Changed C and C++ project source templates to use #pragma once directive.

kilo52 · kilo52 · commit 602e057b984e · 2025-03-19T12:48:26.000+01:00
Enables header files to use '#pragma once' instead of header include guards.
Latter can still be used by overwriting project properties.
Introduced the 'c.headers.include.guards.enable'
and 'cpp.headers.include.guards.enable' project properties to restore
the old behaviour.
Changed the init code for C and C++ projects to be able to handle the
new behaviour.

Signed-off-by: kilo52 &lt;phil.gaiser@raven-computing.com&gt;
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-1.7.7-dev
+1.8.0-dev
diff --git a/c/01_executable/source/src/main/CMakeLists.txt b/c/01_executable/source/src/main/CMakeLists.txt
@@ -8,7 +8,7 @@ set(${{VAR_PROJECT_NAME_UPPER}}_TARGET_APPLICATION_CORE ${{VAR_ARTIFACT_BINARY_N
 add_library(
     ${${{VAR_PROJECT_NAME_UPPER}}_TARGET_APPLICATION_CORE}
     STATIC
-    c/application.c
+    c/example.c
 )
 
 target_include_directories(
diff --git a/c/01_executable/source/src/main/c/example.c b/c/01_executable/source/src/main/c/example.c
@@ -2,7 +2,7 @@
 
 #include <stdio.h>
 
-#include "application.h"
+#include "example.h"
 
 
 int getFortyTwo(){
diff --git a/c/01_executable/source/src/main/c/example.h b/c/01_executable/source/src/main/c/example.h
@@ -1,7 +1,6 @@
 ${{VAR_COPYRIGHT_HEADER}}
 
-#ifndef ${{VAR_PREFIX_INCLUDE_GUARD}}_APPLICATION_H
-#define ${{VAR_PREFIX_INCLUDE_GUARD}}_APPLICATION_H
+${{VAR_C_HEADER_BEGIN}}
 
 /**
  * Gets the number 42.
@@ -15,4 +14,4 @@ int getFortyTwo();
  */
 void printText();
 
-#endif // ${{VAR_PREFIX_INCLUDE_GUARD}}_APPLICATION_H
+${{VAR_C_HEADER_END}}
diff --git a/c/01_executable/source/src/main/c/main.c b/c/01_executable/source/src/main/c/main.c
@@ -1,6 +1,6 @@
 ${{VAR_COPYRIGHT_HEADER}}
 
-#include "application.h"
+#include "example.h"
 
 
 int main(int argc, char** argv){
diff --git a/c/01_executable/source/src/main/tests/CMakeLists.txt b/c/01_executable/source/src/main/tests/CMakeLists.txt
@@ -1,8 +1,8 @@
 # Copyright (C) ${{VAR_COPYRIGHT_YEAR}} ${{VAR_COPYRIGHT_HOLDER}}
 
 add_test_suite(
-    TEST_SUITE_NAME        ApplicationTest
-    TEST_SUITE_TARGET      test_application
-    TEST_SUITE_SOURCE      c/test_application.c
+    TEST_SUITE_NAME        ExampleTest
+    TEST_SUITE_TARGET      test_example
+    TEST_SUITE_SOURCE      c/test_example.c
     TEST_SUITE_LINK        ${${{VAR_PROJECT_NAME_UPPER}}_TARGET_APPLICATION_CORE}
 )
diff --git a/c/01_executable/source/src/main/tests/c/test_example.c b/c/01_executable/source/src/main/tests/c/test_example.c
@@ -2,7 +2,7 @@
 
 #include "unity.h"
 
-#include "application.h"
+#include "example.h"
 
 
 void setUp(){ }
diff --git a/c/02_library/source/src/main/include/example.h b/c/02_library/source/src/main/include/example.h
@@ -10,8 +10,7 @@
  * @see ${{VAR_PROJECT_ORGANISATION_URL}}
  */
 
-#ifndef ${{VAR_PREFIX_INCLUDE_GUARD}}_EXAMPLE_H
-#define ${{VAR_PREFIX_INCLUDE_GUARD}}_EXAMPLE_H
+${{VAR_C_HEADER_BEGIN}}
 
 #include "${{VAR_ARTIFACT_BINARY_NAME}}_export.h"
 
@@ -32,4 +31,4 @@
  */
 ${{VAR_ARTIFACT_BINARY_NAME_UPPER}}_EXPORT const char* getText();
 
-#endif // ${{VAR_PREFIX_INCLUDE_GUARD}}_EXAMPLE_H
+${{VAR_C_HEADER_END}}
diff --git a/c/init.sh b/c/init.sh
@@ -30,14 +30,31 @@
 # VAR_ARTIFACT_BINARY_NAME_UPPER: The name of the binary file to be produced
 #                                 by the project, in all upper-case.
 # VAR_PREFIX_INCLUDE_GUARD: The prefix to be used in all header include guards
+# VAR_C_HEADER_BEGIN: The code at the beginning of a C header file
+# VAR_C_HEADER_END: The code at the end of a C header file
 
 function process_files_lvl_1() {
   replace_var "C_VERSION"                  "$var_c_version";
   replace_var "C_VERSION_LABEL"            "$var_c_version_label";
   replace_var "ARTIFACT_BINARY_NAME"       "$var_artifact_binary_name";
   replace_var "ARTIFACT_BINARY_NAME_UPPER" "$var_artifact_binary_name_upper";
+
+  local var_c_header_begin="#pragma once";
+  local var_c_header_end="";
+  get_boolean_property "c.headers.include.guards.enable" "false";
+  if [[ "$PROPERTY_VALUE" == "true" ]]; then
+    # shellcheck disable=SC2154
+    var_c_header_begin="#ifndef ${var_project_name_upper}_EXAMPLE_H";
+    var_c_header_begin+="${_NL}";
+    var_c_header_begin+="#define ${var_project_name_upper}_EXAMPLE_H";
+    var_c_header_end="#endif // ${var_project_name_upper}_EXAMPLE_H";
+  fi
+  replace_var "C_HEADER_BEGIN" "$var_c_header_begin" "h";
+  replace_var "C_HEADER_END"   "$var_c_header_end"   "h";
+
+  # Kept for backwards compatibility
   # shellcheck disable=SC2154
-  replace_var "PREFIX_INCLUDE_GUARD"       "$var_project_name_upper";
+  replace_var "PREFIX_INCLUDE_GUARD" "$var_project_name_upper" "h";
 }
 
 # [API function]
diff --git a/cpp/01_executable/source/src/main/cpp/namespace/Application.h b/cpp/01_executable/source/src/main/cpp/namespace/Application.h
@@ -1,7 +1,6 @@
 ${{VAR_COPYRIGHT_HEADER}}
 
-#ifndef ${{VAR_NAMESPACE_INCLUDE_GUARD}}_APPLICATION_H
-#define ${{VAR_NAMESPACE_INCLUDE_GUARD}}_APPLICATION_H
+${{VAR_CPP_HEADER_BEGIN}}
 
 #include <string>
 
@@ -24,4 +23,4 @@ class Application {
 }; // END CLASS Application
 
 ${{VAR_NAMESPACE_DECL_END}}
-#endif // ${{VAR_NAMESPACE_INCLUDE_GUARD}}_APPLICATION_H
+${{VAR_CPP_HEADER_END}}
diff --git a/cpp/02_library/source/src/main/include/namespace/StringGenerator.h b/cpp/02_library/source/src/main/include/namespace/StringGenerator.h
@@ -1,7 +1,6 @@
 ${{VAR_COPYRIGHT_HEADER}}
 
-#ifndef ${{VAR_NAMESPACE_INCLUDE_GUARD}}_STRING_GENERATOR_H
-#define ${{VAR_NAMESPACE_INCLUDE_GUARD}}_STRING_GENERATOR_H
+${{VAR_CPP_HEADER_BEGIN}}
 
 #include <string>
 
@@ -35,4 +34,4 @@ class ${{VAR_ARTIFACT_BINARY_NAME_UPPER}}_EXPORT StringGenerator {
 }; // END CLASS StringGenerator
 
 ${{VAR_NAMESPACE_DECL_END}}
-#endif // ${{VAR_NAMESPACE_INCLUDE_GUARD}}_STRING_GENERATOR_H
+${{VAR_CPP_HEADER_END}}
diff --git a/cpp/03_server-poco/source/src/main/cpp/namespace/ExampleControllerHTTP.h b/cpp/03_server-poco/source/src/main/cpp/namespace/ExampleControllerHTTP.h
@@ -1,7 +1,6 @@
 ${{VAR_COPYRIGHT_HEADER}}
 
-#ifndef ${{VAR_NAMESPACE_INCLUDE_GUARD}}_EXAMPLE_CONTROLLER_HTTP_H
-#define ${{VAR_NAMESPACE_INCLUDE_GUARD}}_EXAMPLE_CONTROLLER_HTTP_H
+${{VAR_CPP_HEADER_BEGIN}}
 
 #include "raven/net/ControllerHTTP.h"
 #include "raven/net/RequestHTTP.h"
@@ -23,4 +22,4 @@ class ExampleControllerHTTP : public raven::net::ControllerHTTP {
 }; // END CLASS ExampleControllerHTTP
 
 ${{VAR_NAMESPACE_DECL_END}}
-#endif // ${{VAR_NAMESPACE_INCLUDE_GUARD}}_EXAMPLE_CONTROLLER_HTTP_H
+${{VAR_CPP_HEADER_END}}
diff --git a/cpp/03_server-poco/source/src/main/cpp/namespace/ExampleControllerWS.h b/cpp/03_server-poco/source/src/main/cpp/namespace/ExampleControllerWS.h
@@ -1,7 +1,6 @@
 ${{VAR_COPYRIGHT_HEADER}}
 
-#ifndef ${{VAR_NAMESPACE_INCLUDE_GUARD}}_EXAMPLE_CONTROLLLER_WS_H
-#define ${{VAR_NAMESPACE_INCLUDE_GUARD}}_EXAMPLE_CONTROLLLER_WS_H
+${{VAR_CPP_HEADER_BEGIN}}
 
 #include <exception>
 
@@ -31,4 +30,4 @@ class ExampleControllerWS : public raven::net::WebSocketController {
 }; // END CLASS ExampleControllerWS
 
 ${{VAR_NAMESPACE_DECL_END}}
-#endif // ${{VAR_NAMESPACE_INCLUDE_GUARD}}_EXAMPLE_CONTROLLLER_WS_H
+${{VAR_CPP_HEADER_END}}
diff --git a/cpp/03_server-poco/source/src/main/cpp/namespace/ExampleRouter.h b/cpp/03_server-poco/source/src/main/cpp/namespace/ExampleRouter.h
@@ -1,7 +1,6 @@
 ${{VAR_COPYRIGHT_HEADER}}
 
-#ifndef ${{VAR_NAMESPACE_INCLUDE_GUARD}}_EXAMPLE_ROUTER_H
-#define ${{VAR_NAMESPACE_INCLUDE_GUARD}}_EXAMPLE_ROUTER_H
+${{VAR_CPP_HEADER_BEGIN}}
 
 #include "raven/net/RouterHTTP.h"
 #include "${{VAR_NAMESPACE_PATH}}/ExampleControllerHTTP.h"
@@ -24,4 +23,4 @@ class ExampleRouter : public raven::net::BasicRouterHTTP {
 }; // END CLASS ExampleRouter
 
 ${{VAR_NAMESPACE_DECL_END}}
-#endif // ${{VAR_NAMESPACE_INCLUDE_GUARD}}_EXAMPLE_ROUTER_H
+${{VAR_CPP_HEADER_END}}
diff --git a/cpp/03_server-poco/source/src/main/cpp/namespace/Server.h b/cpp/03_server-poco/source/src/main/cpp/namespace/Server.h
@@ -1,7 +1,6 @@
 ${{VAR_COPYRIGHT_HEADER}}
 
-#ifndef ${{VAR_NAMESPACE_INCLUDE_GUARD}}_SERVER_H
-#define ${{VAR_NAMESPACE_INCLUDE_GUARD}}_SERVER_H
+${{VAR_CPP_HEADER_BEGIN}}
 
 #include <memory>
 
@@ -32,4 +31,4 @@ class Server: public raven::net::ServerTCP {
 }; // END CLASS Server
 
 ${{VAR_NAMESPACE_DECL_END}}
-#endif // ${{VAR_NAMESPACE_INCLUDE_GUARD}}_SERVER_H
+${{VAR_CPP_HEADER_END}}
diff --git a/cpp/04_desktop_imgui/source/src/main/cpp/namespace/Application.h b/cpp/04_desktop_imgui/source/src/main/cpp/namespace/Application.h
@@ -1,7 +1,6 @@
 ${{VAR_COPYRIGHT_HEADER}}
 
-#ifndef ${{VAR_NAMESPACE_INCLUDE_GUARD}}_APPLICATION_H
-#define ${{VAR_NAMESPACE_INCLUDE_GUARD}}_APPLICATION_H
+${{VAR_CPP_HEADER_BEGIN}}
 
 #include <string>
 
@@ -31,4 +30,4 @@ class Application {
 }; // END CLASS Application
 
 ${{VAR_NAMESPACE_DECL_END}}
-#endif // ${{VAR_NAMESPACE_INCLUDE_GUARD}}_APPLICATION_H
+${{VAR_CPP_HEADER_END}}
diff --git a/cpp/04_desktop_imgui/source/src/main/cpp/namespace/Window.h b/cpp/04_desktop_imgui/source/src/main/cpp/namespace/Window.h
@@ -1,7 +1,6 @@
 ${{VAR_COPYRIGHT_HEADER}}
 
-#ifndef ${{VAR_NAMESPACE_INCLUDE_GUARD}}_WINDOW_H
-#define ${{VAR_NAMESPACE_INCLUDE_GUARD}}_WINDOW_H
+${{VAR_CPP_HEADER_BEGIN}}
 
 #include <string>
 
@@ -54,4 +53,4 @@ class Window {
 }; // END CLASS Window
 
 ${{VAR_NAMESPACE_DECL_END}}
-#endif // ${{VAR_NAMESPACE_INCLUDE_GUARD}}_WINDOW_H
+${{VAR_CPP_HEADER_END}}
diff --git a/cpp/init.sh b/cpp/init.sh
@@ -37,6 +37,8 @@
 # VAR_NAMESPACE_INCLUDE_GUARD: The namespace as used in include guards
 # VAR_NAMESPACE_DECL_BEGIN: The namespace declaration start part
 # VAR_NAMESPACE_DECL_END: The namespace declaration end part
+# VAR_CPP_HEADER_BEGIN: The code at the beginning of a C++ header file
+# VAR_CPP_HEADER_END: The code at the end of a C++ header file
 
 function process_files_lvl_1() {
   replace_var "CPP_VERSION"                "$var_cpp_version";
@@ -47,10 +49,27 @@ function process_files_lvl_1() {
   replace_var "NAMESPACE_0"                "$var_namespace_0";
   replace_var "NAMESPACE_PATH"             "$var_namespace_path";
   replace_var "NAMESPACE_COLON"            "$var_namespace_colon";
-  replace_var "NAMESPACE_INCLUDE_GUARD"    "$var_namespace_include_guard";
   replace_var "NAMESPACE_DECL_BEGIN"       "$var_namespace_decl_begin";
   replace_var "NAMESPACE_DECL_END"         "$var_namespace_decl_end";
 
+  local var_cpp_header_begin="#pragma once";
+  local var_cpp_header_end="";
+  get_boolean_property "cpp.headers.include.guards.enable" "false";
+  local use_header_include_guards="$PROPERTY_VALUE";
+  if [[ "$use_header_include_guards" == "true" ]]; then
+    var_cpp_header_begin='#ifndef ${{VAR_NAMESPACE_INCLUDE_GUARD}}_${{VAR_IG_FILENAME}}';
+    var_cpp_header_begin+="${_NL}";
+    var_cpp_header_begin+='#define ${{VAR_NAMESPACE_INCLUDE_GUARD}}_${{VAR_IG_FILENAME}}';
+    var_cpp_header_end='#endif // ${{VAR_NAMESPACE_INCLUDE_GUARD}}_${{VAR_IG_FILENAME}}';
+  fi
+  replace_var "CPP_HEADER_BEGIN" "$var_cpp_header_begin" "h";
+  replace_var "CPP_HEADER_END" "$var_cpp_header_end" "h";
+  # Always replace include guard namespace for backwards compatibility
+  replace_var "NAMESPACE_INCLUDE_GUARD" "$var_namespace_include_guard" "h";
+  if [[ "$use_header_include_guards" == "true" ]]; then
+    _cpp_adjust_header_include_guard_names;
+  fi
+
   if [ -n "$var_namespace_path" ]; then
     expand_namespace_directories "$var_namespace_path"        \
                                  "src/main/cpp/namespace"     \
@@ -59,6 +78,19 @@ function process_files_lvl_1() {
   fi
 }
 
+# Replaces the VAR_IG_FILENAME substitution variable in all C++ headers files.
+function _cpp_adjust_header_include_guard_names() {
+  local ig_filename;
+  local f;
+  for f in "${CACHE_ALL_FILES[@]}"; do
+    if [[ "$f" == *".h" ]]; then
+      f="$(basename "$f")";
+      ig_filename="$(echo "$f" |tr "." "_" |tr '[:lower:]' '[:upper:]')";
+      replace_var "IG_FILENAME" "$ig_filename" "$f";
+    fi
+  done
+}
+
 # [API function]
 # Prompts the user to enter the C++ version to use for the project.
 #
diff --git a/project.properties b/project.properties
@@ -164,6 +164,11 @@ c.disable=false
 # base system, i.e. only show the ones provided by addons
 c.baseprojects.disable=false
 
+# By default, C headers will use the '#pragma once' directive instead of
+# header include guards. Latter can still be used instead by setting
+# this property to true.
+c.headers.include.guards.enable=false
+
 # ##### C++ settings
 
 # Set this to true to disable all C++ projects
@@ -179,6 +184,11 @@ cpp.namespace.example=raven.myproject.mynamespace
 # The default namespace to use, in dot notation
 cpp.namespace.default=raven
 
+# By default, C++ headers will use the '#pragma once' directive instead of
+# header include guards. Latter can still be used instead by setting
+# this property to true.
+cpp.headers.include.guards.enable=false
+
 # ##### Java settings
 
 # Set this to true to disable all Java projects

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,7 @@ set(${{VAR_PROJECT_NAME_UPPER}}_TARGET_APPLICATION_CORE ${{VAR_ARTIFACT_BINARY_N`
`8`	`8`	`add_library(`
`9`	`9`	`${${{VAR_PROJECT_NAME_UPPER}}_TARGET_APPLICATION_CORE}`
`10`	`10`	`STATIC`
`11`		`- c/application.c`
	`11`	`+ c/example.c`
`12`	`12`	`)`
`13`	`13`
`14`	`14`	`target_include_directories(`