CPE Language
[CPE]

Data Structures

struct  cpe_testexpr
 CPE language boolean expression. More...
struct  cpe_lang_model
 CPE platform specification. More...
struct  cpe_platform
 Single platform representation in CPE language. More...
struct  cpe_platform_iterator
 Iterator over CPE dictionary items. More...

Files

file  cpelang_priv.h
 

Interface to Common Platform Enumeration (CPE) Language.


file  cpelang.h
 

Interface to Common Platform Enumeration (CPE) Language.


Enumerations

enum  cpe_lang_oper_t {
  CPE_LANG_OPER_HALT = 0x00, CPE_LANG_OPER_AND = 0x01, CPE_LANG_OPER_OR = 0x02, CPE_LANG_OPER_MATCH = 0x04,
  CPE_LANG_OPER_MASK = 0xFF, CPE_LANG_OPER_NOT = 0x100, CPE_LANG_OPER_NAND = CPE_LANG_OPER_AND | CPE_LANG_OPER_NOT, CPE_LANG_OPER_NOR = CPE_LANG_OPER_OR | CPE_LANG_OPER_NOT
}
 

CPE language operators.

More...

Functions

bool cpe_platform_match_cpe (struct cpe_name **cpe, size_t n, const struct cpe_platform *platform)
 Function to match cpe in platform.
bool cpe_platform_set_remark (struct cpe_platform *platform, const char *new_remark)
struct cpe_lang_modelcpe_lang_model::cpe_lang_model_parse_xml (const struct oscap_import_source *source)
 Function for parsing XML CPE language file.
struct cpe_lang_modelcpe_lang_model::cpe_lang_model_parse (xmlTextReaderPtr reader)
 Parse function for CPE Lang model.
struct cpe_platformcpe_platform::cpe_platform_parse (xmlTextReaderPtr reader)
 Parse CPE platform structure.
struct cpe_testexprcpe_testexpr::cpe_testexpr_parse (xmlTextReaderPtr reader)
 Parse CPE test expression structure.
void cpe_lang_model::cpe_lang_model_export_xml (struct cpe_lang_model *spec, struct oscap_export_target *target)
 Function for export CPE language model to XML.
void cpe_lang_model::cpe_lang_export (const struct cpe_lang_model *spec, xmlTextWriterPtr writer)
 Function for export CPE language top element.
void cpe_platform::cpe_platform_export (const struct cpe_platform *platform, xmlTextWriterPtr writer)
 Function for export CPE platform element.
void cpe_testexpr::cpe_testexpr_export (const struct cpe_testexpr expr, xmlTextWriterPtr writer)
 Function for export CPE test expression element.
struct cpe_platformcpe_platform_iterator::cpe_platform_iterator_next (struct cpe_platform_iterator *it)
bool cpe_platform_iterator::cpe_platform_iterator_has_more (struct cpe_platform_iterator *it)
void cpe_platform_iterator::cpe_platform_iterator_free (struct cpe_platform_iterator *it)
struct cpe_lang_modelcpe_lang_model::cpe_lang_model_import (const struct oscap_import_source *source)
 Load CPE language model from a XML document.
void cpe_lang_model::cpe_lang_model_export (struct cpe_lang_model *spec, struct oscap_export_target *target)
 Write the lang_model to a file.
cpe_lang_oper_t cpe_testexpr::cpe_testexpr_get_oper (const struct cpe_testexpr *item)
 cpe_testexpr functions to get variable members
struct cpe_testexprcpe_testexpr::cpe_testexpr_get_meta_expr (const struct cpe_testexpr *item)
 Get CPE expression subexpression.
struct cpe_namecpe_testexpr::cpe_testexpr_get_meta_cpe (const struct cpe_testexpr *item)
 Get CPE name to match against.
const char * cpe_platform::cpe_platform_get_id (const struct cpe_platform *item)
 cpe_platform functions to get variable members
const char * cpe_platform::cpe_platform_get_remark (const struct cpe_platform *item)
struct oscap_title_iteratorcpe_platform::cpe_platform_get_titles (const struct cpe_platform *item)
struct cpe_testexprcpe_platform::cpe_platform_get_expr (const struct cpe_platform *item)
const char * cpe_lang_model::cpe_lang_model_get_ns_href (const struct cpe_lang_model *item)
 cpe_lang_model function to get namespace href
const char * cpe_lang_model::cpe_lang_model_get_ns_prefix (const struct cpe_lang_model *item)
 cpe_lang_model function to get namespace prefix
struct cpe_platform_iteratorcpe_lang_model::cpe_lang_model_get_platforms (const struct cpe_lang_model *item)
 cpe_lang_model function to get CPE platforms
struct cpe_platformcpe_lang_model::cpe_lang_model_get_item (const struct cpe_lang_model *item, const char *key)
 cpe_lang_model function to get CPE items
bool cpe_lang_model::cpe_lang_model_add_item (struct cpe_lang_model *lang, struct cpe_platform *platform)
 Add platform to CPE lang model.
struct cpe_lang_modelcpe_lang_model::cpe_lang_model_new (void)
 Constructor of CPE Language model.
struct cpe_testexprcpe_testexpr::cpe_testexpr_new (void)
 Constructor of CPE test expression.
struct cpe_platformcpe_platform::cpe_platform_new (void)
 Constructor of CPE Platform.
void cpe_testexpr::cpe_testexpr_free (struct cpe_testexpr *expr)
 Free function of CPE test expression.
void cpe_lang_model::cpe_lang_model_free (struct cpe_lang_model *platformspec)
 Free function of CPE test expression.
void cpe_platform::cpe_platform_free (struct cpe_platform *platform)
 Free function of CPE Platform.
struct cpe_testexprcpe_testexpr::cpe_testexpr_get_next (const struct cpe_testexpr *expr)
 Function to get next expr from array.
bool cpe_lang_model::cpe_lang_model_set_ns_href (struct cpe_lang_model *model, const char *new_href)
 Set / add functions.
bool cpe_lang_model::cpe_lang_model_set_ns_prefix (struct cpe_lang_model *model, const char *new_prefix)
bool cpe_platform::cpe_platform_set_id (struct cpe_platform *platform, const char *new_id)
bool cpe_platform::cpe_platform_add_title (struct cpe_platform *platform, struct oscap_title *title)

Variables

 OSCAP_HIDDEN_START
