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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 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 #include "oscap_export.h"
43 
48 OSCAP_API extern const char *const OSCAP_LANG_ENGLISH;
51 OSCAP_API extern const char *const OSCAP_LANG_ENGLISH_US;
53 OSCAP_API extern const char *const OSCAP_LANG_DEFAULT;
60 struct oscap_text;
61 
66 struct oscap_stringlist;
67 
74 OSCAP_API struct oscap_text *oscap_text_new(void);
75 
81 OSCAP_API struct oscap_text *oscap_text_clone(const struct oscap_text * text);
82 
89 OSCAP_API struct oscap_text *oscap_text_new_html(void);
90 
95 OSCAP_API void oscap_text_free(struct oscap_text *);
96 
97 /************************************************************/
105 OSCAP_API struct oscap_string_iterator *oscap_stringlist_get_strings(const struct oscap_stringlist* list);
108 OSCAP_API struct oscap_stringlist *oscap_stringlist_clone(struct oscap_stringlist *list);
109 
111 OSCAP_API const char *oscap_text_get_text(const struct oscap_text *text);
113 OSCAP_API const char *oscap_text_get_lang(const struct oscap_text *text);
119 OSCAP_API char *oscap_text_get_plaintext(const struct oscap_text *text);
120 
125 OSCAP_API bool oscap_text_get_is_html(const struct oscap_text *text);
130 OSCAP_API bool oscap_text_get_can_substitute(const struct oscap_text *text);
135 OSCAP_API bool oscap_text_get_can_override(const struct oscap_text *text);
140 OSCAP_API bool oscap_text_get_overrides(const struct oscap_text *text);
141 
142 /************************************************************/
145 /************************************************************/
157 OSCAP_API bool oscap_text_set_overrides(struct oscap_text *text, bool overrides);
158 
160 OSCAP_API bool oscap_text_set_text(struct oscap_text *text, const char * string);
162 OSCAP_API bool oscap_text_set_lang(struct oscap_text *text, const char *string);
163 
165 OSCAP_API bool oscap_stringlist_add_string(struct oscap_stringlist* list, const char *str);
167 OSCAP_API struct oscap_stringlist * oscap_stringlist_new(void);
169 OSCAP_API void oscap_stringlist_free(struct oscap_stringlist *list);
170 
171 
172 /************************************************************/
175 /************************************************************/
185 struct oscap_text_iterator;
187 OSCAP_API struct oscap_text *oscap_text_iterator_next(struct oscap_text_iterator *it);
189 OSCAP_API bool oscap_text_iterator_has_more(struct oscap_text_iterator *it);
191 OSCAP_API void oscap_text_iterator_free(struct oscap_text_iterator *it);
193 OSCAP_API void oscap_text_iterator_remove(struct oscap_text_iterator *it);
195 OSCAP_API void oscap_text_iterator_reset(struct oscap_text_iterator *it);
196 
204 struct oscap_string_iterator;
206 OSCAP_API const char *oscap_string_iterator_next(struct oscap_string_iterator *it);
208 OSCAP_API bool oscap_string_iterator_has_more(struct oscap_string_iterator *it);
210 OSCAP_API void oscap_string_iterator_free(struct oscap_string_iterator *it);
212 OSCAP_API void oscap_string_iterator_remove(struct oscap_string_iterator *it);
214 OSCAP_API void oscap_string_iterator_reset(struct oscap_string_iterator *it);
215 
232 
233 /************************************************************/
248 OSCAP_API char* oscap_textlist_get_preferred_plaintext(struct oscap_text_iterator* texts, const char* preferred_lang);
249 
256 OSCAP_API struct oscap_text *oscap_textlist_get_preferred_text(struct oscap_text_iterator *texts, const char *preferred_lang);
257 
258 
261 #endif
262 
OSCAP_API struct oscap_string_iterator * oscap_stringlist_get_strings(const struct oscap_stringlist *list)
Definition: list.c:348
Iterator over collections of strings.
OSCAP_API void oscap_text_iterator_free(struct oscap_text_iterator *it)
OSCAP_API bool oscap_text_set_text(struct oscap_text *text, const char *string)
OSCAP_API const char *const OSCAP_LANG_ENGLISH_US
American English.
Definition: text.c:44
OSCAP_API struct oscap_stringlist * oscap_stringlist_iterator_next(struct oscap_stringlist_iterator *it)
A collection of strings.
Definition: oscap_text.h:60
OSCAP_API bool oscap_text_iterator_has_more(struct oscap_text_iterator *it)
OSCAP_API const char * oscap_text_get_text(const struct oscap_text *text)
OSCAP_API void oscap_string_iterator_remove(struct oscap_string_iterator *it)
OSCAP_API const char *const OSCAP_LANG_DEFAULT
Default language (i.e. American English)
Definition: text.c:45
OSCAP_API bool oscap_text_get_overrides(const struct oscap_text *text)
Does this text override parent content?
OSCAP_API bool oscap_text_set_overrides(struct oscap_text *text, bool overrides)
Set whether this text overrides parent content.
Definition: text.c:62
OSCAP_API void oscap_stringlist_free(struct oscap_stringlist *list)
Definition: list.c:363
OSCAP_API struct oscap_text * oscap_text_clone(const struct oscap_text *text)
Clone an internationalized text field.
Definition: text.c:92
OSCAP_API struct oscap_text * oscap_textlist_get_preferred_text(struct oscap_text_iterator *texts, const char *preferred_lang)
gets oscap_text representing given textlist
Definition: text.c:219
OSCAP_API bool oscap_text_set_lang(struct oscap_text *text, const char *string)
OSCAP_API void oscap_text_iterator_remove(struct oscap_text_iterator *it)
OSCAP_API void oscap_text_iterator_reset(struct oscap_text_iterator *it)
Internationalized string iterator.
OSCAP_API struct oscap_text * oscap_text_new_html(void)
Create an internationalized text field with HTML content.
Definition: text.c:97
OSCAP_API char * oscap_text_get_plaintext(const struct oscap_text *text)
Get plaintext representation of the text.
Definition: text.c:200
OSCAP_API bool oscap_text_get_is_html(const struct oscap_text *text)
Does this text posses a HTML content?
OSCAP_API bool oscap_string_iterator_has_more(struct oscap_string_iterator *it)
OSCAP_API void oscap_text_free(struct oscap_text *)
Release an internationalized text field.
Definition: text.c:68
OSCAP_API void oscap_stringlist_iterator_remove(struct oscap_stringlist_iterator *it)
OSCAP_API char * oscap_textlist_get_preferred_plaintext(struct oscap_text_iterator *texts, const char *preferred_lang)
gets a plaintext string representing given textlist
Definition: text.c:253
OSCAP_API void oscap_string_iterator_reset(struct oscap_string_iterator *it)
OSCAP_API const char *const OSCAP_LANG_ENGLISH
English.
Definition: text.c:43
Representation of internationalizable character strings.
Definition: text_priv.h:46
String iterator.
OSCAP_API void oscap_stringlist_iterator_free(struct oscap_stringlist_iterator *it)
OSCAP_API bool oscap_stringlist_iterator_has_more(struct oscap_stringlist_iterator *it)
OSCAP_API bool oscap_stringlist_add_string(struct oscap_stringlist *list, const char *str)
Definition: list.c:353
OSCAP_API struct oscap_text * oscap_text_iterator_next(struct oscap_text_iterator *it)
OSCAP_API bool oscap_text_get_can_substitute(const struct oscap_text *text)
Can this text contain substitutions?
OSCAP_API void oscap_string_iterator_free(struct oscap_string_iterator *it)
OSCAP_API struct oscap_stringlist * oscap_stringlist_clone(struct oscap_stringlist *list)
Definition: list.c:340
OSCAP_API void oscap_stringlist_iterator_reset(struct oscap_stringlist_iterator *it)
OSCAP_API const char * oscap_string_iterator_next(struct oscap_string_iterator *it)
OSCAP_API struct oscap_text * oscap_text_new(void)
Create an internationalized text field.
Definition: text.c:87
OSCAP_API bool oscap_text_get_can_override(const struct oscap_text *text)
Can this text override parent content?
OSCAP_API struct oscap_stringlist * oscap_stringlist_new(void)
Definition: list.c:358
OSCAP_API const char * oscap_text_get_lang(const struct oscap_text *text)