gtk-builder-tool.c 27.3 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
/*  Copyright 2015 Red Hat, Inc.
 *
 * GTK+ is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2 of the
 * License, or (at your option) any later version.
 *
 * GLib 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
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with GTK+; see the file COPYING.  If not,
 * see <http://www.gnu.org/licenses/>.
 *
 * Author: Matthias Clasen
 */

#include <stdlib.h>
#include <string.h>
22
#include <errno.h>
23 24

#include <glib/gi18n.h>
25
#include <glib/gprintf.h>
26
#include <glib/gstdio.h>
27
#include <gtk/gtk.h>
28
#include "gtkbuilderprivate.h"
29 30 31 32 33 34 35


typedef struct {
  GtkBuilder *builder;
  GList *classes;
  gboolean packing;
  gboolean packing_started;
36 37
  gboolean cell_packing;
  gboolean cell_packing_started;
38 39
  gint in_child;
  gint child_started;
40 41 42 43 44
  gchar **attribute_names;
  gchar **attribute_values;
  GString *value;
  gboolean unclosed_starttag;
  gint indent;
45 46 47
  char *input_filename;
  char *output_filename;
  FILE *output;
48
} MyParserData;
49

50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70
static void
canonicalize_key (gchar *key)
{
  gchar *p;

  for (p = key; *p != 0; p++)
    {
      gchar c = *p;

      /* We may meet something like AtkObject::accessible-name */
      if (c == ':' && ((p > key && p[-1] == ':') || p[1] == ':'))
        continue;

      if (c != '-' &&
          (c < '0' || c > '9') &&
          (c < 'A' || c > 'Z') &&
          (c < 'a' || c > 'z'))
        *p = '-';
    }
}

71 72 73 74
static GParamSpec *
get_property_pspec (MyParserData *data,
                    const gchar  *class_name,
                    const gchar  *property_name)
75 76 77 78 79 80 81 82
{
  GType type;
  GObjectClass *class;
  GParamSpec *pspec;
  gchar *canonical_name;

  type = g_type_from_name (class_name);
  if (type == G_TYPE_INVALID)
83
    return NULL;
84 85 86

  class = g_type_class_ref (type);
  canonical_name = g_strdup (property_name);
87
  canonicalize_key (canonical_name);
88 89
  if (data->packing)
    pspec = gtk_container_class_find_child_property (class, canonical_name);
90 91 92 93 94 95 96 97 98
  else if (data->cell_packing)
    {
      GObjectClass *cell_class;

      /* We're just assuming that the cell layout is using a GtkCellAreaBox. */
      cell_class = g_type_class_ref (GTK_TYPE_CELL_AREA_BOX);
      pspec = gtk_cell_area_class_find_cell_property (GTK_CELL_AREA_CLASS (cell_class), canonical_name);
      g_type_class_unref (cell_class);
    }
99 100 101 102 103
  else
    pspec = g_object_class_find_property (class, canonical_name);
  g_free (canonical_name);
  g_type_class_unref (class);

104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120
  return pspec;
}


static gboolean
value_is_default (MyParserData *data,
                  const gchar  *class_name,
                  const gchar  *property_name,
                  const gchar  *value_string)
{
  GValue value = { 0, };
  gboolean ret;
  GError *error = NULL;
  GParamSpec *pspec;

  pspec = get_property_pspec (data, class_name, property_name);

121 122
  if (pspec == NULL)
    {
123 124
      if (data->packing)
        g_printerr (_("Packing property %s::%s not found\n"), class_name, property_name);
125 126
      else if (data->cell_packing)
        g_printerr (_("Cell property %s::%s not found\n"), class_name, property_name);
127 128
      else
        g_printerr (_("Property %s::%s not found\n"), class_name, property_name);
129 130 131 132 133
      return FALSE;
    }
  else if (g_type_is_a (G_PARAM_SPEC_VALUE_TYPE (pspec), G_TYPE_OBJECT))
    return FALSE;

134
  if (!gtk_builder_value_from_string (data->builder, pspec, value_string, &value, &error))
135
    {
136
      g_printerr (_("Couldn't parse value for %s::%s: %s\n"), class_name, property_name, error->message);
137 138 139 140 141 142 143 144 145 146 147
      g_error_free (error);
      ret = FALSE;
    }
  else
    ret = g_param_value_defaults (pspec, &value);

  g_value_reset (&value);

  return ret;
}

