src/globals.h

   1 /*
   2  * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
   3  *
   4  * Copyright (C) 2003-2005, Evan Battaglia <gtoevan@gmx.net>
   5  * Copyright (C) 2013, Rob Norris <rw_norris@hotmail.com>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, write to the Free Software
  19  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  20  *
  21  */
  22
  23 #ifndef __VIKING_GLOBALS_H
  24 #define __VIKING_GLOBALS_H
  25
  26 #include <glib.h>
  27
  28 G_BEGIN_DECLS
  29
  30 #define PROJECT "Viking"
  31 #define VIKING_VERSION PACKAGE_VERSION
  32 #define VIKING_VERSION_NAME "This Name For Rent"
  33 #define VIKING_URL PACKAGE_URL
  34
  35 #define ALTI_TO_MPP 1.4017295
  36
  37 #define VIK_FEET_IN_METER 3.2808399
  38 #define VIK_METERS_TO_FEET(X) ((X)*VIK_FEET_IN_METER)
  39 #define VIK_FEET_TO_METERS(X) ((X)/VIK_FEET_IN_METER)
  40
  41 #define VIK_MILES_IN_METER 0.000621371192
  42 #define VIK_METERS_TO_MILES(X) ((X)*VIK_MILES_IN_METER)
  43 #define VIK_MILES_TO_METERS(X) ((X)/VIK_MILES_IN_METER)
  44
  45 #define VIK_NAUTICAL_MILES_IN_METER 0.000539957
  46 #define VIK_METERS_TO_NAUTICAL_MILES(X) ((X)*VIK_NAUTICAL_MILES_IN_METER)
  47 #define VIK_NAUTICAL_MILES_TO_METERS(X) ((X)/VIK_NAUTICAL_MILES_IN_METER)
  48
  49 /* MPS - Metres Per Second */
  50 /* MPH - Metres Per Hour */
  51 #define VIK_MPH_IN_MPS 2.23693629
  52 #define VIK_MPS_TO_MPH(X) ((X)*VIK_MPH_IN_MPS)
  53 #define VIK_MPH_TO_MPS(X) ((X)/VIK_MPH_IN_MPS)
  54
  55 /* KPH - Kilometres Per Hour */
  56 #define VIK_KPH_IN_MPS 3.6
  57 #define VIK_MPS_TO_KPH(X) ((X)*VIK_KPH_IN_MPS)
  58 #define VIK_KPH_TO_MPS(X) ((X)/VIK_KPH_IN_MPS)
  59
  60 #define VIK_KNOTS_IN_MPS 1.94384449
  61 #define VIK_MPS_TO_KNOTS(X) ((X)*VIK_KNOTS_IN_MPS)
  62 #define VIK_KNOTS_TO_MPS(X) ((X)/VIK_KNOTS_IN_MPS)
  63
  64 #define VIK_DEFAULT_ALTITUDE 0.0
  65 #define VIK_DEFAULT_DOP 0.0
  66
  67 #define VIK_GTK_WINDOW_FROM_WIDGET(x) GTK_WINDOW(gtk_widget_get_toplevel(GTK_WIDGET(x)))
  68 #define VIK_GTK_WINDOW_FROM_LAYER(x) VIK_GTK_WINDOW_FROM_WIDGET(VIK_LAYER(x)->vt)
  69
  70 #define DEG2RAD(x) ((x)*(M_PI/180))
  71 #define RAD2DEG(x) ((x)*(180/M_PI))
  72
  73 /* mercator projection, latitude conversion (degrees) */
  74 #define MERCLAT(x) (RAD2DEG(log(tan((0.25 * M_PI) + (0.5 * DEG2RAD(x))))))
  75 #define DEMERCLAT(x) (RAD2DEG(atan(sinh(DEG2RAD(x)))))
  76
  77 /* Some command line options */
  78 extern gboolean vik_debug;
  79 extern gboolean vik_verbose;
  80 extern gboolean vik_version;
  81
  82 /* Allow comparing versions */
  83 gint viking_version_to_number ( gchar *version );
  84
  85 /* Very first run */
  86 gboolean a_vik_very_first_run ();
  87
  88 /* Global preferences */
  89 void a_vik_preferences_init ();
  90
  91 /* Coord display preferences */
  92 typedef enum {
  93   VIK_DEGREE_FORMAT_DDD,
  94   VIK_DEGREE_FORMAT_DMM,
  95   VIK_DEGREE_FORMAT_DMS,
  96   VIK_DEGREE_FORMAT_RAW,
  97 } vik_degree_format_t;
  98
  99 vik_degree_format_t a_vik_get_degree_format ( );
 100
 101 /* Distance preferences */
 102 typedef enum {
 103   VIK_UNITS_DISTANCE_KILOMETRES,
 104   VIK_UNITS_DISTANCE_MILES,
 105   VIK_UNITS_DISTANCE_NAUTICAL_MILES,
 106 } vik_units_distance_t;
 107
 108 vik_units_distance_t a_vik_get_units_distance ( );
 109
 110 /* Speed preferences */
 111 typedef enum {
 112   VIK_UNITS_SPEED_KILOMETRES_PER_HOUR,
 113   VIK_UNITS_SPEED_MILES_PER_HOUR,
 114   VIK_UNITS_SPEED_METRES_PER_SECOND,
 115   VIK_UNITS_SPEED_KNOTS,
 116 } vik_units_speed_t;
 117
 118 vik_units_speed_t a_vik_get_units_speed ( );
 119
 120 /* Height (Depth) preferences */
 121 typedef enum {
 122   VIK_UNITS_HEIGHT_METRES,
 123   VIK_UNITS_HEIGHT_FEET,
 124 } vik_units_height_t;
 125
 126 vik_units_height_t a_vik_get_units_height ( );
 127
 128 gboolean a_vik_get_use_large_waypoint_icons ( );
 129
 130 /* Location preferences */
 131 typedef enum {
 132   VIK_LOCATION_LAT,
 133   VIK_LOCATION_LONG,
 134 } vik_location_t;
 135
 136 gdouble a_vik_get_default_lat ( );
 137 gdouble a_vik_get_default_long ( );
 138
 139 // Time display format
 140 typedef enum {
 141   VIK_TIME_REF_LOCALE, // User's locale
 142   VIK_TIME_REF_WORLD,  // Derive the local timezone at the object's position
 143   VIK_TIME_REF_UTC,
 144 } vik_time_ref_frame_t;
 145
 146 vik_time_ref_frame_t a_vik_get_time_ref_frame ( );
 147
 148 /* KML export preferences */
 149 typedef enum {
 150   VIK_KML_EXPORT_UNITS_METRIC,
 151   VIK_KML_EXPORT_UNITS_STATUTE,
 152   VIK_KML_EXPORT_UNITS_NAUTICAL,
 153 } vik_kml_export_units_t;
 154
 155 vik_kml_export_units_t a_vik_get_kml_export_units ( );
 156
 157 typedef enum {
 158   VIK_GPX_EXPORT_TRK_SORT_ALPHA,
 159   VIK_GPX_EXPORT_TRK_SORT_TIME,
 160   VIK_GPX_EXPORT_TRK_SORT_CREATION,
 161 } vik_gpx_export_trk_sort_t;
 162
 163 vik_gpx_export_trk_sort_t a_vik_get_gpx_export_trk_sort ( );
 164
 165 typedef enum {
 166   VIK_GPX_EXPORT_WPT_SYM_NAME_TITLECASE,
 167   VIK_GPX_EXPORT_WPT_SYM_NAME_LOWERCASE,
 168 } vik_gpx_export_wpt_sym_name_t;
 169
 170 vik_gpx_export_wpt_sym_name_t a_vik_gpx_export_wpt_sym_name ( );
 171
 172 #ifndef WINDOWS
 173 /* Windows automatically uses the system defined viewer
 174    ATM for other systems need to specify the program to use */
 175 const gchar* a_vik_get_image_viewer ( );
 176 #endif
 177
 178 const gchar* a_vik_get_external_gpx_program_1 ( );
 179
 180 const gchar* a_vik_get_external_gpx_program_2 ( );
 181
 182 /* File reference preferences - mainly in saving of a viking file */
 183 typedef enum {
 184   VIK_FILE_REF_FORMAT_ABSOLUTE,
 185   VIK_FILE_REF_FORMAT_RELATIVE,
 186 } vik_file_ref_format_t;
 187
 188 vik_file_ref_format_t a_vik_get_file_ref_format ( );
 189
 190 gboolean a_vik_get_ask_for_create_track_name ( );
 191
 192 gboolean a_vik_get_create_track_tooltip ( );
 193
 194 gboolean a_vik_get_restore_window_state ( );
 195
 196 gboolean a_vik_get_add_default_map_layer ( );
 197
 198 typedef enum {
 199   VIK_STARTUP_METHOD_HOME_LOCATION,
 200   VIK_STARTUP_METHOD_LAST_LOCATION,
 201   VIK_STARTUP_METHOD_SPECIFIED_FILE,
 202   VIK_STARTUP_METHOD_AUTO_LOCATION,
 203 } vik_startup_method_t;
 204
 205 vik_startup_method_t a_vik_get_startup_method ( );
 206
 207 const gchar *a_vik_get_startup_file ( );
 208
 209 gboolean a_vik_get_check_version ( );
 210
 211 gint a_vik_get_recent_number_files ( );
 212
 213 /* Group for global preferences */
 214 #define VIKING_PREFERENCES_GROUP_KEY "viking.globals"
 215 #define VIKING_PREFERENCES_NAMESPACE "viking.globals."
 216
 217 /* Another group of global preferences,
 218   but in a separate section to try to keep things organized */
 219 /* AKA Export/External Prefs */
 220 #define VIKING_PREFERENCES_IO_GROUP_KEY "viking.io"
 221 #define VIKING_PREFERENCES_IO_NAMESPACE "viking.io."
 222
 223 /* Group for global preferences - but 'advanced'
 224    User changeable but only for those that need it */
 225 #define VIKING_PREFERENCES_ADVANCED_GROUP_KEY "viking.advanced"
 226 #define VIKING_PREFERENCES_ADVANCED_NAMESPACE "viking.advanced."
 227
 228 #define VIKING_PREFERENCES_STARTUP_GROUP_KEY "viking.startup"
 229 #define VIKING_PREFERENCES_STARTUP_NAMESPACE "viking.startup."
 230
 231 // Additions to 'Stock Icons'
 232 #define VIK_ICON_SHOW_PICTURE "vik-icon-Show Picture"
 233
 234 G_END_DECLS
 235
 236 #endif