summaryrefslogtreecommitdiff
path: root/docs/extending.rst
diff options
context:
space:
mode:
authorJuergen Bocklage-Ryannel <juergen@ryannel.org>2018-03-07 20:26:10 +0100
committerJuergen Bocklage-Ryannel <juergen@ryannel.org>2018-03-07 20:26:10 +0100
commit170b6ca90740903c0bd3f56e803452beac1863ec (patch)
tree155b46a10de68f3ed5089ea024eecafbebbac346 /docs/extending.rst
parent0aa4b17ac60ce0036911ad4205d4d96f669811c7 (diff)
downloadqtivi-qface-170b6ca90740903c0bd3f56e803452beac1863ec.tar.gz
added section for language profiles and maps to the guide
Diffstat (limited to 'docs/extending.rst')
-rw-r--r--docs/extending.rst30
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/extending.rst b/docs/extending.rst
index 5252ed0..910c086 100644
--- a/docs/extending.rst
+++ b/docs/extending.rst
@@ -195,3 +195,33 @@ See below for a simple example
{% endwith %}
Each tag in the JavaDoc styled comment, will be converted into a property of the object returned by `parse_doc`. All lines without a tag will be merged into the description tag.
+
+
+Language Profiles
+=================
+
+
+QFace supports the notion of profile. A profile is a set of features supported by the named profile. The intention of a profile is to make it easier for generator writers to stick to a limited set of language features, also if the overall language is evolving.
+
+Currently there exists three language profiles:
+
+* Micro - A limited set of languages features. The base profile. It does not allow importing of other modules or extending an interface, neither does it support maps.
+* Advanced - Builds upon micro and allows imports, maps, interface extension.
+* Full - Builds up on advanced and will also contain experimental language features.
+
+The current features defined are:
+- const oeprations
+- const properties
+- imports
+- maps
+- interface extensions
+
+The profiles and features are defined in the `qface.idl.profile` module.
+
+.. code-block:: py
+
+ from qface.generator import FileSystem
+ from qface.idl.profile import EProfile
+
+ system = FileSystem.parse(input=input, profile=EProfile.MICRO)
+