Make it easier to refer to enum constants

Author: madsmtm

crates/dispatch2/translation-config.toml

@@ -39,7 +39,7 @@ typedef.dispatch_io_type_t.skipped = true
 typedef.dispatch_io_close_flags_t.skipped = true
 typedef.dispatch_io_interval_flags_t.skipped = true
 # Lonely enum constant that we want to tie to dispatch_time_t
-enum.anonymous.constants.DISPATCH_WALLTIME_NOW.skipped = true
+const.DISPATCH_WALLTIME_NOW.skipped = true
 
 # `dispatch_object_t` is a special union that declares all the different kinds
 # of dispatch objects, but that won't work in Rust.

crates/header-translator/src/config.rs

@@ -324,6 +324,9 @@ pub struct LibraryConfig {
     #[serde(rename = "typedef")]
     #[serde(default)]
     pub typedef_data: HashMap<String, TypedefData>,
+    #[serde(rename = "const")]
+    #[serde(default)]
+    pub const_data: HashMap<String, ConstantData>,
 
     #[serde(default)]
     pub module: HashMap<String, ModuleConfig>,
@@ -451,7 +454,7 @@ pub struct RecordData {
 
 #[derive(Deserialize, Debug, Default, Clone, PartialEq, Eq)]
 #[serde(deny_unknown_fields)]
-pub struct EnumVariantData {
+pub struct ConstantData {
     #[serde(default)]
     pub skipped: bool,
     #[serde(rename = "use-value")]
@@ -467,8 +470,6 @@ pub struct EnumData {
     #[serde(rename = "use-value")]
     #[serde(default)]
     pub use_value: Option<bool>,
-    #[serde(default)]
-    pub constants: HashMap<String, EnumVariantData>,
 }
 
 #[derive(Deserialize, Debug, Default, Clone, PartialEq, Eq)]

crates/header-translator/src/stmt.rs

@@ -1345,7 +1345,7 @@ impl Stmt {
                 let data = context
                     .library(&id)
                     .enum_data
-                    .get(id.name.as_deref().unwrap_or("anonymous"))
+                    .get(id.name.as_deref().unwrap_or("__anonymous__"))
                     .cloned()
                     .unwrap_or_default();
                 if data.skipped {
@@ -1369,7 +1369,12 @@ impl Stmt {
                         let name = entity.get_name().expect("enum constant name");
                         let availability = Availability::parse(&entity, context);
 
-                        let const_data = data.constants.get(&name).cloned().unwrap_or_default();
+                        let const_data = context
+                            .library(&id)
+                            .const_data
+                            .get(&name)
+                            .cloned()
+                            .unwrap_or_default();
 
                         if const_data.skipped {
                             return;

framework-crates/objc2-app-kit/translation-config.toml

@@ -47,10 +47,10 @@ protocol.NSAccessibilityElement.renamed = "NSAccessibilityElementProtocol"
 class.NSDocument.methods."setDisplayName:".skipped = true
 
 # Wrong type for enum
-enum.anonymous.constants.NSOKButton.skipped = true
-enum.anonymous.constants.NSCancelButton.skipped = true
-enum.anonymous.constants.NSFileHandlingPanelCancelButton.skipped = true
-enum.anonymous.constants.NSFileHandlingPanelOKButton.skipped = true
+const.NSOKButton.skipped = true
+const.NSCancelButton.skipped = true
+const.NSFileHandlingPanelCancelButton.skipped = true
+const.NSFileHandlingPanelOKButton.skipped = true
 
 # These subclass a generic struct, and hence the type parameter defaults to
 # `AnyObject`, which is not PartialEq, Eq nor Hash.

framework-crates/objc2-application-services/translation-config.toml

@@ -21,7 +21,7 @@ external.NSView.module = "AppKit.NSView"
 protocol.PDEPanel.methods.panelView.skipped = true
 
 # Mapped as `false`, would need a cast to int to work.
-enum.anonymous.constants.kPMUnlocked.use-value = true
+const.kPMUnlocked.use-value = true
 
 # Needs AliasRecord/FSSpec/FSRef from CoreServices.CarbonCore.Files
 struct.ICFileSpec.skipped = true
@@ -42,16 +42,16 @@ typedef.ProcessInfoExtendedRecPtr.skipped = true
 fn.PMPrinterGetDriverReleaseInfo.skipped = true
 
 # Uses constants from CoreServices.CarbonCore.MacErrors
-enum.anonymous.constants.kPMNoError.use-value = true
-enum.anonymous.constants.kPMInvalidParameter.use-value = true
-enum.anonymous.constants.kPMAllocationFailure.use-value = true
+const.kPMNoError.use-value = true
+const.kPMInvalidParameter.use-value = true
+const.kPMAllocationFailure.use-value = true
 
 # Overflows
-enum.anonymous.constants.kProcessDictionaryIncludeAllInformationMask.skipped = true
+const.kProcessDictionaryIncludeAllInformationMask.skipped = true
 
 # Uses `sizeof`
-enum.anonymous.constants.kICFileSpecHeaderSize.skipped = true
-enum.anonymous.constants.extendedBlockLen.skipped = true
+const.kICFileSpecHeaderSize.skipped = true
+const.extendedBlockLen.skipped = true
 
 # Uses Str255 (an array) directly in parameter, which is unclear ABI-wise.
 fn.ICGetConfigName.skipped = true

framework-crates/objc2-audio-toolbox/translation-config.toml

@@ -113,7 +113,7 @@ fn.AudioOutputUnitGetHostIcon.skipped = true
 protocol.AUCocoaUIBase.methods."uiViewForAudioUnit:withSize:".skipped = true
 
 # Value too large
-enum.anonymous.constants.AUEventSampleTimeImmediate.use-value = true
+const.AUEventSampleTimeImmediate.use-value = true
 
 # Defined for real in CoreMIDI, AudioToolbox just redefines it
 typedef.MIDIChannelNumber.skipped = true

framework-crates/objc2-core-audio-types/translation-config.toml

@@ -11,7 +11,7 @@ watchos = "6.0"
 visionos = "1.0"
 
 # Requires a cast, and deprecated anyhow
-enum.anonymous.constants.AVAudioSessionErrorInsufficientPriority.skipped = true
+const.AVAudioSessionErrorInsufficientPriority.skipped = true
 
 # Differs based on architecture
 typedef.AVAudioInteger.skipped = true

framework-crates/objc2-core-graphics/translation-config.toml

@@ -52,5 +52,5 @@ static.kCGBitmapByteOrder32Host.skipped = true
 # Uses defines from IOKit
 enum.CGEventFlags.use-value = true
 enum.CGEventType.use-value = true
-enum.CGEventType.constants.kCGEventTapDisabledByTimeout.use-value = true
-enum.CGEventType.constants.kCGEventTapDisabledByUserInput.use-value = true
+const.kCGEventTapDisabledByTimeout.use-value = true
+const.kCGEventTapDisabledByUserInput.use-value = true

framework-crates/objc2-core-midi/translation-config.toml

@@ -12,5 +12,5 @@ watchos = "8.0"
 visionos = "1.0"
 
 # Wrongly renamed (Swift's renaming algorithm is insufficient)
-enum.MIDIProtocolID.constants.kMIDIProtocol_1_0.skipped = true
-enum.MIDIProtocolID.constants.kMIDIProtocol_2_0.skipped = true
+const.kMIDIProtocol_1_0.skipped = true
+const.kMIDIProtocol_2_0.skipped = true

framework-crates/objc2-core-services/translation-config.toml

@@ -66,20 +66,20 @@ fn.CallComponentFunction.skipped = true
 fn.CallComponentFunctionWithStorage.skipped = true
 
 # Defaults to c_ulong, which is wrong on 32-bit targets.
-enum.anonymous.constants.kFSEventStreamEventIdSinceNow.skipped = true
+const.kFSEventStreamEventIdSinceNow.skipped = true
 
 # Tries to OR u32s and i32s.
-enum.anonymous.constants.kIconServicesCatalogInfoMask.use-value = true
+const.kIconServicesCatalogInfoMask.use-value = true
 
 # Literals are out of the i32 range.
-enum.anonymous.constants.kFSCatInfoReserved.use-value = true
-enum.anonymous.constants.kFSIterateReserved.use-value = true
-enum.anonymous.constants.kioACAccessOwnerMask.use-value = true
-enum.anonymous.constants.kHelpFolderIcon.use-value = true
-enum.anonymous.constants.kInternetPlugInFolderIcon.use-value = true
-enum.anonymous.constants.kLocalesFolderIcon.use-value = true
-enum.anonymous.constants.kPrinterDriverFolderIcon.use-value = true
-enum.anonymous.constants.kScriptingAdditionsFolderIcon.use-value = true
-enum.anonymous.constants.kSharedLibrariesFolderIcon.use-value = true
-enum.anonymous.constants.kTextEncodingsFolderIcon.use-value = true
-enum.anonymous.constants.kAEDebugXMLDebugAll.use-value = true
+const.kFSCatInfoReserved.use-value = true
+const.kFSIterateReserved.use-value = true
+const.kioACAccessOwnerMask.use-value = true
+const.kHelpFolderIcon.use-value = true
+const.kInternetPlugInFolderIcon.use-value = true
+const.kLocalesFolderIcon.use-value = true
+const.kPrinterDriverFolderIcon.use-value = true
+const.kScriptingAdditionsFolderIcon.use-value = true
+const.kSharedLibrariesFolderIcon.use-value = true
+const.kTextEncodingsFolderIcon.use-value = true
+const.kAEDebugXMLDebugAll.use-value = true

framework-crates/objc2-core-text/translation-config.toml

@@ -18,11 +18,11 @@ fn.CTFontGetPlatformFont.skipped = true
 fn.CTFontCreateWithPlatformFont.skipped = true
 
 # Emits -1 on an unsigned type
-enum.CTFontUIFontType.constants.kCTFontUIFontNone.use-value = true
-enum.CTRubyAlignment.constants.kCTRubyAlignmentInvalid.use-value = true
-enum.CTRubyOverhang.constants.kCTRubyOverhangInvalid.use-value = true
+const.kCTFontUIFontNone.use-value = true
+const.kCTRubyAlignmentInvalid.use-value = true
+const.kCTRubyOverhangInvalid.use-value = true
 
 # Emits 0x80000000 on an int
-enum.anonymous.constants.kMORTLigLastAction.use-value = true
-enum.anonymous.constants.kMORXCoverVertical.use-value = true
-enum.anonymous.constants.kKERXVertical.use-value = true
+const.kMORTLigLastAction.use-value = true
+const.kMORXCoverVertical.use-value = true
+const.kKERXVertical.use-value = true

framework-crates/objc2-disk-arbitration/translation-config.toml

@@ -11,18 +11,18 @@ fn.DADiskCopyIOMedia.skipped = true
 
 # Uses `err_local` and `err_local_diskarbitration`, which
 # are not exposed by the `libc` crate.
-enum.anonymous.constants.kDAReturnError.use-value = true
-enum.anonymous.constants.kDAReturnBusy.use-value = true
-enum.anonymous.constants.kDAReturnBadArgument.use-value = true
-enum.anonymous.constants.kDAReturnExclusiveAccess.use-value = true
-enum.anonymous.constants.kDAReturnNoResources.use-value = true
-enum.anonymous.constants.kDAReturnNotFound.use-value = true
-enum.anonymous.constants.kDAReturnNotMounted.use-value = true
-enum.anonymous.constants.kDAReturnNotPermitted.use-value = true
-enum.anonymous.constants.kDAReturnNotPrivileged.use-value = true
-enum.anonymous.constants.kDAReturnNotReady.use-value = true
-enum.anonymous.constants.kDAReturnNotWritable.use-value = true
-enum.anonymous.constants.kDAReturnUnsupported.use-value = true
+const.kDAReturnError.use-value = true
+const.kDAReturnBusy.use-value = true
+const.kDAReturnBadArgument.use-value = true
+const.kDAReturnExclusiveAccess.use-value = true
+const.kDAReturnNoResources.use-value = true
+const.kDAReturnNotFound.use-value = true
+const.kDAReturnNotMounted.use-value = true
+const.kDAReturnNotPermitted.use-value = true
+const.kDAReturnNotPrivileged.use-value = true
+const.kDAReturnNotReady.use-value = true
+const.kDAReturnNotWritable.use-value = true
+const.kDAReturnUnsupported.use-value = true
 
 # Needs dispatch_queue_t from libdispatch
 fn.DASessionSetDispatchQueue.skipped = true

framework-crates/objc2-foundation/translation-config.toml

@@ -147,7 +147,7 @@ class.NSMutableAttributedString.methods."initWithURL:documentAttributes:".skippe
 class.NSMutableAttributedString.methods."initWithPath:documentAttributes:".skipped = true
 
 # Wrong type compared to value
-enum.anonymous.constants.NSWrapCalendarComponents.skipped = true
+const.NSWrapCalendarComponents.skipped = true
 
 # Marked as API_UNAVAILABLE in a category, so we hit the duplicate checking
 class.NSLocale.methods.init.skipped = true
@@ -160,7 +160,7 @@ class.NSUserNotification.methods.contentImage.skipped = true
 class.NSUserNotification.methods."setContentImage:".skipped = true
 
 # Outlier that really should have been part of the original enum
-enum.anonymous.constants.NSProprietaryStringEncoding.skipped = true
+const.NSProprietaryStringEncoding.skipped = true
 
 # Has the wrong generic parameter
 class.NSDictionary.methods."initWithContentsOfURL:error:".skipped = true
@@ -181,9 +181,9 @@ enum.NSNumberFormatterPadPosition.use-value = true
 enum.NSNumberFormatterRoundingMode.use-value = true
 enum.NSPropertyListMutabilityOptions.use-value = true
 enum.NSPropertyListFormat.use-value = true
-enum.anonymous.constants.NS_UnknownByteOrder.skipped = true
-enum.anonymous.constants.NS_LittleEndian.skipped = true
-enum.anonymous.constants.NS_BigEndian.skipped = true
+const.NS_UnknownByteOrder.skipped = true
+const.NS_LittleEndian.skipped = true
+const.NS_BigEndian.skipped = true
 
 # Uses stuff from different frameworks / system libraries
 class.NSOperationQueue.methods.underlyingQueue.skipped = true

framework-crates/objc2-io-kit/translation-config.toml

@@ -41,8 +41,8 @@ fn.IOServiceAddMatchingNotification.skipped = true
 typedef.IOReturn.skipped = true
 
 # Complex expression involving `sizeof`
-enum.anonymous.constants.kOSAsyncRef64Size.skipped = true
-enum.anonymous.constants.kOSAsyncRef64Count.skipped = true
+const.kOSAsyncRef64Size.skipped = true
+const.kOSAsyncRef64Count.skipped = true
 
 # Needs io_user_reference_t, and contains arrays in typedefs
 typedef.OSAsyncReference64.skipped = true
@@ -73,8 +73,8 @@ fn.IOConnectUnmapMemory64.skipped = true
 fn.IONotificationPortSetDispatchQueue.skipped = true
 
 # Value taken from a type that is c_long internally.
-enum.anonymous.constants.kXHCISSRootHubAddress.use-value = true
-enum.anonymous.constants.kXHCIUSB2RootHubAddress.use-value = true
+const.kXHCISSRootHubAddress.use-value = true
+const.kXHCIUSB2RootHubAddress.use-value = true
 
 # Recursive
 typedef.LowLatencyUserBufferInfo.skipped = true
@@ -85,5 +85,5 @@ typedef.LowLatencyUserBufferInfoV3.skipped = true
 struct.LowLatencyUserBufferInfoV3.skipped = true
 
 # Overflows while calculating on 32-bit.
-enum.anonymous.constants.kIORPCMessageIDKernel.skipped = true
-enum.anonymous.constants.kUSBAllStreams.skipped = true
+const.kIORPCMessageIDKernel.skipped = true
+const.kUSBAllStreams.skipped = true

framework-crates/objc2-io-usb-host/translation-config.toml

@@ -20,9 +20,9 @@ class.IOUSBHostObject.methods."configurationDescriptorWithConfigurationValue:err
 fn.IOUSBGetPlatformCapabilityDescriptorWithUUID.skipped = true
 
 # Overflows while calculating.
-enum.anonymous.constants.IOUSBHostCIDeviceUpdateCommandData1DescriptorAddress.use-value = true
-enum.anonymous.constants.IOUSBHostCINormalTransferData1Buffer.use-value = true
-enum.anonymous.constants.IOUSBHostCILinkData1TransferStructureAddress.use-value = true
+const.IOUSBHostCIDeviceUpdateCommandData1DescriptorAddress.use-value = true
+const.IOUSBHostCINormalTransferData1Buffer.use-value = true
+const.IOUSBHostCILinkData1TransferStructureAddress.use-value = true
 
 # Declared twice.
 static.IOUSBHostMatchingPropertyKeyProductIDMask.skipped = true
@@ -39,13 +39,13 @@ class.IOUSBHostObject.methods."initWithIOService:queue:error:interestHandler:".s
 class.IOUSBHostObject.methods.queue.skipped = true
 
 # Value taken from a type that is c_uint internally.
-enum.anonymous.constants.IOUSBHostCITransferCompletionMessageControlStatus.use-value = true
-enum.anonymous.constants.IOUSBHostCITransferCompletionMessageControlStatusPhase.use-value = true
+const.IOUSBHostCITransferCompletionMessageControlStatus.use-value = true
+const.IOUSBHostCITransferCompletionMessageControlStatusPhase.use-value = true
 
 # Overflows while calculating on 32-bit.
-enum.anonymous.constants.IOUSBHostCIEndpointCreateCommandData1Descriptor.skipped = true
-enum.anonymous.constants.IOUSBHostCIEndpointUpdateCommandData1Descriptor.skipped = true
-enum.anonymous.constants.IOUSBHostCIEndpointSetNextTransferCommandData1Address.skipped = true
-enum.anonymous.constants.IOUSBHostCISetupTransferData1wIndex.skipped = true
-enum.anonymous.constants.IOUSBHostCISetupTransferData1wLength.skipped = true
-enum.anonymous.constants.IOUSBHostCITransferCompletionMessageData1TransferStructure.skipped = true
+const.IOUSBHostCIEndpointCreateCommandData1Descriptor.skipped = true
+const.IOUSBHostCIEndpointUpdateCommandData1Descriptor.skipped = true
+const.IOUSBHostCIEndpointSetNextTransferCommandData1Address.skipped = true
+const.IOUSBHostCISetupTransferData1wIndex.skipped = true
+const.IOUSBHostCISetupTransferData1wLength.skipped = true
+const.IOUSBHostCITransferCompletionMessageData1TransferStructure.skipped = true

framework-crates/objc2-local-authentication/translation-config.toml

@@ -9,7 +9,7 @@ visionos = "1.0"
 
 # Uses defines
 enum.LABiometryType.use-value = true
-enum.LABiometryType.constants.LABiometryNone.use-value = false
+const.LABiometryNone.use-value = false
 enum.LACompanionType.use-value = true
 enum.LAPolicy.use-value = true
 enum.LACredentialType.use-value = true

framework-crates/objc2-pass-kit/translation-config.toml

@@ -13,7 +13,7 @@ watchos = "2.0"
 visionos = "1.0"
 
 # Defined as `~(NSUInteger)0`, which leads header-translator to assume that `NSUInteger` is a macro.
-enum.PKPassType.constants.PKPassTypeAny.skipped = true
+const.PKPassTypeAny.skipped = true
 
 # PKPassRelevantDate.h isn't included in the umbrella `PassKit.h`, which makes it invisible to modules.
 #

framework-crates/objc2-security-interface/translation-config.toml

@@ -5,5 +5,5 @@ required-crates = ["objc2", "objc2-foundation", "objc2-app-kit"]
 macos = "10.3"
 
 # Uses NSCancelButton and NSOKButton, which are skipped in AppKit.
-enum.SFButtonType.constants.SFButtonTypeCancel.use-value = true
-enum.SFButtonType.constants.SFButtonTypeOK.use-value = true
+const.SFButtonTypeCancel.use-value = true
+const.SFButtonTypeOK.use-value = true

framework-crates/objc2-security/translation-config.toml

@@ -139,12 +139,12 @@ static.oidSubjectInfoAccess.skipped = true
 static.oidSubjectKeyIdentifier.skipped = true
 
 # References parent enum SecuritySessionId, which is hard to handle
-enum.anonymous.constants.callerSecuritySession.use-value = true
+const.callerSecuritySession.use-value = true
 
 # There's a bunch of constants in cssmtype that need casts (e.g.
 # CSSM_WORDID_VENDOR_START from i32 to CSSM_WORDID_KEYCHAIN_PROMPT which is
 # u32). So let's just emit all constants directly for now.
-enum.anonymous.use-value = true
+enum.__anonymous__.use-value = true
 
 # Manually re-defined: see #711.
 fn.AuthorizationExecuteWithPrivileges.skipped = true

framework-crates/objc2-tv-ml-kit/translation-config.toml

@@ -7,7 +7,7 @@ tvos = "9.0"
 external.AVPlayer.module = "AVFoundation.AVPlayer"
 
 # Swift renames this to "none", so we do too.
-enum.TVElementUpdateType.constants.TVElementUpdateTypeSelf.skipped = true
+const.TVElementUpdateTypeSelf.skipped = true
 
 # FIXME: Make header-translator pick this up from the explicit protocol impl.
 class.TVBrowserTransitionAnimator.main-thread-only = true

framework-crates/objc2-ui-kit/translation-config.toml

@@ -78,12 +78,12 @@ class.UIImage.skipped-protocols = ["UIItemProviderPresentationSizeProviding", "U
 class.NSTextAttachment.skipped-protocols = ["UIAccessibilityContentSizeCategoryImageAdjusting"]
 
 # Type defaults to `c_int`, but value is `NSInteger`
-enum.anonymous.constants.NSControlCharacterZeroAdvancementAction.use-value = true
-enum.anonymous.constants.NSControlCharacterWhitespaceAction.use-value = true
-enum.anonymous.constants.NSControlCharacterHorizontalTabAction.use-value = true
-enum.anonymous.constants.NSControlCharacterLineBreakAction.use-value = true
-enum.anonymous.constants.NSControlCharacterParagraphBreakAction.use-value = true
-enum.anonymous.constants.NSControlCharacterContainerBreakAction.use-value = true
+const.NSControlCharacterZeroAdvancementAction.use-value = true
+const.NSControlCharacterWhitespaceAction.use-value = true
+const.NSControlCharacterHorizontalTabAction.use-value = true
+const.NSControlCharacterLineBreakAction.use-value = true
+const.NSControlCharacterParagraphBreakAction.use-value = true
+const.NSControlCharacterContainerBreakAction.use-value = true
 
 # Typedef to an enum, which our values handle wrong
 typedef.UITextWritingDirection.skipped = true