148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174
static gboolean
property_is_boolean (MyParserData *data,
                     const gchar  *class_name,
                     const gchar  *property_name)
{
  GParamSpec *pspec;

  pspec = get_property_pspec (data, class_name, property_name);
  if (pspec)
    return G_PARAM_SPEC_VALUE_TYPE (pspec) == G_TYPE_BOOLEAN;

  return FALSE;
}

static const gchar *
canonical_boolean_value (MyParserData *data,
                         const gchar  *string)
{
  GValue value = G_VALUE_INIT;
  gboolean b = FALSE;

  if (gtk_builder_value_from_string_type (data->builder, G_TYPE_BOOLEAN, string, &value, NULL))
    b = g_value_get_boolean (&value);

  return b ? "1" : "0";
}

175 176 177 178 179 180 181
/* A number of properties unfortunately can't be omitted even
 * if they are nominally set to their default value. In many
 * cases, this is due to subclasses not overriding the default
 * value from the superclass.
 */
static gboolean
needs_explicit_setting (MyParserData *data,
182 183
                        const gchar  *class_name,
                        const gchar  *property_name)
184 185 186 187 188 189
{
  struct _Prop {
    const char *class;
    const char *property;
    gboolean packing;
  } props[] = {
190 191 192 193
    { "GtkAboutDialog", "program-name", 0 },
    { "GtkCalendar", "year", 0 },
    { "GtkCalendar", "month", 0 },
    { "GtkCalendar", "day", 0 },
194
    { "GtkDialog", "border-width", 0 },
195
    { "GtkPlacesSidebar", "show-desktop", 0 },
196 197 198
    { "GtkRadioButton", "draw-indicator", 0 },
    { "GtkGrid", "left-attach", 1 },
    { "GtkGrid", "top-attach", 1 },
199 200
    { "GtkWidget", "hexpand", 0 },
    { "GtkWidget", "vexpand", 0 },
201
    { "GtkContainer", "border-width", 0 },
202 203
    { "GtkVBox", "expand", 1 },
    { "GtkHBox", "expand", 1 },
204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229
    { NULL, NULL, 0 }
  };
  gchar *canonical_name;
  gboolean found;
  gint k;

  canonical_name = g_strdup (property_name);
  g_strdelimit (canonical_name, "_", '-');

  found = FALSE;
  for (k = 0; props[k].class; k++)
    {
      if (strcmp (class_name, props[k].class) == 0 &&
          strcmp (canonical_name, props[k].property) == 0 &&
          data->packing == props[k].packing)
        {
          found = TRUE;
          break;
        }
    }

  g_free (canonical_name);

  return found;
}

230 231 232 233 234 235 236
static void
maybe_start_packing (MyParserData *data)
{
  if (data->packing)
    {
      if (!data->packing_started)
        {
237
          g_fprintf (data->output, "%*s<packing>\n", data->indent, "");
238 239 240 241 242 243 244 245 246 247 248 249 250
          data->indent += 2;
          data->packing_started = TRUE;
        }
    }
}

static void
maybe_start_cell_packing (MyParserData *data)
{
  if (data->cell_packing)
    {
      if (!data->cell_packing_started)
        {
251
          g_fprintf (data->output, "%*s<cell-packing>\n", data->indent, "");
252 253 254 255 256 257
          data->indent += 2;
          data->cell_packing_started = TRUE;
        }
    }
}

258 259 260 261 262 263 264
static void
maybe_start_child (MyParserData *data)
{
  if (data->in_child > 0)
    {
      if (data->child_started < data->in_child)
        {
265
          g_fprintf (data->output, "%*s<child>\n", data->indent, "");
266 267 268 269 270 271
          data->indent += 2;
          data->child_started += 1;
        }
    }
}

