summaryrefslogtreecommitdiff
path: root/carg_parser.h
diff options
context:
space:
mode:
Diffstat (limited to 'carg_parser.h')
-rw-r--r--carg_parser.h85
1 files changed, 85 insertions, 0 deletions
diff --git a/carg_parser.h b/carg_parser.h
new file mode 100644
index 0000000..d343c3c
--- /dev/null
+++ b/carg_parser.h
@@ -0,0 +1,85 @@
+/* Arg_parser - A POSIX/GNU command line argument parser. C version
+ Copyright (C) 2006, 2007, 2008, 2009 Antonio Diaz Diaz.
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU General Public License as published by
+ the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU General Public License for more details.
+
+ You should have received a copy of the GNU General Public License
+ along with this program. If not, see <http://www.gnu.org/licenses/>.
+*/
+
+/* Arg_parser reads the arguments in `argv' and creates a number of
+ option codes, option arguments and non-option arguments.
+
+ In case of error, `ap_error' returns a non-null pointer to an error
+ message.
+
+ `options' is an array of `struct ap_Option' terminated by an element
+ containing a code which is zero. A null name means a short-only
+ option. A code value outside the unsigned char range means a
+ long-only option.
+
+ Arg_parser normally makes it appear as if all the option arguments
+ were specified before all the non-option arguments for the purposes
+ of parsing, even if the user of your program intermixed option and
+ non-option arguments. If you want the arguments in the exact order
+ the user typed them, call `ap_init' with `in_order' = true.
+
+ The argument `--' terminates all options; any following arguments are
+ treated as non-option arguments, even if they begin with a hyphen.
+
+ The syntax for optional option arguments is `-<short_option><argument>'
+ (without whitespace), or `--<long_option>=<argument>'.
+*/
+
+typedef enum { ap_no, ap_yes, ap_maybe } ap_Has_arg;
+
+typedef struct
+ {
+ int code; // Short option letter or code ( code != 0 )
+ const char * name; // Long option name (maybe null)
+ ap_Has_arg has_arg;
+ }
+ap_Option;
+
+
+typedef struct
+ {
+ int code;
+ char * argument;
+ }
+ap_Record;
+
+
+typedef struct
+ {
+ ap_Record * data;
+ char * error;
+ int data_size;
+ int error_size;
+ }
+Arg_parser;
+
+
+char ap_init( Arg_parser * ap, const int argc, const char * const argv[],
+ const ap_Option options[], const char in_order );
+
+void ap_free( Arg_parser * ap );
+
+const char * ap_error( const Arg_parser * ap );
+
+ // The number of arguments parsed (may be different from argc)
+int ap_arguments( const Arg_parser * ap );
+
+ // If ap_code( i ) is 0, ap_argument( i ) is a non-option.
+ // Else ap_argument( i ) is the option's argument (or empty).
+int ap_code( const Arg_parser * ap, const int i );
+
+const char * ap_argument( const Arg_parser * ap, const int i );