QDeclarativeImportDatabase Class Reference

The QDeclarativeImportDatabase class manages the QML imports for a QDeclarativeEngine. More...

#include <qdeclarativeimport_p.h>

Public Functions
void	addImportPath (const QString &dir)
void	addPluginPath (const QString &path)
QStringList	importPathList () const
bool	importPlugin (const QString &filePath, const QString &uri, QString *errorString)
QStringList	pluginPathList () const
	QDeclarativeImportDatabase (QDeclarativeEngine *)
void	setImportPathList (const QStringList &paths)
void	setPluginPathList (const QStringList &paths)
	~QDeclarativeImportDatabase ()

Private Functions
QString	resolvePlugin (const QDir &qmldirPath, const QString &qmldirPluginPath, const QString &baseName, const QStringList &suffixes, const QString &prefix=QString())
	Returns the result of the merge of baseName with path, suffixes, and prefix. More...
QString	resolvePlugin (const QDir &qmldirPath, const QString &qmldirPluginPath, const QString &baseName)
	Returns the result of the merge of baseName with dir and the platform suffix. More...

Properties
QDeclarativeEngine *	engine
QStringList	fileImportPath
QStringList	filePluginPath
QSet< QString >	initializedPlugins

Friends
class	QDeclarativeImportsPrivate

Detailed Description

The QDeclarativeImportDatabase class manages the QML imports for a QDeclarativeEngine.

Warning

This function is not part of the public interface.

Definition at line 108 of file qdeclarativeimport_p.h.

Constructors and Destructors

QDeclarativeImportDatabase()

QDeclarativeImportDatabase::QDeclarativeImportDatabase

(

QDeclarativeEngine *

e

)

Definition at line 746 of file qdeclarativeimport.cpp.

: engine(e)
{
    filePluginPath << QLatin1String(".");

    // Search order is applicationDirPath(), $QML_IMPORT_PATH, QLibraryInfo::ImportsPath

#ifndef QT_NO_SETTINGS
    QString installImportsPath =  QLibraryInfo::location(QLibraryInfo::ImportsPath);

#if defined(Q_OS_SYMBIAN)
    // Append imports path for all available drives in Symbian
    if (installImportsPath.at(1) != QChar(QLatin1Char(':'))) {
        QString tempPath = installImportsPath;
        if (tempPath.at(tempPath.length() - 1) != QDir::separator()) {
            tempPath += QDir::separator();
        }
        RFs& fs = qt_s60GetRFs();
        TPtrC tempPathPtr(reinterpret_cast<const TText*> (tempPath.constData()));
        // Symbian searches should start from Y:. Fix start drive otherwise TFindFile starts from the session drive
        _LIT(KStartDir, "Y:");
        TFileName dirPath(KStartDir);
        dirPath.Append(tempPathPtr);
        TFindFile finder(fs);
        TInt err = finder.FindByDir(tempPathPtr, dirPath);
        while (err == KErrNone) {
            QString foundDir(reinterpret_cast<const QChar *>(finder.File().Ptr()),
                             finder.File().Length());
            foundDir = QDir(foundDir).canonicalPath();
            addImportPath(foundDir);
            err = finder.Find();
        }
        // TFindFile found the directories in the order we want, but addImportPath reverses it.
        // Reverse the order again to get it right.
        QAlgorithmsPrivate::qReverse(fileImportPath.begin(), fileImportPath.end());
    } else {
        addImportPath(installImportsPath);
    }
#else
    addImportPath(installImportsPath);
#endif

#endif // QT_NO_SETTINGS

    // env import paths
    QByteArray envImportPath = qgetenv("QML_IMPORT_PATH");
    if (!envImportPath.isEmpty()) {
#if defined(Q_OS_WIN) || defined(Q_OS_SYMBIAN)
        QLatin1Char pathSep(';');
#else
        QLatin1Char pathSep(':');
#endif
        QStringList paths = QString::fromLatin1(envImportPath).split(pathSep, QString::SkipEmptyParts);
        for (int ii = paths.count() - 1; ii >= 0; --ii)
            addImportPath(paths.at(ii));
    }

    addImportPath(QCoreApplication::applicationDirPath());
}

