Autodesk
diff --git a/‎.gitignore
Lines changed: 1 addition & 0 deletions b/‎.gitignore
Lines changed: 1 addition & 0 deletions
diff --git a/‎Build/Readme.md
Lines changed: 8 additions & 0 deletions b/‎Build/Readme.md
Lines changed: 8 additions & 0 deletions
diff --git a/‎Build/build.bat
Lines changed: 1 addition & 1 deletion b/‎Build/build.bat
Lines changed: 1 addition & 1 deletion
diff --git a/‎Build/build.sh
Lines changed: 1 addition & 1 deletion b/‎Build/build.sh
Lines changed: 1 addition & 1 deletion
diff --git a/‎Build/verpatch.exe
115 KB b/‎Build/verpatch.exe
115 KB
diff --git a/‎CONTRIBUTING.md
Lines changed: 1 addition & 1 deletion b/‎CONTRIBUTING.md
Lines changed: 1 addition & 1 deletion
diff --git a/‎Documentation/IDL.md
Lines changed: 65 additions & 12 deletions b/‎Documentation/IDL.md
Lines changed: 65 additions & 12 deletions
diff --git a/‎Documentation/images/element_global.png
6.53 KB b/‎Documentation/images/element_global.png
6.53 KB
@@ -7,6 +7,7 @@
 *.exe
 *.c
 *.go
+*.orig
 
 # Visual Studio Code
 debug
 
@@ -0,0 +1,8 @@
+verpatch.exe is an amazing tool to change resource information in EXEs and DLLs
+
+https://github.com/pavel-a/ddverpatch/releases
+
+Call like this
+```
+verpatch.exe ..\act.exe /high /va 1.5.0 /pv "1.5.0-RC1+buildnumber-5" /s copyright "(c) 2018-2019 ACT Developers" /s desc "ACT is a code generator for software components" /s productName "Automatic Component Toolkit"
+```
@@ -3,7 +3,7 @@ set startingDir="%CD%"
 set basepath="%~dp0"
 
 cd %basepath%\..\Source
-set Sources=actutils.go automaticcomponenttoolkit.go buildbindingcdynamic.go buildbindingcpp.go buildbindinggo.go buildbindingnode.go buildbindingpascal.go buildbindingpython.go buildimplementationcpp.go buildimplementationpascal.go componentdefinition.go componentdiff.go languagewriter.go languagec.go languagepascal.go
+set Sources=actutils.go automaticcomponenttoolkit.go buildbindingccpp.go buildbindingcsharp.go buildbindinggo.go buildbindingnode.go buildbindingpascal.go buildbindingpython.go buildimplementationcpp.go buildimplementationpascal.go componentdefinition.go componentdiff.go languagewriter.go languagec.go languagecpp.go languagepascal.go
 set GOARCH=amd64
 
 set GOOS=windows
 
@@ -4,7 +4,7 @@ startingpath="$(pwd)"
 basepath="$(cd "$(dirname "$0")" && pwd)"
 cd "$basepath/../Source"
 
-Sources="actutils.go automaticcomponenttoolkit.go buildbindingcdynamic.go buildbindingcpp.go buildbindinggo.go buildbindingnode.go buildbindingpascal.go buildbindingpython.go buildimplementationcpp.go buildimplementationpascal.go componentdefinition.go componentdiff.go languagewriter.go languagec.go languagepascal.go"
+Sources="actutils.go automaticcomponenttoolkit.go buildbindingccpp.go buildbindingcsharp.go buildbindinggo.go buildbindingnode.go buildbindingpascal.go buildbindingpython.go buildimplementationcpp.go buildimplementationpascal.go componentdefinition.go componentdiff.go languagewriter.go languagec.go languagecpp.go languagepascal.go"
 GOARCH="amd64"
 
 echo "Build act.exe"
 
@@ -6,7 +6,7 @@ Contributions are welcome and we are looking for people that can improve existin
 You can also contribute by reporting bugs in the [Issue tracker](../../issues), helping review pull requests, participate in discussions about issues and more.
 
 ## Filing issues
-1. When filing an issue to report errors or problems, make sure to answer these five questions:
+1. When filing an [issue](../../issues) to report errors or problems, make sure to answer these five questions:
 	1. Which version of ACT are you using?
 		Run <br/>`act.* -v`<br/> to print ACT's version.
 	2. Which operating system, programming language(s) and development tools (compiler/interpreter) are you using?
 
@@ -4,7 +4,7 @@
 
 
 
-| **Version** | 1.3.2 |
+| **Version** | 1.5.0 |
 | --- | --- |
 
 ## Disclaimer
@@ -76,10 +76,13 @@ Element **\<component>** of type **CT\_Component**
 | namespace | **ST\_NameSpace** | required | | Specifies the namespace for the components's functionality. |
 | copyright | **xs:string** | required | | The legal copyright holder. |
 | basename | **ST\_BaseName** | required | | The basename will be used as prefix for generated filenames and all sorts of identifiers in the generated source code. |
