Difference between revisions of "Inspection Module"
m (Text replacement - "[http://files.basex.org/" to "[https://files.basex.org/") |
|||
(6 intermediate revisions by the same user not shown) | |||
Line 28: | Line 28: | ||
<syntaxhighlight lang="xquery"> | <syntaxhighlight lang="xquery"> | ||
let $uri := 'code.xqm' | let $uri := 'code.xqm' | ||
− | let $name := | + | let $name := 'run' |
for $f in inspect:functions($uri) | for $f in inspect:functions($uri) | ||
where local-name-from-QName(function-name($f)) = $name | where local-name-from-QName(function-name($f)) = $name | ||
return $f() | return $f() | ||
</syntaxhighlight> | </syntaxhighlight> | ||
+ | |- | ||
+ | | '''Errors''' | ||
+ | |{{Error|parse|#Errors}} Error while parsing a module. | ||
|} | |} | ||
Line 98: | Line 101: | ||
==inspect:type== | ==inspect:type== | ||
− | |||
− | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
| width='120' | '''Signatures''' | | width='120' | '''Signatures''' | ||
− | |{{Func|inspect:type|$value as item()*|xs:string}} | + | |{{Func|inspect:type|$value as item()*|xs:string}}<br/>{{Func|inspect:type|$value as item()*, $options as map(*)|xs:string}} |
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Returns a string representation of the type of a value: | + | |Returns a string representation of the type of a {{Code|$value}}: |
* The string includes the occurrence indicator. | * The string includes the occurrence indicator. | ||
* The type of functions and nodes may be stricter than the returned type. | * The type of functions and nodes may be stricter than the returned type. | ||
* For type checking, the standard expressions {{Code|typeswitch}} and {{Code|instance of}} should be used instead. | * For type checking, the standard expressions {{Code|typeswitch}} and {{Code|instance of}} should be used instead. | ||
+ | The following {{Code|$options}} are available: | ||
+ | * {{Code|item}}: If enabled, only the item type is returned and the occurrence indicator is omitted. The default is {{Code|false()}}. | ||
+ | * {{Code|mode}}: If {{Code|value}} is specified, the assigned type of the result value is returned. With {{Code|expression}} the type of the input expression is returned (please note that the original expression may already have been rewritten at compile-time). With {{Code|computed}}, the exact value is computed at runtime, based on the expression and the result value. The default is {{Code|computed}}. | ||
|- | |- | ||
| '''Examples''' | | '''Examples''' | ||
| | | | ||
− | * <code>inspect:type( | + | * <code>inspect:type((<a/>, <a/>))</code> yields <code>element(a)+</code> |
− | * <code>inspect:type(map { 'a': (1, 2)[. = 1] })</code> | + | * <code>inspect:type(map { 'a': (1, 2)[. = 1] })</code> yields <code>map(xs:string, xs:integer)</code> |
− | * <code>inspect:type( | + | * <code>inspect:type(1 to 100, map { 'item': true() })</code> yields <code>xs:integer</code> |
|} | |} | ||
Line 127: | Line 131: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Inspects the specified {{Code|$function}} and returns an element that describes its structure. The output of this function is similar to eXist-db’s [ | + | |Inspects the specified {{Code|$function}} and returns an element that describes its structure. The output of this function is similar to eXist-db’s [https://exist-db.org/exist/apps/fundocs/view.html?uri=http://exist-db.org/xquery/inspection&location=java:org.exist.xquery.functions.inspect.InspectionModule inspect:inspect-function] function. |
|- | |- | ||
|'''Examples''' | |'''Examples''' | ||
Line 194: | Line 198: | ||
|'''Examples''' | |'''Examples''' | ||
|An example is [[#Examples|shown below]]. | |An example is [[#Examples|shown below]]. | ||
+ | |- | ||
+ | | '''Errors''' | ||
+ | |{{Error|parse|#Errors}} Error while parsing a module. | ||
|} | |} | ||
Line 204: | Line 211: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Retrieves the resource located at the specified {{Code|$uri}}, parses it as XQuery module, and generates an xqDoc element. A relative URI will be resolved against the static base URI of the query.<br/>[http://xqdoc.org xqDoc] provides a simple vendor-neutral solution for generating documentation from XQuery modules. The documentation conventions have been inspired by the JavaDoc standard. Documentation comments begin with {{Code|(:~}} and end with {{Code|:)}}, and tags start with {{Code|@}}. xqDoc comments can be specified for main and library modules and variable and function declarations.<br/> | + | |Retrieves the resource located at the specified {{Code|$uri}}, parses it as XQuery module, and generates an xqDoc element. A relative URI will be resolved against the static base URI of the query.<br/>[http://xqdoc.org/ xqDoc] provides a simple vendor-neutral solution for generating documentation from XQuery modules. The documentation conventions have been inspired by the JavaDoc standard. Documentation comments begin with {{Code|(:~}} and end with {{Code|:)}}, and tags start with {{Code|@}}. xqDoc comments can be specified for main and library modules and variable and function declarations.<br/> |
We have slightly extended the xqDoc conventions to do justice to more recent versions of XQuery (Schema: [https://files.basex.org/etc/xqdoc-1.1.30052013.xsd xqdoc-1.1.30052013.xsd]):<br/> | We have slightly extended the xqDoc conventions to do justice to more recent versions of XQuery (Schema: [https://files.basex.org/etc/xqdoc-1.1.30052013.xsd xqdoc-1.1.30052013.xsd]):<br/> | ||
* an {{Code|<xqdoc:annotations/>}} node is added to each variable or function that uses annotations. The xqdoc:annotation child nodes may have additional {{Code|xqdoc:literal}} elements with {{Code|type}} attributes (xs:string, xs:integer, xs:decimal, xs:double) and values. | * an {{Code|<xqdoc:annotations/>}} node is added to each variable or function that uses annotations. The xqdoc:annotation child nodes may have additional {{Code|xqdoc:literal}} elements with {{Code|type}} attributes (xs:string, xs:integer, xs:decimal, xs:double) and values. | ||
Line 212: | Line 219: | ||
|'''Examples''' | |'''Examples''' | ||
|An example is [[#Examples|shown below]]. | |An example is [[#Examples|shown below]]. | ||
+ | |- | ||
+ | | '''Errors''' | ||
+ | |{{Error|parse|#Errors}} Error while parsing a module. | ||
|} | |} | ||
Line 326: | Line 336: | ||
! width="110"|Code | ! width="110"|Code | ||
|Description | |Description | ||
+ | |- | ||
+ | |{{Code|parse}} | ||
+ | |Error while parsing a module. | ||
|- | |- | ||
|{{Code|unknown}} | |{{Code|unknown}} | ||
Line 332: | Line 345: | ||
=Changelog= | =Changelog= | ||
+ | |||
+ | ;Version 9.6 | ||
+ | * Updated: [[#inspect:type|inspect:type]]: options added | ||
;Version 9.3 | ;Version 9.3 |
Revision as of 09:59, 26 April 2022
This XQuery Module contains functions for extracting internal information about modules and functions and generating documentation.
Contents
Conventions
All functions and errors in this module are assigned to the http://basex.org/modules/inspect
namespace, which is statically bound to the inspect
prefix.
xqDoc document instances are assigned to the http://www.xqdoc.org/1.0
namespace, which is statically bound to the xqdoc
prefix.
Reflection
inspect:functions
Signatures | inspect:functions() as function(*)* inspect:functions($uri as xs:string) as function(*)*
|
Summary | Returns function items for all user-defined functions (both public and private) that are known in the current query context. If a $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.
|
Examples | Invokes the declared functions and returns their values: <syntaxhighlight lang="xquery">
declare %private function local:one() { 12 };
declare %private function local:two() { 34 };
for $f in inspect:functions() return $f()
</syntaxhighlight>
Compiles all functions in |
Errors | parse : Error while parsing a module.
|
inspect:function-annotations
Signatures | inspect:function-annotations($function as function(*)?) as map(xs:QName, xs:anyAtomicType*) |
Summary | Returns the annotations of the specified $function in a map.
|
Examples |
<syntaxhighlight lang="xquery"> inspect:function-annotations(true#0) </syntaxhighlight>
<syntaxhighlight lang="xquery"> declare %private function local:f() { 'well hidden' }; inspect:function-annotations(local:f#0) </syntaxhighlight> |
inspect:static-context
Signatures | inspect:static-context($function as function(*)?, $name as xs:string) as item()* |
Summary | Returns a component of the static context of a $function with the specified $name . If no function is supplied, the current static context is considered.The following components can be requested:
|
Examples |
<syntaxhighlight lang="xquery"> inspect:static-context((), 'base-uri') </syntaxhighlight>
<syntaxhighlight lang="xquery"> import module namespace data = 'data.xqm'; inspect:static-context(data:get#1, 'namespaces') </syntaxhighlight> |
Errors | unknown : The specified component does not exist.
|
Documentation
inspect:type
Signatures | inspect:type($value as item()*) as xs:string inspect:type($value as item()*, $options as map(*)) as xs:string
|
Summary | Returns a string representation of the type of a $value :
The following
|
Examples |
|
inspect:function
Signatures | inspect:function($function as function(*)) as element(function)
|
Summary | Inspects the specified $function and returns an element that describes its structure. The output of this function is similar to eXist-db’s inspect:inspect-function function.
|
Examples | The query inspect:function(count#1) yields:
<syntaxhighlight lang="xml"> <function name="count" uri="http://www.w3.org/2005/xpath-functions" external="false"> <argument type="item()" occurrence="*"/> <return type="xs:integer"/> </function> </syntaxhighlight> The function… <syntaxhighlight lang="xquery"> (:~ : This function simply returns the specified integer. : @param $number number to return : @return specified number :) declare %private function local:same($number as xs:integer) as xs:integer { $number };
</syntaxhighlight>
…is represented by <argument type="xs:integer" name="number">number to return</argument> <annotation name="private" uri="http://www.w3.org/2012/xquery"/> <description>This function simply returns the specified integer.</description> <return type="xs:integer">specified number</return> </function> </syntaxhighlight> |
inspect:context
Signatures | inspect:context() as element(context)
|
Summary | Generates an element that describes all variables and functions in the current query context. |
Examples | Evaluate all user-defined functions with zero arguments in the query context: <syntaxhighlight 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"> for $f in inspect:context()/function where $f/annotation/@name = 'private' return $f/@name/string() </syntaxhighlight> |
inspect:module
Signatures | inspect:module($uri as xs:string) as element(module)
|
Summary | Retrieves the resource located at the specified $uri , parses it as XQuery module, and generates an element that describes the module's structure. A relative URI will be resolved against the static base URI of the query.
|
Examples | An example is shown below. |
Errors | parse : Error while parsing a module.
|
inspect:xqdoc
Signatures | inspect:xqdoc($uri as xs:string) as element(xqdoc:xqdoc)
|
Summary | Retrieves the resource located at the specified $uri , parses it as XQuery module, and generates an xqDoc element. A relative URI will be resolved against the static base URI of the query.xqDoc provides a simple vendor-neutral solution for generating documentation from XQuery modules. The documentation conventions have been inspired by the JavaDoc standard. Documentation comments begin with (:~ and end with :) , and tags start with @ . xqDoc comments can be specified for main and library modules and variable and function declarations.We have slightly extended the xqDoc conventions to do justice to more recent versions of XQuery (Schema: xqdoc-1.1.30052013.xsd):
|
Examples | An example is shown below. |
Errors | parse : Error while parsing a module.
|
Examples
This is the sample.xqm
library module:
<syntaxhighlight lang="xquery"> (:~
: This module provides some sample functions to demonstrate : the features of the Inspection Module. : : @author BaseX Team : @see http://docs.basex.org/wiki/XQDoc_Module : @version 1.0 :)
module namespace samples = 'http://basex.org/modules/samples';
(:~ This is a sample string. :) declare variable $samples:test-string as xs:string := 'this is a string';
(:~
: This function simply returns the specified integer. : @param $number number to return : @return specified number :)
declare %private function samples:same($number as xs:integer) as xs:integer {
$number
}; </syntaxhighlight>
If inspect:module('sample.xqm')
is run, the following output will be generated:
<syntaxhighlight lang="xml"> <module prefix="samples" uri="http://basex.org/modules/samples">
<description>This module provides some sample functions to demonstrate
the features of the Inspection Module.</description>
<author>BaseX Team</author> <see>http://docs.basex.org/wiki/XQDoc_Module</see> <version>1.0</version> <variable name="samples:test-string" uri="http://basex.org/modules/samples" type="xs:string" external="false"> <description>This is a sample string.</description> </variable> <function name="samples:same" uri="http://basex.org/modules/samples" external="false"> <argument name="number" type="xs:integer">number to return</argument> <annotation name="private" uri="http://www.w3.org/2012/xquery"/> <description>This function simply returns the specified integer.</description> <return type="xs:integer">specified number</return> </function>
</module> </syntaxhighlight>
The output looks as follows if inspect:xqdoc('sample.xqm')
is called:
<syntaxhighlight lang="xml"> <xqdoc:xqdoc xmlns:xqdoc="http://www.xqdoc.org/1.0">
<xqdoc:control> <xqdoc:date>2013-06-01T16:59:33.654+02:00</xqdoc:date> <xqdoc:version>1.1</xqdoc:version> </xqdoc:control> <xqdoc:module type="library"> <xqdoc:uri>http://basex.org/modules/samples</xqdoc:uri> <xqdoc:name>sample.xqm</xqdoc:name> <xqdoc:comment> <xqdoc:description>This module provides some sample functions to demonstrate
the features of the Inspection Module.</xqdoc:description>
<xqdoc:author>BaseX Team</xqdoc:author> <xqdoc:see>http://docs.basex.org/wiki/XQDoc_Module</xqdoc:see> <xqdoc:version>1.0</xqdoc:version> </xqdoc:comment> </xqdoc:module> <xqdoc:namespaces> <xqdoc:namespace prefix="samples" uri="http://basex.org/modules/samples"/> </xqdoc:namespaces> <xqdoc:imports/> <xqdoc:variables> <xqdoc:variable> <xqdoc:name>samples:test-string</xqdoc:name> <xqdoc:comment> <xqdoc:description>This is a sample string.</xqdoc:description> </xqdoc:comment> <xqdoc:type>xs:string</xqdoc:type> </xqdoc:variable> </xqdoc:variables> <xqdoc:functions> <xqdoc:function arity="1"> <xqdoc:comment> <xqdoc:description>This function simply returns the specified integer.</xqdoc:description> <xqdoc:param>$number number to return</xqdoc:param> <xqdoc:return>specified number</xqdoc:return> </xqdoc:comment> <xqdoc:name>samples:same</xqdoc:name> <xqdoc:annotations> <xqdoc:annotation name="private"/> </xqdoc:annotations> <xqdoc:signature>declare %private function samples:same($number as xs:integer) as xs:integer</xqdoc:signature> <xqdoc:parameters> <xqdoc:parameter> <xqdoc:name>number</xqdoc:name> <xqdoc:type>xs:integer</xqdoc:type> </xqdoc:parameter> </xqdoc:parameters> <xqdoc:return> <xqdoc:type>xs:integer</xqdoc:type> </xqdoc:return> </xqdoc:function> </xqdoc:functions>
</xqdoc:xqdoc> </syntaxhighlight>
Errors
Code | Description |
---|---|
parse
|
Error while parsing a module. |
unknown
|
The specified component does not exist. |
Changelog
- Version 9.6
- Updated: inspect:type: options added
- Version 9.3
- Added: inspect:type
- Version 8.5
- Added: inspect:function-annotations, inspect:static-context
- Updated:
external
attribute added to variables and functions - Updated: Relative URIs will always be resolved against the static base URI of the query
- Version 7.9
- Updated: a query URI can now be specified with inspect:functions.
This module was introduced with Version 7.7.