dive.h

   1 #ifndef DIVE_H
   2 #define DIVE_H
   3
   4 #include <stdlib.h>
   5 #include <time.h>
   6
   7 #include <glib.h>
   8
   9 /*
  10  * Some silly typedefs to make our units very explicit.
  11  *
  12  * Also, the units are chosen so that values can be expressible as
  13  * integers, so that we never have FP rounding issues. And they
  14  * are small enough that converting to/from imperial units doesn't
  15  * really matter.
  16  *
  17  * We also strive to make '0' a meaningless number saying "not
  18  * initialized", since many values are things that may not have
  19  * been reported (eg cylinder pressure or temperature from dive
  20  * computers that don't support them). But sometimes -1 is an even
  21  * more explicit way of saying "not there".
  22  *
  23  * Thus "millibar" for pressure, for example, or "millikelvin" for
  24  * temperatures. Doing temperatures in celsius or fahrenheit would
  25  * make for loss of precision when converting from one to the other,
  26  * and using millikelvin is SI-like but also means that a temperature
  27  * of '0' is clearly just a missing temperature or cylinder pressure.
  28  *
  29  * Also strive to use units that can not possibly be mistaken for a
  30  * valid value in a "normal" system without conversion. If the max
  31  * depth of a dive is '20000', you probably didn't convert from mm on
  32  * output, or if the max depth gets reported as "0.2ft" it was either
  33  * a really boring dive, or there was some missing input conversion,
  34  * and a 60-ft dive got recorded as 60mm.
  35  *
  36  * Doing these as "structs containing value" means that we always
  37  * have to explicitly write out those units in order to get at the
  38  * actual value. So there is hopefully little fear of using a value
  39  * in millikelvin as Fahrenheit by mistake.
  40  *
  41  * We don't actually use these all yet, so maybe they'll change, but
  42  * I made a number of types as guidelines.
  43  */
  44 typedef struct {
  45         int seconds;
  46 } duration_t;
  47
  48 typedef struct {
  49         int mm;
  50 } depth_t;
  51
  52 typedef struct {
  53         int mbar;
  54 } pressure_t;
  55
  56 typedef struct {
  57         int mkelvin;
  58 } temperature_t;
  59
  60 typedef struct {
  61         int mliter;
  62 } volume_t;
  63
  64 typedef struct {
  65         int permille;
  66 } fraction_t;
  67
  68 typedef struct {
  69         int grams;
  70 } weight_t;
  71
  72 struct gasmix {
  73         fraction_t o2;
  74         fraction_t he;
  75 };
  76
  77 typedef struct {
  78         volume_t size;
  79         pressure_t workingpressure;
  80         const char *description;        /* "LP85", "AL72", "AL80", "HP100+" or whatever */
  81 } cylinder_type_t;
  82
  83 typedef struct {
  84         cylinder_type_t type;
  85         struct gasmix gasmix;
  86         pressure_t start, end;
  87 } cylinder_t;
  88
  89 extern int get_pressure_units(unsigned int mb, const char **units);
  90 extern double get_depth_units(unsigned int mm, int *frac, const char **units);
  91 extern double get_volume_units(unsigned int mm, int *frac, const char **units);
  92 extern double get_temp_units(unsigned int mm, const char **units);
  93
  94 static inline double ml_to_cuft(int ml)
  95 {
  96         return ml / 28317.0;
  97 }
  98
  99 static inline double mm_to_feet(int mm)
 100 {
 101         return mm * 0.00328084;
 102 }
 103
 104 static inline int to_feet(depth_t depth)
 105 {
 106         return mm_to_feet(depth.mm) + 0.5;
 107 }
 108
 109 static double mkelvin_to_C(int mkelvin)
 110 {
 111         return (mkelvin - 273150) / 1000.0;
 112 }
 113
 114 static double mkelvin_to_F(int mkelvin)
 115 {
 116         return mkelvin * 9 / 5000.0 - 459.670;
 117 }
 118
 119 static inline int to_C(temperature_t temp)
 120 {
 121         if (!temp.mkelvin)
 122                 return 0;
 123         return mkelvin_to_C(temp.mkelvin) + 0.5;
 124 }
 125
 126 static inline int to_F(temperature_t temp)
 127 {
 128         if (!temp.mkelvin)
 129                 return 0;
 130         return mkelvin_to_F(temp.mkelvin) + 0.5;
 131 }
 132
 133 static inline int to_K(temperature_t temp)
 134 {
 135         if (!temp.mkelvin)
 136                 return 0;
 137         return (temp.mkelvin + 499)/1000;
 138 }
 139
 140 static inline int to_PSI(pressure_t pressure)
 141 {
 142         return pressure.mbar * 0.0145037738 + 0.5;
 143 }
 144
 145 static inline double to_ATM(pressure_t pressure)
 146 {
 147         return pressure.mbar / 1013.25;
 148 }
 149
 150 static inline int mbar_to_PSI(int mbar)
 151 {
 152         pressure_t p = {mbar};
 153         return to_PSI(p);
 154 }
 155
 156 struct sample {
 157         duration_t time;
 158         depth_t depth;
 159         temperature_t temperature;
 160         pressure_t cylinderpressure;
 161         int cylinderindex;
 162 };
 163
 164 /*
 165  * Events are currently pretty meaningless. This is
 166  * just based on the random data that libdivecomputer
 167  * gives us. I'm not sure what a real "architected"
 168  * event model would actually look like, but right
 169  * now you can associate a list of events with a dive,
 170  * and we'll do something about it.
 171  */
 172 struct event {
 173         struct event *next;
 174         duration_t time;
 175         int type, flags, value;
 176         char name[];
 177 };
 178
 179 #define MAX_CYLINDERS (8)
 180
 181 struct dive {
 182         int number;
 183         time_t when;
 184         char *location;
 185         char *notes;
 186         char *divemaster, *buddy;
 187         double latitude, longitude;
 188         depth_t maxdepth, meandepth;
 189         duration_t duration, surfacetime;
 190         depth_t visibility;
 191         temperature_t airtemp, watertemp;
 192         cylinder_t cylinder[MAX_CYLINDERS];
 193         int sac, otu;
 194         struct event *events;
 195         int samples, alloc_samples;
 196         struct sample sample[];
 197 };
 198
 199 /*
 200  * We keep our internal data in well-specified units, but
 201  * the input and output may come in some random format. This
 202  * keeps track of those units.
 203  */
 204 /* turns out in Win32 PASCAL is defined as a calling convention */
 205 #ifdef WIN32
 206 #undef PASCAL
 207 #endif
 208 struct units {
 209         enum { METERS, FEET } length;
 210         enum { LITER, CUFT } volume;
 211         enum { BAR, PSI, PASCAL } pressure;
 212         enum { CELSIUS, FAHRENHEIT, KELVIN } temperature;
 213         enum { KG, LBS } weight;
 214 };
 215
 216 extern const struct units SI_units, IMPERIAL_units;
 217 extern struct units input_units, output_units;
 218
 219 extern int verbose;
 220
 221 struct dive_table {
 222         int nr, allocated, preexisting;
 223         struct dive **dives;
 224 };
 225
 226 extern struct dive_table dive_table;
 227
 228 extern int selected_dive;
 229 #define current_dive (get_dive(selected_dive))
 230
 231 static inline struct dive *get_dive(unsigned int nr)
 232 {
 233         if (nr >= dive_table.nr)
 234                 return NULL;
 235         return dive_table.dives[nr];
 236 }
 237
 238 extern void parse_xml_init(void);
 239 extern void parse_xml_file(const char *filename, GError **error);
 240 extern void set_filename(const char *filename);
 241
 242 extern void show_dive_info(struct dive *);
 243 extern void flush_dive_info_changes(struct dive *);
 244
 245 extern void show_dive_equipment(struct dive *);
 246 extern void flush_dive_equipment_changes(struct dive *);
 247
 248 extern void update_dive(struct dive *new_dive);
 249 extern void save_dives(const char *filename);
 250
 251 static inline unsigned int dive_size(int samples)
 252 {
 253         return sizeof(struct dive) + samples*sizeof(struct sample);
 254 }
 255
 256 extern time_t utc_mktime(struct tm *tm);
 257
 258 extern struct dive *alloc_dive(void);
 259 extern void record_dive(struct dive *dive);
 260
 261 extern struct sample *prepare_sample(struct dive **divep);
 262 extern void finish_sample(struct dive *dive, struct sample *sample);
 263
 264 extern void report_dives(gboolean imported);
 265 extern struct dive *fixup_dive(struct dive *dive);
 266 extern struct dive *try_to_merge(struct dive *a, struct dive *b);
 267
 268 extern void renumber_dives(int nr);
 269
 270 extern void add_event(struct dive *dive, int time, int type, int flags, int value, const char *name);
 271
 272 /* UI related protopypes */
 273
 274 extern void init_ui(int argc, char **argv);
 275
 276 extern void run_ui(void);
 277
 278 extern void report_error(GError* error);
 279
 280 extern void add_cylinder_description(cylinder_type_t *);
 281 extern void add_people(const char *string);
 282 extern void add_location(const char *string);
 283 extern void remember_event(const char *eventname);
 284 extern void evn_foreach(void (*callback)(const char *, int *, void *), void *data);
 285
 286 extern void dive_list_update_dives(void);
 287 extern void flush_divelist(struct dive *dive);
 288
 289 #define DIVE_ERROR_PARSE 1
 290
 291 const char *weekday(int wday);
 292 const char *monthname(int mon);
 293
 294 #define UTF8_DEGREE "\xc2\xb0"
 295 #define UTF8_SUBSCRIPT_2 "\xe2\x82\x82"
 296
 297 #endif /* DIVE_H */