diff options
| author | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2019-04-11 11:19:10 +0200 |
|---|---|---|
| committer | Friedemann Kleint <Friedemann.Kleint@qt.io> | 2019-04-16 19:25:07 +0000 |
| commit | f21206eb95572af8759366fb249c868659c5674c (patch) | |
| tree | 642d30620ba6c73fd099d5ddde136a6c85e6133e /sources/shiboken2/doc | |
| parent | 38a9dc6cb2ba07be4b2c174a10fb60f1cdfba19a (diff) | |
shiboken: Enable including typesystem XML snippets via entities
Implement a QXmlStreamEntityResolver which resolves undeclared entities
to file names in the type system include path.
This is a work-around for the missing handling of standard externally
parsed entities of QXmlStreamReader.
Task-number: PYSIDE-955
Change-Id: I68ebae8ad465ae460c3a0eeadaef22dca2101e6c
Reviewed-by: Christian Tismer <tismer@stackless.com>
Diffstat (limited to 'sources/shiboken2/doc')
| -rw-r--r-- | sources/shiboken2/doc/typesystem_specifying_types.rst | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/sources/shiboken2/doc/typesystem_specifying_types.rst b/sources/shiboken2/doc/typesystem_specifying_types.rst index f4016bc2c..ac1121461 100644 --- a/sources/shiboken2/doc/typesystem_specifying_types.rst +++ b/sources/shiboken2/doc/typesystem_specifying_types.rst @@ -3,6 +3,30 @@ Specifying Types .. _typesystem: +Including Snippets +^^^^^^^^^^^^^^^^^^ + +There might be repetitive XML code, for example function modifications that +need to be done on classes that are not related by type inheritance. +It is possible to split out such snippets and include them via an entity reference. + +.. code-block:: xml + + <typesystem> + <object-type name="A"> + &common_function_modifications; + </object-type> + <object-type name="B"> + &common_function_modifications; + </object-type> + </typesystem> + +The entity name is interpreted as file name (with suffix **xml**) appended and resolved +in the type system paths passed as command line argument. + +Note that this is not a standard externally parsed entity due to the limitations +of the underlying parser. + typesystem ^^^^^^^^^^ |