src/vikwaypoint.c

   1 /*
   2  * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
   3  *
   4  * Copyright (C) 2003-2005, Evan Battaglia <gtoevan@gmx.net>
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, write to the Free Software
  18  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  */
  21
  22 #include <glib.h>
  23 #include <string.h>
  24 #include "coords.h"
  25 #include "vikcoord.h"
  26 #include "vikwaypoint.h"
  27 #include "globals.h"
  28 #include <glib/gi18n.h>
  29
  30 VikWaypoint *vik_waypoint_new()
  31 {
  32   VikWaypoint *wp = g_malloc0 ( sizeof ( VikWaypoint ) );
  33   wp->altitude = VIK_DEFAULT_ALTITUDE;
  34   wp->name = g_strdup(_("Waypoint"));
  35   return wp;
  36 }
  37
  38 // Hmmm tempted to put in new constructor
  39 void vik_waypoint_set_name(VikWaypoint *wp, const gchar *name)
  40 {
  41   if ( wp->name )
  42     g_free ( wp->name );
  43
  44   if ( name && name[0] != '\0' )
  45     wp->name = g_strdup(name);
  46   else
  47     wp->name = NULL;
  48 }
  49
  50 void vik_waypoint_set_comment_no_copy(VikWaypoint *wp, gchar *comment)
  51 {
  52   if ( wp->comment )
  53     g_free ( wp->comment );
  54   wp->comment = comment;
  55 }
  56
  57 void vik_waypoint_set_comment(VikWaypoint *wp, const gchar *comment)
  58 {
  59   if ( wp->comment )
  60     g_free ( wp->comment );
  61
  62   if ( comment && comment[0] != '\0' )
  63     wp->comment = g_strdup(comment);
  64   else
  65     wp->comment = NULL;
  66 }
  67
  68 void vik_waypoint_set_description(VikWaypoint *wp, const gchar *description)
  69 {
  70   if ( wp->description )
  71     g_free ( wp->description );
  72
  73   if ( description && description[0] != '\0' )
  74     wp->description = g_strdup(description);
  75   else
  76     wp->description = NULL;
  77 }
  78
  79 void vik_waypoint_set_image(VikWaypoint *wp, const gchar *image)
  80 {
  81   if ( wp->image )
  82     g_free ( wp->image );
  83
  84   if ( image && image[0] != '\0' )
  85     wp->image = g_strdup(image);
  86   else
  87     wp->image = NULL;
  88   // NOTE - ATM the image (thumbnail) size is calculated on demand when needed to be first drawn
  89 }
  90
  91 void vik_waypoint_set_symbol(VikWaypoint *wp, const gchar *symname)
  92 {
  93   if ( wp->symbol )
  94     g_free ( wp->symbol );
  95
  96   if ( symname && symname[0] != '\0' )
  97     wp->symbol = g_strdup(symname);
  98   else
  99     wp->symbol = NULL;
 100 }
 101
 102 void vik_waypoint_free(VikWaypoint *wp)
 103 {
 104   if ( wp->comment )
 105     g_free ( wp->comment );
 106   if ( wp->description )
 107     g_free ( wp->description );
 108   if ( wp->image )
 109     g_free ( wp->image );
 110   if ( wp->symbol )
 111     g_free ( wp->symbol );
 112   g_free ( wp );
 113 }
 114
 115 VikWaypoint *vik_waypoint_copy(const VikWaypoint *wp)
 116 {
 117   VikWaypoint *new_wp = vik_waypoint_new();
 118   new_wp->coord = wp->coord;
 119   new_wp->visible = wp->visible;
 120   new_wp->altitude = wp->altitude;
 121   vik_waypoint_set_name(new_wp,wp->name);
 122   vik_waypoint_set_comment(new_wp,wp->comment);
 123   vik_waypoint_set_description(new_wp,wp->description);
 124   vik_waypoint_set_image(new_wp,wp->image);
 125   vik_waypoint_set_symbol(new_wp,wp->symbol);
 126   return new_wp;
 127 }
 128
 129 /*
 130  * Take a Waypoint and convert it into a byte array
 131  */
 132 void vik_waypoint_marshall ( VikWaypoint *wp, guint8 **data, guint *datalen)
 133 {
 134   GByteArray *b = g_byte_array_new();
 135   guint len;
 136
 137   // This creates space for fixed sized members like gints and whatnot
 138   //  and copies that amount of data from the waypoint to byte array
 139   g_byte_array_append(b, (guint8 *)wp, sizeof(*wp));
 140
 141   // This allocates space for variant sized strings
 142   //  and copies that amount of data from the waypoint to byte array
 143 #define vwm_append(s) \
 144   len = (s) ? strlen(s)+1 : 0; \
 145   g_byte_array_append(b, (guint8 *)&len, sizeof(len)); \
 146   if (s) g_byte_array_append(b, (guint8 *)s, len);
 147
 148   vwm_append(wp->name);
 149   vwm_append(wp->comment);
 150   vwm_append(wp->description);
 151   vwm_append(wp->image);
 152   vwm_append(wp->symbol);
 153
 154   *data = b->data;
 155   *datalen = b->len;
 156   g_byte_array_free(b, FALSE);
 157 #undef vwm_append
 158 }
 159
 160 /*
 161  * Take a byte array and convert it into a Waypoint
 162  */
 163 VikWaypoint *vik_waypoint_unmarshall (guint8 *data, guint datalen)
 164 {
 165   guint len;
 166   VikWaypoint *new_wp = vik_waypoint_new();
 167   // This copies the fixed sized elements (i.e. visibility, altitude, image_width, etc...)
 168   memcpy(new_wp, data, sizeof(*new_wp));
 169   data += sizeof(*new_wp);
 170
 171   // Now the variant sized strings...
 172 #define vwu_get(s) \
 173   len = *(guint *)data; \
 174   data += sizeof(len); \
 175   if (len) { \
 176     (s) = g_strdup((gchar *)data); \
 177   } else { \
 178     (s) = NULL; \
 179   } \
 180   data += len;
 181
 182   vwu_get(new_wp->name);
 183   vwu_get(new_wp->comment);
 184   vwu_get(new_wp->description);
 185   vwu_get(new_wp->image);
 186   vwu_get(new_wp->symbol);
 187
 188   return new_wp;
 189 #undef vwu_get
 190 }
 191