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