summaryrefslogtreecommitdiff
path: root/libappstream-glib/as-yaml.h
blob: b6a188650f62520a42d22fa47d0b95ff231f7a7b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*-
 *
 * Copyright (C) 2014 Richard Hughes <richard@hughsie.com>
 *
 * SPDX-License-Identifier: LGPL-2.1+
 */

#pragma once

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

#include <gio/gio.h>
#include <glib-object.h>

G_BEGIN_DECLS


/**
 * AsYamlFromFlags:
 * @AS_YAML_FROM_FLAG_NONE:			No extra flags to use
 * @AS_YAML_FROM_FLAG_ONLY_NATIVE_LANGS:	Only load native languages
 *
 * The flags for converting from XML.
 **/
typedef enum {
	AS_YAML_FROM_FLAG_NONE			= 0,		/* Since: 0.1.0 */
	AS_YAML_FROM_FLAG_ONLY_NATIVE_LANGS	= 1 << 0,	/* Since: 0.6.6 */
	/*< private >*/
	AS_YAML_FROM_FLAG_LAST
} AsYamlFromFlags;

typedef GNode AsYaml;

void		 as_yaml_unref			(AsYaml		*node);
GString		*as_yaml_to_string		(AsYaml		*node);
AsYaml		*as_yaml_from_data		(const gchar	*data,
						 gssize		 data_len,
						 AsYamlFromFlags flags,
						 GError		**error);
AsYaml		*as_yaml_from_file		(GFile		*file,
						 AsYamlFromFlags flags,
						 GCancellable	*cancellable,
						 GError		**error);
const gchar	*as_yaml_node_get_key		(const AsYaml	*node);
const gchar	*as_yaml_node_get_value		(const AsYaml	*node);
gint		 as_yaml_node_get_value_as_int	(const AsYaml	*node);
guint		 as_yaml_node_get_value_as_uint	(const AsYaml	*node);

G_DEFINE_AUTOPTR_CLEANUP_FUNC(AsYaml, as_yaml_unref)

G_END_DECLS