ShellCommand.h

Go to the documentation of this file.

/*
 * Copyright (C) 2009 Niek Linnenbank
 *
 * 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 3 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 __SH_SHELLCOMMAND
#define __SH_SHELLCOMMAND
 
#include <String.h>
#include <HashTable.h>
#include <Types.h>
 
class ShellCommand
{
  public:
 
    ShellCommand(const char *name, const Size minParams = 0);
 
    virtual ~ShellCommand();
 
    const char * getName() const;
 
    const char * getHelp() const;
 
    Size getMinimumParams() const;
 
    virtual int execute(const Size nparams, const char **params) = 0;
 
  protected:
 
    const char *m_name;
 
    const char *m_help;
 
    const Size m_minParams;
};
 
#endif /* __SH_SHELLCOMMAND */