tool/Command.h
author Florian Pose <fp@igh-essen.com>
Mon, 28 Jul 2008 13:23:07 +0000
changeset 1162 51a8b41d3dbc
parent 1156 ecaf2a896ea3
child 1166 006244d53f68
permissions -rw-r--r--
Display real ethernet address.
/*****************************************************************************
 *
 * $Id$
 *
 ****************************************************************************/

#ifndef __COMMAND_H__
#define __COMMAND_H__

#include <stdexcept>
#include <vector>
#include <list>
using namespace std;

#include "MasterDevice.h"

/*****************************************************************************/

extern unsigned int masterIndex;
extern int domainIndex;
extern string dataTypeStr;
extern bool force;

/****************************************************************************/

class InvalidUsageException:
    public runtime_error
{
    friend class Command;

    protected:
        /** Constructor with stringstream parameter. */
        InvalidUsageException(
                const stringstream &s /**< Message. */
                ): runtime_error(s.str()) {}
};

/****************************************************************************/

class CommandException:
    public runtime_error
{
    friend class Command;

    protected:
        /** Constructor with stringstream parameter. */
        CommandException(
                const stringstream &s /**< Message. */
                ): runtime_error(s.str()) {}
};

/****************************************************************************/

class Command
{
    public:
        Command(const string &, const string &);
		virtual ~Command();

        const string &getName() const;
        const string &getBriefDescription() const;

        enum Verbosity {
            Quiet,
            Normal,
            Verbose
        };
        void setVerbosity(Verbosity);
		Verbosity getVerbosity() const;
        void setAlias(int);
        int getAlias() const;
        void setPosition(int);
        int getPosition() const;

        bool matchesSubstr(const string &) const;
        bool matchesAbbrev(const string &) const;

        virtual string helpString() const = 0;

        typedef vector<string> StringVector;
        virtual void execute(MasterDevice &, const StringVector &) = 0;

        static string numericInfo();

    protected:
		enum {BreakAfterBytes = 16};

        void throwInvalidUsageException(const stringstream &) const;
        void throwCommandException(const stringstream &) const;
        void throwSingleSlaveRequired(unsigned int) const;

        typedef list<ec_ioctl_slave_t> SlaveList;
        SlaveList selectedSlaves(MasterDevice &);
        typedef list<ec_ioctl_config_t> ConfigList;
        ConfigList selectedConfigs(MasterDevice &);

        static string alStateString(uint8_t);

    private:
		string name;
        string briefDesc;
        Verbosity verbosity;
        int alias;
        int position;

        Command();
};

/****************************************************************************/

inline const string &Command::getName() const
{
    return name;
}

/****************************************************************************/

inline const string &Command::getBriefDescription() const
{
    return briefDesc;
}

/****************************************************************************/

inline Command::Verbosity Command::getVerbosity() const
{
    return verbosity;
}

/****************************************************************************/

inline int Command::getAlias() const
{
    return alias;
}

/****************************************************************************/

inline int Command::getPosition() const
{
    return position;
}

/****************************************************************************/

#endif