summaryrefslogtreecommitdiffstats
path: root/libgimpconfig/gimpconfig-iface.h
blob: eae41b583b46e4ad811f2fdd7337aac2bb5d06fc (plain)
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
/* LIBGIMP - The GIMP Library
 * Copyright (C) 1995-1997 Spencer Kimball and Peter Mattis
 *
 * Config file serialization and deserialization interface
 * Copyright (C) 2001-2003  Sven Neumann <sven@gimp.org>
 *
 * 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 3 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
 * Library 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, see
 * <https://www.gnu.org/licenses/>.
 */

#if !defined (__GIMP_CONFIG_H_INSIDE__) && !defined (GIMP_CONFIG_COMPILATION)
#error "Only <libgimpconfig/gimpconfig.h> can be included directly."
#endif

#ifndef __GIMP_CONFIG_IFACE_H__
#define __GIMP_CONFIG_IFACE_H__

G_BEGIN_DECLS

/* For information look into the C source or the html documentation */


#define GIMP_TYPE_CONFIG               (gimp_config_get_type ())
#define GIMP_IS_CONFIG(obj)            (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GIMP_TYPE_CONFIG))
#define GIMP_CONFIG(obj)               (G_TYPE_CHECK_INSTANCE_CAST ((obj), GIMP_TYPE_CONFIG, GimpConfig))
#define GIMP_CONFIG_GET_INTERFACE(obj) (G_TYPE_INSTANCE_GET_INTERFACE ((obj), GIMP_TYPE_CONFIG, GimpConfigInterface))


typedef struct _GimpConfigInterface GimpConfigInterface;

struct _GimpConfigInterface
{
  GTypeInterface base_iface;

  gboolean     (* serialize)            (GimpConfig       *config,
                                         GimpConfigWriter *writer,
                                         gpointer          data);
  gboolean     (* deserialize)          (GimpConfig       *config,
                                         GScanner         *scanner,
                                         gint              nest_level,
                                         gpointer          data);
  gboolean     (* serialize_property)   (GimpConfig       *config,
                                         guint             property_id,
                                         const GValue     *value,
                                         GParamSpec       *pspec,
                                         GimpConfigWriter *writer);
  gboolean     (* deserialize_property) (GimpConfig       *config,
                                         guint             property_id,
                                         GValue           *value,
                                         GParamSpec       *pspec,
                                         GScanner         *scanner,
                                         GTokenType       *expected);
  GimpConfig * (* duplicate)            (GimpConfig       *config);
  gboolean     (* equal)                (GimpConfig       *a,
                                         GimpConfig       *b);
  void         (* reset)                (GimpConfig       *config);
  gboolean     (* copy)                 (GimpConfig       *src,
                                         GimpConfig       *dest,
                                         GParamFlags       flags);
};


GType      gimp_config_get_type            (void) G_GNUC_CONST;

GIMP_DEPRECATED_FOR (gimp_config_get_type)
GType      gimp_config_interface_get_type  (void) G_GNUC_CONST;

gboolean   gimp_config_serialize_to_file   (GimpConfig       *config,
                                            const gchar      *filename,
                                            const gchar      *header,
                                            const gchar      *footer,
                                            gpointer          data,
                                            GError          **error);
gboolean   gimp_config_serialize_to_gfile  (GimpConfig       *config,
                                            GFile            *file,
                                            const gchar      *header,
                                            const gchar      *footer,
                                            gpointer          data,
                                            GError          **error);
gboolean   gimp_config_serialize_to_stream (GimpConfig       *config,
                                            GOutputStream    *output,
                                            const gchar      *header,
                                            const gchar      *footer,
                                            gpointer          data,
                                            GError          **error);
gboolean   gimp_config_serialize_to_fd     (GimpConfig       *config,
                                            gint              fd,
                                            gpointer          data);
gchar    * gimp_config_serialize_to_string (GimpConfig       *config,
                                            gpointer          data);
gboolean   gimp_config_deserialize_file    (GimpConfig       *config,
                                            const gchar      *filename,
                                            gpointer          data,
                                            GError          **error);
gboolean   gimp_config_deserialize_gfile   (GimpConfig       *config,
                                            GFile            *file,
                                            gpointer          data,
                                            GError          **error);
gboolean   gimp_config_deserialize_stream  (GimpConfig       *config,
                                            GInputStream     *input,
                                            gpointer          data,
                                            GError          **error);
gboolean   gimp_config_deserialize_string  (GimpConfig       *config,
                                            const gchar      *text,
                                            gint              text_len,
                                            gpointer          data,
                                            GError          **error);
gboolean   gimp_config_deserialize_return  (GScanner         *scanner,
                                            GTokenType        expected_token,
                                            gint              nest_level);

gboolean   gimp_config_serialize           (GimpConfig       *config,
                                            GimpConfigWriter *writer,
                                            gpointer          data);
gboolean   gimp_config_deserialize         (GimpConfig       *config,
                                            GScanner         *scanner,
                                            gint              nest_level,
                                            gpointer          data);
gpointer   gimp_config_duplicate           (GimpConfig       *config);
gboolean   gimp_config_is_equal_to         (GimpConfig       *a,
                                            GimpConfig       *b);
void       gimp_config_reset               (GimpConfig       *config);
gboolean   gimp_config_copy                (GimpConfig       *src,
                                            GimpConfig       *dest,
                                            GParamFlags       flags);


G_END_DECLS

#endif  /* __GIMP_CONFIG_IFACE_H__ */