Difference between revisions of "Inspection Module"
(3 intermediate revisions by the same user not shown) | |||
Line 16: | Line 16: | ||
|- | |- | ||
| '''Summary''' | | '''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 addressed module will be compiled, and its functions will be added to the query context and returned to the user. | + | |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 addressed module will be 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''' | |'''Examples''' | ||
Line 36: | Line 36: | ||
==inspect:function-annotations== | ==inspect:function-annotations== | ||
− | |||
− | |||
{| width='100%' | {| width='100%' | ||
Line 61: | Line 59: | ||
==inspect:static-context== | ==inspect:static-context== | ||
− | |||
− | |||
{| width='100%' | {| width='100%' | ||
Line 102: | Line 98: | ||
==inspect:function== | ==inspect:function== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 113: | Line 110: | ||
|The query {{Code|inspect:function(count#1)}} yields: | |The query {{Code|inspect:function(count#1)}} yields: | ||
<pre class="brush:xml"> | <pre class="brush:xml"> | ||
− | <function name="count" uri="http://www.w3.org/2005/xpath-functions"> | + | <function name="count" uri="http://www.w3.org/2005/xpath-functions" external="false"> |
<argument type="item()" occurrence="*"/> | <argument type="item()" occurrence="*"/> | ||
<return type="xs:integer"/> | <return type="xs:integer"/> | ||
Line 131: | Line 128: | ||
…is represented by {{Code|inspect:function(local:same#1)}} as… | …is represented by {{Code|inspect:function(local:same#1)}} as… | ||
<pre class="brush:xml"> | <pre class="brush:xml"> | ||
− | <function name="local:same" uri="http://www.w3.org/2005/xquery-local-functions"> | + | <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> | <argument type="xs:integer" name="number">number to return</argument> | ||
<annotation name="private" uri="http://www.w3.org/2012/xquery"/> | <annotation name="private" uri="http://www.w3.org/2012/xquery"/> | ||
Line 141: | Line 138: | ||
==inspect:context== | ==inspect:context== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 163: | Line 161: | ||
==inspect:module== | ==inspect:module== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 169: | Line 168: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Retrieves the resource located at the specified {{Code|$uri}}, parses it as XQuery module, and generates an element that describes the module's structure. | + | |Retrieves the resource located at the specified {{Code|$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. |
|- | |- | ||
| '''Errors''' | | '''Errors''' | ||
Line 179: | Line 178: | ||
==inspect:xqdoc== | ==inspect:xqdoc== | ||
+ | |||
{| width='100%' | {| width='100%' | ||
|- | |- | ||
Line 185: | Line 185: | ||
|- | |- | ||
| '''Summary''' | | '''Summary''' | ||
− | |Retrieves the resource located at the specified {{Code|$uri}}, parses it as XQuery module, and generates an xqDoc element.<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 | + | We have slightly extended the xqDoc conventions to do justice to more recent versions of XQuery (Schema: [http://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. | ||
* a single {{Code|<xqdoc:namespaces/>}} node is added to the root element, which summarizes all prefixes and namespace URIs used or declared in the module. | * a single {{Code|<xqdoc:namespaces/>}} node is added to the root element, which summarizes all prefixes and namespace URIs used or declared in the module. | ||
Line 235: | Line 235: | ||
<see>http://docs.basex.org/wiki/XQDoc_Module</see> | <see>http://docs.basex.org/wiki/XQDoc_Module</see> | ||
<version>1.0</version> | <version>1.0</version> | ||
− | <variable name="samples:test-string" uri="http://basex.org/modules/samples" type="xs:string"> | + | <variable name="samples:test-string" uri="http://basex.org/modules/samples" type="xs:string" external="false"> |
<description>This is a sample string.</description> | <description>This is a sample string.</description> | ||
</variable> | </variable> | ||
− | <function name="samples:same" uri="http://basex.org/modules/samples"> | + | <function name="samples:same" uri="http://basex.org/modules/samples" external="false"> |
<argument name="number" type="xs:integer">number to return</argument> | <argument name="number" type="xs:integer">number to return</argument> | ||
<annotation name="private" uri="http://www.w3.org/2012/xquery"/> | <annotation name="private" uri="http://www.w3.org/2012/xquery"/> | ||
Line 318: | Line 318: | ||
;Version 8.5 | ;Version 8.5 | ||
− | |||
* Added: [[#inspect:function-annotations|inspect:function-annotations]], [[#inspect:static-context|inspect:static-context]] | * Added: [[#inspect:function-annotations|inspect:function-annotations]], [[#inspect:static-context|inspect:static-context]] | ||
+ | * Updated: {{Code|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 | ;Version 7.9 | ||
− | |||
* Updated: a query URI can now be specified with [[#inspect:functions|inspect:functions]]. | * Updated: a query URI can now be specified with [[#inspect:functions|inspect:functions]]. | ||
This module was introduced with Version 7.7. | This module was introduced with Version 7.7. |
Revision as of 15:01, 16 January 2017
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 addressed module will be 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:declare %private function local:one() { 12 }; declare %private function local:two() { 34 }; for $f in inspect:functions() return $f() Compiles all functions in let $uri := 'code.xqm' let $name := "run" for $f in inspect:functions($uri) where local-name-from-QName(function-name($f)) = $name return $f() |
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 |
inspect:function-annotations(true#0)
declare %private function local:f() { 'well hidden' }; inspect:function-annotations(local:f#0) |
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 |
inspect:static-context((), 'base-uri')
import module namespace data = 'data.xqm'; inspect:static-context(data:get#1, 'namespaces') |
Errors | unknown : The specified component does not exist.
|
Documentation
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:
<function name="count" uri="http://www.w3.org/2005/xpath-functions" external="false"> <argument type="item()" occurrence="*"/> <return type="xs:integer"/> </function> The function… (:~ : 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 }; …is represented by <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> <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> |
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:inspect:context()/function ! function-lookup(QName(@uri, @name), 0) ! .() Return the names of all private functions in the current context: for $f in inspect:context()/function where $f/annotation/@name = 'private' return $f/@name/string() |
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.
|
Errors | FODC0002 : the addressed resource cannot be retrieved.
|
Examples | An example is shown below. |
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):
|
Errors | FODC0002 : the addressed resource cannot be retrieved.
|
Examples | An example is shown below. |
Examples
This is the sample.xqm
library module:
(:~ : 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 };
If inspect:module('sample.xqm')
is run, the following output will be generated:
<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>
The output looks as follows if inspect:xqdoc('sample.xqm')
is called:
<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>
Errors
Code | Description |
---|---|
unknown
|
The specified component does not exist. |
Changelog
- 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.