cpp-hocon 0.3.0
Loading...
Searching...
No Matches
Public Member Functions | List of all members
hocon::config_includer_file Class Referenceabstract

Implement this in addition to config_includer if you want to support inclusion of files with the include file("filename") syntax. More...

#include <config_includer_file.hpp>

Inheritance diagram for hocon::config_includer_file:
hocon::full_includer hocon::simple_includer

Public Member Functions

virtual shared_object include_file (shared_include_context context, std::string what) const =0
 Parses another item to be included.
 

Detailed Description

Implement this in addition to config_includer if you want to support inclusion of files with the include file("filename") syntax.

If you do not implement this but do implement config_includer, attempts to load files will use the default includer.

Definition at line 14 of file config_includer_file.hpp.

Member Function Documentation

◆ include_file()

virtual shared_object hocon::config_includer_file::include_file ( shared_include_context  context,
std::string  what 
) const
pure virtual

Parses another item to be included.

The returned object typically would not have substitutions resolved. You can throw a config_exception here to abort parsing, or return an empty object, but may not return null.

Parameters
contextsome info about the include context
whatthe include statement's argument (a file path)
Returns
a non-null config_object

Implemented in hocon::simple_includer.


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