Newer
Older
(:~
: XQuery functions supplementing the eXist-db templating module
~:)
module namespace app-shared="http://xquery.weber-gesamtausgabe.de/modules/app-shared";
declare namespace templates="http://exist-db.org/xquery/templates";
import module namespace functx="http://www.functx.com";
import module namespace str="http://xquery.weber-gesamtausgabe.de/modules/str" at "str.xqm";
declare variable $app-shared:FUNCTION_LOOKUP_ERROR := QName("http://xquery.weber-gesamtausgabe.de/modules/app-shared", "FunctionLookupError");
(:~
: Looking for the templates:process() function from the templating module
: This module is a prerequisite for our supplement module
~:)
declare variable $app-shared:templates-process :=
try { function-lookup(xs:QName('templates:process'), 2) }
catch * { error($app-shared:FUNCTION_LOOKUP_ERROR, 'Failed to lookup templates:process() from the eXist-db templating module. Error code was "' || $err:code || '". Error message was "' || $err:description || '".') };
(:~
: Set an attribute to the value given in the $model map
:
: @author Peter Stadler
:)
declare function app-shared:set-attr($node as node(), $model as map(*), $attr as xs:string, $key as xs:string) as element() {
element {name($node)} {
$node/@*[not(name(.) = $attr)],
attribute {$attr} {$model($key)},
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
}
};
(:~
: Simply print the string value of $model($key)
:
: @author Peter Stadler
:)
declare
%templates:wrap
function app-shared:print($node as node(), $model as map(*), $key as xs:string) as xs:string? {
if ($model($key) castable as xs:string) then str:normalize-space($model($key))
else app-shared:join($node, $model, $key, '0', '')
};
(:~
: Simply print a sequence from the $model map by joining items with $separator
:
: @param $separator the separator for the string-join()
: @author Peter Stadler
:)
declare
%templates:wrap
%templates:default("max", "0")
%templates:default("separator", ", ")
function app-shared:join($node as node(), $model as map(*), $key as xs:string, $max as xs:string, $separator as xs:string) as xs:string? {
let $items :=
if($max castable as xs:integer and number($max) le 0) then $model($key)
else if($max castable as xs:integer and number($max) < count($model($key))) then (subsequence($model($key), 1, $max), '…')
else if($max castable as xs:integer and number($max) > 0) then subsequence($model($key), 1, $max)
else $model($key)
return
if (every $i in $items satisfies $i castable as xs:string) then string-join($items ! str:normalize-space(.), $separator)
else ()
};
(:~
: A non-wrapping alternative to the standard templates:each()
: Gets rid of the superfluous first list item
:
: @author Peter Stadler
:)
declare
%templates:default("max", "0")
%templates:default("callback", "0")
%templates:default("callbackArity", "2")
function app-shared:each($node as node(), $model as map(*), $from as xs:string, $to as xs:string, $max as xs:string, $callback as xs:string, $callbackArity as xs:string) as node()* {
let $items :=
if($max castable as xs:integer and $max != '0') then subsequence($model($from), 1, $max)
else $model($from)
let $callbackFunc :=
try { function-lookup(xs:QName($callback), 2) }
catch * { error($app-shared:FUNCTION_LOOKUP_ERROR, 'Failed to lookup function "' || $callback || '". Error code was "' || $err:code || '". Error message was "' || $err:description || '".') }
return (
for $item in $items
return
if(exists($callbackFunc)) then $callbackFunc($node, map:new(($model, map:entry($to, $item))))
else
element { node-name($node) } {
$node/@*,
$app-shared:templates-process($node/node(), map:new(($model, map:entry($to, $item))))
: Processes the node only if some $key exists in $model and its value is *not* the empty sequence, an empty string or false()
: @param $key the key to look for in the current $model. Multiple keys must be separated by whitespace only
: @param $wrap whether to include the current node in the output (defaults to 'yes')
: @param $or whether to search for with an logical OR when mulitple keys are given (defaults to 'yes')
: @author Peter Stadler
:)
declare
%templates:default("wrap", "yes")
%templates:default("or", "yes")
function app-shared:if-exists($node as node(), $model as map(*), $key as xs:string, $wrap as xs:string, $or as xs:string) as node()* {
let $thisOr := $or = ('yes', 'true')
let $tokens := tokenize($key, '\s+')
let $output := function() {
if($wrap = 'yes') then
element {node-name($node)} {
$node/@*,
else $app-shared:templates-process($node/node(), $model)
}
return
if($thisOr) then
try {
if(some $token in $tokens satisfies not($model($token) castable as xs:string and replace(string($model($token)), 'false', '') = '')) then $output()
else ()
}
catch * { $output() }
else
try {
if(every $token in $tokens satisfies not($model($token) castable as xs:string and replace(string($model($token)), 'false', '') = '')) then $output()
else ()
}
catch * { () }
};
(:~
: Processes the node only if some $key (value) *not* exists in $model
:
: @author Peter Stadler
:)
declare function app-shared:if-not-exists($node as node(), $model as map(*), $key as xs:string) as node()? {
if(count($model($key)) eq 0) then
element {node-name($node)} {
$node/@*,
}
else ()
};
(:~
: Processes the node only if some $key matches $value in $model
:
: @author Peter Stadler
:)
declare
%templates:default("wrap", "yes")
function app-shared:if-matches($node as node(), $model as map(*), $key as xs:string, $value as xs:string, $wrap as xs:string) as item()* {
if($model($key) castable as xs:string and string($model($key)) = tokenize($value, '\s+')) then
if($wrap = 'yes') then
element {node-name($node)} {
$node/@*,
else $app-shared:templates-process($node/node(), $model)
else ()
};
(:~
: Processes the node only if some $key *not* matches $value in $model
:
: @param $node the processed $node from the html template (a default param from the templating module)
: @param $model a map (a default param from the templating module)
: @param $key the key in $Model to look for
: @param $value the value of $key to match
: @param $wrap whether to copy the node $node to the output or just process the child nodes of $node
: @author Peter Stadler
:)
declare
%templates:default("wrap", "yes")
function app-shared:if-not-matches($node as node(), $model as map(*), $key as xs:string, $value as xs:string, $wrap as xs:string) as item()* {
if($model($key) castable as xs:string and string($model($key)) = tokenize($value, '\s+')) then ()
else if($wrap = 'yes') then
element {node-name($node)} {
$node/@*,
else $app-shared:templates-process($node/node(), $model)
};
declare function app-shared:order-list-items($node as node(), $model as map(*)) as element() {
element {node-name($node)} {
$node/@*,
for $child in $node/node()
let $childProcessed := $app-shared:templates-process($child, $model)
order by str:normalize-space($childProcessed)
return $childProcessed
}
};
(:~
: Outputs the raw value of $key, e.g. some HTML fragment
: that's not being wrapped with the $node element but replaces it.
~:)
declare function app-shared:output($node as node(), $model as map(*), $key as xs:string) as item()* {
$model($key)
};