CmdLineParser.h

Go to the documentation of this file.

/*
 * CmdLineParser.h
 *
 * Smalltalk like class library for C++
 * Command line arguments parser. Header.
 *
 * Copyright (c) 2006 Milan Cermak
 */
/*
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */
#ifndef _CMDLINEPARSER_H_
#define _CMDLINEPARSER_H_

#include <stlib/Object.h>
#include <stlib/Character.h>
#include <stlib/OrderedCollection.h>
#include <stlib/String.h>

#include <stlib/Callback0.h>
#include <stlib/Callback1.h>

struct option;

namespace Tools {

class CommandLineParser : public Core::Object
{
  protected:
    OrderedCollection *_arguments;
    Callback<void> *extra_argument_handler;
    bool parameters_mandatory;

  public:
    CommandLineParser(void);

    /* Class-accessing protocol */
    virtual String *className(void) const;

    /* Initialize-release protocol */
    template <class TReceiver>
    void addMandatoryArgument(char *longArg,
                     TReceiver *receiver, void (TReceiver::*execFunc)(void))
    {
        Callback0<TReceiver,void> *callback;
        callback = new Callback0<TReceiver,void>(receiver, execFunc);
        addArgument(new String(longArg), nil, true, callback);
    }

    template <class TReceiver>
    void addMandatoryArgument(char *longArg, char shortArg,
                     TReceiver *receiver, void (TReceiver::*execFunc)(void))
    {
        Callback0<TReceiver,void> *callback;
        callback = new Callback0<TReceiver,void>(receiver, execFunc);
        addArgument(new String(longArg), Character::value(shortArg),
                    true, callback);
    }

    template <class TReceiver, class TParam>
    void addMandatoryArgument(char *longArg, char shortArg,
                     TReceiver *receiver, void (TReceiver::*execFunc)(TParam),
                     TParam userData)
    {
        Callback1<TReceiver,void,TParam> *callback;
        callback = new Callback1<TReceiver,void,TParam>(receiver, execFunc);
        addArgument(new String(longArg), Character::value(shortArg), false,
                    callback, userData);
    }

    template <class TReceiver>
    void addOptionalArgument(char *longArg,
                     TReceiver *receiver, void (TReceiver::*execFunc)(void))
    {
        Callback0<TReceiver,void> *callback;
        callback = new Callback0<TReceiver,void>(receiver, execFunc);
        addArgument(new String(longArg), nil, false, callback);
    }

    template <class TReceiver>
    void addOptionalArgument(char *longArg, char shortArg,
                     TReceiver *receiver, void (TReceiver::*execFunc)(void))
    {
        Callback0<TReceiver,void> *callback;
        callback = new Callback0<TReceiver,void>(receiver, execFunc);
        addArgument(new String(longArg), Character::value(shortArg),
                    false, callback);
    }

    template <class TReceiver, class TParam>
    void addOptionalArgument(char *longArg, char shortArg,
                     TReceiver *receiver, void (TReceiver::*execFunc)(TParam),
                     TParam userData)
    {
        Callback1<TReceiver,void,TParam> *callback;
        callback = new Callback1<TReceiver,void,TParam>(receiver, execFunc);
        addArgument(new String(longArg), Character::value(shortArg), false,
                    callback, userData);
    }

    template <class TReceiver>
    void addMandatoryArgumentWithParameter(char *longArg,
                    TReceiver *receiver, void (TReceiver::*execFunc)(String *))
    {
        Callback1<TReceiver,void,String*> *callback;
        callback = new Callback1<TReceiver,void,String*>(receiver, execFunc);
        addArgument(new String(longArg), nil, false, callback);
    }

    template <class TReceiver>
    void addMandatoryArgumentWithParameter(char *longArg, char shortArg,
                    TReceiver *receiver, void (TReceiver::*execFunc)(String *))
    {
        Callback1<TReceiver,void,String*> *callback;
        callback = new Callback1<TReceiver,void,String*>(receiver, execFunc);
        addArgument(new String(longArg), Character::value(shortArg),
                    false, callback);
    }

    template <class TReceiver>
    void addOptionalArgumentWithParameter(char *longArg,
                    TReceiver *receiver, void (TReceiver::*execFunc)(String *))
    {
        Callback1<TReceiver,void,String*> *callback;
        callback = new Callback1<TReceiver,void,String*>(receiver, execFunc);
        addArgument(new String(longArg), nil, false, callback);
    }

    template <class TReceiver>
    void addOptionalArgumentWithParameter(char *longArg, char shortArg,
                    TReceiver *receiver, void (TReceiver::*execFunc)(String *))
    {
        Callback1<TReceiver,void,String*> *callback;
        callback = new Callback1<TReceiver,void,String*>(receiver, execFunc);
        addArgument(new String(longArg), Character::value(shortArg),
                    false, callback);
    }

    template <class TReceiver>
    void setExtraParametersHandler(TReceiver *receiver,
                                   void (TReceiver::*execFunc)(Array *))
    {
        Callback1<TReceiver,void,Array*> *callback;
        callback = new Callback1<TReceiver,void,Array*>(receiver, execFunc);
        extra_argument_handler = callback;
    }

    virtual void parametersMandatory(bool isMandatory);

    /* Processing protocol */
    virtual void process(int argc, char **argv);

    /* Private protocol */
    virtual void addArgument(String *longArg, Character *shortArg,
                             bool mandatory, Callback<void> *callback,
                             Object *userData = nil);
    virtual String *collectShortOptions(void);
    virtual struct option *collectLongOptions(void);
    virtual void checkMissingArguments(void);
};

}; /* namespace Tools */

#endif /* __CMDLINEPARSER_H */

---