~QDeclarativeImportDatabase()

QDeclarativeImportDatabase::~QDeclarativeImportDatabase

(

)

Definition at line 806 of file qdeclarativeimport.cpp.

{
}

Functions

addImportPath()

void QDeclarativeImportDatabase::addImportPath

(

const QString &

path

)

Warning

This function is not part of the public interface.

Definition at line 1016 of file qdeclarativeimport.cpp.

Referenced by QDeclarativeImportDatabase().

{
    if (qmlImportTrace())
        qDebug().nospace() << "QDeclarativeImportDatabase::addImportPath: " << path;

    if (path.isEmpty())
        return;

    QUrl url = QUrl(path);
    QString cPath;

    if (url.isRelative() || url.scheme() == QLatin1String("file")
            || (url.scheme().length() == 1 && QFile::exists(path)) ) {  // windows path
        QDir dir = QDir(path);
        cPath = dir.canonicalPath();
    } else {
        cPath = path;
        cPath.replace(QLatin1Char('\\'), QLatin1Char('/'));
    }

    if (!cPath.isEmpty()
        && !fileImportPath.contains(cPath))
        fileImportPath.prepend(cPath);
}

addPluginPath()

void QDeclarativeImportDatabase::addPluginPath

(

const QString &

path

)

Warning

This function is not part of the public interface.

Definition at line 998 of file qdeclarativeimport.cpp.

{
    if (qmlImportTrace())
        qDebug().nospace() << "QDeclarativeImportDatabase::addPluginPath: " << path;

    QUrl url = QUrl(path);
    if (url.isRelative() || url.scheme() == QLatin1String("file")
            || (url.scheme().length() == 1 && QFile::exists(path)) ) {  // windows path
        QDir dir = QDir(path);
        filePluginPath.prepend(dir.canonicalPath());
    } else {
        filePluginPath.prepend(path);
    }
}

importPathList()

QStringList QDeclarativeImportDatabase::importPathList

(

)

const

Warning

This function is not part of the public interface.

Definition at line 1044 of file qdeclarativeimport.cpp.

{
    return fileImportPath;
}

importPlugin()

bool QDeclarativeImportDatabase::importPlugin	(	const QString &	filePath,
		const QString &	uri,
		QString *	errorString
	)

Warning

This function is not part of the public interface.

Definition at line 1060 of file qdeclarativeimport.cpp.

Referenced by QDeclarativeImportsPrivate::importExtension().

{
    if (qmlImportTrace())
        qDebug().nospace() << "QDeclarativeImportDatabase::importPlugin: " << uri << " from " << filePath;

#ifndef QT_NO_LIBRARY
    QFileInfo fileInfo(filePath);
    const QString absoluteFilePath = fileInfo.absoluteFilePath();

    bool engineInitialized = initializedPlugins.contains(absoluteFilePath);
    bool typesRegistered = qmlEnginePluginsWithRegisteredTypes()->contains(absoluteFilePath);

    if (typesRegistered) {
        Q_ASSERT_X(qmlEnginePluginsWithRegisteredTypes()->value(absoluteFilePath) == uri,
                   "QDeclarativeImportDatabase::importExtension",
                   "Internal error: Plugin imported previously with different uri");
    }

    if (!engineInitialized || !typesRegistered) {
        if (!QDeclarative_isFileCaseCorrect(absoluteFilePath)) {
            if (errorString) 
                *errorString = tr("File name case mismatch for \"%1\"").arg(absoluteFilePath);
            return false;
        }
        QPluginLoader loader(absoluteFilePath);

        if (!loader.load()) {
            if (errorString)
                *errorString = loader.errorString();
            return false;
        }

        if (QDeclarativeExtensionInterface *iface = qobject_cast<QDeclarativeExtensionInterface *>(loader.instance())) {

            const QByteArray bytes = uri.toUtf8();
            const char *moduleId = bytes.constData();
            if (!typesRegistered) {

                // ### this code should probably be protected with a mutex.
                qmlEnginePluginsWithRegisteredTypes()->insert(absoluteFilePath, uri);
                iface->registerTypes(moduleId);
            }
            if (!engineInitialized) {
                // things on the engine (eg. adding new global objects) have to be done for every engine.

                // protect against double initialization
                initializedPlugins.insert(absoluteFilePath);
                iface->initializeEngine(engine, moduleId);
            }
        } else {
            if (errorString)
                *errorString = loader.errorString();
            return false;
        }
    }

    return true;
#else
    return false;
#endif
}

