1 Introduction

Pour l’UV CSC4526, nous utiliserons un IDE (parce qu’il facilite l’écriture de code) et le plugin SonarQube, un outil qui aide les développeurs·ses à trouver et surtout réparer, en temps réel, les problèmes de code (Pour celles·ceux qui ont suivi l’UV CSC4102/IGLOO, Introduction au Génie Logiciel pour applications Orientées Objet, SonarQube est l’équivalent de FindBugs).

En ce qui concerne l’IDE, les encadrant·e·s CSC4526 recommandent que, si la machine que vous utiliserez est sous Windows, cet IDE soit Visual Studio. En effet :

• Cela facilitera le support dans le cas de problèmes de compilation ou d’édition de liens.
• Cet IDE est très utilisé dans l’industrie du Jeu Vidéo. Sa maîtrise semble donc un atout pour des étudiant·es de la VAP JIN.

Toutefois, pour celles et ceux qui sont sous Linux ou MacOS ou qui ont déjà pris des habitudes/préférences concernant leur IDE, nous évoquons aussi ici les IDE CLion et Visual Studio Code (CLion nous semblant offrir une meilleure expérience que Visual Studio Code, mais nous savons que les goûts et les couleurs ne se discutent pas ;-) ). Toutefois, sachez que les intervenant·es CSC4526 offriront probablement un moindre support si vous êtes sur CLion et Visual Studio Code.

NB : Pour les utilisateurs·trices de MacOS, l’IDE disponible en standard est XCode. Toutefois, selon ce site, CLion est un IDE meilleur que XCode. En plus, choisir CLion permettra à l’équipe enseignante de vous fournir du support en cas de soucis. Aussi, consultez la section CLion ci-dessous.

2 Visual Studio 2022 (OS Windows)

Remarques préliminaires :

• Il se peut que vous ayez déjà installé Visual Studio (par exemple, pour faire du Unity). Déroulez quand même les points suivants pour installer la “charge de travail” “Développement Desktop en C++” et le plugin SonarQube utilisés durant cette UV.

• Si vous rencontrez des difficultés pendant l’installation, SVP, postez un message sur le Discord CSC4526. Ainsi, non seulement des collègues pourront vous aider, mais des intervenant·es CSC4526 pourront répondre si besoin. Surtout, nous pourrons voir les questions qui mériteraient d’apparaître dans une FAQ.

• Dans le cas où vous n’auriez pas une machine avec suffisamment de ressources pour faire tourner Visual Studio, veuillez contacter le coordonnateur de cette UV : il vous proposera une solution de repli.

2.1 Téléchargement de Visual Studio Community

• Allez en https://visualstudio.microsoft.com/fr/vs/community/
• Cliquez sur le bouton “Téléchargez” : vous récupérez ainsi le fichier VisualStudioSetup.exe, i.e. l’installateur de Visual Studio Community.

2.2 Installation de Visual Studio et de sa “Charge de travail” “Développement Desktop en C++”

• Faites un ménage préliminaire en suivant les conseils Que dois-je faire avant d’installer Visual Studio ?
  • Si vous envisagez d’installer Visual Studio sur une clé USB, vérifiez que vous avez suffisamment de place sur cette clé.
• Lancez l’installateur que vous avez téléchargé à la section précédente.
• Quand la fenêtre d’installation s’affiche : Onglet “Charges de travail”, puis sélectionnez “Développement Desktop en C++” ==> En bas à droite, l’installateur indique le nombre de Go requis pour l’installation.

• Dans la colonne “Détails de l’installation” à droite, vous n’avez pas besoin de cocher d’autres packages.
• Par défaut, Visual Studio s’installe à l’emplacement C:\Program Files\Microsoft Visual Studio\2022\Community comme mentionné en bas de la fenêtre. Pour changer ce répertoire (par exemple, pour installer Visual Studio sur votre disque D: ou bien sur une clé USB), cliquez sur “Changer…” ou sur l’onglet “Emplacements d’installation”. Vous pouvez alors :
  • Spécifier un autre emplacement d’installation.
  • Préciser si vous souhaitez “Conserver le cache de téléchargement après l’installation”. Vu que ce cache requiert plusieurs Go en plus de tous les 3.9 Go de Visual Studio, il peut être intéressant de décocher cette option (ou alors de mettre le cache sur un disque où vous avez de la place).
