| /* ==================================================================== |
| * The Apache Software License, Version 1.1 |
| * |
| * Copyright (c) 2000-2002 The Apache Software Foundation. All rights |
| * reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions |
| * are met: |
| * |
| * 1. Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * |
| * 2. Redistributions in binary form must reproduce the above copyright |
| * notice, this list of conditions and the following disclaimer in |
| * the documentation and/or other materials provided with the |
| * distribution. |
| * |
| * 3. The end-user documentation included with the redistribution, |
| * if any, must include the following acknowledgment: |
| * "This product includes software developed by the |
| * Apache Software Foundation (http://www.apache.org/)." |
| * Alternately, this acknowledgment may appear in the software itself, |
| * if and wherever such third-party acknowledgments normally appear. |
| * |
| * 4. The names "Apache" and "Apache Software Foundation" must |
| * not be used to endorse or promote products derived from this |
| * software without prior written permission. For written |
| * permission, please contact apache@apache.org. |
| * |
| * 5. Products derived from this software may not be called "Apache", |
| * nor may "Apache" appear in their name, without prior written |
| * permission of the Apache Software Foundation. |
| * |
| * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED |
| * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES |
| * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
| * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR |
| * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF |
| * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND |
| * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
| * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT |
| * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF |
| * SUCH DAMAGE. |
| * ==================================================================== |
| * |
| * This software consists of voluntary contributions made by many |
| * individuals on behalf of the Apache Software Foundation. For more |
| * information on the Apache Software Foundation, please see |
| * <http://www.apache.org/>. |
| */ |
| |
| #ifndef AP_CONFIG_H |
| #define AP_CONFIG_H |
| |
| #include "apr.h" |
| #include "apr_hooks.h" |
| #include "apr_optional_hooks.h" |
| |
| /** |
| * @file ap_config.h |
| * @brief Symbol export macros and hook functions |
| */ |
| |
| /* Although this file doesn't declare any hooks, declare the hook group here */ |
| /** @defgroup hooks Apache Hooks */ |
| |
| #ifdef DOXYGEN |
| /* define these just so doxygen documents them */ |
| |
| /** |
| * AP_DECLARE_STATIC is defined when including Apache's Core headers, |
| * to provide static linkage when the dynamic library may be unavailable. |
| * |
| * @see AP_DECLARE_EXPORT |
| * |
| * AP_DECLARE_STATIC and AP_DECLARE_EXPORT are left undefined when |
| * including Apache's Core headers, to import and link the symbols from the |
| * dynamic Apache Core library and assure appropriate indirection and calling |
| * conventions at compile time. |
| */ |
| # define AP_DECLARE_STATIC |
| /** |
| * AP_DECLARE_EXPORT is defined when building the Apache Core dynamic |
| * library, so that all public symbols are exported. |
| * |
| * @see AP_DECLARE_STATIC |
| */ |
| # define AP_DECLARE_EXPORT |
| |
| #endif /* def DOXYGEN */ |
| |
| #if !defined(WIN32) |
| /** |
| * Apache Core dso functions are declared with AP_DECLARE(), so they may |
| * use the most appropriate calling convention. Hook functions and other |
| * Core functions with variable arguments must use AP_DECLARE_NONSTD(). |
| * @code |
| * AP_DECLARE(rettype) ap_func(args) |
| * @endcode |
| */ |
| #define AP_DECLARE(type) type |
| |
| /** |
| * Apache Core dso variable argument and hook functions are declared with |
| * AP_DECLARE_NONSTD(), as they must use the C language calling convention. |
| * @see AP_DECLARE |
| * @code |
| * AP_DECLARE_NONSTD(rettype) ap_func(args [...]) |
| * @endcode |
| */ |
| #define AP_DECLARE_NONSTD(type) type |
| |
| /** |
| * Apache Core dso variables are declared with AP_MODULE_DECLARE_DATA. |
| * This assures the appropriate indirection is invoked at compile time. |
| * |
| * @note AP_DECLARE_DATA extern type apr_variable; syntax is required for |
| * declarations within headers to properly import the variable. |
| * @code |
| * AP_DECLARE_DATA type apr_variable |
| * @endcode |
| */ |
| #define AP_DECLARE_DATA |
| |
| #elif defined(AP_DECLARE_STATIC) |
| #define AP_DECLARE(type) type __stdcall |
| #define AP_DECLARE_NONSTD(type) type |
| #define AP_DECLARE_DATA |
| #elif defined(AP_DECLARE_EXPORT) |
| #define AP_DECLARE(type) __declspec(dllexport) type __stdcall |
| #define AP_DECLARE_NONSTD(type) __declspec(dllexport) type |
| #define AP_DECLARE_DATA __declspec(dllexport) |
| #else |
| #define AP_DECLARE(type) __declspec(dllimport) type __stdcall |
| #define AP_DECLARE_NONSTD(type) __declspec(dllimport) type |
| #define AP_DECLARE_DATA __declspec(dllimport) |
| #endif |
| |
| #if !defined(WIN32) || defined(AP_MODULE_DECLARE_STATIC) |
| /** |
| * Declare a dso module's exported module structure as AP_MODULE_DECLARE_DATA. |
| * |
| * Unless AP_MODULE_DECLARE_STATIC is defined at compile time, symbols |
| * declared with AP_MODULE_DECLARE_DATA are always exported. |
| * @code |
| * module AP_MODULE_DECLARE_DATA mod_tag |
| * @endcode |
| */ |
| #if defined(WIN32) |
| #define AP_MODULE_DECLARE(type) type __stdcall |
| #else |
| #define AP_MODULE_DECLARE(type) type |
| #endif |
| #define AP_MODULE_DECLARE_NONSTD(type) type |
| #define AP_MODULE_DECLARE_DATA |
| #else |
| /** |
| * AP_MODULE_DECLARE_EXPORT is a no-op. Unless contradicted by the |
| * AP_MODULE_DECLARE_STATIC compile-time symbol, it is assumed and defined. |
| * |
| * The old SHARED_MODULE compile-time symbol is now the default behavior, |
| * so it is no longer referenced anywhere with Apache 2.0. |
| */ |
| #define AP_MODULE_DECLARE_EXPORT |
| #define AP_MODULE_DECLARE(type) __declspec(dllexport) type __stdcall |
| #define AP_MODULE_DECLARE_NONSTD(type) __declspec(dllexport) type |
| #define AP_MODULE_DECLARE_DATA __declspec(dllexport) |
| #endif |
| |
| /** |
| * Declare a hook function |
| * @param ret The return type of the hook |
| * @param name The hook's name (as a literal) |
| * @param args The arguments the hook function takes, in brackets. |
| */ |
| #define AP_DECLARE_HOOK(ret,name,args) \ |
| APR_DECLARE_EXTERNAL_HOOK(ap,AP,ret,name,args) |
| |
| /** @internal */ |
| #define AP_IMPLEMENT_HOOK_BASE(name) \ |
| APR_IMPLEMENT_EXTERNAL_HOOK_BASE(ap,AP,name) |
| |
| /** |
| * Implement an Apache core hook that has no return code, and |
| * therefore runs all of the registered functions. The implementation |
| * is called ap_run_<i>name</i>. |
| * |
| * @param name The name of the hook |
| * @param args_decl The declaration of the arguments for the hook, for example |
| * "(int x,void *y)" |
| * @param args_use The arguments for the hook as used in a call, for example |
| * "(x,y)" |
| * @note If IMPLEMENTing a hook that is not linked into the Apache core, |
| * (e.g. within a dso) see APR_IMPLEMENT_EXTERNAL_HOOK_VOID. |
| */ |
| #define AP_IMPLEMENT_HOOK_VOID(name,args_decl,args_use) \ |
| APR_IMPLEMENT_EXTERNAL_HOOK_VOID(ap,AP,name,args_decl,args_use) |
| |
| /** |
| * Implement an Apache core hook that runs until one of the functions |
| * returns something other than ok or decline. That return value is |
| * then returned from the hook runner. If the hooks run to completion, |
| * then ok is returned. Note that if no hook runs it would probably be |
| * more correct to return decline, but this currently does not do |
| * so. The implementation is called ap_run_<i>name</i>. |
| * |
| * @param ret The return type of the hook (and the hook runner) |
| * @param name The name of the hook |
| * @param args_decl The declaration of the arguments for the hook, for example |
| * "(int x,void *y)" |
| * @param args_use The arguments for the hook as used in a call, for example |
| * "(x,y)" |
| * @param ok The "ok" return value |
| * @param decline The "decline" return value |
| * @return ok, decline or an error. |
| * @note If IMPLEMENTing a hook that is not linked into the Apache core, |
| * (e.g. within a dso) see APR_IMPLEMENT_EXTERNAL_HOOK_RUN_ALL. |
| */ |
| #define AP_IMPLEMENT_HOOK_RUN_ALL(ret,name,args_decl,args_use,ok,decline) \ |
| APR_IMPLEMENT_EXTERNAL_HOOK_RUN_ALL(ap,AP,ret,name,args_decl, \ |
| args_use,ok,decline) |
| |
| /** |
| * Implement a hook that runs until the first function that returns |
| * something other than decline. If all functions return decline, the |
| * hook runner returns decline. The implementation is called |
| * ap_run_<i>name</i>. |
| * |
| * @param ret The return type of the hook (and the hook runner) |
| * @param name The name of the hook |
| * @param args_decl The declaration of the arguments for the hook, for example |
| * "(int x,void *y)" |
| * @param args_use The arguments for the hook as used in a call, for example |
| * "(x,y)" |
| * @param decline The "decline" return value |
| * @return decline or an error. |
| * @note If IMPLEMENTing a hook that is not linked into the Apache core |
| * (e.g. within a dso) see APR_IMPLEMENT_EXTERNAL_HOOK_RUN_FIRST. |
| */ |
| #define AP_IMPLEMENT_HOOK_RUN_FIRST(ret,name,args_decl,args_use,decline) \ |
| APR_IMPLEMENT_EXTERNAL_HOOK_RUN_FIRST(ap,AP,ret,name,args_decl, \ |
| args_use,decline) |
| |
| /* Note that the other optional hook implementations are straightforward but |
| * have not yet been needed |
| */ |
| |
| /** |
| * Implement an optional hook. This is exactly the same as a standard hook |
| * implementation, except the hook is optional. |
| * @see AP_IMPLEMENT_HOOK_RUN_ALL |
| */ |
| #define AP_IMPLEMENT_OPTIONAL_HOOK_RUN_ALL(ret,name,args_decl,args_use,ok, \ |
| decline) \ |
| APR_IMPLEMENT_OPTIONAL_HOOK_RUN_ALL(ap,AP,ret,name,args_decl, \ |
| args_use,ok,decline) |
| |
| /** |
| * Hook an optional hook. Unlike static hooks, this uses a macro instead of a |
| * function. |
| */ |
| #define AP_OPTIONAL_HOOK(name,fn,pre,succ,order) \ |
| APR_OPTIONAL_HOOK(ap,name,fn,pre,succ,order) |
| |
| #include "os.h" |
| #if !defined(WIN32) && !defined(NETWARE) |
| #include "ap_config_auto.h" |
| #endif |
| |
| |
| /* TODO - We need to put OS detection back to make all the following work */ |
| |
| #if defined(SUNOS4) || defined(IRIX) || defined(NEXT) || defined(AUX3) \ |
| || defined (UW) || defined(LYNXOS) || defined(TPF) |
| /* These systems don't do well with any lingering close code; I don't know |
| * why -- manoj */ |
| #define NO_LINGCLOSE |
| #endif |
| |
| /* If APR has OTHER_CHILD logic, use reliable piped logs. */ |
| #if APR_HAS_OTHER_CHILD |
| #define AP_HAVE_RELIABLE_PIPED_LOGS TRUE |
| #endif |
| |
| #if APR_CHARSET_EBCDIC && !defined(APACHE_XLATE) |
| #define APACHE_XLATE |
| #endif |
| |
| #endif /* AP_CONFIG_H */ |