variant_dependency_logic.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:
 *
 *   Variant dependency logic.
 *
 */

#ifndef DATATOOLS_CONFIGURATION_VARIANT_DEPENDENCY_LOGIC_H
#define DATATOOLS_CONFIGURATION_VARIANT_DEPENDENCY_LOGIC_H

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

// Third party:
#include <boost/function.hpp>
#include <boost/functional/factory.hpp>

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

namespace datatools {

  namespace configuration {

    class variant_dependency;
    class variant_object_info;
    class variant_repository;
    class variant_registry;

    class base_dependency_logic
      : public datatools::i_tree_dumpable
    {
    public:

      typedef std::map<unsigned int, dependency_logic_ptr_type> input_dict_type;

      base_dependency_logic(variant_dependency &);

      virtual ~base_dependency_logic();

      virtual const char * guid() const = 0;

      virtual std::size_t min_ports() const;

      virtual std::size_t max_ports() const;

      virtual bool is_valid() const;

      virtual bool operator()() const = 0;

      bool check_active_variant(const variant_object_info &) const;

      void connect(const unsigned int input_port_, dependency_logic_ptr_type logic_);

      void disconnect(const unsigned int input_port_);

      base_dependency_logic & connect(const unsigned int input_port_, const std::string & guid_);

      void connect_dependee(const unsigned int input_port_, const unsigned int dependee_slot_);

      const variant_repository & get_repository() const;

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

      const variant_dependency & get_owner_dependency() const;

    protected:

      variant_dependency & _grab_owner_dependency();

    private:

      variant_dependency * _owner_dependency_ = nullptr; 

    protected:

      const variant_repository * _repository = nullptr; 
      input_dict_type            _inputs; 

    };

    typedef boost::function<base_dependency_logic*(variant_dependency &)>
    dependency_logic_factory_type;

    typedef std::map<std::string, dependency_logic_factory_type>
    dependency_logic_factory_dict_type;

    dependency_logic_factory_dict_type & dependency_logic_factories();

    class slot_logic : public base_dependency_logic
    {
    public:

      slot_logic(variant_dependency &);

      virtual ~slot_logic();

      virtual const char * guid() const;

      virtual std::size_t min_ports() const;

      virtual std::size_t max_ports() const;

      virtual bool is_valid() const;

      virtual bool operator()() const;

      void set_dependee_slot(const unsigned int dependee_slot_);

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

      unsigned int _dependee_slot_
      = std::numeric_limits<unsigned int>::max(); 

    };

    class not_logic : public base_dependency_logic
    {
    public:

      not_logic(variant_dependency &);

      virtual ~not_logic();

      virtual const char * guid() const;

      virtual std::size_t max_ports() const;

      virtual bool operator()() const;

    };

    class and_logic : public base_dependency_logic
    {
    public:

      and_logic(variant_dependency &);

      virtual ~and_logic();

      virtual const char * guid() const;

      virtual bool operator()() const;

    };

    class or_logic : public base_dependency_logic
    {
    public:

      or_logic(variant_dependency &);

      virtual ~or_logic();

      virtual const char * guid() const;

      virtual bool operator()() const;

    };

    class xor_logic : public base_dependency_logic
    {
    public:

      xor_logic(variant_dependency &);

      virtual ~xor_logic();

      virtual const char * guid() const;

      virtual bool operator()() const;

    };

  }  // end of namespace configuration

}  // end of namespace datatools

#endif // DATATOOLS_CONFIGURATION_VARIANT_DEPENDENCY_LOGIC_H

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