granicus.if.org Git - apache/blob - include/ap_config.h

   1 /* ====================================================================
   2  * The Apache Software License, Version 1.1
   3  *
   4  * Copyright (c) 2000-2001 The Apache Software Foundation.  All rights
   5  * reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  *
  14  * 2. Redistributions in binary form must reproduce the above copyright
  15  *    notice, this list of conditions and the following disclaimer in
  16  *    the documentation and/or other materials provided with the
  17  *    distribution.
  18  *
  19  * 3. The end-user documentation included with the redistribution,
  20  *    if any, must include the following acknowledgment:
  21  *       "This product includes software developed by the
  22  *        Apache Software Foundation (http://www.apache.org/)."
  23  *    Alternately, this acknowledgment may appear in the software itself,
  24  *    if and wherever such third-party acknowledgments normally appear.
  25  *
  26  * 4. The names "Apache" and "Apache Software Foundation" must
  27  *    not be used to endorse or promote products derived from this
  28  *    software without prior written permission. For written
  29  *    permission, please contact apache@apache.org.
  30  *
  31  * 5. Products derived from this software may not be called "Apache",
  32  *    nor may "Apache" appear in their name, without prior written
  33  *    permission of the Apache Software Foundation.
  34  *
  35  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  36  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  37  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  38  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  39  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  42  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  43  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  44  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  45  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  46  * SUCH DAMAGE.
  47  * ====================================================================
  48  *
  49  * This software consists of voluntary contributions made by many
  50  * individuals on behalf of the Apache Software Foundation.  For more
  51  * information on the Apache Software Foundation, please see
  52  * <http://www.apache.org/>.
  53  */
  54
  55 #ifndef AP_CONFIG_H
  56 #define AP_CONFIG_H
  57
  58 #include "apr.h"
  59 #include "apr_hooks.h"
  60 #include "apr_optional_hooks.h"
  61
  62 /**
  63  * @file ap_config.h
  64  * @brief Symbol Export Macros
  65  */
  66
  67 /* Although this file doesn't declare any hooks, declare the hook group here */
  68 /** @defgroup hooks Apache Hooks */
  69
  70 /**
  71  * AP_DECLARE_EXPORT is defined when building the Apache Core dynamic
  72  * library, so that all public symbols are exported.
  73  *
  74  * AP_DECLARE_STATIC is defined when including Apache's Core headers,
  75  * to provide static linkage when the dynamic library may be unavailable.
  76  *
  77  * AP_DECLARE_STATIC and AP_DECLARE_EXPORT are left undefined when
  78  * including Apache's Core headers, to import and link the symbols from the
  79  * dynamic Apache Core library and assure appropriate indirection and calling
  80  * conventions at compile time.
  81  *
  82  * @deffunc AP_DECLARE_EXPORT/AP_DECLARE_STATIC
  83  */
  84
  85 #if !defined(WIN32)
  86 /**
  87  * Apache Core dso functions are declared with AP_DECLARE(), so they may
  88  * use the most appropriate calling convention.  Hook functions and other
  89  * Core functions with variable arguments must use AP_DECLARE_NONSTD().
  90  *
  91  * @deffunc AP_DECLARE(rettype) ap_func(args)
  92  */
  93 #define AP_DECLARE(type)            type
  94
  95 /**
  96  * Apache Core dso variable argument and hook functions are declared with
  97  * AP_DECLARE_NONSTD(), as they must use the C language calling convention.
  98  *
  99  * @deffunc AP_DECLARE_NONSTD(rettype) ap_func(args [...])
 100  */
 101 #define AP_DECLARE_NONSTD(type)     type
 102
 103 /**
 104  * Apache Core dso variables are declared with AP_MODULE_DECLARE_DATA.
 105  * This assures the appropriate indirection is invoked at compile time.
 106  *
 107  * @tip extern AP_DECLARE_DATA type apr_variable; syntax is required for
 108  * declarations within headers to properly import the variable.
 109  * @deffunc AP_DECLARE_DATA type apr_variable
 110  */
 111 #define AP_DECLARE_DATA
 112
 113 #elif defined(AP_DECLARE_STATIC)
 114 #define AP_DECLARE(type)            type __stdcall
 115 #define AP_DECLARE_NONSTD(type)     type
 116 #define AP_DECLARE_DATA
 117 #elif defined(AP_DECLARE_EXPORT)
 118 #define AP_DECLARE(type)            __declspec(dllexport) type __stdcall
 119 #define AP_DECLARE_NONSTD(type)     __declspec(dllexport) type
 120 #define AP_DECLARE_DATA             __declspec(dllexport)
 121 #else
 122 #define AP_DECLARE(type)            __declspec(dllimport) type __stdcall
 123 #define AP_DECLARE_NONSTD(type)     __declspec(dllimport) type
 124 #define AP_DECLARE_DATA             __declspec(dllimport)
 125 #endif
 126
 127 #if !defined(WIN32) || defined(AP_MODULE_DECLARE_STATIC)
 128 /**
 129  * Declare a dso module's exported module structure as AP_MODULE_DECLARE_DATA.
 130  *
 131  * Unless AP_MODULE_DECLARE_STATIC is defined at compile time, symbols
 132  * declared with AP_MODULE_DECLARE_DATA are always exported.
 133  *
 134  * @deffunc module AP_MODULE_DECLARE_DATA mod_tag
 135  */
 136 #if defined(WIN32)
 137 #define AP_MODULE_DECLARE(type)            type __stdcall
 138 #else
 139 #define AP_MODULE_DECLARE(type)            type
 140 #endif
 141 #define AP_MODULE_DECLARE_NONSTD(type)     type
 142 #define AP_MODULE_DECLARE_DATA
 143 #else
 144 /**
 145  * AP_MODULE_DECLARE_EXPORT is a no-op.  Unless contradicted by the
 146  * AP_MODULE_DECLARE_STATIC compile-time symbol, it is assumed and defined.
 147  *
 148  * The old SHARED_MODULE compile-time symbol is now the default behavior,
 149  * so it is no longer referenced anywhere with Apache 2.0.
 150  *
 151  * @deffunc AP_MODULE_DECLARE_EXPORT
 152  */
 153 #define AP_MODULE_DECLARE_EXPORT
 154 #define AP_MODULE_DECLARE(type)          __declspec(dllexport) type __stdcall
 155 #define AP_MODULE_DECLARE_NONSTD(type)   __declspec(dllexport) type
 156 #define AP_MODULE_DECLARE_DATA           __declspec(dllexport)
 157 #endif
 158
 159 /**
 160  * @package Hook Functions
 161  */
 162
 163 #define AP_DECLARE_HOOK(ret,name,args) \
 164         APR_DECLARE_EXTERNAL_HOOK(ap,AP,ret,name,args)
 165
 166 #define AP_IMPLEMENT_HOOK_BASE(name) \
 167         APR_IMPLEMENT_EXTERNAL_HOOK_BASE(ap,AP,name)
 168
 169 /**
 170  * Implement an Apache core hook that has no return code, and
 171  * therefore runs all of the registered functions. The implementation
 172  * is called ap_run_<I>name</I>.
 173  *
 174  * @param name The name of the hook
 175  * @param args_decl The declaration of the arguments for the hook, for example
 176  * "(int x,void *y)"
 177  * @param args_use The arguments for the hook as used in a call, for example
 178  * "(x,y)"
 179  * @tip If IMPLEMENTing a hook that is not linked into the Apache core,
 180  * (e.g. within a dso) see APR_IMPLEMENT_EXTERNAL_HOOK_VOID.
 181  * @deffunc AP_IMPLEMENT_HOOK_VOID(name, args_decl, args_use)
 182  */
 183 #define AP_IMPLEMENT_HOOK_VOID(name,args_decl,args_use) \
 184         APR_IMPLEMENT_EXTERNAL_HOOK_VOID(ap,AP,name,args_decl,args_use)
 185
 186 /**
 187  * Implement an Apache core hook that runs until one of the functions
 188  * returns something other than ok or decline. That return value is
 189  * then returned from the hook runner. If the hooks run to completion,
 190  * then ok is returned. Note that if no hook runs it would probably be
 191  * more correct to return decline, but this currently does not do
 192  * so. The implementation is called ap_run_<I>name</I>.
 193  *
 194  * @param ret The return type of the hook (and the hook runner)
 195  * @param name The name of the hook
 196  * @param args_decl The declaration of the arguments for the hook, for example
 197  * "(int x,void *y)"
 198  * @param args_use The arguments for the hook as used in a call, for example
 199  * "(x,y)"
 200  * @param ok The "ok" return value
 201  * @param decline The "decline" return value
 202  * @return ok, decline or an error.
 203  * @tip If IMPLEMENTing a hook that is not linked into the Apache core,
 204  * (e.g. within a dso) see APR_IMPLEMENT_EXTERNAL_HOOK_RUN_ALL.
 205  * @deffunc AP_IMPLEMENT_HOOK_RUN_ALL(ret, name, args_decl, args_use, ok, decline)
 206  */
 207 #define AP_IMPLEMENT_HOOK_RUN_ALL(ret,name,args_decl,args_use,ok,decline) \
 208         APR_IMPLEMENT_EXTERNAL_HOOK_RUN_ALL(ap,AP,ret,name,args_decl, \
 209                                             args_use,ok,decline)
 210
 211 /**
 212  * Implement a hook that runs until the first function that returns
 213  * something other than decline. If all functions return decline, the
 214  * hook runner returns decline. The implementation is called
 215  * ap_run_<I>name</I>.
 216  *
 217  * @param ret The return type of the hook (and the hook runner)
 218  * @param name The name of the hook
 219  * @param args_decl The declaration of the arguments for the hook, for example
 220  * "(int x,void *y)"
 221  * @param args_use The arguments for the hook as used in a call, for example
 222  * "(x,y)"
 223  * @param decline The "decline" return value
 224  * @return decline or an error.
 225  * @tip If IMPLEMENTing a hook that is not linked into the Apache core
 226  * (e.g. within a dso) see APR_IMPLEMENT_EXTERNAL_HOOK_RUN_FIRST.
 227  * @deffunc AP_IMPLEMENT_HOOK_RUN_FIRST(ret, name, args_decl, args_use, decline)
 228  */
 229 #define AP_IMPLEMENT_HOOK_RUN_FIRST(ret,name,args_decl,args_use,decline) \
 230         APR_IMPLEMENT_EXTERNAL_HOOK_RUN_FIRST(ap,AP,ret,name,args_decl, \
 231                                               args_use,decline)
 232
 233 /* Note that the other optional hook implementations are straightforward but
 234  * have not yet been needed
 235  */
 236
 237 /**
 238  * Implement an optional hook. This is exactly the same as a standard hook
 239  * implementation, except the hook is optional.
 240  * @see AP_IMPLEMENT_HOOK_RUN_ALL
 241  */
 242 #define AP_IMPLEMENT_OPTIONAL_HOOK_RUN_ALL(ret,name,args_decl,args_use,ok, \
 243                                            decline) \
 244         APR_IMPLEMENT_OPTIONAL_HOOK_RUN_ALL(ap,AP,ret,name,args_decl, \
 245                                             args_use,ok,decline)
 246
 247 /**
 248  * Hook an optional hook. Unlike static hooks, this uses a macro instead of a
 249  * function.
 250  */
 251 #define AP_OPTIONAL_HOOK(name,fn,pre,succ,order) \
 252         APR_OPTIONAL_HOOK(ap,name,fn,pre,succ,order)
 253
 254 #include "os.h"
 255 #ifndef WIN32
 256 #include "ap_config_auto.h"
 257 #endif
 258
 259
 260 /* TODO - We need to put OS detection back to make all the following work */
 261
 262 #if defined(SUNOS4) || defined(IRIX) || defined(NEXT) || defined(AUX3) \
 263     || defined (UW) || defined(LYNXOS) || defined(TPF)
 264 /* These systems don't do well with any lingering close code; I don't know
 265  * why -- manoj */
 266 #define NO_LINGCLOSE
 267 #endif
 268
 269 /* If APR has OTHER_CHILD logic, use reliable piped logs. */
 270 #if APR_HAS_OTHER_CHILD
 271 #define AP_HAVE_RELIABLE_PIPED_LOGS TRUE
 272 #endif
 273
 274 #if APR_CHARSET_EBCDIC && !defined(APACHE_XLATE)
 275 #define APACHE_XLATE
 276 #endif
 277
 278 #endif /* AP_CONFIG_H */