include/wvargs.h

/* -*- Mode: C++ -*-
 *   Copyright (C) 2004-2005 Net Integration Technologies, Inc.
 *
 * WvStreams interface for command-line argument processing
 */
#ifndef __WVARGS_H
#define __WVARGS_H
 
#include "wvstring.h"
#include "wvstringlist.h"
#include "wvtr1.h"
 
class WvArgsOption;
class WvArgsData;

class WvArgs
{
public:

    typedef wv::function<bool(void*)> NoArgCallback;
    typedef wv::function<bool(WvStringParm, void*)> ArgCallback;
 
private:
 
    WvArgsData *data;
    WvString args_doc;
    WvString version;
    WvString email;
    WvString header;
    WvString footer;
 
public:
 
    WvArgs();
    ~WvArgs();

    bool process(int argc, char **argv,
                 WvStringList *remaining_args = NULL);

    void set_version(WvStringParm version);

    void set_email(WvStringParm email);

    void set_help_header(WvStringParm header);

    void set_help_footer(WvStringParm footer);

    void print_usage(int argc, char **argv);
    void print_help(int argc, char **argv);

    void add_set_bool_option(char short_option, WvStringParm long_option,
                             WvStringParm desc, bool &val);
    void add_reset_bool_option(char short_option, WvStringParm long_option,
                               WvStringParm desc, bool &val);
    void add_flip_bool_option(char short_option, WvStringParm long_option,
                              WvStringParm desc, bool &val);

    void add_option(char short_option, WvStringParm long_option,
                    WvStringParm desc, WvStringParm arg_desc, int &val);
    void add_option(char short_option, WvStringParm long_option,
                    WvStringParm desc, WvStringParm arg_desc, long &val);
    void add_option(char short_option, WvStringParm long_option,
                    WvStringParm desc, WvStringParm arg_desc, float &val);
    void add_option(char short_option, WvStringParm long_option,
                    WvStringParm desc, WvStringParm arg_desc, double &val);
    void add_option(char short_option, WvStringParm long_option,
                    WvStringParm desc, WvStringParm arg_desc, WvString &val);
    void add_option(char short_option, WvStringParm long_option,
                    WvStringParm desc, WvStringParm arg_desc,
                    WvStringList &val);
    void add_option(char short_option, WvStringParm long_option,
                    WvStringParm desc, NoArgCallback cb, void *ud = NULL);
    void add_option(char short_option, WvStringParm long_option,
                    WvStringParm desc, WvStringParm arg_desc,
                    ArgCallback cb, void *ud = NULL);

    void add_required_arg(WvStringParm desc, bool multiple = false);
    void add_optional_arg(WvStringParm desc, bool multiple = false);

    void remove_option(char short_option);
    void remove_option(WvStringParm long_option);

    void remove_all_options();
    void zap()
    {
        remove_all_options();
    }

    enum flags_t
    {
        NO_EXIT_ON_ERRORS,      // Do not exit when an error is encountered
        FLAGS_SIZE              // Number of flags that exist
    };

    bool get_flag(const flags_t flag) const;
    void set_flag(const flags_t flag, const bool value);
 
};
 
#endif // __WVARGS_H