/* Licensed to the Apache Software Foundation (ASF) under one or more * contributor license agreements. See the NOTICE file distributed with * this work for additional information regarding copyright ownership. * The ASF licenses this file to You under the Apache License, Version 2.0 * (the "License"); you may not use this file except in compliance with * the License. You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ #ifndef APR_GETOPT_H #define APR_GETOPT_H /** * @file apr_getopt.h * @brief APR Command Arguments (getopt) */ #include "apr_pools.h" #ifdef __cplusplus extern "C" { #endif /* __cplusplus */ /** * @defgroup apr_getopt Command Argument Parsing * @ingroup APR * @{ */ /** * An @c apr_getopt_t error callback function. * * @a arg is this @c apr_getopt_t's @c errarg member. */ typedef void (apr_getopt_err_fn_t)(void *arg, const char *err, ...); /** @see apr_getopt_t */ typedef struct apr_getopt_t apr_getopt_t; /** * Structure to store command line argument information. */ struct apr_getopt_t { /** context for processing */ apr_pool_t *cont; /** function to print error message (NULL == no messages) */ apr_getopt_err_fn_t *errfn; /** user defined first arg to pass to error message */ void *errarg; /** index into parent argv vector */ int ind; /** character checked for validity */ int opt; /** reset getopt */ int reset; /** count of arguments */ int argc; /** array of pointers to arguments */ const char **argv; /** argument associated with option */ char const* place; /** set to nonzero to support interleaving options with regular args */ int interleave; /** start of non-option arguments skipped for interleaving */ int skip_start; /** end of non-option arguments skipped for interleaving */ int skip_end; }; /** @see apr_getopt_option_t */ typedef struct apr_getopt_option_t apr_getopt_option_t; /** * Structure used to describe options that getopt should search for. */ struct apr_getopt_option_t { /** long option name, or NULL if option has no long name */ const char *name; /** option letter, or a value greater than 255 if option has no letter */ int optch; /** nonzero if option takes an argument */ int has_arg; /** a description of the option */ const char *description; }; /** * Initialize the arguments for parsing by apr_getopt(). * @param os The options structure created for apr_getopt() * @param cont The pool to operate on * @param argc The number of arguments to parse * @param argv The array of arguments to parse * @remark Arguments 3 and 4 are most commonly argc and argv from main(argc, argv) * The (*os)->errfn is initialized to fprintf(stderr... but may be overridden. */ APR_DECLARE(apr_status_t) apr_getopt_init(apr_getopt_t **os, apr_pool_t *cont, int argc, const char * const *argv); /** * Parse the options initialized by apr_getopt_init(). * @param os The apr_opt_t structure returned by apr_getopt_init() * @param opts A string of characters that are acceptable options to the * program. Characters followed by ":" are required to have an * option associated * @param option_ch The next option character parsed * @param option_arg The argument following the option character: * @return There are four potential status values on exit. They are: * <PRE> * APR_EOF -- No more options to parse * APR_BADCH -- Found a bad option character * APR_BADARG -- No argument followed the option flag * APR_SUCCESS -- The next option was found. * </PRE> */ APR_DECLARE(apr_status_t) apr_getopt(apr_getopt_t *os, const char *opts, char *option_ch, const char **option_arg); /** * Parse the options initialized by apr_getopt_init(), accepting long * options beginning with "--" in addition to single-character * options beginning with "-". * @param os The apr_getopt_t structure created by apr_getopt_init() * @param opts A pointer to a list of apr_getopt_option_t structures, which * can be initialized with { "name", optch, has_args }. has_args * is nonzero if the option requires an argument. A structure * with an optch value of 0 terminates the list. * @param option_ch Receives the value of "optch" from the apr_getopt_option_t * structure corresponding to the next option matched. * @param option_arg Receives the argument following the option, if any. * @return There are four potential status values on exit. They are: * <PRE> * APR_EOF -- No more options to parse * APR_BADCH -- Found a bad option character * APR_BADARG -- No argument followed the option flag * APR_SUCCESS -- The next option was found. * </PRE> * When APR_SUCCESS is returned, os->ind gives the index of the first * non-option argument. On error, a message will be printed to stdout unless * os->err is set to 0. If os->interleave is set to nonzero, options can come * after arguments, and os->argv will be permuted to leave non-option arguments * at the end (the original argv is unaffected). */ APR_DECLARE(apr_status_t) apr_getopt_long(apr_getopt_t *os, const apr_getopt_option_t *opts, int *option_ch, const char **option_arg); /** @} */ #ifdef __cplusplus } #endif #endif /* ! APR_GETOPT_H */