gio/glib-compile-schemas.c

   1 /*
   2  * Copyright © 2010 Codethink Limited
   3  *
   4  * This library is free software; you can redistribute it and/or
   5  * modify it under the terms of the GNU Lesser General Public
   6  * License as published by the Free Software Foundation; either
   7  * version 2 of the licence, or (at your option) any later version.
   8  *
   9  * This library is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  12  * Lesser General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Lesser General Public
  15  * License along with this library; if not, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  *
  19  * Author: Ryan Lortie <desrt@desrt.ca>
  20  */
  21
  22 /* Prologue {{{1 */
  23 #define _GNU_SOURCE
  24 #include "config.h"
  25
  26 #include <gstdio.h>
  27 #include <locale.h>
  28 #include <string.h>
  29 #include <unistd.h>
  30 #include <stdio.h>
  31
  32 #include <gi18n.h>
  33
  34 #include "gvdb/gvdb-builder.h"
  35 #include "strinfo.c"
  36
  37 /* Handling of <enum> {{{1 */
  38 typedef struct
  39 {
  40   GString *strinfo;
  41
  42   gboolean is_flags;
  43 } EnumState;
  44
  45 static void
  46 enum_state_free (gpointer data)
  47 {
  48   EnumState *state = data;
  49
  50   g_string_free (state->strinfo, TRUE);
  51   g_slice_free (EnumState, state);
  52 }
  53
  54 EnumState *
  55 enum_state_new (gboolean is_flags)
  56 {
  57   EnumState *state;
  58
  59   state = g_slice_new (EnumState);
  60   state->strinfo = g_string_new (NULL);
  61   state->is_flags = is_flags;
  62
  63   return state;
  64 }
  65
  66 static void
  67 enum_state_add_value (EnumState    *state,
  68                       const gchar  *nick,
  69                       const gchar  *valuestr,
  70                       GError      **error)
  71 {
  72   gint64 value;
  73   gchar *end;
  74
  75   if (nick[0] == '\0' || nick[1] == '\0')
  76     {
  77       g_set_error (error, G_MARKUP_ERROR,
  78                    G_MARKUP_ERROR_INVALID_CONTENT,
  79                    "nick must be a minimum of 2 characters");
  80       return;
  81     }
  82
  83   value = g_ascii_strtoll (valuestr, &end, 0);
  84   if (*end || state->is_flags ?
  85                 (value > G_MAXUINT32 || value < 0) :
  86                 (value > G_MAXINT32 || value < G_MININT32))
  87     {
  88       g_set_error (error, G_MARKUP_ERROR,
  89                    G_MARKUP_ERROR_INVALID_CONTENT,
  90                    "invalid numeric value");
  91       return;
  92     }
  93
  94   if (strinfo_builder_contains (state->strinfo, nick))
  95     {
  96       g_set_error (error, G_MARKUP_ERROR,
  97                    G_MARKUP_ERROR_INVALID_CONTENT,
  98                    "<value nick='%s'/> already specified", nick);
  99       return;
 100     }
 101
 102   if (strinfo_builder_contains_value (state->strinfo, value))
 103     {
 104       g_set_error (error, G_MARKUP_ERROR,
 105                    G_MARKUP_ERROR_INVALID_CONTENT,
 106                    "value='%s' already specified", valuestr);
 107       return;
 108     }
 109
 110   if (state->is_flags && (value & (value - 1)))
 111     {
 112       g_set_error (error, G_MARKUP_ERROR,
 113                    G_MARKUP_ERROR_INVALID_CONTENT,
 114                    "flags values must have at most 1 bit set");
 115       return;
 116     }
 117
 118   /* Since we reject exact duplicates of value='' and we only allow one
 119    * bit to be set, it's not possible to have overlaps.
 120    *
 121    * If we loosen the one-bit-set restriction we need an overlap check.
 122    */
 123
 124
 125   strinfo_builder_append_item (state->strinfo, nick, value);
 126 }
 127
 128 static void
 129 enum_state_end (EnumState **state_ptr,
 130                 GError    **error)
 131 {
 132   EnumState *state;
 133
 134   state = *state_ptr;
 135   *state_ptr = NULL;
 136
 137   if (state->strinfo->len == 0)
 138     g_set_error (error,
 139                  G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
 140                  "<%s> must contain at least one <value>",
 141                  state->is_flags ? "flags" : "enum");
 142 }
 143
 144 /* Handling of <key> {{{1 */
 145 typedef struct
 146 {
 147   /* for <child>, @child_schema will be set.
 148    * for <key>, everything else will be set.
 149    */
 150   gchar        *child_schema;
 151
 152
 153   GVariantType *type;
 154   gboolean      have_gettext_domain;
 155
 156   gchar         l10n;
 157   gchar        *l10n_context;
 158   GString      *unparsed_default_value;
 159   GVariant     *default_value;
 160
 161   GString      *strinfo;
 162   gboolean      is_enum;
 163   gboolean      is_flags;
 164
 165   GVariant     *minimum;
 166   GVariant     *maximum;
 167
 168   gboolean      has_choices;
 169   gboolean      has_aliases;
 170   gboolean      is_override;
 171
 172   gboolean      checked;
 173   GVariant     *serialised;
 174 } KeyState;
 175
 176 static KeyState *
 177 key_state_new (const gchar *type_string,
 178                const gchar *gettext_domain,
 179                gboolean     is_enum,
 180                gboolean     is_flags,
 181                GString     *strinfo)
 182 {
 183   KeyState *state;
 184
 185   state = g_slice_new0 (KeyState);
 186   state->type = g_variant_type_new (type_string);
 187   state->have_gettext_domain = gettext_domain != NULL;
 188   state->is_enum = is_enum;
 189   state->is_flags = is_flags;
 190
 191   if (strinfo)
 192     state->strinfo = g_string_new_len (strinfo->str, strinfo->len);
 193   else
 194     state->strinfo = g_string_new (NULL);
 195
 196   return state;
 197 }
 198
 199 static KeyState *
 200 key_state_override (KeyState    *state,
 201                     const gchar *gettext_domain)
 202 {
 203   KeyState *copy;
 204
 205   copy = g_slice_new0 (KeyState);
 206   copy->type = g_variant_type_copy (state->type);
 207   copy->have_gettext_domain = gettext_domain != NULL;
 208   copy->strinfo = g_string_new_len (state->strinfo->str,
 209                                     state->strinfo->len);
 210   copy->is_enum = state->is_enum;
 211   copy->is_flags = state->is_flags;
 212   copy->is_override = TRUE;
 213
 214   if (state->minimum)
 215     {
 216       copy->minimum = g_variant_ref (state->minimum);
 217       copy->maximum = g_variant_ref (state->maximum);
 218     }
 219
 220   return copy;
 221 }
 222
 223 static KeyState *
 224 key_state_new_child (const gchar *child_schema)
 225 {
 226   KeyState *state;
 227
 228   state = g_slice_new0 (KeyState);
 229   state->child_schema = g_strdup (child_schema);
 230
 231   return state;
 232 }
 233
 234 static gboolean
 235 is_valid_choices (GVariant *variant,
 236                   GString  *strinfo)
 237 {
 238   switch (g_variant_classify (variant))
 239     {
 240       case G_VARIANT_CLASS_MAYBE:
 241       case G_VARIANT_CLASS_ARRAY:
 242         {
 243           gboolean valid = TRUE;
 244           GVariantIter iter;
 245
 246           g_variant_iter_init (&iter, variant);
 247
 248           while (valid && (variant = g_variant_iter_next_value (&iter)))
 249             {
 250               valid = is_valid_choices (variant, strinfo);
 251               g_variant_unref (variant);
 252             }
 253
 254           return valid;
 255         }
 256
 257       case G_VARIANT_CLASS_STRING:
 258         return strinfo_is_string_valid ((const guint32 *) strinfo->str,
 259                                         strinfo->len / 4,
 260                                         g_variant_get_string (variant, NULL));
 261
 262       default:
 263         g_assert_not_reached ();
 264     }
 265 }
 266
 267
 268 /* Gets called at </default> </choices> or <range/> to check for
 269  * validity of the default value so that any inconsistency is
 270  * reported as soon as it is encountered.
 271  */
 272 static void
 273 key_state_check_range (KeyState  *state,
 274                        GError   **error)
 275 {
 276   if (state->default_value)
 277     {
 278       const gchar *tag;
 279
 280       tag = state->is_override ? "override" : "default";
 281
 282       if (state->minimum)
 283         {
 284           if (g_variant_compare (state->default_value, state->minimum) < 0 ||
 285               g_variant_compare (state->default_value, state->maximum) > 0)
 286             {
 287               g_set_error (error, G_MARKUP_ERROR,
 288                            G_MARKUP_ERROR_INVALID_CONTENT,
 289                            "<%s> is not contained in "
 290                            "the specified range", tag);
 291             }
 292         }
 293
 294       else if (state->strinfo->len)
 295         {
 296           if (!is_valid_choices (state->default_value, state->strinfo))
 297             {
 298               if (state->is_enum)
 299                 g_set_error (error, G_MARKUP_ERROR,
 300                              G_MARKUP_ERROR_INVALID_CONTENT,
 301                              "<%s> is not a valid member of "
 302                              "the specified enumerated type", tag);
 303
 304               else if (state->is_flags)
 305                 g_set_error (error, G_MARKUP_ERROR,
 306                              G_MARKUP_ERROR_INVALID_CONTENT,
 307                              "<%s> contains string not in the "
 308                              "specified flags type", tag);
 309
 310               else
 311                 g_set_error (error, G_MARKUP_ERROR,
 312                              G_MARKUP_ERROR_INVALID_CONTENT,
 313                              "<%s> contains string not in "
 314                              "<choices>", tag);
 315             }
 316         }
 317     }
 318 }
 319
 320 static void
 321 key_state_set_range (KeyState     *state,
 322                      const gchar  *min_str,
 323                      const gchar  *max_str,
 324                      GError      **error)
 325 {
 326   if (state->minimum)
 327     {
 328       g_set_error_literal (error, G_MARKUP_ERROR,
 329                            G_MARKUP_ERROR_INVALID_CONTENT,
 330                            "<range/> already specified for this key");
 331       return;
 332     }
 333
 334   if (strchr ("ynqiuxtd", *(char *) state->type) == NULL)
 335     {
 336       gchar *type = g_variant_type_dup_string (state->type);
 337       g_set_error (error, G_MARKUP_ERROR,
 338                   G_MARKUP_ERROR_INVALID_CONTENT,
 339                   "<range> not allowed for keys of type '%s'", type);
 340       g_free (type);
 341       return;
 342     }
 343
 344   state->minimum = g_variant_parse (state->type, min_str, NULL, NULL, error);
 345   if (state->minimum == NULL)
 346     return;
 347
 348   state->maximum = g_variant_parse (state->type, max_str, NULL, NULL, error);
 349   if (state->maximum == NULL)
 350     return;
 351
 352   if (g_variant_compare (state->minimum, state->maximum) > 0)
 353     {
 354       g_set_error (error, G_MARKUP_ERROR,
 355                    G_MARKUP_ERROR_INVALID_CONTENT,
 356                    "<range> specified minimum is greater than maxmimum");
 357       return;
 358     }
 359
 360   key_state_check_range (state, error);
 361 }
 362
 363 static GString *
 364 key_state_start_default (KeyState     *state,
 365                          const gchar  *l10n,
 366                          const gchar  *context,
 367                          GError      **error)
 368 {
 369   if (l10n != NULL)
 370     {
 371       if (strcmp (l10n, "messages") == 0)
 372         state->l10n = 'm';
 373
 374       else if (strcmp (l10n, "time") == 0)
 375         state->l10n = 't';
 376
 377       else
 378         {
 379           g_set_error (error, G_MARKUP_ERROR,
 380                        G_MARKUP_ERROR_INVALID_CONTENT,
 381                        "unsupported l10n category: %s", l10n);
 382           return NULL;
 383         }
 384
 385       if (!state->have_gettext_domain)
 386         {
 387           g_set_error_literal (error, G_MARKUP_ERROR,
 388                                G_MARKUP_ERROR_INVALID_CONTENT,
 389                                "l10n requested, but no "
 390                                "gettext domain given");
 391           return NULL;
 392         }
 393
 394       state->l10n_context = g_strdup (context);
 395     }
 396
 397   else if (context != NULL)
 398     {
 399       g_set_error_literal (error, G_MARKUP_ERROR,
 400                            G_MARKUP_ERROR_INVALID_CONTENT,
 401                            "translation context given for "
 402                            " value without l10n enabled");
 403       return NULL;
 404     }
 405
 406   return g_string_new (NULL);
 407 }
 408
 409 static void
 410 key_state_end_default (KeyState  *state,
 411                        GString  **string,
 412                        GError   **error)
 413 {
 414   state->unparsed_default_value = *string;
 415   *string = NULL;
 416
 417   state->default_value = g_variant_parse (state->type,
 418                                           state->unparsed_default_value->str,
 419                                           NULL, NULL, error);
 420   key_state_check_range (state, error);
 421 }
 422
 423 static void
 424 key_state_start_choices (KeyState  *state,
 425                          GError   **error)
 426 {
 427   const GVariantType *type = state->type;
 428
 429   if (state->is_enum)
 430     {
 431       g_set_error_literal (error, G_MARKUP_ERROR,
 432                            G_MARKUP_ERROR_INVALID_CONTENT,
 433                            "<choices> can not be specified for keys "
 434                            "tagged as having an enumerated type");
 435       return;
 436     }
 437
 438   if (state->has_choices)
 439     {
 440       g_set_error_literal (error, G_MARKUP_ERROR,
 441                            G_MARKUP_ERROR_INVALID_CONTENT,
 442                            "<choices> already specified for this key");
 443       return;
 444     }
 445
 446   while (g_variant_type_is_maybe (type) || g_variant_type_is_array (type))
 447     type = g_variant_type_element (type);
 448
 449   if (!g_variant_type_equal (type, G_VARIANT_TYPE_STRING))
 450     {
 451       gchar *type_string = g_variant_type_dup_string (state->type);
 452       g_set_error (error, G_MARKUP_ERROR,
 453                    G_MARKUP_ERROR_INVALID_CONTENT,
 454                    "<choices> not allowed for keys of type '%s'",
 455                    type_string);
 456       g_free (type_string);
 457       return;
 458     }
 459 }
 460
 461 static void
 462 key_state_add_choice (KeyState     *state,
 463                       const gchar  *choice,
 464                       GError      **error)
 465 {
 466   if (strinfo_builder_contains (state->strinfo, choice))
 467     {
 468       g_set_error (error, G_MARKUP_ERROR,
 469                    G_MARKUP_ERROR_INVALID_CONTENT,
 470                    "<choice value='%s'/> already given", choice);
 471       return;
 472     }
 473
 474   strinfo_builder_append_item (state->strinfo, choice, 0);
 475   state->has_choices = TRUE;
 476 }
 477
 478 static void
 479 key_state_end_choices (KeyState  *state,
 480                        GError   **error)
 481 {
 482   if (!state->has_choices)
 483     {
 484       g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
 485                    "<choices> must contain at least one <choice>");
 486       return;
 487     }
 488
 489   key_state_check_range (state, error);
 490 }
 491
 492 static void
 493 key_state_start_aliases (KeyState  *state,
 494                          GError   **error)
 495 {
 496   if (state->has_aliases)
 497     g_set_error_literal (error, G_MARKUP_ERROR,
 498                          G_MARKUP_ERROR_INVALID_CONTENT,
 499                          "<aliases> already specified for this key");
 500
 501   if (!state->is_flags && !state->is_enum && !state->has_choices)
 502     g_set_error_literal (error, G_MARKUP_ERROR,
 503                          G_MARKUP_ERROR_INVALID_CONTENT,
 504                          "<aliases> can only be specified for keys with "
 505                          "enumerated or flags types or after <choices>");
 506 }
 507
 508 static void
 509 key_state_add_alias (KeyState     *state,
 510                      const gchar  *alias,
 511                      const gchar  *target,
 512                      GError      **error)
 513 {
 514   if (strinfo_builder_contains (state->strinfo, alias))
 515     {
 516       if (strinfo_is_string_valid ((guint32 *) state->strinfo->str,
 517                                    state->strinfo->len / 4,
 518                                    alias))
 519         {
 520           if (state->is_enum)
 521             g_set_error (error, G_MARKUP_ERROR,
 522                          G_MARKUP_ERROR_INVALID_CONTENT,
 523                          "<alias value='%s'/> given when '%s' is already "
 524                          "a member of the enumerated type", alias, alias);
 525
 526           else
 527             g_set_error (error, G_MARKUP_ERROR,
 528                          G_MARKUP_ERROR_INVALID_CONTENT,
 529                          "<alias value='%s'/> given when "
 530                          "<choice value='%s'/> was already given",
 531                          alias, alias);
 532         }
 533
 534       else
 535         g_set_error (error, G_MARKUP_ERROR,
 536                      G_MARKUP_ERROR_INVALID_CONTENT,
 537                      "<alias value='%s'/> already specified", alias);
 538
 539       return;
 540     }
 541
 542   if (!strinfo_builder_append_alias (state->strinfo, alias, target))
 543     {
 544       g_set_error (error, G_MARKUP_ERROR,
 545                    G_MARKUP_ERROR_INVALID_CONTENT,
 546                    "alias target '%s' is not in %s", target,
 547                    state->is_enum ? "enumerated type" : "<choices>");
 548       return;
 549     }
 550
 551   state->has_aliases = TRUE;
 552 }
 553
 554 static void
 555 key_state_end_aliases (KeyState  *state,
 556                        GError   **error)
 557 {
 558   if (!state->has_aliases)
 559     {
 560       g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
 561                    "<aliases> must contain at least one <alias>");
 562       return;
 563     }
 564 }
 565
 566 static gboolean
 567 key_state_check (KeyState  *state,
 568                  GError   **error)
 569 {
 570   if (state->checked)
 571     return TRUE;
 572
 573   return state->checked = TRUE;
 574 }
 575
 576 static GVariant *
 577 key_state_serialise (KeyState *state)
 578 {
 579   if (state->serialised == NULL)
 580     {
 581       if (state->child_schema)
 582         {
 583           state->serialised = g_variant_new_string (state->child_schema);
 584         }
 585
 586       else
 587         {
 588           GVariantBuilder builder;
 589
 590           g_assert (key_state_check (state, NULL));
 591
 592           g_variant_builder_init (&builder, G_VARIANT_TYPE_TUPLE);
 593
 594           /* default value */
 595           g_variant_builder_add_value (&builder, state->default_value);
 596
 597           /* translation */
 598           if (state->l10n)
 599             {
 600               if (state->l10n_context)
 601                 {
 602                   gint len;
 603
 604                   /* Contextified messages are supported by prepending
 605                    * the context, followed by '\004' to the start of the
 606                    * message string.  We do that here to save GSettings
 607                    * the work later on.
 608                    */
 609                   len = strlen (state->l10n_context);
 610                   state->l10n_context[len] = '\004';
 611                   g_string_prepend_len (state->unparsed_default_value,
 612                                         state->l10n_context, len + 1);
 613                   g_free (state->l10n_context);
 614                   state->l10n_context = NULL;
 615                 }
 616
 617               g_variant_builder_add (&builder, "(y(y&s))", 'l', state->l10n,
 618                                      state->unparsed_default_value->str);
 619               g_string_free (state->unparsed_default_value, TRUE);
 620               state->unparsed_default_value = NULL;
 621             }
 622
 623           /* choice, aliases, enums */
 624           if (state->strinfo->len)
 625             {
 626               GVariant *array;
 627               gpointer data;
 628               gsize size;
 629
 630               data = state->strinfo->str;
 631               size = state->strinfo->len;
 632
 633               array = g_variant_new_from_data (G_VARIANT_TYPE ("au"),
 634                                                data, size, TRUE,
 635                                                g_free, data);
 636
 637               g_string_free (state->strinfo, FALSE);
 638               state->strinfo = NULL;
 639
 640               g_variant_builder_add (&builder, "(y@au)",
 641                                      state->is_flags ? 'f' :
 642                                      state->is_enum ? 'e' : 'c',
 643                                      array);
 644             }
 645
 646           /* range */
 647           if (state->minimum || state->maximum)
 648             g_variant_builder_add (&builder, "(y(**))", 'r',
 649                                    state->minimum, state->maximum);
 650
 651           state->serialised = g_variant_builder_end (&builder);
 652         }
 653
 654       g_variant_ref_sink (state->serialised);
 655     }
 656
 657   return g_variant_ref (state->serialised);
 658 }
 659
 660 static void
 661 key_state_free (gpointer data)
 662 {
 663   KeyState *state = data;
 664
 665   if (state->type)
 666     g_variant_type_free (state->type);
 667
 668   g_free (state->l10n_context);
 669
 670   if (state->unparsed_default_value)
 671     g_string_free (state->unparsed_default_value, TRUE);
 672
 673   if (state->default_value)
 674     g_variant_unref (state->default_value);
 675
 676   if (state->strinfo)
 677     g_string_free (state->strinfo, TRUE);
 678
 679   if (state->minimum)
 680     g_variant_unref (state->minimum);
 681
 682   if (state->maximum)
 683     g_variant_unref (state->maximum);
 684
 685   if (state->serialised)
 686     g_variant_unref (state->serialised);
 687
 688   g_slice_free (KeyState, state);
 689 }
 690
 691 /* Key name validity {{{1 */
 692 static gboolean allow_any_name = FALSE;
 693
 694 static gboolean
 695 is_valid_keyname (const gchar  *key,
 696                   GError      **error)
 697 {
 698   gint i;
 699
 700   if (key[0] == '\0')
 701     {
 702       g_set_error_literal (error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
 703                            _("empty names are not permitted"));
 704       return FALSE;
 705     }
 706
 707   if (allow_any_name)
 708     return TRUE;
 709
 710   if (!g_ascii_islower (key[0]))
 711     {
 712       g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
 713                    _("invalid name '%s': names must begin "
 714                      "with a lowercase letter"), key);
 715       return FALSE;
 716     }
 717
 718   for (i = 1; key[i]; i++)
 719     {
 720       if (key[i] != '-' &&
 721           !g_ascii_islower (key[i]) &&
 722           !g_ascii_isdigit (key[i]))
 723         {
 724           g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
 725                        _("invalid name '%s': invalid character '%c'; "
 726                          "only lowercase letters, numbers and dash ('-') "
 727                          "are permitted."), key, key[i]);
 728           return FALSE;
 729         }
 730
 731       if (key[i] == '-' && key[i + 1] == '-')
 732         {
 733           g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
 734                        _("invalid name '%s': two successive dashes ('--') "
 735                          "are not permitted."), key);
 736           return FALSE;
 737         }
 738     }
 739
 740   if (key[i - 1] == '-')
 741     {
 742       g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
 743                    _("invalid name '%s': the last character may not be a "
 744                      "dash ('-')."), key);
 745       return FALSE;
 746     }
 747
 748   if (i > 32)
 749     {
 750       g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
 751                    _("invalid name '%s': maximum length is 32"), key);
 752       return FALSE;
 753     }
 754
 755   return TRUE;
 756 }
 757
 758 /* Handling of <schema> {{{1 */
 759 typedef struct _SchemaState SchemaState;
 760 struct _SchemaState
 761 {
 762   SchemaState *extends;
 763
 764   gchar       *path;
 765   gchar       *gettext_domain;
 766   gchar       *extends_name;
 767   gchar       *list_of;
 768
 769   GHashTable  *keys;
 770 };
 771
 772 static SchemaState *
 773 schema_state_new (const gchar  *path,
 774                   const gchar  *gettext_domain,
 775                   SchemaState  *extends,
 776                   const gchar  *extends_name,
 777                   const gchar  *list_of)
 778 {
 779   SchemaState *state;
 780
 781   state = g_slice_new (SchemaState);
 782   state->path = g_strdup (path);
 783   state->gettext_domain = g_strdup (gettext_domain);
 784   state->extends = extends;
 785   state->extends_name = g_strdup (extends_name);
 786   state->list_of = g_strdup (list_of);
 787   state->keys = g_hash_table_new_full (g_str_hash, g_str_equal,
 788                                        g_free, key_state_free);
 789
 790   return state;
 791 }
 792
 793 static void
 794 schema_state_free (gpointer data)
 795 {
 796   SchemaState *state = data;
 797
 798   g_free (state->path);
 799   g_free (state->gettext_domain);
 800   g_hash_table_unref (state->keys);
 801 }
 802
 803 static void
 804 schema_state_add_child (SchemaState  *state,
 805                         const gchar  *name,
 806                         const gchar  *schema,
 807                         GError      **error)
 808 {
 809   gchar *childname;
 810
 811   if (!is_valid_keyname (name, error))
 812     return;
 813
 814   childname = g_strconcat (name, "/", NULL);
 815
 816   if (g_hash_table_lookup (state->keys, childname))
 817     {
 818       g_set_error (error, G_MARKUP_ERROR,
 819                    G_MARKUP_ERROR_INVALID_CONTENT,
 820                    _("<child name='%s'> already specified"), name);
 821       return;
 822     }
 823
 824   g_hash_table_insert (state->keys, childname,
 825                        key_state_new_child (schema));
 826 }
 827
 828 static KeyState *
 829 schema_state_add_key (SchemaState  *state,
 830                       GHashTable   *enum_table,
 831                       GHashTable   *flags_table,
 832                       const gchar  *name,
 833                       const gchar  *type_string,
 834                       const gchar  *enum_type,
 835                       const gchar  *flags_type,
 836                       GError      **error)
 837 {
 838   SchemaState *node;
 839   GString *strinfo;
 840   KeyState *key;
 841
 842   if (state->list_of)
 843     {
 844       g_set_error_literal (error, G_MARKUP_ERROR,
 845                            G_MARKUP_ERROR_INVALID_CONTENT,
 846                            _("can not add keys to a 'list-of' schema"));
 847       return NULL;
 848     }
 849
 850   if (!is_valid_keyname (name, error))
 851     return NULL;
 852
 853   if (g_hash_table_lookup (state->keys, name))
 854     {
 855       g_set_error (error, G_MARKUP_ERROR,
 856                    G_MARKUP_ERROR_INVALID_CONTENT,
 857                    _("<key name='%s'> already specified"), name);
 858       return NULL;
 859     }
 860
 861   for (node = state; node; node = node->extends)
 862     if (node->extends)
 863       {
 864         KeyState *shadow;
 865
 866         shadow = g_hash_table_lookup (node->extends->keys, name);
 867
 868         /* in case of <key> <override> <key> make sure we report the
 869          * location of the original <key>, not the <override>.
 870          */
 871         if (shadow && !shadow->is_override)
 872           {
 873             g_set_error (error, G_MARKUP_ERROR,
 874                          G_MARKUP_ERROR_INVALID_CONTENT,
 875                          _("<key name='%s'> shadows <key name='%s'> in "
 876                            "<schema id='%s'>; use <override> to modify value"),
 877                          name, name, node->extends_name);
 878             return NULL;
 879           }
 880       }
 881
 882   if ((type_string != NULL) + (enum_type != NULL) + (flags_type != NULL) != 1)
 883     {
 884       g_set_error (error, G_MARKUP_ERROR,
 885                    G_MARKUP_ERROR_MISSING_ATTRIBUTE,
 886                    _("exactly one of 'type', 'enum' or 'flags' must "
 887                      "be specified as an attribute to <key>"));
 888       return NULL;
 889     }
 890
 891   if (type_string == NULL) /* flags or enums was specified */
 892     {
 893       EnumState *enum_state;
 894
 895       if (enum_type)
 896         enum_state = g_hash_table_lookup (enum_table, enum_type);
 897       else
 898         enum_state = g_hash_table_lookup (flags_table, flags_type);
 899
 900
 901       if (enum_state == NULL)
 902         {
 903           g_set_error (error, G_MARKUP_ERROR,
 904                        G_MARKUP_ERROR_INVALID_CONTENT,
 905                        _("<%s id='%s'> not (yet) defined."),
 906                        flags_type ? "flags"    : "enum",
 907                        flags_type ? flags_type : enum_type);
 908           return NULL;
 909         }
 910
 911       type_string = flags_type ? "as" : "s";
 912       strinfo = enum_state->strinfo;
 913     }
 914   else
 915     {
 916       if (!g_variant_type_string_is_valid (type_string))
 917         {
 918           g_set_error (error, G_MARKUP_ERROR,
 919                        G_MARKUP_ERROR_INVALID_CONTENT,
 920                        _("invalid GVariant type string '%s'"), type_string);
 921           return NULL;
 922         }
 923
 924       strinfo = NULL;
 925     }
 926
 927   key = key_state_new (type_string, state->gettext_domain,
 928                        enum_type != NULL, flags_type != NULL, strinfo);
 929   g_hash_table_insert (state->keys, g_strdup (name), key);
 930
 931   return key;
 932 }
 933
 934 static void
 935 schema_state_add_override (SchemaState  *state,
 936                            KeyState    **key_state,
 937                            GString     **string,
 938                            const gchar  *key,
 939                            const gchar  *l10n,
 940                            const gchar  *context,
 941                            GError      **error)
 942 {
 943   SchemaState *parent;
 944   KeyState *original;
 945
 946   if (state->extends == NULL)
 947     {
 948       g_set_error_literal (error, G_MARKUP_ERROR,
 949                            G_MARKUP_ERROR_INVALID_CONTENT,
 950                            _("<override> given but schema isn't "
 951                              "extending anything"));
 952       return;
 953     }
 954
 955   for (parent = state->extends; parent; parent = parent->extends)
 956     if ((original = g_hash_table_lookup (parent->keys, key)))
 957       break;
 958
 959   if (original == NULL)
 960     {
 961       g_set_error (error, G_MARKUP_ERROR,
 962                    G_MARKUP_ERROR_INVALID_CONTENT,
 963                    _("no <key name='%s'> to override"), key);
 964       return;
 965     }
 966
 967   if (g_hash_table_lookup (state->keys, key))
 968     {
 969       g_set_error (error, G_MARKUP_ERROR,
 970                    G_MARKUP_ERROR_INVALID_CONTENT,
 971                    _("<override name='%s'> already specified"), key);
 972       return;
 973     }
 974
 975   *key_state = key_state_override (original, state->gettext_domain);
 976   *string = key_state_start_default (*key_state, l10n, context, error);
 977   g_hash_table_insert (state->keys, g_strdup (key), *key_state);
 978 }
 979
 980 static void
 981 override_state_end (KeyState **key_state,
 982                     GString  **string,
 983                     GError   **error)
 984 {
 985   key_state_end_default (*key_state, string, error);
 986   *key_state = NULL;
 987 }
 988
 989 /* Handling of toplevel state {{{1 */
 990 typedef struct
 991 {
 992   GHashTable  *schema_table;            /* string -> SchemaState */
 993   GHashTable  *flags_table;             /* string -> EnumState */
 994   GHashTable  *enum_table;              /* string -> EnumState */
 995
 996   GSList      *this_file_schemas;       /* strings: <schema>s in this file */
 997   GSList      *this_file_flagss;        /* strings: <flags>s in this file */
 998   GSList      *this_file_enums;         /* strings: <enum>s in this file */
 999
1000   gchar       *schemalist_domain;       /* the <schemalist> gettext domain */
1001
1002   SchemaState *schema_state;            /* non-NULL when inside <schema> */
1003   KeyState    *key_state;               /* non-NULL when inside <key> */
1004   EnumState   *enum_state;              /* non-NULL when inside <enum> */
1005
1006   GString     *string;                  /* non-NULL when accepting text */
1007 } ParseState;
1008
1009 static gboolean
1010 is_subclass (const gchar *class_name,
1011              const gchar *possible_parent,
1012              GHashTable  *schema_table)
1013 {
1014   SchemaState *class;
1015
1016   if (strcmp (class_name, possible_parent) == 0)
1017     return TRUE;
1018
1019   class = g_hash_table_lookup (schema_table, class_name);
1020   g_assert (class != NULL);
1021
1022   return class->extends_name &&
1023          is_subclass (class->extends_name, possible_parent, schema_table);
1024 }
1025
1026 static void
1027 parse_state_start_schema (ParseState  *state,
1028                           const gchar  *id,
1029                           const gchar  *path,
1030                           const gchar  *gettext_domain,
1031                           const gchar  *extends_name,
1032                           const gchar  *list_of,
1033                           GError      **error)
1034 {
1035   SchemaState *extends;
1036   gchar *my_id;
1037
1038   if (g_hash_table_lookup (state->schema_table, id))
1039     {
1040       g_set_error (error, G_MARKUP_ERROR,
1041                    G_MARKUP_ERROR_INVALID_CONTENT,
1042                    _("<schema id='%s'> already specified"), id);
1043       return;
1044     }
1045
1046   if (extends_name)
1047     {
1048       extends = g_hash_table_lookup (state->schema_table, extends_name);
1049
1050       if (extends == NULL)
1051         {
1052           g_set_error (error, G_MARKUP_ERROR,
1053                        G_MARKUP_ERROR_INVALID_CONTENT,
1054                        _("<schema id='%s'> extends not yet "
1055                          "existing schema '%s'"), id, extends_name);
1056           return;
1057         }
1058     }
1059   else
1060     extends = NULL;
1061
1062   if (list_of)
1063     {
1064       SchemaState *tmp;
1065
1066       if (!(tmp = g_hash_table_lookup (state->schema_table, list_of)))
1067         {
1068           g_set_error (error, G_MARKUP_ERROR,
1069                        G_MARKUP_ERROR_INVALID_CONTENT,
1070                        _("<schema id='%s'> is list of not yet "
1071                          "existing schema '%s'"), id, list_of);
1072           return;
1073         }
1074
1075       if (tmp->path)
1076         {
1077           g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
1078                        _("Can not be a list of a schema with a path"));
1079           return;
1080         }
1081     }
1082
1083   if (extends)
1084     {
1085       if (extends->path)
1086         {
1087           g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
1088                        _("Can not extend a schema with a path"));
1089           return;
1090         }
1091
1092       if (list_of)
1093         {
1094           if (extends->list_of == NULL)
1095             {
1096               g_set_error (error, G_MARKUP_ERROR,
1097                            G_MARKUP_ERROR_INVALID_CONTENT,
1098                            _("<schema id='%s'> is a list, extending "
1099                              "<schema id='%s'> which is not a list"),
1100                            id, extends_name);
1101               return;
1102             }
1103
1104           if (!is_subclass (list_of, extends->list_of, state->schema_table))
1105             {
1106               g_set_error (error, G_MARKUP_ERROR,
1107                            G_MARKUP_ERROR_INVALID_CONTENT,
1108                            _("<schema id='%s' list-of='%s'> extends <schema "
1109                              "id='%s' list-of='%s'> but '%s' does not "
1110                              "extend '%s'"), id, list_of, extends_name,
1111                            extends->list_of, list_of, extends->list_of);
1112               return;
1113             }
1114         }
1115       else
1116         /* by default we are a list of the same thing that the schema
1117          * we are extending is a list of (which might be nothing)
1118          */
1119         list_of = extends->list_of;
1120     }
1121
1122   if (path && !(g_str_has_prefix (path, "/") && g_str_has_suffix (path, "/")))
1123     {
1124       g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
1125                    _("a path, if given, must begin and end with a slash"));
1126       return;
1127     }
1128
1129   if (path && list_of && !g_str_has_suffix (path, ":/"))
1130     {
1131       g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
1132                    _("the path of a list must end with ':/'"));
1133       return;
1134     }
1135
1136   state->schema_state = schema_state_new (path, gettext_domain,
1137                                           extends, extends_name, list_of);
1138
1139   my_id = g_strdup (id);
1140   state->this_file_schemas = g_slist_prepend (state->this_file_schemas, my_id);
1141   g_hash_table_insert (state->schema_table, my_id, state->schema_state);
1142 }
1143
1144 static void
1145 parse_state_start_enum (ParseState   *state,
1146                         const gchar  *id,
1147                         gboolean      is_flags,
1148                         GError      **error)
1149 {
1150   GSList **list = is_flags ? &state->this_file_flagss : &state->this_file_enums;
1151   GHashTable *table = is_flags ? state->flags_table : state->enum_table;
1152   gchar *my_id;
1153
1154   if (g_hash_table_lookup (table, id))
1155     {
1156       g_set_error (error, G_MARKUP_ERROR,
1157                    G_MARKUP_ERROR_INVALID_CONTENT,
1158                    _("<%s id='%s'> already specified"),
1159                    is_flags ? "flags" : "enum", id);
1160       return;
1161     }
1162
1163   state->enum_state = enum_state_new (is_flags);
1164
1165   my_id = g_strdup (id);
1166   *list = g_slist_prepend (*list, my_id);
1167   g_hash_table_insert (table, my_id, state->enum_state);
1168 }
1169
1170 /* GMarkup Parser Functions {{{1 */
1171
1172 /* Start element {{{2 */
1173 static void
1174 start_element (GMarkupParseContext  *context,
1175                const gchar          *element_name,
1176                const gchar         **attribute_names,
1177                const gchar         **attribute_values,
1178                gpointer              user_data,
1179                GError              **error)
1180 {
1181   ParseState *state = user_data;
1182   const GSList *element_stack;
1183   const gchar *container;
1184
1185   element_stack = g_markup_parse_context_get_element_stack (context);
1186   container = element_stack->next ? element_stack->next->data : NULL;
1187
1188 #define COLLECT(first, ...) \
1189   g_markup_collect_attributes (element_name,                                 \
1190                                attribute_names, attribute_values, error,     \
1191                                first, __VA_ARGS__, G_MARKUP_COLLECT_INVALID)
1192 #define OPTIONAL   G_MARKUP_COLLECT_OPTIONAL
1193 #define STRDUP     G_MARKUP_COLLECT_STRDUP
1194 #define STRING     G_MARKUP_COLLECT_STRING
1195 #define NO_ATTRS()  COLLECT (G_MARKUP_COLLECT_INVALID, NULL)
1196
1197   /* Toplevel items {{{3 */
1198   if (container == NULL)
1199     {
1200       if (strcmp (element_name, "schemalist") == 0)
1201         {
1202           COLLECT (OPTIONAL | STRDUP,
1203                    "gettext-domain",
1204                    &state->schemalist_domain);
1205           return;
1206         }
1207     }
1208
1209
1210   /* children of <schemalist> {{{3 */
1211   else if (strcmp (container, "schemalist") == 0)
1212     {
1213       if (strcmp (element_name, "schema") == 0)
1214         {
1215           const gchar *id, *path, *gettext_domain, *extends, *list_of;
1216           if (COLLECT (STRING, "id", &id,
1217                        OPTIONAL | STRING, "path", &path,
1218                        OPTIONAL | STRING, "gettext-domain", &gettext_domain,
1219                        OPTIONAL | STRING, "extends", &extends,
1220                        OPTIONAL | STRING, "list-of", &list_of))
1221             parse_state_start_schema (state, id, path, gettext_domain,
1222                                       extends, list_of, error);
1223           return;
1224         }
1225
1226       else if (strcmp (element_name, "enum") == 0)
1227         {
1228           const gchar *id;
1229           if (COLLECT (STRING, "id", &id))
1230             parse_state_start_enum (state, id, FALSE, error);
1231           return;
1232         }
1233
1234       else if (strcmp (element_name, "flags") == 0)
1235         {
1236           const gchar *id;
1237           if (COLLECT (STRING, "id", &id))
1238             parse_state_start_enum (state, id, TRUE, error);
1239           return;
1240         }
1241     }
1242
1243
1244   /* children of <schema> {{{3 */
1245   else if (strcmp (container, "schema") == 0)
1246     {
1247       if (strcmp (element_name, "key") == 0)
1248         {
1249           const gchar *name, *type_string, *enum_type, *flags_type;
1250
1251           if (COLLECT (STRING,            "name",  &name,
1252                        OPTIONAL | STRING, "type",  &type_string,
1253                        OPTIONAL | STRING, "enum",  &enum_type,
1254                        OPTIONAL | STRING, "flags", &flags_type))
1255
1256             state->key_state = schema_state_add_key (state->schema_state,
1257                                                      state->enum_table,
1258                                                      state->flags_table,
1259                                                      name, type_string,
1260                                                      enum_type, flags_type,
1261                                                      error);
1262           return;
1263         }
1264       else if (strcmp (element_name, "child") == 0)
1265         {
1266           const gchar *name, *schema;
1267
1268           if (COLLECT (STRING, "name", &name, STRING, "schema", &schema))
1269             schema_state_add_child (state->schema_state,
1270                                     name, schema, error);
1271           return;
1272         }
1273       else if (strcmp (element_name, "override") == 0)
1274         {
1275           const gchar *name, *l10n, *context;
1276
1277           if (COLLECT (STRING,            "name",    &name,
1278                        OPTIONAL | STRING, "l10n",    &l10n,
1279                        OPTIONAL | STRING, "context", &context))
1280             schema_state_add_override (state->schema_state,
1281                                        &state->key_state, &state->string,
1282                                        name, l10n, context, error);
1283           return;
1284         }
1285     }
1286
1287   /* children of <key> {{{3 */
1288   else if (strcmp (container, "key") == 0)
1289     {
1290       if (strcmp (element_name, "default") == 0)
1291         {
1292           const gchar *l10n, *context;
1293           if (COLLECT (STRING | OPTIONAL, "l10n",    &l10n,
1294                        STRING | OPTIONAL, "context", &context))
1295             state->string = key_state_start_default (state->key_state,
1296                                                      l10n, context, error);
1297           return;
1298         }
1299
1300       else if (strcmp (element_name, "summary") == 0 ||
1301                strcmp (element_name, "description") == 0)
1302         {
1303           if (NO_ATTRS ())
1304             state->string = g_string_new (NULL);
1305           return;
1306         }
1307
1308       else if (strcmp (element_name, "range") == 0)
1309         {
1310           const gchar *min, *max;
1311           if (COLLECT (STRING, "min", &min, STRING, "max", &max))
1312             key_state_set_range (state->key_state, min, max, error);
1313           return;
1314         }
1315
1316       else if (strcmp (element_name, "choices") == 0)
1317         {
1318           if (NO_ATTRS ())
1319             key_state_start_choices (state->key_state, error);
1320           return;
1321         }
1322
1323       else if (strcmp (element_name, "aliases") == 0)
1324         {
1325           if (NO_ATTRS ())
1326             key_state_start_aliases (state->key_state, error);
1327           return;
1328         }
1329     }
1330
1331
1332   /* children of <choices> {{{3 */
1333   else if (strcmp (container, "choices") == 0)
1334     {
1335       if (strcmp (element_name, "choice") == 0)
1336         {
1337           const gchar *value;
1338           if (COLLECT (STRING, "value", &value))
1339             key_state_add_choice (state->key_state, value, error);
1340           return;
1341         }
1342     }
1343
1344
1345   /* children of <aliases> {{{3 */
1346   else if (strcmp (container, "aliases") == 0)
1347     {
1348       if (strcmp (element_name, "alias") == 0)
1349         {
1350           const gchar *value, *target;
1351           if (COLLECT (STRING, "value", &value, STRING, "target", &target))
1352             key_state_add_alias (state->key_state, value, target, error);
1353           return;
1354         }
1355     }
1356
1357
1358   /* children of <enum> {{{3 */
1359   else if (strcmp (container, "enum") == 0 ||
1360            strcmp (container, "flags") == 0)
1361     {
1362       if (strcmp (element_name, "value") == 0)
1363         {
1364           const gchar *nick, *valuestr;
1365           if (COLLECT (STRING, "nick", &nick,
1366                        STRING, "value", &valuestr))
1367             enum_state_add_value (state->enum_state, nick, valuestr, error);
1368           return;
1369         }
1370     }
1371   /* 3}}} */
1372
1373   if (container)
1374     g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_UNKNOWN_ELEMENT,
1375                  _("Element <%s> not allowed inside <%s>"),
1376                  element_name, container);
1377   else
1378     g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_UNKNOWN_ELEMENT,
1379                  _("Element <%s> not allowed at toplevel"), element_name);
1380 }
1381 /* 2}}} */
1382 /* End element {{{2 */
1383
1384 static void
1385 key_state_end (KeyState **state_ptr,
1386                GError   **error)
1387 {
1388   KeyState *state;
1389
1390   state = *state_ptr;
1391   *state_ptr = NULL;
1392
1393   if (state->default_value == NULL)
1394     {
1395       g_set_error_literal (error,
1396                            G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
1397                            "element <default> is required in <key>");
1398       return;
1399     }
1400 }
1401
1402 static void
1403 schema_state_end (SchemaState **state_ptr,
1404                   GError      **error)
1405 {
1406   SchemaState *state;
1407
1408   state = *state_ptr;
1409   *state_ptr = NULL;
1410 }
1411
1412 static void
1413 end_element (GMarkupParseContext  *context,
1414              const gchar          *element_name,
1415              gpointer              user_data,
1416              GError              **error)
1417 {
1418   ParseState *state = user_data;
1419
1420   if (strcmp (element_name, "schemalist") == 0)
1421     {
1422       g_free (state->schemalist_domain);
1423       state->schemalist_domain = NULL;
1424     }
1425
1426   else if (strcmp (element_name, "enum") == 0 ||
1427            strcmp (element_name, "flags") == 0)
1428     enum_state_end (&state->enum_state, error);
1429
1430   else if (strcmp (element_name, "schema") == 0)
1431     schema_state_end (&state->schema_state, error);
1432
1433   else if (strcmp (element_name, "override") == 0)
1434     override_state_end (&state->key_state, &state->string, error);
1435
1436   else if (strcmp (element_name, "key") == 0)
1437     key_state_end (&state->key_state, error);
1438
1439   else if (strcmp (element_name, "default") == 0)
1440     key_state_end_default (state->key_state, &state->string, error);
1441
1442   else if (strcmp (element_name, "choices") == 0)
1443     key_state_end_choices (state->key_state, error);
1444
1445   else if (strcmp (element_name, "aliases") == 0)
1446     key_state_end_aliases (state->key_state, error);
1447
1448   if (state->string)
1449     {
1450       g_string_free (state->string, TRUE);
1451       state->string = NULL;
1452     }
1453 }
1454 /* Text {{{2 */
1455 static void
1456 text (GMarkupParseContext  *context,
1457       const gchar          *text,
1458       gsize                 text_len,
1459       gpointer              user_data,
1460       GError              **error)
1461 {
1462   ParseState *state = user_data;
1463   gsize i;
1464
1465   for (i = 0; i < text_len; i++)
1466     if (!g_ascii_isspace (text[i]))
1467       {
1468         if (state->string)
1469           g_string_append_len (state->string, text, text_len);
1470
1471         else
1472           g_set_error (error, G_MARKUP_ERROR, G_MARKUP_ERROR_INVALID_CONTENT,
1473                        _("text may not appear inside <%s>"),
1474                        g_markup_parse_context_get_element (context));
1475
1476         break;
1477       }
1478 }
1479
1480 /* Write to GVDB {{{1 */
1481 typedef struct
1482 {
1483   GHashTable *table;
1484   GvdbItem *root;
1485 } GvdbPair;
1486
1487 static void
1488 gvdb_pair_init (GvdbPair *pair)
1489 {
1490   pair->table = gvdb_hash_table_new (NULL, NULL);
1491   pair->root = gvdb_hash_table_insert (pair->table, "");
1492 }
1493
1494 typedef struct
1495 {
1496   GvdbPair pair;
1497   gboolean l10n;
1498 } OutputSchemaData;
1499
1500 static void
1501 output_key (gpointer key,
1502             gpointer value,
1503             gpointer user_data)
1504 {
1505   OutputSchemaData *data;
1506   const gchar *name;
1507   KeyState *state;
1508   GvdbItem *item;
1509
1510   name = key;
1511   state = value;
1512   data = user_data;
1513
1514   item = gvdb_hash_table_insert (data->pair.table, name);
1515   gvdb_item_set_parent (item, data->pair.root);
1516   gvdb_item_set_value (item, key_state_serialise (state));
1517
1518   if (state->l10n)
1519     data->l10n = TRUE;
1520 }
1521
1522 static void
1523 output_schema (gpointer key,
1524                gpointer value,
1525                gpointer user_data)
1526 {
1527   OutputSchemaData data;
1528   GvdbPair *root_pair;
1529   SchemaState *state;
1530   const gchar *id;
1531   GvdbItem *item;
1532
1533   id = key;
1534   state = value;
1535   root_pair = user_data;
1536
1537   gvdb_pair_init (&data.pair);
1538   data.l10n = FALSE;
1539
1540   item = gvdb_hash_table_insert (root_pair->table, id);
1541   gvdb_item_set_parent (item, root_pair->root);
1542   gvdb_item_set_hash_table (item, data.pair.table);
1543
1544   g_hash_table_foreach (state->keys, output_key, &data);
1545
1546   if (state->path)
1547     gvdb_hash_table_insert_string (data.pair.table, ".path", state->path);
1548
1549   if (state->extends_name)
1550     gvdb_hash_table_insert_string (data.pair.table, ".extends",
1551                                    state->extends_name);
1552
1553   if (state->list_of)
1554     gvdb_hash_table_insert_string (data.pair.table, ".list-of",
1555                                    state->extends_name);
1556
1557   if (data.l10n)
1558     gvdb_hash_table_insert_string (data.pair.table,
1559                                    ".gettext-domain",
1560                                    state->gettext_domain);
1561 }
1562
1563 static gboolean
1564 write_to_file (GHashTable   *schema_table,
1565                const gchar  *filename,
1566                GError      **error)
1567 {
1568   gboolean success;
1569   GvdbPair pair;
1570
1571   gvdb_pair_init (&pair);
1572
1573   g_hash_table_foreach (schema_table, output_schema, &pair);
1574
1575   success = gvdb_table_write_contents (pair.table, filename,
1576                                        G_BYTE_ORDER != G_LITTLE_ENDIAN,
1577                                        error);
1578   g_hash_table_unref (pair.table);
1579
1580   return success;
1581 }
1582
1583 /* Parser driver {{{1 */
1584 static GHashTable *
1585 parse_gschema_files (gchar    **files,
1586                      gboolean   strict)
1587 {
1588   GMarkupParser parser = { start_element, end_element, text };
1589   ParseState state = { 0, };
1590   const gchar *filename;
1591   GError *error = NULL;
1592
1593   state.enum_table = g_hash_table_new_full (g_str_hash, g_str_equal,
1594                                             g_free, enum_state_free);
1595
1596   state.flags_table = g_hash_table_new_full (g_str_hash, g_str_equal,
1597                                              g_free, enum_state_free);
1598
1599   state.schema_table = g_hash_table_new_full (g_str_hash, g_str_equal,
1600                                               g_free, schema_state_free);
1601
1602   while ((filename = *files++) != NULL)
1603     {
1604       GMarkupParseContext *context;
1605       gchar *contents;
1606       gsize size;
1607
1608       if (!g_file_get_contents (filename, &contents, &size, &error))
1609         {
1610           fprintf (stderr, "%s\n", error->message);
1611           g_clear_error (&error);
1612           continue;
1613         }
1614
1615       context = g_markup_parse_context_new (&parser,
1616                                             G_MARKUP_PREFIX_ERROR_POSITION,
1617                                             &state, NULL);
1618
1619
1620       if (!g_markup_parse_context_parse (context, contents, size, &error) ||
1621           !g_markup_parse_context_end_parse (context, &error))
1622         {
1623           GSList *item;
1624
1625           /* back out any changes from this file */
1626           for (item = state.this_file_schemas; item; item = item->next)
1627             g_hash_table_remove (state.schema_table, item->data);
1628
1629           for (item = state.this_file_flagss; item; item = item->next)
1630             g_hash_table_remove (state.flags_table, item->data);
1631
1632           for (item = state.this_file_enums; item; item = item->next)
1633             g_hash_table_remove (state.enum_table, item->data);
1634
1635           /* let them know */
1636           fprintf (stderr, "%s: %s.  ", filename, error->message);
1637
1638           if (strict)
1639             {
1640               /* Translators: Do not translate "--strict". */
1641               fprintf (stderr, _("--strict was specified; exiting.\n"));
1642               g_hash_table_unref (state.schema_table);
1643               g_hash_table_unref (state.flags_table);
1644               g_hash_table_unref (state.enum_table);
1645
1646               return NULL;
1647             }
1648           else
1649             fprintf (stderr, _("This entire file has been ignored.\n"));
1650         }
1651
1652       /* cleanup */
1653       g_markup_parse_context_free (context);
1654       g_slist_free (state.this_file_schemas);
1655       g_slist_free (state.this_file_flagss);
1656       g_slist_free (state.this_file_enums);
1657       state.this_file_schemas = NULL;
1658       state.this_file_flagss = NULL;
1659       state.this_file_enums = NULL;
1660     }
1661
1662   g_hash_table_unref (state.flags_table);
1663   g_hash_table_unref (state.enum_table);
1664
1665   return state.schema_table;
1666 }
1667
1668 static gint
1669 compare_strings (gconstpointer a,
1670                  gconstpointer b)
1671 {
1672   gchar *one = *(gchar **) a;
1673   gchar *two = *(gchar **) b;
1674   gint cmp;
1675
1676   cmp = g_str_has_suffix (two, ".enums.xml") -
1677         g_str_has_suffix (one, ".enums.xml");
1678
1679   if (!cmp)
1680     cmp = strcmp (one, two);
1681
1682   return cmp;
1683 }
1684
1685 static gboolean
1686 set_overrides (GHashTable  *schema_table,
1687                gchar      **files,
1688                gboolean     strict)
1689 {
1690   const gchar *filename;
1691   GError *error = NULL;
1692
1693   while ((filename = *files++))
1694     {
1695       GKeyFile *key_file;
1696       gchar **groups;
1697       gint i;
1698
1699       key_file = g_key_file_new ();
1700       if (!g_key_file_load_from_file (key_file, filename, 0, &error))
1701         {
1702           fprintf (stderr, "%s: %s.  ", filename, error->message);
1703           g_key_file_free (key_file);
1704           g_clear_error (&error);
1705
1706           if (!strict)
1707             {
1708               fprintf (stderr, _("Ignoring this file.\n"));
1709               continue;
1710             }
1711
1712           fprintf (stderr, _("--strict was specified; exiting.\n"));
1713           return FALSE;
1714         }
1715
1716       groups = g_key_file_get_groups (key_file, NULL);
1717
1718       for (i = 0; groups[i]; i++)
1719         {
1720           const gchar *group = groups[i];
1721           SchemaState *schema;
1722           gchar **keys;
1723           gint j;
1724
1725           schema = g_hash_table_lookup (schema_table, group);
1726
1727           if (schema == NULL)
1728             /* Having the schema not be installed is expected to be a
1729              * common case.  Don't even emit an error message about
1730              * that.
1731              */
1732             continue;
1733
1734           keys = g_key_file_get_keys (key_file, group, NULL, NULL);
1735           g_assert (keys != NULL);
1736
1737           for (j = 0; keys[j]; j++)
1738             {
1739               const gchar *key = keys[j];
1740               KeyState *state;
1741               GVariant *value;
1742               gchar *string;
1743
1744               state = g_hash_table_lookup (schema->keys, key);
1745
1746               if (state == NULL)
1747                 {
1748                   fprintf (stderr, _("No such key `%s' in schema `%s' as "
1749                                      "specified in override file `%s'"),
1750                            key, group, filename);
1751
1752                   if (!strict)
1753                     {
1754                       fprintf (stderr, _("; ignoring override for this key.\n"));
1755                       continue;
1756                     }
1757
1758                   fprintf (stderr, _(" and --strict was specified; exiting.\n"));
1759                   g_key_file_free (key_file);
1760                   g_strfreev (groups);
1761                   g_strfreev (keys);
1762
1763                   return FALSE;
1764                 }
1765
1766               string = g_key_file_get_value (key_file, group, key, NULL);
1767               g_assert (string != NULL);
1768
1769               value = g_variant_parse (state->type, string,
1770                                        NULL, NULL, &error);
1771
1772               if (value == NULL)
1773                 {
1774                   fprintf (stderr, _("error parsing key `%s' in schema `%s' "
1775                                      "as specified in override file `%s': "
1776                                      "%s.  "),
1777                            key, group, filename, error->message);
1778
1779                   g_clear_error (&error);
1780                   g_free (string);
1781
1782                   if (!strict)
1783                     {
1784                       fprintf (stderr, _("Ignoring override for this key.\n"));
1785                       continue;
1786                     }
1787
1788                   fprintf (stderr, _("--strict was specified; exiting.\n"));
1789                   g_key_file_free (key_file);
1790                   g_strfreev (groups);
1791                   g_strfreev (keys);
1792
1793                   return FALSE;
1794                 }
1795
1796               if (state->minimum)
1797                 {
1798                   if (g_variant_compare (value, state->minimum) < 0 ||
1799                       g_variant_compare (value, state->maximum) > 0)
1800                     {
1801                       fprintf (stderr,
1802                                _("override for key `%s' in schema `%s' in "
1803                                  "override file `%s' is out of the range "
1804                                  "given in the schema"),
1805                                key, group, filename);
1806
1807                       g_variant_unref (value);
1808                       g_free (string);
1809
1810                       if (!strict)
1811                         {
1812                           fprintf (stderr, _("; ignoring override for this key.\n"));
1813                           continue;
1814                         }
1815
1816                       fprintf (stderr, _(" and --strict was specified; exiting.\n"));
1817                       g_key_file_free (key_file);
1818                       g_strfreev (groups);
1819                       g_strfreev (keys);
1820
1821                       return FALSE;
1822                     }
1823                 }
1824
1825               else if (state->strinfo->len)
1826                 {
1827                   if (!is_valid_choices (value, state->strinfo))
1828                     {
1829                       fprintf (stderr,
1830                                _("override for key `%s' in schema `%s' in "
1831                                  "override file `%s' is not in the list "
1832                                  "of valid choices"),
1833                                key, group, filename);
1834
1835                       g_variant_unref (value);
1836                       g_free (string);
1837
1838                       if (!strict)
1839                         {
1840                           fprintf (stderr, _("; ignoring override for this key.\n"));
1841                           continue;
1842                         }
1843
1844                       fprintf (stderr, _(" and --strict was specified; exiting.\n"));
1845                       g_key_file_free (key_file);
1846                       g_strfreev (groups);
1847                       g_strfreev (keys);
1848
1849                       return FALSE;
1850                     }
1851                 }
1852
1853               g_variant_unref (state->default_value);
1854               state->default_value = value;
1855               g_free (string);
1856             }
1857
1858           g_strfreev (keys);
1859         }
1860
1861       g_strfreev (groups);
1862     }
1863
1864   return TRUE;
1865 }
1866
1867 int
1868 main (int argc, char **argv)
1869 {
1870   GError *error;
1871   GHashTable *table;
1872   GDir *dir;
1873   const gchar *file;
1874   gchar *srcdir;
1875   gchar *targetdir = NULL;
1876   gchar *target;
1877   gboolean uninstall = FALSE;
1878   gboolean dry_run = FALSE;
1879   gboolean strict = FALSE;
1880   gchar **schema_files = NULL;
1881   gchar **override_files = NULL;
1882   GOptionContext *context;
1883   GOptionEntry entries[] = {
1884     { "targetdir", 0, 0, G_OPTION_ARG_FILENAME, &targetdir, N_("where to store the gschemas.compiled file"), N_("DIRECTORY") },
1885     { "strict", 0, 0, G_OPTION_ARG_NONE, &strict, N_("Abort on any errors in schemas"), NULL },
1886     { "dry-run", 0, 0, G_OPTION_ARG_NONE, &dry_run, N_("Do not write the gschema.compiled file"), NULL },
1887     { "uninstall", 0, 0, G_OPTION_ARG_NONE, &uninstall, N_("This option will be removed soon.") },
1888     { "allow-any-name", 0, 0, G_OPTION_ARG_NONE, &allow_any_name, N_("Do not enforce key name restrictions") },
1889
1890     /* These options are only for use in the gschema-compile tests */
1891     { "schema-file", 0, G_OPTION_FLAG_HIDDEN, G_OPTION_ARG_FILENAME_ARRAY, &schema_files, NULL, NULL },
1892     { NULL }
1893   };
1894
1895   setlocale (LC_ALL, "");
1896
1897   context = g_option_context_new (N_("DIRECTORY"));
1898   g_option_context_set_translation_domain (context, GETTEXT_PACKAGE);
1899   g_option_context_set_summary (context,
1900     N_("Compile all GSettings schema files into a schema cache.\n"
1901        "Schema files are required to have the extension .gschema.xml,\n"
1902        "and the cache file is called gschemas.compiled."));
1903   g_option_context_add_main_entries (context, entries, GETTEXT_PACKAGE);
1904
1905   error = NULL;
1906   if (!g_option_context_parse (context, &argc, &argv, &error))
1907     {
1908       fprintf (stderr, "%s\n", error->message);
1909       return 1;
1910     }
1911
1912   g_option_context_free (context);
1913
1914   if (!schema_files && argc != 2)
1915     {
1916       fprintf (stderr, _("You should give exactly one directory name\n"));
1917       return 1;
1918     }
1919
1920   srcdir = argv[1];
1921
1922   if (targetdir == NULL)
1923     targetdir = srcdir;
1924
1925   target = g_build_filename (targetdir, "gschemas.compiled", NULL);
1926
1927   if (!schema_files)
1928     {
1929       GPtrArray *overrides;
1930       GPtrArray *files;
1931
1932       files = g_ptr_array_new ();
1933       overrides = g_ptr_array_new ();
1934
1935       dir = g_dir_open (srcdir, 0, &error);
1936       if (dir == NULL)
1937         {
1938           fprintf (stderr, "%s\n", error->message);
1939           return 1;
1940         }
1941
1942       while ((file = g_dir_read_name (dir)) != NULL)
1943         {
1944           if (g_str_has_suffix (file, ".gschema.xml") ||
1945               g_str_has_suffix (file, ".enums.xml"))
1946             g_ptr_array_add (files, g_build_filename (srcdir, file, NULL));
1947
1948           else if (g_str_has_suffix (file, ".gschema.override"))
1949             g_ptr_array_add (overrides,
1950                              g_build_filename (srcdir, file, NULL));
1951         }
1952
1953       if (files->len == 0)
1954         {
1955           fprintf (stderr, _("No schema files found: "));
1956
1957           if (g_unlink (target))
1958             fprintf (stderr, _("doing nothing.\n"));
1959
1960           else
1961             fprintf (stderr, _("removed existing output file.\n"));
1962
1963           return 0;
1964         }
1965       g_ptr_array_sort (files, compare_strings);
1966       g_ptr_array_add (files, NULL);
1967
1968       g_ptr_array_sort (overrides, compare_strings);
1969       g_ptr_array_add (overrides, NULL);
1970
1971       schema_files = (char **) g_ptr_array_free (files, FALSE);
1972       override_files = (gchar **) g_ptr_array_free (overrides, FALSE);
1973     }
1974
1975   if ((table = parse_gschema_files (schema_files, strict)) == NULL)
1976     {
1977       g_free (target);
1978       return 1;
1979     }
1980
1981   if (override_files != NULL &&
1982       !set_overrides (table, override_files, strict))
1983     {
1984       g_free (target);
1985       return 1;
1986     }
1987
1988   if (!dry_run && !write_to_file (table, target, &error))
1989     {
1990       fprintf (stderr, "%s\n", error->message);
1991       g_free (target);
1992       return 1;
1993     }
1994
1995   g_free (target);
1996
1997   return 0;
1998 }
1999
2000 /* Epilogue {{{1 */
2001
2002 /* vim:set foldmethod=marker: */