Refactor formatter to handle #if-else directives

Author: SSlinky

server/src/antlr/vbafmt.g4

@@ -28,7 +28,7 @@ classHeaderBlock
     ;
 
 basicStatement
-    : ws? ((ambiguousComponent | keywordComponent | flowCharacter) ws?)+ endOfStatement
+    : ws? ((ambiguousComponent | keywordComponent | flowCharacter) ws*)+ endOfStatement
     ;
 
 blankLine
@@ -38,23 +38,51 @@ blankLine
 documentElement
 	: comment
     | classHeader
-    | doBlock
-    | forBlock
     | endStatement
-    | enumBlock
     | labelStatement
-	| methodDeclaration
 	| attributeStatement
     | ifElseStatement
-    | ifElseBlock
-    | selectCaseBlock
-    | whileBlock
-    | withBlock
+    | preIfElseBlock
     | onErrorResumeNextStatement
+    | indentAfterElement
+    | outdentBeforeElement
+    | outdentOnIndentAfterElement
+    | caseDefaultStatement
+    | caseStatement
     | basicStatement
     | blankLine
 	;
 
+indentAfterElement
+    : doBlockOpen
+    | enumBlockOpen
+    | forBlockOpen
+    | ifBlockOpen
+    | methodSignature
+    | selectCaseOpen
+    | typeBlockOpen
+    | withBlockOpen
+    | whileBlockOpen
+    ;
+
+outdentOnIndentAfterElement
+    : elseIfBlockOpen
+    | ifBlockDefault
+    ;
+
+outdentBeforeElement
+    : doBlockClose
+    | enumBlockClose
+    | forBlockClose
+    | ifBlockOpen
+    | ifBlockClose
+    | methodClose
+    | selectCaseClose
+    | typeBlockClose
+    | withBlockClose
+    | whileBlockClose
+    ;
+
 attributeStatement
 	: ws? ATTRIBUTE (ANYCHARS | ws | continuation | STRINGLITERAL)* endOfStatement
 	;
@@ -81,12 +109,26 @@ enumBlockClose
     : ws? END ws ENUM
     ;
 
-enumBlock
-    : enumBlockOpen
-        block?
-        enumBlockClose
+// enumBlock
+//     : enumBlockOpen
+//         block?
+//         enumBlockClose
+//     ;
+
+typeBlockOpen
+    : ws? (visibility ws)? TYPE ws ambiguousComponent endOfStatement
     ;
 
+typeBlockClose
+    : ws? END ws TYPE
+    ;
+
+// typeBlock
+//     : typeBlockOpen
+//         block?
+//         typeBlockClose
+//     ;
+
 labelStatement
     : ws? ambiguousComponent COLON
     ;
@@ -115,14 +157,18 @@ withBlockClose
     : ws? END ws WITH endOfStatement
     ;
 
-withBlock
-    : withBlockOpen
-        block?
-        withBlockClose
-    ;
+// withBlock
+//     : withBlockOpen
+//         block?
+//         withBlockClose
+//     ;
 
 block
-    : documentElement+
+    : (documentElement endOfStatement?)+
+    ;
+
+preBlock
+    : (documentElement endOfStatement? | preIfElseBlock)+
     ;
 
 methodDeclaration
@@ -144,11 +190,11 @@ doBlockClose
     : ws? LOOP (ws (WHILE | UNTIL) ws expression+)? endOfStatement
     ;
 
-doBlock
-    : doBlockOpen
-        block?
-        doBlockClose
-    ;
+// doBlock
+//     : doBlockOpen
+//         block?
+//         doBlockClose
+//     ;
 
 onErrorResumeNextStatement
     : ws? ON ws ERROR ws RESUME ws NEXT endOfStatement
@@ -205,6 +251,29 @@ ifElseBlock
         ifBlockClose
     ;
 
+preIfBlockOpen
+    : ws? PREIF ws expression+ THEN endOfStatement
+    ;
+
+preElseIfBlockOpen
+    : ws? PREELSEIF ws expression+ THEN endOfStatement
+    ;
+
+preIfBlockDefault
+    : ws? PREELSE endOfStatement
+    ;
+
+preIfBlockClose
+    : ws? PREEND ws IF endOfStatement
+    ;
+
+preIfElseBlock
+    : preIfBlockOpen preBlock?
+        (preElseIfBlockOpen preBlock?)*
+        (preIfBlockDefault preBlock?)?
+        preIfBlockClose
+    ;
+
 ifElseStatement
     : ws? IF ws expression+ THEN ws expression+ (ELSE ws expression+)? endOfStatement
     ;
@@ -229,23 +298,23 @@ caseBlock
     : ((caseStatement | caseDefaultStatement) block)+
     ;
 
-selectCaseBlock
-    : selectCaseOpen
-        documentElement*
-        caseBlock?
-        selectCaseClose
-    ;
+// selectCaseBlock
+//     : selectCaseOpen
+//         documentElement*
+//         caseBlock?
+//         selectCaseClose
+//     ;
 
 comment
 	: ws? (COMMENT | REMCOMMENT)
 	;
 
 colonEnding
-    : COLON ws? NEWLINE?
+    : COLON ws? lineEnding?
     ;
 
 lineEnding
-    : ws? NEWLINE
+    : (ws? NEWLINE)+
     | endOfFile
     ;
 
@@ -273,13 +342,15 @@ keywordComponent
     | GLOBAL
     | IF
     | IS
+    | NEXT
     | ON
     | PRIVATE
     | PROPERTY
     | PUBLIC
     | RESUME
     | SUB
     | THEN
+    | TYPE
     ;
 
 flowCharacter
@@ -382,6 +453,10 @@ RESUME
     : 'RESUME'
     ;
 
+PREIF
+	: '#IF'
+	;
+
 IF
 	: 'IF'
 	;
@@ -390,10 +465,18 @@ IS
     : 'IS'
     ;
 
+PREELSE
+	: '#ELSE'
+	;
+
 ELSE
 	: 'ELSE'
 	;
 
+PREELSEIF
+	: '#ELSEIF'
+	;
+
 ELSEIF
 	: 'ELSEIF'
 	;
@@ -402,6 +485,10 @@ THEN
 	: 'THEN'
 	;
 
+PREEND
+	: '#END'
+	;
+
 END
 	: 'END'
 	;
@@ -454,6 +541,10 @@ SUB
     : 'SUB'
     ;
 
+TYPE
+    : 'TYPE'
+    ;
+
 UNDERSCORE
     : '_'
     ;

server/src/project/document.ts

@@ -3,7 +3,7 @@ import { Range, TextDocument } from 'vscode-languageserver-textdocument';
 import { CancellationToken, Diagnostic, DocumentDiagnosticReport, DocumentDiagnosticReportKind, SymbolInformation, SymbolKind } from 'vscode-languageserver';
 
 // Antlr
-import { ParseCancellationException, ParserRuleContext } from 'antlr4ng';
+import { ParserRuleContext } from 'antlr4ng';
 
 // Project
 import { Workspace } from './workspace';

server/src/project/parser/vbaAntlr.ts

@@ -80,7 +80,8 @@ export class VbaFmtParser extends vbafmtParser {
 
 	static create(document: string): VbaFmtParser {
         const lexer = VbaFmtLexer.create(document);
-        const parser = new VbaFmtParser(new CommonTokenStream(lexer));
+        const tokens = new CommonTokenStream(lexer);
+        const parser = new VbaFmtParser(tokens);
         parser.removeErrorListeners();
         parser.errorHandler = new VbaErrorHandler();
         return parser;