gimpconfig-deserialize.c 29.9 KB
Newer Older
1 2
/* LIBGIMP - The GIMP Library
 * Copyright (C) 1995-1997 Spencer Kimball and Peter Mattis
3 4
 *
 * Object properties deserialization routines
5
 * Copyright (C) 2001-2002  Sven Neumann <sven@gimp.org>
6
 *
7
 * This library is free software: you can redistribute it and/or
8 9
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
10
 * version 3 of the License, or (at your option) any later version.
11
 *
12
 * This library is distributed in the hope that it will be useful,
13
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 15
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
16
 *
17
 * You should have received a copy of the GNU Lesser General Public
18
 * License along with this library.  If not, see
19
 * <https://www.gnu.org/licenses/>.
20 21 22 23
 */

#include "config.h"

24
#include <cairo.h>
25 26
#include <gegl.h>
#include <gdk-pixbuf/gdk-pixbuf.h>
27

28
#include "libgimpbase/gimpbase.h"
29
#include "libgimpcolor/gimpcolor.h"
30
#include "libgimpmath/gimpmath.h"
31

32 33
#include "gimpconfigtypes.h"

34 35
#include "gimpconfigwriter.h"
#include "gimpconfig-iface.h"
36
#include "gimpconfig-deserialize.h"
37
#include "gimpconfig-params.h"
38
#include "gimpconfig-path.h"
39
#include "gimpscanner.h"
40

41
#include "libgimp/libgimp-intl.h"
42

43

44 45 46 47 48 49 50 51 52
/**
 * SECTION: gimpconfig-deserialize
 * @title: GimpConfig-deserialize
 * @short_description: Deserializing code for libgimpconfig.
 *
 * Deserializing code for libgimpconfig.
 **/


53
/*
54 55 56 57 58
 *  All functions return G_TOKEN_RIGHT_PAREN on success,
 *  the GTokenType they would have expected but didn't get
 *  or G_TOKEN_NONE if they got the expected token but
 *  couldn't parse it.
 */
59

60
static GTokenType  gimp_config_deserialize_value       (GValue     *value,
Sven Neumann's avatar
Sven Neumann committed
61
                                                        GimpConfig *config,
62 63
                                                        GParamSpec *prop_spec,
                                                        GScanner   *scanner);
64 65 66 67 68 69 70 71 72 73 74 75
static GTokenType  gimp_config_deserialize_fundamental (GValue     *value,
                                                        GParamSpec *prop_spec,
                                                        GScanner   *scanner);
static GTokenType  gimp_config_deserialize_enum        (GValue     *value,
                                                        GParamSpec *prop_spec,
                                                        GScanner   *scanner);
static GTokenType  gimp_config_deserialize_memsize     (GValue     *value,
                                                        GParamSpec *prop_spec,
                                                        GScanner   *scanner);
static GTokenType  gimp_config_deserialize_path        (GValue     *value,
                                                        GParamSpec *prop_spec,
                                                        GScanner   *scanner);
76
static GTokenType  gimp_config_deserialize_rgb         (GValue     *value,
77 78
                                                        GParamSpec *prop_spec,
                                                        GScanner   *scanner);
79 80 81
static GTokenType  gimp_config_deserialize_matrix2     (GValue     *value,
                                                        GParamSpec *prop_spec,
                                                        GScanner   *scanner);
82
static GTokenType  gimp_config_deserialize_object      (GValue     *value,
Sven Neumann's avatar
Sven Neumann committed
83
                                                        GimpConfig *config,
84 85 86
                                                        GParamSpec *prop_spec,
                                                        GScanner   *scanner,
                                                        gint        nest_level);
87
static GTokenType  gimp_config_deserialize_value_array (GValue     *value,
Sven Neumann's avatar
Sven Neumann committed
88
                                                        GimpConfig *config,
89 90
                                                        GParamSpec *prop_spec,
                                                        GScanner   *scanner);
91 92 93
static GTokenType  gimp_config_deserialize_unit        (GValue     *value,
                                                        GParamSpec *prop_spec,
                                                        GScanner   *scanner);
94 95 96
static GTokenType  gimp_config_deserialize_file_value  (GValue     *value,
                                                        GParamSpec *prop_spec,
                                                        GScanner   *scanner);
97 98 99
static GTokenType  gimp_config_deserialize_any         (GValue     *value,
                                                        GParamSpec *prop_spec,
                                                        GScanner   *scanner);
