/usr/include/openscap/oval_variables.h is in libopenscap-dev 1.2.15-1build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 | /**
* @addtogroup OVAL
* @{
* @addtogroup OVALVAR
* Interface to Variable model
* @{
*
* @file
*
* @author "David Niemoller" <David.Niemoller@g2-inc.com>
*
*/
/*
* Copyright 2009-2014 Red Hat Inc., Durham, North Carolina.
* All Rights Reserved.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* Authors:
* "David Niemoller" <David.Niemoller@g2-inc.com>
*/
#ifndef OVAL_VARIABLES_H_
#define OVAL_VARIABLES_H_
#include "oval_types.h"
#include "oscap.h"
#include "oscap_source.h"
/**
* Create a new empty OVAL variable model
* @memberof oval_variable_model
*/
struct oval_variable_model *oval_variable_model_new(void);
/**
* Import the content from the oscap_source into a new oval_variable_model.
* @param source The oscap_source to import from.
* @return new oval_variable_model, or NULL if an error occurred
* @memberof oval_variable_model
*/
struct oval_variable_model *oval_variable_model_import_source(struct oscap_source *source);
/**
* Import the content from the file into a new oval_variable_model.
* @param file filename
* @return new oval_variable_model, or NULL if an error occurred
* @memberof oval_variable_model
* @deprecated This function has been deprecated and it may be dropped from later
* OpenSCAP releases. Please use oval_variable_model_import_source instead.
*
*/
OSCAP_DEPRECATED(struct oval_variable_model *oval_variable_model_import(const char *file));
/**
* Clone an OVAL variable model
* @return A copy of the specified @ref oval_variable_model.
* @memberof oval_variable_model
*/
struct oval_variable_model *oval_variable_model_clone(struct oval_variable_model *);
/**
* Free memory allocated to a specified oval_variable_model
* @param variable_model the specified oval_variable_model
* @memberof oval_variable_model
*/
void oval_variable_model_free(struct oval_variable_model *);
/**
* Export the specified oval_variable_model into file
* @memberof oval_variable_model
*/
int oval_variable_model_export (struct oval_variable_model *, const char *file);
/**
* @name Setters
* @{
*/
void oval_variable_model_set_generator(struct oval_variable_model *model, struct oval_generator *generator);
/**
* Get the values bound to a specified external variable.
* If the varid does not resolve to a managed external variable, this method returns NULL.
* @param variable_model the specified oval_variable_model.
* @param varid the identifier of the required oval_variable.
* @memberof oval_variable_model
*/
void oval_variable_model_add(struct oval_variable_model *model, char *varid, const char *comment, oval_datatype_t datatype, char *value);
/** @} */
/**
* @name Getters
* @{
*/
struct oval_generator *oval_variable_model_get_generator(struct oval_variable_model *model);
/**
* Get all external variables managed by a specified oval_variable_model.
* @param variable_model the specified oval_variable_model.
* @memberof oval_variable_model
*/
struct oval_string_iterator *oval_variable_model_get_variable_ids (struct oval_variable_model *);
/**
* Return true if variable with ID is present in variable model, false otherwise
* @param model Variable model
* @param id ID of variable
* @memberof oval_variable_model
*/
bool oval_variable_model_has_variable(struct oval_variable_model *model, const char * id);
/**
* Get a specified external variable datatype.
* If the varid does not resolve to a managed external variable, this method returns 0.
* @param variable_model the specified oval_variable_model.
* @param varid the identifier of the required oval_variable.
* @memberof oval_variable_model
*/
oval_datatype_t oval_variable_model_get_datatype (struct oval_variable_model *, char *);
/**
* Get a specified external variable comment.
* If the varid does not resolve to a managed external variable, this method returns NULL.
* @param variable_model the specified oval_variable_model.
* @param varid the identifier of the required oval_variable.
* @memberof oval_variable_model
*/
const char *oval_variable_model_get_comment (struct oval_variable_model *, char *);
/**
* Get the values bound to a specified external variable.
* If the varid does not resolve to a managed external variable, this method returns NULL.
* @param variable_model the specified oval_variable_model.
* @param varid the identifier of the required oval_variable.
* @memberof oval_variable_model
*/
struct oval_value_iterator *oval_variable_model_get_values(struct oval_variable_model *, char *);
/** @} */
/**
* @name Iterators
* @{
*/
/**
* @struct oval_variable_model_iterator
* @see oval_definition_model_get_bound_variable_models
*/
struct oval_variable_model_iterator;
/**
* Returns <b>true</b> if iterator not exhausted.
* @memberof oval_variable_model_iterator
*/
bool oval_variable_model_iterator_has_more(struct oval_variable_model_iterator *);
/**
* Returns next instance of @ref oval_variable_model.
* @memberof oval_variable_model_iterator
*/
struct oval_variable_model *oval_variable_model_iterator_next(struct oval_variable_model_iterator *);
/**
* Free iterator.
* @memberof oval_variable_model_iterator
*/
void oval_variable_model_iterator_free(struct oval_variable_model_iterator *);
/** @} */
/**
* @name Evaluators
* @{
*/
/** @} */
/**
* @}END OVALVAR
* @}END OVAL
*/
#endif /* OVAL_VARIABLES_H_ */
|