Option.h

/*
 *  Option class interface
 *
 *  This file is part of OTAWA
 *  Copyright (c) 2004-07, IRIT UPS.
 * 
 *  OTAWA 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.
 *
 *  OTAWA 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 OTAWA; if not, write to the Free Software 
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */
#ifndef ELM_OPTION_OPTION_H
#define ELM_OPTION_OPTION_H
 
#include <elm/util/VarArg.h>
#include <elm/string.h>
#include <elm/io.h>
#include <elm/data/Vector.h>
 
namespace elm { namespace option {
 
class Manager;
 
// OptionException exception
class OptionException: public MessageException {
public:
    OptionException(const String& message);
};
 
 
// Argument usage
typedef enum usage_t {
    arg_none,
    arg_optional,
    arg_required
} usage_t;
 
 
// Option class
class Option {
public:
 
    class Make {
        friend class Option;
    public:
        inline Make(Manager *m): man(*m) { }
        inline Make(Manager& m): man(m) { }
        inline Make& cmd(string cmd) { cmds.add(cmd); return *this; }
        inline Make& help(cstring d) { _desc = d; return *this; }
        inline Make& description(cstring desc) { _desc = desc; return *this; }
    protected:
        Manager& man;
        Vector<string> cmds;
        cstring _desc;
    };
 
    inline Option() { }
    Option(const Make& make);
    virtual ~Option() { }
    virtual cstring description();
    virtual usage_t usage() = 0;
    virtual cstring argDescription() = 0;
    virtual void process(String arg) = 0;
 
protected:
    cstring desc;
};
 
} } // elm::option
 
#endif // ELM_OPTION_OPTION_H