Add new line checks everywhere (#55)

* add check for new lines * comments ordering, update tests * abstract class parse * abstract class impl
jyoo980 · Oct 14, 2019 · efef541 · efef541
1 parent e971752
commit efef541
Show file tree

Hide file tree

Showing 18 changed files with 100 additions and 22 deletions.
diff --git a/ebnf.txt b/ebnf.txt
@@ -1,11 +1,12 @@
-PROGRAM         ::= ‘project’ (str | STRLIST) nl MODULE? nl (DIR|CLASS|INTERFACE)* nl
-MODULE          ::= ‘modules’ STRLIST nl 				# should have quotes
+PROGRAM         ::= ‘project’ str nl (MODULE nl)? (DIR|CLASS|INTERFACE)*
+MODULE          ::= ‘modules’ STRLIST				# should have quotes
 DIR             ::= ‘dir’ str nl (ind (DIR|CLASS|INTERFACE) ded)* nl
-CLASS           ::= ABS? ‘class’ str IMP? EXT? (nl COMMENT)? (nl FIELD)* (nl FUNC)* nl
+CLASS           ::= ABS? ‘class’ str IMP? EXT? (nl COMMENT)? (nl FIELD)* (nl (FUNC | CONSTR))* nl
 INTERFACE       ::= ‘interface’ str EXT? (nl COMMENT)? (nl FIELD)* (nl FUNC)* nl
 
 FIELD           ::= ind ‘fields’ mod? VARLIST (nl ind 'generate' gen)* ded
-FUNC            ::= ind ‘function ’ mod ‘async ’? 'static'? str (nl PARAM)? (nl ind 'returns' type)? (nl ind COMMENT)? ded
+FUNC            ::= ind ‘function ’ mod ‘async ’? 'static'? str (nl ind COMMENT)? (nl PARAM)? (nl ind 'returns' type)? ded
+CONSTR          ::= ind ‘constructor’ mod (nl PARAM)? ded
 
 PARAM           ::= ind ‘params ’ VARLIST ded
 COMMENT         ::= ind ‘comments ’ STRLIST ded
@@ -17,10 +18,10 @@ VARLIST         ::= ‘[ ’ (type str (‘,’ type str))? ‘ ]’
 STRLIST         ::= ‘[ ‘ str (‘,’ str)* ‘ ]’
 
 gen             ::= (‘getters’ | ‘setters’)
-mod             ::= ‘private’ | ‘public’| ‘protected’
+mod             ::= (‘private’ | ‘public’| ‘protected’)
 type            ::= (‘number’ | ‘boolean’| ‘string’ | str) sp
 str             ::= [a-z|A-Z]* sp
 sp              ::= ‘ ’
-nl              ::= [\n]
-ind             ::= [\t]
+nl              ::= [\n]+
+ind             ::= [\t | ]+    # tab(s) or single space(s)
 ded             ::= [] # this is a dedent
diff --git a/src/ast/ClassDecl.ts b/src/ast/ClassDecl.ts
@@ -36,6 +36,9 @@ export class ClassDecl extends Content {
         this.className = context.getNext();
 
         if(context.checkToken("implements")) {
+            if(this.isAbstract) {
+                throw new ParseError("Cannot implement another class in an abstract class");
+            }
             this.implementsNodes = new ImplementsDecl();
             this.implementsNodes.parse(context);
         }

diff --git a/src/ast/DirDecl.ts b/src/ast/DirDecl.ts
@@ -24,6 +24,8 @@ export class DirDecl extends Content {
         this.directoryName = context.getNext();
 
         this.parseContents(context);
+
+        context.checkStartOfLine();
     }
 
     protected parseContents(context: Tokenizer): any {
@@ -32,9 +34,11 @@ export class DirDecl extends Content {
         while (context.getCurrentLineTabLevel() > this.tabLevel && !context.checkToken("NO_MORE_TOKENS")) {
             let contentDecl: Content;
 
+            context.checkStartOfLine();
+
             if (context.checkToken("dir")) {
                 contentDecl = new DirDecl(this.getAbsolutePath());
-            } else if (context.checkToken("class")) {
+            } else if (context.checkToken("class") || context.checkToken("abstract")) {
                 contentDecl = new ClassDecl(this.getAbsolutePath());
             } else if (context.checkToken("interface")) {
                 contentDecl = new InterfaceDecl(this.getAbsolutePath());
@@ -44,6 +48,8 @@ export class DirDecl extends Content {
 
             contentDecl.parse(context);
             this.contents.push(contentDecl);
+
+            context.checkStartOfLine();
         }
     }
 

diff --git a/src/ast/FuncDecl.ts b/src/ast/FuncDecl.ts
@@ -22,7 +22,6 @@ export default class FuncDecl extends AstNode {
     name: string;
     params: VarList;
     comments: CommentDecl;
-    body: string = null; // only used in getter/setter
     returnDecl: ReturnDecl = new ReturnDecl();
 
     public parse(context: Tokenizer): any {
@@ -45,17 +44,30 @@ export default class FuncDecl extends AstNode {
         this.comments = new CommentDecl();
 
         this.name = context.getNext();
-        if (context.checkToken("returns")) {
-            this.returnDecl.parse(context);
+
+        context.checkStartOfLine();
+
+        if (context.getCurrentLineTabLevel() <= indentLevel) return;
+        context.checkStartOfLine();
+
+        if(context.checkToken("comments")) {
+            this.comments.parse(context);
         }
+
         if (context.getCurrentLineTabLevel() <= indentLevel) return;
+        context.checkStartOfLine();
 
         if (context.checkToken("params")) {
             context.getAndCheckNext("params");
             this.params.parse(context);
-            this.comments.parse(context);
         }
-        this.returnDecl.parse(context);
+
+        if (context.getCurrentLineTabLevel() <= indentLevel) return;
+        context.checkStartOfLine();
+
+        if(context.checkToken("returns")) {
+            this.returnDecl.parse(context);
+        }
     }
 
     public evaluate(): any {

diff --git a/src/ast/ProgramDecl.ts b/src/ast/ProgramDecl.ts
@@ -23,9 +23,12 @@ export class ProgramDecl extends DirDecl {
         this.projectName = context.getNext();
         this.directoryName = this.projectName;
 
+        context.checkStartOfLine();
+
         if (context.checkToken("modules")) {
             this.modules = new ModuleDecl();
             this.modules.parse(context);
+            context.checkStartOfLine();
         }
 
         super.parseContents(context);

diff --git a/src/codegen/TypeScriptEngine.ts b/src/codegen/TypeScriptEngine.ts
@@ -59,9 +59,15 @@ export default class TypeScriptEngine {
             classMembers.push(this.createMethod(fn));
         }
 
+        let modifiers: Modifier[] = [];
+        modifiers.push(ts.createModifier(SyntaxKind.ExportKeyword));
+        if(classDecl.isAbstract) {
+            modifiers.push(ts.createModifier(SyntaxKind.AbstractKeyword));
+        }
+
         return ts.createClassDeclaration(
             undefined,
-            [ts.createModifier(SyntaxKind.ExportKeyword)],
+            modifiers,
             classDecl.className,
             undefined,
             this.makeHeritageClause(classDecl),

diff --git a/test/ast/ClassDecl.spec.ts b/test/ast/ClassDecl.spec.ts
@@ -138,4 +138,12 @@ describe ("ClassDecl evaluate test", () => {
         createdFiles.push(OUTPUT_DIR  + "/Time.ts");
     });
 
+    it("writes an abstract class to disk", () => {
+        let tokenizer : Tokenizer = new Tokenizer("classDeclAbstract.txt", "./test/testFiles");
+        let classDec : ClassDecl = new ClassDecl(OUTPUT_DIR);
+        classDec.parse(tokenizer);
+        classDec.evaluate();
+        // createdFiles.push(OUTPUT_DIR  + "/Time.ts");
+    })
+
 });
diff --git a/test/ast/DirDecl.spec.ts b/test/ast/DirDecl.spec.ts
@@ -0,0 +1,18 @@
+import { expect } from "chai";
+import {DirDecl} from "../../src/ast/DirDecl";
+import {Tokenizer} from "../../src/util/Tokenizer";
+import {ClassDecl} from "../../src/ast/ClassDecl";
+
+describe("DirDecl parse test", () => {
+
+    const DUMMY_ROOT_DIR: string = ".";
+
+    it("parses dir with abstract class inside", () => {
+        let tokenizer : Tokenizer = new Tokenizer("dirDeclWithAbstractClass.txt", "./test/testFiles");
+        let dirDec : DirDecl = new DirDecl(DUMMY_ROOT_DIR);
+        dirDec.parse(tokenizer);
+        expect(dirDec.contents).to.have.length(1);
+        let classDec = dirDec.contents[0] as ClassDecl;
+        expect(classDec.isAbstract).to.be.true;
+    });
+});
diff --git a/test/ast/InterfaceDecl.spec.ts b/test/ast/InterfaceDecl.spec.ts
@@ -41,7 +41,7 @@ describe("InterfaceDecl parse test", () => {
     it("throws a ParseError with invalid line", () => {
         let tokenizer : Tokenizer = new Tokenizer("interfaceInvalidInput.txt", "./test/testFiles");
         let intDec : InterfaceDecl = new InterfaceDecl(".");
-        expect(() => {intDec.parse(tokenizer)}).to.throw(ParseError);
+        expect(() => {intDec.parse(tokenizer)}).to.throw(TokenizerError);
 
     });
 });

diff --git a/test/testFiles/classDeclAbstract.txt b/test/testFiles/classDeclAbstract.txt
@@ -0,0 +1,9 @@
+abstract class Time extends TimeClass
+    comments [ "This is the time class" ]
+        fields private [ number dayOfWeek, number hour, number minute ]
+            generate getters
+            generate setters
+        fields public [ number date ]
+            generate getters
+        function public formatDate
+            returns string
diff --git a/test/testFiles/classDeclComplex.txt b/test/testFiles/classDeclComplex.txt
@@ -6,7 +6,7 @@ class Time implements ITime, DateTime extends TimeClass
     fields public [ number date ]
         generate getters
     function public getDate
-        params [ string id, string content, string kind ]
         comments [ "creates a new Time object from given date",
             "{param} date - date object to parse time object from" ]
+        params [ string id, string content, string kind ]
         returns string
diff --git a/test/testFiles/classDeclWithConstructor.txt b/test/testFiles/classDeclWithConstructor.txt
diff --git a/test/testFiles/dirDeclWithAbstractClass.txt b/test/testFiles/dirDeclWithAbstractClass.txt
@@ -0,0 +1,10 @@
+dir models
+    abstract class Time implements ITime, DateTime extends TimeClass
+        comments [ "This is the time class" ]
+        fields private [ number dayOfWeek, number hour, number minute ]
+            generate getters
+            generate setters
+        fields public [ number date ]
+            generate getters
+        function public getDate
+            returns string
diff --git a/test/testFiles/funcDeclComplex.txt b/test/testFiles/funcDeclComplex.txt
@@ -1,4 +1,4 @@
 function public static async addDataset
-    params [ string id, string content, InsightDatasetKind kind ]
     comments [ "Add Dataset function", "returns ids of datasets on disk" ]
+    params [ string id, string content, InsightDatasetKind kind ]
     returns Promise<string>
diff --git a/test/testFiles/funcDeclOptionalParams.txt b/test/testFiles/funcDeclOptionalParams.txt
@@ -1 +1,2 @@
-function public getTime returns number
+function public getTime
+    returns number
diff --git a/test/testFiles/funcDeclUndefinedType.txt b/test/testFiles/funcDeclUndefinedType.txt
@@ -1 +1,2 @@
-function private foo returns NOTAVALIDTYPE
+function private foo
+    returns NOTAVALIDTYPE
diff --git a/test/testFiles/funcDeclWithComments.txt b/test/testFiles/funcDeclWithComments.txt
@@ -1,4 +1,4 @@
 function private foo
-    params [ ]
     comments [ "ayy lmao" ]
+    params [ ]
     returns number
diff --git a/test/testFiles/interfaceDeclComplex.txt b/test/testFiles/interfaceDeclComplex.txt
@@ -1,9 +1,9 @@
 interface TransitLine
     function public getNumberOfStops
-        params [ ]
         comments [ "Returns the number of stops in the transit line" ]
+        params [ ]
         returns number
     function getRoute
-        params [ ]
         comments [ "Returns the street names of transit route" ]
+        params [ ]
         returns string