100
static GTokenType  gimp_config_skip_unknown_property   (GScanner   *scanner);
101

102
static inline gboolean  scanner_string_utf8_valid (GScanner    *scanner,
103
                                                   const gchar *token_name);
104

105 106 107 108 109 110 111 112 113 114 115 116 117
static inline gboolean
scanner_string_utf8_valid (GScanner    *scanner,
                           const gchar *token_name)
{
  if (g_utf8_validate (scanner->value.v_string, -1, NULL))
    return TRUE;

  g_scanner_error (scanner,
                   _("value for token %s is not a valid UTF-8 string"),
                   token_name);

  return FALSE;
}
118

119 120
/**
 * gimp_config_deserialize_properties:
Sven Neumann's avatar
Sven Neumann committed
121
 * @config: a #GimpConfig.
122
 * @scanner: a #GScanner.
123
 * @nest_level: the nest level
124
 *
Sven Neumann's avatar
Sven Neumann committed
125
 * This function uses the @scanner to configure the properties of @config.
126
 *
127 128
 * Return value: %TRUE on success, %FALSE otherwise.
 *
129
 * Since: 2.4
130
 **/
131
gboolean
132 133
gimp_config_deserialize_properties (GimpConfig *config,
                                    GScanner   *scanner,
134
                                    gint        nest_level)
135
{
136 137 138 139 140 141
  GObjectClass  *klass;
  GParamSpec   **property_specs;
  guint          n_property_specs;
  guint          i;
  guint          scope_id;
  guint          old_scope_id;
142
  GTokenType     token;
143

144
  g_return_val_if_fail (GIMP_IS_CONFIG (config), FALSE);
145

146
  klass = G_OBJECT_GET_CLASS (config);
147
  property_specs = g_object_class_list_properties (klass, &n_property_specs);
148

149
  if (! property_specs)
150
    return TRUE;
151

152
  scope_id = g_type_qname (G_TYPE_FROM_INSTANCE (config));
153 154 155 156 157 158
  old_scope_id = g_scanner_set_scope (scanner, scope_id);

  for (i = 0; i < n_property_specs; i++)
    {
      GParamSpec *prop_spec = property_specs[i];

159
      if (prop_spec->flags & GIMP_CONFIG_PARAM_SERIALIZE)
160
        {
161
          g_scanner_scope_add_symbol (scanner, scope_id,
162 163 164 165
                                      prop_spec->name, prop_spec);
        }
    }

166 167
  g_free (property_specs);

168
  g_object_freeze_notify (G_OBJECT (config));
169

170
  token = G_TOKEN_LEFT_PAREN;
171 172

  while (TRUE)
173
    {
174 175 176 177
      GTokenType next = g_scanner_peek_next_token (scanner);

      if (next == G_TOKEN_EOF)
        break;
178

179 180 181 182 183 184
      if (G_UNLIKELY (next != token &&
                      ! (token == G_TOKEN_SYMBOL &&
                         next  == G_TOKEN_IDENTIFIER)))
        {
          break;
        }
185 186

      token = g_scanner_get_next_token (scanner);
187

188 189 190 191 192
      switch (token)
        {
        case G_TOKEN_LEFT_PAREN:
          token = G_TOKEN_SYMBOL;
          break;
193

194 195 196 197
        case G_TOKEN_IDENTIFIER:
          token = gimp_config_skip_unknown_property (scanner);
          break;

198
        case G_TOKEN_SYMBOL:
199
          token = gimp_config_deserialize_property (config,
200
                                                    scanner, nest_level);
201 202 203 204 205 206 207 208 209 210 211
          break;

        case G_TOKEN_RIGHT_PAREN:
          token = G_TOKEN_LEFT_PAREN;
          break;

        default: /* do nothing */
          break;
        }
    }

212 213
  g_scanner_set_scope (scanner, old_scope_id);

214
  g_object_thaw_notify (G_OBJECT (config));
215

216 217 218
  if (token == G_TOKEN_NONE)
    return FALSE;

219
  return gimp_config_deserialize_return (scanner, token, nest_level);
220 221
}

222 223 224 225
/**
 * gimp_config_deserialize_property:
 * @config: a #GimpConfig.
 * @scanner: a #GScanner.
226
 * @nest_level: the nest level
227 228 229 230 231 232 233 234 235
 *
 * This function deserializes a single property of @config. You
 * shouldn't need to call this function directly. If possible, use
 * gimp_config_deserialize_properties() instead.
 *
 * Return value: %G_TOKEN_RIGHT_PAREN on success, otherwise the
 * expected #GTokenType or %G_TOKEN_NONE if the expected token was
 * found but couldn't be parsed.
 *
236
 * Since: 2.4
237
 **/
