IDE Debug Helpers

From Qt Wiki
Revision as of 18:23, 8 September 2020 by Christian Ehrlicher (talk | contribs)
Jump to: navigation, search


Qt Creator

Qt Creator directly supports introspection of all Qt Containers and QObject derived classes for Qt 4 and Qt 5. User defined types can be supported in addition, see the Qt Creator documentation for details.

LLDB

There is an effort to introspect Qt types using LLDB at https://bitbucket.org/lukeworth/lldb-qt-formatters.

KDevelop ships formatter scripts in its LLDB plugin for Qt types that can be used directly in plain LLDB. https://unlimitedcodeworks.xyz/blog/2016/08/20/gsoc-kdevelop-lldb-final-report/#using-data-formatter-scripts-outside-kdevelop

MS Visual Studio 2012 and up

There is a new way to visualize native type, see http://code.msdn.microsoft.com/Writing-type-visualizers-2eae77a2 and http://blogs.msdn.com/b/vcblog/archive/2013/06/28/using-visual-studio-2013-to-write-maintainable-native-visualizations-natvis.aspx for details.

The qt5.natvis file is also included in the Visual Studio add-in which automatically installs it in the correct directory.

So we can visualize QString and some other types using qt5.natvis file (save to file: %USERPROFILE%\Documents\Visual Studio <version>\Visualizers\qt5.natvis)

<?xml version="1.0" encoding="utf-8"?>
<AutoVisualizer >

<Type Name="QString">
    <DisplayString>{((reinterpret_cast<unsigned short*>(d)) + d->offset / 2),sub}</DisplayString>
    <StringView>((reinterpret_cast<unsigned short*>(d)) + d->offset / 2),sub</StringView>
    <Expand>
        <Item Name="[size]">d->size</Item>
        <Item Name="[referenced]">d->ref.atomic._q_value</Item>
        <ArrayItems>
            <Size>d->size</Size>
            <ValuePointer>((reinterpret_cast<unsigned short*>(d)) + d->offset / 2),c</ValuePointer>
        </ArrayItems>
    </Expand>
</Type>

<Type Name="QByteArray">
    <DisplayString>{((reinterpret_cast<char*>(d)) + d->offset),sb}</DisplayString>
    <StringView>((reinterpret_cast<char*>(d)) + d->offset),sb</StringView>
    <Expand>
        <Item Name="[size]">d->size</Item>
        <Item Name="[referenced]">d->ref.atomic._q_value</Item>
        <ArrayItems>
            <Size>d->size</Size>
            <ValuePointer>((reinterpret_cast<char*>(d)) + d->offset),c</ValuePointer>
        </ArrayItems>
    </Expand>
</Type>

<!— More Qt5 types… —>

</AutoVisualizer>

MS Visual Studio before 2012 - QString & QByteArray expansions

The new layout of QString in Qt 5 is hard to inspect using the debugger. The following code can be added to autoexp.dat (c:\program files(x86)\visual studio 9.0\common7\packages\debugger\autoexp.dat) You should add it to the [Visualizer] section, before the STL/ATL containers.

; Qt types
QStringData{
 preview ([(unsigned short*)$e.d + $e.offset,su])
 stringview ([(unsigned short*)$e.d + $e.offset,sub])
}
QString{
 preview ([$e.d])
}
QByteArrayData{
 preview ([(unsigned char*)$e.d + $e.offset,s])
 stringview ([(unsigned char*)$e.d + $e.offset,sb])
}
QByteArray{
 preview ([$e.d])
}

If all else fails you can always just add a watcher for

  (char*)str.d + str.d->offset,su

in the debugger, to see the contents of str.