Qt 4.8
Public Types | Public Functions | Private Types | Properties | List of all members
QDeclarativeTypeLoader Class Reference

#include <qdeclarativetypeloader_p.h>

Inheritance diagram for QDeclarativeTypeLoader:
QDeclarativeDataLoader QObject

Public Types

enum  Option { None, PreserveParser }
 This enum defines the options that control the way type data is handled. More...
 

Public Functions

QString absoluteFilePath (const QString &path)
 Returns the absolute filename of path via a directory cache for files named "qmldir", "*.qml", "*.js" Returns a empty string if the path does not exist. More...
 
void clearCache ()
 
QDeclarativeTypeDataget (const QUrl &url)
 Returns a QDeclarativeTypeData for the specified url. More...
 
QDeclarativeTypeDataget (const QByteArray &, const QUrl &url, Options=None)
 Returns a QDeclarativeTypeData for the given data with the provided base url. More...
 
QDeclarativeQmldirDatagetQmldir (const QUrl &)
 Returns a QDeclarativeQmldirData for url. More...
 
QDeclarativeScriptDatagetScript (const QUrl &)
 Returns a QDeclarativeScriptData for url. More...
 
 QDeclarativeTypeLoader (QDeclarativeEngine *)
 Constructs a new type loader that uses the given engine. More...
 
const QDeclarativeDirParserqmlDirParser (const QString &absoluteFilePath)
 Return a QDeclarativeDirParser for absoluteFilePath. More...
 
 ~QDeclarativeTypeLoader ()
 Destroys the type loader, first clearing the cache of any information about loaded files. More...
 
- Public Functions inherited from QDeclarativeDataLoader
QDeclarativeEngineengine () const
 Return the QDeclarativeEngine associated with this loader. More...
 
void load (QDeclarativeDataBlob *)
 Load the provided blob from the network or filesystem. More...
 
void loadWithStaticData (QDeclarativeDataBlob *, const QByteArray &)
 Load the provided blob with data. More...
 
 QDeclarativeDataLoader (QDeclarativeEngine *)
 Create a new QDeclarativeDataLoader for engine. More...
 
 ~QDeclarativeDataLoader ()
 
- Public Functions inherited from QObject
bool blockSignals (bool b)
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it). More...
 
const QObjectListchildren () const
 Returns a list of child objects. More...
 
bool connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=0, const QObject *receiver=0, const char *member=0)
 
bool disconnect (const QObject *receiver, const char *member=0)
 
void dumpObjectInfo ()
 Dumps information about signal connections, etc. More...
 
void dumpObjectTree ()
 Dumps a tree of children to the debug output. More...
 
QList< QByteArraydynamicPropertyNames () const
 Returns the names of all properties that were dynamically added to the object using setProperty(). More...
 
virtual bool event (QEvent *)
 This virtual function receives events to an object and should return true if the event e was recognized and processed. More...
 
virtual bool eventFilter (QObject *, QEvent *)
 Filters events if this object has been installed as an event filter for the watched object. More...
 
template<typename T >
findChild (const QString &aName=QString()) const
 Returns the child of this object that can be cast into type T and that is called name, or 0 if there is no such object. More...
 
template<typename T >
QList< T > findChildren (const QString &aName=QString()) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects. More...
 
template<typename T >
QList< T > findChildren (const QRegExp &re) const
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false. More...
 
void installEventFilter (QObject *)
 Installs an event filter filterObj on this object. More...
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false. More...
 
void killTimer (int id)
 Kills the timer with timer identifier, id. More...
 
virtual const QMetaObjectmetaObject () const
 Returns a pointer to the meta-object of this object. More...
 
void moveToThread (QThread *thread)
 Changes the thread affinity for this object and its children. More...
 
QString objectName () const
 
QObjectparent () const
 Returns a pointer to the parent object. More...
 
QVariant property (const char *name) const
 Returns the value of the object's name property. More...
 
Q_INVOKABLE QObject (QObject *parent=0)
 Constructs an object with parent object parent. More...
 
void removeEventFilter (QObject *)
 Removes an event filter object obj from this object. More...
 
void setObjectName (const QString &name)
 
void setParent (QObject *)
 Makes the object a child of parent. More...
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value. More...
 
void setUserData (uint id, QObjectUserData *data)
 
bool signalsBlocked () const
 Returns true if signals are blocked; otherwise returns false. More...
 
int startTimer (int interval)
 Starts a timer and returns a timer identifier, or returns zero if it could not start a timer. More...
 
