{ File: CarbonCore/StringCompare.h Contains: Public interfaces for String Comparison and related operations Version: CarbonCore-859.2~1 Copyright: © 1985-2008 by Apple Inc., all rights reserved. Bugs?: For bug reports, consult the following page on the World Wide Web: http://www.freepascal.org/bugs.html } { Pascal Translation Updated: Jonas Maebe, , October 2009 } { Modified for use with Free Pascal Version 308 Please report any bugs to } {$ifc not defined MACOSALLINCLUDE or not MACOSALLINCLUDE} {$mode macpas} {$packenum 1} {$macro on} {$inline on} {$calling mwpascal} unit StringCompare; interface {$setc UNIVERSAL_INTERFACES_VERSION := $0400} {$setc GAP_INTERFACES_VERSION := $0308} {$ifc not defined USE_CFSTR_CONSTANT_MACROS} {$setc USE_CFSTR_CONSTANT_MACROS := TRUE} {$endc} {$ifc defined CPUPOWERPC and defined CPUI386} {$error Conflicting initial definitions for CPUPOWERPC and CPUI386} {$endc} {$ifc defined FPC_BIG_ENDIAN and defined FPC_LITTLE_ENDIAN} {$error Conflicting initial definitions for FPC_BIG_ENDIAN and FPC_LITTLE_ENDIAN} {$endc} {$ifc not defined __ppc__ and defined CPUPOWERPC32} {$setc __ppc__ := 1} {$elsec} {$setc __ppc__ := 0} {$endc} {$ifc not defined __ppc64__ and defined CPUPOWERPC64} {$setc __ppc64__ := 1} {$elsec} {$setc __ppc64__ := 0} {$endc} {$ifc not defined __i386__ and defined CPUI386} {$setc __i386__ := 1} {$elsec} {$setc __i386__ := 0} {$endc} {$ifc not defined __x86_64__ and defined CPUX86_64} {$setc __x86_64__ := 1} {$elsec} {$setc __x86_64__ := 0} {$endc} {$ifc not defined __arm__ and defined CPUARM} {$setc __arm__ := 1} {$elsec} {$setc __arm__ := 0} {$endc} {$ifc defined cpu64} {$setc __LP64__ := 1} {$elsec} {$setc __LP64__ := 0} {$endc} {$ifc defined __ppc__ and __ppc__ and defined __i386__ and __i386__} {$error Conflicting definitions for __ppc__ and __i386__} {$endc} {$ifc defined __ppc__ and __ppc__} {$setc TARGET_CPU_PPC := TRUE} {$setc TARGET_CPU_PPC64 := FALSE} {$setc TARGET_CPU_X86 := FALSE} {$setc TARGET_CPU_X86_64 := FALSE} {$setc TARGET_CPU_ARM := FALSE} {$setc TARGET_OS_MAC := TRUE} {$setc TARGET_OS_IPHONE := FALSE} {$setc TARGET_IPHONE_SIMULATOR := FALSE} {$elifc defined __ppc64__ and __ppc64__} {$setc TARGET_CPU_PPC := FALSE} {$setc TARGET_CPU_PPC64 := TRUE} {$setc TARGET_CPU_X86 := FALSE} {$setc TARGET_CPU_X86_64 := FALSE} {$setc TARGET_CPU_ARM := FALSE} {$setc TARGET_OS_MAC := TRUE} {$setc TARGET_OS_IPHONE := FALSE} {$setc TARGET_IPHONE_SIMULATOR := FALSE} {$elifc defined __i386__ and __i386__} {$setc TARGET_CPU_PPC := FALSE} {$setc TARGET_CPU_PPC64 := FALSE} {$setc TARGET_CPU_X86 := TRUE} {$setc TARGET_CPU_X86_64 := FALSE} {$setc TARGET_CPU_ARM := FALSE} {$ifc defined(iphonesim)} {$setc TARGET_OS_MAC := FALSE} {$setc TARGET_OS_IPHONE := TRUE} {$setc TARGET_IPHONE_SIMULATOR := TRUE} {$elsec} {$setc TARGET_OS_MAC := TRUE} {$setc TARGET_OS_IPHONE := FALSE} {$setc TARGET_IPHONE_SIMULATOR := FALSE} {$endc} {$elifc defined __x86_64__ and __x86_64__} {$setc TARGET_CPU_PPC := FALSE} {$setc TARGET_CPU_PPC64 := FALSE} {$setc TARGET_CPU_X86 := FALSE} {$setc TARGET_CPU_X86_64 := TRUE} {$setc TARGET_CPU_ARM := FALSE} {$setc TARGET_OS_MAC := TRUE} {$setc TARGET_OS_IPHONE := FALSE} {$setc TARGET_IPHONE_SIMULATOR := FALSE} {$elifc defined __arm__ and __arm__} {$setc TARGET_CPU_PPC := FALSE} {$setc TARGET_CPU_PPC64 := FALSE} {$setc TARGET_CPU_X86 := FALSE} {$setc TARGET_CPU_X86_64 := FALSE} {$setc TARGET_CPU_ARM := TRUE} { will require compiler define when/if other Apple devices with ARM cpus ship } {$setc TARGET_OS_MAC := FALSE} {$setc TARGET_OS_IPHONE := TRUE} {$setc TARGET_IPHONE_SIMULATOR := FALSE} {$elsec} {$error __ppc__ nor __ppc64__ nor __i386__ nor __x86_64__ nor __arm__ is defined.} {$endc} {$ifc defined __LP64__ and __LP64__ } {$setc TARGET_CPU_64 := TRUE} {$elsec} {$setc TARGET_CPU_64 := FALSE} {$endc} {$ifc defined FPC_BIG_ENDIAN} {$setc TARGET_RT_BIG_ENDIAN := TRUE} {$setc TARGET_RT_LITTLE_ENDIAN := FALSE} {$elifc defined FPC_LITTLE_ENDIAN} {$setc TARGET_RT_BIG_ENDIAN := FALSE} {$setc TARGET_RT_LITTLE_ENDIAN := TRUE} {$elsec} {$error Neither FPC_BIG_ENDIAN nor FPC_LITTLE_ENDIAN are defined.} {$endc} {$setc ACCESSOR_CALLS_ARE_FUNCTIONS := TRUE} {$setc CALL_NOT_IN_CARBON := FALSE} {$setc OLDROUTINENAMES := FALSE} {$setc OPAQUE_TOOLBOX_STRUCTS := TRUE} {$setc OPAQUE_UPP_TYPES := TRUE} {$setc OTCARBONAPPLICATION := TRUE} {$setc OTKERNEL := FALSE} {$setc PM_USE_SESSION_APIS := TRUE} {$setc TARGET_API_MAC_CARBON := TRUE} {$setc TARGET_API_MAC_OS8 := FALSE} {$setc TARGET_API_MAC_OSX := TRUE} {$setc TARGET_CARBON := TRUE} {$setc TARGET_CPU_68K := FALSE} {$setc TARGET_CPU_MIPS := FALSE} {$setc TARGET_CPU_SPARC := FALSE} {$setc TARGET_OS_UNIX := FALSE} {$setc TARGET_OS_WIN32 := FALSE} {$setc TARGET_RT_MAC_68881 := FALSE} {$setc TARGET_RT_MAC_CFM := FALSE} {$setc TARGET_RT_MAC_MACHO := TRUE} {$setc TYPED_FUNCTION_POINTERS := TRUE} {$setc TYPE_BOOL := FALSE} {$setc TYPE_EXTENDED := FALSE} {$setc TYPE_LONGLONG := TRUE} uses MacTypes,MixedMode,TextCommon,Script; {$endc} {not MACOSALLINCLUDE} {$ifc TARGET_OS_MAC} {$ALIGN POWER} { Here are the current System 7 routine names and the translations to the older forms. Please use the newer forms in all new code and migrate the older names out of existing code as maintenance permits. NEW NAME OLD NAME OBSOLETE FORM (no handle) CompareString (Str255) IUCompPString (hp only) IUCompString (hp only) CompareText (ptr/len) IUMagPString IUMagString IdenticalString (Str255) IUEqualPString (hp only) IUEqualString (hp only) IdenticalText (ptr/len) IUMagIDPString IUMagIDString LanguageOrder IULangOrder ScriptOrder IUScriptOrder StringOrder (Str255) IUStringOrder (hp only) TextOrder (ptr/len) IUTextOrder RelString CmpString (a only) EqualString (hp only) ReplaceText Carbon only supports the new names. The old names are undefined for Carbon targets. InterfaceLib always has exported the old names. For C macros have been defined to allow the use of the new names. For Pascal and Assembly using the new names will result in link errors. } const { Special language code values for Language Order} systemCurLang = -2; { current (itlbLang) lang for system script} systemDefLang = -3; { default (table) lang for system script} currentCurLang = -4; { current (itlbLang) lang for current script} currentDefLang = -5; { default lang for current script} scriptCurLang = -6; { current (itlbLang) lang for specified script} scriptDefLang = -7; { default language for a specified script} { obsolete names} const iuSystemCurLang = systemCurLang; iuSystemDefLang = systemDefLang; iuCurrentCurLang = currentCurLang; iuCurrentDefLang = currentDefLang; iuScriptCurLang = scriptCurLang; iuScriptDefLang = scriptDefLang; { * These routines are available in Carbon with the new names. } {$ifc not TARGET_CPU_64} { * [Mac]ReplaceText() *** DEPRECATED *** * * Deprecated: * use CFStringReplace instead. * * Discussion: * This function is no longer recommended. Please use * CFStringReplace instead. * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4 * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } function MacReplaceText( baseText: Handle; substitutionText: Handle; key: Str15 ): SInt16; external name '_MacReplaceText'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_4 *) { * ScriptOrder() *** DEPRECATED *** * * Deprecated: * use CFStringCompare or UCCompareText instead. * * Discussion: * This function is no longer recommended. Please use * CFStringCompare or UCCompareText instead. * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4 * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } function ScriptOrder( script1: ScriptCode; script2: ScriptCode ): SInt16; external name '_ScriptOrder'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_4 *) { * [Mac]CompareString() *** DEPRECATED *** * * Deprecated: * use CFStringCompare or UCCompareText instead. * * Discussion: * This function is no longer recommended. Please use * CFStringCompare or UCCompareText instead. * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4 * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: not available } function MacCompareString( const (*var*) aStr: Str255; const (*var*) bStr: Str255; itl2Handle: Handle ): SInt16; external name '_MacCompareString'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_4 *) { * IdenticalString() *** DEPRECATED *** * * Deprecated: * use CFStringCompare instead. * * Discussion: * This function is no longer recommended. Please use * CFStringCompare instead. * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4 * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: not available } function IdenticalString( const (*var*) aStr: Str255; const (*var*) bStr: Str255; itl2Handle: Handle ): SInt16; external name '_IdenticalString'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_4 *) { * StringOrder() *** DEPRECATED *** * * Deprecated: * use CFStringCompare or UCCompareText instead. * * Discussion: * This function is no longer recommended. Please use * CFStringCompare or UCCompareText instead. * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4 * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: not available } function StringOrder( const (*var*) aStr: Str255; const (*var*) bStr: Str255; aScript: ScriptCode; bScript: ScriptCode; aLang: LangCode; bLang: LangCode ): SInt16; external name '_StringOrder'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_4 *) { * CompareText() *** DEPRECATED *** * * Deprecated: * use CFStringCompare or UCCompareText instead. * * Discussion: * This function is no longer recommended. Please use * CFStringCompare or UCCompareText instead. * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4 * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: not available } function CompareText( aPtr: {const} UnivPtr; bPtr: {const} UnivPtr; aLen: SInt16; bLen: SInt16; itl2Handle: Handle ): SInt16; external name '_CompareText'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_4 *) { * IdenticalText() *** DEPRECATED *** * * Deprecated: * use CFStringCompare instead. * * Discussion: * This function is no longer recommended. Please use * CFStringCompare instead. * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4 * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: not available } function IdenticalText( aPtr: {const} UnivPtr; bPtr: {const} UnivPtr; aLen: SInt16; bLen: SInt16; itl2Handle: Handle ): SInt16; external name '_IdenticalText'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_4 *) { * TextOrder() *** DEPRECATED *** * * Deprecated: * use CFStringCompare or UCCompareText instead. * * Discussion: * This function is no longer recommended. Please use * CFStringCompare or UCCompareText instead. * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4 * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: not available } function TextOrder( aPtr: {const} UnivPtr; bPtr: {const} UnivPtr; aLen: SInt16; bLen: SInt16; aScript: ScriptCode; bScript: ScriptCode; aLang: LangCode; bLang: LangCode ): SInt16; external name '_TextOrder'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_4 *) { * LanguageOrder() *** DEPRECATED *** * * Deprecated: * use CFStringCompare or UCCompareText instead. * * Discussion: * This function is no longer recommended. Please use * CFStringCompare or UCCompareText instead. * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4 * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: not available } function LanguageOrder( language1: LangCode; language2: LangCode ): SInt16; external name '_LanguageOrder'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_4 *) { * These routines are available in InterfaceLib with old names. * Macros are provided for C to allow source code use to the new names. } {$endc} {not TARGET_CPU_64} { * IUMagPString() * * Availability: * Mac OS X: not available * CarbonLib: not available * Non-Carbon CFM: in InterfaceLib 7.1 and later } { * IUMagIDPString() * * Availability: * Mac OS X: not available * CarbonLib: not available * Non-Carbon CFM: in InterfaceLib 7.1 and later } { * IUTextOrder() * * Availability: * Mac OS X: not available * CarbonLib: not available * Non-Carbon CFM: in InterfaceLib 7.1 and later } { * IULangOrder() * * Availability: * Mac OS X: not available * CarbonLib: not available * Non-Carbon CFM: in InterfaceLib 7.1 and later } { * IUScriptOrder() * * Availability: * Mac OS X: not available * CarbonLib: not available * Non-Carbon CFM: in InterfaceLib 7.1 and later } { * IUMagString() * * Availability: * Mac OS X: not available * CarbonLib: not available * Non-Carbon CFM: in InterfaceLib 7.1 and later } { * IUMagIDString() * * Availability: * Mac OS X: not available * CarbonLib: not available * Non-Carbon CFM: in InterfaceLib 7.1 and later } { * IUCompPString() * * Availability: * Mac OS X: not available * CarbonLib: not available * Non-Carbon CFM: in InterfaceLib 7.1 and later } { * IUEqualPString() * * Availability: * Mac OS X: not available * CarbonLib: not available * Non-Carbon CFM: in InterfaceLib 7.1 and later } { * IUStringOrder() * * Availability: * Mac OS X: not available * CarbonLib: not available * Non-Carbon CFM: in InterfaceLib 7.1 and later } { * IUCompString() * * Availability: * Mac OS X: not available * CarbonLib: not available * Non-Carbon CFM: in InterfaceLib 7.1 and later } { * IUEqualString() * * Availability: * Mac OS X: not available * CarbonLib: not available * Non-Carbon CFM: in InterfaceLib 7.1 and later } { * iucomppstring() * * Availability: * Mac OS X: not available * CarbonLib: not available * Non-Carbon CFM: in InterfaceLib 7.1 and later } { * iuequalpstring() * * Availability: * Mac OS X: not available * CarbonLib: not available * Non-Carbon CFM: in InterfaceLib 7.1 and later } { * iustringorder() * * Availability: * Mac OS X: not available * CarbonLib: not available * Non-Carbon CFM: in InterfaceLib 7.1 and later } { * iucompstring() * * Availability: * Mac OS X: not available * CarbonLib: not available * Non-Carbon CFM: in InterfaceLib 7.1 and later } { * iuequalstring() * * Availability: * Mac OS X: not available * CarbonLib: not available * Non-Carbon CFM: in InterfaceLib 7.1 and later } {$ifc not TARGET_CPU_64} { * RelString() *** DEPRECATED *** * * Deprecated: * use CFStringCompare or UCCompareText instead. * * Discussion: * This function is no longer recommended. Please use * CFStringCompare or UCCompareText instead. * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4 * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } function RelString( const (*var*) str1: Str255; const (*var*) str2: Str255; caseSensitive: Boolean; diacSensitive: Boolean ): SInt16; external name '_RelString'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_4 *) { * EqualString() *** DEPRECATED *** * * Deprecated: * use CFStringCompare instead. * * Discussion: * This function is no longer recommended. Please use * CFStringCompare instead. * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4 * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } function EqualString( const (*var*) str1: Str255; const (*var*) str2: Str255; caseSensitive: Boolean; diacSensitive: Boolean ): Boolean; external name '_EqualString'; (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_4 *) {$endc} {not TARGET_CPU_64} {$ifc not TARGET_CPU_64} { * relstring() *** DEPRECATED *** * * Deprecated: * use CFStringCompare or UCCompareText instead. * * Discussion: * This function is no longer recommended. Please use * CFStringCompare or UCCompareText instead. * * Availability: * Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4 * CarbonLib: in CarbonLib 1.0 and later * Non-Carbon CFM: in InterfaceLib 7.1 and later } (* no function overloading function relstring( str1: ConstCStringPtr; str2: ConstCStringPtr; caseSensitive: Boolean; diacSensitive: Boolean ): SInt16; external name '_relstring'; *) // AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_4; { * equalstring() * * Availability: * Mac OS X: not available [32-bit only] * CarbonLib: not available * Non-Carbon CFM: in InterfaceLib 7.1 and later } {$endc} {not TARGET_CPU_64} {$endc} {TARGET_OS_MAC} {$ifc not defined MACOSALLINCLUDE or not MACOSALLINCLUDE} end. {$endc} {not MACOSALLINCLUDE}