sisi4s
Loading...
Searching...
No Matches
CLI::ConfigINI Class Reference

ConfigINI generates a "standard" INI compliant output. More...

#include <CLI11.hpp>

Inheritance diagram for CLI::ConfigINI:
Collaboration diagram for CLI::ConfigINI:

Public Member Functions

 ConfigINI ()
 
- Public Member Functions inherited from CLI::ConfigBase
std::string to_config (const App *, bool default_also, bool write_description, std::string prefix) const override
 Convert an app into a configuration.
 
std::vector< ConfigItemfrom_config (std::istream &input) const override
 Convert a configuration into an app.
 
ConfigBasecomment (char cchar)
 Specify the configuration for comment characters.
 
ConfigBasearrayBounds (char aStart, char aEnd)
 Specify the start and end characters for an array.
 
ConfigBasearrayDelimiter (char aSep)
 Specify the delimiter character for an array.
 
ConfigBasevalueSeparator (char vSep)
 Specify the delimiter between a name and value.
 
ConfigBasequoteCharacter (char qString, char qChar)
 Specify the quote characters used around strings and characters.
 
ConfigBasemaxLayers (uint8_t layers)
 Specify the maximum number of parents.
 
ConfigBaseparentSeparator (char sep)
 Specify the separator to use for parent layers.
 
std::string & sectionRef ()
 get a reference to the configuration section
 
const std::string & section () const
 get the section
 
ConfigBasesection (const std::string &sectionName)
 specify a particular section of the configuration file to use
 
int16_t & indexRef ()
 get a reference to the configuration index
 
int16_t index () const
 get the section index
 
ConfigBaseindex (int16_t sectionIndex)
 specify a particular index in the section to use (-1) for all sections to use
 
- Public Member Functions inherited from CLI::Config
virtual std::string to_config (const App *, bool, bool, std::string) const =0
 Convert an app into a configuration.
 
virtual std::vector< ConfigItemfrom_config (std::istream &) const =0
 Convert a configuration into an app.
 
virtual std::string to_flag (const ConfigItem &item) const
 Get a flag value.
 
std::vector< ConfigItemfrom_file (const std::string &name)
 Parse a config file, throw an error (ParseError:ConfigParseError or FileError) on failure.
 
virtual ~Config ()=default
 Virtual destructor.
 

Additional Inherited Members

- Protected Attributes inherited from CLI::ConfigBase
char commentChar = '#'
 the character used for comments
 
char arrayStart = '['
 the character used to start an array '\0' is a default to not use
 
char arrayEnd = ']'
 the character used to end an array '\0' is a default to not use
 
char arraySeparator = ','
 the character used to separate elements in an array
 
char valueDelimiter = '='
 the character used separate the name from the value
 
char stringQuote = '"'
 the character to use around strings
 
char characterQuote = '\''
 the character to use around single characters
 
uint8_t maximumLayers {255}
 the maximum number of layers to allow
 
char parentSeparatorChar {'.'}
 the separator used to separator parent layers
 
int16_t configIndex {-1}
 Specify the configuration index to use for arrayed sections.
 
std::string configSection {}
 Specify the configuration section that should be used.
 
- Protected Attributes inherited from CLI::Config
std::vector< ConfigItemitems {}
 

Detailed Description

ConfigINI generates a "standard" INI compliant output.

Constructor & Destructor Documentation

◆ ConfigINI()

CLI::ConfigINI::ConfigINI ( )
inline

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