glade-builtins.c 16.4 KB
Newer Older
1 2 3
/*
 * glade-clipboard.c - An object for handling Cut/Copy/Paste.
 *
4
 * Copyright (C) 2005 The GNOME Foundation.
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
 *
 * Author(s):
 *      Tristan Van Berkom <tvb@gnome.org>
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
20 21 22
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307,
 * USA.
23 24 25 26 27 28 29 30
 */

#ifdef HAVE_CONFIG_H
#include <config.h>
#endif

#include <glib-object.h>
#include <glib/gi18n-lib.h>
31
#include <string.h>
32
#include "glade-builtins.h"
33
#include "glade-displayable-values.h"
34

Tristan Van Berkom's avatar
Tristan Van Berkom committed
35

36 37 38 39 40 41 42
struct _GladeParamSpecObjects
{
  GParamSpec parent_instance;

  GType type;                   /* Object or interface type accepted
                                 * in this object list.
                                 */
43 44
};

45 46 47 48 49 50
typedef struct _GladeStockItem
{
  gchar *value_name;
  gchar *value_nick;
  gchar *clean_name;
  gint value;
51 52
} GladeStockItem;

Tristan Van Berkom's avatar
Tristan Van Berkom committed
53 54 55 56

/************************************************************
 *      Auto-generate the enum type for stock properties    *
 ************************************************************/
57

58
/* Hard-coded list of stock images (and displayable translations) from gtk+ that are not stock "items" */
59 60 61 62 63 64 65 66
static const gchar *builtin_stock_images[] = {
  "gtk-dialog-authentication",  /* GTK_STOCK_DIALOG_AUTHENTICATION */
  "gtk-dnd",                    /* GTK_STOCK_DND */
  "gtk-dnd-multiple",           /* GTK_STOCK_DND_MULTIPLE */
  "gtk-color-picker",           /* GTK_STOCK_COLOR_PICKER */
  "gtk-directory",              /* GTK_STOCK_DIRECTORY */
  "gtk-file",                   /* GTK_STOCK_FILE */
  "gtk-missing-image"           /* GTK_STOCK_MISSING_IMAGE */
67 68
};

69
static const gchar *builtin_stock_displayables[] = {
70 71 72 73 74 75 76 77 78 79 80 81 82 83
  /* GTK_STOCK_DIALOG_AUTHENTICATION */
  N_("Authentication"),
  /* GTK_STOCK_DND */
  N_("Drag and Drop"),
  /* GTK_STOCK_DND_MULTIPLE */
  N_("Drag and Drop Multiple"),
  /* GTK_STOCK_COLOR_PICKER */
  N_("Color Picker"),
  /* GTK_STOCK_DIRECTORY */
  N_("Directory"),
  /* GTK_STOCK_FILE */
  N_("File"),
  /* GTK_STOCK_MISSING_IMAGE */
  N_("Missing Image")
84 85
};

86 87 88
static GSList *stock_prefixs = NULL;
static gboolean stock_prefixs_done = FALSE;

89 90
/* FIXME: func needs documentation
 */
91
void
92
glade_standard_stock_append_prefix (const gchar * prefix)
93
{
94 95 96 97 98 99 100 101
  if (stock_prefixs_done)
    {
      g_warning
          ("glade_standard_stock_append_prefix should be used in catalog init-function");
      return;
    }

  stock_prefixs = g_slist_append (stock_prefixs, g_strdup (prefix));
102 103
}

104
static GladeStockItem *
105
new_from_values (const gchar * name, const gchar * nick, gint value)
106
{
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136
  GladeStockItem *new_gsi = NULL;
  gchar *clean_name;
  size_t len = 0;
  guint i = 0;
  guint j = 0;

  new_gsi = (GladeStockItem *) g_malloc0 (sizeof (GladeStockItem));

  new_gsi->value_name = g_strdup (name);
  new_gsi->value_nick = g_strdup (nick);
  new_gsi->value = value;


  clean_name = g_strdup (name);
  len = strlen (clean_name);

  while (i + j <= len)
    {
      if (clean_name[i + j] == '_')
        j++;

      clean_name[i] = clean_name[i + j];
      i++;
    }

  new_gsi->clean_name = g_utf8_collate_key (clean_name, i - j);

  g_free (clean_name);

  return new_gsi;
137 138 139
}


