/* 
 * Copyright (C) 2006 Registro.br. All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 * 1. Redistribution of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 
 * THIS SOFTWARE IS PROVIDED BY REGISTRO.BR ``AS IS AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIE OF FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
 * EVENT SHALL REGISTRO.BR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
 * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
 * USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
 * DAMAGE.
 */
/* $Id: SheppCommand.H 804 2006-08-03 12:56:01Z eduardo $ */
/** @file SheppCommand.H
 *  @brief EPP command-line shell client Command class
 */

#ifndef __SHEPP_COMMAND_H__
#define __SHEPP_COMMAND_H__

#include <string>
using std::string;

typedef int isfunc_t (vector<string> &);

/// SheppCommand class: command name, function and a brief description
class SheppCommand {
public:
  /// Operator necessary to create a set of SheppCommands
  bool operator<(const SheppCommand &cmd) const {
    return name < cmd.name;
  }

  /// Constructor that initializes all object attributes to empty
  SheppCommand()
  {
    init();
  }

  /// Constructor that sets all object attributes
  SheppCommand(string name, isfunc_t *function, string brief)
  {
    this->name = name;
    this->function = function;
    this->brief = brief;
  }

  /// Reinitializes all object attributes
  void reset(string name, isfunc_t *function, string brief)
  {
    this->name = name;
    this->function = function;
    this->brief = brief;
  }

  /// SheppCommand name
  string name;

  /// Function to be called
  isfunc_t *function;

  /// SheppCommand brief description
  string brief;
protected:
  /// Initializes all object attributes to empty
  void init()
  {
    name = "";
    function = NULL;
    brief = "";
  }
};

#endif //__SHEPP_COMMAND_H__