include/apr-0/apr_lib.h

   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_LIB_H
  18 #define APR_LIB_H
  19
  20 /**
  21  * @file apr_lib.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 general purpose library routines
  26  */
  27
  28 #include "apr.h"
  29 #include "apr_errno.h"
  30
  31 #if APR_HAVE_CTYPE_H
  32 #include <ctype.h>
  33 #endif
  34 #if APR_HAVE_STDARG_H
  35 #include <stdarg.h>
  36 #endif
  37
  38 #ifdef __cplusplus
  39 extern "C" {
  40 #endif /* __cplusplus */
  41
  42 /**
  43  * @defgroup apr_lib General Purpose Library Routines
  44  * @ingroup APR
  45  * This is collection of oddballs that didn't fit anywhere else,
  46  * and might move to more appropriate headers with the release
  47  * of APR 1.0.
  48  * @{
  49  */
  50
  51 /** A constant representing a 'large' string. */
  52 #define HUGE_STRING_LEN 8192
  53
  54 /*
  55  * Define the structures used by the APR general-purpose library.
  56  */
  57
  58 /** @see apr_vformatter_buff_t */
  59 typedef struct apr_vformatter_buff_t apr_vformatter_buff_t;
  60
  61 /**
  62  * Structure used by the variable-formatter routines.
  63  */
  64 struct apr_vformatter_buff_t {
  65     /** The current position */
  66     char *curpos;
  67     /** The end position of the format string */
  68     char *endpos;
  69 };
  70
  71 /**
  72  * return the final element of the pathname
  73  * @param pathname The path to get the final element of
  74  * @return the final element of the path
  75  * @remark
  76  * <PRE>
  77  * For example:
  78  *                 "/foo/bar/gum"    -> "gum"
  79  *                 "/foo/bar/gum/"   -> ""
  80  *                 "gum"             -> "gum"
  81  *                 "bs\\path\\stuff" -> "stuff"
  82  * </PRE>
  83  */
  84 APR_DECLARE(const char *) apr_filepath_name_get(const char *pathname);
  85
  86 /** @deprecated @see apr_filepath_name_get */
  87 APR_DECLARE(const char *) apr_filename_of_pathname(const char *pathname);
  88
  89 /**
  90  * apr_killpg
  91  * Small utility macros to make things easier to read.  Not usually a
  92  * goal, to be sure..
  93  */
  94
  95 #ifdef WIN32
  96 #define apr_killpg(x, y)
  97 #else /* WIN32 */
  98 #ifdef NO_KILLPG
  99 #define apr_killpg(x, y)        (kill (-(x), (y)))
 100 #else /* NO_KILLPG */
 101 #define apr_killpg(x, y)        (killpg ((x), (y)))
 102 #endif /* NO_KILLPG */
 103 #endif /* WIN32 */
 104
 105 /**
 106  * apr_vformatter() is a generic printf-style formatting routine
 107  * with some extensions.
 108  * @param flush_func The function to call when the buffer is full
 109  * @param c The buffer to write to
 110  * @param fmt The format string
 111  * @param ap The arguments to use to fill out the format string.
 112  *
 113  * @remark
 114  * <PRE>
 115  * The extensions are:
 116  *
 117  * %%pA takes a struct in_addr *, and prints it as a.b.c.d
 118  * %%pI takes an apr_sockaddr_t * and prints it as a.b.c.d:port or
 119  *      [ipv6-address]:port
 120  * %%pT takes an apr_os_thread_t * and prints it in decimal
 121  *      ('0' is printed if !APR_HAS_THREADS)
 122  * %%pp takes a void * and outputs it in hex
 123  *
 124  * The %%p hacks are to force gcc's printf warning code to skip
 125  * over a pointer argument without complaining.  This does
 126  * mean that the ANSI-style %%p (output a void * in hex format) won't
 127  * work as expected at all, but that seems to be a fair trade-off
 128  * for the increased robustness of having printf-warnings work.
 129  *
 130  * Additionally, apr_vformatter allows for arbitrary output methods
 131  * using the apr_vformatter_buff and flush_func.
 132  *
 133  * The apr_vformatter_buff has two elements curpos and endpos.
 134  * curpos is where apr_vformatter will write the next byte of output.
 135  * It proceeds writing output to curpos, and updating curpos, until
 136  * either the end of output is reached, or curpos == endpos (i.e. the
 137  * buffer is full).
 138  *
 139  * If the end of output is reached, apr_vformatter returns the
 140  * number of bytes written.
 141  *
 142  * When the buffer is full, the flush_func is called.  The flush_func
 143  * can return -1 to indicate that no further output should be attempted,
 144  * and apr_vformatter will return immediately with -1.  Otherwise
 145  * the flush_func should flush the buffer in whatever manner is
 146  * appropriate, re apr_pool_t nitialize curpos and endpos, and return 0.
 147  *
 148  * Note that flush_func is only invoked as a result of attempting to
 149  * write another byte at curpos when curpos >= endpos.  So for
 150  * example, it's possible when the output exactly matches the buffer
 151  * space available that curpos == endpos will be true when
 152  * apr_vformatter returns.
 153  *
 154  * apr_vformatter does not call out to any other code, it is entirely
 155  * self-contained.  This allows the callers to do things which are
 156  * otherwise "unsafe".  For example, apr_psprintf uses the "scratch"
 157  * space at the unallocated end of a block, and doesn't actually
 158  * complete the allocation until apr_vformatter returns.  apr_psprintf
 159  * would be completely broken if apr_vformatter were to call anything
 160  * that used this same pool.  Similarly http_bprintf() uses the "scratch"
 161  * space at the end of its output buffer, and doesn't actually note
 162  * that the space is in use until it either has to flush the buffer
 163  * or until apr_vformatter returns.
 164  * </PRE>
 165  */
 166 APR_DECLARE(int) apr_vformatter(int (*flush_func)(apr_vformatter_buff_t *b),
 167                                 apr_vformatter_buff_t *c, const char *fmt,
 168                                 va_list ap);
 169
 170 /**
 171  * Display a prompt and read in the password from stdin.
 172  * @param prompt The prompt to display
 173  * @param pwbuf Buffer to store the password
 174  * @param bufsize The length of the password buffer.
 175  */
 176 APR_DECLARE(apr_status_t) apr_password_get(const char *prompt, char *pwbuf,
 177                                            apr_size_t *bufsize);
 178
 179 /** @} */
 180
 181 /**
 182  * @defgroup apr_ctype ctype functions
 183  * These macros allow correct support of 8-bit characters on systems which
 184  * support 8-bit characters.  Pretty dumb how the cast is required, but
 185  * that's legacy libc for ya.  These new macros do not support EOF like
 186  * the standard macros do.  Tough.
 187  * @{
 188  */
 189 /** @see isalnum */
 190 #define apr_isalnum(c) (isalnum(((unsigned char)(c))))
 191 /** @see isalpha */
 192 #define apr_isalpha(c) (isalpha(((unsigned char)(c))))
 193 /** @see iscntrl */
 194 #define apr_iscntrl(c) (iscntrl(((unsigned char)(c))))
 195 /** @see isdigit */
 196 #define apr_isdigit(c) (isdigit(((unsigned char)(c))))
 197 /** @see isgraph */
 198 #define apr_isgraph(c) (isgraph(((unsigned char)(c))))
 199 /** @see islower*/
 200 #define apr_islower(c) (islower(((unsigned char)(c))))
 201 /** @see isascii */
 202 #ifdef isascii
 203 #define apr_isascii(c) (isascii(((unsigned char)(c))))
 204 #else
 205 #define apr_isascii(c) (((c) & ~0x7f)==0)
 206 #endif
 207 /** @see isprint */
 208 #define apr_isprint(c) (isprint(((unsigned char)(c))))
 209 /** @see ispunct */
 210 #define apr_ispunct(c) (ispunct(((unsigned char)(c))))
 211 /** @see isspace */
 212 #define apr_isspace(c) (isspace(((unsigned char)(c))))
 213 /** @see isupper */
 214 #define apr_isupper(c) (isupper(((unsigned char)(c))))
 215 /** @see isxdigit */
 216 #define apr_isxdigit(c) (isxdigit(((unsigned char)(c))))
 217 /** @see tolower */
 218 #define apr_tolower(c) (tolower(((unsigned char)(c))))
 219 /** @see toupper */
 220 #define apr_toupper(c) (toupper(((unsigned char)(c))))
 221
 222 /** @} */
 223
 224 #ifdef __cplusplus
 225 }
 226 #endif
 227
 228 #endif  /* ! APR_LIB_H */