Unnamed: 0
int64 0
0
| repo_id
stringlengths 5
186
| file_path
stringlengths 15
223
| content
stringlengths 1
32.8M
⌀ |
|---|---|---|---|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CloudKit.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CloudKit.framework/Headers/CKRecordZoneID.h | //
// CKRecordZoneID.h
// CloudKit
//
// Copyright (c) 2014 Apple Inc. All rights reserved.
//
#import <Foundation/Foundation.h>
NS_ASSUME_NONNULL_BEGIN
API_AVAILABLE(macos(10.10), ios(8.0), watchos(3.0))
@interface CKRecordZoneID : NSObject <NSSecureCoding, NSCopying>
/*! Zone names must be 255 characters or less. Most UTF-8 characters are valid. */
- (instancetype)init NS_UNAVAILABLE;
+ (instancetype)new NS_UNAVAILABLE;
- (instancetype)initWithZoneName:(NSString *)zoneName ownerName:(NSString *)ownerName NS_DESIGNATED_INITIALIZER;
@property (nonatomic, readonly, copy) NSString *zoneName;
@property (nonatomic, readonly, copy) NSString *ownerName;
@end
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CloudKit.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CloudKit.framework/Headers/CKModifySubscriptionsOperation.h | //
// CKModifySubscriptionsOperation.h
// CloudKit
//
// Copyright (c) 2014 Apple Inc. All rights reserved.
//
#import <CloudKit/CKDatabaseOperation.h>
#import <CloudKit/CKSubscription.h>
NS_ASSUME_NONNULL_BEGIN
API_AVAILABLE(macos(10.10), ios(8.0), watchos(6.0))
@interface CKModifySubscriptionsOperation : CKDatabaseOperation
- (instancetype)init NS_DESIGNATED_INITIALIZER;
- (instancetype)initWithSubscriptionsToSave:(nullable NSArray<CKSubscription *> *)subscriptionsToSave subscriptionIDsToDelete:(nullable NSArray<CKSubscriptionID> *)subscriptionIDsToDelete;
@property (nonatomic, copy, nullable) NSArray<CKSubscription *> *subscriptionsToSave;
@property (nonatomic, copy, nullable) NSArray<CKSubscriptionID> *subscriptionIDsToDelete;
/*! @abstract Called on success or failure of a subscription save
*
* Each @c CKOperation instance has a private serial queue. This queue is used for all callback block invocations.
*/
@property (nonatomic, copy, nullable) void (^perSubscriptionSaveBlock)(CKSubscriptionID subscriptionID, CKSubscription * _Nullable subscription, NSError * _Nullable error) API_AVAILABLE(macos(12.0), ios(15.0), tvos(15.0), watchos(8.0)) NS_REFINED_FOR_SWIFT;
/*! @abstract Called on success or failure of a subscription deletion
*
* Each @c CKOperation instance has a private serial queue. This queue is used for all callback block invocations.
*/
@property (nonatomic, copy, nullable) void (^perSubscriptionDeleteBlock)(CKSubscriptionID subscriptionID, NSError * _Nullable error) API_AVAILABLE(macos(12.0), ios(15.0), tvos(15.0), watchos(8.0)) NS_REFINED_FOR_SWIFT;
/*! @abstract This block is called when the operation completes.
*
* @discussion The @code -[NSOperation completionBlock] @endcode will also be called if both are set.
* If the error is @c CKErrorPartialFailure, the error's userInfo dictionary contains a dictionary of subscriptionIDs to errors keyed off of @c CKPartialErrorsByItemIDKey.
* @c savedSubscriptions, @c deletedSubscriptionIDs and any @c CKPartialErrorsByItemIDKey errors are repeats of the data sent back in previous @c perSubscriptionSaveBlock and @c perSubscriptionDeleteBlock invocations
* Each @c CKOperation instance has a private serial queue. This queue is used for all callback block invocations.
*/
@property (nonatomic, copy, nullable) void (^modifySubscriptionsCompletionBlock)(NSArray<CKSubscription *> * _Nullable savedSubscriptions, NSArray<CKSubscriptionID> * _Nullable deletedSubscriptionIDs, NSError * _Nullable operationError);
@end
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CloudKit.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CloudKit.framework/Headers/CKFetchShareParticipantsOperation.h | //
// CKFetchShareParticipantsOperation.h
// CloudKit
//
// Copyright (c) 2014 Apple Inc. All rights reserved.
//
#import <CloudKit/CKOperation.h>
@class CKUserIdentityLookupInfo, CKShareParticipant, CKRecordID;
NS_ASSUME_NONNULL_BEGIN
API_AVAILABLE(macos(10.12), ios(10.0), tvos(10.0), watchos(3.0))
@interface CKFetchShareParticipantsOperation : CKOperation
- (instancetype)init NS_DESIGNATED_INITIALIZER;
- (instancetype)initWithUserIdentityLookupInfos:(NSArray<CKUserIdentityLookupInfo *> *)userIdentityLookupInfos;
@property (nonatomic, copy, nullable) NSArray<CKUserIdentityLookupInfo *> *userIdentityLookupInfos;
/*! @abstract Called once for each share participant created from a submitted user identity lookup info.
*
* @discussion If the replacement callback @c perShareParticipantCompletionBlock is set, this callback block is ignored.
* Each @c CKOperation instance has a private serial queue. This queue is used for all callback block invocations.
*/
@property (nonatomic, copy, nullable) void (^shareParticipantFetchedBlock)(CKShareParticipant *participant)
API_DEPRECATED("Use perShareParticipantCompletionBlock instead, which surfaces per-share-participant errors", macos(10.12, 12.0), ios(10.0, 15.0), tvos(10.0, 15.0), watchos(3.0, 8.0));
/*! @abstract Called once for each lookup info.
*
* @discussion Each @c CKOperation instance has a private serial queue. This queue is used for all callback block invocations.
*/
@property (nonatomic, copy, nullable) void (^perShareParticipantCompletionBlock)(CKUserIdentityLookupInfo *lookupInfo, CKShareParticipant * _Nullable participant, NSError * _Nullable error) NS_REFINED_FOR_SWIFT;
/*! @abstract This block is called when the operation completes.
*
* @discussion The @code -[NSOperation completionBlock] @endcode will also be called if both are set.
* If the error is @c CKErrorPartialFailure, the error's userInfo dictionary contains a dictionary of lookup infos to errors keyed off of @c CKPartialErrorsByItemIDKey. These errors are repeats of those sent back in previous @c perShareParticipantCompletionBlock invocations
* Each @c CKOperation instance has a private serial queue. This queue is used for all callback block invocations.
*/
@property (nonatomic, copy, nullable) void (^fetchShareParticipantsCompletionBlock)(NSError * _Nullable operationError)
CK_SWIFT_DEPRECATED("Use fetchShareParticipantsResultBlock instead", macos(10.12, 12.0), ios(10.0, 15.0), tvos(10.0, 15.0), watchos(3.0, 8.0));
@end
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CloudKit.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CloudKit.framework/Headers/CKQuery.h | //
// CKQuery.h
// CloudKit
//
// Copyright (c) 2014 Apple Inc. All rights reserved.
//
#import <Foundation/Foundation.h>
#import <CloudKit/CKRecord.h>
NS_ASSUME_NONNULL_BEGIN
/*! @class CKQuery
*
* @discussion Only AND compound predicates are allowed.
*
* Key names must begin with either an upper or lower case character ([a-zA-Z]) and may be followed by characters, numbers, or underscores ([0-9a-zA-Z_]). Keypaths may only resolve to the currently evaluated object, so the '.' character is not allowed in key names.
*
* A limited subset of classes are allowed as predicate arguments:
* - NSString
* - NSDate
* - NSData
* - NSNumber
* - NSArray
* - CKReference
* - CKRecord
* - CLLocation
*
* Any other class as an argument will result in an error when executing the query.
*/
API_AVAILABLE(macos(10.10), ios(8.0), watchos(3.0))
@interface CKQuery : NSObject <NSSecureCoding, NSCopying>
- (instancetype)init NS_UNAVAILABLE;
+ (instancetype)new NS_UNAVAILABLE;
- (instancetype)initWithCoder:(NSCoder *)aDecoder NS_DESIGNATED_INITIALIZER;
/*! Use @code [NSPredicate predicateWithValue:YES] / NSPredicate(value: true) @endcode if you want to query for all records of a given type. */
- (instancetype)initWithRecordType:(CKRecordType)recordType predicate:(NSPredicate *)predicate NS_DESIGNATED_INITIALIZER;
@property (nonatomic, readonly, copy) CKRecordType recordType;
@property (nonatomic, readonly, copy) NSPredicate *predicate;
@property (nonatomic, copy, nullable) NSArray<NSSortDescriptor *> *sortDescriptors;
@end
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CloudKit.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CloudKit.framework/Modules/module.modulemap | framework module CloudKit [extern_c] [system] {
umbrella header "CloudKit.h"
export *
module * { export * }
}
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CFNetwork.framework/CFNetwork.tbd | --- !tapi-tbd
tbd-version: 4
targets: [ x86_64-macos, x86_64-maccatalyst, arm64-macos, arm64-maccatalyst,
arm64e-macos, arm64e-maccatalyst ]
uuids:
- target: x86_64-macos
value: 464E7A92-4441-30A0-9FD0-A0098CCEDB39
- target: x86_64-maccatalyst
value: 464E7A92-4441-30A0-9FD0-A0098CCEDB39
- target: arm64-macos
value: 00000000-0000-0000-0000-000000000000
- target: arm64-maccatalyst
value: 00000000-0000-0000-0000-000000000000
- target: arm64e-macos
value: ED54FDBE-FD7C-3A83-B093-6F569A0229F0
- target: arm64e-maccatalyst
value: ED54FDBE-FD7C-3A83-B093-6F569A0229F0
install-name: '/System/Library/Frameworks/CFNetwork.framework/Versions/A/CFNetwork'
current-version: 1323
exports:
- targets: [ x86_64-macos ]
symbols: [ '$ld$hide$os10.9$_NSHTTPCookieComment', '$ld$hide$os10.9$_NSHTTPCookieCommentURL',
'$ld$hide$os10.9$_NSHTTPCookieDiscard', '$ld$hide$os10.9$_NSHTTPCookieDomain',
'$ld$hide$os10.9$_NSHTTPCookieExpires', '$ld$hide$os10.9$_NSHTTPCookieManagerAcceptPolicyChangedNotification',
'$ld$hide$os10.9$_NSHTTPCookieManagerCookiesChangedNotification',
'$ld$hide$os10.9$_NSHTTPCookieMaximumAge', '$ld$hide$os10.9$_NSHTTPCookieName',
'$ld$hide$os10.9$_NSHTTPCookieOriginURL', '$ld$hide$os10.9$_NSHTTPCookiePath',
'$ld$hide$os10.9$_NSHTTPCookiePort', '$ld$hide$os10.9$_NSHTTPCookieSecure',
'$ld$hide$os10.9$_NSHTTPCookieValue', '$ld$hide$os10.9$_NSHTTPCookieVersion',
'$ld$hide$os10.9$_NSNetServicesErrorCode', '$ld$hide$os10.9$_NSNetServicesErrorDomain',
'$ld$hide$os10.9$_NSURLAuthenticationMethodClientCertificate',
'$ld$hide$os10.9$_NSURLAuthenticationMethodDefault', '$ld$hide$os10.9$_NSURLAuthenticationMethodHTMLForm',
'$ld$hide$os10.9$_NSURLAuthenticationMethodHTTPBasic', '$ld$hide$os10.9$_NSURLAuthenticationMethodHTTPDigest',
'$ld$hide$os10.9$_NSURLAuthenticationMethodNTLM', '$ld$hide$os10.9$_NSURLAuthenticationMethodNegotiate',
'$ld$hide$os10.9$_NSURLAuthenticationMethodServerTrust', '$ld$hide$os10.9$_NSURLCredentialStorageChangedNotification',
'$ld$hide$os10.9$_NSURLCredentialStorageRemoveSynchronizableCredentials',
'$ld$hide$os10.9$_NSURLProtectionSpaceFTP', '$ld$hide$os10.9$_NSURLProtectionSpaceFTPProxy',
'$ld$hide$os10.9$_NSURLProtectionSpaceHTTP', '$ld$hide$os10.9$_NSURLProtectionSpaceHTTPProxy',
'$ld$hide$os10.9$_NSURLProtectionSpaceHTTPS', '$ld$hide$os10.9$_NSURLProtectionSpaceHTTPSProxy',
'$ld$hide$os10.9$_NSURLProtectionSpaceSOCKSProxy', '$ld$hide$os10.9$_NSURLSessionDownloadTaskResumeData',
'$ld$hide$os10.9$_NSURLSessionTransferSizeUnknown', '$ld$hide$os10.9$_OBJC_CLASS_$_NSCachedURLResponse',
'$ld$hide$os10.9$_OBJC_CLASS_$_NSHTTPCookie', '$ld$hide$os10.9$_OBJC_CLASS_$_NSHTTPCookieStorage',
'$ld$hide$os10.9$_OBJC_CLASS_$_NSHTTPURLResponse', '$ld$hide$os10.9$_OBJC_CLASS_$_NSHost',
'$ld$hide$os10.9$_OBJC_CLASS_$_NSMutableURLRequest', '$ld$hide$os10.9$_OBJC_CLASS_$_NSNetService',
'$ld$hide$os10.9$_OBJC_CLASS_$_NSNetServiceBrowser', '$ld$hide$os10.9$_OBJC_CLASS_$_NSURLAuthenticationChallenge',
'$ld$hide$os10.9$_OBJC_CLASS_$_NSURLCache', '$ld$hide$os10.9$_OBJC_CLASS_$_NSURLConnection',
'$ld$hide$os10.9$_OBJC_CLASS_$_NSURLCredential', '$ld$hide$os10.9$_OBJC_CLASS_$_NSURLCredentialStorage',
'$ld$hide$os10.9$_OBJC_CLASS_$_NSURLDownload', '$ld$hide$os10.9$_OBJC_CLASS_$_NSURLProtectionSpace',
'$ld$hide$os10.9$_OBJC_CLASS_$_NSURLProtocol', '$ld$hide$os10.9$_OBJC_CLASS_$_NSURLRequest',
'$ld$hide$os10.9$_OBJC_CLASS_$_NSURLResponse', '$ld$hide$os10.9$_OBJC_CLASS_$_NSURLSession',
'$ld$hide$os10.9$_OBJC_CLASS_$_NSURLSessionConfiguration',
'$ld$hide$os10.9$_OBJC_CLASS_$_NSURLSessionDataTask', '$ld$hide$os10.9$_OBJC_CLASS_$_NSURLSessionDownloadTask',
'$ld$hide$os10.9$_OBJC_CLASS_$_NSURLSessionTask', '$ld$hide$os10.9$_OBJC_CLASS_$_NSURLSessionUploadTask',
'$ld$hide$os10.9$_OBJC_METACLASS_$_NSCachedURLResponse', '$ld$hide$os10.9$_OBJC_METACLASS_$_NSHTTPCookie',
'$ld$hide$os10.9$_OBJC_METACLASS_$_NSHTTPCookieStorage', '$ld$hide$os10.9$_OBJC_METACLASS_$_NSHTTPURLResponse',
'$ld$hide$os10.9$_OBJC_METACLASS_$_NSHost', '$ld$hide$os10.9$_OBJC_METACLASS_$_NSMutableURLRequest',
'$ld$hide$os10.9$_OBJC_METACLASS_$_NSNetService', '$ld$hide$os10.9$_OBJC_METACLASS_$_NSNetServiceBrowser',
'$ld$hide$os10.9$_OBJC_METACLASS_$_NSURLAuthenticationChallenge',
'$ld$hide$os10.9$_OBJC_METACLASS_$_NSURLCache', '$ld$hide$os10.9$_OBJC_METACLASS_$_NSURLConnection',
'$ld$hide$os10.9$_OBJC_METACLASS_$_NSURLCredential', '$ld$hide$os10.9$_OBJC_METACLASS_$_NSURLCredentialStorage',
'$ld$hide$os10.9$_OBJC_METACLASS_$_NSURLDownload', '$ld$hide$os10.9$_OBJC_METACLASS_$_NSURLProtectionSpace',
'$ld$hide$os10.9$_OBJC_METACLASS_$_NSURLProtocol', '$ld$hide$os10.9$_OBJC_METACLASS_$_NSURLRequest',
'$ld$hide$os10.9$_OBJC_METACLASS_$_NSURLResponse', '$ld$hide$os10.9$_OBJC_METACLASS_$_NSURLSession',
'$ld$hide$os10.9$_OBJC_METACLASS_$_NSURLSessionConfiguration',
'$ld$hide$os10.9$_OBJC_METACLASS_$_NSURLSessionDataTask',
'$ld$hide$os10.9$_OBJC_METACLASS_$_NSURLSessionDownloadTask',
'$ld$hide$os10.9$_OBJC_METACLASS_$_NSURLSessionTask', '$ld$hide$os10.9$_OBJC_METACLASS_$_NSURLSessionUploadTask' ]
- targets: [ x86_64-macos, arm64e-macos, x86_64-maccatalyst, arm64e-maccatalyst,
arm64-macos, arm64-maccatalyst ]
symbols: [ _CFCachedURLResponseCopyReceiverDataArray, _CFCachedURLResponseCreateWithData,
_CFCachedURLResponseGetReceiverData, _CFCachedURLResponseGetStoragePolicy,
_CFCachedURLResponseGetWrappedResponse, _CFCachedURLResponseSetStoragePolicy,
_CFFTPCreateParsedResourceListing, _CFHTTPAuthenticationAppliesToRequest,
_CFHTTPAuthenticationCopyDomains, _CFHTTPAuthenticationCopyMethod,
_CFHTTPAuthenticationCopyRealm, _CFHTTPAuthenticationCreateFromResponse,
_CFHTTPAuthenticationGetTypeID, _CFHTTPAuthenticationIsValid,
_CFHTTPAuthenticationRequiresAccountDomain, _CFHTTPAuthenticationRequiresOrderedRequests,
_CFHTTPAuthenticationRequiresUserNameAndPassword, _CFHTTPCookieCopyDomain,
_CFHTTPCookieCopyName, _CFHTTPCookieCopyPath, _CFHTTPCookieCopyProperties,
_CFHTTPCookieCopyRequestHeaderFields, _CFHTTPCookieCopyValue,
_CFHTTPCookieCreateWithProperties, _CFHTTPCookieCreateWithResponseHeaderFields,
_CFHTTPCookieGetExpirationTime, _CFHTTPCookieGetFlags, _CFHTTPCookieGetTypeID,
_CFHTTPCookieIsHTTPOnly, _CFHTTPCookieIsSecure, _CFHTTPCookieStorageAddObserver,
_CFHTTPCookieStorageCopyCookies, _CFHTTPCookieStorageCopyCookiesForURL,
_CFHTTPCookieStorageCreateFromFile, _CFHTTPCookieStorageCreateFromIdentifyingData,
_CFHTTPCookieStorageCreateIdentifyingData, _CFHTTPCookieStorageDeleteAllCookies,
_CFHTTPCookieStorageDeleteCookie, _CFHTTPCookieStorageGetCookieAcceptPolicy,
_CFHTTPCookieStorageRemoveObserver, _CFHTTPCookieStorageScheduleWithRunLoop,
_CFHTTPCookieStorageSetCookie, _CFHTTPCookieStorageSetCookieAcceptPolicy,
_CFHTTPCookieStorageSetCookies, _CFHTTPCookieStorageUnscheduleFromRunLoop,
_CFHTTPMessageAddAuthentication, _CFHTTPMessageAppendBytes,
_CFHTTPMessageApplyCredentialDictionary, _CFHTTPMessageApplyCredentials,
_CFHTTPMessageCopyAllHeaderFields, _CFHTTPMessageCopyBody,
_CFHTTPMessageCopyHeaderFieldValue, _CFHTTPMessageCopyRequestMethod,
_CFHTTPMessageCopyRequestURL, _CFHTTPMessageCopyResponseStatusLine,
_CFHTTPMessageCopySerializedMessage, _CFHTTPMessageCopyVersion,
_CFHTTPMessageCreateCopy, _CFHTTPMessageCreateEmpty, _CFHTTPMessageCreateRequest,
_CFHTTPMessageCreateResponse, _CFHTTPMessageGetResponseStatusCode,
_CFHTTPMessageGetTypeID, _CFHTTPMessageIsHeaderComplete, _CFHTTPMessageIsRequest,
_CFHTTPMessageSetBody, _CFHTTPMessageSetHeaderFieldValue,
_CFHostCancelInfoResolution, _CFHostCreateCopy, _CFHostCreateWithAddress,
_CFHostCreateWithName, _CFHostGetAddressing, _CFHostGetInfo,
_CFHostGetNames, _CFHostGetReachability, _CFHostGetSRVRecords,
_CFHostGetTypeID, _CFHostScheduleWithRunLoop, _CFHostSetClient,
_CFHostStartInfoResolution, _CFHostUnscheduleFromRunLoop,
_CFNetDiagnosticCopyNetworkStatusActively, _CFNetDiagnosticCopyNetworkStatusPassively,
_CFNetDiagnosticCreateBasic, _CFNetDiagnosticCreateWithStreams,
_CFNetDiagnosticCreateWithURL, _CFNetDiagnosticDiagnoseProblemInteractively,
_CFNetDiagnosticNotifyKey, _CFNetDiagnosticPing, _CFNetDiagnosticPingWithOptions,
_CFNetDiagnosticProtocolFTP, _CFNetDiagnosticProtocolHTTP,
_CFNetDiagnosticProtocolIMAP, _CFNetDiagnosticProtocolOSCAR,
_CFNetDiagnosticProtocolSMTP, _CFNetDiagnosticProtocolUnknown,
_CFNetDiagnosticSetName, _CFNetDiagnosticSetProtocol, _CFNetDiagnosticSetServiceID,
_CFNetServiceBrowserCreate, _CFNetServiceBrowserGetTypeID,
_CFNetServiceBrowserInvalidate, _CFNetServiceBrowserScheduleWithRunLoop,
_CFNetServiceBrowserSearchForDomains, _CFNetServiceBrowserSearchForServices,
_CFNetServiceBrowserStopSearch, _CFNetServiceBrowserUnscheduleFromRunLoop,
_CFNetServiceCancel, _CFNetServiceCreate, _CFNetServiceCreateCopy,
_CFNetServiceCreateDictionaryWithTXTData, _CFNetServiceCreateTXTDataWithDictionary,
_CFNetServiceGetAddressing, _CFNetServiceGetDomain, _CFNetServiceGetInfo,
_CFNetServiceGetName, _CFNetServiceGetPortNumber, _CFNetServiceGetTXTData,
_CFNetServiceGetTargetHost, _CFNetServiceGetType, _CFNetServiceGetTypeID,
_CFNetServiceMonitorCreate, _CFNetServiceMonitorGetTypeID,
_CFNetServiceMonitorInvalidate, _CFNetServiceMonitorScheduleWithRunLoop,
_CFNetServiceMonitorStart, _CFNetServiceMonitorStop, _CFNetServiceMonitorUnscheduleFromRunLoop,
_CFNetServiceRegister, _CFNetServiceRegisterWithOptions, _CFNetServiceResolve,
_CFNetServiceResolveWithTimeout, _CFNetServiceScheduleWithRunLoop,
_CFNetServiceSetClient, _CFNetServiceSetInfo, _CFNetServiceSetTXTData,
_CFNetServiceUnscheduleFromRunLoop, _CFNetworkCopyProxiesForAutoConfigurationScript,
_CFNetworkCopyProxiesForURL, _CFNetworkCopySystemProxySettings,
_CFNetworkExecuteProxyAutoConfigurationScript, _CFNetworkExecuteProxyAutoConfigurationURL,
_CFReadStreamCreateForHTTPRequest, _CFReadStreamCreateForStreamedHTTPRequest,
_CFReadStreamCreateWithFTPURL, _CFStreamCreatePairWithSocketToCFHost,
_CFStreamCreatePairWithSocketToNetService, _CFURLAuthChallengeCreate,
_CFURLAuthChallengeGetError, _CFURLAuthChallengeGetFailureResponse,
_CFURLAuthChallengeGetPreviousFailureCount, _CFURLAuthChallengeGetProposedCredential,
_CFURLAuthChallengeGetProtectionSpace, _CFURLCacheAddCachedResponseForRequest,
_CFURLCacheCopyResponseForRequest, _CFURLCacheCopySharedURLCache,
_CFURLCacheCreate, _CFURLCacheCurrentDiskUsage, _CFURLCacheDiskCapacity,
_CFURLCacheMemoryCapacity, _CFURLCacheRemoveAllCachedResponses,
_CFURLCacheRemoveCachedResponseForRequest, _CFURLCacheSetDiskCapacity,
_CFURLCacheSetMemoryCapacity, _CFURLCacheSetSharedURLCache,
_CFURLConnectionCancel, _CFURLConnectionCreate, _CFURLConnectionCreateWithProperties,
_CFURLConnectionHalt, _CFURLConnectionInvalidateConnectionCache,
_CFURLConnectionPerformDefaultHandlingForChallenge, _CFURLConnectionRejectChallenge,
_CFURLConnectionResume, _CFURLConnectionScheduleDownloadWithRunLoop,
_CFURLConnectionScheduleWithRunLoop, _CFURLConnectionSendSynchronousRequest,
_CFURLConnectionSetDelegateDispatchQueue, _CFURLConnectionStart,
_CFURLConnectionUnscheduleFromRunLoop, _CFURLConnectionUseCredential,
_CFURLCredentialContainsPassword, _CFURLCredentialCopyPassword,
_CFURLCredentialCreate, _CFURLCredentialCreateWithIdentityAndCertificateArray,
_CFURLCredentialCreateWithTrust, _CFURLCredentialGetPersistence,
_CFURLCredentialGetUsername, _CFURLCredentialStorageCopyAllCredentials,
_CFURLCredentialStorageCopyCredentialsForProtectionSpace,
_CFURLCredentialStorageCopyDefaultCredentialForProtectionSpace,
_CFURLCredentialStorageCreate, _CFURLCredentialStorageRemoveCredentialForProtectionSpace,
_CFURLCredentialStorageSetCredentialForProtectionSpace, _CFURLCredentialStorageSetDefaultCredentialForProtectionSpace,
_CFURLDownloadCancel, _CFURLDownloadCopyResumeData, _CFURLDownloadCreate,
_CFURLDownloadCreateAndStartWithLoadingConnection, _CFURLDownloadCreateWithResumeData,
_CFURLDownloadDeletesUponFailure, _CFURLDownloadScheduleWithRunLoop,
_CFURLDownloadSetDeletesUponFailure, _CFURLDownloadSetDestination,
_CFURLDownloadStart, _CFURLProtectionSpaceCreate, _CFURLProtectionSpaceGetAuthenticationScheme,
_CFURLProtectionSpaceGetHost, _CFURLProtectionSpaceGetPort,
_CFURLProtectionSpaceGetRealm, _CFURLProtectionSpaceGetServerTrust,
_CFURLProtectionSpaceGetServerType, _CFURLProtectionSpaceIsProxy,
_CFURLProtectionSpaceReceivesCredentialSecurely, _CFURLProtocolGetCachedResponse,
_CFURLProtocolGetClient, _CFURLProtocolGetRequest, _CFURLProtocolRegisterImplementation,
_CFURLProtocolUnregisterImplementation, _CFURLRequestAppendHTTPHeaderFieldValue,
_CFURLRequestCopyAllHTTPHeaderFields, _CFURLRequestCopyHTTPCookieStorage,
_CFURLRequestCopyHTTPHeaderFieldValue, _CFURLRequestCopyHTTPRequest,
_CFURLRequestCopyHTTPRequestBody, _CFURLRequestCopyHTTPRequestBodyParts,
_CFURLRequestCopyHTTPRequestBodyStream, _CFURLRequestCopyHTTPRequestMethod,
_CFURLRequestCreate, _CFURLRequestCreateCopy, _CFURLRequestCreateHTTPRequest,
_CFURLRequestCreateMutable, _CFURLRequestCreateMutableCopy,
_CFURLRequestCreateMutableHTTPRequest, _CFURLRequestGetCachePolicy,
_CFURLRequestGetMainDocumentURL, _CFURLRequestGetRequestPriority,
_CFURLRequestGetSSLProperties, _CFURLRequestGetTimeoutInterval,
_CFURLRequestGetURL, _CFURLRequestSetAllowsCellularAccess,
_CFURLRequestSetCachePolicy, _CFURLRequestSetHTTPCookieStorage,
_CFURLRequestSetHTTPCookieStorageAcceptPolicy, _CFURLRequestSetHTTPHeaderFieldValue,
_CFURLRequestSetHTTPRequestBody, _CFURLRequestSetHTTPRequestBodyParts,
_CFURLRequestSetHTTPRequestBodyStream, _CFURLRequestSetHTTPRequestMethod,
_CFURLRequestSetMainDocumentURL, _CFURLRequestSetMultipleHTTPHeaderFields,
_CFURLRequestSetNetworkServiceType, _CFURLRequestSetProxySettings,
_CFURLRequestSetRequestPriority, _CFURLRequestSetSSLProperties,
_CFURLRequestSetShouldHandleHTTPCookies, _CFURLRequestSetShouldPipelineHTTP,
_CFURLRequestSetShouldStartSynchronously, _CFURLRequestSetTimeoutInterval,
_CFURLRequestSetURL, _CFURLRequestShouldHandleHTTPCookies,
_CFURLResponseConnectionDidFallback, _CFURLResponseConnectionIsCellular,
_CFURLResponseCopyPeerAddress, _CFURLResponseCopySuggestedFilename,
_CFURLResponseCreate, _CFURLResponseCreateWithHTTPResponse,
_CFURLResponseDataIsEncoded, _CFURLResponseGetCreationTime,
_CFURLResponseGetExpectedContentLength, _CFURLResponseGetExpirationTime,
_CFURLResponseGetHTTPResponse, _CFURLResponseGetMIMEType,
_CFURLResponseGetRecommendedCachePolicy, _CFURLResponseGetTextEncodingName,
_CFURLResponseGetTypeID, _CFURLResponseGetURL, _CFURLResponseSetExpectedContentLength,
_CFURLResponseSetExpiration, _CFURLResponseSetMIMEType, _CFURLResponseSetRecommendedCachePolicy,
_CFWriteStreamCreateWithFTPURL, _NSHTTPCookieComment, _NSHTTPCookieCommentURL,
_NSHTTPCookieDiscard, _NSHTTPCookieDomain, _NSHTTPCookieExpires,
_NSHTTPCookieManagerAcceptPolicyChangedNotification, _NSHTTPCookieManagerCookiesChangedNotification,
_NSHTTPCookieMaximumAge, _NSHTTPCookieName, _NSHTTPCookieOriginURL,
_NSHTTPCookiePath, _NSHTTPCookiePort, _NSHTTPCookieSameSiteLax,
_NSHTTPCookieSameSitePolicy, _NSHTTPCookieSameSiteStrict,
_NSHTTPCookieSecure, _NSHTTPCookieValue, _NSHTTPCookieVersion,
_NSNetServicesErrorCode, _NSNetServicesErrorDomain, _NSTCPConnectionConditionsUnmetReasonErrorDomain,
_NSURLAuthenticationMethodClientCertificate, _NSURLAuthenticationMethodDefault,
_NSURLAuthenticationMethodHTMLForm, _NSURLAuthenticationMethodHTTPBasic,
_NSURLAuthenticationMethodHTTPDigest, _NSURLAuthenticationMethodNTLM,
_NSURLAuthenticationMethodNegotiate, _NSURLAuthenticationMethodOAuth,
_NSURLAuthenticationMethodServerTrust, _NSURLAuthenticationMethodXMobileMeAuthToken,
_NSURLConnectionBackgroundDownloadCompletedInvocation, _NSURLConnectionBackgroundDownloadDestinationURL,
_NSURLConnectionBackgroundDownloadIdentifier, _NSURLConnectionBackgroundDownloadMediaKind,
_NSURLConnectionBackgroundDownloadPreCompletedInvocation,
_NSURLConnectionIsBackgroundDownload, _NSURLCredentialStorageChangedNotification,
_NSURLCredentialStorageRemoveSynchronizableCredentials, _NSURLProtectionSpaceFTP,
_NSURLProtectionSpaceFTPProxy, _NSURLProtectionSpaceHTTP,
_NSURLProtectionSpaceHTTPProxy, _NSURLProtectionSpaceHTTPS,
_NSURLProtectionSpaceHTTPSProxy, _NSURLProtectionSpaceSOCKSProxy,
_NSURLSessionDefaultLoadingPriority, _NSURLSessionDownloadTaskResumeData,
_NSURLSessionProxyErrorDomain, _NSURLSessionSourceApplicationBundleIdentifierIsExternal,
_NSURLSessionTaskOriginalStartTimeKey, _NSURLSessionTaskPriorityDefault,
_NSURLSessionTaskPriorityHigh, _NSURLSessionTaskPriorityLow,
_NSURLSessionTransferSizeUnknown, __CFCachedURLResponseGetMemMappedData,
__CFCachedURLResponseSetBecameFileBackedCallBackBlock, __CFErrorCreateWithStreamError,
__CFHTTPAuthenticationApplyProxyAuthorizationToRequest, __CFHTTPAuthenticationPasswordInClear,
__CFHTTPCookieCreateCookiesWithResponseMessage, __CFHTTPCookieCreateWithStringAndPartition,
__CFHTTPCookieStorageCopyCookiesForURLWithMainDocumentURL,
__CFHTTPCookieStorageCopyRequestHeaderFieldsForURL, __CFHTTPCookieStorageCreateInMemory,
__CFHTTPCookieStorageCreateWithProperties, __CFHTTPCookieStorageFlushCookieStores,
__CFHTTPCookieStorageGetDefault, __CFHTTPCookieStorageSetCookiesWithResponseHeaderFields,
__CFHTTPMessageCanRetry, __CFHTTPMessageSetResponseProxyURL,
__CFHTTPMessageSetResponseURL, __CFHTTPParsedCookiesWithResponseHeaderFields,
__CFHTTPServerConnectionCopyProperty, __CFHTTPServerConnectionGetClient,
__CFHTTPServerConnectionGetTypeID, __CFHTTPServerConnectionInvalidate,
__CFHTTPServerConnectionIsValid, __CFHTTPServerConnectionScheduleWithRunLoopAndMode,
__CFHTTPServerConnectionSetClient, __CFHTTPServerConnectionSetDispatchQueue,
__CFHTTPServerConnectionSetProperty, __CFHTTPServerCopyProperty,
__CFHTTPServerCreateService, __CFHTTPServerCreateWithAcceptedSocket,
__CFHTTPServerCreateWithStreams, __CFHTTPServerGetClient,
__CFHTTPServerGetTypeID, __CFHTTPServerInvalidate, __CFHTTPServerIsValid,
__CFHTTPServerRequestCopyBodyStream, __CFHTTPServerRequestCopyProperty,
__CFHTTPServerRequestCreateResponseMessage, __CFHTTPServerRequestGetClient,
__CFHTTPServerRequestGetTypeID, __CFHTTPServerRequestSetClient,
__CFHTTPServerResponseCopyProperty, __CFHTTPServerResponseCreateWithBodyStream,
__CFHTTPServerResponseCreateWithData, __CFHTTPServerResponseEnqueue,
__CFHTTPServerResponseGetClient, __CFHTTPServerResponseGetTypeID,
__CFHTTPServerResponseSetClient, __CFHTTPServerScheduleWithRunLoopAndMode,
__CFHTTPServerSetDispatchQueue, __CFHTTPServerSetProperty,
__CFHostIsDomainTopLevel, __CFHostIsDomainTopLevelForCertificatePolicy,
__CFHostIsDomainTopLevelForCookiePolicy, __CFHostStartInfoResolutionForInterface,
__CFNetServiceCreateFromServiceName, __CFNetServiceCreateFromURL,
__CFNetworkCopyATSContext, __CFNetworkCopyHSTSPolicies, __CFNetworkCopyPreferredLanguageCode,
__CFNetworkErrorCopyLocalizedDescriptionWithHostname, __CFNetworkErrorGetLocalizedDescription,
__CFNetworkErrorGetLocalizedFailureReason, __CFNetworkErrorGetLocalizedRecoverySuggestion,
__CFNetworkExecuteProxyAutoConfigurationURLDelegated, __CFNetworkHTTPConnectionCacheGetLimit,
__CFNetworkHTTPConnectionCacheSetLimit, __CFNetworkIsKnownHSTSHostWithSession,
__CFNetworkResetHSTS, __CFNetworkResetHSTSHosts, __CFNetworkResetHSTSHostsSinceDate,
__CFNetworkResetHSTSHostsWithSession, __CFNetworkSetATSContext,
__CFNetworkSetHSTSStoragePath, __CFNetworkSetOverrideSystemProxySettings,
__CFServerCreate, __CFServerGetPort, __CFServerInvalidate,
__CFServerStart, __CFSocketStreamCreatePair, __CFStreamErrorFromCFError,
__CFStringCreateRFC2616DateStringWithGregorianDate, __CFURLCacheCopyCacheDirectory,
__CFURLCacheLoadMemoryFromDiskNow, __CFURLCachePersistMemoryToDiskNow,
__CFURLCachePurgeMemoryCache, __CFURLCacheSetCacheEventCallBackBlock,
__CFURLCacheSetMemoryLimit, __CFURLConnectionCopyTimingData,
__CFURLConnectionSetFrameworkStubs, __CFURLCreateDataAndPropertiesFromResource,
__CFURLCredentialCreateArchive, __CFURLCredentialCreateForKerberosTicket,
__CFURLCredentialCreateFromArchive, __CFURLCredentialCreateOAuth1,
__CFURLCredentialCreateOAuth2, __CFURLCredentialCreateXMobileMeAuthToken,
__CFURLDestroyResource, __CFURLProtocolSendCacheResponseIsValidCallback,
__CFURLProtocolSendDidFailCallback, __CFURLProtocolSendDidFinishLoadingCallback,
__CFURLProtocolSendDidLoadDataCallback, __CFURLProtocolSendDidReceiveResponseCallback,
__CFURLRequestCopyContentDispositionEncodingFallbackArray,
__CFURLRequestCopyProtocolPropertyForKey, __CFURLRequestCreateArchiveList,
__CFURLRequestCreateFromArchiveList, __CFURLRequestSetAllowedProtocolTypes,
__CFURLRequestSetContentDispositionEncodingFallbackArray,
__CFURLRequestSetProtocolProperty, __CFURLRequestSetShouldPipelineNonIdempotentHTTP,
__CFURLRequestSetShouldSkipPipelineProbe, __CFURLRequestSetStorageSession,
__CFURLResponseCreateArchiveList, __CFURLResponseCreateFromArchiveList,
__CFURLResponseGetFreshnessLifetime, __CFURLResponseGetSSLCertificateContext,
__CFURLResponseMustRevalidate, __CFURLResponseSetCreationTime,
__CFURLStorageSessionCopyCache, __CFURLStorageSessionCopyCookieStorage,
__CFURLStorageSessionCopyCredentialStorage, __CFURLStorageSessionCopyIdentifier,
__CFURLStorageSessionCopyProcessDefault, __CFURLStorageSessionCreate,
__CFURLStorageSessionCreateWithData, __CFURLStorageSessionGetTypeID,
__CFURLWriteDataAndPropertiesToResource, __NSServerConfigurationOutboundConnectionProxyDictionary,
__NSServerConfigurationSOCKS5ServerCredentials, __NSURLErrorNWPathKey,
__NSURLErrorPrivacyProxyFailureKey, __NSURLErrorWebSocketHandshakeFailureReasonKey,
___AuthBrokerMain, ___CFNetworkAgentMessageProcessorMain,
___CFTubeSetTubeTypeNotifier, __kATSAllowsArbitraryLoadsForMediaKey,
__kCFHTTPCookiePolicyPropertyIsTopLevelNavigation, __kCFHTTPCookiePolicyPropertySiteForCookies,
__kCFHTTPServerAllInterfacesIdentifier, __kCFHTTPServerAllowAnonymousServer,
__kCFHTTPServerBoundInterfaceIdentifier, __kCFHTTPServerConnectionClientTrust,
__kCFHTTPServerConnectionMaxRequestBufferSize, __kCFHTTPServerConnectionPeer,
__kCFHTTPServerConnectionPeerCerts, __kCFHTTPServerConnectionServer,
__kCFHTTPServerErrorDomain, __kCFHTTPServerFailingRequest,
__kCFHTTPServerFailingResponse, __kCFHTTPServerHTTPServiceType,
__kCFHTTPServerIdleTimeout, __kCFHTTPServerKeychain, __kCFHTTPServerName,
__kCFHTTPServerRequestConnection, __kCFHTTPServerRequestHTTPVersion,
__kCFHTTPServerRequestHeaderOrderKey, __kCFHTTPServerRequestHeaderValuesKey,
__kCFHTTPServerRequestHeaders, __kCFHTTPServerRequestMethod,
__kCFHTTPServerRequestPath, __kCFHTTPServerRequestURL, __kCFHTTPServerRequireClientCertificate,
__kCFHTTPServerResponseConnection, __kCFHTTPServerResponseMessage,
__kCFHTTPServerResponseRequest, __kCFHTTPServerSSLSettings,
__kCFHTTPServerServerIdentity, __kCFHTTPServerServerTrustChain,
__kCFHTTPServerServicePort, __kCFHTTPServerServiceType, __kCFHTTPServerStreamSSLSettings,
__kCFHTTPServerWatchdogTimeout, __kCFHostByPassMasterAddressLookupString,
__kCFHostConnectByNamePortString, __kCFHostIPv4AddressesString,
__kCFHostIPv6AddressesString, __kCFHostMasterAddressLookupString,
__kCFHostProcessedDNSTypeSRVHostInfoString, __kCFHostProcessedDNSTypeSRVString,
__kCFNetworkHSTSExpiry, __kCFNetworkHSTSIncludeSubDomains,
__kCFNetworkHSTSPreloaded, __kCFNullHostInfoTypeString, __kCFStreamErrorCodeKey,
__kCFStreamErrorDomainKey, __kCFStreamPropertyAllowConstrainedNetworkAccess,
__kCFStreamPropertyAllowExpensiveAccess, __kCFStreamPropertyConnectionIsExpensive,
__kCFStreamPropertyConnectionStatistics, __kCFStreamPropertyConnectionViabilityChangedBlock,
__kCFStreamPropertyDNSIncludeAWDL, __kCFStreamPropertyDNSIncludeP2P,
__kCFStreamPropertyEnableConnectionStatistics, __kCFStreamPropertyFTPLogInOnly,
__kCFStreamPropertyFTPRemoveResource, __kCFStreamPropertyIndefiniteConnectionKickInterval,
__kCFStreamPropertyLargeDownload, __kCFStreamPropertyLocalAddressPreference,
__kCFStreamPropertyLowThroughputBlock, __kCFStreamPropertyLowThroughputThreshold,
__kCFStreamPropertyNPNProtocolsAvailable, __kCFStreamPropertyNPNSelectedProtocol,
__kCFStreamPropertyNoCompanion, __kCFStreamPropertyPrefersNoProxy,
__kCFStreamPropertyPreventsAppSSO, __kCFStreamPropertyProhibitInfraWiFi,
__kCFStreamPropertyQOSClass, __kCFStreamPropertyRaceTCPQUICForDomains,
__kCFStreamPropertySSLClientCertificateState, __kCFStreamPropertySSLClientCertificates,
__kCFStreamPropertySSLClientSideAuthentication, __kCFStreamPropertySSLNegotiatedCipher,
__kCFStreamPropertySSLNegotiatedProtocol, __kCFStreamPropertySocketImmediateBufferSize,
__kCFStreamPropertySocketImmediateBufferTimeOut, __kCFStreamPropertySocketLowPriorityIO,
__kCFStreamPropertyTCPAdaptiveReadTimeout, __kCFStreamPropertyTCPAdaptiveWriteTimeout,
__kCFStreamPropertyTCPConnectionMetadata, __kCFStreamPropertyTCPInfo,
__kCFStreamPropertyTCPKeepAliveOffload, __kCFStreamPropertyTCPKeepAliveParameters,
__kCFStreamPropertyWatchdogTimeout, __kCFStreamSSLDisableEphemeralDiffieHellmanCiphers,
__kCFStreamSSLShouldSetPeerID, __kCFStreamSSLTrustedLeafCertificates,
__kCFStreamSSLUseFalseStart, __kCFStreamSocketEnableECN, __kCFStreamSocketSetNoDelay,
__kCFStreamSocketSetRecvAnyIf, __kCFURLCachePartitionKey,
__kCFURLConnectionPropertyATSContext, __kCFURLConnectionPropertyATSFrameworkOverrides,
__kCFURLConnectionPropertyRespectConnectionClose, __kCFURLConnectionPropertyShouldReportTimingDataToAWD,
__kCFURLConnectionPropertyShouldSniff, __kCFURLConnectionPropertyTimingDataOptions,
__kCFURLErrorAuthFailedResponseKey, __kCFURLStorageSessionIsPrivate,
__kCFURLStorageSessionProcessSharing, __kTCPKeepAliveParametersEnabled,
__kTCPKeepAliveParametersIdleTime, __kTCPKeepAliveParametersInterval,
_cfnTranslateCFError, _kCFDNSServiceFailureKey, _kCFErrorDomainCFNetwork,
_kCFErrorDomainWinSock, _kCFFTPResourceGroup, _kCFFTPResourceLink,
_kCFFTPResourceModDate, _kCFFTPResourceMode, _kCFFTPResourceName,
_kCFFTPResourceOwner, _kCFFTPResourceSize, _kCFFTPResourceType,
_kCFFTPStatusCodeKey, _kCFGetAddrInfoFailureKey, _kCFHTTPAuthenticationAccountDomain,
_kCFHTTPAuthenticationPassword, _kCFHTTPAuthenticationSchemeBasic,
_kCFHTTPAuthenticationSchemeDigest, _kCFHTTPAuthenticationSchemeKerberos,
_kCFHTTPAuthenticationSchemeNTLM, _kCFHTTPAuthenticationSchemeNegotiate,
_kCFHTTPAuthenticationSchemeNegotiate2, _kCFHTTPAuthenticationSchemeXMobileMeAuthToken,
_kCFHTTPAuthenticationUsername, _kCFHTTPCookieDomain, _kCFHTTPCookieLocalFileDomain,
_kCFHTTPCookieName, _kCFHTTPCookiePath, _kCFHTTPCookieValue,
_kCFHTTPRedirectionResponse, _kCFHTTPVersion1_0, _kCFHTTPVersion1_1,
_kCFHTTPVersion2_0, _kCFHTTPVersion3_0, _kCFHostAddressesString,
_kCFHostDNSTypeSRVString, _kCFHostNamesString, _kCFHostReachabilityString,
_kCFNIE, _kCFNetDiagnosticPingOptionDataLength, _kCFNetDiagnosticPingOptionPacketCount,
_kCFNetDiagnosticPingOptionTimeout, _kCFNetDiagnosticPingOptionTrafficClass,
_kCFNetDiagnosticPingOptionTypeOfService, _kCFNetworkProxiesExceptionsList,
_kCFNetworkProxiesExcludeSimpleHostnames, _kCFNetworkProxiesFTPEnable,
_kCFNetworkProxiesFTPPassive, _kCFNetworkProxiesFTPPort, _kCFNetworkProxiesFTPProxy,
_kCFNetworkProxiesGopherEnable, _kCFNetworkProxiesGopherPort,
_kCFNetworkProxiesGopherProxy, _kCFNetworkProxiesHTTPEnable,
_kCFNetworkProxiesHTTPPort, _kCFNetworkProxiesHTTPProxy, _kCFNetworkProxiesHTTPSEnable,
_kCFNetworkProxiesHTTPSPort, _kCFNetworkProxiesHTTPSProxy,
_kCFNetworkProxiesProxyAutoConfigEnable, _kCFNetworkProxiesProxyAutoConfigJavaScript,
_kCFNetworkProxiesProxyAutoConfigURLString, _kCFNetworkProxiesProxyAutoDiscoveryEnable,
_kCFNetworkProxiesRTSPEnable, _kCFNetworkProxiesRTSPPort,
_kCFNetworkProxiesRTSPProxy, _kCFNetworkProxiesSOCKSEnable,
_kCFNetworkProxiesSOCKSPort, _kCFNetworkProxiesSOCKSProxy,
_kCFProxyAutoConfigurationHTTPResponseKey, _kCFProxyAutoConfigurationJavaScriptKey,
_kCFProxyAutoConfigurationURLKey, _kCFProxyHostNameKey, _kCFProxyPasswordKey,
_kCFProxyPortNumberKey, _kCFProxyTypeAutoConfigurationJavaScript,
_kCFProxyTypeAutoConfigurationURL, _kCFProxyTypeFTP, _kCFProxyTypeHTTP,
_kCFProxyTypeHTTPS, _kCFProxyTypeKey, _kCFProxyTypeNone, _kCFProxyTypeSOCKS,
_kCFProxyUsernameKey, _kCFSOCKSNegotiationMethodKey, _kCFSOCKSStatusCodeKey,
_kCFSOCKSVersionKey, _kCFStreamErrorDomainFTP, _kCFStreamErrorDomainHTTP,
_kCFStreamErrorDomainMach, _kCFStreamErrorDomainNetDB, _kCFStreamErrorDomainNetServices,
_kCFStreamErrorDomainSystemConfiguration, _kCFStreamErrorDomainWinSock,
_kCFStreamErrorHTTPConnectionLost, _kCFStreamNetworkServiceType,
_kCFStreamNetworkServiceTypeAVStreaming, _kCFStreamNetworkServiceTypeBackground,
_kCFStreamNetworkServiceTypeBackgroundSystemInitiated, _kCFStreamNetworkServiceTypeCallSignaling,
_kCFStreamNetworkServiceTypeNetworkControl, _kCFStreamNetworkServiceTypeOAM,
_kCFStreamNetworkServiceTypeResponsiveAV, _kCFStreamNetworkServiceTypeResponsiveData,
_kCFStreamNetworkServiceTypeVideo, _kCFStreamNetworkServiceTypeVoIP,
_kCFStreamNetworkServiceTypeVoice, _kCFStreamPropertyAccountIdentifier,
_kCFStreamPropertyAllowConstrainedNetworkAccess, _kCFStreamPropertyAllowExpensiveNetworkAccess,
_kCFStreamPropertyBoundInterfaceIdentifier, _kCFStreamPropertyCONNECTAdditionalHeaders,
_kCFStreamPropertyCONNECTProxy, _kCFStreamPropertyCONNECTProxyHost,
_kCFStreamPropertyCONNECTProxyPort, _kCFStreamPropertyCONNECTResponse,
_kCFStreamPropertyConditionalConnectionProperties, _kCFStreamPropertyConnectionFallbackEnabled,
_kCFStreamPropertyConnectionFastFallbackEnabled, _kCFStreamPropertyConnectionIsCellular,
_kCFStreamPropertyConnectionIsExpensive, _kCFStreamPropertyConnectionIsMultipath,
_kCFStreamPropertyDUETConditional, _kCFStreamPropertyDataConnectionServiceType,
_kCFStreamPropertyDataContextIdentifier, _kCFStreamPropertyDataContextOnDemand,
_kCFStreamPropertyFTPAttemptPersistentConnection, _kCFStreamPropertyFTPFetchResourceInfo,
_kCFStreamPropertyFTPFileTransferOffset, _kCFStreamPropertyFTPPassword,
_kCFStreamPropertyFTPProxy, _kCFStreamPropertyFTPProxyHost,
_kCFStreamPropertyFTPProxyPassword, _kCFStreamPropertyFTPProxyPort,
_kCFStreamPropertyFTPProxyUser, _kCFStreamPropertyFTPResourceSize,
_kCFStreamPropertyFTPUsePassiveMode, _kCFStreamPropertyFTPUserName,
_kCFStreamPropertyHTTPAttemptPersistentConnection, _kCFStreamPropertyHTTPFinalRequest,
_kCFStreamPropertyHTTPFinalURL, _kCFStreamPropertyHTTPProxy,
_kCFStreamPropertyHTTPProxyHost, _kCFStreamPropertyHTTPProxyPort,
_kCFStreamPropertyHTTPRequestBytesWrittenCount, _kCFStreamPropertyHTTPResponseHeader,
_kCFStreamPropertyHTTPSProxyHost, _kCFStreamPropertyHTTPSProxyPort,
_kCFStreamPropertyHTTPShouldAutoredirect, _kCFStreamPropertyHTTPUseSystemProxySettings,
_kCFStreamPropertyIndefiniteConnection, _kCFStreamPropertyInterfaceIdentifier,
_kCFStreamPropertyMPTCPConnectedSubflowCount, _kCFStreamPropertyMPTCPPrimarySubflowInterfaceName,
_kCFStreamPropertyMPTCPSubflowCount, _kCFStreamPropertyMPTCPSubflowSwitchCounts,
_kCFStreamPropertyNoCellular, _kCFStreamPropertyOpportunisticConnection,
_kCFStreamPropertyPersistentConnection, _kCFStreamPropertyProxyLocalBypass,
_kCFStreamPropertySSLContext, _kCFStreamPropertySSLPeerCertificates,
_kCFStreamPropertySSLPeerTrust, _kCFStreamPropertySSLSettings,
_kCFStreamPropertySocketExtendedBackgroundIdleMode, _kCFStreamPropertySocketRemoteHost,
_kCFStreamPropertySocketRemoteNetService, _kCFStreamPropertySourceApplication,
_kCFStreamPropertySourceApplicationBundleIdentifier, _kCFStreamSSLAllowsAnyRoot,
_kCFStreamSSLAllowsExpiredCertificates, _kCFStreamSSLAllowsExpiredRoots,
_kCFStreamSSLCertificates, _kCFStreamSSLEnabledCiphers, _kCFStreamSSLIsServer,
_kCFStreamSSLLevel, _kCFStreamSSLPSKIdentity, _kCFStreamSSLPSKSharedSecret,
_kCFStreamSSLPeerName, _kCFStreamSSLValidatesCertificateChain,
_kCFStreamSocketSecurityLevelTLSv1SSLv3, _kCFStreamSocketSecurityLevelTLSv1_0,
_kCFStreamSocketSecurityLevelTLSv1_0SSLv3, _kCFStreamSocketSecurityLevelTLSv1_1,
_kCFStreamSocketSecurityLevelTLSv1_2, _kCFURLConnectionProhibitAuthChallengeUI,
_kCFURLConnectionPropertyStrictContentLength, _kCFURLConnectionSocketStreamProperties,
_kCFURLConnectionSuspensionThreshold, _kCFURLConnectionURLConnectionProperties,
_kCFURLCredentialKerberosTicketAllowDelegation, _kCFURLErrorFailingURLErrorKey,
_kCFURLErrorFailingURLStringErrorKey, _kCFURLErrorPeerAddressKey,
_kCFURLRequestAllowAllPOSTCaching, _kCFURLRequestContentDecoderSkipURLCheck,
_kCFURLRequestDoNotDecodeData, _kCFURLRequestPreAuthXMMeAuthToken,
_kCFURLResponseExpectedContentLengthUnknown, _kConditionalConnectionActivityName,
_kConditionalConnectionClientOptInDiscretionary, _kConditionalConnectionInTransitionalDiscretionaryPeriod,
_kConditionalConnectionIsDiscretionary, _kConditionalConnectionIsUpload,
_kConditionalConnectionOnBehalfOfPairedDevice, _kConditionalConnectionRequirementDuetPreClearedMode,
_kConditionalConnectionRequirementPowerPluggedIn, _kConditionalConnectionRequirementTimeWindowDelay,
_kConditionalConnectionRequirementTimeWindowDuration, _kConditionalConnectionRequirementWorkload,
_kNSURLSessionLaunchOnDemandClientIdentifierKey, _kNSURLSessionLaunchOnDemandNotificationName,
_kNSURLSessionLaunchOnDemandSessionIdentifierKey ]
objc-classes: [ AVAssetDownloadTask, AVAssetDownloadURLSession, NSCachedURLResponse,
NSGZipDecoder, NSHTTPCookie, NSHTTPCookieStorage, NSHTTPURLResponse,
NSHost, NSMutableURLRequest, NSNetService, NSNetServiceBrowser,
NSURLAuthenticationChallenge, NSURLCache, NSURLConnection,
NSURLCredential, NSURLCredentialStorage, NSURLDownload, NSURLProtectionSpace,
NSURLProtocol, NSURLRequest, NSURLResponse, NSURLSession,
NSURLSessionAVAggregateAssetDownloadTask, NSURLSessionAVAssetDownloadTask,
NSURLSessionConfiguration, NSURLSessionDataTask, NSURLSessionDownloadTask,
NSURLSessionEffectiveConfiguration, NSURLSessionMutableEffectiveConfiguration,
NSURLSessionStreamTask, NSURLSessionTask, NSURLSessionTaskDependency,
NSURLSessionTaskDependencyDescription, NSURLSessionTaskDependencyTree,
NSURLSessionTaskMetrics, NSURLSessionTaskTransactionMetrics,
NSURLSessionUploadTask, NSURLSessionWebSocketMessage, NSURLSessionWebSocketTask,
_NSCFServer, _NSHSTSStorage, _NSHTTPAlternativeServiceEntry,
_NSHTTPAlternativeServicesFilter, _NSHTTPAlternativeServicesStorage,
_NSHTTPConnectionInfo, _NSURLSessionConnectionBeginProperties,
_NSURLSessionConnectionEstablishProperties, __NSCFURLSessionTaskInfo,
__NSCFURLSessionXPC, __NSURLSessionStatistics ]
- targets: [ x86_64-macos, arm64e-macos, arm64-macos ]
symbols: [ _CFNetServiceGetProtocolSpecificInformation, _CFNetServiceSetProtocolSpecificInformation ]
...
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CFNetwork.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CFNetwork.framework/Headers/CFFTPStream.h | /*
File: CFNetwork/CFFTPStream.h
Contains: CoreFoundation FTP stream header
Copyright: Copyright (c) 2001-2013 Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __CFFTPSTREAM__
#define __CFFTPSTREAM__
#ifndef __CFNETWORKDEFS__
#include <CFNetwork/CFNetworkDefs.h>
#endif
#ifndef __CFSTREAM__
#include <CoreFoundation/CFStream.h>
#endif
#if PRAGMA_ONCE
#pragma once
#endif
CF_EXTERN_C_BEGIN
CF_ASSUME_NONNULL_BEGIN
/*
* kCFStreamErrorDomainFTP
*
* Discussion:
* Result code returned by FTP server
*
*/
CFN_EXPORT const SInt32 kCFStreamErrorDomainFTP CF_AVAILABLE(10_3, 2_0);
/*
* FTP Stream Property keys.
* These keys can be passed to the stream property "set/get" functions,
* such as CFReadStreamSetProperty/CFReadStreamCopyProperty, or to a
* CFDictionary creator or an item accessor/mutator. The comment before
* each key declaration (treated as definition) indicates the value type
* of the property.
*/
/*
* kCFStreamPropertyFTPUserName
*
* Discussion:
* Stream property key, for both set and copy operations. CFString
* type to hold login user name. Don't set this property if you
* want anonymous FTP.
*
*/
CFN_EXPORT const CFStringRef kCFStreamPropertyFTPUserName CF_DEPRECATED(10_3, 10_11, 2_0, 9_0 , "Use NSURLSessionAPI for ftp requests");
/*
* kCFStreamPropertyFTPPassword
*
* Discussion:
* Stream property key, for both set and copy operations. CFString
* type to hold login password. Don't set this property if you want
* anonymous FTP.
*
*/
CFN_EXPORT const CFStringRef kCFStreamPropertyFTPPassword CF_DEPRECATED(10_3, 10_11, 2_0, 9_0 , "Use NSURLSessionAPI for ftp requests");
/*
* kCFStreamPropertyFTPUsePassiveMode
*
* Discussion:
* Stream property key, for both set and copy operations. CFBoolean
* type. kCFBooleanTrue means use passive mode, kCFBooleanFalse
* otherwise
*
*/
CFN_EXPORT const CFStringRef kCFStreamPropertyFTPUsePassiveMode CF_DEPRECATED(10_3, 10_11, 2_0, 9_0 , "Use NSURLSessionAPI for ftp requests");
/*
* kCFStreamPropertyFTPResourceSize
*
* Discussion:
* Stream property key, for read stream copy operations. CFNumber
* of kCFNumberLongLongType to hold resource size in bytes.
*
*/
CFN_EXPORT const CFStringRef kCFStreamPropertyFTPResourceSize CF_DEPRECATED(10_3, 10_11, 2_0, 9_0 , "Use NSURLSessionAPI for ftp requests");
/*
* kCFStreamPropertyFTPFetchResourceInfo
*
* Discussion:
* Stream property key, for both set and copy operations. CFBoolean
* type. TRUE means that resource info, such as size, must be
* provided before download starts at higher cost. Don't set if
* resource size/other info is unnecessary. Initially, only
* resource size is implemented.
*
*/
CFN_EXPORT const CFStringRef kCFStreamPropertyFTPFetchResourceInfo CF_DEPRECATED(10_3, 10_11, 2_0, 9_0 , "Use NSURLSessionAPI for ftp requests");
/*
* kCFStreamPropertyFTPFileTransferOffset
*
* Discussion:
* Stream property key, for both set and copy operations. CFNumber
* of kCFNumberLongLongType for the file offset to start transfer at.
*
*/
CFN_EXPORT const CFStringRef kCFStreamPropertyFTPFileTransferOffset CF_DEPRECATED(10_3, 10_11, 2_0, 9_0 , "Use NSURLSessionAPI for ftp requests");
/*
* kCFStreamPropertyFTPAttemptPersistentConnection
*
* Discussion:
* Stream property key, for both set and copy operations. CFBoolean
* type. TRUE by default, set to FALSE to avoid reusing existing
* server connections.
*
*/
CFN_EXPORT const CFStringRef kCFStreamPropertyFTPAttemptPersistentConnection CF_DEPRECATED(10_3, 10_11, 2_0, 9_0 , "Use NSURLSessionAPI for ftp requests");
/*
* kCFStreamPropertyFTPProxy
*
* Discussion:
* Stream property key, for both set and copy operations.
* CFDictionary type that holds key-value pairs of proxy dictionary.
* The dictionary returned by SystemConfiguration can also be
* passed directly as the value.
*
*/
CFN_EXPORT const CFStringRef kCFStreamPropertyFTPProxy CF_DEPRECATED(10_3, 10_11, 2_0, 9_0 , "Use NSURLSessionAPI for ftp requests");
/*
* kCFStreamPropertyFTPProxyHost
*
* Discussion:
* Stream property key or FTP Proxy dictionary key, for both set and
* copy operations. It matches kSCPropNetProxiesFTPProxy defined in
* SCSchemaDefinitions.h. CFString for proxy server host name.
* This property can be set and copied individually or via a
* CFDictionary.
*
*/
CFN_EXPORT const CFStringRef kCFStreamPropertyFTPProxyHost CF_DEPRECATED(10_3, 10_11, 2_0, 9_0 , "Use NSURLSessionAPI for ftp requests");
/*
* kCFStreamPropertyFTPProxyPort
*
* Discussion:
* Stream property key or FTP Proxy dictionary key, for both set and
* copy operations. It matches kSCPropNetProxiesFTPPort defined in
* SCSchemaDefinitions.h. CFNumber of kCFNumberIntType for proxy
* server port number. This property can be set and copied
* individually or via a CFDictionary.
*
*/
CFN_EXPORT const CFStringRef kCFStreamPropertyFTPProxyPort CF_DEPRECATED(10_3, 10_11, 2_0, 9_0 , "Use NSURLSessionAPI for ftp requests");
/*
* kCFStreamPropertyFTPProxyUser
*
*/
CFN_EXPORT const CFStringRef kCFStreamPropertyFTPProxyUser CF_DEPRECATED(10_3, 10_11, 2_0, 9_0 , "Use NSURLSessionAPI for ftp requests");
/*
* kCFStreamPropertyFTPProxyPassword
*
*/
CFN_EXPORT const CFStringRef kCFStreamPropertyFTPProxyPassword CF_DEPRECATED(10_3, 10_11, 2_0, 9_0 , "Use NSURLSessionAPI for ftp requests");
/*
* CFDictionary keys for resource information. The information is
* extracted from a line of the directory list by function
* CFFTPCreateParsedResourceListing.
*/
/*
* kCFFTPResourceMode
*
* Discussion:
* CFDictionary key, for get value operation. CFNumber to hold the
* resource access permission defined in sys/types.h.
*
*/
CFN_EXPORT const CFStringRef kCFFTPResourceMode CF_DEPRECATED(10_3, 10_11, 2_0, 9_0 , "Use NSURLSessionAPI for ftp requests");
/*
* kCFFTPResourceName
*
* Discussion:
* CFDictionary key, for get value operation. CFString that holds
* the resource name.
*
*/
CFN_EXPORT const CFStringRef kCFFTPResourceName CF_DEPRECATED(10_3, 10_11, 2_0, 9_0 , "Use NSURLSessionAPI for ftp requests");
/*
* kCFFTPResourceOwner
*
* Discussion:
* CFDictionary key, for get value operation. CFString that holds
* the resource owner's name.
*
*/
CFN_EXPORT const CFStringRef kCFFTPResourceOwner CF_DEPRECATED(10_3, 10_11, 2_0, 9_0 , "Use NSURLSessionAPI for ftp requests");
/*
* kCFFTPResourceGroup
*
* Discussion:
* CFDictionary key, for get value operation. CFString to hold the
* name of the group that shares the resource.
*
*/
CFN_EXPORT const CFStringRef kCFFTPResourceGroup CF_DEPRECATED(10_3, 10_11, 2_0, 9_0 , "Use NSURLSessionAPI for ftp requests");
/*
* kCFFTPResourceLink
*
* Discussion:
* CFDictionary key, for get value operation. CFString to hold
* symbolic link information. If the item is a symbolic link the
* string will contain the path to the item the link references.
*
*/
CFN_EXPORT const CFStringRef kCFFTPResourceLink CF_DEPRECATED(10_3, 10_11, 2_0, 9_0 , "Use NSURLSessionAPI for ftp requests");
/*
* kCFFTPResourceSize
*
* Discussion:
* CFDictionary key, for get value operation. CFNumber of
* kCFNumberLongLongType to hold the resource length in bytes.
*
*/
CFN_EXPORT const CFStringRef kCFFTPResourceSize CF_DEPRECATED(10_3, 10_11, 2_0, 9_0 , "Use NSURLSessionAPI for ftp requests");
/*
* kCFFTPResourceType
*
* Discussion:
* CFDictionary key, for get value operation. CFNumber to hold the
* resource type as defined in sys/dirent.h.
*
*/
CFN_EXPORT const CFStringRef kCFFTPResourceType CF_DEPRECATED(10_3, 10_11, 2_0, 9_0 , "Use NSURLSessionAPI for ftp requests");
/*
* kCFFTPResourceModDate
*
* Discussion:
* CFDictionary key, for get value operation. CFDate to hold the
* last modification date and time information.
*
*/
CFN_EXPORT const CFStringRef kCFFTPResourceModDate CF_DEPRECATED(10_3, 10_11, 2_0, 9_0 , "Use NSURLSessionAPI for ftp requests");
/*
* CFReadStreamCreateWithFTPURL()
*
* DEPRECATED: Use NSURLSessionAPI for ftp requests
*
* Discussion:
* Create an FTP read stream for downloading operation from an FTP
* URL. If the URL refers to a directory, the stream is a filtered
* line-at-a-time read stream corresponding to the listing results
* provided by the server. If it's a file, then the stream is a
* regular read stream providing the data for that file.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* alloc:
* A pointer to the CFAllocator which should be used to allocate
* memory for the CF read stream and its storage for values. If
* this reference is not a valid CFAllocator, the behavior is
* undefined.
*
* ftpURL:
* A pointer to a CFURL structure created by CFURLCreateWithString
* function. If this parameter is not a pointer to a valid CFURL
* structure, the behavior is undefined.
*
* Result:
* A pointer to the CF read stream created, or NULL if failed. It is
* caller's responsibilty to release the memory allocated for the
* read stream.
*
*/
CFN_EXPORT CFReadStreamRef
CFReadStreamCreateWithFTPURL(CFAllocatorRef __nullable alloc, CFURLRef ftpURL) CF_DEPRECATED(10_3, 10_11, 2_0, 9_0 , "Use NSURLSessionAPI for ftp requests");
/*
* CFFTPCreateParsedResourceListing()
*
* DEPRECATED: Use NSURLSessionAPI for ftp requests
*
* Discussion:
* Parse a line of file or folder listing of Unix format, and store
* the extracted result in a CFDictionary.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* alloc:
* A pointer to the CFAllocator which should be used to allocate
* memory for the CFDictionary to hold resource info. If this
* reference is not a valid CFAllocator, the behavior is undefined.
*
* buffer:
* A pointer to a buffer that may hold lines of resource listing,
* but only the first line starting from buffer[0] will be parsed
* each call.
*
* bufferLength:
* The maximum buffer size in bytes started from the location
* pointed by "buffer."
*
* parsed:
* A pointer to a CFDictionary pointer. The dictionary holds the
* extracted resource information. When parsing fails, a NULL
* pointer will be returned. It is caller's responsibilty to
* release the memory allocated for the dictionary.
*
* Result:
* The number of bytes consumed from buffer, 0 if there are not
* enough bytes, or -1 if a parse failure occurs.
*
*/
CFN_EXPORT CFIndex
CFFTPCreateParsedResourceListing(CFAllocatorRef __nullable alloc, const UInt8 *buffer, CFIndex bufferLength, CFDictionaryRef __nullable * __nullable parsed) CF_DEPRECATED(10_3, 10_11, 2_0, 9_0 , "Use NSURLSessionAPI for ftp requests");
/*
* CFWriteStreamCreateWithFTPURL()
*
* DEPRECATED: Use NSURLSessionAPI for ftp requests
*
* Discussion:
* Create an FTP write stream for uploading operation to a FTP URL.
* If the URL specifies a directory, the open will be followed by a
* close event/state and the directory will have been created.
* Intermediary directory structure is not created.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* alloc:
* A pointer to the CFAllocator which should be used to allocate
* memory for the CF read stream and its storage for values. If
* this reference is not a valid CFAllocator, the behavior is
* undefined.
*
* ftpURL:
* A pointer to a CFURL structure created by CFURLCreateWithString
* function. If this parameter is not a pointer to a valid CFURL
* structure, the behavior is undefined.
*
* Result:
* A pointer to the CF write stream created, or NULL if failed. It
* is caller's responsibilty to release the memory allocated for the
* write stream.
*
*/
CFN_EXPORT CFWriteStreamRef
CFWriteStreamCreateWithFTPURL(CFAllocatorRef __nullable alloc, CFURLRef ftpURL) CF_DEPRECATED(10_3, 10_11, 2_0, 9_0 , "Use NSURLSessionAPI for ftp requests");
CF_ASSUME_NONNULL_END
CF_EXTERN_C_END
#endif /* __CFFTPSTREAM__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CFNetwork.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CFNetwork.framework/Headers/CFHTTPAuthentication.h | /*
File: CFNetwork/CFHTTPAuthentication.h
Contains: CoreFoundation Network HTTP authentication header
Copyright: Copyright (c) 2001-2013 Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __CFHTTPAUTHENTICATION__
#define __CFHTTPAUTHENTICATION__
#ifndef __CFNETWORKDEFS__
#include <CFNetwork/CFNetworkDefs.h>
#endif
#ifndef __COREFOUNDATION__
#include <CoreFoundation/CoreFoundation.h>
#endif
#ifndef __CFHTTPMESSAGE__
#include <CFNetwork/CFHTTPMessage.h>
#endif
#if PRAGMA_ONCE
#pragma once
#endif
CF_EXTERN_C_BEGIN
CF_ASSUME_NONNULL_BEGIN
/*
* CFHTTPAuthenticationRef
*
* Discussion:
* This is the type of a reference to HTTP authentication
* information.
*/
typedef struct _CFHTTPAuthentication* CFHTTPAuthenticationRef;
/*
* CFStreamErrorHTTPAuthentication
*
* Discussion:
* Authentication errors which may be returned as a result of trying
* to apply authentication to a request. These errors are in the
* kCFStreamErrorDomainHTTP domain.
*/
typedef CF_ENUM(int, CFStreamErrorHTTPAuthentication) {
/*
* The type of authentication to be applied to a request is not
* supported.
*/
kCFStreamErrorHTTPAuthenticationTypeUnsupported = -1000,
/*
* The username was in a format not suitable for applying to the
* request.
*/
kCFStreamErrorHTTPAuthenticationBadUserName = -1001,
/*
* The password was in a format not suitable for applying to the
* request.
*/
kCFStreamErrorHTTPAuthenticationBadPassword = -1002
};
/*
* kCFHTTPAuthenticationUsername
*
* Discussion:
* CFDictionary key, for CFHTTPMessageApplyCredentialDictionary. The
* username for authentication as a CFString. Needs to be added if
* CFHTTPAuthenticationRequiresUserNameAndPassword returns TRUE.
*
*/
CFN_EXPORT const CFStringRef kCFHTTPAuthenticationUsername CF_AVAILABLE(10_4, 2_0);
/*
* kCFHTTPAuthenticationPassword
*
* Discussion:
* CFDictionary key, for CFHTTPMessageApplyCredentialDictionary. The
* password for authentication as a CFString. Needs to be added if
* CFHTTPAuthenticationRequiresUserNameAndPassword returns TRUE.
*
*/
CFN_EXPORT const CFStringRef kCFHTTPAuthenticationPassword CF_AVAILABLE(10_4, 2_0);
/*
* kCFHTTPAuthenticationAccountDomain
*
* Discussion:
* CFDictionary key, for CFHTTPMessageApplyCredentialDictionary. The
* domain for authentication as a CFString. Needs to be added if
* CFHTTPAuthenticationRequiresAccountDomain returns TRUE.
*
*/
CFN_EXPORT const CFStringRef kCFHTTPAuthenticationAccountDomain CF_AVAILABLE(10_4, 2_0);
/*
* CFHTTPAuthenticationGetTypeID()
*
* Discussion:
* Returns the type identifier of all CFHTTPAuthentication instances.
*
* Mac OS X threading:
* Thread safe
*
*/
CFN_EXPORT CFTypeID
CFHTTPAuthenticationGetTypeID(void) CF_AVAILABLE(10_2, 2_0);
/*
* CFHTTPAuthenticationCreateFromResponse()
*
* Discussion:
* Based on a response of 401 or 407, this function will create a
* new authentication object which can be used for adding
* credentials to future requests.
*
* Mac OS X threading:
* Thread safe
* The API's to CFHTTPAuthenticationRef are thread-safe so long as
* multiple threads are not altering the same
* CFHTTPAuthenticationRef at the same time.
*
* Parameters:
*
* alloc:
* Allocator to use for creating authentication object
*
* response:
* Failed response.
*
* Result:
* A freshly created authentication object useful for applying
* authentication credentials to new requests.
*
*/
CFN_EXPORT CFHTTPAuthenticationRef
CFHTTPAuthenticationCreateFromResponse(CFAllocatorRef __nullable alloc, CFHTTPMessageRef response) CF_AVAILABLE(10_2, 2_0);
/*
* CFHTTPAuthenticationIsValid()
*
* Discussion:
* Returns TRUE if the given authentication information was
* instantiated correctly and contains enough information in order
* to be applied to a request. If FALSE is returned, the object may
* still contain information which is useful to the user, e.g.
* unsupported method name. An invalid object may be queried for
* information but may not be applied to a request.
*
* Mac OS X threading:
* Thread safe
* The API's to CFHTTPAuthenticationRef are thread-safe so long as
* multiple threads are not altering the same
* CFHTTPAuthenticationRef at the same time.
*
* Parameters:
*
* auth:
* The authentication information being queried.
*
* error:
* Reference to a CFStreamError which will be populated in the
* case of an error in creation. Pass NULL if not interested in
* the failure reason. The error domain will be
* kCFStreamErrorDomainHTTP, and the error code will be one of
* those defined in CFHTTPStream.h or one of those listed as
* CFStreamErrorHTTPAuthentication.
*
* Result:
* TRUE or FALSE depending on whether the authentication object is
* good for applying credentials to further requests.
*
*/
CFN_EXPORT Boolean
CFHTTPAuthenticationIsValid(CFHTTPAuthenticationRef auth, CFStreamError * __nullable error) CF_AVAILABLE(10_2, 2_0);
/*
* CFHTTPAuthenticationAppliesToRequest()
*
* Discussion:
* Returns TRUE if the given request requires credentials based upon
* the given authentication information.
*
* Mac OS X threading:
* Thread safe
* The API's to CFHTTPAuthenticationRef are thread-safe so long as
* multiple threads are not altering the same
* CFHTTPAuthenticationRef at the same time.
*
* Parameters:
*
* auth:
* The authentication information being queried.
*
* request:
* The request which is believed to need the given authentication.
*
* Result:
* TRUE if the given authentication information should be applied to
* the request, otherwise FALSE is returned.
*
*/
CFN_EXPORT Boolean
CFHTTPAuthenticationAppliesToRequest(CFHTTPAuthenticationRef auth, CFHTTPMessageRef request) CF_AVAILABLE(10_2, 2_0);
/*
* CFHTTPAuthenticationRequiresOrderedRequests()
*
* Discussion:
* Some authentication methods require that future requests must be
* performed in an ordered manner, so that information from a
* response can be added to a following request.
*
* Mac OS X threading:
* Thread safe
* The API's to CFHTTPAuthenticationRef are thread-safe so long as
* multiple threads are not altering the same
* CFHTTPAuthenticationRef at the same time.
*
* Parameters:
*
* auth:
* The authentication information being queried.
*
* Result:
* Returns TRUE if the given authentication method requires ordered
* requests.
*
*/
CFN_EXPORT Boolean
CFHTTPAuthenticationRequiresOrderedRequests(CFHTTPAuthenticationRef auth) CF_AVAILABLE(10_2, 2_0);
/*
* CFHTTPMessageApplyCredentials()
*
* Discussion:
* Perform the authentication method required on the request using
* the given username and password.
*
* Mac OS X threading:
* Thread safe
* The API's to CFHTTPAuthenticationRef are thread-safe so long as
* multiple threads are not altering the same
* CFHTTPAuthenticationRef at the same time.
*
* Parameters:
*
* request:
* The request which is to receive the credentials.
*
* auth:
* The authentication information for the given request.
*
* username:
* The username to use for performing the authentication.
*
* password:
* The password to use for performing the authentication.
*
* error:
* Reference to a CFStreamError which will be populated with the
* error information should one occurr during the application of
* the credentials. Pass NULL if not interested in the failure
* reason. The error domain will be kCFStreamErrorDomainHTTP, and
* the error code will be one of those define in CFHTTPStream.h or
* one of those listed as CFStreamErrorHTTPAuthentication.
*
* Result:
* TRUE will be returned if the application of the credentials to
* the request was successful, otherwise FALSE is returned.
*
*/
CFN_EXPORT Boolean
CFHTTPMessageApplyCredentials(
CFHTTPMessageRef request,
CFHTTPAuthenticationRef auth,
CFStringRef __nullable username,
CFStringRef __nullable password,
CFStreamError * __nullable error) CF_AVAILABLE(10_2, 2_0);
/*
* CFHTTPMessageApplyCredentialDictionary()
*
* Discussion:
* Perform the authentication method required on the request using
* the given credential information.
*
* Mac OS X threading:
* Thread safe
* The API's to CFHTTPAuthenticationRef are thread-safe so long as
* multiple threads are not altering the same
* CFHTTPAuthenticationRef at the same time.
*
* Parameters:
*
* request:
* The request which is to receive the credentials.
*
* auth:
* The authentication information for the given request.
*
* dict:
* A dictionary containing credentials to be applied to the
* request. Valid keys are declared above.
*
* error:
* Reference to a CFStreamError which will be populated with the
* error information should one occurr during the application of
* the credentials. Pass NULL if not interested in the failure
* reason. The error domain will be kCFStreamErrorDomainHTTP, and
* the error code will be one of those define in CFHTTPStream.h or
* one of those listed as CFStreamErrorHTTPAuthentication.
*
* Result:
* TRUE will be returned if the application of the credentials to
* the request was successful, otherwise FALSE is returned.
*
*/
CFN_EXPORT Boolean
CFHTTPMessageApplyCredentialDictionary(
CFHTTPMessageRef request,
CFHTTPAuthenticationRef auth,
CFDictionaryRef dict,
CFStreamError * __nullable error) CF_AVAILABLE(10_4, 2_0);
/*
* CFHTTPAuthenticationCopyRealm()
*
* Discussion:
* Some authentication techniques provide for namespaces on top of
* domains. This call will return the authentication information's
* namespace if there is one, otherwise it will return NULL. This
* namespace is usually used for prompting the application user for
* a name and password.
*
* Mac OS X threading:
* Thread safe
* The API's to CFHTTPAuthenticationRef are thread-safe so long as
* multiple threads are not altering the same
* CFHTTPAuthenticationRef at the same time.
*
* Parameters:
*
* auth:
* The authentication information being queried.
*
* Result:
* This call will return the authentication information's namespace
* if there is one, otherwise it will return NULL.
*
*/
CFN_EXPORT CFStringRef
CFHTTPAuthenticationCopyRealm(CFHTTPAuthenticationRef auth) CF_AVAILABLE(10_2, 2_0);
/*
* CFHTTPAuthenticationCopyDomains()
*
* Discussion:
* Returns a list of domain URL's on which the given authentication
* should be applied. This function is provided mostly for
* informational purposes. CFHTTPAuthenticationAppliesToRequest
* should be used in order to check whether a request requires the
* authentication.
*
* Mac OS X threading:
* Thread safe
* The API's to CFHTTPAuthenticationRef are thread-safe so long as
* multiple threads are not altering the same
* CFHTTPAuthenticationRef at the same time.
*
* Parameters:
*
* auth:
* The authentication information being queried.
*
* Result:
* Returns a list of domain URL's on which the given authentication
* should be applied.
*
*/
CFN_EXPORT CFArrayRef
CFHTTPAuthenticationCopyDomains(CFHTTPAuthenticationRef auth) CF_AVAILABLE(10_2, 2_0);
/*
* CFHTTPAuthenticationCopyMethod()
*
* Discussion:
* Returns the method of authentication which will be performed when
* applying credentials. The strongest method of authentication
* will be chosen in the case of multiple choices.
*
* Mac OS X threading:
* Thread safe
* The API's to CFHTTPAuthenticationRef are thread-safe so long as
* multiple threads are not altering the same
* CFHTTPAuthenticationRef at the same time.
*
* Parameters:
*
* auth:
* The authentication information being queried.
*
* Result:
* Returns the method of authentication which will be performed when
* applying credentials.
*
*/
CFN_EXPORT CFStringRef
CFHTTPAuthenticationCopyMethod(CFHTTPAuthenticationRef auth) CF_AVAILABLE(10_2, 2_0);
/*
* CFHTTPAuthenticationRequiresUserNameAndPassword()
*
* Discussion:
* Returns TRUE if the chosen authentication scheme requires a
* username and password.
*
* Mac OS X threading:
* Thread safe
* The API's to CFHTTPAuthenticationRef are thread-safe so long as
* multiple threads are not altering the same
* CFHTTPAuthenticationRef at the same time.
*
* Parameters:
*
* auth:
* The authentication information being queried.
*
* Result:
* Returns TRUE if the chosen authentication scheme requires a
* username and password.
*
*/
CFN_EXPORT Boolean
CFHTTPAuthenticationRequiresUserNameAndPassword(CFHTTPAuthenticationRef auth) CF_AVAILABLE(10_3, 2_0);
/*
* CFHTTPAuthenticationRequiresAccountDomain()
*
* Discussion:
* Returns TRUE if the chosen authentication scheme requires a
* domain for authentication. Currently, this will return TRUE for
* "NTLM" and FALSE for the other methods.
*
* Mac OS X threading:
* Thread safe
* The API's to CFHTTPAuthenticationRef are thread-safe so long as
* multiple threads are not altering the same
* CFHTTPAuthenticationRef at the same time.
*
* Parameters:
*
* auth:
* The authentication information being queried.
*
* Result:
* Returns TRUE if the chosen authentication scheme requires a
* domain for authentication.
*
*/
CFN_EXPORT Boolean
CFHTTPAuthenticationRequiresAccountDomain(CFHTTPAuthenticationRef auth) CF_AVAILABLE(10_4, 2_0);
CF_ASSUME_NONNULL_END
CF_EXTERN_C_END
#endif /* __CFHTTPAUTHENTICATION__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CFNetwork.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CFNetwork.framework/Headers/CFNetworkDefs.h | /*
File: CFNetwork/CFNetworkDefs.h
Contains: CoreFoundation Network header
Copyright: Copyright (c) 2001-2013 Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __CFNETWORK_DEFS_H_
#define __CFNETWORK_DEFS_H_
// To pick-up the CALLBACK_API_C definition.
#include <ConditionalMacros.h>
#include <CoreFoundation/CoreFoundation.h>
/* Standard incantation for exporting/importing DLL symbols */
#if defined(__WIN32__)
#if defined(CFNETWORK_BUILDING_DLL)
#define CFN_EXPORT __declspec(dllexport) extern
#else
#define CFN_EXPORT __declspec(dllimport) extern
#endif
#else
#define CFN_EXPORT extern __attribute__((__visibility__("default")))
#endif
#endif //__CFNETWORK_DEFS_H_
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CFNetwork.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CFNetwork.framework/Headers/CFNetworkErrors.h | /*
File: CFNetwork/CFNetworkErrors.h
Contains: CFNetwork error header
Copyright: Copyright (c) 2006-2013 Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __CFNETWORKERRORS__
#define __CFNETWORKERRORS__
#ifndef __CFNETWORKDEFS__
#include <CFNetwork/CFNetworkDefs.h>
#endif
#ifndef __CFSTRING__
#include <CoreFoundation/CFString.h>
#endif
#if PRAGMA_ONCE
#pragma once
#endif
CF_EXTERN_C_BEGIN
CF_ASSUME_NONNULL_BEGIN
/*
* kCFErrorDomainCFNetwork
*
* Discussion:
* Error domain for all errors originating in CFNetwork. Error codes
* may be interpreted using the list below.
*
*/
CFN_EXPORT const CFStringRef kCFErrorDomainCFNetwork CF_AVAILABLE(10_5, 2_0);
/*
* kCFErrorDomainWinSock
*
* Discussion:
* On Windows, errors originating from WinSock are represented using
* this domain.
*
*/
CFN_EXPORT const CFStringRef kCFErrorDomainWinSock CF_AVAILABLE(10_5, 2_0);
/*
* CFNetworkErrors
*
* Discussion:
* The list of all public error codes returned under the error domain
* kCFErrorDomainCFNetwork
*/
typedef CF_ENUM(int, CFNetworkErrors) {
kCFHostErrorHostNotFound = 1,
kCFHostErrorUnknown = 2, // Query the kCFGetAddrInfoFailureKey to get the value returned from getaddrinfo; lookup in netdb.h
// SOCKS errors; in all cases you may query kCFSOCKSStatusCodeKey to recover the status code returned by the server
kCFSOCKSErrorUnknownClientVersion = 100,
kCFSOCKSErrorUnsupportedServerVersion = 101, // Query the kCFSOCKSVersionKey to find the version requested by the server
// SOCKS4-specific errors
kCFSOCKS4ErrorRequestFailed = 110, // request rejected or failed by the server
kCFSOCKS4ErrorIdentdFailed = 111, // request rejected because SOCKS server cannot connect to identd on the client
kCFSOCKS4ErrorIdConflict = 112, // request rejected because the client program and identd report different user-ids
kCFSOCKS4ErrorUnknownStatusCode = 113,
// SOCKS5-specific errors
kCFSOCKS5ErrorBadState = 120,
kCFSOCKS5ErrorBadResponseAddr = 121,
kCFSOCKS5ErrorBadCredentials = 122,
kCFSOCKS5ErrorUnsupportedNegotiationMethod = 123, // query kCFSOCKSNegotiationMethodKey to find the method requested
kCFSOCKS5ErrorNoAcceptableMethod = 124,
// FTP errors; query the kCFFTPStatusCodeKey to get the status code returned by the server
kCFFTPErrorUnexpectedStatusCode = 200,
// HTTP errors
kCFErrorHTTPAuthenticationTypeUnsupported = 300,
kCFErrorHTTPBadCredentials = 301,
kCFErrorHTTPConnectionLost = 302,
kCFErrorHTTPParseFailure = 303,
kCFErrorHTTPRedirectionLoopDetected = 304,
kCFErrorHTTPBadURL = 305,
kCFErrorHTTPProxyConnectionFailure = 306,
kCFErrorHTTPBadProxyCredentials = 307,
kCFErrorPACFileError = 308,
kCFErrorPACFileAuth = 309,
kCFErrorHTTPSProxyConnectionFailure = 310,
kCFStreamErrorHTTPSProxyFailureUnexpectedResponseToCONNECTMethod = 311,
// Error codes for CFURLConnection and CFURLProtocol
kCFURLErrorBackgroundSessionInUseByAnotherProcess = -996,
kCFURLErrorBackgroundSessionWasDisconnected = -997,
kCFURLErrorUnknown = -998,
kCFURLErrorCancelled = -999,
kCFURLErrorBadURL = -1000,
kCFURLErrorTimedOut = -1001,
kCFURLErrorUnsupportedURL = -1002,
kCFURLErrorCannotFindHost = -1003,
kCFURLErrorCannotConnectToHost = -1004,
kCFURLErrorNetworkConnectionLost = -1005,
kCFURLErrorDNSLookupFailed = -1006,
kCFURLErrorHTTPTooManyRedirects = -1007,
kCFURLErrorResourceUnavailable = -1008,
kCFURLErrorNotConnectedToInternet = -1009,
kCFURLErrorRedirectToNonExistentLocation = -1010,
kCFURLErrorBadServerResponse = -1011,
kCFURLErrorUserCancelledAuthentication = -1012,
kCFURLErrorUserAuthenticationRequired = -1013,
kCFURLErrorZeroByteResource = -1014,
kCFURLErrorCannotDecodeRawData = -1015,
kCFURLErrorCannotDecodeContentData = -1016,
kCFURLErrorCannotParseResponse = -1017,
kCFURLErrorInternationalRoamingOff = -1018,
kCFURLErrorCallIsActive = -1019,
kCFURLErrorDataNotAllowed = -1020,
kCFURLErrorRequestBodyStreamExhausted = -1021,
kCFURLErrorAppTransportSecurityRequiresSecureConnection = -1022,
kCFURLErrorFileDoesNotExist = -1100,
kCFURLErrorFileIsDirectory = -1101,
kCFURLErrorNoPermissionsToReadFile = -1102,
kCFURLErrorDataLengthExceedsMaximum = -1103,
kCFURLErrorFileOutsideSafeArea = -1104,
// SSL errors
kCFURLErrorSecureConnectionFailed = -1200,
kCFURLErrorServerCertificateHasBadDate = -1201,
kCFURLErrorServerCertificateUntrusted = -1202,
kCFURLErrorServerCertificateHasUnknownRoot = -1203,
kCFURLErrorServerCertificateNotYetValid = -1204,
kCFURLErrorClientCertificateRejected = -1205,
kCFURLErrorClientCertificateRequired = -1206,
kCFURLErrorCannotLoadFromNetwork = -2000,
// Download and file I/O errors
kCFURLErrorCannotCreateFile = -3000,
kCFURLErrorCannotOpenFile = -3001,
kCFURLErrorCannotCloseFile = -3002,
kCFURLErrorCannotWriteToFile = -3003,
kCFURLErrorCannotRemoveFile = -3004,
kCFURLErrorCannotMoveFile = -3005,
kCFURLErrorDownloadDecodingFailedMidStream = -3006,
kCFURLErrorDownloadDecodingFailedToComplete = -3007,
// Cookie errors
kCFHTTPCookieCannotParseCookieFile = -4000,
// Errors originating from CFNetServices
kCFNetServiceErrorUnknown = -72000L,
kCFNetServiceErrorCollision = -72001L,
kCFNetServiceErrorNotFound = -72002L,
kCFNetServiceErrorInProgress = -72003L,
kCFNetServiceErrorBadArgument = -72004L,
kCFNetServiceErrorCancel = -72005L,
kCFNetServiceErrorInvalid = -72006L,
kCFNetServiceErrorTimeout = -72007L,
kCFNetServiceErrorDNSServiceFailure = -73000L // An error from DNS discovery; look at kCFDNSServiceFailureKey to get the error number and interpret using dns_sd.h
};
/* Keys used by CFNetwork to pass additional error information back to the user within CFError's userInfo dictionary */
/*
* kCFURLErrorFailingURLErrorKey
*
* Discussion:
* When an NSURLConnection or NSURLDownload error occurs, this key's
* value is set to the URL which caused a load to fail
*
*/
CFN_EXPORT const CFStringRef kCFURLErrorFailingURLErrorKey CF_AVAILABLE(10_5, 2_2);
/*
* kCFURLErrorFailingURLStringErrorKey
*
* Discussion:
* When an NSURLConnection or NSURLDownload error occurs, this key's
* value is set to the CFString value of the URL which caused a load
* to fail
*
*/
CFN_EXPORT const CFStringRef kCFURLErrorFailingURLStringErrorKey CF_AVAILABLE(10_5, 2_2);
/*
* kCFGetAddrInfoFailureKey
*
* Discussion:
* When an error of kCFHostErrorUnknown is returned, this key's
* value is set to a CFNumber containing the raw error value
* returned by getaddrinfo()
*
*/
CFN_EXPORT const CFStringRef kCFGetAddrInfoFailureKey CF_AVAILABLE(10_5, 2_0);
/*
* kCFSOCKSStatusCodeKey
*
* Discussion:
* When a SOCKS failure has occurred, this key's value is set to a
* CFString containing the status value returned by the SOCKS server.
*
*/
CFN_EXPORT const CFStringRef kCFSOCKSStatusCodeKey CF_AVAILABLE(10_5, 2_0);
/*
* kCFSOCKSVersionKey
*
* Discussion:
* When an error of kCFSOCKSErrorUnsupportedServerVersion is
* returned, this key's value is set to a CFString containing the
* version number requested by the server.
*
*/
CFN_EXPORT const CFStringRef kCFSOCKSVersionKey CF_AVAILABLE(10_5, 2_0);
/*
* kCFSOCKSNegotiationMethodKey
*
* Discussion:
* When an error of kCFSOCKS5ErrorUnsupportedNegotiationMethod is
* returned, this key's value is set to a CFString containing the
* negotiation method requested by the server.
*
*/
CFN_EXPORT const CFStringRef kCFSOCKSNegotiationMethodKey CF_AVAILABLE(10_5, 2_0);
/*
* kCFDNSServiceFailureKey
*
* Discussion:
* When an error of kCFNetServicesErrorDNSServiceFailure is
* returned, this key's value is set to a CFNumber containing the
* value returned from DNS; interret it using the values dns_sd.h
*
*/
CFN_EXPORT const CFStringRef kCFDNSServiceFailureKey CF_AVAILABLE(10_5, 2_0);
/*
* kCFFTPStatusCodeKey
*
* Discussion:
* When an error of kCFFTPErrorUnexpectedStatusCode is returned,
* this key's value is set to a CFString containing the status code
* returned by the server
*
*/
CFN_EXPORT const CFStringRef kCFFTPStatusCodeKey CF_AVAILABLE(10_5, 2_0);
CF_ASSUME_NONNULL_END
CF_EXTERN_C_END
#endif /* __CFNETWORKERRORS__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CFNetwork.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CFNetwork.framework/Headers/CFSocketStream.h | /*
File: CFNetwork/CFSocketStream.h
Contains: CoreFoundation Network socket streams header
Copyright: Copyright (c) 2001-2013 Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __CFSOCKETSTREAM__
#define __CFSOCKETSTREAM__
#ifndef __CFNETWORKDEFS__
#include <CFNetwork/CFNetworkDefs.h>
#endif
#ifndef __CFSTREAM__
#include <CoreFoundation/CFStream.h>
#endif
#ifndef __CFHOST__
#include <CFNetwork/CFHost.h>
#endif
#ifndef __CFNETSERVICES__
#include <CFNetwork/CFNetServices.h>
#endif
#if PRAGMA_ONCE
#pragma once
#endif
CF_EXTERN_C_BEGIN
CF_ASSUME_NONNULL_BEGIN
#if PRAGMA_ENUM_ALWAYSINT
#pragma enumsalwaysint on
#endif
/*
* kCFStreamPropertySSLContext
*
* The SSLContextRef used for both read and write operations on a
* CFSocketStream.
*
* CFReadStreamCopyProperty or CFWriteStreamCopyProperty return an
* appropriately reference counted SSLContextRef. If the stream has
* not yet been opened, this SSLContext may be configured directly
* using the appropriate SecureTransport APIs.
*
* CFReadStreamSetProperty or CFWriteStreamSetProperty will allow you
* to specify an SSLContextRef for a stream. If the stream has not
* been opened, the SSLContextRef will replace any existing
* SSLContextRef and be used in the initial stream handshake. If the
* stream has been opened without SSL enabled, setting this property
* will initiate an SSL handshake over the existing socket.
*
* If an SSL settings dictionary was set via
* kCFStreamPropertySSLSettings, a SSLContextRef is created internally
* and configured as per the dictionary. However, if an SSLContextRef
* is set after this, its configuration will take precedence over the
* previously configured context.
*
* Reconfiguring an SSLContext after the stream it is bound to has
* opened is unsupported.
*
*/
CFN_EXPORT const CFStringRef kCFStreamPropertySSLContext CF_AVAILABLE(10_9, 5_0);
/*
* kCFStreamPropertySSLPeerTrust
*
* Discussion:
* Stream property value for copy operations. Returns a SecTrustRef
* which was a result of the SSL handshake. This property is not valid before
* a stream is opened. See Security/SecTrust.h for more information.
*
*/
CFN_EXPORT const CFStringRef kCFStreamPropertySSLPeerTrust CF_AVAILABLE(10_5, 2_0);
/*
* kCFStreamSSLValidatesCertificateChain
*
* Discussion:
* Security property key for kCFStreamPropertySSLSettings.
* CFBooleanRef indicating whether the certificate chain should be
* validated or not. The value is kCFBooleanTrue by default (not
* set).
*
*/
CFN_EXPORT const CFStringRef kCFStreamSSLValidatesCertificateChain CF_AVAILABLE(10_4, 2_0);
/*
* kCFStreamPropertySSLSettings
*
* Discussion:
* Stream property key for set operations. CFDictionaryRef filled
* with different security settings. By default, there are no
* security settings.
*
*/
CFN_EXPORT const CFStringRef kCFStreamPropertySSLSettings CF_AVAILABLE(10_4, 2_0);
/*
* kCFStreamSSLLevel
*
* Discussion:
* Security property key for kCFStreamPropertySSLSettings.
* CFStringRef being one of the security levels. The value is
* kCFStreamSocketSecurityLevelNegotiatedSSL by default (not set).
*
*/
CFN_EXPORT const CFStringRef kCFStreamSSLLevel CF_AVAILABLE(10_4, 2_0);
/*
* kCFStreamSSLPeerName
*
* Discussion:
* Security property key for kCFStreamPropertySSLSettings.
* CFStringRef overriding the name used for certificate
* verification. Set to kCFNull to prevent name verification.
* Default is the host name with which the streams were created. If
* no host name was used, no peer name will be used.
*
*/
CFN_EXPORT const CFStringRef kCFStreamSSLPeerName CF_AVAILABLE(10_4, 2_0);
/*
* kCFStreamSSLCertificates
*
* Discussion:
* Security property key for kCFStreamPropertySSLSettings.
* CFArrayRef of SecCertificateRefs, except for index [0], which is
* a SecIdentityRef. See SSLSetCertificate in
* Security/SecureTransport.h for more information.
*
*/
CFN_EXPORT const CFStringRef kCFStreamSSLCertificates CF_AVAILABLE(10_4, 2_0);
/*
* kCFStreamSSLIsServer
*
* Discussion:
* Security property key for kCFStreamPropertySSLSettings.
* CFBooleanRef indicating whether the connection is to act as a
* server in the SSL process or not. The value is kCFBooleanFalse
* by default (not set). If set to kCFBooleanTrue, there must be a
* valid value for the kCFStreamSSLCertificates key too.
*
*/
CFN_EXPORT const CFStringRef kCFStreamSSLIsServer CF_AVAILABLE(10_4, 2_0);
/* kCFStreamNetworkServiceType
*
* Discussion:
* Property key to specify the type of service for the stream. This
* allows the system to properly handle the request with respect to
* routing, suspension behavior and other networking related attributes
* appropriate for the given service type. The service types supported
* are documented below. Most streams should not need to set this
* property.
*/
CFN_EXPORT const CFStringRef kCFStreamNetworkServiceType CF_AVAILABLE(10_7, 4_0);
/* supported network service types: */
CFN_EXPORT const CFStringRef kCFStreamNetworkServiceTypeVideo CF_AVAILABLE(10_7, 5_0); // interactive video
CFN_EXPORT const CFStringRef kCFStreamNetworkServiceTypeVoice CF_AVAILABLE(10_7, 5_0); // interactive voice data
CFN_EXPORT const CFStringRef kCFStreamNetworkServiceTypeBackground CF_AVAILABLE(10_7, 5_0); // background
CFN_EXPORT const CFStringRef kCFStreamNetworkServiceTypeResponsiveData __OSX_AVAILABLE_STARTING(__MAC_10_8, __IPHONE_6_0); // responsive (time sensitive) data
CFN_EXPORT const CFStringRef kCFStreamNetworkServiceTypeCallSignaling CF_AVAILABLE(10_12, 10_0); //Call Signaling
CFN_EXPORT const CFStringRef kCFStreamNetworkServiceTypeAVStreaming __OSX_AVAILABLE_STARTING(__MAC_10_8, __IPHONE_6_0); // multimedia audio/video streaming
CFN_EXPORT const CFStringRef kCFStreamNetworkServiceTypeResponsiveAV __OSX_AVAILABLE_STARTING(__MAC_10_8, __IPHONE_6_0); // responsive multimedia audio/video
/* deprecated network service type: */
CFN_EXPORT const CFStringRef kCFStreamNetworkServiceTypeVoIP CF_DEPRECATED(10_7, 10_11, 4_0, 9_0, "use PushKit for VoIP control purposes"); // voice over IP control - this service type is deprecated in favor of using PushKit for VoIP control
/*
* kCFStreamPropertyNoCellular
*
* Discussion:
* Stream property value, for both set and copy operations.
* The value is a CFBooleanRef which indicates whether the connection
* is allowed to use the built-in celluar radios. A value of kCFBooleanTrue
* disallows use of cellular interfaces. kCFBooleanFalse (the default)
* allows use of cellular interfaces.
*
*/
CFN_EXPORT const CFStringRef kCFStreamPropertyNoCellular CF_AVAILABLE(10_8, 5_0);
/*
* kCFStreamPropertyConnectionIsCellular
*
* Discussion:
* Stream property key for copy operations. Returns a CFBooleanRef value
* of kCFBooleanTrue if the stream has connected using the built in cellular radios.
* It returns kCFBooleanFalse if the stream is conneceted over a non-cellular
* interface or has not yet established a connection.
*/
CFN_EXPORT const CFStringRef kCFStreamPropertyConnectionIsCellular CF_AVAILABLE(10_8, 6_0);
/*
* kCFStreamPropertyAllowExpensiveNetworkAccess
*
* Discussion:
* Stream property value, for both set and copy operations.
* The value is a CFBooleanRef which indicates whether the connection
* is allowed to use network interfaces that are marked expensive. A value of
* kCFBooleanTrue (the default) allows use of expensive interfaces. kCFBooleanFalse
* disallows use of expensive interfaces.
*
*/
CFN_EXPORT const CFStringRef kCFStreamPropertyAllowExpensiveNetworkAccess API_AVAILABLE(macos(10.15), ios(13.0), watchos(6.0), tvos(13.0));
/*
* kCFStreamPropertyConnectionIsExpensive
*
* Discussion:
* Stream property key for copy operations. Returns a CFBooleanRef value
* of kCFBooleanTrue if the stream has connected using an "expensive" interface.
* It returns kCFBooleanFalse if the stream is conneceted over an "inexpensive"
* interface. If the connection has not been established yet NULL will be returned.
*/
CFN_EXPORT const CFStringRef kCFStreamPropertyConnectionIsExpensive API_AVAILABLE(macos(10.15), ios(13.0), watchos(6.0), tvos(13.0));
/*
* kCFStreamPropertyAllowConstrainedNetworkAccess
*
* Discussion:
* Stream property value, for both set and copy operations.
* The value is a CFBooleanRef which indicates whether the connection
* is allowed to use "constrained" networks. A value of kCFBooleanTrue (the default)
* allows the use of constrained interfaces. kCFBooleanFalse
* disallows use of constrained interfaces.
*
*/
CFN_EXPORT const CFStringRef kCFStreamPropertyAllowConstrainedNetworkAccess API_AVAILABLE(macos(10.15), ios(13.0), watchos(6.0), tvos(13.0));
/*
* kCFStreamErrorDomainWinSock
*
* Discussion:
* WinSock error domain. On Win32 platforms, networking errors will
* come in this domain. See <winsock2.h> for values. Note that
* non-networking errors, like ENOMEM, will continue to come in the
* POSIX domain as on OS X.
*
*/
CFN_EXPORT const CFIndex kCFStreamErrorDomainWinSock CF_AVAILABLE(10_5, 2_0);
CF_INLINE
SInt32 CFSocketStreamSOCKSGetErrorSubdomain(const CFStreamError* error) {
return ((error->error >> 16) & 0x0000FFFF);
}
CF_INLINE
SInt32 CFSocketStreamSOCKSGetError(const CFStreamError* error) {
return (error->error & 0x0000FFFF);
}
enum {
kCFStreamErrorSOCKSSubDomainNone = 0, /* Error code is a general SOCKS error*/
kCFStreamErrorSOCKSSubDomainVersionCode = 1, /* Error code is the version of SOCKS which the server wishes to use*/
kCFStreamErrorSOCKS4SubDomainResponse = 2, /* Error code is the status code returned by the server*/
kCFStreamErrorSOCKS5SubDomainUserPass = 3, /* Error code is the status code that the server returned*/
kCFStreamErrorSOCKS5SubDomainMethod = 4, /* Error code is the server's desired negotiation method*/
kCFStreamErrorSOCKS5SubDomainResponse = 5 /* Error code is the response code that the server returned in reply to the connection request*/
};
/* kCFStreamErrorSOCKSSubDomainNone*/
enum {
kCFStreamErrorSOCKS5BadResponseAddr = 1,
kCFStreamErrorSOCKS5BadState = 2,
kCFStreamErrorSOCKSUnknownClientVersion = 3
};
/* kCFStreamErrorSOCKS4SubDomainResponse*/
enum {
kCFStreamErrorSOCKS4RequestFailed = 91, /* request rejected or failed */
kCFStreamErrorSOCKS4IdentdFailed = 92, /* request rejected because SOCKS server cannot connect to identd on the client */
kCFStreamErrorSOCKS4IdConflict = 93 /* request rejected because the client program and identd report different user-ids */
};
/* kCFStreamErrorSOCKS5SubDomainMethod*/
enum {
kSOCKS5NoAcceptableMethod = 0xFF /* other values indicate the server's desired method */
};
/*
* kCFStreamPropertyProxyLocalBypass
*
* Discussion:
* CFDictionary key for proxy information. It matches
* kSCPropNetProxiesExcludeSimpleHostnames defined in
* SCSchemaDefinitions.h. CFNumber (0 or 1) indicating to bypass
* the proxies for simple hostnames (names without dots).
*
*/
CFN_EXPORT const CFStringRef kCFStreamPropertyProxyLocalBypass CF_AVAILABLE(10_4, 2_0);
/*
* kCFStreamPropertySocketRemoteHost
*
* Discussion:
* Stream property key for copy operations. Returns a CFHostRef if
* known, otherwise NULL.
*
*/
CFN_EXPORT const CFStringRef kCFStreamPropertySocketRemoteHost CF_AVAILABLE(10_3, 2_0);
/*
* kCFStreamPropertySocketRemoteNetService
*
* Discussion:
* Stream property key for copy operations. Returns a
* CFNetServiceRef if known, otherwise NULL.
*
*/
CFN_EXPORT const CFStringRef kCFStreamPropertySocketRemoteNetService CF_AVAILABLE(10_3, 2_0);
/*
* kCFStreamPropertySocketExtendedBackgroundIdleMode
*
* Discussion:
* Set this to kCFBooleanTrue to enable extended background idle
* mode. Enabling this mode asks the system to keep the socket open
* and delay reclaiming it when the process moves to the background (see
* https://developer.apple.com/library/ios/technotes/tn2277/_index.html)
* This property must be set before the stream is opened.
*
*/
CFN_EXPORT const CFStringRef kCFStreamPropertySocketExtendedBackgroundIdleMode CF_AVAILABLE(10_11, 9_0);
/*
* CFStreamCreatePairWithSocketToCFHost()
*
* Discussion:
* Given a CFHostRef, this function will create a pair of streams
* suitable for connecting to the host. If there is a failure
* during creation, the stream references will be set to NULL.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* alloc:
* The CFAllocator which should be used to allocate memory for the
* streams. If this reference is not a valid CFAllocator, the
* behavior is undefined.
*
* host:
* A reference to a CFHost to which the streams are desired. If
* unresolved, the host will be resolved prior to connecting.
*
* port:
* The port to which the connection should be established.
*
* readStream:
* A pointer to a CFReadStreamRef which will be set to the new
* read stream instance. Can be set to NULL if not desired.
*
* writeStream:
* A pointer to a CFWriteStreamRef which will be set to the new
* write stream instance. Can be set to NULL if not desired.
*
*/
CFN_EXPORT void
CFStreamCreatePairWithSocketToCFHost(
CFAllocatorRef __nullable alloc,
CFHostRef host,
SInt32 port,
CFReadStreamRef __nullable * __nullable readStream,
CFWriteStreamRef __nullable * __nullable writeStream) API_DEPRECATED("Use Network framework instead", macos(10.3, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFStreamCreatePairWithSocketToNetService()
*
* Discussion:
* Given a CFNetService, this function will create a pair of streams
* suitable for connecting to the service. If there is a failure
* during creation, the stream references will be set to NULL.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* alloc:
* The CFAllocator which should be used to allocate memory for the
* streams. If this reference is not a valid CFAllocator, the
* behavior is undefined.
*
* service:
* A reference to a CFNetService to which the streams are desired.
* If unresolved, the service will be resolved prior to
* connecting.
*
* readStream:
* A pointer to a CFReadStreamRef which will be set to the new
* read stream instance. Can be set to NULL if not desired.
*
* writeStream:
* A pointer to a CFWriteStreamRef which will be set to the new
* write stream instance. Can be set to NULL if not desired.
*
*/
CFN_EXPORT void
CFStreamCreatePairWithSocketToNetService(
CFAllocatorRef __nullable alloc,
CFNetServiceRef service,
CFReadStreamRef __nullable * __nullable readStream,
CFWriteStreamRef __nullable * __nullable writeStream) API_DEPRECATED("Use Network framework instead", macos(10.3, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* The following properties are DEPRECATED starting in OS X 10.6 and iOS 4.0.
*
* kCFStreamPropertySSLPeerCertificates:
* The peer certificates are available as part of the SecTrustRef object. See <Security/SecTrust.h>
*
* kCFStreamSSLAllowsExpiredCertificates:
* kCFStreamSSLAllowsExpiredRoots:
* kCFStreamSSLAllowsAnyRoot:
* The SSL handshake flags which affect untrusted certificate chain evaluation are deprecated.
* Instead, use the single property kCFStreamSSLValidatesCertificateChain to disable certificate
* chain checking if the user has decided that it is appropriate to do so.
*/
CFN_EXPORT const CFStringRef kCFStreamPropertySSLPeerCertificates CF_DEPRECATED(10_4, 10_6, 2_0, 4_0);
CFN_EXPORT const CFStringRef kCFStreamSSLAllowsExpiredCertificates CF_DEPRECATED(10_4, 10_6, 2_0, 4_0);
CFN_EXPORT const CFStringRef kCFStreamSSLAllowsExpiredRoots CF_DEPRECATED(10_4, 10_6, 2_0, 4_0);
CFN_EXPORT const CFStringRef kCFStreamSSLAllowsAnyRoot CF_DEPRECATED(10_4, 10_6, 2_0, 4_0);
#if PRAGMA_ENUM_ALWAYSINT
#pragma enumsalwaysint reset
#endif
CF_ASSUME_NONNULL_END
CF_EXTERN_C_END
#endif /* __CFSOCKETSTREAM__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CFNetwork.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CFNetwork.framework/Headers/CFProxySupport.h | /*
File: CFNetwork/CFProxySupport.h
Contains: Support for computing which proxy applies when
Copyright: Copyright (c) 2006-2013 Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __CFPROXYSUPPORT__
#define __CFPROXYSUPPORT__
#ifndef __CFNETWORKDEFS__
#include <CFNetwork/CFNetworkDefs.h>
#endif
#ifndef __CFARRAY__
#include <CoreFoundation/CFArray.h>
#endif
#ifndef __CFSTRING__
#include <CoreFoundation/CFString.h>
#endif
#ifndef __CFURL__
#include <CoreFoundation/CFURL.h>
#endif
#ifndef __CFERROR__
#include <CoreFoundation/CFError.h>
#endif
#ifndef __CFRUNLOOP__
#include <CoreFoundation/CFRunLoop.h>
#endif
#ifndef __CFSTREAM__
#include <CoreFoundation/CFStream.h>
#endif
/*
These APIs return arrays of dictionaries, where each dictionary describes a single proxy.
The arrays represent the order in which the proxies should be tried - try to download the URL
using the first entry in the array, and if that fails, try using the second entry, and so on.
The keys to the proxy dictionaries follow the function declarations; every proxy dictionary
will have an entry for kCFProxyTypeKey. If the type is anything except
kCFProxyTypeAutoConfigurationURL, the dictionary will also have entries for the proxy's host
and port (under kCFProxyHostNameKey and kCFProxyPortNumberKey respectively). If the type is
kCFProxyTypeAutoConfigurationURL, it will have an entry for kCFProxyAutoConfigurationURLKey.
The keys for username and password are optional and will only be present if the username
or password could be extracted from the information passed in (i.e. either the URL itself
or the proxy dictionary supplied). These APIs do not consult any external credential stores
(such as the Keychain).
*/
#if PRAGMA_ONCE
#pragma once
#endif
CF_EXTERN_C_BEGIN
CF_ASSUME_NONNULL_BEGIN
/*!
@function CFNetworkCopySystemProxySettings
@discussion Returns a CFDictionary containing the current system internet proxy settings.
@result Returns a dictionary containing key-value pairs that represent
the current internet proxy settings. See below for definitions of the keys and
values.
NULL if no proxy settings have been defined or if an error
was encountered.
The caller is responsible for releasing the returned dictionary.
*/
CFN_EXPORT __nullable CFDictionaryRef
CFNetworkCopySystemProxySettings(void) CF_AVAILABLE(10_6, 2_0);
/*
* CFNetworkCopyProxiesForURL()
*
* Discussion:
* Given a URL and a proxy dictionary, determines the ordered list
* of proxies that should be used to download the given URL.
*
* Parameters:
*
* url:
* The URL to be accessed
*
* proxySettings:
* A dictionary describing the available proxy settings; the
* dictionary's format should match the dictionary returned
* by CFNetworkCopySystemProxySettings described below.
*
* Result:
* An array of dictionaries; each dictionary describes a single
* proxy. See the comment at the top of this file for how to
* interpret the returned dictionaries.
*
*/
CFN_EXPORT CFArrayRef
CFNetworkCopyProxiesForURL(CFURLRef url, CFDictionaryRef proxySettings) CF_AVAILABLE(10_5, 2_0);
/*
* CFProxyAutoConfigurationResultCallback
*
* Discussion:
* Callback function to be called when a PAC file computation
* (initiated by either CFNetworkExecuteProxyAutoConfigurationScript
* or CFNetworkExecuteProxyAutoConfigurationURL) has completed.
*
* Parameters:
*
* client:
* The client reference passed in to
* CFNetworkExecuteProxyAutoConfigurationScript or
* CFNetworkExecuteProxyAutoConfigurationURL
*
* proxyList:
* Upon success, the list of proxies returned by the
* autoconfiguration script. The list has the same format as
* returned by CFProxyCopyProxiesForURL, above, except that no
* entry may be of type kCFProxyTypeAutoConfigurationURL. Note
* that if the client wishes to keep this list, they must retain
* it when they receive this callback.
*
* error:
* Upon failure, an error object explaining the failure.
*/
typedef CALLBACK_API_C( void , CFProxyAutoConfigurationResultCallback )(void *client, CFArrayRef proxyList, CFErrorRef __nullable error);
/*
* CFNetworkCopyProxiesForAutoConfigurationScript()
*
* Discussion:
* Synchronously executes the given proxy autoconfiguration script
* and returns a valid proxyList and NULL error upon success or a
* NULL proxyList and valid error on failure.
*
* Parameters:
*
* proxyAutoConfigurationScript:
* A CFString containing the code of the script to be executed.
*
* targetURL:
* The URL that should be input in to the autoconfiguration script.
*
* error:
* A return argument that will contain a valid error in case of
* failure.
*
* Result:
* An array of dictionaries describing the proxies returned by the
* script or NULL on failure.
*
*/
CFN_EXPORT __nullable CFArrayRef
CFNetworkCopyProxiesForAutoConfigurationScript(CFStringRef proxyAutoConfigurationScript, CFURLRef targetURL, CFErrorRef * __nullable error) CF_AVAILABLE(10_5, 2_0);
/*
* CFNetworkExecuteProxyAutoConfigurationScript()
*
* Discussion:
* Begins the process of executing proxyAutoConfigurationScript to
* determine the correct proxy to use to retrieve targetURL. The
* caller should schedule the returned run loop source; when the
* results are found, the caller's callback will be called via the
* run loop, passing a valid proxyList and NULL error upon success,
* or a NULL proxyList and valid error on failure. The caller
* should invalidate the returned run loop source if it wishes to
* terminate the request before completion. The returned
* RunLoopSource will be removed from all run loops and modes on
* which it was scheduled after the callback returns.
*
* Parameters:
*
* proxyAutoConfigurationScript:
* A CFString containing the code of the script to be executed.
*
* targetURL:
* The URL that should be passed to the autoconfiguration script.
*
* cb:
* A client callback to notify the caller of completion.
*
* clientContext:
* a stream context containing a client info object and optionally
* retain / release callbacks for said info object.
*
* Result:
* A CFRunLoopSource which the client can use to schedule execution
* of the AutoConfiguration Script.
*
*/
CFN_EXPORT CFRunLoopSourceRef
CFNetworkExecuteProxyAutoConfigurationScript(
CFStringRef proxyAutoConfigurationScript,
CFURLRef targetURL,
CFProxyAutoConfigurationResultCallback cb,
CFStreamClientContext * clientContext) CF_AVAILABLE(10_5, 2_0);
/*
* CFNetworkExecuteProxyAutoConfigurationURL()
*
* Discussion:
* As CFNetworkExecuteProxyAutoConfigurationScript(), above, except
* that CFNetworkExecuteProxyAutoConfigurationURL will additionally
* download the contents of proxyAutoConfigURL, convert it to a
* JavaScript string, and then execute that script.
* Ownership for the returned CFRunLoopSourceRef follows the copy rule,
* the client is responsible for releasing the object.
*
*/
CFN_EXPORT CFRunLoopSourceRef
CFNetworkExecuteProxyAutoConfigurationURL(
CFURLRef proxyAutoConfigURL,
CFURLRef targetURL,
CFProxyAutoConfigurationResultCallback cb,
CFStreamClientContext * clientContext) CF_AVAILABLE(10_5, 2_0);
/*
* kCFProxyTypeKey
*
* Discussion:
* Key for the type of proxy being represented; value will be one of
* the kCFProxyType constants listed below.
*
*/
CFN_EXPORT const CFStringRef kCFProxyTypeKey CF_AVAILABLE(10_5, 2_0);
/*
* kCFProxyHostNameKey
*
* Discussion:
* Key for the proxy's hostname; value is a CFString. Note that
* this may be an IPv4 or IPv6 dotted-IP string.
*
*/
CFN_EXPORT const CFStringRef kCFProxyHostNameKey CF_AVAILABLE(10_5, 2_0);
/*
* kCFProxyPortNumberKey
*
* Discussion:
* Key for the proxy's port number; value is a CFNumber specifying
* the port on which to contact the proxy
*
*/
CFN_EXPORT const CFStringRef kCFProxyPortNumberKey CF_AVAILABLE(10_5, 2_0);
/*
* kCFProxyAutoConfigurationURLKey
*
* Discussion:
* Key for the proxy's PAC file location; this key is only present
* if the proxy's type is kCFProxyTypeAutoConfigurationURL. Value
* is a CFURL specifying the location of a proxy auto-configuration
* file
*
*/
CFN_EXPORT const CFStringRef kCFProxyAutoConfigurationURLKey CF_AVAILABLE(10_5, 2_0);
/*
* kCFProxyAutoConfigurationJavaScriptKey
*
* Discussion:
* Key for the proxy's PAC script
* The value is a CFString that contains the full JavaScript soure text for the PAC file.
*
*/
CFN_EXPORT const CFStringRef kCFProxyAutoConfigurationJavaScriptKey CF_AVAILABLE(10_7, 3_0);
/*
* kCFProxyUsernameKey
*
* Discussion:
* Key for the username to be used with the proxy; value is a
* CFString. Note that this key will only be present if the username
* could be extracted from the information passed in. No external
* credential stores (like the Keychain) are consulted.
*
*/
CFN_EXPORT const CFStringRef kCFProxyUsernameKey CF_AVAILABLE(10_5, 2_0);
/*
* kCFProxyPasswordKey
*
* Discussion:
* Key for the password to be used with the proxy; value is a
* CFString. Note that this key will only be present if the username
* could be extracted from the information passed in. No external
* credential stores (like the Keychain) are consulted.
*
*/
CFN_EXPORT const CFStringRef kCFProxyPasswordKey CF_AVAILABLE(10_5, 2_0);
/*
Possible values for kCFProxyTypeKey:
kCFProxyTypeNone - no proxy should be used; contact the origin server directly
kCFProxyTypeHTTP - the proxy is an HTTP proxy
kCFProxyTypeHTTPS - the proxy is a tunneling proxy as used for HTTPS
kCFProxyTypeSOCKS - the proxy is a SOCKS proxy
kCFProxyTypeFTP - the proxy is an FTP proxy
kCFProxyTypeAutoConfigurationURL - the proxy is specified by a proxy autoconfiguration (PAC) file
*/
/*
* kCFProxyTypeNone
*
*/
CFN_EXPORT const CFStringRef kCFProxyTypeNone CF_AVAILABLE(10_5, 2_0);
/*
* kCFProxyTypeHTTP
*
*/
CFN_EXPORT const CFStringRef kCFProxyTypeHTTP CF_AVAILABLE(10_5, 2_0);
/*
* kCFProxyTypeHTTPS
*
*/
CFN_EXPORT const CFStringRef kCFProxyTypeHTTPS CF_AVAILABLE(10_5, 2_0);
/*
* kCFProxyTypeSOCKS
*
*/
CFN_EXPORT const CFStringRef kCFProxyTypeSOCKS CF_AVAILABLE(10_5, 2_0);
/*
* kCFProxyTypeFTP
*
*/
CFN_EXPORT const CFStringRef kCFProxyTypeFTP CF_AVAILABLE(10_5, 2_0);
/*
* kCFProxyTypeAutoConfigurationURL
*
*/
CFN_EXPORT const CFStringRef kCFProxyTypeAutoConfigurationURL CF_AVAILABLE(10_5, 2_0);
/*
* kCFProxyTypeAutoConfigurationJavaScript
*
*/
CFN_EXPORT const CFStringRef kCFProxyTypeAutoConfigurationJavaScript CF_AVAILABLE(10_7, 3_0);
/*
* kCFProxyAutoConfigHTTPResponse
*
*/
CFN_EXPORT const CFStringRef kCFProxyAutoConfigurationHTTPResponseKey CF_AVAILABLE(10_5, 2_0);
#if TARGET_OS_MAC
/*
* kCFNetworkProxiesExceptionsList
*
* Discussion:
* Key for the list of host name patterns that should bypass the proxy; value is a
* CFArray of CFStrings.
*/
CFN_EXPORT const CFStringRef kCFNetworkProxiesExceptionsList CF_AVAILABLE(10_6, NA);
/*
* kCFNetworkProxiesExcludeSimpleHostnames
*
* Discussion:
* Key whose value indicates if simple hostnames will be excluded; value is a
* CFNumber. Simple hostnames will be excluded if the key is present and has a
* non-zero value.
*/
CFN_EXPORT const CFStringRef kCFNetworkProxiesExcludeSimpleHostnames CF_AVAILABLE(10_6, NA);
/*
* kCFNetworkProxiesFTPEnable
*
* Discussion:
* Key for the enabled status of the ftp proxy; value is a
* CFNumber. The proxy is enabled if the key is present and has a non-zero value.
*/
CFN_EXPORT const CFStringRef kCFNetworkProxiesFTPEnable CF_AVAILABLE(10_6, NA);
/*
* kCFNetworkProxiesFTPPassive
*
* Discussion:
* Key for the state of passive mode for the ftp proxy; value is a
* CFNumber. A value of one indicates that passive mode is enabled, a value
* of zero indicates that passive mode is not enabled.
*/
CFN_EXPORT const CFStringRef kCFNetworkProxiesFTPPassive CF_AVAILABLE(10_6, NA);
/*
* kCFNetworkProxiesFTPPort
*
* Discussion:
* Key for the port number associated with the ftp proxy; value is a
* CFNumber which is the port number.
*/
CFN_EXPORT const CFStringRef kCFNetworkProxiesFTPPort CF_AVAILABLE(10_6, NA);
/*
* kCFNetworkProxiesFTPProxy
*
* Discussion:
* Key for the host name associated with the ftp proxy; value is a
* CFString which is the proxy host name.
*/
CFN_EXPORT const CFStringRef kCFNetworkProxiesFTPProxy CF_AVAILABLE(10_6, NA);
/*
* kCFNetworkProxiesGopherEnable
*
* Discussion:
* Key for the enabled status of the gopher proxy; value is a
* CFNumber. The proxy is enabled if the key is present and has a non-zero value.
*/
CFN_EXPORT const CFStringRef kCFNetworkProxiesGopherEnable CF_AVAILABLE(10_6, NA);
/*
* kCFNetworkProxiesGopherPort
*
* Discussion:
* Key for the port number associated with the gopher proxy; value is a
* CFNumber which is the port number.
*/
CFN_EXPORT const CFStringRef kCFNetworkProxiesGopherPort CF_AVAILABLE(10_6, NA);
/*
* kCFNetworkProxiesGopherProxy
*
* Discussion:
* Key for the host name associated with the gopher proxy; value is a
* CFString which is the proxy host name.
*/
CFN_EXPORT const CFStringRef kCFNetworkProxiesGopherProxy CF_AVAILABLE(10_6, NA);
/*
* kCFNetworkProxiesHTTPEnable
*
* Discussion:
* Key for the enabled status of the HTTP proxy; value is a
* CFNumber. The proxy is enabled if the key is present and has a non-zero value.
*/
CFN_EXPORT const CFStringRef kCFNetworkProxiesHTTPEnable CF_AVAILABLE(10_6, 2_0);
/*
* kCFNetworkProxiesHTTPPort
*
* Discussion:
* Key for the port number associated with the HTTP proxy; value is a
* CFNumber which is the port number.
*/
CFN_EXPORT const CFStringRef kCFNetworkProxiesHTTPPort CF_AVAILABLE(10_6, 2_0);
/*
* kCFNetworkProxiesHTTPProxy
*
* Discussion:
* Key for the host name associated with the HTTP proxy; value is a
* CFString which is the proxy host name.
*/
CFN_EXPORT const CFStringRef kCFNetworkProxiesHTTPProxy CF_AVAILABLE(10_6, 2_0);
/*
* kCFNetworkProxiesHTTPSEnable
*
* Discussion:
* Key for the enabled status of the HTTPS proxy; value is a
* CFNumber. The proxy is enabled if the key is present and has a non-zero value.
*/
CFN_EXPORT const CFStringRef kCFNetworkProxiesHTTPSEnable CF_AVAILABLE(10_6, NA);
/*
* kCFNetworkProxiesHTTPSPort
*
* Discussion:
* Key for the port number associated with the HTTPS proxy; value is a
* CFNumber which is the port number.
*/
CFN_EXPORT const CFStringRef kCFNetworkProxiesHTTPSPort CF_AVAILABLE(10_6, NA);
/*
* kCFNetworkProxiesHTTPSProxy
*
* Discussion:
* Key for the host name associated with the HTTPS proxy; value is a
* CFString which is the proxy host name.
*/
CFN_EXPORT const CFStringRef kCFNetworkProxiesHTTPSProxy CF_AVAILABLE(10_6, NA);
/*
* kCFNetworkProxiesRTSPEnable
*
* Discussion:
* Key for the enabled status of the RTSP proxy; value is a
* CFNumber. The proxy is enabled if the key is present and has a non-zero value.
*/
CFN_EXPORT const CFStringRef kCFNetworkProxiesRTSPEnable CF_AVAILABLE(10_6, NA);
/*
* kCFNetworkProxiesRTSPPort
*
* Discussion:
* Key for the port number associated with the RTSP proxy; value is a
* CFNumber which is the port number.
*/
CFN_EXPORT const CFStringRef kCFNetworkProxiesRTSPPort CF_AVAILABLE(10_6, NA);
/*
* kCFNetworkProxiesRTSPProxy
*
* Discussion:
* Key for the host name associated with the RTSP proxy; value is a
* CFString which is the proxy host name.
*/
CFN_EXPORT const CFStringRef kCFNetworkProxiesRTSPProxy CF_AVAILABLE(10_6, NA);
/*
* kCFNetworkProxiesSOCKSEnable
*
* Discussion:
* Key for the enabled status of the SOCKS proxy; value is a
* CFNumber. The proxy is enabled if the key is present and has a non-zero value.
*/
CFN_EXPORT const CFStringRef kCFNetworkProxiesSOCKSEnable CF_AVAILABLE(10_6, NA);
/*
* kCFNetworkProxiesSOCKSPort
*
* Discussion:
* Key for the port number associated with the SOCKS proxy; value is a
* CFNumber which is the port number.
*/
CFN_EXPORT const CFStringRef kCFNetworkProxiesSOCKSPort CF_AVAILABLE(10_6, NA);
/*
* kCFNetworkProxiesSOCKSProxy
*
* Discussion:
* Key for the host name associated with the SOCKS proxy; value is a
* CFString which is the proxy host name.
*/
CFN_EXPORT const CFStringRef kCFNetworkProxiesSOCKSProxy CF_AVAILABLE(10_6, NA);
/*
* kCFNetworkProxiesProxyAutoConfigEnable
*
* Discussion:
* Key for the enabled status ProxyAutoConfig (PAC); value is a
* CFNumber. ProxyAutoConfig is enabled if the key is present and has a non-zero value.
*/
CFN_EXPORT const CFStringRef kCFNetworkProxiesProxyAutoConfigEnable CF_AVAILABLE(10_6, 2_0);
/*
* kCFNetworkProxiesProxyAutoConfigURLString
*
* Discussion:
* Key for the url which indicates the location of the ProxyAutoConfig (PAC) file; value is a
* CFString which is url for the PAC file.
*/
CFN_EXPORT const CFStringRef kCFNetworkProxiesProxyAutoConfigURLString CF_AVAILABLE(10_6, 2_0);
/*
* kCFNetworkProxiesProxyAutoConfigJavaScript
*
* Discussion:
* Key for the string which is the full JavaScript source of the ProxyAutoConfig (PAC) script; value is a
* CFString with is the full text source of the PAC script.
*/
CFN_EXPORT const CFStringRef kCFNetworkProxiesProxyAutoConfigJavaScript CF_AVAILABLE(10_7, 3_0);
/*
* kCFNetworkProxiesProxyAutoDiscoveryEnable
*
* Discussion:
* Key for the enabled status of proxy auto discovery; value is a
* CFNumber. Proxy auto discovery is enabled if the key is present and has a non-zero value.
*/
CFN_EXPORT const CFStringRef kCFNetworkProxiesProxyAutoDiscoveryEnable CF_AVAILABLE(10_6, NA);
#endif // TARGET_OS_MAC
CF_ASSUME_NONNULL_END
CF_EXTERN_C_END
#endif /* __CFPROXYSUPPORT__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CFNetwork.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CFNetwork.framework/Headers/CFNetwork.h | /*
File: CFNetwork/CFNetwork.h
Contains: CoreFoundation Network header
Copyright: Copyright (c) 2001-2008 Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __CFNETWORK__
#define __CFNETWORK__
#ifndef __COREFOUNDATION__
#include <CoreFoundation/CoreFoundation.h>
#endif
#ifndef __CFNETWORKDEFS__
#include <CFNetwork/CFNetworkDefs.h>
#endif
#ifndef __CFNETWORKERRORS__
#include <CFNetwork/CFNetworkErrors.h>
#endif
#ifndef __CFSOCKETSTREAM__
#include <CFNetwork/CFSocketStream.h>
#endif
#ifndef __CFFTPSTREAM__
#include <CFNetwork/CFFTPStream.h>
#endif
#ifndef __CFHOST__
#include <CFNetwork/CFHost.h>
#endif
#ifndef __CFHTTPMESSAGE__
#include <CFNetwork/CFHTTPMessage.h>
#endif
#ifndef __CFHTTPSTREAM__
#include <CFNetwork/CFHTTPStream.h>
#endif
#ifndef __CFHTTPAUTHENTICATION__
#include <CFNetwork/CFHTTPAuthentication.h>
#endif
#ifndef __CFNETDIAGNOSTICS__
#include <CFNetwork/CFNetDiagnostics.h>
#endif
#ifndef __CFNETSERVICES__
#include <CFNetwork/CFNetServices.h>
#endif
#ifndef __CFPROXYSUPPORT__
#include <CFNetwork/CFProxySupport.h>
#endif
#endif /* __CFNETWORK__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CFNetwork.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CFNetwork.framework/Headers/CFNetDiagnostics.h | /*
File: CFNetwork/CFNetDiagnostics.h
Contains: CFNetDiagnostics interface
Copyright: Copyright (c) 2004-2017 Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __CFNETDIAGNOSTICS__
#define __CFNETDIAGNOSTICS__
#ifndef __CFNETWORKDEFS__
#include <CFNetwork/CFNetworkDefs.h>
#endif
#ifndef __COREFOUNDATION__
#include <CoreFoundation/CoreFoundation.h>
#endif
#include <stdint.h>
#if PRAGMA_ONCE
#pragma once
#endif
CF_EXTERN_C_BEGIN
CF_ASSUME_NONNULL_BEGIN
/*
* CFNetDiagnosticRef
*
* Discussion:
* This is the type used to describe the types of connection that
* clients may be querying about
*/
typedef struct __CFNetDiagnostic* CFNetDiagnosticRef;
/*
* CFNetDiagnosticStatusValues
*
* Discussion:
* Values for CFNetDiagnosticStatus
*/
typedef CF_ENUM(int, CFNetDiagnosticStatusValues) {
/*
* There is no status, but no error has occured
*/
kCFNetDiagnosticNoErr = 0,
/*
* An error occured that prevented the call from completing
*/
kCFNetDiagnosticErr = -66560L,
/*
* The connection appears to be working
*/
kCFNetDiagnosticConnectionUp = -66559L,
kCFNetDiagnosticConnectionIndeterminate = -66558L,
/*
* The connection does not appear to be working
*/
kCFNetDiagnosticConnectionDown = -66557L
} CF_DEPRECATED(10_4, 10_13, 2_0, 11_0);
/*
* CFNetDiagnosticStatus
*
* Discussion:
* Returned by the various status and diagnostic calls
*/
typedef CFIndex CFNetDiagnosticStatus CF_DEPRECATED(10_4, 10_13, 2_0, 11_0);
/*
* CFNetDiagnosticCreateWithStreams()
*
* Discussion:
* Creates a CFNetDiagnosticRef from a pair of CFStreams. Either
* stream may be NULL. This is the preferred interface for creating
* a CFNetDiagnosticRef.
*
* Parameters:
*
* alloc:
* The CF allocator to use.
*
* readStream:
* CFReadStreamRef referring to the failed connection. May be NULL.
*
* writeStream:
* CFWriteStreamRef referring to the failed connection. May be
* NULL.
*
* Result:
* A CFNetDiagnosticRef referring to the current networking issue.
*
*/
CFN_EXPORT CFNetDiagnosticRef
CFNetDiagnosticCreateWithStreams(CFAllocatorRef __nullable alloc, CFReadStreamRef __nullable readStream, CFWriteStreamRef __nullable writeStream) CF_DEPRECATED(10_4, 10_13, 2_0, 11_0);
/*
* CFNetDiagnosticCreateWithURL()
*
* Discussion:
* Creates a CFNetDiagnosticRef based on a CFURLRef passed in by the
* application.
*
* Parameters:
*
* alloc:
* The CF allocator to use.
*
* url:
* CFURLRef referring to the failed connection.
*
* Result:
* A CFNetDiagnosticRef referring to the current networking issue.
*
*/
CFN_EXPORT CFNetDiagnosticRef
CFNetDiagnosticCreateWithURL(CFAllocatorRef alloc, CFURLRef url) CF_DEPRECATED(10_4, 10_13, 2_0, 11_0);
/*
* CFNetDiagnosticSetName()
*
* Discussion:
* If the framework requires an application name to be displayed to
* the user it will derive it from the bundle identifier of the
* currently running application, in that application's current
* localization. If you want to override that you may use
* CFNetDiagnosticSetName to specify a CFStringRef to be used.
*
* Parameters:
*
* details:
* CFNetDiagnosticRef referring to the current problem.
*
* name:
* The localized name that should appear to the user when
* referring to the application.
*
*/
CFN_EXPORT void
CFNetDiagnosticSetName(CFNetDiagnosticRef details, CFStringRef name) CF_DEPRECATED(10_4, 10_13, 2_0, 11_0);
/*
* CFNetDiagnosticDiagnoseProblemInteractively()
*
* Discussion:
* Opens the Network Diagnostics window and returns immediately once
* it is open. The client passes in a CFNetDiagnosticRef built with
* one of the creator functions.
*
* Parameters:
*
* details:
* CFNetDiagnosticRef referring to the current problem.
*
* Result:
* A CFNetDiagnosticStatus. Will either be CFNetDiagnosticNoErr, or
* CFNetDiagnosticErr if there was an error attempting to run the
* diagnosis.
*
*/
CFN_EXPORT CFNetDiagnosticStatus
CFNetDiagnosticDiagnoseProblemInteractively(CFNetDiagnosticRef details) CF_DEPRECATED(10_4, 10_13, 2_0, 11_0);
/*
* CFNetDiagnosticCopyNetworkStatusPassively()
*
* Discussion:
* Returns a status value that can be used to display basic
* information about the connection. If the caller wishes they may
* pass in a pointer to a CFStringRef that will be used to pass back
* a localized description of the problem. It is the caller's
* responsibility to release the CFStringRef. If the caller does not
* want a description they may pass in NULL.
* CFNetDiagnosticCopyNetworkStatusPassively() is guaranteed not to
* cause network activity.
*
* Parameters:
*
* details:
* CFNetDiagnosticRef referring to the current problem.
*
* description:
* A pointer to a CFStringRef that, upon return, will point to a
* localized string containing a description of the current
* network status. May be NULL. If it is not NULL, the client must
* call CFRelease on the returned object.
*
*/
CFN_EXPORT CFNetDiagnosticStatus
CFNetDiagnosticCopyNetworkStatusPassively(CFNetDiagnosticRef details, CFStringRef __nullable * __nullable description) CF_DEPRECATED(10_4, 10_13, 2_0, 11_0);
CF_ASSUME_NONNULL_END
CF_EXTERN_C_END
#endif /* __CFNETDIAGNOSTICS__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CFNetwork.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CFNetwork.framework/Headers/CFHTTPMessage.h | /*
File: CFNetwork/CFHTTPMessage.h
Contains: CoreFoundation Network socket streams header
Copyright: Copyright (c) 2001-2013 Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __CFHTTPMESSAGE__
#define __CFHTTPMESSAGE__
#ifndef __CFNETWORKDEFS__
#include <CFNetwork/CFNetworkDefs.h>
#endif
#ifndef __CFSTRING__
#include <CoreFoundation/CFString.h>
#endif
#ifndef __CFURL__
#include <CoreFoundation/CFURL.h>
#endif
#if PRAGMA_ONCE
#pragma once
#endif
CF_EXTERN_C_BEGIN
CF_ASSUME_NONNULL_BEGIN
/*
* kCFHTTPVersion1_0
*
* Discussion:
* Version string for HTTP 1.0.
*
*/
CFN_EXPORT const CFStringRef kCFHTTPVersion1_0 CF_AVAILABLE(10_1, 2_0);
/*
* kCFHTTPVersion1_1
*
* Discussion:
* Version string for HTTP 1.1.
*
*/
CFN_EXPORT const CFStringRef kCFHTTPVersion1_1 CF_AVAILABLE(10_1, 2_0);
/*
* kCFHTTPVersion2_0
*
* Discussion:
* Version string for HTTP 2.0.
*
*/
CFN_EXPORT const CFStringRef kCFHTTPVersion2_0 CF_AVAILABLE(10_10, 8_0);
/*
* kCFHTTPVersion3_0
*
* Discussion:
* Version string for HTTP 3.0.
*
*/
CFN_EXPORT const CFStringRef kCFHTTPVersion3_0 CF_AVAILABLE(10_15, 13_0);
/*
* kCFHTTPAuthenticationSchemeBasic
*
* Discussion:
* HTTP Basic authentication scheme.
*
*/
CFN_EXPORT const CFStringRef kCFHTTPAuthenticationSchemeBasic CF_AVAILABLE(10_2, 2_0);
/*
* kCFHTTPAuthenticationSchemeDigest
*
* Discussion:
* HTTP Digest Access authentication scheme.
*
*/
CFN_EXPORT const CFStringRef kCFHTTPAuthenticationSchemeDigest CF_AVAILABLE(10_2, 2_0);
/*
* kCFHTTPAuthenticationSchemeNTLM
*
* Discussion:
* HTTP NTLM authentication scheme.
*
*/
CFN_EXPORT const CFStringRef kCFHTTPAuthenticationSchemeNTLM CF_AVAILABLE(10_5, 2_0);
/*
* kCFHTTPAuthenticationSchemeKerberos
*
* Discussion:
* HTTP Negotiate authentication scheme.
*
*/
CFN_EXPORT const CFStringRef kCFHTTPAuthenticationSchemeKerberos CF_AVAILABLE(10_5, 2_0);
/*
* kCFHTTPAuthenticationSchemeNegotiate
*
* Discussion:
* HTTP Negotiate authentication scheme.
*
*/
CFN_EXPORT const CFStringRef kCFHTTPAuthenticationSchemeNegotiate CF_AVAILABLE(10_5, 2_0);
/*
* kCFHTTPAuthenticationSchemeNegotiate2
*
* Discussion:
* HTTP Negotiate v2 authentication scheme.
*
*/
CFN_EXPORT const CFStringRef kCFHTTPAuthenticationSchemeNegotiate2 CF_AVAILABLE(10_6, 3_0);
/*
* kCFHTTPAuthenticationSchemeXMobileMeAuthToken
*
* Discussion:
* HTTP XMobileMeAuthToken authentication scheme.
*
*/
CFN_EXPORT const CFStringRef kCFHTTPAuthenticationSchemeXMobileMeAuthToken CF_AVAILABLE(10_6, 4_3);
/*
* CFHTTPMessageRef
*
* Discussion:
* This is the type of a reference to an HTTP message. An HTTP
* message can be a request or a response.
*/
typedef struct __CFHTTPMessage* CFHTTPMessageRef;
/*
* CFHTTPMessageGetTypeID()
*
* Discussion:
* Return the unique type for this class.
*
* Mac OS X threading:
* Thread safe
*
* Result:
* A unique CFType for CFHTTPMessage.
*
*/
CFN_EXPORT CFTypeID
CFHTTPMessageGetTypeID(void) CF_AVAILABLE(10_1, 2_0);
/*
* CFHTTPMessageCreateRequest()
*
* Discussion:
* Create an HTTPMessage from an HTTP method, url and version.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* alloc:
* A pointer to the CFAllocator which should be used to allocate
* memory for the CF read stream and its storage for values. If
* this reference is not a valid CFAllocator, the behavior is
* undefined.
*
* requestMethod:
* A pointer to a CFString indicating the method of request. For a
* "GET" request, for example, the value would be CFSTR("GET").
*
* url:
* A pointer to a CFURL structure created any of the several
* CFURLCreate... functions. If this parameter is not a pointer
* to a valid CFURL structure, the behavior is undefined.
*
* httpVersion:
* A pointer to a CFString indicating the version of request.
*
* Result:
* A pointer to the CFHTTPMessage created, or NULL if failed. It is
* caller's responsibilty to release the memory allocated for the
* message.
*
*/
CFN_EXPORT CFHTTPMessageRef
CFHTTPMessageCreateRequest(CFAllocatorRef __nullable alloc, CFStringRef requestMethod, CFURLRef url, CFStringRef httpVersion) CF_AVAILABLE(10_1, 2_0);
/*
* CFHTTPMessageCreateResponse()
*
* Discussion:
* Create an HTTPMessage from an HTTP status code, description and
* version.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* alloc:
* A pointer to the CFAllocator which should be used to allocate
* memory for the CF read stream and its storage for values. If
* this reference is not a valid CFAllocator, the behavior is
* undefined.
*
* statusCode:
* An integer status code for the response.
*
* statusDescription:
* A pointer to a CFString for the status. Pass NULL to use the
* standard description for the given status code, as found in RFC
* 2616.
*
* httpVersion:
* A pointer to a CFString for the HTTP version.
*
* Result:
* A pointer to the CFHTTPMessage created, or NULL if failed. It is
* caller's responsibilty to release the memory allocated for the
* message.
*
*/
CFN_EXPORT CFHTTPMessageRef
CFHTTPMessageCreateResponse(
CFAllocatorRef __nullable alloc,
CFIndex statusCode,
CFStringRef __nullable statusDescription,
CFStringRef httpVersion) CF_AVAILABLE(10_1, 2_0);
/*
* CFHTTPMessageCreateEmpty()
*
* Discussion:
* Creates an empty request or response, which you can then append
* bytes to via CFHTTPMessageAppendBytes().
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* alloc:
* A pointer to the CFAllocator which should be used to allocate
* memory for the CF read stream and its storage for values. If
* this reference is not a valid CFAllocator, the behavior is
* undefined.
*
* isRequest:
* A boolean. Pass kCFBooleanTrue if the message should be a
* request.
*
* Result:
* A pointer to the CFHTTPMessage created, or NULL if failed. It is
* caller's responsibilty to release the memory allocated for the
* message.
*
*/
CFN_EXPORT CFHTTPMessageRef
CFHTTPMessageCreateEmpty(CFAllocatorRef __nullable alloc, Boolean isRequest) CF_AVAILABLE(10_1, 2_0);
/*
* CFHTTPMessageCreateCopy()
*
* Discussion:
* Creates a copy of a CFHTTPMessage.
*
* Mac OS X threading:
* Not thread safe
*
* Parameters:
*
* alloc:
* A pointer to the CFAllocator which should be used to allocate
* memory for the CF read stream and its storage for values. If
* this reference is not a valid CFAllocator, the behavior is
* undefined.
*
* message:
* A pointer to the CFHTTPMessage to be copied. If the message is
* NULL, the behavior is undefined.
*
* Result:
* A pointer to the CFHTTPMessage created, or NULL if failed. It is
* caller's responsibilty to release the memory allocated for the
* message.
*
*/
CFN_EXPORT CFHTTPMessageRef
CFHTTPMessageCreateCopy(CFAllocatorRef __nullable alloc, CFHTTPMessageRef message) CF_AVAILABLE(10_1, 2_0);
/*
* CFHTTPMessageIsRequest()
*
* Discussion:
* Returns whether the CFHTTPMessage is a request or a response.
*
* Mac OS X threading:
* Not thread safe
*
* Parameters:
*
* message:
* A pointer to the CFHTTPMessage to be copied. If the message is
* NULL, the behavior is undefined.
*
* Result:
* A Boolean. A value of kCFBooleanTrue indicates the message is a
* request. A value of kCFBooleanFalse indicates the message is a
* response.
*
*/
CFN_EXPORT Boolean
CFHTTPMessageIsRequest(CFHTTPMessageRef message) CF_AVAILABLE(10_1, 2_0);
/*
* CFHTTPMessageCopyVersion()
*
* Discussion:
* Returns the HTTP version.
*
* Mac OS X threading:
* Not thread safe
*
* Parameters:
*
* message:
* A pointer to the CFHTTPMessage to be copied. If the message is
* NULL, the behavior is undefined.
*
* Result:
* A pointer to a CFString, or NULL if failed. It is caller's
* responsibilty to release the memory allocated for the string.
*
*/
CFN_EXPORT CFStringRef
CFHTTPMessageCopyVersion(CFHTTPMessageRef message) CF_AVAILABLE(10_1, 2_0);
/*
* CFHTTPMessageCopyBody()
*
* Discussion:
* Returns the body of the message.
*
* Mac OS X threading:
* Not thread safe
*
* Parameters:
*
* message:
* A pointer to the CFHTTPMessage to be copied. If the message is
* NULL, the behavior is undefined.
*
* Result:
* A pointer to a CFData, or NULL if failed. It is caller's
* responsibilty to release the memory allocated for the data.
*
*/
CFN_EXPORT __nullable CFDataRef
CFHTTPMessageCopyBody(CFHTTPMessageRef message) CF_AVAILABLE(10_1, 2_0);
/*
* CFHTTPMessageSetBody()
*
* Discussion:
* Sets the body of the message from a CFData.
*
* Mac OS X threading:
* Not thread safe
*
* Parameters:
*
* message:
* A pointer to the CFHTTPMessage to be copied. If the message is
* NULL, the behavior is undefined.
*
* bodyData:
* A pointer to a CFData containing the body to be set. If the
* bodyData is NULL, the behavior is undefined.
*
*/
CFN_EXPORT void
CFHTTPMessageSetBody(CFHTTPMessageRef message, CFDataRef bodyData) CF_AVAILABLE(10_1, 2_0);
/*
* CFHTTPMessageCopyHeaderFieldValue()
*
* Discussion:
* Returns the specified header field.
*
* Mac OS X threading:
* Not thread safe
*
* Parameters:
*
* message:
* A pointer to the CFHTTPMessage to be copied. If the message is
* NULL, the behavior is undefined.
*
* headerField:
* A pointer to the CFString. If the headerField is NULL, the
* behavior is undefined.
*
* Result:
* A pointer to a CFString, or NULL if failed. It is caller's
* responsibilty to release the memory allocated for the string.
*
*/
CFN_EXPORT __nullable CFStringRef
CFHTTPMessageCopyHeaderFieldValue(CFHTTPMessageRef message, CFStringRef headerField) CF_AVAILABLE(10_1, 2_0);
/*
* CFHTTPMessageCopyAllHeaderFields()
*
* Discussion:
* Returns a CFDictionary containing all of the header fields.
*
* Mac OS X threading:
* Not thread safe
*
* Parameters:
*
* message:
* A pointer to the CFHTTPMessage to be copied. If the message is
* NULL, the behavior is undefined.
*
* Result:
* A pointer to a CFDictionary, or NULL if failed. It is caller's
* responsibilty to release the memory allocated for the dictionary.
*
*/
CFN_EXPORT __nullable CFDictionaryRef
CFHTTPMessageCopyAllHeaderFields(CFHTTPMessageRef message) CF_AVAILABLE(10_1, 2_0);
/*
* CFHTTPMessageSetHeaderFieldValue()
*
* Discussion:
* Sets the value of the specified header field.
*
* Mac OS X threading:
* Not thread safe
*
* Parameters:
*
* message:
* A pointer to the CFHTTPMessage to be copied. If the message is
* NULL, the behavior is undefined.
*
* headerField:
* A pointer to the CFString. If headerField is NULL, the behavior
* is undefined.
*
* value:
* A pointer to the CFString containing the value to set. Set the
* value to NULL to remove the header field.
*
*/
CFN_EXPORT void
CFHTTPMessageSetHeaderFieldValue(CFHTTPMessageRef message, CFStringRef headerField, CFStringRef __nullable value) CF_AVAILABLE(10_1, 2_0);
/*
* CFHTTPMessageAppendBytes()
*
* Discussion:
* Appends the given bytes to the message given (parsing out any
* control information if appropriate). Returns kCFBooleanFalse if
* a parsing error occurs while processing the new data.
*
* Mac OS X threading:
* Not thread safe
*
* Parameters:
*
* message:
* A pointer to the CFHTTPMessage to be copied. If the message is
* NULL, the behavior is undefined.
*
* newBytes:
* A pointer to the bytes. If newBytes is NULL, the behavior is
* undefined.
*
* numBytes:
* A CFIndex of the number of bytes to append.
*
* Result:
* A Boolean indicating success or failure.
*
*/
CFN_EXPORT Boolean
CFHTTPMessageAppendBytes(CFHTTPMessageRef message, const UInt8 *newBytes, CFIndex numBytes) CF_AVAILABLE(10_1, 2_0);
/*
* CFHTTPMessageIsHeaderComplete()
*
* Discussion:
* Returns whether further header data is expected by the message.
*
* Mac OS X threading:
* Not thread safe
*
* Parameters:
*
* message:
* A pointer to the CFHTTPMessage to be copied. If the message is
* NULL, the behavior is undefined.
*
* Result:
* A Boolean. A value of kCFBooleanTrue indicates the header is
* complete and no further data is expected.
*
*/
CFN_EXPORT Boolean
CFHTTPMessageIsHeaderComplete(CFHTTPMessageRef message) CF_AVAILABLE(10_1, 2_0);
/*
* CFHTTPMessageCopySerializedMessage()
*
* Discussion:
* Creates a self-contained copy of a CFHTTPMessage. This would be
* suitable for persistant storage or for transmitting over the
* network independently.
*
* Mac OS X threading:
* Not thread safe
*
* Parameters:
*
* request:
* A pointer to the CFHTTPMessage to be seralized.
*
* Result:
* A pointer to a CFData, or NULL if failed. It is caller's
* responsibilty to release the memory allocated for the data.
*
*/
CFN_EXPORT __nullable CFDataRef
CFHTTPMessageCopySerializedMessage(CFHTTPMessageRef message) CF_AVAILABLE(10_1, 2_0);
/*********************/
/* Request functions */
/*********************/
/*
* CFHTTPMessageCopyRequestURL()
*
* Discussion:
* Creates a copy of the request URL.
*
* Mac OS X threading:
* Not thread safe
*
* Parameters:
*
* request:
* A pointer to the CFHTTPMessage.
*
* Result:
* A pointer to a CFURL, or NULL if failed. It is caller's
* responsibilty to release the memory allocated for the url.
*
*/
CFN_EXPORT __nullable CFURLRef
CFHTTPMessageCopyRequestURL(CFHTTPMessageRef request) CF_AVAILABLE(10_1, 2_0);
/*
* CFHTTPMessageCopyRequestMethod()
*
* Discussion:
* Creates a copy of the request method.
*
* Mac OS X threading:
* Not thread safe
*
* Parameters:
*
* request:
* A pointer to the CFHTTPMessage.
*
* Result:
* A pointer to a CFString, or NULL if failed. It is caller's
* responsibilty to release the memory allocated for the string.
*
*/
CFN_EXPORT __nullable CFStringRef
CFHTTPMessageCopyRequestMethod(CFHTTPMessageRef request) CF_AVAILABLE(10_1, 2_0);
/*
* CFHTTPMessageAddAuthentication()
*
* Discussion:
* Adds authentication to the request. Tries to modify request to
* contain the authentication information requested by the failed
* response (which presumably is a 401 or 407 response).
*
* Mac OS X threading:
* Not thread safe
*
* Parameters:
*
* request:
* A pointer to a CFHTTPMessage request.
*
* authenticationFailureResponse:
* A pointer to a CFHTTPMessage of the failed response.
*
* username:
* A pointer to a CFString containing the user name to
* authenticate.
*
* password:
* A pointer to a CFString containing the password of the user.
*
* authenticationScheme:
* A pointer to a CFString containing the authentication scheme to
* use to authenticate. If authenticationScheme is NULL, strongest
* supported scheme listed authenticationFailureResponse will be
* used.
*
* forProxy:
* A boolean indicating whether the authentication applies to a
* proxy or not.
*
* Result:
* A pointer to a CFString, or NULL if failed. It is caller's
* responsibilty to release the memory allocated for the string.
*
*/
CFN_EXPORT Boolean
CFHTTPMessageAddAuthentication(
CFHTTPMessageRef request,
CFHTTPMessageRef __nullable authenticationFailureResponse,
CFStringRef username,
CFStringRef password,
CFStringRef __nullable authenticationScheme,
Boolean forProxy) CF_AVAILABLE(10_1, 2_0);
/**********************/
/* Response functions */
/**********************/
/*
* CFHTTPMessageGetResponseStatusCode()
*
* Discussion:
* Returns the status code for the response.
*
* Mac OS X threading:
* Not thread safe
*
* Parameters:
*
* response:
* A pointer to the CFHTTPMessage to be copied. If the message is
* NULL, the behavior is undefined.
*
* Result:
* A UInt32 indicating the status code.
*
*/
CFN_EXPORT CFIndex
CFHTTPMessageGetResponseStatusCode(CFHTTPMessageRef response) CF_AVAILABLE(10_1, 2_0);
/*
* CFHTTPMessageCopyResponseStatusLine()
*
* Discussion:
* Returns the status line for the response.
*
* Mac OS X threading:
* Not thread safe
*
* Parameters:
*
* response:
* A pointer to the CFHTTPMessage to be copied. If the message is
* NULL, the behavior is undefined.
*
* Result:
* A CFString indicating the status code, or NULL if failed. It is
* caller's responsibilty to release the memory allocated for the
* string.
*
*/
CFN_EXPORT __nullable CFStringRef
CFHTTPMessageCopyResponseStatusLine(CFHTTPMessageRef response) CF_AVAILABLE(10_1, 2_0);
CF_ASSUME_NONNULL_END
CF_EXTERN_C_END
#endif /* __CFHTTPMESSAGE__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CFNetwork.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CFNetwork.framework/Headers/CFHost.h | /*
File: CFNetwork/CFHost.h
Contains: CoreFoundation CFHost header
Copyright: Copyright (c) 2001-2013 Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __CFHOST__
#define __CFHOST__
#ifndef __CFNETWORKDEFS__
#include <CFNetwork/CFNetworkDefs.h>
#endif
#ifndef __COREFOUNDATION__
#include <CoreFoundation/CoreFoundation.h>
#endif
#ifndef __CFSTREAM__
#include <CoreFoundation/CFStream.h>
#endif
/**
* DEPRECATION NOTICE
*
* If you’re using `CFHost` to resolve DNS names so that you can connect to a
* service, switch to a connect-by-name API, for example, `nw_connection`.
*
* If you have other DNS resolution needs, switch to <dns_sd.h>.
*/
#if PRAGMA_ONCE
#pragma once
#endif
CF_EXTERN_C_BEGIN
CF_ASSUME_NONNULL_BEGIN
#pragma pack(push, 2)
/*
* CFHostRef
*
* Discussion:
* This is the type of a reference to a host name or address lookup.
*/
typedef struct __CFHost* CFHostRef;
/*
* kCFStreamErrorDomainNetDB
*
* Discussion:
* Errors listed in netdb.h
*
*/
CFN_EXPORT const SInt32 kCFStreamErrorDomainNetDB CF_AVAILABLE(10_3, 2_0);
/*
* kCFStreamErrorDomainSystemConfiguration
*
* Discussion:
* Errors listed in SystemConfiguration/SystemConfiguration.h
*
*/
CFN_EXPORT const SInt32 kCFStreamErrorDomainSystemConfiguration CF_AVAILABLE(10_3, 2_0);
/*
* CFHostInfoType
*
* Discussion:
* Host information types to be resolved.
*/
typedef CF_ENUM(int, CFHostInfoType) {
/*
* Results value is a CFArray of CFData's (each being a struct
* sockaddr)
*/
kCFHostAddresses = 0,
/*
* Results value is a CFArray of CFString's
*/
kCFHostNames = 1,
/*
* Results value is a CFData wrapping SCNetworkConnectionFlags
* (defined in SystemConfiguration/SCNetwork.h)
*/
kCFHostReachability = 2
};
/*
* CFHostClientContext
*
* Discussion:
* Structure containing the user-defined data and callbacks for
* CFHost objects.
*/
struct CFHostClientContext {
/*
* The version number of the structure type being passed in as a
* parameter to the CFHost client function. Valid version number is
* currently 0.
*/
CFIndex version;
/*
* An arbitrary pointer to client-defined data, which can be
* associated with the host and is passed to the callbacks.
*/
void * __nullable info;
/*
* The callback used to add a retain for the host on the info pointer
* for the life of the host, and may be used for temporary references
* the host needs to take. This callback returns the actual info
* pointer to store in the host, almost always just the pointer
* passed as the parameter.
*/
CFAllocatorRetainCallBack __nullable retain;
/*
* The callback used to remove a retain previously added for the host
* on the info pointer.
*/
CFAllocatorReleaseCallBack __nullable release;
/*
* The callback used to create a descriptive string representation of
* the info pointer (or the data pointed to by the info pointer) for
* debugging purposes. This is used by the CFCopyDescription()
* function.
*/
CFAllocatorCopyDescriptionCallBack __nullable copyDescription;
};
typedef struct CFHostClientContext CFHostClientContext;
/*
* CFHostClientCallBack
*
* Discussion:
* Callback function which is called upon error or completion of an
* asynchronous resolve.
*
* Parameters:
*
* theHost:
* Host whose resolution is complete.
*
* typeInfo:
* Enum representing which info resolution is complete.
*
* error:
* Reference to an error structure if the resolution failed.
*
* info:
* Client's info reference which was passed into the client
* context.
*/
typedef CALLBACK_API_C( void , CFHostClientCallBack )(CFHostRef theHost, CFHostInfoType typeInfo, const CFStreamError * __nullable error, void * __nullable info);
/*
* CFHostGetTypeID()
*
* Discussion:
* Returns the type identifier of all CFHost instances.
*
* Mac OS X threading:
* Thread safe
*
*/
CFN_EXPORT CFTypeID
CFHostGetTypeID(void) API_DEPRECATED("Use Network framework instead, see deprecation notice in <CFNetwork/CFHost.h>", macos(10.3, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFHostCreateWithName()
*
* Discussion:
* Creates a new host object with the given name.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* allocator:
* The CFAllocator which should be used to allocate memory for the
* host. If this reference is not a valid CFAllocator, the
* behavior is undefined.
*
* hostname:
* A CFStringRef representing the name of the host. Must be
* non-NULL. If this reference is not a valid CFStringRef, the
* behavior is undefined.
*
* Result:
* A valid CFHostRef which may now be resolved, or NULL if
* unsuccessful.
*
*/
CFN_EXPORT CFHostRef
CFHostCreateWithName(CFAllocatorRef __nullable allocator, CFStringRef hostname) API_DEPRECATED("Use Network framework instead, see deprecation notice in <CFNetwork/CFHost.h>", macos(10.3, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFHostCreateWithAddress()
*
* Discussion:
* Creates a new host object with the given address.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* allocator:
* The CFAllocator which should be used to allocate memory for the
* host. If this reference is not a valid CFAllocator, the
* behavior is undefined.
*
* addr:
* A CFDataRef containing a struct sockaddr which is the address
* of the host. Must be non-NULL. If this reference is not a
* valid CFDataRef, the behavior is undefined.
*
* Result:
* A valid CFHostRef which may now be resolved, or NULL if
* unsuccessful.
*
*/
CFN_EXPORT CFHostRef
CFHostCreateWithAddress(CFAllocatorRef __nullable allocator, CFDataRef addr) API_DEPRECATED("Use Network framework instead, see deprecation notice in <CFNetwork/CFHost.h>", macos(10.3, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFHostCreateCopy()
*
* Discussion:
* Creates a new host object as a copy of host argument.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* alloc:
* The CFAllocator which should be used to allocate memory for the
* new host. If this reference is not a valid CFAllocator, the
* behavior is undefined.
*
* host:
* A CFHostRef representing the original host. Must be non-NULL.
* If this reference is not a valid CFHostRef, the behavior is
* undefined.
*
* Result:
* A valid CFHostRef which contains a copy of all previously
* resolved data from the original. NULL is returned in the case of
* failure.
*
*/
CFN_EXPORT CFHostRef
CFHostCreateCopy(CFAllocatorRef __nullable alloc, CFHostRef host) API_DEPRECATED("Use Network framework instead, see deprecation notice in <CFNetwork/CFHost.h>", macos(10.3, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFHostStartInfoResolution()
*
* Discussion:
* Performs a lookup for the given host. It will search for the
* requested information if there is no other active request.
* Previously cached information of the given type will be released.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* theHost:
* The CFHostRef which should be resolved. Must be non-NULL. If
* this reference is not a valid CFHostRef, the behavior is
* undefined.
*
* info:
* The enum representing the type of information to be retrieved.
* If the value is not a valid type, the behavior is undefined.
*
* error:
* A reference to a CFStreamError structure which will be filled
* with any error information should an error occur. May be set
* to NULL if error information is not wanted.
*
* Result:
* Returns TRUE on success and FALSE on failure. In asynchronous
* mode, this function will return immediately. In synchronous
* mode, it will block until the resolve has completed or until the
* resolve is cancelled.
*
*/
CFN_EXPORT Boolean
CFHostStartInfoResolution(CFHostRef theHost, CFHostInfoType info, CFStreamError * __nullable error) API_DEPRECATED("Use Network framework instead, see deprecation notice in <CFNetwork/CFHost.h>", macos(10.3, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFHostGetAddressing()
*
* Discussion:
* Tries to retrieve the known addresses from the given host.
* Returns a CFArrayRef of addresses if known and there were some.
* NULL is returned otherwise. Each address is a CFDataRef wrapping
* a struct sockaddr.
*
* Mac OS X threading:
* Thread safe
* The function gets the data in a thread-safe manner, but the
* resulting data is not safe. Since it is returned as a matter of
* a get opposed to a copy, the data is not safe if the host is
* being altered from another thread.
*
* Parameters:
*
* theHost:
* The CFHostRef which contains the relevant information. Must be
* non-NULL. If this reference is not a valid CFHostRef, the
* behavior is undefined.
*
* hasBeenResolved:
* A reference to a Boolean which returns FALSE if the information
* was not available (e.g. CFHostStartInfoResolution has not been
* called), otherwise TRUE will be returned.
*
*/
CFN_EXPORT __nullable CFArrayRef
CFHostGetAddressing(CFHostRef theHost, Boolean * __nullable hasBeenResolved) API_DEPRECATED("Use Network framework instead, see deprecation notice in <CFNetwork/CFHost.h>", macos(10.3, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFHostGetNames()
*
* Discussion:
* Tries to retrieve the names/aliases from the given host. Returns
* a CFArrayRef of names for the given host. NULL is returned
* otherwise.
*
* Mac OS X threading:
* Thread safe
* The function gets the data in a thread-safe manner, but the
* resulting data is not safe. Since it is returned as a matter of
* a get opposed to a copy, the data is not safe if the host is
* being altered from another thread.
*
* Parameters:
*
* theHost:
* The CFHostRef which contains the relevant information. Must be
* non-NULL. If this reference is not a valid CFHostRef, the
* behavior is undefined.
*
* hasBeenResolved:
* A reference to a Boolean which returns FALSE if the information
* was not available (e.g. CFHostStartInfoResolution has not been
* called), otherwise TRUE will be returned. Can be NULL.
*
*/
CFN_EXPORT __nullable CFArrayRef
CFHostGetNames(CFHostRef theHost, Boolean * __nullable hasBeenResolved) API_DEPRECATED("Use Network framework instead, see deprecation notice in <CFNetwork/CFHost.h>", macos(10.3, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFHostGetReachability()
*
* Discussion:
* Tries to retrieve the reachability of the given host. Returns a
* CFDataRef which wraps the reachability flags. NULL will be
* returned if the value has not been resolved. The possible values
* of these flags is declared in SystemConfiguration/SCNetwork.h.
* Returns FALSE if the information was not available, otherwise
* TRUE will be returned with the results containing the requested
* information.
*
* Mac OS X threading:
* Thread safe
* The function gets the data in a thread-safe manner, but the
* resulting data is not safe. Since it is returned as a matter of
* a get opposed to a copy, the data is not safe if the host is
* being altered from another thread.
*
* Parameters:
*
* theHost:
* The CFHostRef which contains the relevant information. Must be
* non-NULL. If this reference is not a valid CFHostRef, the
* behavior is undefined.
*
* hasBeenResolved:
* A reference to a Boolean which returns FALSE if the information
* was not available (e.g. CFHostStartInfoResolution has not been
* called), otherwise TRUE will be returned. Can be NULL.
*
*/
CFN_EXPORT __nullable CFDataRef
CFHostGetReachability(CFHostRef theHost, Boolean * __nullable hasBeenResolved) API_DEPRECATED("Use Network framework instead, see deprecation notice in <CFNetwork/CFHost.h>", macos(10.3, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFHostCancelInfoResolution()
*
* Discussion:
* Cancels an outstanding asynchronous or synchronous resolve.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* theHost:
* The CFHostRef which is currently resolving. Must be non-NULL.
* If this reference is not a valid CFHostRef, the behavior is
* undefined.
*
* info:
* The enum representing which resolution to be canceled. If the
* value is not a valid type, the behavior is undefined.
*
*/
CFN_EXPORT void
CFHostCancelInfoResolution(CFHostRef theHost, CFHostInfoType info) API_DEPRECATED("Use Network framework instead, see deprecation notice in <CFNetwork/CFHost.h>", macos(10.3, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFHostSetClient()
*
* Discussion:
* Associates a client context and callback function with a CFHostRef.
* This is required for asynchronous usage. If not set, resolve will
* take place synchronously.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* theHost:
* The CFHostRef which is getting a client. Must be non-NULL. If
* this reference is not a valid CFHostRef, the behavior is
* undefined.
*
* clientCB:
* A CFHostClientCallBack which will be called when the resolve
* completes or is cancelled. Use NULL to remove the client
* association with a host object.
*
* clientContext:
* A CFHostClientContext which is used to set the contextual
* information associated with the host object. The info pointer
* from the struct will be passed to the callback function. If
* setting a client, this value must be non-NULL.
*
* Result:
* Returns TRUE if the procedure was a success, otherwise it returns
* FALSE.
*
*/
CFN_EXPORT Boolean
CFHostSetClient(CFHostRef theHost, CFHostClientCallBack __nullable clientCB, CFHostClientContext * __nullable clientContext) API_DEPRECATED("Use Network framework instead, see deprecation notice in <CFNetwork/CFHost.h>", macos(10.3, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFHostScheduleWithRunLoop()
*
* Discussion:
* Schedules the given host on a run loop and mode so the client
* will receive its callbacks on that loop and mode.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* theHost:
* The CFHostRef which is being scheduled. Must be non-NULL. If
* this reference is not a valid CFHostRef, the behavior is
* undefined.
*
* runLoop:
* A CFRunLoopRef on which the host should be scheduled. Must be
* non-NULL. If this reference is not a valid CFRunLoopRef, the
* behavior is undefined.
*
* runLoopMode:
* A CFStringRef which is the mode in which the run loop will be
* running when notification occurs. Must be non-NULL. If this
* reference is not a valid CFStringRef, the behavior is undefined.
*
*/
CFN_EXPORT void
CFHostScheduleWithRunLoop(CFHostRef theHost, CFRunLoopRef runLoop, CFStringRef runLoopMode) API_DEPRECATED("Use Network framework instead, see deprecation notice in <CFNetwork/CFHost.h>", macos(10.3, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFHostUnscheduleFromRunLoop()
*
* Discussion:
* Unschedules the given host from a run loop and mode so the client
* will not receive its callbacks on that loop and mode.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* theHost:
* The CFHostRef which is being unscheduled. Must be non-NULL. If
* this reference is not a valid CFHostRef, the behavior is
* undefined.
*
* runLoop:
* A CFRunLoopRef on which the host is scheduled and should now be
* unscheduled. Must be non-NULL. If this reference is not a
* valid CFRunLoopRef, the behavior is undefined.
*
* runLoopMode:
* A CFStringRef which is the mode in which the host is scheduled
* and should be unscheduled. Must be non-NULL. If this reference
* is not a valid CFStringRef, the behavior is undefined.
*
*/
CFN_EXPORT void
CFHostUnscheduleFromRunLoop(CFHostRef theHost, CFRunLoopRef runLoop, CFStringRef runLoopMode) API_DEPRECATED("Use Network framework instead, see deprecation notice in <CFNetwork/CFHost.h>", macos(10.3, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
#pragma pack(pop)
CF_ASSUME_NONNULL_END
CF_EXTERN_C_END
#endif /* __CFHOST__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CFNetwork.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CFNetwork.framework/Headers/CFHTTPStream.h | /*
File: CFNetwork/CFHTTPStream.h
Contains: CoreFoundation Network HTTP streams header
Copyright: Copyright (c) 2001-2013 Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __CFHTTPSTREAM__
#define __CFHTTPSTREAM__
#ifndef __CFNETWORKDEFS__
#include <CFNetwork/CFNetworkDefs.h>
#endif
#ifndef __CFSTREAM__
#include <CoreFoundation/CFStream.h>
#endif
#ifndef __CFHTTPMESSAGE__
#include <CFNetwork/CFHTTPMessage.h>
#endif
#if PRAGMA_ONCE
#pragma once
#endif
CF_EXTERN_C_BEGIN
CF_ASSUME_NONNULL_BEGIN
#if PRAGMA_ENUM_ALWAYSINT
#pragma enumsalwaysint on
#endif
/*
* kCFStreamErrorDomainHTTP
*
* Discussion:
* Result code returned by HTTP server
*
*/
CFN_EXPORT const SInt32 kCFStreamErrorDomainHTTP CF_AVAILABLE(10_1, 2_0);
/*
* CFStreamErrorHTTP
*
* Discussion:
* Errors from the kCFStreamErrorDomainHTTP domain.
*/
typedef CF_ENUM(int, CFStreamErrorHTTP) {
/*
* Could not parse the request/response.
*/
kCFStreamErrorHTTPParseFailure = -1,
/*
* A loop was detected during redirection.
*/
kCFStreamErrorHTTPRedirectionLoop = -2,
/*
* Could not retreive url for request/response.
*/
kCFStreamErrorHTTPBadURL = -3
};
/*
* kCFStreamPropertyHTTPResponseHeader
*
* Discussion:
* Stream property key, for copy operations. Value is a
* CFHTTPMessage with 0 bytes data.
*
*/
CFN_EXPORT const CFStringRef kCFStreamPropertyHTTPResponseHeader CF_DEPRECATED(10_1, 10_11, 2_0, 9_0, "Use NSURLSession API for http requests");
/*
* kCFStreamPropertyHTTPFinalURL *** DEPRECATED ***
*
* Discussion:
* Stream property key, for copy operations. The response header
* value is the CFURL from the final request; will only differ from
* the URL in the original request if an autoredirection has
* occurred.
*
*/
CFN_EXPORT const CFStringRef kCFStreamPropertyHTTPFinalURL CF_DEPRECATED(10_2, 10_11, 2_0, 9_0, "Use NSURLSession API for http requests");
/*
* kCFStreamPropertyHTTPFinalRequest *** DEPRECATED ***
*
* Discussion:
* Stream property key, for copy operations. The value is the
* CFHTTPMessage transmitted by the stream, after all modifications
* (such as for authentication, connection policy, or redirection)
* have been made.
*
*/
CFN_EXPORT const CFStringRef kCFStreamPropertyHTTPFinalRequest CF_DEPRECATED(10_5, 10_11, 2_0, 9_0, "Use NSURLSession API for http requests");
/*
* kCFStreamPropertyHTTPProxy *** DEPRECATED ***
*
* Discussion:
* Stream property key, for both set and copy operations. The value
* is a CFDictionary. HTTP proxy information is set the same way as
* SOCKS proxies (see CFSocketStream.h). Call
* CFReadStreamSetProperty() passing an HTTP stream and the property
* kCFStreamPropertyHTTPProxy. The value should include at least one
* Host/Port pair from the keys below. Use the dictionary returned
* by SystemConfiguration.framework to set the default values for
* the system. HTTP proxies are not applied automatically.
*
*/
CFN_EXPORT const CFStringRef kCFStreamPropertyHTTPProxy CF_DEPRECATED(10_2, 10_11, 2_0, 9_0, "Use NSURLSession API for http requests");
/*
* kCFStreamPropertyHTTPProxyHost *** DEPRECATED ***
*
* Discussion:
* Proxy dictionary key. The hostname of an HTTP proxy. The value is
* a CFString. The key name matches kSCPropNetProxiesHTTPProxy.
*
*/
CFN_EXPORT const CFStringRef kCFStreamPropertyHTTPProxyHost CF_DEPRECATED(10_2, 10_11, 2_0, 9_0, "Use NSURLSession API for http requests");
/*
* kCFStreamPropertyHTTPProxyPort *** DEPRECATED ***
*
* Discussion:
* Proxy dictionary key. Value is a CFNumber.
*
*/
CFN_EXPORT const CFStringRef kCFStreamPropertyHTTPProxyPort CF_DEPRECATED(10_2, 10_11, 2_0, 9_0, "Use NSURLSession API for http requests");
/* matches kSCPropNetProxiesHTTPPort */
/*
* kCFStreamPropertyHTTPSProxyHost *** DEPRECATED ***
*
* Discussion:
* Proxy dictionary key. Value is a CFString.
*
*/
CFN_EXPORT const CFStringRef kCFStreamPropertyHTTPSProxyHost CF_DEPRECATED(10_2, 10_11, 2_0, 9_0, "Use NSURLSession API for http requests");
/* matches kSCPropNetProxiesHTTPSProxy */
/*
* kCFStreamPropertyHTTPSProxyPort *** DEPRECATED ***
*
* Discussion:
* Proxy dictionary key. Value is a CFNumber.
*
*/
CFN_EXPORT const CFStringRef kCFStreamPropertyHTTPSProxyPort CF_DEPRECATED(10_2, 10_11, 2_0, 9_0, "Use NSURLSession API for http requests");
/* matches kSCPropNetProxiesHTTPSPort */
/*
* kCFStreamPropertyHTTPShouldAutoredirect *** DEPRECATED ***
*
* Discussion:
* Stream property key. Value is a CFBoolean. Redirection is not
* performed by default.
*
*/
CFN_EXPORT const CFStringRef kCFStreamPropertyHTTPShouldAutoredirect CF_DEPRECATED(10_2, 10_11, 2_0, 9_0, "Use NSURLSession API for http requests");
/*
* kCFStreamPropertyHTTPAttemptPersistentConnection *** DEPRECATED ***
*
* Discussion:
* Stream property key. Value is a CFBoolean. If this property is
* set to kCFBooleanTrue, an HTTP stream will look for an
* appropriate extant persistent connection to use, and if it finds
* none, will try to create one. Persistent connections are not used
* by default.
*
*/
CFN_EXPORT const CFStringRef kCFStreamPropertyHTTPAttemptPersistentConnection CF_DEPRECATED(10_2, 10_11, 2_0, 9_0, "Use NSURLSession API for http requests");
/*
* kCFStreamPropertyHTTPRequestBytesWrittenCount *** DEPRECATED ***
*
* Discussion:
* Stream property key. Value is a CFNumber. This property can only
* be retrieved, not set. The number returned is the number of bytes
* from the body of the request that have been written to the
* underlying socket
*
*/
CFN_EXPORT const CFStringRef kCFStreamPropertyHTTPRequestBytesWrittenCount CF_DEPRECATED(10_3, 10_11, 2_0, 9_0, "Use NSURLSession API for http requests");
/*********************/
/* Creation routines */
/*********************/
/*
* CFReadStreamCreateForHTTPRequest() *** DEPRECATED ***
*
* DEPRECATED: Use NSURLSession API for http requests
*
* Discussion:
* Create an HTTP read stream for the response to the given request.
* When the stream is opened, it will begin transmitting the
* request. The bytes returned are the pure body bytes; the response
* header has been parsed off. To retrieve the response header, ask
* for kCFStreamPropertyHTTPResponseHeader, above, any time after
* the first bytes arrive on the stream (or when stream end is
* reported, if there are no data bytes). When an HTTP/1.1 server
* returns a chunked a response, the chunks will be formed into one
* continuous stream.
*
* Parameters:
*
* alloc:
* A pointer to the CFAllocator which should be used to allocate
* memory for the CF read stream and its storage for values. If
* this reference is not a valid CFAllocator, the behavior is
* undefined.
*
* request:
* A pointer to a CFHTTPMessage created by the
* CFHTTPMessageCreateRequest function.
*
* Result:
* A pointer to the CF read stream created, or NULL if failed. It is
* caller's responsibilty to release the memory allocated for the
* read stream.
*
*/
CFN_EXPORT CFReadStreamRef
CFReadStreamCreateForHTTPRequest(CFAllocatorRef __nullable alloc, CFHTTPMessageRef request) CF_DEPRECATED(10_2, 10_11, 2_0, 9_0, "Use NSURLSession API for http requests");
/*
* CFReadStreamCreateForStreamedHTTPRequest() *** DEPRECATED ***
*
* DEPRECATED: Use NSURLSession API for http requests
*
* Discussion:
* Creates a read stream for the response to the given
* requestHeaders plus requestBody. Use in preference to
* CFReadStreamCreateForHTTPRequest() when the body of the request
* is larger than you wish to be resident in memory. Note that
* because streams cannot be reset, read streams created this way
* cannot have autoredirection enabled. If the Content-Length
* header is set in requestHeaders, it is assumed that the caller
* got the length right and that requestBody will report
* end-of-stream after precisely Content-Length bytes have been read
* from it. If the Content-Length header is not set, the chunked
* transfer-encoding will be added to requestHeaders, and bytes read
* from requestBody will be transmitted chunked. The body of
* requestHeaders is ignored.
*
* Parameters:
*
* alloc:
* A pointer to the CFAllocator which should be used to allocate
* memory for the CF read stream and its storage for values. If
* this reference is not a valid CFAllocator, the behavior is
* undefined.
*
* requestHeaders:
* A pointer to a CFHTTPMessage created by the
* CFHTTPMessageCreateRequest function. The body of requestHeaders
* is ignored.
*
* requestBody:
* A pointer to a CFReadStream.
*
* Result:
* A pointer to the CF read stream created, or NULL if failed. It is
* caller's responsibilty to release the memory allocated for the
* read stream.
*
*/
CFN_EXPORT CFReadStreamRef
CFReadStreamCreateForStreamedHTTPRequest(CFAllocatorRef __nullable alloc, CFHTTPMessageRef requestHeaders, CFReadStreamRef requestBody) CF_DEPRECATED(10_2, 10_11, 2_0, 9_0, "Use NSURLSession API for http requests");
#if PRAGMA_ENUM_ALWAYSINT
#pragma enumsalwaysint reset
#endif
CF_ASSUME_NONNULL_END
CF_EXTERN_C_END
#endif /* __CFHTTPSTREAM__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CFNetwork.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CFNetwork.framework/Headers/CFNetServices.h | /*
File: CFNetwork/CFNetServices.h
Contains: CoreFoundation Network Net Services header
Copyright: Copyright (c) 2001-2013 Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __CFNETSERVICES__
#define __CFNETSERVICES__
#ifndef __CFNETWORKDEFS__
#include <CFNetwork/CFNetworkDefs.h>
#endif
#ifndef __CFBASE__
#include <CoreFoundation/CFBase.h>
#endif
#ifndef __CFSTREAM__
#include <CoreFoundation/CFStream.h>
#endif
#if PRAGMA_ONCE
#pragma once
#endif
CF_EXTERN_C_BEGIN
CF_ASSUME_NONNULL_BEGIN
#pragma pack(push, 2)
/*
* CFNetServiceRef
*
* Discussion:
* This is the type of a reference to a service. It may be used for
* registering or for resolving.
*/
typedef struct __CFNetService* CFNetServiceRef;
/*
* CFNetServiceMonitorRef
*
* Discussion:
* This is the type of a reference to a service monitor. It may be
* used for watching record changes on a CFNetServiceRef.
*/
typedef struct __CFNetServiceMonitor* CFNetServiceMonitorRef;
/*
* CFNetServiceBrowserRef
*
* Discussion:
* This is the type of a reference to a service or domain browser.
* It may be used for discovering services or domains.
*/
typedef struct __CFNetServiceBrowser* CFNetServiceBrowserRef;
#ifdef __MACH__
/*
* kCFStreamErrorDomainMach
*
* Discussion:
* Errors reported by mach. See <mach/error.h>
*
*/
CFN_EXPORT const SInt32 kCFStreamErrorDomainMach CF_AVAILABLE(10_2, 2_0);
#endif /* defined(__MACH__) */
/*
* kCFStreamErrorDomainNetServices
*
* Discussion:
* Errors listed below or reported by the Service Discovery API's.
* See <dns_sd.h>. The Service Discovery errors will only be
* returned when using the new, Mac OS X 10.4-based API's or
* CFNetServiceBrowser.
*
*/
CFN_EXPORT const SInt32 kCFStreamErrorDomainNetServices CF_AVAILABLE(10_2, 2_0);
/*
* CFNetServicesError
*
* Discussion:
* Errors from the kCFStreamErrorDomainNetServices domain.
*/
typedef CF_ENUM(int, CFNetServicesError) {
/*
* An error of unknown type has occured.
*/
kCFNetServicesErrorUnknown = -72000L,
/*
* The given registration has had a name collision. Registration
* should be cancelled and should try again probably with a different
* name.
*/
kCFNetServicesErrorCollision = -72001L,
/*
* Not used
*/
kCFNetServicesErrorNotFound = -72002L,
/*
* There is already a register, resolve, browse, or monitor in
* progress on the given object.
*/
kCFNetServicesErrorInProgress = -72003L,
/*
* Not used
*/
kCFNetServicesErrorBadArgument = -72004L,
/*
* The register, resolve, or browse on the object has been cancelled.
*/
kCFNetServicesErrorCancel = -72005L,
/*
* The given CFNetServiceBrowser or CFNetServiceMonitor has already
* been invalidated and can no longer be used.
*/
kCFNetServicesErrorInvalid = -72006L,
/*
* The given CFNetServiceResolveWithTimeout has hit the timeout
* before a successful resolve.
*/
kCFNetServicesErrorTimeout = -72007L,
/*
* Missing required configuration for local network access.
*/
kCFNetServicesErrorMissingRequiredConfiguration API_AVAILABLE(macos(11.0), ios(14.0), tvos(14.0)) API_UNAVAILABLE(watchos) = -72008L,
};
/*
* CFNetServiceMonitorType
*
* Discussion:
* Record type specifier in order to inform CFNetServiceMonitor to
* watch for certain record changes.
*/
typedef CF_ENUM(int, CFNetServiceMonitorType) {
/*
* Watch for TXT record changes.
*/
kCFNetServiceMonitorTXT = 1
};
/*
* CFNetService flags
*
* Discussion:
* Bit flags to be used for registration of a service with CFNetServiceRegisterWithOptions.
*/
typedef CF_OPTIONS(CFOptionFlags, CFNetServiceRegisterFlags) {
/*
* Indicate that registration should not auto-rename the service to prevent name conflicts.
*/
kCFNetServiceFlagNoAutoRename = 1
};
/*
* CFNetServiceBrowser flags
*
* Discussion:
* Result bit flags passed to CFNetServiceBrowserClientCallBack.
*/
typedef CF_OPTIONS(CFOptionFlags, CFNetServiceBrowserFlags) {
/*
* Client will get another callback briefly and shouldn't do costly screen updates (or such).
*/
kCFNetServiceFlagMoreComing = 1,
/*
* If off, the result is a service.
*/
kCFNetServiceFlagIsDomain = 2,
/*
* The result domain is the default domain for the given domain browse type (registration or browse).
*/
kCFNetServiceFlagIsDefault = 4,
/*
* Same as the previous but incorrectly named. Kept for compatibility.
*/
kCFNetServiceFlagIsRegistrationDomain CF_ENUM_DEPRECATED(10_2, 10_4, 2_0, 2_0) = 4,
/*
* The result item should be removed and not added.
*/
kCFNetServiceFlagRemove = 8
};
/*
* CFNetServiceClientContext
*
* Discussion:
* Structure containing the user-defined data and callbacks for
* CFNetService and CFNetServiceBrowser objects.
*/
struct CFNetServiceClientContext {
/*
* The version number of the structure type being passed in as a
* parameter to the CFNetService, Browser, or Monitor client
* function. The current version number is 0.
*/
CFIndex version;
/*
* An arbitrary pointer to client-defined data, which can be
* associated with the service/browser and is passed to the callbacks.
*/
void * __nullable info;
/*
* The callback used to add a retain for the service/browser on the
* info pointer for the life of the service/browser, and may be used
* for temporary references the service/browser needs to take. This
* callback returns the actual info pointer to store in the
* service/browser, almost always just the pointer passed as the
* parameter.
*/
CFAllocatorRetainCallBack __nullable retain;
/*
* The callback used to remove a retain previously added for the
* service/browser on the info pointer.
*/
CFAllocatorReleaseCallBack __nullable release;
/*
* The callback used to create a descriptive string representation of
* the info pointer (or the data pointed to by the info pointer) for
* debugging purposes. This is used by the CFCopyDescription()
* function.
*/
CFAllocatorCopyDescriptionCallBack __nullable copyDescription;
};
typedef struct CFNetServiceClientContext CFNetServiceClientContext;
/*
* CFNetServiceClientCallBack
*
* Discussion:
* Callback function which is called upon error or completion of
* resolve or register. If resolving with the deprecated API's, the
* callback may be called multiple times, once for each resolved
* address.
*
* Parameters:
*
* theService:
* Service receiving the event.
*
* error:
* Reference to an error structure if the event is a failure.
*
* info:
* Client's info reference which was passed into the client
* context.
*/
typedef CALLBACK_API_C( void , CFNetServiceClientCallBack )(CFNetServiceRef theService, CFStreamError * __nullable error, void * __nullable info);
/*
* CFNetServiceMonitorClientCallBack
*
* Discussion:
* Callback function which is called as the monitored record changes.
*
* Parameters:
*
* theMonitor:
* CFNetServiceMonitor receiving the event.
*
* theService:
* Service receiving the event.
*
* typeInfo:
* The information type which changed.
*
* rdata:
* The contents of the record that changed.
*
* error:
* Reference to an error structure if the event is a failure.
*
* info:
* Client's info reference which was passed into the client
* context.
*/
typedef CALLBACK_API_C( void , CFNetServiceMonitorClientCallBack )(CFNetServiceMonitorRef theMonitor, CFNetServiceRef __nullable theService, CFNetServiceMonitorType typeInfo, CFDataRef __nullable rdata, CFStreamError * __nullable error, void * __nullable info);
/*
* CFNetServiceBrowserClientCallBack
*
* Discussion:
* Callback function which is called upon error or upon successful
* discovery of services or domains.
*
* Parameters:
*
* browser:
* CFNetServiceBrowser receiving the event.
*
* flags:
* Bitwise flags indicating the event or further information about
* the event.
*
* domainOrService:
* If searching for domains, a CFStringRef indicating the domain
* which was found or is going away. If searching for services,
* the service which was found or is going away.
*
* error:
* Reference to an error structure if the event is a failure.
*
* info:
* Client's info reference which was passed into the client
* context.
*/
typedef CALLBACK_API_C( void , CFNetServiceBrowserClientCallBack )(CFNetServiceBrowserRef browser, CFOptionFlags flags, CFTypeRef __nullable domainOrService, CFStreamError * __nullable error, void * __nullable info);
/*
* CFNetServiceGetTypeID()
*
* Discussion:
* Returns the type identifier of all CFNetService instances.
*
* Mac OS X threading:
* Thread safe
*
*/
CFN_EXPORT CFTypeID
CFNetServiceGetTypeID(void) API_DEPRECATED("Use nw_browser_t or nw_listener_t in Network framework instead", macos(10.2, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFNetServiceMonitorGetTypeID()
*
* Discussion:
* Returns the type identifier of all CFNetServiceMonitor instances.
*
* Mac OS X threading:
* Thread safe
*
*/
CFN_EXPORT CFTypeID
CFNetServiceMonitorGetTypeID(void) API_DEPRECATED("Use nw_browser_t or nw_listener_t in Network framework instead", macos(10.4, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFNetServiceBrowserGetTypeID()
*
* Discussion:
* Returns the type identifier of all CFNetServiceBrowser instances.
*
* Mac OS X threading:
* Thread safe
*
*/
CFN_EXPORT CFTypeID
CFNetServiceBrowserGetTypeID(void) API_DEPRECATED("Use nw_browser_t or nw_listener_t in Network framework instead", macos(10.2, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFNetServiceCreate()
*
* Discussion:
* Creates an instance of a Network Service.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* alloc:
* The CFAllocator which should be used to allocate memory for the
* service and its storage for values. If this reference is not a
* valid CFAllocator, the behavior is undefined.
*
* domain:
* The network domain in which it is registered or will be
* registered. This value must be non-NULL.
*
* serviceType:
* The type of service being registered or resolved on the
* network. The service type consists of the application protocol
* name followed by the transport protocol name, separated by a
* dot (e.g. "_ftp._tcp"). The application protocol name should
* be 14 characters or less, and should only contain lower-case
* letters, digits, and hyphens. New service types should be
* registered at <htp://www.dns-sd.org/ServiceTypes.html>. This
* value must be non-NULL.
*
* name:
* The name of the machine or application advertising the service.
* If this value is not unique, registering will eventually fail.
* This value must be non-NULL. This value is usually displayed
* in a browser for the user.
*
* port:
* The port on which the service is listening. This must be
* non-zero for services which are to be registered.
*
* Result:
* A valid CFNetService which may now be registered or resolved, or
* NULL if unsuccessful.
*
*/
CFN_EXPORT CFNetServiceRef
CFNetServiceCreate(CFAllocatorRef __nullable alloc, CFStringRef domain, CFStringRef serviceType, CFStringRef name, SInt32 port) API_DEPRECATED("Use nw_browser_t or nw_listener_t in Network framework instead", macos(10.2, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFNetServiceCreateCopy()
*
* Discussion:
* Creates a new CFNetService object as a copy of service argument.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* alloc:
* The CFAllocator which should be used to allocate memory for the
* new service. If this reference is not a valid CFAllocator, the
* behavior is undefined.
*
* service:
* A CFNetServiceRef representing the original service. Must be
* non-NULL. If this If this reference is not a valid
* CFNetServiceRef, the behavior is undefined.
*
* Result:
* Returns a valid CFNetServiceRef which contains a copy of all
* previously resolved data from the original. NULL is returned in
* the case of failure.
*
*/
CFN_EXPORT CFNetServiceRef
CFNetServiceCreateCopy(CFAllocatorRef __nullable alloc, CFNetServiceRef service) API_DEPRECATED("Use nw_browser_t or nw_listener_t in Network framework instead", macos(10.3, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFNetServiceGetDomain()
*
* Discussion:
* Query a Network Service for its domain.
*
* Mac OS X threading:
* Thread safe
* The function gets the data in a thread-safe manner, but the
* resulting data is not safe. Since it is returned as a matter of
* a get opposed to a copy, the data is not safe if the service is
* being altered from another thread.
*
* Parameters:
*
* theService:
* The Network Service to be queried. Must be non-NULL.
*
* Result:
* CFStringRef which is the service's domain.
*
*/
CFN_EXPORT CFStringRef
CFNetServiceGetDomain(CFNetServiceRef theService) API_DEPRECATED("Use nw_browser_t or nw_listener_t in Network framework instead", macos(10.2, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFNetServiceGetType()
*
* Discussion:
* Query a Network Service for its type.
*
* Mac OS X threading:
* Thread safe
* The function gets the data in a thread-safe manner, but the
* resulting data is not safe. Since it is returned as a matter of
* a get opposed to a copy, the data is not safe if the service is
* being altered from another thread.
*
* Parameters:
*
* theService:
* The Network Service to be queried. Must be non-NULL.
*
* Result:
* CFStringRef which is the service's service type.
*
*/
CFN_EXPORT CFStringRef
CFNetServiceGetType(CFNetServiceRef theService) API_DEPRECATED("Use nw_browser_t or nw_listener_t in Network framework instead", macos(10.2, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFNetServiceGetName()
*
* Discussion:
* Query a Network Service for its name.
*
* Mac OS X threading:
* Thread safe
* The function gets the data in a thread-safe manner, but the
* resulting data is not safe. Since it is returned as a matter of
* a get opposed to a copy, the data is not safe if the service is
* being altered from another thread.
*
* Parameters:
*
* theService:
* The Network Service to be queried. Must be non-NULL.
*
* Result:
* CFStringRef which is the service's name.
*
*/
CFN_EXPORT CFStringRef
CFNetServiceGetName(CFNetServiceRef theService) API_DEPRECATED("Use nw_browser_t or nw_listener_t in Network framework instead", macos(10.2, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFNetServiceRegisterWithOptions()
*
* Discussion:
* Registers the entity on the network. This requires that the
* service has a domain, a type, a name, and a port. The service is
* registered on the network until this function returns or is
* cancelled by calling CFNetServiceCancel. In synchronous mode,
* this function will block until there is an error or it is
* cancelled from another thread. In asynchronous mode, this
* function returns immediately and the underlying network
* registration process will start.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* theService:
* The Network Service to register on the network. Must be
* non-NULL.
*
* options:
* A set of bit options used to instruct the registration process.
* Current supported option is kCFNetServiceFlagNoAutoRename.
*
* error:
* A reference to an error struct which will be set to the error
* and domain of the error should one occur. If the value of
* error is not desired, set to NULL.
*
* Result:
* Returns FALSE if domain, type, name or port is NULL. In
* synchronous mode, it will always return FALSE as a result of the
* error or the cancellation. In asynchronous mode, it will return
* TRUE if the registration process could start.
*
*/
CFN_EXPORT Boolean
CFNetServiceRegisterWithOptions(CFNetServiceRef theService, CFOptionFlags options, CFStreamError * __nullable error) API_DEPRECATED("Use nw_browser_t or nw_listener_t in Network framework instead", macos(10.4, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFNetServiceResolveWithTimeout()
*
* Discussion:
* Resolves the information related to this service. It will
* resolve the target host, the addresses, and the first TXT record
* associated with the service.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* theService:
* The CFNetServiceRef which should be resolved. Must be non-NULL.
* If this reference is not a valid CFNetServiceRef, the behavior
* is undefined.
*
* timeout:
* CFTimeInterval representing the maximum amount of time to take
* to perform the resolve. If the resolve can not be performed
* within this timeout, the function or callback will recieve a
* timeout error. Values less than or equal to zero indicate an
* infinite timeout.
*
* error:
* A reference to a CFStreamError structure which will be filled
* with any error information should an error occur. May be set
* to NULL if error information is not wanted.
*
* Result:
* Returns TRUE on success and FALSE on failure. In asynchronous
* mode, this function will return immediately. In synchronous
* mode, it will block until the resolve has completed or until the
* resolve is cancelled.
*
*/
CFN_EXPORT Boolean
CFNetServiceResolveWithTimeout(CFNetServiceRef theService, CFTimeInterval timeout, CFStreamError * __nullable error) API_DEPRECATED("Use nw_browser_t or nw_listener_t in Network framework instead", macos(10.4, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFNetServiceCancel()
*
* Discussion:
* Cancels an outstanding request for registration or resolution.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* theService:
* The Network Service which is active. Must be non-NULL.
*
*/
CFN_EXPORT void
CFNetServiceCancel(CFNetServiceRef theService) API_DEPRECATED("Use nw_browser_t or nw_listener_t in Network framework instead", macos(10.2, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFNetServiceGetTargetHost()
*
* Discussion:
* Query a Network Service for its resolve target.
*
* Mac OS X threading:
* Thread safe
* The function gets the data in a thread-safe manner, but the
* resulting data is not safe. Since it is returned as a matter of
* a get opposed to a copy, the data is not safe if the service is
* being altered from another thread.
*
* Parameters:
*
* theService:
* The Network Service to be queried. Must be non-NULL.
*
* Result:
* Returns The target hostname of the machine providing the service,
* or NULL if the entity's target is not known (has not been
* resolved).
*
*/
CFN_EXPORT __nullable CFStringRef
CFNetServiceGetTargetHost(CFNetServiceRef theService) API_DEPRECATED("Use nw_browser_t or nw_listener_t in Network framework instead", macos(10.4, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFNetServiceGetPortNumber()
*
* Discussion:
* Query a Network Service for its port number.
*
* Mac OS X threading:
* Thread safe
* The function gets the data in a thread-safe manner.
*
* Parameters:
*
* theService:
* The Network Service to be queried. Must be non-NULL.
*
* Result:
* Returns a SInt32 containing the port number in host byte order.
* Returns -1 if the entity's port is not known (has not been
* resolved)
*
*/
CFN_EXPORT SInt32
CFNetServiceGetPortNumber(CFNetServiceRef theService) API_DEPRECATED("Use nw_browser_t or nw_listener_t in Network framework instead", macos(10.5, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFNetServiceGetAddressing()
*
* Discussion:
* Query a Network Service for its addressing.
*
* Mac OS X threading:
* Thread safe
* The function gets the data in a thread-safe manner, but the
* resulting data is not safe. Since it is returned as a matter of
* a get opposed to a copy, the data is not safe if the service is
* being altered from another thread.
*
* Parameters:
*
* theService:
* The Network Service to be queried. Must be non-NULL.
*
* Result:
* Returns NULL if the entity's addressing is not known (has not
* been resolved). The array will contain a CFDataRef for each
* address resolved. Each CFDataRef contains a struct sockaddr
* representing the address of the service.
*
*/
CFN_EXPORT __nullable CFArrayRef
CFNetServiceGetAddressing(CFNetServiceRef theService) API_DEPRECATED("Use nw_browser_t or nw_listener_t in Network framework instead", macos(10.2, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFNetServiceGetTXTData()
*
* Discussion:
* Query a Network Service for its TXT record contents.
*
* Mac OS X threading:
* Thread safe
* The function gets the data in a thread-safe manner, but the
* resulting data is not safe. Since it is returned as a matter of
* a get opposed to a copy, the data is not safe if the service is
* being altered from another thread.
*
* Parameters:
*
* theService:
* The Network Service to be queried. Must be non-NULL.
*
* Result:
* Returns NULL if the entity's TXT is not known (has not been
* resolved). The result will contain the contents of the TXT
* record. This is suitable to pass to
* CFNetServiceCreateDictionaryWithTXTData.
*
*/
CFN_EXPORT __nullable CFDataRef
CFNetServiceGetTXTData(CFNetServiceRef theService) API_DEPRECATED("Use nw_browser_t or nw_listener_t in Network framework instead", macos(10.4, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFNetServiceSetTXTData()
*
* Discussion:
* Sets the TXT record for the service. If the service is currently
* registered on the network, the record will be broadcast. Setting
* the TXT record on a resolving service is not allowed.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* theService:
* The Network Service to receive the new record. Must be
* non-NULL.
*
* txtRecord:
* The contents of the TXT record. This should not exceed a
* length of 1450 bytes.
*
*/
CFN_EXPORT Boolean
CFNetServiceSetTXTData(CFNetServiceRef theService, CFDataRef txtRecord) API_DEPRECATED("Use nw_browser_t or nw_listener_t in Network framework instead", macos(10.4, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFNetServiceCreateDictionaryWithTXTData()
*
* Discussion:
* Parses the given TXT record data into a set of key/value pairs as
* a CFDictionary where keys are CFStringRefs and values are
* CFDataRefs. If the given record can not be parsed, NULL will be
* returned. READ THE COMMENTS FOR
* CFNetServiceCreateTXTDataWithDictionary TO FULLY UNDERSTAND THE
* USE AND RESULTS OF THIS FUNCTION.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* alloc:
* CFAllocatorRef to be used for the creation of the result.
*
* txtRecord:
* The TXT record data as returned by CFNetServiceGetInfo.
*
* Result:
* CFDictionaryRef containing the key/value pairs parsed from the
* record. It will return NULL if the record could not be parsed.
* Keys in the dictionary are CFStringRef's. Values are CFDataRef's.
*
*/
CFN_EXPORT __nullable CFDictionaryRef
CFNetServiceCreateDictionaryWithTXTData(CFAllocatorRef __nullable alloc, CFDataRef txtRecord) API_DEPRECATED("Use nw_browser_t or nw_listener_t in Network framework instead", macos(10.4, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFNetServiceCreateTXTDataWithDictionary()
*
* Discussion:
* Flattens a set of key/value pairs into a CFDataRef suitable to
* pass into CFNetServiceSetTXTData. This function will properly
* format the data for TXT record usage. THIS IS NOT A GENERAL
* CFDictionaryRef FLATTENING ROUTINE. CFDictionaryRef keys should
* be CFStringRef's and values should be CFDataRef's. For
* convenience, values that are CFStringRef's will be converted to
* CFDataRef's representing the flattened UTF-8 bytes of the string.
* The types of the values are not encoded in the CFDataRef's,
* therefore CFStringRef's will be flattened into CFDataRef's, and
* they will come out of CFNetServiceCreateDictionaryWithTXTData as
* CFDataRef's.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* alloc:
* CFAllocatorRef to be used for the creation of the result.
*
* keyValuePairs:
* CFDictionaryRef containing keys and values to be placed into
* the TXT record. The keys must be CFStringRef's. The values
* should be CFDataRef's (CFStringRef's are permitted for
* convenience). Any other types will cause a failure. The
* length of a key and its value should not exceed 255.
*
* Result:
* CFDataRef containing the flattened form of the keys and values.
* If the dictionary could not be flattend, NULL will be returned.
*
*/
CFN_EXPORT __nullable CFDataRef
CFNetServiceCreateTXTDataWithDictionary(CFAllocatorRef __nullable alloc, CFDictionaryRef keyValuePairs) API_DEPRECATED("Use nw_browser_t or nw_listener_t in Network framework instead", macos(10.4, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFNetServiceSetClient()
*
* Discussion:
* Sets up the service to be used in asynchronous mode.
* Notification of registration failure or resolution completion
* will occur through the given callback. Once the client is set,
* the service must be scheduled on a runloop. The client callback
* will be triggered via one of the scheduled run loops; It is the
* caller's responsibility to ensure that at least one of the
* scheduled run loops is being run. This call must be performed
* before calling CFNetServiceRegister or CFNetServiceResolve,
* otherwise it will return FALSE. TRUE will be returned if the
* client could be set.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* theService:
* The service to set up for asynchronous mode. Must be non-NULL.
*
* clientCB:
* Function pointer will be called upon registration failure or
* upon resolution completion. In the case of resolution, this
* callback may be called multiple times if there is more than one
* address for a service. Passing NULL will remove the client
* from the entity and cancel any outstanding activity.
*
* clientContext:
* Client contextual information to be used when calling clientCB.
* Passing NULL will remove the client from the entity and cancel
* any outstanding activity.
*
* Result:
* Returns FALSE if the client could not be set, TRUE otherwise.
*
*/
CFN_EXPORT Boolean
CFNetServiceSetClient(CFNetServiceRef theService, CFNetServiceClientCallBack __nullable clientCB, CFNetServiceClientContext * __nullable clientContext) API_DEPRECATED("Use nw_browser_t or nw_listener_t in Network framework instead", macos(10.2, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFNetServiceScheduleWithRunLoop()
*
* Discussion:
* Schedule the given service on the given run loop and mode.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* theService:
* The service which is set up for asynchronous mode. Must be
* non-NULL.
*
* runLoop:
* A reference to a runloop on which the service should be
* scheduled. Must be non-NULL.
*
* runLoopMode:
* The mode on which to schedule the service. Must be non-NULL.
*
*/
CFN_EXPORT void
CFNetServiceScheduleWithRunLoop(CFNetServiceRef theService, CFRunLoopRef runLoop, CFStringRef runLoopMode) API_DEPRECATED("Use nw_browser_t or nw_listener_t in Network framework instead", macos(10.2, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFNetServiceUnscheduleFromRunLoop()
*
* Discussion:
* Unschedule the given service from the given run loop and mode.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* theService:
* The service which is set up for asynchronous mode. Must be
* non-NULL.
*
* runLoop:
* A reference to a runloop from which the service should be
* unscheduled. Must be non-NULL.
*
* runLoopMode:
* The mode from which to unschedule the service. Must be
* non-NULL.
*
*/
CFN_EXPORT void
CFNetServiceUnscheduleFromRunLoop(CFNetServiceRef theService, CFRunLoopRef runLoop, CFStringRef runLoopMode) API_DEPRECATED("Use nw_browser_t or nw_listener_t in Network framework instead", macos(10.2, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFNetServiceMonitorCreate()
*
* Discussion:
* Creates an instance of an object suitable for watching for
* CFNetService record changes on the network.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* alloc:
* The CFAllocator which should be used to allocate memory for the
* monitor and its storage for values. If this reference is not a
* valid CFAllocator, the behavior is undefined.
*
* theService:
* The CFNetService to be monitored for record changes.
*
* clientCB:
* Function pointer that will be called as record changes occur.
* Must be non-NULL.
*
* clientContext:
* Client contextual information to be used when calling clientCB.
* Must be non-NULL.
*
* Result:
* Returns a new instance of a CFNetServiceMonitor, or NULL if the
* object could not be created.
*
*/
CFN_EXPORT CFNetServiceMonitorRef
CFNetServiceMonitorCreate(
CFAllocatorRef __nullable alloc,
CFNetServiceRef theService,
CFNetServiceMonitorClientCallBack clientCB,
CFNetServiceClientContext * clientContext) API_DEPRECATED("Use nw_browser_t or nw_listener_t in Network framework instead", macos(10.4, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFNetServiceMonitorInvalidate()
*
* Discussion:
* Invalidates the given monitor object so that it may no longer be
* scheduled and callback never be called. This will also stop any
* monitors currently in progress.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* monitor:
* CFNetServiceMonitor to invalidate. Must be non-NULL.
*
*/
CFN_EXPORT void
CFNetServiceMonitorInvalidate(CFNetServiceMonitorRef monitor) API_DEPRECATED("Use nw_browser_t or nw_listener_t in Network framework instead", macos(10.4, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFNetServiceMonitorStart()
*
* Discussion:
* Starts monitoring for record changes on a service. It watches
* for changes of the given record type. If there is already an
* outstanding monitor, it will return FALSE. In synchronous mode,
* this call blocks until the monitor is stopped. It will return
* FALSE if there is an error performing the monitor or if there is
* some other error. It will return TRUE otherwise. In
* asynchronous mode, this call will return TRUE or FALSE depending
* if the underlying network query could be instantiated.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* monitor:
* CFNetServiceMonitor to perform the watch.
*
* recordType:
* CFNetServiceMonitorType indicating the record type to watch.
*
* error:
* A reference to an error struct which will be set to the error
* and domain of the error should one occur. If the value of
* error is not desired, set to NULL.
*
* Result:
* Returns FALSE if an error occurs during a synchronous monitor or
* if the monitor could not start. It returns TRUE otherwise.
*
*/
CFN_EXPORT Boolean
CFNetServiceMonitorStart(CFNetServiceMonitorRef monitor, CFNetServiceMonitorType recordType, CFStreamError * __nullable error) API_DEPRECATED("Use nw_browser_t or nw_listener_t in Network framework instead", macos(10.4, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFNetServiceMonitorStop()
*
* Discussion:
* Stops an outstanding monitor.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* monitor:
* CFNetServiceMonitor with an active monitor. Must be non-NULL.
*
* error:
* Error value to be returned in "error" in
* CFNetServiceMonitorStart if monitor is being performed in
* synchronous mode. In this case, a non-zero of the error field
* of the struct will cause CFNetServiceMonitorStart to return
* FALSE. In asynchronous mode, the client call back will be
* called with this error. Can be NULL.
*
*/
CFN_EXPORT void
CFNetServiceMonitorStop(CFNetServiceMonitorRef monitor, CFStreamError * __nullable error) API_DEPRECATED("Use nw_browser_t or nw_listener_t in Network framework instead", macos(10.4, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFNetServiceMonitorScheduleWithRunLoop()
*
* Discussion:
* Schedules the monitor on a run loop and mode. Use this to place
* the given monitor into asynchronous mode. The client callback
* will be triggered via one of the scheduled run loops; It is the
* caller's responsibility to ensure that at least one of the
* scheduled run loops is being run.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* monitor:
* CFNetServiceMonitor to schedule. Must be non-NULL.
*
* runLoop:
* A reference to a runloop on which the monitor should be
* scheduled. Must be non-NULL.
*
* runLoopMode:
* The mode on which to schedule the monitor. Must be non-NULL.
*
*/
CFN_EXPORT void
CFNetServiceMonitorScheduleWithRunLoop(CFNetServiceMonitorRef monitor, CFRunLoopRef runLoop, CFStringRef runLoopMode) API_DEPRECATED("Use nw_browser_t or nw_listener_t in Network framework instead", macos(10.4, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFNetServiceMonitorUnscheduleFromRunLoop()
*
* Discussion:
* Unschedules the browser from a run loop and mode.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* monitor:
* CFNetServiceMonitor to unschedule. Must be non-NULL.
*
* runLoop:
* A reference to a runloop from which the monitor should be
* unscheduled. Must be non-NULL.
*
* runLoopMode:
* The mode from which to unschedule the monitor. Must be
* non-NULL.
*
*/
CFN_EXPORT void
CFNetServiceMonitorUnscheduleFromRunLoop(CFNetServiceMonitorRef monitor, CFRunLoopRef runLoop, CFStringRef runLoopMode) API_DEPRECATED("Use nw_browser_t or nw_listener_t in Network framework instead", macos(10.4, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFNetServiceBrowserCreate()
*
* Discussion:
* Creates an instance of a browser object.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* alloc:
* The CFAllocator which should be used to allocate memory for the
* browser and its storage for values. If this reference is not a
* valid CFAllocator, the behavior is undefined.
*
* clientCB:
* Function pointer that will be called as domains or services are
* found on the network. Must be non-NULL.
*
* clientContext:
* Client contextual information to be used when calling clientCB.
* Must be non-NULL.
*
* Result:
* Returns a new instance of a browser, or NULL if the instance
* could not be created.
*
*/
CFN_EXPORT CFNetServiceBrowserRef
CFNetServiceBrowserCreate(CFAllocatorRef __nullable alloc, CFNetServiceBrowserClientCallBack clientCB, CFNetServiceClientContext *clientContext) API_DEPRECATED("Use nw_browser_t or nw_listener_t in Network framework instead", macos(10.2, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFNetServiceBrowserInvalidate()
*
* Discussion:
* Invalidates the given browser object so that it may no longer be
* scheduled and callback never be called. This will also stop any
* searches currently in progress.
*
* Parameters:
*
* browser:
* Network Service Browser to invalidate. Must be non-NULL.
*
*/
CFN_EXPORT void
CFNetServiceBrowserInvalidate(CFNetServiceBrowserRef browser) API_DEPRECATED("Use nw_browser_t or nw_listener_t in Network framework instead", macos(10.2, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFNetServiceBrowserSearchForDomains()
*
* Discussion:
* Starts a search for domains. The browser will either try to find
* "Browse" domains or will search for "Registration" domains. If
* there is already an outstanding search, it will return FALSE. In
* syncronous mode, this call blocks until the search is stopped.
* It will return FALSE if there is an error performing the search.
* It will return TRUE otherwise. In asynchronous mode, this call
* will return TRUE or FALSE depending if the underlying network
* search could be started.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* browser:
* Network Service Browser to perform the search. Must be
* non-NULL.
*
* registrationDomains:
* FALSE if "Browse" domains are to be discovered. TRUE if only
* "Registration" domains are to be discovered.
*
* error:
* A reference to an error struct which will be set to the error
* and domain of the error should one occur. If the value of
* error is not desired, set to NULL.
*
* Result:
* Returns FALSE if an error occurs during a synchronous search or
* if the search could not start. It returns TRUE otherwise.
*
*/
CFN_EXPORT Boolean
CFNetServiceBrowserSearchForDomains(CFNetServiceBrowserRef browser, Boolean registrationDomains, CFStreamError * __nullable error) API_DEPRECATED("Use nw_browser_t or nw_listener_t in Network framework instead", macos(10.2, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFNetServiceBrowserSearchForServices()
*
* Discussion:
* Starts a search for a service type on the given domain. If there
* is already an outstanding search, it will return FALSE. In
* syncronous mode, this call blocks until the search is stopped.
* It will return FALSE if there is an error performing the search
* or if there is some other error. It will return TRUE otherwise.
* In asynchronous mode, this call will return TRUE or FALSE
* depending if the underlying network search could be instantiated.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* browser:
* Network Service Browser to perform the search. Must be
* non-NULL.
*
* domain:
* Network domain to search in order to find the service. Must be
* non-NULL.
*
* serviceType:
* Service type for which to search. Must be non-NULL.
*
* error:
* A reference to an error struct which will be set to the error
* and domain of the error should one occur. If the value of
* error is not desired, set to NULL.
*
* Result:
* Returns FALSE if an error occurs during a synchronous search or
* if the search could not start. It returns TRUE otherwise.
*
*/
CFN_EXPORT Boolean
CFNetServiceBrowserSearchForServices(CFNetServiceBrowserRef browser, CFStringRef domain, CFStringRef serviceType, CFStreamError * __nullable error) API_DEPRECATED("Use nw_browser_t or nw_listener_t in Network framework instead", macos(10.2, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFNetServiceBrowserStopSearch()
*
* Discussion:
* Stops an outstanding browser search.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* browser:
* Network Service Browser performing the search. Must be
* non-NULL.
*
* error:
* Error value to be returned in "error" in
* CFNetServiceBrowserStartServiceSearch if search is being
* performed in synchronous mode. In this case, a non-zero of the
* error field of the struct will cause
* CFNetServiceBrowserStartServiceSearch to return FALSE. In
* asynchronous mode, the client call back will be called with
* this error. Can be NULL.
*
*/
CFN_EXPORT void
CFNetServiceBrowserStopSearch(CFNetServiceBrowserRef browser, CFStreamError * __nullable error) API_DEPRECATED("Use nw_browser_t or nw_listener_t in Network framework instead", macos(10.2, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFNetServiceBrowserScheduleWithRunLoop()
*
* Discussion:
* Schedules the browser on a run loop and mode. Use this to place
* the given browser into asynchronous mode. The client callback
* will be triggered via one of the scheduled run loops; It is the
* caller's responsibility to ensure that at least one of the
* scheduled run loops is being run.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* browser:
* Network Service Browser to schedule. Must be non-NULL.
*
* runLoop:
* A reference to a runloop on which the browser should be
* scheduled. Must be non-NULL.
*
* runLoopMode:
* The mode on which to schedule the browser. Must be non-NULL.
*
*/
CFN_EXPORT void
CFNetServiceBrowserScheduleWithRunLoop(CFNetServiceBrowserRef browser, CFRunLoopRef runLoop, CFStringRef runLoopMode) API_DEPRECATED("Use nw_browser_t or nw_listener_t in Network framework instead", macos(10.2, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/*
* CFNetServiceBrowserUnscheduleFromRunLoop()
*
* Discussion:
* Unschedules the browser from a run loop and mode.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* browser:
* Network Service Browser to unschedule. Must be non-NULL.
*
* runLoop:
* A reference to a runloop from which the browser should be
* unscheduled. Must be non-NULL.
*
* runLoopMode:
* The mode from which to unschedule the browser. Must be
* non-NULL.
*
*/
CFN_EXPORT void
CFNetServiceBrowserUnscheduleFromRunLoop(CFNetServiceBrowserRef browser, CFRunLoopRef runLoop, CFStringRef runLoopMode) API_DEPRECATED("Use nw_browser_t or nw_listener_t in Network framework instead", macos(10.2, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
#ifdef __MACH__
/*
* CFNetServiceRegister() *** DEPRECATED ***
*
* Discussion:
* Registers the entity on the network. This requires that the
* service has a domain, a type, a name, and a port. The service is
* registered on the network until this function returns or is
* cancelled by calling CFNetServiceCancel. In synchronous mode,
* this function will block until there is an error or it is
* cancelled from another thread. In asynchronous mode, this
* function returns immediately and the underlying network
* registration process will start.
*
* As a result of new, better performing API's in Service Discovery,
* users should now call CFNetServiceRegisterWithOptions. Using the
* new calls will allow your application to perform better on the
* network.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* theService:
* The Network Service to register on the network. Must be
* non-NULL.
*
* error:
* A reference to an error struct which will be set to the error
* and domain of the error should one occur. If the value of
* error is not desired, set to NULL.
*
* Result:
* Returns FALSE if domain, type, name or port is NULL. In
* synchronous mode, it will always return FALSE as a result of the
* error or the cancellation. In asynchronous mode, it will return
* TRUE if the registration process could start.
*
*/
CFN_EXPORT Boolean
CFNetServiceRegister(CFNetServiceRef theService, CFStreamError * __nullable error) CF_DEPRECATED(10_2, 10_4, NA, NA);
/*
* CFNetServiceResolve() *** DEPRECATED ***
*
* Discussion:
* Resolves the addressing for the given service. This requires
* that the service has a domain, a type, and a name. The service
* is resolved on the network until this function returns or is
* cancelled by calling CFNetServiceCancel. In synchronous mode,
* this function will block until there is an error or it is
* cancelled from another thread. In asynchronous mode, this
* function returns immediately and the underlying network
* resolution process will start.
*
* As a result of new, better performing API's in Service Discovery,
* users should now call CFNetServiceResolveWithTimeout. If needing
* to monitor TXT record changes, users should use the new
* CFNetServiceMonitor object. Using the new calls will allow your
* application to perform better on the network.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* theService:
* The Network Service to resolve on the network. Must be
* non-NULL.
*
* error:
* A reference to an error struct which will be set to the error
* and domain of the error should one occur. If the value of
* error is not desired, set to NULL.
*
* Result:
* Returns FALSE if domain, type, or name is NULL. In synchronous
* mode, it will return FALSE as a result of an error or a
* cancellation. It will return TRUE if the resolution does
* succeed. In asynchronous mode, it will return TRUE if the
* resolution process could start.
*
*/
CFN_EXPORT Boolean
CFNetServiceResolve(CFNetServiceRef theService, CFStreamError * __nullable error) CF_DEPRECATED(10_2, 10_4, NA, NA);
#endif /* defined(__MACH__) */
#pragma pack(pop)
CF_ASSUME_NONNULL_END
CF_EXTERN_C_END
#endif /* __CFNETSERVICES__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CFNetwork.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CFNetwork.framework/Modules/module.modulemap | framework module CFNetwork [extern_c] [system] {
umbrella header "CFNetwork.h"
export *
module * {export *}
} |
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/CoreFoundation.tbd | --- !tapi-tbd
tbd-version: 4
targets: [ x86_64-macos, x86_64-maccatalyst, x86_64h-macos, x86_64h-maccatalyst,
arm64-macos, arm64-maccatalyst, arm64e-macos, arm64e-maccatalyst ]
uuids:
- target: x86_64-macos
value: 2EE2347F-18D8-3FA0-A537-1927D72C5696
- target: x86_64-maccatalyst
value: 2EE2347F-18D8-3FA0-A537-1927D72C5696
- target: x86_64h-macos
value: 6F1237C1-0200-3591-A29C-D7B61BBB8F0F
- target: x86_64h-maccatalyst
value: 6F1237C1-0200-3591-A29C-D7B61BBB8F0F
- target: arm64-macos
value: 00000000-0000-0000-0000-000000000000
- target: arm64-maccatalyst
value: 00000000-0000-0000-0000-000000000000
- target: arm64e-macos
value: D1B80AD3-9834-3729-B837-B8475CA00B58
- target: arm64e-maccatalyst
value: D1B80AD3-9834-3729-B837-B8475CA00B58
install-name: '/System/Library/Frameworks/CoreFoundation.framework/Versions/A/CoreFoundation'
current-version: 1853
compatibility-version: 150
exports:
- targets: [ x86_64-macos, x86_64h-macos ]
symbols: [ '$ld$add$os10.5$_OBJC_CLASS_$_NSObject', '$ld$add$os10.5$_OBJC_IVAR_$_NSObject.isa',
'$ld$add$os10.5$_OBJC_METACLASS_$_NSObject', '$ld$add$os10.6$_OBJC_CLASS_$_NSObject',
'$ld$add$os10.6$_OBJC_IVAR_$_NSObject.isa', '$ld$add$os10.6$_OBJC_METACLASS_$_NSObject',
'$ld$add$os10.7$_OBJC_CLASS_$_NSObject', '$ld$add$os10.7$_OBJC_IVAR_$_NSObject.isa',
'$ld$add$os10.7$_OBJC_METACLASS_$_NSObject' ]
- targets: [ x86_64-macos, arm64e-macos, x86_64h-macos, x86_64-maccatalyst,
x86_64h-maccatalyst, arm64e-maccatalyst, arm64-macos, arm64-maccatalyst ]
symbols: [ _CFAbsoluteTimeAddGregorianUnits, _CFAbsoluteTimeGetCurrent,
_CFAbsoluteTimeGetDayOfWeek, _CFAbsoluteTimeGetDayOfYear,
_CFAbsoluteTimeGetDifferenceAsGregorianUnits, _CFAbsoluteTimeGetGregorianDate,
_CFAbsoluteTimeGetWeekOfYear, _CFAllocatorAllocate, _CFAllocatorCreate,
_CFAllocatorDeallocate, _CFAllocatorGetContext, _CFAllocatorGetDefault,
_CFAllocatorGetPreferredSizeForSize, _CFAllocatorGetTypeID,
_CFAllocatorReallocate, _CFAllocatorSetDefault, _CFArrayAppendArray,
_CFArrayAppendValue, _CFArrayApplyFunction, _CFArrayBSearchValues,
_CFArrayContainsValue, _CFArrayCreate, _CFArrayCreateCopy,
_CFArrayCreateMutable, _CFArrayCreateMutableCopy, _CFArrayExchangeValuesAtIndices,
_CFArrayGetCount, _CFArrayGetCountOfValue, _CFArrayGetFirstIndexOfValue,
_CFArrayGetLastIndexOfValue, _CFArrayGetTypeID, _CFArrayGetValueAtIndex,
_CFArrayGetValues, _CFArrayInsertValueAtIndex, _CFArrayRemoveAllValues,
_CFArrayRemoveValueAtIndex, _CFArrayReplaceValues, _CFArraySetValueAtIndex,
_CFArraySortValues, _CFAttributedStringBeginEditing, _CFAttributedStringCreate,
_CFAttributedStringCreateCopy, _CFAttributedStringCreateMutable,
_CFAttributedStringCreateMutableCopy, _CFAttributedStringCreateWithSubstring,
_CFAttributedStringEndEditing, _CFAttributedStringGetAttribute,
_CFAttributedStringGetAttributeAndLongestEffectiveRange, _CFAttributedStringGetAttributes,
_CFAttributedStringGetAttributesAndLongestEffectiveRange,
_CFAttributedStringGetBidiLevels, _CFAttributedStringGetBidiLevelsAndResolvedDirections,
_CFAttributedStringGetLength, _CFAttributedStringGetMutableString,
_CFAttributedStringGetString, _CFAttributedStringGetTypeID,
_CFAttributedStringOpenUText, _CFAttributedStringRemoveAttribute,
_CFAttributedStringReplaceAttributedString, _CFAttributedStringReplaceString,
_CFAttributedStringSetAttribute, _CFAttributedStringSetAttributes,
_CFAutorelease, _CFBagAddValue, _CFBagApplyFunction, _CFBagContainsValue,
_CFBagCreate, _CFBagCreateCopy, _CFBagCreateMutable, _CFBagCreateMutableCopy,
_CFBagGetCount, _CFBagGetCountOfValue, _CFBagGetTypeID, _CFBagGetValue,
_CFBagGetValueIfPresent, _CFBagGetValues, _CFBagRemoveAllValues,
_CFBagRemoveValue, _CFBagReplaceValue, _CFBagSetValue, _CFBinaryHeapAddValue,
_CFBinaryHeapApplyFunction, _CFBinaryHeapContainsValue, _CFBinaryHeapCreate,
_CFBinaryHeapCreateCopy, _CFBinaryHeapGetCount, _CFBinaryHeapGetCountOfValue,
_CFBinaryHeapGetMinimum, _CFBinaryHeapGetMinimumIfPresent,
_CFBinaryHeapGetTypeID, _CFBinaryHeapGetValues, _CFBinaryHeapRemoveAllValues,
_CFBinaryHeapRemoveMinimumValue, _CFBitVectorContainsBit,
_CFBitVectorCreate, _CFBitVectorCreateCopy, _CFBitVectorCreateMutable,
_CFBitVectorCreateMutableCopy, _CFBitVectorFlipBitAtIndex,
_CFBitVectorFlipBits, _CFBitVectorGetBitAtIndex, _CFBitVectorGetBits,
_CFBitVectorGetCount, _CFBitVectorGetCountOfBit, _CFBitVectorGetFirstIndexOfBit,
_CFBitVectorGetLastIndexOfBit, _CFBitVectorGetTypeID, _CFBitVectorSetAllBits,
_CFBitVectorSetBitAtIndex, _CFBitVectorSetBits, _CFBitVectorSetCount,
_CFBooleanGetTypeID, _CFBooleanGetValue, _CFBundleCloseBundleResourceMap,
_CFBundleCopyAuxiliaryExecutableURL, _CFBundleCopyBuiltInPlugInsURL,
_CFBundleCopyBundleLocalizations, _CFBundleCopyBundleURL,
_CFBundleCopyExecutableArchitectures, _CFBundleCopyExecutableArchitecturesForURL,
_CFBundleCopyExecutableURL, _CFBundleCopyInfoDictionaryForURL,
_CFBundleCopyInfoDictionaryInDirectory, _CFBundleCopyLocalizationForLocalizationInfo,
_CFBundleCopyLocalizationsForPreferences, _CFBundleCopyLocalizationsForURL,
_CFBundleCopyLocalizedString, _CFBundleCopyLocalizedStringForLocalization,
_CFBundleCopyPreferredLocalizationsFromArray, _CFBundleCopyPrivateFrameworksURL,
_CFBundleCopyResourceURL, _CFBundleCopyResourceURLForLocalization,
_CFBundleCopyResourceURLInDirectory, _CFBundleCopyResourceURLsOfType,
_CFBundleCopyResourceURLsOfTypeForLocalization, _CFBundleCopyResourceURLsOfTypeInDirectory,
_CFBundleCopyResourcesDirectoryURL, _CFBundleCopySharedFrameworksURL,
_CFBundleCopySharedSupportURL, _CFBundleCopySupportFilesDirectoryURL,
_CFBundleCreate, _CFBundleCreateBundlesFromDirectory, _CFBundleGetAllBundles,
_CFBundleGetBundleWithIdentifier, _CFBundleGetDataPointerForName,
_CFBundleGetDataPointersForNames, _CFBundleGetDevelopmentRegion,
_CFBundleGetExecutableType, _CFBundleGetFunctionPointerForName,
_CFBundleGetFunctionPointersForNames, _CFBundleGetIdentifier,
_CFBundleGetInfoDictionary, _CFBundleGetLocalInfoDictionary,
_CFBundleGetLocalizationInfoForLocalization, _CFBundleGetMainBundle,
_CFBundleGetPackageInfo, _CFBundleGetPackageInfoInDirectory,
_CFBundleGetPlugIn, _CFBundleGetTypeID, _CFBundleGetValueForInfoDictionaryKey,
_CFBundleGetVersionNumber, _CFBundleIsArchitectureLoadable,
_CFBundleIsExecutableLoadable, _CFBundleIsExecutableLoadableForURL,
_CFBundleIsExecutableLoaded, _CFBundleLoadExecutable, _CFBundleLoadExecutableAndReturnError,
_CFBundleOpenBundleResourceFiles, _CFBundleOpenBundleResourceMap,
_CFBundlePreflightExecutable, _CFBundleUnloadExecutable, _CFBurstTrieAdd,
_CFBurstTrieAddCharacters, _CFBurstTrieAddCharactersWithWeight,
_CFBurstTrieAddUTF8String, _CFBurstTrieAddUTF8StringWithWeight,
_CFBurstTrieAddWithWeight, _CFBurstTrieContains, _CFBurstTrieContainsCharacters,
_CFBurstTrieContainsUTF8String, _CFBurstTrieCreate, _CFBurstTrieCreateCursorForBytes,
_CFBurstTrieCreateFromFile, _CFBurstTrieCreateFromMapBytes,
_CFBurstTrieCreateWithOptions, _CFBurstTrieCursorAdvanceForBytes,
_CFBurstTrieCursorCreateByCopy, _CFBurstTrieCursorGetPayload,
_CFBurstTrieCursorIsEqual, _CFBurstTrieCursorRelease, _CFBurstTrieFind,
_CFBurstTrieFindCharacters, _CFBurstTrieFindUTF8String, _CFBurstTrieGetCount,
_CFBurstTrieInsert, _CFBurstTrieInsertCharacters, _CFBurstTrieInsertCharactersWithWeight,
_CFBurstTrieInsertUTF8String, _CFBurstTrieInsertUTF8StringWithWeight,
_CFBurstTrieInsertWithWeight, _CFBurstTriePrint, _CFBurstTrieRelease,
_CFBurstTrieRetain, _CFBurstTrieSerialize, _CFBurstTrieSerializeWithFileDescriptor,
_CFBurstTrieSetCursorForBytes, _CFBurstTrieTraverse, _CFBurstTrieTraverseFromCursor,
_CFBurstTrieTraverseWithCursor, _CFCalendarAddComponents,
_CFCalendarComposeAbsoluteTime, _CFCalendarCopyCurrent, _CFCalendarCopyGregorianStartDate,
_CFCalendarCopyLocale, _CFCalendarCopyTimeZone, _CFCalendarCreateDateComponentsFromDate,
_CFCalendarCreateDateFromComponents, _CFCalendarCreateWithIdentifier,
_CFCalendarDecomposeAbsoluteTime, _CFCalendarGetComponentDifference,
_CFCalendarGetComponentFromDate, _CFCalendarGetFirstWeekday,
_CFCalendarGetIdentifier, _CFCalendarGetMaximumRangeOfUnit,
_CFCalendarGetMinimumDaysInFirstWeek, _CFCalendarGetMinimumRangeOfUnit,
_CFCalendarGetOrdinalityOfUnit, _CFCalendarGetRangeOfUnit,
_CFCalendarGetTimeRangeOfUnit, _CFCalendarGetTypeID, _CFCalendarSetFirstWeekday,
_CFCalendarSetGregorianStartDate, _CFCalendarSetLocale, _CFCalendarSetMinimumDaysInFirstWeek,
_CFCalendarSetTimeZone, _CFCharacterSetAddCharactersInRange,
_CFCharacterSetAddCharactersInString, _CFCharacterSetCreateBitmapRepresentation,
_CFCharacterSetCreateCopy, _CFCharacterSetCreateInvertedSet,
_CFCharacterSetCreateMutable, _CFCharacterSetCreateMutableCopy,
_CFCharacterSetCreateWithBitmapRepresentation, _CFCharacterSetCreateWithCharactersInRange,
_CFCharacterSetCreateWithCharactersInString, _CFCharacterSetGetPredefined,
_CFCharacterSetGetTypeID, _CFCharacterSetHasMemberInPlane,
_CFCharacterSetInitInlineBuffer, _CFCharacterSetIntersect,
_CFCharacterSetInvert, _CFCharacterSetIsCharacterMember, _CFCharacterSetIsLongCharacterMember,
_CFCharacterSetIsSupersetOfSet, _CFCharacterSetIsSurrogatePairMember,
_CFCharacterSetRemoveCharactersInRange, _CFCharacterSetRemoveCharactersInString,
_CFCharacterSetUnion, _CFCollection_non_gc_storage_error,
_CFCopyDescription, _CFCopyHomeDirectoryURL, _CFCopyHomeDirectoryURLForUser,
_CFCopySearchPathForDirectoriesInDomains, _CFCopySystemVersionString,
_CFCopyTypeIDDescription, _CFCopyUserName, _CFDataAppendBytes,
_CFDataCreate, _CFDataCreateCopy, _CFDataCreateMutable, _CFDataCreateMutableCopy,
_CFDataCreateWithBytesNoCopy, _CFDataDeleteBytes, _CFDataFind,
_CFDataGetBytePtr, _CFDataGetBytes, _CFDataGetLength, _CFDataGetMutableBytePtr,
_CFDataGetTypeID, _CFDataIncreaseLength, _CFDataReplaceBytes,
_CFDataSetLength, _CFDateCompare, _CFDateComponentsCopyCalendar,
_CFDateComponentsCopyTimeZone, _CFDateComponentsCreate, _CFDateComponentsCreateCopy,
_CFDateComponentsDateMatchesComponents, _CFDateComponentsGetTypeID,
_CFDateComponentsGetValue, _CFDateComponentsIsLeapMonth, _CFDateComponentsIsLeapMonthSet,
_CFDateComponentsIsValidDate, _CFDateComponentsIsValidDateInCalendar,
_CFDateComponentsSetCalendar, _CFDateComponentsSetTimeZone,
_CFDateComponentsSetValue, _CFDateCreate, _CFDateFormatterCopyProperty,
_CFDateFormatterCreate, _CFDateFormatterCreateDateFormatFromTemplate,
_CFDateFormatterCreateDateFormatsFromTemplates, _CFDateFormatterCreateDateFromString,
_CFDateFormatterCreateISO8601Formatter, _CFDateFormatterCreateStringWithAbsoluteTime,
_CFDateFormatterCreateStringWithDate, _CFDateFormatterGetAbsoluteTimeFromString,
_CFDateFormatterGetDateStyle, _CFDateFormatterGetFormat, _CFDateFormatterGetLocale,
_CFDateFormatterGetTimeStyle, _CFDateFormatterGetTypeID, _CFDateFormatterSetFormat,
_CFDateFormatterSetProperty, _CFDateGetAbsoluteTime, _CFDateGetTimeIntervalSinceDate,
_CFDateGetTypeID, _CFDateIntervalCompare, _CFDateIntervalContainsDate,
_CFDateIntervalCopyEndDate, _CFDateIntervalCopyStartDate,
_CFDateIntervalCreate, _CFDateIntervalCreateIntersectionWithDateInterval,
_CFDateIntervalCreateWithEndDate, _CFDateIntervalGetDuration,
_CFDateIntervalIntersectsDateInterval, _CFDictionaryAddValue,
_CFDictionaryApplyFunction, _CFDictionaryContainsKey, _CFDictionaryContainsValue,
_CFDictionaryCreate, _CFDictionaryCreateCopy, _CFDictionaryCreateMutable,
_CFDictionaryCreateMutableCopy, _CFDictionaryGetCount, _CFDictionaryGetCountOfKey,
_CFDictionaryGetCountOfValue, _CFDictionaryGetKeyIfPresent,
_CFDictionaryGetKeysAndValues, _CFDictionaryGetTypeID, _CFDictionaryGetValue,
_CFDictionaryGetValueIfPresent, _CFDictionaryRemoveAllValues,
_CFDictionaryRemoveValue, _CFDictionaryReplaceValue, _CFDictionarySetValue,
_CFEqual, _CFErrorCopyCallBackBlockForDomain, _CFErrorCopyDescription,
_CFErrorCopyFailureReason, _CFErrorCopyRecoverySuggestion,
_CFErrorCopyUserInfo, _CFErrorCreate, _CFErrorCreateWithUserInfoKeysAndValues,
_CFErrorGetCallBackBlockForDomain, _CFErrorGetCallBackForDomain,
_CFErrorGetCode, _CFErrorGetDomain, _CFErrorGetTypeID, _CFErrorSetCallBackBlockForDomain,
_CFErrorSetCallBackForDomain, _CFFileDescriptorCreate, _CFFileDescriptorCreateRunLoopSource,
_CFFileDescriptorDisableCallBacks, _CFFileDescriptorEnableCallBacks,
_CFFileDescriptorGetContext, _CFFileDescriptorGetNativeDescriptor,
_CFFileDescriptorGetTypeID, _CFFileDescriptorInvalidate, _CFFileDescriptorIsValid,
_CFFileSecurityClearProperties, _CFFileSecurityCopyAccessControlList,
_CFFileSecurityCopyGroupUUID, _CFFileSecurityCopyOwnerUUID,
_CFFileSecurityCreate, _CFFileSecurityCreateCopy, _CFFileSecurityGetGroup,
_CFFileSecurityGetMode, _CFFileSecurityGetOwner, _CFFileSecurityGetTypeID,
_CFFileSecuritySetAccessControlList, _CFFileSecuritySetGroup,
_CFFileSecuritySetGroupUUID, _CFFileSecuritySetMode, _CFFileSecuritySetOwner,
_CFFileSecuritySetOwnerUUID, _CFGetAllocator, _CFGetRetainCount,
_CFGetSystemUptime, _CFGetTypeID, _CFGetUserName, _CFGregorianDateGetAbsoluteTime,
_CFGregorianDateIsValid, _CFHash, _CFHashBytes, _CFLocaleCopyAvailableLocaleIdentifiers,
_CFLocaleCopyCommonISOCurrencyCodes, _CFLocaleCopyCurrent,
_CFLocaleCopyDisplayNameForPropertyValue, _CFLocaleCopyISOCountryCodes,
_CFLocaleCopyISOCurrencyCodes, _CFLocaleCopyISOLanguageCodes,
_CFLocaleCopyPreferredLanguages, _CFLocaleCreate, _CFLocaleCreateCanonicalLanguageIdentifierFromString,
_CFLocaleCreateCanonicalLocaleIdentifierFromScriptManagerCodes,
_CFLocaleCreateCanonicalLocaleIdentifierFromString, _CFLocaleCreateComponentsFromLocaleIdentifier,
_CFLocaleCreateCopy, _CFLocaleCreateLocaleIdentifierFromComponents,
_CFLocaleCreateLocaleIdentifierFromWindowsLocaleCode, _CFLocaleGetIdentifier,
_CFLocaleGetLanguageCharacterDirection, _CFLocaleGetLanguageLineDirection,
_CFLocaleGetLanguageRegionEncodingForLocaleIdentifier, _CFLocaleGetSystem,
_CFLocaleGetTypeID, _CFLocaleGetValue, _CFLocaleGetWindowsLocaleCodeFromLocaleIdentifier,
_CFLog, _CFLogTest, _CFMachPortCreate, _CFMachPortCreateRunLoopSource,
_CFMachPortCreateWithPort, _CFMachPortGetContext, _CFMachPortGetInvalidationCallBack,
_CFMachPortGetPort, _CFMachPortGetQueuedMessageCount, _CFMachPortGetTypeID,
_CFMachPortInvalidate, _CFMachPortIsValid, _CFMachPortSetInvalidationCallBack,
_CFMakeCollectable, _CFMakeUncollectable, _CFMergeSortArray,
_CFMessagePortCreateLocal, _CFMessagePortCreatePerProcessLocal,
_CFMessagePortCreatePerProcessRemote, _CFMessagePortCreateRemote,
_CFMessagePortCreateRunLoopSource, _CFMessagePortGetContext,
_CFMessagePortGetInvalidationCallBack, _CFMessagePortGetName,
_CFMessagePortGetTypeID, _CFMessagePortInvalidate, _CFMessagePortIsRemote,
_CFMessagePortIsValid, _CFMessagePortSendRequest, _CFMessagePortSetDispatchQueue,
_CFMessagePortSetInvalidationCallBack, _CFMessagePortSetName,
_CFMutableAttributedStringOpenUText, _CFMutableStringOpenUText,
_CFNotificationCenterAddObserver, _CFNotificationCenterGetDarwinNotifyCenter,
_CFNotificationCenterGetDistributedCenter, _CFNotificationCenterGetLocalCenter,
_CFNotificationCenterGetTypeID, _CFNotificationCenterIsSuspended,
_CFNotificationCenterPostNotification, _CFNotificationCenterPostNotificationWithOptions,
_CFNotificationCenterRemoveEveryObserver, _CFNotificationCenterRemoveObserver,
_CFNotificationCenterSetSuspended, _CFNullGetTypeID, _CFNumberCompare,
_CFNumberCreate, _CFNumberFormatterCopyProperty, _CFNumberFormatterCreate,
_CFNumberFormatterCreateNumberFromString, _CFNumberFormatterCreateStringWithNumber,
_CFNumberFormatterCreateStringWithValue, _CFNumberFormatterGetDecimalInfoForCurrencyCode,
_CFNumberFormatterGetFormat, _CFNumberFormatterGetLocale,
_CFNumberFormatterGetStyle, _CFNumberFormatterGetTypeID, _CFNumberFormatterGetValueFromString,
_CFNumberFormatterSetFormat, _CFNumberFormatterSetProperty,
_CFNumberGetByteSize, _CFNumberGetType, _CFNumberGetTypeID,
_CFNumberGetValue, _CFNumberIsFloatType, _CFPasteboardAllowSandboxExtensionAccessForPID,
_CFPasteboardAllowSandboxExtensionAccessForProcess, _CFPasteboardApplyFunction,
_CFPasteboardAttachSecurityScopeToURL, _CFPasteboardBeginDragAndDrop,
_CFPasteboardBeginGeneration, _CFPasteboardCopyData, _CFPasteboardCopyFlavorsForItem,
_CFPasteboardCopyItemsAndFlavors, _CFPasteboardCopyName, _CFPasteboardCreate,
_CFPasteboardCreateDataForString, _CFPasteboardCreateSecurityScopeDataForURL,
_CFPasteboardCreateStringFromData, _CFPasteboardCreateUnique,
_CFPasteboardCreateUniquePromiseFileURL, _CFPasteboardEnableBatching,
_CFPasteboardEndDragAndDrop, _CFPasteboardEnumeratePasteboardUsingBlock,
_CFPasteboardFlushEntries, _CFPasteboardGetChangeCount, _CFPasteboardGetDataFlags,
_CFPasteboardGetFlavorCount, _CFPasteboardGetGenerationCount,
_CFPasteboardGetItemAtIndex, _CFPasteboardGetItemCount, _CFPasteboardGetTypeID,
_CFPasteboardIsDataPromised, _CFPasteboardMakeGenerationLocalOnly,
_CFPasteboardPromiseData, _CFPasteboardPromiseDataUsingBlock,
_CFPasteboardResolveAllPromisedData, _CFPasteboardResolvePromisedData,
_CFPasteboardRestrictSandboxExtensionAccess, _CFPasteboardSetData,
_CFPasteboardSetDataFlags, _CFPasteboardSetExpirationDate,
_CFPasteboardSetPasteFileType, _CFPasteboardSetPasteLocation,
_CFPlugInAddInstanceForFactory, _CFPlugInCreate, _CFPlugInFindFactoriesForPlugInType,
_CFPlugInFindFactoriesForPlugInTypeInPlugIn, _CFPlugInGetBundle,
_CFPlugInGetTypeID, _CFPlugInInstanceCreate, _CFPlugInInstanceCreateWithInstanceDataSize,
_CFPlugInInstanceGetFactoryName, _CFPlugInInstanceGetInstanceData,
_CFPlugInInstanceGetInterfaceFunctionTable, _CFPlugInInstanceGetTypeID,
_CFPlugInIsLoadOnDemand, _CFPlugInRegisterFactoryFunction,
_CFPlugInRegisterFactoryFunctionByName, _CFPlugInRegisterPlugInType,
_CFPlugInRemoveInstanceForFactory, _CFPlugInSetLoadOnDemand,
_CFPlugInUnregisterFactory, _CFPlugInUnregisterPlugInType,
_CFPreferencesAddSuitePreferencesToApp, _CFPreferencesAppSynchronize,
_CFPreferencesAppValueIsForced, _CFPreferencesCopyAppValue,
_CFPreferencesCopyApplicationList, _CFPreferencesCopyKeyList,
_CFPreferencesCopyMultiple, _CFPreferencesCopyValue, _CFPreferencesFlushCaches,
_CFPreferencesGetAppBooleanValue, _CFPreferencesGetAppIntegerValue,
_CFPreferencesRemoveSuitePreferencesFromApp, _CFPreferencesSetAppValue,
_CFPreferencesSetMultiple, _CFPreferencesSetValue, _CFPreferencesSynchronize,
_CFPropertyListCreateData, _CFPropertyListCreateDeepCopy,
_CFPropertyListCreateFromStream, _CFPropertyListCreateFromXMLData,
_CFPropertyListCreateWithData, _CFPropertyListCreateWithStream,
_CFPropertyListCreateXMLData, _CFPropertyListIsValid, _CFPropertyListWrite,
_CFPropertyListWriteToStream, _CFQSortArray, _CFReadStreamClose,
_CFReadStreamCopyDispatchQueue, _CFReadStreamCopyError, _CFReadStreamCopyProperty,
_CFReadStreamCreate, _CFReadStreamCreateWithBytesNoCopy, _CFReadStreamCreateWithData,
_CFReadStreamCreateWithFile, _CFReadStreamGetBuffer, _CFReadStreamGetError,
_CFReadStreamGetInfoPointer, _CFReadStreamGetStatus, _CFReadStreamGetTypeID,
_CFReadStreamHasBytesAvailable, _CFReadStreamOpen, _CFReadStreamRead,
_CFReadStreamScheduleWithRunLoop, _CFReadStreamSetClient,
_CFReadStreamSetDispatchQueue, _CFReadStreamSetProperty, _CFReadStreamSignalEvent,
_CFReadStreamUnscheduleFromRunLoop, _CFRelease, _CFRetain,
_CFRunArrayCreate, _CFRunArrayDelete, _CFRunArrayGetCount,
_CFRunArrayGetTypeID, _CFRunArrayGetValueAtIndex, _CFRunArrayGetValueAtRunArrayIndex,
_CFRunArrayInsert, _CFRunArrayReplace, _CFRunLoopAddCommonMode,
_CFRunLoopAddObserver, _CFRunLoopAddSource, _CFRunLoopAddTimer,
_CFRunLoopContainsObserver, _CFRunLoopContainsSource, _CFRunLoopContainsTimer,
_CFRunLoopCopyAllModes, _CFRunLoopCopyCurrentMode, _CFRunLoopGetCurrent,
_CFRunLoopGetMain, _CFRunLoopGetNextTimerFireDate, _CFRunLoopGetTypeID,
_CFRunLoopIsWaiting, _CFRunLoopObserverCreate, _CFRunLoopObserverCreateWithHandler,
_CFRunLoopObserverDoesRepeat, _CFRunLoopObserverGetActivities,
_CFRunLoopObserverGetContext, _CFRunLoopObserverGetOrder,
_CFRunLoopObserverGetTypeID, _CFRunLoopObserverInvalidate,
_CFRunLoopObserverIsValid, _CFRunLoopPerformBlock, _CFRunLoopRemoveObserver,
_CFRunLoopRemoveSource, _CFRunLoopRemoveTimer, _CFRunLoopRun,
_CFRunLoopRunInMode, _CFRunLoopRunSpecific, _CFRunLoopSourceCreate,
_CFRunLoopSourceGetContext, _CFRunLoopSourceGetOrder, _CFRunLoopSourceGetTypeID,
_CFRunLoopSourceInvalidate, _CFRunLoopSourceIsSignalled, _CFRunLoopSourceIsValid,
_CFRunLoopSourceSignal, _CFRunLoopStop, _CFRunLoopTimerCreate,
_CFRunLoopTimerCreateWithHandler, _CFRunLoopTimerDoesRepeat,
_CFRunLoopTimerGetContext, _CFRunLoopTimerGetInterval, _CFRunLoopTimerGetNextFireDate,
_CFRunLoopTimerGetOrder, _CFRunLoopTimerGetTolerance, _CFRunLoopTimerGetTypeID,
_CFRunLoopTimerInvalidate, _CFRunLoopTimerIsValid, _CFRunLoopTimerSetNextFireDate,
_CFRunLoopTimerSetTolerance, _CFRunLoopWakeUp, _CFServiceControllerCanConnect,
_CFServiceControllerCopyLoadedLocalizations, _CFServiceControllerCopyServicesEntries,
_CFServiceControllerCopyServicesEntriesForLocalizations, _CFServiceControllerGetRegisteredProvider,
_CFServiceControllerPerformService, _CFServiceControllerRegisterProvider,
_CFServiceControllerSetServicesEntries, _CFServiceControllerSynchronizeServiceEntries,
_CFSetAddValue, _CFSetApplyFunction, _CFSetContainsValue,
_CFSetCreate, _CFSetCreateCopy, _CFSetCreateMutable, _CFSetCreateMutableCopy,
_CFSetGetCount, _CFSetGetCountOfValue, _CFSetGetTypeID, _CFSetGetValue,
_CFSetGetValueIfPresent, _CFSetGetValues, _CFSetRemoveAllValues,
_CFSetRemoveValue, _CFSetReplaceValue, _CFSetSetValue, _CFShow,
_CFShowStr, _CFSocketConnectToAddress, _CFSocketCopyAddress,
_CFSocketCopyPeerAddress, _CFSocketCopyRegisteredSocketSignature,
_CFSocketCopyRegisteredValue, _CFSocketCreate, _CFSocketCreateConnectedToSocketSignature,
_CFSocketCreateRunLoopSource, _CFSocketCreateWithNative, _CFSocketCreateWithSocketSignature,
_CFSocketDisableCallBacks, _CFSocketEnableCallBacks, _CFSocketGetContext,
_CFSocketGetDefaultNameRegistryPortNumber, _CFSocketGetNative,
_CFSocketGetSocketFlags, _CFSocketGetTypeID, _CFSocketInvalidate,
_CFSocketIsValid, _CFSocketRegisterSocketSignature, _CFSocketRegisterValue,
_CFSocketSendData, _CFSocketSetAddress, _CFSocketSetDefaultNameRegistryPortNumber,
_CFSocketSetSocketFlags, _CFSocketUnregister, _CFSortIndexes,
_CFStorageApplyBlock, _CFStorageApplyFunction, _CFStorageCreate,
_CFStorageCreateWithSubrange, _CFStorageDeleteValues, _CFStorageGetConstValueAtIndex,
_CFStorageGetCount, _CFStorageGetTypeID, _CFStorageGetValueAtIndex,
_CFStorageGetValues, _CFStorageInsertValues, _CFStorageReplaceValues,
_CFStreamCreateBoundPair, _CFStreamCreatePairWithPeerSocketSignature,
_CFStreamCreatePairWithSocket, _CFStreamCreatePairWithSocketToHost,
_CFStringAppend, _CFStringAppendCString, _CFStringAppendCharacters,
_CFStringAppendFormat, _CFStringAppendFormatAndArguments,
_CFStringAppendPascalString, _CFStringCapitalize, _CFStringCompare,
_CFStringCompareWithOptions, _CFStringCompareWithOptionsAndLocale,
_CFStringConvertEncodingToIANACharSetName, _CFStringConvertEncodingToNSStringEncoding,
_CFStringConvertEncodingToWindowsCodepage, _CFStringConvertIANACharSetNameToEncoding,
_CFStringConvertNSStringEncodingToEncoding, _CFStringConvertWindowsCodepageToEncoding,
_CFStringCreateArrayBySeparatingStrings, _CFStringCreateArrayWithFindResults,
_CFStringCreateByCombiningStrings, _CFStringCreateCopy, _CFStringCreateExternalRepresentation,
_CFStringCreateFromExternalRepresentation, _CFStringCreateMutable,
_CFStringCreateMutableCopy, _CFStringCreateMutableWithExternalCharactersNoCopy,
_CFStringCreateStringWithValidatedFormat, _CFStringCreateWithBytes,
_CFStringCreateWithBytesNoCopy, _CFStringCreateWithCString,
_CFStringCreateWithCStringNoCopy, _CFStringCreateWithCharacters,
_CFStringCreateWithCharactersNoCopy, _CFStringCreateWithFileSystemRepresentation,
_CFStringCreateWithFormat, _CFStringCreateWithFormatAndArguments,
_CFStringCreateWithPascalString, _CFStringCreateWithPascalStringNoCopy,
_CFStringCreateWithSubstring, _CFStringDelete, _CFStringEncodingBytesToUnicode,
_CFStringEncodingIsValidCombiningCharacterForLatin1, _CFStringEncodingPrecomposeLatinCharacter,
_CFStringEncodingRegisterFallbackProcedures, _CFStringEncodingUnicodeToBytes,
_CFStringFileSystemEncoding, _CFStringFind, _CFStringFindAndReplace,
_CFStringFindCharacterFromSet, _CFStringFindWithOptions, _CFStringFindWithOptionsAndLocale,
_CFStringFold, _CFStringGetBytes, _CFStringGetCString, _CFStringGetCStringPtr,
_CFStringGetCharacterAtIndex, _CFStringGetCharacters, _CFStringGetCharactersPtr,
_CFStringGetDoubleValue, _CFStringGetFastestEncoding, _CFStringGetFileSystemRepresentation,
_CFStringGetHyphenationLocationBeforeIndex, _CFStringGetIntValue,
_CFStringGetLength, _CFStringGetLineBounds, _CFStringGetListOfAvailableEncodings,
_CFStringGetMaximumSizeForEncoding, _CFStringGetMaximumSizeOfFileSystemRepresentation,
_CFStringGetMostCompatibleMacStringEncoding, _CFStringGetNameOfEncoding,
_CFStringGetParagraphBounds, _CFStringGetPascalString, _CFStringGetPascalStringPtr,
_CFStringGetRangeOfCharacterClusterAtIndex, _CFStringGetRangeOfComposedCharactersAtIndex,
_CFStringGetSmallestEncoding, _CFStringGetSystemEncoding,
_CFStringGetTypeID, _CFStringHasPrefix, _CFStringHasSuffix,
_CFStringHashCString, _CFStringHashCharacters, _CFStringHashISOLatin1CString,
_CFStringHashNSString, _CFStringInsert, _CFStringIsEncodingAvailable,
_CFStringIsHyphenationAvailableForLocale, _CFStringLowercase,
_CFStringNormalize, _CFStringOpenUText, _CFStringPad, _CFStringReplace,
_CFStringReplaceAll, _CFStringSetExternalCharactersNoCopy,
_CFStringTokenizerAdvanceToNextToken, _CFStringTokenizerCopyBestStringLanguage,
_CFStringTokenizerCopyBestStringLanguageWithHints, _CFStringTokenizerCopyCurrentTokenAttribute,
_CFStringTokenizerCreate, _CFStringTokenizerGetCurrentSubTokens,
_CFStringTokenizerGetCurrentTokenRange, _CFStringTokenizerGetTypeID,
_CFStringTokenizerGoToTokenAtIndex, _CFStringTokenizerSetString,
_CFStringTokenizerSetStringWithOptions, _CFStringTransform,
_CFStringTrim, _CFStringTrimWhitespace, _CFStringUppercase,
_CFTimeZoneCopyAbbreviation, _CFTimeZoneCopyAbbreviationDictionary,
_CFTimeZoneCopyDefault, _CFTimeZoneCopyKnownNames, _CFTimeZoneCopyLocalizedName,
_CFTimeZoneCopySystem, _CFTimeZoneCreate, _CFTimeZoneCreateWithName,
_CFTimeZoneCreateWithTimeIntervalFromGMT, _CFTimeZoneGetData,
_CFTimeZoneGetDaylightSavingTimeOffset, _CFTimeZoneGetName,
_CFTimeZoneGetNextDaylightSavingTimeTransition, _CFTimeZoneGetSecondsFromGMT,
_CFTimeZoneGetTypeID, _CFTimeZoneIsDaylightSavingTime, _CFTimeZoneResetSystem,
_CFTimeZoneSetAbbreviationDictionary, _CFTimeZoneSetDefault,
_CFTreeAppendChild, _CFTreeApplyFunctionToChildren, _CFTreeCreate,
_CFTreeFindRoot, _CFTreeGetChildAtIndex, _CFTreeGetChildCount,
_CFTreeGetChildren, _CFTreeGetContext, _CFTreeGetFirstChild,
_CFTreeGetNextSibling, _CFTreeGetParent, _CFTreeGetTypeID,
_CFTreeInsertSibling, _CFTreePrependChild, _CFTreeRemove,
_CFTreeRemoveAllChildren, _CFTreeSetContext, _CFTreeSortChildren,
_CFTypeGetTypeID, _CFURLCanBeDecomposed, _CFURLClearResourcePropertyCache,
_CFURLClearResourcePropertyCacheForKey, _CFURLCopyAbsoluteURL,
_CFURLCopyFileSystemPath, _CFURLCopyFragment, _CFURLCopyHostName,
_CFURLCopyLastPathComponent, _CFURLCopyNetLocation, _CFURLCopyParameterString,
_CFURLCopyPassword, _CFURLCopyPath, _CFURLCopyPathExtension,
_CFURLCopyQueryString, _CFURLCopyResourcePropertiesForKeys,
_CFURLCopyResourcePropertyForKey, _CFURLCopyResourceSpecifier,
_CFURLCopyScheme, _CFURLCopyStrictPath, _CFURLCopyUserName,
_CFURLCreateAbsoluteURLWithBytes, _CFURLCreateBookmarkData,
_CFURLCreateBookmarkDataFromAliasRecord, _CFURLCreateBookmarkDataFromFile,
_CFURLCreateByResolvingBookmarkData, _CFURLCreateCopyAppendingPathComponent,
_CFURLCreateCopyAppendingPathExtension, _CFURLCreateCopyDeletingLastPathComponent,
_CFURLCreateCopyDeletingPathExtension, _CFURLCreateData, _CFURLCreateDataAndPropertiesFromResource,
_CFURLCreateFilePathURL, _CFURLCreateFileReferenceURL, _CFURLCreateFromFSRef,
_CFURLCreateFromFileSystemRepresentation, _CFURLCreateFromFileSystemRepresentationRelativeToBase,
_CFURLCreatePropertyFromResource, _CFURLCreateResourcePropertiesForKeysFromBookmarkData,
_CFURLCreateResourcePropertyForKeyFromBookmarkData, _CFURLCreateStringByAddingPercentEscapes,
_CFURLCreateStringByReplacingPercentEscapes, _CFURLCreateStringByReplacingPercentEscapesUsingEncoding,
_CFURLCreateStringWithFileSystemPath, _CFURLCreateWithBytes,
_CFURLCreateWithFileSystemPath, _CFURLCreateWithFileSystemPathRelativeToBase,
_CFURLCreateWithString, _CFURLDestroyResource, _CFURLEnumeratorCreateForDirectoryURL,
_CFURLEnumeratorCreateForMountedVolumes, _CFURLEnumeratorGetDescendentLevel,
_CFURLEnumeratorGetNextURL, _CFURLEnumeratorGetSourceDidChange,
_CFURLEnumeratorGetTypeID, _CFURLEnumeratorSkipDescendents,
_CFURLGetBaseURL, _CFURLGetByteRangeForComponent, _CFURLGetBytes,
_CFURLGetBytesUsingEncoding, _CFURLGetFSRef, _CFURLGetFileSystemRepresentation,
_CFURLGetPortNumber, _CFURLGetString, _CFURLGetTypeID, _CFURLHasDirectoryPath,
_CFURLIsFileReferenceURL, _CFURLResourceIsReachable, _CFURLSetResourcePropertiesForKeys,
_CFURLSetResourcePropertyForKey, _CFURLSetTemporaryResourcePropertyForKey,
_CFURLStartAccessingSecurityScopedResource, _CFURLStopAccessingSecurityScopedResource,
_CFURLWriteBookmarkDataToFile, _CFURLWriteDataAndPropertiesToResource,
_CFUUIDCreate, _CFUUIDCreateFromString, _CFUUIDCreateFromUUIDBytes,
_CFUUIDCreateString, _CFUUIDCreateWithBytes, _CFUUIDGetConstantUUIDWithBytes,
_CFUUIDGetTypeID, _CFUUIDGetUUIDBytes, _CFUniCharApplyUnicodeBidiAlgorithm,
_CFUniCharDecompose, _CFUniCharDecomposeCharacter, _CFUniCharDecomposeWithErrorLocation,
_CFUniCharFillDestinationBuffer, _CFUniCharGetBidiCategory,
_CFUniCharGetBitmapPtrForPlane, _CFUniCharGetDefaultWritingDirection,
_CFUniCharGetFirstBidiParagraphLength, _CFUniCharGetUnicodePropertyDataForPlane,
_CFUniCharIsMemberOf, _CFUniCharMapCaseTo, _CFUniCharMapTo,
_CFUniCharPrecompose, _CFUniCharPrioritySort, _CFUserNotificationCancel,
_CFUserNotificationCreate, _CFUserNotificationCreateRunLoopSource,
_CFUserNotificationDisplayAlert, _CFUserNotificationDisplayNotice,
_CFUserNotificationGetResponseDictionary, _CFUserNotificationGetResponseValue,
_CFUserNotificationGetTypeID, _CFUserNotificationReceiveResponse,
_CFUserNotificationUpdate, _CFWriteStreamCanAcceptBytes, _CFWriteStreamClose,
_CFWriteStreamCopyDispatchQueue, _CFWriteStreamCopyError,
_CFWriteStreamCopyProperty, _CFWriteStreamCreate, _CFWriteStreamCreateWithAllocatedBuffers,
_CFWriteStreamCreateWithBuffer, _CFWriteStreamCreateWithFile,
_CFWriteStreamGetError, _CFWriteStreamGetInfoPointer, _CFWriteStreamGetStatus,
_CFWriteStreamGetTypeID, _CFWriteStreamOpen, _CFWriteStreamScheduleWithRunLoop,
_CFWriteStreamSetClient, _CFWriteStreamSetDispatchQueue, _CFWriteStreamSetProperty,
_CFWriteStreamSignalEvent, _CFWriteStreamUnscheduleFromRunLoop,
_CFWriteStreamWrite, _CFXNotificationRegisteredObserverSetDistributedConnection,
_CFXNotificationRegisteredObserverSetNotifyToken, _CFXNotificationRegistrarAdd,
_CFXNotificationRegistrarAddRemoteToken, _CFXNotificationRegistrarCreate,
_CFXNotificationRegistrarEnumerate, _CFXNotificationRegistrarFind,
_CFXNotificationRegistrarFindToken, _CFXNotificationRegistrarGetTypeID,
_CFXNotificationRegistrarIsEmpty, _CFXNotificationRegistrarRemove,
_CFXNotificationRegistrarRemoveRemoteToken, _CFXNotificationRegistrarRemoveToken,
_CFXNotificationRegistrarUpdateDistributedConnections, _CFXNotificationRegistrarValidateToken,
_NSBuddhistCalendar, _NSCalendarDayChangedNotification, _NSCalendarIdentifierBuddhist,
_NSCalendarIdentifierChinese, _NSCalendarIdentifierCoptic,
_NSCalendarIdentifierEthiopicAmeteAlem, _NSCalendarIdentifierEthiopicAmeteMihret,
_NSCalendarIdentifierGregorian, _NSCalendarIdentifierHebrew,
_NSCalendarIdentifierISO8601, _NSCalendarIdentifierIndian,
_NSCalendarIdentifierIslamic, _NSCalendarIdentifierIslamicCivil,
_NSCalendarIdentifierIslamicTabular, _NSCalendarIdentifierIslamicUmmAlQura,
_NSCalendarIdentifierJapanese, _NSCalendarIdentifierPersian,
_NSCalendarIdentifierRepublicOfChina, _NSChineseCalendar,
_NSCurrentLocaleDidChangeNotification, _NSDateFormatterPatternCharacterKey,
_NSDateFormatterPatternLiteralKey, _NSDateFormatterPatternRangeKey,
_NSDateFormatterPatternStringKey, _NSDefaultRunLoopMode, _NSGenericException,
_NSGetSizeAndAlignment, _NSGregorianCalendar, _NSHebrewCalendar,
_NSISO8601Calendar, _NSIndianCalendar, _NSInternalInconsistencyException,
_NSInvalidArgumentException, _NSIslamicCalendar, _NSIslamicCivilCalendar,
_NSJapaneseCalendar, _NSLocaleAlternateQuotationBeginDelimiterKey,
_NSLocaleAlternateQuotationEndDelimiterKey, _NSLocaleCalendar,
_NSLocaleCalendarIdentifier, _NSLocaleCalendarIdentifierKey,
_NSLocaleCalendarKey, _NSLocaleCollationIdentifier, _NSLocaleCollationIdentifierKey,
_NSLocaleCollatorIdentifier, _NSLocaleCollatorIdentifierKey,
_NSLocaleCountryCode, _NSLocaleCountryCodeKey, _NSLocaleCurrencyCode,
_NSLocaleCurrencyCodeKey, _NSLocaleCurrencySymbol, _NSLocaleCurrencySymbolKey,
_NSLocaleDecimalSeparator, _NSLocaleDecimalSeparatorKey, _NSLocaleExemplarCharacterSet,
_NSLocaleExemplarCharacterSetKey, _NSLocaleGroupingSeparator,
_NSLocaleGroupingSeparatorKey, _NSLocaleIdentifier, _NSLocaleIdentifierKey,
_NSLocaleLanguageCode, _NSLocaleLanguageCodeKey, _NSLocaleMeasurementSystem,
_NSLocaleMeasurementSystemKey, _NSLocaleMeasurementSystemMetric,
_NSLocaleMeasurementSystemUK, _NSLocaleMeasurementSystemUS,
_NSLocaleQuotationBeginDelimiterKey, _NSLocaleQuotationEndDelimiterKey,
_NSLocaleScriptCode, _NSLocaleScriptCodeKey, _NSLocaleTemperatureUnit,
_NSLocaleTemperatureUnitCelsius, _NSLocaleTemperatureUnitFahrenheit,
_NSLocaleTemperatureUnitKey, _NSLocaleUsesMetricSystem, _NSLocaleUsesMetricSystemKey,
_NSLocaleVariantCode, _NSLocaleVariantCodeKey, _NSMallocException,
_NSPersianCalendar, _NSRangeException, _NSRepublicOfChinaCalendar,
_NSRunLoopCommonModes, _NSStreamDataWrittenToMemoryStreamKey,
_NSStreamFileCurrentOffsetKey, _NSStreamSOCKSProxyConfigurationKey,
_NSStreamSOCKSProxyHostKey, _NSStreamSOCKSProxyPasswordKey,
_NSStreamSOCKSProxyPortKey, _NSStreamSOCKSProxyUserKey, _NSStreamSOCKSProxyVersion4,
_NSStreamSOCKSProxyVersion5, _NSStreamSOCKSProxyVersionKey,
_NSStreamSocketSecurityLevelKey, _NSStreamSocketSecurityLevelNegotiatedSSL,
_NSStreamSocketSecurityLevelNone, _NSStreamSocketSecurityLevelSSLv2,
_NSStreamSocketSecurityLevelSSLv3, _NSStreamSocketSecurityLevelTLSv1,
_NSStringTransformFullwidthToHalfwidth, _NSStringTransformHiraganaToKatakana,
_NSStringTransformLatinToArabic, _NSStringTransformLatinToCyrillic,
_NSStringTransformLatinToGreek, _NSStringTransformLatinToHangul,
_NSStringTransformLatinToHebrew, _NSStringTransformLatinToHiragana,
_NSStringTransformLatinToKatakana, _NSStringTransformLatinToThai,
_NSStringTransformMandarinToLatin, _NSStringTransformStripCombiningMarks,
_NSStringTransformStripDiacritics, _NSStringTransformToLatin,
_NSStringTransformToUnicodeName, _NSStringTransformToXMLHex,
_NSSystemClockDidChangeNotification, _NSSystemTimeZoneDidChangeNotification,
_NSThumbnail1024x1024SizeKey, _NSURLAddedToDirectoryDateKey,
_NSURLAttributeModificationDateKey, _NSURLCanonicalPathKey,
_NSURLContentAccessDateKey, _NSURLContentModificationDateKey,
_NSURLContentTypeKey, _NSURLCreationDateKey, _NSURLCustomIconKey,
_NSURLDocumentIdentifierKey, _NSURLEffectiveIconKey, _NSURLFileAllocatedSizeKey,
_NSURLFileContentIdentifierKey, _NSURLFileProtectionComplete,
_NSURLFileProtectionCompleteUnlessOpen, _NSURLFileProtectionCompleteUntilFirstUserAuthentication,
_NSURLFileProtectionKey, _NSURLFileProtectionNone, _NSURLFileResourceIdentifierKey,
_NSURLFileResourceTypeBlockSpecial, _NSURLFileResourceTypeCharacterSpecial,
_NSURLFileResourceTypeDirectory, _NSURLFileResourceTypeKey,
_NSURLFileResourceTypeNamedPipe, _NSURLFileResourceTypeRegular,
_NSURLFileResourceTypeSocket, _NSURLFileResourceTypeSymbolicLink,
_NSURLFileResourceTypeUnknown, _NSURLFileSecurityKey, _NSURLFileSizeKey,
_NSURLGenerationIdentifierKey, _NSURLHasHiddenExtensionKey,
_NSURLIsAliasFileKey, _NSURLIsApplicationKey, _NSURLIsDirectoryKey,
_NSURLIsExcludedFromBackupKey, _NSURLIsExecutableKey, _NSURLIsHiddenKey,
_NSURLIsMountTriggerKey, _NSURLIsPackageKey, _NSURLIsPurgeableKey,
_NSURLIsReadableKey, _NSURLIsRegularFileKey, _NSURLIsSparseKey,
_NSURLIsSymbolicLinkKey, _NSURLIsSystemImmutableKey, _NSURLIsUbiquitousItemKey,
_NSURLIsUserImmutableKey, _NSURLIsVolumeKey, _NSURLIsWritableKey,
_NSURLKeysOfUnsetValuesKey, _NSURLLabelColorKey, _NSURLLabelNumberKey,
_NSURLLinkCountKey, _NSURLLocalizedLabelKey, _NSURLLocalizedNameKey,
_NSURLLocalizedTypeDescriptionKey, _NSURLMayHaveExtendedAttributesKey,
_NSURLMayShareFileContentKey, _NSURLNameKey, _NSURLParentDirectoryURLKey,
_NSURLPathKey, _NSURLPreferredIOBlockSizeKey, _NSURLThumbnailDictionaryKey,
_NSURLThumbnailKey, _NSURLTotalFileAllocatedSizeKey, _NSURLTotalFileSizeKey,
_NSURLTypeIdentifierKey, _NSURLUbiquitousItemContainerDisplayNameKey,
_NSURLUbiquitousItemDownloadRequestedKey, _NSURLUbiquitousItemDownloadingErrorKey,
_NSURLUbiquitousItemDownloadingStatusCurrent, _NSURLUbiquitousItemDownloadingStatusDownloaded,
_NSURLUbiquitousItemDownloadingStatusKey, _NSURLUbiquitousItemDownloadingStatusNotDownloaded,
_NSURLUbiquitousItemHasUnresolvedConflictsKey, _NSURLUbiquitousItemIsDownloadedKey,
_NSURLUbiquitousItemIsDownloadingKey, _NSURLUbiquitousItemIsExcludedFromSyncKey,
_NSURLUbiquitousItemIsSharedKey, _NSURLUbiquitousItemIsUploadedKey,
_NSURLUbiquitousItemIsUploadingKey, _NSURLUbiquitousItemPercentDownloadedKey,
_NSURLUbiquitousItemPercentUploadedKey, _NSURLUbiquitousItemUploadingErrorKey,
_NSURLUbiquitousSharedItemCurrentUserPermissionsKey, _NSURLUbiquitousSharedItemCurrentUserRoleKey,
_NSURLUbiquitousSharedItemMostRecentEditorNameComponentsKey,
_NSURLUbiquitousSharedItemOwnerNameComponentsKey, _NSURLUbiquitousSharedItemOwnerNameKey,
_NSURLUbiquitousSharedItemPermissionsKey, _NSURLUbiquitousSharedItemPermissionsReadOnly,
_NSURLUbiquitousSharedItemPermissionsReadWrite, _NSURLUbiquitousSharedItemReadOnlyPermissions,
_NSURLUbiquitousSharedItemReadWritePermissions, _NSURLUbiquitousSharedItemRoleKey,
_NSURLUbiquitousSharedItemRoleOwner, _NSURLUbiquitousSharedItemRoleParticipant,
_NSURLVolumeAvailableCapacityForImportantUsageKey, _NSURLVolumeAvailableCapacityForOpportunisticUsageKey,
_NSURLVolumeAvailableCapacityKey, _NSURLVolumeCreationDateKey,
_NSURLVolumeIdentifierKey, _NSURLVolumeIsAutomountedKey, _NSURLVolumeIsBrowsableKey,
_NSURLVolumeIsEjectableKey, _NSURLVolumeIsEncryptedKey, _NSURLVolumeIsInternalKey,
_NSURLVolumeIsJournalingKey, _NSURLVolumeIsLocalKey, _NSURLVolumeIsReadOnlyKey,
_NSURLVolumeIsRemovableKey, _NSURLVolumeIsRootFileSystemKey,
_NSURLVolumeLocalizedFormatDescriptionKey, _NSURLVolumeLocalizedNameKey,
_NSURLVolumeMaximumFileSizeKey, _NSURLVolumeNameKey, _NSURLVolumeResourceCountKey,
_NSURLVolumeSupportsAccessPermissionsKey, _NSURLVolumeSupportsAdvisoryFileLockingKey,
_NSURLVolumeSupportsCasePreservedNamesKey, _NSURLVolumeSupportsCaseSensitiveNamesKey,
_NSURLVolumeSupportsCompressionKey, _NSURLVolumeSupportsExclusiveRenamingKey,
_NSURLVolumeSupportsExtendedSecurityKey, _NSURLVolumeSupportsFileCloningKey,
_NSURLVolumeSupportsFileProtectionKey, _NSURLVolumeSupportsHardLinksKey,
_NSURLVolumeSupportsImmutableFilesKey, _NSURLVolumeSupportsJournalingKey,
_NSURLVolumeSupportsPersistentIDsKey, _NSURLVolumeSupportsRenamingKey,
_NSURLVolumeSupportsRootDirectoryDatesKey, _NSURLVolumeSupportsSparseFilesKey,
_NSURLVolumeSupportsSwapRenamingKey, _NSURLVolumeSupportsSymbolicLinksKey,
_NSURLVolumeSupportsVolumeSizesKey, _NSURLVolumeSupportsZeroRunsKey,
_NSURLVolumeTotalCapacityKey, _NSURLVolumeURLForRemountingKey,
_NSURLVolumeURLKey, _NSURLVolumeUUIDStringKey, __CFAccentuatedStringCreate,
__CFAffixedStringCreate, __CFAppVersionCheck, __CFAppVersionCheckLessThan,
__CFAppVersionLessThan, __CFArgc, __CFArgv, __CFArrayCheckAndGetValueAtIndex,
__CFArrayFastEnumeration, __CFArrayIsMutable, __CFArrayReplaceValues,
__CFArraySetCapacity, __CFAssignThreadSanitizerTag, __CFAttributedStringCheckAndReplace,
__CFAttributedStringCheckAndReplaceAttributed, __CFAttributedStringCheckAndSetAttribute,
__CFAttributedStringCheckAndSetAttributes, __CFAttributedStringCreateWithRuns,
__CFAttributedStringGetLength, __CFAttributedStringGetNumberOfRuns,
__CFAttributedStringGetRuns, __CFAttributedStringIsMutable,
__CFAutoreleasePoolAddObject, __CFAutoreleasePoolPop, __CFAutoreleasePoolPrintPools,
__CFAutoreleasePoolPush, __CFBagFastEnumeration, __CFBagGetUniqueCount,
__CFBagIsMutable, __CFBagSetCapacity, __CFBigNumAdd, __CFBigNumCompare,
__CFBigNumCopyDescription, __CFBigNumFromCString, __CFBigNumGetInt128,
__CFBigNumGetInt16, __CFBigNumGetInt32, __CFBigNumGetInt64,
__CFBigNumGetInt8, __CFBigNumGetUInt128, __CFBigNumGetUInt16,
__CFBigNumGetUInt32, __CFBigNumGetUInt64, __CFBigNumGetUInt8,
__CFBigNumInitWithBytes, __CFBigNumInitWithCFNumber, __CFBigNumInitWithInt128,
__CFBigNumInitWithInt16, __CFBigNumInitWithInt32, __CFBigNumInitWithInt64,
__CFBigNumInitWithInt8, __CFBigNumInitWithUInt128, __CFBigNumInitWithUInt16,
__CFBigNumInitWithUInt32, __CFBigNumInitWithUInt64, __CFBigNumInitWithUInt8,
__CFBigNumNeg, __CFBigNumSub, __CFBigNumToCString, __CFBuildVersionForCFSystemVersion,
__CFBundleAddResourceURL, __CFBundleCloseBundleResourceFork,
__CFBundleCopyAllBundles, __CFBundleCopyAppStoreReceiptURL,
__CFBundleCopyBundleURLForExecutableURL, __CFBundleCopyExecutableURLInDirectory,
__CFBundleCopyFileTypeForFileData, __CFBundleCopyFileTypeForFileURL,
__CFBundleCopyFindResources, __CFBundleCopyFrameworkURLForExecutablePath,
__CFBundleCopyInfoDictionaryForExecutableFileData, __CFBundleCopyInfoDictionaryInResourceFork,
__CFBundleCopyInfoPlistURL, __CFBundleCopyLocalizedStringForLocalizationAndTableURL,
__CFBundleCopyLocalizedStringForLocalizationTableURLAndMarkdownOption,
__CFBundleCopyMainBundleExecutableURL, __CFBundleCopyOtherExecutableURLInDirectory,
__CFBundleCopyPrivateFrameworksURL, __CFBundleCopyResourceForkURL,
__CFBundleCopyResourceURLForLanguage, __CFBundleCopyResourceURLsOfTypeForLanguage,
__CFBundleCopySharedFrameworksURL, __CFBundleCopySharedSupportURL,
__CFBundleCopyWrappedBundleURL, __CFBundleCopyWrapperContainerURL,
__CFBundleCreateError, __CFBundleCreateFilteredInfoPlist,
__CFBundleCreateFilteredLocalizedInfoPlist, __CFBundleCreateIfLooksLikeBundle,
__CFBundleCreateIfMightBeBundle, __CFBundleCreateUnique, __CFBundleCreateWithExecutableURLIfLooksLikeBundle,
__CFBundleCreateWithExecutableURLIfMightBeBundle, __CFBundleDlfcnPreflight,
__CFBundleFlushBundleCaches, __CFBundleFlushCaches, __CFBundleFlushCachesForURL,
__CFBundleFlushLanguageCachesAfterEUIDChange, __CFBundleGetBundleWithIdentifierAndLibraryName,
__CFBundleGetBundleWithIdentifierWithHint, __CFBundleGetCFMFunctionPointerForName,
__CFBundleGetCFMFunctionPointersForNames, __CFBundleGetCurrentPlatform,
__CFBundleGetExistingBundleWithBundleURL, __CFBundleGetHasChanged,
__CFBundleGetLanguageAndRegionCodes, __CFBundleGetLocalInfoDictionary,
__CFBundleGetMainBundleIfLooksLikeBundle, __CFBundleGetPackageInfoInDirectory,
__CFBundleGetPreferredExecutableArchitecture, __CFBundleGetPreferredExecutableArchitectureForURL,
__CFBundleGetStringsFilesShared, __CFBundleGetSupportedPlatforms,
__CFBundleGetValueForInfoKey, __CFBundleLoadExecutableAndReturnError,
__CFBundleMainBundleInfoDictionaryComesFromResourceFork, __CFBundleOpenBundleResourceFork,
__CFBundleRemoveResourceURL, __CFBundleSearchForLocalizedString,
__CFBundleSetCFMConnectionID, __CFBundleSetDefaultLocalization,
__CFBundleSetStringsFilesShared, __CFBundleSetupXPCBootstrap,
__CFBundleSetupXPCBootstrapWithLanguages, __CFBundleURLLooksLikeBundle,
__CFCalendarGetMidnightNoteCount, __CFCalendarGetUnitsFromDateFormat,
__CFCalendarResetCurrent, __CFCharacterSetCompact, __CFCharacterSetCreateKeyedCodingString,
__CFCharacterSetFast, __CFCharacterSetGetKeyedCodingBuiltinType,
__CFCharacterSetGetKeyedCodingRange, __CFCharacterSetGetKeyedCodingType,
__CFCharacterSetIsInverted, __CFCharacterSetIsMutable, __CFCharacterSetSetIsInverted,
__CFCopyServerVersionDictionary, __CFCopySystemVersionDictionary,
__CFCopySystemVersionDictionaryValue, __CFCopySystemVersionPlatformDictionary,
__CFCreateArrayStorage, __CFCreateCharacterSetFromUSet, __CFCreateContainerURLForSecurityApplicationGroupIdentifier,
__CFCreateContainerURLForSecurityApplicationIdentifierGroupIdentifierAndUser,
__CFDataFindBytes, __CFDateFormatterCreateAttributedStringAndFieldsWithAbsoluteTime,
__CFDateFormatterCreateSkeletonFromTemplate, __CFDictionaryFastEnumeration,
__CFDictionaryGetKVOBit, __CFDictionaryIsMutable, __CFDictionarySetCapacity,
__CFDictionarySetKVOBit, __CFDiscorporateMemoryAllocate, __CFDiscorporateMemoryDeallocate,
__CFDiscorporateMemoryDematerialize, __CFDiscorporateMemoryMaterialize,
__CFDoExceptionOperation, __CFDoubledStringCreate, __CFEnableZombies,
__CFErrorCreateDebugDescription, __CFErrorCreateLocalizedDescription,
__CFErrorCreateLocalizedFailureReason, __CFErrorCreateLocalizedRecoverySuggestion,
__CFErrorCreateRedactedDescription, __CFExecutableLinkedOnOrAfter,
__CFExtensionIsValidToAppend, __CFExtensionUniCharsIsValidToAppend,
__CFFileCoordinateReadWriteItemsAtURLs, __CFFileCoordinateReadingItemAtURL,
__CFFileCoordinateReadingItemAtURL2, __CFFileCoordinateReadingWritingItemsAtURLs2,
__CFFileCoordinateWritingItemAtURL, __CFFileCoordinateWritingItemAtURL2,
__CFFileCoordinateWritingItemsAtURLs2, __CFFileDidDisconnect2,
__CFFileDidGainVersion2, __CFFileDidLoseVersion2, __CFFileDidMove2,
__CFFileDidReconnect2, __CFFileDidResolveConflictVersion2,
__CFFileSecurityCreateFromFilesec, __CFFileSecurityGetFilesec,
__CFGetAlternatePlatformName, __CFGetEGID, __CFGetEUID, __CFGetExecutableLinkedLibraryVersion,
__CFGetHandleForInsertedOrInterposingLibrary, __CFGetOutOfMemoryErrorCallBack,
__CFGetPathExtensionRangesFromPathComponent, __CFGetPathExtensionRangesFromPathComponentUniChars,
__CFGetPlatformName, __CFGetProcessPath, __CFGetProductName,
__CFGetProgname, __CFGetTSD, __CFGetTSDCreateIfNeeded, __CFGetUGIDs,
__CFHyphenationGetAllPossibleHyphenationLocations, __CFHyphenationGetLinguisticDataPath,
__CFHyphenationSetLinguisticDataPath, __CFICULog, __CFIsDeallocating,
__CFIsObjC, __CFKeyedArchiverUIDCreate, __CFKeyedArchiverUIDGetTypeID,
__CFKeyedArchiverUIDGetValue, __CFLexiconAppearsUsable, __CFLexiconPackedTrieCopyLemmaDictionariesForWord,
__CFLibraryVersionCompare, __CFLinkedOnOrAfter, __CFListFormatterCreate,
__CFListFormatterCreateStringByJoiningStrings, __CFListFormatterGetTypeID,
__CFLocaleCopyAsIfCurrent, __CFLocaleCopyAsIfCurrentWithOverrides,
__CFLocaleCopyNumberingSystemForLocaleIdentifier, __CFLocaleCopyPreferred,
__CFLocaleCopyPreferredLanguagesForCurrentUser, __CFLocaleCopyPreferredMeasurementSystem,
__CFLocaleCopyPreferredTemperatureUnit, __CFLocaleCopyValidNumberingSystemsForLocaleIdentifier,
__CFLocaleCreateLikeCurrentWithBundleLocalizations, __CFLocaleCreateLocaleIdentiferByReplacingLanguageCodeAndScriptCode,
__CFLocaleGetCalendarDirection, __CFLocaleGetNoteCount, __CFLocaleResetCurrent,
__CFLocaleSetPreferredMeasurementSystem, __CFLocaleSetPreferredTemperatureUnit,
__CFLogvEx, __CFLogvEx2, __CFLogvEx3, __CFMZEnabled, __CFMachPortCreateWithPort2,
__CFMachPortInstallNotifyPort, __CFMainPThread, __CFMessagePortCreateLocalEx,
__CFNonObjCEqual, __CFNonObjCHash, __CFNonObjCRelease, __CFNonObjCRetain,
__CFNonObjCStringGetCStringPtr, __CFNotificationCenterInitializeDependentNotificationIfNecessary,
__CFNotificationCenterRegisterDependentNotificationList, __CFNumberCreateWithBigNum,
__CFNumberFormatterGetFormatter, __CFNumberGetType2, __CFOperatingSystemVersionGetCurrent,
__CFOperatingSystemVersionIsAtLeastVersion, __CFPlatformExecutableLinkedOnOrAfter,
__CFPrefSetInvalidPropertyListDeletionEnabled, __CFPreferencesAddSuitePreferencesToAppWithContainer,
__CFPreferencesAlwaysUseVolatileUserDomains, __CFPreferencesAppFullCloudSynchronize,
__CFPreferencesAppFullCloudSynchronizeWithConfiguration, __CFPreferencesAppPreload,
__CFPreferencesAppSynchronizeWithContainer, __CFPreferencesCopyAppValueWithContainer,
__CFPreferencesCopyAppValueWithContainerAndConfiguration,
__CFPreferencesCopyApplicationMap, __CFPreferencesCopyKeyListWithContainer,
__CFPreferencesCopyMultipleManaged, __CFPreferencesCopyMultipleWithContainer,
__CFPreferencesCopyPathForManagedDomain, __CFPreferencesCopyValueNoCache,
__CFPreferencesCopyValueWithContainer, __CFPreferencesFlushCachesForIdentifier,
__CFPreferencesGetAppBooleanValueWithContainer, __CFPreferencesGetAppIntegerValueWithContainer,
__CFPreferencesGetBooleanValueWithValue, __CFPreferencesGetFileProtectionClass,
__CFPreferencesHasAppCloudValue, __CFPreferencesHasAppValue,
__CFPreferencesIsManaged, __CFPreferencesManagementStatusChangedForDomains,
__CFPreferencesNotifyOfImpendingUserDeletion, __CFPreferencesPostValuesChangedInDomains,
__CFPreferencesRegisterStandardUserDefaultsExists, __CFPreferencesRemoveSuitePreferencesFromAppWithContainer,
__CFPreferencesSetAccessRestricted, __CFPreferencesSetAppCloudSyncEnabled,
__CFPreferencesSetAppValueWithContainer, __CFPreferencesSetAppValueWithContainerAndConfiguration,
__CFPreferencesSetBackupDisabled, __CFPreferencesSetDaemonCacheEnabled,
__CFPreferencesSetFileProtectionClass, __CFPreferencesSetValueWithContainer,
__CFPreferencesSynchronizeWithContainer, __CFPreferencesWebServicesCopyProvider,
__CFPreferencesWebServicesSetProvider, __CFPreferencesWriteDomainDictionaryToPath,
__CFPreferencesWriteManagedDomain, __CFPreferencesWriteManagedDomainForUser,
__CFPreferencesWriteUserPreferencesWithCorrectOwner, __CFPrefsCopyAppDictionary,
__CFPrefsCopyAppDictionaryWithContainer, __CFPrefsCopyDescriptionOfAllSearchLists,
__CFPrefsCopyDirectModeConnection, __CFPrefsCopyUserForContainer,
__CFPrefsDirectMode, __CFPrefsDirectModeEnabledForDomain,
__CFPrefsDumpDescriptionOfAllSearchLists, __CFPrefsEnableWritingToExternalAppCloudPreferences,
__CFPrefsExtractQuadrupleFromPathIfPossible, __CFPrefsGenerateDirectoryURLForTriplet_testing,
__CFPrefsImpersonateApplicationWithIdentifierAndAuditToken,
__CFPrefsImpersonateApplicationWithIdentifierAndContainerDataPath,
__CFPrefsImpersonateApplicationWithIdentifierAndPID, __CFPrefsRegisterUserDefaultsInstance,
__CFPrefsRegisterUserDefaultsInstanceWithCloudConfigurationURL,
__CFPrefsSetDirectModeConnection, __CFPrefsSetDirectModeEnabled,
__CFPrefsSetEphemeralMultiUserEnabled, __CFPrefsSetReadOnly,
__CFPrefsSetSynchronizeIsSynchronous, __CFPrefsSynchronizeForProcessTermination,
__CFPrefsTestingCloudConfigurationOverrideURL, __CFPrefsTestingFlags,
__CFPrefsUnregisterUserDefaultsInstance, __CFPrintForDebugger,
__CFProcessPath, __CFPropertListCreateFromFrozen, __CFPropertyListCopyShared,
__CFPropertyListCopyTopLevelKeys, __CFPropertyListCreateFiltered,
__CFPropertyListCreateFromXMLData, __CFPropertyListCreateFromXMLString,
__CFPropertyListCreateFromXMLStringError, __CFPropertyListCreateFrozen,
__CFPropertyListCreateSingleValue, __CFPropertyListCreateXMLData,
__CFPropertyListCreateXMLDataWithExtras, __CFPropertyListMissingSemicolon,
__CFPropertyListMissingSemicolonOrValue, __CFPropertyListShare,
__CFPropertyListValidateData, __CFRLORightToLeftStringCreate,
__CFRSCompatible, __CFReadStreamClearEvent, __CFReadStreamCreateFromFileDescriptor,
__CFReadStreamDeallocate, __CFReadStreamGetClient, __CFReadStreamInitialize,
__CFReadStreamSignalEventDelayed, __CFRegisterThreadSanitizerTag,
__CFRelativeDateTimeFormatterCreate, __CFRelativeDateTimeFormatterCreateStringWithCalendarUnit,
__CFRelativeDateTimeFormatterGetTypeID, __CFRunArrayCreateWithGuts,
__CFRunLoop01, __CFRunLoopCurrentIsMain, __CFRunLoopFinished,
__CFRunLoopGet0, __CFRunLoopGet0b, __CFRunLoopGet1, __CFRunLoopGet2,
__CFRunLoopGet2b, __CFRunLoopIsCurrent, __CFRunLoopModeContainsMode,
__CFRunLoopPerCalloutAutoreleasepoolEnabled, __CFRunLoopSetPerCalloutAutoreleasepoolEnabled,
__CFRunLoopStopMode, __CFRuntimeBridgeClasses, __CFRuntimeCreateInstance,
__CFRuntimeGetClassWithTypeID, __CFRuntimeInitStaticInstance,
__CFRuntimeRegisterClass, __CFRuntimeSetCFMPresent, __CFRuntimeSetInstanceTypeID,
__CFRuntimeUnregisterClassWithTypeID, __CFSetFastEnumeration,
__CFSetIsMutable, __CFSetOutOfMemoryErrorCallBack, __CFSetProductName,
__CFSetSetCapacity, __CFSetTSD, __CFSocketGetThread, __CFSocketStreamGetAuthenticatesServerCertificateDefault,
__CFSocketStreamPairSetAuthenticatesServerCertificate, __CFSocketStreamSetAuthenticatesServerCertificateDefault,
__CFStorageFastEnumeration, __CFStreamGetInfoPointer, __CFStreamInstanceSize,
__CFStringAppendFormatAndArgumentsAux, __CFStringAppendFormatAndArgumentsAux2,
__CFStringCheckAndGetCharacterAtIndex, __CFStringCheckAndGetCharacters,
__CFStringCompareForHFS, __CFStringCopyVocativeCaseOfGivenName,
__CFStringCreateByAddingPercentEncodingWithAllowedCharacters,
__CFStringCreateByParsingMarkdownAndInflectingIfNeeded, __CFStringCreateByRemovingPercentEncoding,
__CFStringCreateTaggedPointerString, __CFStringCreateWithBytesNoCopy,
__CFStringCreateWithFormatAndArgumentsAux, __CFStringCreateWithFormatAndArgumentsAux2,
__CFStringCreateWithFormatAndArgumentsReturningMetadata, __CFStringEncodingSetForceASCIICompatibility,
__CFStringGetFileSystemRepresentation, __CFStringGetFileSystemRepresentationWithErrorStatus,
__CFStringGetFormatSpecifierConfiguration, __CFStringGetInstallationEncodingAndRegion,
__CFStringGetLength2, __CFStringGetUserDefaultEncoding, __CFStringHyphenationCompileHyphenatorData,
__CFStringSaveUserDefaultEncoding, __CFStringTokenizerCopyPossibleStringLanguages,
__CFStringTokenizerCreateNamePartsArrayWithString, __CFStringTokenizerCreateNamePartsArrayWithStringAsCompositeName,
__CFStringTokenizerCreatePossibleNamePartsArrayWithStringAsCompositeName,
__CFStringTokenizerGetCurrentTokenPartOfSpeech, __CFStringTokenizerGetDerivedTokens,
__CFStringTokenizerGetNextBestTokens, __CFStringTokenizerGetTokenizerAttribute,
__CFStringTokenizerSetLocale, __CFStringTokenizerSetTokenizerAttribute,
__CFStringTokenizerTokenize, __CFStringTokenizerTokenizeCompoundWord,
__CFStringTokenizerTokenizeWithTranscriptions, __CFSuddenTerminationDisable,
__CFSuddenTerminationDisablingCount, __CFSuddenTerminationEnable,
__CFSuddenTerminationExitIfTerminationEnabled, __CFSuddenTerminationExitWhenTerminationEnabled,
__CFTimeZoneGetNoteCount, __CFTryRetain, __CFURLAttachSecurityScopeToFileURL,
__CFURLBookmarkCopyDescription, __CFURLBookmarkDataCompare,
__CFURLBookmarkDataToAliasHandle, __CFURLCStringIsPromiseName,
__CFURLCacheResourcePropertiesForKeys, __CFURLCacheResourcePropertyForKey,
__CFURLComponentsCopyFragment, __CFURLComponentsCopyHost,
__CFURLComponentsCopyPassword, __CFURLComponentsCopyPath,
__CFURLComponentsCopyPercentEncodedFragment, __CFURLComponentsCopyPercentEncodedHost,
__CFURLComponentsCopyPercentEncodedPassword, __CFURLComponentsCopyPercentEncodedPath,
__CFURLComponentsCopyPercentEncodedQuery, __CFURLComponentsCopyPercentEncodedQueryItems,
__CFURLComponentsCopyPercentEncodedUser, __CFURLComponentsCopyPort,
__CFURLComponentsCopyQuery, __CFURLComponentsCopyQueryItems,
__CFURLComponentsCopyScheme, __CFURLComponentsCopyString,
__CFURLComponentsCopyURL, __CFURLComponentsCopyURLRelativeToURL,
__CFURLComponentsCopyUser, __CFURLComponentsCreate, __CFURLComponentsCreateCopy,
__CFURLComponentsCreateWithString, __CFURLComponentsCreateWithURL,
__CFURLComponentsGetRangeOfFragment, __CFURLComponentsGetRangeOfHost,
__CFURLComponentsGetRangeOfPassword, __CFURLComponentsGetRangeOfPath,
__CFURLComponentsGetRangeOfPort, __CFURLComponentsGetRangeOfQuery,
__CFURLComponentsGetRangeOfScheme, __CFURLComponentsGetRangeOfUser,
__CFURLComponentsGetTypeID, __CFURLComponentsGetURLFragmentAllowedCharacterSet,
__CFURLComponentsGetURLHostAllowedCharacterSet, __CFURLComponentsGetURLPasswordAllowedCharacterSet,
__CFURLComponentsGetURLPathAllowedCharacterSet, __CFURLComponentsGetURLQueryAllowedCharacterSet,
__CFURLComponentsGetURLUserAllowedCharacterSet, __CFURLComponentsSchemeIsValid,
__CFURLComponentsSetFragment, __CFURLComponentsSetHost, __CFURLComponentsSetPassword,
__CFURLComponentsSetPath, __CFURLComponentsSetPercentEncodedFragment,
__CFURLComponentsSetPercentEncodedHost, __CFURLComponentsSetPercentEncodedPassword,
__CFURLComponentsSetPercentEncodedPath, __CFURLComponentsSetPercentEncodedQuery,
__CFURLComponentsSetPercentEncodedQueryItems, __CFURLComponentsSetPercentEncodedUser,
__CFURLComponentsSetPort, __CFURLComponentsSetQuery, __CFURLComponentsSetQueryItems,
__CFURLComponentsSetScheme, __CFURLComponentsSetUser, __CFURLCopyComponents,
__CFURLCopyFileURL, __CFURLCopyLogicalNameOfPromiseAtURL,
__CFURLCopyLogicalURLOfPromiseAtURL, __CFURLCopyPromiseNameOfLogicalURL,
__CFURLCopyPromiseURLOfLogicalURL, __CFURLCopyPropertiesOfPromiseAtURL,
__CFURLCopyPropertyListRepresentation, __CFURLCopyResourcePropertiesForKeysFromCache,
__CFURLCopyResourcePropertyForKeyFromCache, __CFURLCopyResourcePropertyValuesAndFlags,
__CFURLCopySecurityScopeFromFileURL, __CFURLCreateByResolvingAliasFile,
__CFURLCreateCurrentDirectoryURL, __CFURLCreateDisplayPathComponentsArray,
__CFURLCreateFileReferenceURLFromFSRef, __CFURLCreateFileReferenceURLFromIDs,
__CFURLCreateFromComponents, __CFURLCreateFromPropertyListRepresentation,
__CFURLCreateStandardError, __CFURLCreateWithFileSystemPathCachingResourcePropertiesForKeys,
__CFURLEnumeratorGetURLsBulk, __CFURLFileCacheClearPropertyValueForKey,
__CFURLFileCacheGetFinderInfo, __CFURLFileCacheGetFlags, __CFURLFileCacheGetName,
__CFURLFileCacheGetPropertyValueForKey, __CFURLFileCacheSetPropertyValueForKey,
__CFURLGetCatalogInfo, __CFURLGetEncoding, __CFURLGetFSRef,
__CFURLGetObjectInformationNoIO, __CFURLGetResourcePropertyFlags,
__CFURLGetVolumePropertyFlags, __CFURLIsFileReferenceURL,
__CFURLIsFileURL, __CFURLIsItemPromiseAtURL, __CFURLIsPromiseName,
__CFURLIsProtectedDirectory, __CFURLNoteSecurityScopedResourceMoved,
__CFURLPromiseCopyPhysicalURL, __CFURLPromiseCopyResourcePropertyForKey,
__CFURLPromiseCreateProperties, __CFURLPromiseSetPhysicalURL,
__CFURLPromiseSetResourcePropertyForKey, __CFURLRegisterFilePropertyProvider,
__CFURLRegisterFilePropertyWithOptions, __CFURLReplaceObject,
__CFURLRevocableBookmarksCopyClientBundleIdentifiers, __CFURLRevocableBookmarksCopyClients,
__CFURLRevocableBookmarksRevokeForBundleIdentifier, __CFURLRevocableBookmarksSetActiveStatusForBundleIdentifier,
__CFURLSetPermanentResourcePropertyForKey, __CFUserNotificationSetWarningThread,
__CFWebServicesCopyProviderInfo, __CFWebServicesSetProviderInfo,
__CFWriteStreamCreateFromFileDescriptor, __CFWriteStreamDeallocate,
__CFWriteStreamGetClient, __CFWriteStreamInitialize, __CFWriteStreamSignalEventDelayed,
__CFXNotificationCancelToken, __CFXNotificationCenterCopyDebugInfo,
__CFXNotificationCenterCreate, __CFXNotificationCenterIsEmpty,
__CFXNotificationGetHostCenter, __CFXNotificationGetSuspended,
__CFXNotificationGetTaskCenter, __CFXNotificationPost, __CFXNotificationRegisterObserver,
__CFXNotificationRegistrationBufferDestroy, __CFXNotificationRegistrationDispose,
__CFXNotificationRemoveObservers, __CFXNotificationSetSuspended,
__CFXPCCreateCFObjectFromXPCMessage, __CFXPCCreateCFObjectFromXPCObject,
__CFXPCCreateXPCMessageWithCFObject, __CFXPCCreateXPCObjectFromCFObject,
__CFXPreferencesCopyDictionaryForApplicationPreferences, __CFXPreferencesCopyDictionaryForNamedVolatileSource,
__CFXPreferencesCopyDictionaryForSourceWithBundleID, __CFXPreferencesCopyVolatileSourceNames,
__CFXPreferencesGetByHostIdentifierString, __CFXPreferencesRegisterDefaultValues,
__CFXPreferencesRemoveNamedVolatileSource, __CFXPreferencesReplaceValuesInNamedVolatileSource,
__CFXPreferencesReplaceValuesInSourceWithBundleID, __CFXPreferencesReplaceValuesInSourceWithBundleIDWithContainer,
__CFXPreferencesSetUserDefaultsPointer, __CF_forwarding_prep_0,
__NSDateDistantFuture, __NSDateDistantPast, __NSIsNSArray,
__NSIsNSAttributedString, __NSIsNSCFConstantString, __NSIsNSData,
__NSIsNSDate, __NSIsNSDictionary, __NSIsNSIndexSet, __NSIsNSNumber,
__NSIsNSObject, __NSIsNSOrderedSet, __NSIsNSSet, __NSIsNSString,
__NSIsNSTimeZone, __NSIsNSValue, __NSMessageBuilder, __NSObjectLoadWeak,
__NSObjectLoadWeakRetained, __NSObjectStoreWeak, __NSSetDeallocHandler,
__NSTaggedPointerStringGetBytes, __NSTaggedPointerStringGetLength,
__NSURLCloudDocsPlaceholderDictionaryKey, __NSURLCloudDocsPlaceholderLogicalNameKey,
__NSURLUbiquitousItemDownloadRequestedKey, ___CFAllocatorRespectsHintZeroWhenAllocating,
___CFArgStuff, ___CFAttributedStringCreateMutableWithSubstring,
___CFAttributedStringMtbl, ___CFBinaryPlistCreateObject, ___CFBinaryPlistGetOffsetForValueFromArray2,
___CFBinaryPlistGetOffsetForValueFromDictionary3, ___CFBinaryPlistGetTopLevelInfo,
___CFBinaryPlistWrite, ___CFBinaryPlistWriteToStream, ___CFBinaryPlistWriteToStreamWithEstimate,
___CFBinaryPlistWriteToStreamWithOptions, ___CFBundleLanguageAbbreviationsArray,
___CFBundleLocaleAbbreviationsArray, ___CFCharToUniCharFunc,
___CFConstantStringClassReference, ___CFConstantStringClassReferencePtr,
___CFDataMtbl, ___CFDefaultEightBitStringEncoding, ___CFGenericTypeID,
___CFGetNextSearchPathEnumeration, ___CFIdempotentCharToUniCharTable,
___CFInitialize, ___CFMacRomanCharToUnicharTable, ___CFMachMessageCheckForAndDestroyUnsentMessage,
___CFOAInitialize, ___CFOASafe, ___CFObjectAllocRecordAllocationFunction,
___CFObjectAllocSetLastAllocEventNameFunction, ___CFRangeMake,
___CFRecordAllocationEvent, ___CFRunLoopEnableAuxiliaryAppNapNotifications,
___CFRunLoopSetOptions, ___CFRunLoopSetOptionsReason, ___CFSafelyReallocate,
___CFSafelyReallocateWithAllocator, ___CFSetLastAllocationEventName,
___CFSocketEnableCallBacks, ___CFSocketGetBytesAvailable,
___CFSocketRead, ___CFSocketSetSocketReadBufferAttrs, ___CFStartSearchPathEnumeration,
___CFStorageGetCapacity, ___CFStorageGetValueSize, ___CFStorageSetAlwaysFrozen,
___CFStringAppendBytes, ___CFStringCheckAndReplace, ___CFStringComputeEightBitStringEncoding,
___CFStringCreateImmutableFunnel2, ___CFStringDecodeByteStream2,
___CFStringDecodeByteStream3, ___CFStringEncodeByteStream,
___CFStringFindFormatSpecifiersInString, ___CFStringHash,
___CFStringIsEightBit, ___CFStringIsMutable, ___CFStringMakeConstantString,
___CFStringMtbl, ___CFStringNoteErrors, ___CFTSANTagMutableArray,
___CFTSANTagMutableData, ___CFTSANTagMutableDictionary, ___CFTSANTagMutableOrderedSet,
___CFTSANTagMutableSet, ___CFURLBeginResourcePropertyCacheAccess,
___CFURLEndResourcePropertyCacheAccess, ___CFURLReservedPtr,
___CFURLResourceInfoPtr, ___CFURLSetReservedPtr, ___CFURLSetResourceInfoPtr,
___CFXPreferencesDaemon_main, ___NSArray0__, ___NSArray0__struct,
___NSDictionary0__, ___NSDictionary0__struct, ___NSMakeSpecialForwardingCaptureBlock,
___cf_tsanReadFunction, ___cf_tsanWriteFunction, ___crashreporter_info__,
___kCFBooleanFalse, ___kCFBooleanTrue, ___kCFNull, ___kCFSocketRegistryRequestRunLoopMode,
__cfmp_record_nsmachport_deallocation, __cfmp_record_nsmachport_is_interested,
__kCFBundleAllowMixedLocalizationsKey, __kCFBundleCFMLoadAsBundleKey,
__kCFBundleDisplayNameKey, __kCFBundleDocumentTypesKey, __kCFBundleExecutablePathKey,
__kCFBundleGetInfoHTMLKey, __kCFBundleGetInfoStringKey, __kCFBundleIconFileKey,
__kCFBundleInfoPlistURLKey, __kCFBundleNumericVersionKey,
__kCFBundleOldDocumentTypesKey, __kCFBundleOldExecutableKey,
__kCFBundleOldIconFileKey, __kCFBundleOldInfoDictionaryVersionKey,
__kCFBundleOldNameKey, __kCFBundleOldShortVersionStringKey,
__kCFBundleOldTypeExtensions1Key, __kCFBundleOldTypeExtensions2Key,
__kCFBundleOldTypeIconFileKey, __kCFBundleOldTypeNameKey,
__kCFBundleOldTypeOSTypesKey, __kCFBundleOldTypeRoleKey, __kCFBundlePackageTypeKey,
__kCFBundlePrincipalClassKey, __kCFBundleRawInfoPlistURLKey,
__kCFBundleResourceSpecificationKey, __kCFBundleResourcesFileMappedKey,
__kCFBundleShortVersionStringKey, __kCFBundleSignatureKey,
__kCFBundleSupportedPlatformsKey, __kCFBundleTypeExtensionsKey,
__kCFBundleTypeIconFileKey, __kCFBundleTypeMIMETypesKey, __kCFBundleTypeNameKey,
__kCFBundleTypeOSTypesKey, __kCFBundleTypeRoleKey, __kCFBundleURLIconFileKey,
__kCFBundleURLNameKey, __kCFBundleURLSchemesKey, __kCFBundleURLTypesKey,
__kCFLexiconLemmaAttributesPackedRepresentation, __kCFLexiconLemmaName,
__kCFLexiconLemmaWords, __kCFLexiconWordAttributesPackedRepresentation,
__kCFLexiconWordParts, __kCFLexiconWordToken, __kCFStreamPropertyFileNativeHandle,
__kCFStreamPropertyHTTPTrailer, __kCFStreamPropertySocketSecurityAuthenticatesServerCertificate,
__kCFStringFormatMetadataArgumentNumberKey, __kCFStringFormatMetadataArgumentObjectKey,
__kCFStringFormatMetadataReplacementIndexKey, __kCFStringFormatMetadataReplacementRangeLengthKey,
__kCFStringFormatMetadataReplacementRangeLocationKey, __kCFStringFormatMetadataSpecifierRangeLengthInFormatStringKey,
__kCFStringFormatMetadataSpecifierRangeLocationInFormatStringKey,
__kCFSystemVersionBuildStringKey, __kCFSystemVersionBuildVersionKey,
__kCFSystemVersionProductCopyrightKey, __kCFSystemVersionProductNameKey,
__kCFSystemVersionProductUserVisibleVersionKey, __kCFSystemVersionProductVersionExtraKey,
__kCFSystemVersionProductVersionKey, __kCFSystemVersionProductVersionStringKey,
__kCFURLAccessControlListKey, __kCFURLApplicationArchitecturesKey,
__kCFURLApplicationCategoriesKey, __kCFURLApplicationDeviceManagementPolicyKey,
__kCFURLApplicationHasSupportedFormatKey, __kCFURLApplicationHighResolutionModeIsMagnifiedKey,
__kCFURLApplicationIsAppletKey, __kCFURLApplicationIsBetaKey,
__kCFURLApplicationIsPlaceholderKey, __kCFURLApplicationNapIsDisabledKey,
__kCFURLApplicationPrefersExternalGPUKey, __kCFURLApplicationPrefersSafeApertureAppFullScreenCompatibilityKey,
__kCFURLApplicationPrefersSafeApertureSystemFullScreenCompatibilityKey,
__kCFURLApplicationPrefersSafeApertureWindowedCompatibilityKey,
__kCFURLApplicationSupportedRegionsKey, __kCFURLArchitecturesValidOnCurrentSystemKey,
__kCFURLBookmarkURLStringKey, __kCFURLBundleIdentifierKey,
__kCFURLCanSetApplicationHighResolutionModeIsMagnifiedKey,
__kCFURLCanSetApplicationNapIsDisabledKey, __kCFURLCanSetApplicationPrefersExternalGPUKey,
__kCFURLCanSetApplicationPrefersSafeApertureWindowedCompatibilityKey,
__kCFURLCanSetHiddenExtensionKey, __kCFURLCanSetStrongBindingKey,
__kCFURLCloudDocsPlaceholderDictionaryKey, __kCFURLCloudDocsPlaceholderLogicalNameKey,
__kCFURLCompleteMountURLKey, __kCFURLComponentsNameKey, __kCFURLComponentsValueKey,
__kCFURLContentTypeKey, __kCFURLCustomIconImageDataKey, __kCFURLDeviceRefNumKey,
__kCFURLDiskImageBackingURLKey, __kCFURLDistinctLocalizedNameKey,
__kCFURLEffectiveIconFlattenedReferenceDataKey, __kCFURLEffectiveIconImageDataKey,
__kCFURLFaultLogicalFileIsHiddenKey, __kCFURLFileAllocatedSizeOfResourceForkKey,
__kCFURLFileFlagsKey, __kCFURLFileIDKey, __kCFURLFilePathKey,
__kCFURLFileSecurityKey, __kCFURLFileSizeOfResourceForkKey,
__kCFURLFinderInfoKey, __kCFURLGenerationCountKey, __kCFURLGroupIDKey,
__kCFURLHFSTypeCodeKey, __kCFURLInodeNumberKey, __kCFURLIsApplicationKey,
__kCFURLIsCompressedKey, __kCFURLIsExcludedFromCloudBackupKey,
__kCFURLIsExcludedFromUnencryptedBackupKey, __kCFURLIsExecutableKey,
__kCFURLIsReadableKey, __kCFURLIsRestrictedKey, __kCFURLIsSystemAppendKey,
__kCFURLIsSystemArchivedKey, __kCFURLIsSystemDatalessFaultKey,
__kCFURLIsSystemFirmlinkKey, __kCFURLIsSystemNoUnlinkKey,
__kCFURLIsUserAppendKey, __kCFURLIsUserDataVaultKey, __kCFURLIsUserNoDumpKey,
__kCFURLIsUserOpaqueKey, __kCFURLIsUserTrackedKey, __kCFURLIsWriteableKey,
__kCFURLLocalizedNameComponentsKey, __kCFURLLocalizedNameDictionaryKey,
__kCFURLLocalizedNameWithExtensionsHiddenDictionaryKey, __kCFURLLocalizedTypeDescriptionDictionaryKey,
__kCFURLNameExtensionKey, __kCFURLOwnerIDKey, __kCFURLParentDirectoryIDKey,
__kCFURLParentDirectoryIsVolumeRootKey, __kCFURLPathKey, __kCFURLPromiseLogicalNameKey,
__kCFURLPromisePhysicalURLKey, __kCFURLPromisePropertiesKey,
__kCFURLResolvedFromBookmarkDataKey, __kCFURLRevocableBookmarkActiveStatusKey,
__kCFURLRevocableBookmarkAppIdentifierKey, __kCFURLRevocableBookmarkBundleIdentifierKey,
__kCFURLRevocableBookmarkSaltKey, __kCFURLRevocableBookmarksClientsDidChangeNotification,
__kCFURLShortVersionStringKey, __kCFURLStatModeKey, __kCFURLStrongBindingKey,
__kCFURLTypeBindingKey, __kCFURLUbiquitousItemDownloadRequestedKey,
__kCFURLUserCanExecuteKey, __kCFURLUserCanReadKey, __kCFURLUserCanWriteKey,
__kCFURLVersionKey, __kCFURLVolumeCreationDateKey, __kCFURLVolumeDeviceIDKey,
__kCFURLVolumeDontBrowseKey, __kCFURLVolumeIDKey, __kCFURLVolumeIOMediaIconBundleIdentifierKey,
__kCFURLVolumeIOMediaIconFamilyNameKey, __kCFURLVolumeIsAirportKey,
__kCFURLVolumeIsAutomountKey, __kCFURLVolumeIsBDVideoKey,
__kCFURLVolumeIsCDKey, __kCFURLVolumeIsDVDKey, __kCFURLVolumeIsDVDVideoKey,
__kCFURLVolumeIsDeviceFileSystemKey, __kCFURLVolumeIsDiskImageKey,
__kCFURLVolumeIsEjectableKey, __kCFURLVolumeIsExternalKey,
__kCFURLVolumeIsFileVaultKey, __kCFURLVolumeIsHFSStandardKey,
__kCFURLVolumeIsInternalKey, __kCFURLVolumeIsLocalKey, __kCFURLVolumeIsLocaliDiskMirrorKey,
__kCFURLVolumeIsMobileTimeMachineKey, __kCFURLVolumeIsNetworkOpticalKey,
__kCFURLVolumeIsQuarantinedKey, __kCFURLVolumeIsReadOnlyKey,
__kCFURLVolumeIsRemovableKey, __kCFURLVolumeIsTimeMachineKey,
__kCFURLVolumeIsVideoDiskKey, __kCFURLVolumeIsiDiskKey, __kCFURLVolumeIsiPodKey,
__kCFURLVolumeMountPointStringKey, __kCFURLVolumeOpenFolderURLKey,
__kCFURLVolumeQuarantinePropertiesKey, __kCFURLVolumeRefNumKey,
__kCFURLVolumeSupportsFileProtectionKey, __kCFURLVolumeUUIDStringKey,
__kCFURLVolumeiDiskUserNameKey, __kCFURLWriterBundleIdentifierKey,
__kCFXNotificationConfigurationCustomDarwinConfiguration,
__kCFXNotificationConfigurationCustomDistributedConfiguration,
__kCFXNotificationConfigurationCustomLocalConfiguration, __kCFXNotificationConfigurationStandardDarwinConfiguration,
__kCFXNotificationConfigurationStandardDistributedConfiguration,
__kCFXNotificationConfigurationStandardLocalConfiguration,
_kCFAbsoluteTimeIntervalSince1904, _kCFAbsoluteTimeIntervalSince1970,
_kCFAllocatorDefault, _kCFAllocatorDefaultGCRefZero, _kCFAllocatorMalloc,
_kCFAllocatorMallocZone, _kCFAllocatorNull, _kCFAllocatorSystemDefault,
_kCFAllocatorSystemDefaultGCRefZero, _kCFAllocatorUseContext,
_kCFBooleanFalse, _kCFBooleanTrue, _kCFBuddhistCalendar, _kCFBundleDevelopmentRegionKey,
_kCFBundleExecutableKey, _kCFBundleIdentifierKey, _kCFBundleInfoDictionaryVersionKey,
_kCFBundleLocalizationsKey, _kCFBundleNameKey, _kCFBundleVersionKey,
_kCFCalendarIdentifierBuddhist, _kCFCalendarIdentifierChinese,
_kCFCalendarIdentifierCoptic, _kCFCalendarIdentifierEthiopicAmeteAlem,
_kCFCalendarIdentifierEthiopicAmeteMihret, _kCFCalendarIdentifierGregorian,
_kCFCalendarIdentifierHebrew, _kCFCalendarIdentifierISO8601,
_kCFCalendarIdentifierIndian, _kCFCalendarIdentifierIslamic,
_kCFCalendarIdentifierIslamicCivil, _kCFCalendarIdentifierIslamicTabular,
_kCFCalendarIdentifierIslamicUmmAlQura, _kCFCalendarIdentifierJapanese,
_kCFCalendarIdentifierPersian, _kCFCalendarIdentifierRepublicOfChina,
_kCFChineseCalendar, _kCFCopyStringBagCallBacks, _kCFCopyStringDictionaryKeyCallBacks,
_kCFCopyStringSetCallBacks, _kCFCoreFoundationVersionNumber,
_kCFCoreFoundationVersionString, _kCFDataURLDataLength, _kCFDataURLMimeType,
_kCFDataURLTextEncodingName, _kCFDateFormatterAMSymbol, _kCFDateFormatterAMSymbolKey,
_kCFDateFormatterAmbiguousYearStrategyKey, _kCFDateFormatterCalendar,
_kCFDateFormatterCalendarIdentifier, _kCFDateFormatterCalendarIdentifierKey,
_kCFDateFormatterCalendarKey, _kCFDateFormatterCalendarName,
_kCFDateFormatterDefaultDate, _kCFDateFormatterDefaultDateKey,
_kCFDateFormatterDefaultFormat, _kCFDateFormatterDefaultFormatKey,
_kCFDateFormatterDoesRelativeDateFormattingKey, _kCFDateFormatterEraSymbols,
_kCFDateFormatterEraSymbolsKey, _kCFDateFormatterGregorianStartDate,
_kCFDateFormatterGregorianStartDateKey, _kCFDateFormatterIsLenient,
_kCFDateFormatterIsLenientKey, _kCFDateFormatterLongEraSymbols,
_kCFDateFormatterLongEraSymbolsKey, _kCFDateFormatterMonthSymbols,
_kCFDateFormatterMonthSymbolsKey, _kCFDateFormatterPMSymbol,
_kCFDateFormatterPMSymbolKey, _kCFDateFormatterPatternCharacterKey,
_kCFDateFormatterPatternLiteralKey, _kCFDateFormatterPatternRangeKey,
_kCFDateFormatterPatternStringKey, _kCFDateFormatterQuarterSymbols,
_kCFDateFormatterQuarterSymbolsKey, _kCFDateFormatterShortMonthSymbols,
_kCFDateFormatterShortMonthSymbolsKey, _kCFDateFormatterShortQuarterSymbols,
_kCFDateFormatterShortQuarterSymbolsKey, _kCFDateFormatterShortStandaloneMonthSymbols,
_kCFDateFormatterShortStandaloneMonthSymbolsKey, _kCFDateFormatterShortStandaloneQuarterSymbols,
_kCFDateFormatterShortStandaloneQuarterSymbolsKey, _kCFDateFormatterShortStandaloneWeekdaySymbols,
_kCFDateFormatterShortStandaloneWeekdaySymbolsKey, _kCFDateFormatterShortWeekdaySymbols,
_kCFDateFormatterShortWeekdaySymbolsKey, _kCFDateFormatterStandaloneMonthSymbols,
_kCFDateFormatterStandaloneMonthSymbolsKey, _kCFDateFormatterStandaloneQuarterSymbols,
_kCFDateFormatterStandaloneQuarterSymbolsKey, _kCFDateFormatterStandaloneWeekdaySymbols,
_kCFDateFormatterStandaloneWeekdaySymbolsKey, _kCFDateFormatterTimeZone,
_kCFDateFormatterTimeZoneKey, _kCFDateFormatterTwoDigitStartDate,
_kCFDateFormatterTwoDigitStartDateKey, _kCFDateFormatterUsesCharacterDirection,
_kCFDateFormatterUsesCharacterDirectionKey, _kCFDateFormatterVeryShortMonthSymbols,
_kCFDateFormatterVeryShortMonthSymbolsKey, _kCFDateFormatterVeryShortStandaloneMonthSymbols,
_kCFDateFormatterVeryShortStandaloneMonthSymbolsKey, _kCFDateFormatterVeryShortStandaloneWeekdaySymbols,
_kCFDateFormatterVeryShortStandaloneWeekdaySymbolsKey, _kCFDateFormatterVeryShortWeekdaySymbols,
_kCFDateFormatterVeryShortWeekdaySymbolsKey, _kCFDateFormatterWeekdaySymbols,
_kCFDateFormatterWeekdaySymbolsKey, _kCFEmptyString, _kCFErrorDebugDescriptionKey,
_kCFErrorDescriptionKey, _kCFErrorDomainCocoa, _kCFErrorDomainCoreFoundation,
_kCFErrorDomainMach, _kCFErrorDomainOSStatus, _kCFErrorDomainPOSIX,
_kCFErrorFilePathKey, _kCFErrorLocalizedDescriptionKey, _kCFErrorLocalizedFailureKey,
_kCFErrorLocalizedFailureReasonKey, _kCFErrorLocalizedRecoverySuggestionKey,
_kCFErrorURLKey, _kCFErrorUnderlyingErrorKey, _kCFFileURLDirectoryContents,
_kCFFileURLExists, _kCFFileURLLastModificationTime, _kCFFileURLPOSIXMode,
_kCFFileURLSize, _kCFGregorianCalendar, _kCFHTTPURLStatusCode,
_kCFHTTPURLStatusLine, _kCFHebrewCalendar, _kCFISO8601Calendar,
_kCFIndianCalendar, _kCFIslamicCalendar, _kCFIslamicCivilCalendar,
_kCFIslamicTabularCalendar, _kCFIslamicUmmAlQuraCalendar,
_kCFJapaneseCalendar, _kCFLocaleAlternateQuotationBeginDelimiterKey,
_kCFLocaleAlternateQuotationEndDelimiterKey, _kCFLocaleCalendar,
_kCFLocaleCalendarIdentifier, _kCFLocaleCalendarIdentifierKey,
_kCFLocaleCalendarKey, _kCFLocaleCollationIdentifier, _kCFLocaleCollationIdentifierKey,
_kCFLocaleCollatorIdentifier, _kCFLocaleCollatorIdentifierKey,
_kCFLocaleCountryCode, _kCFLocaleCountryCodeKey, _kCFLocaleCurrencyCode,
_kCFLocaleCurrencyCodeKey, _kCFLocaleCurrencySymbol, _kCFLocaleCurrencySymbolKey,
_kCFLocaleCurrentLocaleDidChangeNotification, _kCFLocaleDecimalSeparator,
_kCFLocaleDecimalSeparatorKey, _kCFLocaleExemplarCharacterSet,
_kCFLocaleExemplarCharacterSetKey, _kCFLocaleGroupingSeparator,
_kCFLocaleGroupingSeparatorKey, _kCFLocaleIdentifier, _kCFLocaleIdentifierKey,
_kCFLocaleLanguageCode, _kCFLocaleLanguageCodeKey, _kCFLocaleMeasurementSystem,
_kCFLocaleMeasurementSystemKey, _kCFLocaleMeasurementSystemMetric,
_kCFLocaleMeasurementSystemPreferencesChangedNotification,
_kCFLocaleMeasurementSystemUK, _kCFLocaleMeasurementSystemUS,
_kCFLocaleQuotationBeginDelimiterKey, _kCFLocaleQuotationEndDelimiterKey,
_kCFLocaleScriptCode, _kCFLocaleScriptCodeKey, _kCFLocaleTemperatureUnit,
_kCFLocaleTemperatureUnitCelsius, _kCFLocaleTemperatureUnitFahrenheit,
_kCFLocaleTemperatureUnitKey, _kCFLocaleTemperatureUnitPreferencesChangedNotification,
_kCFLocaleUsesMetricSystem, _kCFLocaleUsesMetricSystemKey,
_kCFLocaleVariantCode, _kCFLocaleVariantCodeKey, _kCFManagedPreferencesMCXNotificationName,
_kCFManagedPreferencesMCXObjectName, _kCFNotificationAnyName,
_kCFNotificationAnyObject, _kCFNotificationAnyObserver, _kCFNull,
_kCFNumberFormatterAlwaysShowDecimalSeparator, _kCFNumberFormatterAlwaysShowDecimalSeparatorKey,
_kCFNumberFormatterCurrencyCode, _kCFNumberFormatterCurrencyCodeKey,
_kCFNumberFormatterCurrencyDecimalSeparator, _kCFNumberFormatterCurrencyDecimalSeparatorKey,
_kCFNumberFormatterCurrencyGroupingSeparator, _kCFNumberFormatterCurrencyGroupingSeparatorKey,
_kCFNumberFormatterCurrencySymbol, _kCFNumberFormatterCurrencySymbolKey,
_kCFNumberFormatterDecimalSeparator, _kCFNumberFormatterDecimalSeparatorKey,
_kCFNumberFormatterDefaultFormat, _kCFNumberFormatterDefaultFormatKey,
_kCFNumberFormatterExponentSymbol, _kCFNumberFormatterExponentSymbolKey,
_kCFNumberFormatterFormatWidth, _kCFNumberFormatterFormatWidthKey,
_kCFNumberFormatterGroupingSeparator, _kCFNumberFormatterGroupingSeparatorKey,
_kCFNumberFormatterGroupingSize, _kCFNumberFormatterGroupingSizeKey,
_kCFNumberFormatterInfinitySymbol, _kCFNumberFormatterInfinitySymbolKey,
_kCFNumberFormatterInternationalCurrencySymbol, _kCFNumberFormatterInternationalCurrencySymbolKey,
_kCFNumberFormatterIsLenient, _kCFNumberFormatterIsLenientKey,
_kCFNumberFormatterMaxFractionDigits, _kCFNumberFormatterMaxFractionDigitsKey,
_kCFNumberFormatterMaxIntegerDigits, _kCFNumberFormatterMaxIntegerDigitsKey,
_kCFNumberFormatterMaxSignificantDigits, _kCFNumberFormatterMaxSignificantDigitsKey,
_kCFNumberFormatterMinFractionDigits, _kCFNumberFormatterMinFractionDigitsKey,
_kCFNumberFormatterMinIntegerDigits, _kCFNumberFormatterMinIntegerDigitsKey,
_kCFNumberFormatterMinSignificantDigits, _kCFNumberFormatterMinSignificantDigitsKey,
_kCFNumberFormatterMinusSign, _kCFNumberFormatterMinusSignKey,
_kCFNumberFormatterMultiplier, _kCFNumberFormatterMultiplierKey,
_kCFNumberFormatterNaNSymbol, _kCFNumberFormatterNaNSymbolKey,
_kCFNumberFormatterNegativePrefix, _kCFNumberFormatterNegativePrefixKey,
_kCFNumberFormatterNegativeSuffix, _kCFNumberFormatterNegativeSuffixKey,
_kCFNumberFormatterPaddingCharacter, _kCFNumberFormatterPaddingCharacterKey,
_kCFNumberFormatterPaddingPosition, _kCFNumberFormatterPaddingPositionKey,
_kCFNumberFormatterPerMillSymbol, _kCFNumberFormatterPerMillSymbolKey,
_kCFNumberFormatterPercentSymbol, _kCFNumberFormatterPercentSymbolKey,
_kCFNumberFormatterPlusSign, _kCFNumberFormatterPlusSignKey,
_kCFNumberFormatterPositivePrefix, _kCFNumberFormatterPositivePrefixKey,
_kCFNumberFormatterPositiveSuffix, _kCFNumberFormatterPositiveSuffixKey,
_kCFNumberFormatterRoundingIncrement, _kCFNumberFormatterRoundingIncrementKey,
_kCFNumberFormatterRoundingMode, _kCFNumberFormatterRoundingModeKey,
_kCFNumberFormatterSecondaryGroupingSize, _kCFNumberFormatterSecondaryGroupingSizeKey,
_kCFNumberFormatterUseGroupingSeparator, _kCFNumberFormatterUseGroupingSeparatorKey,
_kCFNumberFormatterUseSignificantDigits, _kCFNumberFormatterUseSignificantDigitsKey,
_kCFNumberFormatterUsesCharacterDirection, _kCFNumberFormatterUsesCharacterDirectionKey,
_kCFNumberFormatterZeroSymbol, _kCFNumberFormatterZeroSymbolKey,
_kCFNumberNaN, _kCFNumberNegativeInfinity, _kCFNumberPositiveInfinity,
_kCFPasteboardFind, _kCFPasteboardGeneral, _kCFPasteboardSecurityScopeFlavor,
_kCFPersianCalendar, _kCFPlugInDynamicRegisterFunctionKey,
_kCFPlugInDynamicRegistrationKey, _kCFPlugInFactoriesKey,
_kCFPlugInTypesKey, _kCFPlugInUnloadFunctionKey, _kCFPreferencesAnyApplication,
_kCFPreferencesAnyHost, _kCFPreferencesAnyUser, _kCFPreferencesByteCountLimitReachedNotificationName,
_kCFPreferencesCurrentApplication, _kCFPreferencesCurrentHost,
_kCFPreferencesCurrentUser, _kCFPreferencesDidChangeNotificationName,
_kCFPreferencesDidChangeObject, _kCFPreferencesWebServicesProviderChangedNotificationName,
_kCFPreferencesWebServicesProviderTypeImageSearch, _kCFPreferencesWebServicesProviderTypeMap,
_kCFPreferencesWebServicesProviderTypeWebSearch, _kCFRepublicOfChinaCalendar,
_kCFRunLoopCommonModes, _kCFRunLoopDefaultMode, _kCFServiceControllerCFPreferencesAppIdentifier,
_kCFServiceControllerServicesChangedNotification, _kCFSocketCommandKey,
_kCFSocketErrorKey, _kCFSocketNameKey, _kCFSocketRegisterCommand,
_kCFSocketResultKey, _kCFSocketRetrieveCommand, _kCFSocketValueKey,
_kCFStreamErrorDomainSOCKS, _kCFStreamErrorDomainSSL, _kCFStreamPropertyAppendToFile,
_kCFStreamPropertyAutoErrorOnSystemChange, _kCFStreamPropertyDataWritten,
_kCFStreamPropertyFileCurrentOffset, _kCFStreamPropertySOCKSPassword,
_kCFStreamPropertySOCKSProxy, _kCFStreamPropertySOCKSProxyHost,
_kCFStreamPropertySOCKSProxyPort, _kCFStreamPropertySOCKSUser,
_kCFStreamPropertySOCKSVersion, _kCFStreamPropertyShouldCloseNativeSocket,
_kCFStreamPropertySocketNativeHandle, _kCFStreamPropertySocketRemoteHostName,
_kCFStreamPropertySocketRemotePortNumber, _kCFStreamPropertySocketSSLContext,
_kCFStreamPropertySocketSecurityLevel, _kCFStreamSocketSOCKSVersion4,
_kCFStreamSocketSOCKSVersion5, _kCFStreamSocketSecurityLevelNegotiatedSSL,
_kCFStreamSocketSecurityLevelNone, _kCFStreamSocketSecurityLevelSSLv2,
_kCFStreamSocketSecurityLevelSSLv3, _kCFStreamSocketSecurityLevelTLSv1,
_kCFStringAffixRuleType, _kCFStringBinaryHeapCallBacks, _kCFStringDeviceSpecificRuleType,
_kCFStringDirectRuleType, _kCFStringEntityFormattingRuleType,
_kCFStringFormatClassInfoKey, _kCFStringFormatClassTypeKey,
_kCFStringFormatContainsAttributedMarkupKey, _kCFStringFormatDefaultValueKey,
_kCFStringFormatFamilyInfoKey, _kCFStringFormatIsMarkdownKey,
_kCFStringFormatLocaleInfoKey, _kCFStringFormatLocaleKey,
_kCFStringFormatLocalizationKey, _kCFStringFormatRuleInfoKey,
_kCFStringFormatSpecTypeKey, _kCFStringFormatValueTypeKey,
_kCFStringGenderRuleType, _kCFStringLocalizedFormatKey, _kCFStringPluralRuleType,
_kCFStringTransformFullwidthHalfwidth, _kCFStringTransformHiraganaKatakana,
_kCFStringTransformLatinArabic, _kCFStringTransformLatinCyrillic,
_kCFStringTransformLatinGreek, _kCFStringTransformLatinHangul,
_kCFStringTransformLatinHebrew, _kCFStringTransformLatinHiragana,
_kCFStringTransformLatinKatakana, _kCFStringTransformLatinThai,
_kCFStringTransformMandarinLatin, _kCFStringTransformStripCombiningMarks,
_kCFStringTransformStripDiacritics, _kCFStringTransformToLatin,
_kCFStringTransformToUnicodeName, _kCFStringTransformToXMLHex,
_kCFStringVariableWidthRuleType, _kCFStringVerbatimRuleType,
_kCFStringVocativeNameFormattingRuleType, _kCFThumbnail1024x1024SizeKey,
_kCFTimeZoneSystemTimeZoneDidChangeNotification, _kCFTypeArrayCallBacks,
_kCFTypeBagCallBacks, _kCFTypeDictionaryKeyCallBacks, _kCFTypeDictionaryValueCallBacks,
_kCFTypeSetCallBacks, _kCFURLAddedToDirectoryDateKey, _kCFURLApplicationIsScriptableKey,
_kCFURLAttributeModificationDateKey, _kCFURLBookmarkFileProviderStringKey,
_kCFURLBookmarkOriginalPathKey, _kCFURLBookmarkOriginalRelativePathComponentsArrayKey,
_kCFURLBookmarkOriginalRelativePathKey, _kCFURLBookmarkOriginalVolumeCreationDateKey,
_kCFURLBookmarkOriginalVolumeNameKey, _kCFURLCanonicalPathKey,
_kCFURLContentAccessDateKey, _kCFURLContentModificationDateKey,
_kCFURLCreationDateKey, _kCFURLCustomIconKey, _kCFURLDocumentIdentifierKey,
_kCFURLEffectiveIconKey, _kCFURLFileAllocatedSizeKey, _kCFURLFileContentIdentifierKey,
_kCFURLFileDirectoryContents, _kCFURLFileExists, _kCFURLFileLastModificationTime,
_kCFURLFileLength, _kCFURLFileOwnerID, _kCFURLFilePOSIXMode,
_kCFURLFileProtectionComplete, _kCFURLFileProtectionCompleteUnlessOpen,
_kCFURLFileProtectionCompleteUntilFirstUserAuthentication,
_kCFURLFileProtectionKey, _kCFURLFileProtectionNone, _kCFURLFileResourceIdentifierKey,
_kCFURLFileResourceTypeBlockSpecial, _kCFURLFileResourceTypeCharacterSpecial,
_kCFURLFileResourceTypeDirectory, _kCFURLFileResourceTypeKey,
_kCFURLFileResourceTypeNamedPipe, _kCFURLFileResourceTypeRegular,
_kCFURLFileResourceTypeSocket, _kCFURLFileResourceTypeSymbolicLink,
_kCFURLFileResourceTypeUnknown, _kCFURLFileSecurityKey, _kCFURLFileSizeKey,
_kCFURLGenerationIdentifierKey, _kCFURLHTTPStatusCode, _kCFURLHTTPStatusLine,
_kCFURLHasHiddenExtensionKey, _kCFURLIsAliasFileKey, _kCFURLIsApplicationKey,
_kCFURLIsDirectoryKey, _kCFURLIsExcludedFromBackupKey, _kCFURLIsExecutableKey,
_kCFURLIsHiddenKey, _kCFURLIsMountTriggerKey, _kCFURLIsPackageKey,
_kCFURLIsPurgeableKey, _kCFURLIsReadableKey, _kCFURLIsRegularFileKey,
_kCFURLIsSparseKey, _kCFURLIsSymbolicLinkKey, _kCFURLIsSystemImmutableKey,
_kCFURLIsUbiquitousItemKey, _kCFURLIsUserImmutableKey, _kCFURLIsVolumeKey,
_kCFURLIsWritableKey, _kCFURLKeysOfUnsetValuesKey, _kCFURLLabelColorKey,
_kCFURLLabelNumberKey, _kCFURLLinkCountKey, _kCFURLLocalizedLabelKey,
_kCFURLLocalizedNameKey, _kCFURLLocalizedTypeDescriptionKey,
_kCFURLMayHaveExtendedAttributesKey, _kCFURLMayShareFileContentKey,
_kCFURLNameKey, _kCFURLParentDirectoryURLKey, _kCFURLPathKey,
_kCFURLPreferredIOBlockSizeKey, _kCFURLQuarantinePropertiesKey,
_kCFURLTagNamesKey, _kCFURLThumbnailDictionaryKey, _kCFURLThumbnailKey,
_kCFURLTotalFileAllocatedSizeKey, _kCFURLTotalFileSizeKey,
_kCFURLTypeIdentifierKey, _kCFURLUbiquitousItemContainerDisplayNameKey,
_kCFURLUbiquitousItemDownloadRequestedKey, _kCFURLUbiquitousItemDownloadingErrorKey,
_kCFURLUbiquitousItemDownloadingStatusCurrent, _kCFURLUbiquitousItemDownloadingStatusDownloaded,
_kCFURLUbiquitousItemDownloadingStatusKey, _kCFURLUbiquitousItemDownloadingStatusNotDownloaded,
_kCFURLUbiquitousItemHasUnresolvedConflictsKey, _kCFURLUbiquitousItemIsDownloadedKey,
_kCFURLUbiquitousItemIsDownloadingKey, _kCFURLUbiquitousItemIsExcludedFromSyncKey,
_kCFURLUbiquitousItemIsSharedKey, _kCFURLUbiquitousItemIsUploadedKey,
_kCFURLUbiquitousItemIsUploadingKey, _kCFURLUbiquitousItemPercentDownloadedKey,
_kCFURLUbiquitousItemPercentUploadedKey, _kCFURLUbiquitousItemUploadingErrorKey,
_kCFURLUbiquitousSharedItemCurrentUserPermissionsKey, _kCFURLUbiquitousSharedItemCurrentUserRoleKey,
_kCFURLUbiquitousSharedItemMostRecentEditorNameComponentsKey,
_kCFURLUbiquitousSharedItemOwnerNameComponentsKey, _kCFURLUbiquitousSharedItemOwnerNameKey,
_kCFURLUbiquitousSharedItemPermissionsKey, _kCFURLUbiquitousSharedItemPermissionsReadOnly,
_kCFURLUbiquitousSharedItemPermissionsReadWrite, _kCFURLUbiquitousSharedItemReadOnlyPermissions,
_kCFURLUbiquitousSharedItemReadWritePermissions, _kCFURLUbiquitousSharedItemRoleKey,
_kCFURLUbiquitousSharedItemRoleOwner, _kCFURLUbiquitousSharedItemRoleParticipant,
_kCFURLVolumeAvailableCapacityForImportantUsageKey, _kCFURLVolumeAvailableCapacityForOpportunisticUsageKey,
_kCFURLVolumeAvailableCapacityKey, _kCFURLVolumeCreationDateKey,
_kCFURLVolumeIdentifierKey, _kCFURLVolumeIsAutomountedKey,
_kCFURLVolumeIsBrowsableKey, _kCFURLVolumeIsEjectableKey,
_kCFURLVolumeIsEncryptedKey, _kCFURLVolumeIsInternalKey, _kCFURLVolumeIsJournalingKey,
_kCFURLVolumeIsLocalKey, _kCFURLVolumeIsReadOnlyKey, _kCFURLVolumeIsRemovableKey,
_kCFURLVolumeIsRootFileSystemKey, _kCFURLVolumeLocalizedFormatDescriptionKey,
_kCFURLVolumeLocalizedNameKey, _kCFURLVolumeMaximumFileSizeKey,
_kCFURLVolumeNameKey, _kCFURLVolumeResourceCountKey, _kCFURLVolumeSupportsAccessPermissionsKey,
_kCFURLVolumeSupportsAdvisoryFileLockingKey, _kCFURLVolumeSupportsCasePreservedNamesKey,
_kCFURLVolumeSupportsCaseSensitiveNamesKey, _kCFURLVolumeSupportsCompressionKey,
_kCFURLVolumeSupportsExclusiveRenamingKey, _kCFURLVolumeSupportsExtendedSecurityKey,
_kCFURLVolumeSupportsFileCloningKey, _kCFURLVolumeSupportsFileProtectionKey,
_kCFURLVolumeSupportsHardLinksKey, _kCFURLVolumeSupportsImmutableFilesKey,
_kCFURLVolumeSupportsJournalingKey, _kCFURLVolumeSupportsPersistentIDsKey,
_kCFURLVolumeSupportsRenamingKey, _kCFURLVolumeSupportsRootDirectoryDatesKey,
_kCFURLVolumeSupportsSparseFilesKey, _kCFURLVolumeSupportsSwapRenamingKey,
_kCFURLVolumeSupportsSymbolicLinksKey, _kCFURLVolumeSupportsVolumeSizesKey,
_kCFURLVolumeSupportsZeroRunsKey, _kCFURLVolumeTotalCapacityKey,
_kCFURLVolumeURLForRemountingKey, _kCFURLVolumeURLKey, _kCFURLVolumeUUIDStringKey,
_kCFUseCollectableAllocator, _kCFUserNotificationAlertHeaderKey,
_kCFUserNotificationAlertMessageKey, _kCFUserNotificationAlertSourceKey,
_kCFUserNotificationAlertTopMostKey, _kCFUserNotificationAlternateButtonTitleKey,
_kCFUserNotificationCheckBoxLabelsKey, _kCFUserNotificationCheckBoxTitlesKey,
_kCFUserNotificationDefaultButtonTitleKey, _kCFUserNotificationEnsureVisibilityForProcessIDKey,
_kCFUserNotificationFlagsKey, _kCFUserNotificationHelpAnchorKey,
_kCFUserNotificationHelpBookKey, _kCFUserNotificationHelpBundlePathKey,
_kCFUserNotificationHelpBundleURLKey, _kCFUserNotificationIconPathKey,
_kCFUserNotificationIconURLKey, _kCFUserNotificationKeyboardTypesKey,
_kCFUserNotificationLocalizationPathKey, _kCFUserNotificationLocalizationURLKey,
_kCFUserNotificationOtherButtonTitleKey, _kCFUserNotificationPopUpSelectionKey,
_kCFUserNotificationPopUpTitlesKey, _kCFUserNotificationProgressIndicatorValueKey,
_kCFUserNotificationSessionIDKey, _kCFUserNotificationSoundPathKey,
_kCFUserNotificationSoundURLKey, _kCFUserNotificationTextFieldLabelsKey,
_kCFUserNotificationTextFieldTitlesKey, _kCFUserNotificationTextFieldValuesKey,
_kCFUserNotificationTimeoutKey, _kCFUserNotificationTokenKey,
_kCFWebServicesProviderChangedNotificationName, _kCFWebServicesProviderDefaultDisplayNameKey,
_kCFWebServicesProviderIdentifierKey, _kCFWebServicesTypeImageSearch,
_kCFWebServicesTypeMap, _kCFWebServicesTypeWebSearch, _mdict_keysOfEntriesWithOptionsPassingTest,
_os_log_callback ]
objc-classes: [ NSArray, NSBlock, NSBlockInvocation, NSCache, NSCalendar,
NSConstantArray, NSConstantData, NSConstantDate, NSConstantDictionary,
NSData, NSDate, NSDateComponents, NSDictionary, NSEnumerator,
NSException, NSFileSecurity, NSInputStream, NSInvocation,
NSLocale, NSMethodSignature, NSMutableArray, NSMutableData,
NSMutableDictionary, NSMutableOrderedSet, NSMutableSet, NSNull,
NSOrderedSet, NSOutputStream, NSRunLoop, NSSet, NSSharedKeySet,
NSStream, NSTaggedPointerString, NSTimeZone, NSTimer, NSURL,
NSUserDefaults, _NSAutoCalendar, __NSFastEnumerationEnumerator ]
objc-eh-types: [ NSException ]
objc-ivars: [ NSConstantArray._count, NSConstantArray._objects, NSConstantData._bytes,
NSConstantData._length, NSConstantDate._ti, NSConstantDictionary._count,
NSConstantDictionary._keys, NSConstantDictionary._objects,
NSConstantDictionary._options, NSURL._baseURL, NSURL._clients,
NSURL._reserved, NSURL._urlString, _NSAutoCalendar._lock,
_NSAutoCalendar.cal, _NSAutoCalendar.changedFirstWeekday,
_NSAutoCalendar.changedGregorianStartDate, _NSAutoCalendar.changedLocale,
_NSAutoCalendar.changedMinimumDaysinFirstWeek, _NSAutoCalendar.changedTimeZone,
_NSAutoCalendar.combinedNoteCount ]
- targets: [ x86_64-macos, arm64e-macos, x86_64h-macos, arm64-macos ]
symbols: [ _CFMachPortBoostGetTypeID, _CFXMLCreateStringByEscapingEntities,
_CFXMLCreateStringByUnescapingEntities, _CFXMLNodeCreate,
_CFXMLNodeCreateCopy, _CFXMLNodeGetInfoPtr, _CFXMLNodeGetString,
_CFXMLNodeGetTypeCode, _CFXMLNodeGetTypeID, _CFXMLNodeGetVersion,
_CFXMLParserAbort, _CFXMLParserCopyErrorDescription, _CFXMLParserCreate,
_CFXMLParserCreateWithDataFromURL, _CFXMLParserGetCallBacks,
_CFXMLParserGetContext, _CFXMLParserGetDocument, _CFXMLParserGetLineNumber,
_CFXMLParserGetLocation, _CFXMLParserGetSourceURL, _CFXMLParserGetStatusCode,
_CFXMLParserGetTypeID, _CFXMLParserParse, _CFXMLTreeCreateFromData,
_CFXMLTreeCreateFromDataWithError, _CFXMLTreeCreateWithDataFromURL,
_CFXMLTreeCreateWithNode, _CFXMLTreeCreateXMLData, _CFXMLTreeGetNode,
_NSURLApplicationIsScriptableKey, _NSURLQuarantinePropertiesKey,
_NSURLTagNamesKey, __CFBundleSetMainBundle, __CFCreateURLFromFSSpec,
__CFGetFSSpecFromURL, __CFMachPortCopyCurrentBoost, __CFMachPortCreateBoost,
__CFMachPortSetOptions, __CFMessagePortSetOptions, __CFPasteboardInvalidateCache,
__CFPasteboardRemotePasteboardBecameAvailable, __CFPasteboardServerQueue,
__CFRunLoopSetCurrent, __CFStringTokenizerCreateCurrentTokenLemma,
__CFStringTokenizerSetMetadata, __CFURLCopyAliasFromPropertyListRepresentation,
__CFURLCopyExtendedPropertyListPrimitive, __CFURLCopyExtendedPropertyListRepresentation,
__CFVolumeObserverCreate, __CFVolumeObserverGetTypeID, __CFVolumeObserverGetUnmountDissenterForDisk,
__CFVolumeObserverInvalidate, __CFVolumeObserverInvalidateWithCompletionHandler,
__CFVolumeObserverSetUnmountDissenterForDisk, __CFXNotificationResetSessionForTask,
__NSURLCreateNSColorWithRGBAValues, __NSURLCreateNSImageWithIconRef,
___CFPBSPSRL, ___CFPBStart, ___CFPasteboardAdoptPboardEndpointForTest,
___CFPasteboardCreateInProcessPboardEndpointForTest, ___CFPasteboardSetRemotePasteboardClass,
___CFPasteboardSetupLock, ___CFPasteboardStartInProcessServer,
___CFPasteboardStartServicingConnection, __kCFPasteboardDrag,
__kCFPasteboardRemote, _kCFServiceControllerActivateKey, _kCFServiceControllerErrorKey,
_kCFServiceControllerMessageKey, _kCFServiceControllerPasteboardKey,
_kCFServiceControllerProviderKey, _kCFServiceControllerResultKey,
_kCFServiceControllerUserDataKey, _kCFXMLTreeErrorDescription,
_kCFXMLTreeErrorLineNumber, _kCFXMLTreeErrorLocation, _kCFXMLTreeErrorStatusCode ]
objc-ivars: [ NSMessageBuilder._addr, NSMessageBuilder._target ]
- targets: [ x86_64-macos, arm64e-macos, arm64-macos ]
symbols: [ ___CFObjCIsCollectable ]
...
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFDateFormatter.h | /* CFDateFormatter.h
Copyright (c) 2003-2019, Apple Inc. and the Swift project authors
Portions Copyright (c) 2014-2019, Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See http://swift.org/LICENSE.txt for license information
See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
*/
#if !defined(__COREFOUNDATION_CFDATEFORMATTER__)
#define __COREFOUNDATION_CFDATEFORMATTER__ 1
#include <CoreFoundation/CFBase.h>
#include <CoreFoundation/CFDate.h>
#include <CoreFoundation/CFLocale.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
typedef CFStringRef CFDateFormatterKey CF_STRING_ENUM;
typedef struct CF_BRIDGED_MUTABLE_TYPE(id) __CFDateFormatter *CFDateFormatterRef;
// CFDateFormatters are not thread-safe. Do not use one from multiple threads!
CF_EXPORT
CFStringRef CFDateFormatterCreateDateFormatFromTemplate(CFAllocatorRef allocator, CFStringRef tmplate, CFOptionFlags options, CFLocaleRef locale) API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
// no options defined, pass 0 for now
CF_EXPORT
CFTypeID CFDateFormatterGetTypeID(void);
// The exact formatted result for these date and time styles depends on the
// locale, but generally:
// Short is completely numeric, such as "12/13/52" or "3:30pm"
// Medium is longer, such as "Jan 12, 1952"
// Long is longer, such as "January 12, 1952" or "3:30:32pm"
// Full is pretty complete; e.g. "Tuesday, April 12, 1952 AD" or "3:30:42pm PST"
// The specifications though are left fuzzy, in part simply because a user's
// preference choices may affect the output, and also the results may change
// from one OS release to another. To produce an exactly formatted date you
// should not rely on styles and localization, but set the format string and
// use nothing but numbers.
typedef CF_ENUM(CFIndex, CFDateFormatterStyle) { // date and time format styles
kCFDateFormatterNoStyle = 0,
kCFDateFormatterShortStyle = 1,
kCFDateFormatterMediumStyle = 2,
kCFDateFormatterLongStyle = 3,
kCFDateFormatterFullStyle = 4
};
typedef CF_OPTIONS(CFOptionFlags, CFISO8601DateFormatOptions) {
/* The format for year is inferred based on whether or not the week of year option is specified.
- if week of year is present, "YYYY" is used to display week dates.
- if week of year is not present, "yyyy" is used by default.
*/
kCFISO8601DateFormatWithYear API_AVAILABLE(macosx(10.12), ios(10.0), watchos(3.0), tvos(10.0)) = (1UL << 0),
kCFISO8601DateFormatWithMonth API_AVAILABLE(macosx(10.12), ios(10.0), watchos(3.0), tvos(10.0)) = (1UL << 1),
kCFISO8601DateFormatWithWeekOfYear API_AVAILABLE(macosx(10.12), ios(10.0), watchos(3.0), tvos(10.0)) = (1UL << 2), // This includes the "W" prefix (e.g. "W49")
/* The format for day is inferred based on provided options.
- if month is not present, day of year ("DDD") is used.
- if month is present, day of month ("dd") is used.
- if either weekOfMonth or weekOfYear is present, local day of week ("ee") is used.
*/
kCFISO8601DateFormatWithDay API_AVAILABLE(macosx(10.12), ios(10.0), watchos(3.0), tvos(10.0)) = (1UL << 4),
kCFISO8601DateFormatWithTime API_AVAILABLE(macosx(10.12), ios(10.0), watchos(3.0), tvos(10.0)) = (1UL << 5), // This uses the format "HHmmss"
kCFISO8601DateFormatWithTimeZone API_AVAILABLE(macosx(10.12), ios(10.0), watchos(3.0), tvos(10.0)) = (1UL << 6),
kCFISO8601DateFormatWithSpaceBetweenDateAndTime API_AVAILABLE(macosx(10.12), ios(10.0), watchos(3.0), tvos(10.0)) = (1UL << 7), // Use space instead of "T"
kCFISO8601DateFormatWithDashSeparatorInDate API_AVAILABLE(macosx(10.12), ios(10.0), watchos(3.0), tvos(10.0)) = (1UL << 8), // Add separator for date ("-")
kCFISO8601DateFormatWithColonSeparatorInTime API_AVAILABLE(macosx(10.12), ios(10.0), watchos(3.0), tvos(10.0)) = (1UL << 9), // Add separator for time (":")
kCFISO8601DateFormatWithColonSeparatorInTimeZone API_AVAILABLE(macosx(10.12), ios(10.0), watchos(3.0), tvos(10.0)) = (1UL << 10), // Add ":" separator in timezone (eg. +08:00)
kCFISO8601DateFormatWithFractionalSeconds API_AVAILABLE(macosx(10.13), ios(11.0), watchos(4.0), tvos(11.0)) = (1UL << 11), // Add 3 significant digits of fractional seconds (".SSS")
kCFISO8601DateFormatWithFullDate API_AVAILABLE(macosx(10.12), ios(10.0), watchos(3.0), tvos(10.0)) = kCFISO8601DateFormatWithYear | kCFISO8601DateFormatWithMonth | kCFISO8601DateFormatWithDay | kCFISO8601DateFormatWithDashSeparatorInDate,
kCFISO8601DateFormatWithFullTime API_AVAILABLE(macosx(10.12), ios(10.0), watchos(3.0), tvos(10.0)) = kCFISO8601DateFormatWithTime | kCFISO8601DateFormatWithColonSeparatorInTime | kCFISO8601DateFormatWithTimeZone | kCFISO8601DateFormatWithColonSeparatorInTimeZone,
kCFISO8601DateFormatWithInternetDateTime API_AVAILABLE(macosx(10.12), ios(10.0), watchos(3.0), tvos(10.0)) = kCFISO8601DateFormatWithFullDate | kCFISO8601DateFormatWithFullTime, // RFC3339
};
CF_EXPORT
CFDateFormatterRef CFDateFormatterCreateISO8601Formatter(CFAllocatorRef allocator, CFISO8601DateFormatOptions formatOptions) API_AVAILABLE(macosx(10.12), ios(10.0), watchos(3.0), tvos(10.0));
CF_EXPORT
CFDateFormatterRef CFDateFormatterCreate(CFAllocatorRef allocator, CFLocaleRef locale, CFDateFormatterStyle dateStyle, CFDateFormatterStyle timeStyle);
// Returns a CFDateFormatter, localized to the given locale, which
// will format dates to the given date and time styles.
CF_EXPORT
CFLocaleRef CFDateFormatterGetLocale(CFDateFormatterRef formatter);
CF_EXPORT
CFDateFormatterStyle CFDateFormatterGetDateStyle(CFDateFormatterRef formatter);
CF_EXPORT
CFDateFormatterStyle CFDateFormatterGetTimeStyle(CFDateFormatterRef formatter);
// Get the properties with which the date formatter was created.
CF_EXPORT
CFStringRef CFDateFormatterGetFormat(CFDateFormatterRef formatter);
CF_EXPORT
void CFDateFormatterSetFormat(CFDateFormatterRef formatter, CFStringRef formatString);
// Set the format description string of the date formatter. This
// overrides the style settings. The format of the format string
// is as defined by the ICU library. The date formatter starts with a
// default format string defined by the style arguments with
// which it was created.
CF_EXPORT
CFStringRef CFDateFormatterCreateStringWithDate(CFAllocatorRef allocator, CFDateFormatterRef formatter, CFDateRef date);
CF_EXPORT
CFStringRef CFDateFormatterCreateStringWithAbsoluteTime(CFAllocatorRef allocator, CFDateFormatterRef formatter, CFAbsoluteTime at);
// Create a string representation of the given date or CFAbsoluteTime
// using the current state of the date formatter.
CF_EXPORT
CFDateRef CFDateFormatterCreateDateFromString(CFAllocatorRef allocator, CFDateFormatterRef formatter, CFStringRef string, CFRange *rangep);
CF_EXPORT
Boolean CFDateFormatterGetAbsoluteTimeFromString(CFDateFormatterRef formatter, CFStringRef string, CFRange *rangep, CFAbsoluteTime *atp);
// Parse a string representation of a date using the current state
// of the date formatter. The range parameter specifies the range
// of the string in which the parsing should occur in input, and on
// output indicates the extent that was used; this parameter can
// be NULL, in which case the whole string may be used. The
// return value indicates whether some date was computed and
// (if atp is not NULL) stored at the location specified by atp.
CF_EXPORT
void CFDateFormatterSetProperty(CFDateFormatterRef formatter, CFStringRef key, CFTypeRef value);
CF_EXPORT
CFTypeRef CFDateFormatterCopyProperty(CFDateFormatterRef formatter, CFDateFormatterKey key);
// Set and get various properties of the date formatter, the set of
// which may be expanded in the future.
CF_EXPORT const CFDateFormatterKey kCFDateFormatterIsLenient; // CFBoolean
CF_EXPORT const CFDateFormatterKey kCFDateFormatterTimeZone; // CFTimeZone
CF_EXPORT const CFDateFormatterKey kCFDateFormatterCalendarName; // CFString
CF_EXPORT const CFDateFormatterKey kCFDateFormatterDefaultFormat; // CFString
CF_EXPORT const CFDateFormatterKey kCFDateFormatterTwoDigitStartDate; // CFDate
CF_EXPORT const CFDateFormatterKey kCFDateFormatterDefaultDate; // CFDate
CF_EXPORT const CFDateFormatterKey kCFDateFormatterCalendar; // CFCalendar
CF_EXPORT const CFDateFormatterKey kCFDateFormatterEraSymbols; // CFArray of CFString
CF_EXPORT const CFDateFormatterKey kCFDateFormatterMonthSymbols; // CFArray of CFString
CF_EXPORT const CFDateFormatterKey kCFDateFormatterShortMonthSymbols; // CFArray of CFString
CF_EXPORT const CFDateFormatterKey kCFDateFormatterWeekdaySymbols; // CFArray of CFString
CF_EXPORT const CFDateFormatterKey kCFDateFormatterShortWeekdaySymbols; // CFArray of CFString
CF_EXPORT const CFDateFormatterKey kCFDateFormatterAMSymbol; // CFString
CF_EXPORT const CFDateFormatterKey kCFDateFormatterPMSymbol; // CFString
CF_EXPORT const CFDateFormatterKey kCFDateFormatterLongEraSymbols API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)); // CFArray of CFString
CF_EXPORT const CFDateFormatterKey kCFDateFormatterVeryShortMonthSymbols API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)); // CFArray of CFString
CF_EXPORT const CFDateFormatterKey kCFDateFormatterStandaloneMonthSymbols API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)); // CFArray of CFString
CF_EXPORT const CFDateFormatterKey kCFDateFormatterShortStandaloneMonthSymbols API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)); // CFArray of CFString
CF_EXPORT const CFDateFormatterKey kCFDateFormatterVeryShortStandaloneMonthSymbols API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)); // CFArray of CFString
CF_EXPORT const CFDateFormatterKey kCFDateFormatterVeryShortWeekdaySymbols API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)); // CFArray of CFString
CF_EXPORT const CFDateFormatterKey kCFDateFormatterStandaloneWeekdaySymbols API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)); // CFArray of CFString
CF_EXPORT const CFDateFormatterKey kCFDateFormatterShortStandaloneWeekdaySymbols API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)); // CFArray of CFString
CF_EXPORT const CFDateFormatterKey kCFDateFormatterVeryShortStandaloneWeekdaySymbols API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)); // CFArray of CFString
CF_EXPORT const CFDateFormatterKey kCFDateFormatterQuarterSymbols API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)); // CFArray of CFString
CF_EXPORT const CFDateFormatterKey kCFDateFormatterShortQuarterSymbols API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)); // CFArray of CFString
CF_EXPORT const CFDateFormatterKey kCFDateFormatterStandaloneQuarterSymbols API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)); // CFArray of CFString
CF_EXPORT const CFDateFormatterKey kCFDateFormatterShortStandaloneQuarterSymbols API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)); // CFArray of CFString
CF_EXPORT const CFDateFormatterKey kCFDateFormatterGregorianStartDate API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)); // CFDate
CF_EXPORT const CFDateFormatterKey kCFDateFormatterDoesRelativeDateFormattingKey API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0)); // CFBoolean
// See CFLocale.h for these calendar constants:
// const CFStringRef kCFGregorianCalendar;
// const CFStringRef kCFBuddhistCalendar;
// const CFStringRef kCFJapaneseCalendar;
// const CFStringRef kCFIslamicCalendar;
// const CFStringRef kCFIslamicCivilCalendar;
// const CFStringRef kCFHebrewCalendar;
// const CFStringRef kCFChineseCalendar;
// const CFStringRef kCFRepublicOfChinaCalendar;
// const CFStringRef kCFPersianCalendar;
// const CFStringRef kCFIndianCalendar;
// const CFStringRef kCFISO8601Calendar;
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif /* ! __COREFOUNDATION_CFDATEFORMATTER__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFSet.h | /* CFSet.h
Copyright (c) 1998-2019, Apple Inc. and the Swift project authors
Portions Copyright (c) 2014-2019, Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See http://swift.org/LICENSE.txt for license information
See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
*/
/*!
@header CFSet
CFSet implements a container which stores unique values.
*/
#if !defined(__COREFOUNDATION_CFSET__)
#define __COREFOUNDATION_CFSET__ 1
#include <CoreFoundation/CFBase.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
/*!
@typedef CFSetRetainCallBack
Type of the callback function used by CFSets for retaining values.
@param allocator The allocator of the CFSet.
@param value The value to retain.
@result The value to store in the set, which is usually the value
parameter passed to this callback, but may be a different
value if a different value should be stored in the set.
*/
typedef const void * (*CFSetRetainCallBack)(CFAllocatorRef allocator, const void *value);
/*!
@typedef CFSetReleaseCallBack
Type of the callback function used by CFSets for releasing a retain on values.
@param allocator The allocator of the CFSet.
@param value The value to release.
*/
typedef void (*CFSetReleaseCallBack)(CFAllocatorRef allocator, const void *value);
/*!
@typedef CFSetCopyDescriptionCallBack
Type of the callback function used by CFSets for describing values.
@param value The value to describe.
@result A description of the specified value.
*/
typedef CFStringRef (*CFSetCopyDescriptionCallBack)(const void *value);
/*!
@typedef CFSetEqualCallBack
Type of the callback function used by CFSets for comparing values.
@param value1 The first value to compare.
@param value2 The second value to compare.
@result True if the values are equal, otherwise false.
*/
typedef Boolean (*CFSetEqualCallBack)(const void *value1, const void *value2);
/*!
@typedef CFSetHashCallBack
Type of the callback function used by CFSets for hashing values.
@param value The value to hash.
@result The hash of the value.
*/
typedef CFHashCode (*CFSetHashCallBack)(const void *value);
/*!
@typedef CFSetCallBacks
Structure containing the callbacks of a CFSet.
@field version The version number of the structure type being passed
in as a parameter to the CFSet creation functions. This
structure is version 0.
@field retain The callback used to add a retain for the set on
values as they are put into the set. This callback returns
the value to store in the set, which is usually the value
parameter passed to this callback, but may be a different
value if a different value should be stored in the set.
The set's allocator is passed as the first argument.
@field release The callback used to remove a retain previously added
for the set from values as they are removed from the
set. The set's allocator is passed as the first
argument.
@field copyDescription The callback used to create a descriptive
string representation of each value in the set. This is
used by the CFCopyDescription() function.
@field equal The callback used to compare values in the set for
equality for some operations.
@field hash The callback used to compare values in the set for
uniqueness for some operations.
*/
typedef struct {
CFIndex version;
CFSetRetainCallBack retain;
CFSetReleaseCallBack release;
CFSetCopyDescriptionCallBack copyDescription;
CFSetEqualCallBack equal;
CFSetHashCallBack hash;
} CFSetCallBacks;
/*!
@constant kCFTypeSetCallBacks
Predefined CFSetCallBacks structure containing a set of callbacks
appropriate for use when the values in a CFSet are all CFTypes.
*/
CF_EXPORT
const CFSetCallBacks kCFTypeSetCallBacks;
/*!
@constant kCFCopyStringSetCallBacks
Predefined CFSetCallBacks structure containing a set of callbacks
appropriate for use when the values in a CFSet should be copies
of a CFString.
*/
CF_EXPORT
const CFSetCallBacks kCFCopyStringSetCallBacks;
/*!
@typedef CFSetApplierFunction
Type of the callback function used by the apply functions of
CFSets.
@param value The current value from the set.
@param context The user-defined context parameter given to the apply
function.
*/
typedef void (*CFSetApplierFunction)(const void *value, void *context);
/*!
@typedef CFSetRef
This is the type of a reference to immutable CFSets.
*/
typedef const struct CF_BRIDGED_TYPE(NSSet) __CFSet * CFSetRef;
/*!
@typedef CFMutableSetRef
This is the type of a reference to mutable CFSets.
*/
typedef struct CF_BRIDGED_MUTABLE_TYPE(NSMutableSet) __CFSet * CFMutableSetRef;
/*!
@function CFSetGetTypeID
Returns the type identifier of all CFSet instances.
*/
CF_EXPORT
CFTypeID CFSetGetTypeID(void);
/*!
@function CFSetCreate
Creates a new immutable set with the given values.
@param allocator The CFAllocator which should be used to allocate
memory for the set and its storage for values. This
parameter may be NULL in which case the current default
CFAllocator is used. If this reference is not a valid
CFAllocator, the behavior is undefined.
@param values A C array of the pointer-sized values to be in the
set. This C array is not changed or freed by this function.
If this parameter is not a valid pointer to a C array of at
least numValues pointers, the behavior is undefined.
@param numValues The number of values to copy from the values C
array into the CFSet. This number will be the count of the
set. If this parameter is zero, negative, or greater than
the number of values actually in the values C array, the
behavior is undefined.
@param callBacks A C pointer to a CFSetCallBacks structure
initialized with the callbacks for the set to use on each
value in the set. A copy of the contents of the
callbacks structure is made, so that a pointer to a
structure on the stack can be passed in, or can be reused
for multiple set creations. If the version field of this
callbacks structure is not one of the defined ones for
CFSet, the behavior is undefined. The retain field may be
NULL, in which case the CFSet will do nothing to add a
retain to the contained values for the set. The release
field may be NULL, in which case the CFSet will do nothing
to remove the set's retain (if any) on the values when the
set is destroyed. If the copyDescription field is NULL,
the set will create a simple description for the value. If
the equal field is NULL, the set will use pointer equality
to test for equality of values. The hash field may be NULL,
in which case the CFSet will determine uniqueness by pointer
equality. This callbacks parameter
itself may be NULL, which is treated as if a valid structure
of version 0 with all fields NULL had been passed in.
Otherwise, if any of the fields are not valid pointers to
functions of the correct type, or this parameter is not a
valid pointer to a CFSetCallBacks callbacks structure,
the behavior is undefined. If any of the values put into the
set is not one understood by one of the callback functions
the behavior when that callback function is used is
undefined.
@result A reference to the new immutable CFSet.
*/
CF_EXPORT
CFSetRef CFSetCreate(CFAllocatorRef allocator, const void **values, CFIndex numValues, const CFSetCallBacks *callBacks);
/*!
@function CFSetCreateCopy
Creates a new immutable set with the values from the given set.
@param allocator The CFAllocator which should be used to allocate
memory for the set and its storage for values. This
parameter may be NULL in which case the current default
CFAllocator is used. If this reference is not a valid
CFAllocator, the behavior is undefined.
@param theSet The set which is to be copied. The values from the
set are copied as pointers into the new set (that is,
the values themselves are copied, not that which the values
point to, if anything). However, the values are also
retained by the new set. The count of the new set will
be the same as the copied set. The new set uses the same
callbacks as the set to be copied. If this parameter is
not a valid CFSet, the behavior is undefined.
@result A reference to the new immutable CFSet.
*/
CF_EXPORT
CFSetRef CFSetCreateCopy(CFAllocatorRef allocator, CFSetRef theSet);
/*!
@function CFSetCreateMutable
Creates a new empty mutable set.
@param allocator The CFAllocator which should be used to allocate
memory for the set and its storage for values. This
parameter may be NULL in which case the current default
CFAllocator is used. If this reference is not a valid
CFAllocator, the behavior is undefined.
@param capacity A hint about the number of values that will be held
by the CFSet. Pass 0 for no hint. The implementation may
ignore this hint, or may use it to optimize various
operations. A set's actual capacity is only limited by
address space and available memory constraints). If this
parameter is negative, the behavior is undefined.
@param callBacks A C pointer to a CFSetCallBacks structure
initialized with the callbacks for the set to use on each
value in the set. A copy of the contents of the
callbacks structure is made, so that a pointer to a
structure on the stack can be passed in, or can be reused
for multiple set creations. If the version field of this
callbacks structure is not one of the defined ones for
CFSet, the behavior is undefined. The retain field may be
NULL, in which case the CFSet will do nothing to add a
retain to the contained values for the set. The release
field may be NULL, in which case the CFSet will do nothing
to remove the set's retain (if any) on the values when the
set is destroyed. If the copyDescription field is NULL,
the set will create a simple description for the value. If
the equal field is NULL, the set will use pointer equality
to test for equality of values. The hash field may be NULL,
in which case the CFSet will determine uniqueness by pointer
equality. This callbacks parameter
itself may be NULL, which is treated as if a valid structure
of version 0 with all fields NULL had been passed in.
Otherwise, if any of the fields are not valid pointers to
functions of the correct type, or this parameter is not a
valid pointer to a CFSetCallBacks callbacks structure,
the behavior is undefined. If any of the values put into the
set is not one understood by one of the callback functions
the behavior when that callback function is used is
undefined.
@result A reference to the new mutable CFSet.
*/
CF_EXPORT
CFMutableSetRef CFSetCreateMutable(CFAllocatorRef allocator, CFIndex capacity, const CFSetCallBacks *callBacks);
/*!
@function CFSetCreateMutableCopy
Creates a new immutable set with the values from the given set.
@param allocator The CFAllocator which should be used to allocate
memory for the set and its storage for values. This
parameter may be NULL in which case the current default
CFAllocator is used. If this reference is not a valid
CFAllocator, the behavior is undefined.
@param capacity A hint about the number of values that will be held
by the CFSet. Pass 0 for no hint. The implementation may
ignore this hint, or may use it to optimize various
operations. A set's actual capacity is only limited by
address space and available memory constraints).
This parameter must be greater than or equal
to the count of the set which is to be copied, or the
behavior is undefined. If this parameter is negative, the
behavior is undefined.
@param theSet The set which is to be copied. The values from the
set are copied as pointers into the new set (that is,
the values themselves are copied, not that which the values
point to, if anything). However, the values are also
retained by the new set. The count of the new set will
be the same as the copied set. The new set uses the same
callbacks as the set to be copied. If this parameter is
not a valid CFSet, the behavior is undefined.
@result A reference to the new mutable CFSet.
*/
CF_EXPORT
CFMutableSetRef CFSetCreateMutableCopy(CFAllocatorRef allocator, CFIndex capacity, CFSetRef theSet);
/*!
@function CFSetGetCount
Returns the number of values currently in the set.
@param theSet The set to be queried. If this parameter is not a valid
CFSet, the behavior is undefined.
@result The number of values in the set.
*/
CF_EXPORT
CFIndex CFSetGetCount(CFSetRef theSet);
/*!
@function CFSetGetCountOfValue
Counts the number of times the given value occurs in the set. Since
sets by definition contain only one instance of a value, this function
is synonymous to CFSetContainsValue.
@param theSet The set to be searched. If this parameter is not a
valid CFSet, the behavior is undefined.
@param value The value for which to find matches in the set. The
equal() callback provided when the set was created is
used to compare. If the equal() callback was NULL, pointer
equality (in C, ==) is used. If value, or any of the values
in the set, are not understood by the equal() callback,
the behavior is undefined.
@result The number of times the given value occurs in the set.
*/
CF_EXPORT
CFIndex CFSetGetCountOfValue(CFSetRef theSet, const void *value);
/*!
@function CFSetContainsValue
Reports whether or not the value is in the set.
@param theSet The set to be searched. If this parameter is not a
valid CFSet, the behavior is undefined.
@param value The value for which to find matches in the set. The
equal() callback provided when the set was created is
used to compare. If the equal() callback was NULL, pointer
equality (in C, ==) is used. If value, or any of the values
in the set, are not understood by the equal() callback,
the behavior is undefined.
@result true, if the value is in the set, otherwise false.
*/
CF_EXPORT
Boolean CFSetContainsValue(CFSetRef theSet, const void *value);
/*!
@function CFSetGetValue
Retrieves a value in the set which hashes the same as the specified value.
@param theSet The set to be queried. If this parameter is not a
valid CFSet, the behavior is undefined.
@param value The value to retrieve. The equal() callback provided when
the set was created is used to compare. If the equal() callback
was NULL, pointer equality (in C, ==) is used. If a value, or
any of the values in the set, are not understood by the equal()
callback, the behavior is undefined.
@result The value in the set with the given hash.
*/
CF_EXPORT
const void *CFSetGetValue(CFSetRef theSet, const void *value);
/*!
@function CFSetGetValueIfPresent
Retrieves a value in the set which hashes the same as the specified value,
if present.
@param theSet The set to be queried. If this parameter is not a
valid CFSet, the behavior is undefined.
@param candidate This value is hashed and compared with values in the
set to determine which value to retrieve. The equal() callback provided when
the set was created is used to compare. If the equal() callback
was NULL, pointer equality (in C, ==) is used. If a value, or
any of the values in the set, are not understood by the equal()
callback, the behavior is undefined.
@param value A pointer to memory which should be filled with the
pointer-sized value if a matching value is found. If no
match is found, the contents of the storage pointed to by
this parameter are undefined. This parameter may be NULL,
in which case the value from the dictionary is not returned
(but the return value of this function still indicates
whether or not the value was present).
@result True if the value was present in the set, otherwise false.
*/
CF_EXPORT
Boolean CFSetGetValueIfPresent(CFSetRef theSet, const void *candidate, const void **value);
/*!
@function CFSetGetValues
Fills the buffer with values from the set.
@param theSet The set to be queried. If this parameter is not a
valid CFSet, the behavior is undefined.
@param values A C array of pointer-sized values to be filled with
values from the set. The values in the C array are ordered
in the same order in which they appear in the set. If this
parameter is not a valid pointer to a C array of at least
CFSetGetCount() pointers, the behavior is undefined.
*/
CF_EXPORT
void CFSetGetValues(CFSetRef theSet, const void **values);
/*!
@function CFSetApplyFunction
Calls a function once for each value in the set.
@param theSet The set to be operated upon. If this parameter is not
a valid CFSet, the behavior is undefined.
@param applier The callback function to call once for each value in
the given set. If this parameter is not a
pointer to a function of the correct prototype, the behavior
is undefined. If there are values in the set which the
applier function does not expect or cannot properly apply
to, the behavior is undefined.
@param context A pointer-sized user-defined value, which is passed
as the second parameter to the applier function, but is
otherwise unused by this function. If the context is not
what is expected by the applier function, the behavior is
undefined.
*/
CF_EXPORT
void CFSetApplyFunction(CFSetRef theSet, CFSetApplierFunction CF_NOESCAPE applier, void *context);
/*!
@function CFSetAddValue
Adds the value to the set if it is not already present.
@param theSet The set to which the value is to be added. If this
parameter is not a valid mutable CFSet, the behavior is
undefined.
@param value The value to add to the set. The value is retained by
the set using the retain callback provided when the set
was created. If the value is not of the sort expected by the
retain callback, the behavior is undefined. The count of the
set is increased by one.
*/
CF_EXPORT
void CFSetAddValue(CFMutableSetRef theSet, const void *value);
/*!
@function CFSetReplaceValue
Replaces the value in the set if it is present.
@param theSet The set to which the value is to be replaced. If this
parameter is not a valid mutable CFSet, the behavior is
undefined.
@param value The value to replace in the set. The equal() callback provided when
the set was created is used to compare. If the equal() callback
was NULL, pointer equality (in C, ==) is used. If a value, or
any of the values in the set, are not understood by the equal()
callback, the behavior is undefined. The value is retained by
the set using the retain callback provided when the set
was created. If the value is not of the sort expected by the
retain callback, the behavior is undefined. The count of the
set is increased by one.
*/
CF_EXPORT
void CFSetReplaceValue(CFMutableSetRef theSet, const void *value);
/*!
@function CFSetSetValue
Replaces the value in the set if it is present, or adds the value to
the set if it is absent.
@param theSet The set to which the value is to be replaced. If this
parameter is not a valid mutable CFSet, the behavior is
undefined.
@param value The value to set in the CFSet. The equal() callback provided when
the set was created is used to compare. If the equal() callback
was NULL, pointer equality (in C, ==) is used. If a value, or
any of the values in the set, are not understood by the equal()
callback, the behavior is undefined. The value is retained by
the set using the retain callback provided when the set
was created. If the value is not of the sort expected by the
retain callback, the behavior is undefined. The count of the
set is increased by one.
*/
CF_EXPORT
void CFSetSetValue(CFMutableSetRef theSet, const void *value);
/*!
@function CFSetRemoveValue
Removes the specified value from the set.
@param theSet The set from which the value is to be removed.
If this parameter is not a valid mutable CFSet,
the behavior is undefined.
@param value The value to remove. The equal() callback provided when
the set was created is used to compare. If the equal() callback
was NULL, pointer equality (in C, ==) is used. If a value, or
any of the values in the set, are not understood by the equal()
callback, the behavior is undefined.
*/
CF_EXPORT
void CFSetRemoveValue(CFMutableSetRef theSet, const void *value);
/*!
@function CFSetRemoveAllValues
Removes all the values from the set, making it empty.
@param theSet The set from which all of the values are to be
removed. If this parameter is not a valid mutable CFSet,
the behavior is undefined.
*/
CF_EXPORT
void CFSetRemoveAllValues(CFMutableSetRef theSet);
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif /* ! __COREFOUNDATION_CFSET__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFFileDescriptor.h | /* CFFileDescriptor.h
Copyright (c) 2006-2019, Apple Inc. All rights reserved.
*/
#if !defined(__COREFOUNDATION_CFFILEDESCRIPTOR__)
#define __COREFOUNDATION_CFFILEDESCRIPTOR__ 1
#include <CoreFoundation/CFRunLoop.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
typedef int CFFileDescriptorNativeDescriptor;
typedef struct CF_BRIDGED_MUTABLE_TYPE(id) __CFFileDescriptor * CFFileDescriptorRef;
/* Callback Reason Types */
CF_ENUM(CFOptionFlags) {
kCFFileDescriptorReadCallBack = 1UL << 0,
kCFFileDescriptorWriteCallBack = 1UL << 1
};
typedef void (*CFFileDescriptorCallBack)(CFFileDescriptorRef f, CFOptionFlags callBackTypes, void *info);
typedef struct {
CFIndex version;
void * info;
void * (*retain)(void *info);
void (*release)(void *info);
CFStringRef (*copyDescription)(void *info);
} CFFileDescriptorContext;
CF_EXPORT CFTypeID CFFileDescriptorGetTypeID(void) API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0));
CF_EXPORT CFFileDescriptorRef CFFileDescriptorCreate(CFAllocatorRef allocator, CFFileDescriptorNativeDescriptor fd, Boolean closeOnInvalidate, CFFileDescriptorCallBack callout, const CFFileDescriptorContext *context) API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0));
CF_EXPORT CFFileDescriptorNativeDescriptor CFFileDescriptorGetNativeDescriptor(CFFileDescriptorRef f) API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0));
CF_EXPORT void CFFileDescriptorGetContext(CFFileDescriptorRef f, CFFileDescriptorContext *context) API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0));
CF_EXPORT void CFFileDescriptorEnableCallBacks(CFFileDescriptorRef f, CFOptionFlags callBackTypes) API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0));
CF_EXPORT void CFFileDescriptorDisableCallBacks(CFFileDescriptorRef f, CFOptionFlags callBackTypes) API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0));
CF_EXPORT void CFFileDescriptorInvalidate(CFFileDescriptorRef f) API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0));
CF_EXPORT Boolean CFFileDescriptorIsValid(CFFileDescriptorRef f) API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0));
CF_EXPORT CFRunLoopSourceRef CFFileDescriptorCreateRunLoopSource(CFAllocatorRef allocator, CFFileDescriptorRef f, CFIndex order) API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0));
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif /* ! __COREFOUNDATION_CFFILEDESCRIPTOR__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFDictionary.h | /* CFDictionary.h
Copyright (c) 1998-2019, Apple Inc. and the Swift project authors
Portions Copyright (c) 2014-2019, Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See http://swift.org/LICENSE.txt for license information
See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
*/
/*!
@header CFDictionary
CFDictionary implements a container which pairs pointer-sized keys
with pointer-sized values. Values are accessed via arbitrary
user-defined keys. A CFDictionary differs from a CFArray in that
the key used to access a particular value in the dictionary remains
the same as values are added to or removed from the dictionary,
unless a value associated with its particular key is replaced or
removed. In a CFArray, the key (or index) used to retrieve a
particular value can change over time as values are added to or
deleted from the array. Also unlike an array, there is no ordering
among values in a dictionary. To enable later retrieval of a value,
the key of the key-value pair should be constant (or treated as
constant); if the key changes after being used to put a value in
the dictionary, the value may not be retrievable. The keys of a
dictionary form a set; that is, no two keys which are equal to
one another are present in the dictionary at any time.
Dictionaries come in two flavors, immutable, which cannot have
values added to them or removed from them after the dictionary is
created, and mutable, to which you can add values or from which
remove values. Mutable dictionaries can have an unlimited number
of values (or rather, limited only by constraints external to
CFDictionary, like the amount of available memory).
As with all CoreFoundation collection types, dictionaries maintain
hard references on the values you put in them, but the retaining and
releasing functions are user-defined callbacks that can actually do
whatever the user wants (for example, nothing).
Although a particular implementation of CFDictionary may not use
hashing and a hash table for storage of the values, the keys have
a hash-code generating function defined for them, and a function
to test for equality of two keys. These two functions together
must maintain the invariant that if equal(X, Y), then hash(X) ==
hash(Y). Note that the converse will not generally be true (but
the contrapositive, if hash(X) != hash(Y), then !equal(X, Y),
will be as required by Boolean logic). If the hash() and equal()
key callbacks are NULL, the key is used as a pointer-sized integer,
and pointer equality is used. Care should be taken to provide a
hash() callback which will compute sufficiently dispersed hash
codes for the key set for best performance.
Computational Complexity
The access time for a value in the dictionary is guaranteed to be at
worst O(N) for any implementation, current and future, but will
often be O(1) (constant time). Insertion or deletion operations
will typically be constant time as well, but are O(N*N) in the
worst case in some implementations. Access of values through a key
is faster than accessing values directly (if there are any such
operations). Dictionaries will tend to use significantly more memory
than a array with the same number of values.
*/
#if !defined(__COREFOUNDATION_CFDICTIONARY__)
#define __COREFOUNDATION_CFDICTIONARY__ 1
#include <CoreFoundation/CFBase.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
/*!
@typedef CFDictionaryKeyCallBacks
Structure containing the callbacks for keys of a CFDictionary.
@field version The version number of the structure type being passed
in as a parameter to the CFDictionary creation functions.
This structure is version 0.
@field retain The callback used to add a retain for the dictionary
on keys as they are used to put values into the dictionary.
This callback returns the value to use as the key in the
dictionary, which is usually the value parameter passed to
this callback, but may be a different value if a different
value should be used as the key. The dictionary's allocator
is passed as the first argument.
@field release The callback used to remove a retain previously added
for the dictionary from keys as their values are removed from
the dictionary. The dictionary's allocator is passed as the
first argument.
@field copyDescription The callback used to create a descriptive
string representation of each key in the dictionary. This
is used by the CFCopyDescription() function.
@field equal The callback used to compare keys in the dictionary for
equality.
@field hash The callback used to compute a hash code for keys as they
are used to access, add, or remove values in the dictionary.
*/
typedef const void * (*CFDictionaryRetainCallBack)(CFAllocatorRef allocator, const void *value);
typedef void (*CFDictionaryReleaseCallBack)(CFAllocatorRef allocator, const void *value);
typedef CFStringRef (*CFDictionaryCopyDescriptionCallBack)(const void *value);
typedef Boolean (*CFDictionaryEqualCallBack)(const void *value1, const void *value2);
typedef CFHashCode (*CFDictionaryHashCallBack)(const void *value);
typedef struct {
CFIndex version;
CFDictionaryRetainCallBack retain;
CFDictionaryReleaseCallBack release;
CFDictionaryCopyDescriptionCallBack copyDescription;
CFDictionaryEqualCallBack equal;
CFDictionaryHashCallBack hash;
} CFDictionaryKeyCallBacks;
/*!
@constant kCFTypeDictionaryKeyCallBacks
Predefined CFDictionaryKeyCallBacks structure containing a
set of callbacks appropriate for use when the keys of a
CFDictionary are all CFTypes.
*/
CF_EXPORT
const CFDictionaryKeyCallBacks kCFTypeDictionaryKeyCallBacks;
/*!
@constant kCFCopyStringDictionaryKeyCallBacks
Predefined CFDictionaryKeyCallBacks structure containing a
set of callbacks appropriate for use when the keys of a
CFDictionary are all CFStrings, which may be mutable and
need to be copied in order to serve as constant keys for
the values in the dictionary.
*/
CF_EXPORT
const CFDictionaryKeyCallBacks kCFCopyStringDictionaryKeyCallBacks;
/*!
@typedef CFDictionaryValueCallBacks
Structure containing the callbacks for values of a CFDictionary.
@field version The version number of the structure type being passed
in as a parameter to the CFDictionary creation functions.
This structure is version 0.
@field retain The callback used to add a retain for the dictionary
on values as they are put into the dictionary.
This callback returns the value to use as the value in the
dictionary, which is usually the value parameter passed to
this callback, but may be a different value if a different
value should be added to the dictionary. The dictionary's
allocator is passed as the first argument.
@field release The callback used to remove a retain previously added
for the dictionary from values as they are removed from
the dictionary. The dictionary's allocator is passed as the
first argument.
@field copyDescription The callback used to create a descriptive
string representation of each value in the dictionary. This
is used by the CFCopyDescription() function.
@field equal The callback used to compare values in the dictionary for
equality in some operations.
*/
typedef struct {
CFIndex version;
CFDictionaryRetainCallBack retain;
CFDictionaryReleaseCallBack release;
CFDictionaryCopyDescriptionCallBack copyDescription;
CFDictionaryEqualCallBack equal;
} CFDictionaryValueCallBacks;
/*!
@constant kCFTypeDictionaryValueCallBacks
Predefined CFDictionaryValueCallBacks structure containing a set
of callbacks appropriate for use when the values in a CFDictionary
are all CFTypes.
*/
CF_EXPORT
const CFDictionaryValueCallBacks kCFTypeDictionaryValueCallBacks;
/*!
@typedef CFDictionaryApplierFunction
Type of the callback function used by the apply functions of
CFDictionarys.
@param key The current key for the value.
@param value The current value from the dictionary.
@param context The user-defined context parameter given to the apply
function.
*/
typedef void (*CFDictionaryApplierFunction)(const void *key, const void *value, void *context);
/*!
@typedef CFDictionaryRef
This is the type of a reference to immutable CFDictionarys.
*/
typedef const struct CF_BRIDGED_TYPE(NSDictionary) __CFDictionary * CFDictionaryRef;
/*!
@typedef CFMutableDictionaryRef
This is the type of a reference to mutable CFDictionarys.
*/
typedef struct CF_BRIDGED_MUTABLE_TYPE(NSMutableDictionary) __CFDictionary * CFMutableDictionaryRef;
/*!
@function CFDictionaryGetTypeID
Returns the type identifier of all CFDictionary instances.
*/
CF_EXPORT
CFTypeID CFDictionaryGetTypeID(void);
/*!
@function CFDictionaryCreate
Creates a new immutable dictionary with the given values.
@param allocator The CFAllocator which should be used to allocate
memory for the dictionary and its storage for values. This
parameter may be NULL in which case the current default
CFAllocator is used. If this reference is not a valid
CFAllocator, the behavior is undefined.
@param keys A C array of the pointer-sized keys to be used for
the parallel C array of values to be put into the dictionary.
This parameter may be NULL if the numValues parameter is 0.
This C array is not changed or freed by this function. If
this parameter is not a valid pointer to a C array of at
least numValues pointers, the behavior is undefined.
@param values A C array of the pointer-sized values to be in the
dictionary. This parameter may be NULL if the numValues
parameter is 0. This C array is not changed or freed by
this function. If this parameter is not a valid pointer to
a C array of at least numValues pointers, the behavior is
undefined.
@param numValues The number of values to copy from the keys and
values C arrays into the CFDictionary. This number will be
the count of the dictionary. If this parameter is
negative, or greater than the number of values actually
in the keys or values C arrays, the behavior is undefined.
@param keyCallBacks A pointer to a CFDictionaryKeyCallBacks structure
initialized with the callbacks for the dictionary to use on
each key in the dictionary. The retain callback will be used
within this function, for example, to retain all of the new
keys from the keys C array. A copy of the contents of the
callbacks structure is made, so that a pointer to a structure
on the stack can be passed in, or can be reused for multiple
dictionary creations. If the version field of this
callbacks structure is not one of the defined ones for
CFDictionary, the behavior is undefined. The retain field may
be NULL, in which case the CFDictionary will do nothing to add
a retain to the keys of the contained values. The release field
may be NULL, in which case the CFDictionary will do nothing
to remove the dictionary's retain (if any) on the keys when the
dictionary is destroyed or a key-value pair is removed. If the
copyDescription field is NULL, the dictionary will create a
simple description for a key. If the equal field is NULL, the
dictionary will use pointer equality to test for equality of
keys. If the hash field is NULL, a key will be converted from
a pointer to an integer to compute the hash code. This callbacks
parameter itself may be NULL, which is treated as if a valid
structure of version 0 with all fields NULL had been passed in.
Otherwise, if any of the fields are not valid pointers to
functions of the correct type, or this parameter is not a
valid pointer to a CFDictionaryKeyCallBacks callbacks structure,
the behavior is undefined. If any of the keys put into the
dictionary is not one understood by one of the callback functions
the behavior when that callback function is used is undefined.
@param valueCallBacks A pointer to a CFDictionaryValueCallBacks structure
initialized with the callbacks for the dictionary to use on
each value in the dictionary. The retain callback will be used
within this function, for example, to retain all of the new
values from the values C array. A copy of the contents of the
callbacks structure is made, so that a pointer to a structure
on the stack can be passed in, or can be reused for multiple
dictionary creations. If the version field of this callbacks
structure is not one of the defined ones for CFDictionary, the
behavior is undefined. The retain field may be NULL, in which
case the CFDictionary will do nothing to add a retain to values
as they are put into the dictionary. The release field may be
NULL, in which case the CFDictionary will do nothing to remove
the dictionary's retain (if any) on the values when the
dictionary is destroyed or a key-value pair is removed. If the
copyDescription field is NULL, the dictionary will create a
simple description for a value. If the equal field is NULL, the
dictionary will use pointer equality to test for equality of
values. This callbacks parameter itself may be NULL, which is
treated as if a valid structure of version 0 with all fields
NULL had been passed in. Otherwise,
if any of the fields are not valid pointers to functions
of the correct type, or this parameter is not a valid
pointer to a CFDictionaryValueCallBacks callbacks structure,
the behavior is undefined. If any of the values put into the
dictionary is not one understood by one of the callback functions
the behavior when that callback function is used is undefined.
@result A reference to the new immutable CFDictionary.
*/
CF_EXPORT
CFDictionaryRef CFDictionaryCreate(CFAllocatorRef allocator, const void **keys, const void **values, CFIndex numValues, const CFDictionaryKeyCallBacks *keyCallBacks, const CFDictionaryValueCallBacks *valueCallBacks);
/*!
@function CFDictionaryCreateCopy
Creates a new immutable dictionary with the key-value pairs from
the given dictionary.
@param allocator The CFAllocator which should be used to allocate
memory for the dictionary and its storage for values. This
parameter may be NULL in which case the current default
CFAllocator is used. If this reference is not a valid
CFAllocator, the behavior is undefined.
@param theDict The dictionary which is to be copied. The keys and values
from the dictionary are copied as pointers into the new
dictionary (that is, the values themselves are copied, not
that which the values point to, if anything). However, the
keys and values are also retained by the new dictionary using
the retain function of the original dictionary.
The count of the new dictionary will be the same as the
given dictionary. The new dictionary uses the same callbacks
as the dictionary to be copied. If this parameter is
not a valid CFDictionary, the behavior is undefined.
@result A reference to the new immutable CFDictionary.
*/
CF_EXPORT
CFDictionaryRef CFDictionaryCreateCopy(CFAllocatorRef allocator, CFDictionaryRef theDict);
/*!
@function CFDictionaryCreateMutable
Creates a new mutable dictionary.
@param allocator The CFAllocator which should be used to allocate
memory for the dictionary and its storage for values. This
parameter may be NULL in which case the current default
CFAllocator is used. If this reference is not a valid
CFAllocator, the behavior is undefined.
@param capacity A hint about the number of values that will be held
by the CFDictionary. Pass 0 for no hint. The implementation may
ignore this hint, or may use it to optimize various
operations. A dictionary's actual capacity is only limited by
address space and available memory constraints). If this
parameter is negative, the behavior is undefined.
@param keyCallBacks A pointer to a CFDictionaryKeyCallBacks structure
initialized with the callbacks for the dictionary to use on
each key in the dictionary. A copy of the contents of the
callbacks structure is made, so that a pointer to a structure
on the stack can be passed in, or can be reused for multiple
dictionary creations. If the version field of this
callbacks structure is not one of the defined ones for
CFDictionary, the behavior is undefined. The retain field may
be NULL, in which case the CFDictionary will do nothing to add
a retain to the keys of the contained values. The release field
may be NULL, in which case the CFDictionary will do nothing
to remove the dictionary's retain (if any) on the keys when the
dictionary is destroyed or a key-value pair is removed. If the
copyDescription field is NULL, the dictionary will create a
simple description for a key. If the equal field is NULL, the
dictionary will use pointer equality to test for equality of
keys. If the hash field is NULL, a key will be converted from
a pointer to an integer to compute the hash code. This callbacks
parameter itself may be NULL, which is treated as if a valid
structure of version 0 with all fields NULL had been passed in.
Otherwise, if any of the fields are not valid pointers to
functions of the correct type, or this parameter is not a
valid pointer to a CFDictionaryKeyCallBacks callbacks structure,
the behavior is undefined. If any of the keys put into the
dictionary is not one understood by one of the callback functions
the behavior when that callback function is used is undefined.
@param valueCallBacks A pointer to a CFDictionaryValueCallBacks structure
initialized with the callbacks for the dictionary to use on
each value in the dictionary. The retain callback will be used
within this function, for example, to retain all of the new
values from the values C array. A copy of the contents of the
callbacks structure is made, so that a pointer to a structure
on the stack can be passed in, or can be reused for multiple
dictionary creations. If the version field of this callbacks
structure is not one of the defined ones for CFDictionary, the
behavior is undefined. The retain field may be NULL, in which
case the CFDictionary will do nothing to add a retain to values
as they are put into the dictionary. The release field may be
NULL, in which case the CFDictionary will do nothing to remove
the dictionary's retain (if any) on the values when the
dictionary is destroyed or a key-value pair is removed. If the
copyDescription field is NULL, the dictionary will create a
simple description for a value. If the equal field is NULL, the
dictionary will use pointer equality to test for equality of
values. This callbacks parameter itself may be NULL, which is
treated as if a valid structure of version 0 with all fields
NULL had been passed in. Otherwise,
if any of the fields are not valid pointers to functions
of the correct type, or this parameter is not a valid
pointer to a CFDictionaryValueCallBacks callbacks structure,
the behavior is undefined. If any of the values put into the
dictionary is not one understood by one of the callback functions
the behavior when that callback function is used is undefined.
@result A reference to the new mutable CFDictionary.
*/
CF_EXPORT
CFMutableDictionaryRef CFDictionaryCreateMutable(CFAllocatorRef allocator, CFIndex capacity, const CFDictionaryKeyCallBacks *keyCallBacks, const CFDictionaryValueCallBacks *valueCallBacks);
/*!
@function CFDictionaryCreateMutableCopy
Creates a new mutable dictionary with the key-value pairs from
the given dictionary.
@param allocator The CFAllocator which should be used to allocate
memory for the dictionary and its storage for values. This
parameter may be NULL in which case the current default
CFAllocator is used. If this reference is not a valid
CFAllocator, the behavior is undefined.
@param capacity A hint about the number of values that will be held
by the CFDictionary. Pass 0 for no hint. The implementation may
ignore this hint, or may use it to optimize various
operations. A dictionary's actual capacity is only limited by
address space and available memory constraints).
This parameter must be greater than or equal
to the count of the dictionary which is to be copied, or the
behavior is undefined. If this parameter is negative, the
behavior is undefined.
@param theDict The dictionary which is to be copied. The keys and values
from the dictionary are copied as pointers into the new
dictionary (that is, the values themselves are copied, not
that which the values point to, if anything). However, the
keys and values are also retained by the new dictionary using
the retain function of the original dictionary.
The count of the new dictionary will be the same as the
given dictionary. The new dictionary uses the same callbacks
as the dictionary to be copied. If this parameter is
not a valid CFDictionary, the behavior is undefined.
@result A reference to the new mutable CFDictionary.
*/
CF_EXPORT
CFMutableDictionaryRef CFDictionaryCreateMutableCopy(CFAllocatorRef allocator, CFIndex capacity, CFDictionaryRef theDict);
/*!
@function CFDictionaryGetCount
Returns the number of values currently in the dictionary.
@param theDict The dictionary to be queried. If this parameter is
not a valid CFDictionary, the behavior is undefined.
@result The number of values in the dictionary.
*/
CF_EXPORT
CFIndex CFDictionaryGetCount(CFDictionaryRef theDict);
/*!
@function CFDictionaryGetCountOfKey
Counts the number of times the given key occurs in the dictionary.
@param theDict The dictionary to be searched. If this parameter is
not a valid CFDictionary, the behavior is undefined.
@param key The key for which to find matches in the dictionary. The
hash() and equal() key callbacks provided when the dictionary
was created are used to compare. If the hash() key callback
was NULL, the key is treated as a pointer and converted to
an integer. If the equal() key callback was NULL, pointer
equality (in C, ==) is used. If key, or any of the keys in
the dictionary, are not understood by the equal() callback,
the behavior is undefined.
@result Returns 1 if a matching key is used by the dictionary,
0 otherwise.
*/
CF_EXPORT
CFIndex CFDictionaryGetCountOfKey(CFDictionaryRef theDict, const void *key);
/*!
@function CFDictionaryGetCountOfValue
Counts the number of times the given value occurs in the dictionary.
@param theDict The dictionary to be searched. If this parameter is
not a valid CFDictionary, the behavior is undefined.
@param value The value for which to find matches in the dictionary. The
equal() callback provided when the dictionary was created is
used to compare. If the equal() value callback was NULL, pointer
equality (in C, ==) is used. If value, or any of the values in
the dictionary, are not understood by the equal() callback,
the behavior is undefined.
@result The number of times the given value occurs in the dictionary.
*/
CF_EXPORT
CFIndex CFDictionaryGetCountOfValue(CFDictionaryRef theDict, const void *value);
/*!
@function CFDictionaryContainsKey
Reports whether or not the key is in the dictionary.
@param theDict The dictionary to be searched. If this parameter is
not a valid CFDictionary, the behavior is undefined.
@param key The key for which to find matches in the dictionary. The
hash() and equal() key callbacks provided when the dictionary
was created are used to compare. If the hash() key callback
was NULL, the key is treated as a pointer and converted to
an integer. If the equal() key callback was NULL, pointer
equality (in C, ==) is used. If key, or any of the keys in
the dictionary, are not understood by the equal() callback,
the behavior is undefined.
@result true, if the key is in the dictionary, otherwise false.
*/
CF_EXPORT
Boolean CFDictionaryContainsKey(CFDictionaryRef theDict, const void *key);
/*!
@function CFDictionaryContainsValue
Reports whether or not the value is in the dictionary.
@param theDict The dictionary to be searched. If this parameter is
not a valid CFDictionary, the behavior is undefined.
@param value The value for which to find matches in the dictionary. The
equal() callback provided when the dictionary was created is
used to compare. If the equal() callback was NULL, pointer
equality (in C, ==) is used. If value, or any of the values
in the dictionary, are not understood by the equal() callback,
the behavior is undefined.
@result true, if the value is in the dictionary, otherwise false.
*/
CF_EXPORT
Boolean CFDictionaryContainsValue(CFDictionaryRef theDict, const void *value);
/*!
@function CFDictionaryGetValue
Retrieves the value associated with the given key.
@param theDict The dictionary to be queried. If this parameter is
not a valid CFDictionary, the behavior is undefined.
@param key The key for which to find a match in the dictionary. The
hash() and equal() key callbacks provided when the dictionary
was created are used to compare. If the hash() key callback
was NULL, the key is treated as a pointer and converted to
an integer. If the equal() key callback was NULL, pointer
equality (in C, ==) is used. If key, or any of the keys in
the dictionary, are not understood by the equal() callback,
the behavior is undefined.
@result The value with the given key in the dictionary, or NULL if
no key-value pair with a matching key exists. Since NULL
can be a valid value in some dictionaries, the function
CFDictionaryGetValueIfPresent() must be used to distinguish
NULL-no-found from NULL-is-the-value.
*/
CF_EXPORT
const void *CFDictionaryGetValue(CFDictionaryRef theDict, const void *key);
/*!
@function CFDictionaryGetValueIfPresent
Retrieves the value associated with the given key.
@param theDict The dictionary to be queried. If this parameter is
not a valid CFDictionary, the behavior is undefined.
@param key The key for which to find a match in the dictionary. The
hash() and equal() key callbacks provided when the dictionary
was created are used to compare. If the hash() key callback
was NULL, the key is treated as a pointer and converted to
an integer. If the equal() key callback was NULL, pointer
equality (in C, ==) is used. If key, or any of the keys in
the dictionary, are not understood by the equal() callback,
the behavior is undefined.
@param value A pointer to memory which should be filled with the
pointer-sized value if a matching key is found. If no key
match is found, the contents of the storage pointed to by
this parameter are undefined. This parameter may be NULL,
in which case the value from the dictionary is not returned
(but the return value of this function still indicates
whether or not the key-value pair was present).
@result true, if a matching key was found, false otherwise.
*/
CF_EXPORT
Boolean CFDictionaryGetValueIfPresent(CFDictionaryRef theDict, const void *key, const void **value);
/*!
@function CFDictionaryGetKeysAndValues
Fills the two buffers with the keys and values from the dictionary.
@param theDict The dictionary to be queried. If this parameter is
not a valid CFDictionary, the behavior is undefined.
@param keys A C array of pointer-sized values to be filled with keys
from the dictionary. The keys and values C arrays are parallel
to each other (that is, the items at the same indices form a
key-value pair from the dictionary). This parameter may be NULL
if the keys are not desired. If this parameter is not a valid
pointer to a C array of at least CFDictionaryGetCount() pointers,
or NULL, the behavior is undefined.
@param values A C array of pointer-sized values to be filled with values
from the dictionary. The keys and values C arrays are parallel
to each other (that is, the items at the same indices form a
key-value pair from the dictionary). This parameter may be NULL
if the values are not desired. If this parameter is not a valid
pointer to a C array of at least CFDictionaryGetCount() pointers,
or NULL, the behavior is undefined.
*/
CF_EXPORT
void CFDictionaryGetKeysAndValues(CFDictionaryRef theDict, const void **keys, const void **values);
/*!
@function CFDictionaryApplyFunction
Calls a function once for each value in the dictionary.
@param theDict The dictionary to be queried. If this parameter is
not a valid CFDictionary, the behavior is undefined.
@param applier The callback function to call once for each value in
the dictionary. If this parameter is not a
pointer to a function of the correct prototype, the behavior
is undefined. If there are keys or values which the
applier function does not expect or cannot properly apply
to, the behavior is undefined.
@param context A pointer-sized user-defined value, which is passed
as the third parameter to the applier function, but is
otherwise unused by this function. If the context is not
what is expected by the applier function, the behavior is
undefined.
*/
CF_EXPORT
void CFDictionaryApplyFunction(CFDictionaryRef theDict, CFDictionaryApplierFunction CF_NOESCAPE applier, void *context);
/*!
@function CFDictionaryAddValue
Adds the key-value pair to the dictionary if no such key already exists.
@param theDict The dictionary to which the value is to be added. If this
parameter is not a valid mutable CFDictionary, the behavior is
undefined.
@param key The key of the value to add to the dictionary. The key is
retained by the dictionary using the retain callback provided
when the dictionary was created. If the key is not of the sort
expected by the retain callback, the behavior is undefined. If
a key which matches this key is already present in the dictionary,
this function does nothing ("add if absent").
@param value The value to add to the dictionary. The value is retained
by the dictionary using the retain callback provided when the
dictionary was created. If the value is not of the sort expected
by the retain callback, the behavior is undefined.
*/
CF_EXPORT
void CFDictionaryAddValue(CFMutableDictionaryRef theDict, const void *key, const void *value);
/*!
@function CFDictionarySetValue
Sets the value of the key in the dictionary.
@param theDict The dictionary to which the value is to be set. If this
parameter is not a valid mutable CFDictionary, the behavior is
undefined.
@param key The key of the value to set into the dictionary. If a key
which matches this key is already present in the dictionary, only
the value is changed ("add if absent, replace if present"). If
no key matches the given key, the key-value pair is added to the
dictionary. If added, the key is retained by the dictionary,
using the retain callback provided
when the dictionary was created. If the key is not of the sort
expected by the key retain callback, the behavior is undefined.
@param value The value to add to or replace into the dictionary. The value
is retained by the dictionary using the retain callback provided
when the dictionary was created, and the previous value if any is
released. If the value is not of the sort expected by the
retain or release callbacks, the behavior is undefined.
*/
CF_EXPORT
void CFDictionarySetValue(CFMutableDictionaryRef theDict, const void *key, const void *value);
/*!
@function CFDictionaryReplaceValue
Replaces the value of the key in the dictionary.
@param theDict The dictionary to which the value is to be replaced. If this
parameter is not a valid mutable CFDictionary, the behavior is
undefined.
@param key The key of the value to replace in the dictionary. If a key
which matches this key is present in the dictionary, the value
is changed to the given value, otherwise this function does
nothing ("replace if present").
@param value The value to replace into the dictionary. The value
is retained by the dictionary using the retain callback provided
when the dictionary was created, and the previous value is
released. If the value is not of the sort expected by the
retain or release callbacks, the behavior is undefined.
*/
CF_EXPORT
void CFDictionaryReplaceValue(CFMutableDictionaryRef theDict, const void *key, const void *value);
/*!
@function CFDictionaryRemoveValue
Removes the value of the key from the dictionary.
@param theDict The dictionary from which the value is to be removed. If this
parameter is not a valid mutable CFDictionary, the behavior is
undefined.
@param key The key of the value to remove from the dictionary. If a key
which matches this key is present in the dictionary, the key-value
pair is removed from the dictionary, otherwise this function does
nothing ("remove if present").
*/
CF_EXPORT
void CFDictionaryRemoveValue(CFMutableDictionaryRef theDict, const void *key);
/*!
@function CFDictionaryRemoveAllValues
Removes all the values from the dictionary, making it empty.
@param theDict The dictionary from which all of the values are to be
removed. If this parameter is not a valid mutable
CFDictionary, the behavior is undefined.
*/
CF_EXPORT
void CFDictionaryRemoveAllValues(CFMutableDictionaryRef theDict);
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif /* ! __COREFOUNDATION_CFDICTIONARY__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFCalendar.h | /* CFCalendar.h
Copyright (c) 2004-2019, Apple Inc. and the Swift project authors
Portions Copyright (c) 2014-2019, Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See http://swift.org/LICENSE.txt for license information
See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
*/
#if !defined(__COREFOUNDATION_CFCALENDAR__)
#define __COREFOUNDATION_CFCALENDAR__ 1
#include <CoreFoundation/CFBase.h>
#include <CoreFoundation/CFLocale.h>
#include <CoreFoundation/CFDate.h>
#include <CoreFoundation/CFTimeZone.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
typedef struct CF_BRIDGED_MUTABLE_TYPE(NSCalendar) __CFCalendar * CFCalendarRef;
CF_EXPORT
CFTypeID CFCalendarGetTypeID(void);
CF_EXPORT
CFCalendarRef CFCalendarCopyCurrent(void);
CF_EXPORT
CFCalendarRef CFCalendarCreateWithIdentifier(CFAllocatorRef allocator, CFCalendarIdentifier identifier);
// Create a calendar. The identifiers are the kCF*Calendar
// constants in CFLocale.h.
CF_EXPORT
CFCalendarIdentifier CFCalendarGetIdentifier(CFCalendarRef calendar);
// Returns the calendar's identifier.
CF_EXPORT
CFLocaleRef CFCalendarCopyLocale(CFCalendarRef calendar);
CF_EXPORT
void CFCalendarSetLocale(CFCalendarRef calendar, CFLocaleRef locale);
CF_EXPORT
CFTimeZoneRef CFCalendarCopyTimeZone(CFCalendarRef calendar);
CF_EXPORT
void CFCalendarSetTimeZone(CFCalendarRef calendar, CFTimeZoneRef tz);
CF_EXPORT
CFIndex CFCalendarGetFirstWeekday(CFCalendarRef calendar);
CF_EXPORT
void CFCalendarSetFirstWeekday(CFCalendarRef calendar, CFIndex wkdy);
CF_EXPORT
CFIndex CFCalendarGetMinimumDaysInFirstWeek(CFCalendarRef calendar);
CF_EXPORT
void CFCalendarSetMinimumDaysInFirstWeek(CFCalendarRef calendar, CFIndex mwd);
typedef CF_OPTIONS(CFOptionFlags, CFCalendarUnit) {
kCFCalendarUnitEra = (1UL << 1),
kCFCalendarUnitYear = (1UL << 2),
kCFCalendarUnitMonth = (1UL << 3),
kCFCalendarUnitDay = (1UL << 4),
kCFCalendarUnitHour = (1UL << 5),
kCFCalendarUnitMinute = (1UL << 6),
kCFCalendarUnitSecond = (1UL << 7),
kCFCalendarUnitWeek API_DEPRECATED("Use kCFCalendarUnitWeekOfYear or kCFCalendarUnitWeekOfMonth instead", macos(10.4,10.10), ios(2.0,8.0), watchos(2.0,2.0), tvos(9.0,9.0)) = (1UL << 8),
kCFCalendarUnitWeekday = (1UL << 9),
kCFCalendarUnitWeekdayOrdinal = (1UL << 10),
kCFCalendarUnitQuarter API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0)) = (1UL << 11),
kCFCalendarUnitWeekOfMonth API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0)) = (1UL << 12),
kCFCalendarUnitWeekOfYear API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0)) = (1UL << 13),
kCFCalendarUnitYearForWeekOfYear API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0)) = (1UL << 14),
};
CF_EXPORT
CFRange CFCalendarGetMinimumRangeOfUnit(CFCalendarRef calendar, CFCalendarUnit unit);
CF_EXPORT
CFRange CFCalendarGetMaximumRangeOfUnit(CFCalendarRef calendar, CFCalendarUnit unit);
CF_EXPORT
CFRange CFCalendarGetRangeOfUnit(CFCalendarRef calendar, CFCalendarUnit smallerUnit, CFCalendarUnit biggerUnit, CFAbsoluteTime at);
CF_EXPORT
CFIndex CFCalendarGetOrdinalityOfUnit(CFCalendarRef calendar, CFCalendarUnit smallerUnit, CFCalendarUnit biggerUnit, CFAbsoluteTime at);
CF_EXPORT
Boolean CFCalendarGetTimeRangeOfUnit(CFCalendarRef calendar, CFCalendarUnit unit, CFAbsoluteTime at, CFAbsoluteTime *startp, CFTimeInterval *tip) API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0));
CF_EXPORT
Boolean CFCalendarComposeAbsoluteTime(CFCalendarRef calendar, /* out */ CFAbsoluteTime *at, const char *componentDesc, ...);
CF_EXPORT
Boolean CFCalendarDecomposeAbsoluteTime(CFCalendarRef calendar, CFAbsoluteTime at, const char *componentDesc, ...);
CF_ENUM(CFOptionFlags) {
kCFCalendarComponentsWrap = (1UL << 0) // option for adding
};
CF_EXPORT
Boolean CFCalendarAddComponents(CFCalendarRef calendar, /* inout */ CFAbsoluteTime *at, CFOptionFlags options, const char *componentDesc, ...);
CF_EXPORT
Boolean CFCalendarGetComponentDifference(CFCalendarRef calendar, CFAbsoluteTime startingAT, CFAbsoluteTime resultAT, CFOptionFlags options, const char *componentDesc, ...);
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif /* ! __COREFOUNDATION_CFCALENDAR__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFBag.h | /* CFBag.h
Copyright (c) 1998-2019, Apple Inc. and the Swift project authors
Portions Copyright (c) 2014-2019, Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See http://swift.org/LICENSE.txt for license information
See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
*/
#if !defined(__COREFOUNDATION_CFBAG__)
#define __COREFOUNDATION_CFBAG__ 1
#include <CoreFoundation/CFBase.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
typedef const void * (*CFBagRetainCallBack)(CFAllocatorRef allocator, const void *value);
typedef void (*CFBagReleaseCallBack)(CFAllocatorRef allocator, const void *value);
typedef CFStringRef (*CFBagCopyDescriptionCallBack)(const void *value);
typedef Boolean (*CFBagEqualCallBack)(const void *value1, const void *value2);
typedef CFHashCode (*CFBagHashCallBack)(const void *value);
typedef struct {
CFIndex version;
CFBagRetainCallBack retain;
CFBagReleaseCallBack release;
CFBagCopyDescriptionCallBack copyDescription;
CFBagEqualCallBack equal;
CFBagHashCallBack hash;
} CFBagCallBacks;
CF_EXPORT
const CFBagCallBacks kCFTypeBagCallBacks;
CF_EXPORT
const CFBagCallBacks kCFCopyStringBagCallBacks;
typedef void (*CFBagApplierFunction)(const void *value, void *context);
typedef const struct CF_BRIDGED_TYPE(id) __CFBag * CFBagRef;
typedef struct CF_BRIDGED_MUTABLE_TYPE(id) __CFBag * CFMutableBagRef;
CF_EXPORT
CFTypeID CFBagGetTypeID(void);
CF_EXPORT
CFBagRef CFBagCreate(CFAllocatorRef allocator, const void **values, CFIndex numValues, const CFBagCallBacks *callBacks);
CF_EXPORT
CFBagRef CFBagCreateCopy(CFAllocatorRef allocator, CFBagRef theBag);
CF_EXPORT
CFMutableBagRef CFBagCreateMutable(CFAllocatorRef allocator, CFIndex capacity, const CFBagCallBacks *callBacks);
CF_EXPORT
CFMutableBagRef CFBagCreateMutableCopy(CFAllocatorRef allocator, CFIndex capacity, CFBagRef theBag);
CF_EXPORT
CFIndex CFBagGetCount(CFBagRef theBag);
CF_EXPORT
CFIndex CFBagGetCountOfValue(CFBagRef theBag, const void *value);
CF_EXPORT
Boolean CFBagContainsValue(CFBagRef theBag, const void *value);
CF_EXPORT
const void *CFBagGetValue(CFBagRef theBag, const void *value);
CF_EXPORT
Boolean CFBagGetValueIfPresent(CFBagRef theBag, const void *candidate, const void **value);
CF_EXPORT
void CFBagGetValues(CFBagRef theBag, const void **values);
CF_EXPORT
void CFBagApplyFunction(CFBagRef theBag, CFBagApplierFunction CF_NOESCAPE applier, void *context);
CF_EXPORT
void CFBagAddValue(CFMutableBagRef theBag, const void *value);
CF_EXPORT
void CFBagReplaceValue(CFMutableBagRef theBag, const void *value);
CF_EXPORT
void CFBagSetValue(CFMutableBagRef theBag, const void *value);
CF_EXPORT
void CFBagRemoveValue(CFMutableBagRef theBag, const void *value);
CF_EXPORT
void CFBagRemoveAllValues(CFMutableBagRef theBag);
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif /* ! __COREFOUNDATION_CFBAG__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFMessagePort.h | /* CFMessagePort.h
Copyright (c) 1998-2019, Apple Inc. and the Swift project authors
Portions Copyright (c) 2014-2019, Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See http://swift.org/LICENSE.txt for license information
See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
*/
#if !defined(__COREFOUNDATION_CFMESSAGEPORT__)
#define __COREFOUNDATION_CFMESSAGEPORT__ 1
#include <CoreFoundation/CFString.h>
#include <CoreFoundation/CFRunLoop.h>
#include <CoreFoundation/CFData.h>
#include <dispatch/dispatch.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
typedef struct CF_BRIDGED_MUTABLE_TYPE(NSMessagePort) __CFMessagePort * CFMessagePortRef;
CF_ENUM(SInt32) {
kCFMessagePortSuccess = 0,
kCFMessagePortSendTimeout = -1,
kCFMessagePortReceiveTimeout = -2,
kCFMessagePortIsInvalid = -3,
kCFMessagePortTransportError = -4,
kCFMessagePortBecameInvalidError = -5
};
typedef struct {
CFIndex version;
void * info;
const void *(*retain)(const void *info);
void (*release)(const void *info);
CFStringRef (*copyDescription)(const void *info);
} CFMessagePortContext;
typedef CFDataRef (*CFMessagePortCallBack)(CFMessagePortRef local, SInt32 msgid, CFDataRef data, void *info);
/* If callout wants to keep a hold of the data past the return of the callout, it must COPY the data. This includes the case where the data is given to some routine which _might_ keep a hold of it; System will release returned CFData. */
typedef void (*CFMessagePortInvalidationCallBack)(CFMessagePortRef ms, void *info);
CF_EXPORT CFTypeID CFMessagePortGetTypeID(void);
CF_EXPORT CFMessagePortRef CFMessagePortCreateLocal(CFAllocatorRef allocator, CFStringRef name, CFMessagePortCallBack callout, CFMessagePortContext *context, Boolean *shouldFreeInfo);
CF_EXPORT CFMessagePortRef CFMessagePortCreateRemote(CFAllocatorRef allocator, CFStringRef name);
CF_EXPORT Boolean CFMessagePortIsRemote(CFMessagePortRef ms);
CF_EXPORT CFStringRef CFMessagePortGetName(CFMessagePortRef ms);
CF_EXPORT Boolean CFMessagePortSetName(CFMessagePortRef ms, CFStringRef newName);
CF_EXPORT void CFMessagePortGetContext(CFMessagePortRef ms, CFMessagePortContext *context);
CF_EXPORT void CFMessagePortInvalidate(CFMessagePortRef ms);
CF_EXPORT Boolean CFMessagePortIsValid(CFMessagePortRef ms);
CF_EXPORT CFMessagePortInvalidationCallBack CFMessagePortGetInvalidationCallBack(CFMessagePortRef ms);
CF_EXPORT void CFMessagePortSetInvalidationCallBack(CFMessagePortRef ms, CFMessagePortInvalidationCallBack callout);
/* NULL replyMode argument means no return value expected, don't wait for it */
CF_EXPORT SInt32 CFMessagePortSendRequest(CFMessagePortRef remote, SInt32 msgid, CFDataRef data, CFTimeInterval sendTimeout, CFTimeInterval rcvTimeout, CFStringRef replyMode, CFDataRef *returnData);
CF_EXPORT CFRunLoopSourceRef CFMessagePortCreateRunLoopSource(CFAllocatorRef allocator, CFMessagePortRef local, CFIndex order);
CF_EXPORT void CFMessagePortSetDispatchQueue(CFMessagePortRef ms, dispatch_queue_t queue) API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif /* ! __COREFOUNDATION_CFMESSAGEPORT__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFPreferences.h | /* CFPreferences.h
Copyright (c) 1998-2019, Apple Inc. and the Swift project authors
Portions Copyright (c) 2014-2019, Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See http://swift.org/LICENSE.txt for license information
See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
*/
#if !defined(__COREFOUNDATION_CFPREFERENCES__)
#define __COREFOUNDATION_CFPREFERENCES__ 1
#include <CoreFoundation/CFBase.h>
#include <CoreFoundation/CFArray.h>
#include <CoreFoundation/CFString.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_ASSUME_NONNULL_BEGIN
CF_EXTERN_C_BEGIN
CF_EXPORT
const CFStringRef kCFPreferencesAnyApplication;
CF_EXPORT
const CFStringRef kCFPreferencesCurrentApplication;
CF_EXPORT
const CFStringRef kCFPreferencesAnyHost;
CF_EXPORT
const CFStringRef kCFPreferencesCurrentHost;
CF_EXPORT
const CFStringRef kCFPreferencesAnyUser;
CF_EXPORT
const CFStringRef kCFPreferencesCurrentUser;
/* NOTE: All CFPropertyListRef values returned from
CFPreferences API should be assumed to be immutable.
*/
/* The "App" functions search the various sources of defaults that
apply to the given application, and should never be called with
kCFPreferencesAnyApplication - only kCFPreferencesCurrentApplication
or an application's ID (its bundle identifier).
*/
/* Searches the various sources of application defaults to find the
value for the given key. key must not be NULL. If a value is found,
it returns it; otherwise returns NULL. Caller must release the
returned value */
CF_EXPORT
_Nullable CFPropertyListRef CFPreferencesCopyAppValue(CFStringRef key, CFStringRef applicationID);
/* Convenience to interpret a preferences value as a boolean directly.
Returns false if the key doesn't exist, or has an improper format; under
those conditions, keyExistsAndHasValidFormat (if non-NULL) is set to false */
CF_EXPORT
Boolean CFPreferencesGetAppBooleanValue(CFStringRef key, CFStringRef applicationID, Boolean * _Nullable keyExistsAndHasValidFormat);
/* Convenience to interpret a preferences value as an integer directly.
Returns 0 if the key doesn't exist, or has an improper format; under
those conditions, keyExistsAndHasValidFormat (if non-NULL) is set to false */
CF_EXPORT
CFIndex CFPreferencesGetAppIntegerValue(CFStringRef key, CFStringRef applicationID, Boolean * _Nullable keyExistsAndHasValidFormat);
/* Sets the given value for the given key in the "normal" place for
application preferences. key must not be NULL. If value is NULL,
key is removed instead. */
CF_EXPORT
void CFPreferencesSetAppValue(CFStringRef key, _Nullable CFPropertyListRef value, CFStringRef applicationID);
/* Adds the preferences for the given suite to the app preferences for
the specified application. To write to the suite domain, use
CFPreferencesSetValue(), below, using the suiteName in place
of the appName */
CF_EXPORT
void CFPreferencesAddSuitePreferencesToApp(CFStringRef applicationID, CFStringRef suiteID);
CF_EXPORT
void CFPreferencesRemoveSuitePreferencesFromApp(CFStringRef applicationID, CFStringRef suiteID);
/* Writes all changes in all sources of application defaults.
Returns success or failure. */
CF_EXPORT
Boolean CFPreferencesAppSynchronize(CFStringRef applicationID);
/* The primitive get mechanism; all arguments must be non-NULL
(use the constants above for common values). Only the exact
location specified by app-user-host is searched. The returned
CFType must be released by the caller when it is finished with it. */
CF_EXPORT
_Nullable CFPropertyListRef CFPreferencesCopyValue(CFStringRef key, CFStringRef applicationID, CFStringRef userName, CFStringRef hostName);
/* Convenience to fetch multiple keys at once. Keys in
keysToFetch that are not present in the returned dictionary
are not present in the domain. If keysToFetch is NULL, all
keys are fetched. */
CF_EXPORT
CFDictionaryRef CFPreferencesCopyMultiple(_Nullable CFArrayRef keysToFetch, CFStringRef applicationID, CFStringRef userName, CFStringRef hostName);
/* The primitive set function; all arguments except value must be
non-NULL. If value is NULL, the given key is removed */
CF_EXPORT
void CFPreferencesSetValue(CFStringRef key, _Nullable CFPropertyListRef value, CFStringRef applicationID, CFStringRef userName, CFStringRef hostName);
/* Convenience to set multiple values at once. Behavior is undefined
if a key is in both keysToSet and keysToRemove */
CF_EXPORT
void CFPreferencesSetMultiple(_Nullable CFDictionaryRef keysToSet, _Nullable CFArrayRef keysToRemove, CFStringRef applicationID, CFStringRef userName, CFStringRef hostName);
CF_EXPORT
Boolean CFPreferencesSynchronize(CFStringRef applicationID, CFStringRef userName, CFStringRef hostName);
/* Constructs and returns the list of the name of all applications
which have preferences in the scope of the given user and host, or NULL if no applications are there.
The returned value must be released by the caller; neither argument
may be NULL. Does not supported sandboxed applications. */
CF_EXPORT
_Nullable CFArrayRef CFPreferencesCopyApplicationList(CFStringRef userName, CFStringRef hostName) API_DEPRECATED("Unsupported API", macos(10.0,10.9), ios(2.0,7.0), watchos(2.0,2.0), tvos(9.0,9.0));
/* Constructs and returns the list of all keys set in the given
location, or NULL if no keys are set. The returned value must be released by the caller;
all arguments must be non-NULL */
CF_EXPORT
_Nullable CFArrayRef CFPreferencesCopyKeyList(CFStringRef applicationID, CFStringRef userName, CFStringRef hostName);
#ifndef CF_OPEN_SOURCE
/* Function to determine whether or not a given key has been imposed on the
user - In cases where machines and/or users are under some kind of management,
callers should use this function to determine whether or not to disable UI elements
corresponding to those preference keys. */
CF_EXPORT
Boolean CFPreferencesAppValueIsForced(CFStringRef key, CFStringRef applicationID);
#endif
CF_EXTERN_C_END
CF_ASSUME_NONNULL_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif /* ! __COREFOUNDATION_CFPREFERENCES__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFURLEnumerator.h | /*
CFURLEnumerator.h
Copyright (c) 2008-2019, Apple Inc. All rights reserved.
*/
#include <CoreFoundation/CFBase.h>
#if TARGET_OS_MAC || CF_BUILDING_CF || NSBUILDINGFOUNDATION
#if !defined(__COREFOUNDATION_CFURLENUMERATOR__)
#define __COREFOUNDATION_CFURLENUMERATOR__ 1
#include <CoreFoundation/CFArray.h>
#include <CoreFoundation/CFError.h>
#include <CoreFoundation/CFURL.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
typedef const struct CF_BRIDGED_MUTABLE_TYPE(id) __CFURLEnumerator *CFURLEnumeratorRef;
/* CFURLEnumeratorGetTypeID - Returns the CFURLEnumerator CFTypeID. */
CF_EXPORT
CFTypeID CFURLEnumeratorGetTypeID( void ) API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* CFURLEnumeratorOptions - Options for controlling enumerator behavior. */
typedef CF_OPTIONS(CFOptionFlags, CFURLEnumeratorOptions) {
kCFURLEnumeratorDefaultBehavior = 0, /* Use the default behavior for the enumerator. */
kCFURLEnumeratorDescendRecursively = 1UL << 0, /* The directory enumerator will recurse ("depth-first") into each subdirectory enumerated */
kCFURLEnumeratorSkipInvisibles = 1UL << 1, /* The directory or volume enumerator skips "hidden" or "invisible" objects */
kCFURLEnumeratorGenerateFileReferenceURLs = 1UL << 2, /* The volume enumerator generates file reference URLs */
kCFURLEnumeratorSkipPackageContents = 1UL << 3, /* The directory enumerator skips package directory contents */
kCFURLEnumeratorIncludeDirectoriesPreOrder = 1UL << 4, /* With this option set, a recursive directory enumerator will return directory URLs when CFURLEnumeratorGetNextURL() returns kCFURLEnumeratorSuccess before any of the directory's descendants are visited (pre-order). */
kCFURLEnumeratorIncludeDirectoriesPostOrder = 1UL << 5, /* With this option set, a recursive directory enumerator will return directory URLs when CFURLEnumeratorGetNextURL() returns kCFURLEnumeratorDirectoryPostOrderSuccess after all of directory's descendants have been visited (post-order). */
/* Note: if both kCFURLEnumeratorIncludeDirectoriesPreOrder and kCFURLEnumeratorIncludeDirectoriesPostOrder are used, directories will be seen twice (even empty directories and directories whose descendants are skipped) -- once when kCFURLEnumeratorSuccess is returned and once when kCFURLEnumeratorDirectoryPostOrderSuccess is returned. */
kCFURLEnumeratorGenerateRelativePathURLs API_AVAILABLE(macos(10.15), ios(13.0), watchos(6.0), tvos(13.0)) = 1UL << 6, /* The directory enumerator always generates file path URLs relative to the directory URL. This can reduce the size of each URL object returned during enumeration. */
};
/* CFURLEnumeratorCreateForDirectoryURL - Creates a directory enumerator, flat or recursive. Client specifies the directory URL to enumerate, a bit array of options, and an optional array of property keys to pre-fetch for the found URLs. Specifying pre-fetch properties allows the implementation to optimize device access by using bulk operations when available. Pre-fetching more properties than are actually needed may degrade performance.
A directory enumerator generates URLs with the same type as the directory URL being enumerated. If the directoryURL input parameter is a file reference URL, then generated URLs will be file reference URLs. If the directoryURL input parameter is a file path URL, then generated URLs will be file path URLs.
The kCFURLEnumeratorGenerateFileReferenceURLs option is ignored by CFURLEnumeratorCreateForDirectoryURL.
*/
CF_EXPORT
CFURLEnumeratorRef CFURLEnumeratorCreateForDirectoryURL( CFAllocatorRef alloc, CFURLRef directoryURL, CFURLEnumeratorOptions option, CFArrayRef propertyKeys ) API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* CFURLEnumeratorCreateForMountedVolumes - Creates an enumerator for mounted filesystem volumes. Client specifies an allocator, a bit array of options, and an optional array of property keys to pre-fetch for the volume URLs. Specifying pre-fetch properties allows the implementation to optimize device access by using bulk operations when available. Pre-fetching more properties than are actually needed may degrade performance.
A volume enumerator generates file path URLs. If you want a volume enumerator to generate file reference URLs, pass the kCFURLEnumeratorGenerateFileReferenceURLs option.
The kCFURLEnumeratorDescendRecursively and kCFURLEnumeratorSkipPackageContents options are ignored by CFURLEnumeratorCreateForMountedVolumes.
*/
CF_EXPORT
CFURLEnumeratorRef CFURLEnumeratorCreateForMountedVolumes( CFAllocatorRef alloc, CFURLEnumeratorOptions option, CFArrayRef propertyKeys ) API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* CFURLEnumeratorResult - Results for CFURLEnumeratorGetNextURL */
typedef CF_ENUM(CFIndex, CFURLEnumeratorResult) {
kCFURLEnumeratorSuccess = 1, /* The enumeration was successful. The url output parameter is valid. */
kCFURLEnumeratorEnd = 2, /* The enumeration is complete. */
kCFURLEnumeratorError = 3, /* An error occured during enumeration. The retained error output parameter describes the error. */
kCFURLEnumeratorDirectoryPostOrderSuccess = 4, /* The enumeration was successful. The url output parameter is for a directory after all of directory's descendants have been visited (post-order). This result will only be returned for directories when both the kCFURLEnumeratorDescendRecursively and kCFURLEnumeratorIncludeDirectoriesPostOrder options are passed to CFURLEnumeratorCreateForDirectoryURL. */
};
/* CFURLEnumeratorGetNextURL - Advances the enumerator. If kCFURLEnumeratorSuccess is returned, the url output parameter returns the next URL found. If kCFURLEnumeratorError is returned, an error has occured and the error output parameter describes the error. If kCFURLEnumeratorEnd, the enumeration is finished.
The url output parameter, if returned, is not retained. The error output parameter, if returned, is retained and must be released.
*/
CF_EXPORT
CFURLEnumeratorResult CFURLEnumeratorGetNextURL( CFURLEnumeratorRef enumerator, CFURLRef *url, CFErrorRef *error ) API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* CFURLEnumeratorSkipDescendents - Tells a recursive CFURLEnumerator not to descend into the directory of the last CFURLRef returned by CFURLEnumeratorGetNextURL.
Calls to CFURLEnumeratorSkipDescendents are ignored if:
* CFURLEnumeratorGetNextURL has never been called with the CFURLEnumerator.
* The last CFURL returned by CFURLEnumeratorGetNextURL is not a directory.
* The CFURLEnumerator was not created with CFURLEnumeratorCreateForDirectoryURL using the kCFURLEnumeratorDescendRecursively option.
*/
CF_EXPORT
void CFURLEnumeratorSkipDescendents( CFURLEnumeratorRef enumerator ) API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* CFURLEnumeratorGetDescendentLevel - Returns the number of levels a directory enumerator has descended down into the directory hierarchy from the starting directory. The children of the starting directory are at level 1. Each time a recursive enumerator descends into a subdirectory, it adds one to the descendent level. It then subtracts one from the level when it finishes a subdirectory and continues enumerating the parent directory.
*/
CF_EXPORT
CFIndex CFURLEnumeratorGetDescendentLevel( CFURLEnumeratorRef enumerator ) API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* CFURLEnumeratorGetSourceDidChange is deprecated. If your program is interested in directory hierarchy changes during enumeration (and most programs are not interested), you should use the File System Events API.
CFURLEnumeratorGetSourceDidChange does nothing and always returns false.
*/
CF_EXPORT
Boolean CFURLEnumeratorGetSourceDidChange( CFURLEnumeratorRef enumerator ) API_DEPRECATED("Use File System Events API instead", macos(10.6,10.7), ios(4.0,5.0), watchos(2.0,2.0), tvos(9.0,9.0));
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif /* ! __COREFOUNDATION_CFURLENUMERATOR__ */
#endif
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFStream.h | /* CFStream.h
Copyright (c) 2000-2019, Apple Inc. and the Swift project authors
Portions Copyright (c) 2014-2019, Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See http://swift.org/LICENSE.txt for license information
See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
*/
#if !defined(__COREFOUNDATION_CFSTREAM__)
#define __COREFOUNDATION_CFSTREAM__ 1
#include <CoreFoundation/CFBase.h>
#include <CoreFoundation/CFString.h>
#include <CoreFoundation/CFDictionary.h>
#include <CoreFoundation/CFURL.h>
#include <CoreFoundation/CFRunLoop.h>
#include <CoreFoundation/CFSocket.h>
#include <CoreFoundation/CFError.h>
#include <dispatch/dispatch.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
typedef struct {
CFIndex domain;
SInt32 error;
} CFStreamError;
typedef CFStringRef CFStreamPropertyKey CF_EXTENSIBLE_STRING_ENUM;
typedef CF_ENUM(CFIndex, CFStreamStatus) {
kCFStreamStatusNotOpen = 0,
kCFStreamStatusOpening, /* open is in-progress */
kCFStreamStatusOpen,
kCFStreamStatusReading,
kCFStreamStatusWriting,
kCFStreamStatusAtEnd, /* no further bytes can be read/written */
kCFStreamStatusClosed,
kCFStreamStatusError
};
typedef CF_OPTIONS(CFOptionFlags, CFStreamEventType) {
kCFStreamEventNone = 0,
kCFStreamEventOpenCompleted = 1,
kCFStreamEventHasBytesAvailable = 2,
kCFStreamEventCanAcceptBytes = 4,
kCFStreamEventErrorOccurred = 8,
kCFStreamEventEndEncountered = 16
};
typedef struct {
CFIndex version;
void * _Null_unspecified info;
void *_Null_unspecified(* _Null_unspecified retain)(void * _Null_unspecified info);
void (* _Null_unspecified release)(void * _Null_unspecified info);
CFStringRef _Null_unspecified (* _Null_unspecified copyDescription)(void * _Null_unspecified info);
} CFStreamClientContext;
typedef struct CF_BRIDGED_MUTABLE_TYPE(NSInputStream) __CFReadStream * CFReadStreamRef;
typedef struct CF_BRIDGED_MUTABLE_TYPE(NSOutputStream) __CFWriteStream * CFWriteStreamRef;
typedef void (*CFReadStreamClientCallBack)(CFReadStreamRef _Null_unspecified stream, CFStreamEventType type, void * _Null_unspecified clientCallBackInfo);
typedef void (*CFWriteStreamClientCallBack)(CFWriteStreamRef _Null_unspecified stream, CFStreamEventType type, void * _Null_unspecified clientCallBackInfo);
CF_EXPORT
CFTypeID CFReadStreamGetTypeID(void);
CF_EXPORT
CFTypeID CFWriteStreamGetTypeID(void);
/* Memory streams */
/* Value will be a CFData containing all bytes thusfar written; used to recover the data written to a memory write stream. */
CF_EXPORT
const CFStreamPropertyKey _Null_unspecified kCFStreamPropertyDataWritten;
/* Pass kCFAllocatorNull for bytesDeallocator to prevent CFReadStream from deallocating bytes; otherwise, CFReadStream will deallocate bytes when the stream is destroyed */
CF_EXPORT
CFReadStreamRef _Null_unspecified CFReadStreamCreateWithBytesNoCopy(CFAllocatorRef _Null_unspecified alloc, const UInt8 * _Null_unspecified bytes, CFIndex length, CFAllocatorRef _Null_unspecified bytesDeallocator);
/* The stream writes into the buffer given; when bufferCapacity is exhausted, the stream is exhausted (status becomes kCFStreamStatusAtEnd) */
CF_EXPORT
CFWriteStreamRef _Null_unspecified CFWriteStreamCreateWithBuffer(CFAllocatorRef _Null_unspecified alloc, UInt8 * _Null_unspecified buffer, CFIndex bufferCapacity);
/* New buffers are allocated from bufferAllocator as bytes are written to the stream. At any point, you can recover the bytes thusfar written by asking for the property kCFStreamPropertyDataWritten, above */
CF_EXPORT
CFWriteStreamRef _Null_unspecified CFWriteStreamCreateWithAllocatedBuffers(CFAllocatorRef _Null_unspecified alloc, CFAllocatorRef _Null_unspecified bufferAllocator);
/* File streams */
CF_EXPORT
CFReadStreamRef _Null_unspecified CFReadStreamCreateWithFile(CFAllocatorRef _Null_unspecified alloc, CFURLRef _Null_unspecified fileURL);
CF_EXPORT
CFWriteStreamRef _Null_unspecified CFWriteStreamCreateWithFile(CFAllocatorRef _Null_unspecified alloc, CFURLRef _Null_unspecified fileURL);
CF_IMPLICIT_BRIDGING_DISABLED
CF_EXPORT
void CFStreamCreateBoundPair(CFAllocatorRef _Null_unspecified alloc, CFReadStreamRef _Null_unspecified * _Null_unspecified readStream, CFWriteStreamRef _Null_unspecified * _Null_unspecified writeStream, CFIndex transferBufferSize);
CF_IMPLICIT_BRIDGING_ENABLED
/* Property for file write streams; value should be a CFBoolean. Set to TRUE to append to a file, rather than to replace its contents */
CF_EXPORT
const CFStreamPropertyKey _Null_unspecified kCFStreamPropertyAppendToFile;
CF_EXPORT
const CFStreamPropertyKey _Null_unspecified kCFStreamPropertyFileCurrentOffset; // Value is a CFNumber
/* Socket stream properties */
/* Value will be a CFData containing the native handle */
CF_EXPORT
const CFStreamPropertyKey _Null_unspecified kCFStreamPropertySocketNativeHandle;
/* Value will be a CFString, or NULL if unknown */
CF_EXPORT
const CFStreamPropertyKey _Null_unspecified kCFStreamPropertySocketRemoteHostName;
/* Value will be a CFNumber, or NULL if unknown */
CF_EXPORT
const CFStreamPropertyKey _Null_unspecified kCFStreamPropertySocketRemotePortNumber;
/*
* kCFStreamErrorDomainSOCKS
*
* Discussion:
* SOCKS proxy error domain. Errors formulated using inlines below.
*
*/
CF_EXPORT const int kCFStreamErrorDomainSOCKS CF_AVAILABLE(10_0, 2_0);
/*
* kCFStreamPropertySOCKSProxy
*
* Discussion:
* Stream property key, for both set and copy operations. To set a
* stream to use a SOCKS proxy, call CFReadStreamSetProperty or
* CFWriteStreamSetProperty with the property name set to
* kCFStreamPropertySOCKSProxy and the value being a dictionary with
* at least the following two keys: kCFStreamPropertySOCKSProxyHost
* and kCFStreamPropertySOCKSProxyPort. The dictionary returned by
* SystemConfiguration for SOCKS proxies will work without
* alteration.
*
*/
CF_EXPORT const CFStringRef _Nonnull kCFStreamPropertySOCKSProxy CF_AVAILABLE(10_2, 2_0);
/*
* kCFStreamPropertySOCKSProxyHost
*
* Discussion:
* CFDictionary key for SOCKS proxy information. The key
* kCFStreamPropertySOCKSProxyHost should contain a CFStringRef
* value representing the SOCKS proxy host. Defined to match
* kSCPropNetProxiesSOCKSProxy
*
*/
CF_EXPORT const CFStringRef _Nonnull kCFStreamPropertySOCKSProxyHost CF_AVAILABLE(10_2, 2_0);
/*
* kCFStreamPropertySOCKSProxyPort
*
* Discussion:
* CFDictionary key for SOCKS proxy information. The key
* kCFStreamPropertySOCKSProxyPort should contain a CFNumberRef
* which itself is of type kCFNumberSInt32Type. This value should
* represent the port on which the proxy is listening. Defined to
* match kSCPropNetProxiesSOCKSPort
*
*/
CF_EXPORT const CFStringRef _Nonnull kCFStreamPropertySOCKSProxyPort CF_AVAILABLE(10_2, 2_0);
/*
* kCFStreamPropertySOCKSVersion
*
* Discussion:
* CFDictionary key for SOCKS proxy information. By default, SOCKS5
* will be used unless there is a kCFStreamPropertySOCKSVersion key
* in the dictionary. Its value must be
* kCFStreamSocketSOCKSVersion4 or kCFStreamSocketSOCKSVersion5 to
* set SOCKS4 or SOCKS5, respectively.
*
*/
CF_EXPORT const CFStringRef _Nonnull kCFStreamPropertySOCKSVersion CF_AVAILABLE(10_2, 2_0);
/*
* kCFStreamSocketSOCKSVersion4
*
* Discussion:
* CFDictionary value for SOCKS proxy information. Indcates that
* SOCKS will or is using version 4 of the SOCKS protocol.
*
*/
CF_EXPORT const CFStringRef _Nonnull kCFStreamSocketSOCKSVersion4 CF_AVAILABLE(10_2, 2_0);
/*
* kCFStreamSocketSOCKSVersion5
*
* Discussion:
* CFDictionary value for SOCKS proxy information. Indcates that
* SOCKS will or is using version 5 of the SOCKS protocol.
*
*/
CF_EXPORT const CFStringRef _Nonnull kCFStreamSocketSOCKSVersion5 CF_AVAILABLE(10_2, 2_0);
/*
* kCFStreamPropertySOCKSUser
*
* Discussion:
* CFDictionary key for SOCKS proxy information. To set a user name
* and/or password, if required, the dictionary must contain the
* key(s) kCFStreamPropertySOCKSUser and/or
* kCFStreamPropertySOCKSPassword with the value being the user's
* name as a CFStringRef and/or the user's password as a
* CFStringRef, respectively.
*
*/
CF_EXPORT const CFStringRef _Nonnull kCFStreamPropertySOCKSUser CF_AVAILABLE(10_2, 2_0);
/*
* kCFStreamPropertySOCKSPassword
*
* Discussion:
* CFDictionary key for SOCKS proxy information. To set a user name
* and/or password, if required, the dictionary must contain the
* key(s) kCFStreamPropertySOCKSUser and/or
* kCFStreamPropertySOCKSPassword with the value being the user's
* name as a CFStringRef and/or the user's password as a
* CFStringRef, respectively.
*
*/
CF_EXPORT const CFStringRef _Nonnull kCFStreamPropertySOCKSPassword CF_AVAILABLE(10_2, 2_0);
/*
* kCFStreamErrorDomainSSL
*
* Discussion:
* Errors located in Security/SecureTransport.h
*
*/
CF_EXPORT const int kCFStreamErrorDomainSSL CF_AVAILABLE(10_2, 2_0);
/*
* kCFStreamPropertySocketSecurityLevel
*
* Discussion:
* Stream property key, for both set and copy operations. To set a
* stream to be secure, call CFReadStreamSetProperty or
* CFWriteStreamSetPropertywith the property name set to
* kCFStreamPropertySocketSecurityLevel and the value being one of
* the following values. Streams may set a security level after
* open in order to allow on-the-fly securing of a stream.
*
*/
CF_EXPORT const CFStringRef _Nonnull kCFStreamPropertySocketSecurityLevel CF_AVAILABLE(10_2, 2_0);
/*
* kCFStreamSocketSecurityLevelNone
*
* Discussion:
* Stream property value, for both set and copy operations.
* Indicates to use no security (default setting).
*
*/
CF_EXPORT const CFStringRef _Nonnull kCFStreamSocketSecurityLevelNone CF_AVAILABLE(10_2, 2_0);
/*
* kCFStreamSocketSecurityLevelSSLv2
*
* Note: SSLv2 is DEPRECATED starting in OS X 10.12 and iOS 10.0.
*
* Discussion:
* Stream property value, for both set and copy operations.
* Indicates to use SSLv2 security.
*
*/
CF_EXPORT const CFStringRef _Nonnull kCFStreamSocketSecurityLevelSSLv2 CF_DEPRECATED(10_2, 10_12, 2_0, 10_0);
/*
* kCFStreamSocketSecurityLevelSSLv3
*
* Note: SSLv3 is DEPRECATED starting in OS X 10.12 and iOS 10.0.
*
* Discussion:
* Stream property value, for both set and copy operations.
* Indicates to use SSLv3 security.
*
*/
CF_EXPORT const CFStringRef _Nonnull kCFStreamSocketSecurityLevelSSLv3 CF_DEPRECATED(10_2, 10_12, 2_0, 10_0);
/*
* kCFStreamSocketSecurityLevelTLSv1
*
* Discussion:
* Stream property value, for both set and copy operations.
* Indicates to use TLSv1 security.
*
*/
CF_EXPORT const CFStringRef _Nonnull kCFStreamSocketSecurityLevelTLSv1 CF_AVAILABLE(10_2, 2_0);
/*
* kCFStreamSocketSecurityLevelNegotiatedSSL
*
* Discussion:
* Stream property value, for both set and copy operations.
* Indicates to use TLS or SSL with fallback to lower versions. This
* is what HTTPS does, for instance.
*
*/
CF_EXPORT const CFStringRef _Nonnull kCFStreamSocketSecurityLevelNegotiatedSSL CF_AVAILABLE(10_2, 2_0);
/*
* kCFStreamPropertyShouldCloseNativeSocket
*
* Discussion:
* Set the value to kCFBooleanTrue if the stream should close and
* release the underlying native socket when the stream is released.
* Set the value to kCFBooleanFalse to keep the native socket from
* closing and releasing when the stream is released. If the stream
* was created with a native socket, the default property setting on
* the stream is kCFBooleanFalse. The
* kCFStreamPropertyShouldCloseNativeSocket can be set through
* CFReadStreamSetProperty or CFWriteStreamSetProperty. The
* property can be copied through CFReadStreamCopyProperty or
* CFWriteStreamCopyProperty.
*
*/
CF_EXPORT const CFStringRef _Nonnull kCFStreamPropertyShouldCloseNativeSocket CF_AVAILABLE(10_2, 2_0);
CF_IMPLICIT_BRIDGING_DISABLED
/* Socket streams; the returned streams are paired such that they use the same socket; pass NULL if you want only the read stream or the write stream */
CF_EXPORT
void CFStreamCreatePairWithSocket(CFAllocatorRef _Null_unspecified alloc, CFSocketNativeHandle sock, CFReadStreamRef _Null_unspecified * _Null_unspecified readStream, CFWriteStreamRef _Null_unspecified * _Null_unspecified writeStream) API_DEPRECATED("Use nw_connection_t in Network framework instead", macos(10.1, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
CF_EXPORT
void CFStreamCreatePairWithSocketToHost(CFAllocatorRef _Null_unspecified alloc, CFStringRef _Null_unspecified host, UInt32 port, CFReadStreamRef _Null_unspecified * _Null_unspecified readStream, CFWriteStreamRef _Null_unspecified * _Null_unspecified writeStream) API_DEPRECATED("Use nw_connection_t in Network framework instead", macos(10.1, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
CF_EXPORT
void CFStreamCreatePairWithPeerSocketSignature(CFAllocatorRef _Null_unspecified alloc, const CFSocketSignature * _Null_unspecified signature, CFReadStreamRef _Null_unspecified * _Null_unspecified readStream, CFWriteStreamRef _Null_unspecified * _Null_unspecified writeStream) API_DEPRECATED("Use nw_connection_t in Network framework instead", macos(10.1, API_TO_BE_DEPRECATED), ios(2.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
CF_IMPLICIT_BRIDGING_ENABLED
/* Returns the current state of the stream */
CF_EXPORT
CFStreamStatus CFReadStreamGetStatus(CFReadStreamRef _Null_unspecified stream);
CF_EXPORT
CFStreamStatus CFWriteStreamGetStatus(CFWriteStreamRef _Null_unspecified stream);
/* Returns NULL if no error has occurred; otherwise returns the error. */
CF_EXPORT
CFErrorRef _Null_unspecified CFReadStreamCopyError(CFReadStreamRef _Null_unspecified stream) API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0));
CF_EXPORT
CFErrorRef _Null_unspecified CFWriteStreamCopyError(CFWriteStreamRef _Null_unspecified stream) API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0));
/* Returns success/failure. Opening a stream causes it to reserve all the system
resources it requires. If the stream can open non-blocking, this will always
return TRUE; listen to the run loop source to find out when the open completes
and whether it was successful, or poll using CFRead/WriteStreamGetStatus(), waiting
for a status of kCFStreamStatusOpen or kCFStreamStatusError. */
CF_EXPORT
Boolean CFReadStreamOpen(CFReadStreamRef _Null_unspecified stream);
CF_EXPORT
Boolean CFWriteStreamOpen(CFWriteStreamRef _Null_unspecified stream);
/* Terminates the flow of bytes; releases any system resources required by the
stream. The stream may not fail to close. You may call CFStreamClose() to
effectively abort a stream. */
CF_EXPORT
void CFReadStreamClose(CFReadStreamRef _Null_unspecified stream);
CF_EXPORT
void CFWriteStreamClose(CFWriteStreamRef _Null_unspecified stream);
/* Whether there is data currently available for reading; returns TRUE if it's
impossible to tell without trying */
CF_EXPORT
Boolean CFReadStreamHasBytesAvailable(CFReadStreamRef _Null_unspecified stream);
/* Returns the number of bytes read, or -1 if an error occurs preventing any
bytes from being read, or 0 if the stream's end was encountered.
It is an error to try and read from a stream that hasn't been opened first.
This call will block until at least one byte is available; it will NOT block
until the entire buffer can be filled. To avoid blocking, either poll using
CFReadStreamHasBytesAvailable() or use the run loop and listen for the
kCFStreamEventHasBytesAvailable event for notification of data available. */
CF_EXPORT
CFIndex CFReadStreamRead(CFReadStreamRef _Null_unspecified stream, UInt8 * _Null_unspecified buffer, CFIndex bufferLength);
/* Returns a pointer to an internal buffer if possible (setting *numBytesRead
to the length of the returned buffer), otherwise returns NULL; guaranteed
to return in O(1). Bytes returned in the buffer are considered read from
the stream; if maxBytesToRead is greater than 0, not more than maxBytesToRead
will be returned. If maxBytesToRead is less than or equal to zero, as many bytes
as are readily available will be returned. The returned buffer is good only
until the next stream operation called on the stream. Caller should neither
change the contents of the returned buffer nor attempt to deallocate the buffer;
it is still owned by the stream. */
CF_EXPORT
const UInt8 * _Null_unspecified CFReadStreamGetBuffer(CFReadStreamRef _Null_unspecified stream, CFIndex maxBytesToRead, CFIndex * _Null_unspecified numBytesRead);
/* Whether the stream can currently be written to without blocking;
returns TRUE if it's impossible to tell without trying */
CF_EXPORT
Boolean CFWriteStreamCanAcceptBytes(CFWriteStreamRef _Null_unspecified stream);
/* Returns the number of bytes successfully written, -1 if an error has
occurred, or 0 if the stream has been filled to capacity (for fixed-length
streams). If the stream is not full, this call will block until at least
one byte is written. To avoid blocking, either poll via CFWriteStreamCanAcceptBytes
or use the run loop and listen for the kCFStreamEventCanAcceptBytes event. */
CF_EXPORT
CFIndex CFWriteStreamWrite(CFWriteStreamRef _Null_unspecified stream, const UInt8 * _Null_unspecified buffer, CFIndex bufferLength);
/* Particular streams can name properties and assign meanings to them; you
access these properties through the following calls. A property is any interesting
information about the stream other than the data being transmitted itself.
Examples include the headers from an HTTP transmission, or the expected
number of bytes, or permission information, etc. Properties that can be set
configure the behavior of the stream, and may only be settable at particular times
(like before the stream has been opened). See the documentation for particular
properties to determine their get- and set-ability. */
CF_EXPORT
CFTypeRef _Null_unspecified CFReadStreamCopyProperty(CFReadStreamRef _Null_unspecified stream, CFStreamPropertyKey _Null_unspecified propertyName);
CF_EXPORT
CFTypeRef _Null_unspecified CFWriteStreamCopyProperty(CFWriteStreamRef _Null_unspecified stream, CFStreamPropertyKey _Null_unspecified propertyName);
/* Returns TRUE if the stream recognizes and accepts the given property-value pair;
FALSE otherwise. */
CF_EXPORT
Boolean CFReadStreamSetProperty(CFReadStreamRef _Null_unspecified stream, CFStreamPropertyKey _Null_unspecified propertyName, CFTypeRef _Null_unspecified propertyValue);
CF_EXPORT
Boolean CFWriteStreamSetProperty(CFWriteStreamRef _Null_unspecified stream, CFStreamPropertyKey _Null_unspecified propertyName, CFTypeRef _Null_unspecified propertyValue);
/* Asynchronous processing - If you wish to neither poll nor block, you may register
a client to hear about interesting events that occur on a stream. Only one client
per stream is allowed; registering a new client replaces the previous one.
Once you have set a client, the stream must be scheduled to provide the context in
which the client will be called. Streams may be scheduled on a single dispatch queue
or on one or more run loops. If scheduled on a run loop, it is the caller's responsibility
to ensure that at least one of the scheduled run loops is being run.
NOTE: Unlike other CoreFoundation APIs, pasing a NULL clientContext here will remove
the client. If you do not care about the client context (i.e. your only concern
is that your callback be called), you should pass in a valid context where every
entry is 0 or NULL.
*/
CF_EXPORT
Boolean CFReadStreamSetClient(CFReadStreamRef _Null_unspecified stream, CFOptionFlags streamEvents, CFReadStreamClientCallBack _Null_unspecified clientCB, CFStreamClientContext * _Null_unspecified clientContext);
CF_EXPORT
Boolean CFWriteStreamSetClient(CFWriteStreamRef _Null_unspecified stream, CFOptionFlags streamEvents, CFWriteStreamClientCallBack _Null_unspecified clientCB, CFStreamClientContext * _Null_unspecified clientContext);
CF_EXPORT
void CFReadStreamScheduleWithRunLoop(CFReadStreamRef _Null_unspecified stream, CFRunLoopRef _Null_unspecified runLoop, CFRunLoopMode _Null_unspecified runLoopMode);
CF_EXPORT
void CFWriteStreamScheduleWithRunLoop(CFWriteStreamRef _Null_unspecified stream, CFRunLoopRef _Null_unspecified runLoop, _Null_unspecified CFRunLoopMode runLoopMode);
CF_EXPORT
void CFReadStreamUnscheduleFromRunLoop(CFReadStreamRef _Null_unspecified stream, CFRunLoopRef _Null_unspecified runLoop, CFRunLoopMode _Null_unspecified runLoopMode);
CF_EXPORT
void CFWriteStreamUnscheduleFromRunLoop(CFWriteStreamRef _Null_unspecified stream, CFRunLoopRef _Null_unspecified runLoop, CFRunLoopMode _Null_unspecified runLoopMode);
/*
* Specify the dispatch queue upon which the client callbacks will be invoked.
* Passing NULL for the queue will prevent future callbacks from being invoked.
* Specifying a dispatch queue using this API will unschedule the stream from
* any run loops it had previously been scheduled upon - similarly, scheduling
* with a runloop will disassociate the stream from any existing dispatch queue.
*/
CF_EXPORT
void CFReadStreamSetDispatchQueue(CFReadStreamRef _Null_unspecified stream, dispatch_queue_t _Null_unspecified q) API_AVAILABLE(macos(10.9), ios(7.0), watchos(2.0), tvos(9.0));
CF_EXPORT
void CFWriteStreamSetDispatchQueue(CFWriteStreamRef _Null_unspecified stream, dispatch_queue_t _Null_unspecified q) API_AVAILABLE(macos(10.9), ios(7.0), watchos(2.0), tvos(9.0));
/*
* Returns the previously set dispatch queue with an incremented retain count.
* Note that the stream's queue may have been set to NULL if the stream was
* scheduled on a runloop subsequent to it having had a dispatch queue set.
*/
CF_EXPORT
dispatch_queue_t _Null_unspecified CFReadStreamCopyDispatchQueue(CFReadStreamRef _Null_unspecified stream) API_AVAILABLE(macos(10.9), ios(7.0), watchos(2.0), tvos(9.0));
CF_EXPORT
dispatch_queue_t _Null_unspecified CFWriteStreamCopyDispatchQueue(CFWriteStreamRef _Null_unspecified stream) API_AVAILABLE(macos(10.9), ios(7.0), watchos(2.0), tvos(9.0));
/* The following API is deprecated starting in 10.5; please use CFRead/WriteStreamCopyError(), above, instead */
typedef CF_ENUM(CFIndex, CFStreamErrorDomain) {
kCFStreamErrorDomainCustom = -1L, /* custom to the kind of stream in question */
kCFStreamErrorDomainPOSIX = 1, /* POSIX errno; interpret using <sys/errno.h> */
kCFStreamErrorDomainMacOSStatus /* OSStatus type from Carbon APIs; interpret using <MacTypes.h> */
};
CF_EXPORT
CFStreamError CFReadStreamGetError(CFReadStreamRef _Null_unspecified stream);
CF_EXPORT
CFStreamError CFWriteStreamGetError(CFWriteStreamRef _Null_unspecified stream);
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif /* ! __COREFOUNDATION_CFSTREAM__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFString.h | /* CFString.h
Copyright (c) 1998-2019, Apple Inc. and the Swift project authors
Portions Copyright (c) 2014-2019, Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See http://swift.org/LICENSE.txt for license information
See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
*/
#if !defined(__COREFOUNDATION_CFSTRING__)
#define __COREFOUNDATION_CFSTRING__ 1
#include <CoreFoundation/CFBase.h>
#include <CoreFoundation/CFArray.h>
#include <CoreFoundation/CFData.h>
#include <CoreFoundation/CFDictionary.h>
#include <CoreFoundation/CFCharacterSet.h>
#include <CoreFoundation/CFLocale.h>
#include <stdarg.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
/*
Please note: CFStrings are conceptually an array of Unicode characters.
However, in general, how a CFString stores this array is an implementation
detail. For instance, CFString might choose to use an array of 8-bit characters
to store its contents, or it might use multiple blocks of memory, or whatever.
This is especially true since CFString is toll-free bridged with NSString, enabling
any NSString instance to be used as a CFString. Furthermore, the implementation
may change depending on the default system encoding, the user's language,
or even a release or update of the OS.
What this means is that you should use the following advanced functions with care:
CFStringGetPascalStringPtr()
CFStringGetCStringPtr()
CFStringGetCharactersPtr()
These functions are provided for optimization only. They will either return the desired
pointer quickly, in constant time, or they return NULL. They might choose to return NULL
for many reasons; for instance it's possible that for users running in different
languages these sometimes return NULL; or in a future OS release the first two might
switch to always returning NULL. Never observing NULL returns in your usages of these
functions does not mean they won't ever return NULL. In fact, this happened with the
introduction of tagged pointer strings in OS X 10.10, and a year later iOS 9.
(But please note the CFStringGetCharactersPtr() exception mentioned further below.)
In your usages of these functions, if you get a NULL return, use the non-Ptr version
of the functions as shown in this example:
char buffer[BUFSIZE];
const char *ptr = CFStringGetCStringPtr(str, encoding);
if (ptr == NULL) {
if (CFStringGetCString(str, buffer, BUFSIZE, encoding)) ptr = buffer;
}
Note that CFStringGetCString() or CFStringGetPascalString() calls might still fail --- but
that will happen in two circumstances only: The conversion from the UniChar contents of CFString
to the specified encoding fails, or the buffer is too small. If they fail, that means
the conversion was not possible.
If you need a copy of the buffer in the above example, you might consider simply calling
CFStringGetCString() in all cases --- CFStringGetCStringPtr() is simply an optimization.
In addition, the following functions, which create immutable CFStrings from developer
supplied buffers without copying the buffers, might have to actually copy
under certain circumstances (If they do copy, the buffer will be dealt with by the
"contentsDeallocator" argument.):
CFStringCreateWithPascalStringNoCopy()
CFStringCreateWithCStringNoCopy()
CFStringCreateWithCharactersNoCopy()
You should of course never depend on the backing store of these CFStrings being
what you provided, and in other no circumstance should you change the contents
of that buffer (given that would break the invariant about the CFString being immutable).
Having said all this, there are actually ways to create a CFString where the backing store
is external, and can be manipulated by the developer or CFString itself:
CFStringCreateMutableWithExternalCharactersNoCopy()
CFStringSetExternalCharactersNoCopy()
A "contentsAllocator" is used to realloc or free the backing store by CFString.
kCFAllocatorNull can be provided to assure CFString will never realloc or free the buffer.
Developer can call CFStringSetExternalCharactersNoCopy() to update
CFString's idea of what's going on, if the buffer is changed externally. In these
strings, CFStringGetCharactersPtr() is guaranteed to return the external buffer.
These functions are here to allow wrapping a buffer of UniChar characters in a CFString,
allowing the buffer to passed into CFString functions and also manipulated via CFString
mutation functions. In general, developers should not use this technique for all strings,
as it prevents CFString from using certain optimizations.
*/
/* Identifier for character encoding; the values are the same as Text Encoding Converter TextEncoding.
*/
typedef UInt32 CFStringEncoding;
/* Platform-independent built-in encodings; always available on all platforms.
Call CFStringGetSystemEncoding() to get the default system encoding.
*/
#define kCFStringEncodingInvalidId (0xffffffffU)
typedef CF_ENUM(CFStringEncoding, CFStringBuiltInEncodings) {
kCFStringEncodingMacRoman = 0,
kCFStringEncodingWindowsLatin1 = 0x0500, /* ANSI codepage 1252 */
kCFStringEncodingISOLatin1 = 0x0201, /* ISO 8859-1 */
kCFStringEncodingNextStepLatin = 0x0B01, /* NextStep encoding*/
kCFStringEncodingASCII = 0x0600, /* 0..127 (in creating CFString, values greater than 0x7F are treated as corresponding Unicode value) */
kCFStringEncodingUnicode = 0x0100, /* kTextEncodingUnicodeDefault + kTextEncodingDefaultFormat (aka kUnicode16BitFormat) */
kCFStringEncodingUTF8 = 0x08000100, /* kTextEncodingUnicodeDefault + kUnicodeUTF8Format */
kCFStringEncodingNonLossyASCII = 0x0BFF, /* 7bit Unicode variants used by Cocoa & Java */
kCFStringEncodingUTF16 = 0x0100, /* kTextEncodingUnicodeDefault + kUnicodeUTF16Format (alias of kCFStringEncodingUnicode) */
kCFStringEncodingUTF16BE = 0x10000100, /* kTextEncodingUnicodeDefault + kUnicodeUTF16BEFormat */
kCFStringEncodingUTF16LE = 0x14000100, /* kTextEncodingUnicodeDefault + kUnicodeUTF16LEFormat */
kCFStringEncodingUTF32 = 0x0c000100, /* kTextEncodingUnicodeDefault + kUnicodeUTF32Format */
kCFStringEncodingUTF32BE = 0x18000100, /* kTextEncodingUnicodeDefault + kUnicodeUTF32BEFormat */
kCFStringEncodingUTF32LE = 0x1c000100 /* kTextEncodingUnicodeDefault + kUnicodeUTF32LEFormat */
};
/* CFString type ID */
CF_EXPORT
CFTypeID CFStringGetTypeID(void);
/* CFSTR() allows creation of compile-time constant CFStringRefs; the argument
should be a constant C-string.
CFSTR(), not being a "Copy" or "Create" function, does not return a new
reference for you. So, you should not release the return value. This is
much like constant C or Pascal strings --- when you use "hello world"
in a program, you do not free it.
However, strings returned from CFSTR() can be retained and released in a
properly nested fashion, just like any other CF type. That is, if you pass
a CFSTR() return value to a function such as SetMenuItemWithCFString(), the
function can retain it, then later, when it's done with it, it can release it.
Non-7 bit characters (that is, above 127) in CFSTR() are supported, although care must
be taken in dealing with files containing them. If you can trust your editor and tools
to deal with non-ASCII characters in the source code, then you can use them directly
in CFSTR(); otherwise, you can represent such characters with their escaped octal
equivalents in the encoding the compiler will use to interpret them (for instance,
O-umlaut is \303\226 in UTF-8). UTF-8 is the recommended encoding here,
since it is the default choice with Mac OS X developer tools.
*/
#ifndef CF_OPEN_SOURCE
#if TARGET_OS_WIN32
#undef __CONSTANT_CFSTRINGS__
#endif
#endif
#if DEPLOYMENT_RUNTIME_SWIFT
#if TARGET_OS_MAC
#define _CF_CONSTANT_STRING_SWIFT_CLASS $s15SwiftFoundation19_NSCFConstantStringCN
#else
#define _CF_CONSTANT_STRING_SWIFT_CLASS $s10Foundation19_NSCFConstantStringCN
#endif
CF_EXPORT void *_CF_CONSTANT_STRING_SWIFT_CLASS[];
#endif
#if DEPLOYMENT_RUNTIME_SWIFT && TARGET_OS_MAC
struct __CFConstStr {
struct {
__ptrauth_cf_objc_isa_pointer uintptr_t _cfisa;
uintptr_t _swift_rc;
uint64_t _cfinfoa;
} _base;
uint8_t *_ptr;
#if TARGET_RT_64_BIT && defined(__BIG_ENDIAN__)
uint64_t _length;
#else // 32-bit:
uint32_t _length;
#endif // TARGET_RT_64_BIT && defined(__BIG_ENDIAN__)
};
#if __BIG_ENDIAN__
#define CFSTR(cStr) ({ \
static struct __CFConstStr str = {{(uintptr_t)&_CF_CONSTANT_STRING_SWIFT_CLASS, _CF_CONSTANT_OBJECT_STRONG_RC, 0x00000000C8070000}, (uint8_t *)(cStr), sizeof(cStr) - 1}; \
(CFStringRef)&str; \
})
#else // Little endian:
#define CFSTR(cStr) ({ \
static struct __CFConstStr str = {{(uintptr_t)&_CF_CONSTANT_STRING_SWIFT_CLASS, _CF_CONSTANT_OBJECT_STRONG_RC, 0x07C8}, (uint8_t *)(cStr), sizeof(cStr) - 1}; \
(CFStringRef)&str; \
})
#endif // __BIG_ENDIAN__
#else
#ifdef __CONSTANT_CFSTRINGS__
#define CFSTR(cStr) ((CFStringRef) __builtin___CFStringMakeConstantString ("" cStr ""))
#else
#define CFSTR(cStr) __CFStringMakeConstantString("" cStr "")
#endif
#endif
#if defined(__GNUC__) && (__GNUC__*10+__GNUC_MINOR__ >= 42) && defined(__APPLE_CC__) && (__APPLE_CC__ > 1) && !defined(__INTEL_COMPILER) && TARGET_OS_MAC
#define CF_FORMAT_FUNCTION(F,A) __attribute__((format(CFString, F, A)))
#define CF_FORMAT_ARGUMENT(A) __attribute__((format_arg(A)))
#else
#define CF_FORMAT_FUNCTION(F,A)
#define CF_FORMAT_ARGUMENT(A)
#endif
/*** Immutable string creation functions ***/
/* Functions to create basic immutable strings. The provided allocator is used for all memory activity in these functions.
*/
/* The following four functions copy the provided buffer into CFString's internal storage. */
CF_EXPORT
CFStringRef CFStringCreateWithPascalString(CFAllocatorRef alloc, ConstStr255Param pStr, CFStringEncoding encoding);
CF_EXPORT
CFStringRef CFStringCreateWithCString(CFAllocatorRef alloc, const char *cStr, CFStringEncoding encoding);
/* The following takes an explicit length, and allows you to specify whether the data is an external format --- that is, whether to pay attention to the BOM character (if any) and do byte swapping if necessary
*/
CF_EXPORT
CFStringRef CFStringCreateWithBytes(CFAllocatorRef alloc, const UInt8 *bytes, CFIndex numBytes, CFStringEncoding encoding, Boolean isExternalRepresentation);
CF_EXPORT
CFStringRef CFStringCreateWithCharacters(CFAllocatorRef alloc, const UniChar *chars, CFIndex numChars);
/* These functions try not to copy the provided buffer. The buffer will be deallocated
with the provided contentsDeallocator when it's no longer needed; to not free
the buffer, specify kCFAllocatorNull here. As usual, NULL means default allocator.
NOTE: Do not count on these buffers as being used by the string;
in some cases the CFString might free the buffer and use something else
(for instance if it decides to always use Unicode encoding internally).
NOTE: If you are not transferring ownership of the buffer to the CFString
(for instance, you supplied contentsDeallocator = kCFAllocatorNull), it is your
responsibility to assure the buffer does not go away during the lifetime of the string.
If the string is retained or copied, its lifetime might extend in ways you cannot
predict. So, for strings created with buffers whose lifetimes you cannot
guarantee, you need to be extremely careful --- do not hand it out to any
APIs which might retain or copy the strings.
*/
CF_EXPORT
CFStringRef CFStringCreateWithPascalStringNoCopy(CFAllocatorRef alloc, ConstStr255Param pStr, CFStringEncoding encoding, CFAllocatorRef contentsDeallocator);
CF_EXPORT
CFStringRef CFStringCreateWithCStringNoCopy(CFAllocatorRef alloc, const char *cStr, CFStringEncoding encoding, CFAllocatorRef contentsDeallocator);
/* The following takes an explicit length, and allows you to specify whether the data is an external format --- that is, whether to pay attention to the BOM character (if any) and do byte swapping if necessary
*/
CF_EXPORT
CFStringRef CFStringCreateWithBytesNoCopy(CFAllocatorRef alloc, const UInt8 *bytes, CFIndex numBytes, CFStringEncoding encoding, Boolean isExternalRepresentation, CFAllocatorRef contentsDeallocator);
CF_EXPORT
CFStringRef CFStringCreateWithCharactersNoCopy(CFAllocatorRef alloc, const UniChar *chars, CFIndex numChars, CFAllocatorRef contentsDeallocator);
/* Create copies of part or all of the string.
*/
CF_EXPORT
CFStringRef CFStringCreateWithSubstring(CFAllocatorRef alloc, CFStringRef str, CFRange range);
CF_EXPORT
CFStringRef CFStringCreateCopy(CFAllocatorRef alloc, CFStringRef theString);
/* These functions create a CFString from the provided printf-like format string and arguments.
*/
CF_EXPORT
CFStringRef CFStringCreateWithFormat(CFAllocatorRef alloc, CFDictionaryRef formatOptions, CFStringRef format, ...) CF_FORMAT_FUNCTION(3,4);
CF_EXPORT
CFStringRef CFStringCreateWithFormatAndArguments(CFAllocatorRef alloc, CFDictionaryRef formatOptions, CFStringRef format, va_list arguments) CF_FORMAT_FUNCTION(3,0);
/* Functions to create mutable strings. "maxLength", if not 0, is a hard bound on the length of the string. If 0, there is no limit on the length.
*/
CF_EXPORT
CFMutableStringRef CFStringCreateMutable(CFAllocatorRef alloc, CFIndex maxLength);
CF_EXPORT
CFMutableStringRef CFStringCreateMutableCopy(CFAllocatorRef alloc, CFIndex maxLength, CFStringRef theString);
/* This function creates a mutable string that has a developer supplied and directly editable backing store.
The string will be manipulated within the provided buffer (if any) until it outgrows capacity; then the
externalCharactersAllocator will be consulted for more memory. When the CFString is deallocated, the
buffer will be freed with the externalCharactersAllocator. If you provide kCFAllocatorNull here, and the buffer
needs to grow, then CFString will switch to using the default allocator. See comments at top of this file for more info.
*/
CF_EXPORT
CFMutableStringRef CFStringCreateMutableWithExternalCharactersNoCopy(CFAllocatorRef alloc, UniChar *chars, CFIndex numChars, CFIndex capacity, CFAllocatorRef externalCharactersAllocator);
/*** Basic accessors for the contents ***/
/* Number of 16-bit Unicode characters in the string.
*/
CF_EXPORT
CFIndex CFStringGetLength(CFStringRef theString);
/* Extracting the contents of the string. For obtaining multiple characters, calling
CFStringGetCharacters() is more efficient than multiple calls to CFStringGetCharacterAtIndex().
If the length of the string is not known (so you can't use a fixed size buffer for CFStringGetCharacters()),
another method is to use is CFStringGetCharacterFromInlineBuffer() (see further below).
*/
CF_EXPORT
UniChar CFStringGetCharacterAtIndex(CFStringRef theString, CFIndex idx);
CF_EXPORT
void CFStringGetCharacters(CFStringRef theString, CFRange range, UniChar *buffer);
/*** Conversion to other encodings ***/
/* These two convert into the provided buffer; they return false if conversion isn't possible
(due to conversion error, or not enough space in the provided buffer).
These functions do zero-terminate or put the length byte; the provided bufferSize should include
space for this (so pass 256 for Str255). More sophisticated usages can go through CFStringGetBytes().
These functions are equivalent to calling CFStringGetBytes() with
the range of the string; lossByte = 0; and isExternalRepresentation = false;
if successful, they then insert the leading length or terminating zero, as desired.
*/
CF_EXPORT
Boolean CFStringGetPascalString(CFStringRef theString, StringPtr buffer, CFIndex bufferSize, CFStringEncoding encoding);
CF_EXPORT
Boolean CFStringGetCString(CFStringRef theString, char *buffer, CFIndex bufferSize, CFStringEncoding encoding);
/* These functions attempt to return in O(1) time the desired format for the string.
Note that although this means a pointer to the internal structure is being returned,
this can't always be counted on. Please see note at the top of the file for more
details.
*/
CF_EXPORT
ConstStringPtr CFStringGetPascalStringPtr(CFStringRef theString, CFStringEncoding encoding); /* May return NULL at any time; be prepared for NULL, if not now, in some other time or place. See discussion at top of this file. */
CF_EXPORT
const char *CFStringGetCStringPtr(CFStringRef theString, CFStringEncoding encoding); /* May return NULL at any time; be prepared for NULL, if not now, in some other time or place. See discussion at top of this file. */
CF_EXPORT
const UniChar *CFStringGetCharactersPtr(CFStringRef theString); /* May return NULL at any time; be prepared for NULL, if not now, in some other time or place. See discussion at top of this file. */
/* The primitive conversion routine; allows you to convert a string piece at a time
into a fixed size buffer. Returns number of characters converted.
Characters that cannot be converted to the specified encoding are represented
with the byte specified by lossByte; if lossByte is 0, then lossy conversion
is not allowed and conversion stops, returning partial results.
Pass buffer==NULL if you don't care about the converted string (but just the convertability,
or number of bytes required).
maxBufLength indicates the maximum number of bytes to generate. It is ignored when buffer==NULL.
Does not zero-terminate. If you want to create Pascal or C string, allow one extra byte at start or end.
Setting isExternalRepresentation causes any extra bytes that would allow
the data to be made persistent to be included; for instance, the Unicode BOM. Note that
CFString prepends UTF encoded data with the Unicode BOM <http://www.unicode.org/faq/utf_bom.html>
when generating external representation if the target encoding allows. It's important to note that
only UTF-8, UTF-16, and UTF-32 define the handling of the byte order mark character, and the "LE"
and "BE" variants of UTF-16 and UTF-32 don't.
*/
CF_EXPORT
CFIndex CFStringGetBytes(CFStringRef theString, CFRange range, CFStringEncoding encoding, UInt8 lossByte, Boolean isExternalRepresentation, UInt8 *buffer, CFIndex maxBufLen, CFIndex *usedBufLen);
/* Convenience functions String <-> Data. These generate "external" formats, that is, formats that
can be written out to disk. For instance, if the encoding is Unicode,
CFStringCreateFromExternalRepresentation() pays attention to the BOM character (if any)
and does byte swapping if necessary. Similarly CFStringCreateExternalRepresentation() will
include a BOM character if appropriate. See CFStringGetBytes() for more on this and lossByte.
*/
CF_EXPORT
CFStringRef CFStringCreateFromExternalRepresentation(CFAllocatorRef alloc, CFDataRef data, CFStringEncoding encoding); /* May return NULL on conversion error */
CF_EXPORT
CFDataRef CFStringCreateExternalRepresentation(CFAllocatorRef alloc, CFStringRef theString, CFStringEncoding encoding, UInt8 lossByte); /* May return NULL on conversion error */
/* Hints about the contents of a string
*/
CF_EXPORT
CFStringEncoding CFStringGetSmallestEncoding(CFStringRef theString); /* Result in O(n) time max */
CF_EXPORT
CFStringEncoding CFStringGetFastestEncoding(CFStringRef theString); /* Result in O(1) time max */
/* General encoding info
*/
CF_EXPORT
CFStringEncoding CFStringGetSystemEncoding(void); /* The default encoding for the system; untagged 8-bit characters are usually in this encoding */
CF_EXPORT
CFIndex CFStringGetMaximumSizeForEncoding(CFIndex length, CFStringEncoding encoding); /* Max bytes a string of specified length (in UniChars) will take up if encoded */
/*** FileSystem path conversion functions ***/
/* Extract the contents of the string as a NULL-terminated 8-bit string appropriate for passing to POSIX APIs (for example, normalized for HFS+). The string is zero-terminated. false will be returned if the conversion results don't fit into the buffer. Use CFStringGetMaximumSizeOfFileSystemRepresentation() if you want to make sure the buffer is of sufficient length.
*/
CF_EXPORT
Boolean CFStringGetFileSystemRepresentation(CFStringRef string, char *buffer, CFIndex maxBufLen);
/* Get the upper bound on the number of bytes required to hold the file system representation for the string. This result is returned quickly as a very rough approximation, and could be much larger than the actual space required. The result includes space for the zero termination. If you are allocating a buffer for long-term keeping, it's recommended that you reallocate it smaller (to be the right size) after calling CFStringGetFileSystemRepresentation().
*/
CF_EXPORT
CFIndex CFStringGetMaximumSizeOfFileSystemRepresentation(CFStringRef string);
/* Create a CFString from the specified zero-terminated POSIX file system representation. If the conversion fails (possible due to bytes in the buffer not being a valid sequence of bytes for the appropriate character encoding), NULL is returned.
*/
CF_EXPORT
CFStringRef CFStringCreateWithFileSystemRepresentation(CFAllocatorRef alloc, const char *buffer);
/*** Comparison functions. ***/
/* Find and compare flags; these are OR'ed together and provided as CFStringCompareFlags in the various functions.
*/
typedef CF_OPTIONS(CFOptionFlags, CFStringCompareFlags) {
kCFCompareCaseInsensitive = 1,
kCFCompareBackwards = 4, /* Starting from the end of the string */
kCFCompareAnchored = 8, /* Only at the specified starting point */
kCFCompareNonliteral = 16, /* If specified, loose equivalence is performed (o-umlaut == o, umlaut) */
kCFCompareLocalized = 32, /* User's default locale is used for the comparisons */
kCFCompareNumerically = 64, /* Numeric comparison is used; that is, Foo2.txt < Foo7.txt < Foo25.txt */
kCFCompareDiacriticInsensitive API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)) = 128, /* If specified, ignores diacritics (o-umlaut == o) */
kCFCompareWidthInsensitive API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)) = 256, /* If specified, ignores width differences ('a' == UFF41) */
kCFCompareForcedOrdering API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)) = 512 /* If specified, comparisons are forced to return either kCFCompareLessThan or kCFCompareGreaterThan if the strings are equivalent but not strictly equal, for stability when sorting (e.g. "aaa" > "AAA" with kCFCompareCaseInsensitive specified) */
};
/* The main comparison routine; compares specified range of the first string to (the full range of) the second string.
locale == NULL indicates canonical locale (the return value from CFLocaleGetSystem()).
kCFCompareNumerically, added in 10.2, does not work if kCFCompareLocalized is specified on systems before 10.3
kCFCompareBackwards and kCFCompareAnchored are not applicable.
rangeToCompare applies to the first string; that is, only the substring of theString1 specified by rangeToCompare is compared against all of theString2.
*/
CF_EXPORT
CFComparisonResult CFStringCompareWithOptionsAndLocale(CFStringRef theString1, CFStringRef theString2, CFRange rangeToCompare, CFStringCompareFlags compareOptions, CFLocaleRef locale) API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0));
/* Comparison convenience. Uses the current user locale (the return value from CFLocaleCopyCurrent()) if kCFCompareLocalized. Refer to CFStringCompareWithOptionsAndLocale() for more info.
*/
CF_EXPORT
CFComparisonResult CFStringCompareWithOptions(CFStringRef theString1, CFStringRef theString2, CFRange rangeToCompare, CFStringCompareFlags compareOptions);
/* Comparison convenience suitable for passing as sorting functions.
kCFCompareNumerically, added in 10.2, does not work if kCFCompareLocalized is specified on systems before 10.3
kCFCompareBackwards and kCFCompareAnchored are not applicable.
*/
CF_EXPORT
CFComparisonResult CFStringCompare(CFStringRef theString1, CFStringRef theString2, CFStringCompareFlags compareOptions);
/* CFStringFindWithOptionsAndLocale() returns the found range in the CFRange * argument; you can pass NULL for simple discovery check.
locale == NULL indicates canonical locale (the return value from CFLocaleGetSystem()).
If stringToFind is the empty string (zero length), nothing is found.
Ignores the kCFCompareNumerically option.
Only the substring of theString specified by rangeToSearch is searched for stringToFind.
*/
CF_EXPORT
Boolean CFStringFindWithOptionsAndLocale(CFStringRef theString, CFStringRef stringToFind, CFRange rangeToSearch, CFStringCompareFlags searchOptions, CFLocaleRef locale, CFRange *result) API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0));
/* Find convenience. Uses the current user locale (the return value from CFLocaleCopyCurrent()) if kCFCompareLocalized. Refer to CFStringFindWithOptionsAndLocale() for more info.
*/
CF_EXPORT
Boolean CFStringFindWithOptions(CFStringRef theString, CFStringRef stringToFind, CFRange rangeToSearch, CFStringCompareFlags searchOptions, CFRange *result);
/* CFStringCreateArrayWithFindResults() returns an array of CFRange pointers, or NULL if there are no matches.
Overlapping instances are not found; so looking for "AA" in "AAA" finds just one range.
Post 10.1: If kCFCompareBackwards is provided, the scan is done from the end (which can give a different result), and
the results are stored in the array backwards (last found range in slot 0).
If stringToFind is the empty string (zero length), nothing is found.
kCFCompareAnchored causes just the consecutive instances at start (or end, if kCFCompareBackwards) to be reported. So, searching for "AB" in "ABABXAB..." you just get the first two occurrences.
Ignores the kCFCompareNumerically option.
Only the substring of theString specified by rangeToSearch is searched for stringToFind.
*/
CF_EXPORT
CFArrayRef CFStringCreateArrayWithFindResults(CFAllocatorRef alloc, CFStringRef theString, CFStringRef stringToFind, CFRange rangeToSearch, CFStringCompareFlags compareOptions);
/* Find conveniences; see comments above concerning empty string and options.
*/
CF_EXPORT
CFRange CFStringFind(CFStringRef theString, CFStringRef stringToFind, CFStringCompareFlags compareOptions);
CF_EXPORT
Boolean CFStringHasPrefix(CFStringRef theString, CFStringRef prefix);
CF_EXPORT
Boolean CFStringHasSuffix(CFStringRef theString, CFStringRef suffix);
/*!
@function CFStringGetRangeOfComposedCharactersAtIndex
Returns the range of the composed character sequence at the specified index.
@param theString The CFString which is to be searched. If this
parameter is not a valid CFString, the behavior is
undefined.
@param theIndex The index of the character contained in the
composed character sequence. If the index is
outside the index space of the string (0 to N-1 inclusive,
where N is the length of the string), the behavior is
undefined.
@result The range of the composed character sequence.
*/
CF_EXPORT CFRange CFStringGetRangeOfComposedCharactersAtIndex(CFStringRef theString, CFIndex theIndex);
/*!
@function CFStringFindCharacterFromSet
Query the range of the first character contained in the specified character set.
@param theString The CFString which is to be searched. If this
parameter is not a valid CFString, the behavior is
undefined.
@param theSet The CFCharacterSet against which the membership
of characters is checked. If this parameter is not a valid
CFCharacterSet, the behavior is undefined.
@param rangeToSearch The range of characters within the string to search. If
the range location or end point (defined by the location
plus length minus 1) are outside the index space of the
string (0 to N-1 inclusive, where N is the length of the
string), the behavior is undefined. If the range length is
negative, the behavior is undefined. The range may be empty
(length 0), in which case no search is performed.
@param searchOptions The bitwise-or'ed option flags to control
the search behavior. The supported options are
kCFCompareBackwards andkCFCompareAnchored.
If other option flags are specified, the behavior
is undefined.
@param result The pointer to a CFRange supplied by the caller in
which the search result is stored. Note that the length
of this range can be more than 1, if for instance the
result is a composed character. If a pointer to an invalid
memory is specified, the behavior is undefined.
@result true, if at least a character which is a member of the character
set is found and result is filled, otherwise, false.
*/
CF_EXPORT Boolean CFStringFindCharacterFromSet(CFStringRef theString, CFCharacterSetRef theSet, CFRange rangeToSearch, CFStringCompareFlags searchOptions, CFRange *result);
/* Find range of bounds of the line(s) that span the indicated range (startIndex, numChars),
taking into account various possible line separator sequences (CR, CRLF, LF, and Unicode NextLine, LineSeparator, ParagraphSeparator).
All return values are "optional" (provide NULL if you don't want them)
lineBeginIndex: index of first character in line
lineEndIndex: index of first character of the next line (including terminating line separator characters)
contentsEndIndex: index of the first line separator character
Thus, lineEndIndex - lineBeginIndex is the number of chars in the line, including the line separators
contentsEndIndex - lineBeginIndex is the number of chars in the line w/out the line separators
*/
CF_EXPORT
void CFStringGetLineBounds(CFStringRef theString, CFRange range, CFIndex *lineBeginIndex, CFIndex *lineEndIndex, CFIndex *contentsEndIndex);
/* Same as CFStringGetLineBounds(), however, will only look for paragraphs. Won't stop at Unicode NextLine or LineSeparator characters.
*/
CF_EXPORT
void CFStringGetParagraphBounds(CFStringRef string, CFRange range, CFIndex *parBeginIndex, CFIndex *parEndIndex, CFIndex *contentsEndIndex) API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0));
/*!
@function CFStringGetHyphenationLocationBeforeIndex
Retrieve the first potential hyphenation location found before the specified location.
@param string The CFString which is to be hyphenated. If this
parameter is not a valid CFString, the behavior is
undefined.
@param location An index in the string. If a valid hyphen index is returned, it
will be before this index.
@param limitRange The range of characters within the string to search. If
the range location or end point (defined by the location
plus length minus 1) are outside the index space of the
string (0 to N-1 inclusive, where N is the length of the
string), the behavior is undefined. If the range length is
negative, the behavior is undefined. The range may be empty
(length 0), in which case no hyphen location is generated.
@param options Reserved for future use.
@param locale Specifies which language's hyphenation conventions to use.
This must be a valid locale. Hyphenation data is not available
for all locales. You can use CFStringIsHyphenationAvailableForLocale
to test for availability of hyphenation data.
@param character The suggested hyphen character to insert. Pass NULL if you
do not need this information.
@result an index in the string where it is appropriate to insert a hyphen, if
one exists; else kCFNotFound
*/
CF_EXPORT
CFIndex CFStringGetHyphenationLocationBeforeIndex(CFStringRef string, CFIndex location, CFRange limitRange, CFOptionFlags options, CFLocaleRef locale, UTF32Char *character) API_AVAILABLE(macos(10.7), ios(4.2), watchos(2.0), tvos(9.0));
CF_EXPORT
Boolean CFStringIsHyphenationAvailableForLocale(CFLocaleRef locale) API_AVAILABLE(macos(10.7), ios(4.3), watchos(2.0), tvos(9.0));
/*** Exploding and joining strings with a separator string ***/
CF_EXPORT
CFStringRef CFStringCreateByCombiningStrings(CFAllocatorRef alloc, CFArrayRef theArray, CFStringRef separatorString); /* Empty array returns empty string; one element array returns the element */
CF_EXPORT
CFArrayRef CFStringCreateArrayBySeparatingStrings(CFAllocatorRef alloc, CFStringRef theString, CFStringRef separatorString); /* No separators in the string returns array with that string; string == sep returns two empty strings */
/*** Parsing non-localized numbers from strings ***/
CF_EXPORT
SInt32 CFStringGetIntValue(CFStringRef str); /* Skips whitespace; returns 0 on error, MAX or -MAX on overflow */
CF_EXPORT
double CFStringGetDoubleValue(CFStringRef str); /* Skips whitespace; returns 0.0 on error */
/*** MutableString functions ***/
/* CFStringAppend("abcdef", "xxxxx") -> "abcdefxxxxx"
CFStringDelete("abcdef", CFRangeMake(2, 3)) -> "abf"
CFStringReplace("abcdef", CFRangeMake(2, 3), "xxxxx") -> "abxxxxxf"
CFStringReplaceAll("abcdef", "xxxxx") -> "xxxxx"
*/
CF_EXPORT
void CFStringAppend(CFMutableStringRef theString, CFStringRef appendedString);
CF_EXPORT
void CFStringAppendCharacters(CFMutableStringRef theString, const UniChar *chars, CFIndex numChars);
CF_EXPORT
void CFStringAppendPascalString(CFMutableStringRef theString, ConstStr255Param pStr, CFStringEncoding encoding);
CF_EXPORT
void CFStringAppendCString(CFMutableStringRef theString, const char *cStr, CFStringEncoding encoding);
CF_EXPORT
void CFStringAppendFormat(CFMutableStringRef theString, CFDictionaryRef formatOptions, CFStringRef format, ...) CF_FORMAT_FUNCTION(3,4);
CF_EXPORT
void CFStringAppendFormatAndArguments(CFMutableStringRef theString, CFDictionaryRef formatOptions, CFStringRef format, va_list arguments) CF_FORMAT_FUNCTION(3,0);
CF_EXPORT
void CFStringInsert(CFMutableStringRef str, CFIndex idx, CFStringRef insertedStr);
CF_EXPORT
void CFStringDelete(CFMutableStringRef theString, CFRange range);
CF_EXPORT
void CFStringReplace(CFMutableStringRef theString, CFRange range, CFStringRef replacement);
CF_EXPORT
void CFStringReplaceAll(CFMutableStringRef theString, CFStringRef replacement); /* Replaces whole string */
/* Replace all occurrences of target in rangeToSearch of theString with replacement.
Pays attention to kCFCompareCaseInsensitive, kCFCompareBackwards, kCFCompareNonliteral, and kCFCompareAnchored.
kCFCompareBackwards can be used to do the replacement starting from the end, which could give a different result.
ex. AAAAA, replace AA with B -> BBA or ABB; latter if kCFCompareBackwards
kCFCompareAnchored assures only anchored but multiple instances are found (the instances must be consecutive at start or end)
ex. AAXAA, replace A with B -> BBXBB or BBXAA; latter if kCFCompareAnchored
Returns number of replacements performed.
*/
CF_EXPORT
CFIndex CFStringFindAndReplace(CFMutableStringRef theString, CFStringRef stringToFind, CFStringRef replacementString, CFRange rangeToSearch, CFStringCompareFlags compareOptions);
/* This function will make the contents of a mutable CFString point directly at the specified UniChar array.
It works only with CFStrings created with CFStringCreateMutableWithExternalCharactersNoCopy().
This function does not free the previous buffer.
The string will be manipulated within the provided buffer (if any) until it outgrows capacity; then the
externalCharactersAllocator will be consulted for more memory.
See comments at the top of this file for more info.
*/
CF_EXPORT
void CFStringSetExternalCharactersNoCopy(CFMutableStringRef theString, UniChar *chars, CFIndex length, CFIndex capacity); /* Works only on specially created mutable strings! */
/* CFStringPad() will pad or cut down a string to the specified size.
The pad string is used as the fill string; indexIntoPad specifies which character to start with.
CFStringPad("abc", " ", 9, 0) -> "abc "
CFStringPad("abc", ". ", 9, 1) -> "abc . . ."
CFStringPad("abcdef", ?, 3, ?) -> "abc"
CFStringTrim() will trim the specified string from both ends of the string.
CFStringTrimWhitespace() will do the same with white space characters (tab, newline, etc)
CFStringTrim(" abc ", " ") -> "abc"
CFStringTrim("* * * *abc * ", "* ") -> "*abc "
*/
CF_EXPORT
void CFStringPad(CFMutableStringRef theString, CFStringRef padString, CFIndex length, CFIndex indexIntoPad);
CF_EXPORT
void CFStringTrim(CFMutableStringRef theString, CFStringRef trimString);
CF_EXPORT
void CFStringTrimWhitespace(CFMutableStringRef theString);
CF_EXPORT
void CFStringLowercase(CFMutableStringRef theString, CFLocaleRef locale);
CF_EXPORT
void CFStringUppercase(CFMutableStringRef theString, CFLocaleRef locale);
CF_EXPORT
void CFStringCapitalize(CFMutableStringRef theString, CFLocaleRef locale);
/*!
@typedef CFStringNormalizationForm
This is the type of Unicode normalization forms as described in
Unicode Technical Report #15. To normalize for use with file
system calls, use CFStringGetFileSystemRepresentation().
*/
typedef CF_ENUM(CFIndex, CFStringNormalizationForm) {
kCFStringNormalizationFormD = 0, // Canonical Decomposition
kCFStringNormalizationFormKD, // Compatibility Decomposition
kCFStringNormalizationFormC, // Canonical Decomposition followed by Canonical Composition
kCFStringNormalizationFormKC // Compatibility Decomposition followed by Canonical Composition
};
/*!
@function CFStringNormalize
Normalizes the string into the specified form as described in
Unicode Technical Report #15.
@param theString The string which is to be normalized. If this
parameter is not a valid mutable CFString, the behavior is
undefined.
@param theForm The form into which the string is to be normalized.
If this parameter is not a valid CFStringNormalizationForm value,
the behavior is undefined.
*/
CF_EXPORT void CFStringNormalize(CFMutableStringRef theString, CFStringNormalizationForm theForm);
/*!
@function CFStringFold
Folds the string into the form specified by the flags.
Character foldings are operations that convert any of a set of characters
sharing similar semantics into a single representative from that set.
This function can be used to preprocess strings that are to be compared,
searched, or indexed.
Note that folding does not include normalization, so it is necessary
to use CFStringNormalize in addition to CFStringFold in order to obtain
the effect of kCFCompareNonliteral.
@param theString The string which is to be folded. If this parameter is not
a valid mutable CFString, the behavior is undefined.
@param theFlags The equivalency flags which describes the character folding form.
Only those flags containing the word "insensitive" are recognized here; other flags are ignored.
Folding with kCFCompareCaseInsensitive removes case distinctions in accordance with the mapping
specified by ftp://ftp.unicode.org/Public/UNIDATA/CaseFolding.txt. Folding with
kCFCompareDiacriticInsensitive removes distinctions of accents and other diacritics. Folding
with kCFCompareWidthInsensitive removes character width distinctions by mapping characters in
the range U+FF00-U+FFEF to their ordinary equivalents.
@param theLocale The locale tailoring the character folding behavior. If NULL,
it's considered to be the system locale returned from CFLocaleGetSystem().
If non-NULL and not a valid CFLocale object, the behavior is undefined.
*/
CF_EXPORT
void CFStringFold(CFMutableStringRef theString, CFStringCompareFlags theFlags, CFLocaleRef theLocale) API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0));
/* Perform string transliteration. The transformation represented by transform is applied to the given range of string, modifying it in place. Only the specified range will be modified, but the transform may look at portions of the string outside that range for context. NULL range pointer causes the whole string to be transformed. On return, range is modified to reflect the new range corresponding to the original range. reverse indicates that the inverse transform should be used instead, if it exists. If the transform is successful, true is returned; if unsuccessful, false. Reasons for the transform being unsuccessful include an invalid transform identifier, or attempting to reverse an irreversible transform.
You can pass one of the predefined transforms below, or any valid ICU transform ID as defined in the ICU User Guide. Note that we do not support arbitrary set of ICU transform rules.
*/
CF_EXPORT
Boolean CFStringTransform(CFMutableStringRef string, CFRange *range, CFStringRef transform, Boolean reverse);
/* Transform identifiers for CFStringTransform()
*/
CF_EXPORT const CFStringRef kCFStringTransformStripCombiningMarks;
CF_EXPORT const CFStringRef kCFStringTransformToLatin;
CF_EXPORT const CFStringRef kCFStringTransformFullwidthHalfwidth;
CF_EXPORT const CFStringRef kCFStringTransformLatinKatakana;
CF_EXPORT const CFStringRef kCFStringTransformLatinHiragana;
CF_EXPORT const CFStringRef kCFStringTransformHiraganaKatakana;
CF_EXPORT const CFStringRef kCFStringTransformMandarinLatin;
CF_EXPORT const CFStringRef kCFStringTransformLatinHangul;
CF_EXPORT const CFStringRef kCFStringTransformLatinArabic;
CF_EXPORT const CFStringRef kCFStringTransformLatinHebrew;
CF_EXPORT const CFStringRef kCFStringTransformLatinThai;
CF_EXPORT const CFStringRef kCFStringTransformLatinCyrillic;
CF_EXPORT const CFStringRef kCFStringTransformLatinGreek;
CF_EXPORT const CFStringRef kCFStringTransformToXMLHex;
CF_EXPORT const CFStringRef kCFStringTransformToUnicodeName;
CF_EXPORT const CFStringRef kCFStringTransformStripDiacritics API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0));
/*** General encoding related functionality ***/
/* This returns availability of the encoding on the system
*/
CF_EXPORT
Boolean CFStringIsEncodingAvailable(CFStringEncoding encoding);
/* This function returns list of available encodings. The returned list is terminated with kCFStringEncodingInvalidId and owned by the system.
*/
CF_EXPORT
const CFStringEncoding *CFStringGetListOfAvailableEncodings(void);
/* Returns name of the encoding; non-localized.
*/
CF_EXPORT
CFStringRef CFStringGetNameOfEncoding(CFStringEncoding encoding);
/* ID mapping functions from/to Cocoa NSStringEncoding. Returns kCFStringEncodingInvalidId if no mapping exists.
*/
CF_EXPORT
unsigned long CFStringConvertEncodingToNSStringEncoding(CFStringEncoding encoding);
CF_EXPORT
CFStringEncoding CFStringConvertNSStringEncodingToEncoding(unsigned long encoding);
/* ID mapping functions from/to Microsoft Windows codepage (covers both OEM & ANSI). Returns kCFStringEncodingInvalidId if no mapping exists.
*/
CF_EXPORT
UInt32 CFStringConvertEncodingToWindowsCodepage(CFStringEncoding encoding);
CF_EXPORT
CFStringEncoding CFStringConvertWindowsCodepageToEncoding(UInt32 codepage);
/* ID mapping functions from/to IANA registery charset names. Returns kCFStringEncodingInvalidId if no mapping exists.
*/
CF_EXPORT
CFStringEncoding CFStringConvertIANACharSetNameToEncoding(CFStringRef theString);
CF_EXPORT
CFStringRef CFStringConvertEncodingToIANACharSetName(CFStringEncoding encoding);
/* Returns the most compatible MacOS script value for the input encoding */
/* i.e. kCFStringEncodingMacRoman -> kCFStringEncodingMacRoman */
/* kCFStringEncodingWindowsLatin1 -> kCFStringEncodingMacRoman */
/* kCFStringEncodingISO_2022_JP -> kCFStringEncodingMacJapanese */
CF_EXPORT
CFStringEncoding CFStringGetMostCompatibleMacStringEncoding(CFStringEncoding encoding);
/* The next two functions allow fast access to the contents of a string,
assuming you are doing sequential or localized accesses. To use, call
CFStringInitInlineBuffer() with a CFStringInlineBuffer (on the stack, say),
and a range in the string to look at. Then call CFStringGetCharacterFromInlineBuffer()
as many times as you want, with a index into that range (relative to the start
of that range). These are INLINE functions and will end up calling CFString only
once in a while, to fill a buffer. CFStringGetCharacterFromInlineBuffer() returns 0 if
a location outside the original range is specified.
*/
#define __kCFStringInlineBufferLength 64
typedef struct {
UniChar buffer[__kCFStringInlineBufferLength];
CFStringRef theString;
const UniChar *directUniCharBuffer;
const char *directCStringBuffer;
CFRange rangeToBuffer; /* Range in string to buffer */
CFIndex bufferedRangeStart; /* Start of range currently buffered (relative to rangeToBuffer.location) */
CFIndex bufferedRangeEnd; /* bufferedRangeStart + number of chars actually buffered */
} CFStringInlineBuffer;
#if defined(CF_INLINE)
CF_INLINE void CFStringInitInlineBuffer(CFStringRef str, CFStringInlineBuffer *buf, CFRange range) {
buf->theString = str;
buf->rangeToBuffer = range;
buf->directCStringBuffer = (buf->directUniCharBuffer = CFStringGetCharactersPtr(str)) ? NULL : CFStringGetCStringPtr(str, kCFStringEncodingASCII);
buf->bufferedRangeStart = buf->bufferedRangeEnd = 0;
}
CF_INLINE UniChar CFStringGetCharacterFromInlineBuffer(CFStringInlineBuffer *buf, CFIndex idx) {
if (idx < 0 || idx >= buf->rangeToBuffer.length) return 0;
if (buf->directUniCharBuffer) return buf->directUniCharBuffer[idx + buf->rangeToBuffer.location];
if (buf->directCStringBuffer) return (UniChar)(buf->directCStringBuffer[idx + buf->rangeToBuffer.location]);
if (idx >= buf->bufferedRangeEnd || idx < buf->bufferedRangeStart) {
if ((buf->bufferedRangeStart = idx - 4) < 0) buf->bufferedRangeStart = 0;
buf->bufferedRangeEnd = buf->bufferedRangeStart + __kCFStringInlineBufferLength;
if (buf->bufferedRangeEnd > buf->rangeToBuffer.length) buf->bufferedRangeEnd = buf->rangeToBuffer.length;
CFStringGetCharacters(buf->theString, CFRangeMake(buf->rangeToBuffer.location + buf->bufferedRangeStart, buf->bufferedRangeEnd - buf->bufferedRangeStart), buf->buffer);
}
return buf->buffer[idx - buf->bufferedRangeStart];
}
#else
/* If INLINE functions are not available, we do somewhat less powerful macros that work similarly (except be aware that the buf argument is evaluated multiple times).
*/
#define CFStringInitInlineBuffer(str, buf, range) \
do {(buf)->theString = str; (buf)->rangeToBuffer = range; (buf)->directCStringBuffer = ((buf)->directUniCharBuffer = CFStringGetCharactersPtr(str)) ? NULL : CFStringGetCStringPtr(str, kCFStringEncodingASCII);} while (0)
#define CFStringGetCharacterFromInlineBuffer(buf, idx) \
(((idx) < 0 || (idx) >= (buf)->rangeToBuffer.length) ? 0 : ((buf)->directUniCharBuffer ? (buf)->directUniCharBuffer[(idx) + (buf)->rangeToBuffer.location] : ((buf)->directCStringBuffer ? (UniChar)((buf)->directCStringBuffer[(idx) + (buf)->rangeToBuffer.location]) : CFStringGetCharacterAtIndex((buf)->theString, (idx) + (buf)->rangeToBuffer.location))))
#endif /* CF_INLINE */
/* UTF-16 surrogate support
*/
CF_INLINE Boolean CFStringIsSurrogateHighCharacter(UniChar character) {
return ((character >= 0xD800UL) && (character <= 0xDBFFUL) ? true : false);
}
CF_INLINE Boolean CFStringIsSurrogateLowCharacter(UniChar character) {
return ((character >= 0xDC00UL) && (character <= 0xDFFFUL) ? true : false);
}
CF_INLINE UTF32Char CFStringGetLongCharacterForSurrogatePair(UniChar surrogateHigh, UniChar surrogateLow) {
return (UTF32Char)(((surrogateHigh - 0xD800UL) << 10) + (surrogateLow - 0xDC00UL) + 0x0010000UL);
}
// Maps a UTF-32 character to a pair of UTF-16 surrogate characters. The buffer pointed by surrogates has to have space for at least 2 UTF-16 characters. Returns true if mapped to a surrogate pair.
CF_INLINE Boolean CFStringGetSurrogatePairForLongCharacter(UTF32Char character, UniChar *surrogates) {
if ((character > 0xFFFFUL) && (character < 0x110000UL)) { // Non-BMP character
character -= 0x10000;
if (NULL != surrogates) {
surrogates[0] = (UniChar)((character >> 10) + 0xD800UL);
surrogates[1] = (UniChar)((character & 0x3FF) + 0xDC00UL);
}
return true;
} else {
if (NULL != surrogates) *surrogates = (UniChar)character;
return false;
}
}
/* Rest of the stuff in this file is private and should not be used directly
*/
/* For debugging only; output goes to stderr
Use CFShow() to printf the description of any CFType;
Use CFShowStr() to printf detailed info about a CFString
*/
CF_EXPORT
void CFShow(CFTypeRef obj);
CF_EXPORT
void CFShowStr(CFStringRef str);
/* This function is private and should not be used directly */
CF_EXPORT
CFStringRef __CFStringMakeConstantString(const char *cStr) CF_FORMAT_ARGUMENT(1); /* Private; do not use */
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif /* ! __COREFOUNDATION_CFSTRING__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFAttributedString.h | // This source file is part of the Swift.org open source project
//
// Copyright (c) 2014 - 2015 Apple Inc. and the Swift project authors
// Licensed under Apache License v2.0 with Runtime Library Exception
//
// See http://swift.org/LICENSE.txt for license information
// See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
//
/* CFAttributedString.h
Copyright (c) 2004-2019, Apple Inc. All rights reserved.
*/
/*! @header CFAttributedString
Instances of CFAttributedString manage character strings and associated sets of attributes (for example, font and kerning) that apply to individual characters or ranges of characters in the string. CFAttributedString as defined in CoreFoundation provides the basic container functionality, while higher levels provide definitions for standard attributes, their values, and additional behaviors involving these.
CFAttributedString is not a "subclass" of CFString; that is, it does not respond to CFString function calls. CFAttributedString conceptually contains a CFString to which it applies attributes. This protects users of attributed strings from ambiguities caused by the semantic differences between simple and attributed strings.
Attributes are identified by key/value pairs stored in CFDictionaryRefs. Keys must be CFStrings, while the values are arbitrary CFTypeRefs.
*/
#if !defined(__COREFOUNDATION_CFATTRIBUTEDSTRING__)
#define __COREFOUNDATION_CFATTRIBUTEDSTRING__ 1
#include <CoreFoundation/CFBase.h>
#include <CoreFoundation/CFString.h>
#include <CoreFoundation/CFDictionary.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
/* CFAttributedString comes in immutable and mutable flavors.
*/
typedef const struct CF_BRIDGED_TYPE(NSAttributedString) __CFAttributedString *CFAttributedStringRef;
typedef struct CF_BRIDGED_MUTABLE_TYPE(NSMutableAttributedString) __CFAttributedString *CFMutableAttributedStringRef;
/*! @function CFAttributedStringGetTypeID
Returns the type identifier of all CFAttributedString instances.
*/
CF_EXPORT CFTypeID CFAttributedStringGetTypeID(void);
/*** CFAttributedString ***/
/*! @function CFAttributedStringCreate
Creates an attributed string with the specified string and attributes (both copied).
*/
CF_EXPORT CFAttributedStringRef CFAttributedStringCreate(CFAllocatorRef alloc, CFStringRef str, CFDictionaryRef attributes);
/*! @function CFAttributedStringCreateWithSubstring
Creates a sub-attributed string from the specified range. It's a programming error for range to specify characters outside the bounds of aStr.
*/
CF_EXPORT CFAttributedStringRef CFAttributedStringCreateWithSubstring(CFAllocatorRef alloc, CFAttributedStringRef aStr, CFRange range);
/*! @function CFAttributedStringCreateCopy
Creates an immutable attributed string copy.
*/
CF_EXPORT CFAttributedStringRef CFAttributedStringCreateCopy(CFAllocatorRef alloc, CFAttributedStringRef aStr);
/*! @function CFAttributedStringGetString
Returns the string for the attributed string. For performance reasons, this will often point at the backing store of the attributed string, and it might change if the attributed string is edited. However, this is an implementation detail, and definitely not something that should be counted on.
*/
CF_EXPORT CFStringRef CFAttributedStringGetString(CFAttributedStringRef aStr);
/*! @function CFAttributedStringGetLength
Returns the length of the attributed string in characters; same as CFStringGetLength(CFAttributedStringGetString(aStr))
*/
CF_EXPORT CFIndex CFAttributedStringGetLength(CFAttributedStringRef aStr);
/*! @function CFAttributedStringGetAttributes
Returns the attributes at the specified location. If effectiveRange is not NULL, upon return *effectiveRange contains a range over which the exact same set of attributes apply. Note that for performance reasons, the returned effectiveRange is not necessarily the maximal range - for that, use CFAttributedStringGetAttributesAndLongestEffectiveRange(). It's a programming error for loc to specify a location outside the bounds of the attributed string.
Note that the returned attribute dictionary might change in unpredictable ways from under the caller if the attributed string is edited after this call. If you wish to hang on to the dictionary long-term, you should make an actual copy of it rather than just retaining it. Also, no assumptions should be made about the relationship of the actual CFDictionaryRef returned by this call and the dictionary originally used to set the attributes, other than the fact that the values stored in the dictionary will be identical (that is, ==) to those originally specified.
*/
CF_EXPORT CFDictionaryRef CFAttributedStringGetAttributes(CFAttributedStringRef aStr, CFIndex loc, CFRange *effectiveRange);
/*! @function CFAttributedStringGetAttribute
Returns the value of a single attribute at the specified location. If the specified attribute doesn't exist at the location, returns NULL. If effectiveRange is not NULL, upon return *effectiveRange contains a range over which the exact same attribute value applies. Note that for performance reasons, the returned effectiveRange is not necessarily the maximal range - for that, use CFAttributedStringGetAttributeAndLongestEffectiveRange(). It's a programming error for loc to specify a location outside the bounds of the attributed string.
*/
CF_EXPORT CFTypeRef CFAttributedStringGetAttribute(CFAttributedStringRef aStr, CFIndex loc, CFStringRef attrName, CFRange *effectiveRange);
/*! @function CFAttributedStringGetAttributesAndLongestEffectiveRange
Returns the attributes at the specified location. If longestEffectiveRange is not NULL, upon return *longestEffectiveRange contains the maximal range within inRange over which the exact same set of attributes apply. The returned range is clipped to inRange. It's a programming error for loc or inRange to specify locations outside the bounds of the attributed string.
*/
CF_EXPORT CFDictionaryRef CFAttributedStringGetAttributesAndLongestEffectiveRange(CFAttributedStringRef aStr, CFIndex loc, CFRange inRange, CFRange *longestEffectiveRange);
/*! @function CFAttributedStringGetAttributeAndLongestEffectiveRange
Returns the value of a single attribute at the specified location. If longestEffectiveRange is not NULL, upon return *longestEffectiveRange contains the maximal range within inRange over which the exact same attribute value applies. The returned range is clipped to inRange. It's a programming error for loc or inRange to specify locations outside the bounds of the attributed string.
*/
CF_EXPORT CFTypeRef CFAttributedStringGetAttributeAndLongestEffectiveRange(CFAttributedStringRef aStr, CFIndex loc, CFStringRef attrName, CFRange inRange, CFRange *longestEffectiveRange);
/*** CFMutableAttributedString ***/
/*! @function CFAttributedStringCreateMutableCopy
Creates a mutable attributed string copy. maxLength, if not 0, is a hard bound on the length of the attributed string; exceeding this size limit during any editing operation is a programming error. If 0, there is no limit on the length.
*/
CF_EXPORT CFMutableAttributedStringRef CFAttributedStringCreateMutableCopy(CFAllocatorRef alloc, CFIndex maxLength, CFAttributedStringRef aStr);
/*! @function CFAttributedStringCreateMutable
Creates a mutable empty attributed string. maxLength, if not 0, is a hard bound on the length of the attributed string; exceeding this size limit during any editing operation is a programming error. If 0, there is no limit on the length.
*/
CF_EXPORT CFMutableAttributedStringRef CFAttributedStringCreateMutable(CFAllocatorRef alloc, CFIndex maxLength);
/*! @function CFAttributedStringReplaceString
Modifies the string for the attributed string, much like CFStringReplace(). It's an error for range to specify characters outside the bounds of aStr.
(Note: This function is a convenience on CFAttributedStringGetMutableString(); however, until CFAttributedStringGetMutableString() is implemented, it remains the only way to edit the string of the attributed string.)
*/
CF_EXPORT void CFAttributedStringReplaceString(CFMutableAttributedStringRef aStr, CFRange range, CFStringRef replacement);
/*! @function CFAttributedStringGetMutableString
Gets the string for the attributed string as a mutable string, allowing editing the character contents of the string as if it were an CFMutableString. Attributes corresponding to the edited range are appropriately modified. If, as a result of the edit, new characters are introduced into the string, they inherit the attributes of the first replaced character from range. If no existing characters are replaced by the edit, the new characters inherit the attributes of the character preceding range if it has any, otherwise of the character following range. If the initial string is empty, the attributes for the new characters are also empty.
(Note: This function is not yet implemented and will return NULL except for toll-free bridged instances.)
*/
CF_EXPORT CFMutableStringRef CFAttributedStringGetMutableString(CFMutableAttributedStringRef aStr);
/*! @function CFAttributedStringSetAttributes
Sets the value of multiple attributes over the specified range, which should be valid. If clearOtherAttributes is false, existing attributes (which aren't being replaced) are left alone; otherwise they are cleared. The dictionary should be setup for "usual" CF type usage --- CFString keys, and arbitrary CFType values. Note that after this call, further mutations to the replacement dictionary argument by the caller will not affect the contents of the attributed string.
*/
CF_EXPORT void CFAttributedStringSetAttributes(CFMutableAttributedStringRef aStr, CFRange range, CFDictionaryRef replacement, Boolean clearOtherAttributes);
/*! @function CFAttributedStringSetAttribute
Sets the value of a single attribute over the specified range, which should be valid. value should not be NULL.
*/
CF_EXPORT void CFAttributedStringSetAttribute(CFMutableAttributedStringRef aStr, CFRange range, CFStringRef attrName, CFTypeRef value);
/*! @function CFAttributedStringRemoveAttribute
Removes the value of a single attribute over the specified range, which should be valid. It's OK for the attribute not the exist over the specified range.
*/
CF_EXPORT void CFAttributedStringRemoveAttribute(CFMutableAttributedStringRef aStr, CFRange range, CFStringRef attrName);
/*! @function CFAttributedStringReplaceAttributedString
Replaces the attributed substring over the specified range with the attributed string specified in replacement. range should be valid. To delete a range of the attributed string, call CFAttributedStringReplaceString() with empty string and specified range.
*/
CF_EXPORT void CFAttributedStringReplaceAttributedString(CFMutableAttributedStringRef aStr, CFRange range, CFAttributedStringRef replacement);
/*! @function CFAttributedStringBeginEditing
In cases where attributed string might do a bunch of work to assure self-consistency, CFAttributedStringBeginEditing/CFAttributedStringEndEditing allow disabling that to allow deferring and coalescing any work. It's a good idea to call these around a set of related mutation calls which don't require the string to be in consistent state in between. These calls can be nested.
*/
CF_EXPORT void CFAttributedStringBeginEditing(CFMutableAttributedStringRef aStr);
/*! @function CFAttributedStringEndEditing
In cases where attributed string might do a bunch of work to assure self-consistency, CFAttributedStringBeginEditing/CFAttributedStringEndEditing allow disabling that to allow deferring and coalescing any work. It's a good idea to call these around a set of related mutation calls which don't require the string to be in consistent state in between. These calls can be nested.
*/
CF_EXPORT void CFAttributedStringEndEditing(CFMutableAttributedStringRef aStr);
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif /* ! __COREFOUNDATION_CFATTRIBUTEDSTRING__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFURLAccess.h | /* CFURLAccess.h
Copyright (c) 1998-2019, Apple Inc. and the Swift project authors
Portions Copyright (c) 2014-2019, Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See http://swift.org/LICENSE.txt for license information
See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
CFURLAccess is deprecated as of Mac OS X 10.9 and iOS 7.0. The suggested replacement for URLs with network schemes (http, https, ftp, data) are the NSURLSession or NSURLConnection classes. The suggested replacement for URLs with the file scheme are the foundation classes NSFileManager, NSFileHandle and NSURL, or the CoreFoundation classes CFStream and CFURL.
*/
#if !defined(__COREFOUNDATION_CFURLACCESS__)
#define __COREFOUNDATION_CFURLACCESS__ 1
#include <CoreFoundation/CFBase.h>
#include <CoreFoundation/CFArray.h>
#include <CoreFoundation/CFData.h>
#include <CoreFoundation/CFDictionary.h>
#include <CoreFoundation/CFError.h>
#include <CoreFoundation/CFString.h>
#include <CoreFoundation/CFURL.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
/* Attempts to read the data and properties for the given URL. If
only interested in one of the resourceData and properties, pass NULL
for the other. If properties is non-NULL and desiredProperties is
NULL, then all properties are fetched. Returns success or failure;
note that as much work as possible is done even if false is returned.
So for instance if one property is not available, the others are
fetched anyway. errorCode is set to 0 on success, and some other
value on failure. If non-NULL, it is the caller 's responsibility
to release resourceData and properties.
Apple reserves for its use all negative error code values; these
values represent errors common to any scheme. Scheme-specific error
codes should be positive, non-zero, and should be used only if one of
the predefined Apple error codes does not apply. Error codes should
be publicized and documented with the scheme-specific properties.
NOTE: When asking for the resource data, this call will allocate the entire
resource in memory. This can be very expensive, depending on the size of the
resource (file). Please use CFStream or other techniques if you are downloading
large files.
*/
/* Deprecated -- see top of this file for suggested replacement classes */
CF_EXPORT
Boolean CFURLCreateDataAndPropertiesFromResource(CFAllocatorRef alloc, CFURLRef url, CFDataRef *resourceData, CFDictionaryRef *properties, CFArrayRef desiredProperties, SInt32 *errorCode) API_DEPRECATED("For resource data, use the CFReadStream API. For file resource properties, use CFURLCopyResourcePropertiesForKeys.", macos(10.0,10.9), ios(2.0,7.0), watchos(2.0,2.0), tvos(9.0,9.0));
/* Attempts to write the given data and properties to the given URL.
If dataToWrite is NULL, only properties are written out (use
CFURLDestroyResource() to delete a resource). Properties not present
in propertiesToWrite are left unchanged, hence if propertiesToWrite
is NULL or empty, the URL's properties are not changed at all.
Returns success or failure; errorCode is set as for
CFURLCreateDataAndPropertiesFromResource(), above.
*/
/* Deprecated -- see top of this file for suggested replacement classes */
CF_EXPORT
Boolean CFURLWriteDataAndPropertiesToResource(CFURLRef url, CFDataRef dataToWrite, CFDictionaryRef propertiesToWrite, SInt32 *errorCode) API_DEPRECATED("For resource data, use the CFWriteStream API. For file resource properties, use CFURLSetResourcePropertiesForKeys.", macos(10.0,10.9), ios(2.0,7.0), watchos(2.0,2.0), tvos(9.0,9.0));
/* Destroys the resource indicated by url.
Returns success or failure; errorCode set as above.
*/
/* Deprecated -- see top of this file for suggested replacement classes */
CF_EXPORT
Boolean CFURLDestroyResource(CFURLRef url, SInt32 *errorCode) API_DEPRECATED("Use CFURLGetFileSystemRepresentation and removefile(3) instead.", macos(10.0,10.9), ios(2.0,7.0), watchos(2.0,2.0), tvos(9.0,9.0));
/* Convenience method which calls through to CFURLCreateDataAndPropertiesFromResource().
Returns NULL on error and sets errorCode accordingly.
*/
/* Deprecated -- see top of this file for suggested replacement classes */
CF_EXPORT
CFTypeRef CFURLCreatePropertyFromResource(CFAllocatorRef alloc, CFURLRef url, CFStringRef property, SInt32 *errorCode) API_DEPRECATED("For file resource properties, use CFURLCopyResourcePropertyForKey.", macos(10.0,10.9), ios(2.0,7.0), watchos(2.0,2.0), tvos(9.0,9.0));
/* Common error codes (returned only by the older APIs that predate CFError) */
typedef CF_ENUM(CFIndex, CFURLError) {
kCFURLUnknownError = -10L,
kCFURLUnknownSchemeError = -11L,
kCFURLResourceNotFoundError = -12L,
kCFURLResourceAccessViolationError = -13L,
kCFURLRemoteHostUnavailableError = -14L,
kCFURLImproperArgumentsError = -15L,
kCFURLUnknownPropertyKeyError = -16L,
kCFURLPropertyKeyUnavailableError = -17L,
kCFURLTimeoutError = -18L
} API_DEPRECATED("Use CFError codes instead", macos(10.0,10.9), ios(2.0,7.0), watchos(2.0,2.0), tvos(9.0,9.0));
/* Older property keys */
CF_EXPORT
const CFStringRef kCFURLFileExists API_DEPRECATED("Use CFURLResourceIsReachable instead.", macos(10.0,10.9), ios(2.0,7.0), watchos(2.0,2.0), tvos(9.0,9.0));
CF_EXPORT
const CFStringRef kCFURLFileDirectoryContents API_DEPRECATED("Use the CFURLEnumerator API instead.", macos(10.0,10.9), ios(2.0,7.0), watchos(2.0,2.0), tvos(9.0,9.0));
CF_EXPORT
const CFStringRef kCFURLFileLength API_DEPRECATED("Use CFURLCopyResourcePropertyForKey with kCFURLFileSizeKey instead.", macos(10.0,10.9), ios(2.0,7.0), watchos(2.0,2.0), tvos(9.0,9.0));
CF_EXPORT
const CFStringRef kCFURLFileLastModificationTime API_DEPRECATED("Use CFURLCopyResourcePropertyForKey with kCFURLContentModificationDateKey instead.", macos(10.0,10.9), ios(2.0,7.0), watchos(2.0,2.0), tvos(9.0,9.0));
CF_EXPORT
const CFStringRef kCFURLFilePOSIXMode API_DEPRECATED("Use CFURLCopyResourcePropertyForKey with kCFURLFileSecurityKey and then the CFFileSecurity API instead.", macos(10.0,10.9), ios(2.0,7.0), watchos(2.0,2.0), tvos(9.0,9.0));
CF_EXPORT
const CFStringRef kCFURLFileOwnerID API_DEPRECATED("Use CFURLCopyResourcePropertyForKey with kCFURLFileSecurityKey and then the CFFileSecurity API instead.", macos(10.0,10.9), ios(2.0,7.0), watchos(2.0,2.0), tvos(9.0,9.0));
CF_EXPORT
const CFStringRef kCFURLHTTPStatusCode API_DEPRECATED("Use NSHTTPURLResponse methods instead.", macos(10.0,10.9), ios(2.0,7.0), watchos(2.0,2.0), tvos(9.0,9.0));
CF_EXPORT
const CFStringRef kCFURLHTTPStatusLine API_DEPRECATED("Use NSHTTPURLResponse methods instead.", macos(10.0,10.9), ios(2.0,7.0), watchos(2.0,2.0), tvos(9.0,9.0));
/* The value of kCFURLFileExists is a CFBoolean */
/* The value of kCFURLFileDirectoryContents is a CFArray containing CFURLs. An empty array means the directory exists, but is empty */
/* The value of kCFURLFileLength is a CFNumber giving the file's length in bytes */
/* The value of kCFURLFileLastModificationTime is a CFDate */
/* The value of kCFURLFilePOSIXMode is a CFNumber as given in stat.h */
/* The value of kCFURLFileOwnerID is a CFNumber representing the owner's uid */
/* Properties for the http: scheme. Except for the common error codes, above, errorCode will be set to the HTTP response status code upon failure. Any HTTP header name can also be used as a property */
/* The value of kCFURLHTTPStatusCode is a CFNumber */
/* The value of kCFURLHTTPStatusLine is a CFString */
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif /* ! __COREFOUNDATION_CFURLACCESS__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFRunLoop.h | /* CFRunLoop.h
Copyright (c) 1998-2019, Apple Inc. and the Swift project authors
Portions Copyright (c) 2014-2019, Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See http://swift.org/LICENSE.txt for license information
See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
*/
#if !defined(__COREFOUNDATION_CFRUNLOOP__)
#define __COREFOUNDATION_CFRUNLOOP__ 1
#include <CoreFoundation/CFBase.h>
#include <CoreFoundation/CFArray.h>
#include <CoreFoundation/CFDate.h>
#include <CoreFoundation/CFString.h>
#if TARGET_OS_OSX || TARGET_OS_IPHONE
#include <mach/port.h>
#endif
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
typedef CFStringRef CFRunLoopMode CF_EXTENSIBLE_STRING_ENUM;
typedef struct CF_BRIDGED_MUTABLE_TYPE(id) __CFRunLoop * CFRunLoopRef;
typedef struct CF_BRIDGED_MUTABLE_TYPE(id) __CFRunLoopSource * CFRunLoopSourceRef;
typedef struct CF_BRIDGED_MUTABLE_TYPE(id) __CFRunLoopObserver * CFRunLoopObserverRef;
typedef struct CF_BRIDGED_MUTABLE_TYPE(NSTimer) __CFRunLoopTimer * CFRunLoopTimerRef;
/* Reasons for CFRunLoopRunInMode() to Return */
typedef CF_ENUM(SInt32, CFRunLoopRunResult) {
kCFRunLoopRunFinished = 1,
kCFRunLoopRunStopped = 2,
kCFRunLoopRunTimedOut = 3,
kCFRunLoopRunHandledSource = 4
};
/* Run Loop Observer Activities */
typedef CF_OPTIONS(CFOptionFlags, CFRunLoopActivity) {
kCFRunLoopEntry = (1UL << 0),
kCFRunLoopBeforeTimers = (1UL << 1),
kCFRunLoopBeforeSources = (1UL << 2),
kCFRunLoopBeforeWaiting = (1UL << 5),
kCFRunLoopAfterWaiting = (1UL << 6),
kCFRunLoopExit = (1UL << 7),
kCFRunLoopAllActivities = 0x0FFFFFFFU
};
CF_EXPORT const CFRunLoopMode kCFRunLoopDefaultMode;
CF_EXPORT const CFRunLoopMode kCFRunLoopCommonModes;
CF_EXPORT CFTypeID CFRunLoopGetTypeID(void);
CF_EXPORT CFRunLoopRef CFRunLoopGetCurrent(void);
CF_EXPORT CFRunLoopRef CFRunLoopGetMain(void);
CF_EXPORT CFRunLoopMode CFRunLoopCopyCurrentMode(CFRunLoopRef rl);
CF_EXPORT CFArrayRef CFRunLoopCopyAllModes(CFRunLoopRef rl);
CF_EXPORT void CFRunLoopAddCommonMode(CFRunLoopRef rl, CFRunLoopMode mode);
CF_EXPORT CFAbsoluteTime CFRunLoopGetNextTimerFireDate(CFRunLoopRef rl, CFRunLoopMode mode);
CF_EXPORT void CFRunLoopRun(void);
CF_EXPORT CFRunLoopRunResult CFRunLoopRunInMode(CFRunLoopMode mode, CFTimeInterval seconds, Boolean returnAfterSourceHandled);
CF_EXPORT Boolean CFRunLoopIsWaiting(CFRunLoopRef rl);
CF_EXPORT void CFRunLoopWakeUp(CFRunLoopRef rl);
CF_EXPORT void CFRunLoopStop(CFRunLoopRef rl);
#if __BLOCKS__
CF_EXPORT void CFRunLoopPerformBlock(CFRunLoopRef rl, CFTypeRef mode, void (^block)(void)) API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
#endif
CF_EXPORT Boolean CFRunLoopContainsSource(CFRunLoopRef rl, CFRunLoopSourceRef source, CFRunLoopMode mode);
CF_EXPORT void CFRunLoopAddSource(CFRunLoopRef rl, CFRunLoopSourceRef source, CFRunLoopMode mode);
CF_EXPORT void CFRunLoopRemoveSource(CFRunLoopRef rl, CFRunLoopSourceRef source, CFRunLoopMode mode);
CF_EXPORT Boolean CFRunLoopContainsObserver(CFRunLoopRef rl, CFRunLoopObserverRef observer, CFRunLoopMode mode);
CF_EXPORT void CFRunLoopAddObserver(CFRunLoopRef rl, CFRunLoopObserverRef observer, CFRunLoopMode mode);
CF_EXPORT void CFRunLoopRemoveObserver(CFRunLoopRef rl, CFRunLoopObserverRef observer, CFRunLoopMode mode);
CF_EXPORT Boolean CFRunLoopContainsTimer(CFRunLoopRef rl, CFRunLoopTimerRef timer, CFRunLoopMode mode);
CF_EXPORT void CFRunLoopAddTimer(CFRunLoopRef rl, CFRunLoopTimerRef timer, CFRunLoopMode mode);
CF_EXPORT void CFRunLoopRemoveTimer(CFRunLoopRef rl, CFRunLoopTimerRef timer, CFRunLoopMode mode);
typedef struct {
CFIndex version;
void * info;
const void *(*retain)(const void *info);
void (*release)(const void *info);
CFStringRef (*copyDescription)(const void *info);
Boolean (*equal)(const void *info1, const void *info2);
CFHashCode (*hash)(const void *info);
void (*schedule)(void *info, CFRunLoopRef rl, CFRunLoopMode mode);
void (*cancel)(void *info, CFRunLoopRef rl, CFRunLoopMode mode);
void (*perform)(void *info);
} CFRunLoopSourceContext;
typedef struct {
CFIndex version;
void * info;
const void *(*retain)(const void *info);
void (*release)(const void *info);
CFStringRef (*copyDescription)(const void *info);
Boolean (*equal)(const void *info1, const void *info2);
CFHashCode (*hash)(const void *info);
#if TARGET_OS_OSX || TARGET_OS_IPHONE
mach_port_t (*getPort)(void *info);
void * (*perform)(void *msg, CFIndex size, CFAllocatorRef allocator, void *info);
#else
void * (*getPort)(void *info);
void (*perform)(void *info);
#endif
} CFRunLoopSourceContext1;
CF_EXPORT CFTypeID CFRunLoopSourceGetTypeID(void);
CF_EXPORT CFRunLoopSourceRef CFRunLoopSourceCreate(CFAllocatorRef allocator, CFIndex order, CFRunLoopSourceContext *context);
CF_EXPORT CFIndex CFRunLoopSourceGetOrder(CFRunLoopSourceRef source);
CF_EXPORT void CFRunLoopSourceInvalidate(CFRunLoopSourceRef source);
CF_EXPORT Boolean CFRunLoopSourceIsValid(CFRunLoopSourceRef source);
CF_EXPORT void CFRunLoopSourceGetContext(CFRunLoopSourceRef source, CFRunLoopSourceContext *context);
CF_EXPORT void CFRunLoopSourceSignal(CFRunLoopSourceRef source);
typedef struct {
CFIndex version;
void * info;
const void *(*retain)(const void *info);
void (*release)(const void *info);
CFStringRef (*copyDescription)(const void *info);
} CFRunLoopObserverContext;
typedef void (*CFRunLoopObserverCallBack)(CFRunLoopObserverRef observer, CFRunLoopActivity activity, void *info);
CF_EXPORT CFTypeID CFRunLoopObserverGetTypeID(void);
CF_EXPORT CFRunLoopObserverRef CFRunLoopObserverCreate(CFAllocatorRef allocator, CFOptionFlags activities, Boolean repeats, CFIndex order, CFRunLoopObserverCallBack callout, CFRunLoopObserverContext *context);
#if __BLOCKS__
CF_EXPORT CFRunLoopObserverRef CFRunLoopObserverCreateWithHandler(CFAllocatorRef allocator, CFOptionFlags activities, Boolean repeats, CFIndex order, void (^block) (CFRunLoopObserverRef observer, CFRunLoopActivity activity)) API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
#endif
CF_EXPORT CFOptionFlags CFRunLoopObserverGetActivities(CFRunLoopObserverRef observer);
CF_EXPORT Boolean CFRunLoopObserverDoesRepeat(CFRunLoopObserverRef observer);
CF_EXPORT CFIndex CFRunLoopObserverGetOrder(CFRunLoopObserverRef observer);
CF_EXPORT void CFRunLoopObserverInvalidate(CFRunLoopObserverRef observer);
CF_EXPORT Boolean CFRunLoopObserverIsValid(CFRunLoopObserverRef observer);
CF_EXPORT void CFRunLoopObserverGetContext(CFRunLoopObserverRef observer, CFRunLoopObserverContext *context);
typedef struct {
CFIndex version;
void * info;
const void *(*retain)(const void *info);
void (*release)(const void *info);
CFStringRef (*copyDescription)(const void *info);
} CFRunLoopTimerContext;
typedef void (*CFRunLoopTimerCallBack)(CFRunLoopTimerRef timer, void *info);
CF_EXPORT CFTypeID CFRunLoopTimerGetTypeID(void);
CF_EXPORT CFRunLoopTimerRef CFRunLoopTimerCreate(CFAllocatorRef allocator, CFAbsoluteTime fireDate, CFTimeInterval interval, CFOptionFlags flags, CFIndex order, CFRunLoopTimerCallBack callout, CFRunLoopTimerContext *context);
#if __BLOCKS__
CF_EXPORT CFRunLoopTimerRef CFRunLoopTimerCreateWithHandler(CFAllocatorRef allocator, CFAbsoluteTime fireDate, CFTimeInterval interval, CFOptionFlags flags, CFIndex order, void (^block) (CFRunLoopTimerRef timer)) API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
#endif
CF_EXPORT CFAbsoluteTime CFRunLoopTimerGetNextFireDate(CFRunLoopTimerRef timer);
CF_EXPORT void CFRunLoopTimerSetNextFireDate(CFRunLoopTimerRef timer, CFAbsoluteTime fireDate);
CF_EXPORT CFTimeInterval CFRunLoopTimerGetInterval(CFRunLoopTimerRef timer);
CF_EXPORT Boolean CFRunLoopTimerDoesRepeat(CFRunLoopTimerRef timer);
CF_EXPORT CFIndex CFRunLoopTimerGetOrder(CFRunLoopTimerRef timer);
CF_EXPORT void CFRunLoopTimerInvalidate(CFRunLoopTimerRef timer);
CF_EXPORT Boolean CFRunLoopTimerIsValid(CFRunLoopTimerRef timer);
CF_EXPORT void CFRunLoopTimerGetContext(CFRunLoopTimerRef timer, CFRunLoopTimerContext *context);
// Setting a tolerance for a timer allows it to fire later than the scheduled fire date, improving the ability of the system to optimize for increased power savings and responsiveness. The timer may fire at any time between its scheduled fire date and the scheduled fire date plus the tolerance. The timer will not fire before the scheduled fire date. For repeating timers, the next fire date is calculated from the original fire date regardless of tolerance applied at individual fire times, to avoid drift. The default value is zero, which means no additional tolerance is applied. The system reserves the right to apply a small amount of tolerance to certain timers regardless of the value of this property.
// As the user of the timer, you will have the best idea of what an appropriate tolerance for a timer may be. A general rule of thumb, though, is to set the tolerance to at least 10% of the interval, for a repeating timer. Even a small amount of tolerance will have a significant positive impact on the power usage of your application. The system may put a maximum value of the tolerance.
CF_EXPORT CFTimeInterval CFRunLoopTimerGetTolerance(CFRunLoopTimerRef timer) API_AVAILABLE(macos(10.9), ios(7.0), watchos(2.0), tvos(9.0));
CF_EXPORT void CFRunLoopTimerSetTolerance(CFRunLoopTimerRef timer, CFTimeInterval tolerance) API_AVAILABLE(macos(10.9), ios(7.0), watchos(2.0), tvos(9.0));
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif /* ! __COREFOUNDATION_CFRUNLOOP__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFFileSecurity.h | /*
* CFFileSecurity.h
* NSFileSecurity and CFFileSecurity are toll-free bridged.
*
* Copyright (c) 2010-2019, Apple Inc. All rights reserved.
*/
#include <CoreFoundation/CFBase.h>
#if TARGET_OS_MAC || CF_BUILDING_CF || NSBUILDINGFOUNDATION
#if !defined(__COREFOUNDATION_CFFILESECURITY__)
#define __COREFOUNDATION_CFFILESECURITY__ 1
#include <sys/types.h>
#include <sys/acl.h>
#include <sys/fcntl.h>
#include <CoreFoundation/CFUUID.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
/*
* A CFFileSecurity object encapulates a file system object's security information
* in a CF object.
*/
typedef struct CF_BRIDGED_MUTABLE_TYPE(NSFileSecurity) __CFFileSecurity* CFFileSecurityRef;
/*
* Returns the type identifier for the CFFileSecurity opaque type.
*
* Return Value
* The type identifier for the CFFileSecurity opaque type.
*/
CF_EXPORT
CFTypeID CFFileSecurityGetTypeID(void) API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/*
* Creates an CFFileSecurity object.
*
* Parameters
* allocator
* The allocator to use to allocate memory for the new object. Pass
* NULL or kCFAllocatorDefault to use the current default allocator.
* Return Value
* A new CFFileSecurity object, or NULL if there was a problem creating the
* object. Ownership follows the Create Rule.
*/
CF_EXPORT
CFFileSecurityRef CFFileSecurityCreate(CFAllocatorRef allocator) API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/*
* Creates a copy of a CFFileSecurity object.
*
* Parameters
* allocator
* The allocator to use to allocate memory for the new object. Pass
* NULL or kCFAllocatorDefault to use the current default allocator.
* fileSec
* The CFFileSecurity object to copy.
* Return Value
* A copy of fileSec, or NULL if there was a problem creating the object.
* Ownership follows the Create Rule.
*/
CF_EXPORT
CFFileSecurityRef CFFileSecurityCreateCopy(CFAllocatorRef allocator, CFFileSecurityRef fileSec) API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/*
* This routine copies the owner UUID associated with an CFFileSecurity object.
*
* Parameters
* fileSec
* The CFFileSecurity object.
* ownerUUID
* A pointer to storage for the owner UUID.
* Return Value
* true if ownerUUID is successfully returned; false if there is no owner
* UUID property associated with an CFFileSecurity object.
*/
CF_EXPORT
Boolean CFFileSecurityCopyOwnerUUID(CFFileSecurityRef fileSec, CFUUIDRef *ownerUUID) API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/*
* This routine sets the owner UUID associated with an CFFileSecurity object.
*
* Parameters
* fileSec
* The CFFileSecurity object.
* ownerUUID
* The owner UUID.
* Return Value
* true if the owner UUID was successfully set; otherwise, false.
*/
CF_EXPORT
Boolean CFFileSecuritySetOwnerUUID(CFFileSecurityRef fileSec, CFUUIDRef ownerUUID) API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/*
* This routine copies the group UUID associated with an CFFileSecurity object.
*
* Parameters
* fileSec
* The CFFileSecurity object.
* groupUUID
* A pointer to storage for the group UUID.
* Return Value
* true if groupUUID is successfully returned; false if there is no group
* UUID property associated with an CFFileSecurity object.
*/
CF_EXPORT
Boolean CFFileSecurityCopyGroupUUID(CFFileSecurityRef fileSec, CFUUIDRef *groupUUID) API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/*
* This routine sets the group UUID associated with an CFFileSecurity object.
*
* Parameters
* fileSec
* The CFFileSecurity object.
* groupUUID
* The group UUID.
* Return Value
* true if the group UUID was successfully set; otherwise, false.
*/
CF_EXPORT
Boolean CFFileSecuritySetGroupUUID(CFFileSecurityRef fileSec, CFUUIDRef groupUUID) API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/*
* This routine copies the access control list (acl_t) associated with an
* CFFileSecurity object. The acl_t returned by this routine is a copy and must
* be released using acl_free(3). The acl_t is meant to be manipulated using
* the acl calls defined in <sys/acl.h>.
*
* Parameters
* fileSec
* The CFFileSecurity object.
* accessControlList
* A pointer to storage for an acl_t. The acl_t be released using
* acl_free(3)
* Return Value
* true if the access control list is successfully copied; false if there is
* no access control list property associated with the CFFileSecurity object.
*/
CF_EXPORT
Boolean CFFileSecurityCopyAccessControlList(CFFileSecurityRef fileSec, acl_t *accessControlList) API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
#define kCFFileSecurityRemoveACL (acl_t) _FILESEC_REMOVE_ACL
/*
* This routine will set the access control list (acl_t) associated with an
* CFFileSecurityRef. To request removal of an access control list from a
* filesystem object, pass in kCFFileSecurityRemoveACL as the acl_t and set
* the fileSec on the target object using CFURLSetResourcePropertyForKey and
* the kCFURLFileSecurityKey. Setting the accessControlList to NULL will result
* in the property being unset.
*
* Parameters
* fileSec
* The CFFileSecurity object.
* accessControlList
* The acl_t to set, or kCFFileSecurityRemoveACL to remove the access
* control list, or NULL to unset the accessControlList.
* Return Value
* true if the access control list is successfully set; otherwise, false.
*/
CF_EXPORT
Boolean CFFileSecuritySetAccessControlList(CFFileSecurityRef fileSec, acl_t accessControlList) API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/*
* This routine gets the owner uid_t associated with an CFFileSecurity object.
*
* Parameters
* fileSec
* The CFFileSecurity object.
* owner
* A pointer to where the owner uid_t will be put.
* Return Value
* true if owner uid_t is successfully obtained; false if there is no owner
* property associated with an CFFileSecurity object.
*/
CF_EXPORT
Boolean CFFileSecurityGetOwner(CFFileSecurityRef fileSec, uid_t *owner) API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/*
* This routine sets the owner uid_t associated with an CFFileSecurity object.
*
* Parameters
* fileSec
* The CFFileSecurity object.
* owner
* The owner uid_t.
* Return Value
* true if the owner uid_t was successfully set; otherwise, false.
*/
CF_EXPORT
Boolean CFFileSecuritySetOwner(CFFileSecurityRef fileSec, uid_t owner) API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/*
* This routine gets the group gid_t associated with an CFFileSecurity object.
*
* Parameters
* fileSec
* The CFFileSecurity object.
* owner
* A pointer to where the group gid_t will be put.
* Return Value
* true if group gid_t is successfully obtained; false if there is no group
* property associated with an CFFileSecurity object.
*/
CF_EXPORT
Boolean CFFileSecurityGetGroup(CFFileSecurityRef fileSec, gid_t *group) API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/*
* This routine sets the group gid_t associated with an CFFileSecurity object.
*
* Parameters
* fileSec
* The CFFileSecurity object.
* owner
* The group gid_t.
* Return Value
* true if the group gid_t was successfully set; otherwise, false.
*/
CF_EXPORT
Boolean CFFileSecuritySetGroup(CFFileSecurityRef fileSec, gid_t group) API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/*
* This routine gets the mode_t associated with an CFFileSecurity object.
*
* Parameters
* fileSec
* The CFFileSecurity object.
* owner
* A pointer to where the mode_t will be put.
* Return Value
* true if mode_t is successfully obtained; false if there is no mode
* property associated with an CFFileSecurity object.
*/
CF_EXPORT
Boolean CFFileSecurityGetMode(CFFileSecurityRef fileSec, mode_t *mode) API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/*
* This routine sets the mode_t associated with an CFFileSecurity object.
*
* Parameters
* fileSec
* The CFFileSecurity object.
* owner
* The mode_t.
* Return Value
* true if the mode_t was successfully set; otherwise, false.
*/
CF_EXPORT
Boolean CFFileSecuritySetMode(CFFileSecurityRef fileSec, mode_t mode) API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/* values to pass in the clearPropertyMask to CFFileSecurityClearProperties */
typedef CF_OPTIONS(CFOptionFlags, CFFileSecurityClearOptions) {
kCFFileSecurityClearOwner = 1UL << 0,
kCFFileSecurityClearGroup = 1UL << 1,
kCFFileSecurityClearMode = 1UL << 2,
kCFFileSecurityClearOwnerUUID = 1UL << 3,
kCFFileSecurityClearGroupUUID = 1UL << 4,
kCFFileSecurityClearAccessControlList = 1UL << 5
} API_AVAILABLE(macos(10.8), ios(6.0), watchos(2.0), tvos(9.0));
/*
* This routine clears file security properties in the CFFileSecurity object.
*
* Parameters
* clearPropertyMask
* The file security properties to clear.
* Return Value
* true if the file security properties were successfully cleared; otherwise, false.
*/
CF_EXPORT
Boolean CFFileSecurityClearProperties(CFFileSecurityRef fileSec, CFFileSecurityClearOptions clearPropertyMask) API_AVAILABLE(macos(10.8), ios(6.0), watchos(2.0), tvos(9.0));
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif /* ! __COREFOUNDATION_CFFILESECURITY__ */
#endif
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFXMLNode.h | /* CFXMLNode.h
Copyright (c) 1998-2019, Apple Inc. and the Swift project authors
Portions Copyright (c) 2014-2019, Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See http://swift.org/LICENSE.txt for license information
See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
*/
/* CFXMLParser (and thus CFXMLNode) are deprecated as of Mac OS X 10.8 and iOS 6.0. The suggested replacements are the Foundation classes NSXMLParser and NSXMLDocument, or the libxml2 library. */
#include <TargetConditionals.h>
#if TARGET_OS_OSX
#if !defined(__COREFOUNDATION_CFXMLNODE__)
#define __COREFOUNDATION_CFXMLNODE__ 1
#include <CoreFoundation/CFArray.h>
#include <CoreFoundation/CFDictionary.h>
#include <CoreFoundation/CFString.h>
#include <CoreFoundation/CFTree.h>
#include <CoreFoundation/CFURL.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
#define __CFXMLNode_DEPRECATION_MSG "CFXMLNode is deprecated, use NSXMLParser, NSXMLDocument or libxml2 library instead"
CF_ENUM(CFIndex) {
kCFXMLNodeCurrentVersion = 1
};
typedef const struct __CFXMLNode * CFXMLNodeRef;
typedef CFTreeRef CFXMLTreeRef;
/* An CFXMLNode describes an individual XML construct - like a tag, or a comment, or a string
of character data. Each CFXMLNode contains 3 main pieces of information - the node's type,
the data string, and a pointer to an additional data structure. The node's type ID is an enum
value of type CFXMLNodeTypeID. The data string is always a CFStringRef; the meaning of the
string is dependent on the node's type ID. The format of the additional data is also dependent
on the node's type; in general, there is a custom structure for each type that requires
additional data. See below for the mapping from type ID to meaning of the data string and
structure of the additional data. Note that these structures are versioned, and may change
as the parser changes. The current version can always be identified by kCFXMLNodeCurrentVersion;
earlier versions can be identified and used by passing earlier values for the version number
(although the older structures would have been removed from the header).
An CFXMLTree is simply a CFTree whose context data is known to be an CFXMLNodeRef. As
such, an CFXMLTree can be used to represent an entire XML document; the CFTree
provides the tree structure of the document, while the CFXMLNodes identify and describe
the nodes of the tree. An XML document can be parsed to a CFXMLTree, and a CFXMLTree
can generate the data for the equivalent XML document - see CFXMLParser.h for more
information on parsing XML.
*/
/* Type codes for the different possible XML nodes; this list may grow.*/
typedef CF_ENUM(CFIndex, CFXMLNodeTypeCode) {
kCFXMLNodeTypeDocument = 1,
kCFXMLNodeTypeElement = 2,
kCFXMLNodeTypeAttribute = 3,
kCFXMLNodeTypeProcessingInstruction = 4,
kCFXMLNodeTypeComment = 5,
kCFXMLNodeTypeText = 6,
kCFXMLNodeTypeCDATASection = 7,
kCFXMLNodeTypeDocumentFragment = 8,
kCFXMLNodeTypeEntity = 9,
kCFXMLNodeTypeEntityReference = 10,
kCFXMLNodeTypeDocumentType = 11,
kCFXMLNodeTypeWhitespace = 12,
kCFXMLNodeTypeNotation = 13,
kCFXMLNodeTypeElementTypeDeclaration = 14,
kCFXMLNodeTypeAttributeListDeclaration = 15
};
typedef struct {
CFDictionaryRef attributes;
CFArrayRef attributeOrder;
Boolean isEmpty;
char _reserved[3];
} CFXMLElementInfo;
typedef struct {
CFStringRef dataString;
} CFXMLProcessingInstructionInfo;
typedef struct {
CFURLRef sourceURL;
CFStringEncoding encoding;
} CFXMLDocumentInfo;
typedef struct {
CFURLRef systemID;
CFStringRef publicID;
} CFXMLExternalID;
typedef struct {
CFXMLExternalID externalID;
} CFXMLDocumentTypeInfo;
typedef struct {
CFXMLExternalID externalID;
} CFXMLNotationInfo;
typedef struct {
/* This is expected to change in future versions */
CFStringRef contentDescription;
} CFXMLElementTypeDeclarationInfo;
typedef struct {
/* This is expected to change in future versions */
CFStringRef attributeName;
CFStringRef typeString;
CFStringRef defaultString;
} CFXMLAttributeDeclarationInfo;
typedef struct {
CFIndex numberOfAttributes;
CFXMLAttributeDeclarationInfo *attributes;
} CFXMLAttributeListDeclarationInfo;
typedef CF_ENUM(CFIndex, CFXMLEntityTypeCode) {
kCFXMLEntityTypeParameter, /* Implies parsed, internal */
kCFXMLEntityTypeParsedInternal,
kCFXMLEntityTypeParsedExternal,
kCFXMLEntityTypeUnparsed,
kCFXMLEntityTypeCharacter
};
typedef struct {
CFXMLEntityTypeCode entityType;
CFStringRef replacementText; /* NULL if entityType is external or unparsed */
CFXMLExternalID entityID; /* entityID.systemID will be NULL if entityType is internal */
CFStringRef notationName; /* NULL if entityType is parsed */
} CFXMLEntityInfo;
typedef struct {
CFXMLEntityTypeCode entityType;
} CFXMLEntityReferenceInfo;
/*
dataTypeCode meaning of dataString format of infoPtr
=========== ===================== =================
kCFXMLNodeTypeDocument <currently unused> CFXMLDocumentInfo *
kCFXMLNodeTypeElement tag name CFXMLElementInfo *
kCFXMLNodeTypeAttribute <currently unused> <currently unused>
kCFXMLNodeTypeProcessingInstruction name of the target CFXMLProcessingInstructionInfo *
kCFXMLNodeTypeComment text of the comment NULL
kCFXMLNodeTypeText the text's contents NULL
kCFXMLNodeTypeCDATASection text of the CDATA NULL
kCFXMLNodeTypeDocumentFragment <currently unused> <currently unused>
kCFXMLNodeTypeEntity name of the entity CFXMLEntityInfo *
kCFXMLNodeTypeEntityReference name of the referenced entity CFXMLEntityReferenceInfo *
kCFXMLNodeTypeDocumentType name given as top-level element CFXMLDocumentTypeInfo *
kCFXMLNodeTypeWhitespace text of the whitespace NULL
kCFXMLNodeTypeNotation notation name CFXMLNotationInfo *
kCFXMLNodeTypeElementTypeDeclaration tag name CFXMLElementTypeDeclarationInfo *
kCFXMLNodeTypeAttributeListDeclaration tag name CFXMLAttributeListDeclarationInfo *
*/
CF_EXPORT
CFTypeID CFXMLNodeGetTypeID(void) API_DEPRECATED(__CFXMLNode_DEPRECATION_MSG, macos(10.0,10.8), ios(2.0,6.0), watchos(2.0,2.0), tvos(9.0,9.0));
/* Creates a new node based on xmlType, dataString, and additionalInfoPtr. version (together with xmlType) determines the expected structure of additionalInfoPtr */
CF_EXPORT
CFXMLNodeRef CFXMLNodeCreate(CFAllocatorRef alloc, CFXMLNodeTypeCode xmlType, CFStringRef dataString, const void *additionalInfoPtr, CFIndex version) API_DEPRECATED(__CFXMLNode_DEPRECATION_MSG, macos(10.0,10.8), ios(2.0,6.0), watchos(2.0,2.0), tvos(9.0,9.0));
/* Creates a copy of origNode (which may not be NULL). */
CF_EXPORT
CFXMLNodeRef CFXMLNodeCreateCopy(CFAllocatorRef alloc, CFXMLNodeRef origNode) API_DEPRECATED(__CFXMLNode_DEPRECATION_MSG, macos(10.0,10.8), ios(2.0,6.0), watchos(2.0,2.0), tvos(9.0,9.0));
CF_EXPORT
CFXMLNodeTypeCode CFXMLNodeGetTypeCode(CFXMLNodeRef node) API_DEPRECATED(__CFXMLNode_DEPRECATION_MSG, macos(10.0,10.8), ios(2.0,6.0), watchos(2.0,2.0), tvos(9.0,9.0));
CF_EXPORT
CFStringRef CFXMLNodeGetString(CFXMLNodeRef node) API_DEPRECATED(__CFXMLNode_DEPRECATION_MSG, macos(10.0,10.8), ios(2.0,6.0), watchos(2.0,2.0), tvos(9.0,9.0));
CF_EXPORT
const void *CFXMLNodeGetInfoPtr(CFXMLNodeRef node) API_DEPRECATED(__CFXMLNode_DEPRECATION_MSG, macos(10.0,10.8), ios(2.0,6.0), watchos(2.0,2.0), tvos(9.0,9.0));
CF_EXPORT
CFIndex CFXMLNodeGetVersion(CFXMLNodeRef node) API_DEPRECATED(__CFXMLNode_DEPRECATION_MSG, macos(10.0,10.8), ios(2.0,6.0), watchos(2.0,2.0), tvos(9.0,9.0));
/* CFXMLTreeRef */
/* Creates a childless, parentless tree from node */
CF_EXPORT
CFXMLTreeRef CFXMLTreeCreateWithNode(CFAllocatorRef allocator, CFXMLNodeRef node) API_DEPRECATED(__CFXMLNode_DEPRECATION_MSG, macos(10.0,10.8), ios(2.0,6.0), watchos(2.0,2.0), tvos(9.0,9.0));
/* Extracts and returns the node stored in xmlTree */
CF_EXPORT
CFXMLNodeRef CFXMLTreeGetNode(CFXMLTreeRef xmlTree) API_DEPRECATED(__CFXMLNode_DEPRECATION_MSG, macos(10.0,10.8), ios(2.0,6.0), watchos(2.0,2.0), tvos(9.0,9.0));
#undef __CFXMLNode_DEPRECATION_MSG
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif /* ! __COREFOUNDATION_CFXMLNODE__ */
#endif /* TARGET_OS_OSX */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFPlugIn.h | /* CFPlugIn.h
Copyright (c) 1999-2019, Apple Inc. and the Swift project authors
Portions Copyright (c) 2014-2019, Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See http://swift.org/LICENSE.txt for license information
See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
*/
#if !defined(__COREFOUNDATION_CFPLUGIN__)
#define __COREFOUNDATION_CFPLUGIN__ 1
#if !defined(COREFOUNDATION_CFPLUGINCOM_SEPARATE)
#define COREFOUNDATION_CFPLUGINCOM_SEPARATE 1
#endif
#include <CoreFoundation/CFBase.h>
#include <CoreFoundation/CFArray.h>
#include <CoreFoundation/CFBundle.h>
#include <CoreFoundation/CFString.h>
#include <CoreFoundation/CFURL.h>
#include <CoreFoundation/CFUUID.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
/* ================ Standard Info.plist keys for plugIns ================ */
CF_EXPORT const CFStringRef kCFPlugInDynamicRegistrationKey;
CF_EXPORT const CFStringRef kCFPlugInDynamicRegisterFunctionKey;
CF_EXPORT const CFStringRef kCFPlugInUnloadFunctionKey;
CF_EXPORT const CFStringRef kCFPlugInFactoriesKey;
CF_EXPORT const CFStringRef kCFPlugInTypesKey;
/* ================= Function prototypes for various callbacks ================= */
/* Function types that plugIn authors can implement for various purposes. */
typedef void (*CFPlugInDynamicRegisterFunction)(CFPlugInRef plugIn);
typedef void (*CFPlugInUnloadFunction)(CFPlugInRef plugIn);
typedef void *(*CFPlugInFactoryFunction)(CFAllocatorRef allocator, CFUUIDRef typeUUID);
/* ================= Creating PlugIns ================= */
CF_EXPORT CFTypeID CFPlugInGetTypeID(void);
CF_EXPORT CFPlugInRef CFPlugInCreate(CFAllocatorRef allocator, CFURLRef plugInURL);
/* Might return an existing instance with the ref-count bumped. */
CF_EXPORT CFBundleRef CFPlugInGetBundle(CFPlugInRef plugIn);
/* ================= Controlling load on demand ================= */
/* For plugIns. */
/* PlugIns that do static registration are load on demand by default. */
/* PlugIns that do dynamic registration are not load on demand by default. */
/* A dynamic registration function can call CFPlugInSetLoadOnDemand(). */
CF_EXPORT void CFPlugInSetLoadOnDemand(CFPlugInRef plugIn, Boolean flag);
CF_EXPORT Boolean CFPlugInIsLoadOnDemand(CFPlugInRef plugIn);
/* ================= Finding factories and creating instances ================= */
/* For plugIn hosts. */
/* Functions for finding factories to create specific types and actually creating instances of a type. */
/* This function finds all the factories from any plugin for the given type. Returns an array that the caller must release. */
CF_EXPORT CFArrayRef CFPlugInFindFactoriesForPlugInType(CFUUIDRef typeUUID) CF_RETURNS_RETAINED;
/* This function restricts the result to factories from the given plug-in that can create the given type. Returns an array that the caller must release. */
CF_EXPORT CFArrayRef CFPlugInFindFactoriesForPlugInTypeInPlugIn(CFUUIDRef typeUUID, CFPlugInRef plugIn) CF_RETURNS_RETAINED;
/* This function returns the IUnknown interface for the new instance. */
CF_EXPORT void *CFPlugInInstanceCreate(CFAllocatorRef allocator, CFUUIDRef factoryUUID, CFUUIDRef typeUUID);
/* ================= Registering factories and types ================= */
/* For plugIn writers who must dynamically register things. */
/* Functions to register factory functions and to associate factories with types. */
CF_EXPORT Boolean CFPlugInRegisterFactoryFunction(CFUUIDRef factoryUUID, CFPlugInFactoryFunction func);
CF_EXPORT Boolean CFPlugInRegisterFactoryFunctionByName(CFUUIDRef factoryUUID, CFPlugInRef plugIn, CFStringRef functionName);
CF_EXPORT Boolean CFPlugInUnregisterFactory(CFUUIDRef factoryUUID);
CF_EXPORT Boolean CFPlugInRegisterPlugInType(CFUUIDRef factoryUUID, CFUUIDRef typeUUID);
CF_EXPORT Boolean CFPlugInUnregisterPlugInType(CFUUIDRef factoryUUID, CFUUIDRef typeUUID);
/* ================= Registering instances ================= */
/* When a new instance of a type is created, the instance is responsible for registering itself with the factory that created it and unregistering when it deallocates. */
/* This means that an instance must keep track of the CFUUIDRef of the factory that created it so it can unregister when it goes away. */
CF_EXPORT void CFPlugInAddInstanceForFactory(CFUUIDRef factoryID);
CF_EXPORT void CFPlugInRemoveInstanceForFactory(CFUUIDRef factoryID);
/* Obsolete API */
typedef struct CF_BRIDGED_TYPE(id) __CFPlugInInstance *CFPlugInInstanceRef;
typedef Boolean (*CFPlugInInstanceGetInterfaceFunction)(CFPlugInInstanceRef instance, CFStringRef interfaceName, void **ftbl);
typedef void (*CFPlugInInstanceDeallocateInstanceDataFunction)(void *instanceData);
CF_EXPORT Boolean CFPlugInInstanceGetInterfaceFunctionTable(CFPlugInInstanceRef instance, CFStringRef interfaceName, void **ftbl);
/* This function returns a retained object on 10.8 or later. */
CF_EXPORT CFStringRef CFPlugInInstanceGetFactoryName(CFPlugInInstanceRef instance) CF_RETURNS_RETAINED;
CF_EXPORT void *CFPlugInInstanceGetInstanceData(CFPlugInInstanceRef instance);
CF_EXPORT CFTypeID CFPlugInInstanceGetTypeID(void);
CF_EXPORT CFPlugInInstanceRef CFPlugInInstanceCreateWithInstanceDataSize(CFAllocatorRef allocator, CFIndex instanceDataSize, CFPlugInInstanceDeallocateInstanceDataFunction deallocateInstanceFunction, CFStringRef factoryName, CFPlugInInstanceGetInterfaceFunction getInterfaceFunction);
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#if !COREFOUNDATION_CFPLUGINCOM_SEPARATE
#include <CoreFoundation/CFPlugInCOM.h>
#endif /* !COREFOUNDATION_CFPLUGINCOM_SEPARATE */
#endif /* ! __COREFOUNDATION_CFPLUGIN__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFByteOrder.h | /* CFByteOrder.h
Copyright (c) 1995-2019, Apple Inc. and the Swift project authors
Portions Copyright (c) 2014-2019, Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See http://swift.org/LICENSE.txt for license information
See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
*/
#if !defined(__COREFOUNDATION_CFBYTEORDER__)
#define __COREFOUNDATION_CFBYTEORDER__ 1
#include <CoreFoundation/CFBase.h>
#if (TARGET_OS_OSX || TARGET_OS_IPHONE) && !defined(CF_USE_OSBYTEORDER_H)
#include <libkern/OSByteOrder.h>
#define CF_USE_OSBYTEORDER_H 1
#endif
CF_EXTERN_C_BEGIN
enum __CFByteOrder {
CFByteOrderUnknown,
CFByteOrderLittleEndian,
CFByteOrderBigEndian
};
typedef CFIndex CFByteOrder;
CF_INLINE CFByteOrder CFByteOrderGetCurrent(void) {
#if CF_USE_OSBYTEORDER_H
int32_t byteOrder = OSHostByteOrder();
switch (byteOrder) {
case OSLittleEndian: return CFByteOrderLittleEndian;
case OSBigEndian: return CFByteOrderBigEndian;
default: break;
}
return CFByteOrderUnknown;
#else
#if __LITTLE_ENDIAN__
return CFByteOrderLittleEndian;
#elif __BIG_ENDIAN__
return CFByteOrderBigEndian;
#else
return CFByteOrderUnknown;
#endif
#endif
}
CF_INLINE uint16_t CFSwapInt16(uint16_t arg) {
#if CF_USE_OSBYTEORDER_H
return OSSwapInt16(arg);
#else
uint16_t result;
result = (uint16_t)(((arg << 8) & 0xFF00) | ((arg >> 8) & 0xFF));
return result;
#endif
}
CF_INLINE uint32_t CFSwapInt32(uint32_t arg) {
#if CF_USE_OSBYTEORDER_H
return OSSwapInt32(arg);
#else
uint32_t result;
result = ((arg & 0xFF) << 24) | ((arg & 0xFF00) << 8) | ((arg >> 8) & 0xFF00) | ((arg >> 24) & 0xFF);
return result;
#endif
}
CF_INLINE uint64_t CFSwapInt64(uint64_t arg) {
#if CF_USE_OSBYTEORDER_H
return OSSwapInt64(arg);
#else
union CFSwap {
uint64_t sv;
uint32_t ul[2];
} tmp, result;
tmp.sv = arg;
result.ul[0] = CFSwapInt32(tmp.ul[1]);
result.ul[1] = CFSwapInt32(tmp.ul[0]);
return result.sv;
#endif
}
CF_INLINE uint16_t CFSwapInt16BigToHost(uint16_t arg) {
#if CF_USE_OSBYTEORDER_H
return OSSwapBigToHostInt16(arg);
#elif __BIG_ENDIAN__
return arg;
#else
return CFSwapInt16(arg);
#endif
}
CF_INLINE uint32_t CFSwapInt32BigToHost(uint32_t arg) {
#if CF_USE_OSBYTEORDER_H
return OSSwapBigToHostInt32(arg);
#elif __BIG_ENDIAN__
return arg;
#else
return CFSwapInt32(arg);
#endif
}
CF_INLINE uint64_t CFSwapInt64BigToHost(uint64_t arg) {
#if CF_USE_OSBYTEORDER_H
return OSSwapBigToHostInt64(arg);
#elif __BIG_ENDIAN__
return arg;
#else
return CFSwapInt64(arg);
#endif
}
CF_INLINE uint16_t CFSwapInt16HostToBig(uint16_t arg) {
#if CF_USE_OSBYTEORDER_H
return OSSwapHostToBigInt16(arg);
#elif __BIG_ENDIAN__
return arg;
#else
return CFSwapInt16(arg);
#endif
}
CF_INLINE uint32_t CFSwapInt32HostToBig(uint32_t arg) {
#if CF_USE_OSBYTEORDER_H
return OSSwapHostToBigInt32(arg);
#elif __BIG_ENDIAN__
return arg;
#else
return CFSwapInt32(arg);
#endif
}
CF_INLINE uint64_t CFSwapInt64HostToBig(uint64_t arg) {
#if CF_USE_OSBYTEORDER_H
return OSSwapHostToBigInt64(arg);
#elif __BIG_ENDIAN__
return arg;
#else
return CFSwapInt64(arg);
#endif
}
CF_INLINE uint16_t CFSwapInt16LittleToHost(uint16_t arg) {
#if CF_USE_OSBYTEORDER_H
return OSSwapLittleToHostInt16(arg);
#elif __LITTLE_ENDIAN__
return arg;
#else
return CFSwapInt16(arg);
#endif
}
CF_INLINE uint32_t CFSwapInt32LittleToHost(uint32_t arg) {
#if CF_USE_OSBYTEORDER_H
return OSSwapLittleToHostInt32(arg);
#elif __LITTLE_ENDIAN__
return arg;
#else
return CFSwapInt32(arg);
#endif
}
CF_INLINE uint64_t CFSwapInt64LittleToHost(uint64_t arg) {
#if CF_USE_OSBYTEORDER_H
return OSSwapLittleToHostInt64(arg);
#elif __LITTLE_ENDIAN__
return arg;
#else
return CFSwapInt64(arg);
#endif
}
CF_INLINE uint16_t CFSwapInt16HostToLittle(uint16_t arg) {
#if CF_USE_OSBYTEORDER_H
return OSSwapHostToLittleInt16(arg);
#elif __LITTLE_ENDIAN__
return arg;
#else
return CFSwapInt16(arg);
#endif
}
CF_INLINE uint32_t CFSwapInt32HostToLittle(uint32_t arg) {
#if CF_USE_OSBYTEORDER_H
return OSSwapHostToLittleInt32(arg);
#elif __LITTLE_ENDIAN__
return arg;
#else
return CFSwapInt32(arg);
#endif
}
CF_INLINE uint64_t CFSwapInt64HostToLittle(uint64_t arg) {
#if CF_USE_OSBYTEORDER_H
return OSSwapHostToLittleInt64(arg);
#elif __LITTLE_ENDIAN__
return arg;
#else
return CFSwapInt64(arg);
#endif
}
typedef struct {uint32_t v;} CFSwappedFloat32;
typedef struct {uint64_t v;} CFSwappedFloat64;
CF_INLINE CFSwappedFloat32 CFConvertFloat32HostToSwapped(Float32 arg) {
union CFSwap {
Float32 v;
CFSwappedFloat32 sv;
} result;
result.v = arg;
#if __LITTLE_ENDIAN__
result.sv.v = CFSwapInt32(result.sv.v);
#endif
return result.sv;
}
CF_INLINE Float32 CFConvertFloat32SwappedToHost(CFSwappedFloat32 arg) {
union CFSwap {
Float32 v;
CFSwappedFloat32 sv;
} result;
result.sv = arg;
#if __LITTLE_ENDIAN__
result.sv.v = CFSwapInt32(result.sv.v);
#endif
return result.v;
}
CF_INLINE CFSwappedFloat64 CFConvertFloat64HostToSwapped(Float64 arg) {
union CFSwap {
Float64 v;
CFSwappedFloat64 sv;
} result;
result.v = arg;
#if __LITTLE_ENDIAN__
result.sv.v = CFSwapInt64(result.sv.v);
#endif
return result.sv;
}
CF_INLINE Float64 CFConvertFloat64SwappedToHost(CFSwappedFloat64 arg) {
union CFSwap {
Float64 v;
CFSwappedFloat64 sv;
} result;
result.sv = arg;
#if __LITTLE_ENDIAN__
result.sv.v = CFSwapInt64(result.sv.v);
#endif
return result.v;
}
CF_INLINE CFSwappedFloat32 CFConvertFloatHostToSwapped(float arg) {
union CFSwap {
float v;
CFSwappedFloat32 sv;
} result;
result.v = arg;
#if __LITTLE_ENDIAN__
result.sv.v = CFSwapInt32(result.sv.v);
#endif
return result.sv;
}
CF_INLINE float CFConvertFloatSwappedToHost(CFSwappedFloat32 arg) {
union CFSwap {
float v;
CFSwappedFloat32 sv;
} result;
result.sv = arg;
#if __LITTLE_ENDIAN__
result.sv.v = CFSwapInt32(result.sv.v);
#endif
return result.v;
}
CF_INLINE CFSwappedFloat64 CFConvertDoubleHostToSwapped(double arg) {
union CFSwap {
double v;
CFSwappedFloat64 sv;
} result;
result.v = arg;
#if __LITTLE_ENDIAN__
result.sv.v = CFSwapInt64(result.sv.v);
#endif
return result.sv;
}
CF_INLINE double CFConvertDoubleSwappedToHost(CFSwappedFloat64 arg) {
union CFSwap {
double v;
CFSwappedFloat64 sv;
} result;
result.sv = arg;
#if __LITTLE_ENDIAN__
result.sv.v = CFSwapInt64(result.sv.v);
#endif
return result.v;
}
CF_EXTERN_C_END
#endif /* ! __COREFOUNDATION_CFBYTEORDER__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFData.h | /* CFData.h
Copyright (c) 1998-2019, Apple Inc. and the Swift project authors
Portions Copyright (c) 2014-2019, Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See http://swift.org/LICENSE.txt for license information
See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
*/
#if !defined(__COREFOUNDATION_CFDATA__)
#define __COREFOUNDATION_CFDATA__ 1
#include <CoreFoundation/CFBase.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
typedef const struct CF_BRIDGED_TYPE(NSData) __CFData * CFDataRef;
typedef struct CF_BRIDGED_MUTABLE_TYPE(NSMutableData) __CFData * CFMutableDataRef;
CF_EXPORT
CFTypeID CFDataGetTypeID(void);
CF_EXPORT
CFDataRef CFDataCreate(CFAllocatorRef allocator, const UInt8 *bytes, CFIndex length);
CF_EXPORT
CFDataRef CFDataCreateWithBytesNoCopy(CFAllocatorRef allocator, const UInt8 *bytes, CFIndex length, CFAllocatorRef bytesDeallocator);
/* Pass kCFAllocatorNull as bytesDeallocator to assure the bytes aren't freed */
CF_EXPORT
CFDataRef CFDataCreateCopy(CFAllocatorRef allocator, CFDataRef theData);
CF_EXPORT
CFMutableDataRef CFDataCreateMutable(CFAllocatorRef allocator, CFIndex capacity);
CF_EXPORT
CFMutableDataRef CFDataCreateMutableCopy(CFAllocatorRef allocator, CFIndex capacity, CFDataRef theData);
CF_EXPORT
CFIndex CFDataGetLength(CFDataRef theData);
CF_EXPORT
const UInt8 *CFDataGetBytePtr(CFDataRef theData);
CF_EXPORT
UInt8 *CFDataGetMutableBytePtr(CFMutableDataRef theData);
CF_EXPORT
void CFDataGetBytes(CFDataRef theData, CFRange range, UInt8 *buffer);
CF_EXPORT
void CFDataSetLength(CFMutableDataRef theData, CFIndex length);
CF_EXPORT
void CFDataIncreaseLength(CFMutableDataRef theData, CFIndex extraLength);
CF_EXPORT
void CFDataAppendBytes(CFMutableDataRef theData, const UInt8 *bytes, CFIndex length);
CF_EXPORT
void CFDataReplaceBytes(CFMutableDataRef theData, CFRange range, const UInt8 *newBytes, CFIndex newLength);
CF_EXPORT
void CFDataDeleteBytes(CFMutableDataRef theData, CFRange range);
typedef CF_OPTIONS(CFOptionFlags, CFDataSearchFlags) {
kCFDataSearchBackwards = 1UL << 0,
kCFDataSearchAnchored = 1UL << 1
} API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
CF_EXPORT
CFRange CFDataFind(CFDataRef theData, CFDataRef dataToFind, CFRange searchRange, CFDataSearchFlags compareOptions) API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif /* ! __COREFOUNDATION_CFDATA__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFNumber.h | /* CFNumber.h
Copyright (c) 1999-2019, Apple Inc. and the Swift project authors
Portions Copyright (c) 2014-2019, Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See http://swift.org/LICENSE.txt for license information
See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
*/
#if !defined(__COREFOUNDATION_CFNUMBER__)
#define __COREFOUNDATION_CFNUMBER__ 1
#include <CoreFoundation/CFBase.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
typedef const struct CF_BRIDGED_TYPE(NSNumber) __CFBoolean * CFBooleanRef;
CF_EXPORT
const CFBooleanRef kCFBooleanTrue;
CF_EXPORT
const CFBooleanRef kCFBooleanFalse;
CF_EXPORT
CFTypeID CFBooleanGetTypeID(void);
CF_EXPORT
Boolean CFBooleanGetValue(CFBooleanRef boolean);
typedef CF_ENUM(CFIndex, CFNumberType) {
/* Fixed-width types */
kCFNumberSInt8Type = 1,
kCFNumberSInt16Type = 2,
kCFNumberSInt32Type = 3,
kCFNumberSInt64Type = 4,
kCFNumberFloat32Type = 5,
kCFNumberFloat64Type = 6, /* 64-bit IEEE 754 */
/* Basic C types */
kCFNumberCharType = 7,
kCFNumberShortType = 8,
kCFNumberIntType = 9,
kCFNumberLongType = 10,
kCFNumberLongLongType = 11,
kCFNumberFloatType = 12,
kCFNumberDoubleType = 13,
/* Other */
kCFNumberCFIndexType = 14,
kCFNumberNSIntegerType API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)) = 15,
kCFNumberCGFloatType API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)) = 16,
kCFNumberMaxType = 16
};
typedef const struct CF_BRIDGED_TYPE(NSNumber) __CFNumber * CFNumberRef;
CF_EXPORT
const CFNumberRef kCFNumberPositiveInfinity;
CF_EXPORT
const CFNumberRef kCFNumberNegativeInfinity;
CF_EXPORT
const CFNumberRef kCFNumberNaN;
CF_EXPORT
CFTypeID CFNumberGetTypeID(void);
/*
Creates a CFNumber with the given value. The type of number pointed
to by the valuePtr is specified by type. If type is a floating point
type and the value represents one of the infinities or NaN, the
well-defined CFNumber for that value is returned. If either of
valuePtr or type is an invalid value, the result is undefined.
*/
CF_EXPORT
CFNumberRef CFNumberCreate(CFAllocatorRef allocator, CFNumberType theType, const void *valuePtr);
/*
Returns the storage format of the CFNumber's value. Note that
this is not necessarily the type provided in CFNumberCreate().
*/
CF_EXPORT
CFNumberType CFNumberGetType(CFNumberRef number);
/*
Returns the size in bytes of the type of the number.
*/
CF_EXPORT
CFIndex CFNumberGetByteSize(CFNumberRef number);
/*
Returns true if the type of the CFNumber's value is one of
the defined floating point types.
*/
CF_EXPORT
Boolean CFNumberIsFloatType(CFNumberRef number);
/*
Copies the CFNumber's value into the space pointed to by
valuePtr, as the specified type. If conversion needs to take
place, the conversion rules follow human expectation and not
C's promotion and truncation rules. If the conversion is
lossy, or the value is out of range, false is returned. Best
attempt at conversion will still be in *valuePtr.
*/
CF_EXPORT
Boolean CFNumberGetValue(CFNumberRef number, CFNumberType theType, void *valuePtr);
/*
Compares the two CFNumber instances. If conversion of the
types of the values is needed, the conversion and comparison
follow human expectations and not C's promotion and comparison
rules. Negative zero compares less than positive zero.
Positive infinity compares greater than everything except
itself, to which it compares equal. Negative infinity compares
less than everything except itself, to which it compares equal.
Unlike standard practice, if both numbers are NaN, then they
compare equal; if only one of the numbers is NaN, then the NaN
compares greater than the other number if it is negative, and
smaller than the other number if it is positive. (Note that in
CFEqual() with two CFNumbers, if either or both of the numbers
is NaN, true is returned.)
*/
CF_EXPORT
CFComparisonResult CFNumberCompare(CFNumberRef number, CFNumberRef otherNumber, void *context);
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif /* ! __COREFOUNDATION_CFNUMBER__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFXMLParser.h | /* CFXMLParser.h
Copyright (c) 1998-2019, Apple Inc. All rights reserved.
*/
/* CFXMLParser is deprecated as of Mac OS X 10.8. The suggested replacements are the Foundation classes NSXMLParser and NSXMLDocument, or the libxml2 library. */
#include <TargetConditionals.h>
#if TARGET_OS_OSX
#if !defined(__COREFOUNDATION_CFXMLPARSER__)
#define __COREFOUNDATION_CFXMLPARSER__ 1
#include <CoreFoundation/CFBase.h>
#include <CoreFoundation/CFArray.h>
#include <CoreFoundation/CFData.h>
#include <CoreFoundation/CFDictionary.h>
#include <CoreFoundation/CFTree.h>
#include <CoreFoundation/CFURL.h>
#include <CoreFoundation/CFXMLNode.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
#define __CFXMLParser_DEPRECATION_MSG "CFXMLParser is deprecated, use NSXMLParser, NSXMLDocument or libxml2 library instead"
typedef struct __CFXMLParser * CFXMLParserRef;
/* These are the various options you can configure the parser with. These are
chosen such that an option flag of 0 (kCFXMLParserNoOptions) leaves the XML
as "intact" as possible (reports all structures; performs no replacements).
Hence, to make the parser do the most work, returning only the pure element
tree, set the option flag to kCFXMLParserAllOptions.
kCFXMLParserValidateDocument -
validate the document against its grammar from the DTD, reporting any errors.
Currently not supported.
kCFXMLParserSkipMetaData -
silently skip over metadata constructs (the DTD and comments)
kCFXMLParserReplacePhysicalEntities -
replace declared entities like <. Note that other than the 5 predefined
entities (lt, gt, quot, amp, apos), these must be defined in the DTD.
Currently not supported.
kCFXMLParserSkipWhitespace -
skip over all whitespace that does not abut non-whitespace character data.
In other words, given <foo> <bar> blah </bar></foo>, the whitespace between
foo's open tag and bar's open tag would be suppressed, but the whitespace
around blah would be preserved.
kCFXMLParserAddImpliedAttributes -
where the DTD specifies implied attribute-value pairs for a particular element,
add those pairs to any occurrences of the element in the element tree.
Currently not supported.
*/
typedef CF_OPTIONS(CFOptionFlags, CFXMLParserOptions) {
kCFXMLParserValidateDocument = (1UL << 0),
kCFXMLParserSkipMetaData = (1UL << 1),
kCFXMLParserReplacePhysicalEntities = (1UL << 2),
kCFXMLParserSkipWhitespace = (1UL << 3),
kCFXMLParserResolveExternalEntities = (1UL << 4),
kCFXMLParserAddImpliedAttributes = (1UL << 5),
kCFXMLParserAllOptions = 0x00FFFFFF,
kCFXMLParserNoOptions = 0
};
/* This list is expected to grow */
typedef CF_OPTIONS(CFIndex, CFXMLParserStatusCode) {
kCFXMLStatusParseNotBegun = -2,
kCFXMLStatusParseInProgress = -1,
kCFXMLStatusParseSuccessful = 0,
kCFXMLErrorUnexpectedEOF = 1,
kCFXMLErrorUnknownEncoding,
kCFXMLErrorEncodingConversionFailure,
kCFXMLErrorMalformedProcessingInstruction,
kCFXMLErrorMalformedDTD,
kCFXMLErrorMalformedName,
kCFXMLErrorMalformedCDSect,
kCFXMLErrorMalformedCloseTag,
kCFXMLErrorMalformedStartTag,
kCFXMLErrorMalformedDocument,
kCFXMLErrorElementlessDocument,
kCFXMLErrorMalformedComment,
kCFXMLErrorMalformedCharacterReference,
kCFXMLErrorMalformedParsedCharacterData,
kCFXMLErrorNoData
};
/* These functions are called as a parse progresses.
createXMLStructure -
called as new XML structures are encountered by the parser. May return NULL to indicate
that the given structure should be skipped; if NULL is returned for a given structure,
only minimal parsing is done for that structure (enough to correctly determine its end,
and to extract any data necessary for the remainder of the parse, such as Entity definitions).
createXMLStructure (or indeed, any of the tree-creation callbacks) will not be called for any
children of the skipped structure. The only exception is that the top-most element will always
be reported even if NULL was returned for the document as a whole. NOTE: for performance reasons,
the node passed to createXMLStructure cannot be safely retained by the client; the node as
a whole must be copied (via CFXMLNodeCreateCopy), or its contents must be extracted and copied.
addChild -
called as children are parsed and are ready to be added to the tree. If createXMLStructure
returns NULL for a given structure, that structure is omitted entirely, and addChild will
NOT be called for either a NULL child or parent.
endXMLStructure -
called once a structure (and all its children) are completely parsed. As elements are encountered,
createXMLStructure is called for them first, then addChild to add the new structure to its parent,
then addChild (potentially several times) to add the new structure's children to it, then finally
endXMLStructure to show that the structure has been fully parsed.
createXMLStructure, addChild, and endXMLStructure are all REQUIRED TO BE NON-NULL.
resolveExternalEntity -
called when external entities are referenced (NOT when they are simply defined). If the function
pointer is NULL, the parser uses its internal routines to try and resolve the entity. If the
function pointer is set, and the function returns NULL, a place holder for the external entity
is inserted into the tree. In this manner, the parser's client can prevent any external network
or file accesses.
handleError - called as errors/warnings are encountered in the data stream. At some point, we will
have an enum of the expected errors, some of which will be fatal, others of which will not. If
the function pointer is NULL, the parser will silently attempt to recover. The
handleError function may always return false to force the parser to stop; if handleError returns
true, the parser will attempt to recover (fatal errors will still cause the parse to abort
immediately).
*/
typedef void * (*CFXMLParserCreateXMLStructureCallBack)(CFXMLParserRef parser, CFXMLNodeRef nodeDesc, void *info);
typedef void (*CFXMLParserAddChildCallBack)(CFXMLParserRef parser, void *parent, void *child, void *info);
typedef void (*CFXMLParserEndXMLStructureCallBack)(CFXMLParserRef parser, void *xmlType, void *info);
typedef CFDataRef (*CFXMLParserResolveExternalEntityCallBack)(CFXMLParserRef parser, CFXMLExternalID *extID, void *info);
typedef Boolean (*CFXMLParserHandleErrorCallBack)(CFXMLParserRef parser, CFXMLParserStatusCode error, void *info);
typedef struct {
CFIndex version;
CFXMLParserCreateXMLStructureCallBack createXMLStructure;
CFXMLParserAddChildCallBack addChild;
CFXMLParserEndXMLStructureCallBack endXMLStructure;
CFXMLParserResolveExternalEntityCallBack resolveExternalEntity;
CFXMLParserHandleErrorCallBack handleError;
} CFXMLParserCallBacks;
typedef const void * (*CFXMLParserRetainCallBack)(const void *info);
typedef void (*CFXMLParserReleaseCallBack)(const void *info);
typedef CFStringRef (*CFXMLParserCopyDescriptionCallBack)(const void *info);
typedef struct {
CFIndex version;
void * info;
CFXMLParserRetainCallBack retain;
CFXMLParserReleaseCallBack release;
CFXMLParserCopyDescriptionCallBack copyDescription;
} CFXMLParserContext;
CF_EXPORT
CFTypeID CFXMLParserGetTypeID(void) API_DEPRECATED(__CFXMLParser_DEPRECATION_MSG, macos(10.0,10.8), ios(2.0,6.0), watchos(2.0,2.0), tvos(9.0,9.0));
/* Creates a parser which will parse the given data with the given options. xmlData may not be NULL.
dataSource should be the URL from which the data came, and may be NULL; it is used to resolve any
relative references found in xmlData. versionOfNodes determines which version CFXMLNodes are produced
by the parser; see CFXMLNode.h for more details. callBacks are the callbacks called by the parser as
the parse progresses; callBacks, callBacks->createXMLStructure, callBacks->addChild, and
callBacks->endXMLStructure must all be non-NULL. context determines what if any info pointer is
passed to the callbacks as the parse progresses; context may be NULL. */
CF_EXPORT
CFXMLParserRef CFXMLParserCreate(CFAllocatorRef allocator, CFDataRef xmlData, CFURLRef dataSource, CFOptionFlags parseOptions, CFIndex versionOfNodes, CFXMLParserCallBacks *callBacks, CFXMLParserContext *context) API_DEPRECATED(__CFXMLParser_DEPRECATION_MSG, macos(10.0,10.8), ios(2.0,6.0), watchos(2.0,2.0), tvos(9.0,9.0));
/* Arguments as above, except that the data to be parsed is loaded directly
from dataSource. dataSource may not be NULL. */
CF_EXPORT
CFXMLParserRef CFXMLParserCreateWithDataFromURL(CFAllocatorRef allocator, CFURLRef dataSource, CFOptionFlags parseOptions, CFIndex versionOfNodes, CFXMLParserCallBacks *callBacks, CFXMLParserContext *context) API_DEPRECATED(__CFXMLParser_DEPRECATION_MSG, macos(10.0,10.8), ios(2.0,6.0), watchos(2.0,2.0), tvos(9.0,9.0));
CF_EXPORT
void CFXMLParserGetContext(CFXMLParserRef parser, CFXMLParserContext *context) API_DEPRECATED(__CFXMLParser_DEPRECATION_MSG, macos(10.0,10.8), ios(2.0,6.0), watchos(2.0,2.0), tvos(9.0,9.0));
CF_EXPORT
void CFXMLParserGetCallBacks(CFXMLParserRef parser, CFXMLParserCallBacks *callBacks) API_DEPRECATED(__CFXMLParser_DEPRECATION_MSG, macos(10.0,10.8), ios(2.0,6.0), watchos(2.0,2.0), tvos(9.0,9.0));
CF_EXPORT
CFURLRef CFXMLParserGetSourceURL(CFXMLParserRef parser) API_DEPRECATED(__CFXMLParser_DEPRECATION_MSG, macos(10.0,10.8), ios(2.0,6.0), watchos(2.0,2.0), tvos(9.0,9.0));
/* Returns the character index of the current parse location */
CF_EXPORT
CFIndex CFXMLParserGetLocation(CFXMLParserRef parser) API_DEPRECATED(__CFXMLParser_DEPRECATION_MSG, macos(10.0,10.8), ios(2.0,6.0), watchos(2.0,2.0), tvos(9.0,9.0));
/* Returns the line number of the current parse location */
CF_EXPORT
CFIndex CFXMLParserGetLineNumber(CFXMLParserRef parser) API_DEPRECATED(__CFXMLParser_DEPRECATION_MSG, macos(10.0,10.8), ios(2.0,6.0), watchos(2.0,2.0), tvos(9.0,9.0));
/* Returns the top-most object returned by the createXMLStructure callback */
CF_EXPORT
void *CFXMLParserGetDocument(CFXMLParserRef parser) API_DEPRECATED(__CFXMLParser_DEPRECATION_MSG, macos(10.0,10.8), ios(2.0,6.0), watchos(2.0,2.0), tvos(9.0,9.0));
/* Get the status code or a user-readable description of the last error that occurred in a parse.
If no error has occurred, a null description string is returned. See the enum above for
possible status returns */
CF_EXPORT
CFXMLParserStatusCode CFXMLParserGetStatusCode(CFXMLParserRef parser) API_DEPRECATED(__CFXMLParser_DEPRECATION_MSG, macos(10.0,10.8), ios(2.0,6.0), watchos(2.0,2.0), tvos(9.0,9.0));
CF_EXPORT
CFStringRef CFXMLParserCopyErrorDescription(CFXMLParserRef parser) API_DEPRECATED(__CFXMLParser_DEPRECATION_MSG, macos(10.0,10.8), ios(2.0,6.0), watchos(2.0,2.0), tvos(9.0,9.0));
/* Cause any in-progress parse to abort with the given error code and description. errorCode
must be positive, and errorDescription may not be NULL. Cannot be called asynchronously
(i.e. must be called from within a parser callback) */
CF_EXPORT
void CFXMLParserAbort(CFXMLParserRef parser, CFXMLParserStatusCode errorCode, CFStringRef errorDescription) API_DEPRECATED(__CFXMLParser_DEPRECATION_MSG, macos(10.0,10.8), ios(2.0,6.0), watchos(2.0,2.0), tvos(9.0,9.0));
/* Starts a parse of the data the parser was created with; returns success or failure.
Upon success, use CFXMLParserGetDocument() to get the product of the parse. Upon
failure, use CFXMLParserGetErrorCode() or CFXMLParserCopyErrorDescription() to get
information about the error. It is an error to call CFXMLParserParse() while a
parse is already underway. */
CF_EXPORT
Boolean CFXMLParserParse(CFXMLParserRef parser) API_DEPRECATED(__CFXMLParser_DEPRECATION_MSG, macos(10.0,10.8), ios(2.0,6.0), watchos(2.0,2.0), tvos(9.0,9.0));
/* These functions provide a higher-level interface. The XML data is parsed to a
special CFTree (an CFXMLTree) with known contexts and callbacks. See CFXMLNode.h
for full details on using an CFXMLTree and the CFXMLNodes contained therein.
*/
/* Parse to an CFXMLTreeRef. parseOptions are as above. versionOfNodes determines
what version CFXMLNodes are used to populate the tree. */
CF_EXPORT
CFXMLTreeRef CFXMLTreeCreateFromData(CFAllocatorRef allocator, CFDataRef xmlData, CFURLRef dataSource, CFOptionFlags parseOptions, CFIndex versionOfNodes) API_DEPRECATED(__CFXMLParser_DEPRECATION_MSG, macos(10.0,10.8), ios(2.0,6.0), watchos(2.0,2.0), tvos(9.0,9.0));
/* As above, with the additional by-reference pass of a CFDictionaryRef containing
various error information (see below). The caller is responsible for releasing the
returned dictionary. If the error dictionary is not desired, pass NULL. */
CF_EXPORT
CFXMLTreeRef CFXMLTreeCreateFromDataWithError(CFAllocatorRef allocator, CFDataRef xmlData, CFURLRef dataSource, CFOptionFlags parseOptions, CFIndex versionOfNodes, CFDictionaryRef *errorDict) API_DEPRECATED(__CFXMLParser_DEPRECATION_MSG, macos(10.0,10.8), ios(2.0,6.0), watchos(2.0,2.0), tvos(9.0,9.0));
/* Loads the data to be parsed directly from dataSource. Arguments as above. */
CF_EXPORT
CFXMLTreeRef CFXMLTreeCreateWithDataFromURL(CFAllocatorRef allocator, CFURLRef dataSource, CFOptionFlags parseOptions, CFIndex versionOfNodes) API_DEPRECATED(__CFXMLParser_DEPRECATION_MSG, macos(10.0,10.8), ios(2.0,6.0), watchos(2.0,2.0), tvos(9.0,9.0));
/* Generate the XMLData (ready to be written to whatever permanent storage is to be
used) from an CFXMLTree. Will NOT regenerate entity references (except those
required for syntactic correctness) if they were replaced at the parse time;
clients that wish this should walk the tree and re-insert any entity references
that should appear in the final output file. */
CF_EXPORT
CFDataRef CFXMLTreeCreateXMLData(CFAllocatorRef allocator, CFXMLTreeRef xmlTree) API_DEPRECATED(__CFXMLParser_DEPRECATION_MSG, macos(10.0,10.8), ios(2.0,6.0), watchos(2.0,2.0), tvos(9.0,9.0));
/* Escaping and unescaping XML entities in CFStrings. The standard XML entities
are always replaced. */
/* Creates a CFString by replacing entities that appear in the entities dictionary.
Dictionary keys are the entities themselves, and the values should be CFStrings
containing the expansion. Pass NULL for entitiesDictionary to indicate no entities
other than the standard five. */
CF_EXPORT
CFStringRef CFXMLCreateStringByEscapingEntities(CFAllocatorRef allocator, CFStringRef string, CFDictionaryRef entitiesDictionary);
CF_EXPORT
CFStringRef CFXMLCreateStringByUnescapingEntities(CFAllocatorRef allocator, CFStringRef string, CFDictionaryRef entitiesDictionary);
/* CFXMLTreeCreateFromDataWithError error dictionary key constants. */
CF_EXPORT const CFStringRef kCFXMLTreeErrorDescription;
/* value is a CFString containing the readable error string. */
CF_EXPORT const CFStringRef kCFXMLTreeErrorLineNumber;
/* value is a CFNumber containing the line on which the error appears. */
CF_EXPORT const CFStringRef kCFXMLTreeErrorLocation;
/* value is a CFNumber containing the byte location at which the error occurred. */
CF_EXPORT const CFStringRef kCFXMLTreeErrorStatusCode;
/* value is a CFNumber containing the error status code. */
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#undef __CFXMLParser_DEPRECATION_MSG
#endif /* ! __COREFOUNDATION_CFXMLPARSER__ */
#endif /* TARGET_OS_OSX */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CoreFoundation.h | /* CoreFoundation.h
Copyright (c) 1998-2019, Apple Inc. and the Swift project authors
Portions Copyright (c) 2014-2019, Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See http://swift.org/LICENSE.txt for license information
See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
*/
#if !defined(__COREFOUNDATION_COREFOUNDATION__)
#define __COREFOUNDATION_COREFOUNDATION__ 1
#define __COREFOUNDATION__ 1
#if !defined(CF_EXCLUDE_CSTD_HEADERS)
#include <sys/types.h>
#include <stdarg.h>
#include <assert.h>
#include <ctype.h>
#include <errno.h>
#include <float.h>
#include <limits.h>
#include <locale.h>
#include <math.h>
#include <setjmp.h>
#include <signal.h>
#include <stddef.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <time.h>
#if defined(__STDC_VERSION__) && (199901L <= __STDC_VERSION__)
#include <inttypes.h>
#include <stdbool.h>
#include <stdint.h>
#endif
#endif
#include <CoreFoundation/CFBase.h>
#include <CoreFoundation/CFArray.h>
#include <CoreFoundation/CFBag.h>
#include <CoreFoundation/CFBinaryHeap.h>
#include <CoreFoundation/CFBitVector.h>
#include <CoreFoundation/CFByteOrder.h>
#include <CoreFoundation/CFCalendar.h>
#include <CoreFoundation/CFCharacterSet.h>
#include <CoreFoundation/CFData.h>
#include <CoreFoundation/CFDate.h>
#include <CoreFoundation/CFDateFormatter.h>
#include <CoreFoundation/CFDictionary.h>
#include <CoreFoundation/CFError.h>
#include <CoreFoundation/CFLocale.h>
#include <CoreFoundation/CFNumber.h>
#include <CoreFoundation/CFNumberFormatter.h>
#include <CoreFoundation/CFPreferences.h>
#include <CoreFoundation/CFPropertyList.h>
#include <CoreFoundation/CFSet.h>
#include <CoreFoundation/CFString.h>
#include <CoreFoundation/CFStringEncodingExt.h>
#include <CoreFoundation/CFTimeZone.h>
#include <CoreFoundation/CFTree.h>
#include <CoreFoundation/CFURL.h>
#include <CoreFoundation/CFURLAccess.h>
#include <CoreFoundation/CFUUID.h>
#include <CoreFoundation/CFUtilities.h>
#include <CoreFoundation/CFBundle.h>
#if TARGET_OS_OSX || TARGET_OS_IPHONE || TARGET_OS_WIN32
#include <CoreFoundation/CFMessagePort.h>
#include <CoreFoundation/CFPlugIn.h>
#include <CoreFoundation/CFRunLoop.h>
#include <CoreFoundation/CFStream.h>
#include <CoreFoundation/CFSocket.h>
#include <CoreFoundation/CFMachPort.h>
#include <CoreFoundation/CFAttributedString.h>
#include <CoreFoundation/CFNotificationCenter.h>
#ifndef CF_OPEN_SOURCE
#include <CoreFoundation/CFURLEnumerator.h>
#endif
#endif
#if TARGET_OS_OSX || TARGET_OS_IPHONE
#ifndef CF_OPEN_SOURCE
#include <CoreFoundation/CFFileSecurity.h>
#include <CoreFoundation/CFStringTokenizer.h>
#include <CoreFoundation/CFFileDescriptor.h>
#endif
#endif
#include <CoreFoundation/CFUserNotification.h>
#include <CoreFoundation/CFXMLNode.h>
#include <CoreFoundation/CFXMLParser.h>
#endif /* ! __COREFOUNDATION_COREFOUNDATION__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFTree.h | /* CFTree.h
Copyright (c) 1998-2019, Apple Inc. and the Swift project authors
Portions Copyright (c) 2014-2019, Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See http://swift.org/LICENSE.txt for license information
See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
*/
/*!
@header CFTree
CFTree implements a container which stores references to other CFTrees.
Each tree may have a parent, and a variable number of children.
*/
#if !defined(__COREFOUNDATION_CFTREE__)
#define __COREFOUNDATION_CFTREE__ 1
#include <CoreFoundation/CFBase.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
/*!
@typedef CFTreeRetainCallBack
Type of the callback function used to add a retain to the user-specified
info parameter. This callback may returns the value to use whenever the
info parameter is retained, which is usually the value parameter passed
to this callback, but may be a different value if a different value
should be used.
@param info A user-supplied info parameter provided in a CFTreeContext.
@result The retained info parameter.
*/
typedef const void * (*CFTreeRetainCallBack)(const void *info);
/*!
@typedef CFTreeReleaseCallBack
Type of the callback function used to remove a retain previously
added to the user-specified info parameter.
@param info A user-supplied info parameter provided in a CFTreeContext.
*/
typedef void (*CFTreeReleaseCallBack)(const void *info);
/*!
@typedef CFTreeCopyDescriptionCallBack
Type of the callback function used to provide a description of the
user-specified info parameter.
@param info A user-supplied info parameter provided in a CFTreeContext.
@result A description of the info parameter.
*/
typedef CFStringRef (*CFTreeCopyDescriptionCallBack)(const void *info);
/*!
@typedef CFTreeContext
Structure containing user-specified data and callbacks for a CFTree.
@field version The version number of the structure type being passed
in as a parameter to the CFTree creation function.
This structure is version 0.
@field info A C pointer to a user-specified block of data.
@field retain The callback used to add a retain for the info field.
If this parameter is not a pointer to a function of the correct
prototype, the behavior is undefined. The value may be NULL.
@field release The calllback used to remove a retain previously added
for the info field. If this parameter is not a pointer to a
function of the correct prototype, the behavior is undefined.
The value may be NULL.
@field copyDescription The callback used to provide a description of
the info field.
*/
typedef struct {
CFIndex version;
void * info;
CFTreeRetainCallBack retain;
CFTreeReleaseCallBack release;
CFTreeCopyDescriptionCallBack copyDescription;
} CFTreeContext;
/*!
@typedef CFTreeApplierFunction
Type of the callback function used by the apply functions of
CFTree.
@param value The current value from the CFTree
@param context The user-defined context parameter give to the apply
function.
*/
typedef void (*CFTreeApplierFunction)(const void *value, void *context);
/*!
@typedef CFTreeRef
This is the type of a reference to CFTrees.
*/
typedef struct CF_BRIDGED_MUTABLE_TYPE(id) __CFTree * CFTreeRef;
/*!
@function CFTreeGetTypeID
Returns the type identifier of all CFTree instances.
*/
CF_EXPORT
CFTypeID CFTreeGetTypeID(void);
/*!
@function CFTreeCreate
Creates a new mutable tree.
@param allocator The CFAllocator which should be used to allocate
memory for the tree and storage for its children. This
parameter may be NULL in which case the current default
CFAllocator is used. If this reference is not a valid
CFAllocator, the behavior is undefined.
@param context A C pointer to a CFTreeContext structure to be copied
and used as the context of the new tree. The info parameter
will be retained by the tree if a retain function is provided.
If this value is not a valid C pointer to a CFTreeContext
structure-sized block of storage, the result is undefined.
If the version number of the storage is not a valid CFTreeContext
version number, the result is undefined.
@result A reference to the new CFTree.
*/
CF_EXPORT
CFTreeRef CFTreeCreate(CFAllocatorRef allocator, const CFTreeContext *context);
/*!
@function CFTreeGetParent
Returns the parent of the specified tree.
@param tree The tree to be queried. If this parameter is not a valid
CFTree, the behavior is undefined.
@result The parent of the tree.
*/
CF_EXPORT
CFTreeRef CFTreeGetParent(CFTreeRef tree);
/*!
@function CFTreeGetNextSibling
Returns the sibling after the specified tree in the parent tree's list.
@param tree The tree to be queried. If this parameter is not a valid
CFTree, the behavior is undefined.
@result The next sibling of the tree.
*/
CF_EXPORT
CFTreeRef CFTreeGetNextSibling(CFTreeRef tree);
/*!
@function CFTreeGetFirstChild
Returns the first child of the tree.
@param tree The tree to be queried. If this parameter is not a valid
CFTree, the behavior is undefined.
@result The first child of the tree.
*/
CF_EXPORT
CFTreeRef CFTreeGetFirstChild(CFTreeRef tree);
/*!
@function CFTreeGetContext
Returns the context of the specified tree.
@param tree The tree to be queried. If this parameter is not a valid
CFTree, the behavior is undefined.
@param context A C pointer to a CFTreeContext structure to be filled in with
the context of the specified tree. If this value is not a valid C
pointer to a CFTreeContext structure-sized block of storage, the
result is undefined. If the version number of the storage is not
a valid CFTreeContext version number, the result is undefined.
*/
CF_EXPORT
void CFTreeGetContext(CFTreeRef tree, CFTreeContext *context);
/*!
@function CFTreeGetChildCount
Returns the number of children of the specified tree.
@param tree The tree to be queried. If this parameter is not a valid
CFTree, the behavior is undefined.
@result The number of children.
*/
CF_EXPORT
CFIndex CFTreeGetChildCount(CFTreeRef tree);
/*!
@function CFTreeGetChildAtIndex
Returns the nth child of the specified tree.
@param tree The tree to be queried. If this parameter is not a valid
CFTree, the behavior is undefined.
@param idx The index of the child tree to be returned. If this parameter
is less than zero or greater than the number of children of the
tree, the result is undefined.
@result A reference to the specified child tree.
*/
CF_EXPORT
CFTreeRef CFTreeGetChildAtIndex(CFTreeRef tree, CFIndex idx);
/*!
@function CFTreeGetChildren
Fills the buffer with children from the tree.
@param tree The tree to be queried. If this parameter is not a valid
CFTree, the behavior is undefined.
@param children A C array of pointer-sized values to be filled with
children from the tree. If this parameter is not a valid pointer to a
C array of at least CFTreeGetChildCount() pointers, the behavior is undefined.
*/
CF_EXPORT
void CFTreeGetChildren(CFTreeRef tree, CFTreeRef *children);
/*!
@function CFTreeApplyFunctionToChildren
Calls a function once for each child of the tree. Note that the applier
only operates one level deep, and does not operate on descendents further
removed than the immediate children of the tree.
@param tree The tree to be operated upon. If this parameter is not a
valid CFTree, the behavior is undefined.
@param applier The callback function to call once for each child of
the given tree. If this parameter is not a pointer to a
function of the correct prototype, the behavior is undefined.
If there are values in the tree which the applier function does
not expect or cannot properly apply to, the behavior is undefined.
@param context A pointer-sized user-defined value, which is passed
as the second parameter to the applier function, but is
otherwise unused by this function. If the context is not
what is expected by the applier function, the behavior is
undefined.
*/
CF_EXPORT
void CFTreeApplyFunctionToChildren(CFTreeRef tree, CFTreeApplierFunction CF_NOESCAPE applier, void *context);
/*!
@function CFTreeFindRoot
Returns the root tree of which the specified tree is a descendent.
@param tree The tree to be queried. If this parameter is not a valid
CFTree, the behavior is undefined.
@result A reference to the root of the tree.
*/
CF_EXPORT
CFTreeRef CFTreeFindRoot(CFTreeRef tree);
/*!
@function CFTreeSetContext
Replaces the context of a tree. The tree releases its retain on the
info of the previous context, and retains the info of the new context.
@param tree The tree to be operated on. If this parameter is not a valid
CFTree, the behavior is undefined.
@param context A C pointer to a CFTreeContext structure to be copied
and used as the context of the new tree. The info parameter
will be retained by the tree if a retain function is provided.
If this value is not a valid C pointer to a CFTreeContext
structure-sized block of storage, the result is undefined.
If the version number of the storage is not a valid CFTreeContext
version number, the result is undefined.
*/
CF_EXPORT
void CFTreeSetContext(CFTreeRef tree, const CFTreeContext *context);
/*!
@function CFTreePrependChild
Adds the newChild to the specified tree as the first in its list of children.
@param tree The tree to be operated on. If this parameter is not a valid
CFTree, the behavior is undefined.
@param newChild The child to be added.
If this parameter is not a valid CFTree, the behavior is undefined.
If this parameter is a tree which is already a child of any tree,
the behavior is undefined.
*/
CF_EXPORT
void CFTreePrependChild(CFTreeRef tree, CFTreeRef newChild);
/*!
@function CFTreeAppendChild
Adds the newChild to the specified tree as the last in its list of children.
@param tree The tree to be operated on. If this parameter is not a valid
CFTree, the behavior is undefined.
@param newChild The child to be added.
If this parameter is not a valid CFTree, the behavior is undefined.
If this parameter is a tree which is already a child of any tree,
the behavior is undefined.
*/
CF_EXPORT
void CFTreeAppendChild(CFTreeRef tree, CFTreeRef newChild);
/*!
@function CFTreeInsertSibling
Inserts newSibling into the the parent tree's linked list of children after
tree. The newSibling will have the same parent as tree.
@param tree The tree to insert newSibling after. If this parameter is not a valid
CFTree, the behavior is undefined. If the tree does not have a
parent, the behavior is undefined.
@param newSibling The sibling to be added.
If this parameter is not a valid CFTree, the behavior is undefined.
If this parameter is a tree which is already a child of any tree,
the behavior is undefined.
*/
CF_EXPORT
void CFTreeInsertSibling(CFTreeRef tree, CFTreeRef newSibling);
/*!
@function CFTreeRemove
Removes the tree from its parent.
@param tree The tree to be removed. If this parameter is not a valid
CFTree, the behavior is undefined.
*/
CF_EXPORT
void CFTreeRemove(CFTreeRef tree);
/*!
@function CFTreeRemoveAllChildren
Removes all the children of the tree.
@param tree The tree to remove all children from. If this parameter is not a valid
CFTree, the behavior is undefined.
*/
CF_EXPORT
void CFTreeRemoveAllChildren(CFTreeRef tree);
/*!
@function CFTreeSortChildren
Sorts the children of the specified tree using the specified comparator function.
@param tree The tree to be operated on. If this parameter is not a valid
CFTree, the behavior is undefined.
@param comparator The function with the comparator function type
signature which is used in the sort operation to compare
children of the tree with the given value. If this parameter
is not a pointer to a function of the correct prototype, the
the behavior is undefined. The children of the tree are sorted
from least to greatest according to this function.
@param context A pointer-sized user-defined value, which is passed
as the third parameter to the comparator function, but is
otherwise unused by this function. If the context is not
what is expected by the comparator function, the behavior is
undefined.
*/
CF_EXPORT
void CFTreeSortChildren(CFTreeRef tree, CFComparatorFunction comparator, void *context);
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif /* ! __COREFOUNDATION_CFTREE__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFSocket.h | /* CFSocket.h
Copyright (c) 1999-2019, Apple Inc. and the Swift project authors
Portions Copyright (c) 2014-2019, Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See http://swift.org/LICENSE.txt for license information
See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
*/
#if !defined(__COREFOUNDATION_CFSOCKET__)
#define __COREFOUNDATION_CFSOCKET__ 1
#include <CoreFoundation/CFRunLoop.h>
#include <CoreFoundation/CFData.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
typedef struct CF_BRIDGED_MUTABLE_TYPE(id) __CFSocket * CFSocketRef;
/* A CFSocket contains a native socket within a structure that can
be used to read from the socket in the background and make the data
thus read available using a runloop source. The callback used for
this may be of three types, as specified by the callBackTypes
argument when creating the CFSocket.
If kCFSocketReadCallBack is used, then data will not be
automatically read, but the callback will be called when data
is available to be read, or a new child socket is waiting to be
accepted.
If kCFSocketAcceptCallBack is used, then new child sockets will be
accepted and passed to the callback, with the data argument being
a pointer to a CFSocketNativeHandle. This is usable only with
connection rendezvous sockets.
If kCFSocketDataCallBack is used, then data will be read in chunks
in the background and passed to the callback, with the data argument
being a CFDataRef.
These three types are mutually exclusive, but any one of them may
have kCFSocketConnectCallBack added to it, if the socket will be
used to connect in the background. Connect in the background occurs
if CFSocketConnectToAddress is called with a negative timeout
value, in which case the call returns immediately, and a
kCFSocketConnectCallBack is generated when the connect finishes.
In this case the data argument is either NULL, or a pointer to
an SInt32 error code if the connect failed. kCFSocketConnectCallBack
will never be sent more than once for a given socket.
The callback types may also have kCFSocketWriteCallBack added to
them, if large amounts of data are to be sent rapidly over the
socket and notification is desired when there is space in the
kernel buffers so that the socket is writable again.
With a connection-oriented socket, if the connection is broken from the
other end, then one final kCFSocketReadCallBack or kCFSocketDataCallBack
will occur. In the case of kCFSocketReadCallBack, the underlying socket
will have 0 bytes available to read. In the case of kCFSocketDataCallBack,
the data argument will be a CFDataRef of length 0.
There are socket flags that may be set to control whether callbacks of
a given type are automatically reenabled after they are triggered, and
whether the underlying native socket will be closed when the CFSocket
is invalidated. By default read, accept, and data callbacks are
automatically reenabled; write callbacks are not, and connect callbacks
may not be, since they are sent once only. Be careful about automatically
reenabling read and write callbacks, since this implies that the
callbacks will be sent repeatedly if the socket remains readable or
writable respectively. Be sure to set these flags only for callbacks
that your CFSocket actually possesses; the result of setting them for
other callback types is undefined.
Individual callbacks may also be enabled and disabled manually, whether
they are automatically reenabled or not. If they are not automatically
reenabled, then they will need to be manually reenabled when the callback
is ready to be received again (and not sooner). Even if they are
automatically reenabled, there may be occasions when it will be useful
to be able to manually disable them temporarily and then reenable them.
Be sure to enable and disable only callbacks that your CFSocket actually
possesses; the result of enabling and disabling other callback types is
undefined.
By default the underlying native socket will be closed when the CFSocket
is invalidated, but it will not be if kCFSocketCloseOnInvalidate is
turned off. This can be useful in order to destroy a CFSocket but
continue to use the underlying native socket. The CFSocket must
still be invalidated when it will no longer be used. Do not in
either case close the underlying native socket without invalidating
the CFSocket.
Addresses are stored as CFDatas containing a struct sockaddr
appropriate for the protocol family; make sure that all fields are
filled in properly when passing in an address.
*/
/* Values for CFSocketError */
typedef CF_ENUM(CFIndex, CFSocketError) {
kCFSocketSuccess = 0,
kCFSocketError = -1L,
kCFSocketTimeout = -2L
};
typedef struct {
SInt32 protocolFamily;
SInt32 socketType;
SInt32 protocol;
CFDataRef address;
} CFSocketSignature;
/* Values for CFSocketCallBackType */
typedef CF_OPTIONS(CFOptionFlags, CFSocketCallBackType) {
kCFSocketNoCallBack = 0,
kCFSocketReadCallBack = 1,
kCFSocketAcceptCallBack = 2,
kCFSocketDataCallBack = 3,
kCFSocketConnectCallBack = 4,
kCFSocketWriteCallBack = 8
};
/* Socket flags */
CF_ENUM(CFOptionFlags) {
kCFSocketAutomaticallyReenableReadCallBack = 1,
kCFSocketAutomaticallyReenableAcceptCallBack = 2,
kCFSocketAutomaticallyReenableDataCallBack = 3,
kCFSocketAutomaticallyReenableWriteCallBack = 8,
kCFSocketLeaveErrors API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)) = 64,
kCFSocketCloseOnInvalidate = 128
};
typedef void (*CFSocketCallBack)(CFSocketRef s, CFSocketCallBackType type, CFDataRef address, const void *data, void *info);
/* If the callback wishes to keep hold of address or data after the point that it returns, then it must copy them. */
typedef struct {
CFIndex version;
void * info;
const void *(*retain)(const void *info);
void (*release)(const void *info);
CFStringRef (*copyDescription)(const void *info);
} CFSocketContext;
#if TARGET_OS_WIN32
typedef uintptr_t CFSocketNativeHandle;
#else
typedef int CFSocketNativeHandle;
#endif
CF_EXPORT CFTypeID CFSocketGetTypeID(void);
CF_EXPORT CFSocketRef CFSocketCreate(CFAllocatorRef allocator, SInt32 protocolFamily, SInt32 socketType, SInt32 protocol, CFOptionFlags callBackTypes, CFSocketCallBack callout, const CFSocketContext *context);
CF_EXPORT CFSocketRef CFSocketCreateWithNative(CFAllocatorRef allocator, CFSocketNativeHandle sock, CFOptionFlags callBackTypes, CFSocketCallBack callout, const CFSocketContext *context);
CF_EXPORT CFSocketRef CFSocketCreateWithSocketSignature(CFAllocatorRef allocator, const CFSocketSignature *signature, CFOptionFlags callBackTypes, CFSocketCallBack callout, const CFSocketContext *context);
/* CFSocketCreateWithSocketSignature() creates a socket of the requested type and binds its address (using CFSocketSetAddress()) to the requested address. If this fails, it returns NULL. */
CF_EXPORT CFSocketRef CFSocketCreateConnectedToSocketSignature(CFAllocatorRef allocator, const CFSocketSignature *signature, CFOptionFlags callBackTypes, CFSocketCallBack callout, const CFSocketContext *context, CFTimeInterval timeout);
/* CFSocketCreateConnectedToSocketSignature() creates a socket suitable for connecting to the requested type and address, and connects it (using CFSocketConnectToAddress()). If this fails, it returns NULL. */
CF_EXPORT CFSocketError CFSocketSetAddress(CFSocketRef s, CFDataRef address);
CF_EXPORT CFSocketError CFSocketConnectToAddress(CFSocketRef s, CFDataRef address, CFTimeInterval timeout);
CF_EXPORT void CFSocketInvalidate(CFSocketRef s);
CF_EXPORT Boolean CFSocketIsValid(CFSocketRef s);
CF_EXPORT CFDataRef CFSocketCopyAddress(CFSocketRef s);
CF_EXPORT CFDataRef CFSocketCopyPeerAddress(CFSocketRef s);
CF_EXPORT void CFSocketGetContext(CFSocketRef s, CFSocketContext *context);
CF_EXPORT CFSocketNativeHandle CFSocketGetNative(CFSocketRef s);
CF_EXPORT CFRunLoopSourceRef CFSocketCreateRunLoopSource(CFAllocatorRef allocator, CFSocketRef s, CFIndex order);
CF_EXPORT CFOptionFlags CFSocketGetSocketFlags(CFSocketRef s);
CF_EXPORT void CFSocketSetSocketFlags(CFSocketRef s, CFOptionFlags flags);
CF_EXPORT void CFSocketDisableCallBacks(CFSocketRef s, CFOptionFlags callBackTypes);
CF_EXPORT void CFSocketEnableCallBacks(CFSocketRef s, CFOptionFlags callBackTypes);
/* For convenience, a function is provided to send data using the socket with a timeout. The timeout will be used only if the specified value is positive. The address should be left NULL if the socket is already connected. */
CF_EXPORT CFSocketError CFSocketSendData(CFSocketRef s, CFDataRef address, CFDataRef data, CFTimeInterval timeout);
/* Generic name registry functionality (CFSocketRegisterValue,
CFSocketCopyRegisteredValue) allows the registration of any property
list type. Functions specific to CFSockets (CFSocketRegisterSocketData,
CFSocketCopyRegisteredSocketData) register a CFData containing the
components of a socket signature (protocol family, socket type,
protocol, and address). In each function the nameServerSignature
may be NULL, or any component of it may be 0, to use default values
(TCP, INADDR_LOOPBACK, port as set). Name registration servers might
not allow registration with other than TCP and INADDR_LOOPBACK.
The actual address of the server responding to a query may be obtained
by using the nameServerAddress argument. This address, the address
returned by CFSocketCopyRegisteredSocketSignature, and the value
returned by CFSocketCopyRegisteredValue must (if non-null) be released
by the caller. CFSocketUnregister removes any registration associated
with the specified name.
*/
CF_EXPORT CFSocketError CFSocketRegisterValue(const CFSocketSignature *nameServerSignature, CFTimeInterval timeout, CFStringRef name, CFPropertyListRef value);
CF_EXPORT CFSocketError CFSocketCopyRegisteredValue(const CFSocketSignature *nameServerSignature, CFTimeInterval timeout, CFStringRef name, CFPropertyListRef *value, CFDataRef *nameServerAddress);
CF_EXPORT CFSocketError CFSocketRegisterSocketSignature(const CFSocketSignature *nameServerSignature, CFTimeInterval timeout, CFStringRef name, const CFSocketSignature *signature);
CF_EXPORT CFSocketError CFSocketCopyRegisteredSocketSignature(const CFSocketSignature *nameServerSignature, CFTimeInterval timeout, CFStringRef name, CFSocketSignature *signature, CFDataRef *nameServerAddress);
CF_EXPORT CFSocketError CFSocketUnregister(const CFSocketSignature *nameServerSignature, CFTimeInterval timeout, CFStringRef name);
CF_EXPORT void CFSocketSetDefaultNameRegistryPortNumber(UInt16 port);
CF_EXPORT UInt16 CFSocketGetDefaultNameRegistryPortNumber(void);
/* Constants used in name registry server communications */
CF_EXPORT const CFStringRef kCFSocketCommandKey;
CF_EXPORT const CFStringRef kCFSocketNameKey;
CF_EXPORT const CFStringRef kCFSocketValueKey;
CF_EXPORT const CFStringRef kCFSocketResultKey;
CF_EXPORT const CFStringRef kCFSocketErrorKey;
CF_EXPORT const CFStringRef kCFSocketRegisterCommand;
CF_EXPORT const CFStringRef kCFSocketRetrieveCommand;
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif /* ! __COREFOUNDATION_CFSOCKET__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFError.h | /* CFError.h
Copyright (c) 2006-2019, Apple Inc. and the Swift project authors
Portions Copyright (c) 2014-2019, Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See http://swift.org/LICENSE.txt for license information
See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
*/
/*!
@header CFError
@discussion
CFErrors are used to encompass information about errors. At minimum, errors are identified by their domain (a string) and an error code within that domain. In addition a "userInfo" dictionary supplied at creation time enables providing additional info that might be useful for the interpretation and reporting of the error. This dictionary can even contain an "underlying" error, which is wrapped as an error bubbles up through various layers.
CFErrors have the ability to provide human-readable descriptions for the errors; in fact, they are designed to provide localizable, end-user presentable errors that can appear in the UI. CFError has a number of predefined userInfo keys to enable developers to supply the info.
Usage recommendation for CFErrors is to return them as by-ref parameters in functions. This enables the caller to pass NULL in when they don't actually want information about the error. The presence of an error should be reported by other means, for instance a NULL or false return value from the function call proper:
CFError *error;
if (!ReadFromFile(fd, &error)) {
... process error ...
CFRelease(error); // If an error occurs, the returned CFError must be released.
}
It is the responsibility of anyone returning CFErrors this way to:
- Not touch the error argument if no error occurs
- Create and assign the error for return only if the error argument is non-NULL
In addition, it's recommended that CFErrors be used in error situations only (not status), and where there are multiple possible errors to distinguish between. For instance there is no plan to add CFErrors to existing APIs in CF which currently don't return errors; in many cases, there is one possible reason for failure, and a false or NULL return is enough to indicate it.
CFError is toll-free bridged to NSError in Foundation. NSError in Foundation has some additional guidelines which makes it easy to automatically report errors to users and even try to recover from them. See http://developer.apple.com/documentation/Cocoa/Conceptual/ErrorHandlingCocoa/ErrorHandling/chapter_1_section_1.html for more info on NSError programming guidelines.
*/
#if !defined(__COREFOUNDATION_CFERROR__)
#define __COREFOUNDATION_CFERROR__ 1
#include <CoreFoundation/CFBase.h>
#include <CoreFoundation/CFString.h>
#include <CoreFoundation/CFDictionary.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
typedef CFStringRef CFErrorDomain CF_EXTENSIBLE_STRING_ENUM;
/*!
@typedef CFErrorRef
This is the type of a reference to CFErrors. CFErrorRef is toll-free bridged with NSError.
*/
typedef struct CF_BRIDGED_TYPE(NSError) __CFError * CFErrorRef;
/*!
@function CFErrorGetTypeID
Returns the type identifier of all CFError instances.
*/
CF_EXPORT
CFTypeID CFErrorGetTypeID(void) API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0));
// Predefined domains; value of "code" will correspond to preexisting values in these domains.
CF_EXPORT const CFErrorDomain kCFErrorDomainPOSIX API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0));
CF_EXPORT const CFErrorDomain kCFErrorDomainOSStatus API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0));
CF_EXPORT const CFErrorDomain kCFErrorDomainMach API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0));
CF_EXPORT const CFErrorDomain kCFErrorDomainCocoa API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0));
// Keys in userInfo for localizable, end-user presentable error messages. At minimum provide kCFErrorLocalizedDescriptionKey, or add kCFErrorLocalizedFailureKey into errors generated by lower levels to have it combine with kCFErrorLocalizedFailureReasonKey.
CF_EXPORT const CFStringRef kCFErrorLocalizedDescriptionKey API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)); // Key to identify the end user-presentable description in userInfo. Should be one or more complete sentence(s) describing both what failed and why. For instance 'You can't save the file "To Do List" because the volume "Macintosh HD" is out of space.'
CF_EXPORT const CFStringRef kCFErrorLocalizedFailureKey API_AVAILABLE(macos(10.13), ios(11.0), watchos(4.0), tvos(11.0)); // Key to identify the end user-presentable failing operation ("what failed") description in userInfo. Should be one or more complete sentence(s), for instance 'The file "To Do List" couldn't be saved.'
CF_EXPORT const CFStringRef kCFErrorLocalizedFailureReasonKey API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)); // Key to identify the end user-presentable failure reason ("why it failed") description in userInfo. Should be one or more complete sentence(s), for instance 'The volume "Macintosh HD" is out of space.'
CF_EXPORT const CFStringRef kCFErrorLocalizedRecoverySuggestionKey API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)); // Key to identify the end user-presentable recovery suggestion in userInfo. Should be one or more complete sentence(s), for instance 'Remove some files from the volume, and then try again.'
// If you do not have localizable error strings, you can provide a value for this key instead.
CF_EXPORT const CFStringRef kCFErrorDescriptionKey API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)); // Key to identify the description in the userInfo dictionary. Should be a complete sentence if possible. Should not contain domain name or error code.
// Other keys in userInfo.
CF_EXPORT const CFStringRef kCFErrorUnderlyingErrorKey API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)); // Key to identify the underlying error in userInfo.
CF_EXPORT const CFStringRef kCFErrorURLKey API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0)); // Key to identify associated URL in userInfo. Typically one of this or kCFErrorFilePathKey is provided.
CF_EXPORT const CFStringRef kCFErrorFilePathKey API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0)); // Key to identify associated file path in userInfo. Typically one of this or kCFErrorURLKey is provided.
/*!
@function CFErrorCreate
@abstract Creates a new CFError.
@param allocator The CFAllocator which should be used to allocate memory for the error. This parameter may be NULL in which case the
current default CFAllocator is used. If this reference is not a valid CFAllocator, the behavior is undefined.
@param domain A CFString identifying the error domain. If this reference is NULL or is otherwise not a valid CFString, the behavior is undefined.
@param code A CFIndex identifying the error code. The code is interpreted within the context of the error domain.
@param userInfo A CFDictionary created with kCFCopyStringDictionaryKeyCallBacks and kCFTypeDictionaryValueCallBacks. It will be copied with CFDictionaryCreateCopy().
If no userInfo dictionary is desired, NULL may be passed in as a convenience, in which case an empty userInfo dictionary will be assigned.
@result A reference to the new CFError.
*/
CF_EXPORT
CFErrorRef CFErrorCreate(CFAllocatorRef allocator, CFErrorDomain domain, CFIndex code, CFDictionaryRef userInfo) API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0));
/*!
@function CFErrorCreateWithUserInfoKeysAndValues
@abstract Creates a new CFError without having to create an intermediate userInfo dictionary.
@param allocator The CFAllocator which should be used to allocate memory for the error. This parameter may be NULL in which case the
current default CFAllocator is used. If this reference is not a valid CFAllocator, the behavior is undefined.
@param domain A CFString identifying the error domain. If this reference is NULL or is otherwise not a valid CFString, the behavior is undefined.
@param code A CFIndex identifying the error code. The code is interpreted within the context of the error domain.
@param userInfoKeys An array of numUserInfoValues CFStrings used as keys in creating the userInfo dictionary. NULL is valid only if numUserInfoValues is 0.
@param userInfoValues An array of numUserInfoValues CF types used as values in creating the userInfo dictionary. NULL is valid only if numUserInfoValues is 0.
@param numUserInfoValues CFIndex representing the number of keys and values in the userInfoKeys and userInfoValues arrays.
@result A reference to the new CFError. numUserInfoValues CF types are gathered from each of userInfoKeys and userInfoValues to create the userInfo dictionary.
*/
CF_EXPORT
CFErrorRef CFErrorCreateWithUserInfoKeysAndValues(CFAllocatorRef allocator, CFErrorDomain domain, CFIndex code, const void *const *userInfoKeys, const void *const *userInfoValues, CFIndex numUserInfoValues) API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0));
/*!
@function CFErrorGetDomain
@abstract Returns the error domain the CFError was created with.
@param err The CFError whose error domain is to be returned. If this reference is not a valid CFError, the behavior is undefined.
@result The error domain of the CFError. Since this is a "Get" function, the caller shouldn't CFRelease the return value.
*/
CF_EXPORT
CFErrorDomain CFErrorGetDomain(CFErrorRef err) API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0));
/*!
@function CFErrorGetCode
@abstract Returns the error code the CFError was created with.
@param err The CFError whose error code is to be returned. If this reference is not a valid CFError, the behavior is undefined.
@result The error code of the CFError (not an error return for the current call).
*/
CF_EXPORT
CFIndex CFErrorGetCode(CFErrorRef err) API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0));
/*!
@function CFErrorCopyUserInfo
@abstract Returns CFError userInfo dictionary.
@discussion Returns a dictionary containing the same keys and values as in the userInfo dictionary the CFError was created with. Returns an empty dictionary if NULL was supplied to CFErrorCreate().
@param err The CFError whose error user info is to be returned. If this reference is not a valid CFError, the behavior is undefined.
@result The user info of the CFError.
*/
CF_EXPORT
CFDictionaryRef CFErrorCopyUserInfo(CFErrorRef err) API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0));
/*!
@function CFErrorCopyDescription
@abstract Returns a human-presentable description for the error. CFError creators should strive to make sure the return value is human-presentable and localized by providing a value for kCFErrorLocalizedDescriptionKey at the time of CFError creation.
@discussion This is a complete sentence or two which says what failed and why it failed. Please refer to header comments for -[NSError localizedDescription] for details on the steps used to compute this; but roughly:
- Use value of kCFErrorLocalizedDescriptionKey as-is if provided.
- Use value of kCFErrorLocalizedFailureKey if provided, optionally followed by kCFErrorLocalizedFailureReasonKey if available.
- Use value of kCFErrorLocalizedFailureReasonKey, combining with a generic failure message such as: "Operation code not be completed. " + kCFErrorLocalizedFailureReasonKey.
- If all of the above fail, generate a semi-user presentable string from kCFErrorDescriptionKey, the domain, and code. Something like: "Operation could not be completed. Error domain/code occurred. " or "Operation could not be completed. " + kCFErrorDescriptionKey + " (Error domain/code)"
Toll-free bridged NSError instances might provide additional behaviors for manufacturing a description string. Do not count on the exact contents or format of the returned string, it might change.
@param err The CFError whose description is to be returned. If this reference is not a valid CFError, the behavior is undefined.
@result A CFString with human-presentable description of the CFError. Never NULL.
*/
CF_EXPORT
CFStringRef CFErrorCopyDescription(CFErrorRef err) API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0));
/*!
@function CFErrorCopyFailureReason
@abstract Returns a human-presentable failure reason for the error. May return NULL. CFError creators should strive to make sure the return value is human-presentable and localized by providing a value for kCFErrorLocalizedFailureReasonKey at the time of CFError creation.
@discussion This is a complete sentence which describes why the operation failed. In many cases this will be just the "because" part of the description (but as a complete sentence, which makes localization easier). By default this looks for kCFErrorLocalizedFailureReasonKey in the user info. Toll-free bridged NSError instances might provide additional behaviors for manufacturing this value. If no user-presentable string is available, returns NULL.
Example Description: "Could not save file 'Letter' in folder 'Documents' because the volume 'MyDisk' doesn't have enough space."
Corresponding FailureReason: "The volume 'MyDisk' doesn't have enough space."
@param err The CFError whose failure reason is to be returned. If this reference is not a valid CFError, the behavior is undefined.
@result A CFString with the localized, end-user presentable failure reason of the CFError, or NULL.
*/
CF_EXPORT
CFStringRef CFErrorCopyFailureReason(CFErrorRef err) API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0));
/*!
@function CFErrorCopyRecoverySuggestion
@abstract Returns a human presentable recovery suggestion for the error. May return NULL. CFError creators should strive to make sure the return value is human-presentable and localized by providing a value for kCFErrorLocalizedRecoverySuggestionKey at the time of CFError creation.
@discussion This is the string that can be displayed as the "informative" (aka "secondary") message on an alert panel. By default this looks for kCFErrorLocalizedRecoverySuggestionKey in the user info. Toll-free bridged NSError instances might provide additional behaviors for manufacturing this value. If no user-presentable string is available, returns NULL.
Example Description: "Could not save file 'Letter' in folder 'Documents' because the volume 'MyDisk' doesn't have enough space."
Corresponding RecoverySuggestion: "Remove some files from the volume and try again."
@param err The CFError whose recovery suggestion is to be returned. If this reference is not a valid CFError, the behavior is undefined.
@result A CFString with the localized, end-user presentable recovery suggestion of the CFError, or NULL.
*/
CF_EXPORT
CFStringRef CFErrorCopyRecoverySuggestion(CFErrorRef err) API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0));
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif /* ! __COREFOUNDATION_CFERROR__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFDate.h | /* CFDate.h
Copyright (c) 1998-2019, Apple Inc. and the Swift project authors
Portions Copyright (c) 2014-2019, Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See http://swift.org/LICENSE.txt for license information
See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
*/
#if !defined(__COREFOUNDATION_CFDATE__)
#define __COREFOUNDATION_CFDATE__ 1
#include <CoreFoundation/CFBase.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
typedef double CFTimeInterval;
typedef CFTimeInterval CFAbsoluteTime;
/* absolute time is the time interval since the reference date */
/* the reference date (epoch) is 00:00:00 1 January 2001. */
CF_EXPORT
CFAbsoluteTime CFAbsoluteTimeGetCurrent(void);
CF_EXPORT
const CFTimeInterval kCFAbsoluteTimeIntervalSince1970;
CF_EXPORT
const CFTimeInterval kCFAbsoluteTimeIntervalSince1904;
typedef const struct CF_BRIDGED_TYPE(NSDate) __CFDate * CFDateRef;
CF_EXPORT
CFTypeID CFDateGetTypeID(void);
CF_EXPORT
CFDateRef CFDateCreate(CFAllocatorRef allocator, CFAbsoluteTime at);
CF_EXPORT
CFAbsoluteTime CFDateGetAbsoluteTime(CFDateRef theDate);
CF_EXPORT
CFTimeInterval CFDateGetTimeIntervalSinceDate(CFDateRef theDate, CFDateRef otherDate);
CF_EXPORT
CFComparisonResult CFDateCompare(CFDateRef theDate, CFDateRef otherDate, void *context);
CF_IMPLICIT_BRIDGING_DISABLED
typedef const struct CF_BRIDGED_TYPE(NSTimeZone) __CFTimeZone * CFTimeZoneRef;
#if !defined(CF_CALENDAR_ENUM_DEPRECATED)
#if 1 || NS_ENABLE_CALENDAR_DEPRECATIONS
#define CF_CALENDAR_ENUM_DEPRECATED(A, B, C, D, ...) CF_ENUM_DEPRECATED(A, B, C, D, __VA_ARGS__)
#define CF_CALENDAR_DEPRECATED(A, B, C, D, ...) CF_DEPRECATED(A, B, C, D, __VA_ARGS__)
#else
#define CF_CALENDAR_ENUM_DEPRECATED(A, B, C, D, ...) CF_ENUM_AVAILABLE(A, C)
#define CF_CALENDAR_DEPRECATED(A, B, C, D, ...) CF_AVAILABLE(A, C)
#endif
#endif
typedef struct {
SInt32 year;
SInt8 month;
SInt8 day;
SInt8 hour;
SInt8 minute;
double second;
} CFGregorianDate API_DEPRECATED("Use CFCalendar or NSCalendar API instead", macos(10.4, 10.10), ios(2.0, 8.0), watchos(2.0, 2.0), tvos(9.0, 9.0));
typedef struct {
SInt32 years;
SInt32 months;
SInt32 days;
SInt32 hours;
SInt32 minutes;
double seconds;
} CFGregorianUnits API_DEPRECATED("Use CFCalendar or NSCalendar API instead", macos(10.4, 10.10), ios(2.0, 8.0), watchos(2.0, 2.0), tvos(9.0, 9.0));
typedef CF_OPTIONS(CFOptionFlags, CFGregorianUnitFlags) {
kCFGregorianUnitsYears API_DEPRECATED("Use CFCalendar or NSCalendar API instead", macos(10.4, 10.10), ios(2.0, 8.0), watchos(2.0, 2.0), tvos(9.0, 9.0)) = (1UL << 0),
kCFGregorianUnitsMonths API_DEPRECATED("Use CFCalendar or NSCalendar API instead", macos(10.4, 10.10), ios(2.0, 8.0), watchos(2.0, 2.0), tvos(9.0, 9.0)) = (1UL << 1),
kCFGregorianUnitsDays API_DEPRECATED("Use CFCalendar or NSCalendar API instead", macos(10.4, 10.10), ios(2.0, 8.0), watchos(2.0, 2.0), tvos(9.0, 9.0)) = (1UL << 2),
kCFGregorianUnitsHours API_DEPRECATED("Use CFCalendar or NSCalendar API instead", macos(10.4, 10.10), ios(2.0, 8.0), watchos(2.0, 2.0), tvos(9.0, 9.0)) = (1UL << 3),
kCFGregorianUnitsMinutes API_DEPRECATED("Use CFCalendar or NSCalendar API instead", macos(10.4, 10.10), ios(2.0, 8.0), watchos(2.0, 2.0), tvos(9.0, 9.0)) = (1UL << 4),
kCFGregorianUnitsSeconds API_DEPRECATED("Use CFCalendar or NSCalendar API instead", macos(10.4, 10.10), ios(2.0, 8.0), watchos(2.0, 2.0), tvos(9.0, 9.0)) = (1UL << 5),
kCFGregorianAllUnits API_DEPRECATED("Use CFCalendar or NSCalendar API instead", macos(10.4, 10.10), ios(2.0, 8.0), watchos(2.0, 2.0), tvos(9.0, 9.0)) = 0x00FFFFFF
};
CF_EXPORT
Boolean CFGregorianDateIsValid(CFGregorianDate gdate, CFOptionFlags unitFlags) API_DEPRECATED("Use CFCalendar or NSCalendar API instead", macos(10.4, 10.10), ios(2.0, 8.0), watchos(2.0, 2.0), tvos(9.0, 9.0));
CF_EXPORT
CFAbsoluteTime CFGregorianDateGetAbsoluteTime(CFGregorianDate gdate, CFTimeZoneRef tz) API_DEPRECATED("Use CFCalendar or NSCalendar API instead", macos(10.4, 10.10), ios(2.0, 8.0), watchos(2.0, 2.0), tvos(9.0, 9.0));
CF_EXPORT
CFGregorianDate CFAbsoluteTimeGetGregorianDate(CFAbsoluteTime at, CFTimeZoneRef tz) API_DEPRECATED("Use CFCalendar or NSCalendar API instead", macos(10.4, 10.10), ios(2.0, 8.0), watchos(2.0, 2.0), tvos(9.0, 9.0));
CF_EXPORT
CFAbsoluteTime CFAbsoluteTimeAddGregorianUnits(CFAbsoluteTime at, CFTimeZoneRef tz, CFGregorianUnits units) API_DEPRECATED("Use CFCalendar or NSCalendar API instead", macos(10.4, 10.10), ios(2.0, 8.0), watchos(2.0, 2.0), tvos(9.0, 9.0));
CF_EXPORT
CFGregorianUnits CFAbsoluteTimeGetDifferenceAsGregorianUnits(CFAbsoluteTime at1, CFAbsoluteTime at2, CFTimeZoneRef tz, CFOptionFlags unitFlags) API_DEPRECATED("Use CFCalendar or NSCalendar API instead", macos(10.4, 10.10), ios(2.0, 8.0), watchos(2.0, 2.0), tvos(9.0, 9.0));
CF_EXPORT
SInt32 CFAbsoluteTimeGetDayOfWeek(CFAbsoluteTime at, CFTimeZoneRef tz) API_DEPRECATED("Use CFCalendar or NSCalendar API instead", macos(10.4, 10.10), ios(2.0, 8.0), watchos(2.0, 2.0), tvos(9.0, 9.0));
CF_EXPORT
SInt32 CFAbsoluteTimeGetDayOfYear(CFAbsoluteTime at, CFTimeZoneRef tz) API_DEPRECATED("Use CFCalendar or NSCalendar API instead", macos(10.4, 10.10), ios(2.0, 8.0), watchos(2.0, 2.0), tvos(9.0, 9.0));
CF_EXPORT
SInt32 CFAbsoluteTimeGetWeekOfYear(CFAbsoluteTime at, CFTimeZoneRef tz) API_DEPRECATED("Use CFCalendar or NSCalendar API instead", macos(10.4, 10.10), ios(2.0, 8.0), watchos(2.0, 2.0), tvos(9.0, 9.0));
CF_EXTERN_C_END
#endif /* ! __COREFOUNDATION_CFDATE__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFPlugInCOM.h | /* CFPlugInCOM.h
Copyright (c) 1999-2019, Apple Inc. and the Swift project authors
Portions Copyright (c) 2014-2019, Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See http://swift.org/LICENSE.txt for license information
See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
*/
#if !defined(__COREFOUNDATION_CFPLUGINCOM__)
#define __COREFOUNDATION_CFPLUGINCOM__ 1
#include <CoreFoundation/CFPlugIn.h>
CF_EXTERN_C_BEGIN
/* ================= IUnknown definition (C struct) ================= */
/* All interface structs must have an IUnknownStruct at the beginning. */
/* The _reserved field is part of the Microsoft COM binary standard on Macintosh. */
/* You can declare new C struct interfaces by defining a new struct that includes "IUNKNOWN_C_GUTS;" before the first field of the struct. */
#if TARGET_OS_WIN32
#define NOMINMAX
#define VC_EXTRALEAN
#define WIN32_LEAN_AND_MEAN
#include <Windows.h>
#else
typedef SInt32 HRESULT;
typedef UInt32 ULONG;
typedef void *LPVOID;
typedef CFUUIDBytes REFIID;
#endif
#define SUCCEEDED(Status) ((HRESULT)(Status) >= 0)
#define FAILED(Status) ((HRESULT)(Status)<0)
/* Macros for more detailed HRESULT analysis */
#define IS_ERROR(Status) ((unsigned long)(Status) >> 31 == SEVERITY_ERROR)
#define HRESULT_CODE(hr) ((hr) & 0xFFFF)
#define HRESULT_FACILITY(hr) (((hr) >> 16) & 0x1fff)
#define HRESULT_SEVERITY(hr) (((hr) >> 31) & 0x1)
#define SEVERITY_SUCCESS 0
#define SEVERITY_ERROR 1
/* Creating an HRESULT from its component pieces */
#define MAKE_HRESULT(sev,fac,code) ((HRESULT) (((unsigned long)(sev)<<31) | ((unsigned long)(fac)<<16) | ((unsigned long)(code))) )
/* Pre-defined success HRESULTS */
#define S_OK ((HRESULT)0x00000000L)
#define S_FALSE ((HRESULT)0x00000001L)
/* Common error HRESULTS */
#define E_UNEXPECTED ((HRESULT)0x8000FFFFL)
#define E_NOTIMPL ((HRESULT)0x80000001L)
#define E_OUTOFMEMORY ((HRESULT)0x80000002L)
#define E_INVALIDARG ((HRESULT)0x80000003L)
#define E_NOINTERFACE ((HRESULT)0x80000004L)
#define E_POINTER ((HRESULT)0x80000005L)
#define E_HANDLE ((HRESULT)0x80000006L)
#define E_ABORT ((HRESULT)0x80000007L)
#define E_FAIL ((HRESULT)0x80000008L)
#define E_ACCESSDENIED ((HRESULT)0x80000009L)
/* This macro should be used when defining all interface functions (as it is for the IUnknown functions below). */
#define STDMETHODCALLTYPE
/* The __RPC_FAR macro is for COM source compatibility only. This macro is used a lot in COM interface definitions. If your CFPlugIn interfaces need to be COM interfaces as well, you can use this macro to get better source compatibility. It is not used in the IUnknown definition below, because when doing COM, you will be using the Microsoft supplied IUnknown interface anyway. */
#define __RPC_FAR
/* The IUnknown interface */
#define IUnknownUUID CFUUIDGetConstantUUIDWithBytes(kCFAllocatorSystemDefault, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0xC0, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x46)
#if __clang__
#define __PRAGMA_PUSH_NO_NULLABILITY_COMPLETENESS_WARNINGS _Pragma("clang diagnostic push") _Pragma("clang diagnostic ignored \"-Wnullability-completeness\"")
#define __PRAGMA_POP_NO_NULLABILITY_COMPLETENESS_WARNINGS _Pragma("clang diagnostic pop")
#else
#define __PRAGMA_PUSH_NO_NULLABILITY_COMPLETENESS_WARNINGS
#define __PRAGMA_POP_NO_NULLABILITY_COMPLETENESS_WARNINGS
#endif
#define IUNKNOWN_C_GUTS \
__PRAGMA_PUSH_NO_NULLABILITY_COMPLETENESS_WARNINGS \
void *_reserved; \
HRESULT (STDMETHODCALLTYPE *QueryInterface)(void *thisPointer, REFIID iid, LPVOID *ppv); \
ULONG (STDMETHODCALLTYPE *AddRef)(void *thisPointer); \
ULONG (STDMETHODCALLTYPE *Release)(void *thisPointer) \
__PRAGMA_POP_NO_NULLABILITY_COMPLETENESS_WARNINGS
typedef struct IUnknownVTbl {
IUNKNOWN_C_GUTS;
} IUnknownVTbl;
CF_EXTERN_C_END
/* C++ specific stuff */
#if defined(__cplusplus)
/* ================= IUnknown definition (C++ class) ================= */
/* This is a definition of IUnknown as a pure abstract virtual C++ class. This class will work only with compilers that can produce COM-compatible object layouts for C++ classes. egcs can not do this. MetroWerks can do this (if you subclass from __comobject) */
class IUnknown
#if defined(__MWERKS__) && TARGET_OS_WIN32
: __comobject
#endif
{
public:
virtual HRESULT STDMETHODCALLTYPE QueryInterface(REFIID iid, LPVOID *ppv) = 0;
virtual ULONG STDMETHODCALLTYPE AddRef(void) = 0;
virtual ULONG STDMETHODCALLTYPE Release(void) = 0;
};
#endif /* __cplusplus */
#endif /* ! __COREFOUNDATION_CFPLUGINCOM__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFUUID.h | /* CFUUID.h
Copyright (c) 1999-2019, Apple Inc. and the Swift project authors
Portions Copyright (c) 2014-2019, Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See http://swift.org/LICENSE.txt for license information
See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
*/
#if !defined(__COREFOUNDATION_CFUUID__)
#define __COREFOUNDATION_CFUUID__ 1
#include <CoreFoundation/CFBase.h>
#include <CoreFoundation/CFString.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
typedef const struct CF_BRIDGED_TYPE(id) __CFUUID * CFUUIDRef;
typedef struct {
UInt8 byte0;
UInt8 byte1;
UInt8 byte2;
UInt8 byte3;
UInt8 byte4;
UInt8 byte5;
UInt8 byte6;
UInt8 byte7;
UInt8 byte8;
UInt8 byte9;
UInt8 byte10;
UInt8 byte11;
UInt8 byte12;
UInt8 byte13;
UInt8 byte14;
UInt8 byte15;
} CFUUIDBytes;
/* The CFUUIDBytes struct is a 128-bit struct that contains the
raw UUID. A CFUUIDRef can provide such a struct from the
CFUUIDGetUUIDBytes() function. This struct is suitable for
passing to APIs that expect a raw UUID.
*/
CF_EXPORT
CFTypeID CFUUIDGetTypeID(void);
CF_EXPORT
CFUUIDRef CFUUIDCreate(CFAllocatorRef alloc);
/* Create and return a brand new unique identifier */
CF_EXPORT
CFUUIDRef CFUUIDCreateWithBytes(CFAllocatorRef alloc, UInt8 byte0, UInt8 byte1, UInt8 byte2, UInt8 byte3, UInt8 byte4, UInt8 byte5, UInt8 byte6, UInt8 byte7, UInt8 byte8, UInt8 byte9, UInt8 byte10, UInt8 byte11, UInt8 byte12, UInt8 byte13, UInt8 byte14, UInt8 byte15);
/* Create and return an identifier with the given contents. This may return an existing instance with its ref count bumped because of uniquing. */
CF_EXPORT
CFUUIDRef CFUUIDCreateFromString(CFAllocatorRef alloc, CFStringRef uuidStr);
/* Converts from a string representation to the UUID. This may return an existing instance with its ref count bumped because of uniquing. */
CF_EXPORT
CFStringRef CFUUIDCreateString(CFAllocatorRef alloc, CFUUIDRef uuid);
/* Converts from a UUID to its string representation. */
CF_EXPORT
CFUUIDRef CFUUIDGetConstantUUIDWithBytes(CFAllocatorRef alloc, UInt8 byte0, UInt8 byte1, UInt8 byte2, UInt8 byte3, UInt8 byte4, UInt8 byte5, UInt8 byte6, UInt8 byte7, UInt8 byte8, UInt8 byte9, UInt8 byte10, UInt8 byte11, UInt8 byte12, UInt8 byte13, UInt8 byte14, UInt8 byte15);
/* This returns an immortal CFUUIDRef that should not be released. It can be used in headers to declare UUID constants with #define. */
CF_EXPORT
CFUUIDBytes CFUUIDGetUUIDBytes(CFUUIDRef uuid);
CF_EXPORT
CFUUIDRef CFUUIDCreateFromUUIDBytes(CFAllocatorRef alloc, CFUUIDBytes bytes);
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif /* ! __COREFOUNDATION_CFUUID__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFURL.h | /* CFURL.h
Copyright (c) 1998-2019, Apple Inc. and the Swift project authors
Portions Copyright (c) 2014-2019, Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See http://swift.org/LICENSE.txt for license information
See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
*/
#if !defined(__COREFOUNDATION_CFURL__)
#define __COREFOUNDATION_CFURL__ 1
#include <CoreFoundation/CFBase.h>
#include <CoreFoundation/CFData.h>
#include <CoreFoundation/CFError.h>
#include <CoreFoundation/CFString.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
typedef CF_ENUM(CFIndex, CFURLPathStyle) {
kCFURLPOSIXPathStyle = 0,
kCFURLHFSPathStyle API_DEPRECATED("Carbon File Manager is deprecated, use kCFURLPOSIXPathStyle where possible", macos(10.0,10.9), ios(2.0,7.0), watchos(2.0,2.0), tvos(9.0,9.0)), /* The use of kCFURLHFSPathStyle is deprecated. The Carbon File Manager, which uses HFS style paths, is deprecated. HFS style paths are unreliable because they can arbitrarily refer to multiple volumes if those volumes have identical volume names. You should instead use kCFURLPOSIXPathStyle wherever possible. */
kCFURLWindowsPathStyle
};
typedef const struct CF_BRIDGED_TYPE(NSURL) __CFURL * CFURLRef;
/* CFURLs are composed of two fundamental pieces - their string, and a */
/* (possibly NULL) base URL. A relative URL is one in which the string */
/* by itself does not fully specify the URL (for instance "myDir/image.tiff"); */
/* an absolute URL is one in which the string does fully specify the URL */
/* ("file://localhost/myDir/image.tiff"). Absolute URLs always have NULL */
/* base URLs; however, it is possible for a URL to have a NULL base, and still */
/* not be absolute. Such a URL has only a relative string, and cannot be */
/* resolved. Two CFURLs are considered equal if and only if their strings */
/* are equal and their bases are equal. In other words, */
/* "file://localhost/myDir/image.tiff" is NOT equal to the URL with relative */
/* string "myDir/image.tiff" and base URL "file://localhost/". Clients that */
/* need these less strict form of equality should convert all URLs to their */
/* absolute form via CFURLCopyAbsoluteURL(), then compare the absolute forms. */
CF_EXPORT
CFTypeID CFURLGetTypeID(void);
/* encoding will be used both to interpret the bytes of URLBytes, and to */
/* interpret any percent-escapes within the bytes. */
/* Using a string encoding which isn't a superset of ASCII encoding is not */
/* supported because CFURLGetBytes and CFURLGetByteRangeForComponent require */
/* 7-bit ASCII characters to be stored in a single 8-bit byte. */
/* CFStringEncodings which are a superset of ASCII encoding include MacRoman, */
/* WindowsLatin1, ISOLatin1, NextStepLatin, ASCII, and UTF8. */
CF_EXPORT
CFURLRef CFURLCreateWithBytes(CFAllocatorRef allocator, const UInt8 *URLBytes, CFIndex length, CFStringEncoding encoding, CFURLRef baseURL);
/* Escapes any character that is not 7-bit ASCII with the byte-code */
/* for the given encoding. If escapeWhitespace is true, whitespace */
/* characters (' ', '\t', '\r', '\n') will be escaped also (desirable */
/* if embedding the URL into a larger text stream like HTML) */
CF_EXPORT
CFDataRef CFURLCreateData(CFAllocatorRef allocator, CFURLRef url, CFStringEncoding encoding, Boolean escapeWhitespace);
/* Any percent-escape sequences in URLString will be interpreted via UTF-8. URLString must be a valid URL string. */
CF_EXPORT
CFURLRef CFURLCreateWithString(CFAllocatorRef allocator, CFStringRef URLString, CFURLRef baseURL);
/* Create an absolute URL directly, without requiring the extra step */
/* of calling CFURLCopyAbsoluteURL(). If useCompatibilityMode is */
/* true, the rules historically used on the web are used to resolve */
/* relativeString against baseURL - these rules are generally listed */
/* in the RFC as optional or alternate interpretations. Otherwise, */
/* the strict rules from the RFC are used. The major differences are */
/* that in compatibility mode, we are lenient of the scheme appearing */
/* in relative portion, leading "../" components are removed from the */
/* final URL's path, and if the relative portion contains only */
/* resource specifier pieces (query, parameters, and fragment), then */
/* the last path component of the base URL will not be deleted. */
/* Using a string encoding which isn't a superset of ASCII encoding is not */
/* supported because CFURLGetBytes and CFURLGetByteRangeForComponent require */
/* 7-bit ASCII characters to be stored in a single 8-bit byte. */
/* CFStringEncodings which are a superset of ASCII encoding include MacRoman, */
/* WindowsLatin1, ISOLatin1, NextStepLatin, ASCII, and UTF8. */
CF_EXPORT
CFURLRef CFURLCreateAbsoluteURLWithBytes(CFAllocatorRef alloc, const UInt8 *relativeURLBytes, CFIndex length, CFStringEncoding encoding, CFURLRef baseURL, Boolean useCompatibilityMode);
/* filePath should be the URL's path expressed as a path of the type */
/* fsType. If filePath is not absolute, the resulting URL will be */
/* considered relative to the current working directory (evaluated */
/* at creation time). isDirectory determines whether filePath is */
/* treated as a directory path when resolving against relative path */
/* components */
CF_EXPORT
CFURLRef CFURLCreateWithFileSystemPath(CFAllocatorRef allocator, CFStringRef filePath, CFURLPathStyle pathStyle, Boolean isDirectory);
CF_EXPORT
CFURLRef CFURLCreateFromFileSystemRepresentation(CFAllocatorRef allocator, const UInt8 *buffer, CFIndex bufLen, Boolean isDirectory);
/* The path style of the baseURL must match the path style of the relative */
/* url or the results are undefined. If the provided filePath looks like an */
/* absolute path ( starting with '/' if pathStyle is kCFURLPosixPathStyle, */
/* not starting with ':' for kCFURLHFSPathStyle, or starting with what looks */
/* like a drive letter and colon for kCFURLWindowsPathStyle ) then the baseURL */
/* is ignored. */
CF_EXPORT
CFURLRef CFURLCreateWithFileSystemPathRelativeToBase(CFAllocatorRef allocator, CFStringRef filePath, CFURLPathStyle pathStyle, Boolean isDirectory, CFURLRef baseURL);
CF_EXPORT
CFURLRef CFURLCreateFromFileSystemRepresentationRelativeToBase(CFAllocatorRef allocator, const UInt8 *buffer, CFIndex bufLen, Boolean isDirectory, CFURLRef baseURL);
/* Fills buffer with the file system's native representation of */
/* url's path. No more than maxBufLen bytes are written to buffer. */
/* The buffer should be at least the maximum path length for */
/* the file system in question to avoid failures for insufficiently */
/* large buffers. If resolveAgainstBase is true, the url's relative */
/* portion is resolved against its base before the path is computed. */
/* Returns success or failure. */
CF_EXPORT
Boolean CFURLGetFileSystemRepresentation(CFURLRef url, Boolean resolveAgainstBase, UInt8 *buffer, CFIndex maxBufLen);
/* Creates a new URL by resolving the relative portion of relativeURL against its base. */
CF_EXPORT
CFURLRef CFURLCopyAbsoluteURL(CFURLRef relativeURL);
/* Returns the URL's string. Percent-escape sequences are not removed. */
CF_EXPORT
CFStringRef CFURLGetString(CFURLRef anURL);
/* Returns the base URL if it exists */
CF_EXPORT
CFURLRef CFURLGetBaseURL(CFURLRef anURL);
/*
All URLs can be broken into two pieces - the scheme (preceding the
first colon) and the resource specifier (following the first colon).
Most URLs are also "standard" URLs conforming to RFC 1808 (available
from www.w3c.org). This category includes URLs of the file, http,
https, and ftp schemes, to name a few. Standard URLs start the
resource specifier with two slashes ("//"), and can be broken into
four distinct pieces - the scheme, the net location, the path, and
further resource specifiers (typically an optional parameter, query,
and/or fragment). The net location appears immediately following
the two slashes and goes up to the next slash; it's format is
scheme-specific, but is usually composed of some or all of a username,
password, host name, and port. The path is a series of path components
separated by slashes; if the net location is present, the path always
begins with a slash. Standard URLs can be relative to another URL,
in which case at least the scheme and possibly other pieces as well
come from the base URL (see RFC 1808 for precise details when resolving
a relative URL against its base). The full URL is therefore
<scheme> "://" <net location> <path, always starting with slash> <add'l resource specifiers>
If a given CFURL can be decomposed (that is, conforms to RFC 1808), you
can ask for each of the four basic pieces (scheme, net location, path,
and resource specifer) separately, as well as for its base URL. The
basic pieces are returned with any percent-escape sequences still in
place (although note that the scheme may not legally include any
percent-escapes); this is to allow the caller to distinguish between
percent-escape sequences that may have syntactic meaning if replaced by the
character being escaped (for instance, a '/' in a path component).
Since only the individual schemes know which characters are
syntactically significant, CFURL cannot safely replace any percent-
escape sequences. However, you can use
CFURLCreateStringByReplacingPercentEscapes() to create a new string with
the percent-escapes removed; see below.
If a given CFURL can not be decomposed, you can ask for its scheme and its
resource specifier; asking it for its net location or path will return NULL.
To get more refined information about the components of a decomposable
CFURL, you may ask for more specific pieces of the URL, expressed with
the percent-escapes removed. The available functions are CFURLCopyHostName(),
CFURLGetPortNumber() (returns an Int32), CFURLCopyUserName(),
CFURLCopyPassword(), CFURLCopyQuery(), CFURLCopyParameters(), and
CFURLCopyFragment(). Because the parameters, query, and fragment of an
URL may contain scheme-specific syntaxes, these methods take a second
argument, giving a list of characters which should NOT be replaced if
percent-escaped. For instance, the ftp parameter syntax gives simple
key-value pairs as "<key>=<value>;" Clearly if a key or value includes
either '=' or ';', it must be escaped to avoid corrupting the meaning of
the parameters, so the caller may request the parameter string as
CFStringRef myParams = CFURLCopyParameters(ftpURL, CFSTR("=;%"));
requesting that all percent-escape sequences be replaced by the represented
characters, except for escaped '=', '%' or ';' characters. Pass the empty
string (CFSTR("")) to request that all percent-escapes be replaced, or NULL
to request that none be.
*/
/* Returns true if anURL conforms to RFC 1808 */
CF_EXPORT
Boolean CFURLCanBeDecomposed(CFURLRef anURL);
CF_EXPORT
CFStringRef CFURLCopyScheme(CFURLRef anURL);
/* Percent-escape sequences are not removed. NULL if CFURLCanBeDecomposed(anURL) is false */
CF_EXPORT
CFStringRef CFURLCopyNetLocation(CFURLRef anURL);
/* NULL if CFURLCanBeDecomposed(anURL) is false; also does not resolve the URL */
/* against its base. See also CFURLCopyAbsoluteURL(). Note that, strictly */
/* speaking, any leading '/' is not considered part of the URL's path, although */
/* its presence or absence determines whether the path is absolute. */
/* CFURLCopyPath()'s return value includes any leading slash (giving the path */
/* the normal POSIX appearance); CFURLCopyStrictPath()'s return value omits any */
/* leading slash, and uses isAbsolute to report whether the URL's path is absolute. */
/* Percent-escape sequences are not removed. */
CF_EXPORT
CFStringRef CFURLCopyPath(CFURLRef anURL);
/* Percent-escape sequences are not removed. */
CF_EXPORT
CFStringRef CFURLCopyStrictPath(CFURLRef anURL, Boolean *isAbsolute);
/* CFURLCopyFileSystemPath() returns the URL's path as a file system path for the */
/* given path style. All percent-escape sequences are removed. The URL is not */
/* resolved against its base before computing the path. */
CF_EXPORT
CFStringRef CFURLCopyFileSystemPath(CFURLRef anURL, CFURLPathStyle pathStyle);
/* Returns whether anURL's path represents a directory */
/* (true returned) or a simple file (false returned) */
CF_EXPORT
Boolean CFURLHasDirectoryPath(CFURLRef anURL);
/* Any additional resource specifiers after the path. For URLs */
/* that cannot be decomposed, this is everything except the scheme itself. */
/* Percent-escape sequences are not removed. */
CF_EXPORT
CFStringRef CFURLCopyResourceSpecifier(CFURLRef anURL);
/* Percent-escape sequences are removed. */
CF_EXPORT
CFStringRef CFURLCopyHostName(CFURLRef anURL);
CF_EXPORT
SInt32 CFURLGetPortNumber(CFURLRef anURL); /* Returns -1 if no port number is specified */
/* Percent-escape sequences are removed. */
CF_EXPORT
CFStringRef CFURLCopyUserName(CFURLRef anURL);
/* Percent-escape sequences are removed. */
CF_EXPORT
CFStringRef CFURLCopyPassword(CFURLRef anURL);
/* CFURLCopyParameterString, CFURLCopyQueryString, and CFURLCopyFragment */
/* remove all percent-escape sequences except those for */
/* characters in charactersToLeaveEscaped. If charactersToLeaveEscaped */
/* is empty (""), all percent-escape sequences are replaced by their */
/* corresponding characters. If charactersToLeaveEscaped is NULL, */
/* then no escape sequences are removed at all */
CF_EXPORT
CFStringRef CFURLCopyParameterString(CFURLRef anURL, CFStringRef charactersToLeaveEscaped) API_DEPRECATED("The CFURLCopyParameterString function is deprecated. Post deprecation for applications linked with or after the macOS 10.15, and for all iOS, watchOS, and tvOS applications, CFURLCopyParameterString will always return NULL, and the CFURLCopyPath(), CFURLCopyStrictPath(), and CFURLCopyFileSystemPath() functions will return the complete path including the semicolon separator and params component if the URL string contains them.", macosx(10.2,10.15), ios(2.0,13.0), watchos(2.0,6.0), tvos(9.0,13.0));
CF_EXPORT
CFStringRef CFURLCopyQueryString(CFURLRef anURL, CFStringRef charactersToLeaveEscaped);
CF_EXPORT
CFStringRef CFURLCopyFragment(CFURLRef anURL, CFStringRef charactersToLeaveEscaped);
/* Percent-escape sequences are removed. */
CF_EXPORT
CFStringRef CFURLCopyLastPathComponent(CFURLRef url);
/* Percent-escape sequences are removed. */
CF_EXPORT
CFStringRef CFURLCopyPathExtension(CFURLRef url);
CF_EXPORT
CFURLRef CFURLCreateCopyAppendingPathComponent(CFAllocatorRef allocator, CFURLRef url, CFStringRef pathComponent, Boolean isDirectory);
CF_EXPORT
CFURLRef CFURLCreateCopyDeletingLastPathComponent(CFAllocatorRef allocator, CFURLRef url);
CF_EXPORT
CFURLRef CFURLCreateCopyAppendingPathExtension(CFAllocatorRef allocator, CFURLRef url, CFStringRef extension);
CF_EXPORT
CFURLRef CFURLCreateCopyDeletingPathExtension(CFAllocatorRef allocator, CFURLRef url);
/* Fills buffer with the bytes for url, returning the number of bytes */
/* filled. If buffer is of insufficient size, returns -1 and no bytes */
/* are placed in buffer. If buffer is NULL, the needed length is */
/* computed and returned. The returned bytes are the original bytes */
/* from which the URL was created; if the URL was created from a */
/* string, the bytes will be the bytes of the string encoded via UTF-8. */
/* */
/* Note: Due to incompatibilities between encodings, it might be impossible to */
/* generate bytes from the base URL in the encoding of the relative URL or relative bytes, */
/* which will cause this method to fail and return -1, even if a NULL buffer is passed. */
/* To avoid this scenario, use UTF-8, UTF-16, or UTF-32 encodings exclusively, or */
/* use one non-Unicode encoding exclusively. */
CF_EXPORT
CFIndex CFURLGetBytes(CFURLRef url, UInt8 *buffer, CFIndex bufferLength);
typedef CF_ENUM(CFIndex, CFURLComponentType) {
kCFURLComponentScheme = 1,
kCFURLComponentNetLocation = 2,
kCFURLComponentPath = 3,
kCFURLComponentResourceSpecifier = 4,
kCFURLComponentUser = 5,
kCFURLComponentPassword = 6,
kCFURLComponentUserInfo = 7,
kCFURLComponentHost = 8,
kCFURLComponentPort = 9,
kCFURLComponentParameterString = 10,
kCFURLComponentQuery = 11,
kCFURLComponentFragment = 12
};
/*
Gets the range of the requested component in the bytes of url, as
returned by CFURLGetBytes(). This range is only good for use in the
bytes returned by CFURLGetBytes!
If non-NULL, rangeIncludingSeparators gives the range of component
including the sequences that separate component from the previous and
next components. If there is no previous or next component, that end of
rangeIncludingSeparators will match the range of the component itself.
If url does not contain the given component type, (kCFNotFound, 0) is
returned, and rangeIncludingSeparators is set to the location where the
component would be inserted. Some examples -
For the URL http://www.apple.com/hotnews/
Component returned range rangeIncludingSeparators
scheme (0, 4) (0, 7)
net location (7, 13) (4, 16)
path (20, 9) (20, 9)
resource specifier (kCFNotFound, 0) (29, 0)
user (kCFNotFound, 0) (7, 0)
password (kCFNotFound, 0) (7, 0)
user info (kCFNotFound, 0) (7, 0)
host (7, 13) (4, 16)
port (kCFNotFound, 0) (20, 0)
parameter (kCFNotFound, 0) (29, 0)
query (kCFNotFound, 0) (29, 0)
fragment (kCFNotFound, 0) (29, 0)
For the URL ./relPath/file.html#fragment
Component returned range rangeIncludingSeparators
scheme (kCFNotFound, 0) (0, 0)
net location (kCFNotFound, 0) (0, 0)
path (0, 19) (0, 20)
resource specifier (20, 8) (19, 9)
user (kCFNotFound, 0) (0, 0)
password (kCFNotFound, 0) (0, 0)
user info (kCFNotFound, 0) (0, 0)
host (kCFNotFound, 0) (0, 0)
port (kCFNotFound, 0) (0, 0)
parameter (kCFNotFound, 0) (19, 0)
query (kCFNotFound, 0) (19, 0)
fragment (20, 8) (19, 9)
For the URL scheme://user:pass@host:1/path/path2/file.html;params?query#fragment
Component returned range rangeIncludingSeparators
scheme (0, 6) (0, 9)
net location (9, 16) (6, 19)
path (25, 21) (25, 22)
resource specifier (47, 21) (46, 22)
user (9, 4) (6, 8)
password (14, 4) (13, 6)
user info (9, 9) (6, 13)
host (19, 4) (18, 6)
port (24, 1) (23, 2)
parameter (47, 6) (46, 8)
query (54, 5) (53, 7)
fragment (60, 8) (59, 9)
*/
CF_EXPORT
CFRange CFURLGetByteRangeForComponent(CFURLRef url, CFURLComponentType component, CFRange *rangeIncludingSeparators);
/* Returns a string with any percent-escape sequences that do NOT */
/* correspond to characters in charactersToLeaveEscaped with their */
/* equivalent. Returns NULL on failure (if an invalid percent-escape sequence */
/* is encountered), or the original string (retained) if no characters */
/* need to be replaced. Pass NULL to request that no percent-escapes be */
/* replaced, or the empty string (CFSTR("")) to request that all percent- */
/* escapes be replaced. Uses UTF8 to interpret percent-escapes. */
CF_EXPORT
CFStringRef CFURLCreateStringByReplacingPercentEscapes(CFAllocatorRef allocator, CFStringRef originalString, CFStringRef charactersToLeaveEscaped);
/* As above, but allows you to specify the encoding to use when interpreting percent-escapes */
CF_EXPORT
CFStringRef CFURLCreateStringByReplacingPercentEscapesUsingEncoding(CFAllocatorRef allocator, CFStringRef origString, CFStringRef charsToLeaveEscaped, CFStringEncoding encoding) API_DEPRECATED("Use [NSString stringByRemovingPercentEncoding] or CFURLCreateStringByReplacingPercentEscapes() instead, which always uses the recommended UTF-8 encoding.", macos(10.0,10.11), ios(2.0,9.0), watchos(2.0,2.0), tvos(9.0,9.0));
/* Creates a copy or originalString, replacing certain characters with */
/* the equivalent percent-escape sequence based on the encoding specified. */
/* If the originalString does not need to be modified (no percent-escape */
/* sequences are missing), may retain and return originalString. */
/* If you are uncertain of the correct encoding, you should use UTF-8, */
/* which is the encoding designated by RFC 2396 as the correct encoding */
/* for use in URLs. The characters so escaped are all characters that */
/* are not legal URL characters (based on RFC 2396), plus any characters */
/* in legalURLCharactersToBeEscaped, less any characters in */
/* charactersToLeaveUnescaped. To simply correct any non-URL characters */
/* in an otherwise correct URL string, do: */
/* newString = CFURLCreateStringByAddingPercentEscapes(kCFAllocatorDefault, origString, NULL, NULL, kCFStringEncodingUTF8); */
CF_EXPORT
CFStringRef CFURLCreateStringByAddingPercentEscapes(CFAllocatorRef allocator, CFStringRef originalString, CFStringRef charactersToLeaveUnescaped, CFStringRef legalURLCharactersToBeEscaped, CFStringEncoding encoding) API_DEPRECATED("Use [NSString stringByAddingPercentEncodingWithAllowedCharacters:] instead, which always uses the recommended UTF-8 encoding, and which encodes for a specific URL component or subcomponent (since each URL component or subcomponent has different rules for what characters are valid).", macos(10.0,10.11), ios(2.0,9.0), watchos(2.0,2.0), tvos(9.0,9.0));
#if TARGET_OS_MAC || CF_BUILDING_CF || NSBUILDINGFOUNDATION
CF_IMPLICIT_BRIDGING_DISABLED
/*
CFURLIsFileReferenceURL
Returns whether the URL is a file reference URL.
Parameters
url
The URL specifying the resource.
*/
CF_EXPORT
Boolean CFURLIsFileReferenceURL(CFURLRef url) API_AVAILABLE(macos(10.9), ios(7.0), watchos(2.0), tvos(9.0));
/*
CFURLCreateFileReferenceURL
Returns a new file reference URL that refers to the same resource as a specified URL.
Parameters
allocator
The memory allocator for creating the new URL.
url
The file URL specifying the resource.
error
On output when the result is NULL, the error that occurred. This parameter is optional; if you do not wish the error returned, pass NULL here. The caller is responsible for releasing a valid output error.
Return Value
The new file reference URL, or NULL if an error occurs.
Discussion
File reference URLs use a URL path syntax that identifies a file system object by reference, not by path. This form of file URL remains valid when the file system path of the URL’s underlying resource changes. An error will occur if the url parameter is not a file URL. File reference URLs cannot be created to file system objects which do not exist or are not reachable. In some areas of the file system hierarchy, file reference URLs cannot be generated to the leaf node of the URL path. A file reference URL's path should never be persistently stored because is not valid across system restarts, and across remounts of volumes -- if you want to create a persistent reference to a file system object, use a bookmark (see CFURLCreateBookmarkData). If this function returns NULL, the optional error is populated. This function is currently applicable only to URLs for file system resources.
Symbol is present in iOS 4, but performs no operation.
*/
CF_EXPORT
CFURLRef CFURLCreateFileReferenceURL(CFAllocatorRef allocator, CFURLRef url, CFErrorRef *error) API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/*
CFURLCreateFilePathURL
Returns a new file path URL that refers to the same resource as a specified URL.
Parameters
allocator
The memory allocator for creating the new URL.
url
The file URL specifying the resource.
error
On output when the result is NULL, the error that occurred. This parameter is optional; if you do not wish the error returned, pass NULL here. The caller is responsible for releasing a valid output error.
Return Value
The new file path URL, or NULL if an error occurs.
Discussion
File path URLs use a file system style path. An error will occur if the url parameter is not a file URL. A file reference URL's resource must exist and be reachable to be converted to a file path URL. If this function returns NULL, the optional error is populated. This function is currently applicable only to URLs for file system resources.
Symbol is present in iOS 4, but performs no operation.
*/
CF_EXPORT
CFURLRef CFURLCreateFilePathURL(CFAllocatorRef allocator, CFURLRef url, CFErrorRef *error) API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
CF_IMPLICIT_BRIDGING_ENABLED
#endif
#ifndef CF_OPEN_SOURCE
#if TARGET_OS_OSX || TARGET_OS_IPHONE
struct FSRef;
// Note: CFURLCreateFromFSRef and CFURLGetFSRef have never been functional on iOS because the Carbon File Manager is not on iOS.
CF_EXPORT
CFURLRef CFURLCreateFromFSRef(CFAllocatorRef allocator, const struct FSRef *fsRef) API_DEPRECATED("Not supported", macos(10.0,10.9), ios(2.0,7.0), watchos(2.0,2.0), tvos(9.0,9.0));
CF_EXPORT
Boolean CFURLGetFSRef(CFURLRef url, struct FSRef *fsRef) API_DEPRECATED("Not supported", macos(10.0,10.9), ios(2.0,7.0), watchos(2.0,2.0), tvos(9.0,9.0));
#endif
#endif
#if TARGET_OS_MAC || CF_BUILDING_CF || NSBUILDINGFOUNDATION || DEPLOYMENT_TARGET_SWIFT
CF_IMPLICIT_BRIDGING_DISABLED
/* Resource access
The behavior of resource value caching is slightly different between the NSURL and CFURL API.
When the NSURL methods which get, set, or use cached resource values are used from the main thread, resource values cached by the URL (except those added as temporary properties) are invalidated the next time the main thread's run loop runs.
The CFURL functions do not automatically clear any resource values cached by the URL. The client has complete control over the cache lifetime. If you are using CFURL API, you must use CFURLClearResourcePropertyCacheForKey or CFURLClearResourcePropertyCache to clear cached resource values.
*/
/*
CFURLCopyResourcePropertyForKey
Returns the resource value identified by a given resource key.
Parameters
url
The URL specifying the resource.
key
The resource key that identifies the resource property.
propertyValueTypeRefPtr
On output when the result is true, the resource value or NULL.
error
On output when the result is false, the error that occurred. This parameter is optional; if you do not wish the error returned, pass NULL here. The caller is responsible for releasing a valid output error.
Return Value
true if propertyValueTypeRefPtr is successfully populated; false if an error occurs.
Discussion
CFURLCopyResourcePropertyForKey first checks if the URL object already caches the resource value. If so, it returns the cached resource value to the caller. If not, then CFURLCopyResourcePropertyForKey synchronously obtains the resource value from the backing store, adds the resource value to the URL object's cache, and returns the resource value to the caller. The type of the resource value varies by resource property (see resource key definitions). If this function returns true and propertyValueTypeRefPtr is populated with NULL, it means the resource property is not available for the specified resource and no errors occurred when determining the resource property was not available. If this function returns false, the optional error is populated. This function is currently applicable only to URLs for file system resources.
Symbol is present in iOS 4, but performs no operation.
*/
CF_EXPORT
Boolean CFURLCopyResourcePropertyForKey(CFURLRef url, CFStringRef key, void *propertyValueTypeRefPtr, CFErrorRef *error) API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/*
CFURLCopyResourcePropertiesForKeys
Returns the resource values identified by specified array of resource keys.
Parameters
url
The URL specifying the resource.
keys
An array of resource keys that identify the resource properties.
error
On output when the result is NULL, the error that occurred. This parameter is optional; if you do not wish the error returned, pass NULL here. The caller is responsible for releasing a valid output error.
Return Value
A dictionary of resource values indexed by resource key; NULL if an error occurs.
Discussion
CFURLCopyResourcePropertiesForKeys first checks if the URL object already caches the resource values. If so, it returns the cached resource values to the caller. If not, then CFURLCopyResourcePropertyForKey synchronously obtains the resource values from the backing store, adds the resource values to the URL object's cache, and returns the resource values to the caller. The type of the resource values vary by property (see resource key definitions). If the result dictionary does not contain a resource value for one or more of the requested resource keys, it means those resource properties are not available for the specified resource and no errors occurred when determining those resource properties were not available. If this function returns NULL, the optional error is populated. This function is currently applicable only to URLs for file system resources.
Symbol is present in iOS 4, but performs no operation.
*/
CF_EXPORT
CFDictionaryRef CFURLCopyResourcePropertiesForKeys(CFURLRef url, CFArrayRef keys, CFErrorRef *error) API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/*
CFURLSetResourcePropertyForKey
Sets the resource value identified by a given resource key.
Parameters
url
The URL specifying the resource.
key
The resource key that identifies the resource property.
propertyValue
The resource value.
error
On output when the result is false, the error that occurred. This parameter is optional; if you do not wish the error returned, pass NULL here. The caller is responsible for releasing a valid output error.
Return Value
true if the attempt to set the resource value completed with no errors; otherwise, false.
Discussion
CFURLSetResourcePropertyForKey writes the new resource value out to the backing store. Attempts to set a read-only resource property or to set a resource property not supported by the resource are ignored and are not considered errors. If this function returns false, the optional error is populated. This function is currently applicable only to URLs for file system resources.
Symbol is present in iOS 4, but performs no operation.
*/
CF_EXPORT
Boolean CFURLSetResourcePropertyForKey(CFURLRef url, CFStringRef key, CFTypeRef propertyValue, CFErrorRef *error) API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/*
CFURLSetResourcePropertiesForKeys
Sets any number of resource values of a URL's resource.
Parameters
url
The URL specifying the resource.
keyedPropertyValues
A dictionary of resource values indexed by resource keys.
error
On output when the result is false, the error that occurred. This parameter is optional; if you do not wish the error returned, pass NULL here. The caller is responsible for releasing a valid output error.
Return Value
true if the attempt to set the resource values completed with no errors; otherwise, false.
Discussion
CFURLSetResourcePropertiesForKeys writes the new resource values out to the backing store. Attempts to set read-only resource properties or to set resource properties not supported by the resource are ignored and are not considered errors. If an error occurs after some resource properties have been successfully changed, the userInfo dictionary in the returned error contains an array of resource keys that were not set with the key kCFURLKeysOfUnsetValuesKey. The order in which the resource values are set is not defined. If you need to guarantee the order resource values are set, you should make multiple requests to CFURLSetResourcePropertiesForKeys or CFURLSetResourcePropertyForKey to guarantee the order. If this function returns false, the optional error is populated. This function is currently applicable only to URLs for file system resources.
Symbol is present in iOS 4, but performs no operation.
*/
CF_EXPORT
Boolean CFURLSetResourcePropertiesForKeys(CFURLRef url, CFDictionaryRef keyedPropertyValues, CFErrorRef *error) API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
CF_EXPORT
const CFStringRef kCFURLKeysOfUnsetValuesKey API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/* Key for the resource properties that have not been set after the CFURLSetResourcePropertiesForKeys function returns an error, returned as an array of of CFString objects. */
/*
CFURLClearResourcePropertyCacheForKey
Discards a cached resource value of a URL.
Parameters
url
The URL specifying the resource.
key
The resource key that identifies the resource property.
Discussion
Discarding a cached resource value may discard other cached resource values, because some resource values are cached as a set of values and because some resource values depend on other resource values (temporary properties have no dependencies). This function is currently applicable only to URLs for file system resources.
Symbol is present in iOS 4, but performs no operation.
*/
CF_EXPORT
void CFURLClearResourcePropertyCacheForKey(CFURLRef url, CFStringRef key) API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/*
CFURLClearResourcePropertyCache
Discards all cached resource values of a URL.
Parameters
url
The URL specifying the resource.
Discussion
All temporary properties are also cleared from the URL object's cache. This function is currently applicable only to URLs for file system resources.
Symbol is present in iOS 4, but performs no operation.
*/
CF_EXPORT
void CFURLClearResourcePropertyCache(CFURLRef url) API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/*
CFURLSetTemporaryResourcePropertyForKey
Sets a temporary resource value on the URL object.
Parameters
url
The URL object.
key
The resource key that identifies the temporary resource property.
propertyValue
The resource value.
Discussion
Temporary properties are for client use. Temporary properties exist only in memory and are never written to the resource's backing store. Once set, a temporary value can be copied from the URL object with CFURLCopyResourcePropertyForKey and CFURLCopyResourcePropertiesForKeys. To remove a temporary value from the URL object, use CFURLClearResourcePropertyCacheForKey. Temporary values must be valid Core Foundation types, and will be retained by CFURLSetTemporaryResourcePropertyForKey. Care should be taken to ensure the key that identifies a temporary resource property is unique and does not conflict with system defined keys (using reverse domain name notation in your temporary resource property keys is recommended). This function is currently applicable only to URLs for file system resources.
Symbol is present in iOS 4, but performs no operation.
*/
CF_EXPORT
void CFURLSetTemporaryResourcePropertyForKey(CFURLRef url, CFStringRef key, CFTypeRef propertyValue) API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/*
CFURLResourceIsReachable
Returns whether the URL's resource exists and is reachable.
Parameters
url
The URL object.
error
On output when the result is false, the error that occurred. This parameter is optional; if you do not wish the error returned, pass NULL here. The caller is responsible for releasing a valid output error.
Return Value
true if the resource is reachable; otherwise, false.
Discussion
CFURLResourceIsReachable synchronously checks if the resource's backing store is reachable. Checking reachability is appropriate when making decisions that do not require other immediate operations on the resource, e.g. periodic maintenance of UI state that depends on the existence of a specific document. When performing operations such as opening a file or copying resource properties, it is more efficient to simply try the operation and handle failures. This function is currently applicable only to URLs for file system resources. If this function returns false, the optional error is populated. For other URL types, false is returned.
Symbol is present in iOS 4, but performs no operation.
*/
CF_EXPORT
Boolean CFURLResourceIsReachable(CFURLRef url, CFErrorRef *error) API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
CF_IMPLICIT_BRIDGING_ENABLED
/* Properties of File System Resources */
CF_EXPORT
const CFStringRef kCFURLNameKey API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* The resource name provided by the file system (Read-write, value type CFString) */
CF_EXPORT
const CFStringRef kCFURLLocalizedNameKey API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* Localized or extension-hidden name as displayed to users (Read-only, value type CFString) */
CF_EXPORT
const CFStringRef kCFURLIsRegularFileKey API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* True for regular files (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLIsDirectoryKey API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* True for directories (Read-only, CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLIsSymbolicLinkKey API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* True for symlinks (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLIsVolumeKey API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* True for the root directory of a volume (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLIsPackageKey API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* True for packaged directories (Read-only 10_6 and 10_7, read-write 10_8, value type CFBoolean). Note: You can only set or clear this property on directories; if you try to set this property on non-directory objects, the property is ignored. If the directory is a package for some other reason (extension type, etc), setting this property to false will have no effect. */
CF_EXPORT
const CFStringRef kCFURLIsApplicationKey API_AVAILABLE(macos(10.11), ios(9.0), watchos(2.0), tvos(9.0));
/* True if resource is an application (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLApplicationIsScriptableKey API_AVAILABLE(macos(10.11)) API_UNAVAILABLE(ios, watchos, tvos);
/* True if the resource is scriptable. Only applies to applications. (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLIsSystemImmutableKey API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* True for system-immutable resources (Read-write, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLIsUserImmutableKey API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* True for user-immutable resources (Read-write, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLIsHiddenKey API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* True for resources normally not displayed to users (Read-write, value type CFBoolean). Note: If the resource is a hidden because its name starts with a period, setting this property to false will not change the property. */
CF_EXPORT
const CFStringRef kCFURLHasHiddenExtensionKey API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* True for resources whose filename extension is removed from the localized name property (Read-write, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLCreationDateKey API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* The date the resource was created (Read-write, value type CFDate) */
CF_EXPORT
const CFStringRef kCFURLContentAccessDateKey API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* The date the resource was last accessed (Read-write, value type CFDate) */
CF_EXPORT
const CFStringRef kCFURLContentModificationDateKey API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* The time the resource content was last modified (Read-write, value type CFDate) */
CF_EXPORT
const CFStringRef kCFURLAttributeModificationDateKey API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* The time the resource's attributes were last modified (Read-only, value type CFDate) */
CF_EXPORT
const CFStringRef kCFURLFileContentIdentifierKey API_AVAILABLE(macos(11.0), ios(14.0), watchos(7.0), tvos(14.0));
/* A 64-bit value assigned by APFS that identifies a file's content data stream. Only cloned files and their originals can have the same identifier. (CFNumber) */
CF_EXPORT
const CFStringRef kCFURLMayShareFileContentKey API_AVAILABLE(macos(11.0), ios(14.0), watchos(7.0), tvos(14.0));
/* True for cloned files and their originals that may share all, some, or no data blocks. (CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLMayHaveExtendedAttributesKey API_AVAILABLE(macos(11.0), ios(14.0), watchos(7.0), tvos(14.0));
/* True if the file has extended attributes. False guarantees there are none. (CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLIsPurgeableKey API_AVAILABLE(macos(11.0), ios(14.0), watchos(7.0), tvos(14.0));
/* True if the file can be deleted by the file system when asked to free space. (CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLIsSparseKey API_AVAILABLE(macos(11.0), ios(14.0), watchos(7.0), tvos(14.0));
/* True if the file has sparse regions. (CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLLinkCountKey API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* Number of hard links to the resource (Read-only, value type CFNumber) */
CF_EXPORT
const CFStringRef kCFURLParentDirectoryURLKey API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* The resource's parent directory, if any (Read-only, value type CFURL) */
CF_EXPORT
const CFStringRef kCFURLVolumeURLKey API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* URL of the volume on which the resource is stored (Read-only, value type CFURL) */
CF_EXPORT
const CFStringRef kCFURLTypeIdentifierKey API_DEPRECATED("Use NSURLContentTypeKey instead", macos(10.6, API_TO_BE_DEPRECATED), ios(4.0, API_TO_BE_DEPRECATED), watchos(2.0, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED));
/* Uniform type identifier (UTI) for the resource (Read-only, value type CFString) */
CF_EXPORT
const CFStringRef kCFURLLocalizedTypeDescriptionKey API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* User-visible type or "kind" description (Read-only, value type CFString) */
CF_EXPORT
const CFStringRef kCFURLLabelNumberKey API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* The label number assigned to the resource (Read-write, value type CFNumber) */
CF_EXPORT
const CFStringRef kCFURLLabelColorKey API_DEPRECATED("Use NSURLLabelColorKey", macosx(10.6, 10.12), ios(4.0,10.0), watchos(2.0,3.0), tvos(9.0,10.0));
/* not implemented */
CF_EXPORT
const CFStringRef kCFURLLocalizedLabelKey API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* The user-visible label text (Read-only, value type CFString) */
CF_EXPORT
const CFStringRef kCFURLEffectiveIconKey API_DEPRECATED("Use NSURLEffectiveIconKey", macosx(10.6, 10.12), ios(4.0,10.0), watchos(2.0,3.0), tvos(9.0,10.0));
/* not implemented */
CF_EXPORT
const CFStringRef kCFURLCustomIconKey API_DEPRECATED("Use NSURLCustomIconKey", macosx(10.6, 10.12), ios(4.0,10.0), watchos(2.0,3.0), tvos(9.0,10.0));
/* not implemented */
CF_EXPORT
const CFStringRef kCFURLFileResourceIdentifierKey API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/* An identifier which can be used to compare two file system objects for equality using CFEqual (i.e, two object identifiers are equal if they have the same file system path or if the paths are linked to same inode on the same file system). This identifier is not persistent across system restarts. (Read-only, value type CFType) */
CF_EXPORT
const CFStringRef kCFURLVolumeIdentifierKey API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/* An identifier that can be used to identify the volume the file system object is on. Other objects on the same volume will have the same volume identifier and can be compared using for equality using CFEqual. This identifier is not persistent across system restarts. (Read-only, value type CFType) */
CF_EXPORT
const CFStringRef kCFURLPreferredIOBlockSizeKey API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/* The optimal block size when reading or writing this file's data, or NULL if not available. (Read-only, value type CFNumber) */
CF_EXPORT
const CFStringRef kCFURLIsReadableKey API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/* true if this process (as determined by EUID) can read the resource. (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLIsWritableKey API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/* true if this process (as determined by EUID) can write to the resource. (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLIsExecutableKey API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/* true if this process (as determined by EUID) can execute a file resource or search a directory resource. (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLFileSecurityKey API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/* The file system object's security information encapsulated in a CFFileSecurity object. (Read-write, value type CFFileSecurity) */
CF_EXPORT
const CFStringRef kCFURLIsExcludedFromBackupKey API_AVAILABLE(macos(10.8), ios(5.1), watchos(2.0), tvos(9.0));
/* true if resource should be excluded from backups, false otherwise (Read-write, value type CFBoolean). This property is only useful for excluding cache and other application support files which are not needed in a backup. Some operations commonly made to user documents will cause this property to be reset to false and so this property should not be used on user documents. */
CF_EXPORT
const CFStringRef kCFURLTagNamesKey API_AVAILABLE(macos(10.9)) API_UNAVAILABLE(ios, watchos, tvos);
/* The array of Tag names (Read-write, value type CFArray of CFString) */
CF_EXPORT
const CFStringRef kCFURLPathKey API_AVAILABLE(macos(10.8), ios(6.0), watchos(2.0), tvos(9.0));
/* the URL's path as a file system path (Read-only, value type CFString) */
CF_EXPORT
const CFStringRef kCFURLCanonicalPathKey API_AVAILABLE(macosx(10.12), ios(10.0), watchos(3.0), tvos(10.0));
/* the URL's path as a canonical absolute file system path (Read-only, value type CFString) */
CF_EXPORT
const CFStringRef kCFURLIsMountTriggerKey API_AVAILABLE(macos(10.7), ios(4.0), watchos(2.0), tvos(9.0));
/* true if this URL is a file system trigger directory. Traversing or opening a file system trigger will cause an attempt to mount a file system on the trigger directory. (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLGenerationIdentifierKey API_AVAILABLE(macos(10.10), ios(8.0), watchos(2.0), tvos(9.0));
/* An opaque generation identifier which can be compared using CFEqual() to determine if the data in a document has been modified. For URLs which refer to the same file inode, the generation identifier will change when the data in the file's data fork is changed (changes to extended attributes or other file system metadata do not change the generation identifier). For URLs which refer to the same directory inode, the generation identifier will change when direct children of that directory are added, removed or renamed (changes to the data of the direct children of that directory will not change the generation identifier). The generation identifier is persistent across system restarts. The generation identifier is tied to a specific document on a specific volume and is not transferred when the document is copied to another volume. This property is not supported by all volumes. (Read-only, value type CFType) */
CF_EXPORT
const CFStringRef kCFURLDocumentIdentifierKey API_AVAILABLE(macos(10.10), ios(8.0), watchos(2.0), tvos(9.0));
/* The document identifier -- a value assigned by the kernel to a document (which can be either a file or directory) and is used to identify the document regardless of where it gets moved on a volume. The document identifier survives "safe save” operations; i.e it is sticky to the path it was assigned to (-replaceItemAtURL:withItemAtURL:backupItemName:options:resultingItemURL:error: is the preferred safe-save API). The document identifier is persistent across system restarts. The document identifier is not transferred when the file is copied. Document identifiers are only unique within a single volume. This property is not supported by all volumes. (Read-only, value type CFNumber) */
CF_EXPORT
const CFStringRef kCFURLAddedToDirectoryDateKey API_AVAILABLE(macos(10.10), ios(8.0), watchos(2.0), tvos(9.0));
/* The date the resource was created, or renamed into or within its parent directory. Note that inconsistent behavior may be observed when this attribute is requested on hard-linked items. This property is not supported by all volumes. (Read-only before macOS 10.15, iOS 13.0, watchOS 6.0, and tvOS 13.0; Read-write after, value type CFDate) */
CF_EXPORT
const CFStringRef kCFURLQuarantinePropertiesKey API_AVAILABLE(macos(10.10)) API_UNAVAILABLE(ios, watchos, tvos);
/* The quarantine properties as defined in LSQuarantine.h. To remove quarantine information from a file, pass kCFNull as the value when setting this property. (Read-write, value type CFDictionary) */
CF_EXPORT
const CFStringRef kCFURLFileResourceTypeKey API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/* Returns the file system object type. (Read-only, value type CFString) */
/* The file system object type values returned for the kCFURLFileResourceTypeKey */
CF_EXPORT
const CFStringRef kCFURLFileResourceTypeNamedPipe API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
CF_EXPORT
const CFStringRef kCFURLFileResourceTypeCharacterSpecial API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
CF_EXPORT
const CFStringRef kCFURLFileResourceTypeDirectory API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
CF_EXPORT
const CFStringRef kCFURLFileResourceTypeBlockSpecial API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
CF_EXPORT
const CFStringRef kCFURLFileResourceTypeRegular API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
CF_EXPORT
const CFStringRef kCFURLFileResourceTypeSymbolicLink API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
CF_EXPORT
const CFStringRef kCFURLFileResourceTypeSocket API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
CF_EXPORT
const CFStringRef kCFURLFileResourceTypeUnknown API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/* File Properties */
CF_EXPORT
const CFStringRef kCFURLFileSizeKey API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* Total file size in bytes (Read-only, value type CFNumber) */
CF_EXPORT
const CFStringRef kCFURLFileAllocatedSizeKey API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* Total size allocated on disk for the file in bytes (number of blocks times block size) (Read-only, value type CFNumber) */
CF_EXPORT
const CFStringRef kCFURLTotalFileSizeKey API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/* Total displayable size of the file in bytes (this may include space used by metadata), or NULL if not available. (Read-only, value type CFNumber) */
CF_EXPORT
const CFStringRef kCFURLTotalFileAllocatedSizeKey API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/* Total allocated size of the file in bytes (this may include space used by metadata), or NULL if not available. This can be less than the value returned by kCFURLTotalFileSizeKey if the resource is compressed. (Read-only, value type CFNumber) */
CF_EXPORT
const CFStringRef kCFURLIsAliasFileKey API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* true if the resource is a Finder alias file or a symlink, false otherwise ( Read-only, value type CFBooleanRef) */
CF_EXPORT
const CFStringRef kCFURLFileProtectionKey API_AVAILABLE(ios(9.0), watchos(2.0), tvos(9.0)) API_UNAVAILABLE(macos);
/* The protection level for this file */
/* The protection level values returned for the kCFURLFileProtectionKey */
CF_EXPORT
const CFStringRef kCFURLFileProtectionNone API_AVAILABLE(ios(9.0), watchos(2.0), tvos(9.0)) API_UNAVAILABLE(macos); // The file has no special protections associated with it. It can be read from or written to at any time.
CF_EXPORT
const CFStringRef kCFURLFileProtectionComplete API_AVAILABLE(ios(9.0), watchos(2.0), tvos(9.0)) API_UNAVAILABLE(macos); // The file is stored in an encrypted format on disk and cannot be read from or written to while the device is locked or booting.
CF_EXPORT
const CFStringRef kCFURLFileProtectionCompleteUnlessOpen API_AVAILABLE(ios(9.0), watchos(2.0), tvos(9.0)) API_UNAVAILABLE(macos); // The file is stored in an encrypted format on disk. Files can be created while the device is locked, but once closed, cannot be opened again until the device is unlocked. If the file is opened when unlocked, you may continue to access the file normally, even if the user locks the device. There is a small performance penalty when the file is created and opened, though not when being written to or read from. This can be mitigated by changing the file protection to kCFURLFileProtectionComplete when the device is unlocked.
CF_EXPORT
const CFStringRef kCFURLFileProtectionCompleteUntilFirstUserAuthentication API_AVAILABLE(ios(9.0), watchos(2.0), tvos(9.0)) API_UNAVAILABLE(macos); // The file is stored in an encrypted format on disk and cannot be accessed until after the device has booted. After the user unlocks the device for the first time, your app can access the file and continue to access it even if the user subsequently locks the device.
/* Volume Properties */
/* As a convenience, volume properties can be requested from any file system URL. The value returned will reflect the property value for the volume on which the resource is located. */
CF_EXPORT
const CFStringRef kCFURLVolumeLocalizedFormatDescriptionKey API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* The user-visible volume format (Read-only, value type CFString) */
CF_EXPORT
const CFStringRef kCFURLVolumeTotalCapacityKey API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* Total volume capacity in bytes (Read-only, value type CFNumber) */
CF_EXPORT
const CFStringRef kCFURLVolumeAvailableCapacityKey API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* Total free space in bytes (Read-only, value type CFNumber) */
CF_EXPORT
const CFStringRef kCFURLVolumeAvailableCapacityForImportantUsageKey API_AVAILABLE(macos(10.13), ios(11.0)) API_UNAVAILABLE(watchos, tvos);
/* Total available capacity in bytes for "Important" resources, including space expected to be cleared by purging non-essential and cached resources. "Important" means something that the user or application clearly expects to be present on the local system, but is ultimately replaceable. This would include items that the user has explicitly requested via the UI, and resources that an application requires in order to provide functionality.
Examples: A video that the user has explicitly requested to watch but has not yet finished watching or an audio file that the user has requested to download.
This value should not be used in determining if there is room for an irreplaceable resource. In the case of irreplaceable resources, always attempt to save the resource regardless of available capacity and handle failure as gracefully as possible. (Read-only, value type CFNumber) */
CF_EXPORT
const CFStringRef kCFURLVolumeAvailableCapacityForOpportunisticUsageKey API_AVAILABLE(macos(10.13), ios(11.0)) API_UNAVAILABLE(watchos, tvos);
/* Total available capacity in bytes for "Opportunistic" resources, including space expected to be cleared by purging non-essential and cached resources. "Opportunistic" means something that the user is likely to want but does not expect to be present on the local system, but is ultimately non-essential and replaceable. This would include items that will be created or downloaded without an explicit request from the user on the current device.
Examples: A background download of a newly available episode of a TV series that a user has been recently watching, a piece of content explicitly requested on another device, or a new document saved to a network server by the current user from another device. (Read-only, value type CFNumber) */
CF_EXPORT
const CFStringRef kCFURLVolumeResourceCountKey API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* Total number of resources on the volume (Read-only, value type CFNumber) */
CF_EXPORT
const CFStringRef kCFURLVolumeSupportsPersistentIDsKey API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* true if the volume format supports persistent object identifiers and can look up file system objects by their IDs (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLVolumeSupportsSymbolicLinksKey API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* true if the volume format supports symbolic links (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLVolumeSupportsHardLinksKey API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* true if the volume format supports hard links (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLVolumeSupportsJournalingKey API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* true if the volume format supports a journal used to speed recovery in case of unplanned restart (such as a power outage or crash). This does not necessarily mean the volume is actively using a journal. (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLVolumeIsJournalingKey API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* true if the volume is currently using a journal for speedy recovery after an unplanned restart. (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLVolumeSupportsSparseFilesKey API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* true if the volume format supports sparse files, that is, files which can have 'holes' that have never been written to, and thus do not consume space on disk. A sparse file may have an allocated size on disk that is less than its logical length. (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLVolumeSupportsZeroRunsKey API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* For security reasons, parts of a file (runs) that have never been written to must appear to contain zeroes. true if the volume keeps track of allocated but unwritten runs of a file so that it can substitute zeroes without actually writing zeroes to the media. (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLVolumeSupportsCaseSensitiveNamesKey API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* true if the volume format treats upper and lower case characters in file and directory names as different. Otherwise an upper case character is equivalent to a lower case character, and you can't have two names that differ solely in the case of the characters. (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLVolumeSupportsCasePreservedNamesKey API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* true if the volume format preserves the case of file and directory names. Otherwise the volume may change the case of some characters (typically making them all upper or all lower case). (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLVolumeSupportsRootDirectoryDatesKey API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/* true if the volume supports reliable storage of times for the root directory. (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLVolumeSupportsVolumeSizesKey API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/* true if the volume supports returning volume size values (kCFURLVolumeTotalCapacityKey and kCFURLVolumeAvailableCapacityKey). (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLVolumeSupportsRenamingKey API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/* true if the volume can be renamed. (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLVolumeSupportsAdvisoryFileLockingKey API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/* true if the volume implements whole-file flock(2) style advisory locks, and the O_EXLOCK and O_SHLOCK flags of the open(2) call. (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLVolumeSupportsExtendedSecurityKey API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/* true if the volume implements extended security (ACLs). (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLVolumeIsBrowsableKey API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/* true if the volume should be visible via the GUI (i.e., appear on the Desktop as a separate volume). (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLVolumeMaximumFileSizeKey API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/* The largest file size (in bytes) supported by this file system, or NULL if this cannot be determined. (Read-only, value type CFNumber) */
CF_EXPORT
const CFStringRef kCFURLVolumeIsEjectableKey API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/* true if the volume's media is ejectable from the drive mechanism under software control. (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLVolumeIsRemovableKey API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/* true if the volume's media is removable from the drive mechanism. (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLVolumeIsInternalKey API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/* true if the volume's device is connected to an internal bus, false if connected to an external bus, or NULL if not available. (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLVolumeIsAutomountedKey API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/* true if the volume is automounted. Note: do not mistake this with the functionality provided by kCFURLVolumeSupportsBrowsingKey. (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLVolumeIsLocalKey API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/* true if the volume is stored on a local device. (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLVolumeIsReadOnlyKey API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/* true if the volume is read-only. (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLVolumeCreationDateKey API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/* The volume's creation date, or NULL if this cannot be determined. (Read-only, value type CFDate) */
CF_EXPORT
const CFStringRef kCFURLVolumeURLForRemountingKey API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/* The CFURL needed to remount a network volume, or NULL if not available. (Read-only, value type CFURL) */
CF_EXPORT
const CFStringRef kCFURLVolumeUUIDStringKey API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/* The volume's persistent UUID as a string, or NULL if a persistent UUID is not available for the volume. (Read-only, value type CFString) */
CF_EXPORT
const CFStringRef kCFURLVolumeNameKey API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/* The name of the volume (Read-write, settable if kCFURLVolumeSupportsRenamingKey is true and permissions allow, value type CFString) */
CF_EXPORT
const CFStringRef kCFURLVolumeLocalizedNameKey API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/* The user-presentable name of the volume (Read-only, value type CFString) */
CF_EXPORT
const CFStringRef kCFURLVolumeIsEncryptedKey API_AVAILABLE(macosx(10.12), ios(10.0), watchos(3.0), tvos(10.0));
/* true if the volume is encrypted. (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLVolumeIsRootFileSystemKey API_AVAILABLE(macosx(10.12), ios(10.0), watchos(3.0), tvos(10.0));
/* true if the volume is the root filesystem. (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLVolumeSupportsCompressionKey API_AVAILABLE(macosx(10.12), ios(10.0), watchos(3.0), tvos(10.0));
/* true if the volume supports transparent decompression of compressed files using decmpfs. (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLVolumeSupportsFileCloningKey API_AVAILABLE(macosx(10.12), ios(10.0), watchos(3.0), tvos(10.0));
/* true if the volume supports clonefile(2) (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLVolumeSupportsSwapRenamingKey API_AVAILABLE(macosx(10.12), ios(10.0), watchos(3.0), tvos(10.0));
/* true if the volume supports renamex_np(2)'s RENAME_SWAP option (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLVolumeSupportsExclusiveRenamingKey API_AVAILABLE(macosx(10.12), ios(10.0), watchos(3.0), tvos(10.0));
/* true if the volume supports renamex_np(2)'s RENAME_EXCL option (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLVolumeSupportsImmutableFilesKey API_AVAILABLE(macosx(10.13), ios(11.0), watchos(4.0), tvos(11.0));
/* true if the volume supports making files immutable with the kCFURLIsUserImmutableKey or kCFURLIsSystemImmutableKey properties (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLVolumeSupportsAccessPermissionsKey API_AVAILABLE(macosx(10.13), ios(11.0), watchos(4.0), tvos(11.0));
/* true if the volume supports setting POSIX access permissions with the kCFURLFileSecurityKey property (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLVolumeSupportsFileProtectionKey API_AVAILABLE(macosx(11.0), ios(14.0), watchos(7.0), tvos(14.0));
/* true if the volume supports data protection for files (see kCFURLFileProtectionKey). (Read-only, value type CFBoolean) */
/* UbiquitousItem Properties */
CF_EXPORT
const CFStringRef kCFURLIsUbiquitousItemKey API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/* true if this item is synced to the cloud, false if it is only a local file. (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLUbiquitousItemHasUnresolvedConflictsKey API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/* true if this item has conflicts outstanding. (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLUbiquitousItemIsDownloadedKey API_DEPRECATED("Use kCFURLUbiquitousItemDownloadingStatusKey instead", macos(10.7,10.9), ios(5.0,7.0), watchos(2.0,2.0), tvos(9.0,9.0));
/* Equivalent to NSURLUbiquitousItemDownloadingStatusKey == NSURLUbiquitousItemDownloadingStatusCurrent. Has never behaved as documented in earlier releases, hence deprecated. (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLUbiquitousItemIsDownloadingKey API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/* true if data is being downloaded for this item. (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLUbiquitousItemIsUploadedKey API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/* true if there is data present in the cloud for this item. (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLUbiquitousItemIsUploadingKey API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0));
/* true if data is being uploaded for this item. (Read-only, value type CFBoolean) */
CF_EXPORT
const CFStringRef kCFURLUbiquitousItemPercentDownloadedKey API_DEPRECATED("Use NSMetadataQuery and NSMetadataUbiquitousItemPercentDownloadedKey on NSMetadataItem instead", macos(10.7,10.8), ios(5.0,6.0), watchos(2.0,2.0), tvos(9.0,9.0));
/* Use NSMetadataQuery and NSMetadataUbiquitousItemPercentDownloadedKey on NSMetadataItem instead */
CF_EXPORT
const CFStringRef kCFURLUbiquitousItemPercentUploadedKey API_DEPRECATED("Use NSMetadataQuery and NSMetadataUbiquitousItemPercentUploadedKey on NSMetadataItem instead", macos(10.7,10.8), ios(5.0,6.0), watchos(2.0,2.0), tvos(9.0,9.0));
/* Use NSMetadataQuery and NSMetadataUbiquitousItemPercentUploadedKey on NSMetadataItem instead */
CF_EXPORT
const CFStringRef kCFURLUbiquitousItemDownloadingStatusKey API_AVAILABLE(macos(10.9), ios(7.0), watchos(2.0), tvos(9.0));
/* Returns the download status of this item. (Read-only, value type CFString). Possible values below. */
CF_EXPORT
const CFStringRef kCFURLUbiquitousItemDownloadingErrorKey API_AVAILABLE(macos(10.9), ios(7.0), watchos(2.0), tvos(9.0));
/* returns the error when downloading the item from iCloud failed. See the NSUbiquitousFile section in FoundationErrors.h. (Read-only, value type CFError) */
CF_EXPORT
const CFStringRef kCFURLUbiquitousItemUploadingErrorKey API_AVAILABLE(macos(10.9), ios(7.0), watchos(2.0), tvos(9.0));
/* returns the error when uploading the item to iCloud failed. See the NSUbiquitousFile section in FoundationErrors.h. (Read-only, value type CFError) */
CF_EXPORT
const CFStringRef kCFURLUbiquitousItemIsExcludedFromSyncKey API_AVAILABLE(macos(11.3), ios(14.5), watchos(7.4), tvos(14.5));
/* the item is excluded from sync, which means it is locally on disk but won't be available on the server. An excluded item is no longer ubiquitous. */
/* The values returned for kCFURLUbiquitousItemDownloadingStatusKey
*/
CF_EXPORT
const CFStringRef kCFURLUbiquitousItemDownloadingStatusNotDownloaded API_AVAILABLE(macos(10.9), ios(7.0), watchos(2.0), tvos(9.0));
/* this item has not been downloaded yet. Use NSFileManager's startDownloadingUbiquitousItemAtURL:error: to download it */
CF_EXPORT
const CFStringRef kCFURLUbiquitousItemDownloadingStatusDownloaded API_AVAILABLE(macos(10.9), ios(7.0), watchos(2.0), tvos(9.0));
/* there is a local version of this item available. The most current version will get downloaded as soon as possible. */
CF_EXPORT
const CFStringRef kCFURLUbiquitousItemDownloadingStatusCurrent API_AVAILABLE(macos(10.9), ios(7.0), watchos(2.0), tvos(9.0));
/* there is a local version of this item and it is the most up-to-date version known to this device. */
#if !DEPLOYMENT_TARGET_SWIFT
typedef CF_OPTIONS(CFOptionFlags, CFURLBookmarkCreationOptions) {
kCFURLBookmarkCreationMinimalBookmarkMask = ( 1UL << 9 ), // creates bookmark data with "less" information, which may be smaller but still be able to resolve in certain ways
kCFURLBookmarkCreationSuitableForBookmarkFile = ( 1UL << 10 ), // include the properties required by CFURLWriteBookmarkDataToFile() in the bookmark data created
kCFURLBookmarkCreationWithSecurityScope API_AVAILABLE(macos(10.7), macCatalyst(13.0)) API_UNAVAILABLE(ios, watchos, tvos) = ( 1UL << 11 ), // Mac OS X 10.7.3 and later, include information in the bookmark data which allows the same sandboxed process to access the resource after being relaunched
kCFURLBookmarkCreationSecurityScopeAllowOnlyReadAccess API_AVAILABLE(macos(10.7), macCatalyst(13.0)) API_UNAVAILABLE(ios, watchos, tvos) = ( 1UL << 12 ), // Mac OS X 10.7.3 and later, if used with kCFURLBookmarkCreationWithSecurityScope, at resolution time only read access to the resource will be granted
kCFURLBookmarkCreationWithoutImplicitSecurityScope API_AVAILABLE(macos(10.7), ios(5.0), watchos(2.0), tvos(9.0)) = (1 << 29), // Disable automatic embedding of an implicit security scope. The resolving process will not be able gain access to the resource by security scope, either implicitly or explicitly, through the returned URL. Not applicable to security-scoped bookmarks.
// deprecated
kCFURLBookmarkCreationPreferFileIDResolutionMask
API_DEPRECATED("kCFURLBookmarkCreationPreferFileIDResolutionMask does nothing and has no effect on bookmark resolution", macos(10.6,10.9), ios(4.0,7.0)) = ( 1UL << 8 ),
} API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
typedef CF_OPTIONS(CFOptionFlags, CFURLBookmarkResolutionOptions) {
kCFURLBookmarkResolutionWithoutUIMask = ( 1UL << 8 ), // don't perform any user interaction during bookmark resolution
kCFURLBookmarkResolutionWithoutMountingMask = ( 1UL << 9 ), // don't mount a volume during bookmark resolution
kCFURLBookmarkResolutionWithSecurityScope API_AVAILABLE(macos(10.7), macCatalyst(13.0)) API_UNAVAILABLE(ios, watchos, tvos) = ( 1UL << 10 ), // Mac OS X 10.7.3 and later, use the secure information included at creation time to provide the ability to access the resource in a sandboxed process.
kCFURLBookmarkResolutionWithoutImplicitStartAccessing API_AVAILABLE(macos(11.2), ios(14.2), watchos(7.2), tvos(14.2)) = ( 1 << 15 ), // Disable implicitly starting access of the ephemeral security-scoped resource during resolution. Instead, call `CFURLStartAccessingSecurityScopedResource` on the returned URL when ready to use the resource. Not applicable to security-scoped bookmarks.
kCFBookmarkResolutionWithoutUIMask = kCFURLBookmarkResolutionWithoutUIMask,
kCFBookmarkResolutionWithoutMountingMask = kCFURLBookmarkResolutionWithoutMountingMask,
} API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
typedef CFOptionFlags CFURLBookmarkFileCreationOptions;
CF_IMPLICIT_BRIDGING_DISABLED
/* Returns bookmark data for the URL, created with specified options and resource properties. If this function returns NULL, the optional error is populated.
*/
CF_EXPORT
CFDataRef CFURLCreateBookmarkData ( CFAllocatorRef allocator, CFURLRef url, CFURLBookmarkCreationOptions options, CFArrayRef resourcePropertiesToInclude, CFURLRef relativeToURL, CFErrorRef* error ) API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* Return a URL that refers to a location specified by resolving bookmark data. If this function returns NULL, the optional error is populated.
*/
CF_EXPORT
CFURLRef CFURLCreateByResolvingBookmarkData ( CFAllocatorRef allocator, CFDataRef bookmark, CFURLBookmarkResolutionOptions options, CFURLRef relativeToURL, CFArrayRef resourcePropertiesToInclude, Boolean* isStale, CFErrorRef* error ) API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* Returns the resource propertyies identified by a specified array of keys contained in specified bookmark data. If the result dictionary does not contain a resource value for one or more of the requested resource keys, it means those resource properties are not available in the bookmark data.
*/
CF_EXPORT
CFDictionaryRef CFURLCreateResourcePropertiesForKeysFromBookmarkData ( CFAllocatorRef allocator, CFArrayRef resourcePropertiesToReturn, CFDataRef bookmark ) API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* Returns the resource property identified by a given resource key contained in specified bookmark data. If this function returns NULL, it means the resource property is not available in the bookmark data.
*/
CF_EXPORT
CFTypeRef CFURLCreateResourcePropertyForKeyFromBookmarkData( CFAllocatorRef allocator, CFStringRef resourcePropertyKey, CFDataRef bookmark ) API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* Returns bookmark data derived from an alias file referred to by fileURL. If fileURL refers to an alias file created prior to OS X v10.6 that contains Alias Manager information but no bookmark data, this method synthesizes bookmark data for the file. If this method returns NULL, the optional error is populated.
*/
CF_EXPORT
CFDataRef CFURLCreateBookmarkDataFromFile(CFAllocatorRef allocator, CFURLRef fileURL, CFErrorRef *errorRef ) API_AVAILABLE(macos(10.6), ios(5.0), watchos(2.0), tvos(9.0));
/* Creates an alias file on disk at a specified location with specified bookmark data. The bookmark data must have been created with the kCFURLBookmarkCreationSuitableForBookmarkFile option. fileURL must either refer to an existing file (which will be overwritten), or to location in an existing directory. If this method returns FALSE, the optional error is populated.
*/
CF_EXPORT
Boolean CFURLWriteBookmarkDataToFile( CFDataRef bookmarkRef, CFURLRef fileURL, CFURLBookmarkFileCreationOptions options, CFErrorRef *errorRef ) API_AVAILABLE(macos(10.6), ios(5.0), watchos(2.0), tvos(9.0));
/* Returns bookmark data derived from an alias record.
*/
CF_EXPORT
CFDataRef CFURLCreateBookmarkDataFromAliasRecord ( CFAllocatorRef allocatorRef, CFDataRef aliasRecordDataRef ) API_DEPRECATED("The Carbon Alias Manager is deprecated. This function should only be used to convert Carbon AliasRecords to bookmark data.", macos(10.6,11.0)) API_UNAVAILABLE(ios, watchos, tvos);
CF_IMPLICIT_BRIDGING_ENABLED
/* Given a CFURLRef created by resolving a bookmark data created with security scope, make the resource referenced by the url accessible to the process. When access to this resource is no longer needed the client must call CFURLStopAccessingSecurityScopedResource(). Each call to CFURLStartAccessingSecurityScopedResource() must be balanced with a call to CFURLStopAccessingSecurityScopedResource() (Note: this is not reference counted).
*/
CF_EXPORT
Boolean CFURLStartAccessingSecurityScopedResource(CFURLRef url) API_AVAILABLE(macos(10.7), ios(8.0), watchos(2.0), tvos(9.0)); // On OSX, available in MacOS X 10.7.3 and later
/* Revokes the access granted to the url by a prior successful call to CFURLStartAccessingSecurityScopedResource().
*/
CF_EXPORT
void CFURLStopAccessingSecurityScopedResource(CFURLRef url) API_AVAILABLE(macos(10.7), ios(8.0), watchos(2.0), tvos(9.0)); // On OSX, available in MacOS X 10.7.3 and later
#endif /* !DEPLOYMENT_TARGET_SWIFT */
#endif /* TARGET_OS_MAC || CF_BUILDING_CF || NSBUILDINGFOUNDATION || DEPLOYMENT_TARGET_SWIFT */
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif /* ! __COREFOUNDATION_CFURL__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFMachPort.h | /* CFMachPort.h
Copyright (c) 1998-2019, Apple Inc. and the Swift project authors
Portions Copyright (c) 2014-2019, Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See http://swift.org/LICENSE.txt for license information
See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
*/
#if !defined(__COREFOUNDATION_CFMACHPORT__)
#define __COREFOUNDATION_CFMACHPORT__ 1
#include <CoreFoundation/CFRunLoop.h>
#if TARGET_OS_MAC
#include <mach/port.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
typedef struct CF_BRIDGED_MUTABLE_TYPE(NSMachPort) __CFMachPort * CFMachPortRef;
typedef struct {
CFIndex version;
void * info;
const void *(*retain)(const void *info);
void (*release)(const void *info);
CFStringRef (*copyDescription)(const void *info);
} CFMachPortContext;
typedef void (*CFMachPortCallBack)(CFMachPortRef port, void *msg, CFIndex size, void *info);
typedef void (*CFMachPortInvalidationCallBack)(CFMachPortRef port, void *info);
CF_EXPORT CFTypeID CFMachPortGetTypeID(void);
CF_EXPORT CFMachPortRef CFMachPortCreate(CFAllocatorRef allocator, CFMachPortCallBack callout, CFMachPortContext *context, Boolean *shouldFreeInfo);
CF_EXPORT CFMachPortRef CFMachPortCreateWithPort(CFAllocatorRef allocator, mach_port_t portNum, CFMachPortCallBack callout, CFMachPortContext *context, Boolean *shouldFreeInfo);
CF_EXPORT mach_port_t CFMachPortGetPort(CFMachPortRef port);
CF_EXPORT void CFMachPortGetContext(CFMachPortRef port, CFMachPortContext *context);
CF_EXPORT void CFMachPortInvalidate(CFMachPortRef port);
CF_EXPORT Boolean CFMachPortIsValid(CFMachPortRef port);
CF_EXPORT CFMachPortInvalidationCallBack CFMachPortGetInvalidationCallBack(CFMachPortRef port);
CF_EXPORT void CFMachPortSetInvalidationCallBack(CFMachPortRef port, CFMachPortInvalidationCallBack callout);
CF_EXPORT CFRunLoopSourceRef CFMachPortCreateRunLoopSource(CFAllocatorRef allocator, CFMachPortRef port, CFIndex order);
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif
#endif /* ! __COREFOUNDATION_CFMACHPORT__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFArray.h | /* CFArray.h
Copyright (c) 1998-2019, Apple Inc. All rights reserved.
*/
/*!
@header CFArray
CFArray implements an ordered, compact container of pointer-sized
values. Values are accessed via integer keys (indices), from the
range 0 to N-1, where N is the number of values in the array when
an operation is performed. The array is said to be "compact" because
deleted or inserted values do not leave a gap in the key space --
the values with higher-numbered indices have their indices
renumbered lower (or higher, in the case of insertion) so that the
set of valid indices is always in the integer range [0, N-1]. Thus,
the index to access a particular value in the array may change over
time as other values are inserted into or deleted from the array.
Arrays come in two flavors, immutable, which cannot have values
added to them or removed from them after the array is created, and
mutable, to which you can add values or from which remove values.
Mutable arrays can have an unlimited number of values (or rather,
limited only by constraints external to CFArray, like the amount
of available memory).
As with all CoreFoundation collection types, arrays maintain hard
references on the values you put in them, but the retaining and
releasing functions are user-defined callbacks that can actually do
whatever the user wants (for example, nothing).
Computational Complexity
The access time for a value in the array is guaranteed to be at
worst O(lg N) for any implementation, current and future, but will
often be O(1) (constant time). Linear search operations similarly
have a worst case complexity of O(N*lg N), though typically the
bounds will be tighter, and so on. Insertion or deletion operations
will typically be linear in the number of values in the array, but
may be O(N*lg N) clearly in the worst case in some implementations.
There are no favored positions within the array for performance;
that is, it is not necessarily faster to access values with low
indices, or to insert or delete values with high indices, or
whatever.
*/
#if !defined(__COREFOUNDATION_CFARRAY__)
#define __COREFOUNDATION_CFARRAY__ 1
#include <CoreFoundation/CFBase.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
/*!
@typedef CFArrayCallBacks
Structure containing the callbacks of a CFArray.
@field version The version number of the structure type being passed
in as a parameter to the CFArray creation functions. This
structure is version 0.
@field retain The callback used to add a retain for the array on
values as they are put into the array. This callback returns
the value to store in the array, which is usually the value
parameter passed to this callback, but may be a different
value if a different value should be stored in the array.
The array's allocator is passed as the first argument.
@field release The callback used to remove a retain previously added
for the array from values as they are removed from the
array. The array's allocator is passed as the first
argument.
@field copyDescription The callback used to create a descriptive
string representation of each value in the array. This is
used by the CFCopyDescription() function.
@field equal The callback used to compare values in the array for
equality for some operations.
*/
typedef const void * (*CFArrayRetainCallBack)(CFAllocatorRef allocator, const void *value);
typedef void (*CFArrayReleaseCallBack)(CFAllocatorRef allocator, const void *value);
typedef CFStringRef (*CFArrayCopyDescriptionCallBack)(const void *value);
typedef Boolean (*CFArrayEqualCallBack)(const void *value1, const void *value2);
typedef struct {
CFIndex version;
CFArrayRetainCallBack retain;
CFArrayReleaseCallBack release;
CFArrayCopyDescriptionCallBack copyDescription;
CFArrayEqualCallBack equal;
} CFArrayCallBacks;
/*!
@constant kCFTypeArrayCallBacks
Predefined CFArrayCallBacks structure containing a set of callbacks
appropriate for use when the values in a CFArray are all CFTypes.
*/
CF_EXPORT
const CFArrayCallBacks kCFTypeArrayCallBacks;
/*!
@typedef CFArrayApplierFunction
Type of the callback function used by the apply functions of
CFArrays.
@param value The current value from the array.
@param context The user-defined context parameter given to the apply
function.
*/
typedef void (*CFArrayApplierFunction)(const void *value, void *context);
/*!
@typedef CFArrayRef
This is the type of a reference to immutable CFArrays.
*/
typedef const struct CF_BRIDGED_TYPE(NSArray) __CFArray * CFArrayRef;
/*!
@typedef CFMutableArrayRef
This is the type of a reference to mutable CFArrays.
*/
typedef struct CF_BRIDGED_MUTABLE_TYPE(NSMutableArray) __CFArray * CFMutableArrayRef;
/*!
@function CFArrayGetTypeID
Returns the type identifier of all CFArray instances.
*/
CF_EXPORT
CFTypeID CFArrayGetTypeID(void);
/*!
@function CFArrayCreate
Creates a new immutable array with the given values.
@param allocator The CFAllocator which should be used to allocate
memory for the array and its storage for values. This
parameter may be NULL in which case the current default
CFAllocator is used. If this reference is not a valid
CFAllocator, the behavior is undefined.
@param values A C array of the pointer-sized values to be in the
array. The values in the array are ordered in the same order
in which they appear in this C array. This parameter may be
NULL if the numValues parameter is 0. This C array is not
changed or freed by this function. If this parameter is not
a valid pointer to a C array of at least numValues pointers,
the behavior is undefined.
@param numValues The number of values to copy from the values C
array into the CFArray. This number will be the count of the
array.
If this parameter is negative, or greater than the number of
values actually in the value's C array, the behavior is
undefined.
@param callBacks A pointer to a CFArrayCallBacks structure
initialized with the callbacks for the array to use on each
value in the array. The retain callback will be used within
this function, for example, to retain all of the new values
from the values C array. A copy of the contents of the
callbacks structure is made, so that a pointer to a
structure on the stack can be passed in, or can be reused
for multiple array creations. If the version field of this
callbacks structure is not one of the defined ones for
CFArray, the behavior is undefined. The retain field may be
NULL, in which case the CFArray will do nothing to add a
retain to the contained values for the array. The release
field may be NULL, in which case the CFArray will do nothing
to remove the array's retain (if any) on the values when the
array is destroyed. If the copyDescription field is NULL,
the array will create a simple description for the value. If
the equal field is NULL, the array will use pointer equality
to test for equality of values. This callbacks parameter
itself may be NULL, which is treated as if a valid structure
of version 0 with all fields NULL had been passed in.
Otherwise, if any of the fields are not valid pointers to
functions of the correct type, or this parameter is not a
valid pointer to a CFArrayCallBacks callbacks structure,
the behavior is undefined. If any of the values put into the
array is not one understood by one of the callback functions
the behavior when that callback function is used is
undefined.
@result A reference to the new immutable CFArray.
*/
CF_EXPORT
CFArrayRef CFArrayCreate(CFAllocatorRef allocator, const void **values, CFIndex numValues, const CFArrayCallBacks *callBacks);
/*!
@function CFArrayCreateCopy
Creates a new immutable array with the values from the given array.
@param allocator The CFAllocator which should be used to allocate
memory for the array and its storage for values. This
parameter may be NULL in which case the current default
CFAllocator is used. If this reference is not a valid
CFAllocator, the behavior is undefined.
@param theArray The array which is to be copied. The values from the
array are copied as pointers into the new array (that is,
the values themselves are copied, not that which the values
point to, if anything). However, the values are also
retained by the new array. The count of the new array will
be the same as the given array. The new array uses the same
callbacks as the array to be copied. If this parameter is
not a valid CFArray, the behavior is undefined.
@result A reference to the new immutable CFArray.
*/
CF_EXPORT
CFArrayRef CFArrayCreateCopy(CFAllocatorRef allocator, CFArrayRef theArray);
/*!
@function CFArrayCreateMutable
Creates a new empty mutable array.
@param allocator The CFAllocator which should be used to allocate
memory for the array and its storage for values. This
parameter may be NULL in which case the current default
CFAllocator is used. If this reference is not a valid
CFAllocator, the behavior is undefined.
@param capacity A hint about the number of values that will be held
by the CFArray. Pass 0 for no hint. The implementation may
ignore this hint, or may use it to optimize various
operations. An array's actual capacity is only limited by
address space and available memory constraints). If this
parameter is negative, the behavior is undefined.
@param callBacks A pointer to a CFArrayCallBacks structure
initialized with the callbacks for the array to use on each
value in the array. A copy of the contents of the
callbacks structure is made, so that a pointer to a
structure on the stack can be passed in, or can be reused
for multiple array creations. If the version field of this
callbacks structure is not one of the defined ones for
CFArray, the behavior is undefined. The retain field may be
NULL, in which case the CFArray will do nothing to add a
retain to the contained values for the array. The release
field may be NULL, in which case the CFArray will do nothing
to remove the array's retain (if any) on the values when the
array is destroyed. If the copyDescription field is NULL,
the array will create a simple description for the value. If
the equal field is NULL, the array will use pointer equality
to test for equality of values. This callbacks parameter
itself may be NULL, which is treated as if a valid structure
of version 0 with all fields NULL had been passed in.
Otherwise, if any of the fields are not valid pointers to
functions of the correct type, or this parameter is not a
valid pointer to a CFArrayCallBacks callbacks structure,
the behavior is undefined. If any of the values put into the
array is not one understood by one of the callback functions
the behavior when that callback function is used is
undefined.
@result A reference to the new mutable CFArray.
*/
CF_EXPORT
CFMutableArrayRef CFArrayCreateMutable(CFAllocatorRef allocator, CFIndex capacity, const CFArrayCallBacks *callBacks);
/*!
@function CFArrayCreateMutableCopy
Creates a new mutable array with the values from the given array.
@param allocator The CFAllocator which should be used to allocate
memory for the array and its storage for values. This
parameter may be NULL in which case the current default
CFAllocator is used. If this reference is not a valid
CFAllocator, the behavior is undefined.
@param capacity A hint about the number of values that will be held
by the CFArray. Pass 0 for no hint. The implementation may
ignore this hint, or may use it to optimize various
operations. An array's actual capacity is only limited by
address space and available memory constraints).
This parameter must be greater than or equal
to the count of the array which is to be copied, or the
behavior is undefined. If this parameter is negative, the
behavior is undefined.
@param theArray The array which is to be copied. The values from the
array are copied as pointers into the new array (that is,
the values themselves are copied, not that which the values
point to, if anything). However, the values are also
retained by the new array. The count of the new array will
be the same as the given array. The new array uses the same
callbacks as the array to be copied. If this parameter is
not a valid CFArray, the behavior is undefined.
@result A reference to the new mutable CFArray.
*/
CF_EXPORT
CFMutableArrayRef CFArrayCreateMutableCopy(CFAllocatorRef allocator, CFIndex capacity, CFArrayRef theArray);
/*!
@function CFArrayGetCount
Returns the number of values currently in the array.
@param theArray The array to be queried. If this parameter is not a valid
CFArray, the behavior is undefined.
@result The number of values in the array.
*/
CF_EXPORT
CFIndex CFArrayGetCount(CFArrayRef theArray);
/*!
@function CFArrayGetCountOfValue
Counts the number of times the given value occurs in the array.
@param theArray The array to be searched. If this parameter is not a
valid CFArray, the behavior is undefined.
@param range The range within the array to search. If the range
location or end point (defined by the location plus length
minus 1) is outside the index space of the array (0 to
N-1 inclusive, where N is the count of the array), the
behavior is undefined. If the range length is negative, the
behavior is undefined. The range may be empty (length 0).
@param value The value for which to find matches in the array. The
equal() callback provided when the array was created is
used to compare. If the equal() callback was NULL, pointer
equality (in C, ==) is used. If value, or any of the values
in the array, are not understood by the equal() callback,
the behavior is undefined.
@result The number of times the given value occurs in the array,
within the specified range.
*/
CF_EXPORT
CFIndex CFArrayGetCountOfValue(CFArrayRef theArray, CFRange range, const void *value);
/*!
@function CFArrayContainsValue
Reports whether or not the value is in the array.
@param theArray The array to be searched. If this parameter is not a
valid CFArray, the behavior is undefined.
@param range The range within the array to search. If the range
location or end point (defined by the location plus length
minus 1) is outside the index space of the array (0 to
N-1 inclusive, where N is the count of the array), the
behavior is undefined. If the range length is negative, the
behavior is undefined. The range may be empty (length 0).
@param value The value for which to find matches in the array. The
equal() callback provided when the array was created is
used to compare. If the equal() callback was NULL, pointer
equality (in C, ==) is used. If value, or any of the values
in the array, are not understood by the equal() callback,
the behavior is undefined.
@result true, if the value is in the specified range of the array,
otherwise false.
*/
CF_EXPORT
Boolean CFArrayContainsValue(CFArrayRef theArray, CFRange range, const void *value);
/*!
@function CFArrayGetValueAtIndex
Retrieves the value at the given index.
@param theArray The array to be queried. If this parameter is not a
valid CFArray, the behavior is undefined.
@param idx The index of the value to retrieve. If the index is
outside the index space of the array (0 to N-1 inclusive,
where N is the count of the array), the behavior is
undefined.
@result The value with the given index in the array.
*/
CF_EXPORT
const void *CFArrayGetValueAtIndex(CFArrayRef theArray, CFIndex idx);
/*!
@function CFArrayGetValues
Fills the buffer with values from the array.
@param theArray The array to be queried. If this parameter is not a
valid CFArray, the behavior is undefined.
@param range The range of values within the array to retrieve. If
the range location or end point (defined by the location
plus length minus 1) is outside the index space of the
array (0 to N-1 inclusive, where N is the count of the
array), the behavior is undefined. If the range length is
negative, the behavior is undefined. The range may be empty
(length 0), in which case no values are put into the buffer.
@param values A C array of pointer-sized values to be filled with
values from the array. The values in the C array are ordered
in the same order in which they appear in the array. If this
parameter is not a valid pointer to a C array of at least
range.length pointers, the behavior is undefined.
*/
CF_EXPORT
void CFArrayGetValues(CFArrayRef theArray, CFRange range, const void **values);
/*!
@function CFArrayApplyFunction
Calls a function once for each value in the array.
@param theArray The array to be operated upon. If this parameter is not
a valid CFArray, the behavior is undefined.
@param range The range of values within the array to which to apply
the function. If the range location or end point (defined by
the location plus length minus 1) is outside the index
space of the array (0 to N-1 inclusive, where N is the count
of the array), the behavior is undefined. If the range
length is negative, the behavior is undefined. The range may
be empty (length 0).
@param applier The callback function to call once for each value in
the given range in the array. If this parameter is not a
pointer to a function of the correct prototype, the behavior
is undefined. If there are values in the range which the
applier function does not expect or cannot properly apply
to, the behavior is undefined.
@param context A pointer-sized user-defined value, which is passed
as the second parameter to the applier function, but is
otherwise unused by this function. If the context is not
what is expected by the applier function, the behavior is
undefined.
*/
CF_EXPORT
void CFArrayApplyFunction(CFArrayRef theArray, CFRange range, CFArrayApplierFunction CF_NOESCAPE applier, void *context);
/*!
@function CFArrayGetFirstIndexOfValue
Searches the array for the value.
@param theArray The array to be searched. If this parameter is not a
valid CFArray, the behavior is undefined.
@param range The range within the array to search. If the range
location or end point (defined by the location plus length
minus 1) is outside the index space of the array (0 to
N-1 inclusive, where N is the count of the array), the
behavior is undefined. If the range length is negative, the
behavior is undefined. The range may be empty (length 0).
The search progresses from the smallest index defined by
the range to the largest.
@param value The value for which to find a match in the array. The
equal() callback provided when the array was created is
used to compare. If the equal() callback was NULL, pointer
equality (in C, ==) is used. If value, or any of the values
in the array, are not understood by the equal() callback,
the behavior is undefined.
@result The lowest index of the matching values in the range, or
kCFNotFound if no value in the range matched.
*/
CF_EXPORT
CFIndex CFArrayGetFirstIndexOfValue(CFArrayRef theArray, CFRange range, const void *value);
/*!
@function CFArrayGetLastIndexOfValue
Searches the array for the value.
@param theArray The array to be searched. If this parameter is not a
valid CFArray, the behavior is undefined.
@param range The range within the array to search. If the range
location or end point (defined by the location plus length
minus 1) is outside the index space of the array (0 to
N-1 inclusive, where N is the count of the array), the
behavior is undefined. If the range length is negative, the
behavior is undefined. The range may be empty (length 0).
The search progresses from the largest index defined by the
range to the smallest.
@param value The value for which to find a match in the array. The
equal() callback provided when the array was created is
used to compare. If the equal() callback was NULL, pointer
equality (in C, ==) is used. If value, or any of the values
in the array, are not understood by the equal() callback,
the behavior is undefined.
@result The highest index of the matching values in the range, or
kCFNotFound if no value in the range matched.
*/
CF_EXPORT
CFIndex CFArrayGetLastIndexOfValue(CFArrayRef theArray, CFRange range, const void *value);
/*!
@function CFArrayBSearchValues
Searches the array for the value using a binary search algorithm.
@param theArray The array to be searched. If this parameter is not a
valid CFArray, the behavior is undefined. If the array is
not sorted from least to greatest according to the
comparator function, the behavior is undefined.
@param range The range within the array to search. If the range
location or end point (defined by the location plus length
minus 1) is outside the index space of the array (0 to
N-1 inclusive, where N is the count of the array), the
behavior is undefined. If the range length is negative, the
behavior is undefined. The range may be empty (length 0).
@param value The value for which to find a match in the array. If
value, or any of the values in the array, are not understood
by the comparator callback, the behavior is undefined.
@param comparator The function with the comparator function type
signature which is used in the binary search operation to
compare values in the array with the given value. If this
parameter is not a pointer to a function of the correct
prototype, the behavior is undefined. If there are values
in the range which the comparator function does not expect
or cannot properly compare, the behavior is undefined.
@param context A pointer-sized user-defined value, which is passed
as the third parameter to the comparator function, but is
otherwise unused by this function. If the context is not
what is expected by the comparator function, the behavior is
undefined.
@result The return value is either 1) the index of a value that
matched, if the target value matches one or more in the
range, 2) greater than or equal to the end point of the
range, if the value is greater than all the values in the
range, or 3) the index of the value greater than the target
value, if the value lies between two of (or less than all
of) the values in the range.
*/
CF_EXPORT
CFIndex CFArrayBSearchValues(CFArrayRef theArray, CFRange range, const void *value, CFComparatorFunction comparator, void *context);
/*!
@function CFArrayAppendValue
Adds the value to the array giving it a new largest index.
@param theArray The array to which the value is to be added. If this
parameter is not a valid mutable CFArray, the behavior is
undefined.
@param value The value to add to the array. The value is retained by
the array using the retain callback provided when the array
was created. If the value is not of the sort expected by the
retain callback, the behavior is undefined. The value is
assigned to the index one larger than the previous largest
index, and the count of the array is increased by one.
*/
CF_EXPORT
void CFArrayAppendValue(CFMutableArrayRef theArray, const void *value);
/*!
@function CFArrayInsertValueAtIndex
Adds the value to the array, giving it the given index.
@param theArray The array to which the value is to be added. If this
parameter is not a valid mutable CFArray, the behavior is
undefined.
@param idx The index to which to add the new value. If the index is
outside the index space of the array (0 to N inclusive,
where N is the count of the array before the operation), the
behavior is undefined. If the index is the same as N, this
function has the same effect as CFArrayAppendValue().
@param value The value to add to the array. The value is retained by
the array using the retain callback provided when the array
was created. If the value is not of the sort expected by the
retain callback, the behavior is undefined. The value is
assigned to the given index, and all values with equal and
larger indices have their indexes increased by one.
*/
CF_EXPORT
void CFArrayInsertValueAtIndex(CFMutableArrayRef theArray, CFIndex idx, const void *value);
/*!
@function CFArraySetValueAtIndex
Changes the value with the given index in the array.
@param theArray The array in which the value is to be changed. If this
parameter is not a valid mutable CFArray, the behavior is
undefined.
@param idx The index to which to set the new value. If the index is
outside the index space of the array (0 to N inclusive,
where N is the count of the array before the operation), the
behavior is undefined. If the index is the same as N, this
function has the same effect as CFArrayAppendValue().
@param value The value to set in the array. The value is retained by
the array using the retain callback provided when the array
was created, and the previous value with that index is
released. If the value is not of the sort expected by the
retain callback, the behavior is undefined. The indices of
other values is not affected.
*/
CF_EXPORT
void CFArraySetValueAtIndex(CFMutableArrayRef theArray, CFIndex idx, const void *value);
/*!
@function CFArrayRemoveValueAtIndex
Removes the value with the given index from the array.
@param theArray The array from which the value is to be removed. If
this parameter is not a valid mutable CFArray, the behavior
is undefined.
@param idx The index from which to remove the value. If the index is
outside the index space of the array (0 to N-1 inclusive,
where N is the count of the array before the operation), the
behavior is undefined.
*/
CF_EXPORT
void CFArrayRemoveValueAtIndex(CFMutableArrayRef theArray, CFIndex idx);
/*!
@function CFArrayRemoveAllValues
Removes all the values from the array, making it empty.
@param theArray The array from which all of the values are to be
removed. If this parameter is not a valid mutable CFArray,
the behavior is undefined.
*/
CF_EXPORT
void CFArrayRemoveAllValues(CFMutableArrayRef theArray);
/*!
@function CFArrayReplaceValues
Replaces a range of values in the array.
@param theArray The array from which all of the values are to be
removed. If this parameter is not a valid mutable CFArray,
the behavior is undefined.
@param range The range of values within the array to replace. If the
range location or end point (defined by the location plus
length minus 1) is outside the index space of the array (0
to N inclusive, where N is the count of the array), the
behavior is undefined. If the range length is negative, the
behavior is undefined. The range may be empty (length 0),
in which case the new values are merely inserted at the
range location.
@param newValues A C array of the pointer-sized values to be placed
into the array. The new values in the array are ordered in
the same order in which they appear in this C array. This
parameter may be NULL if the newCount parameter is 0. This
C array is not changed or freed by this function. If this
parameter is not a valid pointer to a C array of at least
newCount pointers, the behavior is undefined.
@param newCount The number of values to copy from the values C
array into the CFArray. If this parameter is different than
the range length, the excess newCount values will be
inserted after the range, or the excess range values will be
deleted. This parameter may be 0, in which case no new
values are replaced into the array and the values in the
range are simply removed. If this parameter is negative, or
greater than the number of values actually in the newValues
C array, the behavior is undefined.
*/
CF_EXPORT
void CFArrayReplaceValues(CFMutableArrayRef theArray, CFRange range, const void **newValues, CFIndex newCount);
/*!
@function CFArrayExchangeValuesAtIndices
Exchanges the values at two indices of the array.
@param theArray The array of which the values are to be swapped. If
this parameter is not a valid mutable CFArray, the behavior
is undefined.
@param idx1 The first index whose values should be swapped. If the
index is outside the index space of the array (0 to N-1
inclusive, where N is the count of the array before the
operation), the behavior is undefined.
@param idx2 The second index whose values should be swapped. If the
index is outside the index space of the array (0 to N-1
inclusive, where N is the count of the array before the
operation), the behavior is undefined.
*/
CF_EXPORT
void CFArrayExchangeValuesAtIndices(CFMutableArrayRef theArray, CFIndex idx1, CFIndex idx2);
/*!
@function CFArraySortValues
Sorts the values in the array using the given comparison function.
@param theArray The array whose values are to be sorted. If this
parameter is not a valid mutable CFArray, the behavior is
undefined.
@param range The range of values within the array to sort. If the
range location or end point (defined by the location plus
length minus 1) is outside the index space of the array (0
to N-1 inclusive, where N is the count of the array), the
behavior is undefined. If the range length is negative, the
behavior is undefined. The range may be empty (length 0).
@param comparator The function with the comparator function type
signature which is used in the sort operation to compare
values in the array with the given value. If this parameter
is not a pointer to a function of the correct prototype, the
the behavior is undefined. If there are values in the array
which the comparator function does not expect or cannot
properly compare, the behavior is undefined. The values in
the range are sorted from least to greatest according to
this function.
@param context A pointer-sized user-defined value, which is passed
as the third parameter to the comparator function, but is
otherwise unused by this function. If the context is not
what is expected by the comparator function, the behavior is
undefined.
*/
CF_EXPORT
void CFArraySortValues(CFMutableArrayRef theArray, CFRange range, CFComparatorFunction comparator, void *context);
/*!
@function CFArrayAppendArray
Adds the values from an array to another array.
@param theArray The array to which values from the otherArray are to
be added. If this parameter is not a valid mutable CFArray,
the behavior is undefined.
@param otherArray The array providing the values to be added to the
array. If this parameter is not a valid CFArray, the
behavior is undefined.
@param otherRange The range within the otherArray from which to add
the values to the array. If the range location or end point
(defined by the location plus length minus 1) is outside
the index space of the otherArray (0 to N-1 inclusive, where
N is the count of the otherArray), the behavior is
undefined. The new values are retained by the array using
the retain callback provided when the array was created. If
the values are not of the sort expected by the retain
callback, the behavior is undefined. The values are assigned
to the indices one larger than the previous largest index
in the array, and beyond, and the count of the array is
increased by range.length. The values are assigned new
indices in the array from smallest to largest index in the
order in which they appear in the otherArray.
*/
CF_EXPORT
void CFArrayAppendArray(CFMutableArrayRef theArray, CFArrayRef otherArray, CFRange otherRange);
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif /* ! __COREFOUNDATION_CFARRAY__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFStringEncodingExt.h | /* CFStringEncodingExt.h
Copyright (c) 1998-2019, Apple Inc. and the Swift project authors
Portions Copyright (c) 2014-2019, Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See http://swift.org/LICENSE.txt for license information
See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
*/
#if !defined(__COREFOUNDATION_CFSTRINGENCODINGEXT__)
#define __COREFOUNDATION_CFSTRINGENCODINGEXT__ 1
#include <CoreFoundation/CFBase.h>
CF_EXTERN_C_BEGIN
typedef CF_ENUM(CFIndex, CFStringEncodings) {
/* kCFStringEncodingMacRoman = 0L, defined in CoreFoundation/CFString.h */
kCFStringEncodingMacJapanese = 1,
kCFStringEncodingMacChineseTrad = 2,
kCFStringEncodingMacKorean = 3,
kCFStringEncodingMacArabic = 4,
kCFStringEncodingMacHebrew = 5,
kCFStringEncodingMacGreek = 6,
kCFStringEncodingMacCyrillic = 7,
kCFStringEncodingMacDevanagari = 9,
kCFStringEncodingMacGurmukhi = 10,
kCFStringEncodingMacGujarati = 11,
kCFStringEncodingMacOriya = 12,
kCFStringEncodingMacBengali = 13,
kCFStringEncodingMacTamil = 14,
kCFStringEncodingMacTelugu = 15,
kCFStringEncodingMacKannada = 16,
kCFStringEncodingMacMalayalam = 17,
kCFStringEncodingMacSinhalese = 18,
kCFStringEncodingMacBurmese = 19,
kCFStringEncodingMacKhmer = 20,
kCFStringEncodingMacThai = 21,
kCFStringEncodingMacLaotian = 22,
kCFStringEncodingMacGeorgian = 23,
kCFStringEncodingMacArmenian = 24,
kCFStringEncodingMacChineseSimp = 25,
kCFStringEncodingMacTibetan = 26,
kCFStringEncodingMacMongolian = 27,
kCFStringEncodingMacEthiopic = 28,
kCFStringEncodingMacCentralEurRoman = 29,
kCFStringEncodingMacVietnamese = 30,
kCFStringEncodingMacExtArabic = 31,
/* The following use script code 0, smRoman */
kCFStringEncodingMacSymbol = 33,
kCFStringEncodingMacDingbats = 34,
kCFStringEncodingMacTurkish = 35,
kCFStringEncodingMacCroatian = 36,
kCFStringEncodingMacIcelandic = 37,
kCFStringEncodingMacRomanian = 38,
kCFStringEncodingMacCeltic = 39,
kCFStringEncodingMacGaelic = 40,
/* The following use script code 4, smArabic */
kCFStringEncodingMacFarsi = 0x8C, /* Like MacArabic but uses Farsi digits */
/* The following use script code 7, smCyrillic */
kCFStringEncodingMacUkrainian = 0x98,
/* The following use script code 32, smUnimplemented */
kCFStringEncodingMacInuit = 0xEC,
kCFStringEncodingMacVT100 = 0xFC, /* VT100/102 font from Comm Toolbox: Latin-1 repertoire + box drawing etc */
/* Special Mac OS encodings*/
kCFStringEncodingMacHFS = 0xFF, /* Meta-value, should never appear in a table */
/* Unicode & ISO UCS encodings begin at 0x100 */
/* We don't use Unicode variations defined in TextEncoding; use the ones in CFString.h, instead. */
/* ISO 8-bit and 7-bit encodings begin at 0x200 */
/* kCFStringEncodingISOLatin1 = 0x0201, defined in CoreFoundation/CFString.h */
kCFStringEncodingISOLatin2 = 0x0202, /* ISO 8859-2 */
kCFStringEncodingISOLatin3 = 0x0203, /* ISO 8859-3 */
kCFStringEncodingISOLatin4 = 0x0204, /* ISO 8859-4 */
kCFStringEncodingISOLatinCyrillic = 0x0205, /* ISO 8859-5 */
kCFStringEncodingISOLatinArabic = 0x0206, /* ISO 8859-6, =ASMO 708, =DOS CP 708 */
kCFStringEncodingISOLatinGreek = 0x0207, /* ISO 8859-7 */
kCFStringEncodingISOLatinHebrew = 0x0208, /* ISO 8859-8 */
kCFStringEncodingISOLatin5 = 0x0209, /* ISO 8859-9 */
kCFStringEncodingISOLatin6 = 0x020A, /* ISO 8859-10 */
kCFStringEncodingISOLatinThai = 0x020B, /* ISO 8859-11 */
kCFStringEncodingISOLatin7 = 0x020D, /* ISO 8859-13 */
kCFStringEncodingISOLatin8 = 0x020E, /* ISO 8859-14 */
kCFStringEncodingISOLatin9 = 0x020F, /* ISO 8859-15 */
kCFStringEncodingISOLatin10 = 0x0210, /* ISO 8859-16 */
/* MS-DOS & Windows encodings begin at 0x400 */
kCFStringEncodingDOSLatinUS = 0x0400, /* code page 437 */
kCFStringEncodingDOSGreek = 0x0405, /* code page 737 (formerly code page 437G) */
kCFStringEncodingDOSBalticRim = 0x0406, /* code page 775 */
kCFStringEncodingDOSLatin1 = 0x0410, /* code page 850, "Multilingual" */
kCFStringEncodingDOSGreek1 = 0x0411, /* code page 851 */
kCFStringEncodingDOSLatin2 = 0x0412, /* code page 852, Slavic */
kCFStringEncodingDOSCyrillic = 0x0413, /* code page 855, IBM Cyrillic */
kCFStringEncodingDOSTurkish = 0x0414, /* code page 857, IBM Turkish */
kCFStringEncodingDOSPortuguese = 0x0415, /* code page 860 */
kCFStringEncodingDOSIcelandic = 0x0416, /* code page 861 */
kCFStringEncodingDOSHebrew = 0x0417, /* code page 862 */
kCFStringEncodingDOSCanadianFrench = 0x0418, /* code page 863 */
kCFStringEncodingDOSArabic = 0x0419, /* code page 864 */
kCFStringEncodingDOSNordic = 0x041A, /* code page 865 */
kCFStringEncodingDOSRussian = 0x041B, /* code page 866 */
kCFStringEncodingDOSGreek2 = 0x041C, /* code page 869, IBM Modern Greek */
kCFStringEncodingDOSThai = 0x041D, /* code page 874, also for Windows */
kCFStringEncodingDOSJapanese = 0x0420, /* code page 932, also for Windows */
kCFStringEncodingDOSChineseSimplif = 0x0421, /* code page 936, also for Windows */
kCFStringEncodingDOSKorean = 0x0422, /* code page 949, also for Windows; Unified Hangul Code */
kCFStringEncodingDOSChineseTrad = 0x0423, /* code page 950, also for Windows */
/* kCFStringEncodingWindowsLatin1 = 0x0500, defined in CoreFoundation/CFString.h */
kCFStringEncodingWindowsLatin2 = 0x0501, /* code page 1250, Central Europe */
kCFStringEncodingWindowsCyrillic = 0x0502, /* code page 1251, Slavic Cyrillic */
kCFStringEncodingWindowsGreek = 0x0503, /* code page 1253 */
kCFStringEncodingWindowsLatin5 = 0x0504, /* code page 1254, Turkish */
kCFStringEncodingWindowsHebrew = 0x0505, /* code page 1255 */
kCFStringEncodingWindowsArabic = 0x0506, /* code page 1256 */
kCFStringEncodingWindowsBalticRim = 0x0507, /* code page 1257 */
kCFStringEncodingWindowsVietnamese = 0x0508, /* code page 1258 */
kCFStringEncodingWindowsKoreanJohab = 0x0510, /* code page 1361, for Windows NT */
/* Various national standards begin at 0x600 */
/* kCFStringEncodingASCII = 0x0600, defined in CoreFoundation/CFString.h */
kCFStringEncodingANSEL = 0x0601, /* ANSEL (ANSI Z39.47) */
kCFStringEncodingJIS_X0201_76 = 0x0620,
kCFStringEncodingJIS_X0208_83 = 0x0621,
kCFStringEncodingJIS_X0208_90 = 0x0622,
kCFStringEncodingJIS_X0212_90 = 0x0623,
kCFStringEncodingJIS_C6226_78 = 0x0624,
kCFStringEncodingShiftJIS_X0213 API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)) = 0x0628, /* Shift-JIS format encoding of JIS X0213 planes 1 and 2*/
kCFStringEncodingShiftJIS_X0213_MenKuTen = 0x0629, /* JIS X0213 in plane-row-column notation */
kCFStringEncodingGB_2312_80 = 0x0630,
kCFStringEncodingGBK_95 = 0x0631, /* annex to GB 13000-93; for Windows 95 */
kCFStringEncodingGB_18030_2000 = 0x0632,
kCFStringEncodingKSC_5601_87 = 0x0640, /* same as KSC 5601-92 without Johab annex */
kCFStringEncodingKSC_5601_92_Johab = 0x0641, /* KSC 5601-92 Johab annex */
kCFStringEncodingCNS_11643_92_P1 = 0x0651, /* CNS 11643-1992 plane 1 */
kCFStringEncodingCNS_11643_92_P2 = 0x0652, /* CNS 11643-1992 plane 2 */
kCFStringEncodingCNS_11643_92_P3 = 0x0653, /* CNS 11643-1992 plane 3 (was plane 14 in 1986 version) */
/* ISO 2022 collections begin at 0x800 */
kCFStringEncodingISO_2022_JP = 0x0820,
kCFStringEncodingISO_2022_JP_2 = 0x0821,
kCFStringEncodingISO_2022_JP_1 = 0x0822, /* RFC 2237*/
kCFStringEncodingISO_2022_JP_3 = 0x0823, /* JIS X0213*/
kCFStringEncodingISO_2022_CN = 0x0830,
kCFStringEncodingISO_2022_CN_EXT = 0x0831,
kCFStringEncodingISO_2022_KR = 0x0840,
/* EUC collections begin at 0x900 */
kCFStringEncodingEUC_JP = 0x0920, /* ISO 646, 1-byte katakana, JIS 208, JIS 212 */
kCFStringEncodingEUC_CN = 0x0930, /* ISO 646, GB 2312-80 */
kCFStringEncodingEUC_TW = 0x0931, /* ISO 646, CNS 11643-1992 Planes 1-16 */
kCFStringEncodingEUC_KR = 0x0940, /* ISO 646, KS C 5601-1987 */
/* Misc standards begin at 0xA00 */
kCFStringEncodingShiftJIS = 0x0A01, /* plain Shift-JIS */
kCFStringEncodingKOI8_R = 0x0A02, /* Russian internet standard */
kCFStringEncodingBig5 = 0x0A03, /* Big-5 (has variants) */
kCFStringEncodingMacRomanLatin1 = 0x0A04, /* Mac OS Roman permuted to align with ISO Latin-1 */
kCFStringEncodingHZ_GB_2312 = 0x0A05, /* HZ (RFC 1842, for Chinese mail & news) */
kCFStringEncodingBig5_HKSCS_1999 = 0x0A06, /* Big-5 with Hong Kong special char set supplement*/
kCFStringEncodingVISCII = 0x0A07, /* RFC 1456, Vietnamese */
kCFStringEncodingKOI8_U = 0x0A08, /* RFC 2319, Ukrainian */
kCFStringEncodingBig5_E = 0x0A09, /* Taiwan Big-5E standard */
/* Other platform encodings*/
/* kCFStringEncodingNextStepLatin = 0x0B01, defined in CoreFoundation/CFString.h */
kCFStringEncodingNextStepJapanese = 0x0B02, /* NextStep Japanese encoding */
/* EBCDIC & IBM host encodings begin at 0xC00 */
kCFStringEncodingEBCDIC_US = 0x0C01, /* basic EBCDIC-US */
kCFStringEncodingEBCDIC_CP037 = 0x0C02, /* code page 037, extended EBCDIC (Latin-1 set) for US,Canada... */
kCFStringEncodingUTF7 API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0)) = 0x04000100, /* kTextEncodingUnicodeDefault + kUnicodeUTF7Format RFC2152 */
kCFStringEncodingUTF7_IMAP API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0)) = 0x0A10, /* UTF-7 (IMAP folder variant) RFC3501 */
/* Deprecated constants */
kCFStringEncodingShiftJIS_X0213_00 = 0x0628 /* Shift-JIS format encoding of JIS X0213 planes 1 and 2 (DEPRECATED) */
};
CF_EXTERN_C_END
#endif /* ! __COREFOUNDATION_CFSTRINGENCODINGEXT__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFNotificationCenter.h | /* CFNotificationCenter.h
Copyright (c) 1998-2019, Apple Inc. and the Swift project authors
Portions Copyright (c) 2014-2019, Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See http://swift.org/LICENSE.txt for license information
See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
*/
#if !defined(__COREFOUNDATION_CFNOTIFICATIONCENTER__)
#define __COREFOUNDATION_CFNOTIFICATIONCENTER__ 1
#include <CoreFoundation/CFBase.h>
#include <CoreFoundation/CFDictionary.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
typedef CFStringRef CFNotificationName CF_EXTENSIBLE_STRING_ENUM;
typedef struct CF_BRIDGED_MUTABLE_TYPE(id) __CFNotificationCenter * CFNotificationCenterRef;
typedef void (*CFNotificationCallback)(CFNotificationCenterRef center, void *observer, CFNotificationName name, const void *object, CFDictionaryRef userInfo);
typedef CF_ENUM(CFIndex, CFNotificationSuspensionBehavior) {
CFNotificationSuspensionBehaviorDrop = 1,
// The server will not queue any notifications with this name and object while the process/app is in the background.
CFNotificationSuspensionBehaviorCoalesce = 2,
// The server will only queue the last notification of the specified name and object; earlier notifications are dropped.
CFNotificationSuspensionBehaviorHold = 3,
// The server will hold all matching notifications until the queue has been filled (queue size determined by the server) at which point the server may flush queued notifications.
CFNotificationSuspensionBehaviorDeliverImmediately = 4
// The server will deliver notifications matching this registration whether or not the process is in the background. When a notification with this suspension behavior is matched, it has the effect of first flushing any queued notifications.
};
CF_EXPORT CFTypeID CFNotificationCenterGetTypeID(void);
CF_EXPORT CFNotificationCenterRef CFNotificationCenterGetLocalCenter(void);
#if TARGET_OS_OSX || TARGET_OS_WIN32
CF_EXPORT CFNotificationCenterRef CFNotificationCenterGetDistributedCenter(void);
#endif
CF_EXPORT CFNotificationCenterRef CFNotificationCenterGetDarwinNotifyCenter(void);
// The Darwin Notify Center is based on the <notify.h> API.
// For this center, there are limitations in the API. There are no notification "objects",
// "userInfo" cannot be passed in the notification, and there are no suspension behaviors
// (always "deliver immediately"). Other limitations in the <notify.h> API as described in
// that header will also apply.
// - In the CFNotificationCallback, the 'object' and 'userInfo' parameters must be ignored.
// - CFNotificationCenterAddObserver(): the 'object' and 'suspensionBehavior' arguments are ignored.
// - CFNotificationCenterAddObserver(): the 'name' argument may not be NULL (for this center).
// - CFNotificationCenterRemoveObserver(): the 'object' argument is ignored.
// - CFNotificationCenterPostNotification(): the 'object', 'userInfo', and 'deliverImmediately' arguments are ignored.
// - CFNotificationCenterPostNotificationWithOptions(): the 'object', 'userInfo', and 'options' arguments are ignored.
// The Darwin Notify Center has no notion of per-user sessions, all notifications are system-wide.
// As with distributed notifications, the main thread's run loop must be running in one of the
// common modes (usually kCFRunLoopDefaultMode) for Darwin-style notifications to be delivered.
// NOTE: NULL or 0 should be passed for all ignored arguments to ensure future compatibility.
CF_EXPORT void CFNotificationCenterAddObserver(CFNotificationCenterRef center, const void *observer, CFNotificationCallback callBack, CFStringRef name, const void *object, CFNotificationSuspensionBehavior suspensionBehavior);
CF_EXPORT void CFNotificationCenterRemoveObserver(CFNotificationCenterRef center, const void *observer, CFNotificationName name, const void *object);
CF_EXPORT void CFNotificationCenterRemoveEveryObserver(CFNotificationCenterRef center, const void *observer);
CF_EXPORT void CFNotificationCenterPostNotification(CFNotificationCenterRef center, CFNotificationName name, const void *object, CFDictionaryRef userInfo, Boolean deliverImmediately);
CF_ENUM(CFOptionFlags) {
kCFNotificationDeliverImmediately = (1UL << 0),
kCFNotificationPostToAllSessions = (1UL << 1)
};
CF_EXPORT void CFNotificationCenterPostNotificationWithOptions(CFNotificationCenterRef center, CFNotificationName name, const void *object, CFDictionaryRef userInfo, CFOptionFlags options);
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif /* ! __COREFOUNDATION_CFNOTIFICATIONCENTER__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFCharacterSet.h | /* CFCharacterSet.h
Copyright (c) 1999-2019, Apple Inc. and the Swift project authors
Portions Copyright (c) 2014-2019, Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See http://swift.org/LICENSE.txt for license information
See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
*/
/*!
@header CFCharacterSet
CFCharacterSet represents a set, or a bag, of Unicode characters.
The API consists of 3 groups:
1) creation/manipulation of CFCharacterSet instances,
2) query of a single Unicode character membership,
and 3) bitmap representation related (reading/writing).
Conceptually, CFCharacterSet is a 136K byte bitmap array of
which each bit represents a Unicode code point. It could
contain the Unicode characters in ISO 10646 Basic Multilingual
Plane (BMP) and characters in Plane 1 through Plane 16
accessible via surrogate paris in the Unicode Transformation
Format, 16-bit encoding form (UTF-16). In other words, it can
store values from 0x00000 to 0x10FFFF in the Unicode
Transformation Format, 32-bit encoding form (UTF-32). However,
in general, how CFCharacterSet stores the information is an
implementation detail. Note even CFData used for the external
bitmap representation rarely has 136K byte. For detailed
discussion of the external bitmap representation, refer to the
comments for CFCharacterSetCreateWithBitmapRepresentation below.
Note that the existance of non-BMP characters in a character set
does not imply the membership of the corresponding surrogate
characters. For example, a character set with U+10000 does not
match with U+D800.
*/
#if !defined(__COREFOUNDATION_CFCHARACTERSET__)
#define __COREFOUNDATION_CFCHARACTERSET__ 1
#include <CoreFoundation/CFBase.h>
#include <CoreFoundation/CFData.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
/*!
@typedef CFCharacterSetRef
This is the type of a reference to immutable CFCharacterSets.
*/
typedef const struct CF_BRIDGED_TYPE(NSCharacterSet) __CFCharacterSet * CFCharacterSetRef;
/*!
@typedef CFMutableCharacterSetRef
This is the type of a reference to mutable CFMutableCharacterSets.
*/
typedef struct CF_BRIDGED_MUTABLE_TYPE(NSMutableCharacterSet) __CFCharacterSet * CFMutableCharacterSetRef;
/*!
@typedef CFCharacterSetPredefinedSet
Type of the predefined CFCharacterSet selector values.
*/
typedef CF_ENUM(CFIndex, CFCharacterSetPredefinedSet) {
kCFCharacterSetControl = 1, /* Control character set (Unicode General Category Cc and Cf) */
kCFCharacterSetWhitespace, /* Whitespace character set (Unicode General Category Zs and U0009 CHARACTER TABULATION) */
kCFCharacterSetWhitespaceAndNewline, /* Whitespace and Newline character set (Unicode General Category Z*, U000A ~ U000D, and U0085) */
kCFCharacterSetDecimalDigit, /* Decimal digit character set */
kCFCharacterSetLetter, /* Letter character set (Unicode General Category L* & M*) */
kCFCharacterSetLowercaseLetter, /* Lowercase character set (Unicode General Category Ll) */
kCFCharacterSetUppercaseLetter, /* Uppercase character set (Unicode General Category Lu and Lt) */
kCFCharacterSetNonBase, /* Non-base character set (Unicode General Category M*) */
kCFCharacterSetDecomposable, /* Canonically decomposable character set */
kCFCharacterSetAlphaNumeric, /* Alpha Numeric character set (Unicode General Category L*, M*, & N*) */
kCFCharacterSetPunctuation, /* Punctuation character set (Unicode General Category P*) */
kCFCharacterSetCapitalizedLetter = 13, /* Titlecase character set (Unicode General Category Lt) */
kCFCharacterSetSymbol = 14, /* Symbol character set (Unicode General Category S*) */
kCFCharacterSetNewline API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)) = 15, /* Newline character set (U000A ~ U000D, U0085, U2028, and U2029) */
kCFCharacterSetIllegal = 12/* Illegal character set */
};
/*!
@function CFCharacterSetGetTypeID
Returns the type identifier of all CFCharacterSet instances.
*/
CF_EXPORT
CFTypeID CFCharacterSetGetTypeID(void);
/*!
@function CFCharacterSetGetPredefined
Returns a predefined CFCharacterSet instance.
@param theSetIdentifier The CFCharacterSetPredefinedSet selector
which specifies the predefined character set. If the
value is not in CFCharacterSetPredefinedSet, the behavior
is undefined.
@result A reference to the predefined immutable CFCharacterSet.
This instance is owned by CF.
*/
CF_EXPORT
CFCharacterSetRef CFCharacterSetGetPredefined(CFCharacterSetPredefinedSet theSetIdentifier);
/*!
@function CFCharacterSetCreateWithCharactersInRange
Creates a new immutable character set with the values from the given range.
@param alloc The CFAllocator which should be used to allocate
memory for the array and its storage for values. This
parameter may be NULL in which case the current default
CFAllocator is used. If this reference is not a valid
CFAllocator, the behavior is undefined.
@param theRange The CFRange which should be used to specify the
Unicode range the character set is filled with. It
accepts the range in 32-bit in the UTF-32 format. The
valid character point range is from 0x00000 to 0x10FFFF.
If the range is outside of the valid Unicode character
point, the behavior is undefined.
@result A reference to the new immutable CFCharacterSet.
*/
CF_EXPORT
CFCharacterSetRef CFCharacterSetCreateWithCharactersInRange(CFAllocatorRef alloc, CFRange theRange);
/*!
@function CFCharacterSetCreateWithCharactersInString
Creates a new immutable character set with the values in the given string.
@param alloc The CFAllocator which should be used to allocate
memory for the array and its storage for values. This
parameter may be NULL in which case the current default
CFAllocator is used. If this reference is not a valid
CFAllocator, the behavior is undefined.
@param theString The CFString which should be used to specify
the Unicode characters the character set is filled with.
If this parameter is not a valid CFString, the behavior
is undefined.
@result A reference to the new immutable CFCharacterSet.
*/
CF_EXPORT
CFCharacterSetRef CFCharacterSetCreateWithCharactersInString(CFAllocatorRef alloc, CFStringRef theString);
/*!
@function CFCharacterSetCreateWithBitmapRepresentation
Creates a new immutable character set with the bitmap representtion in the given data.
@param alloc The CFAllocator which should be used to allocate
memory for the array and its storage for values. This
parameter may be NULL in which case the current default
CFAllocator is used. If this reference is not a valid
CFAllocator, the behavior is undefined.
@param theData The CFData which should be used to specify the
bitmap representation of the Unicode character points
the character set is filled with. The bitmap
representation could contain all the Unicode character
range starting from BMP to Plane 16. The first 8192 bytes
of the data represent the BMP range. The BMP range 8192
bytes can be followed by zero to sixteen 8192 byte
bitmaps, each one with the plane index byte prepended.
For example, the bitmap representing the BMP and Plane 2
has the size of 16385 bytes (8192 bytes for BMP, 1 byte
index + 8192 bytes bitmap for Plane 2). The plane index
byte, in this case, contains the integer value two. If
this parameter is not a valid CFData or it contains a
Plane index byte outside of the valid Plane range
(1 to 16), the behavior is undefined.
@result A reference to the new immutable CFCharacterSet.
*/
CF_EXPORT
CFCharacterSetRef CFCharacterSetCreateWithBitmapRepresentation(CFAllocatorRef alloc, CFDataRef theData);
/*!
@function CFCharacterSetCreateInvertedSet
Creates a new immutable character set that is the invert of the specified character set.
@param alloc The CFAllocator which should be used to allocate
memory for the array and its storage for values. This
parameter may be NULL in which case the current default
CFAllocator is used. If this reference is not a valid
CFAllocator, the behavior is undefined.
@param theSet The CFCharacterSet which is to be inverted. If this
parameter is not a valid CFCharacterSet, the behavior is
undefined.
@result A reference to the new immutable CFCharacterSet.
*/
CF_EXPORT CFCharacterSetRef CFCharacterSetCreateInvertedSet(CFAllocatorRef alloc, CFCharacterSetRef theSet);
/*!
@function CFCharacterSetIsSupersetOfSet
Reports whether or not the character set is a superset of the character set specified as the second parameter.
@param theSet The character set to be checked for the membership of theOtherSet.
If this parameter is not a valid CFCharacterSet, the behavior is undefined.
@param theOtherset The character set to be checked whether or not it is a subset of theSet.
If this parameter is not a valid CFCharacterSet, the behavior is undefined.
*/
CF_EXPORT Boolean CFCharacterSetIsSupersetOfSet(CFCharacterSetRef theSet, CFCharacterSetRef theOtherset);
/*!
@function CFCharacterSetHasMemberInPlane
Reports whether or not the character set contains at least one member character in the specified plane.
@param theSet The character set to be checked for the membership. If this
parameter is not a valid CFCharacterSet, the behavior is undefined.
@param thePlane The plane number to be checked for the membership.
The valid value range is from 0 to 16. If the value is outside of the valid
plane number range, the behavior is undefined.
*/
CF_EXPORT Boolean CFCharacterSetHasMemberInPlane(CFCharacterSetRef theSet, CFIndex thePlane);
/*!
@function CFCharacterSetCreateMutable
Creates a new empty mutable character set.
@param alloc The CFAllocator which should be used to allocate
memory for the array and its storage for values. This
parameter may be NULL in which case the current default
CFAllocator is used. If this reference is not a valid
CFAllocator, the behavior is undefined.
@result A reference to the new mutable CFCharacterSet.
*/
CF_EXPORT
CFMutableCharacterSetRef CFCharacterSetCreateMutable(CFAllocatorRef alloc);
/*!
@function CFCharacterSetCreateCopy
Creates a new character set with the values from the given character set. This function tries to compact the backing store where applicable.
@param alloc The CFAllocator which should be used to allocate
memory for the array and its storage for values. This
parameter may be NULL in which case the current default
CFAllocator is used. If this reference is not a valid
CFAllocator, the behavior is undefined.
@param theSet The CFCharacterSet which is to be copied. If this
parameter is not a valid CFCharacterSet, the behavior is
undefined.
@result A reference to the new CFCharacterSet.
*/
CF_EXPORT
CFCharacterSetRef CFCharacterSetCreateCopy(CFAllocatorRef alloc, CFCharacterSetRef theSet);
/*!
@function CFCharacterSetCreateMutableCopy
Creates a new mutable character set with the values from the given character set.
@param alloc The CFAllocator which should be used to allocate
memory for the array and its storage for values. This
parameter may be NULL in which case the current default
CFAllocator is used. If this reference is not a valid
CFAllocator, the behavior is undefined.
@param theSet The CFCharacterSet which is to be copied. If this
parameter is not a valid CFCharacterSet, the behavior is
undefined.
@result A reference to the new mutable CFCharacterSet.
*/
CF_EXPORT
CFMutableCharacterSetRef CFCharacterSetCreateMutableCopy(CFAllocatorRef alloc, CFCharacterSetRef theSet);
/*!
@function CFCharacterSetIsCharacterMember
Reports whether or not the Unicode character is in the character set.
@param theSet The character set to be searched. If this parameter
is not a valid CFCharacterSet, the behavior is undefined.
@param theChar The Unicode character for which to test against the
character set. Note that this function takes 16-bit Unicode
character value; hence, it does not support access to the
non-BMP planes.
@result true, if the value is in the character set, otherwise false.
*/
CF_EXPORT
Boolean CFCharacterSetIsCharacterMember(CFCharacterSetRef theSet, UniChar theChar);
/*!
@function CFCharacterSetIsLongCharacterMember
Reports whether or not the UTF-32 character is in the character set.
@param theSet The character set to be searched. If this parameter
is not a valid CFCharacterSet, the behavior is undefined.
@param theChar The UTF-32 character for which to test against the
character set.
@result true, if the value is in the character set, otherwise false.
*/
CF_EXPORT Boolean CFCharacterSetIsLongCharacterMember(CFCharacterSetRef theSet, UTF32Char theChar);
/*!
@function CFCharacterSetCreateBitmapRepresentation
Creates a new immutable data with the bitmap representation from the given character set.
@param alloc The CFAllocator which should be used to allocate
memory for the array and its storage for values. This
parameter may be NULL in which case the current default
CFAllocator is used. If this reference is not a valid
CFAllocator, the behavior is undefined.
@param theSet The CFCharacterSet which is to be used create the
bitmap representation from. Refer to the comments for
CFCharacterSetCreateWithBitmapRepresentation for the
detailed discussion of the bitmap representation format.
If this parameter is not a valid CFCharacterSet, the
behavior is undefined.
@result A reference to the new immutable CFData.
*/
CF_EXPORT
CFDataRef CFCharacterSetCreateBitmapRepresentation(CFAllocatorRef alloc, CFCharacterSetRef theSet);
/*!
@function CFCharacterSetAddCharactersInRange
Adds the given range to the charaacter set.
@param theSet The character set to which the range is to be added.
If this parameter is not a valid mutable CFCharacterSet,
the behavior is undefined.
@param theRange The range to add to the character set. It accepts
the range in 32-bit in the UTF-32 format. The valid
character point range is from 0x00000 to 0x10FFFF. If the
range is outside of the valid Unicode character point,
the behavior is undefined.
*/
CF_EXPORT
void CFCharacterSetAddCharactersInRange(CFMutableCharacterSetRef theSet, CFRange theRange);
/*!
@function CFCharacterSetRemoveCharactersInRange
Removes the given range from the charaacter set.
@param theSet The character set from which the range is to be
removed. If this parameter is not a valid mutable
CFCharacterSet, the behavior is undefined.
@param theRange The range to remove from the character set.
It accepts the range in 32-bit in the UTF-32 format.
The valid character point range is from 0x00000 to 0x10FFFF.
If the range is outside of the valid Unicode character point,
the behavior is undefined.
*/
CF_EXPORT
void CFCharacterSetRemoveCharactersInRange(CFMutableCharacterSetRef theSet, CFRange theRange);
/*!
@function CFCharacterSetAddCharactersInString
Adds the characters in the given string to the charaacter set.
@param theSet The character set to which the characters in the
string are to be added. If this parameter is not a
valid mutable CFCharacterSet, the behavior is undefined.
@param theString The string to add to the character set.
If this parameter is not a valid CFString, the behavior
is undefined.
*/
CF_EXPORT
void CFCharacterSetAddCharactersInString(CFMutableCharacterSetRef theSet, CFStringRef theString);
/*!
@function CFCharacterSetRemoveCharactersInString
Removes the characters in the given string from the charaacter set.
@param theSet The character set from which the characters in the
string are to be remove. If this parameter is not a
valid mutable CFCharacterSet, the behavior is undefined.
@param theString The string to remove from the character set.
If this parameter is not a valid CFString, the behavior
is undefined.
*/
CF_EXPORT
void CFCharacterSetRemoveCharactersInString(CFMutableCharacterSetRef theSet, CFStringRef theString);
/*!
@function CFCharacterSetUnion
Forms the union with the given character set.
@param theSet The destination character set into which the
union of the two character sets is stored. If this
parameter is not a valid mutable CFCharacterSet, the
behavior is undefined.
@param theOtherSet The character set with which the union is
formed. If this parameter is not a valid CFCharacterSet,
the behavior is undefined.
*/
CF_EXPORT
void CFCharacterSetUnion(CFMutableCharacterSetRef theSet, CFCharacterSetRef theOtherSet);
/*!
@function CFCharacterSetIntersect
Forms the intersection with the given character set.
@param theSet The destination character set into which the
intersection of the two character sets is stored.
If this parameter is not a valid mutable CFCharacterSet,
the behavior is undefined.
@param theOtherSet The character set with which the intersection
is formed. If this parameter is not a valid CFCharacterSet,
the behavior is undefined.
*/
CF_EXPORT
void CFCharacterSetIntersect(CFMutableCharacterSetRef theSet, CFCharacterSetRef theOtherSet);
/*!
@function CFCharacterSetInvert
Inverts the content of the given character set.
@param theSet The character set to be inverted.
If this parameter is not a valid mutable CFCharacterSet,
the behavior is undefined.
*/
CF_EXPORT
void CFCharacterSetInvert(CFMutableCharacterSetRef theSet);
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif /* ! __COREFOUNDATION_CFCHARACTERSET__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFPropertyList.h | /* CFPropertyList.h
Copyright (c) 1998-2019, Apple Inc. and the Swift project authors
Portions Copyright (c) 2014-2019, Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See http://swift.org/LICENSE.txt for license information
See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
*/
#if !defined(__COREFOUNDATION_CFPROPERTYLIST__)
#define __COREFOUNDATION_CFPROPERTYLIST__ 1
#include <CoreFoundation/CFBase.h>
#include <CoreFoundation/CFData.h>
#include <CoreFoundation/CFString.h>
#include <CoreFoundation/CFError.h>
#include <CoreFoundation/CFStream.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
typedef CF_OPTIONS(CFOptionFlags, CFPropertyListMutabilityOptions) {
kCFPropertyListImmutable = 0,
kCFPropertyListMutableContainers = 1 << 0,
kCFPropertyListMutableContainersAndLeaves = 1 << 1,
};
CF_IMPLICIT_BRIDGING_DISABLED
/*
Creates a property list object from its XML description; xmlData should
be the raw bytes of that description, possibly the contents of an XML
file. Returns NULL if the data cannot be parsed; if the parse fails
and errorString is non-NULL, a human-readable description of the failure
is returned in errorString. It is the caller's responsibility to release
either the returned object or the error string, whichever is applicable.
This function is deprecated. See CFPropertyListCreateWithData() for a replacement.
*/
CF_EXPORT
CFPropertyListRef CFPropertyListCreateFromXMLData(CFAllocatorRef allocator, CFDataRef xmlData, CFOptionFlags mutabilityOption, CFStringRef *errorString) API_DEPRECATED("Use CFPropertyListCreateWithData instead.", macos(10.0,10.10), ios(2.0,8.0), watchos(2.0,2.0), tvos(9.0,9.0));
/*
Returns the XML description of the given object; propertyList must
be one of the supported property list types, and (for composite types
like CFArray and CFDictionary) must not contain any elements that
are not themselves of a property list type. If a non-property list
type is encountered, NULL is returned. The returned data is
appropriate for writing out to an XML file. Note that a data, not a
string, is returned because the bytes contain in them a description
of the string encoding used.
This function is deprecated. See CFPropertyListCreateData() for a replacement.
*/
CF_EXPORT
CFDataRef CFPropertyListCreateXMLData(CFAllocatorRef allocator, CFPropertyListRef propertyList) API_DEPRECATED("Use CFPropertyListCreateData instead.", macos(10.0,10.10), ios(2.0,8.0), watchos(2.0,2.0), tvos(9.0,9.0));
CF_IMPLICIT_BRIDGING_ENABLED
/*
Recursively creates a copy of the given property list (so nested arrays
and dictionaries are copied as well as the top-most container). The
resulting property list has the mutability characteristics determined
by mutabilityOption.
*/
CF_EXPORT
CFPropertyListRef CFPropertyListCreateDeepCopy(CFAllocatorRef allocator, CFPropertyListRef propertyList, CFOptionFlags mutabilityOption);
typedef CF_ENUM(CFIndex, CFPropertyListFormat) {
kCFPropertyListOpenStepFormat = 1,
kCFPropertyListXMLFormat_v1_0 = 100,
kCFPropertyListBinaryFormat_v1_0 = 200
};
/* Returns true if the object graph rooted at plist is a valid property list
* graph -- that is, no cycles, containing only plist objects, and dictionary
* keys are strings. The debugging library version spits out some messages
* to be helpful. The plist structure which is to be allowed is given by
* the format parameter. */
CF_EXPORT
Boolean CFPropertyListIsValid(CFPropertyListRef plist, CFPropertyListFormat format);
CF_IMPLICIT_BRIDGING_DISABLED
/* Writes the bytes of a plist serialization out to the stream. The
* stream must be opened and configured -- the function simply writes
* a bunch of bytes to the stream. The output plist format can be chosen.
* Leaves the stream open, but note that reading a plist expects the
* reading stream to end wherever the writing ended, so that the
* end of the plist data can be identified. Returns the number of bytes
* written, or 0 on error. Error messages are not currently localized, but
* may be in the future, so they are not suitable for comparison.
*
* This function is deprecated. See CFPropertyListWrite() for a replacement. */
CF_EXPORT
CFIndex CFPropertyListWriteToStream(CFPropertyListRef propertyList, CFWriteStreamRef stream, CFPropertyListFormat format, CFStringRef *errorString) API_DEPRECATED("Use CFPropertyListWrite instead.", macos(10.2,10.10), ios(2.0,8.0), watchos(2.0,2.0), tvos(9.0,9.0));
/* Same as current function CFPropertyListCreateFromXMLData()
* but takes a stream instead of data, and works on any plist file format.
* CFPropertyListCreateFromXMLData() also works on any plist file format.
* The stream must be open and configured -- the function simply reads a bunch
* of bytes from it starting at the current location in the stream, to the END
* of the stream, which is expected to be the end of the plist, or up to the
* number of bytes given by the length parameter if it is not 0. Error messages
* are not currently localized, but may be in the future, so they are not
* suitable for comparison.
*
* This function is deprecated. See CFPropertyListCreateWithStream() for a replacement. */
CF_EXPORT
CFPropertyListRef CFPropertyListCreateFromStream(CFAllocatorRef allocator, CFReadStreamRef stream, CFIndex streamLength, CFOptionFlags mutabilityOption, CFPropertyListFormat *format, CFStringRef *errorString) API_DEPRECATED("Use CFPropertyListCreateWithStream instead.", macos(10.2,10.10), ios(2.0,8.0), watchos(2.0,2.0), tvos(9.0,9.0));
CF_IMPLICIT_BRIDGING_ENABLED
CF_IMPLICIT_BRIDGING_DISABLED
CF_ENUM(CFIndex) {
kCFPropertyListReadCorruptError = 3840, // Error parsing a property list
kCFPropertyListReadUnknownVersionError = 3841, // The version number in the property list is unknown
kCFPropertyListReadStreamError = 3842, // Stream error reading a property list
kCFPropertyListWriteStreamError = 3851, // Stream error writing a property list
} API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* Create a property list with a CFData input. If the format parameter is non-NULL, it will be set to the format of the data after parsing is complete. The options parameter is used to specify CFPropertyListMutabilityOptions. If an error occurs while parsing the data, the return value will be NULL. Additionally, if an error occurs and the error parameter is non-NULL, the error parameter will be set to a CFError describing the problem, which the caller must release. If the parse succeeds, the returned value is a reference to the new property list. It is the responsibility of the caller to release this value.
*/
CF_EXPORT
CFPropertyListRef CFPropertyListCreateWithData(CFAllocatorRef allocator, CFDataRef data, CFOptionFlags options, CFPropertyListFormat *format, CFErrorRef *error) API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* Create and return a property list with a CFReadStream input. If the format parameter is non-NULL, it will be set to the format of the data after parsing is complete. The options parameter is used to specify CFPropertyListMutabilityOptions. The streamLength parameter specifies the number of bytes to read from the stream. Set streamLength to 0 to read until the end of the stream is detected. If an error occurs while parsing the data, the return value will be NULL. Additionally, if an error occurs and the error parameter is non-NULL, the error parameter will be set to a CFError describing the problem, which the caller must release. If the parse succeeds, the returned value is a reference to the new property list. It is the responsibility of the caller to release this value.
*/
CF_EXPORT
CFPropertyListRef CFPropertyListCreateWithStream(CFAllocatorRef allocator, CFReadStreamRef stream, CFIndex streamLength, CFOptionFlags options, CFPropertyListFormat *format, CFErrorRef *error) API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* Write the bytes of a serialized property list out to a stream. The stream must be opened and configured. The format of the property list can be chosen with the format parameter. The options parameter is currently unused and should be set to 0. The return value is the number of bytes written or 0 in the case of an error. If an error occurs and the error parameter is non-NULL, the error parameter will be set to a CFError describing the problem, which the caller must release.
*/
CF_EXPORT
CFIndex CFPropertyListWrite(CFPropertyListRef propertyList, CFWriteStreamRef stream, CFPropertyListFormat format, CFOptionFlags options, CFErrorRef *error) API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
/* Create a CFData with the bytes of a serialized property list. The format of the property list can be chosen with the format parameter. The options parameter is currently unused and should be set to 0. If an error occurs while parsing the data, the return value will be NULL. Additionally, if an error occurs and the error parameter is non-NULL, the error parameter will be set to a CFError describing the problem, which the caller must release. If the conversion succeeds, the returned value is a reference to the created data. It is the responsibility of the caller to release this value.
*/
CF_EXPORT
CFDataRef CFPropertyListCreateData(CFAllocatorRef allocator, CFPropertyListRef propertyList, CFPropertyListFormat format, CFOptionFlags options, CFErrorRef *error) API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif /* ! __COREFOUNDATION_CFPROPERTYLIST__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFUtilities.h | /* CFUtilities.h
Copyright (c) 2005-2019, Apple Inc. and the Swift project authors
Portions Copyright (c) 2014-2019, Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See http://swift.org/LICENSE.txt for license information
See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
*/
#if !defined(__COREFOUNDATION_CFUTILITIES__)
#define __COREFOUNDATION_CFUTILITIES__ 1
#include <CoreFoundation/CFBase.h>
#include <CoreFoundation/CFString.h>
#include <CoreFoundation/CFURL.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
CF_EXPORT
CFURLRef CFCopyHomeDirectoryURL(void) API_AVAILABLE(ios(5.0), watchos(2.0), tvos(9.0)) API_UNAVAILABLE(macos);
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif /* ! __COREFOUNDATION_CFUTILITIES__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFTimeZone.h | /* CFTimeZone.h
Copyright (c) 1998-2019, Apple Inc. and the Swift project authors
Portions Copyright (c) 2014-2019, Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See http://swift.org/LICENSE.txt for license information
See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
*/
#if !defined(__COREFOUNDATION_CFTIMEZONE__)
#define __COREFOUNDATION_CFTIMEZONE__ 1
#include <CoreFoundation/CFBase.h>
#include <CoreFoundation/CFArray.h>
#include <CoreFoundation/CFData.h>
#include <CoreFoundation/CFDate.h>
#include <CoreFoundation/CFDictionary.h>
#include <CoreFoundation/CFString.h>
#include <CoreFoundation/CFNotificationCenter.h>
#include <CoreFoundation/CFLocale.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
CF_EXPORT
CFTypeID CFTimeZoneGetTypeID(void);
CF_EXPORT
CFTimeZoneRef CFTimeZoneCopySystem(void);
CF_EXPORT
void CFTimeZoneResetSystem(void);
CF_EXPORT
CFTimeZoneRef CFTimeZoneCopyDefault(void);
CF_EXPORT
void CFTimeZoneSetDefault(CFTimeZoneRef tz);
CF_EXPORT
CFArrayRef CFTimeZoneCopyKnownNames(void);
CF_EXPORT
CFDictionaryRef CFTimeZoneCopyAbbreviationDictionary(void);
CF_EXPORT
void CFTimeZoneSetAbbreviationDictionary(CFDictionaryRef dict);
CF_EXPORT
CFTimeZoneRef CFTimeZoneCreate(CFAllocatorRef allocator, CFStringRef name, CFDataRef data);
CF_EXPORT
CFTimeZoneRef CFTimeZoneCreateWithTimeIntervalFromGMT(CFAllocatorRef allocator, CFTimeInterval ti);
CF_EXPORT
CFTimeZoneRef CFTimeZoneCreateWithName(CFAllocatorRef allocator, CFStringRef name, Boolean tryAbbrev);
CF_EXPORT
CFStringRef CFTimeZoneGetName(CFTimeZoneRef tz);
CF_EXPORT
CFDataRef CFTimeZoneGetData(CFTimeZoneRef tz);
CF_EXPORT
CFTimeInterval CFTimeZoneGetSecondsFromGMT(CFTimeZoneRef tz, CFAbsoluteTime at);
CF_EXPORT
CFStringRef CFTimeZoneCopyAbbreviation(CFTimeZoneRef tz, CFAbsoluteTime at);
CF_EXPORT
Boolean CFTimeZoneIsDaylightSavingTime(CFTimeZoneRef tz, CFAbsoluteTime at);
CF_EXPORT
CFTimeInterval CFTimeZoneGetDaylightSavingTimeOffset(CFTimeZoneRef tz, CFAbsoluteTime at) API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0));
CF_EXPORT
CFAbsoluteTime CFTimeZoneGetNextDaylightSavingTimeTransition(CFTimeZoneRef tz, CFAbsoluteTime at) API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0));
typedef CF_ENUM(CFIndex, CFTimeZoneNameStyle) {
kCFTimeZoneNameStyleStandard,
kCFTimeZoneNameStyleShortStandard,
kCFTimeZoneNameStyleDaylightSaving,
kCFTimeZoneNameStyleShortDaylightSaving,
kCFTimeZoneNameStyleGeneric,
kCFTimeZoneNameStyleShortGeneric
} API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0));
CF_EXPORT
CFStringRef CFTimeZoneCopyLocalizedName(CFTimeZoneRef tz, CFTimeZoneNameStyle style, CFLocaleRef locale) API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0));
CF_EXPORT
const CFNotificationName kCFTimeZoneSystemTimeZoneDidChangeNotification API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0));
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif /* ! __COREFOUNDATION_CFTIMEZONE__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFBinaryHeap.h | /* CFBinaryHeap.h
Copyright (c) 1998-2019, Apple Inc. and the Swift project authors
Portions Copyright (c) 2014-2019, Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See http://swift.org/LICENSE.txt for license information
See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
*/
/*!
@header CFBinaryHeap
CFBinaryHeap implements a container which stores values sorted using
a binary search algorithm. CFBinaryHeaps can be useful as priority
queues.
*/
#if !defined(__COREFOUNDATION_CFBINARYHEAP__)
#define __COREFOUNDATION_CFBINARYHEAP__ 1
#include <CoreFoundation/CFBase.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
typedef struct {
CFIndex version;
void * info;
const void *(*retain)(const void *info);
void (*release)(const void *info);
CFStringRef (*copyDescription)(const void *info);
} CFBinaryHeapCompareContext;
/*!
@typedef CFBinaryHeapCallBacks
Structure containing the callbacks for values of a CFBinaryHeap.
@field version The version number of the structure type being passed
in as a parameter to the CFBinaryHeap creation functions.
This structure is version 0.
@field retain The callback used to add a retain for the binary heap
on values as they are put into the binary heap.
This callback returns the value to use as the value in the
binary heap, which is usually the value parameter passed to
this callback, but may be a different value if a different
value should be added to the binary heap. The binary heap's
allocator is passed as the first argument.
@field release The callback used to remove a retain previously added
for the binary heap from values as they are removed from
the binary heap. The binary heap's allocator is passed as the
first argument.
@field copyDescription The callback used to create a descriptive
string representation of each value in the binary heap. This
is used by the CFCopyDescription() function.
@field compare The callback used to compare values in the binary heap for
equality in some operations.
*/
typedef struct {
CFIndex version;
const void *(*retain)(CFAllocatorRef allocator, const void *ptr);
void (*release)(CFAllocatorRef allocator, const void *ptr);
CFStringRef (*copyDescription)(const void *ptr);
CFComparisonResult (*compare)(const void *ptr1, const void *ptr2, void *context);
} CFBinaryHeapCallBacks;
/*!
@constant kCFStringBinaryHeapCallBacks
Predefined CFBinaryHeapCallBacks structure containing a set
of callbacks appropriate for use when the values in a CFBinaryHeap
are all CFString types.
*/
CF_EXPORT const CFBinaryHeapCallBacks kCFStringBinaryHeapCallBacks;
/*!
@typedef CFBinaryHeapApplierFunction
Type of the callback function used by the apply functions of
CFBinaryHeap.
@param val The current value from the binary heap.
@param context The user-defined context parameter given to the apply
function.
*/
typedef void (*CFBinaryHeapApplierFunction)(const void *val, void *context);
/*!
@typedef CFBinaryHeapRef
This is the type of a reference to CFBinaryHeaps.
*/
typedef struct CF_BRIDGED_MUTABLE_TYPE(id) __CFBinaryHeap * CFBinaryHeapRef;
/*!
@function CFBinaryHeapGetTypeID
Returns the type identifier of all CFBinaryHeap instances.
*/
CF_EXPORT CFTypeID CFBinaryHeapGetTypeID(void);
/*!
@function CFBinaryHeapCreate
Creates a new mutable binary heap with the given values.
@param allocator The CFAllocator which should be used to allocate
memory for the binary heap and its storage for values. This
parameter may be NULL in which case the current default
CFAllocator is used. If this reference is not a valid
CFAllocator, the behavior is undefined.
@param capacity A hint about the number of values that will be held
by the CFBinaryHeap. Pass 0 for no hint. The implementation may
ignore this hint, or may use it to optimize various
operations. A heap's actual capacity is only limited by
address space and available memory constraints). If this
parameter is negative, the behavior is undefined.
@param callBacks A pointer to a CFBinaryHeapCallBacks structure
initialized with the callbacks for the binary heap to use on
each value in the binary heap. A copy of the contents of the
callbacks structure is made, so that a pointer to a structure
on the stack can be passed in, or can be reused for multiple
binary heap creations. If the version field of this callbacks
structure is not one of the defined ones for CFBinaryHeap, the
behavior is undefined. The retain field may be NULL, in which
case the CFBinaryHeap will do nothing to add a retain to values
as they are put into the binary heap. The release field may be
NULL, in which case the CFBinaryHeap will do nothing to remove
the binary heap's retain (if any) on the values when the
heap is destroyed or a key-value pair is removed. If the
copyDescription field is NULL, the binary heap will create a
simple description for a value. If the equal field is NULL, the
binary heap will use pointer equality to test for equality of
values. This callbacks parameter itself may be NULL, which is
treated as if a valid structure of version 0 with all fields
NULL had been passed in. Otherwise,
if any of the fields are not valid pointers to functions
of the correct type, or this parameter is not a valid
pointer to a CFBinaryHeapCallBacks callbacks structure,
the behavior is undefined. If any of the values put into the
binary heap is not one understood by one of the callback functions
the behavior when that callback function is used is undefined.
@param compareContext A pointer to a CFBinaryHeapCompareContext structure.
@result A reference to the new CFBinaryHeap.
*/
CF_EXPORT CFBinaryHeapRef CFBinaryHeapCreate(CFAllocatorRef allocator, CFIndex capacity, const CFBinaryHeapCallBacks *callBacks, const CFBinaryHeapCompareContext *compareContext);
/*!
@function CFBinaryHeapCreateCopy
Creates a new mutable binary heap with the values from the given binary heap.
@param allocator The CFAllocator which should be used to allocate
memory for the binary heap and its storage for values. This
parameter may be NULL in which case the current default
CFAllocator is used. If this reference is not a valid
CFAllocator, the behavior is undefined.
@param capacity A hint about the number of values that will be held
by the CFBinaryHeap. Pass 0 for no hint. The implementation may
ignore this hint, or may use it to optimize various
operations. A heap's actual capacity is only limited by
address space and available memory constraints).
This parameter must be greater than or equal
to the count of the heap which is to be copied, or the
behavior is undefined. If this parameter is negative, the
behavior is undefined.
@param heap The binary heap which is to be copied. The values from the
binary heap are copied as pointers into the new binary heap (that is,
the values themselves are copied, not that which the values
point to, if anything). However, the values are also
retained by the new binary heap. The count of the new binary will
be the same as the given binary heap. The new binary heap uses the same
callbacks as the binary heap to be copied. If this parameter is
not a valid CFBinaryHeap, the behavior is undefined.
@result A reference to the new mutable binary heap.
*/
CF_EXPORT CFBinaryHeapRef CFBinaryHeapCreateCopy(CFAllocatorRef allocator, CFIndex capacity, CFBinaryHeapRef heap);
/*!
@function CFBinaryHeapGetCount
Returns the number of values currently in the binary heap.
@param heap The binary heap to be queried. If this parameter is not a valid
CFBinaryHeap, the behavior is undefined.
@result The number of values in the binary heap.
*/
CF_EXPORT CFIndex CFBinaryHeapGetCount(CFBinaryHeapRef heap);
/*!
@function CFBinaryHeapGetCountOfValue
Counts the number of times the given value occurs in the binary heap.
@param heap The binary heap to be searched. If this parameter is not a
valid CFBinaryHeap, the behavior is undefined.
@param value The value for which to find matches in the binary heap. The
compare() callback provided when the binary heap was created is
used to compare. If the compare() callback was NULL, pointer
equality (in C, ==) is used. If value, or any of the values
in the binary heap, are not understood by the compare() callback,
the behavior is undefined.
@result The number of times the given value occurs in the binary heap.
*/
CF_EXPORT CFIndex CFBinaryHeapGetCountOfValue(CFBinaryHeapRef heap, const void *value);
/*!
@function CFBinaryHeapContainsValue
Reports whether or not the value is in the binary heap.
@param heap The binary heap to be searched. If this parameter is not a
valid CFBinaryHeap, the behavior is undefined.
@param value The value for which to find matches in the binary heap. The
compare() callback provided when the binary heap was created is
used to compare. If the compare() callback was NULL, pointer
equality (in C, ==) is used. If value, or any of the values
in the binary heap, are not understood by the compare() callback,
the behavior is undefined.
@result true, if the value is in the specified binary heap, otherwise false.
*/
CF_EXPORT Boolean CFBinaryHeapContainsValue(CFBinaryHeapRef heap, const void *value);
/*!
@function CFBinaryHeapGetMinimum
Returns the minimum value is in the binary heap. If the heap contains several equal
minimum values, any one may be returned.
@param heap The binary heap to be searched. If this parameter is not a
valid CFBinaryHeap, the behavior is undefined.
@result A reference to the minimum value in the binary heap, or NULL if the
binary heap contains no values.
*/
CF_EXPORT const void * CFBinaryHeapGetMinimum(CFBinaryHeapRef heap);
/*!
@function CFBinaryHeapGetMinimumIfPresent
Returns the minimum value is in the binary heap, if present. If the heap contains several equal
minimum values, any one may be returned.
@param heap The binary heap to be searched. If this parameter is not a
valid CFBinaryHeap, the behavior is undefined.
@param value A C pointer to pointer-sized storage to be filled with the minimum value in
the binary heap. If this value is not a valid C pointer to a pointer-sized block
of storage, the result is undefined. If the result of the function is false, the value
stored at this address is undefined.
@result true, if a minimum value was found in the specified binary heap, otherwise false.
*/
CF_EXPORT Boolean CFBinaryHeapGetMinimumIfPresent(CFBinaryHeapRef heap, const void **value);
/*!
@function CFBinaryHeapGetValues
Fills the buffer with values from the binary heap.
@param heap The binary heap to be queried. If this parameter is not a
valid CFBinaryHeap, the behavior is undefined.
@param values A C array of pointer-sized values to be filled with
values from the binary heap. The values in the C array are ordered
from least to greatest. If this parameter is not a valid pointer to a
C array of at least CFBinaryHeapGetCount() pointers, the behavior is undefined.
*/
CF_EXPORT void CFBinaryHeapGetValues(CFBinaryHeapRef heap, const void **values);
/*!
@function CFBinaryHeapApplyFunction
Calls a function once for each value in the binary heap.
@param heap The binary heap to be operated upon. If this parameter is not a
valid CFBinaryHeap, the behavior is undefined.
@param applier The callback function to call once for each value in
the given binary heap. If this parameter is not a
pointer to a function of the correct prototype, the behavior
is undefined. If there are values in the binary heap which the
applier function does not expect or cannot properly apply
to, the behavior is undefined.
@param context A pointer-sized user-defined value, which is passed
as the second parameter to the applier function, but is
otherwise unused by this function. If the context is not
what is expected by the applier function, the behavior is
undefined.
*/
CF_EXPORT void CFBinaryHeapApplyFunction(CFBinaryHeapRef heap, CFBinaryHeapApplierFunction CF_NOESCAPE applier, void *context);
/*!
@function CFBinaryHeapAddValue
Adds the value to the binary heap.
@param heap The binary heap to which the value is to be added. If this parameter is not a
valid mutable CFBinaryHeap, the behavior is undefined.
@param value The value to add to the binary heap. The value is retained by
the binary heap using the retain callback provided when the binary heap
was created. If the value is not of the sort expected by the
retain callback, the behavior is undefined.
*/
CF_EXPORT void CFBinaryHeapAddValue(CFBinaryHeapRef heap, const void *value);
/*!
@function CFBinaryHeapRemoveMinimumValue
Removes the minimum value from the binary heap.
@param heap The binary heap from which the minimum value is to be removed. If this
parameter is not a valid mutable CFBinaryHeap, the behavior is undefined.
*/
CF_EXPORT void CFBinaryHeapRemoveMinimumValue(CFBinaryHeapRef heap);
/*!
@function CFBinaryHeapRemoveAllValues
Removes all the values from the binary heap, making it empty.
@param heap The binary heap from which all of the values are to be
removed. If this parameter is not a valid mutable CFBinaryHeap,
the behavior is undefined.
*/
CF_EXPORT void CFBinaryHeapRemoveAllValues(CFBinaryHeapRef heap);
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif /* ! __COREFOUNDATION_CFBINARYHEAP__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFNumberFormatter.h | /* CFNumberFormatter.h
Copyright (c) 2003-2019, Apple Inc. and the Swift project authors
Portions Copyright (c) 2014-2019, Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See http://swift.org/LICENSE.txt for license information
See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
*/
#if !defined(__COREFOUNDATION_CFNUMBERFORMATTER__)
#define __COREFOUNDATION_CFNUMBERFORMATTER__ 1
#include <CoreFoundation/CFBase.h>
#include <CoreFoundation/CFNumber.h>
#include <CoreFoundation/CFLocale.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
typedef CFStringRef CFNumberFormatterKey CF_STRING_ENUM;
typedef struct CF_BRIDGED_MUTABLE_TYPE(id) __CFNumberFormatter *CFNumberFormatterRef;
// CFNumberFormatters are not thread-safe. Do not use one from multiple threads!
CF_EXPORT
CFTypeID CFNumberFormatterGetTypeID(void);
typedef CF_ENUM(CFIndex, CFNumberFormatterStyle) { // number format styles
kCFNumberFormatterNoStyle = 0,
kCFNumberFormatterDecimalStyle = 1,
kCFNumberFormatterCurrencyStyle = 2,
kCFNumberFormatterPercentStyle = 3,
kCFNumberFormatterScientificStyle = 4,
kCFNumberFormatterSpellOutStyle = 5,
kCFNumberFormatterOrdinalStyle API_AVAILABLE(macos(10.11), ios(9.0), watchos(2.0), tvos(9.0)) = 6,
kCFNumberFormatterCurrencyISOCodeStyle API_AVAILABLE(macos(10.11), ios(9.0), watchos(2.0), tvos(9.0)) = 8,
kCFNumberFormatterCurrencyPluralStyle API_AVAILABLE(macos(10.11), ios(9.0), watchos(2.0), tvos(9.0)) = 9,
kCFNumberFormatterCurrencyAccountingStyle API_AVAILABLE(macos(10.11), ios(9.0), watchos(2.0), tvos(9.0)) = 10,
};
CF_EXPORT
CFNumberFormatterRef CFNumberFormatterCreate(CFAllocatorRef allocator, CFLocaleRef locale, CFNumberFormatterStyle style);
// Returns a CFNumberFormatter, localized to the given locale, which
// will format numbers to the given style.
CF_EXPORT
CFLocaleRef CFNumberFormatterGetLocale(CFNumberFormatterRef formatter);
CF_EXPORT
CFNumberFormatterStyle CFNumberFormatterGetStyle(CFNumberFormatterRef formatter);
// Get the properties with which the number formatter was created.
CF_EXPORT
CFStringRef CFNumberFormatterGetFormat(CFNumberFormatterRef formatter);
CF_EXPORT
void CFNumberFormatterSetFormat(CFNumberFormatterRef formatter, CFStringRef formatString);
// Set the format description string of the number formatter. This
// overrides the style settings. The format of the format string
// is as defined by the ICU library, and is similar to that found
// in Microsoft Excel and NSNumberFormatter.
// The number formatter starts with a default format string defined
// by the style argument with which it was created.
CF_EXPORT
CFStringRef CFNumberFormatterCreateStringWithNumber(CFAllocatorRef allocator, CFNumberFormatterRef formatter, CFNumberRef number);
CF_EXPORT
CFStringRef CFNumberFormatterCreateStringWithValue(CFAllocatorRef allocator, CFNumberFormatterRef formatter, CFNumberType numberType, const void *valuePtr);
// Create a string representation of the given number or value
// using the current state of the number formatter.
typedef CF_OPTIONS(CFOptionFlags, CFNumberFormatterOptionFlags) {
kCFNumberFormatterParseIntegersOnly = 1 /* only parse integers */
};
CF_EXPORT
CFNumberRef CFNumberFormatterCreateNumberFromString(CFAllocatorRef allocator, CFNumberFormatterRef formatter, CFStringRef string, CFRange *rangep, CFOptionFlags options);
CF_EXPORT
Boolean CFNumberFormatterGetValueFromString(CFNumberFormatterRef formatter, CFStringRef string, CFRange *rangep, CFNumberType numberType, void *valuePtr);
// Parse a string representation of a number using the current state
// of the number formatter. The range parameter specifies the range
// of the string in which the parsing should occur in input, and on
// output indicates the extent that was used; this parameter can
// be NULL, in which case the whole string may be used. The
// return value indicates whether some number was computed and
// (if valuePtr is not NULL) stored at the location specified by
// valuePtr. The numberType indicates the type of value pointed
// to by valuePtr.
CF_EXPORT
void CFNumberFormatterSetProperty(CFNumberFormatterRef formatter, CFNumberFormatterKey key, CFTypeRef value);
CF_EXPORT
CFTypeRef CFNumberFormatterCopyProperty(CFNumberFormatterRef formatter, CFNumberFormatterKey key);
// Set and get various properties of the number formatter, the set of
// which may be expanded in the future.
CF_EXPORT const CFNumberFormatterKey kCFNumberFormatterCurrencyCode; // CFString
CF_EXPORT const CFNumberFormatterKey kCFNumberFormatterDecimalSeparator; // CFString
CF_EXPORT const CFNumberFormatterKey kCFNumberFormatterCurrencyDecimalSeparator; // CFString
CF_EXPORT const CFNumberFormatterKey kCFNumberFormatterAlwaysShowDecimalSeparator; // CFBoolean
CF_EXPORT const CFNumberFormatterKey kCFNumberFormatterGroupingSeparator; // CFString
CF_EXPORT const CFNumberFormatterKey kCFNumberFormatterUseGroupingSeparator; // CFBoolean
CF_EXPORT const CFNumberFormatterKey kCFNumberFormatterPercentSymbol; // CFString
CF_EXPORT const CFNumberFormatterKey kCFNumberFormatterZeroSymbol; // CFString
CF_EXPORT const CFNumberFormatterKey kCFNumberFormatterNaNSymbol; // CFString
CF_EXPORT const CFNumberFormatterKey kCFNumberFormatterInfinitySymbol; // CFString
CF_EXPORT const CFNumberFormatterKey kCFNumberFormatterMinusSign; // CFString
CF_EXPORT const CFNumberFormatterKey kCFNumberFormatterPlusSign; // CFString
CF_EXPORT const CFNumberFormatterKey kCFNumberFormatterCurrencySymbol; // CFString
CF_EXPORT const CFNumberFormatterKey kCFNumberFormatterExponentSymbol; // CFString
CF_EXPORT const CFNumberFormatterKey kCFNumberFormatterMinIntegerDigits; // CFNumber
CF_EXPORT const CFNumberFormatterKey kCFNumberFormatterMaxIntegerDigits; // CFNumber
CF_EXPORT const CFNumberFormatterKey kCFNumberFormatterMinFractionDigits; // CFNumber
CF_EXPORT const CFNumberFormatterKey kCFNumberFormatterMaxFractionDigits; // CFNumber
CF_EXPORT const CFNumberFormatterKey kCFNumberFormatterGroupingSize; // CFNumber
CF_EXPORT const CFNumberFormatterKey kCFNumberFormatterSecondaryGroupingSize; // CFNumber
CF_EXPORT const CFNumberFormatterKey kCFNumberFormatterRoundingMode; // CFNumber
CF_EXPORT const CFNumberFormatterKey kCFNumberFormatterRoundingIncrement; // CFNumber
CF_EXPORT const CFNumberFormatterKey kCFNumberFormatterFormatWidth; // CFNumber
CF_EXPORT const CFNumberFormatterKey kCFNumberFormatterPaddingPosition; // CFNumber
CF_EXPORT const CFNumberFormatterKey kCFNumberFormatterPaddingCharacter; // CFString
CF_EXPORT const CFNumberFormatterKey kCFNumberFormatterDefaultFormat; // CFString
CF_EXPORT const CFNumberFormatterKey kCFNumberFormatterMultiplier; // CFNumber
CF_EXPORT const CFNumberFormatterKey kCFNumberFormatterPositivePrefix; // CFString
CF_EXPORT const CFNumberFormatterKey kCFNumberFormatterPositiveSuffix; // CFString
CF_EXPORT const CFNumberFormatterKey kCFNumberFormatterNegativePrefix; // CFString
CF_EXPORT const CFNumberFormatterKey kCFNumberFormatterNegativeSuffix; // CFString
CF_EXPORT const CFNumberFormatterKey kCFNumberFormatterPerMillSymbol; // CFString
CF_EXPORT const CFNumberFormatterKey kCFNumberFormatterInternationalCurrencySymbol; // CFString
CF_EXPORT const CFNumberFormatterKey kCFNumberFormatterCurrencyGroupingSeparator API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)); // CFString
CF_EXPORT const CFNumberFormatterKey kCFNumberFormatterIsLenient API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)); // CFBoolean
CF_EXPORT const CFNumberFormatterKey kCFNumberFormatterUseSignificantDigits API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)); // CFBoolean
CF_EXPORT const CFNumberFormatterKey kCFNumberFormatterMinSignificantDigits API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)); // CFNumber
CF_EXPORT const CFNumberFormatterKey kCFNumberFormatterMaxSignificantDigits API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0)); // CFNumber
typedef CF_ENUM(CFIndex, CFNumberFormatterRoundingMode) {
kCFNumberFormatterRoundCeiling = 0,
kCFNumberFormatterRoundFloor = 1,
kCFNumberFormatterRoundDown = 2,
kCFNumberFormatterRoundUp = 3,
kCFNumberFormatterRoundHalfEven = 4,
kCFNumberFormatterRoundHalfDown = 5,
kCFNumberFormatterRoundHalfUp = 6
};
typedef CF_ENUM(CFIndex, CFNumberFormatterPadPosition) {
kCFNumberFormatterPadBeforePrefix = 0,
kCFNumberFormatterPadAfterPrefix = 1,
kCFNumberFormatterPadBeforeSuffix = 2,
kCFNumberFormatterPadAfterSuffix = 3
};
CF_EXPORT
Boolean CFNumberFormatterGetDecimalInfoForCurrencyCode(CFStringRef currencyCode, int32_t *defaultFractionDigits, double *roundingIncrement);
// Returns the number of fraction digits that should be displayed, and
// the rounding increment (or 0.0 if no rounding is done by the currency)
// for the given currency. Returns false if the currency code is unknown
// or the information is not available.
// Not localized because these are properties of the currency.
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif /* ! __COREFOUNDATION_CFNUMBERFORMATTER__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFBundle.h | /* CFBundle.h
Copyright (c) 1999-2019, Apple Inc. All rights reserved.
*/
#if !defined(__COREFOUNDATION_CFBUNDLE__)
#define __COREFOUNDATION_CFBUNDLE__ 1
#include <CoreFoundation/CFBase.h>
#include <CoreFoundation/CFArray.h>
#include <CoreFoundation/CFDictionary.h>
#include <CoreFoundation/CFError.h>
#include <CoreFoundation/CFString.h>
#include <CoreFoundation/CFURL.h>
#if TARGET_OS_MAC
#include <mach/machine.h>
#endif
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
typedef struct CF_BRIDGED_TYPE(id) __CFBundle *CFBundleRef;
typedef struct CF_BRIDGED_TYPE(id) __CFBundle *CFPlugInRef;
/* ===================== Standard Info.plist keys ===================== */
CF_EXPORT
const CFStringRef kCFBundleInfoDictionaryVersionKey;
/* The version of the Info.plist format */
CF_EXPORT
const CFStringRef kCFBundleExecutableKey;
/* The name of the executable in this bundle, if any */
CF_EXPORT
const CFStringRef kCFBundleIdentifierKey;
/* The bundle identifier (for CFBundleGetBundleWithIdentifier()) */
CF_EXPORT
const CFStringRef kCFBundleVersionKey;
/* The version number of the bundle. For Mac OS 9 style version numbers (for example "2.5.3d5"), */
/* clients can use CFBundleGetVersionNumber() instead of accessing this key directly since that */
/* function will properly convert the version string into its compact integer representation. */
CF_EXPORT
const CFStringRef kCFBundleDevelopmentRegionKey;
/* The name of the development language of the bundle. */
CF_EXPORT
const CFStringRef kCFBundleNameKey;
/* The human-readable name of the bundle. This key is often found in the InfoPlist.strings since it is usually localized. */
CF_EXPORT
const CFStringRef kCFBundleLocalizationsKey;
/* Allows an unbundled application that handles localization itself to specify which localizations it has available. */
/* ===================== Finding Bundles ===================== */
CF_EXPORT
CFBundleRef CFBundleGetMainBundle(void);
CF_EXPORT
CFBundleRef CFBundleGetBundleWithIdentifier(CFStringRef bundleID);
/* A bundle can name itself by providing a key in the info dictionary. */
/* This facility is meant to allow bundle-writers to get hold of their */
/* bundle from their code without having to know where it was on the disk. */
/* This is meant to be a replacement mechanism for +bundleForClass: users. */
/* Note that this does not search for bundles on the disk; it will locate */
/* only bundles already loaded or otherwise known to the current process. */
CF_EXPORT
CFArrayRef CFBundleGetAllBundles(void);
/* This is potentially expensive, and not thread-safe. Use with care. */
/* Best used for debuggging or other diagnostic purposes. */
/* ===================== Creating Bundles ===================== */
CF_EXPORT
CFTypeID CFBundleGetTypeID(void);
CF_EXPORT
CFBundleRef CFBundleCreate(CFAllocatorRef allocator, CFURLRef bundleURL);
/* Might return an existing instance with the ref-count bumped. */
CF_EXPORT
CFArrayRef CFBundleCreateBundlesFromDirectory(CFAllocatorRef allocator, CFURLRef directoryURL, CFStringRef bundleType);
/* Create instances for all bundles in the given directory matching the given type */
/* (or all of them if bundleType is NULL). Instances are created using CFBundleCreate() and are not released. */
/* ==================== Basic Bundle Info ==================== */
CF_EXPORT
CFURLRef CFBundleCopyBundleURL(CFBundleRef bundle);
CF_EXPORT
CFTypeRef CFBundleGetValueForInfoDictionaryKey(CFBundleRef bundle, CFStringRef key);
/* Returns a localized value if available, otherwise the global value. */
/* This is the recommended function for examining the info dictionary. */
CF_EXPORT
CFDictionaryRef CFBundleGetInfoDictionary(CFBundleRef bundle);
/* This is the global info dictionary. Note that CFBundle may add */
/* extra keys to the dictionary for its own use. */
CF_EXPORT
CFDictionaryRef CFBundleGetLocalInfoDictionary(CFBundleRef bundle);
/* This is the localized info dictionary. */
CF_EXPORT
void CFBundleGetPackageInfo(CFBundleRef bundle, UInt32 *packageType, UInt32 *packageCreator);
CF_EXPORT
CFStringRef CFBundleGetIdentifier(CFBundleRef bundle);
CF_EXPORT
UInt32 CFBundleGetVersionNumber(CFBundleRef bundle);
CF_EXPORT
CFStringRef CFBundleGetDevelopmentRegion(CFBundleRef bundle);
CF_EXPORT
CFURLRef CFBundleCopySupportFilesDirectoryURL(CFBundleRef bundle);
CF_EXPORT
CFURLRef CFBundleCopyResourcesDirectoryURL(CFBundleRef bundle);
CF_EXPORT
CFURLRef CFBundleCopyPrivateFrameworksURL(CFBundleRef bundle);
CF_EXPORT
CFURLRef CFBundleCopySharedFrameworksURL(CFBundleRef bundle);
CF_EXPORT
CFURLRef CFBundleCopySharedSupportURL(CFBundleRef bundle);
CF_EXPORT
CFURLRef CFBundleCopyBuiltInPlugInsURL(CFBundleRef bundle);
/* ------------- Basic Bundle Info without a CFBundle instance ------------- */
/* This API is provided to enable developers to retrieve basic information */
/* about a bundle without having to create an instance of CFBundle. */
/* Because of caching behavior when a CFBundle instance exists, it will be faster */
/* to actually create a CFBundle if you need to retrieve multiple pieces of info. */
CF_EXPORT
CFDictionaryRef CFBundleCopyInfoDictionaryInDirectory(CFURLRef bundleURL);
CF_EXPORT
Boolean CFBundleGetPackageInfoInDirectory(CFURLRef url, UInt32 *packageType, UInt32 *packageCreator);
/* ==================== Resource Handling API ==================== */
CF_EXPORT
CFURLRef CFBundleCopyResourceURL(CFBundleRef bundle, CFStringRef resourceName, CFStringRef resourceType, CFStringRef subDirName);
CF_EXPORT
CFArrayRef CFBundleCopyResourceURLsOfType(CFBundleRef bundle, CFStringRef resourceType, CFStringRef subDirName);
CF_EXPORT
CFStringRef CFBundleCopyLocalizedString(CFBundleRef bundle, CFStringRef key, CFStringRef value, CFStringRef tableName) CF_FORMAT_ARGUMENT(2);
#define CFCopyLocalizedString(key, comment) \
CFBundleCopyLocalizedString(CFBundleGetMainBundle(), (key), (key), NULL)
#define CFCopyLocalizedStringFromTable(key, tbl, comment) \
CFBundleCopyLocalizedString(CFBundleGetMainBundle(), (key), (key), (tbl))
#define CFCopyLocalizedStringFromTableInBundle(key, tbl, bundle, comment) \
CFBundleCopyLocalizedString((bundle), (key), (key), (tbl))
#define CFCopyLocalizedStringWithDefaultValue(key, tbl, bundle, value, comment) \
CFBundleCopyLocalizedString((bundle), (key), (value), (tbl))
/* ------------- Resource Handling without a CFBundle instance ------------- */
/* This API is provided to enable developers to use the CFBundle resource */
/* searching policy without having to create an instance of CFBundle. */
/* Because of caching behavior when a CFBundle instance exists, it will be faster */
/* to actually create a CFBundle if you need to access several resources. */
CF_EXPORT
CFURLRef CFBundleCopyResourceURLInDirectory(CFURLRef bundleURL, CFStringRef resourceName, CFStringRef resourceType, CFStringRef subDirName);
CF_EXPORT
CFArrayRef CFBundleCopyResourceURLsOfTypeInDirectory(CFURLRef bundleURL, CFStringRef resourceType, CFStringRef subDirName);
/* =========== Localization-specific Resource Handling API =========== */
/* This API allows finer-grained control over specific localizations, */
/* as distinguished from the above API, which always uses the user's */
/* preferred localizations for the bundle in the current app context. */
CF_EXPORT
CFArrayRef CFBundleCopyBundleLocalizations(CFBundleRef bundle);
/* Lists the localizations that a bundle contains. */
CF_EXPORT
CFArrayRef CFBundleCopyPreferredLocalizationsFromArray(CFArrayRef locArray);
/* Given an array of possible localizations, returns the one or more */
/* of them that CFBundle would use in the current application context. */
/* To determine the localizations that would be used for a particular */
/* bundle in the current application context, apply this function to the */
/* result of CFBundleCopyBundleLocalizations(). */
CF_EXPORT
CFArrayRef CFBundleCopyLocalizationsForPreferences(CFArrayRef locArray, CFArrayRef prefArray);
/* Given an array of possible localizations, returns the one or more of */
/* them that CFBundle would use, without reference to the current application */
/* context, if the user's preferred localizations were given by prefArray. */
/* If prefArray is NULL, the current user's actual preferred localizations will */
/* be used. This is not the same as CFBundleCopyPreferredLocalizationsFromArray(), */
/* because that function takes the current application context into account. */
/* To determine the localizations that another application would use, apply */
/* this function to the result of CFBundleCopyBundleLocalizations(). */
CF_EXPORT
CFURLRef CFBundleCopyResourceURLForLocalization(CFBundleRef bundle, CFStringRef resourceName, CFStringRef resourceType, CFStringRef subDirName, CFStringRef localizationName);
CF_EXPORT
CFArrayRef CFBundleCopyResourceURLsOfTypeForLocalization(CFBundleRef bundle, CFStringRef resourceType, CFStringRef subDirName, CFStringRef localizationName);
/* The localizationName argument to CFBundleCopyResourceURLForLocalization() or */
/* CFBundleCopyResourceURLsOfTypeForLocalization() must be identical to one of the */
/* localizations in the bundle, as returned by CFBundleCopyBundleLocalizations(). */
/* It is recommended that either CFBundleCopyPreferredLocalizationsFromArray() or */
/* CFBundleCopyLocalizationsForPreferences() be used to select the localization. */
/* =================== Unbundled application info ===================== */
/* This API is provided to enable developers to retrieve bundle-related */
/* information about an application that may be bundled or unbundled. */
CF_EXPORT
CFDictionaryRef CFBundleCopyInfoDictionaryForURL(CFURLRef url);
/* For a directory URL, this is equivalent to CFBundleCopyInfoDictionaryInDirectory(). */
/* For a plain file URL representing an unbundled executable, this will attempt to read */
/* an info dictionary from the (__TEXT, __info_plist) section, if it is a Mach-o file. */
CF_EXPORT
CFArrayRef CFBundleCopyLocalizationsForURL(CFURLRef url);
/* For a directory URL, this is equivalent to calling CFBundleCopyBundleLocalizations() */
/* on the corresponding bundle. For a plain file URL representing an unbundled executable, */
/* this will attempt to determine its localizations using the CFBundleLocalizations and */
/* CFBundleDevelopmentRegion keys in the dictionary returned by CFBundleCopyInfoDictionaryForURL. */
CF_EXPORT
CFArrayRef CFBundleCopyExecutableArchitecturesForURL(CFURLRef url) API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0));
/* For a directory URL, this is equivalent to calling CFBundleCopyExecutableArchitectures() */
/* on the corresponding bundle. For a plain file URL representing an unbundled executable, */
/* this will return the architectures it provides, if it is a Mach-o file, or NULL otherwise. */
/* ==================== Primitive Code Loading API ==================== */
/* This API abstracts the various different executable formats supported on */
/* various platforms. It can load DYLD, CFM, or DLL shared libraries (on their */
/* appropriate platforms) and gives a uniform API for looking up functions. */
CF_EXPORT
CFURLRef CFBundleCopyExecutableURL(CFBundleRef bundle);
enum {
kCFBundleExecutableArchitectureI386 = 0x00000007,
kCFBundleExecutableArchitecturePPC = 0x00000012,
kCFBundleExecutableArchitectureX86_64 = 0x01000007,
kCFBundleExecutableArchitecturePPC64 = 0x01000012,
kCFBundleExecutableArchitectureARM64 API_AVAILABLE(macos(11.0), ios(14.0), watchos(7.0), tvos(14.0)) = 0x0100000c,
} API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0));
CF_EXPORT
CFArrayRef CFBundleCopyExecutableArchitectures(CFBundleRef bundle) API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0));
/* If the bundle's executable exists and is a Mach-o file, this function will return an array */
/* of CFNumbers whose values are integers representing the architectures the file provides. */
/* The values currently in use are those listed in the enum above, but others may be added */
/* in the future. If the executable is not a Mach-o file, this function returns NULL. */
CF_EXPORT
Boolean CFBundlePreflightExecutable(CFBundleRef bundle, CFErrorRef *error) API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0));
/* This function will return true if the bundle is loaded, or if the bundle appears to be */
/* loadable upon inspection. This does not mean that the bundle is definitively loadable, */
/* since it may fail to load due to link errors or other problems not readily detectable. */
/* If this function detects problems, it will return false, and return a CFError by reference. */
/* It is the responsibility of the caller to release the CFError. */
CF_EXPORT
Boolean CFBundleLoadExecutableAndReturnError(CFBundleRef bundle, CFErrorRef *error) API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0));
/* If the bundle is already loaded, this function will return true. Otherwise, it will attempt */
/* to load the bundle, and it will return true if that attempt succeeds. If the bundle fails */
/* to load, this function will return false, and it will return a CFError by reference. */
/* It is the responsibility of the caller to release the CFError. */
CF_EXPORT
Boolean CFBundleLoadExecutable(CFBundleRef bundle);
CF_EXPORT
Boolean CFBundleIsExecutableLoaded(CFBundleRef bundle);
CF_EXPORT
void CFBundleUnloadExecutable(CFBundleRef bundle);
CF_EXPORT
void *CFBundleGetFunctionPointerForName(CFBundleRef bundle, CFStringRef functionName);
CF_EXPORT
void CFBundleGetFunctionPointersForNames(CFBundleRef bundle, CFArrayRef functionNames, void *ftbl[]);
CF_EXPORT
void *CFBundleGetDataPointerForName(CFBundleRef bundle, CFStringRef symbolName);
CF_EXPORT
void CFBundleGetDataPointersForNames(CFBundleRef bundle, CFArrayRef symbolNames, void *stbl[]);
CF_EXPORT
CFURLRef CFBundleCopyAuxiliaryExecutableURL(CFBundleRef bundle, CFStringRef executableName);
/* This function can be used to find executables other than your main */
/* executable. This is useful, for instance, for applications that have */
/* some command line tool that is packaged with and used by the application. */
/* The tool can be packaged in the various platform executable directories */
/* in the bundle and can be located with this function. This allows an */
/* app to ship versions of the tool for each platform as it does for the */
/* main app executable. */
#if TARGET_OS_MAC
CF_EXPORT
Boolean CFBundleIsExecutableLoadable(CFBundleRef bundle) API_AVAILABLE(macos(11.0)) API_UNAVAILABLE(ios, watchos, tvos);
CF_EXPORT
Boolean CFBundleIsExecutableLoadableForURL(CFURLRef url) API_AVAILABLE(macos(11.0)) API_UNAVAILABLE(ios, watchos, tvos);
CF_EXPORT
Boolean CFBundleIsArchitectureLoadable(cpu_type_t arch) API_AVAILABLE(macos(11.0)) API_UNAVAILABLE(ios, watchos, tvos);
#endif
/* ==================== Getting a bundle's plugIn ==================== */
CF_EXPORT
CFPlugInRef CFBundleGetPlugIn(CFBundleRef bundle);
/* ==================== Resource Manager-Related API ==================== */
#if TARGET_RT_64_BIT
typedef int CFBundleRefNum;
#else
typedef SInt16 CFBundleRefNum;
#endif
CF_EXPORT
CFBundleRefNum CFBundleOpenBundleResourceMap(CFBundleRef bundle) API_DEPRECATED("The Carbon Resource Manager is deprecated. This should only be used to access Resource Manager-style resources in old bundles.", macosx(10.0, 10.15)) API_UNAVAILABLE(ios, watchos, tvos);
/* This function opens the non-localized and the localized resource files */
/* (if any) for the bundle, creates and makes current a single read-only */
/* resource map combining both, and returns a reference number for it. */
/* If it is called multiple times, it opens the files multiple times, */
/* and returns distinct reference numbers. */
CF_EXPORT
SInt32 CFBundleOpenBundleResourceFiles(CFBundleRef bundle, CFBundleRefNum *refNum, CFBundleRefNum *localizedRefNum) API_DEPRECATED("The Carbon Resource Manager is deprecated. This should only be used to access Resource Manager-style resources in old bundles.", macosx(10.0, 10.15)) API_UNAVAILABLE(ios, watchos, tvos);
/* Similar to CFBundleOpenBundleResourceMap(), except that it creates two */
/* separate resource maps and returns reference numbers for both. */
CF_EXPORT
void CFBundleCloseBundleResourceMap(CFBundleRef bundle, CFBundleRefNum refNum) API_DEPRECATED("The Carbon Resource Manager is deprecated. This should only be used to access Resource Manager-style resources in old bundles.", macosx(10.0, 10.15)) API_UNAVAILABLE(ios, watchos, tvos);
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif /* ! __COREFOUNDATION_CFBUNDLE__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFUserNotification.h | /* CFUserNotification.h
Copyright (c) 2000-2019, Apple Inc. and the Swift project authors
Portions Copyright (c) 2014-2019, Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See http://swift.org/LICENSE.txt for license information
See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
*/
#if !defined(__COREFOUNDATION_CFUSERNOTIFICATION__)
#define __COREFOUNDATION_CFUSERNOTIFICATION__ 1
#include <CoreFoundation/CFBase.h>
#include <CoreFoundation/CFDate.h>
#include <CoreFoundation/CFDictionary.h>
#include <CoreFoundation/CFString.h>
#include <CoreFoundation/CFURL.h>
#include <CoreFoundation/CFRunLoop.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
typedef struct CF_BRIDGED_MUTABLE_TYPE(id) __CFUserNotification * CFUserNotificationRef;
/* A CFUserNotification is a notification intended to be presented to a
user at the console (if one is present). This is for the use of processes
that do not otherwise have user interfaces, but may need occasional
interaction with a user. There is a parallel API for this functionality
at the System framework level, described in UNCUserNotification.h.
The contents of the notification can include a header, a message, textfields,
a popup button, radio buttons or checkboxes, a progress indicator, and up to
three ordinary buttons. All of these items are optional, but a default
button will be supplied even if not specified unless the
kCFUserNotificationNoDefaultButtonFlag is set.
The contents of the notification are specified in the dictionary used to
create the notification, whose keys should be taken from the list of constants
below, and whose values should be either strings or arrays of strings
(except for kCFUserNotificationProgressIndicatorValueKey, in which case the
value should be a number between 0 and 1, for a "definite" progress indicator,
or a boolean, for an "indefinite" progress indicator). Additionally, URLs can
optionally be supplied for an icon, a sound, and a bundle whose Localizable.strings
files will be used to localize strings.
Certain request flags are specified when a notification is created.
These specify an alert level for the notification, determine whether
radio buttons or check boxes are to be used, specify which if any of these
are checked by default, specify whether any of the textfields are to
be secure textfields, and determine which popup item should be selected
by default. A timeout is also specified, which determines how long the
notification should be supplied to the user (if zero, it will not timeout).
A CFUserNotification is dispatched for presentation when it is created.
If any reply is required, it may be awaited in one of two ways: either
synchronously, using CFUserNotificationReceiveResponse, or asynchronously,
using a run loop source. CFUserNotificationReceiveResponse has a timeout
parameter that determines how long it will block (zero meaning indefinitely)
and it may be called as many times as necessary until a response arrives.
If a notification has not yet received a response, it may be updated with
new information, or it may be cancelled. Notifications may not be reused.
When a response arrives, it carries with it response flags that describe
which button was used to dismiss the notification, which checkboxes or
radio buttons were checked, and what the selection of the popup was.
It also carries a response dictionary, which describes the contents
of the textfields. */
typedef void (*CFUserNotificationCallBack)(CFUserNotificationRef userNotification, CFOptionFlags responseFlags);
CF_EXPORT
CFTypeID CFUserNotificationGetTypeID(void) API_AVAILABLE(macos(10.0)) API_UNAVAILABLE(ios, watchos, tvos);
CF_EXPORT
CFUserNotificationRef CFUserNotificationCreate(CFAllocatorRef allocator, CFTimeInterval timeout, CFOptionFlags flags, SInt32 *error, CFDictionaryRef dictionary) API_AVAILABLE(macos(10.0)) API_UNAVAILABLE(ios, watchos, tvos);
CF_EXPORT
SInt32 CFUserNotificationReceiveResponse(CFUserNotificationRef userNotification, CFTimeInterval timeout, CFOptionFlags *responseFlags) API_AVAILABLE(macos(10.0)) API_UNAVAILABLE(ios, watchos, tvos);
CF_EXPORT
CFStringRef CFUserNotificationGetResponseValue(CFUserNotificationRef userNotification, CFStringRef key, CFIndex idx) API_AVAILABLE(macos(10.0)) API_UNAVAILABLE(ios, watchos, tvos);
CF_EXPORT
CFDictionaryRef CFUserNotificationGetResponseDictionary(CFUserNotificationRef userNotification) API_AVAILABLE(macos(10.0)) API_UNAVAILABLE(ios, watchos, tvos);
CF_EXPORT
SInt32 CFUserNotificationUpdate(CFUserNotificationRef userNotification, CFTimeInterval timeout, CFOptionFlags flags, CFDictionaryRef dictionary) API_AVAILABLE(macos(10.0)) API_UNAVAILABLE(ios, watchos, tvos);
CF_EXPORT
SInt32 CFUserNotificationCancel(CFUserNotificationRef userNotification) API_AVAILABLE(macos(10.0)) API_UNAVAILABLE(ios, watchos, tvos);
CF_EXPORT
CFRunLoopSourceRef CFUserNotificationCreateRunLoopSource(CFAllocatorRef allocator, CFUserNotificationRef userNotification, CFUserNotificationCallBack callout, CFIndex order) API_AVAILABLE(macos(10.0)) API_UNAVAILABLE(ios, watchos, tvos);
/* Convenience functions for handling the simplest and most common cases:
a one-way notification, and a notification with up to three buttons. */
CF_EXPORT
SInt32 CFUserNotificationDisplayNotice(CFTimeInterval timeout, CFOptionFlags flags, CFURLRef iconURL, CFURLRef soundURL, CFURLRef localizationURL, CFStringRef alertHeader, CFStringRef alertMessage, CFStringRef defaultButtonTitle) API_AVAILABLE(macos(10.0)) API_UNAVAILABLE(ios, watchos, tvos);
CF_EXPORT
SInt32 CFUserNotificationDisplayAlert(CFTimeInterval timeout, CFOptionFlags flags, CFURLRef iconURL, CFURLRef soundURL, CFURLRef localizationURL, CFStringRef alertHeader, CFStringRef alertMessage, CFStringRef defaultButtonTitle, CFStringRef alternateButtonTitle, CFStringRef otherButtonTitle, CFOptionFlags *responseFlags) API_AVAILABLE(macos(10.0)) API_UNAVAILABLE(ios, watchos, tvos);
/* Flags */
CF_ENUM(CFOptionFlags) {
kCFUserNotificationStopAlertLevel API_AVAILABLE(macos(10.0)) API_UNAVAILABLE(ios, watchos, tvos) = 0,
kCFUserNotificationNoteAlertLevel API_AVAILABLE(macos(10.0)) API_UNAVAILABLE(ios, watchos, tvos) = 1,
kCFUserNotificationCautionAlertLevel API_AVAILABLE(macos(10.0)) API_UNAVAILABLE(ios, watchos, tvos) = 2,
kCFUserNotificationPlainAlertLevel API_AVAILABLE(macos(10.0)) API_UNAVAILABLE(ios, watchos, tvos) = 3
};
CF_ENUM(CFOptionFlags) {
kCFUserNotificationDefaultResponse API_AVAILABLE(macos(10.0)) API_UNAVAILABLE(ios, watchos, tvos) = 0,
kCFUserNotificationAlternateResponse API_AVAILABLE(macos(10.0)) API_UNAVAILABLE(ios, watchos, tvos) = 1,
kCFUserNotificationOtherResponse API_AVAILABLE(macos(10.0)) API_UNAVAILABLE(ios, watchos, tvos) = 2,
kCFUserNotificationCancelResponse API_AVAILABLE(macos(10.0)) API_UNAVAILABLE(ios, watchos, tvos) = 3
};
CF_ENUM(CFOptionFlags) {
kCFUserNotificationNoDefaultButtonFlag API_AVAILABLE(macos(10.0)) API_UNAVAILABLE(ios, watchos, tvos) = (1UL << 5),
kCFUserNotificationUseRadioButtonsFlag API_AVAILABLE(macos(10.0)) API_UNAVAILABLE(ios, watchos, tvos) = (1UL << 6)
};
CF_INLINE CFOptionFlags CFUserNotificationCheckBoxChecked(CFIndex i) API_AVAILABLE(macos(10.0)) API_UNAVAILABLE(ios, watchos, tvos) {return ((CFOptionFlags)(1UL << (8 + i)));}
CF_INLINE CFOptionFlags CFUserNotificationSecureTextField(CFIndex i) API_AVAILABLE(macos(10.0)) API_UNAVAILABLE(ios, watchos, tvos) {return ((CFOptionFlags)(1UL << (16 + i)));}
CF_INLINE CFOptionFlags CFUserNotificationPopUpSelection(CFIndex n) API_AVAILABLE(macos(10.0)) API_UNAVAILABLE(ios, watchos, tvos) {return ((CFOptionFlags)(n << 24));}
/* Keys */
CF_EXPORT
const CFStringRef kCFUserNotificationIconURLKey API_AVAILABLE(macos(10.0)) API_UNAVAILABLE(ios, watchos, tvos);
CF_EXPORT
const CFStringRef kCFUserNotificationSoundURLKey API_AVAILABLE(macos(10.0)) API_UNAVAILABLE(ios, watchos, tvos);
CF_EXPORT
const CFStringRef kCFUserNotificationLocalizationURLKey API_AVAILABLE(macos(10.0)) API_UNAVAILABLE(ios, watchos, tvos);
CF_EXPORT
const CFStringRef kCFUserNotificationAlertHeaderKey API_AVAILABLE(macos(10.0)) API_UNAVAILABLE(ios, watchos, tvos);
CF_EXPORT
const CFStringRef kCFUserNotificationAlertMessageKey API_AVAILABLE(macos(10.0)) API_UNAVAILABLE(ios, watchos, tvos);
CF_EXPORT
const CFStringRef kCFUserNotificationDefaultButtonTitleKey API_AVAILABLE(macos(10.0)) API_UNAVAILABLE(ios, watchos, tvos);
CF_EXPORT
const CFStringRef kCFUserNotificationAlternateButtonTitleKey API_AVAILABLE(macos(10.0)) API_UNAVAILABLE(ios, watchos, tvos);
CF_EXPORT
const CFStringRef kCFUserNotificationOtherButtonTitleKey API_AVAILABLE(macos(10.0)) API_UNAVAILABLE(ios, watchos, tvos);
CF_EXPORT
const CFStringRef kCFUserNotificationProgressIndicatorValueKey API_AVAILABLE(macos(10.0)) API_UNAVAILABLE(ios, watchos, tvos);
CF_EXPORT
const CFStringRef kCFUserNotificationPopUpTitlesKey API_AVAILABLE(macos(10.0)) API_UNAVAILABLE(ios, watchos, tvos);
CF_EXPORT
const CFStringRef kCFUserNotificationTextFieldTitlesKey API_AVAILABLE(macos(10.0)) API_UNAVAILABLE(ios, watchos, tvos);
CF_EXPORT
const CFStringRef kCFUserNotificationCheckBoxTitlesKey API_AVAILABLE(macos(10.0)) API_UNAVAILABLE(ios, watchos, tvos);
CF_EXPORT
const CFStringRef kCFUserNotificationTextFieldValuesKey API_AVAILABLE(macos(10.0)) API_UNAVAILABLE(ios, watchos, tvos);
CF_EXPORT
const CFStringRef kCFUserNotificationPopUpSelectionKey API_AVAILABLE(macos(10.3)) API_UNAVAILABLE(ios, watchos, tvos);
CF_EXPORT
const CFStringRef kCFUserNotificationAlertTopMostKey API_AVAILABLE(macos(10.0)) API_UNAVAILABLE(ios, watchos, tvos);
CF_EXPORT
const CFStringRef kCFUserNotificationKeyboardTypesKey API_AVAILABLE(macos(10.0)) API_UNAVAILABLE(ios, watchos, tvos);
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif /* ! __COREFOUNDATION_CFUSERNOTIFICATION__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFAvailability.h | /* CFAvailability.h
Copyright (c) 2013-2019, Apple Inc. and the Swift project authors
Portions Copyright (c) 2014-2019, Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See http://swift.org/LICENSE.txt for license information
See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
*/
#if !defined(__COREFOUNDATION_CFAVAILABILITY__)
#define __COREFOUNDATION_CFAVAILABILITY__ 1
#if __has_include(<CoreFoundation/TargetConditionals.h>)
#include <CoreFoundation/TargetConditionals.h>
#else
#include <TargetConditionals.h>
#endif
#if __has_include(<Availability.h>) && __has_include(<os/availability.h>) && __has_include(<AvailabilityMacros.h>)
#include <Availability.h>
#include <os/availability.h>
// Even if unused, these must remain here for compatibility, because projects rely on them being included.
#include <AvailabilityMacros.h>
#else
#define API_AVAILABLE(...)
#define API_DEPRECATED(...)
#define API_UNAVAILABLE(...)
#endif
#ifndef __has_feature
#define __has_feature(x) 0
#endif
#ifndef __has_attribute
#define __has_attribute(x) 0
#endif
#ifndef __has_extension
#define __has_extension(x) 0
#endif
// The arguments to these availability macros is a version number, e.g. 10_6, 3_0 or 'NA'
// To use a deprecation message with the macro, add a string as the last argument.
#if __has_feature(attribute_availability_with_version_underscores) || (__has_feature(attribute_availability_with_message) && __clang__ && __clang_major__ >= 7)
#if TARGET_OS_OSX
// This section is for compilers targeting OS X which support attribute_availability_with_message
#define CF_AVAILABLE(_mac, _ios) __attribute__((availability(macosx,introduced=_mac)))
#define CF_AVAILABLE_MAC(_mac) __attribute__((availability(macosx,introduced=_mac)))
#define CF_AVAILABLE_IOS(_ios) __attribute__((availability(macosx,unavailable)))
#define CF_DEPRECATED(_macIntro, _macDep, _iosIntro, _iosDep, ...) __attribute__((availability(macosx,introduced=_macIntro,deprecated=_macDep,message="" __VA_ARGS__)))
#define CF_DEPRECATED_MAC(_macIntro, _macDep, ...) __attribute__((availability(macosx,introduced=_macIntro,deprecated=_macDep,message="" __VA_ARGS__)))
#define CF_DEPRECATED_IOS(_iosIntro, _iosDep, ...) __attribute__((availability(macosx,unavailable)))
#elif TARGET_OS_IPHONE
// This section is for compilers targeting iOS which support attribute_availability_with_message
#define CF_AVAILABLE(_mac, _ios) __attribute__((availability(ios,introduced=_ios)))
#define CF_AVAILABLE_MAC(_mac) __attribute__((availability(ios,unavailable)))
#define CF_AVAILABLE_IOS(_ios) __attribute__((availability(ios,introduced=_ios)))
#define CF_DEPRECATED(_macIntro, _macDep, _iosIntro, _iosDep, ...) __attribute__((availability(ios,introduced=_iosIntro,deprecated=_iosDep,message="" __VA_ARGS__)))
#define CF_DEPRECATED_MAC(_macIntro, _macDep, ...) __attribute__((availability(ios,unavailable)))
#define CF_DEPRECATED_IOS(_iosIntro, _iosDep, ...) __attribute__((availability(ios,introduced=_iosIntro,deprecated=_iosDep,message="" __VA_ARGS__)))
#endif
#elif TARGET_OS_OSX || TARGET_OS_IPHONE
// This section is for OS X or iOS, and compilers without support for attribute_availability_with_message. We fall back to Availability.h.
#ifndef __AVAILABILITY_INTERNAL__MAC_10_0_DEP__MAC_10_0
#define __AVAILABILITY_INTERNAL__MAC_10_0_DEP__MAC_10_0 __AVAILABILITY_INTERNAL_DEPRECATED
#endif
#define CF_AVAILABLE(_mac, _ios) __OSX_AVAILABLE_STARTING(__MAC_##_mac, __IPHONE_##_ios)
#define CF_AVAILABLE_MAC(_mac) __OSX_AVAILABLE_STARTING(__MAC_##_mac, __IPHONE_NA)
#define CF_AVAILABLE_IOS(_ios) __OSX_AVAILABLE_STARTING(__MAC_NA, __IPHONE_##_ios)
#define CF_DEPRECATED(_macIntro, _macDep, _iosIntro, _iosDep, ...) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_##_macIntro, __MAC_##_macDep, __IPHONE_##_iosIntro, __IPHONE_##_iosDep)
#define CF_DEPRECATED_MAC(_macIntro, _macDep, ...) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_##_macIntro, __MAC_##_macDep, __IPHONE_NA, __IPHONE_NA)
#define CF_DEPRECATED_IOS(_iosIntro, _iosDep, ...) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_NA, __MAC_NA, __IPHONE_##_iosIntro, __IPHONE_##_iosDep)
#endif // __has_feature(attribute_availability_with_message)
#ifndef CF_AVAILABLE
// This section is for platforms which do not support availability
#define CF_AVAILABLE(_mac, _ios)
#define CF_AVAILABLE_MAC(_mac)
#define CF_AVAILABLE_IOS(_ios)
#define CF_DEPRECATED(_macIntro, _macDep, _iosIntro, _iosDep, ...)
#define CF_DEPRECATED_MAC(_macIntro, _macDep, ...)
#define CF_DEPRECATED_IOS(_iosIntro, _iosDep, ...)
#endif
// Older versions of these macros; use iOS versions instead
#define CF_AVAILABLE_IPHONE(_ios) CF_AVAILABLE_IOS(_ios)
#define CF_DEPRECATED_IPHONE(_iosIntro, _iosDep) CF_DEPRECATED_IOS(_iosIntro, _iosDep)
// Enum availability macros
#if __has_feature(enumerator_attributes) && __has_attribute(availability)
#define CF_ENUM_AVAILABLE(_mac, _ios) CF_AVAILABLE(_mac, _ios)
#define CF_ENUM_AVAILABLE_MAC(_mac) CF_AVAILABLE_MAC(_mac)
#define CF_ENUM_AVAILABLE_IOS(_ios) CF_AVAILABLE_IOS(_ios)
#define CF_ENUM_DEPRECATED(_macIntro, _macDep, _iosIntro, _iosDep, ...) CF_DEPRECATED(_macIntro, _macDep, _iosIntro, _iosDep, __VA_ARGS__)
#define CF_ENUM_DEPRECATED_MAC(_macIntro, _macDep, ...) CF_DEPRECATED_MAC(_macIntro, _macDep, __VA_ARGS__)
#define CF_ENUM_DEPRECATED_IOS(_iosIntro, _iosDep, ...) CF_DEPRECATED_IOS(_iosIntro, _iosDep, __VA_ARGS__)
#else
#define CF_ENUM_AVAILABLE(_mac, _ios)
#define CF_ENUM_AVAILABLE_MAC(_mac)
#define CF_ENUM_AVAILABLE_IOS(_ios)
#define CF_ENUM_DEPRECATED(_macIntro, _macDep, _iosIntro, _iosDep, ...)
#define CF_ENUM_DEPRECATED_MAC(_macIntro, _macDep, ...)
#define CF_ENUM_DEPRECATED_IOS(_iosIntro, _iosDep, ...)
#endif
// "Soft" deprecation.
#ifndef API_TO_BE_DEPRECATED
/// This macro is used as a version number in API that will be deprecated in an upcoming release. We call this API "soft deprecated". Soft deprecation is an intermediate step before formal deprecation, used as a way to give you a heads-up about the API before you start getting a compiler warning.
/// You can find all places in your code that use soft deprecated API by redefining the value of this macro to your current minimum deployment target, for example:
/// (macOS)
/// clang -DAPI_TO_BE_DEPRECATED=10.12 other compiler flags
/// (iOS)
/// clang -DAPI_TO_BE_DEPRECATED=11.0 other compiler flags
#define API_TO_BE_DEPRECATED 100000
#endif
// Enums and Options
#if __has_attribute(enum_extensibility)
#define __CF_ENUM_ATTRIBUTES __attribute__((enum_extensibility(open)))
#define __CF_CLOSED_ENUM_ATTRIBUTES __attribute__((enum_extensibility(closed)))
#define __CF_OPTIONS_ATTRIBUTES __attribute__((flag_enum,enum_extensibility(open)))
#else
#define __CF_ENUM_ATTRIBUTES
#define __CF_CLOSED_ENUM_ATTRIBUTES
#define __CF_OPTIONS_ATTRIBUTES
#endif
#define __CF_ENUM_GET_MACRO(_1, _2, NAME, ...) NAME
#ifndef CF_OPEN_SOURCE
#define __CF_ENUM_FIXED_IS_AVAILABLE (__cplusplus && __cplusplus >= 201103L && (__has_extension(cxx_strong_enums) || __has_feature(objc_fixed_enum))) || (!__cplusplus && __has_feature(objc_fixed_enum))
#else
#define __CF_ENUM_FIXED_IS_AVAILABLE (__cplusplus && __cplusplus >= 201103L && (__has_extension(cxx_strong_enums) || __has_feature(objc_fixed_enum))) || (!__cplusplus && (__has_feature(objc_fixed_enum) || __has_extension(cxx_fixed_enum)))
#endif
#if __CF_ENUM_FIXED_IS_AVAILABLE
#define __CF_NAMED_ENUM(_type, _name) enum __CF_ENUM_ATTRIBUTES _name : _type _name; enum _name : _type
#define __CF_ANON_ENUM(_type) enum __CF_ENUM_ATTRIBUTES : _type
#define CF_CLOSED_ENUM(_type, _name) enum __CF_CLOSED_ENUM_ATTRIBUTES _name : _type _name; enum _name : _type
#if (__cplusplus)
#define CF_OPTIONS(_type, _name) _type _name; enum __CF_OPTIONS_ATTRIBUTES : _type
#else
#define CF_OPTIONS(_type, _name) enum __CF_OPTIONS_ATTRIBUTES _name : _type _name; enum _name : _type
#endif
#else
#define __CF_NAMED_ENUM(_type, _name) _type _name; enum
#define __CF_ANON_ENUM(_type) enum
#define CF_CLOSED_ENUM(_type, _name) _type _name; enum
#define CF_OPTIONS(_type, _name) _type _name; enum
#endif
/* CF_ENUM supports the use of one or two arguments. The first argument is always the integer type used for the values of the enum. The second argument is an optional type name for the macro. When specifying a type name, you must precede the macro with 'typedef' like so:
typedef CF_ENUM(CFIndex, CFComparisonResult) {
...
};
If you do not specify a type name, do not use 'typdef', like so:
CF_ENUM(CFIndex) {
...
};
*/
#define CF_ENUM(...) __CF_ENUM_GET_MACRO(__VA_ARGS__, __CF_NAMED_ENUM, __CF_ANON_ENUM, )(__VA_ARGS__)
#if __has_attribute(swift_wrapper)
#define _CF_TYPED_ENUM __attribute__((swift_wrapper(enum)))
#else
#define _CF_TYPED_ENUM
#endif
#if __has_attribute(swift_wrapper)
#define _CF_TYPED_EXTENSIBLE_ENUM __attribute__((swift_wrapper(struct)))
#else
#define _CF_TYPED_EXTENSIBLE_ENUM
#endif
#if DEPLOYMENT_RUNTIME_SWIFT
#define CF_STRING_ENUM
#define CF_EXTENSIBLE_STRING_ENUM
#define CF_TYPED_ENUM
#define CF_TYPED_EXTENSIBLE_ENUM
#else
#define CF_STRING_ENUM _CF_TYPED_ENUM
#define CF_EXTENSIBLE_STRING_ENUM _CF_TYPED_EXTENSIBLE_ENUM
#define CF_TYPED_ENUM _CF_TYPED_ENUM
#define CF_TYPED_EXTENSIBLE_ENUM _CF_TYPED_EXTENSIBLE_ENUM
#endif
#define __CF_ERROR_ENUM_GET_MACRO(_1, _2, NAME, ...) NAME
#if ((__cplusplus && __cplusplus >= 201103L && (__has_extension(cxx_strong_enums) || __has_feature(objc_fixed_enum))) || (!__cplusplus && __has_feature(objc_fixed_enum))) && __has_attribute(ns_error_domain)
#define __CF_NAMED_ERROR_ENUM(_domain, _name) enum __attribute__((ns_error_domain(_domain))) _name : CFIndex _name; enum _name : CFIndex
#define __CF_ANON_ERROR_ENUM(_domain) enum __attribute__((ns_error_domain(_domain))) : CFIndex
#else
#define __CF_NAMED_ERROR_ENUM(_domain, _name) __CF_NAMED_ENUM(CFIndex, _name)
#define __CF_ANON_ERROR_ENUM(_domain) __CF_ANON_ENUM(CFIndex)
#endif
/* CF_ERROR_ENUM supports the use of one or two arguments. The first argument is always the domain specifier for the enum. The second argument is an optional name of the typedef for the macro. When specifying a name for of the typedef, you must precede the macro with 'typedef' like so:
typedef CF_ERROR_ENUM(kCFSomeErrorDomain, SomeErrorCodes) {
...
};
If you do not specify a typedef name, do not use 'typedef', like so:
CF_ERROR_ENUM(kCFSomeErrorDomain) {
...
};
*/
#define CF_ERROR_ENUM(...) __CF_ERROR_ENUM_GET_MACRO(__VA_ARGS__, __CF_NAMED_ERROR_ENUM, __CF_ANON_ERROR_ENUM)(__VA_ARGS__)
#ifndef CF_SWIFT_BRIDGED_TYPEDEF
#if __has_attribute(swift_bridged_typedef)
#define CF_SWIFT_BRIDGED_TYPEDEF __attribute__((swift_bridged_typedef))
#else
#define CF_SWIFT_BRIDGED_TYPEDEF
#endif
#endif
// Extension availability macros
#define CF_EXTENSION_UNAVAILABLE(_msg) __OS_EXTENSION_UNAVAILABLE(_msg)
#define CF_EXTENSION_UNAVAILABLE_MAC(_msg) __OSX_EXTENSION_UNAVAILABLE(_msg)
#define CF_EXTENSION_UNAVAILABLE_IOS(_msg) __IOS_EXTENSION_UNAVAILABLE(_msg)
// Swift availability macro
#if __has_feature(attribute_availability_swift)
#define CF_SWIFT_UNAVAILABLE(_msg) __attribute__((availability(swift, unavailable, message=_msg)))
#else
#define CF_SWIFT_UNAVAILABLE(_msg)
#endif
#endif // __COREFOUNDATION_CFAVAILABILITY__
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFStringTokenizer.h | /* CFStringTokenizer.h
Copyright (c) 2006-2019, Apple Inc. All rights reserved.
*/
/*!
@header CFStringTokenizer
@abstract A CFStringTokenizer object provides the means by which you can
tokenize a string. To find a token that includes the character
specified by character index and set it as the current token, you call
CFStringTokenizerGoToTokenAtIndex. To advance to the next token and set
it as the current token, you call CFStringTokenizerAdvanceToNextToken.
To get the range of current token, you call
CFStringTokenizerGetCurrentTokenRange. You can use
CFStringTokenizerCopyCurrentTokenAttribute to get the attribute of
current token. If current token is a compound, you can call
CFStringTokenizerGetCurrentSubTokens to retrieve the subtokens or derived
subtokens contained in the compound token.
To guess the language of a string, you call
CFStringTokenizerCopyBestStringLanguage.
*/
#if !defined(__COREFOUNDATION_CFSTRINGTOKENIZER__)
#define __COREFOUNDATION_CFSTRINGTOKENIZER__ 1
#include <CoreFoundation/CFBase.h>
#include <CoreFoundation/CFLocale.h>
#include <CoreFoundation/CFString.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
/*
===================================================================
Language Identifier
===================================================================
*/
/*!
@function CFStringTokenizerCopyBestStringLanguage
@abstract Guesses the language of a string and returns the BCP 47 string of the
language.
@param string The string whose language is to be guessed.
@param range The range of characters in string whose language to be
guessed. The specified range must not exceed the bounds of the string.
@result A language represented in BCP 47 string. NULL is returned either if
string is NULL, the location of range is negative, the length of range
is 0, or the language of the string cannot be guessed.
@discussion The result is not guaranteed to be accurate. Typically 200-400
characters are required to reliably guess the language of a string.
*/
CF_EXPORT
CFStringRef CFStringTokenizerCopyBestStringLanguage(CFStringRef string, CFRange range) API_AVAILABLE(macos(10.5), ios(3.0), watchos(2.0), tvos(9.0));
/*
===================================================================
Tokenization
===================================================================
*/
typedef struct CF_BRIDGED_MUTABLE_TYPE(id) __CFStringTokenizer * CFStringTokenizerRef;
/*!
Tokenization options
*/
CF_ENUM(CFOptionFlags) {
/*!
Tokenization Unit
Use one of tokenization unit options with CFStringTokenizerCreate to
specify how the string should be tokenized.
*/
/* kCFStringTokenizerUnitWord doesn't return space between words as a token. */
kCFStringTokenizerUnitWord = 0,
kCFStringTokenizerUnitSentence = 1,
kCFStringTokenizerUnitParagraph = 2,
kCFStringTokenizerUnitLineBreak = 3,
/* kCFStringTokenizerUnitWordBoundary can be used in double click detection
and whole word search. It is locale sensitive. If the locale parameter of
CFStringTokenizerCreate is NULL, default locale is used.
kCFStringTokenizerUnitWordBoundary returns space between words as a token. */
kCFStringTokenizerUnitWordBoundary = 4,
/*!
Attribute Specifier
Use attribute specifier to tell tokenizer to prepare the specified attribute
when it tokenizes the given string. The attribute value can be retrieved by
calling CFStringTokenizerCopyCurrentTokenAttribute with one of the attribute
option.
*/
/* Latin Transcription. Used with kCFStringTokenizerUnitWord or
kCFStringTokenizerUnitWordBoundary */
kCFStringTokenizerAttributeLatinTranscription = 1UL << 16,
/* Language in BCP 47 string. Used with kCFStringTokenizerUnitSentence
or kCFStringTokenizerUnitParagraph. */
kCFStringTokenizerAttributeLanguage = 1UL << 17,
};
/*!
Token type
CFStringTokenizerGoToTokenAtIndex / CFStringTokenizerAdvanceToNextToken returns
the type of current token.
*/
typedef CF_OPTIONS(CFOptionFlags, CFStringTokenizerTokenType) {
/* Have no token. */
kCFStringTokenizerTokenNone = 0,
/* Normal token */
kCFStringTokenizerTokenNormal = 1UL << 0,
/*!
Compound token which may contain subtokens but with no derived subtokens.
Its subtokens can be obtained by calling CFStringTokenizerGetCurrentSubTokens.
*/
kCFStringTokenizerTokenHasSubTokensMask = 1UL << 1,
/*!
Compound token which may contain derived subtokens.
Its subtokens and derived subtokens can be obtained by calling
CFStringTokenizerGetCurrentSubTokens.
*/
kCFStringTokenizerTokenHasDerivedSubTokensMask = 1UL << 2,
kCFStringTokenizerTokenHasHasNumbersMask = 1UL << 3,
kCFStringTokenizerTokenHasNonLettersMask = 1UL << 4,
kCFStringTokenizerTokenIsCJWordMask = 1UL << 5
};
/*!
@function CFStringTokenizerGetTypeID
@abstract Get the type identifier.
@result the type identifier of all CFStringTokenizer instances.
*/
CF_EXPORT
CFTypeID CFStringTokenizerGetTypeID(void) API_AVAILABLE(macos(10.5), ios(3.0), watchos(2.0), tvos(9.0));
/*!
@function CFStringTokenizerCreate
@abstract Creates a tokenizer instance.
@param alloc The CFAllocator which should be used to allocate memory for the
tokenizer and its storage for values. This parameter may be NULL in which
case the current default CFAllocator is used.
@param string The string to tokenize.
@param range The range of characters within the string to be tokenized. The
specified range must not exceed the length of the string.
@param options Use one of the Tokenization Unit options to specify how the
string should be tokenized. Optionally specify one or more attribute
specifiers to tell the tokenizer to prepare specified attributes when it
tokenizes the string.
@param locale The locale to specify language or region specific behavior. Pass
NULL if you want tokenizer to identify the locale automatically.
@result A reference to the new CFStringTokenizer.
*/
CF_EXPORT
CFStringTokenizerRef CFStringTokenizerCreate(CFAllocatorRef alloc, CFStringRef string, CFRange range, CFOptionFlags options, CFLocaleRef locale) API_AVAILABLE(macos(10.5), ios(3.0), watchos(2.0), tvos(9.0));
/*!
@function CFStringTokenizerSetString
@abstract Set the string to tokenize.
@param tokenizer The reference to CFStringTokenizer returned by
CFStringTokenizerCreate.
@param string The string to tokenize.
@param range The range of characters within the string to be tokenized. The
specified range must not exceed the length of the string.
*/
CF_EXPORT
void CFStringTokenizerSetString(CFStringTokenizerRef tokenizer, CFStringRef string, CFRange range) API_AVAILABLE(macos(10.5), ios(3.0), watchos(2.0), tvos(9.0));
/*!
@function CFStringTokenizerGoToTokenAtIndex
@abstract Random access to a token. Find a token that includes the character specified
by character index, and set it as the current token.
@param tokenizer The reference to CFStringTokenizer returned by
CFStringTokenizerCreate.
@param index The index of the Unicode character in the CFString.
@result Type of the token if succeeded in finding a token and setting it as
current token. kCFStringTokenizerTokenNone if failed in finding a token.
@discussion The range and attribute of the token can be obtained by calling
CFStringTokenizerGetCurrentTokenRange and CFStringTokenizerCopyCurrentTokenAttribute.
If the token is a compound (with type kCFStringTokenizerTokenHasSubTokensMask or
kCFStringTokenizerTokenHasDerivedSubTokensMask), its subtokens and
(or) derived subtokens can be obtained by calling CFStringTokenizerGetCurrentSubTokens.
*/
CF_EXPORT
CFStringTokenizerTokenType CFStringTokenizerGoToTokenAtIndex(CFStringTokenizerRef tokenizer, CFIndex index) API_AVAILABLE(macos(10.5), ios(3.0), watchos(2.0), tvos(9.0));
/*!
@function CFStringTokenizerAdvanceToNextToken
@abstract Token enumerator.
@param tokenizer The reference to CFStringTokenizer returned by
CFStringTokenizerCreate.
@result Type of the token if succeeded in finding a token and setting it as
current token. kCFStringTokenizerTokenNone if failed in finding a token.
@discussion If there is no preceding call to CFStringTokenizerGoToTokenAtIndex
or CFStringTokenizerAdvanceToNextToken, it finds the first token in the range
specified to CFStringTokenizerCreate. If there is a current token after successful
call to CFStringTokenizerGoToTokenAtIndex or CFStringTokenizerAdvanceToNextToken,
it proceeds to the next token. If succeeded in finding a token, set it as current
token and return its token type. Otherwise invalidate current token and return
kCFStringTokenizerTokenNone.
The range and attribute of the token can be obtained by calling
CFStringTokenizerGetCurrentTokenRange and
CFStringTokenizerCopyCurrentTokenAttribute. If the token is a compound
(with type kCFStringTokenizerTokenHasSubTokensMask or
kCFStringTokenizerTokenHasDerivedSubTokensMask), its subtokens and
(or) derived subtokens can be obtained by calling CFStringTokenizerGetCurrentSubTokens.
*/
CF_EXPORT
CFStringTokenizerTokenType CFStringTokenizerAdvanceToNextToken(CFStringTokenizerRef tokenizer) API_AVAILABLE(macos(10.5), ios(3.0), watchos(2.0), tvos(9.0));
/*!
@function CFStringTokenizerGetCurrentTokenRange
@abstract Returns the range of current token.
@param tokenizer The reference to CFStringTokenizer returned by
CFStringTokenizerCreate.
@result Range of current token, or {kCFNotFound,0} if there is no current token.
*/
CF_EXPORT
CFRange CFStringTokenizerGetCurrentTokenRange(CFStringTokenizerRef tokenizer) API_AVAILABLE(macos(10.5), ios(3.0), watchos(2.0), tvos(9.0));
/*!
@function CFStringTokenizerCopyCurrentTokenAttribute
@abstract Copies the specified attribute of current token.
@param tokenizer The reference to CFStringTokenizer returned by
CFStringTokenizerCreate.
@param attribute Specify a token attribute you want to obtain. The value is
one of kCFStringTokenizerAttributeLatinTranscription or
kCFStringTokenizerAttributeLanguage.
@result Token attribute, or NULL if current token does not have the specified
attribute or if there is no current token.
*/
CF_EXPORT
CFTypeRef CFStringTokenizerCopyCurrentTokenAttribute(CFStringTokenizerRef tokenizer, CFOptionFlags attribute) API_AVAILABLE(macos(10.5), ios(3.0), watchos(2.0), tvos(9.0));
/*!
@function CFStringTokenizerGetCurrentSubTokens
@abstract Retrieves the subtokens or derived subtokens contained in the compound token.
@param tokenizer The reference to CFStringTokenizer returned by CFStringTokenizerCreate.
@param ranges An array of CFRange to fill in with the ranges of subtokens. The filled in
ranges are relative to the string specified to CFStringTokenizerCreate. This parameter
can be NULL.
@param maxRangeLength The maximum number of ranges to return.
@param derivedSubTokens An array of CFMutableArray to which the derived subtokens are to
be added. This parameter can be NULL.
@result number of subtokens.
@discussion If token type is kCFStringTokenizerTokenNone, the ranges array and
derivedSubTokens array are untouched and the return value is 0.
If token type is kCFStringTokenizerTokenNormal, the ranges array has one item
filled in with the entire range of the token (if maxRangeLength >= 1) and a string
taken from the entire token range is added to the derivedSubTokens array and the
return value is 1.
If token type is kCFStringTokenizerTokenHasSubTokensMask or
kCFStringTokenizerTokenHasDerivedSubTokensMask, the ranges array is filled
in with as many items as there are subtokens (up to a limit of maxRangeLength).
The derivedSubTokens array will have sub tokens added even when the sub token is a
substring of the token. If token type is kCFStringTokenizerTokenHasSubTokensMask,
the ordinary non-derived subtokens are added to the derivedSubTokens array.
*/
CF_EXPORT
CFIndex CFStringTokenizerGetCurrentSubTokens(CFStringTokenizerRef tokenizer, CFRange *ranges, CFIndex maxRangeLength, CFMutableArrayRef derivedSubTokens) API_AVAILABLE(macos(10.5), ios(3.0), watchos(2.0), tvos(9.0));
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif /* ! __COREFOUNDATION_CFSTRINGTOKENIZER__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFBase.h | /* CFBase.h
Copyright (c) 1998-2019, Apple Inc. and the Swift project authors
Portions Copyright (c) 2014-2019, Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See http://swift.org/LICENSE.txt for license information
See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
*/
#if !defined(__COREFOUNDATION_CFBASE__)
#define __COREFOUNDATION_CFBASE__ 1
#if __has_include(<CoreFoundation/TargetConditionals.h>)
#include <CoreFoundation/TargetConditionals.h>
#else
#include <TargetConditionals.h>
#endif
#include <CoreFoundation/CFAvailability.h>
#if (defined(__CYGWIN32__) || defined(_WIN32)) && !defined(__WIN32__)
#define __WIN32__ 1
#endif
#if defined(_WIN64) && !defined(__WIN64__)
#define __WIN64__ 1
#endif
#if defined(__WIN64__) && !defined(__LLP64__)
#define __LLP64__ 1
#endif
#if defined(_MSC_VER) && defined(_M_IX86)
#define __i386__ 1
#endif
#if (defined(__i386__) || defined(__x86_64__)) && !defined(__LITTLE_ENDIAN__)
#define __LITTLE_ENDIAN__ 1
#endif
#if !defined(__BIG_ENDIAN__) && !defined(__LITTLE_ENDIAN__)
#error Do not know the endianess of this architecture
#endif
#if !__BIG_ENDIAN__ && !__LITTLE_ENDIAN__
#error Both __BIG_ENDIAN__ and __LITTLE_ENDIAN__ cannot be false
#endif
#if __BIG_ENDIAN__ && __LITTLE_ENDIAN__
#error Both __BIG_ENDIAN__ and __LITTLE_ENDIAN__ cannot be true
#endif
// Some compilers provide the capability to test if certain features are available. This macro provides a compatibility path for other compilers.
#ifndef __has_feature
#define __has_feature(x) 0
#endif
// Some compilers provide the capability to test if certain attributes are available. This macro provides a compatibility path for other compilers.
#ifndef __has_attribute
#define __has_attribute(x) 0
#endif
#ifndef __has_extension
#define __has_extension(x) 0
#endif
#if defined(__GNUC__) || TARGET_OS_WIN32
#include <stdint.h>
#include <stdbool.h>
#endif
#if __BLOCKS__ && (TARGET_OS_OSX || TARGET_OS_IPHONE)
#include <Block.h>
#endif
#ifndef CF_OPEN_SOURCE
#if defined(__CF_USE_FRAMEWORK_INCLUDES__) || (TARGET_OS_OSX || TARGET_OS_IPHONE)
#include <MacTypes.h>
#endif
#else
#if (TARGET_OS_OSX || TARGET_OS_IPHONE) && !DEPLOYMENT_RUNTIME_SWIFT
#include <libkern/OSTypes.h>
#endif
#endif
#if !defined(__MACTYPES__)
#if !defined(_OS_OSTYPES_H)
#if DEPLOYMENT_RUNTIME_SWIFT
typedef _Bool Boolean;
#else
typedef unsigned char Boolean;
#endif
typedef unsigned char UInt8;
typedef signed char SInt8;
typedef unsigned short UInt16;
typedef signed short SInt16;
typedef unsigned int UInt32;
typedef signed int SInt32;
typedef uint64_t UInt64;
typedef int64_t SInt64;
typedef SInt32 OSStatus;
#endif
typedef float Float32;
typedef double Float64;
typedef unsigned short UniChar;
typedef unsigned long UniCharCount;
typedef unsigned char * StringPtr;
typedef const unsigned char * ConstStringPtr;
typedef unsigned char Str255[256];
typedef const unsigned char * ConstStr255Param;
typedef SInt16 OSErr;
typedef SInt16 RegionCode;
typedef SInt16 LangCode;
typedef SInt16 ScriptCode;
typedef UInt32 FourCharCode;
typedef FourCharCode OSType;
typedef UInt8 Byte;
typedef SInt8 SignedByte;
#endif
#if !defined(__MACTYPES__) || (defined(UNIVERSAL_INTERFACES_VERSION) && UNIVERSAL_INTERFACES_VERSION < 0x0340)
typedef UInt32 UTF32Char;
typedef UInt16 UTF16Char;
typedef UInt8 UTF8Char;
#endif
#if !defined(CF_EXTERN_C_BEGIN)
#if defined(__cplusplus)
#define CF_EXTERN_C_BEGIN extern "C" {
#define CF_EXTERN_C_END }
#else
#define CF_EXTERN_C_BEGIN
#define CF_EXTERN_C_END
#endif
#endif
#if TARGET_OS_WIN32
#if defined(__cplusplus)
#define _CF_EXTERN extern "C"
#else
#define _CF_EXTERN extern
#endif
#if defined(_WINDLL)
#if defined(CoreFoundation_EXPORTS) || defined(CF_BUILDING_CF)
#define CF_EXPORT _CF_EXTERN __declspec(dllexport)
#else
#define CF_EXPORT _CF_EXTERN __declspec(dllimport)
#endif
#else
#define CF_EXPORT _CF_EXTERN
#endif
#else
#define CF_EXPORT extern
#endif
CF_EXTERN_C_BEGIN
#if !defined(NULL)
#if defined(__GNUG__)
#define NULL __null
#elif defined(__cplusplus)
#define NULL 0
#else
#define NULL ((void *)0)
#endif
#endif
#if !defined(TRUE)
#define TRUE 1
#endif
#if !defined(FALSE)
#define FALSE 0
#endif
#if !defined(CF_INLINE)
#if defined(__GNUC__) && (__GNUC__ == 4) && !defined(DEBUG)
#define CF_INLINE static __inline__ __attribute__((always_inline))
#elif defined(__GNUC__)
#define CF_INLINE static __inline__
#elif defined(__cplusplus)
#define CF_INLINE static inline
#elif defined(_MSC_VER)
#define CF_INLINE static __inline
#elif TARGET_OS_WIN32
#define CF_INLINE static __inline__
#endif
#endif
// Marks functions which return a CF type that needs to be released by the caller but whose names are not consistent with CoreFoundation naming rules. The recommended fix to this is to rename the functions, but this macro can be used to let the clang static analyzer know of any exceptions that cannot be fixed.
// This macro is ONLY to be used in exceptional circumstances, not to annotate functions which conform to the CoreFoundation naming rules.
#ifndef CF_RETURNS_RETAINED
#if __has_feature(attribute_cf_returns_retained)
#define CF_RETURNS_RETAINED __attribute__((cf_returns_retained))
#else
#define CF_RETURNS_RETAINED
#endif
#endif
// Marks functions which return a CF type that may need to be retained by the caller but whose names are not consistent with CoreFoundation naming rules. The recommended fix to this is to rename the functions, but this macro can be used to let the clang static analyzer know of any exceptions that cannot be fixed.
// This macro is ONLY to be used in exceptional circumstances, not to annotate functions which conform to the CoreFoundation naming rules.
#ifndef CF_RETURNS_NOT_RETAINED
#if __has_feature(attribute_cf_returns_not_retained)
#define CF_RETURNS_NOT_RETAINED __attribute__((cf_returns_not_retained))
#else
#define CF_RETURNS_NOT_RETAINED
#endif
#endif
// Marks function arguments which are released by the callee.
#ifndef CF_RELEASES_ARGUMENT
#if __has_feature(attribute_cf_consumed)
#define CF_RELEASES_ARGUMENT __attribute__((cf_consumed))
#else
#define CF_RELEASES_ARGUMENT
#endif
#endif
// Compatibility
#ifndef CF_CONSUMED
#if __has_feature(attribute_cf_consumed)
#define CF_CONSUMED __attribute__((cf_consumed))
#else
#define CF_CONSUMED
#endif
#endif
// Marks functions which cannot be used when compiling in automatic reference counting mode.
#if __has_feature(objc_arc)
#define CF_AUTOMATED_REFCOUNT_UNAVAILABLE __attribute__((unavailable("not available in automatic reference counting mode")))
#else
#define CF_AUTOMATED_REFCOUNT_UNAVAILABLE
#endif
#ifndef CF_IMPLICIT_BRIDGING_ENABLED
#if __has_feature(arc_cf_code_audited)
#define CF_IMPLICIT_BRIDGING_ENABLED _Pragma("clang arc_cf_code_audited begin")
#else
#define CF_IMPLICIT_BRIDGING_ENABLED
#endif
#endif
#ifndef CF_IMPLICIT_BRIDGING_DISABLED
#if __has_feature(arc_cf_code_audited)
#define CF_IMPLICIT_BRIDGING_DISABLED _Pragma("clang arc_cf_code_audited end")
#else
#define CF_IMPLICIT_BRIDGING_DISABLED
#endif
#endif
#if __has_attribute(objc_bridge) && __has_feature(objc_bridge_id) && __has_feature(objc_bridge_id_on_typedefs)
#ifdef __OBJC__
@class NSArray;
@class NSAttributedString;
@class NSString;
@class NSNull;
@class NSCharacterSet;
@class NSData;
@class NSDate;
@class NSTimeZone;
@class NSDictionary;
@class NSError;
@class NSLocale;
@class NSNumber;
@class NSSet;
@class NSURL;
#endif
#define CF_BRIDGED_TYPE(T) __attribute__((objc_bridge(T)))
#define CF_BRIDGED_MUTABLE_TYPE(T) __attribute__((objc_bridge_mutable(T)))
#define CF_RELATED_TYPE(T,C,I) __attribute__((objc_bridge_related(T,C,I)))
#else
#define CF_BRIDGED_TYPE(T)
#define CF_BRIDGED_MUTABLE_TYPE(T)
#define CF_RELATED_TYPE(T,C,I)
#endif
#if __has_feature(assume_nonnull)
#define CF_ASSUME_NONNULL_BEGIN _Pragma("clang assume_nonnull begin")
#define CF_ASSUME_NONNULL_END _Pragma("clang assume_nonnull end")
#else
#define CF_ASSUME_NONNULL_BEGIN
#define CF_ASSUME_NONNULL_END
#endif
#if !__has_feature(nullability)
#ifndef _Nullable
#define _Nullable
#endif
#ifndef _Nonnull
#define _Nonnull
#endif
#ifndef _Null_unspecified
#define _Null_unspecified
#endif
#endif
#if __has_attribute(swift_private)
# define CF_REFINED_FOR_SWIFT __attribute__((swift_private))
#else
# define CF_REFINED_FOR_SWIFT
#endif
#if __has_attribute(swift_name)
# define CF_SWIFT_NAME(_name) __attribute__((swift_name(#_name)))
#else
# define CF_SWIFT_NAME(_name)
#endif
#if __has_attribute(noescape)
#define CF_NOESCAPE __attribute__((noescape))
#else
#define CF_NOESCAPE
#endif
#if __has_attribute(not_tail_called)
#define CF_NO_TAIL_CALL __attribute__((not_tail_called))
#else
#define CF_NO_TAIL_CALL
#endif
#if __has_attribute(warn_unused_result)
#define CF_WARN_UNUSED_RESULT __attribute__((warn_unused_result))
#else
#define CF_WARN_UNUSED_RESULT
#endif
#if !__has_feature(objc_generics_variance)
#ifndef __covariant
#define __covariant
#endif
#ifndef __contravariant
#define __contravariant
#endif
#endif
CF_EXPORT double kCFCoreFoundationVersionNumber;
#if TARGET_OS_MAC
#define kCFCoreFoundationVersionNumber10_0 196.40
#define kCFCoreFoundationVersionNumber10_0_3 196.50
#define kCFCoreFoundationVersionNumber10_1 226.00
#define kCFCoreFoundationVersionNumber10_1_1 226.00
/* Note the next three do not follow the usual numbering policy from the base release */
#define kCFCoreFoundationVersionNumber10_1_2 227.20
#define kCFCoreFoundationVersionNumber10_1_3 227.20
#define kCFCoreFoundationVersionNumber10_1_4 227.30
#define kCFCoreFoundationVersionNumber10_2 263.00
#define kCFCoreFoundationVersionNumber10_2_1 263.10
#define kCFCoreFoundationVersionNumber10_2_2 263.10
#define kCFCoreFoundationVersionNumber10_2_3 263.30
#define kCFCoreFoundationVersionNumber10_2_4 263.30
#define kCFCoreFoundationVersionNumber10_2_5 263.50
#define kCFCoreFoundationVersionNumber10_2_6 263.50
#define kCFCoreFoundationVersionNumber10_2_7 263.50
#define kCFCoreFoundationVersionNumber10_2_8 263.50
#define kCFCoreFoundationVersionNumber10_3 299.00
#define kCFCoreFoundationVersionNumber10_3_1 299.00
#define kCFCoreFoundationVersionNumber10_3_2 299.00
#define kCFCoreFoundationVersionNumber10_3_3 299.30
#define kCFCoreFoundationVersionNumber10_3_4 299.31
#define kCFCoreFoundationVersionNumber10_3_5 299.31
#define kCFCoreFoundationVersionNumber10_3_6 299.32
#define kCFCoreFoundationVersionNumber10_3_7 299.33
#define kCFCoreFoundationVersionNumber10_3_8 299.33
#define kCFCoreFoundationVersionNumber10_3_9 299.35
#define kCFCoreFoundationVersionNumber10_4 368.00
#define kCFCoreFoundationVersionNumber10_4_1 368.10
#define kCFCoreFoundationVersionNumber10_4_2 368.11
#define kCFCoreFoundationVersionNumber10_4_3 368.18
#define kCFCoreFoundationVersionNumber10_4_4_Intel 368.26
#define kCFCoreFoundationVersionNumber10_4_4_PowerPC 368.25
#define kCFCoreFoundationVersionNumber10_4_5_Intel 368.26
#define kCFCoreFoundationVersionNumber10_4_5_PowerPC 368.25
#define kCFCoreFoundationVersionNumber10_4_6_Intel 368.26
#define kCFCoreFoundationVersionNumber10_4_6_PowerPC 368.25
#define kCFCoreFoundationVersionNumber10_4_7 368.27
#define kCFCoreFoundationVersionNumber10_4_8 368.27
#define kCFCoreFoundationVersionNumber10_4_9 368.28
#define kCFCoreFoundationVersionNumber10_4_10 368.28
#define kCFCoreFoundationVersionNumber10_4_11 368.31
#define kCFCoreFoundationVersionNumber10_5 476.00
#define kCFCoreFoundationVersionNumber10_5_1 476.00
#define kCFCoreFoundationVersionNumber10_5_2 476.10
#define kCFCoreFoundationVersionNumber10_5_3 476.13
#define kCFCoreFoundationVersionNumber10_5_4 476.14
#define kCFCoreFoundationVersionNumber10_5_5 476.15
#define kCFCoreFoundationVersionNumber10_5_6 476.17
#define kCFCoreFoundationVersionNumber10_5_7 476.18
#define kCFCoreFoundationVersionNumber10_5_8 476.19
#define kCFCoreFoundationVersionNumber10_6 550.00
#define kCFCoreFoundationVersionNumber10_6_1 550.00
#define kCFCoreFoundationVersionNumber10_6_2 550.13
#define kCFCoreFoundationVersionNumber10_6_3 550.19
#define kCFCoreFoundationVersionNumber10_6_4 550.29
#define kCFCoreFoundationVersionNumber10_6_5 550.42
#define kCFCoreFoundationVersionNumber10_6_6 550.42
#define kCFCoreFoundationVersionNumber10_6_7 550.42
#define kCFCoreFoundationVersionNumber10_6_8 550.43
#define kCFCoreFoundationVersionNumber10_7 635.00
#define kCFCoreFoundationVersionNumber10_7_1 635.00
#define kCFCoreFoundationVersionNumber10_7_2 635.15
#define kCFCoreFoundationVersionNumber10_7_3 635.19
#define kCFCoreFoundationVersionNumber10_7_4 635.21
#define kCFCoreFoundationVersionNumber10_7_5 635.21
#define kCFCoreFoundationVersionNumber10_8 744.00
#define kCFCoreFoundationVersionNumber10_8_1 744.00
#define kCFCoreFoundationVersionNumber10_8_2 744.12
#define kCFCoreFoundationVersionNumber10_8_3 744.18
#define kCFCoreFoundationVersionNumber10_8_4 744.19
#define kCFCoreFoundationVersionNumber10_9 855.11
#define kCFCoreFoundationVersionNumber10_9_1 855.11
#define kCFCoreFoundationVersionNumber10_9_2 855.14
#define kCFCoreFoundationVersionNumber10_10 1151.16
#define kCFCoreFoundationVersionNumber10_10_1 1151.16
#define kCFCoreFoundationVersionNumber10_10_2 1152
#define kCFCoreFoundationVersionNumber10_10_3 1153.18
#define kCFCoreFoundationVersionNumber10_10_4 1153.18
#define kCFCoreFoundationVersionNumber10_10_5 1153.18
#define kCFCoreFoundationVersionNumber10_10_Max 1199
#define kCFCoreFoundationVersionNumber10_11 1253
#define kCFCoreFoundationVersionNumber10_11_1 1255.1
#define kCFCoreFoundationVersionNumber10_11_2 1256.14
#define kCFCoreFoundationVersionNumber10_11_3 1256.14
#define kCFCoreFoundationVersionNumber10_11_4 1258.1
#define kCFCoreFoundationVersionNumber10_11_Max 1299
#endif
#if TARGET_OS_IPHONE
#define kCFCoreFoundationVersionNumber_iPhoneOS_2_0 478.23
#define kCFCoreFoundationVersionNumber_iPhoneOS_2_1 478.26
#define kCFCoreFoundationVersionNumber_iPhoneOS_2_2 478.29
#define kCFCoreFoundationVersionNumber_iPhoneOS_3_0 478.47
#define kCFCoreFoundationVersionNumber_iPhoneOS_3_1 478.52
#define kCFCoreFoundationVersionNumber_iPhoneOS_3_2 478.61
#define kCFCoreFoundationVersionNumber_iOS_4_0 550.32
#define kCFCoreFoundationVersionNumber_iOS_4_1 550.38
#define kCFCoreFoundationVersionNumber_iOS_4_2 550.52
#define kCFCoreFoundationVersionNumber_iOS_4_3 550.52
#define kCFCoreFoundationVersionNumber_iOS_5_0 675.00
#define kCFCoreFoundationVersionNumber_iOS_5_1 690.10
#define kCFCoreFoundationVersionNumber_iOS_6_0 793.00
#define kCFCoreFoundationVersionNumber_iOS_6_1 793.00
#define kCFCoreFoundationVersionNumber_iOS_7_0 847.20
#define kCFCoreFoundationVersionNumber_iOS_7_1 847.24
#define kCFCoreFoundationVersionNumber_iOS_8_0 1140.1
#define kCFCoreFoundationVersionNumber_iOS_8_1 1141.14
#define kCFCoreFoundationVersionNumber_iOS_8_2 1142.16
#define kCFCoreFoundationVersionNumber_iOS_8_3 1144.17
#define kCFCoreFoundationVersionNumber_iOS_8_4 1145.15
#define kCFCoreFoundationVersionNumber_iOS_8_x_Max 1199
#define kCFCoreFoundationVersionNumber_iOS_9_0 1240.1
#define kCFCoreFoundationVersionNumber_iOS_9_1 1241.11
#define kCFCoreFoundationVersionNumber_iOS_9_2 1242.13
#define kCFCoreFoundationVersionNumber_iOS_9_3 1242.13
#define kCFCoreFoundationVersionNumber_iOS_9_4 1280.38
#define kCFCoreFoundationVersionNumber_iOS_9_x_Max 1299
#endif
#if __LLP64__
typedef unsigned long long CFTypeID;
typedef unsigned long long CFOptionFlags;
typedef unsigned long long CFHashCode;
typedef signed long long CFIndex;
#else
typedef unsigned long CFTypeID;
typedef unsigned long CFOptionFlags;
typedef unsigned long CFHashCode;
typedef signed long CFIndex;
#endif
/* Base "type" of all "CF objects", and polymorphic functions on them */
typedef const CF_BRIDGED_TYPE(id) void * CFTypeRef;
typedef const struct CF_BRIDGED_TYPE(NSString) __CFString * CFStringRef;
typedef struct CF_BRIDGED_MUTABLE_TYPE(NSMutableString) __CFString * CFMutableStringRef;
/*
Type to mean any instance of a property list type;
currently, CFString, CFData, CFNumber, CFBoolean, CFDate,
CFArray, and CFDictionary.
*/
typedef CF_BRIDGED_TYPE(id) CFTypeRef CFPropertyListRef;
/* Values returned from comparison functions */
typedef CF_ENUM(CFIndex, CFComparisonResult) {
kCFCompareLessThan = -1L,
kCFCompareEqualTo = 0,
kCFCompareGreaterThan = 1
};
/* A standard comparison function */
typedef CFComparisonResult (*CFComparatorFunction)(const void *val1, const void *val2, void *context);
/* Constant used by some functions to indicate failed searches. */
static const CFIndex kCFNotFound = -1;
/* Range type */
typedef struct {
CFIndex location;
CFIndex length;
} CFRange;
#if defined(CF_INLINE)
CF_INLINE CFRange CFRangeMake(CFIndex loc, CFIndex len) {
CFRange range;
range.location = loc;
range.length = len;
return range;
}
#else
#define CFRangeMake(LOC, LEN) __CFRangeMake(LOC, LEN)
#endif
/* Private; do not use */
CF_EXPORT
CFRange __CFRangeMake(CFIndex loc, CFIndex len);
/* Null representant */
typedef const struct CF_BRIDGED_TYPE(NSNull) __CFNull * CFNullRef;
CF_EXPORT
CFTypeID CFNullGetTypeID(void);
CF_EXPORT
const CFNullRef kCFNull; // the singleton null instance
/* Allocator API
Most of the time when specifying an allocator to Create functions, the NULL
argument indicates "use the default"; this is the same as using kCFAllocatorDefault
or the return value from CFAllocatorGetDefault(). This assures that you will use
the allocator in effect at that time.
*/
typedef const struct CF_BRIDGED_TYPE(id) __CFAllocator * CFAllocatorRef;
/* This is a synonym for NULL, if you'd rather use a named constant. */
CF_EXPORT
const CFAllocatorRef kCFAllocatorDefault;
/* Default system allocator; you rarely need to use this. */
CF_EXPORT
const CFAllocatorRef kCFAllocatorSystemDefault;
/* This allocator uses malloc(), realloc(), and free(). This should not be
generally used; stick to kCFAllocatorDefault whenever possible. This
allocator is useful as the "bytesDeallocator" in CFData or
"contentsDeallocator" in CFString where the memory was obtained as a
result of malloc() type functions.
*/
CF_EXPORT
const CFAllocatorRef kCFAllocatorMalloc;
/* This allocator explicitly uses the default malloc zone, returned by
malloc_default_zone(). It should only be used when an object is
safe to be allocated in non-scanned memory.
*/
CF_EXPORT
const CFAllocatorRef kCFAllocatorMallocZone;
/* Null allocator which does nothing and allocates no memory. This allocator
is useful as the "bytesDeallocator" in CFData or "contentsDeallocator"
in CFString where the memory should not be freed.
*/
CF_EXPORT
const CFAllocatorRef kCFAllocatorNull;
/* Special allocator argument to CFAllocatorCreate() which means
"use the functions given in the context to allocate the allocator
itself as well".
*/
CF_EXPORT
const CFAllocatorRef kCFAllocatorUseContext;
typedef const void * (*CFAllocatorRetainCallBack)(const void *info);
typedef void (*CFAllocatorReleaseCallBack)(const void *info);
typedef CFStringRef (*CFAllocatorCopyDescriptionCallBack)(const void *info);
typedef void * (*CFAllocatorAllocateCallBack)(CFIndex allocSize, CFOptionFlags hint, void *info);
typedef void * (*CFAllocatorReallocateCallBack)(void *ptr, CFIndex newsize, CFOptionFlags hint, void *info);
typedef void (*CFAllocatorDeallocateCallBack)(void *ptr, void *info);
typedef CFIndex (*CFAllocatorPreferredSizeCallBack)(CFIndex size, CFOptionFlags hint, void *info);
typedef struct {
CFIndex version;
void * info;
CFAllocatorRetainCallBack retain;
CFAllocatorReleaseCallBack release;
CFAllocatorCopyDescriptionCallBack copyDescription;
CFAllocatorAllocateCallBack allocate;
CFAllocatorReallocateCallBack reallocate;
CFAllocatorDeallocateCallBack deallocate;
CFAllocatorPreferredSizeCallBack preferredSize;
} CFAllocatorContext;
CF_EXPORT
CFTypeID CFAllocatorGetTypeID(void);
/*
CFAllocatorSetDefault() sets the allocator that is used in the current
thread whenever NULL is specified as an allocator argument. This means
that most, if not all allocations will go through this allocator. It
also means that any allocator set as the default needs to be ready to
deal with arbitrary memory allocation requests; in addition, the size
and number of requests will change between releases.
An allocator set as the default will never be released, even if later
another allocator replaces it as the default. Not only is it impractical
for it to be released (as there might be caches created under the covers
that refer to the allocator), in general it's also safer and more
efficient to keep it around.
If you wish to use a custom allocator in a context, it's best to provide
it as the argument to the various creation functions rather than setting
it as the default. Setting the default allocator is not encouraged.
If you do set an allocator as the default, either do it for all time in
your app, or do it in a nested fashion (by restoring the previous allocator
when you exit your context). The latter might be appropriate for plug-ins
or libraries that wish to set the default allocator.
*/
CF_EXPORT
void CFAllocatorSetDefault(CFAllocatorRef allocator);
CF_EXPORT
CFAllocatorRef CFAllocatorGetDefault(void);
CF_EXPORT
CFAllocatorRef CFAllocatorCreate(CFAllocatorRef allocator, CFAllocatorContext *context);
CF_EXPORT
void *CFAllocatorAllocate(CFAllocatorRef allocator, CFIndex size, CFOptionFlags hint);
CF_EXPORT
void *CFAllocatorReallocate(CFAllocatorRef allocator, void *ptr, CFIndex newsize, CFOptionFlags hint);
CF_EXPORT
void CFAllocatorDeallocate(CFAllocatorRef allocator, void *ptr);
CF_EXPORT
CFIndex CFAllocatorGetPreferredSizeForSize(CFAllocatorRef allocator, CFIndex size, CFOptionFlags hint);
CF_EXPORT
void CFAllocatorGetContext(CFAllocatorRef allocator, CFAllocatorContext *context);
/* Polymorphic CF functions */
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXPORT
CFTypeID CFGetTypeID(CFTypeRef cf);
CF_EXPORT
CFStringRef CFCopyTypeIDDescription(CFTypeID type_id);
CF_EXPORT
CFTypeRef CFRetain(CFTypeRef cf);
CF_EXPORT
void CFRelease(CFTypeRef cf);
#if DEPLOYMENT_RUNTIME_SWIFT
#else
CF_EXPORT
CFTypeRef CFAutorelease(CFTypeRef CF_RELEASES_ARGUMENT arg) API_AVAILABLE(macos(10.9), ios(7.0), watchos(2.0), tvos(9.0));
CF_EXPORT
CFIndex CFGetRetainCount(CFTypeRef cf);
#endif
CF_EXPORT
Boolean CFEqual(CFTypeRef cf1, CFTypeRef cf2);
CF_EXPORT
CFHashCode CFHash(CFTypeRef cf);
CF_EXPORT
CFStringRef CFCopyDescription(CFTypeRef cf);
CF_EXPORT
CFAllocatorRef CFGetAllocator(CFTypeRef cf);
CF_IMPLICIT_BRIDGING_DISABLED
// This function is unavailable in ARC mode. On OS X 10.12 and later, this function simply returns the argument.
CF_EXPORT
CFTypeRef CFMakeCollectable(CFTypeRef cf) CF_AUTOMATED_REFCOUNT_UNAVAILABLE;
#if DEPLOYMENT_RUNTIME_SWIFT
#define _CF_SWIFT_RC_PINNED_FLAG (0x1)
#define _CF_CONSTANT_OBJECT_STRONG_RC ((uintptr_t)_CF_SWIFT_RC_PINNED_FLAG)
#endif
#if __has_include(<ptrauth.h>)
#include <ptrauth.h>
#endif
#ifndef __ptrauth_objc_isa_pointer
#define __ptrauth_objc_isa_pointer
#endif
#define ISA_PTRAUTH_DISCRIMINATOR 0x6AE1
#if defined(__ptrauth_objc_isa_uintptr)
#define __ptrauth_cf_objc_isa_pointer __ptrauth_objc_isa_uintptr
#elif defined(__arm64e__) && defined(__PTRAUTH_INTRINSICS__) && __has_feature(ptrauth_objc_isa)
#define __ptrauth_cf_objc_isa_pointer __ptrauth_restricted_intptr(ptrauth_key_objc_isa_pointer, 1, ISA_PTRAUTH_DISCRIMINATOR)
#else
#define __ptrauth_cf_objc_isa_pointer
#endif
CF_EXTERN_C_END
#endif /* ! __COREFOUNDATION_CFBASE__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFBitVector.h | /* CFBitVector.h
Copyright (c) 1998-2019, Apple Inc. and the Swift project authors
Portions Copyright (c) 2014-2019, Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See http://swift.org/LICENSE.txt for license information
See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
*/
#if !defined(__COREFOUNDATION_CFBITVECTOR__)
#define __COREFOUNDATION_CFBITVECTOR__ 1
#include <CoreFoundation/CFBase.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
typedef UInt32 CFBit;
typedef const struct CF_BRIDGED_TYPE(id) __CFBitVector * CFBitVectorRef;
typedef struct CF_BRIDGED_MUTABLE_TYPE(id) __CFBitVector * CFMutableBitVectorRef;
CF_EXPORT CFTypeID CFBitVectorGetTypeID(void);
CF_EXPORT CFBitVectorRef CFBitVectorCreate(CFAllocatorRef allocator, const UInt8 *bytes, CFIndex numBits);
CF_EXPORT CFBitVectorRef CFBitVectorCreateCopy(CFAllocatorRef allocator, CFBitVectorRef bv);
CF_EXPORT CFMutableBitVectorRef CFBitVectorCreateMutable(CFAllocatorRef allocator, CFIndex capacity);
CF_EXPORT CFMutableBitVectorRef CFBitVectorCreateMutableCopy(CFAllocatorRef allocator, CFIndex capacity, CFBitVectorRef bv);
CF_EXPORT CFIndex CFBitVectorGetCount(CFBitVectorRef bv);
CF_EXPORT CFIndex CFBitVectorGetCountOfBit(CFBitVectorRef bv, CFRange range, CFBit value);
CF_EXPORT Boolean CFBitVectorContainsBit(CFBitVectorRef bv, CFRange range, CFBit value);
CF_EXPORT CFBit CFBitVectorGetBitAtIndex(CFBitVectorRef bv, CFIndex idx);
CF_EXPORT void CFBitVectorGetBits(CFBitVectorRef bv, CFRange range, UInt8 *bytes);
CF_EXPORT CFIndex CFBitVectorGetFirstIndexOfBit(CFBitVectorRef bv, CFRange range, CFBit value);
CF_EXPORT CFIndex CFBitVectorGetLastIndexOfBit(CFBitVectorRef bv, CFRange range, CFBit value);
CF_EXPORT void CFBitVectorSetCount(CFMutableBitVectorRef bv, CFIndex count);
CF_EXPORT void CFBitVectorFlipBitAtIndex(CFMutableBitVectorRef bv, CFIndex idx);
CF_EXPORT void CFBitVectorFlipBits(CFMutableBitVectorRef bv, CFRange range);
CF_EXPORT void CFBitVectorSetBitAtIndex(CFMutableBitVectorRef bv, CFIndex idx, CFBit value);
CF_EXPORT void CFBitVectorSetBits(CFMutableBitVectorRef bv, CFRange range, CFBit value);
CF_EXPORT void CFBitVectorSetAllBits(CFMutableBitVectorRef bv, CFBit value);
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif /* ! __COREFOUNDATION_CFBITVECTOR__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Headers/CFLocale.h | /* CFLocale.h
Copyright (c) 2002-2019, Apple Inc. and the Swift project authors
Portions Copyright (c) 2014-2019, Apple Inc. and the Swift project authors
Licensed under Apache License v2.0 with Runtime Library Exception
See http://swift.org/LICENSE.txt for license information
See http://swift.org/CONTRIBUTORS.txt for the list of Swift project authors
*/
#if !defined(__COREFOUNDATION_CFLOCALE__)
#define __COREFOUNDATION_CFLOCALE__ 1
#include <CoreFoundation/CFBase.h>
#include <CoreFoundation/CFArray.h>
#include <CoreFoundation/CFDictionary.h>
#include <CoreFoundation/CFNotificationCenter.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
typedef CFStringRef CFLocaleIdentifier CF_EXTENSIBLE_STRING_ENUM;
typedef CFStringRef CFLocaleKey CF_STRING_ENUM;
typedef const struct CF_BRIDGED_TYPE(NSLocale) __CFLocale *CFLocaleRef;
CF_EXPORT
CFTypeID CFLocaleGetTypeID(void);
CF_EXPORT
CFLocaleRef CFLocaleGetSystem(void);
// Returns the "root", canonical locale. Contains fixed "backstop" settings.
CF_EXPORT
CFLocaleRef CFLocaleCopyCurrent(void);
// Returns the logical "user" locale for the current user.
// [This is Copy in the sense that you get a retain you have to release,
// but we may return the same cached object over and over.] Settings
// you get from this locale do not change under you as CFPreferences
// are changed (for safety and correctness). Generally you would not
// grab this and hold onto it forever, but use it to do the operations
// you need to do at the moment, then throw it away. (The non-changing
// ensures that all the results of your operations are consistent.)
CF_EXPORT
CFArrayRef CFLocaleCopyAvailableLocaleIdentifiers(void);
// Returns an array of CFStrings that represents all locales for
// which locale data is available.
CF_EXPORT
CFArrayRef CFLocaleCopyISOLanguageCodes(void);
// Returns an array of CFStrings that represents all known legal ISO
// language codes. Note: many of these will not have any supporting
// locale data in Mac OS X.
CF_EXPORT
CFArrayRef CFLocaleCopyISOCountryCodes(void);
// Returns an array of CFStrings that represents all known legal ISO
// country codes. Note: many of these will not have any supporting
// locale data in Mac OS X.
CF_EXPORT
CFArrayRef CFLocaleCopyISOCurrencyCodes(void);
// Returns an array of CFStrings that represents all known legal ISO
// currency codes. Note: some of these currencies may be obsolete, or
// represent other financial instruments.
CF_EXPORT
CFArrayRef CFLocaleCopyCommonISOCurrencyCodes(void) API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0));
// Returns an array of CFStrings that represents ISO currency codes for
// currencies in common use.
CF_EXPORT
CFArrayRef CFLocaleCopyPreferredLanguages(void) API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0));
// Returns the array of canonicalized CFString locale IDs that the user prefers.
CF_EXPORT
CFLocaleIdentifier CFLocaleCreateCanonicalLanguageIdentifierFromString(CFAllocatorRef allocator, CFStringRef localeIdentifier);
// Map an arbitrary language identification string (something close at
// least) to a canonical language identifier.
CF_EXPORT
CFLocaleIdentifier CFLocaleCreateCanonicalLocaleIdentifierFromString(CFAllocatorRef allocator, CFStringRef localeIdentifier);
// Map an arbitrary locale identification string (something close at
// least) to the canonical identifier.
CF_EXPORT
CFLocaleIdentifier CFLocaleCreateCanonicalLocaleIdentifierFromScriptManagerCodes(CFAllocatorRef allocator, LangCode lcode, RegionCode rcode);
// Map a Mac OS LangCode and RegionCode to the canonical locale identifier.
CF_EXPORT
CFLocaleIdentifier CFLocaleCreateLocaleIdentifierFromWindowsLocaleCode(CFAllocatorRef allocator, uint32_t lcid) API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
// Map a Windows LCID to the canonical locale identifier.
CF_EXPORT
uint32_t CFLocaleGetWindowsLocaleCodeFromLocaleIdentifier(CFLocaleIdentifier localeIdentifier) API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
// Map a locale identifier to a Windows LCID.
typedef CF_ENUM(CFIndex, CFLocaleLanguageDirection) {
kCFLocaleLanguageDirectionUnknown = 0,
kCFLocaleLanguageDirectionLeftToRight = 1,
kCFLocaleLanguageDirectionRightToLeft = 2,
kCFLocaleLanguageDirectionTopToBottom = 3,
kCFLocaleLanguageDirectionBottomToTop = 4
};
CF_EXPORT
CFLocaleLanguageDirection CFLocaleGetLanguageCharacterDirection(CFStringRef isoLangCode) API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
CF_EXPORT
CFLocaleLanguageDirection CFLocaleGetLanguageLineDirection(CFStringRef isoLangCode) API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
CF_EXPORT
CFDictionaryRef CFLocaleCreateComponentsFromLocaleIdentifier(CFAllocatorRef allocator, CFLocaleIdentifier localeID);
// Parses a locale ID consisting of language, script, country, variant,
// and keyword/value pairs into a dictionary. The keys are the constant
// CFStrings corresponding to the locale ID components, and the values
// will correspond to constants where available.
// Example: "en_US@calendar=japanese" yields a dictionary with three
// entries: kCFLocaleLanguageCode=en, kCFLocaleCountryCode=US, and
// kCFLocaleCalendarIdentifier=kCFJapaneseCalendar.
CF_EXPORT
CFLocaleIdentifier CFLocaleCreateLocaleIdentifierFromComponents(CFAllocatorRef allocator, CFDictionaryRef dictionary);
// Reverses the actions of CFLocaleCreateDictionaryFromLocaleIdentifier,
// creating a single string from the data in the dictionary. The
// dictionary {kCFLocaleLanguageCode=en, kCFLocaleCountryCode=US,
// kCFLocaleCalendarIdentifier=kCFJapaneseCalendar} becomes
// "en_US@calendar=japanese".
CF_EXPORT
CFLocaleRef CFLocaleCreate(CFAllocatorRef allocator, CFLocaleIdentifier localeIdentifier);
// Returns a CFLocaleRef for the locale named by the "arbitrary" locale identifier.
CF_EXPORT
CFLocaleRef CFLocaleCreateCopy(CFAllocatorRef allocator, CFLocaleRef locale);
// Having gotten a CFLocale from somebody, code should make a copy
// if it is going to use it for several operations
// or hold onto it. In the future, there may be mutable locales.
CF_EXPORT
CFLocaleIdentifier CFLocaleGetIdentifier(CFLocaleRef locale);
// Returns the locale's identifier. This may not be the same string
// that the locale was created with (CFLocale may canonicalize it).
CF_EXPORT
CFTypeRef CFLocaleGetValue(CFLocaleRef locale, CFLocaleKey key);
// Returns the value for the given key. This is how settings and state
// are accessed via a CFLocale. Values might be of any CF type.
CF_EXPORT
CFStringRef CFLocaleCopyDisplayNameForPropertyValue(CFLocaleRef displayLocale, CFLocaleKey key, CFStringRef value);
// Returns the display name for the given value. The key tells what
// the value is, and is one of the usual locale property keys, though
// not all locale property keys have values with display name values.
CF_EXPORT const CFNotificationName kCFLocaleCurrentLocaleDidChangeNotification API_AVAILABLE(macos(10.5), ios(2.0), watchos(2.0), tvos(9.0));
// Locale Keys
CF_EXPORT const CFLocaleKey kCFLocaleIdentifier;
CF_EXPORT const CFLocaleKey kCFLocaleLanguageCode;
CF_EXPORT const CFLocaleKey kCFLocaleCountryCode;
CF_EXPORT const CFLocaleKey kCFLocaleScriptCode;
CF_EXPORT const CFLocaleKey kCFLocaleVariantCode;
CF_EXPORT const CFLocaleKey kCFLocaleExemplarCharacterSet;
CF_EXPORT const CFLocaleKey kCFLocaleCalendarIdentifier;
CF_EXPORT const CFLocaleKey kCFLocaleCalendar;
CF_EXPORT const CFLocaleKey kCFLocaleCollationIdentifier;
CF_EXPORT const CFLocaleKey kCFLocaleUsesMetricSystem;
CF_EXPORT const CFLocaleKey kCFLocaleMeasurementSystem; // "Metric", "U.S." or "U.K."
CF_EXPORT const CFLocaleKey kCFLocaleDecimalSeparator;
CF_EXPORT const CFLocaleKey kCFLocaleGroupingSeparator;
CF_EXPORT const CFLocaleKey kCFLocaleCurrencySymbol;
CF_EXPORT const CFLocaleKey kCFLocaleCurrencyCode; // ISO 3-letter currency code
CF_EXPORT const CFLocaleKey kCFLocaleCollatorIdentifier API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
CF_EXPORT const CFLocaleKey kCFLocaleQuotationBeginDelimiterKey API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
CF_EXPORT const CFLocaleKey kCFLocaleQuotationEndDelimiterKey API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
CF_EXPORT const CFLocaleKey kCFLocaleAlternateQuotationBeginDelimiterKey API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
CF_EXPORT const CFLocaleKey kCFLocaleAlternateQuotationEndDelimiterKey API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
// Values for kCFLocaleCalendarIdentifier
typedef CFStringRef CFCalendarIdentifier CF_STRING_ENUM;
CF_EXPORT const CFCalendarIdentifier kCFGregorianCalendar;
CF_EXPORT const CFCalendarIdentifier kCFBuddhistCalendar;
CF_EXPORT const CFCalendarIdentifier kCFChineseCalendar;
CF_EXPORT const CFCalendarIdentifier kCFHebrewCalendar;
CF_EXPORT const CFCalendarIdentifier kCFIslamicCalendar;
CF_EXPORT const CFCalendarIdentifier kCFIslamicCivilCalendar;
CF_EXPORT const CFCalendarIdentifier kCFJapaneseCalendar;
CF_EXPORT const CFCalendarIdentifier kCFRepublicOfChinaCalendar API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
CF_EXPORT const CFCalendarIdentifier kCFPersianCalendar API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
CF_EXPORT const CFCalendarIdentifier kCFIndianCalendar API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
CF_EXPORT const CFCalendarIdentifier kCFISO8601Calendar API_AVAILABLE(macos(10.6), ios(4.0), watchos(2.0), tvos(9.0));
CF_EXPORT const CFCalendarIdentifier kCFIslamicTabularCalendar API_AVAILABLE(macos(10.10), ios(8.0), watchos(2.0), tvos(9.0));
CF_EXPORT const CFCalendarIdentifier kCFIslamicUmmAlQuraCalendar API_AVAILABLE(macos(10.10), ios(8.0), watchos(2.0), tvos(9.0));
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif /* ! __COREFOUNDATION_CFLOCALE__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreFoundation.framework/Modules/module.modulemap | framework module CoreFoundation [extern_c] [system] {
umbrella header "CoreFoundation.h"
explicit module CFPlugInCOM { header "CFPlugInCOM.h" }
export *
module * {
export *
}
}
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreVideo.framework/CoreVideo.tbd | --- !tapi-tbd
tbd-version: 4
targets: [ x86_64-macos, x86_64-maccatalyst, arm64-macos, arm64-maccatalyst,
arm64e-macos, arm64e-maccatalyst ]
uuids:
- target: x86_64-macos
value: 71EB0CF1-47DC-3764-990D-F9C4AB2F7AEF
- target: x86_64-maccatalyst
value: 71EB0CF1-47DC-3764-990D-F9C4AB2F7AEF
- target: arm64-macos
value: 00000000-0000-0000-0000-000000000000
- target: arm64-maccatalyst
value: 00000000-0000-0000-0000-000000000000
- target: arm64e-macos
value: AAD5F625-6DFB-3F97-AAB6-E59DDCCE5615
- target: arm64e-maccatalyst
value: AAD5F625-6DFB-3F97-AAB6-E59DDCCE5615
install-name: '/System/Library/Frameworks/CoreVideo.framework/Versions/A/CoreVideo'
current-version: 1.5
compatibility-version: 1.2
exports:
- targets: [ arm64e-macos, x86_64-macos, x86_64-maccatalyst, arm64e-maccatalyst,
arm64-macos, arm64-maccatalyst ]
symbols: [ _CVBufferCopyAttachment, _CVBufferCopyAttachments, _CVBufferDumpToQTES,
_CVBufferGetAttachment, _CVBufferGetAttachments, _CVBufferHasAttachment,
_CVBufferPropagateAttachments, _CVBufferRelease, _CVBufferRemoveAllAttachments,
_CVBufferRemoveAttachment, _CVBufferRetain, _CVBufferSetAttachment,
_CVBufferSetAttachments, _CVColorPrimariesGetIntegerCodePointForString,
_CVColorPrimariesGetStringForIntegerCodePoint, _CVDataBufferCreateWithIOSurface,
_CVDataBufferGetDataFormatType, _CVDataBufferGetDataSize,
_CVDataBufferGetIOSurface, _CVDataBufferGetPixelFormatType,
_CVDataBufferGetTypeID, _CVDataBufferPoolCreate, _CVDataBufferPoolCreateDataBuffer,
_CVDataBufferPoolCreateDataBufferWithAuxAttributes, _CVDataBufferPoolFlush,
_CVDataBufferPoolGetAttributes, _CVDataBufferPoolGetDataBufferAttributes,
_CVDataBufferPoolGetMinBufferCount, _CVDataBufferPoolGetTypeID,
_CVDataBufferPoolPrefetchPages, _CVDataBufferPoolScanIOSurfaces,
_CVDataBufferPoolSetMinBufferCount, _CVDisplayLinkCreateWithActiveCGDisplays,
_CVDisplayLinkCreateWithCGDisplay, _CVDisplayLinkCreateWithCGDisplays,
_CVDisplayLinkCreateWithDisplay, _CVDisplayLinkCreateWithDisplays,
_CVDisplayLinkCreateWithOpenGLDisplayMask, _CVDisplayLinkGetActualOutputVideoRefreshPeriod,
_CVDisplayLinkGetCurrentCGDisplay, _CVDisplayLinkGetCurrentDisplay,
_CVDisplayLinkGetCurrentTime, _CVDisplayLinkGetNominalOutputVideoRefreshPeriod,
_CVDisplayLinkGetOutputVideoLatency, _CVDisplayLinkGetTypeID,
_CVDisplayLinkIsRunning, _CVDisplayLinkRelease, _CVDisplayLinkRetain,
_CVDisplayLinkSetCurrentCGDisplay, _CVDisplayLinkSetCurrentCGDisplayFromOpenGLContext,
_CVDisplayLinkSetCurrentDisplay, _CVDisplayLinkSetDisplayCallback,
_CVDisplayLinkSetOutputCallback, _CVDisplayLinkSetOutputHandler,
_CVDisplayLinkSetPaused, _CVDisplayLinkSetRenderCallback,
_CVDisplayLinkStart, _CVDisplayLinkStop, _CVDisplayLinkTranslateTime,
_CVGetCurrentHostTime, _CVGetHostClockFrequency, _CVGetHostClockMinimumTimeDelta,
_CVGetTotalPixelBufferBackingSize, _CVImageBufferCreateColorSpaceFromAttachments,
_CVImageBufferDeleteImageTexture, _CVImageBufferGetBufferBackingSize,
_CVImageBufferGetCleanRect, _CVImageBufferGetColorSpace, _CVImageBufferGetDisplaySize,
_CVImageBufferGetEncodedSize, _CVImageBufferGetPixelFormatType,
_CVImageBufferHasCleanRect, _CVImageBufferIsFlipped, _CVImageBufferProvideImageData,
_CVImageBufferProvideImageTexture, _CVImageBufferSetCleanAperture,
_CVImageBufferSetColorSpace, _CVImageBufferSetDisplayDimensions,
_CVImageBufferSetFieldCount, _CVImageBufferSetPixelAspectRatio,
_CVIsCompressedPixelFormatAvailable, _CVMetalTextureCacheCreate,
_CVMetalTextureCacheCreateTextureFromImage, _CVMetalTextureCacheFlush,
_CVMetalTextureCacheGetTypeID, _CVMetalTextureGetCleanTexCoords,
_CVMetalTextureGetTexture, _CVMetalTextureGetTypeID, _CVMetalTextureIsFlipped,
_CVOpenGLBufferAttach, _CVOpenGLBufferCreate, _CVOpenGLBufferGetAttributes,
_CVOpenGLBufferGetDisplayMask, _CVOpenGLBufferGetPBuffer,
_CVOpenGLBufferGetSurfaceID, _CVOpenGLBufferGetTypeID, _CVOpenGLBufferPoolCreate,
_CVOpenGLBufferPoolCreateOpenGLBuffer, _CVOpenGLBufferPoolGetAttributes,
_CVOpenGLBufferPoolGetOpenGLBufferAttributes, _CVOpenGLBufferPoolGetTypeID,
_CVOpenGLBufferPoolRelease, _CVOpenGLBufferPoolRetain, _CVOpenGLBufferRelease,
_CVOpenGLBufferRetain, _CVOpenGLTextureBackingImage, _CVOpenGLTextureBufferBackingImage,
_CVOpenGLTextureCacheCreate, _CVOpenGLTextureCacheCreateCGLS,
_CVOpenGLTextureCacheCreateTextureFromImage, _CVOpenGLTextureCacheFlush,
_CVOpenGLTextureCacheGetTypeID, _CVOpenGLTextureCacheRelease,
_CVOpenGLTextureCacheRetain, _CVOpenGLTextureCopyBacking,
_CVOpenGLTextureGetBounds, _CVOpenGLTextureGetCGLContextObj,
_CVOpenGLTextureGetCleanRect, _CVOpenGLTextureGetCleanTexCoords,
_CVOpenGLTextureGetName, _CVOpenGLTextureGetSize, _CVOpenGLTextureGetTarget,
_CVOpenGLTextureGetTypeID, _CVOpenGLTextureIsFlipped, _CVOpenGLTextureRelease,
_CVOpenGLTextureRetain, _CVPixelBufferCopyCreationAttributes,
_CVPixelBufferCreate, _CVPixelBufferCreateFromCVImageBufferRef,
_CVPixelBufferCreateResolvedAttributesDictionary, _CVPixelBufferCreateWithBufferBacking,
_CVPixelBufferCreateWithBytes, _CVPixelBufferCreateWithIOSurface,
_CVPixelBufferCreateWithPlanarBytes, _CVPixelBufferDrawColorBars,
_CVPixelBufferFillExtendedPixels, _CVPixelBufferGetAttributes,
_CVPixelBufferGetBaseAddress, _CVPixelBufferGetBaseAddressOfPlane,
_CVPixelBufferGetBufferBacking, _CVPixelBufferGetBytesPerRow,
_CVPixelBufferGetBytesPerRowOfPlane, _CVPixelBufferGetDataSize,
_CVPixelBufferGetExtendedPixels, _CVPixelBufferGetFixedPointFractionalBits,
_CVPixelBufferGetFixedPointIntegerBits, _CVPixelBufferGetFixedPointPaddingBits,
_CVPixelBufferGetFixedPointSignBits, _CVPixelBufferGetHeight,
_CVPixelBufferGetHeightOfPlane, _CVPixelBufferGetIOSurface,
_CVPixelBufferGetPixelFormatType, _CVPixelBufferGetPlaneCount,
_CVPixelBufferGetTypeID, _CVPixelBufferGetWidth, _CVPixelBufferGetWidthOfPlane,
_CVPixelBufferIsCompatibleWithAttributes, _CVPixelBufferIsPlanar,
_CVPixelBufferLockBaseAddress, _CVPixelBufferPoolCopyIOSurfaceCreationProperties,
_CVPixelBufferPoolCreate, _CVPixelBufferPoolCreatePixelBuffer,
_CVPixelBufferPoolCreatePixelBufferWithAuxAttributes, _CVPixelBufferPoolFlush,
_CVPixelBufferPoolGetAttributes, _CVPixelBufferPoolGetMaxBufferAge,
_CVPixelBufferPoolGetMinBufferCount, _CVPixelBufferPoolGetPixelBufferAttributes,
_CVPixelBufferPoolGetTypeID, _CVPixelBufferPoolPreAllocate,
_CVPixelBufferPoolPrefetchPages, _CVPixelBufferPoolRelease,
_CVPixelBufferPoolRetain, _CVPixelBufferPoolScanIOSurfaces,
_CVPixelBufferPoolSetMaxBufferAge, _CVPixelBufferPoolSetMinBufferCount,
_CVPixelBufferRelease, _CVPixelBufferRetain, _CVPixelBufferUnlockBaseAddress,
_CVPixelBufferWasAllocatedFromPool, _CVPixelFormatDescriptionArrayCreateWithAllPixelFormatTypes,
_CVPixelFormatDescriptionCreateWithPixelFormatType, _CVPixelFormatDescriptionGetDescriptionWithPixelFormatType,
_CVPixelFormatDescriptionGetPixelFormatTypes, _CVPixelFormatDescriptionRegisterDescriptionWithPixelFormatType,
_CVPixelFormatTypeIsSubsampled, _CVSetRestrictions, _CVTransferFunctionGetIntegerCodePointForString,
_CVTransferFunctionGetStringForIntegerCodePoint, _CVYCbCrMatrixGetIntegerCodePointForString,
_CVYCbCrMatrixGetStringForIntegerCodePoint, _kCICVImageTextureCache,
_kCICVImageTextureMaxHeight, _kCICVImageTextureMaxWidth, _kCVBufferBackingWillDeallocate,
_kCVBufferMovieTimeKey, _kCVBufferNonPropagatedAttachmentsKey,
_kCVBufferPropagatedAttachmentsKey, _kCVBufferTimeScaleKey,
_kCVBufferTimeValueKey, _kCVDataBufferIOSurfacePropertiesKey,
_kCVDataBufferIOSurfacePurgeableKey, _kCVDataBufferIOSurfaceWiringAssertion,
_kCVDataBufferIOSurfaceWiringAssertionKey, _kCVDataBufferPoolAllocationThresholdKey,
_kCVDataBufferPoolMaximumBufferAgeKey, _kCVDataBufferPoolMinimumBufferCountKey,
_kCVDataBufferPoolNameKey, _kCVImageBufferAlphaChannelIsOpaque,
_kCVImageBufferAlphaChannelModeKey, _kCVImageBufferAlphaChannelMode_PremultipliedAlpha,
_kCVImageBufferAlphaChannelMode_StraightAlpha, _kCVImageBufferAmbientViewingEnvironmentKey,
_kCVImageBufferBlankieTransportIdentifierKey, _kCVImageBufferCGColorSpaceKey,
_kCVImageBufferChromaLocationBottomFieldKey, _kCVImageBufferChromaLocationTopFieldKey,
_kCVImageBufferChromaLocation_Bottom, _kCVImageBufferChromaLocation_BottomLeft,
_kCVImageBufferChromaLocation_Center, _kCVImageBufferChromaLocation_DV420,
_kCVImageBufferChromaLocation_Left, _kCVImageBufferChromaLocation_Top,
_kCVImageBufferChromaLocation_TopLeft, _kCVImageBufferChromaSubsamplingKey,
_kCVImageBufferChromaSubsampling_411, _kCVImageBufferChromaSubsampling_420,
_kCVImageBufferChromaSubsampling_422, _kCVImageBufferCleanApertureHeightKey,
_kCVImageBufferCleanApertureHorizontalOffsetKey, _kCVImageBufferCleanApertureKey,
_kCVImageBufferCleanApertureVerticalOffsetKey, _kCVImageBufferCleanApertureWidthKey,
_kCVImageBufferColorPrimariesKey, _kCVImageBufferColorPrimaries_DCI_P3,
_kCVImageBufferColorPrimaries_EBU_3213, _kCVImageBufferColorPrimaries_ITU_R_2020,
_kCVImageBufferColorPrimaries_ITU_R_709_2, _kCVImageBufferColorPrimaries_P22,
_kCVImageBufferColorPrimaries_P3_D65, _kCVImageBufferColorPrimaries_SMPTE_C,
_kCVImageBufferContentLightLevelInfoKey, _kCVImageBufferDisplayDimensionsKey,
_kCVImageBufferDisplayHeightKey, _kCVImageBufferDisplayWidthKey,
_kCVImageBufferFieldCountKey, _kCVImageBufferFieldDetailKey,
_kCVImageBufferFieldDetailSpatialFirstLineEarly, _kCVImageBufferFieldDetailSpatialFirstLineLate,
_kCVImageBufferFieldDetailTemporalBottomFirst, _kCVImageBufferFieldDetailTemporalTopFirst,
_kCVImageBufferGammaLevelKey, _kCVImageBufferHDRImageStatisticsInfoFilteredKey,
_kCVImageBufferHDRImageStatisticsInfoRawKey, _kCVImageBufferHDRImageStatisticsInfoTransferFunctionKey,
_kCVImageBufferHDRImageStatisticsInfo_AnchorPQKey, _kCVImageBufferHDRImageStatisticsInfo_AnchorPowerKey,
_kCVImageBufferHDRImageStatisticsInfo_AverageKey, _kCVImageBufferHDRImageStatisticsInfo_AverageOffsetKey,
_kCVImageBufferHDRImageStatisticsInfo_DolbyMetadataVersionKey,
_kCVImageBufferHDRImageStatisticsInfo_MaximumKey, _kCVImageBufferHDRImageStatisticsInfo_MaximumOffsetKey,
_kCVImageBufferHDRImageStatisticsInfo_MinimumKey, _kCVImageBufferHDRImageStatisticsInfo_MinimumOffsetKey,
_kCVImageBufferICCProfileKey, _kCVImageBufferMasteringDisplayColorVolumeKey,
_kCVImageBufferPixelAspectRatioHorizontalSpacingKey, _kCVImageBufferPixelAspectRatioKey,
_kCVImageBufferPixelAspectRatioVerticalSpacingKey, _kCVImageBufferPreferredCleanApertureKey,
_kCVImageBufferRegionOfInterestKey, _kCVImageBufferSceneReferredExtendedLinearKey,
_kCVImageBufferTransferFunctionKey, _kCVImageBufferTransferFunction_ARIB_STD_B67_HLG,
_kCVImageBufferTransferFunction_EBU_3213, _kCVImageBufferTransferFunction_ITU_R_2020,
_kCVImageBufferTransferFunction_ITU_R_2100_HLG, _kCVImageBufferTransferFunction_ITU_R_709_2,
_kCVImageBufferTransferFunction_Linear, _kCVImageBufferTransferFunction_SMPTE_240M_1995,
_kCVImageBufferTransferFunction_SMPTE_C, _kCVImageBufferTransferFunction_SMPTE_ST_2084_PQ,
_kCVImageBufferTransferFunction_SMPTE_ST_428_1, _kCVImageBufferTransferFunction_UseGamma,
_kCVImageBufferTransferFunction_aYCC, _kCVImageBufferTransferFunction_sRGB,
_kCVImageBufferYCbCrMatrixKey, _kCVImageBufferYCbCrMatrix_DCI_P3,
_kCVImageBufferYCbCrMatrix_IPT, _kCVImageBufferYCbCrMatrix_ITU_R_2020,
_kCVImageBufferYCbCrMatrix_ITU_R_2100_ICtCp, _kCVImageBufferYCbCrMatrix_ITU_R_601_4,
_kCVImageBufferYCbCrMatrix_ITU_R_709_2, _kCVImageBufferYCbCrMatrix_Identity,
_kCVImageBufferYCbCrMatrix_P3_D65, _kCVImageBufferYCbCrMatrix_SMPTE_240M_1995,
_kCVIndefiniteTime, _kCVMetalTextureCacheMaximumTextureAgeKey,
_kCVMetalTextureStorageMode, _kCVMetalTextureUsage, _kCVOpenGLBufferFlipped,
_kCVOpenGLBufferHeight, _kCVOpenGLBufferInternalFormat, _kCVOpenGLBufferMaximumMipmapLevel,
_kCVOpenGLBufferPoolMaximumBufferAgeKey, _kCVOpenGLBufferPoolMinimumBufferCountKey,
_kCVOpenGLBufferTarget, _kCVOpenGLBufferWidth, _kCVOpenGLTextureBottomField,
_kCVOpenGLTextureBottomHalf, _kCVOpenGLTextureCacheChromaSamplingModeAutomatic,
_kCVOpenGLTextureCacheChromaSamplingModeBestPerformance, _kCVOpenGLTextureCacheChromaSamplingModeHighestQuality,
_kCVOpenGLTextureCacheChromaSamplingModeKey, _kCVOpenGLTextureFieldKey,
_kCVOpenGLTextureTopField, _kCVOpenGLTextureTopHalf, _kCVPixelBufferBaseAddressAdjustmentKey,
_kCVPixelBufferBytesPerRowAlignmentKey, _kCVPixelBufferBytesPerRowKey,
_kCVPixelBufferCGBitmapContextCompatibilityKey, _kCVPixelBufferCGImageCompatibilityKey,
_kCVPixelBufferCacheModeKey, _kCVPixelBufferCustomMemoryLayoutCallbacksKey,
_kCVPixelBufferExactBytesPerRowKey, _kCVPixelBufferExactHeightKey,
_kCVPixelBufferExtendedPixelsBottomKey, _kCVPixelBufferExtendedPixelsFilledKey,
_kCVPixelBufferExtendedPixelsLeftKey, _kCVPixelBufferExtendedPixelsRightKey,
_kCVPixelBufferExtendedPixelsTopKey, _kCVPixelBufferFixedPointInvalidValueKey,
_kCVPixelBufferFixedPointOffsetKey, _kCVPixelBufferHeightKey,
_kCVPixelBufferIOSurfaceCoreAnimationCompatibilityKey, _kCVPixelBufferIOSurfaceOpenGLESFBOCompatibilityKey,
_kCVPixelBufferIOSurfaceOpenGLESTextureCompatibilityKey, _kCVPixelBufferIOSurfaceOpenGLFBOCompatibilityKey,
_kCVPixelBufferIOSurfaceOpenGLTextureCompatibilityKey, _kCVPixelBufferIOSurfacePropertiesKey,
_kCVPixelBufferIOSurfacePurgeableKey, _kCVPixelBufferIOSurfaceWiringAssertion,
_kCVPixelBufferIOSurfaceWiringAssertionKey, _kCVPixelBufferMemoryAllocatorKey,
_kCVPixelBufferMetalCompatibilityKey, _kCVPixelBufferOpenGLCompatibilityKey,
_kCVPixelBufferOpenGLESCompatibilityKey, _kCVPixelBufferOpenGLESTextureCacheCompatibilityKey,
_kCVPixelBufferOpenGLTextureCacheCompatibilityKey, _kCVPixelBufferPixelFormatDescriptionKey,
_kCVPixelBufferPixelFormatTypeKey, _kCVPixelBufferPlaneAlignmentKey,
_kCVPixelBufferPoolAdjustableBaseAddressGranularityKey, _kCVPixelBufferPoolAllocationThresholdKey,
_kCVPixelBufferPoolFreeBufferNotification, _kCVPixelBufferPoolMaximumBufferAgeKey,
_kCVPixelBufferPoolMinimumBufferCountKey, _kCVPixelBufferPoolNameKey,
_kCVPixelBufferPoolPrefetchOnAllocation, _kCVPixelBufferPoolWorstCaseBytesPerRowKey,
_kCVPixelBufferPreferRealTimeCacheModeIfEveryoneDoesKey, _kCVPixelBufferProResRAWKey_BlackLevel,
_kCVPixelBufferProResRAWKey_ColorMatrix, _kCVPixelBufferProResRAWKey_GainFactor,
_kCVPixelBufferProResRAWKey_LargestDCQSS, _kCVPixelBufferProResRAWKey_MetadataExtension,
_kCVPixelBufferProResRAWKey_RecommendedCrop, _kCVPixelBufferProResRAWKey_SenselSitingOffsets,
_kCVPixelBufferProResRAWKey_WhiteBalanceBlueFactor, _kCVPixelBufferProResRAWKey_WhiteBalanceCCT,
_kCVPixelBufferProResRAWKey_WhiteBalanceRedFactor, _kCVPixelBufferProResRAWKey_WhiteLevel,
_kCVPixelBufferQDCompatibilityKey, _kCVPixelBufferRotationKey,
_kCVPixelBufferVersatileBayerKey_BayerPattern, _kCVPixelBufferWidthKey,
_kCVPixelFormatBitsPerBlock, _kCVPixelFormatBitsPerComponent,
_kCVPixelFormatBlackBlock, _kCVPixelFormatBlockHeight, _kCVPixelFormatBlockHorizontalAlignment,
_kCVPixelFormatBlockVerticalAlignment, _kCVPixelFormatBlockWidth,
_kCVPixelFormatCGBitmapContextCompatibility, _kCVPixelFormatCGBitmapInfo,
_kCVPixelFormatCGImageCompatibility, _kCVPixelFormatCodecType,
_kCVPixelFormatComponentRange, _kCVPixelFormatComponentRange_FullRange,
_kCVPixelFormatComponentRange_VideoRange, _kCVPixelFormatComponentRange_WideRange,
_kCVPixelFormatComponents, _kCVPixelFormatConstant, _kCVPixelFormatContainsAlpha,
_kCVPixelFormatContainsBayer, _kCVPixelFormatContainsGrayscale,
_kCVPixelFormatContainsRGB, _kCVPixelFormatContainsYCbCr,
_kCVPixelFormatExactRatioBetweenBytesPerRowOfPlanes, _kCVPixelFormatFillExtendedPixelsCallback,
_kCVPixelFormatFourCC, _kCVPixelFormatHorizontalSubsampling,
_kCVPixelFormatName, _kCVPixelFormatOpenGLCompatibility, _kCVPixelFormatOpenGLESCompatibility,
_kCVPixelFormatOpenGLFormat, _kCVPixelFormatOpenGLInternalFormat,
_kCVPixelFormatOpenGLType, _kCVPixelFormatPlanes, _kCVPixelFormatQDCompatibility,
_kCVPixelFormatVerticalSubsampling, _kCVZeroTime ]
- targets: [ arm64e-macos, x86_64-macos, arm64-macos ]
symbols: [ _CVPixelBufferCreateWithParentIOSurface, _CVPixelBufferCreateWithParentPixelBuffer ]
- targets: [ arm64e-macos, x86_64-macos, arm64e-maccatalyst, arm64-macos,
arm64-maccatalyst ]
symbols: [ _CVPixelBufferCalculateCompressedTileDataRegionMemoryUsedOfPlane,
_CVPixelBufferCalculateSparseHistogramOfCompressedTileDataUsageOfPlane,
_kCVPixelBufferCompressedDataRegionAlignmentKey, _kCVPixelBufferCompressedTileHeaderGroupBytesPerRowAlignmentKey,
_kCVPixelFormatBytesPerCompressedTileHeader, _kCVPixelFormatCompressedTileHeight,
_kCVPixelFormatCompressedTileWidth, _kCVPixelFormatCompressionFootprint,
_kCVPixelFormatCompressionMetadataPatternSignallingConstant,
_kCVPixelFormatCompressionMetadataPatternSignallingUncompressed,
_kCVPixelFormatCompressionType, _kCVPixelFormatEquivalentUncompressedPixelFormat,
_kCVPixelFormatTiledAddressFormat ]
...
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreVideo.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreVideo.framework/Headers/CVPixelBufferIOSurface.h | /*
* CVPixelBufferIOSurface.h
* CoreVideo
*
* Copyright (c) 2010-2017 Apple Inc. All rights reserved.
*
*/
/*! @header CVPixelBufferIOSurface.h
@copyright 2010-2017 Apple Inc. All rights reserved.
@availability Mac OS X 10.4 or later; iOS 11 or later
@discussion routines for accessing and manipulating IOSurface backings for CVPixelBuffers
*/
#if !defined(__COREVIDEO_CVPIXELBUFFERIOSURFACE_H__)
#define __COREVIDEO_CVPIXELBUFFERIOSURFACE_H__ 1
#include <TargetConditionals.h>
#include <CoreVideo/CVBase.h>
#include <CoreVideo/CVPixelBuffer.h>
#if COREVIDEO_SUPPORTS_IOSURFACE
#if COREVIDEO_USE_IOSURFACEREF
#if __has_include(<IOSurface/IOSurfaceRef.h>)
#include <IOSurface/IOSurfaceRef.h>
#define COREVIDEO_INCLUDED_IOSURFACE_HEADER_FILE 1
#endif
#else
#if __has_include(<IOSurface/IOSurface.h>)
#include <IOSurface/IOSurface.h>
#define COREVIDEO_INCLUDED_IOSURFACE_HEADER_FILE 1
#endif
#endif
#endif // COREVIDEO_SUPPORTS_IOSURFACE
#if defined(__cplusplus)
extern "C" {
#endif
// Ensures that CGLTexImageIOSurface2D() will succeed in creating a valid texture object from the CVPixelBuffer's IOSurface.
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelBufferIOSurfaceOpenGLTextureCompatibilityKey API_AVAILABLE(macosx(10.6)) __IOS_PROHIBITED __TVOS_PROHIBITED __WATCHOS_PROHIBITED; // CFBoolean
// Ensures that CGLTexImageIOSurface2D() will succeed in creating a valid texture object from the CVPixelBuffer's IOSurface AND that the resulting texture may be used as a color buffer attachment to a OpenGL frame buffer object.
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelBufferIOSurfaceOpenGLFBOCompatibilityKey API_AVAILABLE(macosx(10.6)) __IOS_PROHIBITED __TVOS_PROHIBITED __WATCHOS_PROHIBITED; // CFBoolean
// Ensures that the CVPixelBuffer's IOSurfaceRef can be displayed in an CoreAnimation CALayer.
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelBufferIOSurfaceCoreAnimationCompatibilityKey AVAILABLE_MAC_OS_X_VERSION_10_6_AND_LATER; // CFBoolean
// Ensures that OpenGLES can create a valid texture object from IOSurface-backed CVPixelBuffers.
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelBufferIOSurfaceOpenGLESTextureCompatibilityKey API_AVAILABLE(ios(5.0), tvos(9.0)) API_UNAVAILABLE(macosx) API_UNAVAILABLE(macCatalyst) __WATCHOS_PROHIBITED; // CFBoolean
// Ensures that OpenGLES can create a valid texture object from IOSurface-backed CVPixelBuffers AND that the resulting texture may be used as a color buffer attachment to a OpenGLES frame buffer object.
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelBufferIOSurfaceOpenGLESFBOCompatibilityKey API_AVAILABLE(ios(5.0), tvos(9.0)) API_UNAVAILABLE(macosx) API_UNAVAILABLE(macCatalyst) __WATCHOS_PROHIBITED; // CFBoolean
#if COREVIDEO_SUPPORTS_IOSURFACE
#if COREVIDEO_INCLUDED_IOSURFACE_HEADER_FILE
/*!
@function CVPixelBufferGetIOSurface
@abstract Returns the IOSurface backing the pixel buffer, or NULL if it is not backed by an IOSurface.
@param pixelBuffer Target PixelBuffer.
*/
CV_EXPORT IOSurfaceRef CV_NULLABLE CVPixelBufferGetIOSurface(CVPixelBufferRef CV_NULLABLE pixelBuffer) API_AVAILABLE(macosx(10.6), ios(4.0), tvos(9.0), watchos(4.0));
/*!
@function CVPixelBufferCreateWithIOSurface
@abstract Call to create a single CVPixelBuffer for a passed-in IOSurface.
@discussion The CVPixelBuffer will retain the IOSurface.
IMPORTANT NOTE: If you are using IOSurface to share CVPixelBuffers between processes
and those CVPixelBuffers are allocated via a CVPixelBufferPool, it is important
that the CVPixelBufferPool does not reuse CVPixelBuffers whose IOSurfaces are still
in use in other processes.
CoreVideo and IOSurface will take care of this for if you use IOSurfaceCreateMachPort
and IOSurfaceLookupFromMachPort, but NOT if you pass IOSurfaceIDs.
@param surface The IOSurface to wrap.
@param pixelBufferAttributes A dictionary with additional attributes for a a pixel buffer. This parameter is optional. See PixelBufferAttributes for more details.
@param pixelBufferOut The new pixel buffer will be returned here
@result returns kCVReturnSuccess on success.
*/
CV_EXPORT CVReturn CVPixelBufferCreateWithIOSurface(
CFAllocatorRef CV_NULLABLE allocator,
IOSurfaceRef CV_NONNULL surface,
CFDictionaryRef CV_NULLABLE pixelBufferAttributes,
CVPixelBufferRef CV_NULLABLE * CV_NONNULL pixelBufferOut) __OSX_AVAILABLE_STARTING(__MAC_10_6,__IPHONE_4_0);
#endif
#endif // COREVIDEO_SUPPORTS_IOSURFACE
#if defined(__cplusplus)
}
#endif
#endif
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreVideo.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreVideo.framework/Headers/CoreVideo.h | /*
* CoreVideo.h
* CoreVideo
*
* Copyright (c) 2004-2015 Apple Inc. All rights reserved.
*
*/
/*!
@header CoreVideo
@copyright 2004-2014 Apple Inc. All rights reserved.
@availability Mac OS X 10.4 or later, and iOS 4.0 or later
@abstract Umbrella header for the CoreVideo framework
@discussion This header includes all necesssary headers for the CoreVideo API
*/
#include <TargetConditionals.h>
#include <Availability.h>
#include <AvailabilityMacros.h>
#include <CoreVideo/CVReturn.h>
#include <CoreVideo/CVBase.h>
#if COREVIDEO_SUPPORTS_DISPLAYLINK
#include <CoreVideo/CVHostTime.h>
#include <CoreVideo/CVDisplayLink.h>
#endif
#include <CoreVideo/CVBuffer.h>
#include <CoreVideo/CVPixelBuffer.h>
#include <CoreVideo/CVPixelBufferPool.h>
#if COREVIDEO_SUPPORTS_OPENGL
#include <CoreVideo/CVOpenGLBuffer.h>
#include <CoreVideo/CVOpenGLBufferPool.h>
#include <CoreVideo/CVOpenGLTexture.h>
#include <CoreVideo/CVOpenGLTextureCache.h>
#endif // COREVIDEO_SUPPORTS_OPENGL
#if COREVIDEO_SUPPORTS_OPENGLES || TARGET_OS_WATCH
#if __has_include(<OpenGLES/gltypes.h>)
#include <CoreVideo/CVOpenGLESTexture.h>
#include <CoreVideo/CVOpenGLESTextureCache.h>
#endif
#endif // COREVIDEO_SUPPORTS_OPENGLES
#include <CoreVideo/CVPixelFormatDescription.h>
#if COREVIDEO_SUPPORTS_DIRECT3D
#include <CoreVideo/CVDirect3DBuffer.h>
#include <CoreVideo/CVDirect3DBufferPool.h>
#include <CoreVideo/CVDirect3DTexture.h>
#include <CoreVideo/CVDirect3DTextureCache.h>
#endif
#if !0
#if TARGET_OS_MAC
#include <CoreVideo/CVMetalTexture.h>
#include <CoreVideo/CVMetalTextureCache.h>
#endif
#endif
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreVideo.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreVideo.framework/Headers/CVReturn.h | /*
* CVReturn.h
* CoreVideo
*
* Copyright (c) 2004-2014 Apple Inc. All rights reserved.
*
*/
/*! @header CVReturn.h
@copyright 2004-2014 Apple Inc. All rights reserved.
@availability Mac OS X 10.4 or later, and iOS 4.0 or later
@discussion Here you can find all the CoreVideo specific error codes.
*/
#if !defined(__COREVIDEO_CVRETURN_H__)
#define __COREVIDEO_CVRETURN_H__ 1
#include <TargetConditionals.h>
#include <CoreVideo/CVBase.h>
#if defined(__cplusplus)
extern "C" {
#endif
/*!
@enum CVReturn
@abstract CoreVideo specific error codes
@constant kCVReturnSuccess Function executed successfully without errors.
@constant kCVReturnFirst Placeholder to mark the beginning of the range of CVReturn codes.
@constant kCVReturnLast Placeholder to mark the end of the range of CVReturn codes.
@constant kCVReturnInvalidArgument At least one of the arguments passed in is not valid. Either out of range or the wrong type.
@constant kCVReturnAllocationFailed The allocation for a buffer or buffer pool failed. Most likely because of lack of resources.
@constant kCVReturnInvalidDisplay A CVDisplayLink cannot be created for the given DisplayRef.
@constant kCVReturnDisplayLinkAlreadyRunning The CVDisplayLink is already started and running.
@constant kCVReturnDisplayLinkNotRunning The CVDisplayLink has not been started.
@constant kCVReturnDisplayLinkCallbacksNotSet The output callback is not set.
@constant kCVReturnInvalidPixelFormat The requested pixelformat is not supported for the CVBuffer type.
@constant kCVReturnInvalidSize The requested size (most likely too big) is not supported for the CVBuffer type.
@constant kCVReturnInvalidPixelBufferAttributes A CVBuffer cannot be created with the given attributes.
@constant kCVReturnPixelBufferNotOpenGLCompatible The Buffer cannot be used with OpenGL as either its size, pixelformat or attributes are not supported by OpenGL.
@constant kCVReturnPixelBufferNotMetalCompatible The Buffer cannot be used with Metal as either its size, pixelformat or attributes are not supported by Metal.
@constant kCVReturnWouldExceedAllocationThreshold The allocation request failed because it would have exceeded a specified allocation threshold (see kCVPixelBufferPoolAllocationThresholdKey).
@constant kCVReturnPoolAllocationFailed The allocation for the buffer pool failed. Most likely because of lack of resources. Check if your parameters are in range.
@constant kCVReturnInvalidPoolAttributes A CVBufferPool cannot be created with the given attributes.
@constant kCVReturnRetry a scan hasn't completely traversed the CVBufferPool due to a concurrent operation. The client can retry the scan.
*/
typedef int32_t CVReturn;
#if COREVIDEO_USE_DERIVED_ENUMS_FOR_CONSTANTS
enum : CVReturn
#else
enum _CVReturn
#endif
{
kCVReturnSuccess = 0,
kCVReturnFirst = -6660,
kCVReturnError = kCVReturnFirst,
kCVReturnInvalidArgument = -6661,
kCVReturnAllocationFailed = -6662,
kCVReturnUnsupported = -6663,
// DisplayLink related errors
kCVReturnInvalidDisplay = -6670,
kCVReturnDisplayLinkAlreadyRunning = -6671,
kCVReturnDisplayLinkNotRunning = -6672,
kCVReturnDisplayLinkCallbacksNotSet = -6673,
// Buffer related errors
kCVReturnInvalidPixelFormat = -6680,
kCVReturnInvalidSize = -6681,
kCVReturnInvalidPixelBufferAttributes = -6682,
kCVReturnPixelBufferNotOpenGLCompatible = -6683,
kCVReturnPixelBufferNotMetalCompatible = -6684,
// Buffer Pool related errors
kCVReturnWouldExceedAllocationThreshold = -6689,
kCVReturnPoolAllocationFailed = -6690,
kCVReturnInvalidPoolAttributes = -6691,
kCVReturnRetry = -6692,
kCVReturnLast = -6699
};
#if defined(__cplusplus)
}
#endif
#endif
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreVideo.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreVideo.framework/Headers/CVOpenGLTexture.h | /*
* CVOpenGLTexture.h
* CoreVideo
*
* Copyright (c) 2004-2015 Apple Inc. All rights reserved.
*
*/
/*! @header CVOpenGLTexture.h
@copyright 2004-2015 Apple Inc. All rights reserved.
@availability Mac OS X 10.4 or later
@discussion A CoreVideo Texture derives from an ImageBuffer, and is used for supplying source image data to OpenGL.
*/
#if !defined(__COREVIDEO_CVOPENGLTEXTURE_H__)
#define __COREVIDEO_CVOPENGLTEXTURE_H__ 1
#include <CoreVideo/CVBase.h>
#include <CoreVideo/CVReturn.h>
#include <CoreVideo/CVImageBuffer.h>
#include <OpenGL/OpenGL.h>
#include <OpenGL/gltypes.h>
#include <stddef.h>
#include <stdint.h>
#if defined(__cplusplus)
extern "C" {
#endif
#pragma mark CVOpenGLTexture
/*!
@typedef CVOpenGLTextureRef
@abstract OpenGL texture based image buffer
*/
typedef CVImageBufferRef CVOpenGLTextureRef;
CV_EXPORT CFTypeID CVOpenGLTextureGetTypeID(void) COREVIDEO_GL_DEPRECATED(macosx, 10.4, 10.14) API_UNAVAILABLE(macCatalyst);
/*!
@function CVOpenGLTextureRetain
@abstract Retains a CVOpenGLTexture object
@discussion Equivalent to CFRetain, but NULL safe
@param buffer A CVOpenGLTexture object that you want to retain.
@result A CVOpenGLTexture object that is the same as the passed in buffer.
*/
CV_EXPORT CVOpenGLTextureRef CV_NULLABLE CVOpenGLTextureRetain( CVOpenGLTextureRef CV_NULLABLE texture ) COREVIDEO_GL_DEPRECATED(macosx, 10.4, 10.14) API_UNAVAILABLE(macCatalyst);
/*!
@function CVOpenGLTextureRelease
@abstract Releases a CVOpenGLTexture object
@discussion Equivalent to CFRelease, but NULL safe
@param buffer A CVOpenGLTexture object that you want to release.
*/
CV_EXPORT void CVOpenGLTextureRelease( CV_RELEASES_ARGUMENT CVOpenGLTextureRef CV_NULLABLE texture ) COREVIDEO_GL_DEPRECATED(macosx, 10.4, 10.14) API_UNAVAILABLE(macCatalyst);
/*!
@function CVOpenGLTextureGetTarget
@abstract Returns the texture target (eg. 2D vs. rect texture extension) of the CVOpenGLTexture
@param image Target CVOpenGLTexture
@result OpenGL texture target
*/
CV_EXPORT GLenum CVOpenGLTextureGetTarget( CVOpenGLTextureRef CV_NONNULL image ) COREVIDEO_GL_DEPRECATED(macosx, 10.4, 10.14) API_UNAVAILABLE(macCatalyst);
/*!
@function CVOpenGLTextureGetName
@abstract Returns the texture target name of the CVOpenGLTexture
@param image Target CVOpenGLTexture
@result OpenGL texture target name
*/
CV_EXPORT GLuint CVOpenGLTextureGetName( CVOpenGLTextureRef CV_NONNULL image ) COREVIDEO_GL_DEPRECATED(macosx, 10.4, 10.14) API_UNAVAILABLE(macCatalyst);
/*!
@function CVOpenGLTextureIsFlipped
@abstract Returns whether the image is flipped vertically or not.
@param image Target CVOpenGLTexture
@result True if 0,0 in the texture is upper left, false if 0,0 is lower left
*/
CV_EXPORT Boolean CVOpenGLTextureIsFlipped( CVOpenGLTextureRef CV_NONNULL image ) COREVIDEO_GL_DEPRECATED(macosx, 10.4, 10.14) API_UNAVAILABLE(macCatalyst);
/*!
@function CVOpenGLTextureGetCleanTexCoords
@abstract Returns convenient texture coordinates for the part of the image that should be displayed
@discussion This function automatically takes into account whether or not the texture is flipped.
@param image Target CVOpenGLTexture
@param lowerLeft - array of two GLfloats where the s and t texture coordinates of the lower left corner of the image will be stored
@param lowerRight - array of two GLfloats where the s and t texture coordinates of the lower right corner of the image will be stored
@param upperRight - array of two GLfloats where the s and t texture coordinates of the upper right corner of the image will be stored
@param upperLeft - array of two GLfloats where the s and t texture coordinates of the upper right corner of the image will be stored
*/
CV_EXPORT void CVOpenGLTextureGetCleanTexCoords( CVOpenGLTextureRef CV_NONNULL image,
GLfloat lowerLeft[CV_NONNULL 2],
GLfloat lowerRight[CV_NONNULL 2],
GLfloat upperRight[CV_NONNULL 2],
GLfloat upperLeft[CV_NONNULL 2] ) COREVIDEO_GL_DEPRECATED(macosx, 10.4, 10.14) API_UNAVAILABLE(macCatalyst);
#if defined(__cplusplus)
}
#endif
#endif
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreVideo.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreVideo.framework/Headers/CVBase.h | /*
* CVBase.h
* CoreVideo
*
* Copyright (c) 2004-2020 Apple Inc. All rights reserved.
*
*/
/*! @header CVBase.h
@copyright 2004-2017 Apple Inc. All rights reserved.
@availability Mac OS X 10.4 or later, and iOS 4.0 or later
@discussion Here you can find the type declarations for CoreVideo. CoreVideo uses a CVTimeStamp structure to store video display time stamps.
*/
#if !defined(__COREVIDEO_CVBASE_H__)
#define __COREVIDEO_CVBASE_H__ 1
#include <TargetConditionals.h>
#include <Availability.h>
#include <AvailabilityMacros.h>
#include <stdint.h>
#if TARGET_OS_WIN32
#pragma warning (disable: 4068) // ignore unknown pragmas
#endif
#include <CoreFoundation/CFBase.h>
#if defined(__cplusplus)
extern "C" {
#endif
#define COREVIDEO_TRUE (1 && 1)
#define COREVIDEO_FALSE (0 && 1)
#if TARGET_OS_WIN32
#define COREVIDEO_SUPPORTS_DIRECT3D COREVIDEO_TRUE
#else
#define COREVIDEO_SUPPORTS_DIRECT3D COREVIDEO_FALSE
#endif
#if TARGET_OS_MACCATALYST
#define COREVIDEO_SUPPORTS_OPENGL COREVIDEO_TRUE
#define COREVIDEO_SUPPORTS_OPENGLES COREVIDEO_FALSE
#else
#if TARGET_OS_OSX
#define COREVIDEO_SUPPORTS_OPENGL COREVIDEO_TRUE
#else
#define COREVIDEO_SUPPORTS_OPENGL COREVIDEO_FALSE
#endif
#if TARGET_OS_MAC && TARGET_OS_IPHONE
#define COREVIDEO_SUPPORTS_OPENGLES COREVIDEO_TRUE
#else
#define COREVIDEO_SUPPORTS_OPENGLES COREVIDEO_FALSE
#endif
#endif
#if ((TARGET_OS_MAC && ! TARGET_OS_IPHONE) || (TARGET_OS_WIN32))
#define COREVIDEO_SUPPORTS_COLORSPACE COREVIDEO_TRUE
#else
#define COREVIDEO_SUPPORTS_COLORSPACE COREVIDEO_FALSE
#endif
#if (TARGET_OS_MAC && ! TARGET_OS_IPHONE)
#define COREVIDEO_SUPPORTS_DISPLAYLINK COREVIDEO_TRUE
#else
#define COREVIDEO_SUPPORTS_DISPLAYLINK COREVIDEO_FALSE
#endif
#if TARGET_OS_MAC
#define COREVIDEO_SUPPORTS_IOSURFACE COREVIDEO_TRUE
#else
#define COREVIDEO_SUPPORTS_IOSURFACE COREVIDEO_FALSE
#endif
#if TARGET_OS_EMBEDDED && (__IPHONE_OS_VERSION_MIN_REQUIRED >= 80300)
#define COREVIDEO_SUPPORTS_PREFETCH COREVIDEO_TRUE
#elif TARGET_OS_OSX
#define COREVIDEO_SUPPORTS_PREFETCH COREVIDEO_TRUE
#else
#define COREVIDEO_SUPPORTS_PREFETCH COREVIDEO_FALSE
#endif
#if TARGET_OS_EMBEDDED && (__IPHONE_OS_VERSION_MIN_REQUIRED >= 80300)
#define COREVIDEO_SUPPORTS_IOSURFACE_PREFETCH COREVIDEO_TRUE
#elif TARGET_OS_OSX && (__MAC_OS_X_VERSION_MIN_REQUIRED >= 101500)
#define COREVIDEO_SUPPORTS_IOSURFACE_PREFETCH COREVIDEO_TRUE
#else
#define COREVIDEO_SUPPORTS_IOSURFACE_PREFETCH COREVIDEO_FALSE
#endif
#if TARGET_OS_SIMULATOR
#define COREVIDEO_SUPPORTS_GLES_TEX_IMAGE_IOSURFACE COREVIDEO_FALSE
#else
#define COREVIDEO_SUPPORTS_GLES_TEX_IMAGE_IOSURFACE COREVIDEO_SUPPORTS_IOSURFACE
#endif
#if TARGET_OS_IPHONE
#define COREVIDEO_USE_IOSURFACEREF COREVIDEO_TRUE
#else
#define COREVIDEO_USE_IOSURFACEREF COREVIDEO_FALSE
#endif
#if COREVIDEO_SUPPORTS_IOSURFACE && (TARGET_OS_IPHONE || (MAC_OS_X_VERSION_MIN_REQUIRED >= 101100)) && (! TARGET_OS_WATCH)
#define COREVIDEO_SUPPORTS_METAL COREVIDEO_TRUE
#else
#define COREVIDEO_SUPPORTS_METAL COREVIDEO_FALSE
#endif
#ifndef COREVIDEO_SUPPORTS_PERMANENT_ALLOCATOR
#if TARGET_OS_MAC
#define COREVIDEO_SUPPORTS_PERMANENT_ALLOCATOR COREVIDEO_FALSE // set this to COREVIDEO_TRUE when this is fixed [64465605] malloc zone allocations all show up as non-object in heap
#else
#define COREVIDEO_SUPPORTS_PERMANENT_ALLOCATOR COREVIDEO_FALSE
#endif // TARGET_OS_MAC
#endif // COREVIDEO_SUPPORTS_PERMANENT_ALLOCATOR
#if (__cplusplus && __cplusplus >= 201103L && (__has_extension(cxx_strong_enums) || __has_feature(objc_fixed_enum))) || (!__cplusplus && __has_feature(objc_fixed_enum))
#define COREVIDEO_USE_DERIVED_ENUMS_FOR_CONSTANTS COREVIDEO_TRUE
#else
#define COREVIDEO_USE_DERIVED_ENUMS_FOR_CONSTANTS COREVIDEO_FALSE
#endif
#if (TARGET_OS_IPHONE || TARGET_OS_MAC) && defined(__has_feature) && __has_feature(nullability)
#define COREVIDEO_DECLARE_NULLABILITY COREVIDEO_TRUE
#else
#define COREVIDEO_DECLARE_NULLABILITY COREVIDEO_FALSE
#endif
#if (TARGET_OS_IPHONE || TARGET_OS_MAC) && defined(__has_feature) && __has_feature(attribute_cf_returns_retained)
#define CV_RETURNS_RETAINED CF_RETURNS_RETAINED
#else
#define CV_RETURNS_RETAINED
#endif
#if (TARGET_OS_IPHONE || TARGET_OS_MAC) && defined(__has_feature) && __has_feature(attribute_cf_returns_on_parameters)
#define CV_RETURNS_RETAINED_PARAMETER CF_RETURNS_RETAINED
#else
#define CV_RETURNS_RETAINED_PARAMETER
#endif
#if (TARGET_OS_IPHONE || TARGET_OS_MAC) && defined(__has_feature) && __has_feature(attribute_cf_consumed)
#define CV_RELEASES_ARGUMENT CF_RELEASES_ARGUMENT
#else
#define CV_RELEASES_ARGUMENT
#endif
#if (TARGET_OS_IPHONE || TARGET_OS_MAC) && defined(__has_feature) && __has_feature(objc_bridge_id)
#define CV_BRIDGED_TYPE(type) CF_BRIDGED_TYPE(type)
#else
#define CV_BRIDGED_TYPE(type)
#endif
#if COREVIDEO_DECLARE_NULLABILITY
#define CV_NULLABLE __nullable
#define CV_NONNULL __nonnull
#else
#define CV_NULLABLE
#define CV_NONNULL
#endif
#define CV_INTERNAL __attribute__((visibility("hidden")))
#if TARGET_OS_WIN32 && defined(CV_BUILDING_CV) && defined(__cplusplus)
#define CV_EXPORT extern "C" __declspec(dllexport)
#elif TARGET_OS_WIN32 && defined(CV_BUILDING_CV) && !defined(__cplusplus)
#define CV_EXPORT extern __declspec(dllexport)
#elif TARGET_OS_WIN32 && defined(__cplusplus)
#define CV_EXPORT extern "C" __declspec(dllimport)
#elif TARGET_OS_WIN32
#define CV_EXPORT extern __declspec(dllimport)
#else
#define CV_EXPORT __attribute__((visibility("default"))) CF_EXPORT
#endif
#define CV_INLINE CF_INLINE
#define CVDIRECT3DDEVICE LPDIRECT3DDEVICE9
#define CVDIRECT3DTEXTURE LPDIRECT3DTEXTURE9
#define CVDIRECT3DSURFACE LPDIRECT3DSURFACE9
#define CVDIRECT3D LPDIRECT3D9
#if defined(COREVIDEO_SILENCE_GL_DEPRECATION) || \
defined(GL_SILENCE_DEPRECATION) || \
defined(GLES_SILENCE_DEPRECATION)
#define COREVIDEO_GL_DEPRECATED(platform, from, to) API_AVAILABLE(platform(from))
#else
#define COREVIDEO_GL_DEPRECATED(platform, from, to) API_DEPRECATED("OpenGL/OpenGLES is no longer supported. Use Metal APIs instead. (Define COREVIDEO_SILENCE_GL_DEPRECATION to silence these warnings)", platform(from, to))
#endif // COREVIDEO_SILENCE_GL_DEPRECATION
/*!
@typedef CVOptionFlags
@abstract Flags to be used for the display and render call back functions.
@discussion ***Values to be defined***
*/
typedef uint64_t CVOptionFlags;
/*!
@struct CVSMPTETime
@abstract A structure for holding a SMPTE time.
@field subframes
The number of subframes in the full message.
@field subframeDivisor
The number of subframes per frame (typically 80).
@field counter
The total number of messages received.
@field type
The kind of SMPTE time using the SMPTE time type constants.
@field flags
A set of flags that indicate the SMPTE state.
@field hours
The number of hours in the full message.
@field minutes
The number of minutes in the full message.
@field seconds
The number of seconds in the full message.
@field frames
The number of frames in the full message.
*/
struct CVSMPTETime
{
SInt16 subframes;
SInt16 subframeDivisor;
UInt32 counter;
UInt32 type;
UInt32 flags;
SInt16 hours;
SInt16 minutes;
SInt16 seconds;
SInt16 frames;
};
typedef struct CVSMPTETime CVSMPTETime;
/*!
@enum SMPTE Time Types
@abstract Constants that describe the type of SMPTE time.
@constant kCVSMPTETimeType24
24 Frame
@constant kCVSMPTETimeType25
25 Frame
@constant kCVSMPTETimeType30Drop
30 Drop Frame
@constant kCVSMPTETimeType30
30 Frame
@constant kCVSMPTETimeType2997
29.97 Frame
@constant kCVSMPTETimeType2997Drop
29.97 Drop Frame
@constant kCVSMPTETimeType60
60 Frame
@constant kCVSMPTETimeType5994
59.94 Frame
*/
typedef CF_ENUM(uint32_t, CVSMPTETimeType)
{
kCVSMPTETimeType24 = 0,
kCVSMPTETimeType25 = 1,
kCVSMPTETimeType30Drop = 2,
kCVSMPTETimeType30 = 3,
kCVSMPTETimeType2997 = 4,
kCVSMPTETimeType2997Drop = 5,
kCVSMPTETimeType60 = 6,
kCVSMPTETimeType5994 = 7
};
/*!
@enum SMPTE State Flags
@abstract Flags that describe the SMPTE time state.
@constant kCVSMPTETimeValid
The full time is valid.
@constant kCVSMPTETimeRunning
Time is running.
*/
typedef CF_OPTIONS(uint32_t, CVSMPTETimeFlags)
{
kCVSMPTETimeValid = (1L << 0),
kCVSMPTETimeRunning = (1L << 1)
};
typedef CF_OPTIONS(int32_t, CVTimeFlags) {
kCVTimeIsIndefinite = 1 << 0
};
typedef struct
{
int64_t timeValue;
int32_t timeScale;
int32_t flags;
} CVTime;
/*!
@struct CVTimeStamp
@abstract CoreVideo uses a CVTimeStamp structure to store video display time stamps.
@discussion This structure is purposely very similar to AudioTimeStamp defined in the CoreAudio framework.
Most of the CVTimeStamp struct should be fairly self-explanatory. However, it is probably worth pointing out that unlike the audio time stamps, floats are not used to represent the video equivalent of sample times. This was done partly to avoid precision issues, and partly because QuickTime still uses integers for time values and time scales. In the actual implementation it has turned out to be very convenient to use integers, and we can represent framerates like NTSC (30000/1001 fps) exactly. The mHostTime structure field uses the same Mach absolute time base that is used in CoreAudio, so that clients of the CoreVideo API can synchronize between the two subsystems.
@field version The current CVTimeStamp is version 0.
@field videoTimeScale The scale (in units per second) of the videoTime and videoPeriod values
@field videoTime This represents the start of a frame (or field for interlaced)
@field hostTime Host root timebase time
@field rateScalar This is the current rate of the device as measured by the timestamps, divided by the nominal rate
@field videoRefreshPeriod This is the nominal update period of the current output device
@field smpteTime SMPTE time representation of the time stamp.
@field flags Possible values are:
kCVTimeStampVideoTimeValid
kCVTimeStampHostTimeValid
kCVTimeStampSMPTETimeValid
kCVTimeStampVideoPeriodValid
kCVTimeStampRateScalarValid
There are flags for each field to make it easier to detect interlaced vs progressive output
kCVTimeStampTopField
kCVTimeStampBottomField
Some commonly used combinations of timestamp flags
kCVTimeStampVideoHostTimeValid
kCVTimeStampIsInterlaced
@field reserved Reserved. Do not use.
*/
typedef struct
{
uint32_t version;
int32_t videoTimeScale;
int64_t videoTime;
uint64_t hostTime;
double rateScalar;
int64_t videoRefreshPeriod;
CVSMPTETime smpteTime;
uint64_t flags;
uint64_t reserved;
} CVTimeStamp;
// Flags for the CVTimeStamp structure
typedef CF_OPTIONS(uint64_t, CVTimeStampFlags)
{
kCVTimeStampVideoTimeValid = (1L << 0),
kCVTimeStampHostTimeValid = (1L << 1),
kCVTimeStampSMPTETimeValid = (1L << 2),
kCVTimeStampVideoRefreshPeriodValid = (1L << 3),
kCVTimeStampRateScalarValid = (1L << 4),
// There are flags for each field to make it easier to detect interlaced vs progressive output
kCVTimeStampTopField = (1L << 16),
kCVTimeStampBottomField = (1L << 17),
// Some commonly used combinations of timestamp flags
kCVTimeStampVideoHostTimeValid = (kCVTimeStampVideoTimeValid | kCVTimeStampHostTimeValid),
kCVTimeStampIsInterlaced = (kCVTimeStampTopField | kCVTimeStampBottomField)
};
CV_EXPORT const CVTime kCVZeroTime;
CV_EXPORT const CVTime kCVIndefiniteTime;
#if defined(__cplusplus)
}
#endif
#endif
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreVideo.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreVideo.framework/Headers/CVPixelFormatDescription.h | /*
* CVPixelFormatDescription.h
* CoreVideo
*
* Copyright (c) 2013-2015 Apple Inc. All rights reserved.
*
*/
#if !defined(__COREVIDEO_CVPIXELFORMATDESCRIPTION_H__)
#define __COREVIDEO_CVPIXELFORMATDESCRIPTION_H__
#include <TargetConditionals.h>
#include <Availability.h>
#include <AvailabilityMacros.h>
#include <CoreVideo/CoreVideo.h>
#include <CoreFoundation/CFDictionary.h>
#include <CoreFoundation/CFArray.h>
#if defined(__cplusplus)
extern "C" {
#endif
/* This document is influenced by Ice Floe #19: http://developer.apple.com/quicktime/icefloe/dispatch019.html */
/* The canonical name for the format. This should bethe same as the codec name you'd use in QT */
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelFormatName __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/* QuickTime/QuickDraw Pixel Format Type constant (OSType) */
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelFormatConstant __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/* This is the codec type constant, i.e. '2vuy' or k422YpCbCr8CodecType */
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelFormatCodecType __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/* This is the equivalent Microsoft FourCC code for this pixel format */
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelFormatFourCC __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/* kCFBooleanTrue indicates that the format contains alpha and some images may be considered transparent;
kCFBooleanFalse indicates that there is no alpha and images are always opaque. */
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelFormatContainsAlpha __OSX_AVAILABLE_STARTING(__MAC_10_7,__IPHONE_4_3);
/* kCFBooleanTrue indicates that the format contains YCbCr data; */
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelFormatContainsYCbCr __OSX_AVAILABLE_STARTING(__MAC_10_10,__IPHONE_8_0);
/* kCFBooleanTrue indicates that the format contains RGB data; */
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelFormatContainsRGB __OSX_AVAILABLE_STARTING(__MAC_10_10,__IPHONE_8_0);
/* kCFBooleanTrue indicates that the format contains Grayscale data; */
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelFormatContainsGrayscale __OSX_AVAILABLE_STARTING(__MAC_10_14,__IPHONE_12_0);
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelFormatComponentRange __OSX_AVAILABLE_STARTING(__MAC_10_10,__IPHONE_9_0);
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelFormatComponentRange_VideoRange __OSX_AVAILABLE_STARTING(__MAC_10_10,__IPHONE_9_0);
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelFormatComponentRange_FullRange __OSX_AVAILABLE_STARTING(__MAC_10_10,__IPHONE_9_0);
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelFormatComponentRange_WideRange __OSX_AVAILABLE_STARTING(__MAC_10_10,__IPHONE_9_0);
/* All buffers have one or more image planes. Each plane may contain a single or an interleaved set of components */
/* For simplicity sake, pixel formats that are not planar may place the required format keys at the top
level dictionary. */
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelFormatPlanes __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/* The following keys describe the requirements/layout of a a single image plane. */
/* Used to assist with allocating memory for pixel formats that don't have an integer value for
bytes per pixel */
/* Block width is essentially the width in pixels of the smallest "byte addressable" group of pixels */
/* This works in close conjunction with BitsPerBlock */
/* Examples:
8-bit luminance only, BlockWidth would be 1, BitsPerBlock would be 8
16-bit 1555 RGB, BlockWidth would be 1, BitsPerBlock would be 16
32-bit 8888 ARGB, BlockWidth would be 1, BitsPerBlock would be 32
2vuy (CbYCrY), BlockWidth would be 2, BitsPerBlock would be 32
1-bit bitmap, BlockWidth would be 8, BitsPerBlock would be 8
v210, BlockWidth would be 6, BitsPerBlock would be 128 */
/* Values assumed to 1 be one if not present */
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelFormatBlockWidth __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelFormatBlockHeight __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/* This value must be present. For simple pixel formats this will be equivalent to the traditional
bitsPerPixel value. */
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelFormatBitsPerBlock __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/* Used to state requirements on block multiples. v210 would be '8' here for the horizontal case,
to match the standard v210 row alignment value of 48.
These may be assumed as 1 if not present. */
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelFormatBlockHorizontalAlignment __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelFormatBlockVerticalAlignment __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/* CFData containing the bit pattern for a block of black pixels. If absent, black is assumed to be all zeros.
If present, this should be bitsPerPixel bits long -- if bitsPerPixel is less than a byte, repeat the bit pattern
for the full byte. */
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelFormatBlackBlock __OSX_AVAILABLE_STARTING(__MAC_10_6,__IPHONE_4_0);
/* Subsampling information for this plane. Assumed to be '1' if not present. */
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelFormatHorizontalSubsampling __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelFormatVerticalSubsampling __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/* If present, these two keys describe the OpenGL format and type enums you would use to describe this
image plane to OpenGL */
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelFormatOpenGLFormat __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelFormatOpenGLType __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelFormatOpenGLInternalFormat __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/* CGBitmapInfo value, if required */
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelFormatCGBitmapInfo __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/* Pixel format compatibility flags */
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelFormatQDCompatibility API_AVAILABLE(macosx(10.4), ios(4.0), tvos(9.0), watchos(4.0));
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelFormatCGBitmapContextCompatibility API_AVAILABLE(macosx(10.4), ios(4.0), tvos(9.0), watchos(4.0));
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelFormatCGImageCompatibility API_AVAILABLE(macosx(10.4), ios(4.0), tvos(9.0), watchos(4.0));
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelFormatOpenGLCompatibility API_AVAILABLE(macosx(10.4), ios(4.0), tvos(9.0), watchos(4.0));
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelFormatOpenGLESCompatibility API_AVAILABLE(ios(5.0), tvos(9.0)) API_UNAVAILABLE(macosx) API_UNAVAILABLE(macCatalyst) __WATCHOS_PROHIBITED;
/* This callback routine implements code to handle the functionality of CVPixelBufferFillExtendedPixels.
For custom pixel formats where you will never need to use that call, this is not required. */
typedef Boolean (*CVFillExtendedPixelsCallBack)(CVPixelBufferRef CV_NONNULL pixelBuffer, void * CV_NULLABLE refCon);
typedef struct {
CFIndex version;
CVFillExtendedPixelsCallBack CV_NULLABLE fillCallBack;
void * CV_NULLABLE refCon;
} CVFillExtendedPixelsCallBackData;
/* The value for this key is a CFData containing a CVFillExtendedPixelsCallBackData struct */
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelFormatFillExtendedPixelsCallback __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/* Create a description of a pixel format from a provided OSType */
CV_EXPORT CFDictionaryRef CF_RETURNS_RETAINED CV_NULLABLE CVPixelFormatDescriptionCreateWithPixelFormatType(CFAllocatorRef CV_NULLABLE allocator, OSType pixelFormat) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/* Get a CFArray of CFNumbers containing all known pixel formats as OSTypes */
CV_EXPORT CFArrayRef CF_RETURNS_RETAINED CV_NULLABLE CVPixelFormatDescriptionArrayCreateWithAllPixelFormatTypes(CFAllocatorRef CV_NULLABLE allocator) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/* Register a new pixel format with CoreVideo */
CV_EXPORT void CVPixelFormatDescriptionRegisterDescriptionWithPixelFormatType(CFDictionaryRef CV_NONNULL description, OSType pixelFormat) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/*!
@function CVIsCompressedPixelFormatAvailable
@abstract Checks if a compressed pixel format is supported on the current platform.
@param pixelFormatType compressed pixel format.
@result True if pixel format is supported on the current platform.
*/
CV_EXPORT Boolean CVIsCompressedPixelFormatAvailable( OSType pixelFormatType ) API_AVAILABLE(macos(12.0), ios(15.0), tvos(15.0));
#if COREVIDEO_SUPPORTS_DIRECT3D
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelFormatDirect3DFormat;
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelFormatDirect3DType;
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelFormatDirect3DInternalFormat;
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelFormatDirect3DCompatibility;
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelFormatDXGICompatibility;
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelFormatDXGIFormat;
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelFormatDXGIType;
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelFormatDXGIInternalFormat;
#endif
#if defined(__cplusplus)
}
#endif
#endif
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreVideo.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreVideo.framework/Headers/CVImageBuffer.h | /*
* CVImageBuffer.h
* CoreVideo
*
* Copyright (c) 2004-2021 Apple Inc. All rights reserved.
*
*/
/*! @header CVImageBuffer.h
@copyright 2004-2015 Apple Inc. All rights reserved.
@availability Mac OS X 10.4 or later, and iOS 4.0 or later
@discussion CVImageBufferRef types are abstract and define various attachments and convenience
calls for retreiving image related bits of data.
*/
#if !defined(__COREVIDEO_CVIMAGEBUFFER_H__)
#define __COREVIDEO_CVIMAGEBUFFER_H__ 1
#include <TargetConditionals.h>
#include <Availability.h>
#include <AvailabilityMacros.h>
// For legacy reasons CVImageBuffer.h includes CoreGraphics.h and ApplicationServices.h
#if TARGET_OS_IPHONE || TARGET_OS_WIN32
#include <CoreGraphics/CoreGraphics.h>
#else
#include <ApplicationServices/ApplicationServices.h>
#endif
#include <CoreGraphics/CGColorSpace.h>
#include <CoreGraphics/CGGeometry.h>
#include <CoreVideo/CVBuffer.h>
#if defined(__cplusplus)
extern "C" {
#endif
#pragma mark CVImageBufferRef attachment keys
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferCGColorSpaceKey __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0); // CGColorSpaceRef
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferCleanApertureKey __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0); // CFDictionary containing the following four keys
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferCleanApertureWidthKey __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0); // CFNumber
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferCleanApertureHeightKey __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0); // CFNumber
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferCleanApertureHorizontalOffsetKey __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0); // CFNumber, horizontal offset from center of image buffer
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferCleanApertureVerticalOffsetKey __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0); // CFNumber, vertical offset from center of image buffer
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferPreferredCleanApertureKey __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0); // CFDictionary containing same keys as kCVImageBufferCleanApertureKey
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferFieldCountKey __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0); // CFNumber
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferFieldDetailKey __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0); // CFString with one of the following four values
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferFieldDetailTemporalTopFirst __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0); // CFString
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferFieldDetailTemporalBottomFirst __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0); // CFString
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferFieldDetailSpatialFirstLineEarly __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0); // CFString
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferFieldDetailSpatialFirstLineLate __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0); // CFString
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferPixelAspectRatioKey __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0); // CFDictionary with the following two keys
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferPixelAspectRatioHorizontalSpacingKey __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0); // CFNumber
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferPixelAspectRatioVerticalSpacingKey __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0); // CFNumber
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferDisplayDimensionsKey __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0); // CFDictionary with the following two keys
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferDisplayWidthKey __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0); // CFNumber
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferDisplayHeightKey __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0); // CFNumber
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferGammaLevelKey __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0); // CFNumber describing the gamma level, used in absence of (or ignorance of) kCVImageBufferTransferFunctionKey
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferICCProfileKey __OSX_AVAILABLE_STARTING(__MAC_10_6,__IPHONE_4_0); // CFData representation of the ICC profile
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferYCbCrMatrixKey __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0); // CFString describing the color matrix for YCbCr->RGB. This key can be one of the following values:
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferYCbCrMatrix_ITU_R_709_2 __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0); // CFString
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferYCbCrMatrix_ITU_R_601_4 __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0); // CFString
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferYCbCrMatrix_SMPTE_240M_1995 __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0); // CFString
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferYCbCrMatrix_DCI_P3 API_DEPRECATED("kCVImageBufferYCbCrMatrix_DCI_P3 no longer supported.", macos(10.11, 11.0), ios(9.0, 14.0)); // CFString
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferYCbCrMatrix_P3_D65 API_DEPRECATED("kCVImageBufferYCbCrMatrix_P3_D65 no longer supported.", macos(10.11, 11.0), ios(9.0, 14.0)); // CFString
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferYCbCrMatrix_ITU_R_2020 __OSX_AVAILABLE_STARTING(__MAC_10_11,__IPHONE_9_0); // CFString
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferColorPrimariesKey __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_4_0); // CFString describing the color primaries. This key can be one of the following values
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferColorPrimaries_ITU_R_709_2 __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_4_0);
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferColorPrimaries_EBU_3213 __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_4_0);
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferColorPrimaries_SMPTE_C __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_4_0);
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferColorPrimaries_P22 __OSX_AVAILABLE_STARTING(__MAC_10_8,__IPHONE_6_0);
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferColorPrimaries_DCI_P3 __OSX_AVAILABLE_STARTING(__MAC_10_11,__IPHONE_9_0);
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferColorPrimaries_P3_D65 __OSX_AVAILABLE_STARTING(__MAC_10_11,__IPHONE_9_0);
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferColorPrimaries_ITU_R_2020 __OSX_AVAILABLE_STARTING(__MAC_10_11,__IPHONE_9_0);
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferTransferFunctionKey __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_4_0); // CFString describing the transfer function. This key can be one of the following values
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferTransferFunction_ITU_R_709_2 __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_4_0);
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferTransferFunction_SMPTE_240M_1995 __OSX_AVAILABLE_STARTING(__MAC_10_6,__IPHONE_4_0);
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferTransferFunction_UseGamma __OSX_AVAILABLE_STARTING(__MAC_10_6,__IPHONE_4_0);
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferTransferFunction_EBU_3213 __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_5,__MAC_10_6,__IPHONE_NA,__IPHONE_NA); // Should not be used.
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferTransferFunction_SMPTE_C __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_5,__MAC_10_6,__IPHONE_NA,__IPHONE_NA); // Should not be used.
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferTransferFunction_sRGB __OSX_AVAILABLE_STARTING(__MAC_10_13,__IPHONE_11_0); // IEC 61966-2-1 sRGB or sYCC
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferTransferFunction_ITU_R_2020 __OSX_AVAILABLE_STARTING(__MAC_10_11,__IPHONE_9_0); // note: kCVImageBufferTransferFunction_ITU_R_709_2 is equivalent, and preferred
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferTransferFunction_SMPTE_ST_428_1 __OSX_AVAILABLE_STARTING(__MAC_10_12,__IPHONE_10_0);
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferTransferFunction_SMPTE_ST_2084_PQ __OSX_AVAILABLE_STARTING(__MAC_10_13,__IPHONE_11_0);
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferTransferFunction_ITU_R_2100_HLG __OSX_AVAILABLE_STARTING(__MAC_10_13,__IPHONE_11_0);
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferTransferFunction_Linear __OSX_AVAILABLE_STARTING(__MAC_10_14,__IPHONE_12_0);
/* Chroma siting information. For progressive images, only the TopField value is used. */
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferChromaLocationTopFieldKey __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_4_0); // CFString with one of the following CFString values
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferChromaLocationBottomFieldKey __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_4_0); // CFString with one of the following CFString values
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferChromaLocation_Left __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_4_0); // Chroma sample is horizontally co-sited with the left column of luma samples, but centered vertically.
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferChromaLocation_Center __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_4_0); // Chroma sample is fully centered
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferChromaLocation_TopLeft __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_4_0); // Chroma sample is co-sited with the top-left luma sample.
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferChromaLocation_Top __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_4_0); // Chroma sample is horizontally centered, but co-sited with the top row of luma samples.
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferChromaLocation_BottomLeft __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_4_0); // Chroma sample is co-sited with the bottom-left luma sample.
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferChromaLocation_Bottom __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_4_0); // Chroma sample is horizontally centered, but co-sited with the bottom row of luma samples.
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferChromaLocation_DV420 __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_4_0); // Cr and Cb samples are alternately co-sited with the left luma samples of the same field.
// These describe the format of the original subsampled data before conversion to 422/2vuy. In order to use
// these tags, the data must have been converted to 4:2:2 via simple pixel replication.
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferChromaSubsamplingKey __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_4_0); // CFString/CFNumber with one of the following values
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferChromaSubsampling_420 __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_4_0);
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferChromaSubsampling_422 __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_4_0);
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferChromaSubsampling_411 __OSX_AVAILABLE_STARTING(__MAC_10_5,__IPHONE_4_0);
// Can be set to kCFBooleanTrue as a hint that the alpha channel is fully opaque. Not used if the pixel format type has no alpha channel.
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferAlphaChannelIsOpaque __OSX_AVAILABLE_STARTING(__MAC_10_10,__IPHONE_8_0);
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferAlphaChannelModeKey API_AVAILABLE(macosx(10.15), ios(13.0), tvos(13.0)) API_UNAVAILABLE(watchos);
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferAlphaChannelMode_StraightAlpha API_AVAILABLE(macosx(10.15), ios(13.0), tvos(13.0)) API_UNAVAILABLE(watchos);
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferAlphaChannelMode_PremultipliedAlpha API_AVAILABLE(macosx(10.15), ios(13.0), tvos(13.0)) API_UNAVAILABLE(watchos);
// Returns the standard integer code point corresponding to a given CoreVideo YCbCrMatrix constant string (in the kCVImageBufferYCbCrMatrix_... family). Returns 2 (the code point for "unknown") if the string is NULL or not recognized.
CV_EXPORT int CVYCbCrMatrixGetIntegerCodePointForString( CV_NULLABLE CFStringRef yCbCrMatrixString ) API_AVAILABLE(macosx(10.13), ios(11.0), tvos(11.0), watchos(4.0));
// Returns the standard integer code point corresponding to a given CoreVideo ColorPrimaries constant string (in the kCVImageBufferColorPrimaries_... family). Returns 2 (the code point for "unknown") if the string is NULL or not recognized.
CV_EXPORT int CVColorPrimariesGetIntegerCodePointForString( CV_NULLABLE CFStringRef colorPrimariesString ) API_AVAILABLE(macosx(10.13), ios(11.0), tvos(11.0), watchos(4.0));
// Returns the standard integer code point corresponding to a given CoreVideo TransferFunction constant string (in the kCVImageBufferTransferFunction_... family). Returns 2 (the code point for "unknown") if the string is NULL or not recognized.
CV_EXPORT int CVTransferFunctionGetIntegerCodePointForString( CV_NULLABLE CFStringRef transferFunctionString ) API_AVAILABLE(macosx(10.13), ios(11.0), tvos(11.0), watchos(4.0));
// Returns the CoreVideo YCbCrMatrix constant string (in the kCVImageBufferYCbCrMatrix_... family) corresponding to a given standard integer code point. Returns NULL if the code point is not recognized, or if it is 2 (the code point for "unknown").
CV_EXPORT CV_NULLABLE CFStringRef CVYCbCrMatrixGetStringForIntegerCodePoint( int yCbCrMatrixCodePoint ) API_AVAILABLE(macosx(10.13), ios(11.0), tvos(11.0), watchos(4.0));
// Returns the CoreVideo ColorPrimaries constant string (in the kCVImageBufferColorPrimaries_... family) corresponding to a given standard integer code point. Returns NULL if the code point is not recognized, or if it is 2 (the code point for "unknown").
CV_EXPORT CV_NULLABLE CFStringRef CVColorPrimariesGetStringForIntegerCodePoint( int colorPrimariesCodePoint ) API_AVAILABLE(macosx(10.13), ios(11.0), tvos(11.0), watchos(4.0));
// Returns the CoreVideo TransferFunction constant string (in the kCVImageBufferTransferFunction_... family) corresponding to a given standard integer code point. Returns NULL if the code point is not recognized, or if it is 2 (the code point for "unknown").
CV_EXPORT CV_NULLABLE CFStringRef CVTransferFunctionGetStringForIntegerCodePoint( int transferFunctionCodePoint ) API_AVAILABLE(macosx(10.13), ios(11.0), tvos(11.0), watchos(4.0));
#pragma mark CVImageBufferRef
/*!
@typedef CVImageBufferRef
@abstract Base type for all CoreVideo image buffers
*/
typedef CVBufferRef CVImageBufferRef;
/*!
@function CVImageBufferGetEncodedSize
@abstract Returns the full encoded dimensions of a CVImageBuffer. For example, for an NTSC DV frame this would be 720x480
@param imageBuffer A CVImageBuffer that you wish to retrieve the encoded size from.
@result A CGSize returning the full encoded size of the buffer
Returns zero size if called with a non-CVImageBufferRef type or NULL.
*/
CV_EXPORT CGSize CVImageBufferGetEncodedSize( CVImageBufferRef CV_NONNULL imageBuffer ) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/*!
@function CVImageBufferGetDisplaySize
@abstract Returns the nominal output display size (in square pixels) of a CVImageBuffer.
For example, for an NTSC DV frame this would be 640x480
@param imageBuffer A CVImageBuffer that you wish to retrieve the display size from.
@result A CGSize returning the nominal display size of the buffer
Returns zero size if called with a non-CVImageBufferRef type or NULL.
*/
CV_EXPORT CGSize CVImageBufferGetDisplaySize( CVImageBufferRef CV_NONNULL imageBuffer ) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/*!
@function CVImageBufferGetCleanRect
@abstract Returns the source rectangle of a CVImageBuffer that represents the clean aperture
of the buffer in encoded pixels. For example, an NTSC DV frame would return a CGRect with an
origin of 8,0 and a size of 704,480.
Note that the origin of this rect always the lower left corner. This is the same coordinate system as
used by CoreImage.
@param imageBuffer A CVImageBuffer that you wish to retrieve the display size from.
@result A CGSize returning the nominal display size of the buffer
Returns zero rect if called with a non-CVImageBufferRef type or NULL.
*/
CV_EXPORT CGRect CVImageBufferGetCleanRect( CVImageBufferRef CV_NONNULL imageBuffer ) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/*!
@function CVImageBufferIsFlipped
@abstract Returns whether the image is flipped vertically or not.
@param CVImageBuffer target
@result True if 0,0 in the texture is upper left, false if 0,0 is lower left.
*/
CV_EXPORT Boolean CVImageBufferIsFlipped( CVImageBufferRef CV_NONNULL imageBuffer ) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
#if COREVIDEO_SUPPORTS_COLORSPACE
/*!
@function CVImageBufferGetColorSpace
@abstract Returns the color space of a CVImageBuffer.
@param imageBuffer A CVImageBuffer that you wish to retrieve the color space from.
@result A CGColorSpaceRef representing the color space of the buffer.
Returns NULL if called with a non-CVImageBufferRef type or NULL.
*/
CV_EXPORT CGColorSpaceRef CV_NULLABLE CVImageBufferGetColorSpace( CVImageBufferRef CV_NONNULL imageBuffer ) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
#endif
/*!
@function CVImageBufferCreateColorSpaceFromAttachments
@abstract Attempts to synthesize a CGColorSpace from an image buffer's attachments.
@param attachments A CFDictionary of attachments for an image buffer, obtained using CVBufferCopyAttachments().
@result A CGColorSpaceRef representing the color space of the buffer.
Returns NULL if the attachments dictionary does not contain the information required to synthesize a CGColorSpace.
@discussion
To generate a CGColorSpace, the attachments dictionary should include values for either:
1. kCVImageBufferICCProfile
2. kCVImageBufferColorPrimariesKey, kCVImageBufferTransferFunctionKey, and kCVImageBufferYCbCrMatrixKey (and possibly kCVImageBufferGammaLevelKey)
The client is responsible for releasing the CGColorSpaceRef when it is done with it (CGColorSpaceRelease() or CFRelease())
*/
CV_EXPORT CGColorSpaceRef CV_NULLABLE CVImageBufferCreateColorSpaceFromAttachments( CFDictionaryRef CV_NONNULL attachments ) __OSX_AVAILABLE_STARTING(__MAC_10_8,__IPHONE_10_0);
// CFData (24 bytes) containing big-endian data matching payload of ISO/IEC 23008-2:2015(E), D.2.28 Mastering display colour volume SEI message
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferMasteringDisplayColorVolumeKey __OSX_AVAILABLE_STARTING(__MAC_10_13,__IPHONE_11_0);
// CFData (4 bytes) containing big-endian data matching payload of Content Light Level Information SEI message
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferContentLightLevelInfoKey __OSX_AVAILABLE_STARTING(__MAC_10_13,__IPHONE_11_0);
// CFData (8 bytes) containing big-endian data matching payload of Ambient Viewing Environment SEI message
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferAmbientViewingEnvironmentKey API_AVAILABLE(macosx(12.0), ios(15.0), tvos(15.0), watchos(8.0));
/*!
@constant kCVImageBufferRegionOfInterestKey
@abstract
Specifies region of interest that image statistics cover. This value should be a CGRect dictionary created by CGRectCreateDictionaryRepresentation(). The origin in the CGRect represents the x,y coordinate within the CVPixelBuffer where region of interest is located.
@discussion
*/
CV_EXPORT const CFStringRef CV_NONNULL kCVImageBufferRegionOfInterestKey API_AVAILABLE(macosx(12.0), ios(15.0), tvos(15.0), watchos(8.0));
#if defined(__cplusplus)
}
#endif
#endif
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreVideo.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreVideo.framework/Headers/CVHostTime.h | /*
* CVHostTime.h
* CoreVideo
*
* Copyright (c) 2004-2014 Apple Inc. All rights reserved.
$ManualLog$
16aug2018 mito
[43359877] In C language, a function prototype declaration should use void for empty arguments <jdecoodt>
13jan2017 aballow
[28840287] Added CoreVideo Support for TiledCompressed IOSurfaces. <jsam>
*
*/
/*! @header CVHostTime.h
@copyright 2004-2014 Apple Inc. All rights reserved.
@availability Mac OS X 10.4 or later, and iOS 4.0 or later
@discussion Utility functions for retrieving and working with the host time.
*/
#if !defined(__COREVIDEO_CVHOSTTIME_H__)
#define __COREVIDEO_CVHOSTTIME_H__ 1
#include <TargetConditionals.h>
#include <Availability.h>
#include <AvailabilityMacros.h>
#include <CoreVideo/CVBase.h>
#if defined(__cplusplus)
extern "C" {
#endif
/*!
@function CVGetCurrentHostTime
@abstract Retrieve the current value of the host time base.
@discussion On Mac OS X, the host time base for CoreVideo and CoreAudio are identical, and the values returned from either API
may be used interchangeably.
@result The current host time.
*/
CV_EXPORT uint64_t CVGetCurrentHostTime(void) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/*!
@function CVGetHostClockFrequency
@abstract Retrieve the frequency of the host time base.
@discussion On Mac OS X, the host time base for CoreVideo and CoreAudio are identical, and the values returned from either API
may be used interchangeably.
@result The current host frequency.
*/
CV_EXPORT double CVGetHostClockFrequency(void) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/*!
@function CVGetHostClockMinimumTimeDelta
@abstract Retrieve the smallest possible increment in the host time base.
@result The smallest valid increment in the host time base.
*/
CV_EXPORT uint32_t CVGetHostClockMinimumTimeDelta(void) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
#if defined(__cplusplus)
}
#endif
#endif
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreVideo.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreVideo.framework/Headers/CVOpenGLTextureCache.h | /*
* CVOpenGLTextureCache.h
* CoreVideo
*
* Copyright 2004-2015 Apple Inc. All rights reserved.
*
*/
#if !defined(__COREVIDEO__CVOPENGLTEXTURECACHE_H__)
#define __COREVIDEO__CVOPENGLTEXTURECACHE_H__ 1
#include <CoreVideo/CVBase.h>
#include <CoreVideo/CVReturn.h>
#include <CoreVideo/CVBuffer.h>
#include <CoreVideo/CVOpenGLTexture.h>
#include <OpenGL/OpenGL.h>
#if defined(__cplusplus)
extern "C" {
#endif
/*!
@typedef CVOpenGLTextureCacheRef
@abstract CoreVideo OpenGL Texture Cache
*/
typedef struct CV_BRIDGED_TYPE(id) __CVOpenGLTextureCache *CVOpenGLTextureCacheRef;
/* Dictionary keys and values for use with the 'cacheAttributes' parameter of CVOpenGLTextureCacheCreate */
/* CVOpenGLTextureCache can (in some cases) do higher quality chroma upsampling on GPUs that support ARB_fragment_program. By
default it will be enabled automatically if the texture cache determines that the GPU has the needed support and the image
size is something reasonable for the GPU being used. The automatic behaviour can be overridden below. Note that setting
kCVOpenGLTextureCacheChromaSamplingModeHighQuality is only a request. GPUs that don't support ARB_fragment_program will still
resort back to the native hardware support for YCbCr textures. */
CV_EXPORT const CFStringRef CV_NONNULL kCVOpenGLTextureCacheChromaSamplingModeKey COREVIDEO_GL_DEPRECATED(macosx, 10.4, 10.14) API_UNAVAILABLE(macCatalyst);
CV_EXPORT const CFStringRef CV_NONNULL kCVOpenGLTextureCacheChromaSamplingModeAutomatic COREVIDEO_GL_DEPRECATED(macosx, 10.4, 10.14) API_UNAVAILABLE(macCatalyst); // Defaut if the key is not present
CV_EXPORT const CFStringRef CV_NONNULL kCVOpenGLTextureCacheChromaSamplingModeHighestQuality COREVIDEO_GL_DEPRECATED(macosx, 10.4, 10.14) API_UNAVAILABLE(macCatalyst); // Force highest quality regardless of performance impact
CV_EXPORT const CFStringRef CV_NONNULL kCVOpenGLTextureCacheChromaSamplingModeBestPerformance COREVIDEO_GL_DEPRECATED(macosx, 10.4, 10.14) API_UNAVAILABLE(macCatalyst); // Do it the quickest way possible
CV_EXPORT CFTypeID CVOpenGLTextureCacheGetTypeID(void) COREVIDEO_GL_DEPRECATED(macosx, 10.4, 10.14) API_UNAVAILABLE(macCatalyst);
/*!
@function CVOpenGLTextureCacheRetain
@abstract Retains a CVOpenGLTextureCache object
@discussion Equivalent to CFRetain, but NULL safe
@param buffer A CVOpenGLTextureCache object that you want to retain.
@result A CVOpenGLTextureCache object that is the same as the passed in buffer.
*/
CV_EXPORT CVOpenGLTextureCacheRef CV_NULLABLE CVOpenGLTextureCacheRetain( CVOpenGLTextureCacheRef CV_NULLABLE textureCache ) COREVIDEO_GL_DEPRECATED(macosx, 10.4, 10.14) API_UNAVAILABLE(macCatalyst); // NULL-safe
/*!
@function CVOpenGLTextureCacheRelease
@abstract Releases a CVOpenGLTextureCache object
@discussion Equivalent to CFRelease, but NULL safe
@param buffer A CVOpenGLTextureCache object that you want to release.
*/
CV_EXPORT void CVOpenGLTextureCacheRelease( CV_RELEASES_ARGUMENT CVOpenGLTextureCacheRef CV_NULLABLE textureCache ) COREVIDEO_GL_DEPRECATED(macosx, 10.4, 10.14) API_UNAVAILABLE(macCatalyst); // NULL-safe
/*!
@function CVOpenGLTextureCacheCreate
@abstract Creates a new Texture Cache.
@param allocator The CFAllocatorRef to use for allocating the cache. May be NULL.
@param cacheAttributes A CFDictionaryRef containing the attributes of the cache itself. May be NULL.
@param cglContext The OpenGL context into which the texture objects will be created
@param cglPixelFormat The OpenGL pixel format object used to create the passed in OpenGL context
@param textureAttributes A CFDictionaryRef containing the attributes to be used for creating the CVOpenGLTexture objects. May be NULL.
@param cacheOut The newly created texture cache will be placed here
@result Returns kCVReturnSuccess on success
*/
CV_EXPORT CVReturn CVOpenGLTextureCacheCreate(
CFAllocatorRef CV_NULLABLE allocator,
CFDictionaryRef CV_NULLABLE cacheAttributes,
CGLContextObj CV_NONNULL cglContext,
CGLPixelFormatObj CV_NONNULL cglPixelFormat,
CFDictionaryRef CV_NULLABLE textureAttributes,
CV_RETURNS_RETAINED_PARAMETER CVOpenGLTextureCacheRef CV_NULLABLE * CV_NONNULL cacheOut ) COREVIDEO_GL_DEPRECATED(macosx, 10.4, 10.14) API_UNAVAILABLE(macCatalyst);
/*!
@function CVOpenGLTextureCacheCreateTextureFromImage
@abstract Creates a CVOpenGLTexture object from an existing CVImageBuffer
@param allocator The CFAllocatorRef to use for allocating the CVOpenGLTexture object. May be NULL.
@param textureCache The texture cache object that will manage the texture
@param sourceImage The CVImageBuffer that you want to create a CVOpenGLTexture from.
@param attributes For Future use only! - The desired buffer attributes for the CVOpenGLTexture.
@param textureOut The newly created texture object will be placed here.
@result Returns kCVReturnSuccess on success
*/
CV_EXPORT CVReturn CVOpenGLTextureCacheCreateTextureFromImage(
CFAllocatorRef CV_NULLABLE allocator,
CVOpenGLTextureCacheRef CV_NONNULL textureCache,
CVImageBufferRef CV_NONNULL sourceImage,
CFDictionaryRef CV_NULLABLE attributes,
CV_RETURNS_RETAINED_PARAMETER CVOpenGLTextureRef CV_NULLABLE * CV_NONNULL textureOut ) COREVIDEO_GL_DEPRECATED(macosx, 10.4, 10.14) API_UNAVAILABLE(macCatalyst);
/*!
@function CVOpenGLTextureCacheFlush
@abstract Performs internal housekeeping/recycling operations
@discussion This call must be made periodically to give the texture cache a chance to make OpenGL calls
on the OpenGL context used to create it in order to do housekeeping operations.
@param textureCache The texture cache object to flush
@param options Currently unused, set to 0.
@result Returns kCVReturnSuccess on success
*/
CV_EXPORT void CVOpenGLTextureCacheFlush( CVOpenGLTextureCacheRef CV_NONNULL textureCache, CVOptionFlags options ) COREVIDEO_GL_DEPRECATED(macosx, 10.4, 10.14) API_UNAVAILABLE(macCatalyst);
#if defined(__cplusplus)
}
#endif
#endif
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreVideo.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreVideo.framework/Headers/CVOpenGLBufferPool.h | /*
* CVOpenGLBufferPool.h
* CoreVideo
*
* Copyright 2004-2015 Apple Inc. All rights reserved.
*
*/
/*! @header CVOpenGLBufferPool.h
@copyright 2004-2015 Apple Inc. All rights reserved.
@availability Mac OS X 10.4 or later
@discussion CVOpenGLBufferPool is a utility object for managing a set of CVOpenGLBuffer objects that are going to be recycled.
*/
#if !defined(__COREVIDEO__CVOPENGLBUFFERPOOL_H__)
#define __COREVIDEO__CVOPENGLBUFFERPOOL_H__ 1
#include <CoreVideo/CVBase.h>
#include <CoreVideo/CVReturn.h>
#include <CoreVideo/CVOpenGLBuffer.h>
#if defined(__cplusplus)
extern "C" {
#endif
typedef struct CV_BRIDGED_TYPE(id) __CVOpenGLBufferPool *CVOpenGLBufferPoolRef;
CV_EXPORT const CFStringRef CV_NONNULL kCVOpenGLBufferPoolMinimumBufferCountKey COREVIDEO_GL_DEPRECATED(macosx, 10.4, 10.14) API_UNAVAILABLE(macCatalyst);
// By default, buffers will age out after one second. If required, setting an age of zero will disable
// the age-out mechanism completely.
CV_EXPORT const CFStringRef CV_NONNULL kCVOpenGLBufferPoolMaximumBufferAgeKey COREVIDEO_GL_DEPRECATED(macosx, 10.4, 10.14) API_UNAVAILABLE(macCatalyst);
CV_EXPORT CFTypeID CVOpenGLBufferPoolGetTypeID(void) COREVIDEO_GL_DEPRECATED(macosx, 10.4, 10.14) API_UNAVAILABLE(macCatalyst);
/*!
@function CVOpenGLBufferPoolRetain
@abstract Retains a CVOpenGLBufferPoolRef object
@discussion Equivalent to CFRetain, but NULL safe
@param buffer A CVOpenGLBufferPoolRef object that you want to retain.
@result A CVOpenGLBufferPoolRef object that is the same as the passed in buffer.
*/
CV_EXPORT CVOpenGLBufferPoolRef CV_NULLABLE CVOpenGLBufferPoolRetain( CVOpenGLBufferPoolRef CV_NULLABLE openGLBufferPool ) COREVIDEO_GL_DEPRECATED(macosx, 10.4, 10.14) API_UNAVAILABLE(macCatalyst); // NULL-safe
/*!
@function CVOpenGLBufferPoolRelease
@abstract Releases a CVOpenGLBufferPoolRef object
@discussion Equivalent to CFRelease, but NULL safe
@param buffer A CVOpenGLBufferPoolRef object that you want to release.
*/
CV_EXPORT void CVOpenGLBufferPoolRelease( CV_RELEASES_ARGUMENT CVOpenGLBufferPoolRef CV_NULLABLE openGLBufferPool ) COREVIDEO_GL_DEPRECATED(macosx, 10.4, 10.14) API_UNAVAILABLE(macCatalyst); // NULL-safe
/*!
@function CVOpenGLBufferPoolCreate
@abstract Creates a new OpenGL Buffer pool.
@discussion Equivalent to CFRelease, but NULL safe
@param allocator The CFAllocatorRef to use for allocating this buffer pool. May be NULL.
@param poolAttributes A CFDictionaryRef containing the attributes to be used for the pool itself.
@param openGLBufferAttributes A CFDictionaryRef containing the attributes to be used for creating new OpenGLBuffers within the pool.
@param poolOut The newly created pool will be placed here
@result Returns kCVReturnSuccess on success
*/
CV_EXPORT CVReturn CVOpenGLBufferPoolCreate(
CFAllocatorRef CV_NULLABLE allocator,
CFDictionaryRef CV_NULLABLE poolAttributes,
CFDictionaryRef CV_NULLABLE openGLBufferAttributes,
CV_RETURNS_RETAINED_PARAMETER CVOpenGLBufferPoolRef CV_NULLABLE * CV_NONNULL poolOut ) COREVIDEO_GL_DEPRECATED(macosx, 10.4, 10.14) API_UNAVAILABLE(macCatalyst);
/*!
@function CVOpenGLBufferPoolGetOpenGLBufferAttributes
@abstract Returns the pool attributes dictionary for a CVOpenGLBufferPool
@param pool The CVOpenGLBufferPoolRef to retrieve the attributes from
@result Returns the pool attributes dictionary, or NULL on failure.
*/
CV_EXPORT CFDictionaryRef CV_NULLABLE CVOpenGLBufferPoolGetAttributes( CVOpenGLBufferPoolRef CV_NONNULL pool ) COREVIDEO_GL_DEPRECATED(macosx, 10.4, 10.14) API_UNAVAILABLE(macCatalyst);
/*!
@function CVOpenGLBufferPoolGetOpenGLBufferAttributes
@abstract Returns the attributes of OpenGL buffers that will be created from this pool.
@discussion This function is provided for those cases where you may need to know some information about the buffers that
will be created up front.
@param pool The CVOpenGLBufferPoolRef to retrieve the attributes from
@result Returns the OpenGL buffer attributes dictionary, or NULL on failure.
*/
CV_EXPORT CFDictionaryRef CV_NULLABLE CVOpenGLBufferPoolGetOpenGLBufferAttributes( CVOpenGLBufferPoolRef CV_NONNULL pool ) COREVIDEO_GL_DEPRECATED(macosx, 10.4, 10.14) API_UNAVAILABLE(macCatalyst);
/*!
@function CVOpenGLBufferPoolCreateOpenGLBuffer
@abstract Creates a new OpenGLBuffer object from the pool.
@discussion The function creates a new CVOpenGLBuffer with the default attachments using the OpenGL buffer attributes specifed during pool creation.
@param allocator The CFAllocatorRef to use for creating the OpenGL buffer. May be NULL.
@param openGLBufferPool The CVOpenGLBufferPool that should create the new CVOpenGLBuffer.
@param openGLBufferOut The newly created OpenGL buffer will be placed here
@result Returns kCVReturnSuccess on success
*/
CV_EXPORT CVReturn CVOpenGLBufferPoolCreateOpenGLBuffer(
CFAllocatorRef CV_NULLABLE allocator,
CVOpenGLBufferPoolRef CV_NONNULL openGLBufferPool,
CV_RETURNS_RETAINED_PARAMETER CVOpenGLBufferRef CV_NULLABLE * CV_NONNULL openGLBufferOut ) COREVIDEO_GL_DEPRECATED(macosx, 10.4, 10.14) API_UNAVAILABLE(macCatalyst);
#if defined(__cplusplus)
}
#endif
#endif
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreVideo.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreVideo.framework/Headers/CVMetalTextureCache.h | /*
* CVMetalTextureCache.h
* CoreVideo
*
* Copyright 2011-2015 Apple Inc. All rights reserved.
*
*/
/*! @header CVMetalTextureCache.h
@copyright 2011-2015 Apple Inc. All rights reserved.
@availability iOS 8.0 or later. Mac OS X 10.11 or later.
@discussion A CoreVideo Metal TextureCache is used to cache and manage CVMetalTextures.
*/
#if !defined(__COREVIDEO__CVMETALTEXTURECACHE_H__)
#define __COREVIDEO__CVMETALTEXTURECACHE_H__ 1
#include <CoreVideo/CVBase.h>
#include <CoreVideo/CVReturn.h>
#include <CoreVideo/CVBuffer.h>
#include <CoreVideo/CVMetalTexture.h>
#if defined(__cplusplus)
extern "C" {
#endif
//
// cacheAttributes
//
// By default, textures will age out after one second. Setting a maximum
// texture age of zero will disable the age-out mechanism completely.
// CVMetalTextureCacheFlush() can be used to force eviction in either case.
CV_EXPORT const CFStringRef CV_NONNULL kCVMetalTextureCacheMaximumTextureAgeKey API_AVAILABLE(macosx(10.11), ios(8.0), tvos(9.0)) __WATCHOS_PROHIBITED;
//
// textureAttributes - reserved for future use
/* CVMetalTextureCacheRef is only available to Objective C code */
#if defined(__OBJC__) && COREVIDEO_SUPPORTS_METAL
#import <Metal/MTLPixelFormat.h>
@protocol MTLDevice;
/*!
@typedef CVMetalTextureCacheRef
@abstract CoreVideo Metal Texture Cache
*/
typedef struct CV_BRIDGED_TYPE(id) __CVMetalTextureCache *CVMetalTextureCacheRef;
CV_EXPORT CFTypeID CVMetalTextureCacheGetTypeID(void) API_AVAILABLE(macosx(10.11), ios(8.0), tvos(9.0)) __WATCHOS_PROHIBITED;
/*!
@function CVMetalTextureCacheCreate
@abstract Creates a new Texture Cache.
@param allocator The CFAllocatorRef to use for allocating the cache. May be NULL.
@param cacheAttributes A CFDictionaryRef containing the attributes of the cache itself. May be NULL.
@param metalDevice The Metal device for which the texture objects will be created.
@param textureAttributes A CFDictionaryRef containing the attributes to be used for creating the CVMetalTexture objects. May be NULL.
@param cacheOut The newly created texture cache will be placed here
@result Returns kCVReturnSuccess on success
*/
CV_EXPORT CVReturn CVMetalTextureCacheCreate(
CFAllocatorRef CV_NULLABLE allocator,
CFDictionaryRef CV_NULLABLE cacheAttributes,
id <MTLDevice> CV_NONNULL metalDevice,
CFDictionaryRef CV_NULLABLE textureAttributes,
CV_RETURNS_RETAINED_PARAMETER CVMetalTextureCacheRef CV_NULLABLE * CV_NONNULL cacheOut ) API_AVAILABLE(macosx(10.11), ios(8.0), tvos(9.0)) __WATCHOS_PROHIBITED;
/*!
@function CVMetalTextureCacheCreateTextureFromImage
@abstract Creates a CVMetalTexture object from an existing CVImageBuffer
@param allocator The CFAllocatorRef to use for allocating the CVMetalTexture object. May be NULL.
@param textureCache The texture cache object that will manage the texture.
@param sourceImage The CVImageBuffer that you want to create a CVMetalTexture from.
@param textureAttributes A CFDictionaryRef containing attributes to be used for creating the CVMetalTexture objects. May be NULL.
@param pixelFormat Specifies the Metal pixel format.
@param width Specifies the width of the texture image.
@param height Specifies the height of the texture image.
@param planeIndex Specifies the plane of the CVImageBuffer to map bind. Ignored for non-planar CVImageBuffers.
@param textureOut The newly created texture object will be placed here.
@result Returns kCVReturnSuccess on success
@discussion Creates or returns a cached CVMetalTexture texture object mapped to the CVImageBuffer and
associated params. This creates a live binding between the CVImageBuffer and underlying
CVMetalTexture texture object.
Note that CoreVideo does not explicitly declare any pixel format types to be Metal compatible. The assumption
is that if the CVPixelBufferMetalCompatibilityKey has been specified, all buffers will be Metal compatible
(IOSurface backed), and thus it is the developer's responsibility to choose an appropriate Metal pixel format
for the CVPixelBuffers.
Here are some example mappings:
Mapping a BGRA buffer:
CVMetalTextureCacheCreateTextureFromImage(kCFAllocatorDefault, textureCache, pixelBuffer, NULL, MTLPixelFormatBGRA8Unorm, width, height, 0, &outTexture);
Mapping the luma plane of a 420v buffer:
CVMetalTextureCacheCreateTextureFromImage(kCFAllocatorDefault, textureCache, pixelBuffer, NULL, MTLPixelFormatR8Unorm, width, height, 0, &outTexture);
Mapping the chroma plane of a 420v buffer as a source texture:
CVMetalTextureCacheCreateTextureFromImage(kCFAllocatorDefault, textureCache, pixelBuffer, NULL, MTLPixelFormatRG8Unorm width/2, height/2, 1, &outTexture);
Mapping a yuvs buffer as a source texture (note: yuvs/f and 2vuy are unpacked and resampled -- not colorspace converted)
CVMetalTextureCacheCreateTextureFromImage(kCFAllocatorDefault, textureCache, pixelBuffer, NULL, MTLPixelFormatGBGR422, width, height, 1, &outTexture);
*/
CV_EXPORT CVReturn CVMetalTextureCacheCreateTextureFromImage(
CFAllocatorRef CV_NULLABLE allocator,
CVMetalTextureCacheRef CV_NONNULL textureCache,
CVImageBufferRef CV_NONNULL sourceImage,
CFDictionaryRef CV_NULLABLE textureAttributes,
MTLPixelFormat pixelFormat,
size_t width,
size_t height,
size_t planeIndex,
CV_RETURNS_RETAINED_PARAMETER CVMetalTextureRef CV_NULLABLE * CV_NONNULL textureOut ) API_AVAILABLE(macosx(10.11), ios(8.0), tvos(9.0)) __WATCHOS_PROHIBITED;
/*!
@function CVMetalTextureCacheFlush
@abstract Performs internal housekeeping/recycling operations
@discussion This call must be made periodically to give the texture cache a chance to do internal housekeeping operations.
@param textureCache The texture cache object to flush
@param options Currently unused, set to 0.
*/
CV_EXPORT void CVMetalTextureCacheFlush(CVMetalTextureCacheRef CV_NONNULL textureCache, CVOptionFlags options) API_AVAILABLE(macosx(10.11), ios(8.0), tvos(9.0)) __WATCHOS_PROHIBITED;
#endif
#if defined(__cplusplus)
}
#endif
#endif
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreVideo.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreVideo.framework/Headers/CVPixelBuffer.h | /*
* CVPixelBuffer.h
* CoreVideo
*
* Copyright (c) 2004-2021 Apple Inc. All rights reserved.
*
*/
/*! @header CVPixelBuffer.h
@copyright 2004-2021 Apple Inc. All rights reserved.
@availability Mac OS X 10.4 or later, and iOS 4.0 or later
@discussion CVPixelBuffers are CVImageBuffers that hold the pixels in main memory
*/
#if !defined(__COREVIDEO_CVPIXELBUFFER_H__)
#define __COREVIDEO_CVPIXELBUFFER_H__ 1
#include <TargetConditionals.h>
#include <Availability.h>
#include <AvailabilityMacros.h>
#include <CoreVideo/CVImageBuffer.h>
#include <CoreFoundation/CFArray.h>
#if defined(__cplusplus)
extern "C" {
#endif
/*
CoreVideo pixel format type constants.
CoreVideo does not provide support for all of these formats; this list just defines their names.
*/
#if COREVIDEO_USE_DERIVED_ENUMS_FOR_CONSTANTS
enum : OSType
#else
enum
#endif
{
kCVPixelFormatType_1Monochrome = 0x00000001, /* 1 bit indexed */
kCVPixelFormatType_2Indexed = 0x00000002, /* 2 bit indexed */
kCVPixelFormatType_4Indexed = 0x00000004, /* 4 bit indexed */
kCVPixelFormatType_8Indexed = 0x00000008, /* 8 bit indexed */
kCVPixelFormatType_1IndexedGray_WhiteIsZero = 0x00000021, /* 1 bit indexed gray, white is zero */
kCVPixelFormatType_2IndexedGray_WhiteIsZero = 0x00000022, /* 2 bit indexed gray, white is zero */
kCVPixelFormatType_4IndexedGray_WhiteIsZero = 0x00000024, /* 4 bit indexed gray, white is zero */
kCVPixelFormatType_8IndexedGray_WhiteIsZero = 0x00000028, /* 8 bit indexed gray, white is zero */
kCVPixelFormatType_16BE555 = 0x00000010, /* 16 bit BE RGB 555 */
kCVPixelFormatType_16LE555 = 'L555', /* 16 bit LE RGB 555 */
kCVPixelFormatType_16LE5551 = '5551', /* 16 bit LE RGB 5551 */
kCVPixelFormatType_16BE565 = 'B565', /* 16 bit BE RGB 565 */
kCVPixelFormatType_16LE565 = 'L565', /* 16 bit LE RGB 565 */
kCVPixelFormatType_24RGB = 0x00000018, /* 24 bit RGB */
kCVPixelFormatType_24BGR = '24BG', /* 24 bit BGR */
kCVPixelFormatType_32ARGB = 0x00000020, /* 32 bit ARGB */
kCVPixelFormatType_32BGRA = 'BGRA', /* 32 bit BGRA */
kCVPixelFormatType_32ABGR = 'ABGR', /* 32 bit ABGR */
kCVPixelFormatType_32RGBA = 'RGBA', /* 32 bit RGBA */
kCVPixelFormatType_64ARGB = 'b64a', /* 64 bit ARGB, 16-bit big-endian samples */
kCVPixelFormatType_64RGBALE = 'l64r', /* 64 bit RGBA, 16-bit little-endian full-range (0-65535) samples */
kCVPixelFormatType_48RGB = 'b48r', /* 48 bit RGB, 16-bit big-endian samples */
kCVPixelFormatType_32AlphaGray = 'b32a', /* 32 bit AlphaGray, 16-bit big-endian samples, black is zero */
kCVPixelFormatType_16Gray = 'b16g', /* 16 bit Grayscale, 16-bit big-endian samples, black is zero */
kCVPixelFormatType_30RGB = 'R10k', /* 30 bit RGB, 10-bit big-endian samples, 2 unused padding bits (at least significant end). */
kCVPixelFormatType_422YpCbCr8 = '2vuy', /* Component Y'CbCr 8-bit 4:2:2, ordered Cb Y'0 Cr Y'1 */
kCVPixelFormatType_4444YpCbCrA8 = 'v408', /* Component Y'CbCrA 8-bit 4:4:4:4, ordered Cb Y' Cr A */
kCVPixelFormatType_4444YpCbCrA8R = 'r408', /* Component Y'CbCrA 8-bit 4:4:4:4, rendering format. full range alpha, zero biased YUV, ordered A Y' Cb Cr */
kCVPixelFormatType_4444AYpCbCr8 = 'y408', /* Component Y'CbCrA 8-bit 4:4:4:4, ordered A Y' Cb Cr, full range alpha, video range Y'CbCr. */
kCVPixelFormatType_4444AYpCbCr16 = 'y416', /* Component Y'CbCrA 16-bit 4:4:4:4, ordered A Y' Cb Cr, full range alpha, video range Y'CbCr, 16-bit little-endian samples. */
kCVPixelFormatType_444YpCbCr8 = 'v308', /* Component Y'CbCr 8-bit 4:4:4 */
kCVPixelFormatType_422YpCbCr16 = 'v216', /* Component Y'CbCr 10,12,14,16-bit 4:2:2 */
kCVPixelFormatType_422YpCbCr10 = 'v210', /* Component Y'CbCr 10-bit 4:2:2 */
kCVPixelFormatType_444YpCbCr10 = 'v410', /* Component Y'CbCr 10-bit 4:4:4 */
kCVPixelFormatType_420YpCbCr8Planar = 'y420', /* Planar Component Y'CbCr 8-bit 4:2:0. baseAddr points to a big-endian CVPlanarPixelBufferInfo_YCbCrPlanar struct */
kCVPixelFormatType_420YpCbCr8PlanarFullRange = 'f420', /* Planar Component Y'CbCr 8-bit 4:2:0, full range. baseAddr points to a big-endian CVPlanarPixelBufferInfo_YCbCrPlanar struct */
kCVPixelFormatType_422YpCbCr_4A_8BiPlanar = 'a2vy', /* First plane: Video-range Component Y'CbCr 8-bit 4:2:2, ordered Cb Y'0 Cr Y'1; second plane: alpha 8-bit 0-255 */
kCVPixelFormatType_420YpCbCr8BiPlanarVideoRange = '420v', /* Bi-Planar Component Y'CbCr 8-bit 4:2:0, video-range (luma=[16,235] chroma=[16,240]). baseAddr points to a big-endian CVPlanarPixelBufferInfo_YCbCrBiPlanar struct */
kCVPixelFormatType_420YpCbCr8BiPlanarFullRange = '420f', /* Bi-Planar Component Y'CbCr 8-bit 4:2:0, full-range (luma=[0,255] chroma=[1,255]). baseAddr points to a big-endian CVPlanarPixelBufferInfo_YCbCrBiPlanar struct */
kCVPixelFormatType_422YpCbCr8BiPlanarVideoRange = '422v', /* Bi-Planar Component Y'CbCr 8-bit 4:2:2, video-range (luma=[16,235] chroma=[16,240]). baseAddr points to a big-endian CVPlanarPixelBufferInfo_YCbCrBiPlanar struct */
kCVPixelFormatType_422YpCbCr8BiPlanarFullRange = '422f', /* Bi-Planar Component Y'CbCr 8-bit 4:2:2, full-range (luma=[0,255] chroma=[1,255]). baseAddr points to a big-endian CVPlanarPixelBufferInfo_YCbCrBiPlanar struct */
kCVPixelFormatType_444YpCbCr8BiPlanarVideoRange = '444v', /* Bi-Planar Component Y'CbCr 8-bit 4:4:4, video-range (luma=[16,235] chroma=[16,240]). baseAddr points to a big-endian CVPlanarPixelBufferInfo_YCbCrBiPlanar struct */
kCVPixelFormatType_444YpCbCr8BiPlanarFullRange = '444f', /* Bi-Planar Component Y'CbCr 8-bit 4:4:4, full-range (luma=[0,255] chroma=[1,255]). baseAddr points to a big-endian CVPlanarPixelBufferInfo_YCbCrBiPlanar struct */
kCVPixelFormatType_422YpCbCr8_yuvs = 'yuvs', /* Component Y'CbCr 8-bit 4:2:2, ordered Y'0 Cb Y'1 Cr */
kCVPixelFormatType_422YpCbCr8FullRange = 'yuvf', /* Component Y'CbCr 8-bit 4:2:2, full range, ordered Y'0 Cb Y'1 Cr */
kCVPixelFormatType_OneComponent8 = 'L008', /* 8 bit one component, black is zero */
kCVPixelFormatType_TwoComponent8 = '2C08', /* 8 bit two component, black is zero */
kCVPixelFormatType_30RGBLEPackedWideGamut = 'w30r', /* little-endian RGB101010, 2 MSB are zero, wide-gamut (384-895) */
kCVPixelFormatType_ARGB2101010LEPacked = 'l10r', /* little-endian ARGB2101010 full-range ARGB */
kCVPixelFormatType_40ARGBLEWideGamut = 'w40a', /* little-endian ARGB10101010, each 10 bits in the MSBs of 16bits, wide-gamut (384-895, including alpha) */
kCVPixelFormatType_40ARGBLEWideGamutPremultiplied = 'w40m', /* little-endian ARGB10101010, each 10 bits in the MSBs of 16bits, wide-gamut (384-895, including alpha). Alpha premultiplied */
kCVPixelFormatType_OneComponent10 = 'L010', /* 10 bit little-endian one component, stored as 10 MSBs of 16 bits, black is zero */
kCVPixelFormatType_OneComponent12 = 'L012', /* 12 bit little-endian one component, stored as 12 MSBs of 16 bits, black is zero */
kCVPixelFormatType_OneComponent16 = 'L016', /* 16 bit little-endian one component, black is zero */
kCVPixelFormatType_TwoComponent16 = '2C16', /* 16 bit little-endian two component, black is zero */
kCVPixelFormatType_OneComponent16Half = 'L00h', /* 16 bit one component IEEE half-precision float, 16-bit little-endian samples */
kCVPixelFormatType_OneComponent32Float = 'L00f', /* 32 bit one component IEEE float, 32-bit little-endian samples */
kCVPixelFormatType_TwoComponent16Half = '2C0h', /* 16 bit two component IEEE half-precision float, 16-bit little-endian samples */
kCVPixelFormatType_TwoComponent32Float = '2C0f', /* 32 bit two component IEEE float, 32-bit little-endian samples */
kCVPixelFormatType_64RGBAHalf = 'RGhA', /* 64 bit RGBA IEEE half-precision float, 16-bit little-endian samples */
kCVPixelFormatType_128RGBAFloat = 'RGfA', /* 128 bit RGBA IEEE float, 32-bit little-endian samples */
kCVPixelFormatType_14Bayer_GRBG = 'grb4', /* Bayer 14-bit Little-Endian, packed in 16-bits, ordered G R G R... alternating with B G B G... */
kCVPixelFormatType_14Bayer_RGGB = 'rgg4', /* Bayer 14-bit Little-Endian, packed in 16-bits, ordered R G R G... alternating with G B G B... */
kCVPixelFormatType_14Bayer_BGGR = 'bgg4', /* Bayer 14-bit Little-Endian, packed in 16-bits, ordered B G B G... alternating with G R G R... */
kCVPixelFormatType_14Bayer_GBRG = 'gbr4', /* Bayer 14-bit Little-Endian, packed in 16-bits, ordered G B G B... alternating with R G R G... */
kCVPixelFormatType_DisparityFloat16 = 'hdis', /* IEEE754-2008 binary16 (half float), describing the normalized shift when comparing two images. Units are 1/meters: ( pixelShift / (pixelFocalLength * baselineInMeters) ) */
kCVPixelFormatType_DisparityFloat32 = 'fdis', /* IEEE754-2008 binary32 float, describing the normalized shift when comparing two images. Units are 1/meters: ( pixelShift / (pixelFocalLength * baselineInMeters) ) */
kCVPixelFormatType_DepthFloat16 = 'hdep', /* IEEE754-2008 binary16 (half float), describing the depth (distance to an object) in meters */
kCVPixelFormatType_DepthFloat32 = 'fdep', /* IEEE754-2008 binary32 float, describing the depth (distance to an object) in meters */
kCVPixelFormatType_420YpCbCr10BiPlanarVideoRange = 'x420', /* 2 plane YCbCr10 4:2:0, each 10 bits in the MSBs of 16bits, video-range (luma=[64,940] chroma=[64,960]) */
kCVPixelFormatType_422YpCbCr10BiPlanarVideoRange = 'x422', /* 2 plane YCbCr10 4:2:2, each 10 bits in the MSBs of 16bits, video-range (luma=[64,940] chroma=[64,960]) */
kCVPixelFormatType_444YpCbCr10BiPlanarVideoRange = 'x444', /* 2 plane YCbCr10 4:4:4, each 10 bits in the MSBs of 16bits, video-range (luma=[64,940] chroma=[64,960]) */
kCVPixelFormatType_420YpCbCr10BiPlanarFullRange = 'xf20', /* 2 plane YCbCr10 4:2:0, each 10 bits in the MSBs of 16bits, full-range (Y range 0-1023) */
kCVPixelFormatType_422YpCbCr10BiPlanarFullRange = 'xf22', /* 2 plane YCbCr10 4:2:2, each 10 bits in the MSBs of 16bits, full-range (Y range 0-1023) */
kCVPixelFormatType_444YpCbCr10BiPlanarFullRange = 'xf44', /* 2 plane YCbCr10 4:4:4, each 10 bits in the MSBs of 16bits, full-range (Y range 0-1023) */
kCVPixelFormatType_420YpCbCr8VideoRange_8A_TriPlanar = 'v0a8', /* first and second planes as per 420YpCbCr8BiPlanarVideoRange (420v), alpha 8 bits in third plane full-range. No CVPlanarPixelBufferInfo struct. */
kCVPixelFormatType_16VersatileBayer = 'bp16', /* Single plane Bayer 16-bit little-endian sensor element ("sensel") samples from full-size decoding of ProRes RAW images; Bayer pattern (sensel ordering) and other raw conversion information is described via buffer attachments */
kCVPixelFormatType_64RGBA_DownscaledProResRAW = 'bp64', /* Single plane 64-bit RGBA (16-bit little-endian samples) from downscaled decoding of ProRes RAW images; components--which may not be co-sited with one another--are sensel values and require raw conversion, information for which is described via buffer attachments */
kCVPixelFormatType_422YpCbCr16BiPlanarVideoRange = 'sv22', /* 2 plane YCbCr16 4:2:2, video-range (luma=[4096,60160] chroma=[4096,61440]) */
kCVPixelFormatType_444YpCbCr16BiPlanarVideoRange = 'sv44', /* 2 plane YCbCr16 4:4:4, video-range (luma=[4096,60160] chroma=[4096,61440]) */
kCVPixelFormatType_444YpCbCr16VideoRange_16A_TriPlanar = 's4as', /* 3 plane video-range YCbCr16 4:4:4 with 16-bit full-range alpha (luma=[4096,60160] chroma=[4096,61440] alpha=[0,65535]). No CVPlanarPixelBufferInfo struct. */
};
/*
Lossless-Compressed Pixel Formats
The following pixel formats can be used to reduce the memory bandwidth involved in large-scale pixel data flow, which can have benefits for battery life and thermal efficiency.
They work by dividing pixel buffers into fixed-width, fixed-height, fixed-byte-size blocks. Hardware units (video codecs, GPU, ISP, etc.) attempt to write a compressed encoding for each block using a lossless algorithm. If a block of pixels is successfully encoded using fewer bytes than the uncompressed pixel data, the hardware unit does not need to write as many bytes for that pixel block. If the encoding is unsuccessful, the uncompressed pixel data is written, filling the whole pixel block. Each compressed pixel buffer has a separate area of metadata recording the encoding choices for each pixel block.
Padding bits are eliminated, so for example, 10-bit-per-component lossless-compressed pixel buffers are slightly smaller than their uncompressed equivalents. For pixel formats with no padding, the lossless-compressed pixel buffers are slightly larger due to the metadata.
IMPORTANT CAVEATS:
Some devices do not support these pixel formats at all.
Before using one of these pixel formats, call CVIsCompressedPixelFormatAvailable() to check that it is available on the current device.
On different devices, the concrete details of these formats may be different.
On different devices, the degree and details of support by hardware units (video codecs, GPU, ISP, etc.) may be different.
Do not ship code that reads the contents of lossless-compressed pixel buffers directly with the CPU, or which saves or transfers it to other devices, as this code will break with future hardware.
The bandwidth benefits of these formats are generally outweighed by the cost of buffer copies to convert to uncompressed pixel formats, so if you find that you need to perform a buffer copy to covert for CPU usage, it's likely that you would have been better served by using the equivalent uncompressed pixel formats in the first place.
*/
#if COREVIDEO_USE_DERIVED_ENUMS_FOR_CONSTANTS
enum : OSType
#else
enum
#endif
{
kCVPixelFormatType_Lossless_32BGRA = '&BGA', /* Lossless-compressed form of kCVPixelFormatType_32BGRA. */
// Lossless-compressed Bi-planar YCbCr pixel format types
kCVPixelFormatType_Lossless_420YpCbCr8BiPlanarVideoRange = '&8v0', /* Lossless-compressed form of kCVPixelFormatType_420YpCbCr8BiPlanarVideoRange. No CVPlanarPixelBufferInfo struct. */
kCVPixelFormatType_Lossless_420YpCbCr8BiPlanarFullRange = '&8f0', /* Lossless-compressed form of kCVPixelFormatType_420YpCbCr8BiPlanarFullRange. No CVPlanarPixelBufferInfo struct. */
kCVPixelFormatType_Lossless_420YpCbCr10PackedBiPlanarVideoRange = '&xv0', /* Lossless-compressed-packed form of kCVPixelFormatType_420YpCbCr10BiPlanarVideoRange. No CVPlanarPixelBufferInfo struct. Format is compressed-packed with no padding bits between pixels. */
kCVPixelFormatType_Lossless_422YpCbCr10PackedBiPlanarVideoRange = '&xv2', /* Lossless-compressed form of kCVPixelFormatType_422YpCbCr10BiPlanarVideoRange. No CVPlanarPixelBufferInfo struct. Format is compressed-packed with no padding bits between pixels. */
};
/*
Lossy-Compressed Pixel Formats
The following pixel formats can be used to reduce memory bandwidth and memory footprint involved in large-scale pixel data flow, which can have benefits for battery life and thermal efficiency.
Similar to lossless pixel formats, they work by dividing pixel buffers into fixed-width, fixed-height, fixed-byte-size blocks. Pixel buffers allocated using lossy formats have reduced memory footprint than their lossless equivalents; this reduced footprint may or may not result in loss of quality depending on the content of the individual block. Hardware units (video codecs, GPU, ISP, etc.) attempt to write a compressed encoding for each block using either a lossless or lossy algorithm. If a block of pixels is successfully encoded within its pre-defined memory footprint, then the lossless alogrithm is applied; if the encoded block of pixels exceeds the pre-defined memory footprint then the lossy algorithm is applied. Each compressed pixel buffer has a separate area of metadata recording the encoding choices for each pixel block.
IMPORTANT CAVEATS:
Some devices do not support these pixel formats at all.
Before using one of these pixel formats, call CVIsCompressedPixelFormatAvailable() to check that it is available on the current device.
On different devices, the concrete details of these formats may be different.
On different devices, the degree and details of support by hardware units (video codecs, GPU, ISP, etc.) may be different.
Do not ship code that reads the contents of lossless-compressed pixel buffers directly with the CPU, or which saves or transfers it to other devices, as this code will break with future hardware.
The bandwidth benefits of these formats are generally outweighed by the cost of buffer copies to convert to uncompressed pixel formats, so if you find that you need to perform a buffer copy to covert for CPU usage, it's likely that you would have been better served by using the equivalent uncompressed pixel formats in the first place.
*/
#if COREVIDEO_USE_DERIVED_ENUMS_FOR_CONSTANTS
enum : OSType
#else
enum
#endif
{
kCVPixelFormatType_Lossy_32BGRA = '-BGA', /* Lossy-compressed form of kCVPixelFormatType_32BGRA. No CVPlanarPixelBufferInfo struct. */
kCVPixelFormatType_Lossy_420YpCbCr8BiPlanarVideoRange = '-8v0', /* Lossy-compressed form of kCVPixelFormatType_420YpCbCr8BiPlanarVideoRange. No CVPlanarPixelBufferInfo struct. */
kCVPixelFormatType_Lossy_420YpCbCr8BiPlanarFullRange = '-8f0', /* Lossy-compressed form of kCVPixelFormatType_420YpCbCr8BiPlanarFullRange. No CVPlanarPixelBufferInfo struct. */
kCVPixelFormatType_Lossy_420YpCbCr10PackedBiPlanarVideoRange = '-xv0', /* Lossy-compressed form of kCVPixelFormatType_420YpCbCr10BiPlanarVideoRange. No CVPlanarPixelBufferInfo struct. Format is compressed-packed with no padding bits between pixels. */
kCVPixelFormatType_Lossy_422YpCbCr10PackedBiPlanarVideoRange = '-xv2', /* Lossy-compressed form of kCVPixelFormatType_422YpCbCr10BiPlanarVideoRange. No CVPlanarPixelBufferInfo struct. Format is compressed-packed with no padding bits between pixels. */
};
/*!
@enum Pixel Buffer Locking Flags
@discussion Flags to pass to CVPixelBufferLockBaseAddress() / CVPixelBufferUnlockBaseAddress()
@constant kCVPixelBufferLock_ReadOnly
If you are not going to modify the data while you hold the lock, you should set this flag
to avoid potentially invalidating any existing caches of the buffer contents. This flag
should be passed both to the lock and unlock functions. Non-symmetrical usage of this
flag will result in undefined behavior.
*/
typedef CF_OPTIONS(CVOptionFlags, CVPixelBufferLockFlags)
{
kCVPixelBufferLock_ReadOnly = 0x00000001,
};
/*
Planar pixel buffers have the following descriptor at their base address.
Clients should generally use CVPixelBufferGetBaseAddressOfPlane,
CVPixelBufferGetBytesPerRowOfPlane, etc. instead of accessing it directly.
*/
struct CVPlanarComponentInfo {
int32_t offset; /* offset from main base address to base address of this plane, big-endian */
uint32_t rowBytes; /* bytes per row of this plane, big-endian */
};
typedef struct CVPlanarComponentInfo CVPlanarComponentInfo;
struct CVPlanarPixelBufferInfo {
CVPlanarComponentInfo componentInfo[1];
};
typedef struct CVPlanarPixelBufferInfo CVPlanarPixelBufferInfo;
struct CVPlanarPixelBufferInfo_YCbCrPlanar {
CVPlanarComponentInfo componentInfoY;
CVPlanarComponentInfo componentInfoCb;
CVPlanarComponentInfo componentInfoCr;
};
typedef struct CVPlanarPixelBufferInfo_YCbCrPlanar CVPlanarPixelBufferInfo_YCbCrPlanar;
struct CVPlanarPixelBufferInfo_YCbCrBiPlanar {
CVPlanarComponentInfo componentInfoY;
CVPlanarComponentInfo componentInfoCbCr;
};
typedef struct CVPlanarPixelBufferInfo_YCbCrBiPlanar CVPlanarPixelBufferInfo_YCbCrBiPlanar;
#pragma mark BufferAttributeKeys
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelBufferPixelFormatTypeKey API_AVAILABLE(macosx(10.4), ios(4.0), tvos(9.0), watchos(4.0)); // A single CFNumber or a CFArray of CFNumbers (OSTypes)
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelBufferMemoryAllocatorKey API_AVAILABLE(macosx(10.4), ios(4.0), tvos(9.0), watchos(4.0)); // CFAllocatorRef
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelBufferWidthKey API_AVAILABLE(macosx(10.4), ios(4.0), tvos(9.0), watchos(4.0)); // CFNumber
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelBufferHeightKey API_AVAILABLE(macosx(10.4), ios(4.0), tvos(9.0), watchos(4.0)); // CFNumber
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelBufferExtendedPixelsLeftKey API_AVAILABLE(macosx(10.4), ios(4.0), tvos(9.0), watchos(4.0)); // CFNumber
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelBufferExtendedPixelsTopKey API_AVAILABLE(macosx(10.4), ios(4.0), tvos(9.0), watchos(4.0)); // CFNumber
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelBufferExtendedPixelsRightKey API_AVAILABLE(macosx(10.4), ios(4.0), tvos(9.0), watchos(4.0)); // CFNumber
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelBufferExtendedPixelsBottomKey API_AVAILABLE(macosx(10.4), ios(4.0), tvos(9.0), watchos(4.0)); // CFNumber
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelBufferBytesPerRowAlignmentKey API_AVAILABLE(macosx(10.4), ios(4.0), tvos(9.0), watchos(4.0)); // CFNumber
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelBufferCGBitmapContextCompatibilityKey API_AVAILABLE(macosx(10.4), ios(4.0), tvos(9.0), watchos(4.0)); // CFBoolean
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelBufferCGImageCompatibilityKey API_AVAILABLE(macosx(10.4), ios(4.0), tvos(9.0), watchos(4.0)); // CFBoolean
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelBufferOpenGLCompatibilityKey API_AVAILABLE(macosx(10.4), ios(4.0), tvos(9.0), watchos(4.0)); // CFBoolean
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelBufferPlaneAlignmentKey API_AVAILABLE(macosx(10.6), ios(4.0), tvos(9.0), watchos(4.0)); // CFNumber
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelBufferIOSurfacePropertiesKey API_AVAILABLE(macosx(10.6), ios(4.0), tvos(9.0), watchos(4.0)); // CFDictionary; presence requests buffer allocation via IOSurface
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelBufferOpenGLESCompatibilityKey API_AVAILABLE(ios(6.0), tvos(9.0)) API_UNAVAILABLE(macosx) API_UNAVAILABLE(macCatalyst) __WATCHOS_PROHIBITED; // CFBoolean
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelBufferMetalCompatibilityKey API_AVAILABLE(macosx(10.11), ios(8.0), tvos(9.0), watchos(4.0)); // CFBoolean
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelBufferOpenGLTextureCacheCompatibilityKey API_AVAILABLE(macosx(10.11)) API_UNAVAILABLE(ios, tvos, watchos);
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelBufferOpenGLESTextureCacheCompatibilityKey API_AVAILABLE(ios(9.0), tvos(9.0)) API_UNAVAILABLE(macosx) API_UNAVAILABLE(macCatalyst) __WATCHOS_PROHIBITED;
/*!
@const kCVPixelBufferVersatileBayerKey_BayerPattern
@abstract Buffer attachment key for code indicating Bayer pattern (sensel arrangement).
@discussion Associated attachment is a CFNumber of type kCFNumberSInt32Type. The value follows the semantics of the ProRes RAW bayer_pattern bitstream syntax element, namely 0, 1, 2, or 3, where 0 means the top-left sensel of the frame is red-filtered ("RGGB"); 1 means the top-left sensel of the frame is green-filtered, with the top row alternating between green- and red-filtered sensels ("GRBG"); 2 means the top-left sensel of the frame is green- filtered, with the top row alternating between green- and blue-filtered sensels ("GBRG"); and 3 means the top-left sensel of the frame is blue-filtered ("BGGR"). This attachment applies only to buffers with VersatileBayer formats.
*/
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelBufferVersatileBayerKey_BayerPattern API_AVAILABLE(ios(14.0), macosx(11.0)) __TVOS_PROHIBITED __WATCHOS_PROHIBITED;
enum {
kCVVersatileBayer_BayerPattern_RGGB = 0,
kCVVersatileBayer_BayerPattern_GRBG = 1,
kCVVersatileBayer_BayerPattern_GBRG = 2,
kCVVersatileBayer_BayerPattern_BGGR = 3,
};
/*!
@const kCVPixelBufferProResRAWKey_SenselSitingOffsets
@abstract Buffer attachment key for siting offsets, relative to pixel center, of individual sensels/components constituting each pixel.
@discussion Associated attachment is CFData containing an array of 8 32-bit floats. The eight CFData array elements specify, in order, the following sensel/component offsets from pixel center: red horizontal offset, red vertical offset, green horizontal offset, green vertical offset, blue horizontal offset, blue vertical offset, alpha horizontal offset, and alpha vertical offset. A positive offset value indicates that the sensel/component lies to the right of or below the center of its pixel, while a negative value indicates that the sensel/component lies to the left of or above the center of its pixel. Horizontal and vertical offset magnitudes are respectively in terms of the spacing between horizontally- and vertically-adjacent pixel centers. This attachment applies only to buffers with the bp64 format, and is optional for those buffers; if not present, all offsets are considered to be 0.
*/
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelBufferProResRAWKey_SenselSitingOffsets API_AVAILABLE(ios(14.0), macosx(11.0)) __TVOS_PROHIBITED __WATCHOS_PROHIBITED;
/*!
@const kCVPixelBufferProResRAWKey_BlackLevel
@abstract Buffer attachment key for sensel black level.
@discussion Associated attachment is a CFNumber of type kCFNumberSInt32Type. The value is the sensel level corresponding to no light exposure. This attachment is required for buffers with either the bp16 or bp64 format.
*/
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelBufferProResRAWKey_BlackLevel API_AVAILABLE(ios(14.0), macosx(11.0)) __TVOS_PROHIBITED __WATCHOS_PROHIBITED;
/*!
@const kCVPixelBufferProResRAWKey_WhiteLevel
@abstract Buffer attachment key for sensel white level.
@discussion Associated attachment is a CFNumber of type kCFNumberSInt32Type. The value is the sensel level corresponding to sensor (or camera A-to-D converter) saturation. This attachment is required for buffers with either the bp16 or bp64 format.
*/
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelBufferProResRAWKey_WhiteLevel API_AVAILABLE(ios(14.0), macosx(11.0)) __TVOS_PROHIBITED __WATCHOS_PROHIBITED;
/*!
@const kCVPixelBufferProResRAWKey_WhiteBalanceCCT
@abstract Buffer attachment key for illuminant correlated color temperature.
@discussion Associated attachment is a CFNumber of type kCFNumberSInt32Type. The value is the illuminant correlated color temperature (CCT), in kelvins, selected at the time of capture. May be 0, indicating that the CCT is unknown or unspecified. This attachment is optional for buffers with either the bp16 or bp64 format; if not present, the CCT is considered unknown or unspecified.
*/
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelBufferProResRAWKey_WhiteBalanceCCT API_AVAILABLE(ios(14.0), macosx(11.0)) __TVOS_PROHIBITED __WATCHOS_PROHIBITED;
/*!
@const kCVPixelBufferProResRAWKey_WhiteBalanceRedFactor
@abstract Buffer attachment key for white balance red factor.
@discussion Associated attachment is a CFNumber of type kCFNumberFloat32Type. The value is the white balance multiplication factor for red-filtered sensels. This attachment is required for buffers with either the bp16 or bp64 format.
*/
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelBufferProResRAWKey_WhiteBalanceRedFactor API_AVAILABLE(ios(14.0), macosx(11.0)) __TVOS_PROHIBITED __WATCHOS_PROHIBITED;
/*!
@const kCVPixelBufferProResRAWKey_WhiteBalanceBlueFactor
@abstract Buffer attachment key for white balance blue factor.
@discussion Associated attachment is a CFNumber of type kCFNumberFloat32Type. The value is the white balance multiplication factor for blue-filtered sensels. This attachment is required for buffers with either the bp16 or bp64 format.
*/
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelBufferProResRAWKey_WhiteBalanceBlueFactor API_AVAILABLE(ios(14.0), macosx(11.0)) __TVOS_PROHIBITED __WATCHOS_PROHIBITED;
/*!
@const kCVPixelBufferProResRAWKey_ColorMatrix
@abstract Buffer attachment key for color translation matrix.
@discussion Associated attachment is CFData containing an array of 9 32-bit floats. The value is a 3x3 matrix which transforms linear RGB pixel values in the camera native color space to CIE 1931 XYZ values relative to the D65 illuminant, where the matrix entries are stored in the CFData in row-major order. This attachment is required for buffers with either the bp16 or bp64 format.
*/
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelBufferProResRAWKey_ColorMatrix API_AVAILABLE(ios(14.0), macosx(11.0)) __TVOS_PROHIBITED __WATCHOS_PROHIBITED;
/*!
@const kCVPixelBufferProResRAWKey_GainFactor
@abstract Buffer attachment key for gain factor.
@discussion Associated attachment is a CFNumber of type kCFNumberFloat32Type. The value is the overall gain factor for raw conversion. This attachment is required for buffers with either the bp16 or bp64 format.
*/
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelBufferProResRAWKey_GainFactor API_AVAILABLE(ios(14.0), macosx(11.0)) __TVOS_PROHIBITED __WATCHOS_PROHIBITED;
/*!
@const kCVPixelBufferProResRAWKey_RecommendedCrop
@abstract Buffer attachment key for recommended number of pixels/rows to discard from the sides of the image after raw conversion.
@discussion Associated attachment is CFData containing an array of 4 32-bit floats. The four CFData array elements specify, in order, the recommended number of: pixels to discard from the start (left) of each row of the image; pixels to discard from the end (right) of each row of the image; rows of pixels to discard from the top of the image; and rows of pixels to discard from the bottom of the image. (Pixels/rows are discarded after raw conversion.) This attachment is optional for buffers with either the bp16 or bp64 format; if not present, the recommended crop values are considered to be 0. For buffers with the bp64 format, the values may be nonintegral due to downscaling, in which case the handling of fractional parts is implementation-dependent.
*/
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelBufferProResRAWKey_RecommendedCrop API_AVAILABLE(ios(14.0), macosx(11.0)) __TVOS_PROHIBITED __WATCHOS_PROHIBITED;
/*!
@const kCVPixelBufferProResRAWKey_MetadataExtension
@abstract Buffer attachment key for metadata extension.
@discussion Associated attachment is CFData containing ProRes RAW metadata extension. This attachment is optional for buffers with either bp16 or bp64. The CFData contains a big-endian uint32 representing the size of the item in bytes followed by a 4-character code ('psim') followed by a variable-length pascal string identifying the metadata (like a key string) followed by the metadata payload.
*/
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelBufferProResRAWKey_MetadataExtension API_AVAILABLE(ios(15.0), macosx(12.0)) __TVOS_PROHIBITED __WATCHOS_PROHIBITED;
/*!
@typedef CVPixelBufferRef
@abstract Based on the image buffer type. The pixel buffer implements the memory storage for an image buffer.
*/
typedef CVImageBufferRef CVPixelBufferRef;
CV_EXPORT CFTypeID CVPixelBufferGetTypeID(void) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/*!
@function CVPixelBufferRetain
@abstract Retains a CVPixelBuffer object
@discussion Equivalent to CFRetain, but NULL safe
@param buffer A CVPixelBuffer object that you want to retain.
@result A CVPixelBuffer object that is the same as the passed in buffer.
*/
CV_EXPORT CVPixelBufferRef CV_NULLABLE CVPixelBufferRetain( CVPixelBufferRef CV_NULLABLE texture ) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/*!
@function CVPixelBufferRelease
@abstract Releases a CVPixelBuffer object
@discussion Equivalent to CFRelease, but NULL safe
@param buffer A CVPixelBuffer object that you want to release.
*/
CV_EXPORT void CVPixelBufferRelease( CV_RELEASES_ARGUMENT CVPixelBufferRef CV_NULLABLE texture ) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/*!
@function CVPixelBufferCreateResolvedAttributesDictionary
@abstract Takes a CFArray of CFDictionary objects describing various pixel buffer attributes and tries to resolve them into a
single dictionary.
@discussion This is useful when you need to resolve multiple requirements between different potential clients of a buffer.
@param attributes CFArray of CFDictionaries containing kCVPixelBuffer key/value pairs.
@param resolvedDictionaryOut The resulting dictionary will be placed here.
@result Return value that may be useful in discovering why resolution failed.
*/
CV_EXPORT CVReturn CVPixelBufferCreateResolvedAttributesDictionary(
CFAllocatorRef CV_NULLABLE allocator,
CFArrayRef CV_NULLABLE attributes,
CV_RETURNS_RETAINED_PARAMETER CFDictionaryRef CV_NULLABLE * CV_NONNULL resolvedDictionaryOut) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/*!
@function CVPixelBufferCreate
@abstract Call to create a single PixelBuffer for a given size and pixelFormatType.
@discussion Creates a single PixelBuffer for a given size and pixelFormatType. It allocates the necessary memory based on the pixel dimensions, pixelFormatType and extended pixels described in the pixelBufferAttributes. Not all parameters of the pixelBufferAttributes will be used here.
@param width Width of the PixelBuffer in pixels.
@param height Height of the PixelBuffer in pixels.
@param pixelFormatType Pixel format indentified by its respective OSType.
@param pixelBufferAttributes A dictionary with additional attributes for a pixel buffer. This parameter is optional. See BufferAttributeKeys for more details.
@param pixelBufferOut The new pixel buffer will be returned here
@result returns kCVReturnSuccess on success.
*/
CV_EXPORT CVReturn CVPixelBufferCreate(
CFAllocatorRef CV_NULLABLE allocator,
size_t width,
size_t height,
OSType pixelFormatType,
CFDictionaryRef CV_NULLABLE pixelBufferAttributes,
CV_RETURNS_RETAINED_PARAMETER CVPixelBufferRef CV_NULLABLE * CV_NONNULL pixelBufferOut) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
typedef void (*CVPixelBufferReleaseBytesCallback)( void * CV_NULLABLE releaseRefCon, const void * CV_NULLABLE baseAddress );
/*!
@function CVPixelBufferCreateWithBytes
@abstract Call to create a single PixelBuffer for a given size and pixelFormatType based on a passed in piece of memory.
@discussion Creates a single PixelBuffer for a given size and pixelFormatType. Not all parameters of the pixelBufferAttributes will be used here. It requires a release callback function that will be called, when the PixelBuffer gets destroyed so that the owner of the pixels can free the memory.
@param width Width of the PixelBuffer in pixels
@param height Height of the PixelBuffer in pixels
@param pixelFormatType Pixel format indentified by its respective OSType.
@param baseAddress Address of the memory storing the pixels.
@param bytesPerRow Row bytes of the pixel storage memory.
@param releaseCallback CVPixelBufferReleaseBytePointerCallback function that gets called when the PixelBuffer gets destroyed.
@param releaseRefCon User data identifying the PixelBuffer for the release callback.
@param pixelBufferAttributes A dictionary with additional attributes for a a pixel buffer. This parameter is optional. See PixelBufferAttributes for more details.
@param pixelBufferOut The new pixel buffer will be returned here
@result returns kCVReturnSuccess on success.
*/
CV_EXPORT CVReturn CVPixelBufferCreateWithBytes(
CFAllocatorRef CV_NULLABLE allocator,
size_t width,
size_t height,
OSType pixelFormatType,
void * CV_NONNULL baseAddress,
size_t bytesPerRow,
CVPixelBufferReleaseBytesCallback CV_NULLABLE releaseCallback,
void * CV_NULLABLE releaseRefCon,
CFDictionaryRef CV_NULLABLE pixelBufferAttributes,
CV_RETURNS_RETAINED_PARAMETER CVPixelBufferRef CV_NULLABLE * CV_NONNULL pixelBufferOut) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
typedef void (*CVPixelBufferReleasePlanarBytesCallback)( void * CV_NULLABLE releaseRefCon, const void * CV_NULLABLE dataPtr, size_t dataSize, size_t numberOfPlanes, const void * CV_NULLABLE planeAddresses[CV_NULLABLE ] );
/*!
@function CVPixelBufferCreateWithPlanarBytes
@abstract Call to create a single PixelBuffer in planar format for a given size and pixelFormatType based on a passed in piece of memory.
@discussion Creates a single PixelBuffer for a given size and pixelFormatType. Not all parameters of the pixelBufferAttributes will be used here. It requires a release callback function that will be called, when the PixelBuffer gets destroyed so that the owner of the pixels can free the memory.
@param width Width of the PixelBuffer in pixels
@param height Height of the PixelBuffer in pixels
@param pixelFormatType Pixel format indentified by its respective OSType.
@param dataPtr Pass a pointer to a plane descriptor block, or NULL.
@param dataSize pass size if planes are contiguous, NULL if not.
@param numberOfPlanes Number of planes.
@param planeBaseAddress Array of base addresses for the planes.
@param planeWidth Array of plane widths.
@param planeHeight Array of plane heights.
@param planeBytesPerRow Array of plane bytesPerRow values.
@param releaseCallback CVPixelBufferReleaseBytePointerCallback function that gets called when the PixelBuffer gets destroyed.
@param releaseRefCon User data identifying the PixelBuffer for the release callback.
@param pixelBufferAttributes A dictionary with additional attributes for a a pixel buffer. This parameter is optional. See PixelBufferAttributes for more details.
@param pixelBufferOut The new pixel buffer will be returned here
@result returns kCVReturnSuccess on success.
*/
CV_EXPORT CVReturn CVPixelBufferCreateWithPlanarBytes(
CFAllocatorRef CV_NULLABLE allocator,
size_t width,
size_t height,
OSType pixelFormatType,
void * CV_NULLABLE dataPtr, // pass a pointer to a plane descriptor block, or NULL
size_t dataSize, // pass size if planes are contiguous, NULL if not
size_t numberOfPlanes,
void * CV_NULLABLE planeBaseAddress[CV_NONNULL ],
size_t planeWidth[CV_NONNULL ],
size_t planeHeight[CV_NONNULL ],
size_t planeBytesPerRow[CV_NONNULL ],
CVPixelBufferReleasePlanarBytesCallback CV_NULLABLE releaseCallback,
void * CV_NULLABLE releaseRefCon,
CFDictionaryRef CV_NULLABLE pixelBufferAttributes,
CV_RETURNS_RETAINED_PARAMETER CVPixelBufferRef CV_NULLABLE * CV_NONNULL pixelBufferOut) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/*!
@function CVPixelBufferLockBaseAddress
@abstract Description Locks the BaseAddress of the PixelBuffer to ensure that the memory is accessible.
@discussion This API ensures that the CVPixelBuffer is accessible in system memory. This should only be called if the base address is going to be used and the pixel data will be accessed by the CPU.
@param pixelBuffer Target PixelBuffer.
@param lockFlags See CVPixelBufferLockFlags.
@result kCVReturnSuccess if the lock succeeded, or error code on failure
*/
CV_EXPORT CVReturn CVPixelBufferLockBaseAddress( CVPixelBufferRef CV_NONNULL pixelBuffer, CVPixelBufferLockFlags lockFlags ) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/*!
@function CVPixelBufferUnlockBaseAddress
@abstract Description Unlocks the BaseAddress of the PixelBuffer.
@param pixelBuffer Target PixelBuffer.
@param unlockFlags See CVPixelBufferLockFlags.
@result kCVReturnSuccess if the unlock succeeded, or error code on failure
*/
CV_EXPORT CVReturn CVPixelBufferUnlockBaseAddress( CVPixelBufferRef CV_NONNULL pixelBuffer, CVPixelBufferLockFlags unlockFlags ) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/*!
@function CVPixelBufferGetWidth
@abstract Returns the width of the PixelBuffer.
@param pixelBuffer Target PixelBuffer.
@result Width in pixels.
*/
CV_EXPORT size_t CVPixelBufferGetWidth( CVPixelBufferRef CV_NONNULL pixelBuffer ) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/*!
@function CVPixelBufferGetHeight
@abstract Returns the height of the PixelBuffer.
@param pixelBuffer Target PixelBuffer.
@result Height in pixels.
*/
CV_EXPORT size_t CVPixelBufferGetHeight( CVPixelBufferRef CV_NONNULL pixelBuffer ) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/*!
@function CVPixelBufferGetPixelFormatType
@abstract Returns the PixelFormatType of the PixelBuffer.
@param pixelBuffer Target PixelBuffer.
@result OSType identifying the pixel format by its type.
*/
CV_EXPORT OSType CVPixelBufferGetPixelFormatType( CVPixelBufferRef CV_NONNULL pixelBuffer ) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/*!
@function CVPixelBufferGetBaseAddress
@abstract Returns the base address of the PixelBuffer.
@discussion Retrieving the base address for a PixelBuffer requires that the buffer base address be locked
via a successful call to CVPixelBufferLockBaseAddress.
@param pixelBuffer Target PixelBuffer.
@result Base address of the pixels.
For chunky buffers, this will return a pointer to the pixel at 0,0 in the buffer
For planar buffers this will return a pointer to a PlanarComponentInfo struct (defined in QuickTime).
*/
CV_EXPORT void * CV_NULLABLE CVPixelBufferGetBaseAddress( CVPixelBufferRef CV_NONNULL pixelBuffer ) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/*!
@function CVPixelBufferGetBytesPerRow
@abstract Returns the rowBytes of the PixelBuffer.
@param pixelBuffer Target PixelBuffer.
@result Bytes per row of the image data. For planar buffers this will return a rowBytes value such that bytesPerRow * height
will cover the entire image including all planes.
*/
CV_EXPORT size_t CVPixelBufferGetBytesPerRow( CVPixelBufferRef CV_NONNULL pixelBuffer ) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/*!
@function CVPixelBufferGetDataSize
@abstract Returns the data size for contigous planes of the PixelBuffer.
@param pixelBuffer Target PixelBuffer.
@result Data size used in CVPixelBufferCreateWithPlanarBytes.
*/
CV_EXPORT size_t CVPixelBufferGetDataSize( CVPixelBufferRef CV_NONNULL pixelBuffer ) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/*!
@function CVPixelBufferIsPlanar
@abstract Returns if the PixelBuffer is planar.
@param pixelBuffer Target PixelBuffer.
@result True if the PixelBuffer was created using CVPixelBufferCreateWithPlanarBytes.
*/
CV_EXPORT Boolean CVPixelBufferIsPlanar( CVPixelBufferRef CV_NONNULL pixelBuffer ) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/*!
@function CVPixelBufferGetPlaneCount
@abstract Returns number of planes of the PixelBuffer.
@param pixelBuffer Target PixelBuffer.
@result Number of planes. Returns 0 for non-planar CVPixelBufferRefs.
*/
CV_EXPORT size_t CVPixelBufferGetPlaneCount( CVPixelBufferRef CV_NONNULL pixelBuffer ) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/*!
@function CVPixelBufferGetWidthOfPlane
@abstract Returns the width of the plane at planeIndex in the PixelBuffer.
@discussion On OSX 10.10 and earlier, or iOS 8 and earlier, calling this
function with a non-planar buffer will have undefined behavior.
@param pixelBuffer Target PixelBuffer.
@param planeIndex Identifying the plane.
@result Width in pixels, or 0 for non-planar CVPixelBufferRefs.
*/
CV_EXPORT size_t CVPixelBufferGetWidthOfPlane( CVPixelBufferRef CV_NONNULL pixelBuffer, size_t planeIndex ) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/*!
@function CVPixelBufferGetHeightOfPlane
@abstract Returns the height of the plane at planeIndex in the PixelBuffer.
@discussion On OSX 10.10 and earlier, or iOS 8 and earlier, calling this
function with a non-planar buffer will have undefined behavior.
@param pixelBuffer Target PixelBuffer.
@param planeIndex Identifying the plane.
@result Height in pixels, or 0 for non-planar CVPixelBufferRefs.
*/
CV_EXPORT size_t CVPixelBufferGetHeightOfPlane( CVPixelBufferRef CV_NONNULL pixelBuffer, size_t planeIndex ) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/*!
@function CVPixelBufferGetBaseAddressOfPlane
@abstract Returns the base address of the plane at planeIndex in the PixelBuffer.
@discussion Retrieving the base address for a PixelBuffer requires that the buffer base address be locked
via a successful call to CVPixelBufferLockBaseAddress. On OSX 10.10 and earlier, or iOS 8 and
earlier, calling this function with a non-planar buffer will have undefined behavior.
@param pixelBuffer Target PixelBuffer.
@param planeIndex Identifying the plane.
@result Base address of the plane, or NULL for non-planar CVPixelBufferRefs.
*/
CV_EXPORT void * CV_NULLABLE CVPixelBufferGetBaseAddressOfPlane( CVPixelBufferRef CV_NONNULL pixelBuffer, size_t planeIndex ) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/*!
@function CVPixelBufferGetBytesPerRowOfPlane
@abstract Returns the row bytes of the plane at planeIndex in the PixelBuffer.
@discussion On OSX 10.10 and earlier, or iOS 8 and earlier, calling this
function with a non-planar buffer will have undefined behavior.
@param pixelBuffer Target PixelBuffer.
@param planeIndex Identifying the plane.
@result Row bytes of the plane, or NULL for non-planar CVPixelBufferRefs.
*/
CV_EXPORT size_t CVPixelBufferGetBytesPerRowOfPlane( CVPixelBufferRef CV_NONNULL pixelBuffer, size_t planeIndex ) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/*!
@function CVPixelBufferGetExtendedPixels
@abstract Returns the size of extended pixels of the PixelBuffer.
@discussion On OSX 10.10 and earlier, or iOS 8 and earlier, calling this
function with a non-planar buffer will have undefined behavior.
@param pixelBuffer Target PixelBuffer.
@param extraColumnsOnLeft Returns the pixel row padding to the left. May be NULL.
@param extraRowsOnTop Returns the pixel row padding to the top. May be NULL.
@param extraColumnsOnRight Returns the pixel row padding to the right. May be NULL.
@param extraRowsOnBottom Returns the pixel row padding to the bottom. May be NULL.
*/
CV_EXPORT void CVPixelBufferGetExtendedPixels(
CVPixelBufferRef CV_NONNULL pixelBuffer,
size_t * CV_NULLABLE extraColumnsOnLeft,
size_t * CV_NULLABLE extraColumnsOnRight,
size_t * CV_NULLABLE extraRowsOnTop,
size_t * CV_NULLABLE extraRowsOnBottom ) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/*!
@function CVPixelBufferFillExtendedPixels
@abstract Fills the extended pixels of the PixelBuffer. This function replicates edge pixels to fill the entire extended region of the image.
@param pixelBuffer Target PixelBuffer.
*/
CV_EXPORT CVReturn CVPixelBufferFillExtendedPixels( CVPixelBufferRef CV_NONNULL pixelBuffer ) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/*!
@function CVPixelBufferCopyCreationAttributes
@abstract Returns a copy of pixelBufferAttributes dictionary used to create the PixelBuffer.
@discussion Can be used to create similar pixelbuffers.
@param pixelBuffer Target PixelBuffer.
*/
CV_EXPORT CFDictionaryRef CV_NONNULL CVPixelBufferCopyCreationAttributes( CVPixelBufferRef CV_NONNULL pixelBuffer ) CV_RETURNS_RETAINED API_AVAILABLE(macosx(12.0), ios(15.0), tvos(15.0), watchos(8.0));
#if defined(__cplusplus)
}
#endif
#if !0
#if COREVIDEO_SUPPORTS_IOSURFACE
#if __has_include(<CoreVideo/CVPixelBufferIOSurface.h>)
#include <CoreVideo/CVPixelBufferIOSurface.h>
#endif
#endif
#endif
#endif
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreVideo.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreVideo.framework/Headers/CVDisplayLink.h | /*
* CVDisplayLink.h
* CoreVideo
*
* Copyright (c) 2004-2015 Apple Inc. All rights reserved.
*
*/
/*! @header CVDisplayLink.h
@copyright 2004-2015 Apple Inc. All rights reserved.
@availability Mac OS X 10.4 or later
@discussion The main purpose of the CoreVideo DisplayLink API is to provide a worker thread to the VideoUnit subsystem that is clocked based on the refresh rate of a CGDirectDisplay device. In the current implementation, these DisplayLinks are created automatically by the Video Unit display nodes, and the developer does not have to deal with them directly.
A CoreVideo DisplayLink is represented in code by a CVDisplayLinkRef. The CVDisplayLinkRef API uses the CoreFoundation class system internally to provide reference counting behaviour and other such goodies. There are three different ways to create a CVDisplayLinkRef in the current API. The first call is the most general case, and the other two are provided as a convenience (the third will probably go away, as it's only marginally useful).
*/
#if !defined(__COREVIDEO_CVDISPLAYLINK_H__)
#define __COREVIDEO_CVDISPLAYLINK_H__ 1
#include <CoreGraphics/CoreGraphics.h>
#include <CoreVideo/CVReturn.h>
#include <CoreVideo/CVBase.h>
#include <OpenGL/OpenGL.h>
typedef struct CV_BRIDGED_TYPE(id) __CVDisplayLink *CVDisplayLinkRef;
#if defined(__cplusplus)
extern "C" {
#endif
typedef CVReturn (*CVDisplayLinkOutputCallback)(
CVDisplayLinkRef CV_NONNULL displayLink,
const CVTimeStamp * CV_NONNULL inNow,
const CVTimeStamp * CV_NONNULL inOutputTime,
CVOptionFlags flagsIn,
CVOptionFlags * CV_NONNULL flagsOut,
void * CV_NULLABLE displayLinkContext );
#if __BLOCKS__
typedef CVReturn (^CVDisplayLinkOutputHandler)(
CVDisplayLinkRef CV_NONNULL displayLink,
const CVTimeStamp * CV_NONNULL inNow,
const CVTimeStamp * CV_NONNULL inOutputTime,
CVOptionFlags flagsIn,
CVOptionFlags * CV_NONNULL flagsOut );
#endif // __BLOCKS__
CV_EXPORT CFTypeID CVDisplayLinkGetTypeID(void) AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;
/*!
@function CVDisplayLinkCreateWithCGDisplays
@abstract General call to create a CVDisplayLink
@discussion Use this call to create a CVDisplayLink for a set of displays indentified by the CGDirectDisplayIDs.
@param displayArray array of CGDirectDisplayIDs
@param count number of displays in the displayArray
@param displayLisk The new display link will be returned here
@result returns kCVReturnSuccess on success.
*/
CV_EXPORT CVReturn CVDisplayLinkCreateWithCGDisplays(
CGDirectDisplayID * CV_NONNULL displayArray,
CFIndex count,
CV_RETURNS_RETAINED_PARAMETER CVDisplayLinkRef CV_NULLABLE * CV_NONNULL displayLinkOut ) AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;
/*!
@function CVDisplayLinkCreateWithOpenGLDisplayMask
@abstract Convenience call to create a CVDisplayLink from an OpenGL display mask.
@discussion Use this call to create a CVDisplayLink for a CGOpenGLDisplayMask.
@param mask CGOpenGLDisplayMask describing the display
@param displayLisk The new display link will be returned here
@result returns kCVReturnSuccess on success.
*/
CV_EXPORT CVReturn CVDisplayLinkCreateWithOpenGLDisplayMask(
CGOpenGLDisplayMask mask,
CV_RETURNS_RETAINED_PARAMETER CVDisplayLinkRef CV_NULLABLE * CV_NONNULL displayLinkOut ) AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;
/*!
@function CVDisplayLinkCreateWithCGDisplay
@abstract Convenience call to create a CVDisplayLink for a single CGDirectDisplay.
@discussion Use this call to create a CVDisplayLink for a single CGDirectDisplay.
@param displayID CGDirectDisplayID of the target display
@param displayLisk The new display link will be returned here
@result returns kCVReturnSuccess on success.
*/
CV_EXPORT CVReturn CVDisplayLinkCreateWithCGDisplay(
CGDirectDisplayID displayID,
CV_RETURNS_RETAINED_PARAMETER CVDisplayLinkRef CV_NULLABLE * CV_NONNULL displayLinkOut ) AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;
/*!
@function CVDisplayLinkCreateWithActiveCGDisplays
@abstract Convenience function to create a CVDisplayLink capable of being used with all active CGDisplays
@param displayLinkOut The newly created CVDisplayLink
@result kCVReturnSuccess if the device was created, or failure
*/
CV_EXPORT CVReturn CVDisplayLinkCreateWithActiveCGDisplays(
CV_RETURNS_RETAINED_PARAMETER CVDisplayLinkRef CV_NULLABLE * CV_NONNULL displayLinkOut ) AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;
/*!
@function CVDisplayLinkSetCurrentCGDisplay
@abstract Sets the current display of a DisplayLink
@discussion It is safe to call this with a running display link, but be aware that there will likely be a timestamp
discontinuity in the video time stamp
@param displayLink target CVDisplayLinkRef
@param displayID target CGDirectDisplayID
@result CVReturn. kCVReturnSuccess if successfull.
*/
CV_EXPORT CVReturn CVDisplayLinkSetCurrentCGDisplay( CVDisplayLinkRef CV_NONNULL displayLink, CGDirectDisplayID displayID ) AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;
/*!
@function CVDisplayLinkSetCurrentCGDisplayFromOpenGLContext
@abstract Convenience function to select a CVDisplayLink most optimal for the current renderer of the passed in OpenGL context
@param displayLink The CVDisplayLink for which you want to set the current CGDisplay
@param cglContext The OpenGL context to retrieve the current renderer from.
@param cglPixelFormat The OpenGL pixel format used to create the passed in OpenGL context
@result kCVReturnSuccess if a device was found, or failure.
*/
CV_EXPORT CVReturn CVDisplayLinkSetCurrentCGDisplayFromOpenGLContext(
CVDisplayLinkRef CV_NONNULL displayLink,
CGLContextObj CV_NONNULL cglContext,
CGLPixelFormatObj CV_NONNULL cglPixelFormat) AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;
/*!
@function CVDisplayLinkGetCurrentCGDisplay
@abstract Gets the current display of a DisplayLink
@discussion (description)
@param displayLink target CVDisplayLinkRef
@result CGDirectDisplayID
*/
CV_EXPORT CGDirectDisplayID CVDisplayLinkGetCurrentCGDisplay( CVDisplayLinkRef CV_NONNULL displayLink ) AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;
/*!
@function CVDisplayLinkSetOutputCallback
@abstract Set the renderer output callback function
@discussion The DisplayLink will invoke this callback whenever it wants you to output a frame.
@param displayLink target CVDisplayLinkRef
@param callback CVDisplayLinkOutputCallback function
@param userInfo User data for the callback to identify the context.
@result CVReturn. kCVReturnSuccess if successfull.
*/
CV_EXPORT CVReturn CVDisplayLinkSetOutputCallback( CVDisplayLinkRef CV_NONNULL displayLink, CVDisplayLinkOutputCallback CV_NULLABLE callback, void * CV_NULLABLE userInfo ) AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;
/*!
@function CVDisplayLinkSetOutputHandler
@abstract Set the renderer output callback block
@discussion The DisplayLink will invoke this block whenever it wants you to output a frame. You can only have a block or a callback function; not both.
@param displayLink target CVDisplayLinkRef
@param handler CVDisplayLinkOutputHandler block
@result CVReturn. kCVReturnSuccess if successful.
*/
CV_EXPORT CVReturn CVDisplayLinkSetOutputHandler( CVDisplayLinkRef CV_NONNULL displayLink, CVDisplayLinkOutputHandler CV_NONNULL handler );
/*!
@function CVDisplayLinkStart
@abstract Start timer for DisplayLink
@discussion This call should not be made from inside the CVDisplayLinkOutputCallback
@param displayLink target CVDisplayLinkRef
@result CVReturn. kCVReturnSuccess if successfull.
kCVReturnDisplayLinkCallbacksNotSet The DisplayLink cannot be started until the output callback is set.
*/
CV_EXPORT CVReturn CVDisplayLinkStart( CVDisplayLinkRef CV_NONNULL displayLink ) AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;
/*!
@function CVDisplayLinkStop
@abstract Stop timer for DisplayLink
@discussion (description)
@param displayLink target CVDisplayLinkRef
@result CVReturn. kCVReturnSuccess if successfull.
*/
CV_EXPORT CVReturn CVDisplayLinkStop( CVDisplayLinkRef CV_NONNULL displayLink ) AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;
/*!
@function CVDisplayLinkGetNominalOutputVideoRefreshPeriod
@abstract Retrieves the nominal refresh period of a CVDisplayLink.
@discussion This call allows one to retrieve the device's "ideal" refresh period. For example, an NTSC output device might report 1001/60000 to represent the exact NTSC vertial refresh rate.
@param displayLink The CVDisplayLink to get the refresh period from.
@result A CVTime struct that holds the nominal refresh period. This value may be indefinite.
*/
CV_EXPORT CVTime CVDisplayLinkGetNominalOutputVideoRefreshPeriod( CVDisplayLinkRef CV_NONNULL displayLink ) AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;
/*!
@function CVDisplayLinkGetOutputVideoLatency
@abstract Retrieves the nominal latency of a CVDisplayLink.
@discussion This call allows one to retrieve the device's built in output latency. An NTSC device with one frame of latency might report back 1001/30000 or 2002/60000, for example.
@param displayLink The CVDisplayLink to get the latency period from.
@result A CVTime struct that holds the latency. This value may be indefinite.
*/
CV_EXPORT CVTime CVDisplayLinkGetOutputVideoLatency( CVDisplayLinkRef CV_NONNULL displayLink ) AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;
/*!
@function CVDisplayLinkGetActualOutputVideoRefreshPeriod
@abstract Retrieves the actual output refresh period of a display as measured by the host timebase.
@discussion This call returns the actual output refresh period (in seconds) as computed relative to the host's timebase.
@param displayLink The CVDisplayLink to get the refresh period from.
@result A double containing the actual refresh period. This value may be zero if the device is not running, or is otherwise unavailable.
*/
CV_EXPORT double CVDisplayLinkGetActualOutputVideoRefreshPeriod( CVDisplayLinkRef CV_NONNULL displayLink ) AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;
/*!
@function CVDisplayLinkIsRunning
@abstract Retrieves the running state of a CVDisplayLink.
@discussion This call queries the running state of the given CVDisplayLink.
@param displayLink The CVDisplayLink to get the running state from.
@result A boolean describing the running state. It returns true if it is running and false if it is not running or the CVDisplayLink is invalid.
*/
CV_EXPORT Boolean CVDisplayLinkIsRunning( CVDisplayLinkRef CV_NONNULL displayLink ) AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;
/*!
@function CVDisplayLinkGetCurrentTime
@abstract Retrieves the current ("now") time of a given CVDisplayLink
@discussion This call may be used to get the current time of a running CVDisplayLink, outside of the output callback.
@param displayLink The CVDisplayLink to get the current time from.
@param outTime A pointer to a CVTimeStamp struct. This struct's version field must currently be set correctly (currently 0) to indicate which version of the timestamp struct is desired.
@result kCVReturnSuccess if the current time could be retrieved, otherwise an error indicating why the operation failed.
*/
CV_EXPORT CVReturn CVDisplayLinkGetCurrentTime( CVDisplayLinkRef CV_NONNULL displayLink, CVTimeStamp * CV_NONNULL outTime ) AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;
/*!
@function CVDisplayLinkTranslateTime
@abstract Translates the time in the CVDisplayLink's time base from one representation to
another. Note that the device has to be running for this call to succeed.
@param displayLink The CVDisplayLink who's timebase should be used to do the translation.
@param inTime A CVTimeStamp containing the source time to be translated.
@param outTime A CVTimeStamp into which the target time will be written. This struct's version field must currently be set correctly
(currently 0) to indicate which version of the timestamp struct is desired. As well, the flags field should be used to specify
which representations to translate to.
@result kCVReturnSuccess if the time could be translated, otherwise an error indicating why the operation failed.
*/
CV_EXPORT CVReturn CVDisplayLinkTranslateTime( CVDisplayLinkRef CV_NONNULL displayLink, const CVTimeStamp * CV_NONNULL inTime, CVTimeStamp * CV_NONNULL outTime ) AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;
/*!
@function CVDisplayLinkRetain
@abstract Retains the CVDisplayLink
@discussion Use this call to retain a CVDisplayLink.
@param displayLink target CVDisplayLinkRef. NULL safe.
@result If successfull the passed in dislplayLink
*/
CV_EXPORT CVDisplayLinkRef CV_NULLABLE CVDisplayLinkRetain( CVDisplayLinkRef CV_NULLABLE displayLink ) AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;
/*!
@function CVDisplayLinkRelease
@abstract Releases the CVDisplayLink
@discussion Use this call to release a CVDisplayLink.
@param displayLink target CVDisplayLinkRef. NULL safe.
*/
CV_EXPORT void CVDisplayLinkRelease( CV_RELEASES_ARGUMENT CVDisplayLinkRef CV_NULLABLE displayLink ) AVAILABLE_MAC_OS_X_VERSION_10_4_AND_LATER;
#if defined(__cplusplus)
}
#endif
#endif
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreVideo.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreVideo.framework/Headers/CVOpenGLBuffer.h | /*
* CVOpenGLBuffer.h
* CoreVideo
*
* Copyright (c) 2004-2015 Apple Inc. All rights reserved.
*
*/
/*! @header CVOpenGLBuffer.h
@copyright 2004-2015 Apple Inc. All rights reserved.
@availability Mac OS X 10.4 or later
@discussion A CoreVideo buffer derives from a generic buffer and can be an ImageBuffer or PixelBuffer.
*/
#if !defined(__COREVIDEO_CVOPENGLBUFFER_H__)
#define __COREVIDEO_CVOPENGLBUFFER_H__ 1
#include <CoreVideo/CVImageBuffer.h>
#include <OpenGL/OpenGL.h>
#include <OpenGL/gltypes.h>
#if defined(__cplusplus)
extern "C" {
#endif
CV_EXPORT const CFStringRef CV_NONNULL kCVOpenGLBufferWidth COREVIDEO_GL_DEPRECATED(macosx, 10.4, 10.14) API_UNAVAILABLE(macCatalyst);
CV_EXPORT const CFStringRef CV_NONNULL kCVOpenGLBufferHeight COREVIDEO_GL_DEPRECATED(macosx, 10.4, 10.14) API_UNAVAILABLE(macCatalyst);
CV_EXPORT const CFStringRef CV_NONNULL kCVOpenGLBufferTarget COREVIDEO_GL_DEPRECATED(macosx, 10.4, 10.14) API_UNAVAILABLE(macCatalyst);
CV_EXPORT const CFStringRef CV_NONNULL kCVOpenGLBufferInternalFormat COREVIDEO_GL_DEPRECATED(macosx, 10.4, 10.14) API_UNAVAILABLE(macCatalyst);
CV_EXPORT const CFStringRef CV_NONNULL kCVOpenGLBufferMaximumMipmapLevel COREVIDEO_GL_DEPRECATED(macosx, 10.4, 10.14) API_UNAVAILABLE(macCatalyst);
typedef CVImageBufferRef CVOpenGLBufferRef;
CV_EXPORT CFTypeID CVOpenGLBufferGetTypeID(void) COREVIDEO_GL_DEPRECATED(macosx, 10.4, 10.14) API_UNAVAILABLE(macCatalyst);
/*!
@function CVOpenGLBufferRetain
@abstract Retains a CVOpenGLBuffer object
@discussion Equivalent to CFRetain, but NULL safe
@param buffer A CVOpenGLBuffer object that you want to retain.
@result A CVOpenGLBuffer object that is the same as the passed in buffer.
*/
CV_EXPORT CVOpenGLBufferRef CV_NULLABLE CVOpenGLBufferRetain( CVOpenGLBufferRef CV_NULLABLE buffer ) COREVIDEO_GL_DEPRECATED(macosx, 10.4, 10.14) API_UNAVAILABLE(macCatalyst);
/*!
@function CVOpenGLBufferRelease
@abstract Releases a CVOpenGLBuffer object
@discussion Equivalent to CFRelease, but NULL safe
@param buffer A CVOpenGLBuffer object that you want to release.
*/
CV_EXPORT void CVOpenGLBufferRelease( CV_RELEASES_ARGUMENT CVOpenGLBufferRef CV_NULLABLE buffer ) COREVIDEO_GL_DEPRECATED(macosx, 10.4, 10.14) API_UNAVAILABLE(macCatalyst);
/*!
@function CVOpenGLBufferCreate
@abstract Create a new CVOpenGLBuffer that may be used for OpenGL rendering purposes
@param width The width of the buffer in pixels
@param height The height of the buffer in pixels
@param attributes A CFDictionaryRef containing other desired attributes of the buffer (texture target, internal format, max mipmap level, etc.).
May be NULL. Defaults are GL_TEXTURE_RECTANGLE_EXT, GL_RGBA, and 0 for kCVOpenGLBufferTarget, kCVOpenGLBufferInternalFormat and kCVOpenGLBufferMaximumMipmapLevel,
respectively.
@param bufferOut The newly created buffer will be placed here.
@result kCVReturnSuccess if the attachment succeeded
*/
CV_EXPORT CVReturn CVOpenGLBufferCreate(
CFAllocatorRef CV_NULLABLE allocator,
size_t width,
size_t height,
CFDictionaryRef CV_NULLABLE attributes,
CV_RETURNS_RETAINED_PARAMETER CVOpenGLBufferRef CV_NULLABLE * CV_NONNULL bufferOut ) COREVIDEO_GL_DEPRECATED(macosx, 10.4, 10.14) API_UNAVAILABLE(macCatalyst);
/*!
@function CVOpenGLBufferGetAttributes
@param openGLBuffer Target OpenGL Buffer.
@result CVOpenGLBuffer attributes dictionary, NULL if not set.
*/
CV_EXPORT CFDictionaryRef CV_NULLABLE CVOpenGLBufferGetAttributes( CVOpenGLBufferRef CV_NONNULL openGLBuffer ) COREVIDEO_GL_DEPRECATED(macosx, 10.4, 10.14) API_UNAVAILABLE(macCatalyst);
/*!
@function CVOpenGLBufferAttach
@param openGLBuffer The buffer you wish to attach a GL context to
@param cglContext The CGLContextObj you wish to attach
@param face The target GL face enum (0 for non cube maps)
@param level The mipmap level index you wish to attach to
@param screen The virtual screen number you want to use
@result kCVReturnSuccess if the attachment succeeded
*/
CV_EXPORT CVReturn CVOpenGLBufferAttach( CVOpenGLBufferRef CV_NONNULL openGLBuffer, CGLContextObj CV_NONNULL cglContext, GLenum face, GLint level, GLint screen ) COREVIDEO_GL_DEPRECATED(macosx, 10.4, 10.14) API_UNAVAILABLE(macCatalyst);
#if defined(__cplusplus)
}
#endif
#endif
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreVideo.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreVideo.framework/Headers/CVPixelBufferPool.h | /*
* CVPixelBufferPool.h
* CoreVideo
*
* Copyright 2004-2015 Apple Inc. All rights reserved.
*
*/
/*! @header CVPixelBufferPool.h
@copyright 2004-2015 Apple Inc. All rights reserved.
@availability Mac OS X 10.4 or later, and iOS 4.0 or later
@discussion CVPixelBufferPool is a utility object for managing a set of CVPixelBuffer objects that are going to be recycled.
*/
#if !defined(__COREVIDEO__CVPIXELBUFFERPOOL_H__)
#define __COREVIDEO__CVPIXELBUFFERPOOL_H__ 1
#include <TargetConditionals.h>
#include <Availability.h>
#include <AvailabilityMacros.h>
#include <CoreVideo/CVBase.h>
#include <CoreVideo/CVReturn.h>
#include <CoreVideo/CVPixelBuffer.h>
#if defined(__cplusplus)
extern "C" {
#endif
typedef struct CV_BRIDGED_TYPE(id) __CVPixelBufferPool *CVPixelBufferPoolRef;
// By default, buffers will age out after one second. If required, setting an age of zero will disable
// the age-out mechanism completely.
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelBufferPoolMinimumBufferCountKey __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelBufferPoolMaximumBufferAgeKey __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
CV_EXPORT CFTypeID CVPixelBufferPoolGetTypeID(void) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/*!
@function CVPixelBufferPoolRetain
@abstract Retains a CVPixelBufferPoolRef object
@discussion Equivalent to CFRetain, but NULL safe
@param buffer A CVPixelBufferPoolRef object that you want to retain.
@result A CVPixelBufferPoolRef object that is the same as the passed in buffer.
*/
CV_EXPORT CVPixelBufferPoolRef CV_NULLABLE CVPixelBufferPoolRetain( CVPixelBufferPoolRef CV_NULLABLE pixelBufferPool ) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0); // NULL-safe
/*!
@function CVPixelBufferPoolRelease
@abstract Releases a CVPixelBufferPoolRef object
@discussion Equivalent to CFRelease, but NULL safe
@param buffer A CVPixelBufferPoolRef object that you want to release.
*/
CV_EXPORT void CVPixelBufferPoolRelease( CV_RELEASES_ARGUMENT CVPixelBufferPoolRef CV_NULLABLE pixelBufferPool ) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0); // NULL-safe
/*!
@function CVPixelBufferPoolCreate
@abstract Creates a new Pixel Buffer pool.
@param allocator The CFAllocatorRef to use for allocating this buffer pool. May be NULL.
@param attributes A CFDictionaryRef containing the attributes to be used for creating new PixelBuffers within the pool.
@param poolOut The newly created pool will be placed here
@result Returns kCVReturnSuccess on success
*/
CV_EXPORT CVReturn CVPixelBufferPoolCreate(
CFAllocatorRef CV_NULLABLE allocator,
CFDictionaryRef CV_NULLABLE poolAttributes,
CFDictionaryRef CV_NULLABLE pixelBufferAttributes,
CV_RETURNS_RETAINED_PARAMETER CVPixelBufferPoolRef CV_NULLABLE * CV_NONNULL poolOut ) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/*!
@function CVPixelBufferPoolGetAttributes
@abstract Returns the pool attributes dictionary for a CVPixelBufferPool
@param pool The CVPixelBufferPoolRef to retrieve the attributes from
@result Returns the pool attributes dictionary, or NULL on failure.
*/
CV_EXPORT CFDictionaryRef CF_RETURNS_NOT_RETAINED CV_NULLABLE CVPixelBufferPoolGetAttributes( CVPixelBufferPoolRef CV_NONNULL pool ) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/*!
@function CVPixelBufferPoolGetPixelBufferAttributes
@abstract Returns the attributes of pixel buffers that will be created from this pool.
@discussion This function is provided for those cases where you may need to know some information about the buffers that
will be created up front.
@param pool The CVPixelBufferPoolRef to retrieve the attributes from
@result Returns the pixel buffer attributes dictionary, or NULL on failure.
*/
CV_EXPORT CFDictionaryRef CF_RETURNS_NOT_RETAINED CV_NULLABLE CVPixelBufferPoolGetPixelBufferAttributes( CVPixelBufferPoolRef CV_NONNULL pool ) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/*!
@function CVPixelBufferPoolCreatePixelBuffer
@abstract Creates a new PixelBuffer object from the pool.
@discussion The function creates a new (attachment-free) CVPixelBuffer using the pixel buffer attributes specifed during pool creation.
@param allocator The CFAllocatorRef to use for creating the pixel buffer. May be NULL.
@param pool The CVPixelBufferPool that should create the new CVPixelBuffer.
@param pixelBufferOut The newly created pixel buffer will be placed here
@result Returns kCVReturnSuccess on success
*/
CV_EXPORT CVReturn CVPixelBufferPoolCreatePixelBuffer(
CFAllocatorRef CV_NULLABLE allocator,
CVPixelBufferPoolRef CV_NONNULL pixelBufferPool,
CV_RETURNS_RETAINED_PARAMETER CVPixelBufferRef CV_NULLABLE * CV_NONNULL pixelBufferOut ) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/*
@function CVPixelBufferPoolCreatePixelBufferWithAuxAttributes
@abstract Creates a new PixelBuffer object from the pool.
@discussion This function creates a new CVPixelBuffer using the pixel buffer attributes specified during pool creation and the attributes specified in the auxAttributes parameter.
@param allocator The CFAllocatorRef to use for creating the pixel buffer. May be NULL.
@param pixelBufferPool The CVPixelBufferPool that should create the new CVPixelBuffer.
@param auxAttributes Attributes describing this specific allocation request. May be NULL.
@param pixelBufferOut The newly created pixel buffer will be placed here
@result Returns kCVReturnSuccess on success
*/
CV_EXPORT CVReturn CVPixelBufferPoolCreatePixelBufferWithAuxAttributes(
CFAllocatorRef CV_NULLABLE allocator,
CVPixelBufferPoolRef CV_NONNULL pixelBufferPool,
CFDictionaryRef CV_NULLABLE auxAttributes,
CV_RETURNS_RETAINED_PARAMETER CVPixelBufferRef CV_NULLABLE * CV_NONNULL pixelBufferOut ) __OSX_AVAILABLE_STARTING(__MAC_10_7,__IPHONE_4_0);
// Key for the auxiliary attributes dictionary passed to CVPixelBufferPoolCreatePixelBufferWithAuxAttributes().
// When set, indicates that a new pixel buffer should not be allocated if
// the pool already has this many or more pixel buffers allocated.
// This does not prevent already-allocated buffers from being recycled.
// If this key causes CVPixelBufferPoolCreatePixelBufferWithAuxAttributes to fail,
// it will return kCVReturnWouldExceedAllocationThreshold.
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelBufferPoolAllocationThresholdKey __OSX_AVAILABLE_STARTING(__MAC_10_7,__IPHONE_4_0); // CFNumberRef -- for use only in auxAttributes
// kCVPixelBufferPoolFreeBufferNotification is posted if a buffer becomes available after
// CVPixelBufferPoolCreatePixelBufferWithAuxAttributes has failed due to kCVPixelBufferPoolAllocationThresholdKey.
// This notification will not be posted by the pool if kCVPixelBufferPoolAllocationThresholdKey
// has never been passed to CVPixelBufferPoolCreatePixelBufferWithAuxAttributes.
CV_EXPORT const CFStringRef CV_NONNULL kCVPixelBufferPoolFreeBufferNotification __OSX_AVAILABLE_STARTING(__MAC_10_7,__IPHONE_4_0);
/*!
@enum CVPixelBufferPoolFlush flags
@discussion Flags to pass to CVPixelBufferPoolFlush()
@constant kCVPixelBufferPoolFlushExcessBuffers
This flag will cause CVPixelBufferPoolFlush to flush all unused buffers regardless of age.
*/
typedef CF_OPTIONS(CVOptionFlags,CVPixelBufferPoolFlushFlags)
{
kCVPixelBufferPoolFlushExcessBuffers = 1,
};
/*!
@function CVPixelBufferPoolFlush
@abstract Frees as many buffers from the pool as possible.
@discussion By default, this function will free all aged out buffers. Setting the
kCVPixelBufferPoolFlushExcessBuffers flag will cause this call to free all unused
buffers regardless of age.
@param pool The CVPixelBufferPool to be flushed.
@param options Set to kCVPixelBufferPoolFlushExcessBuffers to free all unused buffers
regardless of their age.
*/
CV_EXPORT void CVPixelBufferPoolFlush( CVPixelBufferPoolRef CV_NONNULL pool, CVPixelBufferPoolFlushFlags options );
#if defined(__cplusplus)
}
#endif
#endif
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreVideo.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreVideo.framework/Headers/CVBuffer.h | /*
* CVBuffer.h
* CoreVideo
*
* Copyright (c) 2004-2017,2021 Apple Inc. All rights reserved.
*
*/
/*! @header CVBuffer.h
@copyright 2004-2015 Apple Inc. All rights reserved.
@availability Mac OS X 10.4 or later, and iOS 4.0 or later
@discussion CVBufferRef types are abstract and only define ways to attach meta data to buffers (such as timestamps,
colorspace information, etc.). CVBufferRefs do not imply any particular kind of data storage. It could
be compressed data, image data, etc.
*/
#if !defined(__COREVIDEO_CVBUFFER_H__)
#define __COREVIDEO_CVBUFFER_H__ 1
#include <TargetConditionals.h>
#include <Availability.h>
#include <AvailabilityMacros.h>
#include <CoreVideo/CVBase.h>
#include <CoreVideo/CVReturn.h>
#include <CoreFoundation/CFDictionary.h>
#if TARGET_OS_MAC
#include <stddef.h>
#include <stdint.h>
#endif
#if defined(__cplusplus)
extern "C" {
#endif
#pragma mark CVBufferRef attribute keys
/* The following two keys are useful with the CoreVideo pool and texture cache APIs so that you can specify
an initial set of default buffer attachments to automatically be attached to the buffer when it is created. */
CV_EXPORT const CFStringRef CV_NONNULL kCVBufferPropagatedAttachmentsKey __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
CV_EXPORT const CFStringRef CV_NONNULL kCVBufferNonPropagatedAttachmentsKey __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
#pragma mark CVBufferRef attachment keys
CV_EXPORT const CFStringRef CV_NONNULL kCVBufferMovieTimeKey __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0); // Generally only available for frames emitted by QuickTime; CFDictionary containing these two keys:
CV_EXPORT const CFStringRef CV_NONNULL kCVBufferTimeValueKey __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
CV_EXPORT const CFStringRef CV_NONNULL kCVBufferTimeScaleKey __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
#pragma mark CVBufferRef
typedef CF_ENUM(uint32_t, CVAttachmentMode)
{
kCVAttachmentMode_ShouldNotPropagate = 0,
kCVAttachmentMode_ShouldPropagate = 1
};
/*!
@typedef CVBufferRef
@abstract Base type for all CoreVideo buffers
*/
typedef struct CV_BRIDGED_TYPE(id) __CVBuffer *CVBufferRef;
/*!
@function CVBufferRetain
@abstract Retains a CVBuffer object
@discussion Like CFRetain CVBufferRetain increments the retain count of a CVBuffer object. In contrast to the CF call it is NULL safe.
@param buffer A CVBuffer object that you want to retain.
@result A CVBuffer object that is the same as the passed in buffer.
*/
CV_EXPORT CVBufferRef CV_NULLABLE CVBufferRetain( CVBufferRef CV_NULLABLE buffer ) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/*!
@function CVBufferRelease
@abstract Release a CVBuffer object
@discussion Like CFRetain CVBufferRetain decrements the retain count of a CVBuffer object. If that count consequently becomes zero the memory allocated to the object is deallocated and the object is destroyed. In contrast to the CF call it is NULL safe.
@param buffer A CVBuffer object that you want to release.
*/
CV_EXPORT void CVBufferRelease( CV_RELEASES_ARGUMENT CVBufferRef CV_NULLABLE buffer ) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
#pragma mark CVBufferAttachment
/*!
@function CVBufferSetAttachment
@abstract Sets or adds a attachment of a CVBuffer object
@discussion You can attach any CF object to a CVBuffer object to store additional information. CVBufferGetAttachment stores an attachement identified by a key. If the key doesn't exist, the attachment will be added. If the key does exist, the existing attachment will be replaced. In bouth cases the retain count of the attachment will be incremented. The value can be any CFType but nil has no defined behavior.
@param buffer Target CVBuffer object.
@param key Key in form of a CFString identifying the desired attachment.
@param value Attachment in form af a CF object.
@param attachmentMode Specifies which attachment mode is desired for this attachment. A particular attachment key may only exist in
a single mode at a time.
*/
CV_EXPORT void CVBufferSetAttachment( CVBufferRef CV_NONNULL buffer, CFStringRef CV_NONNULL key, CFTypeRef CV_NONNULL value, CVAttachmentMode attachmentMode ) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/*!
@function CVBufferGetAttachment
@abstract Returns a specific attachment of a CVBuffer object
@discussion You can attach any CF object to a CVBuffer object to store additional information. CVBufferGetAttachment retrieves an attachement identified by a key.
@param buffer Target CVBuffer object.
@param key Key in form of a CFString identifying the desired attachment.
@param attachmentMode. Returns the mode of the attachment, if desired. May be NULL.
@result If found the attachment object
*/
CV_EXPORT CFTypeRef CV_NULLABLE CVBufferGetAttachment( CVBufferRef CV_NONNULL buffer, CFStringRef CV_NONNULL key, CVAttachmentMode * CV_NULLABLE attachmentMode ) API_DEPRECATED_WITH_REPLACEMENT("CVBufferCopyAttachment", macos(10.4, 12.0), ios(4.0,15.0), tvos(9.0, 15.0), watchos(4.0, 8.0));
/*!
@function CVBufferRemoveAttachment
@abstract Removes a specific attachment of a CVBuffer object
@discussion CVBufferRemoveAttachment removes an attachement identified by a key. If found the attachement is removed and the retain count decremented.
@param buffer Target CVBuffer object.
@param key Key in form of a CFString identifying the desired attachment.
*/
CV_EXPORT void CVBufferRemoveAttachment( CVBufferRef CV_NONNULL buffer, CFStringRef CV_NONNULL key ) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/*!
@function CVBufferRemoveAllAttachments
@abstract Removes all attachments of a CVBuffer object
@discussion While CVBufferRemoveAttachment removes a specific attachement identified by a key CVBufferRemoveAllAttachments removes all attachments of a buffer and decrements their retain counts.
@param buffer Target CVBuffer object.
*/
CV_EXPORT void CVBufferRemoveAllAttachments( CVBufferRef CV_NONNULL buffer ) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/*!
@function CVBufferGetAttachments
@abstract Returns all attachments of a CVBuffer object
@discussion CVBufferGetAttachments is a convenience call that returns all attachments with their corresponding keys in a CFDictionary.
@param buffer Target CVBuffer object.
@result A CFDictionary with all buffer attachments identified by there keys. If no attachment is present, the dictionary is empty. Returns NULL
for invalid attachment mode.
*/
CV_EXPORT CFDictionaryRef CF_RETURNS_NOT_RETAINED CV_NULLABLE CVBufferGetAttachments( CVBufferRef CV_NONNULL buffer, CVAttachmentMode attachmentMode ) API_DEPRECATED_WITH_REPLACEMENT("CVBufferCopyAttachments", macos(10.4, 12.0), ios(4.0,15.0), tvos(9.0, 15.0), watchos(4.0, 8.0));
/*!
@function CVBufferSetAttachments
@abstract Sets a set of attachments for a CVBuffer
@discussion CVBufferSetAttachments is a convenience call that in turn calls CVBufferSetAttachment for each key and value in the given dictionary. All key value pairs must be in the root level of the dictionary.
@param buffer Target CVBuffer object.
*/
CV_EXPORT void CVBufferSetAttachments( CVBufferRef CV_NONNULL buffer, CFDictionaryRef CV_NONNULL theAttachments, CVAttachmentMode attachmentMode ) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/*!
@function CVBufferPropagateAttachments
@abstract Copy all propagatable attachments from one buffer to another.
@discussion CVBufferPropagateAttachments is a convenience call that copies all attachments with a mode of kCVAttachmentMode_ShouldPropagate from one
buffer to another.
@param sourceBuffer CVBuffer to copy attachments from.
@param destinationBuffer CVBuffer to copy attachments to.
*/
CV_EXPORT void CVBufferPropagateAttachments( CVBufferRef CV_NONNULL sourceBuffer, CVBufferRef CV_NONNULL destinationBuffer ) __OSX_AVAILABLE_STARTING(__MAC_10_4,__IPHONE_4_0);
/*!
@function CVBufferCopyAttachments
@abstract Returns a copy of all attachments of a CVBuffer object. It is the caller’s responsibility to release the returned dictionary.
@discussion CVBufferCopyAttachments is a convenience call that returns a copy of all attachments with their corresponding keys in a CFDictionary.
@param buffer Target CVBuffer object.
@result A CFDictionary with all buffer attachments identified by their keys. If no attachment is present or invalid attachment mode, returns NULL
*/
CV_EXPORT CFDictionaryRef CF_RETURNS_RETAINED CV_NULLABLE CVBufferCopyAttachments( CVBufferRef CV_NONNULL buffer, CVAttachmentMode attachmentMode ) API_AVAILABLE(macos(12.0), ios(15.0), tvos(15.0), watchos(8.0));
/*!
@function CVBufferCopyAttachment
@abstract Returns a retained specific attachment of a CVBuffer object. It is the caller’s responsibility to release the returned value.
@discussion You can attach any CF object to a CVBuffer object to store additional information. CVBufferCopyAttachment retrieves a retained attachment identified by a key.
@param buffer Target CVBuffer object.
@param key Key in form of a CFString identifying the desired attachment.
@param attachmentMode. Returns the mode of the attachment, if desired. May be NULL.
@result If found the attachment object, return the value; otherwize, return NULL.
*/
CV_EXPORT CFTypeRef CV_NULLABLE CF_RETURNS_RETAINED CVBufferCopyAttachment( CVBufferRef CV_NONNULL buffer, CFStringRef CV_NONNULL key, CVAttachmentMode * CV_NULLABLE attachmentMode ) API_AVAILABLE(macos(12.0), ios(15.0), tvos(15.0), watchos(8.0));
/*!
@function CVBufferHasAttachment
@abstract Returns true if an attachment with the passed key is present on a CVBuffer object.
@param buffer Target CVBuffer object.
@param key Key in form of a CFString identifying the desired attachment.
@result True if an attachment with this key is present, otherwise false.
*/
CV_EXPORT Boolean CVBufferHasAttachment( CVBufferRef CV_NONNULL buffer, CFStringRef CV_NONNULL key ) API_AVAILABLE(macos(12.0), ios(15.0), tvos(15.0), watchos(8.0));
#if defined(__cplusplus)
}
#endif
#endif
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreVideo.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreVideo.framework/Headers/CVMetalTexture.h | /*
* CVMetalTexture.h
* CoreVideo
*
* Copyright (c) 2011-2015 Apple Inc. All rights reserved.
*
*/
/*! @header CVMetalTexture.h
@copyright 2011-2015 Apple Inc. All rights reserved.
@availability iOS 8.0 or later. Mac OS X 10.11 or later.
@discussion A CoreVideo Metal Texture derives from an ImageBuffer, and is used for supplying source image data to Metal.
*/
#if !defined(__COREVIDEO_CVMETALTEXTURE_H__)
#define __COREVIDEO_CVMETALTEXTURE_H__ 1
#include <CoreVideo/CVBase.h>
#include <CoreVideo/CVReturn.h>
#include <CoreVideo/CVImageBuffer.h>
#include <CoreFoundation/CoreFoundation.h>
#include <stddef.h>
#include <stdint.h>
#if defined(__cplusplus)
extern "C" {
#endif
/* CVMetalTextureRef is only available to Objective C code */
#if COREVIDEO_SUPPORTS_METAL
#if defined(__OBJC__)
@protocol MTLTexture;
#pragma mark CVMetalTexture
/*!
@typedef CVMetalTextureRef
@abstract Metal texture based image buffer
*/
typedef CVImageBufferRef CVMetalTextureRef;
CV_EXPORT CFTypeID CVMetalTextureGetTypeID(void) API_AVAILABLE(macosx(10.11), ios(8.0), tvos(9.0)) __WATCHOS_PROHIBITED;
/*!
@function CVMetalTextureGetTexture
@abstract Returns the Meta MTLTexture object of the CVMetalTextureRef
@param image Target CVMetalTexture
@result Metal texture
*/
CV_EXPORT id <MTLTexture> CV_NULLABLE CVMetalTextureGetTexture( CVMetalTextureRef CV_NONNULL image ) API_AVAILABLE(macosx(10.11), ios(8.0), tvos(9.0)) __WATCHOS_PROHIBITED;
/*!
@function CVMetalTextureIsFlipped
@abstract Returns whether the image is flipped vertically or not.
@param image Target CVMetalTexture
@result True if 0,0 in the texture is upper left, false if 0,0 is lower left
*/
CV_EXPORT Boolean CVMetalTextureIsFlipped( CVMetalTextureRef CV_NONNULL image ) API_AVAILABLE(macosx(10.11), ios(8.0), tvos(9.0)) __WATCHOS_PROHIBITED;
/*!
@function CVMetalTextureGetCleanTexCoords
@abstract Returns convenient normalized texture coordinates for the part of the image that should be displayed
@discussion This function automatically takes into account whether or not the texture is flipped.
@param image Target CVMetalTexture
@param lowerLeft - array of two floats where the s and t normalized texture coordinates of the lower left corner of the image will be stored
@param lowerRight - array of two floats where the s and t normalized texture coordinates of the lower right corner of the image will be stored
@param upperRight - array of two floats where the s and t normalized texture coordinates of the upper right corner of the image will be stored
@param upperLeft - array of two floats where the s and t normalized texture coordinates of the upper right corner of the image will be stored
*/
CV_EXPORT void CVMetalTextureGetCleanTexCoords( CVMetalTextureRef CV_NONNULL image,
float lowerLeft[CV_NONNULL 2],
float lowerRight[CV_NONNULL 2],
float upperRight[CV_NONNULL 2],
float upperLeft[CV_NONNULL 2] ) API_AVAILABLE(macosx(10.11), ios(8.0), tvos(9.0)) __WATCHOS_PROHIBITED;
#endif // defined(__OBJC__)
/*!
@discussion kCVMetalTextureUsage is a property that can be placed on a CVMetalTextureCache to instruct the MTLTextureUsage of the created MTLTexture. Values for this can can be read from MTLTexture.h
*/
CV_EXPORT const CFStringRef CV_NONNULL kCVMetalTextureUsage API_AVAILABLE(macosx(10.13), ios(11.0), tvos(11.0)) __WATCHOS_PROHIBITED;
/*!
@discussion kCVMetalTextureStorageMode is a property that can be placed on a CVMetalTextureCache to instruct the MTLTextureStorageMode of the created MTLTexture. Values for this can can be read from MTLTexture.h
*/
CV_EXPORT const CFStringRef CV_NONNULL kCVMetalTextureStorageMode API_AVAILABLE(macosx(10.15), ios(13.0), tvos(13.0)) __WATCHOS_PROHIBITED;
#endif // COREVIDEO_SUPPORTS_METAL
#if defined(__cplusplus)
}
#endif
#endif
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreVideo.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreVideo.framework/Modules/module.modulemap | framework module CoreVideo [system] {
umbrella header "CoreVideo.h"
export *
module * {
export *
}
explicit module CVHostTime {
header "CVHostTime.h"
export *
}
}
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/AudioUnit.framework/AudioUnit.tbd | --- !tapi-tbd
tbd-version: 4
targets: [ x86_64-macos, x86_64-maccatalyst, arm64-macos, arm64-maccatalyst,
arm64e-macos, arm64e-maccatalyst ]
uuids:
- target: x86_64-macos
value: 0942F2B8-345A-3874-B7FA-F62947983FC7
- target: x86_64-maccatalyst
value: 0942F2B8-345A-3874-B7FA-F62947983FC7
- target: arm64-macos
value: 00000000-0000-0000-0000-000000000000
- target: arm64-maccatalyst
value: 00000000-0000-0000-0000-000000000000
- target: arm64e-macos
value: 2A7E4341-9E52-397C-B992-05C0E4C42726
- target: arm64e-maccatalyst
value: 2A7E4341-9E52-397C-B992-05C0E4C42726
install-name: '/System/Library/Frameworks/AudioUnit.framework/Versions/A/AudioUnit'
exports:
- targets: [ x86_64-maccatalyst, x86_64-macos, arm64e-maccatalyst, arm64e-macos,
arm64-macos, arm64-maccatalyst ]
symbols: [ '$ld$add$os10.10$_AudioCodecAppendInputBufferList', '$ld$add$os10.10$_AudioCodecAppendInputData',
'$ld$add$os10.10$_AudioCodecGetProperty', '$ld$add$os10.10$_AudioCodecGetPropertyInfo',
'$ld$add$os10.10$_AudioCodecInitialize', '$ld$add$os10.10$_AudioCodecProduceOutputBufferList',
'$ld$add$os10.10$_AudioCodecProduceOutputPackets', '$ld$add$os10.10$_AudioCodecReset',
'$ld$add$os10.10$_AudioCodecSetProperty', '$ld$add$os10.10$_AudioCodecUninitialize',
'$ld$add$os10.10$_AudioComponentCopyName', '$ld$add$os10.10$_AudioComponentCount',
'$ld$add$os10.10$_AudioComponentFindNext', '$ld$add$os10.10$_AudioComponentGetDescription',
'$ld$add$os10.10$_AudioComponentGetVersion', '$ld$add$os10.10$_AudioComponentInstanceCanDo',
'$ld$add$os10.10$_AudioComponentInstanceDispose', '$ld$add$os10.10$_AudioComponentInstanceGetComponent',
'$ld$add$os10.10$_AudioComponentInstanceNew', '$ld$add$os10.10$_AudioComponentRegister',
'$ld$add$os10.10$_AudioOutputUnitStart', '$ld$add$os10.10$_AudioOutputUnitStop',
'$ld$add$os10.10$_AudioUnitAddPropertyListener', '$ld$add$os10.10$_AudioUnitAddRenderNotify',
'$ld$add$os10.10$_AudioUnitCarbonViewCreate', '$ld$add$os10.10$_AudioUnitComplexRender',
'$ld$add$os10.10$_AudioUnitGetParameter', '$ld$add$os10.10$_AudioUnitGetProperty',
'$ld$add$os10.10$_AudioUnitGetPropertyInfo', '$ld$add$os10.10$_AudioUnitInitialize',
'$ld$add$os10.10$_AudioUnitProcess', '$ld$add$os10.10$_AudioUnitProcessMultiple',
'$ld$add$os10.10$_AudioUnitRemovePropertyListenerWithUserData',
'$ld$add$os10.10$_AudioUnitRemoveRenderNotify', '$ld$add$os10.10$_AudioUnitRender',
'$ld$add$os10.10$_AudioUnitReset', '$ld$add$os10.10$_AudioUnitScheduleParameters',
'$ld$add$os10.10$_AudioUnitSetParameter', '$ld$add$os10.10$_AudioUnitSetProperty',
'$ld$add$os10.10$_AudioUnitUninitialize', '$ld$add$os10.10$_MusicDeviceMIDIEvent',
'$ld$add$os10.10$_MusicDevicePrepareInstrument', '$ld$add$os10.10$_MusicDeviceReleaseInstrument',
'$ld$add$os10.10$_MusicDeviceStartNote', '$ld$add$os10.10$_MusicDeviceStopNote',
'$ld$add$os10.10$_MusicDeviceSysEx', '$ld$add$os10.4$_AudioCodecAppendInputData',
'$ld$add$os10.4$_AudioCodecGetProperty', '$ld$add$os10.4$_AudioCodecGetPropertyInfo',
'$ld$add$os10.4$_AudioCodecInitialize', '$ld$add$os10.4$_AudioCodecProduceOutputPackets',
'$ld$add$os10.4$_AudioCodecReset', '$ld$add$os10.4$_AudioCodecSetProperty',
'$ld$add$os10.4$_AudioCodecUninitialize', '$ld$add$os10.4$_AudioOutputUnitStart',
'$ld$add$os10.4$_AudioOutputUnitStop', '$ld$add$os10.4$_AudioUnitAddPropertyListener',
'$ld$add$os10.4$_AudioUnitAddRenderNotify', '$ld$add$os10.4$_AudioUnitCarbonViewCreate',
'$ld$add$os10.4$_AudioUnitGetParameter', '$ld$add$os10.4$_AudioUnitGetProperty',
'$ld$add$os10.4$_AudioUnitGetPropertyInfo', '$ld$add$os10.4$_AudioUnitInitialize',
'$ld$add$os10.4$_AudioUnitRemoveRenderNotify', '$ld$add$os10.4$_AudioUnitRender',
'$ld$add$os10.4$_AudioUnitReset', '$ld$add$os10.4$_AudioUnitScheduleParameters',
'$ld$add$os10.4$_AudioUnitSetParameter', '$ld$add$os10.4$_AudioUnitSetProperty',
'$ld$add$os10.4$_AudioUnitUninitialize', '$ld$add$os10.4$_MusicDeviceMIDIEvent',
'$ld$add$os10.4$_MusicDeviceStartNote', '$ld$add$os10.4$_MusicDeviceStopNote',
'$ld$add$os10.4$_MusicDeviceSysEx', '$ld$add$os10.5$_AudioCodecAppendInputData',
'$ld$add$os10.5$_AudioCodecGetProperty', '$ld$add$os10.5$_AudioCodecGetPropertyInfo',
'$ld$add$os10.5$_AudioCodecInitialize', '$ld$add$os10.5$_AudioCodecProduceOutputPackets',
'$ld$add$os10.5$_AudioCodecReset', '$ld$add$os10.5$_AudioCodecSetProperty',
'$ld$add$os10.5$_AudioCodecUninitialize', '$ld$add$os10.5$_AudioOutputUnitStart',
'$ld$add$os10.5$_AudioOutputUnitStop', '$ld$add$os10.5$_AudioUnitAddPropertyListener',
'$ld$add$os10.5$_AudioUnitAddRenderNotify', '$ld$add$os10.5$_AudioUnitCarbonViewCreate',
'$ld$add$os10.5$_AudioUnitGetParameter', '$ld$add$os10.5$_AudioUnitGetProperty',
'$ld$add$os10.5$_AudioUnitGetPropertyInfo', '$ld$add$os10.5$_AudioUnitInitialize',
'$ld$add$os10.5$_AudioUnitRemovePropertyListenerWithUserData',
'$ld$add$os10.5$_AudioUnitRemoveRenderNotify', '$ld$add$os10.5$_AudioUnitRender',
'$ld$add$os10.5$_AudioUnitReset', '$ld$add$os10.5$_AudioUnitScheduleParameters',
'$ld$add$os10.5$_AudioUnitSetParameter', '$ld$add$os10.5$_AudioUnitSetProperty',
'$ld$add$os10.5$_AudioUnitUninitialize', '$ld$add$os10.5$_MusicDeviceMIDIEvent',
'$ld$add$os10.5$_MusicDevicePrepareInstrument', '$ld$add$os10.5$_MusicDeviceReleaseInstrument',
'$ld$add$os10.5$_MusicDeviceStartNote', '$ld$add$os10.5$_MusicDeviceStopNote',
'$ld$add$os10.5$_MusicDeviceSysEx', '$ld$add$os10.6$_AudioCodecAppendInputData',
'$ld$add$os10.6$_AudioCodecGetProperty', '$ld$add$os10.6$_AudioCodecGetPropertyInfo',
'$ld$add$os10.6$_AudioCodecInitialize', '$ld$add$os10.6$_AudioCodecProduceOutputPackets',
'$ld$add$os10.6$_AudioCodecReset', '$ld$add$os10.6$_AudioCodecSetProperty',
'$ld$add$os10.6$_AudioCodecUninitialize', '$ld$add$os10.6$_AudioComponentCopyName',
'$ld$add$os10.6$_AudioComponentCount', '$ld$add$os10.6$_AudioComponentFindNext',
'$ld$add$os10.6$_AudioComponentGetDescription', '$ld$add$os10.6$_AudioComponentGetVersion',
'$ld$add$os10.6$_AudioComponentInstanceCanDo', '$ld$add$os10.6$_AudioComponentInstanceDispose',
'$ld$add$os10.6$_AudioComponentInstanceGetComponent', '$ld$add$os10.6$_AudioComponentInstanceNew',
'$ld$add$os10.6$_AudioOutputUnitStart', '$ld$add$os10.6$_AudioOutputUnitStop',
'$ld$add$os10.6$_AudioUnitAddPropertyListener', '$ld$add$os10.6$_AudioUnitAddRenderNotify',
'$ld$add$os10.6$_AudioUnitCarbonViewCreate', '$ld$add$os10.6$_AudioUnitGetParameter',
'$ld$add$os10.6$_AudioUnitGetProperty', '$ld$add$os10.6$_AudioUnitGetPropertyInfo',
'$ld$add$os10.6$_AudioUnitInitialize', '$ld$add$os10.6$_AudioUnitRemovePropertyListenerWithUserData',
'$ld$add$os10.6$_AudioUnitRemoveRenderNotify', '$ld$add$os10.6$_AudioUnitRender',
'$ld$add$os10.6$_AudioUnitReset', '$ld$add$os10.6$_AudioUnitScheduleParameters',
'$ld$add$os10.6$_AudioUnitSetParameter', '$ld$add$os10.6$_AudioUnitSetProperty',
'$ld$add$os10.6$_AudioUnitUninitialize', '$ld$add$os10.6$_MusicDeviceMIDIEvent',
'$ld$add$os10.6$_MusicDevicePrepareInstrument', '$ld$add$os10.6$_MusicDeviceReleaseInstrument',
'$ld$add$os10.6$_MusicDeviceStartNote', '$ld$add$os10.6$_MusicDeviceStopNote',
'$ld$add$os10.6$_MusicDeviceSysEx', '$ld$add$os10.7$_AudioCodecAppendInputBufferList',
'$ld$add$os10.7$_AudioCodecAppendInputData', '$ld$add$os10.7$_AudioCodecGetProperty',
'$ld$add$os10.7$_AudioCodecGetPropertyInfo', '$ld$add$os10.7$_AudioCodecInitialize',
'$ld$add$os10.7$_AudioCodecProduceOutputBufferList', '$ld$add$os10.7$_AudioCodecProduceOutputPackets',
'$ld$add$os10.7$_AudioCodecReset', '$ld$add$os10.7$_AudioCodecSetProperty',
'$ld$add$os10.7$_AudioCodecUninitialize', '$ld$add$os10.7$_AudioComponentCopyName',
'$ld$add$os10.7$_AudioComponentCount', '$ld$add$os10.7$_AudioComponentFindNext',
'$ld$add$os10.7$_AudioComponentGetDescription', '$ld$add$os10.7$_AudioComponentGetVersion',
'$ld$add$os10.7$_AudioComponentInstanceCanDo', '$ld$add$os10.7$_AudioComponentInstanceDispose',
'$ld$add$os10.7$_AudioComponentInstanceGetComponent', '$ld$add$os10.7$_AudioComponentInstanceNew',
'$ld$add$os10.7$_AudioComponentRegister', '$ld$add$os10.7$_AudioOutputUnitStart',
'$ld$add$os10.7$_AudioOutputUnitStop', '$ld$add$os10.7$_AudioUnitAddPropertyListener',
'$ld$add$os10.7$_AudioUnitAddRenderNotify', '$ld$add$os10.7$_AudioUnitCarbonViewCreate',
'$ld$add$os10.7$_AudioUnitComplexRender', '$ld$add$os10.7$_AudioUnitGetParameter',
'$ld$add$os10.7$_AudioUnitGetProperty', '$ld$add$os10.7$_AudioUnitGetPropertyInfo',
'$ld$add$os10.7$_AudioUnitInitialize', '$ld$add$os10.7$_AudioUnitProcess',
'$ld$add$os10.7$_AudioUnitProcessMultiple', '$ld$add$os10.7$_AudioUnitRemovePropertyListenerWithUserData',
'$ld$add$os10.7$_AudioUnitRemoveRenderNotify', '$ld$add$os10.7$_AudioUnitRender',
'$ld$add$os10.7$_AudioUnitReset', '$ld$add$os10.7$_AudioUnitScheduleParameters',
'$ld$add$os10.7$_AudioUnitSetParameter', '$ld$add$os10.7$_AudioUnitSetProperty',
'$ld$add$os10.7$_AudioUnitUninitialize', '$ld$add$os10.7$_MusicDeviceMIDIEvent',
'$ld$add$os10.7$_MusicDevicePrepareInstrument', '$ld$add$os10.7$_MusicDeviceReleaseInstrument',
'$ld$add$os10.7$_MusicDeviceStartNote', '$ld$add$os10.7$_MusicDeviceStopNote',
'$ld$add$os10.7$_MusicDeviceSysEx', '$ld$add$os10.8$_AudioCodecAppendInputBufferList',
'$ld$add$os10.8$_AudioCodecAppendInputData', '$ld$add$os10.8$_AudioCodecGetProperty',
'$ld$add$os10.8$_AudioCodecGetPropertyInfo', '$ld$add$os10.8$_AudioCodecInitialize',
'$ld$add$os10.8$_AudioCodecProduceOutputBufferList', '$ld$add$os10.8$_AudioCodecProduceOutputPackets',
'$ld$add$os10.8$_AudioCodecReset', '$ld$add$os10.8$_AudioCodecSetProperty',
'$ld$add$os10.8$_AudioCodecUninitialize', '$ld$add$os10.8$_AudioComponentCopyName',
'$ld$add$os10.8$_AudioComponentCount', '$ld$add$os10.8$_AudioComponentFindNext',
'$ld$add$os10.8$_AudioComponentGetDescription', '$ld$add$os10.8$_AudioComponentGetVersion',
'$ld$add$os10.8$_AudioComponentInstanceCanDo', '$ld$add$os10.8$_AudioComponentInstanceDispose',
'$ld$add$os10.8$_AudioComponentInstanceGetComponent', '$ld$add$os10.8$_AudioComponentInstanceNew',
'$ld$add$os10.8$_AudioComponentRegister', '$ld$add$os10.8$_AudioOutputUnitStart',
'$ld$add$os10.8$_AudioOutputUnitStop', '$ld$add$os10.8$_AudioUnitAddPropertyListener',
'$ld$add$os10.8$_AudioUnitAddRenderNotify', '$ld$add$os10.8$_AudioUnitCarbonViewCreate',
'$ld$add$os10.8$_AudioUnitComplexRender', '$ld$add$os10.8$_AudioUnitGetParameter',
'$ld$add$os10.8$_AudioUnitGetProperty', '$ld$add$os10.8$_AudioUnitGetPropertyInfo',
'$ld$add$os10.8$_AudioUnitInitialize', '$ld$add$os10.8$_AudioUnitProcess',
'$ld$add$os10.8$_AudioUnitProcessMultiple', '$ld$add$os10.8$_AudioUnitRemovePropertyListenerWithUserData',
'$ld$add$os10.8$_AudioUnitRemoveRenderNotify', '$ld$add$os10.8$_AudioUnitRender',
'$ld$add$os10.8$_AudioUnitReset', '$ld$add$os10.8$_AudioUnitScheduleParameters',
'$ld$add$os10.8$_AudioUnitSetParameter', '$ld$add$os10.8$_AudioUnitSetProperty',
'$ld$add$os10.8$_AudioUnitUninitialize', '$ld$add$os10.8$_MusicDeviceMIDIEvent',
'$ld$add$os10.8$_MusicDevicePrepareInstrument', '$ld$add$os10.8$_MusicDeviceReleaseInstrument',
'$ld$add$os10.8$_MusicDeviceStartNote', '$ld$add$os10.8$_MusicDeviceStopNote',
'$ld$add$os10.8$_MusicDeviceSysEx', '$ld$add$os10.9$_AudioCodecAppendInputBufferList',
'$ld$add$os10.9$_AudioCodecAppendInputData', '$ld$add$os10.9$_AudioCodecGetProperty',
'$ld$add$os10.9$_AudioCodecGetPropertyInfo', '$ld$add$os10.9$_AudioCodecInitialize',
'$ld$add$os10.9$_AudioCodecProduceOutputBufferList', '$ld$add$os10.9$_AudioCodecProduceOutputPackets',
'$ld$add$os10.9$_AudioCodecReset', '$ld$add$os10.9$_AudioCodecSetProperty',
'$ld$add$os10.9$_AudioCodecUninitialize', '$ld$add$os10.9$_AudioComponentCopyName',
'$ld$add$os10.9$_AudioComponentCount', '$ld$add$os10.9$_AudioComponentFindNext',
'$ld$add$os10.9$_AudioComponentGetDescription', '$ld$add$os10.9$_AudioComponentGetVersion',
'$ld$add$os10.9$_AudioComponentInstanceCanDo', '$ld$add$os10.9$_AudioComponentInstanceDispose',
'$ld$add$os10.9$_AudioComponentInstanceGetComponent', '$ld$add$os10.9$_AudioComponentInstanceNew',
'$ld$add$os10.9$_AudioComponentRegister', '$ld$add$os10.9$_AudioOutputUnitStart',
'$ld$add$os10.9$_AudioOutputUnitStop', '$ld$add$os10.9$_AudioUnitAddPropertyListener',
'$ld$add$os10.9$_AudioUnitAddRenderNotify', '$ld$add$os10.9$_AudioUnitCarbonViewCreate',
'$ld$add$os10.9$_AudioUnitComplexRender', '$ld$add$os10.9$_AudioUnitGetParameter',
'$ld$add$os10.9$_AudioUnitGetProperty', '$ld$add$os10.9$_AudioUnitGetPropertyInfo',
'$ld$add$os10.9$_AudioUnitInitialize', '$ld$add$os10.9$_AudioUnitProcess',
'$ld$add$os10.9$_AudioUnitProcessMultiple', '$ld$add$os10.9$_AudioUnitRemovePropertyListenerWithUserData',
'$ld$add$os10.9$_AudioUnitRemoveRenderNotify', '$ld$add$os10.9$_AudioUnitRender',
'$ld$add$os10.9$_AudioUnitReset', '$ld$add$os10.9$_AudioUnitScheduleParameters',
'$ld$add$os10.9$_AudioUnitSetParameter', '$ld$add$os10.9$_AudioUnitSetProperty',
'$ld$add$os10.9$_AudioUnitUninitialize', '$ld$add$os10.9$_MusicDeviceMIDIEvent',
'$ld$add$os10.9$_MusicDevicePrepareInstrument', '$ld$add$os10.9$_MusicDeviceReleaseInstrument',
'$ld$add$os10.9$_MusicDeviceStartNote', '$ld$add$os10.9$_MusicDeviceStopNote',
'$ld$add$os10.9$_MusicDeviceSysEx' ]
reexports:
- targets: [ x86_64-maccatalyst, x86_64-macos, arm64e-maccatalyst, arm64e-macos,
arm64-macos, arm64-maccatalyst ]
symbols: [ _AudioCodecAppendInputBufferList, _AudioCodecAppendInputData,
_AudioCodecGetProperty, _AudioCodecGetPropertyInfo, _AudioCodecInitialize,
_AudioCodecProduceOutputBufferList, _AudioCodecProduceOutputPackets,
_AudioCodecReset, _AudioCodecSetProperty, _AudioCodecUninitialize,
_AudioComponentCopyName, _AudioComponentCount, _AudioComponentFindNext,
_AudioComponentGetDescription, _AudioComponentGetVersion,
_AudioComponentInstanceCanDo, _AudioComponentInstanceDispose,
_AudioComponentInstanceGetComponent, _AudioComponentInstanceNew,
_AudioComponentRegister, _AudioOutputUnitStart, _AudioOutputUnitStop,
_AudioUnitAddPropertyListener, _AudioUnitAddRenderNotify,
_AudioUnitComplexRender, _AudioUnitGetParameter, _AudioUnitGetProperty,
_AudioUnitGetPropertyInfo, _AudioUnitInitialize, _AudioUnitProcess,
_AudioUnitProcessMultiple, _AudioUnitRemovePropertyListenerWithUserData,
_AudioUnitRemoveRenderNotify, _AudioUnitRender, _AudioUnitReset,
_AudioUnitScheduleParameters, _AudioUnitSetParameter, _AudioUnitSetProperty,
_AudioUnitUninitialize, _MusicDeviceMIDIEvent, _MusicDevicePrepareInstrument,
_MusicDeviceReleaseInstrument, _MusicDeviceStartNote, _MusicDeviceStopNote,
_MusicDeviceSysEx ]
...
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/AudioUnit.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/AudioUnit.framework/Headers/AUComponent.h | #include <AudioToolbox/AUComponent.h>
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/AudioUnit.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/AudioUnit.framework/Headers/AudioUnit.h | // Umbrella header for AudioUnit.framework
// Deprecated: Use AudioToolbox
#ifndef AudioUnit_AudioUnit_h
#define AudioUnit_AudioUnit_h
#ifndef AUDIO_UNIT_VERSION
#define AUDIO_UNIT_VERSION 1070
#endif
#include <AudioUnit/AUComponent.h>
#include <AudioUnit/AudioCodec.h>
#include <AudioUnit/AudioComponent.h>
#include <AudioUnit/AudioOutputUnit.h>
#include <AudioUnit/AudioUnitParameters.h>
#include <AudioUnit/AudioUnitProperties.h>
#include <AudioUnit/MusicDevice.h>
#ifdef __OBJC2__
#include <AudioUnit/AUAudioUnit.h>
#include <AudioUnit/AUAudioUnitImplementation.h>
#include <AudioUnit/AUParameters.h>
#endif // __OBJC2__
#endif // AudioUnit_AudioUnit_h
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/AudioUnit.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/AudioUnit.framework/Headers/AUParameters.h | #include <AudioToolbox/AUParameters.h>
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/AudioUnit.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/AudioUnit.framework/Headers/AudioUnitCarbonView.h | #include <AudioToolbox/AudioUnitCarbonView.h>
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/AudioUnit.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/AudioUnit.framework/Headers/MusicDevice.h | #include <AudioToolbox/MusicDevice.h>
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/AudioUnit.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/AudioUnit.framework/Headers/AudioComponent.h | #include <AudioToolbox/AudioComponent.h>
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/AudioUnit.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/AudioUnit.framework/Headers/AudioCodec.h | #include <AudioToolbox/AudioCodec.h>
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/AudioUnit.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/AudioUnit.framework/Headers/AudioOutputUnit.h | #include <AudioToolbox/AudioOutputUnit.h>
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/AudioUnit.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/AudioUnit.framework/Headers/AudioUnitParameters.h | #include <AudioToolbox/AudioUnitParameters.h>
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/AudioUnit.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/AudioUnit.framework/Headers/AUAudioUnit.h | #include <AudioToolbox/AUAudioUnit.h>
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/AudioUnit.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/AudioUnit.framework/Headers/AudioUnitProperties.h | #include <AudioToolbox/AudioUnitProperties.h>
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/AudioUnit.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/AudioUnit.framework/Headers/AUAudioUnitImplementation.h | #include <AudioToolbox/AUAudioUnitImplementation.h>
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/AudioUnit.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/AudioUnit.framework/Headers/AUCocoaUIView.h | #include <AudioToolbox/AUCocoaUIView.h>
|
Subsets and Splits
No saved queries yet
Save your SQL queries to embed, download, and access them later. Queries will appear here once saved.