Gambit::IniParser::Parser Class Reference

Inifile parser base class. More...

#include <yaml_parser_base.hpp>

Inheritance diagram for Gambit::IniParser::Parser:

Public Member Functions
virtual void	readFile (str filename)
	Read in the YAML file. More...
YAML::Node	getParametersNode () const
	Getters for key/value section. More...
YAML::Node	getPriorsNode () const
YAML::Node	getPrinterNode () const
YAML::Node	getScannerNode () const
YAML::Node	getLoggerNode () const
YAML::Node	getKeyValuePairNode () const
template<typename... args>
bool	hasKey (args... keys) const
template<typename TYPE , typename... args>
TYPE	getValue (args... keys) const
template<typename TYPE , typename... args>
TYPE	getValueOrDef (TYPE def, const args &... keys) const
template<typename TYPE >
TYPE	getModelParameterEntry (str model, str param, str key) const
	Getters for model/parameter section. More...
bool	hasModelParameterEntry (str model, str param, str key) const
	Getters for model/parameter section. More...
const std::set< str >	getModelNames () const
	Return list of model names (without "adhoc" model!) More...
const std::vector< str >	getModelParameters (str model) const
const Options	getOptions (str key) const
	Getter for options. More...

Protected Member Functions
YAML::Node	filename_to_node (str)
	Read in the actual YAML file. More...
void	basicParse (YAML::Node, str)
	Do the basic parsing of the YAML file. More...

Private Attributes
YAML::Node	keyValuePairNode
YAML::Node	parametersNode
YAML::Node	priorsNode
YAML::Node	printerNode
YAML::Node	scannerNode
YAML::Node	logNode

Detailed Description

Inifile parser base class.

Definition at line 48 of file yaml_parser_base.hpp.

Member Function Documentation

basicParse()

void Gambit::IniParser::Parser::basicParse ( YAML::Node  root, str  filename  )

protected

Do the basic parsing of the YAML file.

Definition at line 154 of file yaml_parser_base.cpp.

References Gambit::Utils::ensure_path_exists(), hasKey(), Gambit::IniParser::inifile_error(), Gambit::Logging::LogMaster::initialise(), keyValuePairNode, LOCAL_INFO, Gambit::logger(), logNode, parametersNode, printerNode, priorsNode, Gambit::IniParser::recursiveImport(), scannerNode, and Gambit::Logging::LogMaster::set_log_debug_messages().

