builder.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_INTROSPECTION_BUILDER_H
#define DATATOOLS_INTROSPECTION_BUILDER_H

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

// Third Party:
// - Boost:
#include <boost/lexical_cast.hpp>
#include <boost/program_options/options_description.hpp>
// - Camp:
#include <camp/function.hpp>

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

namespace datatools {

  namespace introspection {

    // Function flags
    std::string function_builder_flag();
    std::string function_constness_flag();
    std::string function_description_tag();

    // General tags:
    std::string name_tag();
    std::string description_tag();
    std::string type_tag();
    std::string layout_tag();
    std::string vector_fixed_size_tag();
    std::string implicit_unit_tag();
    std::string explicit_unit_dimension_tag();
    std::string preferred_unit_tag();
    std::string default_value_tag();

    // Composed tag (format : "PREFIX.WHAT");
    std::string composed_tag(const std::string & prefix_, const std::string & what_);

    // Tag builders for function arguments:
    std::string function_arg_prefix(std::size_t iarg_);
    std::string function_arg_tag(std::size_t iarg_, const std::string & what_);

    // Tag builders for function returned parameter:
    std::string function_returned_prefix();
    std::string function_returned_tag(const std::string & what_);

    /*

     .DR_CLASS_TAG("arg[0].name", "x")
     .DR_CLASS_TAG("arg[0].description", "The length")
     .DR_CLASS_TAG("arg[0].type", "double")
     .DR_CLASS_TAG("arg[0].layout", "scalar")
     .DR_CLASS_TAG("arg[0].vector_fixed_size", 3)
     .DR_CLASS_TAG("arg[0].implicit_unit", "mm")
     .DR_CLASS_TAG("arg[0].explicit_unit_dimension", "length")
     .DR_CLASS_TAG("arg[0].preferred_unit", "cm")

     */

    class method_builder
    {
    public:

      method_builder();

      method_builder(const std::string & funcname_);

      method_builder(const std::string & classname_, const std::string & funcname_);

      void reset();

      void set_classname(const std::string & classname_);

      void set_funcname(const std::string & funcname_);

      void set_function(const camp::Function & func_);

      void build_parameter_data_description(camp::Type param_type_,
                                            std::size_t param_index_,
                                            data_description & param_dd_);

      void build_argument(std::size_t arg_index_, argument & arg_);

      void build_returned(argument & returned_);

      void build(method & method_);

      static void dump_func(const camp::Function & func_, std::ostream & out_ = std::clog);

    public:

      datatools::logger::priority logging = datatools::logger::PRIO_FATAL;

    private:
      std::string _classname_; 
      std::string _funcname_;  

      // Work:
      std::string _func_what_;
      std::string _func_full_name_;
      const camp::Function * _func_ = nullptr;

    };

    class method_args_builder
    {
    public:

      method_args_builder(method & method_, const boost::program_options::variables_map & vmap_);

      void build(camp::Args & args_);

    public:

      datatools::logger::priority logging = datatools::logger::PRIO_FATAL;

    private:

      method * _method_ = nullptr;
      const boost::program_options::variables_map * _vmap_ = nullptr;
    };

  } // namespace introspection

} // namespace datatools

#endif // DATATOOLS_INTROSPECTION_BUILDER_H

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