/
qgslocator.cpp
297 lines (269 loc) · 8.52 KB
/
qgslocator.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
/***************************************************************************
qgslocator.cpp
--------------
begin : May 2017
copyright : (C) 2017 by Nyall Dawson
email : nyall dot dawson at gmail dot com
***************************************************************************/
/***************************************************************************
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 2 of the License, or *
* (at your option) any later version. *
* *
***************************************************************************/
#include "qgslocator.h"
#include "qgssettings.h"
#include <QtConcurrent>
#include <functional>
const QList<QString> QgsLocator::CORE_FILTERS = QList<QString>() << QStringLiteral( "actions" )
<< QStringLiteral( "processing_alg" )
<< QStringLiteral( "layertree" )
<< QStringLiteral( "layouts" )
<< QStringLiteral( "features" )
<< QStringLiteral( "allfeatures" )
<< QStringLiteral( "calculator" )
<< QStringLiteral( "bookmarks" )
<< QStringLiteral( "optionpages" )
<< QStringLiteral( "edit_features" )
<< QStringLiteral( "goto" );
QgsLocator::QgsLocator( QObject *parent )
: QObject( parent )
{
qRegisterMetaType<QgsLocatorResult>( "QgsLocatorResult" );
}
QgsLocator::~QgsLocator()
{
cancelRunningQuery();
qDeleteAll( mFilters );
}
void QgsLocator::deregisterFilter( QgsLocatorFilter *filter )
{
cancelRunningQuery();
mFilters.removeAll( filter );
delete filter;
}
QList<QgsLocatorFilter *> QgsLocator::filters( const QString &prefix )
{
if ( !prefix.isEmpty() )
{
QList<QgsLocatorFilter *> filters = QList<QgsLocatorFilter *>();
for ( QgsLocatorFilter *filter : mFilters )
{
if ( !filter->activePrefix().isEmpty() && filter->activePrefix().compare( prefix, Qt::CaseInsensitive ) == 0 )
{
filters << filter;
}
}
return filters;
}
else
{
return mFilters;
}
}
QMap<QString, QgsLocatorFilter *> QgsLocator::prefixedFilters() const
{
QMap<QString, QgsLocatorFilter *> filters = QMap<QString, QgsLocatorFilter *>();
for ( QgsLocatorFilter *filter : mFilters )
{
if ( !filter->activePrefix().isEmpty() && filter->enabled() )
{
#if QT_VERSION < QT_VERSION_CHECK(5, 15, 0)
filters.insertMulti( filter->activePrefix(), filter );
#else
filters.insert( filter->activePrefix(), filter );
#endif
}
}
return filters;
}
void QgsLocator::registerFilter( QgsLocatorFilter *filter )
{
mFilters.append( filter );
filter->setParent( this );
// restore settings
QgsSettings settings;
bool enabled = settings.value( QStringLiteral( "locator_filters/enabled_%1" ).arg( filter->name() ), true, QgsSettings::Section::Gui ).toBool();
bool byDefault = settings.value( QStringLiteral( "locator_filters/default_%1" ).arg( filter->name() ), filter->useWithoutPrefix(), QgsSettings::Section::Gui ).toBool();
QString prefix = settings.value( QStringLiteral( "locator_filters/prefix_%1" ).arg( filter->name() ), filter->prefix(), QgsSettings::Section::Gui ).toString();
if ( prefix.isEmpty() )
{
prefix = filter->prefix();
}
if ( !prefix.isEmpty() )
{
if ( CORE_FILTERS.contains( filter->name() ) )
{
//inbuilt filter, no prefix check
filter->setActivePrefix( prefix );
}
else if ( prefix.length() >= 3 || prefix != filter->prefix() )
{
// for plugins either the native prefix is >3 char or it has been customized by user
filter->setActivePrefix( prefix );
}
else
{
// otherwise set it to empty string (not NULL)
filter->setActivePrefix( QString( "" ) );
}
}
filter->setEnabled( enabled );
filter->setUseWithoutPrefix( byDefault );
}
void QgsLocator::fetchResults( const QString &string, const QgsLocatorContext &c, QgsFeedback *feedback )
{
mAutocompletionList.clear();
QgsLocatorContext context( c );
// ideally this should not be required, as well behaved callers
// will NOT fire up a new fetchResults call while an existing one is
// operating/waiting to be canceled...
cancelRunningQuery();
// if no feedback object was passed, create one that is owned by this object
// to ensure that filters ALWAYS receive a valid feedback
if ( !feedback )
{
mOwnedFeedback.reset( new QgsFeedback() );
feedback = mOwnedFeedback.get();
}
else
{
mOwnedFeedback.reset( nullptr );
}
mFeedback = feedback;
QList< QgsLocatorFilter * > activeFilters;
QString searchString = string;
QString prefix = searchString.left( std::max( searchString.indexOf( ' ' ), 0 ) );
if ( !prefix.isEmpty() )
{
for ( QgsLocatorFilter *filter : qgis::as_const( mFilters ) )
{
if ( filter->activePrefix().compare( prefix, Qt::CaseInsensitive ) == 0 && filter->enabled() )
{
activeFilters << filter;
}
}
context.usingPrefix = !activeFilters.empty();
}
if ( !activeFilters.isEmpty() )
{
searchString = searchString.mid( prefix.length() + 1 );
}
else
{
for ( QgsLocatorFilter *filter : qgis::as_const( mFilters ) )
{
if ( filter->useWithoutPrefix() && filter->enabled() )
{
activeFilters << filter;
}
}
}
QList< QgsLocatorFilter *> threadedFilters;
for ( QgsLocatorFilter *filter : qgis::as_const( activeFilters ) )
{
filter->clearPreviousResults();
std::unique_ptr< QgsLocatorFilter > clone( filter->clone() );
connect( clone.get(), &QgsLocatorFilter::resultFetched, clone.get(), [this, filter]( QgsLocatorResult result )
{
result.filter = filter;
filterSentResult( result );
} );
QStringList autoCompleteList = clone->prepare( searchString, context );
if ( context.usingPrefix )
{
for ( int i = 0; i < autoCompleteList.length(); i++ )
{
autoCompleteList[i].prepend( QStringLiteral( "%1 " ).arg( prefix ) );
}
}
mAutocompletionList.append( autoCompleteList );
if ( clone->flags() & QgsLocatorFilter::FlagFast )
{
// filter is fast enough to fetch results on the main thread
clone->fetchResults( searchString, context, feedback );
}
else
{
threadedFilters.append( clone.release() );
}
}
mActiveThreads.clear();
for ( QgsLocatorFilter *filter : qgis::as_const( threadedFilters ) )
{
QThread *thread = new QThread();
mActiveThreads.append( thread );
filter->moveToThread( thread );
connect( thread, &QThread::started, filter, [filter, searchString, context, feedback]
{
int delay = filter->fetchResultsDelay();
while ( delay > 0 )
{
if ( feedback->isCanceled() )
break;
QThread::msleep( 50 );
delay -= 50;
}
if ( !feedback->isCanceled() )
filter->fetchResults( searchString, context, feedback );
filter->emit finished();
}, Qt::QueuedConnection );
connect( filter, &QgsLocatorFilter::finished, thread, &QThread::quit );
connect( filter, &QgsLocatorFilter::finished, filter, &QgsLocatorFilter::deleteLater );
connect( thread, &QThread::finished, thread, [this, thread]
{
mActiveThreads.removeAll( thread );
if ( mActiveThreads.empty() )
emit finished();
} );
connect( thread, &QThread::finished, thread, &QThread::deleteLater );
thread->start();
}
emit searchPrepared();
if ( mActiveThreads.empty() )
emit finished();
}
void QgsLocator::cancel()
{
cancelRunningQuery();
}
void QgsLocator::cancelWithoutBlocking()
{
if ( mFeedback )
mFeedback->cancel();
}
bool QgsLocator::isRunning() const
{
return !mActiveThreads.empty();
}
void QgsLocator::clearPreviousResults()
{
for ( QgsLocatorFilter *filter : qgis::as_const( mFilters ) )
{
if ( filter->enabled() )
{
filter->clearPreviousResults();
}
}
}
void QgsLocator::filterSentResult( QgsLocatorResult result )
{
// if query has been canceled then discard any results we receive
if ( mFeedback->isCanceled() )
return;
emit foundResult( result );
}
void QgsLocator::cancelRunningQuery()
{
if ( !mActiveThreads.empty() )
{
// cancel existing job
mFeedback->cancel();
while ( !mActiveThreads.empty() )
{
QCoreApplication::processEvents();
}
}
}