1 /*
2  * Copyright (c) 2014 Benjamin Otte <otte@gnome.org>
3  *
4  * Permission is hereby granted, free of charge, to any person obtaining a
5  * copy of this software and associated documentation files (the "Software"),
6  * to deal in the Software without restriction, including without limitation
7  * the rights to use, copy, modify, merge, publish, distribute, sublicntnse,
8  * and/or sell copies of the Software, and to permit persons to whom the
9  * Software is furnished to do so, subject to the following conditions:
10  *
11  * The above copyright noticnt and this permission noticnt shall be included
12  * in all copies or substantial portions of the Software.
13  *
14  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20  * THE SOFTWARE.
21  */
22 
23 #include "config.h"
24 #include <glib/gi18n-lib.h>
25 
26 #include "css-node-tree.h"
27 #include "prop-editor.h"
28 
29 #include "gtktreemodelcssnode.h"
30 #include "gtktreeview.h"
31 #include "gtklabel.h"
32 #include "gtkpopover.h"
33 #include "gtk/gtkwidgetprivate.h"
34 #include "gtkcssproviderprivate.h"
35 #include "gtkcssstylepropertyprivate.h"
36 #include "gtkcsssectionprivate.h"
37 #include "gtkcssstyleprivate.h"
38 #include "gtkcssvalueprivate.h"
39 #include "gtkcssselectorprivate.h"
40 #include "gtkliststore.h"
41 #include "gtksettings.h"
42 #include "gtktreeview.h"
43 #include "gtktreeselection.h"
44 #include "gtktypebuiltins.h"
45 #include "gtkmodelbutton.h"
46 #include "gtkstack.h"
47 
48 enum {
49   COLUMN_NODE_NAME,
50   COLUMN_NODE_VISIBLE,
51   COLUMN_NODE_CLASSES,
52   COLUMN_NODE_ID,
53   COLUMN_NODE_STATE,
54   /* add more */
55   N_NODE_COLUMNS
56 };
57 
58 enum
59 {
60   COLUMN_PROP_NAME,
61   COLUMN_PROP_VALUE,
62   COLUMN_PROP_LOCATION
63 };
64 
65 struct _GtkInspectorCssNodeTreePrivate
66 {
67   GtkWidget *node_tree;
68   GtkTreeModel *node_model;
69   GtkTreeViewColumn *node_name_column;
70   GtkTreeViewColumn *node_id_column;
71   GtkTreeViewColumn *node_classes_column;
72   GtkListStore *prop_model;
73   GtkWidget *prop_tree;
74   GtkTreeViewColumn *prop_name_column;
75   GHashTable *prop_iters;
76   GtkCssNode *node;
77 };
78 
79 G_DEFINE_TYPE_WITH_PRIVATE (GtkInspectorCssNodeTree, gtk_inspector_css_node_tree, GTK_TYPE_BOX)
80 
81 typedef struct {
82   GtkCssNode *node;
83   const gchar *prop_name;
84   GdkRectangle rect;
85   GtkInspectorCssNodeTree *cnt;
86 } NodePropEditor;
87 
88 static void
show_node_prop_editor(NodePropEditor * npe)89 show_node_prop_editor (NodePropEditor *npe)
90 {
91   GtkWidget *popover;
92   GtkWidget *editor;
93 
94   popover = gtk_popover_new (GTK_WIDGET (npe->cnt->priv->node_tree));
95   gtk_popover_set_pointing_to (GTK_POPOVER (popover), &npe->rect);
96 
97   editor = gtk_inspector_prop_editor_new (G_OBJECT (npe->node), npe->prop_name, FALSE);
98   gtk_widget_show (editor);
99 
100   gtk_container_add (GTK_CONTAINER (popover), editor);
101 
102   if (gtk_inspector_prop_editor_should_expand (GTK_INSPECTOR_PROP_EDITOR (editor)))
103     gtk_widget_set_vexpand (popover, TRUE);
104 
105   gtk_popover_popup (GTK_POPOVER (popover));
106 
107   g_signal_connect (popover, "unmap", G_CALLBACK (gtk_widget_destroy), NULL);
108 }
109 
110 static void
row_activated(GtkTreeView * tv,GtkTreePath * path,GtkTreeViewColumn * col,GtkInspectorCssNodeTree * cnt)111 row_activated (GtkTreeView             *tv,
112                GtkTreePath             *path,
113                GtkTreeViewColumn       *col,
114                GtkInspectorCssNodeTree *cnt)
115 {
116   GtkTreeIter iter;
117   NodePropEditor npe;
118 
119   npe.cnt = cnt;
120 
121   if (col == cnt->priv->node_name_column)
122     npe.prop_name = "name";
123   else if (col == cnt->priv->node_id_column)
124     npe.prop_name = "id";
125   else if (col == cnt->priv->node_classes_column)
126     npe.prop_name = "classes";
127   else
128     return;
129 
130   gtk_tree_model_get_iter (cnt->priv->node_model, &iter, path);
131   npe.node = gtk_tree_model_css_node_get_node_from_iter (GTK_TREE_MODEL_CSS_NODE (cnt->priv->node_model), &iter);
132   gtk_tree_view_get_cell_area (tv, path, col, &npe.rect);
133   gtk_tree_view_convert_bin_window_to_widget_coords (tv, npe.rect.x, npe.rect.y, &npe.rect.x, &npe.rect.y);
134 
135   show_node_prop_editor (&npe);
136 }
137 
138 static void
139 gtk_inspector_css_node_tree_set_node (GtkInspectorCssNodeTree *cnt,
140                                       GtkCssNode              *node);
141 
142 static void
selection_changed(GtkTreeSelection * selection,GtkInspectorCssNodeTree * cnt)143 selection_changed (GtkTreeSelection *selection, GtkInspectorCssNodeTree *cnt)
144 {
145   GtkTreeIter iter;
146   GtkCssNode *node;
147 
148   if (!gtk_tree_selection_get_selected (selection, NULL, &iter))
149     return;
150 
151   node = gtk_tree_model_css_node_get_node_from_iter (GTK_TREE_MODEL_CSS_NODE (cnt->priv->node_model), &iter);
152   gtk_inspector_css_node_tree_set_node (cnt, node);
153 }
154 
155 static void
gtk_inspector_css_node_tree_unset_node(GtkInspectorCssNodeTree * cnt)156 gtk_inspector_css_node_tree_unset_node (GtkInspectorCssNodeTree *cnt)
157 {
158   GtkInspectorCssNodeTreePrivate *priv = cnt->priv;
159 
160   if (priv->node)
161     {
162       g_signal_handlers_disconnect_matched (priv->node,
163                                             G_SIGNAL_MATCH_DATA,
164                                             0, 0, NULL, NULL,
165                                             cnt);
166       g_object_unref (priv->node);
167       priv->node = NULL;
168     }
169 }
170 
171 static void
gtk_inspector_css_node_tree_finalize(GObject * object)172 gtk_inspector_css_node_tree_finalize (GObject *object)
173 {
174   GtkInspectorCssNodeTree *cnt = GTK_INSPECTOR_CSS_NODE_TREE (object);
175 
176   gtk_inspector_css_node_tree_unset_node (cnt);
177 
178   g_hash_table_unref (cnt->priv->prop_iters);
179 
180   G_OBJECT_CLASS (gtk_inspector_css_node_tree_parent_class)->finalize (object);
181 }
182 
183 static void
ensure_css_sections(void)184 ensure_css_sections (void)
185 {
186   GtkSettings *settings;
187   gchar *theme_name;
188 
189   gtk_css_provider_set_keep_css_sections ();
190 
191   settings = gtk_settings_get_default ();
192   g_object_get (settings, "gtk-theme-name", &theme_name, NULL);
193   g_object_set (settings, "gtk-theme-name", theme_name, NULL);
194   g_free (theme_name);
195 }
196 
197 static void
gtk_inspector_css_node_tree_class_init(GtkInspectorCssNodeTreeClass * klass)198 gtk_inspector_css_node_tree_class_init (GtkInspectorCssNodeTreeClass *klass)
199 {
200   GObjectClass *object_class = G_OBJECT_CLASS (klass);
201   GtkWidgetClass *widget_class = GTK_WIDGET_CLASS (klass);
202 
203   ensure_css_sections ();
204 
205   object_class->finalize = gtk_inspector_css_node_tree_finalize;
206 
207   gtk_widget_class_set_template_from_resource (widget_class, "/org/gtk/libgtk/inspector/css-node-tree.ui");
208   gtk_widget_class_bind_template_child_private (widget_class, GtkInspectorCssNodeTree, node_tree);
209   gtk_widget_class_bind_template_child_private (widget_class, GtkInspectorCssNodeTree, node_name_column);
210   gtk_widget_class_bind_template_child_private (widget_class, GtkInspectorCssNodeTree, node_id_column);
211   gtk_widget_class_bind_template_child_private (widget_class, GtkInspectorCssNodeTree, node_classes_column);
212   gtk_widget_class_bind_template_child_private (widget_class, GtkInspectorCssNodeTree, prop_name_column);
213   gtk_widget_class_bind_template_child_private (widget_class, GtkInspectorCssNodeTree, prop_model);
214   gtk_widget_class_bind_template_child_private (widget_class, GtkInspectorCssNodeTree, prop_name_column);
215 
216   gtk_widget_class_bind_template_callback (widget_class, row_activated);
217   gtk_widget_class_bind_template_callback (widget_class, selection_changed);
218 }
219 
220 static int
sort_strv(gconstpointer a,gconstpointer b,gpointer data)221 sort_strv (gconstpointer a,
222            gconstpointer b,
223            gpointer      data)
224 {
225   char **ap = (char **) a;
226   char **bp = (char **) b;
227 
228   return g_ascii_strcasecmp (*ap, *bp);
229 }
230 
231 static void
strv_sort(char ** strv)232 strv_sort (char **strv)
233 {
234   g_qsort_with_data (strv,
235 		     g_strv_length (strv),
236                      sizeof (char *),
237                      sort_strv,
238                      NULL);
239 }
240 
241 static gchar *
format_state_flags(GtkStateFlags state)242 format_state_flags (GtkStateFlags state)
243 {
244   if (state)
245     {
246       GString *str;
247       gint i;
248       gboolean first = TRUE;
249 
250       str = g_string_new ("");
251 
252       for (i = 0; i < 31; i++)
253         {
254           if (state & (1 << i))
255             {
256               if (!first)
257                 g_string_append (str, " | ");
258               first = FALSE;
259               g_string_append (str, gtk_css_pseudoclass_name (1 << i));
260             }
261         }
262       return g_string_free (str, FALSE);
263     }
264 
265  return g_strdup ("");
266 }
267 
268 static void
gtk_inspector_css_node_tree_get_node_value(GtkTreeModelCssNode * model,GtkCssNode * node,int column,GValue * value)269 gtk_inspector_css_node_tree_get_node_value (GtkTreeModelCssNode *model,
270                                             GtkCssNode          *node,
271                                             int                  column,
272                                             GValue              *value)
273 {
274   char **strv;
275   char *s;
276 
277   switch (column)
278     {
279     case COLUMN_NODE_NAME:
280       g_value_set_string (value, gtk_css_node_get_name (node));
281       break;
282 
283     case COLUMN_NODE_VISIBLE:
284       g_value_set_boolean (value, gtk_css_node_get_visible (node));
285       break;
286 
287     case COLUMN_NODE_CLASSES:
288       strv = gtk_css_node_get_classes (node);
289       strv_sort (strv);
290       s = g_strjoinv (" ", strv);
291       g_value_take_string (value, s);
292       g_strfreev (strv);
293       break;
294 
295     case COLUMN_NODE_ID:
296       g_value_set_string (value, gtk_css_node_get_id (node));
297       break;
298 
299     case COLUMN_NODE_STATE:
300       g_value_take_string (value, format_state_flags (gtk_css_node_get_state (node)));
301       break;
302 
303     default:
304       g_assert_not_reached ();
305       break;
306     }
307 }
308 
309 static void
gtk_inspector_css_node_tree_init(GtkInspectorCssNodeTree * cnt)310 gtk_inspector_css_node_tree_init (GtkInspectorCssNodeTree *cnt)
311 {
312   GtkInspectorCssNodeTreePrivate *priv;
313   gint i;
314 
315   cnt->priv = gtk_inspector_css_node_tree_get_instance_private (cnt);
316   gtk_widget_init_template (GTK_WIDGET (cnt));
317   priv = cnt->priv;
318 
319   priv->node_model = gtk_tree_model_css_node_new (gtk_inspector_css_node_tree_get_node_value,
320                                                   N_NODE_COLUMNS,
321                                                   G_TYPE_STRING,
322                                                   G_TYPE_BOOLEAN,
323                                                   G_TYPE_STRING,
324                                                   G_TYPE_STRING,
325                                                   G_TYPE_STRING);
326   gtk_tree_view_set_model (GTK_TREE_VIEW (priv->node_tree), priv->node_model);
327   g_object_unref (priv->node_model);
328 
329   gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (cnt->priv->prop_model),
330                                         COLUMN_PROP_NAME,
331                                         GTK_SORT_ASCENDING);
332 
333   priv->prop_iters = g_hash_table_new_full (g_str_hash, g_str_equal,
334                                             NULL, (GDestroyNotify) gtk_tree_iter_free);
335 
336   for (i = 0; i < _gtk_css_style_property_get_n_properties (); i++)
337     {
338       GtkCssStyleProperty *prop;
339       GtkTreeIter iter;
340       const gchar *name;
341 
342       prop = _gtk_css_style_property_lookup_by_id (i);
343       name = _gtk_style_property_get_name (GTK_STYLE_PROPERTY (prop));
344 
345       gtk_list_store_append (cnt->priv->prop_model, &iter);
346       gtk_list_store_set (cnt->priv->prop_model, &iter, COLUMN_PROP_NAME, name, -1);
347       g_hash_table_insert (cnt->priv->prop_iters, (gpointer)name, gtk_tree_iter_copy (&iter));
348     }
349 }
350 
351 void
gtk_inspector_css_node_tree_set_object(GtkInspectorCssNodeTree * cnt,GObject * object)352 gtk_inspector_css_node_tree_set_object (GtkInspectorCssNodeTree *cnt,
353                                         GObject                 *object)
354 {
355   GtkInspectorCssNodeTreePrivate *priv;
356   GtkCssNode *node, *root;
357   GtkTreePath *path;
358   GtkTreeIter iter;
359 
360   g_return_if_fail (GTK_INSPECTOR_IS_CSS_NODE_TREE (cnt));
361 
362   priv = cnt->priv;
363 
364   if (!GTK_IS_WIDGET (object))
365     {
366       gtk_widget_hide (GTK_WIDGET (cnt));
367       return;
368     }
369 
370   gtk_widget_show (GTK_WIDGET (cnt));
371 
372   root = node = gtk_widget_get_css_node (GTK_WIDGET (object));
373   while (gtk_css_node_get_parent (root))
374     root = gtk_css_node_get_parent (root);
375 
376   gtk_tree_model_css_node_set_root_node (GTK_TREE_MODEL_CSS_NODE (priv->node_model), root);
377 
378   gtk_tree_model_css_node_get_iter_from_node (GTK_TREE_MODEL_CSS_NODE (priv->node_model), &iter, node);
379   path = gtk_tree_model_get_path (priv->node_model, &iter);
380 
381   gtk_tree_view_expand_to_path (GTK_TREE_VIEW (priv->node_tree), path);
382   gtk_tree_view_set_cursor (GTK_TREE_VIEW (priv->node_tree), path, NULL, FALSE);
383   gtk_tree_view_scroll_to_cell (GTK_TREE_VIEW (priv->node_tree), path, NULL, TRUE, 0.5, 0.0);
384 
385   gtk_tree_path_free (path);
386 }
387 
388 static void
gtk_inspector_css_node_tree_update_style(GtkInspectorCssNodeTree * cnt,GtkCssStyle * new_style)389 gtk_inspector_css_node_tree_update_style (GtkInspectorCssNodeTree *cnt,
390                                           GtkCssStyle             *new_style)
391 {
392   GtkInspectorCssNodeTreePrivate *priv = cnt->priv;
393   gint i;
394 
395   for (i = 0; i < _gtk_css_style_property_get_n_properties (); i++)
396     {
397       GtkCssStyleProperty *prop;
398       const gchar *name;
399       GtkTreeIter *iter;
400       GtkCssSection *section;
401       gchar *location;
402       gchar *value;
403 
404       prop = _gtk_css_style_property_lookup_by_id (i);
405       name = _gtk_style_property_get_name (GTK_STYLE_PROPERTY (prop));
406 
407       iter = (GtkTreeIter *)g_hash_table_lookup (priv->prop_iters, name);
408 
409       if (new_style)
410         {
411           value = _gtk_css_value_to_string (gtk_css_style_get_value (new_style, i));
412 
413           section = gtk_css_style_get_section (new_style, i);
414           if (section)
415             location = _gtk_css_section_to_string (section);
416           else
417             location = NULL;
418         }
419       else
420         {
421           value = NULL;
422           location = NULL;
423         }
424 
425       gtk_list_store_set (priv->prop_model,
426                           iter,
427                           COLUMN_PROP_VALUE, value,
428                           COLUMN_PROP_LOCATION, location,
429                           -1);
430 
431       g_free (location);
432       g_free (value);
433     }
434 }
435 
436 static void
gtk_inspector_css_node_tree_update_style_cb(GtkCssNode * node,GtkCssStyleChange * change,GtkInspectorCssNodeTree * cnt)437 gtk_inspector_css_node_tree_update_style_cb (GtkCssNode              *node,
438                                              GtkCssStyleChange       *change,
439                                              GtkInspectorCssNodeTree *cnt)
440 {
441   gtk_inspector_css_node_tree_update_style (cnt, gtk_css_style_change_get_new_style (change));
442 }
443 
444 static void
gtk_inspector_css_node_tree_set_node(GtkInspectorCssNodeTree * cnt,GtkCssNode * node)445 gtk_inspector_css_node_tree_set_node (GtkInspectorCssNodeTree *cnt,
446                                       GtkCssNode              *node)
447 {
448   GtkInspectorCssNodeTreePrivate *priv = cnt->priv;
449 
450   if (priv->node == node)
451     return;
452 
453   if (node)
454     g_object_ref (node);
455 
456   gtk_inspector_css_node_tree_update_style (cnt, node ? gtk_css_node_get_style (node) : NULL);
457 
458   gtk_inspector_css_node_tree_unset_node (cnt);
459 
460   priv->node = node;
461 
462   g_signal_connect (node, "style-changed", G_CALLBACK (gtk_inspector_css_node_tree_update_style_cb), cnt);
463 }
464 
465 // vim: set et sw=2 ts=2:
466