io.h

Go to the documentation of this file.

/* Author(s)     : Francois Mauger <mauger@lpccaen.in2p3.fr>
 * Creation date : 2014-09-29
 * Last modified : 2017-01-10
 *
 * Copyright (C) 2014-2017 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:
 *
 *   I/O utilities for variant registries and repositories.
 *
 */

#ifndef DATATOOLS_CONFIGURATION_IO_H
#define DATATOOLS_CONFIGURATION_IO_H

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

// This project (Bayeux/datatools):
#include <datatools/bit_mask.h>
#include <datatools/logger.h>
#include <datatools/bit_mask.h>
#include <datatools/command_utils.h>
#include <datatools/version_id.h>

namespace datatools {

  namespace configuration {

    // Forward declarations:
    class variant_record;
    class variant_registry;
    class variant_repository;

    class ascii_io
    {
    public:

      enum store_flags {
        IO_DESCRIPTION = datatools::bit_mask::bit00, 
        IO_TITLE       = datatools::bit_mask::bit01, 
        IO_TRACE       = datatools::bit_mask::bit02, 
        IO_NO_HEADER   = datatools::bit_mask::bit03, 
        IO_DONT_IGNORE_UNKNOWN_REGISTRY = datatools::bit_mask::bit04, 
        IO_DEFAULT     = 0                           
      };

      static const std::string & unset_label();

      static const std::string & error_label();

      static const std::string & format_label();

      static version_id current_format_version_id();

      explicit ascii_io(uint32_t flags_ = IO_DEFAULT);

      void store_record(std::ostream & out_, const variant_record & vrec_) const;

      int load_record(std::istream & in_, variant_record & vrec_) const;

      void store_registry(std::ostream & out_, const variant_registry & vreg_) const;

      int load_registry(std::istream & in_, variant_registry & vreg_) const;

      void store_repository(std::ostream & out_, const variant_repository & vrep_) const;

      int load_repository(std::istream & in_, variant_repository & vrep_) const;

      logger::priority get_logging() const;

      void set_logging(logger::priority);

      void print(std::ostream & out_, const std::string & title_ = "") const;

    private:

      bool _no_header_;           
      bool _with_description_;    
      bool _with_title_;          
      bool _dont_ignore_unknown_registries_; 
      logger::priority _logging_; 
      datatools::version_id _format_version_; 

    };

    class variant_reporting
    {
    public:
      typedef std::map<std::string, std::size_t> statistics_type;

      variant_reporting();

      ~variant_reporting();

      bool has_repository() const;

      void set_repository(const variant_repository & repository_);

      void reset_repository();

      const variant_repository & get_repository() const;

      void reset();

      void print_report(std::ostream & out_, uint32_t flags_ = 0) const;

      void add(const std::string & path_, std::size_t increment_ = 1);

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

      logger::priority get_logging() const;

      void set_logging(logger::priority);

    private:

      void _init_repository_();

    private:

      logger::priority _logging_; 
      const variant_repository * _repository_ = nullptr; 
      statistics_type _parameter_stats_; 

    };

    class variant_preprocessor
    {
    public:

      enum flag_type {
        FLAG_TRACE         = datatools::bit_mask::bit00, 
        FLAG_REMOVE_QUOTES = datatools::bit_mask::bit01  
      };

      bool is_remove_quotes() const;

      void set_remove_quotes(bool);

      variant_preprocessor(unsigned int flags_ = 0);

      bool has_repository() const;

      void set_repository(const variant_repository & repository_);

      void reset_repository();

      bool repository_is_active() const;

      const variant_repository & get_repository() const;

      command::returned_info preprocess(const std::string & source_,
                                        std::string & target_) const;

      std::string preprocess_string(const std::string & source_) const;

      bool preprocess_boolean(const std::string & source_) const;

      int preprocess_integer(const std::string & source_) const;

      double preprocess_real(const std::string & source_) const;


      void preprocess_args_options(int argc_, char ** argv_,
                                   std::vector<std::string> & preprocessed_args_);


      void preprocess_args_options(const std::vector<std::string> & args_,
                                   std::vector<std::string> & preprocessed_args_);

      command::returned_info preprocess_parameter(const std::string & parameter_token_,
                                                  std::string & parameter_effective_token_) const;

      command::returned_info resolve_variant(const std::string & variant_desc_,
                                             bool & variant_active_,
                                             bool & variant_reverse_) const;

      logger::priority get_logging() const;

      void set_logging(logger::priority);

    private:

      void _set_default_kernel_repository();

    private:

      logger::priority _logging_; 
      bool _remove_quotes_ = false; 
      const variant_repository * _repository_ = nullptr; 

    };

  }  // end of namespace configuration

}  // end of namespace datatools

#endif // DATATOOLS_CONFIGURATION_IO_H

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