/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*-
 *
 * Copyright (C) 2012-2024 Matthias Klumpp <matthias@tenstral.net>
 *
 * Licensed under the GNU Lesser General Public License Version 2.1
 *
 * This library 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 2.1 of the license, or
 * (at your option) any later version.
 *
 * This library 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 this library.  If not, see <http://www.gnu.org/licenses/>.
 */

#if !defined(__APPSTREAM_H) && !defined(AS_COMPILATION)
#error "Only <appstream.h> can be included directly."
#endif

#ifndef __AS_XML_H
#define __AS_XML_H

#include <libxml/tree.h>
#include <libxml/parser.h>
#include <libxml/xmlsave.h>
#include "as-context.h"
#include "as-metadata.h"
#include "as-tag.h"

G_BEGIN_DECLS
#pragma GCC visibility push(hidden)

gchar		      *as_xml_get_node_value (const xmlNode *node);
GRefString	      *as_xml_get_node_value_refstr (const xmlNode *node);
#define as_xml_get_node_value_raw(node) (gchar *) (xmlNodeGetContent (node))

#define as_xml_get_prop_value(node, prop_name) (gchar *) (xmlGetProp (node, (xmlChar *) prop_name))
GRefString *as_xml_get_prop_value_refstr (const xmlNode *node, const gchar *prop_name);
gint	    as_xml_get_prop_value_as_int (const xmlNode *node, const gchar *prop_name);

gchar	   *as_xml_get_node_locale (AsContext *ctx, xmlNode *node);
gchar	   *as_xml_get_node_locale_match (AsContext *ctx, xmlNode *node);

void	    as_xml_add_children_values_to_array (xmlNode     *node,
						 const gchar *element_name,
						 GPtrArray   *array);

GPtrArray  *as_xml_get_children_as_string_list (xmlNode *node, const gchar *element_name);
gchar	  **as_xml_get_children_as_strv (xmlNode *node, const gchar *element_name);

void as_xml_parse_metainfo_description_node (AsContext *ctx, xmlNode *node, GHashTable *l10n_desc);

gchar	*as_xml_dump_node_content_raw (xmlNode *node);
gchar	*as_xml_dump_node_children (xmlNode *node);

void	 as_xml_add_description_node (AsContext	 *ctx,
				      xmlNode	 *root,
				      GHashTable *desc_table,
				      gboolean	  mi_translatable);
xmlNode *as_xml_add_description_node_raw (xmlNode *root, const gchar *description);

void	 as_xml_add_localized_text_node (xmlNode     *root,
					 const gchar *node_name,
					 GHashTable  *value_table);

xmlNode *as_xml_add_node_list_strv (xmlNode	*root,
				    const gchar *name,
				    const gchar *child_name,
				    gchar      **strv);

xmlNode *as_xml_add_node_list (xmlNode	   *root,
			       const gchar *name,
			       const gchar *child_name,
			       GPtrArray   *array);

void	 as_xml_parse_custom_node (xmlNode *node, GHashTable *custom);
void	 as_xml_add_custom_node (xmlNode *root, const gchar *node_name, GHashTable *custom);

#define as_xml_node_new(name)	    xmlNewNode (NULL, (xmlChar *) name)
#define as_xml_add_node(root, name) xmlNewChild (root, NULL, (xmlChar *) name, NULL)
xmlNode *as_xml_add_text_node (xmlNode *root, const gchar *name, const gchar *value);
xmlNode *as_xml_add_uint_node (xmlNode *root, const gchar *name, guint64 value);
xmlAttr *as_xml_add_text_prop (xmlNode *node, const gchar *name, const gchar *value);
xmlAttr *as_xml_add_uint_prop (xmlNode *node, const gchar *name, guint64 value);

xmlDoc	*as_xml_parse_document (const gchar *data, gssize len, gboolean pedantic, GError **error);

gchar	*as_xml_node_free_to_str (xmlNode *root, GError **error);

#pragma GCC visibility pop
G_END_DECLS

#endif /* __AS_XML_H */