Merge branch 'uck/ThreadSafety' of https://github.com/Kimeek42/AutomaticComponentToolkit into uck/ThreadSafety

Author: Kimeek42

Examples/ThreadSafety/Readme.md

@@ -22,14 +22,13 @@ To address the thread safety issue described above, a new parameter called `thre
 This parameter ensures thread safety by adding mutex locking mechanisms on the library implementation side.
 
 ### 2.2. Details
-The ThreadSafetyOption parameter can be set to either `none`, `soft` or `strict` values. Here is the difference them:
+The `ThreadSafetyOption` parameter can be set to `none`, `soft` or `strict` value. Here is the difference between them:
 - `none`: Does nothing.
 - `soft`: The binding side will call the lock mechanism only when a string is returned from an API function.
 - `strict`: The binding side will call the lock mechanism every time, regardless of what is returned from the function.
 
-When the ThreadSafetyOption attribute in the LibraryManager component class is set to `soft` or `strict`,
+When the `ThreadSafetyOption` attribute in the component class is set to `soft` or `strict`,
 the implementation will derive from a base class that includes mutex locking mechanisms.
-This approach ensures that the mutexes are locked and unlocked on the implementation side.
 This solution ensures thread safety both when a single pointer on the binding side is shared across threads,
 and when different pointers that point to the same object on the implementation side are used in different threads.
 Additionally, error handling mechanisms are in place to unlock the mutex in case of exception propagation, preventing deadlocks.
@@ -44,7 +43,7 @@ In the `threadSafeLibrary.xml` file, there are three classes defined with the sa
 ```xml
 <class name="StringReturner" threadsafetyoption="none">
 	<method name="GetString" description="Returns a string">
-			<param name="Value" type="string" pass="return"/>
+		<param name="Value" type="string" pass="return"/>
 	</method>
 	<method name="ThreadSafetyCheck" description="Function that may crash when called from different threads at the same time"></method>
 </class>
@@ -62,7 +61,7 @@ In the `threadSafeLibrary.xml` file, there are three classes defined with the sa
 </class>
 ```
 
-Each class contains the following methods:
+Each class has the following methods:
 - `GetString` which simply returns a random string.
 - `ThreadSafetyCheck` which returns nothing but may crash when executed from different threads simultaneously, as no thread safety mechanism is provided in the library implementation.
 
@@ -112,9 +111,9 @@ int main()
 }
 ```
 
-Executing `testStringReturn` and `testThreadSafetyCheck` with `stringReturner` will crash because there is no thread safety mechanism enabled for this instance.
+Executing `testStringReturn` and `testThreadSafetyCheck` with `stringReturner` will crash because there is no thread safety mechanism enabled for this instance.  
 Executing `testStringReturn` with `softStringReturner` will work as expected. However, it will crash on `testThreadSafetyCheck` because with the `soft`
-value of the `threadsafetyoption` parameter, the thread safety mechanism will lock the instance on the library side only when executing functions that return strings.
+value of the `threadsafetyoption` parameter, the thread safety mechanism will lock the instance on the library side only when executing functions that return strings.  
 Executing `testStringReturn` or `testThreadSafetyCheck` on `strictStringReturner` will work as expected in both cases because with the `strict` value of
 the `threadsafetyoption`, the instance on the implementation side will be locked during each function execution.
 

Source/automaticcomponenttoolkit.go

@@ -48,13 +48,13 @@ const (
 	eACTModeDiff     = 1
 )
 
