shell_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_SHELL_COMMAND_INTERFACE_H
#define DATATOOLS_UI_SHELL_COMMAND_INTERFACE_H

// This project:
#include <datatools/command_utils.h>
#include <datatools/service_manager.h>
#include <datatools/properties.h>
#include <datatools/version_id.h>
#include <datatools/ui/base_command.h>
#include <datatools/ui/target_command_interface.h>

namespace datatools {

  namespace ui {

    class basic_shell;

    class shell_command_interface
      : public target_command_interface<basic_shell>
    {
    public:

      shell_command_interface();

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

      shell_command_interface(basic_shell & sh_,
                              const std::string & name_,
                              const std::string & description_ = "",
                              const datatools::version_id & vid_ = datatools::version_id::invalid());

      virtual ~shell_command_interface();

      virtual bool is_initialized() const;

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

      virtual void reset();

      bool is_inhibit_load() const;

      void set_inhibit_load(bool);

      bool is_inhibit_cd() const;

      void set_inhibit_cd(bool);

      bool has_shell() const;

      basic_shell & grab_shell();

      const basic_shell & get_shell() const;

    protected:

      virtual void _add_shell_commands();

      virtual void _remove_shell_commands();

    private:

      // Management:
      bool _initialized_ = false; 

      // Configuration:
      bool _inhibit_cd_ = false;   
      bool _inhibit_load_ = false; 

      // Factory registration:
      DATATOOLS_FACTORY_SYSTEM_AUTO_REGISTRATION_INTERFACE(base_command_interface,
                                                           shell_command_interface)

    };

  } // namespace ui

} // namespace datatools

#endif // DATATOOLS_UI_SHELL_COMMAND_INTERFACE_H

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