Skip to content

Transform assignments to private named instance fields #10

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.

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

Closed
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
51 changes: 51 additions & 0 deletions src/compiler/transformers/esnext.ts
Original file line number Diff line number Diff line change
Expand Up @@ -780,6 +780,46 @@ namespace ts {
visitNode(node.right, noDestructuringValue ? visitorNoDestructuringValue : visitor, isExpression)
);
}
else if (isAssignmentExpression(node) && isPropertyAccessExpression(node.left) && isPrivateName(node.left.name)) {
const privateNameInfo = accessPrivateName(node.left.name);
if (privateNameInfo && privateNameInfo.type === PrivateNameType.InstanceField) {
if (isCompoundAssignment(node.operatorToken.kind)) {
const isReceiverInlineable = isSimpleInlineableExpression(node.left.expression);
const getReceiver = isReceiverInlineable ? node.left.expression : createTempVariable(hoistVariableDeclaration);
const setReceiver = isReceiverInlineable
? node.left.expression
: createAssignment(getReceiver, node.left.expression);
return setOriginalNode(
createClassPrivateFieldSetHelper(
context,
setReceiver,
privateNameInfo.weakMapName,
createBinary(
createClassPrivateFieldGetHelper(
context,
getReceiver,
privateNameInfo.weakMapName
),
getOperatorForCompoundAssignment(node.operatorToken.kind),
visitNode(node.right, visitor)
)
),
node
);
}
else {
return setOriginalNode(
createClassPrivateFieldSetHelper(
context,
node.left.expression,
privateNameInfo.weakMapName,
visitNode(node.right, visitor)
),
node
);
}
}
}
return visitEachChild(node, visitor, context);
}

Expand Down Expand Up @@ -1617,4 +1657,15 @@ namespace ts {
context.requestEmitHelper(classPrivateFieldGetHelper);
return createCall(getHelperName("_classPrivateFieldGet"), /* typeArguments */ undefined, [receiver, privateField]);
}

const classPrivateFieldSetHelper: EmitHelper = {
name: "typescript:classPrivateFieldSet",
scoped: false,
text: `var _classPrivateFieldSet = function (receiver, privateMap, value) { if (!privateMap.has(receiver)) { throw new TypeError("attempted to set private field on non-instance"); } privateMap.set(receiver, value); return value; };`
};

function createClassPrivateFieldSetHelper(context: TransformationContext, receiver: Expression, privateField: Identifier, value: Expression) {
context.requestEmitHelper(classPrivateFieldSetHelper);
return createCall(getHelperName("_classPrivateFieldSet"), /* typeArguments */ undefined, [receiver, privateField, value]);
}
}
22 changes: 0 additions & 22 deletions src/compiler/transformers/generators.ts
Original file line number Diff line number Diff line change
Expand Up @@ -667,28 +667,6 @@ namespace ts {
}
}

function isCompoundAssignment(kind: BinaryOperator): kind is CompoundAssignmentOperator {
return kind >= SyntaxKind.FirstCompoundAssignment
&& kind <= SyntaxKind.LastCompoundAssignment;
}

function getOperatorForCompoundAssignment(kind: CompoundAssignmentOperator): BitwiseOperatorOrHigher {
switch (kind) {
case SyntaxKind.PlusEqualsToken: return SyntaxKind.PlusToken;
case SyntaxKind.MinusEqualsToken: return SyntaxKind.MinusToken;
case SyntaxKind.AsteriskEqualsToken: return SyntaxKind.AsteriskToken;
case SyntaxKind.AsteriskAsteriskEqualsToken: return SyntaxKind.AsteriskAsteriskToken;
case SyntaxKind.SlashEqualsToken: return SyntaxKind.SlashToken;
case SyntaxKind.PercentEqualsToken: return SyntaxKind.PercentToken;
case SyntaxKind.LessThanLessThanEqualsToken: return SyntaxKind.LessThanLessThanToken;
case SyntaxKind.GreaterThanGreaterThanEqualsToken: return SyntaxKind.GreaterThanGreaterThanToken;
case SyntaxKind.GreaterThanGreaterThanGreaterThanEqualsToken: return SyntaxKind.GreaterThanGreaterThanGreaterThanToken;
case SyntaxKind.AmpersandEqualsToken: return SyntaxKind.AmpersandToken;
case SyntaxKind.BarEqualsToken: return SyntaxKind.BarToken;
case SyntaxKind.CaretEqualsToken: return SyntaxKind.CaretToken;
}
}

