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