#!@PERL@ -w # -*- cperl -*- # # gtk-doc - GTK DocBook documentation generator. # Copyright (C) 1998 Damon Chaplin # # 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 heirarchies and signals # by compiling a small C program. CFLAGS and LDFLAGS must be # set appropriately before running this script. # # NOTE: the lookup_signal_arg_names() function contains the argument names of # standard GTK signal handlers. This may need to be updated for new # GTK signals or Gnome widget signals. # FIXME: this is only needed for undocumented signals, we should remove # the list as its totally undermaintained anyway use Getopt::Long; push @INC, '@PACKAGE_DATA_DIR@'; require "gtkdoc-common.pl"; # Options # name of documentation module my $MODULE; my $OUTPUT_DIR; my $PRINT_VERSION; my $PRINT_HELP; my $TYPE_INIT_FUNC="g_type_init(); g_type_class_ref(G_TYPE_OBJECT)"; my $QUERY_CHILD_PROPERTIES; # --nogtkinit is deprecated, as it is the default now anyway. %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, 'version' => \$PRINT_VERSION, 'help' => \$PRINT_HELP); GetOptions(\%optctl, "module=s", "types:s", "output-dir:s", "nogtkinit", "type-init-func:s", "query-child-properties:s", "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 <$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"; # write a C program to scan the types $includes = ""; @types = (); for () { 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; push @types, $_; } } $ntypes = @types + 1; print OUTPUT < #include #include #include #include EOT if ($includes) { print OUTPUT $includes; } else { for (@types) { print OUTPUT "extern GType $_ (void);\n"; } } if ($QUERY_CHILD_PROPERTIES) { print OUTPUT < #endif GType object_types[$ntypes]; static GType * get_object_types (void) { gpointer g_object_class; gint i = 0; EOT for (@types) { print OUTPUT " object_types[i++] = $_ ();\n"; } print OUTPUT < 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. */ arg_names = lookup_signal_arg_names (object_name, signal_name); for (param = 0; param < query_info.n_params; param++) { if (arg_names) { sprintf (pos, "%s\\n", arg_names[param]); pos += strlen (pos); } else { 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. GdkWidgets are called "widget", "widget2", ... GdkEvents are called "event", "event2", ... GtkCallbacks are called "callback", "callback2", ... */ if (!strcmp (type_name, "GtkWidget")) { arg_name = "widget"; arg_num = &widget_num; } else if (!strcmp (type_name, "GdkEvent")) { type_name = get_gdk_event (signal_name); arg_name = "event"; arg_num = &event_num; is_pointer = TRUE; } 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, "\\n%s::%s\\n%s%s\\n%s\\n%s\\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"; 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. */ if (g_type_is_a (type, G_TYPE_BOXED)) *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; } static const gchar * get_gdk_event (const gchar * signal_name) { static const gchar *GbGDKEvents[] = { "button_press_event", "GdkEventButton", "button_release_event", "GdkEventButton", "motion_notify_event", "GdkEventMotion", "delete_event", "GdkEvent", "destroy_event", "GdkEvent", "expose_event", "GdkEventExpose", "key_press_event", "GdkEventKey", "key_release_event", "GdkEventKey", "enter_notify_event", "GdkEventCrossing", "leave_notify_event", "GdkEventCrossing", "configure_event", "GdkEventConfigure", "focus_in_event", "GdkEventFocus", "focus_out_event", "GdkEventFocus", "map_event", "GdkEvent", "unmap_event", "GdkEvent", "property_notify_event", "GdkEventProperty", "selection_clear_event", "GdkEventSelection", "selection_request_event", "GdkEventSelection", "selection_notify_event", "GdkEventSelection", "proximity_in_event", "GdkEventProximity", "proximity_out_event", "GdkEventProximity", "drag_begin_event", "GdkEventDragBegin", "drag_request_event", "GdkEventDragRequest", "drag_end_event", "GdkEventDragRequest", "drop_enter_event", "GdkEventDropEnter", "drop_leave_event", "GdkEventDropLeave", "drop_data_available_event", "GdkEventDropDataAvailable", "other_event", "GdkEventOther", "client_event", "GdkEventClient", "no_expose_event", "GdkEventNoExpose", "visibility_notify_event", "GdkEventVisibility", "window_state_event", "GdkEventWindowState", "scroll_event", "GdkEventScroll", NULL }; gint i; for (i = 0; GbGDKEvents[i]; i += 2) { if (!strcmp (signal_name, GbGDKEvents[i])) return GbGDKEvents[i + 1]; } return "GdkEvent"; } /* This returns argument names to use for some known GTK signals. It is passed a widget name, e.g. 'GtkCList' and a signal name, e.g. 'select_row' and it returns a pointer to an array of argument types and names. */ static const gchar ** lookup_signal_arg_names (const gchar * type, const gchar * signal_name) { /* Each arg array starts with the object type name and the signal name, and then signal arguments follow. */ static const gchar *GbArgTable[][16] = { {"GtkCList", "select_row", "gint row", "gint column", "GdkEventButton *event"}, {"GtkCList", "unselect_row", "gint row", "gint column", "GdkEventButton *event"}, {"GtkCList", "click_column", "gint column"}, {"GtkCList", "resize_column", "gint column", "gint width"}, {"GtkCList", "extend_selection", "GtkScrollType scroll_type", "gfloat position", "gboolean auto_start_selection"}, {"GtkCList", "scroll_vertical", "GtkScrollType scroll_type", "gfloat position"}, {"GtkCList", "scroll_horizontal", "GtkScrollType scroll_type", "gfloat position"}, {"GtkCTree", "tree_select_row", "GtkCTreeNode *node", "gint column"}, {"GtkCTree", "tree_unselect_row", "GtkCTreeNode *node", "gint column"}, {"GtkCTree", "tree_expand", "GtkCTreeNode *node"}, {"GtkCTree", "tree_collapse", "GtkCTreeNode *node"}, {"GtkCTree", "tree_move", "GtkCTreeNode *node", "GtkCTreeNode *new_parent", "GtkCTreeNode *new_sibling"}, {"GtkCTree", "change_focus_row_expansion", "GtkCTreeExpansionType expansion"}, {"GtkEditable", "insert_text", "gchar *new_text", "gint new_text_length", "gint *position"}, {"GtkEditable", "delete_text", "gint start_pos", "gint end_pos"}, {"GtkEditable", "set_editable", "gboolean is_editable"}, {"GtkEditable", "move_cursor", "gint x", "gint y"}, {"GtkEditable", "move_word", "gint num_words"}, {"GtkEditable", "move_page", "gint x", "gint y"}, {"GtkEditable", "move_to_row", "gint row"}, {"GtkEditable", "move_to_column", "gint column"}, {"GtkEditable", "kill_char", "gint direction"}, {"GtkEditable", "kill_word", "gint direction"}, {"GtkEditable", "kill_line", "gint direction"}, {"GtkInputDialog", "enable_device", "GdkDevice *deviceid"}, {"GtkInputDialog", "disable_device", "GdkDevice *deviceid"}, {"GtkListItem", "extend_selection", "GtkScrollType scroll_type", "gfloat position", "gboolean auto_start_selection"}, {"GtkListItem", "scroll_vertical", "GtkScrollType scroll_type", "gfloat position"}, {"GtkListItem", "scroll_horizontal", "GtkScrollType scroll_type", "gfloat position"}, {"GtkMenuShell", "move_current", "GtkMenuDirectionType direction"}, {"GtkMenuShell", "activate_current", "gboolean force_hide"}, {"GtkNotebook", "switch_page", "GtkNotebookPage *page", "guint page_num"}, {"GtkStatusbar", "text_pushed", "guint context_id", "gchar *text"}, {"GtkStatusbar", "text_popped", "guint context_id", "gchar *text"}, {"GtkTipsQuery", "widget_entered", "GtkWidget *widget", "gchar *tip_text", "gchar *tip_private"}, {"GtkTipsQuery", "widget_selected", "GtkWidget *widget", "gchar *tip_text", "gchar *tip_private", "GdkEventButton *event"}, {"GtkToolbar", "orientation_changed", "GtkOrientation orientation"}, {"GtkToolbar", "style_changed", "GtkToolbarStyle style"}, {"GtkWidget", "draw", "GdkRectangle *area"}, {"GtkWidget", "size_request", "GtkRequisition *requisition"}, {"GtkWidget", "size_allocate", "GtkAllocation *allocation"}, {"GtkWidget", "state_changed", "GtkStateType state"}, {"GtkWidget", "style_set", "GtkStyle *previous_style"}, {"GtkWidget", "install_accelerator", "gchar *signal_name", "gchar key", "gint modifiers"}, {"GtkWidget", "add_accelerator", "guint accel_signal_id", "GtkAccelGroup *accel_group", "guint accel_key", "GdkModifierType accel_mods", "GtkAccelFlags accel_flags"}, {"GtkWidget", "parent_set", "GtkObject *old_parent"}, {"GtkWidget", "remove_accelerator", "GtkAccelGroup *accel_group", "guint accel_key", "GdkModifierType accel_mods"}, {"GtkWidget", "debug_msg", "gchar *message"}, {"GtkWindow", "move_resize", "gint *x", "gint *y", "gint width", "gint height"}, {"GtkWindow", "set_focus", "GtkWidget *widget"}, {"GtkWidget", "selection_get", "GtkSelectionData *data", "guint info", "guint time"}, {"GtkWidget", "selection_received", "GtkSelectionData *data", "guint time"}, {"GtkWidget", "drag_begin", "GdkDragContext *drag_context"}, {"GtkWidget", "drag_end", "GdkDragContext *drag_context"}, {"GtkWidget", "drag_data_delete", "GdkDragContext *drag_context"}, {"GtkWidget", "drag_leave", "GdkDragContext *drag_context", "guint time"}, {"GtkWidget", "drag_motion", "GdkDragContext *drag_context", "gint x", "gint y", "guint time"}, {"GtkWidget", "drag_drop", "GdkDragContext *drag_context", "gint x", "gint y", "guint time"}, {"GtkWidget", "drag_data_get", "GdkDragContext *drag_context", "GtkSelectionData *data", "guint info", "guint time"}, {"GtkWidget", "drag_data_received", "GdkDragContext *drag_context", "gint x", "gint y", "GtkSelectionData *data", "guint info", "guint time"}, {NULL} }; gint i; for (i = 0; GbArgTable[i][0]; i++) { #if 1 if (!strcmp (type, GbArgTable[i][0]) && !strcmp (signal_name, GbArgTable[i][1])) return &GbArgTable[i][2]; #endif } return NULL; } /* 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; 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++) { if (!g_type_parent (object_types[i]) && (object_types[i] != G_TYPE_OBJECT) && (object_types[i] != G_TYPE_INTERFACE) ) { output_hierarchy (fp, object_types[i], 0); } } fclose (fp); } /* This is called recursively to output the hierarchy of a widget. */ 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 desc = g_strdup_printf ("%lg", 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"); else if (value == (gint64)G_MAXUINT) desc = g_strdup ("G_MAXUINT"); } 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"); else if (value == (gint64)G_MAXUINT) desc = g_strdup ("G_MAXUINT"); } if (value == G_MAXLONG) desc = g_strdup ("G_MAXLONG"); else if (value == G_MINLONG) desc = g_strdup ("G_MINLONG"); else if (value == (gint64)G_MAXULONG) desc = g_strdup ("G_MAXULONG"); 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); } 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); desc = g_strdup_printf ("%g", pspec->default_value); } else if (G_IS_PARAM_SPEC_DOUBLE (spec)) { GParamSpecDouble *pspec = G_PARAM_SPEC_DOUBLE (spec); desc = g_strdup_printf ("%lg", 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"); } 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, "\\n%s::%s\\n%s%s\\n%s\\n%s\\n%s\\n%s%s\\n%s\\n\\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_WIDGET_CLASS #if GTK_CHECK_VERSION(2,1,0) 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 <