Nützliche Tastenkürzel

Nützliche Tastenkürzel in Visual Studio Code

• Shift+F7: CMake konfigurieren
• Ctrl+F7: Programm kompilieren¹
• Shift+F5: Programm (ohne Debugger) ausführen
• Ctrl+F5: Programm im Debugger ausführen
• F9: Debugger-Haltemarke an Cursorposition setzen/aufheben
• Ctrl+K, dann Ctrl+C: ausgewählte Zeilen auskommentieren
• Ctrl+K, dann Ctrl+U: ausgewählte Zeilen einkommentieren
• Ctrl+Shift+P: Kommandozeile von Visual Studio Code anzeigen

Während der Ausführung des Codes im Debugger sind noch folgende Tastenkürzel verfügbar:

• Ctrl+Shift+F5: Programm im Debugger neu starten
• Shift+F5: Debugger beenden
• F5: weiter (bis zur nächsten Haltemarke o.Ä.) ausführen
• Ctrl+F10: bis zur Cursorposition ausführen¹
• F10: aktuelle Anweisung ausführen
• F11: in aktuellen Funktionsaufruf hineinspringen (falls möglich)
• Shift+F11: bis zum Ende der aktuellen Funktion ausführen

¹ Diese Tastenkürzel müssen zuerst manuell zugewiesen werden; siehe entsprechender Abschnitt weiter unten.

Vor dem ersten Start von Visual Studio Code

Bevor Sie Visual Studio Code das erste mal starten, müssen Sie aus technischen Gründen zuerst zwei Dateien erstellen, welche beim Öffnen eines Terminals die aktuellen CMake-Software-Module der Version 3.x laden, da das Betriebssystem standardmäßig nur die veraltete Version 2.8 mitbringt. Wenn Sie die nachfolgenden Schritte nicht durchführen, dann wird spätestens bei der Konfiguration mittels CMake unter Visual Studio Code die folgende Fehlermeldung im Ausgabefenster erscheinen:

[cmake] -- Configuring incomplete, errors occurred!
[cmake] See also "/home/pool/XXXXX/Desktop/hello_world/build/CMakeFiles/CMakeOutput.log".
[cmake] CMake Error at CMakeLists.txt:1 (cmake_minimum_required):
[cmake]   CMake 3.0 or higher is required.  You are running version 2.8.12.2

Um diesem Problem vorzubeugen, öffnen Sie zunächst ein neues Terminal, indem Sie auf dem Desktophintergrund die rechte Maustaste drücken und anschließend im Popup-Menü den Eintrag Open in Terminal auswählen. In dem neu geöffneten Terminal können Sie jetzt den Befehl cmake -version eingeben, um zu prüfen, welche CMake-Version bei Ihnen aktuell geladen wird; die Ausgabe sollte wie folgt aussehen:

Geben Sie nun im Terminal die folgenden beiden Befehle ein (am Besten per copy-&-paste; im Terminal kann man per Ctrl+Shift+V einfügen), um die beiden benötigten Dateien zum Laden des CMake-Moduls zu erstellen:

echo "module load gcc/current-v9 cmake/3.21.2" >> ~/.bashrc
echo "if [ -f ~/.bashrc ]; then source ~/.bashrc; fi" >> ~/.bash_profile

Sie können nun das Terminal schließen und wenn Sie das nächste mal ein Terminal oder Visual Studio Code öffnen, sollte nun die aktuelle CMake Version 3.21.2 verwendet werden.

C++ und CMake Erweiterungen installieren

Öffnen Sie in die Extensions Sidebar, indem Sie die Tastenkombination Ctrl+Shift+X drücken:

Geben Sie im obigen Suchfeld der Extensions Sidebar C++ ein:

Wählen Sie aus der Liste das C/C++ Extension Pack von Microsoft aus und installieren Sie dieses mit einem Kick auf install:

Grundeinstellungen setzen

Wählen Sie im Hauptmenu den Eintrag File > Preferences > Settings aus:

Geben Sie im obigen Suchfeld paralleljobs ein und ändern Sie anschließend im Eingabefeld des Eintrages Cmake: Parallel jobs den Wert von 0 auf 1.

Tastenkürzel setzen

Wählen Sie im Hauptmenu den Eintag File > Preferences > Keyboard Shortcuts aus:

Geben Sie im obigen Suchfeld debug run to cursor ein und wählen Sie anschließend in der Liste den Eintrag Debug: Run to Cursor mit einem Rechtsklick aus und wählen Sie Add Keybinding... aus dem Dropdown-Menu aus:

Drücken Sie nun die Tastenkombination Ctrl+F10 und anschließend Enter, um die Tastenkombination zu speichern.

Geben Sie nun im Suchfeld cmake configure ein und weisen Sie analog dem Befehl CMake: Configure die Tastenkombination Ctrl+F7 zu.

Hello-World Projekt erstellen

Um ein neues Projekt erstellen zu können, muss in Visual Studio Code zuerst ein Ordner geöffnet werden. Wählen Sie dazu im Hauptmenu den Eintrag File > Open Folder... oder drücken Sie nacheinander die Tastenkombination Ctrl+K und Ctrl+O. Im folgenden Popup-Fenster können Sie nun einen bestehenden Ordner öffnen oder einen neuen Ordnder erstellen, indem Sie auf das Icon oben rechts im Fenster klicken und einen Namen für den neuen Ordner angeben:

