Lua table (#516)

hazzard993 · Perryvw · commit 3de430d39734 · 2019-05-04T15:08:45.000+02:00
* LuaTable draft

* Refactor and added tests

* Fixed tripped watch file

* Missing semicolon

* Prettified

* Cannot extend LuaTable classes

* luaTable classes can only be declared

* Restricted LuaTable parameter length

* string -&gt; LuaTable correction

* LuaTable length cannot be re-assigned

* Prettier

* LuaTable interface tests

* LuaTables cannot be constructed with arguments

* Test splitting and more interface tests

* instanceof LuaTable not allowed

* Purpose in life for exception

* No more other methods

* Broke down transformLuaTableCallExpression into other methods

* LuaTable -&gt; luaTable

* luaTables must be within an ambient context

* Added isAmbient and disallowed argument spreading

* Unsupported method consistency

* tsHelper.isDeclared is unused

* public -&gt; private

* Missed one more public

* Allowed transpileAndExecute to use ambient code

* luaTable functional tests

* transpileString signature change

* Revert util.ts changes
diff --git a/src/Decorator.ts b/src/Decorator.ts
@@ -23,6 +23,8 @@ export class Decorator {
                 return DecoratorKind.TupleReturn;
             case "luaiterator":
                 return DecoratorKind.LuaIterator;
+            case "luatable":
+                return DecoratorKind.LuaTable;
             case "noself":
                 return DecoratorKind.NoSelf;
             case "noselfinfile":
@@ -56,6 +58,7 @@ export enum DecoratorKind {
     Phantom = "Phantom",
     TupleReturn = "TupleReturn",
     LuaIterator = "LuaIterator",
+    LuaTable = "LuaTable",
     NoSelf = "NoSelf",
     NoSelfInFile = "NoSelfInFile",
 }
diff --git a/src/LuaTransformer.ts b/src/LuaTransformer.ts
@@ -475,6 +475,19 @@ export class LuaTransformer {
             }
         }
 
+        // You cannot extend LuaTable classes
+        if (extendsType) {
+            const decorators = tsHelper.getCustomDecorators(extendsType, this.checker);
+            if (decorators.has(DecoratorKind.LuaTable)) {
+                throw TSTLErrors.InvalidExtendsLuaTable(statement);
+            }
+        }
+
+        // LuaTable classes must be ambient
+        if (decorators.has(DecoratorKind.LuaTable) && !tsHelper.isAmbient(statement)) {
+            throw TSTLErrors.ForbiddenLuaTableNonDeclaration(statement);
+        }
+
         // Get all properties with value
         const properties = statement.members.filter(ts.isPropertyDeclaration).filter(member => member.initializer);
 
@@ -1981,6 +1994,22 @@ export class LuaTransformer {
             );
         }
 
+        if (ts.isCallExpression(expression) && ts.isPropertyAccessExpression(expression.expression)) {
+            const ownerType = this.checker.getTypeAtLocation(expression.expression.expression);
+            const classDecorators = tsHelper.getCustomDecorators(ownerType, this.checker);
+            if (classDecorators.has(DecoratorKind.LuaTable)) {
+                this.validateLuaTableCall(
+                    expression as ts.CallExpression & { expression: ts.PropertyAccessExpression },
+                    true
+                );
+                return this.transformLuaTableExpressionStatement(
+                    statement as ts.ExpressionStatement
+                        & { expression: ts.CallExpression }
+                        & { expression: { expression: ts.PropertyAccessExpression } }
+                );
+            }
+        }
+
         return tstl.createExpressionStatement(this.expectExpression(this.transformExpression(expression)));
     }
 
@@ -2666,6 +2695,10 @@ export class LuaTransformer {
                     throw TSTLErrors.InvalidInstanceOfExtension(expression);
                 }
 
+                if (decorators.has(DecoratorKind.LuaTable)) {
+                    throw TSTLErrors.InvalidInstanceOfLuaTable(expression);
+                }
+
                 if (tsHelper.isStandardLibraryType(rhsType, "ObjectConstructor", this.program)) {
                     return this.transformLuaLibFunction(LuaLibFeature.InstanceOfObject, expression, lhs);
                 }
