summaryrefslogtreecommitdiff
path: root/gladeui/glade-signal.c
blob: d3849f60652b1785cb118ade3c70221a2b9a75c7 (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
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
/* -*- Mode: C; tab-width: 8; indent-tabs-mode: t; c-basic-offset: 8 -*- */
/*
 * Copyright (C) 2001 Ximian, Inc.
 *
 * 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 * Authors:
 *   Chema Celorio <chema@celorio.com>
 *   Paolo Borelli <pborelli@katamail.com>
 */

#include "config.h"

#include <string.h>

#include <glib/gi18n-lib.h>

#include "glade.h"
#include "glade-signal.h"
#include "glade-xml-utils.h"

/**
 * glade_signal_new:
 * @name: a name for the signal
 * @handler: a handler function for the signal
 * @after: whether this handler should be called after the default emission phase
 * @swapped: whether the handler's user data should be swapped with the emitter instance.
 *
 * Creates a new #GladeSignal with the given parameters.
 *
 * Returns: the new #GladeSignal
 */
GladeSignal *glade_signal_new (const gchar *name,
			       const gchar *handler,
			       const gchar *userdata,
			       gboolean     after,
			       gboolean     swapped)
{
	GladeSignal *signal = g_slice_new0 (GladeSignal);

	signal->name     = g_strdup (name);
	signal->handler  = g_strdup (handler);
	signal->userdata = userdata ? g_strdup (userdata) : NULL;
	signal->after    = after;
	signal->swapped  = swapped;

	return signal;
}

/**
 * glade_signal_free:
 * @signal: a #GladeSignal
 *
 * Frees @signal and its associated memory.
 */
void
glade_signal_free (GladeSignal *signal)
{
	g_return_if_fail (GLADE_IS_SIGNAL (signal));

	g_free (signal->name);
	g_free (signal->handler);
	g_free (signal->userdata);
	g_free (signal->support_warning);
	g_slice_free (GladeSignal, signal);
}

/**
 * glade_signal_equal:
 * @sig1: a #GladeSignal
 * @sig2: a #GladeSignal
 *
 * Returns: %TRUE if @sig1 and @sig2 have identical attributes, %FALSE otherwise
 */
gboolean
glade_signal_equal (GladeSignal *sig1, GladeSignal *sig2)
{
	gboolean ret = FALSE;
	g_return_val_if_fail (GLADE_IS_SIGNAL (sig1), FALSE);
	g_return_val_if_fail (GLADE_IS_SIGNAL (sig2), FALSE);

	/* Intentionally ignore support_warning */
	if (!strcmp (sig1->name, sig2->name)        &&
	    !strcmp (sig1->handler, sig2->handler)  &&
	    sig1->after   == sig2->after            &&
	    sig1->swapped == sig2->swapped)
	{
		if ((sig1->userdata == NULL && sig2->userdata == NULL) ||
		    (sig1->userdata != NULL && sig2->userdata != NULL  &&
		     !strcmp (sig1->userdata, sig2->userdata)))
			ret = TRUE;
	}

	return ret;
}

/**
 * glade_signal_clone:
 * @signal: a #GladeSignal
 *
 * Returns: a new #GladeSignal with the same attributes as @signal
 */
GladeSignal *
glade_signal_clone (const GladeSignal *signal)
{
	GladeSignal *dup;

	g_return_val_if_fail (GLADE_IS_SIGNAL (signal), NULL);

	dup = glade_signal_new (signal->name,
				signal->handler,
				signal->userdata,
				signal->after,
				signal->swapped);

	glade_signal_set_support_warning (dup, signal->support_warning);
	
	return dup;
}

/**
 * glade_signal_write:
 * @signal: The #GladeSignal
 * @fmt: The #GladeProjectFormat to write the signal for
 * @context: A #GladeXmlContext
 * @node: A #GladeXmlNode
 *
 * Writes @signal to @node
 */
void
glade_signal_write (GladeSignal       *signal,
		    GladeProjectFormat fmt,
		    GladeXmlContext   *context,
		    GladeXmlNode      *node)
{
	GladeXmlNode *signal_node;
	gchar        *name;

	/*  Should assert GLADE_XML_TAG_WIDGET tag here, but no 
	 * access to project, so not really seriosly needed 
	 */

	name = g_strdup (signal->name);

	if (fmt == GLADE_PROJECT_FORMAT_LIBGLADE)
		glade_util_replace (name, '-', '_');

	/* Now dump the node values... */
	signal_node = glade_xml_node_new (context, GLADE_XML_TAG_SIGNAL);
	glade_xml_node_append_child (node, signal_node);

	glade_xml_node_set_property_string (signal_node, GLADE_XML_TAG_NAME, name);
	glade_xml_node_set_property_string (signal_node, GLADE_XML_TAG_HANDLER, signal->handler);

	if (signal->userdata)
		glade_xml_node_set_property_string (signal_node, 
						    GLADE_XML_TAG_OBJECT, 
						    signal->userdata);

	if (signal->after)
		glade_xml_node_set_property_string (signal_node, 
						    GLADE_XML_TAG_AFTER, 
						    GLADE_XML_TAG_SIGNAL_TRUE);

	/* Always serialize swapped regardless of format (libglade should not complain about this
	 * and we prefer to not lose data in conversions).
	 */
	glade_xml_node_set_property_string (signal_node, 
					    GLADE_XML_TAG_SWAPPED,
					    signal->swapped ? 
					    GLADE_XML_TAG_SIGNAL_TRUE : GLADE_XML_TAG_SIGNAL_FALSE);

	g_free (name);
}


/**
 * glade_signal_read:
 * @node: The #GladeXmlNode to read
 *
 * Reads and creates a ner #GladeSignal based on @node
 *
 * Returns: A newly created #GladeSignal
 */
GladeSignal *
glade_signal_read (GladeXmlNode *node)
{
	GladeSignal *signal;
	gchar *name, *handler;

	g_return_val_if_fail (glade_xml_node_verify_silent 
			      (node, GLADE_XML_TAG_SIGNAL), NULL);

	if (!(name = 
	      glade_xml_get_property_string_required (node, GLADE_XML_TAG_NAME, NULL)))
		return NULL;
	glade_util_replace (name, '_', '-');

	if (!(handler = 
	      glade_xml_get_property_string_required (node, GLADE_XML_TAG_HANDLER, NULL)))
	{
		g_free (name);
		return NULL;
	}

	signal = g_new0 (GladeSignal, 1);
	signal->name     = name;
	signal->handler  = handler;
	signal->after    = glade_xml_get_property_boolean (node, GLADE_XML_TAG_AFTER, FALSE);
	signal->userdata = glade_xml_get_property_string (node, GLADE_XML_TAG_OBJECT);
	signal->swapped  = glade_xml_get_property_boolean (node, GLADE_XML_TAG_SWAPPED, 
							   /* If a signal specifies an object, its swapped
							    * by default behaviour in GtkBuilder */
							   signal->userdata != NULL);

	return signal;
}

void
glade_signal_set_support_warning (GladeSignal *signal,
				  const gchar *support_warning)
{
	g_return_if_fail (GLADE_IS_SIGNAL (signal));

	if (g_strcmp0 (signal->support_warning, support_warning))
	{
		g_free (signal->support_warning);
		signal->support_warning = 
			support_warning ? g_strdup (support_warning) : NULL;
	}
}