/* -*- 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_YAML_H
#define __AS_YAML_H

#include <yaml.h>
#include "as-context.h"
#include "as-metadata.h"
#include "as-tag.h"

G_BEGIN_DECLS
#pragma GCC visibility push(hidden)

void		       as_yaml_parse_layer (yaml_parser_t *parser, GNode *data, GError **error);

gboolean	       as_yaml_free_node (GNode *node, gpointer data);

const gchar	      *as_yaml_node_get_key (GNode *n);
const gchar	      *as_yaml_node_get_value (GNode *n);

GRefString	      *as_yaml_node_get_key_refstr (GNode *n);
GRefString	      *as_yaml_node_get_value_refstr (GNode *n);

void		       as_yaml_print_unknown (const gchar *root, const gchar *key);

/* these functions have internal visibility, so appstream-compose can write YAML data */
#pragma GCC visibility push(default)
void		       as_yaml_mapping_start (yaml_emitter_t *emitter);
void		       as_yaml_mapping_end (yaml_emitter_t *emitter);

void		       as_yaml_sequence_start (yaml_emitter_t *emitter);
void		       as_yaml_sequence_end (yaml_emitter_t *emitter);

void		       as_yaml_emit_long_entry_literal (yaml_emitter_t *emitter,
							const gchar    *key,
							const gchar    *value);
void		       as_yaml_emit_scalar_raw (yaml_emitter_t *emitter, const gchar *value);
void		       as_yaml_emit_scalar (yaml_emitter_t *emitter, const gchar *value);
void		       as_yaml_emit_scalar_uint64 (yaml_emitter_t *emitter, guint64 value);
void		       as_yaml_emit_scalar_key (yaml_emitter_t *emitter, const gchar *key);
void as_yaml_emit_entry (yaml_emitter_t *emitter, const gchar *key, const gchar *value);
void as_yaml_emit_entry_uint64 (yaml_emitter_t *emitter, const gchar *key, guint64 value);
void as_yaml_emit_entry_timestamp (yaml_emitter_t *emitter, const gchar *key, guint64 unixtime);
void as_yaml_emit_long_entry (yaml_emitter_t *emitter, const gchar *key, const gchar *value);
void as_yaml_emit_sequence (yaml_emitter_t *emitter, const gchar *key, GPtrArray *list);
#pragma GCC visibility pop
void		       as_yaml_emit_sequence_from_str_array (yaml_emitter_t *emitter,
							     const gchar    *key,
							     GPtrArray	    *array);
void as_yaml_emit_localized_strv (yaml_emitter_t *emitter, const gchar *key, GHashTable *ltab);
void as_yaml_emit_localized_str_array (yaml_emitter_t *emitter, const gchar *key, GHashTable *ltab);

GNode	    *as_yaml_get_localized_node (AsContext *ctx, GNode *node, gchar *locale_override);
const gchar *as_yaml_get_node_locale (AsContext *ctx, GNode *node);
void	     as_yaml_set_localized_table (AsContext *ctx, GNode *node, GHashTable *l10n_table);

void as_yaml_emit_localized_entry (yaml_emitter_t *emitter, const gchar *key, GHashTable *ltab);
void as_yaml_emit_long_localized_entry (yaml_emitter_t *emitter,
					const gchar    *key,
					GHashTable     *ltab);

void as_yaml_list_to_str_array (GNode *node, GPtrArray *array);

#pragma GCC visibility pop
G_END_DECLS

#endif /* __AS_YAML_H */