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