-func createComponent(component ComponentDefinition, outfolderBase string, bindingsDirectoryOverride string, interfacesDirectoryOverride string, stubDirectoryOverride string, suppressBindings bool, suppressStub bool, suppressInterfaces bool, suppressSubcomponents bool, suppressLicense bool, suppressExamples bool) (error) {
+func createComponent(component ComponentDefinition, outfolderBase string, bindingsDirectoryOverride string, interfacesDirectoryOverride string, stubDirectoryOverride string, suppressBindings bool, suppressStub bool, suppressInterfaces bool, suppressSubcomponents bool, suppressLicense bool, suppressExamples bool, suppressCmake bool) (error) {
 
 	log.Printf("Creating Component \"%s\"", component.LibraryName)
 
 	if (!suppressSubcomponents) {	
 		for _, subComponent := range component.ImportedComponentDefinitions {
-			err := createComponent(subComponent, outfolderBase, "", "", "", suppressBindings, suppressStub, suppressInterfaces, suppressSubcomponents, suppressLicense, suppressExamples)
+			err := createComponent(subComponent, outfolderBase, "", "", "", suppressBindings, suppressStub, suppressInterfaces, suppressSubcomponents, suppressLicense, suppressExamples, suppressCmake)
 			if (err != nil) {
 				return err
 			}
@@ -506,7 +506,7 @@ func createComponent(component ComponentDefinition, outfolderBase string, bindin
 				}
 
 				err = BuildImplementationCPP(component, outputFolderImplementationCpp, outputFolderImplementationCppStub,
-					outputFolderImplementationProject, implementation, suppressStub, suppressInterfaces)
+					outputFolderImplementationProject, implementation, suppressStub, suppressInterfaces, suppressCmake)
 				if err != nil {
 					return err
 				}
@@ -578,6 +578,7 @@ func printUsageInfo() {
 	fmt.Fprintln(os.Stdout, "  -suppressinterfaces: do not generate the contents of the interfaces-folder")
 	fmt.Fprintln(os.Stdout, "  -suppresssubcomponents: do not generate any files for subcomponents")
 	fmt.Fprintln(os.Stdout, "  -suppressexamples: do not generate any examples")
+	fmt.Fprintln(os.Stdout, "  -suppresscmake: do not generate CMakeLists.txt file for C++ implementation. It only takes effect if -suppressstub argument is not set.")	
 	fmt.Fprintln(os.Stdout, "  ")
 	fmt.Fprintln(os.Stdout, "Tutorials, info and source-code on: https://github.com/Autodesk/AutomaticComponentToolkit/ .")
 	fmt.Fprintln(os.Stdout, "ACT stops now.")
@@ -616,6 +617,7 @@ func main() {
 	suppressInterfaces := false;
 	suppressSubcomponents := false;
 	suppressExamples := false;
+	suppressCmake := false;
 
 	if len(os.Args) >= 4 {
 		for idx := 2; idx < len(os.Args); idx ++ {
@@ -667,6 +669,9 @@ func main() {
 				suppressExamples = true;
 			}
 
+			if os.Args[idx] == "-suppresscmake" {
+				suppressCmake = true;
+			}
 		}
 	}
 	if mode == eACTModeGenerate {
@@ -735,7 +740,7 @@ func main() {
 	// 	}
 	// }
 
-	err = createComponent(component, outfolderBase, bindingsDirectoryOverride, interfacesDirectoryOverride, stubDirectoryOverride, suppressBindings, suppressStub, suppressInterfaces, suppressSubcomponents, suppressLicense, suppressExamples)
+	err = createComponent(component, outfolderBase, bindingsDirectoryOverride, interfacesDirectoryOverride, stubDirectoryOverride, suppressBindings, suppressStub, suppressInterfaces, suppressSubcomponents, suppressLicense, suppressExamples, suppressCmake)
 	if (err != nil) {
 		if err == ErrPythonBuildFailed {
 			log.Println("Python binding generation failed (Due to usage of reserved keywords)")

Source/buildimplementationcpp.go

@@ -43,7 +43,7 @@ import (
 )
 
 // BuildImplementationCPP builds C++ interface classes, implementation stubs and wrapper code that maps to the C-header
-func BuildImplementationCPP(component ComponentDefinition, outputFolder string, stubOutputFolder string, projectOutputFolder string, implementation ComponentDefinitionImplementation, suppressStub bool, suppressInterfaces bool) error {
+func BuildImplementationCPP(component ComponentDefinition, outputFolder string, stubOutputFolder string, projectOutputFolder string, implementation ComponentDefinitionImplementation, suppressStub bool, suppressInterfaces bool, suppressCmake bool) error {
 	forceRecreation := false
 
 	doJournal := len (component.Global.JournalMethod) > 0;
@@ -169,7 +169,7 @@ func BuildImplementationCPP(component ComponentDefinition, outputFolder string,
 			log.Printf("Omitting recreation of implementation stub \"%s\"", IntfWrapperStubName)
 		}
 
-		if ( len(projectOutputFolder) > 0 ) {
+		if ( !suppressCmake && len(projectOutputFolder) > 0 ) {
 			CMakeListsFileName := path.Join(projectOutputFolder, "CMakeLists.txt");
 			if forceRecreation || !FileExists(CMakeListsFileName) {
 				log.Printf("Creating CMake-Project \"%s\" for CPP Implementation", CMakeListsFileName)
@@ -833,11 +833,11 @@ func buildCPPGetSymbolAddressMethod(component ComponentDefinition, w LanguageWri
 }
 
 func buildCPPInterfaceWrapper(component ComponentDefinition, w LanguageWriter, NameSpace string, NameSpaceImplementation string, ClassIdentifier string, BaseName string, doJournal bool) error {
-	w.Writeln("#include \"%s_abi.hpp\"", strings.ToLower(BaseName))
-	w.Writeln("#include \"%s_interfaces.hpp\"", strings.ToLower(BaseName))
-	w.Writeln("#include \"%s_interfaceexception.hpp\"", strings.ToLower(BaseName))
+	w.Writeln("#include \"%s_abi.hpp\"", BaseName)
+	w.Writeln("#include \"%s_interfaces.hpp\"", BaseName)
+	w.Writeln("#include \"%s_interfaceexception.hpp\"", BaseName)
 	if (doJournal) {
-		w.Writeln("#include \"%s_interfacejournal.hpp\"", strings.ToLower(BaseName))
+		w.Writeln("#include \"%s_interfacejournal.hpp\"", BaseName)
 	}
 	w.Writeln("")
 	w.Writeln("#include <map>")