pluginPathList()

QStringList QDeclarativeImportDatabase::pluginPathList

(

)

const

Warning

This function is not part of the public interface.

Definition at line 982 of file qdeclarativeimport.cpp.

{
    return filePluginPath;
}

resolvePlugin() [1/2]

QString QDeclarativeImportDatabase::resolvePlugin ( const QDir &  qmldirPath, const QString &  qmldirPluginPath, const QString &  baseName, const QStringList &  suffixes, const QString &  prefix = QString()  )

private

Returns the result of the merge of baseName with path, suffixes, and prefix.

Warning

This function is not part of the public interface.

The prefix must contain the dot.

qmldirPath is the location of the qmldir file.

Definition at line 853 of file qdeclarativeimport.cpp.

Referenced by QDeclarativeImportsPrivate::importExtension(), and resolvePlugin().

{
    QStringList searchPaths = filePluginPath;
    bool qmldirPluginPathIsRelative = QDir::isRelativePath(qmldirPluginPath);
    if (!qmldirPluginPathIsRelative)
        searchPaths.prepend(qmldirPluginPath);

    foreach (const QString &pluginPath, searchPaths) {

        QString resolvedPath;

        if (pluginPath == QLatin1String(".")) {
            if (qmldirPluginPathIsRelative)
                resolvedPath = qmldirPath.absoluteFilePath(qmldirPluginPath);
            else
                resolvedPath = qmldirPath.absolutePath();
        } else {
            resolvedPath = pluginPath;
        }

        // hack for resources, should probably go away
        if (resolvedPath.startsWith(QLatin1Char(':')))
            resolvedPath = QCoreApplication::applicationDirPath();

        QDir dir(resolvedPath);
        foreach (const QString &suffix, suffixes) {
            QString pluginFileName = prefix;

            pluginFileName += baseName;
            pluginFileName += suffix;

            QFileInfo fileInfo(dir, pluginFileName);

            if (fileInfo.exists())
                return fileInfo.absoluteFilePath();
        }
    }

    if (qmlImportTrace())
        qDebug() << "QDeclarativeImportDatabase::resolvePlugin: Could not resolve plugin" << baseName 
                 << "in" << qmldirPath.absolutePath();

    return QString();
}

resolvePlugin() [2/2]

QString QDeclarativeImportDatabase::resolvePlugin ( const QDir &  qmldirPath, const QString &  qmldirPluginPath, const QString &  baseName  )

private

Returns the result of the merge of baseName with dir and the platform suffix.

Warning

This function is not part of the public interface.

Platform	Valid suffixes
Windows	.dll
Unix/Linux	.so
AIX	.a
HP-UX	.sl, .so (HP-UXi)
Mac OS X	.dylib, .bundle, .so
Symbian	.dll

Version number on unix are ignored.

Definition at line 920 of file qdeclarativeimport.cpp.

