2 * viking -- GPS Data and Topo Analyzer, Explorer, and Manager
4 * Copyright (C) 2003-2005, Evan Battaglia <gtoevan@gmx.net>
5 * Copyright (C) 2008, Guilhem Bonnefille <guilhem.bonnefille@gmail.com>
6 * Copyright (C) 2010-2013, Rob Norris <rw_norris@hotmail.com>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
30 #include <glib/gi18n.h>
33 #include "preferences.h"
37 gboolean vik_debug = FALSE;
38 gboolean vik_verbose = FALSE;
39 gboolean vik_version = FALSE;
42 * viking_version_to_number:
43 * @version: The string of the Viking version.
44 * This should be in the form of N.N.N.N, where the 3rd + 4th numbers are optional
45 * Often you'll want to pass in VIKING_VERSION
47 * Returns: a single number useful for comparison
49 gint viking_version_to_number ( gchar *version )
51 // Basic method, probably can be improved
52 gint version_number = 0;
53 gchar** parts = g_strsplit ( version, ".", 0 );
55 gchar *part = parts[part_num];
56 // Allow upto 4 parts to the version number
57 while ( part && part_num < 4 ) {
58 // Allow each part to have upto 100
59 version_number = version_number + ( atol(part) * pow(100, 3-part_num) );
61 part = parts[part_num];
64 return version_number;
67 static gchar * params_degree_formats[] = {"DDD", "DMM", "DMS", N_("Raw"), NULL};
68 static gchar * params_units_distance[] = {N_("Kilometres"), N_("Miles"), N_("Nautical Miles"), NULL};
69 static gchar * params_units_speed[] = {"km/h", "mph", "m/s", "knots", NULL};
70 static gchar * params_units_height[] = {"Metres", "Feet", NULL};
71 static VikLayerParamScale params_scales_lat[] = { {-90.0, 90.0, 0.05, 2} };
72 static VikLayerParamScale params_scales_long[] = { {-180.0, 180.0, 0.05, 2} };
73 static gchar * params_time_ref_frame[] = {N_("Locale"), N_("World"), N_("UTC"), NULL};
75 static VikLayerParam general_prefs[] = {
76 { VIK_LAYER_NUM_TYPES, VIKING_PREFERENCES_NAMESPACE "degree_format", VIK_LAYER_PARAM_UINT, VIK_LAYER_GROUP_NONE, N_("Degree format:"), VIK_LAYER_WIDGET_COMBOBOX, params_degree_formats, NULL, NULL, NULL, NULL, NULL },
77 { VIK_LAYER_NUM_TYPES, VIKING_PREFERENCES_NAMESPACE "units_distance", VIK_LAYER_PARAM_UINT, VIK_LAYER_GROUP_NONE, N_("Distance units:"), VIK_LAYER_WIDGET_COMBOBOX, params_units_distance, NULL, NULL, NULL, NULL, NULL },
78 { VIK_LAYER_NUM_TYPES, VIKING_PREFERENCES_NAMESPACE "units_speed", VIK_LAYER_PARAM_UINT, VIK_LAYER_GROUP_NONE, N_("Speed units:"), VIK_LAYER_WIDGET_COMBOBOX, params_units_speed, NULL, NULL, NULL, NULL, NULL },
79 { VIK_LAYER_NUM_TYPES, VIKING_PREFERENCES_NAMESPACE "units_height", VIK_LAYER_PARAM_UINT, VIK_LAYER_GROUP_NONE, N_("Height units:"), VIK_LAYER_WIDGET_COMBOBOX, params_units_height, NULL, NULL, NULL, NULL, NULL },
80 { VIK_LAYER_NUM_TYPES, VIKING_PREFERENCES_NAMESPACE "use_large_waypoint_icons", VIK_LAYER_PARAM_BOOLEAN, VIK_LAYER_GROUP_NONE, N_("Use large waypoint icons:"), VIK_LAYER_WIDGET_CHECKBUTTON, NULL, NULL, NULL, NULL, NULL, NULL },
81 { VIK_LAYER_NUM_TYPES, VIKING_PREFERENCES_NAMESPACE "default_latitude", VIK_LAYER_PARAM_DOUBLE, VIK_LAYER_GROUP_NONE, N_("Default latitude:"), VIK_LAYER_WIDGET_SPINBUTTON, params_scales_lat, NULL, NULL, NULL, NULL, NULL },
82 { VIK_LAYER_NUM_TYPES, VIKING_PREFERENCES_NAMESPACE "default_longitude", VIK_LAYER_PARAM_DOUBLE, VIK_LAYER_GROUP_NONE, N_("Default longitude:"), VIK_LAYER_WIDGET_SPINBUTTON, params_scales_long, NULL, NULL, NULL, NULL, NULL },
83 { VIK_LAYER_NUM_TYPES, VIKING_PREFERENCES_NAMESPACE "time_reference_frame", VIK_LAYER_PARAM_UINT, VIK_LAYER_GROUP_NONE, N_("Time Display:"), VIK_LAYER_WIDGET_COMBOBOX, params_time_ref_frame, NULL,
84 N_("Display times according to the reference frame. Locale is the user's system setting. World is relative to the location of the object."), NULL, NULL, NULL },
87 /* External/Export Options */
89 static gchar * params_kml_export_units[] = {"Metric", "Statute", "Nautical", NULL};
90 static gchar * params_gpx_export_trk_sort[] = {N_("Alphabetical"), N_("Time"), N_("Creation"), NULL };
91 static gchar * params_gpx_export_wpt_symbols[] = {N_("Title Case"), N_("Lowercase"), NULL};
93 static VikLayerParam io_prefs[] = {
94 { VIK_LAYER_NUM_TYPES, VIKING_PREFERENCES_IO_NAMESPACE "kml_export_units", VIK_LAYER_PARAM_UINT, VIK_LAYER_GROUP_NONE, N_("KML File Export Units:"), VIK_LAYER_WIDGET_COMBOBOX, params_kml_export_units, NULL, NULL, NULL, NULL, NULL },
95 { VIK_LAYER_NUM_TYPES, VIKING_PREFERENCES_IO_NAMESPACE "gpx_export_track_sort", VIK_LAYER_PARAM_UINT, VIK_LAYER_GROUP_NONE, N_("GPX Track Order:"), VIK_LAYER_WIDGET_COMBOBOX, params_gpx_export_trk_sort, NULL, NULL, NULL, NULL, NULL },
96 { VIK_LAYER_NUM_TYPES, VIKING_PREFERENCES_IO_NAMESPACE "gpx_export_wpt_sym_names", VIK_LAYER_PARAM_UINT, VIK_LAYER_GROUP_NONE, N_("GPX Waypoint Symbols:"), VIK_LAYER_WIDGET_COMBOBOX, params_gpx_export_wpt_symbols, NULL,
97 N_("Save GPX Waypoint Symbol names in the specified case. May be useful for compatibility with various devices"), NULL, NULL, NULL },
101 static VikLayerParam io_prefs_non_windows[] = {
102 { VIK_LAYER_NUM_TYPES, VIKING_PREFERENCES_IO_NAMESPACE "image_viewer", VIK_LAYER_PARAM_STRING, VIK_LAYER_GROUP_NONE, N_("Image Viewer:"), VIK_LAYER_WIDGET_FILEENTRY, NULL, NULL, NULL, NULL, NULL, NULL },
106 static VikLayerParam io_prefs_external_gpx[] = {
107 { VIK_LAYER_NUM_TYPES, VIKING_PREFERENCES_IO_NAMESPACE "external_gpx_1", VIK_LAYER_PARAM_STRING, VIK_LAYER_GROUP_NONE, N_("External GPX Program 1:"), VIK_LAYER_WIDGET_FILEENTRY, NULL, NULL, NULL, NULL, NULL, NULL },
108 { VIK_LAYER_NUM_TYPES, VIKING_PREFERENCES_IO_NAMESPACE "external_gpx_2", VIK_LAYER_PARAM_STRING, VIK_LAYER_GROUP_NONE, N_("External GPX Program 2:"), VIK_LAYER_WIDGET_FILEENTRY, NULL, NULL, NULL, NULL, NULL, NULL },
111 static gchar * params_vik_fileref[] = {N_("Absolute"), N_("Relative"), NULL};
112 static VikLayerParamScale params_recent_files[] = { {-1, 25, 1, 0} };
114 static VikLayerParam prefs_advanced[] = {
115 { VIK_LAYER_NUM_TYPES, VIKING_PREFERENCES_ADVANCED_NAMESPACE "save_file_reference_mode", VIK_LAYER_PARAM_UINT, VIK_LAYER_GROUP_NONE, N_("Save File Reference Mode:"), VIK_LAYER_WIDGET_COMBOBOX, params_vik_fileref, NULL,
116 N_("When saving a Viking .vik file, this determines how the directory paths of filenames are written."), NULL, NULL, NULL },
117 { VIK_LAYER_NUM_TYPES, VIKING_PREFERENCES_ADVANCED_NAMESPACE "ask_for_create_track_name", VIK_LAYER_PARAM_BOOLEAN, VIK_LAYER_GROUP_NONE, N_("Ask for Name before Track Creation:"), VIK_LAYER_WIDGET_CHECKBUTTON, NULL, NULL, NULL, NULL, NULL, NULL },
118 { VIK_LAYER_NUM_TYPES, VIKING_PREFERENCES_ADVANCED_NAMESPACE "create_track_tooltip", VIK_LAYER_PARAM_BOOLEAN, VIK_LAYER_GROUP_NONE, N_("Show Tooltip during Track Creation:"), VIK_LAYER_WIDGET_CHECKBUTTON, NULL, NULL, NULL, NULL, NULL, NULL },
119 { VIK_LAYER_NUM_TYPES, VIKING_PREFERENCES_ADVANCED_NAMESPACE "number_recent_files", VIK_LAYER_PARAM_INT, VIK_LAYER_GROUP_NONE, N_("The number of recent files:"), VIK_LAYER_WIDGET_SPINBUTTON, params_recent_files, NULL,
120 N_("Only applies to new windows or on application restart. -1 means all available files."), NULL, NULL, NULL },
123 static gchar * params_startup_methods[] = {N_("Home Location"), N_("Last Location"), N_("Specified File"), N_("Auto Location"), NULL};
125 static VikLayerParam startup_prefs[] = {
126 { VIK_LAYER_NUM_TYPES, VIKING_PREFERENCES_STARTUP_NAMESPACE "restore_window_state", VIK_LAYER_PARAM_BOOLEAN, VIK_LAYER_GROUP_NONE, N_("Restore Window Setup:"), VIK_LAYER_WIDGET_CHECKBUTTON, NULL, NULL,
127 N_("Restore window size and layout"), NULL, NULL, NULL},
128 { VIK_LAYER_NUM_TYPES, VIKING_PREFERENCES_STARTUP_NAMESPACE "add_default_map_layer", VIK_LAYER_PARAM_BOOLEAN, VIK_LAYER_GROUP_NONE, N_("Add a Default Map Layer:"), VIK_LAYER_WIDGET_CHECKBUTTON, NULL, NULL,
129 N_("The default map layer added is defined by the Layer Defaults. Use the menu Edit->Layer Defaults->Map... to change the map type and other values."), NULL, NULL, NULL},
130 { VIK_LAYER_NUM_TYPES, VIKING_PREFERENCES_STARTUP_NAMESPACE "startup_method", VIK_LAYER_PARAM_UINT, VIK_LAYER_GROUP_NONE, N_("Startup Method:"), VIK_LAYER_WIDGET_COMBOBOX, params_startup_methods, NULL, NULL, NULL, NULL, NULL },
131 { VIK_LAYER_NUM_TYPES, VIKING_PREFERENCES_STARTUP_NAMESPACE "startup_file", VIK_LAYER_PARAM_STRING, VIK_LAYER_GROUP_NONE, N_("Startup File:"), VIK_LAYER_WIDGET_FILEENTRY, NULL, NULL,
132 N_("The default file to load on startup. Only applies when the startup method is set to 'Specified File'"), NULL, NULL, NULL },
133 { VIK_LAYER_NUM_TYPES, VIKING_PREFERENCES_STARTUP_NAMESPACE "check_version", VIK_LAYER_PARAM_BOOLEAN, VIK_LAYER_GROUP_NONE, N_("Check For New Version:"), VIK_LAYER_WIDGET_CHECKBUTTON, NULL, NULL,
134 N_("Periodically check to see if a new version of Viking is available"), NULL, NULL, NULL },
136 /* End of Options static stuff */
139 * Detect when Viking is run for the very first time
140 * Call this very early in the startup sequence to ensure subsequent correct results
141 * The return value is cached, since later on the test will no longer be true
143 gboolean a_vik_very_first_run ()
145 static gboolean vik_very_first_run_known = FALSE;
146 static gboolean vik_very_first_run = FALSE;
148 // use cached result if available
149 if ( vik_very_first_run_known )
150 return vik_very_first_run;
152 gchar *dir = a_get_viking_dir_no_create();
153 // NB: will need extra logic if default dir gets changed e.g. from ~/.viking to ~/.config/viking
155 // If directory exists - Viking has been run before
156 vik_very_first_run = ! g_file_test ( dir, G_FILE_TEST_EXISTS );
160 vik_very_first_run = TRUE;
161 vik_very_first_run_known = TRUE;
163 return vik_very_first_run;
166 void a_vik_preferences_init ()
168 g_debug ( "VIKING VERSION as number: %d", viking_version_to_number (VIKING_VERSION) );
170 // Defaults for the options are setup here
171 a_preferences_register_group ( VIKING_PREFERENCES_GROUP_KEY, _("General") );
173 VikLayerParamData tmp;
174 tmp.u = VIK_DEGREE_FORMAT_DMS;
175 a_preferences_register(&general_prefs[0], tmp, VIKING_PREFERENCES_GROUP_KEY);
177 tmp.u = VIK_UNITS_DISTANCE_KILOMETRES;
178 a_preferences_register(&general_prefs[1], tmp, VIKING_PREFERENCES_GROUP_KEY);
180 tmp.u = VIK_UNITS_SPEED_KILOMETRES_PER_HOUR;
181 a_preferences_register(&general_prefs[2], tmp, VIKING_PREFERENCES_GROUP_KEY);
183 tmp.u = VIK_UNITS_HEIGHT_METRES;
184 a_preferences_register(&general_prefs[3], tmp, VIKING_PREFERENCES_GROUP_KEY);
187 a_preferences_register(&general_prefs[4], tmp, VIKING_PREFERENCES_GROUP_KEY);
189 /* Maintain the default location to New York */
191 a_preferences_register(&general_prefs[5], tmp, VIKING_PREFERENCES_GROUP_KEY);
193 a_preferences_register(&general_prefs[6], tmp, VIKING_PREFERENCES_GROUP_KEY);
195 tmp.u = VIK_TIME_REF_LOCALE;
196 a_preferences_register(&general_prefs[7], tmp, VIKING_PREFERENCES_GROUP_KEY);
199 a_preferences_register_group ( VIKING_PREFERENCES_STARTUP_GROUP_KEY, _("Startup") );
202 a_preferences_register(&startup_prefs[0], tmp, VIKING_PREFERENCES_STARTUP_GROUP_KEY);
205 a_preferences_register(&startup_prefs[1], tmp, VIKING_PREFERENCES_STARTUP_GROUP_KEY);
207 tmp.u = VIK_STARTUP_METHOD_HOME_LOCATION;
208 a_preferences_register(&startup_prefs[2], tmp, VIKING_PREFERENCES_STARTUP_GROUP_KEY);
211 a_preferences_register(&startup_prefs[3], tmp, VIKING_PREFERENCES_STARTUP_GROUP_KEY);
214 a_preferences_register(&startup_prefs[4], tmp, VIKING_PREFERENCES_STARTUP_GROUP_KEY);
217 a_preferences_register_group ( VIKING_PREFERENCES_IO_GROUP_KEY, _("Export/External") );
219 tmp.u = VIK_KML_EXPORT_UNITS_METRIC;
220 a_preferences_register(&io_prefs[0], tmp, VIKING_PREFERENCES_IO_GROUP_KEY);
222 tmp.u = VIK_GPX_EXPORT_TRK_SORT_TIME;
223 a_preferences_register(&io_prefs[1], tmp, VIKING_PREFERENCES_IO_GROUP_KEY);
225 tmp.b = VIK_GPX_EXPORT_WPT_SYM_NAME_TITLECASE;
226 a_preferences_register(&io_prefs[2], tmp, VIKING_PREFERENCES_IO_GROUP_KEY);
230 a_preferences_register(&io_prefs_non_windows[0], tmp, VIKING_PREFERENCES_IO_GROUP_KEY);
233 // JOSM for OSM editing around a GPX track
235 a_preferences_register(&io_prefs_external_gpx[0], tmp, VIKING_PREFERENCES_IO_GROUP_KEY);
236 // Add a second external program - another OSM editor by default
237 tmp.s = "merkaartor";
238 a_preferences_register(&io_prefs_external_gpx[1], tmp, VIKING_PREFERENCES_IO_GROUP_KEY);
240 // 'Advanced' Properties
241 a_preferences_register_group ( VIKING_PREFERENCES_ADVANCED_GROUP_KEY, _("Advanced") );
243 tmp.u = VIK_FILE_REF_FORMAT_ABSOLUTE;
244 a_preferences_register(&prefs_advanced[0], tmp, VIKING_PREFERENCES_ADVANCED_GROUP_KEY);
247 a_preferences_register(&prefs_advanced[1], tmp, VIKING_PREFERENCES_ADVANCED_GROUP_KEY);
250 a_preferences_register(&prefs_advanced[2], tmp, VIKING_PREFERENCES_ADVANCED_GROUP_KEY);
252 tmp.i = 10; // Seemingly GTK's default for the number of recent files
253 a_preferences_register(&prefs_advanced[3], tmp, VIKING_PREFERENCES_ADVANCED_GROUP_KEY);
256 vik_degree_format_t a_vik_get_degree_format ( )
258 vik_degree_format_t format;
259 format = a_preferences_get(VIKING_PREFERENCES_NAMESPACE "degree_format")->u;
263 vik_units_distance_t a_vik_get_units_distance ( )
265 vik_units_distance_t units;
266 units = a_preferences_get(VIKING_PREFERENCES_NAMESPACE "units_distance")->u;
270 vik_units_speed_t a_vik_get_units_speed ( )
272 vik_units_speed_t units;
273 units = a_preferences_get(VIKING_PREFERENCES_NAMESPACE "units_speed")->u;
277 vik_units_height_t a_vik_get_units_height ( )
279 vik_units_height_t units;
280 units = a_preferences_get(VIKING_PREFERENCES_NAMESPACE "units_height")->u;
284 gboolean a_vik_get_use_large_waypoint_icons ( )
286 gboolean use_large_waypoint_icons;
287 use_large_waypoint_icons = a_preferences_get(VIKING_PREFERENCES_NAMESPACE "use_large_waypoint_icons")->b;
288 return use_large_waypoint_icons;
291 gdouble a_vik_get_default_lat ( )
294 data = a_preferences_get(VIKING_PREFERENCES_NAMESPACE "default_latitude")->d;
298 gdouble a_vik_get_default_long ( )
301 data = a_preferences_get(VIKING_PREFERENCES_NAMESPACE "default_longitude")->d;
305 vik_time_ref_frame_t a_vik_get_time_ref_frame ( )
307 return a_preferences_get(VIKING_PREFERENCES_NAMESPACE "time_reference_frame")->u;
310 /* External/Export Options */
312 vik_kml_export_units_t a_vik_get_kml_export_units ( )
314 vik_kml_export_units_t units;
315 units = a_preferences_get(VIKING_PREFERENCES_IO_NAMESPACE "kml_export_units")->u;
319 vik_gpx_export_trk_sort_t a_vik_get_gpx_export_trk_sort ( )
321 vik_gpx_export_trk_sort_t sort;
322 sort = a_preferences_get(VIKING_PREFERENCES_IO_NAMESPACE "gpx_export_track_sort")->u;
326 vik_gpx_export_wpt_sym_name_t a_vik_gpx_export_wpt_sym_name ( )
329 val = a_preferences_get(VIKING_PREFERENCES_IO_NAMESPACE "gpx_export_wpt_sym_names")->b;
334 const gchar* a_vik_get_image_viewer ( )
336 return a_preferences_get(VIKING_PREFERENCES_IO_NAMESPACE "image_viewer")->s;
340 const gchar* a_vik_get_external_gpx_program_1 ( )
342 return a_preferences_get(VIKING_PREFERENCES_IO_NAMESPACE "external_gpx_1")->s;
345 const gchar* a_vik_get_external_gpx_program_2 ( )
347 return a_preferences_get(VIKING_PREFERENCES_IO_NAMESPACE "external_gpx_2")->s;
351 vik_file_ref_format_t a_vik_get_file_ref_format ( )
353 vik_file_ref_format_t format;
354 format = a_preferences_get(VIKING_PREFERENCES_ADVANCED_NAMESPACE "save_file_reference_mode")->u;
358 gboolean a_vik_get_ask_for_create_track_name ( )
360 return a_preferences_get(VIKING_PREFERENCES_ADVANCED_NAMESPACE "ask_for_create_track_name")->b;
363 gboolean a_vik_get_create_track_tooltip ( )
365 return a_preferences_get(VIKING_PREFERENCES_ADVANCED_NAMESPACE "create_track_tooltip")->b;
368 gint a_vik_get_recent_number_files ( )
370 return a_preferences_get(VIKING_PREFERENCES_ADVANCED_NAMESPACE "number_recent_files")->i;
374 gboolean a_vik_get_restore_window_state ( )
377 data = a_preferences_get(VIKING_PREFERENCES_STARTUP_NAMESPACE "restore_window_state")->b;
381 gboolean a_vik_get_add_default_map_layer ( )
384 data = a_preferences_get(VIKING_PREFERENCES_STARTUP_NAMESPACE "add_default_map_layer")->b;
388 vik_startup_method_t a_vik_get_startup_method ( )
390 vik_startup_method_t data;
391 data = a_preferences_get(VIKING_PREFERENCES_STARTUP_NAMESPACE "startup_method")->u;
395 const gchar *a_vik_get_startup_file ( )
397 return a_preferences_get(VIKING_PREFERENCES_STARTUP_NAMESPACE "startup_file")->s;
400 gboolean a_vik_get_check_version ( )
402 return a_preferences_get(VIKING_PREFERENCES_STARTUP_NAMESPACE "check_version")->b;