Qt Documentation

Contents

Qt Creator integrates the following Clang tools for finding problems in C, C++, and Objective-C source code by using static analysis:

• Clang-Tidy, which provides diagnostics and fixes for typical programming errors, such as style violations or interface misuse.
• Clazy, which helps Clang understand Qt semantics. It displays Qt related compiler warnings, ranging from unnecessary memory allocation to misuse of API and provides refactoring actions for fixing some of the issues.

Note: The Clang static analyzer checks are a part of Clang-Tidy. To use the checks you must create a custom configuration for the Clang tools and enable them for Clang-Tidy.

Clang tools are delivered and installed with Qt Creator, and therefore you do not need to set them up separately.

In addition to running the tools to collect diagnostics, you can select to load diagnostics from YAML files that you exported using the -export fixes option.

Running Clang Tools

To run the Clang tools to analyze the currently open file:

• Select the (Analyze File) button on the editor toolbar.
• Select Tools >C++ >Analyze Current File.

To run the Clang tools to analyze an open project:

Select Analyze >Clang-Tidy and Clazy.

Select the files to apply the checks to.

Select Analyze to start the checks.

The found issues are displayed in the Clang-Tidy and Clazy view:

Note: If you select Debug in the mode selector to open the Debug mode and then select Clang-Tidy and Clazy, you must select the (Start) button to open the Files to Analyze dialog.

Double-click an issue to move to the location where the issue appears in the code editor.

If a fixit exists for an issue, you can select the check box next to the issue to schedule it for fixing. Select the Select Fixits check box to select all fixits. You can see the status of an issue by hovering the mouse pointer over the icon next to the check box.

To see more information about an issue that is marked with the icon, hover the mouse pointer over the line.

Select the button to customize Clang diagnostics for the current project.

To restore the global settings, select Restore Global Settings. To view and modify the global settings, select Open Global Settings. To open the Clang static analyzer, select Go to Analyzer.

Configuring Clang Tools

To configure Clang diagnostics globally for Clang tools:

In the Clang-Tidy and Clazy-Standalone fields, set the paths to the executables to use.

To build the project before running the Clang tools, select the Build the project before analysis check box. The Clang tools do not require the project to be built before analysis, but they might display misleading warnings about files missing that are generated during the build. For big projects, not building the project might save some time.

To disable automatic analysis of open documents, deselect the Analyze open files check box.

In the Parallel jobs field, select the number of jobs to run in parallel to make the analysis faster on multi-core processors.

In the Diagnostic Configuration group, select Manage to create or edit a custom configuration.

Select Copy to create a custom Clang configuration.

Читайте также:  Hkey local machine software microsoft windows currentversion setup

In the Diagnostic configuration name field, give the configuration a name, and then select OK.

In the Clang Warnings tab, select the Use diagnostic flags from the build system check box to forward diagnostic flags, such as warning flags, from the build system to the Clang code model for displaying annotations in the code editor.

In the Clang-Tidy Checks tab, select Select Checks to select the checks to perform.

For more information about the available checkers, see Clang Static Analyzer documentation.

To edit the selected check as plain text, select Edit Checks as String.

In the Clazy Checks tab, select the level of Clazy checks to perform.

In the Topic Filter field, select a topic to view only checks related to that area in the Checks field.

To view all checks again, select Reset Filter.

To view more information about the checks online, select the Web Page links next to them.

To suppress diagnostics, select Suppress This Diagnostic in the context menu. To view the suppression list for a project and to remove diagnostics from it, select Projects > Project Settings > Clang Tools.

Selecting Clazy Check Levels

The Clazy checks are divided into levels from 0 to 3. The checks at level 0 are very stable and provide hardly any false positives, while the checks at level 3 can be considered experimental. You can select the checks to perform at each level. To include the checks from the lower levels automatically, select the Enable lower levels automatically check box.

Creating Clang-Tidy Configuration Files

Clang-Tidy reads the configuration for each source file from a .clang-tidy file located in the closest parent directory of the source file. If any configuration options have a corresponding command-line option, the command-line option takes precedence. The effective configuration can be inspected using -dump-config .

