xray16 1.3.0 → 1.3.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "xray16",
-  "version": "1.3.0",
+  "version": "1.3.2",
   "author": "Neloreck",
   "repository": "https://github.com/stalker-xrts/xray-16-types",
   "private": false,

package/plugins/built_at_info.d.ts

@@ -0,0 +1,3 @@
+import { Plugin } from "typescript-to-lua";
+declare const plugin: Plugin;
+export default plugin;

package/plugins/built_at_info.js

@@ -3,9 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const comment = `-- Generated by xrf util at: ${new Date().toString()}\n\n`;
 const plugin = {
     beforeEmit(program, options, emitHost, result) {
-        void program;
-        void options;
-        void emitHost;
         for (const file of result) {
             file.code = comment + file.code;
         }

package/plugins/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const ENV_XR_NO_LUA_LOGS: string;
+export declare const ENV_XR_INJECT_TRACY_ZONES: string;

package/plugins/constants.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ENV_XR_INJECT_TRACY_ZONES = exports.ENV_XR_NO_LUA_LOGS = void 0;
+exports.ENV_XR_NO_LUA_LOGS = "XR_NO_LUA_LOGS";
+exports.ENV_XR_INJECT_TRACY_ZONES = "XR_INJECT_TRACY_ZONES";

package/plugins/from_cast_utils.d.ts

@@ -0,0 +1,7 @@
+import { Plugin } from "typescript-to-lua";
+/**
+ * Plugin for transformation of casting methods.
+ * Simplifies TS/Lua testing and interoperation.
+ */
+declare const plugin: Plugin;
+export default plugin;

package/plugins/global_declarations_transform.d.ts

@@ -0,0 +1,6 @@
+import { Plugin } from "typescript-to-lua";
+/**
+ * Plugin that removes imports from 'global' libraries like engine typedefs.
+ */
+declare const plugin: Plugin;
+export default plugin;

package/plugins/inject_file_meta.d.ts

@@ -0,0 +1,6 @@
+import { Plugin } from "typescript-to-lua";
+/**
+ * Plugin that injects FILE_NAME in compile-time.
+ */
+declare const plugin: Plugin;
+export default plugin;

package/plugins/inject_tracy_zones.d.ts

@@ -0,0 +1,6 @@
+import { Plugin } from "typescript-to-lua";
+/**
+ * Plugin that injects FILE_NAME in compile-time.
+ */
+declare const plugin: Plugin;
+export default plugin;

package/plugins/inject_tracy_zones.js

@@ -1,19 +1,38 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+const path = require("path");
 const typescript_1 = require("typescript");
-const environment_1 = require("./utils/environment");
 const tracy_1 = require("./utils/tracy");
 const ast_1 = require("./utils/ast");
+const environment_1 = require("./utils/environment");
+const sourceFile_1 = require("typescript-to-lua/dist/transformation/visitors/sourceFile");
 /**
  * Plugin that injects FILE_NAME in compile-time.
  */
 const plugin = {
     visitors: {
+        [typescript_1.SyntaxKind.SourceFile]: (node, context) => {
+            if ((0, environment_1.isTracyZonesInjectionEnabled)()) {
+                let filename = node.fileName ? path.basename(node.fileName) : "unknown";
+                if (filename.endsWith(".ts")) {
+                    filename = filename.slice(0, -3) + ".script";
+                }
+                if (filename.startsWith("index.")) {
+                    filename = `${path.basename(path.dirname(node.fileName))}::${filename}`;
+                }
+                return (0, sourceFile_1.transformSourceFileNode)(typescript_1.factory.updateSourceFile(node, [
+                    (0, tracy_1.createTraceZoneBeginNExpression)(`file::${filename}@lua`),
+                    ...node.statements,
+                    (0, tracy_1.createTraceZoneEndExpression)(),
+                ], node.isDeclarationFile, node.referencedFiles, node.typeReferenceDirectives, node.hasNoDefaultLib, node.libReferenceDirectives), context);
+            }
+            return (0, sourceFile_1.transformSourceFileNode)(node, context);
+        },
         [typescript_1.SyntaxKind.FunctionDeclaration]: (node, context) => {
-            return context.superTransformStatements(environment_1.IS_TRACY_ZONES_INJECTION_ENABLED ? (0, tracy_1.transformWithInjectedZones)(node) : node);
+            return context.superTransformStatements((0, environment_1.isTracyZonesInjectionEnabled)() ? (0, tracy_1.transformWithInjectedZones)(node) : node);
         },
         [typescript_1.SyntaxKind.ClassDeclaration]: (node, context) => {
-            if (environment_1.IS_TRACY_ZONES_INJECTION_ENABLED) {
+            if ((0, environment_1.isTracyZonesInjectionEnabled)()) {
                 const name = node.name ? node.name.getText() : null;
                 return context.superTransformStatements(typescript_1.factory.updateClassDeclaration(node, node.modifiers, node.name, node.typeParameters, node.heritageClauses, node.members.map((it) => {
                     if ((0, typescript_1.isMethodDeclaration)(it)) {
@@ -25,7 +44,7 @@ const plugin = {
             return context.superTransformStatements(node);
         },
         [typescript_1.SyntaxKind.ExpressionStatement]: (statement, context) => {
-            if (environment_1.IS_TRACY_ZONES_INJECTION_ENABLED) {
+            if ((0, environment_1.isTracyZonesInjectionEnabled)()) {
                 const expression = statement.expression;
                 if ((0, typescript_1.isCallExpression)(expression) &&
                     expression.expression?.kind === typescript_1.SyntaxKind.Identifier &&

package/plugins/strip_lua_logger.d.ts

@@ -0,0 +1,6 @@
+import { Plugin } from "typescript-to-lua";
+/**
+ * Plugin that removes all LuaLogger instance creations and calls when possible.
+ */
+declare const plugin: Plugin;
+export default plugin;

package/plugins/strip_lua_logger.js

@@ -9,7 +9,7 @@ const LUA_LOGGER_STRIP_TARGET = "LuaLogger";
 const plugin = {
     visitors: {
         [typescript_1.SyntaxKind.VariableStatement]: (statement, context) => {
-            if (environment_1.IS_LUA_LOGGER_DISABLED) {
+            if (!(0, environment_1.isLuaLoggerEnabled)()) {
                 let elementsCount = 0;
                 const list = statement.declarationList;
                 const nodes = [];
@@ -34,7 +34,7 @@ const plugin = {
             return context.superTransformStatements(statement);
         },
         [typescript_1.SyntaxKind.ExpressionStatement]: (statement, context) => {
-            if (environment_1.IS_LUA_LOGGER_DISABLED && statement.expression?.kind === typescript_1.SyntaxKind.CallExpression) {
+            if (!(0, environment_1.isLuaLoggerEnabled)() && statement.expression?.kind === typescript_1.SyntaxKind.CallExpression) {
                 const expression = statement.expression;
                 const propertyAccess = expression.expression;
                 if (propertyAccess.expression?.kind === typescript_1.SyntaxKind.Identifier) {

package/plugins/transform_luabind_class/plugin.d.ts

@@ -0,0 +1,6 @@
+import { Plugin } from "typescript-to-lua";
+/**
+ * Plugin that transform TS classes marked with decorator to luabind class declaration.
+ */
+declare const plugin: Plugin;
+export default plugin;

package/plugins/transform_luabind_class/transformation/class_declaration.d.ts

@@ -0,0 +1,18 @@
+import { ClassLikeDeclaration, ExpressionWithTypeArguments } from "typescript";
+import * as tstl from "typescript-to-lua";
+import { TransformationContext } from "typescript-to-lua";
+export interface ITransformationContext extends TransformationContext {
+    classSuperInfos: Array<ClassSuperInfo>;
+}
+export declare const transformLuabindClassDeclaration: (declaration: any, context: TransformationContext) => tstl.Statement[];
+export declare function transformClassAsExpression(expression: ClassLikeDeclaration, context: ITransformationContext): tstl.Expression;
+/** @internal */
+export interface ClassSuperInfo {
+    className: tstl.Identifier;
+    classDeclaration: ClassLikeDeclaration;
+    extendedTypeNode?: ExpressionWithTypeArguments;
+}
+export declare function transformClassLikeDeclaration(classDeclaration: ClassLikeDeclaration, context: ITransformationContext, nameOverride?: tstl.Identifier): {
+    statements: tstl.Statement[];
+    name: tstl.Identifier;
+};

package/plugins/transform_luabind_class/transformation/constants.d.ts

@@ -0,0 +1,4 @@
+export declare const LUABIND_NAME_FIELD: string;
+export declare const LUABIND_DECORATOR: string;
+export declare const LUABIND_CONSTRUCTOR_METHOD: string;
+export declare const LUABIND_SYMBOL: symbol;

package/plugins/transform_luabind_class/transformation/decorators.d.ts

@@ -0,0 +1,6 @@
+import { Decorator } from "typescript";
+import { TransformationContext } from "typescript-to-lua";
+/**
+ * Transform decorator call expressions for luabind class.
+ */
+export declare function checkLuabindClassDecoratorExpression(context: TransformationContext, decorator: Decorator): void;

package/plugins/transform_luabind_class/transformation/errors.d.ts

@@ -0,0 +1,18 @@
+export declare const unsupportedStaticMethod: ((node: import("typescript").Node, name?: string) => import("typescript").Diagnostic) & {
+    code: number;
+};
+export declare const unsupportedClassDecorator: ((node: import("typescript").Node, name?: string) => import("typescript").Diagnostic) & {
+    code: number;
+};
+export declare const unsupportedPropertyDecorator: ((node: import("typescript").Node, name?: string) => import("typescript").Diagnostic) & {
+    code: number;
+};
+export declare const unsupportedParameterDecorator: ((node: import("typescript").Node, name?: string) => import("typescript").Diagnostic) & {
+    code: number;
+};
+export declare const unsupportedMethodDecorator: ((node: import("typescript").Node, name?: string) => import("typescript").Diagnostic) & {
+    code: number;
+};
+export declare const unsupportedStaticAccessor: ((node: import("typescript").Node, name?: string) => import("typescript").Diagnostic) & {
+    code: number;
+};

package/plugins/transform_luabind_class/transformation/index.d.ts

@@ -0,0 +1,5 @@
+export * from "./constants";
+export * from "./utils";
+export * from "./class_declaration";
+export * from "./super";
+export * from "./new";

package/plugins/transform_luabind_class/transformation/members/accessors.d.ts

@@ -0,0 +1,3 @@
+import { AllAccessorDeclarations, TransformationContext } from "typescript-to-lua";
+import * as lua from "typescript-to-lua";
+export declare function transformAccessorDeclarations(context: TransformationContext, { firstAccessor, getAccessor, setAccessor }: AllAccessorDeclarations, className: lua.Identifier): lua.Statement | undefined;

package/plugins/transform_luabind_class/transformation/members/constructor.d.ts

@@ -0,0 +1,5 @@
+import { ClassLikeDeclaration, ConstructorDeclaration, PropertyDeclaration } from "typescript";
+import { TransformationContext } from "typescript-to-lua";
+import * as lua from "typescript-to-lua";
+export declare function createConstructorName(className: lua.Identifier): lua.TableIndexExpression;
+export declare function transformConstructorDeclaration(context: TransformationContext, statement: ConstructorDeclaration, className: lua.Identifier, instanceFields: Array<PropertyDeclaration>, classDeclaration: ClassLikeDeclaration): lua.Statement | undefined;

package/plugins/transform_luabind_class/transformation/members/fields.d.ts

@@ -0,0 +1,8 @@
+import { AccessorDeclaration, PropertyDeclaration } from "typescript";
+import { TransformationContext } from "typescript-to-lua";
+import * as tstl from "typescript-to-lua";
+/**
+ * Verify whether decorators provided for luabind class.
+ */
+export declare function verifyPropertyDecoratingExpression(context: TransformationContext, node: PropertyDeclaration | AccessorDeclaration): void;
+export declare function transformClassInstanceFields(context: TransformationContext, instanceFields: Array<PropertyDeclaration>): Array<tstl.Statement>;

package/plugins/transform_luabind_class/transformation/members/method.d.ts

@@ -0,0 +1,10 @@
+import { AccessorDeclaration, MethodDeclaration, PropertyDeclaration } from "typescript";
+import { TransformationContext } from "typescript-to-lua";
+import * as lua from "typescript-to-lua";
+export declare function transformMemberExpressionOwnerName(node: PropertyDeclaration | MethodDeclaration | AccessorDeclaration, className: lua.Identifier): lua.Expression;
+export declare function transformMethodName(context: TransformationContext, node: MethodDeclaration): lua.Expression;
+export declare function transformMethodDeclaration(context: TransformationContext, node: MethodDeclaration, className: lua.Identifier): lua.Statement | undefined;
+/**
+ * Verify that method statement is not using decorators for methods/parameters.
+ */
+export declare function verifyMethodDecoratingExpression(context: TransformationContext, node: MethodDeclaration): void;

package/plugins/transform_luabind_class/transformation/new.d.ts

@@ -0,0 +1,7 @@
+import { NewExpression } from "typescript";
+import * as tstl from "typescript-to-lua";
+import { ITransformationContext } from "./index";
+/**
+ * Transform new call for luabind class as ClassConstructor() instead of TS_NEW from tstl.
+ */
+export declare function transformNewCallExpression(expression: NewExpression, context: ITransformationContext): tstl.CallExpression;

package/plugins/transform_luabind_class/transformation/setup.d.ts

@@ -0,0 +1,8 @@
+import { ClassLikeDeclarationBase } from "typescript";
+import * as tstl from "typescript-to-lua";
+import { TransformationContext } from "typescript-to-lua";
+/**
+ * Create full class setup statement with name/super calls/methods/declaration/fields etc.
+ */
+export declare function createClassSetup(context: TransformationContext, statement: ClassLikeDeclarationBase, className: tstl.Identifier, localClassName: tstl.Identifier): tstl.Statement[];
+export declare function getReflectionClassName(declaration: ClassLikeDeclarationBase, className: tstl.Identifier): tstl.Expression;

package/plugins/transform_luabind_class/transformation/super.d.ts

@@ -0,0 +1,20 @@
+import { CallExpression, Expression, SuperExpression } from "typescript";
+import * as tstl from "typescript-to-lua";
+import { ITransformationContext } from "./class_declaration";
+/**
+ * Transform generic methods super calls.
+ * Example: super.parentMethod(first, second).
+ */
+export declare function transformClassSuperMethodExpression(expression: Expression, context: ITransformationContext): tstl.Expression;
+/**
+ * Check if super() call is in luabind class target.
+ */
+export declare function isLuabindClassSuperCall(expression: CallExpression | SuperExpression, context: ITransformationContext): boolean;
+/**
+ * Check if super.method() call is in luabind class target.
+ */
+export declare function isLuabindClassSuperMethodCall(expression: CallExpression | SuperExpression, context: ITransformationContext): boolean;
+/**
+ * Transform super() call in luabind classes to base_class.__init(self, param).
+ */
+export declare function transformLuabindConstructorSuperCall(expression: CallExpression, context: ITransformationContext): tstl.CallExpression;

package/plugins/transform_luabind_class/transformation/utils.d.ts

@@ -0,0 +1,30 @@
+import { ClassLikeDeclaration, ClassLikeDeclarationBase, Expression, ExpressionWithTypeArguments, HasModifiers, HeritageClause, Type } from "typescript";
+import { TransformationContext } from "typescript-to-lua";
+/**
+ * Whether method / field is static.
+ */
+export declare function isStaticNode(node: HasModifiers): boolean;
+/**
+ * Get class extends node.
+ */
+export declare function getExtendsClause(node: ClassLikeDeclarationBase): HeritageClause | undefined;
+/**
+ * Get class extended node.
+ */
+export declare function getExtendedNode(node: ClassLikeDeclarationBase): ExpressionWithTypeArguments | undefined;
+/**
+ * Get class extended node.
+ */
+export declare function getExtendedType(context: TransformationContext, node: ClassLikeDeclarationBase): Type | undefined;
+/**
+ * Check if class is decorated with provided decorator name.
+ */
+export declare function isLuabindDecoratedClass(declaration: ClassLikeDeclaration): boolean;
+/**
+ * Mark provided class as Luabind target.
+ */
+export declare function markTypeAsLuabind(declaration: ClassLikeDeclaration, context: TransformationContext): void;
+/**
+ * Check if provided class is specified as LuaBind.
+ */
+export declare function isLuabindClassType(declaration: Expression | ClassLikeDeclaration, context: TransformationContext): boolean;

package/plugins/utils/ast.d.ts

@@ -0,0 +1,2 @@
+import { Identifier, StringLiteral } from "typescript";
+export declare function getIdentifierText(node: Identifier | StringLiteral): string;

package/plugins/utils/diagnostics.d.ts

@@ -0,0 +1,12 @@
+import { DiagnosticCategory, Node } from "typescript";
+type MessageProvider<TArgs extends any[]> = string | ((...args: TArgs) => string);
+/**
+ * Create diagnostics factory to push errors when transpile lua to typescript.
+ */
+export declare function createDiagnosticFactory<TArgs extends any[]>(category: DiagnosticCategory, message: MessageProvider<TArgs>): ((node: Node, ...args: TArgs) => import("typescript").Diagnostic) & {
+    code: number;
+};
+export declare function createErrorDiagnosticFactory<TArgs extends any[]>(message: MessageProvider<TArgs>): ((node: Node, ...args: TArgs) => import("typescript").Diagnostic) & {
+    code: number;
+};
+export {};

package/plugins/utils/environment.d.ts

@@ -0,0 +1,2 @@
+export declare function isLuaLoggerEnabled(): boolean;
+export declare function isTracyZonesInjectionEnabled(): boolean;

package/plugins/utils/environment.js

@@ -1,5 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.IS_TRACY_ZONES_INJECTION_ENABLED = exports.IS_LUA_LOGGER_DISABLED = void 0;
-exports.IS_LUA_LOGGER_DISABLED = process.argv.includes("--no-lua-logs") || process.env.XR_NO_LUA_LOGS === "true";
-exports.IS_TRACY_ZONES_INJECTION_ENABLED = process.argv.includes("--inject-tracy-zones") || process.env.XR_INJECT_TRACY_ZONES === "true";
+exports.isLuaLoggerEnabled = isLuaLoggerEnabled;
+exports.isTracyZonesInjectionEnabled = isTracyZonesInjectionEnabled;
+const constants_1 = require("../constants");
+function isLuaLoggerEnabled() {
+    return !process.argv.includes("--no-lua-logs") && process.env[constants_1.ENV_XR_NO_LUA_LOGS] !== "true";
+}
+function isTracyZonesInjectionEnabled() {
+    return process.argv.includes("--inject-tracy-zones") || process.env[constants_1.ENV_XR_INJECT_TRACY_ZONES] === "true";
+}

package/plugins/utils/tracy.d.ts

@@ -0,0 +1,13 @@
+import { ArrowFunction, ConstructorDeclaration, ExpressionStatement, FunctionDeclaration, MethodDeclaration, Node, NodeArray, Statement } from "typescript";
+export declare function isTraceBeginExpression(node: Node): boolean;
+export declare function isTraceEndExpression(node: Node): boolean;
+export declare function createTraceZoneBeginExpression(): ExpressionStatement;
+export declare function createTraceZoneBeginNExpression(name: string): ExpressionStatement;
+export declare function createTraceZoneBeginSExpression(name: string): ExpressionStatement;
+export declare function createTraceZoneEndExpression(): ExpressionStatement;
+export declare function remapStatementsWithZoneEnd<T extends {
+    statements: NodeArray<Statement>;
+}>(target: T): Array<Statement>;
+export declare function transformNestedStatementsToInjectEndZones(statement?: Statement): Statement;
+export declare function transformWithInjectedZones<T extends FunctionDeclaration | MethodDeclaration | ConstructorDeclaration>(node: T, parentName?: string): T;
+export declare function transformArrowFunctionWithInjectedZones<T extends ArrowFunction>(node: T, name: string): T;

package/plugins/utils/tracy.js

@@ -120,7 +120,7 @@ function transformWithInjectedZones(node, parentName) {
     }
     const statements = remapStatementsWithZoneEnd(node.body).map(transformNestedStatementsToInjectEndZones);
     // Zone start declaration.
-    statements.unshift(createTraceZoneBeginNExpression(`${parentName ? `${parentName}.` : ""}${name}@lua`));
+    statements.unshift(createTraceZoneBeginNExpression(`${parentName ? `${parentName}::` : ""}${name}@lua`));
     // Zone end declaration without explicit return.
     if (!hasReturnStatement) {
         statements.push(createTraceZoneEndExpression());