home *** CD-ROM | disk | FTP | other *** search
/ Chip 2004 November / CMCD1104.ISO / Software / Complet / Apache / apache_2.0.52-win32-x86-no_ssl.msi / Data.Cab / F277219_apr_optional_hooks.h < prev    next >
C/C++ Source or Header  |  2004-02-13  |  4KB  |  117 lines
  1. /* Copyright 2000-2004 The Apache Software Foundation
  2.  *
  3.  * Licensed under the Apache License, Version 2.0 (the "License");
  4.  * you may not use this file except in compliance with the License.
  5.  * You may obtain a copy of the License at
  6.  *
  7.  *     http://www.apache.org/licenses/LICENSE-2.0
  8.  *
  9.  * Unless required by applicable law or agreed to in writing, software
  10.  * distributed under the License is distributed on an "AS IS" BASIS,
  11.  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12.  * See the License for the specific language governing permissions and
  13.  * limitations under the License.
  14.  */
  15. /**
  16.  * @file apr_optional_hooks.h
  17.  * @brief Apache optional hook functions
  18.  */
  19.  
  20.  
  21. #ifndef APR_OPTIONAL_HOOK_H
  22. #define APR_OPTIONAL_HOOK_H
  23.  
  24. #include "apr_tables.h"
  25.  
  26. #ifdef __cplusplus
  27. extern "C" {
  28. #endif
  29. /** 
  30.  * @defgroup APR_Util_OPT_HOOK Optional Hook Functions
  31.  * @ingroup APR_Util_Hook
  32.  * @{
  33.  */
  34. /**
  35.  * Function to implemnt the APR_OPTIONAL_HOOK Macro
  36.  * @internal
  37.  * @see APR_OPTIONAL_HOOK
  38.  *
  39.  * @param name The name of the hook
  40.  * @param pfn A pointer to a function that will be called
  41.  * @param aszPre a NULL-terminated array of strings that name modules whose hooks should precede this one
  42.  * @param aszSucc a NULL-terminated array of strings that name modules whose hooks should succeed this one
  43.  * @param nOrder an integer determining order before honouring aszPre and aszSucc (for example HOOK_MIDDLE)
  44.  */
  45.  
  46.  
  47. APU_DECLARE(void) apr_optional_hook_add(const char *szName,void (*pfn)(void),
  48.                     const char * const *aszPre,
  49.                     const char * const *aszSucc,
  50.                     int nOrder);
  51.  
  52. /**
  53.  * Hook to an optional hook.
  54.  *
  55.  * @param ns The namespace prefix of the hook functions
  56.  * @param name The name of the hook
  57.  * @param pfn A pointer to a function that will be called
  58.  * @param aszPre a NULL-terminated array of strings that name modules whose hooks should precede this one
  59.  * @param aszSucc a NULL-terminated array of strings that name modules whose hooks should succeed this one
  60.  * @param nOrder an integer determining order before honouring aszPre and aszSucc (for example HOOK_MIDDLE)
  61.  */
  62.  
  63. #define APR_OPTIONAL_HOOK(ns,name,pfn,aszPre,aszSucc,nOrder) do { \
  64.   ns##_HOOK_##name##_t *apu__hook = pfn; \
  65.   apr_optional_hook_add(#name,(void (*)(void))apu__hook,aszPre, aszSucc, nOrder); \
  66. } while (0)
  67.  
  68. /**
  69.  * @internal
  70.  * @param szName - the name of the function
  71.  * @return the hook structure for a given hook
  72.  */
  73. APU_DECLARE(apr_array_header_t *) apr_optional_hook_get(const char *szName);
  74.  
  75. /**
  76.  * Implement an optional hook that runs until one of the functions
  77.  * returns something other than OK or DECLINE.
  78.  *
  79.  * @param ns The namespace prefix of the hook functions
  80.  * @param link The linkage declaration prefix of the hook
  81.  * @param ret The type of the return value of the hook
  82.  * @param ret The type of the return value of the hook
  83.  * @param name The name of the hook
  84.  * @param args_decl The declaration of the arguments for the hook
  85.  * @param args_use The names for the arguments for the hook
  86.  * @param ok Success value
  87.  * @param decline Decline value
  88.  */
  89. #define APR_IMPLEMENT_OPTIONAL_HOOK_RUN_ALL(ns,link,ret,name,args_decl,args_use,ok,decline) \
  90. link##_DECLARE(ret) ns##_run_##name args_decl \
  91.     { \
  92.     ns##_LINK_##name##_t *pHook; \
  93.     int n; \
  94.     ret rv; \
  95.     apr_array_header_t *pHookArray=apr_optional_hook_get(#name); \
  96. \
  97.     if(!pHookArray) \
  98.     return ok; \
  99. \
  100.     pHook=(ns##_LINK_##name##_t *)pHookArray->elts; \
  101.     for(n=0 ; n < pHookArray->nelts ; ++n) \
  102.     { \
  103.     rv=(pHook[n].pFunc)args_use; \
  104. \
  105.     if(rv != ok && rv != decline) \
  106.         return rv; \
  107.     } \
  108.     return ok; \
  109.     }
  110.  
  111. /** @} */
  112. #ifdef __cplusplus
  113. }
  114. #endif
  115.  
  116. #endif /* APR_OPTIONAL_HOOK_H */
  117.