Skip to content
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
2 changes: 2 additions & 0 deletions crates/oxc_data_structures/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ all = [
"assert_unchecked",
"box_macros",
"code_buffer",
"fieldless_enum",
"inline_string",
"rope",
"slice_iter",
Expand All @@ -38,6 +39,7 @@ all = [
assert_unchecked = []
box_macros = []
code_buffer = ["assert_unchecked"]
fieldless_enum = []
inline_string = ["assert_unchecked"]
rope = ["dep:ropey"]
slice_iter = ["assert_unchecked"]
Expand Down
1 change: 1 addition & 0 deletions crates/oxc_data_structures/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ This crate provides specialized data structures and utilities that are used thro
- **Slice iterators**: Enhanced iteration capabilities for slices
- **Rope data structure**: Efficient text manipulation for large documents
- **Box macros**: Macros for creating boxed arrays / slices (similar to `vec!` macro)
- **Fieldless enums macro**: Macro for creating enums with a `VARIANTS` constant listing all variants

## Architecture

Expand Down
147 changes: 147 additions & 0 deletions crates/oxc_data_structures/src/fieldless_enum.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
/// Macro to define a fieldless enum with a `VARIANTS` constant listing all variants in declaration order.
///
/// Wraps the enum definition and adds:
///
/// ```ignore
/// impl EnumName {
/// pub const VARIANTS: [EnumName; N] = [EnumName::A, EnumName::B, ...];
/// }
/// ```
#[macro_export]
macro_rules! fieldless_enum {
(
$(#[$meta:meta])*
$vis:vis enum $name:ident {
$(
$(#[$variant_meta:meta])*
$variant:ident $(= $discriminant:expr)?
),* $(,)?
}
) => {
$(#[$meta])*
$vis enum $name {
$(
$(#[$variant_meta])*
$variant $(= $discriminant)?
),*
}

impl $name {
/// All variants in declaration order.
$vis const VARIANTS: [$name; <[&str]>::len(&[$(stringify!($variant)),*])] = [
$($name::$variant),*
];
}
};
}

pub use fieldless_enum;

#[cfg(test)]
mod tests {
#[test]
fn basic() {
fieldless_enum! {
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
enum Color {
Red,
Green,
Blue,
}
}

assert_eq!(Color::VARIANTS.len(), 3);
assert_eq!(Color::VARIANTS, [Color::Red, Color::Green, Color::Blue]);
}

#[test]
fn explicit_discriminants() {
const PENDING: u8 = 10;

fieldless_enum! {
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[repr(u8)]
enum Status {
Active = 1,
Inactive = 5,
Pending = PENDING,
}
}

assert_eq!(Status::VARIANTS.len(), 3);
assert_eq!(Status::VARIANTS, [Status::Active, Status::Inactive, Status::Pending]);
assert_eq!(Status::Active as u8, 1);
assert_eq!(Status::Inactive as u8, 5);
assert_eq!(Status::Pending as u8, 10);
}

#[test]
fn variant_attributes() {
fieldless_enum! {
#[derive(Debug, Default, Clone, Copy, PartialEq, Eq)]
enum WithDefault {
#[default]
First,
Second,
}
}

assert_eq!(WithDefault::default(), WithDefault::First);
assert_eq!(WithDefault::VARIANTS, [WithDefault::First, WithDefault::Second]);
}

#[test]
fn single_variant() {
fieldless_enum! {
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
enum Unit {
Only,
}
}

assert_eq!(Unit::VARIANTS.len(), 1);
assert_eq!(Unit::VARIANTS, [Unit::Only]);
}

#[test]
fn zero_variants() {
fieldless_enum! {
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
enum Never {}
}

assert_eq!(Never::VARIANTS.len(), 0);
assert_eq!(Never::VARIANTS, []);
}

#[test]
fn declaration_order() {
fieldless_enum! {
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
#[repr(u8)]
enum Shuffled {
C = 2,
A = 0,
B = 1,
}
}

// `VARIANTS` follows declaration order, not discriminant order
assert_eq!(Shuffled::VARIANTS, [Shuffled::C, Shuffled::A, Shuffled::B]);
}

#[test]
fn visibility() {
mod inner {
fieldless_enum! {
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum Visible {
A,
B,
}
}
}

assert_eq!(inner::Visible::VARIANTS.len(), 2);
}
}
3 changes: 3 additions & 0 deletions crates/oxc_data_structures/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@ pub mod box_macros;
#[cfg(feature = "code_buffer")]
pub mod code_buffer;

#[cfg(feature = "fieldless_enum")]
pub mod fieldless_enum;

#[cfg(feature = "inline_string")]
pub mod inline_string;

Expand Down
Loading