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 / F277205_apr_general.h < prev    next >
C/C++ Source or Header  |  2004-02-13  |  7KB  |  249 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. #ifndef APR_GENERAL_H
  17. #define APR_GENERAL_H
  18.  
  19. /**
  20.  * @file apr_general.h
  21.  * This is collection of oddballs that didn't fit anywhere else,
  22.  * and might move to more appropriate headers with the release
  23.  * of APR 1.0.
  24.  * @brief APR Miscellaneous library routines
  25.  */
  26.  
  27. #include "apr.h"
  28. #include "apr_pools.h"
  29. #include "apr_errno.h"
  30.  
  31. #if APR_HAVE_SIGNAL_H
  32. #include <signal.h>
  33. #endif
  34.  
  35. #ifdef __cplusplus
  36. extern "C" {
  37. #endif /* __cplusplus */
  38.  
  39. /**
  40.  * @defgroup apr_general Miscellaneous library routines
  41.  * @ingroup APR 
  42.  * This is collection of oddballs that didn't fit anywhere else,
  43.  * and might move to more appropriate headers with the release
  44.  * of APR 1.0.
  45.  * @{
  46.  */
  47.  
  48. /** FALSE */
  49. #ifndef FALSE
  50. #define FALSE 0
  51. #endif
  52. /** TRUE */
  53. #ifndef TRUE
  54. #define TRUE (!FALSE)
  55. #endif
  56.  
  57. /** a space */
  58. #define APR_ASCII_BLANK  '\040'
  59. /** a carrige return */
  60. #define APR_ASCII_CR     '\015'
  61. /** a line feed */
  62. #define APR_ASCII_LF     '\012'
  63. /** a tab */
  64. #define APR_ASCII_TAB    '\011'
  65.  
  66. /** signal numbers typedef */
  67. typedef int               apr_signum_t;
  68.  
  69. /**
  70.  * Finding offsets of elements within structures.
  71.  * Taken from the X code... they've sweated portability of this stuff
  72.  * so we don't have to.  Sigh...
  73.  * @param p_type pointer type name
  74.  * @param field  data field within the structure pointed to
  75.  * @return offset
  76.  */
  77.  
  78. #if defined(CRAY) || (defined(__arm) && !defined(LINUX))
  79. #ifdef __STDC__
  80. #define APR_OFFSET(p_type,field) _Offsetof(p_type,field)
  81. #else
  82. #ifdef CRAY2
  83. #define APR_OFFSET(p_type,field) \
  84.         (sizeof(int)*((unsigned int)&(((p_type)NULL)->field)))
  85.  
  86. #else /* !CRAY2 */
  87.  
  88. #define APR_OFFSET(p_type,field) ((unsigned int)&(((p_type)NULL)->field))
  89.  
  90. #endif /* !CRAY2 */
  91. #endif /* __STDC__ */
  92. #else /* ! (CRAY || __arm) */
  93.  
  94. #define APR_OFFSET(p_type,field) \
  95.         ((long) (((char *) (&(((p_type)NULL)->field))) - ((char *) NULL)))
  96.  
  97. #endif /* !CRAY */
  98.  
  99. /**
  100.  * Finding offsets of elements within structures.
  101.  * @param s_type structure type name
  102.  * @param field  data field within the structure
  103.  * @return offset
  104.  */
  105. #if defined(offsetof) && !defined(__cplusplus)
  106. #define APR_OFFSETOF(s_type,field) offsetof(s_type,field)
  107. #else
  108. #define APR_OFFSETOF(s_type,field) APR_OFFSET(s_type*,field)
  109. #endif
  110.  
  111. /** @deprecated @see APR_OFFSET */
  112. #define APR_XtOffset APR_OFFSET
  113.  
  114. /** @deprecated @see APR_OFFSETOF */
  115. #define APR_XtOffsetOf APR_OFFSETOF
  116.  
  117. #ifndef DOXYGEN
  118.  
  119. /* A couple of prototypes for functions in case some platform doesn't 
  120.  * have it
  121.  */
  122. #if (!APR_HAVE_STRCASECMP) && (APR_HAVE_STRICMP) 
  123. #define strcasecmp(s1, s2) stricmp(s1, s2)
  124. #elif (!APR_HAVE_STRCASECMP)
  125. int strcasecmp(const char *a, const char *b);
  126. #endif
  127.  
  128. #if (!APR_HAVE_STRNCASECMP) && (APR_HAVE_STRNICMP)
  129. #define strncasecmp(s1, s2, n) strnicmp(s1, s2, n)
  130. #elif (!APR_HAVE_STRNCASECMP)
  131. int strncasecmp(const char *a, const char *b, size_t n);
  132. #endif
  133.  
  134. #endif
  135.  
  136. /**
  137.  * Alignment macros
  138.  */
  139.  
  140. /* APR_ALIGN() is only to be used to align on a power of 2 boundary */
  141. #define APR_ALIGN(size, boundary) \
  142.     (((size) + ((boundary) - 1)) & ~((boundary) - 1))
  143.  
  144. /** Default alignment */
  145. #define APR_ALIGN_DEFAULT(size) APR_ALIGN(size, 8)
  146.  
  147.  
  148. /**
  149.  * String and memory functions
  150.  */
  151.  
  152. /** Properly quote a value as a string in the C preprocessor */
  153. #define APR_STRINGIFY(n) APR_STRINGIFY_HELPER(n)
  154. /** Helper macro for APR_STRINGIFY */
  155. #define APR_STRINGIFY_HELPER(n) #n
  156.  
  157. #if (!APR_HAVE_MEMMOVE)
  158. #define memmove(a,b,c) bcopy(b,a,c)
  159. #endif
  160.  
  161. #if (!APR_HAVE_MEMCHR)
  162. void *memchr(const void *s, int c, size_t n);
  163. #endif
  164.  
  165. /** @} */
  166.  
  167. /**
  168.  * @defgroup apr_library Library initialization and termination
  169.  * @{
  170.  */
  171.  
  172. /**
  173.  * Setup any APR internal data structures.  This MUST be the first function 
  174.  * called for any APR library.
  175.  * @remark See apr_app_initialize if this is an application, rather than
  176.  * a library consumer of apr.
  177.  */
  178. APR_DECLARE(apr_status_t) apr_initialize(void);
  179.  
  180. /**
  181.  * Set up an application with normalized argc, argv (and optionally env) in
  182.  * order to deal with platform-specific oddities, such as Win32 services,
  183.  * code pages and signals.  This must be the first function called for any
  184.  * APR program.
  185.  * @param argc Pointer to the argc that may be corrected
  186.  * @param argv Pointer to the argv that may be corrected
  187.  * @param env Pointer to the env that may be corrected, may be NULL
  188.  * @remark See apr_initialize if this is a library consumer of apr.
  189.  * Otherwise, this call is identical to apr_initialize, and must be closed
  190.  * with a call to apr_terminate at the end of program execution.
  191.  */
  192. APR_DECLARE(apr_status_t) apr_app_initialize(int *argc, 
  193.                                              char const * const * *argv, 
  194.                                              char const * const * *env);
  195.  
  196. /**
  197.  * Tear down any APR internal data structures which aren't torn down 
  198.  * automatically.
  199.  * @remark An APR program must call this function at termination once it 
  200.  *         has stopped using APR services.  The APR developers suggest using
  201.  *         atexit to ensure this is called.  When using APR from a language
  202.  *         other than C that has problems with the calling convention, use
  203.  *         apr_terminate2() instead.
  204.  */
  205. APR_DECLARE_NONSTD(void) apr_terminate(void);
  206.  
  207. /**
  208.  * Tear down any APR internal data structures which aren't torn down 
  209.  * automatically, same as apr_terminate
  210.  * @remark An APR program must call either the apr_terminate or apr_terminate2 
  211.  *         function once it it has finished using APR services.  The APR 
  212.  *         developers suggest using atexit(apr_terminate) to ensure this is done.
  213.  *         apr_terminate2 exists to allow non-c language apps to tear down apr, 
  214.  *         while apr_terminate is recommended from c language applications.
  215.  */
  216. APR_DECLARE(void) apr_terminate2(void);
  217.  
  218. /** @} */
  219.  
  220. /**
  221.  * @defgroup apr_random Random Functions
  222.  * @{
  223.  */
  224.  
  225. #if APR_HAS_RANDOM || defined(DOXYGEN)
  226.  
  227. /* TODO: I'm not sure this is the best place to put this prototype...*/
  228. /**
  229.  * Generate random bytes.
  230.  * @param buf Buffer to fill with random bytes
  231.  * @param length Length of buffer in bytes (becomes apr_size_t in APR 1.0)
  232.  */
  233. #ifdef APR_ENABLE_FOR_1_0
  234. APR_DECLARE(apr_status_t) apr_generate_random_bytes(unsigned char * buf, 
  235.                                                     apr_size_t length);
  236. #else
  237. APR_DECLARE(apr_status_t) apr_generate_random_bytes(unsigned char * buf, 
  238.                                                     int length);
  239. #endif
  240.  
  241. #endif
  242. /** @} */
  243.  
  244. #ifdef __cplusplus
  245. }
  246. #endif
  247.  
  248. #endif  /* ! APR_GENERAL_H */
  249.