xml_compat.h

Go to the documentation of this file.

/*
 * Copyright 2004-2025 the Pacemaker project contributors
 *
 * The version control history for this file may have further details.
 *
 * This source code is licensed under the GNU Lesser General Public License
 * version 2.1 or later (LGPLv2.1+) WITHOUT ANY WARRANTY.
 */
 
#ifndef PCMK__CRM_COMMON_XML_COMPAT__H
#define PCMK__CRM_COMMON_XML_COMPAT__H
 
#include <glib.h>               // gboolean
#include <libxml/tree.h>        // xmlNode
#include <libxml/xpath.h>           // xmlXPathObject
 
#include <crm/common/nvpair.h>  // crm_xml_add()
#include <crm/common/xml_names.h>   // PCMK_XE_CLONE
 
#ifdef __cplusplus
extern "C" {
#endif
 
// NOTE: sbd (as of at least 1.5.2) uses this
static inline const char *
crm_element_name(const xmlNode *xml)
{
    return (xml == NULL)? NULL : (const char *) xml->name;
}
 
// NOTE: sbd (as of at least 1.5.2) uses this
xmlNode *copy_xml(xmlNode *src_node);
 
// NOTE: sbd (as of at least 1.5.2) uses this
gboolean cli_config_update(xmlNode **xml, int *best_version, gboolean to_logs);
 
// NOTE: sbd (as of at least 1.5.2) uses this
void crm_xml_init(void);
 
void crm_xml_cleanup(void);
 
void pcmk_free_xml_subtree(xmlNode *xml);
 
// NOTE: sbd (as of at least 1.5.2) uses this
void free_xml(xmlNode *child);
 
void crm_xml_sanitize_id(char *id);
 
char *calculate_on_disk_digest(xmlNode *input);
 
char *calculate_operation_digest(xmlNode *input, const char *version);
 
char *calculate_xml_versioned_digest(xmlNode *input, gboolean sort,
                                     gboolean do_filter, const char *version);
 
xmlXPathObjectPtr xpath_search(const xmlNode *xml_top, const char *path);
 
static inline int numXpathResults(xmlXPathObjectPtr xpathObj)
{
    if ((xpathObj == NULL) || (xpathObj->nodesetval == NULL)) {
        return 0;
    }
    return xpathObj->nodesetval->nodeNr;
}
 
xmlNode *getXpathResult(xmlXPathObjectPtr xpathObj, int index);
 
void freeXpathObject(xmlXPathObjectPtr xpathObj);
 
void dedupXpathResults(xmlXPathObjectPtr xpathObj);
 
void crm_foreach_xpath_result(xmlNode *xml, const char *xpath,
                              void (*helper)(xmlNode*, void*), void *user_data);
 
// NOTE: sbd (as of at least 1.5.2) uses this
xmlNode *get_xpath_object(const char *xpath, xmlNode *xml_obj, int error_level);
 
typedef const xmlChar *pcmkXmlStr;
 
bool xml_tracking_changes(xmlNode *xml);
 
bool xml_document_dirty(xmlNode *xml);
 
void xml_accept_changes(xmlNode *xml);
 
void xml_track_changes(xmlNode *xml, const char *user, xmlNode *acl_source,
                       bool enforce_acls);
 
void xml_calculate_changes(xmlNode *old_xml, xmlNode *new_xml);
 
void xml_calculate_significant_changes(xmlNode *old_xml, xmlNode *new_xml);
 
#ifdef __cplusplus
}
#endif
 
#endif // PCMK__CRM_COMMON_XML_COMPAT__H