EIC code displayed by LXR master/​include/​CLI/​ConfigFwd.hpp	Source navigation Diff markup Identifier search General search
	Version: master test Revert   Change

File indexing completed on 2025-07-05 08:51:42

 // Copyright (c) 2017-2024, University of Cincinnati, developed by Henry Schreiner
 // under NSF AWARD 1414736 and by the respective contributors.
 // All rights reserved.
 //
 // SPDX-License-Identifier: BSD-3-Clause
 
 #pragma once
 
 // IWYU pragma: private, include "CLI/CLI.hpp"
 
 // [CLI11:public_includes:set]
 #include <algorithm>
 #include <fstream>
 #include <iostream>
 #include <memory>
 #include <string>
 #include <vector>
 // [CLI11:public_includes:end]
 
 #include "Error.hpp"
 #include "StringTools.hpp"
 
 namespace CLI {
 // [CLI11:config_fwd_hpp:verbatim]
 
 class App;
 
 /// Holds values to load into Options
 struct ConfigItem {
     /// This is the list of parents
     std::vector<std::string> parents{};
 
     /// This is the name
     std::string name{};
     /// Listing of inputs
     std::vector<std::string> inputs{};
 
     /// The list of parents and name joined by "."
     CLI11_NODISCARD std::string fullname() const {
         std::vector<std::string> tmp = parents;
         tmp.emplace_back(name);
         return detail::join(tmp, ".");
     }
 };
 
 /// This class provides a converter for configuration files.
 class Config {
   protected:
     std::vector<ConfigItem> items{};
 
   public:
     /// Convert an app into a configuration
     virtual std::string to_config(const App *, bool, bool, std::string) const = 0;
 
     /// Convert a configuration into an app
     virtual std::vector<ConfigItem> from_config(std::istream &) const = 0;
 
     /// Get a flag value
     CLI11_NODISCARD virtual std::string to_flag(const ConfigItem &item) const {
         if(item.inputs.size() == 1) {
             return item.inputs.at(0);
         }
         if(item.inputs.empty()) {
             return "{}";
         }
         throw ConversionError::TooManyInputsFlag(item.fullname());  // LCOV_EXCL_LINE
     }
 
     /// Parse a config file, throw an error (ParseError:ConfigParseError or FileError) on failure
     CLI11_NODISCARD std::vector<ConfigItem> from_file(const std::string &name) const {
         std::ifstream input{name};
         if(!input.good())
             throw FileError::Missing(name);
 
         return from_config(input);
     }
 
     /// Virtual destructor
     virtual ~Config() = default;
 };
 
 /// This converter works with INI/TOML files; to write INI files use ConfigINI
 class ConfigBase : public Config {
   protected:
     /// the character used for comments
     char commentChar = '#';
     /// the character used to start an array '\0' is a default to not use
     char arrayStart = '[';
     /// the character used to end an array '\0' is a default to not use
     char arrayEnd = ']';
     /// the character used to separate elements in an array
     char arraySeparator = ',';
     /// the character used separate the name from the value
     char valueDelimiter = '=';
     /// the character to use around strings
     char stringQuote = '"';
     /// the character to use around single characters and literal strings
     char literalQuote = '\'';
     /// the maximum number of layers to allow
     uint8_t maximumLayers{255};
     /// the separator used to separator parent layers
     char parentSeparatorChar{'.'};
     /// Specify the configuration index to use for arrayed sections
     int16_t configIndex{-1};
     /// Specify the configuration section that should be used
     std::string configSection{};
 
   public:
     std::string
     to_config(const App * /*app*/, bool default_also, bool write_description, std::string prefix) const override;
 
     std::vector<ConfigItem> from_config(std::istream &input) const override;
     /// Specify the configuration for comment characters
     ConfigBase *comment(char cchar) {
         commentChar = cchar;
         return this;
     }
     /// Specify the start and end characters for an array
     ConfigBase *arrayBounds(char aStart, char aEnd) {
         arrayStart = aStart;
         arrayEnd = aEnd;
         return this;
     }
     /// Specify the delimiter character for an array
     ConfigBase *arrayDelimiter(char aSep) {
         arraySeparator = aSep;
         return this;
     }
     /// Specify the delimiter between a name and value
     ConfigBase *valueSeparator(char vSep) {
         valueDelimiter = vSep;
         return this;
     }
     /// Specify the quote characters used around strings and literal strings
     ConfigBase *quoteCharacter(char qString, char literalChar) {
         stringQuote = qString;
         literalQuote = literalChar;
         return this;
     }
     /// Specify the maximum number of parents
     ConfigBase *maxLayers(uint8_t layers) {
         maximumLayers = layers;
         return this;
     }
     /// Specify the separator to use for parent layers
     ConfigBase *parentSeparator(char sep) {
         parentSeparatorChar = sep;
         return this;
     }
     /// get a reference to the configuration section
     std::string &sectionRef() { return configSection; }
     /// get the section
     CLI11_NODISCARD const std::string &section() const { return configSection; }
     /// specify a particular section of the configuration file to use
     ConfigBase *section(const std::string &sectionName) {
         configSection = sectionName;
         return this;
     }
 
     /// get a reference to the configuration index
     int16_t &indexRef() { return configIndex; }
     /// get the section index
     CLI11_NODISCARD int16_t index() const { return configIndex; }
     /// specify a particular index in the section to use (-1) for all sections to use
     ConfigBase *index(int16_t sectionIndex) {
         configIndex = sectionIndex;
         return this;
     }
 };
 
 /// the default Config is the TOML file format
 using ConfigTOML = ConfigBase;
 
 /// ConfigINI generates a "standard" INI compliant output
 class ConfigINI : public ConfigTOML {
 
   public:
     ConfigINI() {
         commentChar = ';';
         arrayStart = '\0';
         arrayEnd = '\0';
         arraySeparator = ' ';
         valueDelimiter = '=';
     }
 };
 // [CLI11:config_fwd_hpp:end]
 }  // namespace CLI

This page was automatically generated by the 2.3.7 LXR engine. The LXR team