QThreadthread () const
 Returns the thread in which the object lives. More...
 
QObjectUserDatauserData (uint id) const
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects. More...
 

Private Types

typedef QHash< QString, StringSet * > ImportDirCache
 
typedef QHash< QString, QDeclarativeDirParser * > ImportQmlDirCache
 
typedef QHash< QUrl, QDeclarativeQmldirData * > QmldirCache
 
typedef QHash< QUrl, QDeclarativeScriptData * > ScriptCache
 
typedef QSet< QStringStringSet
 
typedef QHash< QUrl, QDeclarativeTypeData * > TypeCache
 

Properties

ImportDirCache m_importDirCache
 
ImportQmlDirCache m_importQmlDirCache
 
QmldirCache m_qmldirCache
 
ScriptCache m_scriptCache
 
TypeCache m_typeCache
 

Additional Inherited Members

- Public Slots inherited from QObject
void deleteLater ()
 Schedules this object for deletion. More...
 
- Signals inherited from QObject
void destroyed (QObject *=0)
 This signal is emitted immediately before the object obj is destroyed, and can not be blocked. More...
 
- Static Public Functions inherited from QObject
static bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 Creates a connection of the given type from the signal in the sender object to the method in the receiver object. More...
 
static bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 Disconnects signal in object sender from method in object receiver. More...
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static uint registerUserData ()
 
static QString tr (const char *sourceText, const char *comment=0, int n=-1)
 
static QString trUtf8 (const char *sourceText, const char *comment=0, int n=-1)
 
- Static Public Variables inherited from QObject
static const QMetaObject staticMetaObject
 This variable stores the meta-object for the class. More...
 
- Protected Functions inherited from QObject
virtual void childEvent (QChildEvent *)
 This event handler can be reimplemented in a subclass to receive child events. More...
 
virtual void connectNotify (const char *signal)
 This virtual function is called when something has been connected to signal in this object. More...
 
virtual void customEvent (QEvent *)
 This event handler can be reimplemented in a subclass to receive custom events. More...
 
virtual void disconnectNotify (const char *signal)
 This virtual function is called when something has been disconnected from signal in this object. More...
 
 QObject (QObjectPrivate &dd, QObject *parent=0)
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal. More...
 
QObjectsender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns 0. More...
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *)
 This event handler can be reimplemented in a subclass to receive timer events for the object. More...
 
- Protected Variables inherited from QObject
QScopedPointer< QObjectDatad_ptr
 
- Static Protected Variables inherited from QObject
static const QMetaObject staticQtMetaObject
 

Detailed Description

Warning
This function is not part of the public interface.

Definition at line 184 of file qdeclarativetypeloader_p.h.

Typedefs

◆ ImportDirCache

Definition at line 212 of file qdeclarativetypeloader_p.h.

◆ ImportQmlDirCache

Definition at line 213 of file qdeclarativetypeloader_p.h.

◆ QmldirCache

Definition at line 210 of file qdeclarativetypeloader_p.h.

◆ ScriptCache

Definition at line 209 of file qdeclarativetypeloader_p.h.

◆ StringSet

Definition at line 211 of file qdeclarativetypeloader_p.h.

◆ TypeCache

Definition at line 208 of file qdeclarativetypeloader_p.h.

Enumerations

◆ Option

This enum defines the options that control the way type data is handled.

  • None The default value, indicating that no other options are enabled.
  • PreserveParser The parser used to handle the type data is preserved after the data has been parsed.
Enumerator
None 
PreserveParser 

Definition at line 191 of file qdeclarativetypeloader_p.h.

Constructors and Destructors

◆ QDeclarativeTypeLoader()

QDeclarativeTypeLoader::QDeclarativeTypeLoader ( QDeclarativeEngine engine)

Constructs a new type loader that uses the given engine.

Definition at line 679 of file qdeclarativetypeloader.cpp.

680 : QDeclarativeDataLoader(engine)
681 {
682 }
QDeclarativeDataLoader(QDeclarativeEngine *)
Create a new QDeclarativeDataLoader for engine.

◆ ~QDeclarativeTypeLoader()

QDeclarativeTypeLoader::~QDeclarativeTypeLoader ( )

Destroys the type loader, first clearing the cache of any information about loaded files.

Definition at line 688 of file qdeclarativetypeloader.cpp.

689 {
690  clearCache();
691 }

Functions

◆ absoluteFilePath()

QString QDeclarativeTypeLoader::absoluteFilePath ( const QString path)

