OpenVAS Libraries  8.0.3
xml.h
Go to the documentation of this file.
1 /* openvase-libraries/omp/xml
2  * $Id$
3  * Description: Headers for simple XML reader.
4  *
5  * Authors:
6  * Matthew Mundell <matt@mundell.ukfsn.org>
7  *
8  * Copyright:
9  * Copyright (C) 2009 Greenbone Networks GmbH
10  *
11  * This program is free software; you can redistribute it and/or
12  * modify it under the terms of the GNU General Public License
13  * as published by the Free Software Foundation; either version 2
14  * of the License, or (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program; if not, write to the Free Software
23  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24  */
25 
26 #ifndef _OPENVAS_LIBRARIES_XML_H
27 #define _OPENVAS_LIBRARIES_XML_H
28 
29 #include <glib.h>
30 #include <gnutls/gnutls.h>
31 #include <stdio.h>
32 
33 #ifdef __cplusplus
34 extern "C"
35 {
36 #if 0
37 }
38 #endif
39 #endif
40 
41 typedef GSList *entities_t;
42 
46 struct entity_s
47 {
48  char *name;
49  char *text;
50  GHashTable *attributes;
52 };
53 typedef struct entity_s *entity_t;
54 
56 
57 entity_t first_entity (entities_t);
58 
59 entity_t add_entity (entities_t *, const char *, const char *);
60 
61 int compare_entities (entity_t, entity_t);
62 
63 entity_t entity_child (entity_t, const char *);
64 
65 const char *entity_attribute (entity_t, const char *);
66 
67 char *entity_name (entity_t entity);
68 
69 char *entity_text (entity_t entity);
70 
71 void free_entity (entity_t);
72 
73 void print_entity (FILE *, entity_t);
74 
75 void print_entity_format (entity_t, gpointer indentation);
76 
77 int try_read_entity_and_string (gnutls_session_t *, int, entity_t *,
78  GString **);
79 
80 int read_entity_and_string (gnutls_session_t *, entity_t *, GString **);
81 
82 int read_entity_and_text (gnutls_session_t *, entity_t *, char **);
83 
84 int try_read_entity (gnutls_session_t *, int, entity_t *);
85 
86 int read_entity (gnutls_session_t *, entity_t *);
87 
88 int read_string (gnutls_session_t *, GString **);
89 
90 int parse_entity (const char *, entity_t *);
91 
92 void print_entity_to_string (entity_t entity, GString * string);
93 
95 
96 void xml_string_append (GString *, const char *, ...);
97 
98 #if 0
99 {
100 #endif
101 #ifdef __cplusplus
102 }
103 #endif
104 
105 #endif /* not _OPENVAS_LIBRARIES_XML_H */
const char * entity_attribute(entity_t, const char *)
Get an attribute of an entity.
Definition: xml.c:241
GHashTable * attributes
Attributes.
Definition: xml.h:50
int parse_entity(const char *, entity_t *)
Read an XML entity tree from a string.
Definition: xml.c:701
entity_t entity_child(entity_t, const char *)
Get a child of an entity.
Definition: xml.c:220
int compare_entities(entity_t, entity_t)
Compare two XML entity.
Definition: xml.c:947
int read_entity_and_text(gnutls_session_t *, entity_t *, char **)
Read an XML entity tree from the manager.
Definition: xml.c:622
int read_entity_and_string(gnutls_session_t *, entity_t *, GString **)
Try read an XML entity tree from the manager.
Definition: xml.c:603
int read_string(gnutls_session_t *, GString **)
Read entity and text. Free the entity immediately.
Definition: xml.c:651
char * entity_text(entity_t entity)
Get the text an entity.
Definition: xml.c:178
entities_t next_entities(entities_t)
Return all the entities from an entities_t after the first.
Definition: xml.c:100
void print_entity_to_string(entity_t entity, GString *string)
Print an XML entity tree to a GString, appending it if string is not.
Definition: xml.c:799
void print_entity(FILE *, entity_t)
Print an XML entity.
Definition: xml.c:846
XML element.
Definition: xml.h:46
int try_read_entity(gnutls_session_t *, int, entity_t *)
Try read an XML entity tree from the manager.
Definition: xml.c:673
entities_t entities
Children.
Definition: xml.h:51
void xml_string_append(GString *, const char *,...)
Append formatted escaped XML to a string.
Definition: xml.c:1034
entity_t add_entity(entities_t *, const char *, const char *)
Add an XML entity to a tree of entities.
Definition: xml.c:134
struct entity_s * entity_t
Definition: xml.h:53
int try_read_entity_and_string(gnutls_session_t *, int, entity_t *, GString **)
Try read an XML entity tree from the manager.
Definition: xml.c:397
char * name
Name.
Definition: xml.h:48
int read_entity(gnutls_session_t *, entity_t *)
Read an XML entity tree from the manager.
Definition: xml.c:687
GSList * entities_t
Definition: xml.h:41
void print_entity_format(entity_t, gpointer indentation)
Print an XML entity to stdout, recusively printing its children.
Definition: xml.c:888
entity_t first_entity(entities_t)
Return the first entity from an entities_t.
Definition: xml.c:115
void free_entity(entity_t)
Free an entity, recursively.
Definition: xml.c:148
char * entity_name(entity_t entity)
Get the name an entity.
Definition: xml.c:191
char * text
Text.
Definition: xml.h:49
int xml_count_entities(entities_t)
Count the number of entities.
Definition: xml.c:1013