Qt Creator creates the configuration for you based on the checks you select. To store the checks in file format, you can create a .clang-tidy file, as follows:

1. Select Edit Checks as String and copy the contents of the field.
2. Pipe the output of clang-tidy -dump-config into a file named .clang-tidy . For example: clang-tidy -checks=-*,bugprone-*,cppcoreguidelines-avoid-* -dump-config > .clang-tidy
3. Move the .clang-tidy file to the parent directory of the sources.

To add more checks using Qt Creator later on, copy the checks from your .clang-tidy file into the Edit Checks as String field, select additional checks, and copy-paste the contents of the field to the .clang-tidy file.

В© 2021 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.

Как использовать Clang kit с Qt Creator на Windows?

(этот вопрос похож на этот но не то же самое)

Я использую QtCreator на платформе Windows, обычно с vc toolchain.
иногда с MinGW-W64, поэтому сейчас я хотел бы попробовать clang по некоторым причинам.
в отличие от поста выше — я не использую библиотеку Qt, просто qtcreator в качестве IDE, поэтому я полагаю, что мне не нужно пересобирать ее и QtCreator для использования набора clang, это правильно?

Есть несколько вопросов по этому поводу:

1. Дистрибутив CLang не содержит платформу или даже библиотеку времени выполнения c / c ++. Должен ли я использовать ее из vc kit? или / и MinGW Runtime? как переключаться между?
2. Исправьте мое понимание, пожалуйста, если это не так — для платформы Win clang имеет два варианта использования: 1) обычное использование — clang.exe, как и на любой другой платформе 2) clang-cl.exe — дополнительный слой, который «выглядит» как cl. exe, и просто анализирует ключи командной строки cl и вызывает обычный clang.
3. насколько я понимаю, нет платформы LLDB для Windows, могу ли я использовать GDB или CDB, зависит от используемой среды выполнения lib и двоичного формата исполняемого файла?

и напоследок — как все это настроить в qtcreator?

Решение

Следующие шаги применимы только к MSYS2 64-битной установке QT Creator 4.5.1 (инструкции по установке Вот ), где у вас также установлены MinGW-w64 и mingw32-make на MSYS2; и вы создаете не-QT C или C ++ приложение.

В этих инструкциях используется QMake, потому что QBS не поддерживает MSL2 clang. Ну, QMake также не поддерживает его, но я выяснил, как добавить поддержку QMake, и я не понял QBS.

Существует поддержка QMake для MSVC-clang, но он выводит make-файлы MSVC, поэтому вы не можете собрать его с помощью MSYS2 make. Так что это не относится к нам.

1. Установите Clang с pacman , я использовал pacman -Ss mingw-w64-x86_64-clang Ваш вкус может отличаться.
2. Добавить поддержку для clang в QMake:
   1. В оболочке MSYS2 зайдите в /msys64/mingw64/share/qt5/mkspecs/
   2. Делать cp -a win32-g++ win32-clang-msys
   3. редактировать win32-clang-msys/qmake.conf и изменить gcc в clang , а также g++ в clang++ (2 места каждый)
   4. В том же файле вынь -fno-keep-inline-dllexport -mthreads которые не поддерживаются clang.
3. В QT Creator установите новый комплект:
   1. Перейти к управлению комплектами.
   2. Добавьте пользовательский компилятор для C и перейдите к установленному пути ( /mingw64/bin/clang.exe под вашим MSYS2 установить).
   3. Добавьте пользовательский компилятор для C ++ как clang++.exe в том же месте)
   4. Добавить ручной комплект под названием Clang и установить эти два компилятора в качестве его компиляторов.
   5. В конфиге ручного комплекта установите «Qt mkspec» как win32-clang-msys
   6. Установите «QT Version» на что-то. Несмотря на то, что я использую не-QT проект, IDE не любит использовать комплект, если для «Qt version» установлено значение None.