-| version | **ST\_Version** | required | | The three digit vesion of this component. |
+| version | **ST\_Version** | required | | The semantic version of this component. |
 | year | **ST\_Year** | optional | the current year | The year associcated with the copyright. |
 | @anyAttribute | | | | |
 
+It is RECOMMENDED that components generated with ACT follow the [semantic versioning scheme](https://semver.org/).
+The "version" attribute encodes the semantic version of this component. Major, Minor and Micro-version info MUST be included. Pre-release information and build information MAY be included.
+
 The \<component> element is the root element of a ACT-IDL file.
 There MUST be exactly one \<component> element in a ACT-IDL file.
 A component MUST have exactly one child [license](#2-license) element, 
@@ -147,7 +150,7 @@ of type **CT\_Export**
 | language | **ST\_Language** | required | | The programming langugage of this export. |
 | indentation | **ST\_Indentation** | optional | 4spaces | Which string should be used to denote a single level of indentation in the generated source code files. |
 | stubidentifier | **ST\_StubIdentifier** | optional | "" | Generated sources files of this export will follow the naming schme "...${BaseName}_${stubidentifier}...". Only used in \<implementation> right now. |
-| classidentifier | **ST\_ClassIdentifier** | optional | "" | Generated classes of this export will follow the naming schme "...${ClassIdentifier}${NameSpace}_${ClassName}...".  Only used in \<implementation> right now. |
+| classidentifier | **ST\_ClassIdentifier** | optional | "" | Generated classes of this export will follow the naming schme "...${ClassIdentifier}_${ClassName}...". The only binding that supports this are the C++-bindings.|
 
 ## 7. Global
 Element **\<global>** of type **CT\_Global**
@@ -157,18 +160,38 @@ Element **\<global>** of type **CT\_Global**
 ##### Attributes
 | Name | Type | Use | Default | Annotation |
 | --- | --- | --- | --- | --- |
+| baseclassname | **ST\_Name** | required | | Specifies the name of a class that is the base class for all classes of the generated component. |
 | releasemethod | **ST\_Name** | required | | Specifies the name of the method used to release a class instance owned by the generated component. |
-| versionmethod | **ST\_Name** | required | | Specifies the name of the method used to obtain the semantic version of the component. |
+| versionmethod | **ST\_Name** | required | | Specifies the name of the method used to obtain the major, minor and micro version of the component. |
+| prereleasemethod | **ST\_Name** | required | | Specifies the name of the method used to obtain the prerelease information of the component. |
+| buildinfomethod | **ST\_Name** | required | | Specifies the name of the method used to obtain the build information of the component. |
+| errormethod | **ST\_Name** | required | | Specifies the name of the method used to query the last error that occured during the call of class's method. |
 | journalmethod | **ST\_Name** | optional | | Specifies the name of the method used to set the journal file. If ommitted, journalling will not be built into the component. |
 
 The \<global> element contains a list of [method](#9-function-type) elements that define the exported global functions of the component.
 The names of the \<method> elements MUST be unique within the \<global> element.
 
-The `releasemethod`-attribute must be the name of a \<method> within the \<global> element of a method that has exactly one parameter with `type="handle"`, `class="BaseClass"` and `pass="in"`.
-The `versionmethod`-attribute must be the name of a \<method> within the \<global> element of a method that has exactly three parameters with `type="uint32"` and `pass="out"`.
+The `baseclassname`-attribute must be the name of a \<class> element within the components list of classes.
+This class will be the base class for all classes of the generated component.
+
+The `releasemethod`-attribute must be the name of a \<method> within the \<global> element of a component that has exactly one parameter with `type="class"`, `class="BaseClass"` and `pass="in"`.
+The `versionmethod`-attribute must be the name of a \<method> within the \<global> element of a component that has exactly three parameters. The three parameters MUST be of type `type="uint32"` and `pass="out"`.
+The `prereleasemethod`-attribute is optional an can be the name of a \<method> within the \<global> element of a component that has two parameters.
+The first parameter MUST be of type `type="bool"` and `pass="return"`, the second parameter MUST be of type `type="string"` and `pass="out"`.
+The `buildinfomethod`-attribute is optional an can be the name of a \<method> within the \<global> element of a component that has two parameters.
+The first parameter MUST be of type `type="bool"` and `pass="return"`, the second parameter MUST be of type `type="string"` and `pass="out"`.
+
+
+The `errormethod`-attribute must be the name of a \<method> within the \<global> element of a method that has exactly three parameters:
+1. `type="class"`, `class="$BASECLASSNAME"` and `pass="in"`, where `"$BASECLASSNAME"` is the value of the `baseclassname` attribute of the \<global> element.
+2. `type="string"` and `pass="out"`: outputs the last error message
+3. `type="bool"` and `pass="return"`: returns the instance of the baseclass has an error.
 
 If the `journalmethod` attribute is given, it must be the name of a \<method> within the \<global> element of a method that has exactly one parameter with `type="string"` and `pass="in"`.
 
+ **Note**
+ `type="handle"` is equivalent to `type="class"` for backwards compatibility. It will be removed in a later version.
+
 ## 8. Class
 Element **\<class>** of type **CT\_Class**
 
@@ -184,6 +207,10 @@ Element **\<class>** of type **CT\_Class**
 The \<class> element contains a list of [method](#9-function-type) elements that define the exported member functions of this class.
 The names of the \<method> elements MUST be unique in this list.
 
+If the `parent`-attribute is empty, and the name of this class differs from the `baseclassname`-attribute of the \<global> element, `baseclassname` will be considered as the parent class of this class.
+
+A class MUST be defined in the list of \<class> elements before it is used as parent-class of another class. This restiction rules out circular inheritance. Moreover, the default `baseclassname` MUST be defined as the first \<class> within the IDL-file.
+
 ## 9. Function Type
 Element **\<functiontype>**
 <br/>
@@ -293,6 +320,9 @@ Element **\<errors>** of type **CT\_ErrorList**
 The \<errors> element contains a list of [\<error>](#16-error) elements.
 The names and codes of the \<error> elements in this list MUST be unique within the \<errors> element.
 
+Each ACT-component MUST contain at least the following 8 error codes:
+
+`NOTIMPLEMENTED`, `INVALIDPARAM`, `INVALIDCAST`, `BUFFERTOOSMALL`, `GENERICEXCEPTION`, `COULDNOTLOADLIBRARY`, `COULDNOTFINDLIBRARYEXPORT`, `INCOMPATIBLEBINARYVERSION`
 
 ## 16. Error
 Element **\<error>** of type **CT\_Error**
@@ -312,18 +342,41 @@ The simple types of this specification encode features, concepts, data types,
 and naming rules used in or required by programming languages.
 
 For now, please look the up in the [ACT.xsd](../Source/ACT.xsd).
-TODO: add all simple types here.
 
 ### 17.1 Type
-ST_Type `string` denotes a null-terminated string. If a component requires arbitrary strings that can contain null-characters, on should use the type `basicarray` of class `uint8`.
+Supported types are:
+- `bool`: denotes a boolean value (`true` or `false`).
+Although this can be encoded in a single bit, the thin C89-layer APIs generated by ACT will use an unsigned 8 bit value (a `uint8` in ACT terms) to encode a boolean value.
+A numerical value of `0` encodes `false`, all oher values encode `true`.
+Implementations and bindings should use the definition of a boolean value that is native to the respective language of the implementation or binding.
+- `uint8`, `uint16`, `uint32`, `uint64`:
+An _unsigned_ integer vaules ranging from 0 - 2<sup>8</sup>-1, 0 - 2<sup>16</sup>-1, 0 - 2<sup>32</sup>-1, 0 - 2<sup>64</sup>-1, respectively.
+- `int8`, `int16`, `int32`, `int64`:
+A _signed_ integer vaules ranging from -2<sup>7</sup> - 2<sup>7</sup>-1, -2<sup>15</sup> - 2<sup>15</sup>-1,
+-2<sup>31</sup> - 2<sup>31</sup>-1,
+-2<sup>63</sup> - 2<sup>63</sup>-1, respectively.
+- `pointer`: An address in memory without knowledge of the kind of data that resides there. In C++, this corresponds to a `void*`.
+- `string` denotes a null-terminated string. If a component requires arbitrary strings that can contain null-characters, one should use the type `basicarray` of class `uint8`.
+- `single`: Single precision floating point number.
+- `double`: Double precision floating point number.
+- `struct`: see [13. Struct](#13-struct)
+- `enum`: see [11. Enum](#11-enum)
+- `basicarray`: an array of [ST\_ScalarTypes](#17-2-scalartype)
+- `enumarray`: an array of [enums](#11-enum)
+- `structarray`: an array of [structs](#13-struct)
+- `handle`: the identifier (address, unique identifier, hash, ...) of a class instance [class instance](#8-class)
+- `functiontype`: see [9. Function Type](#9-function-type)
 
 ### 17.2 ScalarType
-ST_ScalarType `bool` denotes a boolean value (`true` or `false`).
-Although this can be encoded in a single bit, the thin C89-layer APIs generated by ACT will use a unsigned 8 bit value (a `uint8` in ACT terms) to encode a boolean value.
-A numerical value of `0` encodes `false`, all oher values encode `true`.
-Implementations and bindings should use the definition of a boolean value native to the respective language of the implementation or binding.
+A subset of scalar or integral of ST\_Type:
+
+`bool`, `uint8`, `uint16`, `uint32`, `uint64`, `int8`, `int16`, `int32`, `int64`, `single`, `double`, `pointer`.
 
 ### 17.3 ComposedType
+A subset of more complex types, or types composed of other ST\_Types:
+
+`string`, `enum`, `basicarray`, `enumarray`, `structarray`, `handle`, `functiontype`
+
 ### 17.4 Name
 ### 17.5 Description
 ### 17.6 ErrorName
-Original file line number
+Diff line change
 *.exe
 *.c
 *.go
 +*.orig
 # Visual Studio Code
 debug