src/babel.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) 2005, Alex Foobarian <foobarian@gmail.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_BABEL_H
  24 #define _VIKING_BABEL_H
  25
  26 #include <glib.h>
  27
  28 #include "viktrwlayer.h"
  29 #include "download.h"
  30
  31 G_BEGIN_DECLS
  32
  33 /**
  34  * BabelProgressCode:
  35  * @BABEL_DIAG_OUTPUT: a line of diagnostic output is available. The pointer is to a
  36  *                     NULL-terminated line of diagnostic output from gpsbabel.
  37  * @BABEL_DONE: gpsbabel finished, or %NULL if no callback is needed.
  38  *
  39  * Used when calling #BabelStatusFunc.
  40  */
  41 typedef enum {
  42   BABEL_DIAG_OUTPUT,
  43   BABEL_DONE,
  44 } BabelProgressCode;
  45
  46 /**
  47  * BabelStatusFunc:
  48  *
  49  * Callback function.
  50  */
  51 typedef void (*BabelStatusFunc)(BabelProgressCode, gpointer, gpointer);
  52
  53 /**
  54  * BabelMode:
  55  *
  56  * Store the Read/Write support offered by gpsbabel for a given format.
  57  */
  58 typedef struct {
  59     unsigned waypointsRead : 1;
  60     unsigned waypointsWrite : 1;
  61     unsigned tracksRead : 1;
  62     unsigned tracksWrite : 1;
  63     unsigned routesRead : 1;
  64     unsigned routesWrite : 1;
  65 } BabelMode;
  66
  67 /**
  68  * BabelDevice:
  69  * @name: gpsbabel's identifier of the device
  70  * @label: human readable label
  71  *
  72  * Representation of a supported device.
  73  */
  74 typedef struct {
  75     BabelMode mode;
  76     gchar *name;
  77     gchar *label;
  78 } BabelDevice;
  79
  80 /**
  81  * BabelFile:
  82  * @name: gpsbabel's identifier of the device
  83  * @ext: file's extension for this format
  84  * @label: human readable label
  85  *
  86  * Representation of a supported file format.
  87  */
  88 typedef struct {
  89     BabelMode mode;
  90     gchar *name;
  91     gchar *ext;
  92     gchar *label;
  93 } BabelFile;
  94
  95 GList *a_babel_file_list;
  96 GList *a_babel_device_list;
  97
  98 gboolean a_babel_convert( VikTrwLayer *vt, const char *babelargs, BabelStatusFunc cb, gpointer user_data, gpointer options );
  99 gboolean a_babel_convert_from( VikTrwLayer *vt, const char *babelargs, const char *file, BabelStatusFunc cb, gpointer user_data, gpointer options );
 100 gboolean a_babel_convert_from_shellcommand ( VikTrwLayer *vt, const char *input_cmd, const char *input_file_type, BabelStatusFunc cb, gpointer user_data, gpointer options );
 101 gboolean a_babel_convert_from_url ( VikTrwLayer *vt, const char *url, const char *input_type, BabelStatusFunc cb, gpointer user_data, DownloadMapOptions *options );
 102 gboolean a_babel_convert_to( VikTrwLayer *vt, VikTrack *track, const char *babelargs, const char *file, BabelStatusFunc cb, gpointer user_data );
 103
 104 void a_babel_init ();
 105 void a_babel_uninit ();
 106
 107 G_END_DECLS
 108
 109 #endif