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.

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

Add explicit toString() #754

Merged
merged 3 commits into from
Nov 14, 2019
Merged
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
14 changes: 13 additions & 1 deletion baselines/dom.generated.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4026,6 +4026,7 @@ interface DOMMatrixReadOnly {
toJSON(): any;
transformPoint(point?: DOMPointInit): DOMPoint;
translate(tx?: number, ty?: number, tz?: number): DOMMatrix;
toString(): string;
}

declare var DOMMatrixReadOnly: {
Expand All @@ -4034,6 +4035,7 @@ declare var DOMMatrixReadOnly: {
fromFloat32Array(array32: Float32Array): DOMMatrixReadOnly;
fromFloat64Array(array64: Float64Array): DOMMatrixReadOnly;
fromMatrix(other?: DOMMatrixInit): DOMMatrixReadOnly;
toString(): string;
};

/** Provides the ability to parse XML or HTML source code from a string into a DOM Document. */
Expand Down Expand Up @@ -4191,6 +4193,7 @@ interface DOMTokenList {
* Can be set, to change the associated attribute.
*/
value: string;
toString(): string;
/**
* Adds all arguments passed, except those already present.
*
Expand Down Expand Up @@ -7071,6 +7074,7 @@ interface HTMLHyperlinkElementUtils {
host: string;
hostname: string;
href: string;
toString(): string;
readonly origin: string;
password: string;
pathname: string;
Expand Down Expand Up @@ -9924,6 +9928,7 @@ interface Location {
* Can be set, to navigate to the given URL.
*/
href: string;
toString(): string;
/**
* Returns the Location object's URL's origin.
*/
Expand Down Expand Up @@ -10382,10 +10387,10 @@ declare var MediaKeys: {
interface MediaList {
readonly length: number;
mediaText: string;
toString(): string;
appendMedium(medium: string): void;
deleteMedium(medium: string): void;
item(index: number): string | null;
toString(): number;
[index: number]: string;
}

Expand Down Expand Up @@ -12652,6 +12657,7 @@ interface Range extends AbstractRange {
setStartAfter(node: Node): void;
setStartBefore(node: Node): void;
surroundContents(newParent: Node): void;
toString(): string;
readonly END_TO_END: number;
readonly END_TO_START: number;
readonly START_TO_END: number;
Expand All @@ -12665,6 +12671,7 @@ declare var Range: {
readonly END_TO_START: number;
readonly START_TO_END: number;
readonly START_TO_START: number;
toString(): string;
};

interface ReadableByteStreamController {
Expand Down Expand Up @@ -15036,11 +15043,13 @@ interface Selection {
selectAllChildren(node: Node): void;
setBaseAndExtent(anchorNode: Node, anchorOffset: number, focusNode: Node, focusOffset: number): void;
setPosition(node: Node | null, offset?: number): void;
toString(): string;
}

declare var Selection: {
prototype: Selection;
new(): Selection;
toString(): string;
};

interface ServiceUIFrameContext {
Expand Down Expand Up @@ -16045,6 +16054,7 @@ interface URL {
host: string;
hostname: string;
href: string;
toString(): string;
readonly origin: string;
password: string;
pathname: string;
Expand Down Expand Up @@ -16092,12 +16102,14 @@ interface URLSearchParams {
*/
set(name: string, value: string): void;
sort(): void;
toString(): string;
forEach(callbackfn: (value: string, key: string, parent: URLSearchParams) => void, thisArg?: any): void;
}

declare var URLSearchParams: {
prototype: URLSearchParams;
new(init?: string[][] | Record<string, string> | string | URLSearchParams): URLSearchParams;
toString(): string;
};

/** This WebVR API interface represents any VR device supported by this API. It includes generic information such as device IDs and descriptions, as well as methods for starting to present a VR scene, retrieving eye parameters and display capabilities, and other important functionality. */
Expand Down
5 changes: 4 additions & 1 deletion baselines/webworker.generated.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3211,6 +3211,7 @@ interface URL {
host: string;
hostname: string;
href: string;
toString(): string;
readonly origin: string;
password: string;
pathname: string;
Expand Down Expand Up @@ -3255,12 +3256,14 @@ interface URLSearchParams {
*/
set(name: string, value: string): void;
sort(): void;
toString(): string;
forEach(callbackfn: (value: string, key: string, parent: URLSearchParams) => void, thisArg?: any): void;
}

declare var URLSearchParams: {
prototype: URLSearchParams;
new(init?: string[][] | Record<string, string> | string | URLSearchParams): URLSearchParams;
toString(): string;
};

interface WEBGL_color_buffer_float {
Expand Down Expand Up @@ -5389,12 +5392,12 @@ interface WorkerLocation {
readonly host: string;
readonly hostname: string;
readonly href: string;
toString(): string;
readonly origin: string;
readonly pathname: string;
readonly port: string;
readonly protocol: string;
readonly search: string;
toString(): string;
}

declare var WorkerLocation: {
Expand Down
21 changes: 20 additions & 1 deletion src/emitter.ts
Original file line number Diff line number Diff line change
Expand Up @@ -626,6 +626,10 @@ export function emitWebIdl(webidl: Browser.WebIdl, flavor: Flavor) {
const readOnlyModifier = p["read-only"] === 1 && prefix === "" ? "readonly " : "";
printer.printLine(`${prefix}${readOnlyModifier}${p.name}${requiredModifier}: ${pType};`);
}

if (p.stringifier) {
printer.printLine("toString(): string;")
}
}

function emitComments(entity: { comment?: string; deprecated?: 1 }, print: (s: string) => void) {
Expand Down Expand Up @@ -666,7 +670,16 @@ export function emitWebIdl(webidl: Browser.WebIdl, flavor: Flavor) {
case "querySelector": return emitQuerySelectorOverloads(m);
case "querySelectorAll": return emitQuerySelectorAllOverloads(m);
}
emitSignatures(m, prefix, m.name, printLine);

// ignore toString() provided from browser.webidl.preprocessed.json
// to prevent duplication
if (m.name !== "toString") {
emitSignatures(m, prefix, m.name, printLine);

if (m.stringifier) {
printLine("toString(): string;")
}
}
}

function emitSignature(s: Browser.Signature, prefix: string | undefined, name: string | undefined, printLine: (s: string) => void) {
Expand Down Expand Up @@ -698,6 +711,12 @@ export function emitWebIdl(webidl: Browser.WebIdl, flavor: Flavor) {
.sort(compareName)
.forEach(m => emitMethod(prefix, m, conflictedMembers));
}
if (i["anonymous-methods"]) {
const stringifier = i["anonymous-methods"].method.find(m => m.stringifier);
if (stringifier) {
printer.printLine("toString(): string;");
}
}

// The window interface inherited some methods from "Object",
// which need to explicitly exposed
Expand Down
14 changes: 10 additions & 4 deletions src/widlprocess.ts
Original file line number Diff line number Diff line change
Expand Up @@ -145,7 +145,7 @@ function convertInterfaceCommon(i: webidl2.InterfaceType | webidl2.InterfaceMixi
properties!.property[member.name] = prop;
}
}
else if (member.type === "operation" && member.idlType) {
else if (member.type === "operation") {
const operation = convertOperation(member, result.exposed);
const { method } = result.methods;
if (!member.name) {
Expand Down Expand Up @@ -205,18 +205,23 @@ function getNamedConstructor(extAttrs: webidl2.ExtendedAttribute[], parent: stri
}

function convertOperation(operation: webidl2.OperationMemberType, inheritedExposure: string | undefined): Browser.AnonymousMethod | Browser.Method {
if (!operation.idlType) {
const isStringifier = operation.special === "stringifier";
const type =
operation.idlType ? convertIdlType(operation.idlType) :
isStringifier ? { type: "DOMString" } :
undefined;
if (!type) {
throw new Error("Unexpected anonymous operation");
}
return {
name: operation.name || undefined,
signature: [{
...convertIdlType(operation.idlType),
...type,
param: operation.arguments.map(convertArgument)
}],
getter: operation.special === "getter" ? 1 : undefined,
static: operation.special === "static" ? 1 : undefined,
stringifier: operation.special === "stringifier" ? 1 : undefined,
stringifier: isStringifier ? 1 : undefined,
exposed: getExtAttrConcatenated(operation.extAttrs, "Exposed") || inheritedExposure
};
}
Expand Down Expand Up @@ -249,6 +254,7 @@ function convertAttribute(attribute: webidl2.AttributeMemberType, inheritedExpos
name: attribute.name,
...convertIdlType(attribute.idlType),
static: attribute.special === "static" ? 1 : undefined,
stringifier: attribute.special === "stringifier" ? 1 : undefined,
"read-only": attribute.readonly ? 1 : undefined,
"event-handler": isEventHandler ? attribute.name.slice(2) : undefined,
exposed: getExtAttrConcatenated(attribute.extAttrs, "Exposed") || inheritedExposure
Expand Down