use Cmake config file to pass CMake variables to Idefix. Add compiler infos to idefix.

Author: glesur

CMakeLists.txt

@@ -183,14 +183,15 @@ if(Idefix_EVOLVE_VECTOR_POTENTIAL)
 endif()
 #update version.hpp if possible
 git_describe(GIT_SHA1)
-set(Idefix_VERSION ${Idefix_VERSION_MAJOR}.${Idefix_VERSION_MINOR}.${Idefix_VERSION_PATCH}-${GIT_SHA1})
-file(WRITE ${CMAKE_SOURCE_DIR}/src/version.hpp "#define IDEFIX_GIT_COMMIT \"${GIT_SHA1}\"\n")
-file(APPEND ${CMAKE_SOURCE_DIR}/src/version.hpp "#define IDEFIX_VERSION_MAJOR \"${Idefix_VERSION_MAJOR}\"\n")
-file(APPEND ${CMAKE_SOURCE_DIR}/src/version.hpp "#define IDEFIX_VERSION_MINOR \"${Idefix_VERSION_MINOR}\"\n")
-file(APPEND ${CMAKE_SOURCE_DIR}/src/version.hpp "#define IDEFIX_VERSION_PATCH \"${Idefix_VERSION_PATCH}\"\n")
-file(APPEND ${CMAKE_SOURCE_DIR}/src/version.hpp "#define IDEFIX_VERSION \"${Idefix_VERSION}\"\n")
 
 
+set(Idefix_VERSION ${Idefix_VERSION_MAJOR}.${Idefix_VERSION_MINOR}.${Idefix_VERSION_PATCH}-${GIT_SHA1})
+configure_file(
+    ${CMAKE_SOURCE_DIR}/src/version.h.in
+    ${CMAKE_BINARY_DIR}/build/generated/version.h
+    @ONLY
+)
+
 if(NOT ${Idefix_DEFS} STREQUAL "definitions.hpp")
   add_compile_definitions("DEFINITIONS_FILE=\"${Idefix_DEFS}\"")
 endif()
@@ -269,6 +270,15 @@ target_include_directories(idefix PUBLIC
 
 target_link_libraries(idefix Kokkos::kokkos)
 
+# Generate header with compiler information (name, flags, path)
+configure_file(
+    ${CMAKE_SOURCE_DIR}/src/compiler_info.h.in
+    ${CMAKE_BINARY_DIR}/build/generated/compiler_info.h
+    @ONLY
+)
+# Make sure the generated header is on the include path
+target_include_directories(idefix PRIVATE ${CMAKE_BINARY_DIR}/build/generated)
+
 message(STATUS "Idefix final configuration")
 if(Idefix_EVOLVE_VECTOR_POTENTIAL)
   message(STATUS "    MHD:  ${Idefix_MHD} (Vector potential)")

src/compiler_info.h.in

@@ -0,0 +1,17 @@
+// ***********************************************************************************
+// Idefix MHD astrophysical code
+// Copyright(C) Geoffroy R. J. Lesur <geoffroy.lesur@univ-grenoble-alpes.fr>
+// and other code contributors
+// Licensed under CeCILL 2.1 License, see COPYING for more information
+// ***********************************************************************************
+
+#ifndef COMPILER_INFO_H
+#define COMPILER_INFO_H
+
+namespace CompilerInfo {
+    inline constexpr const char* name    = "@CMAKE_CXX_COMPILER_ID@";
+    inline constexpr const char* version = "@CMAKE_CXX_COMPILER_VERSION@";
+    inline constexpr const char* path    = "@CMAKE_CXX_COMPILER@";
+}
+
+#endif

src/dataBlock/dumpToFile.cpp

@@ -11,6 +11,7 @@
 #include "dataBlock.hpp"
 #include "version.hpp"
 #include "fluid.hpp"
+#include "version.h"
 
 #define  NAMESIZE     16
 #define  HEADERSIZE 128
@@ -78,7 +79,7 @@ void DataBlock::DumpToFile(std::string filebase)  {
 
   // Write Header
   char header[HEADERSIZE];
-  std::snprintf(header, HEADERSIZE, "Idefix %s Debug DataBlock", IDEFIX_VERSION);
+  std::snprintf(header, HEADERSIZE, "Idefix %s Debug DataBlock", VersionInfo::version);
   fwrite (header, sizeof(char), HEADERSIZE, fileHdl);
 
   // Write Vc

src/input.cpp

@@ -20,6 +20,8 @@
 #include "input.hpp"
 #include "version.hpp"
 #include "profiler.hpp"
+#include "version.h"
+#include "compiler_info.h"
 
 // Flag will be set if a signal has been received
 bool Input::abortRequested = false;
@@ -415,7 +417,10 @@ void Input::PrintOptions() {
 }
 
 void Input::PrintVersion() {
-  idfx::cout << "              Idefix version " << IDEFIX_VERSION << std::endl;
-  idfx::cout << "              Built against Kokkos " << KOKKOS_VERSION << std::endl;
-  idfx::cout << "              Compiled on " << __DATE__ <<  " at " << __TIME__ << std::endl;
+  idfx::cout << "Idefix version " << VersionInfo::version << std::endl;
+  idfx::cout << "Built against Kokkos " << KOKKOS_VERSION << std::endl;
+  idfx::cout << "Compiled on " << __DATE__ <<  " at " << __TIME__ << std::endl;
+  idfx::cout << "Compiler name: " << CompilerInfo::name    << std::endl;
+  idfx::cout << "Compiler version: " << CompilerInfo::version   << std::endl;
+  idfx::cout << "Compiler path:  " << CompilerInfo::path    << std::endl;
 }

src/output/dump.cpp

@@ -25,6 +25,7 @@
 #include "gridHost.hpp"
 #include "output.hpp"
 #include "fluid.hpp"
+#include "version.h"
 
 // Max size of array name
 #define  NAMESIZE     16
@@ -880,7 +881,7 @@ int Dump::Write(Output& output) {
 
   char header[HEADERSIZE];
   std::snprintf(header, HEADERSIZE, "Idefix %s Dump Data %s endian",
-                IDEFIX_VERSION, endian.c_str());
+                VersionInfo::version, endian.c_str());
   WriteString(fileHdl, header, HEADERSIZE);
 
   for(int dir = 0; dir < 3 ; dir++) {

src/output/vtk.cpp

@@ -26,6 +26,7 @@
 #include "gridHost.hpp"
 #include "output.hpp"
 #include "fluid.hpp"
+#include "version.h"
 
 #define VTK_RECTILINEAR_GRID    14
 #define VTK_STRUCTURED_GRID     35
@@ -385,7 +386,7 @@ void Vtk::WriteHeader(IdfxFileHandler fvtk, real time) {
   2. Header
   ------------------------------------------- */
 
-  ssheader << "Idefix " << IDEFIX_VERSION << " VTK Data" << std::endl;
+  ssheader << "Idefix " << VersionInfo::version << " VTK Data" << std::endl;
 
   /* ------------------------------------------
   3. File format

src/output/xdmf.cpp

@@ -26,6 +26,7 @@
 #include "dataBlockHost.hpp"
 #include "gridHost.hpp"
 #include "output.hpp"
+#include "version.h"
 
 // Whether or not we write the time in the XDMF file
 #define WRITE_TIME
@@ -526,7 +527,7 @@ void Xdmf::WriteHeader(
 
   dimstr = 1;
 
-  ssheader << "Idefix " << IDEFIX_VERSION << " XDMF Data";
+  ssheader << "Idefix " << VersionInfo::version << " XDMF Data";
   strspace = H5Screate_simple(1, &dimstr, NULL);
   string_type = H5Tcopy(H5T_C_S1);
   H5Tset_size(string_type, strlen( ssheader.str().c_str() ));

src/version.h.in

@@ -0,0 +1,19 @@
+// ***********************************************************************************
+// Idefix MHD astrophysical code
+// Copyright(C) Geoffroy R. J. Lesur <geoffroy.lesur@univ-grenoble-alpes.fr>
+// and other code contributors
+// Licensed under CeCILL 2.1 License, see COPYING for more information
+// ***********************************************************************************
+
+#ifndef VERSION_H
+#define VERSION_H
+
+namespace VersionInfo {
+    inline constexpr const char* gitCommit  = "@GIT_SHA1@";
+    inline constexpr const char* versionMajor  = "@Idefix_VERSION_MAJOR@";
+    inline constexpr const char* versionMinor  = "@Idefix_VERSION_MINOR@";
+    inline constexpr const char* versionPatch  = "@Idefix_VERSION_PATCH@";
+    inline constexpr const char* version = "@Idefix_VERSION@";
+}
+
+#endif