140
static gint
141 142
compare_two_gsi (gconstpointer a, gconstpointer b)
{
143 144
  GladeStockItem *gsi1 = (GladeStockItem *) a;
  GladeStockItem *gsi2 = (GladeStockItem *) b;
145

146
  return strcmp (gsi1->clean_name, gsi2->clean_name);
147 148
}

149
static GArray *
150
list_stock_items (gboolean include_images)
151
{
152 153 154 155 156 157 158 159 160 161
  GtkStockItem item;
  GSList *l = NULL, *stock_list = NULL, *p = NULL;
  gchar *stock_id = NULL, *prefix = NULL;
  gint stock_enum = 0, i = 0;
  GEnumValue value;
  GArray *values = NULL;
  GladeStockItem *gsi;
  GSList *gsi_list = NULL;
  GSList *gsi_list_list = NULL;

162 163 164 165 166 167 168 169 170 171 172 173
  if (gdk_display_get_default () == NULL)
    {
      values = g_array_sized_new (TRUE, TRUE, sizeof (GEnumValue), 1);

      value.value = 0;
      value.value_name = "dummy";
      value.value_nick = "Dummy";
      g_array_append_val (values, value);

      return values;
    }

174
G_GNUC_BEGIN_IGNORE_DEPRECATIONS
175
  stock_list = g_slist_reverse (gtk_stock_list_ids ());
176
G_GNUC_END_IGNORE_DEPRECATIONS
177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192

  values = g_array_sized_new (TRUE, TRUE, sizeof (GEnumValue),
                              g_slist_length (stock_list));

  /* We want gtk+ stock items to appear first */
  if ((stock_prefixs && strcmp (stock_prefixs->data, "gtk-")) ||
      stock_prefixs == NULL)
    stock_prefixs = g_slist_prepend (stock_prefixs, g_strdup ("gtk-"));

  for (p = stock_prefixs; p; p = g_slist_next (p))
    {
      prefix = p->data;

      for (l = stock_list; l; l = g_slist_next (l))
        {
          stock_id = l->data;
193
G_GNUC_BEGIN_IGNORE_DEPRECATIONS
194 195 196
          if (g_str_has_prefix (stock_id, prefix) == FALSE ||
              gtk_stock_lookup (stock_id, &item) == FALSE)
            continue;
197
G_GNUC_END_IGNORE_DEPRECATIONS
198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249

          gsi = new_from_values (item.label, stock_id, stock_enum++);
          gsi_list =
              g_slist_insert_sorted (gsi_list, gsi,
                                     (GCompareFunc) compare_two_gsi);
        }

      gsi_list_list = g_slist_append (gsi_list_list, gsi_list);
      gsi_list = NULL;

      /* Images are appended after the gtk+ group of items */
      if (include_images && !strcmp (prefix, "gtk-"))
        {
          for (i = 0; i < G_N_ELEMENTS (builtin_stock_images); i++)
            {
              gsi =
                  new_from_values (builtin_stock_images[i],
                                   builtin_stock_images[i], stock_enum++);
              gsi_list =
                  g_slist_insert_sorted (gsi_list, gsi,
                                         (GCompareFunc) compare_two_gsi);
            }
          gsi_list_list = g_slist_append (gsi_list_list, gsi_list);
          gsi_list = NULL;
        }
    }

  for (p = gsi_list_list; p; p = g_slist_next (p))
    {

      for (l = (GSList *) p->data; l; l = g_slist_next (l))
        {
          gsi = (GladeStockItem *) l->data;
          value.value = gsi->value;
          value.value_name = g_strdup (gsi->value_name);
          value.value_nick = g_strdup (gsi->value_nick);
          values = g_array_append_val (values, value);

          g_free (gsi->value_nick);
          g_free (gsi->value_name);
          g_free (gsi->clean_name);
          g_free (gsi);
        }
      g_slist_free ((GSList *) p->data);
    }

  g_slist_free (gsi_list_list);

  stock_prefixs_done = TRUE;
  g_slist_free (stock_list);

  return values;
250 251
}