Achtung: Es kommt leider häufig vor, dass das Popup-Fenster nicht automatisch im Vordergrund geöffnet wird, sondern vom Visual Studio Code Hauptfenster verdeckt wird. In diesem Falle müssen Sie einmal auf den Open Folder Eintrag in der Taskleiste ganz unten klicken, damit das Fenster angezeigt wird.

In der Explorer Sidebar können Sie nun mit einem Klick auf das New File Icon eine neue Datei erstellen:

Nennen Sie diese Datei hello_world.cpp:

Kopieren Sie anschließend den folgenden Code in die neu erstelle Datei und speichern Sie diese:

#include <iostream>

int main()
{
  // Schreibe etwas auf die Konsole:
  std::cout << "Hello World!" << std::endl;
  return 0;
}

Erstellen Sie anschließend eine zweite Datei namens CMakeLists.txt und fügen Sie per copy-&-paste den folgenden Inhalt ein und speichern Sie die Datei:

# setze CMake Version 3.0 voraus
cmake_minimum_required(VERSION 3.0)

# C++11 Standard verwenden
set(CMAKE_CXX_STANDARD 11)

# zusaetzliche Compiler-Optionen
add_compile_options(-O0 -pedantic -Wfatal-errors -Wall)
add_compile_options(-Wextra -Wshadow -Wconversion -Wno-unused)

# Projektname fuer CMake
project(Proku)

# die Liste aller ausfuehrbaren Programme
add_executable(hello-world hello_world.cpp)

Bevor Sie das Programm kompilieren und ausführen können, müssen Sie zunächst das Projekt mittels CMake konfigurieren. Drücken Sie dazu die (zuvor eingerichtete) Tastenkombination Ctrl+F7, um ein Dropdown-Menu zu öffnen. Beim allerersten Mal wird in dieser Liste der Compiler GCC 9.3.0 nicht zur Verfügung stehen; klicken Sie in diesem Falle einmal auf den Eintrag [Scan for kits], um die von CMake bekannte Liste von installierten Compilern zu aktualisieren.

Drücken Sie erneut die Tastenkombination Ctrl+F7 und jetzt können Sie den Eintrag GCC 9.3.0 aus der Liste auswählen. Sollte dieser Eintrag wider Erwarten nicht zur Verfügung stehen, so ziehen Sie einen der Betreuer zu Hilfe.

Im unteren Fensterbereich sollte nun ein Terminal auftauchen, in welchem die Ausgabe des CMake Programms angezeigt wird. Im Erfolgsfall sollte die Ausgabe mit den folgenden drei Zeilen enden:

[cmake] -- Configuring done
[cmake] -- Generating done
[cmake] -- Build files have been written to: ...

Bemerkung: In der Regel sollte Visual Studio Code nach der erstmaligen manuellen CMake Konfiguration automatisch nach jeder gespeicherten Änderung an der Datei CMakeLists.txt eine Rekonfiguration durchführen, so dass geänderte oder neu hinzugefügte Programme ebenfalls automatisch erkannt werden sollten. Sollte dies aus irgendwelchen Gründen nicht passieren, so müssen Sie die Rekonfiguration manuell per Ctrl+F7 durchführen.

Wenn Sie nun die Tastenkombination Shift+F7 drücken, so öffnet sich beim ersten Mal ein Dropdown-Menu, in welchem Sie auswählen können, welches der in der CMakeLists.txt eingetragenen Ziele Sie kompilieren möchten. Die können hier jetzt das Ziel hello-world auswählen, um die Hello-World Anwendung zu kompilieren. Wenn Sie stattdessen das Ziel all auswählen, werden alle in der CMakeLists.txt eingetragenen Ziele nacheinander kompiliert -- das kann im späteren Verlauf nützlich sein, wenn Sie beispielsweise alle Teilaufgaben einer Aufgabe, wie gemeinsam in einem CMake-Projekt organisiert werden, auf einmal kompilieren möchten.

Im Erfolgsfall sollte die Ausgabe mit den folgenden Zeilen enden:

[build] [100%] Build target hello-world
[build] Build finished with exit code 0

Wenn Sie im späteren Verlauf das zu kompilierene Ziel ändern möchten, so können Sie dieses in der blauen Leiste am unteren Ende des Fensters (zwischen dem Eintrag Build und dem kleinen Käfersymbol) auswählen. Als Alternative zur Tastenkombination Shift+F7 können Sie auch auf das Build in der blauen Statusleiste klicken, um den Compiler anzuwerfen.

Sie können jetzt in der blauen Leiste recht neben dem Dreieck das auszuführende Programm auswählen und dieses entweder mit einem Klick auf das Dreieck oder mit der Tastenkombination Shift+F5 starten. Nun sollte ich im unteren Fensterbereich ein Terminal-Fenster öffnen, in welchem Ihr Programm ausgeführt wird und wo auch die Programmausgabe Hello World! zu sehen sein sollte: