base_command_interface.h

Go to the documentation of this file.

//
// Copyright (c) 2015 by François Mauger <mauger@lpccaen.in2p3.fr>
//
// This file is part of datatools.
//
// datatools 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.
//
// datatools 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 datatools. If not, see <http://www.gnu.org/licenses/>.

#ifndef DATATOOLS_UI_BASE_COMMAND_INTERFACE_H
#define DATATOOLS_UI_BASE_COMMAND_INTERFACE_H

// Standard library:
#include <string>
#include <iostream>
#include <vector>
#include <memory>

// Third Party:
// - Boost:
#include <boost/optional.hpp>
// - Bayeux/datatools:
#include <datatools/enriched_base.h>
#include <datatools/version_id.h>
#include <datatools/command_utils.h>
#include <datatools/factory_macros.h>
#include <datatools/exception.h>

namespace datatools {

  class properties;
  class service_manager;

  namespace ui {

    class basic_shell;
    class base_command;

    class base_command_interface
      : public datatools::enriched_base
    {
    public:

      base_command_interface();

      base_command_interface(const std::string & name_,
                             const std::string & description_ = "",
                             const version_id & vid_ = version_id::invalid());

      virtual ~base_command_interface();

      bool has_version() const;

      void set_version(const datatools::version_id & version_);

      const datatools::version_id & get_version() const;

      std::size_t size() const;

      bool has_command(const std::string & command_name_) const;

      base_command & grab_command(const std::string & command_name_);

      const base_command & get_command(const std::string & command_name_) const;

      base_command_interface & add_command(base_command & command_,
                                           const std::string & command_name_ = "");

      base_command_interface & add_command(base_command * command_,
                                           const std::string & command_name_ = "");

      void remove_command(const std::string & command_name_);

      void remove_all_commands();

      void build_command_names(std::vector<std::string> & names_) const;

      void initialize_simple();

      void initialize_standalone(const datatools::properties &);

      virtual bool is_initialized() const = 0;

      virtual void initialize(const datatools::properties & config_,
                              const datatools::service_manager & services_) = 0;

      virtual void reset() = 0;

      bool is_valid() const;

      bool is_disabled() const;

      virtual void tree_dump(std::ostream & out_ = std::clog,
                             const std::string & title_  = "",
                             const std::string & indent_ = "",
                             bool inherit_ = false) const;

      int operator()(const std::vector<std::string> & argv_,
                     datatools::command::returned_info & cri_,
                     uint32_t flags_ = 0);

      datatools::command::returned_info
      operator()(const std::vector<std::string> & argv_,
                 uint32_t flags_ = 0);

      void call(const std::vector<std::string> & argv_,
                datatools::command::returned_info & cri_,
                uint32_t flags_ = 0);

    protected:

      void _base_setup(const std::string & name_,
                       const std::string & description_,
                       const version_id & vid_);

      void _set_version(const datatools::version_id &);

      void _base_initialize(const datatools::properties & config_);

      void _base_reset();

      virtual bool _is_valid() const;

      virtual bool _is_disabled() const;


    private:

      // Configuration:
      boost::optional<datatools::version_id> _version_; 

      // Private data:

      struct pimpl_type;
      pimpl_type & _grab_pimpl();
      const pimpl_type & _get_pimpl() const;
      std::unique_ptr<pimpl_type> _pimpl_; 

      // Factory stuff :
      DATATOOLS_FACTORY_SYSTEM_REGISTER_INTERFACE(base_command_interface)

    };

  } // namespace ui

} // namespace datatools

#endif // DATATOOLS_UI_BASE_COMMAND_INTERFACE_H

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