16401140698

Committed 20 Jul 2025 02:13PM UTC coverage: 26.945% (+1.2%) from 25.766%

Build # 16401140698

Build Type

Pull #489

github

Committed by

Xenira

Commit Message

refactor(enum): use raii box pattern for enum values

Refs: #178

Pull Request Pull Request #489: feat(enum): add basic enum support

Run Details

118 of 288 new or added lines in 7 files covered. (40.97%)

1 existing line in 1 file now uncovered.

1115 of 4138 relevant lines covered (26.95%)

5.64 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

29.79

/src/builders/enum_builder.rs

use std::{ffi::CString, ptr};

use crate::{
    builders::FunctionBuilder,
    convert::IntoZval,
    describe::DocComments,
    enum_::{Discriminant, EnumCase},
    error::Result,
    ffi::{zend_enum_add_case, zend_register_internal_enum},
    flags::{DataType, MethodFlags},
    types::{ZendStr, Zval},
    zend::{ClassEntry, FunctionEntry},
};

/// A builder for PHP enums.
#[must_use]
pub struct EnumBuilder {
    pub(crate) name: String,
    pub(crate) methods: Vec<(FunctionBuilder<'static>, MethodFlags)>,
    pub(crate) cases: Vec<&'static EnumCase>,
    pub(crate) datatype: DataType,
    register: Option<fn(&'static mut ClassEntry)>,
    pub(crate) docs: DocComments,
}

impl EnumBuilder {
    /// Creates a new enum builder with the given name.
    pub fn new<T: Into<String>>(name: T) -> Self {
        Self {
            name: name.into(),
            methods: Vec::default(),
            cases: Vec::default(),
            datatype: DataType::Undef,
            register: None,
            docs: DocComments::default(),
        }
    }

    /// Adds an enum case to the enum.
    ///
    /// # Panics
    ///
    /// If the case's data type does not match the enum's data type
    pub fn case(mut self, case: &'static EnumCase) -> Self {
        let data_type = case.data_type();
        assert!(
            data_type == self.datatype || self.cases.is_empty(),
            "Cannot add case with data type {:?} to enum with data type {:?}",
            data_type,
            self.datatype
        );

        self.datatype = data_type;
        self.cases.push(case);

        self
    }

    /// Adds a method to the enum.
    pub fn method(mut self, method: FunctionBuilder<'static>, flags: MethodFlags) -> Self {
        self.methods.push((method, flags));
        self
    }

    /// Function to register the class with PHP. This function is called after
    /// the class is built.
    ///
    /// # Parameters
    ///
    /// * `register` - The function to call to register the class.
    pub fn registration(mut self, register: fn(&'static mut ClassEntry)) -> Self {
        self.register = Some(register);
        self
    }

    /// Add documentation comments to the enum.
    pub fn docs(mut self, docs: DocComments) -> Self {
        self.docs = docs;
        self
    }

    /// Registers the enum with PHP.
    ///
    /// # Panics
    ///
    /// If the registration function was not set prior to calling this
    /// method.
    ///
    /// # Errors
    ///
    /// If the enum could not be registered, e.g. due to an invalid name or
    /// data type.
    pub fn register(self) -> Result<()> {
        let mut methods = self
            .methods
            .into_iter()
            .map(|(method, flags)| {
                method.build().map(|mut method| {
                    method.flags |= flags.bits();
                    method
                })
            })
            .collect::<Result<Vec<_>>>()?;
        methods.push(FunctionEntry::end());

        let class = unsafe {
            zend_register_internal_enum(
                CString::new(self.name)?.as_ptr(),
                self.datatype.as_u32().try_into()?,
                methods.into_boxed_slice().as_ptr(),
            )
        };

        for case in self.cases {
            let name = ZendStr::new_interned(case.name, true);
            let value = match &case.discriminant {
                Some(value) => Self::create_enum_value(value)?,
                None => ptr::null_mut(),
            };
            unsafe {
                zend_enum_add_case(class, name.into_raw(), value);
            }
        }

        if let Some(register) = self.register {
            register(unsafe { &mut *class });
        } else {
            panic!("Enum was not registered with a registration function",);
        }

        Ok(())
    }

    fn create_enum_value(discriminant: &Discriminant) -> Result<*mut Zval> {
        let value: Zval = match discriminant {
            Discriminant::Int(i) => i.into_zval(false)?,
            Discriminant::String(s) => s.into_zval(true)?,
        };

        let boxed_value = Box::new(value);
        Ok(Box::into_raw(boxed_value).cast())
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::enum_::Discriminant;

    const case1: EnumCase = EnumCase {
        name: "Variant1",
        discriminant: None,
        docs: &[],
    };
    const case2: EnumCase = EnumCase {
        name: "Variant2",
        discriminant: Some(Discriminant::Int(42)),
        docs: &[],
    };
    const case3: EnumCase = EnumCase {
        name: "Variant3",
        discriminant: Some(Discriminant::String("foo")),
        docs: &[],
    };

    #[test]
    fn test_new_enum_builder() {
        let builder = EnumBuilder::new("MyEnum");
        assert_eq!(builder.name, "MyEnum");
        assert!(builder.methods.is_empty());
        assert!(builder.cases.is_empty());
        assert_eq!(builder.datatype, DataType::Undef);
        assert!(builder.register.is_none());
    }

    #[test]
    fn test_enum_case() {
        let builder = EnumBuilder::new("MyEnum").case(&case1);
        assert_eq!(builder.cases.len(), 1);
        assert_eq!(builder.cases[0].name, "Variant1");
        assert_eq!(builder.datatype, DataType::Undef);

        let builder = EnumBuilder::new("MyEnum").case(&case2);
        assert_eq!(builder.cases.len(), 1);
        assert_eq!(builder.cases[0].name, "Variant2");
        assert_eq!(builder.cases[0].discriminant, Some(Discriminant::Int(42)));
        assert_eq!(builder.datatype, DataType::Long);

        let builder = EnumBuilder::new("MyEnum").case(&case3);
        assert_eq!(builder.cases.len(), 1);
        assert_eq!(builder.cases[0].name, "Variant3");
        assert_eq!(
            builder.cases[0].discriminant,
            Some(Discriminant::String("foo"))
        );
        assert_eq!(builder.datatype, DataType::String);
    }

    #[test]
    #[should_panic(expected = "Cannot add case with data type Long to enum with data type Undef")]
    fn test_enum_case_mismatch() {
        #[allow(unused_must_use)]
        EnumBuilder::new("MyEnum").case(&case1).case(&case2); // This should panic because case2 has a different data type
    }

    const docs: DocComments = &["This is a test enum"];
    #[test]
    fn test_docs() {
        let builder = EnumBuilder::new("MyEnum").docs(docs);
        assert_eq!(builder.docs.len(), 1);
        assert_eq!(builder.docs[0], "This is a test enum");
    }
}

1	use std::{ffi::CString, ptr};
2
3	use crate::{
4	builders::FunctionBuilder,
5	convert::IntoZval,
6	describe::DocComments,
7	enum_::{Discriminant, EnumCase},
8	error::Result,
9	ffi::{zend_enum_add_case, zend_register_internal_enum},
10	flags::{DataType, MethodFlags},
11	types::{ZendStr, Zval},
12	zend::{ClassEntry, FunctionEntry},
13	};
14
15	/// A builder for PHP enums.
16	#[must_use]
17	pub struct EnumBuilder {
18	pub(crate) name: String,
19	pub(crate) methods: Vec<(FunctionBuilder<'static>, MethodFlags)>,
20	pub(crate) cases: Vec<&'static EnumCase>,
21	pub(crate) datatype: DataType,
22	register: Option<fn(&'static mut ClassEntry)>,
23	pub(crate) docs: DocComments,
24	}
25
26	impl EnumBuilder {
27	/// Creates a new enum builder with the given name.
28	pub fn new<T: Into<String>>(name: T) -> Self {	6✔
29	Self {
30	name: name.into(),	18✔
31	methods: Vec::default(),	12✔
32	cases: Vec::default(),	12✔
33	datatype: DataType::Undef,
34	register: None,
35	docs: DocComments::default(),	6✔
36	}
37	}
38
39	/// Adds an enum case to the enum.
40	///
41	/// # Panics
42	///
43	/// If the case's data type does not match the enum's data type
44	pub fn case(mut self, case: &'static EnumCase) -> Self {	5✔
45	let data_type = case.data_type();	15✔
46	assert!(	5✔
47	data_type == self.datatype \|\| self.cases.is_empty(),	8✔
48	"Cannot add case with data type {:?} to enum with data type {:?}",	1✔
49	data_type,
50	self.datatype
51	);
52
53	self.datatype = data_type;	4✔
54	self.cases.push(case);
55
56	self
57	}
58
59	/// Adds a method to the enum.
NEW 60	pub fn method(mut self, method: FunctionBuilder<'static>, flags: MethodFlags) -> Self {	×
NEW 61	self.methods.push((method, flags));	×
NEW 62	self	×
63	}
64
65	/// Function to register the class with PHP. This function is called after
66	/// the class is built.
67	///
68	/// # Parameters
69	///
70	/// * `register` - The function to call to register the class.
NEW 71	pub fn registration(mut self, register: fn(&'static mut ClassEntry)) -> Self {	×
NEW 72	self.register = Some(register);	×
NEW 73	self	×
74	}
75
76	/// Add documentation comments to the enum.
77	pub fn docs(mut self, docs: DocComments) -> Self {	1✔
78	self.docs = docs;	1✔
79	self	1✔
80	}
81
82	/// Registers the enum with PHP.
83	///
84	/// # Panics
85	///
86	/// If the registration function was not set prior to calling this
87	/// method.
88	///
89	/// # Errors
90	///
91	/// If the enum could not be registered, e.g. due to an invalid name or
92	/// data type.
NEW 93	pub fn register(self) -> Result<()> {	×
NEW 94	let mut methods = self	×
NEW 95	.methods	×
96	.into_iter()
NEW 97	.map(\|(method, flags)\| {	×
NEW 98	method.build().map(\|mut method\| {	×
NEW 99	method.flags \|= flags.bits();	×
NEW 100	method	×
101	})
102	})
103	.collect::<Result<Vec<_>>>()?;
NEW 104	methods.push(FunctionEntry::end());	×
105
106	let class = unsafe {
107	zend_register_internal_enum(
NEW 108	CString::new(self.name)?.as_ptr(),	×
NEW 109	self.datatype.as_u32().try_into()?,	×
NEW 110	methods.into_boxed_slice().as_ptr(),	×
111	)
112	};
113
NEW 114	for case in self.cases {	×
NEW 115	let name = ZendStr::new_interned(case.name, true);	×
NEW 116	let value = match &case.discriminant {	×
NEW 117	Some(value) => Self::create_enum_value(value)?,	×
NEW 118	None => ptr::null_mut(),	×
119	};
120	unsafe {
NEW 121	zend_enum_add_case(class, name.into_raw(), value);	×
122	}
123	}
124
NEW 125	if let Some(register) = self.register {	×
NEW 126	register(unsafe { &mut *class });	×
127	} else {
NEW 128	panic!("Enum was not registered with a registration function",);	×
129	}
130
NEW 131	Ok(())	×
132	}
133
NEW 134	fn create_enum_value(discriminant: &Discriminant) -> Result<*mut Zval> {	×
NEW 135	let value: Zval = match discriminant {	×
NEW 136	Discriminant::Int(i) => i.into_zval(false)?,	×
NEW 137	Discriminant::String(s) => s.into_zval(true)?,	×
138	};
139
NEW 140	let boxed_value = Box::new(value);	×
NEW 141	Ok(Box::into_raw(boxed_value).cast())	×
142	}
143	}
144
145	#[cfg(test)]
146	mod tests {
147	use super::*;
148	use crate::enum_::Discriminant;
149
150	const case1: EnumCase = EnumCase {
151	name: "Variant1",
152	discriminant: None,
153	docs: &[],
154	};
155	const case2: EnumCase = EnumCase {
156	name: "Variant2",
157	discriminant: Some(Discriminant::Int(42)),
158	docs: &[],
159	};
160	const case3: EnumCase = EnumCase {
161	name: "Variant3",
162	discriminant: Some(Discriminant::String("foo")),
163	docs: &[],
164	};
165
166	#[test]
167	fn test_new_enum_builder() {
168	let builder = EnumBuilder::new("MyEnum");
169	assert_eq!(builder.name, "MyEnum");
170	assert!(builder.methods.is_empty());
171	assert!(builder.cases.is_empty());
172	assert_eq!(builder.datatype, DataType::Undef);
173	assert!(builder.register.is_none());
174	}
175
176	#[test]
177	fn test_enum_case() {
178	let builder = EnumBuilder::new("MyEnum").case(&case1);
179	assert_eq!(builder.cases.len(), 1);
180	assert_eq!(builder.cases[0].name, "Variant1");
181	assert_eq!(builder.datatype, DataType::Undef);
182
183	let builder = EnumBuilder::new("MyEnum").case(&case2);
184	assert_eq!(builder.cases.len(), 1);
185	assert_eq!(builder.cases[0].name, "Variant2");
186	assert_eq!(builder.cases[0].discriminant, Some(Discriminant::Int(42)));
187	assert_eq!(builder.datatype, DataType::Long);
188
189	let builder = EnumBuilder::new("MyEnum").case(&case3);
190	assert_eq!(builder.cases.len(), 1);
191	assert_eq!(builder.cases[0].name, "Variant3");
192	assert_eq!(
193	builder.cases[0].discriminant,
194	Some(Discriminant::String("foo"))
195	);
196	assert_eq!(builder.datatype, DataType::String);
197	}
198
199	#[test]
200	#[should_panic(expected = "Cannot add case with data type Long to enum with data type Undef")]
201	fn test_enum_case_mismatch() {
202	#[allow(unused_must_use)]
203	EnumBuilder::new("MyEnum").case(&case1).case(&case2); // This should panic because case2 has a different data type
204	}
205
206	const docs: DocComments = &["This is a test enum"];
207	#[test]
208	fn test_docs() {
209	let builder = EnumBuilder::new("MyEnum").docs(docs);
210	assert_eq!(builder.docs.len(), 1);
211	assert_eq!(builder.docs[0], "This is a test enum");
212	}
213	}

davidcole1340 / ext-php-rs / 16401140698

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous