variant_dependency_model.h

Go to the documentation of this file.

/* Author(s)     : Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date : 2016-10-26
 * Last modified : 2016-11-01
 *
 * Copyright (C) 2016 Francois Mauger <mauger@lpccaen.in2p3.fr>
 *
 * This program 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.
 *
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 *
 * Description:
 *
 *   A model of variant dependencies between variant parameters
 *   and variants.
 *
 */

#ifndef DATATOOLS_CONFIGURATION_VARIANT_DEPENDENCY_MODEL_H
#define DATATOOLS_CONFIGURATION_VARIANT_DEPENDENCY_MODEL_H

// Standard library:
#include <string>
#include <set>
#include <map>
#include <memory>

// This project (Bayeux/datatools):
#include <datatools/i_tree_dump.h>
#include <datatools/properties.h>
#include <datatools/logger.h>
#include <datatools/configuration/variant_dependency.h>

namespace datatools {

  namespace configuration {

    class variant_repository;
    class variant_registry;

    struct variant_dependency_model
      : public datatools::i_tree_dumpable
    {
    public:

      struct dependee_record {
        std::string            dependee_path;
      };
      typedef std::map<unsigned int, dependee_record> dependee_record_dict_type;

      struct dependency_record {
        std::string            depender_path;
        std::set<unsigned int> input_slots;
        std::string            logic_expression;
        datatools::logger::priority logging = datatools::logger::PRIO_FATAL;
      };
      typedef std::map<std::string, dependency_record> dependency_record_dict_type;

      typedef std::shared_ptr<variant_dependency>          dependency_ptr_type;
      typedef std::map<std::string, dependency_ptr_type>   dependency_dict_type;
      typedef std::map<std::string, std::set<std::string>> dependers_table_type;

      variant_dependency_model(const variant_repository & repository_);

      variant_dependency_model(const variant_registry & registry_);

      bool has_repository() const;

      const variant_repository & get_repository() const;

      bool has_registry() const;

      const variant_registry & get_registry() const;

      datatools::logger::priority get_logging() const;

      void set_logging(const datatools::logger::priority);

      bool is_local() const;

      bool has_dependee_record_by_path(const std::string & dependee_path_) const;

      bool has_dependee_record(unsigned int slot_) const;

      unsigned int add_dependee_record(unsigned int slot_, const std::string & dependee_path_);

      const std::string & get_dependee_record_path(unsigned int slot_) const;

      const dependee_record_dict_type & get_dependee_records() const;

      void build_list_of_dependee_slots(std::set<unsigned int> & dep_slots_) const;

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

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

      void build_list_of_dependency_records(std::set<std::string> & dep_names_) const;

      void add_dependency_record(const std::string & name_,
                                 const std::string & depender_path_,
                                 const std::set<unsigned int> & input_slots_,
                                 const std::string & logic_expression_ = "",
                                 const datatools::logger::priority logging_ = datatools::logger::PRIO_FATAL);

      const dependency_record_dict_type & get_dependency_records() const;

      bool is_valid() const;

      bool is_initialized() const;

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

      void reset();

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

      bool has_dependency(const std::string & path_) const;

      const variant_dependency & get_dependency(const std::string & path_) const;

      const dependency_ptr_type & get_dependency_ptr(const std::string & path_) const;

      const dependency_dict_type & get_dependencies() const;

      const dependers_table_type & get_dependers_per_dependee() const;

      enum rst_flags {
        PRINT_RST_NO_TITLE = datatools::bit_mask::bit00,
        PRINT_RST_NO_SCOPE = datatools::bit_mask::bit01
      };

      void print_rst(std::ostream & out_,
                     const uint32_t flags_ = 0,
                     const std::string & indent_ = "") const;

    protected:

      void _at_init();

      void _at_init_build_table_of_dependers_();

      void _at_reset();

    private:

      // Management:
      datatools::logger::priority _logging_ = datatools::logger::PRIO_FATAL; 
      bool _initialized_ = false; 
      const variant_repository * _repository_ = nullptr; 
      const variant_registry   * _registry_ = nullptr; 

      // Configuration:
      dependee_record_dict_type   _dependee_records_;   
      dependency_record_dict_type _dependency_records_; 

      // Working:
      dependency_dict_type _dependencies_; 
      dependers_table_type _dependers_;    

    };

  }  // end of namespace configuration

}  // end of namespace datatools

#endif // DATATOOLS_CONFIGURATION_VARIANT_DEPENDENCY_MODEL_H

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