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 / F277206_apr_getopt.h < prev    next >
C/C++ Source or Header  |  2004-02-13  |  6KB  |  158 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_GETOPT_H
  17. #define APR_GETOPT_H
  18.  
  19. /**
  20.  * @file apr_getopt.h
  21.  * @brief APR Command Arguments (getopt)
  22.  */
  23.  
  24. #include "apr_pools.h"
  25.  
  26. #ifdef __cplusplus
  27. extern "C" {
  28. #endif /* __cplusplus */
  29.  
  30. /**
  31.  * @defgroup apr_getopt Command Argument Parsing
  32.  * @ingroup APR 
  33.  * @{
  34.  */
  35.  
  36. /** 
  37.  * defintion of a error function 
  38.  */
  39. typedef void (apr_getopt_err_fn_t)(void *arg, const char *err, ...);
  40.  
  41. /** @see apr_getopt_t */
  42. typedef struct apr_getopt_t apr_getopt_t;
  43.  
  44. /**
  45.  * Structure to store command line argument information.
  46.  */ 
  47. struct apr_getopt_t {
  48.     /** context for processing */
  49.     apr_pool_t *cont;
  50.     /** function to print error message (NULL == no messages) */
  51.     apr_getopt_err_fn_t *errfn;
  52.     /** user defined first arg to pass to error message  */
  53.     void *errarg;
  54.     /** index into parent argv vector */
  55.     int ind;
  56.     /** character checked for validity */
  57.     int opt;
  58.     /** reset getopt */
  59.     int reset;
  60.     /** count of arguments */
  61.     int argc;
  62.     /** array of pointers to arguments */
  63.     const char **argv;
  64.     /** argument associated with option */
  65.     char const* place;
  66.     /** set to nonzero to support interleaving options with regular args */
  67.     int interleave;
  68.     /** start of non-option arguments skipped for interleaving */
  69.     int skip_start;
  70.     /** end of non-option arguments skipped for interleaving */
  71.     int skip_end;
  72. };
  73.  
  74. /** @see apr_getopt_option_t */
  75. typedef struct apr_getopt_option_t apr_getopt_option_t;
  76.  
  77. /**
  78.  * Structure used to describe options that getopt should search for.
  79.  */
  80. struct apr_getopt_option_t {
  81.     /** long option name, or NULL if option has no long name */
  82.     const char *name;
  83.     /** option letter, or a value greater than 255 if option has no letter */
  84.     int optch;
  85.     /** nonzero if option takes an argument */
  86.     int has_arg;
  87.     /** a description of the option */
  88.     const char *description;
  89. };
  90.  
  91. /**
  92.  * Initialize the arguments for parsing by apr_getopt().
  93.  * @param os   The options structure created for apr_getopt()
  94.  * @param cont The pool to operate on
  95.  * @param argc The number of arguments to parse
  96.  * @param argv The array of arguments to parse
  97.  * @remark Arguments 2 and 3 are most commonly argc and argv from main(argc, argv)
  98.  * The errfn is initialized to fprintf(stderr... but may be overridden.
  99.  */
  100. APR_DECLARE(apr_status_t) apr_getopt_init(apr_getopt_t **os, apr_pool_t *cont,
  101.                                       int argc, const char * const *argv);
  102.  
  103. /**
  104.  * Parse the options initialized by apr_getopt_init().
  105.  * @param os     The apr_opt_t structure returned by apr_getopt_init()
  106.  * @param opts   A string of characters that are acceptable options to the 
  107.  *               program.  Characters followed by ":" are required to have an 
  108.  *               option associated
  109.  * @param option_ch  The next option character parsed
  110.  * @param option_arg The argument following the option character:
  111.  * @return There are four potential status values on exit. They are:
  112.  * <PRE>
  113.  *             APR_EOF      --  No more options to parse
  114.  *             APR_BADCH    --  Found a bad option character
  115.  *             APR_BADARG   --  No argument followed the option flag
  116.  *             APR_SUCCESS  --  The next option was found.
  117.  * </PRE>
  118.  */
  119. APR_DECLARE(apr_status_t) apr_getopt(apr_getopt_t *os, const char *opts, 
  120.                                      char *option_ch, const char **option_arg);
  121.  
  122. /**
  123.  * Parse the options initialized by apr_getopt_init(), accepting long
  124.  * options beginning with "--" in addition to single-character
  125.  * options beginning with "-".
  126.  * @param os     The apr_getopt_t structure created by apr_getopt_init()
  127.  * @param opts   A pointer to a list of apr_getopt_option_t structures, which
  128.  *               can be initialized with { "name", optch, has_args }.  has_args
  129.  *               is nonzero if the option requires an argument.  A structure
  130.  *               with an optch value of 0 terminates the list.
  131.  * @param option_ch  Receives the value of "optch" from the apr_getopt_option_t
  132.  *                   structure corresponding to the next option matched.
  133.  * @param option_arg Receives the argument following the option, if any.
  134.  * @return There are four potential status values on exit.   They are:
  135.  * <PRE>
  136.  *             APR_EOF      --  No more options to parse
  137.  *             APR_BADCH    --  Found a bad option character
  138.  *             APR_BADARG   --  No argument followed the option flag
  139.  *             APR_SUCCESS  --  The next option was found.
  140.  * </PRE>
  141.  * When APR_SUCCESS is returned, os->ind gives the index of the first
  142.  * non-option argument.  On error, a message will be printed to stdout unless
  143.  * os->err is set to 0.  If os->interleave is set to nonzero, options can come
  144.  * after arguments, and os->argv will be permuted to leave non-option arguments
  145.  * at the end (the original argv is unaffected).
  146.  */
  147. APR_DECLARE(apr_status_t) apr_getopt_long(apr_getopt_t *os,
  148.                       const apr_getopt_option_t *opts,
  149.                       int *option_ch,
  150.                                           const char **option_arg);
  151. /** @} */
  152.  
  153. #ifdef __cplusplus
  154. }
  155. #endif
  156.  
  157. #endif  /* ! APR_GETOPT_H */
  158.