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