Commit ee85384c authored by Christian Kandeler's avatar Christian Kandeler
Browse files

QML/Mobile wizard: Factor out common parts.

Reviewed-by: Alessandro Portale
parent 1b0487d5
......@@ -36,6 +36,7 @@ HEADERS += qt4deployconfiguration.h \
wizards/targetsetuppage.h \
wizards/qmlstandaloneappwizard.h \
wizards/qmlstandaloneappwizardpages.h \
wizards/abstractmobileapp.h \
wizards/qmlstandaloneapp.h \
qt4projectmanagerconstants.h \
makestep.h \
......@@ -90,6 +91,7 @@ SOURCES += qt4projectmanagerplugin.cpp \
wizards/targetsetuppage.cpp \
wizards/qmlstandaloneappwizard.cpp \
wizards/qmlstandaloneappwizardpages.cpp \
wizards/abstractmobileapp.cpp \
wizards/qmlstandaloneapp.cpp \
makestep.cpp \
qmakestep.cpp \
......
/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** Commercial Usage
**
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
**
** GNU Lesser General Public License Usage
**
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at http://qt.nokia.com/contact.
**
**************************************************************************/
#include "abstractmobileapp.h"
#include <QtCore/QCoreApplication>
#include <QtCore/QDir>
#include <QtCore/QFile>
#include <QtCore/QTextStream>
#ifndef CREATORLESSTEST
#include <coreplugin/icore.h>
#endif // CREATORLESSTEST
namespace Qt4ProjectManager {
namespace Internal {
AbstractGeneratedFileInfo::AbstractGeneratedFileInfo()
: fileType(ExtendedFile)
, version(-1)
, dataChecksum(0)
, statedChecksum(0)
{
}
bool AbstractGeneratedFileInfo::isUpToDate() const
{
return !isOutdated() && !wasModified();
}
bool AbstractGeneratedFileInfo::wasModified() const
{
return dataChecksum != statedChecksum;
}
const QString AbstractMobileApp::CFileComment(QLatin1String("//"));
const QString AbstractMobileApp::ProFileComment(QLatin1String("#"));
const QString AbstractMobileApp::DeploymentPriFileName(QLatin1String("deployment.pri"));
const QString AbstractMobileApp::FileChecksum(QLatin1String("checksum"));
const QString AbstractMobileApp::FileStubVersion(QLatin1String("version"));
const int AbstractMobileApp::StubVersion = 1;
AbstractMobileApp::AbstractMobileApp()
: m_orientation(Auto), m_networkEnabled(false)
{
}
AbstractMobileApp::~AbstractMobileApp() { }
QString AbstractMobileApp::symbianUidForPath(const QString &path)
{
quint32 hash = 5381;
for (int i = 0; i < path.size(); ++i) {
const char c = path.at(i).toAscii();
hash ^= c + ((c - i) << i % 20) + ((c + i) << (i + 5) % 20) + ((c - 2 * i) << (i + 10) % 20) + ((c + 2 * i) << (i + 15) % 20);
}
return QString::fromLatin1("0xE")
+ QString::fromLatin1("%1").arg(hash, 7, 16, QLatin1Char('0')).right(7);
}
void AbstractMobileApp::setOrientation(Orientation orientation)
{
m_orientation = orientation;
}
AbstractMobileApp::Orientation AbstractMobileApp::orientation() const
{
return m_orientation;
}
void AbstractMobileApp::setProjectName(const QString &name)
{
m_projectName = name;
}
QString AbstractMobileApp::projectName() const
{
return m_projectName;
}
void AbstractMobileApp::setProjectPath(const QString &path)
{
m_projectPath.setFile(path);
}
void AbstractMobileApp::setSymbianSvgIcon(const QString &icon)
{
m_symbianSvgIcon = icon;
}
QString AbstractMobileApp::symbianSvgIcon() const
{
return path(SymbianSvgIconOrigin);
}
void AbstractMobileApp::setMaemoPngIcon(const QString &icon)
{
m_maemoPngIcon = icon;
}
QString AbstractMobileApp::maemoPngIcon() const
{
return path(MaemoPngIconOrigin);
}
void AbstractMobileApp::setSymbianTargetUid(const QString &uid)
{
m_symbianTargetUid = uid;
}
QString AbstractMobileApp::symbianTargetUid() const
{
return !m_symbianTargetUid.isEmpty() ? m_symbianTargetUid
: symbianUidForPath(path(AppPro));
}
void AbstractMobileApp::setNetworkEnabled(bool enabled)
{
m_networkEnabled = enabled;
}
bool AbstractMobileApp::networkEnabled() const
{
return m_networkEnabled;
}
QString AbstractMobileApp::path(int fileType) const
{
const QString originsRootApp = originsRoot();
const QString originsRootShared = templatesRoot() + QLatin1String("shared/");
const QString mainCppFileName = QLatin1String("main.cpp");
const QString symbianIconFileName = QLatin1String("symbianicon.svg");
switch (fileType) {
case MainCpp: return outputPathBase() + mainCppFileName;
case MainCppOrigin: return originsRootApp + mainCppFileName;
case AppPro: return outputPathBase() + m_projectName + QLatin1String(".pro");
case AppProOrigin: return originsRootApp + QLatin1String("app.pro");
case AppProPath: return outputPathBase();
case Desktop: return outputPathBase() + m_projectName + QLatin1String(".desktop");
case DesktopOrigin: return originsRootShared + QLatin1String("app.desktop");
case DeploymentPri: return outputPathBase() + DeploymentPriFileName;
case DeploymentPriOrigin: return originsRootShared + DeploymentPriFileName;
case SymbianSvgIcon: return outputPathBase() + symbianIconFileName;
case SymbianSvgIconOrigin: return !m_symbianSvgIcon.isEmpty() ? m_symbianSvgIcon
: originsRootShared + symbianIconFileName;
case MaemoPngIcon: return outputPathBase() + projectName() + QLatin1String(".png");
case MaemoPngIconOrigin: return !m_maemoPngIcon.isEmpty() ? m_maemoPngIcon
: originsRootShared + QLatin1String("maemoicon.png");
default: return pathExtended(fileType);
}
return QString();
}
QByteArray AbstractMobileApp::generateDesktopFile(QString *errorMessage) const
{
QFile desktopTemplate(path(DesktopOrigin));
if (!desktopTemplate.open(QIODevice::ReadOnly)) {
*errorMessage = QCoreApplication::translate("AbstractMobileApp",
"Could not open desktop file template");
return QByteArray();
}
QByteArray desktopFileContent = desktopTemplate.readAll();
return desktopFileContent.replace("thisApp", projectName().toUtf8());
}
QByteArray AbstractMobileApp::generateMainCpp(QString *errorMessage) const
{
QFile sourceFile(path(MainCppOrigin));
if (!sourceFile.open(QIODevice::ReadOnly)) {
*errorMessage = tr("Could not open main.cpp template '%1'.")
.arg(sourceFile.fileName());
return QByteArray();
}
QTextStream in(&sourceFile);
QByteArray mainCppContent;
QTextStream out(&mainCppContent, QIODevice::WriteOnly);
QString line;
while (!(line = in.readLine()).isNull()) {
bool adaptLine = true;
if (line.contains(QLatin1String("// ORIENTATION"))) {
const char *orientationString;
switch (orientation()) {
case LockLandscape:
orientationString = "LockLandscape";
break;
case LockPortrait:
orientationString = "LockPortrait";
break;
case Auto:
orientationString = "Auto";
break;
}
insertParameter(line, mainWindowClassName() + QLatin1String("::")
+ QLatin1String(orientationString));
} else {
adaptLine = adaptCurrentMainCppTemplateLine(line);
}
if (adaptLine) {
const int commentIndex = line.indexOf(QLatin1String(" //"));
if (commentIndex != -1)
line.truncate(commentIndex);
out << line << endl;
}
}
return mainCppContent;
}
QByteArray AbstractMobileApp::generateProFile(QString *errorMessage) const
{
const QChar comment = QLatin1Char('#');
QFile proFile(path(AppProOrigin));
if (!proFile.open(QIODevice::ReadOnly)) {
*errorMessage = tr("Could not open project file template '%1'.")
.arg(proFile.fileName());
return QByteArray();
}
QTextStream in(&proFile);
QByteArray proFileContent;
QTextStream out(&proFileContent, QIODevice::WriteOnly);
QString valueOnNextLine;
bool uncommentNextLine = false;
QString line;
while (!(line = in.readLine()).isNull()) {
if (line.contains(QLatin1String("# TARGETUID3"))) {
valueOnNextLine = symbianTargetUid();
} else if (line.contains(QLatin1String("# ORIENTATIONLOCK"))
&& orientation() == Auto) {
uncommentNextLine = true;
} else if (line.contains(QLatin1String("# NETWORKACCESS"))
&& !networkEnabled()) {
uncommentNextLine = true;
} else {
handleCurrentProFileTemplateLine(line, in, out, uncommentNextLine);
}
// Remove all marker comments
if (line.trimmed().startsWith(comment)
&& line.trimmed().endsWith(comment))
continue;
if (!valueOnNextLine.isEmpty()) {
out << line.left(line.indexOf(QLatin1Char('=')) + 2)
<< QDir::fromNativeSeparators(valueOnNextLine) << endl;
valueOnNextLine.clear();
continue;
}
if (uncommentNextLine) {
out << comment << line << endl;
uncommentNextLine = false;
continue;
}
out << line << endl;
};
proFileContent.replace("../shared/" + DeploymentPriFileName.toAscii(),
DeploymentPriFileName.toAscii());
return proFileContent;
}
#ifndef CREATORLESSTEST
// The definition of QmlStandaloneApp::templatesRoot() for
// CREATORLESSTEST is in tests/manual/qmlstandalone/main.cpp
QString AbstractMobileApp::templatesRoot()
{
return Core::ICore::instance()->resourcePath()
+ QLatin1String("/templates/");
}
Core::GeneratedFile AbstractMobileApp::file(const QByteArray &data,
const QString &targetFile)
{
Core::GeneratedFile generatedFile(targetFile);
generatedFile.setBinary(true);
generatedFile.setBinaryContents(data);
return generatedFile;
}
Core::GeneratedFiles AbstractMobileApp::generateFiles(QString *errorMessage) const
{
Core::GeneratedFiles files;
files << file(generateFile(AbstractGeneratedFileInfo::AppProFile, errorMessage), path(AppPro));
files.last().setAttributes(Core::GeneratedFile::OpenProjectAttribute);
files << file(generateFile(AbstractGeneratedFileInfo::MainCppFile, errorMessage), path(MainCpp));
files << file(generateFile(AbstractGeneratedFileInfo::SymbianSvgIconFile, errorMessage), path(SymbianSvgIcon));
files << file(generateFile(AbstractGeneratedFileInfo::MaemoPngIconFile, errorMessage), path(MaemoPngIcon));
files << file(generateFile(AbstractGeneratedFileInfo::DesktopFile, errorMessage), path(Desktop));
files << file(generateFile(AbstractGeneratedFileInfo::DeploymentPriFile, errorMessage), path(DeploymentPri));
return files;
}
#endif // CREATORLESSTEST
QString AbstractMobileApp::error() const
{
return m_error;
}
QByteArray AbstractMobileApp::readBlob(const QString &filePath,
QString *errorMsg) const
{
QFile sourceFile(filePath);
if (!sourceFile.open(QIODevice::ReadOnly)) {
*errorMsg = QCoreApplication::translate("AbstractMobileApp",
"Could not open template file '%1'.").arg(filePath);
return QByteArray();
}
return sourceFile.readAll();
}
QByteArray AbstractMobileApp::generateFile(int fileType,
QString *errorMessage) const
{
QByteArray data;
QString comment = CFileComment;
bool versionAndChecksum = false;
switch (fileType) {
case AbstractGeneratedFileInfo::MainCppFile:
data = generateMainCpp(errorMessage);
break;
case AbstractGeneratedFileInfo::AppProFile:
data = generateProFile(errorMessage);
comment = ProFileComment;
break;
case AbstractGeneratedFileInfo::SymbianSvgIconFile:
data = readBlob(path(SymbianSvgIconOrigin), errorMessage);
break;
case AbstractGeneratedFileInfo::MaemoPngIconFile:
data = readBlob(path(MaemoPngIconOrigin), errorMessage);
break;
case AbstractGeneratedFileInfo::DesktopFile:
data = generateDesktopFile(errorMessage);
break;
case AbstractGeneratedFileInfo::DeploymentPriFile:
data = readBlob(path(DeploymentPriOrigin), errorMessage);
comment = ProFileComment;
versionAndChecksum = true;
break;
default:
data = generateFileExtended(fileType, &versionAndChecksum,
&comment, errorMessage);
}
if (!versionAndChecksum)
return data;
QByteArray versioned = data;
versioned.replace('\x0D', "");
versioned.replace('\x0A', "");
const quint16 checkSum = qChecksum(versioned.constData(), versioned.length());
const QString checkSumString = QString::number(checkSum, 16);
const QString versionString = QString::number(makeStubVersion(stubVersionMinor()));
const QChar sep = QLatin1Char(' ');
const QString versionLine =
comment + sep + FileChecksum + sep + QLatin1String("0x") + checkSumString
+ sep + FileStubVersion + sep + versionString + QLatin1Char('\x0A');
return versionLine.toAscii() + data;
}
int AbstractMobileApp::makeStubVersion(int minor)
{
return StubVersion << 16 | minor;
}
QString AbstractMobileApp::outputPathBase() const
{
return m_projectPath.absoluteFilePath() + QLatin1Char('/')
+ projectName() + QLatin1Char('/');
}
void AbstractMobileApp::insertParameter(QString &line, const QString &parameter)
{
line.replace(QRegExp(QLatin1String("\\([^()]+\\)")),
QLatin1Char('(') + parameter + QLatin1Char(')'));
}
} // namespace Internal
} // namespace Qt4ProjectManager
/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** Commercial Usage
**
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
**
** GNU Lesser General Public License Usage
**
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at http://qt.nokia.com/contact.
**
**************************************************************************/
#ifndef ABSTRACTMOBILEAPP_H
#define ABSTRACTMOBILEAPP_H
#include <QtCore/QFileInfo>
#ifndef CREATORLESSTEST
#include <coreplugin/basefilewizard.h>
#endif // CREATORLESSTEST
QT_FORWARD_DECLARE_CLASS(QTextStream);
namespace Qt4ProjectManager {
namespace Internal {
struct AbstractGeneratedFileInfo
{
enum FileType {
MainQmlFile,
MainCppFile,
AppProFile,
DeploymentPriFile,
SymbianSvgIconFile,
MaemoPngIconFile,
DesktopFile,
ExtendedFile
};
AbstractGeneratedFileInfo();
bool isUpToDate() const;
bool wasModified() const;
virtual bool isOutdated() const=0;
int fileType;
QFileInfo fileInfo;
int version;
quint16 dataChecksum;
quint16 statedChecksum;
};
class AbstractMobileApp : public QObject
{
public:
enum Orientation {
LockLandscape,
LockPortrait,
Auto
};
enum FileType {
MainCpp,
MainCppOrigin,
AppPro,
AppProOrigin,
AppProPath,
Desktop,
DesktopOrigin,
DeploymentPri,
DeploymentPriOrigin,
SymbianSvgIcon,
SymbianSvgIconOrigin,
MaemoPngIcon,
MaemoPngIconOrigin,
ExtendedFile
};
virtual ~AbstractMobileApp();
void setOrientation(Orientation orientation);
Orientation orientation() const;
void setProjectName(const QString &name);
QString projectName() const;
void setProjectPath(const QString &path);
void setSymbianSvgIcon(const QString &icon);
QString symbianSvgIcon() const;
void setMaemoPngIcon(const QString &icon);
QString maemoPngIcon() const;
void setSymbianTargetUid(const QString &uid);
QString symbianTargetUid() const;
void setNetworkEnabled(bool enabled);
bool networkEnabled() const;
static QString symbianUidForPath(const QString &path);
static int makeStubVersion(int minor);
QString path(int fileType) const;
QString error() const;
static const QString DeploymentPriFileName;
protected:
AbstractMobileApp();
static QString templatesRoot();
static void insertParameter(QString &line, const QString &parameter);
QByteArray readBlob(const QString &filePath, QString *errorMsg) const;
#ifndef CREATORLESSTEST
virtual Core::GeneratedFiles generateFiles(QString *errorMessage) const;
static Core::GeneratedFile file(const QByteArray &data,
const QString &targetFile);
#else
bool generateFiles(QString *errorMessage) const;
#endif // CREATORLESSTEST
QByteArray generateFile(int fileType, QString *errorMessage) const;
QString outputPathBase() const;
static const QString CFileComment;
static const QString ProFileComment;
static const QString FileChecksum;
static const QString FileStubVersion;
static const int StubVersion;
QString m_error;
private:
QByteArray generateDesktopFile(QString *errorMessage) const;
QByteArray generateMainCpp(QString *errorMessage) const;
QByteArray generateProFile(QString *errorMessage) const;
virtual QByteArray generateFileExtended(int fileType,
bool *versionAndCheckSum, QString *comment, QString *errorMessage) const=0;
virtual QString pathExtended(int fileType) const=0;
virtual QString originsRoot() const=0;
virtual QString mainWindowClassName() const=0;
virtual int stubVersionMinor() const=0;
virtual bool adaptCurrentMainCppTemplateLine(QString &line) const=0;
virtual void handleCurrentProFileTemplateLine(const QString &line,
QTextStream &proFileTemplate, QTextStream &proFile,
bool &uncommentNextLine) const=0;
QString m_projectName;
QFileInfo m_projectPath;
QString m_symbianSvgIcon;
QString m_maemoPngIcon;
QString m_symbianTargetUid;
Orientation m_orientation;