cpe_lang_oper_t cpe_testexpr::oper
struct cpe_name *   cpe_testexpr::@0::cpe
union {
   struct cpe_testexpr *   expr
   struct cpe_name *   cpe
cpe_testexpr::meta
 OSCAP_HIDDEN_END

Enumeration Type Documentation

CPE language operators.

Enumerator:
CPE_LANG_OPER_HALT 

end of instruction list

CPE_LANG_OPER_AND 

logical AND

CPE_LANG_OPER_OR 

logical OR

CPE_LANG_OPER_MATCH 

match against specified CPE

CPE_LANG_OPER_MASK 

mask to extract the operator w/o possible negation

CPE_LANG_OPER_NOT 

negate


Function Documentation

void cpe_lang_export ( const struct cpe_lang_model spec,
xmlTextWriterPtr  writer 
) [related, inherited]

Function for export CPE language top element.

Parameters:
writer xmlTextWriterPtr structure representing XML model
spec CPE language model structure
bool cpe_lang_model_add_item ( struct cpe_lang_model lang,
struct cpe_platform platform 
) [related, inherited]

Add platform to CPE lang model.

void cpe_lang_model_export ( struct cpe_lang_model spec,
struct oscap_export_target target 
) [related, inherited]

Write the lang_model to a file.

Parameters:
spec CPE lang model
target target structure with filename, endcoding and indent information
void cpe_lang_model_export_xml ( struct cpe_lang_model spec,
struct oscap_export_target target 
) [related, inherited]

Function for export CPE language model to XML.

Parameters:
target structure with exporting information such filename and encoding
spec CPE language model structure
struct cpe_lang_model * cpe_lang_model_parse ( xmlTextReaderPtr  reader  )  [related, inherited]

Parse function for CPE Lang model.

Parameters:
reader xmlTextReaderPtr structure representing XML model
struct cpe_lang_model * cpe_lang_model_parse_xml ( const struct oscap_import_source source  )  [related, inherited]

Function for parsing XML CPE language file.

Parameters:
source structure of import source with filename and encoding
bool cpe_lang_model_set_ns_href ( struct cpe_lang_model model,
const char *  new_href 
) [related, inherited]

Set / add functions.

bool cpe_lang_model_set_ns_prefix ( struct cpe_lang_model model,
const char *  new_prefix 
) [related, inherited]
bool cpe_platform_add_title ( struct cpe_platform platform,
struct oscap_title title 
) [related, inherited]
void cpe_platform_export ( const struct cpe_platform platform,
xmlTextWriterPtr  writer 
) [related, inherited]

Function for export CPE platform element.

Parameters:
writer xmlTextWriterPtr structure representing XML model
platform CPE platform structure
struct cpe_testexpr * cpe_platform_get_expr ( const struct cpe_platform item  )  [related, inherited]
const char * cpe_platform_get_id ( const struct cpe_platform item  )  [related, inherited]

cpe_platform functions to get variable members

const char * cpe_platform_get_remark ( const struct cpe_platform item  )  [related, inherited]
struct oscap_title_iterator * cpe_platform_get_titles ( const struct cpe_platform item  )  [related, inherited]
void cpe_platform_iterator_free ( struct cpe_platform_iterator it  )  [related, inherited]
bool cpe_platform_iterator_has_more ( struct cpe_platform_iterator it  )  [related, inherited]
struct cpe_platform * cpe_platform_iterator_next ( struct cpe_platform_iterator it  )  [related, inherited]
bool cpe_platform_match_cpe ( struct cpe_name **  cpe,
size_t  n,
const struct cpe_platform platform 
)

Function to match cpe in platform.

Parameters:
cpe to be matched with
n size
platform CPE platform
struct cpe_platform * cpe_platform_parse ( xmlTextReaderPtr  reader  )  [related, inherited]

Parse CPE platform structure.

Parameters:
reader xmlTextReaderPtr structure representing XML model
Returns:
cpe_platform structure with CPE platform item
bool cpe_platform_set_id ( struct cpe_platform platform,
const char *  new_id 
) [related, inherited]
void cpe_testexpr_export ( const struct cpe_testexpr  expr,
xmlTextWriterPtr  writer 
) [related, inherited]

Function for export CPE test expression element.

Parameters:
writer xmlTextWriterPtr structure representing XML model
expr CPE test expression structure
struct cpe_name * cpe_testexpr_get_meta_cpe ( const struct cpe_testexpr item  )  [related, inherited]

Get CPE name to match against.

Only valid for CPE_LANG_OPER_MATCH.

struct cpe_testexpr * cpe_testexpr_get_meta_expr ( const struct cpe_testexpr item  )  [related, inherited]

Get CPE expression subexpression.

Not valid for CPE_LANG_OPER_MATCH operation.

struct cpe_testexpr * cpe_testexpr_get_next ( const struct cpe_testexpr expr  )  [related, inherited]

Function to get next expr from array.

Parameters:
expr CPE Test expression structure
struct cpe_testexpr * cpe_testexpr_parse ( xmlTextReaderPtr  reader  )  [related, inherited]

Parse CPE test expression structure.

Parameters:
reader xmlTextReaderPtr structure representing XML model
Returns:
cpe_testexpr structure with CPE test expression item

Generated on 12 Nov 2009 for Open SCAP Library by  doxygen 1.6.1