summaryrefslogtreecommitdiff
path: root/mate-settings-daemon/mate-settings-plugin.h
blob: 1786f02374f14d7eda88d6559a2712c81a260807 (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
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 8 -*-
 *
 * Copyright (C) 2002-2005 Paolo Maggi
 * Copyright (C) 2007      William Jon McCann <mccann@jhu.edu>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA 02111-1307, USA.
 */

#ifndef __MATE_SETTINGS_PLUGIN_H__
#define __MATE_SETTINGS_PLUGIN_H__

#include <glib-object.h>
#include <gmodule.h>

#ifdef __cplusplus
extern "C" {
#endif
#define MATE_TYPE_SETTINGS_PLUGIN              (mate_settings_plugin_get_type())
#define MATE_SETTINGS_PLUGIN(obj)              (G_TYPE_CHECK_INSTANCE_CAST((obj), MATE_TYPE_SETTINGS_PLUGIN, MateSettingsPlugin))
#define MATE_SETTINGS_PLUGIN_CLASS(klass)      (G_TYPE_CHECK_CLASS_CAST((klass),  MATE_TYPE_SETTINGS_PLUGIN, MateSettingsPluginClass))
#define MATE_IS_SETTINGS_PLUGIN(obj)           (G_TYPE_CHECK_INSTANCE_TYPE((obj), MATE_TYPE_SETTINGS_PLUGIN))
#define MATE_IS_SETTINGS_PLUGIN_CLASS(klass)   (G_TYPE_CHECK_CLASS_TYPE ((klass), MATE_TYPE_SETTINGS_PLUGIN))
#define MATE_SETTINGS_PLUGIN_GET_CLASS(obj)    (G_TYPE_INSTANCE_GET_CLASS((obj),  MATE_TYPE_SETTINGS_PLUGIN, MateSettingsPluginClass))

typedef struct
{
        GObject parent;
} MateSettingsPlugin;

typedef struct
{
        GObjectClass parent_class;

        /* Virtual public methods */
        void            (*activate)                     (MateSettingsPlugin *plugin);
        void            (*deactivate)                   (MateSettingsPlugin *plugin);
} MateSettingsPluginClass;

GType            mate_settings_plugin_get_type           (void) G_GNUC_CONST;

void             mate_settings_plugin_activate           (MateSettingsPlugin *plugin);
void             mate_settings_plugin_deactivate         (MateSettingsPlugin *plugin);

/*
 * Utility macro used to register plugins
 *
 * use: MATE_SETTINGS_PLUGIN_REGISTER (PluginName, plugin_name)
 */
#define MATE_SETTINGS_PLUGIN_REGISTER(PluginName, plugin_name)                   \
                                                                                \
static GType plugin_name##_type = 0;                                            \
static GTypeModule *plugin_module_type = 0;                                     \
                                                                                \
GType                                                                           \
plugin_name##_get_type (void)                                                   \
{                                                                               \
        return plugin_name##_type;                                              \
}                                                                               \
                                                                                \
static void     plugin_name##_init              (PluginName        *self);      \
static void     plugin_name##_class_init        (PluginName##Class *klass);     \
static gpointer plugin_name##_parent_class = NULL;                              \
static void     plugin_name##_class_intern_init (gpointer klass)                \
{                                                                               \
        plugin_name##_parent_class = g_type_class_peek_parent (klass);          \
        plugin_name##_class_init ((PluginName##Class *) klass);                 \
}                                                                               \
                                                                                \
G_MODULE_EXPORT GType                                                           \
register_mate_settings_plugin (GTypeModule *module)                              \
{                                                                               \
        static const GTypeInfo our_info =                                       \
        {                                                                       \
                sizeof (PluginName##Class),                                     \
                NULL, /* base_init */                                           \
                NULL, /* base_finalize */                                       \
                (GClassInitFunc) plugin_name##_class_intern_init,               \
                NULL,                                                           \
                NULL, /* class_data */                                          \
                sizeof (PluginName),                                            \
                0, /* n_preallocs */                                            \
                (GInstanceInitFunc) plugin_name##_init                          \
        };                                                                      \
                                                                                \
        g_debug ("Registering " #PluginName);                                   \
                                                                                \
        /* Initialise the i18n stuff */                                         \
        bindtextdomain (GETTEXT_PACKAGE, MATE_SETTINGS_LOCALEDIR);               \
        bind_textdomain_codeset (GETTEXT_PACKAGE, "UTF-8");                     \
                                                                                \
        plugin_module_type = module;                                            \
        plugin_name##_type = g_type_module_register_type (module,               \
                                            MATE_TYPE_SETTINGS_PLUGIN,           \
                                            #PluginName,                        \
                                            &our_info,                          \
                                            0);                                 \
                                                                                \
        return plugin_name##_type;                                              \
}

/*
 * Utility macro used to register gobject types in plugins with additional code
 *
 * use: MATE_SETTINGS_PLUGIN_DEFINE_TYPE_WITH_CODE(ObjectName, object_name, PARENT_TYPE, CODE)
 */
#define MATE_SETTINGS_PLUGIN_DEFINE_TYPE_WITH_CODE(ObjectName, object_name, PARENT_TYPE, CODE)   \
static void     object_name##_init              (ObjectName        *self);      \
static void     object_name##_class_init        (ObjectName##Class *klass);     \
static gpointer object_name##_parent_class = ((void *)0);                       \
static GType    ojbect_name##_type_id = 0;                                      \
                                                                                \
static void     object_name##_class_intern_init (gpointer klass)                \
{                                                                               \
        object_name##_parent_class = g_type_class_peek_parent (klass);          \
        object_name##_class_init ((ObjectName##Class *) klass);                 \
}                                                                               \
                                                                                \
                                                                                \
GType                                                                           \
object_name##_get_type (void)                                                   \
{                                                                               \
        g_assert (object_name##_type_id != 0);                                  \
                                                                                \
        return object_name##_type_id;                                           \
}                                                                               \
                                                                                \
GType                                                                           \
object_name##_register_type (GTypeModule *module)                               \
{                                                                               \
        if ((object_name##_type_id == 0)) {                                     \
                const GTypeInfo g_define_type_info = {                          \
                        sizeof (ObjectName##Class),                             \
                        (GBaseInitFunc) ((void *)0),                            \
                        (GBaseFinalizeFunc) ((void *)0),                        \
                        (GClassInitFunc) object_name##_class_intern_init,       \
                        (GClassFinalizeFunc) ((void *)0),                       \
                        ((void *)0),                                            \
                        sizeof (ObjectName),                                    \
                        0,                                                      \
                        (GInstanceInitFunc) object_name##_init,                 \
                        ((void *)0)                                             \
                };                                                              \
                object_name##_type_id =                                         \
                        g_type_module_register_type (module,                    \
                                                     PARENT_TYPE,               \
                                                     #ObjectName,               \
                                                     &g_define_type_info,       \
                                                     (GTypeFlags) 0);           \
        }                                                                       \
                                                                                \
        g_debug ("Registering " #ObjectName);                                   \
                                                                                \
        CODE                                                                    \
                                                                                \
        return type_name##_type_id;                                             \
}

/*
 * Utility macro used to register gobject types in plugins
 *
 * use: MATE_SETTINGS_PLUGIN_DEFINE_TYPE(ObjectName, object_name, PARENT_TYPE)
 */
#define MATE_SETTINGS_PLUGIN_DEFINE_TYPE(ObjectName, object_name, PARENT_TYPE)           \
        MATE_SETTINGS_PLUGIN_DEFINE_TYPE_WITH_CODE(ObjectName, object_name, PARENT_TYPE, ;)

#ifdef __cplusplus
}
#endif

#endif  /* __MATE_SETTINGS_PLUGIN_H__ */