252
static gchar *
253
clean_stock_name (const gchar * name)
254
{
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
  gchar *clean_name, *str;
  size_t len = 0;
  guint i = 0;
  guint j = 0;

  g_assert (name && name[0]);

  str = g_strdup (name);
  len = strlen (str);

  while (i + j <= len)
    {
      if (str[i + j] == '_')
        j++;

      str[i] = str[i + j];
      i++;
    }
  clean_name = g_strndup (str, i - j);
  g_free (str);

  return clean_name;
277 278
}

279 280 281
GType
glade_standard_stock_get_type (void)
{
282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
  static GType etype = 0;

  if (etype == 0)
    {
      GArray *values = list_stock_items (FALSE);
      gint i, n_values = values->len;
      GEnumValue *enum_values = (GEnumValue *) values->data;
      GtkStockItem item;

      etype = g_enum_register_static ("GladeStock",
                                      (GEnumValue *) g_array_free (values,
                                                                   FALSE));

      /* Register displayable by GType, i.e. after the types been created. */
      for (i = 0; i < n_values; i++)
        {
298 299 300 301 302
G_GNUC_BEGIN_IGNORE_DEPRECATIONS
          gboolean valid_item = gtk_stock_lookup (enum_values[i].value_nick, &item);
G_GNUC_END_IGNORE_DEPRECATIONS

          if (valid_item)
303 304
            {
              gchar *clean_name = clean_stock_name (item.label);
305

306 307
              if (!glade_get_displayable_value (etype, enum_values[i].value_nick))
                glade_register_translated_value (etype, enum_values[i].value_nick, clean_name);
308 309 310 311 312
              g_free (clean_name);
            }
        }
    }
  return etype;
313 314 315 316 317 318
}


GType
glade_standard_stock_image_get_type (void)
{
319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334
  static GType etype = 0;

  if (etype == 0)
    {
      GArray *values = list_stock_items (TRUE);
      gint i, n_values = values->len;
      GEnumValue *enum_values = (GEnumValue *) values->data;
      GtkStockItem item;

      etype = g_enum_register_static ("GladeStockImage",
                                      (GEnumValue *) g_array_free (values,
                                                                   FALSE));

      /* Register displayable by GType, i.e. after the types been created. */
      for (i = 0; i < n_values; i++)
        {
335 336 337 338
G_GNUC_BEGIN_IGNORE_DEPRECATIONS
          gboolean valid_item = gtk_stock_lookup (enum_values[i].value_nick, &item);
G_GNUC_END_IGNORE_DEPRECATIONS
          if (valid_item)
339 340 341 342
            {
              gchar *clean_name = clean_stock_name (item.label);

              /* These are translated, we just cut out the mnemonic underscores */
343 344
              if (!glade_get_displayable_value (etype, enum_values[i].value_nick))
                glade_register_translated_value (etype, enum_values[i].value_nick, clean_name);
345 346 347 348 349 350
              g_free (clean_name);
            }
        }

      for (i = 0; i < G_N_ELEMENTS (builtin_stock_images); i++)
        {
351
          /* these ones are translated from glade */
352 353 354 355 356
          if (!glade_get_displayable_value (etype, builtin_stock_images[i]))
            glade_register_displayable_value (etype,
                                              builtin_stock_images[i],
                                              GETTEXT_PACKAGE,
                                              builtin_stock_displayables[i]);
357 358 359
        }
    }
  return etype;
360 361 362 363 364
}

GParamSpec *
glade_standard_stock_spec (void)
{
365 366 367
  return g_param_spec_enum ("stock", _("Stock"),
                            _("A builtin stock item"),
                            GLADE_TYPE_STOCK, 0, G_PARAM_READWRITE);
368 369 370 371 372
}

GParamSpec *
glade_standard_stock_image_spec (void)
{
373 374 375
  return g_param_spec_enum ("stock-image", _("Stock Image"),
                            _("A builtin stock image"),
                            GLADE_TYPE_STOCK_IMAGE, 0, G_PARAM_READWRITE);
376 377
}

Tristan Van Berkom's avatar
Tristan Van Berkom committed
378
/****************************************************************
Tristan Van Berkom's avatar
Tristan Van Berkom committed
379
 *  A GList boxed type used by GladeParamSpecObjects and        *
380
 *  GladeParamSpecAccel (which is now in the glade-gtk backend) *
Tristan Van Berkom's avatar
Tristan Van Berkom committed
381 382 383 384
 ****************************************************************/
