Programmatically extracting function signatures

On 17 September 2018 at 16:43, Bridger Dyson-Smith <bdysonsmith at gmail.com> wrote: > Hi all - > > I was curious if there was a way to extract function signatures from > BaseX. I'm currently reading through the (excellent) wiki but was curious > if there was a more automated process I might be able to use. I've been > trying to think of something clever with function-lookup, but I can't seem > to make it dynamic based on module namespace; e.g. > > ``` > for $fun in function-lookup(xs:QName("archive:delete"), 1) > return > $fun > ``` > > I may just grab the wiki and parse it :), but I'm also interested in > changes between versions of the processor. > > Any thoughts or suggestions would be greatly appreciated! > Best, > Bridger >

On 17 September 2018 at 17:28, Bridger Dyson-Smith <bdysonsmith at gmail.com> wrote: > Andy - > thank you for that suggestion! > > On Mon, Sep 17, 2018 at 12:13 PM Andy Bunce <bunce.andy at gmail.com> wrote: > >> If you look in lib/ folder the file modules.zip contains the BaseX >> modules as .xqm stub files with functions marked as external. >> The entry for archive:delete is shown below. At one point I am sure these >> *.xqm could be parsed by functions like inspect:module and inspect:xqdoc >> Currently they raise errors like [XQST0045] Function '...' is in reserved >> namespace. >> >> I believe were generated by scraping the wiki :) >> >> However: >> * some of these are a little out of date (at least in 9.02) >> * modules.zip is not present in recent 9.1 betas >> >> This is a shame as I hoped to use to one day use these in some kind of >> IDE for content assist. >> (although I have hoped that for a long time without actually doing it.) >> >> This is exactly the use case I have. I'm attempting to help work on an > IntelliJ plugin that will leverage the signatures (for things I don't quite > understand :). > > Regards >> /Andy >> >> (:~ >> : Deletes entries from an <code>$archive</code> . >> : The format of <code>$entries</code> is the same as for <a >> href="#archive:create">archive:create</a> . >> : >> : @error bxerr:ARCH0005 the entries of the given archive cannot be >> modified. >> : @error bxerr:ARCH9999 archive creation failed for some other reason. >> :) >> declare function archive:delete($archive as xs:base64Binary, $entries as >> item()*) as xs:base64Binary external; >> >> Thanks again for the suggestion. > Best, > Bridger > > >> On 17 September 2018 at 16:43, Bridger Dyson-Smith <bdysonsmith at gmail.com >> > wrote: >> >>> Hi all - >>> >>> I was curious if there was a way to extract function signatures from >>> BaseX. I'm currently reading through the (excellent) wiki but was curious >>> if there was a more automated process I might be able to use. I've been >>> trying to think of something clever with function-lookup, but I can't seem >>> to make it dynamic based on module namespace; e.g. >>> >>> ``` >>> for $fun in function-lookup(xs:QName("archive:delete"), 1) >>> return >>> $fun >>> ``` >>> >>> I may just grab the wiki and parse it :), but I'm also interested in >>> changes between versions of the processor. >>> >>> Any thoughts or suggestions would be greatly appreciated! >>> Best, >>> Bridger >>> >> >>

On Mon, Sep 17, 2018 at 12:13 PM Andy Bunce <bunce.andy at gmail.com> wrote: > If you look in lib/ folder the file modules.zip contains the BaseX modules > as .xqm stub files with functions marked as external. > The entry for archive:delete is shown below. At one point I am sure these > *.xqm could be parsed by functions like inspect:module and inspect:xqdoc > Currently they raise errors like [XQST0045] Function '...' is in reserved > namespace. > > I believe were generated by scraping the wiki :) > > However: > * some of these are a little out of date (at least in 9.02) > * modules.zip is not present in recent 9.1 betas > > This is a shame as I hoped to use to one day use these in some kind of IDE > for content assist. > (although I have hoped that for a long time without actually doing it.) > > This is exactly the use case I have. I'm attempting to help work on an

