libdivecomputer/src/parser.h

/* 
 * libdivecomputer
 * 
 * Copyright (C) 2008 Jef Driesen
 * 
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 * 
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 * 
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301 USA
 */

#ifndef PARSER_H
#define PARSER_H

#include "datetime.h"

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

typedef enum parser_type_t {
	PARSER_TYPE_NULL = 0,
	PARSER_TYPE_SUUNTO_SOLUTION,
	PARSER_TYPE_SUUNTO_EON,
	PARSER_TYPE_SUUNTO_VYPER,
	PARSER_TYPE_SUUNTO_D9,
	PARSER_TYPE_REEFNET_SENSUS,
	PARSER_TYPE_REEFNET_SENSUSPRO,
	PARSER_TYPE_REEFNET_SENSUSULTRA,
	PARSER_TYPE_UWATEC_MEMOMOUSE,
	PARSER_TYPE_UWATEC_SMART,
	PARSER_TYPE_MARES_NEMO,
	PARSER_TYPE_MARES_DARWIN,
	PARSER_TYPE_MARES_ICONHD,
	PARSER_TYPE_OCEANIC_VTPRO,
	PARSER_TYPE_OCEANIC_VEO250,
	PARSER_TYPE_OCEANIC_ATOM2,
	PARSER_TYPE_HW_OSTC,
	PARSER_TYPE_CRESSI_EDY,
	PARSER_TYPE_ATOMICS_COBALT
} parser_type_t;

typedef enum parser_status_t {
	PARSER_STATUS_SUCCESS = 0,
	PARSER_STATUS_UNSUPPORTED = -1,
	PARSER_STATUS_TYPE_MISMATCH = -2,
	PARSER_STATUS_ERROR = -3,
	PARSER_STATUS_MEMORY = -7
} parser_status_t;

typedef enum parser_sample_type_t {
	SAMPLE_TYPE_TIME,
	SAMPLE_TYPE_DEPTH,
	SAMPLE_TYPE_PRESSURE,
	SAMPLE_TYPE_TEMPERATURE,
	SAMPLE_TYPE_EVENT,
	SAMPLE_TYPE_RBT,
	SAMPLE_TYPE_HEARTBEAT,
	SAMPLE_TYPE_BEARING,
	SAMPLE_TYPE_VENDOR
} parser_sample_type_t;

typedef enum parser_field_type_t {
	FIELD_TYPE_DIVETIME,
	FIELD_TYPE_MAXDEPTH,
	FIELD_TYPE_AVGDEPTH,
	FIELD_TYPE_GASMIX_COUNT,
	FIELD_TYPE_GASMIX
} parser_field_type_t;

typedef enum parser_sample_event_t {
	SAMPLE_EVENT_NONE,
	SAMPLE_EVENT_DECOSTOP,
	SAMPLE_EVENT_RBT,
	SAMPLE_EVENT_ASCENT,
	SAMPLE_EVENT_CEILING,
	SAMPLE_EVENT_WORKLOAD,
	SAMPLE_EVENT_TRANSMITTER,
	SAMPLE_EVENT_VIOLATION,
	SAMPLE_EVENT_BOOKMARK,
	SAMPLE_EVENT_SURFACE,
	SAMPLE_EVENT_SAFETYSTOP,
	SAMPLE_EVENT_GASCHANGE,
	SAMPLE_EVENT_SAFETYSTOP_VOLUNTARY,
	SAMPLE_EVENT_SAFETYSTOP_MANDATORY,
	SAMPLE_EVENT_DEEPSTOP,
	SAMPLE_EVENT_CEILING_SAFETYSTOP,
	SAMPLE_EVENT_UNKNOWN,
	SAMPLE_EVENT_DIVETIME,
	SAMPLE_EVENT_MAXDEPTH,
	SAMPLE_EVENT_OLF,
	SAMPLE_EVENT_PO2,
	SAMPLE_EVENT_AIRTIME,
	SAMPLE_EVENT_RGBM,
	SAMPLE_EVENT_HEADING,
	SAMPLE_EVENT_TISSUELEVEL
} parser_sample_event_t;

typedef enum parser_sample_flags_t {
	SAMPLE_FLAGS_NONE = 0,
	SAMPLE_FLAGS_BEGIN = (1 << 0),
	SAMPLE_FLAGS_END = (1 << 1)
} parser_sample_flags_t;

typedef enum parser_sample_vendor_t {
	SAMPLE_VENDOR_NONE,
	SAMPLE_VENDOR_UWATEC_ALADIN,
	SAMPLE_VENDOR_UWATEC_SMART,
	SAMPLE_VENDOR_OCEANIC_VTPRO,
	SAMPLE_VENDOR_OCEANIC_VEO250,
	SAMPLE_VENDOR_OCEANIC_ATOM2
} parser_sample_vendor_t;

typedef struct gasmix_t {
	double helium;
	double oxygen;
	double nitrogen;
} gasmix_t;

typedef union parser_sample_value_t {
	unsigned int time;
	double depth;
	struct {
		unsigned int tank;
		double value;
	} pressure;
	double temperature;
	struct {
		unsigned int type;
		unsigned int time;
		unsigned int flags;
		unsigned int value;
	} event;
	unsigned int rbt;
	unsigned int heartbeat;
	unsigned int bearing;
	struct {
		unsigned int type;
		unsigned int size;
		const void *data;
	} vendor;
} parser_sample_value_t;

typedef struct parser_t parser_t;

typedef void (*sample_callback_t) (parser_sample_type_t type, parser_sample_value_t value, void *userdata);

parser_type_t
parser_get_type (parser_t *device);

parser_status_t
parser_set_data (parser_t *parser, const unsigned char *data, unsigned int size);

parser_status_t
parser_get_datetime (parser_t *parser, dc_datetime_t *datetime);

parser_status_t
parser_get_field (parser_t *parser, parser_field_type_t type, unsigned int flags, void *value);

parser_status_t
parser_samples_foreach (parser_t *parser, sample_callback_t callback, void *userdata);

parser_status_t
parser_destroy (parser_t *parser);

#ifdef __cplusplus
}
#endif /* __cplusplus */
#endif /* PARSER_H */