Merge pull request #16 from Neko-Box-Coder/CrossPlatformDefine

Adding cross platform defines

Author: Neko-Box-Coder

CMakeLists.txt

@@ -84,6 +84,7 @@ add_executable(runcpp2
                         "${CMAKE_CURRENT_LIST_DIR}/Src/runcpp2/Data/ProfilesCompilesFiles.cpp"
                         "${CMAKE_CURRENT_LIST_DIR}/Src/runcpp2/Data/FilesTypesInfo.cpp"
                         "${CMAKE_CURRENT_LIST_DIR}/Src/runcpp2/Data/StageInfo.cpp"
+                        "${CMAKE_CURRENT_LIST_DIR}/Src/runcpp2/Data/ProfilesDefines.cpp"
                         "${CMAKE_CURRENT_LIST_DIR}/Src/runcpp2/ProfileHelper.cpp"
                         "${CMAKE_CURRENT_LIST_DIR}/Src/runcpp2/CompilingLinking.cpp"
                         "${CMAKE_CURRENT_LIST_DIR}/Src/runcpp2/ConfigParsing.cpp"

DefaultYAMLs/DefaultScriptInfo.yaml

@@ -1,15 +1,17 @@
+# NOTE: All command substitutions are passed directly to the shell. 
+#       Be cautious when using user-provided input in your build commands to avoid potential security risks.
+
 # NOTE: All the options here are defaulted to empty. 
 #       You can uncomment different sections to set what you want.
 
 # # (Optional) Language of the script
 # Language: "c++"
 
 # # (Optional) Preferred profiles for the script for each platform.
-# #            A special profile name "All" can be used to allow any profile.
-# #            Default profiles are listed in user config file,
+# #            Profiles are listed in user config file,
 # #            which can be retreived by running `runcpp2 --show-config-path`
 # #            Each of the platform dependent settings can be listed under
-# #            - All
+# #            - Default
 # #            - Windows
 # #            - Linux
 # #            - MacOS
@@ -22,8 +24,8 @@
 # # (Optional) Override the default compile flags for each platform.
 # OverrideCompileFlags:
 #     # Target Platform
-#     All:
-#         # Profile with the respective flags to override. ("All" for any profile)
+#     Default:
+#         # Profile with the respective flags to override. ("Default" for any profile)
 #         "g++":
 #             # (Optional) Flags to be removed from the default compile flags, separated by space
 #             Remove: ""
@@ -34,8 +36,8 @@
 # # (Optional) Override the default link flags for each platform.
 # OverrideLinkFlags:
 #     # Target Platform
-#     All:
-#         # Profile with the respective flags to override ("All" for any profile)
+#     Default:
+#         # Profile with the respective flags to override ("Default" for any profile)
 #         "g++":
 #             # (Optional) Flags to be removed from the default link flags, separated by space
 #             Remove: ""
@@ -47,11 +49,21 @@
 # # (Optional) Other source files (relative to script file path) to be compiled.
 # OtherFilesToBeCompiled:
 #     # Target Platform
-#     All:
+#     Default:
 #         # Target Profile
-#         All:
+#         Default:
 #             - "./AnotherSourceFile.cpp"
 
+# # (Optional) Define cross-compiler defines for each platform and profile.
+# # Defines can be specified as just a name or as a name-value pair.
+# Defines:
+#     # Target Platform (Default, Windows, Linux, MacOS, or Unix)
+#     Default:
+#         # Profile name (e.g., "g++", "clang++", "msvc", or "Default" for any profile)
+#         "Default":
+#             - "EXAMPLE_DEFINE"              # Define without a value
+#             - "VERSION_MAJOR=1"             # Define with a value
+
 # # (Optional) The list of dependencies needed by the script
 # Dependencies:
 #     # Dependency name
@@ -79,7 +91,7 @@
 #     # (Optional if LibraryType is Header) Link properties of the dependency
 #     LinkProperties:
 #         # Properties for searching the library binary for the profile
-#         # You can also use "All" if all compilers use the same values
+#         # You can also use "Default" if all compilers use the same values
 #         "g++":
 #             # The library names to be searched for when linking against the script. 
 #             # Binaries with linkable extension that contains one of the names will be linked
@@ -94,24 +106,24 @@
 #             
 #             # (Optional) Additional link flags for this dependency for each platform
 #             AdditionalLinkOptions: 
-#                 All: []
+#                 Default: []
 #     
 #     # (Optional) Setup commands are run once when the dependency is populated
 #     Setup:
 #         # Target Platform
-#         All:
+#         Default:
 #             # Setup shell commands for the specified profile. 
-#             # All commands are run in the dependency folder
-#             # You can also use "All" if all the compilers run the same setup commands
+#             # Default commands are run in the dependency folder
+#             # You can also use "Default" if all the compilers run the same setup commands
 #             "g++":
 #             -   "mkdir build"
 #             
 #     
 #     # (Optional) Build commands are run every time before the script is being built
 #     Build:
 #         # Target Platform
-#         All:
-#             # Target Profile ("All" for any profile)
+#         Default:
+#             # Target Profile ("Default" for any profile)
 #             "g++":
 #             -   "cd build && cmake .."
 #             -   "cd build && cmake --build ."

DefaultYAMLs/DefaultUserConfig.yaml

@@ -6,6 +6,10 @@ Templates:
     "g++_CompileRunParts": &g++_CompileRunParts
     -   Type: Once
         CommandPart: "{Executable} -c {CompileFlags}"
+    -   Type: Repeats
+        CommandPart: " -D{DefineNameOnly}="
+    -   Type: Repeats
+        CommandPart: " \"-D{DefineName}={DefineValue}\""
     -   Type: Repeats
         CommandPart: " -I\"{IncludeDirectoryPath}\""
     -   Type: Once
@@ -20,6 +24,10 @@ Templates:
     "vs2022_v17+_CompileRunParts": &vs2022_v17+_CompileRunParts
     -   Type: Once
         CommandPart: "{Executable} /c {CompileFlags}"
+    -   Type: Repeats
+        CommandPart: " /D{DefineNameOnly}="
+    -   Type: Repeats
+        CommandPart: " \"/D{DefineName}={DefineValue}\""
     -   Type: Repeats
         CommandPart: " /I\"{IncludeDirectoryPath}\""
     -   Type: Once
@@ -37,15 +45,15 @@ Templates:
 
     # TODO: Add support for custom platform
     # Each of the platform dependent settings can be listed under
-    # - All
+    # - Default
     # - Windows
     # - Linux
     # - MacOS
     # - Unix
     FilesTypes: &CommonFilesTypes
         ObjectLinkFile:
             Prefix:
-                All: ""
+                Default: ""
             Extension:
                 Windows: ".obj"
                 Unix: ".o"
@@ -91,6 +99,10 @@ Templates:
                 Windows: ""
                 Unix: ""
 
+# WARNING: All command substitutions in this file are passed directly to the shell.
+#          Exercise caution when using variables or user-provided input in your build commands
+#          to prevent potential security vulnerabilities.
+
 # A profile to be used if not specified while running the build script
 PreferredProfile: "g++"
 
@@ -111,12 +123,12 @@ Profiles:
     # (Optional) The commands to run in **shell** before calling the compiler/linker for each platform.
     #            This is run inside the .runcpp2 directory where the build happens.
     # Setup: 
-    #     All: []
+    #     Default: []
 
     # (Optional) The commands to run in **shell** after calling the compiler/linker for each platform.
     #            This is run inside the .runcpp2 directory where the build happens.
     # Cleanup: 
-    #     All: []
+    #     Default: []
 
     # The file properties for the object files for each platform.
     FilesTypes: *CommonFilesTypes
@@ -126,16 +138,19 @@ Profiles:
         # (Optional) The command to run together before running each compile command
         #               in **shell** for each platform
         # PreRun: 
-        #     All: ""
+        #     Default: ""
 
         # Shell command to use for checking if the executable exists or not
         CheckExistence: 
-            All: "g++ -v"
+            Default: "g++ -v"
 
         # Here are a list of substitution strings for RunParts, Setup and Cleanup
         # {Executable}:             Compiler executable
         # {CompileFlags}:           Compile flags from config and override
         # {IncludeDirectoryPath}:   Path to include directories for both the script and dependencies
+        # {DefineNameOnly}:         Name of a macro to be defined without a value (equivalent to #define X)
+        # {DefineName}:             Name of a macro to be defined with a value
+        # {DefineValue}:            Value of a macro to be defined (used with {DefineName})
 
         # {InputFileName}:          Name of the input file (without directory path and extension)
         # {InputFileExtension}:     Extension of the input file
@@ -148,7 +163,7 @@ Profiles:
         # {OutputFilePath}:         (Similar to previous)
         CompileTypes:
             Executable:
-                All:
+                Default:
                     Flags: "-std=c++17 -Wall -Werror"
                     Executable: "g++"
                     RunParts: *g++_CompileRunParts
@@ -159,14 +174,14 @@ Profiles:
                     #            This is run inside the .runcpp2 directory where the build happens.
                     # Cleanup: []
             Static:
-                All:
+                Default:
                     Flags: "-std=c++17 -Wall -Werror"
                     Executable: "g++"
                     RunParts: *g++_CompileRunParts
                     # Setup: []
                     # Cleanup: []
             Shared:
-                All:
+                Default:
                     Flags: "-std=c++17 -Wall -Werror -fpic"
                     Executable: "g++"
                     RunParts: *g++_CompileRunParts
@@ -178,11 +193,11 @@ Profiles:
         # (Optional) The command to run together before running each link command 
         #               in **shell** for each platform
         # PreRun: 
-        #     All: ""
+        #     Default: ""
 
         # Shell command to use for checking if the executable exists or not
         CheckExistence:
-            All: "g++ -v"
+            Default: "g++ -v"
 
         # Here are a list of substitution strings for RunParts, Setup and Cleanup
         # {Executable}:                 Linker executable
@@ -227,7 +242,7 @@ Profiles:
                     # Setup: []
                     # Cleanup: []
             Static:
-                All:
+                Default:
                     Flags: ""
                     Executable: "g++"
                     RunParts: *g++_LinkRunParts

Examples/test.cpp

@@ -6,14 +6,19 @@
 
 OtherFilesToBeCompiled:
     # Target Platform
-    All:
+    Default:
         # Target Profile
         "g++":
         -   "./OtherSources/AnotherSourceFileGcc.cpp"
-        All:
+        Default:
         -   "./AnotherSourceFile.cpp"
         -   "./AnotherSourceFile2.cpp"
 
+Defines:
+    Default:
+        # Turns into `TEST_DEF=\"Test Define Working\"` in shell
+        "Default": ["TEST_DEF=\\\"Test Define Working\\\""]
+
 Dependencies:
 -   Name: ssLogger
     Platforms: [Windows, Linux, MacOS]
@@ -23,17 +28,17 @@
     LibraryType: Shared
     IncludePaths: ["Include"]
     LinkProperties:
-        "All":
+        "Default":
             SearchLibraryNames: ["ssLogger"]
             ExcludeLibraryNames: ["ssLogger_SRC"]
             SearchDirectories: ["./build", "./build/Debug", "./build/Release"]
     Setup:
-        All:
-            "All":
+        Default:
+            "Default":
             -   "mkdir build"
     Build:
-        All:
-            "All":
+        Default:
+            "Default":
             -   "cd build && cmake .. -DssLOG_BUILD_TYPE=SHARED"
             -   "cd build && cmake --build . --config Release -j 16"
 */
@@ -52,6 +57,7 @@
 int main(int argc, char* argv[])
 {
     std::cout << "Hello World" << std::endl;
+    std::cout << TEST_DEF << std::endl;
 
     for(int i = 0; i < argc; ++i)
         std::cout << "Arg" << i << ": " << argv[i] << std::endl;

Include/runcpp2/Data/ProfilesDefines.hpp

@@ -0,0 +1,32 @@
+#ifndef RUNCPP2_DATA_PROFILES_DEFINES_HPP
+#define RUNCPP2_DATA_PROFILES_DEFINES_HPP
+
+#include "runcpp2/Data/ParseCommon.hpp"
+#include "ryml.hpp"
+#include <unordered_map>
+#include <vector>
+#include <string>
+
+namespace runcpp2
+{
+    namespace Data
+    {
+        struct Define
+        {
+            std::string Name;
+            std::string Value;
+            bool HasValue;
+        };
+
+        class ProfilesDefines
+        {
+            public:
+                std::unordered_map<ProfileName, std::vector<Define>> Defines;
+
+                bool ParseYAML_Node(ryml::ConstNodeRef& node);
+                std::string ToString(std::string indentation) const;
+        };
+    }
+}
+
+#endif

Include/runcpp2/Data/ScriptInfo.hpp

@@ -5,6 +5,7 @@
 #include "runcpp2/Data/ProfilesFlagsOverride.hpp"
 #include "runcpp2/Data/ParseCommon.hpp"
 #include "runcpp2/Data/ProfilesCompilesFiles.hpp"
+#include "runcpp2/Data/ProfilesDefines.hpp"
 
 #include <string>
 #include <vector>
@@ -27,6 +28,7 @@ namespace runcpp2
 
                 std::vector<DependencyInfo> Dependencies;
 
+                std::unordered_map<PlatformName, ProfilesDefines> Defines;
 
                 bool Populated = false;
 

README.md

@@ -71,6 +71,9 @@ Everything is documented as comment in the template but here's a quick summary.
 - `OtherFilesToBeCompiled`: Other source files you wish to be compiled.
 - `Dependencies`: Any external libraries you wish to use. See next section.
 
+> [!NOTE]
+> Settings in the script info are passed directly to the shell. Be cautious when using user-provided input in your build commands.
+
 #### 4. Using External Libraries
 
 To use any external libraries, you need to specify them in the Dependencies section.