[gtk-doc] scangobj: port to python
- From: Stefan Sauer <stefkost src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk-doc] scangobj: port to python
- Date: Wed, 5 Apr 2017 17:37:51 +0000 (UTC)
commit e47cdf6cc344e2bb4fe1d18bdc799f8fba6e83d8
Author: Stefan Sauer <ensonic users sf net>
Date: Wed Apr 5 18:30:24 2017 +0200
scangobj: port to python
Makefile.am | 6 +-
gtkdoc-scangobj.in | 1379 ++-------------------------------------------------
gtkdoc/config.py.in | 8 +-
gtkdoc/scangobj.py | 1276 +++++++++++++++++++++++++++++++++++++++++++++++
4 files changed, 1332 insertions(+), 1337 deletions(-)
---
diff --git a/Makefile.am b/Makefile.am
index 9f071f2..185a50e 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -43,7 +43,8 @@ pylibdata_DATA = \
gtkdoc/mkhtml.py \
gtkdoc/mkman.py \
gtkdoc/mkpdf.py \
- gtkdoc/rebase.py
+ gtkdoc/rebase.py \
+ gtkdoc/scangobj.py
pkgconfigdir = $(datadir)/pkgconfig
pkgconfig_DATA = gtk-doc.pc
@@ -88,7 +89,8 @@ CLEANFILES = \
gtkdoc/mkhtml.pyc \
gtkdoc/mkman.pyc \
gtkdoc/mkpdf.pyc \
- gtkdoc/rebase.pyc
+ gtkdoc/rebase.pyc \
+ gtkdoc/scangobj.pyc
DISTCLEANFILES = \
gtkdoc-check \
diff --git a/gtkdoc-scangobj.in b/gtkdoc-scangobj.in
index a2d91b0..d3d9302 100644
--- a/gtkdoc-scangobj.in
+++ b/gtkdoc-scangobj.in
@@ -1,5 +1,5 @@
-#!@PERL@ -w
-# -*- cperl -*-
+#!@PYTHON@
+# -*- python -*-
#
# gtk-doc - GTK DocBook documentation generator.
# Copyright (C) 1998 Damon Chaplin
@@ -20,1333 +20,48 @@
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#
-#
-# This gets information about object hierarchies and signals
-# by compiling a small C program. CFLAGS and LDFLAGS must be
-# set appropriately before running this script.
-#
-
-use strict;
-use Getopt::Long;
-
-push @INC, '@PACKAGE_DATA_DIR@';
-require "gtkdoc-common.pl";
-
-# Options
-
-# name of documentation module
-my $MODULE;
-my $TYPES_FILE;
-my $NO_GTK_INIT;
-my $OUTPUT_DIR;
-my $VERBOSE;
-my $PRINT_VERSION;
-my $PRINT_HELP;
-my $TYPE_INIT_FUNC="#if !GLIB_CHECK_VERSION(2,35,0)\n g_type_init();\n #endif\n
g_type_class_ref(G_TYPE_OBJECT)";
-my $QUERY_CHILD_PROPERTIES;
-
-my $CC;
-my $LD;
-my $CFLAGS;
-my $LDFLAGS;
-my $RUN;
-
-# --nogtkinit is deprecated, as it is the default now anyway.
-my %optctl = (module => \$MODULE,
- types => \$TYPES_FILE,
- nogtkinit => \$NO_GTK_INIT,
- 'type-init-func' => \$TYPE_INIT_FUNC,
- 'query-child-properties' => \$QUERY_CHILD_PROPERTIES,
- 'output-dir' => \$OUTPUT_DIR,
- 'cc' => \$CC,
- 'ld' => \$LD,
- 'cflags' => \$CFLAGS,
- 'ldflags' => \$LDFLAGS,
- 'run' => \$RUN,
- 'verbose' => \$VERBOSE,
- 'version' => \$PRINT_VERSION,
- 'help' => \$PRINT_HELP);
-
-GetOptions(\%optctl, "module=s", "types:s", "output-dir:s", "nogtkinit", "type-init-func:s",
"query-child-properties:s", "cc:s", "ld:s", "run:s", "cflags:s", "ldflags:s", "verbose", "version", "help");
-
-if ($NO_GTK_INIT) {
- # Do nothing. This just avoids a warning.
- # the option is not used anymore
-}
-
-if ($PRINT_VERSION) {
- print "@VERSION@\n";
- exit 0;
-}
-
-if (!$MODULE) {
- $PRINT_HELP = 1;
-}
-
-if ($PRINT_HELP) {
- print <<EOF;
-gtkdoc-scangobj version @VERSION@ - introspect g-objects
-
---module=MODULE_NAME Name of the doc module being parsed
---types=FILE The name of the file to store the types in
---type-init-func=FUNC The init function to call instead of g_type_init()
---query-child-properties=FUNC A function that returns a list of child
- properties for a class
---output-dir=DIRNAME The directory where the results are stored
---cc=COMPILER The compiler to use
---ld=LINKER The linker to use
---run=RUN Command for running the scanner
---cflags=CFLAGS Compiler flags
---ldflags=LDFLAGS Linker flags
---verbose Print extra output while processing
---version Print the version of this program
---help Print this help
-EOF
- exit 0;
-}
-
-$OUTPUT_DIR = $OUTPUT_DIR ? $OUTPUT_DIR : ".";
-
-$TYPES_FILE = $TYPES_FILE ? $TYPES_FILE : "$OUTPUT_DIR/$MODULE.types";
-
-open (TYPES, $TYPES_FILE) || die "Cannot open $TYPES_FILE: $!\n";
-open (OUTPUT, ">$MODULE-scan.c") || die "Cannot open $MODULE-scan.c: $!\n";
-
-my $old_signals_filename = "$OUTPUT_DIR/$MODULE.signals";
-my $new_signals_filename = "$OUTPUT_DIR/$MODULE.signals.new";
-my $old_hierarchy_filename = "$OUTPUT_DIR/$MODULE.hierarchy";
-my $new_hierarchy_filename = "$OUTPUT_DIR/$MODULE.hierarchy.new";
-my $old_interfaces_filename = "$OUTPUT_DIR/$MODULE.interfaces";
-my $new_interfaces_filename = "$OUTPUT_DIR/$MODULE.interfaces.new";
-my $old_prerequisites_filename = "$OUTPUT_DIR/$MODULE.prerequisites";
-my $new_prerequisites_filename = "$OUTPUT_DIR/$MODULE.prerequisites.new";
-my $old_args_filename = "$OUTPUT_DIR/$MODULE.args";
-my $new_args_filename = "$OUTPUT_DIR/$MODULE.args.new";
-
-# generate a C program to scan the types
-
-my $includes = "";
-my $forward_decls = "";
-my $get_types = "";
-my $ntypes = 1;
-
-for (<TYPES>) {
- if (/^#include/) {
- $includes .= $_;
- } elsif (/^gnome_keyring_item_info_get_type$/) {
- # HACK: This isn't really a GObject type so skip it.
- next;
- } elsif (/^%/) {
- next;
- } elsif (/^\s*$/) {
- next;
- } else {
- chomp;
- $get_types .= " object_types[i++] = $_ ();\n";
- $forward_decls .= "extern GType $_ (void);\n";
- $ntypes++;
- }
-}
-
-print OUTPUT <<EOT;
-#include <string.h>
-#include <stdlib.h>
-#include <stdio.h>
-#include <errno.h>
-#include <glib-object.h>
-
-EOT
-
-if ($includes) {
- print OUTPUT $includes;
-} else {
- print OUTPUT $forward_decls;
-}
-
-if ($QUERY_CHILD_PROPERTIES) {
- print OUTPUT <<EOT;
-extern GParamSpec** $QUERY_CHILD_PROPERTIES (gpointer class, guint *n_properties);
-EOT
-}
-
-print OUTPUT <<EOT;
-
-#ifdef GTK_IS_WIDGET_CLASS
-#include <gtk/gtk.h>
-#endif
-static GType object_types[$ntypes];
-
-static GType *
-get_object_types (void)
-{
- gpointer g_object_class;
- gint i = 0;
-
-${get_types}
- object_types[i] = G_TYPE_INVALID;
-
- /* reference the GObjectClass to initialize the param spec pool
- * potentially needed by interfaces. See http://bugs.gnome.org/571820 */
- g_object_class = g_type_class_ref (G_TYPE_OBJECT);
-
- /* Need to make sure all the types are loaded in and initialize
- * their signals and properties.
- */
- for (i=0; object_types[i]; i++) {
- if (G_TYPE_IS_CLASSED (object_types[i]))
- g_type_class_ref (object_types[i]);
- if (G_TYPE_IS_INTERFACE (object_types[i]))
- g_type_default_interface_ref (object_types[i]);
- }
-
- g_type_class_unref (g_object_class);
-
- return object_types;
-}
-
-/*
- * This uses GObject type functions to output signal prototypes and the object
- * hierarchy.
- */
-
-/* The output files */
-const gchar *signals_filename = "$new_signals_filename";
-const gchar *hierarchy_filename = "$new_hierarchy_filename";
-const gchar *interfaces_filename = "$new_interfaces_filename";
-const gchar *prerequisites_filename = "$new_prerequisites_filename";
-const gchar *args_filename = "$new_args_filename";
-
-static void output_signals (void);
-static void output_object_signals (FILE *fp,
- GType object_type);
-static void output_object_signal (FILE *fp,
- const gchar *object_class_name,
- guint signal_id);
-static const gchar * get_type_name (GType type,
- gboolean * is_pointer);
-static void output_object_hierarchy (void);
-static void output_hierarchy (FILE *fp,
- GType type,
- guint level);
-
-static void output_object_interfaces (void);
-static void output_interfaces (FILE *fp,
- GType type);
-
-static void output_interface_prerequisites (void);
-static void output_prerequisites (FILE *fp,
- GType type);
-
-static void output_args (void);
-static void output_object_args (FILE *fp, GType object_type);
-
-int
-main (int argc, char *argv[])
-{
- $TYPE_INIT_FUNC;
-
- get_object_types ();
-
- output_signals ();
- output_object_hierarchy ();
- output_object_interfaces ();
- output_interface_prerequisites ();
- output_args ();
-
- return 0;
-}
-
-static void
-output_signals (void)
-{
- FILE *fp;
- gint i;
-
- fp = fopen (signals_filename, "w");
- if (fp == NULL) {
- g_warning ("Couldn't open output file: %s : %s", signals_filename, g_strerror(errno));
- return;
- }
-
- for (i = 0; object_types[i]; i++)
- output_object_signals (fp, object_types[i]);
-
- fclose (fp);
-}
-
-static gint
-compare_signals (const void *a, const void *b)
-{
- const guint *signal_a = a;
- const guint *signal_b = b;
-
- return strcmp (g_signal_name (*signal_a), g_signal_name (*signal_b));
-}
-
-/* This outputs all the signals of one object. */
-static void
-output_object_signals (FILE *fp, GType object_type)
-{
- const gchar *object_class_name;
- guint *signals, n_signals;
- guint sig;
-
- if (G_TYPE_IS_INSTANTIATABLE (object_type) ||
- G_TYPE_IS_INTERFACE (object_type)) {
-
- object_class_name = g_type_name (object_type);
-
- signals = g_signal_list_ids (object_type, &n_signals);
- qsort (signals, n_signals, sizeof (guint), compare_signals);
-
- for (sig = 0; sig < n_signals; sig++) {
- output_object_signal (fp, object_class_name, signals[sig]);
- }
- g_free (signals);
- }
-}
-
-/* This outputs one signal. */
-static void
-output_object_signal (FILE *fp,
- const gchar *object_name,
- guint signal_id)
-{
- GSignalQuery query_info;
- const gchar *type_name, *ret_type, *object_arg, *arg_name;
- gchar *pos, *object_arg_lower;
- gboolean is_pointer;
- gchar buffer[1024];
- guint i, param;
- gint param_num, widget_num, event_num, callback_num;
- gint *arg_num;
- gchar signal_name[128];
- gchar flags[16];
-
- /* g_print ("Object: %s Signal: %u\\n", object_name, signal_id);*/
-
- param_num = 1;
- widget_num = event_num = callback_num = 0;
-
- g_signal_query (signal_id, &query_info);
-
- /* Output the signal object type and the argument name. We assume the
- * type is a pointer - I think that is OK. We remove "Gtk" or "Gnome" and
- * convert to lower case for the argument name. */
- pos = buffer;
- sprintf (pos, "%s ", object_name);
- pos += strlen (pos);
-
- /* Try to come up with a sensible variable name for the first arg
- * It chops off 2 know prefixes :/ and makes the name lowercase
- * It should replace lowercase -> uppercase with '_'
- * GFileMonitor -> file_monitor
- * GIOExtensionPoint -> extension_point
- * GtkTreeView -> tree_view
- * if 2nd char is upper case too
- * search for first lower case and go back one char
- * else
- * search for next upper case
- */
- if (!strncmp (object_name, "Gtk", 3))
- object_arg = object_name + 3;
- else if (!strncmp (object_name, "Gnome", 5))
- object_arg = object_name + 5;
- else
- object_arg = object_name;
-
- object_arg_lower = g_ascii_strdown (object_arg, -1);
- sprintf (pos, "*%s\\n", object_arg_lower);
- pos += strlen (pos);
- if (!strncmp (object_arg_lower, "widget", 6))
- widget_num = 2;
- g_free(object_arg_lower);
-
- /* Convert signal name to use underscores rather than dashes '-'. */
- strncpy (signal_name, query_info.signal_name, 127);
- signal_name[127] = '\\0';
- for (i = 0; signal_name[i]; i++) {
- if (signal_name[i] == '-')
- signal_name[i] = '_';
- }
-
- /* Output the signal parameters. */
- for (param = 0; param < query_info.n_params; param++) {
- type_name = get_type_name (query_info.param_types[param] & ~G_SIGNAL_TYPE_STATIC_SCOPE, &is_pointer);
-
- /* Most arguments to the callback are called "arg1", "arg2", etc.
- GtkWidgets are called "widget", "widget2", ...
- GtkCallbacks are called "callback", "callback2", ... */
- if (!strcmp (type_name, "GtkWidget")) {
- arg_name = "widget";
- arg_num = &widget_num;
- }
- else if (!strcmp (type_name, "GtkCallback")
- || !strcmp (type_name, "GtkCCallback")) {
- arg_name = "callback";
- arg_num = &callback_num;
- }
- else {
- arg_name = "arg";
- arg_num = ¶m_num;
- }
- sprintf (pos, "%s ", type_name);
- pos += strlen (pos);
-
- if (!arg_num || *arg_num == 0)
- sprintf (pos, "%s%s\\n", is_pointer ? "*" : " ", arg_name);
- else
- sprintf (pos, "%s%s%i\\n", is_pointer ? "*" : " ", arg_name,
- *arg_num);
- pos += strlen (pos);
-
- if (arg_num) {
- if (*arg_num == 0)
- *arg_num = 2;
- else
- *arg_num += 1;
- }
- }
-
- pos = flags;
- /* We use one-character flags for simplicity. */
- if (query_info.signal_flags & G_SIGNAL_RUN_FIRST)
- *pos++ = 'f';
- if (query_info.signal_flags & G_SIGNAL_RUN_LAST)
- *pos++ = 'l';
- if (query_info.signal_flags & G_SIGNAL_RUN_CLEANUP)
- *pos++ = 'c';
- if (query_info.signal_flags & G_SIGNAL_NO_RECURSE)
- *pos++ = 'r';
- if (query_info.signal_flags & G_SIGNAL_DETAILED)
- *pos++ = 'd';
- if (query_info.signal_flags & G_SIGNAL_ACTION)
- *pos++ = 'a';
- if (query_info.signal_flags & G_SIGNAL_NO_HOOKS)
- *pos++ = 'h';
- *pos = 0;
-
- /* Output the return type and function name. */
- ret_type = get_type_name (query_info.return_type & ~G_SIGNAL_TYPE_STATIC_SCOPE, &is_pointer);
-
- fprintf (fp,
-
"<SIGNAL>\\n<NAME>%s::%s</NAME>\\n<RETURNS>%s%s</RETURNS>\\n<FLAGS>%s</FLAGS>\\n%s</SIGNAL>\\n\\n",
- object_name, query_info.signal_name, ret_type, is_pointer ? "*" : "", flags, buffer);
-}
-
-
-/* Returns the type name to use for a signal argument or return value, given
- the GtkType from the signal info. It also sets is_pointer to TRUE if the
- argument needs a '*' since it is a pointer. */
-static const gchar *
-get_type_name (GType type, gboolean * is_pointer)
-{
- const gchar *type_name;
-
- *is_pointer = FALSE;
- type_name = g_type_name (type);
-
- switch (type) {
- case G_TYPE_NONE:
- case G_TYPE_CHAR:
- case G_TYPE_UCHAR:
- case G_TYPE_BOOLEAN:
- case G_TYPE_INT:
- case G_TYPE_UINT:
- case G_TYPE_LONG:
- case G_TYPE_ULONG:
- case G_TYPE_FLOAT:
- case G_TYPE_DOUBLE:
- case G_TYPE_POINTER:
- /* These all have normal C type names so they are OK. */
- return type_name;
-
- case G_TYPE_STRING:
- /* A GtkString is really a gchar*. */
- *is_pointer = TRUE;
- return "gchar";
-
- case G_TYPE_ENUM:
- case G_TYPE_FLAGS:
- /* We use a gint for both of these. Hopefully a subtype with a decent
- name will be registered and used instead, as GTK+ does itself. */
- return "gint";
-
- case G_TYPE_BOXED:
- /* The boxed type shouldn't be used itself, only subtypes. Though we
- return 'gpointer' just in case. */
- return "gpointer";
-
- case G_TYPE_PARAM:
- /* A GParam is really a GParamSpec*. */
- *is_pointer = TRUE;
- return "GParamSpec";
-
-#if GLIB_CHECK_VERSION (2, 25, 9)
- case G_TYPE_VARIANT:
- *is_pointer = TRUE;
- return "GVariant";
-#endif
-
-default:
- break;
- }
-
- /* For all GObject subclasses we can use the class name with a "*",
- e.g. 'GtkWidget *'. */
- if (g_type_is_a (type, G_TYPE_OBJECT))
- *is_pointer = TRUE;
-
- /* Also catch non GObject root types */
- if (G_TYPE_IS_CLASSED (type))
- *is_pointer = TRUE;
-
- /* All boxed subtypes will be pointers as well. */
- /* Exception: GStrv */
- if (g_type_is_a (type, G_TYPE_BOXED) &&
- !g_type_is_a (type, G_TYPE_STRV))
- *is_pointer = TRUE;
-
- /* All pointer subtypes will be pointers as well. */
- if (g_type_is_a (type, G_TYPE_POINTER))
- *is_pointer = TRUE;
-
- /* But enums are not */
- if (g_type_is_a (type, G_TYPE_ENUM) ||
- g_type_is_a (type, G_TYPE_FLAGS))
- *is_pointer = FALSE;
-
- return type_name;
-}
-
-
-/* This outputs the hierarchy of all objects which have been initialized,
- i.e. by calling their XXX_get_type() initialization function. */
-static void
-output_object_hierarchy (void)
-{
- FILE *fp;
- gint i,j;
- GType root, type;
- GType root_types[$ntypes] = { G_TYPE_INVALID, };
-
- fp = fopen (hierarchy_filename, "w");
- if (fp == NULL) {
- g_warning ("Couldn't open output file: %s : %s", hierarchy_filename, g_strerror(errno));
- return;
- }
- output_hierarchy (fp, G_TYPE_OBJECT, 0);
- output_hierarchy (fp, G_TYPE_INTERFACE, 0);
-
- for (i=0; object_types[i]; i++) {
- root = object_types[i];
- while ((type = g_type_parent (root))) {
- root = type;
- }
- if ((root != G_TYPE_OBJECT) && (root != G_TYPE_INTERFACE)) {
- for (j=0; root_types[j]; j++) {
- if (root == root_types[j]) {
- root = G_TYPE_INVALID; break;
- }
- }
- if(root) {
- root_types[j] = root;
- output_hierarchy (fp, root, 0);
- }
- }
- }
-
- fclose (fp);
-}
-
-/* This is called recursively to output the hierarchy of a object. */
-static void
-output_hierarchy (FILE *fp,
- GType type,
- guint level)
-{
- guint i;
- GType *children;
- guint n_children;
-
- if (!type)
- return;
-
- for (i = 0; i < level; i++)
- fprintf (fp, " ");
- fprintf (fp, "%s\\n", g_type_name (type));
-
- children = g_type_children (type, &n_children);
-
- for (i=0; i < n_children; i++)
- output_hierarchy (fp, children[i], level + 1);
-
- g_free (children);
-}
-
-static void output_object_interfaces (void)
-{
- guint i;
- FILE *fp;
-
- fp = fopen (interfaces_filename, "w");
- if (fp == NULL) {
- g_warning ("Couldn't open output file: %s : %s", interfaces_filename, g_strerror(errno));
- return;
- }
- output_interfaces (fp, G_TYPE_OBJECT);
-
- for (i = 0; object_types[i]; i++) {
- if (!g_type_parent (object_types[i]) &&
- (object_types[i] != G_TYPE_OBJECT) &&
- G_TYPE_IS_INSTANTIATABLE (object_types[i])) {
- output_interfaces (fp, object_types[i]);
- }
- }
- fclose (fp);
-}
-
-static void
-output_interfaces (FILE *fp,
- GType type)
-{
- guint i;
- GType *children, *interfaces;
- guint n_children, n_interfaces;
-
- if (!type)
- return;
-
- interfaces = g_type_interfaces (type, &n_interfaces);
-
- if (n_interfaces > 0) {
- fprintf (fp, "%s", g_type_name (type));
- for (i=0; i < n_interfaces; i++)
- fprintf (fp, " %s", g_type_name (interfaces[i]));
- fprintf (fp, "\\n");
- }
- g_free (interfaces);
-
- children = g_type_children (type, &n_children);
-
- for (i=0; i < n_children; i++)
- output_interfaces (fp, children[i]);
-
- g_free (children);
-}
-
-static void output_interface_prerequisites (void)
-{
- FILE *fp;
-
- fp = fopen (prerequisites_filename, "w");
- if (fp == NULL) {
- g_warning ("Couldn't open output file: %s : %s", prerequisites_filename, g_strerror(errno));
- return;
- }
- output_prerequisites (fp, G_TYPE_INTERFACE);
- fclose (fp);
-}
-
-static void
-output_prerequisites (FILE *fp,
- GType type)
-{
-#if GLIB_CHECK_VERSION(2,1,0)
- guint i;
- GType *children, *prerequisites;
- guint n_children, n_prerequisites;
-
- if (!type)
- return;
-
- prerequisites = g_type_interface_prerequisites (type, &n_prerequisites);
-
- if (n_prerequisites > 0) {
- fprintf (fp, "%s", g_type_name (type));
- for (i=0; i < n_prerequisites; i++)
- fprintf (fp, " %s", g_type_name (prerequisites[i]));
- fprintf (fp, "\\n");
- }
- g_free (prerequisites);
-
- children = g_type_children (type, &n_children);
-
- for (i=0; i < n_children; i++)
- output_prerequisites (fp, children[i]);
-
- g_free (children);
-#endif
-}
-
-static void
-output_args (void)
-{
- FILE *fp;
- gint i;
-
- fp = fopen (args_filename, "w");
- if (fp == NULL) {
- g_warning ("Couldn't open output file: %s : %s", args_filename, g_strerror(errno));
- return;
- }
-
- for (i = 0; object_types[i]; i++) {
- output_object_args (fp, object_types[i]);
- }
-
- fclose (fp);
-}
-
-static gint
-compare_param_specs (const void *a, const void *b)
-{
- GParamSpec *spec_a = *(GParamSpec **)a;
- GParamSpec *spec_b = *(GParamSpec **)b;
-
- return strcmp (g_param_spec_get_name (spec_a), g_param_spec_get_name (spec_b));
-}
-
-/* Its common to have unsigned properties restricted
- * to the signed range. Therefore we make this look
- * a bit nicer by spelling out the max constants.
- */
-
-/* Don't use "==" with floats, it might trigger a gcc warning. */
-#define GTKDOC_COMPARE_FLOAT(x, y) (x <= y && x >= y)
-
-static gchar*
-describe_double_constant (gdouble value)
-{
- gchar *desc;
-
- if (GTKDOC_COMPARE_FLOAT (value, G_MAXDOUBLE))
- desc = g_strdup ("G_MAXDOUBLE");
- else if (GTKDOC_COMPARE_FLOAT (value, G_MINDOUBLE))
- desc = g_strdup ("G_MINDOUBLE");
- else if (GTKDOC_COMPARE_FLOAT (value, -G_MAXDOUBLE))
- desc = g_strdup ("-G_MAXDOUBLE");
- else if (GTKDOC_COMPARE_FLOAT (value, G_MAXFLOAT))
- desc = g_strdup ("G_MAXFLOAT");
- else if (GTKDOC_COMPARE_FLOAT (value, G_MINFLOAT))
- desc = g_strdup ("G_MINFLOAT");
- else if (GTKDOC_COMPARE_FLOAT (value, -G_MAXFLOAT))
- desc = g_strdup ("-G_MAXFLOAT");
- else{
- /* make sure floats are output with a decimal dot irrespective of
- * current locale. Use formatd since we want human-readable numbers
- * and do not need the exact same bit representation when deserialising */
- desc = g_malloc0 (G_ASCII_DTOSTR_BUF_SIZE);
- g_ascii_formatd (desc, G_ASCII_DTOSTR_BUF_SIZE, "%g", value);
- }
-
- return desc;
-}
-
-static gchar*
-describe_signed_constant (gsize size, gint64 value)
-{
- gchar *desc = NULL;
-
- switch (size) {
- case 2:
- if (sizeof (int) == 2) {
- if (value == G_MAXINT)
- desc = g_strdup ("G_MAXINT");
- else if (value == G_MININT)
- desc = g_strdup ("G_MININT");
- }
- break;
- case 4:
- if (sizeof (int) == 4) {
- if (value == G_MAXINT)
- desc = g_strdup ("G_MAXINT");
- else if (value == G_MININT)
- desc = g_strdup ("G_MININT");
- }
- if (value == G_MAXLONG)
- desc = g_strdup ("G_MAXLONG");
- else if (value == G_MINLONG)
- desc = g_strdup ("G_MINLONG");
- break;
- case 8:
- if (value == G_MAXINT64)
- desc = g_strdup ("G_MAXINT64");
- else if (value == G_MININT64)
- desc = g_strdup ("G_MININT64");
- break;
- default:
- break;
- }
- if (!desc)
- desc = g_strdup_printf ("%" G_GINT64_FORMAT, value);
-
- return desc;
-}
-
-static gchar*
-describe_unsigned_constant (gsize size, guint64 value)
-{
- gchar *desc = NULL;
-
- switch (size) {
- case 2:
- if (sizeof (int) == 2) {
- if (value == (guint64)G_MAXINT)
- desc = g_strdup ("G_MAXINT");
- else if (value == G_MAXUINT)
- desc = g_strdup ("G_MAXUINT");
- }
- break;
- case 4:
- if (sizeof (int) == 4) {
- if (value == (guint64)G_MAXINT)
- desc = g_strdup ("G_MAXINT");
- else if (value == G_MAXUINT)
- desc = g_strdup ("G_MAXUINT");
- }
- if (value == (guint64)G_MAXLONG)
- desc = g_strdup ("G_MAXLONG");
- else if (value == G_MAXULONG)
- desc = g_strdup ("G_MAXULONG");
- break;
- case 8:
- if (value == G_MAXINT64)
- desc = g_strdup ("G_MAXINT64");
- else if (value == G_MAXUINT64)
- desc = g_strdup ("G_MAXUINT64");
- break;
- default:
- break;
- }
- if (!desc)
- desc = g_strdup_printf ("%" G_GUINT64_FORMAT, value);
-
- return desc;
-}
-
-static gchar*
-describe_type (GParamSpec *spec)
-{
- gchar *desc;
- gchar *lower;
- gchar *upper;
-
- if (G_IS_PARAM_SPEC_CHAR (spec)) {
- GParamSpecChar *pspec = G_PARAM_SPEC_CHAR (spec);
-
- lower = describe_signed_constant (sizeof(gchar), pspec->minimum);
- upper = describe_signed_constant (sizeof(gchar), pspec->maximum);
- if (pspec->minimum == G_MININT8 && pspec->maximum == G_MAXINT8)
- desc = g_strdup ("");
- else if (pspec->minimum == G_MININT8)
- desc = g_strdup_printf ("<= %s", upper);
- else if (pspec->maximum == G_MAXINT8)
- desc = g_strdup_printf (">= %s", lower);
- else
- desc = g_strdup_printf ("[%s,%s]", lower, upper);
- g_free (lower);
- g_free (upper);
- }
- else if (G_IS_PARAM_SPEC_UCHAR (spec)) {
- GParamSpecUChar *pspec = G_PARAM_SPEC_UCHAR (spec);
-
- lower = describe_unsigned_constant (sizeof(guchar), pspec->minimum);
- upper = describe_unsigned_constant (sizeof(guchar), pspec->maximum);
- if (pspec->minimum == 0 && pspec->maximum == G_MAXUINT8)
- desc = g_strdup ("");
- else if (pspec->minimum == 0)
- desc = g_strdup_printf ("<= %s", upper);
- else if (pspec->maximum == G_MAXUINT8)
- desc = g_strdup_printf (">= %s", lower);
- else
- desc = g_strdup_printf ("[%s,%s]", lower, upper);
- g_free (lower);
- g_free (upper);
- }
- else if (G_IS_PARAM_SPEC_INT (spec)) {
- GParamSpecInt *pspec = G_PARAM_SPEC_INT (spec);
-
- lower = describe_signed_constant (sizeof(gint), pspec->minimum);
- upper = describe_signed_constant (sizeof(gint), pspec->maximum);
- if (pspec->minimum == G_MININT && pspec->maximum == G_MAXINT)
- desc = g_strdup ("");
- else if (pspec->minimum == G_MININT)
- desc = g_strdup_printf ("<= %s", upper);
- else if (pspec->maximum == G_MAXINT)
- desc = g_strdup_printf (">= %s", lower);
- else
- desc = g_strdup_printf ("[%s,%s]", lower, upper);
- g_free (lower);
- g_free (upper);
- }
- else if (G_IS_PARAM_SPEC_UINT (spec)) {
- GParamSpecUInt *pspec = G_PARAM_SPEC_UINT (spec);
-
- lower = describe_unsigned_constant (sizeof(guint), pspec->minimum);
- upper = describe_unsigned_constant (sizeof(guint), pspec->maximum);
- if (pspec->minimum == 0 && pspec->maximum == G_MAXUINT)
- desc = g_strdup ("");
- else if (pspec->minimum == 0)
- desc = g_strdup_printf ("<= %s", upper);
- else if (pspec->maximum == G_MAXUINT)
- desc = g_strdup_printf (">= %s", lower);
- else
- desc = g_strdup_printf ("[%s,%s]", lower, upper);
- g_free (lower);
- g_free (upper);
- }
- else if (G_IS_PARAM_SPEC_LONG (spec)) {
- GParamSpecLong *pspec = G_PARAM_SPEC_LONG (spec);
-
- lower = describe_signed_constant (sizeof(glong), pspec->minimum);
- upper = describe_signed_constant (sizeof(glong), pspec->maximum);
- if (pspec->minimum == G_MINLONG && pspec->maximum == G_MAXLONG)
- desc = g_strdup ("");
- else if (pspec->minimum == G_MINLONG)
- desc = g_strdup_printf ("<= %s", upper);
- else if (pspec->maximum == G_MAXLONG)
- desc = g_strdup_printf (">= %s", lower);
- else
- desc = g_strdup_printf ("[%s,%s]", lower, upper);
- g_free (lower);
- g_free (upper);
- }
- else if (G_IS_PARAM_SPEC_ULONG (spec)) {
- GParamSpecULong *pspec = G_PARAM_SPEC_ULONG (spec);
-
- lower = describe_unsigned_constant (sizeof(gulong), pspec->minimum);
- upper = describe_unsigned_constant (sizeof(gulong), pspec->maximum);
- if (pspec->minimum == 0 && pspec->maximum == G_MAXULONG)
- desc = g_strdup ("");
- else if (pspec->minimum == 0)
- desc = g_strdup_printf ("<= %s", upper);
- else if (pspec->maximum == G_MAXULONG)
- desc = g_strdup_printf (">= %s", lower);
- else
- desc = g_strdup_printf ("[%s,%s]", lower, upper);
- g_free (lower);
- g_free (upper);
- }
- else if (G_IS_PARAM_SPEC_INT64 (spec)) {
- GParamSpecInt64 *pspec = G_PARAM_SPEC_INT64 (spec);
-
- lower = describe_signed_constant (sizeof(gint64), pspec->minimum);
- upper = describe_signed_constant (sizeof(gint64), pspec->maximum);
- if (pspec->minimum == G_MININT64 && pspec->maximum == G_MAXINT64)
- desc = g_strdup ("");
- else if (pspec->minimum == G_MININT64)
- desc = g_strdup_printf ("<= %s", upper);
- else if (pspec->maximum == G_MAXINT64)
- desc = g_strdup_printf (">= %s", lower);
- else
- desc = g_strdup_printf ("[%s,%s]", lower, upper);
- g_free (lower);
- g_free (upper);
- }
- else if (G_IS_PARAM_SPEC_UINT64 (spec)) {
- GParamSpecUInt64 *pspec = G_PARAM_SPEC_UINT64 (spec);
-
- lower = describe_unsigned_constant (sizeof(guint64), pspec->minimum);
- upper = describe_unsigned_constant (sizeof(guint64), pspec->maximum);
- if (pspec->minimum == 0 && pspec->maximum == G_MAXUINT64)
- desc = g_strdup ("");
- else if (pspec->minimum == 0)
- desc = g_strdup_printf ("<= %s", upper);
- else if (pspec->maximum == G_MAXUINT64)
- desc = g_strdup_printf (">= %s", lower);
- else
- desc = g_strdup_printf ("[%s,%s]", lower, upper);
- g_free (lower);
- g_free (upper);
- }
- else if (G_IS_PARAM_SPEC_FLOAT (spec)) {
- GParamSpecFloat *pspec = G_PARAM_SPEC_FLOAT (spec);
-
- lower = describe_double_constant (pspec->minimum);
- upper = describe_double_constant (pspec->maximum);
- if (GTKDOC_COMPARE_FLOAT (pspec->minimum, -G_MAXFLOAT)) {
- if (GTKDOC_COMPARE_FLOAT (pspec->maximum, G_MAXFLOAT))
- desc = g_strdup ("");
- else
- desc = g_strdup_printf ("<= %s", upper);
- }
- else if (GTKDOC_COMPARE_FLOAT (pspec->maximum, G_MAXFLOAT))
- desc = g_strdup_printf (">= %s", lower);
- else
- desc = g_strdup_printf ("[%s,%s]", lower, upper);
- g_free (lower);
- g_free (upper);
- }
- else if (G_IS_PARAM_SPEC_DOUBLE (spec)) {
- GParamSpecDouble *pspec = G_PARAM_SPEC_DOUBLE (spec);
-
- lower = describe_double_constant (pspec->minimum);
- upper = describe_double_constant (pspec->maximum);
- if (GTKDOC_COMPARE_FLOAT (pspec->minimum, -G_MAXDOUBLE)) {
- if (GTKDOC_COMPARE_FLOAT (pspec->maximum, G_MAXDOUBLE))
- desc = g_strdup ("");
- else
- desc = g_strdup_printf ("<= %s", upper);
- }
- else if (GTKDOC_COMPARE_FLOAT (pspec->maximum, G_MAXDOUBLE))
- desc = g_strdup_printf (">= %s", lower);
- else
- desc = g_strdup_printf ("[%s,%s]", lower, upper);
- g_free (lower);
- g_free (upper);
- }
-#if GLIB_CHECK_VERSION (2, 12, 0)
- else if (G_IS_PARAM_SPEC_GTYPE (spec)) {
- GParamSpecGType *pspec = G_PARAM_SPEC_GTYPE (spec);
- gboolean is_pointer;
-
- desc = g_strdup (get_type_name (pspec->is_a_type, &is_pointer));
- }
-#endif
-#if GLIB_CHECK_VERSION (2, 25, 9)
- else if (G_IS_PARAM_SPEC_VARIANT (spec)) {
- GParamSpecVariant *pspec = G_PARAM_SPEC_VARIANT (spec);
- gchar *variant_type;
-
- variant_type = g_variant_type_dup_string (pspec->type);
- desc = g_strdup_printf ("GVariant<%s>", variant_type);
- g_free (variant_type);
- }
-#endif
- else {
- desc = g_strdup ("");
- }
-
- return desc;
-}
-
-static gchar*
-describe_default (GParamSpec *spec)
-{
- gchar *desc;
-
- if (G_IS_PARAM_SPEC_CHAR (spec)) {
- GParamSpecChar *pspec = G_PARAM_SPEC_CHAR (spec);
-
- desc = g_strdup_printf ("%d", pspec->default_value);
- }
- else if (G_IS_PARAM_SPEC_UCHAR (spec)) {
- GParamSpecUChar *pspec = G_PARAM_SPEC_UCHAR (spec);
-
- desc = g_strdup_printf ("%u", pspec->default_value);
- }
- else if (G_IS_PARAM_SPEC_BOOLEAN (spec)) {
- GParamSpecBoolean *pspec = G_PARAM_SPEC_BOOLEAN (spec);
-
- desc = g_strdup_printf ("%s", pspec->default_value ? "TRUE" : "FALSE");
- }
- else if (G_IS_PARAM_SPEC_INT (spec)) {
- GParamSpecInt *pspec = G_PARAM_SPEC_INT (spec);
-
- desc = g_strdup_printf ("%d", pspec->default_value);
- }
- else if (G_IS_PARAM_SPEC_UINT (spec)) {
- GParamSpecUInt *pspec = G_PARAM_SPEC_UINT (spec);
-
- desc = g_strdup_printf ("%u", pspec->default_value);
- }
- else if (G_IS_PARAM_SPEC_LONG (spec)) {
- GParamSpecLong *pspec = G_PARAM_SPEC_LONG (spec);
-
- desc = g_strdup_printf ("%ld", pspec->default_value);
- }
- else if (G_IS_PARAM_SPEC_LONG (spec)) {
- GParamSpecULong *pspec = G_PARAM_SPEC_ULONG (spec);
-
- desc = g_strdup_printf ("%lu", pspec->default_value);
- }
- else if (G_IS_PARAM_SPEC_INT64 (spec)) {
- GParamSpecInt64 *pspec = G_PARAM_SPEC_INT64 (spec);
-
- desc = g_strdup_printf ("%" G_GINT64_FORMAT, pspec->default_value);
- }
- else if (G_IS_PARAM_SPEC_UINT64 (spec))
- {
- GParamSpecUInt64 *pspec = G_PARAM_SPEC_UINT64 (spec);
-
- desc = g_strdup_printf ("%" G_GUINT64_FORMAT, pspec->default_value);
- }
- else if (G_IS_PARAM_SPEC_UNICHAR (spec)) {
- GParamSpecUnichar *pspec = G_PARAM_SPEC_UNICHAR (spec);
-
- if (g_unichar_isprint (pspec->default_value))
- desc = g_strdup_printf ("'%c'", pspec->default_value);
- else
- desc = g_strdup_printf ("%u", pspec->default_value);
- }
- else if (G_IS_PARAM_SPEC_ENUM (spec)) {
- GParamSpecEnum *pspec = G_PARAM_SPEC_ENUM (spec);
-
- GEnumValue *value = g_enum_get_value (pspec->enum_class, pspec->default_value);
- if (value)
- desc = g_strdup_printf ("%s", value->value_name);
- else
- desc = g_strdup_printf ("%d", pspec->default_value);
- }
- else if (G_IS_PARAM_SPEC_FLAGS (spec)) {
- GParamSpecFlags *pspec = G_PARAM_SPEC_FLAGS (spec);
- guint default_value;
- GString *acc;
-
- default_value = pspec->default_value;
- acc = g_string_new ("");
-
- while (default_value) {
- GFlagsValue *value = g_flags_get_first_value (pspec->flags_class, default_value);
-
- if (!value)
- break;
-
- if (acc->len > 0)
- g_string_append (acc, " | ");
- g_string_append (acc, value->value_name);
-
- default_value &= ~value->value;
- }
-
- if (default_value == 0)
- desc = g_string_free (acc, FALSE);
- else {
- desc = g_strdup_printf ("%d", pspec->default_value);
- g_string_free (acc, TRUE);
- }
- }
- else if (G_IS_PARAM_SPEC_FLOAT (spec)) {
- GParamSpecFloat *pspec = G_PARAM_SPEC_FLOAT (spec);
-
- /* make sure floats are output with a decimal dot irrespective of
- * current locale. Use formatd since we want human-readable numbers
- * and do not need the exact same bit representation when deserialising */
- desc = g_malloc0 (G_ASCII_DTOSTR_BUF_SIZE);
- g_ascii_formatd (desc, G_ASCII_DTOSTR_BUF_SIZE, "%g",
- pspec->default_value);
- }
- else if (G_IS_PARAM_SPEC_DOUBLE (spec)) {
- GParamSpecDouble *pspec = G_PARAM_SPEC_DOUBLE (spec);
-
- /* make sure floats are output with a decimal dot irrespective of
- * current locale. Use formatd since we want human-readable numbers
- * and do not need the exact same bit representation when deserialising */
- desc = g_malloc0 (G_ASCII_DTOSTR_BUF_SIZE);
- g_ascii_formatd (desc, G_ASCII_DTOSTR_BUF_SIZE, "%g",
- pspec->default_value);
- }
- else if (G_IS_PARAM_SPEC_STRING (spec)) {
- GParamSpecString *pspec = G_PARAM_SPEC_STRING (spec);
-
- if (pspec->default_value) {
- gchar *esc = g_strescape (pspec->default_value, NULL);
- desc = g_strdup_printf ("\\"%s\\"", esc);
- g_free (esc);
- }
- else
- desc = g_strdup_printf ("NULL");
- }
-#if GLIB_CHECK_VERSION (2, 25, 9)
- else if (G_IS_PARAM_SPEC_VARIANT (spec)) {
- GParamSpecVariant *pspec = G_PARAM_SPEC_VARIANT (spec);
-
- if (pspec->default_value)
- desc = g_variant_print (pspec->default_value, TRUE);
- else
- desc = g_strdup ("NULL");
- }
-#endif
- else {
- desc = g_strdup ("");
- }
-
- return desc;
-}
-
-
-static void
-output_object_args (FILE *fp, GType object_type)
-{
- gpointer class;
- const gchar *object_class_name;
- guint arg;
- gchar flags[16], *pos;
- GParamSpec **properties;
- guint n_properties;
- gboolean child_prop;
- gboolean style_prop;
- gboolean is_pointer;
- const gchar *type_name;
- gchar *type_desc;
- gchar *default_value;
-
- if (G_TYPE_IS_OBJECT (object_type)) {
- class = g_type_class_peek (object_type);
- if (!class)
- return;
-
- properties = g_object_class_list_properties (class, &n_properties);
- }
-#if GLIB_MAJOR_VERSION > 2 || (GLIB_MAJOR_VERSION == 2 && GLIB_MINOR_VERSION >= 3)
- else if (G_TYPE_IS_INTERFACE (object_type)) {
- class = g_type_default_interface_ref (object_type);
-
- if (!class)
- return;
-
- properties = g_object_interface_list_properties (class, &n_properties);
- }
-#endif
- else
- return;
-
- object_class_name = g_type_name (object_type);
-
- child_prop = FALSE;
- style_prop = FALSE;
-
- while (TRUE) {
- qsort (properties, n_properties, sizeof (GParamSpec *), compare_param_specs);
- for (arg = 0; arg < n_properties; arg++) {
- GParamSpec *spec = properties[arg];
- const gchar *nick, *blurb, *dot;
-
- if (spec->owner_type != object_type)
- continue;
-
- pos = flags;
- /* We use one-character flags for simplicity. */
- if (child_prop && !style_prop)
- *pos++ = 'c';
- if (style_prop)
- *pos++ = 's';
- if (spec->flags & G_PARAM_READABLE)
- *pos++ = 'r';
- if (spec->flags & G_PARAM_WRITABLE)
- *pos++ = 'w';
- if (spec->flags & G_PARAM_CONSTRUCT)
- *pos++ = 'x';
- if (spec->flags & G_PARAM_CONSTRUCT_ONLY)
- *pos++ = 'X';
- *pos = 0;
-
- nick = g_param_spec_get_nick (spec);
- blurb = g_param_spec_get_blurb (spec);
-
- dot = "";
- if (blurb) {
- int str_len = strlen (blurb);
- if (str_len > 0 && blurb[str_len - 1] != '.')
- dot = ".";
- }
-
- type_desc = describe_type (spec);
- default_value = describe_default (spec);
- type_name = get_type_name (spec->value_type, &is_pointer);
- fprintf (fp,
"<ARG>\\n<NAME>%s::%s</NAME>\\n<TYPE>%s%s</TYPE>\\n<RANGE>%s</RANGE>\\n<FLAGS>%s</FLAGS>\\n<NICK>%s</NICK>\\n<BLURB>%s%s</BLURB>\\n<DEFAULT>%s</DEFAULT>\\n</ARG>\\n\\n",
- object_class_name, g_param_spec_get_name (spec), type_name, is_pointer ? "*" : "", type_desc,
flags, nick ? nick : "(null)", blurb ? blurb : "(null)", dot, default_value);
- g_free (type_desc);
- g_free (default_value);
- }
-
- g_free (properties);
-
-#ifdef GTK_IS_CONTAINER_CLASS
- if (!child_prop && GTK_IS_CONTAINER_CLASS (class)) {
- properties = gtk_container_class_list_child_properties (class, &n_properties);
- child_prop = TRUE;
- continue;
- }
-#endif
-
-#ifdef GTK_IS_CELL_AREA_CLASS
- if (!child_prop && GTK_IS_CELL_AREA_CLASS (class)) {
- properties = gtk_cell_area_class_list_cell_properties (class, &n_properties);
- child_prop = TRUE;
- continue;
- }
-#endif
-
-#ifdef GTK_IS_WIDGET_CLASS
-#if GTK_CHECK_VERSION(2,1,0) && !GTK_CHECK_VERSION(3,89,2)
- if (!style_prop && GTK_IS_WIDGET_CLASS (class)) {
- properties = gtk_widget_class_list_style_properties (GTK_WIDGET_CLASS (class), &n_properties);
- style_prop = TRUE;
- continue;
- }
-#endif
-#endif
-
-EOT
-
-if ($QUERY_CHILD_PROPERTIES) {
- print OUTPUT <<EOT;
- if (!child_prop) {
- properties = $QUERY_CHILD_PROPERTIES (class, &n_properties);
- if (properties) {
- child_prop = TRUE;
- continue;
- }
- }
-
-EOT
-}
-
-print OUTPUT <<EOT;
- break;
- }
-}
-EOT
-
-close OUTPUT;
-
-# Compile and run our file
-
-unless ($CC) {
- $CC = $ENV{CC} ? $ENV{CC} : "gcc";
-}
-unless ($LD) {
- $LD = $ENV{LD} ? $ENV{LD} : $CC;
-}
-unless ($CFLAGS) {
- $CFLAGS = $ENV{CFLAGS} ? $ENV{CFLAGS} : "";
-}
-unless ($LDFLAGS) {
- $LDFLAGS = $ENV{LDFLAGS} ? $ENV{LDFLAGS} : "";
-}
-unless ($RUN) {
- $RUN = $ENV{RUN} ? $ENV{RUN} : "";
-}
-
-my $o_file = $CC =~ /libtool/ ? "$MODULE-scan.lo" :"$MODULE-scan.o";
-
-my $stdout="";
-if (!defined($VERBOSE) or $VERBOSE eq "0") {
- $stdout=">/dev/null";
-}
-
-# Compiling scanner
-my $command = "$CC $stdout $CFLAGS -c -o $o_file $MODULE-scan.c";
-system("($command)") == 0 or die "Compilation of scanner failed: $!\n";
-
-# Linking scanner
-# FIXME: Can we turn off as-needed for the docs (or better fix it?)
-#$command = "$LD -Wl,--no-as-needed $o_file $LDFLAGS -o $MODULE-scan@EXEEXT@";
-$command = "$LD $stdout $o_file $LDFLAGS -o $MODULE-scan@EXEEXT@";
-system("($command)") == 0 or die "Linking of scanner failed: $!\n";
-
-# Running scanner $MODULE-scan ";
-system("($RUN ./$MODULE-scan@EXEEXT@)") == 0 or die "Scan failed: $!\n";
-
-
-if (!defined($ENV{"GTK_DOC_KEEP_INTERMEDIATE"})) {
- unlink "./$MODULE-scan.c", "./$MODULE-scan.o", "./$MODULE-scan.lo", "./$MODULE-scan@EXEEXT@";
-}
-
-&UpdateFileIfChanged ($old_signals_filename, $new_signals_filename, 0);
-&UpdateFileIfChanged ($old_hierarchy_filename, $new_hierarchy_filename, 0);
-&UpdateFileIfChanged ($old_interfaces_filename, $new_interfaces_filename, 0);
-&UpdateFileIfChanged ($old_prerequisites_filename, $new_prerequisites_filename, 0);
-&UpdateFileIfChanged ($old_args_filename, $new_args_filename, 0);
+import argparse, os, sys
+sys.path.append('@PYTHON_PACKAGE_DIR@')
+
+from gtkdoc import config, scangobj
+
+if __name__ == '__main__':
+ parser = argparse.ArgumentParser(
+ description='gtkdoc-rebase version %s - introspect g-objects' % config.version)
+ parser.add_argument('--version', action='version', version=config.version)
+ parser.add_argument('--module', default='',
+ help='Name of the doc module being parsed')
+ parser.add_argument('--types', default='',
+ help='The name of the file to store the types in')
+ parser.add_argument('--type-init-func', default='',
+ help='The init function(s) to call instead of g_type_init()')
+ parser.add_argument('--query-child-properties', default='',
+ help='A function that returns a list of child properties for a class')
+ parser.add_argument('--output-dir', default='.',
+ help='The directory where the results are stored')
+ parser.add_argument('--cc', default='', help='The compiler to use')
+ parser.add_argument('--ld', default='', help='The linker to use')
+ parser.add_argument('--cflags', default='', help='Compiler flags')
+ parser.add_argument('--ldflags', default='', help='Linker flags')
+ parser.add_argument('--run', default='',
+ help='Command for running the scanner')
+ parser.add_argument('--verbose', action='store_true', default=False,
+ help='Print extra output while processing')
+
+ options = parser.parse_args()
+
+ if options.types == '':
+ options.types = os.path.join(options.output_dir, options.module + '.types')
+
+ if not options.cc:
+ options.cc = os.environ.get('CC', 'gcc')
+ if not options.ld:
+ options.ld = os.environ.get('LD', options.cc)
+ if not options.cflags:
+ options.cflags = os.environ.get('CFLAGS', '')
+ if not options.ldflags:
+ options.ldflags = os.environ.get('LDFLAGS', '')
+ if not options.run:
+ options.run = os.environ.get('RUN', '')
+
+ sys.exit(scangobj.run(options))
diff --git a/gtkdoc/config.py.in b/gtkdoc/config.py.in
index 5ef5fdd..1264374 100644
--- a/gtkdoc/config.py.in
+++ b/gtkdoc/config.py.in
@@ -7,6 +7,8 @@ pkg_config = '@PKG_CONFIG@'
xsltproc = '@XSLTPROC@'
# configured directories
-prefix='@prefix@'
-datarootdir="@datarootdir@".replace('${prefix}', prefix)
-datadir="@datadir@".replace('${datarootdir}', datarootdir)
+prefix = '@prefix@'
+datarootdir = "@datarootdir@".replace('${prefix}', prefix)
+datadir = "@datadir@".replace('${datarootdir}', datarootdir)
+
+exeext = '@EXEEXT@'
diff --git a/gtkdoc/scangobj.py b/gtkdoc/scangobj.py
new file mode 100644
index 0000000..e7df3e5
--- /dev/null
+++ b/gtkdoc/scangobj.py
@@ -0,0 +1,1276 @@
+#!@PYTHON@
+# -*- python -*-
+#
+# gtk-doc - GTK DocBook documentation generator.
+# Copyright (C) 1998 Damon Chaplin
+# 2007-2016 Stefan Sauer
+#
+# 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.
+#
+
+#############################################################################
+# This gets information about object hierarchies and signals
+# by compiling a small C program. CFLAGS and LDFLAGS must be
+# set appropriately before running this script.
+#############################################################################
+
+
+from __future__ import print_function
+
+import logging, os, re, string, subprocess, sys
+
+from . import common, config
+
+
+COMMON_INCLUDES = """
+#include <string.h>
+#include <stdlib.h>
+#include <stdio.h>
+#include <errno.h>
+#include <glib-object.h>
+"""
+
+QUERY_CHILD_PROPS_PROTOTYPE = "extern GParamSpec** %s (gpointer class, guint *n_properties);"
+
+QUERY_CHILD_PROPS_CODE = """
+ if (!child_prop) {
+ properties = %s (class, &n_properties);
+ if (properties) {
+ child_prop = TRUE;
+ continue;
+ }
+ }
+"""
+
+MAIN_CODE = """
+
+#ifdef GTK_IS_WIDGET_CLASS
+#include <gtk/gtk.h>
+#endif
+static GType object_types[$ntypes];
+
+static GType *
+get_object_types (void)
+{
+ gpointer g_object_class;
+ gint i = 0;
+
+${get_types}
+ object_types[i] = G_TYPE_INVALID;
+
+ /* reference the GObjectClass to initialize the param spec pool
+ * potentially needed by interfaces. See http://bugs.gnome.org/571820 */
+ g_object_class = g_type_class_ref (G_TYPE_OBJECT);
+
+ /* Need to make sure all the types are loaded in and initialize
+ * their signals and properties.
+ */
+ for (i=0; object_types[i]; i++) {
+ if (G_TYPE_IS_CLASSED (object_types[i]))
+ g_type_class_ref (object_types[i]);
+ if (G_TYPE_IS_INTERFACE (object_types[i]))
+ g_type_default_interface_ref (object_types[i]);
+ }
+
+ g_type_class_unref (g_object_class);
+
+ return object_types;
+}
+
+/*
+ * This uses GObject type functions to output signal prototypes and the object
+ * hierarchy.
+ */
+
+/* The output files */
+const gchar *signals_filename = "$new_signals_filename";
+const gchar *hierarchy_filename = "$new_hierarchy_filename";
+const gchar *interfaces_filename = "$new_interfaces_filename";
+const gchar *prerequisites_filename = "$new_prerequisites_filename";
+const gchar *args_filename = "$new_args_filename";
+
+static void output_signals (void);
+static void output_object_signals (FILE *fp,
+ GType object_type);
+static void output_object_signal (FILE *fp,
+ const gchar *object_class_name,
+ guint signal_id);
+static const gchar * get_type_name (GType type,
+ gboolean * is_pointer);
+static void output_object_hierarchy (void);
+static void output_hierarchy (FILE *fp,
+ GType type,
+ guint level);
+
+static void output_object_interfaces (void);
+static void output_interfaces (FILE *fp,
+ GType type);
+
+static void output_interface_prerequisites (void);
+static void output_prerequisites (FILE *fp,
+ GType type);
+
+static void output_args (void);
+static void output_object_args (FILE *fp, GType object_type);
+
+int
+main (int argc, char *argv[])
+{
+ ${type_init_func};
+
+ get_object_types ();
+
+ output_signals ();
+ output_object_hierarchy ();
+ output_object_interfaces ();
+ output_interface_prerequisites ();
+ output_args ();
+
+ return 0;
+}
+
+static void
+output_signals (void)
+{
+ FILE *fp;
+ gint i;
+
+ fp = fopen (signals_filename, "w");
+ if (fp == NULL) {
+ g_warning ("Couldn't open output file: %s : %s", signals_filename, g_strerror(errno));
+ return;
+ }
+
+ for (i = 0; object_types[i]; i++)
+ output_object_signals (fp, object_types[i]);
+
+ fclose (fp);
+}
+
+static gint
+compare_signals (const void *a, const void *b)
+{
+ const guint *signal_a = a;
+ const guint *signal_b = b;
+
+ return strcmp (g_signal_name (*signal_a), g_signal_name (*signal_b));
+}
+
+/* This outputs all the signals of one object. */
+static void
+output_object_signals (FILE *fp, GType object_type)
+{
+ const gchar *object_class_name;
+ guint *signals, n_signals;
+ guint sig;
+
+ if (G_TYPE_IS_INSTANTIATABLE (object_type) ||
+ G_TYPE_IS_INTERFACE (object_type)) {
+
+ object_class_name = g_type_name (object_type);
+
+ signals = g_signal_list_ids (object_type, &n_signals);
+ qsort (signals, n_signals, sizeof (guint), compare_signals);
+
+ for (sig = 0; sig < n_signals; sig++) {
+ output_object_signal (fp, object_class_name, signals[sig]);
+ }
+ g_free (signals);
+ }
+}
+
+/* This outputs one signal. */
+static void
+output_object_signal (FILE *fp,
+ const gchar *object_name,
+ guint signal_id)
+{
+ GSignalQuery query_info;
+ const gchar *type_name, *ret_type, *object_arg, *arg_name;
+ gchar *pos, *object_arg_lower;
+ gboolean is_pointer;
+ gchar buffer[1024];
+ guint i, param;
+ gint param_num, widget_num, event_num, callback_num;
+ gint *arg_num;
+ gchar signal_name[128];
+ gchar flags[16];
+
+ /* g_print ("Object: %s Signal: %u\\n", object_name, signal_id);*/
+
+ param_num = 1;
+ widget_num = event_num = callback_num = 0;
+
+ g_signal_query (signal_id, &query_info);
+
+ /* Output the signal object type and the argument name. We assume the
+ * type is a pointer - I think that is OK. We remove "Gtk" or "Gnome" and
+ * convert to lower case for the argument name. */
+ pos = buffer;
+ sprintf (pos, "%s ", object_name);
+ pos += strlen (pos);
+
+ /* Try to come up with a sensible variable name for the first arg
+ * It chops off 2 know prefixes :/ and makes the name lowercase
+ * It should replace lowercase -> uppercase with '_'
+ * GFileMonitor -> file_monitor
+ * GIOExtensionPoint -> extension_point
+ * GtkTreeView -> tree_view
+ * if 2nd char is upper case too
+ * search for first lower case and go back one char
+ * else
+ * search for next upper case
+ */
+ if (!strncmp (object_name, "Gtk", 3))
+ object_arg = object_name + 3;
+ else if (!strncmp (object_name, "Gnome", 5))
+ object_arg = object_name + 5;
+ else
+ object_arg = object_name;
+
+ object_arg_lower = g_ascii_strdown (object_arg, -1);
+ sprintf (pos, "*%s\\n", object_arg_lower);
+ pos += strlen (pos);
+ if (!strncmp (object_arg_lower, "widget", 6))
+ widget_num = 2;
+ g_free(object_arg_lower);
+
+ /* Convert signal name to use underscores rather than dashes '-'. */
+ strncpy (signal_name, query_info.signal_name, 127);
+ signal_name[127] = '\\0';
+ for (i = 0; signal_name[i]; i++) {
+ if (signal_name[i] == '-')
+ signal_name[i] = '_';
+ }
+
+ /* Output the signal parameters. */
+ for (param = 0; param < query_info.n_params; param++) {
+ type_name = get_type_name (query_info.param_types[param] & ~G_SIGNAL_TYPE_STATIC_SCOPE, &is_pointer);
+
+ /* Most arguments to the callback are called "arg1", "arg2", etc.
+ GtkWidgets are called "widget", "widget2", ...
+ GtkCallbacks are called "callback", "callback2", ... */
+ if (!strcmp (type_name, "GtkWidget")) {
+ arg_name = "widget";
+ arg_num = &widget_num;
+ }
+ else if (!strcmp (type_name, "GtkCallback")
+ || !strcmp (type_name, "GtkCCallback")) {
+ arg_name = "callback";
+ arg_num = &callback_num;
+ }
+ else {
+ arg_name = "arg";
+ arg_num = ¶m_num;
+ }
+ sprintf (pos, "%s ", type_name);
+ pos += strlen (pos);
+
+ if (!arg_num || *arg_num == 0)
+ sprintf (pos, "%s%s\\n", is_pointer ? "*" : " ", arg_name);
+ else
+ sprintf (pos, "%s%s%i\\n", is_pointer ? "*" : " ", arg_name,
+ *arg_num);
+ pos += strlen (pos);
+
+ if (arg_num) {
+ if (*arg_num == 0)
+ *arg_num = 2;
+ else
+ *arg_num += 1;
+ }
+ }
+
+ pos = flags;
+ /* We use one-character flags for simplicity. */
+ if (query_info.signal_flags & G_SIGNAL_RUN_FIRST)
+ *pos++ = 'f';
+ if (query_info.signal_flags & G_SIGNAL_RUN_LAST)
+ *pos++ = 'l';
+ if (query_info.signal_flags & G_SIGNAL_RUN_CLEANUP)
+ *pos++ = 'c';
+ if (query_info.signal_flags & G_SIGNAL_NO_RECURSE)
+ *pos++ = 'r';
+ if (query_info.signal_flags & G_SIGNAL_DETAILED)
+ *pos++ = 'd';
+ if (query_info.signal_flags & G_SIGNAL_ACTION)
+ *pos++ = 'a';
+ if (query_info.signal_flags & G_SIGNAL_NO_HOOKS)
+ *pos++ = 'h';
+ *pos = 0;
+
+ /* Output the return type and function name. */
+ ret_type = get_type_name (query_info.return_type & ~G_SIGNAL_TYPE_STATIC_SCOPE, &is_pointer);
+
+ fprintf (fp,
+
"<SIGNAL>\\n<NAME>%s::%s</NAME>\\n<RETURNS>%s%s</RETURNS>\\n<FLAGS>%s</FLAGS>\\n%s</SIGNAL>\\n\\n",
+ object_name, query_info.signal_name, ret_type, is_pointer ? "*" : "", flags, buffer);
+}
+
+
+/* Returns the type name to use for a signal argument or return value, given
+ the GtkType from the signal info. It also sets is_pointer to TRUE if the
+ argument needs a '*' since it is a pointer. */
+static const gchar *
+get_type_name (GType type, gboolean * is_pointer)
+{
+ const gchar *type_name;
+
+ *is_pointer = FALSE;
+ type_name = g_type_name (type);
+
+ switch (type) {
+ case G_TYPE_NONE:
+ case G_TYPE_CHAR:
+ case G_TYPE_UCHAR:
+ case G_TYPE_BOOLEAN:
+ case G_TYPE_INT:
+ case G_TYPE_UINT:
+ case G_TYPE_LONG:
+ case G_TYPE_ULONG:
+ case G_TYPE_FLOAT:
+ case G_TYPE_DOUBLE:
+ case G_TYPE_POINTER:
+ /* These all have normal C type names so they are OK. */
+ return type_name;
+
+ case G_TYPE_STRING:
+ /* A GtkString is really a gchar*. */
+ *is_pointer = TRUE;
+ return "gchar";
+
+ case G_TYPE_ENUM:
+ case G_TYPE_FLAGS:
+ /* We use a gint for both of these. Hopefully a subtype with a decent
+ name will be registered and used instead, as GTK+ does itself. */
+ return "gint";
+
+ case G_TYPE_BOXED:
+ /* The boxed type shouldn't be used itself, only subtypes. Though we
+ return 'gpointer' just in case. */
+ return "gpointer";
+
+ case G_TYPE_PARAM:
+ /* A GParam is really a GParamSpec*. */
+ *is_pointer = TRUE;
+ return "GParamSpec";
+
+#if GLIB_CHECK_VERSION (2, 25, 9)
+ case G_TYPE_VARIANT:
+ *is_pointer = TRUE;
+ return "GVariant";
+#endif
+
+default:
+ break;
+ }
+
+ /* For all GObject subclasses we can use the class name with a "*",
+ e.g. 'GtkWidget *'. */
+ if (g_type_is_a (type, G_TYPE_OBJECT))
+ *is_pointer = TRUE;
+
+ /* Also catch non GObject root types */
+ if (G_TYPE_IS_CLASSED (type))
+ *is_pointer = TRUE;
+
+ /* All boxed subtypes will be pointers as well. */
+ /* Exception: GStrv */
+ if (g_type_is_a (type, G_TYPE_BOXED) &&
+ !g_type_is_a (type, G_TYPE_STRV))
+ *is_pointer = TRUE;
+
+ /* All pointer subtypes will be pointers as well. */
+ if (g_type_is_a (type, G_TYPE_POINTER))
+ *is_pointer = TRUE;
+
+ /* But enums are not */
+ if (g_type_is_a (type, G_TYPE_ENUM) ||
+ g_type_is_a (type, G_TYPE_FLAGS))
+ *is_pointer = FALSE;
+
+ return type_name;
+}
+
+
+/* This outputs the hierarchy of all objects which have been initialized,
+ i.e. by calling their XXX_get_type() initialization function. */
+static void
+output_object_hierarchy (void)
+{
+ FILE *fp;
+ gint i,j;
+ GType root, type;
+ GType root_types[$ntypes] = { G_TYPE_INVALID, };
+
+ fp = fopen (hierarchy_filename, "w");
+ if (fp == NULL) {
+ g_warning ("Couldn't open output file: %s : %s", hierarchy_filename, g_strerror(errno));
+ return;
+ }
+ output_hierarchy (fp, G_TYPE_OBJECT, 0);
+ output_hierarchy (fp, G_TYPE_INTERFACE, 0);
+
+ for (i=0; object_types[i]; i++) {
+ root = object_types[i];
+ while ((type = g_type_parent (root))) {
+ root = type;
+ }
+ if ((root != G_TYPE_OBJECT) && (root != G_TYPE_INTERFACE)) {
+ for (j=0; root_types[j]; j++) {
+ if (root == root_types[j]) {
+ root = G_TYPE_INVALID; break;
+ }
+ }
+ if(root) {
+ root_types[j] = root;
+ output_hierarchy (fp, root, 0);
+ }
+ }
+ }
+
+ fclose (fp);
+}
+
+/* This is called recursively to output the hierarchy of a object. */
+static void
+output_hierarchy (FILE *fp,
+ GType type,
+ guint level)
+{
+ guint i;
+ GType *children;
+ guint n_children;
+
+ if (!type)
+ return;
+
+ for (i = 0; i < level; i++)
+ fprintf (fp, " ");
+ fprintf (fp, "%s\\n", g_type_name (type));
+
+ children = g_type_children (type, &n_children);
+
+ for (i=0; i < n_children; i++)
+ output_hierarchy (fp, children[i], level + 1);
+
+ g_free (children);
+}
+
+static void output_object_interfaces (void)
+{
+ guint i;
+ FILE *fp;
+
+ fp = fopen (interfaces_filename, "w");
+ if (fp == NULL) {
+ g_warning ("Couldn't open output file: %s : %s", interfaces_filename, g_strerror(errno));
+ return;
+ }
+ output_interfaces (fp, G_TYPE_OBJECT);
+
+ for (i = 0; object_types[i]; i++) {
+ if (!g_type_parent (object_types[i]) &&
+ (object_types[i] != G_TYPE_OBJECT) &&
+ G_TYPE_IS_INSTANTIATABLE (object_types[i])) {
+ output_interfaces (fp, object_types[i]);
+ }
+ }
+ fclose (fp);
+}
+
+static void
+output_interfaces (FILE *fp,
+ GType type)
+{
+ guint i;
+ GType *children, *interfaces;
+ guint n_children, n_interfaces;
+
+ if (!type)
+ return;
+
+ interfaces = g_type_interfaces (type, &n_interfaces);
+
+ if (n_interfaces > 0) {
+ fprintf (fp, "%s", g_type_name (type));
+ for (i=0; i < n_interfaces; i++)
+ fprintf (fp, " %s", g_type_name (interfaces[i]));
+ fprintf (fp, "\\n");
+ }
+ g_free (interfaces);
+
+ children = g_type_children (type, &n_children);
+
+ for (i=0; i < n_children; i++)
+ output_interfaces (fp, children[i]);
+
+ g_free (children);
+}
+
+static void output_interface_prerequisites (void)
+{
+ FILE *fp;
+
+ fp = fopen (prerequisites_filename, "w");
+ if (fp == NULL) {
+ g_warning ("Couldn't open output file: %s : %s", prerequisites_filename, g_strerror(errno));
+ return;
+ }
+ output_prerequisites (fp, G_TYPE_INTERFACE);
+ fclose (fp);
+}
+
+static void
+output_prerequisites (FILE *fp,
+ GType type)
+{
+#if GLIB_CHECK_VERSION(2,1,0)
+ guint i;
+ GType *children, *prerequisites;
+ guint n_children, n_prerequisites;
+
+ if (!type)
+ return;
+
+ prerequisites = g_type_interface_prerequisites (type, &n_prerequisites);
+
+ if (n_prerequisites > 0) {
+ fprintf (fp, "%s", g_type_name (type));
+ for (i=0; i < n_prerequisites; i++)
+ fprintf (fp, " %s", g_type_name (prerequisites[i]));
+ fprintf (fp, "\\n");
+ }
+ g_free (prerequisites);
+
+ children = g_type_children (type, &n_children);
+
+ for (i=0; i < n_children; i++)
+ output_prerequisites (fp, children[i]);
+
+ g_free (children);
+#endif
+}
+
+static void
+output_args (void)
+{
+ FILE *fp;
+ gint i;
+
+ fp = fopen (args_filename, "w");
+ if (fp == NULL) {
+ g_warning ("Couldn't open output file: %s : %s", args_filename, g_strerror(errno));
+ return;
+ }
+
+ for (i = 0; object_types[i]; i++) {
+ output_object_args (fp, object_types[i]);
+ }
+
+ fclose (fp);
+}
+
+static gint
+compare_param_specs (const void *a, const void *b)
+{
+ GParamSpec *spec_a = *(GParamSpec **)a;
+ GParamSpec *spec_b = *(GParamSpec **)b;
+
+ return strcmp (g_param_spec_get_name (spec_a), g_param_spec_get_name (spec_b));
+}
+
+/* Its common to have unsigned properties restricted
+ * to the signed range. Therefore we make this look
+ * a bit nicer by spelling out the max constants.
+ */
+
+/* Don't use "==" with floats, it might trigger a gcc warning. */
+#define GTKDOC_COMPARE_FLOAT(x, y) (x <= y && x >= y)
+
+static gchar*
+describe_double_constant (gdouble value)
+{
+ gchar *desc;
+
+ if (GTKDOC_COMPARE_FLOAT (value, G_MAXDOUBLE))
+ desc = g_strdup ("G_MAXDOUBLE");
+ else if (GTKDOC_COMPARE_FLOAT (value, G_MINDOUBLE))
+ desc = g_strdup ("G_MINDOUBLE");
+ else if (GTKDOC_COMPARE_FLOAT (value, -G_MAXDOUBLE))
+ desc = g_strdup ("-G_MAXDOUBLE");
+ else if (GTKDOC_COMPARE_FLOAT (value, G_MAXFLOAT))
+ desc = g_strdup ("G_MAXFLOAT");
+ else if (GTKDOC_COMPARE_FLOAT (value, G_MINFLOAT))
+ desc = g_strdup ("G_MINFLOAT");
+ else if (GTKDOC_COMPARE_FLOAT (value, -G_MAXFLOAT))
+ desc = g_strdup ("-G_MAXFLOAT");
+ else{
+ /* make sure floats are output with a decimal dot irrespective of
+ * current locale. Use formatd since we want human-readable numbers
+ * and do not need the exact same bit representation when deserialising */
+ desc = g_malloc0 (G_ASCII_DTOSTR_BUF_SIZE);
+ g_ascii_formatd (desc, G_ASCII_DTOSTR_BUF_SIZE, "%g", value);
+ }
+
+ return desc;
+}
+
+static gchar*
+describe_signed_constant (gsize size, gint64 value)
+{
+ gchar *desc = NULL;
+
+ switch (size) {
+ case 2:
+ if (sizeof (int) == 2) {
+ if (value == G_MAXINT)
+ desc = g_strdup ("G_MAXINT");
+ else if (value == G_MININT)
+ desc = g_strdup ("G_MININT");
+ }
+ break;
+ case 4:
+ if (sizeof (int) == 4) {
+ if (value == G_MAXINT)
+ desc = g_strdup ("G_MAXINT");
+ else if (value == G_MININT)
+ desc = g_strdup ("G_MININT");
+ }
+ if (value == G_MAXLONG)
+ desc = g_strdup ("G_MAXLONG");
+ else if (value == G_MINLONG)
+ desc = g_strdup ("G_MINLONG");
+ break;
+ case 8:
+ if (value == G_MAXINT64)
+ desc = g_strdup ("G_MAXINT64");
+ else if (value == G_MININT64)
+ desc = g_strdup ("G_MININT64");
+ break;
+ default:
+ break;
+ }
+ if (!desc)
+ desc = g_strdup_printf ("%" G_GINT64_FORMAT, value);
+
+ return desc;
+}
+
+static gchar*
+describe_unsigned_constant (gsize size, guint64 value)
+{
+ gchar *desc = NULL;
+
+ switch (size) {
+ case 2:
+ if (sizeof (int) == 2) {
+ if (value == (guint64)G_MAXINT)
+ desc = g_strdup ("G_MAXINT");
+ else if (value == G_MAXUINT)
+ desc = g_strdup ("G_MAXUINT");
+ }
+ break;
+ case 4:
+ if (sizeof (int) == 4) {
+ if (value == (guint64)G_MAXINT)
+ desc = g_strdup ("G_MAXINT");
+ else if (value == G_MAXUINT)
+ desc = g_strdup ("G_MAXUINT");
+ }
+ if (value == (guint64)G_MAXLONG)
+ desc = g_strdup ("G_MAXLONG");
+ else if (value == G_MAXULONG)
+ desc = g_strdup ("G_MAXULONG");
+ break;
+ case 8:
+ if (value == G_MAXINT64)
+ desc = g_strdup ("G_MAXINT64");
+ else if (value == G_MAXUINT64)
+ desc = g_strdup ("G_MAXUINT64");
+ break;
+ default:
+ break;
+ }
+ if (!desc)
+ desc = g_strdup_printf ("%" G_GUINT64_FORMAT, value);
+
+ return desc;
+}
+
+static gchar*
+describe_type (GParamSpec *spec)
+{
+ gchar *desc;
+ gchar *lower;
+ gchar *upper;
+
+ if (G_IS_PARAM_SPEC_CHAR (spec)) {
+ GParamSpecChar *pspec = G_PARAM_SPEC_CHAR (spec);
+
+ lower = describe_signed_constant (sizeof(gchar), pspec->minimum);
+ upper = describe_signed_constant (sizeof(gchar), pspec->maximum);
+ if (pspec->minimum == G_MININT8 && pspec->maximum == G_MAXINT8)
+ desc = g_strdup ("");
+ else if (pspec->minimum == G_MININT8)
+ desc = g_strdup_printf ("<= %s", upper);
+ else if (pspec->maximum == G_MAXINT8)
+ desc = g_strdup_printf (">= %s", lower);
+ else
+ desc = g_strdup_printf ("[%s,%s]", lower, upper);
+ g_free (lower);
+ g_free (upper);
+ }
+ else if (G_IS_PARAM_SPEC_UCHAR (spec)) {
+ GParamSpecUChar *pspec = G_PARAM_SPEC_UCHAR (spec);
+
+ lower = describe_unsigned_constant (sizeof(guchar), pspec->minimum);
+ upper = describe_unsigned_constant (sizeof(guchar), pspec->maximum);
+ if (pspec->minimum == 0 && pspec->maximum == G_MAXUINT8)
+ desc = g_strdup ("");
+ else if (pspec->minimum == 0)
+ desc = g_strdup_printf ("<= %s", upper);
+ else if (pspec->maximum == G_MAXUINT8)
+ desc = g_strdup_printf (">= %s", lower);
+ else
+ desc = g_strdup_printf ("[%s,%s]", lower, upper);
+ g_free (lower);
+ g_free (upper);
+ }
+ else if (G_IS_PARAM_SPEC_INT (spec)) {
+ GParamSpecInt *pspec = G_PARAM_SPEC_INT (spec);
+
+ lower = describe_signed_constant (sizeof(gint), pspec->minimum);
+ upper = describe_signed_constant (sizeof(gint), pspec->maximum);
+ if (pspec->minimum == G_MININT && pspec->maximum == G_MAXINT)
+ desc = g_strdup ("");
+ else if (pspec->minimum == G_MININT)
+ desc = g_strdup_printf ("<= %s", upper);
+ else if (pspec->maximum == G_MAXINT)
+ desc = g_strdup_printf (">= %s", lower);
+ else
+ desc = g_strdup_printf ("[%s,%s]", lower, upper);
+ g_free (lower);
+ g_free (upper);
+ }
+ else if (G_IS_PARAM_SPEC_UINT (spec)) {
+ GParamSpecUInt *pspec = G_PARAM_SPEC_UINT (spec);
+
+ lower = describe_unsigned_constant (sizeof(guint), pspec->minimum);
+ upper = describe_unsigned_constant (sizeof(guint), pspec->maximum);
+ if (pspec->minimum == 0 && pspec->maximum == G_MAXUINT)
+ desc = g_strdup ("");
+ else if (pspec->minimum == 0)
+ desc = g_strdup_printf ("<= %s", upper);
+ else if (pspec->maximum == G_MAXUINT)
+ desc = g_strdup_printf (">= %s", lower);
+ else
+ desc = g_strdup_printf ("[%s,%s]", lower, upper);
+ g_free (lower);
+ g_free (upper);
+ }
+ else if (G_IS_PARAM_SPEC_LONG (spec)) {
+ GParamSpecLong *pspec = G_PARAM_SPEC_LONG (spec);
+
+ lower = describe_signed_constant (sizeof(glong), pspec->minimum);
+ upper = describe_signed_constant (sizeof(glong), pspec->maximum);
+ if (pspec->minimum == G_MINLONG && pspec->maximum == G_MAXLONG)
+ desc = g_strdup ("");
+ else if (pspec->minimum == G_MINLONG)
+ desc = g_strdup_printf ("<= %s", upper);
+ else if (pspec->maximum == G_MAXLONG)
+ desc = g_strdup_printf (">= %s", lower);
+ else
+ desc = g_strdup_printf ("[%s,%s]", lower, upper);
+ g_free (lower);
+ g_free (upper);
+ }
+ else if (G_IS_PARAM_SPEC_ULONG (spec)) {
+ GParamSpecULong *pspec = G_PARAM_SPEC_ULONG (spec);
+
+ lower = describe_unsigned_constant (sizeof(gulong), pspec->minimum);
+ upper = describe_unsigned_constant (sizeof(gulong), pspec->maximum);
+ if (pspec->minimum == 0 && pspec->maximum == G_MAXULONG)
+ desc = g_strdup ("");
+ else if (pspec->minimum == 0)
+ desc = g_strdup_printf ("<= %s", upper);
+ else if (pspec->maximum == G_MAXULONG)
+ desc = g_strdup_printf (">= %s", lower);
+ else
+ desc = g_strdup_printf ("[%s,%s]", lower, upper);
+ g_free (lower);
+ g_free (upper);
+ }
+ else if (G_IS_PARAM_SPEC_INT64 (spec)) {
+ GParamSpecInt64 *pspec = G_PARAM_SPEC_INT64 (spec);
+
+ lower = describe_signed_constant (sizeof(gint64), pspec->minimum);
+ upper = describe_signed_constant (sizeof(gint64), pspec->maximum);
+ if (pspec->minimum == G_MININT64 && pspec->maximum == G_MAXINT64)
+ desc = g_strdup ("");
+ else if (pspec->minimum == G_MININT64)
+ desc = g_strdup_printf ("<= %s", upper);
+ else if (pspec->maximum == G_MAXINT64)
+ desc = g_strdup_printf (">= %s", lower);
+ else
+ desc = g_strdup_printf ("[%s,%s]", lower, upper);
+ g_free (lower);
+ g_free (upper);
+ }
+ else if (G_IS_PARAM_SPEC_UINT64 (spec)) {
+ GParamSpecUInt64 *pspec = G_PARAM_SPEC_UINT64 (spec);
+
+ lower = describe_unsigned_constant (sizeof(guint64), pspec->minimum);
+ upper = describe_unsigned_constant (sizeof(guint64), pspec->maximum);
+ if (pspec->minimum == 0 && pspec->maximum == G_MAXUINT64)
+ desc = g_strdup ("");
+ else if (pspec->minimum == 0)
+ desc = g_strdup_printf ("<= %s", upper);
+ else if (pspec->maximum == G_MAXUINT64)
+ desc = g_strdup_printf (">= %s", lower);
+ else
+ desc = g_strdup_printf ("[%s,%s]", lower, upper);
+ g_free (lower);
+ g_free (upper);
+ }
+ else if (G_IS_PARAM_SPEC_FLOAT (spec)) {
+ GParamSpecFloat *pspec = G_PARAM_SPEC_FLOAT (spec);
+
+ lower = describe_double_constant (pspec->minimum);
+ upper = describe_double_constant (pspec->maximum);
+ if (GTKDOC_COMPARE_FLOAT (pspec->minimum, -G_MAXFLOAT)) {
+ if (GTKDOC_COMPARE_FLOAT (pspec->maximum, G_MAXFLOAT))
+ desc = g_strdup ("");
+ else
+ desc = g_strdup_printf ("<= %s", upper);
+ }
+ else if (GTKDOC_COMPARE_FLOAT (pspec->maximum, G_MAXFLOAT))
+ desc = g_strdup_printf (">= %s", lower);
+ else
+ desc = g_strdup_printf ("[%s,%s]", lower, upper);
+ g_free (lower);
+ g_free (upper);
+ }
+ else if (G_IS_PARAM_SPEC_DOUBLE (spec)) {
+ GParamSpecDouble *pspec = G_PARAM_SPEC_DOUBLE (spec);
+
+ lower = describe_double_constant (pspec->minimum);
+ upper = describe_double_constant (pspec->maximum);
+ if (GTKDOC_COMPARE_FLOAT (pspec->minimum, -G_MAXDOUBLE)) {
+ if (GTKDOC_COMPARE_FLOAT (pspec->maximum, G_MAXDOUBLE))
+ desc = g_strdup ("");
+ else
+ desc = g_strdup_printf ("<= %s", upper);
+ }
+ else if (GTKDOC_COMPARE_FLOAT (pspec->maximum, G_MAXDOUBLE))
+ desc = g_strdup_printf (">= %s", lower);
+ else
+ desc = g_strdup_printf ("[%s,%s]", lower, upper);
+ g_free (lower);
+ g_free (upper);
+ }
+#if GLIB_CHECK_VERSION (2, 12, 0)
+ else if (G_IS_PARAM_SPEC_GTYPE (spec)) {
+ GParamSpecGType *pspec = G_PARAM_SPEC_GTYPE (spec);
+ gboolean is_pointer;
+
+ desc = g_strdup (get_type_name (pspec->is_a_type, &is_pointer));
+ }
+#endif
+#if GLIB_CHECK_VERSION (2, 25, 9)
+ else if (G_IS_PARAM_SPEC_VARIANT (spec)) {
+ GParamSpecVariant *pspec = G_PARAM_SPEC_VARIANT (spec);
+ gchar *variant_type;
+
+ variant_type = g_variant_type_dup_string (pspec->type);
+ desc = g_strdup_printf ("GVariant<%s>", variant_type);
+ g_free (variant_type);
+ }
+#endif
+ else {
+ desc = g_strdup ("");
+ }
+
+ return desc;
+}
+
+static gchar*
+describe_default (GParamSpec *spec)
+{
+ gchar *desc;
+
+ if (G_IS_PARAM_SPEC_CHAR (spec)) {
+ GParamSpecChar *pspec = G_PARAM_SPEC_CHAR (spec);
+
+ desc = g_strdup_printf ("%d", pspec->default_value);
+ }
+ else if (G_IS_PARAM_SPEC_UCHAR (spec)) {
+ GParamSpecUChar *pspec = G_PARAM_SPEC_UCHAR (spec);
+
+ desc = g_strdup_printf ("%u", pspec->default_value);
+ }
+ else if (G_IS_PARAM_SPEC_BOOLEAN (spec)) {
+ GParamSpecBoolean *pspec = G_PARAM_SPEC_BOOLEAN (spec);
+
+ desc = g_strdup_printf ("%s", pspec->default_value ? "TRUE" : "FALSE");
+ }
+ else if (G_IS_PARAM_SPEC_INT (spec)) {
+ GParamSpecInt *pspec = G_PARAM_SPEC_INT (spec);
+
+ desc = g_strdup_printf ("%d", pspec->default_value);
+ }
+ else if (G_IS_PARAM_SPEC_UINT (spec)) {
+ GParamSpecUInt *pspec = G_PARAM_SPEC_UINT (spec);
+
+ desc = g_strdup_printf ("%u", pspec->default_value);
+ }
+ else if (G_IS_PARAM_SPEC_LONG (spec)) {
+ GParamSpecLong *pspec = G_PARAM_SPEC_LONG (spec);
+
+ desc = g_strdup_printf ("%ld", pspec->default_value);
+ }
+ else if (G_IS_PARAM_SPEC_LONG (spec)) {
+ GParamSpecULong *pspec = G_PARAM_SPEC_ULONG (spec);
+
+ desc = g_strdup_printf ("%lu", pspec->default_value);
+ }
+ else if (G_IS_PARAM_SPEC_INT64 (spec)) {
+ GParamSpecInt64 *pspec = G_PARAM_SPEC_INT64 (spec);
+
+ desc = g_strdup_printf ("%" G_GINT64_FORMAT, pspec->default_value);
+ }
+ else if (G_IS_PARAM_SPEC_UINT64 (spec))
+ {
+ GParamSpecUInt64 *pspec = G_PARAM_SPEC_UINT64 (spec);
+
+ desc = g_strdup_printf ("%" G_GUINT64_FORMAT, pspec->default_value);
+ }
+ else if (G_IS_PARAM_SPEC_UNICHAR (spec)) {
+ GParamSpecUnichar *pspec = G_PARAM_SPEC_UNICHAR (spec);
+
+ if (g_unichar_isprint (pspec->default_value))
+ desc = g_strdup_printf ("'%c'", pspec->default_value);
+ else
+ desc = g_strdup_printf ("%u", pspec->default_value);
+ }
+ else if (G_IS_PARAM_SPEC_ENUM (spec)) {
+ GParamSpecEnum *pspec = G_PARAM_SPEC_ENUM (spec);
+
+ GEnumValue *value = g_enum_get_value (pspec->enum_class, pspec->default_value);
+ if (value)
+ desc = g_strdup_printf ("%s", value->value_name);
+ else
+ desc = g_strdup_printf ("%d", pspec->default_value);
+ }
+ else if (G_IS_PARAM_SPEC_FLAGS (spec)) {
+ GParamSpecFlags *pspec = G_PARAM_SPEC_FLAGS (spec);
+ guint default_value;
+ GString *acc;
+
+ default_value = pspec->default_value;
+ acc = g_string_new ("");
+
+ while (default_value) {
+ GFlagsValue *value = g_flags_get_first_value (pspec->flags_class, default_value);
+
+ if (!value)
+ break;
+
+ if (acc->len > 0)
+ g_string_append (acc, " | ");
+ g_string_append (acc, value->value_name);
+
+ default_value &= ~value->value;
+ }
+
+ if (default_value == 0)
+ desc = g_string_free (acc, FALSE);
+ else {
+ desc = g_strdup_printf ("%d", pspec->default_value);
+ g_string_free (acc, TRUE);
+ }
+ }
+ else if (G_IS_PARAM_SPEC_FLOAT (spec)) {
+ GParamSpecFloat *pspec = G_PARAM_SPEC_FLOAT (spec);
+
+ /* make sure floats are output with a decimal dot irrespective of
+ * current locale. Use formatd since we want human-readable numbers
+ * and do not need the exact same bit representation when deserialising */
+ desc = g_malloc0 (G_ASCII_DTOSTR_BUF_SIZE);
+ g_ascii_formatd (desc, G_ASCII_DTOSTR_BUF_SIZE, "%g",
+ pspec->default_value);
+ }
+ else if (G_IS_PARAM_SPEC_DOUBLE (spec)) {
+ GParamSpecDouble *pspec = G_PARAM_SPEC_DOUBLE (spec);
+
+ /* make sure floats are output with a decimal dot irrespective of
+ * current locale. Use formatd since we want human-readable numbers
+ * and do not need the exact same bit representation when deserialising */
+ desc = g_malloc0 (G_ASCII_DTOSTR_BUF_SIZE);
+ g_ascii_formatd (desc, G_ASCII_DTOSTR_BUF_SIZE, "%g",
+ pspec->default_value);
+ }
+ else if (G_IS_PARAM_SPEC_STRING (spec)) {
+ GParamSpecString *pspec = G_PARAM_SPEC_STRING (spec);
+
+ if (pspec->default_value) {
+ gchar *esc = g_strescape (pspec->default_value, NULL);
+ desc = g_strdup_printf ("\\"%s\\"", esc);
+ g_free (esc);
+ }
+ else
+ desc = g_strdup_printf ("NULL");
+ }
+#if GLIB_CHECK_VERSION (2, 25, 9)
+ else if (G_IS_PARAM_SPEC_VARIANT (spec)) {
+ GParamSpecVariant *pspec = G_PARAM_SPEC_VARIANT (spec);
+
+ if (pspec->default_value)
+ desc = g_variant_print (pspec->default_value, TRUE);
+ else
+ desc = g_strdup ("NULL");
+ }
+#endif
+ else {
+ desc = g_strdup ("");
+ }
+
+ return desc;
+}
+
+
+static void
+output_object_args (FILE *fp, GType object_type)
+{
+ gpointer class;
+ const gchar *object_class_name;
+ guint arg;
+ gchar flags[16], *pos;
+ GParamSpec **properties;
+ guint n_properties;
+ gboolean child_prop;
+ gboolean style_prop;
+ gboolean is_pointer;
+ const gchar *type_name;
+ gchar *type_desc;
+ gchar *default_value;
+
+ if (G_TYPE_IS_OBJECT (object_type)) {
+ class = g_type_class_peek (object_type);
+ if (!class)
+ return;
+
+ properties = g_object_class_list_properties (class, &n_properties);
+ }
+#if GLIB_MAJOR_VERSION > 2 || (GLIB_MAJOR_VERSION == 2 && GLIB_MINOR_VERSION >= 3)
+ else if (G_TYPE_IS_INTERFACE (object_type)) {
+ class = g_type_default_interface_ref (object_type);
+
+ if (!class)
+ return;
+
+ properties = g_object_interface_list_properties (class, &n_properties);
+ }
+#endif
+ else
+ return;
+
+ object_class_name = g_type_name (object_type);
+
+ child_prop = FALSE;
+ style_prop = FALSE;
+
+ while (TRUE) {
+ qsort (properties, n_properties, sizeof (GParamSpec *), compare_param_specs);
+ for (arg = 0; arg < n_properties; arg++) {
+ GParamSpec *spec = properties[arg];
+ const gchar *nick, *blurb, *dot;
+
+ if (spec->owner_type != object_type)
+ continue;
+
+ pos = flags;
+ /* We use one-character flags for simplicity. */
+ if (child_prop && !style_prop)
+ *pos++ = 'c';
+ if (style_prop)
+ *pos++ = 's';
+ if (spec->flags & G_PARAM_READABLE)
+ *pos++ = 'r';
+ if (spec->flags & G_PARAM_WRITABLE)
+ *pos++ = 'w';
+ if (spec->flags & G_PARAM_CONSTRUCT)
+ *pos++ = 'x';
+ if (spec->flags & G_PARAM_CONSTRUCT_ONLY)
+ *pos++ = 'X';
+ *pos = 0;
+
+ nick = g_param_spec_get_nick (spec);
+ blurb = g_param_spec_get_blurb (spec);
+
+ dot = "";
+ if (blurb) {
+ int str_len = strlen (blurb);
+ if (str_len > 0 && blurb[str_len - 1] != '.')
+ dot = ".";
+ }
+
+ type_desc = describe_type (spec);
+ default_value = describe_default (spec);
+ type_name = get_type_name (spec->value_type, &is_pointer);
+ fprintf (fp,
"<ARG>\\n<NAME>%s::%s</NAME>\\n<TYPE>%s%s</TYPE>\\n<RANGE>%s</RANGE>\\n<FLAGS>%s</FLAGS>\\n<NICK>%s</NICK>\\n<BLURB>%s%s</BLURB>\\n<DEFAULT>%s</DEFAULT>\\n</ARG>\\n\\n",
+ object_class_name, g_param_spec_get_name (spec), type_name, is_pointer ? "*" : "", type_desc,
flags, nick ? nick : "(null)", blurb ? blurb : "(null)", dot, default_value);
+ g_free (type_desc);
+ g_free (default_value);
+ }
+
+ g_free (properties);
+
+#ifdef GTK_IS_CONTAINER_CLASS
+ if (!child_prop && GTK_IS_CONTAINER_CLASS (class)) {
+ properties = gtk_container_class_list_child_properties (class, &n_properties);
+ child_prop = TRUE;
+ continue;
+ }
+#endif
+
+#ifdef GTK_IS_CELL_AREA_CLASS
+ if (!child_prop && GTK_IS_CELL_AREA_CLASS (class)) {
+ properties = gtk_cell_area_class_list_cell_properties (class, &n_properties);
+ child_prop = TRUE;
+ continue;
+ }
+#endif
+
+#ifdef GTK_IS_WIDGET_CLASS
+#if GTK_CHECK_VERSION(2,1,0) && !GTK_CHECK_VERSION(3,89,2)
+ if (!style_prop && GTK_IS_WIDGET_CLASS (class)) {
+ properties = gtk_widget_class_list_style_properties (GTK_WIDGET_CLASS (class), &n_properties);
+ style_prop = TRUE;
+ continue;
+ }
+#endif
+#endif
+
+"""
+
+MAIN_CODE_END = """
+ break;
+ }
+}
+"""
+
+
+def run(options):
+
+ c_file = options.module + '-scan.c'
+ output = open(c_file, 'w')
+
+ base_filename = os.path.join(options.output_dir, options.module)
+ old_signals_filename = base_filename + '.signals'
+ new_signals_filename = base_filename + '.signals.new'
+ old_hierarchy_filename = base_filename + '.hierarchy'
+ new_hierarchy_filename = base_filename + '.hierarchy.new'
+ old_interfaces_filename = base_filename + '.interfaces'
+ new_interfaces_filename = base_filename + '.interfaces.new'
+ old_prerequisites_filename = base_filename + '.prerequisites'
+ new_prerequisites_filename = base_filename + '.prerequisites.new'
+ old_args_filename = base_filename + '.args'
+ new_args_filename = base_filename + '.args.new'
+
+ # generate a C program to scan the types
+
+ includes = ""
+ forward_decls = ""
+ get_types = ""
+ ntypes = 1
+
+ for line in open(options.types):
+ if line.startswith('#include'):
+ includes += line
+ elif line.startswith('%') or line.strip() == '':
+ continue
+ else:
+ line = line.strip()
+ get_types += ' object_types[i++] = ' + line + ' ();\n'
+ forward_decls += 'extern GType ' + line + ' (void);\n'
+ ntypes += 1
+
+ output.write(COMMON_INCLUDES)
+
+ if includes:
+ output.write(includes)
+ else:
+ output.write(forward_decls)
+
+ if options.query_child_properties:
+ output.write(QUERY_CHILD_PROPS_PROTOTYPE % options.query_child_properties)
+
+ # substitute local vars in the template
+ type_init_func = options.type_init_func
+ output.write(string.Template(MAIN_CODE).substitute(locals()))
+
+ if options.query_child_properties:
+ output.write(QUERY_CHILD_PROPS_CODE % options.query_child_properties)
+
+ output.write(MAIN_CODE_END)
+
+ output.close()
+
+ # Compile and run our file
+ if 'libtool' in options.cc:
+ o_file = options.module + '-scan.lo'
+ else:
+ o_file = options.module + '-scan.o'
+
+ x_file = options.module + '-scan' + config.exeext
+
+ stdout = ""
+ if not options.verbose:
+ stdout = ">/dev/null"
+
+ # Compiling scanner
+ command = '%s %s %s -c -o %s %s' % (options.cc, stdout, options.cflags, o_file, c_file)
+ res = subprocess.check_call(command, shell=True)
+ if res > 0:
+ logging.warning('Compilation of scanner failed: %d', res)
+ return res
+
+ # Linking scanner
+ command = '%s %s %s %s -o %s' % (options.ld, stdout, o_file, options.ldflags, x_file)
+ res = subprocess.check_call(command, shell=True)
+ if res > 0:
+ logging.warning('Linking of scanner failed: %d', res)
+ return res
+
+ # Running scanner
+ command = '%s ./%s' % (options.run, x_file)
+ res = subprocess.check_call(command, shell=True)
+ if res > 0:
+ logging.warning('Running scanner failed: %d', res)
+ return res
+
+ if 'GTK_DOC_KEEP_INTERMEDIATE' not in os.environ:
+ os.unlink(c_file)
+ os.unlink(o_file)
+ os.unlink(x_file)
+
+ common.UpdateFileIfChanged(old_signals_filename, new_signals_filename, False)
+ common.UpdateFileIfChanged(old_hierarchy_filename, new_hierarchy_filename, False)
+ common.UpdateFileIfChanged(old_interfaces_filename, new_interfaces_filename, False)
+ common.UpdateFileIfChanged(old_prerequisites_filename, new_prerequisites_filename, False)
+ common.UpdateFileIfChanged(old_args_filename, new_args_filename, False)
+
+ return 0
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]
