1 /* GIMP - The GNU Image Manipulation Program
2  * Copyright (C) 1995 Spencer Kimball and Peter Mattis
3  *
4  * gimptag.h
5  * Copyright (C) 2008 Aurimas Juška <aurisj@svn.gnome.org>
6  *
7  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
19  */
20 
21 #ifndef __GIMP_TAG_H__
22 #define __GIMP_TAG_H__
23 
24 
25 #include <glib-object.h>
26 
27 
28 #define GIMP_TYPE_TAG            (gimp_tag_get_type ())
29 #define GIMP_TAG(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), GIMP_TYPE_TAG, GimpTag))
30 #define GIMP_TAG_CLASS(klass)    (G_TYPE_CHECK_CLASS_CAST ((klass), GIMP_TYPE_TAG, GimpTagClass))
31 #define GIMP_IS_TAG(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GIMP_TYPE_TAG))
32 #define GIMP_IS_TAG_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE ((klass), GIMP_TYPE_TAG))
33 #define GIMP_TAG_GET_CLASS(obj)  (G_TYPE_INSTANCE_GET_CLASS ((obj), GIMP_TYPE_TAG, GimpTagClass))
34 
35 
36 typedef struct _GimpTagClass    GimpTagClass;
37 
38 struct _GimpTag
39 {
40   GObject parent_instance;
41 
42   GQuark  tag;
43   GQuark  collate_key;
44 
45   gboolean internal; /* Tags that are not serialized to disk */
46 };
47 
48 struct _GimpTagClass
49 {
50   GObjectClass parent_class;
51 };
52 
53 GType         gimp_tag_get_type            (void) G_GNUC_CONST;
54 
55 GimpTag     * gimp_tag_new                 (const gchar *tag_string);
56 GimpTag     * gimp_tag_try_new             (const gchar *tag_string);
57 
58 const gchar * gimp_tag_get_name            (GimpTag     *tag);
59 guint         gimp_tag_get_hash            (GimpTag     *tag);
60 
61 gboolean      gimp_tag_get_internal        (GimpTag     *tag);
62 void          gimp_tag_set_internal        (GimpTag     *tag,
63                                             gboolean     internal);
64 
65 gboolean      gimp_tag_equals              (GimpTag     *tag,
66                                             GimpTag     *other);
67 gint          gimp_tag_compare_func        (const void  *p1,
68                                             const void  *p2);
69 gint          gimp_tag_compare_with_string (GimpTag     *tag,
70                                             const gchar *tag_string);
71 gboolean      gimp_tag_has_prefix          (GimpTag     *tag,
72                                             const gchar *prefix_string);
73 gchar       * gimp_tag_string_make_valid   (const gchar *tag_string);
74 gboolean      gimp_tag_is_tag_separator    (gunichar     c);
75 
76 void          gimp_tag_or_null_ref         (GimpTag     *tag_or_null);
77 void          gimp_tag_or_null_unref       (GimpTag     *tag_or_null);
78 
79 
80 #endif /* __GIMP_TAG_H__ */
81