File indexing completed on 2024-05-05 04:48:02

 /****************************************************************************************
  * Copyright (c) 2007-2008 Maximilian Kossick <maximilian.kossick@googlemail.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 AMAROK_COLLECTIONMANAGER_H
 #define AMAROK_COLLECTIONMANAGER_H
 
 #include "amarok_export.h"
 #include "core/meta/forward_declarations.h"
 
 #include <QUrl>
 
 #include <QList>
 #include <QObject>
 
 
 namespace Plugins {
     class PluginFactory;
 }
 
 namespace Collections {
     class Collection;
     class CollectionFactory;
     class TrackProvider;
     class QueryMaker;
 }
 
 /** Class managing the different collections.
  *
  *  This singleton class is the main repository for all current collections.
  *  The most useful functions are probably queryMaker and
  *  viewableCollections
  */
 class AMAROK_EXPORT CollectionManager : public QObject
 {
     Q_OBJECT
 
     public:
 
         /**
          * defines the status of a collection in respect to global queries (i.e. queries that query all known collections)
          * or the collection browser.
          */
         enum CollectionStatus { CollectionDisabled = 1, ///< Collection neither viewable nor queryable (but might produce tracks that can be played)
                                 CollectionViewable = 2, ///< Collection will not be queried by CollectionManager::queryMaker
                                 CollectionQueryable= 4, ///< Collection wil not show up in the browser, but is queryable by global queries
                                 CollectionEnabled = CollectionViewable | CollectionQueryable ///< Collection viewable in the browser and queryable
         };
         Q_ENUM( CollectionStatus )
 
         static CollectionManager *instance();
 
         /** Destroys the instance of the CollectionManager.
          */
         static void destroy();
 
         /**
          * Returns a query maker that queries all queryable the collections
          */
         Collections::QueryMaker *queryMaker() const;
 
         /**
          * returns all viewable collections.
          */
         QList<Collections::Collection*> viewableCollections() const;
 
         //TODO: Remove
         /**
           * Allows access to one of Amarok's collection.
           *
           * @deprecated DO NOT USE this method. This is legacy code from the early days of Amarok
           * when SqlCollection was the only working collection. If you are writing new code, make
           * sure that it is able to handle multiple collections,
           * e.g. multiple connected media devices. Using this method means you are lazy. An easy way
           * is to use CollectionManager::queryMaker(). Alternatively, access the available collections
           * using CollectionManager::queryableCollections() or CollectionManager::viewableCollections()
           * and do whatever you want to.
           *
           */
         Collections::Collection* primaryCollection() const;
 
         /**
             This method will try to get a Track object for the given url. This method will return 0 if no Track object
             could be created for the url.
         */
         Meta::TrackPtr trackForUrl( const QUrl &url );
 
         CollectionStatus collectionStatus( const QString &collectionId ) const;
 
         QHash<Collections::Collection*, CollectionStatus> collections() const;
 
         /**
          * adds a TrackProvider to the list of TrackProviders,
          * which allows CollectionManager to create tracks in trackForUrl.
          * CollectionManager does not take ownership of the TrackProvider pointer
          *
          * Note: collections that CollectionManager knows about are automatically
          * added to the list of TrackProviders.
          *
          * @param provider the new TrackProvider
          */
         void addTrackProvider( Collections::TrackProvider *provider );
 
         /**
          * removes a TrackProvider. Does not do anything if
          * CollectionManager does not know the given TrackProvider.
          *
          * Note: collections will be automatically removed from
          * the list of available TrackProviders.
          *
          * @param provider the provider to be removed
          */
         void removeTrackProvider( Collections::TrackProvider *provider );
 
         /**
          * Set the list of current factories
          *
          * For every factory that is a CollectionFactory uses it to create new
          * collections and register with this manager.
          */
         void setFactories( const QList<QSharedPointer<Plugins::PluginFactory> > &factories );
 
     public Q_SLOTS:
         /** Starts the full scan for each collection with CollectionScanCapability */
         void startFullScan();
         /** Starts the incremental scan for each collection with CollectionScanCapability */
         void startIncrementalScan( const QString &directory = QString() );
         void stopScan();
         void checkCollectionChanges();
 
     Q_SIGNALS:
         //deprecated, use collectionAdded( Collections::Collection*, CollectionStatus ) instead
 //         void collectionAdded( Collections::Collection *newCollection );
 
         void collectionAdded( Collections::Collection *newCollection, CollectionManager::CollectionStatus status );
         void collectionRemoved( const QString &collectionId );
         void trackProviderAdded( Collections::TrackProvider *provider );
         //this signal will be emitted after major changes to the collection
         //e.g. new songs where added, or an album changed
         //from compilation to non-compilation (and vice versa)
         //it will not be emitted on minor changes (e.g. the tags of a song were changed)
         void collectionDataChanged( Collections::Collection *changedCollection );
 
     private Q_SLOTS:
         /** Will be called whenever a registered collection factory creates a new collection */
         void slotNewCollection( Collections::Collection *newCollection );
         /** Will remove the collection that emitted the signal */
         void slotRemoveCollection();
         void slotCollectionChanged();
 
     private:
         static CollectionManager* s_instance;
         CollectionManager();
         ~CollectionManager() override;
 
         void init();
 
 
         Q_DISABLE_COPY( CollectionManager )
 
         struct Private;
         Private * const d;
 };
 
 #endif /* AMAROK_COLLECTIONMANAGER_H */