method.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_INTROSPECTION_METHOD_H
#define DATATOOLS_INTROSPECTION_METHOD_H

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

// Third party:
// - Boost:
#include <boost/optional.hpp>
#include <boost/scoped_ptr.hpp>
#include <boost/program_options.hpp>
// - Bayeux/datatools:
#include <datatools/enriched_base.h>

// This project:
#include <datatools/introspection/argument.h>

namespace datatools {

  namespace introspection {

    class method
      : public datatools::enriched_base
    {
    public:

      method();

      virtual ~method();

      bool has_constness() const;

      bool is_constness() const;

      void set_constness(bool);

      void reset_constness();

      bool has_type_id() const;

      void set_type_id(const std::string &);

      void reset_type_id();

      const std::string & get_type_id() const;

      bool has_arguments() const;

      bool has_input_arguments() const;

      bool has_output_arguments() const;

      bool has_unique_returned() const;

      const argument & get_unique_returned() const;

      void add_argument(const argument & arg_, const std::string & arg_name_ = "");

      bool has_argument_by_rank(std::size_t rank_) const;

      bool has_argument_by_name(const std::string & name_) const;

      const argument & get_argument_by_name(const std::string & name_) const;

      const argument & get_argument_by_rank(std::size_t rank_) const;

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

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

      bool is_valid() const;

      void initialize();

      void initialize(const datatools::properties &);

      void reset();

      enum method_xc_flags {
        METHOD_XC_CONSTNESS  = (datatools::enriched_base::EXPORT_CONFIG_LAST << 1),
        METHOD_XC_TYPE_ID    = (datatools::enriched_base::EXPORT_CONFIG_LAST << 2),
        METHOD_XC_ARGUMENTS  = (datatools::enriched_base::EXPORT_CONFIG_LAST << 3),
        METHOD_XC_DEFAULT    = (datatools::enriched_base::EXPORT_CONFIG_DEFAULT
                                | datatools::enriched_base::EXPORT_CONFIG_NAME
                                | METHOD_XC_CONSTNESS
                                | METHOD_XC_TYPE_ID
                                | METHOD_XC_ARGUMENTS),
        METHOD_XC_LAST       = (METHOD_XC_ARGUMENTS)
      };

      void export_to_config(datatools::properties & config_,
                            uint32_t flags_ = METHOD_XC_DEFAULT,
                            const std::string & prefix_ = "") const;

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

      void make_scalar_setter(const std::string & arg_name_,
                              data_type           arg_type_,
                              const std::string & arg_info_ = "",
                              const std::string & arg_info2_ = "",
                              const std::string & method_desc_ = "",
                              const std::string & method_name_ = "set");

      void make_scalar_getter(const std::string & arg_name_,
                              data_type           arg_type_,
                              const std::string & arg_info_ = "",
                              const std::string & arg_info2_ = "",
                              const std::string & method_desc_ = "",
                              const std::string & method_name_ = "get");

    private:

      boost::optional<bool>        _constness_; 
      boost::optional<std::string> _type_id_;   

      // Working data:
      // PIMPL-ized data structure:
      struct pimpl_type;
      boost::scoped_ptr<pimpl_type> _priv_; 

    };

  } // namespace introspection

} // namespace datatools

#endif // DATATOOLS_INTROSPECTION_METHOD_H

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