/**
* Visits a right-associative binary expression containing `yield`.
*
Expand Down
22 changes: 22 additions & 0 deletions src/compiler/transformers/utilities.ts
Original file line number Diff line number Diff line change
Expand Up @@ -335,4 +335,26 @@ namespace ts {
return member.kind === SyntaxKind.PropertyDeclaration
&& (<PropertyDeclaration>member).initializer !== undefined;
}

export function isCompoundAssignment(kind: BinaryOperator): kind is CompoundAssignmentOperator {
return kind >= SyntaxKind.FirstCompoundAssignment
&& kind <= SyntaxKind.LastCompoundAssignment;
}

export function getOperatorForCompoundAssignment(kind: CompoundAssignmentOperator): BitwiseOperatorOrHigher {
switch (kind) {
case SyntaxKind.PlusEqualsToken: return SyntaxKind.PlusToken;
case SyntaxKind.MinusEqualsToken: return SyntaxKind.MinusToken;
case SyntaxKind.AsteriskEqualsToken: return SyntaxKind.AsteriskToken;
case SyntaxKind.AsteriskAsteriskEqualsToken: return SyntaxKind.AsteriskAsteriskToken;
case SyntaxKind.SlashEqualsToken: return SyntaxKind.SlashToken;
case SyntaxKind.PercentEqualsToken: return SyntaxKind.PercentToken;
case SyntaxKind.LessThanLessThanEqualsToken: return SyntaxKind.LessThanLessThanToken;
case SyntaxKind.GreaterThanGreaterThanEqualsToken: return SyntaxKind.GreaterThanGreaterThanToken;
case SyntaxKind.GreaterThanGreaterThanGreaterThanEqualsToken: return SyntaxKind.GreaterThanGreaterThanGreaterThanToken;
case SyntaxKind.AmpersandEqualsToken: return SyntaxKind.AmpersandToken;
case SyntaxKind.BarEqualsToken: return SyntaxKind.BarToken;
case SyntaxKind.CaretEqualsToken: return SyntaxKind.CaretToken;
}
}
}
5 changes: 4 additions & 1 deletion tests/baselines/reference/privateNameField.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,12 @@ class A {
}

//// [privateNameField.js]
var _classPrivateFieldSet = function (receiver, privateMap, value) { if (!privateMap.has(receiver)) { throw new TypeError("attempted to set private field on non-instance"); } privateMap.set(receiver, value); return value; };
var _name;
var A = /** @class */ (function () {
function A(name) {
this.#name = name;
_classPrivateFieldSet(this, _name, name);
}
return A;
}());
_name = new WeakMap();
78 changes: 78 additions & 0 deletions tests/baselines/reference/privateNameFieldAssignment.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
//// [privateNameFieldAssignment.ts]
class A {
#field = 0;
constructor() {
this.#field = 1;
this.#field += 2;
this.#field -= 3;
this.#field /= 4;
this.#field *= 5;
this.#field **= 6;
this.#field %= 7;
this.#field <<= 8;
this.#field >>= 9;
this.#field >>>= 10;
this.#field &= 11;
this.#field |= 12;
this.#field ^= 13;
A.getInstance().#field = 1;
A.getInstance().#field += 2;
A.getInstance().#field -= 3;
A.getInstance().#field /= 4;
A.getInstance().#field *= 5;
A.getInstance().#field **= 6;
A.getInstance().#field %= 7;
A.getInstance().#field <<= 8;
A.getInstance().#field >>= 9;
A.getInstance().#field >>>= 10;
A.getInstance().#field &= 11;
A.getInstance().#field |= 12;
A.getInstance().#field ^= 13;
}
static getInstance() {
return new A();
}
}


