From f1a1c75407c4e0c6a6d25bda7647acf2f2e4d148 Mon Sep 17 00:00:00 2001 From: tastytea Date: Sun, 21 Jul 2019 23:12:08 +0200 Subject: [PATCH] 2019-07-21 --- docs/annotated.html | 2 +- docs/classes.html | 2 +- docs/classxdgcfg-members.html | 16 ++-- docs/classxdgcfg.html | 91 ++++++++++++------- .../dir_68267d1309a1af8e8297ef4c3efbcdba.html | 2 +- docs/example_8cpp-example.html | 4 +- docs/examples.html | 2 +- docs/files.html | 2 +- docs/functions.html | 12 +-- docs/functions_func.html | 12 +-- docs/index.html | 9 +- docs/xdgcfg_8hpp_source.html | 18 ++-- 12 files changed, 97 insertions(+), 75 deletions(-) diff --git a/docs/annotated.html b/docs/annotated.html index a3b51f6..fae1e06 100644 --- a/docs/annotated.html +++ b/docs/annotated.html @@ -19,7 +19,7 @@
xdgcfg -  0.2.2 +  0.3.0
diff --git a/docs/classes.html b/docs/classes.html index 1f62b98..473c21f 100644 --- a/docs/classes.html +++ b/docs/classes.html @@ -19,7 +19,7 @@
xdgcfg -  0.2.2 +  0.3.0
diff --git a/docs/classxdgcfg-members.html b/docs/classxdgcfg-members.html index 40a369f..61fbe15 100644 --- a/docs/classxdgcfg-members.html +++ b/docs/classxdgcfg-members.html @@ -19,7 +19,7 @@
xdgcfg -  0.2.2 +  0.3.0
@@ -46,13 +46,13 @@ $(function() {

This is the complete list of members for xdgcfg, including all inherited members.

- - - - - - - + + + + + + +
get_cfg()xdgcfg
get_filepath() constxdgcfg
get_verbose() constxdgcfg
read()xdgcfg
set_verbose(bool verbose)xdgcfg
write()xdgcfg
xdgcfg(const string &filename, const string &subdir="")xdgcfgexplicit
get_cfg()xdgcfginline
get_filepath() constxdgcfginline
get_verbose() constxdgcfginline
read()xdgcfginline
set_verbose(bool verbose)xdgcfginline
write()xdgcfginline
xdgcfg(const string &filename, const string &subdir="")xdgcfginlineexplicit
diff --git a/docs/classxdgcfg.html b/docs/classxdgcfg.html index 7d4d568..5ec391e 100644 --- a/docs/classxdgcfg.html +++ b/docs/classxdgcfg.html @@ -19,7 +19,7 @@
xdgcfg -  0.2.2 +  0.3.0
@@ -52,27 +52,27 @@ Public Member Functions  xdgcfg (const string &filename, const string &subdir="")  Checks if subdir is present, creates it if necessary. More...
  -const uint_fast8_t read () - Read the file. More...
-  -const bool write () - Write the file. More...
-  -libconfig::Config & get_cfg () - Returns a reference to the config as libconfig::Config. More...
-  +uint_fast8_t read () + Read the file. More...
+  +bool write () + Write the file. More...
+  +libconfig::Config & get_cfg () + Returns a reference to the config as libconfig::Config. More...
+  const fs::path get_filepath () const  Returns the complete filepath.
  - -const void set_verbose (bool verbose) - Sets verbosity.
-  - -const bool get_verbose () const - Returns verbosity.
-  + +void set_verbose (bool verbose) + Sets verbosity.
+  + +bool get_verbose () const + Returns verbosity.
+ 

Detailed Description

Examples:
example.cpp.
@@ -106,7 +106,7 @@ const bool  -explicit +inlineexplicit
@@ -119,75 +119,98 @@ const bool  -
13 : _cfg()
14 , _verbose(false)
15 {
16  xdgHandle xdg;
17  xdgInitHandle(&xdg);
18  _filepath = xdgConfigHome(&xdg);
19  xdgWipeHandle(&xdg);
20 
21  if (!subdir.empty())
22  {
23  _filepath /= subdir;
24  }
25  if (!fs::exists(_filepath))
26  {
27  fs::create_directories(_filepath);
28  }
29  _filepath /= filename;
30 }
+
44  : _cfg()
45  , _verbose(false)
46  {
47  xdgHandle xdg;
48  xdgInitHandle(&xdg);
49  _filepath = xdgConfigHome(&xdg);
50  xdgWipeHandle(&xdg);
51 
52  if (!subdir.empty())
53  {
54  _filepath /= subdir;
55  }
56  if (!fs::exists(_filepath))
57  {
58  fs::create_directories(_filepath);
59  }
60  _filepath /= filename;
61  }

Member Function Documentation

- -

◆ get_cfg()

+ +

◆ get_cfg()

+ + + + + +
- +
libconfig::Config & xdgcfg::get_cfg libconfig::Config& xdgcfg::get_cfg ( )
+ 		+inline

Returns a reference to the config as libconfig::Config.

Example:

libconfig::Config &cfg = config.get_cfg();
Examples:
example.cpp.
-
80 {
81  return _cfg;
82 }
+
129  {
130  return _cfg;
131  }
- -

◆ read()

+ +

◆ read()

+ + + + + +
- +
const uint_fast8_t xdgcfg::read uint_fast8_t xdgcfg::read ( )
+ 		+inline

Read the file.

Returns
0 on success, 1 on I/O error, 2 on parse error.
Examples:
example.cpp.
-
33 {
34  try
35  {
36  _cfg.readFile(_filepath.c_str());
37  }
38  catch (const libconfig::FileIOException &e)
39  {
40  if (_verbose)
41  {
42  cerr << "I/O error while reading " << _filepath
43  << " - " << e.what() << endl;
44  }
45  return 1;
46  }
47  catch (const libconfig::ParseException &e)
48  {
49  if (_verbose)
50  {
51  cerr << "Parse error at " << e.getFile() << ":" << e.getLine()
52  << " - " << e.getError() << endl;
53  }
54  return 2;
55  }
56 
57  return 0;
58 }
+
69  {
70  try
71  {
72  _cfg.readFile(_filepath.c_str());
73  }
74  catch (const libconfig::FileIOException &e)
75  {
76  if (_verbose)
77  {
78  cerr << "I/O error while reading " << _filepath
79  << " - " << e.what() << endl;
80  }
81  return 1;
82  }
83  catch (const libconfig::ParseException &e)
84  {
85  if (_verbose)
86  {
87  cerr << "Parse error at " << e.getFile() << ":" << e.getLine()
88  << " - " << e.getError() << endl;
89  }
90  return 2;
91  }
92 
93  return 0;
94  }
- -

◆ write()

+ +

◆ write()

+ + + + + +
- +
const bool xdgcfg::write bool xdgcfg::write ( )
+ 		+inline

Write the file.

Returns
true on success
Examples:
example.cpp.
-
61 {
62  try
63  {
64  _cfg.writeFile(_filepath.c_str());
65  }
66  catch (const libconfig::FileIOException &e)
67  {
68  if (_verbose)
69  {
70  cerr << "I/O error while writing " << _filepath
71  << " - " << e.what() << endl;
72  }
73  return false;
74  }
75 
76  return true;
77 }
+
102  {
103  try
104  {
105  _cfg.writeFile(_filepath.c_str());
106  }
107  catch (const libconfig::FileIOException &e)
108  {
109  if (_verbose)
110  {
111  cerr << "I/O error while writing " << _filepath
112  << " - " << e.what() << endl;
113  }
114  return false;
115  }
116 
117  return true;
118  }
-
The documentation for this class was generated from the following files:
    +
    The documentation for this class was generated from the following file: diff --git a/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html b/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html index eb9bce3..f197430 100644 --- a/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html +++ b/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html @@ -19,7 +19,7 @@
    xdgcfg -  0.2.2 +  0.3.0
    diff --git a/docs/example_8cpp-example.html b/docs/example_8cpp-example.html index 994ee39..a04ae33 100644 --- a/docs/example_8cpp-example.html +++ b/docs/example_8cpp-example.html @@ -19,7 +19,7 @@
    xdgcfg -  0.2.2 +  0.3.0
    @@ -43,7 +43,7 @@ $(function() {
    example.cpp
    -
    #include <iostream>
    #include <libconfig.h++>
    #include "xdgcfg.hpp"
    int main(int argc, char *argv[])
    {
    xdgcfg config("test.cfg", "xdgcfg");
    config.set_verbose(true);
    if (config.read() != 0)
    {
    config.write();
    }
    libconfig::Config &cfg = config.get_cfg();
    libconfig::Setting &root = cfg.getRoot();
    if (!root.exists("Hello"))
    {
    root.add("Hello", libconfig::Setting::TypeString) = "World";
    }
    config.write();
    std::cout << "Hello: " << root["Hello"].c_str() << std::endl;
    }
    +
    #include <iostream>
    #include <libconfig.h++>
    #include "xdgcfg.hpp"
    int main()
    {
    xdgcfg config("test.cfg", "xdgcfg");
    config.set_verbose(true);
    if (config.read() != 0)
    {
    config.write();
    }
    libconfig::Config &cfg = config.get_cfg();
    libconfig::Setting &root = cfg.getRoot();
    if (!root.exists("Hello"))
    {
    root.add("Hello", libconfig::Setting::TypeString) = "World";
    }
    config.write();
    std::cout << "Hello: " << root["Hello"].c_str() << std::endl;
    }
    Generated by   diff --git a/docs/examples.html b/docs/examples.html index 0846863..c54f9e5 100644 --- a/docs/examples.html +++ b/docs/examples.html @@ -19,7 +19,7 @@
    xdgcfg -  0.2.2 +  0.3.0
    diff --git a/docs/files.html b/docs/files.html index 93d603c..3b35ab7 100644 --- a/docs/files.html +++ b/docs/files.html @@ -19,7 +19,7 @@
    xdgcfg -  0.2.2 +  0.3.0
    diff --git a/docs/functions.html b/docs/functions.html index 89ac7ab..b33ff98 100644 --- a/docs/functions.html +++ b/docs/functions.html @@ -19,7 +19,7 @@
    xdgcfg -  0.2.2 +  0.3.0
    @@ -41,22 +41,22 @@ $(function() {
    Here is a list of all documented class members with links to the class documentation for each member:
    • get_cfg() -: xdgcfg +: xdgcfg
    • get_filepath() : xdgcfg
    • get_verbose() -: xdgcfg +: xdgcfg
    • read() -: xdgcfg +: xdgcfg
    • set_verbose() -: xdgcfg +: xdgcfg
    • write() -: xdgcfg +: xdgcfg
    • xdgcfg() : xdgcfg diff --git a/docs/functions_func.html b/docs/functions_func.html index a1ada1f..85b8b0a 100644 --- a/docs/functions_func.html +++ b/docs/functions_func.html @@ -19,7 +19,7 @@
      xdgcfg -  0.2.2 +  0.3.0
      @@ -41,22 +41,22 @@ $(function() {
       
      • get_cfg() -: xdgcfg +: xdgcfg
      • get_filepath() : xdgcfg
      • get_verbose() -: xdgcfg +: xdgcfg
      • read() -: xdgcfg +: xdgcfg
      • set_verbose() -: xdgcfg +: xdgcfg
      • write() -: xdgcfg +: xdgcfg
      • xdgcfg() : xdgcfg diff --git a/docs/index.html b/docs/index.html index 3079252..1736aa1 100644 --- a/docs/index.html +++ b/docs/index.html @@ -19,7 +19,7 @@
        xdgcfg -  0.2.2 +  0.3.0
        @@ -46,16 +46,15 @@ $(function() {

        xdgcfg is a very simple wrapper around libconfig written in C++. It reads and writes files in ${XDG_CONFIG_HOME}. It creates subdirectories if necessary.

        Dependencies

        Usage

        -

        You can create dynamic and static libraries:

        -
        mkdir build
        cd build
        cmake ..
        make
        make install

        Or just copy xdgcfg.hpp and xdgcfg.cpp into your project folder.

        -

        Documentation

        +

        Copy xdgcfg.hpp into a folder where your project can find it.

        +
        mkdir build
        cd build
        cmake ..
        make
        make install

        Documentation

        xdgcfg.hpp has explanatory comments in it and there is an example. The reference is also available at doc.schlomp.space/xdgcfg/.

      diff --git a/docs/xdgcfg_8hpp_source.html b/docs/xdgcfg_8hpp_source.html index 265c097..92ddeca 100644 --- a/docs/xdgcfg_8hpp_source.html +++ b/docs/xdgcfg_8hpp_source.html @@ -19,7 +19,7 @@
      xdgcfg -  0.2.2 +  0.3.0
      @@ -47,14 +47,14 @@ $(function() {
      xdgcfg.hpp
    -
    1 /* Public Domain / CC-0
    2  * Author: tastytea <tastytea@tastytea.de>
    3  */
    4 
    5 #ifndef XDGCFG_HPP
    6 #define XDGCFG_HPP
    7 
    8 #if __cplusplus >= 201703L
    9  #include <filesystem>
    10 #else
    11  #include <experimental/filesystem>
    12 #endif
    13 #include <string>
    14 #include <cstdint>
    15 #include <libconfig.h++>
    16 
    17 #if __cplusplus >= 201703L
    18  namespace fs = std::filesystem;
    19 #else
    20  namespace fs = std::experimental::filesystem;
    21 #endif
    22 using std::string;
    23 using std::uint_fast8_t;
    24 
    25 class xdgcfg
    26 {
    27 public:
    39  explicit xdgcfg(const string &filename, const string &subdir = "");
    40 
    46  const uint_fast8_t read();
    47 
    53  const bool write();
    54 
    63  libconfig::Config &get_cfg();
    64 
    68  const fs::path get_filepath() const;
    69 
    73  const void set_verbose(bool verbose);
    74 
    78  const bool get_verbose() const;
    79 
    80 private:
    84  libconfig::Config _cfg;
    85 
    89  fs::path _filepath;
    90 
    94  bool _verbose;
    95 };
    96 
    101 #endif // XDGCFG_HPP
    xdgcfg::write
    const bool write()
    Write the file.
    Definition: xdgcfg.cpp:60
    -
    xdgcfg
    Definition: xdgcfg.hpp:25
    -
    xdgcfg::set_verbose
    const void set_verbose(bool verbose)
    Sets verbosity.
    Definition: xdgcfg.cpp:89
    -
    xdgcfg::xdgcfg
    xdgcfg(const string &filename, const string &subdir="")
    Checks if subdir is present, creates it if necessary.
    Definition: xdgcfg.cpp:12
    -
    xdgcfg::get_cfg
    libconfig::Config & get_cfg()
    Returns a reference to the config as libconfig::Config.
    Definition: xdgcfg.cpp:79
    -
    xdgcfg::read
    const uint_fast8_t read()
    Read the file.
    Definition: xdgcfg.cpp:32
    -
    xdgcfg::get_filepath
    const fs::path get_filepath() const
    Returns the complete filepath.
    Definition: xdgcfg.cpp:84
    -
    xdgcfg::get_verbose
    const bool get_verbose() const
    Returns verbosity.
    Definition: xdgcfg.cpp:94
    +
    1 /* Public Domain / CC-0
    2  * Author: tastytea <tastytea@tastytea.de>
    3  */
    4 
    5 #ifndef XDGCFG_HPP
    6 #define XDGCFG_HPP
    7 
    8 #if __cplusplus >= 201703L
    9  #include <filesystem>
    10 #else
    11  #include <experimental/filesystem>
    12 #endif
    13 #include <string>
    14 #include <iostream>
    15 #include <cstdint>
    16 #include <libconfig.h++>
    17 #include <basedir.h>
    18 
    19 #if __cplusplus >= 201703L
    20  namespace fs = std::filesystem;
    21 #else
    22  namespace fs = std::experimental::filesystem;
    23 #endif
    24 using std::string;
    25 using std::uint_fast8_t;
    26 using std::cerr;
    27 using std::endl;
    28 
    29 class xdgcfg
    30 {
    31 public:
    43  explicit xdgcfg(const string &filename, const string &subdir = "")
    44  : _cfg()
    45  , _verbose(false)
    46  {
    47  xdgHandle xdg;
    48  xdgInitHandle(&xdg);
    49  _filepath = xdgConfigHome(&xdg);
    50  xdgWipeHandle(&xdg);
    51 
    52  if (!subdir.empty())
    53  {
    54  _filepath /= subdir;
    55  }
    56  if (!fs::exists(_filepath))
    57  {
    58  fs::create_directories(_filepath);
    59  }
    60  _filepath /= filename;
    61  }
    62 
    68  uint_fast8_t read()
    69  {
    70  try
    71  {
    72  _cfg.readFile(_filepath.c_str());
    73  }
    74  catch (const libconfig::FileIOException &e)
    75  {
    76  if (_verbose)
    77  {
    78  cerr << "I/O error while reading " << _filepath
    79  << " - " << e.what() << endl;
    80  }
    81  return 1;
    82  }
    83  catch (const libconfig::ParseException &e)
    84  {
    85  if (_verbose)
    86  {
    87  cerr << "Parse error at " << e.getFile() << ":" << e.getLine()
    88  << " - " << e.getError() << endl;
    89  }
    90  return 2;
    91  }
    92 
    93  return 0;
    94  }
    95 
    101  bool write()
    102  {
    103  try
    104  {
    105  _cfg.writeFile(_filepath.c_str());
    106  }
    107  catch (const libconfig::FileIOException &e)
    108  {
    109  if (_verbose)
    110  {
    111  cerr << "I/O error while writing " << _filepath
    112  << " - " << e.what() << endl;
    113  }
    114  return false;
    115  }
    116 
    117  return true;
    118  }
    119 
    128  libconfig::Config &get_cfg()
    129  {
    130  return _cfg;
    131  }
    132 
    136  const fs::path get_filepath() const
    137  {
    138  return _filepath;
    139  }
    140 
    144  void set_verbose(bool verbose)
    145  {
    146  _verbose = verbose;
    147  }
    148 
    152  bool get_verbose() const
    153  {
    154  return _verbose;
    155  }
    156 
    157 private:
    161  libconfig::Config _cfg;
    162 
    166  fs::path _filepath;
    167 
    171  bool _verbose;
    172 };
    173 
    178 #endif // XDGCFG_HPP
    xdgcfg
    Definition: xdgcfg.hpp:29
    +
    xdgcfg::get_cfg
    libconfig::Config & get_cfg()
    Returns a reference to the config as libconfig::Config.
    Definition: xdgcfg.hpp:128
    +
    xdgcfg::xdgcfg
    xdgcfg(const string &filename, const string &subdir="")
    Checks if subdir is present, creates it if necessary.
    Definition: xdgcfg.hpp:43
    +
    xdgcfg::set_verbose
    void set_verbose(bool verbose)
    Sets verbosity.
    Definition: xdgcfg.hpp:144
    +
    xdgcfg::get_filepath
    const fs::path get_filepath() const
    Returns the complete filepath.
    Definition: xdgcfg.hpp:136
    +
    xdgcfg::read
    uint_fast8_t read()
    Read the file.
    Definition: xdgcfg.hpp:68
    +
    xdgcfg::get_verbose
    bool get_verbose() const
    Returns verbosity.
    Definition: xdgcfg.hpp:152
    +
    xdgcfg::write
    bool write()
    Write the file.
    Definition: xdgcfg.hpp:101