add custom table editor provider (#12)

clean up and document other table view extension parts

Author: RandomFractals

package.json

@@ -41,6 +41,7 @@
 	],
 	"activationEvents": [
 		"onCommand:tabular.data.viewTable",
+		"onCustomEditor:tabular.data.tableEditor",
 		"onWebviewPanel:tabular.data.tableView"
 	],
 	"main": "./dist/extension.js",
@@ -125,7 +126,7 @@
 		},
 		"customEditors": [
 			{
-				"viewType": "tabular.data.tableView",
+				"viewType": "tabular.data.tableEditor",
 				"displayName": "Table View",
 				"priority": "default",
 				"selector": [

src/extension.ts

@@ -1,37 +1,40 @@
 import {
 	commands,
 	window,
-	workspace,
 	ExtensionContext,
 	Disposable,
 	Uri
 } from 'vscode';
 
+import { TableEditor } from './views/tableEditor';
 import { TableView } from './views/tableView';
 import { TableViewSerializer } from './views/tableViewSerializer';
 import { ViewTypes } from './views/viewTypes';
 
 /**
  * Activates this extension per rules set in package.json.
  * 
- * @param context vscode extension context.
- * @see https://code.visualstudio.com/api/references/activation-events for more info.
+ * @param context Extension context.
+ * 
+ * @see https://code.visualstudio.com/api/references/vscode-api#extensions
+ * @see https://code.visualstudio.com/api/references/activation-events
  */
 export function activate(context: ExtensionContext) {
 
 	console.log('tabular.data.viewer:activate(): activated!');
 
 	// register view table command
-	let viewTableCommand: Disposable = 
+	const viewTableCommand: Disposable = 
 		commands.registerCommand('tabular.data.viewTable', (documentUri: Uri) => {
 			TableView.render(context.extensionUri, documentUri);
 		});
-
 	context.subscriptions.push(viewTableCommand);
 
-	// register table view serializer for restore on vscode restart
-	window.registerWebviewPanelSerializer(ViewTypes.TableView, 
-		new TableViewSerializer(context.extensionUri));
+	// register table view serializer for restore on vscode reload
+	context.subscriptions.push(TableViewSerializer.register(context));
+
+	// register table editor
+	context.subscriptions.push(TableEditor.register(context));
 }
 
 /**

src/views/tableEditor.ts

@@ -0,0 +1,63 @@
+import {
+  window,
+  CancellationToken,
+  CustomTextEditorProvider,
+  Disposable,
+  ExtensionContext,
+  TextDocument,
+  WebviewPanel
+} from 'vscode';
+
+import { TableView } from './tableView';
+import { ViewTypes } from './viewTypes';
+
+/**
+ * Defines custom tabular data text editor provider.
+ * 
+ * @see https://code.visualstudio.com/api/references/vscode-api#CustomTextEditorProvider
+ */
+export class TableEditor implements CustomTextEditorProvider {
+
+  /**
+   * Registers custom Table editor.
+   * 
+   * @see https://code.visualstudio.com/api/references/vscode-api#window.registerCustomEditorProvider
+   * 
+   * @param context Extension context.
+   * @returns Disposable object for this editor.
+   */
+  public static register(context: ExtensionContext): Disposable {
+    return window.registerCustomEditorProvider(
+      ViewTypes.TableEditor, new TableEditor(context), {
+      webviewOptions: {
+        enableFindWidget: true,
+        retainContextWhenHidden: true
+      }
+    });
+  }
+
+  /**
+   * Creates new Table editor instance.
+   * 
+   * @param context Extension context.
+   */
+  constructor(private readonly context: ExtensionContext) {
+  }
+
+  /**
+   * Resolves a custom text eidtor for a given tabular data text document source,
+   * and creates new TableView for that table data display.
+   * 
+   * @param document Text document for the tabular data source to resolve.
+   * @param webviewPanel Webview panel used to display the editor UI for this resource.
+   * @param token A cancellation token that indicates the result is no longer needed.
+   */
+  public async resolveCustomTextEditor(
+    document: TextDocument,
+    webviewPanel: WebviewPanel,
+    token: CancellationToken
+  ): Promise<void> {
+    // create new table view for the given tabular text data document and render it
+    TableView.render(this.context.extensionUri, document.uri, webviewPanel);
+  }
+}

src/views/tableView.ts

@@ -31,7 +31,7 @@ export class TableView {
   private _disposables: Disposable[] = [];
 
   /**
-   * Creates new TableView instance for the initial table data rendering.
+   * Creates new TableView instance for tabular data rendering.
    * 
    * @param webviewPanel Reference to the webview panel.
    * @param extensionUri Extension directory Uri.
@@ -103,7 +103,9 @@ export class TableView {
       },
       { // weview panel options
         enableScripts: true, // enable JavaScript in webview
-        enableCommandUris: true // ???
+        enableCommandUris: true,
+        enableFindWidget: true,
+        retainContextWhenHidden: true
       }
     );
   }
@@ -113,6 +115,7 @@ export class TableView {
    */
   public dispose() {
     TableView.currentView = undefined;
+    TableView._views.delete(this._viewUri.toString());
     this._webviewPanel.dispose();
     while (this._disposables.length) {
       const disposable: Disposable | undefined = this._disposables.pop();

src/views/tableViewSerializer.ts

@@ -1,18 +1,34 @@
 import {
+  window,
+  Disposable,
+  ExtensionContext,
   WebviewPanel,
   WebviewPanelSerializer,
-  Uri,
+  Uri
 } from 'vscode';
 
 import { TableView } from './tableView';
+import { ViewTypes } from './viewTypes';
 
 /**
  * Table webview panel serializer for restoring table views on vscode reload.
  */
 export class TableViewSerializer implements WebviewPanelSerializer {
 
   /**
-   * Creates new webview serializer.
+   * Registers table view serializer.
+   * 
+   * @param context Extension context.
+   * @returns Disposable object for this webview panel serializer.
+   */
+  public static register(context: ExtensionContext): Disposable {
+    return window.registerWebviewPanelSerializer(ViewTypes.TableView,
+      new TableViewSerializer(context.extensionUri));
+  }
+
+  /**
+   * Creates new Table webview serializer.
+   * 
    * @param extensionUri Extension directory Uri.
    */
   constructor(private extensionUri: Uri) {