Use interfaces (instead of classes) for enumerations

cscott · cscott · commit 071976644dec · 2021-02-12T23:54:42.000-05:00
Also update WebIDL.md to describe enumeration types better.

Change-Id: I2bb0d4da076a8aaf9260150ec35c349a45429c8a
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,7 @@
 # IDLeDOM x.x.x (not yet released)
+* Use interface (instead of class) for enumerations.  This allows
+  DOM implementations to easily define a class implementing the interface
+  to bring the constants into the implementation's namespace.
 
 # IDLeDOM 0.2.0 (2021-02-12)
 * Strip explicit PHP type hints for DOM interface types, in order to
diff --git a/WebIDL.md b/WebIDL.md
@@ -228,6 +228,13 @@ type])(https://www.php.net/manual/en/language.types.object.php).
 
 The IDL [`symbol`] type is not supported.
 
+### Enumerations
+
+IDL [enumeration](https://heycam.github.io/webidl/#idl-enums) types
+correspond to the PHP `int` type.  (There is a PHP interface created
+to hold the enumeration values as class constants, but enumeration
+values are `int`s, not objects implementing this interface.)
+
 ## Objects implementing interfaces
 
 A PHP object that implements an IDL [interface] must be of a PHP class
diff --git a/src/ShadowRootMode.php b/src/ShadowRootMode.php
@@ -12,7 +12,7 @@
  *
  * @phan-forbid-undeclared-magic-properties
  */
-class ShadowRootMode {
+interface ShadowRootMode {
 	public const open = 0;
 	public const closed = 1;
 }
diff --git a/tools/InterfaceBuilder.php b/tools/InterfaceBuilder.php
@@ -258,7 +258,7 @@ protected function emitCallback( string $topName, array $def ): void {
 
 	/** @inheritDoc */
 	protected function emitEnum( string $topName, array $def ): void {
-		$this->firstLine( 'class', $topName, $def );
+		$this->firstLine( 'interface', $topName, $def );
 		// Treat enumerations like interfaces with const members
 		$val = 0;
 		foreach ( $def['values'] as $m ) {

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@`
`12`	`12`	`*`
`13`	`13`	`* @phan-forbid-undeclared-magic-properties`
`14`	`14`	`*/`
`15`		`-class ShadowRootMode {`
	`15`	`+interface ShadowRootMode {`
`16`	`16`	`public const open = 0;`
`17`	`17`	`public const closed = 1;`
`18`	`18`	`}`