summaryrefslogtreecommitdiff
path: root/src/components/config_profile/include/config_profile/ini_file.h
blob: f489872533bb69000f36206ff7b261a162157a76 (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
/*
 * Copyright (c) 2013, Ford Motor Company
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following
 * disclaimer in the documentation and/or other materials provided with the
 * distribution.
 *
 * Neither the name of the Ford Motor Company nor the names of its contributors
 * may be used to endorse or promote products derived from this software
 * without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef SRC_COMPONENTS_CONFIG_PROFILE_INCLUDE_CONFIG_PROFILE_INI_FILE_H_
#define SRC_COMPONENTS_CONFIG_PROFILE_INCLUDE_CONFIG_PROFILE_INI_FILE_H_

#include <stdint.h>
#include "utils/macro.h"

namespace profile {

#define INI_FILE_VER 1000

#if !defined TRUE
#define TRUE 1
#endif
#if !defined True
#define True 1
#endif

#if !defined FALSE
#define FALSE 0
#endif
#if !defined False
#define False 0
#endif

/*
 * @brief Global defines
 */
#define INI_LINE_LEN 1024
#define INI_FILE_TEMP_NAME "ini.tmp"

#define INI_FLAG_UPDATE 0x00
#define INI_FLAG_ITEM_UP_CREA 0x01
#define INI_FLAG_FILE_UP_CREA 0x10

/*
 * @brief Global typedefs
 */
typedef enum Ini_search_id_e {
  INI_NOTHING,
  INI_RIGHT_CHAPTER,
  INI_WRONG_CHAPTER,
  INI_RIGHT_ITEM,
  INI_WRONG_ITEM,
  INI_REMARK,

  INI_SEARCH_MAX
} Ini_search_id;

/*
 * @brief Prototypes of functions
 */
#ifdef __cplusplus
extern "C" {
#endif

/*
 * @brief Write usage instructions to the end of the file
 * @param
 *
 * \deprecated This method will be removed in the next major release
 * See Profile::ParseConfiguration for the new ini parsing code
 *
 * @return NULL if file or desired entry not found, otherwise pointer to fname
 */
DEPRECATED extern char* ini_write_inst(const char* fname, uint8_t flag);

/*
 * @brief Read a certain item of the specified chapter of a ini-file
 *
 * \deprecated This method will be removed in the next major release
 * See Profile::ParseConfiguration for the new ini parsing code
 *
 * @return NULL if file or desired entry not found, otherwise pointer to value
 */
DEPRECATED extern char* ini_read_value(const char* fname,
                                       const char* chapter,
                                       const char* item,
                                       char* value);

/*
 * @brief Write a certain item of the specified chapter of a ini-file
 *
 * \deprecated This method will be removed in the next major release
 * See Profile::ParseConfiguration for the new ini parsing code
 *
 * @return NULL if file not found, otherwise pointer to value
 */
DEPRECATED extern char ini_write_value(const char* fname,
                                       const char* chapter,
                                       const char* item,
                                       const char* value,
                                       uint8_t flag);

/*
 * @brief Parse the given line for the item and returns the value if
 *        there is one otherwise NULL
 *
 * \deprecated This method will be removed in the next major release
 * See Profile::ParseConfiguration for the new ini parsing code
 *
 * @return NULL if desired entry not found, otherwise pointer to value
 */
DEPRECATED extern Ini_search_id ini_parse_line(const char* line,
                                               const char* tag,
                                               char* value);

#ifdef __cplusplus
}
#endif

}  // namespace profile

#endif  // SRC_COMPONENTS_CONFIG_PROFILE_INCLUDE_CONFIG_PROFILE_INI_FILE_H_