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
|
// Copyright Contributors to the DNF5 project.
// Copyright Contributors to the libdnf project.
// SPDX-License-Identifier: LGPL-2.1-or-later
//
// This file is part of libdnf: https://github.com/rpm-software-management/libdnf/
//
// Libdnf is free software: you can redistribute it and/or modify
// it under the terms of the GNU Lesser General Public License as published by
// the Free Software Foundation, either version 2.1 of the License, or
// (at your option) any later version.
//
// Libdnf is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with libdnf. If not, see <https://www.gnu.org/licenses/>.
#ifndef LIBDNF5_CONF_CONFIG_PARSER_HPP
#define LIBDNF5_CONF_CONFIG_PARSER_HPP
#include "config_parser_errors.hpp"
#include "libdnf5/common/preserve_order_map.hpp"
#include "libdnf5/defs.h"
#include <string>
namespace libdnf5 {
/**
* @class ConfigParser
*
* @brief Class for parsing dnf/yum .ini configuration files.
*
* ConfigParser is used for parsing files.
* User can get both substituted and original parsed values.
* The parsed items are stored into the PreserveOrderMap.
* ConfigParser preserve order of items. Comments and empty lines are kept.
*/
struct LIBDNF_API ConfigParser {
public:
using Container = PreserveOrderMap<std::string, PreserveOrderMap<std::string, std::string>>;
ConfigParser();
~ConfigParser();
ConfigParser(const ConfigParser & src);
ConfigParser & operator=(const ConfigParser & src);
ConfigParser(ConfigParser && src) noexcept;
ConfigParser & operator=(ConfigParser && src) noexcept;
/**
* @brief Reads/parse one INI file
*
* Can be called repeately for reading/merge more INI files.
*
* @param file_path Name (with path) of file to read
*/
void read(const std::string & file_path);
/**
* @brief Writes all data (all sections) to INI file
*
* @param file_path Name (with path) of file to write
* @param append If true, existent file will be appended, otherwise overwritten
*/
void write(const std::string & file_path, bool append) const;
/**
* @brief Writes one section data to INI file
*
* @param file_path Name (with path) of file to write
* @param append If true, existent file will be appended, otherwise overwritten
* @param section Section to write
*/
void write(const std::string & file_path, bool append, const std::string & section) const;
bool add_section(const std::string & section, const std::string & raw_line);
bool add_section(const std::string & section);
bool add_section(std::string && section, std::string && raw_line);
bool add_section(std::string && section);
bool has_section(const std::string & section) const noexcept;
bool has_option(const std::string & section, const std::string & key) const noexcept;
void set_value(
const std::string & section, const std::string & key, const std::string & value, const std::string & raw_item);
void set_value(const std::string & section, const std::string & key, const std::string & value);
void set_value(const std::string & section, std::string && key, std::string && value, std::string && raw_item);
void set_value(const std::string & section, std::string && key, std::string && value);
bool remove_section(const std::string & section);
bool remove_option(const std::string & section, const std::string & key);
void add_comment_line(const std::string & section, const std::string & comment);
void add_comment_line(const std::string & section, std::string && comment);
const std::string & get_value(const std::string & section, const std::string & key) const;
const std::string & get_header() const noexcept;
std::string & get_header() noexcept;
const Container & get_data() const noexcept;
Container & get_data() noexcept;
private:
class LIBDNF_LOCAL Impl;
std::unique_ptr<Impl> p_impl;
};
} // namespace libdnf5
#endif
|
