Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Attempt to clarify p:import-functions #1111

Merged
merged 2 commits into from
Aug 29, 2024
Merged

Attempt to clarify p:import-functions #1111

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3a93a7f
Attempt to clarify p:import-functions
ndw Aug 28, 2024
fcbe673
Fix scoping of imported function names
ndw Aug 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 23 additions & 6 deletions xproc/src/main/xml/specification.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3578,10 +3578,22 @@ library <rfc2119>must</rfc2119> have unique names: it is a
<glossterm>static error</glossterm> if any static option name is
declared more than once in the same scope.</error></para>
</section>


<section>
<title>Scoping of imported function names</title>

<para>If functions can be imported with <tag>p:import-functions</tag>, the scope
of the imported functions is to expressions that appear in elements and
attributes that follow the <tag>p:import-functions</tag> element, in document
order, in the pipeline document.</para>

<para>If functions are imported in a <tag>p:library</tag>, they are also
available in pipelines that import that library. The scope of the imported
functions in the importing pipeline is the expressions that follow the
<tag>p:import</tag> element that imports the library, in document order,
in the importing pipeline document.</para>
</section>
</section>



<section xml:id="xml-base-attribute">
<title>Base URIs and xml:base</title>
Expand Down Expand Up @@ -6706,11 +6718,13 @@ L2 contains a step C, then:</para>
</section>
</section>

<section xml:id="p.import-functions"><title>p:import-functions</title>
<section xml:id="p.import-functions">
<title>p:import-functions</title>

<para>An <tag>p:import-functions</tag> element identifies a library of externally
defined functions to be imported into the pipeline. After the functions have been
imported, they are available in the processor XPath context.</para>
imported, they are available in the
<link linkend="xproc-xpath-context-31">processor XPath context</link>.</para>

<e:rng-pattern name="ImportFunctions"/>

Expand Down Expand Up @@ -6744,6 +6758,10 @@ in those namespaces will be loaded.
</varlistentry>
</variablelist>

<para>Imported functions are loaded during static analysis. In particular,
they can be used in <tag class="attribute">[p:]use-when</tag> expressions and in
expressions that initialize static options.</para>

<para>The ability to import functions is optional. <impl>Whether or not a processor
can import functions, and if it can, what kinds of function libraries it can import
from is <glossterm>implementation-defined</glossterm>.</impl> Pipeline authors can
Expand Down Expand Up @@ -6771,7 +6789,6 @@ arity). <error code="S0105">It is a <glossterm>static error</glossterm> if a fun
imported from a library has the same name and arity as a function already imported.</error>
</para>


</section>

<!-- ============================================================ -->
Expand Down
3 changes: 2 additions & 1 deletion xproc/src/main/xml/xpath-context.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -111,7 +111,8 @@ recent bindings are visible.</para>
<para>The signatures of the <biblioref linkend="xpath31-functions"/> in namespaces <literal>http://www.w3.org/2005/xpath-functions</literal>,
<literal>http://www.w3.org/2005/xpath-functions/math</literal>, <literal>http://www.w3.org/2005/xpath-functions/map</literal> and
<literal>http://www.w3.org/2005/xpath-functions/array</literal>. Additionally the function signatures defined in <xref
linkend="xpath-extension-functions"/>. </para>
linkend="xpath-extension-functions"/>. If a pipeline loads external functions
with <tag>p:import-functions</tag> those are available within their scope.</para>
</listitem>
</varlistentry>
<varlistentry>
Expand Down