File indexing completed on 2025-02-23 04:28:33

 /****************************************************************************************
  * Copyright (c) 2013 Anmol Ahuja <darthcodus@gmail.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.                                                                             *
  *                                                                                      *
  * This program is distributed in the hope that it will be useful, but WITHOUT ANY      *
  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A      *
  * PARTICULAR PURPOSE. See the GNU General Public License for more details.             *
  *                                                                                      *
  * You should have received a copy of the GNU General Public License along with         *
  * this program.  If not, see <http://www.gnu.org/licenses/>.                           *
  ****************************************************************************************/
 
 #ifndef QUERYMAKER_EXPORTER_H
 #define QUERYMAKER_EXPORTER_H
 
 #include "amarok_export.h"
 #include "core/collections/QueryMaker.h"
 #include "core/meta/Meta.h"
 
 #include <QObject>
 #include <QPointer>
 #include <QString>
 
 namespace Collections
 {
     class QueryMaker;
 }
 class QJSEngine;
 
 namespace AmarokScript
 {
     // SCRIPTDOX PROTOTYPE Collections::QueryMaker QueryMaker
     #ifdef DEBUG
     class AMAROK_EXPORT
     #else
     class
     #endif
     QueryMakerPrototype : public QObject
     {
         Q_OBJECT
 
         /**
          * Indicates whether this query maker object is valid.
          */
         Q_PROPERTY( bool isValid READ isValid )
 
         /**
          * The current filter string.
          */
         Q_PROPERTY( QString filter READ filter )
 
     public:
         static void init( QJSEngine *engine );
         QueryMakerPrototype( Collections::QueryMaker *collection );
         ~QueryMakerPrototype() override;
         Collections::QueryMaker *data() const { return m_querymaker; }
 
         /**
          *  Starts the query. This method returns immediately. All processing is done in one or more
          *  separate worker thread(s). One of the newResultReady signals will be emitted at least once,
          *  followed by the queryDone() signal exactly once.
          */
         Q_INVOKABLE void run();
 
         /**
          * Block until the query completes, returns the tracklist.
          */
         Q_INVOKABLE Meta::TrackList blockingRun();
 
         /**
          *  Aborts a running query.
          */
         Q_INVOKABLE void abort();
 
         /**
          * Add a filter query to this query maker.
          */
         Q_INVOKABLE void addFilter( const QString &filter );
 
     private:
         QPointer<Collections::QueryMaker> m_querymaker;
         QString m_filter;
         Meta::TrackList m_result;
 
         bool isValid() const;
         QString filter() const;
 
     private Q_SLOTS:
         void slotResult( const Meta::TrackList &tracks );
 
     Q_SIGNALS:
         /**
          * newResultReady will be emitted every time new results from the query maker are received.
          * This signal can be emitted zero times (in case of no results) one (the usual case) or multiple times
          * (e.g. in case when the result is received in several batches).
          * The results will be terminated by a queryDone signal.
          */
         void newResultReady( Meta::TrackList );
 
         /**
          * This signal is emitted after all the results have been submitted via zero or more newResultReady signals.
          */
         void queryDone();
     };
 }
 
 #endif