Show context for items with duplicate names in combo boxes

Closes #211

Author: svetter

src/dialogs/ascent_dialog.cpp

@@ -155,8 +155,8 @@ QString AscentDialog::getEditWindowTitle()
  */
 void AscentDialog::populateComboBoxes()
 {
-	populateItemCombo(db.regionsTable, db.regionsTable.nameColumn, true, regionFilterCombo, selectableRegionIDs, tr("All regions (no filter)"));
-	populateItemCombo(db.peaksTable, db.peaksTable.nameColumn, true, peakCombo, selectablePeakIDs);
+	populateItemCombo(db.regionsTable, db.regionsTable.nameColumn, true, regionFilterCombo, selectableRegionIDs, tr("All regions (no filter)"), &db.regionsTable.rangeIDColumn, &db.rangesTable.nameColumn);
+	populateItemCombo(db.peaksTable, db.peaksTable.nameColumn, true, peakCombo, selectablePeakIDs, QString(), &db.peaksTable.regionIDColumn, &db.regionsTable.nameColumn);
 
 	hikeKindCombo->insertItems(1, EnumNames::translateList(EnumNames::hikeKindNames));
 
@@ -293,9 +293,9 @@ void AscentDialog::handle_regionFilterChanged()
 {
 	ItemID regionID = parseItemCombo(regionFilterCombo, selectableRegionIDs);
 	if (regionID.isValid()) {
-		populateItemCombo(db.peaksTable, db.peaksTable.nameColumn, true, peakCombo, selectablePeakIDs, QString(), &db.peaksTable.regionIDColumn, regionID);
+		populateItemCombo(db.peaksTable, db.peaksTable.nameColumn, true, peakCombo, selectablePeakIDs, QString(), &db.peaksTable.regionIDColumn, &db.regionsTable.nameColumn, &db.peaksTable.regionIDColumn, regionID);
 	} else {
-		populateItemCombo(db.peaksTable, db.peaksTable.nameColumn, true, peakCombo, selectablePeakIDs);
+		populateItemCombo(db.peaksTable, db.peaksTable.nameColumn, true, peakCombo, selectablePeakIDs, QString(), &db.peaksTable.regionIDColumn, &db.regionsTable.nameColumn);
 	}
 }
 
@@ -309,7 +309,7 @@ void AscentDialog::handle_newPeak()
 	BufferRowIndex newPeakIndex = openNewPeakDialogAndStore(this, mainWindow, db);
 	if (newPeakIndex.isInvalid()) return;
 
-	populateItemCombo(db.peaksTable, db.peaksTable.nameColumn, true, peakCombo, selectablePeakIDs);
+	populateItemCombo(db.peaksTable, db.peaksTable.nameColumn, true, peakCombo, selectablePeakIDs, QString(), &db.peaksTable.regionIDColumn, &db.regionsTable.nameColumn);
 	const ValidItemID newPeakID = db.peaksTable.getPrimaryKeyAt(newPeakIndex);
 	regionFilterCombo->setCurrentIndex(0);
 	peakCombo->setCurrentIndex(selectablePeakIDs.indexOf(newPeakID) + 1);	// 0 is None

src/dialogs/item_dialog.cpp

@@ -181,17 +181,20 @@ bool displayDeleteWarning(QWidget* parent, QString windowTitle, const QList<What
  * Repopulates the given combo box with the given table's entries, filtered and sorted according to
  * the given parameters, and writes the IDs of the entries to the referenced list.
  * 
- * @param table					The table to get the entries from.
- * @param displayAndSortColumn	The column of the table to use for displaying and sorting the entries.
- * @param sortAsString			Whether to sort the entries as strings. Otherwise, QVariant::compare() is used.
- * @param combo					The combo box to populate.
- * @param idList				The list in which to store the IDs of the entries.
- * @param overrideFirstLine		If not empty, this string will be used as the first line of the combo box instead of the table's none string.
- * @param filterColumn			If not null, only entries whose foreign key ID in this column matches the given ID will be added to the combo box.
- * @param filterID				The ID to use for filtering entries, or an invalid ID to filter for entries with no reference.
+ * @param table						The table to get the entries from.
+ * @param displayAndSortColumn		The column of the table to use for displaying and sorting the entries.
+ * @param sortAsString				Whether to sort the entries as strings. Otherwise, QVariant::compare() is used.
+ * @param combo						The combo box to populate.
+ * @param idList					The list in which to store the IDs of the entries.
+ * @param overrideFirstLine			If not empty, this string will be used as the first line of the combo box instead of the table's none string.
+ * @param distinctionKeyColumn		If not null, this column will be used to point to a cell in distinctionContentColumn.
+ * @param distinctionContentColumn	If not null, this column will be used to add a distinguishing name in brackets to entries with duplicate names.
+ * @param filterColumn				If not null, only entries whose foreign key ID in this column matches the given ID will be added to the combo box.
+ * @param filterID					The ID to use for filtering entries, or an invalid ID to filter for entries with no reference.
  */
-void populateItemCombo(NormalTable& table, const ValueColumn& displayAndSortColumn, bool sortAsString, QComboBox* combo, QList<ValidItemID>& idList, QString overrideFirstLine, const ForeignKeyColumn* filterColumn, ItemID filterID)
+void populateItemCombo(NormalTable& table, const ValueColumn& displayAndSortColumn, bool sortAsString, QComboBox* combo, QList<ValidItemID>& idList, const QString& overrideFirstLine, const ForeignKeyColumn* distinctionKeyColumn, const ValueColumn* distinctionContentColumn, const ForeignKeyColumn* filterColumn, ItemID filterID)
 {
+	assert(displayAndSortColumn.table == &table);
 	assert(!(!filterColumn && filterID.isValid()));
 
 	combo->clear();
@@ -202,6 +205,7 @@ void populateItemCombo(NormalTable& table, const ValueColumn& displayAndSortColu
 
 	// Get pairs of ID and display/sort field
 	QList<QPair<ValidItemID, QVariant>> selectableItems = table.pairIDWith(displayAndSortColumn);
+	if (selectableItems.isEmpty()) return;
 
 	if (filterColumn) {
 		// Filter entries: if an item's foreign key ID doesn't match the given one, discard it
@@ -222,6 +226,36 @@ void populateItemCombo(NormalTable& table, const ValueColumn& displayAndSortColu
 	};
 	std::sort(selectableItems.begin(), selectableItems.end(), comparator);
 
+	// Add distinction field in brackets in case of duplicates
+	if (distinctionKeyColumn || distinctionContentColumn) {
+		assert(distinctionKeyColumn && distinctionContentColumn);
+		assert(distinctionKeyColumn->table == &table);
+		assert(distinctionKeyColumn->foreignColumn->table == distinctionContentColumn->table);
+		// Find duplicates
+		QSet<int> duplicateNameIndices = QSet<int>();
+		QString previousName;
+		for (int i = 0; i < selectableItems.size(); i++) {
+			const QString currentName = selectableItems.at(i).second.toString();
+			const bool sameName = currentName == previousName && i != 0;
+			if (sameName) {
+				duplicateNameIndices.insert(i - 1);
+				duplicateNameIndices.insert(i);
+			}
+			previousName = currentName;
+		}
+		// Append distinction column content to duplicate names
+		for (const int duplicateNameIndex : duplicateNameIndices) {
+			const ValidItemID& itemID = selectableItems.at(duplicateNameIndex).first;
+			const ItemID& distinctionKey = distinctionKeyColumn->getValueFor(itemID);
+			if (distinctionKey.isInvalid()) continue;
+			const QString& distinctionContent = distinctionContentColumn->getValueFor(FORCE_VALID(distinctionKey)).toString();
+			if (distinctionContent.isEmpty()) continue;
+			const QString& currentName = selectableItems.at(duplicateNameIndex).second.toString();
+			const QString newName = currentName + " (" + distinctionContent + ")";
+			selectableItems[duplicateNameIndex].second = newName;
+		}
+	}
+	
 	// Save IDs and populate combo box
 	for (const auto& [itemID, name] : selectableItems) {
 		idList.append(itemID);

src/dialogs/item_dialog.h

@@ -105,7 +105,7 @@ class ItemDialog : public QDialog
 
 bool displayDeleteWarning(QWidget* parent, QString windowTitle, const QList<WhatIfDeleteResult>& whatIfResults);
 
-void populateItemCombo(NormalTable& table, const ValueColumn& displayAndSortColumn, bool sortAsString, QComboBox* combo, QList<ValidItemID>& idList, QString overrideFirstLine = QString(), const ForeignKeyColumn* filterColumn = nullptr, ItemID filterID = ItemID());
+void populateItemCombo(NormalTable& table, const ValueColumn& displayAndSortColumn, bool sortAsString, QComboBox* combo, QList<ValidItemID>& idList, const QString& overrideFirstLine = QString(), const ForeignKeyColumn* distinctionKeyColumn = nullptr, const ValueColumn* distinctionContentColumn = nullptr, const ForeignKeyColumn* filterColumn = nullptr, ItemID filterID = ItemID());
 
 
 

src/dialogs/peak_dialog.cpp

@@ -114,7 +114,7 @@ QString PeakDialog::getEditWindowTitle()
  */
 void PeakDialog::populateComboBoxes()
 {
-	populateItemCombo(db.regionsTable, db.regionsTable.nameColumn, true, regionCombo, selectableRegionIDs);
+	populateItemCombo(db.regionsTable, db.regionsTable.nameColumn, true, regionCombo, selectableRegionIDs, QString(), &db.regionsTable.rangeIDColumn, &db.rangesTable.nameColumn);
 }
 
 
@@ -202,7 +202,7 @@ void PeakDialog::handle_newRegion()
 	BufferRowIndex newRegionIndex = openNewRegionDialogAndStore(this, mainWindow, db);
 	if (newRegionIndex.isInvalid()) return;
 
-	populateItemCombo(db.regionsTable, db.regionsTable.nameColumn, true, regionCombo, selectableRegionIDs);
+	populateItemCombo(db.regionsTable, db.regionsTable.nameColumn, true, regionCombo, selectableRegionIDs, QString(), &db.regionsTable.rangeIDColumn, &db.rangesTable.nameColumn);
 	const ValidItemID newRegionID = db.regionsTable.getPrimaryKeyAt(newRegionIndex);
 	regionCombo->setCurrentIndex(selectableRegionIDs.indexOf(newRegionID) + 1);	// 0 is None
 }