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 static inline int to_feet(depth_t depth)
  90 {
  91         return depth.mm * 0.00328084 + 0.5;
  92 }
  93
  94 static double mkelvin_to_C(int mkelvin)
  95 {
  96         return (mkelvin - 273150) / 1000.0;
  97 }
  98
  99 static double mkelvin_to_F(int mkelvin)
 100 {
 101         return mkelvin * 9 / 5000.0 - 459.670;
 102 }
 103
 104 static inline int to_C(temperature_t temp)
 105 {
 106         if (!temp.mkelvin)
 107                 return 0;
 108         return mkelvin_to_C(temp.mkelvin) + 0.5;
 109 }
 110
 111 static inline int to_F(temperature_t temp)
 112 {
 113         if (!temp.mkelvin)
 114                 return 0;
 115         return mkelvin_to_F(temp.mkelvin) + 0.5;
 116 }
 117
 118 static inline int to_K(temperature_t temp)
 119 {
 120         if (!temp.mkelvin)
 121                 return 0;
 122         return (temp.mkelvin + 499)/1000;
 123 }
 124
 125 static inline int to_PSI(pressure_t pressure)
 126 {
 127         return pressure.mbar * 0.0145037738 + 0.5;
 128 }
 129
 130 struct sample {
 131         duration_t time;
 132         depth_t depth;
 133         temperature_t temperature;
 134         pressure_t cylinderpressure;
 135         int cylinderindex;
 136 };
 137
 138 #define MAX_CYLINDERS (8)
 139
 140 struct dive {
 141         int number;
 142         time_t when;
 143         char *location;
 144         char *notes;
 145         char *divemaster, *buddy;
 146         double latitude, longitude;
 147         depth_t maxdepth, meandepth;
 148         duration_t duration, surfacetime;
 149         depth_t visibility;
 150         temperature_t airtemp, watertemp;
 151         cylinder_t cylinder[MAX_CYLINDERS];
 152         int samples, alloc_samples;
 153         struct sample sample[];
 154 };
 155
 156 /*
 157  * We keep our internal data in well-specified units, but
 158  * the input and output may come in some random format. This
 159  * keeps track of those units.
 160  */
 161 struct units {
 162         enum { METERS, FEET } length;
 163         enum { LITER, CUFT } volume;
 164         enum { BAR, PSI, PASCAL } pressure;
 165         enum { CELSIUS, FAHRENHEIT, KELVIN } temperature;
 166         enum { KG, LBS } weight;
 167 };
 168
 169 extern const struct units SI_units, IMPERIAL_units;
 170 extern struct units input_units, output_units;
 171
 172 extern int verbose;
 173
 174 struct dive_table {
 175         int nr, allocated;
 176         struct dive **dives;
 177 };
 178
 179 extern struct dive_table dive_table;
 180
 181 extern int selected_dive;
 182 #define current_dive (get_dive(selected_dive))
 183
 184 static inline struct dive *get_dive(unsigned int nr)
 185 {
 186         if (nr >= dive_table.nr)
 187                 return NULL;
 188         return dive_table.dives[nr];
 189 }
 190
 191 extern void parse_xml_init(void);
 192 extern void parse_xml_file(const char *filename, GError **error);
 193
 194 extern void show_dive_info(struct dive *);
 195 extern void flush_dive_info_changes(struct dive *);
 196
 197 extern void show_dive_equipment(struct dive *);
 198 extern void flush_dive_equipment_changes(struct dive *);
 199
 200 extern void update_dive(struct dive *new_dive);
 201 extern void save_dives(const char *filename);
 202
 203 static inline unsigned int dive_size(int samples)
 204 {
 205         return sizeof(struct dive) + samples*sizeof(struct sample);
 206 }
 207
 208 extern time_t utc_mktime(struct tm *tm);
 209
 210 extern struct dive *alloc_dive(void);
 211 extern void record_dive(struct dive *dive);
 212
 213 extern struct sample *prepare_sample(struct dive **divep);
 214 extern void finish_sample(struct dive *dive, struct sample *sample);
 215
 216 extern void report_dives(void);
 217 extern struct dive *fixup_dive(struct dive *dive);
 218 extern struct dive *try_to_merge(struct dive *a, struct dive *b);
 219
 220 extern void update_air_info(char *buffer);
 221
 222 #define DIVE_ERROR_PARSE 1
 223
 224 #endif /* DIVE_H */