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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*-
*
* Copyright (C) 2014-2016 Richard Hughes <richard@hughsie.com>
*
* 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, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
#if !defined (__APPSTREAM_GLIB_H) && !defined (AS_COMPILATION)
#error "Only <appstream-glib.h> can be included directly."
#endif
#ifndef __AS_MARKUP_H
#define __AS_MARKUP_H
#include <glib.h>
G_BEGIN_DECLS
/**
* AsMarkupConvertFormat:
* @AS_MARKUP_CONVERT_FORMAT_SIMPLE: UTF-8 text
* @AS_MARKUP_CONVERT_FORMAT_MARKDOWN: Markdown format
* @AS_MARKUP_CONVERT_FORMAT_NULL: No output
* @AS_MARKUP_CONVERT_FORMAT_APPSTREAM: AppStream (passthrough)
* @AS_MARKUP_CONVERT_FORMAT_HTML: HyperText Markup Language
*
* The format used when converting to or from AppStream descriptions.
**/
typedef enum {
AS_MARKUP_CONVERT_FORMAT_SIMPLE,
AS_MARKUP_CONVERT_FORMAT_MARKDOWN,
AS_MARKUP_CONVERT_FORMAT_NULL, /* Since: 0.5.2 */
AS_MARKUP_CONVERT_FORMAT_APPSTREAM, /* Since: 0.5.2 */
AS_MARKUP_CONVERT_FORMAT_HTML, /* Since: 0.5.11 */
/*< private >*/
AS_MARKUP_CONVERT_FORMAT_LAST
} AsMarkupConvertFormat;
/**
* AsMarkupConvertFlag:
* @AS_MARKUP_CONVERT_FLAG_NONE: No flags set
* @AS_MARKUP_CONVERT_FLAG_IGNORE_ERRORS: Ignore errors where possible
*
* The flags used when converting descriptions from AppStream-style.
**/
typedef enum {
AS_MARKUP_CONVERT_FLAG_NONE = 0,
AS_MARKUP_CONVERT_FLAG_IGNORE_ERRORS = 1 << 0,
/*< private >*/
AS_MARKUP_CONVERT_FLAG_LAST
} AsMarkupConvertFlag;
gchar *as_markup_convert_simple (const gchar *markup,
GError **error);
gchar *as_markup_convert (const gchar *markup,
AsMarkupConvertFormat format,
GError **error);
gchar *as_markup_convert_full (const gchar *markup,
AsMarkupConvertFormat format,
AsMarkupConvertFlag flags,
GError **error);
gboolean as_markup_validate (const gchar *markup,
GError **error);
gchar **as_markup_strsplit_words (const gchar *text,
guint line_len);
gchar *as_markup_import (const gchar *text,
AsMarkupConvertFormat format,
GError **error);
G_END_DECLS
#endif /* __AS_MARKUP_H */
|
