Main Page | Modules | Data Structures | File List | Data Fields | Globals | Related Pages

apr.h

Go to the documentation of this file.
00001 /* Copyright 2000-2004 The Apache Software Foundation
00002  *
00003  * Licensed under the Apache License, Version 2.0 (the "License");
00004  * you may not use this file except in compliance with the License.
00005  * You may obtain a copy of the License at
00006  *
00007  *     http://www.apache.org/licenses/LICENSE-2.0
00008  *
00009  * Unless required by applicable law or agreed to in writing, software
00010  * distributed under the License is distributed on an "AS IS" BASIS,
00011  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00012  * See the License for the specific language governing permissions and
00013  * limitations under the License.
00014  */
00015 
00016 
00017 #ifndef APR_H
00018 #define APR_H
00019 
00020 /* GENERATED FILE WARNING!  DO NOT EDIT apr.h
00021  *
00022  * You must modify apr.h.in instead.
00023  *
00024  * And please, make an effort to stub apr.hw and apr.hnw in the process.
00025  */
00026 
00027 /**
00028  * @file apr.h
00029  * @brief APR Platform Definitions
00030  * @remark This is a generated header generated from include/apr.h.in by
00031  * ./configure, or copied from include/apr.hw or include/apr.hnw 
00032  * for Win32 or Netware by those build environments, respectively.
00033  */
00034 
00035 /**
00036  * @defgroup APR Apache Portability Runtime library
00037  * @{
00038  */
00039 /**
00040  * @defgroup apr_platform Platform Definitions
00041  * @{
00042  */
00043 
00044 /* So that we can use inline on some critical functions, and use
00045  * GNUC attributes (such as to get -Wall warnings for printf-like
00046  * functions).  Only do this in gcc 2.7 or later ... it may work
00047  * on earlier stuff, but why chance it.
00048  *
00049  * We've since discovered that the gcc shipped with NeXT systems
00050  * as "cc" is completely broken.  It claims to be __GNUC__ and so
00051  * on, but it doesn't implement half of the things that __GNUC__
00052  * means.  In particular it's missing inline and the __attribute__
00053  * stuff.  So we hack around it.  PR#1613. -djg
00054  */
00055 #if !defined(__GNUC__) || __GNUC__ < 2 || \
00056     (__GNUC__ == 2 && __GNUC_MINOR__ < 7) ||\
00057     defined(NEXT)
00058 #ifndef __attribute__
00059 #define __attribute__(__x)
00060 #endif
00061 #define APR_INLINE
00062 #define APR_HAS_INLINE          0
00063 #else
00064 #define APR_INLINE __inline__
00065 #define APR_HAS_INLINE          1
00066 #endif
00067 
00068 #define APR_HAVE_ARPA_INET_H     1
00069 #define APR_HAVE_CONIO_H         0
00070 #define APR_HAVE_CRYPT_H         1
00071 #define APR_HAVE_CTYPE_H         1
00072 #define APR_HAVE_DIRENT_H        1
00073 #define APR_HAVE_ERRNO_H         1
00074 #define APR_HAVE_FCNTL_H         1
00075 #define APR_HAVE_IO_H            0
00076 #define APR_HAVE_LIMITS_H        1
00077 #define APR_HAVE_NETDB_H         1
00078 #define APR_HAVE_NETINET_IN_H    1
00079 #define APR_HAVE_NETINET_SCTP_H  0
00080 #define APR_HAVE_NETINET_SCTP_UIO_H 0
00081 #define APR_HAVE_NETINET_TCP_H   1
00082 #define APR_HAVE_PTHREAD_H       1
00083 #define APR_HAVE_SEMAPHORE_H     1
00084 #define APR_HAVE_SIGNAL_H        1
00085 #define APR_HAVE_STDARG_H        1
00086 #define APR_HAVE_STDINT_H        1
00087 #define APR_HAVE_STDIO_H         1
00088 #define APR_HAVE_STDLIB_H        1
00089 #define APR_HAVE_STRING_H        1
00090 #define APR_HAVE_STRINGS_H       1
00091 #define APR_HAVE_SYS_IOCTL_H     1
00092 #define APR_HAVE_SYS_SENDFILE_H  1
00093 #define APR_HAVE_SYS_SIGNAL_H    1
00094 #define APR_HAVE_SYS_SOCKET_H    1
00095 #define APR_HAVE_SYS_SOCKIO_H    0
00096 #define APR_HAVE_SYS_SYSLIMITS_H 0
00097 #define APR_HAVE_SYS_TIME_H      1
00098 #define APR_HAVE_SYS_TYPES_H     1
00099 #define APR_HAVE_SYS_UIO_H       1
00100 #define APR_HAVE_SYS_UN_H        1
00101 #define APR_HAVE_SYS_WAIT_H      1
00102 #define APR_HAVE_TIME_H          1
00103 #define APR_HAVE_UNISTD_H        1
00104 
00105 /** @} */
00106 
00107 /* We don't include our conditional headers within the doxyblocks 
00108  * or the extern "C" namespace 
00109  */
00110 
00111 #if APR_HAVE_SYS_TYPES_H
00112 #include <sys/types.h>
00113 #endif
00114 
00115 #if APR_HAVE_SYS_SOCKET_H
00116 #include <sys/socket.h>
00117 #endif
00118 
00119 #if defined(__cplusplus) && !defined(__STDC_CONSTANT_MACROS)
00120 /* C99 7.18.4 requires that stdint.h only exposes INT64_C 
00121  * and UINT64_C for C++ implementations if this is defined: */
00122 #define __STDC_CONSTANT_MACROS
00123 #endif
00124 
00125 #if APR_HAVE_STDINT_H
00126 #include <stdint.h>
00127 #endif
00128 
00129 #if APR_HAVE_SYS_WAIT_H
00130 #include <sys/wait.h>
00131 #endif
00132 
00133 #ifdef OS2
00134 #define INCL_DOS
00135 #define INCL_DOSERRORS
00136 #include <os2.h>
00137 #endif
00138 
00139 /* header files for PATH_MAX, _POSIX_PATH_MAX */
00140 #if APR_HAVE_LIMITS_H
00141 #include <limits.h>
00142 #else
00143 #if APR_HAVE_SYS_SYSLIMITS_H
00144 #include <sys/syslimits.h>
00145 #endif
00146 #endif
00147 
00148 
00149 #ifdef __cplusplus
00150 extern "C" {
00151 #endif
00152 
00153 /**
00154  * @addtogroup apr_platform
00155  * @ingroup APR 
00156  * @{
00157  */
00158 
00159 #define APR_HAVE_SHMEM_MMAP_TMP     1
00160 #define APR_HAVE_SHMEM_MMAP_SHM     1
00161 #define APR_HAVE_SHMEM_MMAP_ZERO    1
00162 #define APR_HAVE_SHMEM_SHMGET_ANON  1
00163 #define APR_HAVE_SHMEM_SHMGET       1
00164 #define APR_HAVE_SHMEM_MMAP_ANON    1
00165 #define APR_HAVE_SHMEM_BEOS         0
00166 
00167 #define APR_USE_SHMEM_MMAP_TMP     0
00168 #define APR_USE_SHMEM_MMAP_SHM     0
00169 #define APR_USE_SHMEM_MMAP_ZERO    0
00170 #define APR_USE_SHMEM_SHMGET_ANON  0
00171 #define APR_USE_SHMEM_SHMGET       1
00172 #define APR_USE_SHMEM_MMAP_ANON    1
00173 #define APR_USE_SHMEM_BEOS         0
00174 
00175 #define APR_USE_FLOCK_SERIALIZE           0 
00176 #define APR_USE_SYSVSEM_SERIALIZE         0
00177 #define APR_USE_POSIXSEM_SERIALIZE        0
00178 #define APR_USE_FCNTL_SERIALIZE           1
00179 #define APR_USE_PROC_PTHREAD_SERIALIZE    0 
00180 #define APR_USE_PTHREAD_SERIALIZE         1 
00181 
00182 #define APR_HAS_FLOCK_SERIALIZE           1
00183 #define APR_HAS_SYSVSEM_SERIALIZE         1
00184 #define APR_HAS_POSIXSEM_SERIALIZE        1
00185 #define APR_HAS_FCNTL_SERIALIZE           1
00186 #define APR_HAS_PROC_PTHREAD_SERIALIZE    1
00187 
00188 #define APR_PROCESS_LOCK_IS_GLOBAL        0
00189 
00190 #define APR_HAVE_CORKABLE_TCP   1 
00191 #define APR_HAVE_GETRLIMIT      1
00192 #define APR_HAVE_IN_ADDR        1
00193 #define APR_HAVE_INET_ADDR      1
00194 #define APR_HAVE_INET_NETWORK   1
00195 #define APR_HAVE_IPV6           1
00196 #define APR_HAVE_MEMMOVE        1
00197 #define APR_HAVE_SETRLIMIT      1
00198 #define APR_HAVE_SIGACTION      1
00199 #define APR_HAVE_SIGSUSPEND     1
00200 #define APR_HAVE_SIGWAIT        1
00201 #define APR_HAVE_SA_STORAGE     1
00202 #define APR_HAVE_STRCASECMP     1
00203 #define APR_HAVE_STRDUP         1
00204 #define APR_HAVE_STRICMP        0
00205 #define APR_HAVE_STRNCASECMP    1
00206 #define APR_HAVE_STRNICMP       0
00207 #define APR_HAVE_STRSTR         1
00208 #define APR_HAVE_MEMCHR         1
00209 #define APR_HAVE_STRUCT_RLIMIT  1
00210 #define APR_HAVE_UNION_SEMUN    0
00211 #define APR_HAVE_SCTP           0
00212 
00213 /*  APR Feature Macros */
00214 #define APR_HAS_SHARED_MEMORY     1
00215 #define APR_HAS_THREADS           1
00216 #define APR_HAS_SENDFILE          1
00217 #define APR_HAS_MMAP              1
00218 #define APR_HAS_FORK              1
00219 #define APR_HAS_RANDOM            1
00220 #define APR_HAS_OTHER_CHILD       1
00221 #define APR_HAS_DSO               1
00222 #define APR_HAS_SO_ACCEPTFILTER   0
00223 #define APR_HAS_UNICODE_FS        0
00224 #define APR_HAS_PROC_INVOKED      0
00225 #define APR_HAS_USER              1
00226 #define APR_HAS_LARGE_FILES       0
00227 #define APR_HAS_XTHREAD_FILES     0
00228 #define APR_HAS_OS_UUID           1
00229 
00230 #define APR_PROCATTR_USER_SET_REQUIRES_PASSWORD 0
00231 
00232 /* APR sets APR_FILES_AS_SOCKETS to 1 on systems where it is possible
00233  * to poll on files/pipes.
00234  */
00235 #define APR_FILES_AS_SOCKETS      1
00236 
00237 /* This macro indicates whether or not EBCDIC is the native character set.
00238  */
00239 #define APR_CHARSET_EBCDIC        0
00240 
00241 /* If we have a TCP implementation that can be "corked", what flag
00242  * do we use?
00243  */
00244 #define APR_TCP_NOPUSH_FLAG       TCP_CORK
00245 
00246 /* Is the TCP_NODELAY socket option inherited from listening sockets?
00247 */
00248 #define APR_TCP_NODELAY_INHERITED 1
00249 
00250 /* Is the O_NONBLOCK flag inherited from listening sockets?
00251 */
00252 #define APR_O_NONBLOCK_INHERITED 0
00253 
00254 /* Typedefs that APR needs. */
00255 
00256 typedef  unsigned char           apr_byte_t;
00257 
00258 typedef  short           apr_int16_t;
00259 typedef  unsigned short  apr_uint16_t;
00260                                                
00261 typedef  int             apr_int32_t;
00262 typedef  unsigned int    apr_uint32_t;
00263                                                
00264 typedef  long            apr_int64_t;
00265 typedef  unsigned long   apr_uint64_t;
00266 
00267 typedef  size_t          apr_size_t;
00268 typedef  ssize_t         apr_ssize_t;
00269 typedef  off_t           apr_off_t;
00270 typedef  socklen_t       apr_socklen_t;
00271 
00272 #define APR_SIZEOF_VOIDP 8
00273 
00274 /* Are we big endian? */
00275 #define APR_IS_BIGENDIAN        0
00276 
00277 /* Mechanisms to properly type numeric literals */
00278 #define APR_INT64_C(val) INT64_C(val)
00279 #define APR_UINT64_C(val) UINT64_C(val)
00280 
00281 /* Definitions that APR programs need to work properly. */
00282 
00283 /** 
00284  * Thread callbacks from APR functions must be declared with APR_THREAD_FUNC, 
00285  * so that they follow the platform's calling convention.
00286  * @example
00287  */
00288 /** void* APR_THREAD_FUNC my_thread_entry_fn(apr_thread_t *thd, void *data);
00289  */
00290 #define APR_THREAD_FUNC
00291 
00292 /**
00293  * The public APR functions are declared with APR_DECLARE(), so they may
00294  * use the most appropriate calling convention.  Public APR functions with 
00295  * variable arguments must use APR_DECLARE_NONSTD().
00296  *
00297  * @remark Both the declaration and implementations must use the same macro.
00298  * @example
00299  */
00300 /** APR_DECLARE(rettype) apr_func(args)
00301  * @see APR_DECLARE_NONSTD @see APR_DECLARE_DATA
00302  * @remark Note that when APR compiles the library itself, it passes the 
00303  * symbol -DAPR_DECLARE_EXPORT to the compiler on some platforms (e.g. Win32) 
00304  * to export public symbols from the dynamic library build.\n
00305  * The user must define the APR_DECLARE_STATIC when compiling to target
00306  * the static APR library on some platforms (e.g. Win32.)  The public symbols 
00307  * are neither exported nor imported when APR_DECLARE_STATIC is defined.\n
00308  * By default, compiling an application and including the APR public
00309  * headers, without defining APR_DECLARE_STATIC, will prepare the code to be
00310  * linked to the dynamic library.
00311  */
00312 #define APR_DECLARE(type)            type 
00313 
00314 /**
00315  * The public APR functions using variable arguments are declared with 
00316  * APR_DECLARE_NONSTD(), as they must follow the C language calling convention.
00317  * @see APR_DECLARE @see APR_DECLARE_DATA
00318  * @remark Both the declaration and implementations must use the same macro.
00319  * @example
00320  */
00321 /** APR_DECLARE_NONSTD(rettype) apr_func(args, ...);
00322  */
00323 #define APR_DECLARE_NONSTD(type)     type
00324 
00325 /**
00326  * The public APR variables are declared with AP_MODULE_DECLARE_DATA.
00327  * This assures the appropriate indirection is invoked at compile time.
00328  * @see APR_DECLARE @see APR_DECLARE_NONSTD
00329  * @remark Note that the declaration and implementations use different forms,
00330  * but both must include the macro.
00331  * @example
00332  */
00333 /** extern APR_DECLARE_DATA type apr_variable;\n
00334  * APR_DECLARE_DATA type apr_variable = value;
00335  */
00336 #define APR_DECLARE_DATA
00337 
00338 /* Define APR_SSIZE_T_FMT.  
00339  * If ssize_t is an integer we define it to be "d",
00340  * if ssize_t is a long int we define it to be "ld",
00341  * if ssize_t is neither we declare an error here.
00342  * I looked for a better way to define this here, but couldn't find one, so
00343  * to find the logic for this definition search for "ssize_t_fmt" in
00344  * configure.in.
00345  */
00346 #define APR_SSIZE_T_FMT "ld"
00347 
00348 /* And APR_SIZE_T_FMT */
00349 #define APR_SIZE_T_FMT "ld"
00350 
00351 /* And APR_OFF_T_FMT */
00352 #define APR_OFF_T_FMT "ld"
00353 
00354 /* And APR_PID_T_FMT */
00355 #define APR_PID_T_FMT "d"
00356 
00357 /* And APR_INT64_T_FMT */
00358 #define APR_INT64_T_FMT "ld"
00359 
00360 /* And APR_UINT64_T_FMT */
00361 #define APR_UINT64_T_FMT "lu"
00362 
00363 /* And APR_UINT64_T_HEX_FMT */
00364 #define APR_UINT64_T_HEX_FMT "lx"
00365 
00366 /* Does the proc mutex lock threads too */
00367 #define APR_PROC_MUTEX_IS_GLOBAL      0
00368 
00369 /* Local machine definition for console and log output. */
00370 #define APR_EOL_STR              "\n"
00371 
00372 
00373 #if APR_HAVE_SYS_WAIT_H
00374 #ifdef WEXITSTATUS
00375 #define apr_wait_t       int
00376 #else
00377 #define apr_wait_t       union wait
00378 #define WEXITSTATUS(status)    (int)((status).w_retcode)
00379 #define WTERMSIG(status)       (int)((status).w_termsig)
00380 #endif /* !WEXITSTATUS */
00381 #endif /* HAVE_SYS_WAIT_H */
00382 
00383 #if defined(PATH_MAX)
00384 #define APR_PATH_MAX       PATH_MAX
00385 #elif defined(_POSIX_PATH_MAX)
00386 #define APR_PATH_MAX       _POSIX_PATH_MAX
00387 #else
00388 #error no decision has been made on APR_PATH_MAX for your platform
00389 #endif
00390 
00391 /** @} */
00392 
00393 #ifdef __cplusplus
00394 }
00395 #endif
00396 
00397 #endif /* APR_H */

Generated on Sat Apr 2 21:46:29 2005 for Apache Portable Runtime by  doxygen 1.3.9.1