multi_properties.h

Go to the documentation of this file.

/* multi_properties.h
 * Author(s):     Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date: 2009
 * Last modified: 2019-01-29
 *
 * License:
 *
 * Copyright (C) 2011-2019 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 container of properties objects implemented as a dictionnary
 *
 */

#ifndef DATATOOLS_MULTI_PROPERTIES_H
#define DATATOOLS_MULTI_PROPERTIES_H

// Standard Library:
#include <map>
#include <list>
#include <string>

// Third Party:
// - Boost:
#include <boost/cstdint.hpp>
#include <boost/serialization/access.hpp>

// This project:
#include <datatools/i_serializable.h>
#include <datatools/i_clear.h>
#include <datatools/i_tree_dump.h>
#include <datatools/i_cloneable.h>
#include <datatools/properties.h>
#include <datatools/bit_mask.h>
#include <datatools/logger.h>

namespace datatools {

  class multi_properties
    : public datatools::i_serializable
    , public datatools::i_clear
    , public datatools::i_tree_dumpable
    , public datatools::i_cloneable
  {
  public:

    struct defaults {
      static const std::string & key_label();
      static const std::string & meta_label();
    };

  public:
    class entry
      : public datatools::i_tree_dumpable
    {
    public:

      entry(const std::string & key_ = "",
            const std::string & meta_ = "");

      virtual ~entry();

      const properties& get_properties() const;

      properties& grab_properties();

      const std::string & get_key() const;

      void set_key(const std::string &);

      const std::string & get_meta() const;

      void set_meta(const std::string &);

      bool has_meta() const;

      void print_tree(std::ostream & out_ = std::clog,
                      const boost::property_tree::ptree & options_ = empty_options()) const override;

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

    private:
      std::string _key_;        
      std::string _meta_;       
      properties  _properties_; 

      BOOST_SERIALIZATION_BASIC_DECLARATION()

    }; // multi_properties::entry


  public:

    typedef std::map<std::string, entry> entries_col_type;

    typedef std::list<entry*> entries_ordered_col_type;

  private:

    void _init_ (const std::string & key_label_,
                 const std::string & meta_label_,
                 const std::string & description_,
                 bool debug_);

    void _copy_impl_(const multi_properties &);

  public:

    multi_properties();

    multi_properties(const std::string & key_label_,
                     const std::string & meta_label_);

    multi_properties(const std::string & key_label_,
                     const std::string & meta_label_,
                     const std::string & description_,
                     bool debug_ = false);

    virtual ~multi_properties();

    multi_properties(const multi_properties &);

    multi_properties & operator=(const multi_properties &);

    bool is_debug() const;

    void set_debug(bool = true);

    void set_description(const std::string & description_);

    bool has_description() const;

    const std::string & get_description() const;

    bool has_key_label() const;

    void set_key_label(const std::string & key_label_);

    void clear_key_label();

    const std::string & get_key_label() const;

    bool has_meta_label() const;

    void set_meta_label(const std::string & meta_label_);

    void clear_meta_label();

    const std::string & get_meta_label() const;

    uint32_t size() const;

    bool empty() const;

    void reset();

    virtual void clear();

    const entries_col_type& entries() const;

    const entries_ordered_col_type& ordered_entries() const;

    const entry& get(const std::string & key_) const;

    entry& grab(const std::string & key_);

    bool has_key(const std::string & key_) const;

    bool has_key_with_meta(const std::string & key_, const std::string & meta_) const;

    const std::string & key(int) const;

    const std::string & ordered_key(int) const;

    std::vector<std::string> keys() const;

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

    std::vector<std::string> ordered_keys() const;

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

    bool has_section(const std::string & key_) const;

    const properties& get_section(const std::string & key_) const;

    const properties& get_section_const(const std::string & key_) const;

    properties& grab_section(const std::string & key_);

    void add(const std::string & key_,
             const std::string & meta_,
             const properties & props_);

    void add(const std::string & key_,
             const properties& props_);

    void add(const std::string & key_,
             const std::string & meta_ = "");

    properties& add_section(const std::string & key_,
                            const std::string & meta_ = "");

    void remove(const std::string & key_);

    void write(const std::string & filename_,
               uint32_t options_ = config::HEADER_FOOTER | config::SKIP_PRIVATE_SECTIONS) const;

    void read(const std::string & filename_, uint32_t options_ = 0);

    void dump(std::ostream & out_ = std::clog) const;

    void print_tree(std::ostream & out_ = std::clog,
                    const boost::property_tree::ptree & options_ = empty_options()) const override;
    
    virtual void tree_dump(std::ostream & out_         = std::clog,
                           const std::string & title_  = "",
                           const std::string & indent_ = "",
                           bool inherit_          = false) const;

    class config
    {
    public:
      enum options_flag {
        SKIP_PRIVATE_SECTIONS = bit_mask::bit00, 
        FORBID_VARIANTS       = bit_mask::bit01, 
        LOG_MUTE              = bit_mask::bit02, 
        LOG_DEBUG             = bit_mask::bit03, 
        LOG_TRACE             = bit_mask::bit04, 
        SKIP_PRIVATE_PROPS    = bit_mask::bit05, 
        HEADER_FOOTER         = bit_mask::bit06, 
        DONT_CLEAR            = bit_mask::bit07, 
        REQUESTED_TOPIC       = bit_mask::bit08, 
        RESOLVE_PATH          = bit_mask::bit09, 
        START_WITHOUT_LABELS  = bit_mask::bit10, 
        WITHOUT_DECORATION    = bit_mask::bit11  
      };

      config(uint32_t options_ = 0, const std::string & topic_ = "");

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

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

      void reset();

      void read(const std::string & filename, multi_properties & target_);

      void read(std::istream & in_, multi_properties & target_);

      void write(std::ostream& out_, const multi_properties & source_);

      void write(const std::string & filename_, const multi_properties & source_);

      bool has_topic() const;

      void set_topic(const std::string & topic_);

      const std::string & get_topic() const;

    protected:

      void _init_defaults();

      void _read(std::istream & in_, multi_properties & target_);

      void _write(std::ostream & out_, const multi_properties & target_);

      void _set_current_filename(const std::string & filename_);

    private:

      // Configuration:
      datatools::logger::priority _logging_; 
      bool _skip_private_sections_;   
      bool _skip_private_properties_; 
      bool _forbid_variants_;         
      bool _header_footer_;           
      bool _requested_topic_;         
      std::string _topic_;            
      bool _resolve_path_;            
      bool _start_without_labels_;    
      bool _without_decoration_;      

      // Working parsing data:
      std::string _current_filename_;    
      int         _current_line_number_; 

    }; //----- end of class config

  private:

    void remove_impl(const std::string & key_);

    void add_impl(const std::string & key_,
                  const std::string & meta_ = "");

    properties& add_impl2(const std::string & key_,
                          const std::string & meta_ = "");

    void init_defaults();

  private:

    bool                  _debug_;       
    std::string           _description_; 
    std::string           _key_label_;   
    std::string           _meta_label_;  
    entries_col_type      _entries_;     
    entries_ordered_col_type _ordered_entries_; 

    DATATOOLS_CLONEABLE_DECLARATION(multi_properties)

    
    DATATOOLS_SERIALIZATION_DECLARATION_ADVANCED(multi_properties)
    DATATOOLS_SERIALIZATION_BACKWARD_SERIAL_TAG_SUPPORT()

#ifndef Q_MOC_RUN
    DR_CLASS_RTTI()
#endif // Q_MOC_RUN

  };

} // end of namespace datatools

// Support for serialization tag :
DATATOOLS_SERIALIZATION_EXT_SERIAL_TAG_DECLARATION(::datatools::multi_properties)
// Support for old serialization tag :
DATATOOLS_SERIALIZATION_EXT_BACKWARD_SERIAL_TAG_DECLARATION(::datatools::multi_properties)

#include <boost/serialization/export.hpp>
BOOST_CLASS_EXPORT_KEY2(datatools::multi_properties, "datatools::multi_properties")

#ifndef Q_MOC_RUN
// Activate reflection layer for the 'datatools::multi_properties' class:
DR_CLASS_INIT(::datatools::multi_properties)
#endif // Q_MOC_RUN

// Explicit class version:
#include <boost/serialization/version.hpp>
BOOST_CLASS_VERSION(datatools::multi_properties, 2)

#endif // DATATOOLS_MULTI_PROPERTIES_H

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