238
GTokenType
239
gimp_config_deserialize_property (GimpConfig *config,
240 241
                                  GScanner   *scanner,
                                  gint        nest_level)
242
{
243
  GimpConfigInterface *config_iface = NULL;
244
  GimpConfigInterface *parent_iface = NULL;
245
  GParamSpec          *prop_spec;
246 247
  GTokenType           token        = G_TOKEN_RIGHT_PAREN;
  GValue               value        = G_VALUE_INIT;
248 249 250
  guint                old_scope_id;

  old_scope_id = g_scanner_set_scope (scanner, 0);
251

252
  prop_spec = G_PARAM_SPEC (scanner->value.v_symbol);
253

254 255
  g_value_init (&value, prop_spec->value_type);

256
  if (G_TYPE_IS_OBJECT (prop_spec->owner_type))
257
    {
258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275
      GTypeClass *owner_class = g_type_class_peek (prop_spec->owner_type);

      config_iface = g_type_interface_peek (owner_class, GIMP_TYPE_CONFIG);

      /*  We must call deserialize_property() *only* if the *exact* class
       *  which implements it is param_spec->owner_type's class.
       *
       *  Therefore, we ask param_spec->owner_type's immediate parent class
       *  for it's GimpConfigInterface and check if we get a different
       *  pointer.
       *
       *  (if the pointers are the same, param_spec->owner_type's
       *   GimpConfigInterface is inherited from one of it's parent classes
       *   and thus not able to handle param_spec->owner_type's properties).
       */
      if (config_iface)
        {
          GTypeClass *owner_parent_class;
276

277
          owner_parent_class = g_type_class_peek_parent (owner_class);
278

279 280 281
          parent_iface = g_type_interface_peek (owner_parent_class,
                                                GIMP_TYPE_CONFIG);
        }
282 283
    }

284
  if (config_iface                       &&
285
      config_iface != parent_iface       && /* see comment above */
286 287 288 289 290 291 292
      config_iface->deserialize_property &&
      config_iface->deserialize_property (config,
                                          prop_spec->param_id,
                                          &value,
                                          prop_spec,
                                          scanner,
                                          &token))
293 294 295 296 297
    {
      /* nop */
    }
  else
    {
298 299 300 301 302 303 304
      if (G_VALUE_HOLDS_OBJECT (&value) &&
          G_VALUE_TYPE (&value) != G_TYPE_FILE)
        {
          token = gimp_config_deserialize_object (&value,
                                                  config, prop_spec,
                                                  scanner, nest_level);
        }
305
      else
306 307 308 309
        {
          token = gimp_config_deserialize_value (&value,
                                                 config, prop_spec, scanner);
        }
310
    }
311

312 313 314
  if (token == G_TOKEN_RIGHT_PAREN &&
      g_scanner_peek_next_token (scanner) == token)
    {
315
      if (! (G_VALUE_HOLDS_OBJECT (&value) &&
316
             (prop_spec->flags & GIMP_CONFIG_PARAM_AGGREGATE)))
317
        g_object_set_property (G_OBJECT (config), prop_spec->name, &value);
318
    }
319
#ifdef CONFIG_DEBUG
320
  else
321
    {
322 323
      g_warning ("%s: couldn't deserialize property %s::%s of type %s",
                 G_STRFUNC,
324
                 g_type_name (G_TYPE_FROM_INSTANCE (config)),
325
                 prop_spec->name,
326 327
                 g_type_name (prop_spec->value_type));
    }
328
#endif
329

330
  g_value_unset (&value);
331

332 333
  g_scanner_set_scope (scanner, old_scope_id);

334
  return token;
335 336
}