• Lancez l’installation proprement dite.
• Il se peut qu’un redémarrage vous soit demandé.
  • Si c’est le cas, une fois que vous êtes à nouveau connecté, lancer Visual Studio en le retrouvant dans la liste des applications (liste accessible en cliquant sur l’icône Windows dans votre barre de menu Windows).
  • Si ce n’est pas le cas, cliquez sur le bouton “Lancer” dans l’installateur.
• Une fois Visual Studio lancé, nous vous recommandons d’épingler Visual Studio à votre barre des tâches pour pouvoir le lancer rapidement la prochaine fois.
• Lors du premier lancement de Visual Studio, il vous demande de vous connecter. Choisissez “Compte professionnel ou scolaire”, puis utilisez votre adresse courriel Télécom SudParis. Vous serez alors redirigé·e vers la fenêtre CAS habituelle du campus Télécom SudParis.
• La fenêtre d’accueil de Visual Studio s’affiche.
• Nous pourrions cliquer sur “Continuer sans code” en bas de la colonne “Démarrer”, mais nous allons “coder” un “Hello World!” pour vérifier que l’installation s’est bien passée.
  • Cliquez sur le bouton “Créer un projet” : une fenêtre “Créer un projet” s’ouvre.
  • Cliquez sur “Application console”, puis sur le bouton “Suivant”.
  • Mettez le nom du projet que vous souhaitez, puis cliquez sur le bouton “Créer”.
  • Comme indiqué dans l’un des commentaires du code source affiché, menu Déboguer > Exécuter sans débogage : vous obtenez la fenêtre suivante contenant le message “Hello World!”.

2.3 Visual Studio et CoPilot (IA)

Visual Studio est très insistant pour vous “simplifier” la vie, en vous faisant utiliser CoPilot, donc une IA, qui analysera votre code pour vous faire des suggestions.

Alors, succomber à cette sirène ou pas, telle est la question !

Nous n’avons pas de recommandations à vous faire, hormis que, si vous utilisez CoPilot, nous vous demandons instamment de comprendre les suggestions que Copilot vous a faites et que vous avez acceptées.

2.4 Indentations/formatage de code dans Visual Studio

