1 | /* |
2 | * Copyright © 2020 Benjamin Otte |
3 | * |
4 | * This library is free software; you can redistribute it and/or |
5 | * modify it under the terms of the GNU Lesser General Public |
6 | * License as published by the Free Software Foundation; either |
7 | * version 2.1 of the License, or (at your option) any later version. |
8 | * |
9 | * This library is distributed in the hope that it will be useful, |
10 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
11 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
12 | * Lesser General Public License for more details. |
13 | * |
14 | * You should have received a copy of the GNU Lesser General Public |
15 | * License along with this library. If not, see <http://www.gnu.org/licenses/>. |
16 | * |
17 | * Authors: Benjamin Otte <otte@gnome.org> |
18 | */ |
19 | |
20 | |
21 | #ifndef __GTK_BITSET_H__ |
22 | #define __GTK_BITSET_H__ |
23 | |
24 | #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION) |
25 | #error "Only <gtk/gtk.h> can be included directly." |
26 | #endif |
27 | |
28 | #include <gtk/gtktypes.h> |
29 | |
30 | G_BEGIN_DECLS |
31 | |
32 | #define GTK_TYPE_BITSET (gtk_bitset_get_type ()) |
33 | |
34 | GDK_AVAILABLE_IN_ALL |
35 | GType gtk_bitset_get_type (void) G_GNUC_CONST; |
36 | |
37 | GDK_AVAILABLE_IN_ALL |
38 | GtkBitset * gtk_bitset_ref (GtkBitset *self); |
39 | GDK_AVAILABLE_IN_ALL |
40 | void gtk_bitset_unref (GtkBitset *self); |
41 | G_DEFINE_AUTOPTR_CLEANUP_FUNC(GtkBitset, gtk_bitset_unref) |
42 | |
43 | GDK_AVAILABLE_IN_ALL |
44 | gboolean gtk_bitset_contains (const GtkBitset *self, |
45 | guint value); |
46 | GDK_AVAILABLE_IN_ALL |
47 | gboolean gtk_bitset_is_empty (const GtkBitset *self); |
48 | GDK_AVAILABLE_IN_ALL |
49 | gboolean gtk_bitset_equals (const GtkBitset *self, |
50 | const GtkBitset *other); |
51 | GDK_AVAILABLE_IN_ALL |
52 | guint64 gtk_bitset_get_size (const GtkBitset *self); |
53 | GDK_AVAILABLE_IN_ALL |
54 | guint64 gtk_bitset_get_size_in_range (const GtkBitset *self, |
55 | guint first, |
56 | guint last); |
57 | GDK_AVAILABLE_IN_ALL |
58 | guint gtk_bitset_get_nth (const GtkBitset *self, |
59 | guint nth); |
60 | GDK_AVAILABLE_IN_ALL |
61 | guint gtk_bitset_get_minimum (const GtkBitset *self); |
62 | GDK_AVAILABLE_IN_ALL |
63 | guint gtk_bitset_get_maximum (const GtkBitset *self); |
64 | |
65 | GDK_AVAILABLE_IN_ALL |
66 | GtkBitset * gtk_bitset_new_empty (void); |
67 | GDK_AVAILABLE_IN_ALL |
68 | GtkBitset * gtk_bitset_copy (const GtkBitset *self); |
69 | GDK_AVAILABLE_IN_ALL |
70 | GtkBitset * gtk_bitset_new_range (guint start, |
71 | guint n_items); |
72 | |
73 | GDK_AVAILABLE_IN_ALL |
74 | void gtk_bitset_remove_all (GtkBitset *self); |
75 | GDK_AVAILABLE_IN_ALL |
76 | gboolean gtk_bitset_add (GtkBitset *self, |
77 | guint value); |
78 | GDK_AVAILABLE_IN_ALL |
79 | gboolean gtk_bitset_remove (GtkBitset *self, |
80 | guint value); |
81 | GDK_AVAILABLE_IN_ALL |
82 | void gtk_bitset_add_range (GtkBitset *self, |
83 | guint start, |
84 | guint n_items); |
85 | GDK_AVAILABLE_IN_ALL |
86 | void gtk_bitset_remove_range (GtkBitset *self, |
87 | guint start, |
88 | guint n_items); |
89 | GDK_AVAILABLE_IN_ALL |
90 | void gtk_bitset_add_range_closed (GtkBitset *self, |
91 | guint first, |
92 | guint last); |
93 | GDK_AVAILABLE_IN_ALL |
94 | void gtk_bitset_remove_range_closed (GtkBitset *self, |
95 | guint first, |
96 | guint last); |
97 | GDK_AVAILABLE_IN_ALL |
98 | void gtk_bitset_add_rectangle (GtkBitset *self, |
99 | guint start, |
100 | guint width, |
101 | guint height, |
102 | guint stride); |
103 | GDK_AVAILABLE_IN_ALL |
104 | void gtk_bitset_remove_rectangle (GtkBitset *self, |
105 | guint start, |
106 | guint width, |
107 | guint height, |
108 | guint stride); |
109 | |
110 | GDK_AVAILABLE_IN_ALL |
111 | void gtk_bitset_union (GtkBitset *self, |
112 | const GtkBitset *other); |
113 | GDK_AVAILABLE_IN_ALL |
114 | void gtk_bitset_intersect (GtkBitset *self, |
115 | const GtkBitset *other); |
116 | GDK_AVAILABLE_IN_ALL |
117 | void gtk_bitset_subtract (GtkBitset *self, |
118 | const GtkBitset *other); |
119 | GDK_AVAILABLE_IN_ALL |
120 | void gtk_bitset_difference (GtkBitset *self, |
121 | const GtkBitset *other); |
122 | GDK_AVAILABLE_IN_ALL |
123 | void gtk_bitset_shift_left (GtkBitset *self, |
124 | guint amount); |
125 | GDK_AVAILABLE_IN_ALL |
126 | void gtk_bitset_shift_right (GtkBitset *self, |
127 | guint amount); |
128 | GDK_AVAILABLE_IN_ALL |
129 | void gtk_bitset_splice (GtkBitset *self, |
130 | guint position, |
131 | guint removed, |
132 | guint added); |
133 | |
134 | /** |
135 | * GtkBitsetIter: |
136 | * |
137 | * An opaque, stack-allocated struct for iterating |
138 | * over the elements of a `GtkBitset`. |
139 | * |
140 | * Before a `GtkBitsetIter` can be used, it needs to be initialized with |
141 | * [func@Gtk.BitsetIter.init_first], [func@Gtk.BitsetIter.init_last] |
142 | * or [func@Gtk.BitsetIter.init_at]. |
143 | */ |
144 | typedef struct _GtkBitsetIter GtkBitsetIter; |
145 | |
146 | struct _GtkBitsetIter |
147 | { |
148 | /*< private >*/ |
149 | gpointer private_data[10]; |
150 | }; |
151 | |
152 | GDK_AVAILABLE_IN_4_6 |
153 | GType gtk_bitset_iter_get_type (void) G_GNUC_CONST; |
154 | |
155 | GDK_AVAILABLE_IN_ALL |
156 | gboolean gtk_bitset_iter_init_first (GtkBitsetIter *iter, |
157 | const GtkBitset *set, |
158 | guint *value); |
159 | GDK_AVAILABLE_IN_ALL |
160 | gboolean gtk_bitset_iter_init_last (GtkBitsetIter *iter, |
161 | const GtkBitset *set, |
162 | guint *value); |
163 | GDK_AVAILABLE_IN_ALL |
164 | gboolean gtk_bitset_iter_init_at (GtkBitsetIter *iter, |
165 | const GtkBitset *set, |
166 | guint target, |
167 | guint *value); |
168 | GDK_AVAILABLE_IN_ALL |
169 | gboolean gtk_bitset_iter_next (GtkBitsetIter *iter, |
170 | guint *value); |
171 | GDK_AVAILABLE_IN_ALL |
172 | gboolean gtk_bitset_iter_previous (GtkBitsetIter *iter, |
173 | guint *value); |
174 | GDK_AVAILABLE_IN_ALL |
175 | guint gtk_bitset_iter_get_value (const GtkBitsetIter *iter); |
176 | GDK_AVAILABLE_IN_ALL |
177 | gboolean gtk_bitset_iter_is_valid (const GtkBitsetIter *iter); |
178 | |
179 | G_END_DECLS |
180 | |
181 | #endif /* __GTK_BITSET_H__ */ |
182 | |