home *** CD-ROM | disk | FTP | other *** search
/ GameStar 2004 May / Gamestar_62_2004-05_dvd.iso / Programy / apache_2.0.48-win32-x86-no_ssl.msi / Data.Cab / F251753_apr_lib.h < prev    next >
C/C++ Source or Header  |  2003-04-17  |  10KB  |  267 lines
  1. /* ====================================================================
  2.  * The Apache Software License, Version 1.1
  3.  *
  4.  * Copyright (c) 2000-2003 The Apache Software Foundation.  All rights
  5.  * reserved.
  6.  *
  7.  * Redistribution and use in source and binary forms, with or without
  8.  * modification, are permitted provided that the following conditions
  9.  * are met:
  10.  *
  11.  * 1. Redistributions of source code must retain the above copyright
  12.  *    notice, this list of conditions and the following disclaimer.
  13.  *
  14.  * 2. Redistributions in binary form must reproduce the above copyright
  15.  *    notice, this list of conditions and the following disclaimer in
  16.  *    the documentation and/or other materials provided with the
  17.  *    distribution.
  18.  *
  19.  * 3. The end-user documentation included with the redistribution,
  20.  *    if any, must include the following acknowledgment:
  21.  *       "This product includes software developed by the
  22.  *        Apache Software Foundation (http://www.apache.org/)."
  23.  *    Alternately, this acknowledgment may appear in the software itself,
  24.  *    if and wherever such third-party acknowledgments normally appear.
  25.  *
  26.  * 4. The names "Apache" and "Apache Software Foundation" must
  27.  *    not be used to endorse or promote products derived from this
  28.  *    software without prior written permission. For written
  29.  *    permission, please contact apache@apache.org.
  30.  *
  31.  * 5. Products derived from this software may not be called "Apache",
  32.  *    nor may "Apache" appear in their name, without prior written
  33.  *    permission of the Apache Software Foundation.
  34.  *
  35.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  36.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  37.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  38.  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  39.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  42.  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  43.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  44.  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  45.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  46.  * SUCH DAMAGE.
  47.  * ====================================================================
  48.  *
  49.  * This software consists of voluntary contributions made by many
  50.  * individuals on behalf of the Apache Software Foundation.  For more
  51.  * information on the Apache Software Foundation, please see
  52.  * <http://www.apache.org/>.
  53.  */
  54.  
  55. #ifndef APR_LIB_H
  56. #define APR_LIB_H
  57.  
  58. /**
  59.  * @file apr_lib.h
  60.  * This is collection of oddballs that didn't fit anywhere else,
  61.  * and might move to more appropriate headers with the release
  62.  * of APR 1.0.
  63.  * @brief APR general purpose library routines
  64.  */
  65.  
  66. #include "apr.h"
  67. #include "apr_errno.h"
  68.  
  69. #if APR_HAVE_CTYPE_H
  70. #include <ctype.h>
  71. #endif
  72. #if APR_HAVE_STDARG_H
  73. #include <stdarg.h>
  74. #endif
  75.  
  76. #ifdef __cplusplus
  77. extern "C" {
  78. #endif /* __cplusplus */
  79.  
  80. /**
  81.  * @defgroup apr_lib General Purpose Library Routines
  82.  * @ingroup APR 
  83.  * This is collection of oddballs that didn't fit anywhere else,
  84.  * and might move to more appropriate headers with the release
  85.  * of APR 1.0.
  86.  * @{
  87.  */
  88.  
  89. /** A constant representing a 'large' string. */
  90. #define HUGE_STRING_LEN 8192
  91.  
  92. /*
  93.  * Define the structures used by the APR general-purpose library.
  94.  */
  95.  
  96. /** @see apr_vformatter_buff_t */
  97. typedef struct apr_vformatter_buff_t apr_vformatter_buff_t;
  98.  
  99. /**
  100.  * Structure used by the variable-formatter routines.
  101.  */
  102. struct apr_vformatter_buff_t {
  103.     /** The current position */
  104.     char *curpos;
  105.     /** The end position of the format string */
  106.     char *endpos;
  107. };
  108.  
  109. /**
  110.  * return the final element of the pathname
  111.  * @param pathname The path to get the final element of
  112.  * @return the final element of the path
  113.  * @remark
  114.  * <PRE>
  115.  * For example:
  116.  *                 "/foo/bar/gum"    -> "gum"
  117.  *                 "/foo/bar/gum/"   -> ""
  118.  *                 "gum"             -> "gum"
  119.  *                 "bs\\path\\stuff" -> "stuff"
  120.  * </PRE>
  121.  */
  122. APR_DECLARE(const char *) apr_filepath_name_get(const char *pathname);
  123.  
  124. /** @deprecated @see apr_filepath_name_get */
  125. APR_DECLARE(const char *) apr_filename_of_pathname(const char *pathname);
  126.  
  127. /**
  128.  * apr_killpg
  129.  * Small utility macros to make things easier to read.  Not usually a
  130.  * goal, to be sure..
  131.  */
  132.  
  133. #ifdef WIN32
  134. #define apr_killpg(x, y)
  135. #else /* WIN32 */
  136. #ifdef NO_KILLPG
  137. #define apr_killpg(x, y)        (kill (-(x), (y)))
  138. #else /* NO_KILLPG */
  139. #define apr_killpg(x, y)        (killpg ((x), (y)))
  140. #endif /* NO_KILLPG */
  141. #endif /* WIN32 */
  142.  
  143. /**
  144.  * apr_vformatter() is a generic printf-style formatting routine
  145.  * with some extensions.
  146.  * @param flush_func The function to call when the buffer is full
  147.  * @param c The buffer to write to
  148.  * @param fmt The format string
  149.  * @param ap The arguments to use to fill out the format string.
  150.  *
  151.  * @remark
  152.  * <PRE>
  153.  * The extensions are:
  154.  *
  155.  * %%pA    takes a struct in_addr *, and prints it as a.b.c.d
  156.  * %%pI    takes an apr_sockaddr_t * and prints it as a.b.c.d:port or
  157.  *      [ipv6-address]:port
  158.  * %%pT takes an apr_os_thread_t * and prints it in decimal
  159.  *      ('0' is printed if !APR_HAS_THREADS)
  160.  * %%pp takes a void * and outputs it in hex
  161.  *
  162.  * The %%p hacks are to force gcc's printf warning code to skip
  163.  * over a pointer argument without complaining.  This does
  164.  * mean that the ANSI-style %%p (output a void * in hex format) won't
  165.  * work as expected at all, but that seems to be a fair trade-off
  166.  * for the increased robustness of having printf-warnings work.
  167.  *
  168.  * Additionally, apr_vformatter allows for arbitrary output methods
  169.  * using the apr_vformatter_buff and flush_func.
  170.  *
  171.  * The apr_vformatter_buff has two elements curpos and endpos.
  172.  * curpos is where apr_vformatter will write the next byte of output.
  173.  * It proceeds writing output to curpos, and updating curpos, until
  174.  * either the end of output is reached, or curpos == endpos (i.e. the
  175.  * buffer is full).
  176.  *
  177.  * If the end of output is reached, apr_vformatter returns the
  178.  * number of bytes written.
  179.  *
  180.  * When the buffer is full, the flush_func is called.  The flush_func
  181.  * can return -1 to indicate that no further output should be attempted,
  182.  * and apr_vformatter will return immediately with -1.  Otherwise
  183.  * the flush_func should flush the buffer in whatever manner is
  184.  * appropriate, re apr_pool_t nitialize curpos and endpos, and return 0.
  185.  *
  186.  * Note that flush_func is only invoked as a result of attempting to
  187.  * write another byte at curpos when curpos >= endpos.  So for
  188.  * example, it's possible when the output exactly matches the buffer
  189.  * space available that curpos == endpos will be true when
  190.  * apr_vformatter returns.
  191.  *
  192.  * apr_vformatter does not call out to any other code, it is entirely
  193.  * self-contained.  This allows the callers to do things which are
  194.  * otherwise "unsafe".  For example, apr_psprintf uses the "scratch"
  195.  * space at the unallocated end of a block, and doesn't actually
  196.  * complete the allocation until apr_vformatter returns.  apr_psprintf
  197.  * would be completely broken if apr_vformatter were to call anything
  198.  * that used a apr_pool_t.  Similarly http_bprintf() uses the "scratch"
  199.  * space at the end of its output buffer, and doesn't actually note
  200.  * that the space is in use until it either has to flush the buffer
  201.  * or until apr_vformatter returns.
  202.  * </PRE>
  203.  */
  204. APR_DECLARE(int) apr_vformatter(int (*flush_func)(apr_vformatter_buff_t *b),
  205.                     apr_vformatter_buff_t *c, const char *fmt,
  206.                     va_list ap);
  207.  
  208. /**
  209.  * Display a prompt and read in the password from stdin.
  210.  * @param prompt The prompt to display
  211.  * @param pwbuf Buffer to store the password
  212.  * @param bufsize The length of the password buffer.
  213.  */
  214. APR_DECLARE(apr_status_t) apr_password_get(const char *prompt, char *pwbuf, 
  215.                                            apr_size_t *bufsize);
  216.  
  217. /** @} */
  218.  
  219. /**
  220.  * @defgroup apr_ctype ctype functions
  221.  * These macros allow correct support of 8-bit characters on systems which
  222.  * support 8-bit characters.  Pretty dumb how the cast is required, but
  223.  * that's legacy libc for ya.  These new macros do not support EOF like
  224.  * the standard macros do.  Tough.
  225.  * @{
  226.  */
  227. /** @see isalnum */
  228. #define apr_isalnum(c) (isalnum(((unsigned char)(c))))
  229. /** @see isalpha */
  230. #define apr_isalpha(c) (isalpha(((unsigned char)(c))))
  231. /** @see iscntrl */
  232. #define apr_iscntrl(c) (iscntrl(((unsigned char)(c))))
  233. /** @see isdigit */
  234. #define apr_isdigit(c) (isdigit(((unsigned char)(c))))
  235. /** @see isgraph */
  236. #define apr_isgraph(c) (isgraph(((unsigned char)(c))))
  237. /** @see islower*/
  238. #define apr_islower(c) (islower(((unsigned char)(c))))
  239. /** @see isascii */
  240. #ifdef isascii
  241. #define apr_isascii(c) (isascii(((unsigned char)(c))))
  242. #else
  243. #define apr_isascii(c) (((c) & ~0x7f)==0)
  244. #endif
  245. /** @see isprint */
  246. #define apr_isprint(c) (isprint(((unsigned char)(c))))
  247. /** @see ispunct */
  248. #define apr_ispunct(c) (ispunct(((unsigned char)(c))))
  249. /** @see isspace */
  250. #define apr_isspace(c) (isspace(((unsigned char)(c))))
  251. /** @see isupper */
  252. #define apr_isupper(c) (isupper(((unsigned char)(c))))
  253. /** @see isxdigit */
  254. #define apr_isxdigit(c) (isxdigit(((unsigned char)(c))))
  255. /** @see tolower */
  256. #define apr_tolower(c) (tolower(((unsigned char)(c))))
  257. /** @see toupper */
  258. #define apr_toupper(c) (toupper(((unsigned char)(c))))
  259.  
  260. /** @} */
  261.  
  262. #ifdef __cplusplus
  263. }
  264. #endif
  265.  
  266. #endif    /* ! APR_LIB_H */
  267.