blob: d47c04b10303daa6f4b84bcc45b8fe2f694606c9 (
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
|
/*
* @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 CCFGReader.
///
////////////////////////////////////////////////////////////////////////////////////////////////////
#ifndef FRAMEWORK_UNIFIED_CLIENT_NS_CONFIGPARSER_INCLUDE_NS_CFG_READER_H_
#define FRAMEWORK_UNIFIED_CLIENT_NS_CONFIGPARSER_INCLUDE_NS_CFG_READER_H_
////////////////////////////////////////////////////////////////////////////////////////////////////
// Include Files
////////////////////////////////////////////////////////////////////////////////////////////////////
#include <native_service/ns_reader.h>
#include <string>
class CCFGParser;
/*
* This class provides functionalities to read from CFG config file
*/
class CCFGReader: public IConfigReader {
public:
////////////////////////////////////////////////////////////////////////////////////////////////
/// CCFGReader
/// Constructor of CCFGReader class
///
/// \param
///
/// \return
///
////////////////////////////////////////////////////////////////////////////////////////////////
CCFGReader();
////////////////////////////////////////////////////////////////////////////////////////////////
/// CCFGReader
/// Constructor of CCFGReader class
///
/// \param [IN] f_c_filepath
/// std::string - Full path of the configuration file
///
/// \return
///
////////////////////////////////////////////////////////////////////////////////////////////////
explicit CCFGReader(const std::string &f_c_filepath);
////////////////////////////////////////////////////////////////////////////////////////////////
/// ~CCFGReader
/// Destructor of CCFGReader class
///
/// \param
///
/// \return
///
////////////////////////////////////////////////////////////////////////////////////////////////
~CCFGReader();
////////////////////////////////////////////////////////////////////////////////////////////////
/// ParseFile
/// This function is used to parse the file
///
/// \param [IN] f_c_filepath
/// std::string - path of file to parse
///
/// \return EFrameworkunifiedStatus - success or failure
///
////////////////////////////////////////////////////////////////////////////////////////////////
EFrameworkunifiedStatus ParseFile(const std::string &f_c_filepath);
////////////////////////////////////////////////////////////////////////////////////////////////
/// GetString
/// This function is used to get the value associated with the key
///
/// \param [IN] f_c_key
/// std::string - key to search
///
/// \return std::string - value for key
///
////////////////////////////////////////////////////////////////////////////////////////////////
std::string GetValue(const std::string &f_c_key);
////////////////////////////////////////////////////////////////////////////////////////////////
/// GetString
/// This function is used to get the value associated with the key
///
/// \param [IN] f_c_key
/// std::string - key to search
/// \param [REF] f_c_value
/// std::string - Value of key
///
/// \return EFrameworkunifiedStatus
/// EFrameworkunifiedStatus - error if key not found else eFrameworkunifiedStatusOK
///
////////////////////////////////////////////////////////////////////////////////////////////////
EFrameworkunifiedStatus GetValue(const std::string &f_c_key, std::string &f_c_value); // NOLINT (readability/nolint)
////////////////////////////////////////////////////////////////////////////////////////////////
/// GetDataPtr
/// This function is used to get the data pointer. This pointer is then set in config writer.
/// This is needed to avoid recreation of same data structure object in both reader and writer
/// when we create object of NSConfigParser.
///
/// \param
///
/// \return PVOID - pointer of data structure
///
////////////////////////////////////////////////////////////////////////////////////////////////
PVOID GetDataPtr();
private:
// path of config file
std::string m_cFilePath;
// CFG file parser object
CCFGParser *m_pCFGParser;
};
#endif // FRAMEWORK_UNIFIED_CLIENT_NS_CONFIGPARSER_INCLUDE_NS_CFG_READER_H_
|
