src/acquire.h

   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
  25 #include <gtk/gtk.h>
  26
  27 #include "vikwindow.h"
  28 #include "viklayerspanel.h"
  29 #include "vikviewport.h"
  30 #include "babel.h"
  31
  32 G_BEGIN_DECLS
  33
  34 typedef struct _VikDataSourceInterface VikDataSourceInterface;
  35
  36 /**
  37  * acq_dialog_widgets_t:
  38  *
  39  * global data structure used to expose the progress dialog to the worker thread.
  40  */
  41 typedef struct {
  42   GtkWidget *status;
  43   VikWindow *vw;
  44   VikLayersPanel *vlp;
  45   VikViewport *vvp;
  46   GtkWidget *dialog;
  47   gboolean running;
  48   VikDataSourceInterface *source_interface;
  49   gpointer user_data;
  50 } acq_dialog_widgets_t;
  51
  52 typedef enum {
  53   VIK_DATASOURCE_CREATENEWLAYER,
  54   VIK_DATASOURCE_ADDTOLAYER
  55 } vik_datasource_mode_t;
  56 /* TODO: replace track/layer? */
  57
  58 typedef enum {
  59   VIK_DATASOURCE_INPUTTYPE_NONE = 0,
  60   VIK_DATASOURCE_INPUTTYPE_TRWLAYER,
  61   VIK_DATASOURCE_INPUTTYPE_TRACK,
  62   VIK_DATASOURCE_INPUTTYPE_TRWLAYER_TRACK
  63 } vik_datasource_inputtype_t;
  64
  65 /**
  66  * VikDataSourceInitFunc:
  67  *
  68  * Returns: pointer to state if OK, otherwise %NULL
  69  */
  70 typedef gpointer (*VikDataSourceInitFunc) ();
  71
  72 /**
  73  * VikDataSourceCheckExistenceFunc:
  74  *
  75  * Returns: %NULL if OK, otherwise returns an error message.
  76  */
  77 typedef gchar *(*VikDataSourceCheckExistenceFunc) ();
  78
  79 /**
  80  * VikDataSourceAddSetupWidgetsFunc:
  81  *
  82  * Create widgets to show in a setup dialog, set up state via user_data.
  83  */
  84 typedef void (*VikDataSourceAddSetupWidgetsFunc) ( GtkWidget *dialog, VikViewport *vvp, gpointer user_data );
  85
  86 /**
  87  * VikDataSourceGetCmdStringFunc:
  88  * @user_data: provided by #VikDataSourceInterface.init_func or dialog with params
  89  * @args: the arguments computed for #VikDataSourceInterface.process_func
  90  * @extra: extra arguments for #VikDataSourceInterface.process_func
  91  * @options: even more options for #VikDataSourceInterface.process_func
  92  *
  93  * set both to %NULL to signal refusal (ie already downloading).
  94  */
  95 typedef void (*VikDataSourceGetCmdStringFunc) ( gpointer user_data, gchar **args, gchar **extra, gpointer options );
  96
  97 typedef void (*VikDataSourceGetCmdStringFuncWithInput) ( gpointer user_data, gchar **babelargs_or_shellcmd, gchar **inputfile_or_inputtype, const gchar *input_file_name );
  98 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 );
  99
 100 /**
 101  * VikDataSourceProcessFunc:
 102  * @vtl:
 103  * @cmd: the arguments computed by #VikDataSourceInterface.get_cmd_string_func
 104  * @extra: the extra arguments computed by #VikDataSourceInterface.get_cmd_string_func
 105  * @status_cb: the #VikDataSourceInterface.progress_func
 106  * @adw: the widgets and data used by #VikDataSourceInterface.progress_func
 107  * @options: more options returned by #VikDataSourceInterface.get_cmd_string_func
 108  *
 109  * The actual function to do stuff - must report success/failure.
 110  */
 111 typedef gboolean (*VikDataSourceProcessFunc)  ( gpointer vtl, const gchar *cmd, const gchar *extra, BabelStatusFunc status_cb, acq_dialog_widgets_t *adw, gpointer options );
 112
 113 /* */
 114 typedef void  (*VikDataSourceProgressFunc)  ( BabelProgressCode c, gpointer data, acq_dialog_widgets_t *w );
 115
 116 /**
 117  * VikDataSourceAddProgressWidgetsFunc:
 118  *
 119  * Creates widgets to show in a progress dialog, may set up state via user_data.
 120  */
 121 typedef void  (*VikDataSourceAddProgressWidgetsFunc) ( GtkWidget *dialog, gpointer user_data );
 122
 123 /**
 124  * VikDataSourceCleanupFunc:
 125  *
 126  * Frees any widgets created for the setup or progress dialogs, any allocated state, etc.
 127  */
 128 typedef void (*VikDataSourceCleanupFunc) ( gpointer user_data );
 129
 130 typedef void (*VikDataSourceOffFunc) ( gpointer user_data, gchar **babelargs_or_shellcmd, gchar **inputfile_or_inputtype );;
 131
 132 /**
 133  * VikDataSourceInterface:
 134  *
 135  * Main interface.
 136  */
 137 struct _VikDataSourceInterface {
 138   const gchar *window_title;
 139   const gchar *layer_title;
 140   vik_datasource_mode_t mode;
 141   vik_datasource_inputtype_t inputtype;
 142   gboolean autoview;
 143   gboolean keep_dialog_open; /* when done */
 144
 145   gboolean is_thread;
 146
 147   /*** Manual UI Building ***/
 148   VikDataSourceInitFunc init_func;
 149   VikDataSourceCheckExistenceFunc check_existence_func;
 150   VikDataSourceAddSetupWidgetsFunc add_setup_widgets_func;
 151   /***                    ***/
 152
 153   /* or VikDataSourceGetCmdStringFuncWithInput, if inputtype is not NONE */
 154   VikDataSourceGetCmdStringFunc get_cmd_string_func;
 155
 156   VikDataSourceProcessFunc process_func;
 157
 158   VikDataSourceProgressFunc progress_func;
 159   VikDataSourceAddProgressWidgetsFunc add_progress_widgets_func;
 160   VikDataSourceCleanupFunc cleanup_func;
 161   VikDataSourceOffFunc off_func;
 162
 163   /*** UI Building        ***/
 164   VikLayerParam *                   params;
 165   guint16                           params_count;
 166   VikLayerParamData *               params_defaults;
 167   gchar **                          params_groups;
 168   guint8                            params_groups_count;
 169
 170 };
 171
 172 /**********************************/
 173 /**********************************/
 174 /**********************************/
 175
 176 void a_acquire ( VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikDataSourceInterface *source_interface );
 177
 178 GtkWidget *a_acquire_trwlayer_menu (VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikTrwLayer *vtl);
 179
 180 GtkWidget *a_acquire_trwlayer_track_menu (VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikTrwLayer *vtl);
 181
 182 GtkWidget *a_acquire_track_menu (VikWindow *vw, VikLayersPanel *vlp, VikViewport *vvp, VikTrack *tr);
 183
 184 void a_acquire_set_filter_track ( VikTrack *tr );
 185
 186 G_END_DECLS
 187
 188 #endif