Visual Studio impose des indentations (4 espaces, éventuellement remplacés par des tabulations) et un formatage de code (par exemple, “{” systématiquement en dessous de l’instruction qui le nécessite) qui peuvent sembler lourd :

• Pour changer les indentations, Outils > Options > Éditeur > C/C++ > Tabulations , puis mettre 2 à “Taille des tabulations” et “Taille du retrait”. Vérifier que c’est “Insérer des espaces” qui est sélectionné et non “Conserver les tabulations”.
• Pour choisir un autre formatage de code, Outils > Options > Éditeur > C/C++ > Style de code > Mise en forme , puis sélectionner par exemple “Google” au lieu de “Visual Studio” comme “Style de mise en forme par défaut”.

Par la suite, pour reformater rapidement un fichier source :

• Ctrl+K, Ctrl+D pour reformater tout un fichier.
• Pour reformater une zone sélectionnée, Edition > Avancé > Mettre la sélection en forme (ou Ctrl+K, Ctrl+V)

2.5 Installation de SonarQube dans Visual Studio

Il vous reste une dernière étape : installer SonarQube. Pour ce faire:

• Dans VisualStudio, menu Extensions > Gérer les extensions: Une fenêtre Gérer les extensions s’ouvre.
• Dans le champ de recherche, tapez SonarQube pour chercher cette extension: Une ligne concernant SonarQube apparaît.
• Cliquez sur le bouton Télécharger.
• Quand le téléchargement est terminé, quittez VisualStudio : L’extension SonarQube est installée.
• Redémarrez VisualStudio.
• La section SonarQube de ce document explique le fonctionnement de SonarQube.

3 CLion (OS Linux, MacOS ou Windows)

3.1 Installations préliminaires pour MacOS

Clion s’installe de la même manière sur l’ensemble des OS (Windows, Linux, MacOS). Toutefois, pour MacOS, vous devez effectuez les instructions suivantes avant d’installer Clion :

1. Installez XCode avec votre gestionnaire d’applications MacOS. Cela vous permettra de disposer sur votre machine du compilateur C++ Mac, i.e. Clang macOS.
2. Puis, pour avoir la version “ligne de commande” des outils de la chaîne de compilation, dans un terminal, tapez la commande : sudo xcode-select --install

3.2 Installation de CLion

• Récupérez une licence gratuite CLion :
  • Suivez le lien CLion
  • Cliquez sur “Acheter”
  • Cliquez sur “Offres spéciales”
  • Cliquez sur “En savoir plus” de la rubrique “Pour les étudiants et les enseignants” : Une page “Licences éducatives gratuites” s’ouvre.
  • Cliquez sur le bouton “Postuler maintenant” en bas de cette page
  • Remplissez le formulaire “Produits JetBrains pour l’apprentissage”
  • NB : Michel Simatic n’a pas testé cette procédure jusqu’au bout, vu qu’il possède déjà un compte “Enseignant” chez JetBrains ==> Pour ceux qui dérouleront cette procédure, indiquez lui s’il y a des choses spécifiques à savoir.
• Installez CLion dans le répertoire de votre choix.
• Sous Linux ou MacOS, une fois l’installation terminée, il faut modifier le PATH pour que la commande clion puisse être invoquée à partir d’un terminal :
  • Sous Linux, éditez votre fichier ~/.bashrc pour y ajouter une ligne ressemblant à export PATH=$PATH:/home/simatic/Software/clion-2024.3.2/bin
  • Sous MacOS, éditez votre fichier ~/.zshrc pour y ajouter une ligne ressemblant à export PATH=$PATH:/home/simatic/Software/clion-2024.3.2/bin
• Démarrez CLion et “codez” un “Hello World!” pour vérifier que l’installation s’est bien passée :
  • Cliquez sur le bouton “New Project” : une fenêtre “New Project” s’ouvre.
  • Pour le “C++ Executable” que vous allez créer, dans le champ “Location”, indiquez l’endroit où vous souhaitez que le projet soit stocké. Dans le champ “Language standard”, choisissez “C++23”. Cliquez sur le bouton “Create”.
  • Dans la barre de menu en haut de la fenêtre principale, cliquez sur le bouton en forme de triangle vert (ou appuyez sur les touches “Shift” et “F10”): Le programme est compilé, puis exécuté. La fenêtre d’affichage en bas montre le texte affiché par le programme.

3.3 CLion et IA

CLion vous suggère d’essayer leur assistant IA (mais il semble que ce service soit payant). Notre position est identique à celle énoncée précédemment pour Visual Studio et CoPilot.

3.4 Indentations dans CLion

CLion impose 4 espaces pour les indentations. Si vous en voulez seulement 2, cliquez sur Roue crantée en haut à droite de la fenêtre principale > Settings > Editor > Code Style > C/C++ > Onglet “Tabs and Indents” et mettre indentation à 2.

NB : Pour remettre l’indentation d’équerre, Ctrl+Alt+I (cf. https://www.jetbrains.com/help/clion/reformat-and-rearrange-code.html#tabs_and_indents)

3.5 Installation de SonarQube dans CLion

• Démarrez CLion.
• Dans CLion, cliquez sur la roue crantée en haut à droite de la fenêtre principale > Setting… et sélectionnez Plugins.
• Dans la fenêtre de Recherche, tapez “SonarQube” et appuyez sur Entrée: Un item “SonarQube item” est affiché.
• Cliquez sur le bouton “Install”. L’installation démarre.
• Une fois que l’installation est terminée, cliquez sur le bouton “Restart IDE”.
• La section SonarQube de ce document explique le fonctionnement de SonarQube.

4 Visual Studio Code (OS Linux, MacOS ou Windows)

4.1 Installations préliminaires

Visual Studio Code requiert l’installation préliminaire d’une chaîne de compilation et d’un outil de debug (alors que Visual Studio et CLion intègrent ces différents outils).

4.1.1 Linux

Exécutez les commandes suivantes :

sudo apt update && sudo apt install -y \
     gcc \
     g++ \
     make \
     gdb

4.1.2 MacOS

Exécutez les instructions listées en section “CLion”, sous-section “Installations préliminaires pour MacOS”.

4.1.3 Windows

Le plus simple est d’installer l’IDE Visual Studio et sa charge de travail “Développement Desktop en C++” (cf. section Visual Studio 2022). Vous disposerez ainsi de la chaîne de compilation et de l’environnement de debug Microsoft.

Toutefois, cette solution nécessitant plusieurs Go sur le disque, en voici une autre moins gourmande de ce point de vue (environ 3 Go) :

1. Installez l’environnement MSYS en exécutant toutes les instructions dans la section “Installation” de cette page.

   • Téléchargement de l’installeur, puis exécution.
   • Choix d’un répertoire d’installation (Par exemple, C:\software\msys64 au lieu de C:\msys64 comme suggéré par leur installateur)
   • Clic sur le bouton “Finish” en ayant coché le bouton “Run MSYS2 now.”
   • Dans la fenêtre “MSYS” qui s’est ouverte, exécution de la commande pacman -S mingw-w64-ucrt-x86_64-gcc (clic-droit > Paste pour coller cette commande). Demandez à tout installer. Vous disposez ainsi, en environnement Windows, de gcc, g++, make et gdb.
   • (Facultatif) Pour disposer aussi du compilateur clang, tapez la commande pacman -S mingw-w64-clang-x86_64-clang

2. Modifiez la variable d’environnement PATH de windows pour y ajouter le chemin C:\msys64\ucrt64\bin (et aussi le chemin C:\msys64\clang64\bin si vous avez installé le compilateur clang)

3. Ouvrez une nouvelle fenêtre PowerShell (pour être certain·e que vos mise-à-jours de PATH ont été prises en compte). Tapez la commande g++ --version pour vérifier que g++ est bien opérationnel (idem avec clang++ --version). Vous devez obtenir un affichage similaire à :

PS C:\Users\simatic> g++ --version
g++.exe (Rev2, Built by MSYS2 project) 14.2.0
Copyright (C) 2024 Free Software Foundation, Inc.
This is free software; see the source for copying conditions.  There is NO
warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

PS C:\Users\simatic> clang++ --version
clang version 19.1.7
Target: x86_64-w64-windows-gnu
Thread model: posix
InstalledDir: C:/software/msys64/clang64/bin
PS C:\Users\simatic>

4.2 Installation de Visual Studio Code

Installez Visual Studio Code, puis les extensions :

• C/C++ version Microsoft
• C/C++ Extension Pack
• C/C++ Themes
• (facultatif) French - Code Spelling
• IntelliCode
• Makefile Tools

Vérifions que Visual Studio Code sait compiler des fichier C++ :

• Menu File > NewFile : Le bandeau haut s’ouvre.
• Indiquez le nom hello_world.cpp : Une fenêtre où ranger ce fichier s’ouvre et une notification concernant SonarQube apparaît en bas à droite.
  • Choisissez la localisation qui vous arrange.
  • Concernant la notification SonarQube, ignorez la.
• Dans hello_world.cpp, recopiez le code :

#include <iostream>

int main() {
    std::cout << "Hello, World!" << std::endl;
    return 0;
}

• Cliquez sur le bouton “Run and Debug” présent dans la colonne de gauche et dans la première ligne.

• Il se peut qu’une fenêtre s’ouvre en haut au milieu de la fenêtre. Elle vous permet de sélectionner le compilateur que vous souhaitez.

• Votre programme est compilé et exécuté. Vous pouvez voir le résultat de son exécution dans l’onglet “TERMINAL” présent dans la fenêtre du bas.

4.3 Visual Studio Code et CoPilot (IA)

cf. section “Visual Studio et CoPilot (IA)”

4.4 Indentations/formatage de code dans Visual Studio Code

• Pour changer les indentations, appliquer cet article
• Pour choisir un autre formatage de code :
  • Cliquer-droit sur l’extension “C/C++” : Un menu apparaît.
  • Sélectionner “Settings” : Une fenêtre “Settings” apparaît.
  • Dans sa colonne de gauche, cliquer sur “Formatting (63) : Des paramètres sont filtrés.
  • Changer la valeur du paramètre “C_Cpp: Clang_format_fallback Style” de “Visual Studio” à “Google”.
  • Fermer la fenêtre “Settings”

NB :

• Pour reformater un document dans Visual Studio Code, Shift+Alt+F.
• L’ensemble des raccourcis clavier est disponible ici.

4.5 Installation de SonarQube dans Visual Studio Code

• Installez l’extension “SonarQube for IDE”.
• La section SonarQube de ce document explique le fonctionnement de SonarQube.