More Swift-friendly stuff, this time adding XADStringEncodingName and XADArchiveKeys as typed extensible enums.

Author: MaddTheSane

XADArchiveParser.h

@@ -19,6 +19,9 @@
  * MA 02110-1301  USA
  */
 #import <Foundation/Foundation.h>
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wquoted-include-in-framework-header"
+#import "XADTypes.h"
 #import "XADException.h"
 #import "XADString.h"
 #import "XADPath.h"
@@ -27,71 +30,74 @@
 #import "XADSkipHandle.h"
 #import "XADResourceFork.h"
 #import "Checksums.h"
-
-extern NSString *const XADFileNameKey;
-extern NSString *const XADCommentKey;
-extern NSString *const XADFileSizeKey;
-extern NSString *const XADCompressedSizeKey;
-extern NSString *const XADCompressionNameKey;
-
-extern NSString *const XADLastModificationDateKey;
-extern NSString *const XADLastAccessDateKey;
-extern NSString *const XADLastAttributeChangeDateKey;
-extern NSString *const XADLastBackupDateKey;
-extern NSString *const XADCreationDateKey;
-
-extern NSString *const XADIsDirectoryKey;
-extern NSString *const XADIsResourceForkKey;
-extern NSString *const XADIsArchiveKey;
-extern NSString *const XADIsHiddenKey;
-extern NSString *const XADIsLinkKey;
-extern NSString *const XADIsHardLinkKey;
-extern NSString *const XADLinkDestinationKey;
-extern NSString *const XADIsCharacterDeviceKey;
-extern NSString *const XADIsBlockDeviceKey;
-extern NSString *const XADDeviceMajorKey;
-extern NSString *const XADDeviceMinorKey;
-extern NSString *const XADIsFIFOKey;
-extern NSString *const XADIsEncryptedKey;
-extern NSString *const XADIsCorruptedKey;
-
-extern NSString *const XADExtendedAttributesKey;
-extern NSString *const XADFileTypeKey;
-extern NSString *const XADFileCreatorKey;
-extern NSString *const XADFinderFlagsKey;
-extern NSString *const XADFinderInfoKey;
-extern NSString *const XADPosixPermissionsKey;
-extern NSString *const XADPosixUserKey;
-extern NSString *const XADPosixGroupKey;
-extern NSString *const XADPosixUserNameKey;
-extern NSString *const XADPosixGroupNameKey;
-extern NSString *const XADDOSFileAttributesKey;
-extern NSString *const XADWindowsFileAttributesKey;
-extern NSString *const XADAmigaProtectionBitsKey;
-
-extern NSString *const XADIndexKey;
-extern NSString *const XADDataOffsetKey;
-extern NSString *const XADDataLengthKey;
-extern NSString *const XADSkipOffsetKey;
-extern NSString *const XADSkipLengthKey;
-
-extern NSString *const XADIsSolidKey;
-extern NSString *const XADFirstSolidIndexKey;
-extern NSString *const XADFirstSolidEntryKey;
-extern NSString *const XADNextSolidIndexKey;
-extern NSString *const XADNextSolidEntryKey;
-extern NSString *const XADSolidObjectKey;
-extern NSString *const XADSolidOffsetKey;
-extern NSString *const XADSolidLengthKey;
+#pragma clang diagnostic pop
+
+typedef NSString *XADArchiveKeys NS_TYPED_EXTENSIBLE_ENUM NS_SWIFT_NAME(XADArchiveParser.Keys);
+
+XADEXTERN XADArchiveKeys const XADFileNameKey NS_SWIFT_NAME(fileName);
+XADEXTERN XADArchiveKeys const XADCommentKey NS_SWIFT_NAME(comment);
+XADEXTERN XADArchiveKeys const XADFileSizeKey NS_SWIFT_NAME(fileSize);
+XADEXTERN XADArchiveKeys const XADCompressedSizeKey NS_SWIFT_NAME(compressedSize);
+XADEXTERN XADArchiveKeys const XADCompressionNameKey NS_SWIFT_NAME(compressionName);
+
+XADEXTERN XADArchiveKeys const XADLastModificationDateKey NS_SWIFT_NAME(lastModificationDate);
+XADEXTERN XADArchiveKeys const XADLastAccessDateKey NS_SWIFT_NAME(lastAccessDate);
+XADEXTERN XADArchiveKeys const XADLastAttributeChangeDateKey NS_SWIFT_NAME(lastAttributeChangeDate);
+XADEXTERN XADArchiveKeys const XADLastBackupDateKey NS_SWIFT_NAME(lastBackupDate);
+XADEXTERN XADArchiveKeys const XADCreationDateKey NS_SWIFT_NAME(creationDate);
+
+XADEXTERN XADArchiveKeys const XADIsDirectoryKey NS_SWIFT_NAME(isDirectory);
+XADEXTERN XADArchiveKeys const XADIsResourceForkKey NS_SWIFT_NAME(isResourceFork);
+XADEXTERN XADArchiveKeys const XADIsArchiveKey NS_SWIFT_NAME(isArchive);
+XADEXTERN XADArchiveKeys const XADIsHiddenKey NS_SWIFT_NAME(isHidden);
+XADEXTERN XADArchiveKeys const XADIsLinkKey NS_SWIFT_NAME(isLink);
+XADEXTERN XADArchiveKeys const XADIsHardLinkKey NS_SWIFT_NAME(isHardLink);
+XADEXTERN XADArchiveKeys const XADLinkDestinationKey NS_SWIFT_NAME(linkDestination);
+XADEXTERN XADArchiveKeys const XADIsCharacterDeviceKey NS_SWIFT_NAME(isCharacterDevice);
+XADEXTERN XADArchiveKeys const XADIsBlockDeviceKey NS_SWIFT_NAME(isBlockDevice);
+XADEXTERN XADArchiveKeys const XADDeviceMajorKey NS_SWIFT_NAME(deviceMajor);
+XADEXTERN XADArchiveKeys const XADDeviceMinorKey NS_SWIFT_NAME(deviceMinor);
+XADEXTERN XADArchiveKeys const XADIsFIFOKey NS_SWIFT_NAME(isFIFO);
+XADEXTERN XADArchiveKeys const XADIsEncryptedKey NS_SWIFT_NAME(isEncrypted);
+XADEXTERN XADArchiveKeys const XADIsCorruptedKey NS_SWIFT_NAME(isCorrupted);
+
+XADEXTERN XADArchiveKeys const XADExtendedAttributesKey NS_SWIFT_NAME(extendedAttributes);
+XADEXTERN XADArchiveKeys const XADFileTypeKey NS_SWIFT_NAME(fileType);
+XADEXTERN XADArchiveKeys const XADFileCreatorKey NS_SWIFT_NAME(fileCreator);
+XADEXTERN XADArchiveKeys const XADFinderFlagsKey NS_SWIFT_NAME(finderFlags);
+XADEXTERN XADArchiveKeys const XADFinderInfoKey NS_SWIFT_NAME(finderInfo);
+XADEXTERN XADArchiveKeys const XADPosixPermissionsKey NS_SWIFT_NAME(posixPermissions);
+XADEXTERN XADArchiveKeys const XADPosixUserKey NS_SWIFT_NAME(posixUser);
+XADEXTERN XADArchiveKeys const XADPosixGroupKey NS_SWIFT_NAME(posixGroup);
+XADEXTERN XADArchiveKeys const XADPosixUserNameKey NS_SWIFT_NAME(posixUserName);
+XADEXTERN XADArchiveKeys const XADPosixGroupNameKey NS_SWIFT_NAME(posixGroupName);
+XADEXTERN XADArchiveKeys const XADDOSFileAttributesKey NS_SWIFT_NAME(dosFileAttributes);
+XADEXTERN XADArchiveKeys const XADWindowsFileAttributesKey NS_SWIFT_NAME(windowsFileAttributes);
+XADEXTERN XADArchiveKeys const XADAmigaProtectionBitsKey NS_SWIFT_NAME(amigaProtectionBits);
+
+XADEXTERN XADArchiveKeys const XADIndexKey NS_SWIFT_NAME(index);
+XADEXTERN XADArchiveKeys const XADDataOffsetKey NS_SWIFT_NAME(dataOffset);
+XADEXTERN XADArchiveKeys const XADDataLengthKey NS_SWIFT_NAME(dataLength);
+XADEXTERN XADArchiveKeys const XADSkipOffsetKey NS_SWIFT_NAME(skipOffset);
+XADEXTERN XADArchiveKeys const XADSkipLengthKey NS_SWIFT_NAME(skipLength);
+
+XADEXTERN XADArchiveKeys const XADIsSolidKey NS_SWIFT_NAME(isSolid);
+XADEXTERN XADArchiveKeys const XADFirstSolidIndexKey NS_SWIFT_NAME(firstSolidIndex);
+XADEXTERN XADArchiveKeys const XADFirstSolidEntryKey NS_SWIFT_NAME(firstSolidEntry);
+XADEXTERN XADArchiveKeys const XADNextSolidIndexKey NS_SWIFT_NAME(nextSolidIndex);
+XADEXTERN XADArchiveKeys const XADNextSolidEntryKey NS_SWIFT_NAME(nextSolidEntry);
+XADEXTERN XADArchiveKeys const XADSolidObjectKey NS_SWIFT_NAME(solidObject);
+XADEXTERN XADArchiveKeys const XADSolidOffsetKey NS_SWIFT_NAME(solidOffset);
+XADEXTERN XADArchiveKeys const XADSolidLengthKey NS_SWIFT_NAME(solidLength);
 
 // Archive properties only
