25173 2014-03-27 13:11:50 +0000 Test whether a streaming document is available through fn:streaming-document-available() 2014-05-23 16:33:51 +0000 1 1 1 Unclassified XPath / XQuery / XSLT XSLT 3.0 Last Call drafts PC Windows NT CLOSED FIXED P2 enhancement --- 25174 1 abel.braaksma mike public-qt-comments oldest_to_newest 102999 0 abel.braaksma 2014-03-27 13:11:50 +0000 During the telcon of 13 March 2014, during the discussion about xsl:try and streaming, one suggestion that was made in addition to solving the xsl:try buffering issue, was to be able to query whether a streaming document is available or not. If we decide to introduce such a function, it can never be a stable function, because streaming documents are not stable upon multiple invocations. However, we can define such a function such that it must attempt to read up to the start of the root note and buffer this for a next invocation of the same URI. Example: <xsl:stream href="{ if(streaming-document-available($x)) then $x else $y}"> .... </xsl:stream> 103001 1 abel.braaksma 2014-03-27 13:13:47 +0000 Related: bug 25174. 106056 2 abel.braaksma 2014-05-15 17:39:15 +0000 During the telcon of 15 May 2014 this bugreport was discussed and the WG requested what semantics the new function should have. I propose to have it have the same semantics we currently use for reading a streamed document: we currently say that a streamed document must buffer the part up until the root element, and that the DTD, PI's and comments prior to the root element must be buffered. I think it makes sense to define it in terms of existing functionality, similarly to the way the XPath function fn:doc-available is defined: Summary The function returns true if a streaming document is available. Signature fn:streaming-document-available($uri as xs:string?) as xs:boolean Properties This function is [non-deterministic], [context-dependent] and [focus-independent], it depends on the static base uri. Rules If $uri is the empty sequence, this function returns false. If the following construct returns true, this function returns true: <xsl:stream href="{$arg}"> <xsl:value-of select="has-children(root())" /> </xsl:stream> Error conditions (should we raise FODC0005 if the uri is not well-formed?) Otherwise, this function returns false. Notes If this function returns true, implementers are encouraged to buffer the result of reading up until the root element so that an <xsl:stream> instruction with the same URI will succeed, even in scenario's where reading a streaming document is forward-only. However, this behavior is not guaranteed for the same reasons multiple invocations of <xsl:stream> on the same URI are not guaranteed deterministic. This means in practice that this function returns a positive hint that a document is or is not available, but subsequent invocations using <xsl:stream> with the same URI may still fail. 106136 3 mike 2014-05-16 07:25:38 +0000 OK in principle, but I think my preference would be (a) name the function stream-available() (b) define it along the following lines: the function returns true if and only if all the following conditions are satisfied: * The URI is valid, * a resource with this URI can be retrieved * the initial bytes of the resource can be read and decoded as text according to the rules used by an XML processor * the resulting sequence of characters starts with a string that matches the grammar: prolog (EmptyElemTag | STag ) as defined in the XML Recommendation * no implementation-dependent errors, such as would cause the xsl:stream instruction to fail, are detected during the process of opening and parsing the initial content of the stream 106637 4 abel.braaksma 2014-05-22 11:28:16 +0000 I just checked the XML grammar to be sure I understand it correctly: Prolog: xml decl and/or dtd and/or SI/comment/whitespace STag: start tag of element EmptyElemTag: empty element tag so I think this is the same as matching has-children(root()), except explained in XML grammar and without the potential confusion about consuming the input to process the xpath instruction. I am unsure about your last paragraph, what implementation dependent errors could raise that allow to read to STag but would still throw? > * The URI is valid, while I think this is preferable, do note that it is a deviation from the semantics of fn:doc-available(), which throws here. 106676 5 mike 2014-05-22 22:14:55 +0000 The proposal in comment 3 was accepted today. 106722 6 mike 2014-05-23 16:33:51 +0000 Applied to spec.