]>
Commit | Line | Data |
---|---|---|
1d1bc3c1 EB |
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 | #ifndef _VIKING_ACQUIRE_H | |
23 | #define _VIKING_ACQUIRE_H | |
24 | ||
a25c4c50 GB |
25 | #include <gtk/gtk.h> |
26 | ||
27 | #include "vikwindow.h" | |
28 | #include "viklayerspanel.h" | |
29 | #include "vikviewport.h" | |
0944940f | 30 | #include "babel.h" |
a25c4c50 | 31 | |
cf697cc2 EB |
32 | typedef struct _VikDataSourceInterface VikDataSourceInterface; |
33 | ||
7b3479e3 EB |
34 | /* global data structure used to expose the progress dialog to the worker thread */ |
35 | typedef struct { | |
36 | GtkWidget *status; | |
37 | VikWindow *vw; | |
38 | VikLayersPanel *vlp; | |
39 | VikViewport *vvp; | |
40 | GtkWidget *dialog; | |
41 | gboolean ok; /* if OK is false when we exit, we MUST free w */ | |
62ddf770 | 42 | VikDataSourceInterface *source_interface; |
65f0ccab | 43 | gpointer user_data; |
7b3479e3 EB |
44 | } acq_dialog_widgets_t; |
45 | ||
0944940f | 46 | /* Direct, URL & Shell types process the results with GPSBabel to create tracks/waypoint */ |
28c82d8b EB |
47 | typedef enum { |
48 | VIK_DATASOURCE_GPSBABEL_DIRECT, | |
533bbf34 | 49 | VIK_DATASOURCE_URL, |
0944940f RN |
50 | VIK_DATASOURCE_SHELL_CMD, |
51 | VIK_DATASOURCE_INTERNAL | |
28c82d8b EB |
52 | } vik_datasource_type_t; |
53 | ||
54 | typedef enum { | |
55 | VIK_DATASOURCE_CREATENEWLAYER, | |
56 | VIK_DATASOURCE_ADDTOLAYER | |
57 | } vik_datasource_mode_t; | |
58 | /* TODO: replace track/layer? */ | |
59 | ||
60 | typedef enum { | |
61 | VIK_DATASOURCE_INPUTTYPE_NONE = 0, | |
62 | VIK_DATASOURCE_INPUTTYPE_TRWLAYER, | |
63 | VIK_DATASOURCE_INPUTTYPE_TRACK, | |
64 | VIK_DATASOURCE_INPUTTYPE_TRWLAYER_TRACK | |
65 | } vik_datasource_inputtype_t; | |
7b3479e3 | 66 | |
65f0ccab AF |
67 | /* returns pointer to state if OK, otherwise NULL */ |
68 | typedef gpointer (*VikDataSourceInitFunc) (); | |
92255687 EB |
69 | |
70 | /* returns NULL if OK, otherwise returns an error message. */ | |
71 | typedef gchar *(*VikDataSourceCheckExistenceFunc) (); | |
72 | ||
65f0ccab AF |
73 | /* Create widgets to show in a setup dialog, set up state via user_data */ |
74 | typedef void (*VikDataSourceAddSetupWidgetsFunc) ( GtkWidget *dialog, VikViewport *vvp, gpointer user_data ); | |
75 | ||
76 | /* if VIK_DATASOURCE_GPSBABEL_DIRECT, babelargs and inputfile. | |
77 | if VIK_DATASOURCE_SHELL_CMD, shellcmd and inputtype. | |
533bbf34 | 78 | if VIK_DATASOURCE_URL, url and inputtype. |
65f0ccab AF |
79 | set both to NULL to signal refusal (ie already downloading) */ |
80 | typedef void (*VikDataSourceGetCmdStringFunc) ( gpointer user_data, gchar **babelargs_or_shellcmd, gchar **inputfile_or_inputtype ); | |
81 | ||
28c82d8b EB |
82 | typedef void (*VikDataSourceGetCmdStringFuncWithInput) ( gpointer user_data, gchar **babelargs_or_shellcmd, gchar **inputfile_or_inputtype, const gchar *input_file_name ); |
83 | typedef void (*VikDataSourceGetCmdStringFuncWithInputInput) ( gpointer user_data, gchar **babelargs_or_shellcmd, gchar **inputfile_or_inputtype, const gchar *input_file_name, const gchar *input_track_file_name ); | |
84 | ||
0944940f RN |
85 | /* The actual function to do stuff - must report success/failure */ |
86 | typedef gboolean (*VikDataSourceProcessFunc) ( gpointer vtl, const gchar *cmd, const gchar *extra, BabelStatusFunc status_cb, acq_dialog_widgets_t *adw ); | |
87 | ||
65f0ccab | 88 | /* */ |
7b3479e3 | 89 | typedef void (*VikDataSourceProgressFunc) (gpointer c, gpointer data, acq_dialog_widgets_t *w); |
65f0ccab AF |
90 | |
91 | /* Creates widgets to show in a progress dialog, may set up state via user_data */ | |
92 | typedef void (*VikDataSourceAddProgressWidgetsFunc) ( GtkWidget *dialog, gpointer user_data ); | |
93 | ||
94 | /* Frees any widgets created for the setup or progress dialogs, any allocated state, etc. */ | |
95 | typedef void (*VikDataSourceCleanupFunc) ( gpointer user_data ); | |
96 | ||
2b756ea0 | 97 | typedef void (*VikDataSourceOffFunc) ( gpointer user_data, gchar **babelargs_or_shellcmd, gchar **inputfile_or_inputtype );; |
7b3479e3 | 98 | |
cf697cc2 | 99 | struct _VikDataSourceInterface { |
a8d46e0b | 100 | const gchar *window_title; |
7b3479e3 EB |
101 | const gchar *layer_title; |
102 | vik_datasource_type_t type; | |
28c82d8b EB |
103 | vik_datasource_mode_t mode; |
104 | vik_datasource_inputtype_t inputtype; | |
d2525524 | 105 | gboolean autoview; |
28c82d8b EB |
106 | gboolean keep_dialog_open; /* when done */ |
107 | ||
7b3479e3 | 108 | |
28c82d8b | 109 | /*** Manual UI Building ***/ |
65f0ccab AF |
110 | VikDataSourceInitFunc init_func; |
111 | VikDataSourceCheckExistenceFunc check_existence_func; | |
112 | VikDataSourceAddSetupWidgetsFunc add_setup_widgets_func; | |
28c82d8b EB |
113 | /*** ***/ |
114 | ||
115 | /* or VikDataSourceGetCmdStringFuncWithInput, if inputtype is not NONE */ | |
65f0ccab | 116 | VikDataSourceGetCmdStringFunc get_cmd_string_func; |
7b3479e3 | 117 | |
0944940f RN |
118 | VikDataSourceProcessFunc process_func; |
119 | ||
7b3479e3 EB |
120 | VikDataSourceProgressFunc progress_func; |
121 | VikDataSourceAddProgressWidgetsFunc add_progress_widgets_func; | |
122 | VikDataSourceCleanupFunc cleanup_func; | |
2b756ea0 | 123 | VikDataSourceOffFunc off_func; |
28c82d8b EB |
124 | |
125 | /*** UI Building ***/ | |
126 | VikLayerParam * params; | |
127 | guint16 params_count; | |
128 | VikLayerParamData * params_defaults; | |
129 | gchar ** params_groups; | |
130 | guint8 params_groups_count; | |
131 | ||
cf697cc2 | 132 | }; |
7b3479e3 | 133 | |
28c82d8b EB |
134 | /**********************************/ |
135 | /**********************************/ | |
136 | /**********************************/ | |
7b3479e3 | 137 | |
28c82d8b | 138 | /* for sources with no input data */ |
62ddf770 | 139 | void a_acquire ( VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikDataSourceInterface *source_interface ); |
1d1bc3c1 | 140 | |
28c82d8b EB |
141 | /* Create a sub menu intended for rightclicking on a TRWLayer. menu called "Filter" |
142 | * returns NULL if no filters */ | |
143 | GtkWidget *a_acquire_trwlayer_menu (VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikTrwLayer *vtl); | |
144 | ||
145 | /* Create a sub menu intended for rightclicking on a TRWLayer. menu called "Filter with Track "TRACKNAME"..." | |
146 | * returns NULL if no filters or no filter track has been set | |
147 | */ | |
148 | GtkWidget *a_acquire_trwlayer_track_menu (VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikTrwLayer *vtl); | |
149 | ||
150 | /* Create a sub menu intended for rightclicking on a track. menu called "Filter" | |
151 | * returns NULL if no applicable filters */ | |
152 | GtkWidget *a_acquire_track_menu (VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikTrack *tr); | |
153 | ||
154 | /* sets aplication-wide track to use with filter. references the track. */ | |
155 | void a_acquire_set_filter_track ( VikTrack *tr, const gchar *name ); | |
156 | ||
157 | ||
1d1bc3c1 | 158 | #endif |