1 /*
2 * Copyright (c) 2008-2009 Christian Hammond
3 * Copyright (c) 2008-2009 David Trowbridge
4 *
5 * Permission is hereby granted, free of charge, to any person obtaining a
6 * copy of this software and associated documentation files (the "Software"),
7 * to deal in the Software without restriction, including without limitation
8 * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9 * and/or sell copies of the Software, and to permit persons to whom the
10 * Software is furnished to do so, subject to the following conditions:
11 *
12 * The above copyright notice and this permission notice shall be included
13 * in all copies or substantial portions of the Software.
14 *
15 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21 * THE SOFTWARE.
22 */
23
24 #include "config.h"
25 #include <glib/gi18n-lib.h>
26
27 #include "prop-list.h"
28
29 #include "prop-editor.h"
30 #include "object-tree.h"
31
32 #include "gtkcelllayout.h"
33 #include "gtktreeview.h"
34 #include "gtktreeselection.h"
35 #include "gtkpopover.h"
36 #include "gtksearchentry.h"
37 #include "gtklabel.h"
38 #include "gtkstack.h"
39
40 enum
41 {
42 COLUMN_NAME,
43 COLUMN_VALUE,
44 COLUMN_TYPE,
45 COLUMN_DEFINED_AT,
46 COLUMN_TOOLTIP,
47 COLUMN_WRITABLE,
48 COLUMN_ATTRIBUTE
49 };
50
51 enum
52 {
53 PROP_0,
54 PROP_OBJECT_TREE,
55 PROP_CHILD_PROPERTIES,
56 PROP_SEARCH_ENTRY
57 };
58
59 struct _GtkInspectorPropListPrivate
60 {
61 GObject *object;
62 GtkListStore *model;
63 GHashTable *prop_iters;
64 gulong notify_handler_id;
65 GtkInspectorObjectTree *object_tree;
66 gboolean child_properties;
67 GtkTreeViewColumn *name_column;
68 GtkTreeViewColumn *attribute_column;
69 GtkWidget *tree;
70 GtkWidget *search_entry;
71 GtkWidget *search_stack;
72 };
73
G_DEFINE_TYPE_WITH_PRIVATE(GtkInspectorPropList,gtk_inspector_prop_list,GTK_TYPE_BOX)74 G_DEFINE_TYPE_WITH_PRIVATE (GtkInspectorPropList, gtk_inspector_prop_list, GTK_TYPE_BOX)
75
76 static void
77 search_close_clicked (GtkWidget *button,
78 GtkInspectorPropList *pl)
79 {
80 gtk_entry_set_text (GTK_ENTRY (pl->priv->search_entry), "");
81 gtk_stack_set_visible_child_name (GTK_STACK (pl->priv->search_stack), "title");
82 }
83
84 static gboolean
key_press_event(GtkWidget * window,GdkEvent * event,GtkInspectorPropList * pl)85 key_press_event (GtkWidget *window,
86 GdkEvent *event,
87 GtkInspectorPropList *pl)
88 {
89 if (!gtk_widget_get_mapped (GTK_WIDGET (pl)))
90 return GDK_EVENT_PROPAGATE;
91
92 if (gtk_search_entry_handle_event (GTK_SEARCH_ENTRY (pl->priv->search_entry), event))
93 {
94 gtk_stack_set_visible_child (GTK_STACK (pl->priv->search_stack), pl->priv->search_entry);
95 return GDK_EVENT_STOP;
96 }
97 return GDK_EVENT_PROPAGATE;
98 }
99
100 static void
hierarchy_changed(GtkWidget * widget,GtkWidget * previous_toplevel)101 hierarchy_changed (GtkWidget *widget,
102 GtkWidget *previous_toplevel)
103 {
104 if (previous_toplevel)
105 g_signal_handlers_disconnect_by_func (previous_toplevel, key_press_event, widget);
106 g_signal_connect (gtk_widget_get_toplevel (widget), "key-press-event",
107 G_CALLBACK (key_press_event), widget);
108 }
109
110 static void
gtk_inspector_prop_list_init(GtkInspectorPropList * pl)111 gtk_inspector_prop_list_init (GtkInspectorPropList *pl)
112 {
113 pl->priv = gtk_inspector_prop_list_get_instance_private (pl);
114 gtk_widget_init_template (GTK_WIDGET (pl));
115 gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (pl->priv->model),
116 COLUMN_NAME,
117 GTK_SORT_ASCENDING);
118 pl->priv->prop_iters = g_hash_table_new_full (g_str_hash,
119 g_str_equal,
120 NULL,
121 (GDestroyNotify) gtk_tree_iter_free);
122 }
123
124 static void
get_property(GObject * object,guint param_id,GValue * value,GParamSpec * pspec)125 get_property (GObject *object,
126 guint param_id,
127 GValue *value,
128 GParamSpec *pspec)
129 {
130 GtkInspectorPropList *pl = GTK_INSPECTOR_PROP_LIST (object);
131
132 switch (param_id)
133 {
134 case PROP_OBJECT_TREE:
135 g_value_take_object (value, pl->priv->object_tree);
136 break;
137
138 case PROP_CHILD_PROPERTIES:
139 g_value_set_boolean (value, pl->priv->child_properties);
140 break;
141
142 case PROP_SEARCH_ENTRY:
143 g_value_take_object (value, pl->priv->search_entry);
144 break;
145
146 default:
147 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
148 break;
149 }
150 }
151
152 static void
set_property(GObject * object,guint param_id,const GValue * value,GParamSpec * pspec)153 set_property (GObject *object,
154 guint param_id,
155 const GValue *value,
156 GParamSpec *pspec)
157 {
158 GtkInspectorPropList *pl = GTK_INSPECTOR_PROP_LIST (object);
159
160 switch (param_id)
161 {
162 case PROP_OBJECT_TREE:
163 pl->priv->object_tree = g_value_get_object (value);
164 break;
165
166 case PROP_CHILD_PROPERTIES:
167 pl->priv->child_properties = g_value_get_boolean (value);
168 break;
169
170 case PROP_SEARCH_ENTRY:
171 pl->priv->search_entry = g_value_get_object (value);
172 break;
173
174 default:
175 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, param_id, pspec);
176 break;
177 }
178 }
179
180 static void
show_object(GtkInspectorPropEditor * editor,GObject * object,const gchar * name,const gchar * tab,GtkInspectorPropList * pl)181 show_object (GtkInspectorPropEditor *editor,
182 GObject *object,
183 const gchar *name,
184 const gchar *tab,
185 GtkInspectorPropList *pl)
186 {
187 GtkTreeIter iter;
188 GtkWidget *popover;
189
190 popover = gtk_widget_get_ancestor (GTK_WIDGET (editor), GTK_TYPE_POPOVER);
191 gtk_widget_hide (popover);
192
193 g_object_set_data (G_OBJECT (pl->priv->object_tree), "next-tab", (gpointer)tab);
194 if (gtk_inspector_object_tree_find_object (pl->priv->object_tree, object, &iter))
195 {
196 gtk_inspector_object_tree_select_object (pl->priv->object_tree, object);
197 }
198 else if (gtk_inspector_object_tree_find_object (pl->priv->object_tree, pl->priv->object, &iter))
199 {
200 gtk_inspector_object_tree_append_object (pl->priv->object_tree, object, &iter, name);
201 gtk_inspector_object_tree_select_object (pl->priv->object_tree, object);
202 }
203 else
204 {
205 g_warning ("GtkInspector: couldn't find the widget in the tree");
206 }
207 }
208
209 static void
row_activated(GtkTreeView * tv,GtkTreePath * path,GtkTreeViewColumn * col,GtkInspectorPropList * pl)210 row_activated (GtkTreeView *tv,
211 GtkTreePath *path,
212 GtkTreeViewColumn *col,
213 GtkInspectorPropList *pl)
214 {
215 GtkTreeIter iter;
216 GdkRectangle rect;
217 gchar *name;
218 GtkWidget *editor;
219 GtkWidget *popover;
220
221 gtk_tree_model_get_iter (GTK_TREE_MODEL (pl->priv->model), &iter, path);
222 gtk_tree_model_get (GTK_TREE_MODEL (pl->priv->model), &iter, COLUMN_NAME, &name, -1);
223 gtk_tree_view_get_cell_area (tv, path, col, &rect);
224 gtk_tree_view_convert_bin_window_to_widget_coords (tv, rect.x, rect.y, &rect.x, &rect.y);
225
226 popover = gtk_popover_new (GTK_WIDGET (tv));
227 gtk_popover_set_pointing_to (GTK_POPOVER (popover), &rect);
228
229 editor = gtk_inspector_prop_editor_new (pl->priv->object, name, pl->priv->child_properties);
230 gtk_widget_show (editor);
231
232 gtk_container_add (GTK_CONTAINER (popover), editor);
233
234 if (gtk_inspector_prop_editor_should_expand (GTK_INSPECTOR_PROP_EDITOR (editor)))
235 gtk_widget_set_vexpand (popover, TRUE);
236
237 g_signal_connect (editor, "show-object", G_CALLBACK (show_object), pl);
238
239 gtk_popover_popup (GTK_POPOVER (popover));
240
241 g_signal_connect (popover, "unmap", G_CALLBACK (gtk_widget_destroy), NULL);
242
243 g_free (name);
244 }
245
246 static void cleanup_object (GtkInspectorPropList *pl);
247
248 static void
finalize(GObject * object)249 finalize (GObject *object)
250 {
251 GtkInspectorPropList *pl = GTK_INSPECTOR_PROP_LIST (object);
252
253 cleanup_object (pl);
254 g_hash_table_unref (pl->priv->prop_iters);
255
256 G_OBJECT_CLASS (gtk_inspector_prop_list_parent_class)->finalize (object);
257 }
258
259 static void
constructed(GObject * object)260 constructed (GObject *object)
261 {
262 GtkInspectorPropList *pl = GTK_INSPECTOR_PROP_LIST (object);
263
264 pl->priv->search_stack = gtk_widget_get_parent (pl->priv->search_entry);
265
266 gtk_tree_view_set_search_entry (GTK_TREE_VIEW (pl->priv->tree),
267 GTK_ENTRY (pl->priv->search_entry));
268
269 g_signal_connect (pl->priv->search_entry, "stop-search",
270 G_CALLBACK (search_close_clicked), pl);
271 }
272
273 static void
gtk_inspector_prop_list_class_init(GtkInspectorPropListClass * klass)274 gtk_inspector_prop_list_class_init (GtkInspectorPropListClass *klass)
275 {
276 GObjectClass *object_class = G_OBJECT_CLASS (klass);
277 GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass);
278
279 object_class->finalize = finalize;
280 object_class->get_property = get_property;
281 object_class->set_property = set_property;
282 object_class->constructed = constructed;
283
284 g_object_class_install_property (object_class, PROP_OBJECT_TREE,
285 g_param_spec_object ("object-tree", "Object Tree", "Object tree",
286 GTK_TYPE_WIDGET, G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
287 g_object_class_install_property (object_class, PROP_CHILD_PROPERTIES,
288 g_param_spec_boolean ("child-properties", "Child properties", "Child properties",
289 FALSE, G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
290
291 g_object_class_install_property (object_class, PROP_SEARCH_ENTRY,
292 g_param_spec_object ("search-entry", "Search Entry", "Search Entry",
293 GTK_TYPE_WIDGET, G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY));
294
295 gtk_widget_class_set_template_from_resource (widget_class, "/org/gtk/libgtk/inspector/prop-list.ui");
296 gtk_widget_class_bind_template_child_private (widget_class, GtkInspectorPropList, model);
297 gtk_widget_class_bind_template_child_private (widget_class, GtkInspectorPropList, attribute_column);
298 gtk_widget_class_bind_template_child_private (widget_class, GtkInspectorPropList, tree);
299 gtk_widget_class_bind_template_callback (widget_class, row_activated);
300 gtk_widget_class_bind_template_callback (widget_class, search_close_clicked);
301 gtk_widget_class_bind_template_callback (widget_class, hierarchy_changed);
302 }
303
304 /* Like g_strdup_value_contents, but keeps the type name separate */
305 static void
strdup_value_contents(const GValue * value,gchar ** contents,gchar ** type)306 strdup_value_contents (const GValue *value,
307 gchar **contents,
308 gchar **type)
309 {
310 const gchar *src;
311
312 if (G_VALUE_HOLDS_STRING (value))
313 {
314 src = g_value_get_string (value);
315
316 *type = g_strdup ("char*");
317
318 if (!src)
319 {
320 *contents = g_strdup ("NULL");
321 }
322 else
323 {
324 gchar *s = g_strescape (src, NULL);
325 *contents = g_strdup_printf ("\"%s\"", s);
326 g_free (s);
327 }
328 }
329 else if (g_value_type_transformable (G_VALUE_TYPE (value), G_TYPE_STRING))
330 {
331 GValue tmp_value = G_VALUE_INIT;
332
333 *type = g_strdup (g_type_name (G_VALUE_TYPE (value)));
334
335 g_value_init (&tmp_value, G_TYPE_STRING);
336 g_value_transform (value, &tmp_value);
337 src = g_value_get_string (&tmp_value);
338 if (!src)
339 *contents = g_strdup ("NULL");
340 else
341 *contents = g_strescape (src, NULL);
342 g_value_unset (&tmp_value);
343 }
344 else if (g_value_fits_pointer (value))
345 {
346 gpointer p = g_value_peek_pointer (value);
347
348 if (!p)
349 {
350 *type = g_strdup (g_type_name (G_VALUE_TYPE (value)));
351 *contents = g_strdup ("NULL");
352 }
353 else if (G_VALUE_HOLDS_OBJECT (value))
354 {
355 *type = g_strdup (G_OBJECT_TYPE_NAME (p));
356 *contents = g_strdup_printf ("%p", p);
357 }
358 else if (G_VALUE_HOLDS_PARAM (value))
359 {
360 *type = g_strdup (G_PARAM_SPEC_TYPE_NAME (p));
361 *contents = g_strdup_printf ("%p", p);
362 }
363 else if (G_VALUE_HOLDS (value, G_TYPE_STRV))
364 {
365 GStrv strv = g_value_get_boxed (value);
366 GString *tmp = g_string_new ("[");
367
368 while (*strv != NULL)
369 {
370 gchar *escaped = g_strescape (*strv, NULL);
371
372 g_string_append_printf (tmp, "\"%s\"", escaped);
373 g_free (escaped);
374
375 if (*++strv != NULL)
376 g_string_append (tmp, ", ");
377 }
378
379 g_string_append (tmp, "]");
380 *type = g_strdup ("char**");
381 *contents = g_string_free (tmp, FALSE);
382 }
383 else if (G_VALUE_HOLDS_BOXED (value))
384 {
385 *type = g_strdup (g_type_name (G_VALUE_TYPE (value)));
386 *contents = g_strdup_printf ("%p", p);
387 }
388 else if (G_VALUE_HOLDS_POINTER (value))
389 {
390 *type = g_strdup ("gpointer");
391 *contents = g_strdup_printf ("%p", p);
392 }
393 else
394 {
395 *type = g_strdup ("???");
396 *contents = g_strdup ("???");
397 }
398 }
399 else
400 {
401 *type = g_strdup ("???");
402 *contents = g_strdup ("???");
403 }
404 }
405
406 static void
gtk_inspector_prop_list_update_prop(GtkInspectorPropList * pl,GtkTreeIter * iter,GParamSpec * prop)407 gtk_inspector_prop_list_update_prop (GtkInspectorPropList *pl,
408 GtkTreeIter *iter,
409 GParamSpec *prop)
410 {
411 GValue gvalue = {0};
412 gchar *value;
413 gchar *type;
414 gchar *attribute = NULL;
415 gboolean writable;
416
417 g_value_init (&gvalue, prop->value_type);
418 if (pl->priv->child_properties)
419 {
420 GtkWidget *parent;
421
422 parent = gtk_widget_get_parent (GTK_WIDGET (pl->priv->object));
423 gtk_container_child_get_property (GTK_CONTAINER (parent),
424 GTK_WIDGET (pl->priv->object),
425 prop->name, &gvalue);
426 }
427 else
428 g_object_get_property (pl->priv->object, prop->name, &gvalue);
429
430 strdup_value_contents (&gvalue, &value, &type);
431
432 if (GTK_IS_CELL_RENDERER (pl->priv->object))
433 {
434 gpointer *layout;
435 GtkCellArea *area;
436 gint column = -1;
437
438 area = NULL;
439 layout = g_object_get_data (pl->priv->object, "gtk-inspector-cell-layout");
440 if (layout)
441 area = gtk_cell_layout_get_area (GTK_CELL_LAYOUT (layout));
442 if (area)
443 column = gtk_cell_area_attribute_get_column (area,
444 GTK_CELL_RENDERER (pl->priv->object),
445 prop->name);
446
447 if (column != -1)
448 attribute = g_strdup_printf ("%d", column);
449 }
450
451 writable = ((prop->flags & G_PARAM_WRITABLE) != 0) &&
452 ((prop->flags & G_PARAM_CONSTRUCT_ONLY) == 0);
453
454 gtk_list_store_set (pl->priv->model, iter,
455 COLUMN_NAME, prop->name,
456 COLUMN_VALUE, value ? value : "",
457 COLUMN_TYPE, type ? type : "",
458 COLUMN_DEFINED_AT, g_type_name (prop->owner_type),
459 COLUMN_TOOLTIP, g_param_spec_get_blurb (prop),
460 COLUMN_WRITABLE, writable,
461 COLUMN_ATTRIBUTE, attribute ? attribute : "",
462 -1);
463
464 g_free (value);
465 g_free (type);
466 g_free (attribute);
467 g_value_unset (&gvalue);
468 }
469
470 static void
gtk_inspector_prop_list_prop_changed_cb(GObject * pspec,GParamSpec * prop,GtkInspectorPropList * pl)471 gtk_inspector_prop_list_prop_changed_cb (GObject *pspec,
472 GParamSpec *prop,
473 GtkInspectorPropList *pl)
474 {
475 GtkTreeIter *iter;
476
477 if (!pl->priv->object)
478 return;
479
480 iter = g_hash_table_lookup (pl->priv->prop_iters, prop->name);
481 if (iter != NULL)
482 gtk_inspector_prop_list_update_prop (pl, iter, prop);
483 }
484
485 static void
cleanup_object(GtkInspectorPropList * pl)486 cleanup_object (GtkInspectorPropList *pl)
487 {
488 if (pl->priv->object &&
489 g_signal_handler_is_connected (pl->priv->object, pl->priv->notify_handler_id))
490 g_signal_handler_disconnect (pl->priv->object, pl->priv->notify_handler_id);
491
492 pl->priv->object = NULL;
493 pl->priv->notify_handler_id = 0;
494
495 g_hash_table_remove_all (pl->priv->prop_iters);
496 if (pl->priv->model)
497 gtk_list_store_clear (pl->priv->model);
498 }
499
500 gboolean
gtk_inspector_prop_list_set_object(GtkInspectorPropList * pl,GObject * object)501 gtk_inspector_prop_list_set_object (GtkInspectorPropList *pl,
502 GObject *object)
503 {
504 GtkTreeIter iter;
505 GParamSpec **props;
506 guint num_properties;
507 guint i;
508
509 if (!object)
510 return FALSE;
511
512 if (pl->priv->object == object)
513 return TRUE;
514
515 cleanup_object (pl);
516
517 gtk_entry_set_text (GTK_ENTRY (pl->priv->search_entry), "");
518 gtk_stack_set_visible_child_name (GTK_STACK (pl->priv->search_stack), "title");
519
520 if (pl->priv->child_properties)
521 {
522 GtkWidget *parent;
523
524 if (!GTK_IS_WIDGET (object))
525 {
526 gtk_widget_hide (GTK_WIDGET (pl));
527 return TRUE;
528 }
529
530 parent = gtk_widget_get_parent (GTK_WIDGET (object));
531 if (!parent)
532 {
533 gtk_widget_hide (GTK_WIDGET (pl));
534 return TRUE;
535 }
536
537 gtk_tree_view_column_set_visible (pl->priv->attribute_column, FALSE);
538
539 props = gtk_container_class_list_child_properties (G_OBJECT_GET_CLASS (parent), &num_properties);
540 }
541 else
542 {
543 gtk_tree_view_column_set_visible (pl->priv->attribute_column, GTK_IS_CELL_RENDERER (object));
544
545 props = g_object_class_list_properties (G_OBJECT_GET_CLASS (object), &num_properties);
546 }
547
548 pl->priv->object = object;
549
550 for (i = 0; i < num_properties; i++)
551 {
552 GParamSpec *prop = props[i];
553
554 if (! (prop->flags & G_PARAM_READABLE))
555 continue;
556
557 gtk_list_store_append (pl->priv->model, &iter);
558 gtk_inspector_prop_list_update_prop (pl, &iter, prop);
559
560 g_hash_table_insert (pl->priv->prop_iters, (gpointer) prop->name, gtk_tree_iter_copy (&iter));
561 }
562
563 g_free (props);
564
565 if (GTK_IS_WIDGET (object))
566 g_signal_connect_object (object, "destroy", G_CALLBACK (cleanup_object), pl, G_CONNECT_SWAPPED);
567
568 /* Listen for updates */
569 pl->priv->notify_handler_id =
570 g_signal_connect_object (object,
571 pl->priv->child_properties ? "child-notify" : "notify",
572 G_CALLBACK (gtk_inspector_prop_list_prop_changed_cb),
573 pl, 0);
574
575 gtk_widget_show (GTK_WIDGET (pl));
576
577 return TRUE;
578 }
579
580 // vim: set et sw=2 ts=2:
581