GType
glade_glist_get_type (void)
{
385 386 387 388 389 390 391
  static GType type_id = 0;

  if (!type_id)
    type_id = g_boxed_type_register_static
        ("GladeGList",
         (GBoxedCopyFunc) g_list_copy, (GBoxedFreeFunc) g_list_free);
  return type_id;
Tristan Van Berkom's avatar
Tristan Van Berkom committed
392 393 394 395 396 397 398
}

/****************************************************************
 *  Built-in GladeParamSpecObjects for object list properties   *
 *  (Used as a pspec to desctibe an AtkRelationSet, but can     *
 *  for any object list property)                               *
 ****************************************************************/
Tristan Van Berkom's avatar
Tristan Van Berkom committed
399
static void
400
param_objects_init (GParamSpec * pspec)
Tristan Van Berkom's avatar
Tristan Van Berkom committed
401
{
402 403
  GladeParamSpecObjects *ospec = GLADE_PARAM_SPEC_OBJECTS (pspec);
  ospec->type = G_TYPE_OBJECT;
Tristan Van Berkom's avatar
Tristan Van Berkom committed
404 405 406
}

static void
407
param_objects_set_default (GParamSpec * pspec, GValue * value)
Tristan Van Berkom's avatar
Tristan Van Berkom committed
408
{
409 410 411 412 413
  if (value->data[0].v_pointer != NULL)
    {
      g_free (value->data[0].v_pointer);
    }
  value->data[0].v_pointer = NULL;
Tristan Van Berkom's avatar
Tristan Van Berkom committed
414 415 416
}

static gboolean
417
param_objects_validate (GParamSpec * pspec, GValue * value)
Tristan Van Berkom's avatar
Tristan Van Berkom committed
418
{
419 420 421 422 423 424 425 426 427 428
  GladeParamSpecObjects *ospec = GLADE_PARAM_SPEC_OBJECTS (pspec);
  GList *objects, *list, *toremove = NULL;
  GObject *object;

  objects = value->data[0].v_pointer;

  for (list = objects; list; list = list->next)
    {
      object = list->data;

429
      if (!(G_OBJECT_TYPE (object) == ospec->type ||
430
            g_type_is_a (G_OBJECT_TYPE (object), ospec->type)))
431 432 433 434 435 436 437 438 439 440 441 442 443 444
        toremove = g_list_prepend (toremove, object);
    }

  for (list = toremove; list; list = list->next)
    {
      object = list->data;
      objects = g_list_remove (objects, object);
    }
  if (toremove)
    g_list_free (toremove);

  value->data[0].v_pointer = objects;

  return toremove != NULL;
Tristan Van Berkom's avatar
Tristan Van Berkom committed
445 446 447
}

static gint
448 449
param_objects_values_cmp (GParamSpec * pspec,
                          const GValue * value1, const GValue * value2)
Tristan Van Berkom's avatar
Tristan Van Berkom committed
450 451 452 453 454 455 456 457 458 459 460 461
{
  guint8 *p1 = value1->data[0].v_pointer;
  guint8 *p2 = value2->data[0].v_pointer;

  /* not much to compare here, try to at least provide stable lesser/greater result */

  return p1 < p2 ? -1 : p1 > p2;
}

GType
glade_param_objects_get_type (void)
{
462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481
  static GType objects_type = 0;

  if (objects_type == 0)
    {
      static /* const */ GParamSpecTypeInfo pspec_info = {
        sizeof (GladeParamSpecObjects), /* instance_size */
        16,                     /* n_preallocs */
        param_objects_init,     /* instance_init */
        0xdeadbeef,             /* value_type, assigned further down */
        NULL,                   /* finalize */
        param_objects_set_default,      /* value_set_default */
        param_objects_validate, /* value_validate */
        param_objects_values_cmp,       /* values_cmp */
      };
      pspec_info.value_type = GLADE_TYPE_GLIST;

      objects_type = g_param_type_register_static
          ("GladeParamObjects", &pspec_info);
    }
  return objects_type;
Tristan Van Berkom's avatar
Tristan Van Berkom committed
482 483 484
}

