macros: Take a visibility for c_enum variants

Accept a visibility so we are able to make some variants nonpublic. This
means that `pub` needs to be added on all variants we want to be
visible: it is more verbose, but matches how everything else works.

Author: tgross35

src/macros.rs

@@ -294,13 +294,13 @@ macro_rules! c_enum {
     ($(
         $(#[repr($repr:ty)])?
         pub enum $($ty_name:ident)? $(#$anon:ident)? {
-            $($variant:ident $(= $value:expr)?,)+
+            $($vis:vis $variant:ident $(= $value:expr)?,)+
         }
     )+) => {
         $(c_enum!(@single;
             $(#[repr($repr)])?
             pub enum $($ty_name)? $(#$anon)? {
-                $($variant $(= $value)?,)+
+                $($vis $variant $(= $value)?,)+
             }
         );)+
     };
@@ -309,31 +309,45 @@ macro_rules! c_enum {
     (@single;
         $(#[repr($repr:ty)])?
         pub enum $ty_name:ident {
-            $($variant:ident $(= $value:expr)?,)+
+            $($vis:vis $variant:ident $(= $value:expr)?,)+
         }
     ) => {
         pub type $ty_name = c_enum!(@ty $($repr)?);
-        c_enum!(@variant; $ty_name; 0; $($variant $(= $value)?,)+);
+        c_enum! {
+            @variant;
+            ty: $ty_name;
+            default: 0;
+            variants: [$($vis $variant $(= $value)?,)+]
+        }
     };
 
     // Matcher for a single anonymous enum
     (@single;
         $(#[repr($repr:ty)])?
         pub enum #anon {
-            $($variant:ident $(= $value:expr)?,)+
+            $($vis:vis $variant:ident $(= $value:expr)?,)+
         }
     ) => {
-        c_enum!(@variant; c_enum!(@ty $($repr)?); 0; $($variant $(= $value)?,)+);
+        c_enum! {
+            @variant;
+            ty: c_enum!(@ty $($repr)?);
+            default: 0;
+            variants: [$($vis $variant $(= $value)?,)+]
+        }
     };
 
-    // Matcher for a single variant
-    (@variant; $_ty_name:ty; $_idx:expr;) => { /* end of the chain */ };
+    // Matcher for variants: eats a single variant then recurses with the rest
+    (@variant; ty: $_ty_name:ty; default: $_idx:expr; variants: []) => { /* end of the chain */ };
     (
-        @variant; $ty_name:ty; $default_val:expr;
-        $variant:ident $(= $value:expr)?,
-        $($tail:tt)*
+        @variant;
+        ty: $ty_name:ty;
+        default: $default_val:expr;
+        variants: [
+            $vis:vis $variant:ident $(= $value:expr)?,
+            $($tail:tt)*
+        ]
     ) => {
-        pub const $variant: $ty_name = {
+        $vis const $variant: $ty_name = {
             #[allow(unused_variables)]
             let r = $default_val;
             $(let r = $value;)?
@@ -342,7 +356,12 @@ macro_rules! c_enum {
 
         // The next value is always one more than the previous value, unless
         // set explicitly.
-        c_enum!(@variant; $ty_name; $variant + 1; $($tail)*);
+        c_enum! {
+            @variant;
+            ty: $ty_name;
+            default: $variant + 1;
+            variants: [$($tail)*]
+        }
     };
 
     // Use a specific type if provided, otherwise default to `CEnumRepr`
@@ -505,6 +524,40 @@ mod tests {
         assert_eq!(VAR4_1, 4 as CEnumRepr);
     }
 
+    #[test]
+    fn c_enum_vis() {
+        mod priv1 {
+            c_enum! {
+                #[repr(u8)]
+                pub enum e1 {
+                    PRIV_ON_1 = 10,
+                    // Variant should still be usable within its visibility
+                    pub PUB1 = PRIV_ON_1 * 2,
+                }
+            }
+        }
+        mod priv2 {
+            c_enum! {
+                #[repr(u16)]
+                pub enum e2 {
+                    pub PRIV_ON_1 = 42,
+                    pub PUB2 = PRIV_ON_1 * 2,
+                }
+            }
+        }
+
+        use priv1::*;
+        use priv2::*;
+
+        assert_eq!(TypeId::of::<e1>(), TypeId::of::<u8>());
+        assert_eq!(TypeId::of::<e2>(), TypeId::of::<u16>());
+        assert_eq!(PUB1, 10u8 * 2);
+        assert_eq!(PUB2, 42u16 * 2);
+        // Verify that the default is private. If `PRIV_ON_1` was actually public in `priv1`, this
+        // would be an ambiguous import and/or type mismatch error.
+        assert_eq!(PRIV_ON_1, 42u16);
+    }
+
     fn type_id_of_val<T: 'static>(_: &T) -> TypeId {
         TypeId::of::<T>()
     }

src/new/apple/libpthread/pthread_/introspection.rs

@@ -8,10 +8,10 @@ pub use crate::pthread_::pthread::*;
 c_enum! {
     #[repr(c_uint)]
     pub enum #anon {
-        PTHREAD_INTROSPECTION_THREAD_CREATE = 1,
-        PTHREAD_INTROSPECTION_THREAD_START,
-        PTHREAD_INTROSPECTION_THREAD_TERMINATE,
-        PTHREAD_INTROSPECTION_THREAD_DESTROY,
+        pub PTHREAD_INTROSPECTION_THREAD_CREATE = 1,
+        pub PTHREAD_INTROSPECTION_THREAD_START,
+        pub PTHREAD_INTROSPECTION_THREAD_TERMINATE,
+        pub PTHREAD_INTROSPECTION_THREAD_DESTROY,
     }
 }
 

src/new/apple/libpthread/sys/qos.rs

@@ -5,11 +5,11 @@
 c_enum! {
     #[repr(u32)]
     pub enum qos_class_t {
-        QOS_CLASS_USER_INTERACTIVE = 0x21,
-        QOS_CLASS_USER_INITIATED = 0x19,
-        QOS_CLASS_DEFAULT = 0x15,
-        QOS_CLASS_UTILITY = 0x11,
-        QOS_CLASS_BACKGROUND = 0x09,
-        QOS_CLASS_UNSPECIFIED = 0x00,
+        pub QOS_CLASS_USER_INTERACTIVE = 0x21,
+        pub QOS_CLASS_USER_INITIATED = 0x19,
+        pub QOS_CLASS_DEFAULT = 0x15,
+        pub QOS_CLASS_UTILITY = 0x11,
+        pub QOS_CLASS_BACKGROUND = 0x09,
+        pub QOS_CLASS_UNSPECIFIED = 0x00,
     }
 }

src/new/linux_uapi/linux/can/bcm.rs

@@ -23,18 +23,18 @@ s! {
 c_enum! {
     #[repr(u32)]
     pub enum #anon {
-        TX_SETUP = 1,
-        TX_DELETE,
-        TX_READ,
-        TX_SEND,
-        RX_SETUP,
-        RX_DELETE,
-        RX_READ,
-        TX_STATUS,
-        TX_EXPIRED,
-        RX_STATUS,
-        RX_TIMEOUT,
-        RX_CHANGED,
+        pub TX_SETUP = 1,
+        pub TX_DELETE,
+        pub TX_READ,
+        pub TX_SEND,
+        pub RX_SETUP,
+        pub RX_DELETE,
+        pub RX_READ,
+        pub TX_STATUS,
+        pub TX_EXPIRED,
+        pub RX_STATUS,
+        pub RX_TIMEOUT,
+        pub RX_CHANGED,
     }
 }
 

src/unix/aix/mod.rs

@@ -65,17 +65,17 @@ pub type iconv_t = *mut c_void;
 c_enum! {
     #[repr(u32)]
     pub enum uio_rw {
-        UIO_READ = 0,
-        UIO_WRITE,
-        UIO_READ_NO_MOVE,
-        UIO_WRITE_NO_MOVE,
-        UIO_PWRITE,
+        pub UIO_READ = 0,
+        pub UIO_WRITE,
+        pub UIO_READ_NO_MOVE,
+        pub UIO_WRITE_NO_MOVE,
+        pub UIO_PWRITE,
     }
 
     #[repr(u32)]
     pub enum ACTION {
-        FIND = 0,
-        ENTER,
+        pub FIND = 0,
+        pub ENTER,
     }
 }
 

src/unix/bsd/apple/mod.rs

@@ -182,39 +182,39 @@ extern_ty! {
 c_enum! {
     #[repr(u32)]
     pub enum sysdir_search_path_directory_t {
-        SYSDIR_DIRECTORY_APPLICATION = 1,
-        SYSDIR_DIRECTORY_DEMO_APPLICATION = 2,
-        SYSDIR_DIRECTORY_DEVELOPER_APPLICATION = 3,
-        SYSDIR_DIRECTORY_ADMIN_APPLICATION = 4,
-        SYSDIR_DIRECTORY_LIBRARY = 5,
-        SYSDIR_DIRECTORY_DEVELOPER = 6,
-        SYSDIR_DIRECTORY_USER = 7,
-        SYSDIR_DIRECTORY_DOCUMENTATION = 8,
-        SYSDIR_DIRECTORY_DOCUMENT = 9,
-        SYSDIR_DIRECTORY_CORESERVICE = 10,
-        SYSDIR_DIRECTORY_AUTOSAVED_INFORMATION = 11,
-        SYSDIR_DIRECTORY_DESKTOP = 12,
-        SYSDIR_DIRECTORY_CACHES = 13,
-        SYSDIR_DIRECTORY_APPLICATION_SUPPORT = 14,
-        SYSDIR_DIRECTORY_DOWNLOADS = 15,
-        SYSDIR_DIRECTORY_INPUT_METHODS = 16,
-        SYSDIR_DIRECTORY_MOVIES = 17,
-        SYSDIR_DIRECTORY_MUSIC = 18,
-        SYSDIR_DIRECTORY_PICTURES = 19,
-        SYSDIR_DIRECTORY_PRINTER_DESCRIPTION = 20,
-        SYSDIR_DIRECTORY_SHARED_PUBLIC = 21,
-        SYSDIR_DIRECTORY_PREFERENCE_PANES = 22,
-        SYSDIR_DIRECTORY_ALL_APPLICATIONS = 100,
-        SYSDIR_DIRECTORY_ALL_LIBRARIES = 101,
+        pub SYSDIR_DIRECTORY_APPLICATION = 1,
+        pub SYSDIR_DIRECTORY_DEMO_APPLICATION = 2,
+        pub SYSDIR_DIRECTORY_DEVELOPER_APPLICATION = 3,
+        pub SYSDIR_DIRECTORY_ADMIN_APPLICATION = 4,
+        pub SYSDIR_DIRECTORY_LIBRARY = 5,
+        pub SYSDIR_DIRECTORY_DEVELOPER = 6,
+        pub SYSDIR_DIRECTORY_USER = 7,
+        pub SYSDIR_DIRECTORY_DOCUMENTATION = 8,
+        pub SYSDIR_DIRECTORY_DOCUMENT = 9,
+        pub SYSDIR_DIRECTORY_CORESERVICE = 10,
+        pub SYSDIR_DIRECTORY_AUTOSAVED_INFORMATION = 11,
+        pub SYSDIR_DIRECTORY_DESKTOP = 12,
+        pub SYSDIR_DIRECTORY_CACHES = 13,
+        pub SYSDIR_DIRECTORY_APPLICATION_SUPPORT = 14,
+        pub SYSDIR_DIRECTORY_DOWNLOADS = 15,
+        pub SYSDIR_DIRECTORY_INPUT_METHODS = 16,
+        pub SYSDIR_DIRECTORY_MOVIES = 17,
+        pub SYSDIR_DIRECTORY_MUSIC = 18,
+        pub SYSDIR_DIRECTORY_PICTURES = 19,
+        pub SYSDIR_DIRECTORY_PRINTER_DESCRIPTION = 20,
+        pub SYSDIR_DIRECTORY_SHARED_PUBLIC = 21,
+        pub SYSDIR_DIRECTORY_PREFERENCE_PANES = 22,
+        pub SYSDIR_DIRECTORY_ALL_APPLICATIONS = 100,
+        pub SYSDIR_DIRECTORY_ALL_LIBRARIES = 101,
     }
 
     #[repr(u32)]
     pub enum sysdir_search_path_domain_mask_t {
-        SYSDIR_DOMAIN_MASK_USER = 1 << 0,
-        SYSDIR_DOMAIN_MASK_LOCAL = 1 << 1,
-        SYSDIR_DOMAIN_MASK_NETWORK = 1 << 2,
-        SYSDIR_DOMAIN_MASK_SYSTEM = 1 << 3,
-        SYSDIR_DOMAIN_MASK_ALL = 0x0ffff,
+        pub SYSDIR_DOMAIN_MASK_USER = 1 << 0,
+        pub SYSDIR_DOMAIN_MASK_LOCAL = 1 << 1,
+        pub SYSDIR_DOMAIN_MASK_NETWORK = 1 << 2,
+        pub SYSDIR_DOMAIN_MASK_SYSTEM = 1 << 3,
+        pub SYSDIR_DOMAIN_MASK_ALL = 0x0ffff,
     }
 }
 

src/unix/bsd/freebsdlike/dragonfly/mod.rs

@@ -55,18 +55,18 @@ extern_ty! {
 c_enum! {
     #[repr(u32)]
     pub enum lwpstat {
-        LSRUN = 1,
-        LSSTOP = 2,
-        LSSLEEP = 3,
+        pub LSRUN = 1,
+        pub LSSTOP = 2,
+        pub LSSLEEP = 3,
     }
 
     #[repr(u32)]
     pub enum procstat {
-        SIDL = 1,
-        SACTIVE = 2,
-        SSTOP = 3,
-        SZOMB = 4,
-        SCORE = 5,
+        pub SIDL = 1,
+        pub SACTIVE = 2,
+        pub SSTOP = 3,
+        pub SZOMB = 4,
+        pub SCORE = 5,
     }
 }