337 338
static GTokenType
gimp_config_deserialize_value (GValue     *value,
Sven Neumann's avatar
Sven Neumann committed
339
                               GimpConfig *config,
340 341 342 343 344 345 346 347 348 349 350 351 352 353 354
                               GParamSpec *prop_spec,
                               GScanner   *scanner)
{
  if (G_TYPE_FUNDAMENTAL (prop_spec->value_type) == G_TYPE_ENUM)
    {
      return gimp_config_deserialize_enum (value, prop_spec, scanner);
    }
  else if (G_TYPE_IS_FUNDAMENTAL (prop_spec->value_type))
    {
      return gimp_config_deserialize_fundamental (value, prop_spec, scanner);
    }
  else if (prop_spec->value_type == GIMP_TYPE_MEMSIZE)
    {
      return gimp_config_deserialize_memsize (value, prop_spec, scanner);
    }
355
  else if (prop_spec->value_type == GIMP_TYPE_CONFIG_PATH)
356
    {
357
      return  gimp_config_deserialize_path (value, prop_spec, scanner);
358
    }
359
  else if (prop_spec->value_type == GIMP_TYPE_RGB)
360
    {
361
      return gimp_config_deserialize_rgb (value, prop_spec, scanner);
362
    }
363 364 365 366
  else if (prop_spec->value_type == GIMP_TYPE_MATRIX2)
    {
      return gimp_config_deserialize_matrix2 (value, prop_spec, scanner);
    }
367
  else if (prop_spec->value_type == GIMP_TYPE_VALUE_ARRAY)
368 369
    {
      return gimp_config_deserialize_value_array (value,
Sven Neumann's avatar
Sven Neumann committed
370
                                                  config, prop_spec, scanner);
371
    }
372 373 374 375
  else if (prop_spec->value_type == GIMP_TYPE_UNIT)
    {
      return gimp_config_deserialize_unit (value, prop_spec, scanner);
    }
376 377 378 379
  else if (prop_spec->value_type == G_TYPE_FILE)
    {
      return gimp_config_deserialize_file_value (value, prop_spec, scanner);
    }
380 381 382 383 384 385 386

  /*  This fallback will only work for value_types that
   *  can be transformed from a string value.
   */
  return gimp_config_deserialize_any (value, prop_spec, scanner);
}

387
static GTokenType
388 389
gimp_config_deserialize_fundamental (GValue     *value,
                                     GParamSpec *prop_spec,
390
                                     GScanner   *scanner)
391
{
392
  GTokenType token;
Sven Neumann's avatar
Sven Neumann committed
393 394
  GType      value_type;
  gboolean   negate = FALSE;
395

Sven Neumann's avatar
Sven Neumann committed
396 397 398
  value_type = G_TYPE_FUNDAMENTAL (prop_spec->value_type);

  switch (value_type)
399 400
    {
    case G_TYPE_STRING:
401
      token = G_TOKEN_STRING;
402
      break;
403

404
    case G_TYPE_BOOLEAN:
405
      token = G_TOKEN_IDENTIFIER;
406
      break;
407

408 409
    case G_TYPE_INT:
    case G_TYPE_LONG:
410
    case G_TYPE_INT64:
Sven Neumann's avatar
Sven Neumann committed
411 412 413 414 415 416 417
      if (g_scanner_peek_next_token (scanner) == '-')
        {
          negate = TRUE;
          g_scanner_get_next_token (scanner);
        }
      /*  fallthrough  */
    case G_TYPE_UINT:
418
    case G_TYPE_ULONG:
419
    case G_TYPE_UINT64:
420
      token = G_TOKEN_INT;
421
      break;
422

423 424
    case G_TYPE_FLOAT:
    case G_TYPE_DOUBLE:
425 426 427 428 429
      if (g_scanner_peek_next_token (scanner) == '-')
        {
          negate = TRUE;
          g_scanner_get_next_token (scanner);
        }
430
      token = G_TOKEN_FLOAT;
431
      break;
432

433 434
    default:
      g_assert_not_reached ();
435
      break;
436 437
    }

438
  if (g_scanner_peek_next_token (scanner) != token)
Sven Neumann's avatar
Sven Neumann committed
439 440 441
    {
      return token;
    }
442 443 444

  g_scanner_get_next_token (scanner);

Sven Neumann's avatar
Sven Neumann committed
445
  switch (value_type)
446
    {
447
    case G_TYPE_STRING:
448
      if (scanner_string_utf8_valid (scanner, prop_spec->name))
449
        g_value_set_static_string (value, scanner->value.v_string);
450 451
      else
        return G_TOKEN_NONE;
452
      break;
453

454 455 456 457 458 459 460
    case G_TYPE_BOOLEAN:
      if (! g_ascii_strcasecmp (scanner->value.v_identifier, "yes") ||
          ! g_ascii_strcasecmp (scanner->value.v_identifier, "true"))
        g_value_set_boolean (value, TRUE);
      else if (! g_ascii_strcasecmp (scanner->value.v_identifier, "no") ||
               ! g_ascii_strcasecmp (scanner->value.v_identifier, "false"))
        g_value_set_boolean (value, FALSE);
461
      else
462
        {
463 464
          g_scanner_error
            (scanner,
465
             /* please don't translate 'yes' and 'no' */
466
             _("expected 'yes' or 'no' for boolean token %s, got '%s'"),
467
             prop_spec->name, scanner->value.v_identifier);
468
          return G_TOKEN_NONE;
469 470 471 472
        }
      break;

    case G_TYPE_INT:
Sven Neumann's avatar
Sven Neumann committed
473
      g_value_set_int (value, (negate ?
474 475
                               - scanner->value.v_int64 :
                               scanner->value.v_int64));
476 477
      break;
    case G_TYPE_UINT:
478
      g_value_set_uint (value, scanner->value.v_int64);
479
      break;
480

481
    case G_TYPE_LONG:
Sven Neumann's avatar
Sven Neumann committed
482
      g_value_set_long (value, (negate ?
483 484
                                - scanner->value.v_int64 :
                                scanner->value.v_int64));
485 486
      break;
    case G_TYPE_ULONG:
487 488 489 490 491 492 493
      g_value_set_ulong (value, scanner->value.v_int64);
      break;

    case G_TYPE_INT64:
      g_value_set_int64 (value, (negate ?
                                 - scanner->value.v_int64 :
                                 scanner->value.v_int64));
494
      break;
495 496 497 498
    case G_TYPE_UINT64:
      g_value_set_uint64 (value, scanner->value.v_int64);
      break;

499
    case G_TYPE_FLOAT:
500 501
      g_value_set_float (value, negate ?
                         - scanner->value.v_float : scanner->value.v_float);
502 503
      break;
    case G_TYPE_DOUBLE:
504 505
      g_value_set_double (value, negate ?
                          - scanner->value.v_float: scanner->value.v_float);
506
      break;
507

508
    default:
509 510
      g_assert_not_reached ();
      break;
511
    }
512

513
  return G_TOKEN_RIGHT_PAREN;
514 515
}