> /Andy > > (:~ > : Deletes entries from an <code>$archive</code> . > : The format of <code>$entries</code> is the same as for <a > href="#archive:create">archive:create</a> . > : > : @error bxerr:ARCH0005 the entries of the given archive cannot be > modified. > : @error bxerr:ARCH9999 archive creation failed for some other reason. > :) > declare function archive:delete($archive as xs:base64Binary, $entries as > item()*) as xs:base64Binary external; > > Thanks again for the suggestion.

> On 17 September 2018 at 16:43, Bridger Dyson-Smith <bdysonsmith at gmail.com> > wrote: > >> Hi all - >> >> I was curious if there was a way to extract function signatures from >> BaseX. I'm currently reading through the (excellent) wiki but was curious >> if there was a more automated process I might be able to use. I've been >> trying to think of something clever with function-lookup, but I can't seem >> to make it dynamic based on module namespace; e.g. >> >> ``` >> for $fun in function-lookup(xs:QName("archive:delete"), 1) >> return >> $fun >> ``` >> >> I may just grab the wiki and parse it :), but I'm also interested in >> changes between versions of the processor. >> >> Any thoughts or suggestions would be greatly appreciated! >> Best, >> Bridger >> > >

On Mon, Sep 17, 2018 at 6:23 PM Bridger Dyson-Smith <bdysonsmith at gmail.com> wrote: > > Andy - > thank you for that suggestion! > > On Mon, Sep 17, 2018 at 12:13 PM Andy Bunce <bunce.andy at gmail.com> wrote: >> >> If you look in lib/ folder the file modules.zip contains the BaseX modules as .xqm stub files with functions marked as external. >> The entry for archive:delete is shown below. At one point I am sure these *.xqm could be parsed by functions like inspect:module and inspect:xqdoc >> Currently they raise errors like [XQST0045] Function '...' is in reserved namespace. >> >> I believe were generated by scraping the wiki :) >> >> However: >> * some of these are a little out of date (at least in 9.02) >> * modules.zip is not present in recent 9.1 betas >> >> This is a shame as I hoped to use to one day use these in some kind of IDE for content assist. >> (although I have hoped that for a long time without actually doing it.) >> > This is exactly the use case I have. I'm attempting to help work on an IntelliJ plugin that will leverage the signatures (for things I don't quite understand :). > >> Regards >> /Andy >> >> (:~ >> : Deletes entries from an <code>$archive</code> . >> : The format of <code>$entries</code> is the same as for <a href="#archive:create">archive:create</a> . >> : >> : @error bxerr:ARCH0005 the entries of the given archive cannot be modified. >> : @error bxerr:ARCH9999 archive creation failed for some other reason. >> :) >> declare function archive:delete($archive as xs:base64Binary, $entries as item()*) as xs:base64Binary external; >> > Thanks again for the suggestion. > Best, > Bridger > >> >> On 17 September 2018 at 16:43, Bridger Dyson-Smith <bdysonsmith at gmail.com> wrote: >>> >>> Hi all - >>> >>> I was curious if there was a way to extract function signatures from BaseX. I'm currently reading through the (excellent) wiki but was curious if there was a more automated process I might be able to use. I've been trying to think of something clever with function-lookup, but I can't seem to make it dynamic based on module namespace; e.g. >>> >>> ``` >>> for $fun in function-lookup(xs:QName("archive:delete"), 1) >>> return >>> $fun >>> ``` >>> >>> I may just grab the wiki and parse it :), but I'm also interested in changes between versions of the processor. >>> >>> Any thoughts or suggestions would be greatly appreciated! >>> Best, >>> Bridger >> >>

On Mon, Sep 17, 2018 at 5:38 PM Bridger Dyson-Smith <bdysonsmith at gmail.com> wrote: > > Hi all - > > I was curious if there was a way to extract function signatures from BaseX. I'm currently reading through the (excellent) wiki but was curious if there was a more automated process I might be able to use. I've been trying to think of something clever with function-lookup, but I can't seem to make it dynamic based on module namespace; e.g. > > ``` > for $fun in function-lookup(xs:QName("archive:delete"), 1) > return > $fun > ``` > > I may just grab the wiki and parse it :), but I'm also interested in changes between versions of the processor. > > Any thoughts or suggestions would be greatly appreciated! > Best, > Bridger

