lib/object_defaults.c

   1 /* Dia -- an diagram creation/manipulation program
   2  * Copyright (C) 1998 Alexander Larsson
   3  *
   4  * object_defaults.c : manage default properties of dia objects
   5  *      The serialization is done with standard object methods in
   6  *      a diagram compatible format.
   7  *
   8  * Copyright (C) 2002 Hans Breuer
   9  *
  10  * This program is free software; you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation; either version 2 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program; if not, write to the Free Software
  22  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  23  */
  24 #include <config.h>
  25
  26 #include <stdlib.h> /* atoi() */
  27 #include <string.h>
  28
  29 #include <glib.h>
  30
  31 #include "intl.h"
  32
  33 #include <libxml/tree.h>
  34 #include "dia_xml_libxml.h"
  35 #include "dia_xml.h"
  36 #include "object.h"
  37 #include "message.h"
  38 #include "dia_dirs.h"
  39
  40 static GHashTable *defaults_hash = NULL;
  41 static gboolean object_default_create_lazy = FALSE;
  42
  43 static void
  44 _obj_create (gpointer key,
  45              gpointer value,
  46              gpointer user_data)
  47 {
  48   gchar *name = (gchar *)key;
  49   DiaObjectType *type = (DiaObjectType *)value;
  50   GHashTable *ht = (GHashTable *) user_data;
  51   DiaObject *obj;
  52   Point startpoint = {0.0,0.0};
  53   Handle *handle1,*handle2;
  54
  55   g_assert (g_hash_table_lookup (ht, name) == NULL);
  56
  57   /* at least 'Group' has no ops */
  58   if (!type->ops)
  59     return;
  60
  61   /* the custom objects needs extra_data */
  62   obj = type->ops->create(&startpoint, type->default_user_data, &handle1,&handle2);
  63   if (!obj)
  64     g_warning ("Failed to create default object for '%s'", name);
  65   else if (0 != strcmp (obj->type->name, name))
  66     object_destroy (obj); /* Skip over 'compatibility' names/objects */
  67   else
  68     g_hash_table_insert(ht, obj->type->name, obj);
  69 }
  70
  71 static void
  72 _obj_destroy (gpointer val)
  73 {
  74   DiaObject *obj = (DiaObject *)val;
  75
  76   obj->ops->destroy (obj);
  77 }
  78
  79 /**
  80  * @param filename the file to load from or NULL for default
  81  * @param create_lazy if FALSE creates default objects for
  82  *             every known type. Otherwise default objects
  83  *             are created on demand
  84  *
  85  * Create all the default objects.
  86  */
  87 gboolean
  88 dia_object_defaults_load (const gchar *filename, gboolean create_lazy)
  89 {
  90   xmlDocPtr doc;
  91   xmlNsPtr name_space;
  92   ObjectNode obj_node, layer_node;
  93
  94   object_default_create_lazy = create_lazy;
  95
  96   if (!defaults_hash)
  97     {
  98       defaults_hash = g_hash_table_new_full(g_str_hash, g_str_equal,
  99                                             NULL, _obj_destroy);
 100
 101       if (!create_lazy)
 102         object_registry_foreach (_obj_create, defaults_hash);
 103     }
 104
 105
 106   /* overload properties from file */
 107   if (!filename)
 108     {
 109       gchar *default_filename = dia_config_filename("defaults.dia");
 110
 111       if (g_file_test(default_filename, G_FILE_TEST_EXISTS))
 112         doc = xmlDiaParseFile(default_filename);
 113       else
 114         doc = NULL;
 115       g_free (default_filename);
 116     }
 117   else
 118       doc = xmlDiaParseFile(filename);
 119
 120   if (!doc)
 121       return FALSE;
 122
 123   name_space = xmlSearchNs(doc, doc->xmlRootNode, "dia");
 124   if (   strcmp (doc->xmlRootNode->name, "diagram")
 125       || (name_space == NULL))
 126     {
 127       message_error(_("Error loading defaults '%s'.\n"
 128                       "Not a Dia diagram file."),
 129                     dia_message_filename(filename));
 130       xmlFreeDoc (doc);
 131       return FALSE;
 132     }
 133
 134   layer_node = doc->xmlRootNode->xmlChildrenNode;
 135   while (layer_node)
 136     {
 137       if (   !xmlIsBlankNode(layer_node)
 138           && 0 == strcmp(layer_node->name, "layer"))
 139         {
 140           obj_node = layer_node->xmlChildrenNode;
 141           while (obj_node)
 142             {
 143               if (   !xmlIsBlankNode(obj_node)
 144                   && 0 == strcmp(obj_node->name, "object"))
 145                 {
 146                   char *typestr = xmlGetProp(obj_node, "type");
 147                   char *version = xmlGetProp(obj_node, "version");
 148                   if (typestr)
 149                     {
 150                       DiaObject *obj = g_hash_table_lookup (defaults_hash, typestr);
 151                       if (!obj)
 152                         {
 153                           if (!create_lazy)
 154                             g_warning ("Unknown object '%s' while reading '%s'",
 155                                        typestr, filename);
 156                           else
 157                             {
 158                               DiaObjectType *type = object_get_type (typestr);
 159                               if (type)
 160                                 obj = type->ops->load (
 161                                         obj_node,
 162                                         version ? atoi(version) : 0,
 163                                         filename);
 164                               if (obj)
 165                                 g_hash_table_insert (defaults_hash,
 166                                                      obj->type->name, obj);
 167                             }
 168                         }
 169                       else
 170                         {
 171 #if 0 /* lots of complaining about missing attributes */
 172                           object_load_props(obj, obj_node); /* leaks ?? */
 173 #else
 174                           DiaObject *def_obj;
 175                           def_obj = obj->type->ops->load (
 176                                         obj_node,
 177                                         version ? atoi(version) : 0,
 178                                         filename);
 179                           if (def_obj->ops->set_props)
 180                             {
 181                               object_copy_props (obj, def_obj, FALSE);
 182                               def_obj->ops->destroy (def_obj);
 183                             }
 184                           else
 185                             {
 186                               /* can't copy props */
 187                               g_hash_table_replace (defaults_hash,
 188                                                     def_obj->type->name, def_obj);
 189                             }
 190 #endif
 191                         }
 192                       if (version)
 193                           xmlFree (version);
 194                       xmlFree (typestr);
 195                     }
 196                 }
 197               obj_node = obj_node->next;
 198             }
 199         }
 200       layer_node = layer_node->next;
 201     }
 202
 203   xmlFreeDoc(doc);
 204   return TRUE;
 205 }
 206
 207 /*
 208  * Remember as defaults from a diagram object
 209  */
 210 void
 211 dia_object_default_make (const DiaObject *obj_from)
 212 {
 213   DiaObject *obj_to;
 214
 215   g_return_if_fail (obj_from);
 216
 217   obj_to = dia_object_default_get (obj_from->type);
 218   g_return_if_fail (obj_to);
 219
 220   object_copy_props (obj_to, obj_from, TRUE);
 221 }
 222
 223 /**
 224  * dia_object_default_get :
 225  * @param type The type of the object for which you want the defaults object.
 226  *
 227  * Allows to edit one defaults object properties
 228  */
 229 DiaObject *
 230 dia_object_default_get (const DiaObjectType *type)
 231 {
 232   DiaObject *obj;
 233
 234   obj = g_hash_table_lookup (defaults_hash, type->name);
 235   if (!obj && object_default_create_lazy)
 236     {
 237       Point startpoint = {0.0,0.0};
 238       Handle *handle1,*handle2;
 239
 240       /* at least 'Group' has no ops */
 241       if (!type->ops)
 242         return NULL;
 243
 244       /* the custom objects needs extra_data */
 245       obj = type->ops->create(&startpoint,
 246                               type->default_user_data,
 247                               &handle1,&handle2);
 248       if (obj)
 249         g_hash_table_insert (defaults_hash, obj->type->name, obj);
 250     }
 251
 252   return obj;
 253 }
 254
 255 /**
 256  * dia_object_default_create:
 257  * @param type The objects type
 258  * @param startpoint The left upper corner
 259  * @param user_data
 260  * @param handle1
 261  * @param handle2
 262  * @return A newly created object.
 263  *
 264  * Create an object respecting defaults if available
 265  */
 266 DiaObject *
 267 dia_object_default_create (const DiaObjectType *type,
 268                            Point *startpoint,
 269                            void *user_data,
 270                            Handle **handle1,
 271                            Handle **handle2)
 272 {
 273   const DiaObject *def_obj;
 274   DiaObject *obj;
 275
 276   g_return_val_if_fail (type != NULL, NULL);
 277
 278   def_obj = dia_object_default_get (type);
 279   if (def_obj && def_obj->ops->describe_props)
 280     {
 281       /* copy properties to new object, but keep position */
 282       obj = type->ops->create (startpoint, user_data, handle1, handle2);
 283       if (obj)
 284         {
 285           object_copy_props (obj, def_obj, TRUE);
 286           obj->ops->move (obj, startpoint);
 287         }
 288     }
 289   else
 290     {
 291       obj = type->ops->create (startpoint, user_data, handle1, handle2);
 292     }
 293
 294   return obj;
 295 }
 296
 297 typedef struct _MyLayerInfo MyLayerInfo;
 298 struct _MyLayerInfo
 299 {
 300   Point      pos;
 301   xmlNodePtr node;
 302 };
 303
 304 typedef struct _MyRootInfo MyRootInfo;
 305 struct _MyRootInfo
 306 {
 307   xmlNodePtr  node;
 308   gchar      *filename;
 309   GHashTable *layer_hash;
 310   xmlNs      *name_space;
 311   gint        obj_nr;
 312 };
 313
 314 static void
 315 _obj_store (gpointer key,
 316             gpointer value,
 317             gpointer user_data)
 318 {
 319   gchar *name = (gchar *)key;
 320   DiaObject *obj = (DiaObject *)value;
 321   MyRootInfo *ri = (MyRootInfo *)user_data;
 322   ObjectNode obj_node;
 323   gchar *layer_name;
 324   gchar buffer[31];
 325   gchar *p;
 326   MyLayerInfo *li;
 327
 328   /* fires if you have messed up the hash keys,
 329    * e.g. by using non permanent memory */
 330   g_assert (0 == strcmp (obj->type->name, name));
 331
 332   p = strstr (name, " - ");
 333   if (p) {
 334     if (p > name)
 335       layer_name = g_strndup (name, p - name);
 336     else
 337       layer_name = g_strdup("NULL");
 338   }
 339   else
 340     layer_name = g_strdup ("default");
 341
 342   li = g_hash_table_lookup (ri->layer_hash, layer_name);
 343   if (!li)
 344     {
 345       li = g_new (MyLayerInfo, 1);
 346       li->node = xmlNewChild(ri->node, ri->name_space, "layer", NULL);
 347       xmlSetProp(li->node, "name", layer_name);
 348       xmlSetProp(li->node, "visible", "false");
 349       li->pos.x = li->pos.y = 0.0;
 350       g_hash_table_insert (ri->layer_hash, layer_name, li);
 351     }
 352   else
 353     g_free (layer_name);
 354
 355   obj_node = xmlNewChild(li->node, NULL, "object", NULL);
 356   xmlSetProp(obj_node, "type", obj->type->name);
 357
 358   g_snprintf(buffer, 30, "%d", obj->type->version);
 359   xmlSetProp(obj_node, "version", buffer);
 360
 361   g_snprintf(buffer, 30, "O%d", ri->obj_nr++);
 362   xmlSetProp(obj_node, "id", buffer);
 363
 364   obj->ops->move (obj,&(li->pos));
 365   obj->type->ops->save (obj, obj_node, ri->filename);
 366   /* arrange following objects below */
 367   li->pos.y += (obj->bounding_box.bottom - obj->bounding_box.top + 1.0);
 368 }
 369
 370 /**
 371  * dia_object_defaults_save:
 372  *
 373  * Saves all the currently created default objects into a
 374  * valid diagram file. All the objects are placed into
 375  * separate invisible layers.
 376  */
 377 gboolean
 378 dia_object_defaults_save (const gchar *filename)
 379 {
 380   MyRootInfo ni;
 381   xmlDocPtr doc;
 382   gboolean ret;
 383   gchar *real_filename;
 384   int old_blanks_default = pretty_formated_xml;
 385
 386   /* FIXME HACK: we always want nice readable default files,
 387    *  but toggling it by a global var is ugly   --hb
 388    */
 389   pretty_formated_xml = TRUE;
 390
 391   if (!filename)
 392     real_filename = dia_config_filename("defaults.dia");
 393   else
 394     real_filename = g_strdup (filename);
 395
 396   doc = xmlNewDoc("1.0");
 397   doc->encoding = xmlStrdup("UTF-8");
 398   doc->xmlRootNode = xmlNewDocNode(doc, NULL, "diagram", NULL);
 399
 400   ni.name_space = xmlNewNs(doc->xmlRootNode,
 401                            DIA_XML_NAME_SPACE_BASE,
 402                            "dia");
 403   xmlSetNs(doc->xmlRootNode, ni.name_space);
 404
 405   ni.obj_nr = 0;
 406   ni.node = doc->xmlRootNode;
 407   ni.filename = real_filename;
 408   ni.layer_hash = g_hash_table_new_full (g_str_hash, g_str_equal,
 409                                          g_free, g_free);
 410
 411   g_hash_table_foreach (defaults_hash, _obj_store, &ni);
 412
 413   ret = xmlDiaSaveFile (real_filename, doc);
 414   g_free (real_filename);
 415   xmlFreeDoc(doc);
 416   pretty_formated_xml = old_blanks_default;
 417
 418   g_hash_table_destroy (ni.layer_hash);
 419
 420   return ret;
 421 }