Added ability to register constants (#22)

Author: davidcole1340

README.md

@@ -14,7 +14,7 @@ This is not a set feature list, but these are the features on my roadmap. Create
     - [x] Class methods
     - [ ] Class properties
     - [x] Class constants
-- [ ] Module constants
+- [x] Module constants
 - [x] Calling PHP functions
 
 ## Requirements

example/skel/src/lib.rs

@@ -3,6 +3,7 @@ use ext_php_rs::{
     php::{
         args::{Arg, ArgParser},
         class::{ClassBuilder, ClassEntry},
+        constants::IntoConst,
         enums::DataType,
         exceptions::throw,
         execution_data::ExecutionData,
@@ -79,7 +80,7 @@ impl Default for Test {
 }
 
 #[no_mangle]
-pub extern "C" fn module_init(_type: i32, _module_number: i32) -> i32 {
+pub extern "C" fn module_init(_type: i32, module_number: i32) -> i32 {
     // object_handlers_init!(Test);
 
     ClassBuilder::new("TestClass")
@@ -106,6 +107,9 @@ pub extern "C" fn module_init(_type: i32, _module_number: i32) -> i32 {
         .object_override::<Test>()
         .build();
 
+    "Test constant".register_constant("SKEL_TEST_CONST", module_number);
+    1234.register_constant("SKEL_TEST_LONG_CONST", module_number);
+
     0
 }
 

example/skel/test.php

@@ -1,5 +1,8 @@
 <?php
 
+var_dump(SKEL_TEST_CONST, SKEL_TEST_LONG_CONST);
+die;
+
 $x = new TestClass();
 
 skeleton_version(1, 2);

src/php/constants.rs

@@ -0,0 +1,155 @@
+use super::flags::GlobalConstantFlags;
+use crate::{
+    bindings::{
+        zend_register_bool_constant, zend_register_double_constant, zend_register_long_constant,
+        zend_register_string_constant,
+    },
+    functions::c_str,
+};
+
+pub trait IntoConst: Sized {
+    /// Registers a global module constant in PHP, with the value as the content of self.
+    /// This function _must_ be called in the module startup function, which is called after
+    /// the module is initialized. The second parameter of the startup function will be the
+    /// module number. By default, the case-insensitive and persistent flags are set when
+    /// registering the constant.
+    ///
+    /// # Parameters
+    ///
+    /// * `name` - The name of the constant.
+    /// * `module_number` - The module number that we are registering the constant under.
+    ///
+    /// # Examples
+    ///
+    /// ```no_run
+    /// use ext_php_rs::php::{constants::IntoConst, flags::ZendResult};
+    ///
+    /// pub extern "C" fn startup_function(_type: i32, module_number: i32) -> i32 {
+    ///     5.register_constant("MY_CONST_NAME", module_number); // MY_CONST_NAME == 5
+    ///     "Hello, world!".register_constant("STRING_CONSTANT", module_number); // STRING_CONSTANT == "Hello, world!"
+    ///     0
+    /// }
+    /// ```
+    fn register_constant<N: AsRef<str>>(&self, name: N, module_number: i32) {
+        self.register_constant_flags(
+            name,
+            module_number,
+            GlobalConstantFlags::CaseSensitive | GlobalConstantFlags::Persistent,
+        )
+    }
+
+    /// Registers a global module constant in PHP, with the value as the content of self.
+    /// This function _must_ be called in the module startup function, which is called after
+    /// the module is initialized. The second parameter of the startup function will be the
+    /// module number. This function allows you to pass any extra flags in if you require.
+    /// Note that the case-sensitive and persistent flags *are not* set when you use this function,
+    /// you must set these yourself.
+    ///
+    /// # Parameters
+    ///
+    /// * `name` - The name of the constant.
+    /// * `module_number` - The module number that we are registering the constant under.
+    /// * `flags` - Flags to register the constant with.
+    ///
+    /// # Examples
+    ///
+    /// ```no_run
+    /// use ext_php_rs::php::{constants::IntoConst, flags::{GlobalConstantFlags, ZendResult}};
+    ///
+    /// pub extern "C" fn startup_function(_type: i32, module_number: i32) -> i32 {
+    ///     42.register_constant_flags("MY_CONST_NAME", module_number, GlobalConstantFlags::Persistent | GlobalConstantFlags::Deprecated);
+    ///     0
+    /// }
+    /// ```
+    fn register_constant_flags<N: AsRef<str>>(
+        &self,
+        name: N,
+        module_number: i32,
+        flags: GlobalConstantFlags,
+    );
+}
+
+impl IntoConst for String {
+    fn register_constant_flags<N: AsRef<str>>(
+        &self,
+        name: N,
+        module_number: i32,
+        flags: GlobalConstantFlags,
+    ) {
+        self.as_str()
+            .register_constant_flags(name, module_number, flags);
+    }
+}
+
+impl IntoConst for &str {
+    fn register_constant_flags<N: AsRef<str>>(
+        &self,
+        name: N,
+        module_number: i32,
+        flags: GlobalConstantFlags,
+    ) {
+        let name = name.as_ref();
+        unsafe {
+            zend_register_string_constant(
+                c_str(name),
+                name.len() as _,
+                c_str(self),
+                flags.bits() as _,
+                module_number,
+            )
+        };
+    }
+}
+
+impl IntoConst for bool {
+    fn register_constant_flags<N: AsRef<str>>(
+        &self,
+        name: N,
+        module_number: i32,
+        flags: GlobalConstantFlags,
+    ) {
+        let name = name.as_ref();
+        unsafe {
+            zend_register_bool_constant(
+                c_str(name),
+                name.len() as _,
+                *self,
+                flags.bits() as _,
+                module_number,
+            )
+        }
+    }
+}
+
+/// Implements the `IntoConst` trait for a given number type using a given function.
+#[macro_use]
+macro_rules! into_const_num {
+    ($type: ty, $fn: expr) => {
+        impl IntoConst for $type {
+            fn register_constant_flags<N: AsRef<str>>(
+                &self,
+                name: N,
+                module_number: i32,
+                flags: GlobalConstantFlags,
+            ) {
+                let name = name.as_ref();
+                unsafe {
+                    $fn(
+                        c_str(name),
+                        name.len() as _,
+                        *self as _,
+                        flags.bits() as _,
+                        module_number,
+                    )
+                };
+            }
+        }
+    };
+}
+
+into_const_num!(i8, zend_register_long_constant);
+into_const_num!(i16, zend_register_long_constant);
+into_const_num!(i32, zend_register_long_constant);
+into_const_num!(i64, zend_register_long_constant);
+into_const_num!(f32, zend_register_double_constant);
+into_const_num!(f64, zend_register_double_constant);

src/php/flags.rs

@@ -3,18 +3,19 @@
 use bitflags::bitflags;
 
 use crate::bindings::{
-    ZEND_ACC_ABSTRACT, ZEND_ACC_ANON_CLASS, ZEND_ACC_CALL_VIA_TRAMPOLINE, ZEND_ACC_CHANGED,
-    ZEND_ACC_CLOSURE, ZEND_ACC_CONSTANTS_UPDATED, ZEND_ACC_CTOR, ZEND_ACC_DEPRECATED,
-    ZEND_ACC_DONE_PASS_TWO, ZEND_ACC_EARLY_BINDING, ZEND_ACC_FAKE_CLOSURE, ZEND_ACC_FINAL,
-    ZEND_ACC_GENERATOR, ZEND_ACC_HAS_FINALLY_BLOCK, ZEND_ACC_HAS_RETURN_TYPE,
-    ZEND_ACC_HAS_TYPE_HINTS, ZEND_ACC_HAS_UNLINKED_USES, ZEND_ACC_HEAP_RT_CACHE,
-    ZEND_ACC_IMMUTABLE, ZEND_ACC_IMPLICIT_ABSTRACT_CLASS, ZEND_ACC_INTERFACE, ZEND_ACC_LINKED,
-    ZEND_ACC_NEARLY_LINKED, ZEND_ACC_NEVER_CACHE, ZEND_ACC_NO_DYNAMIC_PROPERTIES,
-    ZEND_ACC_PRELOADED, ZEND_ACC_PRIVATE, ZEND_ACC_PROMOTED, ZEND_ACC_PROPERTY_TYPES_RESOLVED,
-    ZEND_ACC_PROTECTED, ZEND_ACC_PUBLIC, ZEND_ACC_RESOLVED_INTERFACES, ZEND_ACC_RESOLVED_PARENT,
-    ZEND_ACC_RETURN_REFERENCE, ZEND_ACC_REUSE_GET_ITERATOR, ZEND_ACC_STATIC, ZEND_ACC_STRICT_TYPES,
-    ZEND_ACC_TOP_LEVEL, ZEND_ACC_TRAIT, ZEND_ACC_TRAIT_CLONE, ZEND_ACC_UNRESOLVED_VARIANCE,
-    ZEND_ACC_USES_THIS, ZEND_ACC_USE_GUARDS, ZEND_ACC_VARIADIC, ZEND_HAS_STATIC_IN_METHODS,
+    CONST_CS, CONST_DEPRECATED, CONST_NO_FILE_CACHE, CONST_PERSISTENT, ZEND_ACC_ABSTRACT,
+    ZEND_ACC_ANON_CLASS, ZEND_ACC_CALL_VIA_TRAMPOLINE, ZEND_ACC_CHANGED, ZEND_ACC_CLOSURE,
+    ZEND_ACC_CONSTANTS_UPDATED, ZEND_ACC_CTOR, ZEND_ACC_DEPRECATED, ZEND_ACC_DONE_PASS_TWO,
+    ZEND_ACC_EARLY_BINDING, ZEND_ACC_FAKE_CLOSURE, ZEND_ACC_FINAL, ZEND_ACC_GENERATOR,
+    ZEND_ACC_HAS_FINALLY_BLOCK, ZEND_ACC_HAS_RETURN_TYPE, ZEND_ACC_HAS_TYPE_HINTS,
+    ZEND_ACC_HAS_UNLINKED_USES, ZEND_ACC_HEAP_RT_CACHE, ZEND_ACC_IMMUTABLE,
+    ZEND_ACC_IMPLICIT_ABSTRACT_CLASS, ZEND_ACC_INTERFACE, ZEND_ACC_LINKED, ZEND_ACC_NEARLY_LINKED,
+    ZEND_ACC_NEVER_CACHE, ZEND_ACC_NO_DYNAMIC_PROPERTIES, ZEND_ACC_PRELOADED, ZEND_ACC_PRIVATE,
+    ZEND_ACC_PROMOTED, ZEND_ACC_PROPERTY_TYPES_RESOLVED, ZEND_ACC_PROTECTED, ZEND_ACC_PUBLIC,
+    ZEND_ACC_RESOLVED_INTERFACES, ZEND_ACC_RESOLVED_PARENT, ZEND_ACC_RETURN_REFERENCE,
+    ZEND_ACC_REUSE_GET_ITERATOR, ZEND_ACC_STATIC, ZEND_ACC_STRICT_TYPES, ZEND_ACC_TOP_LEVEL,
+    ZEND_ACC_TRAIT, ZEND_ACC_TRAIT_CLONE, ZEND_ACC_UNRESOLVED_VARIANCE, ZEND_ACC_USES_THIS,
+    ZEND_ACC_USE_GUARDS, ZEND_ACC_VARIADIC, ZEND_HAS_STATIC_IN_METHODS,
 };
 
 bitflags! {
@@ -102,3 +103,21 @@ bitflags! {
         const Promoted = ZEND_ACC_PROMOTED;
     }
 }
+
+bitflags! {
+    /// Flags for building module global constants.
+    pub struct GlobalConstantFlags: u32 {
+        const CaseSensitive = CONST_CS;
+        const Persistent = CONST_PERSISTENT;
+        const NoFileCache = CONST_NO_FILE_CACHE;
+        const Deprecated = CONST_DEPRECATED;
+    }
+}
+
+bitflags! {
+    /// Represents the result of a function.
+    pub struct ZendResult: i32 {
+        const Success = 0;
+        const Failure = -1;
+    }
+}

src/php/mod.rs

@@ -2,6 +2,7 @@
 
 pub mod args;
 pub mod class;
+pub mod constants;
 pub mod enums;
 pub mod exceptions;
 pub mod execution_data;