Initial work for peek for objects

Signed-off-by: worksofliam <[email protected]>

Author: worksofliam

src/database/schemas.ts

@@ -1,4 +1,5 @@
 
+import { spec } from "node:test/reporters";
 import { getInstance } from "../base";
 
 import { JobManager } from "../config";
@@ -15,6 +16,22 @@ const typeMap = {
 
 export const AllSQLTypes: SQLType[] = ["tables", "views", "aliases", "constraints", "functions", "variables", "indexes", "procedures", "sequences", "packages", "triggers", "types", "logicals"];
 
+export const InternalTypes: {[t: string]: string} = {
+  "tables": `table`,
+  "views": `view`,
+  "aliases": `alias`,
+  "constraints": `constraint`,
+  "functions": `function`,
+  "variables": `variable`,
+  "indexes": `index`,
+  "procedures": `procedure`,
+  "sequences": `sequence`,
+  "packages": `package`,
+  "triggers": `trigger`,
+  "types": `type`,
+  "logicals": `logical`
+}
+
 export const SQL_ESCAPE_CHAR = `\\`;
 
 type BasicColumnType = string|number;
@@ -211,7 +228,7 @@ export default class Schemas {
         schema: object.BASE_SCHEMA || undefined,
         name: object.BASE_OBJ || undefined
       }
-    }));
+    } as BasicSQLObject));
   }
 
   /**

src/language/providers/index.ts

@@ -2,6 +2,7 @@ import { completionProvider } from "./completionProvider";
 import { formatProvider } from "./formatProvider";
 import { hoverProvider, openProvider } from "./hoverProvider";
 import { signatureProvider } from "./parameterProvider";
+import { peekProvider } from "./peekProvider";
 
 export function languageInit() {
   let functionality = [];
@@ -11,7 +12,8 @@ export function languageInit() {
     formatProvider,
     signatureProvider,
     hoverProvider,
-    openProvider
+    openProvider,
+    peekProvider
   );
 
   return functionality;

src/language/providers/peekProvider.ts

@@ -0,0 +1,73 @@
+import { env, Hover, languages, MarkdownString, workspace } from "vscode";
+import { getSqlDocument } from "./logic/parse";
+import { DbCache, LookupResult, RoutineDetail } from "./logic/cache";
+import { JobManager } from "../../config";
+import Statement from "../../database/statement";
+import { getParmAttributes, prepareParamType } from "./logic/completion";
+import { StatementType } from "../sql/types";
+import { remoteAssistIsEnabled } from "./logic/available";
+import { getPositionData } from "./logic/callable";
+import { CallableSignature } from "../../database/callable";
+import Schemas, { AllSQLTypes, InternalTypes, SQLType } from "../../database/schemas";
+
+const standardObjects: SQLType[] = AllSQLTypes.filter(type => ![`functions`, `procedures`].includes(type));
+
+export const peekProvider = languages.registerDefinitionProvider({ language: `sql` }, {
+  async provideDefinition(document, position, token) {
+    if (!remoteAssistIsEnabled()) return;
+    console.log(`peekProvider`);
+
+    const defaultSchema = getDefaultSchema();
+    const sqlDoc = getSqlDocument(document);
+    const offset = document.offsetAt(position);
+
+    const tokAt = sqlDoc.getTokenByOffset(offset);
+    const statementAt = sqlDoc.getStatementByOffset(offset);
+
+    if (statementAt) {
+      const refs = statementAt.getObjectReferences();
+      const possibleNames = refs.map(ref => ref.object.name).filter(name => name);
+
+      const ref = refs.find(ref => ref.tokens[0].range.start && offset <= ref.tokens[ref.tokens.length - 1].range.end);
+
+      if (ref) {
+        const name = Statement.noQuotes(Statement.delimName(ref.object.name, true));
+        const schema = Statement.noQuotes(Statement.delimName(ref.object.schema || defaultSchema, true));
+
+        let types: SQLType[] = standardObjects;
+
+        if (ref.isUDTF) {
+          types = [`functions`];
+        } else if (statementAt.type === StatementType.Call) {
+          types = [`procedures`];
+        }
+
+        const possibleObjects = await Schemas.getObjects(schema, types, {filter: name});
+
+        if (possibleObjects.length) {
+          const lines: string[] = [];
+          for (const obj of possibleObjects) {
+            const type = InternalTypes[obj.type];
+            if (type) {
+              const contents = await Schemas.generateSQL(obj.schema, obj.name, type.toUpperCase());
+              lines.push(contents, ``, ``);
+            }
+          }
+
+          const document = await workspace.openTextDocument({ content: lines.join(`\n`), language: `sql` });
+
+          return {
+            uri: document.uri,
+            range: document.lineAt(0).range,
+          };
+        }
+
+      }
+    }
+  }
+});
+
+const getDefaultSchema = (): string => {
+  const currentJob = JobManager.getSelection();
+  return currentJob && currentJob.job.options.libraries[0] ? currentJob.job.options.libraries[0] : `QGPL`;
+}

src/views/schemaBrowser/index.ts

@@ -1,7 +1,7 @@
 
 import { ThemeIcon, TreeItem } from "vscode"
 import * as vscode from "vscode"
-import Schemas, { AllSQLTypes, SQL_ESCAPE_CHAR, SQLType } from "../../database/schemas";
+import Schemas, { AllSQLTypes, InternalTypes, SQL_ESCAPE_CHAR, SQLType } from "../../database/schemas";
 import Table from "../../database/table";
 import { getInstance, loadBase } from "../../base";
 
@@ -12,22 +12,6 @@ import Statement from "../../database/statement";
 import { copyUI } from "./copyUI";
 import { getAdvisedIndexesStatement, getIndexesStatement, getMTIStatement } from "./statements";
 
-const viewItem = {
-  "tables": `table`,
-  "views": `view`,
-  "aliases": `alias`,
-  "constraints": `constraint`,
-  "functions": `function`,
-  "variables": `variable`,
-  "indexes": `index`,
-  "procedures": `procedure`,
-  "sequences": `sequence`,
-  "packages": `package`,
-  "triggers": `trigger`,
-  "types": `type`,
-  "logicals": `logical`
-}
-
 const itemIcons = {
   "table": `split-horizontal`,
   "procedure": `run`,
@@ -552,7 +536,7 @@ class SQLObject extends vscode.TreeItem {
   }
 
   constructor(item: BasicSQLObject) {
-    const type = viewItem[item.type];
+    const type = InternalTypes[item.type];
     super(Statement.prettyName(item.name), Types[type] ? vscode.TreeItemCollapsibleState.Collapsed : vscode.TreeItemCollapsibleState.None);
 
     this.contextValue = type;