blob: 91e88c0366b33d11cae1d66f2de261bc39908fb5 (
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
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
|
/**
* @file ns_xml_reader.h
* @brief \~english This file contains declaration of class CXMLReader.
*
*/
/** @addtogroup BaseSystem
* @{
*/
/** @addtogroup native_service
* @ingroup BaseSystem
* @{
*/
/** @addtogroup framework_unified
* @ingroup native_service
* @{
*/
/*
* @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 declaration of class CXMLReader.
///
////////////////////////////////////////////////////////////////////////////////////////////////////
#ifndef __FRAMEWORKUNIFIED_NATIVESERVICES_NSCONFIGPARSER_INC_NS_XML_READER_H__ // NOLINT (build/header_guard)
#define __FRAMEWORKUNIFIED_NATIVESERVICES_NSCONFIGPARSER_INC_NS_XML_READER_H__
////////////////////////////////////////////////////////////////////////////////////////////////////
// Include Files
////////////////////////////////////////////////////////////////////////////////////////////////////
#include <libxml/tree.h>
#include <native_service/frameworkunified_types.h>
#include <native_service/ns_reader.h>
#include <string>
/**
* @class CXMLReader
* \~english @par Brief Introduction
* This class provides functionalities to read from XML config file.
*
*/
class CXMLReader: public IConfigReader {
public:
////////////////////////////////////////////////////////////////////////////////
/// \ingroup CXMLReader
/// \~english @par Brief
/// This API constructor of CXMLReader class.
/// \~english @param None
/// \~english @retval None
/// \~english @par Prerequisite
/// - Load the shared library first
/// \~english @par Inside state change
/// - The API no inside state change
/// \~english @par None
/// \~english @par Classification
/// Public
/// \~english @par Type
/// Sync
/// \~english @par Detail
/// This API should be called by ServiceA and create a new object of CXMLReader.
/// \~english @see None
////////////////////////////////////////////////////////////////////////////////
CXMLReader();
////////////////////////////////////////////////////////////////////////////////
/// \ingroup CXMLReader
/// \~english @par Brief
/// This API constructor of CXMLReader class.
/// \~english @param [IN] f_cFilePath
/// std::string - Full path of the configuration file
/// \~english @retval None
/// \~english @par Prerequisite
/// - Load the shared library first
/// \~english @par Inside state change
/// - The API no inside state change
/// \~english @par None
/// \~english @par Classification
/// Public
/// \~english @par Type
/// Sync
/// \~english @par Detail
/// This API should be called by ServiceA and create a new object of CXMLReader with filepath.
/// \~english @see GetCXMLReaderObject
////////////////////////////////////////////////////////////////////////////////
CXMLReader(const std::string &f_cFilePath); // NOLINT (readability/nolint)
////////////////////////////////////////////////////////////////////////////////////////////////
/// \ingroup ~CXMLReader
/// \~english @par CXMLReader
/// Destructor of CXMLReader class.
/// \~english @param None
/// \~english @retval none
/// \~english @par Preconditons
/// - None
/// \~english @par Change of internal status
/// - Close shared memory object.
/// \~english @par Conditions of processing failure
/// -None
/// \~english @par Detail
/// Destruct the object of CXMLReader
/// \~english @par Classification
/// - Public
/// \~english @par Type
/// - sync only
/// \~english @see CXMLReader
////////////////////////////////////////////////////////////////////////////////////////////////
~CXMLReader();
////////////////////////////////////////////////////////////////////////////////
/// \ingroup ParseFile
/// \~english @par Brief
/// This API parser file
/// \~english @param [IN] f_cFilePath
/// std::string - path of file to parse
/// \~english @retval eFrameworkunifiedStatusOK Success
/// \~english @retval eFrameworkunifiedStatusNullPointer Null pointer
/// \~english @par Prerequisite
/// - Load the shared library first.
/// - Create XmlReader object.
/// \~english @par Inside state change
/// - The API no inside state change
/// \~english @par None
/// \~english @par Classification
/// Public
/// \~english @par Type
/// Sync
/// \~english @par Detail
/// This API is used to parse the file from the path.
/// \~english @see CXMLReader or GetCXMLReaderObject
////////////////////////////////////////////////////////////////////////////////
EFrameworkunifiedStatus ParseFile(const std::string &f_cFilePath);
////////////////////////////////////////////////////////////////////////////////
/// \ingroup ParseFile
/// \~english @par Brief
/// Get Value with key
/// \~english @param [IN] f_cKey
/// std::string - key to search
/// \~english @retval std::string - value for key
/// \~english @par Prerequisite
/// - Load the shared library first.
/// - Create XmlReader object.
/// \~english @par Inside state change
/// - The API no inside state change
/// \~english @par None
/// \~english @par Classification
/// Public
/// \~english @par Type
/// Sync
/// \~english @par Detail
/// This function is used to get the value associated with the key
/// \~english @see CXMLReader or GetCXMLReaderObject
////////////////////////////////////////////////////////////////////////////////
std::string GetValue(const std::string &f_cKey);
////////////////////////////////////////////////////////////////////////////////
/// \ingroup ParseFile
/// \~english @par Brief
/// Get Value with key
/// \~english @param [IN] f_cKey
/// std::string - key to search
/// \~english @param [REF] f_cValue
/// std::string - Value of key
/// \~english @retval eFrameworkunifiedStatusOK Success / Pass / OK
/// \~english @retval eFrameworkunifiedStatusFail Failed
/// \~english @retval eFrameworkunifiedStatusInvldParam Invalid parameter
/// \~english @retval eFrameworkunifiedStatusNullPointer Null pointer
/// \~english @par Prerequisite
/// - Load the shared library first.
/// - Create XmlReader object.
/// \~english @par Inside state change
/// - The API no inside state change
/// \~english @par None
/// \~english @par Classification
/// Public
/// \~english @par Type
/// Sync
/// \~english @par Detail
/// This function is used to get the value associated with the key
/// \~english @see CXMLReader or GetCXMLReaderObject
////////////////////////////////////////////////////////////////////////////////
EFrameworkunifiedStatus GetValue(const std::string &f_cKey, std::string &f_cValue); // NOLINT (readability/nolint)
////////////////////////////////////////////////////////////////////////////////
/// \ingroup ParseFile
/// \~english @par Brief
/// Get Value with key
/// \~english @param None
/// \~english @retval PVOID - pointer of data structure
/// \~english @par Prerequisite
/// - Load the shared library first.
/// - Create XmlReader object.
/// \~english @par Inside state change
/// - The API no inside state change
/// \~english @par None
/// \~english @par Classification
/// Public
/// \~english @par Type
/// Sync
/// \~english @par Detail
/// This function is used to get the data pointer. This pointer is then set in config writer.
/// \~english @see CXMLReader or GetCXMLReaderObject
////////////////////////////////////////////////////////////////////////////////
PVOID GetDataPtr();
private:
////////////////////////////////////////////////////////////////////////////////////////////////
/// XMLGetValue
/// This function is used to parse and get the value from xml file
///
/// \param [IN] f_pCurrNode
/// xmlNodePtr - pointer to current node in xml
/// \param [IN] f_cUserKey
/// std::string - Key to be searched for
///
/// \return std::string - content of key node
///
////////////////////////////////////////////////////////////////////////////////////////////////
std::string XMLGetValue(xmlNodePtr f_pCurrNode, const std::string &f_cUserKey);
////////////////////////////////////////////////////////////////////////////////////////////////
/// XMLGetValue
/// This function is used to parse and get the value from xml file
///
/// \param [IN] f_pCurrNode
/// xmlNodePtr - pointer to current node in xml
/// \param [IN] f_cUserKey
/// std::string - Key to be searched for
/// \param [IN] f_cValue
/// std::string - Value of Key
/// \param [IN] f_bKeyFound
/// BOOL - flag to check whether key exists in xml file or not
///
/// \return EFrameworkunifiedStatus - error if key not found or else eFrameworkunifiedStatusOK
///
////////////////////////////////////////////////////////////////////////////////////////////////
EFrameworkunifiedStatus XMLGetValue(xmlNodePtr f_pCurrNode,
const std::string &f_cUserKey, std::string &f_cValue, BOOL &f_bKeyFound); // NOLINT (readability/nolint)
// pointer of xml document structure(DOM)
xmlDocPtr m_pXmlDoc;
};
#ifdef __cplusplus
extern "C" {
#endif
////////////////////////////////////////////////////////////////////////////////
/// \ingroup GetCXMLReaderObject
/// \~english @par Brief
/// Get CXMLReader object.
/// \~english @param [IN] f_cFilePath
/// std::string - path of file to parse
/// \~english @retval CXMLReader *
/// \~english @par Prerequisite
/// - Load the shared library first.
/// \~english @par Inside state change
/// - The API no inside state change
/// \~english @par None
/// \~english @par Classification
/// Public
/// \~english @par Type
/// Sync
/// \~english @par Detail
/// This API is used to create CXMLReader object with file path and return the CXMLReader pointer.
/// \~english @see None
////////////////////////////////////////////////////////////////////////////////
CXMLReader *GetCXMLReaderObject(CHAR *f_cFilePath);
#ifdef __cplusplus
}
#endif
#endif /* __FRAMEWORKUNIFIED_NATIVESERVICES_NSCONFIGPARSER_INC_NS_XML_READER_H__ */ // NOLINT (build/header_guard)
/** @}*/
/** @}*/
/** @}*/
/** @}*/
|
