fg_argparser.h

Go to the documentation of this file.

 
/*
 * Copyright (C) 2014 Felix Rietig <felix.rietig@rwth-aachen.de>
 * Copyright (C) 2006-2013 Antonio Diaz Diaz <antonio@gnu.org>
 *
 * This file is part of Flowgrind.  It is based on the POSIX/GNU
 * command line argument parser 'arg_parser' origninally written by
 * Antonio Diaz Diaz.
 *
 * Flowgrind 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.
 *
 * Flowgrind 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 Flowgrind.  If not, see <http://www.gnu.org/licenses/>.
 *
 */
 
#ifndef _ARG_PARSER_H_
#define _ARG_PARSER_H_
 
#include <stdbool.h>
 
enum ap_Has_arg {
        ap_no = 0,
        ap_yes,
        ap_maybe
};
 
struct ap_Option {
        int code;
        char *name;
        enum ap_Has_arg has_arg;
        int tag;
        int *mutex;
};
 
struct ap_Record {
        char *opt_string;
        char *argument;
        int option_index;
};
 
struct arg_parser {
        struct ap_Option *options;
        struct ap_Record *data;
        char *error;
        int num_options;
        int data_size;
        int error_size;
        int num_mutex;
};
 
struct ap_Mutex_state {
        int *seen_records;
        int num_mutex;
};
 
bool ap_init(struct arg_parser *const ap,
             const int argc, const char *const argv[],
             const struct ap_Option options[], const char in_order);
 
void ap_free(struct arg_parser *const ap);
 
const char *ap_error(const struct arg_parser *const ap);
 
int ap_arguments(const struct arg_parser *const ap);
 
int ap_code(const struct arg_parser *const ap, const int i);
 
const char *ap_argument(const struct arg_parser *const ap, const int i);
 
const struct ap_Option *ap_option(const struct arg_parser *const ap, const int i);
 
const char *ap_opt_string(const struct arg_parser *const ap, const int i);
 
bool ap_is_used(const struct arg_parser *const ap, int code);
 
bool ap_init_mutex_state(const struct arg_parser *const ap,
                         struct ap_Mutex_state *const ms);
 
bool ap_check_mutex(const struct arg_parser *const ap,
                    const struct ap_Mutex_state *const ms,
                    const int i, int *conflict);
 
bool ap_set_mutex(const struct arg_parser *const ap,
                  struct ap_Mutex_state *const ms, const int i);
 
bool ap_set_check_mutex(const struct arg_parser *const ap,
                        struct ap_Mutex_state *const ms,
                        const int i, int *conflict);
 
void ap_reset_mutex(struct ap_Mutex_state *const ms);
 
void ap_free_mutex_state(struct ap_Mutex_state *const ms);
 
#endif /* _ARG_PARSER_H_ */