Open SCAP Library
cpe_lang.h
Go to the documentation of this file.
1 
13 /*
14  * Copyright 2009 Red Hat Inc., Durham, North Carolina.
15  * All Rights Reserved.
16  *
17  * This library is free software; you can redistribute it and/or
18  * modify it under the terms of the GNU Lesser General Public
19  * License as published by the Free Software Foundation; either
20  * version 2.1 of the License, or (at your option) any later version.
21  *
22  * This library is distributed in the hope that it will be useful,
23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
25  * Lesser General Public License for more details.
26  *
27  * You should have received a copy of the GNU Lesser General Public
28  * License along with this library; if not, write to the Free Software
29  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30  *
31  * Authors:
32  * Lukas Kuklinek <lkuklinek@redhat.com>
33  * Maros Barabas <mbarabas@redhat.com>
34  */
35 
36 #ifndef CPELANG_H_
37 #define CPELANG_H_
38 
39 #include <stdlib.h>
40 
41 #include "cpe_name.h"
42 #include "oscap_text.h"
43 
47 typedef enum {
53 
56 
57  CPE_LANG_OPER_NAND = CPE_LANG_OPER_AND | CPE_LANG_OPER_NOT,
58  CPE_LANG_OPER_NOR = CPE_LANG_OPER_OR | CPE_LANG_OPER_NOT,
60 
65 struct cpe_lang_model;
66 
71 struct cpe_platform;
72 
77 struct cpe_testexpr;
78 
79 
80 /************************************************************/
92 
99 
105 struct cpe_testexpr_iterator;
112 
113 /************************************************************/
116 /************************************************************/
129 
136 
142 const struct cpe_name *cpe_testexpr_get_meta_cpe(const struct cpe_testexpr *item);
143 
149 const char* cpe_testexpr_get_meta_check_system(const struct cpe_testexpr *item);
150 
156 const char* cpe_testexpr_get_meta_check_href(const struct cpe_testexpr *item);
157 
163 const char* cpe_testexpr_get_meta_check_id(const struct cpe_testexpr *item);
164 
170 const struct cpe_testexpr *cpe_testexpr_get_next(const struct cpe_testexpr *expr);
171 
177 
182 struct cpe_platform *cpe_lang_model_get_item(const struct cpe_lang_model *item, const char *key);
183 
192 bool cpe_platform_applicable_lang_model(const char* platform, struct cpe_lang_model *lang_model, cpe_check_fn check_cb, cpe_dict_fn dict_cb, void* usr);
193 
198 const char *cpe_platform_get_id(const struct cpe_platform *item);
203 const char *cpe_platform_get_remark(const struct cpe_platform *item);
208 struct oscap_text_iterator *cpe_platform_get_titles(const struct cpe_platform *item);
213 const struct cpe_testexpr *cpe_platform_get_expr(const struct cpe_platform *item);
214 
215 /************************************************************/
218 /************************************************************/
230 bool cpe_lang_model_add_platform(struct cpe_lang_model *lang, struct cpe_platform *platform);
235 bool cpe_platform_add_title(struct cpe_platform *platform, struct oscap_text *title);
236 
241 /*bool cpe_lang_model_add_xmlns(struct cpe_lang_model * model, struct xml_metadata * xml);*/
242 
250 
255 bool cpe_platform_set_id(struct cpe_platform *platform, const char *new_id);
260 bool cpe_platform_set_remark(struct cpe_platform *platform, const char *new_remark);
267 bool cpe_platform_set_expr(struct cpe_platform *platform, struct cpe_testexpr *expr);
275 
283 bool cpe_testexpr_set_name(struct cpe_testexpr *expr, struct cpe_name *name);
284 
285 /************************************************************/
288 void cpe_platform_iterator_remove(struct cpe_platform_iterator *it, struct cpe_lang_model *parent);
292 
297 struct cpe_lang_model *cpe_lang_model_new(void);
298 
303 struct cpe_testexpr *cpe_testexpr_new(void);
304 
309 struct cpe_platform *cpe_platform_new(void);
310 
316 struct cpe_testexpr * cpe_testexpr_clone(struct cpe_testexpr * old_expr);
317 
322 void cpe_testexpr_free(struct cpe_testexpr *expr);
323 
329 
334 void cpe_lang_model_free(struct cpe_lang_model *platformspec);
335 
340 void cpe_platform_free(struct cpe_platform *platform);
341 
342 /************************************************************/
353 const char * cpe_lang_model_supported(void);
354 
359 char * cpe_lang_model_detect_version(const char* file);
360 
368 bool cpe_platform_match_cpe(struct cpe_name **cpe, size_t n, const struct cpe_platform *platform);
369 
370 /************************************************************/
377 struct cpe_lang_model *cpe_lang_model_import(const char *file);
378 
384 bool cpe_lang_model_set_origin_file(struct cpe_lang_model* lang_model, const char* origin_file);
385 
393 const char* cpe_lang_model_get_origin_file(const struct cpe_lang_model* lang_model);
394 
401 void cpe_lang_model_export(const struct cpe_lang_model *spec, const char *file);
402 
407 #endif /* _CPELANG_H_ */
bool cpe_platform_applicable_lang_model(const char *platform, struct cpe_lang_model *lang_model, cpe_check_fn check_cb, cpe_dict_fn dict_cb, void *usr)
Verify whether given CPE platform idref is applicable by evaluating test expression associated with i...
Definition: cpelang.c:186
bool *(* cpe_dict_fn)(const struct cpe_name *, void *)
Shared callback definition used to match CPE names to perform applicability tests.
Definition: cpe_name.h:371
const char * cpe_lang_model_get_origin_file(const struct cpe_lang_model *lang_model)
Gets the file the CPE dict model was loaded from.
Definition: cpelang_priv.c:801
CPE platform specification.
Definition: cpelang_priv.c:61
void cpe_testexpr_free(struct cpe_testexpr *expr)
Free function of CPE test expression.
Definition: cpelang_priv.c:672
const char * cpe_platform_get_remark(const struct cpe_platform *item)
cpe_platform functions to get remark
cpe_lang_oper_t
CPE language operators.
Definition: cpe_lang.h:47
struct cpe_platform * cpe_platform_new(void)
Constructor of CPE Platform.
Definition: cpelang_priv.c:191
bool cpe_platform_iterator_has_more(struct cpe_platform_iterator *it)
struct cpe_platform_iterator * cpe_lang_model_get_platforms(const struct cpe_lang_model *item)
cpe_lang_model function to get CPE platforms
bool cpe_lang_model_set_origin_file(struct cpe_lang_model *lang_model, const char *origin_file)
Sets the origin file hint.
Definition: cpelang_priv.c:793
bool cpe_platform_set_expr(struct cpe_platform *platform, struct cpe_testexpr *expr)
Set evaluation expression for this CPE platform.
Definition: cpelang_priv.c:781
const char * cpe_testexpr_get_meta_check_href(const struct cpe_testexpr *item)
Get check href to evaluate Only valid for CPE_LANG_OPER_CHECK.
Definition: cpelang_priv.c:714
bool cpe_testexpr_add_subexpression(struct cpe_testexpr *expr, struct cpe_testexpr *sub)
Add XML namespace to CPE lang model.
Definition: cpelang_priv.c:751
bool cpe_platform_add_title(struct cpe_platform *platform, struct oscap_text *title)
Add title to platform.
struct cpe_lang_model * cpe_lang_model_new(void)
Constructor of CPE Language model.
Definition: cpelang_priv.c:175
const struct cpe_testexpr * cpe_platform_get_expr(const struct cpe_platform *item)
cpe_platform functions to get test expression
cpe_lang_oper_t oper
operator
Definition: cpelang_priv.h:53
struct cpe_name * cpe
CPE for match operation.
Definition: cpelang_priv.h:56
void cpe_platform_iterator_remove(struct cpe_platform_iterator *it, struct cpe_lang_model *parent)
Definition: cpelang_priv.c:772
Interface to Common Platform Enumeration (CPE) URI.
struct cpe_platform * cpe_platform_iterator_next(struct cpe_platform_iterator *it)
char * cpe_lang_model_detect_version(const char *file)
Detect version of given CPE language XML.
Definition: cpelang.c:126
const char * cpe_lang_model_supported(void)
Get supported version of CPE language XML.
Definition: cpelang.c:121
struct cpe_testexpr_iterator * cpe_testexpr_get_meta_expr(const struct cpe_testexpr *item)
Get CPE expression subexpression.
Definition: cpelang_priv.c:690
bool cpe_testexpr_set_oper(struct cpe_testexpr *expr, cpe_lang_oper_t oper)
Set CPE operation.
Definition: cpelang_priv.c:730
negate
Definition: cpe_lang.h:55
Internationalized string iterator.
Iterator over CPE dictionary items.
bool cpe_testexpr_iterator_has_more(struct cpe_testexpr_iterator *it)
bool *(* cpe_check_fn)(const char *, const char *, const char *, void *)
Shared callback definition used to evaluate checks to perform applicability tests.
Definition: cpe_name.h:362
bool cpe_testexpr_set_name(struct cpe_testexpr *expr, struct cpe_name *name)
Set CPE name.
Definition: cpelang_priv.c:739
const char * cpe_testexpr_get_meta_check_system(const struct cpe_testexpr *item)
Get check system to evaluate Only valid for CPE_LANG_OPER_CHECK.
Definition: cpelang_priv.c:706
const struct cpe_name * cpe_testexpr_get_meta_cpe(const struct cpe_testexpr *item)
Get CPE name to match against.
Definition: cpelang_priv.c:698
bool cpe_lang_model_add_platform(struct cpe_lang_model *lang, struct cpe_platform *platform)
Add platform to CPE lang model.
Definition: cpelang_priv.c:763
struct oscap_list * expr
array of subexpressions for operators
Definition: cpelang_priv.h:55
fact-ref = match given CPE name against available dictionaries
Definition: cpe_lang.h:51
bool cpe_platform_set_remark(struct cpe_platform *platform, const char *new_remark)
Set remark of CPE platform.
struct cpe_testexpr * cpe_testexpr_clone(struct cpe_testexpr *old_expr)
Clone CPE test expression.
Definition: cpelang_priv.c:150
Multilingual text processing interface.
struct cpe_testexpr * cpe_testexpr_iterator_next(struct cpe_testexpr_iterator *it)
bool cpe_platform_set_id(struct cpe_platform *platform, const char *new_id)
Set ID of CPE platform.
cpe_lang_oper_t cpe_testexpr_get_oper(const struct cpe_testexpr *item)
cpe_testexpr functions to get variable members
const struct cpe_testexpr * cpe_testexpr_get_next(const struct cpe_testexpr *expr)
Function to get next expr from array.
Definition: cpelang_priv.c:122
logical OR
Definition: cpe_lang.h:50
void cpe_testexpr_iterator_reset(struct cpe_testexpr_iterator *it)
Reset function of CPE test expression.
void cpe_lang_model_export(const struct cpe_lang_model *spec, const char *file)
Write the lang_model to a file.
Definition: cpelang.c:62
void cpe_platform_free(struct cpe_platform *platform)
Free function of CPE Platform.
Definition: cpelang_priv.c:633
Structure holding Common Platform Enumeration URI data.
Definition: cpename.c:68
CPE language boolean expression.
Definition: cpelang_priv.h:52
Representation of internationalizable character strings.
Definition: text_priv.h:47
void cpe_platform_iterator_reset(struct cpe_platform_iterator *it)
void cpe_testexpr_iterator_free(struct cpe_testexpr_iterator *it)
invalid or unknown operation
Definition: cpe_lang.h:48
struct cpe_lang_model * cpe_lang_model_import(const char *file)
Load CPE language model from a XML document.
Definition: cpelang.c:45
Single platform representation in CPE language.
Definition: cpelang_priv.c:71
void cpe_platform_iterator_free(struct cpe_platform_iterator *it)
struct cpe_platform * cpe_lang_model_get_item(const struct cpe_lang_model *item, const char *key)
cpe_lang_model function to get CPE platforms
const char * cpe_testexpr_get_meta_check_id(const struct cpe_testexpr *item)
Get check idref to evaluate Only valid for CPE_LANG_OPER_CHECK.
Definition: cpelang_priv.c:722
bool cpe_platform_match_cpe(struct cpe_name **cpe, size_t n, const struct cpe_platform *platform)
Function to match cpe in platform.
Definition: cpelang.c:116
logical AND
Definition: cpe_lang.h:49
Iterator over CPE language expressions.
struct cpe_testexpr * cpe_testexpr_new(void)
Constructor of CPE test expression.
Definition: cpelang_priv.c:136
void cpe_lang_model_free(struct cpe_lang_model *platformspec)
Free function of CPE test expression.
Definition: cpelang_priv.c:621
mask to extract the operator w/o possible negation
Definition: cpe_lang.h:54
const char * cpe_platform_get_id(const struct cpe_platform *item)
cpe_platform functions to get id
check-ref = evaluate given check
Definition: cpe_lang.h:52
struct oscap_text_iterator * cpe_platform_get_titles(const struct cpe_platform *item)
cpe_platform functions to get titles