Add new process stage for acquire methods.

[andy/viking.git] / src / babel.h

diff --git a/src/babel.h b/src/babel.h
index 967eb5376f5112317c88f13d9767c52030790701..5c168fa243cc0b2f467ad8315118847eb3c8b930 100644 (file)
--- a/src/babel.h
+++ b/src/babel.h
@@ -27,47 +27,78 @@
 
 #include "viktrwlayer.h"
 
+/**
+ * BabelProgressCode:
+ * @BABEL_DIAG_OUTPUT: a line of diagnostic output is available. The pointer is to a 
+ *                     NULL-terminated line of diagnostic output from gpsbabel.
+ * @BABEL_DONE: gpsbabel finished, or %NULL if no callback is needed.
+ *
+ * Used when calling #BabelStatusFunc.
+ */
 typedef enum {
   BABEL_DIAG_OUTPUT,
   BABEL_DONE,
 } BabelProgressCode;
 
+/**
+ * BabelStatusFunc:
+ *
+ * Callback function.
+ */
 typedef void (*BabelStatusFunc)(BabelProgressCode, gpointer, gpointer);
 
-/*
- * a_babel_convert modifies data in a trw layer using gpsbabel filters.  This routine is synchronous;
- * that is, it will block the calling program until the conversion is done.  To avoid blocking, call
- * this routine from a worker thread.  The arguments are as follows:
- * 
- * vt              The TRW layer to modify.  All data will be deleted, and replaced by what gpsbabel outputs.
+/**
+ * BabelMode:
  * 
- * babelargs       A string containing gpsbabel command line filter options.  No file types or names should
- *                 be specified.
- * 
- * cb             A callback function, called with the following status codes:
- *                   BABEL_DIAG_OUTPUT: a line of diagnostic output is available.  The pointer is to a 
- *                                      NUL-terminated line of diagnostic output from gpsbabel.
- *                   BABEL_DIAG_DONE: gpsbabel finished,
- *                 or NULL if no callback is needed.
+ * Store the Read/Write support offered by gpsbabel for a given format.
  */
-gboolean a_babel_convert( VikTrwLayer *vt, const char *babelargs, BabelStatusFunc cb, gpointer user_data );
+typedef struct {
+    unsigned waypointsRead : 1;
+    unsigned waypointsWrite : 1;
+    unsigned tracksRead : 1;
+    unsigned tracksWrite : 1;
+    unsigned routesRead : 1;
+    unsigned routesWrite : 1;
+} BabelMode;
 
-/*
- * a_babel_convert_from loads data into a trw layer from a file, using gpsbabel.  This routine is synchronous;
- * that is, it will block the calling program until the conversion is done.  To avoid blocking, call
- * this routine from a worker thread. The arguments are as follows:
- * 
- * vt              The TRW layer to place data into.  Duplicate items will be overwritten. 
+/**
+ * BabelDevice:
+ * @name: gpsbabel's identifier of the device
+ * @label: human readable label
  * 
- * babelargs       A string containing gpsbabel command line options.  In addition to any filters, this string
- *                 must include the input file type (-i) option. 
+ * Representation of a supported device.
+ */
+typedef struct {
+    BabelMode mode;
+    gchar *name;
+    gchar *label;
+} BabelDevice;
+
+/**
+ * BabelFile:
+ * @name: gpsbabel's identifier of the device
+ * @ext: file's extension for this format
+ * @label: human readable label
  * 
- * cb             Optional callback function. Same usage as in a_babel_convert.
+ * Representation of a supported file format.
  */
+typedef struct {
+    BabelMode mode;
+    gchar *name;
+    gchar *ext;
+    gchar *label;
+} BabelFile;
+
+GList *a_babel_file_list;
+GList *a_babel_device_list;
+
+gboolean a_babel_convert( VikTrwLayer *vt, const char *babelargs, BabelStatusFunc cb, gpointer user_data );
 gboolean a_babel_convert_from( VikTrwLayer *vt, const char *babelargs, BabelStatusFunc cb, const char *file, gpointer user_data );
 gboolean a_babel_convert_from_shellcommand ( VikTrwLayer *vt, const char *input_cmd, const char *input_file_type, BabelStatusFunc cb, gpointer user_data );
 gboolean a_babel_convert_from_url ( VikTrwLayer *vt, const char *url, const char *input_type, BabelStatusFunc cb, gpointer user_data );
 gboolean a_babel_convert_to( VikTrwLayer *vt, const char *babelargs, BabelStatusFunc cb, const char *file, gpointer user_data );
 
+void a_babel_init ();
+void a_babel_uninit ();
 
 #endif