Skip to content
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

Implement private variables, getter/setters and methods using Symbols #685

Closed
wants to merge 5 commits into from
Closed

Implement private variables, getter/setters and methods using Symbols #685

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
269a9bb
Add -symbolForPrivates compiler flag.
Sep 29, 2014
40c2631
Emit one __symbol function declaration per file.
Sep 29, 2014
0ab94c4
Change emitMemberAccess to take in the whole member declaration.
Sep 29, 2014
187c0eb
Add functions to get whether a property access is for a private prope…
Sep 29, 2014
0ff1420
Use Symbol for private members.
Sep 29, 2014
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
12 changes: 12 additions & 0 deletions src/compiler/checker.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7587,6 +7587,16 @@ module ts {
return undefined;
}

function isPrivatePropertyAccess(node: PropertyAccess): boolean {
var symbol = getNodeLinks(node).resolvedSymbol;
return symbol && !!forEach(symbol.declarations, declaration => declaration.flags & NodeFlags.Private);
}

function isStaticPropertyAccess(node: PropertyAccess): boolean {
var symbol = getNodeLinks(node).resolvedSymbol;
return symbol && !!forEach(symbol.declarations, declaration => declaration.flags & NodeFlags.Static);
}

// Create a single instance that we can wrap the underlying emitter TextWriter with. That
// way we don't have to allocate a new wrapper every time writeTypeAtLocation and
// writeReturnTypeOfSignatureDeclaration are called.
Expand Down Expand Up @@ -7630,6 +7640,8 @@ module ts {
hasSemanticErrors: hasSemanticErrors,
isDeclarationVisible: isDeclarationVisible,
isImplementationOfOverload: isImplementationOfOverload,
isPrivatePropertyAccess: isPrivatePropertyAccess,
isStaticPropertyAccess: isStaticPropertyAccess,
writeTypeAtLocation: writeTypeAtLocation,
writeReturnTypeOfSignatureDeclaration: writeReturnTypeOfSignatureDeclaration,
isSymbolAccessible: isSymbolAccessible,
Expand Down
5 changes: 5 additions & 0 deletions src/compiler/commandLineParser.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,11 @@ module ts {
type: "boolean",
description: Diagnostics.Do_not_emit_comments_to_output,
},
{
name: "symbolForPrivates",
type: "boolean",
description: Diagnostics.Use_ES6_Symbol_for_private_members,
},
{
name: "sourceMap",
type: "boolean",
Expand Down
1 change: 1 addition & 0 deletions src/compiler/diagnosticInformationMap.generated.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -354,6 +354,7 @@ module ts {
Watch_input_files: { code: 6005, category: DiagnosticCategory.Message, key: "Watch input files." },
Redirect_output_structure_to_the_directory: { code: 6006, category: DiagnosticCategory.Message, key: "Redirect output structure to the directory." },
Do_not_emit_comments_to_output: { code: 6009, category: DiagnosticCategory.Message, key: "Do not emit comments to output." },
Use_ES6_Symbol_for_private_members: { code: 6010, category: DiagnosticCategory.Message, key: "Use ES6 Symbol for private members." },
Specify_ECMAScript_target_version_Colon_ES3_default_or_ES5: { code: 6015, category: DiagnosticCategory.Message, key: "Specify ECMAScript target version: 'ES3' (default), or 'ES5'" },
Specify_module_code_generation_Colon_commonjs_or_amd: { code: 6016, category: DiagnosticCategory.Message, key: "Specify module code generation: 'commonjs' or 'amd'" },
Print_this_message: { code: 6017, category: DiagnosticCategory.Message, key: "Print this message." },
Expand Down
4 changes: 4 additions & 0 deletions src/compiler/diagnosticMessages.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1411,6 +1411,10 @@
"category": "Message",
"code": 6009
},
"Use ES6 Symbol for private members.": {
"category": "Message",
"code": 6010
},
"Specify ECMAScript target version: 'ES3' (default), or 'ES5'": {
"category": "Message",
"code": 6015
Expand Down
95 changes: 84 additions & 11 deletions src/compiler/emitter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,6 +314,7 @@ module ts {
var decreaseIndent = writer.decreaseIndent;

var extendsEmitted = false;
var symbolEmitted = false;

/** write emitted output to disk*/
var writeEmittedFiles = writeJavaScriptFile;
Expand Down Expand Up @@ -944,9 +945,25 @@ module ts {
write(constantValue.toString() + " /* " + identifierToString(node.right) + " */");
}
else {
emit(node.left);
write(".");
emit(node.right);
var rewriteUsingSymbol = compilerOptions.symbolForPrivates && resolver.isPrivatePropertyAccess(node);
if (rewriteUsingSymbol) {
emit(node.left);
if (resolver.isStaticPropertyAccess(node)) {
write("[__symbolstatic_");
emit(node.right);
write("]");
}
else {
write("[__symbol_");
emit(node.right);
write("]");
}
}
else {
emit(node.left);
write(".");
emit(node.right);
}
}
}

Expand Down Expand Up @@ -1510,8 +1527,20 @@ module ts {
writeLine();
emitStart(param);
emitStart(param.name);
write("this.");
emitNode(param.name);
if (compilerOptions.symbolForPrivates && param.flags & NodeFlags.Private) {
if (param.flags & NodeFlags.Static) {
write("this[__symbolstatic_");
}
else {
write("this[__symbol_");
}
emitNode(param.name);
write("]");
}
else {
write("this.");
emitNode(param.name);
}
emitEnd(param.name);
write(" = ");
emit(param.name);
Expand All @@ -1521,15 +1550,25 @@ module ts {
});
}

function emitMemberAccess(memberName: Identifier) {
if (memberName.kind === SyntaxKind.StringLiteral || memberName.kind === SyntaxKind.NumericLiteral) {
function emitMemberAccess(member: Declaration) {
if (member.name.kind === SyntaxKind.StringLiteral || member.name.kind === SyntaxKind.NumericLiteral) {
write("[");
emitNode(memberName);
emitNode(member.name);
write("]");
}
else if (compilerOptions.symbolForPrivates && member.flags & NodeFlags.Private) {
if (member.flags & NodeFlags.Static) {
write("[__symbolstatic_");
}
else {
write("[__symbol_");
}
emitNode(member.name);
write("]");
}
else {
write(".");
emitNode(memberName);
emitNode(member.name);
}
}

Expand All @@ -1546,7 +1585,7 @@ module ts {
else {
write("this");
}
emitMemberAccess((<PropertyDeclaration>member).name);
emitMemberAccess(<PropertyDeclaration>member);
emitEnd((<PropertyDeclaration>member).name);
write(" = ");
emit((<PropertyDeclaration>member).initializer);
Expand All @@ -1572,7 +1611,7 @@ module ts {
if (!(member.flags & NodeFlags.Static)) {
write(".prototype");
}
emitMemberAccess((<MethodDeclaration>member).name);
emitMemberAccess(<MethodDeclaration>member);
emitEnd((<MethodDeclaration>member).name);
write(" = ");
emitStart(member);
Expand Down Expand Up @@ -1653,6 +1692,35 @@ module ts {
emitEnd(node.baseType);
}
writeLine();
if (compilerOptions.symbolForPrivates) {
forEach(node.members, (member: Node) => {
if (member.flags & NodeFlags.Private) {
if (member.flags & NodeFlags.Static) {
write("var __symbolstatic_");
}
else {
write("var __symbol_");
}
emitNode((<Declaration>member).name);
write(" = __symbol(\"");
emitNode((<Declaration>member).name);
write("\");");
writeLine();
}
else if (member.kind === SyntaxKind.Constructor) {
forEach((<ConstructorDeclaration>member).parameters, (parameter: ParameterDeclaration) => {
if ((parameter.flags & NodeFlags.Private) === NodeFlags.Private) {
write("var __symbol_");
emitNode(parameter.name);
write(" = __symbol(\"");
emitNode(parameter.name);
write("\");");
writeLine();
}
});
}
});
}
emitConstructorOfClass();
emitMemberFunctions(node);
emitMemberAssignments(node, NodeFlags.Static);
Expand Down Expand Up @@ -2034,6 +2102,11 @@ module ts {
write("};");
extendsEmitted = true;
}
if (compilerOptions.symbolForPrivates && !symbolEmitted) {
writeLine();
write("var __symbol = (this && this.__symbol) || (1, eval)(\"this\").Symbol || function (name) { return name; };");
symbolEmitted = true;
}
if (isExternalModule(node)) {
if (compilerOptions.module === ModuleKind.AMD) {
emitAMDModule(node, startIndex);
Expand Down
3 changes: 3 additions & 0 deletions src/compiler/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -698,6 +698,8 @@ module ts {
hasSemanticErrors(): boolean;
isDeclarationVisible(node: Declaration): boolean;
isImplementationOfOverload(node: FunctionDeclaration): boolean;
isPrivatePropertyAccess(node: PropertyAccess): boolean;
isStaticPropertyAccess(node: PropertyAccess): boolean;
writeTypeAtLocation(location: Node, enclosingDeclaration: Node, flags: TypeFormatFlags, writer: TextWriter): void;
writeReturnTypeOfSignatureDeclaration(signatureDeclaration: SignatureDeclaration, enclosingDeclaration: Node, flags: TypeFormatFlags, writer: TextWriter): void;
isSymbolAccessible(symbol: Symbol, enclosingDeclaration: Node, meaning: SymbolFlags): SymbolAccessiblityResult;
Expand Down Expand Up @@ -1012,6 +1014,7 @@ module ts {
removeComments?: boolean;
sourceMap?: boolean;
sourceRoot?: string;
symbolForPrivates?: boolean;
target?: ScriptTarget;
version?: boolean;
watch?: boolean;
Expand Down