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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
/*
* peas-extension-base.c
* This file is part of libpeas
*
* Copyright (C) 2002-2008 Paolo Maggi
* Copyright (C) 2009 Steve Frécinaux
*
* libpeas 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 2.1 of the License, or (at your option) any later version.
*
* libpeas 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
* Lesser 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, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* SPDX-License-Identifier: LGPL-2.1-or-later
*/
#include "config.h"
#include "peas-extension-base.h"
#include "peas-plugin-info-priv.h"
/**
* PeasExtensionBase:
*
* Base class for C extensions.
*
* #PeasExtensionBase can optionally be used as a base class for the extensions
* of your plugin. By inheriting from it, you will make your extension able to
* access the related [struct@PluginInfo], and especially the location where all
* the data of your plugin lives.
*
* Non-C extensions will usually not inherit from this class: Python
* plugins automatically get a "plugin_info" attribute that serves
* the same purpose.
**/
typedef struct _PeasExtensionBasePrivate
{
PeasPluginInfo *info;
} PeasExtensionBasePrivate;
/* properties */
enum {
PROP_0,
PROP_PLUGIN_INFO,
PROP_DATA_DIR,
N_PROPERTIES
};
static GParamSpec *properties[N_PROPERTIES] = { NULL };
G_DEFINE_ABSTRACT_TYPE_WITH_PRIVATE (PeasExtensionBase, peas_extension_base, G_TYPE_OBJECT)
static void
peas_extension_base_finalize (GObject *object)
{
PeasExtensionBase *extbase = PEAS_EXTENSION_BASE (object);
PeasExtensionBasePrivate *priv = peas_extension_base_get_instance_private (extbase);
g_clear_object (&priv->info);
G_OBJECT_CLASS (peas_extension_base_parent_class)->finalize (object);
}
static void
peas_extension_base_get_property (GObject *object,
guint prop_id,
GValue *value,
GParamSpec *pspec)
{
PeasExtensionBase *extbase = PEAS_EXTENSION_BASE (object);
switch (prop_id)
{
case PROP_PLUGIN_INFO:
g_value_set_object (value, peas_extension_base_get_plugin_info (extbase));
break;
case PROP_DATA_DIR:
g_value_take_string (value, peas_extension_base_get_data_dir (extbase));
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static void
peas_extension_base_set_property (GObject *object,
guint prop_id,
const GValue *value,
GParamSpec *pspec)
{
PeasExtensionBase *extbase = PEAS_EXTENSION_BASE (object);
PeasExtensionBasePrivate *priv = peas_extension_base_get_instance_private (extbase);
switch (prop_id)
{
case PROP_PLUGIN_INFO:
priv->info = g_value_dup_object (value);
break;
default:
G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
break;
}
}
static void
peas_extension_base_init (PeasExtensionBase *extbase)
{
}
static void
peas_extension_base_class_init (PeasExtensionBaseClass *klass)
{
GObjectClass *object_class = G_OBJECT_CLASS (klass);
object_class->finalize = peas_extension_base_finalize;
object_class->get_property = peas_extension_base_get_property;
object_class->set_property = peas_extension_base_set_property;
/**
* PeasExtensionBase:plugin-info:
*
* The [struct@PluginInfo] related to the current plugin.
*/
properties[PROP_PLUGIN_INFO] =
g_param_spec_object ("plugin-info",
"Plugin Information",
"Information related to the current plugin",
PEAS_TYPE_PLUGIN_INFO,
G_PARAM_READWRITE |
G_PARAM_CONSTRUCT_ONLY |
G_PARAM_STATIC_STRINGS);
/**
* PeasExtensionBase:data-dir:
*
* The The full path of the directory where the plugin
* should look for its data files.
*
* Note: This is the same path as that returned by
* [method@PluginInfo.get_data_dir].
*/
properties[PROP_DATA_DIR] =
g_param_spec_string ("data-dir",
"Data Directory",
"The full path of the directory where the "
"plugin should look for its data files",
NULL,
G_PARAM_READABLE |
G_PARAM_STATIC_STRINGS);
g_object_class_install_properties (object_class, N_PROPERTIES, properties);
}
/**
* peas_extension_base_get_plugin_info:
* @extbase: A #PeasExtensionBase.
*
* Get information relative to @extbase.
*
* Returns: (transfer none): the [struct@PluginInfo] relative
* to the #PeasExtensionBase.
*/
PeasPluginInfo *
peas_extension_base_get_plugin_info (PeasExtensionBase *extbase)
{
PeasExtensionBasePrivate *priv = peas_extension_base_get_instance_private (extbase);
g_return_val_if_fail (PEAS_IS_EXTENSION_BASE (extbase), NULL);
return priv->info;
}
/**
* peas_extension_base_get_data_dir:
* @extbase: A #PeasExtensionBase.
*
* Get the path of the directory where the plugin should look for
* its data files.
*
* Returns: A newly allocated string with the path of the
* directory where the plugin should look for its data files
*/
char *
peas_extension_base_get_data_dir (PeasExtensionBase *extbase)
{
PeasExtensionBasePrivate *priv = peas_extension_base_get_instance_private (extbase);
g_return_val_if_fail (PEAS_IS_EXTENSION_BASE (extbase), NULL);
return g_strdup (peas_plugin_info_get_data_dir (priv->info));
}
|
