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 unsigned long feet_to_mm(double feet)
 129 {
 130         return feet * 304.8 + 0.5;
 131 }
 132
 133 static inline int to_feet(depth_t depth)
 134 {
 135         return mm_to_feet(depth.mm) + 0.5;
 136 }
 137
 138 static inline double mkelvin_to_C(int mkelvin)
 139 {
 140         return (mkelvin - 273150) / 1000.0;
 141 }
 142
 143 static inline double mkelvin_to_F(int mkelvin)
 144 {
 145         return mkelvin * 9 / 5000.0 - 459.670;
 146 }
 147
 148 static inline unsigned long F_to_mkelvin(double f)
 149 {
 150         return (f-32) * 1000 / 1.8 + 273150.5;
 151 }
 152
 153 static inline int to_C(temperature_t temp)
 154 {
 155         if (!temp.mkelvin)
 156                 return 0;
 157         return mkelvin_to_C(temp.mkelvin) + 0.5;
 158 }
 159
 160 static inline int to_F(temperature_t temp)
 161 {
 162         if (!temp.mkelvin)
 163                 return 0;
 164         return mkelvin_to_F(temp.mkelvin) + 0.5;
 165 }
 166
 167 static inline int to_K(temperature_t temp)
 168 {
 169         if (!temp.mkelvin)
 170                 return 0;
 171         return (temp.mkelvin + 499)/1000;
 172 }
 173
 174 static inline double psi_to_bar(double psi)
 175 {
 176         return psi / 14.5037738;
 177 }
 178
 179 static inline unsigned long psi_to_mbar(double psi)
 180 {
 181         return psi_to_bar(psi)*1000 + 0.5;
 182 }
 183
 184 static inline int to_PSI(pressure_t pressure)
 185 {
 186         return pressure.mbar * 0.0145037738 + 0.5;
 187 }
 188
 189 static inline double bar_to_atm(double bar)
 190 {
 191         return bar / 1.01325;
 192 }
 193
 194 static inline double to_ATM(pressure_t pressure)
 195 {
 196         return pressure.mbar / 1013.25;
 197 }
 198
 199 static inline int mbar_to_PSI(int mbar)
 200 {
 201         pressure_t p = {mbar};
 202         return to_PSI(p);
 203 }
 204
 205 struct sample {
 206         duration_t time;
 207         depth_t depth;
 208         temperature_t temperature;
 209         pressure_t cylinderpressure;
 210         int cylinderindex;
 211 };
 212
 213 /*
 214  * Events are currently pretty meaningless. This is
 215  * just based on the random data that libdivecomputer
 216  * gives us. I'm not sure what a real "architected"
 217  * event model would actually look like, but right
 218  * now you can associate a list of events with a dive,
 219  * and we'll do something about it.
 220  */
 221 struct event {
 222         struct event *next;
 223         duration_t time;
 224         int type, flags, value;
 225         char name[];
 226 };
 227
 228 #define MAX_CYLINDERS (8)
 229 #define MAX_WEIGHTSYSTEMS (4)
 230
 231 struct dive {
 232         int number;
 233         time_t when;
 234         char *location;
 235         char *notes;
 236         char *divemaster, *buddy;
 237         int rating;
 238         double latitude, longitude;
 239         depth_t maxdepth, meandepth;
 240         duration_t duration, surfacetime;
 241         depth_t visibility;
 242         temperature_t airtemp, watertemp;
 243         cylinder_t cylinder[MAX_CYLINDERS];
 244         weightsystem_t weightsystem[MAX_WEIGHTSYSTEMS];
 245         int sac, otu;
 246         struct event *events;
 247         int samples, alloc_samples;
 248         struct sample sample[];
 249 };
 250
 251 /*
 252  * We keep our internal data in well-specified units, but
 253  * the input and output may come in some random format. This
 254  * keeps track of those units.
 255  */
 256 /* turns out in Win32 PASCAL is defined as a calling convention */
 257 #ifdef WIN32
 258 #undef PASCAL
 259 #endif
 260 struct units {
 261         enum { METERS, FEET } length;
 262         enum { LITER, CUFT } volume;
 263         enum { BAR, PSI, PASCAL } pressure;
 264         enum { CELSIUS, FAHRENHEIT, KELVIN } temperature;
 265         enum { KG, LBS } weight;
 266 };
 267
 268 extern const struct units SI_units, IMPERIAL_units;
 269 extern struct units input_units, output_units;
 270
 271 extern int verbose;
 272
 273 struct dive_table {
 274         int nr, allocated, preexisting;
 275         struct dive **dives;
 276 };
 277
 278 extern struct dive_table dive_table;
 279
 280 extern int selected_dive;
 281 #define current_dive (get_dive(selected_dive))
 282
 283 static inline struct dive *get_dive(unsigned int nr)
 284 {
 285         if (nr >= dive_table.nr)
 286                 return NULL;
 287         return dive_table.dives[nr];
 288 }
 289
 290 extern void parse_xml_init(void);
 291 extern void parse_xml_buffer(const char *url, const char *buf, int size, GError **error);
 292 extern void set_filename(const char *filename);
 293
 294 extern void parse_file(const char *filename, GError **error);
 295
 296 #ifdef XSLT
 297 extern xmlDoc *test_xslt_transforms(xmlDoc *doc);
 298 #endif
 299
 300 extern void show_dive_info(struct dive *);
 301
 302 extern void show_dive_equipment(struct dive *);
 303
 304 extern void show_dive_stats(struct dive *);
 305
 306 extern void update_dive(struct dive *new_dive);
 307 extern void save_dives(const char *filename);
 308
 309 static inline unsigned int dive_size(int samples)
 310 {
 311         return sizeof(struct dive) + samples*sizeof(struct sample);
 312 }
 313
 314 extern time_t utc_mktime(struct tm *tm);
 315
 316 extern struct dive *alloc_dive(void);
 317 extern void record_dive(struct dive *dive);
 318 extern void delete_dive(struct dive *dive);
 319
 320 extern struct sample *prepare_sample(struct dive **divep);
 321 extern void finish_sample(struct dive *dive);
 322
 323 extern void report_dives(gboolean imported);
 324 extern struct dive *fixup_dive(struct dive *dive);
 325 extern struct dive *try_to_merge(struct dive *a, struct dive *b);
 326
 327 extern void renumber_dives(int nr);
 328
 329 extern void add_event(struct dive *dive, int time, int type, int flags, int value, const char *name);
 330
 331 /* UI related protopypes */
 332
 333 extern void init_ui(int *argcp, char ***argvp);
 334
 335 extern void run_ui(void);
 336 extern void exit_ui(void);
 337
 338 extern void report_error(GError* error);
 339
 340 extern void add_cylinder_description(cylinder_type_t *);
 341 extern void add_people(const char *string);
 342 extern void add_location(const char *string);
 343 extern void remember_event(const char *eventname);
 344 extern void evn_foreach(void (*callback)(const char *, int *, void *), void *data);
 345
 346 extern int add_new_dive(struct dive *dive);
 347 extern int edit_dive_info(struct dive *dive);
 348 extern void dive_list_update_dives(void);
 349 extern void flush_divelist(struct dive *dive);
 350
 351 #define DIVE_ERROR_PARSE 1
 352
 353 const char *weekday(int wday);
 354 const char *monthname(int mon);
 355
 356 #define UTF8_DEGREE "\xc2\xb0"
 357 #define UTF8_SUBSCRIPT_2 "\xe2\x82\x82"
 358 #define UTF8_WHITESTAR "\xe2\x98\x86"
 359 #define UTF8_BLACKSTAR "\xe2\x98\x85"
 360 #define ZERO_STARS      UTF8_WHITESTAR UTF8_WHITESTAR UTF8_WHITESTAR UTF8_WHITESTAR UTF8_WHITESTAR
 361 #define ONE_STARS       UTF8_BLACKSTAR UTF8_WHITESTAR UTF8_WHITESTAR UTF8_WHITESTAR UTF8_WHITESTAR
 362 #define TWO_STARS       UTF8_BLACKSTAR UTF8_BLACKSTAR UTF8_WHITESTAR UTF8_WHITESTAR UTF8_WHITESTAR
 363 #define THREE_STARS     UTF8_BLACKSTAR UTF8_BLACKSTAR UTF8_BLACKSTAR UTF8_WHITESTAR UTF8_WHITESTAR
 364 #define FOUR_STARS      UTF8_BLACKSTAR UTF8_BLACKSTAR UTF8_BLACKSTAR UTF8_BLACKSTAR UTF8_WHITESTAR
 365 #define FIVE_STARS      UTF8_BLACKSTAR UTF8_BLACKSTAR UTF8_BLACKSTAR UTF8_BLACKSTAR UTF8_BLACKSTAR
 366 extern const char *star_strings[];
 367
 368 #define AIR_PERMILLE 209
 369
 370 #endif /* DIVE_H */