cpp-hocon  0.3.0
Public Member Functions | Static Public Member Functions | List of all members
hocon::parseable Class Referenceabstract
Inheritance diagram for hocon::parseable:
hocon::config_parseable hocon::parseable_file hocon::parseable_not_found hocon::parseable_resources hocon::parseable_string

Public Member Functions

void post_construct (config_parse_options const &base_options)
 
std::shared_ptr< config_documentparse_config_document ()
 
shared_object parse (config_parse_options const &options) const override
 Parse whatever it is. More...
 
shared_object parse () const
 
shared_value parse_value () const
 
config_parse_options const & options () const override
 Get the initial options, which can be modified then passed to parse(). More...
 
std::shared_ptr< const config_originorigin () const override
 Returns a config_origin describing the origin of the paresable item. More...
 
virtual std::unique_ptr< std::istream > reader (config_parse_options const &options) const
 
virtual std::unique_ptr< std::istream > reader () const =0
 
virtual shared_origin create_origin () const =0
 
virtual config_syntax guess_syntax () const
 
virtual config_syntax content_type () const
 
virtual std::shared_ptr< config_parseablerelative_to (std::string file_name) const
 
std::string to_string () const
 
std::string get_cur_dir () const
 
void set_cur_dir (std::string dir) const
 
void separate_filepath (const std::string &path, std::string *file_dir, std::string *file_name) const
 
 parseable (parseable const &)=delete
 
parseableoperator= (parseable const &)=delete
 

Static Public Member Functions

static std::shared_ptr< parseablenew_file (std::string input_file_path, config_parse_options options)
 
static std::shared_ptr< parseablenew_string (std::string s, config_parse_options options)
 
static std::shared_ptr< parseablenew_not_found (std::string what_not_found, std::string message, config_parse_options options)
 
static config_syntax syntax_from_extension (std::string name)
 

Detailed Description

Definition at line 13 of file parseable.hpp.

Member Function Documentation

◆ options()

config_parse_options const& hocon::parseable::options ( ) const
overridevirtual

Get the initial options, which can be modified then passed to parse().

These options will have the right description, includer, and other parameters already set up.

Returns
the initial options

Implements hocon::config_parseable.

◆ origin()

std::shared_ptr<const config_origin> hocon::parseable::origin ( ) const
overridevirtual

Returns a config_origin describing the origin of the paresable item.

Implements hocon::config_parseable.

◆ parse()

shared_object hocon::parseable::parse ( config_parse_options const &  options) const
overridevirtual

Parse whatever it is.

The options should come from config_parseable#options() but you could tweak them if you like.

Parameters
optionsparse options, should be based on the ones from config_parseable#options()
Returns
the parsed object

Implements hocon::config_parseable.


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