variant_dependency.h

Go to the documentation of this file.

/* Author(s)     : Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date : 2016-10-26
 * Last modified : 2016-10-26
 *
 * 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:
 *
 *   Description of long range dependencies between variant parameters
 *   and variants.
 *
 */

#ifndef DATATOOLS_CONFIGURATION_VARIANT_DEPENDENCY_H
#define DATATOOLS_CONFIGURATION_VARIANT_DEPENDENCY_H

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

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

namespace datatools {

  namespace configuration {

    class variant_repository;
    class variant_registry;
    class base_dependency_logic;

    class variant_dependency
      : public datatools::i_tree_dumpable
    {
    public:

      typedef std::map<unsigned int, variant_object_info> dependee_dict_type;

      variant_dependency(const variant_repository & repository_);

      variant_dependency(const variant_registry & registry_);

      ~variant_dependency();

      bool has_repository() const;

      const variant_repository & get_repository() const;

      bool has_registry() const;

      const variant_registry & get_registry() const;

      bool has_global_scope() const;

      bool has_local_scope() const;

      bool is_local() const;

      bool is_valid() const;

      void set_depender_by_path(const std::string & depender_name_, bool registry_scope_ = false);

      void set_depender(const variant_object_info & depender_);

      const variant_object_info & get_depender() const;

      std::size_t get_number_of_dependees() const;

      unsigned int add_dependee_by_path(const std::string & dependee_path_,
                                        const unsigned int slot_ = std::numeric_limits<unsigned int>::max());

      unsigned int add_dependee(const variant_object_info & dependee_,
                                const unsigned int slot_ = std::numeric_limits<unsigned int>::max());

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

      bool has_dependee(const unsigned int slot_) const;

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

      const variant_object_info & get_dependee(const unsigned int slot_) const;

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

      base_dependency_logic & create_logic(const std::string & guid_);

      const base_dependency_logic & get_logic() const;

      base_dependency_logic & grab_logic();

      void build_logic_from_formula(const std::string & logic_expression_);

      bool is_locked() const;

      void lock();

      bool operator()() const;

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

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

    protected:

      void _lock();

      void _check();

      void _install_default_logic();

    private:

      datatools::logger::priority _logging_ = datatools::logger::PRIO_FATAL; 
      bool _locked_ = false;
      const variant_repository * _repository_ = nullptr; 
      const variant_registry * _registry_ = nullptr;     
      variant_object_info _depender_;                    
      dependee_dict_type _dependees_;                    
      std::shared_ptr<base_dependency_logic> _logic_;    

    };

  }  // end of namespace configuration

}  // end of namespace datatools

#endif // DATATOOLS_CONFIGURATION_VARIANT_DEPENDENCY_H

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