tools/qmlscene/main.cpp

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   5 **
   6 ** This file is part of the tools applications of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** Commercial License Usage
  10 ** Licensees holding valid commercial Qt licenses may use this file in
  11 ** accordance with the commercial license agreement provided with the
  12 ** Software or, alternatively, in accordance with the terms contained in
  13 ** a written agreement between you and Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/contact-us.
  16 **
  17 ** GNU Lesser General Public License Usage
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #include <QtCore/qdebug.h>
  43 #include <QtCore/qabstractanimation.h>
  44 #include <QtCore/qdir.h>
  45 #include <QtCore/qmath.h>
  46 #include <QtCore/qdatetime.h>
  47
  48 #include <QtGui/QGuiApplication>
  49
  50 #include <QtQml/qqml.h>
  51 #include <QtQml/qqmlengine.h>
  52 #include <QtQml/qqmlcomponent.h>
  53 #include <QtQml/qqmlcontext.h>
  54
  55 #include <QtQuick/qquickitem.h>
  56 #include <QtQuick/qquickview.h>
  57
  58 #include <private/qabstractanimation_p.h>
  59
  60 #ifdef QT_WIDGETS_LIB
  61 #include <QtWidgets/QApplication>
  62 #include <QtWidgets/QFileDialog>
  63 #endif
  64
  65 #include <QtCore/QTranslator>
  66 #include <QtCore/QLibraryInfo>
  67
  68 #ifdef QML_RUNTIME_TESTING
  69 class RenderStatistics
  70 {
  71 public:
  72     static void updateStats();
  73     static void printTotalStats();
  74 private:
  75     static QVector<qreal> timePerFrame;
  76     static QVector<int> timesPerFrames;
  77 };
  78
  79 QVector<qreal> RenderStatistics::timePerFrame;
  80 QVector<int> RenderStatistics::timesPerFrames;
  81
  82 void RenderStatistics::updateStats()
  83 {
  84     static QTime time;
  85     static int frames;
  86     static int lastTime;
  87
  88     if (frames == 0) {
  89         time.start();
  90     } else {
  91         int elapsed = time.elapsed();
  92         timesPerFrames.append(elapsed - lastTime);
  93         lastTime = elapsed;
  94
  95         if (elapsed > 5000) {
  96             qreal avgtime = elapsed / (qreal) frames;
  97             qreal var = 0;
  98             for (int i = 0; i < timesPerFrames.size(); ++i) {
  99                 qreal diff = timesPerFrames.at(i) - avgtime;
 100                 var += diff * diff;
 101             }
 102             var /= timesPerFrames.size();
 103
 104             qDebug("Average time per frame: %f ms (%i fps), std.dev: %f ms", avgtime, qRound(1000. / avgtime), qSqrt(var));
 105
 106             timePerFrame.append(avgtime);
 107             timesPerFrames.clear();
 108             time.start();
 109             lastTime = 0;
 110             frames = 0;
 111         }
 112     }
 113     ++frames;
 114 }
 115
 116 void RenderStatistics::printTotalStats()
 117 {
 118     int count = timePerFrame.count();
 119     if (count == 0)
 120         return;
 121
 122     qreal minTime = 0;
 123     qreal maxTime = 0;
 124     qreal avg = 0;
 125     for (int i = 0; i < count; ++i) {
 126         minTime = minTime == 0 ? timePerFrame.at(i) : qMin(minTime, timePerFrame.at(i));
 127         maxTime = qMax(maxTime, timePerFrame.at(i));
 128         avg += timePerFrame.at(i);
 129     }
 130     avg /= count;
 131
 132     qDebug(" ");
 133     qDebug("----- Statistics -----");
 134     qDebug("Average time per frame: %f ms (%i fps)", avg, qRound(1000. / avg));
 135     qDebug("Best time per frame: %f ms (%i fps)", minTime, int(1000 / minTime));
 136     qDebug("Worst time per frame: %f ms (%i fps)", maxTime, int(1000 / maxTime));
 137     qDebug("----------------------");
 138     qDebug(" ");
 139 }
 140 #endif
 141
 142 struct Options
 143 {
 144     Options()
 145         : originalQml(false)
 146         , originalQmlRaster(false)
 147         , maximized(false)
 148         , fullscreen(false)
 149         , transparent(false)
 150         , clip(false)
 151         , versionDetection(true)
 152         , slowAnimations(false)
 153         , quitImmediately(false)
 154         , resizeViewToRootItem(false)
 155     {
 156     }
 157
 158     QUrl file;
 159     bool originalQml;
 160     bool originalQmlRaster;
 161     bool maximized;
 162     bool fullscreen;
 163     bool transparent;
 164     bool scenegraphOnGraphicsview;
 165     bool clip;
 166     bool versionDetection;
 167     bool slowAnimations;
 168     bool quitImmediately;
 169     bool resizeViewToRootItem;
 170     QString translationFile;
 171 };
 172
 173 #if defined(QMLSCENE_BUNDLE)
 174 QFileInfoList findQmlFiles(const QString &dirName)
 175 {
 176     QDir dir(dirName);
 177
 178     QFileInfoList ret;
 179     if (dir.exists()) {
 180         QFileInfoList fileInfos = dir.entryInfoList(QStringList() << "*.qml",
 181                                                     QDir::Files | QDir::AllDirs | QDir::NoDotAndDotDot);
 182
 183         foreach (QFileInfo fileInfo, fileInfos) {
 184             if (fileInfo.isDir())
 185                 ret += findQmlFiles(fileInfo.filePath());
 186             else if (fileInfo.fileName().length() > 0 && fileInfo.fileName().at(0).isLower())
 187                 ret.append(fileInfo);
 188         }
 189     }
 190
 191     return ret;
 192 }
 193
 194 static int displayOptionsDialog(Options *options)
 195 {
 196     QDialog dialog;
 197
 198     QFormLayout *layout = new QFormLayout(&dialog);
 199
 200     QComboBox *qmlFileComboBox = new QComboBox(&dialog);
 201     QFileInfoList fileInfos = findQmlFiles(":/bundle") + findQmlFiles("./qmlscene-resources");
 202
 203     foreach (QFileInfo fileInfo, fileInfos)
 204         qmlFileComboBox->addItem(fileInfo.dir().dirName() + "/" + fileInfo.fileName(), QVariant::fromValue(fileInfo));
 205
 206     QCheckBox *originalCheckBox = new QCheckBox(&dialog);
 207     originalCheckBox->setText("Use original QML viewer");
 208     originalCheckBox->setChecked(options->originalQml);
 209
 210     QCheckBox *fullscreenCheckBox = new QCheckBox(&dialog);
 211     fullscreenCheckBox->setText("Start fullscreen");
 212     fullscreenCheckBox->setChecked(options->fullscreen);
 213
 214     QCheckBox *maximizedCheckBox = new QCheckBox(&dialog);
 215     maximizedCheckBox->setText("Start maximized");
 216     maximizedCheckBox->setChecked(options->maximized);
 217
 218     QDialogButtonBox *buttonBox = new QDialogButtonBox(QDialogButtonBox::Ok | QDialogButtonBox::Cancel,
 219                                                        Qt::Horizontal,
 220                                                        &dialog);
 221     QObject::connect(buttonBox, SIGNAL(accepted()), &dialog, SLOT(accept()));
 222     QObject::connect(buttonBox, SIGNAL(rejected()), &dialog, SLOT(reject()));
 223
 224     layout->addRow("Qml file:", qmlFileComboBox);
 225     layout->addWidget(originalCheckBox);
 226     layout->addWidget(maximizedCheckBox);
 227     layout->addWidget(fullscreenCheckBox);
 228     layout->addWidget(buttonBox);
 229
 230     int result = dialog.exec();
 231     if (result == QDialog::Accepted) {
 232         QVariant variant = qmlFileComboBox->itemData(qmlFileComboBox->currentIndex());
 233         QFileInfo fileInfo = variant.value<QFileInfo>();
 234
 235         if (fileInfo.canonicalFilePath().startsWith(":"))
 236             options->file = QUrl("qrc" + fileInfo.canonicalFilePath());
 237         else
 238             options->file = QUrl::fromLocalFile(fileInfo.canonicalFilePath());
 239         options->originalQml = originalCheckBox->isChecked();
 240         options->maximized = maximizedCheckBox->isChecked();
 241         options->fullscreen = fullscreenCheckBox->isChecked();
 242     }
 243     return result;
 244 }
 245 #endif
 246
 247 static bool checkVersion(const QUrl &url)
 248 {
 249     if (!qgetenv("QMLSCENE_IMPORT_NAME").isEmpty())
 250         qWarning("QMLSCENE_IMPORT_NAME is no longer supported.");
 251
 252     QString fileName = url.toLocalFile();
 253     if (fileName.isEmpty()) {
 254         qWarning("qmlscene: filename required.");
 255         return false;
 256     }
 257
 258     QFile f(fileName);
 259     if (!f.open(QFile::ReadOnly | QFile::Text)) {
 260         qWarning("qmlscene: failed to check version of file '%s', could not open...",
 261                  qPrintable(fileName));
 262         return false;
 263     }
 264
 265     QRegExp quick1("^\\s*import +QtQuick +1\\.\\w*");
 266     QRegExp qt47("^\\s*import +Qt +4\\.7");
 267
 268     QTextStream stream(&f);
 269     bool codeFound= false;
 270     while (!codeFound) {
 271         QString line = stream.readLine();
 272         if (line.contains("{")) {
 273             codeFound = true;
 274         } else {
 275             QString import;
 276             if (quick1.indexIn(line) >= 0)
 277                 import = quick1.cap(0).trimmed();
 278             else if (qt47.indexIn(line) >= 0)
 279                 import = qt47.cap(0).trimmed();
 280
 281             if (!import.isNull()) {
 282                 qWarning("qmlscene: '%s' is no longer supported.\n"
 283                          "Use qmlviewer to load file '%s'.",
 284                          qPrintable(import),
 285                          qPrintable(fileName));
 286                 return false;
 287             }
 288         }
 289     }
 290
 291     return true;
 292 }
 293
 294 static void displayFileDialog(Options *options)
 295 {
 296 #if defined(QT_WIDGETS_LIB) && !defined(QT_NO_FILEDIALOG)
 297     QString fileName = QFileDialog::getOpenFileName(0, "Open QML file", QString(), "QML Files (*.qml)");
 298     if (!fileName.isEmpty()) {
 299         QFileInfo fi(fileName);
 300         options->file = QUrl::fromLocalFile(fi.canonicalFilePath());
 301     }
 302 #else
 303     Q_UNUSED(options);
 304     qWarning("No filename specified...");
 305 #endif
 306 }
 307
 308 static void loadTranslationFile(QTranslator &translator, const QString& directory)
 309 {
 310     translator.load(QLatin1String("qml_" )+QLocale::system().name(), directory + QLatin1String("/i18n"));
 311     QCoreApplication::installTranslator(&translator);
 312 }
 313
 314 static void loadDummyDataFiles(QQmlEngine &engine, const QString& directory)
 315 {
 316     QDir dir(directory+"/dummydata", "*.qml");
 317     QStringList list = dir.entryList();
 318     for (int i = 0; i < list.size(); ++i) {
 319         QString qml = list.at(i);
 320         QFile f(dir.filePath(qml));
 321         f.open(QIODevice::ReadOnly);
 322         QByteArray data = f.readAll();
 323         QQmlComponent comp(&engine);
 324         comp.setData(data, QUrl());
 325         QObject *dummyData = comp.create();
 326
 327         if(comp.isError()) {
 328             QList<QQmlError> errors = comp.errors();
 329             foreach (const QQmlError &error, errors)
 330                 qWarning() << error;
 331         }
 332
 333         if (dummyData) {
 334             qWarning() << "Loaded dummy data:" << dir.filePath(qml);
 335             qml.truncate(qml.length()-4);
 336             engine.rootContext()->setContextProperty(qml, dummyData);
 337             dummyData->setParent(&engine);
 338         }
 339     }
 340 }
 341
 342 static void usage()
 343 {
 344     qWarning("Usage: qmlscene [options] <filename>");
 345     qWarning(" ");
 346     qWarning(" options:");
 347     qWarning("  --maximized ............................... run maximized");
 348     qWarning("  --fullscreen .............................. run fullscreen");
 349     qWarning("  --transparent ............................. Make the window transparent");
 350     qWarning("  --no-multisample .......................... Disable multisampling (anti-aliasing)");
 351     qWarning("  --no-version-detection .................... Do not try to detect the version of the .qml file");
 352     qWarning("  --slow-animations ......................... Run all animations in slow motion");
 353     qWarning("  --resize-to-root .......................... Resize the window to the size of the root item");
 354     qWarning("  --quit .................................... Quit immediately after starting");
 355     qWarning("  -I <path> ................................. Add <path> to the list of import paths");
 356     qWarning("  -B <name> <file> .......................... Add a named bundle");
 357     qWarning("  -translation <translationfile> ........... set the language to run in");
 358
 359     qWarning(" ");
 360     exit(1);
 361 }
 362
 363 int main(int argc, char ** argv)
 364 {
 365     Options options;
 366
 367     QStringList imports;
 368     QList<QPair<QString, QString> > bundles;
 369     for (int i = 1; i < argc; ++i) {
 370         if (*argv[i] != '-' && QFileInfo(QFile::decodeName(argv[i])).exists()) {
 371             options.file = QUrl::fromLocalFile(argv[i]);
 372         } else {
 373             const QString lowerArgument = QString::fromLatin1(argv[i]).toLower();
 374             if (lowerArgument == QLatin1String("--maximized"))
 375                 options.maximized = true;
 376             else if (lowerArgument == QLatin1String("--fullscreen"))
 377                 options.fullscreen = true;
 378             else if (lowerArgument == QLatin1String("--transparent"))
 379                 options.transparent = true;
 380             else if (lowerArgument == QLatin1String("--clip"))
 381                 options.clip = true;
 382             else if (lowerArgument == QLatin1String("--no-version-detection"))
 383                 options.versionDetection = false;
 384             else if (lowerArgument == QLatin1String("--slow-animations"))
 385                 options.slowAnimations = true;
 386             else if (lowerArgument == QLatin1String("--quit"))
 387                 options.quitImmediately = true;
 388            else if (lowerArgument == QLatin1String("-translation"))
 389                 options.translationFile = QLatin1String(argv[++i]);
 390             else if (lowerArgument == QLatin1String("--resize-to-root"))
 391                 options.resizeViewToRootItem = true;
 392             else if (lowerArgument == QLatin1String("-i") && i + 1 < argc)
 393                 imports.append(QString::fromLatin1(argv[++i]));
 394             else if (lowerArgument == QLatin1String("-b") && i + 2 < argc) {
 395                 QString name = QString::fromLatin1(argv[++i]);
 396                 QString file = QString::fromLatin1(argv[++i]);
 397                 bundles.append(qMakePair(name, file));
 398             } else if (lowerArgument == QLatin1String("--help")
 399                      || lowerArgument == QLatin1String("-help")
 400                      || lowerArgument == QLatin1String("--h")
 401                      || lowerArgument == QLatin1String("-h"))
 402                 usage();
 403         }
 404     }
 405
 406 #ifdef QT_WIDGETS_LIB
 407     QApplication app(argc, argv);
 408 #else
 409     QGuiApplication app(argc, argv);
 410 #endif
 411     app.setApplicationName("QtQmlViewer");
 412     app.setOrganizationName("Qt Project");
 413     app.setOrganizationDomain("qt-project.org");
 414
 415     QTranslator translator;
 416     QTranslator qtTranslator;
 417     QString sysLocale = QLocale::system().name();
 418     if (translator.load(QLatin1String("qmlscene_") + sysLocale, QLibraryInfo::location(QLibraryInfo::TranslationsPath))) {
 419         app.installTranslator(&translator);
 420         if (qtTranslator.load(QLatin1String("qt_") + sysLocale, QLibraryInfo::location(QLibraryInfo::TranslationsPath))) {
 421             app.installTranslator(&qtTranslator);
 422         } else {
 423             app.removeTranslator(&translator);
 424         }
 425     }
 426
 427     QTranslator qmlTranslator;
 428     if (!options.translationFile.isEmpty()) {
 429         if (qmlTranslator.load(options.translationFile)) {
 430             app.installTranslator(&qmlTranslator);
 431         } else {
 432             qWarning() << "Could not load the translation file" << options.translationFile;
 433         }
 434     }
 435
 436     QUnifiedTimer::instance()->setSlowModeEnabled(options.slowAnimations);
 437
 438     if (options.file.isEmpty())
 439 #if defined(QMLSCENE_BUNDLE)
 440         displayOptionsDialog(&options);
 441 #else
 442         displayFileDialog(&options);
 443 #endif
 444
 445     int exitCode = 0;
 446
 447     if (!options.file.isEmpty()) {
 448         if (!options.versionDetection || checkVersion(options.file)) {
 449             QTranslator translator;
 450
 451             // TODO: as soon as the engine construction completes, the debug service is
 452             // listening for connections.  But actually we aren't ready to debug anything.
 453             QQmlEngine engine;
 454             QQmlComponent *component = new QQmlComponent(&engine);
 455             for (int i = 0; i < imports.size(); ++i)
 456                 engine.addImportPath(imports.at(i));
 457             for (int i = 0; i < bundles.size(); ++i)
 458                 engine.addNamedBundle(bundles.at(i).first, bundles.at(i).second);
 459             if (options.file.isLocalFile()) {
 460                 QFileInfo fi(options.file.toLocalFile());
 461                 loadTranslationFile(translator, fi.path());
 462                 loadDummyDataFiles(engine, fi.path());
 463             }
 464             QObject::connect(&engine, SIGNAL(quit()), QCoreApplication::instance(), SLOT(quit()));
 465             component->loadUrl(options.file);
 466             if ( !component->isReady() ) {
 467                 qFatal(qPrintable(component->errorString()));
 468                 return -1;
 469             }
 470
 471             QObject *topLevel = component->create();
 472             QQuickWindow *window = qobject_cast<QQuickWindow *>(topLevel);
 473             QQuickView* qxView = 0;
 474             if (!window) {
 475                 QQuickItem *contentItem = qobject_cast<QQuickItem *>(topLevel);
 476                 if (contentItem) {
 477                     qxView = new QQuickView(&engine, NULL);
 478                     window = qxView;
 479                     // Set window default properties; the qml can still override them
 480                     QString oname = contentItem->objectName();
 481                     window->setTitle(oname.isEmpty() ? QString::fromLatin1("qmlscene") : QString::fromLatin1("qmlscene: ") + oname);
 482                     window->setFlags(Qt::Window | Qt::WindowSystemMenuHint | Qt::WindowTitleHint | Qt::WindowMinMaxButtonsHint | Qt::WindowCloseButtonHint);
 483                     if (options.resizeViewToRootItem)
 484                         qxView->setResizeMode(QQuickView::SizeViewToRootObject);
 485                     else
 486                         qxView->setResizeMode(QQuickView::SizeRootObjectToView);
 487                     qxView->setContent(options.file, component, contentItem);
 488                 }
 489             }
 490
 491             if (window) {
 492                 if (options.transparent) {
 493                     QSurfaceFormat surfaceFormat;
 494                     surfaceFormat.setAlphaBufferSize(8);
 495                     window->setFormat(surfaceFormat);
 496                     window->setClearBeforeRendering(true);
 497                     window->setColor(QColor(Qt::transparent));
 498                     window->setWindowFlags(Qt::FramelessWindowHint);
 499                 }
 500
 501                 if (options.fullscreen)
 502                     window->showFullScreen();
 503                 else if (options.maximized)
 504                     window->showMaximized();
 505                 else
 506                     window->show();
 507             }
 508
 509             if (options.quitImmediately)
 510                 QMetaObject::invokeMethod(QCoreApplication::instance(), "quit", Qt::QueuedConnection);
 511
 512             // Now would be a good time to inform the debug service to start listening.
 513
 514             exitCode = app.exec();
 515
 516 #ifdef QML_RUNTIME_TESTING
 517             RenderStatistics::printTotalStats();
 518 #endif
 519             // Ready to exit.  If we created qxView, it owns the component;
 520             // otherwise, the ownership is still right here.  Nobody deletes the engine
 521             // (which is odd since the container constructor takes the engine pointer),
 522             // but it's stack-allocated anyway.
 523             if (qxView)
 524                 delete qxView;
 525             else
 526                 delete component;
 527         }
 528     }
 529
 530     return exitCode;
 531 }