Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
qqmltypescreator_p.h
Go to the documentation of this file.
1// Copyright (C) 2019 The Qt Company Ltd.
2// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
3
4#ifndef QMLTYPESCREATOR_P_H
5#define QMLTYPESCREATOR_P_H
6
7//
8// W A R N I N G
9// -------------
10//
11// This file is not part of the Qt API. It exists purely as an
12// implementation detail. This header file may change from version to
13// version without notice, or even be removed.
14//
15// We mean it.
16//
17
20
21#include <QtCore/qstring.h>
22#include <QtCore/qset.h>
23
25
27{
28public:
30
31 bool generate(const QString &outFileName);
32
33 void setOwnTypes(QVector<MetaType> ownTypes) { m_ownTypes = std::move(ownTypes); }
34 void setForeignTypes(QVector<MetaType> foreignTypes) { m_foreignTypes = std::move(foreignTypes); }
35 void setReferencedTypes(QList<QAnyStringView> referencedTypes) { m_referencedTypes = std::move(referencedTypes); }
36 void setModule(QByteArray module) { m_module = std::move(module); }
37 void setVersion(QTypeRevision version) { m_version = version; }
38 void setUsingDeclarations(QList<UsingDeclaration> usingDeclarations) { m_usingDeclarations = std::move(usingDeclarations);}
39 void setGeneratingJSRoot(bool jsroot) { m_generatingJSRoot = jsroot; }
40
41private:
42 void writeComponent(const QmlTypesClassDescription &collector);
43 void writeClassProperties(const QmlTypesClassDescription &collector);
44 void writeType(QAnyStringView type);
45 void writeProperties(const Property::Container &properties);
46 void writeMethods(const Method::Container &methods, QLatin1StringView type);
47 void writeEnums(const Enum::Container &enums);
48 void writeComponents();
49 void writeRootMethods(const MetaType &classDef);
50
51 QByteArray m_output;
52 QQmlJSStreamWriter m_qml;
53 QVector<MetaType> m_ownTypes;
54 QVector<MetaType> m_foreignTypes;
55 QList<QAnyStringView> m_referencedTypes;
56 QList<UsingDeclaration> m_usingDeclarations;
57 QByteArray m_module;
58 QTypeRevision m_version = QTypeRevision::zero();
59 bool m_generatingJSRoot = false;
60};
61
62QT_END_NAMESPACE
63
64#endif // QMLTYPESCREATOR_P_H
MetaType()=default
bool generatePluginTypes(const QString &pluginTypesFile, bool generatingJSRoot=false)
void setModuleNameAndNamespace(const QString &module, const QString &targetNamespace)
static bool argumentsFromCommandLineAndFile(QStringList &allArguments, const QStringList &arguments)
void setTypes(const QVector< MetaType > &types, const QVector< MetaType > &foreignTypes)
void setIncludes(const QList< QString > &includes)
static int runExtract(const QString &baseName, const QString &nameSpace, const MetaTypesJsonProcessor &processor)
void write(QTextStream &os, QAnyStringView outFileName) const
void setModuleVersions(QTypeRevision moduleVersion, const QList< quint8 > &pastMajorVersions, bool followForeignVersioning)
void setUsingDeclarations(const QList< UsingDeclaration > &usingDeclarations)
void setReferencedTypes(const QList< QAnyStringView > &referencedTypes)
void setGeneratingJSRoot(bool jsroot)
void setUsingDeclarations(QList< UsingDeclaration > usingDeclarations)
void setForeignTypes(QVector< MetaType > foreignTypes)
bool generate(const QString &outFileName)
void setModule(QByteArray module)
void setOwnTypes(QVector< MetaType > ownTypes)
void setVersion(QTypeRevision version)
void setReferencedTypes(QList< QAnyStringView > referencedTypes)
static QString registrationVarName(const QString &module)
bool operator<(const ExclusiveVersionRange &x, const ExclusiveVersionRange &y)
True if x was removed before y was introduced.
QString conflictingVersionToString(const ExclusiveVersionRange &r)
bool operator==(const ExclusiveVersionRange &x, const ExclusiveVersionRange &y)
True when x and y share a common version.