//// [privateNameFieldAssignment.js]
var _classPrivateFieldSet = function (receiver, privateMap, value) { if (!privateMap.has(receiver)) { throw new TypeError("attempted to set private field on non-instance"); } privateMap.set(receiver, value); return value; };
var _classPrivateFieldGet = function (receiver, privateMap) { if (!privateMap.has(receiver)) { throw new TypeError("attempted to get private field on non-instance"); } return privateMap.get(receiver); };
var _field;
var A = /** @class */ (function () {
function A() {
_field.set(this, 0);
var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m;
_classPrivateFieldSet(this, _field, 1);
_classPrivateFieldSet(this, _field, _classPrivateFieldGet(this, _field) + 2);
_classPrivateFieldSet(this, _field, _classPrivateFieldGet(this, _field) - 3);
_classPrivateFieldSet(this, _field, _classPrivateFieldGet(this, _field) / 4);
_classPrivateFieldSet(this, _field, _classPrivateFieldGet(this, _field) * 5);
_classPrivateFieldSet(this, _field, Math.pow(_classPrivateFieldGet(this, _field), 6));
_classPrivateFieldSet(this, _field, _classPrivateFieldGet(this, _field) % 7);
_classPrivateFieldSet(this, _field, _classPrivateFieldGet(this, _field) << 8);
_classPrivateFieldSet(this, _field, _classPrivateFieldGet(this, _field) >> 9);
_classPrivateFieldSet(this, _field, _classPrivateFieldGet(this, _field) >>> 10);
_classPrivateFieldSet(this, _field, _classPrivateFieldGet(this, _field) & 11);
_classPrivateFieldSet(this, _field, _classPrivateFieldGet(this, _field) | 12);
_classPrivateFieldSet(this, _field, _classPrivateFieldGet(this, _field) ^ 13);
_classPrivateFieldSet(A.getInstance(), _field, 1);
_classPrivateFieldSet(_a = A.getInstance(), _field, _classPrivateFieldGet(_a, _field) + 2);
_classPrivateFieldSet(_b = A.getInstance(), _field, _classPrivateFieldGet(_b, _field) - 3);
_classPrivateFieldSet(_c = A.getInstance(), _field, _classPrivateFieldGet(_c, _field) / 4);
_classPrivateFieldSet(_d = A.getInstance(), _field, _classPrivateFieldGet(_d, _field) * 5);
_classPrivateFieldSet(_e = A.getInstance(), _field, Math.pow(_classPrivateFieldGet(_e, _field), 6));
_classPrivateFieldSet(_f = A.getInstance(), _field, _classPrivateFieldGet(_f, _field) % 7);
_classPrivateFieldSet(_g = A.getInstance(), _field, _classPrivateFieldGet(_g, _field) << 8);
_classPrivateFieldSet(_h = A.getInstance(), _field, _classPrivateFieldGet(_h, _field) >> 9);
_classPrivateFieldSet(_j = A.getInstance(), _field, _classPrivateFieldGet(_j, _field) >>> 10);
_classPrivateFieldSet(_k = A.getInstance(), _field, _classPrivateFieldGet(_k, _field) & 11);
_classPrivateFieldSet(_l = A.getInstance(), _field, _classPrivateFieldGet(_l, _field) | 12);
_classPrivateFieldSet(_m = A.getInstance(), _field, _classPrivateFieldGet(_m, _field) ^ 13);
}
A.getInstance = function () {
return new A();
};
return A;
}());
_field = new WeakMap();
146 changes: 146 additions & 0 deletions tests/baselines/reference/privateNameFieldAssignment.symbols
Original file line number Diff line number Diff line change
@@ -0,0 +1,146 @@
=== tests/cases/conformance/classes/members/privateNames/privateNameFieldAssignment.ts ===
class A {
>A : Symbol(A, Decl(privateNameFieldAssignment.ts, 0, 0))

#field = 0;
>#field : Symbol(A[#field], Decl(privateNameFieldAssignment.ts, 0, 9))

constructor() {
this.#field = 1;
>this.#field : Symbol(A[#field], Decl(privateNameFieldAssignment.ts, 0, 9))
>this : Symbol(A, Decl(privateNameFieldAssignment.ts, 0, 0))

this.#field += 2;
>this.#field : Symbol(A[#field], Decl(privateNameFieldAssignment.ts, 0, 9))
>this : Symbol(A, Decl(privateNameFieldAssignment.ts, 0, 0))

this.#field -= 3;
>this.#field : Symbol(A[#field], Decl(privateNameFieldAssignment.ts, 0, 9))
>this : Symbol(A, Decl(privateNameFieldAssignment.ts, 0, 0))

this.#field /= 4;
>this.#field : Symbol(A[#field], Decl(privateNameFieldAssignment.ts, 0, 9))
>this : Symbol(A, Decl(privateNameFieldAssignment.ts, 0, 0))

this.#field *= 5;
>this.#field : Symbol(A[#field], Decl(privateNameFieldAssignment.ts, 0, 9))
>this : Symbol(A, Decl(privateNameFieldAssignment.ts, 0, 0))

this.#field **= 6;
>this.#field : Symbol(A[#field], Decl(privateNameFieldAssignment.ts, 0, 9))
>this : Symbol(A, Decl(privateNameFieldAssignment.ts, 0, 0))

this.#field %= 7;
>this.#field : Symbol(A[#field], Decl(privateNameFieldAssignment.ts, 0, 9))
>this : Symbol(A, Decl(privateNameFieldAssignment.ts, 0, 0))

this.#field <<= 8;
>this.#field : Symbol(A[#field], Decl(privateNameFieldAssignment.ts, 0, 9))
>this : Symbol(A, Decl(privateNameFieldAssignment.ts, 0, 0))

this.#field >>= 9;
>this.#field : Symbol(A[#field], Decl(privateNameFieldAssignment.ts, 0, 9))
>this : Symbol(A, Decl(privateNameFieldAssignment.ts, 0, 0))

this.#field >>>= 10;
>this.#field : Symbol(A[#field], Decl(privateNameFieldAssignment.ts, 0, 9))
>this : Symbol(A, Decl(privateNameFieldAssignment.ts, 0, 0))

this.#field &= 11;
>this.#field : Symbol(A[#field], Decl(privateNameFieldAssignment.ts, 0, 9))
>this : Symbol(A, Decl(privateNameFieldAssignment.ts, 0, 0))

this.#field |= 12;
>this.#field : Symbol(A[#field], Decl(privateNameFieldAssignment.ts, 0, 9))
>this : Symbol(A, Decl(privateNameFieldAssignment.ts, 0, 0))

this.#field ^= 13;
>this.#field : Symbol(A[#field], Decl(privateNameFieldAssignment.ts, 0, 9))
>this : Symbol(A, Decl(privateNameFieldAssignment.ts, 0, 0))

A.getInstance().#field = 1;
>A.getInstance().#field : Symbol(A[#field], Decl(privateNameFieldAssignment.ts, 0, 9))
>A.getInstance : Symbol(A.getInstance, Decl(privateNameFieldAssignment.ts, 29, 5))
>A : Symbol(A, Decl(privateNameFieldAssignment.ts, 0, 0))
>getInstance : Symbol(A.getInstance, Decl(privateNameFieldAssignment.ts, 29, 5))

A.getInstance().#field += 2;
>A.getInstance().#field : Symbol(A[#field], Decl(privateNameFieldAssignment.ts, 0, 9))
>A.getInstance : Symbol(A.getInstance, Decl(privateNameFieldAssignment.ts, 29, 5))
>A : Symbol(A, Decl(privateNameFieldAssignment.ts, 0, 0))
>getInstance : Symbol(A.getInstance, Decl(privateNameFieldAssignment.ts, 29, 5))

A.getInstance().#field -= 3;
>A.getInstance().#field : Symbol(A[#field], Decl(privateNameFieldAssignment.ts, 0, 9))
>A.getInstance : Symbol(A.getInstance, Decl(privateNameFieldAssignment.ts, 29, 5))
>A : Symbol(A, Decl(privateNameFieldAssignment.ts, 0, 0))
>getInstance : Symbol(A.getInstance, Decl(privateNameFieldAssignment.ts, 29, 5))

A.getInstance().#field /= 4;
>A.getInstance().#field : Symbol(A[#field], Decl(privateNameFieldAssignment.ts, 0, 9))
>A.getInstance : Symbol(A.getInstance, Decl(privateNameFieldAssignment.ts, 29, 5))
>A : Symbol(A, Decl(privateNameFieldAssignment.ts, 0, 0))
>getInstance : Symbol(A.getInstance, Decl(privateNameFieldAssignment.ts, 29, 5))

A.getInstance().#field *= 5;
>A.getInstance().#field : Symbol(A[#field], Decl(privateNameFieldAssignment.ts, 0, 9))
>A.getInstance : Symbol(A.getInstance, Decl(privateNameFieldAssignment.ts, 29, 5))
>A : Symbol(A, Decl(privateNameFieldAssignment.ts, 0, 0))
>getInstance : Symbol(A.getInstance, Decl(privateNameFieldAssignment.ts, 29, 5))

A.getInstance().#field **= 6;
>A.getInstance().#field : Symbol(A[#field], Decl(privateNameFieldAssignment.ts, 0, 9))
>A.getInstance : Symbol(A.getInstance, Decl(privateNameFieldAssignment.ts, 29, 5))
>A : Symbol(A, Decl(privateNameFieldAssignment.ts, 0, 0))
>getInstance : Symbol(A.getInstance, Decl(privateNameFieldAssignment.ts, 29, 5))

A.getInstance().#field %= 7;
>A.getInstance().#field : Symbol(A[#field], Decl(privateNameFieldAssignment.ts, 0, 9))
>A.getInstance : Symbol(A.getInstance, Decl(privateNameFieldAssignment.ts, 29, 5))
>A : Symbol(A, Decl(privateNameFieldAssignment.ts, 0, 0))
>getInstance : Symbol(A.getInstance, Decl(privateNameFieldAssignment.ts, 29, 5))

A.getInstance().#field <<= 8;
>A.getInstance().#field : Symbol(A[#field], Decl(privateNameFieldAssignment.ts, 0, 9))
>A.getInstance : Symbol(A.getInstance, Decl(privateNameFieldAssignment.ts, 29, 5))
>A : Symbol(A, Decl(privateNameFieldAssignment.ts, 0, 0))
>getInstance : Symbol(A.getInstance, Decl(privateNameFieldAssignment.ts, 29, 5))

A.getInstance().#field >>= 9;
>A.getInstance().#field : Symbol(A[#field], Decl(privateNameFieldAssignment.ts, 0, 9))
>A.getInstance : Symbol(A.getInstance, Decl(privateNameFieldAssignment.ts, 29, 5))
>A : Symbol(A, Decl(privateNameFieldAssignment.ts, 0, 0))
>getInstance : Symbol(A.getInstance, Decl(privateNameFieldAssignment.ts, 29, 5))

A.getInstance().#field >>>= 10;
>A.getInstance().#field : Symbol(A[#field], Decl(privateNameFieldAssignment.ts, 0, 9))
>A.getInstance : Symbol(A.getInstance, Decl(privateNameFieldAssignment.ts, 29, 5))
>A : Symbol(A, Decl(privateNameFieldAssignment.ts, 0, 0))
>getInstance : Symbol(A.getInstance, Decl(privateNameFieldAssignment.ts, 29, 5))

A.getInstance().#field &= 11;
>A.getInstance().#field : Symbol(A[#field], Decl(privateNameFieldAssignment.ts, 0, 9))
>A.getInstance : Symbol(A.getInstance, Decl(privateNameFieldAssignment.ts, 29, 5))
>A : Symbol(A, Decl(privateNameFieldAssignment.ts, 0, 0))
>getInstance : Symbol(A.getInstance, Decl(privateNameFieldAssignment.ts, 29, 5))

A.getInstance().#field |= 12;
>A.getInstance().#field : Symbol(A[#field], Decl(privateNameFieldAssignment.ts, 0, 9))
>A.getInstance : Symbol(A.getInstance, Decl(privateNameFieldAssignment.ts, 29, 5))
>A : Symbol(A, Decl(privateNameFieldAssignment.ts, 0, 0))
>getInstance : Symbol(A.getInstance, Decl(privateNameFieldAssignment.ts, 29, 5))

A.getInstance().#field ^= 13;
>A.getInstance().#field : Symbol(A[#field], Decl(privateNameFieldAssignment.ts, 0, 9))
>A.getInstance : Symbol(A.getInstance, Decl(privateNameFieldAssignment.ts, 29, 5))
>A : Symbol(A, Decl(privateNameFieldAssignment.ts, 0, 0))
>getInstance : Symbol(A.getInstance, Decl(privateNameFieldAssignment.ts, 29, 5))
}
static getInstance() {
>getInstance : Symbol(A.getInstance, Decl(privateNameFieldAssignment.ts, 29, 5))

return new A();
>A : Symbol(A, Decl(privateNameFieldAssignment.ts, 0, 0))
}
}

Loading