Débogage des applications QML

Lorsque vous développez une application avec QML, il existe de nombreuses façons de déboguer les problèmes auxquels vous pourriez être confronté. Les sections ci-dessous décrivent les outils de débogage disponibles et leur utilisation.

API de la console

function f(a, b) {
  console.log("a is ", a, "b is ", b);
}

function f() {
  var x = 12
  console.assert(x == 12, "This will pass");
  console.assert(x > 12, "This will fail");
}

function f() {
    console.time("wholeFunction");
    console.time("firstPart");
    // first part
    console.timeEnd("firstPart");
    // second part
    console.timeEnd("wholeFunction");
}

function f() {
  console.count("f called");
}

function f() {
    console.profile();
    //Call some function that needs to be profiled.
    //Ensure that a client is attached before ending
    //the profiling session.
    console.profileEnd();
}

Il est également possible de passer une expression « logging category » en tant que premier argument à l’une de ces fonctions console. Pour plus de détails, consultez LoggingCategory.

Débogage des importations de modules

Définissez la variable d’environnement QML_IMPORT_TRACE pour activer les messages de débogage provenant des mécanismes de chargement des importations de QML.

Par exemple, pour un fichier QML simple comme celui-ci :

import QtQuick

Rectangle { width: 100; height: 100 }

Si vous définissez QML_IMPORT_TRACE=1 avant d'exécuter l'outil «QML Runtime » ou votre application QML C++, vous obtiendrez une sortie similaire à celle-ci :

QQmlImportDatabase::addImportPath "/qt-sdk/imports"
QQmlImportDatabase::addImportPath "/qt-sdk/bin/QMLViewer.app/Contents/MacOS"
QQmlImportDatabase::addToImport 0x106237370 "." -1.-1 File as ""
QQmlImportDatabase::addToImport 0x106237370 "Qt" 4.7 Library as ""
QQmlImportDatabase::resolveType "Rectangle" = "QDeclarativeRectangle"

Infrastructure de débogage QML

Le Qt Qml module fournit des services permettant de déboguer, d’inspecter et de profiler des applications via un port TCP ou un socket local.

Activation de l’infrastructure

Lorsque vous compilez votre application, vous devez activer explicitement l'infrastructure de débogage.

Si vous utilisez CMake, vous pouvez passer ` -DCMAKE_CXX_FLAGS_INIT=-DQT_QML_DEBUG ` en argument à ` cmake ` sur la ligne de commande pour l’activer uniquement pour une compilation spécifique. Vous pouvez également l’activer de manière permanente dans votre fichier `CMakeLists.txt` en ajoutant l’extrait de code suivant :

qt_add_executable(MyApp
...
)

target_compile_definitions(MyApp PRIVATE QT_QML_DEBUG)

Si vous utilisez qmake, vous pouvez ajouter les paramètres de configuration « CONFIG+=qml_debug » au fichier « .pro » du projet ou les passer en argument sur la ligne de commande.

Si vous utilisez un autre système de compilation, vous devez transmettre la définition ` QT_QML_DEBUG ` au compilateur via les moyens fournis par ce système.

Lancement des applications

Pour activer le débogage – dès le démarrage ou pour y associer un débogueur ultérieurement –, lancez l'application avec les arguments suivants :

-qmljsdebugger=port:<port_from>[,port_to][,host:<ip address>][,block][,file:<local socket>][,services:<comma-separated list of services to enable>]

Où :

• l'argument obligatoire « port_from » spécifie soit le port de débogage, soit le port de départ d’une plage de ports lorsque « port_to » est spécifié
• l’ ip address, facultative, spécifie l’adresse IP de l’hôte sur lequel l’application s’exécute
• l'block, facultative, empêche l'application de s'exécuter tant que le client de débogage ne s'est pas connecté au serveur
• l'file, facultative, spécifie le socket local.
• l’ services, facultatif, spécifie les services à activer ; par défaut, tous ceux qui sont détectés sont activés. Notez que le service v4 debug désactive le JIT.

Une fois l'application lancée avec succès, elle affiche le message suivant :

QML Debugger: Waiting for connection on port <port_number>

ou

QML Debugger: Connecting to socket at <file>

Connexion aux applications

Lorsque l’application est en cours d’exécution, un IDE ou un outil implémentant le protocole binaire peut se connecter au port ouvert.

Le débogage avec Qt Creator

Qt Creator utilise l’infrastructure de débogage pour déboguer, inspecter et profiler les applications QML aussi bien sur le bureau que sur des appareils distants. Qt Creator fournit des clients intégrés pour déboguer du JavaScript, inspecter l’arborescence des objets et profiler les activités d’un moteur QML. Pour plus d’informations, consultez Qt Creator: Débogage de projets Qt Quick .

Le débogage avec Qt Extension for Visual Studio Code

Qt Extension for Visual Studio Code fournit des clients intégrés pour le débogage de JavaScript et le profilage de l’activité du moteur QML. Pour plus d’informations, consultez Qt Extension for Visual Studio Code: Débogage d’applications Qt Quick .