Returns the absolute filename of path via a directory cache for files named "qmldir", "*.qml", "*.js" Returns a empty string if the path does not exist.

Definition at line 785 of file qdeclarativetypeloader.cpp.

Referenced by QDeclarativeImportsPrivate::add(), and QDeclarativeImportedNamespace::find_helper().

786 {
787  if (path.isEmpty())
788  return QString();
789  if (path.at(0) == QLatin1Char(':')) {
790  // qrc resource
791  QFileInfo fileInfo(path);
792  return fileInfo.isFile() ? fileInfo.absoluteFilePath() : QString();
793  }
794 #if defined(Q_OS_WIN32) || defined(Q_OS_WINCE) || defined(Q_OS_DARWIN) || defined(Q_OS_SYMBIAN)
795  QString lowPath(path.toLower());
796 #else
797  QString lowPath(path);
798 #endif
799  int lastSlash = lowPath.lastIndexOf(QLatin1Char('/'));
800  QString dirPath = lowPath.left(lastSlash);
801 
802  StringSet *fileSet = 0;
804  if (it == m_importDirCache.end()) {
805  StringSet *files = qmlFilesInDirectory(path.left(lastSlash));
806  m_importDirCache.insert(dirPath, files);
807  fileSet = files;
808  } else {
809  fileSet = *it;
810  }
811  if (!fileSet)
812  return QString();
813 
814  QString absoluteFilePath = fileSet->contains(QString(lowPath.constData()+lastSlash+1, lowPath.length()-lastSlash-1)) ? path : QString();
815  if (absoluteFilePath.length() > 2 && absoluteFilePath.at(0) != QLatin1Char('/') && absoluteFilePath.at(1) != QLatin1Char(':'))
816  absoluteFilePath = QFileInfo(absoluteFilePath).absoluteFilePath();
817 
818  return absoluteFilePath;
819 }
QBool contains(QChar c, Qt::CaseSensitivity cs=Qt::CaseSensitive) const
Definition: qstring.h:904
const QChar at(int i) const
Returns the character at the given index position in the string.
Definition: qstring.h:698
#define it(className, varName)
int length() const
Returns the number of characters in this string.
Definition: qstring.h:696
QString absoluteFilePath() const
Returns an absolute path including the file name.
Definition: qfileinfo.cpp:534
The QString class provides a Unicode character string.
Definition: qstring.h:83
The QHash class is a template class that provides a hash-table-based dictionary.
Definition: qdatastream.h:66
iterator insert(const Key &key, const T &value)
Inserts a new item with the key and a value of value.
Definition: qhash.h:753
QString left(int n) const Q_REQUIRED_RESULT
Returns a substring that contains the n leftmost characters of the string.
Definition: qstring.cpp:3664
bool isEmpty() const
Returns true if the string has no characters; otherwise returns false.
Definition: qstring.h:704
iterator end()
Returns an STL-style iterator pointing to the imaginary item after the last item in the hash...
Definition: qhash.h:467
QString toLower() const Q_REQUIRED_RESULT
Returns a lowercase copy of the string.
Definition: qstring.cpp:5389
static QSet< QString > * qmlFilesInDirectory(const QString &path)
QString absoluteFilePath(const QString &path)
Returns the absolute filename of path via a directory cache for files named "qmldir", "*.qml", "*.js" Returns a empty string if the path does not exist.
iterator find(const Key &key)
Returns an iterator pointing to the item with the key in the hash.
Definition: qhash.h:865
The QFileInfo class provides system-independent file information.
Definition: qfileinfo.h:60
The QLatin1Char class provides an 8-bit ASCII/Latin-1 character.
Definition: qchar.h:55

◆ clearCache()

void QDeclarativeTypeLoader::clearCache ( )

Definition at line 845 of file qdeclarativetypeloader.cpp.

Referenced by ~QDeclarativeTypeLoader().

846 {
847  for (TypeCache::Iterator iter = m_typeCache.begin(); iter != m_typeCache.end(); ++iter)
848  (*iter)->release();
849  for (ScriptCache::Iterator iter = m_scriptCache.begin(); iter != m_scriptCache.end(); ++iter)
850  (*iter)->release();
851  for (QmldirCache::Iterator iter = m_qmldirCache.begin(); iter != m_qmldirCache.end(); ++iter)
852  (*iter)->release();
855 
856  m_typeCache.clear();
861 }
void clear()
Removes all items from the hash.
Definition: qhash.h:574
iterator end()
Returns an STL-style iterator pointing to the imaginary item after the last item in the hash...
Definition: qhash.h:467
iterator begin()
Returns an STL-style iterator pointing to the first item in the hash.
Definition: qhash.h:464
Q_OUTOFLINE_TEMPLATE void qDeleteAll(ForwardIterator begin, ForwardIterator end)
Definition: qalgorithms.h:319
iterator Iterator
Qt-style synonym for QHash::iterator.
Definition: qhash.h:473
ImportQmlDirCache m_importQmlDirCache