516
static GTokenType
517 518
gimp_config_deserialize_enum (GValue     *value,
                              GParamSpec *prop_spec,
519
                              GScanner   *scanner)
520 521 522 523 524
{
  GEnumClass *enum_class;
  GEnumValue *enum_value;

  enum_class = g_type_class_peek (G_VALUE_TYPE (value));
525 526

  switch (g_scanner_peek_next_token (scanner))
527
    {
528 529 530
    case G_TOKEN_IDENTIFIER:
      g_scanner_get_next_token (scanner);

531
      enum_value = g_enum_get_value_by_nick (enum_class,
Sven Neumann's avatar
Sven Neumann committed
532
                                             scanner->value.v_identifier);
533
      if (! enum_value)
Sven Neumann's avatar
Sven Neumann committed
534 535
        enum_value = g_enum_get_value_by_name (enum_class,
                                               scanner->value.v_identifier);
536 537 538 539 540 541
      if (! enum_value)
        {
          /*  if the value was not found, check if we have a compat
           *  enum to find the ideitifier
           */
          GQuark quark       = g_quark_from_static_string ("gimp-compat-enum");
542 543
          GType  compat_type = (GType) g_type_get_qdata (G_VALUE_TYPE (value),
                                                         quark);
544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563

          if (compat_type)
            {
              GEnumClass *compat_class = g_type_class_ref (compat_type);

              enum_value = g_enum_get_value_by_nick (compat_class,
                                                     scanner->value.v_identifier);
              if (! enum_value)
                enum_value = g_enum_get_value_by_name (compat_class,
                                                       scanner->value.v_identifier);

              /*  finally, if we found a compat value, make sure the
               *  same value exists in the original enum
               */
              if (enum_value)
                enum_value = g_enum_get_value (enum_class, enum_value->value);

              g_type_class_unref (compat_class);
           }
        }
564

565
      if (! enum_value)
Sven Neumann's avatar
Sven Neumann committed
566 567 568 569 570 571
        {
          g_scanner_error (scanner,
                           _("invalid value '%s' for token %s"),
                           scanner->value.v_identifier, prop_spec->name);
          return G_TOKEN_NONE;
        }
572
      break;
573

574 575 576
    case G_TOKEN_INT:
      g_scanner_get_next_token (scanner);

577 578
      enum_value = g_enum_get_value (enum_class,
                                     (gint) scanner->value.v_int64);
579

580
      if (! enum_value)
Sven Neumann's avatar
Sven Neumann committed
581 582 583 584 585 586
        {
          g_scanner_error (scanner,
                           _("invalid value '%ld' for token %s"),
                           (glong) scanner->value.v_int64, prop_spec->name);
          return G_TOKEN_NONE;
        }
587
      break;
588

589 590
    default:
      return G_TOKEN_IDENTIFIER;
591
    }
592

593 594
  g_value_set_enum (value, enum_value->value);

595
  return G_TOKEN_RIGHT_PAREN;
596 597
}