@@ -2697,6 +2730,7 @@ export class LuaTransformer {
         const rightType = this.checker.getTypeAtLocation(expression.right);
         const leftType = this.checker.getTypeAtLocation(expression.left);
         this.validateFunctionAssignment(expression.right, rightType, leftType);
+        this.validatePropertyAssignment(expression);
 
         if (tsHelper.isArrayLengthAssignment(expression, this.checker, this.program)) {
             // array.length = x
@@ -3393,6 +3427,17 @@ export class LuaTransformer {
             );
         }
 
+        if (classDecorators.has(DecoratorKind.LuaTable)) {
+            if (node.arguments && node.arguments.length > 0) {
+                throw TSTLErrors.ForbiddenLuaTableUseException(
+                    "No parameters are allowed when constructing a LuaTable object.",
+                    node
+                );
+            } else {
+                return tstl.createTableExpression();
+            }
+        }
+
         return tstl.createCallExpression(
             tstl.createTableIndexExpression(name, tstl.createStringLiteral("new")),
             params,
@@ -3535,6 +3580,18 @@ export class LuaTransformer {
             return this.transformSymbolCallExpression(node);
         }
 
+        const classDecorators = tsHelper.getCustomDecorators(ownerType, this.checker);
+
+        if (classDecorators.has(DecoratorKind.LuaTable)) {
+            this.validateLuaTableCall(
+                node as ts.CallExpression & { expression: ts.PropertyAccessExpression },
+                false
+            );
+            return this.transformLuaTableCallExpression(
+                node as ts.CallExpression & { expression: ts.PropertyAccessExpression }
+            );
+        }
+
         switch (ownerType.flags) {
             case ts.TypeFlags.String:
             case ts.TypeFlags.StringLiteral:
@@ -3712,6 +3769,10 @@ export class LuaTransformer {
             return tstl.createIdentifier(property, node);
         }
 
+        if (decorators.has(DecoratorKind.LuaTable)) {
+            return this.transformLuaTableProperty(node);
+        }
+
         // Catch math expressions
         if (ts.isIdentifier(node.expression)) {
             const ownerType = this.checker.getTypeAtLocation(node.expression);
@@ -3851,6 +3912,16 @@ export class LuaTransformer {
         }
     }
 
+    private transformLuaTableProperty(node: ts.PropertyAccessExpression): tstl.UnaryExpression | undefined {
+        switch (node.name.escapedText) {
+            case "length":
+                const propertyAccessExpression = this.expectExpression(this.transformExpression(node.expression));
+                return tstl.createUnaryExpression(propertyAccessExpression, tstl.SyntaxKind.LengthOperator, node);
+            default:
+                throw TSTLErrors.UnsupportedProperty("LuaTable", node.name.escapedText as string, node);
+        }
+    }
+
     public transformElementAccessExpression(expression: ts.ElementAccessExpression): ExpressionVisitResult {
         const table = this.expectExpression(this.transformExpression(expression.expression));
         const index = this.expectExpression(this.transformExpression(expression.argumentExpression));
@@ -4219,6 +4290,91 @@ export class LuaTransformer {
         }
     }
 
+    private validateLuaTableCall(
+        expression: ts.CallExpression & { expression: ts.PropertyAccessExpression },
+        isWithinExpressionStatement: boolean
+    ): void {
+        const methodName = expression.expression.name.escapedText;
+        if (expression.arguments.some(argument => ts.isSpreadElement(argument))) {
+            throw TSTLErrors.ForbiddenLuaTableUseException("Arguments cannot be spread.", expression);
+        }
+
+        switch (methodName) {
+            case "get":
+                if (expression.arguments.length !== 1) {
+                    throw TSTLErrors.ForbiddenLuaTableUseException(
+                        "One parameter is required for get().",
+                        expression
+                    );
+                }
+                break;
+            case "set":
+                if (expression.arguments.length !== 2) {
+                    throw TSTLErrors.ForbiddenLuaTableUseException(
+                        "Two parameters are required for set().",
+                        expression
+                    );
+                }
+                if (!isWithinExpressionStatement) {
+                    throw TSTLErrors.ForbiddenLuaTableSetExpression(expression);
+                }
+                break;
+        }
+    }
+
+    private transformLuaTableExpressionStatement(
+        node: ts.ExpressionStatement
+            & { expression: ts.CallExpression }
+            & { expression: { expression: ts.PropertyAccessExpression }}
+    ): tstl.VariableDeclarationStatement | tstl.AssignmentStatement {
+        const methodName = node.expression.expression.name.escapedText;
+        const signature = this.checker.getResolvedSignature(node.expression);
+        const tableName = (node.expression.expression.expression as ts.Identifier).escapedText;
+        const luaTable = tstl.createIdentifier(tableName);
+        const params = this.transformArguments((node.expression as ts.CallExpression).arguments, signature);
+
+        switch (methodName) {
+            case "get":
+                return tstl.createVariableDeclarationStatement(
+                    tstl.createAnonymousIdentifier(node.expression),
+                    tstl.createTableIndexExpression(luaTable, params[0], node.expression),
+                    node.expression
+                );
+            case "set":
+                return tstl.createAssignmentStatement(
+                    tstl.createTableIndexExpression(luaTable, params[0], node.expression),
+                    params.splice(1),
+                    node.expression
+                );
+            default:
+                throw TSTLErrors.ForbiddenLuaTableUseException(
+                    "Unsupported method.",
+                    node.expression
+                );
+        }
+    }
+
+    private transformLuaTableCallExpression(
+        expression: ts.CallExpression & { expression: ts.PropertyAccessExpression }
+    ): tstl.Expression {
+        const method = expression.expression;
+        const methodName = method.name.escapedText;
+        const signature = this.checker.getResolvedSignature(expression);
+        const tableName = (method.expression as ts.Identifier).escapedText;
+        const luaTable = tstl.createIdentifier(tableName);
+        const params = this.transformArguments(expression.arguments, signature);
+
+        switch (methodName) {
+            case "get":
+                return tstl.createTableIndexExpression(luaTable, params[0], expression);
+            default:
+                throw TSTLErrors.ForbiddenLuaTableUseException(
+                    "Unsupported method.",
+                    expression
+                );
+        }
+    }
+
     private transformArrayCallExpression(node: ts.CallExpression): tstl.CallExpression {
         const expression = node.expression as ts.PropertyAccessExpression;
         const signature = this.checker.getResolvedSignature(node);
@@ -4823,6 +4979,22 @@ export class LuaTransformer {
         }
     }
 
+    private validatePropertyAssignment(node: ts.Node): void {
+        if (ts.isBinaryExpression(node) && ts.isPropertyAccessExpression(node.left)) {
+            const leftType = this.checker.getTypeAtLocation(node.left.expression);
+            const decorators = tsHelper.getCustomDecorators(leftType, this.checker);
+            if (decorators.has(DecoratorKind.LuaTable)) {
+                switch (node.left.name.escapedText as string) {
+                    case "length":
+                        throw TSTLErrors.ForbiddenLuaTableUseException(
+                            `A LuaTable object's length cannot be re-assigned.`,
+                            node
+                        );
+                }
+            }
+        }
+    }
+
     private wrapInFunctionCall(expression: tstl.Expression): tstl.FunctionExpression {
         const returnStatement = tstl.createReturnStatement([expression]);
         return tstl.createFunctionExpression(
diff --git a/src/TSHelper.ts b/src/TSHelper.ts
@@ -128,6 +128,10 @@ export class TSHelper {
         return false;
     }
 
+    public static isAmbient(node: ts.Declaration): boolean {
+        return !((ts.getCombinedModifierFlags(node) & ts.ModifierFlags.Ambient) === 0);
+    }
+
     public static isStatic(node: ts.Node): boolean {
         return node.modifiers !== undefined && node.modifiers.some(m => m.kind === ts.SyntaxKind.StaticKeyword);
     }
diff --git a/src/TSTLErrors.ts b/src/TSTLErrors.ts
@@ -18,6 +18,22 @@ export class TSTLErrors {
     public static ForbiddenForIn = (node: ts.Node) =>
         new TranspileError(`Iterating over arrays with 'for ... in' is not allowed.`, node);
 
+    public static ForbiddenLuaTableSetExpression = (node: ts.Node) => new TranspileError(
+        `A '@luaTable' object's 'set()' method can only be used as a Statement, not an Expression.`,
+        node);
+
+    public static ForbiddenLuaTableNonDeclaration = (node: ts.Node) =>
+        new TranspileError(`Classes with the '@luaTable' decorator must be declared.`, node);
+
+    public static InvalidExtendsLuaTable = (node: ts.Node) =>
+        new TranspileError(`Cannot extend classes with the decorator '@luaTable'.`, node);
+
+    public static InvalidInstanceOfLuaTable = (node: ts.Node) =>
+        new TranspileError(`The instanceof operator cannot be used with a '@luaTable' class.`, node);
+
+    public static ForbiddenLuaTableUseException = (description: string, node: ts.Node) =>
+        new TranspileError(`Invalid @luaTable usage: ${description}`, node);
+
     public static HeterogeneousEnum = (node: ts.Node) => new TranspileError(
         `Invalid heterogeneous enum. Enums should either specify no member values, ` +
             `or specify values (of the same type) for all members.`,
diff --git a/test/translation/__snapshots__/transformation.spec.ts.snap b/test/translation/__snapshots__/transformation.spec.ts.snap
@@ -296,6 +296,16 @@ exports[`Transformation (interfaceIndex) 1`] = `
 a.abc = \\"def\\""
 `;
 
+exports[`Transformation (luaTable) 1`] = `
+"tbl = {}
+tbl.value = 5
+local value = tbl.value
+local tblLength = #tbl
+itbl.value = 5
+local ivalue = itbl.value
+local ilength = #tbl"
+`;
+
 exports[`Transformation (methodRestArguments) 1`] = `
 "MyClass = {}
 MyClass.name = \\"MyClass\\"
diff --git a/test/translation/transformation/luaTable.ts b/test/translation/transformation/luaTable.ts
@@ -0,0 +1,23 @@
+/** @luaTable */
+declare class Table<K extends {} = {}, V = any> {
+    public readonly length: number;
+    public set(key: K, value: V): void;
+    public get(key: K): V;
+}
+declare let tbl: Table;
+tbl = new Table();
+tbl.set("value", 5);
+const value = tbl.get("value");
+const tblLength = tbl.length;
+
+/** @luaTable */
+declare interface InterfaceTable<K extends {} = {}, V = any> {
+    readonly length: number;
+    set(key: K, value: V): void;
+    get(key: K): V;
+}
+
+declare const itbl: InterfaceTable;
+itbl.set("value", 5);
+const ivalue = itbl.get("value");
+const ilength = tbl.length;
diff --git a/test/unit/luaTable.spec.ts b/test/unit/luaTable.spec.ts

Original file line number	Diff line number	Diff line change
`@@ -128,6 +128,10 @@ export class TSHelper {`
`128`	`128`	`return false;`
`129`	`129`	`}`
`130`	`130`
	`131`	`+ public static isAmbient(node: ts.Declaration): boolean {`
	`132`	`+ return !((ts.getCombinedModifierFlags(node) & ts.ModifierFlags.Ambient) === 0);`
	`133`	`+ }`
	`134`	`+`
`131`	`135`	`public static isStatic(node: ts.Node): boolean {`
`132`	`136`	`return node.modifiers !== undefined && node.modifiers.some(m => m.kind === ts.SyntaxKind.StaticKeyword);`
`133`	`137`	`}`