EVOLUTION-MANAGER

Edit File: reportxml.h

/* Icecast * * This program is distributed under the GNU General Public License, version 2. * A copy of this license is included with this source. * * Copyright 2018, Philipp "ph3-der-loewe" Schafft <lion@lion.leolix.org>, */ /* This file contains the API for report XML document parsing, manipulation, and rendering. */ #ifndef __REPORTXML_H__ #define __REPORTXML_H__ #include <libxml/tree.h> #include "icecasttypes.h" #include "compat.h" #include "refobject.h" /* XML Tag Types * While a hint of what the nodes are used for is given, see the specification for more details. */ typedef enum { /* This is a virtual type used to indicate error conditions */ REPORTXML_NODE_TYPE__ERROR, /* <report> is the root element of report XML documents */ REPORTXML_NODE_TYPE_REPORT, /* <definition> is used to define templates */ REPORTXML_NODE_TYPE_DEFINITION, /* <incident> defines an event that is reported */ REPORTXML_NODE_TYPE_INCIDENT, /* <state> defines the state an <incident> resulted in */ REPORTXML_NODE_TYPE_STATE, /* <backtrace> provides helpful information about the location some event happend */ REPORTXML_NODE_TYPE_BACKTRACE, /* <position> defines an element within <backtrace> */ REPORTXML_NODE_TYPE_POSITION, /* <more> allows to skip <position>s in <backtrace> for any reason * (e.g. they are unknown or consider of no intrest) */ REPORTXML_NODE_TYPE_MORE, /* <fix> provides a machine readable way to actually fix the problem */ REPORTXML_NODE_TYPE_FIX, /* <action> defines a specific action to do */ REPORTXML_NODE_TYPE_ACTION, /* <reason> allows to define why an event happend */ REPORTXML_NODE_TYPE_REASON, /* <text> is used to provide messages to the user. * The content of <text> is not machine readable. */ REPORTXML_NODE_TYPE_TEXT, /* <timestamp> provides a way to present a point in time an event happend */ REPORTXML_NODE_TYPE_TIMESTAMP, /* <resource> names a resource that was involved in the event such as user input or the result */ REPORTXML_NODE_TYPE_RESOURCE, /* <value> provides an actual value for a <resource> */ REPORTXML_NODE_TYPE_VALUE, /* <reference> provides a way to refer to external documents such as documentation */ REPORTXML_NODE_TYPE_REFERENCE, /* <extension> is used to allow application specific extensions */ REPORTXML_NODE_TYPE_EXTENSION } reportxml_node_type_t; REFOBJECT_FORWARD_TYPE(reportxml_t); REFOBJECT_FORWARD_TYPE(reportxml_node_t); REFOBJECT_FORWARD_TYPE(reportxml_database_t); /* ---[ Document level ]--- */ /* The document object is NOT thread safe. */ /* Depreciated: This creates a new, empty report XML document * Do NOT use this. Use refobject_new(reportxml_t) */ reportxml_t * reportxml_new(void); /* This gets the root node of a report XML document */ reportxml_node_t * reportxml_get_root_node(reportxml_t *report); /* This selects a node by an attribute and it's value. * This is mostly useful to look for an object by using it's ID. * If more than one node matches the first one found is returned. * If the parameter include_definitions is true nodes from within * <definition> are also considered. If it is false nodes inside * <definition>s are skipped. */ reportxml_node_t * reportxml_get_node_by_attribute(reportxml_t *report, const char *key, const char *value, int include_definitions); /* This gets a node by it's type. Otherwise identical to reportxml_get_node_by_attribute() */ reportxml_node_t * reportxml_get_node_by_type(reportxml_t *report, reportxml_node_type_t type, int include_definitions); /* This function parses an XML document and returns the parst report XML document */ reportxml_t * reportxml_parse_xmldoc(xmlDocPtr doc); /* This function renders an report XML document as XML structure */ xmlDocPtr reportxml_render_xmldoc(reportxml_t *report, int set_namespace); /* ---[ Node level ]--- */ /* The node object is NOT thread safe. */ /* This creates a new node of type type. * It's id, definition, and akindof attributes can be given as parameters. */ reportxml_node_t * reportxml_node_new(reportxml_node_type_t type, const char *id, const char *definition, const char *akindof); /* This parses an XML node and returns the resulting report XML node */ reportxml_node_t * reportxml_node_parse_xmlnode(xmlNodePtr xmlnode); /* Copy an report XML node (and it's children) */ reportxml_node_t * reportxml_node_copy(reportxml_node_t *node); /* Renders an report XML node as XML node */ xmlNodePtr reportxml_node_render_xmlnode(reportxml_node_t *node); /* This gets the type of an report XML node */ reportxml_node_type_t reportxml_node_get_type(reportxml_node_t *node); /* Gets and Sets attribute values */ int reportxml_node_set_attribute(reportxml_node_t *node, const char *key, const char *value); char * reportxml_node_get_attribute(reportxml_node_t *node, const char *key); /* Adds, counts, and get child nodes */ int reportxml_node_add_child(reportxml_node_t *node, reportxml_node_t *child); ssize_t reportxml_node_count_child(reportxml_node_t *node); reportxml_node_t * reportxml_node_get_child(reportxml_node_t *node, size_t idx); /* This gets an child by it's value of the given attribute. See reportxml_get_node_by_attribute() for more details. */ reportxml_node_t * reportxml_node_get_child_by_attribute(reportxml_node_t *node, const char *key, const char *value, int include_definitions); /* This gets a child by it's type. Otherwise identical to reportxml_node_get_child_by_attribute() */ reportxml_node_t * reportxml_node_get_child_by_type(reportxml_node_t *node, reportxml_node_type_t type, int include_definitions); /* This gets and sets the text content of an node (used for <text>) */ int reportxml_node_set_content(reportxml_node_t *node, const char *value); char * reportxml_node_get_content(reportxml_node_t *node); /* Adds, counts, and gets XML childs (used for <extension>) */ int reportxml_node_add_xml_child(reportxml_node_t *node, xmlNodePtr child); ssize_t reportxml_node_count_xml_child(reportxml_node_t *node); xmlNodePtr reportxml_node_get_xml_child(reportxml_node_t *node, size_t idx); /* ---[ Database level ]--- */ /* The database object is thread safe. */ /* Depreciated: Create a new database object * Do NOT use this. Use refobject_new(reportxml_database_t) */ reportxml_database_t * reportxml_database_new(void); /* Add an report to the database */ int reportxml_database_add_report(reportxml_database_t *db, reportxml_t *report); /* Build a node (copy) from the data in the database based on the given ID (using "definition" and "defines" attributes) * depth may be used to select how many recursions may be used to resolve definitions within defines. * The default value is selected by passing -1 (recommended). */ reportxml_node_t * reportxml_database_build_node(reportxml_database_t *db, const char *id, ssize_t depth); /* This does the same as reportxml_database_build_node() except that a new report document is returned. */ reportxml_t * reportxml_database_build_report(reportxml_database_t *db, const char *id, ssize_t depth); /* This does the same reportxml_database_add_report() but does not return a node of a given type compiled from the definition. */ reportxml_node_t * reportxml_database_build_fragment(reportxml_database_t *db, const char *id, ssize_t depth, reportxml_node_type_t type); #endif