Refactor and fix error highlighting

Author: Varagos

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+  "cSpell.words": ["ANTLR"]
+}

server/package.json

@@ -9,7 +9,7 @@
   },
   "type": "module",
   "scripts": {
-    "generate-core-dts": "rimraf src/parser/core/grammar/Bitloops*.ts && node --experimental-vm-modules node_modules/typescript/bin/tsc src/parser/core/grammar/Bitloops*js --declaration --emitDeclarationOnly --allowJs --outDir src/parser/core/grammar && node_modules/prettier/bin-prettier.js --config .prettierrc --write src/parser/core/grammar/*.d.ts",
+    "generate-core-dts": "rimraf src/parser/grammar/Bitloops*.ts && node --experimental-vm-modules node_modules/typescript/bin/tsc src/parser/grammar/Bitloops*js --declaration --emitDeclarationOnly --allowJs --outDir src/parser/grammar && node_modules/prettier/bin-prettier.js --config .prettierrc --write src/parser/grammar/*.d.ts",
     "ant": "yarn antlr4 -listener -visitor -Dlanguage=JavaScript src/parser/grammar/BitloopsLexer.g4 && yarn antlr4 -listener -visitor -Dlanguage=JavaScript src/parser/grammar/BitloopsParser.g4 && yarn generate-core-dts",
     "antlr4": "java -jar /usr/local/lib/antlr-4.10.1-complete.jar"
   },

server/src/analyzer.ts

@@ -6,6 +6,9 @@ import { components } from './types/keywords.js';
 import { getMatchRange } from './utils/regex.js';
 
 export interface IAnalyzer {
+  /**
+   * It analyzes the document and returns a list of diagnostics.
+   */
   analyze(document: TextDocument): Diagnostic[];
 }
 