{
#if defined(Q_OS_WIN32) || defined(Q_OS_WINCE)
    return resolvePlugin(qmldirPath, qmldirPluginPath, baseName,
                         QStringList()
# ifdef QT_DEBUG
                         << QLatin1String("d.dll") // try a qmake-style debug build first
# endif
                         << QLatin1String(".dll"));
#elif defined(Q_OS_SYMBIAN)
    return resolvePlugin(qmldirPath, qmldirPluginPath, baseName,
                         QStringList()
                         << QLatin1String(".dll")
                         << QLatin1String(".qtplugin"));
#else

# if defined(Q_OS_DARWIN)

    return resolvePlugin(qmldirPath, qmldirPluginPath, baseName,
                         QStringList()
# ifdef QT_DEBUG
                         << QLatin1String("_debug.dylib") // try a qmake-style debug build first
                         << QLatin1String(".dylib")
# else
                         << QLatin1String(".dylib")
                         << QLatin1String("_debug.dylib") // try a qmake-style debug build after
# endif
                         << QLatin1String(".so")
                         << QLatin1String(".bundle"),
                         QLatin1String("lib"));
# else  // Generic Unix
    QStringList validSuffixList;

#  if defined(Q_OS_HPUX)
/*
    See "HP-UX Linker and Libraries User's Guide", section "Link-time Differences between PA-RISC and IPF":
    "In PA-RISC (PA-32 and PA-64) shared libraries are suffixed with .sl. In IPF (32-bit and 64-bit),
    the shared libraries are suffixed with .so. For compatibility, the IPF linker also supports the .sl suffix."
 */
    validSuffixList << QLatin1String(".sl");
#   if defined __ia64
    validSuffixList << QLatin1String(".so");
#   endif
#  elif defined(Q_OS_AIX)
    validSuffixList << QLatin1String(".a") << QLatin1String(".so");
#  elif defined(Q_OS_UNIX)
    validSuffixList << QLatin1String(".so");
#  endif

    // Examples of valid library names:
    //  libfoo.so

    return resolvePlugin(qmldirPath, qmldirPluginPath, baseName, validSuffixList, QLatin1String("lib"));
# endif

#endif
}

setImportPathList()

void QDeclarativeImportDatabase::setImportPathList

(

const QStringList &

paths

)

Warning

This function is not part of the public interface.

Definition at line 1052 of file qdeclarativeimport.cpp.

{
    fileImportPath = paths;
}

setPluginPathList()

void QDeclarativeImportDatabase::setPluginPathList

(

const QStringList &

paths

)

Warning

This function is not part of the public interface.

Definition at line 990 of file qdeclarativeimport.cpp.

{
    filePluginPath = paths;
}

Friends and Related Functions

QDeclarativeImportsPrivate

friend class QDeclarativeImportsPrivate

friend

Definition at line 126 of file qdeclarativeimport_p.h.

Properties

engine

QDeclarativeEngine* QDeclarativeImportDatabase::engine

private

Definition at line 138 of file qdeclarativeimport_p.h.

Referenced by importPlugin().

fileImportPath

QStringList QDeclarativeImportDatabase::fileImportPath

private

Definition at line 135 of file qdeclarativeimport_p.h.

Referenced by QDeclarativeImportsPrivate::add(), addImportPath(), importPathList(), QDeclarativeImportDatabase(), QDeclarativeImportsPrivate::resolvedUri(), and setImportPathList().

filePluginPath

QStringList QDeclarativeImportDatabase::filePluginPath

private

Definition at line 134 of file qdeclarativeimport_p.h.

Referenced by addPluginPath(), pluginPathList(), QDeclarativeImportDatabase(), resolvePlugin(), and setPluginPathList().

initializedPlugins

QSet<QString> QDeclarativeImportDatabase::initializedPlugins

private

Definition at line 137 of file qdeclarativeimport_p.h.

Referenced by importPlugin().

---

The documentation for this class was generated from the following files:

• /src/declarative/qml/qdeclarativeimport_p.h
• /src/declarative/qml/qdeclarativeimport.cpp