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 #define MPP_TO_ALTI 0.7134044
  37
  38 #define VIK_FEET_IN_METER 3.2808399
  39 #define VIK_METERS_TO_FEET(X) ((X)*VIK_FEET_IN_METER)
  40 #define VIK_FEET_TO_METERS(X) ((X)/VIK_FEET_IN_METER)
  41
  42 #define VIK_MILES_IN_METER 0.000621371192
  43 #define VIK_METERS_TO_MILES(X) ((X)*VIK_MILES_IN_METER)
  44 #define VIK_MILES_TO_METERS(X) ((X)/VIK_MILES_IN_METER)
  45
  46 /* MPS - Metres Per Second */
  47 /* MPH - Metres Per Hour */
  48 #define VIK_MPH_IN_MPS 2.23693629
  49 #define VIK_MPS_TO_MPH(X) ((X)*VIK_MPH_IN_MPS)
  50 #define VIK_MPH_TO_MPS(X) ((X)/VIK_MPH_IN_MPS)
  51
  52 /* KPH - Kilometres Per Hour */
  53 #define VIK_KPH_IN_MPS 3.6
  54 #define VIK_MPS_TO_KPH(X) ((X)*VIK_KPH_IN_MPS)
  55 #define VIK_KPH_TO_MPS(X) ((X)/VIK_KPH_IN_MPS)
  56
  57 #define VIK_KNOTS_IN_MPS 1.94384449
  58 #define VIK_MPS_TO_KNOTS(X) ((X)*VIK_KNOTS_IN_MPS)
  59 #define VIK_KNOTS_TO_MPS(X) ((X)/VIK_KNOTS_IN_MPS)
  60
  61 #define VIK_DEFAULT_ALTITUDE 0.0
  62 #define VIK_DEFAULT_DOP 0.0
  63
  64 #define VIK_GTK_WINDOW_FROM_WIDGET(x) GTK_WINDOW(gtk_widget_get_toplevel(GTK_WIDGET(x)))
  65 #define VIK_GTK_WINDOW_FROM_LAYER(x) VIK_GTK_WINDOW_FROM_WIDGET(VIK_LAYER(x)->vt)
  66
  67 #define DEG2RAD(x) ((x)*(M_PI/180))
  68 #define RAD2DEG(x) ((x)*(180/M_PI))
  69
  70 /* mercator projection, latitude conversion (degrees) */
  71 #define MERCLAT(x) (RAD2DEG(log(tan((0.25 * M_PI) + (0.5 * DEG2RAD(x))))))
  72 #define DEMERCLAT(x) (RAD2DEG(atan(sinh(DEG2RAD(x)))))
  73
  74 /* Some command line options */
  75 extern gboolean vik_debug;
  76 extern gboolean vik_verbose;
  77 extern gboolean vik_version;
  78
  79 /* Allow comparing versions */
  80 gint viking_version_to_number ( gchar *version );
  81
  82 /* Very first run */
  83 gboolean a_vik_very_first_run ();
  84
  85 /* Global preferences */
  86 void a_vik_preferences_init ();
  87
  88 /* Coord display preferences */
  89 typedef enum {
  90   VIK_DEGREE_FORMAT_DDD,
  91   VIK_DEGREE_FORMAT_DMM,
  92   VIK_DEGREE_FORMAT_DMS,
  93   VIK_DEGREE_FORMAT_RAW,
  94 } vik_degree_format_t;
  95
  96 vik_degree_format_t a_vik_get_degree_format ( );
  97
  98 /* Distance preferences */
  99 typedef enum {
 100   VIK_UNITS_DISTANCE_KILOMETRES,
 101   VIK_UNITS_DISTANCE_MILES,
 102 } vik_units_distance_t;
 103
 104 vik_units_distance_t a_vik_get_units_distance ( );
 105
 106 /* Speed preferences */
 107 typedef enum {
 108   VIK_UNITS_SPEED_KILOMETRES_PER_HOUR,
 109   VIK_UNITS_SPEED_MILES_PER_HOUR,
 110   VIK_UNITS_SPEED_METRES_PER_SECOND,
 111   VIK_UNITS_SPEED_KNOTS,
 112 } vik_units_speed_t;
 113
 114 vik_units_speed_t a_vik_get_units_speed ( );
 115
 116 /* Height (Depth) preferences */
 117 typedef enum {
 118   VIK_UNITS_HEIGHT_METRES,
 119   VIK_UNITS_HEIGHT_FEET,
 120 } vik_units_height_t;
 121
 122 vik_units_height_t a_vik_get_units_height ( );
 123
 124 gboolean a_vik_get_use_large_waypoint_icons ( );
 125
 126 /* Location preferences */
 127 typedef enum {
 128   VIK_LOCATION_LAT,
 129   VIK_LOCATION_LONG,
 130 } vik_location_t;
 131
 132 gdouble a_vik_get_default_lat ( );
 133 gdouble a_vik_get_default_long ( );
 134
 135 // Time display format
 136 typedef enum {
 137   VIK_TIME_REF_LOCALE, // User's locale
 138   VIK_TIME_REF_WORLD,  // Derive the local timezone at the object's position
 139   VIK_TIME_REF_UTC,
 140 } vik_time_ref_frame_t;
 141
 142 vik_time_ref_frame_t a_vik_get_time_ref_frame ( );
 143
 144 /* KML export preferences */
 145 typedef enum {
 146   VIK_KML_EXPORT_UNITS_METRIC,
 147   VIK_KML_EXPORT_UNITS_STATUTE,
 148   VIK_KML_EXPORT_UNITS_NAUTICAL,
 149 } vik_kml_export_units_t;
 150
 151 vik_kml_export_units_t a_vik_get_kml_export_units ( );
 152
 153 typedef enum {
 154   VIK_GPX_EXPORT_TRK_SORT_ALPHA,
 155   VIK_GPX_EXPORT_TRK_SORT_TIME,
 156   VIK_GPX_EXPORT_TRK_SORT_CREATION,
 157 } vik_gpx_export_trk_sort_t;
 158
 159 vik_gpx_export_trk_sort_t a_vik_get_gpx_export_trk_sort ( );
 160
 161 typedef enum {
 162   VIK_GPX_EXPORT_WPT_SYM_NAME_TITLECASE,
 163   VIK_GPX_EXPORT_WPT_SYM_NAME_LOWERCASE,
 164 } vik_gpx_export_wpt_sym_name_t;
 165
 166 vik_gpx_export_wpt_sym_name_t a_vik_gpx_export_wpt_sym_name ( );
 167
 168 #ifndef WINDOWS
 169 /* Windows automatically uses the system defined viewer
 170    ATM for other systems need to specify the program to use */
 171 const gchar* a_vik_get_image_viewer ( );
 172 #endif
 173
 174 const gchar* a_vik_get_external_gpx_program_1 ( );
 175
 176 const gchar* a_vik_get_external_gpx_program_2 ( );
 177
 178 /* File reference preferences - mainly in saving of a viking file */
 179 typedef enum {
 180   VIK_FILE_REF_FORMAT_ABSOLUTE,
 181   VIK_FILE_REF_FORMAT_RELATIVE,
 182 } vik_file_ref_format_t;
 183
 184 vik_file_ref_format_t a_vik_get_file_ref_format ( );
 185
 186 gboolean a_vik_get_ask_for_create_track_name ( );
 187
 188 gboolean a_vik_get_create_track_tooltip ( );
 189
 190 gboolean a_vik_get_restore_window_state ( );
 191
 192 gboolean a_vik_get_add_default_map_layer ( );
 193
 194 typedef enum {
 195   VIK_STARTUP_METHOD_HOME_LOCATION,
 196   VIK_STARTUP_METHOD_LAST_LOCATION,
 197   VIK_STARTUP_METHOD_SPECIFIED_FILE,
 198   VIK_STARTUP_METHOD_AUTO_LOCATION,
 199 } vik_startup_method_t;
 200
 201 vik_startup_method_t a_vik_get_startup_method ( );
 202
 203 const gchar *a_vik_get_startup_file ( );
 204
 205 gboolean a_vik_get_check_version ( );
 206
 207 gint a_vik_get_recent_number_files ( );
 208
 209 /* Group for global preferences */
 210 #define VIKING_PREFERENCES_GROUP_KEY "viking.globals"
 211 #define VIKING_PREFERENCES_NAMESPACE "viking.globals."
 212
 213 /* Another group of global preferences,
 214   but in a separate section to try to keep things organized */
 215 /* AKA Export/External Prefs */
 216 #define VIKING_PREFERENCES_IO_GROUP_KEY "viking.io"
 217 #define VIKING_PREFERENCES_IO_NAMESPACE "viking.io."
 218
 219 /* Group for global preferences - but 'advanced'
 220    User changeable but only for those that need it */
 221 #define VIKING_PREFERENCES_ADVANCED_GROUP_KEY "viking.advanced"
 222 #define VIKING_PREFERENCES_ADVANCED_NAMESPACE "viking.advanced."
 223
 224 #define VIKING_PREFERENCES_STARTUP_GROUP_KEY "viking.startup"
 225 #define VIKING_PREFERENCES_STARTUP_NAMESPACE "viking.startup."
 226
 227 G_END_DECLS
 228
 229 #endif