Wrapper for managing XML documents and elements using libxml2. More...

#include <iostream>
#include <libxml/parser.h>
#include <limits>
#include <memory>
#include <optional>
#include <span>
#include <stdexcept>
#include <string>
#include <string_view>
#include <vector>
#include "core/logging.h"
#include "libxml/globals.h"
#include "libxml/xmlstring.h"

Include dependency graph for libxml_wrapper.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	XmlException
	Exception class for handling XML-related errors. More...

class	xml_detail::XmlCharBuffer

class	XmlElement
	Class representing a node in an XML document. More...

class	XmlDocument
	Class for managing XML documents. More...

Namespaces
namespace	xml_detail

Functions
std::string	xml_detail::toString (const xmlChar *value)

std::string	xml_detail::toString (const xmlChar *value, const int length)

bool	xml_detail::equals (const xmlChar *xml_value, const std::string_view value)

xmlNodePtr	xml_detail::createNode (const std::string_view name)

xmlDocPtr	xml_detail::createDocument ()

void	mergeXmlDocuments (const XmlDocument &mainDoc, const XmlDocument &includedDoc)
	Merge two XML documents.

void	removeIncludeElements (const XmlDocument &doc)
	Remove "include" elements from the XML document.

Detailed Description

Wrapper for managing XML documents and elements using libxml2.

This header file provides classes and functions to simplify handling XML documents and elements using the libxml2 library. It includes basic functionality for manipulating XML nodes, attributes, content, and validation using DTD and XSD schemas.

Definition in file libxml_wrapper.h.

Function Documentation

◆ mergeXmlDocuments()

void mergeXmlDocuments	(	const XmlDocument &	mainDoc,
		const XmlDocument &	includedDoc
	)

Merge two XML documents.

Parameters

mainDoc	The main XML document.
includedDoc	The XML document to include.

Definition at line 214 of file libxml_wrapper.cpp.

{
    const XmlElement main_root = mainDoc.getRootElement();
    const XmlElement included_root = includedDoc.getRootElement();
 
    for (xmlNodePtr child = included_root.getNode()->children; child != nullptr; child = child->next)
    {
        if (child->type == XML_ELEMENT_NODE)
        {
            xmlNodePtr new_node = xmlCopyNode(child, 1);
            xmlAddChild(main_root.getNode(), new_node);
        }
    }
}

References max.

Referenced by serial::xml_parser_utils::addIncludeFilesToMainDocument().

Here is the caller graph for this function:

◆ removeIncludeElements()

void removeIncludeElements ( const XmlDocument & doc )

Remove "include" elements from the XML document.

Parameters

doc	The XML document from which to remove the "include" elements.

Definition at line 229 of file libxml_wrapper.cpp.

{
    const XmlElement root = doc.getRootElement();
 
    while (true)
    {
        if (const XmlElement include_element = root.childElement("include", 0); include_element.isValid())
        {
            xmlUnlinkNode(include_element.getNode());
            xmlFreeNode(include_element.getNode());
        }
        else
        {
            break;
        }
    }
}