[mod] base-uri handling

Author: apb2006

CHANGELOG.md

@@ -1,3 +1,10 @@
+# 0.1.3 (2024-02-10)
+* change status text order
+* improve base-uri handling
+* add `.xqbk` as prefered file extension. 
+# 0.1.2 (2024-01-22)
+* set base-uri
+* statusbar text
 # 0.1.1 (2024-01-10)
 * Add configuration and statusbar
 # 0.0.18

README.md

@@ -11,8 +11,9 @@ Settings
 ### create a notebook
 ### add XQuery cells
 Adding a code cell defaults to type `xquery`. `Javascript` cells are also supported.
-### prolog cells
+### header cells
 Before executing a XQuery cell, preceding XQuery cells are examined for content starting with '(:<:)' The first such cell, if any, found searching towards the first cell is prefixed to the current cell before execution.
+If no `declare base-uri` is present in the header then the notebook url is prepended to the code.
 
 ## Notes
 

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "quobook",
-  "displayName": "Quodatum: XQuery notebooks",
-  "version": "0.1.1",
+  "displayName": "Quodatum: XQuery notebooks for BaseX",
+  "version": "0.1.3",
   "description": "Notebook supporting XQuery cells. The XQuery cells are evaluated via a socket connection to a BaseX server.",
   "preview": true,
   "publisher": "quodatum",
@@ -101,6 +101,9 @@
         "type": "quobook",
         "displayName": "XQuery Notebook",
         "selector": [
+          {
+            "filenamePattern": "*.xqbk"
+          },
           {
             "filenamePattern": "*.xq-notebook"
           }

package.json

@@ -0,0 +1 @@
+{"cells":[{"kind":2,"language":"xquery","value":"static-base-uri()"}]}

samples/base-uri.xqbk

@@ -0,0 +1 @@
+{"cells":[{"kind":2,"language":"xquery","value":"let $cells:=json:doc(\"C:\\Users\\mrwhe\\git\\quodatum\\xquery-notebook\\samples\\test.xq-notebook\",\r\nmap{\"format\":\"xquery\"})?cells=>array:flatten()\r\n\r\nreturn $cells[?language=\"xquery\"]"},{"kind":2,"language":"xquery","value":""}]}

samples/book-to-bxs.xq

@@ -1,16 +1,23 @@
-import { match } from 'assert';
-import * as vscode from 'vscode';
+
 import { NotebookCell, NotebookCellKind } from 'vscode';
 
-//   1st XQuery cell with special marker
-export function prologCell(cell: NotebookCell) :string {
-    for (const c of cell.notebook.getCells()) {
-        if (c.index !== cell.index
-            && NotebookCellKind.Code === c.kind
-            && "xquery" === c.document.languageId) {
-            const line=  c.document.lineAt(0).text;
-            if(line.startsWith("(:<:)"))  return c.document.getText();
-        }
+//   1st XQuery cell before with special marker
+export function findHeader(cell: NotebookCell): string | undefined {
+    let ci = cell.index;
+    let header: string | undefined;
+    do {
+        const c = cell.notebook.cellAt(ci--);
+        header = getHeader(c);
+        if (header) return header;
+    }
+
+    while (ci > 0);
+}
+// text of cell if "header" else undefined 
+function getHeader(cell: NotebookCell): string | undefined {
+    if (NotebookCellKind.Code === cell.kind
+        && "xquery" === cell.document.languageId) {
+        const line = cell.document.lineAt(0).text;
+        if (line.startsWith("(:<:)")) return cell.document.getText();
     }
-    return "";
 }

samples/export.xq-notebook

@@ -49,6 +49,6 @@ export class Configuration {
          workspace.getConfiguration(ExtensionTopLevelSection).update(section,value);
     }
     static get summary():string{
-        return `${Configuration.hostname}:${Configuration.port}@${Configuration.user}`;
+        return `${Configuration.user}@${Configuration.hostname}:${Configuration.port}`;
     }
 }

src/common/cell.ts

@@ -1,6 +1,6 @@
 import * as vscode from 'vscode';
 import * as cellprovider from './languages/cellprovider';
-import { prologCell } from './common';
+import { findHeader } from './common';
 
 function output(execution: vscode.NotebookCellExecution, items: any[]) {
     execution.replaceOutput([new vscode.NotebookCellOutput(items)]);
@@ -45,14 +45,15 @@ export class XQueryKernel {
         execution.start(Date.now());
 
         try {
-            const code =getCode(cell);
+            const code = getCode(cell);
             const result: string[] = await provider.eval(code);
             // eslint-disable-next-line prefer-const
             let text = asHtml(result);
             /*  result.forEach(element => { text+=element; }); */
             output(execution, [
-                vscode.NotebookCellOutputItem.text(text, 'text/html'),
-                vscode.NotebookCellOutputItem.json(result)]);
+                vscode.NotebookCellOutputItem.json(result)
+                , vscode.NotebookCellOutputItem.text(text, 'text/html')
+            ]);
 
             execution.end(true, Date.now());
         } catch (err: any) {
@@ -65,10 +66,17 @@ export class XQueryKernel {
 }
 
 function getCode(cell: vscode.NotebookCell): string {
+    const base = `declare base-uri "${cell.document.fileName}";`;
+    const cellText = cell.document.getText();
+    const header = findHeader(cell);
+    if (header) {
+        const hasBase = header.includes('declare base-uri ');
+        return (hasBase ? "" : base) + header + cellText;
+    } else {
+        const hasBase = cellText.includes('declare base-uri ');
+        return (hasBase ? "" : base) + cellText; + cellText;
+    }
 
-    const code = prologCell(cell)+ cell.document.getText();
-
-    return code;
 }
 
 function formatResult(item: string): string {