598 599 600 601 602
static GTokenType
gimp_config_deserialize_memsize (GValue     *value,
                                 GParamSpec *prop_spec,
                                 GScanner   *scanner)
{
603 604 605
  gchar   *orig_cset_first = scanner->config->cset_identifier_first;
  gchar   *orig_cset_nth   = scanner->config->cset_identifier_nth;
  guint64  memsize;
606 607 608

  scanner->config->cset_identifier_first = G_CSET_DIGITS;
  scanner->config->cset_identifier_nth   = G_CSET_DIGITS "gGmMkKbB";
609

610 611
  if (g_scanner_peek_next_token (scanner) != G_TOKEN_IDENTIFIER)
    return G_TOKEN_IDENTIFIER;
612

613 614 615 616
  g_scanner_get_next_token (scanner);

  scanner->config->cset_identifier_first = orig_cset_first;
  scanner->config->cset_identifier_nth   = orig_cset_nth;
617

618
  if (! gimp_memsize_deserialize (scanner->value.v_identifier, &memsize))
619
    return G_TOKEN_NONE;
620 621 622 623

  g_value_set_uint64 (value, memsize);

  return G_TOKEN_RIGHT_PAREN;
624 625 626 627 628 629 630
}

static GTokenType
gimp_config_deserialize_path (GValue     *value,
                              GParamSpec *prop_spec,
                              GScanner   *scanner)
{
631
  GError *error = NULL;
632

633 634 635 636 637
  if (g_scanner_peek_next_token (scanner) != G_TOKEN_STRING)
    return G_TOKEN_STRING;

  g_scanner_get_next_token (scanner);

638 639 640
  if (!scanner_string_utf8_valid (scanner, prop_spec->name))
    return G_TOKEN_NONE;

641 642 643
  if (scanner->value.v_string)
    {
      /*  Check if the string can be expanded
644
       *  and converted to the filesystem encoding.
645 646 647
       */
      gchar *expand = gimp_config_path_expand (scanner->value.v_string,
                                               TRUE, &error);
648

649 650 651
      if (!expand)
        {
          g_scanner_error (scanner,
652
                           _("while parsing token '%s': %s"),
653 654
                           prop_spec->name, error->message);
          g_error_free (error);
655

656 657
          return G_TOKEN_NONE;
        }
658

659
      g_free (expand);
660

661 662
      g_value_set_static_string (value, scanner->value.v_string);
    }
663 664 665 666

  return G_TOKEN_RIGHT_PAREN;
}

667
static GTokenType
668 669 670
gimp_config_deserialize_rgb (GValue     *value,
                             GParamSpec *prop_spec,
                             GScanner   *scanner)
671
{
672
  GimpRGB rgb;
673

674
  if (! gimp_scanner_parse_color (scanner, &rgb))
675
    return G_TOKEN_NONE;
676

677
  g_value_set_boxed (value, &rgb);
678

679
  return G_TOKEN_RIGHT_PAREN;
680 681
}

682 683 684 685 686 687 688 689 690 691 692 693 694 695 696
static GTokenType
gimp_config_deserialize_matrix2 (GValue     *value,
                                 GParamSpec *prop_spec,
                                 GScanner   *scanner)
{
  GimpMatrix2 matrix;

  if (! gimp_scanner_parse_matrix2 (scanner, &matrix))
    return G_TOKEN_NONE;

  g_value_set_boxed (value, &matrix);

  return G_TOKEN_RIGHT_PAREN;
}

