CfgParser

An alternative parsecfg configuration parser for Nim.

Aim

Aim of this project is the following:

1. Resolve unintended interpretation of configuration files.
   parsecfg sometimes doesn't parse key-value pairs correctly depending on how the key and value are represented in the file.

   Example:
   Key Value Pair

   NamedCounts=(("DiscoveryLobbyMatchmakingPlay", 23),("DiscoveryLobbyMatchmakingPlay_HotfixVer", 0),("lastfrontendflow_Fortnite", 23),("lastfrontendflow_Fortnite_HotfixVer", 0),("UEnableMultiFactorModal::ShouldShowMFASplashScreen", 23),("UEnableMultiFactorModal::ShouldShowMFASplashScreen_HotfixVer", 0),("FrontendContext:ShouldShowSocialImport", 23),("FrontendContext:ShouldShowSocialImport_HotfixVer", 0))

   What it is parsed as

   namedcounts="""(("DiscoveryLobbyMatchmakingPlay", 23),("DiscoveryLobbyMatchmakingPlay_HotfixVer", 0),("lastfrontendflow_Fortnite", 23),("lastfrontendflow_Fortnite_HotfixVer", 0),("UEnableMultiFactorModal::ShouldShowMFASplashScreen", 23),("UEnableMultiFactorModal::ShouldShowMFASplashScreen_HotfixVer", 0),("FrontendContext:ShouldShowSocialImport", 23),("FrontendContext:ShouldShowSocialImport_HotfixVer", 0))"""

2. Implement customizable parsing arguments.

3. Implement similar functions present in parsecfg.

Functions and Objects

1. Configuration File Object.

   type Cfg* = OrderedTableRef[string, OrderedTableRef[string, string]]

   • Functions

     1.  proc setSectionValue*(cfg: var Cfg, section, key, value: string)

        Set the value of a key for the specified section.

     2.  proc delSection*(cfg: var Cfg, section: string)

        Delete the specified section.

     3.  proc delSectionKey*(cfg: var Cfg, section, key: string)

        Delete the specified key from a section.

     4.  proc getSectionValue*(cfg: Cfg, section, key: string, default: string = "")

        Get the value of a key from the specified section.

2. Create a new Configuration File Object.

   proc newCfg*: Cfg

3. Load a Configuration File Object using a string or file.

   • String Representation

     proc loadCfg*(str: string, case_sensitive: bool = true, delimiter: char = '=', comments: openArray[char] = [';']): Cfg

     • str: String representation of the configuration file.
     • caseSensitive: Whether keys and sections should be case_senstive.
     • delimiter: The character used to separate keys from values.
     • comments: A sequence of characters used to indicate comments.

   • Filename

     proc readCfg*(str: string, case_sensitive: bool = true, delimiter: char = '=', comments: openArray[char] = [';']): Cfg

     • filename: Name of the file to read from.
     • caseSensitive: Whether keys and sections should be case_senstive.
     • delimiter: The character used to separate keys from values.
     • comments: A sequence of characters used to indicate comments.

4. Dump/Write a Configuration File Object as a string or file.

   • String Representation

     proc dumpCfg*(cfg: Cfg, delimiter: char = '='): string

     • cfg: Configuration File Object
     • delimiter: The character used to separate keys from values.

   • File

     proc writeCfg*(cfg: Cfg, filename: string, delimiter: char = '=')

     • cfg: Configuration File Object
     • filename: Name of the file write.
     • delimiter: The character used to separate keys from values.