Main Page | Modules | Data Structures | File List | Data Fields | Globals | Related Pages

apr_getopt.h

Go to the documentation of this file.
00001 /* ====================================================================
00002  * The Apache Software License, Version 1.1
00003  *
00004  * Copyright (c) 2000-2003 The Apache Software Foundation.  All rights
00005  * reserved.
00006  *
00007  * Redistribution and use in source and binary forms, with or without
00008  * modification, are permitted provided that the following conditions
00009  * are met:
00010  *
00011  * 1. Redistributions of source code must retain the above copyright
00012  *    notice, this list of conditions and the following disclaimer.
00013  *
00014  * 2. Redistributions in binary form must reproduce the above copyright
00015  *    notice, this list of conditions and the following disclaimer in
00016  *    the documentation and/or other materials provided with the
00017  *    distribution.
00018  *
00019  * 3. The end-user documentation included with the redistribution,
00020  *    if any, must include the following acknowledgment:
00021  *       "This product includes software developed by the
00022  *        Apache Software Foundation (http://www.apache.org/)."
00023  *    Alternately, this acknowledgment may appear in the software itself,
00024  *    if and wherever such third-party acknowledgments normally appear.
00025  *
00026  * 4. The names "Apache" and "Apache Software Foundation" must
00027  *    not be used to endorse or promote products derived from this
00028  *    software without prior written permission. For written
00029  *    permission, please contact apache@apache.org.
00030  *
00031  * 5. Products derived from this software may not be called "Apache",
00032  *    nor may "Apache" appear in their name, without prior written
00033  *    permission of the Apache Software Foundation.
00034  *
00035  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00036  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00037  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00038  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00039  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00040  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00041  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00042  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00043  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00044  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00045  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00046  * SUCH DAMAGE.
00047  * ====================================================================
00048  *
00049  * This software consists of voluntary contributions made by many
00050  * individuals on behalf of the Apache Software Foundation.  For more
00051  * information on the Apache Software Foundation, please see
00052  * <http://www.apache.org/>.
00053  */
00054 
00055 #ifndef APR_GETOPT_H
00056 #define APR_GETOPT_H
00057 
00063 #include "apr_pools.h"
00064 
00065 #ifdef __cplusplus
00066 extern "C" {
00067 #endif /* __cplusplus */
00068 
00078 typedef void (apr_getopt_err_fn_t)(void *arg, const char *err, ...);
00079 
00081 typedef struct apr_getopt_t apr_getopt_t;
00082 
00086 struct apr_getopt_t {
00088     apr_pool_t *cont;
00090     apr_getopt_err_fn_t *errfn;
00092     void *errarg;
00094     int ind;
00096     int opt;
00098     int reset;
00100     int argc;
00102     const char **argv;
00104     char const* place;
00106     int interleave;
00108     int skip_start;
00110     int skip_end;
00111 };
00112 
00114 typedef struct apr_getopt_option_t apr_getopt_option_t;
00115 
00119 struct apr_getopt_option_t {
00121     const char *name;
00123     int optch;
00125     int has_arg;
00127     const char *description;
00128 };
00129 
00139 APR_DECLARE(apr_status_t) apr_getopt_init(apr_getopt_t **os, apr_pool_t *cont,
00140                                       int argc, const char * const *argv);
00141 
00158 APR_DECLARE(apr_status_t) apr_getopt(apr_getopt_t *os, const char *opts, 
00159                                      char *option_ch, const char **option_arg);
00160 
00186 APR_DECLARE(apr_status_t) apr_getopt_long(apr_getopt_t *os,
00187                                           const apr_getopt_option_t *opts,
00188                                           int *option_ch,
00189                                           const char **option_arg);
00192 #ifdef __cplusplus
00193 }
00194 #endif
00195 
00196 #endif  /* ! APR_GETOPT_H */

Generated on Wed Apr 13 15:56:31 2005 for Apache Portable Runtime by  doxygen 1.3.9.1