Open SCAP Library
oscap_text.h
Go to the documentation of this file.
1 /*
2  * Copyright 2009 Red Hat Inc., Durham, North Carolina.
3  * All Rights Reserved.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this library; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18  *
19  * Authors:
20  * "David Niemoller" <David.Niemoller@g2-inc.com>
21  * Lukas Kuklinek <lkuklinek@redhat.com>
22  */
23 
37 #pragma once
38 #ifndef OSCAP_TEXT_H_
39 #define OSCAP_TEXT_H_
40 
41 #include <stdbool.h>
42 
47 
48 extern const char * const OSCAP_LANG_ENGLISH;
50 extern const char * const OSCAP_LANG_ENGLISH_US;
52 extern const char * const OSCAP_LANG_DEFAULT;
59 struct oscap_text;
60 
65 struct oscap_stringlist;
66 
73 struct oscap_text *oscap_text_new(void);
74 
80 struct oscap_text *oscap_text_clone(const struct oscap_text * text);
81 
88 struct oscap_text *oscap_text_new_html(void);
89 
94 void oscap_text_free(struct oscap_text *);
95 
96 /************************************************************/
104 
108 
110 const char *oscap_text_get_text(const struct oscap_text *text);
112 const char *oscap_text_get_lang(const struct oscap_text *text);
118 char *oscap_text_get_plaintext(const struct oscap_text *text);
119 
124 bool oscap_text_get_is_html(const struct oscap_text *text);
129 bool oscap_text_get_can_substitute(const struct oscap_text *text);
134 bool oscap_text_get_can_override(const struct oscap_text *text);
139 bool oscap_text_get_overrides(const struct oscap_text *text);
140 
141 /************************************************************/
144 /************************************************************/
156 bool oscap_text_set_overrides(struct oscap_text *text, bool overrides);
157 
159 bool oscap_text_set_text(struct oscap_text *text, const char * string);
161 bool oscap_text_set_lang(struct oscap_text *text, const char *string);
162 
164 bool oscap_stringlist_add_string(struct oscap_stringlist* list, const char *str);
168 void oscap_stringlist_free(struct oscap_stringlist *list);
169 
170 
171 /************************************************************/
174 /************************************************************/
184 struct oscap_text_iterator;
195 
203 struct oscap_string_iterator;
205 const char *oscap_string_iterator_next(struct oscap_string_iterator *it);
214 
231 
232 /************************************************************/
247 char* oscap_textlist_get_preferred_plaintext(struct oscap_text_iterator* texts, const char* preferred_lang);
248 
251 #endif
252