Informationen zur Verwendung von Visual Studio und cmake

Transkript

1 Inhaltsverzeichnis Informationen zur Verwendung von Visual Studio und cmake...2 Erste Schritte mit Visual Studio...2 Einstellungen für Visual Studio Nutzung von cmake...5 Installation von cmake...5 Hinzufügen, Ändern und Entfernen projektrelevanter Daten/Dateien...7

2 Informationen zur Verwendung von Visual Studio und cmake Im Folgenden ist die Nutzung von Visual Studio beschrieben. Die Beschreibung basiert auf der Version von Visual Studio 2013 oder ganz genau Microsoft Visual Studio Professional 2013 Version REL Sie werden vermutlich Visual Studio 2017 verwenden, die Sie ggf. über die Microsoft Studenten Version kostenlos erhalten können. Inkompatibilitäten sind also vorprogrammiert, vor allem wenn Sie auch noch planen sollten auf Linux oder Apple-System zu entwickeln. Hier bietet cmake eine Lösung, wie wir Projektdateien (Makefiles) austauschen könnten. Dieses ist ab Seite 5 im Kapitel Nutzung von cmake in diesem Dokument beschrieben. Erste Schritte mit Visual Studio Informationen zur Erstellung eines Projektes, Hinzufügen von Dateien und Klassen finden Sie im Foliensatz A00_VisualStudioBedienung.* Einstellungen für Visual Studio 2013 Damit Software-Quellen unterschiedlicher Entwickler in etwa gleich aussehen, sollten die folgenden Voreinstellungen unter den Optionen (bei Extras/Optionen) bei Visual Studio 2013 vorgenommen werden. Der Reiter bei Geschweifte Klammern einrücken bei Text- Editor C/C++ Formatierung Einzug ist zu entfernen, siehe folgende Abbildung: Alle, auch einzeilige Anweisungen, sollten stets als Verbundanweisungen geschrieben werden, d.h. in geschweifte Klammern gesetzt werden, Dazu unter Text- Editor C/C++ Formatierung Umbruch den Eintrag Einstellungen für neue Zeilen stets auswählen, siehe folgende Abbildung:

3 Unter Text-Editor C/C++ Formatierung Einzug den Eintrag Inhalte an den Inhalten der öffnenden Klammer ausrichten und Für vorhandenen Code die Einstellungen für das Ausrichten neuer Zeilen auswählen, siehe folgende Abbildung: Unter Text-Editor C/C++ Allgemein die Standardeinstellungen aus der folgenden Abbildung übernehmen:

4 Unter Text-Editor C/C++ Tabstopps einstellen, dass Leerzeichen und keine Tabstopps beim Einrücken verwendet werden. Hierzu den Reiter Leerzeichen einfügen auswählen. Außerdem Einzug auf Intelligent stellen und die Tabstoppgröße und Einzuggröße auf 3 setzen, siehe folgende Abbildung: Außerdem sollten alle Entwickler die gleiche Tastaturbelegung verwenden, sodass F7 z.b. immer den Build-Vorgang startet usw. Hierzu ist die C/C++-Tastatur einzustellen, und zwar unter Umgebung Tastatur ist Visual C++ 6 auszuwählen, siehe folgende Abbildung:

5 Nutzung von cmake CMake ermöglicht es, unter Nutzung der in jedem Projektverzeichnis vorliegenden CMakeLists.txt, Projekte für verschiedene Visual-Studio-Versionen zu erzeugen und damit die Projekte automatisch zu erstellen. Auch Eclipse und Linux wird unterstützt. Dazu sind unter Windows einmalig die folgenden Schritte auf dem lokalen Rechner erforderlich Installation von cmake CMake installieren: Herunterladen der ausführbaren exe-version für Windows ist ausreichend Am war dieses z.b. cmake rc4-win32-x86.exe 1 Es gab die Warnung, die ignoriert wurde: Beim Hinzufügen von CMake zum Pfad (PATH-Variable) kann folgende Warnung: auftreten: 1. Mittels cmake ein Hauptprojekt erstellen: a. cmake-gui öffnen (d.h. das zuvor erstellte Programm) und als Source-Ordner den Hauptordner angeben. Als Zielordner einen anderen Ordner (der nicht im 1 Am ist die Version die aktuelle Version. Verwenden Sie diese Version, die aktuell auch im DLR verwendet wird. Wir verwenden aber so wenig von cmake, dass jede Version ab 3.3 funktionieren sollte.

6 SVN-Pfad liegt angeben, da die automatisch von cmake erstellten Dateien nicht eingecheckt werden müssen). 2 b. Auf Configure klicken (Umgebungsvariablen werden erstellt) c. Auf Generate klicken und die gewünschte Version der Projektdateien angeben (hier: Visual Studio anklicken, dann Native Compiler) und anschließend mit Finish bestätigen. 2 Man auch den gleichen Ordner (wie für den Quellcode) angeben. 3 Oder welche Version Sie auch immer gerade verwenden.

7 2. Anschließend wechselt man in den Ordner für die Build-Dateien, öffnet dort die Hauptprojektdatei xxx.sln in Visual Studio. Nun die gesamte Projektmappe erstellen (Strg-Alt-F7 bzw. auf gesamte Projektmappe klicken und mit rechter Maustaste Projektmappe neu erstellen auswählen. Die oben genannten Schritte 3 bis 2 sind für andere Visual-Studio-Projektmappenversionen (z.b. VS2010) bzw. andere Plattformen (z.b. 64 bit) nochmals erforderlich, wobei dann ein anderer Zielordner zu wählen ist. Schritt 2 stellt das eigentliche Erstellen aller Projekte dar und ist bei Bedarf nach jedem SVN Update durchzuführen, sollte aber eigentlich automatisch von Visual Studio angestoßen werden. Dieses gilt auch, wenn eine der CMakeList.txt Dateien geändert wurde. Gegebenenfalls muss man das Projekt innerhalb der Projektmappe als Startprojekt festlegen, damit die Erstellung des Projekts wie gewünscht läuft. Will man nicht jedes Mal die gesamte Projektmappe neu erstellen, muss man zu "Nur Projekt" und "Nur Projekt erstellen" gehen. Hinzufügen, Ändern und Entfernen projektrelevanter Daten/Dateien Zum Hinzufügen oder Entfernen von projektrelevanten Dateien(Quellcodedateien, Headerdateien, Resourcendateien, etc.) zum Kompiliervorgang, müssen diese in die passende CMakeLists.txt-Datei hinzugefügt/entfernt werden. Die passende CMakeLists.txt-Datei ist immer im Quellcodeverzeichnis des Projektes zu finden oder auch in jedem Projekt in Visual Studio vorzufinden: Am Beispiel vom AdvisoryGenerator Test wird hier die CMake-Datei erklärt:

8 set(modadvisorygenerator_test_sources mainmodadvisorygeneratortest.cxx AdvisoryGeneratorTest.cxx ) set(modadvisorygenerator_test_headers AdvisoryGeneratorTest.h ) set(modadvisorygenerator_test_resources ${DATA}/ids/AdvisoryGeneratorTest.ids ) add_executable(modadvisorygenerator_test ${MODADVISORYGENERATOR_TEST_SOURCES} ${MODADVISORYGENERATOR_TEST_HEADERS} ${MODADVISORYGENERATOR_TEST_RESOURCES}) source_group("header Files" FILES ${MODADVISORYGENERATOR_TEST_HEADERS}) source_group("" FILES ${MODADVISORYGENERATOR_TEST_RESOURCES}) target_include_directories(modadvisorygenerator_test PUBLIC ${modadvisorygenerator_source_dir}) target_link_libraries(modadvisorygenerator_test modadvisorygenerator) Um eine neue Datei hinzuzufügen, muss diese Datei einfach in die passende Liste, die mit dem set-befehl erstellt wird, hinzugefügt werden. Um eine Datei zu entfernen, muss diese einfach nur aus der Liste gelöscht werden. Mit add_executable wird eine neue ausführbare Datei+Projekt erstellt. Dabei müssen alle Dateien angegeben werden, welche zum Projekt gehören, auch wenn diese nicht kompiliert werden. Der source_group-befehl erstellt neue Ordner und verschiebt die angegebenen Dateien in den passenden Ordner. Unterordner werden mit \\ abgetrennt(bsp. Source\\OrdnerA ). Der target_include_directories-befehl fügt alle nötigen Ordner für Abhängigkeiten hinzu, damit die Headerdateien beim Inkludieren gefunden werden. Der target_link_libraries-befehl fügt eine Bibliothek zum Linken hinzu. Diese Liste ist meistens synchron zu den Inkludeverzeichnissen zu ändern. Nachdem die CMakeLists.txt-Dateien geändert wurden, muss das Projekt nur erneuert kompiliert werden, um die Projektdateien zu aktualisieren. Sind Projekte voneinander abhängig (Nutzung von Headern), so ist auf die korrekte Reihenfolge der Projekte z.b. in basics/src/cmakelists.txt zu achten.