Merge pull request #20 from Neko-Box-Coder/Version

Adding version to CMake and interface

Author: Neko-Box-Coder

CMakeLists.txt

@@ -10,6 +10,54 @@ set(CMAKE_CXX_STANDARD 11)
 option(RUNCPP2_UPDATE_DEFAULT_YAMLS "Update default yaml files" OFF)
 option(RUNCPP2_BUILD_TESTS "Build runcpp2 tests" OFF)
 
+# =========================================================================
+# Retrieving Version String
+# =========================================================================
+
+function(get_version_from_git OUTPUT_VARIABLE)
+    # Get the latest tag
+    execute_process(
+        COMMAND git describe --tags --abbrev=0
+        OUTPUT_VARIABLE GIT_TAG
+        OUTPUT_STRIP_TRAILING_WHITESPACE
+        RESULT_VARIABLE GIT_TAG_RESULT
+        ERROR_QUIET
+    )
+
+    # Get the current commit hash
+    execute_process(
+        COMMAND git rev-parse --short HEAD
+        OUTPUT_VARIABLE GIT_COMMIT_HASH
+        OUTPUT_STRIP_TRAILING_WHITESPACE
+        ERROR_QUIET
+    )
+
+    if(GIT_TAG_RESULT EQUAL 0)
+        # Check if the tag is on the current commit
+        execute_process(
+            COMMAND git describe --tags --exact-match
+            RESULT_VARIABLE TAG_ON_COMMIT
+            OUTPUT_QUIET
+            ERROR_QUIET
+        )
+
+        if(TAG_ON_COMMIT EQUAL 0)
+            set(VERSION ${GIT_TAG})
+        else()
+            set(VERSION "${GIT_TAG}-${GIT_COMMIT_HASH}")
+        endif()
+    else()
+        # No tags found, use v0.0.0 with commit hash
+        set(VERSION "v0.0.0-${GIT_COMMIT_HASH}")
+    endif()
+
+    set(${OUTPUT_VARIABLE} ${VERSION} PARENT_SCOPE)
+endfunction()
+
+# Call the function and store the result
+get_version_from_git(RUNCPP2_PROJECT_VERSION)
+message("RUNCPP2_PROJECT_VERSION: ${RUNCPP2_PROJECT_VERSION}")
+
 # =========================================================================
 # External Dependencies
 # =========================================================================
@@ -122,7 +170,8 @@ endif()
 
 target_compile_options(runcpp2 PRIVATE ${STANDARD_COMPILE_FLAGS})
 
-
+# Define the version macro
+target_compile_definitions(runcpp2 PUBLIC RUNCPP2_VERSION="${RUNCPP2_PROJECT_VERSION}")
 
 # TODO: Maybe move this to the UnitTests sub folder
 # Unit Tests
@@ -142,3 +191,4 @@ endif()
 
 
 
+

Include/runcpp2/runcpp2.hpp

@@ -22,6 +22,7 @@ namespace runcpp2
         SCRIPT_TEMPLATE,
         WATCH,
         BUILD,
+        VERSION,
         COUNT
     };
 

Src/runcpp2/main.cpp

@@ -174,7 +174,7 @@ int main(int argc, char* argv[])
     std::unordered_map<runcpp2::CmdOptions, std::string> currentOptions;
 
     {
-        static_assert(static_cast<int>(runcpp2::CmdOptions::COUNT) == 11, "Update this");
+        static_assert(static_cast<int>(runcpp2::CmdOptions::COUNT) == 12, "Update this");
         std::unordered_map<std::string, runcpp2::OptionInfo> longOptionsMap =
         {
             {
@@ -216,10 +216,14 @@ int main(int argc, char* argv[])
             {
                 "--build",
                 runcpp2::OptionInfo(runcpp2::CmdOptions::BUILD, false)
+            },
+            {
+                "--version",
+                runcpp2::OptionInfo(runcpp2::CmdOptions::VERSION, false)
             }
         };
 
-        static_assert(static_cast<int>(runcpp2::CmdOptions::COUNT) == 11, "Update this");
+        static_assert(static_cast<int>(runcpp2::CmdOptions::COUNT) == 12, "Update this");
         std::unordered_map<std::string, const runcpp2::OptionInfo&> shortOptionsMap = 
         {
             {"-r", longOptionsMap.at("--reset-cache")},
@@ -231,7 +235,8 @@ int main(int argc, char* argv[])
             {"-s", longOptionsMap.at("--show-config-path")},
             {"-t", longOptionsMap.at("--create-script-template")},
             {"-w", longOptionsMap.at("--watch")},
-            {"-b", longOptionsMap.at("--build")}
+            {"-b", longOptionsMap.at("--build")},
+            {"-v", longOptionsMap.at("--version")}
         };
 
         currentArgIndex = ParseArgs(longOptionsMap, shortOptionsMap, currentOptions, argc, argv);
@@ -248,7 +253,7 @@ int main(int argc, char* argv[])
     //Help message
     if(currentOptions.count(runcpp2::CmdOptions::HELP))
     {
-        static_assert(static_cast<int>(runcpp2::CmdOptions::COUNT) == 11, "Update this");
+        static_assert(static_cast<int>(runcpp2::CmdOptions::COUNT) == 12, "Update this");
         ssLOG_BASE("Usage: runcpp2 [options] [input_file]");
         ssLOG_BASE("Options:");
         ssLOG_BASE("    -r, --[r]eset-cache                     Deletes all cache and build everything from scratch");
@@ -261,6 +266,7 @@ int main(int argc, char* argv[])
         ssLOG_BASE("    -t, --create-script-[t]emplate <file>   Creates/prepend runcpp2 script info template");
         ssLOG_BASE("    -w, --[w]atch                           Watch script changes and output any compiling errors");
         ssLOG_BASE("    -b, --[b]uild                           Build the script and copy output files to the working directory");
+        ssLOG_BASE("    -v, --[v]ersion                           Show the version of runcpp2");
 
         return 0;
     }
@@ -271,6 +277,13 @@ int main(int argc, char* argv[])
         ssLOG_BASE(runcpp2::GetConfigFilePath());
         return 0;
     }
+
+    // Check if the version flag is present
+    if (currentOptions.count(runcpp2::CmdOptions::VERSION))
+    {
+        ssLOG_BASE("runcpp2 version " << RUNCPP2_VERSION);
+        return 0;
+    }
 
     //Resetting user config
     if(currentOptions.count(runcpp2::CmdOptions::RESET_USER_CONFIG))
@@ -415,3 +428,4 @@ int main(int argc, char* argv[])
 
     return result;
 }
+