forked from mixxxdj/mixxx
-
Notifications
You must be signed in to change notification settings - Fork 2
/
wsearchrelatedtracksmenu.cpp
336 lines (317 loc) · 11.9 KB
/
wsearchrelatedtracksmenu.cpp
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
#include "widget/wsearchrelatedtracksmenu.h"
#include <QScreen>
#include "moc_wsearchrelatedtracksmenu.cpp"
#include "track/track.h"
#include "util/math.h"
#include "util/qt.h"
#include "util/widgethelper.h"
namespace {
// Occupying up to 20% of the screen's width has been considered
// a viable upper bound for the context menu.
constexpr double kMaxMenuToAvailableScreenWidthRatio = 0.2;
constexpr double kRelativeBpmRange = 0.06; // +/-6 %
const QString kActionTextPrefixSuffixSeparator = QStringLiteral(" | ");
inline int bpmLowerBound(double bpm) {
return static_cast<int>(std::floor((1 - kRelativeBpmRange) * bpm));
}
inline int bpmUpperBound(double bpm) {
return static_cast<int>(std::ceil((1 + kRelativeBpmRange) * bpm));
}
inline QString quoteSearchQueryText(const QString& text) {
return QChar('"') + text + QChar('"');
}
QString extractCalendarYearNumberFromReleaseDate(
const QString& releaseDate) {
// TODO: Improve this poor calendar year number parser
// and extract the code
int skippedLeadingZeros = 0;
int countedLeadingDigits = 0;
const auto trimmed = releaseDate.trimmed();
// Count leading digits
for (int i = 0; i < trimmed.size(); ++i) {
if (!trimmed[i].isDigit()) {
break;
}
// Skip leading zeros
if (countedLeadingDigits == 0 && trimmed[i] == QChar('0')) {
++skippedLeadingZeros;
continue;
}
// Count leading digits
++countedLeadingDigits;
}
// Interpret the leading digits as the calendar year
// without any further validation
return trimmed.mid(skippedLeadingZeros, countedLeadingDigits);
}
} // namespace
WSearchRelatedTracksMenu::WSearchRelatedTracksMenu(
QWidget* parent)
: QMenu(tr("Search related Tracks"), parent) {
}
void WSearchRelatedTracksMenu::addTriggerSearchAction(
bool* /*in/out*/ pAddSeparatorBeforeNextAction,
/*!by-value-because-captured-by-lambda!*/
QString searchQuery, // clazy:exclude=function-args-by-ref
const QString& actionTextPrefix,
const QString& elidableTextSuffix) {
DEBUG_ASSERT(pAddSeparatorBeforeNextAction);
if (*pAddSeparatorBeforeNextAction) {
addSeparator();
}
// Reset the flag before adding the next action
*pAddSeparatorBeforeNextAction = false;
const auto elidedActionText =
elideActionText(
actionTextPrefix,
elidableTextSuffix);
addAction(
mixxx::escapeTextPropertyWithoutShortcuts(elidedActionText),
this,
[this, searchQuery]() {
emit triggerSearch(searchQuery);
});
}
QString WSearchRelatedTracksMenu::elideActionText(
const QString& actionTextPrefix,
const QString& elidableTextSuffix) const {
if (elidableTextSuffix.isEmpty()) {
return actionTextPrefix;
}
const auto* const pScreen =
mixxx::widgethelper::getScreen(*this);
VERIFY_OR_DEBUG_ASSERT(pScreen) {
// This should never fail
return actionTextPrefix;
}
const QString actionTextPrefixWithSeparator =
actionTextPrefix + kActionTextPrefixSuffixSeparator;
const auto prefixWidthInPixels =
fontMetrics().boundingRect(actionTextPrefixWithSeparator).width();
const auto maxWidthInPixels =
math_max(
static_cast<int>(std::ceil(
pScreen->availableSize().width() *
kMaxMenuToAvailableScreenWidthRatio)),
prefixWidthInPixels);
const auto elidedTextSuffix =
fontMetrics().elidedText(
elidableTextSuffix,
// TODO: Customize the suffix elision?
Qt::ElideMiddle,
maxWidthInPixels - prefixWidthInPixels);
return actionTextPrefixWithSeparator + elidedTextSuffix;
}
void WSearchRelatedTracksMenu::addActionsForTrack(
const Track& track) {
// NOTE: We have to explicitly use `QString` instead of `auto`
// when composing search queries using `QStringBuilder`. Otherwise
// string concatenation will fail at runtime!
// Mixing actions
bool addSeparatorBeforeNextAction = !isEmpty();
{
const auto keyText = track.getKeyText();
if (!keyText.isEmpty()) {
const QString searchQuery =
QStringLiteral("~key:") +
quoteSearchQueryText(keyText);
addTriggerSearchAction(
&addSeparatorBeforeNextAction,
searchQuery,
tr("Key"),
tr("harmonic with %1").arg(keyText));
}
}
{
const auto bpm = track.getBpm();
if (bpm > 0) {
const auto minBpmNumber = QString::number(bpmLowerBound(bpm));
const auto maxBpmNumber = QString::number(bpmUpperBound(bpm));
const QString searchQuery =
QStringLiteral("bpm:>=") +
minBpmNumber +
QStringLiteral(" bpm:<=") +
maxBpmNumber;
addTriggerSearchAction(
&addSeparatorBeforeNextAction,
searchQuery,
tr("BPM"),
tr("between %1 and %2").arg(minBpmNumber, maxBpmNumber));
}
}
// Artist actions
addSeparatorBeforeNextAction = !isEmpty();
{
auto primaryArtist = track.getArtist();
auto secondaryArtist = track.getAlbumArtist();
if (primaryArtist.isEmpty()) {
primaryArtist = secondaryArtist;
secondaryArtist = QString();
} else {
if (!secondaryArtist.isEmpty() &&
primaryArtist.contains(secondaryArtist)) {
// Use the shorter string as primary artist and the
// longer string as secondary artist
if (primaryArtist == secondaryArtist) {
secondaryArtist = QString();
} else {
std::swap(primaryArtist, secondaryArtist);
}
}
}
DEBUG_ASSERT(!primaryArtist.isEmpty() || secondaryArtist.isEmpty());
if (!primaryArtist.isEmpty()) {
// Search tracks with similar artist(s)
{
const auto actionTextPrefix = tr("Artist");
const auto searchQueryPrefix = QStringLiteral("artist:");
{
const QString searchQuery =
searchQueryPrefix +
quoteSearchQueryText(primaryArtist);
addTriggerSearchAction(
&addSeparatorBeforeNextAction,
searchQuery,
actionTextPrefix,
primaryArtist);
}
if (!secondaryArtist.isEmpty()) {
const QString searchQuery =
searchQueryPrefix +
quoteSearchQueryText(secondaryArtist);
addTriggerSearchAction(
&addSeparatorBeforeNextAction,
searchQuery,
actionTextPrefix,
secondaryArtist);
}
}
{
const auto actionTextPrefix = tr("Album Artist");
const auto searchQueryPrefix = QStringLiteral("album_artist:");
{
const QString searchQuery =
searchQueryPrefix +
quoteSearchQueryText(primaryArtist);
addTriggerSearchAction(
&addSeparatorBeforeNextAction,
searchQuery,
actionTextPrefix,
primaryArtist);
}
if (!secondaryArtist.isEmpty()) {
const QString searchQuery =
searchQueryPrefix +
quoteSearchQueryText(secondaryArtist);
addTriggerSearchAction(
&addSeparatorBeforeNextAction,
searchQuery,
actionTextPrefix,
secondaryArtist);
}
}
}
}
{
const auto composer = track.getComposer();
if (!composer.isEmpty()) {
const QString searchQuery =
QStringLiteral("composer:") +
quoteSearchQueryText(composer);
addTriggerSearchAction(
&addSeparatorBeforeNextAction,
searchQuery,
tr("Composer"),
composer);
}
}
// Title and grouping actions
addSeparatorBeforeNextAction = !isEmpty();
{
const auto title = track.getTitle();
if (!title.isEmpty()) {
const QString searchQuery =
QStringLiteral("title:") +
quoteSearchQueryText(title);
addTriggerSearchAction(
&addSeparatorBeforeNextAction,
searchQuery,
tr("Title"),
title);
}
}
{
const auto album = track.getAlbum();
if (!album.isEmpty()) {
const QString searchQuery =
QStringLiteral("album:") +
quoteSearchQueryText(album);
addTriggerSearchAction(
&addSeparatorBeforeNextAction,
searchQuery,
tr("Album"),
album);
}
}
{
const auto grouping = track.getGrouping();
if (!grouping.isEmpty()) {
const QString searchQuery =
QStringLiteral("grouping:") +
quoteSearchQueryText(grouping);
addTriggerSearchAction(
&addSeparatorBeforeNextAction,
searchQuery,
tr("Grouping"),
grouping);
}
}
// Other actions
addSeparatorBeforeNextAction = !isEmpty();
{
const auto releaseYearNumber =
extractCalendarYearNumberFromReleaseDate(track.getYear());
if (!releaseYearNumber.isEmpty()) {
const QString searchQuery =
QStringLiteral("year:") +
releaseYearNumber;
addTriggerSearchAction(
&addSeparatorBeforeNextAction,
searchQuery,
tr("Year"),
releaseYearNumber);
}
}
{
const auto genre = track.getGenre();
if (!genre.isEmpty()) {
const QString searchQuery =
QStringLiteral("genre:") +
quoteSearchQueryText(genre);
addTriggerSearchAction(
&addSeparatorBeforeNextAction,
searchQuery,
tr("Genre"),
genre);
}
}
{
const auto locationPath = track.getFileInfo().directory();
if (!locationPath.isEmpty()) {
// Search folder and all subfolders, i.e. for "path/to/folder"
// also find files in "path/to/folder/subfolder" but not in
// "path/to/folder copy".
DEBUG_ASSERT(!locationPath.endsWith(QChar('/')));
const QString locationPathWithTerminator =
locationPath + QChar('/');
const QString searchQuery =
QStringLiteral("location:") +
quoteSearchQueryText(locationPathWithTerminator);
addTriggerSearchAction(
&addSeparatorBeforeNextAction,
searchQuery,
tr("Folder"),
locationPathWithTerminator);
}
}
}