Referenced by getModelParameterEntry(), readFile(), and Gambit::IniParser::IniFile::readFile().

    {
      recursiveImport(root,filename);
      parametersNode = root["Parameters"];
      priorsNode = root["Priors"];
      printerNode = root["Printer"];
      scannerNode = root["Scanner"];
      logNode = root["Logger"];
      keyValuePairNode = root["KeyValues"];

      // Set default output path
      std::string defpath;
      if(hasKey("default_output_path"))
      {
         defpath = getValue<std::string>("default_output_path");
      }
      else
      {
         // Assign a default default (;)) path based on the yaml file name
         // Ridiculously we have to parse manually in C++ since no
         // standard library tools for doing this exist...
         // Assumes that file extension has only one dot, or that
         // there is no file extension. Should work anyway if more
         // dots, will just get a directory name with a dot in it.
         size_t fname_start = filename.find_last_of("/\\");
         size_t fname_end   = filename.find_last_of(".");
         str fname = filename.substr(fname_start+1,fname_end);
         defpath = "runs/" + fname + "/";
      }
      scannerNode["default_output_path"] = Utils::ensure_path_exists(defpath+"/scanner_plugins/");
      logNode    ["default_output_path"] = Utils::ensure_path_exists(defpath+"/logs/");
      printerNode["options"]["default_output_path"] = Utils::ensure_path_exists(defpath+"/samples/");

      // Postprocessor is currently incompatible with 'print_timing_data', so need to pass this option on for checking
      scannerNode["print_timing_data"] = getValueOrDef<bool>(false,"print_timing_data");

      // Pass on minimum recognised lnlike and offset to Scanner
      scannerNode["model_invalid_for_lnlike_below"] = getValueOrDef<double>(0.9*std::numeric_limits<double>::lowest(), "likelihood", "model_invalid_for_lnlike_below");
      if (hasKey("likelihood", "lnlike_offset"))
        scannerNode["lnlike_offset"] = getValue<double>("likelihood", "lnlike_offset");

      // Set fatality of exceptions
      if (hasKey("exceptions"))
      {
        // Iterate over the map of all recognised exception objects
        std::map<const char*,exception*>::const_iterator iter;
        for (iter = exception::all_exceptions().begin(); iter != exception::all_exceptions().end(); ++iter)
        {
          // Check if the exception has an entry in the YAML file
          if (hasKey("exceptions",iter->first))
          {
            // Retrieve the entry and set the exception's 'fatal' flag accordingly.
            str value = getValue<str>("exceptions",iter->first);
            if (value == "fatal")
            {
              iter->second->set_fatal(true);
            }
            else if (value == "non-fatal")
            {
              iter->second->set_fatal(false);
            }
            else
            {
              str error_msg = "Unrecognised entry \"" + value + "\" for exceptions key \"" + iter->first + "\" in input file.";
              inifile_error().raise(LOCAL_INFO,error_msg);
            }
          }
        }
      }

      // Parse the logging setup node, and initialise the LogMaster object
      std::string prefix;
      if(logNode["prefix"])
      {
         prefix = logNode["prefix"].as<std::string>();
      }
      else
      {
         prefix = logNode["default_output_path"].as<std::string>()+"/";
      }

      // map storing info used to set up logger objects
      std::map<std::set<std::string>,std::string> loggerinfo;
      if(logNode["redirection"])
      {
         YAML::Node redir = logNode["redirection"];
         for(YAML::const_iterator it=redir.begin(); it!=redir.end(); ++it)
         {
             std::set<std::string> tags;
             std::string filename;
             // Iterate through tags and add them to the set
             YAML::Node yamltags = it->first;
             for(YAML::const_iterator it2=yamltags.begin();it2!=yamltags.end();++it2)
             {
               tags.insert( it2->as<std::string>() );
             }
             filename = (it->second).as<std::string>();

             // Add entry to the loggerinfo map
             if((filename=="stdout") or (filename=="stderr"))
             {
               // Special cases to trigger redirection to standard output streams
               loggerinfo[tags] = filename;
             }
             else
             {
               // The logger won't be able to create the log files if the prefix
               // directory doesn't exist, so let us now make sure that it does
               loggerinfo[tags] = Utils::ensure_path_exists(prefix + filename);
             }
         }
      }
      else
      {
         // Use default log file only
         std::set<std::string> tags;
         std::string filename;
         tags.insert("Default");
         filename = "default.log";
         loggerinfo[tags] = Utils::ensure_path_exists(prefix + filename);
     }
      // Initialise global LogMaster object
      bool master_debug = (keyValuePairNode["debug"]) ? keyValuePairNode["debug"].as<bool>() : false;
      bool logger_debug = (logNode["debug"])          ? logNode["debug"].as<bool>()          : false;
      logger().set_log_debug_messages(master_debug or logger_debug);
      logger().initialise(loggerinfo);

      // Parse the Parameters node and expand out some shorthand syntax
      // e.g.
      //  model1
      //    param1: 5.678
      // expands to
      //  model1
      //    param1:
      //      fixed_value: 5.678
      // Parameter must have no entries besides the value for this syntax to be valid
    }

Here is the call graph for this function:

Here is the caller graph for this function:

filename_to_node()

YAML::Node Gambit::IniParser::Parser::filename_to_node ( str  filename )

protected

Read in the actual YAML file.

Definition at line 135 of file yaml_parser_base.cpp.

References Gambit::IniParser::inifile_error(), and LOCAL_INFO.

