blob: 8d7a47fd3607a597a7d709763cae2600b0679977 (
plain)
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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
|
/*
* @copyright Copyright (c) 2016-2020 TOYOTA MOTOR CORPORATION.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
////////////////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup tag_NS_ConfigParser
/// \brief This file contains the declaration of class CCFGParser.
/// This class contains the parsing logic for reading and writing from and to cfg files
/// respectively.
///
////////////////////////////////////////////////////////////////////////////////////////////////////
#ifndef FRAMEWORK_UNIFIED_CLIENT_NS_CONFIGPARSER_INCLUDE_NS_CFG_PARSER_H_
#define FRAMEWORK_UNIFIED_CLIENT_NS_CONFIGPARSER_INCLUDE_NS_CFG_PARSER_H_
////////////////////////////////////////////////////////////////////////////////////////////////////
// Include Files
////////////////////////////////////////////////////////////////////////////////////////////////////
#include <native_service/frameworkunified_types.h>
#include <string>
#include <map>
// forward declaration of classes
class CNode;
class CBlock;
typedef std::map<std::string, CBlock *> CFGData_Type;
class CCFGParser {
public:
////////////////////////////////////////////////////////////////////////////////////////////////
/// CCFGParser
/// Constructor of CCFGReader class
///
/// \param
///
/// \return
///
////////////////////////////////////////////////////////////////////////////////////////////////
CCFGParser();
////////////////////////////////////////////////////////////////////////////////////////////////
/// CCFGParser
/// Constructor of CCFGReader class
///
/// \param [IN] f_c_filepath
/// std::string - Full path of the configuration file
///
/// \return
///
////////////////////////////////////////////////////////////////////////////////////////////////
explicit CCFGParser(const std::string &f_c_filepath);
////////////////////////////////////////////////////////////////////////////////////////////////
/// ~CCFGParser
/// Destructor of CCFGReader class
///
/// \param
///
/// \return
///
////////////////////////////////////////////////////////////////////////////////////////////////
~CCFGParser();
////////////////////////////////////////////////////////////////////////////////////////////////
/// CFGParseFile
/// This function is used to parse the configuration file and store data in internal structure
///
/// \param [IN] f_c_filepath
/// std::string - full path of the configuration file
///
/// \return EFrameworkunifiedStatus - success or failure
///
////////////////////////////////////////////////////////////////////////////////////////////////
EFrameworkunifiedStatus CFGParseFile(const std::string &f_c_filepath);
////////////////////////////////////////////////////////////////////////////////////////////////
/// CFGGetData
/// This function is used to get the value associated with the key from internal CFG structure
///
/// \param [IN] f_c_key
/// std::string - key to search
///
/// \return std::string - value for key
///
////////////////////////////////////////////////////////////////////////////////////////////////
std::string CFGGetData(const std::string &f_c_key);
////////////////////////////////////////////////////////////////////////////////////////////////
/// CFGGetData
/// This function is used to get the value associated with the key from internal CFG structure
///
/// \param [IN] f_c_key
/// std::string - key to search
/// \param [IN] f_c_value
/// std::string - Value of key
///
/// \return EFrameworkunifiedStatus
/// EFrameworkunifiedStatus - error if key not founf or else eFrameworkunifiedStatusOK
///
////////////////////////////////////////////////////////////////////////////////////////////////
EFrameworkunifiedStatus CFGGetData(const std::string &f_c_key, std::string &f_c_value); // NOLINT (readability/nolint)
////////////////////////////////////////////////////////////////////////////////////////////////
/// CFGSetData
/// This function is used to set the value for the key in internal CFG structure
///
/// \param [IN] f_c_key
/// std::string - key to search
/// \param [IN] f_c_value
/// std::string - value to set
///
/// \return EFrameworkunifiedStatus - success or failure
///
////////////////////////////////////////////////////////////////////////////////////////////////
EFrameworkunifiedStatus CFGSetData(const std::string &f_c_key, std::string f_c_value);
////////////////////////////////////////////////////////////////////////////////////////////////
/// CFGSaveData
/// This function is used to save the changed value to the cfg config file
///
/// \param [IN] f_c_filepath
/// std::string - full path of the configuration file
///
/// \return EFrameworkunifiedStatus - success or failure
///
////////////////////////////////////////////////////////////////////////////////////////////////
EFrameworkunifiedStatus CFGSaveData(const std::string &f_c_filepath);
private:
// internal data structure created by parsing the cfg file
CFGData_Type *m_pmCFGData;
std::string m_cLastComment;
};
#endif // FRAMEWORK_UNIFIED_CLIENT_NS_CONFIGPARSER_INCLUDE_NS_CFG_PARSER_H_
|
