Get Involved/development/IDE configuration/CLion: Difference between revisions
(→Setup: Add instructions to prepare run environment variables) |
m (→Setup: do not use frame around images) |
||
| Line 9: | Line 9: | ||
Open a new project in CLion. Locate it to the folder with CMakeLists.txt. It will ask how do you want to open the project. Select CMake project. | Open a new project in CLion. Locate it to the folder with CMakeLists.txt. It will ask how do you want to open the project. Select CMake project. | ||
[[File:Clion open as cmake project.png| | [[File:Clion open as cmake project.png|frameless|300px|open as cmake project]] | ||
In CMake configuration, choose Debug build. In the Generator, set "Let Cmake decide". In the Build directory, insert the build directory path, for example, "/home/username/kde/build/dolphin". | In CMake configuration, choose Debug build. In the Generator, set "Let Cmake decide". In the Build directory, insert the build directory path, for example, "/home/username/kde/build/dolphin". | ||
[[File:Clion build configuration.png| | [[File:Clion build configuration.png|frameless|700px|build configuration]] | ||
In this same window, under CMake options, we must set some important variables such as CMAKE_PREFIX_PATH. If the prefix was in "/home/username/kde", then the CMake options line would look like: | In this same window, under CMake options, we must set some important variables such as CMAKE_PREFIX_PATH. If the prefix was in "/home/username/kde", then the CMake options line would look like: | ||
| Line 62: | Line 62: | ||
In the run/debug target (in the upper right corner of main window), select "dolphin". | In the run/debug target (in the upper right corner of main window), select "dolphin". | ||
[[File:Clion select run debug configuration.png| | [[File:Clion select run debug configuration.png|frameless|300px|select run debug configuration]] | ||
Expand it and choose Edit. | Expand it and choose Edit. | ||
[[File:Clion go to run debug configuration edit.png| | [[File:Clion go to run debug configuration edit.png|frameless|300px|go to run debug configuration edit]] | ||
The Run/Debug Configurations window will appear. | The Run/Debug Configurations window will appear. | ||
[[File:Clion run debug configuration.png| | [[File:Clion run debug configuration.png|frameless|500px|run debug configuration]] | ||
In the Environment variables field click edit button. Add variables, that you prepared in <code>~/kde/clion_run_environment.txt</code> as described above. | In the Environment variables field click edit button. Add variables, that you prepared in <code>~/kde/clion_run_environment.txt</code> as described above. | ||
[[File:Clion run debug configuration add variables.png| | [[File:Clion run debug configuration add variables.png|frameless|500px|run debug configuration add variables]] | ||
In the Toolchains you can use bundled cmake and gdb. In Arch Linux their versions are very recent and not yet supported by CLion. They can be installed with [https://aur.archlinux.org/packages/clion-cmake clion-cmake] and [https://aur.archlinux.org/packages/clion-gdb clion-gdb]. | In the Toolchains you can use bundled cmake and gdb. In Arch Linux their versions are very recent and not yet supported by CLion. They can be installed with [https://aur.archlinux.org/packages/clion-cmake clion-cmake] and [https://aur.archlinux.org/packages/clion-gdb clion-gdb]. | ||
[[File:Clion use bundled cmake and gdb.png| | [[File:Clion use bundled cmake and gdb.png|frameless|500px|use bundled cmake and gdb]] | ||
== Tips and Tricks == | == Tips and Tricks == | ||
Revision as of 16:34, 29 August 2023
CLion is a proprietary IDE for C++.
Install CLion
On Arch Linux install the clion.
Setup
Open a new project in CLion. Locate it to the folder with CMakeLists.txt. It will ask how do you want to open the project. Select CMake project.
In CMake configuration, choose Debug build. In the Generator, set "Let Cmake decide". In the Build directory, insert the build directory path, for example, "/home/username/kde/build/dolphin".
In this same window, under CMake options, we must set some important variables such as CMAKE_PREFIX_PATH. If the prefix was in "/home/username/kde", then the CMake options line would look like:
-DCMAKE_PREFIX_PATH=/home/username/kde/usr
-DCMAKE_MODULE_PATH=/home/username/kde/usr/lib64/cmake:/home/username/kde/usr/lib/cmake
-DQT_PLUGIN_PATH=/home/username/kde/usr/lib64/plugins:/home/username/kde/usr/lib/plugins
-DXDG_DATA_DIRS=/home/username/kde/usr/share
You probably would want to save that to file `~/kde/clion_cmake_options.txt` for future use.
Press OK.
Translate the content of the file ~/kde/build/dolphin/prefix.sh to the variables list that you can paste to CLion. E.g. if ~/kde/build/dolphin/prefix.sh is like:
export PATH=/home/username/kde/usr/bin:$PATH
# LD_LIBRARY_PATH only needed if you are building without rpath
# export LD_LIBRARY_PATH=/home/username/kde/usr/lib/x86_64-linux-gnu:$LD_LIBRARY_PATH
export XDG_DATA_DIRS=/home/username/kde/usr/share:${XDG_DATA_DIRS:-/usr/local/share/:/usr/share/}
export XDG_CONFIG_DIRS=/home/username/kde/usr/etc/xdg:${XDG_CONFIG_DIRS:-/etc/xdg}
export QT_PLUGIN_PATH=/home/username/kde/usr/lib/x86_64-linux-gnu/plugins:$QT_PLUGIN_PATH
export QML2_IMPORT_PATH=/home/username/kde/usr/lib/x86_64-linux-gnu/qml:$QML2_IMPORT_PATH
export QT_QUICK_CONTROLS_STYLE_PATH=/home/username/kde/usr/lib/x86_64-linux-gnu/qml/QtQuick/Controls.2/:$QT_QUICK_CONTROLS_STYLE_PATH
Then the same thing in the form of variables list for CLion looks like this block of text:
PATH=/home/username/kde/usr/bin:$PATH
XDG_DATA_DIRS=/home/username/kde/usr/share:${XDG_DATA_DIRS:-/usr/local/share/:/usr/share/}
XDG_CONFIG_DIRS=/home/username/kde/usr/etc/xdg:${XDG_CONFIG_DIRS:-/etc/xdg}
QT_PLUGIN_PATH=/home/username/kde/usr/lib/x86_64-linux-gnu/plugins:$QT_PLUGIN_PATH
QML2_IMPORT_PATH=/home/username/kde/usr/lib/x86_64-linux-gnu/qml:$QML2_IMPORT_PATH
QT_QUICK_CONTROLS_STYLE_PATH=/home/username/kde/usr/lib/x86_64-linux-gnu/qml/QtQuick/Controls.2/:$QT_QUICK_CONTROLS_STYLE_PATH
Note: if you want to modify debugging output messages, you can add corresponding variables here. See Guidelines and HOWTOs/Debugging/Using Error Messages#Controlling_Messages.
You probably want to save the above block of text, in order to reuse it when loading other KDE git repositories in CLion. E.g. to file ~/kde/clion_run_environment.txt.
In the run/debug target (in the upper right corner of main window), select "dolphin".
Expand it and choose Edit.
The Run/Debug Configurations window will appear.
In the Environment variables field click edit button. Add variables, that you prepared in ~/kde/clion_run_environment.txt as described above.
run debug configuration add variables
In the Toolchains you can use bundled cmake and gdb. In Arch Linux their versions are very recent and not yet supported by CLion. They can be installed with clion-cmake and clion-gdb.
Tips and Tricks
Out of tree breakpoints
You may want the debugger to stop on a specific breakpoint, that is located out of project tree. For example, you run and debug dolphin project: select several files, with context menu you add them to archive. And you want the debugger to stop on some function of Ark's code.
For this, you just open the corresponding file, and put a breakpoint there. No even need to map sources, like you need in Qt Creator.