command_utils.h

Go to the documentation of this file.

/* Author(s)     : Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date : 2014-09-25
 * Last modified : 2016-06-23
 *
 * Copyright (C) 2014-2016 Francois Mauger <mauger@lpccaen.in2p3.fr>
 *
 * 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, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 *
 * Description:
 *
 *  Command utilities.
 *
 */

#ifndef DATATOOLS_COMMAND_UTILS_H
#define DATATOOLS_COMMAND_UTILS_H

// Standard library:
#include <iostream>

// This project:
#ifndef Q_MOC_RUN
#include <datatools/reflection_interface.h>
#endif // Q_MOC_RUN

namespace datatools {

  class command
  {
  public:

    enum error_code_type {
      // Special non-error values:
      CEC_DEPRECATED                   = -3, 
      CEC_STOP                         = -2, 
      CEC_CONTINUE                     = -1, 
      // Sucess:
      CEC_SUCCESS                      =  0, 
      // Failures:
      CEC_FAILURE                      =  1, 
      CEC_PARSING_FAILURE              =  2, 
      CEC_CONTEXT_INVALID              =  3, 
      CEC_NOT_IMPLEMENTED              =  8, 
      CEC_ABORT                        =  9, 
      CEC_SCOPE_INVALID                = 10, 
      CEC_COMMAND_INVALID              = 20, 
      CEC_COMMAND_NO_PRIVILEDGE        = 21, 
      CEC_COMMAND_INVALID_CONTEXT      = 22, 
      CEC_COMMAND_INVALID_SYNTAX       = 23, 
      CEC_COMMAND_INVALID_NUMBER_OF_ARGUMENTS = 24, 
      CEC_PARAMETER_INVALID            = 30, 
      CEC_PARAMETER_INVALID_KEY        = 31, 
      CEC_PARAMETER_NO_PRIVILEDGE      = 32, 
      CEC_PARAMETER_INVALID_CONTEXT    = 33, 
      CEC_PARAMETER_INVALID_TYPE       = 34, 
      CEC_PARAMETER_UNSET_VALUE        = 35, 
      CEC_PARAMETER_INVALID_VALUE      = 36, 
      CEC_PARAMETER_INVALID_UNIT       = 37  
    };

    class returned_info
    {
    public:

      returned_info();

      returned_info(const std::string & output_);

      returned_info(error_code_type code_, const std::string & message_ = "");

      ~returned_info();

      void set_continue();

      void set_stop();

      void set_success(const std::string & output_ = "");

      void set_failure(error_code_type code_, const std::string & message_ = "");

      bool is_stop() const;

      bool is_continue() const;

      bool is_deprecated() const;

      bool is_special() const;

      bool is_success() const;

      bool is_failure() const;

      bool error_is(error_code_type code_) const;

      void set_error_code(error_code_type code_);

      error_code_type get_error_code() const;

      bool has_error_message() const;

      void set_error_message(const std::string & message_);

      const std::string& get_error_message() const;

      bool has_output() const;

      void set_output(const std::string & output_);

      const std::string& get_output() const;

      void reset();

      friend std::ostream & operator<<(std::ostream & out_, const returned_info & ri_);

    private:

      error_code_type _error_code_;    
      std::string     _error_message_; 
      std::string     _output_;        

      DR_CLASS_RTTI()

    };

    DR_CLASS_RTTI()

  };

} // end of namespace datatools

#ifndef Q_MOC_RUN
// Activate reflection layer:
DR_TYPE_INIT(::datatools::command) // mandatory to access the embedded enum
DR_TYPE_INIT(::datatools::command::error_code_type)
DR_TYPE_INIT(::datatools::command::returned_info)
#endif // Q_MOC_RUN

#endif // DATATOOLS_COMMAND_UTILS_H

// Local Variables: --
// mode: c++ --
// c-file-style: "gnu" --
// tab-width: 2 --
// End: --