jyapayne/swig
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Fragments: additional testing and documentation enhancements

Browse source 
Add test for original syntax when using a single fragment key containing
the list of dependent fragments. I couldn't find a test for this.

Spaces in the fragment list don't seem to work - document it.
This commit is contained in:
William S Fulton 2022-02-07 21:39:09 +00:00
commit d59cbf1c39
3 changed files with 54 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

39
Doc/Manual/Typemaps.html
View file

@ -3835,7 +3835,7 @@ To eliminate this, define a fragment that includes the common marshalling code:
<p>
When the "in" or "varin" typemaps for MyClass are required, the
contents of the fragment called "AsMyClass" is added to the "header" section within the generated code, and then the
contents of the fragment called "AsMyClass" are added to the "header" section within the generated code, and then the
typemap code is emitted. Hence, the method <tt>AsMyClass</tt> will be
generated into the wrapper code before any typemap code that calls it.
</p>
@ -3983,29 +3983,34 @@ inclusion of the other fragments.
<li>
<p>
A typemap can also use more than one fragment with the same syntax:
A typemap can also use more than one fragment:
</p>
<div class="code">
<pre>
%typemap("in", "header", fragment="frag1", fragment="frag2", fragment="frag3") "";
</pre>
</div>
<p>
<em>New in SWIG 4.1.</em>
</p>
<p>An older syntax allows multiple fragments to be specified in a comma
separated list inside a single keyword argument. Consider:
</p>
<div class="code">
<pre>
%typemap(in, fragment="frag1, frag2, frag3") {...}
%typemap("in", fragment="frag1", fragment="frag2", fragment="frag3") {...}
</pre>
</div>
<p>
which is equivalent to:
<b>Compatibility note: </b> The ability to use multiple
<tt>fragment</tt> keys as shown above was introduced in SWIG-4.1.0.
</p>
<p>
Multiple fragments can alternatively be specified as a comma
separated list value in a single <tt>fragment</tt> key.
Note that no whitespace is allowed within this comma separated list.
The following is the equivalent to the above:
</p>
<div class="code">
<pre>
%typemap(in, fragment="frag1,frag2,frag3") {...}
</pre>
</div>
<p>
which in turn is functionally equivalent to:
</p>
<div class="code">