1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*-
2  *
3  * Copyright (C) 2017 Richard Hughes <richard@hughsie.com>
4  *
5  * SPDX-License-Identifier: LGPL-2.1+
6  */
7 
8 #pragma once
9 
10 #if !defined (__APPSTREAM_GLIB_H_INSIDE__) && !defined (AS_COMPILATION)
11 #error "Only <appstream-glib.h> can be included directly."
12 #endif
13 
14 #include <glib-object.h>
15 
16 G_BEGIN_DECLS
17 
18 #define AS_TYPE_FORMAT (as_format_get_type ())
19 G_DECLARE_DERIVABLE_TYPE (AsFormat, as_format, AS, FORMAT, GObject)
20 
21 struct _AsFormatClass
22 {
23 	GObjectClass		parent_class;
24 	/*< private >*/
25 	void (*_as_reserved1)	(void);
26 	void (*_as_reserved2)	(void);
27 	void (*_as_reserved3)	(void);
28 	void (*_as_reserved4)	(void);
29 	void (*_as_reserved5)	(void);
30 	void (*_as_reserved6)	(void);
31 	void (*_as_reserved7)	(void);
32 	void (*_as_reserved8)	(void);
33 };
34 
35 /**
36  * AsFormatKind:
37  * @AS_FORMAT_KIND_UNKNOWN:		Not formatd from a file
38  * @AS_FORMAT_KIND_APPSTREAM:		AppStream file
39  * @AS_FORMAT_KIND_DESKTOP:		Desktop file
40  * @AS_FORMAT_KIND_APPDATA:		AppData file
41  * @AS_FORMAT_KIND_METAINFO:		MetaInfo file
42  *
43  * The format kind.
44  **/
45 typedef enum {
46 	AS_FORMAT_KIND_UNKNOWN,		/* Since: 0.6.9 */
47 	AS_FORMAT_KIND_APPSTREAM,	/* Since: 0.6.9 */
48 	AS_FORMAT_KIND_DESKTOP,		/* Since: 0.6.9 */
49 	AS_FORMAT_KIND_APPDATA,		/* Since: 0.6.9 */
50 	AS_FORMAT_KIND_METAINFO,	/* Since: 0.6.9 */
51 	/*< private >*/
52 	AS_FORMAT_KIND_LAST
53 } AsFormatKind;
54 
55 AsFormat	*as_format_new			(void);
56 
57 /* helpers */
58 AsFormatKind	 as_format_kind_from_string	(const gchar	*kind);
59 const gchar	*as_format_kind_to_string	(AsFormatKind	 kind);
60 gboolean	 as_format_equal		(AsFormat	*format1,
61 						 AsFormat	*format2);
62 AsFormatKind	 as_format_guess_kind		(const gchar	*filename);
63 
64 /* getters */
65 const gchar	*as_format_get_filename		(AsFormat	*format);
66 AsFormatKind	 as_format_get_kind		(AsFormat	*format);
67 
68 /* setters */
69 void		 as_format_set_filename		(AsFormat	*format,
70 						 const gchar	*filename);
71 void		 as_format_set_kind		(AsFormat	*format,
72 						 AsFormatKind	 kind);
73 
74 G_END_DECLS
75