697 698
static GTokenType
gimp_config_deserialize_object (GValue     *value,
699
                                GimpConfig *config,
700 701 702 703
                                GParamSpec *prop_spec,
                                GScanner   *scanner,
                                gint        nest_level)
{
704 705
  GimpConfigInterface *config_iface;
  GimpConfig          *prop_object;
706

707
  g_object_get_property (G_OBJECT (config), prop_spec->name, value);
708 709 710 711

  prop_object = g_value_get_object (value);

  if (! prop_object)
712
    {
713
      /*  if the object property is not GIMP_CONFIG_PARAM_AGGREGATE, read
714 715
       *  the type of the object and create it
       */
716
      if (! (prop_spec->flags & GIMP_CONFIG_PARAM_AGGREGATE))
717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738
        {
          gchar *type_name;
          GType  type;

          if (! gimp_scanner_parse_string (scanner, &type_name))
            return G_TOKEN_STRING;

          type = g_type_from_name (type_name);
          g_free (type_name);

          if (! g_type_is_a (type, prop_spec->value_type))
            return G_TOKEN_STRING;

          prop_object = g_object_new (type, NULL);

          g_value_take_object (value, prop_object);
        }
      else
        {
          return G_TOKEN_RIGHT_PAREN;
        }
    }
739

740
  config_iface = GIMP_CONFIG_GET_INTERFACE (prop_object);
741

742
  if (! config_iface)
743
    return gimp_config_deserialize_any (value, prop_spec, scanner);
744

745
  if (! config_iface->deserialize (prop_object, scanner, nest_level + 1, NULL))
746 747 748 749 750
    return G_TOKEN_NONE;

  return G_TOKEN_RIGHT_PAREN;
}

751 752
static GTokenType
gimp_config_deserialize_value_array (GValue     *value,
753
                                     GimpConfig *config,
754 755 756
                                     GParamSpec *prop_spec,
                                     GScanner   *scanner)
{
757 758
  GimpParamSpecValueArray *array_spec;
  GimpValueArray          *array;
759
  GValue                   array_value = G_VALUE_INIT;
760 761 762
  gint                     n_values;
  GTokenType               token;
  gint                     i;
763

764
  array_spec = GIMP_PARAM_SPEC_VALUE_ARRAY (prop_spec);
765

766
  if (! gimp_scanner_parse_int (scanner, &n_values))
767 768
    return G_TOKEN_INT;

769
  array = gimp_value_array_new (n_values);
770 771 772 773 774 775

  for (i = 0; i < n_values; i++)
    {
      g_value_init (&array_value, array_spec->element_spec->value_type);

      token = gimp_config_deserialize_value (&array_value,
776
                                             config,
777 778 779 780
                                             array_spec->element_spec,
                                             scanner);

      if (token == G_TOKEN_RIGHT_PAREN)
781
        gimp_value_array_append (array, &array_value);
782 783 784 785 786 787 788

      g_value_unset (&array_value);

      if (token != G_TOKEN_RIGHT_PAREN)
        return token;
    }

789
  g_value_take_boxed (value, array);
790

791 792 793
  return G_TOKEN_RIGHT_PAREN;
}

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 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 873 874 875 876 877 878
/* This function is entirely sick, so is our method of serializing
 * units, which we write out as (unit foo bar) instead of
 * (unit "foo bar"). The assumption that caused this shit was that a
 * unit's "identifier" is really an identifier in the C-ish sense,
 * when in fact it's just a random user entered string.
 *
 * Here, we try to parse at least the default units shipped with gimp,
 * and we add code to parse (unit "foo bar") in order to be compatible
 * with future correct unit serializing.
 */
