CAENXMLParser.h

Go to the documentation of this file.

/******************************************************************************
*
*   CAEN SpA - Software Division
*   Via Vetraia, 11 - 55049 - Viareggio ITALY
*   +39 0594 388 398 - www.caen.it
*
*******************************************************************************
*
*   Copyright (C) 2019-2022 CAEN SpA
*
*   This file is part of the CAEN Utility.
*
*   The CAEN Utility is free software; you can redistribute it and/or
*   modify it under the terms of the GNU Lesser General Public
*   License as published by the Free Software Foundation; either
*   version 3 of the License, or (at your option) any later version.
*
*   The CAEN Utility is distributed in the hope that it will be useful,
*   but WITHOUT ANY WARRANTY; without even the implied warranty of
*   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
*   Lesser General Public License for more details.
*
*   You should have received a copy of the GNU Lesser General Public
*   License along with the CAEN Utility; if not, see
*   https://www.gnu.org/licenses/.
*
*   SPDX-License-Identifier: LGPL-3.0-or-later
*
***************************************************************************/
#ifndef CAEN_INCLUDE_CAENXMLPARSER_H_
#define CAEN_INCLUDE_CAENXMLPARSER_H_

#ifndef _NOUSEXML

#ifdef __cplusplus
extern "C" {
#endif

#include <types/CAENXMLParserTypes.h>
#include <types/CAENMultiplatformTypes.h>
#include <CAENUtility.h>

#include <libxml/xpath.h>

c_nodiscard c_attribute_malloc c_attribute_nonnull(1)
CAEN_UTILITY_DLLAPI c_xmlfile_t * CAEN_UTILITY_API c_xml_newfile(const char *filename);

c_nodiscard c_attribute_malloc c_attribute_nonnull(1)
CAEN_UTILITY_DLLAPI c_xmlfile_t * CAEN_UTILITY_API c_xml_newfile_from_memory(const char *buffer, int size);

CAEN_UTILITY_DLLAPI void CAEN_UTILITY_API c_xml_freefile(c_xmlfile_t *file);

c_nodiscard
CAEN_UTILITY_DLLAPI xmlNode * CAEN_UTILITY_API c_xml_getrootnode(const c_xmlfile_t *file);

c_nodiscard
CAEN_UTILITY_DLLAPI const char * CAEN_UTILITY_API c_xml_getpath(const c_xmlfile_t *file);

c_nodiscard c_attribute_malloc
CAEN_UTILITY_DLLAPI xmlNodeSet * CAEN_UTILITY_API c_xml_getnodeset(c_xmlfile_t *file, const xmlChar *query);

CAEN_UTILITY_DLLAPI void CAEN_UTILITY_API c_xml_freenodeset(xmlNodeSet *nodeset);

c_nodiscard
CAEN_UTILITY_DLLAPI const char * CAEN_UTILITY_API c_xml_getattributevalue(const xmlNode *node, const char *attribute, bool warnEnable);

c_nodiscard
CAEN_UTILITY_DLLAPI xmlNode * CAEN_UTILITY_API c_xml_getfirstnodefromxpathquery(c_xmlfile_t *file, const xmlChar *query);

c_nodiscard
CAEN_UTILITY_DLLAPI xmlNode * CAEN_UTILITY_API c_xml_getnextelementfromname(xmlNode *node, const char *nodename);

c_nodiscard
CAEN_UTILITY_DLLAPI xmlNode * CAEN_UTILITY_API c_getfirstsiblingelementfromname(xmlNode *node, const char *nodename);

c_nodiscard
CAEN_UTILITY_DLLAPI xmlNode * CAEN_UTILITY_API c_xml_getfirstchildrenelementfromname(xmlNode *node, const char *nodename);

c_nodiscard
CAEN_UTILITY_DLLAPI xmlNode * CAEN_UTILITY_API c_xml_getfirstdescendantelementfromname(xmlNode *node, const char *nodename);

CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_xml_getcodefromnodechild(const xmlNode *node, double *code);

CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_xml_getcodefromnode(const xmlNode *node, double *code);

CAEN_UTILITY_DLLAPI int32_t CAEN_UTILITY_API c_xml_getcodefromcodename(const c_xmlfile_t *file, const char *__restrict category, const char *__restrict codename, double *code);

c_nodiscard
CAEN_UTILITY_DLLAPI const char * CAEN_UTILITY_API c_xml_getattributevaluefromcodename(const c_xmlfile_t *file, const char *__restrict category, const char *__restrict codename, const char *__restrict attrname);

c_nodiscard
CAEN_UTILITY_DLLAPI c_fcnhandle_t CAEN_UTILITY_API c_xml_getfunctionpointerfromcodename(const c_xmlfile_t *file, const char *codename);

c_attribute_format(3, 4)
CAEN_UTILITY_DLLAPI int CAEN_UTILITY_API c_xml_snprintf(xmlChar *buf, int len, const char *msg, ...);

CAEN_UTILITY_DLLAPI int CAEN_UTILITY_API c_xml_strlen(const xmlChar *str);

CAEN_UTILITY_DLLAPI const char * CAEN_UTILITY_API c_xml_parserversion(void);

CAEN_UTILITY_DLLAPI void CAEN_UTILITY_API c_xml_parsercleanup(void);

#ifdef __cplusplus
}
#endif

#endif // !_NOUSEXML

#endif // CAEN_INCLUDE_CAENXMLPARSER_H_