- Notifications
You must be signed in to change notification settings - Fork39
Simple C++ Config Loader Framework(Serialization & Reflection)
License
netcan/config-loader
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
config-loader中文版
config-loader is a static reflection framework written in C++17 fromparse configuration file tonative data structure. It has the following characteristics:
- Simple interface, users need todefine data structure and provide correspondingconfiguration file, the framework uses meta-programming technology to generateload interface
- The design conforms to the opening and closing principle, extends the data structure without modifying the framework
- Currently supports XML, JSON and YAML format configuration files, a variety of methods can beflexibly composed
- Lightweight, easy to integrate, less than ~1000 lines of code
- Support nested data structure, STL container
- Complete test cases
- Support from native data structure to config file, stringify data structure
Future plans:
- Provide additional C++20 version
Build
$ git clone --recursive https://github.com/netcan/config-loader.git$cd config-loader$ mkdir build$cd build$ cmake ..$ make -j
Run
$cd bin/$ ./config_loader_testFirstly useDEFINE_SCHEMA macro to define the data structure:
// define and reflect a structDEFINE_SCHEMA(Point,// struct Point { (double) x,// double x; (double) y);// double y;// };// vector and stringDEFINE_SCHEMA(SomeOfPoints,// struct SomeOfPoints { (std::string) name,// std::string name; (std::vector<Point>) points);// std::vector<Point> points;// };
Provide configuration files, usingloadXML2Obj/loadJSON2Obj/loadYAML2Obj interfaces:
SomeOfPoints someOfPoints;auto res = loadJSON2Obj(someOfPoints, [] {returnR"( { "name": "Some of points", "points":[ { "x": 1.2, "y": 3.4 }, { "x": 5.6, "y": 7.8 }, { "x": 2.2, "y": 3.3 } ] })";});REQUIRE(res == Result::SUCCESS);REQUIRE_THAT(someOfPoints.name, Equals("Some of points"));REQUIRE(someOfPoints.points.size() == 3);
Or, through an XML configuration file.
SomeOfPoints someOfPoints;auto res = loadXML2Obj(someOfPoints,"configs/xml/SomeOfPoints.xml");REQUIRE(res == Result::SUCCESS);REQUIRE_THAT(someOfPoints.name, Equals("Some of points"));REQUIRE(someOfPoints.points.size() == 3);
Through a YAML configuration file.
SomeOfPoints someOfPoints;auto res = loadYAML2Obj(someOfPoints, [] {returnR"( name: Some of points points: - x: 1.2 y: 3.4 - x: 5.6 y: 7.8 - x: 2.2 y: 3.3)";});REQUIRE(res == Result::SUCCESS);REQUIRE_THAT(someOfPoints.name, Equals("Some of points"));REQUIRE(someOfPoints.points.size() == 3);
The current framework depends on the following libraries:
tinyxml2, used for parsing xml configuration filesjsoncpp, used for parsing json configuration filesyamlcpp, used for parsing yaml configuration files
In the future, these libraries may be enabled through CMake options to avoid unnecessary dependencies in actual use: only using xml will only rely on the xml parsing library.
This framework requires configuration files to be provided in a standardized format. Taking XML as an example, the field name is required to correspond to the XML tag name, and the value corresponds to the text content of the XML; for themap data structure, the tag uses the attributename as the key name.
The semantics of the current error code.
enumclassResult { SUCCESS,// parse successfully ERR_EMPTY_CONTENT,// The parsing file is empty ERR_ILL_FORMED,// Illegal parsing file ERR_MISSING_FIELD,// Missing field ERR_EXTRACTING_FIELD,// Failed to parse the value ERR_TYPE,// Type error};
About
Simple C++ Config Loader Framework(Serialization & Reflection)