272
static void
273
maybe_emit_property (MyParserData *data)
274 275 276
{
  gint i;
  gboolean bound;
277
  gboolean translatable;
278
  gchar *escaped;
279 280 281 282 283 284 285
  const gchar *class_name;
  const gchar *property_name;
  const gchar *value_string;

  class_name = (const gchar *)data->classes->data;
  property_name = "";
  value_string = (const gchar *)data->value->str;
286

287 288
  bound = FALSE;
  translatable = FALSE;
289 290
  for (i = 0; data->attribute_names[i]; i++)
    {
291 292 293 294
      if (strcmp (data->attribute_names[i], "bind-source") == 0 ||
          strcmp (data->attribute_names[i], "bind_source") == 0)
        bound = TRUE;
      else if (strcmp (data->attribute_names[i], "translatable") == 0)
295
        translatable = TRUE;
296 297
      else if (strcmp (data->attribute_names[i], "name") == 0)
        property_name = (const gchar *)data->attribute_values[i];
298 299
    }

300 301 302
  if (!translatable &&
      !bound &&
      !needs_explicit_setting (data, class_name, property_name))
303 304
    {
      for (i = 0; data->attribute_names[i]; i++)
305
        {
306 307 308 309
          if (strcmp (data->attribute_names[i], "name") == 0)
            {
              if (data->classes == NULL)
                break;
310

311
              if (value_is_default (data, class_name, property_name, value_string))
312 313
                return;
            }
314 315 316
        }
    }

317 318
  maybe_start_packing (data);
  maybe_start_cell_packing (data);
319

320
  g_fprintf (data->output, "%*s<property", data->indent, "");
321 322
  for (i = 0; data->attribute_names[i]; i++)
    {
323
      if (!translatable &&
324 325
          (strcmp (data->attribute_names[i], "comments") == 0 ||
           strcmp (data->attribute_names[i], "context") == 0))
326
        continue;
327

328
      escaped = g_markup_escape_text (data->attribute_values[i], -1);
329 330 331 332

      if (strcmp (data->attribute_names[i], "name") == 0)
        canonicalize_key (escaped);

333
      g_fprintf (data->output, " %s=\"%s\"", data->attribute_names[i], escaped);
334
      g_free (escaped);
335 336 337 338
    }

  if (bound)
    {
339
      g_fprintf (data->output, "/>\n");
340 341 342
    }
  else
    {
343
      g_fprintf (data->output, ">");
344 345
      if (property_is_boolean (data, class_name, property_name))
        {
346
          g_fprintf (data->output, "%s", canonical_boolean_value (data, value_string));
347 348 349 350
        }
      else
        {
          escaped = g_markup_escape_text (value_string, -1);
351
          g_fprintf (data->output, "%s", escaped);
352 353
          g_free (escaped);
        }
354
      g_fprintf (data->output, "</property>\n");
355 356 357 358
    }
}

static void
359
maybe_close_starttag (MyParserData *data)
360 361 362
{
  if (data->unclosed_starttag)
    {
363
      g_fprintf (data->output, ">\n");
364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412
      data->unclosed_starttag = FALSE;
    }
}

static gboolean
stack_is (GMarkupParseContext *context,
          ...)
{
  va_list args;
  gchar *s, *p;
  const GSList *stack;

  stack = g_markup_parse_context_get_element_stack (context);

  va_start (args, context);
  s = va_arg (args, gchar *);
  while (s)
    {
      if (stack == NULL)
        {
          va_end (args);
          return FALSE;
        }

      p = (gchar *)stack->data;
      if (strcmp (s, p) != 0)
        {
          va_end (args);
          return FALSE;
        }

      s = va_arg (args, gchar *);
      stack = stack->next;
    }

  va_end (args);
  return TRUE;
}

