// SPDX-License-Identifier: GPL-2.0 #include "qt-models/divetripmodel.h" #include "core/divefilter.h" #include "core/gettextfromc.h" #include "core/metrics.h" #include "core/selection.h" #include "core/trip.h" #include "core/qthelper.h" #include "core/divesite.h" #include "core/subsurface-string.h" #include "core/tag.h" #include "qt-models/divelocationmodel.h" // For the dive-site field ids #include "commands/command.h" #include #include #include #include // 1) Base functions static int nitrox_sort_value(const struct dive *dive) { int o2, he, o2max; get_dive_gas(dive, &o2, &he, &o2max); return he * 1000 + o2; } static QVariant dive_table_alignment(int column) { switch (column) { case DiveTripModelBase::DEPTH: case DiveTripModelBase::DURATION: case DiveTripModelBase::TEMPERATURE: case DiveTripModelBase::TOTALWEIGHT: case DiveTripModelBase::SAC: case DiveTripModelBase::OTU: case DiveTripModelBase::MAXCNS: // Right align numeric columns return int(Qt::AlignRight | Qt::AlignVCenter); // NR needs to be left aligned because its the indent marker for trips too case DiveTripModelBase::NR: case DiveTripModelBase::DATE: case DiveTripModelBase::RATING: case DiveTripModelBase::SUIT: case DiveTripModelBase::CYLINDER: case DiveTripModelBase::GAS: case DiveTripModelBase::TAGS: case DiveTripModelBase::PHOTOS: case DiveTripModelBase::COUNTRY: case DiveTripModelBase::BUDDIES: case DiveTripModelBase::LOCATION: return int(Qt::AlignLeft | Qt::AlignVCenter); } return QVariant(); } QVariant DiveTripModelBase::tripData(const dive_trip *trip, int column, int role) { if (role == TRIP_ROLE) return QVariant::fromValue(const_cast(trip)); // Not nice: casting away a const if (role == Qt::DisplayRole) { switch (column) { case DiveTripModelBase::NR: QString shownText; bool oneDayTrip = trip_is_single_day(trip); int countShown = trip_shown_dives(trip); if (countShown < trip->dives.nr) shownText = tr("(%1 shown)").arg(countShown); if (!empty_string(trip->location)) return QString(trip->location) + ", " + get_trip_date_string(trip_date(trip), trip->dives.nr, oneDayTrip) + " "+ shownText; else return get_trip_date_string(trip_date(trip), trip->dives.nr, oneDayTrip) + shownText; } } return QVariant(); } static const QString icon_names[4] = { QStringLiteral(":zero"), QStringLiteral(":photo-in-icon"), QStringLiteral(":photo-out-icon"), QStringLiteral(":photo-in-out-icon") }; static int countPhotos(const struct dive *d) { // Determine whether dive has pictures, and whether they were taken during or before/after dive. const int bufperiod = 120; // A 2-min buffer period. Photos within 2 min of dive are assumed as int diveTotaltime = dive_endtime(d) - d->when; // taken during the dive, not before/after. int pic_offset, icon_index = 0; FOR_EACH_PICTURE (d) { // Step through each of the pictures for this dive: pic_offset = picture->offset.seconds; if ((pic_offset < -bufperiod) | (pic_offset > diveTotaltime+bufperiod)) { icon_index |= 0x02; // If picture is before/after the dive // then set the appropriate bit ... } else { icon_index |= 0x01; // else set the bit for picture during the dive } } return icon_index; // return value: 0=no pictures; 1=pictures during dive; } // 2=pictures before/after; 3=pictures during as well as before/after static QString displayDuration(const struct dive *d) { if (prefs.units.show_units_table) return get_dive_duration_string(d->duration.seconds, gettextFromC::tr("h"), gettextFromC::tr("min"), "", ":", d->dc.divemode == FREEDIVE); else return get_dive_duration_string(d->duration.seconds, "", "", "", ":", d->dc.divemode == FREEDIVE); } static QString displayTemperature(const struct dive *d, bool units) { if (!d->watertemp.mkelvin) return QString(); return get_temperature_string(d->watertemp, units); } static QString displaySac(const struct dive *d, bool units) { if (!d->sac) return QString(); QString s = get_volume_string(d->sac, units); return units ? s + gettextFromC::tr("/min") : s; } static QString displayWeight(const struct dive *d, bool units) { QString s = weight_string(total_weight(d)); if (!units) return s; else if (get_units()->weight == units::KG) return s + gettextFromC::tr("kg"); else return s + gettextFromC::tr("lbs"); } QVariant DiveTripModelBase::diveData(const struct dive *d, int column, int role) { switch (role) { case Qt::TextAlignmentRole: return dive_table_alignment(column); case Qt::DisplayRole: switch (column) { case NR: return d->number; case DATE: return get_dive_date_string(d->when); case DEPTH: return get_depth_string(d->maxdepth, prefs.units.show_units_table); case DURATION: return displayDuration(d); case TEMPERATURE: return displayTemperature(d, prefs.units.show_units_table); case TOTALWEIGHT: return displayWeight(d, prefs.units.show_units_table); case SUIT: return QString(d->suit); case CYLINDER: return d->cylinders.nr > 0 ? QString(get_cylinder(d, 0)->type.description) : QString(); case SAC: return displaySac(d, prefs.units.show_units_table); case OTU: return d->otu; case MAXCNS: if (prefs.units.show_units_table) return QString("%1%").arg(d->maxcns); else return d->maxcns; case TAGS: return get_taglist_string(d->tag_list); case PHOTOS: break; case COUNTRY: return QString(get_dive_country(d)); case BUDDIES: return QString(d->buddy); case LOCATION: return QString(get_dive_location(d)); case GAS: char *gas_string = get_dive_gas_string(d); QString ret(gas_string); free(gas_string); return ret; } break; case Qt::DecorationRole: switch (column) { //TODO: ADD A FLAG case COUNTRY: return QVariant(); case LOCATION: if (dive_has_gps_location(d)) { IconMetrics im = defaultIconMetrics(); return QIcon(":globe-icon").pixmap(im.sz_small, im.sz_small); } break; case PHOTOS: if (d->picture_list) { IconMetrics im = defaultIconMetrics(); return QIcon(icon_names[countPhotos(d)]).pixmap(im.sz_small, im.sz_small); } // If there are photos, show one of the three photo icons: fish= photos during dive; break; // sun=photos before/after dive; sun+fish=photos during dive as well as before/after } break; case Qt::ToolTipRole: switch (column) { case NR: return tr("#"); case DATE: return tr("Date"); case RATING: return tr("Rating"); case DEPTH: return tr("Depth(%1)").arg((get_units()->length == units::METERS) ? tr("m") : tr("ft")); case DURATION: return tr("Duration"); case TEMPERATURE: return tr("Temp.(°%1)").arg((get_units()->temperature == units::CELSIUS) ? "C" : "F"); case TOTALWEIGHT: return tr("Weight(%1)").arg((get_units()->weight == units::KG) ? tr("kg") : tr("lbs")); case SUIT: return tr("Suit"); case CYLINDER: return tr("Cylinder"); case GAS: return tr("Gas"); case SAC: const char *unit; get_volume_units(0, NULL, &unit); return tr("SAC(%1)").arg(QString(unit).append(tr("/min"))); case OTU: return tr("OTU"); case MAXCNS: return tr("Max. CNS"); case TAGS: return tr("Tags"); case PHOTOS: return tr("Media before/during/after dive"); case COUNTRY: return tr("Country"); case BUDDIES: return tr("Buddy"); case LOCATION: return tr("Location"); } break; case STAR_ROLE: return d->rating; case DIVE_ROLE: return QVariant::fromValue(const_cast(d)); // Not nice: casting away a const case DIVE_IDX: return get_divenr(d); case SELECTED_ROLE: return d->selected; } return QVariant(); } QVariant DiveTripModelBase::headerData(int section, Qt::Orientation orientation, int role) const { if (orientation == Qt::Vertical) return QVariant(); switch (role) { case Qt::TextAlignmentRole: return dive_table_alignment(section); case Qt::FontRole: return defaultModelFont(); case Qt::InitialSortOrderRole: // By default, sort NR and DATE descending, everything else ascending. return section == NR || section == DATE ? Qt::DescendingOrder : Qt::AscendingOrder; case Qt::DisplayRole: switch (section) { case NR: return tr("#"); case DATE: return tr("Date"); case RATING: return tr("Rating"); case DEPTH: return tr("Depth"); case DURATION: return tr("Duration"); case TEMPERATURE: return tr("Temp."); case TOTALWEIGHT: return tr("Weight"); case SUIT: return tr("Suit"); case CYLINDER: return tr("Cylinder"); case GAS: return tr("Gas"); case SAC: return tr("SAC"); case OTU: return tr("OTU"); case MAXCNS: return tr("Max CNS"); case TAGS: return tr("Tags"); case PHOTOS: return tr("Media"); case COUNTRY: return tr("Country"); case BUDDIES: return tr("Buddy"); case LOCATION: return tr("Location"); } break; case Qt::ToolTipRole: switch (section) { case NR: return tr("#"); case DATE: return tr("Date"); case RATING: return tr("Rating"); case DEPTH: return tr("Depth(%1)").arg((get_units()->length == units::METERS) ? tr("m") : tr("ft")); case DURATION: return tr("Duration"); case TEMPERATURE: return tr("Temp.(°%1)").arg((get_units()->temperature == units::CELSIUS) ? "C" : "F"); case TOTALWEIGHT: return tr("Weight(%1)").arg((get_units()->weight == units::KG) ? tr("kg") : tr("lbs")); case SUIT: return tr("Suit"); case CYLINDER: return tr("Cylinder"); case GAS: return tr("Gas"); case SAC: const char *unit; get_volume_units(0, NULL, &unit); return tr("SAC(%1)").arg(QString(unit).append(tr("/min"))); case OTU: return tr("OTU"); case MAXCNS: return tr("Max CNS"); case TAGS: return tr("Tags"); case PHOTOS: return tr("Media before/during/after dive"); case BUDDIES: return tr("Buddy"); case LOCATION: return tr("Location"); } break; } return QVariant(); } // After resetting the model, the higher up model or view may call this // function to get informed on the current selection. // TODO: Currently, this reads and resets the selection. Make this more // efficient by maintaining a list of selected dives. void DiveTripModelBase::initSelection() { std::vector dives = getDiveSelection(); if (!dives.empty()) setSelection(dives, current_dive); else select_newest_visible_dive(); } void DiveTripModelBase::clear() { beginResetModel(); clear_dive_file_data(); clearData(); emit diveListNotifier.divesSelected({}, nullptr); // Inform profile, etc of changed selection endResetModel(); } void DiveTripModelBase::reset() { beginResetModel(); clearData(); populate(); endResetModel(); initSelection(); } DiveTripModelBase::DiveTripModelBase(QObject *parent) : QAbstractItemModel(parent) { } int DiveTripModelBase::columnCount(const QModelIndex&) const { return COLUMNS; } Qt::ItemFlags DiveTripModelBase::flags(const QModelIndex &index) const { dive *d = diveOrNull(index); Qt::ItemFlags base = Qt::ItemIsEnabled | Qt::ItemIsSelectable; // Only dives have editable fields and only the number is editable return d && index.column() == NR ? base | Qt::ItemIsEditable : base; } bool DiveTripModelBase::setData(const QModelIndex &index, const QVariant &value, int role) { // We only support setting of data for dives and there, only the number. dive *d = diveOrNull(index); if (!d) return false; if (role != Qt::EditRole) return false; if (index.column() != NR) return false; int v = value.toInt(); if (v == 0) return false; // Only accept numbers that are not already in use by other dives. int i; struct dive *dive; for_each_dive (i, dive) { if (dive->number == v) return false; } Command::editNumber(v, d); return true; } // Find a range of matching elements in a vector. // Input parameters: // v: vector to be searched // first: first element to search // cond: a function that is fed elements and returns an integer: // - >0: matches // - 0: doesn't match // - <0: stop searching, no more elements will be found // cond is called exactly once per element and from the beginning of the range. // Returns a pair [first, last) with usual C++ semantics: last-first is the size of the found range. // If no items were found, first and last are set to the size of the vector. template std::pair findRangeIf(const Vector &v, int first, Predicate cond) { int size = (int)v.size(); for (int i = first; i < size; ++i) { int res = cond(v[i]); if (res > 0) { for (int j = i + 1; j < size; ++j) { if (cond(v[j]) <= 0) return { i, j }; } return { i, size }; } else if (res < 0) { break; } } return { size, size }; } // Ideally, Qt's model/view functions are processed in batches of contiguous // items. Therefore, this template is used to process actions on ranges of // contiguous elements of a vector. // Input paremeters: // - items: vector to process, wich must allow random access via [] and the size() function // - cond: a predicate that is tested for each element. contiguous ranges of elements which // test for true are collected. cond is fed an element and should return: // - >0: matches // - 0: doesn't match // - <0: stop searching, no more elements will be found // - action: action that is called with the vector, first and last element of the range. template void processRanges(Vector &items, Predicate cond, Action action) { // Note: the "i++" is correct: We know that the last element tested // negatively -> we can skip it. Thus we avoid checking any element // twice. for(int i = 0;; i++) { std::pair range = findRangeIf(items, i, cond); if (range.first >= (int)items.size()) break; int delta = action(items, range.first, range.second); i = range.second + delta; } } // processRangesZip() is a refined version of processRanges(), which operates on two vectors. // The vectors are supposed to be sorted equivalently. That is, the first matching // item will of the first vector will match to the first item of the second vector. // It is supposed that all elements of the second vector will match to an element of // the first vector. // Input parameters: // - items1: vector to process, wich must allow random access via [] and the size() function // - items2: second vector to process. every item in items2 must match to an item in items1 // in ascending order. // - cond1: a predicate that is tested for each element of items1 with the next unmatched element // of items2. returns a boolean // - action: action that is called with the vectors, first and last element of the first range // and first element of the last range. template void processRangesZip(Vector1 &items1, Vector2 &items2, Predicate cond, Action action) { int actItem = 0; processRanges(items1, [&](typename Vector1::const_reference &e) mutable -> int { // Condition. Marked mutable so that it can change actItem if (actItem >= items2.size()) return -1; // No more items -> bail if (!cond(e, items2[actItem])) return 0; ++actItem; return 1; }, [&](Vector1 &v1, int from, int to) { // Action return action(v1, items2, from, to, actItem); }); } // Add items from vector "v2" to vector "v1" in batches of contiguous objects. // The items are inserted at places according to a sort order determined by "comp". // "v1" and "v2" are supposed to be ordered accordingly. // TODO: We might use binary search with std::lower_bound(), but not sure if it's worth it. // Input parameters: // - v1: destination vector // - v2: source vector // - comp: compare-function, which is fed elements from v2 and v1. returns true for "insert here". // - adder: performs the insertion. Perameters: v1, v2, insertion index, from, to range in v2. template void addInBatches(Vector1 &v1, const Vector2 &v2, Comparator comp, Inserter insert) { int idx = 0; // Index where dives will be inserted int i, j; // Begin and end of range to insert for (i = 0; i < (int)v2.size(); i = j) { for (; idx < (int)v1.size() && !comp(v2[i], v1[idx]); ++idx) ; // Pass // We found the index of the first item to add. // Now search how many items we should insert there. if (idx == (int)v1.size()) { // We were at end -> insert the remaining items j = v2.size(); } else { for (j = i + 1; j < (int)v2.size() && comp(v2[j], v1[idx]); ++j) ; // Pass } // Now add the batch insert(v1, v2, idx, i, j); // Skip over inserted dives for searching the new insertion position plus one. // If we added at the end, the loop will end anyway. idx += j - i + 1; } } // 2) TreeModel functions DiveTripModelTree::DiveTripModelTree(QObject *parent) : DiveTripModelBase(parent) { // Stay informed of changes to the divelist connect(&diveListNotifier, &DiveListNotifier::divesAdded, this, &DiveTripModelTree::divesAdded); connect(&diveListNotifier, &DiveListNotifier::divesDeleted, this, &DiveTripModelTree::divesDeleted); connect(&diveListNotifier, &DiveListNotifier::divesChanged, this, &DiveTripModelTree::divesChanged); connect(&diveListNotifier, &DiveListNotifier::diveSiteChanged, this, &DiveTripModelTree::diveSiteChanged); connect(&diveListNotifier, &DiveListNotifier::divesMovedBetweenTrips, this, &DiveTripModelTree::divesMovedBetweenTrips); connect(&diveListNotifier, &DiveListNotifier::divesTimeChanged, this, &DiveTripModelTree::divesTimeChanged); connect(&diveListNotifier, &DiveListNotifier::divesSelected, this, &DiveTripModelTree::divesSelected); connect(&diveListNotifier, &DiveListNotifier::tripChanged, this, &DiveTripModelTree::tripChanged); connect(&diveListNotifier, &DiveListNotifier::filterReset, this, &DiveTripModelTree::filterReset); populate(); } void DiveTripModelTree::populate() { for (int i = 0; i < dive_table.nr ; ++i) { dive *d = get_dive(i); update_cylinder_related_info(d); dive_trip_t *trip = d->divetrip; // If this dive doesn't have a trip, add as top-level item. if (!trip) { items.emplace_back(d); continue; } // Check if that trip is already known to us: search for the first item // that corresponds to that trip auto it = std::find_if(items.begin(), items.end(), [trip](const Item &item) { return item.d_or_t.trip == trip; }); if (it == items.end()) { // We didn't find an entry for this trip -> add one items.emplace_back(trip, d); } else { // We found the trip -> simply add the dive it->dives.push_back(d); } } } int DiveTripModelTree::rowCount(const QModelIndex &parent) const { // No parent means top level - return the number of top-level items if (!parent.isValid()) return items.size(); // If the parent has a parent, this is a dive -> no entries if (parent.parent().isValid()) return 0; // If this is outside of our top-level list -> no entries int row = parent.row(); if (row < 0 || row >= (int)items.size()) return 0; // Only trips have items const Item &entry = items[parent.row()]; return entry.d_or_t.trip ? entry.dives.size() : 0; } void DiveTripModelList::clearData() { items.clear(); } static const quintptr noParent = ~(quintptr)0; // This is the "internalId" marker for top-level item QModelIndex DiveTripModelTree::index(int row, int column, const QModelIndex &parent) const { if (!hasIndex(row, column, parent)) return QModelIndex(); // In the "internalId", we store either ~0 for top-level items or the // index of the parent item. A top-level item has an invalid parent. return createIndex(row, column, parent.isValid() ? parent.row() : noParent); } QModelIndex DiveTripModelTree::parent(const QModelIndex &index) const { if (!index.isValid()) return QModelIndex(); // In the "internalId", we store either ~0 for top-level items // or the index of the parent item. quintptr id = index.internalId(); if (id == noParent) return QModelIndex(); // Parent must be top-level item return createIndex(id, 0, noParent); } DiveTripModelTree::Item::Item(dive_trip *t, const QVector &divesIn) : d_or_t{nullptr, t}, dives(std::vector(divesIn.begin(), divesIn.end())), shown(std::any_of(dives.begin(), dives.end(), [](dive *d){ return !d->hidden_by_filter; })) { } DiveTripModelTree::Item::Item(dive_trip *t, dive *d) : d_or_t{nullptr, t}, dives({ d }), shown(!d->hidden_by_filter) { } DiveTripModelTree::Item::Item(dive *d) : d_or_t{d, nullptr}, shown(!d->hidden_by_filter) { } bool DiveTripModelTree::Item::isDive(const dive *d) const { return d_or_t.dive == d; } dive *DiveTripModelTree::Item::getDive() const { return d_or_t.dive; } timestamp_t DiveTripModelTree::Item::when() const { return d_or_t.trip ? trip_date(d_or_t.trip) : d_or_t.dive->when; } dive_or_trip DiveTripModelTree::tripOrDive(const QModelIndex &index) const { if (!index.isValid()) return { nullptr, nullptr }; QModelIndex parent = index.parent(); // An invalid parent means that we're at the top-level if (!parent.isValid()) return items[index.row()].d_or_t; // Otherwise, we're at a leaf -> thats a dive return { items[parent.row()].dives[index.row()], nullptr }; } dive *DiveTripModelTree::diveOrNull(const QModelIndex &index) const { return tripOrDive(index).dive; } // Send data changed signals blockwise. Which entries are changed is collected // in the first parameter "changed". void DiveTripModelBase::sendShownChangedSignals(const std::vector &changed, quintptr parentIndex) { static const QVector roles { SHOWN_ROLE }; for (size_t i = 0; i < changed.size(); ++i) { // Find first and last block of changed items if (!changed[i]) continue; size_t j; for (j = i + 1; j < changed.size() && changed[j]; ++j) ; // Pass dataChanged(createIndex(i, 0, parentIndex), createIndex(j - 1, 0, parentIndex), roles); i = j - 1; } } // Applying the filter to trip-items is a bit tricky: // We only want to send changed-signals if one of the dives remains visible. // Because if no dive remains visible, we'll simply send a signal on the parent trip, // which will then be hidden and all the dives will be hidden implicitly as well. // Thus, do this in two passes: collect changed dives and only if any dive is visible, // send the signals. bool DiveTripModelTree::calculateFilterForTrip(const std::vector &dives, const DiveFilter *filter, quintptr parentIndex) { bool showTrip = false; std::vector changed; changed.reserve(dives.size()); for (dive *d: dives) { bool shown = filter->showDive(d); changed.push_back(filter_dive(d, shown)); showTrip |= shown; } // If any dive is shown, send changed-signals if (showTrip) sendShownChangedSignals(changed, parentIndex); return showTrip; } // This recalculates the filters and sends appropriate changed signals. // Attention: Since this uses / modifies the hidden_by_filter flag of the // core dive structure, only one DiveTripModel[Tree|List] must exist at // a given time! void DiveTripModelTree::filterReset() { // Collect the changes in a vector used later to send signals. // This could be solved more efficiently in one pass, but // doing it in two passes allows us to use a common function without // resorting to co-routines, lambdas or similar techniques. std::vector changed; changed.reserve(items.size()); dive *old_current = current_dive; { // This marker prevents the UI from getting notifications on selection changes. // It is active until the end of the scope. // This was actually designed for the undo-commands, so that they can do their work // without having the UI updated. // Here, it is used because invalidating the filter can generate numerous // selection changes, which do full ui reloads. Instead, do that all at once // as a consequence of the filterReset signal right after the local scope. auto marker = diveListNotifier.enterCommand(); DiveFilter *filter = DiveFilter::instance(); for (size_t i = 0; i < items.size(); ++i) { Item &item = items[i]; bool oldShown = item.shown; if (item.d_or_t.dive) { dive *d = item.d_or_t.dive; item.shown = filter->showDive(item.d_or_t.dive); filter_dive(d, item.shown); } else { // Trips are shown if any of the dives is shown item.shown = calculateFilterForTrip(item.dives, filter, i); } changed.push_back(item.shown != oldShown); } } // Send the data-changed signals if some items changed visibility. sendShownChangedSignals(changed, noParent); // Rerender all trip headers. TODO: be smarter about this and only rerender if the number // of shown dives changed. for (int idx = 0; idx < (int)items.size(); ++idx) { QModelIndex tripIndex = createIndex(idx, 0, noParent); dataChanged(tripIndex, tripIndex); } emit diveListNotifier.numShownChanged(); // If the current dive changed, instruct the UI of the changed selection // TODO: This is way to heavy, as it reloads the whole selection! if (old_current != current_dive) initSelection(); } QVariant DiveTripModelTree::data(const QModelIndex &index, int role) const { if (role == SHOWN_ROLE) { QModelIndex parent = index.parent(); // An invalid parent means that we're at the top-level if (!parent.isValid()) return items[index.row()].shown; return !items[parent.row()].dives[index.row()]->hidden_by_filter; } // Set the font for all items alike if (role == Qt::FontRole) return defaultModelFont(); dive_or_trip entry = tripOrDive(index); if (role == IS_TRIP_ROLE) return !!entry.trip; if (entry.trip) return tripData(entry.trip, index.column(), role); else if (entry.dive) return diveData(entry.dive, index.column(), role); else return QVariant(); } // After a trip changed, the top level might need to be reordered. // Move the item and send a "data-changed" signal. void DiveTripModelTree::topLevelChanged(int idx) { if (idx < 0 || idx >= (int)items.size()) return; // First, try to move backwards int newIdx = idx; while (newIdx > 0 && dive_or_trip_less_than(items[idx].d_or_t, items[newIdx - 1].d_or_t)) --newIdx; // If that didn't change, try to move forward if (newIdx == idx) { ++newIdx; while (newIdx < (int)items.size() && !dive_or_trip_less_than(items[idx].d_or_t, items[newIdx].d_or_t)) ++newIdx; } // If index changed, move items if (newIdx != idx && newIdx != idx + 1) { beginMoveRows(QModelIndex(), idx, idx, QModelIndex(), newIdx); moveInVector(items, idx, idx + 1, newIdx); endMoveRows(); } // If we moved the object backwards in the array, we have to // subtract one from the index to account for the removed object. if (newIdx > idx) --newIdx; // Finally, inform UI of changed trip header QModelIndex tripIdx = createIndex(newIdx, 0, noParent); dataChanged(tripIdx, tripIdx); } void DiveTripModelTree::addDivesToTrip(int trip, const QVector &dives) { // Construct the parent index, ie. the index of the trip. QModelIndex parent = createIndex(trip, 0, noParent); addInBatches(items[trip].dives, dives, [](dive *d, dive *d2) { return dive_less_than(d, d2); }, // comp [&](std::vector &items, const QVector &dives, int idx, int from, int to) { // inserter beginInsertRows(parent, idx, idx + to - from - 1); items.insert(items.begin() + idx, dives.begin() + from, dives.begin() + to); endInsertRows(); }); // If necessary, move the trip topLevelChanged(trip); } int DiveTripModelTree::findTripIdx(const dive_trip *trip) const { for (int i = 0; i < (int)items.size(); ++i) if (items[i].d_or_t.trip == trip) return i; return -1; } int DiveTripModelTree::findDiveIdx(const dive *d) const { for (int i = 0; i < (int)items.size(); ++i) if (items[i].isDive(d)) return i; return -1; } int DiveTripModelTree::findDiveInTrip(int tripIdx, const dive *d) const { const Item &item = items[tripIdx]; for (int i = 0; i < (int)item.dives.size(); ++i) if (item.dives[i] == d) return i; return -1; } int DiveTripModelTree::findInsertionIndex(const dive_trip *trip) const { dive_or_trip d_or_t{ nullptr, (dive_trip *)trip }; for (int i = 0; i < (int)items.size(); ++i) { if (dive_or_trip_less_than(d_or_t, items[i].d_or_t)) return i; } return items.size(); } // This function is used to compare a dive to an arbitrary entry (dive or trip). // For comparing two dives, use the core function dive_less_than_entry, which // effectively sorts by timestamp. // If comparing to a trip, the policy for equal-times is to place the dives // before the trip in the case of equal timestamps. bool DiveTripModelTree::dive_before_entry(const dive *d, const Item &entry) { dive_or_trip d_or_t { (dive *)d, nullptr }; return dive_or_trip_less_than(d_or_t, entry.d_or_t); } void DiveTripModelTree::divesAdded(dive_trip *trip, bool addTrip, const QVector &dives) { if (!trip) { // This is outside of a trip. Add dives at the top-level in batches. addInBatches(items, dives, &dive_before_entry, // comp [&](std::vector &items, const QVector &dives, int idx, int from, int to) { // inserter beginInsertRows(QModelIndex(), idx, idx + to - from - 1); items.insert(items.begin() + idx, dives.begin() + from, dives.begin() + to); endInsertRows(); }); } else if (addTrip) { // We're supposed to add the whole trip. Just insert the trip. int idx = findInsertionIndex(trip); // Find the place where to insert the trip beginInsertRows(QModelIndex(), idx, idx); items.insert(items.begin() + idx, { trip, dives }); endInsertRows(); } else { // Ok, we have to add dives to an existing trip // Find the trip... int idx = findTripIdx(trip); if (idx < 0) { // We don't know the trip - this shouldn't happen. We seem to have // missed some signals! qWarning() << "DiveTripModelTree::divesAdded(): unknown trip"; return; } // ...and add dives. addDivesToTrip(idx, dives); } } void DiveTripModelTree::divesDeleted(dive_trip *trip, bool deleteTrip, const QVector &dives) { if (!trip) { // This is outside of a trip. Delete top-level dives in batches. processRangesZip(items, dives, [](const Item &e, dive *d) { return e.getDive() == d; }, // Condition [&](std::vector &items, const QVector &, int from, int to, int) -> int { // Action beginRemoveRows(QModelIndex(), from, to - 1); items.erase(items.begin() + from, items.begin() + to); endRemoveRows(); return from - to; // Delta: negate the number of items deleted }); } else { // Find the trip int idx = findTripIdx(trip); if (idx < 0) { // We don't know the trip - this shouldn't happen. We seem to have // missed some signals! qWarning() << "DiveTripModelTree::divesDeleted(): unknown trip"; return; } if (deleteTrip) { // We're supposed to delete the whole trip. Nice, we don't have to // care about individual dives. Just remove the row. beginRemoveRows(QModelIndex(), idx, idx); items.erase(items.begin() + idx); endRemoveRows(); } else { // Construct the parent index, ie. the index of the trip. QModelIndex parent = createIndex(idx, 0, noParent); // Delete a number of dives in a trip. We do this range-wise. processRangesZip(items[idx].dives, dives, [](dive *d1, dive *d2) { return d1 == d2; }, // Condition [&](std::vector &diveList, const QVector &, int from, int to, int) -> int { // Action beginRemoveRows(parent, from, to - 1); diveList.erase(diveList.begin() + from, diveList.begin() + to); endRemoveRows(); return from - to; // Delta: negate the number of items deleted }); // If necessary, move the trip topLevelChanged(idx); } } } // The tree-version of the model wants to process the dives per trip. // This template takes a vector of dives and calls a function batchwise for each trip. template void processByTrip(QVector dives, Function action) { // Sort lexicographically by trip then according to the dive_less_than() function. std::sort(dives.begin(), dives.end(), [](const dive *d1, const dive *d2) { return d1->divetrip == d2->divetrip ? dive_less_than(d1, d2) : d1->divetrip < d2->divetrip; }); // Then, process the dives in batches by trip int i, j; // Begin and end of batch for (i = 0; i < dives.size(); i = j) { dive_trip *trip = dives[i]->divetrip; for (j = i + 1; j < dives.size() && dives[j]->divetrip == trip; ++j) ; // pass // Copy dives into a QVector. Some sort of "range_view" would be ideal. QVector divesInTrip(j - i); for (int k = i; k < j; ++k) divesInTrip[k - i] = dives[k]; // Finally, emit the signal action(trip, divesInTrip); } } // Helper function: collect the dives that are at the given dive site static QVector getDivesForSite(struct dive_site *ds) { QVector diveSiteDives; diveSiteDives.reserve(ds->dives.nr); for (int i = 0; i < ds->dives.nr; ++i) diveSiteDives.push_back(ds->dives.dives[i]); return diveSiteDives; } // On the change of which dive site field should we update the // dive in the list? static bool isInterestingDiveSiteField(int field) { return field == LocationInformationModel::NAME // dive site name can is shown in the dive list || field == LocationInformationModel::TAXONOMY // country is shown in the dive list || field == LocationInformationModel::LOCATION; // the globe icon in the dive list shows whether we have coordinates } void DiveTripModelTree::diveSiteChanged(dive_site *ds, int field) { if (!isInterestingDiveSiteField(field)) return; divesChanged(getDivesForSite(ds)); } void DiveTripModelTree::divesChanged(const QVector &dives) { processByTrip(dives, [this] (dive_trip *trip, const QVector &divesInTrip) { divesChangedTrip(trip, divesInTrip); }); } // Update visibility status of dive and return true if visibility changed static bool updateShown(const QVector &dives) { bool changed = false; DiveFilter *filter = DiveFilter::instance(); for (dive *d: dives) { bool newStatus = filter->showDive(d); changed |= filter_dive(d, newStatus); } if (changed) emit diveListNotifier.numShownChanged(); return changed; } void DiveTripModelTree::divesChangedTrip(dive_trip *trip, const QVector &dives) { bool diveChanged = updateShown(dives); if (!trip) { // This is outside of a trip. Process top-level items range-wise. // Since we know that the dive list is sorted, we will only ever search for the first element // in dives as this must be the first that we encounter. Once we find a range, increase the // index accordingly. processRangesZip(items, dives, [](const Item &e, dive *d) { return e.getDive() == d; }, // Condition [&](const std::vector &, const QVector &, int from, int to, int) -> int { // Action // TODO: We might be smarter about which columns changed! dataChanged(createIndex(from, 0, noParent), createIndex(to - 1, COLUMNS - 1, noParent)); return 0; // No items added or deleted }); } else { // Find the trip. int idx = findTripIdx(trip); if (idx < 0) { // We don't know the trip - this shouldn't happen. We seem to have // missed some signals! qWarning() << "DiveTripModelTree::divesChanged(): unknown trip"; return; } // Change the dives in the trip. We do this range-wise. processRangesZip(items[idx].dives, dives, std::equal_to(), // Condition: dive-pointers are equal [&](const std::vector &, const QVector &, int from, int to, int) -> int { // Action // TODO: We might be smarter about which columns changed! dataChanged(createIndex(from, 0, idx), createIndex(to - 1, COLUMNS - 1, idx)); return 0; // No items added or deleted }); // If necessary, move the trip topLevelChanged(idx); // If a dive changed, re-render the trip in the list [or actually make it (in)visible]. if (diveChanged) dataChanged(createIndex(idx, 0, noParent), createIndex(idx, 0, noParent)); } } void DiveTripModelTree::tripChanged(dive_trip *trip, TripField) { int idx = findTripIdx(trip); if (idx < 0) { // We don't know the trip - this shouldn't happen. We seem to have // missed some signals! qWarning() << "DiveTripModelTree::divesChanged(): unknown trip"; return; } dataChanged(createIndex(idx, 0, noParent), createIndex(idx, COLUMNS - 1, noParent)); } void DiveTripModelTree::divesMovedBetweenTrips(dive_trip *from, dive_trip *to, bool deleteFrom, bool createTo, const QVector &dives) { // Move dives between trips. This is an "interesting" problem, as we might // move from trip to trip, from trip to top-level or from top-level to trip. // Moreover, we might have to add a trip first or delete an old trip. // For simplicity, we will simply use the already existing divesAdded() / divesDeleted() // functions. This *is* cheating. But let's just try this and see how graceful // this is handled by Qt and if it gives some ugly UI behavior! // But first let's just rule out the trivial case: same-to-same trip move. if (from == to) return; // Cheating! // Unfortunately, removing the dives means that their selection is lost. // Thus, remember the selection and re-add it later. divesAdded(to, createTo, dives); divesDeleted(from, deleteFrom, dives); } void DiveTripModelTree::divesTimeChanged(timestamp_t delta, const QVector &dives) { processByTrip(dives, [this, delta] (dive_trip *trip, const QVector &divesInTrip) { divesTimeChangedTrip(trip, delta, divesInTrip); }); } void DiveTripModelTree::divesTimeChangedTrip(dive_trip *trip, timestamp_t delta, const QVector &dives) { // As in the case of divesMovedBetweenTrips(), this is a tricky, but solvable, problem. // We have to consider the direction (delta < 0 or delta >0) and that dives at their destination // position have different contiguous batches than at their original position. For now, // cheat and simply do a remove/add pair. Note that for this to work it is crucial the the // order of the dives don't change. This is indeed the case, as all starting-times were // moved by the same delta. // Cheating! // Unfortunately, removing the dives means that their selection is lost. // Thus, remember the selection and re-add it later. divesDeleted(trip, false, dives); divesAdded(trip, false, dives); } void DiveTripModelTree::divesSelected(const QVector &dives, dive *current) { // We got a number of dives that have been selected. Turn this into QModelIndexes and // emit a signal, so that views can change the selection. QVector indexes; indexes.reserve(dives.count()); processByTrip(dives, [this, &indexes] (dive_trip *trip, const QVector &divesInTrip) { divesSelectedTrip(trip, divesInTrip, indexes); }); emit selectionChanged(indexes); // The current dive has changed. Transform the current dive into an index and pass it on to the view. if (!current) { emit currentDiveChanged(QModelIndex()); // No current dive -> tell view to clear current index with an invalid index return; } dive_trip *trip = current->divetrip; if (!trip) { // Outside of a trip - search top-level. int idx = findDiveIdx(current); if (idx < 0) { // We don't know this dive. Something is wrong. Warn and bail. qWarning() << "DiveTripModelTree::diveSelected(): unknown top-level dive"; emit currentDiveChanged(QModelIndex()); return; } emit currentDiveChanged(createIndex(idx, 0, noParent)); } else { int idx = findTripIdx(trip); if (idx < 0) { // We don't know the trip - this shouldn't happen. Warn and bail. qWarning() << "DiveTripModelTree::diveSelected(): unknown trip"; emit currentDiveChanged(QModelIndex()); return; } int diveIdx = findDiveInTrip(idx, current); if (diveIdx < 0) { // We don't know this dive. Something is wrong. Warn and bail. qWarning() << "DiveTripModelTree::diveSelected(): unknown dive"; emit currentDiveChanged(QModelIndex()); return; } emit currentDiveChanged(createIndex(diveIdx, 0, idx)); } } void DiveTripModelTree::divesSelectedTrip(dive_trip *trip, const QVector &dives, QVector &indexes) { if (!trip) { // This is at the top level. // Since both lists are sorted, we can do this linearly. Perhaps a binary search // would be better? int j = 0; // Index in items array for (int i = 0; i < dives.size(); ++i) { while (j < (int)items.size() && !items[j].isDive(dives[i])) ++j; if (j >= (int)items.size()) break; indexes.append(createIndex(j, 0, noParent)); } } else { // Find the trip. int idx = findTripIdx(trip); if (idx < 0) { // We don't know the trip - this shouldn't happen. We seem to have // missed some signals! qWarning() << "DiveTripModelTree::diveSelectedTrip(): unknown trip"; return; } // Locate the indices inside the trip. // Since both lists are sorted, we can do this linearly. Perhaps a binary search // would be better? int j = 0; // Index in items array const Item &entry = items[idx]; for (int i = 0; i < dives.size(); ++i) { while (j < (int)entry.dives.size() && entry.dives[j] != dives[i]) ++j; if (j >= (int)entry.dives.size()) break; indexes.append(createIndex(j, 0, idx)); } } } bool DiveTripModelTree::lessThan(const QModelIndex &i1, const QModelIndex &i2) const { // In tree mode we don't support any sorting! // Simply keep the original position. return i1.row() < i2.row(); } // 3) ListModel functions DiveTripModelList::DiveTripModelList(QObject *parent) : DiveTripModelBase(parent) { // Stay informed of changes to the divelist connect(&diveListNotifier, &DiveListNotifier::divesAdded, this, &DiveTripModelList::divesAdded); connect(&diveListNotifier, &DiveListNotifier::divesDeleted, this, &DiveTripModelList::divesDeleted); connect(&diveListNotifier, &DiveListNotifier::divesChanged, this, &DiveTripModelList::divesChanged); connect(&diveListNotifier, &DiveListNotifier::diveSiteChanged, this, &DiveTripModelList::diveSiteChanged); // Does nothing in list-view //connect(&diveListNotifier, &DiveListNotifier::divesMovedBetweenTrips, this, &DiveTripModelList::divesMovedBetweenTrips); connect(&diveListNotifier, &DiveListNotifier::divesTimeChanged, this, &DiveTripModelList::divesTimeChanged); connect(&diveListNotifier, &DiveListNotifier::divesSelected, this, &DiveTripModelList::divesSelected); connect(&diveListNotifier, &DiveListNotifier::filterReset, this, &DiveTripModelList::filterReset); populate(); } void DiveTripModelList::populate() { // Fill model items.reserve(dive_table.nr); for (int i = 0; i < dive_table.nr ; ++i) items.push_back(get_dive(i)); } int DiveTripModelList::rowCount(const QModelIndex &parent) const { // In list-mode there is only one level, i.e only top-level // (=invalid parent) has items. return parent.isValid() ? 0 : items.size(); } void DiveTripModelTree::clearData() { items.clear(); } QModelIndex DiveTripModelList::index(int row, int column, const QModelIndex &parent) const { if (!hasIndex(row, column, parent)) return QModelIndex(); return createIndex(row, column); } QModelIndex DiveTripModelList::parent(const QModelIndex &index) const { // In list-mode there is only one level, i.e. no parent return QModelIndex(); } dive *DiveTripModelList::diveOrNull(const QModelIndex &index) const { int row = index.row(); if (row < 0 || row > (int)items.size()) return nullptr; return items[row]; } // This recalculates the filters and sends appropriate changed signals. // Attention: Since this uses / modifies the hidden_by_filter flag of the // core dive structure, only one DiveTripModel[Tree|List] must exist at // a given time! void DiveTripModelList::filterReset() { // Collect the changes in a vector used later to send signals. // This could be solved more efficiently in one pass, but // doing it in two passes allows us to use a common function without // resorting to co-routines, lambdas or similar techniques. std::vector changed; changed.reserve(items.size()); dive *old_current = current_dive; { // This marker prevents the UI from getting notifications on selection changes. // It is active until the end of the scope. See comment in DiveTripModelTree::filterReset(). auto marker = diveListNotifier.enterCommand(); DiveFilter *filter = DiveFilter::instance(); for (dive *d: items) { bool shown = filter->showDive(d); changed.push_back(filter_dive(d, shown)); } } // Send the data-changed signals if some items changed visibility. sendShownChangedSignals(changed, noParent); emit diveListNotifier.numShownChanged(); // If the current dive changed, instruct the UI of the changed selection // TODO: This is way to heavy, as it reloads the whole selection! if (old_current != current_dive) initSelection(); } QVariant DiveTripModelList::data(const QModelIndex &index, int role) const { // Set the font for all items alike if (role == Qt::FontRole) return defaultModelFont(); dive *d = diveOrNull(index); if (role == SHOWN_ROLE) return d && !d->hidden_by_filter; return d ? diveData(d, index.column(), role) : QVariant(); } void DiveTripModelList::divesAdded(dive_trip *, bool, const QVector &divesIn) { QVector dives = divesIn; std::sort(dives.begin(), dives.end(), dive_less_than); addInBatches(items, dives, &dive_less_than, // comp [&](std::vector &items, const QVector &dives, int idx, int from, int to) { // inserter beginInsertRows(QModelIndex(), idx, idx + to - from - 1); items.insert(items.begin() + idx, dives.begin() + from, dives.begin() + to); endInsertRows(); }); } void DiveTripModelList::divesDeleted(dive_trip *, bool, const QVector &divesIn) { QVector dives = divesIn; std::sort(dives.begin(), dives.end(), dive_less_than); processRangesZip(items, dives, std::equal_to(), // Condition: dive-pointers are equal [&](std::vector &items, const QVector &, int from, int to, int) -> int { // Action beginRemoveRows(QModelIndex(), from, to - 1); items.erase(items.begin() + from, items.begin() + to); endRemoveRows(); return from - to; // Delta: negate the number of items deleted }); } void DiveTripModelList::diveSiteChanged(dive_site *ds, int field) { if (!isInterestingDiveSiteField(field)) return; divesChanged(getDivesForSite(ds)); } void DiveTripModelList::divesChanged(const QVector &divesIn) { QVector dives = divesIn; std::sort(dives.begin(), dives.end(), dive_less_than); updateShown(dives); // Since we know that the dive list is sorted, we will only ever search for the first element // in dives as this must be the first that we encounter. Once we find a range, increase the // index accordingly. processRangesZip(items, dives, std::equal_to(), // Condition: dive-pointers are equal [&](const std::vector &, const QVector &, int from, int to, int) -> int { // Action // TODO: We might be smarter about which columns changed! dataChanged(createIndex(from, 0, noParent), createIndex(to - 1, COLUMNS - 1, noParent)); return 0; // No items added or deleted }); } void DiveTripModelList::divesTimeChanged(timestamp_t delta, const QVector &divesIn) { QVector dives = divesIn; std::sort(dives.begin(), dives.end(), dive_less_than); // See comment for DiveTripModelTree::divesTimeChanged above. divesDeleted(nullptr, false, dives); divesAdded(nullptr, false, dives); } void DiveTripModelList::divesSelected(const QVector &dives, dive *current) { // We got a number of dives that have been selected. Turn this into QModelIndexes and // emit a signal, so that views can change the selection. QVector indexes; indexes.reserve(dives.count()); // Since both lists are sorted, we can do this linearly. Perhaps a binary search // would be better? int j = 0; // Index in items array for (int i = 0; i < dives.size(); ++i) { while (j < (int)items.size() && items[j] != dives[i]) ++j; if (j >= (int)items.size()) break; indexes.append(createIndex(j, 0, noParent)); } emit selectionChanged(indexes); // Transform the current dive into an index and pass it on to the view. if (!current) { emit currentDiveChanged(QModelIndex()); // No current dive -> tell view to clear current index with an invalid index return; } auto it = std::find(items.begin(), items.end(), current); if (it == items.end()) { // We don't know this dive. Something is wrong. Warn and bail. qWarning() << "DiveTripModelList::divesSelected(): unknown dive"; emit currentDiveChanged(QModelIndex()); return; } emit currentDiveChanged(createIndex(it - items.begin(), 0)); } // Simple sorting helper for sorting against a criterium and if // that is undefined against a different criterium. // Return true if diff1 < 0, false if diff1 > 0. // If diff1 == 0 return true if diff2 < 0; static bool lessThanHelper(int diff1, int diff2) { return diff1 < 0 || (diff1 == 0 && diff2 < 0); } static int strCmp(const char *s1, const char *s2) { if (!s1) return !s2 ? 0 : -1; if (!s2) return 1; return QString::localeAwareCompare(QString(s1), QString(s2)); // TODO: avoid copy } bool DiveTripModelList::lessThan(const QModelIndex &i1, const QModelIndex &i2) const { // We assume that i1.column() == i2.column(). int row1 = i1.row(); int row2 = i2.row(); if (row1 < 0 || row1 >= (int)items.size() || row2 < 0 || row2 >= (int)items.size()) return false; const dive *d1 = items[row1]; const dive *d2 = items[row2]; // This is used as a second sort criterion: For equal values, sorting is chronologically *descending*. int row_diff = row2 - row1; switch (i1.column()) { case NR: case DATE: default: return row1 < row2; case RATING: return lessThanHelper(d1->rating - d2->rating, row_diff); case DEPTH: return lessThanHelper(d1->maxdepth.mm - d2->maxdepth.mm, row_diff); case DURATION: return lessThanHelper(d1->duration.seconds - d2->duration.seconds, row_diff); case TEMPERATURE: return lessThanHelper(d1->watertemp.mkelvin - d2->watertemp.mkelvin, row_diff); case TOTALWEIGHT: return lessThanHelper(total_weight(d1) - total_weight(d2), row_diff); case SUIT: return lessThanHelper(strCmp(d1->suit, d2->suit), row_diff); case CYLINDER: if (d1->cylinders.nr > 0 && d2->cylinders.nr > 0) return lessThanHelper(strCmp(get_cylinder(d1, 0)->type.description, get_cylinder(d2, 0)->type.description), row_diff); return d1->cylinders.nr - d2->cylinders.nr < 0; case GAS: return lessThanHelper(nitrox_sort_value(d1) - nitrox_sort_value(d2), row_diff); case SAC: return lessThanHelper(d1->sac - d2->sac, row_diff); case OTU: return lessThanHelper(d1->otu - d2->otu, row_diff); case MAXCNS: return lessThanHelper(d1->maxcns - d2->maxcns, row_diff); case TAGS: { char *s1 = taglist_get_tagstring(d1->tag_list); char *s2 = taglist_get_tagstring(d2->tag_list); int diff = strCmp(s1, s2); free(s1); free(s2); return lessThanHelper(diff, row_diff); } case PHOTOS: return lessThanHelper(countPhotos(d1) - countPhotos(d2), row_diff); case COUNTRY: return lessThanHelper(strCmp(get_dive_country(d1), get_dive_country(d2)), row_diff); case BUDDIES: return lessThanHelper(strCmp(d1->buddy, d2->buddy), row_diff); case LOCATION: return lessThanHelper(strCmp(get_dive_location(d1), get_dive_location(d2)), row_diff); } }