Support unnamed stringifier operations

cscott · cscott · commit 369de9691306 · 2021-05-07T20:01:08.000-04:00
Change-Id: I1d9e2debebe1a8dc253b4ff452352aa79927f391
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,6 @@
 # IDLeDOM x.x.x (not yet released)
 * Add interfaces for HTML IDL, in particular the HTML*Element classes.
-* Support "unnamed" getter/setters/deleters.
+* Support "unnamed" getter/setters/deleters/stringifiers.
 
 # IDLeDOM 0.3.0 (2021-04-12)
 * Use interface (instead of class) for enumerations.  This allows
diff --git a/WebIDL.md b/WebIDL.md
@@ -83,9 +83,10 @@ reserved. (These are used to implement [`IteratorAggregate`] and
 [`Countable`].)
 
 If the WebIDL defines an "unnamed" indexed getter, named getter,
-indexed setter, named setter, indexed deleter or named deleter,
-the names `item`, `namedItem`, `setItem`, `setNamedItem`, `removeItem`,
-or `removeNamedItem` (respectively) are reserved.
+indexed setter, named setter, indexed deleter, named deleter, or
+stringifier operation, then the names `item`, `namedItem`, `setItem`,
+`setNamedItem`, `removeItem`, `removeNamedItem`, or `toString`
+(respectively) are reserved.
 
 ### Resolution order
 
diff --git a/src/Helper/Range.php b/src/Helper/Range.php
@@ -65,4 +65,13 @@ public function __isset( string $name ) : bool {
 		return false;
 	}
 
+	/**
+	 * @return string
+	 */
+	public function __toString() : string {
+		'@phan-var \Wikimedia\IDLeDOM\Range $this';
+		// @var \Wikimedia\IDLeDOM\Range $this
+		return $this->toString();
+	}
+
 }
diff --git a/src/Range.php b/src/Range.php
@@ -157,4 +157,9 @@ public function comparePoint( /* Node */ $node, int $offset ) : int;
 	 */
 	public function intersectsNode( /* Node */ $node ) : bool;
 
+	/**
+	 * @return string
+	 */
+	public function toString() : string;
+
 }
diff --git a/src/Stub/Range.php b/src/Stub/Range.php
@@ -190,4 +190,11 @@ public function intersectsNode( /* Node */ $node ) : bool {
 		throw self::_unimplemented();
 	}
 
+	/**
+	 * @return string
+	 */
+	public function toString() : string {
+		throw self::_unimplemented();
+	}
+
 }
diff --git a/tools/Generator.php b/tools/Generator.php
@@ -260,22 +260,32 @@ private function resolveNames( array &$def, array &$done ): array {
 				( $m['name'] ?? '' ) === '' &&
 				( $m['special'] ?? '' ) !== '' ) {
 				if ( $m['special'] === 'stringifier' ) {
-					// XXX unnamed stringifier
-					continue;
-				}
-				if ( count( $m['arguments'] ?? [] ) === 0 ) {
+					// unnamed stringifier operation
+					$which = "stringifier";
+					$m['idlType'] = [
+						'idlType' => 'DOMString',
+						'type' => null,
+						'extAttrs' => [],
+						'generic' => '',
+						'nullable' => false,
+						'union' => false,
+					];
+				} elseif ( count( $m['arguments'] ?? [] ) === 0 ) {
 					continue;
+				} else {
+					$firstArgType = $m['arguments'][0]['idlType']['idlType'];
+					$which = ( (
+						$firstArgType === "unsigned long"
+					) ? "indexed " : "named " ) . ( $m['special'] ?? '' );
 				}
-				$which = ( (
-					$m['arguments'][0]['idlType']['idlType'] === "unsigned long"
-				) ? "indexed " : "named " ) . ( $m['special'] ?? '' );
 				$names = [
 					"indexed getter" => "item",
 					"named getter" => "namedItem",
 					"indexed setter" => "setItem",
 					"named setter" => "setNamedItem",
 					"indexed deleter" => "removeItem",
 					"named deleter" => "removeNamedItem",
+					"stringifier" => "toString",
 				];
 				$m['name'] = $names[$which] ?? '';
 			}

Original file line number	Diff line number	Diff line change
`@@ -65,4 +65,13 @@ public function __isset( string $name ) : bool {`
`65`	`65`	`return false;`
`66`	`66`	`}`
`67`	`67`
	`68`	`+ /**`
	`69`	`+ * @return string`
	`70`	`+ */`
	`71`	`+ public function __toString() : string {`
	`72`	`+ '@phan-var \Wikimedia\IDLeDOM\Range $this';`
	`73`	`+ // @var \Wikimedia\IDLeDOM\Range $this`
	`74`	`+ return $this->toString();`
	`75`	`+ }`
	`76`	`+`
`68`	`77`	`}`
Original file line number	Diff line number	Diff line change
`@@ -157,4 +157,9 @@ public function comparePoint( /* Node */ $node, int $offset ) : int;`
`157`	`157`	`*/`
`158`	`158`	`public function intersectsNode( /* Node */ $node ) : bool;`
`159`	`159`
	`160`	`+ /**`
	`161`	`+ * @return string`
	`162`	`+ */`
	`163`	`+ public function toString() : string;`
	`164`	`+`
`160`	`165`	`}`
Original file line number	Diff line number	Diff line change
`@@ -190,4 +190,11 @@ public function intersectsNode( /* Node */ $node ) : bool {`
`190`	`190`	`throw self::_unimplemented();`
`191`	`191`	`}`
`192`	`192`
	`193`	`+ /**`
	`194`	`+ * @return string`
	`195`	`+ */`
	`196`	`+ public function toString() : string {`
	`197`	`+ throw self::_unimplemented();`
	`198`	`+ }`
	`199`	`+`
`193`	`200`	`}`