-extern NSString *const XADArchiveNameKey;
-extern NSString *const XADVolumesKey;
-extern NSString *const XADVolumeScanningFailedKey;
-extern NSString *const XADDiskLabelKey;
+XADEXTERN XADArchiveKeys const XADArchiveNameKey NS_SWIFT_NAME(archiveName);
+XADEXTERN XADArchiveKeys const XADVolumesKey NS_SWIFT_NAME(volumes);
+XADEXTERN XADArchiveKeys const XADVolumeScanningFailedKey NS_SWIFT_NAME(volumeScanningFailed);
+XADEXTERN XADArchiveKeys const XADDiskLabelKey NS_SWIFT_NAME(diskLabel);
 
-extern NSString *const XADSignatureOffset;
-extern NSString *const XADParserClass;
+XADEXTERN XADArchiveKeys const XADSignatureOffset;
+XADEXTERN XADArchiveKeys const XADParserClass;
 
 @protocol XADArchiveParserDelegate;
 
@@ -103,7 +109,7 @@ extern NSString *const XADParserClass;
 
 	id<XADArchiveParserDelegate> delegate;
 	NSString *password;
-	NSString *passwordencodingname;
+	XADStringEncodingName passwordencodingname;
 	BOOL caresaboutpasswordencoding;
 
 	NSMutableDictionary *properties;
