Inspection Module - Revision history

CG: Text replacement - "syntaxhighlight" to "pre"

2023-12-01T16:39:51Z

Text replacement - "syntaxhighlight" to "pre"

CG: Text replacement - "" to ""

2023-12-01T16:35:38Z

Text replacement - "</syntaxhighlight>" to "</pre>"

CG: Text replacement - "" to "

2023-12-01T16:35:31Z

Text replacement - "<syntaxhighlight lang="xquery">" to "<pre lang='xquery'>"

CG at 10:52, 26 October 2023

2023-10-26T10:52:42Z

CG: /* inspect:type */

2023-10-13T16:30:05Z

inspect:type

CG at 14:54, 9 March 2023

2023-03-09T14:54:11Z

CG at 13:57, 9 March 2023

2023-03-09T13:57:16Z

CG: Text replacement - "'''Signatures'''" to "'''Signature'''"

2023-03-09T13:05:51Z

Text replacement - "'''Signatures'''" to "'''Signature'''"

CG at 11:06, 9 March 2023

2023-03-09T11:06:21Z

CG at 12:18, 20 July 2022

2022-07-20T12:18:47Z

Show changes

@@ Line 124: / Line 124: @@
 |'''Examples'''
 |The query {{Code|inspect:function(count#1)}} yields:
-<syntaxhighlight lang="xml">
+<pre lang="xml">
 <function name="count" uri="http://www.w3.org/2005/xpath-functions" external="false">
    <argument type="item()" occurrence="*"/>
@@ Line 142: / Line 142: @@
 </pre>
 …is represented by {{Code|inspect:function(local:same#1)}} as…
-<syntaxhighlight lang="xml">
+<pre lang="xml">
 <function name="local:same" uri="http://www.w3.org/2005/xquery-local-functions" external="false">
    <argument type="xs:integer" name="number">number to return</argument>
@@ Line 247: / Line 247: @@
 If {{Code|inspect:module('sample.xqm')}} is run, the following output will be generated:
-<syntaxhighlight lang="xml">
+<pre lang="xml">
 <module prefix="samples" uri="http://basex.org/modules/samples">
    <description>This module provides some sample functions to demonstrate
@@ Line 268: / Line 268: @@
 The output looks as follows if {{Code|inspect:xqdoc('sample.xqm')}} is called:
-<syntaxhighlight lang="xml">
+<pre lang="xml">
 <xqdoc:xqdoc xmlns:xqdoc="http://www.xqdoc.org/1.0">
    <xqdoc:control>

@@ Line 28: / Line 28: @@
 declare %private function local:two() { 34 };
 for $f in inspect:functions() return $f()
-</syntaxhighlight>
+</pre>
 Compiles all functions in {{Code|code.xqm}} and invokes the function named {{Code|run}}:
 <pre lang='xquery'>
@@ Line 36: / Line 36: @@
 where local-name-from-QName(function-name($f)) = $name
 return $f()
-</syntaxhighlight>
+</pre>
 |- valign="top"
 | '''Errors'''
@@ Line 71: / Line 71: @@
 <pre lang='xquery'>
 inspect:static-context((), 'base-uri')
-</syntaxhighlight>
+</pre>
 * Returns a map with all namespaces that are statically known in the module of the specified function:
 <pre lang='xquery'>
 import module namespace data = 'data.xqm';
 inspect:static-context(data:get#1, 'namespaces')
-</syntaxhighlight>
+</pre>
 |- valign="top"
 | '''Errors'''
@@ Line 129: / Line 129: @@
    <return type="xs:integer"/>
 </function>
-</syntaxhighlight>
+</pre>
 The function…
 <pre lang='xquery'>
@@ Line 140: / Line 140: @@
    $number
 };
-</syntaxhighlight>
+</pre>
 …is represented by {{Code|inspect:function(local:same#1)}} as…
 <syntaxhighlight lang="xml">
@@ Line 149: / Line 149: @@
    <return type="xs:integer">specified number</return>
 </function>
-</syntaxhighlight>
+</pre>
 |}
@@ Line 166: / Line 166: @@
 <pre lang='xquery'>
 inspect:context()/function ! function-lookup(QName(@uri, @name), 0) ! .()
-</syntaxhighlight>
+</pre>
 Return the names of all private functions in the current context:
 <pre lang='xquery'>
@@ Line 172: / Line 172: @@
 where $f/annotation/@name = 'private'
 return $f/@name/string()
-</syntaxhighlight>
+</pre>
 |}
@@ Line 243: / Line 243: @@
    $number
 };
-</syntaxhighlight>
+</pre>
 If {{Code|inspect:module('sample.xqm')}} is run, the following output will be generated:
@@ Line 264: / Line 264: @@
    </function>
 </module>
-</syntaxhighlight>
+</pre>
 The output looks as follows if {{Code|inspect:xqdoc('sample.xqm')}} is called:
@@ Line 322: / Line 322: @@
    </xqdoc:functions>
 </xqdoc:xqdoc>
-</syntaxhighlight>
+</pre>
 =Errors=

@@ Line 24: / Line 24: @@
 |'''Examples'''
 |Invokes the declared functions and returns their values:<br/>
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 declare %private function local:one() { 12 };
 declare %private function local:two() { 34 };
@@ Line 30: / Line 30: @@
 </syntaxhighlight>
 Compiles all functions in {{Code|code.xqm}} and invokes the function named {{Code|run}}:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 let $uri := 'code.xqm'
 let $name := 'run'
@@ Line 69: / Line 69: @@
+|
 * Returns the static base URI (same as {{Code|static-base-uri()}}):
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 inspect:static-context((), 'base-uri')
 </syntaxhighlight>
 * Returns a map with all namespaces that are statically known in the module of the specified function:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 import module namespace data = 'data.xqm';
 inspect:static-context(data:get#1, 'namespaces')
@@ Line 131: / Line 131: @@
 </syntaxhighlight>
 The function…
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 (:~
   : This function simply returns the specified integer.
@@ Line 164: / Line 164: @@
 | '''Examples'''
 |Evaluate all user-defined functions with zero arguments in the query context:<br/>
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 inspect:context()/function ! function-lookup(QName(@uri, @name), 0) ! .()
 </syntaxhighlight>
 Return the names of all private functions in the current context:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 for $f in inspect:context()/function
 where $f/annotation/@name = 'private'
@@ Line 221: / Line 221: @@
 This is the {{Code|sample.xqm}} library module:
-<syntaxhighlight lang="xquery">
+<pre lang='xquery'>
 (:~
   : This module provides some sample functions to demonstrate

@@ Line 1: / Line 1: @@
 This [[Module Library|XQuery Module]] contains functions for extracting internal information about modules and functions and generating documentation.
 =Conventions=
@@ Line 38: / Line 40: @@
 | '''Errors'''
 |{{Error|parse|#Errors}} Error while parsing a module.
 |}
@@ Line 361: / Line 338: @@
 =Changelog=
 ;Version 9.6

@@ Line 114: / Line 114: @@
 |<pre>inspect:type(
    $input    as item()*,
-   $options  as map(*)   := map { }
+   $options  as map(*)?  := map { }
 ) as xs:string</pre>
 |- valign="top"

@@ Line 14: / Line 14: @@
 | width='120' | '''Signature'''
 |<pre>inspect:functions(
-   $uri  as xs:string  := ()
+   $href  as xs:string  := ()
 ) as function(*)*</pre>
 |- valign="top"
 | '''Summary'''
-|Returns function items for all user-defined functions (both public and private) that are known in the current query context. If a {{Code|$uri}} is specified, the specified resource will be retrieved as string and compiled, and its functions will be added to the query context and returned to the user. A relative URI will be resolved against the static base URI of the query.
+|Returns function items for all user-defined functions (both public and private) that are known in the current query context. If an {{Code|$href}} value is specified, the specified resource will be retrieved as a string and compiled, and its functions will be added to the query context and returned to the user. A relative URI will be resolved against the static base URI of the query.
 |- valign="top"
 |'''Examples'''
@@ Line 46: / Line 46: @@
 | width='120' | '''Signature'''
 |<pre>inspect:function-annotations(
-   $function  as function(*)?
+   $function  as function(*)
 ) as map(xs:QName, xs:anyAtomicType*)</pre>
 |- valign="top"
@@ Line 71: / Line 71: @@
 | width='120' | '''Signature'''
 |<pre>inspect:static-context(
-   $function  as function(*)?
+   $function  as function(*)?,
    $name      as xs:string
 ) as item()*</pre>
@@ Line 113: / Line 113: @@
 | width='120' | '''Signature'''
 |<pre>inspect:type(
-   $value    as item()*
+   $input    as item()*,
    $options  as map(*)   := ()
 ) as xs:string</pre>
 |- valign="top"
 | '''Summary'''
-|Returns a string representation of the type of a {{Code|$value}}:
+|Returns a string representation of the type of a the given {{Code|$input}}:
 * The string includes the occurrence indicator.
 * The type of functions and nodes may be stricter than the returned type.