File indexing completed on 2024-05-12 04:55:39

 /**
  * \file kid3qmlplugin.cpp
  * QML plugin for Kid3 application.
  *
  * \b Project: Kid3
  * \author Urs Fleisch
  * \date 19 Sep 2014
  *
  * Copyright (C) 2014-2024  Urs Fleisch
  *
  * This file is part of Kid3.
  *
  * Kid3 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.
  *
  * Kid3 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/>.
  */
 
 #include "kid3qmlplugin.h"
 #include <QCoreApplication>
 #include <QQmlComponent>
 #include <QQmlContext>
 #include "kid3application.h"
 #include "guiplatformtools.h"
 #include "qmlimageprovider.h"
 #include "fileproxymodel.h"
 #include "dirproxymodel.h"
 #include "genremodel.h"
 #include "frametablemodel.h"
 #include "framelist.h"
 #include "frameeditorobject.h"
 #include "frameobjectmodel.h"
 #include "taggedfileselection.h"
 #include "scriptutils.h"
 #include "configobjects.h"
 #include "formatconfig.h"
 #include "playlistconfig.h"
 #include "tagconfig.h"
 #include "checkablelistmodel.h"
 #include "dirrenamer.h"
 #include "filefilter.h"
 #include "batchimporter.h"
 #include "downloadclient.h"
 #include "config.h"
 #ifdef HAVE_QTMULTIMEDIA
 #include "audioplayer.h"
 #endif
 
 Q_DECLARE_METATYPE(Kid3Application*)
 Q_DECLARE_METATYPE(QAbstractItemModel*)
 Q_DECLARE_METATYPE(FileProxyModel*)
 Q_DECLARE_METATYPE(DirProxyModel*)
 Q_DECLARE_METATYPE(GenreModel*)
 Q_DECLARE_METATYPE(FrameTableModel*)
 Q_DECLARE_METATYPE(FrameList*)
 Q_DECLARE_METATYPE(FrameEditorObject*)
 Q_DECLARE_METATYPE(FrameObjectModel*)
 Q_DECLARE_METATYPE(TaggedFileSelectionTagContext*)
 Q_DECLARE_METATYPE(TaggedFileSelection*)
 Q_DECLARE_METATYPE(QList<QPersistentModelIndex>)
 Q_DECLARE_METATYPE(Frame::TagVersion)
 Q_DECLARE_METATYPE(Frame::TagNumber)
 Q_DECLARE_METATYPE(Frame)
 Q_DECLARE_METATYPE(ScriptUtils*)
 Q_DECLARE_METATYPE(ConfigObjects*)
 Q_DECLARE_METATYPE(CheckableListModel*)
 Q_DECLARE_METATYPE(QItemSelectionModel*)
 Q_DECLARE_METATYPE(DirRenamer*)
 Q_DECLARE_METATYPE(BatchImporter*)
 Q_DECLARE_METATYPE(DownloadClient*)
 Q_DECLARE_METATYPE(Kid3ApplicationTagContext*)
 #ifdef HAVE_QTMULTIMEDIA
 Q_DECLARE_METATYPE(AudioPlayer*)
 #endif
 
 namespace {
 
 /**
  * Get the plugins path from the QML import path.
  *
  * The plugins path is normally found relative to the directory where the
  * application binary is located. However, when the application is started
  * from a QML script using qmlscene, the path plugins path cannot be found
  * from the location of qmlscene. In this case, the plugins path can be
  * derived from the QML import path, which contains the Kid3 QML plugin.
  *
  * @param engine QML engine
  * @return plugins directory path, empty if not found.
  */
 QString getPluginsPathFromImportPathList(const QQmlEngine* engine)
 {
   QString cfgPluginsDir(QLatin1String(CFG_PLUGINSDIR));
   if (cfgPluginsDir.startsWith(QLatin1String("./"))) {
     cfgPluginsDir.remove(0, 2);
   } else if (cfgPluginsDir.startsWith(QLatin1String("../"))) {
     cfgPluginsDir.remove(0, 3);
   }
 
   QString pluginsPath;
   const auto paths = engine->importPathList();
   for (const QString& path : paths) {
     if (int index = path.indexOf(cfgPluginsDir); index != -1) {
       pluginsPath = path.left(index + cfgPluginsDir.length());
       break;
     } else if (pluginsPath.isEmpty() &&
                (index = path.indexOf(QLatin1String("plugins"))) != -1) {
       pluginsPath = path.left(index + 7);
       // Probably a path in the build directory, use it if CFG_PLUGINSDIR is
       // not found.
     }
   }
   return pluginsPath;
 }
 
 }
 
 /**
  * Constructor.
  * @param parent parent object
  */
 Kid3QmlPlugin::Kid3QmlPlugin(QObject* parent)
   : QQmlExtensionPlugin(parent),
     m_platformTools(nullptr), m_kid3App(nullptr), m_imageProvider(nullptr),
     m_ownsKid3App(false)
 {
 }
 
 /**
  * Destructor.
  */
 Kid3QmlPlugin::~Kid3QmlPlugin()
 {
   if (m_ownsKid3App) {
     delete m_kid3App;
     delete m_platformTools;
   }
 }
 
 /**
  * Register the types used by the QML plugin.
  * @param uri URI of imported module, must be "Kid3"
  */
 void Kid3QmlPlugin::registerTypes(const char *uri)
 {
   if (qstrcmp(uri, "Kid3") == 0) {
     qRegisterMetaType<QList<QPersistentModelIndex> >();
     qRegisterMetaType<Frame::TagVersion>();
     qRegisterMetaType<Frame::TagNumber>();
     qRegisterMetaType<QAbstractItemModel*>();
     // @uri Kid3
     qmlRegisterUncreatableType<Kid3Application>(uri, 1, 1, "Kid3Application",
         QLatin1String("Retrieve it using app"));
     qmlRegisterUncreatableType<FileProxyModel>(uri, 1, 0, "FileProxyModel",
         QLatin1String("Retrieve it using app.fileProxyModel"));
     qmlRegisterUncreatableType<DirProxyModel>(uri, 1, 0, "DirProxyModel",
         QLatin1String("Retrieve it using app.dirProxyModel"));
     qmlRegisterUncreatableType<GenreModel>(uri, 1, 0, "GenreModel",
         QLatin1String("Retrieve it using app.tag().genreModel"));
     qmlRegisterUncreatableType<FrameTableModel>(uri, 1, 0, "FrameTableModel",
         QLatin1String("Retrieve it using app.tag().frameModel"));
     qmlRegisterUncreatableType<FrameList>(uri, 1, 0, "FrameList",
         QLatin1String("Retrieve it using app.tag().frameList"));
     qmlRegisterType<FrameEditorObject>(uri, 1, 0, "FrameEditorObject");
     qmlRegisterUncreatableType<FrameObjectModel>(uri, 1, 0, "FrameObjectModel",
         QLatin1String("Argument of FrameEditorObject.frameEditFinished()"));
     qmlRegisterUncreatableType<TaggedFileSelection>(
           uri, 1, 0, "TaggedFileSelection",
         QLatin1String("Retrieve it using app.selectionInfo"));
     qmlRegisterUncreatableType<TaggedFileSelectionTagContext>(uri, 1, 0,
         "TaggedFileSelectionTagContext",
         QLatin1String("Retrieve it using app.selectionInfo.tag()"));
     qmlRegisterUncreatableType<QItemSelectionModel>(
           uri, 1, 0, "QItemSelectionModel",
         QLatin1String("Retrieve it using app.fileSelectionModel"));
     qmlRegisterType<ScriptUtils>(uri, 1, 0, "ScriptUtils");
     qmlRegisterType<ConfigObjects>(uri, 1, 0, "ConfigObjects");
     qmlRegisterType<CheckableListModel>(uri, 1, 0, "CheckableListModel");
     qmlRegisterUncreatableType<Frame>(uri, 1, 0, "Frame",
                                       QLatin1String("Only enum container"));
     qmlRegisterUncreatableType<FrameNotice>(uri, 1, 0, "FrameNotice",
                                           QLatin1String("Only enum container"));
     qmlRegisterUncreatableType<FormatConfig>(
           uri, 1, 0, "FormatConfig", QLatin1String("Only enum container"));
     qmlRegisterUncreatableType<PlaylistConfig>(
           uri, 1, 0, "PlaylistConfig", QLatin1String("Only enum container"));
     qmlRegisterUncreatableType<TagConfig>(
           uri, 1, 0, "TagConfig", QLatin1String("Only enum container"));
     qmlRegisterUncreatableType<DirRenamer>(uri, 1, 0, "DirRenamer",
         QLatin1String("Retrieve it using app.dirRenamer"));
     qmlRegisterUncreatableType<FileFilter>(
           uri, 1, 0, "FileFilter", QLatin1String("Only enum container"));
     qmlRegisterUncreatableType<BatchImporter>(uri, 1, 0, "BatchImporter",
         QLatin1String("Retrieve it using app.batchImporter"));
     qmlRegisterUncreatableType<DownloadClient>(uri, 1, 0, "DownloadClient",
         QLatin1String("Retrieve it using app.downloadClient"));
     qmlRegisterUncreatableType<Kid3ApplicationTagContext>(uri, 1, 0,
         "Kid3ApplicationTagContext",
         QLatin1String("Retrieve it using app.tag()"));
 #ifdef HAVE_QTMULTIMEDIA
     qmlRegisterUncreatableType<AudioPlayer>(uri, 1, 0, "AudioPlayer",
         QLatin1String("Retrieve it using app.getAudioPlayer()"));
 #endif
   }
 }
 
 /**
  * Initialize the QML engine when the plugin is imported.
  * @param engine QML engine
  * @param uri URI of imported module, must be "Kid3"
  */
 void Kid3QmlPlugin::initializeEngine(QQmlEngine* engine, const char* uri)
 {
   if (qstrcmp(uri, "Kid3") == 0) {
     Kid3Application::setPluginsPathFallback(
           getPluginsPathFromImportPathList(engine));
     QQmlContext* rootContext = engine->rootContext();
     m_kid3App = qvariant_cast<Kid3Application*>(
           rootContext->contextProperty(QLatin1String("app")));
     if (!m_kid3App) {
       m_platformTools = new GuiPlatformTools;
       m_kid3App = new Kid3Application(m_platformTools);
       m_ownsKid3App = true;
       rootContext->setContextProperty(QLatin1String("app"), m_kid3App);
     }
     if (!m_imageProvider) {
       m_imageProvider = new QmlImageProvider(
             m_kid3App->getFileProxyModel()->getIconProvider());
     }
     m_kid3App->setImageProvider(m_imageProvider);
     // The QQmlEngine takes ownership of m_imageProvider.
     engine->addImageProvider(QLatin1String("kid3"), m_imageProvider);
   }
 }