import type { NodePath } from "@babel/traverse"; import nameFunction from "@babel/helper-function-name"; import ReplaceSupers, { environmentVisitor, } from "@babel/helper-replace-supers"; import optimiseCall from "@babel/helper-optimise-call-expression"; import * as defineMap from "@babel/helper-define-map"; import { traverse, template, types as t } from "@babel/core"; import annotateAsPure from "@babel/helper-annotate-as-pure"; import addCreateSuperHelper from "./inline-createSuper-helpers"; type ReadonlySet = Set | { has(val: T): boolean }; function buildConstructor(classRef, constructorBody, node) { const func = t.functionDeclaration( t.cloneNode(classRef), [], constructorBody, ); t.inherits(func, node); return func; } export default function transformClass( path: NodePath, file: any, builtinClasses: ReadonlySet, isLoose: boolean, ) { const classState = { parent: undefined, scope: undefined, node: undefined, path: undefined, file: undefined, classId: undefined, classRef: undefined, superFnId: undefined, superName: undefined, superReturns: [], isDerived: false, extendsNative: false, construct: undefined, constructorBody: undefined, userConstructor: undefined, userConstructorPath: undefined, hasConstructor: false, instancePropBody: [], instancePropRefs: {}, staticPropBody: [], body: [], superThises: [], pushedConstructor: false, pushedInherits: false, protoAlias: null, isLoose: false, hasInstanceDescriptors: false, hasStaticDescriptors: false, instanceMutatorMap: {}, staticMutatorMap: {}, }; const setState = newState => { Object.assign(classState, newState); }; const findThisesVisitor = traverse.visitors.merge([ environmentVisitor, { ThisExpression(path) { classState.superThises.push(path); }, }, ]); function pushToMap(node, enumerable, kind = "value", scope?) { let mutatorMap; if (node.static) { setState({ hasStaticDescriptors: true }); mutatorMap = classState.staticMutatorMap; } else { setState({ hasInstanceDescriptors: true }); mutatorMap = classState.instanceMutatorMap; } const map = defineMap.push(mutatorMap, node, kind, classState.file, scope); if (enumerable) { map.enumerable = t.booleanLiteral(true); } return map; } /** * Creates a class constructor or bail out if there is none */ function maybeCreateConstructor() { let hasConstructor = false; const paths = classState.path.get("body.body"); for (const path of paths) { hasConstructor = path.equals("kind", "constructor"); if (hasConstructor) break; } if (hasConstructor) return; let params, body; if (classState.isDerived) { const constructor = template.expression.ast` (function () { super(...arguments); }) `; params = constructor.params; body = constructor.body; } else { params = []; body = t.blockStatement([]); } classState.path .get("body") .unshiftContainer( "body", t.classMethod("constructor", t.identifier("constructor"), params, body), ); } function buildBody() { maybeCreateConstructor(); pushBody(); verifyConstructor(); if (classState.userConstructor) { const { constructorBody, userConstructor, construct } = classState; constructorBody.body = constructorBody.body.concat( userConstructor.body.body, ); t.inherits(construct, userConstructor); t.inherits(constructorBody, userConstructor.body); } pushDescriptors(); } function pushBody() { const classBodyPaths: Array = classState.path.get("body.body"); for (const path of classBodyPaths) { const node = path.node; if (path.isClassProperty()) { throw path.buildCodeFrameError("Missing class properties transform."); } if (node.decorators) { throw path.buildCodeFrameError( "Method has decorators, put the decorator plugin before the classes one.", ); } if (t.isClassMethod(node)) { const isConstructor = node.kind === "constructor"; const replaceSupers = new ReplaceSupers({ methodPath: path, objectRef: classState.classRef, superRef: classState.superName, isLoose: classState.isLoose, file: classState.file, }); replaceSupers.replace(); const superReturns = []; path.traverse( traverse.visitors.merge([ environmentVisitor, { ReturnStatement(path) { if (!path.getFunctionParent().isArrowFunctionExpression()) { superReturns.push(path); } }, }, ]), ); if (isConstructor) { pushConstructor(superReturns, node, path); } else { pushMethod(node, path); } } } } function clearDescriptors() { setState({ hasInstanceDescriptors: false, hasStaticDescriptors: false, instanceMutatorMap: {}, staticMutatorMap: {}, }); } function pushDescriptors() { pushInheritsToBody(); const { body } = classState; let instanceProps; let staticProps; if (classState.hasInstanceDescriptors) { instanceProps = defineMap.toClassObject(classState.instanceMutatorMap); } if (classState.hasStaticDescriptors) { staticProps = defineMap.toClassObject(classState.staticMutatorMap); } if (instanceProps || staticProps) { if (instanceProps) { instanceProps = defineMap.toComputedObjectFromClass(instanceProps); } if (staticProps) { staticProps = defineMap.toComputedObjectFromClass(staticProps); } let args = [ t.cloneNode(classState.classRef), // Constructor t.nullLiteral(), // instanceDescriptors t.nullLiteral(), // staticDescriptors ]; if (instanceProps) args[1] = instanceProps; if (staticProps) args[2] = staticProps; let lastNonNullIndex = 0; for (let i = 0; i < args.length; i++) { if (!t.isNullLiteral(args[i])) lastNonNullIndex = i; } args = args.slice(0, lastNonNullIndex + 1); body.push( t.expressionStatement( t.callExpression(classState.file.addHelper("createClass"), args), ), ); } clearDescriptors(); } function wrapSuperCall(bareSuper, superRef, thisRef, body) { const bareSuperNode = bareSuper.node; let call; if (classState.isLoose) { bareSuperNode.arguments.unshift(t.thisExpression()); if ( bareSuperNode.arguments.length === 2 && t.isSpreadElement(bareSuperNode.arguments[1]) && t.isIdentifier(bareSuperNode.arguments[1].argument, { name: "arguments", }) ) { // special case single arguments spread bareSuperNode.arguments[1] = bareSuperNode.arguments[1].argument; bareSuperNode.callee = t.memberExpression( t.cloneNode(superRef), t.identifier("apply"), ); } else { bareSuperNode.callee = t.memberExpression( t.cloneNode(superRef), t.identifier("call"), ); } call = t.logicalExpression("||", bareSuperNode, t.thisExpression()); } else { call = optimiseCall( t.cloneNode(classState.superFnId), t.thisExpression(), bareSuperNode.arguments, ); } if ( bareSuper.parentPath.isExpressionStatement() && bareSuper.parentPath.container === body.node.body && body.node.body.length - 1 === bareSuper.parentPath.key ) { // this super call is the last statement in the body so we can just straight up // turn it into a return if (classState.superThises.length) { call = t.assignmentExpression("=", thisRef(), call); } bareSuper.parentPath.replaceWith(t.returnStatement(call)); } else { bareSuper.replaceWith(t.assignmentExpression("=", thisRef(), call)); } } function verifyConstructor() { if (!classState.isDerived) return; const path = classState.userConstructorPath; const body = path.get("body"); path.traverse(findThisesVisitor); let thisRef = function() { const ref = path.scope.generateDeclaredUidIdentifier("this"); thisRef = () => t.cloneNode(ref); return ref; }; for (const thisPath of classState.superThises) { const { node, parentPath } = thisPath; if (parentPath.isMemberExpression({ object: node })) { thisPath.replaceWith(thisRef()); continue; } thisPath.replaceWith( t.callExpression(classState.file.addHelper("assertThisInitialized"), [ thisRef(), ]), ); } const bareSupers = new Set(); path.traverse( traverse.visitors.merge([ environmentVisitor, { Super(path) { const { node, parentPath } = path; if (parentPath.isCallExpression({ callee: node })) { bareSupers.add(parentPath); } }, }, ]), ); let guaranteedSuperBeforeFinish = !!bareSupers.size; for (const bareSuper of bareSupers) { wrapSuperCall(bareSuper, classState.superName, thisRef, body); if (guaranteedSuperBeforeFinish) { bareSuper.find(function(parentPath) { // hit top so short circuit if (parentPath === path) { return true; } if ( parentPath.isLoop() || parentPath.isConditional() || parentPath.isArrowFunctionExpression() ) { guaranteedSuperBeforeFinish = false; return true; } }); } } let wrapReturn; if (classState.isLoose) { wrapReturn = returnArg => { const thisExpr = t.callExpression( classState.file.addHelper("assertThisInitialized"), [thisRef()], ); return returnArg ? t.logicalExpression("||", returnArg, thisExpr) : thisExpr; }; } else { wrapReturn = returnArg => t.callExpression( classState.file.addHelper("possibleConstructorReturn"), [thisRef()].concat(returnArg || []), ); } // if we have a return as the last node in the body then we've already caught that // return const bodyPaths = body.get("body"); if (!bodyPaths.length || !bodyPaths.pop().isReturnStatement()) { body.pushContainer( "body", t.returnStatement( guaranteedSuperBeforeFinish ? thisRef() : wrapReturn(), ), ); } for (const returnPath of classState.superReturns) { returnPath .get("argument") .replaceWith(wrapReturn(returnPath.node.argument)); } } /** * Push a method to its respective mutatorMap. */ function pushMethod(node: { type: "ClassMethod" }, path?: NodePath) { const scope = path ? path.scope : classState.scope; if (node.kind === "method") { if (processMethod(node, scope)) return; } pushToMap(node, false, null, scope); } function processMethod(node, scope) { if (classState.isLoose && !node.decorators) { // use assignments instead of define properties for loose classes let { classRef } = classState; if (!node.static) { insertProtoAliasOnce(); classRef = classState.protoAlias; } const methodName = t.memberExpression( t.cloneNode(classRef), node.key, node.computed || t.isLiteral(node.key), ); let func = t.functionExpression( null, node.params, node.body, node.generator, node.async, ); t.inherits(func, node); const key = t.toComputedKey(node, node.key); if (t.isStringLiteral(key)) { func = nameFunction({ node: func, id: key, scope, }); } const expr = t.expressionStatement( t.assignmentExpression("=", methodName, func), ); t.inheritsComments(expr, node); classState.body.push(expr); return true; } return false; } function insertProtoAliasOnce() { if (classState.protoAlias === null) { setState({ protoAlias: classState.scope.generateUidIdentifier("proto") }); const classProto = t.memberExpression( classState.classRef, t.identifier("prototype"), ); const protoDeclaration = t.variableDeclaration("var", [ t.variableDeclarator(classState.protoAlias, classProto), ]); classState.body.push(protoDeclaration); } } /** * Replace the constructor body of our class. */ function pushConstructor( superReturns, method: { type: "ClassMethod" }, path: NodePath, ) { // https://github.com/babel/babel/issues/1077 if (path.scope.hasOwnBinding(classState.classRef.name)) { path.scope.rename(classState.classRef.name); } setState({ userConstructorPath: path, userConstructor: method, hasConstructor: true, superReturns, }); const { construct } = classState; t.inheritsComments(construct, method); construct.params = method.params; t.inherits(construct.body, method.body); construct.body.directives = method.body.directives; pushConstructorToBody(); } function pushConstructorToBody() { if (classState.pushedConstructor) return; classState.pushedConstructor = true; // we haven't pushed any descriptors yet if (classState.hasInstanceDescriptors || classState.hasStaticDescriptors) { pushDescriptors(); } classState.body.push(classState.construct); pushInheritsToBody(); } /** * Push inherits helper to body. */ function pushInheritsToBody() { if (!classState.isDerived || classState.pushedInherits) return; const superFnId = path.scope.generateUidIdentifier("super"); setState({ pushedInherits: true, superFnId }); // Unshift to ensure that the constructor inheritance is set up before // any properties can be assigned to the prototype. classState.body.unshift( t.expressionStatement( t.callExpression( classState.file.addHelper( classState.isLoose ? "inheritsLoose" : "inherits", ), [t.cloneNode(classState.classRef), t.cloneNode(classState.superName)], ), ), t.variableDeclaration("var", [ t.variableDeclarator( superFnId, t.callExpression(addCreateSuperHelper(classState.file), [ t.cloneNode(classState.classRef), ]), ), ]), ); } function setupClosureParamsArgs() { const { superName } = classState; const closureParams = []; const closureArgs = []; if (classState.isDerived) { let arg = t.cloneNode(superName); if (classState.extendsNative) { arg = t.callExpression(classState.file.addHelper("wrapNativeSuper"), [ arg, ]); annotateAsPure(arg); } const param = classState.scope.generateUidIdentifierBasedOnNode( superName, ); closureParams.push(param); closureArgs.push(arg); setState({ superName: t.cloneNode(param) }); } return { closureParams, closureArgs }; } function classTransformer( path: NodePath, file, builtinClasses: ReadonlySet, isLoose: boolean, ) { setState({ parent: path.parent, scope: path.scope, node: path.node, path, file, isLoose, }); setState({ classId: classState.node.id, // this is the name of the binding that will **always** reference the class we've constructed classRef: classState.node.id ? t.identifier(classState.node.id.name) : classState.scope.generateUidIdentifier("class"), superName: classState.node.superClass, isDerived: !!classState.node.superClass, constructorBody: t.blockStatement([]), }); setState({ extendsNative: classState.isDerived && builtinClasses.has(classState.superName.name) && !classState.scope.hasBinding( classState.superName.name, /* noGlobals */ true, ), }); const { classRef, node, constructorBody } = classState; setState({ construct: buildConstructor(classRef, constructorBody, node), }); let { body } = classState; const { closureParams, closureArgs } = setupClosureParamsArgs(); buildBody(); // make sure this class isn't directly called (with A() instead new A()) if (!classState.isLoose) { constructorBody.body.unshift( t.expressionStatement( t.callExpression(classState.file.addHelper("classCallCheck"), [ t.thisExpression(), t.cloneNode(classState.classRef), ]), ), ); } body = body.concat( classState.staticPropBody.map(fn => fn(t.cloneNode(classState.classRef))), ); const isStrict = path.isInStrictMode(); let constructorOnly = classState.classId && body.length === 1; if (constructorOnly && !isStrict) { for (const param of classState.construct.params) { // It's illegal to put a use strict directive into the body of a function // with non-simple parameters for some reason. So, we have to use a strict // wrapper function. if (!t.isIdentifier(param)) { constructorOnly = false; break; } } } const directives = constructorOnly ? body[0].body.directives : []; if (!isStrict) { directives.push(t.directive(t.directiveLiteral("use strict"))); } if (constructorOnly) { // named class with only a constructor return t.toExpression(body[0]); } body.push(t.returnStatement(t.cloneNode(classState.classRef))); const container = t.arrowFunctionExpression( closureParams, t.blockStatement(body, directives), ); return t.callExpression(container, closureArgs); } return classTransformer(path, file, builtinClasses, isLoose); }