]> git.tdb.fi Git - ext/subsurface.git/blobdiff - parse-xml.c
Add framework for UDDF importer
[ext/subsurface.git] / parse-xml.c
index 1ca046db7a62f2e0391e8f89e896df0c34dd06d8..d53c9b323cc6b49a7cd55d1a1565cfed3ba6ce09 100644 (file)
@@ -70,12 +70,17 @@ static int match(const char *pattern, int plen,
 static struct units {
        enum { METERS, FEET } length;
        enum { LITER, CUFT } volume;
-       enum { BAR, PSI } pressure;
-       enum { CELSIUS, FAHRENHEIT } temperature;
+       enum { BAR, PSI, PASCAL } pressure;
+       enum { CELSIUS, FAHRENHEIT, KELVIN } temperature;
        enum { KG, LBS } weight;
 } units;
 
-/* We're going to default to SI units for input */
+/*
+ * We're going to default to SI units for input. Yes,
+ * technically the SI unit for pressure is Pascal, but
+ * we default to bar (10^5 pascal), which people
+ * actually use. Similarly, C instead of Kelvin.
+ */
 static const struct units SI_units = {
        .length = METERS,
        .volume = LITER,
@@ -91,9 +96,17 @@ static int alloc_samples;
 static struct dive *dive;
 static struct sample *sample;
 static struct tm tm;
-static int suunto, uemis;
 static int event_index, cylinder_index;
 
+static enum import_source {
+       UNKNOWN,
+       LIBDIVECOMPUTER,
+       SUUNTO,
+       UEMIS,
+       DIVINGLOG,
+       UDDF,
+} import_source;
+
 static time_t utc_mktime(struct tm *tm)
 {
        static const int mdays[] = {
@@ -231,6 +244,9 @@ static void pressure(char *buffer, void *_press)
                if (!val.fp)
                        break;
                switch (units.pressure) {
+               case PASCAL:
+                       mbar = val.fp / 100;
+                       break;
                case BAR:
                        /* Assume mbar, but if it's really small, it's bar */
                        mbar = val.fp;
@@ -286,6 +302,9 @@ static void temperature(char *buffer, void *_temperature)
                        break;
                /* Celsius */
                switch (units.temperature) {
+               case KELVIN:
+                       temperature->mkelvin = val.fp * 1000;
+                       break;
                case CELSIUS:
                        temperature->mkelvin = (val.fp + 273.15) * 1000 + 0.5;
                        break;
@@ -467,6 +486,35 @@ static int uemis_fill_sample(struct sample *sample, const char *name, int len, c
                0;
 }
 
+/*
+ * Divinglog is crazy. The temperatures are in celsius. EXCEPT
+ * for the sample temperatures, that are in Fahrenheit.
+ * WTF?
+ */
+static void fahrenheit(char *buffer, void *_temperature)
+{
+       temperature_t *temperature = _temperature;
+       union int_or_float val;
+
+       switch (integer_or_float(buffer, &val)) {
+       case FLOAT:
+               temperature->mkelvin = (val.fp + 459.67) * 5000/9;
+               break;
+       default:
+               fprintf(stderr, "Crazy Diving Log temperature reading %s\n", buffer);
+       }
+       free(buffer);
+}
+
+static int divinglog_fill_sample(struct sample *sample, const char *name, int len, char *buf)
+{
+       return  MATCH(".p.time", sampletime, &sample->time) ||
+               MATCH(".p.depth", depth, &sample->depth) ||
+               MATCH(".p.temp", fahrenheit, &sample->temperature) ||
+               MATCH(".p.press1", pressure, &sample->cylinderpressure) ||
+               0;
+}
+
 /* We're in samples - try to convert the random xml value to something useful */
 static void try_to_fill_sample(struct sample *sample, const char *name, char *buf)
 {
@@ -488,9 +536,19 @@ static void try_to_fill_sample(struct sample *sample, const char *name, char *bu
        if (MATCH(".sample.time", sampletime, &sample->time))
                return;
 
-       if (uemis) {
+       switch (import_source) {
+       case UEMIS:
                if (uemis_fill_sample(sample, name, len, buf))
                        return;
+               break;
+
+       case DIVINGLOG:
+               if (divinglog_fill_sample(sample, name, len, buf))
+                       return;
+               break;
+
+       default:
+               break;
        }
 
        nonmatch("sample", name, buf);
@@ -514,6 +572,44 @@ static int suunto_dive_match(struct dive *dive, const char *name, int len, char
                0;
 }
 
+static const char *country, *city;
+
+static void divinglog_place(char *place, void *_location)
+{
+       char **location = _location;
+       char buffer[256], *p;
+       int len;
+
+       len = snprintf(buffer, sizeof(buffer),
+               "%s%s%s%s%s",
+               place,
+               city ? ", " : "",
+               city ? city : "",
+               country ? ", " : "",
+               country ? country : "");
+
+       p = malloc(len+1);
+       memcpy(p, buffer, len+1);
+       *location = p;
+
+       city = NULL;
+       country = NULL;
+}
+
+static int divinglog_dive_match(struct dive *dive, const char *name, int len, char *buf)
+{
+       return  MATCH(".divedate", divedate, &dive->when) ||
+               MATCH(".entrytime", divetime, &dive->when) ||
+               MATCH(".depth", depth, &dive->maxdepth) ||
+               MATCH(".tanksize", cylindersize, &dive->cylinder[0].type.size) ||
+               MATCH(".tanktype", utf8_string, &dive->cylinder[0].type.description) ||
+               MATCH(".comments", utf8_string, &dive->notes) ||
+               MATCH(".country.name", utf8_string, &country) ||
+               MATCH(".city.name", utf8_string, &city) ||
+               MATCH(".place.name", divinglog_place, &dive->location) ||
+               0;
+}
+
 static int buffer_value(char *buffer)
 {
        int val = atoi(buffer);
@@ -564,7 +660,7 @@ static void uemis_date_time(char *buffer, void *_when)
 
         switch (integer_or_float(buffer, &val)) {
         case FLOAT:
-               *when = (val.fp - 40587.5) * 86400;
+               *when = (val.fp - 40587) * 86400;
                break;
        default:
                fprintf(stderr, "Strange julian date: %s", buffer);
@@ -581,10 +677,78 @@ static void uemis_date_time(char *buffer, void *_when)
  */
 static void uemis_time_zone(char *buffer, void *_when)
 {
+#if 0 /* seems like this is only used to display it correctly
+       * the stored time appears to be UTC */
+
        time_t *when = _when;
        signed char tz = atoi(buffer);
 
        *when += tz * 3600;
+#endif
+}
+
+/* 0 - air ; 1 - nitrox1 ; 2 - nitrox2 ; 3 = nitrox3 */
+static int uemis_gas_template;
+
+/*
+ * Christ. Uemis tank data is a total mess.
+ *
+ * We're passed a "virtual cylinder" (0 - 6) for the different
+ * Uemis tank cases ("air", "nitrox_1", "nitrox_2.{bottom,deco}"
+ * and "nitrox_3.{bottom,deco,travel}". We need to turn that
+ * into the actual cylinder data depending on the gas template,
+ * and ignore the ones that are irrelevant for that template.
+ *
+ * So for "template 2" (nitrox_2), we ignore virtual tanks 0-1
+ * (which are "air" and "nitrox_1" respectively), and tanks 4-6
+ * (which are the three "nitrox_3" tanks), and we turn virtual
+ * tanks 2/3 into actual tanks 0/1.
+ *
+ * Confused yet?
+ */
+static int uemis_cylinder_index(void *_cylinder)
+{
+       cylinder_t *cylinder = _cylinder;
+       unsigned int index = cylinder - dive->cylinder;
+
+       if (index > 6) {
+               fprintf(stderr, "Uemis cylinder pointer calculations broken\n");
+               return -1;
+       }
+       switch(uemis_gas_template) {
+       case 1: /* Dive uses tank 1 */
+               index -= 1;
+       /* Fallthrough */
+       case 0: /* Dive uses tank 0 */
+               if (index)
+                       index = -1;
+               break;
+       case 2: /* Dive uses tanks 2-3 */
+               index -= 2;
+               if (index > 1)
+                       index = -1;
+               break;
+       case 3: /* Dive uses tanks 4-6 */
+               index -= 4;
+               if (index > 2)
+                       index = -1;
+               break;
+       }
+       return index;
+}
+
+static void uemis_cylindersize(char *buffer, void *_cylinder)
+{
+       int index = uemis_cylinder_index(_cylinder);
+       if (index >= 0)
+               cylindersize(buffer, &dive->cylinder[index].type.size);
+}
+
+static void uemis_percent(char *buffer, void *_cylinder)
+{
+       int index = uemis_cylinder_index(_cylinder);
+       if (index >= 0)
+               percent(buffer, &dive->cylinder[index].gasmix.o2);
 }
 
 static int uemis_dive_match(struct dive *dive, const char *name, int len, char *buf)
@@ -599,6 +763,21 @@ static int uemis_dive_match(struct dive *dive, const char *name, int len, char *
                MATCH(".date_time", uemis_date_time, &dive->when) ||
                MATCH(".time_zone", uemis_time_zone, &dive->when) ||
                MATCH(".ambient.temperature", decicelsius, &dive->airtemp) ||
+               MATCH(".gas.template", get_index, &uemis_gas_template) ||
+               MATCH(".air.bottom_tank.size", uemis_cylindersize, dive->cylinder + 0) ||
+               MATCH(".air.bottom_tank.oxygen", uemis_percent, dive->cylinder + 0) ||
+               MATCH(".nitrox_1.bottom_tank.size", uemis_cylindersize, dive->cylinder + 1) ||
+               MATCH(".nitrox_1.bottom_tank.oxygen", uemis_percent, dive->cylinder + 1) ||
+               MATCH(".nitrox_2.bottom_tank.size", uemis_cylindersize, dive->cylinder + 2) ||
+               MATCH(".nitrox_2.bottom_tank.oxygen", uemis_percent, dive->cylinder + 2) ||
+               MATCH(".nitrox_2.deco_tank.size", uemis_cylindersize, dive->cylinder + 3) ||
+               MATCH(".nitrox_2.deco_tank.oxygen", uemis_percent, dive->cylinder + 3) ||
+               MATCH(".nitrox_3.bottom_tank.size", uemis_cylindersize, dive->cylinder + 4) ||
+               MATCH(".nitrox_3.bottom_tank.oxygen", uemis_percent, dive->cylinder + 4) ||
+               MATCH(".nitrox_3.deco_tank.size", uemis_cylindersize, dive->cylinder + 5) ||
+               MATCH(".nitrox_3.deco_tank.oxygen", uemis_percent, dive->cylinder + 5) ||
+               MATCH(".nitrox_3.travel_tank.size", uemis_cylindersize, dive->cylinder + 6) ||
+               MATCH(".nitrox_3.travel_tank.oxygen", uemis_percent, dive->cylinder + 6) ||
                0;
 }
 
@@ -608,6 +787,27 @@ static void try_to_fill_dive(struct dive *dive, const char *name, char *buf)
        int len = strlen(name);
 
        start_match("dive", name, buf);
+
+       switch (import_source) {
+       case SUUNTO:
+               if (suunto_dive_match(dive, name, len, buf))
+                       return;
+               break;
+
+       case UEMIS:
+               if (uemis_dive_match(dive, name, len, buf))
+                       return;
+               break;
+
+       case DIVINGLOG:
+               if (divinglog_dive_match(dive, name, len, buf))
+                       return;
+               break;
+
+       default:
+               break;
+       }
+
        if (MATCH(".date", divedate, &dive->when))
                return;
        if (MATCH(".time", divetime, &dive->when))
@@ -618,6 +818,10 @@ static void try_to_fill_dive(struct dive *dive, const char *name, char *buf)
                return;
        if (MATCH(".meandepth", depth, &dive->meandepth))
                return;
+       if (MATCH(".depth.max", depth, &dive->maxdepth))
+               return;
+       if (MATCH(".depth.mean", depth, &dive->meandepth))
+               return;
        if (MATCH(".duration", duration, &dive->duration))
                return;
        if (MATCH(".divetime", duration, &dive->duration))
@@ -630,9 +834,13 @@ static void try_to_fill_dive(struct dive *dive, const char *name, char *buf)
                return;
        if (MATCH(".watertemp", temperature, &dive->watertemp))
                return;
-       if (MATCH(".cylinderstartpressure", pressure, &dive->beginning_pressure))
+       if (MATCH(".temperature.air", temperature, &dive->airtemp))
+               return;
+       if (MATCH(".temperature.water", temperature, &dive->watertemp))
                return;
-       if (MATCH(".cylinderendpressure", pressure, &dive->end_pressure))
+       if (MATCH(".cylinderstartpressure", pressure, &dive->cylinder[0].start))
+               return;
+       if (MATCH(".cylinderendpressure", pressure, &dive->cylinder[0].end))
                return;
        if (MATCH(".location", utf8_string, &dive->location))
                return;
@@ -643,6 +851,12 @@ static void try_to_fill_dive(struct dive *dive, const char *name, char *buf)
                return;
        if (MATCH(".cylinder.workpressure", pressure, &dive->cylinder[cylinder_index].type.workingpressure))
                return;
+       if (MATCH(".cylinder.description", utf8_string, &dive->cylinder[cylinder_index].type.description))
+               return;
+       if (MATCH(".cylinder.start", pressure, &dive->cylinder[cylinder_index].start))
+               return;
+       if (MATCH(".cylinder.end", pressure, &dive->cylinder[cylinder_index].end))
+               return;
 
        if (MATCH(".o2", gasmix, &dive->cylinder[cylinder_index].gasmix.o2))
                return;
@@ -651,13 +865,6 @@ static void try_to_fill_dive(struct dive *dive, const char *name, char *buf)
        if (MATCH(".he", gasmix, &dive->cylinder[cylinder_index].gasmix.he))
                return;
 
-       /* Suunto XML files are some crazy sh*t. */
-       if (suunto && suunto_dive_match(dive, name, len, buf))
-               return;
-
-       if (uemis && uemis_dive_match(dive, name, len, buf))
-               return;
-
        nonmatch("dive", name, buf);
 }
 
@@ -805,27 +1012,6 @@ static void dive_end(void)
        cylinder_index = 0;
 }
 
-static void suunto_start(void)
-{
-       suunto++;
-       units = SI_units;
-}
-
-static void suunto_end(void)
-{
-       suunto--;
-}
-
-static void uemis_start(void)
-{
-       uemis++;
-       units = SI_units;
-}
-
-static void uemis_end(void)
-{
-}
-
 static void event_start(void)
 {
 }
@@ -970,6 +1156,41 @@ static void visit(xmlNode *n)
        traverse(n->children);
 }
 
+static void suunto_importer(void)
+{
+       import_source = SUUNTO;
+       units = SI_units;
+}
+
+static void uemis_importer(void)
+{
+       import_source = UEMIS;
+       units = SI_units;
+}
+
+static void DivingLog_importer(void)
+{
+       import_source = DIVINGLOG;
+
+       /*
+        * Diving Log units are really strange.
+        *
+        * Temperatures are in C, except in samples,
+        * when they are in Fahrenheit. Depths are in
+        * meters, but pressure is in PSI.
+        */
+       units = SI_units;
+       units.pressure = PSI;
+}
+
+static void uddf_importer(void)
+{
+       import_source = UDDF;
+       units = SI_units;
+       units.pressure = PASCAL;
+       units.temperature = KELVIN;
+}
+
 /*
  * I'm sure this could be done as some fancy DTD rules.
  * It's just not worth the headache.
@@ -979,14 +1200,22 @@ static struct nesting {
        void (*start)(void), (*end)(void);
 } nesting[] = {
        { "dive", dive_start, dive_end },
-       { "SUUNTO", suunto_start, suunto_end },
+       { "Dive", dive_start, dive_end },
        { "sample", sample_start, sample_end },
+       { "waypoint", sample_start, sample_end },
        { "SAMPLE", sample_start, sample_end },
        { "reading", sample_start, sample_end },
        { "event", event_start, event_end },
        { "gasmix", cylinder_start, cylinder_end },
        { "cylinder", cylinder_start, cylinder_end },
-       { "pre_dive", uemis_start, uemis_end },
+       { "P", sample_start, sample_end },
+
+       /* Import type recognition */
+       { "SUUNTO", suunto_importer },
+       { "Divinglog", DivingLog_importer },
+       { "pre_dive", uemis_importer },
+       { "uddf", uddf_importer },
+
        { NULL, }
 };
 
@@ -1022,17 +1251,23 @@ static void reset_all(void)
         * dive for that format.
         */
        units = SI_units;
-       suunto = 0;
-       uemis = 0;
+       import_source = UNKNOWN;
 }
 
-void parse_xml_file(const char *filename)
+void parse_xml_file(const char *filename, GError **error)
 {
        xmlDoc *doc;
 
        doc = xmlReadFile(filename, NULL, 0);
        if (!doc) {
                fprintf(stderr, "Failed to parse '%s'.\n", filename);
+               if (error != NULL)
+               {
+                       *error = g_error_new(g_quark_from_string("divelog"),
+                                            DIVE_ERROR_PARSE,
+                                            "Failed to parse '%s'",
+                                            filename);
+               }
                return;
        }