Теперь вы можете попытаться построить свой проект с Clang обвес и QMake.

Я изначально пытался с QBS и сборка не удалась из-за эта ошибка . Но команды сборки будут успешными, если я скопирую их и вырежу фальшивку -target переключатель. Так что для пользователей QBS, я полагаю, вам следует переключиться на QMake, пока они не исправят эту ошибку.

Поиск проблемы: Я иногда получаю ошибку Project ERROR: failed to parse default search paths from compiler output , Это проблема с отсутствием поддержки QMake для Clang. Ошибка, как правило, не происходит, если я построил в подкаталоге .pro файл, но это произошло, если я встроил в одноуровневую директорию.

В качестве обходного пути: вернитесь в win32-clang-msys/qmake.conf , Поменяй первый clang вернуться к g++ , Затем «Запустите Qmake» (от создателя QT или командной строки), затем верните его обратно. При первом запуске QMake записывает файл .qmake.stash и тогда не нужно генерировать его снова. Содержимое этого файла было поддельным для меня, но здание все равно работало.

Неопределенные ссылки: Я обнаружил, что связь с -static произвел кучу неопределенных ссылок на __imp__cxa_ имена. Не уверен, что проблема здесь, но, возможно, связана с ошибкой генерации .qmake.stash , Я предполагаю, что разработчикам Qt нужно будет официально добавить поддержку не-MSVC Clang в QMake.

Несколько определений: Компоновщик CLang дал несколько определений для встроенных функций DLLexport. Я еще не нашел обходного пути для этого; G ++ имеет -fno-keep-inline-dllexport чтобы избежать этой проблемы, но CLang 5 не поддерживает этот флаг.

Qt Creator Clang Code Model

Contents

Debugging

With the following invocation debugging output will be generated:

Windows (start DebugView in advance to see the output):

The debugging output contains among others:

• The IPC messages send/received
• Output of libclang while parsing

Internal command line

The debugging output from above will contain all the command line options that are passed on to libclang, which is enough for most cases.

However, to see also the resulting internal command line of libclang run:

1. Restart Qt Creator with QTC_CLANG_NO_DIAGNOSTIC_CHECK=1 (>= Qt Creator 4.5)
2. Switch to projects mode and there to the «Clang Code Model»
3. Copy some warning configuration by clicking on «Copy. «, give it a name like «Debug»
4. Replace all the options from the copied configuration with «-###»
5. Close and re-open the editor document — the new debugging output will contain also the internal command line

Note that libclang/clangbackend will crash afterwards, so do not forget to switch back to a sane warning configuration.

Related Environment Variables

Build related

• QTC_ENABLE_CLANG_LIBTOOLING — Build against Clang’s C++ libs; the ClangFormat and ClangRefactoring plugin and dependencies will be build.

Run time related

• LIBCLANG_TIMING — Timings from libclang for parse / reparse / preamble generation / completion.
• QTC_CLANG_ENABLE_STACKTRACES — For debugging. Enables the clang stack trace printer on a crash. Might deadlock clangbackend.
• QTC_CLANG_NO_DIAGNOSTIC_CHECK — Avoid validation of warning configuration (>= Qt Creator 4.5)
• QTC_CLANG_NO_SUPPORTIVE_TRANSLATIONUNIT — Use only one translation unit per document.
• QTC_CLANG_NO_ALIVE_TIMER — Simplifies debugging in certain cases.
• QTC_CLANG_FORCE_VERBOSE_ALIVE — Simplifies debugging in certain cases.

Libclang

libclang is used inside clangbackend to provide code model features

Builds

libclang is built with the same compilers as Qt Creator («Clang 7.0 (Apple)» for macOS, and GCC 5.3 from RHEL (which turns on old ABI compatibility with _GLIBCXX_USE_CXX11_ABI=0 by default) on Linux)

Currently libclang is built with optimized MinGW compiler for all Qt Creator versions. More information about Windows builds: Build libclang on Windows

Minimal libclang installation that Qt Creator can use

The following targets are sufficient for this: