21#include <QtConcurrent>
25 << QStringLiteral(
"processing_alg" )
26 << QStringLiteral(
"layertree" )
27 << QStringLiteral(
"layouts" )
28 << QStringLiteral(
"features" )
29 << QStringLiteral(
"allfeatures" )
30 << QStringLiteral(
"calculator" )
31 << QStringLiteral(
"bookmarks" )
32 << QStringLiteral(
"optionpages" )
33 << QStringLiteral(
"edit_features" )
34 << QStringLiteral(
"goto" )
35 << QStringLiteral(
"nominatimgeocoder" ) ;
40 qRegisterMetaType<QgsLocatorResult>(
"QgsLocatorResult" );
46 qDeleteAll( mFilters );
52 mFilters.removeAll( filter );
58 if ( !prefix.isEmpty() )
60 QList<QgsLocatorFilter *>
filters = QList<QgsLocatorFilter *>();
63 if ( !filter->activePrefix().isEmpty() && filter->activePrefix().compare( prefix, Qt::CaseInsensitive ) == 0 )
78 QMap<QString, QgsLocatorFilter *>
filters = QMap<QString, QgsLocatorFilter *>();
81 if ( !filter->activePrefix().isEmpty() && filter->enabled() )
83#if QT_VERSION < QT_VERSION_CHECK(5, 15, 0)
84 filters.insertMulti( filter->activePrefix(), filter );
86 filters.insert( filter->activePrefix(), filter );
95 mFilters.append( filter );
96 filter->setParent(
this );
102 if ( prefix.isEmpty() )
104 prefix = filter->
prefix();
107 if ( !prefix.isEmpty() )
114 else if ( prefix.length() >= 3 || prefix != filter->
prefix() )
132 mAutocompletionList.clear();
138 cancelRunningQuery();
145 feedback = mOwnedFeedback.get();
149 mOwnedFeedback.reset(
nullptr );
151 mFeedback = feedback;
153 QList< QgsLocatorFilter * > activeFilters;
154 QString searchString = string;
155 QString prefix = searchString.left( std::max(
static_cast<int>( searchString.indexOf(
' ' ) ), 0 ) );
156 if ( !prefix.isEmpty() )
160 if ( filter->activePrefix().compare( prefix, Qt::CaseInsensitive ) == 0 && filter->enabled() )
162 activeFilters << filter;
167 if ( !activeFilters.isEmpty() )
169 searchString = searchString.mid( prefix.length() + 1 );
175 if ( filter->useWithoutPrefix() && filter->enabled() )
177 activeFilters << filter;
182 QList< QgsLocatorFilter *> threadedFilters;
185 filter->clearPreviousResults();
186 std::unique_ptr< QgsLocatorFilter > clone( filter->clone() );
189 QgsMessageLog::logMessage( tr(
"QgsLocatorFilter '%1' could not provide a valid clone" ).arg( filter->name() ), QString(), Qgis::MessageLevel::Critical );
194 result.filter = filter;
195 filterSentResult( result );
197 QStringList autoCompleteList = clone->prepare( searchString, context );
200 for (
int i = 0; i < autoCompleteList.length(); i++ )
202 autoCompleteList[i].prepend( QStringLiteral(
"%1 " ).arg( prefix ) );
205 mAutocompletionList.append( autoCompleteList );
210 clone->fetchResults( searchString, context, feedback );
214 threadedFilters.append( clone.release() );
218 mActiveThreads.clear();
221 QThread *thread =
new QThread();
222 mActiveThreads.append( thread );
223 filter->moveToThread( thread );
224 connect( thread, &QThread::started, filter, [filter, searchString, context, feedback]
226 int delay = filter->fetchResultsDelay();
231 QThread::msleep( 50 );
235 filter->fetchResults( searchString, context, feedback );
237 }, Qt::QueuedConnection );
240 connect( thread, &QThread::finished, thread, [
this, thread]
242 mActiveThreads.removeAll( thread );
243 if ( mActiveThreads.empty() )
246 connect( thread, &QThread::finished, thread, &QThread::deleteLater );
252 if ( mActiveThreads.empty() )
258 cancelRunningQuery();
269 return !mActiveThreads.empty();
276 if ( filter->enabled() )
278 filter->clearPreviousResults();
292void QgsLocator::cancelRunningQuery()
294 if ( !mActiveThreads.empty() )
298 while ( !mActiveThreads.empty() )
300 QCoreApplication::processEvents();
Base class for feedback objects to be used for cancellation of something running in a worker thread.
void cancel()
Tells the internal routines that the current operation should be canceled. This should be run by the ...
bool isCanceled() const SIP_HOLDGIL
Tells whether the operation has been canceled already.
Encapsulates the properties relating to the context of a locator search.
bool usingPrefix
Will be true if search is being conducted using a filter prefix.
Abstract base class for filters which collect locator results.
void setEnabled(bool enabled)
Sets whether the filter is enabled.
void setActivePrefix(const QString &activePrefix)
Sets the prefix as being used by the locator.
virtual QString prefix() const
Returns the search prefix character(s) for this filter.
bool useWithoutPrefix() const
Returns true if the filter should be used when no prefix is entered.
@ FlagFast
Filter finds results quickly and can be safely run in the main thread.
void setUseWithoutPrefix(bool useWithoutPrefix)
Sets whether the filter should be used when no prefix is entered.
void finished()
Emitted when the filter finishes fetching results.
virtual QString name() const =0
Returns the unique name for the filter.
void resultFetched(const QgsLocatorResult &result)
Should be emitted by filters whenever they encounter a matching result during within their fetchResul...
Encapsulates properties of an individual matching result found by a QgsLocatorFilter.
static const QList< QString > CORE_FILTERS
List of core filters (i.e. not plugin filters)
void searchPrepared()
Emitted when locator has prepared the search (.
void cancel()
Cancels any current running query, and blocks until query is completely canceled by all filters.
QgsLocator(QObject *parent=nullptr)
Constructor for QgsLocator.
void registerFilter(QgsLocatorFilter *filter)
Registers a filter within the locator.
static const QgsSettingsEntryBool settingsLocatorFilterEnabled
Settings entry locator filter enabled.
void finished()
Emitted when locator has finished a query, either as a result of successful completion or early cance...
void foundResult(const QgsLocatorResult &result)
Emitted whenever a filter encounters a matching result after the fetchResults() method is called.
void fetchResults(const QString &string, const QgsLocatorContext &context, QgsFeedback *feedback=nullptr)
Triggers the background fetching of filter results for a specified search string.
void clearPreviousResults()
Will call clearPreviousResults on all filters.
static const QgsSettingsEntryBool settingsLocatorFilterDefault
Settings entry locator filter default value.
~QgsLocator() override
Destructor for QgsLocator.
Q_DECL_DEPRECATED QMap< QString, QgsLocatorFilter * > prefixedFilters() const
Returns a map of prefix to filter, for all registered filters with valid prefixes.
bool isRunning() const
Returns true if a query is currently being executed by the locator.
void cancelWithoutBlocking()
Triggers cancellation of any current running query without blocking.
static const QgsSettingsEntryString settingsLocatorFilterPrefix
Settings entry locator filter prefix.
QList< QgsLocatorFilter * > filters(const QString &prefix=QString())
Returns the list of filters registered in the locator.
void deregisterFilter(QgsLocatorFilter *filter)
Deregisters a filter from the locator and deletes it.
static void logMessage(const QString &message, const QString &tag=QString(), Qgis::MessageLevel level=Qgis::MessageLevel::Warning, bool notifyUser=true)
Adds a message to the log instance (and creates it if necessary).
T valueWithDefaultOverride(const T &defaultValueOverride, const QString &dynamicKeyPart=QString()) const
Returns the settings value with a defaultValueOverride and with an optional dynamicKeyPart.
T valueWithDefaultOverride(T defaultValueOverride, const QString &dynamicKeyPart=QString()) const
Returns the settings value with a defaultValueOverride and with an optional dynamicKeyPart.
T value(const QString &dynamicKeyPart=QString()) const
Returns settings value.
As part of the API refactoring and improvements which landed in the Processing API was substantially reworked from the x version This was done in order to allow much of the underlying Processing framework to be ported into c