GParamSpec *
485 486 487 488
glade_param_spec_objects (const gchar * name,
                          const gchar * nick,
                          const gchar * blurb,
                          GType accepted_type, GParamFlags flags)
Tristan Van Berkom's avatar
Tristan Van Berkom committed
489 490 491 492
{
  GladeParamSpecObjects *pspec;

  pspec = g_param_spec_internal (GLADE_TYPE_PARAM_OBJECTS,
493 494
                                 name, nick, blurb, flags);

Tristan Van Berkom's avatar
Tristan Van Berkom committed
495 496 497 498 499
  pspec->type = accepted_type;
  return G_PARAM_SPEC (pspec);
}

void
500
glade_param_spec_objects_set_type (GladeParamSpecObjects * pspec, GType type)
Tristan Van Berkom's avatar
Tristan Van Berkom committed
501
{
502
  pspec->type = type;
Tristan Van Berkom's avatar
Tristan Van Berkom committed
503 504
}

Tristan Van Berkom's avatar
Tristan Van Berkom committed
505
GType
506
glade_param_spec_objects_get_type (GladeParamSpecObjects * pspec)
Tristan Van Berkom's avatar
Tristan Van Berkom committed
507
{
508
  return pspec->type;
Tristan Van Berkom's avatar
Tristan Van Berkom committed
509
}
Tristan Van Berkom's avatar
Tristan Van Berkom committed
510 511 512 513 514 515 516 517

/* This was developed for the purpose of holding a list
 * of 'targets' in an AtkRelation (we are setting it up
 * as a property)
 */
GParamSpec *
glade_standard_objects_spec (void)
{
518 519 520
  return glade_param_spec_objects ("objects", _("Objects"),
                                   _("A list of objects"),
                                   G_TYPE_OBJECT, G_PARAM_READWRITE);
Tristan Van Berkom's avatar
Tristan Van Berkom committed
521 522
}

523 524 525 526
/* Pixbuf Type */
GParamSpec *
glade_standard_pixbuf_spec (void)
{
527
  return g_param_spec_object ("pixbuf", _("Image File Name"),
528
                              _("Enter a filename, relative path or full path to "
529
                                "load the image"), GDK_TYPE_PIXBUF,
530
                              G_PARAM_READWRITE);
531 532 533 534 535 536
}

/* GdkColor */
GParamSpec *
glade_standard_gdkcolor_spec (void)
{
537
  return g_param_spec_boxed ("gdkcolor", _("Color"),
538 539
                             _("A GDK color value"), GDK_TYPE_COLOR,
                             G_PARAM_READWRITE);
540
}
Tristan Van Berkom's avatar
Tristan Van Berkom committed
541 542 543 544

/****************************************************************
 *                    Basic types follow                        *
 ****************************************************************/
545 546 547
GParamSpec *
glade_standard_int_spec (void)
{
548 549
  return g_param_spec_int ("int", "Integer",
                           "An integer value",
550
                           G_MININT, G_MAXINT, 0, G_PARAM_READWRITE);
551 552
}

553 554 555
GParamSpec *
glade_standard_uint_spec (void)
{
556 557
  return g_param_spec_uint ("uint", "Unsigned Integer",
                            "An unsigned integer value",
558
                            0, G_MAXUINT, 0, G_PARAM_READWRITE);
559 560
}

561 562 563
GParamSpec *
glade_standard_string_spec (void)
{
564 565
  return g_param_spec_string ("string", _("String"),
                              _("An entry"), "", G_PARAM_READWRITE);
566 567
}

568 569 570
GParamSpec *
glade_standard_strv_spec (void)
{
571 572
  return g_param_spec_boxed ("strv", "Strv",
                             "String array", G_TYPE_STRV, G_PARAM_READWRITE);
573 574
}

575 576 577
GParamSpec *
glade_standard_float_spec (void)
{
578 579
  return g_param_spec_float ("float", "Float",
                             "A floating point entry",
580
                             0.0F, G_MAXFLOAT, 0.0F, G_PARAM_READWRITE);
581
}
582 583 584 585

GParamSpec *
glade_standard_boolean_spec (void)
{
586
  return g_param_spec_boolean ("boolean", "Boolean",
587
                               "A boolean value", FALSE, G_PARAM_READWRITE);
588
}