Use of pre_cleanups is not the default for reslists.
[apr-util.git] / include / apu.h.in
blob64c6c18b852ede78d4136cff7ba5613b4a473073
1 /* Licensed to the Apache Software Foundation (ASF) under one or more
2 * contributor license agreements. See the NOTICE file distributed with
3 * this work for additional information regarding copyright ownership.
4 * The ASF licenses this file to You under the Apache License, Version 2.0
5 * (the "License"); you may not use this file except in compliance with
6 * the License. You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
18 * apu.h is generated from apu.h.in by configure -- do not edit apu.h
20 /* @file apu.h
21 * @brief APR-Utility main file
23 /**
24 * @defgroup APR_Util APR Utility Functions
25 * @{
29 #ifndef APU_H
30 #define APU_H
32 /**
33 * APU_DECLARE_EXPORT is defined when building the APR-UTIL dynamic library,
34 * so that all public symbols are exported.
36 * APU_DECLARE_STATIC is defined when including the APR-UTIL public headers,
37 * to provide static linkage when the dynamic library may be unavailable.
39 * APU_DECLARE_STATIC and APU_DECLARE_EXPORT are left undefined when
40 * including the APR-UTIL public headers, to import and link the symbols from
41 * the dynamic APR-UTIL library and assure appropriate indirection and calling
42 * conventions at compile time.
45 /**
46 * The public APR-UTIL functions are declared with APU_DECLARE(), so they may
47 * use the most appropriate calling convention. Public APR functions with
48 * variable arguments must use APU_DECLARE_NONSTD().
50 * @fn APU_DECLARE(rettype) apr_func(args);
52 #define APU_DECLARE(type) type
53 /**
54 * The public APR-UTIL functions using variable arguments are declared with
55 * APU_DECLARE_NONSTD(), as they must use the C language calling convention.
57 * @fn APU_DECLARE_NONSTD(rettype) apr_func(args, ...);
59 #define APU_DECLARE_NONSTD(type) type
60 /**
61 * The public APR-UTIL variables are declared with APU_DECLARE_DATA.
62 * This assures the appropriate indirection is invoked at compile time.
64 * @fn APU_DECLARE_DATA type apr_variable;
65 * @note APU_DECLARE_DATA extern type apr_variable; syntax is required for
66 * declarations within headers to properly import the variable.
68 #define APU_DECLARE_DATA
70 #if !defined(WIN32) || defined(APU_MODULE_DECLARE_STATIC)
71 /**
72 * Declare a dso module's exported module structure as APU_MODULE_DECLARE_DATA.
74 * Unless APU_MODULE_DECLARE_STATIC is defined at compile time, symbols
75 * declared with APU_MODULE_DECLARE_DATA are always exported.
76 * @code
77 * module APU_MODULE_DECLARE_DATA mod_tag
78 * @endcode
80 #define APU_MODULE_DECLARE_DATA
81 #else
82 #define APU_MODULE_DECLARE_DATA __declspec(dllexport)
83 #endif
86 * we always have SDBM (it's in our codebase)
88 #define APU_HAVE_SDBM @apu_have_sdbm@
89 #define APU_HAVE_GDBM @apu_have_gdbm@
90 #define APU_HAVE_NDBM @apu_have_ndbm@
91 #define APU_HAVE_DB @apu_have_db@
93 #if APU_HAVE_DB
94 #define APU_HAVE_DB_VERSION @apu_db_version@
95 #endif
97 #define APU_HAVE_PGSQL @apu_have_pgsql@
98 #define APU_HAVE_MYSQL @apu_have_mysql@
99 #define APU_HAVE_SQLITE3 @apu_have_sqlite3@
100 #define APU_HAVE_SQLITE2 @apu_have_sqlite2@
101 #define APU_HAVE_ORACLE @apu_have_oracle@
102 #define APU_HAVE_FREETDS @apu_have_freetds@
103 #define APU_HAVE_ODBC @apu_have_odbc@
105 #define APU_HAVE_APR_ICONV @have_apr_iconv@
106 #define APU_HAVE_ICONV @have_iconv@
107 #define APR_HAS_XLATE (APU_HAVE_APR_ICONV || APU_HAVE_ICONV)
109 #endif /* APU_H */
110 /** @} */