Skip to content

Change @:enum to enum #188

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

Open
Geokureli wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Change @:enum to enum #188

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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: 6 additions & 6 deletions assets/content/cookbook/Macros/enum-abstract-values.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
[tags]: / "enum,expression-macro"

# Get all values of an @:enum abstract
# Get all values of an enum abstract

The following macro function returns an array of all possible values of a given `@:enum abstract` type.
The following macro function returns an array of all possible values of a given `enum abstract` type.
Since it's not possible in runtime (because abstracts doesn't exist there), we need to use a macro for that.

## Implementation
Expand All @@ -22,10 +22,10 @@ class AbstractEnumTools {
// compiler will give a error here.
var type = Context.getType(typePath.toString());

// Switch on the type and check if it's an abstract with @:enum metadata
// Switch on the type and check if it's an abstract with enum metadata
switch (type.follow()) {
case TAbstract(_.get() => ab, _) if (ab.meta.has(":enum")):
// @:enum abstract values are actually static fields of the abstract implementation class,
// enum abstract values are actually static fields of the abstract implementation class,
// marked with @:enum and @:impl metadata. We generate an array of expressions that access those fields.
// Note that this is a bit of implementation detail, so it can change in future Haxe versions, but it's been
// stable so far.
Expand All @@ -40,7 +40,7 @@ class AbstractEnumTools {
return macro $a{valueExprs};
default:
// The given type is not an abstract, or doesn't have @:enum metadata, show a nice error message.
throw new Error(type.toString() + " should be @:enum abstract", typePath.pos);
throw new Error(type.toString() + " should be enum abstract", typePath.pos);
}
}
}
Expand All @@ -49,7 +49,7 @@ class AbstractEnumTools {
## Usage

```haxe
@:enum abstract MyEnum(Int) {
enum abstract MyEnum(Int) {
var A = 1;
var B = 2;
var C = 3;
Expand Down