1 /* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*-
2  *
3  * Copyright (C) 2016 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_REQUIRE (as_require_get_type ())
19 G_DECLARE_DERIVABLE_TYPE (AsRequire, as_require, AS, REQUIRE, GObject)
20 
21 struct _AsRequireClass
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  * AsRequireKind:
37  * @AS_REQUIRE_KIND_UNKNOWN:		Type invalid or not known
38  * @AS_REQUIRE_KIND_ID:			Component ID
39  * @AS_REQUIRE_KIND_FIRMWARE:		Device firmware version
40  * @AS_REQUIRE_KIND_HARDWARE:		Hardware device, typically a GUID
41  * @AS_REQUIRE_KIND_MODALIAS:		Modalias string
42  * @AS_REQUIRE_KIND_KERNEL:		Kernel version
43  * @AS_REQUIRE_KIND_MEMORY:		Amount of installed memory in MiB
44  *
45  * The require type.
46  **/
47 typedef enum {
48 	AS_REQUIRE_KIND_UNKNOWN,
49 	AS_REQUIRE_KIND_ID,
50 	AS_REQUIRE_KIND_FIRMWARE,
51 	AS_REQUIRE_KIND_HARDWARE,		/* Since: 0.7.4 */
52 	AS_REQUIRE_KIND_MODALIAS,		/* Since: 0.7.8 */
53 	AS_REQUIRE_KIND_KERNEL,			/* Since: 0.7.8 */
54 	AS_REQUIRE_KIND_MEMORY,			/* Since: 0.7.8 */
55 	/*< private >*/
56 	AS_REQUIRE_KIND_LAST
57 } AsRequireKind;
58 
59 /**
60  * AsRequireCompare:
61  * @AS_REQUIRE_COMPARE_UNKNOWN:			Comparison predicate invalid or not known
62  * @AS_REQUIRE_COMPARE_EQ:			Equal to
63  * @AS_REQUIRE_COMPARE_NE:			Not equal to
64  * @AS_REQUIRE_COMPARE_LT:			Less than
65  * @AS_REQUIRE_COMPARE_GT:			Greater than
66  * @AS_REQUIRE_COMPARE_LE:			Less than or equal to
67  * @AS_REQUIRE_COMPARE_GE:			Greater than or equal to
68  * @AS_REQUIRE_COMPARE_GLOB:			Filename glob, e.g. `test*`
69  * @AS_REQUIRE_COMPARE_REGEX:			A regular expression, e.g. `fw[0-255]`
70  *
71  * The relational comparison type.
72  **/
73 typedef enum {
74 	AS_REQUIRE_COMPARE_UNKNOWN,
75 	AS_REQUIRE_COMPARE_EQ,
76 	AS_REQUIRE_COMPARE_NE,
77 	AS_REQUIRE_COMPARE_LT,
78 	AS_REQUIRE_COMPARE_GT,
79 	AS_REQUIRE_COMPARE_LE,
80 	AS_REQUIRE_COMPARE_GE,
81 	AS_REQUIRE_COMPARE_GLOB,
82 	AS_REQUIRE_COMPARE_REGEX,
83 	/*< private >*/
84 	AS_REQUIRE_COMPARE_LAST
85 } AsRequireCompare;
86 
87 AsRequire	*as_require_new			(void);
88 
89 /* helpers */
90 AsRequireKind	 as_require_kind_from_string	(const gchar	*kind);
91 const gchar	*as_require_kind_to_string	(AsRequireKind	 kind);
92 AsRequireCompare as_require_compare_from_string	(const gchar	*compare);
93 const gchar	*as_require_compare_to_string	(AsRequireCompare compare);
94 
95 /* getters */
96 AsRequireKind	 as_require_get_kind		(AsRequire	*require);
97 AsRequireCompare as_require_get_compare		(AsRequire	*require);
98 const gchar	*as_require_get_version		(AsRequire	*require);
99 const gchar	*as_require_get_value		(AsRequire	*require);
100 
101 /* setters */
102 void		 as_require_set_kind		(AsRequire	*require,
103 						 AsRequireKind	 kind);
104 void		 as_require_set_compare		(AsRequire	*require,
105 						 AsRequireCompare compare);
106 void		 as_require_set_version		(AsRequire	*require,
107 						 const gchar	*version);
108 void		 as_require_set_value		(AsRequire	*require,
109 						 const gchar	*value);
110 
111 /* object methods */
112 gboolean	 as_require_version_compare	(AsRequire	*require,
113 						 const gchar	*version,
114 						 GError		**error);
115 gboolean	 as_require_equal		(AsRequire	*require1,
116 						 AsRequire	*require2);
117 
118 G_END_DECLS
119