Open SCAP Library
oscap_source.h
1 /*
2  * Copyright 2014 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  * Author:
20  * Šimon Lukašík
21  */
22 #ifndef OSCAP_SOURCE_H
23 #define OSCAP_SOURCE_H
24 
25 #ifdef HAVE_CONFIG_H
26 #include <config.h>
27 #endif
28 
29 #include <stddef.h>
30 
31 #include "oscap.h"
32 #include "oscap_export.h"
33 
59 struct oscap_source;
60 
68 OSCAP_API struct oscap_source *oscap_source_new_from_file(const char *filepath);
69 
83 OSCAP_API struct oscap_source *oscap_source_new_from_memory(const char *buffer, size_t size, const char *filepath);
84 
90 OSCAP_API struct oscap_source *oscap_source_clone(struct oscap_source *old);
91 
96 OSCAP_API void oscap_source_free(struct oscap_source *source);
97 
104 OSCAP_API const char *oscap_source_get_filepath(struct oscap_source *source);
105 
117 
124 OSCAP_API const char *oscap_source_get_schema_version(struct oscap_source *source);
125 
133 OSCAP_API int oscap_source_validate(struct oscap_source *source, xml_reporter reporter, void *user);
134 
143 OSCAP_API int oscap_source_validate_schematron(struct oscap_source *source, const char *outfile);
144 
151 OSCAP_API const char *oscap_source_readable_origin(const struct oscap_source *source);
152 
161 OSCAP_API int oscap_source_save_as(struct oscap_source *source, const char *filename);
162 
175 OSCAP_API int oscap_source_get_raw_memory(struct oscap_source *source, char **buffer, size_t *size);
176 
177 #endif
OSCAP_API const char * oscap_source_get_schema_version(struct oscap_source *source)
Get the version of the schema for the particular document type.
Definition: oscap_source.c:358
OSCAP_API int oscap_source_validate(struct oscap_source *source, xml_reporter reporter, void *user)
Validate the SCAP document against particular XML schema definition.
Definition: oscap_source.c:328
Definition: reporter.c:31
General OpenScap functions and types.
OSCAP_API oscap_document_type_t oscap_source_get_scap_type(struct oscap_source *source)
Get SCAP document type of the given resource.
Definition: oscap_source.c:180
char * filepath
Filepath (if originated from file)
Definition: oscap_source.c:71
OSCAP_API const char * oscap_source_readable_origin(const struct oscap_source *source)
Returns human readable description of oscap_source origin.
Definition: oscap_source.c:159
enum oscap_document_type oscap_document_type_t
SCAP document type identifiers.
Definition: oscap_source.c:66
OSCAP_API const char * oscap_source_get_filepath(struct oscap_source *source)
Get filepath of the given resource.
Definition: oscap_source.c:198
OSCAP_API int oscap_source_save_as(struct oscap_source *source, const char *filename)
Store the resource represented by oscap_source to the file.
Definition: oscap_source.c:410
OSCAP_API int oscap_source_validate_schematron(struct oscap_source *source, const char *outfile)
Validate the SCAP document against schematron assertions.
Definition: oscap_source.c:352