libini_config  0.2.91
 All Data Structures Functions Groups Pages
ini_comment.h
1 /*
2  INI LIBRARY
3 
4  Header file for comment object.
5 
6  Copyright (C) Dmitri Pal <dpal@redhat.com> 2010
7 
8  INI Library is free software: you can redistribute it and/or modify
9  it under the terms of the GNU Lesser General Public License as published by
10  the Free Software Foundation, either version 3 of the License, or
11  (at your option) any later version.
12 
13  INI Library is distributed in the hope that it will be useful,
14  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  GNU Lesser General Public License for more details.
17 
18  You should have received a copy of the GNU Lesser General Public License
19  along with INI Library. If not, see <http://www.gnu.org/licenses/>.
20 */
21 
22 #ifndef INI_COMMENT_H
23 #define INI_COMMENT_H
24 
25 #include <stdint.h>
26 #include <stdio.h>
27 
28 #ifndef EOK
29 #define EOK 0
30 #endif
31 
32 struct ini_comment;
33 
37 int ini_comment_create(struct ini_comment **ic);
38 
42 void ini_comment_destroy(struct ini_comment *ic);
43 
48 int ini_comment_build(struct ini_comment *ic,
49  const char *line);
50 
55 int ini_comment_build_wl(struct ini_comment *ic,
56  const char *line,
57  uint32_t length);
58 
71 int ini_comment_insert(struct ini_comment *ic,
72  uint32_t idx,
73  const char *line);
74 
78 int ini_comment_append(struct ini_comment *ic,
79  const char *line);
80 
84 int ini_comment_remove(struct ini_comment *ic,
85  uint32_t idx);
86 
91 int ini_comment_clear(struct ini_comment *ic,
92  uint32_t idx);
93 
97 int ini_comment_replace(struct ini_comment *ic,
98  uint32_t idx,
99  const char *line);
100 
104 int ini_comment_reset(struct ini_comment *ic);
105 
109 int ini_comment_get_numlines(struct ini_comment *ic,
110  uint32_t *num);
111 
115 int ini_comment_get_line(struct ini_comment *ic,
116  uint32_t idx,
117  char **line,
118  uint32_t *line_len);
119 
123 int ini_comment_swap(struct ini_comment *ic,
124  uint32_t idx1,
125  uint32_t idx2);
126 
130 int ini_comment_copy(struct ini_comment *ic,
131  struct ini_comment **ic_copy);
132 
136 void ini_comment_print(struct ini_comment *ic, FILE *file);
137 
138 
139 #endif