target_command_interface.h

Go to the documentation of this file.

//
// Copyright (c) 2016 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_TARGET_COMMAND_INTERFACE_H
#define DATATOOLS_UI_TARGET_COMMAND_INTERFACE_H

// This project:
#include <datatools/ui/base_command_interface.h>

namespace datatools {

  namespace ui {

    template <typename Type>
    class target_command_interface
      : public base_command_interface
    {
    public:

      target_command_interface()
        : base_command_interface(),
          _target_(nullptr)
      {
        return;
      }

      target_command_interface(const std::string & name_,
                               const std::string & description_ = "",
                               const version_id & vid_ = version_id::invalid())
        : base_command_interface(name_, description_, vid_),
          _target_(nullptr)
      {
        return;
      }

      target_command_interface(Type & target_,
                               const std::string & name_,
                               const std::string & description_ = "",
                               const version_id & vid_ = version_id::invalid())
        : base_command_interface(name_, description_, vid_),
          _target_(nullptr)
      {
        _set_target(target_);
        return;
      }

      virtual ~target_command_interface()
      {
        return;
      }

      bool has_target() const
      {
        return _target_ != nullptr;
      }

      void set_target(Type & target_)
      {
        DT_THROW_IF(is_initialized(), std::logic_error,
                    "Target command interface is already initialized!");
        _set_target(target_);
        return;
      }

      const Type & get_target() const
      {
        return *_target_;
      }

      Type & grab_target()
      {
        return _grab_target();
      }

      virtual void tree_dump(std::ostream & out_ = std::clog,
                             const std::string & title_  = "",
                             const std::string & indent_ = "",
                             bool inherit_ = false) const
      {
        this->base_command_interface::tree_dump(out_, title_, indent_, true);

        out_ << indent_ << i_tree_dumpable::inherit_tag(inherit_)
             << "Target : [@" << _target_ << "]" << std::endl;

        return;
      }

    protected:

      Type & _grab_target()
      {
        return *_target_;
      }

      void _set_target(Type & target_)
      {
        _target_ = &target_;
        return;
      }

    private:

      Type * _target_ = nullptr; 

    };

    template <typename Type>
    class const_target_command_interface
      : public base_command_interface
    {
    public:

      const_target_command_interface()
        : base_command_interface(),
          _target_(nullptr)
      {
        return;
      }

      const_target_command_interface(const std::string & name_,
                                     const std::string & description_ = "",
                                     const version_id & vid_ = version_id::invalid())
        : base_command_interface(name_, description_, vid_),
          _target_(nullptr)
      {
        return;
      }

      const_target_command_interface(const Type & target_,
                                     const std::string & name_,
                                     const std::string & description_ = "",
                                     const version_id & vid_ = version_id::invalid())
        : base_command_interface(name_, description_, vid_),
          _target_(nullptr)
      {
        _set_target(target_);
        return;
      }

      virtual ~const_target_command_interface()
      {
        return;
      }

      bool has_target() const
      {
        return _target_ != nullptr;
      }

      void set_target(const Type & target_)
      {
        DT_THROW_IF(is_initialized(), std::logic_error,
                    "Target command interface is already initialized!");
        _set_target(target_);
        return;
      }

      const Type & get_target() const
      {
        return *_target_;
      }

      virtual void tree_dump(std::ostream & out_ = std::clog,
                             const std::string & title_  = "",
                             const std::string & indent_ = "",
                             bool inherit_ = false) const
      {
        this->base_command_interface::tree_dump(out_, title_, indent_, true);

        out_ << indent_ << i_tree_dumpable::inherit_tag(inherit_)
             << "Target : [@" << _target_ << "]" << std::endl;

        return;
      }

    protected:

      const Type & _get_target()
      {
        return *_target_;
      }

      void _set_target(const Type & target_)
      {
        _target_ = &target_;
        return;
      }

    private:

      const Type * _target_ = nullptr; 

    };

  } // namespace ui

} // namespace datatools

#endif // DATATOOLS_UI_TARGET_COMMAND_INTERFACE_H

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