1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
|
//
// Copyright 2018 Ettus Research, a National Instruments Company
//
// SPDX-License-Identifier: GPL-3.0-or-later
//
#ifndef INCLUDED_LIBUHD_CONFIG_PARSER_HPP
#define INCLUDED_LIBUHD_CONFIG_PARSER_HPP
#include <uhd/exception.hpp>
#include <boost/property_tree/ptree.hpp>
#include <vector>
namespace uhd {
/*! Represent a config file (INI format)
*
* These files have the following format:
* ```
* ; Comment
* [section]
* key=value
* ```
*
* The API of this class was designed to match the ConfigParser class from
* Python https://docs.python.org/3/library/configparser.html, which we use in
* MPM. This does mean the API is somewhat different from typical C++ APIs,
* and does not name getters get_*.
*/
class config_parser
{
public:
/*!
* \param path Path to the INI file
*
* \throws uhd::runtime_error if the parsing failed.
*/
config_parser(const std::string &path="");
/*! Load another config file and update the current values.
*
* If a value exists in both the new and current file, the new value wins.
*/
void read_file(const std::string &path);
//! Return a list of sections
std::vector<std::string> sections();
//! Return a list of options (keys) in a section, or an empty list if
// section does not exist
std::vector<std::string> options(const std::string §ion);
/*! Return the value of a key
*
* \param section The name of the section in which this key is
* \param key Name of the key
* \param def Default value, in case the key does not exist
*/
template <typename T>
T get(
const std::string §ion,
const std::string &key,
const T &def
) {
try {
const auto child = _pt.get_child(section);
return child.get<T>(key, def);
} catch (const boost::property_tree::ptree_bad_path &) {
return def;
}
}
/*! Return the value of a key
*
* \param section The name of the section in which this key is
* \param key Name of the key
*
* \throws uhd::key_error if the key or the section don't exist
*/
template <typename T>
T get(
const std::string §ion,
const std::string &key
) {
try {
const auto child = _pt.get_child(section);
return child.get<T>(key);
} catch (const boost::property_tree::ptree_bad_path &) {
throw uhd::key_error(
std::string("[config_parser] Key ") + key +
" not found in section " + section
);
}
}
template <typename T>
void set(
const std::string §ion,
const std::string &key,
const T &value
) {
_pt.put<T>(section + "." + key, value);
}
private:
template <typename T>
static std::vector<std::string> _options(T key_bearing_iterable)
{
std::vector<std::string> sections;
for (const auto& node : key_bearing_iterable) {
sections.push_back(node.first);
}
return sections;
}
boost::property_tree::ptree _pt;
};
} /* namespace uhd */
#endif /* INCLUDED_LIBUHD_CONFIG_PARSER_HPP */
|