@@ -162,11 +168,11 @@ resourceFork:(XADResourceFork *)fork name:(NSString *)name propertiesToAdd:(NSMu
 @property (nonatomic, copy) NSString *password;
 @property (nonatomic, readonly) BOOL hasPassword;
 
--(NSString *)encodingName;
+-(XADStringEncodingName)encodingName;
 @property (nonatomic, readonly) float encodingConfidence;
--(void)setEncodingName:(NSString *)encodingname;
+-(void)setEncodingName:(XADStringEncodingName)encodingname;
 @property (readonly) BOOL caresAboutPasswordEncoding;
-@property (nonatomic, retain) NSString *passwordEncodingName;
+@property (nonatomic, retain) XADStringEncodingName passwordEncodingName;
 @property (readonly, retain) XADStringSource *stringSource;
 
 -(XADString *)linkDestinationForDictionary:(NSDictionary *)dict;
@@ -195,11 +201,11 @@ regex:(XADRegex *)regex firstFileExtension:(NSString *)firstext;
 -(CSHandle *)zeroLengthHandleWithChecksum:(BOOL)checksum;
 -(CSHandle *)subHandleFromSolidStreamForEntryWithDictionary:(NSDictionary *)dict;
 
--(BOOL)hasVolumes;
--(NSArray *)volumeSizes;
--(CSHandle *)currentHandle;
+@property (NS_NONATOMIC_IOSONLY, readonly) BOOL hasVolumes;
+@property (NS_NONATOMIC_IOSONLY, readonly, copy) NSArray<NSNumber*> *volumeSizes;
+@property (NS_NONATOMIC_IOSONLY, readonly, retain) CSHandle *currentHandle;
 
--(void)setObject:(id)object forPropertyKey:(NSString *)key;
+-(void)setObject:(id)object forPropertyKey:(XADArchiveKeys)key;
 -(void)addPropertiesFromDictionary:(NSDictionary *)dict;
 -(void)setIsMacArchive:(BOOL)ismac;
 
@@ -208,21 +214,21 @@ regex:(XADRegex *)regex firstFileExtension:(NSString *)firstext;
 
 -(XADString *)XADStringWithString:(NSString *)string;
 -(XADString *)XADStringWithData:(NSData *)data;
--(XADString *)XADStringWithData:(NSData *)data encodingName:(NSString *)encoding;
+-(XADString *)XADStringWithData:(NSData *)data encodingName:(XADStringEncodingName)encoding;
 -(XADString *)XADStringWithBytes:(const void *)bytes length:(int)length;
--(XADString *)XADStringWithBytes:(const void *)bytes length:(int)length encodingName:(NSString *)encoding;
+-(XADString *)XADStringWithBytes:(const void *)bytes length:(int)length encodingName:(XADStringEncodingName)encoding;
 -(XADString *)XADStringWithCString:(const char *)cstring;
--(XADString *)XADStringWithCString:(const char *)cstring encodingName:(NSString *)encoding;
+-(XADString *)XADStringWithCString:(const char *)cstring encodingName:(XADStringEncodingName)encoding;
 
--(XADPath *)XADPath;
+@property (NS_NONATOMIC_IOSONLY, readonly, copy) XADPath *XADPath;
 -(XADPath *)XADPathWithString:(NSString *)string;
 -(XADPath *)XADPathWithUnseparatedString:(NSString *)string;
 -(XADPath *)XADPathWithData:(NSData *)data separators:(const char *)separators;
--(XADPath *)XADPathWithData:(NSData *)data encodingName:(NSString *)encoding separators:(const char *)separators;
+-(XADPath *)XADPathWithData:(NSData *)data encodingName:(XADStringEncodingName)encoding separators:(const char *)separators;
 -(XADPath *)XADPathWithBytes:(const void *)bytes length:(int)length separators:(const char *)separators;
--(XADPath *)XADPathWithBytes:(const void *)bytes length:(int)length encodingName:(NSString *)encoding separators:(const char *)separators;
+-(XADPath *)XADPathWithBytes:(const void *)bytes length:(int)length encodingName:(XADStringEncodingName)encoding separators:(const char *)separators;
 -(XADPath *)XADPathWithCString:(const char *)cstring separators:(const char *)separators;
--(XADPath *)XADPathWithCString:(const char *)cstring encodingName:(NSString *)encoding separators:(const char *)separators;
+-(XADPath *)XADPathWithCString:(const char *)cstring encodingName:(XADStringEncodingName)encoding separators:(const char *)separators;
 
 -(NSData *)encodedPassword;
 -(const char *)encodedCStringPassword;

XADException.h

@@ -55,7 +55,7 @@ typedef int XADError;
 
 #define XADSubArchiveError 0x10000
 
-extern NSString *XADExceptionName;
+extern NSExceptionName const XADExceptionName;
 
 @interface XADException:NSObject
 {

XADException.m

@@ -24,7 +24,7 @@
 #import "CSZlibHandle.h"
 #import "CSBzip2Handle.h"
 
-NSString *XADExceptionName=@"XADException";
+NSString *const XADExceptionName=@"XADException";
 
 @implementation XADException
 

XADMaster.h

@@ -26,6 +26,7 @@ FOUNDATION_EXPORT double XADMasterVersionNumber;
 //! Project version string for XADMaster.
 FOUNDATION_EXPORT const unsigned char XADMasterVersionString[];
 
+#import <XADMaster/XADTypes.h>
 #import <XADMaster/XADArchive.h>
 #import <XADMaster/XADPlatform.h>
 #import <XADMaster/XADException.h>

XADMaster.xcodeproj/project.pbxproj

@@ -1367,6 +1367,10 @@
 		1BF3BA9013EE08A300BE7400 /* XADPlatform.h in Headers */ = {isa = PBXBuildFile; fileRef = 1BF3BA8F13EE08A300BE7400 /* XADPlatform.h */; settings = {ATTRIBUTES = (Public, ); }; };
 		1BF3BA9113EE08A300BE7400 /* XADPlatform.h in Headers */ = {isa = PBXBuildFile; fileRef = 1BF3BA8F13EE08A300BE7400 /* XADPlatform.h */; };
 		1BF3BA9213EE08A300BE7400 /* XADPlatform.h in Headers */ = {isa = PBXBuildFile; fileRef = 1BF3BA8F13EE08A300BE7400 /* XADPlatform.h */; };
+		5530A4AF2D4CCC3800CBD82D /* XADTypes.h in Headers */ = {isa = PBXBuildFile; fileRef = 5530A4AE2D4CCC3800CBD82D /* XADTypes.h */; };
+		5530A4B02D4CCC3800CBD82D /* XADTypes.h in Headers */ = {isa = PBXBuildFile; fileRef = 5530A4AE2D4CCC3800CBD82D /* XADTypes.h */; };
+		5530A4B12D4CCC3800CBD82D /* XADTypes.h in Headers */ = {isa = PBXBuildFile; fileRef = 5530A4AE2D4CCC3800CBD82D /* XADTypes.h */; settings = {ATTRIBUTES = (Public, ); }; };
+		5530A4B22D4CCC3800CBD82D /* XADTypes.h in Headers */ = {isa = PBXBuildFile; fileRef = 5530A4AE2D4CCC3800CBD82D /* XADTypes.h */; };
 		73032E6C2626D3DD000C2751 /* XADWARCParserTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 73032E6B2626D3DD000C2751 /* XADWARCParserTests.m */; };
 		73032E6E2626DB7C000C2751 /* WARCFixtures in Resources */ = {isa = PBXBuildFile; fileRef = 73032E6D2626DB7C000C2751 /* WARCFixtures */; };
 		7318A41D248C67E400D327B9 /* XADRARParserTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 7318A41C248C67E400D327B9 /* XADRARParserTests.m */; };
