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