Replace comment semtoks with unreachable diags

Author: SSlinky

server/src/capabilities/diagnostics.ts

@@ -84,6 +84,15 @@ export class UnexpectedLineEndingDiagnostic extends BaseDiagnostic {
 	}
 }
 
+// test
+export class UnreachableCodeDiagnostic extends BaseDiagnostic {
+	severity = DiagnosticSeverity.Hint;
+	tags = [DiagnosticTag.Unnecessary];
+	constructor(range: Range) {
+		super(range);
+	}
+}
+
 
 export class IgnoredAttributeDiagnostic extends BaseDiagnostic {
 	severity = DiagnosticSeverity.Warning;

server/src/project/document.ts

@@ -153,8 +153,7 @@ export abstract class BaseProjectDocument {
 	languageServerDiagnostics(): DocumentDiagnosticReport {
 		return {
 			kind: DocumentDiagnosticReportKind.Full,
-			items: this.hasDiagnosticElements
-				.map((e) => e.diagnosticCapability.diagnostics).flat(1)
+			items: this.diagnostics
 		};
 	}
 

server/src/project/elements/precompiled.ts

@@ -1,14 +1,13 @@
 // Core
-import { Range, SemanticTokenTypes } from 'vscode-languageserver';
 import { TextDocument } from 'vscode-languageserver-textdocument';
 
 // Antlr
-import { ParserRuleContext } from 'antlr4ng';
 import { CompilerConditionalBlockContext, CompilerDefaultBlockContext, CompilerIfBlockContext } from '../../antlr/out/vbapreParser';
 
 // Project
-import { SemanticTokenCapability } from '../../capabilities/capabilities';
-import { BaseContextSyntaxElement, HasSemanticTokenCapability } from '../elements/base';
+import { DiagnosticCapability } from '../../capabilities/capabilities';
+import { BaseContextSyntaxElement } from '../elements/base';
+import { UnreachableCodeDiagnostic } from '../../capabilities/diagnostics';
 
 
 export class CompilerLogicalBlock extends BaseContextSyntaxElement<CompilerIfBlockContext> {
@@ -29,6 +28,7 @@ export class CompilerLogicalBlock extends BaseContextSyntaxElement<CompilerIfBlo
 				resolved = true;
 				continue;
 			}
+			block.deactivate();
 			this.inactiveBlocks.push(block);
 		}
 	}
@@ -47,31 +47,6 @@ class CompilerConditionBlock extends BaseContextSyntaxElement<CompilerConditiona
 		return this.context.rule.compilerBlockContent()?.getText().split('\n') ?? [];
 	}
 
-	get linesToComments(): GenericCommentElement[] {
-		const rowX = this.context.range.start.line;
-		const rowY = this.context.range.end.line;
-
-		// Iterate the rows -- test what happens when you get to the end of the document.
-		// May require a try catch where the default offset is the character count of the document.
-		const result: GenericCommentElement[] = [];
-		for (let i = rowX; i < rowY; i++) {
-			const posX = this.context.document.offsetAt({ line: i, character: 0 });
-			const posY = this.context.document.offsetAt({ line: i + 1, character: 0 }) - 1;
-
-			const lineRange = Range.create(
-				this.context.document.positionAt(posX),
-				this.context.document.positionAt(posY)
-			);
-			result.push(new GenericCommentElement(
-				this.context.rule,
-				this.context.document,
-				lineRange)
-			);
-		}
-
-		return result;
-	}
-
 	get conditionResult(): boolean {
 		// Default "Else" block is always true.
 		const ctx = this.context.rule;
@@ -90,6 +65,11 @@ class CompilerConditionBlock extends BaseContextSyntaxElement<CompilerConditiona
 		return result;
 	}
 
+	deactivate(): void {
+		this.diagnosticCapability = new DiagnosticCapability(this);
+		this.diagnosticCapability.diagnostics.push(new UnreachableCodeDiagnostic(this.context.range))
+	}
+
 	/** Transpiles a VBA expression into Typescript. */
 	private transpileVbaToTypescript(exp: string): string {
 		// Convert the environment constant to boolean.
@@ -118,14 +98,3 @@ class CompilerConditionBlock extends BaseContextSyntaxElement<CompilerConditiona
 		return result;
 	}
 }
-
-
-export class GenericCommentElement extends BaseContextSyntaxElement<ParserRuleContext> implements HasSemanticTokenCapability {
-	semanticTokenCapability: SemanticTokenCapability;
-
-	constructor(ctx: ParserRuleContext, doc: TextDocument, range?: Range) {
-		super(ctx, doc);
-		const textLen = range ? doc.offsetAt(range.end) - doc.offsetAt(range.start) + 1 : undefined;
-		this.semanticTokenCapability = new SemanticTokenCapability(this, SemanticTokenTypes.comment, [], range, textLen)
-	}
-}

server/src/project/parser/vbaListener.ts

@@ -31,7 +31,7 @@ import {
 
 // Project
 import { DuplicateOperatorElement, WhileLoopElement } from '../elements/flow';
-import { CompilerLogicalBlock, GenericCommentElement } from '../elements/precompiled';
+import { CompilerLogicalBlock } from '../elements/precompiled';
 import { ClassElement, ModuleElement, ModuleIgnoredAttributeElement } from '../elements/module';
 import { DocumentSettings, VbaClassDocument, VbaModuleDocument } from '../document';
 import { FunctionDeclarationElement, PropertyGetDeclarationElement, PropertyLetDeclarationElement, PropertySetDeclarationElement, SubDeclarationElement } from '../elements/procedure';
@@ -214,25 +214,10 @@ export class VbaPreListener extends vbapreListener {
         const doc = this.common.document;
         const docprops = this.common.documentSettings;
         const element = new CompilerLogicalBlock(ctx, doc.textDocument, docprops);
-
-        // Register block subtraction and comment tokens.
-        element.inactiveBlocks.forEach(b => {
-            doc.registerSubtractElement(b);
-            b.linesToComments.forEach(c =>
-                doc.registerSemanticToken(c)
-                    .registerSemanticToken(c)
-            );
-        });
-    }
-
-    enterCompilerElseStatement = (ctx: CompilerElseStatementContext) => this.registerSemanticComment(ctx);
-    enterCompilerEndIfStatement = (ctx: CompilerEndIfStatementContext) => this.registerSemanticComment(ctx);
-    enterCompilerConditionalStatement = (ctx: CompilerConditionalStatementContext) => this.registerSemanticComment(ctx);
-
-    private registerSemanticComment(ctx: ParserRuleContext) {
-        const doc = this.common.document;
-        const element = new GenericCommentElement(ctx, doc.textDocument);
-        doc.registerSubtractElement(element);
+        element.inactiveBlocks.forEach(
+            b => doc.registerElement(b)
+                .registerSubtractElement(b)
+        );
     }
 }