static void
start_element (GMarkupParseContext  *context,
               const gchar          *element_name,
               const gchar         **attribute_names,
               const gchar         **attribute_values,
               gpointer              user_data,
               GError              **error)
{
  gint i;
  gchar *escaped;
413
  MyParserData *data = user_data;
414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433

  maybe_close_starttag (data);

  if (strcmp (element_name, "property") == 0)
    {
      g_assert (data->attribute_names == NULL);
      g_assert (data->attribute_values == NULL);
      g_assert (data->value == NULL);

      data->attribute_names = g_strdupv ((gchar **)attribute_names);
      data->attribute_values = g_strdupv ((gchar **)attribute_values);
      data->value = g_string_new ("");

      return;
    }
  else if (strcmp (element_name, "packing") == 0)
    {
      data->packing = TRUE;
      data->packing_started = FALSE;

434 435 436 437 438 439 440
      return;
    }
  else if (strcmp (element_name, "cell-packing") == 0)
    {
      data->cell_packing = TRUE;
      data->cell_packing_started = FALSE;

441 442
      return;
    }
443 444 445 446 447 448 449 450 451
  else if (strcmp (element_name, "child") == 0)
    {
      data->in_child += 1;

      if (attribute_names[0] == NULL)
        return;

      data->child_started += 1;
    }
452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469
  else if (strcmp (element_name, "attribute") == 0)
    {
      /* attribute in label has no content */
      if (data->classes == NULL ||
          strcmp ((gchar *)data->classes->data, "GtkLabel") != 0)
        data->value = g_string_new ("");
    }
  else if (stack_is (context, "item", "items", NULL) ||
           stack_is (context, "action-widget", "action-widgets", NULL) ||
           stack_is (context, "mime-type", "mime-types", NULL) ||
           stack_is (context, "pattern", "patterns", NULL) ||
           stack_is (context, "application", "applications", NULL) ||
           stack_is (context, "col", "row", "data", NULL) ||
           stack_is (context, "mark", "marks", NULL) ||
           stack_is (context, "action", "accessibility", NULL))
    {
      data->value = g_string_new ("");
    }
470 471 472 473
  else if (strcmp (element_name, "placeholder") == 0)
    {
      return;
    }
474 475 476
  else if (strcmp (element_name, "object") == 0 ||
           strcmp (element_name, "template") == 0)
    {
477 478
      maybe_start_child (data);

479 480 481 482 483 484 485 486 487 488 489
      for (i = 0; attribute_names[i]; i++)
        {
          if (strcmp (attribute_names[i], "class") == 0)
            {
              data->classes = g_list_prepend (data->classes,
                                              g_strdup (attribute_values[i]));
              break;
            }
        }
    }

490
  g_fprintf (data->output, "%*s<%s", data->indent, "", element_name);
491 492 493
  for (i = 0; attribute_names[i]; i++)
    {
      escaped = g_markup_escape_text (attribute_values[i], -1);
494
      g_fprintf (data->output, " %s=\"%s\"", attribute_names[i], escaped);
495 496 497 498 499 500 501 502 503 504 505 506
      g_free (escaped);
    }
  data->unclosed_starttag = TRUE;
  data->indent += 2;
}

static void
end_element (GMarkupParseContext  *context,
             const gchar          *element_name,
             gpointer              user_data,
             GError              **error)
{
507
  MyParserData *data = user_data;
508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524

  if (strcmp (element_name, "property") == 0)
    {
      maybe_emit_property (data);

      g_clear_pointer (&data->attribute_names, g_strfreev);
      g_clear_pointer (&data->attribute_values, g_strfreev);
      g_string_free (data->value, TRUE);
      data->value = NULL;
      return;
    }
  else if (strcmp (element_name, "packing") == 0)
    {
      data->packing = FALSE;
      if (!data->packing_started)
        return;
    }
525 526 527 528 529 530
  else if (strcmp (element_name, "cell-packing") == 0)
    {
      data->cell_packing = FALSE;
      if (!data->cell_packing_started)
        return;
    }
531 532 533 534 535 536 537 538
  else if (strcmp (element_name, "child") == 0)
    {
      data->in_child -= 1;
      if (data->child_started == data->in_child)
        return;
      data->child_started -= 1;
    }
  else if (strcmp (element_name, "placeholder") == 0)
539 540 541 542 543 544 545 546 547 548
    {
      return;
    }
  else if (strcmp (element_name, "object") == 0 ||
           strcmp (element_name, "template") == 0)
    {
      g_free (data->classes->data);
      data->classes = g_list_delete_link (data->classes, data->classes);
    }

549 550 551
  if (data->value != NULL)
    {
      gchar *escaped;
552

553
      if (data->unclosed_starttag)
554
        g_fprintf (data->output, ">");
555 556

      escaped = g_markup_escape_text (data->value->str, -1);
557
      g_fprintf (data->output, "%s</%s>\n", escaped, element_name);
558 559 560 561 562
      g_free (escaped);

      g_string_free (data->value, TRUE);
      data->value = NULL;
    }
563
  else
564 565
    {
      if (data->unclosed_starttag)
566
        g_fprintf (data->output, "/>\n");
567
      else
568
        g_fprintf (data->output, "%*s</%s>\n", data->indent - 2, "", element_name);
569
    }
570

571
  data->indent -= 2;
572 573 574 575 576 577 578 579 580 581
  data->unclosed_starttag = FALSE;
}

static void
text (GMarkupParseContext  *context,
      const gchar          *text,
      gsize                 text_len,
      gpointer              user_data,
      GError              **error)
{
582
  MyParserData *data = user_data;
583 584 585 586 587 588 589 590 591 592 593 594 595 596 597

  if (data->value)
    {
      g_string_append_len (data->value, text, text_len);
      return;
    }
}

static void
passthrough (GMarkupParseContext  *context,
             const gchar          *text,
             gsize                 text_len,
             gpointer              user_data,
             GError              **error)
{
598
  MyParserData *data = user_data;
599 600 601

  maybe_close_starttag (data);

602
  g_fprintf (data->output, "%*s%s\n", data->indent, "", text);
603 604 605 606 607 608 609 610 611 612
}

GMarkupParser parser = {
  start_element,
  end_element,
  text,
  passthrough,
  NULL
};

613
static void
614 615
do_simplify (int          *argc,
             const char ***argv)
616 617 618
{
  GMarkupParseContext *context;
  gchar *buffer;
619
  MyParserData data;
620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656
  gboolean replace = FALSE;
  char **filenames = NULL;
  GOptionContext *ctx;
  const GOptionEntry entries[] = {
    { "replace", 0, 0, G_OPTION_ARG_NONE, &replace, NULL, NULL },
    { G_OPTION_REMAINING, 0, 0, G_OPTION_ARG_FILENAME_ARRAY, &filenames, NULL, NULL },
    { NULL, }
  };
  GError *error = NULL;

  ctx = g_option_context_new (NULL);
  g_option_context_set_help_enabled (ctx, FALSE);
  g_option_context_add_main_entries (ctx, entries, NULL);

  if (!g_option_context_parse (ctx, argc, (char ***)argv, &error))
    {
      g_printerr ("%s\n", error->message);
      g_error_free (error);
      exit (1);
    }

  g_option_context_free (ctx);

  if (filenames == NULL)
    {
      g_printerr ("No .ui file specified\n");
      exit (1);
    }

  if (g_strv_length (filenames) > 1)
    {
      g_printerr ("Can only simplify a single .ui file\n");
      exit (1);
    }

  data.input_filename = filenames[0];
  data.output_filename = NULL;
657

658 659 660 661 662 663 664 665 666 667 668 669
  if (replace)
    {
      int fd;
      fd = g_file_open_tmp ("gtk-builder-tool-XXXXXX", &data.output_filename, NULL);
      data.output = fdopen (fd, "w");
    }
  else
    {
      data.output = stdout;
    }

  if (!g_file_get_contents (filenames[0], &buffer, NULL, &error))
670
    {
671
      g_printerr (_("Can't load file: %s\n"), error->message);
672
      exit (1);
673 674 675 676 677 678 679 680 681
    }

  data.builder = gtk_builder_new ();
  data.classes = NULL;
  data.attribute_names = NULL;
  data.attribute_values = NULL;
  data.value = NULL;
  data.packing = FALSE;
  data.packing_started = FALSE;
682 683
  data.cell_packing = FALSE;
  data.cell_packing_started = FALSE;
684 685
  data.in_child = 0;
  data.child_started = 0;
686 687 688 689 690 691
  data.unclosed_starttag = FALSE;
  data.indent = 0;

  context = g_markup_parse_context_new (&parser, G_MARKUP_TREAT_CDATA_AS_TEXT, &data, NULL);
  if (!g_markup_parse_context_parse (context, buffer, -1, &error))
    {
692
      g_printerr (_("Can't parse file: %s\n"), error->message);
693
      exit (1);
694
    }
695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714

  fclose (data.output);

  if (data.output_filename)
    {
      char *content;
      gsize length;

      if (!g_file_get_contents (data.output_filename, &content, &length, &error))
        {
          g_printerr ("Failed to read %s: %s\n", data.output_filename, error->message);
          exit (1);
        }

      if (!g_file_set_contents (data.input_filename, content, length, &error))
        {
          g_printerr ("Failed to write %s: %s\n", data.input_filename, error->message);
          exit (1);
        }
    }
715 716
}