@@ -2127,6 +2131,7 @@
 		1BF0EE9D14031860007B8CF8 /* VariantI.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = VariantI.h; sourceTree = "<group>"; };
 		1BF3BA8F13EE08A300BE7400 /* XADPlatform.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = XADPlatform.h; sourceTree = "<group>"; };
 		32DBCF5E0370ADEE00C91783 /* XADMaster_Prefix.pch */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = XADMaster_Prefix.pch; sourceTree = "<group>"; };
+		5530A4AE2D4CCC3800CBD82D /* XADTypes.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = XADTypes.h; sourceTree = "<group>"; };
 		56FBC8DC0A57531D00BE98CF /* UniversalDetector.xcodeproj */ = {isa = PBXFileReference; lastKnownFileType = "wrapper.pb-project"; name = UniversalDetector.xcodeproj; path = ../UniversalDetector/UniversalDetector.xcodeproj; sourceTree = SOURCE_ROOT; };
 		56FBC92B0A57541300BE98CF /* Info.plist */ = {isa = PBXFileReference; fileEncoding = 30; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = SOURCE_ROOT; };
 		73032E6B2626D3DD000C2751 /* XADWARCParserTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = XADWARCParserTests.m; sourceTree = "<group>"; };
@@ -2354,6 +2359,7 @@
 				1B349EF711BACA4F00396C26 /* XADPlatformWindows.m */,
 				1B349EF511BACA3C00396C26 /* XADPlatformLinux.m */,
 				1B83727C15CEA27000B0DC9D /* XADPlatformiOS.m */,
