1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*-
2 * GObject introspection: Dump introspection data
4 * Copyright (C) 2008 Colin Walters <walters@verbum.org>
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the
18 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, USA.
25 #include <glib-object.h>
28 /* This file is both compiled into libgirepository.so, and installed
29 * on the filesystem. But for the dumper, we want to avoid linking
30 * to libgirepository; see
31 * https://bugzilla.gnome.org/show_bug.cgi?id=630342
33 #ifdef G_IREPOSITORY_COMPILATION
35 #include "girepository.h"
41 escaped_printf (GOutputStream *out, const char *fmt, ...)
50 str = g_markup_vprintf_escaped (fmt, args);
51 if (!g_output_stream_write_all (out, str, strlen (str), &written, NULL, &error))
53 g_critical ("failed to write to iochannel: %s", error->message);
54 g_clear_error (&error);
62 goutput_write (GOutputStream *out, const char *str)
66 if (!g_output_stream_write_all (out, str, strlen (str), &written, NULL, &error))
68 g_critical ("failed to write to iochannel: %s", error->message);
69 g_clear_error (&error);
73 typedef GType (*GetTypeFunc)(void);
74 typedef GQuark (*ErrorQuarkFunc)(void);
77 invoke_get_type (GModule *self, const char *symbol, GError **error)
82 if (!g_module_symbol (self, symbol, (void**)&sym))
87 "Failed to find symbol '%s'", symbol);
88 return G_TYPE_INVALID;
92 if (ret == G_TYPE_INVALID)
97 "Function '%s' returned G_TYPE_INVALID", symbol);
103 invoke_error_quark (GModule *self, const char *symbol, GError **error)
107 if (!g_module_symbol (self, symbol, (void**)&sym))
112 "Failed to find symbol '%s'", symbol);
113 return G_TYPE_INVALID;
120 dump_properties (GType type, GOutputStream *out)
126 if (G_TYPE_FUNDAMENTAL (type) == G_TYPE_OBJECT)
129 klass = g_type_class_ref (type);
130 props = g_object_class_list_properties (klass, &n_properties);
135 klass = g_type_default_interface_ref (type);
136 props = g_object_interface_list_properties (klass, &n_properties);
139 for (i = 0; i < n_properties; i++)
144 if (prop->owner_type != type)
147 escaped_printf (out, " <property name=\"%s\" type=\"%s\" flags=\"%d\"/>\n",
148 prop->name, g_type_name (prop->value_type), prop->flags);
154 dump_signals (GType type, GOutputStream *out)
160 sig_ids = g_signal_list_ids (type, &n_sigs);
161 for (i = 0; i < n_sigs; i++)
168 g_signal_query (sigid, &query);
170 escaped_printf (out, " <signal name=\"%s\" return=\"%s\"",
171 query.signal_name, g_type_name (query.return_type));
173 if (query.signal_flags & G_SIGNAL_RUN_FIRST)
174 escaped_printf (out, " when=\"first\"");
175 else if (query.signal_flags & G_SIGNAL_RUN_LAST)
176 escaped_printf (out, " when=\"last\"");
177 else if (query.signal_flags & G_SIGNAL_RUN_CLEANUP)
178 escaped_printf (out, " when=\"cleanup\"");
179 #if GLIB_CHECK_VERSION(2, 29, 15)
180 else if (query.signal_flags & G_SIGNAL_MUST_COLLECT)
181 escaped_printf (out, " when=\"must-collect\"");
183 if (query.signal_flags & G_SIGNAL_NO_RECURSE)
184 escaped_printf (out, " no-recurse=\"1\"");
186 if (query.signal_flags & G_SIGNAL_DETAILED)
187 escaped_printf (out, " detailed=\"1\"");
189 if (query.signal_flags & G_SIGNAL_ACTION)
190 escaped_printf (out, " action=\"1\"");
192 if (query.signal_flags & G_SIGNAL_NO_HOOKS)
193 escaped_printf (out, " no-hooks=\"1\"");
195 goutput_write (out, ">\n");
197 for (j = 0; j < query.n_params; j++)
199 escaped_printf (out, " <param type=\"%s\"/>\n",
200 g_type_name (query.param_types[j]));
202 goutput_write (out, " </signal>\n");
207 dump_object_type (GType type, const char *symbol, GOutputStream *out)
213 escaped_printf (out, " <class name=\"%s\" get-type=\"%s\"",
214 g_type_name (type), symbol);
215 if (type != G_TYPE_OBJECT)
219 gboolean first = TRUE;
221 parent = g_type_parent (type);
222 parent_str = g_string_new ("");
223 while (parent != G_TYPE_INVALID)
228 g_string_append_c (parent_str, ',');
229 g_string_append (parent_str, g_type_name (parent));
230 parent = g_type_parent (parent);
233 escaped_printf (out, " parents=\"%s\"", parent_str->str);
235 g_string_free (parent_str, TRUE);
238 if (G_TYPE_IS_ABSTRACT (type))
239 escaped_printf (out, " abstract=\"1\"");
240 goutput_write (out, ">\n");
242 interfaces = g_type_interfaces (type, &n_interfaces);
243 for (i = 0; i < n_interfaces; i++)
245 GType itype = interfaces[i];
246 escaped_printf (out, " <implements name=\"%s\"/>\n",
247 g_type_name (itype));
249 dump_properties (type, out);
250 dump_signals (type, out);
251 goutput_write (out, " </class>\n");
255 dump_interface_type (GType type, const char *symbol, GOutputStream *out)
261 escaped_printf (out, " <interface name=\"%s\" get-type=\"%s\">\n",
262 g_type_name (type), symbol);
264 interfaces = g_type_interface_prerequisites (type, &n_interfaces);
265 for (i = 0; i < n_interfaces; i++)
267 GType itype = interfaces[i];
268 if (itype == G_TYPE_OBJECT)
270 /* Treat this as implicit for now; in theory GInterfaces are
271 * supported on things like GstMiniObject, but right now
272 * the introspection system only supports GObject.
273 * http://bugzilla.gnome.org/show_bug.cgi?id=559706
277 escaped_printf (out, " <prerequisite name=\"%s\"/>\n",
278 g_type_name (itype));
280 dump_properties (type, out);
281 dump_signals (type, out);
282 goutput_write (out, " </interface>\n");
286 dump_boxed_type (GType type, const char *symbol, GOutputStream *out)
288 escaped_printf (out, " <boxed name=\"%s\" get-type=\"%s\"/>\n",
289 g_type_name (type), symbol);
293 dump_flags_type (GType type, const char *symbol, GOutputStream *out)
298 klass = g_type_class_ref (type);
299 escaped_printf (out, " <flags name=\"%s\" get-type=\"%s\">\n",
300 g_type_name (type), symbol);
302 for (i = 0; i < klass->n_values; i++)
304 GFlagsValue *value = &(klass->values[i]);
306 escaped_printf (out, " <member name=\"%s\" nick=\"%s\" value=\"%d\"/>\n",
307 value->value_name, value->value_nick, value->value);
309 goutput_write (out, " </flags>\n");
313 dump_enum_type (GType type, const char *symbol, GOutputStream *out)
318 klass = g_type_class_ref (type);
319 escaped_printf (out, " <enum name=\"%s\" get-type=\"%s\">\n",
320 g_type_name (type), symbol);
322 for (i = 0; i < klass->n_values; i++)
324 GEnumValue *value = &(klass->values[i]);
326 escaped_printf (out, " <member name=\"%s\" nick=\"%s\" value=\"%d\"/>\n",
327 value->value_name, value->value_nick, value->value);
329 goutput_write (out, " </enum>");
333 dump_fundamental_type (GType type, const char *symbol, GOutputStream *out)
340 gboolean first = TRUE;
343 escaped_printf (out, " <fundamental name=\"%s\" get-type=\"%s\"",
344 g_type_name (type), symbol);
346 if (G_TYPE_IS_ABSTRACT (type))
347 escaped_printf (out, " abstract=\"1\"");
349 if (G_TYPE_IS_INSTANTIATABLE (type))
350 escaped_printf (out, " instantiatable=\"1\"");
352 parent = g_type_parent (type);
353 parent_str = g_string_new ("");
354 while (parent != G_TYPE_INVALID)
359 g_string_append_c (parent_str, ',');
360 if (!g_type_name (parent))
362 g_string_append (parent_str, g_type_name (parent));
363 parent = g_type_parent (parent);
366 if (parent_str->len > 0)
367 escaped_printf (out, " parents=\"%s\"", parent_str->str);
368 g_string_free (parent_str, TRUE);
370 goutput_write (out, ">\n");
372 interfaces = g_type_interfaces (type, &n_interfaces);
373 for (i = 0; i < n_interfaces; i++)
375 GType itype = interfaces[i];
376 escaped_printf (out, " <implements name=\"%s\"/>\n",
377 g_type_name (itype));
379 goutput_write (out, " </fundamental>\n");
383 dump_type (GType type, const char *symbol, GOutputStream *out)
385 switch (g_type_fundamental (type))
388 dump_object_type (type, symbol, out);
390 case G_TYPE_INTERFACE:
391 dump_interface_type (type, symbol, out);
394 dump_boxed_type (type, symbol, out);
397 dump_flags_type (type, symbol, out);
400 dump_enum_type (type, symbol, out);
403 /* GValue, etc. Just skip them. */
406 dump_fundamental_type (type, symbol, out);
412 dump_error_quark (GQuark quark, const char *symbol, GOutputStream *out)
414 escaped_printf (out, " <error-quark function=\"%s\" domain=\"%s\"/>\n",
415 symbol, g_quark_to_string (quark));
419 * g_irepository_dump:
420 * @arg: Comma-separated pair of input and output filenames
423 * Argument specified is a comma-separated pair of filenames; i.e. of
424 * the form "input.txt,output.xml". The input file should be a
425 * UTF-8 Unix-line-ending text file, with each line containing the name
426 * of a GType _get_type function.
428 * The output file should already exist, but be empty. This function will
429 * overwrite its contents.
431 * Returns: %TRUE on success, %FALSE on error
433 #ifndef G_IREPOSITORY_COMPILATION
435 dump_irepository (const char *arg, GError **error) G_GNUC_UNUSED;
437 dump_irepository (const char *arg, GError **error)
440 g_irepository_dump (const char *arg, GError **error)
443 GHashTable *output_types;
447 GFileInputStream *input;
448 GFileOutputStream *output;
449 GDataInputStream *in;
451 gboolean caught_error = FALSE;
453 self = g_module_open (NULL, 0);
459 "failed to open self: %s",
464 args = g_strsplit (arg, ",", 2);
466 input_file = g_file_new_for_path (args[0]);
467 output_file = g_file_new_for_path (args[1]);
469 input = g_file_read (input_file, NULL, error);
473 output = g_file_replace (output_file, NULL, FALSE, 0, NULL, error);
476 g_input_stream_close (G_INPUT_STREAM (input), NULL, NULL);
480 goutput_write (G_OUTPUT_STREAM (output), "<?xml version=\"1.0\"?>\n");
481 goutput_write (G_OUTPUT_STREAM (output), "<dump>\n");
483 output_types = g_hash_table_new (NULL, NULL);
485 in = g_data_input_stream_new (G_INPUT_STREAM (input));
486 g_object_unref (input);
491 char *line = g_data_input_stream_read_line (in, &len, NULL, NULL);
492 const char *function;
494 if (line == NULL || *line == '\0')
502 if (strncmp (line, "get-type:", strlen ("get-type:")) == 0)
506 function = line + strlen ("get-type:");
508 type = invoke_get_type (self, function, error);
510 if (type == G_TYPE_INVALID)
512 g_printerr ("Invalid GType function: '%s'\n", function);
518 if (g_hash_table_lookup (output_types, (gpointer) type))
520 g_hash_table_insert (output_types, (gpointer) type, (gpointer) type);
522 dump_type (type, function, G_OUTPUT_STREAM (output));
524 else if (strncmp (line, "error-quark:", strlen ("error-quark:")) == 0)
527 function = line + strlen ("error-quark:");
528 quark = invoke_error_quark (self, function, error);
532 g_printerr ("Invalid error quark function: '%s'\n", function);
538 dump_error_quark (quark, function, G_OUTPUT_STREAM (output));
546 g_hash_table_destroy (output_types);
548 goutput_write (G_OUTPUT_STREAM (output), "</dump>\n");
552 /* Avoid overwriting an earlier set error */
557 if (!g_input_stream_close (G_INPUT_STREAM (in), NULL, ioerror))
559 if (!g_output_stream_close (G_OUTPUT_STREAM (output), NULL, ioerror))
563 return !caught_error;