2017-04-27 18:24:53 +00:00
|
|
|
// SPDX-License-Identifier: GPL-2.0
|
2011-08-31 01:23:59 +00:00
|
|
|
#ifndef DIVE_H
|
|
|
|
#define DIVE_H
|
|
|
|
|
2018-05-11 15:25:41 +00:00
|
|
|
// dive and dive computer related structures and helpers
|
|
|
|
|
2011-09-03 20:19:26 +00:00
|
|
|
#include <stdlib.h>
|
2012-11-25 19:44:27 +00:00
|
|
|
#include <stdint.h>
|
2018-01-07 10:14:46 +00:00
|
|
|
#include <stdbool.h>
|
2011-09-03 20:19:26 +00:00
|
|
|
#include <time.h>
|
2013-01-08 23:48:23 +00:00
|
|
|
#include <math.h>
|
2014-05-06 21:08:17 +00:00
|
|
|
#include <string.h>
|
2019-08-05 18:07:10 +00:00
|
|
|
#include <stdio.h>
|
2013-02-16 01:03:42 +00:00
|
|
|
|
2019-08-05 18:43:06 +00:00
|
|
|
#include "divemode.h"
|
2019-05-30 18:51:30 +00:00
|
|
|
#include "equipment.h"
|
2011-09-05 20:14:53 +00:00
|
|
|
|
2013-04-01 10:51:49 +00:00
|
|
|
#ifdef __cplusplus
|
|
|
|
extern "C" {
|
|
|
|
#endif
|
|
|
|
|
2015-02-13 07:35:52 +00:00
|
|
|
extern int last_xml_version;
|
|
|
|
|
2019-07-14 17:40:04 +00:00
|
|
|
extern const char *cylinderuse_text[NUM_GAS_USE];
|
2018-05-17 08:04:41 +00:00
|
|
|
extern const char *divemode_text_ui[];
|
2015-01-10 23:01:15 +00:00
|
|
|
extern const char *divemode_text[];
|
2014-06-11 17:48:48 +00:00
|
|
|
|
2014-06-01 19:07:29 +00:00
|
|
|
/*
|
|
|
|
* Events are currently based straight on what libdivecomputer gives us.
|
|
|
|
* We need to wrap these into our own events at some point to remove some of the limitations.
|
|
|
|
*/
|
|
|
|
struct event {
|
|
|
|
struct event *next;
|
|
|
|
duration_t time;
|
2014-08-17 18:26:21 +00:00
|
|
|
int type;
|
|
|
|
/* This is the annoying libdivecomputer format. */
|
|
|
|
int flags, value;
|
|
|
|
/* .. and this is our "extended" data for some event types */
|
|
|
|
union {
|
2018-05-08 14:24:51 +00:00
|
|
|
enum divemode_t divemode; // for divemode change events
|
2014-08-17 18:26:21 +00:00
|
|
|
/*
|
|
|
|
* NOTE! The index may be -1, which means "unknown". In that
|
|
|
|
* case, the get_cylinder_index() function will give the best
|
|
|
|
* match with the cylinders in the dive based on gasmix.
|
|
|
|
*/
|
2018-04-05 10:02:25 +00:00
|
|
|
struct { // for gas switch events
|
2014-08-17 18:26:21 +00:00
|
|
|
int index;
|
|
|
|
struct gasmix mix;
|
|
|
|
} gas;
|
|
|
|
};
|
2014-06-01 19:07:29 +00:00
|
|
|
bool deleted;
|
|
|
|
char name[];
|
|
|
|
};
|
|
|
|
|
2018-08-16 22:58:30 +00:00
|
|
|
extern int event_is_gaschange(const struct event *ev);
|
2014-06-02 19:40:31 +00:00
|
|
|
|
2018-08-16 17:10:10 +00:00
|
|
|
extern void fill_pressures(struct gas_pressures *pressures, const double amb_pressure, struct gasmix mix, double po2, enum divemode_t dctype);
|
2014-10-13 19:19:21 +00:00
|
|
|
|
2013-01-08 23:48:23 +00:00
|
|
|
/* Linear interpolation between 'a' and 'b', when we are 'part'way into the 'whole' distance from a to b */
|
|
|
|
static inline int interpolate(int a, int b, int part, int whole)
|
|
|
|
{
|
|
|
|
/* It is doubtful that we actually need floating point for this, but whatever */
|
2016-08-30 03:05:20 +00:00
|
|
|
if (whole) {
|
|
|
|
double x = (double)a * (whole - part) + (double)b * part;
|
2018-05-18 15:46:12 +00:00
|
|
|
return (int)lrint(x / whole);
|
2016-08-30 03:05:20 +00:00
|
|
|
}
|
|
|
|
return (a+b)/2;
|
2013-01-08 23:48:23 +00:00
|
|
|
}
|
|
|
|
|
Try to sanely download multiple concurrent cylinder pressures
This tries to sanely handle the case of a dive computer reporting
multiple cylinder pressures concurrently.
NOTE! There are various "interesting" situations that this whole issue
brings up:
- some dive computers may report more cylinder pressures than we have
slots for.
Currently we will drop such pressures on the floor if they come for
the same sample, but if they end up being spread across multiple
samples we will end up re-using the slots with different sensor
indexes.
That kind of slot re-use may or may not end up confusing other
subsurface logic - for example, make things believe there was a
cylidner change event.
- some dive computers might send only one sample at a time, but switch
*which* sample they send on a gas switch event. If they also report
the correct sensor number, we'll now start reporting that pressure in
the second slot.
This should all be fine, and is the RightThing(tm) to do, but is
different from what we used to do when we only ever used a single
slot.
- When people actually use multiple sensors, our old save format will
start to need fixing. Right now our save format comes from the CCR
model where the second sensor was always the Oxygen sensor.
We save that pressure fine (except we save it as "o2pressure" - just
an odd historical naming artifact), but we do *not* save the actual
sensor index, because in our traditional format that was always
implicit in the data ("it's the oxygen cylinder").
so while this code hopefully makes our libdivecomputer download do the
right thing, there *will* be further fallout from having multiple
cylinder pressure sensors. We're not done yet.
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-07-24 18:55:47 +00:00
|
|
|
#define MAX_SENSORS 2
|
2017-11-05 14:56:35 +00:00
|
|
|
struct sample // BASE TYPE BYTES UNITS RANGE DESCRIPTION
|
|
|
|
{ // --------- ----- ----- ----- -----------
|
|
|
|
duration_t time; // int32_t 4 seconds (0-34 yrs) elapsed dive time up to this sample
|
|
|
|
duration_t stoptime; // int32_t 4 seconds (0-34 yrs) time duration of next deco stop
|
|
|
|
duration_t ndl; // int32_t 4 seconds (-1 no val, 0-34 yrs) time duration before no-deco limit
|
|
|
|
duration_t tts; // int32_t 4 seconds (0-34 yrs) time duration to reach the surface
|
|
|
|
duration_t rbt; // int32_t 4 seconds (0-34 yrs) remaining bottom time
|
|
|
|
depth_t depth; // int32_t 4 mm (0-2000 km) dive depth of this sample
|
|
|
|
depth_t stopdepth; // int32_t 4 mm (0-2000 km) depth of next deco stop
|
2019-01-30 20:17:47 +00:00
|
|
|
temperature_t temperature; // uint32_t 4 mK (0-4 MK) ambient temperature
|
2017-11-05 14:56:35 +00:00
|
|
|
pressure_t pressure[MAX_SENSORS]; // int32_t 4 mbar (0-2 Mbar) cylinder pressures (main and CCR o2)
|
|
|
|
o2pressure_t setpoint; // uint16_t 2 mbar (0-65 bar) O2 partial pressure (will be setpoint)
|
|
|
|
o2pressure_t o2sensor[3]; // uint16_t 6 mbar (0-65 bar) Up to 3 PO2 sensor values (rebreather)
|
|
|
|
bearing_t bearing; // int16_t 2 degrees (-1 no val, 0-360 deg) compass bearing
|
|
|
|
uint8_t sensor[MAX_SENSORS]; // uint8_t 1 sensorID (0-255) ID of cylinder pressure sensor
|
|
|
|
uint16_t cns; // uint16_t 1 % (0-64k %) cns% accumulated
|
|
|
|
uint8_t heartbeat; // uint8_t 1 beats/m (0-255) heart rate measurement
|
|
|
|
volume_t sac; // 4 ml/min predefined SAC
|
|
|
|
bool in_deco; // bool 1 y/n y/n this sample is part of deco
|
|
|
|
bool manually_entered; // bool 1 y/n y/n this sample was entered by the user,
|
2018-05-11 15:25:41 +00:00
|
|
|
// not calculated when planning a dive
|
2017-11-05 14:56:35 +00:00
|
|
|
}; // Total size of structure: 57 bytes, excluding padding at end
|
2011-08-31 01:23:59 +00:00
|
|
|
|
2014-11-06 18:32:48 +00:00
|
|
|
struct extra_data {
|
|
|
|
const char *key;
|
|
|
|
const char *value;
|
|
|
|
struct extra_data *next;
|
|
|
|
};
|
|
|
|
|
2012-11-25 19:44:27 +00:00
|
|
|
/*
|
|
|
|
* NOTE! The deviceid and diveid are model-specific *hashes* of
|
|
|
|
* whatever device identification that model may have. Different
|
|
|
|
* dive computers will have different identifying data, it could
|
|
|
|
* be a firmware number or a serial ID (in either string or in
|
|
|
|
* numeric format), and we do not care.
|
|
|
|
*
|
|
|
|
* The only thing we care about is that subsurface will hash
|
|
|
|
* that information the same way. So then you can check the ID
|
|
|
|
* of a dive computer by comparing the hashes for equality.
|
|
|
|
*
|
|
|
|
* A deviceid or diveid of zero is assumed to be "no ID".
|
|
|
|
*/
|
2012-11-24 02:51:27 +00:00
|
|
|
struct divecomputer {
|
2012-11-25 02:50:21 +00:00
|
|
|
timestamp_t when;
|
Improve profile display in planner
This patch allows the planner to save the last manually-entered
dive planner point of a dive plan. When the plan has been saved
and re-opened for edit, the time of the last-entered dive planner
point is used to ensure that dive planning continues from the same
point in the profile as was when the original dive plan was saved.
Mechanism:
1) In dive.h, create a new dc attribute dc->last_manual_time
with data type of duration_t.
2) In diveplanner.c, ensure that the last manually-entered
dive planner point is saved in dc->last_manual_time.
3) In save-xml.c, create a new XML attribute for the <divecomputer>
element, named last-manual-time. For dive plans, the element would
now look like:
<divecomputer model='planned dive' last-manual-time='31:17 min'>
4) In parse-xml.c, insert code that recognises the last-manual-time
XML attribute, reads the time value and assigns this time to
dc->last_manual_time.
5) In diveplannermodel.cpp, method DiveplannerPointModel::loadfromdive,
insert code that sets the appropriate boolean value to dp->entered
by comparing newtime (i.e. time of dp) with dc->last_manual_time.
6) Diveplannermodel.cpp also accepts profile data from normal dives in
the dive log, whether hand-entered or loaded from dive computer. It
looks like the reduction of dive points for dives with >100 points
continues to work ok.
The result is that when a dive plan is saved with manually entered
points up to e.g. 10 minutes into the dive, it can be re-opened for edit
in the dive planner and the planner re-creates the plan with manually
entered points up to 10 minutes. The rest of the points are "soft"
points, shaped by the deco calculations of the planner.
Improvements: Improve code for profile display in dive planner
This responds to #1052.
Change load-git.c and save-git.c so that the last-manual-time is
also saved in the git-format dive log.
Several stylistic changes in text for consistent C source code.
Improvement of dive planner profile display:
Do some simplification of my alterations to diveplannermodel.cpp
Two small style changes in planner.c and diveplannermodel.cpp
as requested ny @neolit123
Signed-off-by: Willem Ferguson <willemferguson@zoology.up.ac.za>
2018-01-15 12:51:47 +00:00
|
|
|
duration_t duration, surfacetime, last_manual_time;
|
2013-01-23 18:25:31 +00:00
|
|
|
depth_t maxdepth, meandepth;
|
|
|
|
temperature_t airtemp, watertemp;
|
|
|
|
pressure_t surface_pressure;
|
2018-05-08 14:24:51 +00:00
|
|
|
enum divemode_t divemode; // dive computer type: OC(default) or CCR
|
2014-06-11 17:48:48 +00:00
|
|
|
uint8_t no_o2sensors; // rebreathers: number of O2 sensors used
|
|
|
|
int salinity; // kg per 10000 l
|
2014-10-22 19:11:12 +00:00
|
|
|
const char *model, *serial, *fw_version;
|
2012-11-25 19:44:27 +00:00
|
|
|
uint32_t deviceid, diveid;
|
2012-11-24 02:51:27 +00:00
|
|
|
int samples, alloc_samples;
|
|
|
|
struct sample *sample;
|
|
|
|
struct event *events;
|
2014-11-06 18:32:48 +00:00
|
|
|
struct extra_data *extra_data;
|
2012-11-25 02:50:21 +00:00
|
|
|
struct divecomputer *next;
|
2012-11-24 02:51:27 +00:00
|
|
|
};
|
|
|
|
|
2018-12-10 13:49:32 +00:00
|
|
|
typedef struct dive_table {
|
2018-11-08 15:58:33 +00:00
|
|
|
int nr, allocated;
|
|
|
|
struct dive **dives;
|
2018-12-10 13:49:32 +00:00
|
|
|
} dive_table_t;
|
2018-11-08 15:58:33 +00:00
|
|
|
|
2020-01-09 05:25:02 +00:00
|
|
|
static const dive_table_t empty_dive_table = { 0, 0, (struct dive **)0 };
|
|
|
|
|
2014-06-02 19:56:02 +00:00
|
|
|
struct picture;
|
2019-03-04 22:20:29 +00:00
|
|
|
struct dive_site;
|
|
|
|
struct dive_site_table;
|
2019-05-31 14:09:14 +00:00
|
|
|
struct dive_trip;
|
|
|
|
struct trip_table;
|
2020-02-16 21:26:47 +00:00
|
|
|
struct full_text_cache;
|
2011-08-31 01:23:59 +00:00
|
|
|
struct dive {
|
2019-05-31 14:09:14 +00:00
|
|
|
struct dive_trip *divetrip;
|
2012-09-20 00:35:52 +00:00
|
|
|
timestamp_t when;
|
2018-10-26 15:03:54 +00:00
|
|
|
struct dive_site *dive_site;
|
2011-09-02 02:56:04 +00:00
|
|
|
char *notes;
|
2011-09-13 21:58:06 +00:00
|
|
|
char *divemaster, *buddy;
|
2019-08-04 16:44:57 +00:00
|
|
|
struct cylinder_table cylinders;
|
2019-06-26 15:21:03 +00:00
|
|
|
struct weightsystem_table weightsystems;
|
2012-08-14 23:07:25 +00:00
|
|
|
char *suit;
|
2019-11-06 04:49:14 +00:00
|
|
|
int number;
|
|
|
|
int rating;
|
2019-11-28 19:04:52 +00:00
|
|
|
int wavesize, current, visibility, surge, chill; /* 0 - 5 star ratings */
|
2012-12-11 05:18:48 +00:00
|
|
|
int sac, otu, cns, maxcns;
|
2013-02-09 00:15:18 +00:00
|
|
|
|
|
|
|
/* Calculated based on dive computer data */
|
2013-02-09 15:41:15 +00:00
|
|
|
temperature_t mintemp, maxtemp, watertemp, airtemp;
|
2013-02-09 14:50:53 +00:00
|
|
|
depth_t maxdepth, meandepth;
|
2013-02-09 00:15:18 +00:00
|
|
|
pressure_t surface_pressure;
|
2013-02-09 15:12:30 +00:00
|
|
|
duration_t duration;
|
2013-02-09 00:15:18 +00:00
|
|
|
int salinity; // kg per 10000 l
|
2019-11-19 10:27:18 +00:00
|
|
|
int user_salinity; // water density reflecting a user-specified type
|
2012-11-24 02:51:27 +00:00
|
|
|
|
2014-01-07 01:30:01 +00:00
|
|
|
struct tag_entry *tag_list;
|
2012-11-24 02:51:27 +00:00
|
|
|
struct divecomputer dc;
|
2014-01-07 01:30:01 +00:00
|
|
|
int id; // unique ID for this dive
|
2014-06-02 19:56:02 +00:00
|
|
|
struct picture *picture_list;
|
2016-04-03 22:31:59 +00:00
|
|
|
unsigned char git_id[20];
|
2019-11-06 04:49:14 +00:00
|
|
|
bool notrip; /* Don't autogroup this dive to a trip */
|
|
|
|
bool selected;
|
|
|
|
bool hidden_by_filter;
|
2020-02-16 21:19:44 +00:00
|
|
|
struct full_text_cache *full_text; /* word cache for full text search */
|
2019-12-12 21:58:53 +00:00
|
|
|
bool invalid;
|
2014-06-02 19:56:02 +00:00
|
|
|
};
|
|
|
|
|
2018-11-10 08:07:42 +00:00
|
|
|
/* For the top-level list: an entry is either a dive or a trip */
|
|
|
|
struct dive_or_trip {
|
|
|
|
struct dive *dive;
|
|
|
|
struct dive_trip *trip;
|
|
|
|
};
|
|
|
|
|
2018-07-18 18:47:19 +00:00
|
|
|
extern void invalidate_dive_cache(struct dive *dive);
|
|
|
|
extern bool dive_cache_is_valid(const struct dive *dive);
|
2016-04-03 22:31:59 +00:00
|
|
|
|
2018-08-16 22:58:30 +00:00
|
|
|
extern int get_cylinder_idx_by_use(const struct dive *dive, enum cylinderuse cylinder_use_type);
|
2017-10-09 21:34:04 +00:00
|
|
|
extern void cylinder_renumber(struct dive *dive, int mapping[]);
|
2019-08-04 16:44:57 +00:00
|
|
|
extern int same_gasmix_cylinder(const cylinder_t *cyl, int cylid, const struct dive *dive, bool check_unused);
|
Calculate nitrogen and helium gas pressures for CCR after import from CSV
Currently the gas pressures stored in structures of pressure are
calculated using the gasmix composition of the currently selected
cylinder. But with CCR dives the default cylinder is the oxygen
cylinder (here, index 0). However, the gas pressures need to
be calculated using gasmix data from cylinder 1 (the diluent
cylinder). This patch allows setting the appropriate cylinder
for calculating the values in the structures of pressure. It
also allows for correctly calculating gas pressures for any
open circuit cylinders (e.g. bailout) that a CCR diver may
use. This is performed as follows:
1) In dive.h create an enum variable {oxygen, diluent, bailout}
2) Within the definition of cylinder_t, add a member: cylinder_use_type
This stores an enum variable, one of the above.
3) In file.c where the Poseidon CSV data are read in, assign
the appropriate enum values to each of the cylinders.
4) Within the definition of structure dive, add two members:
int oxygen_cylinder_index
int diluent_cylinder_index
This will keep the indices of the two main CCR cylinders.
5) In dive.c create a function get_cylinder_use(). This scans the
cylinders for that dive, looking for a cylinder that has a
particular cylinder_use_type and returns that cylinder index.
6) In dive.c create a function fixup_cylinder_use() that stores the
indices of the oxygen and diluent cylinders in the variables
dive->oxygen_cylinder_index and dive->diluent_cylinder_index,
making use of the function in 4) above.
7) In profile.c, modify function calculate_gas_information_new()
to use the above functions for CCR dives to find the oxygen and
diluent cylinders and to calculate partail gas pressures based
on the diluent cylinder gas mix.
This results in the correct calculation of gas partial pressures
in the case of CCR dives, displaying the correct partial pressure
graphs in the dive profile widget.
Signed-off-by: willem ferguson <willemferguson@zoology.up.ac.za>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2014-11-03 20:11:00 +00:00
|
|
|
|
2014-08-16 13:55:31 +00:00
|
|
|
/* when selectively copying dive information, which parts should be copied? */
|
|
|
|
struct dive_components {
|
2015-02-13 04:58:03 +00:00
|
|
|
unsigned int divesite : 1;
|
2014-08-16 13:55:31 +00:00
|
|
|
unsigned int notes : 1;
|
|
|
|
unsigned int divemaster : 1;
|
|
|
|
unsigned int buddy : 1;
|
|
|
|
unsigned int suit : 1;
|
|
|
|
unsigned int rating : 1;
|
|
|
|
unsigned int visibility : 1;
|
2019-11-28 19:04:52 +00:00
|
|
|
unsigned int wavesize : 1;
|
|
|
|
unsigned int current : 1;
|
|
|
|
unsigned int surge : 1;
|
|
|
|
unsigned int chill : 1;
|
2014-08-16 13:55:31 +00:00
|
|
|
unsigned int tags : 1;
|
|
|
|
unsigned int cylinders : 1;
|
|
|
|
unsigned int weights : 1;
|
|
|
|
};
|
|
|
|
|
2018-08-16 22:58:30 +00:00
|
|
|
extern enum divemode_t get_current_divemode(const struct divecomputer *dc, int time, const struct event **evp, enum divemode_t *divemode);
|
|
|
|
extern struct event *get_next_divemodechange(const struct event **evd, bool update_pointer);
|
|
|
|
extern enum divemode_t get_divemode_at_time(const struct divecomputer *dc, int dtime, const struct event **ev_dmc);
|
2018-04-02 15:16:07 +00:00
|
|
|
|
2014-06-02 19:56:02 +00:00
|
|
|
/* picture list and methods related to dive picture handling */
|
2014-06-03 14:48:35 +00:00
|
|
|
#define FOR_EACH_PICTURE(_dive) \
|
|
|
|
if (_dive) \
|
|
|
|
for (struct picture *picture = (_dive)->picture_list; picture; picture = picture->next)
|
2018-12-11 21:30:57 +00:00
|
|
|
extern void create_picture(const char *filename, int shift_time, bool match_all);
|
2014-06-08 19:34:18 +00:00
|
|
|
extern void dive_add_picture(struct dive *d, struct picture *newpic);
|
2018-03-03 09:10:51 +00:00
|
|
|
extern bool dive_remove_picture(struct dive *d, const char *filename);
|
2018-09-17 15:34:13 +00:00
|
|
|
extern bool picture_check_valid_time(timestamp_t timestamp, int shift_time);
|
2014-06-02 19:56:02 +00:00
|
|
|
|
2018-08-16 22:58:30 +00:00
|
|
|
extern bool has_gaschange_event(const struct dive *dive, const struct divecomputer *dc, int idx);
|
|
|
|
extern int explicit_first_cylinder(const struct dive *dive, const struct divecomputer *dc);
|
2018-08-16 22:36:51 +00:00
|
|
|
extern int get_depth_at_time(const struct divecomputer *dc, unsigned int time);
|
2014-06-02 19:56:02 +00:00
|
|
|
|
2018-08-16 22:36:51 +00:00
|
|
|
extern fraction_t best_o2(depth_t depth, const struct dive *dive);
|
2019-10-29 16:57:34 +00:00
|
|
|
extern fraction_t best_he(depth_t depth, const struct dive *dive, bool o2narcotic, fraction_t fo2);
|
2016-05-21 09:32:07 +00:00
|
|
|
|
2018-07-18 18:47:19 +00:00
|
|
|
extern int get_surface_pressure_in_mbar(const struct dive *dive, bool non_null);
|
|
|
|
extern int calculate_depth_to_mbar(int depth, pressure_t surface_pressure, int salinity);
|
2018-08-16 22:36:51 +00:00
|
|
|
extern int depth_to_mbar(int depth, const struct dive *dive);
|
|
|
|
extern double depth_to_bar(int depth, const struct dive *dive);
|
|
|
|
extern double depth_to_atm(int depth, const struct dive *dive);
|
|
|
|
extern int rel_mbar_to_depth(int mbar, const struct dive *dive);
|
|
|
|
extern int mbar_to_depth(int mbar, const struct dive *dive);
|
|
|
|
extern depth_t gas_mod(struct gasmix mix, pressure_t po2_limit, const struct dive *dive, int roundto);
|
|
|
|
extern depth_t gas_mnd(struct gasmix mix, depth_t end, const struct dive *dive, int roundto);
|
2016-07-06 12:40:31 +00:00
|
|
|
|
2012-11-11 09:36:46 +00:00
|
|
|
#define SURFACE_THRESHOLD 750 /* somewhat arbitrary: only below 75cm is it really diving */
|
|
|
|
|
2017-12-29 10:49:56 +00:00
|
|
|
extern bool autogroup;
|
2012-08-22 05:04:24 +00:00
|
|
|
|
Undo: fix multi-level undo of delete-dive and remove-dive-from-trip
The original undo-code was fundamentally broken. Not only did it leak
resources (copied trips were never freed), it also kept references
to trips or dives that could be changed by other commands. Thus,
anything more than a single undo could lead to crashes.
Two ways of fixing this were considered
1) Don't store pointers, but unique dive-ids and trip-ids.
Whereas such unique ids exist for dives, they would have to be
implemented for trips.
2) Don't free objects in the backend.
Instead, take ownership of deleted objects in the undo-object.
Thus, all references in previous undo-objects are guaranteed to
still exist (unless the objects are deleted elsewhere).
After some contemplation, the second method was chosen, because
it is significantly less intrusive. While touching the undo-objects,
clearly separate backend from ui-code, such that they can ultimately
be reused for mobile.
Note that if other parts of the code delete dives, crashes can still
be provoked. Notable examples are split/merge dives. These will have
to be fixed later. Nevertheless, the new code is a significant
improvement over the old state.
While touching the code, implement proper translation string based
on Qt's plural-feature (using %n).
Signed-off-by: Berthold Stoeger <bstoeger@mail.tuwien.ac.at>
2018-07-19 12:44:27 +00:00
|
|
|
struct dive *unregister_dive(int idx);
|
2012-11-11 06:49:19 +00:00
|
|
|
extern void delete_single_dive(int idx);
|
|
|
|
|
2020-04-19 19:39:59 +00:00
|
|
|
extern int quit, force_root, ignore_bt;
|
2019-11-23 12:02:41 +00:00
|
|
|
#ifdef SUBSURFACE_MOBILE_DESKTOP
|
|
|
|
extern char *testqml;
|
|
|
|
#endif
|
2011-08-31 01:40:25 +00:00
|
|
|
|
2018-12-10 13:49:32 +00:00
|
|
|
extern struct dive_table dive_table;
|
2014-07-02 18:50:28 +00:00
|
|
|
extern struct dive displayed_dive;
|
2014-05-19 05:39:34 +00:00
|
|
|
extern unsigned int dc_number;
|
Undo: select dives after add, remove, merge, split dive commands
Select the proper dives after the add, remove, split and merge
dives commands on undo *and* redo. Generally, select the added
dives. For undo of add, remember the pre-addition selection.
For redo of remove, select the closest dive to the first removed
dive.
The biggest part of the commit is the signal-interface between
the dive commands and the dive-list model and dive-list view.
This is done in two steps:
1) To the DiveTripModel in batches of trips. The dive trip model
transforms the dives into indices.
2) To the DiveListView. The DiveListView has to translate the
DiveTripModel indexes to actual indexes via its QSortFilterProxy-
model.
For code-reuse, derive all divelist-changing commands from a new base-class,
which has a flag that describes whether the divelist changed. The helper
functions which add and remove dives are made members of the base class and
set the flag is a selected dive is added or removed.
To properly detect when the current dive was deleted it
became necessary to turn the current dive from an index
to a pointer, because indices are not stable.
Unfortunately, in some cases an index was expected and these
places now have to transform the dive into an index. These
should be converted in due course.
Signed-off-by: Berthold Stoeger <bstoeger@mail.tuwien.ac.at>
2018-08-03 09:35:43 +00:00
|
|
|
extern struct dive *current_dive;
|
2013-03-18 01:07:59 +00:00
|
|
|
#define current_dc (get_dive_dc(current_dive, dc_number))
|
2017-10-19 13:29:59 +00:00
|
|
|
#define displayed_dc (get_dive_dc(&displayed_dive, dc_number))
|
2011-09-11 19:53:59 +00:00
|
|
|
|
2018-07-18 18:47:19 +00:00
|
|
|
extern struct dive *get_dive(int nr);
|
2019-09-22 19:44:16 +00:00
|
|
|
extern struct dive *get_dive_from_table(int nr, const struct dive_table *dt);
|
2018-08-16 22:36:51 +00:00
|
|
|
extern struct dive_site *get_dive_site_for_dive(const struct dive *dive);
|
|
|
|
extern const char *get_dive_country(const struct dive *dive);
|
|
|
|
extern const char *get_dive_location(const struct dive *dive);
|
|
|
|
extern unsigned int number_of_computers(const struct dive *dive);
|
2018-07-18 18:47:19 +00:00
|
|
|
extern struct divecomputer *get_dive_dc(struct dive *dive, int nr);
|
2015-09-22 19:32:27 +00:00
|
|
|
extern timestamp_t dive_endtime(const struct dive *dive);
|
|
|
|
|
2019-05-17 20:22:55 +00:00
|
|
|
extern struct dive *make_first_dc(const struct dive *d, int dc_number);
|
2019-05-19 16:40:04 +00:00
|
|
|
extern int count_divecomputers(const struct dive *d);
|
2019-05-19 12:27:10 +00:00
|
|
|
extern struct dive *clone_delete_divecomputer(const struct dive *d, int dc_number);
|
2019-03-31 08:20:13 +00:00
|
|
|
void split_divecomputer(const struct dive *src, int num, struct dive **out1, struct dive **out2);
|
2014-05-19 05:39:34 +00:00
|
|
|
|
2012-08-21 22:51:34 +00:00
|
|
|
/*
|
|
|
|
* Iterate over each dive, with the first parameter being the index
|
|
|
|
* iterator variable, and the second one being the dive one.
|
|
|
|
*
|
|
|
|
* I don't think anybody really wants the index, and we could make
|
|
|
|
* it local to the for-loop, but that would make us requires C99.
|
|
|
|
*/
|
2014-02-28 04:09:57 +00:00
|
|
|
#define for_each_dive(_i, _x) \
|
2014-03-05 20:19:45 +00:00
|
|
|
for ((_i) = 0; ((_x) = get_dive(_i)) != NULL; (_i)++)
|
2012-08-21 22:51:34 +00:00
|
|
|
|
2014-02-28 04:09:57 +00:00
|
|
|
#define for_each_dc(_dive, _dc) \
|
2014-03-05 20:19:45 +00:00
|
|
|
for (_dc = &_dive->dc; _dc; _dc = _dc->next)
|
2013-02-09 00:15:18 +00:00
|
|
|
|
2018-07-18 18:47:19 +00:00
|
|
|
extern struct dive *get_dive_by_uniq_id(int id);
|
|
|
|
extern int get_idx_by_uniq_id(int id);
|
2018-08-16 22:36:51 +00:00
|
|
|
extern bool dive_site_has_gps_location(const struct dive_site *ds);
|
|
|
|
extern int dive_has_gps_location(const struct dive *dive);
|
2019-04-24 21:59:59 +00:00
|
|
|
extern location_t dive_get_gps_location(const struct dive *d);
|
2018-07-18 18:47:19 +00:00
|
|
|
|
2013-10-05 07:29:09 +00:00
|
|
|
extern bool dive_within_time_range(struct dive *dive, timestamp_t when, timestamp_t offset);
|
2015-06-25 05:38:44 +00:00
|
|
|
extern bool time_during_dive_with_offset(struct dive *dive, timestamp_t when, timestamp_t offset);
|
2013-01-31 03:09:16 +00:00
|
|
|
struct dive *find_dive_n_near(timestamp_t when, int n, timestamp_t offset);
|
2013-01-29 22:25:09 +00:00
|
|
|
|
|
|
|
/* Check if two dive computer entries are the exact same dive (-1=no/0=maybe/1=yes) */
|
2018-08-23 17:18:43 +00:00
|
|
|
extern int match_one_dc(const struct divecomputer *a, const struct divecomputer *b);
|
2013-01-29 22:25:09 +00:00
|
|
|
|
2011-08-31 17:20:46 +00:00
|
|
|
extern void parse_xml_init(void);
|
2019-02-28 21:45:17 +00:00
|
|
|
extern int parse_xml_buffer(const char *url, const char *buf, int size, struct dive_table *table, struct trip_table *trips, struct dive_site_table *sites, const char **params);
|
2012-09-18 15:33:55 +00:00
|
|
|
extern void parse_xml_exit(void);
|
2017-12-10 21:22:13 +00:00
|
|
|
extern void set_filename(const char *filename);
|
2011-08-31 01:40:25 +00:00
|
|
|
|
2014-03-14 17:11:26 +00:00
|
|
|
extern int save_dives(const char *filename);
|
2018-09-10 12:47:56 +00:00
|
|
|
extern int save_dives_logic(const char *filename, bool select_only, bool anonymize);
|
|
|
|
extern int save_dive(FILE *f, struct dive *dive, bool anonymize);
|
2020-02-06 21:56:10 +00:00
|
|
|
extern int export_dives_xslt(const char *filename, bool selected, const int units, const char *export_xslt, bool anonymize);
|
2014-03-12 21:12:58 +00:00
|
|
|
|
2019-09-21 12:10:53 +00:00
|
|
|
extern int save_dive_sites_logic(const char *filename, const struct dive_site *sites[], int nr_sites, bool anonymize);
|
2019-04-06 19:05:18 +00:00
|
|
|
|
2015-04-28 18:27:36 +00:00
|
|
|
struct membuffer;
|
2018-09-10 12:47:56 +00:00
|
|
|
extern void save_one_dive_to_mb(struct membuffer *b, struct dive *dive, bool anonymize);
|
2015-04-28 18:27:36 +00:00
|
|
|
|
2017-11-02 23:51:33 +00:00
|
|
|
extern void subsurface_console_init(void);
|
2014-03-25 14:55:56 +00:00
|
|
|
extern void subsurface_console_exit(void);
|
2016-03-25 08:21:45 +00:00
|
|
|
extern bool subsurface_user_is_root(void);
|
2013-12-19 13:00:50 +00:00
|
|
|
|
2014-03-20 20:57:49 +00:00
|
|
|
extern timestamp_t get_times();
|
2013-11-18 13:53:05 +00:00
|
|
|
|
2012-09-20 00:35:52 +00:00
|
|
|
extern timestamp_t utc_mktime(struct tm *tm);
|
|
|
|
extern void utc_mkdate(timestamp_t, struct tm *tm);
|
2011-09-12 20:25:05 +00:00
|
|
|
|
2011-09-12 19:56:34 +00:00
|
|
|
extern struct dive *alloc_dive(void);
|
2018-09-27 19:55:03 +00:00
|
|
|
extern void free_dive(struct dive *);
|
2019-10-06 08:48:41 +00:00
|
|
|
extern void free_dive_dcs(struct divecomputer *dc);
|
2015-01-09 22:35:31 +00:00
|
|
|
extern void record_dive_to_table(struct dive *dive, struct dive_table *table);
|
2014-07-02 22:29:02 +00:00
|
|
|
extern void clear_dive(struct dive *dive);
|
2018-08-23 17:18:43 +00:00
|
|
|
extern void copy_dive(const struct dive *s, struct dive *d);
|
|
|
|
extern void selective_copy_dive(const struct dive *s, struct dive *d, struct dive_components what, bool clear);
|
2019-05-19 16:28:56 +00:00
|
|
|
extern struct dive *move_dive(struct dive *s);
|
2011-09-12 19:56:34 +00:00
|
|
|
|
2018-05-05 17:26:48 +00:00
|
|
|
extern void alloc_samples(struct divecomputer *dc, int num);
|
2018-06-20 00:20:32 +00:00
|
|
|
extern void free_samples(struct divecomputer *dc);
|
2012-11-24 02:51:27 +00:00
|
|
|
extern struct sample *prepare_sample(struct divecomputer *dc);
|
|
|
|
extern void finish_sample(struct divecomputer *dc);
|
2018-08-23 17:18:43 +00:00
|
|
|
extern struct sample *add_sample(const struct sample *sample, int time, struct divecomputer *dc);
|
2017-07-26 01:33:10 +00:00
|
|
|
extern void add_sample_pressure(struct sample *sample, int sensor, int mbar);
|
2018-08-23 17:18:43 +00:00
|
|
|
extern int legacy_format_o2pressures(const struct dive *dive, const struct divecomputer *dc);
|
2011-09-12 19:56:34 +00:00
|
|
|
|
2018-08-26 12:42:38 +00:00
|
|
|
extern bool dive_less_than(const struct dive *a, const struct dive *b);
|
2018-11-10 08:07:42 +00:00
|
|
|
extern bool dive_or_trip_less_than(struct dive_or_trip a, struct dive_or_trip b);
|
2018-11-24 09:11:07 +00:00
|
|
|
extern void sort_dive_table(struct dive_table *table);
|
2011-09-03 20:19:26 +00:00
|
|
|
extern struct dive *fixup_dive(struct dive *dive);
|
2019-04-30 10:42:33 +00:00
|
|
|
extern pressure_t calculate_surface_pressure(const struct dive *dive);
|
|
|
|
extern pressure_t un_fixup_surface_pressure(const struct dive *d);
|
2014-08-04 14:36:07 +00:00
|
|
|
extern void fixup_dc_duration(struct divecomputer *dc);
|
2018-07-17 21:05:03 +00:00
|
|
|
extern int dive_getUniqID();
|
2018-08-23 17:18:43 +00:00
|
|
|
extern unsigned int dc_airtemp(const struct divecomputer *dc);
|
|
|
|
extern unsigned int dc_watertemp(const struct divecomputer *dc);
|
2018-12-09 12:17:45 +00:00
|
|
|
extern int split_dive(const struct dive *dive, struct dive **new1, struct dive **new2);
|
|
|
|
extern int split_dive_at_time(const struct dive *dive, duration_t time, struct dive **new1, struct dive **new2);
|
2019-03-05 21:58:47 +00:00
|
|
|
extern struct dive *merge_dives(const struct dive *a, const struct dive *b, int offset, bool prefer_downloaded, struct dive_trip **trip, struct dive_site **site);
|
2013-10-05 07:29:09 +00:00
|
|
|
extern struct dive *try_to_merge(struct dive *a, struct dive *b, bool prefer_downloaded);
|
2015-12-04 05:42:23 +00:00
|
|
|
extern struct event *clone_event(const struct event *src_ev);
|
2018-08-23 17:18:43 +00:00
|
|
|
extern void copy_events(const struct divecomputer *s, struct divecomputer *d);
|
2020-04-12 11:39:01 +00:00
|
|
|
extern void copy_events_until(const struct dive *sd, struct dive *dd, int time);
|
2015-04-23 22:24:02 +00:00
|
|
|
extern void free_events(struct event *ev);
|
2019-08-04 16:44:57 +00:00
|
|
|
extern void copy_cylinders(const struct cylinder_table *s, struct cylinder_table *d);
|
|
|
|
extern void copy_used_cylinders(const struct dive *s, struct dive *d, bool used_only);
|
2018-08-23 17:18:43 +00:00
|
|
|
extern void copy_samples(const struct divecomputer *s, struct divecomputer *d);
|
|
|
|
extern bool is_cylinder_used(const struct dive *dive, int idx);
|
|
|
|
extern bool is_cylinder_prot(const struct dive *dive, int idx);
|
First step in cleaning up cylinder pressure sensor logic
This clarifies/changes the meaning of our "cylinderindex" entry in our
samples. It has been rather confused, because different dive computers
have done things differently, and the naming really hasn't helped.
There are two totally different - and independent - cylinder "indexes":
- the pressure sensor index, which indicates which cylinder the sensor
data is from.
- the "active cylinder" index, which indicates which cylinder we actually
breathe from.
These two values really are totally independent, and have nothing
what-so-ever to do with each other. The sensor index may well be fixed:
many dive computers only support a single pressure sensor (whether
wireless or wired), and the sensor index is thus always zero.
Other dive computers may support multiple pressure sensors, and the gas
switch event may - or may not - indicate that the sensor changed too. A
dive computer might give the sensor data for *all* cylinders it can read,
regardless of which one is the one we're actively breathing. In fact, some
dive computers might give sensor data for not just *your* cylinder, but
your buddies.
This patch renames "cylinderindex" in the samples as "sensor", making it
quite clear that it's about which sensor index the pressure data in the
sample is about.
The way we figure out which is the currently active gas is with an
explicit has change event. If a computer (like the Uemis Zurich) joins the
two concepts together, then a sensor change should also create a gas
switch event. This patch also changes the Uemis importer to do that.
Finally, it should be noted that the plot info works totally separately
from the sample data, and is about what we actually *display*, not about
the sample pressures etc. In the plot info, the "cylinderindex" does in
fact mean the currently active cylinder, and while it is initially set to
match the sensor information from the samples, we then walk the gas change
events and fix it up - and if the active cylinder differs from the sensor
cylinder, we clear the sensor data.
[Dirk Hohndel: this conflicted with some of my recent changes - I think
I merged things correctly...]
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2012-12-31 04:00:51 +00:00
|
|
|
extern void add_gas_switch_event(struct dive *dive, struct divecomputer *dc, int time, int idx);
|
2020-03-03 19:03:56 +00:00
|
|
|
extern struct event *create_event(unsigned int time, int type, int flags, int value, const char *name);
|
2020-03-04 18:41:40 +00:00
|
|
|
extern struct event *create_gas_switch_event(struct dive *dive, struct divecomputer *dc, int seconds, int idx);
|
2020-03-04 17:13:02 +00:00
|
|
|
extern struct event *clone_event_rename(const struct event *ev, const char *name);
|
2020-03-03 19:03:56 +00:00
|
|
|
extern void add_event_to_dc(struct divecomputer *dc, struct event *ev);
|
2020-03-04 17:13:02 +00:00
|
|
|
extern void swap_event(struct divecomputer *dc, struct event *from, struct event *to);
|
|
|
|
extern bool same_event(const struct event *a, const struct event *b);
|
2016-03-10 02:18:58 +00:00
|
|
|
extern struct event *add_event(struct divecomputer *dc, unsigned int time, int type, int flags, int value, const char *name);
|
2020-03-03 20:48:08 +00:00
|
|
|
extern void remove_event_from_dc(struct divecomputer *dc, struct event *event);
|
2018-08-16 22:58:30 +00:00
|
|
|
extern void update_event_name(struct dive *d, struct event *event, const char *name);
|
2014-11-07 06:02:22 +00:00
|
|
|
extern void add_extra_data(struct divecomputer *dc, const char *key, const char *value);
|
2018-08-23 17:18:43 +00:00
|
|
|
extern void per_cylinder_mean_depth(const struct dive *dive, struct divecomputer *dc, int *mean, int *duration);
|
2018-08-16 22:58:30 +00:00
|
|
|
extern int get_cylinder_index(const struct dive *dive, const struct event *ev);
|
|
|
|
extern struct gasmix get_gasmix_from_event(const struct dive *, const struct event *ev);
|
2018-08-23 17:18:43 +00:00
|
|
|
extern int nr_cylinders(const struct dive *dive);
|
|
|
|
extern int nr_weightsystems(const struct dive *dive);
|
2011-09-23 01:02:54 +00:00
|
|
|
|
2011-09-20 19:40:34 +00:00
|
|
|
/* UI related protopypes */
|
|
|
|
|
2011-10-25 07:29:19 +00:00
|
|
|
extern void remember_event(const char *eventname);
|
2016-04-03 22:31:59 +00:00
|
|
|
extern void invalidate_dive_cache(struct dive *dc);
|
2013-10-09 07:14:39 +00:00
|
|
|
|
2013-01-31 13:07:04 +00:00
|
|
|
extern void clear_events(void);
|
2011-10-23 06:47:19 +00:00
|
|
|
|
2012-12-13 06:26:29 +00:00
|
|
|
extern void set_dc_nickname(struct dive *dive);
|
2013-10-05 07:29:09 +00:00
|
|
|
extern void set_autogroup(bool value);
|
2018-08-23 17:18:43 +00:00
|
|
|
extern int total_weight(const struct dive *);
|
2012-12-13 06:26:29 +00:00
|
|
|
|
2011-09-05 20:14:53 +00:00
|
|
|
#define DIVE_ERROR_PARSE 1
|
2013-02-13 23:03:25 +00:00
|
|
|
#define DIVE_ERROR_PLAN 2
|
2011-09-05 20:14:53 +00:00
|
|
|
|
2011-09-20 05:09:47 +00:00
|
|
|
const char *monthname(int mon);
|
|
|
|
|
2012-09-16 03:51:06 +00:00
|
|
|
extern const char *existing_filename;
|
2013-10-05 07:29:09 +00:00
|
|
|
extern void subsurface_command_line_init(int *, char ***);
|
|
|
|
extern void subsurface_command_line_exit(int *, char ***);
|
2011-12-31 16:15:59 +00:00
|
|
|
|
2019-01-01 17:02:04 +00:00
|
|
|
extern bool is_dc_planner(const struct divecomputer *dc);
|
2019-01-01 17:49:56 +00:00
|
|
|
extern bool has_planned(const struct dive *dive, bool planned);
|
|
|
|
|
2018-08-16 22:58:30 +00:00
|
|
|
/* Since C doesn't have parameter-based overloading, two versions of get_next_event. */
|
|
|
|
extern const struct event *get_next_event(const struct event *event, const char *name);
|
|
|
|
extern struct event *get_next_event_mutable(struct event *event, const char *name);
|
2013-03-28 02:04:46 +00:00
|
|
|
|
2018-08-16 15:11:51 +00:00
|
|
|
/* Get gasmixes at increasing timestamps.
|
2018-08-16 11:35:14 +00:00
|
|
|
* In "evp", pass a pointer to a "struct event *" which is NULL-initialized on first invocation.
|
|
|
|
* On subsequent calls, pass the same "evp" and the "gasmix" from previous calls.
|
|
|
|
*/
|
2018-08-16 22:58:30 +00:00
|
|
|
extern struct gasmix get_gasmix(const struct dive *dive, const struct divecomputer *dc, int time, const struct event **evp, struct gasmix gasmix);
|
Add "get_gasmix()" helper function to iterate over gas changes
We have a few places that used to get the gasmix by looking at the
sensor index in the plot data, which really doesn't work any more.
To make it easier for those users to convert to the new world order,
this adds a "get_gasmix()" function. The gasmix function takes as its
argument the dive, the dive computer, and the time.
In addition, for good performance (to avoid looping over the event list
over and over and over again) it maintains a pointer to the next gas
switch event, and the previous gas. Those need to be initialized to
NULL by the caller, so the standard use-case pattern basically looks
like this:
struct gasmix *gasmix = NULL;
struct event *ev = NULL;
loop over samples or plot events in increasing time order: {
...
gasmix = get_gasmix(dive, dc, time, &ev, gasmix);
...
}
and then you can see what the currently breathing gas is at that time.
If for some reason you need to walk backwards in time, you can just pass
in a NULL gasmix again, which will reset the event iterator (at the cost
of now having to walk all the events again).
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
Signed-off-by: Dirk Hohndel <dirk@hohndel.org>
2017-07-28 17:22:17 +00:00
|
|
|
|
2018-08-16 15:11:51 +00:00
|
|
|
/* Get gasmix at a given time */
|
2018-08-16 22:58:30 +00:00
|
|
|
extern struct gasmix get_gasmix_at_time(const struct dive *dive, const struct divecomputer *dc, duration_t time);
|
2018-08-16 15:11:51 +00:00
|
|
|
|
2013-05-24 01:38:45 +00:00
|
|
|
/* these structs holds the information that
|
|
|
|
* describes the cylinders / weight systems.
|
|
|
|
* they are global variables initialized in equipment.c
|
2013-04-15 18:04:35 +00:00
|
|
|
* used to fill the combobox in the add/edit cylinder
|
|
|
|
* dialog
|
|
|
|
*/
|
|
|
|
|
2018-03-03 09:10:51 +00:00
|
|
|
extern void set_informational_units(const char *units);
|
|
|
|
extern void set_git_prefs(const char *prefs);
|
2014-04-11 06:17:35 +00:00
|
|
|
|
2018-03-13 21:12:23 +00:00
|
|
|
extern char *get_dive_date_c_string(timestamp_t when);
|
2018-08-16 22:58:30 +00:00
|
|
|
extern void update_setpoint_events(const struct dive *dive, struct divecomputer *dc);
|
2018-05-11 15:25:41 +00:00
|
|
|
|
2018-11-22 07:06:07 +00:00
|
|
|
#ifdef __cplusplus
|
|
|
|
}
|
|
|
|
|
2019-09-25 19:28:46 +00:00
|
|
|
/* Make pointers to dive and dive_trip "Qt metatypes" so that they can be passed through
|
|
|
|
* QVariants and through QML.
|
|
|
|
*/
|
2019-03-04 22:20:29 +00:00
|
|
|
#include <QObject>
|
2018-11-22 07:06:07 +00:00
|
|
|
Q_DECLARE_METATYPE(struct dive *);
|
|
|
|
|
|
|
|
#endif
|
|
|
|
|
2013-01-11 01:26:10 +00:00
|
|
|
#include "pref.h"
|
|
|
|
|
2014-02-11 18:14:46 +00:00
|
|
|
#endif // DIVE_H
|