On Tue, Oct 30, 2018 at 9:13 AM Christian Grün <christian.gruen at gmail.com> wrote: > Hi Bridger, > > I am glad to report I have created new stub files for the BaseX XQuery > Modules [1]. They’ll now be included in the official releases again > [2]. I have also uploaded the script that I wrote for generating the > xqdoc output [3]. It’s far from perfect, but definitely more complete > than the old version. If you encounter any errors, please don’t > hesitate to tell me. > > Could you give us a little update on your contribution to the IntelliJ > XQuery plugin? > > Cheers, > Christian > > [1] https://github.com/BaseXdb/basex/issues/1623 > [2] http://files.basex.org/releases/latest/ > [3] https://github.com/BaseXdb/basex-dist/blob/master/wiki2xqdoc.xq > > > > On Mon, Sep 17, 2018 at 5:38 PM Bridger Dyson-Smith > <bdysonsmith at gmail.com> wrote: > > > > Hi all - > > > > I was curious if there was a way to extract function signatures from > BaseX. I'm currently reading through the (excellent) wiki but was curious > if there was a more automated process I might be able to use. I've been > trying to think of something clever with function-lookup, but I can't seem > to make it dynamic based on module namespace; e.g. > > > > ``` > > for $fun in function-lookup(xs:QName("archive:delete"), 1) > > return > > $fun > > ``` > > > > I may just grab the wiki and parse it :), but I'm also interested in > changes between versions of the processor. > > > > Any thoughts or suggestions would be greatly appreciated! > > Best, > > Bridger >

On Wed, 7 Nov 2018 at 01:27, Bridger Dyson-Smith <bdysonsmith at gmail.com> wrote: > Hi Christian - > > thank you for your work on the xqdoc files (and the link to the xquery > used for generating them)! > > The current state of XQuery plugins for the JetBrains/IntelliJ IDEs has > changed a bit since I added the IDEA documentation to the wiki. Grzegorz > Ligas' XQuery Support plugin has been forked by the talented developers at > OverStory, with lots of MarkLogic-specific features added. Reece Dunn also > has been working on an XQuery plugin that takes a slightly different > approach: rather than focusing on one implementation, Reece is working on a > plugin that provides broader language support. >

The very minor work that I've done has been for Reece - I'm (slowly) adding > implementation builtin function signatures that will be used by his plugin > to provide improved static analysis. >

> XQuery/JetBrains plugins. > Best, > Bridger > > > > On Tue, Oct 30, 2018 at 9:13 AM Christian Grün <christian.gruen at gmail.com> > wrote: > >> Hi Bridger, >> >> I am glad to report I have created new stub files for the BaseX XQuery >> Modules [1]. They’ll now be included in the official releases again >> [2]. I have also uploaded the script that I wrote for generating the >> xqdoc output [3]. It’s far from perfect, but definitely more complete >> than the old version. If you encounter any errors, please don’t >> hesitate to tell me. >> >> Could you give us a little update on your contribution to the IntelliJ >> XQuery plugin? >> >> Cheers, >> Christian >> >> [1] https://github.com/BaseXdb/basex/issues/1623 >> [2] http://files.basex.org/releases/latest/ >> [3] https://github.com/BaseXdb/basex-dist/blob/master/wiki2xqdoc.xq >> >> >> >> On Mon, Sep 17, 2018 at 5:38 PM Bridger Dyson-Smith >> <bdysonsmith at gmail.com> wrote: >> > >> > Hi all - >> > >> > I was curious if there was a way to extract function signatures from >> BaseX. I'm currently reading through the (excellent) wiki but was curious >> if there was a more automated process I might be able to use. I've been >> trying to think of something clever with function-lookup, but I can't seem >> to make it dynamic based on module namespace; e.g. >> > >> > ``` >> > for $fun in function-lookup(xs:QName("archive:delete"), 1) >> > return >> > $fun >> > ``` >> > >> > I may just grab the wiki and parse it :), but I'm also interested in >> changes between versions of the processor. >> > >> > Any thoughts or suggestions would be greatly appreciated! >> > Best, >> > Bridger >> >