Skip to content
Merged
Show file tree
Hide file tree
Changes from 16 commits
Commits
Show all changes
26 commits
Select commit Hold shift + click to select a range
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
24 changes: 0 additions & 24 deletions inputfiles/addedTypes.jsonc
Original file line number Diff line number Diff line change
@@ -1,28 +1,4 @@
{
"mixins": {
"mixin": {
"DocumentOrShadowRoot": {
// Manually moved from Document
// See https://github.com/w3c/csswg-drafts/issues/5886 and https://github.com/w3c/csswg-drafts/issues/556
"methods": {
"method": {
"elementFromPoint": {
"name": "elementFromPoint",
"overrideSignatures": [
"elementFromPoint(x: number, y: number): Element | null"
]
},
"elementsFromPoint": {
"name": "elementsFromPoint",
"overrideSignatures": [
"elementsFromPoint(x: number, y: number): Element[]"
]
}
}
}
}
}
},
"interfaces": {
"interface": {
// ImportMeta is not a true DOM interface, but we are forced to declare it as one in order to emit method definitions.
Expand Down
16 changes: 16 additions & 0 deletions inputfiles/patches/cssom-view.kdl
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
// Manually moved from Document
// See https://github.com/w3c/csswg-drafts/issues/5886 and https://github.com/w3c/csswg-drafts/issues/556
interface-mixin DocumentOrShadowRoot {
method elementFromPoint {
type Element nullable=#true
param x type=long
param y type=long
}
method elementsFromPoint {
type sequence {
type Element
}
param x type=long
param y type=long
}
}
55 changes: 54 additions & 1 deletion src/build/patches.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
import { parse, type Value, type Node } from "kdljs";
import type { Enum, Event, Property, Interface, WebIdl } from "./types.js";
import type {
Enum,
Event,
Property,
Interface,
WebIdl,
Method,
} from "./types.js";
import { readdir, readFile } from "fs/promises";
import { merge } from "./helpers.js";

Expand All @@ -25,6 +32,20 @@ function optionalMember<const T>(prop: string, type: T, value?: Value) {
};
}

function handleTyped(type: Node, returnType: string) {
const isTyped = type.name == "type";
const name = isTyped ? (type.values[0] as string) : returnType;
const subType =
type.children.length > 0
? { type: type.children[0].values[0] as string }
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should be a recursive call to handleTyped

: undefined;
return {
type: name,
subtype: subType,
...optionalMember("nullable", "boolean", type.properties?.nullable),
};
}

/**
* Converts patch files in KDL to match the [types](types.d.ts).
*/
Expand Down Expand Up @@ -94,6 +115,7 @@ function handleMixin(node: Node): DeepPartial<Interface> {

const event: Event[] = [];
const property: Record<string, Partial<Property>> = {};
const method: Record<string, Partial<Method>> = {};

for (const child of node.children) {
switch (child.name) {
Expand All @@ -105,6 +127,11 @@ function handleMixin(node: Node): DeepPartial<Interface> {
property[propName] = handleProperty(child);
break;
}
case "method": {
const methodName = child.values[0] as string;
method[methodName] = handleMethod(child);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(Fine for now but eventually this will need to change to support overloads)

break;
}
default:
throw new Error(`Unknown node name: ${child.name}`);
}
Expand All @@ -114,6 +141,7 @@ function handleMixin(node: Node): DeepPartial<Interface> {
name,
events: { event },
properties: { property },
methods: { method },
...optionalMember("extends", "string", node.properties?.extends),
} as DeepPartial<Interface>;
}
Expand Down Expand Up @@ -142,6 +170,31 @@ function handleProperty(child: Node): Partial<Property> {
};
}

/**
* Handles a child node of type "method" and adds it to the method object.
* @param child The child node to handle.
*/
function handleMethod(child: Node): Partial<Method> {
const name = child.values[0] as string;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Too many as string, would be nice to have something like

function string(arg: unknown): string {
  if (typeof arg !== "string") {
    throw new Error(`Expected a string but found ${typeof arg}`);
  }
  return arg;
}

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

const type = child.children[0];
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should iterate and check types than assuming a position or using filter(), otherwise we can't throw on unexpected child. Just like line 120.

const returnType = child.properties.returns as string;

const params = child.children
.filter((c) => c.properties.type)
.map((c) => ({
name: c.values[0] as string,
type: c.properties.type as string,
}));

const signature: Method["signature"] = [
{
param: params,
...handleTyped(type, returnType),
},
];
return { name, signature };
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(This is fine for now but eventually we'll hit a problem when dealing with overloads)

}

/**
* Collect all file URLs in a directory.
*/
Expand Down