1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
|
// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
// **********************************************************************
// NOTE: the sections are not ordered by their logical order to avoid
// reshuffling the file each time the index order changes (i.e., often).
// Run the fixnavi.pl script to adjust the links to the index order.
// **********************************************************************
/*!
\previouspage creator-debugging.html
\page creator-debugger-engines.html
\nextpage creator-debugger-operating-modes.html
\title Setting Up Debugger
The main debugger preferences are associated with the
\l{Adding Kits}{kit} you build and run your project with. To
specify the debugger and compiler to use for each kit, select
\uicontrol Edit > \uicontrol Preferences > \uicontrol Kits.
\image qtcreator-kits.png {Kits preferences}
You need to set up the debugger only if the automatic setup fails because
the native debugger is missing (for example, you must install the CDB
debugger on Windows yourself) or because \QC does not support the installed
version. For example, when your system does not have GDB
installed or the installed version is outdated, and you want to use a locally
installed replacement instead.
To change the debugger in an automatically detected kit, select
\uicontrol Edit > \uicontrol Preferences > \uicontrol Kits >
\uicontrol Clone to create a copy of the kit, and change the
parameters in the cloned kit. Make sure to enable the cloned kit
for your project.
If the debugger you want to use is not automatically detected, select
\uicontrol Edit > \uicontrol Preferences > \uicontrol Kits >
\uicontrol Debuggers > \uicontrol Add to add it.
\image qtcreator-preferences-kits-debuggers.webp {Debuggers tab in Kits preferences}
To use the debugging tools for Windows, you must install them.
Optionally, you can set up the Microsoft Symbol Server if you need
symbol information from Microsoft modules that is not found locally.
For more information, see \l{Setting CDB Paths on Windows}.
To use the Free Software Foundation (FSF) version of GDB on \macos, you
must sign it and modify your kit preferences.
This section describes the options you have for debugging C++ and Python code
and installing the supported native debuggers. It also
applies to code in other compiled languages such as C, FORTRAN, and Ada.
For more information about launching the debugger in different modes, see
\l{Debugger Operating Modes}.
\section1 Supported Native Debugger Versions
\QC supports native debuggers for debugging compiled code.
On most supported platforms, you can use the GNU Symbolic Debugger (GDB).
On Microsoft Windows, when using the Microsoft tool chain, you need the
Microsoft Console Debugger (CDB). On \macos and Linux, you can use the LLDB
debugger. On all supported platforms, you can use PDB to debug Python source
code.
\note You need a debugger version built with Python scripting support.
The following table summarizes the support for debugging C++ code:
\table
\header
\li Platform
\li Compiler
\li Native Debugger
\row
\li Linux
\li GCC, ICC
\li GDB, LLDB
\row
\li Unix
\li GCC, ICC
\li GDB
\row
\li \macos
\li GCC, Clang
\li LLDB, FSF GDB (experimental)
\row
\li Windows/\MinGW
\li GCC
\li GDB
\row
\li Windows/MSVC
\li Microsoft Visual C++ Compiler
\li Debugging Tools for Windows/CDB
\endtable
\section2 Supported GDB Versions
Use GDB 7.5, or later, with the Python scripting extension and Python version
3.3, or later.
For remote debugging using GDB and GDB server, the minimum supported version
of GDB server on the target \l{glossary-device}{device} is 7.0.
\section2 Supported CDB Versions
\QC supports all versions of CDB targeting platforms that Qt supports.
\section2 Supported LLDB Versions
The LLDB native debugger has similar functionality to the GDB debugger. LLDB
is the default debugger in Xcode on \macos for C++ on the desktop.
LLDB is typically used with the Clang compiler (even though you can use it
with GCC, too).
On \macos you can use the LLDB version delivered with Xcode or build from source.
The minimum supported version is LLDB 320.4. You need a LLDB version built
with Python support.
On Linux, the minimum supported version is LLDB 3.8.
\omit
\section2 GDB Adapter Modes
[Advanced Topic]
The GDB native debugger used internally by the debugger plugin runs in
different adapter modes to cope with the variety of supported platforms and
environments. All GDB adapters inherit from AbstractGdbAdapter:
\list
\li PlainGdbAdapter debugs locally started GUI processes. It is
physically split into parts that are relevant only when Python is
available, parts relevant only when Python is not available, and
mixed code.
\li TermGdbAdapter debugs locally started processes that need a console.
\li AttachGdbAdapter debugs local processes started outside \QC.
\li CoreGdbAdapter debugs core files generated from crashes.
\li RemoteGdbAdapter interacts with the GDB server running on Linux.
\endlist
\endomit
\section1 Installing Native Debuggers
The following sections describe installing native debuggers.
\section2 GDB
On Windows, use the Python-enabled GDB version that is bundled
with the Qt package or comes with recent versions of \MinGW. On
most Linux distributions, the GDB builds shipped with the system
are sufficient.
You can also build your own GDB, as instructed in
\l{http://wiki.qt.io/QtCreator_Build_Gdb}{Building GDB}.
Builds of GDB shipped with Xcode on \macos are no longer supported.
\section2 Debugging Tools for Windows
To use the CDB debugger, install the \e {Debugging Tools for Windows} when
you install \QC either by using the Qt Online Installer (in \uicontrol Qt
> \uicontrol Tools > \uicontrol {\QC}) or by using the stand-alone \QC
installation packages.
The 32-bit CDB version can only debug 32-bit executables, whereas the 64-bit
version can debug both 64-bit and 32-bit executables. However, interrupting a
32-bit executable with a 64-bit debugger can result in a stack trace of the
WOW64 emulator 32-bit emulation layer being displayed.
\QC extends the command line debugger by loading the
\c qtcreatorcdbext.dll extension library into it. The
library must be available in the \c {libs\qtcreatorcdbext64}
and \c {libs\qtcreatorcdbext32} folder. To install it there,
select \uicontrol {\QC CDB Debugger Support} when you install \QC.
When manually building \QC using
the Microsoft Visual C++ Compiler, the build process checks for
the required files in
\c{"%ProgramFiles%\Debugging Tools for Windows"}.
\section2 Debugging Tools for \macos
The Qt binary distribution has both debug and release
variants of the libraries. However, you have to explicitly tell the
runtime linker that you want to use the debug libraries even if
your application is compiled as debug, as release is the default
library.
If you use a qmake based project in \QC, you can set a flag in
your \l{glossary-run-config}{run configuration}, in
\uicontrol Projects mode. In the run configuration, select
\uicontrol{Use debug version of frameworks}.
For more detailed information about debugging on \macos,
see: \l{http://developer.apple.com/library/mac/#technotes/tn2124/_index.html#//apple_ref/doc/uid/DTS10003391}
{Mac OS X Debugging Magic}.
\section2 LLDB
We recommend using the LLDB version that is delivered with the latest Xcode.
\section2 PDB
\l{https://docs.python.org/3/library/pdb.html}{PDB} is a source code debugger
for Python applications. You can use it to debug projects that have a
\l {Creating Widget-Based Qt for Python Applications}{.pyproject}
configuration file.
You must install Python and set the interpreter to use in \uicontrol Projects
> \uicontrol Run:
\image qtcreator-run-settings-python.webp {Run settings for a Python project}
Start debugging the \c main.py file. If you encounter problems, check the
active build target in the kit selector.
\QC does not support mixed-mode debugging, but you can attach GDB to the
Python interpreter to debug the C++ implementation of the corresponding
Python code. For more information, see
\l{https://doc.qt.io/qtforpython-6/tutorials/debugging/qtcreator/qtcreator.html}
{Debugging PySide with Qt Creator (Linux)}.
\section1 Setting up FSF GDB for \macos
To use FSF GDB on \macos, you must sign it and add it to the \QC
\l{glossary-buildandrun-kit}{kits}.
\list 1
\li To create a key for signing FSF GDB, select
\uicontrol {Keychain Access} > \uicontrol {Certificate Assistant} >
\uicontrol {Create a Certificate}:
\list 1
\li In the \uicontrol Name field, input \uicontrol fsfgdb to
replace the existing content.
\li In the \uicontrol {Certificate Type} field, select
\uicontrol {Code Signing}.
\li Select the \uicontrol {Let me override defaults} check box.
\li Select \uicontrol Continue, and follow the instructions of the
wizard (use the default settings), until the
\uicontrol {Specify a Location For The Certificate} dialog
opens.
\li In the \uicontrol Keychain field, select \uicontrol System.
\li Select \uicontrol {Keychain Access} > \uicontrol System, and
locate the certificate.
\li Double click the certificate to view certificate information.
\li In the \uicontrol Trust section, select
\uicontrol {Always Trust} in the
\uicontrol {When using this certificate} field, and then close
the dialog.
\endlist
\li To sign the binary, enter the following command in the terminal:
\code
codesign -f -s "fsfgdb" $INSTALL_LOCATION/fsfgdb
\endcode
\li In \QC, select \uicontrol {\QC} > \uicontrol Preferences >
\uicontrol Kits > \uicontrol Add to
create a kit that uses FSF GDB.
\li In the \uicontrol Debugger field, specify the path to FSF GDB
(\c $HOME/gdb72/bin/fsfgdb, but with an explicit value for
\c $HOME).
\li To use the debugger, enable the kit in the \uicontrol {Build Settings}
of the project.
\endlist
*/
|