717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740
static GType
make_fake_type (const gchar *type_name,
                const gchar *parent_name)
{
  GType parent_type;
  GTypeQuery query;

  parent_type = g_type_from_name (parent_name);
  if (parent_type == G_TYPE_INVALID)
    {
      g_printerr ("Failed to lookup template parent type %s\n", parent_name);
      exit (1);
    }

  g_type_query (parent_type, &query);
  return g_type_register_static_simple (parent_type,
                                        type_name,
                                        query.class_size,
                                        NULL,
                                        query.instance_size,
                                        NULL,
                                        0);
}

741
static void
742 743 744
do_validate_template (const gchar *filename,
                      const gchar *type_name,
                      const gchar *parent_name)
745
{
746 747
  GType template_type;
  GtkWidget *widget;
748 749 750 751
  GtkBuilder *builder;
  GError *error = NULL;
  gint ret;

752 753 754 755 756 757 758 759 760 761 762 763 764 765
  /* Only make a fake type if it doesn't exist yet.
   * This lets us e.g. validate the GtkFileChooserWidget template.
   */
  template_type = g_type_from_name (type_name);
  if (template_type == G_TYPE_INVALID)
    template_type = make_fake_type (type_name, parent_name);

  widget = g_object_new (template_type, NULL);
  if (!widget)
    {
      g_printerr ("Failed to create an instance of the template type %s\n", type_name);
      exit (1);
    }

766
  builder = gtk_builder_new ();
767 768 769
  ret = gtk_builder_extend_with_template (builder, widget, template_type, " ", 1, &error);
  if (ret)
    ret = gtk_builder_add_from_file (builder, filename, &error);
770 771 772 773 774
  g_object_unref (builder);

  if (ret == 0)
    {
      g_printerr ("%s\n", error->message);
775
      exit (1);
776
    }
777 778
}

779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836
static gboolean
parse_template_error (const gchar  *message,
                      gchar       **class_name,
                      gchar       **parent_name)
{
  gchar *p;

  if (!strstr (message, "Not expecting to handle a template"))
    return FALSE;

  p = strstr (message, "(class '");
  if (p)
    {
      *class_name = g_strdup (p + strlen ("(class '"));
      p = strstr (*class_name, "'");
      if (p)
        *p = '\0';
    }
  p = strstr (message, ", parent '");
  if (p)
    {
      *parent_name = g_strdup (p + strlen (", parent '"));
      p = strstr (*parent_name, "'");
      if (p)
        *p = '\0';
    }

  return TRUE;
}

static void
do_validate (const gchar *filename)
{
  GtkBuilder *builder;
  GError *error = NULL;
  gint ret;
  gchar *class_name = NULL;
  gchar *parent_name = NULL;

  builder = gtk_builder_new ();
  ret = gtk_builder_add_from_file (builder, filename, &error);
  g_object_unref (builder);

  if (ret == 0)
    {
      if (g_error_matches (error, GTK_BUILDER_ERROR, GTK_BUILDER_ERROR_UNHANDLED_TAG)  &&
          parse_template_error (error->message, &class_name, &parent_name))
        {
          do_validate_template (filename, class_name, parent_name);
        }
      else
        {
          g_printerr ("%s\n", error->message);
          exit (1);
        }
    }
}

837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872
static const gchar *
object_get_name (GObject *object)
{
  if (GTK_IS_BUILDABLE (object))
    return gtk_buildable_get_name (GTK_BUILDABLE (object));
  else
    return g_object_get_data (object, "gtk-builder-name");
}

static void
do_enumerate (const gchar *filename)
{
  GtkBuilder *builder;
  GError *error = NULL;
  gint ret;
  GSList *list, *l;
  GObject *object;
  const gchar *name;

  builder = gtk_builder_new ();
  ret = gtk_builder_add_from_file (builder, filename, &error);

  if (ret == 0)
    {
      g_printerr ("%s\n", error->message);
      exit (1);
    }

  list = gtk_builder_get_objects (builder);
  for (l = list; l; l = l->next)
    {
      object = l->data;
      name = object_get_name (object);
      if (g_str_has_prefix (name, "___") && g_str_has_suffix (name, "___"))
        continue;

873
      g_printf ("%s (%s)\n", name, g_type_name_from_instance ((GTypeInstance*)object));
874 875 876 877 878 879
    }
  g_slist_free (list);

  g_object_unref (builder);
}

880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901
static void
set_window_title (GtkWindow  *window,
                  const char *filename,
                  const char *id)
{
  gchar *name;
  gchar *title;

  name = g_path_get_basename (filename);

  if (id)
    title = g_strdup_printf ("%s in %s", id, name);
  else
    title = g_strdup (name);

  gtk_window_set_title (window, title);

  g_free (title);
  g_free (name);
}

static void
902 903 904
preview_file (const char *filename,
              const char *id,
              const char *cssfile)
905 906 907 908 909 910
{
  GtkBuilder *builder;
  GError *error = NULL;
  GObject *object;
  GtkWidget *window;

911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926
  if (cssfile)
    {
      GtkCssProvider *provider;

      provider = gtk_css_provider_new ();
      if (!gtk_css_provider_load_from_path (provider, cssfile, &error))
        {
          g_printerr ("%s\n", error->message);
          exit (1);
        }

      gtk_style_context_add_provider_for_screen (gdk_screen_get_default (),
                                                 GTK_STYLE_PROVIDER (provider),
                                                 GTK_STYLE_PROVIDER_PRIORITY_APPLICATION);
    }

927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004
  builder = gtk_builder_new ();
  if (!gtk_builder_add_from_file (builder, filename, &error))
    {
      g_printerr ("%s\n", error->message);
      exit (1);
    }

  object = NULL;

  if (id)
    {
      object = gtk_builder_get_object (builder, id);
    }
  else
    {
      GSList *objects, *l;

      objects = gtk_builder_get_objects (builder);
      for (l = objects; l; l = l->next)
        {
          GObject *obj = l->data;

          if (GTK_IS_WINDOW (obj))
            {
              object = obj;
              break;
            }
          else if (GTK_IS_WIDGET (obj))
            {
              if (object == NULL)
                object = obj;
            }
        }
      g_slist_free (objects);
    }

  if (object == NULL)
    {
      if (id)
        g_printerr ("No object with ID '%s' found\n", id);
      else
        g_printerr ("No previewable object found\n");
      exit (1);
    }

  if (!GTK_IS_WIDGET (object))
    {
      g_printerr ("Objects of type %s can't be previewed\n", G_OBJECT_TYPE_NAME (object));
      exit (1);
    }

  if (GTK_IS_WINDOW (object))
    window = GTK_WIDGET (object);
  else
    {
      GtkWidget *widget = GTK_WIDGET (object);

      window = gtk_window_new (GTK_WINDOW_TOPLEVEL);

      if (GTK_IS_BUILDABLE (object))
        id = gtk_buildable_get_name (GTK_BUILDABLE (object));

      set_window_title (GTK_WINDOW (window), filename, id);

      g_object_ref (widget);
      if (gtk_widget_get_parent (widget) != NULL)
        gtk_container_remove (GTK_CONTAINER (gtk_widget_get_parent (widget)), widget);
      gtk_container_add (GTK_CONTAINER (window), widget);
      g_object_unref (widget);
    }

  gtk_window_present (GTK_WINDOW (window));

  gtk_main ();

  g_object_unref (builder);
}

1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015
static void
do_preview (int          *argc,
            const char ***argv)
{
  GOptionContext *context;
  char *id = NULL;
  char *css = NULL;
  char **filenames = NULL;
  const GOptionEntry entries[] = {
    { "id", 0, 0, G_OPTION_ARG_STRING, &id, NULL, NULL },
    { "css", 0, 0, G_OPTION_ARG_FILENAME, &css, NULL, NULL },
1016 1017
    { G_OPTION_REMAINING, 0, 0, G_OPTION_ARG_FILENAME_ARRAY, &filenames, NULL, NULL },
    { NULL, }
1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052
  };
  GError *error = NULL;

  context = g_option_context_new (NULL);
  g_option_context_set_help_enabled (context, FALSE);
  g_option_context_add_main_entries (context, entries, NULL);

  if (!g_option_context_parse (context, argc, (char ***)argv, &error))
    {
      g_printerr ("%s\n", error->message);
      g_error_free (error);
      exit (1);
    }

  g_option_context_free (context);

  if (filenames == NULL)
    {
      g_printerr ("No .ui file specified\n");
      exit (1);
    }

  if (g_strv_length (filenames) > 1)
    {
      g_printerr ("Can only preview a single .ui file\n");
      exit (1);
    }

  preview_file (filenames[0], id, css);

  g_strfreev (filenames);
  g_free (id);
  g_free (css);
}

1053 1054 1055
static void
usage (void)
{
1056 1057 1058 1059
  g_print (_("Usage:\n"
             "  gtk-builder-tool [COMMAND] FILE\n"
             "\n"
             "Commands:\n"
1060
             "  validate           Validate the file\n"
1061
             "  simplify [OPTIONS] Simplify the file\n"
1062 1063 1064
             "  enumerate          List all named objects\n"
             "  preview [OPTIONS]  Preview the file\n"
             "\n"
1065 1066 1067
             "Simplify Options:\n"
             "  --replace          Replace the file\n"
             "\n"
1068 1069 1070
             "Preview Options:\n"
             "  --id=ID            Preview only the named object\n"
             "  --css=FILE         Use style from CSS file\n"
1071
             "\n"
1072
             "Perform various tasks on GtkBuilder .ui files.\n"));
1073 1074 1075 1076
  exit (1);
}

int
1077
main (int argc, const char *argv[])
1078
{
1079 1080
  g_set_prgname ("gtk-builder-tool");

1081 1082 1083 1084
  gtk_init (NULL, NULL);

  gtk_test_register_all_types ();

1085
  if (argc < 3)
1086 1087
    usage ();

1088 1089 1090
  if (strcmp (argv[2], "--help") == 0)
    usage ();

1091 1092 1093 1094 1095 1096
  argv++;
  argc--;

  if (strcmp (argv[0], "validate") == 0)
    do_validate (argv[1]);
  else if (strcmp (argv[0], "simplify") == 0)
1097
    do_simplify (&argc, &argv);
1098 1099 1100 1101
  else if (strcmp (argv[0], "enumerate") == 0)
    do_enumerate (argv[1]);
  else if (strcmp (argv[0], "preview") == 0)
    do_preview (&argc, &argv);
1102 1103
  else
    usage ();
1104

1105 1106
  return 0;
}