+				5530A4AE2D4CCC3800CBD82D /* XADTypes.h */,
 			);
 			name = Classes;
 			sourceTree = "<group>";
@@ -3311,6 +3317,7 @@
 				1B7451AD13081B89008D80FE /* XADISO9660Parser.h in Headers */,
 				1B7F3CB413147CD6008238BF /* XADPaddedBlockHandle.h in Headers */,
 				1B3443D913A6EAF800C89872 /* XADWinZipWavPackHandle.h in Headers */,
+				5530A4B02D4CCC3800CBD82D /* XADTypes.h in Headers */,
 				1B34443913A978AC00C89872 /* wavpack_local.h in Headers */,
 				1B34443B13A978AF00C89872 /* wavpack_version.h in Headers */,
 				1B31CB6013C2305100ED119E /* XADArParser.h in Headers */,
@@ -3389,6 +3396,7 @@
 				1B467A0815CD9A73001AB1DD /* XADISO9660Parser.h in Headers */,
 				1B467A0915CD9A73001AB1DD /* XADPaddedBlockHandle.h in Headers */,
 				1B467A0A15CD9A73001AB1DD /* XADWinZipWavPackHandle.h in Headers */,
+				5530A4AF2D4CCC3800CBD82D /* XADTypes.h in Headers */,
 				1B467A0C15CD9A73001AB1DD /* wavpack_local.h in Headers */,
 				1B467A0D15CD9A73001AB1DD /* wavpack_version.h in Headers */,
 				1B467A0E15CD9A73001AB1DD /* XADArParser.h in Headers */,
