Jump to content

Get Involved/development/IDE configuration/CLion: Difference between revisions

From KDE Community Wiki
← Older edit
Ashark (talk | contribs)
webadmin
287 edits
Remove duplicated block of text, colorize result
Ashark (talk | contribs)
webadmin
287 edits
Use link to moved page
Tag: Replaced
 
(30 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[https://www.jetbrains.com/clion/ CLion] is a proprietary IDE for C++ from JetBrains.
Moved to https://develop.kde.org/docs/getting-started/building/ide/clion/
 
A screen recording version is available https://www.youtube.com/watch?v=_V5AqMj2fWc
 
== Install CLion ==
 
Follow the [https://www.jetbrains.com/help/clion/installation-guide.html Install CLion] documentation.
 
If using Arch Linux, you can install the AUR package [https://aur.archlinux.org/packages/clion clion].
 
== Setup a KDE project in CLion ==
 
In this article we will use ''dolphin'' as an example project. Prerequisite is that you have successfully built a project following kdesrc-build setup procedure. This article assumes your username is {{ic|username}}, and the kdesrc-build setup path is {{ic|/home/username/kde/}}. Replace them to the your values in the specified commands.
 
=== Importing project ===
 
In the "Welcome to Clion" window press "Open" button. In the "Open File or Project", chose a root folder of ''dolphin'' project ({{ic|~/kde/src/dolphin}}) or select the {{ic|CMakeLists.txt}} file in that directory. It will ask how do you want to open it. Press "Open as Project" for file, or "Open as CMake project" for directory.
 
[[File:Clion open as cmake project.png|frameless|300px|open as cmake project]]
 
=== CMake profile ===
 
After previous step, the new window will open to setup cmake profile. You can reach these settings later by going to '''Settings | Build, Execution, Deployment | CMake'''. Choose ''Debug'' build. In the ''Generator'', set "Let Cmake decide". In the ''Build directory'', specify the build directory path, for this example it will be {{ic|/home/username/kde/build/dolphin}}.
 
[[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:
 
<syntaxhighlight lang="ini">
-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
</syntaxhighlight>
 
You probably would want to save that to file `~/kde/clion_cmake_options.txt` for future use.
 
Press OK.
 
=== Run/Debug Configuration ===
 
In the run/debug target (in the upper right corner of main window), select "dolphin".
 
[[File:Clion select run debug configuration.png|frameless|300px|select run debug configuration]]
 
Expand it and choose Edit.
 
[[File:Clion go to run debug configuration edit.png|frameless|300px|go to run debug configuration edit]]
 
The Run/Debug Configurations window will appear.
 
[[File:Clion run debug configuration.png|frameless|500px|run debug configuration]]
 
In the Environment variables field click edit button.
 
You can add variables in there manually or reuse exports from <code>prefix.sh</code> script from build directory.
 
Note: if you want to modify debugging output messages, you can add corresponding variables there. See [[Guidelines and HOWTOs/Debugging/Using Error Messages#Controlling_Messages]].
 
==== Variants to setup environment variables ====
[[File:Clion run environment variables.png|frameless|400px|run debug variables configuration]]
 
===== Reusing existing prefix.sh =====
 
For convenience, copy the <code>/home/username/kde/build/dolphin/prefix.sh</code> to <code>/home/username/kde/clion_run_environment.sh</code>. [https://www.jetbrains.com/help/clion/2023.2/run-debug-configuration.html#envvars-progargs Use] the following syntax for setting variables in that script: <code>export VAR=value</code>.
 
In the Environment Variables dialog, in the Load Variables from file field, paste the path <code>/home/username/kde/clion_run_environment.sh</code>.
 
===== Setting variables manually =====
 
Translate the content of the file <code>~/kde/build/dolphin/prefix.sh</code> to the variables list that you can paste to CLion. E.g. if <code>~/kde/build/dolphin/prefix.sh</code> is like:
 
<syntaxhighlight lang="bash">
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
</syntaxhighlight>
 
Then the same thing in the form of variables list for CLion looks like this block of text:
 
<syntaxhighlight lang="bash">
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$
</syntaxhighlight>
 
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 <code>~/kde/clion_run_environment.txt</code>.
 
Then in the Environment Variables dialog, paste the contents of the <code>~/kde/clion_run_environment.txt</code>.
 
== Additional settings ==
 
In the Settings | Build, Execution, Deployment | 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|frameless|500px|use bundled cmake and gdb]]
 
== Tips and Tricks ==
 
=== Set defaults for new projects ===
 
For convenience, you can specify default settings for new opened projects. This allows you to not set it manually for each new project you open in CLion.
 
Go to '''File | New Projects Setup | Settings for New Projects'''. The '''Build, Execution, Deployment | CMake''' page will be opened. Open the ''Debug'' profile.
 
In the ''Generator'' field choose 'Let CMake decide'.
 
In the ''Build directory'' field type: <code>$PROJECT_DIR$/../../build/$PROJECT_NAME$</code>.
 
Press OK button.
 
=== JetBrains Dolphin Plugin ===
 
[https://github.com/alex1701c/JetBrainsDolphinPlugin JetBrains Dolphin Plugin] is a service menu plugin (context menu action) which allows you to easily open folders as ide projects.
 
You can install it from the store.kde.org (in the ''Configure Dolphin'' choose ''Context Menu'', then press ''Download New Services...'' button. Search for ''Jetbrains Dolphin Plugin'' by alex1701c).
 
If using Arch Linux, you will prefer to install from [https://aur.archlinux.org/packages/kf5-servicemenus-jetbrains-dolphin-plugin-git AUR].
 
=== Qt6Renderer ===
 
Currently, the Qt classes do not support pretty printing in debugger in CLion out of the box. See [https://youtrack.jetbrains.com/issue/CPP-605/Qt-types-renderers Bug CPP-605] for more information.
 
You can install [https://plugins.jetbrains.com/plugin/19882-qt6-renderer Qt6Renderer] plugin by Nikita Kobzev. Note that currently it works only with lldb debugger.
 
== Additional notes ==
 
{{Construction|Notes need reworking}}
 
Note that I tell kdesrc-build to use the CMake generator "Unix Makefiles" by commenting out the line <code>cmake-generator</code> from the kdesrc-buildrc configuration file. I also need to configure kdesrc-build to use the CMake build configuration "Debug" in order to be able to use the debugger in the IDE, and I use more than 4 CPU threads. For more details see the wiki page for the IDE [[Get_Involved/development/IDE_configuration/Qt_Creator|QtCreator]].
 
<pre>
cmake-options -DCMAKE_BUILD_TYPE=Debug
...
num-cores 14
...
#cmake-generator Kate - Ninja
</pre>
 
Build a KDE project e.g.
<pre>
kdesrc-build kcalc --debug
</pre>
 
Look at the output, write down the part similar to:
{{bc|1=
        Running cmake targeting Unix Makefiles...
        cd /home/username/kde/build/kcalc
 
run_logged_command(): Module kcalc, Command: cmake -B . -S /home/username/kde/src/kcalc -G Unix Makefiles -DCMAKE_EXPORT_COMPILE_COMMANDS:BOOL=ON -DCMAKE_BUILD_TYPE=Debug -DBUILD_WITH_QT6=ON -DCMAKE_CXX_FLAGS:STRING=-pipe -DCMAKE_INSTALL_PREFIX=/home/username/kde/usr -DCMAKE_PREFIX_PATH=/home/username/Qt/6.6.0/gcc_64
        Setting environment variable {{color|green|XDG_DATA_DIRS}} to {{color|lime|/home/username/kde/usr/share:/usr/share/plasma:/usr/local/share:/usr/share:/var/lib/snapd/desktop}}
        Setting environment variable {{color|green|PATH}} to {{color|lime|/home/username/kde/usr/bin:/home/username/Qt/6.6.0/gcc_64/bin:/home/username/.local/bin:/home/username/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/snap/bin}}
        Setting environment variable {{color|green|CMAKE_MODULE_PATH}} to {{color|lime|/home/username/Qt/6.6.0/gcc_64/lib/cmake:/home/username/kde/usr/lib64/cmake:/home/username/kde/usr/lib/cmake}}
        Setting environment variable {{color|green|PKG_CONFIG_PATH}} to {{color|lime|/home/username/kde/usr/lib/pkgconfig:/home/username/Qt/6.6.0/gcc_64/lib/pkgconfig}}
        Setting environment variable {{color|green|LD_LIBRARY_PATH}} to {{color|lime|/home/username/kde/usr/lib:/home/username/Qt/6.6.0/gcc_64/lib}}
        Setting environment variable CMAKE_PREFIX_PATH to {{color|lime|/home/username/Qt/6.6.0/gcc_64:/home/username/kde/usr}}
        Setting environment variable {{color|green|QT_PLUGIN_PATH}} to {{color|lime|/home/username/kde/usr/lib64/plugins:/home/username/kde/usr/lib/plugins}}
}}
 
In the "Welcome to CLion" wizard > "Open" > "/home/username/kde/src/kcalc/CMakeLists.txt" > OK. The dialog "Open Project CMakeLists.txt is a project file. Would you like to open the project?" is shown, select "Open as Project". Enable check box "Trust projects in ~/kde/src" > "Trust Project" button. In the "Open Project Wizard" dialog select "OK".
 
Look at the the part that you have written down from the output of <code>kdesrc-build kcalc --debug</code>.
In Settings > Build, Execution, Deployment select the "Debug" CMake "Profile". "Generator:" "Let CMake decide", "Build directory:" "/home/username/kde/build/kcalc".
 
CMake options:
<pre>
-G "Unix Makefiles" -DCMAKE_EXPORT_COMPILE_COMMANDS:BOOL=ON -DCMAKE_BUILD_TYPE=Debug -DBUILD_WITH_QT6=ON -DCMAKE_CXX_FLAGS:STRING=-pipe -DCMAKE_INSTALL_PREFIX=/home/username/kde/usr -DCMAKE_PREFIX_PATH=/home/username/Qt/6.6.0/gcc_64
</pre>
 
From the text above, prepare the variables and value definitions like this:
<syntaxhighlight lang="ini">
XDG_DATA_DIRS=/home/username/kde/usr/share:/usr/share/plasma:/usr/local/share:/usr/share:/var/lib/snapd/desktop
PATH=/home/username/kde/usr/bin:/home/username/Qt/6.6.0/gcc_64/bin:/home/username/.local/bin:/home/username/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/snap/bin
CMAKE_MODULE_PATH=/home/username/Qt/6.6.0/gcc_64/lib/cmake:/home/username/kde/usr/lib64/cmake:/home/username/kde/usr/lib/cmake
PKG_CONFIG_PATH=/home/username/kde/usr/lib/pkgconfig:/home/username/Qt/6.6.0/gcc_64/lib/pkgconfig
LD_LIBRARY_PATH=/home/username/kde/usr/lib:/home/username/Qt/6.6.0/gcc_64/lib
CMAKE_PREFIX_PATH=/home/username/Qt/6.6.0/gcc_64:/home/username/kde/usr
QT_PLUGIN_PATH=/home/username/kde/usr/lib64/plugins:/home/username/kde/usr/lib/plugins
</syntaxhighlight>
 
Select the text block above and in "Environment:" click on the button with the tooltip "Paste". Press "OK" button.
 
<pre>
rm -rf ~/kde/build/kcalc
</pre>
In the bottom left select the button with the tooltip CMake, this will open the CMake tool window. Press the Clear All button, press the "Reload CMake Project" button. Make sure that the output is correct.
From the CLion main menu > Build > Rebuild "kcalc".
 
From the CLion main menu > Run > Edit Configurations... > kcalc > Environment variables: > use the button with the tooltip "Paste" to paste the same text block as above in the "Settings > Build, Execution, Deployment" >"Environment:".
 
Now you can run kcalc correctly, from the CLion main menu > Run > Run 'kcalc' Shift + F10.
 
Now you can debug kcalc correctly, from the CLion main menu > Run > Debug 'kcalc' Shift + F9.
 
If CLion starts the process kcalc (for running or for debugging), you can make sure that the process was started correctly. In Clion >  in the bottom left button "Debug Alt + 5" > tab "GDB" > run the command <code>info proc</code>. It says:
<pre>
(gdb) info proc
process 89954
cmdline = '/home/username/kde/build/kcalc/bin/kcalc'
cwd = '/home/username/kde/build/kcalc/bin'
exe = '/home/username/kde/build/kcalc/bin/kcalc'
</pre>
 
In a terminal:
<pre>
xargs -0 printf %s\\n < /proc/89954/environ
</pre>
The value of the environment variables should be the same as in part that you have written down from the output of <code>kdesrc-build kcalc --debug</code>.

Latest revision as of 17:44, 18 April 2024

Moved to https://develop.kde.org/docs/getting-started/building/ide/clion/

Retrieved from "https://community.kde.org/index.php?title=Get_Involved/development/IDE_configuration/CLion&oldid=100645"