Pour compiler notre application HelloWorld, nous allons donc utiliser CMake.

Voici la liste des commandes à compléter pour compiler et lancer notre application :

ARCANE_INSTALL_PATH=#A compléter
 
HW_SOURCE_DIR=#A compléter
HW_BUILD_DIR=#A compléter
HW_BUILD_TYPE=Release
HW_EXE=${HW_BUILD_DIR}/HelloWorld
HW_ARC=${HW_SOURCE_DIR}/HelloWorld.arc
 
cd ${HW_BUILD_DIR}
 
cmake \
  -S ${HW_SOURCE_DIR} \
  -B ${HW_BUILD_DIR} \
  -DCMAKE_PREFIX_PATH=${ARCANE_INSTALL_PATH} \
  -DCMAKE_BUILD_TYPE=${HW_BUILD_TYPE}
 
cmake --build ${HW_BUILD_DIR}
 
${HW_EXE} ${HW_ARC}

Au début de cette liste, nous définissons des variables pour rendre le tout plus lisible et plus facilement modifiable.

ARCANE_INSTALL_PATH=# A compléter

Cette ligne nous permet de définir le répertoire d'installation de Arcane.

Note: Exemple de ligne :
ARCANE_INSTALL_PATH=~/install_arcane

HW_SOURCE_DIR=# A compléter

Cette ligne nous permet de définir le répertoire contenant les sources de notre HelloWorld.

Note: Exemple de ligne :
HW_SOURCE_DIR=~/src_helloworld

HW_BUILD_DIR=# A compléter

Cette ligne nous permet de définir le répertoire où sera compilé notre application.

Note: Exemple de ligne :
HW_BUILD_DIR=~/build_hw

HW_BUILD_TYPE=Release

Cette ligne nous permet de définir le type de build que l'on souhaite. On a le choix entre Debug, Check et Release. Debug nous permet d'avoir des informations supplémentaire pour pouvoir débugger avec un débuggeur. Check permet de rajouter des vérifications supplémentaires pour éviter les problèmes de dépassement de tableau par exemple.

Note: Debug inclut automatiquement Check.

HW_EXE=${HW_BUILD_DIR}/HelloWorld
HW_ARC=${HW_SOURCE_DIR}/HelloWorld.arc
 
cd ${HW_BUILD_DIR}

À l'aide des informations que nous avons donné précédement, on peut déduire l'emplacement de l'exécutable (HW_EXE) et l'emplacement de notre jeu de données (HW_ARC).

Personnellement, je préfère me situer dans le dossier de build pour les commandes ci-après, donc j'effectue un cd ${HW_BUILD_DIR}, mais ça reste facultatif.

cmake \
  -S ${HW_SOURCE_DIR} \
  -B ${HW_BUILD_DIR} \
  -DCMAKE_PREFIX_PATH=${ARCANE_INSTALL_PATH} \
  -DCMAKE_BUILD_TYPE=${HW_BUILD_TYPE}

On demande à CMake de configurer le dossier de build grâce à/aux CMakeLists.txt pour que Make puisse compiler notre projet. Cette commande ne modifiera pas le répertoire contenant les sources de notre projet (c'est le cas pour toutes les commandes présentées ici d'ailleurs).

cmake --build ${HW_BUILD_DIR}

On demande à CMake d'appeler Make pour compiler notre projet. On pourrait utiliser directement la commande make mais si un jour, on veut utiliser un autre programme que Make (comme Ninja), il faudra changer cette commande. Alors que là, c'est CMake qui gère selon la configuration faite précédemment.

${HW_EXE} ${HW_ARC}

Enfin, on peut lancer notre HelloWorld ! On doit aussi préciser la position de notre jeu de données. Si l'on a plusieurs jeux de données, il suffit de changer la variable ${HW_ARC} et de relancer HelloWorld sans avoir besoin de recompiler.

Voilà pour ce sous-chapitre dédié à la construction d'un hello world avec Arcane. Les bases sont présentées ici. Néanmoins, pour aller plus loin, il est conseillé de lire tous les chapitres de cette documentation.

Si un problème est présent dans ce sous-chapitre, vous pouvez ouvrir une issue dans le GitHub d'Arcane.

Fichier CMakeLists.txt Exemple concret