@@ -3467,6 +3475,7 @@
 				1B7451A913081B89008D80FE /* XADISO9660Parser.h in Headers */,
 				1B7F3CB613147CD6008238BF /* XADPaddedBlockHandle.h in Headers */,
 				1B3443DA13A6EAF800C89872 /* XADWinZipWavPackHandle.h in Headers */,
+				5530A4B22D4CCC3800CBD82D /* XADTypes.h in Headers */,
 				1B34443A13A978AD00C89872 /* wavpack_local.h in Headers */,
 				1B34443C13A978B000C89872 /* wavpack_version.h in Headers */,
 				1B31CB6113C2305100ED119E /* XADArParser.h in Headers */,
@@ -3727,6 +3736,7 @@
 				1B06CD1C145CFF36003907F9 /* XADCrunchHandles.h in Headers */,
 				1B5F3F82146A0962007BC5A6 /* XADAppleDouble.h in Headers */,
 				1BBEF8B014D8A31800790E4B /* XADArchiveParserDescriptions.h in Headers */,
+				5530A4B12D4CCC3800CBD82D /* XADTypes.h in Headers */,
 				1BBEFA5B14EF375400790E4B /* XADStuffItSplitParser.h in Headers */,
 				1B3581A715A4CFE90002A4C9 /* XADAppleSingleParser.h in Headers */,
 				1B3581D015A7ABE20002A4C9 /* XADPDFParser.h in Headers */,