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   ObjectType *type = (ObjectType *)value;
  50   GHashTable *ht = (GHashTable *) user_data;
  51   Object *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   Object *obj = (Object *)val;
  75
  76   obj->ops->destroy (obj);
  77 }
  78
  79 /**
  80  * dia_object_defaults_load :
  81  * @filename : the file to load from or NULL for default
  82  * @create_lazy : if FALSE creates default objects for
  83  *             every known type. Otherwise default objects
  84  *             are created on demand
  85  *
  86  * Create all the default objects.
  87  */
  88 gboolean
  89 dia_object_defaults_load (const gchar *filename, gboolean create_lazy)
  90 {
  91   xmlDocPtr doc;
  92   xmlNsPtr name_space;
  93   ObjectNode obj_node, layer_node;
  94
  95   object_default_create_lazy = create_lazy;
  96
  97   if (!defaults_hash)
  98     {
  99       defaults_hash = g_hash_table_new_full(g_str_hash, g_str_equal,
 100                                             NULL, _obj_destroy);
 101
 102       if (!create_lazy)
 103         object_registry_foreach (_obj_create, defaults_hash);
 104     }
 105
 106
 107   /* overload properties from file */
 108   if (!filename)
 109     {
 110       gchar *default_filename = dia_config_filename("defaults.dia");
 111       doc = xmlDiaParseFile(default_filename);
 112       g_free (default_filename);
 113     }
 114   else
 115       doc = xmlDiaParseFile(filename);
 116
 117   if (!doc)
 118       return FALSE;
 119
 120   name_space = xmlSearchNs(doc, doc->xmlRootNode, "dia");
 121   if (   strcmp (doc->xmlRootNode->name, "diagram")
 122       || (name_space == NULL))
 123     {
 124       message_error(_("Error loading defaults '%s'.\n"
 125                       "Not a Dia diagram file."), filename);
 126       xmlFreeDoc (doc);
 127       return FALSE;
 128     }
 129
 130   layer_node = doc->xmlRootNode->xmlChildrenNode;
 131   while (layer_node)
 132     {
 133       if (   !xmlIsBlankNode(layer_node)
 134           && 0 == strcmp(layer_node->name, "layer"))
 135         {
 136           obj_node = layer_node->xmlChildrenNode;
 137           while (obj_node)
 138             {
 139               if (   !xmlIsBlankNode(obj_node)
 140                   && 0 == strcmp(obj_node->name, "object"))
 141                 {
 142                   char *typestr = xmlGetProp(obj_node, "type");
 143                   char *version = xmlGetProp(obj_node, "version");
 144                   if (typestr)
 145                     {
 146                       Object *obj = g_hash_table_lookup (defaults_hash, typestr);
 147                       if (!obj)
 148                         {
 149                           if (!create_lazy)
 150                             g_warning ("Unknown object '%s' while reading '%s'",
 151                                        typestr, filename);
 152                           else
 153                             {
 154                               ObjectType *type = object_get_type (typestr);
 155                               if (type)
 156                                 obj = type->ops->load (
 157                                         obj_node,
 158                                         version ? atoi(version) : 0,
 159                                         filename);
 160                               if (obj)
 161                                 g_hash_table_insert (defaults_hash,
 162                                                      obj->type->name, obj);
 163                             }
 164                         }
 165                       else
 166                         {
 167 #if 0 /* lots of complaining about missing attributes */
 168                           object_load_props(obj, obj_node); /* leaks ?? */
 169 #else
 170                           Object *def_obj;
 171                           def_obj = obj->type->ops->load (
 172                                         obj_node,
 173                                         version ? atoi(version) : 0,
 174                                         filename);
 175                           if (def_obj->ops->set_props)
 176                             {
 177                               object_copy_props (obj, def_obj, FALSE);
 178                               def_obj->ops->destroy (def_obj);
 179                             }
 180                           else
 181                             {
 182                               /* can't copy props */
 183                               g_hash_table_replace (defaults_hash,
 184                                                     def_obj->type->name, def_obj);
 185                             }
 186 #endif
 187                         }
 188                       if (version)
 189                           xmlFree (version);
 190                       xmlFree (typestr);
 191                     }
 192                 }
 193               obj_node = obj_node->next;
 194             }
 195         }
 196       layer_node = layer_node->next;
 197     }
 198
 199   xmlFreeDoc(doc);
 200   return TRUE;
 201 }
 202
 203 /*
 204  * Remember as defaults from a diagram object
 205  */
 206 void
 207 dia_object_default_make (const Object *obj_from)
 208 {
 209   Object *obj_to;
 210
 211   g_return_if_fail (obj_from);
 212
 213   obj_to = dia_object_default_get (obj_from->type);
 214   g_return_if_fail (obj_to);
 215
 216   object_copy_props (obj_to, obj_from, TRUE);
 217 }
 218
 219 /**
 220  * dia_object_default_get :
 221  * @type : the ObjectType
 222  *
 223  * Allows to edit one defaults object properties
 224  */
 225 Object *
 226 dia_object_default_get (const ObjectType *type)
 227 {
 228   Object *obj;
 229
 230   obj = g_hash_table_lookup (defaults_hash, type->name);
 231   if (!obj && object_default_create_lazy)
 232     {
 233       Point startpoint = {0.0,0.0};
 234       Handle *handle1,*handle2;
 235
 236       /* at least 'Group' has no ops */
 237       if (!type->ops)
 238         return NULL;
 239
 240       /* the custom objects needs extra_data */
 241       obj = type->ops->create(&startpoint,
 242                               type->default_user_data,
 243                               &handle1,&handle2);
 244       if (obj)
 245         g_hash_table_insert (defaults_hash, obj->type->name, obj);
 246     }
 247
 248   return obj;
 249 }
 250
 251 /**
 252  * dia_object_default_create:
 253  * @type : the objects type
 254  * @startpoint : the left upper corner
 255  * @user_data :
 256  * @handle1 :
 257  * @handle2 :
 258  *
 259  * Create an object respecting defaults if available
 260  */
 261 Object *
 262 dia_object_default_create (const ObjectType *type,
 263                            Point *startpoint,
 264                            void *user_data,
 265                            Handle **handle1,
 266                            Handle **handle2)
 267 {
 268   const Object *def_obj;
 269   Object *obj;
 270
 271   g_return_val_if_fail (type != NULL, NULL);
 272
 273   def_obj = dia_object_default_get (type);
 274   if (def_obj)
 275     {
 276       /* copy properties to new object, but keep position */
 277       obj = type->ops->create (startpoint, user_data, handle1, handle2);
 278       if (obj)
 279         {
 280           object_copy_props (obj, def_obj, TRUE);
 281           obj->ops->move (obj, startpoint);
 282         }
 283     }
 284   else
 285     {
 286       obj = type->ops->create (startpoint, user_data, handle1, handle2);
 287     }
 288
 289   return obj;
 290 }
 291
 292 typedef struct _MyLayerInfo MyLayerInfo;
 293 struct _MyLayerInfo
 294 {
 295   Point      pos;
 296   xmlNodePtr node;
 297 };
 298
 299 typedef struct _MyRootInfo MyRootInfo;
 300 struct _MyRootInfo
 301 {
 302   xmlNodePtr  node;
 303   gchar      *filename;
 304   GHashTable *layer_hash;
 305   xmlNs      *name_space;
 306   gint        obj_nr;
 307 };
 308
 309 static void
 310 _obj_store (gpointer key,
 311             gpointer value,
 312             gpointer user_data)
 313 {
 314   gchar *name = (gchar *)key;
 315   Object *obj = (Object *)value;
 316   MyRootInfo *ri = (MyRootInfo *)user_data;
 317   ObjectNode obj_node;
 318   gchar *layer_name;
 319   gchar buffer[31];
 320   gchar *p;
 321   MyLayerInfo *li;
 322
 323   /* fires if you have messed up the hash keys,
 324    * e.g. by using non permanent memory */
 325   g_assert (0 == strcmp (obj->type->name, name));
 326
 327   p = strstr (name, " - ");
 328   if (p)
 329     layer_name = g_strndup (name, p - name);
 330   else
 331     layer_name = g_strdup ("default");
 332
 333   li = g_hash_table_lookup (ri->layer_hash, layer_name);
 334   if (!li)
 335     {
 336       li = g_new (MyLayerInfo, 1);
 337       li->node = xmlNewChild(ri->node, ri->name_space, "layer", NULL);
 338       xmlSetProp(li->node, "name", layer_name);
 339       xmlSetProp(li->node, "visible", "false");
 340       li->pos.x = li->pos.y = 0.0;
 341       g_hash_table_insert (ri->layer_hash, layer_name, li);
 342     }
 343
 344   obj_node = xmlNewChild(li->node, NULL, "object", NULL);
 345   xmlSetProp(obj_node, "type", obj->type->name);
 346
 347   g_snprintf(buffer, 30, "%d", obj->type->version);
 348   xmlSetProp(obj_node, "version", buffer);
 349
 350   g_snprintf(buffer, 30, "O%d", ri->obj_nr++);
 351   xmlSetProp(obj_node, "id", buffer);
 352
 353   obj->ops->move (obj,&(li->pos));
 354   obj->type->ops->save (obj, obj_node, ri->filename);
 355   /* arrange following objects below */
 356   li->pos.y += (obj->bounding_box.bottom - obj->bounding_box.top + 1.0);
 357
 358   g_free (layer_name);
 359 }
 360
 361 /**
 362  * dia_object_defaults_save:
 363  *
 364  * Saves all the currently created default objects into a
 365  * valid diagram file. All the objects are placed into
 366  * separate invisible layers.
 367  */
 368 gboolean
 369 dia_object_defaults_save (const gchar *filename)
 370 {
 371   MyRootInfo ni;
 372   xmlDocPtr doc;
 373   gboolean ret;
 374   gchar *real_filename;
 375   int old_blanks_default = pretty_formated_xml;
 376
 377   /* FIXME HACK: we always want nice readable default files,
 378    *  but toggling it by a global var is ugly   --hb
 379    */
 380   pretty_formated_xml = TRUE;
 381
 382   if (!filename)
 383     real_filename = dia_config_filename("defaults.dia");
 384   else
 385     real_filename = g_strdup (filename);
 386
 387   doc = xmlNewDoc("1.0");
 388   doc->encoding = xmlStrdup("UTF-8");
 389   doc->xmlRootNode = xmlNewDocNode(doc, NULL, "diagram", NULL);
 390
 391   ni.name_space = xmlNewNs(doc->xmlRootNode,
 392                            "http://www.lysator.liu.se/~alla/dia/",
 393                            "dia");
 394   xmlSetNs(doc->xmlRootNode, ni.name_space);
 395
 396   ni.obj_nr = 0;
 397   ni.node = doc->xmlRootNode;
 398   ni.filename = real_filename;
 399   ni.layer_hash = g_hash_table_new_full (g_str_hash, g_str_equal,
 400                                          NULL, g_free);
 401
 402   g_hash_table_foreach (defaults_hash, _obj_store, &ni);
 403
 404   ret = xmlDiaSaveFile (real_filename, doc);
 405   g_free (real_filename);
 406   xmlFreeDoc(doc);
 407   pretty_formated_xml = old_blanks_default;
 408
 409   g_hash_table_destroy (ni.layer_hash);
 410
 411   return ret;
 412 }