Skip to content

Console function calls #454

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Perryvw merged 5 commits into from
Feb 27, 2019
Merged

Console function calls #454

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c3cf573
Added console call expression translations
hazzard993 Feb 26, 2019
5484e4d
Added console translation tests
hazzard993 Feb 26, 2019
9c08988
Fixed tests
hazzard993 Feb 26, 2019
bd123ae
Formatting and readability changes
hazzard993 Feb 26, 2019
9811dee
Formatting change to stringFormatCall
hazzard993 Feb 26, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 95 additions & 0 deletions src/LuaTransformer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3138,6 +3138,10 @@ export class LuaTransformer {
return this.transformObjectCallExpression(node);
}

if (ownerType.symbol && ownerType.symbol.escapedName === "Console") {
return this.transformConsoleCallExpression(node);
}

if (ownerType.symbol && ownerType.symbol.escapedName === "SymbolConstructor") {
return this.transformSymbolCallExpression(node);
}
Expand Down Expand Up @@ -3666,6 +3670,97 @@ export class LuaTransformer {
}
}

public transformConsoleCallExpression(expression: ts.CallExpression): ExpressionVisitResult {
const method = expression.expression as ts.PropertyAccessExpression;
const methodName = method.name.escapedText;

switch (methodName) {
case "log":
if (expression.arguments.length > 0
&& this.isStringFormatTemplate(expression.arguments[0])) {
// print(string.format([arguments]))
const stringFormatCall = tstl.createCallExpression(
tstl.createTableIndexExpression(
tstl.createIdentifier("string"),
tstl.createStringLiteral("format")),
this.transformArguments(expression.arguments)
);
return tstl.createCallExpression(
tstl.createIdentifier("print"),
[stringFormatCall]
);
}
// print([arguments])
return tstl.createCallExpression(
tstl.createIdentifier("print"),
this.transformArguments(expression.arguments)
);
case "assert":
const args = this.transformArguments(expression.arguments);
if (expression.arguments.length > 1
&& this.isStringFormatTemplate(expression.arguments[1])) {
// assert([condition], string.format([arguments]))
const stringFormatCall = tstl.createCallExpression(
tstl.createTableIndexExpression(
tstl.createIdentifier("string"),
tstl.createStringLiteral("format")),
args.slice(1)
);
return tstl.createCallExpression(
tstl.createIdentifier("assert"),
[args[0], stringFormatCall]
);
}
// assert()
return tstl.createCallExpression(
tstl.createIdentifier("assert"),
args
);
case "trace":
if (expression.arguments.length > 0
&& this.isStringFormatTemplate(expression.arguments[0])) {
// print(debug.traceback(string.format([arguments])))
const stringFormatCall = tstl.createCallExpression(
tstl.createTableIndexExpression(
tstl.createIdentifier("string"),
tstl.createStringLiteral("format")),
this.transformArguments(expression.arguments)
);
const debugTracebackCall = tstl.createCallExpression(
tstl.createTableIndexExpression(
tstl.createIdentifier("debug"),
tstl.createStringLiteral("traceback")),
[stringFormatCall]
);
return tstl.createCallExpression(
tstl.createIdentifier("print"),
[debugTracebackCall]
);
}
// print(debug.traceback([arguments])))
const debugTracebackCall = tstl.createCallExpression(
tstl.createTableIndexExpression(
tstl.createIdentifier("debug"),
tstl.createStringLiteral("traceback")),
this.transformArguments(expression.arguments)
);
return tstl.createCallExpression(
tstl.createIdentifier("print"),
[debugTracebackCall]
);
default:
throw TSTLErrors.UnsupportedForTarget(
`console property ${methodName}`,
this.options.luaTarget,
expression
);
}
}

private isStringFormatTemplate(expression: ts.Expression): boolean {
return ts.isStringLiteral(expression) && expression.text.match(/\%/g) !== null;
}

// Transpile a Symbol._ property
public transformSymbolCallExpression(expression: ts.CallExpression): tstl.CallExpression {
const method = expression.expression as ts.PropertyAccessExpression;
Expand Down
48 changes: 48 additions & 0 deletions test/unit/console.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
import { Expect, Test, TestCase, IgnoreTest, FocusTest } from "alsatian";
import * as util from "../src/util";

export class ConsoleTests {

@TestCase("console.log()", "print();")
@TestCase('console.log("Hello")', 'print("Hello");')
@TestCase('console.log("Hello %s", "there")', 'print(string.format("Hello %s", "there"));')
@TestCase('console.log("Hello %%s", "there")', 'print(string.format("Hello %%s", "there"));')
@TestCase('console.log("Hello", "There")', 'print("Hello", "There");')
@Test("console.log")
public testConsoleLog(inp: string, expected: string): void {
// Transpile
const lua = util.transpileString(inp);

// Assert
Expect(lua).toBe(expected);
}

@TestCase("console.trace()", "print(debug.traceback());")
@TestCase('console.trace("message")', 'print(debug.traceback("message"));')
@TestCase('console.trace("Hello %s", "there")', 'print(debug.traceback(string.format("Hello %s", "there")));')
@TestCase('console.trace("Hello %%s", "there")', 'print(debug.traceback(string.format("Hello %%s", "there")));')
@TestCase('console.trace("Hello", "there")', 'print(debug.traceback("Hello", "there"));')
@Test("console.trace")
public testConsoleTrace(inp: string, expected: string): void {
// Transpile
const lua = util.transpileString(inp);

// Assert
Expect(lua).toBe(expected);
}

@TestCase("console.assert(false)", "assert(false);")
@TestCase('console.assert(false, "message")', 'assert(false, "message");')
@TestCase('console.assert(false, "message %s", "info")', 'assert(false, string.format("message %s", "info"));')
@TestCase('console.assert(false, "message %%s", "info")', 'assert(false, string.format("message %%s", "info"));')
@TestCase('console.assert(false, "message", "more")', 'assert(false, "message", "more");')
@Test("console.assert")
public testConsoleAssert(inp: string, expected: string): void {
// Transpile
const lua = util.transpileString(inp);

// Assert
Expect(lua).toBe(expected);
}

}