Merge pull request #1120 from autoboosh/macrofix

fix macro rules and some other whitespace issues (#1119)

Author: retailcoder

Rubberduck.Parsing/Grammar/VBA.g4

@@ -39,9 +39,6 @@
 * 1. Preprocessor statements (#if, #else, ...) must not interfere with regular
 *    statements.
 *
-* 2. Comments are skipped.
-*
-*
 * Change log:
 *
 * v1.4 Rubberduck
@@ -75,6 +72,8 @@
 *   - optional parameters can be a valueStmt.
 *   - added support for Octal and Currency literals.
 *   - implemented proper specs for DATELITERAL.
+*   - added comments to parse tree (removes known limitation #2).
+*   - macroConstStmt now allowed in blockStmt.
 *
 *======================================================================================
 *
@@ -98,13 +97,14 @@ grammar VBA;
 startRule : module EOF;
 
 module : 
+	WS?
 	endOfLine*
 	(moduleHeader endOfLine*)?
 	moduleConfig? endOfLine*
 	moduleAttributes? endOfLine*
 	moduleDeclarations? endOfLine*
 	moduleBody? endOfLine*
-	endOfLine*
+	WS?
 ;
 
 moduleHeader : VERSION WS DOUBLELITERAL WS CLASS;
@@ -124,10 +124,10 @@ moduleAttributes : (attributeStmt endOfLine+)+;
 moduleDeclarations : moduleDeclarationsElement (endOfLine+ moduleDeclarationsElement)*;
 
 moduleOption : 
-	OPTION_BASE WS? SHORTLITERAL 			# optionBaseStmt
-	| OPTION_COMPARE WS? (BINARY | TEXT | DATABASE) 	# optionCompareStmt
-	| OPTION_EXPLICIT 						# optionExplicitStmt
-	| OPTION_PRIVATE_MODULE 				# optionPrivateModuleStmt
+	OPTION_BASE WS SHORTLITERAL 					# optionBaseStmt
+	| OPTION_COMPARE WS (BINARY | TEXT | DATABASE) 	# optionCompareStmt
+	| OPTION_EXPLICIT 								# optionExplicitStmt
+	| OPTION_PRIVATE_MODULE 						# optionPrivateModuleStmt
 ;
 
 moduleDeclarationsElement :
@@ -138,23 +138,23 @@ moduleDeclarationsElement :
 	| constStmt
 	| implementsStmt
 	| variableStmt
-	| macroConstStmt
-	| macroIfThenElseStmt
 	| moduleOption
 	| typeStmt
+	| macroConstStmt
+	| macroIfThenElseStmt
 ;
 
 moduleBody : 
-	moduleBodyElement (endOfStatement moduleBodyElement)* endOfStatement;
+	moduleBodyElement (endOfLine+ moduleBodyElement)*;
 
 moduleBodyElement : 
 	functionStmt 
-	| macroIfThenElseStmt
-	| macroConstStmt
 	| propertyGetStmt 
 	| propertySetStmt 
 	| propertyLetStmt 
 	| subStmt 
+	| macroConstStmt
+	| macroIfThenElseStmt
 ;
 
 
@@ -197,6 +197,7 @@ blockStmt :
 	| loadStmt
 	| lockStmt
 	| lsetStmt
+	| macroConstStmt
 	| macroIfThenElseStmt
 	| midStmt
 	| mkdirStmt
@@ -368,17 +369,17 @@ macroIfThenElseStmt : macroIfBlockStmt macroElseIfBlockStmt* macroElseBlockStmt?
 
 macroIfBlockStmt : 
 	MACRO_IF WS? ifConditionStmt WS THEN endOfStatement
-	((moduleDeclarationsElement | moduleBody | block) endOfStatement)*
+	(moduleDeclarations | moduleBody | block)*
 ;
 
 macroElseIfBlockStmt : 
 	MACRO_ELSEIF WS? ifConditionStmt WS THEN endOfStatement
-	((moduleDeclarationsElement | moduleBody | block) endOfStatement)*
+	(moduleDeclarations | moduleBody | block)*
 ;
 
 macroElseBlockStmt : 
 	MACRO_ELSE endOfStatement
-	((moduleDeclarationsElement | moduleBody | block) endOfStatement)*
+	(moduleDeclarations | moduleBody | block)*
 ;
 
 midStmt : MID WS? LPAREN WS? argsCall WS? RPAREN;
@@ -809,11 +810,11 @@ LOCK_READ : L O C K WS R E A D;
 LOCK_WRITE : L O C K WS W R I T E;
 LOCK_READ_WRITE : L O C K WS R E A D WS W R I T E;
 LSET : L S E T;
-MACRO_CONST : '#' C O N S T WS;
-MACRO_IF : '#' I F WS;
-MACRO_ELSEIF : '#' E L S E I F WS;
-MACRO_ELSE : '#' E L S E NEWLINE;
-MACRO_END_IF : '#' E N D WS I F NEWLINE;
+MACRO_CONST : '#' C O N S T;
+MACRO_IF : '#' I F;
+MACRO_ELSEIF : '#' E L S E I F;
+MACRO_ELSE : '#' E L S E;
+MACRO_END_IF : '#' E N D WS? I F;
 ME : M E;
 MID : M I D;
 MKDIR : M K D I R;
@@ -829,9 +830,9 @@ ON_ERROR : O N WS E R R O R;
 ON_LOCAL_ERROR : O N WS L O C A L WS E R R O R;
 OPEN : O P E N;
 OPTIONAL : O P T I O N A L;
-OPTION_BASE : O P T I O N WS B A S E WS;
+OPTION_BASE : O P T I O N WS B A S E;
 OPTION_EXPLICIT : O P T I O N WS E X P L I C I T;
-OPTION_COMPARE : O P T I O N WS C O M P A R E WS;
+OPTION_COMPARE : O P T I O N WS C O M P A R E;
 OPTION_PRIVATE_MODULE : O P T I O N WS P R I V A T E WS M O D U L E;
 OR : O R;
 OUTPUT : O U T P U T;
@@ -981,4 +982,4 @@ fragment V:('v'|'V');
 fragment W:('w'|'W');
 fragment X:('x'|'X');
 fragment Y:('y'|'Y');
-fragment Z:('z'|'Z');
+fragment Z:('z'|'Z');