lib/arglex.h

Go to the documentation of this file.

//
// nis-util - NIS Administration Utilities
// Copyright (C) 2001, 2008, 2009, 2011, 2012 Peter Miller
//
// 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 2 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/>.
//

#ifndef LIB_ARGLEX_H
#define LIB_ARGLEX_H

#include <list>

#include <lib/arglex/source.h>

#define ARGLEX_END_MARKER {0,0}

class arglex
{
public:
    virtual ~arglex();

    arglex(int argc, char **argv);

    enum
    {
        token_configuration_file,
        token_eoln,
        token_group_name_maximum,
        token_help,
        token_license,
        token_number,
        token_option,
        token_page_length,
        token_page_width,
        token_passwd_name_maximum,
        token_stdio,
        token_string,
        token_tracing,
        token_verbose,
        token_verbose_not,
        token_version,
        token_warning,
        token_warning_not,
        token_MAX
    };

    int token_first(void);

    int token_next(void);

    int token_cur(void) const { return token; }

    rcstring get_string_value(void) const { return value_string; }

    long get_integer_value(void) const { return value_number; }

    const source_location &get_source_location(void) const;

    const char *token_name(int num) const;

    void usage(void) const;

    void bad_argument(void) const;

    void generic_argument(void);

    static bool compare(const char *formal, const char *actual);

    void check_stdin_references(void);

    void check_stdout_references(void);

    rcstring get_filename_or_stdin(void);

    void get_filename_or_stdin(rcstring &fnvar);

    rcstring get_filename_or_stdout(void);

    void get_filename_or_stdout(rcstring &fnvar);

protected:
    struct table_t
    {
        const char *name;
        int token;
    };

    void table_set(const table_t *tp);

    void usage_tail_set(const char *text);

private:
    void help(const char *name = 0) const;

    void version(void) const;

    void license(void) const;

    typedef std::list<arglex_source::pointer> sources_t;

    sources_t sources;

    int token;

    source_location token_locn;

    rcstring value_string;

    long value_number;

    typedef std::list<const table_t *> tables_t;

    tables_t tables;

    const char *usage_tail_;

    const char *usage_tail_get(void) const;

    int number_of_stdin_references;

    int number_of_stdout_references;

    void push_arg_back(const char *text);

    arglex();

    arglex(const arglex &rhs);

    arglex &operator=(const arglex &rhs);
};

// vim: set ts=8 sw=4 et :
#endif // LIB_ARGLEX_H