◆ get() [1/2]

QDeclarativeTypeData * QDeclarativeTypeLoader::get ( const QUrl url)

Returns a QDeclarativeTypeData for the specified url.

The QDeclarativeTypeData may be cached.

Definition at line 707 of file qdeclarativetypeloader.cpp.

Referenced by QDeclarativeCompiler::buildDynamicMeta(), QDeclarativeBinding::createBinding(), QDeclarativeDomDocument::load(), QDeclarativeComponent::loadUrl(), QDeclarativeTypeData::resolveTypes(), and QDeclarativeComponent::setData().

708 {
709  Q_ASSERT(!url.isRelative() &&
712 
713  QDeclarativeTypeData *typeData = m_typeCache.value(url);
714 
715  if (!typeData) {
716  typeData = new QDeclarativeTypeData(url, None, this);
717  m_typeCache.insert(url, typeData);
719  }
720 
721  typeData->addref();
722  return typeData;
723 }
static QString urlToLocalFileOrQrc(const QUrl &url)
static bool isRelativePath(const QString &path)
Returns true if path is relative; returns false if it is absolute.
Definition: qdir.cpp:2210
#define Q_ASSERT(cond)
Definition: qglobal.h:1823
bool isRelative() const
Returns true if the URL is relative; otherwise returns false.
Definition: qurl.cpp:5880
const T value(const Key &key) const
Returns the value associated with the key.
Definition: qhash.h:606
iterator insert(const Key &key, const T &value)
Inserts a new item with the key and a value of value.
Definition: qhash.h:753
bool isEmpty() const
Returns true if the string has no characters; otherwise returns false.
Definition: qstring.h:704
void load(QDeclarativeDataBlob *)
Load the provided blob from the network or filesystem.

◆ get() [2/2]

QDeclarativeTypeData * QDeclarativeTypeLoader::get ( const QByteArray data,
const QUrl url,
Options  options = None 
)

Returns a QDeclarativeTypeData for the given data with the provided base url.

The QDeclarativeTypeData will not be cached.

The specified options control how the loader handles type data.

Definition at line 731 of file qdeclarativetypeloader.cpp.

732 {
733  QDeclarativeTypeData *typeData = new QDeclarativeTypeData(url, options, this);
735  return typeData;
736 }
void loadWithStaticData(QDeclarativeDataBlob *, const QByteArray &)
Load the provided blob with data.

◆ getQmldir()

QDeclarativeQmldirData * QDeclarativeTypeLoader::getQmldir ( const QUrl url)

Returns a QDeclarativeQmldirData for url.

The QDeclarativeQmldirData may be cached.

Definition at line 762 of file qdeclarativetypeloader.cpp.

Referenced by QDeclarativeTypeData::dataReceived().

763 {
764  Q_ASSERT(!url.isRelative() &&
767 
768  QDeclarativeQmldirData *qmldirData = m_qmldirCache.value(url);
769 
770  if (!qmldirData) {
771  qmldirData = new QDeclarativeQmldirData(url);
772  m_qmldirCache.insert(url, qmldirData);
773  QDeclarativeDataLoader::load(qmldirData);
774  }
775 
776  qmldirData->addref();
777  return qmldirData;
778 }
static QString urlToLocalFileOrQrc(const QUrl &url)
static bool isRelativePath(const QString &path)
Returns true if path is relative; returns false if it is absolute.
Definition: qdir.cpp:2210
#define Q_ASSERT(cond)
Definition: qglobal.h:1823
bool isRelative() const
Returns true if the URL is relative; otherwise returns false.
Definition: qurl.cpp:5880
const T value(const Key &key) const
Returns the value associated with the key.
Definition: qhash.h:606
iterator insert(const Key &key, const T &value)
Inserts a new item with the key and a value of value.
Definition: qhash.h:753
bool isEmpty() const
Returns true if the string has no characters; otherwise returns false.
Definition: qstring.h:704
void load(QDeclarativeDataBlob *)
Load the provided blob from the network or filesystem.

◆ getScript()

QDeclarativeScriptData * QDeclarativeTypeLoader::getScript ( const QUrl url)

Returns a QDeclarativeScriptData for url.

The QDeclarativeScriptData may be cached.

Definition at line 741 of file qdeclarativetypeloader.cpp.

Referenced by QDeclarativeTypeData::dataReceived().

742 {
743  Q_ASSERT(!url.isRelative() &&
746 
747  QDeclarativeScriptData *scriptData = m_scriptCache.value(url);
748 
749  if (!scriptData) {
750  scriptData = new QDeclarativeScriptData(url);
751  m_scriptCache.insert(url, scriptData);
752  QDeclarativeDataLoader::load(scriptData);
753  }
754 
755  scriptData->addref();
756  return scriptData;
757 }
static QString urlToLocalFileOrQrc(const QUrl &url)
static bool isRelativePath(const QString &path)
Returns true if path is relative; returns false if it is absolute.
Definition: qdir.cpp:2210
#define Q_ASSERT(cond)
Definition: qglobal.h:1823
bool isRelative() const
Returns true if the URL is relative; otherwise returns false.
Definition: qurl.cpp:5880
const T value(const Key &key) const
Returns the value associated with the key.
Definition: qhash.h:606
iterator insert(const Key &key, const T &value)
Inserts a new item with the key and a value of value.
Definition: qhash.h:753
bool isEmpty() const
Returns true if the string has no characters; otherwise returns false.
Definition: qstring.h:704
void load(QDeclarativeDataBlob *)
Load the provided blob from the network or filesystem.

◆ qmlDirParser()

const QDeclarativeDirParser * QDeclarativeTypeLoader::qmlDirParser ( const QString absoluteFilePath)

Return a QDeclarativeDirParser for absoluteFilePath.

The QDeclarativeDirParser may be cached.

Definition at line 824 of file qdeclarativetypeloader.cpp.

Referenced by QDeclarativeImportsPrivate::importExtension().

825 {
826  QDeclarativeDirParser *qmldirParser;
828  if (it == m_importQmlDirCache.end()) {
829  qmldirParser = new QDeclarativeDirParser;
830  qmldirParser->setFileSource(absoluteFilePath);
831  qmldirParser->setUrl(QUrl::fromLocalFile(absoluteFilePath));
832  qmldirParser->parse();
833  m_importQmlDirCache.insert(absoluteFilePath, qmldirParser);
834  } else {
835  qmldirParser = *it;
836  }
837 
838  return qmldirParser;
839 }
#define it(className, varName)
The QHash class is a template class that provides a hash-table-based dictionary.
Definition: qdatastream.h:66
iterator insert(const Key &key, const T &value)
Inserts a new item with the key and a value of value.
Definition: qhash.h:753
void setFileSource(const QString &filePath)
iterator end()
Returns an STL-style iterator pointing to the imaginary item after the last item in the hash...
Definition: qhash.h:467
static QUrl fromLocalFile(const QString &localfile)
Returns a QUrl representation of localFile, interpreted as a local file.
Definition: qurl.cpp:6374
iterator find(const Key &key)
Returns an iterator pointing to the item with the key in the hash.
Definition: qhash.h:865
void setUrl(const QUrl &url)
ImportQmlDirCache m_importQmlDirCache

Properties

◆ m_importDirCache

ImportDirCache QDeclarativeTypeLoader::m_importDirCache
private

Definition at line 218 of file qdeclarativetypeloader_p.h.

Referenced by absoluteFilePath(), and clearCache().

◆ m_importQmlDirCache

ImportQmlDirCache QDeclarativeTypeLoader::m_importQmlDirCache
private

Definition at line 219 of file qdeclarativetypeloader_p.h.

Referenced by clearCache(), and qmlDirParser().

◆ m_qmldirCache

QmldirCache QDeclarativeTypeLoader::m_qmldirCache
private

Definition at line 217 of file qdeclarativetypeloader_p.h.

Referenced by clearCache(), and getQmldir().

◆ m_scriptCache

ScriptCache QDeclarativeTypeLoader::m_scriptCache
private

Definition at line 216 of file qdeclarativetypeloader_p.h.

Referenced by clearCache(), and getScript().

◆ m_typeCache

TypeCache QDeclarativeTypeLoader::m_typeCache
private

Definition at line 215 of file qdeclarativetypeloader_p.h.

Referenced by clearCache(), and get().


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