@@ -29,7 +32,11 @@ export class RegexAnalyzer implements IAnalyzer {
     const pattern = new RegExp(`(${componentUnion})(?!\\s*\\w)`);
     const match = pattern.exec(document.getText());
     if (match) {
-      const useCaseSyntacError = DiagnosticFactory.create(1, getMatchRange(document, match), EErrors.NoIdentifier);
+      const useCaseSyntacError = DiagnosticFactory.create(
+        1,
+        getMatchRange(document, match),
+        EErrors.NoIdentifier,
+      );
       // console.log(useCaseSyntacError);
       return [useCaseSyntacError];
     }

server/src/completion.ts

@@ -1,16 +1,22 @@
-import { CompletionItem, CompletionItemKind, TextDocumentPositionParams } from 'vscode-languageserver/node.js';
+import {
+  CompletionItem,
+  CompletionItemKind,
+  TextDocumentPositionParams,
+} from 'vscode-languageserver/node.js';
 import { documentation } from './information/documentation.js';
 import { details } from './information/details.js';
 import { components } from './types/keywords.js';
 
-export class BitloopsCompletionItemProvider {
-  // constructor(connection: Connection) {
-  //   super();
-  // }
+export class CompletionItemProvider {
   public static onCompletion(_textDocumentPosition: TextDocumentPositionParams) {
-    const keywords = BitloopsCompletionItemProvider.completeKeyword();
-    return keywords;
+    const keywordsList = Object.keys(components);
+    return keywordsList.map((symbol) => ({
+      label: symbol,
+      kind: CompletionItemKind.Keyword,
+      data: 1,
+    }));
   }
+
   public static onCompletionResolve(item: CompletionItem): CompletionItem {
     const label: string = item.label;
     if (documentation[item.label as keyof typeof documentation]) {
@@ -22,15 +28,4 @@ export class BitloopsCompletionItemProvider {
 
     return item;
   }
-
-  private static completeKeyword(): CompletionItem[] {
-    const keywordsList = Object.keys(components);
-    return keywordsList.map((symbol) => {
-      return {
-        label: symbol,
-        kind: CompletionItemKind.Keyword,
-        data: 1,
-      };
-    });
-  }
 }

server/src/diagnostic.ts

@@ -1,18 +1,25 @@
 import { Diagnostic, DiagnosticSeverity, Range, TextDocument } from 'vscode-languageserver/node.js';
 
+export enum LogLevel {
+  Error = 1,
+  Warn = 2,
+  Info = 3,
+  Log = 4,
+}
+
 export class DiagnosticFactory {
   public static create(
-    severity: 1 | 2 | 3 | 4,
+    severity: LogLevel,
     range: Range,
     message: string,
-    addRelatedInformation?: string[]
+    addRelatedInformation?: string[],
   ): Diagnostic {
     message = this.prefixMessage(message, severity);
     const diagnostic: Diagnostic = {
-      severity: severity,
-      range: range,
-      message: message,
-      source: 'ex',
+      severity,
+      range,
+      message,
+      source: 'bl',
     };
     if (addRelatedInformation) {
       diagnostic.relatedInformation = [];
@@ -29,7 +36,7 @@ export class DiagnosticFactory {
     }
     return diagnostic;
   }
-  public static prefixMessage(message: string, severity: 1 | 2 | 3 | 4) {
+  public static prefixMessage(message: string, severity: LogLevel) {
     switch (severity) {
       case 1:
         return `Error: ${message}`;

server/src/index.ts

@@ -1,63 +1,3 @@
-import {
-  createConnection,
-  DidChangeConfigurationNotification,
-  InitializeParams,
-  InitializeResult,
-  ProposedFeatures,
-  TextDocumentSyncKind,
-} from 'vscode-languageserver/node.js';
-import { BitloopsServer } from './server.js';
-let hasConfigurationCapability = false;
-let hasWorkspaceFolderCapability = false;
-let hasDiagnosticRelatedInformationCapability = false;
+import { LspConnection } from './lsp-connection.js';
 
-const connection = createConnection(ProposedFeatures.all);
-connection.onInitialize(onInitialize);
-connection.onInitialized(onInitialized);
-const server = new BitloopsServer(
-  connection,
-  hasConfigurationCapability,
-  hasWorkspaceFolderCapability,
-  hasDiagnosticRelatedInformationCapability
-);
-server.register();
-
-function onInitialize(params: InitializeParams): InitializeResult {
-  const capabilities = params.capabilities;
-  hasConfigurationCapability = !!(capabilities.workspace && !!capabilities.workspace.configuration);
-  hasWorkspaceFolderCapability = !!(capabilities.workspace && !!capabilities.workspace.workspaceFolders);
-  hasDiagnosticRelatedInformationCapability = !!(
-    capabilities.textDocument &&
-    capabilities.textDocument.publishDiagnostics &&
-    capabilities.textDocument.publishDiagnostics.relatedInformation
-  );
-
-  const result: InitializeResult = {
-    capabilities: {
-      textDocumentSync: TextDocumentSyncKind.Incremental,
-      // Tell the client that this server supports code completion.
-      completionProvider: {
-        resolveProvider: true,
-      },
-    },
-  };
-  if (hasWorkspaceFolderCapability) {
-    result.capabilities.workspace = {
-      workspaceFolders: {
-        supported: true,
-      },
-    };
-  }
-  return result;
-}
-function onInitialized() {
-  if (hasConfigurationCapability) {
-    // Register for all configuration changes.
-    connection.client.register(DidChangeConfigurationNotification.type, undefined);
-  }
-  if (hasWorkspaceFolderCapability) {
-    connection.workspace.onDidChangeWorkspaceFolders((_event) => {
-      connection.console.log('Workspace folder change event received.');
-    });
-  }
-}
+new LspConnection().registerLspEvents().listen();

server/src/linter.ts

@@ -0,0 +1,13 @@
+import * as lsp from 'vscode-languageserver';
+
+export interface ILspClient {
+  publishDiagnostics(args: lsp.PublishDiagnosticsParams): void;
+}
+
+export class LspClientImpl implements ILspClient {
+  constructor(protected connection: lsp.Connection) {}
+
+  publishDiagnostics(params: lsp.PublishDiagnosticsParams): void {
+    this.connection.sendDiagnostics(params);
+  }
+}

server/src/lsp-client.ts

@@ -0,0 +1,42 @@
+import {
+  createConnection,
+  TextDocuments,
+  ProposedFeatures,
+  _Connection,
+} from 'vscode-languageserver/node.js';
+
+import { TextDocument } from 'vscode-languageserver-textdocument';
+import { LspClientImpl } from './lsp-client.js';
+import { BitloopsServer } from './server.js';
+
+export class LspConnection {
+  private connection: _Connection;
+  private server: BitloopsServer;
+
+  protected documents: TextDocuments<TextDocument>;
+  constructor() {
+    this.documents = new TextDocuments(TextDocument);
+    this.connection = createConnection(ProposedFeatures.all);
+    const lspClient = new LspClientImpl(this.connection);
+
+    this.server = new BitloopsServer(lspClient, this.connection);
+  }
+
+  public registerLspEvents() {
+    const server = this.server;
+    this.connection.onInitialize(server.onInitialize.bind(server));
+    this.connection.onInitialized(server.onInitialized.bind(server));
+
+    this.documents.onDidClose(server.onDidClose.bind(server));
+    this.documents.onDidChangeContent(server.onDidChangeContent.bind(server));
+    this.connection.onCompletion(server.completion.bind(server));
+    this.connection.onCompletionResolve(server.completionResolve.bind(server));
+    return this;
+  }
+
+  // Listen on the connection
+  public listen() {
+    this.documents.listen(this.connection);
+    this.connection.listen();
+  }
+}

server/src/lsp-connection.ts

@@ -0,0 +1,34 @@
+import antlr from 'antlr4';
+import Recognizer from 'antlr4/Recognizer.js';
+import { DiagnosticFactory } from '../diagnostic.js';
+import { ANTLR4Analyzer } from './index.js';
+// import { ErrorListener } from 'antlr4/error';
+
+export class VerboseListener extends (antlr as any).error.ErrorListener {
+  syntaxError = (
+    _recognizer: Recognizer.default,
+    offendingToken: any,
+    line: number,
+    column: number,
+    msg: string,
+    _e: any,
+  ) => {
+    // const stack: any = recognizer.getTokenErrorDisplay(offendingSymbol);
+    // console.log("rule stack: "+stack);
+    console.log(`line: ${line}:${column}, offendingSymbol : ${offendingToken.text}, msg: ${msg}`);
+    const start = offendingToken.start;
+    const stop = offendingToken.stop;
+    console.log(`start: ${start}, stop: ${stop}`);
+    // let range = new Range(error.line - 1, error.startColumn, error.line - 1, error.endColumn);
+
+    const diagnostic = DiagnosticFactory.create(
+      1,
+      {
+        start,
+        end: stop,
+      },
+      `line: ${line}:${column}, offendingSymbol : ${offendingToken.text}, msg: ${msg}`,
+    );
+    ANTLR4Analyzer.diagnostics.push(diagnostic);
+  };
+}