Referenced by getModelParameterEntry(), readFile(), and Gambit::IniParser::IniFile::readFile().

    {
      YAML::Node root;
      // Read inifile file
      try
      {
        root = YAML::LoadFile(filename);
      }
      catch (YAML::Exception &e)
      {
        std::ostringstream msg;
        msg << "Error reading Inifile \""<<filename<<"\"! ";
        msg << "Please check that file exist!" << endl;
        msg << "(yaml-cpp error: "<<e.what()<<" )";
        inifile_error().raise(LOCAL_INFO,msg.str());
      }
      return root;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getKeyValuePairNode()

YAML::Node Gambit::IniParser::Parser::getKeyValuePairNode

(

)

const

Definition at line 299 of file yaml_parser_base.cpp.

References keyValuePairNode.

Referenced by Gambit::IniParser::IniFile::readFile().

{return keyValuePairNode;}

Here is the caller graph for this function:

getLoggerNode()

YAML::Node Gambit::IniParser::Parser::getLoggerNode

(

)

const

Definition at line 298 of file yaml_parser_base.cpp.

References logNode.

Referenced by Gambit::IniParser::IniFile::readFile().

{return logNode;}

Here is the caller graph for this function:

getModelNames()

const std::set< str > Gambit::IniParser::Parser::getModelNames

(

)

const

Return list of model names (without "adhoc" model!)

Definition at line 310 of file yaml_parser_base.cpp.

References parametersNode.

Referenced by getModelParameterEntry(), Gambit::Likelihood_Container_Factory::Likelihood_Container_Factory(), and main().

    {
      std::set<str> result;
      for (YAML::const_iterator it = parametersNode.begin(); it!=parametersNode.end(); ++it)
      {
        if (it->first.as<std::string>() != "adhoc")
          result.insert( it->first.as<std::string>() );
      }
      return result;
    }

Here is the caller graph for this function:

getModelParameterEntry()

template<typename TYPE >

TYPE Gambit::IniParser::Parser::getModelParameterEntry ( str  model, str  param, str  key  ) const

inline

Getters for model/parameter section.

Definition at line 91 of file yaml_parser_base.hpp.

References basicParse(), filename_to_node(), getModelNames(), getModelParameters(), getOptions(), hasModelParameterEntry(), Gambit::IniParser::inifile_error(), LOCAL_INFO, and parametersNode.

        {
          if (not parametersNode[model][param][key]) inifile_error().raise(LOCAL_INFO,model + "." + param + "." + key + "not found in inifile.");
          return parametersNode[model][param][key].as<TYPE>();
        }

Here is the call graph for this function:

getModelParameters()

const std::vector< std::string > Gambit::IniParser::Parser::getModelParameters

(

str

model

)

const

Definition at line 321 of file yaml_parser_base.cpp.

References parametersNode.

Referenced by getModelParameterEntry(), and Gambit::Likelihood_Container_Factory::Likelihood_Container_Factory().

    {
      std::vector<std::string> result;
      if (parametersNode[model])
      {
        for (YAML::const_iterator it = parametersNode[model].begin(); it!=parametersNode[model].end(); ++it)
        {
          result.push_back( it->first.as<std::string>() );
        }
      }
      return result;
    }

Here is the caller graph for this function:

getOptions()

const Options Gambit::IniParser::Parser::getOptions

(

str

key

)

const

Getter for options.

Definition at line 335 of file yaml_parser_base.cpp.

References hasKey(), and keyValuePairNode.

Referenced by getModelParameterEntry().

    {
      if (hasKey(key, "options"))
      {
        return Options(keyValuePairNode[key]["options"]);
      }
      else
      {
        return Options(keyValuePairNode[key]);
      }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getParametersNode()

YAML::Node Gambit::IniParser::Parser::getParametersNode

(

)

const

Getters for key/value section.

Definition at line 294 of file yaml_parser_base.cpp.

References parametersNode.

Referenced by main().

{return parametersNode;}

Here is the caller graph for this function:

getPrinterNode()

YAML::Node Gambit::IniParser::Parser::getPrinterNode

(

)

const

Definition at line 296 of file yaml_parser_base.cpp.

References printerNode.

Referenced by main(), and Gambit::IniParser::IniFile::readFile().

{return printerNode;}

Here is the caller graph for this function:

getPriorsNode()

YAML::Node Gambit::IniParser::Parser::getPriorsNode

(

)

const

Definition at line 295 of file yaml_parser_base.cpp.

References priorsNode.

Referenced by main().

{return priorsNode;}

Here is the caller graph for this function:

getScannerNode()

YAML::Node Gambit::IniParser::Parser::getScannerNode

(

)

const

Definition at line 297 of file yaml_parser_base.cpp.

References scannerNode.

Referenced by main(), and Gambit::IniParser::IniFile::readFile().

{return scannerNode;}

Here is the caller graph for this function:

getValue()

template<typename TYPE , typename... args>

TYPE Gambit::IniParser::Parser::getValue ( args...  keys ) const

inline

Definition at line 71 of file yaml_parser_base.hpp.

References Gambit::getVariadicNode(), Gambit::IniParser::inifile_error(), keyValuePairNode, LOCAL_INFO, and Gambit::stringifyVariadic().

        {
          const YAML::Node node = getVariadicNode(keyValuePairNode, keys...);
          if (not node) inifile_error().raise(LOCAL_INFO,"No inifile entry for [" + stringifyVariadic(keys...) + "]");
          return NodeUtility::getNode<TYPE>(node);
        }

Here is the call graph for this function:

getValueOrDef()

template<typename TYPE , typename... args>

TYPE Gambit::IniParser::Parser::getValueOrDef ( TYPE  def, const args &...  keys  ) const

inline

Definition at line 78 of file yaml_parser_base.hpp.

References Gambit::LogTags::def, Gambit::getVariadicNode(), and keyValuePairNode.

Referenced by Gambit::DRes::DependencyResolver::calcObsLike(), Gambit::DRes::DependencyResolver::generateTree(), main(), Gambit::DRes::DependencyResolver::resolveDependency(), Gambit::DRes::DependencyResolver::resolveDependencyFromRules(), and Gambit::DRes::DependencyResolver::solveRequirement().

        {
          const YAML::Node node = getVariadicNode(keyValuePairNode, keys...);
          if (not node)
          {
              return def;
          }
          return NodeUtility::getNode<TYPE>(node);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

hasKey()

template<typename... args>

bool Gambit::IniParser::Parser::hasKey ( args...  keys ) const

inline

Definition at line 66 of file yaml_parser_base.hpp.

References Gambit::getVariadicNode(), and keyValuePairNode.

Referenced by basicParse(), and getOptions().

        {
          return getVariadicNode(keyValuePairNode, keys...);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

hasModelParameterEntry()

bool Gambit::IniParser::Parser::hasModelParameterEntry	(	str	model,
		str	param,
		str	key
	)		const

Getters for model/parameter section.

Definition at line 304 of file yaml_parser_base.cpp.

References parametersNode.

Referenced by getModelParameterEntry().

    {
      return parametersNode[model][param][key];
    }

Here is the caller graph for this function:

readFile()

void Gambit::IniParser::Parser::readFile ( str  filename )

virtual

Read in the YAML file.

Reimplemented in Gambit::IniParser::IniFile.

Definition at line 129 of file yaml_parser_base.cpp.

References basicParse(), and filename_to_node().

Referenced by main().

    {
      YAML::Node root = filename_to_node(filename);
      basicParse(root,filename);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

keyValuePairNode

YAML::Node Gambit::IniParser::Parser::keyValuePairNode

private

Definition at line 115 of file yaml_parser_base.hpp.

Referenced by basicParse(), getKeyValuePairNode(), getOptions(), getValue(), getValueOrDef(), and hasKey().

logNode

YAML::Node Gambit::IniParser::Parser::logNode

private

Definition at line 120 of file yaml_parser_base.hpp.

Referenced by basicParse(), getLoggerNode(), and Gambit::IniParser::IniFile::readFile().

parametersNode

YAML::Node Gambit::IniParser::Parser::parametersNode

private

Definition at line 116 of file yaml_parser_base.hpp.

Referenced by basicParse(), getModelNames(), getModelParameterEntry(), getModelParameters(), getParametersNode(), and hasModelParameterEntry().

printerNode

YAML::Node Gambit::IniParser::Parser::printerNode

private

Definition at line 118 of file yaml_parser_base.hpp.

Referenced by basicParse(), getPrinterNode(), and Gambit::IniParser::IniFile::readFile().

priorsNode

YAML::Node Gambit::IniParser::Parser::priorsNode

private

Definition at line 117 of file yaml_parser_base.hpp.

Referenced by basicParse(), and getPriorsNode().

scannerNode

YAML::Node Gambit::IniParser::Parser::scannerNode

private

Definition at line 119 of file yaml_parser_base.hpp.

Referenced by basicParse(), and getScannerNode().

---

The documentation for this class was generated from the following files:

• Utils/include/gambit/Utils/yaml_parser_base.hpp
• Utils/src/yaml_parser_base.cpp