static GTokenType
gimp_config_deserialize_unit (GValue     *value,
                              GParamSpec *prop_spec,
                              GScanner   *scanner)
{
  gchar      *old_cset_skip_characters;
  gchar      *old_cset_identifier_first;
  gchar      *old_cset_identifier_nth;
  GString    *buffer;
  GValue      src = G_VALUE_INIT;
  GTokenType  token;

  /* parse the next token *before* reconfiguring the scanner, so it
   * skips whitespace first
   */
  token = g_scanner_peek_next_token (scanner);

  if (token == G_TOKEN_STRING)
    return gimp_config_deserialize_any (value, prop_spec, scanner);

  old_cset_skip_characters  = scanner->config->cset_skip_characters;
  old_cset_identifier_first = scanner->config->cset_identifier_first;
  old_cset_identifier_nth   = scanner->config->cset_identifier_nth;

  scanner->config->cset_skip_characters  = "";
  scanner->config->cset_identifier_first = ( G_CSET_a_2_z G_CSET_A_2_Z "." );
  scanner->config->cset_identifier_nth   = ( G_CSET_a_2_z G_CSET_A_2_Z
                                             G_CSET_DIGITS "-_." );

  buffer = g_string_new ("");

  while (g_scanner_peek_next_token (scanner) != G_TOKEN_RIGHT_PAREN)
    {
      token = g_scanner_peek_next_token (scanner);

      if (token == G_TOKEN_IDENTIFIER)
        {
          g_scanner_get_next_token (scanner);
          g_string_append (buffer, scanner->value.v_identifier);
        }
      else if (token == G_TOKEN_CHAR)
        {
          g_scanner_get_next_token (scanner);
          g_string_append_c (buffer, scanner->value.v_char);
        }
      else if (token == ' ')
        {
          g_scanner_get_next_token (scanner);
          g_string_append_c (buffer, token);
        }
      else
        {
          token = G_TOKEN_IDENTIFIER;
          goto cleanup;
        }
    }

  g_value_init (&src, G_TYPE_STRING);
  g_value_set_static_string (&src, buffer->str);
  g_value_transform (&src, value);
  g_value_unset (&src);

  token = G_TOKEN_RIGHT_PAREN;

 cleanup:

  g_string_free (buffer, TRUE);

  scanner->config->cset_skip_characters  = old_cset_skip_characters;
  scanner->config->cset_identifier_first = old_cset_identifier_first;
  scanner->config->cset_identifier_nth   = old_cset_identifier_nth;

  return token;
}

879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902
static GTokenType
gimp_config_deserialize_file_value (GValue     *value,
                                    GParamSpec *prop_spec,
                                    GScanner   *scanner)
{
  GTokenType token;

  token = g_scanner_peek_next_token (scanner);

  if (token != G_TOKEN_IDENTIFIER &&
      token != G_TOKEN_STRING)
    {
      return G_TOKEN_STRING;
    }

  g_scanner_get_next_token (scanner);

  if (token == G_TOKEN_IDENTIFIER)
    {
      /* this is supposed to parse a literal "NULL" only, but so what... */
      g_value_set_object (value, NULL);
    }
  else
    {
903 904
      gchar *path = gimp_config_path_expand (scanner->value.v_string, TRUE,
                                             NULL);
905

906 907 908 909 910 911 912 913 914 915 916
      if (path)
        {
          GFile *file = g_file_new_for_path (path);

          g_value_take_object (value, file);
          g_free (path);
        }
      else
        {
          g_value_set_object (value, NULL);
        }
917 918 919 920 921
    }

  return G_TOKEN_RIGHT_PAREN;
}

922
static GTokenType
923 924
gimp_config_deserialize_any (GValue     *value,
                             GParamSpec *prop_spec,
925
                             GScanner   *scanner)
926
{
927 928
  GValue     src = G_VALUE_INIT;
  GTokenType token;
929 930 931 932

  if (!g_value_type_transformable (G_TYPE_STRING, prop_spec->value_type))
    {
      g_warning ("%s: %s can not be transformed from a string",
933
                 G_STRFUNC, g_type_name (prop_spec->value_type));
934
      return G_TOKEN_NONE;
935
    }
936

937 938 939 940 941 942 943
  token = g_scanner_peek_next_token (scanner);

  if (token != G_TOKEN_IDENTIFIER &&
      token != G_TOKEN_STRING)
    {
      return G_TOKEN_IDENTIFIER;
    }
944 945 946 947

  g_scanner_get_next_token (scanner);

  g_value_init (&src, G_TYPE_STRING);
948 949 950 951 952 953

  if (token == G_TOKEN_IDENTIFIER)
    g_value_set_static_string (&src, scanner->value.v_identifier);
  else
    g_value_set_static_string (&src, scanner->value.v_string);

954
  g_value_transform (&src, value);
955
  g_value_unset (&src);
956

957
  return G_TOKEN_RIGHT_PAREN;
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

static GTokenType
gimp_config_skip_unknown_property (GScanner *scanner)
{
  gint open_paren = 0;

  while (TRUE)
    {
      GTokenType token = g_scanner_peek_next_token (scanner);

      switch (token)
        {
        case G_TOKEN_LEFT_PAREN:
          open_paren++;
          g_scanner_get_next_token (scanner);
          break;

        case G_TOKEN_RIGHT_PAREN:
          if (open_paren == 0)
            return token;

          open_paren--;
          g_scanner_get_next_token (scanner);
          break;

        case G_TOKEN_EOF:
          return token;

        default:
          g_scanner_get_next_token (scanner);
          break;
        }
    }
}