Merge pull request #15 from Autodesk/release/1.4.0

Release/1.4.0

Author: martinweismann

.travis.yml

@@ -0,0 +1,22 @@
+# Configuration file for Travis CI (https://travis-ci.org)
+#
+# It used as a status check for all PRs and
+# to generate the build-status-icon in the main README.md-file.
+
+language: go
+
+go:
+  - 1.11.x
+
+matrix:
+  include:
+    - os: linux
+      compiler: gcc
+    - os: osx
+      osx_image: xcode7.2
+
+before_script:
+    - cd Build
+
+script:
+    - sh build.sh

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email protected]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -16,6 +16,8 @@ You can also contribute by reporting bugs in the [Issue tracker](../../issues),
 
 2. When contributing to this repository, please first discuss the change you wish to make via issue with the [maintainers](#maintainers) of this repository. This way, we can ensure that there is no overlap between contributions or internal development work.
 
+3. Adhere to the [code of conduct](CODE_OF_CONDUCT.md).
+
 ## Submitting a pull request
 When ready to contribute, fork this repository and submit a pull request that references the issue it resolves. Be sure to include a clear and detailed description of the changes you've made so that we can verify them and eventually merge.
 

Documentation/IDL.md

@@ -4,7 +4,7 @@
 
 
 
-| **Version** | 0.1.0 |
+| **Version** | 1.3.2 |
 | --- | --- |
 
 ## Disclaimer
@@ -76,6 +76,7 @@ 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. |
 | year | **ST\_Year** | optional | the current year | The year associcated with the copyright. |
 | @anyAttribute | | | | |
 
@@ -97,13 +98,13 @@ Element **\<license>** of type **CT\_License**
 
 ![element license](images/element_license.png)
 
-The \<license> element contains a list of at least one child [license line](#3-license-line) element.
+The \<license> element contains a list of at least one child [line](#3-line) element.
 The license lines will be included as comments at the start of all generated source code files.
 
-## 3. License Line
-Element **\<licenseline>** of type **CT\_LicenseLine**
+## 3. Line
+Element **\<line>** of type **CT\_LicenseLine**
 
-![element licenseline](images/element_licenseline.png)
+![element line](images/element_line.png)
 
 ##### Attributes
 | Name | Type | Use | Default | Annotation |
@@ -163,7 +164,10 @@ Element **\<global>** of type **CT\_Global**
 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.
 
-TODO: explanation of siganture of release and version method.
+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"`.
+
+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"`.
 
 ## 8. Class
 Element **\<class>** of type **CT\_Class**
@@ -314,6 +318,11 @@ TODO: add all simple types here.
 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`.
 
 ### 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.
+
 ### 17.3 ComposedType
 ### 17.4 Name
 ### 17.5 Description
@@ -332,8 +341,7 @@ ST_Type `string` denotes a null-terminated string. If a component requires arbit
 
 
 # Appendix A. XSD Schema of ACT-IDL
-See [ACT.xsd](../Source/ACT.xsd).
-TODO: include the .xsds content here.
+See [ACT.xsd](../Source/ACT.xsd)
 
 # Appendix B. Example of ACT-IDL
-dolor sit amen
+See [libPrimes.xml](../Examples/Primes/libPrimes.xml)