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
|
/*
INI LIBRARY
Header file for comment object.
Copyright (C) Dmitri Pal <dpal@redhat.com> 2010
INI Library 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 3 of the License, or
(at your option) any later version.
INI Library 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 INI Library. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef INI_COMMENT_H
#define INI_COMMENT_H
#include <stdint.h>
#include <stdio.h>
#include "simplebuffer.h"
#ifndef EOK
#define EOK 0
#endif
struct ini_comment;
/**
* Create a comment object
*/
int ini_comment_create(struct ini_comment **ic);
/**
* Destroy the comment object
*/
void ini_comment_destroy(struct ini_comment *ic);
/**
* Build up a comment object - use this when reading
* comments from a file.
*/
int ini_comment_build(struct ini_comment *ic,
const char *line);
/**
* Build up a comment object - use this when reading
* comments from a file when length is known.
*/
int ini_comment_build_wl(struct ini_comment *ic,
const char *line,
uint32_t length);
/**
* Modify comment by instering a line.
*
* idx can be:
* 0 - as first
* 1 - after first
* 2 - after second
* ...
* If greater than number of lines
* missing lines are added automatically
* as empty lines
*/
int ini_comment_insert(struct ini_comment *ic,
uint32_t idx,
const char *line);
/**
* Modify comment by appending a line.
*/
int ini_comment_append(struct ini_comment *ic,
const char *line);
/**
* Remove line from the comment.
*/
int ini_comment_remove(struct ini_comment *ic,
uint32_t idx);
/**
* Clear line in the comment.
* Line is replaced with an empty line
*/
int ini_comment_clear(struct ini_comment *ic,
uint32_t idx);
/**
* Replace a line in the comment
*/
int ini_comment_replace(struct ini_comment *ic,
uint32_t idx,
const char *line);
/**
* Reset the comment - clean all lines.
*/
int ini_comment_reset(struct ini_comment *ic);
/**
* Get number of lines
*/
int ini_comment_get_numlines(struct ini_comment *ic,
uint32_t *num);
/**
* Get line
*/
int ini_comment_get_line(struct ini_comment *ic,
uint32_t idx,
char **line,
uint32_t *line_len);
/**
* Swap lines
*/
int ini_comment_swap(struct ini_comment *ic,
uint32_t idx1,
uint32_t idx2);
/**
* Create a copy of the comment object
*/
int ini_comment_copy(struct ini_comment *ic,
struct ini_comment **ic_copy);
/**
* Add one comment to another
*/
int ini_comment_add(struct ini_comment *ic_to_add,
struct ini_comment *ic);
/**
* Serialize comment
*/
int ini_comment_serialize(struct ini_comment *ic,
struct simplebuffer *sbobj);
/**
* Internal function to print comment
*/
void ini_comment_print(struct ini_comment *ic, FILE *file);
#endif
|
