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/CoreData.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreData.framework/Headers/NSPersistentStoreDescription.h | /*
NSPersistentStoreDescription.h
Core Data
Copyright (c) 2016-2021, Apple Inc.
All rights reserved.
*/
#import <Foundation/NSArray.h>
#import <Foundation/NSDictionary.h>
#import <Foundation/NSDate.h>
@class NSURL;
NS_ASSUME_NONNULL_BEGIN
// An instance of NSPersistentStoreDescription encapsulates all information needed to describe a persistent store.
API_AVAILABLE(macosx(10.12),ios(10.0),tvos(10.0),watchos(3.0))
@interface NSPersistentStoreDescription : NSObject <NSCopying> {
}
+ (instancetype)persistentStoreDescriptionWithURL:(NSURL *)URL;
@property (copy) NSString *type;
@property (copy, nullable) NSString *configuration;
@property (copy, nullable) NSURL *URL;
@property (nonatomic, copy, readonly) NSDictionary<NSString *, NSObject *> *options;
- (void)setOption:(nullable NSObject *)option forKey:(NSString *)key;
// Store options
@property (getter = isReadOnly) BOOL readOnly;
@property NSTimeInterval timeout;
@property (nonatomic, copy, readonly) NSDictionary<NSString *, NSObject *> *sqlitePragmas;
- (void)setValue:(nullable NSObject *)value forPragmaNamed:(NSString *)name;
// addPersistentStore-time behaviours
@property BOOL shouldAddStoreAsynchronously;
@property BOOL shouldMigrateStoreAutomatically;
@property BOOL shouldInferMappingModelAutomatically;
// Returns a store description instance with default values for the store located at `URL` that can be used immediately with `addPersistentStoreWithDescription:completionHandler:`.
- (instancetype)initWithURL:(NSURL *)url NS_DESIGNATED_INITIALIZER;
@end
@class NSPersistentCloudKitContainerOptions;
@interface NSPersistentStoreDescription (NSPersistentCloudKitContainerAdditions)
/**
Use this property to apply customized instances of NSPersistentCloudKitContainerOptions to
a store description you wish to use with CloudKit.
*/
@property(strong, nullable) NSPersistentCloudKitContainerOptions *cloudKitContainerOptions API_AVAILABLE(macosx(10.15),ios(13.0),tvos(13.0),watchos(6.0));
@end
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreData.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreData.framework/Headers/NSBatchUpdateRequest.h | /*
NSBatchUpdateRequest.h
Core Data
Copyright (c) 2004-2021, Apple Inc.
All rights reserved.
*/
#import <Foundation/NSPredicate.h>
#import <Foundation/NSDictionary.h>
#import <CoreData/NSPersistentStoreRequest.h>
#import <CoreData/NSPersistentStoreResult.h>
NS_ASSUME_NONNULL_BEGIN
@class NSEntityDescription;
// Used to request that Core Data do a batch update of data in a persistent store without
// loading any data into memory. May not be supported by all store types.
// WARNING:
// It is up to the developer creating the request to ensure that changes made by the request to
// the underlying store do not violate any validation rules specified in the model.
API_AVAILABLE(macosx(10.10),ios(8.0))
@interface NSBatchUpdateRequest : NSPersistentStoreRequest {
}
+ (instancetype)batchUpdateRequestWithEntityName:(NSString*)entityName;
- (instancetype)initWithEntityName:(NSString *)entityName NS_DESIGNATED_INITIALIZER;
- (instancetype)initWithEntity:(NSEntityDescription *)entity NS_DESIGNATED_INITIALIZER;
@property (copy, readonly) NSString* entityName;
@property (strong, readonly) NSEntityDescription *entity;
@property (nullable, strong) NSPredicate *predicate;
// Should the update include subentities? Defaults to YES.
@property BOOL includesSubentities;
// The type of result that should be returned from this request. Defaults to NSStatusOnlyResultType
@property NSBatchUpdateRequestResultType resultType;
// Dictionary of NSPropertyDescription|property name string -> constantValue/NSExpression pairs describing the desired updates.
// The expressions can be any NSExpression that evaluates to a scalar value.
@property (nullable, copy) NSDictionary *propertiesToUpdate;
@end
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreData.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreData.framework/Headers/CoreDataDefines.h | /*
CoreDataDefines.h
Core Data
Copyright (c) 2004-2021, Apple Inc.
All rights reserved.
*/
#ifndef _COREDATADEFINES_H
#define _COREDATADEFINES_H
#import <AvailabilityMacros.h>
#import <Availability.h>
#import <TargetConditionals.h>
//
// Platform specific defs for externs
//
//
// For MACH
//
#if defined(__MACH__)
#ifdef __cplusplus
#define COREDATA_EXTERN extern "C"
#define COREDATA_PRIVATE_EXTERN __attribute__((visibility("hidden"))) extern "C"
#else
#define COREDATA_EXTERN extern
#define COREDATA_PRIVATE_EXTERN __attribute__((visibility("hidden"))) extern
#endif
//
// For Windows
//
#elif defined(WIN32)
#ifndef _NSBUILDING_COREDATA_DLL
#define _NSWINDOWS_DLL_GOOP __declspec(dllimport)
#else
#define _NSWINDOWS_DLL_GOOP __declspec(dllexport)
#endif
#ifdef __cplusplus
#define COREDATA_EXTERN extern "C" _NSWINDOWS_DLL_GOOP
#define COREDATA_PRIVATE_EXTERN extern
#else
#define COREDATA_EXTERN _NSWINDOWS_DLL_GOOP extern
#define COREDATA_PRIVATE_EXTERN extern
#endif
//
// For Solaris
//
#elif defined(SOLARIS)
#ifdef __cplusplus
#define COREDATA_EXTERN extern "C"
#define COREDATA_PRIVATE_EXTERN extern "C"
#else
#define COREDATA_EXTERN extern
#define COREDATA_PRIVATE_EXTERN extern
#endif
#endif
//
// Framework version
//
COREDATA_EXTERN double NSCoreDataVersionNumber;
#define NSCoreDataVersionNumber10_4 46.0
#define NSCoreDataVersionNumber10_4_3 77.0
#define NSCoreDataVersionNumber10_5 185.0
#define NSCoreDataVersionNumber10_5_3 186.0
#define NSCoreDataVersionNumber10_6 246.0
#define NSCoreDataVersionNumber10_6_2 250.0
#define NSCoreDataVersionNumber10_6_3 251.0
#define NSCoreDataVersionNumber10_7 358.4
#define NSCoreDataVersionNumber10_7_2 358.12
#define NSCoreDataVersionNumber10_7_3 358.13
#define NSCoreDataVersionNumber10_7_4 358.14
#define NSCoreDataVersionNumber10_8 407.5
#define NSCoreDataVersionNumber10_8_2 407.7
#define NSCoreDataVersionNumber10_9 481.0
#define NSCoreDataVersionNumber10_9_2 481.1
#define NSCoreDataVersionNumber10_9_3 481.3
#define NSCoreDataVersionNumber10_10 526.0
#define NSCoreDataVersionNumber10_10_2 526.1
#define NSCoreDataVersionNumber10_10_3 526.2
#define NSCoreDataVersionNumber10_11 640.0
#define NSCoreDataVersionNumber10_11_3 641.3
#define NSCoreDataVersionNumber_iPhoneOS_3_0 241.0
#define NSCoreDataVersionNumber_iPhoneOS_3_1 248.0
#define NSCoreDataVersionNumber_iPhoneOS_3_2 310.2
#define NSCoreDataVersionNumber_iPhoneOS_4_0 320.5
#define NSCoreDataVersionNumber_iPhoneOS_4_1 320.11
#define NSCoreDataVersionNumber_iPhoneOS_4_2 320.15
#define NSCoreDataVersionNumber_iPhoneOS_4_3 320.17
#define NSCoreDataVersionNumber_iPhoneOS_5_0 386.1
#define NSCoreDataVersionNumber_iPhoneOS_5_1 386.5
#define NSCoreDataVersionNumber_iPhoneOS_6_0 419.0
#define NSCoreDataVersionNumber_iPhoneOS_6_1 419.1
#define NSCoreDataVersionNumber_iPhoneOS_7_0 479.1
#define NSCoreDataVersionNumber_iPhoneOS_7_1 479.3
#define NSCoreDataVersionNumber_iPhoneOS_8_0 519.0
#define NSCoreDataVersionNumber_iPhoneOS_8_3 519.15
#define NSCoreDataVersionNumber_iPhoneOS_9_0 640.0
#define NSCoreDataVersionNumber_iPhoneOS_9_2 641.4
#define NSCoreDataVersionNumber_iPhoneOS_9_3 641.6
#endif // _COREDATADEFINES_H
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreData.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreData.framework/Headers/NSManagedObjectModel.h | /*
NSManagedObjectModel.h
Core Data
Copyright (c) 2004-2021, Apple Inc.
All rights reserved.
*/
#import <Foundation/NSArray.h>
#import <Foundation/NSDictionary.h>
#import <Foundation/NSSet.h>
NS_ASSUME_NONNULL_BEGIN
@class NSEntityDescription;
@class NSFetchRequest;
@class NSData;
@class NSBundle;
// Models describe object graphs to be managed. Models (and their entities/properties/fetch request templates) are editable until they are used by a persistent store coordinator, allowing developers to create/modify them dynamically. However, once a model is being used, it MUST NOT be changed. When the persistent store coordinator first fetches data using a model, it will become uneditable. Any attempt to mutate a model or any of its subobjects after that point will cause an exception to be thrown. If you need to modify a model that is in use, create a copy, modify the copy, and then discard the objects with the old model.
API_AVAILABLE(macosx(10.4),ios(3.0))
@interface NSManagedObjectModel : NSObject <NSCoding, NSCopying, NSFastEnumeration> {
}
+ (nullable NSManagedObjectModel *)mergedModelFromBundles:(nullable NSArray<NSBundle *> *)bundles; // looks up all models in the specified bundles and merges them; if nil is specified as argument, uses the main bundle
+ (nullable NSManagedObjectModel *)modelByMergingModels:(nullable NSArray<NSManagedObjectModel *> *)models; // combines multiple models (typically from different frameworks) into one
- (instancetype)init NS_DESIGNATED_INITIALIZER;
- (nullable instancetype)initWithContentsOfURL:(NSURL *)url;
@property (readonly, copy) NSDictionary<NSString *, NSEntityDescription *> *entitiesByName;
@property (strong) NSArray<NSEntityDescription *> *entities;
@property (readonly, strong) NSArray<NSString *> *configurations; // returns all available configuration names
- (nullable NSArray<NSEntityDescription *> *)entitiesForConfiguration:(nullable NSString *)configuration;
- (void)setEntities:(NSArray<NSEntityDescription *> *)entities forConfiguration:(NSString *)configuration;
// fetch request templates allow to pre-define queries and their parameters in the model (with the tool) - typically they contain variables that need to be substituted at runtime.
- (void)setFetchRequestTemplate:(nullable NSFetchRequest *)fetchRequestTemplate forName:(NSString *)name;
- (nullable NSFetchRequest *)fetchRequestTemplateForName:(NSString *)name;
- (nullable NSFetchRequest *)fetchRequestFromTemplateWithName:(NSString *)name substitutionVariables:(NSDictionary<NSString *, id> *)variables; // returns a copy of the fetch request template with the variable bindings substituted - this is the usual way to bind an "abstractly" defined fetch request template to a concrete fetch
/*
NSDictionary containing localized string values for entities, properties, and error strings related to this model. The key and value pattern follows:
key = "Entity/NonLocalizedEntityName"
value = "LocalizedEntityName"
// for properties of the same non-localized name in differenct entities, which should have different localized names
key = "Property/NonLocalizedPropertyName/Entity/EntityName"
value = "LocalizedPropertyName"
key = "Property/NonLocalizedPropertyName"
value = "LocalizedPropertyName"
key = "ErrorString/NonLocalizedErrorString"
value = "LocalizedErrorString"
*/
@property (nullable, strong) NSDictionary<NSString *, NSString *> *localizationDictionary;
/* Returns the managed object model used to create the store for the specified metadata. This method is a companion to the mergedModelFromBundles: method; in this case, the framework uses the version information stored in the metadata for a store to locate the models/entities used to create the store in the available bundles, and return the model. If the model for the store cannot be found, this method will return nil.
*/
+ (nullable NSManagedObjectModel *)mergedModelFromBundles:(nullable NSArray<NSBundle *> *)bundles forStoreMetadata:(NSDictionary<NSString *, id> *)metadata API_AVAILABLE(macosx(10.5),ios(3.0));
/* Returns a merged model from the specified array for the version information in the provided metadata. (This is the companion method to mergedModelFromBundles:forStoreMetadata:) If a model cannot be created to match the version information in the specified metadata, this method will return nil.
*/
+ (nullable NSManagedObjectModel *)modelByMergingModels:(NSArray<NSManagedObjectModel *> *)models forStoreMetadata:(NSDictionary<NSString *, id> *)metadata API_AVAILABLE(macosx(10.5),ios(3.0));
/* Returns the dictionary of fetch request templates, keyed by name, for the model. If the template contains a predicate with substitution variables, you should instead use fetchRequestFromTemplateWithName:substitutionVariables: to create a new fetch request.
*/
@property (readonly, copy) NSDictionary<NSString *, NSFetchRequest *> *fetchRequestTemplatesByName API_AVAILABLE(macosx(10.5),ios(3.0));
/* Returns the collection of developer-defined version identifiers for the model. For models created in Xcode, this value is set by the developer in the model inspector. Merged models return the combined collection of identifiers. This value is meant to be used as a debugging hint to help developers determine the models that were combined to create a merged model. The framework does not give models a default identifier, nor does it depend this value at runtime.
*/
@property (copy) NSSet *versionIdentifiers API_AVAILABLE(macosx(10.5),ios(3.0));
/* Compares the version information in the store metadata with the entity version of a given configuration. Returns NO if there are differences between the version information. (For information on specific differences, developers should utilize the entityVersionHashesByName method, and perform a comparison.)
*/
- (BOOL)isConfiguration:(nullable NSString *)configuration compatibleWithStoreMetadata:(NSDictionary<NSString *, id> *)metadata API_AVAILABLE(macosx(10.5),ios(3.0));
/* Returns a dictionary of the version hashes for the entities in the model, keyed by entity name. (The dictionary of version hash information is used by Core Data to determine schema compatibility.)
*/
@property (readonly, copy) NSDictionary<NSString *, NSData *> *entityVersionHashesByName API_AVAILABLE(macosx(10.5),ios(3.0));
@end
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreData.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreData.framework/Headers/NSManagedObjectID.h | /*
NSManagedObjectID.h
Core Data
Copyright (c) 2004-2021, Apple Inc.
All rights reserved.
*/
#import <Foundation/NSObject.h>
NS_ASSUME_NONNULL_BEGIN
@class NSPersistentStore;
@class NSEntityDescription;
@class NSURL;
// Managed object IDs are opaque identifiers for managed objects.
API_AVAILABLE(macosx(10.4),ios(3.0))
@interface NSManagedObjectID : NSObject <NSCopying> {
}
@property (readonly, strong) NSEntityDescription *entity; // entity for the object identified by an ID
@property (nullable, readonly, weak) NSPersistentStore *persistentStore; // persistent store that fetched the object identified by an ID
@property (getter=isTemporaryID, readonly) BOOL temporaryID; // indicates whether or not this ID will be replaced later, such as after a save operation (temporary IDs are assigned to newly inserted objects and replaced with permanent IDs when an object is written to a persistent store); most IDs return NO
- (NSURL *)URIRepresentation; // URI which provides an archivable reference to the object which this ID refers
@end
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreData.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreData.framework/Headers/NSAtomicStoreCacheNode.h | /*
NSAtomicStoreCacheNode.h
Core Data
Copyright (c) 2004-2021, Apple Inc.
All rights reserved.
*/
#import <Foundation/NSArray.h>
#import <Foundation/NSDictionary.h>
#import <Foundation/NSSet.h>
#import <Foundation/NSString.h>
#import <Foundation/NSError.h>
#import <Foundation/NSURL.h>
#import <CoreData/NSManagedObjectID.h>
#import <CoreData/NSManagedObject.h>
NS_ASSUME_NONNULL_BEGIN
@class NSEntityDescription;
API_AVAILABLE(macosx(10.5),ios(3.0))
@interface NSAtomicStoreCacheNode : NSObject {
}
/* The designated initializer for the cache node. */
- (instancetype)initWithObjectID:(NSManagedObjectID *)moid;
/* Returns the managed object ID for the cache node. */
@property (nonatomic, readonly, strong) NSManagedObjectID *objectID;
/* Returns the property cache dictionary for the cache node. This dictionary is used by -valueForKey: and -setValue:forKey: for property values. The default implementation will return nil unless the companion -setPropertyCache: method is invoked, or -setValue:forKey: is invoked on the cache node with non-nil property values.
*/
@property (nullable, nonatomic, strong) NSMutableDictionary<NSString *, id> *propertyCache;
/* Returns the value for the specified key. Subclasses must return the appropriate object value for all property keys (as specified by the names of the NSPropertyDescriptions for the entity of this cache node.) For attributes, these are instances of NSObject; for to-one relationships, the return value must be another cache node instance; for a to-many relationship, the return value must be an NSSet of the related cache nodes.
The default implementation forwards the request to the -propertyCache dictionary if the key matches a property name of the entity for the cache node. If the key does not represent a property, the standard -valueForKey: implementation will be used.
*/
- (nullable id)valueForKey:(NSString*)key;
/* Sets the value for the specified key. The default implementation forwards the request to the -propertyCache dictionary if the key matches a property name of the entity for this cache node. If the key does not represent a property, the standard -setValue:forKey: implementation will be used.
*/
- (void)setValue:(nullable id)value forKey:(NSString*)key;
@end
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreData.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreData.framework/Headers/NSIncrementalStore.h | /*
NSIncrementalStore.h
Core Data
Copyright (c) 2009-2021, Apple Inc.
All rights reserved.
*/
#import <Foundation/NSArray.h>
#import <CoreData/NSPersistentStore.h>
#import <CoreData/NSPersistentStoreRequest.h>
NS_ASSUME_NONNULL_BEGIN
@class NSManagedObjectContext;
@class NSManagedObjectID;
@class NSManagedObject;
@class NSRelationshipDescription;
@class NSIncrementalStoreNode;
@class NSEntityDescription;
// Abstract class defining the API through which Core Data communicates with a store.
// This API is designed to allow users to create persistent stores which load and save
// data incrementally, allowing for the management of large and/or shared datasets.
API_AVAILABLE(macosx(10.7),ios(5.0))
@interface NSIncrementalStore : NSPersistentStore {
}
// CoreData expects loadMetadata: to validate that the URL used to create the store is usable
// (location exists, is writable (if applicable), schema is compatible, etc) and return an
// error if there is an issue.
// Any subclass of NSIncrementalStore which is file-based must be able to handle being initialized
// with a URL pointing to a zero-length file. This serves as an indicator that a new store is to be
// constructed at the specified location and allows applications using the store to securly create
// reservation files in known locations.
-(BOOL)loadMetadata:(NSError **)error;
// API methods that must be overriden by a subclass:
// Return a value as appropriate for the request, or nil if the request cannot be completed.
// If the request is a fetch request whose result type is set to one of NSManagedObjectResultType,
// NSManagedObjectIDResultType, NSDictionaryResultType, return an array containing all objects
// in the store matching the request.
// If the request is a fetch request whose result type is set to NSCountResultType, return an
// array containing an NSNumber of all objects in the store matching the request.
// If the request is a save request, the result should be an empty array. Note that
// save requests may have nil inserted/updated/deleted/locked collections; this should be
// treated as a request to save the store metadata.
// Note that subclasses of NSIncrementalStore should implement this method conservatively,
// and expect that unknown request types may at some point be passed to the
// method. The correct behavior in these cases would be to return nil and an error.
- (nullable id)executeRequest:(NSPersistentStoreRequest *)request withContext:(nullable NSManagedObjectContext*)context error:(NSError **)error;
// Returns an NSIncrementalStoreNode encapsulating the persistent external values for the object for an objectID.
// It should include all attributes values and may include to-one relationship values as NSManagedObjectIDs.
// Should return nil and set the error if the object cannot be found.
- (nullable NSIncrementalStoreNode *)newValuesForObjectWithID:(NSManagedObjectID*)objectID withContext:(NSManagedObjectContext*)context error:(NSError**)error;
// Returns the relationship for the given relationship on the object with ID objectID. If the relationship
// is a to-one it should return an NSManagedObjectID corresponding to the destination or NSNull if the relationship value is nil.
// If the relationship is a to-many, should return an NSSet or NSArray containing the NSManagedObjectIDs of the related objects.
// Should return nil and set the error if the source object cannot be found.
- (nullable id)newValueForRelationship:(NSRelationshipDescription*)relationship forObjectWithID:(NSManagedObjectID*)objectID withContext:(nullable NSManagedObjectContext *)context error:(NSError **)error;
// API methods that may be overriden:
+ (id)identifierForNewStoreAtURL:(NSURL*)storeURL;
// Called before executeRequest with a save request, to assign permanent IDs to newly inserted objects;
// must return the objectIDs in the same order as the objects appear in array.
- (nullable NSArray<NSManagedObjectID *> *)obtainPermanentIDsForObjects:(NSArray<NSManagedObject *> *)array error:(NSError **)error;
// Inform the store that the objects with ids in objectIDs are in use in a client NSManagedObjectContext
- (void)managedObjectContextDidRegisterObjectsWithIDs:(NSArray<NSManagedObjectID *> *)objectIDs;
// Inform the store that the objects with ids in objectIDs are no longer in use in a client NSManagedObjectContext
- (void)managedObjectContextDidUnregisterObjectsWithIDs:(NSArray<NSManagedObjectID *> *)objectIDs;
// API utility methods that should not be overriden (implemented by NSIncrementalStore):
// Returns a new objectID with retain count 1 that uses data as the key.
- (NSManagedObjectID *)newObjectIDForEntity:(NSEntityDescription *)entity referenceObject:(id)data;
// Returns the reference data used to construct the objectID. Will raise an NSInvalidArgumentException if the objectID was not created
// by this store.
- (id)referenceObjectForObjectID:(NSManagedObjectID *)objectID;
@end
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreData.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreData.framework/Headers/NSFetchRequestExpression.h | /*
NSFetchRequestExpression.h
Core Data
Copyright (c) 2006-2021, Apple Inc.
All rights reserved.
*/
#import <Foundation/NSArray.h>
#import <Foundation/NSDictionary.h>
#import <Foundation/NSExpression.h>
NS_ASSUME_NONNULL_BEGIN
static const NSExpressionType NSFetchRequestExpressionType = (NSExpressionType)50;
API_AVAILABLE(macosx(10.5),ios(3.0))
@interface NSFetchRequestExpression : NSExpression {
}
/* Returns an expression which will evaluate to the result of executing a fetch request on a context. The first argument must be an expression which evaluates to an NSFetchRequest *, and the second must be an expression which evaluates to an NSManagedObjectContext *. If the desired result is simply the count for the request, the "countOnly" argument should be YES.
*/
+ (NSExpression*)expressionForFetch:(NSExpression*)fetch context:(NSExpression*)context countOnly:(BOOL)countFlag;
/* Returns the expression for the fetch request: evaluating it must return an NSFetchRequest *.
*/
@property (readonly, strong) NSExpression *requestExpression;
/* Returns the expression for the managed object context: evaluating it must return an NSManagedObjectContext *.
*/
@property (readonly, strong) NSExpression *contextExpression;
/* Boolean indicating if the request will return object values or merely the count. If the value returns NO, the managed object context (from the contextExpression) will perform executeFetchRequest:error: with the requestExpression; if the value returns YES, the managed object context will perform countForFetchRequest:error with the requestExpression.
*/
@property (getter=isCountOnlyRequest, readonly) BOOL countOnlyRequest;
@end
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreData.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreData.framework/Headers/NSAtomicStore.h | /*
NSAtomicStore.h
Core Data
Copyright (c) 2004-2021, Apple Inc.
All rights reserved.
*/
#import <Foundation/NSArray.h>
#import <Foundation/NSDictionary.h>
#import <Foundation/NSSet.h>
#import <Foundation/NSString.h>
#import <Foundation/NSError.h>
#import <Foundation/NSURL.h>
#import <CoreData/NSPersistentStore.h>
#import <CoreData/NSAtomicStoreCacheNode.h>
#import <CoreData/NSManagedObject.h>
NS_ASSUME_NONNULL_BEGIN
@class NSPersistentStoreCoordinator;
@class NSEntityDescription;
@class NSManagedObjectID;
API_AVAILABLE(macosx(10.5),ios(3.0))
@interface NSAtomicStore : NSPersistentStore {
}
// API method that may be overriden by subclasses for custom initialization
- (instancetype)initWithPersistentStoreCoordinator:(nullable NSPersistentStoreCoordinator *)coordinator configurationName:(nullable NSString *)configurationName URL:(NSURL *)url options:(nullable NSDictionary *)options;
// API method that must be overriden by subclasses
- (BOOL)load:(NSError **)error;
// API method that must be overriden by subclasses
- (BOOL)save:(NSError **)error;
// API method that must be overriden by subclasses
- (NSAtomicStoreCacheNode *)newCacheNodeForManagedObject:(NSManagedObject *)managedObject;
// API method that must be overriden by subclasses
- (void)updateCacheNode:(NSAtomicStoreCacheNode *)node fromManagedObject:(NSManagedObject *)managedObject;
// Utility method with implementation provided by NSAtomicStore
- (NSSet<__kindof NSAtomicStoreCacheNode *> *)cacheNodes;
// Utility method with implementation provided by NSAtomicStore
- (void)addCacheNodes:(NSSet<__kindof NSAtomicStoreCacheNode *> *)cacheNodes;
// Called before cache nodes are removed
- (void)willRemoveCacheNodes:(NSSet<__kindof NSAtomicStoreCacheNode *> *)cacheNodes;
// Utility method with implementation provided by NSAtomicStore
- (nullable NSAtomicStoreCacheNode *)cacheNodeForObjectID:(NSManagedObjectID *)objectID;
// Utility method with implementation provided by NSAtomicStore
- (NSManagedObjectID *)objectIDForEntity:(NSEntityDescription *)entity referenceObject:(id)data;
// This method MUST return a new unique primary key reference data for an instance of entity. This
// primary key value MUST be an id
// API method that must be overriden by subclasses
- (id)newReferenceObjectForManagedObject:(NSManagedObject *)managedObject;
// Utility method with implementation provided by NSAtomicStore
- (id)referenceObjectForObjectID:(NSManagedObjectID *)objectID;
@end
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreData.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreData.framework/Headers/NSFetchIndexElementDescription.h | /*
NSFetchIndexElementDescription.h
Core Data
Copyright (c) 2017-2021, Apple Inc.
All rights reserved.
*/
#import <Foundation/NSArray.h>
#import <Foundation/NSString.h>
@class NSPropertyDescription;
@class NSFetchIndexDescription;
NS_ASSUME_NONNULL_BEGIN
typedef NS_ENUM(NSUInteger, NSFetchIndexElementType) {
NSFetchIndexElementTypeBinary,
NSFetchIndexElementTypeRTree,
} API_AVAILABLE(macosx(10.13),ios(11.0),tvos(11.0),watchos(4.0));
API_AVAILABLE(macosx(10.13),ios(11.0),tvos(11.0),watchos(4.0))
@interface NSFetchIndexElementDescription : NSObject <NSCoding,NSCopying> {
}
- (instancetype)initWithProperty:(NSPropertyDescription*)property collationType:(NSFetchIndexElementType)collationType;
/* This may be an NSExpressionDescription that expresses a function */
@property (readonly, nullable, retain) NSPropertyDescription *property;
@property (readonly, nullable, retain) NSString *propertyName;
/* Default NSIndexTypeBinary */
@property NSFetchIndexElementType collationType;
/* Default YES. Control whether this is an ascending or descending index for indexes which support direction. */
@property (getter=isAscending) BOOL ascending;
@property (readonly, nonatomic, nullable, assign) NSFetchIndexDescription *indexDescription;
@end
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreData.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreData.framework/Headers/NSPersistentStore.h | /*
NSPersistentStore.h
Core Data
Copyright (c) 2004-2021, Apple Inc.
All rights reserved.
*/
#import <Foundation/NSArray.h>
#import <Foundation/NSDictionary.h>
#import <Foundation/NSSet.h>
#import <Foundation/NSString.h>
#import <Foundation/NSError.h>
#import <Foundation/NSURL.h>
NS_ASSUME_NONNULL_BEGIN
@class NSManagedObjectID;
@class NSManagedObjectModel;
@class NSManagedObjectContext;
@class NSPersistentStore;
@class NSPersistentStoreRequest;
@class NSPersistentStoreCoordinator;
@class NSCoreDataCoreSpotlightDelegate;
API_AVAILABLE(macosx(10.5),ios(3.0))
@interface NSPersistentStore : NSObject {
}
/* Get metadata from the persistent store at url. Must be overriden by subclasses.
Subclasses should validate that the URL is the type of URL they are expecting, and
should verify that the file contents are appropriate for the store type before
attempting to read from it. This method should never raise an exception.
*/
+ (nullable NSDictionary<NSString *, id> *)metadataForPersistentStoreWithURL:(NSURL *)url error:(NSError **)error;
/* Set the medatada of the store at url to metadata. Must be overriden by subclasses. */
+ (BOOL)setMetadata:(nullable NSDictionary<NSString *, id> *)metadata forPersistentStoreWithURL:(NSURL*)url error:(NSError **)error;
/* Returns the NSMigrationManager class optimized for this store class. Subclasses of NSPersistentStore can override this to provide a custom migration manager subclass (eg to take advantage of store-specific functionality to improve migration performance).
*/
+ (Class)migrationManagerClass API_AVAILABLE(macosx(10.6),ios(3.0));
/* the designated initializer for object stores. */
- (instancetype)initWithPersistentStoreCoordinator:(nullable NSPersistentStoreCoordinator *)root configurationName:(nullable NSString *)name URL:(NSURL *)url options:(nullable NSDictionary *)options NS_DESIGNATED_INITIALIZER;
- (instancetype)init NS_UNAVAILABLE;
/* Store metadata must be accessible before -load: is called, but there is no way to return an error if the store is invalid
*/
-(BOOL)loadMetadata:(NSError **)error;
/* the bridge between the control & access layers. */
@property (nullable, nonatomic, readonly, weak) NSPersistentStoreCoordinator *persistentStoreCoordinator;
@property (readonly, copy) NSString *configurationName; // Which configuration does this store contain
@property (nullable, readonly, strong) NSDictionary *options; // the options the store was initialized with
@property (nullable, strong) NSURL *URL;
@property (null_resettable, copy) NSString *identifier;
@property (readonly, copy) NSString *type; // stores always know their type
@property (getter=isReadOnly) BOOL readOnly; // Do we know a priori the store is read only?
@property (null_resettable, nonatomic, strong) NSDictionary<NSString *, id> *metadata; // includes store type and UUID
// Gives the store a chance to do any post-init work that's necessary
- (void)didAddToPersistentStoreCoordinator:(NSPersistentStoreCoordinator *)coordinator;
// Gives the store a chance to do any non-dealloc teardown (for example, closing a network connection)
// before removal.
- (void)willRemoveFromPersistentStoreCoordinator:(nullable NSPersistentStoreCoordinator *)coordinator;
/* Return the Core Spotlight exporter if one exists for this store. The exporter
can be set as part of the store options when it is added to the coordinator. */
@property (nonatomic, readonly) NSCoreDataCoreSpotlightDelegate *coreSpotlightExporter API_AVAILABLE(macosx(10.13),ios(11.0)) API_UNAVAILABLE(tvos,watchos);
@end
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreData.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreData.framework/Modules/module.modulemap | framework module CoreData [extern_c] [system] {
umbrella header "CoreData.h"
exclude header "CoreData_CloudKit.h"
exclude header "NSPersistentCloudKitContainer_Sharing.h"
module * {
export *
}
}
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/CoreServices.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: B341B5E6-CF4F-3EF9-941A-F73D01DC1F99
- target: x86_64-maccatalyst
value: B341B5E6-CF4F-3EF9-941A-F73D01DC1F99
- target: arm64-macos
value: 00000000-0000-0000-0000-000000000000
- target: arm64-maccatalyst
value: 00000000-0000-0000-0000-000000000000
- target: arm64e-macos
value: A8F69963-342C-36F3-8393-E7C3098CC266
- target: arm64e-maccatalyst
value: A8F69963-342C-36F3-8393-E7C3098CC266
install-name: '/System/Library/Frameworks/CoreServices.framework/Versions/A/CoreServices'
current-version: 1141.1
exports:
- targets: [ x86_64-maccatalyst, x86_64-macos, arm64e-maccatalyst, arm64e-macos,
arm64-macos, arm64-maccatalyst ]
symbols: [ _CoreServicesVersionNumber, _CoreServicesVersionString ]
reexports:
- targets: [ x86_64-maccatalyst, x86_64-macos ]
symbols: [ __FE_DFL_DISABLE_SSE_DENORMS_ENV, ___inf, '_exp2$fenv_access_off',
'_fdim$fenv_access_off', _fegetexcept, _fesetexcept, '_fmax$fenv_access_off',
'_fmin$fenv_access_off', '_log2$fenv_access_off', '_modff$fenv_access_off',
_nextafterd, '_remquo$fenv_access_off' ]
- targets: [ x86_64-maccatalyst, x86_64-macos, arm64e-maccatalyst, arm64e-macos,
arm64-macos, arm64-maccatalyst ]
symbols: [ __FE_DFL_ENV, _exp2, _fdim, _feclearexcept, _fegetenv, _fegetround,
_feholdexcept, _feraiseexcept, _fesetenv, _fesetround, _fetestexcept,
_feupdateenv, _fmax, _fmin, _log2, _modff, _nan, _nanf, _nextafterf,
_remquo ]
--- !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: 3F027CDA-3649-35AB-A3BF-CE76CDB6192A
- target: x86_64-maccatalyst
value: 3F027CDA-3649-35AB-A3BF-CE76CDB6192A
- target: arm64-macos
value: 00000000-0000-0000-0000-000000000000
- target: arm64-maccatalyst
value: 00000000-0000-0000-0000-000000000000
- target: arm64e-macos
value: EC2CC19C-A2FA-37CD-9664-DF8F9947D367
- target: arm64e-maccatalyst
value: EC2CC19C-A2FA-37CD-9664-DF8F9947D367
install-name: '/System/Library/Frameworks/CoreServices.framework/Versions/A/Frameworks/AE.framework/Versions/A/AE'
current-version: 924
compatibility-version: 0
parent-umbrella:
- targets: [ x86_64-macos, x86_64-maccatalyst, arm64-macos, arm64-maccatalyst,
arm64e-macos, arm64e-maccatalyst ]
umbrella: CoreServices
allowable-clients:
- targets: [ x86_64-macos, x86_64-maccatalyst, arm64-macos, arm64-maccatalyst,
arm64e-macos, arm64e-maccatalyst ]
clients: [ DesktopServices, Foundation, HIServices, LaunchServices, PrintCore ]
exports:
- targets: [ x86_64-maccatalyst, x86_64-macos, arm64e-maccatalyst, arm64e-macos,
arm64-macos, arm64-maccatalyst ]
symbols: [ _AEBuildAppleEvent, _AEBuildDesc, _AEBuildParameters, _AECallObjectAccessor,
_AECheckIsRecord, _AECoerceDesc, _AECoercePtr, _AECoercionHandlersApplyFunction,
_AECompareDesc, _AEConvertFromMsg, _AECountItems, _AECreateAppleEvent,
_AECreateDesc, _AECreateDescFromExternalPtr, _AECreateList,
_AECreateRemoteProcessResolver, _AEDecodeMessage, _AEDeleteItem,
_AEDeleteParam, _AEDescribeDesc, _AEDeterminePermissionToAutomateTarget,
_AEDispatchEvent, _AEDisposeDesc, _AEDisposeRemoteProcessResolver,
_AEDisposeToken, _AEDuplicateDesc, _AEEventHandlersApplyFunction,
_AEFlattenDesc, _AEGetArray, _AEGetAttributeDesc, _AEGetAttributePtr,
_AEGetCoercionHandler, _AEGetDescData, _AEGetDescDataRange,
_AEGetDescDataSize, _AEGetEventHandler, _AEGetNthDesc, _AEGetNthPtr,
_AEGetObjectAccessor, _AEGetParamDesc, _AEGetParamPtr, _AEGetRegisteredMachPort,
_AEGetSpecialHandler, _AEInitializeDesc, _AEInstallCoercionHandler,
_AEInstallEventHandler, _AEInstallObjectAccessor, _AEInstallSpecialHandler,
_AEInstallSystemDispatcher, _AEManagerInfo, _AEObjectInit,
_AEPrintDescToHandle, _AEProcessMessage, _AEPutArray, _AEPutAttributeDesc,
_AEPutAttributePtr, _AEPutDesc, _AEPutParamDesc, _AEPutParamPtr,
_AEPutPtr, _AEReceiveFromMach, _AERemoteProcessResolverGetProcesses,
_AERemoteProcessResolverScheduleWithRunLoop, _AERemoveCoercionHandler,
_AERemoveEventHandler, _AERemoveObjectAccessor, _AERemoveSpecialHandler,
_AEReplaceDescData, _AEResolve, _AESendMessage, _AESendWithMach,
_AESetObjectCallbacks, _AESizeOfAttribute, _AESizeOfFlattenedDesc,
_AESizeOfNthItem, _AESizeOfParam, _AEStreamClose, _AEStreamCloseDesc,
_AEStreamCloseList, _AEStreamCloseRecord, _AEStreamCreateEvent,
_AEStreamOpen, _AEStreamOpenDesc, _AEStreamOpenEvent, _AEStreamOpenKeyDesc,
_AEStreamOpenList, _AEStreamOpenRecord, _AEStreamOptionalParam,
_AEStreamSetRecordType, _AEStreamWriteAEDesc, _AEStreamWriteData,
_AEStreamWriteDesc, _AEStreamWriteKey, _AEStreamWriteKeyDesc,
_AEUnflattenDesc, _AEUnflattenDescFromBytes, _CreateCompDescriptor,
_CreateLogicalDescriptor, _CreateObjSpecifier, _CreateOffsetDescriptor,
_CreateRangeDescriptor, _GDBPrintAECoercionTables, _GDBPrintAEDesc,
_GDBPrintAEHandlerTables, _GDBPrintHelpDebuggingAppleEvents,
__AEAddAnnotationsToAppleEvent, __AEAppleEventMergeAnnotations,
__AECanSandboxedApplicationSendAppleEvent, __AECopyEntitlementForToken,
__AECopyRegisteredMachPort, __AECreateAEReceiveMachPort, __AECreateAEReceivePortInRunLoopWithSource,
__AECreateAnnotatedAppleEvent, __AEDescEventGetCounts, __AEDescEventIndexedAttributeItem,
__AEDescEventIndexedParamItem, __AEDescGetAsString, __AEDescInformation,
__AEDescListGetCount, __AEDescListIndexedItem, __AEDescRecordGetCount,
__AEDescRecordIndexedItem, __AEDescToInternalImpl, __AEDoesAppleEventContainAnyTypesWhichRequireAnnotation,
__AEEventDescGetInformation, __AEEventRequiresSecurityHandlerChecks,
__AEEventSecurityHandlerDoChecks, __AEGenerateAnnotations,
__AEInstallAEInteractWithUserCallback, __AEInstallEventHandlerBlock,
__AEInstallEventSecurityHandler, __AEInstallEventSecurityHandlerBlock,
__AEIsAppleEventTargetInSandbox, __AERegisterCurrentApplicationInfomationWithAppleEventsD,
__AERemoveAEReceivePort, __AERemoveEventSecurityHandler, __AEUnflattenDescFromBytes,
__AppleEventsCheckInApp, __AppleEventsCheckInAppWithBlock,
__AppleEventsCopyApplicationEntitlements, __AppleEventsCopyApplicationEntitlementsWithBlock,
__AppleEventsCopyStatusString, __AppleEventsCopyStatusStringWithBlock,
__AppleEventsForwardEntitlements, __AppleEventsForwardEntitlementsWithBlock,
__AppleEventsHintApp, __AppleEventsHintAppWithBlock, __AppleEventsListApplications,
__AppleEventsListApplicationsWithBlock, __AppleEventsLookupApplicationPort,
__AppleEventsLookupApplicationPortWithBlock, __AppleEventsReleaseProcessAssertion,
__AppleEventsReleaseProcessAssertionWithBlock, __AppleEventsRequestProcessAssertion,
__AppleEventsRequestProcessAssertionWithBlock, __AppleEventsSendPortRequiresProcessAssertions,
__kAppleEventsScriptingEntitlementKey, _aeAddFilter, _aeAppendToImplEnd,
_aeBindToArbitraryMachPort, _aeCheckMessage, _aeCheckinApp,
_aeClassicCompatFlattenDesc, _aeClassicCompatSizeOfFlattenedDesc,
_aeConvertCarbonToClassic, _aeConvertClassicToCarbon, _aeCreateBuffer,
_aeCreateDefaultReply, _aeDecodeMachMsg, _aeDescToCFStringCopy,
_aeDescToCFTypeCopy, _aeEventToEppcMsg, _aeGetInteractionAllowed,
_aeGetTheCurrentEvent, _aeHintApp, _aeInitializeFromHIToolbox,
_aeInstallBulk, _aeInstallRunLoopDispatcher, _aeInteractWithUser,
_aeMakeMeta, _aeProcessAppleEvent, _aePushHighLevelEvent,
_aeReconstructAppleEvent, _aeReconstructReplyAppleEvent, _aeRemoveFromImplEnd,
_aeResetTimer, _aeResumeTheCurrentEvent, _aeRmvFilter, _aeSend,
_aeSetInteractionAllowed, _aeSetTheCurrentEvent, _aeSimpleMunger,
_aeSuspendTheCurrentEvent, _kAERemoteProcessNameKey, _kAERemoteProcessProcessIDKey,
_kAERemoteProcessURLKey, _kAERemoteProcessUserIDKey, _pushHighLevelEvent,
_vAEBuildAppleEvent, _vAEBuildDesc, _vAEBuildParameters ]
--- !tapi-tbd
tbd-version: 4
targets: [ x86_64-macos, arm64-macos, arm64e-macos ]
uuids:
- target: x86_64-macos
value: 4C2E47F2-D99C-3E03-9232-C1DEF4CBA716
- target: arm64-macos
value: 00000000-0000-0000-0000-000000000000
- target: arm64e-macos
value: 0A1D27BA-29DA-3CA5-8A1F-27C86D8B7D89
install-name: '/System/Library/Frameworks/CoreServices.framework/Versions/A/Frameworks/CarbonCore.framework/Versions/A/CarbonCore'
current-version: 1319
parent-umbrella:
- targets: [ x86_64-macos, arm64-macos, arm64e-macos ]
umbrella: CoreServices
allowable-clients:
- targets: [ x86_64-macos, arm64-macos, arm64e-macos ]
clients: [ AudioToolbox, Foundation, Metadata ]
exports:
- targets: [ x86_64-macos, arm64e-macos, arm64-macos ]
symbols: [ _AbsoluteDeltaToDuration, _AbsoluteDeltaToNanoseconds, _AbsoluteToDuration,
_AbsoluteToNanoseconds, _AddAbsoluteToAbsolute, _AddAtomic,
_AddAtomic16, _AddAtomic8, _AddCollectionItem, _AddCollectionItemHdl,
_AddDurationToAbsolute, _AddFolderDescriptor, _AddNanosecondsToAbsolute,
_AddResource, _BitAnd, _BitAndAtomic, _BitAndAtomic16, _BitAndAtomic8,
_BitClr, _BitNot, _BitOr, _BitOrAtomic, _BitOrAtomic16, _BitOrAtomic8,
_BitSet, _BitShift, _BitTst, _BitXor, _BitXorAtomic, _BitXorAtomic16,
_BitXorAtomic8, _CLVGetConstantString, _CLVHup, _CLVVisitValuesForKey,
_CSBackupDestinationCopySnapshotDates, _CSBackupDestinationGetDestinationID,
_CSBackupDestinationGetTypeID, _CSBackupIsItemExcluded, _CSBackupMobileIteratorCreate,
_CSBackupMobileIteratorCreateWithOptions, _CSBackupMobileIteratorGetNextURL,
_CSBackupMobileIteratorGetNextURLWithFlags, _CSBackupMobileIteratorGetTypeID,
_CSBackupMobileIteratorSkipDescendents, _CSBackupSetItemExcluded,
_CSBackupWalkCurrentBackup, _CSCopyMachineName, _CSCopyUserName,
_CSDiskSpaceCancelRecovery, _CSDiskSpaceGetRecoveryEstimate,
_CSDiskSpaceStartRecovery, _CSGetComponentsThreadMode, _CSMemDisposeHandle,
_CSMemDisposePtr, _CSMemEmptyHandle, _CSMemGetHandleSize,
_CSMemGetPtrSize, _CSMemHGetState, _CSMemHSetState, _CSMemHandAndHand,
_CSMemHandToHand, _CSMemMunger, _CSMemNewEmptyHandle, _CSMemNewHandle,
_CSMemNewHandleClear, _CSMemNewHandleFromExternalPtr, _CSMemNewPtr,
_CSMemNewPtrClear, _CSMemPtrAndHand, _CSMemPtrToHand, _CSMemPtrToXHand,
_CSMemReallocateHandle, _CSMemRecoverHandle, _CSMemSetHandleSize,
_CSMemSetPtrSize, _CSRefCreateInstance, _CSRefRelease, _CSRefReleaseCallbackForCF,
_CSRefRetain, _CSRefRetainCallbackForCF, _CSSetComponentsThreadMode,
_CallComponent, _CallComponentCanDo, _CallComponentClose,
_CallComponentDispatch, _CallComponentFunction, _CallComponentFunctionWithStorage,
_CallComponentFunctionWithStorageProcInfo, _CallComponentFunctionWithStorageProcInfo_TVector,
_CallComponentGetMPWorkFunction, _CallComponentGetPublicResource,
_CallComponentOpen, _CallComponentRegister, _CallComponentTarget,
_CallComponentUnregister, _CallComponentVersion, _CallThreadInitHooks,
_CaptureComponent, _CarbonCoreGetMainRunLoop, _ChangeTextToUnicodeInfo,
_ChangeUnicodeToTextInfo, _ChangedResource, _CharacterByteType,
_CharacterType, _ClassicVolumeGetStartupInfo, _ClearIntlResourceCache,
_ClearStackList, _CloneCollection, _CloseComponent, _CloseComponentResFile,
_CloseResFile, _CollectionTagExists, _CompareAndSwap, _CompareString,
_CompareText, _CompleteFolderRouting, _ConvertFromPStringToUnicode,
_ConvertFromTextToUnicode, _ConvertFromTextToUnicodeNoInit,
_ConvertFromUnicodeToPString, _ConvertFromUnicodeToScriptCodeRun,
_ConvertFromUnicodeToText, _ConvertFromUnicodeToTextNoInit,
_ConvertFromUnicodeToTextRun, _ConvertLocalTimeToUTC, _ConvertLocalToUTCDateTime,
_ConvertUTCToLocalDateTime, _ConvertUTCToLocalTime, _CopyCollection,
_CopyP2CStr, _CoreEndianFlipData, _CoreEndianGetFlipper, _CoreEndianGetFlipperFromTables,
_CoreEndianGetFlipperFromTablesForUTI, _CoreEndianInstallFlipper,
_Count1Resources, _Count1Types, _CountCollectionItems, _CountCollectionOwners,
_CountCollectionTags, _CountComponentInstances, _CountComponents,
_CountResources, _CountStackListElements, _CountTaggedCollectionItems,
_CountTypes, _CountUnicodeMappings, _CountUnicodeMappingsNoInit,
_CreateTextEncoding, _CreateTextToUnicodeInfo, _CreateTextToUnicodeInfoByEncoding,
_CreateTextToUnicodeInfoNoInit, _CreateThreadPool, _CreateUSetForKCHR,
_CreateUnicodeToTextInfo, _CreateUnicodeToTextInfoByEncoding,
_CreateUnicodeToTextInfoNoInit, _CreateUnicodeToTextRunInfo,
_CreateUnicodeToTextRunInfoByEncoding, _CreateUnicodeToTextRunInfoByScriptCode,
_CurResFile, _DTCurrentContextIsDeferredTask, _DebugAssert,
_DebugCStr, _DebugDumpGestalt, _DebugGestalt, _DebugGestaltStr,
_DebugLogEntry, _DebugPrint, _DebugStr, _Debugger, _DeclineVolumeNotification,
_DeclineVolumeNotificationWithFlags, _DecrementAtomic, _DecrementAtomic16,
_DecrementAtomic8, _Delay, _DelegateComponentCall, _DeleteGestaltValue,
_Dequeue, _DestroyComponent, _DetachHandleFromExternalPtr,
_DetachResource, _DetachResourceFile, _DetermineIfPathIsEnclosedByFolder,
_DisposeCollection, _DisposeComponentFunctionUPP, _DisposeDebugComponent,
_DisposeDebugLog, _DisposeHandle, _DisposePtr, _DisposeStackList,
_DisposeTextToUnicodeInfo, _DisposeTextToUnicodeInfoNoInit,
_DisposeThread, _DisposeThreadInitHookUPP, _DisposeUnicodeToTextInfo,
_DisposeUnicodeToTextInfoNoInit, _DisposeUnicodeToTextRunInfo,
_DisposeVNUPP, _DurationToAbsolute, _DurationToNanoseconds,
_EmptyCollection, _EmptyHandle, _Endian64_Swap, _Enqueue,
_EqualString, _ErrorTranslate, _ExtendedToString, _FIDDumpFileIDMap,
_FIDListFileIDMaps, _FNGetDirectoryForSubscription, _FNNotify,
_FNNotifyAll, _FNNotifyByPath, _FNSubscribe, _FNSubscribeByPath,
_FNUnsubscribe, _FSAllocateFork, _FSCancelVolumeOperation,
_FSCatalogSearch, _FSCloseFork, _FSCloseIterator, _FSCompareFSRefs,
_FSCopyAliasInfo, _FSCopyDADiskForVolume, _FSCopyDiskIDForVolume,
_FSCopyExtendedAttribute, _FSCopyExtendedAttributeByForkRefNum,
_FSCopyExtendedAttributeList, _FSCopyExtendedAttributeListByForkRefNum,
_FSCopyObjectAsync, _FSCopyObjectAsyncWithCallbacks, _FSCopyObjectSync,
_FSCopyURLForVolume, _FSCreateDirectoryUnicode, _FSCreateFileAndOpenForkUnicode,
_FSCreateFileUnicode, _FSCreateFork, _FSCreateResFile, _FSCreateResourceFile,
_FSCreateResourceFork, _FSCreateStringFromHFSUniStr, _FSCreateVolumeOperation,
_FSDeleteFork, _FSDeleteObject, _FSDetermineIfRefIsEnclosedByFolder,
_FSDisposeVolumeOperation, _FSEjectVolumeAsync, _FSEjectVolumeSync,
_FSExchangeObjects, _FSFileOperationCancel, _FSFileOperationCopyStatus,
_FSFileOperationCreate, _FSFileOperationGetTypeID, _FSFileOperationScheduleWithRunLoop,
_FSFileOperationUnscheduleFromRunLoop, _FSFileSecurityCopyAccessControlList,
_FSFileSecurityCreate, _FSFileSecurityCreateWithFSPermissionInfo,
_FSFileSecurityGetGroup, _FSFileSecurityGetGroupUUID, _FSFileSecurityGetMode,
_FSFileSecurityGetOwner, _FSFileSecurityGetOwnerUUID, _FSFileSecurityGetTypeID,
_FSFileSecurityRefCreateCopy, _FSFileSecuritySetAccessControlList,
_FSFileSecuritySetGroup, _FSFileSecuritySetGroupUUID, _FSFileSecuritySetMode,
_FSFileSecuritySetOwner, _FSFileSecuritySetOwnerUUID, _FSFindFolder,
_FSFlushFork, _FSFlushVolume, _FSFollowFinderAlias, _FSGetAsyncEjectStatus,
_FSGetAsyncMountStatus, _FSGetAsyncUnmountStatus, _FSGetCanonicalPath,
_FSGetCatalogInfo, _FSGetCatalogInfoBulk, _FSGetDataForkName,
_FSGetDefaultTextEncoding, _FSGetForkCBInfo, _FSGetForkPosition,
_FSGetForkSize, _FSGetHFSUniStrFromString, _FSGetResourceForkName,
_FSGetTemporaryDirectoryForReplaceObject, _FSGetVolumeForDADisk,
_FSGetVolumeForDiskID, _FSGetVolumeInfo, _FSGetVolumeMountInfo,
_FSGetVolumeMountInfoSize, _FSGetVolumeParent, _FSGetVolumeParms,
_FSIsAliasFile, _FSIsFSRefValid, _FSIterateForks, _FSLockRange,
_FSMakeFSRefUnicode, _FSMatchAliasBulk, _FSMountCopyIOMediaIconBundleIdentifier,
_FSMountCopyIOMediaIconFamilyName, _FSMountDestroy, _FSMountGetCapabilities,
_FSMountGetFSID, _FSMountGetIOBlockSize, _FSMountGetMaxFileSize,
_FSMountGetMountID, _FSMountGetMountPoint, _FSMountGetMutableVolumeInfo,
_FSMountGetSpecialDeviceType, _FSMountGetVolumeCreationDate,
_FSMountGetVolumeFlags, _FSMountGetVolumeName, _FSMountGetVolumeUUID,
_FSMountLocalVolumeAsync, _FSMountLocalVolumeSync, _FSMountMakepath,
_FSMountMountIDToVRefNum, _FSMountPrepare, _FSMountPrepareWithMountPointString,
_FSMountRenameVolume, _FSMountServerVolumeAsync, _FSMountServerVolumeSync,
_FSMountSetProperty, _FSMountStorageSize, _FSMountUpdateCaseInsensitiveName,
_FSMountVCBVRefNum, _FSMoveObject, _FSMoveObjectAsync, _FSMoveObjectAsyncWithCallbacks,
_FSMoveObjectSync, _FSMoveObjectToTrashAsync, _FSMoveObjectToTrashSync,
_FSNewAlias, _FSNewAliasFromPath, _FSNewAliasMinimal, _FSNewAliasMinimalUnicode,
_FSNewAliasUnicode, _FSObjTypeToFSNodeObjectType, _FSOpenFork,
_FSOpenIterator, _FSOpenOrphanResFile, _FSOpenResFile, _FSOpenResourceFile,
_FSOpenResourceFileMapped, _FSPathCopyExtendedAttribute, _FSPathCopyExtendedAttributeList,
_FSPathCopyObjectAsync, _FSPathCopyObjectAsyncWithCallbacks,
_FSPathCopyObjectSync, _FSPathCopyObjectSyncWithCallbacks,
_FSPathFileOperationCopyStatus, _FSPathGetTemporaryDirectoryForReplaceObject,
_FSPathMakeRef, _FSPathMakeRefWithOptions, _FSPathMoveObjectAsync,
_FSPathMoveObjectAsyncWithCallbacks, _FSPathMoveObjectSync,
_FSPathMoveObjectSyncWithCallbacks, _FSPathMoveObjectToTrashAsync,
_FSPathMoveObjectToTrashSync, _FSPathRemoveExtendedAttribute,
_FSPathReplaceObject, _FSPathSetExtendedAttribute, _FSReadFork,
_FSRefCreate64, _FSRefMakePath, _FSRemoveExtendedAttribute,
_FSRemoveExtendedAttributeByForkRefNum, _FSRenameUnicode,
_FSReplaceObject, _FSReservationAcquire, _FSReservationCopyPath,
_FSReservationCreateWithFSRef, _FSReservationCreateWithPath,
_FSReservationGetFSRefInfo, _FSReservationGetReservationType,
_FSReservationGetTypeID, _FSReservationRelinquish, _FSReservationUpdate,
_FSResolveAlias, _FSResolveAliasFile, _FSResolveAliasFileWithMountFlags,
_FSResolveAliasFileWithMountFlagsThreadSafe, _FSResolveAliasWithMountFlags,
_FSResolveNodeID, _FSResourceFileAlreadyOpen, _FSSetCatalogInfo,
_FSSetDefaultTextEncoding, _FSSetExtendedAttribute, _FSSetExtendedAttributeByForkRefNum,
_FSSetForkPosition, _FSSetForkSize, _FSSetVolumeInfo, _FSUnlinkObject,
_FSUnlockRange, _FSUnmountVolumeAsync, _FSUnmountVolumeSync,
_FSUpdateAlias, _FSVolumeMount, _FSWriteFork, _FileIDTreeCreateMountPointArrayWithOptions,
_FileIDTreeGetChildIDFromName, _FileIDTreeGetEntryInfoFromFileID,
_FileIDTreeGetFileIDFromPath, _FileIDTreePrintVolumeIDs, _FileIDTreePrintVolumeInfo,
_FileIDTreePrintVolumeTree, _FileIDTreePrintVolumes, _FileIDTree_GetBootGUID,
_FillParseTable, _FindCharInSet, _FindFolder, _FindFolderRoutingForDomain,
_FindNextComponent, _Fix2Frac, _Fix2Long, _Fix2X, _FixATan2,
_FixDiv, _FixMul, _FixRatio, _FixRound, _FlattenAliasRecord,
_FlattenCollection, _FlattenCollectionToHdl, _FlattenPartialCollection,
_FlushDebugLog, _FolderManagerDeleteUserSpecificItems, _FolderManagerDeleteUserSpecificItemsForVRefNum,
_Font2RealScript, _FontScript, _FontToScript, _FormatRecToString,
_Frac2Fix, _Frac2X, _FracCos, _FracDiv, _FracMul, _FracSin,
_FracSqrt, _GDBComponentList, _Gestalt, _GestaltHostName,
_GestaltUserName, _Get1IndResource, _Get1IndType, _Get1NamedResource,
_Get1Resource, _GetAliasSize, _GetAliasSizeFromPtr, _GetAliasUserType,
_GetAliasUserTypeFromPtr, _GetCollectionDefaultAttributes,
_GetCollectionExceptionProc, _GetCollectionItem, _GetCollectionItemHdl,
_GetCollectionItemInfo, _GetCollectionRetainCount, _GetComponentIDFromComponentInstance,
_GetComponentIndString, _GetComponentInfo, _GetComponentInstanceError,
_GetComponentInstanceStorage, _GetComponentListModSeed, _GetComponentMgrFlags,
_GetComponentPublicIndString, _GetComponentPublicResource,
_GetComponentPublicResourceList, _GetComponentRefcon, _GetComponentResource,
_GetComponentTypeModSeed, _GetCurrentThread, _GetDYLDEntryPoint,
_GetDYLDEntryPointWithImage, _GetDebugComponentInfo, _GetDebugOptionInfo,
_GetDefaultThreadStackSize, _GetFSRefComponentsForFileReferenceURL,
_GetFolderNameUnicode, _GetFolderTypes, _GetForkPhysicalInfo,
_GetFreeThreadCount, _GetHandleSize, _GetHostName, _GetIndResource,
_GetIndType, _GetIndexedCollectionItem, _GetIndexedCollectionItemHdl,
_GetIndexedCollectionItemInfo, _GetIndexedCollectionTag, _GetIntlResource,
_GetIntlResourceTable, _GetLocalDateTime, _GetMacOSStatusCommentString,
_GetMacOSStatusErrorString, _GetMap, _GetMaxResourceSize,
_GetNamedResource, _GetNewCollection, _GetNextFOND, _GetNextResourceFile,
_GetOverrideAttributes, _GetOverrideMap, _GetPtrSize, _GetResAttrs,
_GetResFileAttrs, _GetResInfo, _GetResource, _GetResourceSizeOnDisk,
_GetScriptInfoFromTextEncoding, _GetScriptManagerVariable,
_GetScriptManagerVariable_Internal, _GetScriptVariable, _GetSpecificFreeThreadCount,
_GetStackListElementFromIndex, _GetSysDirection, _GetTaggedCollectionItem,
_GetTaggedCollectionItemInfo, _GetTextEncodingBase, _GetTextEncodingFormat,
_GetTextEncodingFromScriptInfo, _GetTextEncodingName, _GetTextEncodingNameNoInit,
_GetTextEncodingVariant, _GetThreadCurrentTaskRef, _GetThreadGlobals,
_GetThreadScheduler, _GetThreadState, _GetThreadStateGivenTaskRef,
_GetTopResourceFile, _GetUTCDateTime, _HClrRBit, _HFSCreateInstalledEncodingDictionary,
_HGetState, _HLock, _HLockHi, _HSetRBit, _HSetState, _HUnlock,
_HandAndHand, _HandToHand, _HomeResFile, _IUClearCacheSys,
_IUGetItlScript, _IUMagWPString, _IUTextOrderSys, _IdenticalString,
_IdenticalText, _IdentifyFolder, _IdentifyFolderInDomain,
_IncrementAtomic, _IncrementAtomic16, _IncrementAtomic8, _InitScriptBundleComponent,
_InsTime, _InsXTime, _InsertOverrideFile, _InsertOverrideMap,
_InsertResourceFile, _InsertStackListElement, _InsertSystemOverrideFile,
_InstallDebugAssertOutputHandler, _InstallExceptionHandler,
_InstallThreadEventsWaitingHook, _InstallThreadInitHook, _InstallTimeTask,
_InstallXTimeTask, _IntlFCAddSearchCriteria, _IntlFCAddSearchDirectory,
_IntlFCCloseComponentData, _IntlFCCreateNewComponentObject,
_IntlFCDebugCache, _IntlFCDeleteComponent, _IntlFCDisposeComponentObject,
_IntlFCEditComponentObject, _IntlFCOpenComponentData, _IntlFCWriteComponentObject,
_IntlGetCache, _IntlGetInitValues, _IntlGetIsInitIntlValueDone,
_IntlGetToken, _IntlIsInitIntlValueDone, _IntlScript, _IntlSetCache,
_IntlSetInitIntlValueProc, _IntlSetInitValues, _IntlSetToken,
_IntlTokenize, _InvalidateFolderDescriptorCache, _InvokeThreadInitHookUPP,
_InvokeVNUPP, _IsHandleValid, _IsHeapValid, _IsMetric, _IsPointerValid,
_IsThisASystemResourceMap, _LLConvertUCS2toUTF8, _LLConvertUTF8toUCS2,
_LLConvertUTF8toUTF16, _LMGetApFontID, _LMGetApFontIDNoInit,
_LMGetBootDrive, _LMGetBrianBits, _LMGetDskSwtchHook, _LMGetHSCHndl,
_LMGetIntlSpec, _LMGetItlSysCachePtr, _LMGetKeyCache, _LMGetLangMapPtr,
_LMGetMemErr, _LMGetQDExist, _LMGetROMMapHndl, _LMGetResErr,
_LMGetResLoad, _LMGetResOneDeep, _LMGetScriptMapPtr, _LMGetSoundActive,
_LMGetSysFontFamNoInit, _LMGetSysFontSize, _LMGetSysMap, _LMGetTmpResLoad,
_LMGetWWExist, _LMInvalidateKeyCache, _LMSetApFontID, _LMSetBootDrive,
_LMSetBrianBits, _LMSetDskSwtchHook, _LMSetHSCHndl, _LMSetIntlSpec,
_LMSetItlSysCachePtr, _LMSetKeyCache, _LMSetKeyboardSwitchingState,
_LMSetLangMapPtr, _LMSetMemErr, _LMSetQDExist, _LMSetROMMapHndl,
_LMSetResErr, _LMSetResLoad, _LMSetResOneDeep, _LMSetScriptMapPtr,
_LMSetSoundActive, _LMSetSysFontFam, _LMSetSysFontSize, _LMSetSysMap,
_LMSetTmpResLoad, _LanguageOrder, _LoadResource, _LocaleCountNames,
_LocaleGetIndName, _LocaleGetName, _LocaleOperationCountLocales,
_LocaleOperationCountNames, _LocaleOperationGetIndName, _LocaleOperationGetLocales,
_LocaleOperationGetName, _LocaleOperationLoadData, _LocaleOperationUnloadData,
_LocaleRefFromLangOrRegionCode, _LocaleRefFromLocaleString,
_LocaleRefGetPartString, _LocaleStringToLangAndRegionCodes,
_Long2Fix, _MPAllocate, _MPAllocateAligned, _MPAllocateTaskStorageIndex,
_MPArmTimer, _MPBlockClear, _MPBlockCopy, _MPCancelTimer,
_MPCauseNotification, _MPCreateCriticalRegion, _MPCreateEvent,
_MPCreateNotification, _MPCreateQueue, _MPCreateSemaphore,
_MPCreateTask, _MPCreateTaskCFM, _MPCreateTimer, _MPCurrentTaskID,
_MPDeallocateTaskStorageIndex, _MPDelayUntil, _MPDeleteCriticalRegion,
_MPDeleteEvent, _MPDeleteNotification, _MPDeleteQueue, _MPDeleteSemaphore,
_MPDeleteTimer, _MPDisposeTaskException, _MPEnterCriticalRegion,
_MPExit, _MPExitCriticalRegion, _MPExtractTaskState, _MPFree,
_MPGetAllocatedBlockSize, _MPGetNextCpuID, _MPGetNextTaskID,
_MPGetTaskStorageValue, _MPModifyNotification, _MPModifyNotificationParameters,
_MPNotifyQueue, _MPProcessors, _MPProcessorsScheduled, _MPRegisterDebugger,
_MPRemoteCall, _MPRemoteCallCFM, _MPSetEvent, _MPSetExceptionHandler,
_MPSetQueueReserve, _MPSetTaskState, _MPSetTaskStorageValue,
_MPSetTaskTSPriority, _MPSetTaskType, _MPSetTaskWeight, _MPSetTimerNotify,
_MPSignalSemaphore, _MPTaskIsPreemptive, _MPTerminateTask,
_MPThrowException, _MPUnregisterDebugger, _MPWaitForEvent,
_MPWaitOnQueue, _MPWaitOnSemaphore, _MPYield, _MapScriptInfoAndISOCodes,
_MemError, _Microseconds, _ModeToFSNodeType, _Munger, _NanosecondsToAbsolute,
_NanosecondsToDuration, _NearestMacTextEncodings, _NearestMacTextEncodingsNoInit,
_NewCollection, _NewComponentFunctionUPP, _NewDebugComponent,
_NewDebugLog, _NewDebugOption, _NewEmptyHandle, _NewGestaltValue,
_NewHandle, _NewHandleClear, _NewHandleFromExternalPtr, _NewPtr,
_NewPtrClear, _NewStackListSys, _NewThread, _NewThreadInitHookUPP,
_NewVNUPP, _NumToString, _OLD_NEXT_COLORS, _OSTypeToCString,
_OpenAComponent, _OpenAComponentResFile, _OpenADefaultComponent,
_OpenComponent, _OpenComponentResFile, _OpenDefaultComponent,
_PBAllocateForkAsync, _PBAllocateForkSync, _PBCatalogSearchAsync,
_PBCatalogSearchSync, _PBCloseForkAsync, _PBCloseForkSync,
_PBCloseIteratorAsync, _PBCloseIteratorSync, _PBCompareFSRefsAsync,
_PBCompareFSRefsSync, _PBCreateDirectoryUnicodeAsync, _PBCreateDirectoryUnicodeSync,
_PBCreateFileAndOpenForkUnicodeAsync, _PBCreateFileAndOpenForkUnicodeSync,
_PBCreateFileUnicodeAsync, _PBCreateFileUnicodeSync, _PBCreateForkAsync,
_PBCreateForkSync, _PBDeleteForkAsync, _PBDeleteForkSync,
_PBDeleteObjectAsync, _PBDeleteObjectSync, _PBExchangeObjectsAsync,
_PBExchangeObjectsSync, _PBFSCopyFileAsync, _PBFSCopyFileSync,
_PBFSResolveNodeIDAsync, _PBFSResolveNodeIDSync, _PBFlushForkAsync,
_PBFlushForkSync, _PBFlushVolumeAsync, _PBFlushVolumeSync,
_PBGetCatalogInfoAsync, _PBGetCatalogInfoBulkAsync, _PBGetCatalogInfoBulkSync,
_PBGetCatalogInfoSync, _PBGetForkCBInfoAsync, _PBGetForkCBInfoSync,
_PBGetForkPositionAsync, _PBGetForkPositionSync, _PBGetForkSizeAsync,
_PBGetForkSizeSync, _PBGetVolumeInfoAsync, _PBGetVolumeInfoSync,
_PBIterateForksAsync, _PBIterateForksSync, _PBMakeFSRefUnicodeAsync,
_PBMakeFSRefUnicodeSync, _PBMoveObjectAsync, _PBMoveObjectSync,
_PBOpenForkAsync, _PBOpenForkSync, _PBOpenIteratorAsync, _PBOpenIteratorSync,
_PBReadForkAsync, _PBReadForkSync, _PBRenameUnicodeAsync,
_PBRenameUnicodeSync, _PBSetCatalogInfoAsync, _PBSetCatalogInfoSync,
_PBSetForkPositionAsync, _PBSetForkPositionSync, _PBSetForkSizeAsync,
_PBSetForkSizeSync, _PBSetVolumeInfoAsync, _PBSetVolumeInfoSync,
_PBUnlinkObjectAsync, _PBUnlinkObjectSync, _PBWriteForkAsync,
_PBWriteForkSync, _PBXLockRangeAsync, _PBXLockRangeSync, _PBXUnlockRangeAsync,
_PBXUnlockRangeSync, _PLpos, _PLstrcat, _PLstrchr, _PLstrcmp,
_PLstrcpy, _PLstrlen, _PLstrncat, _PLstrncmp, _PLstrncpy,
_PLstrpbrk, _PLstrrchr, _PLstrspn, _PLstrstr, _PopStackListElement,
_PrimeTime, _PrimeTimeTask, _PrintEnumerationCache, _PrintFSAccessControlEntry,
_PrintFSRef, _PrintFSRefPath, _PrintFileInfo, _PrintLaunchDebugInfo,
_PrintOpenForks, _PrintResourceChain, _PrintVolumeInfo, _PtrAndHand,
_PtrToHand, _PtrToXHand, _PurgeCollection, _PurgeCollectionTag,
_PushStackListElement, _QueryUnicodeMappings, _QueryUnicodeMappingsNoInit,
_RMAddResFileToSearchPath, _RMAddResourceByFileRef, _RMChangedResourceByFileRef,
_RMCloseResourceFile, _RMCloseResourceFileByFileRef, _RMDetachResourceByFileRef,
_RMDisposeMappedFileRef, _RMFSCreateResFile, _RMFSCreateResourceFile,
_RMFSOpenResourceFile, _RMGetIndexedResource, _RMGetIndexedResourceByFileRef,
_RMGetIndexedType, _RMGetNamedResource, _RMGetPtrAndSizeFromMappedRef,
_RMGetResource, _RMGetResourceByFileRef, _RMGetResourceCount,
_RMGetResourceCountByFileRef, _RMGetResourceSize, _RMGetTopOfOrphanChain,
_RMGetTypeCount, _RMInsertMappedResourceFileInChain, _RMNewMappedRefFromMappedFork,
_RMOpenResourceFileRef, _RMReadPartialResourceByFileRef, _RMReleaseResourceByFileRef,
_RMRemoveResFileFromSearchPath, _RMRemoveResourceByFileRef,
_RMUpdateResourceFileByFileRef, _RMWriteResourceByFileRef,
_ReadLocation, _ReadPartialResource, _RealScript, _ReallocateHandle,
_RecoverHandle, _RefFix2X, _RefX2Fix, _RefX2Frac, _RegisterComponent,
_RegisterComponentFileRef, _RegisterComponentFileRefEntries,
_RegisterComponentResource, _RegisterComponentResourceFile,
_RelString, _ReleaseCollection, _ReleaseFolder, _ReleaseResource,
_RemoveChewableItemsFromVolume, _RemoveCollectionItem, _RemoveFolderDescriptor,
_RemoveIndexedCollectionItem, _RemoveResource, _RemoveStackListElement,
_RemoveThreadInitHook, _RemoveTimeTask, _ReplaceGestaltValue,
_ReplaceIndexedCollectionItem, _ReplaceIndexedCollectionItemHdl,
_ReplaceStackListElement, _ReplaceText, _RequestVolumeNotification,
_RequestVolumeNotificationWithFlags, _ResError, _ResetTextToUnicodeInfo,
_ResetUnicodeToTextInfo, _ResetUnicodeToTextRunInfo, _ResolveComponentAlias,
_ResolveDefaultTextEncoding, _RetainCollection, _RevertTextEncodingToScriptInfo,
_RmvTime, _S32Set, _S64Absolute, _S64Add, _S64And, _S64BitwiseAnd,
_S64BitwiseEor, _S64BitwiseNot, _S64BitwiseOr, _S64Compare,
_S64Divide, _S64Eor, _S64Max, _S64Min, _S64Multiply, _S64Negate,
_S64Not, _S64Or, _S64Set, _S64SetU, _S64ShiftLeft, _S64ShiftRight,
_S64Subtract, _SInt64ToUInt64, _SMDisposeIntlSpec, _SMInitIntlSpec,
_ScriptOrder, _ScriptToRange, _SearchStackList, _SearchStackListFirstFourBytes,
_SetAliasUserType, _SetAliasUserTypeWithPtr, _SetCollectionDefaultAttributes,
_SetCollectionExceptionProc, _SetCollectionItemInfo, _SetComponentInstanceError,
_SetComponentInstanceStorage, _SetComponentMgrFlags, _SetComponentRefcon,
_SetDebugOptionValue, _SetDebuggerNotificationProcs, _SetDefaultComponent,
_SetFallbackUnicodeToText, _SetFallbackUnicodeToTextRun, _SetGestaltSystemValue,
_SetGestaltSystemValuesBulk, _SetGestaltValue, _SetGestaltValuesBulk,
_SetGetFNumProc, _SetGetFontFromPortProc, _SetGetFontNameProc,
_SetGetFontScriptProc, _SetGetScriptFontFlagsCallback, _SetHandleSize,
_SetIndexedCollectionItemInfo, _SetInitializeScriptHLProc,
_SetLocalDateTime, _SetOverrideAttributes, _SetPtrSize, _SetResAttrs,
_SetResFileAttrs, _SetResInfo, _SetResLoad, _SetResPurge,
_SetResourceSize, _SetScriptFontValidatorCallback, _SetScriptManagerVariable,
_SetScriptManagerVariable_KeyScriptOverride, _SetScriptVariable,
_SetSwapKeyboardProc, _SetSysDirection, _SetThreadGlobalsAreCooperative,
_SetThreadReadyGivenTaskRef, _SetThreadScheduler, _SetThreadState,
_SetThreadStateEndCritical, _SetThreadSwitcher, _SetThreadTerminator,
_SetUTCDateTime, _SetUnicodeConverterInstalledScripts, _StringOrder,
_StringToExtended, _StringToFormatRec, _StringToNum, _SubAbsoluteFromAbsolute,
_SubDurationFromAbsolute, _SubNanosecondsFromAbsolute, _SysBreak,
_SysBreakFunc, _SysBreakStr, _SysError, _TECClearConverterContextInfo,
_TECClearSnifferContextInfo, _TECConvertText, _TECConvertTextToMultipleEncodings,
_TECCopyTextEncodingInternetNameAndMIB, _TECCountAvailableSniffers,
_TECCountAvailableTextEncodings, _TECCountDestinationTextEncodings,
_TECCountDirectTextEncodingConversions, _TECCountMailTextEncodings,
_TECCountSubTextEncodings, _TECCountWebTextEncodings, _TECCreateConverter,
_TECCreateConverterFromPath, _TECCreateOneToManyConverter,
_TECCreateSniffer, _TECDisposeConverter, _TECDisposeSniffer,
_TECFlushMultipleEncodings, _TECFlushText, _TECGetAvailableSniffers,
_TECGetAvailableTextEncodings, _TECGetBasicOptions, _TECGetDestinationTextEncodings,
_TECGetDirectTextEncodingConversions, _TECGetEncodingList,
_TECGetInfo, _TECGetMailTextEncodings, _TECGetSubTextEncodings,
_TECGetTextEncodingFromInternetName, _TECGetTextEncodingFromInternetNameOrMIB,
_TECGetTextEncodingInternetName, _TECGetWebTextEncodings,
_TECSetBasicOptions, _TECSniffEncodingAndLanguage, _TECSniffTextEncoding,
_TSAcquireReader, _TSAtomicCompareAndSwapPtr, _TSBroadcastCondition,
_TSChangeExceptionCatcherHandler, _TSCreateStorageKey, _TSCreateThread,
_TSCreateThreadWithPolicy, _TSCreateThreadWithStackSize, _TSDeleteStorageKey,
_TSDestroyCondition, _TSDestroyMutex, _TSDestroyReaderWriterLock,
_TSDestroySemaphore, _TSDurationToTimeSpec, _TSExceptionAbort,
_TSExceptionContinue, _TSExceptionGetLiveState, _TSExit, _TSGetDefaultThreadStackSize,
_TSGetMainThreadBacktrace, _TSGetPriority, _TSGetStackBase,
_TSGetStackSize, _TSGetStorage, _TSInitCondition, _TSInitMutex,
_TSInitReaderWriterLock, _TSInitSemaphore, _TSInstallExceptionCatcher,
_TSLockMutex, _TSReaderToWriter, _TSReleaseReader, _TSRemoveExceptionCatcher,
_TSSelf, _TSSetPriority, _TSSetStorage, _TSSignalCondition,
_TSSignalSemaphore, _TSTerminateThread, _TSTryLockMutex, _TSUnlockMutex,
_TSWaitOnCondition, _TSWaitOnConditionTimed, _TSWaitOnConditionTimedRelative,
_TSWaitOnSemaphore, _TSWaitOnSemaphoreRelative, _TSWriterToReader,
_TSYield, _TUCharacterByteType, _TaskLevel, _TempNewHandle,
_TestAndClear, _TestAndSet, _TextOrder, _ThreadBeginCritical,
_ThreadCurrentStackSpace, _ThreadEndCritical, _ThreadsHaveNonMainRunnable,
_TickCount, _TransferCustomIconAndBadge, _TransliterateText,
_TruncateForTextToUnicode, _TruncateForUnicodeToText, _U32SetU,
_U64Add, _U64And, _U64BitwiseAnd, _U64BitwiseEor, _U64BitwiseNot,
_U64BitwiseOr, _U64Compare, _U64Divide, _U64Eor, _U64Max,
_U64Multiply, _U64Not, _U64Or, _U64Set, _U64SetU, _U64ShiftLeft,
_U64ShiftRight, _U64Subtract, _UCCompareCollationKeys, _UCCompareText,
_UCCompareTextDefault, _UCCompareTextNoLocale, _UCCompileuchr,
_UCConvertCFAbsoluteTimeToLongDateTime, _UCConvertCFAbsoluteTimeToSeconds,
_UCConvertCFAbsoluteTimeToUTCDateTime, _UCConvertLongDateTimeToCFAbsoluteTime,
_UCConvertSecondsToCFAbsoluteTime, _UCConvertUTCDateTimeToCFAbsoluteTime,
_UCCreateCollator, _UCCreateTextBreakLocator, _UCCreateUSetForUchr,
_UCDisposeCollator, _UCDisposeTextBreakLocator, _UCFindTextBreak,
_UCGenerateSwappedUchr, _UCGetCharProperty, _UCGetCollationKey,
_UCKeyTranslate, _UCKeyboardLayoutStringMax, _UCLoadCharPropsTablePriv,
_UCTypeSelectAddKeyToSelector, _UCTypeSelectAddKeyToSelectorData,
_UCTypeSelectAddKeyToSelectorDataWithTime, _UCTypeSelectCompare,
_UCTypeSelectCreateSelector, _UCTypeSelectDisposeSelector,
_UCTypeSelectFindItem, _UCTypeSelectFlushSelectorData, _UCTypeSelectNewSelector,
_UCTypeSelectReleaseSelector, _UCTypeSelectWalkList, _UCTypeSelectWouldResetBuffer,
_UCUnloadCharPropsTablePriv, _UCUseCharPropsTablePriv, _UInt64ToSInt64,
_UTF8ToCString, _UmapBCharToUChars, _UmapCloseMapping, _UmapGetCharsToComposeUSet,
_UmapOpenMapping, _UmapScanUCharElement, _UmapSetFallbacks,
_UmapSetLookupInfo, _UmapUCharElementToBChars, _UncaptureComponent,
_UnflattenAliasRecord, _UnflattenCollection, _UnflattenCollectionFromHdl,
_UnicodeValidConversionLength, _Unique1ID, _UniqueID, _UnregisterComponent,
_UnsignedFixedMulDiv, _UpTime, _UpdateResFile, _UpgradeScriptInfoToTextEncoding,
_UseResFile, _ValidComponent, _WideAdd, _WideBitShift, _WideCompare,
_WideDivide, _WideMultiply, _WideNegate, _WideShift, _WideSquareRoot,
_WideSubtract, _WideWideDivide, _WritePartialResource, _WriteResource,
_X2Fix, _X2Frac, _YieldToAnyThread, _YieldToThread, __AL_CreateMinimalAliasHandle,
__AL_FlattenAliasRecordFromPtr, __AL_MarkAliasDoNotDisplay,
__AL_UnflattenAliasRecordFromPtr, __AddMountInfoToAlias, __AddServerURLInfoToAlias,
__C2PStr, __CSBackupAddAdvisoryForDatabasePath, __CSBackupBackUpNow,
__CSBackupBackupAboutToBegin, __CSBackupBackupCompleted, __CSBackupBuildNumberCompare,
__CSBackupCancelBackup, __CSBackupCompareAliasData, __CSBackupCompareItems,
__CSBackupCopyBackupItemsForBUItem, __CSBackupCopyBackupRootLocationForDate,
__CSBackupCopyBackupRootLocationForSnapshot, __CSBackupCopyBackupSessionID,
__CSBackupCopyClientNotifyString, __CSBackupCopyCompletedRecoverySets,
__CSBackupCopyComputerURLOnVolume, __CSBackupCopyCustomBooterToBackupDisk,
__CSBackupCopyDestinationMountPointURL, __CSBackupCopyDifferentBackupItemsForBUItem,
__CSBackupCopyDiskImageForDirectory, __CSBackupCopyHostUUID,
__CSBackupCopyInProgressRecoverySets, __CSBackupCopyInProgressThinningRecoverySets,
__CSBackupCopyItemBackupLocationForDate, __CSBackupCopyItemLatestBackupLocation,
__CSBackupCopyLatestBackupRootLocation, __CSBackupCopyMACAddress,
__CSBackupCopyMTMOverlayMountPointURL, __CSBackupCopyMachineDirectoryForDestination,
__CSBackupCopyMatchingComputerURLOnVolume, __CSBackupCopyMatchingSnapshotItem,
__CSBackupCopyMountPointURLForDestination, __CSBackupCopyNetworkInfoFromAlias,
__CSBackupCopyNextDifferentItemForBUItem, __CSBackupCopyOriginalItemLocation,
__CSBackupCopyPathFromAliasDataNoMount, __CSBackupCopyPathFromAliasNoMount,
__CSBackupCopyPathFromAliasReturningStatus, __CSBackupCopyPreviousDifferentItemForBUItem,
__CSBackupCopyRecoverySet, __CSBackupCopyRecoverySetToBackupStore,
__CSBackupCopyRecoverySetURLInBackupStoreForBoardID, __CSBackupCopySessionNotifyString,
__CSBackupCopySessionStatus, __CSBackupCopySnapshotDate, __CSBackupCopySnapshotForBUItem,
__CSBackupCopySnapshotLabel, __CSBackupCopySnapshotsForBUItem,
__CSBackupCopyStandardizedNetworkDestinationURL, __CSBackupCopySuggestedDiskImageName,
__CSBackupCopyTimeMachineDiskImageURLsOnVolume, __CSBackupCreateAliasByRemovingServerURLInfoFromAlias,
__CSBackupCreateAliasDataFromAlias, __CSBackupCreateAliasDataFromPath,
__CSBackupCreateAliasFromAliasData, __CSBackupCreateAliasFromPath,
__CSBackupCreateBackupSession, __CSBackupDeleteBackup, __CSBackupEstimateReusableBytesOnVolume,
__CSBackupFindMatchingOriginalItemByPath, __CSBackupFindMatchingSnapshotItemByPath,
__CSBackupFindMatchingSnapshotItemByPathWithHints, __CSBackupFindUnusedIndexIntoRecoverySetsDirectory,
__CSBackupGetDefaultBackupSession, __CSBackupGetMachineMACAddress,
__CSBackupGetSharedServerProxy, __CSBackupGetSharedStatusProxy,
__CSBackupIdentityCopyFileVaultExclusionPaths, __CSBackupIdentityCopyFileVaultImagePath,
__CSBackupIdentityCopyFileVaultImagePaths, __CSBackupIdentityCopyFileVaultUsers,
__CSBackupIdentityCopyLocalUsers, __CSBackupIdentityUserIsFileVault,
__CSBackupInitializeBackupDaemon, __CSBackupItemGetsBackedUp,
__CSBackupItemIsSnapshot, __CSBackupMarkSnapshotForDeletion,
__CSBackupPathIsBackupItem, __CSBackupPostStatusNotifyForClient,
__CSBackupPostStatusNotifyForSession, __CSBackupRegisterMTMExclusions,
__CSBackupRegisterPreAndPostBackupHooks, __CSBackupRemoveAdvisoryForDatabasePath,
__CSBackupRequestFreeSpaceOnVolume, __CSBackupRuleTreeCreateWithVolumeName,
__CSBackupRuleTreeEvaluateFile, __CSBackupRuleTreeEvaluateFolder,
__CSBackupRuleTreeGetNodeForPath, __CSBackupRuleTreeGetTypeID,
__CSBackupRuleTreePushFullPath, __CSBackupRuleTreeSetPathExcluded,
__CSBackupRuleTreeSetPathsExcluded, __CSBackupRulesEngineAddPath,
__CSBackupRulesEngineAddRuleTree, __CSBackupRulesEngineAddSourcePath,
__CSBackupRulesEngineAddStdRulesToTree, __CSBackupRulesEngineBulkEvaluatePathCopyIncludedChildren,
__CSBackupRulesEngineBulkEvaluateURLCopyIncludedChildren,
__CSBackupRulesEngineCopyRuleTrees, __CSBackupRulesEngineCopySourceDictionary,
__CSBackupRulesEngineCopySourcePaths, __CSBackupRulesEngineCreateForBackup,
__CSBackupRulesEngineCreateWithArchive, __CSBackupRulesEngineEvaluateFile,
__CSBackupRulesEngineEvaluateFileFromFullPath, __CSBackupRulesEngineEvaluateFolder,
__CSBackupRulesEngineEvaluateFolderFromFullPath, __CSBackupRulesEngineEvaluateFromFullPath,
__CSBackupRulesEngineEvaluateFromFullPathDeferDirectoryDecision,
__CSBackupRulesEngineGetRuleTreeForPath, __CSBackupRulesEngineGetRuleTreeWithVolEntry,
__CSBackupRulesEngineGetTypeID, __CSBackupRulesEngineIsExclusionRulesCacheEnabled,
__CSBackupRulesEngineIsPathExcluded, __CSBackupRulesEnginePopAllComponents,
__CSBackupRulesEnginePopPathComponent, __CSBackupRulesEnginePushPathComponent,
__CSBackupRulesEnginePushRelativePath, __CSBackupRulesEngineQuickEvaluateFromFullPath,
__CSBackupRulesEngineRemoveRuleTree, __CSBackupRulesEngineRemoveSourcePath,
__CSBackupRulesEngineSetExclusionRulesCacheEnabled, __CSBackupRulesEngineSetPathExcluded,
__CSBackupRulesEngineSetTraversalPath, __CSBackupServerCopyStatus,
__CSBackupServerIsActive, __CSBackupServerProxyBackupNow,
__CSBackupServerProxyCancelBackup, __CSBackupServerProxyCopyDestinationMountPoint,
__CSBackupServerProxyGetTypeID, __CSBackupServerProxyIsPortRegistered,
__CSBackupServerProxyRunHealthCheck, __CSBackupServerProxySendMessage,
__CSBackupServerProxySetNeedsRescan, __CSBackupSessionCopyBackupDirectory,
__CSBackupSessionGetTypeID, __CSBackupSetBackupSessionTarget,
__CSBackupSettingsAreSystemFilesSkipped, __CSBackupSettingsCanEnableAutoBackup,
__CSBackupSettingsCanManuallyBackup, __CSBackupSettingsCanSetBackupVolume,
__CSBackupSettingsCopyBackupAlias, __CSBackupSettingsCopyBackupAliasData,
__CSBackupSettingsCopyDestinations, __CSBackupSettingsCopyExcludedPaths,
__CSBackupSettingsCopyExcludedVolumes, __CSBackupSettingsCopyIncludedPaths,
__CSBackupSettingsCopyIncludedVolumes, __CSBackupSettingsCopyNextBackupDate,
__CSBackupSettingsCopySkippedFolders, __CSBackupSettingsCopySkippedItems,
__CSBackupSettingsCopySkippedPaths, __CSBackupSettingsCopyStdExcludedContentPaths,
__CSBackupSettingsCopyStdExcludedFileContentPaths, __CSBackupSettingsCopyStdExcludedPaths,
__CSBackupSettingsCopyStdExcludedUserPaths, __CSBackupSettingsCreate,
__CSBackupSettingsExcludePath, __CSBackupSettingsGetMaxBackupSize,
__CSBackupSettingsGetTypeID, __CSBackupSettingsIsAutoBackupEnabled,
__CSBackupSettingsIsPathExcluded, __CSBackupShouldBackUpRecoverySet,
__CSBackupShouldCheckLocalRecoveryPartition, __CSBackupStartBackingUpItem,
__CSBackupStopBackingUpItem, __CSBackupSuspendAutomaticActivity,
__CSBackupSystemVersionCompare, __CSBackupURLIsBackupItem,
__CSBackupUnregisterMTMExclusions, __CSBackupWasItemEverBackedUp,
__CSCheckFix, __CSCheckFixDisable, __CSCheckFixSetBundleInformation,
__CSCheckFixWithInfo, __CSCopyLazyValuesForKey, __CSCopyNamedData,
__CSCreateSeed, __CSDestroySeed, __CSFlushNamedData, __CSGetNamedData,
__CSGetProcessorArchitecture, __CSIncrementSeed, __CSReadSeed,
__CSReleaseNamedData, __CSSetNamedData, __CSWriteSeed, __CharacterByteType,
__ConvertLocalTimeToUTC, __ConvertLocalToUTCDateTime, __ConvertUTCToLocalDateTime,
__ConvertUTCToLocalTime, __CopyCStringToPascal, __CopyComponentBundleIdentifier,
__CopyPascalStringToC, __CoreServicesServerMain, __EqualString,
__FNNotifyByURL, __FSAccessControlEntryCopyUUID, __FSAccessControlEntryCreateMutableWithUUID,
__FSAccessControlEntryCreateMutableWithUUIDBytes, __FSAccessControlEntryGetAccessControlInfo,
__FSAccessControlEntryGetDisplayAsCurrentID, __FSAccessControlEntryGetDisplayAsCurrentIDValue,
__FSAccessControlEntryGetTypeID, __FSAccessControlEntryGetUUIDBytes,
__FSAccessControlEntryGetUnmappableInfo, __FSAccessControlEntryGetVisibility,
__FSAccessControlEntrySetAccessControlInfo, __FSAccessControlEntrySetUUID,
__FSAccessControlEntrySetUUIDBytes, __FSAddVolumeObserver,
__FSAddVolumeObserverOnQueue, __FSAllocateQuarantineData,
__FSApplyAccessRightsToObjectForUser, __FSApplyAccessRightsToObjectWithDictionary,
__FSCatalogSearchPlusFileIDs, __FSCompareAliasRecords, __FSCompareFlattenedFSRefs,
__FSCopyAliasFile, __FSCopyAliasFileWithFlags, __FSCopyAliasInfoFromAliasPtr,
__FSCopyExtendedAliasInfoFromAliasPtr, __FSCopyFSPackedFSRef,
__FSCopyFile, __FSCopyPOSIXSymlink, __FSCopyVolumeProperty,
__FSCreateEffectiveAccessArrayWithACLArray, __FSCreateFSPackedFSRef,
__FSCreateFileDictionaryFromDirectoryDictionary, __FSCreateFileSecurityRefForCopyWithFinalDestRef,
__FSCreateFinalDestinationFileSecurityRef, __FSCreateMutableACLArrayForObject,
__FSCreateMutableACLArrayFromPOSIXPerms, __FSCreateMutableFileACLArrayFromDirectoryACLArray,
__FSCreateRelativeFSRef, __FSCreateStrippedFileSecurityRef,
__FSCreateUserAccessRightsDictionaryForObject, __FSDeallocateQuarantineData,
__FSDisableAutoDiskArbHandling, __FSDisposeFSPackedFSRef,
__FSEffectiveAccessEntryCopyUUID, __FSEffectiveAccessEntryGetEffectiveAccessControlInfo,
__FSEffectiveAccessEntryGetUUIDBytes, __FSErrorTranslate,
__FSFileSecurityCreateForFileFromDirectory, __FSFileSecurityGetfilesec_t,
__FSFileSecurityUnsetAccessControlList, __FSFileSecurityUnsetGroup,
__FSFileSecurityUnsetGroupUUID, __FSFileSecurityUnsetMode,
__FSFileSecurityUnsetOwner, __FSFileSecurityUnsetOwnerUUID,
__FSFlattenFSRef, __FSFlipAFPXVolMountInfo, __FSForkAdvise,
__FSGetAliasInfoFromAliasPtr, __FSGetCatalogInfoByName, __FSGetDisableNetworkVolumes,
__FSGetExtendedUserAccess, __FSGetFSRefFromPackedFSRef, __FSGetFSRefInformationFast,
__FSGetFileIDAndVRefNum, __FSGetFileVaultHomeDirectoryVRefNum,
__FSGetObjectAccess, __FSGetVolumeByName, __FSGetVolumeDeviceAttributes,
__FSGetVolumeDeviceTypeAndBackingStoreVolume, __FSGetVolumeEncoding,
__FSGetVolumeForMountpoint, __FSGetVolumeInfoWithFlags, __FSGetVolumeMountpoint,
__FSGetVolumePermissions, __FSGetVolumeProperty, __FSIdentifyFolder,
__FSIsItemFileVaultHomeDirectory, __FSIsItemHomeDirectory,
__FSIsSyntheticLink, __FSIsVolumeDiskImage, __FSLinkObjectUnicode,
__FSMakeFSRefFromSpecData, __FSMapIDToName, __FSMapIDtoUUID,
__FSMapNameToID, __FSMapNameToUUID, __FSMapUUIDToIDAndName,
__FSMapUUIDToName, __FSModifyAccessRightsOfObjectForUser,
__FSModifyAccessRightsOfObjectWithDictionaries, __FSMoveAndRenameObject,
__FSNewHomeDirRelativeAliasByPath, __FSNewMinimalPathAliasFromAbsoluteHFSStylePath,
__FSNewMinimalPathAliasFromRelativeUTF8PathAndServerInfo,
__FSNewVersion3Alias, __FSNewVersion3PathAlias, __FSOpenForkWithCatalogInfo,
__FSPathAllocateQuarantineData, __FSPathGetCatalogInfo, __FSPathSetQuarantineData,
__FSPermissionArrayAddEntry, __FSPermissionArrayCreateFSPermissionInfo,
__FSPermissionArrayCreateFSPermissionInfoWithVolume, __FSPermissionArrayCreateWithPermissionInfo,
__FSPermissionArrayCreateWithPermissionInfoWithVolume, __FSPermissionArrayCreateWithSecurityInfo,
__FSPermissionArrayWriteToDisk, __FSRemoveUserFromObjectAccessControlList,
__FSRemoveVolumeObserver, __FSRemoveVolumeObserverOnQueue,
__FSRemoveVolumeProperty, __FSReplaceAccessControlListWithArray,
__FSReplaceAccessControlListWithDictionary, __FSSamePhysicalDevice,
__FSScheduleFileVolumeOperations, __FSSetAliasHandleSizeValidation,
__FSSetDisableNetworkVolumes, __FSSetObjectAccess, __FSSetObjectAccessRights,
__FSSetObjectOwnership, __FSSetQuarantineData, __FSSetStrictAliasPathMatchByDefault,
__FSSetVolumeEncoding, __FSSetVolumePermissions, __FSSetVolumeProperty,
__FSTransferExtendedAttributes, __FSTransferExtendedAttributesByForkRefNum,
__FSUnflattenFSRef, __FSUnscheduleFileVolumeOperations, __FSValidVolume,
__FSVolumeAllocateQuarantineData, __FSVolumeMount, __FSVolumeSetQuarantineData,
__FileIDTreeGetSKServiceDescription, __FindFolderRouting,
__FindNextComponentWithPlatformsBitmap, __FlattenComponent,
__FolderManagerDeleteUserSpecificItemsWithTimeout, __GDBUserBreakCallbackFunc,
__GDBUserBreakShouldSignalWithSIGINT, __GetComponentFSRef,
__GetComponentPlatformsBitmap, __GetComponentThingInfo, __GetCurrentEventTimestamp,
__GetIOKitDeviceTypeFromDeviceID, __GetUTCDateTime, __HClrRBit,
__HGetState, __HNoPurge, __HPurge, __HSetRBit, __HSetState,
__InitCarbonCore, __LMGetApFontID, __LMGetSysFontFam, __MPIsFullyInitialized,
__MPLibraryIsCompatible, __MPLibraryVersion, __P2CStr, __PBCatalogSearchPlusFileIDs,
__PLpos, __PLstrcat, __PLstrchr, __PLstrcmp, __PLstrcpy, __PLstrlen,
__PLstrncat, __PLstrncmp, __PLstrncpy, __PLstrpbrk, __PLstrrchr,
__PLstrspn, __PLstrstr, __SCSeedGetSKServiceDescription, __URLGetExtendedUserAccess,
__UnflattenComponent, __UppercaseText, __c2pstr, __c2pstrcpy,
__ccSetGetHandleSizeCallout, __p2cstr, __p2cstrcpy, _annuity,
_compound, _dec2f, _dec2l, _dec2num, _dec2s, _dec2str, _dtox80,
_gCarbonDiskSwitchDialog, _gSCKnownSKPlugins, _kBackupID,
_kBackupMachineAddressXAttrKey, _kBackupNotificationObject,
_kBackupPrefsChangedNotification, _kBackupPrefsPlist, _kBackupsTopLevelFolder,
_kCSBackupAirPortInfoMacAddressKey, _kCSBackupAirPortInfoNameKey,
_kCSBackupAirPortInfoVersionKey, _kCSBackupAlwaysShowDeletedBackupsWarningKey,
_kCSBackupBootPlist, _kCSBackupClientIdXPCKey, _kCSBackupCustomBooter,
_kCSBackupCustomBooterPathXPCKey, _kCSBackupCustomRecoveryBooterPath,
_kCSBackupDestinationIdentifierXPCKey, _kCSBackupDestinationMountNotification,
_kCSBackupDestinationsKey, _kCSBackupEncryptedTMBootPickerVersionXattrKey,
_kCSBackupExcludedVolumeUUIDsKey, _kCSBackupFVAccountsFolder,
_kCSBackupFVMountPoint, _kCSBackupHasEncryptedRecoveryBitsXAttrKey,
_kCSBackupHasRecoverySetXAttrKey, _kCSBackupHealthCheckSkeletonDirectoryPath,
_kCSBackupHostUUIDXAttrKey, _kCSBackupIncludedVolumeUUIDsKey,
_kCSBackupItemNewestSnapshotMDKey, _kCSBackupItemOldestSnapshotMDKey,
_kCSBackupItemPathMDKey, _kCSBackupKernelCache, _kCSBackupKernelCachePath,
_kCSBackupKernelCacheRecoverySetsPath, _kCSBackupKernelFlags,
_kCSBackupKernelFlagsBaseSystemPath, _kCSBackupKernelFlagsRecoverySetsPath,
_kCSBackupKeyAutoBackup, _kCSBackupKeyBackupAlias, _kCSBackupKeyBackupHasRecoverySet,
_kCSBackupKeyBackupPath, _kCSBackupKeyClientID, _kCSBackupKeyDestURL,
_kCSBackupKeyDestinationUUID, _kCSBackupKeyDestinationUUIDs,
_kCSBackupKeyDestinationVolumeUUIDs, _kCSBackupKeyExcludeSystem,
_kCSBackupKeyExcludedVolumes, _kCSBackupKeyHealthCheckInterval,
_kCSBackupKeyHostUUIDs, _kCSBackupKeyIncludedVolumes, _kCSBackupKeyMaxSize,
_kCSBackupKeyMobileBackups, _kCSBackupKeySkipPaths, _kCSBackupKeySourceURLs,
_kCSBackupKeyTrickleBackup, _kCSBackupLatestSnapshotSymlinkName,
_kCSBackupLaunchAirPortUtilityNotification, _kCSBackupLaunchPreferencesNotification,
_kCSBackupMTMDeltaStoreTopLevelFolder, _kCSBackupMTMHiddenChangeFilesFolder,
_kCSBackupMessageIdXPCKey, _kCSBackupNewSystemBackupAvailableNotification,
_kCSBackupNewSystemBackupPath, _kCSBackupNotifyDied, _kCSBackupNotifyExclusionsChanged,
_kCSBackupNotifyPrefsChanged, _kCSBackupNotifyProgress, _kCSBackupNotifyThinningBackup,
_kCSBackupNotifyThinningBackupEnded, _kCSBackupPhaseCalculatingChanges,
_kCSBackupPhaseCopying, _kCSBackupPhaseDeletingOldBackups,
_kCSBackupPhaseFinishing, _kCSBackupPhaseHealthCheckCopyHFSMeta,
_kCSBackupPhaseHealthCheckFsck, _kCSBackupPhaseKey, _kCSBackupPhaseMigratingMobileBackups,
_kCSBackupPhaseMountingBackupVolume, _kCSBackupPhaseMountingBackupVolumeForHealthCheck,
_kCSBackupPhaseStarting, _kCSBackupPhaseThinningPostBackup,
_kCSBackupPhaseThinningPreBackup, _kCSBackupPhaseWaitingForSpotlight,
_kCSBackupPlatformSupportPlist, _kCSBackupProductBuildVersion,
_kCSBackupProductVersion, _kCSBackupRecoveryContentsDirectory,
_kCSBackupRecoverySetIndexXPCKey, _kCSBackupRecoverySetsDirectory,
_kCSBackupRecoverySetsDirectoryPath, _kCSBackupRecoverySetsPathXPCKey,
_kCSBackupRequiresACPowerKey, _kCSBackupResultCodeXPCKey,
_kCSBackupSnapshotDatesCachePath, _kCSBackupSnapshotStartDateXAttrKey,
_kCSBackupSnapshotTypeXAttrKey, _kCSBackupSuccessBoolXPCKey,
_kCSBackupSupportedBoardIds, _kCSBackupSuspendHelperActivityTimeStamp,
_kCSBackupSystemVersionPlist, _kCSBackupTMBootPickerVersionXattrKey,
_kCSBackupThinEncryptedRecoverySetsXattrKey, _kCSBackupTopLevelFolder,
_kCSBackupTrickleSnapshotStoreName, _kCSBackupVolumeBytesUsedXAttrKey,
_kCSBackupVolumeCaseSensitiveXAttrKey, _kCSBackupVolumePathXPCKey,
_kCSBackupXPCConnectionName, _kCSBackupXPCSandboxConnectionName,
_kCSBackupXPCStatusConnectionName, _kCSBackupdKeyBytesCopied,
_kCSBackupdKeyClientID, _kCSBackupdKeyDestinationMountPoint,
_kCSBackupdKeyErrorCode, _kCSBackupdKeyFileVaultUser, _kCSBackupdKeyFirstBackup,
_kCSBackupdKeyIsRunning, _kCSBackupdKeyIsStopping, _kCSBackupdKeyLastSystemBackupDate,
_kCSBackupdKeyLatestBackupPath, _kCSBackupdKeyMobileBackupName,
_kCSBackupdKeyMobileBackupsMigrated, _kCSBackupdKeyNumberOfChangedItems,
_kCSBackupdKeyNumberOfDeepScannedItems, _kCSBackupdKeyNumberOfExcludedItems,
_kCSBackupdKeyPercent, _kCSBackupdKeyProgress, _kCSBackupdKeyStats,
_kCSBackupdKeyTimeRemaining, _kCSBackupdKeyTotalBytesCopied,
_kCSBackupdKeyTotalMobileBackupsToMigrate, _kCSBackupdPortName,
_kCSBackupdResultDictionaryPath, _kCSBackupdSignature, _kCSBackupdStatusPortName,
_kCompletionDateXAttrKey, _kFSEventVolumeAboutToRename, _kFSEventVolumeAboutToUnmount,
_kFSEventVolumeMounted, _kFSEventVolumePropertyChanged, _kFSEventVolumeRenamed,
_kFSEventVolumeRepairStarted, _kFSEventVolumeUnmountFailed,
_kFSEventVolumeUnmounted, _kFSFileManagerVolumePropertyChanged,
_kFSFileManagerVolumePropertyMonitor, _kFSIOMediaIconBundleIdentifier,
_kFSIOMediaIconFamilyName, _kFSIsAirportVolume, _kFSIsBDVideo,
_kFSIsDVDVideo, _kFSIsMobileTimeMachine, _kFSIsNetworkOpticalVolume,
_kFSIsTimeMachineVolume, _kFSIsVideoDisk, _kFSOperationBytesCompleteKey,
_kFSOperationBytesRemainingKey, _kFSOperationObjectsCompleteKey,
_kFSOperationObjectsRemainingKey, _kFSOperationThroughputKey,
_kFSOperationTotalBytesKey, _kFSOperationTotalObjectsKey,
_kFSOperationTotalUserVisibleObjectsKey, _kFSOperationUserVisibleObjectsCompleteKey,
_kFSOperationUserVisibleObjectsRemainingKey, _kFSReservationPidArray,
_kFSVolumeIsBeingRepaired, _kFSVolumeIsBeingUnmounted, _kFSVolumePropertyKey,
_kFSVolumeRefNumKey, _kSnapshotContainerXAttrKey, _kSnapshotStateXAttrKey,
_kSnapshotVolumeFSEventStoreUUIDXAttrKey, _kSnapshotVolumeLastEventBackedUpXAttrKey,
_kSnapshotVolumeUUIDXAttrKey, _ldtox80, _lowMem, _num2dec,
_numtostring, _pi, _randomx, _relation, _relstring, _scAddReconnectProc,
_scCopyAllSessionInfo, _scCreateService, _scCreateServiceVersion,
_scCreateSystemService, _scCreateSystemServiceVersion, _scGetProcessOptions,
_scGetServerCheckinPort, _scGetServerOptions, _scPrefsForgetKey,
_scPrefsGetInteger, _scPrefsGetString, _scPrefsPostData, _scPrefsSetInteger,
_scPrefsSetString, _str2dec, _x80tod, _x80told ]
--- !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: 45B3781F-3D4D-3EB1-ABFC-987AE940DABE
- target: x86_64-maccatalyst
value: 45B3781F-3D4D-3EB1-ABFC-987AE940DABE
- target: arm64-macos
value: 00000000-0000-0000-0000-000000000000
- target: arm64-maccatalyst
value: 00000000-0000-0000-0000-000000000000
- target: arm64e-macos
value: 23D9E702-80B5-39E1-9B9B-FEA156349D01
- target: arm64e-maccatalyst
value: 23D9E702-80B5-39E1-9B9B-FEA156349D01
install-name: '/System/Library/Frameworks/CoreServices.framework/Versions/A/Frameworks/DictionaryServices.framework/Versions/A/DictionaryServices'
current-version: 350
parent-umbrella:
- targets: [ x86_64-macos, x86_64-maccatalyst, arm64-macos, arm64-maccatalyst,
arm64e-macos, arm64e-maccatalyst ]
umbrella: CoreServices
exports:
- targets: [ x86_64-macos, arm64e-macos, x86_64-maccatalyst, arm64e-maccatalyst,
arm64-macos, arm64-maccatalyst ]
symbols: [ _DCSActivateDictionaryPanel, _DCSCopyActiveDictionaries, _DCSCopyAvailableDictionaries,
_DCSCopyDefinitionMarkup, _DCSCopyDefinitionRecords, _DCSCopyDefinitions,
_DCSCopyInactiveDictionaries, _DCSCopyLanguagesOfPreparedDefaultDictionaries,
_DCSCopyRecordForReference, _DCSCopyRecordsForHeadword, _DCSCopyRecordsForSearchString,
_DCSCopyRecordsWithHeadword, _DCSCopyTextDefinition, _DCSCreateAppleWordEquivalenceList,
_DCSCreateHeadwordList, _DCSCreateUserDictionariesDirectory,
_DCSDictionaryAssetAttributesDownloaded, _DCSDictionaryAssetAttributesWillBePurged,
_DCSDictionaryAssetCopyDiagnosticLog, _DCSDictionaryAssetCopyDownloadedDictionaryIdentifiers,
_DCSDictionaryAssetCopyRemovedDictionaryIdentifiers, _DCSDictionaryAssetGetAssetType,
_DCSDictionaryAssetGetCompatibilityVersion, _DCSDictionaryCopyResourceURLsOfType,
_DCSDictionaryCreate, _DCSDictionaryCreateWithAssetAttributes,
_DCSDictionaryCreateWithIdentifier, _DCSDictionaryDownloadFinished,
_DCSDictionaryGetAssetObj, _DCSDictionaryGetBaseURL, _DCSDictionaryGetIdentifier,
_DCSDictionaryGetLanguages, _DCSDictionaryGetName, _DCSDictionaryGetParentDictionary,
_DCSDictionaryGetPreference, _DCSDictionaryGetPreferenceHTML,
_DCSDictionaryGetPrimaryLanguage, _DCSDictionaryGetShortName,
_DCSDictionaryGetStyleSheetURL, _DCSDictionaryGetSubDictionaries,
_DCSDictionaryGetTypeID, _DCSDictionaryGetURL, _DCSDictionaryIsLanguageDictionary,
_DCSDictionaryIsNetworkService, _DCSDictionaryIsSupportedDefinitionStyle,
_DCSDictionarySetDataHeader, _DCSDictionarySetPreference,
_DCSGetActiveDictionaries, _DCSGetDefaultDictionary, _DCSGetDefaultThesaurus,
_DCSGetServicePresentationType, _DCSGetTermRangeInString,
_DCSGetTermRangeInStringWithOptions, _DCSHasDefinitionForTerm,
_DCSInvalidateDictionaryCache, _DCSNormalizeSearchString,
_DCSNormalizeSearchStringWithOptionsAndLocale, _DCSPreferredOrderOfDictionaryAssetAttributesForLanguages,
_DCSPrepareMobileAssetQuery, _DCSRecordCopyData, _DCSRecordCopyDataURL,
_DCSRecordCopyDefinition, _DCSRecordCopyTextElements, _DCSRecordGetAnchor,
_DCSRecordGetAssociatedObj, _DCSRecordGetDictionary, _DCSRecordGetHeadword,
_DCSRecordGetRawHeadword, _DCSRecordGetString, _DCSRecordGetSubDictionary,
_DCSRecordGetSupplementalHeadword, _DCSRecordGetTitle, _DCSRecordGetTypeID,
_DCSRecordSetAssociatedObj, _DCSRecordSetHeadword, _DCSSearchFoundationCopyResults,
_DCSSearchFoundationCopyResultsWithOptions, _DCSSearchSessionCreate,
_DCSSearchSessionScheduleWithRunLoop, _DCSSearchSessionUnscheduleFromRunLoop,
_DCSSetActiveDictionaries, _DCSSetServicePresentationType,
_DCSSortRecordsWithHeadword, _IDXAddRecord, _IDXBuildIndexWithRecords,
_IDXContainsMatchData, _IDXCopyIndexNames, _IDXCreateDictionaryPackage,
_IDXCreateFlattenData, _IDXCreateIndexObject, _IDXDeleteRecord,
_IDXGetDataByID, _IDXGetDataPtrByID, _IDXGetFieldDataPtrs,
_IDXGetMatchData, _IDXGetMatchDataPtr, _IDXIndexGetTypeID,
_IDXPerformSearch, _IDXSetRequestFields, _IDXSetSearchCharacters,
_IDXSetSearchString, _IDXSupportDataPtr, _kDCSActiveDictionariesChangedNotification,
_kDCSDictionaryDescriptionLanguage, _kDCSDictionaryIndexLanguage,
_kDCSFilterOptionAllowNetworkServices, _kDCSFilterOptionDescriptionLanguage,
_kDCSFilterOptionIndexLanguage, _kDCSResourceTypePrivateFont,
_kDCSResourceTypeStyleSheet, _kDCSTextElementKeyHeadword,
_kDCSTextElementKeyPartOfSpeech, _kDCSTextElementKeyPronunciation,
_kDCSTextElementKeyRecordID, _kDCSTextElementKeySenses, _kDCSTextElementKeySensesWithAttributes,
_kDCSTextElementKeySyllabifiedHeadword, _kDCSTextElementSenseKeyIsExplicit,
_kDCSTextElementSenseKeyText, _kIDXPropertyDataFieldName,
_kIDXPropertyDataFields, _kIDXPropertyDataSize, _kIDXPropertyDataSizeLength,
_kIDXPropertyExternalFields, _kIDXPropertyFixedFields, _kIDXPropertyIndexAccessMethod,
_kIDXPropertyIndexBigEndian, _kIDXPropertyIndexDataSizeLength,
_kIDXPropertyIndexKeyMatchingMethods, _kIDXPropertyIndexList,
_kIDXPropertyIndexName, _kIDXPropertyIndexPath, _kIDXPropertyIndexSupportDataID,
_kIDXPropertyIndexWritable, _kIDXPropertyVariableFields, _kIDXPropertyVersion,
_kIDXSearchAllMatch, _kIDXSearchCommonPrefixMatch, _kIDXSearchExactMatch,
_kIDXSearchPrefixMatch, _kIDXSearchWildcardMatch ]
--- !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: 542109F0-F83B-3DBC-A947-66C18148446D
- target: x86_64-maccatalyst
value: 542109F0-F83B-3DBC-A947-66C18148446D
- target: arm64-macos
value: 00000000-0000-0000-0000-000000000000
- target: arm64-maccatalyst
value: 00000000-0000-0000-0000-000000000000
- target: arm64e-macos
value: 4FF8C103-0BBC-313E-8FED-3A5964439A4E
- target: arm64e-maccatalyst
value: 4FF8C103-0BBC-313E-8FED-3A5964439A4E
install-name: '/System/Library/Frameworks/CoreServices.framework/Versions/A/Frameworks/FSEvents.framework/Versions/A/FSEvents'
current-version: 1325.0.7
parent-umbrella:
- targets: [ x86_64-macos, x86_64-maccatalyst, arm64-macos, arm64-maccatalyst,
arm64e-macos, arm64e-maccatalyst ]
umbrella: CoreServices
exports:
- targets: [ x86_64-maccatalyst, x86_64-macos, arm64e-maccatalyst, arm64e-macos,
arm64-macos, arm64-maccatalyst ]
symbols: [ _FSEventStreamCopyDescription, _FSEventStreamCopyPathsBeingWatched,
_FSEventStreamCreate, _FSEventStreamCreateRelativeToDevice,
_FSEventStreamFlushAsync, _FSEventStreamFlushSync, _FSEventStreamGetDeviceBeingWatched,
_FSEventStreamGetLatestEventId, _FSEventStreamInvalidate,
_FSEventStreamRelease, _FSEventStreamRetain, _FSEventStreamScheduleWithRunLoop,
_FSEventStreamSetDispatchQueue, _FSEventStreamSetExclusionPaths,
_FSEventStreamShow, _FSEventStreamStart, _FSEventStreamStop,
_FSEventStreamUnscheduleFromRunLoop, _FSEventsCopyUUIDForDevice,
_FSEventsGetCurrentEventId, _FSEventsGetLastEventIdForDeviceBeforeTime,
_FSEventsPurgeEventsForDeviceUpToEventId ]
--- !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: 4D53BFD9-3D56-3BFA-A68A-3F03F355AE78
- target: x86_64-maccatalyst
value: 4D53BFD9-3D56-3BFA-A68A-3F03F355AE78
- target: arm64-macos
value: 00000000-0000-0000-0000-000000000000
- target: arm64-maccatalyst
value: 00000000-0000-0000-0000-000000000000
- target: arm64e-macos
value: 4E0BB03C-088B-3EFA-9FFE-E3DC6E90547D
- target: arm64e-maccatalyst
value: 4E0BB03C-088B-3EFA-9FFE-E3DC6E90547D
install-name: '/System/Library/Frameworks/CoreServices.framework/Versions/A/Frameworks/LaunchServices.framework/Versions/A/LaunchServices'
current-version: 1141.1
parent-umbrella:
- targets: [ x86_64-macos, x86_64-maccatalyst, arm64-macos, arm64-maccatalyst,
arm64e-macos, arm64e-maccatalyst ]
umbrella: CoreServices
allowable-clients:
- targets: [ x86_64-macos, x86_64-maccatalyst, arm64-macos, arm64-maccatalyst,
arm64e-macos, arm64e-maccatalyst ]
clients: [ Foundation ]
exports:
- targets: [ x86_64-maccatalyst, x86_64-macos, arm64e-maccatalyst, arm64e-macos,
arm64-macos, arm64-maccatalyst ]
symbols: [ _AcquireIconRef, _CompositeIconRef, _GetCustomIconsEnabled,
_GetIconRef, _GetIconRefFromComponent, _GetIconRefFromFileInfo,
_GetIconRefFromFolder, _GetIconRefFromIconFamilyPtr, _GetIconRefFromTypeInfo,
_GetIconRefFromUTI, _GetIconRefOwners, _IsDataAvailableInIconRef,
_IsIconRefComposite, _IsValidIconRef, _LSApplicationSINFKey,
_LSApplicationWorkspaceErrorDomain, _LSApplicationsChangedNotificationName,
_LSApplyURLOverridesForContacts, _LSBindingCopyVariant, _LSBlockUntilCompleteKey,
_LSCanRefAcceptItem, _LSCanURLAcceptURL, _LSContinuityErrorDomain,
_LSCopyAllHandlersForURLScheme, _LSCopyAllRoleHandlersForContentType,
_LSCopyApplicationForMIMEType, _LSCopyApplicationURLsForBundleIdentifier,
_LSCopyApplicationURLsForURL, _LSCopyDefaultApplicationURLForContentType,
_LSCopyDefaultApplicationURLForURL, _LSCopyDefaultHandlerForURLScheme,
_LSCopyDefaultRoleHandlerForContentType, _LSCopyDisplayNameForRef,
_LSCopyDisplayNameForURL, _LSCopyItemAttribute, _LSCopyItemAttributes,
_LSCopyItemInfoForRef, _LSCopyItemInfoForURL, _LSCopyKindStringForMIMEType,
_LSCopyKindStringForRef, _LSCopyKindStringForTypeInfo, _LSCopyKindStringForURL,
_LSDefaultApplicationManagementDomain, _LSDefaultIconName,
_LSDisableURLOverrides, _LSDocumentTypesChangedNotificationName,
_LSFileProviderStringKey, _LSFindApplicationForInfo, _LSGeoJSONKey,
_LSGetApplicationForInfo, _LSGetApplicationForItem, _LSGetApplicationForURL,
_LSGetExtensionInfo, _LSGetHandlerOptionsForContentType, _LSGetOpenRoles,
_LSHiddenAppType, _LSInit, _LSInstallTypeKey, _LSInternalApplicationType,
_LSMoveDocumentOnOpenKey, _LSNewsstandArtworkKey, _LSOpenApplication,
_LSOpenApplicationPayloadOptionsKey, _LSOpenCFURLRef, _LSOpenFSRef,
_LSOpenFromRefSpec, _LSOpenFromURLSpec, _LSOpenInBackgroundKey,
_LSOpenItemsWithRole, _LSOpenURLsWithRole, _LSPackageTypeCarrierBundle,
_LSPackageTypeCustomer, _LSPackageTypeDeveloper, _LSPackageTypeKey,
_LSPackageTypePlaceholder, _LSPlugInKitType, _LSReferrerURLKey,
_LSRegisterFSRef, _LSRegisterURL, _LSRequireOpenInPlaceKey,
_LSRestrictedKey, _LSSetDefaultHandlerForURLScheme, _LSSetDefaultRoleHandlerForContentType,
_LSSetExtensionHiddenForRef, _LSSetExtensionHiddenForURL,
_LSSetHandlerOptionsForContentType, _LSSetItemAttribute, _LSSimulatorRootPathKey,
_LSSimulatorUserPathKey, _LSSupressNotificationKey, _LSSystemApplicationType,
_LSSystemPlaceholderType, _LSTargetBSServiceConnectionEndpointKey,
_LSTerm, _LSTypeDeclarationsChangedNotificationName, _LSURLTypesChangedNotificationName,
_LSUninstallUserDataOnly, _LSUpdatePlaceholderIconKey, _LSUserActivityAlwaysEligibleKey,
_LSUserActivityAlwaysPickKey, _LSUserActivityHasWebPageURLOptionKey,
_LSUserActivityIsForPairedDeviceOptionKey, _LSUserActivityIsHighPriorityOptionKey,
_LSUserActivityIsNotificationOptionKey, _LSUserActivityManagerActivityContinuationIsEnabledChangedNotification,
_LSUserActivityTypeNowPlaying, _LSUserActivityTypeSiri, _LSUserActivityTypeTeamIDOverideKey,
_LSUserApplicationType, _LSUserInitiatedUninstall, _LSVPNPluginType,
_LSiTunesArtworkKey, _LSiTunesMetadataKey, _OverrideIconRef,
_ReadIconFromFSRef, _RegisterIconRefFromFSRef, _RegisterIconRefFromIconFamily,
_ReleaseIconRef, _RemoveIconRefOverride, _SetCustomIconsEnabled,
_UTCreateStringForOSType, _UTGetOSTypeFromString, _UTTypeConformsTo,
_UTTypeCopyAllTagsWithClass, _UTTypeCopyChildIdentifiers,
_UTTypeCopyDeclaration, _UTTypeCopyDeclaringBundleURL, _UTTypeCopyDescription,
_UTTypeCopyParentIdentifiers, _UTTypeCopyPreferredTagWithClass,
_UTTypeCreateAllIdentifiersForTag, _UTTypeCreatePreferredIdentifierForTag,
_UTTypeEqual, _UTTypeIsDeclared, _UTTypeIsDynamic, _UTTypeShow,
_UnregisterIconRef, _UpdateIconRef, __FlattenIconRef, __GDBIconRefsList,
__GetIconRefFromIOKitDevice, __GetIconRefFromURL, __IconRefCopyResourceURLs,
__IconRefIsTemplate, __LSASNCreate, __LSASNCreateCopy, __LSASNCreateWithPid,
__LSASNCreateWithUInt64, __LSASNExtractHighAndLowParts, __LSASNGetTypeID,
__LSASNReturnASNForPIDFromWithinCoreServicesd, __LSASNToUInt64,
__LSAddRecentItem, __LSAddToRecentsAfterOpening, __LSAdvertisementBytesKind,
__LSAgentCheckRiskLevelForURL, __LSAgentCopyDisplayNameWithLanguageCode,
__LSAgentGetAuditToken, __LSAllocatePSN, __LSAnnotateAndSendAppleEvent,
__LSAppStateBlockedKey, __LSAppStateInstalledKey, __LSAppStatePlaceholderKey,
__LSAppStateRemovedKey, __LSAppStateRestrictedKey, __LSAppStateValidKey,
__LSApplicationCheckIn, __LSApplicationQuitting, __LSAssertRunningInServer,
__LSBindingCopyIconRef, __LSBindingCopyUTI, __LSBindingCopyVariant,
__LSBindingCreateVariant, __LSBindingCreateWithBookmarkData,
__LSBindingCreateWithData, __LSBindingCreateWithIconRef, __LSBindingCreateWithResourceData,
__LSBindingCreateWithResourceURL, __LSBindingCreateWithTypeInfo,
__LSBindingCreateWithURL, __LSBindingCreateWithUTI, __LSBindingEnumerateIconResourceInfo,
__LSBindingGetBadge, __LSBindingGetCachingProfile, __LSBindingGetDataRepresentation,
__LSBindingGetIconRef, __LSBindingGetLegacyIconRef, __LSBindingGetType,
__LSBindingGetTypeID, __LSBindingGetValidationState, __LSBindingGetValidationToken,
__LSBindingGetVariantFlags, __LSBindingSetLogFile, __LSBindingSetReasonTrackingEnabled,
__LSBindingValidationStateIsStale, __LSBindingValidationStateIsValid,
__LSCEResultAlwaysAllowDeveloperKey, __LSCEResultSubmitMalwareReportKey,
__LSCEResultUnquarantineDiskImageKey, __LSCEResultUnquarantineServerKey,
__LSCanOpenContentsOfPasteboard, __LSCanURLAcceptContentType,
__LSClientSideReconnectionPhase1, __LSCompareASNs, __LSCompareASNsLong,
__LSCompareHashedBytesFromAdvertisingStrings, __LSConflictResolutionContinueOpening,
__LSConflictResolutionCopyDocumentURL, __LSConflictResolverProcessIdentifier,
__LSCopyActivityTypesClaimedHashedAdvertisingStrings, __LSCopyAdvertisementStringForTeamIdentifierAndActivityType,
__LSCopyAllApplicationArray, __LSCopyAllApplicationURLs, __LSCopyAllClaimedContentTypesForApplicationURL,
__LSCopyAllClaimedURLSchemesForApplicationURL, __LSCopyApplicationArray,
__LSCopyApplicationArrayInFrontToBackOrder, __LSCopyApplicationCategories,
__LSCopyApplicationDeathInformationForPid, __LSCopyApplicationInformation,
__LSCopyApplicationInformationItem, __LSCopyApplicationURLsForContentType,
__LSCopyApplicationURLsForItemURL, __LSCopyApplicationURLsWithInfoFlags,
__LSCopyApplicationsWithPath, __LSCopyArchitecturePreferenceForApplicationURL,
__LSCopyBundleIdentifierForRegisteredSurrogate, __LSCopyBundleIdentifierFromSurrogateData,
__LSCopyBundleURLForRegisteredSurrogate, __LSCopyBundleURLWithIdentifier,
__LSCopyClaimedActivityIdentifiersAndDomains, __LSCopyCurrentApplicationASN,
__LSCopyDefaultSchemeHandlerURL, __LSCopyDisplayNameForCanonicalName,
__LSCopyDownloadAssessmentDictionary, __LSCopyFrontApplication,
__LSCopyFrontUIApplication, __LSCopyItemAttributesForRefInfo,
__LSCopyKernelPackageExtensions, __LSCopyKindStringForInfo,
__LSCopyLSASNForAuditToken, __LSCopyLaunchModifiers, __LSCopyLibraryItemURLs,
__LSCopyLoginItemURLWithBundleIdentifiers, __LSCopyMatchingApplications,
__LSCopyMatchingApplicationsWithItems, __LSCopyMetaApplicationInformation,
__LSCopyMetaApplicationInformationItem, __LSCopyNULLApplicationASN,
__LSCopyPendingApplicationArray, __LSCopyProcessQuarantineProperties,
__LSCopyRecentItems, __LSCopyRunningApplicationArray, __LSCopySchemesAndHandlerURLs,
__LSCopySystemApplicationASN, __LSCopyTypeIdentifierForItemRefInfo,
__LSCopyURLOverrideForURL, __LSCopyUserActivityDomainNamesForBundleID,
__LSCopyValidApplicationCategories, __LSCreateCSUIConnectionForLaunching,
__LSCreateDatabaseChangeNotificationNameForCurrentUser, __LSCreateDatabaseLookupStringFromHashedBytesForAdvertising,
__LSCreateDeviceTypeIdentifierWithModelCode, __LSCreateDeviceTypeIdentifierWithModelCodeAndColorComponents,
__LSCreateHashedBytesForAdvertisingFromString, __LSCreatePackageExtensionsArray,
__LSCreateSurrogateDataForApplication, __LSCreateVisualizerForDatabaseAtURL,
__LSCreateVisualizerForDatabaseAtURLWithStore, __LSDServiceGetXPCProxyForServiceClass,
__LSDataContainerPersonalityCopyInfo, __LSDataContainerPersonalityRemoveInfo,
__LSDataContainerPersonalitySetInfo, __LSDataContainerPersonalitySetInfoWithApplicationIdentifier,
__LSDatabaseContextSetDetachProxyObjects, __LSDatabaseCopyURLForUser,
__LSDebugAdvertismentValue, __LSDebugGetSharedMemoryPageAddress,
__LSDefaultLog, __LSDeleteAllQuarantineHistory, __LSDeleteQuarantineHistoryForFileURL,
__LSDeleteQuarantineHistoryInDateRange, __LSDisplayData, __LSEnumerateApplicationsFromSpotlight,
__LSExceptionsGetAppStoreInfoForBundleIdentifier, __LSExceptionsIsBundleIdentifierInternallyBlocked,
__LSExtensionsLog, __LSFindApplications, __LSFindApplicationsItem,
__LSGetApplicationInformationSeed, __LSGetApplicationListSeed,
__LSGetBundle, __LSGetCurrentApplicationASN, __LSGetFrontApplicationSeed,
__LSGetIconRefForURL, __LSGetMainBundleURL, __LSGetMenuBarOwnerApplicationSeed,
__LSGetNotificationInformation, __LSGetPointerAuthKeyStatePreferenceForCurrentApplication,
__LSGetRecentItemCount, __LSGetSharedMemoryPageInfoTEST, __LSGetShowAllExtensionsPreference,
__LSGetStatus, __LSGetVersionFromString, __LSGetVisibleApplicationListSeed,
__LSHandlerRankAlternate, __LSHandlerRankDefault, __LSHandlerRankNone,
__LSHandlerRankOwner, __LSIconDictionarySupportsAssetCatalogs,
__LSInstall_ocon_EventHandler, __LSIsApplicationRunning, __LSKillApplication,
__LSLaunchApplication, __LSLog, __LSMakeVersionNumber, __LSMigrateLaunchServices,
__LSModifyNotification, __LSOpen2CopyDiagnostics, __LSOpen2SetDiagnostics,
__LSOpenApplicationURL, __LSOpenCallInvokeWithXPC, __LSOpenContentsOfPasteboardWithCompletionHandler,
__LSOpenExtractBackgroundLaunchReasonFromAppleEvent, __LSOpenURLWithCompletionHandler,
__LSOpenURLsUsingASNWithCompletionHandler, __LSOpenURLsUsingBundleIdentifierWithCompletionHandler,
__LSOpenURLsWithCompletionHandler, __LSOrderApplications,
__LSPassDownCurrentEventState, __LSPersistentIdentifierCompare,
__LSPersistentIdentifierGetDebugDescription, __LSPersistentIdentifierGetKnowledgeUUID4CoreDevice,
__LSPersistentIdentifierGetSequenceNumber4CoreDevice, __LSPostLaunchModifiers,
__LSQuarantinePropertiesCreateData, __LSQuarantinePropertiesCreateWithBytes,
__LSReCheckinApplication, __LSReRegisterNotifications, __LSRecentItemsChanged,
__LSRecentsInit, __LSRegisterAsSessionLauncherClient, __LSRegisterExtensionPointInfo,
__LSRegisterFilePropertyProvider, __LSRegisterLibraryBundle,
__LSRegisterNamedXPCConnection, __LSRegisterPlatformExtensionPointInfo,
__LSRegisterPlatformFrameworkExtensionPointInfo, __LSRegisterPluginURL,
__LSRegisterURLWithOptions, __LSRemoveDefaultRoleHandlerForContentType,
__LSRemoveRecentItems, __LSRequestProcessBecomeFrontmost,
__LSSaveAndRefresh, __LSScheduleNotificationFunction, __LSScheduleNotificationFunctionOnQueue_f,
__LSScheduleNotificationOnQueueWithBlock, __LSSecretManagementDecryptData,
__LSSecretManagementEncryptData, __LSSecretManagementVersion,
__LSSendNotification, __LSServerMain, __LSSetApplicationCategories,
__LSSetApplicationInformation, __LSSetApplicationInformationItem,
__LSSetApplicationLaunchServicesServerConnectionStatus, __LSSetArchitecturePreferenceForApplicationURL,
__LSSetDatabaseIsSeeded, __LSSetDefaultSchemeHandlerURL, __LSSetDefaultSchemeHandlerURLWaitingUntilDone,
__LSSetDefaultWebBrowserWithApplicationURL, __LSSetDefaultWebBrowserWithBundleIdentifierAndVersion,
__LSSetDefaultXPCConnection, __LSSetFrontApplication, __LSSetFrontApplicationLong,
__LSSetFrontApplicationLongWithCompletion, __LSSetMetaApplicationInformation,
__LSSetMetaApplicationInformationItem, __LSSetPointerAuthKeyStatePreferenceForCurrentApplication,
__LSSetProcessQuarantineProperties, __LSSetRecentItemCount,
__LSSetShowAllExtensionsPreference, __LSSetUpClientSideReconnectionServices,
__LSSetWeakBindingForFileURL, __LSSetWeakBindingURLForType,
__LSSetWeakBindingURLForUTI, __LSSharedMemoryBumpApplicationInformationSeed,
__LSSharedMemoryBumpApplicationListSeed, __LSSharedMemoryBumpFrontApplicationASNSeed,
__LSSharedMemoryBumpMenuBarOwnerASNSeed, __LSSharedMemoryBumpPendingApplicationListSeed,
__LSSharedMemoryBumpVisibleApplicationListSeed, __LSSharedMemoryClearIndexedApplicationInformation,
__LSSharedMemoryCopyForSessionID, __LSSharedMemoryCopySystemUIPresentationModeStrRef,
__LSSharedMemoryGetApplicationInformation, __LSSharedMemoryGetApplicationInformationForPid,
__LSSharedMemoryGetApplicationInformationSeed, __LSSharedMemoryGetApplicationListCount,
__LSSharedMemoryGetApplicationListSeed, __LSSharedMemoryGetCGSSessionID,
__LSSharedMemoryGetChangeCount, __LSSharedMemoryGetDebugLevel,
__LSSharedMemoryGetExpectedFrontApplicationASNLow, __LSSharedMemoryGetFrontASNLow,
__LSSharedMemoryGetFrontApplicationASNSeed, __LSSharedMemoryGetIndexedApplicationAdditionalInformation,
__LSSharedMemoryGetIndexedApplicationInformation, __LSSharedMemoryGetLaunchProgressFlags,
__LSSharedMemoryGetLaunchProgressUserActivityCount, __LSSharedMemoryGetLockCount,
__LSSharedMemoryGetMenuBarOwnerASNLow, __LSSharedMemoryGetMenuBarOwnerASNSeed,
__LSSharedMemoryGetMetaInformationFlags, __LSSharedMemoryGetNextAppToBringForwardASNLow,
__LSSharedMemoryGetPagePtr, __LSSharedMemoryGetPendingApplicationListSeed,
__LSSharedMemoryGetSessionID, __LSSharedMemoryGetSessionLauncherASNLow,
__LSSharedMemoryGetSize, __LSSharedMemoryGetSystemProcessASNLow,
__LSSharedMemoryGetSystemUIPresentationMode, __LSSharedMemoryGetSystemUIPresentationModeStrRef,
__LSSharedMemoryGetSystemUIPresentationOptions, __LSSharedMemoryGetTypeID,
__LSSharedMemoryGetVersion, __LSSharedMemoryGetVisibleApplicationListSeed,
__LSSharedMemoryIncrementLaunchProgressUserActivityCount,
__LSSharedMemoryInvalidateCachedSharedMemoryPages, __LSSharedMemoryIsApplicationInformationUsable,
__LSSharedMemoryIsLocked, __LSSharedMemoryIsUnlocked, __LSSharedMemoryLock,
__LSSharedMemoryPageCreate, __LSSharedMemorySetApplicationInformationFromToken,
__LSSharedMemorySetApplicationListCount, __LSSharedMemorySetCGSSessionID,
__LSSharedMemorySetDebugLevel, __LSSharedMemorySetExpectedFrontApplicationASNLow,
__LSSharedMemorySetFrontASNLow, __LSSharedMemorySetIndexedApplicationInformation,
__LSSharedMemorySetLaunchProgressFlags, __LSSharedMemorySetMenuBarOwnerASNLow,
__LSSharedMemorySetMetaInformationFlags, __LSSharedMemorySetNextAppToBringForwardASNLow,
__LSSharedMemorySetSessionLauncherASNLow, __LSSharedMemorySetSystemProcessASNLow,
__LSSharedMemorySetSystemUIPresentationMode, __LSSharedMemorySetSystemUIPresentationOptions,
__LSSharedMemoryUnlock, __LSSignalApplicationReady, __LSStartLaunchedApplication,
__LSURLBindingReasonKey, __LSURLIsDataContainer4IS, __LSUnregisterPluginsInDirectory,
__LSUnregisterURL, __LSUnregisterURLsRelativeToURL, __LSUnscheduleNotificationFunction,
__LSUpdateRegistrationForURLsRelativeToURL, __LSUseCoreApplicationServices,
__LSUserActivityContainsFileProviderURLKey, __LSUserActivityContainsUnsynchronizedCloudDocsKey,
__LSUserActivityOptionInvalidateAfterFetchKey, __LSVersionNumberCompare,
__LSVersionNumberCopyStringRepresentation, __LSVersionNumberGetBugFixComponent,
__LSVersionNumberGetCurrentSystemVersion, __LSVersionNumberGetMajorComponent,
__LSVersionNumberGetMinorComponent, __LSVersionNumberGetStringRepresentation,
__LSVersionNumberHash, __LSVersionNumberMakeWithString, __LSWaitForApplicationCheckIn,
__LSWaitUntilSeedingComplete, __LSWriteApplicationPlaceholderToURL,
__LSWriteSurrogateForApplicationToURL, __UTCopyDeclaredTypeIdentifiers,
__UTTypeCopyDescriptionLocalizationDictionary, __UTTypeCopyDynamicIdentifiersForTags,
__UTTypeCopyGlyphName, __UTTypeCopyIconFileURL, __UTTypeCopyIconName,
__UTTypeCopyIdentifierForPromiseAtURL, __UTTypeCopyKindStringDictionaryForNonMaterializedItem,
__UTTypeCopyKindStringForNonMaterializedItem, __UTTypeCopyPedigree,
__UTTypeCopyPedigreeSet, __UTTypeCreateDynamicIdentifierForTaggedPointerObject,
__UTTypeCreateSuggestedFilename, __UTTypeGetStatus, __UTTypeHash,
__UTTypeIdentifierIsValid, __UTTypeIsWildcard, __UTTypePrecachePropertiesOfIdentifiers,
__UnlattenIconRef, ___LSDefaultsGetSharedInstance, __kLSASNKey,
__kLSASNToBringForwardAtNextApplicationExitKey, __kLSActivePageUserVisibleOriginsKey,
__kLSAddToPermittedFrontASNsArrayKey, __kLSAllowedToBecomeFrontmostKey,
__kLSApplicationBackgroundOnlyTypeKey, __kLSApplicationBackgroundPriorityKey,
__kLSApplicationCountKey, __kLSApplicationDelayLaunchUntilTimeKey,
__kLSApplicationDesiresAttentionKey, __kLSApplicationDoNotTALRelaunchKey,
__kLSApplicationForegroundPriorityKey, __kLSApplicationForegroundTypeKey,
__kLSApplicationHasRegisteredKey, __kLSApplicationHasSignalledItIsReadyKey,
__kLSApplicationInSandboxKey, __kLSApplicationInStoppedStateKey,
__kLSApplicationInThrottledStateAfterLaunchKey, __kLSApplicationInformationSeedKey,
__kLSApplicationIsBetaKey, __kLSApplicationIsHiddenKey, __kLSApplicationListSeedKey,
__kLSApplicationLockedInStoppedStateKey, __kLSApplicationOverriddenBackgroundDomainNameKey,
__kLSApplicationReadyToBeFrontableKey, __kLSApplicationSandboxedInformationItemsKey,
__kLSApplicationTypeKey, __kLSApplicationTypeToRestoreKey,
__kLSApplicationUIElementTypeKey, __kLSApplicationVersionKey,
__kLSApplicationWasTerminatedByTALKey, __kLSApplicationWouldBeTerminatedByTALKey,
__kLSApplicationsRecordingAppleEventsKey, __kLSArchitectureARM64Value,
__kLSArchitectureKey, __kLSArchitecturePowerPC64Value, __kLSArchitecturePowerPCValue,
__kLSArchitectureUnknownValue, __kLSArchitecturei386Value,
__kLSArchitecturex86_64Value, __kLSAuditTokenKey, __kLSBackgroundPriorityKey,
__kLSBackgroundPriorityOnceKey, __kLSBindingResourceInfoBadgeableKey,
__kLSBindingResourceInfoNameKey, __kLSBindingResourceInfoResourceKey,
__kLSBindingResourceInfoVariantFlagsKey, __kLSBringForwardDelayKey,
__kLSBringForwardRequestCausedByUserIntentKey, __kLSBringForwardRequestForcedKey,
__kLSBringForwardRequestIfFrontReservationExistsKey, __kLSBringForwardRequestImmediateKey,
__kLSBringForwardRequestStandardActivationKey, __kLSBringForwardWindowIDKey,
__kLSBringNextApplicationForwardKey, __kLSBundleIdentifierLowerCaseKey,
__kLSBundleNameLowerCaseKey, __kLSBundlePathDeviceIDKey, __kLSBundlePathINodeKey,
__kLSBundlePathKey, __kLSBundlePathLastComponentLowerCaseKey,
__kLSBundlePathSandboxExtensionKey, __kLSCheckInTimeKey, __kLSDYLDPlatformKey,
__kLSDataContainerPersonalityIconKey, __kLSDataContainerPersonalityLocalizedNameKey,
__kLSDebugLevelKey, __kLSDisableAllPostLaunchBringForwardRequestsKey,
__kLSDisplayNameKey, __kLSDoNotBFIfFrontApplicationSeedIsChangedKey,
__kLSDoNotBringAllWindowsForwardKey, __kLSDoNotBringAnyWindowsForwardKey,
__kLSDoNotSetTaskPolicyAutomaticallyKey, __kLSDontDropRootPermissionsKey,
__kLSErrorMessageStringKey, __kLSExecutableFilenameLowerCaseKey,
__kLSExecutableFormatCFMKey, __kLSExecutableFormatKey, __kLSExecutableFormatMachOKey,
__kLSExecutableFormatPoundBangKey, __kLSExecutablePathDeviceIDKey,
__kLSExecutablePathINodeKey, __kLSExecutablePathKey, __kLSExecutablePlatformKey,
__kLSExecutableSDKVersionKey, __kLSExitStatusKey, __kLSExpectedFrontApplicationASNKey,
__kLSFileCreatorKey, __kLSFileTypeKey, __kLSFlavorKey, __kLSForegroundPriorityKey,
__kLSForegroundPriorityOnceKey, __kLSFrontASNKey, __kLSFrontApplicationSeedKey,
__kLSFrontReservationExistsKey, __kLSHiddenApplicationCountKey,
__kLSIsProxiedForTALKey, __kLSKeyBeingAddedKey, __kLSKeyBeingChangedKey,
__kLSKeyBeingRemovedKey, __kLSKnownLSSessionIDsKey, __kLSLaunchBeforeTranslocationLaunchBundlePathDeviceIDKey,
__kLSLaunchBeforeTranslocationLaunchBundlePathINodeKey, __kLSLaunchBeforeTranslocationLaunchBundlePathKey,
__kLSLaunchBeforeTranslocationLaunchExecutablePathDeviceIDKey,
__kLSLaunchBeforeTranslocationLaunchExecutablePathINodeKey,
__kLSLaunchBeforeTranslocationLaunchExecutablePathKey, __kLSLaunchDLabelKey,
__kLSLaunchEventRecordTimeKey, __kLSLaunchInProgressKey, __kLSLaunchModifierAddPSNToArgumentListKey,
__kLSLaunchModifierAdditionalEnvironmentVarsDictKey, __kLSLaunchModifierArchitectures,
__kLSLaunchModifierAsGIDKey, __kLSLaunchModifierAsUIDKey,
__kLSLaunchModifierAsyncKey, __kLSLaunchModifierDataKey, __kLSLaunchModifierDataTypeAppParametersKey,
__kLSLaunchModifierDataTypeAppleEventKey, __kLSLaunchModifierDataTypeKey,
__kLSLaunchModifierDoNotAddCOMMAND_MODEEnvironmentVariableKey,
__kLSLaunchModifierDoNotAddToRecentApplicationsKey, __kLSLaunchModifierDoNotMakeFrontmostWhenReadyKey,
__kLSLaunchModifierFailureErrorCodeKey, __kLSLaunchModifierFailureErrorStringKey,
__kLSLaunchModifierForce32Bit, __kLSLaunchModifierFullEnvironmentVarsDictKey,
__kLSLaunchModifierLaunchAndHideOthersKey, __kLSLaunchModifierLaunchAndLetLauncherStartProcessKey,
__kLSLaunchModifierLaunchInStoppedStateKey, __kLSLaunchModifierLaunchWithASLRDisabledKey,
__kLSLaunchModifierLaunchedHiddenKey, __kLSLaunchModifierLeaveOpenFilesAloneKey,
__kLSLaunchModifierLeaveSTDERRAloneKey, __kLSLaunchModifierLeaveSTDINAloneKey,
__kLSLaunchModifierLeaveSTDOUTAloneKey, __kLSLaunchModifierNewCopyKey,
__kLSLaunchModifierOverriddenApplicationType, __kLSLaunchModifierRefConKey,
__kLSLaunchModifierUMaskKey, __kLSLaunchModifierUserActivityCountAtLaunchKey,
__kLSLaunchModifierWithLoginKey, __kLSLaunchModifiersBFIfFrontSeedChangesDuringLaunchKey,
__kLSLaunchModifiersBFIfMouseButtonIsDownDuringLaunchKey,
__kLSLaunchModifiersBFIfUserActivityOccursDuringLaunchKey,
__kLSLaunchModifiersFrontApplicationSeedKey, __kLSLaunchModifiersKey,
__kLSLaunchModifiersLaunchProgressTimeoutKey, __kLSLaunchModifiersLaunchedBecauseOfPersistenceKey,
__kLSLaunchModifiersTimeoutBeforeRestoringBackgroundPriorityKey,
__kLSLaunchTimeKey, __kLSLaunchedByLaunchServicesKey, __kLSLaunchedByLaunchServicesThruForkExecKey,
__kLSLaunchedByLaunchServicesThruLaunchDKey, __kLSLaunchedByLaunchServicesThruSessionLauncherKey,
__kLSLaunchedInQuarantineKey, __kLSLaunchedPersonaUIDKey,
__kLSMenuBarOwnerApplicationSeedKey, __kLSMenuBarOwningASNKey,
__kLSMetaExpectedFrontAppsASNsKey, __kLSMetaInfoActiveCGSSessionIDKey,
__kLSMetaInfoAddUIDsToSessionKey, __kLSMetaInfoCGSSessionIDKey,
__kLSMetaMultiplyProhibitedApplicationBundleIDsArrayKey, __kLSMetaProcessShouldNotConnectToLSServerKey,
__kLSMetaRecentApplicationsArrayIntervalKey, __kLSMetaRecentApplicationsArrayKey,
__kLSMetaRecentApplicationsArraySizeKey, __kLSModifierLaunchedForPersistenceKey,
__kLSModifierRefConKey, __kLSMouseButtonDownKey, __kLSNotificationsDelayedCountKey,
__kLSNotificationsPendingCountKey, __kLSNotificationsSentCountKey,
__kLSNotifyBecameFrontmostAnotherLaunchKey, __kLSNotifyBecameFrontmostFirstActivationKey,
__kLSNotifyLaunchRequestArgumentListKey, __kLSNotifyLaunchRequestLaunchModifiersKey,
__kLSOpenOptionAEParamDescKey, __kLSOpenOptionAEParamKeyKey,
__kLSOpenOptionActivateKey, __kLSOpenOptionAddToRecentsKey,
__kLSOpenOptionAllowConflictResolutionUIKey, __kLSOpenOptionAllowErrorUIKey,
__kLSOpenOptionAllowLoginUIKey, __kLSOpenOptionAlwaysOpenPasteboardContentsKey,
__kLSOpenOptionArchitectureKey, __kLSOpenOptionArchitectureSubtypeKey,
__kLSOpenOptionArgumentsKey, __kLSOpenOptionBackgroundLaunchInformationKey,
__kLSOpenOptionBackgroundLaunchKey, __kLSOpenOptionBackgroundLaunchReasonKey,
__kLSOpenOptionCaptureDiagnosticsKey, __kLSOpenOptionEnableURLOverridesKey,
__kLSOpenOptionEnvironmentVariablesKey, __kLSOpenOptionForegroundLaunchKey,
__kLSOpenOptionHideKey, __kLSOpenOptionHideOthersKey, __kLSOpenOptionInitialAppleEventKey,
__kLSOpenOptionLaunchSessionIDDKey, __kLSOpenOptionLaunchStdErrPathKey,
__kLSOpenOptionLaunchStdInPathKey, __kLSOpenOptionLaunchStdOutPathKey,
__kLSOpenOptionLaunchUIDKey, __kLSOpenOptionLaunchWhenThisProcessExitsKey,
__kLSOpenOptionLaunchedByPersistenceKey, __kLSOpenOptionOverrideBackgroundPriorityDomainNameKey,
__kLSOpenOptionPreferRunningInstanceKey, __kLSOpenOptionPrintDocumentsKey,
__kLSOpenOptionRequiresUniversalLinksKey, __kLSOpenOptionRolesMaskKey,
__kLSOpenOptionStopProcessKey, __kLSOpenOptionUIElementLaunchKey,
__kLSOpenOptionUserInfoKey, __kLSOpenOptionWaitForApplicationToCheckInKey,
__kLSOriginalExecutablePathDeviceIDKey, __kLSOriginalExecutablePathINodeKey,
__kLSOriginalExecutablePathKey, __kLSOriginalPIDKey, __kLSPIDKey,
__kLSPIDsInSessionKey, __kLSPSNToBringForwardAtNextApplicationExitKey,
__kLSParentASNKey, __kLSParentASNWasInferredKey, __kLSPermittedFrontASNsArrayKey,
__kLSPersistenceSuppressRelaunchAtLoginKey, __kLSPidThisProcessIsAWrapperForKey,
__kLSPidThisProcessIsWrappingKey, __kLSPluginBundleIdentifierKey,
__kLSPreviousASNKey, __kLSPreviousPresentationModeKey, __kLSPreviousValueKey,
__kLSRecordingAppleEventsKey, __kLSRemoveFromPermittedFrontASNsArrayKey,
__kLSServerMessageCountKey, __kLSSessionAttributesKey, __kLSSessionIDKey,
__kLSSessionLauncherASNKey, __kLSShellExecutablePathKey, __kLSSystemProcessASNKey,
__kLSUIDsInSessionKey, __kLSUIPresentationModeAllHiddenValue,
__kLSUIPresentationModeAllSuppressedValue, __kLSUIPresentationModeContentHiddenValue,
__kLSUIPresentationModeContentSuppressedValue, __kLSUIPresentationModeKey,
__kLSUIPresentationModeNormalValue, __kLSUIPresentationOptionsKey,
__kLSUnhiddenApplicationCountKey, __kLSUserActivityCountKey,
__kLSVisibleApplicationCountKey, __kLSVisibleApplicationListSeedKey,
__kLSWantsToComeForwardAtRegistrationTimeKey, __kUTTypeGlyphNameKey,
__kUTTypeIconNameKey, __kUTTypeIconsKey, __kUTTypePassBundle,
__kUTTypePassData, _kLSAppleInternalLibraryBundleIdentifier,
_kLSComputerRootCanonicalName, _kLSCurrentDeviceModelCode,
_kLSDefaultLocalizedValueKey, _kLSItemContentType, _kLSItemDisplayKind,
_kLSItemDisplayName, _kLSItemExtension, _kLSItemExtensionIsHidden,
_kLSItemFileCreator, _kLSItemFileType, _kLSItemIsInvisible,
_kLSItemQuarantineProperties, _kLSItemRoleHandlerDisplayName,
_kLSLocalLibraryBundleIdentifier, _kLSMeetingRoomCanonicalName,
_kLSNetworkLibraryBundleIdentifier, _kLSNetworkRootCanonicalName,
_kLSNotificationDatabaseSeedingComplete, _kLSNotificationDatabaseSeedingStart,
_kLSNotificationSystemConfigurationChange, _kLSQuarantineAgentBundleIdentifierKey,
_kLSQuarantineAgentNameKey, _kLSQuarantineDataURLKey, _kLSQuarantineOriginURLKey,
_kLSQuarantineTimeStampKey, _kLSQuarantineTypeCalendarEventAttachment,
_kLSQuarantineTypeEmailAttachment, _kLSQuarantineTypeInstantMessageAttachment,
_kLSQuarantineTypeKey, _kLSQuarantineTypeOtherAttachment,
_kLSQuarantineTypeOtherDownload, _kLSQuarantineTypeWebDownload,
_kLSRemoteDiscRootCanonicalName, _kLSSystemLibraryBundleIdentifier,
_kLSUserLibraryBundleIdentifier, _kLSVersionNumberNull, _kUTExportedTypeDeclarationsKey,
_kUTImportedTypeDeclarationsKey, _kUTTagClassDeviceModelCode,
_kUTTagClassFilenameExtension, _kUTTagClassMIMEType, _kUTTagClassNSPboardType,
_kUTTagClassOSType, _kUTType3DContent, _kUTTypeAVIMovie, _kUTTypeAliasFile,
_kUTTypeAliasRecord, _kUTTypeAppCategory, _kUTTypeAppCategoryActionGames,
_kUTTypeAppCategoryAdventureGames, _kUTTypeAppCategoryArcadeGames,
_kUTTypeAppCategoryBoardGames, _kUTTypeAppCategoryBusiness,
_kUTTypeAppCategoryCardGames, _kUTTypeAppCategoryCasinoGames,
_kUTTypeAppCategoryDeveloperTools, _kUTTypeAppCategoryDiceGames,
_kUTTypeAppCategoryEducation, _kUTTypeAppCategoryEducationalGames,
_kUTTypeAppCategoryEntertainment, _kUTTypeAppCategoryFamilyGames,
_kUTTypeAppCategoryFinance, _kUTTypeAppCategoryGames, _kUTTypeAppCategoryGraphicsDesign,
_kUTTypeAppCategoryHealthcareFitness, _kUTTypeAppCategoryKidsGames,
_kUTTypeAppCategoryLifestyle, _kUTTypeAppCategoryMedical,
_kUTTypeAppCategoryMusic, _kUTTypeAppCategoryMusicGames, _kUTTypeAppCategoryNews,
_kUTTypeAppCategoryPhotography, _kUTTypeAppCategoryProductivity,
_kUTTypeAppCategoryPuzzleGames, _kUTTypeAppCategoryRacingGames,
_kUTTypeAppCategoryReference, _kUTTypeAppCategoryRolePlayingGames,
_kUTTypeAppCategorySimulationGames, _kUTTypeAppCategorySocialNetworking,
_kUTTypeAppCategorySports, _kUTTypeAppCategorySportsGames,
_kUTTypeAppCategoryStrategyGames, _kUTTypeAppCategoryTravel,
_kUTTypeAppCategoryTriviaGames, _kUTTypeAppCategoryUtilities,
_kUTTypeAppCategoryVideo, _kUTTypeAppCategoryWeather, _kUTTypeAppCategoryWordGames,
_kUTTypeAppleICNS, _kUTTypeAppleMac, _kUTTypeAppleProtectedMPEG4Audio,
_kUTTypeAppleProtectedMPEG4Video, _kUTTypeAppleScript, _kUTTypeApplication,
_kUTTypeApplicationBundle, _kUTTypeApplicationFile, _kUTTypeApplicationsFolder,
_kUTTypeArchive, _kUTTypeAssemblyLanguageSource, _kUTTypeAudio,
_kUTTypeAudioInterchangeFileFormat, _kUTTypeAudiovisualContent,
_kUTTypeBMP, _kUTTypeBinaryPropertyList, _kUTTypeBookmark,
_kUTTypeBundle, _kUTTypeBzip2Archive, _kUTTypeCHeader, _kUTTypeCPlusPlusHeader,
_kUTTypeCPlusPlusSource, _kUTTypeCSource, _kUTTypeCalendarEvent,
_kUTTypeCommaSeparatedText, _kUTTypeCompositeContent, _kUTTypeComputer,
_kUTTypeConformsToKey, _kUTTypeContact, _kUTTypeContent, _kUTTypeData,
_kUTTypeDatabase, _kUTTypeDelimitedText, _kUTTypeDeprecatedApplicationFile,
_kUTTypeDescriptionKey, _kUTTypeDevice, _kUTTypeDirectory,
_kUTTypeDiskImage, _kUTTypeDotMac, _kUTTypeDropFolder, _kUTTypeElectronicPublication,
_kUTTypeEmailMessage, _kUTTypeExecutable, _kUTTypeFileSharepoint,
_kUTTypeFileURL, _kUTTypeFlatRTFD, _kUTTypeFolder, _kUTTypeFont,
_kUTTypeFramework, _kUTTypeGIF, _kUTTypeGNUZipArchive, _kUTTypeGenericPC,
_kUTTypeHTML, _kUTTypeICO, _kUTTypeIconFileKey, _kUTTypeIdentifierKey,
_kUTTypeImage, _kUTTypeInkText, _kUTTypeInternetLocation,
_kUTTypeItem, _kUTTypeJPEG, _kUTTypeJPEG2000, _kUTTypeJSON,
_kUTTypeJavaArchive, _kUTTypeJavaClass, _kUTTypeJavaScript,
_kUTTypeJavaSource, _kUTTypeLibraryFolder, _kUTTypeLivePhoto,
_kUTTypeLog, _kUTTypeM3UPlaylist, _kUTTypeMIDIAudio, _kUTTypeMP3,
_kUTTypeMPEG, _kUTTypeMPEG2TransportStream, _kUTTypeMPEG2Video,
_kUTTypeMPEG4, _kUTTypeMPEG4Audio, _kUTTypeMessage, _kUTTypeMountPoint,
_kUTTypeMovie, _kUTTypeNetworkNeighborhood, _kUTTypeOSAScript,
_kUTTypeOSAScriptBundle, _kUTTypeObjectiveCPlusPlusSource,
_kUTTypeObjectiveCSource, _kUTTypePDF, _kUTTypePHPScript,
_kUTTypePICT, _kUTTypePKCS12, _kUTTypePNG, _kUTTypePackage,
_kUTTypePerlScript, _kUTTypePlainText, _kUTTypePlaylist, _kUTTypePluginBundle,
_kUTTypePresentation, _kUTTypePropertyList, _kUTTypePythonScript,
_kUTTypeQuickLookGenerator, _kUTTypeQuickTimeImage, _kUTTypeQuickTimeMovie,
_kUTTypeRTF, _kUTTypeRTFD, _kUTTypeRawImage, _kUTTypeReferenceURLKey,
_kUTTypeResolvable, _kUTTypeRubyScript, _kUTTypeScalableVectorGraphics,
_kUTTypeScript, _kUTTypeServersFolder, _kUTTypeShellScript,
_kUTTypeSourceCode, _kUTTypeSpotlightImporter, _kUTTypeSpreadsheet,
_kUTTypeSwiftSource, _kUTTypeSymLink, _kUTTypeSystemPreferencesPane,
_kUTTypeTIFF, _kUTTypeTXNTextAndMultimediaData, _kUTTypeTabSeparatedText,
_kUTTypeTagSpecificationKey, _kUTTypeText, _kUTTypeToDoItem,
_kUTTypeTraditionalMacPlainText, _kUTTypeURL, _kUTTypeURLBookmarkData,
_kUTTypeUTF16ExternalPlainText, _kUTTypeUTF16PlainText, _kUTTypeUTF8PlainText,
_kUTTypeUTF8TabSeparatedText, _kUTTypeUnixExecutable, _kUTTypeVCard,
_kUTTypeVersionKey, _kUTTypeVideo, _kUTTypeVolume, _kUTTypeWaveformAudio,
_kUTTypeWebArchive, _kUTTypeWindowsExecutable, _kUTTypeX509Certificate,
_kUTTypeXML, _kUTTypeXMLPropertyList, _kUTTypeXPCService,
_kUTTypeZipArchive ]
objc-classes: [ LSAppLink, LSAppTranslocationResult, LSApplicationExtensionRecord,
LSApplicationIdentity, LSApplicationProxy, LSApplicationRecord,
LSApplicationWorkspace, LSApplicationWorkspaceObserver, LSBundleInfoCachedValues,
LSBundleProxy, LSBundleRecord, LSBundleWrapperCreator, LSBundleWrapperStagingReceipt,
LSBundleWrapperUpdater, LSClaimBinding, LSClaimBindingConfiguration,
LSClaimRecord, LSCodeEvaluation, LSCodeEvaluationInfo, LSDatabaseContext,
LSDocumentProxy, LSEnumerator, LSExtensionPoint, LSExtensionPointRecord,
LSIconResource, LSObserver, LSOpenWithMenuConstructor, LSPlugInKitProxy,
LSPlugInQuery, LSPlugInQueryWithIdentifier, LSPlugInQueryWithQueryDictionary,
LSPlugInQueryWithURL, LSPropertyList, LSRecord, LSRecordPromise,
LSResourceProxy, LSServiceRecord, LSSpotlightAction, UTTypeRecord,
_LSApplicationState, _LSDatabase, _LSDefaults, _LSDiskUsage,
_LSDisplayNameConstructor, _LSExceptions, _LSInternetLocator,
_LSLazyPropertyList, _LSOpenConfiguration, _LSQuery, _LSQueryContext,
_LSQueryResult, _LSRecordEnumerator, _LSStringLocalizer, _LSURLOverride ]
objc-ivars: [ _LSDatabase.schema, _LSDatabase.store ]
reexports:
- targets: [ x86_64-maccatalyst, x86_64-macos, arm64e-maccatalyst, arm64e-macos,
arm64-macos, arm64-maccatalyst ]
objc-classes: [ NSUserActivity ]
--- !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: 16862C7C-BFF9-368F-A2A0-B2FB630E5E6D
- target: x86_64-maccatalyst
value: 16862C7C-BFF9-368F-A2A0-B2FB630E5E6D
- target: arm64-macos
value: 00000000-0000-0000-0000-000000000000
- target: arm64-maccatalyst
value: 00000000-0000-0000-0000-000000000000
- target: arm64e-macos
value: 8B70FB9F-57B2-30D4-A1B4-1FF35BFF1194
- target: arm64e-maccatalyst
value: 8B70FB9F-57B2-30D4-A1B4-1FF35BFF1194
install-name: '/System/Library/Frameworks/CoreServices.framework/Versions/A/Frameworks/Metadata.framework/Versions/A/Metadata'
current-version: 2179.2
parent-umbrella:
- targets: [ x86_64-macos, x86_64-maccatalyst, arm64-macos, arm64-maccatalyst,
arm64e-macos, arm64e-maccatalyst ]
umbrella: CoreServices
allowable-clients:
- targets: [ x86_64-macos, x86_64-maccatalyst, arm64-macos, arm64-maccatalyst,
arm64e-macos, arm64e-maccatalyst ]
clients: [ Foundation ]
exports:
- targets: [ x86_64-maccatalyst, x86_64-macos, arm64e-maccatalyst, arm64e-macos,
arm64-macos, arm64-maccatalyst ]
symbols: [ _MDBackupBegin, _MDBackupCancel, _MDBackupCreate, _MDBackupEnd,
_MDBackupFileWasIndexed, _MDBackupFinishedForVolume, _MDBackupFlushFallbackBackup,
_MDBackupIndexFile, _MDBackupPendingUnmount, _MDBackupQuiescentForVolume,
_MDBackupResume, _MDBackupWriteRawAttributesToPath, _MDCopyLabelKinds,
_MDCopyLabelWithID, _MDCopyLabelWithUUID, _MDCopyLabelsMatchingExpression,
_MDCopyLabelsWithKind, _MDCopyPathForSpotlight, _MDCopySessionBegin,
_MDCopySessionCancel, _MDCopySessionCreate, _MDCopySessionEnd,
_MDCopySessionEnterUserDirectory, _MDCopySessionIndexFile,
_MDCopySessionLeaveUserDirectory, _MDItemCopyAttribute, _MDItemCopyAttributeNames,
_MDItemCopyAttributes, _MDItemCopyAttributesBulk, _MDItemCopyLabels,
_MDItemCreate, _MDItemCreateForAbsolutePaths, _MDItemCreateWithURL,
_MDItemGetTypeID, _MDItemRemoveAttribute, _MDItemRemoveAttributes,
_MDItemRemoveAttributesForAbsolutePaths, _MDItemRemoveLabel,
_MDItemSetAttribute, _MDItemSetAttributes, _MDItemSetAttributesForAbsolutePaths,
_MDItemSetLabel, _MDItemSetLocalizedAttribute, _MDItemsCopyAttributes,
_MDItemsCreateWithURLs, _MDItemsSetAttributes, _MDItemsSetAttributesNoExAttr,
_MDLabelAddToItems, _MDLabelCopyAttribute, _MDLabelCopyAttributeName,
_MDLabelCreate, _MDLabelDelete, _MDLabelGetTypeID, _MDLabelRemoveFromItems,
_MDLabelSetAttributes, _MDQueryCopyQueryString, _MDQueryCopySortingAttributes,
_MDQueryCopyValueListAttributes, _MDQueryCopyValuesOfAttribute,
_MDQueryCreate, _MDQueryCreateForItems, _MDQueryCreateSubset,
_MDQueryDisableUpdates, _MDQueryEnableUpdates, _MDQueryExecute,
_MDQueryGetAttributeValueOfResultAtIndex, _MDQueryGetBatchingParameters,
_MDQueryGetCountOfResultsWithAttributeValue, _MDQueryGetIndexOfResult,
_MDQueryGetResultAtIndex, _MDQueryGetResultCount, _MDQueryGetTypeID,
_MDQueryIsGatheringComplete, _MDQueryIsStopped, _MDQuerySetBatchingParameters,
_MDQuerySetCreateResultFunction, _MDQuerySetCreateValueFunction,
_MDQuerySetDispatchQueue, _MDQuerySetMatchesSupportFiles,
_MDQuerySetMaxCount, _MDQuerySetSearchScope, _MDQuerySetSortComparator,
_MDQuerySetSortComparatorBlock, _MDQuerySetSortOptionFlagsForAttribute,
_MDQuerySetSortOrder, _MDQueryStop, _MDSchemaCopyAllAttributes,
_MDSchemaCopyAttributesForContentType, _MDSchemaCopyDisplayDescriptionForAttribute,
_MDSchemaCopyDisplayNameForAttribute, _MDSchemaCopyMetaAttributesForAttribute,
_MDServiceConnectionBindChannelUUID, _MDServiceConnectionDropChannelUUID,
_MDServiceConnectionGetConnection, _MDServiceConnectionGetTypeID,
_MDServiceConnectionReceive, _MDServiceConnectionReceiveBlock,
_MDServiceConnectionSend, _MDServiceConnectionSendEnv, _MDServiceConnectionSendReceive,
_NSMetadataItemAcquisitionMakeKey, _NSMetadataItemAcquisitionModelKey,
_NSMetadataItemAlbumKey, _NSMetadataItemAltitudeKey, _NSMetadataItemApertureKey,
_NSMetadataItemAppleLoopDescriptorsKey, _NSMetadataItemAppleLoopsKeyFilterTypeKey,
_NSMetadataItemAppleLoopsLoopModeKey, _NSMetadataItemAppleLoopsRootKeyKey,
_NSMetadataItemApplicationCategoriesKey, _NSMetadataItemAttributeChangeDateKey,
_NSMetadataItemAudiencesKey, _NSMetadataItemAudioBitRateKey,
_NSMetadataItemAudioChannelCountKey, _NSMetadataItemAudioEncodingApplicationKey,
_NSMetadataItemAudioSampleRateKey, _NSMetadataItemAudioTrackNumberKey,
_NSMetadataItemAuthorAddressesKey, _NSMetadataItemAuthorEmailAddressesKey,
_NSMetadataItemAuthorsKey, _NSMetadataItemBitsPerSampleKey,
_NSMetadataItemCFBundleIdentifierKey, _NSMetadataItemCameraOwnerKey,
_NSMetadataItemCityKey, _NSMetadataItemCodecsKey, _NSMetadataItemColorSpaceKey,
_NSMetadataItemCommentKey, _NSMetadataItemComposerKey, _NSMetadataItemContactKeywordsKey,
_NSMetadataItemContentCreationDateKey, _NSMetadataItemContentModificationDateKey,
_NSMetadataItemContentTypeKey, _NSMetadataItemContentTypeTreeKey,
_NSMetadataItemContributorsKey, _NSMetadataItemCopyrightKey,
_NSMetadataItemCountryKey, _NSMetadataItemCoverageKey, _NSMetadataItemCreatorKey,
_NSMetadataItemDateAddedKey, _NSMetadataItemDeliveryTypeKey,
_NSMetadataItemDescriptionKey, _NSMetadataItemDirectorKey,
_NSMetadataItemDownloadedDateKey, _NSMetadataItemDueDateKey,
_NSMetadataItemDurationSecondsKey, _NSMetadataItemEXIFGPSVersionKey,
_NSMetadataItemEXIFVersionKey, _NSMetadataItemEditorsKey,
_NSMetadataItemEmailAddressesKey, _NSMetadataItemEncodingApplicationsKey,
_NSMetadataItemExecutableArchitecturesKey, _NSMetadataItemExecutablePlatformKey,
_NSMetadataItemExposureModeKey, _NSMetadataItemExposureProgramKey,
_NSMetadataItemExposureTimeSecondsKey, _NSMetadataItemExposureTimeStringKey,
_NSMetadataItemFNumberKey, _NSMetadataItemFinderCommentKey,
_NSMetadataItemFlashOnOffKey, _NSMetadataItemFocalLength35mmKey,
_NSMetadataItemFocalLengthKey, _NSMetadataItemFontsKey, _NSMetadataItemGPSAreaInformationKey,
_NSMetadataItemGPSDOPKey, _NSMetadataItemGPSDateStampKey,
_NSMetadataItemGPSDestBearingKey, _NSMetadataItemGPSDestDistanceKey,
_NSMetadataItemGPSDestLatitudeKey, _NSMetadataItemGPSDestLongitudeKey,
_NSMetadataItemGPSDifferentalKey, _NSMetadataItemGPSMapDatumKey,
_NSMetadataItemGPSMeasureModeKey, _NSMetadataItemGPSProcessingMethodKey,
_NSMetadataItemGPSStatusKey, _NSMetadataItemGPSTrackKey, _NSMetadataItemGenreKey,
_NSMetadataItemHasAlphaChannelKey, _NSMetadataItemHeadlineKey,
_NSMetadataItemISOSpeedKey, _NSMetadataItemIdentifierKey,
_NSMetadataItemImageDirectionKey, _NSMetadataItemInformationKey,
_NSMetadataItemInstantMessageAddressesKey, _NSMetadataItemInstructionsKey,
_NSMetadataItemIsApplicationManagedKey, _NSMetadataItemIsGeneralMIDISequenceKey,
_NSMetadataItemIsLikelyJunkKey, _NSMetadataItemKeySignatureKey,
_NSMetadataItemKeywordsKey, _NSMetadataItemKindKey, _NSMetadataItemLanguagesKey,
_NSMetadataItemLastUsedDateKey, _NSMetadataItemLatitudeKey,
_NSMetadataItemLayerNamesKey, _NSMetadataItemLensModelKey,
_NSMetadataItemLongitudeKey, _NSMetadataItemLyricistKey, _NSMetadataItemMaxApertureKey,
_NSMetadataItemMediaTypesKey, _NSMetadataItemMeteringModeKey,
_NSMetadataItemMusicalGenreKey, _NSMetadataItemMusicalInstrumentCategoryKey,
_NSMetadataItemMusicalInstrumentNameKey, _NSMetadataItemNamedLocationKey,
_NSMetadataItemNumberOfPagesKey, _NSMetadataItemOrganizationsKey,
_NSMetadataItemOrientationKey, _NSMetadataItemOriginalFormatKey,
_NSMetadataItemOriginalSourceKey, _NSMetadataItemPageHeightKey,
_NSMetadataItemPageWidthKey, _NSMetadataItemParticipantsKey,
_NSMetadataItemPerformersKey, _NSMetadataItemPhoneNumbersKey,
_NSMetadataItemPixelCountKey, _NSMetadataItemPixelHeightKey,
_NSMetadataItemPixelWidthKey, _NSMetadataItemProducerKey,
_NSMetadataItemProfileNameKey, _NSMetadataItemProjectsKey,
_NSMetadataItemPublishersKey, _NSMetadataItemRecipientAddressesKey,
_NSMetadataItemRecipientEmailAddressesKey, _NSMetadataItemRecipientsKey,
_NSMetadataItemRecordingDateKey, _NSMetadataItemRecordingYearKey,
_NSMetadataItemRedEyeOnOffKey, _NSMetadataItemResolutionHeightDPIKey,
_NSMetadataItemResolutionWidthDPIKey, _NSMetadataItemRightsKey,
_NSMetadataItemSecurityMethodKey, _NSMetadataItemSpeedKey,
_NSMetadataItemStarRatingKey, _NSMetadataItemStateOrProvinceKey,
_NSMetadataItemStreamableKey, _NSMetadataItemSubjectKey, _NSMetadataItemTempoKey,
_NSMetadataItemTextContentKey, _NSMetadataItemThemeKey, _NSMetadataItemTimeSignatureKey,
_NSMetadataItemTimestampKey, _NSMetadataItemTitleKey, _NSMetadataItemTotalBitRateKey,
_NSMetadataItemVersionKey, _NSMetadataItemVideoBitRateKey,
_NSMetadataItemWhereFromsKey, _NSMetadataItemWhiteBalanceKey,
_NSMetadataQueryIndexedLocalComputerScope, _NSMetadataQueryIndexedNetworkScope,
_NSMetadataQueryUpdateAddedItemsKey, _NSMetadataQueryUpdateChangedItemsKey,
_NSMetadataQueryUpdateRemovedItemsKey, _SIUINT32SetAddValue,
_SIUINT32SetContainsValue, _SIUINT32SetCreate, _SIUINT32SetGetTypeID,
_SIUINT64SetAddValue, _SIUINT64SetContainsValue, _SIUINT64SetCreate,
_SIUINT64SetGetTypeID, _SIUINT64SetIterate, _SIUINT64SetRemoveValue,
__MDAppRankEvaluatorDeallocate, __MDAppRankOfItem, __MDBackupCatchup,
__MDBackupDeletes, __MDBackupFileEndOfLife, __MDConfigClearStoreUUID,
__MDConfigCopyImporterInformation, __MDConfigCopyImporterUIDs,
__MDConfigCopyIndexingStorePaths, __MDConfigCopyStoreAttributes,
__MDConfigCopyStoreInformation, __MDConfigCopyStorePaths,
__MDConfigCreateStore, __MDConfigCreateVolumeIndex, __MDConfigForceStoreSync,
__MDConfigRegisterMountPoint, __MDConfigRemoveStore, __MDConfigSetStoreAttributes,
__MDConfigUnregisterMountPoint, __MDConnectToServer, __MDCopyAltGroupNameToGroupNameDictionary,
__MDCopyAppleLanguages, __MDCopyAttributeSchema, __MDCopyBundlePaths,
__MDCopyExclusionList, __MDCopyExtendedAttributes, __MDCopyGroupIndexToNameDictionary,
__MDCopyGroupNameToGroupNumberDictionary, __MDCopyGroupNameToQueryDictionary,
__MDCopyImportInfo, __MDCopyImporterPluginPathForFile, __MDCopyIndexSize,
__MDCopyIndexingStatus, __MDCopyIndexingStatusForVolume, __MDCopyLabelUserUUID,
__MDCopyLocalizedGroupNameDictionary, __MDCopyMDSimpleGroupingsPlist,
__MDCopyShortcutsDictionary, __MDCopyTextShortcutsSet, __MDCopyUTIToGroupNumberDictionary,
__MDCopyVolumeFilter, __MDCopyVolumeFilterEngine, __MDCreateAppRankEvaluator,
__MDCreateDictionaryByMappingXMPDictionary, __MDCreateSimpleQueryEvaluator,
__MDCreateSimpleQueryEvaluatorWithBlock, __MDCreateSimpleQueryEvaluatorWithOptions,
__MDCreateSimpleQueryEvaluatorWithOptionsAndLanguages, __MDCustomizeGroupNameWithUTITypeAndTree,
__MDDynamicAppRankOfItem, __MDFilterIsItemExcludedFromIndexing,
__MDFilterIsItemOut, __MDGetAllowedTaskCount, __MDGetCurrentTaskCount,
__MDGetLabelServicesConnection, __MDGetLastUsedDate, __MDGetPrivateXattrServicesConnection,
__MDGetPublicXattrServicesConnection, __MDHealthCheckDirectory,
__MDIgnoreFileOperations, __MDImportDirectory, __MDImportFile,
__MDImportFilesWithUTIs, __MDImportPrivateXattrsFromItems,
__MDIndexingProgress, __MDIsAppDirPath, __MDIsCompatibleArchitecture,
__MDIsCustomizableGroupName, __MDIsRootVolumePath, __MDIssueStoreCommand,
__MDItemCopyCFURL, __MDItemCopyExAttrWithURL, __MDItemCreate,
__MDItemCreateFSRef, __MDItemCreateFileSystemObject, __MDItemGetContentType,
__MDItemGetDevice, __MDItemGetFileId, __MDItemGetTextEncodingHint,
__MDItemGetTextSnippets, __MDItemGetVRefNum, __MDItemMarkAsCreated,
__MDItemMarkAsDownloaded, __MDItemMarkAsModified, __MDItemMarkAsPrinted,
__MDItemMarkAsReceived, __MDItemMarkAsSent, __MDItemMarkAsUsed,
__MDItemMarkAsUsedWithAbsoluteTime, __MDItemMarkAsUsedWithPathAndCatInfo,
__MDItemMarkAsUsedWithPathAndStatBuf, __MDItemMarkAsUsedWithURL,
__MDItemMarkAsUsedWithURLAndAbsoluteTime, __MDItemRemoveAttributesWithURL,
__MDItemSetAttributesForAbsolutePathsNoExAttr, __MDItemSetAttributesForAbsolutePathsNoExAttrNoImport,
__MDItemSetAttributesWithURL, __MDItemSetCommonAttributesForOids,
__MDItemSetContentType, __MDItemSetFinderColor, __MDItemSetInSniffer,
__MDItemSetPrivateAttributes, __MDItemSetTextEncodingHint,
__MDItemsCreateWithFileIdsAndAbsolutePathsOnDevice, __MDItemsWritePrivateXattrUpdatesWithKeysAndValues,
__MDLabelCopyAttributeNameForUUID, __MDLabelCopyPrivateAttrs,
__MDLabelCopyPrivateAttrsForUid, __MDLabelMatchExpressionApply,
__MDLabelUUIDEncode, __MDMatchKeyCreate, __MDMatchKeyDeallocate,
__MDMatchKeyEvaluate, __MDOpenUserFile, __MDOptionAddBooleanGetter,
__MDOptionAddIntegerGetter, __MDOptionAddObjectGetter, __MDOptionCopyDump,
__MDOptionGetValues, __MDOptionNamedPthreadKey, __MDPerfCopyStoreLifeCycleInfo,
__MDPerfCreateFileEventMarker, __MDPerfCreateFileIndexingMarker,
__MDPerfFlushAuditLog, __MDPerfSetAuditLevel, __MDPerfWaitFileIndexingMarkerProcessed,
__MDPerfWaitForStoreState, __MDPreHeatIndex, __MDPrepareForSnapshot,
__MDPrepareForSnapshotTimeout, __MDPrepareForSoftwareUpdate,
__MDPrivateXattrUUIDsGetter, __MDQueryAttributesChanged, __MDQueryClearIgnoreUpdateList,
__MDQueryCopyCompletions, __MDQueryCopyDictionary, __MDQueryCopyMenuRankingQueries,
__MDQueryCopyMenuSortingAttributes, __MDQueryCopyMenuValueListAttributes,
__MDQueryCopyParams, __MDQueryCopyPerfData, __MDQueryCopyRankingTerms,
__MDQueryCopyTextTerms, __MDQueryCopyUserStringForGroupName,
__MDQueryCreateExpr, __MDQueryCreateForItems, __MDQueryCreateFromDictionary,
__MDQueryCreateFromSavedSearch, __MDQueryCreateQueryDictionaryWithOptionsDict,
__MDQueryCreateQueryString, __MDQueryCreateQueryStringToMatchAttribute,
__MDQueryCreateQueryStringToMatchAttributeWithOptions, __MDQueryCreateQueryStringToMatchDisplayName,
__MDQueryCreateQueryStringToMatchDisplayNameWithOptions, __MDQueryCreateQueryStringToMatchDisplayNamesWithOptions,
__MDQueryCreateQueryStringWithOptions, __MDQueryCreateQueryStringWithOptionsDict,
__MDQueryCreateStringByAddingBackslashEscapes, __MDQueryDontEnforceTopN,
__MDQueryEnablePerfGathering, __MDQueryEnumerateNodesInQueryString,
__MDQueryExtractTextTerms, __MDQueryFastWillStop, __MDQueryGetAttributeValueOfResultAtIndexForGroup,
__MDQueryGetAttributeValuesOfResultAtIndex, __MDQueryGetGeneration,
__MDQueryGetGroupCount, __MDQueryGetResultAtIndexForGroup,
__MDQueryGetResultCountForAllGroups, __MDQueryGetResultCountForGroup,
__MDQueryGetSortFlagsForAttribute, __MDQueryIgnoreAllLastUsedUpdatesForItem,
__MDQueryIgnoreNextLastUsedUpdateForItem, __MDQueryProcessUpdates,
__MDQuerySendPerformanceFeedback, __MDQuerySetCompletionOptions,
__MDQuerySetCompletionQuery, __MDQuerySetCompletionQueryWithWeights,
__MDQuerySetCompletionResultCount, __MDQuerySetCreateResultFunctionWithKeyCallBacks,
__MDQuerySetGroupComparator, __MDQuerySetGroupingRules, __MDQuerySetHasUpdateNotification,
__MDQuerySetLabel, __MDQuerySetMDFilter, __MDQuerySetMDFilterQueries,
__MDQuerySetMatchesOnlyFinderFiles, __MDQuerySetMaxCountPerGroup,
__MDQuerySetMenuSortFlagsForQuery, __MDQuerySetNoProgress,
__MDQuerySetRankingTerms, __MDQuerySetSearchScopes, __MDQuerySetSortFlagsForAttribute,
__MDQuerySetSortOrder, __MDQuerySetSortToNone, __MDQuerySortDatesDescending,
__MDQueryStringCopyUserInput, __MDQueryStringCreateForRanking,
__MDQueryStringPreload, __MDQueryTotalCount, __MDQueryUserStringFacetsApplyDoWhileBlock,
__MDQueryWillSendPerformanceFeedback, __MDRankBitForShortcut,
__MDRankIsExactPhraseMatch, __MDRankIsMeaningfulForTopHit,
__MDRankIsOnOldBootVolume, __MDRegisterMailClient, __MDRemoveExtendedAttributes,
__MDRemoveExtendedAttributesForPath, __MDRemoveExtenedAttributes,
__MDRemoveExtenedAttributesForPath, __MDRequestVolumeRecycle,
__MDResumeIndexing, __MDResumeIndexingDirectory, __MDSchemaAddSchemaChangedHandler,
__MDSchemaCopyAll, __MDSchemaCopyAllStringsFiles, __MDSchemaCopyShortDisplayNameForAttribute,
__MDSchemaCopyShortNamesForAttribute, __MDSetExclusion, __MDSetExtendedAttributes,
__MDSetExtendedAttributesForPath, __MDSetLastUsedDate, __MDSetMailMessageAttributes,
__MDSetMailMessageAttributesAtTime, __MDSimpleQueryDeallocate,
__MDSimpleQueryGatherRangesForKeyAndValue, __MDSimpleQueryModifyForMatching,
__MDSimpleQueryObjectMatches, __MDSimpleQuerySetWidcardAttributes,
__MDSoftwareUpdateComplete, __MDStaticAppRankOfItem, __MDStringCompareLocalized,
__MDStringCopyCollationData, __MDStringPrefixOfString, __MDSuspendIndexing,
__MDSuspendIndexingDirectory, __MDTransferExtendedAttributes,
__MDUserListChange, __MDWaitForServerDeath, ___MDItemCopyAttributesEllipsis1,
___MDItemRemoveAttributesEllipsis1, ___MDItemSetAttributesEllipsis1,
__kMDImportIsForBackup, __kMDImporterTextLimitInK, __kMDItemAdamID,
__kMDItemContentChangeDate, __kMDItemCreationDate, __kMDItemCreatorCode,
__kMDItemExportImporterAvaliable, __kMDItemFSContentType,
__kMDItemFSContentTypeTree, __kMDItemFSDisplayName, __kMDItemFileName,
__kMDItemFinderFlags, __kMDItemFinderLabel, __kMDItemHasCustomIcon,
__kMDItemHasExtensionHidden, __kMDItemImporterResult, __kMDItemIncomingCalendarCounts,
__kMDItemIncomingCounts, __kMDItemIncomingFileProviderCounts,
__kMDItemIncomingMailCounts, __kMDItemIncomingSMSCounts, __kMDItemInvisibleFileType,
__kMDItemIsEvictedFile, __kMDItemIsExtensionHidden, __kMDItemIsShared,
__kMDItemIsStationery, __kMDItemLocked, __kMDItemMailAccountsAttributesMissing,
__kMDItemNodeCount, __kMDItemOutgoingCalendarCounts, __kMDItemOutgoingCounts,
__kMDItemOutgoingFileProviderCounts, __kMDItemOutgoingMailCounts,
__kMDItemOutgoingSMSCounts, __kMDItemOwnerGroupID, __kMDItemOwnerName,
__kMDItemOwnerUserID, __kMDItemPrescanCandidate, __kMDItemServerVersion,
__kMDItemSharedItemCurrentUserRole, __kMDItemSortIdentityAttr,
__kMDItemStaticInterestScore, __kMDItemSupportFileType, __kMDItemTextContentIndexExists,
__kMDItemTypeCode, __kMDItemUserTags, __kMDParametersForImporter,
__kMDQueryItemInScopeForRankingOnly, __kMDQueryScope, __kMDUserQueryAttributedInputDateKey,
__kMDUserQueryAttributedInputRecipientKey, __kMDUserQueryAttributedInputSenderKey,
__kMDUserQueryAttributedInputTitleKey, __kMDUserQueryAttributedInputTopicKey,
__kMDUserQueryDictionaryQueryAttributedInputKey, __kMDUserQueryDictionaryQueryConfidenceHighValue,
__kMDUserQueryDictionaryQueryConfidenceKey, __kMDUserQueryDictionaryQueryConfidenceLowValue,
__kMDUserQueryDictionaryQueryConfidenceMediumValue, __kMDUserQueryDictionaryQueryConfidenceNoneValue,
__kMDUserQueryDictionaryQueryDefaultStringKey, __kMDUserQueryDictionaryQueryDisplayCriteriaKey,
__kMDUserQueryDictionaryQueryDisplayCriteriaSortFieldDateValue,
__kMDUserQueryDictionaryQueryDisplayCriteriaSortFieldKey,
__kMDUserQueryDictionaryQueryDisplayCriteriaSortOrderKey,
__kMDUserQueryDictionaryQueryDisplayCriteriaSortOrderMaxValue,
__kMDUserQueryDictionaryQueryDisplayCriteriaSortOrderMinValue,
__kMDUserQueryDictionaryQueryKindKey, __kMDUserQueryDictionaryQueryLanguageSupportedKey,
__kMDUserQueryDictionaryQueryRankingCategoriesKey, __kMDUserQueryDictionaryQueryRankingTermsKey,
__kMDUserQueryDictionaryQueryStringKey, __kMDUserQueryDictionaryQueryTokenCountKey,
_kMDAttributeAllValues, _kMDAttributeArray, _kMDAttributeDisplayValues,
_kMDAttributeMultiValued, _kMDAttributeName, _kMDAttributePreviewValues,
_kMDAttributeReadOnlyValues, _kMDAttributeRelatedValues, _kMDAttributeType,
_kMDConfigChangedNotification, _kMDConfigCreateDefaultIndex,
_kMDConfigCurrentSearchLevel, _kMDConfigErase, _kMDConfigFilterRules,
_kMDConfigIsDistantStore, _kMDConfigSearchLevel, _kMDConfigSearchLevelFSSearchOnly,
_kMDConfigSearchLevelForbidden, _kMDConfigSearchLevelOff,
_kMDConfigSearchLevelReadOnly, _kMDConfigSearchLevelReadWrite,
_kMDConfigSearchLevelTransitioning, _kMDExclusionsNotification,
_kMDExporterAvaliable, _kMDIndexingNotification, _kMDIndexingNotificationActualScanCount,
_kMDIndexingNotificationArray, _kMDIndexingNotificationArrayItemPath,
_kMDIndexingNotificationCompletedRepair, _kMDIndexingNotificationCurrentlyIndexing,
_kMDIndexingNotificationCurrentlyScanning, _kMDIndexingNotificationFilesInflightFModWatch,
_kMDIndexingNotificationFilesInflightFModWatchSystem, _kMDIndexingNotificationFilesInflightFModWatchUser,
_kMDIndexingNotificationFilesInflightRepair, _kMDIndexingNotificationFilesInflightScan,
_kMDIndexingNotificationHasExclusions, _kMDIndexingNotificationIsBackup,
_kMDIndexingNotificationIsInternalVolume, _kMDIndexingNotificationPlayedBackRepair,
_kMDIndexingNotificationPlayedBackScanCount, _kMDIndexingNotificationPoppedTotalFModWatch,
_kMDIndexingNotificationPoppedTotalFModWatchSystem, _kMDIndexingNotificationPoppedTotalFModWatchUser,
_kMDIndexingNotificationPoppedTotalRepair, _kMDIndexingNotificationPoppedTotalScan,
_kMDIndexingNotificationPushedTotalRepair, _kMDIndexingNotificationRequestedRepair,
_kMDIndexingNotificationRetiredTotalFModWatch, _kMDIndexingNotificationRetiredTotalFModWatchSystem,
_kMDIndexingNotificationRetiredTotalFModWatchUser, _kMDIndexingNotificationRetiredTotalRepair,
_kMDIndexingNotificationRetiredTotalScan, _kMDIndexingNotificationScanBaseTime,
_kMDIndexingNotificationSession, _kMDIndexingNotificationTargetPolicySearch,
_kMDIndexingNotificationVolumeRoot, _kMDItemAcquisitionMake,
_kMDItemAcquisitionModel, _kMDItemAlbum, _kMDItemAlternateNames,
_kMDItemAltitude, _kMDItemAperture, _kMDItemAppleLoopDescriptors,
_kMDItemAppleLoopsKeyFilterType, _kMDItemAppleLoopsLoopMode,
_kMDItemAppleLoopsRootKey, _kMDItemApplicationCategories,
_kMDItemAttributeChangeDate, _kMDItemAudiences, _kMDItemAudioBitRate,
_kMDItemAudioChannelCount, _kMDItemAudioEncodingApplication,
_kMDItemAudioSampleRate, _kMDItemAudioTrackNumber, _kMDItemAuthorAddresses,
_kMDItemAuthorEmailAddresses, _kMDItemAuthors, _kMDItemBitsPerSample,
_kMDItemCFBundleIdentifier, _kMDItemCalendarDelegateIdentifier,
_kMDItemCalendarHolidayIdentifier, _kMDItemCameraOwner, _kMDItemCity,
_kMDItemCodecs, _kMDItemColorSpace, _kMDItemComment, _kMDItemComposer,
_kMDItemContactKeywords, _kMDItemContentCreationDate, _kMDItemContentModificationDate,
_kMDItemContentType, _kMDItemContentTypeTree, _kMDItemContributors,
_kMDItemCopyright, _kMDItemCountry, _kMDItemCoverage, _kMDItemCreator,
_kMDItemDateAdded, _kMDItemDeliveryType, _kMDItemDescription,
_kMDItemDestinationRecipients, _kMDItemDidChangeNotification,
_kMDItemDirector, _kMDItemDisplayName, _kMDItemDisplayNameInitials,
_kMDItemDocumentContainer, _kMDItemDocumentIdentifier, _kMDItemDownloadedDate,
_kMDItemDueDate, _kMDItemDurationSeconds, _kMDItemEXIFGPSVersion,
_kMDItemEXIFVersion, _kMDItemEditors, _kMDItemEmailAddresses,
_kMDItemEncodingApplications, _kMDItemExecutableArchitectures,
_kMDItemExecutablePlatform, _kMDItemExposureMode, _kMDItemExposureProgram,
_kMDItemExposureTimeSeconds, _kMDItemExposureTimeString, _kMDItemFNumber,
_kMDItemFSContentChangeDate, _kMDItemFSCreationDate, _kMDItemFSCreatorCode,
_kMDItemFSExists, _kMDItemFSFinderFlags, _kMDItemFSHasCustomIcon,
_kMDItemFSInvisible, _kMDItemFSIsExtensionHidden, _kMDItemFSIsReadable,
_kMDItemFSIsStationery, _kMDItemFSIsWriteable, _kMDItemFSLabel,
_kMDItemFSName, _kMDItemFSNodeCount, _kMDItemFSOwnerGroupID,
_kMDItemFSOwnerUserID, _kMDItemFSSize, _kMDItemFSTypeCode,
_kMDItemFinderComment, _kMDItemFinderOpenDate, _kMDItemFlashOnOff,
_kMDItemFocalLength, _kMDItemFocalLength35mm, _kMDItemFonts,
_kMDItemGPSAreaInformation, _kMDItemGPSDOP, _kMDItemGPSDateStamp,
_kMDItemGPSDestBearing, _kMDItemGPSDestDistance, _kMDItemGPSDestLatitude,
_kMDItemGPSDestLongitude, _kMDItemGPSDifferental, _kMDItemGPSMapDatum,
_kMDItemGPSMeasureMode, _kMDItemGPSProcessingMethod, _kMDItemGPSStatus,
_kMDItemGPSTrack, _kMDItemGenre, _kMDItemHTMLContent, _kMDItemHasAlphaChannel,
_kMDItemHeadline, _kMDItemISOSpeed, _kMDItemIdentifier, _kMDItemImageDirection,
_kMDItemInformation, _kMDItemInstantMessageAddresses, _kMDItemInstructions,
_kMDItemIsApplicationManaged, _kMDItemIsGeneralMIDISequence,
_kMDItemIsLikelyJunk, _kMDItemIsQuarantined, _kMDItemKeySignature,
_kMDItemKeywords, _kMDItemKind, _kMDItemLabelID, _kMDItemLabelIcon,
_kMDItemLabelKind, _kMDItemLabelUUID, _kMDItemLanguages, _kMDItemLastUsedDate,
_kMDItemLatitude, _kMDItemLayerNames, _kMDItemLensModel, _kMDItemLogicalSize,
_kMDItemLongitude, _kMDItemLyricist, _kMDItemMaxAperture,
_kMDItemMediaTypes, _kMDItemMeteringMode, _kMDItemMusicalGenre,
_kMDItemMusicalInstrumentCategory, _kMDItemMusicalInstrumentName,
_kMDItemNamedLocation, _kMDItemNumberOfPages, _kMDItemOrganizations,
_kMDItemOrientation, _kMDItemOriginApplicationIdentifier,
_kMDItemOriginMessageID, _kMDItemOriginSenderDisplayName,
_kMDItemOriginSenderHandle, _kMDItemOriginSubject, _kMDItemOriginalFormat,
_kMDItemOriginalSource, _kMDItemPageHeight, _kMDItemPageWidth,
_kMDItemParticipants, _kMDItemPath, _kMDItemPerformers, _kMDItemPhoneNumbers,
_kMDItemPhysicalSize, _kMDItemPixelCount, _kMDItemPixelHeight,
_kMDItemPixelWidth, _kMDItemProducer, _kMDItemProfileName,
_kMDItemProjects, _kMDItemPublishers, _kMDItemPurchaseDate,
_kMDItemRecipientAddresses, _kMDItemRecipientEmailAddresses,
_kMDItemRecipients, _kMDItemRecordingDate, _kMDItemRecordingYear,
_kMDItemRedEyeOnOff, _kMDItemResolutionHeightDPI, _kMDItemResolutionWidthDPI,
_kMDItemRights, _kMDItemSecurityMethod, _kMDItemSpeed, _kMDItemStarRating,
_kMDItemStateOrProvince, _kMDItemStreamable, _kMDItemSubject,
_kMDItemSupportFileType, _kMDItemTempo, _kMDItemTextContent,
_kMDItemTheme, _kMDItemTimeSignature, _kMDItemTimestamp, _kMDItemTitle,
_kMDItemTotalBitRate, _kMDItemURL, _kMDItemUsedDates, _kMDItemUserCreatedDate,
_kMDItemUserCreatedUserHandle, _kMDItemUserDownloadedDate,
_kMDItemUserDownloadedUserHandle, _kMDItemUserModifiedDate,
_kMDItemUserModifiedUserHandle, _kMDItemUserPrintedDate, _kMDItemUserPrintedUserHandle,
_kMDItemUserSharedReceivedDate, _kMDItemUserSharedReceivedRecipient,
_kMDItemUserSharedReceivedRecipientHandle, _kMDItemUserSharedReceivedSender,
_kMDItemUserSharedReceivedSenderHandle, _kMDItemUserSharedReceivedTransport,
_kMDItemUserSharedSentDate, _kMDItemUserSharedSentRecipient,
_kMDItemUserSharedSentRecipientHandle, _kMDItemUserSharedSentSender,
_kMDItemUserSharedSentSenderHandle, _kMDItemUserSharedSentTransport,
_kMDItemUserTags, _kMDItemVersion, _kMDItemVideoBitRate, _kMDItemWhereFroms,
_kMDItemWhiteBalance, _kMDLabelAddedNotification, _kMDLabelAttributeBits,
_kMDLabelBundleURL, _kMDLabelChangedNotification, _kMDLabelContentChangeDate,
_kMDLabelDisplayName, _kMDLabelExtendedFinderColor, _kMDLabelHasPreviewIcon,
_kMDLabelID, _kMDLabelIconData, _kMDLabelIconURL, _kMDLabelIconUUID,
_kMDLabelIsMutuallyExclusiveSetMember, _kMDLabelKind, _kMDLabelKindIsMutuallyExclusiveSetKey,
_kMDLabelKindVisibilityKey, _kMDLabelRemovedNotification,
_kMDLabelSetsFinderColor, _kMDLabelUUID, _kMDLabelVisibility,
_kMDPrivateVisibility, _kMDPublicVisibility, _kMDQueryAllowTranslation,
_kMDQueryBatchFirstCount, _kMDQueryBatchFirstDelay, _kMDQueryBatchProgressCount,
_kMDQueryBatchProgressDelay, _kMDQueryBatchUpdateCount, _kMDQueryBatchUpdateDelay,
_kMDQueryCompletionFields, _kMDQueryCompletionOptions, _kMDQueryCompletionResultCount,
_kMDQueryCompletionString, _kMDQueryCompletionWeights, _kMDQueryDidFinishNotification,
_kMDQueryDidUpdateNotification, _kMDQueryFilters, _kMDQueryFlatScopes,
_kMDQueryGroupMaxCount, _kMDQueryGroupingRules, _kMDQueryHasUpdateNotification,
_kMDQueryIndexedOnly, _kMDQueryIsLive, _kMDQueryIsLowPriority,
_kMDQueryItemArray, _kMDQueryLiftingRules, _kMDQueryMDFilter,
_kMDQueryMatchOnlyFinderFiles, _kMDQueryMatchSupportFiles,
_kMDQueryMaxCount, _kMDQueryNoProgress, _kMDQueryNoRewrite,
_kMDQueryOptionContextIdentifier, _kMDQueryOptionFinderLabelsDict,
_kMDQueryOptionFinderLabelsDictLocale, _kMDQueryProgressNotification,
_kMDQueryQoSClass, _kMDQueryResultContentRelevance, _kMDQueryResultGroupId,
_kMDQueryResultMLRelevance, _kMDQueryResultMatchedDisplayNameField,
_kMDQueryResultMatchedExtraQueriesField, _kMDQueryResultMatchedFields,
_kMDQueryResultMenuRelevance, _kMDQueryResultNewMatchedExtraQueriesField,
_kMDQueryResultTopMatchedField, _kMDQueryScopeAllIndexed,
_kMDQueryScopeComputer, _kMDQueryScopeComputerIndexed, _kMDQueryScopeHome,
_kMDQueryScopeMyFiles, _kMDQueryScopeMyLocalFiles, _kMDQueryScopeNetwork,
_kMDQueryScopeNetworkIndexed, _kMDQueryString, _kMDQueryStringMatchAllMetadata,
_kMDQueryStringMatchAllMetadataOrContent, _kMDQueryUniqueId,
_kMDQueryUpdateAddedItems, _kMDQueryUpdateChangedItems, _kMDQueryUpdateRemovedItems,
_kMDQueryWantsPerfData, _kMDSAttributeSchema, _kMDSAttributeSchemaPlistBytes,
_kMDSBundlePathArray, _kMDSCompleteSchema, _kMDSDiskStoreIsLowLatency,
_kMDSDiskStorePolicy, _kMDSDiskStoreSpindleNumber, _kMDSGroupIDVectorData,
_kMDSHomeDirectoryPath, _kMDSLanguageArray, _kMDSPreferencesName,
_kMDSStoreDevice, _kMDSStoreHasPersistentUUID, _kMDSStoreMetaScopes,
_kMDSStorePathScopes, _kMDSStorePrivateForUser, _kMDSStoreSnapshots,
_kMDSStoreSupportsVolFS, _kMDSStoreURLScopes, _kMDSStoreUUID,
_kMDSStoreVolFSPrefix, _kMDSTimeoutDontWait, _kMDSTimeoutLong,
_kMDSTimeoutShort, _kMDSTimeoutWaitForever, _kMDSVolumeUUID,
_kMDScopeArray, _kMDServerPortName, _kMDServiceConnectionAdvisoryNotification,
_kMDServiceConnectionDownNotification, _kMDServiceConnectionUpNotification,
_kMDSystemFile, _mach_msg_dispatch, _mach_msg_dispatch_chain_init,
_mach_msg_dispatch_gcd, _mach_msg_dispatchx, _mach_port_set_queue_limit,
_mdsChannelRequest, _mdsClientCheckin, _mdsFetchAccessTokenIDForUID,
_mdsManageCheckin, _mdsMarkItemsAsUsed, _mdsPeerCheckin, _mdsRequestVolume,
_mdsServerBootstrap ]
objc-classes: [ MDSPathFilter, MDSPathFilterGenerator, _MDLabel, _MDServiceConnection ]
reexports:
- targets: [ x86_64-maccatalyst, x86_64-macos, arm64e-maccatalyst, arm64e-macos,
arm64-macos, arm64-maccatalyst ]
symbols: [ _MDChildPlistBytesContextCreate, _MDChildPlistBytesContextDestroy,
_MDPlistArrayGetCount, _MDPlistArrayGetPlistObjectAtIndex,
_MDPlistArrayIterate, _MDPlistBooleanGetValue, _MDPlistBytesAddBoolean,
_MDPlistBytesAddCString, _MDPlistBytesAddData, _MDPlistBytesAddDate,
_MDPlistBytesAddInteger, _MDPlistBytesAddInternedCString,
_MDPlistBytesAddNull, _MDPlistBytesAddPlistBytes, _MDPlistBytesAddRawInternedCStringKey,
_MDPlistBytesAddRawInternedCStringKeyWithString, _MDPlistBytesAddReal,
_MDPlistBytesAddString, _MDPlistBytesAddUUID, _MDPlistBytesAppendMultiplePlistBytes,
_MDPlistBytesAppendPlist, _MDPlistBytesAppendPlistBytes, _MDPlistBytesBeginArray,
_MDPlistBytesBeginDictionary, _MDPlistBytesBeginPlist, _MDPlistBytesCopyChildPlistBytesAtIndex,
_MDPlistBytesCopyDispatchData, _MDPlistBytesCopyPlistAtIndex,
_MDPlistBytesCopyPlistAtIndexWithAllocator, _MDPlistBytesCopyPlistAtIndexWithCallbacks,
_MDPlistBytesCopyPlistAtIndexWithCallbacksAndAllocator, _MDPlistBytesCopyPlistBytesAtIndex,
_MDPlistBytesCreate, _MDPlistBytesCreateMutable, _MDPlistBytesCreateMutableCopy,
_MDPlistBytesCreateMutableUsingMalloc, _MDPlistBytesCreateUniquedString,
_MDPlistBytesCreateWithDeallocator, _MDPlistBytesEndArray,
_MDPlistBytesEndDictionary, _MDPlistBytesEndPlist, _MDPlistBytesGetByteVector,
_MDPlistBytesGetByteVectorCount, _MDPlistBytesGetMappedByteVector,
_MDPlistBytesGetTypeID, _MDPlistBytesSetShouldDeallocate,
_MDPlistBytesSetShouldUseMalloc, _MDPlistContainerAddBooleanValue,
_MDPlistContainerAddCString, _MDPlistContainerAddDataValue,
_MDPlistContainerAddDateValue, _MDPlistContainerAddDoubleValue,
_MDPlistContainerAddFloatValue, _MDPlistContainerAddInt32Value,
_MDPlistContainerAddInt64Value, _MDPlistContainerAddNullValue,
_MDPlistContainerAddObject, _MDPlistContainerAddPlistObject,
_MDPlistContainerAddUUIDValue, _MDPlistContainerBeginArray,
_MDPlistContainerBeginContainer, _MDPlistContainerBeginDictionary,
_MDPlistContainerCopyDispatchData, _MDPlistContainerCopyObject,
_MDPlistContainerCopyObjectAtKeyArray, _MDPlistContainerCopyObjectAtKeyPath,
_MDPlistContainerCopyObjectsAtKeyPath, _MDPlistContainerCopyObjectsAtPlistObject,
_MDPlistContainerCopyRootObject, _MDPlistContainerCreateCopy,
_MDPlistContainerCreateMutable, _MDPlistContainerCreateMutableWithStaticBuffer,
_MDPlistContainerCreateWithBytes, _MDPlistContainerCreateWithBytesAndDeallocator,
_MDPlistContainerCreateWithCopiedBytes, _MDPlistContainerCreateWithObject,
_MDPlistContainerEndArray, _MDPlistContainerEndContainer,
_MDPlistContainerEndDictionary, _MDPlistContainerGetBytes,
_MDPlistContainerGetLength, _MDPlistContainerGetPlistObjectAtKeyArray,
_MDPlistContainerGetPlistObjectAtKeyPath, _MDPlistContainerHasObjectAtKeyPath,
_MDPlistContainerWillUseMalloc, _MDPlistDataGetBytePtr, _MDPlistDateGetValue,
_MDPlistDictionaryGetCount, _MDPlistDictionaryGetPlistObjectForKey,
_MDPlistDictionaryIterate, _MDPlistEmbeddedReferenceToPlistObject,
_MDPlistEnumerateQueryResults, _MDPlistGetPlistObjectSize,
_MDPlistGetPlistObjectType, _MDPlistGetRootPlistObject, _MDPlistNumberGetDoubleValue,
_MDPlistNumberGetIntValue, _MDPlistPlistObjectToEmbeddedReference,
_MDPlistReferenceToPlistObject, _MDPlistStringGetValue, _MDPlistUUIDGetValue,
_MDSPathFilterDumpRawFilterInternal, _MDStoreOIDArrayAddOID,
_MDStoreOIDArrayAppendOIDArray, _MDStoreOIDArrayApplyBlock,
_MDStoreOIDArrayApplyBlockParallel, _MDStoreOIDArrayApplyFunction,
_MDStoreOIDArrayApplyParallelFunction, _MDStoreOIDArrayBeginBulkAdd,
_MDStoreOIDArrayBeginSequence, _MDStoreOIDArrayCreate, _MDStoreOIDArrayCreateMutable,
_MDStoreOIDArrayCreateMutableCopy, _MDStoreOIDArrayCreateMutableUsingMalloc,
_MDStoreOIDArrayCreateMutableWithOids, _MDStoreOIDArrayCreateWithDeallocator,
_MDStoreOIDArrayEndBulkAdd, _MDStoreOIDArrayEndSequence, _MDStoreOIDArrayGetMappedVector,
_MDStoreOIDArrayGetTypeID, _MDStoreOIDArrayGetVector, _MDStoreOIDArrayGetVectorCount,
_MDStoreOIDArrayRoom, _MDStoreOIDArraySetShouldDeallocate,
_MDStoreOIDArraySetShouldUseMalloc, _MDUniquiedStringDictCreate,
__MDPlistBytesAddObject, __MDPlistBytesAddUInt64Array, __MDPlistBytesAddURL,
__MDPlistBytesAppendChunk, __MDPlistBytesFirstChunk, __MDPlistBytesNextChunk,
__MDPlistBytesReadFromFile, __MDPlistBytesWriteToFile, __MDPlistGetRootPlistObject,
_kMDPlistBytesDeserializationCallbacks ]
objc-classes: [ _MDMutablePlistBytes, _MDPlistBytes ]
--- !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: 2AC37B30-0810-3E4E-B266-A8C13C2F61A2
- target: x86_64-maccatalyst
value: 2AC37B30-0810-3E4E-B266-A8C13C2F61A2
- target: arm64-macos
value: 00000000-0000-0000-0000-000000000000
- target: arm64-maccatalyst
value: 00000000-0000-0000-0000-000000000000
- target: arm64e-macos
value: BA1BB273-1814-3EFF-B4ED-DDDFDB622786
- target: arm64e-maccatalyst
value: BA1BB273-1814-3EFF-B4ED-DDDFDB622786
install-name: '/System/Library/Frameworks/CoreServices.framework/Versions/A/Frameworks/OSServices.framework/Versions/A/OSServices'
current-version: 1141.1
parent-umbrella:
- targets: [ x86_64-macos, x86_64-maccatalyst, arm64-macos, arm64-maccatalyst,
arm64e-macos, arm64e-maccatalyst ]
umbrella: CoreServices
exports:
- targets: [ x86_64-maccatalyst, x86_64-macos, arm64e-maccatalyst, arm64e-macos,
arm64-macos, arm64-maccatalyst ]
symbols: [ _AlertSoundPlay, _AlertSoundPlayCustomSound, _BatteryCount,
_CSGetDefaultIdentityAuthority, _CSGetLocalIdentityAuthority,
_CSGetManagedIdentityAuthority, _CSIdentityAddAlias, _CSIdentityAddMember,
_CSIdentityAuthenticateUsingPassword, _CSIdentityAuthorityCopyLocalizedName,
_CSIdentityAuthorityGetTypeID, _CSIdentityCommit, _CSIdentityCommitAsynchronously,
_CSIdentityCreate, _CSIdentityCreateCopy, _CSIdentityCreateGroupMembershipQuery,
_CSIdentityCreatePersistentReference, _CSIdentityDelete, _CSIdentityGetAliases,
_CSIdentityGetAuthority, _CSIdentityGetCertificate, _CSIdentityGetClass,
_CSIdentityGetEmailAddress, _CSIdentityGetFullName, _CSIdentityGetImageData,
_CSIdentityGetImageDataType, _CSIdentityGetImageURL, _CSIdentityGetPosixID,
_CSIdentityGetPosixName, _CSIdentityGetTypeID, _CSIdentityGetUUID,
_CSIdentityIsCommitting, _CSIdentityIsEnabled, _CSIdentityIsHidden,
_CSIdentityIsMemberOfGroup, _CSIdentityQueryCopyResults, _CSIdentityQueryCreate,
_CSIdentityQueryCreateForCurrentUser, _CSIdentityQueryCreateForName,
_CSIdentityQueryCreateForPersistentReference, _CSIdentityQueryCreateForPosixID,
_CSIdentityQueryCreateForUUID, _CSIdentityQueryExecute, _CSIdentityQueryExecuteAsynchronously,
_CSIdentityQueryGetTypeID, _CSIdentityQueryStop, _CSIdentityRemoveAlias,
_CSIdentityRemoveClient, _CSIdentityRemoveMember, _CSIdentitySetCertificate,
_CSIdentitySetEmailAddress, _CSIdentitySetFullName, _CSIdentitySetImageData,
_CSIdentitySetImageURL, _CSIdentitySetIsEnabled, _CSIdentitySetPassword,
_CurrentProcessorSpeed, _GetCPUSpeed, _KCAddCallback, _KCCopyItem,
_KCCountKeychains, _KCDeleteItem, _KCFindAppleSharePassword,
_KCFindFirstItem, _KCFindGenericPassword, _KCFindInternetPassword,
_KCFindInternetPasswordWithPath, _KCFindNextItem, _KCGetAttribute,
_KCGetData, _KCGetDefaultKeychain, _KCGetIndKeychain, _KCGetKeychain,
_KCGetKeychainManagerVersion, _KCGetKeychainName, _KCGetStatus,
_KCIsInteractionAllowed, _KCLock, _KCMakeAliasFromKCRef, _KCMakeKCRefFromAlias,
_KCMakeKCRefFromFSRef, _KCNewItem, _KCReleaseItem, _KCReleaseKeychain,
_KCReleaseSearch, _KCRemoveCallback, _KCSetAttribute, _KCSetData,
_KCSetDefaultKeychain, _KCSetInteractionAllowed, _KCUnlockNoUI,
_KCUpdateItem, _MakeAppleSharePasswordKCItemRef, _MakeGenericPasswordKCItemRef,
_MakeInternetPasswordKCItemRef, _MaximumProcessorSpeed, _MinimumProcessorSpeed,
_SecNewAFPXVolMountInfo, _Sleep, _SleepQInstall, _SleepQRemove,
_SystemSoundGetActionID, _SystemSoundGetProperty, _SystemSoundGetPropertyInfo,
_SystemSoundPlay, _SystemSoundRemoveActionID, _SystemSoundRemoveCompletionRoutine,
_SystemSoundSetCompletionRoutine, _SystemSoundSetProperty,
_UpdateSystemActivity, _WSGetCFTypeIDFromWSTypeID, _WSGetWSTypeIDFromCFType,
_WSMethodInvocationAddDeserializationOverride, _WSMethodInvocationAddSerializationOverride,
_WSMethodInvocationCopyParameters, _WSMethodInvocationCopyProperty,
_WSMethodInvocationCopySerialization, _WSMethodInvocationCreate,
_WSMethodInvocationCreateFromSerialization, _WSMethodInvocationGetTypeID,
_WSMethodInvocationInvoke, _WSMethodInvocationScheduleWithRunLoop,
_WSMethodInvocationSetCallBack, _WSMethodInvocationSetParameters,
_WSMethodInvocationSetProperty, _WSMethodInvocationUnscheduleFromRunLoop,
_WSMethodResultIsFault, _WSProtocolHandlerCopyFaultDocument,
_WSProtocolHandlerCopyProperty, _WSProtocolHandlerCopyReplyDictionary,
_WSProtocolHandlerCopyReplyDocument, _WSProtocolHandlerCopyRequestDictionary,
_WSProtocolHandlerCopyRequestDocument, _WSProtocolHandlerCreate,
_WSProtocolHandlerGetTypeID, _WSProtocolHandlerSetDeserializationOverride,
_WSProtocolHandlerSetProperty, _WSProtocolHandlerSetSerializationOverride,
__AppleIDAuthenticatePassword, __AppleIDAuthenticatePasswordWithBlock,
__AppleIDAuthenticationAddAppleID, __AppleIDAuthenticationAddAppleIDWithBlock,
__AppleIDAuthenticationCopyAppleIDs, __AppleIDAuthenticationCopyCertificateInfo,
__AppleIDAuthenticationCopyCertificateInfoWithBlock, __AppleIDAuthenticationCopyMyInfo,
__AppleIDAuthenticationCopyMyInfoWithBlock, __AppleIDAuthenticationCopyStatus,
__AppleIDAuthenticationCopyStatusWithBlock, __AppleIDAuthenticationFindPerson,
__AppleIDAuthenticationFindPersonWithBlock, __AppleIDAuthenticationForgetAppleID,
__AppleIDAuthenticationForgetAppleIDWithBlock, __AppleIDBreadcrumbCheckinWithBlock,
__AppleIDCopyDSIDForCertificate, __AppleIDCopySecIdentityForAppleIDAccount,
__AppleIDGetBreadcrumbEncryptedKeyWithBlock, __AppleIDSetBreadcrumbEncryptedKeyWithBlock,
__AppleIDUpdateLinkedIdentityProvisioning, __AppleIDUpdateLinkedIdentityProvisioningWithBlock,
__CSAddAppleIDAccount, __CSAddAppleIDAccountUsingCompletionBlock,
__CSBackToMyMacCopyDomain, __CSBackToMyMacCopyDomains, __CSBackToMyMacDisableEveryone,
__CSBackToMyMacIsEnabledForSomeUser, __CSBackToMyMacResetForUser,
__CSCopyAccountIdentifierForAppleIDCertificate, __CSCopyAccountIdentifierForAppleIDCertificateChain,
__CSCopyAccountInfoForAppleID, __CSCopyAccountStatusForAppleID,
__CSCopyAppleIDAccountForAppleIDCertificate, __CSCopyAppleIDAccounts,
__CSCopyCommentForServerName, __CSCopyDefaultSharingSecIdentities,
__CSCopyKerberosPrincipalForCertificate, __CSCopyLocalHostnameForComputerName,
__CSCopySecIdentityForAppleID, __CSCopyUserIdentityForPersonInfo,
__CSCreateAppleIDIdentityWithCertificate, __CSCreateAppleIDIdentityWithCertificateChain,
__CSCreateAppleIDIdentityWithNameAndAccountIdentifier, __CSCreatePosixNameFromString,
__CSDeviceSupportsAirDrop, __CSDeviceSupportsODisk, __CSDisassociateWireless,
__CSEnableWirelessP2P, __CSGetAppleIDIdentityAuthority, __CSIdentityAddLinkedIdentityWithNameAndAuthority,
__CSIdentityAllowsPasswordResetWithAuthority, __CSIdentityAllowsPasswordResetWithAuthorityFromDSAttrData,
__CSIdentityAuthenticateUsingCertificate, __CSIdentityAuthenticateUsingCertificateChain,
__CSIdentityAuthenticateUsingPassword, __CSIdentityAuthorityAuthenticateNameAndPassword,
__CSIdentityAuthorityCopyIdentityWithName, __CSIdentityChangePassword,
__CSIdentityCopyCurrentUser, __CSIdentityCopyLinkedIdentityAuthorities,
__CSIdentityCopyLinkedIdentityNameWithAuthorityFromDSAttrData,
__CSIdentityCopyLinkedIdentityNamesWithAuthority, __CSIdentityCopyLinkedIdentityNamesWithAuthorityFromDSAttrData,
__CSIdentityGetHomeDirectoryURL, __CSIdentityGetLinkedIdentityNameWithAuthority,
__CSIdentityGetLoginShellURL, __CSIdentityIsLoginUser, __CSIdentityRemoveLinkedIdentityWithAuthority,
__CSIdentityRemoveLinkedIdentityWithNameAndAuthority, __CSIdentitySetAllowsPasswordResetWithAuthority,
__CSIdentityUpdateLinkedIdentityProvisioning, __CSIsComputerToComputerEnabled,
__CSIsCurrentUserAdmin, __CSIsMobileTimeMachineDisk, __CSIsMobileTimeMachineEnabled,
__CSIsOpticalDisk, __CSIsWirelessAccessPointEnabled, __CSIsWirelessP2PEnabled,
__CSLinkCurrentUserToAppleIDWithVerifiedAccountIdentifier,
__CSRemoveAppleIDAccount, __CSRemoveDotMacIdentitiesFromKeychain,
__CSUnlinkCurrentUserFromAppleID, __ISGetIconIndex, __ISGetIconIndexInfo,
__ISIconIndexHasJPEGFlag, __LWCopyNextFireDateForScheduledAction,
__LWRemoveScheduledAction, __LWScheduleCommandAction, __LWScheduleOpenItemAction,
__LWScheduleOpenURLAction, __LWSchedulerNotifyPortName, __OSS_InstallGestaltSelectors,
__kCSAppleIDAccountAllEmailAddresses, __kCSAppleIDAccountAppleID,
__kCSAppleIDAccountCertificateExpirationDate, __kCSAppleIDAccountCertificateSerialNumber,
__kCSAppleIDAccountFirstName, __kCSAppleIDAccountLastName,
__kCSAppleIDAccountStateCertificateAssumedOK, __kCSAppleIDAccountStateCertificateExpired,
__kCSAppleIDAccountStateCertificateMustBeRenewed, __kCSAppleIDAccountStateCertificateOK,
__kCSAppleIDAccountStateCertificatePending, __kCSAppleIDAccountStateCertificateRevoked,
__kCSAppleIDAccountStateCertificateShouldBeRenewed, __kCSAppleIDAccountStateNoCertificate,
__kCSAppleIDAccountStateNoEncodedDSID, __kCSAppleIDAccountStatePasswordInaccessibleInKeychain,
__kCSAppleIDAccountStatePasswordInvalid, __kCSAppleIDAccountStateUnknown,
__kCSAppleIDAccountStatusAccountStateKey, __kCSAppleIDAccountStatusNextActionTimeKey,
__kCSAppleIDAccountStatusRequiresUserActionKey, __kCSAppleIDAccountStatusValidationDateKey,
__kCSAppleIDAccountVerifiedEmailAddresses, __kCSAppleIDAccountVerifiedPhoneNumbers,
__kCSAppleIDOptionDeferServerCheck, __kCSAppleIDOptionForceServerCheck,
__kCSAppleIDOptionSkipServerCheck, _kAppleIDAccountAddedOrRemovedNotificationKey,
_kAppleIDAccountConfigurationChangeNotificationKey, _kAppleIDAuthenticationStatusTerminateServerKey,
_kAppleIDDoNotSaveSessionInformation, _kAppleIDEncodedDSIDCertificateType,
_kAppleIDValidatedItemsRecordDataCertificateType, _kAppleIDValidationRecordOptionDoNotCheckValidAsOfDateKey,
_kAppleIDValidationRecordOptionDoNotCheckVersionKey, _kAppleIDValidationRecordOptionDoNotEvaluateTrustRefKey,
_kAppleIDValidationRecordOptionOverrideSuggestedDurationValueKey,
_kCSIdentityErrorDomain, _kCSIdentityGeneratePosixName, _kISIconResType,
_kWSAuthInfo, _kWSAuthInfo_authScheme, _kWSAuthInfo_forProxy,
_kWSAuthInfo_password, _kWSAuthInfo_user, _kWSDebugIncomingBody,
_kWSDebugIncomingHeaders, _kWSDebugOutgoingBody, _kWSDebugOutgoingHeaders,
_kWSFaultCode, _kWSFaultExtra, _kWSFaultString, _kWSHTTPExtraHeaders,
_kWSHTTPFollowsRedirects, _kWSHTTPMessage, _kWSHTTPProxy,
_kWSHTTPResponseMessage, _kWSHTTPVersion, _kWSMethodInvocationResult,
_kWSMethodInvocationResultParameterName, _kWSMethodInvocationTimeoutValue,
_kWSNetworkStreamFaultString, _kWSPostingMethod, _kWSRecordNamespaceURI,
_kWSRecordParameterOrder, _kWSRecordType, _kWSSOAP1999Protocol,
_kWSSOAP2001Protocol, _kWSSOAPBodyEncodingStyle, _kWSSOAPMessageHeaders,
_kWSSOAPMethodNamespaceURI, _kWSSOAPStyleDoc, _kWSSOAPStyleRPC,
_kWSStreamErrorDomain, _kWSStreamErrorError, _kWSStreamErrorMessage,
_kWSXMLRPCProtocol, _kcfindapplesharepassword, _kcfindgenericpassword,
_kcfindinternetpassword, _kcfindinternetpasswordwithpath,
_kcgetkeychainname, _wsCFDateToISO8601String, _wsCreateDateFromISO8601 ]
--- !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: 215422CE-8CCC-393F-813A-9DD9DB3B992A
- target: x86_64-maccatalyst
value: 215422CE-8CCC-393F-813A-9DD9DB3B992A
- target: arm64-macos
value: 00000000-0000-0000-0000-000000000000
- target: arm64-maccatalyst
value: 00000000-0000-0000-0000-000000000000
- target: arm64e-macos
value: 3E01AD82-E12C-38E7-9167-EEB9E88BDAEB
- target: arm64e-maccatalyst
value: 3E01AD82-E12C-38E7-9167-EEB9E88BDAEB
install-name: '/System/Library/Frameworks/CoreServices.framework/Versions/A/Frameworks/SearchKit.framework/Versions/A/SearchKit'
current-version: 417.1
parent-umbrella:
- targets: [ x86_64-macos, x86_64-maccatalyst, arm64-macos, arm64-maccatalyst,
arm64e-macos, arm64e-maccatalyst ]
umbrella: CoreServices
exports:
- targets: [ x86_64-maccatalyst, x86_64-macos, arm64e-maccatalyst, arm64e-macos,
arm64-macos, arm64-maccatalyst ]
symbols: [ _AIATFree, _AIATGetAllocator, _AIATMalloc, _AIATRegisterReportErrorUPP,
_AIATSetAllocator, _DisposeIASearchIsHitFilterUPP, _IACFDataDocAccessorCreate,
_IACFDataDocAccessorDispose, _IADocKeyAccessorCreate, _IADocKeyAccessorLength,
_IADocKeyAccessorRead, _IADocKeyAccessorRelease, _IADocKeyAccessorRetain,
_IADocKeyCanCreateAccessor, _IADocKeyCanCreateIterator, _IADocKeyCompare,
_IADocKeyCopyFilePath, _IADocKeyCopyMIMEType, _IADocKeyCopyModDate,
_IADocKeyCopyURL, _IADocKeyCopyURLEncodedName, _IADocKeyCreate,
_IADocKeyCreateFromFSRef, _IADocKeyCreateFromFilePath, _IADocKeyGetFSRef,
_IADocKeyGetName, _IADocKeyGetParent, _IADocKeyGetSchemeName,
_IADocKeyIteratorCopyNextDoc, _IADocKeyIteratorCreate, _IADocKeyIteratorDispose,
_IADocKeyRelease, _IADocKeyRetain, _IAGetHFSDocSchemeName,
_IAIndexAddDoc, _IAIndexAddDocAsync, _IAIndexAddDocWithTextStream,
_IAIndexAddDocWithTextStreamAsync, _IAIndexCompact, _IAIndexCompactAsync,
_IAIndexCopyDocKeyFromID, _IAIndexCopyDocProperties, _IAIndexCopyDocTermIDArrray,
_IAIndexCopyTermData, _IAIndexCopyTermDocIDArrray, _IAIndexDocIteratorCopyNext,
_IAIndexDocIteratorCreate, _IAIndexDocIteratorDispose, _IAIndexFlush,
_IAIndexGetBytesForUpdate, _IAIndexGetDocKeyID, _IAIndexGetDocState,
_IAIndexGetDocTermCount, _IAIndexGetDocTermFrequency, _IAIndexGetMaxDocID,
_IAIndexGetMaxTermID, _IAIndexGetNumDocuments, _IAIndexGetRootDocKeyCount,
_IAIndexGetRootDocKeys, _IAIndexGetStorage, _IAIndexGetTermDocCount,
_IAIndexGetTermID, _IAIndexGetTextAnalysisTypeCount, _IAIndexGetTextAnalysisTypes,
_IAIndexGetType, _IAIndexInitialize, _IAIndexInitializeFromFSRef,
_IAIndexInitializeFromFilePath, _IAIndexMakeRootDocKey, _IAIndexMoveDoc,
_IAIndexOpen, _IAIndexOpenFromFSRef, _IAIndexOpenFromFilePath,
_IAIndexRelease, _IAIndexRemoveDoc, _IAIndexRemoveDocAsync,
_IAIndexRenameDoc, _IAIndexReplaceRootDocKey, _IAIndexRetain,
_IAIndexSetBytesForUpdate, _IAIndexSetDocProperties, _IAIndexUpdate,
_IAIndexUpdateAsync, _IAInputBlockCreate, _IAInputBlockDispose,
_IAInputBlockGetPosition, _IAInputBlockReadBuffer, _IAInputBlockReadByte,
_IAInputBlockReadCFData, _IAInputBlockReadCFString, _IAInputBlockReadCFType,
_IAInputBlockReadUInt32, _IAInputBlockReadUInt64, _IAInputBlockReadVInt32,
_IAInputBlockReadVInt64, _IALoadDefaultExtractorPlugIns, _IALoadExtractorPlugIn,
_IAMutexCreate, _IAMutexDispose, _IAMutexGetGlobalMutex, _IAMutexLock,
_IAMutexUnlock, _IAOutputBlockCreate, _IAOutputBlockDispose,
_IAOutputBlockGetPosition, _IAOutputBlockWriteBuffer, _IAOutputBlockWriteByte,
_IAOutputBlockWriteCFData, _IAOutputBlockWriteCFString, _IAOutputBlockWriteCFType,
_IAOutputBlockWriteUInt32, _IAOutputBlockWriteUInt64, _IAOutputBlockWriteVInt32,
_IAOutputBlockWriteVInt64, _IASearchResultsCopyMatchingTerms,
_IASearchResultsDispose, _IASearchResultsGetCount, _IASearchResultsGetInfoBulk,
_IASearchSetAddIndices, _IASearchSetCreate, _IASearchSetFindSimilarDocuments,
_IASearchSetGetIndexCount, _IASearchSetGetIndices, _IASearchSetQuery,
_IASearchSetQueryAsync, _IASearchSetRankedQueryFromTextStream,
_IASearchSetRelease, _IASearchSetRetain, _IASearchSetTaskGetSearchResults,
_IASentenceParserCopyNextSentence, _IASentenceParserCreate,
_IASentenceParserRegister, _IASentenceParserRelease, _IASentenceParserRetain,
_IASentenceParserSetSourceText, _IAStorageAllocateBlock, _IAStorageAllocateNamedBlock,
_IAStorageCFDataSize, _IAStorageCFStringSize, _IAStorageCFTypeSize,
_IAStorageCommit, _IAStorageCompact, _IAStorageCopyBlockNames,
_IAStorageCopyFilePath, _IAStorageDeallocateBlock, _IAStorageDeallocateNamedBlock,
_IAStorageFreeSpace, _IAStorageGetBlockSize, _IAStorageGetCFData,
_IAStorageGetDiskBlockSize, _IAStorageGetFSRef, _IAStorageGetMaxBlockID,
_IAStorageGetNamedBlock, _IAStorageGetReadAddress, _IAStorageGetStream,
_IAStorageGetStreamCallbacks, _IAStorageGetType, _IAStorageGetWriteAddress,
_IAStorageIsOpen, _IAStorageIsWritable, _IAStorageLockMutex,
_IAStorageMemoryOpen, _IAStorageOpenFromFSRef, _IAStorageOpenFromFilePath,
_IAStorageRelease, _IAStorageRemoveBlockName, _IAStorageRetain,
_IAStorageSetBlockName, _IAStorageSetDiskBlockSize, _IAStorageTotalSpace,
_IAStorageUnlockMutex, _IAStorageVInt32Size, _IAStorageVInt64Size,
_IASummaryCopyParagraphs, _IASummaryCopyRankedSentenceArray,
_IASummaryCopySentenceArray, _IASummaryCopyText, _IASummaryCreate,
_IASummaryCreateWithQuery, _IASummaryDispose, _IASummaryGetHitCount,
_IASummaryGetNthRankedSentence, _IASummaryGetNthSentence,
_IASummaryGetSentenceCount, _IASummmaryCopyText, _IATaskCancel,
_IATaskCopyProperties, _IATaskCreate, _IATaskDispose, _IATaskGetContext,
_IATaskGetCurrent, _IATaskGetProgress, _IATaskIsDone, _IATaskSetProperties,
_IATaskWasCanceled, _IATaskYield, _IATextAnalysisCreate, _IATextAnalysisGetCallbacks,
_IATextAnalysisGetProperties, _IATextAnalysisGetType, _IATextAnalysisRegister,
_IATextAnalysisRelease, _IATextAnalysisRetain, _IATextAnalysisSetProperties,
_IATextAnalysisUnregister, _IATextStreamCreate, _IATextStreamCreateFromCFData,
_IATextStreamCreateFromCFString, _IATextStreamGetCurrentEncoding,
_IATextStreamRead, _IATextStreamRelease, _IATextStreamRetain,
_IATextStreamRewind, _IATokenizerCreate, _IATokenizerGetNextToken,
_IATokenizerRelease, _IATokenizerRetain, _InvokeIASearchIsHitFilterUPP,
_NewIASearchIsHitFilterUPP, _SKCurrentLocaleData, _SKDocumentCopyText,
_SKDocumentCopyURL, _SKDocumentCreate, _SKDocumentCreateWithURL,
_SKDocumentGetName, _SKDocumentGetParent, _SKDocumentGetSchemeName,
_SKDocumentGetTypeID, _SKIndexAddDocument, _SKIndexAddDocumentWithText,
_SKIndexClose, _SKIndexCompact, _SKIndexContainsContentForDocumentID,
_SKIndexCopyDocumentForDocumentID, _SKIndexCopyDocumentIDArrayForTermID,
_SKIndexCopyDocumentNameForDocumentID, _SKIndexCopyDocumentProperties,
_SKIndexCopyDocumentRefsForDocumentIDs, _SKIndexCopyDocumentURLsForDocumentIDs,
_SKIndexCopyInfoForDocumentIDs, _SKIndexCopyTermIDArrayForDocumentID,
_SKIndexCopyTermStringForTermID, _SKIndexCopyUniqueTerms,
_SKIndexCreateTermIterator, _SKIndexCreateWithMutableData,
_SKIndexCreateWithURL, _SKIndexDocumentIteratorCopyNext, _SKIndexDocumentIteratorCreate,
_SKIndexDocumentIteratorGetTypeID, _SKIndexEnumerateTokens,
_SKIndexFlush, _SKIndexFlushCache, _SKIndexFlushInternal,
_SKIndexGetAnalysisProperties, _SKIndexGetDocumentCount, _SKIndexGetDocumentID,
_SKIndexGetDocumentState, _SKIndexGetDocumentTermCount, _SKIndexGetDocumentTermFrequency,
_SKIndexGetIndexType, _SKIndexGetMaximumBytesBeforeFlush,
_SKIndexGetMaximumDocumentID, _SKIndexGetMaximumTermID, _SKIndexGetParentDocumentIDForDocumentID,
_SKIndexGetTermDocumentCount, _SKIndexGetTermIDForTermString,
_SKIndexGetTypeID, _SKIndexGetVersion, _SKIndexMatchQueryForDocumentIDs,
_SKIndexMoveDocument, _SKIndexOpenWithData, _SKIndexOpenWithDataAndLocale,
_SKIndexOpenWithMutableData, _SKIndexOpenWithMutableDataAndLocale,
_SKIndexOpenWithURL, _SKIndexOpenWithURLAndLocale, _SKIndexRemoveDocument,
_SKIndexRenameDocument, _SKIndexSetDocumentProperties, _SKIndexSetMaximumBytesBeforeFlush,
_SKIndexShouldFlushCache, _SKIndexTermIteratorCopyNext, _SKIndexTokenizeString,
_SKLoadDefaultExtractorPlugIns, _SKQueryNodeGetData, _SKSearchCancel,
_SKSearchCreate, _SKSearchFindMatches, _SKSearchGetQueryNode,
_SKSearchGetTypeID, _SKSearchGroupCopyIndexes, _SKSearchGroupCreate,
_SKSearchGroupGetTypeID, _SKSearchResultsCopyMatchingTerms,
_SKSearchResultsCreateWithDocuments, _SKSearchResultsCreateWithQuery,
_SKSearchResultsGetCount, _SKSearchResultsGetInfoInRange,
_SKSearchResultsGetTypeID, _SKSetDefault, _SKSummaryCopyParagraphAtIndex,
_SKSummaryCopyParagraphSummaryString, _SKSummaryCopySentenceAtIndex,
_SKSummaryCopySentenceSummaryString, _SKSummaryCreateWithString,
_SKSummaryGetParagraphCount, _SKSummaryGetParagraphSummaryInfo,
_SKSummaryGetSentenceCount, _SKSummaryGetSentenceSummaryInfo,
_SKSummaryGetTypeID, _gSKGlobalFlags, _kIAIndexDefaultAnalysis,
_kIAStoreStreamCFDataType, _kIAStoreStreamFSRefType, _kIAStoreStreamFileType,
_kSKEndTermChars, _kSKLanguageTypes, _kSKMaximumTerms, _kSKMinTermLength,
_kSKProximityIndexing, _kSKStartTermChars, _kSKStopWords,
_kSKSubstitutions, _kSKTermChars ]
--- !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: CDE97B98-5C70-3120-BA12-1A0408C41F09
- target: x86_64-maccatalyst
value: CDE97B98-5C70-3120-BA12-1A0408C41F09
- target: arm64-macos
value: 00000000-0000-0000-0000-000000000000
- target: arm64-maccatalyst
value: 00000000-0000-0000-0000-000000000000
- target: arm64e-macos
value: A30F9F46-7FF0-3404-9585-F54117864BAB
- target: arm64e-maccatalyst
value: A30F9F46-7FF0-3404-9585-F54117864BAB
install-name: '/System/Library/Frameworks/CoreServices.framework/Versions/A/Frameworks/SharedFileList.framework/Versions/A/SharedFileList'
current-version: 155
parent-umbrella:
- targets: [ x86_64-macos, x86_64-maccatalyst, arm64-macos, arm64-maccatalyst,
arm64e-macos, arm64e-maccatalyst ]
umbrella: CoreServices
allowable-clients:
- targets: [ x86_64-macos, x86_64-maccatalyst, arm64-macos, arm64-maccatalyst,
arm64e-macos, arm64e-maccatalyst ]
clients: [ Foundation ]
exports:
- targets: [ x86_64-macos, arm64e-macos, x86_64-maccatalyst, arm64e-maccatalyst,
arm64-macos, arm64-maccatalyst ]
symbols: [ _SFLListChangeNotification, _SFLListLaunchNotification, _SFLServiceName,
_kSFLDefaultsDomain ]
objc-classes: [ SFLBookmark, SFLDefaults, SFLItem, SFLManager, SFLResolveResult,
_SFLItem, _SFLList ]
- targets: [ x86_64-macos, arm64e-macos, arm64-macos ]
symbols: [ _LSSharedFileListAddObserver, _LSSharedFileListAddObserverOnQueue,
_LSSharedFileListCopyProperty, _LSSharedFileListCopySnapshot,
_LSSharedFileListCreate, _LSSharedFileListGetSeedValue, _LSSharedFileListGetTypeID,
_LSSharedFileListInsertItemAlias, _LSSharedFileListInsertItemBookmark,
_LSSharedFileListInsertItemFSRef, _LSSharedFileListInsertItemURL,
_LSSharedFileListItemCopyAliasData, _LSSharedFileListItemCopyBookmarkData,
_LSSharedFileListItemCopyDisplayName, _LSSharedFileListItemCopyIconRef,
_LSSharedFileListItemCopyProperty, _LSSharedFileListItemCopyResolvedURL,
_LSSharedFileListItemGetID, _LSSharedFileListItemGetTypeID,
_LSSharedFileListItemMove, _LSSharedFileListItemRemove, _LSSharedFileListItemResolve,
_LSSharedFileListItemSetProperty, _LSSharedFileListItemUpdate,
_LSSharedFileListRemoveAllItems, _LSSharedFileListRemoveObserver,
_LSSharedFileListRemoveObserverOnQueue, _LSSharedFileListSetAuthorization,
_LSSharedFileListSetProperty, __LSSharedFileListCopyListType,
__LSSharedFileListIsURLSharePoint, __LSSharedFileListItemCopyBinding,
__LSSharedFileListItemCopyURL, __LSSharedFileListItemOpen,
__LSSharedFileListItemSetBookmarkData, __LSSharedFileListItemSetURL,
__LSSharedFileListUpgrade, __LSSharedFileListVolumeIsVisibleInSidebar,
__SFLCreateSnapshot, __SFLGetRestrictedCustomFileList, __SFLIsFolderShareable,
__SFLRelease, __SFLReleaseSnapshot, __kLSSharedFileListFavoriteItems,
__kLSSharedFileListFavoriteVolumes, __kLSSharedFileListGlobalLoginItems,
__kLSSharedFileListItemBeforeFirst, __kLSSharedFileListItemHidden,
__kLSSharedFileListItemLast, __kLSSharedFileListLoginItemHidden,
__kLSSharedFileListRecentApplicationItems, __kLSSharedFileListRecentDocumentItems,
__kLSSharedFileListRecentItemsMaxAmount, __kLSSharedFileListRecentServerItems,
__kLSSharedFileListSessionLoginItems, __kLSSharedFileListSharePoints,
__kLSSharedFileListVolumesComputerVisible, __kLSSharedFileListVolumesICloudDriveVisible,
__kLSSharedFileListVolumesIDiskVisible, __kLSSharedFileListVolumesNetworkVisible,
__kLSSharedFileListiCloudItems, _kLSSharedFileListAFPCancelShutdown,
_kLSSharedFileListAFPConnectionUserName, _kLSSharedFileListAFPConnections,
_kLSSharedFileListAFPSecondsToShutdown, _kLSSharedFileListAFPServerActivity,
_kLSSharedFileListAFPServerName, _kLSSharedFileListAFPServerState,
_kLSSharedFileListAFPServerStateGoingToShutDown, _kLSSharedFileListAFPServerStateNotRunning,
_kLSSharedFileListAFPServerStateRefusingConnections, _kLSSharedFileListAFPServerStateServerIsEnabled,
_kLSSharedFileListAFPServerStateShuttingDown, _kLSSharedFileListAFPServerStateStartingUp,
_kLSSharedFileListAFPServerStateUnknown, _kLSSharedFileListAFPServerTimedShutdownMessage,
_kLSSharedFileListAFPServerTimedShutdownTime, _kLSSharedFileListAFPServerVersion,
_kLSSharedFileListAFPSharingEnabled, _kLSSharedFileListAFPStatus,
_kLSSharedFileListAFPTimedShutdown, _kLSSharedFileListApplicationRecentDocuments,
_kLSSharedFileListAutomountedServers, _kLSSharedFileListCancelShutdown,
_kLSSharedFileListDockApplications, _kLSSharedFileListFTPSharingEnabled,
_kLSSharedFileListFavoriteItems, _kLSSharedFileListFavoriteServers,
_kLSSharedFileListFavoriteVolumes, _kLSSharedFileListFinderProjectsItems,
_kLSSharedFileListGlobalLoginItems, _kLSSharedFileListGuestAccessEnabled,
_kLSSharedFileListItemBeforeFirst, _kLSSharedFileListItemBinding,
_kLSSharedFileListItemHidden, _kLSSharedFileListItemIsComputer,
_kLSSharedFileListItemIsEjectableVolume, _kLSSharedFileListItemIsICloudDrive,
_kLSSharedFileListItemIsIDisk, _kLSSharedFileListItemIsMeetingRoom,
_kLSSharedFileListItemIsMobileTimeMachine, _kLSSharedFileListItemIsNetwork,
_kLSSharedFileListItemIsRemoteDisc, _kLSSharedFileListItemIsShared,
_kLSSharedFileListItemIsVideoDisc, _kLSSharedFileListItemLast,
_kLSSharedFileListItemLocked, _kLSSharedFileListItemManaged,
_kLSSharedFileListItemPersistent, _kLSSharedFileListItemRepairedVolume,
_kLSSharedFileListItemShareName, _kLSSharedFileListItemSharePointNotAvailable,
_kLSSharedFileListItemSharingUUID, _kLSSharedFileListItemTargetIsDirectory,
_kLSSharedFileListItemTargetIsVolume, _kLSSharedFileListItemTargetName,
_kLSSharedFileListItemVolumeRefNum, _kLSSharedFileListLoginItemHidden,
_kLSSharedFileListManagedSessionLoginItems, _kLSSharedFileListManagedSharedItems,
_kLSSharedFileListNMBSharingEnabled, _kLSSharedFileListNetworkBrowser,
_kLSSharedFileListRecentApplicationItems, _kLSSharedFileListRecentDocumentItems,
_kLSSharedFileListRecentHostItems, _kLSSharedFileListRecentItemsMaxAmount,
_kLSSharedFileListRecentServerItems, _kLSSharedFileListRestrictedItemFSProperties,
_kLSSharedFileListRestrictedItemFileSecurity, _kLSSharedFileListRestrictedItemOnVolumeSupportingPerms,
_kLSSharedFileListRestrictedItemOnWritableVolume, _kLSSharedFileListRestrictedItemOwner,
_kLSSharedFileListSMBPrintingEnabled, _kLSSharedFileListSMBSharingEnabled,
_kLSSharedFileListSavedSearchesItems, _kLSSharedFileListSessionLoginItems,
_kLSSharedFileListSharePoints, _kLSSharedFileListSharingEnabled,
_kLSSharedFileListSpecialItemIdentifier, _kLSSharedFileListTimedShutdown,
_kLSSharedFileListVolumesComputerVisible, _kLSSharedFileListVolumesIDiskVisible,
_kLSSharedFileListVolumesNetworkVisible, _kLSSharedFileListVolumesShowEjectableVolumes,
_kLSSharedFileListVolumesShowEjectableVolumesExceptions, _kLSSharedFileListVolumesShowHardDrives,
_kLSSharedFileListVolumesShowHardDrivesExceptions, _kLSSharedFileListVolumesShowRemovableVolumes,
_kLSSharedFileListVolumesShowRemovableVolumesExceptions, _kLSSharedFileListVolumesShowRepairing ]
...
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Headers/CoreServices.h | /*
File: CoreServices/CoreServices.h
Contains: Master include for CoreServices
Copyright: (c) 1999-2012 Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __CORESERVICES__
#define __CORESERVICES__
#ifndef __COREFOUNDATION__
#include <CoreFoundation/CoreFoundation.h>
#endif
#ifndef __AE__
#include <AE/AE.h>
#endif
#ifndef __CARBONCORE__
#include <CarbonCore/CarbonCore.h>
#endif
#ifndef __CFNETWORK__
#include <CFNetwork/CFNetwork.h>
#endif
#ifndef __DICTIONARYSERVICES__
#include <DictionaryServices/DictionaryServices.h>
#endif
#ifndef __LAUNCHSERVICES__
#include <LaunchServices/LaunchServices.h>
#endif
#ifndef __METADATA_METADATA__
#include <Metadata/Metadata.h>
#endif
#ifndef __OSSERVICES__
#include <OSServices/OSServices.h>
#endif
#ifndef __SEARCHKIT__
#include <SearchKit/SearchKit.h>
#endif
#ifndef __FSEVENTS__
#include <FSEvents/FSEvents.h>
#endif
#ifndef __SHAREDFILELIST__
#include <SharedFileList/SharedFileList.h>
#endif
#endif /* __CORESERVICES__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Modules/module.modulemap | framework module CoreServices [extern_c] {
umbrella header "CoreServices.h"
exclude header "Components.k.h"
export *
module * {
export *
}
framework module AE {
umbrella header "AE.h"
export *
module * {
export *
}
}
framework module CarbonCore {
umbrella header "CarbonCore.h"
export *
module * {
export *
}
}
framework module DictionaryServices {
umbrella header "DictionaryServices.h"
export *
module * {
export *
}
}
framework module FSEvents {
umbrella header "FSEvents.h"
export *
module * {
export *
}
}
framework module LaunchServices {
umbrella header "LaunchServices.h"
export *
module * {
export *
}
}
framework module Metadata {
umbrella header "Metadata.h"
export *
module * {
export *
}
}
framework module OSServices {
umbrella header "OSServices.h"
export *
module * {
export *
}
}
framework module SearchKit {
umbrella header "SearchKit.h"
export *
module * {
export *
}
}
framework module SharedFileList {
umbrella header "SharedFileList.h"
export *
module * {
export *
}
}
}
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework/CarbonCore.tbd | --- !tapi-tbd
tbd-version: 4
targets: [ x86_64-macos, arm64-macos, arm64e-macos ]
uuids:
- target: x86_64-macos
value: 4C2E47F2-D99C-3E03-9232-C1DEF4CBA716
- target: arm64-macos
value: 00000000-0000-0000-0000-000000000000
- target: arm64e-macos
value: 0A1D27BA-29DA-3CA5-8A1F-27C86D8B7D89
install-name: '/System/Library/Frameworks/CoreServices.framework/Versions/A/Frameworks/CarbonCore.framework/Versions/A/CarbonCore'
current-version: 1319
parent-umbrella:
- targets: [ x86_64-macos, arm64-macos, arm64e-macos ]
umbrella: CoreServices
allowable-clients:
- targets: [ x86_64-macos, arm64-macos, arm64e-macos ]
clients: [ AudioToolbox, Foundation, Metadata ]
exports:
- targets: [ x86_64-macos, arm64e-macos, arm64-macos ]
symbols: [ _AbsoluteDeltaToDuration, _AbsoluteDeltaToNanoseconds, _AbsoluteToDuration,
_AbsoluteToNanoseconds, _AddAbsoluteToAbsolute, _AddAtomic,
_AddAtomic16, _AddAtomic8, _AddCollectionItem, _AddCollectionItemHdl,
_AddDurationToAbsolute, _AddFolderDescriptor, _AddNanosecondsToAbsolute,
_AddResource, _BitAnd, _BitAndAtomic, _BitAndAtomic16, _BitAndAtomic8,
_BitClr, _BitNot, _BitOr, _BitOrAtomic, _BitOrAtomic16, _BitOrAtomic8,
_BitSet, _BitShift, _BitTst, _BitXor, _BitXorAtomic, _BitXorAtomic16,
_BitXorAtomic8, _CLVGetConstantString, _CLVHup, _CLVVisitValuesForKey,
_CSBackupDestinationCopySnapshotDates, _CSBackupDestinationGetDestinationID,
_CSBackupDestinationGetTypeID, _CSBackupIsItemExcluded, _CSBackupMobileIteratorCreate,
_CSBackupMobileIteratorCreateWithOptions, _CSBackupMobileIteratorGetNextURL,
_CSBackupMobileIteratorGetNextURLWithFlags, _CSBackupMobileIteratorGetTypeID,
_CSBackupMobileIteratorSkipDescendents, _CSBackupSetItemExcluded,
_CSBackupWalkCurrentBackup, _CSCopyMachineName, _CSCopyUserName,
_CSDiskSpaceCancelRecovery, _CSDiskSpaceGetRecoveryEstimate,
_CSDiskSpaceStartRecovery, _CSGetComponentsThreadMode, _CSMemDisposeHandle,
_CSMemDisposePtr, _CSMemEmptyHandle, _CSMemGetHandleSize,
_CSMemGetPtrSize, _CSMemHGetState, _CSMemHSetState, _CSMemHandAndHand,
_CSMemHandToHand, _CSMemMunger, _CSMemNewEmptyHandle, _CSMemNewHandle,
_CSMemNewHandleClear, _CSMemNewHandleFromExternalPtr, _CSMemNewPtr,
_CSMemNewPtrClear, _CSMemPtrAndHand, _CSMemPtrToHand, _CSMemPtrToXHand,
_CSMemReallocateHandle, _CSMemRecoverHandle, _CSMemSetHandleSize,
_CSMemSetPtrSize, _CSRefCreateInstance, _CSRefRelease, _CSRefReleaseCallbackForCF,
_CSRefRetain, _CSRefRetainCallbackForCF, _CSSetComponentsThreadMode,
_CallComponent, _CallComponentCanDo, _CallComponentClose,
_CallComponentDispatch, _CallComponentFunction, _CallComponentFunctionWithStorage,
_CallComponentFunctionWithStorageProcInfo, _CallComponentFunctionWithStorageProcInfo_TVector,
_CallComponentGetMPWorkFunction, _CallComponentGetPublicResource,
_CallComponentOpen, _CallComponentRegister, _CallComponentTarget,
_CallComponentUnregister, _CallComponentVersion, _CallThreadInitHooks,
_CaptureComponent, _CarbonCoreGetMainRunLoop, _ChangeTextToUnicodeInfo,
_ChangeUnicodeToTextInfo, _ChangedResource, _CharacterByteType,
_CharacterType, _ClassicVolumeGetStartupInfo, _ClearIntlResourceCache,
_ClearStackList, _CloneCollection, _CloseComponent, _CloseComponentResFile,
_CloseResFile, _CollectionTagExists, _CompareAndSwap, _CompareString,
_CompareText, _CompleteFolderRouting, _ConvertFromPStringToUnicode,
_ConvertFromTextToUnicode, _ConvertFromTextToUnicodeNoInit,
_ConvertFromUnicodeToPString, _ConvertFromUnicodeToScriptCodeRun,
_ConvertFromUnicodeToText, _ConvertFromUnicodeToTextNoInit,
_ConvertFromUnicodeToTextRun, _ConvertLocalTimeToUTC, _ConvertLocalToUTCDateTime,
_ConvertUTCToLocalDateTime, _ConvertUTCToLocalTime, _CopyCollection,
_CopyP2CStr, _CoreEndianFlipData, _CoreEndianGetFlipper, _CoreEndianGetFlipperFromTables,
_CoreEndianGetFlipperFromTablesForUTI, _CoreEndianInstallFlipper,
_Count1Resources, _Count1Types, _CountCollectionItems, _CountCollectionOwners,
_CountCollectionTags, _CountComponentInstances, _CountComponents,
_CountResources, _CountStackListElements, _CountTaggedCollectionItems,
_CountTypes, _CountUnicodeMappings, _CountUnicodeMappingsNoInit,
_CreateTextEncoding, _CreateTextToUnicodeInfo, _CreateTextToUnicodeInfoByEncoding,
_CreateTextToUnicodeInfoNoInit, _CreateThreadPool, _CreateUSetForKCHR,
_CreateUnicodeToTextInfo, _CreateUnicodeToTextInfoByEncoding,
_CreateUnicodeToTextInfoNoInit, _CreateUnicodeToTextRunInfo,
_CreateUnicodeToTextRunInfoByEncoding, _CreateUnicodeToTextRunInfoByScriptCode,
_CurResFile, _DTCurrentContextIsDeferredTask, _DebugAssert,
_DebugCStr, _DebugDumpGestalt, _DebugGestalt, _DebugGestaltStr,
_DebugLogEntry, _DebugPrint, _DebugStr, _Debugger, _DeclineVolumeNotification,
_DeclineVolumeNotificationWithFlags, _DecrementAtomic, _DecrementAtomic16,
_DecrementAtomic8, _Delay, _DelegateComponentCall, _DeleteGestaltValue,
_Dequeue, _DestroyComponent, _DetachHandleFromExternalPtr,
_DetachResource, _DetachResourceFile, _DetermineIfPathIsEnclosedByFolder,
_DisposeCollection, _DisposeComponentFunctionUPP, _DisposeDebugComponent,
_DisposeDebugLog, _DisposeHandle, _DisposePtr, _DisposeStackList,
_DisposeTextToUnicodeInfo, _DisposeTextToUnicodeInfoNoInit,
_DisposeThread, _DisposeThreadInitHookUPP, _DisposeUnicodeToTextInfo,
_DisposeUnicodeToTextInfoNoInit, _DisposeUnicodeToTextRunInfo,
_DisposeVNUPP, _DurationToAbsolute, _DurationToNanoseconds,
_EmptyCollection, _EmptyHandle, _Endian64_Swap, _Enqueue,
_EqualString, _ErrorTranslate, _ExtendedToString, _FIDDumpFileIDMap,
_FIDListFileIDMaps, _FNGetDirectoryForSubscription, _FNNotify,
_FNNotifyAll, _FNNotifyByPath, _FNSubscribe, _FNSubscribeByPath,
_FNUnsubscribe, _FSAllocateFork, _FSCancelVolumeOperation,
_FSCatalogSearch, _FSCloseFork, _FSCloseIterator, _FSCompareFSRefs,
_FSCopyAliasInfo, _FSCopyDADiskForVolume, _FSCopyDiskIDForVolume,
_FSCopyExtendedAttribute, _FSCopyExtendedAttributeByForkRefNum,
_FSCopyExtendedAttributeList, _FSCopyExtendedAttributeListByForkRefNum,
_FSCopyObjectAsync, _FSCopyObjectAsyncWithCallbacks, _FSCopyObjectSync,
_FSCopyURLForVolume, _FSCreateDirectoryUnicode, _FSCreateFileAndOpenForkUnicode,
_FSCreateFileUnicode, _FSCreateFork, _FSCreateResFile, _FSCreateResourceFile,
_FSCreateResourceFork, _FSCreateStringFromHFSUniStr, _FSCreateVolumeOperation,
_FSDeleteFork, _FSDeleteObject, _FSDetermineIfRefIsEnclosedByFolder,
_FSDisposeVolumeOperation, _FSEjectVolumeAsync, _FSEjectVolumeSync,
_FSExchangeObjects, _FSFileOperationCancel, _FSFileOperationCopyStatus,
_FSFileOperationCreate, _FSFileOperationGetTypeID, _FSFileOperationScheduleWithRunLoop,
_FSFileOperationUnscheduleFromRunLoop, _FSFileSecurityCopyAccessControlList,
_FSFileSecurityCreate, _FSFileSecurityCreateWithFSPermissionInfo,
_FSFileSecurityGetGroup, _FSFileSecurityGetGroupUUID, _FSFileSecurityGetMode,
_FSFileSecurityGetOwner, _FSFileSecurityGetOwnerUUID, _FSFileSecurityGetTypeID,
_FSFileSecurityRefCreateCopy, _FSFileSecuritySetAccessControlList,
_FSFileSecuritySetGroup, _FSFileSecuritySetGroupUUID, _FSFileSecuritySetMode,
_FSFileSecuritySetOwner, _FSFileSecuritySetOwnerUUID, _FSFindFolder,
_FSFlushFork, _FSFlushVolume, _FSFollowFinderAlias, _FSGetAsyncEjectStatus,
_FSGetAsyncMountStatus, _FSGetAsyncUnmountStatus, _FSGetCanonicalPath,
_FSGetCatalogInfo, _FSGetCatalogInfoBulk, _FSGetDataForkName,
_FSGetDefaultTextEncoding, _FSGetForkCBInfo, _FSGetForkPosition,
_FSGetForkSize, _FSGetHFSUniStrFromString, _FSGetResourceForkName,
_FSGetTemporaryDirectoryForReplaceObject, _FSGetVolumeForDADisk,
_FSGetVolumeForDiskID, _FSGetVolumeInfo, _FSGetVolumeMountInfo,
_FSGetVolumeMountInfoSize, _FSGetVolumeParent, _FSGetVolumeParms,
_FSIsAliasFile, _FSIsFSRefValid, _FSIterateForks, _FSLockRange,
_FSMakeFSRefUnicode, _FSMatchAliasBulk, _FSMountCopyIOMediaIconBundleIdentifier,
_FSMountCopyIOMediaIconFamilyName, _FSMountDestroy, _FSMountGetCapabilities,
_FSMountGetFSID, _FSMountGetIOBlockSize, _FSMountGetMaxFileSize,
_FSMountGetMountID, _FSMountGetMountPoint, _FSMountGetMutableVolumeInfo,
_FSMountGetSpecialDeviceType, _FSMountGetVolumeCreationDate,
_FSMountGetVolumeFlags, _FSMountGetVolumeName, _FSMountGetVolumeUUID,
_FSMountLocalVolumeAsync, _FSMountLocalVolumeSync, _FSMountMakepath,
_FSMountMountIDToVRefNum, _FSMountPrepare, _FSMountPrepareWithMountPointString,
_FSMountRenameVolume, _FSMountServerVolumeAsync, _FSMountServerVolumeSync,
_FSMountSetProperty, _FSMountStorageSize, _FSMountUpdateCaseInsensitiveName,
_FSMountVCBVRefNum, _FSMoveObject, _FSMoveObjectAsync, _FSMoveObjectAsyncWithCallbacks,
_FSMoveObjectSync, _FSMoveObjectToTrashAsync, _FSMoveObjectToTrashSync,
_FSNewAlias, _FSNewAliasFromPath, _FSNewAliasMinimal, _FSNewAliasMinimalUnicode,
_FSNewAliasUnicode, _FSObjTypeToFSNodeObjectType, _FSOpenFork,
_FSOpenIterator, _FSOpenOrphanResFile, _FSOpenResFile, _FSOpenResourceFile,
_FSOpenResourceFileMapped, _FSPathCopyExtendedAttribute, _FSPathCopyExtendedAttributeList,
_FSPathCopyObjectAsync, _FSPathCopyObjectAsyncWithCallbacks,
_FSPathCopyObjectSync, _FSPathCopyObjectSyncWithCallbacks,
_FSPathFileOperationCopyStatus, _FSPathGetTemporaryDirectoryForReplaceObject,
_FSPathMakeRef, _FSPathMakeRefWithOptions, _FSPathMoveObjectAsync,
_FSPathMoveObjectAsyncWithCallbacks, _FSPathMoveObjectSync,
_FSPathMoveObjectSyncWithCallbacks, _FSPathMoveObjectToTrashAsync,
_FSPathMoveObjectToTrashSync, _FSPathRemoveExtendedAttribute,
_FSPathReplaceObject, _FSPathSetExtendedAttribute, _FSReadFork,
_FSRefCreate64, _FSRefMakePath, _FSRemoveExtendedAttribute,
_FSRemoveExtendedAttributeByForkRefNum, _FSRenameUnicode,
_FSReplaceObject, _FSReservationAcquire, _FSReservationCopyPath,
_FSReservationCreateWithFSRef, _FSReservationCreateWithPath,
_FSReservationGetFSRefInfo, _FSReservationGetReservationType,
_FSReservationGetTypeID, _FSReservationRelinquish, _FSReservationUpdate,
_FSResolveAlias, _FSResolveAliasFile, _FSResolveAliasFileWithMountFlags,
_FSResolveAliasFileWithMountFlagsThreadSafe, _FSResolveAliasWithMountFlags,
_FSResolveNodeID, _FSResourceFileAlreadyOpen, _FSSetCatalogInfo,
_FSSetDefaultTextEncoding, _FSSetExtendedAttribute, _FSSetExtendedAttributeByForkRefNum,
_FSSetForkPosition, _FSSetForkSize, _FSSetVolumeInfo, _FSUnlinkObject,
_FSUnlockRange, _FSUnmountVolumeAsync, _FSUnmountVolumeSync,
_FSUpdateAlias, _FSVolumeMount, _FSWriteFork, _FileIDTreeCreateMountPointArrayWithOptions,
_FileIDTreeGetChildIDFromName, _FileIDTreeGetEntryInfoFromFileID,
_FileIDTreeGetFileIDFromPath, _FileIDTreePrintVolumeIDs, _FileIDTreePrintVolumeInfo,
_FileIDTreePrintVolumeTree, _FileIDTreePrintVolumes, _FileIDTree_GetBootGUID,
_FillParseTable, _FindCharInSet, _FindFolder, _FindFolderRoutingForDomain,
_FindNextComponent, _Fix2Frac, _Fix2Long, _Fix2X, _FixATan2,
_FixDiv, _FixMul, _FixRatio, _FixRound, _FlattenAliasRecord,
_FlattenCollection, _FlattenCollectionToHdl, _FlattenPartialCollection,
_FlushDebugLog, _FolderManagerDeleteUserSpecificItems, _FolderManagerDeleteUserSpecificItemsForVRefNum,
_Font2RealScript, _FontScript, _FontToScript, _FormatRecToString,
_Frac2Fix, _Frac2X, _FracCos, _FracDiv, _FracMul, _FracSin,
_FracSqrt, _GDBComponentList, _Gestalt, _GestaltHostName,
_GestaltUserName, _Get1IndResource, _Get1IndType, _Get1NamedResource,
_Get1Resource, _GetAliasSize, _GetAliasSizeFromPtr, _GetAliasUserType,
_GetAliasUserTypeFromPtr, _GetCollectionDefaultAttributes,
_GetCollectionExceptionProc, _GetCollectionItem, _GetCollectionItemHdl,
_GetCollectionItemInfo, _GetCollectionRetainCount, _GetComponentIDFromComponentInstance,
_GetComponentIndString, _GetComponentInfo, _GetComponentInstanceError,
_GetComponentInstanceStorage, _GetComponentListModSeed, _GetComponentMgrFlags,
_GetComponentPublicIndString, _GetComponentPublicResource,
_GetComponentPublicResourceList, _GetComponentRefcon, _GetComponentResource,
_GetComponentTypeModSeed, _GetCurrentThread, _GetDYLDEntryPoint,
_GetDYLDEntryPointWithImage, _GetDebugComponentInfo, _GetDebugOptionInfo,
_GetDefaultThreadStackSize, _GetFSRefComponentsForFileReferenceURL,
_GetFolderNameUnicode, _GetFolderTypes, _GetForkPhysicalInfo,
_GetFreeThreadCount, _GetHandleSize, _GetHostName, _GetIndResource,
_GetIndType, _GetIndexedCollectionItem, _GetIndexedCollectionItemHdl,
_GetIndexedCollectionItemInfo, _GetIndexedCollectionTag, _GetIntlResource,
_GetIntlResourceTable, _GetLocalDateTime, _GetMacOSStatusCommentString,
_GetMacOSStatusErrorString, _GetMap, _GetMaxResourceSize,
_GetNamedResource, _GetNewCollection, _GetNextFOND, _GetNextResourceFile,
_GetOverrideAttributes, _GetOverrideMap, _GetPtrSize, _GetResAttrs,
_GetResFileAttrs, _GetResInfo, _GetResource, _GetResourceSizeOnDisk,
_GetScriptInfoFromTextEncoding, _GetScriptManagerVariable,
_GetScriptManagerVariable_Internal, _GetScriptVariable, _GetSpecificFreeThreadCount,
_GetStackListElementFromIndex, _GetSysDirection, _GetTaggedCollectionItem,
_GetTaggedCollectionItemInfo, _GetTextEncodingBase, _GetTextEncodingFormat,
_GetTextEncodingFromScriptInfo, _GetTextEncodingName, _GetTextEncodingNameNoInit,
_GetTextEncodingVariant, _GetThreadCurrentTaskRef, _GetThreadGlobals,
_GetThreadScheduler, _GetThreadState, _GetThreadStateGivenTaskRef,
_GetTopResourceFile, _GetUTCDateTime, _HClrRBit, _HFSCreateInstalledEncodingDictionary,
_HGetState, _HLock, _HLockHi, _HSetRBit, _HSetState, _HUnlock,
_HandAndHand, _HandToHand, _HomeResFile, _IUClearCacheSys,
_IUGetItlScript, _IUMagWPString, _IUTextOrderSys, _IdenticalString,
_IdenticalText, _IdentifyFolder, _IdentifyFolderInDomain,
_IncrementAtomic, _IncrementAtomic16, _IncrementAtomic8, _InitScriptBundleComponent,
_InsTime, _InsXTime, _InsertOverrideFile, _InsertOverrideMap,
_InsertResourceFile, _InsertStackListElement, _InsertSystemOverrideFile,
_InstallDebugAssertOutputHandler, _InstallExceptionHandler,
_InstallThreadEventsWaitingHook, _InstallThreadInitHook, _InstallTimeTask,
_InstallXTimeTask, _IntlFCAddSearchCriteria, _IntlFCAddSearchDirectory,
_IntlFCCloseComponentData, _IntlFCCreateNewComponentObject,
_IntlFCDebugCache, _IntlFCDeleteComponent, _IntlFCDisposeComponentObject,
_IntlFCEditComponentObject, _IntlFCOpenComponentData, _IntlFCWriteComponentObject,
_IntlGetCache, _IntlGetInitValues, _IntlGetIsInitIntlValueDone,
_IntlGetToken, _IntlIsInitIntlValueDone, _IntlScript, _IntlSetCache,
_IntlSetInitIntlValueProc, _IntlSetInitValues, _IntlSetToken,
_IntlTokenize, _InvalidateFolderDescriptorCache, _InvokeThreadInitHookUPP,
_InvokeVNUPP, _IsHandleValid, _IsHeapValid, _IsMetric, _IsPointerValid,
_IsThisASystemResourceMap, _LLConvertUCS2toUTF8, _LLConvertUTF8toUCS2,
_LLConvertUTF8toUTF16, _LMGetApFontID, _LMGetApFontIDNoInit,
_LMGetBootDrive, _LMGetBrianBits, _LMGetDskSwtchHook, _LMGetHSCHndl,
_LMGetIntlSpec, _LMGetItlSysCachePtr, _LMGetKeyCache, _LMGetLangMapPtr,
_LMGetMemErr, _LMGetQDExist, _LMGetROMMapHndl, _LMGetResErr,
_LMGetResLoad, _LMGetResOneDeep, _LMGetScriptMapPtr, _LMGetSoundActive,
_LMGetSysFontFamNoInit, _LMGetSysFontSize, _LMGetSysMap, _LMGetTmpResLoad,
_LMGetWWExist, _LMInvalidateKeyCache, _LMSetApFontID, _LMSetBootDrive,
_LMSetBrianBits, _LMSetDskSwtchHook, _LMSetHSCHndl, _LMSetIntlSpec,
_LMSetItlSysCachePtr, _LMSetKeyCache, _LMSetKeyboardSwitchingState,
_LMSetLangMapPtr, _LMSetMemErr, _LMSetQDExist, _LMSetROMMapHndl,
_LMSetResErr, _LMSetResLoad, _LMSetResOneDeep, _LMSetScriptMapPtr,
_LMSetSoundActive, _LMSetSysFontFam, _LMSetSysFontSize, _LMSetSysMap,
_LMSetTmpResLoad, _LanguageOrder, _LoadResource, _LocaleCountNames,
_LocaleGetIndName, _LocaleGetName, _LocaleOperationCountLocales,
_LocaleOperationCountNames, _LocaleOperationGetIndName, _LocaleOperationGetLocales,
_LocaleOperationGetName, _LocaleOperationLoadData, _LocaleOperationUnloadData,
_LocaleRefFromLangOrRegionCode, _LocaleRefFromLocaleString,
_LocaleRefGetPartString, _LocaleStringToLangAndRegionCodes,
_Long2Fix, _MPAllocate, _MPAllocateAligned, _MPAllocateTaskStorageIndex,
_MPArmTimer, _MPBlockClear, _MPBlockCopy, _MPCancelTimer,
_MPCauseNotification, _MPCreateCriticalRegion, _MPCreateEvent,
_MPCreateNotification, _MPCreateQueue, _MPCreateSemaphore,
_MPCreateTask, _MPCreateTaskCFM, _MPCreateTimer, _MPCurrentTaskID,
_MPDeallocateTaskStorageIndex, _MPDelayUntil, _MPDeleteCriticalRegion,
_MPDeleteEvent, _MPDeleteNotification, _MPDeleteQueue, _MPDeleteSemaphore,
_MPDeleteTimer, _MPDisposeTaskException, _MPEnterCriticalRegion,
_MPExit, _MPExitCriticalRegion, _MPExtractTaskState, _MPFree,
_MPGetAllocatedBlockSize, _MPGetNextCpuID, _MPGetNextTaskID,
_MPGetTaskStorageValue, _MPModifyNotification, _MPModifyNotificationParameters,
_MPNotifyQueue, _MPProcessors, _MPProcessorsScheduled, _MPRegisterDebugger,
_MPRemoteCall, _MPRemoteCallCFM, _MPSetEvent, _MPSetExceptionHandler,
_MPSetQueueReserve, _MPSetTaskState, _MPSetTaskStorageValue,
_MPSetTaskTSPriority, _MPSetTaskType, _MPSetTaskWeight, _MPSetTimerNotify,
_MPSignalSemaphore, _MPTaskIsPreemptive, _MPTerminateTask,
_MPThrowException, _MPUnregisterDebugger, _MPWaitForEvent,
_MPWaitOnQueue, _MPWaitOnSemaphore, _MPYield, _MapScriptInfoAndISOCodes,
_MemError, _Microseconds, _ModeToFSNodeType, _Munger, _NanosecondsToAbsolute,
_NanosecondsToDuration, _NearestMacTextEncodings, _NearestMacTextEncodingsNoInit,
_NewCollection, _NewComponentFunctionUPP, _NewDebugComponent,
_NewDebugLog, _NewDebugOption, _NewEmptyHandle, _NewGestaltValue,
_NewHandle, _NewHandleClear, _NewHandleFromExternalPtr, _NewPtr,
_NewPtrClear, _NewStackListSys, _NewThread, _NewThreadInitHookUPP,
_NewVNUPP, _NumToString, _OLD_NEXT_COLORS, _OSTypeToCString,
_OpenAComponent, _OpenAComponentResFile, _OpenADefaultComponent,
_OpenComponent, _OpenComponentResFile, _OpenDefaultComponent,
_PBAllocateForkAsync, _PBAllocateForkSync, _PBCatalogSearchAsync,
_PBCatalogSearchSync, _PBCloseForkAsync, _PBCloseForkSync,
_PBCloseIteratorAsync, _PBCloseIteratorSync, _PBCompareFSRefsAsync,
_PBCompareFSRefsSync, _PBCreateDirectoryUnicodeAsync, _PBCreateDirectoryUnicodeSync,
_PBCreateFileAndOpenForkUnicodeAsync, _PBCreateFileAndOpenForkUnicodeSync,
_PBCreateFileUnicodeAsync, _PBCreateFileUnicodeSync, _PBCreateForkAsync,
_PBCreateForkSync, _PBDeleteForkAsync, _PBDeleteForkSync,
_PBDeleteObjectAsync, _PBDeleteObjectSync, _PBExchangeObjectsAsync,
_PBExchangeObjectsSync, _PBFSCopyFileAsync, _PBFSCopyFileSync,
_PBFSResolveNodeIDAsync, _PBFSResolveNodeIDSync, _PBFlushForkAsync,
_PBFlushForkSync, _PBFlushVolumeAsync, _PBFlushVolumeSync,
_PBGetCatalogInfoAsync, _PBGetCatalogInfoBulkAsync, _PBGetCatalogInfoBulkSync,
_PBGetCatalogInfoSync, _PBGetForkCBInfoAsync, _PBGetForkCBInfoSync,
_PBGetForkPositionAsync, _PBGetForkPositionSync, _PBGetForkSizeAsync,
_PBGetForkSizeSync, _PBGetVolumeInfoAsync, _PBGetVolumeInfoSync,
_PBIterateForksAsync, _PBIterateForksSync, _PBMakeFSRefUnicodeAsync,
_PBMakeFSRefUnicodeSync, _PBMoveObjectAsync, _PBMoveObjectSync,
_PBOpenForkAsync, _PBOpenForkSync, _PBOpenIteratorAsync, _PBOpenIteratorSync,
_PBReadForkAsync, _PBReadForkSync, _PBRenameUnicodeAsync,
_PBRenameUnicodeSync, _PBSetCatalogInfoAsync, _PBSetCatalogInfoSync,
_PBSetForkPositionAsync, _PBSetForkPositionSync, _PBSetForkSizeAsync,
_PBSetForkSizeSync, _PBSetVolumeInfoAsync, _PBSetVolumeInfoSync,
_PBUnlinkObjectAsync, _PBUnlinkObjectSync, _PBWriteForkAsync,
_PBWriteForkSync, _PBXLockRangeAsync, _PBXLockRangeSync, _PBXUnlockRangeAsync,
_PBXUnlockRangeSync, _PLpos, _PLstrcat, _PLstrchr, _PLstrcmp,
_PLstrcpy, _PLstrlen, _PLstrncat, _PLstrncmp, _PLstrncpy,
_PLstrpbrk, _PLstrrchr, _PLstrspn, _PLstrstr, _PopStackListElement,
_PrimeTime, _PrimeTimeTask, _PrintEnumerationCache, _PrintFSAccessControlEntry,
_PrintFSRef, _PrintFSRefPath, _PrintFileInfo, _PrintLaunchDebugInfo,
_PrintOpenForks, _PrintResourceChain, _PrintVolumeInfo, _PtrAndHand,
_PtrToHand, _PtrToXHand, _PurgeCollection, _PurgeCollectionTag,
_PushStackListElement, _QueryUnicodeMappings, _QueryUnicodeMappingsNoInit,
_RMAddResFileToSearchPath, _RMAddResourceByFileRef, _RMChangedResourceByFileRef,
_RMCloseResourceFile, _RMCloseResourceFileByFileRef, _RMDetachResourceByFileRef,
_RMDisposeMappedFileRef, _RMFSCreateResFile, _RMFSCreateResourceFile,
_RMFSOpenResourceFile, _RMGetIndexedResource, _RMGetIndexedResourceByFileRef,
_RMGetIndexedType, _RMGetNamedResource, _RMGetPtrAndSizeFromMappedRef,
_RMGetResource, _RMGetResourceByFileRef, _RMGetResourceCount,
_RMGetResourceCountByFileRef, _RMGetResourceSize, _RMGetTopOfOrphanChain,
_RMGetTypeCount, _RMInsertMappedResourceFileInChain, _RMNewMappedRefFromMappedFork,
_RMOpenResourceFileRef, _RMReadPartialResourceByFileRef, _RMReleaseResourceByFileRef,
_RMRemoveResFileFromSearchPath, _RMRemoveResourceByFileRef,
_RMUpdateResourceFileByFileRef, _RMWriteResourceByFileRef,
_ReadLocation, _ReadPartialResource, _RealScript, _ReallocateHandle,
_RecoverHandle, _RefFix2X, _RefX2Fix, _RefX2Frac, _RegisterComponent,
_RegisterComponentFileRef, _RegisterComponentFileRefEntries,
_RegisterComponentResource, _RegisterComponentResourceFile,
_RelString, _ReleaseCollection, _ReleaseFolder, _ReleaseResource,
_RemoveChewableItemsFromVolume, _RemoveCollectionItem, _RemoveFolderDescriptor,
_RemoveIndexedCollectionItem, _RemoveResource, _RemoveStackListElement,
_RemoveThreadInitHook, _RemoveTimeTask, _ReplaceGestaltValue,
_ReplaceIndexedCollectionItem, _ReplaceIndexedCollectionItemHdl,
_ReplaceStackListElement, _ReplaceText, _RequestVolumeNotification,
_RequestVolumeNotificationWithFlags, _ResError, _ResetTextToUnicodeInfo,
_ResetUnicodeToTextInfo, _ResetUnicodeToTextRunInfo, _ResolveComponentAlias,
_ResolveDefaultTextEncoding, _RetainCollection, _RevertTextEncodingToScriptInfo,
_RmvTime, _S32Set, _S64Absolute, _S64Add, _S64And, _S64BitwiseAnd,
_S64BitwiseEor, _S64BitwiseNot, _S64BitwiseOr, _S64Compare,
_S64Divide, _S64Eor, _S64Max, _S64Min, _S64Multiply, _S64Negate,
_S64Not, _S64Or, _S64Set, _S64SetU, _S64ShiftLeft, _S64ShiftRight,
_S64Subtract, _SInt64ToUInt64, _SMDisposeIntlSpec, _SMInitIntlSpec,
_ScriptOrder, _ScriptToRange, _SearchStackList, _SearchStackListFirstFourBytes,
_SetAliasUserType, _SetAliasUserTypeWithPtr, _SetCollectionDefaultAttributes,
_SetCollectionExceptionProc, _SetCollectionItemInfo, _SetComponentInstanceError,
_SetComponentInstanceStorage, _SetComponentMgrFlags, _SetComponentRefcon,
_SetDebugOptionValue, _SetDebuggerNotificationProcs, _SetDefaultComponent,
_SetFallbackUnicodeToText, _SetFallbackUnicodeToTextRun, _SetGestaltSystemValue,
_SetGestaltSystemValuesBulk, _SetGestaltValue, _SetGestaltValuesBulk,
_SetGetFNumProc, _SetGetFontFromPortProc, _SetGetFontNameProc,
_SetGetFontScriptProc, _SetGetScriptFontFlagsCallback, _SetHandleSize,
_SetIndexedCollectionItemInfo, _SetInitializeScriptHLProc,
_SetLocalDateTime, _SetOverrideAttributes, _SetPtrSize, _SetResAttrs,
_SetResFileAttrs, _SetResInfo, _SetResLoad, _SetResPurge,
_SetResourceSize, _SetScriptFontValidatorCallback, _SetScriptManagerVariable,
_SetScriptManagerVariable_KeyScriptOverride, _SetScriptVariable,
_SetSwapKeyboardProc, _SetSysDirection, _SetThreadGlobalsAreCooperative,
_SetThreadReadyGivenTaskRef, _SetThreadScheduler, _SetThreadState,
_SetThreadStateEndCritical, _SetThreadSwitcher, _SetThreadTerminator,
_SetUTCDateTime, _SetUnicodeConverterInstalledScripts, _StringOrder,
_StringToExtended, _StringToFormatRec, _StringToNum, _SubAbsoluteFromAbsolute,
_SubDurationFromAbsolute, _SubNanosecondsFromAbsolute, _SysBreak,
_SysBreakFunc, _SysBreakStr, _SysError, _TECClearConverterContextInfo,
_TECClearSnifferContextInfo, _TECConvertText, _TECConvertTextToMultipleEncodings,
_TECCopyTextEncodingInternetNameAndMIB, _TECCountAvailableSniffers,
_TECCountAvailableTextEncodings, _TECCountDestinationTextEncodings,
_TECCountDirectTextEncodingConversions, _TECCountMailTextEncodings,
_TECCountSubTextEncodings, _TECCountWebTextEncodings, _TECCreateConverter,
_TECCreateConverterFromPath, _TECCreateOneToManyConverter,
_TECCreateSniffer, _TECDisposeConverter, _TECDisposeSniffer,
_TECFlushMultipleEncodings, _TECFlushText, _TECGetAvailableSniffers,
_TECGetAvailableTextEncodings, _TECGetBasicOptions, _TECGetDestinationTextEncodings,
_TECGetDirectTextEncodingConversions, _TECGetEncodingList,
_TECGetInfo, _TECGetMailTextEncodings, _TECGetSubTextEncodings,
_TECGetTextEncodingFromInternetName, _TECGetTextEncodingFromInternetNameOrMIB,
_TECGetTextEncodingInternetName, _TECGetWebTextEncodings,
_TECSetBasicOptions, _TECSniffEncodingAndLanguage, _TECSniffTextEncoding,
_TSAcquireReader, _TSAtomicCompareAndSwapPtr, _TSBroadcastCondition,
_TSChangeExceptionCatcherHandler, _TSCreateStorageKey, _TSCreateThread,
_TSCreateThreadWithPolicy, _TSCreateThreadWithStackSize, _TSDeleteStorageKey,
_TSDestroyCondition, _TSDestroyMutex, _TSDestroyReaderWriterLock,
_TSDestroySemaphore, _TSDurationToTimeSpec, _TSExceptionAbort,
_TSExceptionContinue, _TSExceptionGetLiveState, _TSExit, _TSGetDefaultThreadStackSize,
_TSGetMainThreadBacktrace, _TSGetPriority, _TSGetStackBase,
_TSGetStackSize, _TSGetStorage, _TSInitCondition, _TSInitMutex,
_TSInitReaderWriterLock, _TSInitSemaphore, _TSInstallExceptionCatcher,
_TSLockMutex, _TSReaderToWriter, _TSReleaseReader, _TSRemoveExceptionCatcher,
_TSSelf, _TSSetPriority, _TSSetStorage, _TSSignalCondition,
_TSSignalSemaphore, _TSTerminateThread, _TSTryLockMutex, _TSUnlockMutex,
_TSWaitOnCondition, _TSWaitOnConditionTimed, _TSWaitOnConditionTimedRelative,
_TSWaitOnSemaphore, _TSWaitOnSemaphoreRelative, _TSWriterToReader,
_TSYield, _TUCharacterByteType, _TaskLevel, _TempNewHandle,
_TestAndClear, _TestAndSet, _TextOrder, _ThreadBeginCritical,
_ThreadCurrentStackSpace, _ThreadEndCritical, _ThreadsHaveNonMainRunnable,
_TickCount, _TransferCustomIconAndBadge, _TransliterateText,
_TruncateForTextToUnicode, _TruncateForUnicodeToText, _U32SetU,
_U64Add, _U64And, _U64BitwiseAnd, _U64BitwiseEor, _U64BitwiseNot,
_U64BitwiseOr, _U64Compare, _U64Divide, _U64Eor, _U64Max,
_U64Multiply, _U64Not, _U64Or, _U64Set, _U64SetU, _U64ShiftLeft,
_U64ShiftRight, _U64Subtract, _UCCompareCollationKeys, _UCCompareText,
_UCCompareTextDefault, _UCCompareTextNoLocale, _UCCompileuchr,
_UCConvertCFAbsoluteTimeToLongDateTime, _UCConvertCFAbsoluteTimeToSeconds,
_UCConvertCFAbsoluteTimeToUTCDateTime, _UCConvertLongDateTimeToCFAbsoluteTime,
_UCConvertSecondsToCFAbsoluteTime, _UCConvertUTCDateTimeToCFAbsoluteTime,
_UCCreateCollator, _UCCreateTextBreakLocator, _UCCreateUSetForUchr,
_UCDisposeCollator, _UCDisposeTextBreakLocator, _UCFindTextBreak,
_UCGenerateSwappedUchr, _UCGetCharProperty, _UCGetCollationKey,
_UCKeyTranslate, _UCKeyboardLayoutStringMax, _UCLoadCharPropsTablePriv,
_UCTypeSelectAddKeyToSelector, _UCTypeSelectAddKeyToSelectorData,
_UCTypeSelectAddKeyToSelectorDataWithTime, _UCTypeSelectCompare,
_UCTypeSelectCreateSelector, _UCTypeSelectDisposeSelector,
_UCTypeSelectFindItem, _UCTypeSelectFlushSelectorData, _UCTypeSelectNewSelector,
_UCTypeSelectReleaseSelector, _UCTypeSelectWalkList, _UCTypeSelectWouldResetBuffer,
_UCUnloadCharPropsTablePriv, _UCUseCharPropsTablePriv, _UInt64ToSInt64,
_UTF8ToCString, _UmapBCharToUChars, _UmapCloseMapping, _UmapGetCharsToComposeUSet,
_UmapOpenMapping, _UmapScanUCharElement, _UmapSetFallbacks,
_UmapSetLookupInfo, _UmapUCharElementToBChars, _UncaptureComponent,
_UnflattenAliasRecord, _UnflattenCollection, _UnflattenCollectionFromHdl,
_UnicodeValidConversionLength, _Unique1ID, _UniqueID, _UnregisterComponent,
_UnsignedFixedMulDiv, _UpTime, _UpdateResFile, _UpgradeScriptInfoToTextEncoding,
_UseResFile, _ValidComponent, _WideAdd, _WideBitShift, _WideCompare,
_WideDivide, _WideMultiply, _WideNegate, _WideShift, _WideSquareRoot,
_WideSubtract, _WideWideDivide, _WritePartialResource, _WriteResource,
_X2Fix, _X2Frac, _YieldToAnyThread, _YieldToThread, __AL_CreateMinimalAliasHandle,
__AL_FlattenAliasRecordFromPtr, __AL_MarkAliasDoNotDisplay,
__AL_UnflattenAliasRecordFromPtr, __AddMountInfoToAlias, __AddServerURLInfoToAlias,
__C2PStr, __CSBackupAddAdvisoryForDatabasePath, __CSBackupBackUpNow,
__CSBackupBackupAboutToBegin, __CSBackupBackupCompleted, __CSBackupBuildNumberCompare,
__CSBackupCancelBackup, __CSBackupCompareAliasData, __CSBackupCompareItems,
__CSBackupCopyBackupItemsForBUItem, __CSBackupCopyBackupRootLocationForDate,
__CSBackupCopyBackupRootLocationForSnapshot, __CSBackupCopyBackupSessionID,
__CSBackupCopyClientNotifyString, __CSBackupCopyCompletedRecoverySets,
__CSBackupCopyComputerURLOnVolume, __CSBackupCopyCustomBooterToBackupDisk,
__CSBackupCopyDestinationMountPointURL, __CSBackupCopyDifferentBackupItemsForBUItem,
__CSBackupCopyDiskImageForDirectory, __CSBackupCopyHostUUID,
__CSBackupCopyInProgressRecoverySets, __CSBackupCopyInProgressThinningRecoverySets,
__CSBackupCopyItemBackupLocationForDate, __CSBackupCopyItemLatestBackupLocation,
__CSBackupCopyLatestBackupRootLocation, __CSBackupCopyMACAddress,
__CSBackupCopyMTMOverlayMountPointURL, __CSBackupCopyMachineDirectoryForDestination,
__CSBackupCopyMatchingComputerURLOnVolume, __CSBackupCopyMatchingSnapshotItem,
__CSBackupCopyMountPointURLForDestination, __CSBackupCopyNetworkInfoFromAlias,
__CSBackupCopyNextDifferentItemForBUItem, __CSBackupCopyOriginalItemLocation,
__CSBackupCopyPathFromAliasDataNoMount, __CSBackupCopyPathFromAliasNoMount,
__CSBackupCopyPathFromAliasReturningStatus, __CSBackupCopyPreviousDifferentItemForBUItem,
__CSBackupCopyRecoverySet, __CSBackupCopyRecoverySetToBackupStore,
__CSBackupCopyRecoverySetURLInBackupStoreForBoardID, __CSBackupCopySessionNotifyString,
__CSBackupCopySessionStatus, __CSBackupCopySnapshotDate, __CSBackupCopySnapshotForBUItem,
__CSBackupCopySnapshotLabel, __CSBackupCopySnapshotsForBUItem,
__CSBackupCopyStandardizedNetworkDestinationURL, __CSBackupCopySuggestedDiskImageName,
__CSBackupCopyTimeMachineDiskImageURLsOnVolume, __CSBackupCreateAliasByRemovingServerURLInfoFromAlias,
__CSBackupCreateAliasDataFromAlias, __CSBackupCreateAliasDataFromPath,
__CSBackupCreateAliasFromAliasData, __CSBackupCreateAliasFromPath,
__CSBackupCreateBackupSession, __CSBackupDeleteBackup, __CSBackupEstimateReusableBytesOnVolume,
__CSBackupFindMatchingOriginalItemByPath, __CSBackupFindMatchingSnapshotItemByPath,
__CSBackupFindMatchingSnapshotItemByPathWithHints, __CSBackupFindUnusedIndexIntoRecoverySetsDirectory,
__CSBackupGetDefaultBackupSession, __CSBackupGetMachineMACAddress,
__CSBackupGetSharedServerProxy, __CSBackupGetSharedStatusProxy,
__CSBackupIdentityCopyFileVaultExclusionPaths, __CSBackupIdentityCopyFileVaultImagePath,
__CSBackupIdentityCopyFileVaultImagePaths, __CSBackupIdentityCopyFileVaultUsers,
__CSBackupIdentityCopyLocalUsers, __CSBackupIdentityUserIsFileVault,
__CSBackupInitializeBackupDaemon, __CSBackupItemGetsBackedUp,
__CSBackupItemIsSnapshot, __CSBackupMarkSnapshotForDeletion,
__CSBackupPathIsBackupItem, __CSBackupPostStatusNotifyForClient,
__CSBackupPostStatusNotifyForSession, __CSBackupRegisterMTMExclusions,
__CSBackupRegisterPreAndPostBackupHooks, __CSBackupRemoveAdvisoryForDatabasePath,
__CSBackupRequestFreeSpaceOnVolume, __CSBackupRuleTreeCreateWithVolumeName,
__CSBackupRuleTreeEvaluateFile, __CSBackupRuleTreeEvaluateFolder,
__CSBackupRuleTreeGetNodeForPath, __CSBackupRuleTreeGetTypeID,
__CSBackupRuleTreePushFullPath, __CSBackupRuleTreeSetPathExcluded,
__CSBackupRuleTreeSetPathsExcluded, __CSBackupRulesEngineAddPath,
__CSBackupRulesEngineAddRuleTree, __CSBackupRulesEngineAddSourcePath,
__CSBackupRulesEngineAddStdRulesToTree, __CSBackupRulesEngineBulkEvaluatePathCopyIncludedChildren,
__CSBackupRulesEngineBulkEvaluateURLCopyIncludedChildren,
__CSBackupRulesEngineCopyRuleTrees, __CSBackupRulesEngineCopySourceDictionary,
__CSBackupRulesEngineCopySourcePaths, __CSBackupRulesEngineCreateForBackup,
__CSBackupRulesEngineCreateWithArchive, __CSBackupRulesEngineEvaluateFile,
__CSBackupRulesEngineEvaluateFileFromFullPath, __CSBackupRulesEngineEvaluateFolder,
__CSBackupRulesEngineEvaluateFolderFromFullPath, __CSBackupRulesEngineEvaluateFromFullPath,
__CSBackupRulesEngineEvaluateFromFullPathDeferDirectoryDecision,
__CSBackupRulesEngineGetRuleTreeForPath, __CSBackupRulesEngineGetRuleTreeWithVolEntry,
__CSBackupRulesEngineGetTypeID, __CSBackupRulesEngineIsExclusionRulesCacheEnabled,
__CSBackupRulesEngineIsPathExcluded, __CSBackupRulesEnginePopAllComponents,
__CSBackupRulesEnginePopPathComponent, __CSBackupRulesEnginePushPathComponent,
__CSBackupRulesEnginePushRelativePath, __CSBackupRulesEngineQuickEvaluateFromFullPath,
__CSBackupRulesEngineRemoveRuleTree, __CSBackupRulesEngineRemoveSourcePath,
__CSBackupRulesEngineSetExclusionRulesCacheEnabled, __CSBackupRulesEngineSetPathExcluded,
__CSBackupRulesEngineSetTraversalPath, __CSBackupServerCopyStatus,
__CSBackupServerIsActive, __CSBackupServerProxyBackupNow,
__CSBackupServerProxyCancelBackup, __CSBackupServerProxyCopyDestinationMountPoint,
__CSBackupServerProxyGetTypeID, __CSBackupServerProxyIsPortRegistered,
__CSBackupServerProxyRunHealthCheck, __CSBackupServerProxySendMessage,
__CSBackupServerProxySetNeedsRescan, __CSBackupSessionCopyBackupDirectory,
__CSBackupSessionGetTypeID, __CSBackupSetBackupSessionTarget,
__CSBackupSettingsAreSystemFilesSkipped, __CSBackupSettingsCanEnableAutoBackup,
__CSBackupSettingsCanManuallyBackup, __CSBackupSettingsCanSetBackupVolume,
__CSBackupSettingsCopyBackupAlias, __CSBackupSettingsCopyBackupAliasData,
__CSBackupSettingsCopyDestinations, __CSBackupSettingsCopyExcludedPaths,
__CSBackupSettingsCopyExcludedVolumes, __CSBackupSettingsCopyIncludedPaths,
__CSBackupSettingsCopyIncludedVolumes, __CSBackupSettingsCopyNextBackupDate,
__CSBackupSettingsCopySkippedFolders, __CSBackupSettingsCopySkippedItems,
__CSBackupSettingsCopySkippedPaths, __CSBackupSettingsCopyStdExcludedContentPaths,
__CSBackupSettingsCopyStdExcludedFileContentPaths, __CSBackupSettingsCopyStdExcludedPaths,
__CSBackupSettingsCopyStdExcludedUserPaths, __CSBackupSettingsCreate,
__CSBackupSettingsExcludePath, __CSBackupSettingsGetMaxBackupSize,
__CSBackupSettingsGetTypeID, __CSBackupSettingsIsAutoBackupEnabled,
__CSBackupSettingsIsPathExcluded, __CSBackupShouldBackUpRecoverySet,
__CSBackupShouldCheckLocalRecoveryPartition, __CSBackupStartBackingUpItem,
__CSBackupStopBackingUpItem, __CSBackupSuspendAutomaticActivity,
__CSBackupSystemVersionCompare, __CSBackupURLIsBackupItem,
__CSBackupUnregisterMTMExclusions, __CSBackupWasItemEverBackedUp,
__CSCheckFix, __CSCheckFixDisable, __CSCheckFixSetBundleInformation,
__CSCheckFixWithInfo, __CSCopyLazyValuesForKey, __CSCopyNamedData,
__CSCreateSeed, __CSDestroySeed, __CSFlushNamedData, __CSGetNamedData,
__CSGetProcessorArchitecture, __CSIncrementSeed, __CSReadSeed,
__CSReleaseNamedData, __CSSetNamedData, __CSWriteSeed, __CharacterByteType,
__ConvertLocalTimeToUTC, __ConvertLocalToUTCDateTime, __ConvertUTCToLocalDateTime,
__ConvertUTCToLocalTime, __CopyCStringToPascal, __CopyComponentBundleIdentifier,
__CopyPascalStringToC, __CoreServicesServerMain, __EqualString,
__FNNotifyByURL, __FSAccessControlEntryCopyUUID, __FSAccessControlEntryCreateMutableWithUUID,
__FSAccessControlEntryCreateMutableWithUUIDBytes, __FSAccessControlEntryGetAccessControlInfo,
__FSAccessControlEntryGetDisplayAsCurrentID, __FSAccessControlEntryGetDisplayAsCurrentIDValue,
__FSAccessControlEntryGetTypeID, __FSAccessControlEntryGetUUIDBytes,
__FSAccessControlEntryGetUnmappableInfo, __FSAccessControlEntryGetVisibility,
__FSAccessControlEntrySetAccessControlInfo, __FSAccessControlEntrySetUUID,
__FSAccessControlEntrySetUUIDBytes, __FSAddVolumeObserver,
__FSAddVolumeObserverOnQueue, __FSAllocateQuarantineData,
__FSApplyAccessRightsToObjectForUser, __FSApplyAccessRightsToObjectWithDictionary,
__FSCatalogSearchPlusFileIDs, __FSCompareAliasRecords, __FSCompareFlattenedFSRefs,
__FSCopyAliasFile, __FSCopyAliasFileWithFlags, __FSCopyAliasInfoFromAliasPtr,
__FSCopyExtendedAliasInfoFromAliasPtr, __FSCopyFSPackedFSRef,
__FSCopyFile, __FSCopyPOSIXSymlink, __FSCopyVolumeProperty,
__FSCreateEffectiveAccessArrayWithACLArray, __FSCreateFSPackedFSRef,
__FSCreateFileDictionaryFromDirectoryDictionary, __FSCreateFileSecurityRefForCopyWithFinalDestRef,
__FSCreateFinalDestinationFileSecurityRef, __FSCreateMutableACLArrayForObject,
__FSCreateMutableACLArrayFromPOSIXPerms, __FSCreateMutableFileACLArrayFromDirectoryACLArray,
__FSCreateRelativeFSRef, __FSCreateStrippedFileSecurityRef,
__FSCreateUserAccessRightsDictionaryForObject, __FSDeallocateQuarantineData,
__FSDisableAutoDiskArbHandling, __FSDisposeFSPackedFSRef,
__FSEffectiveAccessEntryCopyUUID, __FSEffectiveAccessEntryGetEffectiveAccessControlInfo,
__FSEffectiveAccessEntryGetUUIDBytes, __FSErrorTranslate,
__FSFileSecurityCreateForFileFromDirectory, __FSFileSecurityGetfilesec_t,
__FSFileSecurityUnsetAccessControlList, __FSFileSecurityUnsetGroup,
__FSFileSecurityUnsetGroupUUID, __FSFileSecurityUnsetMode,
__FSFileSecurityUnsetOwner, __FSFileSecurityUnsetOwnerUUID,
__FSFlattenFSRef, __FSFlipAFPXVolMountInfo, __FSForkAdvise,
__FSGetAliasInfoFromAliasPtr, __FSGetCatalogInfoByName, __FSGetDisableNetworkVolumes,
__FSGetExtendedUserAccess, __FSGetFSRefFromPackedFSRef, __FSGetFSRefInformationFast,
__FSGetFileIDAndVRefNum, __FSGetFileVaultHomeDirectoryVRefNum,
__FSGetObjectAccess, __FSGetVolumeByName, __FSGetVolumeDeviceAttributes,
__FSGetVolumeDeviceTypeAndBackingStoreVolume, __FSGetVolumeEncoding,
__FSGetVolumeForMountpoint, __FSGetVolumeInfoWithFlags, __FSGetVolumeMountpoint,
__FSGetVolumePermissions, __FSGetVolumeProperty, __FSIdentifyFolder,
__FSIsItemFileVaultHomeDirectory, __FSIsItemHomeDirectory,
__FSIsSyntheticLink, __FSIsVolumeDiskImage, __FSLinkObjectUnicode,
__FSMakeFSRefFromSpecData, __FSMapIDToName, __FSMapIDtoUUID,
__FSMapNameToID, __FSMapNameToUUID, __FSMapUUIDToIDAndName,
__FSMapUUIDToName, __FSModifyAccessRightsOfObjectForUser,
__FSModifyAccessRightsOfObjectWithDictionaries, __FSMoveAndRenameObject,
__FSNewHomeDirRelativeAliasByPath, __FSNewMinimalPathAliasFromAbsoluteHFSStylePath,
__FSNewMinimalPathAliasFromRelativeUTF8PathAndServerInfo,
__FSNewVersion3Alias, __FSNewVersion3PathAlias, __FSOpenForkWithCatalogInfo,
__FSPathAllocateQuarantineData, __FSPathGetCatalogInfo, __FSPathSetQuarantineData,
__FSPermissionArrayAddEntry, __FSPermissionArrayCreateFSPermissionInfo,
__FSPermissionArrayCreateFSPermissionInfoWithVolume, __FSPermissionArrayCreateWithPermissionInfo,
__FSPermissionArrayCreateWithPermissionInfoWithVolume, __FSPermissionArrayCreateWithSecurityInfo,
__FSPermissionArrayWriteToDisk, __FSRemoveUserFromObjectAccessControlList,
__FSRemoveVolumeObserver, __FSRemoveVolumeObserverOnQueue,
__FSRemoveVolumeProperty, __FSReplaceAccessControlListWithArray,
__FSReplaceAccessControlListWithDictionary, __FSSamePhysicalDevice,
__FSScheduleFileVolumeOperations, __FSSetAliasHandleSizeValidation,
__FSSetDisableNetworkVolumes, __FSSetObjectAccess, __FSSetObjectAccessRights,
__FSSetObjectOwnership, __FSSetQuarantineData, __FSSetStrictAliasPathMatchByDefault,
__FSSetVolumeEncoding, __FSSetVolumePermissions, __FSSetVolumeProperty,
__FSTransferExtendedAttributes, __FSTransferExtendedAttributesByForkRefNum,
__FSUnflattenFSRef, __FSUnscheduleFileVolumeOperations, __FSValidVolume,
__FSVolumeAllocateQuarantineData, __FSVolumeMount, __FSVolumeSetQuarantineData,
__FileIDTreeGetSKServiceDescription, __FindFolderRouting,
__FindNextComponentWithPlatformsBitmap, __FlattenComponent,
__FolderManagerDeleteUserSpecificItemsWithTimeout, __GDBUserBreakCallbackFunc,
__GDBUserBreakShouldSignalWithSIGINT, __GetComponentFSRef,
__GetComponentPlatformsBitmap, __GetComponentThingInfo, __GetCurrentEventTimestamp,
__GetIOKitDeviceTypeFromDeviceID, __GetUTCDateTime, __HClrRBit,
__HGetState, __HNoPurge, __HPurge, __HSetRBit, __HSetState,
__InitCarbonCore, __LMGetApFontID, __LMGetSysFontFam, __MPIsFullyInitialized,
__MPLibraryIsCompatible, __MPLibraryVersion, __P2CStr, __PBCatalogSearchPlusFileIDs,
__PLpos, __PLstrcat, __PLstrchr, __PLstrcmp, __PLstrcpy, __PLstrlen,
__PLstrncat, __PLstrncmp, __PLstrncpy, __PLstrpbrk, __PLstrrchr,
__PLstrspn, __PLstrstr, __SCSeedGetSKServiceDescription, __URLGetExtendedUserAccess,
__UnflattenComponent, __UppercaseText, __c2pstr, __c2pstrcpy,
__ccSetGetHandleSizeCallout, __p2cstr, __p2cstrcpy, _annuity,
_compound, _dec2f, _dec2l, _dec2num, _dec2s, _dec2str, _dtox80,
_gCarbonDiskSwitchDialog, _gSCKnownSKPlugins, _kBackupID,
_kBackupMachineAddressXAttrKey, _kBackupNotificationObject,
_kBackupPrefsChangedNotification, _kBackupPrefsPlist, _kBackupsTopLevelFolder,
_kCSBackupAirPortInfoMacAddressKey, _kCSBackupAirPortInfoNameKey,
_kCSBackupAirPortInfoVersionKey, _kCSBackupAlwaysShowDeletedBackupsWarningKey,
_kCSBackupBootPlist, _kCSBackupClientIdXPCKey, _kCSBackupCustomBooter,
_kCSBackupCustomBooterPathXPCKey, _kCSBackupCustomRecoveryBooterPath,
_kCSBackupDestinationIdentifierXPCKey, _kCSBackupDestinationMountNotification,
_kCSBackupDestinationsKey, _kCSBackupEncryptedTMBootPickerVersionXattrKey,
_kCSBackupExcludedVolumeUUIDsKey, _kCSBackupFVAccountsFolder,
_kCSBackupFVMountPoint, _kCSBackupHasEncryptedRecoveryBitsXAttrKey,
_kCSBackupHasRecoverySetXAttrKey, _kCSBackupHealthCheckSkeletonDirectoryPath,
_kCSBackupHostUUIDXAttrKey, _kCSBackupIncludedVolumeUUIDsKey,
_kCSBackupItemNewestSnapshotMDKey, _kCSBackupItemOldestSnapshotMDKey,
_kCSBackupItemPathMDKey, _kCSBackupKernelCache, _kCSBackupKernelCachePath,
_kCSBackupKernelCacheRecoverySetsPath, _kCSBackupKernelFlags,
_kCSBackupKernelFlagsBaseSystemPath, _kCSBackupKernelFlagsRecoverySetsPath,
_kCSBackupKeyAutoBackup, _kCSBackupKeyBackupAlias, _kCSBackupKeyBackupHasRecoverySet,
_kCSBackupKeyBackupPath, _kCSBackupKeyClientID, _kCSBackupKeyDestURL,
_kCSBackupKeyDestinationUUID, _kCSBackupKeyDestinationUUIDs,
_kCSBackupKeyDestinationVolumeUUIDs, _kCSBackupKeyExcludeSystem,
_kCSBackupKeyExcludedVolumes, _kCSBackupKeyHealthCheckInterval,
_kCSBackupKeyHostUUIDs, _kCSBackupKeyIncludedVolumes, _kCSBackupKeyMaxSize,
_kCSBackupKeyMobileBackups, _kCSBackupKeySkipPaths, _kCSBackupKeySourceURLs,
_kCSBackupKeyTrickleBackup, _kCSBackupLatestSnapshotSymlinkName,
_kCSBackupLaunchAirPortUtilityNotification, _kCSBackupLaunchPreferencesNotification,
_kCSBackupMTMDeltaStoreTopLevelFolder, _kCSBackupMTMHiddenChangeFilesFolder,
_kCSBackupMessageIdXPCKey, _kCSBackupNewSystemBackupAvailableNotification,
_kCSBackupNewSystemBackupPath, _kCSBackupNotifyDied, _kCSBackupNotifyExclusionsChanged,
_kCSBackupNotifyPrefsChanged, _kCSBackupNotifyProgress, _kCSBackupNotifyThinningBackup,
_kCSBackupNotifyThinningBackupEnded, _kCSBackupPhaseCalculatingChanges,
_kCSBackupPhaseCopying, _kCSBackupPhaseDeletingOldBackups,
_kCSBackupPhaseFinishing, _kCSBackupPhaseHealthCheckCopyHFSMeta,
_kCSBackupPhaseHealthCheckFsck, _kCSBackupPhaseKey, _kCSBackupPhaseMigratingMobileBackups,
_kCSBackupPhaseMountingBackupVolume, _kCSBackupPhaseMountingBackupVolumeForHealthCheck,
_kCSBackupPhaseStarting, _kCSBackupPhaseThinningPostBackup,
_kCSBackupPhaseThinningPreBackup, _kCSBackupPhaseWaitingForSpotlight,
_kCSBackupPlatformSupportPlist, _kCSBackupProductBuildVersion,
_kCSBackupProductVersion, _kCSBackupRecoveryContentsDirectory,
_kCSBackupRecoverySetIndexXPCKey, _kCSBackupRecoverySetsDirectory,
_kCSBackupRecoverySetsDirectoryPath, _kCSBackupRecoverySetsPathXPCKey,
_kCSBackupRequiresACPowerKey, _kCSBackupResultCodeXPCKey,
_kCSBackupSnapshotDatesCachePath, _kCSBackupSnapshotStartDateXAttrKey,
_kCSBackupSnapshotTypeXAttrKey, _kCSBackupSuccessBoolXPCKey,
_kCSBackupSupportedBoardIds, _kCSBackupSuspendHelperActivityTimeStamp,
_kCSBackupSystemVersionPlist, _kCSBackupTMBootPickerVersionXattrKey,
_kCSBackupThinEncryptedRecoverySetsXattrKey, _kCSBackupTopLevelFolder,
_kCSBackupTrickleSnapshotStoreName, _kCSBackupVolumeBytesUsedXAttrKey,
_kCSBackupVolumeCaseSensitiveXAttrKey, _kCSBackupVolumePathXPCKey,
_kCSBackupXPCConnectionName, _kCSBackupXPCSandboxConnectionName,
_kCSBackupXPCStatusConnectionName, _kCSBackupdKeyBytesCopied,
_kCSBackupdKeyClientID, _kCSBackupdKeyDestinationMountPoint,
_kCSBackupdKeyErrorCode, _kCSBackupdKeyFileVaultUser, _kCSBackupdKeyFirstBackup,
_kCSBackupdKeyIsRunning, _kCSBackupdKeyIsStopping, _kCSBackupdKeyLastSystemBackupDate,
_kCSBackupdKeyLatestBackupPath, _kCSBackupdKeyMobileBackupName,
_kCSBackupdKeyMobileBackupsMigrated, _kCSBackupdKeyNumberOfChangedItems,
_kCSBackupdKeyNumberOfDeepScannedItems, _kCSBackupdKeyNumberOfExcludedItems,
_kCSBackupdKeyPercent, _kCSBackupdKeyProgress, _kCSBackupdKeyStats,
_kCSBackupdKeyTimeRemaining, _kCSBackupdKeyTotalBytesCopied,
_kCSBackupdKeyTotalMobileBackupsToMigrate, _kCSBackupdPortName,
_kCSBackupdResultDictionaryPath, _kCSBackupdSignature, _kCSBackupdStatusPortName,
_kCompletionDateXAttrKey, _kFSEventVolumeAboutToRename, _kFSEventVolumeAboutToUnmount,
_kFSEventVolumeMounted, _kFSEventVolumePropertyChanged, _kFSEventVolumeRenamed,
_kFSEventVolumeRepairStarted, _kFSEventVolumeUnmountFailed,
_kFSEventVolumeUnmounted, _kFSFileManagerVolumePropertyChanged,
_kFSFileManagerVolumePropertyMonitor, _kFSIOMediaIconBundleIdentifier,
_kFSIOMediaIconFamilyName, _kFSIsAirportVolume, _kFSIsBDVideo,
_kFSIsDVDVideo, _kFSIsMobileTimeMachine, _kFSIsNetworkOpticalVolume,
_kFSIsTimeMachineVolume, _kFSIsVideoDisk, _kFSOperationBytesCompleteKey,
_kFSOperationBytesRemainingKey, _kFSOperationObjectsCompleteKey,
_kFSOperationObjectsRemainingKey, _kFSOperationThroughputKey,
_kFSOperationTotalBytesKey, _kFSOperationTotalObjectsKey,
_kFSOperationTotalUserVisibleObjectsKey, _kFSOperationUserVisibleObjectsCompleteKey,
_kFSOperationUserVisibleObjectsRemainingKey, _kFSReservationPidArray,
_kFSVolumeIsBeingRepaired, _kFSVolumeIsBeingUnmounted, _kFSVolumePropertyKey,
_kFSVolumeRefNumKey, _kSnapshotContainerXAttrKey, _kSnapshotStateXAttrKey,
_kSnapshotVolumeFSEventStoreUUIDXAttrKey, _kSnapshotVolumeLastEventBackedUpXAttrKey,
_kSnapshotVolumeUUIDXAttrKey, _ldtox80, _lowMem, _num2dec,
_numtostring, _pi, _randomx, _relation, _relstring, _scAddReconnectProc,
_scCopyAllSessionInfo, _scCreateService, _scCreateServiceVersion,
_scCreateSystemService, _scCreateSystemServiceVersion, _scGetProcessOptions,
_scGetServerCheckinPort, _scGetServerOptions, _scPrefsForgetKey,
_scPrefsGetInteger, _scPrefsGetString, _scPrefsPostData, _scPrefsSetInteger,
_scPrefsSetString, _str2dec, _x80tod, _x80told ]
...
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework/Headers/BackupCore.h | /*
File: CarbonCore/BackupCore.h
Contains: Backup low level Interfaces.
Copyright: © 2006-2011 by Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __BACKUPCORE__
#define __BACKUPCORE__
#ifndef __CFURL__
#include <CoreFoundation/CFURL.h>
#endif
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
/*
* CSBackupSetItemExcluded()
*
* Discussion:
* Add or remove an item from the list of items excluded from
* backup. When backing up, the backup daemon skips items marked by
* this call. If a folder is marked for exclusion, it and its
* contents are excluded from backup. When specifying by path, it is
* OK to pass a URL of an item/folder that does not exist yet.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* item:
* The URL of the file/folder to be added or removed from the
* exclusion list.
*
* exclude:
* true to exclude an item, false to stop excluding it.
*
* excludeByPath:
* false to make the exclusion bit 'sticky', i.e. follow the item
* if it gets moved, true to tie the exclusion to an absolute path.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern OSStatus
CSBackupSetItemExcluded(
CFURLRef item,
Boolean exclude,
Boolean excludeByPath) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_NA);
/*
* CSBackupIsItemExcluded()
*
* Discussion:
* Report whether or not an item is being excluded from backup.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* item:
* A URL to the item of interest.
*
* excludeByPath:
* pass an optional return address to determine whether or not the
* given item is excluded as an absolute path or whether it is
* sticky to the item. Can be NULL.
*
* Result:
* true if the item or any of its ancestors are excluded from
* backup, false otherwise.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern Boolean
CSBackupIsItemExcluded(
CFURLRef item,
Boolean * excludeByPath) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_NA);
#ifdef __cplusplus
}
#endif
#endif /* __BACKUPCORE__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework/Headers/LowMem.h | /*
File: CarbonCore/LowMem.h
Contains: Low Memory Accessor Interfaces.
The contents of this header file are deprecated.
Copyright: © 1993-2011 by Apple Inc. All rights reserved.
*/
#ifndef __LOWMEM__
#define __LOWMEM__
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
#ifndef __FILES__
#include <CarbonCore/Files.h>
#endif
#ifndef __MACMEMORY__
#include <CarbonCore/MacMemory.h>
#endif
#ifndef __OSUTILS__
#include <CarbonCore/OSUtils.h>
#endif
#ifndef __RESOURCES__
#include <CarbonCore/Resources.h>
#endif
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
#pragma pack(push, 2)
/**************************************************************************************
SIMPLE LOWMEM ACCESSORS
**************************************************************************************/
/*
The following functions were moved to Quickdraw.h:
LMSetDeviceList
LMSetLastSPExtra
LMGetWidthListHand
LMSetWidthListHand
LMGetScrHRes
LMSetScrHRes
LMSetScrVRes
LMGetScrVRes
LMGetHiliteMode
LMSetHiliteMode
LMGetMainDevice
LMSetMainDevice
LMGetDeviceList
LMGetQDColors
LMSetQDColors
LMGetWidthPtr
LMSetWidthPtr
LMGetWidthTabHandle
LMSetWidthTabHandle
LMGetLastSPExtra
LMGetLastFOND
LMSetLastFOND
LMGetFractEnable
LMSetFractEnable
LMGetTheGDevice
LMSetTheGDevice
LMGetCursorNew
LMSetCursorNew
LMGetHiliteRGB
LMSetHiliteRGB
The following functions were moved to TextEdit.h:
LMGetWordRedraw
LMSetWordRedraw
The following functions were moved to Menus.h:
LMGetTheMenu
The following functions were moved to Events.h:
LMGetKeyRepThresh
LMSetKeyRepThresh
LMGetKeyThresh
LMSetKeyRepThresh
LMGetKbdLast
LMSetKbdLast
LMGetKbdType
LMSetKbdType
*/
#if !__LP64__
/*
* LMGetMemTop() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern Ptr LMGetMemTop(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetMemTop() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void LMSetMemTop(Ptr value) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* LMGetBufPtr() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern Ptr LMGetBufPtr(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetBufPtr() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void LMSetBufPtr(Ptr value) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* LMGetHeapEnd() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern Ptr LMGetHeapEnd(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetHeapEnd() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void LMSetHeapEnd(Ptr value) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* LMGetCPUFlag() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern UInt8 LMGetCPUFlag(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetCPUFlag() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void LMSetCPUFlag(UInt8 value) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* LMGetRndSeed() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern SInt32 LMGetRndSeed(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetRndSeed() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void LMSetRndSeed(SInt32 value) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* LMGetSEvtEnb() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern UInt8 LMGetSEvtEnb(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetSEvtEnb() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void LMSetSEvtEnb(UInt8 value) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
#endif /* !__LP64__ */
/*
* LMGetBootDrive()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern SInt16 LMGetBootDrive(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetBootDrive()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void LMSetBootDrive(SInt16 value) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
#if !__LP64__
/*
* LMGetSdVolume() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern UInt8 LMGetSdVolume(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetSdVolume() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void LMSetSdVolume(UInt8 value) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* LMGetSoundPtr() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern Ptr LMGetSoundPtr(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetSoundPtr() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void LMSetSoundPtr(Ptr value) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* LMGetSoundBase() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern Ptr LMGetSoundBase(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetSoundBase() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void LMSetSoundBase(Ptr value) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* LMGetSoundLevel() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern UInt8 LMGetSoundLevel(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetSoundLevel() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void LMSetSoundLevel(UInt8 value) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* LMGetCurPitch() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern SInt16 LMGetCurPitch(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetCurPitch() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void LMSetCurPitch(SInt16 value) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
#endif /* !__LP64__ */
/*
* LMGetROM85()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
* LMSetROM85()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
* LMGetPortBUse()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
* LMSetPortBUse()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
* LMGetGNEFilter()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
* LMSetGNEFilter()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
* LMGetROMBase()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
* LMSetROMBase()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
* LMGetRAMBase()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
* LMSetRAMBase()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
* LMGetDSAlertTab()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
* LMSetDSAlertTab()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
NOTE: LMGetABusVars and LMSetABusVars have been removed.
Their implememtation in InterfaceLib was inconsistent
with their prototypes here. In InterfaceLib LMSetABusVars
would copy eight bytes and LMGetABusVars would return the
value 0x02D8 instead of the long at that location.
Use LMGetABusGlobals/LMSetABusGlobals to get/set the
long at location 0x02D8 which is a pointer to the AppleTalk
globals. Use LMGetABusDCE/LMSetABusDCE to get/set the
long at location 0x02DC which is the .MPP driver
Device Control Entry.
*/
/*
* LMGetABusGlobals()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 8.5 and later
*/
/*
* LMGetABusDCE()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 8.5 and later
*/
/*
* LMSetABusGlobals()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 8.5 and later
*/
/*
* LMSetABusDCE()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 8.5 and later
*/
#if !__LP64__
/*
* LMGetScrDmpEnb() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern UInt8 LMGetScrDmpEnb(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetScrDmpEnb() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void LMSetScrDmpEnb(UInt8 value) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* LMGetBufTgFNum() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern SInt32 LMGetBufTgFNum(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetBufTgFNum() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void LMSetBufTgFNum(SInt32 value) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* LMGetBufTgFFlg() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern SInt16 LMGetBufTgFFlg(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetBufTgFFlg() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void LMSetBufTgFFlg(SInt16 value) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* LMGetBufTgFBkNum() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern SInt16 LMGetBufTgFBkNum(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetBufTgFBkNum() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void LMSetBufTgFBkNum(SInt16 value) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* LMGetBufTgDate() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern SInt32 LMGetBufTgDate(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetBufTgDate() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void LMSetBufTgDate(SInt32 value) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* LMGetMinStack() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern SInt32 LMGetMinStack(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetMinStack() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void LMSetMinStack(SInt32 value) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* LMGetDefltStack() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern SInt32 LMGetDefltStack(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetDefltStack() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void LMSetDefltStack(SInt32 value) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* LMGetGZRootHnd() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern Handle LMGetGZRootHnd(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetGZRootHnd() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void LMSetGZRootHnd(Handle value) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* LMGetGZMoveHnd() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern Handle LMGetGZMoveHnd(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetGZMoveHnd() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void LMSetGZMoveHnd(Handle value) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* LMGetToExtFS() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern UniversalProcPtr LMGetToExtFS(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetToExtFS() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void LMSetToExtFS(UniversalProcPtr value) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* LMGetJStash() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern UniversalProcPtr LMGetJStash(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetJStash() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void LMSetJStash(UniversalProcPtr value) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* LMGetCurApRefNum() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern FSIORefNum LMGetCurApRefNum(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetCurApRefNum() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void LMSetCurApRefNum(FSIORefNum value) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* LMGetCurStackBase() *** DEPRECATED ***
*
* Deprecated:
* If using the Thread Manager APIs, use ThreadCurrentStackSpace().
* If using pthreads(), get the stack with
* pthread_get_stackaddr_np().
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern Ptr LMGetCurStackBase(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetCurStackBase() *** DEPRECATED ***
*
* Deprecated:
* Mac OS X does not support setting the stack base.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void LMSetCurStackBase(Ptr value) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* LMGetCurPageOption() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern SInt16 LMGetCurPageOption(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetCurPageOption() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void LMSetCurPageOption(SInt16 value) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* LMGetPrintErr() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern SInt16 LMGetPrintErr(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetPrintErr() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void LMSetPrintErr(SInt16 value) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
#endif /* !__LP64__ */
/*
* LMGetApFontID() *** DEPRECATED ***
*
* Summary:
* Get the id of the application font. Use GetAppFont() in the
* Quickdraw framework instead of this.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern SInt16 LMGetApFontID(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetApFontID() *** DEPRECATED ***
*
* Summary:
* Set the id of the application font. Don't use this call anymore;
* this functionality is not supported on Mac OS X.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void LMSetApFontID(SInt16 value) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
#if !__LP64__
/*
* LMGetOneOne() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern SInt32 LMGetOneOne(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetOneOne() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void LMSetOneOne(SInt32 value) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* LMGetMinusOne() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern SInt32 LMGetMinusOne(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetMinusOne() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void LMSetMinusOne(SInt32 value) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
#endif /* !__LP64__ */
/*
* LMGetSysMap()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern SInt16 LMGetSysMap(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetSysMap()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void LMSetSysMap(SInt16 value) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* LMGetResLoad()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern UInt8 LMGetResLoad(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetResLoad()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void LMSetResLoad(UInt8 value) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* LMGetResErr()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern SInt16 LMGetResErr(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetResErr()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void LMSetResErr(SInt16 value) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* LMGetTmpResLoad()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern UInt8 LMGetTmpResLoad(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetTmpResLoad()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void LMSetTmpResLoad(UInt8 value) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* LMGetIntlSpec()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern Ptr LMGetIntlSpec(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetIntlSpec()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void LMSetIntlSpec(Ptr value) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/* LMGetWordRedraw and LMSetWordRedraw moved to TextEdit.h */
#if !__LP64__
/*
* LMGetSysFontFam() *** DEPRECATED ***
*
* Summary:
* Get the id of the system font family. Use GetSysFont() in the
* Quickdraw framework instead of this.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern SInt16 LMGetSysFontFam(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
#endif /* !__LP64__ */
/*
* LMSetSysFontFam() *** DEPRECATED ***
*
* Summary:
* Set the id of the system font family. This is not supported on
* Mac OS X.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void LMSetSysFontFam(SInt16 value) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* LMGetSysFontSize() *** DEPRECATED ***
*
* Summary:
* Get the size of the system font. Use DefFontSize() in the
* Quickdraw framework instead of this.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern SInt16 LMGetSysFontSize(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetSysFontSize()
*
* Summary:
* Set the size for the system font. This is not supported on Mac
* OS X.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void LMSetSysFontSize(SInt16 value) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/**************************************************************************************
"BLOCKMOVE ACCESSORS"
These lowmem accessors use the BlockMove to set
**************************************************************************************/
#if !__LP64__
/*
* LMGetCurApName() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern StringPtr LMGetCurApName(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetCurApName() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void LMSetCurApName(ConstStr31Param curApNameValue) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* LMGetSysResName() *** DEPRECATED ***
*
* Deprecated:
* Mac OS X does not have the concept of a "System" file name.
* Remove usage of this lowmem value.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern StringPtr LMGetSysResName(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetSysResName() *** DEPRECATED ***
*
* Deprecated:
* Mac OS X does not have the concept of a "System" file name.
* Remove usage of this lowmem value.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void LMSetSysResName(ConstStr15Param sysResNameValue) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* LMGetFinderName() *** DEPRECATED ***
*
* Deprecated:
* Getting the name of the Finder isn't terribly useful. If you
* need to find the Finder process, look it up with the CFBundle
* calls by bundle id ( "com.apple.finder" ). Remove usage of this
* lowmem value.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern StringPtr LMGetFinderName(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetFinderName() *** DEPRECATED ***
*
* Deprecated:
* Setting the name of the Finder application is not supported on
* Mac OS X. Remove usage of this lowmem accessor.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void LMSetFinderName(ConstStr15Param finderNameValue) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* LMGetToolScratch() *** DEPRECATED ***
*
* Deprecated:
* Mac OS X gives each process its own tool scratch area, so this
* accessor is fairly useless. If you really need to share 8 bytes
* of memory among various libraries, just make it a global and
* export it from one library and import it into the others.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern Ptr LMGetToolScratch(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetToolScratch() *** DEPRECATED ***
*
* Deprecated:
* Mac OS X gives each process its own tool scratch area, so this
* accessor is fairly useless. If you really need to share 8 bytes
* of memory among various libraries, just make it a global and
* export it from one library and import it into the others.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void LMSetToolScratch(const void * toolScratchValue) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/**************************************************************************************
"INDEXED ACCESSORS"
These lowmem accessors take an index parameter to get/set an indexed
lowmem global.
**************************************************************************************/
/*
* LMGetLvl2DT() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern UniversalProcPtr LMGetLvl2DT(short vectorNumber) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetLvl2DT() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void LMSetLvl2DT(UniversalProcPtr Lvl2DTValue, short vectorNumber) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/**************************************************************************************
"Missing Accessors"
These lowmem accessors are not in the original InterfaceLib. They were
added to InterfaceLib in Mac OS 8.5. In Universal Interfaces 3.2 they
were defined via a macro. In you want to use these functions on a pre-8.5
systems, you must write your own macros to override the function prototype
or write your own implementation.
**************************************************************************************/
/* accesses "HiHeapMark"*/
/*
* LMGetHighHeapMark() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 8.5 and later
*/
extern Ptr LMGetHighHeapMark(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetHighHeapMark() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 8.5 and later
*/
extern void LMSetHighHeapMark(Ptr value) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/* accesses "StkLowPt"*/
/*
* LMGetStackLowPoint() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 8.5 and later
*/
extern Ptr LMGetStackLowPoint(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetStackLowPoint() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 8.5 and later
*/
extern void LMSetStackLowPoint(Ptr value) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/* accesses "FmtDefaults"*/
/*
* LMGetDiskFormatingHFSDefaults() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 8.5 and later
*/
extern Ptr LMGetDiskFormatingHFSDefaults(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* LMSetDiskFormatingHFSDefaults() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 8.5 and later
*/
extern void LMSetDiskFormatingHFSDefaults(Ptr value) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
#endif /* !__LP64__ */
#pragma pack(pop)
#ifdef __cplusplus
}
#endif
#endif /* __LOWMEM__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework/Headers/Debugging.h | /*
File: CarbonCore/Debugging.h
Contains: Macros to handle exceptions and assertions.
The contents of this header file are deprecated.
Copyright: © 1989-2011 by Apple Inc. All rights reserved.
*/
#ifndef __DEBUGGING__
#define __DEBUGGING__
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
#ifndef __MIXEDMODE__
#include <CarbonCore/MixedMode.h>
#endif
#ifndef __MACERRORS__
#include <CarbonCore/MacErrors.h>
#endif
#include <Availability.h>
#include <TargetConditionals.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
/*
This file supplies standard debugging routines and macros to Carbon and
Classic Mac OS programs. Other C programs which wish to use the
exception handling and assertion macros should include AssertMacros.h
instead of this file.
To activate debugger breaks, #define DEBUG to 1 (one) before including this
file. Five further levels of debugging are available, selected by #defining
one of the following conditionals to 1 after DEBUG is defined to 1.
DEBUG_INTERNAL the default; asserts include file and line number
information
DEBUG_EXTERNAL used for code which must ship to developers outside
your organization; no file or line number
information is included in asserts
DEBUG_BREAK_ONLY where an assertion string would normally be sent to
the debugger; call Debugger() instead.
PRODUCTION used for shipping code; no debugger breaks are
emitted
PERFORMANCE same as PRODUCTION
#defining DEBUG to 0 is equivalent to #defining PRODUCTION 1 when
DEBUG is 1. (No code for debugger breaks is emitted in either case.)
#defining DEBUG to 1 without specifying a level is equivalent to #defining
DEBUG_INTERNAL 1.
In addition, these macros should also be #defined (they are described in detail below):
kComponentSignatureString
COMPONENT_SIGNATURE
*/
/*
* Before including this file, #define kComponentSignatureString to a C-string
* containing the name of your client and #define COMPONENT_SIGNATURE to your
* client's unique signature (i.e., your program's registered creator type).
* For example:
*
* #define kComponentSignatureString "SurfWriter"
* #define COMPONENT_SIGNATURE 'WAVE'
*
* If you don't define kComponentSignatureString and COMPONENT_SIGNATURE, the
* default kComponentSignatureString and COMPONENT_SIGNATURE values will be
* used by the DEBUGASSERTMSG macros below.
*/
#ifndef kComponentSignatureString
#define kComponentSignatureString "Third Party Client"
#endif
#ifndef COMPONENT_SIGNATURE
#define COMPONENT_SIGNATURE '?*?*'
#endif
#define QuoteExceptionString(x) #x
/*
* The DEBUGLEVEL's
*/
#define DEBUG_LEVEL_PRODUCTION 0
#define DEBUG_LEVEL_BREAK_ONLY 1
#define DEBUG_LEVEL_EXTERNAL 3
#define DEBUG_LEVEL_INTERNAL 4
#define DEBUGFULL DEBUG_LEVEL_INTERNAL
/*
* define DEBUGLEVEL
*/
#if DEBUG
#if PRODUCTION
#define DEBUGLEVEL DEBUG_LEVEL_PRODUCTION
#elif PERFORMANCE
#define DEBUGLEVEL DEBUG_LEVEL_PRODUCTION
#elif DEBUG_BREAK_ONLY
#define DEBUGLEVEL DEBUG_LEVEL_BREAK_ONLY
#elif DEBUG_EXTERNAL
#define DEBUGLEVEL DEBUG_LEVEL_EXTERNAL
#elif DEBUG_INTERNAL
#define DEBUGLEVEL DEBUG_LEVEL_INTERNAL
#else
/* default to DEBUG_LEVEL_INTERNAL */
#define DEBUGLEVEL DEBUG_LEVEL_INTERNAL
#endif
#endif
#ifndef DEBUGLEVEL
#define DEBUGLEVEL DEBUG_LEVEL_PRODUCTION
#endif
/*
* The options parameter to DebugAssert and DEBUGASSERTMSG is currently reserved (must be zero).
*/
#define DEBUG_NO_OPTIONS 0
/*
* DEBUGASSERTMSG()
*
* Summary:
* All error reporting is routed through this macro, which calls the system
* routine DebugAssert(). If you wish to use your own assertion break
* routine, you can override DEBUGASSERTMSG by defining it before including
* this file.
*
* Parameters:
*
* componentSignature:
* The unique signature of component causing the assertion.
*
* options:
* reserved.
*
* assertionString:
* A pointer to a string constant containing the assertion.
* This must be a string constant (and not a string variable or
* NULL) because the Proeprocessor concatenates it with other
* string constants
*
* exceptionLabelString:
* A pointer to a string containing the exceptionLabel, or NULL.
*
* errorString:
* A pointer to the error string, or NULL. DEBUGASSERTMSG macros
* must not attempt to concatenate this string with constant
* character strings.
*
* fileName:
* A pointer to the fileName or pathname (generated by the
* preprocessor __FILE__ identifier), or NULL.
*
* lineNumber:
* The line number in the file (generated by the preprocessor
* __LINE__ identifier), or 0 (zero).
*
* value:
* A value associated with the assertion, or NULL.
*/
#ifndef DEBUGASSERTMSG
#if DEBUGLEVEL == DEBUG_LEVEL_PRODUCTION
/* no debugger message */
#define DEBUGASSERTMSG(componentSignature, options, assertionString, exceptionLabelString, errorString, fileName, lineNumber, value)
#elif DEBUGLEVEL == DEBUG_LEVEL_BREAK_ONLY
/* call Debugger() if it is available */
#define DEBUGASSERTMSG(componentSignature, options, assertionString, exceptionLabelString, errorString, fileName, lineNumber, value) \
Debugger()
#elif DEBUGLEVEL == DEBUG_LEVEL_EXTERNAL
/* exclude fileName and lineNumber */
#define DEBUGASSERTMSG(componentSignature, options, assertionString, exceptionLabelString, errorString, fileName, lineNumber, value) \
DebugAssert(componentSignature, options, assertionString, exceptionLabelString, errorString, 0, 0, (void*)value)
#else
/* include all info */
#define DEBUGASSERTMSG(componentSignature, options, assertionString, exceptionLabelString, errorString, fileName, lineNumber, value) \
DebugAssert(componentSignature, options, assertionString, exceptionLabelString, errorString, fileName, lineNumber, (void*)value)
#endif
#endif
#if TARGET_OS_OSX
/*
* Define the three inputs to AssertMacros.h
*/
#ifndef DEBUG_ASSERT_COMPONENT_NAME_STRING
#define DEBUG_ASSERT_COMPONENT_NAME_STRING kComponentSignatureString
#endif
#ifndef DEBUG_ASSERT_PRODUCTION_CODE
#define DEBUG_ASSERT_PRODUCTION_CODE (DEBUGLEVEL==0)
#endif
#ifndef DEBUG_ASSERT_MESSAGE
#define DEBUG_ASSERT_MESSAGE(componentNameString, assertionString, exceptionLabelString, errorString, fileName, lineNumber, value) \
DEBUGASSERTMSG(COMPONENT_SIGNATURE, DEBUG_NO_OPTIONS, componentNameString ": " assertionString, exceptionLabelString, errorString, fileName, lineNumber, value)
#endif
#endif
/*
* Non-macOS targets use the default inputs in AssertMacros.h
*/
/*
* Include AssertMacros.h where all of the check, verify, and require macros are defined
*/
#include <AssertMacros.h>
/*
* The following check, verify, and require macros assert that TaskLevel is 0.
*/
#define ATTASKLEVEL0() \
(TaskLevel() == 0)
#define check_tasklevel0() \
__Check(ATTASKLEVEL0())
#define check_tasklevel0_string(cstring) \
__Check_string(ATTASKLEVEL0(), cstring)
#define verify_tasklevel0() \
__Verify(ATTASKLEVEL0())
#define verify_tasklevel0_string(cstring) \
__Verify_String(ATTASKLEVEL0(), cstring)
#define require_tasklevel0(exceptionLabel) \
__Require(ATTASKLEVEL0(), exceptionLabel)
#define require_tasklevel0_action(exceptionLabel, action) \
__Require_action(ATTASKLEVEL0(), exceptionLabel, action)
#define require_tasklevel0_quiet(exceptionLabel) \
__Require_quiet(ATTASKLEVEL0(), exceptionLabel)
#define require_tasklevel0_action_quiet(exceptionLabel, action) \
__Require_action_quiet(ATTASKLEVEL0(), exceptionLabel, action)
#define require_tasklevel0_string(exceptionLabel, cstring) \
__Require_string(ATTASKLEVEL0(), exceptionLabel, cstring)
#define require_tasklevel0_action_string(exceptionLabel, action, cstring) \
__Require_action_string(ATTASKLEVEL0(), exceptionLabel, action, cstring)
/*
* You can use DPRINTF as a dprintf which goes away in production builds.
* DPRINTF is not supported by Carbon because dprintf
* is not supported by Carbon.
*
* To use it, double-parenthesize the argument - i.e., use:
*
* DPRINTF(("formatString %d", 5 ));
*
* This is sadly necessary because a macro can not have a variable number
* of arguments.
*
* DPRINTF is defined only if it is not already defined to
* prevent conflicts with developer code.
*/
#if defined(DEBUG) && DEBUG
#define DPRINTF(x) dprintf x
#else
#define DPRINTF(x) { }
#endif
/*
* kBlessedBusErrorBait is an address that will never be mapped by
* Mac OS 8 or 9. It is close to the middle of the 64K range from 0x68F10000
* to 0x68F1FFFF that is unmapped and cannot be accessed without causing an
* exception. Thus, it's a good value to use for filling uninitialized
* pointers, etc.
*
* Mac OS X programs should NOT use kBlessedBusErrorBait and should use
* zero (0) instead, since by default, page 0 is read and write protected
* for user code.
*/
enum {
kBlessedBusErrorBait = 0x68F168F1
};
/*
* DebugAssert()
*
* Summary:
* DebugAssert is the system routine that the DEBUGASSERTMSG macro
* calls (by default) to display assertion messsages. The output
* from DebugAssert can be redirected by installing a
* DebugAssertOutputHandler with InstallDebugAssertOutputHandler.
*
* Mac OS X threading:
* Thread safe
* This call is thread safe if no debug components are registered,
* and may be thread unsafe if there are debug components being
* installed or removed.
*
* Parameters:
*
* componentSignature:
* The unique signature of component causing the assertion.
*
* options:
* reserved.
*
* assertionString:
* A pointer to a string containing the assertion, or NULL.
*
* exceptionLabelString:
* A pointer to a string containing the exceptionLabel, or NULL.
*
* errorString:
* A pointer to the error string, or NULL.
*
* fileName:
* A pointer to the fileName or pathname (generated by the
* preprocessor __FILE__ identifier), or NULL.
*
* lineNumber:
* The line number in the file (generated by the preprocessor
* __LINE__ identifier), or 0 (zero).
*
* value:
* A value associated with the assertion, or NULL.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in DebugLib 1.0 and later
*/
extern void
DebugAssert(
OSType componentSignature,
UInt32 options,
const char * assertionString,
const char * exceptionLabelString,
const char * errorString,
const char * fileName,
long lineNumber,
void * value) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* TaskLevel masks
*/
enum {
k68kInterruptLevelMask = 0x00000007, /* 68K interrupt levels 0 through 7 */
kInVBLTaskMask = 0x00000010, /* VBLs are executing */
kInDeferredTaskMask = 0x00000020, /* Deferred tasks are executing */
kInSecondaryIntHandlerMask = 0x00000040, /* Secondary interrupt handlers are executing */
kInNestedInterruptMask = 0x00000080 /* The system is handling an interrupt */
};
/*
* TaskLevel()
*
* Summary:
* TaskLevel returns 0 if we're (probably) running at non-interrupt
* time. There's no way to make this perfect, but this is as close
* as we can get. If TaskLevel doesn't return 0, then one of the
* TaskLevel masks can be used to learn more. Mac OS X has no
* concept of "TaskLevel"; and so it will always return the value 0.
*
* Mac OS X threading:
* Thread safe
*
* Result:
* The current task level.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in DebugLib 1.0 and later
*/
extern UInt32
TaskLevel(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* Constants used by the DebugComponent functions
*/
enum {
kComponentDebugOption = 0 /* optionSelectorNum to turn breaks for component On or Off*/
};
enum {
kGetDebugOption = 1, /* get current debug option setting*/
kSetDebugOption = 2 /* set debug option*/
};
/*
* DebugComponentCallbackProcPtr
*
* Discussion:
* DebugComponentCallback is the callback into a component that
* registers with DebugLib. It is called to get the debug option
* setting, or to turn a debug option on or off.
*
* Parameters:
*
* optionSelectorNum:
* The component debug option to set.
*
* command:
* The command the DebugComponentCallbackProc must handle:
* kGetDebugOption - get current debug option setting
* kSetDebugOption - set debug option
*
* optionSetting:
* A pointer to a Boolean where the DebugComponentCallbackProc
* must return the option setting: the current setting if command
* is kGetDebugOption; the new debug option if command is
* kSetDebugOption
*/
typedef CALLBACK_API( void , DebugComponentCallbackProcPtr )(SInt32 optionSelectorNum, UInt32 command, Boolean *optionSetting);
typedef STACK_UPP_TYPE(DebugComponentCallbackProcPtr) DebugComponentCallbackUPP;
/*
* NewDebugComponent()
*
* Summary:
* NewDebugComponent registers a component with DebugLib.
*
* Mac OS X threading:
* Not thread safe
*
* Parameters:
*
* componentSignature:
* The unique signature of component.
*
* componentName:
* The displayable string naming the component.
*
* componentCallback:
* The callback into component for working with options.
*
* Result:
* An operating system result code: noErr, memFullErr,
* debuggingExecutionContextErr, debuggingDuplicateSignatureErr, or
* debuggingInvalidNameErr.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in DebugLib 1.0 and later
*/
extern OSStatus
NewDebugComponent(
OSType componentSignature,
ConstStr255Param componentName,
DebugComponentCallbackUPP componentCallback) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* NewDebugOption()
*
* Summary:
* NewDebugOption registers a debug option with DebugLib.
*
* Mac OS X threading:
* Not thread safe
*
* Parameters:
*
* componentSignature:
* The signature of component to register a debug option for.
*
* optionSelectorNum:
* The selector number of this debug option.
*
* optionName:
* The displayable string naming this debug option.
*
* Result:
* An operating system result code: noErr, memFullErr,
* debuggingExecutionContextErr, debuggingDuplicateOptionErr,
* debuggingInvalidSignatureErr, debuggingInvalidNameErr, or
* debuggingNoCallbackErr.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in DebugLib 1.0 and later
*/
extern OSStatus
NewDebugOption(
OSType componentSignature,
SInt32 optionSelectorNum,
ConstStr255Param optionName) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* DisposeDebugComponent()
*
* Summary:
* DisposeDebugComponent removes a component registration and all
* related debug options from DebugLib.
*
* Mac OS X threading:
* Not thread safe
*
* Parameters:
*
* componentSignature:
* The unique signature of a component.
*
* Result:
* An operating system result code: noErr,
* debuggingExecutionContextErr, or debuggingInvalidSignatureErr.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in DebugLib 1.0 and later
*/
extern OSStatus
DisposeDebugComponent(OSType componentSignature) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* GetDebugComponentInfo()
*
* Summary:
* GetDebugComponentInfo returns a component registered with
* DebugLib.
*
* Mac OS X threading:
* Not thread safe
*
* Parameters:
*
* itemIndex:
* The index into the list of registered components (1-based).
*
* componentSignature:
* A pointer to an OSType where the unique signature of a
* component is returned.
*
* componentName:
* A pointer to an Str255 where the displayable string naming a
* component is returned.
*
* Result:
* An operating system result code: noErr or debuggingNoMatchErr.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in DebugLib 1.0 and later
*/
extern OSStatus
GetDebugComponentInfo(
UInt32 itemIndex,
OSType * componentSignature,
Str255 componentName) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* GetDebugOptionInfo()
*
* Summary:
* GetDebugOptionInfo returns a debug option registered with
* DebugLib.
*
* Mac OS X threading:
* Not thread safe
*
* Parameters:
*
* itemIndex:
* The index into the list of registered debug options (0-based);
* 0 = kComponentDebugOption.
*
* componentSignature:
* The unique signature of a component.
*
* optionSelectorNum:
* A pointer to an SInt32 where the selector number of this debug
* option is returned.
*
* optionName:
* A pointer to an Str255 where the displayable string naming this
* debug option is returned.
*
* optionSetting:
* A pointer to an Boolean where the current debug option setting
* is returned.
*
* Result:
* An operating system result code: noErr,
* debuggingInvalidSignatureErr, or debuggingNoMatchErr.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in DebugLib 1.0 and later
*/
extern OSStatus
GetDebugOptionInfo(
UInt32 itemIndex,
OSType componentSignature,
SInt32 * optionSelectorNum,
Str255 optionName,
Boolean * optionSetting) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* SetDebugOptionValue()
*
* Summary:
* SetDebugOptionValue sets a debug option registered with DebugLib.
*
* Mac OS X threading:
* Not thread safe
*
* Parameters:
*
* componentSignature:
* The unique signature of a component.
*
* optionSelectorNum:
* The selector number of this debug option.
*
* newOptionSetting:
* The new debug option setting.
*
* Result:
* An operating system result code: noErr,
* debuggingInvalidSignatureErr, or debuggingInvalidOptionErr.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in DebugLib 1.0 and later
*/
extern OSStatus
SetDebugOptionValue(
OSType componentSignature,
SInt32 optionSelectorNum,
Boolean newOptionSetting) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* DebugAssertOutputHandlerProcPtr
*
* Discussion:
* DebugAssertOutputHandler is the callback that registers with
* DebugLib to handle the output from DebugAssert. The
* "componentSignature" through "value" parameters are the raw
* values passed to DebugAssert when an exception occurs.
*
* Parameters:
*
* componentSignature:
* The unique signature of component causing the assertion.
*
* options:
* reserved.
*
* assertionString:
* A pointer to a string containing the assertion, or NULL.
*
* exceptionLabelString:
* A pointer to a string containing the exceptionLabel, or NULL.
*
* errorString:
* A pointer to the error string, or NULL.
*
* fileName:
* A pointer to the fileName or pathname (generated by the
* preprocessor __FILE__ identifier), or NULL.
*
* lineNumber:
* The line number in the file (generated by the preprocessor
* __LINE__ identifier), or 0 (zero).
*
* value:
* A value associated with the assertion, or NULL.
*
* outputMsg:
* The string DebugAssert build which would normally be passed to
* DebugStr if a DebugAssertOutputHandler isn't installed.
*/
typedef CALLBACK_API( void , DebugAssertOutputHandlerProcPtr )(OSType componentSignature, UInt32 options, const char *assertionString, const char *exceptionLabelString, const char *errorString, const char *fileName, long lineNumber, void *value, ConstStr255Param outputMsg);
typedef STACK_UPP_TYPE(DebugAssertOutputHandlerProcPtr) DebugAssertOutputHandlerUPP;
/*
* InstallDebugAssertOutputHandler()
*
* Summary:
* InstallDebugAssertOutputHandler installs a
* DebugAssertOutputHandler which DebugAssert calls instead of
* DebugStr.
*
* Parameters:
*
* handler:
* The DebugAssertOutputHandler to install or NULL to switch back
* to the default handler (DebugStr).
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in DebugLib 1.0 and later
*/
extern void
InstallDebugAssertOutputHandler(DebugAssertOutputHandlerUPP handler) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* dprintf()
*
* Summary:
* printf takes a variable argument list and 'prints' that to the
* debugging output handler. Calling dprintf() from anything but C
* or C++ is tricky.
*
* Parameters:
*
* format:
* The format string.
*
* ...:
* The arguments to the format string.
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in DebugLib 1.1 and later
*/
/*
* vdprintf()
*
* Summary:
* vdprintf takes a va_args list and 'prints' that to the debugging
* output handler.
*
* Parameters:
*
* format:
* The format string.
*
* va_args_list:
* The va_args list.
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in DebugLib 1.1 and later
*/
/*
* GetMacOSStatusErrorString()
*
* Summary:
* Returns a const char* string which corresponds to the textual
* constant for the given OSStatus code.
*
* Discussion:
* This function returns a text string which corresponds to the
* given OSStatus code, based on the errors in MacErrors.h. For
* example, GetMacOSStatusErrorString( -43 ) returns "fnfErr", which
* is the text representation for the error constant -43. This
* function is useful if you want to get or print out ( for
* debugging purposes only ) a useful description for a given
* OSStatus error. If no string is available for the given
* constant, then the empty string "" is returned. Some error values
* have multiple meanings; in those cases the multiple meanings are
* all returned seperated by '/'es.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* err:
* The OSStatus to return a text string for.
*
* Result:
* A const char* string corresponding to the given OSStatus
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern const char *
GetMacOSStatusErrorString(OSStatus err) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_4, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* GetMacOSStatusCommentString()
*
* Summary:
* Returns a const char* string which corresponds to the descriptive
* string for the given OSStatus code.
*
* Discussion:
* This function returns a text string which corresponds to a
* comment for the given OSStatus code, based on the errors in
* MacErrors.h. For example, GetMacOSStatusConstantString( -43 )
* returns "File not found", which is the text representation for
* the error constant -43. This function is useful if you want to
* get or print out ( for debugging purposes only ) a useful
* description for a given OSStatus error. If no string is
* available for the given constant, then the empty string "" is
* returned. If no string is available for the given constant, then
* the empty string "" is returned. Some error values have multiple
* meanings; in those cases the multiple meanings are all returned
* seperated by '/'es.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* err:
* The OSStatus to return a text string for.
*
* Result:
* A const char* string corresponding to the given OSStatus
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern const char *
GetMacOSStatusCommentString(OSStatus err) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_4, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* NewDebugComponentCallbackUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern DebugComponentCallbackUPP
NewDebugComponentCallbackUPP(DebugComponentCallbackProcPtr userRoutine) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* NewDebugAssertOutputHandlerUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern DebugAssertOutputHandlerUPP
NewDebugAssertOutputHandlerUPP(DebugAssertOutputHandlerProcPtr userRoutine) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* DisposeDebugComponentCallbackUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
DisposeDebugComponentCallbackUPP(DebugComponentCallbackUPP userUPP) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* DisposeDebugAssertOutputHandlerUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
DisposeDebugAssertOutputHandlerUPP(DebugAssertOutputHandlerUPP userUPP) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* InvokeDebugComponentCallbackUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
InvokeDebugComponentCallbackUPP(
SInt32 optionSelectorNum,
UInt32 command,
Boolean * optionSetting,
DebugComponentCallbackUPP userUPP) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* InvokeDebugAssertOutputHandlerUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
InvokeDebugAssertOutputHandlerUPP(
OSType componentSignature,
UInt32 options,
const char * assertionString,
const char * exceptionLabelString,
const char * errorString,
const char * fileName,
long lineNumber,
void * value,
ConstStr255Param outputMsg,
DebugAssertOutputHandlerUPP userUPP) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
#if __MACH__
#ifdef __cplusplus
inline DebugComponentCallbackUPP NewDebugComponentCallbackUPP(DebugComponentCallbackProcPtr userRoutine) { return userRoutine; }
inline DebugAssertOutputHandlerUPP NewDebugAssertOutputHandlerUPP(DebugAssertOutputHandlerProcPtr userRoutine) { return userRoutine; }
inline void DisposeDebugComponentCallbackUPP(DebugComponentCallbackUPP) { }
inline void DisposeDebugAssertOutputHandlerUPP(DebugAssertOutputHandlerUPP) { }
inline void InvokeDebugComponentCallbackUPP(SInt32 optionSelectorNum, UInt32 command, Boolean * optionSetting, DebugComponentCallbackUPP userUPP) { (*userUPP)(optionSelectorNum, command, optionSetting); }
inline void InvokeDebugAssertOutputHandlerUPP(OSType componentSignature, UInt32 options, const char * assertionString, const char * exceptionLabelString, const char * errorString, const char * fileName, long lineNumber, void * value, ConstStr255Param outputMsg, DebugAssertOutputHandlerUPP userUPP) { (*userUPP)(componentSignature, options, assertionString, exceptionLabelString, errorString, fileName, lineNumber, value, outputMsg); }
#else
#define NewDebugComponentCallbackUPP(userRoutine) ((DebugComponentCallbackUPP)userRoutine)
#define NewDebugAssertOutputHandlerUPP(userRoutine) ((DebugAssertOutputHandlerUPP)userRoutine)
#define DisposeDebugComponentCallbackUPP(userUPP)
#define DisposeDebugAssertOutputHandlerUPP(userUPP)
#define InvokeDebugComponentCallbackUPP(optionSelectorNum, command, optionSetting, userUPP) (*userUPP)(optionSelectorNum, command, optionSetting)
#define InvokeDebugAssertOutputHandlerUPP(componentSignature, options, assertionString, exceptionLabelString, errorString, fileName, lineNumber, value, outputMsg, userUPP) (*userUPP)(componentSignature, options, assertionString, exceptionLabelString, errorString, fileName, lineNumber, value, outputMsg)
#endif
#endif
#ifdef __cplusplus
}
#endif
#endif /* __DEBUGGING__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework/Headers/TextCommon.h | /*
File: CarbonCore/TextCommon.h
Contains: TextEncoding-related types and constants, and prototypes for related functions
Copyright: © 1995-2020 Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __TEXTCOMMON__
#define __TEXTCOMMON__
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
#pragma pack(push, 2)
/*
* Generic Text Alignment Constants
*
* Summary:
* These constants are implemented to supplant the old TextEdit
* Manager constants ( teFlushDefault, teCenter teFlushRight,
* teFlushLeft ) These constants are used outside the context of the
* legacy TextEdit Manager Framework. Use these as you would use the
* old TextEdit.h constants to specify how text should be justified
* (word aligned.) The new constants use the same values as the the
* old TextEdit ones, for backwards compatibility.
*/
enum {
/*
* Flush according to the line direction
*/
kTextFlushDefault = 0,
/*
* Center justify (word alignment)
*/
kTextCenter = 1,
/*
* Flush right
*/
kTextFlushRight = -1,
/*
* Flush left
*/
kTextFlushLeft = -2
};
/* TextEncodingBase type & values */
/* (values 0-32 correspond to the Script Codes defined in Inside Macintosh: Text pages 6-52 and 6-53 */
typedef UInt32 TextEncodingBase;
enum {
/* Mac OS encodings*/
kTextEncodingMacRoman = 0,
kTextEncodingMacJapanese = 1,
kTextEncodingMacChineseTrad = 2,
kTextEncodingMacKorean = 3,
kTextEncodingMacArabic = 4,
kTextEncodingMacHebrew = 5,
kTextEncodingMacGreek = 6,
kTextEncodingMacCyrillic = 7,
kTextEncodingMacDevanagari = 9,
kTextEncodingMacGurmukhi = 10,
kTextEncodingMacGujarati = 11,
kTextEncodingMacOriya = 12,
kTextEncodingMacBengali = 13,
kTextEncodingMacTamil = 14,
kTextEncodingMacTelugu = 15,
kTextEncodingMacKannada = 16,
kTextEncodingMacMalayalam = 17,
kTextEncodingMacSinhalese = 18,
kTextEncodingMacBurmese = 19,
kTextEncodingMacKhmer = 20,
kTextEncodingMacThai = 21,
kTextEncodingMacLaotian = 22,
kTextEncodingMacGeorgian = 23,
kTextEncodingMacArmenian = 24,
kTextEncodingMacChineseSimp = 25,
kTextEncodingMacTibetan = 26,
kTextEncodingMacMongolian = 27,
kTextEncodingMacEthiopic = 28,
kTextEncodingMacCentralEurRoman = 29,
kTextEncodingMacVietnamese = 30,
kTextEncodingMacExtArabic = 31, /* The following use script code 0, smRoman*/
kTextEncodingMacSymbol = 33,
kTextEncodingMacDingbats = 34,
kTextEncodingMacTurkish = 35,
kTextEncodingMacCroatian = 36,
kTextEncodingMacIcelandic = 37,
kTextEncodingMacRomanian = 38,
kTextEncodingMacCeltic = 39,
kTextEncodingMacGaelic = 40,
kTextEncodingMacKeyboardGlyphs = 41
};
/* The following are older names for backward compatibility*/
enum {
kTextEncodingMacTradChinese = kTextEncodingMacChineseTrad,
kTextEncodingMacRSymbol = 8,
kTextEncodingMacSimpChinese = kTextEncodingMacChineseSimp,
kTextEncodingMacGeez = kTextEncodingMacEthiopic,
kTextEncodingMacEastEurRoman = kTextEncodingMacCentralEurRoman,
kTextEncodingMacUninterp = 32
};
/*
Beginning in Mac OS 8.5, the following meta-value is used to indicate Unicode in some parts
of the Mac OS which previously only expected a Mac OS script code. In some of these places,
only 7 bits are available to indicate encoding (script code), so kTextEncodingUnicodeDefault
cannot be used. For example, kTextEncodingMacUnicode can be used to indicate Unicode in the
7-bit script code field of a Unicode input method's ComponentDescription.componentFlags field;
it can also be used to indicate Unicode in the 16-bit script code field of an AppleEvent's
typeIntlWritingCode text tag.
*/
enum {
kTextEncodingMacUnicode = 0x7E /* Meta-value, Unicode as a Mac encoding*/
};
/* Variant Mac OS encodings that use script codes other than 0*/
enum {
/* The following use script code 4, smArabic*/
kTextEncodingMacFarsi = 0x8C, /* Like MacArabic but uses Farsi digits*/
/* The following use script code 7, smCyrillic*/
kTextEncodingMacUkrainian = 0x98, /* Meta-value in TEC 1.5 & later; maps to kTextEncodingMacCyrillic variant */
/* The following use script code 28, smEthiopic*/
kTextEncodingMacInuit = 0xEC, /* The following use script code 32, smUnimplemented*/
kTextEncodingMacVT100 = 0xFC /* VT100/102 font from Comm Toolbox: Latin-1 repertoire + box drawing etc*/
};
/* Special Mac OS encodings*/
enum {
kTextEncodingMacHFS = 0xFF /* Meta-value, should never appear in a table.*/
};
/* Unicode & ISO UCS encodings begin at 0x100*/
enum {
kTextEncodingUnicodeDefault = 0x0100, /* Meta-value, should never appear in a table.*/
kTextEncodingUnicodeV1_1 = 0x0101,
kTextEncodingISO10646_1993 = 0x0101, /* Code points identical to Unicode 1.1*/
kTextEncodingUnicodeV2_0 = 0x0103, /* New location for Korean Hangul*/
kTextEncodingUnicodeV2_1 = 0x0103, /* We treat both Unicode 2.0 and Unicode 2.1 as 2.1*/
kTextEncodingUnicodeV3_0 = 0x0104,
kTextEncodingUnicodeV3_1 = 0x0105, /* Adds characters requiring surrogate pairs in UTF-16*/
kTextEncodingUnicodeV3_2 = 0x0106,
kTextEncodingUnicodeV4_0 = 0x0108,
kTextEncodingUnicodeV5_0 = 0x010A,
kTextEncodingUnicodeV5_1 = 0x010B, /* No constant for Unicode 5.2, but leave an opening.*/
kTextEncodingUnicodeV6_0 = 0x010D, /* Adds many symbols, including emoji support.*/
kTextEncodingUnicodeV6_1 = 0x010E, /* Adds emoji variation sequences, properties changes.*/
kTextEncodingUnicodeV6_3 = 0x0110, /* Adds new bidi controls.*/
kTextEncodingUnicodeV7_0 = 0x0111, /* Adds RUBLE SIGN, symbols from Wingdings/Webdings.*/
kTextEncodingUnicodeV8_0 = 0x0112, /* Adds LARI SIGN, lowercase Cherokee, emoji modifiers, CJK Ext E, 6 scripts.*/
kTextEncodingUnicodeV9_0 = 0x0113, /* Adds Tangut and 5 other scripts, 72 emoji.*/
kTextEncodingUnicodeV10_0 = 0x0114, /* Adds CJK Ext F, Hentaigana, 4 scripts, Bitcoin sign, 56 emoji...*/
kTextEncodingUnicodeV11_0 = 0x0115, /* Adds Georgian Mtavruli capitals, 7 scripts, Copyleft, 66 emoji...*/
kTextEncodingUnicodeV12_1 = 0x0116, /* Adds 4 new scripts, more letters for 5, Marca reg., 61 emoji...*/
kTextEncodingUnicodeV13_0 = 0x0117 /* Adds 4 new scripts, more letters for 3, CJK Ext G, 55 emoji...*/
};
/* ISO 8-bit and 7-bit encodings begin at 0x200*/
enum {
kTextEncodingISOLatin1 = 0x0201, /* ISO 8859-1, Western European*/
kTextEncodingISOLatin2 = 0x0202, /* ISO 8859-2, Central European*/
kTextEncodingISOLatin3 = 0x0203, /* ISO 8859-3, South European (Maltese...)*/
kTextEncodingISOLatin4 = 0x0204, /* ISO 8859-4, North European & some Baltic*/
kTextEncodingISOLatinCyrillic = 0x0205, /* ISO 8859-5*/
kTextEncodingISOLatinArabic = 0x0206, /* ISO 8859-6, = ASMO 708, =DOS CP 708*/
kTextEncodingISOLatinGreek = 0x0207, /* ISO 8859-7*/
kTextEncodingISOLatinHebrew = 0x0208, /* ISO 8859-8*/
kTextEncodingISOLatin5 = 0x0209, /* ISO 8859-9, Turkish*/
kTextEncodingISOLatin6 = 0x020A, /* ISO 8859-10, Nordic */
kTextEncodingISOLatin7 = 0x020D, /* ISO 8859-13, Baltic Rim */
kTextEncodingISOLatin8 = 0x020E, /* ISO 8859-14, Celtic */
kTextEncodingISOLatin9 = 0x020F, /* ISO 8859-15, 8859-1 changed for EURO & CP1252 letters */
kTextEncodingISOLatin10 = 0x0210 /* ISO 8859-16, Romanian*/
};
/* MS-DOS & Windows encodings begin at 0x400*/
enum {
kTextEncodingDOSLatinUS = 0x0400, /* code page 437*/
kTextEncodingDOSGreek = 0x0405, /* code page 737 (formerly code page 437G)*/
kTextEncodingDOSBalticRim = 0x0406, /* code page 775*/
kTextEncodingDOSLatin1 = 0x0410, /* code page 850, "Multilingual"*/
kTextEncodingDOSGreek1 = 0x0411, /* code page 851*/
kTextEncodingDOSLatin2 = 0x0412, /* code page 852, Slavic*/
kTextEncodingDOSCyrillic = 0x0413, /* code page 855, IBM Cyrillic*/
kTextEncodingDOSTurkish = 0x0414, /* code page 857, IBM Turkish*/
kTextEncodingDOSPortuguese = 0x0415, /* code page 860*/
kTextEncodingDOSIcelandic = 0x0416, /* code page 861*/
kTextEncodingDOSHebrew = 0x0417, /* code page 862*/
kTextEncodingDOSCanadianFrench = 0x0418, /* code page 863*/
kTextEncodingDOSArabic = 0x0419, /* code page 864*/
kTextEncodingDOSNordic = 0x041A, /* code page 865*/
kTextEncodingDOSRussian = 0x041B, /* code page 866*/
kTextEncodingDOSGreek2 = 0x041C, /* code page 869, IBM Modern Greek*/
kTextEncodingDOSThai = 0x041D, /* code page 874, also for Windows*/
kTextEncodingDOSJapanese = 0x0420, /* code page 932, also for Windows; Shift-JIS with additions*/
kTextEncodingDOSChineseSimplif = 0x0421, /* code page 936, also for Windows; was EUC-CN, now GBK (EUC-CN extended)*/
kTextEncodingDOSKorean = 0x0422, /* code page 949, also for Windows; Unified Hangul Code (EUC-KR extended)*/
kTextEncodingDOSChineseTrad = 0x0423, /* code page 950, also for Windows; Big-5*/
kTextEncodingWindowsLatin1 = 0x0500, /* code page 1252*/
kTextEncodingWindowsANSI = 0x0500, /* code page 1252 (alternate name)*/
kTextEncodingWindowsLatin2 = 0x0501, /* code page 1250, Central Europe*/
kTextEncodingWindowsCyrillic = 0x0502, /* code page 1251, Slavic Cyrillic*/
kTextEncodingWindowsGreek = 0x0503, /* code page 1253*/
kTextEncodingWindowsLatin5 = 0x0504, /* code page 1254, Turkish*/
kTextEncodingWindowsHebrew = 0x0505, /* code page 1255*/
kTextEncodingWindowsArabic = 0x0506, /* code page 1256*/
kTextEncodingWindowsBalticRim = 0x0507, /* code page 1257*/
kTextEncodingWindowsVietnamese = 0x0508, /* code page 1258*/
kTextEncodingWindowsKoreanJohab = 0x0510 /* code page 1361, for Windows NT*/
};
/* Various national standards begin at 0x600*/
enum {
kTextEncodingUS_ASCII = 0x0600,
kTextEncodingANSEL = 0x0601, /* ANSEL (ANSI Z39.47) for library use*/
kTextEncodingJIS_X0201_76 = 0x0620, /* JIS Roman and 1-byte katakana (halfwidth)*/
kTextEncodingJIS_X0208_83 = 0x0621,
kTextEncodingJIS_X0208_90 = 0x0622,
kTextEncodingJIS_X0212_90 = 0x0623,
kTextEncodingJIS_C6226_78 = 0x0624,
kTextEncodingShiftJIS_X0213 = 0x0628, /* Shift-JIS format encoding of JIS X0213 planes 1 and 2*/
kTextEncodingJIS_X0213_MenKuTen = 0x0629, /* JIS X0213 in plane-row-column notation (3 bytes)*/
kTextEncodingGB_2312_80 = 0x0630,
kTextEncodingGBK_95 = 0x0631, /* annex to GB 13000-93; for Windows 95; EUC-CN extended*/
kTextEncodingGB_18030_2000 = 0x0632, /* This is actually implemented as GB_18030_2005*/
kTextEncodingGB_18030_2005 = 0x0632,
kTextEncodingKSC_5601_87 = 0x0640, /* same as KSC 5601-92 without Johab annex*/
kTextEncodingKSC_5601_92_Johab = 0x0641, /* KSC 5601-92 Johab annex*/
kTextEncodingCNS_11643_92_P1 = 0x0651, /* CNS 11643-1992 plane 1*/
kTextEncodingCNS_11643_92_P2 = 0x0652, /* CNS 11643-1992 plane 2*/
kTextEncodingCNS_11643_92_P3 = 0x0653 /* CNS 11643-1992 plane 3 (was plane 14 in 1986 version)*/
};
/* ISO 2022 collections begin at 0x800*/
enum {
kTextEncodingISO_2022_JP = 0x0820, /* RFC 1468*/
kTextEncodingISO_2022_JP_2 = 0x0821, /* RFC 1554*/
kTextEncodingISO_2022_JP_1 = 0x0822, /* RFC 2237*/
kTextEncodingISO_2022_JP_3 = 0x0823, /* JIS X0213*/
kTextEncodingISO_2022_CN = 0x0830, /* RFC 1922*/
kTextEncodingISO_2022_CN_EXT = 0x0831, /* RFC 1922*/
kTextEncodingISO_2022_KR = 0x0840 /* RFC 1557*/
};
/* EUC collections begin at 0x900*/
enum {
kTextEncodingEUC_JP = 0x0920, /* ISO 646, 1-byte katakana, JIS 208, JIS 212*/
kTextEncodingEUC_CN = 0x0930, /* ISO 646, GB 2312-80*/
kTextEncodingEUC_TW = 0x0931, /* ISO 646, CNS 11643-1992 Planes 1-16*/
kTextEncodingEUC_KR = 0x0940 /* RFC 1557: ISO 646, KS C 5601-1987*/
};
/* Misc standards begin at 0xA00*/
enum {
kTextEncodingShiftJIS = 0x0A01, /* plain Shift-JIS*/
kTextEncodingKOI8_R = 0x0A02, /* RFC 1489, Russian internet standard*/
kTextEncodingBig5 = 0x0A03, /* Big-5 (has variants)*/
kTextEncodingMacRomanLatin1 = 0x0A04, /* Mac OS Roman permuted to align with ISO Latin-1*/
kTextEncodingHZ_GB_2312 = 0x0A05, /* HZ (RFC 1842, for Chinese mail & news)*/
kTextEncodingBig5_HKSCS_1999 = 0x0A06, /* Big-5 with Hong Kong special char set supplement*/
kTextEncodingVISCII = 0x0A07, /* RFC 1456, Vietnamese*/
kTextEncodingKOI8_U = 0x0A08, /* RFC 2319, Ukrainian*/
kTextEncodingBig5_E = 0x0A09 /* Taiwan Big-5E standard*/
};
/* Other platform encodings*/
enum {
kTextEncodingNextStepLatin = 0x0B01, /* NextStep Latin encoding*/
kTextEncodingNextStepJapanese = 0x0B02 /* NextStep Japanese encoding (variant of EUC-JP)*/
};
/* EBCDIC & IBM host encodings begin at 0xC00*/
enum {
kTextEncodingEBCDIC_LatinCore = 0x0C01, /* Common base subset of EBCDIC Latin encodings*/
kTextEncodingEBCDIC_CP037 = 0x0C02 /* code page 037, extended EBCDIC (Latin-1 set) for US,Canada...*/
};
/* Special values*/
enum {
kTextEncodingMultiRun = 0x0FFF, /* Multi-encoding text with external run info*/
kTextEncodingUnknown = 0xFFFF /* Unknown or unspecified */
};
/* The following are older names for backward compatibility*/
enum {
kTextEncodingEBCDIC_US = 0x0C01
};
/* TextEncodingVariant type & values */
typedef UInt32 TextEncodingVariant;
/* Default TextEncodingVariant, for any TextEncodingBase*/
enum {
kTextEncodingDefaultVariant = 0
};
/* Variants of kTextEncodingMacRoman */
enum {
kMacRomanDefaultVariant = 0, /* meta value, maps to 1 or 2 depending on System */
kMacRomanCurrencySignVariant = 1, /* Mac OS version < 8.5, 0xDB is CURRENCY SIGN*/
kMacRomanEuroSignVariant = 2 /* Mac OS version >= 8.5, 0xDB is EURO SIGN */
};
/* Variants of kTextEncodingMacCyrillic (for TEC 1.5 and later) */
enum {
kMacCyrillicDefaultVariant = 0, /* meta value, maps to 1, 2, or 3 depending on System*/
kMacCyrillicCurrSignStdVariant = 1, /* Mac OS < 9.0 (RU,BG), 0xFF = CURRENCY SIGN, 0xA2/0xB6 = CENT / PARTIAL DIFF.*/
kMacCyrillicCurrSignUkrVariant = 2, /* Mac OS < 9.0 (UA,LangKit), 0xFF = CURRENCY SIGN, 0xA2/0xB6 = GHE WITH UPTURN*/
kMacCyrillicEuroSignVariant = 3 /* Mac OS >= 9.0, 0xFF is EURO SIGN, 0xA2/0xB6 = GHE WITH UPTURN*/
};
/* Variants of kTextEncodingMacIcelandic */
enum {
kMacIcelandicStdDefaultVariant = 0, /* meta value, maps to 2 or 4 depending on System */
kMacIcelandicTTDefaultVariant = 1, /* meta value, maps to 3 or 5 depending on System */
/* The following are for Mac OS version < 8.5, 0xDB is CURRENCY SIGN */
kMacIcelandicStdCurrSignVariant = 2, /* 0xBB/0xBC are fem./masc. ordinal indicators*/
kMacIcelandicTTCurrSignVariant = 3, /* 0xBB/0xBC are fi/fl ligatures*/
/* The following are for Mac OS version >= 8.5, 0xDB is EURO SIGN */
kMacIcelandicStdEuroSignVariant = 4, /* 0xBB/0xBC are fem./masc. ordinal indicators*/
kMacIcelandicTTEuroSignVariant = 5 /* 0xBB/0xBC are fi/fl ligatures*/
};
/* Variants of kTextEncodingMacCroatian */
enum {
kMacCroatianDefaultVariant = 0, /* meta value, maps to 1 or 2 depending on System */
kMacCroatianCurrencySignVariant = 1, /* Mac OS version < 8.5, 0xDB is CURRENCY SIGN */
kMacCroatianEuroSignVariant = 2 /* Mac OS version >= 8.5, 0xDB is EURO SIGN */
};
/* Variants of kTextEncodingMacRomanian */
enum {
kMacRomanianDefaultVariant = 0, /* meta value, maps to 1 or 2 depending on System */
kMacRomanianCurrencySignVariant = 1, /* Mac OS version < 8.5, 0xDB is CURRENCY SIGN */
kMacRomanianEuroSignVariant = 2 /* Mac OS version >= 8.5, 0xDB is EURO SIGN */
};
/* Variants of kTextEncodingMacJapanese*/
enum {
kMacJapaneseStandardVariant = 0,
kMacJapaneseStdNoVerticalsVariant = 1,
kMacJapaneseBasicVariant = 2,
kMacJapanesePostScriptScrnVariant = 3,
kMacJapanesePostScriptPrintVariant = 4,
kMacJapaneseVertAtKuPlusTenVariant = 5
};
/* Variants of kTextEncodingMacArabic*/
enum {
kMacArabicStandardVariant = 0, /* 0xC0 is 8-spoke asterisk, 0x2A & 0xAA are asterisk (e.g. Cairo)*/
kMacArabicTrueTypeVariant = 1, /* 0xC0 is asterisk, 0x2A & 0xAA are multiply signs (e.g. Baghdad)*/
kMacArabicThuluthVariant = 2, /* 0xC0 is Arabic five-point star, 0x2A & 0xAA are multiply signs*/
kMacArabicAlBayanVariant = 3 /* 8-spoke asterisk, multiply sign, Koranic ligatures & parens*/
};
/* Variants of kTextEncodingMacFarsi*/
enum {
kMacFarsiStandardVariant = 0, /* 0xC0 is 8-spoke asterisk, 0x2A & 0xAA are asterisk (e.g. Tehran)*/
kMacFarsiTrueTypeVariant = 1 /* asterisk, multiply signs, Koranic ligatures, geometric shapes*/
};
/* Variants of kTextEncodingMacHebrew*/
enum {
kMacHebrewStandardVariant = 0,
kMacHebrewFigureSpaceVariant = 1
};
/* Variants of kTextEncodingMacGreek*/
enum {
kMacGreekDefaultVariant = 0, /* meta value, maps to 1 or 2 depending on System*/
kMacGreekNoEuroSignVariant = 1, /* Mac OS version < 9.2.2, 0x9C is SOFT HYPHEN, 0xFF is undefined*/
kMacGreekEuroSignVariant = 2 /* Mac OS version >= 9.2.2, 0x9C is EURO SIGN, 0xFF is SOFT HYPHEN*/
};
/* Variants of kTextEncodingMacVT100 */
enum {
kMacVT100DefaultVariant = 0, /* meta value, maps to 1 or 2 depending on System */
kMacVT100CurrencySignVariant = 1, /* Mac OS version < 8.5, 0xDB is CURRENCY SIGN */
kMacVT100EuroSignVariant = 2 /* Mac OS version >= 8.5, 0xDB is EURO SIGN */
};
/* Variants of Unicode & ISO 10646 encodings*/
enum {
kUnicodeNoSubset = 0,
kUnicodeNormalizationFormD = 5, /* canonical decomposition (NFD); excludes composed chars*/
kUnicodeNormalizationFormC = 3, /* canonical composition (NFC); uses the composed chars as of Unicode 3.1*/
kUnicodeHFSPlusDecompVariant = 8, /* decomposition for HFS+; doesn't decompose in 2000-2FFF, F900-FAFF, 2F800-2FAFF*/
kUnicodeHFSPlusCompVariant = 9 /* composition based on HFS+ decomposition*/
};
/* Variants of kTextEncodingISOLatin1*/
enum {
kISOLatin1StandardVariant = 0,
kISOLatin1MusicCDVariant = 1
};
/*
Variants of kTextEncodingISOLatinArabic, kTextEncodingISOLatinHebrew.
Per RFC 1556 and ECMA TR/53, there are three ways of handling bidirectional text
in the ISO character sets 8859-6 (Arabic) and 8859-8 (Hebrew).
1. Implicit or Logical order is "a presentation method in which the direction is
determined by an algorithm according to the type of characters and their position
relative to the adjacent characters and according to their primary direction." This
is the method normally used for Unicode and for the Mac OS and Windows Arabic and
Hebrew encodings.
2. Visual order assumes the text is already ordered such that it can be displayed
in a left-to-right display direction with no further directional processing. This
is equivalent to treating all characters as having strong left-right directionality.
This is the default assumed for internet Hebrew text encoded in ISO 8859-8, unless
the charset label suffix specifically indicates implicit (-i) or explicit (-e)
ordering.
3. Explicit order is "a presentation method in which the direction is explicitly
defined by using control sequences which are interleaved within the text and are
used for direction determination."
*/
enum {
kISOLatinArabicImplicitOrderVariant = 0,
kISOLatinArabicVisualOrderVariant = 1,
kISOLatinArabicExplicitOrderVariant = 2
};
enum {
kISOLatinHebrewImplicitOrderVariant = 0,
kISOLatinHebrewVisualOrderVariant = 1,
kISOLatinHebrewExplicitOrderVariant = 2
};
/* Variants of kTextEncodingWindowsLatin1*/
enum {
kWindowsLatin1StandardVariant = 0,
kWindowsLatin1PalmVariant = 1 /* PalmSource variant of cp1252*/
};
/* Variants of kTextEncodingDOSJapanese*/
enum {
kDOSJapaneseStandardVariant = 0,
kDOSJapanesePalmVariant = 1 /* PalmSource variant of cp932*/
};
/*
Variants of EUC_CN
The DOSVariant is like kTextEncodingDOSChineseSimplif, but with the
basic EUC_CN part mapped as per kTextEncodingEUC_CN.
*/
enum {
kEUC_CN_BasicVariant = 0,
kEUC_CN_DOSVariant = 1
};
/*
Variants of EUC_KR
The DOSVariant is like kTextEncodingDOSKorean, but with the
basic EUC_KR part mapped as per kTextEncodingEUC_KR.
*/
enum {
kEUC_KR_BasicVariant = 0,
kEUC_KR_DOSVariant = 1
};
/*
Variants of ShiftJIS
The DOSVariant is like kTextEncodingDOSJapanese, but with the
basic ShiftJIS part mapped as per kTextEncodingShiftJIS.
*/
enum {
kShiftJIS_BasicVariant = 0,
kShiftJIS_DOSVariant = 1,
kShiftJIS_MusicCDVariant = 2 /* MusicShiftJIS, per RIS-506 (RIAJ)*/
};
/*
Variants of Big-5 encoding
The DOSVariant is like kTextEncodingDOSChineseTrad, but with the
basic Big5 part mapped as per kTextEncodingBig5.
*/
enum {
kBig5_BasicVariant = 0,
kBig5_StandardVariant = 1, /* 0xC6A1-0xC7FC: kana, Cyrillic, enclosed numerics*/
kBig5_ETenVariant = 2, /* adds kana, Cyrillic, radicals, etc with hi bytes C6-C8,F9*/
kBig5_DOSVariant = 3
};
/* Variants of MacRomanLatin1 */
enum {
kMacRomanLatin1DefaultVariant = 0, /* meta value, maps to others depending on System*/
kMacRomanLatin1StandardVariant = 2, /* permuted MacRoman, EuroSignVariant*/
kMacRomanLatin1TurkishVariant = 6, /* permuted MacTurkish*/
kMacRomanLatin1CroatianVariant = 8, /* permuted MacCroatian, EuroSignVariant*/
kMacRomanLatin1IcelandicVariant = 11, /* permuted MacIcelandic, StdEuroSignVariant*/
kMacRomanLatin1RomanianVariant = 14 /* permuted MacRomanian, EuroSignVariant*/
};
/* Unicode variants not yet supported (and not fully defined)*/
enum {
kUnicodeNoCompatibilityVariant = 1,
kUnicodeNoCorporateVariant = 4
};
/* The following are older names for backward compatibility*/
enum {
kMacRomanStandardVariant = 0,
kMacIcelandicStandardVariant = 0,
kMacIcelandicTrueTypeVariant = 1,
kJapaneseStandardVariant = 0,
kJapaneseStdNoVerticalsVariant = 1,
kJapaneseBasicVariant = 2,
kJapanesePostScriptScrnVariant = 3,
kJapanesePostScriptPrintVariant = 4,
kJapaneseVertAtKuPlusTenVariant = 5,
kTextEncodingShiftJIS_X0213_00 = 0x0628, /* Shift-JIS format encoding of JIS X0213 planes 1 and 2*/
/* kJapaneseStdNoOneByteKanaVariant = 6, // replaced by kJapaneseNoOneByteKanaOption*/
/* kJapaneseBasicNoOneByteKanaVariant = 7, // replaced by kJapaneseNoOneByteKanaOption */
kHebrewStandardVariant = 0,
kHebrewFigureSpaceVariant = 1, /* Old Unicode variants. Variant 2 (kUnicodeCanonicalDecompVariant, kUnicodeMaxDecomposedVariant) is ambiguous and means*/
/* different things in different contexts. When normalizing (using ConvertFromUnicodeToText to convert from arbitrary*/
/* Unicode to a normalized form), Unicode variant 2 means the same thing as kUnicodeNormalizationFormD (i.e. NFD).*/
/* However, when converting between Unicode and traditional Mac OS encodings, Unicode variant 2 means the same thing as*/
/* kUnicodeHFSPlusDecompVariant (i.e. the special HFS decomposition which excludes some character ranges from normalization).*/
/* For clarity, please use the less ambiguous constants: kUnicodeNormalizationFormD = 5, kUnicodeHFSPlusDecompVariant = 8.*/
/* */
kUnicodeCanonicalDecompVariant = 2, /* use kUnicodeNormalizationFormD or kUnicodeHFSPlusDecompVariant*/
kUnicodeMaxDecomposedVariant = 2, /* use kUnicodeNormalizationFormD or kUnicodeHFSPlusDecompVariant*/
kUnicodeCanonicalCompVariant = 3, /* replaced by kUnicodeNormalizationFormC*/
kUnicodeNoComposedVariant = 3 /* this really meant NoComposing; replaced by kUnicodeNormalizationFormC*/
};
/* TextEncodingFormat type & values */
typedef UInt32 TextEncodingFormat;
enum {
/* Default TextEncodingFormat for any TextEncodingBase*/
kTextEncodingDefaultFormat = 0, /* Formats for Unicode & ISO 10646*/
kUnicodeUTF16Format = 0, /* UTF16 form (16-bit units), native or external byte order (see below)*/
kUnicodeUTF7Format = 1, /* UTF7 form*/
kUnicodeUTF8Format = 2, /* UTF8 form*/
kUnicodeUTF32Format = 3, /* UTF32 form (32-bit units), native or external byte order (see below)*/
kUnicodeUTF16BEFormat = 4, /* UTF16 form, explicit big-endian byte order, no BOM*/
kUnicodeUTF16LEFormat = 5, /* UTF16 form, explicit little-endian byte order, no BOM*/
kUnicodeUTF32BEFormat = 6, /* UTF32 form, explicit big-endian byte order, no BOM*/
kUnicodeUTF32LEFormat = 7, /* UTF32 form, explicit little-endian byte order, no BOM*/
kUnicodeSCSUFormat = 8, /* Std. Compression Scheme for Unicode, Unicode Tech Std. #6*/
/* Note for kUnicodeUTF16Format and kUnicodeUTF32Format:*/
/* - An array of UTF16Char (UniChar) or UTF32Char is normally understood to use "internal" or*/
/* platform-native byte ordering for kUnicodeUTF16Format and kUnicodeUTF32Format; the array MAY*/
/* begin with byte-order mark (BOM), but the BOM should match the internal ordering.*/
/* - If an array of bytes (such as char *) that can be in various encodings is specified to be*/
/* in Unicode with kUnicodeUTF16Format or kUnicodeUTF32Format (not explicitly BE or LE), then it*/
/* is assumed to use "external" byte ordering, which means: If there is a BOM at the beginning*/
/* of text, the BOM specifies the byte ordering, otherwise big-endian is assumed.*/
/* Synonyms for some Unicode formats*/
kUnicode16BitFormat = 0,
kUnicode32BitFormat = 3
};
/* TextEncoding type */
typedef UInt32 TextEncoding;
/* name part selector for GetTextEncodingName*/
typedef UInt32 TextEncodingNameSelector;
enum {
kTextEncodingFullName = 0,
kTextEncodingBaseName = 1,
kTextEncodingVariantName = 2,
kTextEncodingFormatName = 3
};
/* Types used in conversion */
struct TextEncodingRun {
ByteOffset offset;
TextEncoding textEncoding;
};
typedef struct TextEncodingRun TextEncodingRun;
typedef TextEncodingRun * TextEncodingRunPtr;
typedef const TextEncodingRun * ConstTextEncodingRunPtr;
struct ScriptCodeRun {
ByteOffset offset;
ScriptCode script;
};
typedef struct ScriptCodeRun ScriptCodeRun;
typedef ScriptCodeRun * ScriptCodeRunPtr;
typedef const ScriptCodeRun * ConstScriptCodeRunPtr;
typedef UInt8 * TextPtr;
typedef const UInt8 * ConstTextPtr;
/* Basic types for Unicode characters and strings:*/
typedef UniChar * UniCharArrayPtr;
typedef const UniChar * ConstUniCharArrayPtr;
/*
UniCharArrayHandle is a handle type to correspond to UniCharArrayPtr,
i.e. a handle to an array of UniChars (UInt16s).
*/
typedef UniCharArrayPtr * UniCharArrayHandle;
/*
UniCharArrayOffset is used to indicate an edge offset in an array
of UniChars (UInt16s).
*/
typedef unsigned long UniCharArrayOffset;
/* enums for TextEncoding Conversion routines*/
enum {
kTextScriptDontCare = -128,
kTextLanguageDontCare = -128,
kTextRegionDontCare = -128
};
/* struct for TECGetInfo*/
struct TECInfo {
UInt16 format; /* format code for this struct*/
UInt16 tecVersion; /* TEC version in BCD, e.g. 0x0121 for 1.2.1*/
UInt32 tecTextConverterFeatures; /* bitmask indicating TEC features/fixes*/
UInt32 tecUnicodeConverterFeatures; /* bitmask indicating UnicodeConverter features/fixes*/
UInt32 tecTextCommonFeatures; /* bitmask indicating TextCommon features/fixes*/
Str31 tecTextEncodingsFolderName; /* localized name of Text Encodings folder (pascal string)*/
Str31 tecExtensionFileName; /* localized name of TEC extension (pascal string)*/
UInt16 tecLowestTEFileVersion; /* Lowest version (BCD) of all files in Text Encodings folder*/
UInt16 tecHighestTEFileVersion; /* Highest version (BCD) of all files in Text Encodings folder*/
};
typedef struct TECInfo TECInfo;
typedef TECInfo * TECInfoPtr;
typedef TECInfoPtr * TECInfoHandle;
/* Value for TECInfo format code*/
enum {
kTECInfoCurrentFormat = 2 /* any future formats will just add fields at the end*/
};
/*
Defined feature/fix bits for tecUnicodeConverterFeatures field
Bit: Meaning if set:
---- ---------------
kTECKeepInfoFixBit Unicode Converter no longer ignores other control flags if
kUnicodeKeepInfoBit is set. Bug fix in TEC Manager 1.2.1.
kTECFallbackTextLengthFixBit Unicode Converter honors the *srcConvLen and *destConvLen
returned by caller-supplied fallback handler for any status it
returns except for kTECUnmappableElementErr (previously it only
honored these values if noErr was returned). Bug fix in TEC
Manager 1.2.1.
kTECTextRunBitClearFixBit ConvertFromUnicodeToTextRun & ConvertFromUnicodeToScriptCodeRun
function correctly if the kUnicodeTextRunBit is set (previously
their determination of best target encoding was incorrect). Bug
fix in TEC Manager 1.3.
kTECTextToUnicodeScanFixBit ConvertFromTextToUnicode uses an improved scanner and maintains
some resulting state information, which it uses for mapping.
This has several effects:
- Improved mapping of 0x30-0x39 digits in Mac OS Arabic, fewer
direction overrides when mapping Mac OS Arabic & Hebrew, and
improved mapping of certain characters in Indic encodings.
- Malformed input produces kTextMalformedInputErr.
- ConvertFromTextToUnicode accepts and uses the control flags
kUnicodeKeepInfoMask and kUnicodeStringUnterminatedMask.
Bug fix and enhancement in TEC Manager 1.3.
kTECAddForceASCIIChangesBit Define new control flag bits kUnicodeForceASCIIRangeBit and
kUnicodeNoHalfwidthCharsBit for use with
ConvertFromTextToUnicode, ConvertFromUnicodeToText, etc.
Enhancement in TEC Manager 1.4.
kTECPreferredEncodingFixBit CreateUnicodeToTextRunInfo and related functions fix a problem
that occurred when a preferred encoding was specified that did
not match the System script; the preferred script was not
actually placed first in the ordered list of encodings to use.
Bug fix in TEC Manager 1.4.
kTECAddTextRunHeuristicsBit Define new control flag bit kUnicodeTextRunHeuristicsBit for
use with ConvertFromUnicodeToTextRun.
kTECAddFallbackInterruptBit Define new option kUnicodeFallbackInterruptSafeMask for use
with SetFallbackUnicodeToText. If a client fallback handler is
installed without specifying this bit, ConvertFromUnicodeToText
will HLock the tables it uses (in case the fallback handler
moves memory); otherwise, it won't.
*/
enum {
kTECKeepInfoFixBit = 0,
kTECFallbackTextLengthFixBit = 1,
kTECTextRunBitClearFixBit = 2,
kTECTextToUnicodeScanFixBit = 3,
kTECAddForceASCIIChangesBit = 4,
kTECPreferredEncodingFixBit = 5,
kTECAddTextRunHeuristicsBit = 6,
kTECAddFallbackInterruptBit = 7
};
enum {
kTECKeepInfoFixMask = 1L << kTECKeepInfoFixBit,
kTECFallbackTextLengthFixMask = 1L << kTECFallbackTextLengthFixBit,
kTECTextRunBitClearFixMask = 1L << kTECTextRunBitClearFixBit,
kTECTextToUnicodeScanFixMask = 1L << kTECTextToUnicodeScanFixBit,
kTECAddForceASCIIChangesMask = 1L << kTECAddForceASCIIChangesBit,
kTECPreferredEncodingFixMask = 1L << kTECPreferredEncodingFixBit,
kTECAddTextRunHeuristicsMask = 1L << kTECAddTextRunHeuristicsBit,
kTECAddFallbackInterruptMask = 1L << kTECAddFallbackInterruptBit
};
/*
-------------------------------------------------------------------------------------------------
CONSTANTS for common and special Unicode code values
-------------------------------------------------------------------------------------------------
*/
enum {
kUnicodeByteOrderMark = 0xFEFF,
kUnicodeObjectReplacement = 0xFFFC, /* placeholder for non-text object*/
kUnicodeReplacementChar = 0xFFFD, /* Unicode replacement for unconvertable input char*/
kUnicodeSwappedByteOrderMark = 0xFFFE, /* not a Unicode char; byte-swapped version of FEFF*/
kUnicodeNotAChar = 0xFFFF /* not a Unicode char; may be used as a terminator*/
};
/*
-------------------------------------------------------------------------------------------------
CONSTANTS & DATA STRUCTURES for Unicode Properties
-------------------------------------------------------------------------------------------------
*/
typedef SInt32 UCCharPropertyType;
enum {
kUCCharPropTypeGenlCategory = 1, /* requests enumeration value*/
kUCCharPropTypeCombiningClass = 2, /* requests numeric value 0..255*/
kUCCharPropTypeBidiCategory = 3, /* requests enumeration value*/
kUCCharPropTypeDecimalDigitValue = 4 /* requests numeric value 0..9 for decimal digit chars (get err for others)*/
};
typedef UInt32 UCCharPropertyValue;
/* General Category enumeration values (requested by kUCCharPropTypeGenlCategory)*/
enum {
/* Normative categories:*/
kUCGenlCatOtherNotAssigned = 0, /* Cn Other, Not Assigned*/
kUCGenlCatOtherControl = 1, /* Cc Other, Control*/
kUCGenlCatOtherFormat = 2, /* Cf Other, Format*/
kUCGenlCatOtherSurrogate = 3, /* Cs Other, Surrogate*/
kUCGenlCatOtherPrivateUse = 4, /* Co Other, Private Use*/
kUCGenlCatMarkNonSpacing = 5, /* Mn Mark, Non-Spacing*/
kUCGenlCatMarkSpacingCombining = 6, /* Mc Mark, Spacing Combining*/
kUCGenlCatMarkEnclosing = 7, /* Me Mark, Enclosing*/
kUCGenlCatNumberDecimalDigit = 8, /* Nd Number, Decimal Digit*/
kUCGenlCatNumberLetter = 9, /* Nl Number, Letter*/
kUCGenlCatNumberOther = 10, /* No Number, Other*/
kUCGenlCatSeparatorSpace = 11, /* Zs Separator, Space*/
kUCGenlCatSeparatorLine = 12, /* Zl Separator, Line*/
kUCGenlCatSeparatorParagraph = 13, /* Zp Separator, Paragraph*/
kUCGenlCatLetterUppercase = 14, /* Lu Letter, Uppercase*/
kUCGenlCatLetterLowercase = 15, /* Ll Letter, Lowercase*/
kUCGenlCatLetterTitlecase = 16, /* Lt Letter, Titlecase*/
/* Informative categories:*/
kUCGenlCatLetterModifier = 17, /* Lm Letter, Modifier*/
kUCGenlCatLetterOther = 18, /* Lo Letter, Other*/
kUCGenlCatPunctConnector = 20, /* Pc Punctuation, Connector*/
kUCGenlCatPunctDash = 21, /* Pd Punctuation, Dash*/
kUCGenlCatPunctOpen = 22, /* Ps Punctuation, Open*/
kUCGenlCatPunctClose = 23, /* Pe Punctuation, Close*/
kUCGenlCatPunctInitialQuote = 24, /* Pi Punctuation, Initial quote*/
kUCGenlCatPunctFinalQuote = 25, /* Pf Punctuation, Final quote*/
kUCGenlCatPunctOther = 26, /* Po Punctuation, Other*/
kUCGenlCatSymbolMath = 28, /* Sm Symbol, Math*/
kUCGenlCatSymbolCurrency = 29, /* Sc Symbol, Currency*/
kUCGenlCatSymbolModifier = 30, /* Sk Symbol, Modifier*/
kUCGenlCatSymbolOther = 31 /* So Symbol, Other*/
};
/* Bidirectional Category enumeration values (requested by kUCCharPropTypeBidiCategory)*/
enum {
kUCBidiCatNotApplicable = 0, /* for now use this for unassigned*/
/* Strong types:*/
kUCBidiCatLeftRight = 1, /* L Left-to-Right*/
kUCBidiCatRightLeft = 2, /* R Right-to-Left*/
/* Weak types:*/
kUCBidiCatEuroNumber = 3, /* EN European Number*/
kUCBidiCatEuroNumberSeparator = 4, /* ES European Number Separator*/
kUCBidiCatEuroNumberTerminator = 5, /* ET European Number Terminator*/
kUCBidiCatArabicNumber = 6, /* AN Arabic Number*/
kUCBidiCatCommonNumberSeparator = 7, /* CS Common Number Separator*/
/* Separators:*/
kUCBidiCatBlockSeparator = 8, /* B Paragraph Separator (was Block Separator)*/
kUCBidiCatSegmentSeparator = 9, /* S Segment Separator*/
/* Neutrals:*/
kUCBidiCatWhitespace = 10, /* WS Whitespace*/
kUCBidiCatOtherNeutral = 11, /* ON Other Neutrals (unassigned codes could use this)*/
/* New categories for Unicode 3.0*/
kUCBidiCatRightLeftArabic = 12, /* AL Right-to-Left Arabic (was Arabic Letter)*/
kUCBidiCatLeftRightEmbedding = 13, /* LRE Left-to-Right Embedding*/
kUCBidiCatRightLeftEmbedding = 14, /* RLE Right-to-Left Embedding*/
kUCBidiCatLeftRightOverride = 15, /* LRO Left-to-Right Override*/
kUCBidiCatRightLeftOverride = 16, /* RLO Right-to-Left Override*/
kUCBidiCatPopDirectionalFormat = 17, /* PDF Pop Directional Format*/
kUCBidiCatNonSpacingMark = 18, /* NSM Non-Spacing Mark*/
kUCBidiCatBoundaryNeutral = 19, /* BN Boundary Neutral*/
/* New categories for Unicode 6.3*/
kUCBidiCatLeftRightIsolate = 20, /* LRI Left-to-Right Isolate*/
kUCBidiCatRightLeftIsolate = 21, /* RLI Right-to-Left Isolate*/
kUCBidiCatFirstStrongIsolate = 22, /* FSI First Strong Isolate*/
kUCBidiCatPopDirectionalIsolate = 23 /* PDI Pop Directional Isolate*/
};
/*
-------------------------------------------------------------------------------------------------
Prototypes for TextEncoding functions
-------------------------------------------------------------------------------------------------
*/
/*
* CreateTextEncoding()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in TextCommon 1.1 and later
*/
extern TextEncoding
CreateTextEncoding(
TextEncodingBase encodingBase,
TextEncodingVariant encodingVariant,
TextEncodingFormat encodingFormat) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/*
* GetTextEncodingBase()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in TextCommon 1.1 and later
*/
extern TextEncodingBase
GetTextEncodingBase(TextEncoding encoding) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/*
* GetTextEncodingVariant()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in TextCommon 1.1 and later
*/
extern TextEncodingVariant
GetTextEncodingVariant(TextEncoding encoding) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/*
* GetTextEncodingFormat()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in TextCommon 1.1 and later
*/
extern TextEncodingFormat
GetTextEncodingFormat(TextEncoding encoding) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/*
* ResolveDefaultTextEncoding()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in TextCommon 1.1 and later
*/
extern TextEncoding
ResolveDefaultTextEncoding(TextEncoding encoding) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/*
* GetTextEncodingName()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in TextCommon 1.1 and later
*/
extern OSStatus
GetTextEncodingName(
TextEncoding iEncoding,
TextEncodingNameSelector iNamePartSelector,
RegionCode iPreferredRegion,
TextEncoding iPreferredEncoding,
ByteCount iOutputBufLen,
ByteCount * oNameLength,
RegionCode * oActualRegion, /* can be NULL */
TextEncoding * oActualEncoding, /* can be NULL */
TextPtr oEncodingName) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/*
* TECGetInfo()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in TextCommon 1.2.1 and later
*/
extern OSStatus
TECGetInfo(TECInfoHandle * tecInfo) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/*
* UpgradeScriptInfoToTextEncoding()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in TextCommon 1.1 and later
*/
extern OSStatus
UpgradeScriptInfoToTextEncoding(
ScriptCode iTextScriptID,
LangCode iTextLanguageID,
RegionCode iRegionID,
ConstStr255Param iTextFontname,
TextEncoding * oEncoding) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/*
* RevertTextEncodingToScriptInfo()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in TextCommon 1.1 and later
*/
extern OSStatus
RevertTextEncodingToScriptInfo(
TextEncoding iEncoding,
ScriptCode * oTextScriptID,
LangCode * oTextLanguageID, /* can be NULL */
Str255 oTextFontname) /* can be NULL */ __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/*
* GetTextEncodingFromScriptInfo()
*
* Summary:
* Converts any combination of a Mac OS script code, a language
* code, and a region code to a text encoding.
*
* Discussion:
* This function is almost identical to
* UpgradeScriptInfoToTextEncoding except it doesn't take a font
* name and it is available in CoreServices.
*
* Parameters:
*
* iTextScriptID:
* A valid Script Manager script code. The Mac OS Script Manager
* defines constants for script codes using this format: smXxx. To
* designate the system script, specify the meta-value of
* smSystemScript. To indicate that you do not want to provide a
* script code for this parameter, specify the constant
* kTextScriptDontCare.
*
* iTextLanguageID:
* A valid Script Manager language code. The Mac OS Script Manager
* defines constants for language codes using this format:
* langXxx. To indicate that you do not want to provide a language
* code for this parameter, specify the constant
* kTextLanguageDontCare.
*
* iTextRegionID:
* A valid Script Manager region code. The Mac OS Script Manager
* defines constants for region codes using this format: verXxx.
* To indicate that you do not want to provide a region code for
* this parameter, specify the constant kTextRegionDontCare.
*
* oEncoding:
* A pointer to a value of type TextEncoding. On return, this
* value holds the text encoding specification that the function
* created from the other values you provided.
*
* Availability:
* Mac OS X: in version 10.2 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x, is available on Mac OS X version 10.2 and later
* Non-Carbon CFM: not available
*/
extern OSStatus
GetTextEncodingFromScriptInfo(
ScriptCode iTextScriptID,
LangCode iTextLanguageID,
RegionCode iTextRegionID,
TextEncoding * oEncoding) __OSX_AVAILABLE_STARTING(__MAC_10_2, __IPHONE_NA);
/*
* GetScriptInfoFromTextEncoding()
*
* Summary:
* Converts the given Mac OS text encoding specification to the
* corresponding script code and, if possible, language code.
*
* Discussion:
* This function is almost identical to
* RevertTextEncodingToScriptInfo except it doesn't return a font
* name and it is available in CoreServices.
*
* Parameters:
*
* iEncoding:
* The text encoding specification to be converted.
*
* oTextScriptID:
* A pointer to a value of type ScriptCode. On return, a Mac OS
* script code that corresponds to the text encoding specification
* you identified in the iEncoding parameter. If you do not pass a
* pointer for this parameter, the function returns a paramErr
* result code.
*
* oTextLanguageID:
* A pointer to a value of type LangCode. On input, if you do not
* want the function to return the language code, specify NULL as
* the value of this parameter. On return, the appropriate
* language code, if the language can be unambiguously derived
* from the text encoding specification, for example, Japanese,
* and you did not set the parameter to NULL. If you do not
* specify NULL on input and the language is ambiguous—that is,
* the function cannot accurately derive it from the text encoding
* specification—the function returns a value of
* kTextLanguageDontCare.
*
* Availability:
* Mac OS X: in version 10.2 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x, is available on Mac OS X version 10.2 and later
* Non-Carbon CFM: not available
*/
extern OSStatus
GetScriptInfoFromTextEncoding(
TextEncoding iEncoding,
ScriptCode * oTextScriptID,
LangCode * oTextLanguageID) /* can be NULL */ __OSX_AVAILABLE_STARTING(__MAC_10_2, __IPHONE_NA);
/*
* NearestMacTextEncodings()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in TextCommon 1.5 and later
*/
extern OSStatus
NearestMacTextEncodings(
TextEncoding generalEncoding,
TextEncoding * bestMacEncoding,
TextEncoding * alternateMacEncoding) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/*
* UCGetCharProperty()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in TextCommon 1.5 and later
*/
extern OSStatus
UCGetCharProperty(
const UniChar * charPtr,
UniCharCount textLength,
UCCharPropertyType propType,
UCCharPropertyValue * propValue) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/*
-------------------------------------------------------------------------------------------------
Surrogate pair utilities
-------------------------------------------------------------------------------------------------
*/
#if !defined(UC_INLINE)
#if defined(__GNUC__)
#define UC_INLINE static __inline__
#elif defined(__MWERKS__) || defined(__cplusplus)
#define UC_INLINE static inline
#endif
#endif
// surrogate ranges
enum {
kUCHighSurrogateRangeStart = 0xD800,
kUCHighSurrogateRangeEnd = 0xDBFF,
kUCLowSurrogateRangeStart = 0xDC00,
kUCLowSurrogateRangeEnd = 0xDFFF
};
/*!
@function UCIsSurrogateHighCharacter
Reports whether or not the character is a high surrogate.
@param character The character to be checked.
@result true, if character is a high surrogate, otherwise false.
*/
UC_INLINE Boolean UCIsSurrogateHighCharacter( UniChar character ) {
/* return ( ( character >= kUCHighSurrogateRangeStart ) && (character <= kUCHighSurrogateRangeEnd ) ? true : false ); */
return ( ( character & 0xFC00 ) == kUCHighSurrogateRangeStart );
}
/*!
@function UCIsSurrogateLowCharacter
Reports whether or not the character is a low surrogate.
@param character The character to be checked.
@result true, if character is a low surrogate, otherwise false.
*/
UC_INLINE Boolean UCIsSurrogateLowCharacter( UniChar character ) {
/* return ( ( character >= kUCLowSurrogateRangeStart ) && ( character <= kUCLowSurrogateRangeEnd ) ? true : false ); */
return ( ( character & 0xFC00 ) == kUCLowSurrogateRangeStart );
}
/*!
@function UCGetUnicodeScalarValueForSurrogatePair
Returns the UTF-32 value corresponding to the surrogate pair passed in.
@param surrogateHigh The high surrogate character. If this parameter
is not a valid high surrogate character, the behavior is undefined.
@param surrogateLow The low surrogate character. If this parameter
is not a valid low surrogate character, the behavior is undefined.
@result The UTF-32 value for the surrogate pair.
*/
UC_INLINE UnicodeScalarValue UCGetUnicodeScalarValueForSurrogatePair( UniChar surrogateHigh, UniChar surrogateLow ) {
return ( (UnicodeScalarValue)( surrogateHigh - kUCHighSurrogateRangeStart ) << 10 ) + ( surrogateLow - kUCLowSurrogateRangeStart ) + 0x0010000;
}
#pragma pack(pop)
#ifdef __cplusplus
}
#endif
#endif /* __TEXTCOMMON__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework/Headers/UTCUtils.h | /*
File: CarbonCore/UTCUtils.h
Contains: Interface for UTC to Local Time conversion and 64 Bit Clock routines
Copyright: © 1999-2011 by Apple Inc., all rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __UTCUTILS__
#define __UTCUTILS__
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
#ifndef __MACERRORS__
#include <CarbonCore/MacErrors.h>
#endif
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
#pragma pack(push, 2)
/* Options for Set & Get DateTime Routines */
enum {
kUTCDefaultOptions = 0
};
/* 64 Bit Clock Typedefs */
struct UTCDateTime {
UInt16 highSeconds;
UInt32 lowSeconds;
UInt16 fraction;
};
typedef struct UTCDateTime UTCDateTime;
typedef UTCDateTime * UTCDateTimePtr;
typedef UTCDateTimePtr * UTCDateTimeHandle;
struct LocalDateTime {
UInt16 highSeconds;
UInt32 lowSeconds;
UInt16 fraction;
};
typedef struct LocalDateTime LocalDateTime;
typedef LocalDateTime * LocalDateTimePtr;
typedef LocalDateTimePtr * LocalDateTimeHandle;
/* Classic 32 bit clock conversion routines */
#if !__LP64__
/*
* ConvertLocalTimeToUTC() *** DEPRECATED ***
*
* Deprecated:
* use
* UCConvertUTCDateTimeToCFAbsoluteTime/CFTimeZoneGetSecondsFromGMT
* instead.
*
* Discussion:
* This function is no longer recommended. Please use
* UCConvertUTCDateTimeToCFAbsoluteTime and
* CFTimeZoneGetSecondsFromGMT instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0.2 and later
* Non-Carbon CFM: in UTCUtils 1.0 and later
*/
extern OSStatus
ConvertLocalTimeToUTC(
UInt32 localSeconds,
UInt32 * utcSeconds) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* ConvertUTCToLocalTime() *** DEPRECATED ***
*
* Deprecated:
* use
* UCConvertUTCDateTimeToCFAbsoluteTime/CFTimeZoneGetSecondsFromGMT
* instead.
*
* Discussion:
* This function is no longer recommended. Please use
* UCConvertUTCDateTimeToCFAbsoluteTime and
* CFTimeZoneGetSecondsFromGMT instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0.2 and later
* Non-Carbon CFM: in UTCUtils 1.0 and later
*/
extern OSStatus
ConvertUTCToLocalTime(
UInt32 utcSeconds,
UInt32 * localSeconds) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/* 64 bit clock conversion routines */
/*
* ConvertUTCToLocalDateTime() *** DEPRECATED ***
*
* Deprecated:
* use
* UCConvertUTCDateTimeToCFAbsoluteTime/CFTimeZoneGetSecondsFromGMT
* instead.
*
* Discussion:
* This function is no longer recommended. Please use
* UCConvertUTCDateTimeToCFAbsoluteTime and
* CFTimeZoneGetSecondsFromGMT instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0.2 and later
* Non-Carbon CFM: in UTCUtils 1.0 and later
*/
extern OSStatus
ConvertUTCToLocalDateTime(
const UTCDateTime * utcDateTime,
LocalDateTime * localDateTime) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* ConvertLocalToUTCDateTime() *** DEPRECATED ***
*
* Deprecated:
* use
* UCConvertUTCDateTimeToCFAbsoluteTime/CFTimeZoneGetSecondsFromGMT
* instead.
*
* Discussion:
* This function is no longer recommended. Please use
* UCConvertUTCDateTimeToCFAbsoluteTime and
* CFTimeZoneGetSecondsFromGMT instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0.2 and later
* Non-Carbon CFM: in UTCUtils 1.0 and later
*/
extern OSStatus
ConvertLocalToUTCDateTime(
const LocalDateTime * localDateTime,
UTCDateTime * utcDateTime) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/* Getter and Setter Clock routines using 64 Bit values */
/*
* GetUTCDateTime() *** DEPRECATED ***
*
* Deprecated:
* use CFAbsoluteTimeGetCurrent instead.
*
* Discussion:
* This function is no longer recommended. Please use
* CFAbsoluteTimeGetCurrent instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0.2 and later
* Non-Carbon CFM: in UTCUtils 1.0 and later
*/
extern OSStatus
GetUTCDateTime(
UTCDateTime * utcDateTime,
OptionBits options) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* SetUTCDateTime() *** DEPRECATED ***
*
* Deprecated:
* use settimeofday (2) instead.
*
* Discussion:
* This function is no longer recommended. Setting the time requires
* root privileges. If you must, use settimeofday (2)
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0.2 and later
* Non-Carbon CFM: in UTCUtils 1.0 and later
*/
extern OSStatus
SetUTCDateTime(
const UTCDateTime * utcDateTime,
OptionBits options) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* GetLocalDateTime() *** DEPRECATED ***
*
* Deprecated:
* use CFAbsoluteTimeGetCurrent/CFTimeZoneGetSecondsFromGMT instead.
*
* Discussion:
* This function is no longer recommended. Please use
* CFAbsoluteTimeGetCurrent and CFTimeZoneGetSecondsFromGMT instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0.2 and later
* Non-Carbon CFM: in UTCUtils 1.0 and later
*/
extern OSStatus
GetLocalDateTime(
LocalDateTime * localDateTime,
OptionBits options) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* SetLocalDateTime() *** DEPRECATED ***
*
* Deprecated:
* it without replacement
*
* Discussion:
* This function is no longer recommended. There is no replacement.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0.2 and later
* Non-Carbon CFM: in UTCUtils 1.0 and later
*/
extern OSStatus
SetLocalDateTime(
const LocalDateTime * localDateTime,
OptionBits options) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
#endif /* !__LP64__ */
#pragma pack(pop)
#ifdef __cplusplus
}
#endif
#endif /* __UTCUTILS__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework/Headers/MachineExceptions.h | /*
File: CarbonCore/MachineExceptions.h
Contains: Processor Exception Handling Interfaces.
The contents of this header file are deprecated.
Copyright: © 1993-2011 by Apple Inc. All rights reserved.
*/
#ifndef __MACHINEEXCEPTIONS__
#define __MACHINEEXCEPTIONS__
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
#ifndef __MIXEDMODE__
#include <CarbonCore/MixedMode.h>
#endif
#if TARGET_CPU_X86 || TARGET_CPU_X86_64
#include <emmintrin.h>
#endif
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
#pragma options align=power
/* Some basic declarations used throughout the kernel */
typedef struct OpaqueAreaID* AreaID;
/* Machine Dependent types for PowerPC: */
/* Because a number of sources do a #define CR 13 and this file contains a struct member named CR,
* an obscure compilation error gets spit out. Rename the field to CRRegister. To build old code
* which has the name CR in it, either update the code to use CRRegister or do a
* #define __MACHINEEXCEPTIONS_USE_OLD_CR_FIELD_NAME__ 1
* before #including <CoreServices/CoreServices.h> */
#if __MACHINEEXCEPTIONS_USE_OLD_CR_FIELD_NAME__
#define CRRegister CR
#endif
struct MachineInformationPowerPC {
UnsignedWide CTR;
UnsignedWide LR;
UnsignedWide PC;
unsigned long CRRegister; /* changed from CR since some folks had a #define CR 13 in their source code*/
unsigned long XER;
unsigned long MSR;
unsigned long MQ;
unsigned long ExceptKind;
unsigned long DSISR;
UnsignedWide DAR;
UnsignedWide Reserved;
};
typedef struct MachineInformationPowerPC MachineInformationPowerPC;
struct RegisterInformationPowerPC {
UnsignedWide R0;
UnsignedWide R1;
UnsignedWide R2;
UnsignedWide R3;
UnsignedWide R4;
UnsignedWide R5;
UnsignedWide R6;
UnsignedWide R7;
UnsignedWide R8;
UnsignedWide R9;
UnsignedWide R10;
UnsignedWide R11;
UnsignedWide R12;
UnsignedWide R13;
UnsignedWide R14;
UnsignedWide R15;
UnsignedWide R16;
UnsignedWide R17;
UnsignedWide R18;
UnsignedWide R19;
UnsignedWide R20;
UnsignedWide R21;
UnsignedWide R22;
UnsignedWide R23;
UnsignedWide R24;
UnsignedWide R25;
UnsignedWide R26;
UnsignedWide R27;
UnsignedWide R28;
UnsignedWide R29;
UnsignedWide R30;
UnsignedWide R31;
};
typedef struct RegisterInformationPowerPC RegisterInformationPowerPC;
struct FPUInformationPowerPC {
UnsignedWide Registers[32];
unsigned long FPSCR;
unsigned long Reserved;
};
typedef struct FPUInformationPowerPC FPUInformationPowerPC;
union Vector128 {
#ifdef __APPLE_ALTIVEC__
vector unsigned int v;
#endif
unsigned long l[4];
unsigned short s[8];
unsigned char c[16];
};
typedef union Vector128 Vector128;
struct VectorInformationPowerPC {
Vector128 Registers[32];
Vector128 VSCR;
UInt32 VRsave;
};
typedef struct VectorInformationPowerPC VectorInformationPowerPC;
/* Exception related declarations */
enum {
kWriteReference = 0,
kReadReference = 1,
kFetchReference = 2,
writeReference = kWriteReference, /* Obsolete name*/
readReference = kReadReference, /* Obsolete name*/
fetchReference = kFetchReference /* Obsolete name*/
};
typedef unsigned long MemoryReferenceKind;
struct MemoryExceptionInformation {
AreaID theArea; /* The area related to the execption, same as MPAreaID.*/
LogicalAddress theAddress; /* The 32-bit address of the exception.*/
OSStatus theError; /* See enum below.*/
MemoryReferenceKind theReference; /* read, write, instruction fetch.*/
};
typedef struct MemoryExceptionInformation MemoryExceptionInformation;
enum {
kUnknownException = 0,
kIllegalInstructionException = 1,
kTrapException = 2,
kAccessException = 3,
kUnmappedMemoryException = 4,
kExcludedMemoryException = 5,
kReadOnlyMemoryException = 6,
kUnresolvablePageFaultException = 7,
kPrivilegeViolationException = 8,
kTraceException = 9,
kInstructionBreakpointException = 10, /* Optional*/
kDataBreakpointException = 11, /* Optional*/
kIntegerException = 12,
kFloatingPointException = 13,
kStackOverflowException = 14, /* Optional, may be implemented as kAccessException on some systems.*/
kTaskTerminationException = 15, /* Obsolete*/
kTaskCreationException = 16, /* Obsolete*/
kDataAlignmentException = 17 /* May occur when a task is in little endian mode or created with kMPTaskTakesAllExceptions.*/
};
#if OLDROUTINENAMES
enum {
unknownException = kUnknownException, /* Obsolete name*/
illegalInstructionException = kIllegalInstructionException, /* Obsolete name*/
trapException = kTrapException, /* Obsolete name*/
accessException = kAccessException, /* Obsolete name*/
unmappedMemoryException = kUnmappedMemoryException, /* Obsolete name*/
excludedMemoryException = kExcludedMemoryException, /* Obsolete name*/
readOnlyMemoryException = kReadOnlyMemoryException, /* Obsolete name*/
unresolvablePageFaultException = kUnresolvablePageFaultException, /* Obsolete name*/
privilegeViolationException = kPrivilegeViolationException, /* Obsolete name*/
traceException = kTraceException, /* Obsolete name*/
instructionBreakpointException = kInstructionBreakpointException, /* Obsolete name*/
dataBreakpointException = kDataBreakpointException, /* Obsolete name*/
integerException = kIntegerException, /* Obsolete name*/
floatingPointException = kFloatingPointException, /* Obsolete name*/
stackOverflowException = kStackOverflowException, /* Obsolete name*/
terminationException = kTaskTerminationException, /* Obsolete name*/
kTerminationException = kTaskTerminationException /* Obsolete name*/
};
#endif /* OLDROUTINENAMES */
typedef unsigned long ExceptionKind;
union ExceptionInfo {
MemoryExceptionInformation * memoryInfo;
};
typedef union ExceptionInfo ExceptionInfo;
struct ExceptionInformationPowerPC {
ExceptionKind theKind;
MachineInformationPowerPC * machineState;
RegisterInformationPowerPC * registerImage;
FPUInformationPowerPC * FPUImage;
ExceptionInfo info;
VectorInformationPowerPC * vectorImage;
};
typedef struct ExceptionInformationPowerPC ExceptionInformationPowerPC;
#if TARGET_CPU_PPC || TARGET_CPU_PPC64
typedef ExceptionInformationPowerPC ExceptionInformation;
typedef MachineInformationPowerPC MachineInformation;
typedef RegisterInformationPowerPC RegisterInformation;
typedef FPUInformationPowerPC FPUInformation;
typedef VectorInformationPowerPC VectorInformation;
#endif /* TARGET_CPU_PPC || TARGET_CPU_PPC64 */
#if TARGET_CPU_X86 || TARGET_CPU_X86_64
union Vector128Intel {
__m128 s;
__m128i si;
__m128d sd;
unsigned char c[16];
};
typedef union Vector128Intel Vector128Intel;
#endif /* TARGET_CPU_X86 || TARGET_CPU_X86_64 */
#if TARGET_CPU_X86
struct MachineInformationIntel {
unsigned long CS;
unsigned long DS;
unsigned long SS;
unsigned long ES;
unsigned long FS;
unsigned long GS;
unsigned long EFLAGS;
unsigned long EIP;
unsigned long ExceptTrap;
unsigned long ExceptErr;
unsigned long ExceptAddr;
};
typedef struct MachineInformationIntel MachineInformationIntel;
struct RegisterInformationIntel {
unsigned long EAX;
unsigned long EBX;
unsigned long ECX;
unsigned long EDX;
unsigned long ESI;
unsigned long EDI;
unsigned long EBP;
unsigned long ESP;
};
typedef struct RegisterInformationIntel RegisterInformationIntel;
typedef unsigned char FPRegIntel[10];
/* Because Xlib.h does a #define Status int, this struct fails to compile if Xlib.h is #include before CarbonCore.h
So, hack around it for them. */
struct FPUInformationIntel {
FPRegIntel Registers[8];
unsigned short Control;
#ifdef Status
unsigned short StatusReg;
#else
unsigned short Status;
#endif
unsigned short Tag;
unsigned short Opcode;
unsigned int EIP;
unsigned int DP;
unsigned int DS;
};
typedef struct FPUInformationIntel FPUInformationIntel;
struct VectorInformationIntel {
Vector128Intel Registers[8];
};
typedef struct VectorInformationIntel VectorInformationIntel;
typedef MachineInformationIntel MachineInformation;
typedef RegisterInformationIntel RegisterInformation;
typedef FPUInformationIntel FPUInformation;
typedef VectorInformationIntel VectorInformation;
#endif /* TARGET_CPU_X86 */
#if TARGET_CPU_X86_64
struct MachineInformationIntel64 {
unsigned long CS;
unsigned long FS;
unsigned long GS;
unsigned long RFLAGS;
unsigned long RIP;
unsigned long ExceptTrap;
unsigned long ExceptErr;
unsigned long ExceptAddr;
};
typedef struct MachineInformationIntel64 MachineInformationIntel64;
struct RegisterInformationIntel64 {
unsigned long RAX;
unsigned long RBX;
unsigned long RCX;
unsigned long RDX;
unsigned long RDI;
unsigned long RSI;
unsigned long RBP;
unsigned long RSP;
unsigned long R8;
unsigned long R9;
unsigned long R10;
unsigned long R11;
unsigned long R12;
unsigned long R13;
unsigned long R14;
unsigned long R15;
};
typedef struct RegisterInformationIntel64 RegisterInformationIntel64;
typedef unsigned char FPRegIntel[10];
struct FPUInformationIntel64 {
FPRegIntel Registers[8];
unsigned short Control;
unsigned short Status;
unsigned short Tag;
unsigned short Opcode;
unsigned int IP;
unsigned int DP;
unsigned int DS;
};
typedef struct FPUInformationIntel64 FPUInformationIntel64;
struct VectorInformationIntel64 {
Vector128Intel Registers[16];
};
typedef struct VectorInformationIntel64 VectorInformationIntel64;
typedef MachineInformationIntel64 MachineInformation;
typedef RegisterInformationIntel64 RegisterInformation;
typedef FPUInformationIntel64 FPUInformation;
typedef VectorInformationIntel64 VectorInformation;
#endif /* TARGET_CPU_X86_64 */
#if TARGET_CPU_X86 || TARGET_CPU_X86_64
struct ExceptionInformation {
ExceptionKind theKind;
MachineInformation * machineState;
RegisterInformation * registerImage;
FPUInformation * FPUImage;
ExceptionInfo info;
VectorInformation * vectorImage;
};
typedef struct ExceptionInformation ExceptionInformation;
#endif /* TARGET_CPU_X86 || TARGET_CPU_X86_64 */
#if TARGET_CPU_ARM64
typedef struct {
const void* __unusedMachineInformationField;
} MachineInformation;
typedef struct {
const void* __unusedRegisterInformationField;
} RegisterInformation;
typedef struct {
const void* __unusedFPUInformationField;
} FPUInformation;
typedef struct {
const void* __unusedVectorInformationField;
} VectorInformation;
struct ExceptionInformation {
ExceptionKind theKind;
/* XXX: Not implemented */
MachineInformation * machineState;
RegisterInformation * registerImage;
FPUInformation * FPUImage;
ExceptionInfo info;
VectorInformation * vectorImage;
};
typedef struct ExceptionInformation ExceptionInformation;
#endif /* TARGET_CPU_ARM64 */
/*
Note: An ExceptionHandler is NOT a UniversalProcPtr, except in Carbon.
It must be a PowerPC function pointer with NO routine descriptor,
except on Carbon, where it must be a UniversalProcPtr (TPP actually)
to allow the interface to work from both CFM and Mach-O.
*/
typedef CALLBACK_API_C( OSStatus , ExceptionHandlerProcPtr )(ExceptionInformation * theException);
typedef STACK_UPP_TYPE(ExceptionHandlerProcPtr) ExceptionHandlerUPP;
/*
* NewExceptionHandlerUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: available as macro/inline
*/
extern ExceptionHandlerUPP
NewExceptionHandlerUPP(ExceptionHandlerProcPtr userRoutine) __API_DEPRECATED("No longer supported", macos(10.0,10.8)) __API_UNAVAILABLE(ios,watchos,tvos);
/*
* DisposeExceptionHandlerUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
DisposeExceptionHandlerUPP(ExceptionHandlerUPP userUPP) __API_DEPRECATED("No longer supported", macos(10.0,10.8)) __API_UNAVAILABLE(ios,watchos,tvos);
/*
* InvokeExceptionHandlerUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: available as macro/inline
*/
extern OSStatus
InvokeExceptionHandlerUPP(
ExceptionInformation * theException,
ExceptionHandlerUPP userUPP) __API_DEPRECATED("No longer supported", macos(10.0,10.8)) __API_UNAVAILABLE(ios,watchos,tvos);
#if __MACH__
#ifdef __cplusplus
inline ExceptionHandlerUPP NewExceptionHandlerUPP(ExceptionHandlerProcPtr userRoutine) { return userRoutine; }
inline void DisposeExceptionHandlerUPP(ExceptionHandlerUPP) { }
inline OSStatus InvokeExceptionHandlerUPP(ExceptionInformation * theException, ExceptionHandlerUPP userUPP) { return (*userUPP)(theException); }
#else
#define NewExceptionHandlerUPP(userRoutine) ((ExceptionHandlerUPP)userRoutine)
#define DisposeExceptionHandlerUPP(userUPP)
#define InvokeExceptionHandlerUPP(theException, userUPP) (*userUPP)(theException)
#endif
#endif
/*
ExceptionHandler function pointers (TPP):
on classic PowerPC, use raw function pointers
on classic PowerPC with OPAQUE_UPP_TYPES=1, use UPP's
on Carbon, use UPP's
*/
/* use UPP's*/
typedef ExceptionHandlerUPP ExceptionHandlerTPP;
typedef ExceptionHandlerTPP ExceptionHandler;
/* Routine for installing per-process exception handlers */
/*!
* InstallExceptionHandler()
*
* As of macOS 10.16, this call always returns kMPInvalidIDErr and otherwise does nothing. It has been deprecated since
* macOS 10.8 and non-functional since macOS10.13.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern ExceptionHandlerTPP InstallExceptionHandler(ExceptionHandlerTPP theHandler) __API_DEPRECATED("No longer support", macos(10.0,10.8)) __API_UNAVAILABLE(ios,watchos,tvos);
#pragma options align=reset
#ifdef __cplusplus
}
#endif
#endif /* __MACHINEEXCEPTIONS__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework/Headers/HFSVolumes.h | /*
File: CarbonCore/HFSVolumes.h
Contains: On-disk data structures for HFS and HFS Plus volumes.
The contents of this header file are deprecated.
Copyright: © 1984-2011 by Apple Inc. All rights reserved.
*/
#ifndef __HFSVOLUMES__
#define __HFSVOLUMES__
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
#ifndef __FILES__
#include <CarbonCore/Files.h>
#endif
#ifndef __FINDER__
#include <CarbonCore/Finder.h>
#endif
#include <hfs/hfs_format.h>
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
/* CatalogNodeID is used to track catalog objects */
typedef UInt32 HFSCatalogNodeID;
#endif /* __HFSVOLUMES__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework/Headers/Threads.h | /*
File: CarbonCore/Threads.h
Contains: Thread Manager Interfaces.
The contents of this header file are deprecated.
Copyright: © 1991-2011 by Apple Inc. All rights reserved.
*/
#ifndef __THREADS__
#define __THREADS__
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
#ifndef __MIXEDMODE__
#include <CarbonCore/MixedMode.h>
#endif
#ifndef __MACERRORS__
#include <CarbonCore/MacErrors.h>
#endif
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
#pragma pack(push, 2)
/*********************************************************************************************
The Thread Manager is deprecated. Callers should use blocks, libDispatch, or pthreads.
No exact replacement exists for the 'cooperative' threads model, but converting all of the
former work done in cooperative threads into blocks and scheduling them on the same serial
dispatch queue ( or the main queue ) is essentially the same.
*********************************************************************************************/
/* Thread states*/
typedef UInt16 ThreadState;
enum {
kReadyThreadState = 0,
kStoppedThreadState = 1,
kRunningThreadState = 2
};
/* Error codes have been moved to Errors.(pah)*/
/* Thread environment characteristics*/
typedef void * ThreadTaskRef;
/* Thread characteristics*/
typedef UInt32 ThreadStyle;
enum {
kCooperativeThread = 1L << 0,
kPreemptiveThread = 1L << 1
};
/* Thread identifiers*/
typedef unsigned long ThreadID;
enum {
kNoThreadID = 0,
kCurrentThreadID = 1,
kApplicationThreadID = 2
};
/* Options when creating a thread*/
typedef UInt32 ThreadOptions;
enum {
kNewSuspend = (1 << 0),
kUsePremadeThread = (1 << 1),
kCreateIfNeeded = (1 << 2),
kFPUNotNeeded = (1 << 3),
kExactMatchThread = (1 << 4)
};
/* Information supplied to the custom scheduler*/
struct SchedulerInfoRec {
UInt32 InfoRecSize;
ThreadID CurrentThreadID;
ThreadID SuggestedThreadID;
ThreadID InterruptedCoopThreadID;
};
typedef struct SchedulerInfoRec SchedulerInfoRec;
typedef SchedulerInfoRec * SchedulerInfoRecPtr;
/*
The following ProcPtrs cannot be interchanged with UniversalProcPtrs because
of differences between 680x0 and PowerPC runtime architectures with regard to
the implementation of the Thread Manager.
*/
typedef void * voidPtr;
/* Prototype for thread's entry (main) routine*/
typedef CALLBACK_API( voidPtr , ThreadEntryProcPtr )(void * threadParam);
/* Prototype for custom thread scheduler routine*/
typedef CALLBACK_API( ThreadID , ThreadSchedulerProcPtr )(SchedulerInfoRecPtr schedulerInfo);
/* Prototype for custom thread switcher routine*/
typedef CALLBACK_API( void , ThreadSwitchProcPtr )(ThreadID threadBeingSwitched, void *switchProcParam);
/* Prototype for thread termination notification routine*/
typedef CALLBACK_API( void , ThreadTerminationProcPtr )(ThreadID threadTerminated, void *terminationProcParam);
/* Prototype for debugger NewThread notification*/
typedef CALLBACK_API( void , DebuggerNewThreadProcPtr )(ThreadID threadCreated);
/* Prototype for debugger DisposeThread notification*/
typedef CALLBACK_API( void , DebuggerDisposeThreadProcPtr )(ThreadID threadDeleted);
/* Prototype for debugger schedule notification*/
typedef CALLBACK_API( ThreadID , DebuggerThreadSchedulerProcPtr )(SchedulerInfoRecPtr schedulerInfo);
typedef STACK_UPP_TYPE(ThreadEntryProcPtr) ThreadEntryUPP;
typedef STACK_UPP_TYPE(ThreadSchedulerProcPtr) ThreadSchedulerUPP;
typedef STACK_UPP_TYPE(ThreadSwitchProcPtr) ThreadSwitchUPP;
typedef STACK_UPP_TYPE(ThreadTerminationProcPtr) ThreadTerminationUPP;
typedef STACK_UPP_TYPE(DebuggerNewThreadProcPtr) DebuggerNewThreadUPP;
typedef STACK_UPP_TYPE(DebuggerDisposeThreadProcPtr) DebuggerDisposeThreadUPP;
typedef STACK_UPP_TYPE(DebuggerThreadSchedulerProcPtr) DebuggerThreadSchedulerUPP;
/*
* NewThreadEntryUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern ThreadEntryUPP
NewThreadEntryUPP(ThreadEntryProcPtr userRoutine) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_7, __IPHONE_NA, __IPHONE_NA);
/*
* NewThreadSchedulerUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern ThreadSchedulerUPP
NewThreadSchedulerUPP(ThreadSchedulerProcPtr userRoutine) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_7, __IPHONE_NA, __IPHONE_NA);
/*
* NewThreadSwitchUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern ThreadSwitchUPP
NewThreadSwitchUPP(ThreadSwitchProcPtr userRoutine) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_7, __IPHONE_NA, __IPHONE_NA);
/*
* NewThreadTerminationUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern ThreadTerminationUPP
NewThreadTerminationUPP(ThreadTerminationProcPtr userRoutine) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_7, __IPHONE_NA, __IPHONE_NA);
/*
* NewDebuggerNewThreadUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern DebuggerNewThreadUPP
NewDebuggerNewThreadUPP(DebuggerNewThreadProcPtr userRoutine) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_7, __IPHONE_NA, __IPHONE_NA);
/*
* NewDebuggerDisposeThreadUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern DebuggerDisposeThreadUPP
NewDebuggerDisposeThreadUPP(DebuggerDisposeThreadProcPtr userRoutine) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_7, __IPHONE_NA, __IPHONE_NA);
/*
* NewDebuggerThreadSchedulerUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern DebuggerThreadSchedulerUPP
NewDebuggerThreadSchedulerUPP(DebuggerThreadSchedulerProcPtr userRoutine) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_7, __IPHONE_NA, __IPHONE_NA);
/*
* DisposeThreadEntryUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
DisposeThreadEntryUPP(ThreadEntryUPP userUPP) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_7, __IPHONE_NA, __IPHONE_NA);
/*
* DisposeThreadSchedulerUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
DisposeThreadSchedulerUPP(ThreadSchedulerUPP userUPP) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_7, __IPHONE_NA, __IPHONE_NA);
/*
* DisposeThreadSwitchUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
DisposeThreadSwitchUPP(ThreadSwitchUPP userUPP) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_7, __IPHONE_NA, __IPHONE_NA);
/*
* DisposeThreadTerminationUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
DisposeThreadTerminationUPP(ThreadTerminationUPP userUPP) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_7, __IPHONE_NA, __IPHONE_NA);
/*
* DisposeDebuggerNewThreadUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
DisposeDebuggerNewThreadUPP(DebuggerNewThreadUPP userUPP) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_7, __IPHONE_NA, __IPHONE_NA);
/*
* DisposeDebuggerDisposeThreadUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
DisposeDebuggerDisposeThreadUPP(DebuggerDisposeThreadUPP userUPP) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_7, __IPHONE_NA, __IPHONE_NA);
/*
* DisposeDebuggerThreadSchedulerUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
DisposeDebuggerThreadSchedulerUPP(DebuggerThreadSchedulerUPP userUPP) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_7, __IPHONE_NA, __IPHONE_NA);
/*
* InvokeThreadEntryUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern voidPtr
InvokeThreadEntryUPP(
void * threadParam,
ThreadEntryUPP userUPP) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_7, __IPHONE_NA, __IPHONE_NA);
/*
* InvokeThreadSchedulerUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern ThreadID
InvokeThreadSchedulerUPP(
SchedulerInfoRecPtr schedulerInfo,
ThreadSchedulerUPP userUPP) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_7, __IPHONE_NA, __IPHONE_NA);
/*
* InvokeThreadSwitchUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
InvokeThreadSwitchUPP(
ThreadID threadBeingSwitched,
void * switchProcParam,
ThreadSwitchUPP userUPP) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_7, __IPHONE_NA, __IPHONE_NA);
/*
* InvokeThreadTerminationUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
InvokeThreadTerminationUPP(
ThreadID threadTerminated,
void * terminationProcParam,
ThreadTerminationUPP userUPP) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_7, __IPHONE_NA, __IPHONE_NA);
/*
* InvokeDebuggerNewThreadUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
InvokeDebuggerNewThreadUPP(
ThreadID threadCreated,
DebuggerNewThreadUPP userUPP) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_7, __IPHONE_NA, __IPHONE_NA);
/*
* InvokeDebuggerDisposeThreadUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
InvokeDebuggerDisposeThreadUPP(
ThreadID threadDeleted,
DebuggerDisposeThreadUPP userUPP) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_7, __IPHONE_NA, __IPHONE_NA);
/*
* InvokeDebuggerThreadSchedulerUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern ThreadID
InvokeDebuggerThreadSchedulerUPP(
SchedulerInfoRecPtr schedulerInfo,
DebuggerThreadSchedulerUPP userUPP) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_7, __IPHONE_NA, __IPHONE_NA);
#if __MACH__
#ifdef __cplusplus
inline ThreadEntryUPP NewThreadEntryUPP(ThreadEntryProcPtr userRoutine) { return userRoutine; }
inline ThreadSchedulerUPP NewThreadSchedulerUPP(ThreadSchedulerProcPtr userRoutine) { return userRoutine; }
inline ThreadSwitchUPP NewThreadSwitchUPP(ThreadSwitchProcPtr userRoutine) { return userRoutine; }
inline ThreadTerminationUPP NewThreadTerminationUPP(ThreadTerminationProcPtr userRoutine) { return userRoutine; }
inline DebuggerNewThreadUPP NewDebuggerNewThreadUPP(DebuggerNewThreadProcPtr userRoutine) { return userRoutine; }
inline DebuggerDisposeThreadUPP NewDebuggerDisposeThreadUPP(DebuggerDisposeThreadProcPtr userRoutine) { return userRoutine; }
inline DebuggerThreadSchedulerUPP NewDebuggerThreadSchedulerUPP(DebuggerThreadSchedulerProcPtr userRoutine) { return userRoutine; }
inline void DisposeThreadEntryUPP(ThreadEntryUPP) { }
inline void DisposeThreadSchedulerUPP(ThreadSchedulerUPP) { }
inline void DisposeThreadSwitchUPP(ThreadSwitchUPP) { }
inline void DisposeThreadTerminationUPP(ThreadTerminationUPP) { }
inline void DisposeDebuggerNewThreadUPP(DebuggerNewThreadUPP) { }
inline void DisposeDebuggerDisposeThreadUPP(DebuggerDisposeThreadUPP) { }
inline void DisposeDebuggerThreadSchedulerUPP(DebuggerThreadSchedulerUPP) { }
inline voidPtr InvokeThreadEntryUPP(void * threadParam, ThreadEntryUPP userUPP) { return (*userUPP)(threadParam); }
inline ThreadID InvokeThreadSchedulerUPP(SchedulerInfoRecPtr schedulerInfo, ThreadSchedulerUPP userUPP) { return (*userUPP)(schedulerInfo); }
inline void InvokeThreadSwitchUPP(ThreadID threadBeingSwitched, void * switchProcParam, ThreadSwitchUPP userUPP) { (*userUPP)(threadBeingSwitched, switchProcParam); }
inline void InvokeThreadTerminationUPP(ThreadID threadTerminated, void * terminationProcParam, ThreadTerminationUPP userUPP) { (*userUPP)(threadTerminated, terminationProcParam); }
inline void InvokeDebuggerNewThreadUPP(ThreadID threadCreated, DebuggerNewThreadUPP userUPP) { (*userUPP)(threadCreated); }
inline void InvokeDebuggerDisposeThreadUPP(ThreadID threadDeleted, DebuggerDisposeThreadUPP userUPP) { (*userUPP)(threadDeleted); }
inline ThreadID InvokeDebuggerThreadSchedulerUPP(SchedulerInfoRecPtr schedulerInfo, DebuggerThreadSchedulerUPP userUPP) { return (*userUPP)(schedulerInfo); }
#else
#define NewThreadEntryUPP(userRoutine) ((ThreadEntryUPP)userRoutine)
#define NewThreadSchedulerUPP(userRoutine) ((ThreadSchedulerUPP)userRoutine)
#define NewThreadSwitchUPP(userRoutine) ((ThreadSwitchUPP)userRoutine)
#define NewThreadTerminationUPP(userRoutine) ((ThreadTerminationUPP)userRoutine)
#define NewDebuggerNewThreadUPP(userRoutine) ((DebuggerNewThreadUPP)userRoutine)
#define NewDebuggerDisposeThreadUPP(userRoutine) ((DebuggerDisposeThreadUPP)userRoutine)
#define NewDebuggerThreadSchedulerUPP(userRoutine) ((DebuggerThreadSchedulerUPP)userRoutine)
#define DisposeThreadEntryUPP(userUPP)
#define DisposeThreadSchedulerUPP(userUPP)
#define DisposeThreadSwitchUPP(userUPP)
#define DisposeThreadTerminationUPP(userUPP)
#define DisposeDebuggerNewThreadUPP(userUPP)
#define DisposeDebuggerDisposeThreadUPP(userUPP)
#define DisposeDebuggerThreadSchedulerUPP(userUPP)
#define InvokeThreadEntryUPP(threadParam, userUPP) (*userUPP)(threadParam)
#define InvokeThreadSchedulerUPP(schedulerInfo, userUPP) (*userUPP)(schedulerInfo)
#define InvokeThreadSwitchUPP(threadBeingSwitched, switchProcParam, userUPP) (*userUPP)(threadBeingSwitched, switchProcParam)
#define InvokeThreadTerminationUPP(threadTerminated, terminationProcParam, userUPP) (*userUPP)(threadTerminated, terminationProcParam)
#define InvokeDebuggerNewThreadUPP(threadCreated, userUPP) (*userUPP)(threadCreated)
#define InvokeDebuggerDisposeThreadUPP(threadDeleted, userUPP) (*userUPP)(threadDeleted)
#define InvokeDebuggerThreadSchedulerUPP(schedulerInfo, userUPP) (*userUPP)(schedulerInfo)
#endif
#endif
/*
Thread Manager function pointers (TPP):
on classic 68k use raw function pointers (same as UPP's)
on classic PowerPC, use raw function pointers
on classic PowerPC with OPAQUE_UPP_TYPES=1, use UPP's
on CFM-68K, use UPP's
on Carbon, use UPP's
*/
/* use UPP's*/
typedef ThreadEntryUPP ThreadEntryTPP;
typedef ThreadSchedulerUPP ThreadSchedulerTPP;
typedef ThreadSwitchUPP ThreadSwitchTPP;
typedef ThreadTerminationUPP ThreadTerminationTPP;
typedef DebuggerNewThreadUPP DebuggerNewThreadTPP;
typedef DebuggerDisposeThreadUPP DebuggerDisposeThreadTPP;
typedef DebuggerThreadSchedulerUPP DebuggerThreadSchedulerTPP;
/*
* NewThread() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.7
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in ThreadsLib 1.0 and later
*/
extern OSErr
NewThread(
ThreadStyle threadStyle,
ThreadEntryTPP threadEntry,
void * threadParam,
Size stackSize,
ThreadOptions options,
void ** threadResult, /* can be NULL */
ThreadID * threadMade) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_7, __IPHONE_NA, __IPHONE_NA);
/*
* SetThreadScheduler() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.7
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in ThreadsLib 1.0 and later
*/
extern OSErr
SetThreadScheduler(ThreadSchedulerTPP threadScheduler) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_7, __IPHONE_NA, __IPHONE_NA);
/*
* SetThreadSwitcher() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.7
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in ThreadsLib 1.0 and later
*/
extern OSErr
SetThreadSwitcher(
ThreadID thread,
ThreadSwitchTPP threadSwitcher,
void * switchProcParam,
Boolean inOrOut) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_7, __IPHONE_NA, __IPHONE_NA);
/*
* SetThreadTerminator() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.7
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in ThreadsLib 1.0 and later
*/
extern OSErr
SetThreadTerminator(
ThreadID thread,
ThreadTerminationTPP threadTerminator,
void * terminationProcParam) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_7, __IPHONE_NA, __IPHONE_NA);
/*
* SetDebuggerNotificationProcs() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.7
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in ThreadsLib 1.0 and later
*/
extern OSErr
SetDebuggerNotificationProcs(
DebuggerNewThreadTPP notifyNewThread,
DebuggerDisposeThreadTPP notifyDisposeThread,
DebuggerThreadSchedulerTPP notifyThreadScheduler) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_7, __IPHONE_NA, __IPHONE_NA);
/*
* CreateThreadPool() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.7
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in ThreadsLib 1.0 and later
*/
extern OSErr
CreateThreadPool(
ThreadStyle threadStyle,
SInt16 numToCreate,
Size stackSize) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_7, __IPHONE_NA, __IPHONE_NA);
/*
* GetDefaultThreadStackSize() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.7
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in ThreadsLib 1.0 and later
*/
extern OSErr
GetDefaultThreadStackSize(
ThreadStyle threadStyle,
Size * stackSize) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_7, __IPHONE_NA, __IPHONE_NA);
/*
* ThreadCurrentStackSpace() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.7
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in ThreadsLib 1.0 and later
*/
extern OSErr
ThreadCurrentStackSpace(
ThreadID thread,
ByteCount * freeStack) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_7, __IPHONE_NA, __IPHONE_NA);
/*
* DisposeThread() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.7
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in ThreadsLib 1.0 and later
*/
extern OSErr
DisposeThread(
ThreadID threadToDump,
void * threadResult,
Boolean recycleThread) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_7, __IPHONE_NA, __IPHONE_NA);
/*
* YieldToThread() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.7
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in ThreadsLib 1.0 and later
*/
extern OSErr
YieldToThread(ThreadID suggestedThread) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_7, __IPHONE_NA, __IPHONE_NA);
/*
* YieldToAnyThread() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.7
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in ThreadsLib 1.0 and later
*/
extern OSErr
YieldToAnyThread(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_7, __IPHONE_NA, __IPHONE_NA);
/*
* [Mac]GetCurrentThread() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.7
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in ThreadsLib 1.0 and later
*/
#if TARGET_OS_MAC
#define MacGetCurrentThread GetCurrentThread
#endif
extern OSErr
MacGetCurrentThread(ThreadID * currentThreadID) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_7, __IPHONE_NA, __IPHONE_NA);
/*
* GetThreadState() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.7
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in ThreadsLib 1.0 and later
*/
extern OSErr
GetThreadState(
ThreadID threadToGet,
ThreadState * threadState) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_7, __IPHONE_NA, __IPHONE_NA);
/*
* SetThreadState() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.7
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in ThreadsLib 1.0 and later
*/
extern OSErr
SetThreadState(
ThreadID threadToSet,
ThreadState newState,
ThreadID suggestedThread) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_7, __IPHONE_NA, __IPHONE_NA);
/*
* SetThreadStateEndCritical() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.7
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in ThreadsLib 1.0 and later
*/
extern OSErr
SetThreadStateEndCritical(
ThreadID threadToSet,
ThreadState newState,
ThreadID suggestedThread) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_7, __IPHONE_NA, __IPHONE_NA);
/*
* ThreadBeginCritical() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.7
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in ThreadsLib 1.0 and later
*/
extern OSErr
ThreadBeginCritical(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_7, __IPHONE_NA, __IPHONE_NA);
/*
* ThreadEndCritical() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.7
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in ThreadsLib 1.0 and later
*/
extern OSErr
ThreadEndCritical(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_7, __IPHONE_NA, __IPHONE_NA);
/*
* GetThreadCurrentTaskRef() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.7
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in ThreadsLib 1.0 and later
*/
extern OSErr
GetThreadCurrentTaskRef(ThreadTaskRef * threadTRef) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_7, __IPHONE_NA, __IPHONE_NA);
/*
* GetThreadStateGivenTaskRef() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.7
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in ThreadsLib 1.0 and later
*/
extern OSErr
GetThreadStateGivenTaskRef(
ThreadTaskRef threadTRef,
ThreadID threadToGet,
ThreadState * threadState) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_7, __IPHONE_NA, __IPHONE_NA);
/*
* SetThreadReadyGivenTaskRef() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.7
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in ThreadsLib 1.0 and later
*/
extern OSErr
SetThreadReadyGivenTaskRef(
ThreadTaskRef threadTRef,
ThreadID threadToSet) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_7, __IPHONE_NA, __IPHONE_NA);
#if !__LP64__
/* This routine was never implemented on Mac OS X.*/
/*
* GetFreeThreadCount() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.3
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in ThreadsLib 1.0 and later
*/
extern OSErr
GetFreeThreadCount(
ThreadStyle threadStyle,
SInt16 * freeCount) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_3, __IPHONE_NA, __IPHONE_NA);
/* This routine was never implemented on Mac OS X.*/
/*
* GetSpecificFreeThreadCount() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.3
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in ThreadsLib 1.0 and later
*/
extern OSErr
GetSpecificFreeThreadCount(
ThreadStyle threadStyle,
Size stackSize,
SInt16 * freeCount) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_3, __IPHONE_NA, __IPHONE_NA);
#endif /* !__LP64__ */
#pragma pack(pop)
#ifdef __cplusplus
}
#endif
#endif /* __THREADS__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework/Headers/DiskSpaceRecovery.h | /*
File: CarbonCore/DiskSpaceRecovery.h
Contains: Low level interfaces for recovering space
Copyright: © 2008-2011 by Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __DISKSPACERECOVERY__
#define __DISKSPACERECOVERY__
#ifndef __CFURL__
#include <CoreFoundation/CFURL.h>
#endif
#ifndef __CFERROR__
#include <CoreFoundation/CFError.h>
#endif
#ifndef __CFUUID__
#include <CoreFoundation/CFUUID.h>
#endif
#include <dispatch/dispatch.h>
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
#if __BLOCKS__
/* options to pass to CSDiskSpaceStartRecovery() */
enum {
kCSDiskSpaceRecoveryOptionNoUI = (1 << 0)
};
typedef int CSDiskSpaceRecoveryOptions;
/* callback block invoked by CSDiskSpaceStartRecovery() */
typedef void (^CSDiskSpaceRecoveryCallback)(Boolean succeeded, UInt64 bytesFree, CFErrorRef error);
/*
* CSDiskSpaceStartRecovery()
*
* Discussion:
*
* Asynchronously attempts to recover free space on the specified
* volume and continues until at least the specified amount of space
* is available or until no more space can be recovered. The
* recovery attempt can take a significant amount of time - progress
* can be judged by the caller by monitoring the amount of free
* space on the volume. The provided callback block will be invoked
* once the recovery attempt is complete. Space may be recovered by
* removing Time Machine local snapshots, compacting the
* GenerationStore, or via other methods in the future such as
* removing unneeded cache files or temporary files. The actual
* clean up is performed by a helper process and any user interface
* or IO is managed by the helper process and not by the caller's
* process. The user will be prompted for permission before any
* potentially destructive operations are performed such as removing
* Time Machine local snapshots. Use the
* kCSDiskSpaceRecoveryOptionNoUI flag if you do not want the API to
* invoke any space recovery operations which could result in UI
* being presented.
*
* Mac OS X threading:
* Thread safe since version 10.7
*
* Parameters:
*
* volumeURL:
* The url of the mount point where the space is needed.
*
* bytesNeeded:
* The minimum number of bytes of free space needed on the volume.
*
* options:
* Pass kCSDiskSpaceRecoveryOptionNoUI if user interface should
* not be presented (this may restrict the kinds and amount of
* space that can be recovered)
*
* outOperationUUID:
* If non NULL will be set to point to a CFUUID identifying the
* operation. This CFUUID can be passed to
* CSDiskSpaceCancelRecovery() to cancel the operation. The caller
* is responsible for releasing the returned CFUUID.
*
* callbackQueue:
* The dispatch queue used to invoke the callback.
*
* callback:
* A block which will be invoked once the free space recovery is
* complete. The arguments passed to the block will indicate
* whether recovery succeeded or not, how many bytes are now free
* on the volume, and any error that was encountered.
*
* Result:
* A CFUUID which uniquely identifies the recover space operation
* and can later be passed to CSDiskSpaceCancelRecovery() to cancel
* the operation if needed.
*
* Availability:
* Mac OS X: in version 10.7 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
CSDiskSpaceStartRecovery(
CFURLRef volumeURL,
UInt64 bytesNeeded,
CSDiskSpaceRecoveryOptions options,
CFUUIDRef * outOperationUUID,
dispatch_queue_t callbackQueue,
CSDiskSpaceRecoveryCallback callback) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_NA);
/*
* CSDiskSpaceCancelRecovery()
*
* Discussion:
*
* Cancels the specified space recovery operation. Cancelation may
* take a significant amount of time but this function will return
* immediately. Once cancelation is successful the callback provided
* to CSDiskSpaceStartRecovery() will be invoked.
*
* Mac OS X threading:
* Thread safe since version 10.7
*
* Parameters:
*
* operationUUID:
* The CFUUID for the operation to be canceled as returned by
* CSDiskSpaceStartRecovery()
*
* Availability:
* Mac OS X: in version 10.7 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
CSDiskSpaceCancelRecovery(CFUUIDRef operationUUID) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_NA);
/*
* CSDiskSpaceGetRecoveryEstimate()
*
* Discussion:
*
* Returns a quick, conservative estimate of the number of
* recoverable bytes on the specified volume. This estimated value
* is only intended for display in the user interface. The actual
* amount of recoverable space on a volume may be greater than the
* estimated space so this function should not be used to attempt to
* determine in advance if any particular call to
* CSDiskSpaceStartRecovery() would succeed.
*
* Mac OS X threading:
* Thread safe since version 10.7
*
* Parameters:
*
* volumeURL:
* The url of the mount point of the volume.
*
* Result:
* A UInt64 containing a quick, conservative, rough estimate of the
* number of bytes that might be recoverable on a volume.
*
* Availability:
* Mac OS X: in version 10.7 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern UInt64
CSDiskSpaceGetRecoveryEstimate(CFURLRef volumeURL) __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_NA);
#endif
#ifdef __cplusplus
}
#endif
#endif /* __DISKSPACERECOVERY__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework/Headers/DateTimeUtils.h | /*
File: CarbonCore/DateTimeUtils.h
Contains: International Date and Time Interfaces (previously in TextUtils)
Copyright: © 1994-2011 by Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __DATETIMEUTILS__
#define __DATETIMEUTILS__
#ifndef __CONDITIONALMACROS__
#include <ConditionalMacros.h>
#endif
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
#ifndef __UTCUTILS__
#include <CarbonCore/UTCUtils.h>
#endif
#ifndef __CFDATE__
#include <CoreFoundation/CFDate.h>
#endif
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
#pragma pack(push, 2)
/*
Here are the current routine names and the translations to the older forms.
Please use the newer forms in all new code and migrate the older names out of existing
code as maintainance permits.
New Name Old Name(s)
DateString IUDatePString IUDateString
InitDateCache
LongDateString IULDateString
LongTimeString IULTimeString
StringToDate String2Date
StringToTime
TimeString IUTimeString IUTimePString
LongDateToSeconds LongDate2Secs
LongSecondsToDate LongSecs2Date
DateToSeconds Date2Secs
SecondsToDate Secs2Date
Carbon only supports the new names. The old names are undefined for Carbon targets.
This is true for C, Assembly and Pascal.
InterfaceLib always has exported the old names. For C macros have been defined to allow
the use of the new names. For Pascal and Assembly using the new names will result
in link errors.
*/
typedef SInt16 ToggleResults;
enum {
/* Toggle results */
toggleUndefined = 0,
toggleOK = 1,
toggleBadField = 2,
toggleBadDelta = 3,
toggleBadChar = 4,
toggleUnknown = 5,
toggleBadNum = 6,
toggleOutOfRange = 7, /*synonym for toggleErr3*/
toggleErr3 = 7,
toggleErr4 = 8,
toggleErr5 = 9
};
enum {
/* Date equates */
smallDateBit = 31, /*Restrict valid date/time to range of Time global*/
togChar12HourBit = 30, /*If toggling hour by char, accept hours 1..12 only*/
togCharZCycleBit = 29, /*Modifier for togChar12HourBit: accept hours 0..11 only*/
togDelta12HourBit = 28, /*If toggling hour up/down, restrict to 12-hour range (am/pm)*/
genCdevRangeBit = 27, /*Restrict date/time to range used by genl CDEV*/
validDateFields = -1,
maxDateField = 10
};
enum {
eraMask = 0x0001,
yearMask = 0x0002,
monthMask = 0x0004,
dayMask = 0x0008,
hourMask = 0x0010,
minuteMask = 0x0020,
secondMask = 0x0040,
dayOfWeekMask = 0x0080,
dayOfYearMask = 0x0100,
weekOfYearMask = 0x0200,
pmMask = 0x0400,
dateStdMask = 0x007F /*default for ValidDate flags and ToggleDate TogglePB.togFlags*/
};
typedef SInt8 LongDateField;
enum {
eraField = 0,
yearField = 1,
monthField = 2,
dayField = 3,
hourField = 4,
minuteField = 5,
secondField = 6,
dayOfWeekField = 7,
dayOfYearField = 8,
weekOfYearField = 9,
pmField = 10,
res1Field = 11,
res2Field = 12,
res3Field = 13
};
typedef SInt8 DateForm;
enum {
shortDate = 0,
longDate = 1,
abbrevDate = 2
};
enum {
/* StringToDate status values */
fatalDateTime = 0x8000, /* StringToDate and String2Time mask to a fatal error */
longDateFound = 1, /* StringToDate mask to long date found */
leftOverChars = 2, /* StringToDate & Time mask to warn of left over characters */
sepNotIntlSep = 4, /* StringToDate & Time mask to warn of non-standard separators */
fieldOrderNotIntl = 8, /* StringToDate & Time mask to warn of non-standard field order */
extraneousStrings = 16, /* StringToDate & Time mask to warn of unparsable strings in text */
tooManySeps = 32, /* StringToDate & Time mask to warn of too many separators */
sepNotConsistent = 64, /* StringToDate & Time mask to warn of inconsistent separators */
tokenErr = 0x8100, /* StringToDate & Time mask for 'tokenizer err encountered' */
cantReadUtilities = 0x8200,
dateTimeNotFound = 0x8400,
dateTimeInvalid = 0x8800
};
typedef short StringToDateStatus;
typedef StringToDateStatus String2DateStatus;
struct DateCacheRecord {
short hidden[256]; /* only for temporary use */
};
typedef struct DateCacheRecord DateCacheRecord;
typedef DateCacheRecord * DateCachePtr;
struct DateTimeRec {
short year;
short month;
short day;
short hour;
short minute;
short second;
short dayOfWeek;
};
typedef struct DateTimeRec DateTimeRec;
typedef SInt64 LongDateTime;
#if TARGET_RT_BIG_ENDIAN
union LongDateCvt {
SInt64 c;
struct {
UInt32 lHigh;
UInt32 lLow;
} hl;
};
typedef union LongDateCvt LongDateCvt;
#else
union LongDateCvt {
SInt64 c;
struct {
UInt32 lLow;
UInt32 lHigh;
} hl;
};
typedef union LongDateCvt LongDateCvt;
#endif /* TARGET_RT_BIG_ENDIAN */
union LongDateRec {
struct {
short era;
short year;
short month;
short day;
short hour;
short minute;
short second;
short dayOfWeek;
short dayOfYear;
short weekOfYear;
short pm;
short res1;
short res2;
short res3;
} ld;
short list[14]; /*Index by LongDateField!*/
struct {
short eraAlt;
DateTimeRec oldDate;
} od;
};
typedef union LongDateRec LongDateRec;
typedef SInt8 DateDelta;
struct TogglePB {
long togFlags; /*caller normally sets low word to dateStdMask=$7F*/
ResType amChars; /*from 'itl0', but uppercased*/
ResType pmChars; /*from 'itl0', but uppercased*/
long reserved[4];
};
typedef struct TogglePB TogglePB;
/*
Conversion utilities between CF and Carbon time types.
*/
/*
* UCConvertUTCDateTimeToCFAbsoluteTime()
*
* Discussion:
* Use UCConvertUTCDateTimeToCFAbsoluteTime to convert from a
* UTCDDateTime to a CFAbsoluteTime. Remember that the epoch for
* UTCDateTime is January 1, 1904 while the epoch for CFAbsoluteTime
* is January 1, 2001.
*
* Parameters:
*
* iUTCDate:
* A pointer to a UTCDateTime struct that represents the time you
* wish to convert from.
*
* oCFTime:
* A pointer to a CFAbsoluteTime. On successful return, this will
* contain the converted time from the input time type.
*
* Result:
* A result code indicating whether or not conversion was successful.
*
* Availability:
* Mac OS X: in version 10.2 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x
* Non-Carbon CFM: not available
*/
extern OSStatus
UCConvertUTCDateTimeToCFAbsoluteTime(
const UTCDateTime * iUTCDate,
CFAbsoluteTime * oCFTime) __OSX_AVAILABLE_STARTING(__MAC_10_2, __IPHONE_NA);
/*
* UCConvertSecondsToCFAbsoluteTime()
*
* Discussion:
* Use UCConvertSecondsToCFAbsoluteTime to convert from the normal
* seconds representation of time to a CFAbsoluteTime. Remember that
* the epoch for seconds is January 1, 1904 while the epoch for
* CFAbsoluteTime is January 1, 2001.
*
* Parameters:
*
* iSeconds:
* A UInt32 value that represents the time you wish to convert
* from.
*
* oCFTime:
* A pointer to a CFAbsoluteTime. On successful return, this will
* contain the converted time from the input time type.
*
* Result:
* A result code indicating whether or not conversion was successful.
*
* Availability:
* Mac OS X: in version 10.2 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x
* Non-Carbon CFM: not available
*/
extern OSStatus
UCConvertSecondsToCFAbsoluteTime(
UInt32 iSeconds,
CFAbsoluteTime * oCFTime) __OSX_AVAILABLE_STARTING(__MAC_10_2, __IPHONE_NA);
/*
* UCConvertLongDateTimeToCFAbsoluteTime()
*
* Discussion:
* Use UCConvertLongDateTimeToCFAbsoluteTime to convert from a
* LongDateTime to a CFAbsoluteTime. Remember that the epoch for
* LongDateTime is January 1, 1904 while the epoch for
* CFAbsoluteTime is January 1, 2001.
*
* Parameters:
*
* iLongTime:
* A LongDateTime value that represents the time you wish to
* convert from.
*
* oCFTime:
* A pointer to a CFAbsoluteTime. On successful return, this will
* contain the converted time from the input time type.
*
* Result:
* A result code indicating whether or not conversion was successful.
*
* Availability:
* Mac OS X: in version 10.2 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x
* Non-Carbon CFM: not available
*/
extern OSStatus
UCConvertLongDateTimeToCFAbsoluteTime(
LongDateTime iLongTime,
CFAbsoluteTime * oCFTime) __OSX_AVAILABLE_STARTING(__MAC_10_2, __IPHONE_NA);
/*
* UCConvertCFAbsoluteTimeToUTCDateTime()
*
* Discussion:
* Use UCConvertCFAbsoluteTimeToUTCDateTime to convert from a
* CFAbsoluteTime to a UTCDateTime. Remember that the epoch for
* UTCDateTime is January 1, 1904 while the epoch for CFAbsoluteTime
* is January 1, 2001.
*
* Parameters:
*
* iCFTime:
* A CFAbsoluteTime value that represents the time you wish to
* convert from.
*
* oUTCDate:
* A pointer to a UTCDateTime. On successful return, this will
* contain the converted time from the CFAbsoluteTime input.
*
* Result:
* A result code indicating whether or not conversion was successful.
*
* Availability:
* Mac OS X: in version 10.2 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x
* Non-Carbon CFM: not available
*/
extern OSStatus
UCConvertCFAbsoluteTimeToUTCDateTime(
CFAbsoluteTime iCFTime,
UTCDateTime * oUTCDate) __OSX_AVAILABLE_STARTING(__MAC_10_2, __IPHONE_NA);
/*
* UCConvertCFAbsoluteTimeToSeconds()
*
* Discussion:
* Use UCConvertCFAbsoluteTimeToSeconds to convert from a
* CFAbsoluteTime to a UInt32 representation of seconds. Remember
* that the epoch for seconds is January 1, 1904 while the epoch for
* CFAbsoluteTime is January 1, 2001.
*
* Parameters:
*
* iCFTime:
* A CFAbsoluteTime value that represents the time you wish to
* convert from.
*
* oSeconds:
* A pointer to a UInt32. On successful return, this will contain
* the converted time from the CFAbsoluteTime input.
*
* Result:
* A result code indicating whether or not conversion was successful.
*
* Availability:
* Mac OS X: in version 10.2 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x
* Non-Carbon CFM: not available
*/
extern OSStatus
UCConvertCFAbsoluteTimeToSeconds(
CFAbsoluteTime iCFTime,
UInt32 * oSeconds) __OSX_AVAILABLE_STARTING(__MAC_10_2, __IPHONE_NA);
/*
* UCConvertCFAbsoluteTimeToLongDateTime()
*
* Discussion:
* Use UCConvertCFAbsoluteTimeToLongDateTime to convert from a
* CFAbsoluteTime to a LongDateTime. Remember that the epoch for
* LongDateTime is January 1, 1904 while the epoch for
* CFAbsoluteTime is January 1, 2001.
*
* Parameters:
*
* iCFTime:
* A CFAbsoluteTime value that represents the time you wish to
* convert from.
*
* oLongDate:
* A pointer to a LongDateTime. On successful return, this will
* contain the converted time from the CFAbsoluteTime input.
*
* Result:
* A result code indicating whether or not conversion was successful.
*
* Availability:
* Mac OS X: in version 10.2 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x
* Non-Carbon CFM: not available
*/
extern OSStatus
UCConvertCFAbsoluteTimeToLongDateTime(
CFAbsoluteTime iCFTime,
LongDateTime * oLongDate) __OSX_AVAILABLE_STARTING(__MAC_10_2, __IPHONE_NA);
#if !__LP64__
/*
These routine are available in Carbon with their new name
*/
#if !__LP64__
/*
* DateString() *** DEPRECATED ***
*
* Deprecated:
* use CFDateFormatterCreateStringWithDate instead
*
* Discussion:
* This function is no longer recommended. Please use
* CFDateFormatterCreateStringWithDate instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.3
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: not available
*/
extern void
DateString(
SInt32 dateTime,
DateForm longFlag,
Str255 result,
Handle intlHandle) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_3, __IPHONE_NA, __IPHONE_NA);
/*
* TimeString() *** DEPRECATED ***
*
* Deprecated:
* use CFDateFormatterCreateStringWithDate instead
*
* Discussion:
* This function is no longer recommended. Please use
* CFDateFormatterCreateStringWithDate instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.3
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: not available
*/
extern void
TimeString(
SInt32 dateTime,
Boolean wantSeconds,
Str255 result,
Handle intlHandle) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_3, __IPHONE_NA, __IPHONE_NA);
/*
* LongDateString() *** DEPRECATED ***
*
* Deprecated:
* use CFDateFormatterCreateStringWithDate instead
*
* Discussion:
* This function is no longer recommended. Please use
* CFDateFormatterCreateStringWithDate instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.3
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: not available
*/
extern void
LongDateString(
const LongDateTime * dateTime,
DateForm longFlag,
Str255 result,
Handle intlHandle) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_3, __IPHONE_NA, __IPHONE_NA);
/*
* LongTimeString() *** DEPRECATED ***
*
* Deprecated:
* use CFDateFormatterCreateStringWithDate instead
*
* Discussion:
* This function is no longer recommended. Please use
* CFDateFormatterCreateStringWithDate instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.3
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: not available
*/
extern void
LongTimeString(
const LongDateTime * dateTime,
Boolean wantSeconds,
Str255 result,
Handle intlHandle) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_3, __IPHONE_NA, __IPHONE_NA);
/*
These routine are available in Carbon and InterfaceLib with their new name
*/
/*
* InitDateCache() *** DEPRECATED ***
*
* Deprecated:
* No longer needed on MacOS X.
*
* Discussion:
* This function is obsolate.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.3
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
InitDateCache(DateCachePtr theCache) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_3, __IPHONE_NA, __IPHONE_NA);
/*
* StringToDate() *** DEPRECATED ***
*
* Deprecated:
* use CFDateFormatterCreateDateFromString instead
*
* Discussion:
* This function is no longer recommended. Please use
* CFDateFormatterCreateDateFromString instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.3
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern StringToDateStatus
StringToDate(
Ptr textPtr,
SInt32 textLen,
DateCachePtr theCache,
SInt32 * lengthUsed,
LongDateRec * dateTime) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_3, __IPHONE_NA, __IPHONE_NA);
/*
* StringToTime() *** DEPRECATED ***
*
* Deprecated:
* use CFDateFormatterCreateDateFromString instead
*
* Discussion:
* This function is no longer recommended. Please use
* CFDateFormatterCreateDateFromString instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.3
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern StringToDateStatus
StringToTime(
Ptr textPtr,
SInt32 textLen,
DateCachePtr theCache,
SInt32 * lengthUsed,
LongDateRec * dateTime) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_3, __IPHONE_NA, __IPHONE_NA);
/*
* LongDateToSeconds() *** DEPRECATED ***
*
* Deprecated:
* use CFCalendar instead.
*
* Discussion:
* This function is no longer recommended. Please use CFCalendar
* instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.3
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void
LongDateToSeconds(
const LongDateRec * lDate,
LongDateTime * lSecs) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_3, __IPHONE_NA, __IPHONE_NA);
/*
* LongSecondsToDate() *** DEPRECATED ***
*
* Deprecated:
* use CFCalendar instead.
*
* Discussion:
* This function is no longer recommended. Please use CFCalendar
* instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.3
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void
LongSecondsToDate(
const LongDateTime * lSecs,
LongDateRec * lDate) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_3, __IPHONE_NA, __IPHONE_NA);
/*
* ToggleDate() *** DEPRECATED ***
*
* Deprecated:
* use CFCalendar instead.
*
* Discussion:
* This function is no longer recommended. Please use CFCalendar
* instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.3
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern ToggleResults
ToggleDate(
LongDateTime * lSecs,
LongDateField field,
DateDelta delta,
short ch,
const TogglePB * params) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_3, __IPHONE_NA, __IPHONE_NA);
/*
* ValidDate() *** DEPRECATED ***
*
* Deprecated:
* use CFCalendar instead.
*
* Discussion:
* This function is no longer recommended. Please use CFCalendar
* instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.3
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern short
ValidDate(
const LongDateRec * vDate,
long flags,
LongDateTime * newSecs) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_3, __IPHONE_NA, __IPHONE_NA);
/*
* ReadDateTime() *** DEPRECATED ***
*
* Deprecated:
* use CFAbsoluteTimeGetCurrent instead.
*
* Discussion:
* This function is no longer recommended. Please use
* CFAbsoluteTimeGetCurrent instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.3
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
ReadDateTime(unsigned long * datetime) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_3, __IPHONE_NA, __IPHONE_NA);
/*
* GetDateTime() *** DEPRECATED ***
*
* Deprecated:
* use CFAbsoluteTimeGetCurrent instead.
*
* Discussion:
* This function is no longer recommended. Please use
* CFAbsoluteTimeGetCurrent instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.3
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void
GetDateTime(unsigned long * secs) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_3, __IPHONE_NA, __IPHONE_NA);
/*
* SetDateTime() *** DEPRECATED ***
*
* Deprecated:
* deprecated it without replacement
*
* Discussion:
* This function is no longer recommended. One has to be root on
* MacOSX to set. This is done through other means on OS X
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.3
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
SetDateTime(unsigned long datetime) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_3, __IPHONE_NA, __IPHONE_NA);
/*
* SetTime() *** DEPRECATED ***
*
* Deprecated:
* deprecated it without replacement
*
* Discussion:
* This function is no longer recommended. One has to be root on
* MacOSX to set. This is done through other means on OS X
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.3
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void
SetTime(const DateTimeRec * d) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_3, __IPHONE_NA, __IPHONE_NA);
/*
* GetTime() *** DEPRECATED ***
*
* Deprecated:
* use CFAbsoluteTimeGetCurrent instead.
*
* Discussion:
* This function is no longer recommended. Please use
* CFAbsoluteTimeGetCurrent instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.3
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void
GetTime(DateTimeRec * d) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_3, __IPHONE_NA, __IPHONE_NA);
#endif /* !__LP64__ */
#if !__LP64__
/*
* DateToSeconds() *** DEPRECATED ***
*
* Deprecated:
* use CFCalendar instead.
*
* Discussion:
* This function is no longer recommended. Please use CFCalendar
* instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.3
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void
DateToSeconds(
const DateTimeRec * d,
unsigned long * secs) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_3, __IPHONE_NA, __IPHONE_NA);
#endif /* !__LP64__ */
#if !__LP64__
/*
* SecondsToDate() *** DEPRECATED ***
*
* Deprecated:
* use CFCalendar instead.
*
* Discussion:
* This function is no longer recommended. Please use CFCalendar
* instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.3
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void
SecondsToDate(
unsigned long secs,
DateTimeRec * d) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_3, __IPHONE_NA, __IPHONE_NA);
/*
These routine are available in InterfaceLib using their old name.
Macros allow using the new names in all source code.
@deprecated use CFDateFormatter instead.
*/
/*
* IUDateString() *** DEPRECATED ***
*
* Availability:
* Mac OS X: not available [32-bit only] but deprecated in 10.3
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
* IUTimeString() *** DEPRECATED ***
*
* Availability:
* Mac OS X: not available [32-bit only] but deprecated in 10.3
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
* IUDatePString() *** DEPRECATED ***
*
* Availability:
* Mac OS X: not available [32-bit only] but deprecated in 10.3
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
* IUTimePString() *** DEPRECATED ***
*
* Availability:
* Mac OS X: not available [32-bit only] but deprecated in 10.3
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
* IULDateString() *** DEPRECATED ***
*
* Availability:
* Mac OS X: not available [32-bit only] but deprecated in 10.3
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
* IULTimeString() *** DEPRECATED ***
*
* Availability:
* Mac OS X: not available [32-bit only] but deprecated in 10.3
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
#endif /* !__LP64__ */
#if CALL_NOT_IN_CARBON
#define DateString(dateTime, longFlag, result, intlHandle) \
IUDatePString( dateTime, longFlag, result, intlHandle)
#define TimeString(dateTime, wantSeconds, result, intlHandle) \
IUTimePString(dateTime, wantSeconds, result, intlHandle)
#define LongDateString(dateTime, longFlag, result, intlHandle) \
IULDateString(dateTime, longFlag, result, intlHandle)
#define LongTimeString(dateTime, wantSeconds, result, intlHandle) \
IULTimeString(dateTime, wantSeconds, result, intlHandle)
#endif /* CALL_NOT_IN_CARBON */
#if OLDROUTINENAMES
#define String2Date(textPtr, textLen, theCache, lengthUsed, dateTime) \
StringToDate(textPtr, textLen, theCache, lengthUsed, dateTime)
#define String2Time(textPtr, textLen, theCache, lengthUsed, dateTime) \
StringToTime(textPtr, textLen, theCache, lengthUsed, dateTime)
#define LongDate2Secs(lDate, lSecs) LongDateToSeconds(lDate, lSecs)
#define LongSecs2Date(lSecs, lDate) LongSecondsToDate(lSecs, lDate)
#define Date2Secs(d, secs) DateToSeconds(d, secs)
#define Secs2Date(secs, d) SecondsToDate(secs, d)
#endif /* OLDROUTINENAMES */
/*
* iudatestring()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
* iudatepstring()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
* iutimestring()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
* iutimepstring()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
* iuldatestring()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
* iultimestring()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
#endif /* !__LP64__ */
#pragma pack(pop)
#ifdef __cplusplus
}
#endif
#endif /* __DATETIMEUTILS__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework/Headers/Timer.h | /*
File: CarbonCore/Timer.h
Contains: Time Manager interfaces.
The contents of this header file are deprecated.
Copyright: © 1985-2011 by Apple Inc. All rights reserved.
*/
#ifndef __TIMER__
#define __TIMER__
#ifndef __CONDITIONALMACROS__
#include <ConditionalMacros.h>
#endif
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
#ifndef __OSUTILS__
#include <CarbonCore/OSUtils.h>
#endif
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
#pragma pack(push, 2)
/*
* Microseconds()
*
* Summary:
* Determines the number of microseconds that have elapsed since
* system startup time.
*
* Discussion:
* Return a value representing the number of microseconds since some
* point in time, usually since the system was booted. One
* microsecond is 1 * 10^-6 seconds, and so there are one million
* ( 1,000,000 ) microseconds per second. For reference, in
* one microsecond light can travel about 850 feet in a vacuum.
*
* Microseconds() doesn't necessarily advance while the computer is
* asleep, so it should not be used for long duration timings.
*
* Parameters:
*
* microTickCount:
* The number of microseconds elapsed since system startup.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void
Microseconds(UnsignedWide * microTickCount) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/****************************************************************************
The remaining functions in this file have all been deprecated on Mac
OS X 10.4. There are other solutions which perform better, and consume
fewer system resources which are recommended. The Time Manager on
Mac OS X does not have exactly the same behavior as it did on Mac OS 9
and earlier, especially in a multithreaded process.
Instead of using the Time Manager functions, you should consider
the following:
1. If you want a function to be called periodically from an
application, then look at using a CFRunLoopTimer ( in CFRunLoop.h ).
2. In a Cocoa application, you can use the NSTimer object to get
both absolute and interval-based periodic callbacks.
3. If you need something to happen periodically, and don't have a
CFRunLoop in your application, you can create a thread which sleeps
for whatever interval you want, then does something and sleeps again
( or exits, or whatever. )
Conceptually, this is all the current Time Manager does -- when you
prime a task, a thread is created which sleeps on a semaphore for the
amount of time remaining before the next earliest Time Manager task,
then calls the tmTask function for that task and then calculates the
time until the next task, ad nauseum.
4. If you just want to delay for some period of time, and don't have
other threads or data which may require synchronization, you can call
Delay(), sleep(), usleep(), or nanosleep().
5.
-
****************************************************************************/
enum {
/* high bit of qType is set if task is active */
kTMTaskActive = (1L << 15)
};
typedef struct TMTask TMTask;
typedef TMTask * TMTaskPtr;
typedef CALLBACK_API( void , TimerProcPtr )(TMTaskPtr tmTaskPtr);
typedef STACK_UPP_TYPE(TimerProcPtr) TimerUPP;
struct TMTask {
QElemPtr qLink;
short qType;
TimerUPP tmAddr;
long tmCount;
long tmWakeUp;
long tmReserved;
};
/*
* InsTime() *** DEPRECATED ***
*
* Discussion:
* Use InstallTimeTask() instead of this function.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void
InsTime(QElemPtr tmTaskPtr) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* InsXTime() *** DEPRECATED ***
*
* Discussion:
* Use InstallXTimeTask() instead of this function.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void
InsXTime(QElemPtr tmTaskPtr) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* PrimeTime() *** DEPRECATED ***
*
* Discussion:
* Use PrimeTimeTask() instead of this function.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void
PrimeTime(
QElemPtr tmTaskPtr,
long count) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* RmvTime() *** DEPRECATED ***
*
* Discussion:
* Use RemoveTimeTask() instead of this function.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void
RmvTime(QElemPtr tmTaskPtr) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* InstallTimeTask() *** DEPRECATED ***
*
* Summary:
* Installs a task, taking advantage of the drift-free,
* fixed-frequency timing services of the extended Time Manager.
*
* Discussion:
* The InstallXTimeTask function adds the Time Manager task
* structure specified by tmTaskPtr to the Time Manager queue. Use
* InstallXTimeTask only if you wish to use the drift-free,
* fixed-frequency timing services of the extended Time Manager; use
* InstallTimeTask in all other cases. The tmTaskPtr parameter must
* point to an extended Time Manager task structure. Your
* application must fill in the tmAddr field of that task. You
* should set the tmWakeUp and tmReserved fields to 0 the first time
* you call InsXTime.
* With the extended Time Manager, you can set tmAddr to NULL if you
* do not want a task to execute when the delay passed to PrimeTime
* expires. Also, InsXTime resets the high-order bit of the qType
* field to 0.
* The InstallXTimeTask function, which returns a value of type
* OSErr, takes the place of InsXTime.
*
* Parameters:
*
* tmTaskPtr:
* A pointer to an extended task structure to be installed in the
* queue.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0.2 and later
* Non-Carbon CFM: in InterfaceLib 9.1 and later
*/
extern OSErr
InstallTimeTask(QElemPtr tmTaskPtr) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* InstallXTimeTask() *** DEPRECATED ***
*
* Summary:
* Installs a task, taking advantage of the drift-free,
* fixed-frequency timing services of the extended Time Manager.
*
* Discussion:
* The InstallXTimeTask function adds the Time Manager task
* structure specified by tmTaskPtr to the Time Manager queue. Use
* InstallXTimeTask only if you wish to use the drift-free,
* fixed-frequency timing services of the extended Time Manager; use
* InstallTimeTask in all other cases. The tmTaskPtr parameter must
* point to an extended Time Manager task structure. Your
* application must fill in the tmAddr field of that task. You
* should set the tmWakeUp and tmReserved fields to 0 the first time
* you call InsXTime.
* With the extended Time Manager, you can set tmAddr to NULL if you
* do not want a task to execute when the delay passed to PrimeTime
* expires. Also, InsXTime resets the high-order bit of the qType
* field to 0.
* The InstallXTimeTask function, which returns a value of type
* OSErr, takes the place of InsXTime.
*
*
*
*
*
*
* *************************************************************
* See the discussion at the top of this file for information about
* why this call is deprecated on Mac OS X, and what other system
* facilities you can use in your code instead of the Time Manager.
* *****************************************************************
*
* Parameters:
*
* tmTaskPtr:
* A pointer to an extended task structure to be installed in the
* queue.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0.2 and later
* Non-Carbon CFM: in InterfaceLib 9.1 and later
*/
extern OSErr
InstallXTimeTask(QElemPtr tmTaskPtr) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* PrimeTimeTask() *** DEPRECATED ***
*
* Summary:
* Activates a task in the Time Manager queue.
*
* Discussion:
* The PrimeTimeTask function schedules the task specified by the
* tmAddr field of the structure pointed to by the tmTaskPtr
* parameter for execution after the delay specified by the count
* parameter has elapsed.
*
* If the count parameter is a positive value, it is interpreted as
* milliseconds. If count is a negative value, it is interpreted in
* negated microseconds. Microsecond delays are allowable only in
* the revised and extended Time Managers.
*
* The task record specified by the tmTaskPtr parameter must already
* be installed in the queue (by a previous call to the functions
* InstallTimeTask or InstallXTimeTask) before your application
* calls the PrimeTimeTask function. The PrimeTimeTask function
* returns immediately, and the specified task is executed after the
* specified delay has elapsed. If you call the PrimeTimeTask
* function with a time delay of 0, the task runs as soon as
* interrupts are enabled.
*
* In the revised and extended Time Managers, the PrimeTimeTask
* function sets the high-order bit of the qType field to 1. In
* addition, any value of the count parameter that exceeds the
* maximum millisecond delay is reduced to the maximum. If you stop
* an unexpired task (by calling the function RemoveTimeTask) and
* then reinstall it (by calling the InstallXTimeTask function), you
* can continue the previous delay by calling the PrimeTimeTask
* function with the count parameter set to 0.
*
*
*
*
*
*
* *************************************************************
* See the discussion at the top of this file for information about
* why this call is deprecated on Mac OS X, and what other system
* facilities you can use in your code instead of the Time Manager.
* *****************************************************************
*
* Parameters:
*
* tmTaskPtr:
* A pointer to a task structure already installed in the queue.
*
* count:
* The desired delay before execution of the task.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0.2 and later
* Non-Carbon CFM: in InterfaceLib 9.1 and later
*/
extern OSErr
PrimeTimeTask(
QElemPtr tmTaskPtr,
long count) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* RemoveTimeTask() *** DEPRECATED ***
*
* Summary:
* Removes a task from the Time Manager queue.
*
* Discussion:
* The RemoveTimeTask function removes the Time Manager task
* structure specified by the tmTaskPtr parameter from the Time
* Manager queue. In both the revised and extended Time Managers, if
* the specified task record is active (that is, if it has been
* activated but the specified time has not yet elapsed), the
* tmCount field of the task structure returns the amount of time
* remaining. To provide the greatest accuracy, the unused time is
* reported as negated microseconds if that value is small enough to
* fit into the tmCount field (even if the delay was originally
* specified in milliseconds); otherwise, the unused time is
* reported in positive milliseconds. If the time has already
* expired, the tmCount field contains 0.
*
* In the revised and extended Time Managers, the RemoveTimeTask
* function sets the high-order bit of the qType field to 0.
*
*
*
*
*
*
* *************************************************************
* See the discussion at the top of this file for information about
* why this call is deprecated on Mac OS X, and what other system
* facilities you can use in your code instead of the Time Manager.
* *****************************************************************
*
* Parameters:
*
* tmTaskPtr:
* A pointer to a task structure to be removed from the queue.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0.2 and later
* Non-Carbon CFM: in InterfaceLib 9.1 and later
*/
extern OSErr
RemoveTimeTask(QElemPtr tmTaskPtr) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* NewTimerUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern TimerUPP
NewTimerUPP(TimerProcPtr userRoutine) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* DisposeTimerUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
DisposeTimerUPP(TimerUPP userUPP) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* InvokeTimerUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
InvokeTimerUPP(
TMTaskPtr tmTaskPtr,
TimerUPP userUPP) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
#if __MACH__
#ifdef __cplusplus
inline TimerUPP NewTimerUPP(TimerProcPtr userRoutine) { return userRoutine; }
inline void DisposeTimerUPP(TimerUPP) { }
inline void InvokeTimerUPP(TMTaskPtr tmTaskPtr, TimerUPP userUPP) { (*userUPP)(tmTaskPtr); }
#else
#define NewTimerUPP(userRoutine) ((TimerUPP)userRoutine)
#define DisposeTimerUPP(userUPP)
#define InvokeTimerUPP(tmTaskPtr, userUPP) (*userUPP)(tmTaskPtr)
#endif
#endif
#pragma pack(pop)
#ifdef __cplusplus
}
#endif
#endif /* __TIMER__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework/Headers/TextEncodingPlugin.h | /*
File: CarbonCore/TextEncodingPlugin.h
Contains: Required interface for Text Encoding Converter-Plugins
Copyright: © 1996-2011 by Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __TEXTENCODINGPLUGIN__
#define __TEXTENCODINGPLUGIN__
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
#ifndef __TEXTCOMMON__
#include <CarbonCore/TextCommon.h>
#endif
#ifndef __TEXTENCODINGCONVERTER__
#include <CarbonCore/TextEncodingConverter.h>
#endif
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#if defined(__x86_64__)
#pragma pack(push, 2)
#endif
/*
####################################################################################
Constants
####################################################################################
*/
/*
This constant is needed for MacOS X development only. It is the name in which the
function to grab the plugin's dispatch table must go by.
*/
#define kTECMacOSXDispatchTableNameString "ConverterPluginGetPluginDispatchTable"
/* These constant are needed for TEC plugins.*/
enum {
kTECAvailableEncodingsResType = 'cven',
kTECAvailableSniffersResType = 'cvsf',
kTECSubTextEncodingsResType = 'cvsb',
kTECConversionInfoResType = 'cvif',
kTECMailEncodingsResType = 'cvml',
kTECWebEncodingsResType = 'cvwb',
kTECInternetNamesResType = 'cvmm'
};
enum {
kTECPluginType = 'ecpg',
kTECPluginCreator = 'encv',
kTECPluginOneToOne = 'otoo',
kTECPluginOneToMany = 'otom',
kTECPluginManyToOne = 'mtoo',
kTECPluginSniffObj = 'snif'
};
enum {
verUnspecified = 32767,
kTECResourceID = 128
};
/*
####################################################################################
Structs
####################################################################################
*/
/* These structs are needed for TEC plugins.*/
struct TextEncodingRec {
UInt32 base;
UInt32 variant;
UInt32 format;
};
typedef struct TextEncodingRec TextEncodingRec;
/* supported encodings & sniffers lists, type TECEncodingsListRec */
struct TECEncodingsListRec {
UInt32 count;
TextEncodingRec encodings; /* first of many*/
};
typedef struct TECEncodingsListRec TECEncodingsListRec;
typedef TECEncodingsListRec * TECEncodingsListPtr;
typedef TECEncodingsListPtr * TECEncodingsListHandle;
/* sub encodings list - type TECSubTextEncodingsRec */
struct TECSubTextEncodingRec {
UInt32 offset; /* offset to next variable-length record*/
TextEncodingRec searchEncoding; /* the encoding*/
UInt32 count;
TextEncodingRec subEncodings; /* first of many sub encodings for searchEncoding*/
};
typedef struct TECSubTextEncodingRec TECSubTextEncodingRec;
struct TECSubTextEncodingsRec {
UInt32 count;
TECSubTextEncodingRec subTextEncodingRec; /* first of many*/
};
typedef struct TECSubTextEncodingsRec TECSubTextEncodingsRec;
typedef TECSubTextEncodingsRec * TECSubTextEncodingsPtr;
typedef TECSubTextEncodingsPtr * TECSubTextEncodingsHandle;
/* conversions pairs list - type TECEncodingPairsRec */
struct TECEncodingPairRec {
TextEncodingRec source;
TextEncodingRec dest;
};
typedef struct TECEncodingPairRec TECEncodingPairRec;
struct TECEncodingPairs {
TECEncodingPairRec encodingPair;
UInt32 flags; /* 'flags' name is not really used yet (JKC 9/5/97)*/
UInt32 speed; /* 'speed' name is not really used yet (JKC 9/5/97)*/
};
typedef struct TECEncodingPairs TECEncodingPairs;
struct TECEncodingPairsRec {
UInt32 count;
TECEncodingPairs encodingPairs;
};
typedef struct TECEncodingPairsRec TECEncodingPairsRec;
typedef TECEncodingPairsRec * TECEncodingPairsPtr;
typedef TECEncodingPairsPtr * TECEncodingPairsHandle;
/* mail & web encodings lists - type TECLocaleToEncodingsListRec */
struct TECLocaleListToEncodingListRec {
UInt32 offset; /* offset to next variable-length record*/
UInt32 count;
RegionCode locales; /* first in list of locales*/
/* TECEncodingListRec encodingList; // after local variable length array*/
};
typedef struct TECLocaleListToEncodingListRec TECLocaleListToEncodingListRec;
typedef TECLocaleListToEncodingListRec * TECLocaleListToEncodingListPtr;
struct TECLocaleToEncodingsListRec {
UInt32 count;
TECLocaleListToEncodingListRec localeListToEncodingList; /* language of name*/
};
typedef struct TECLocaleToEncodingsListRec TECLocaleToEncodingsListRec;
typedef TECLocaleToEncodingsListRec * TECLocaleToEncodingsListPtr;
typedef TECLocaleToEncodingsListPtr * TECLocaleToEncodingsListHandle;
/* internet names list - type TECInternetNamesRec */
struct TECInternetNameRec {
UInt32 offset; /* offset to next variable-length record*/
TextEncodingRec searchEncoding; /* named encoding*/
UInt8 encodingNameLength;
UInt8 encodingName[1]; /* first byte of many */
};
typedef struct TECInternetNameRec TECInternetNameRec;
struct TECInternetNamesRec {
UInt32 count;
TECInternetNameRec InternetNames; /* first of many*/
};
typedef struct TECInternetNamesRec TECInternetNamesRec;
typedef TECInternetNamesRec * TECInternetNamesPtr;
typedef TECInternetNamesPtr * TECInternetNamesHandle;
/* plugin context record */
struct TECBufferContextRec {
ConstTextPtr textInputBuffer;
ConstTextPtr textInputBufferEnd;
TextPtr textOutputBuffer;
TextPtr textOutputBufferEnd;
ConstTextEncodingRunPtr encodingInputBuffer;
ConstTextEncodingRunPtr encodingInputBufferEnd;
TextEncodingRunPtr encodingOutputBuffer;
TextEncodingRunPtr encodingOutputBufferEnd;
};
typedef struct TECBufferContextRec TECBufferContextRec;
struct TECPluginStateRec {
UInt8 state1;
UInt8 state2;
UInt8 state3;
UInt8 state4;
UInt32 longState1;
UInt32 longState2;
UInt32 longState3;
UInt32 longState4;
};
typedef struct TECPluginStateRec TECPluginStateRec;
struct TECConverterContextRec {
/* public - manipulated externally and by plugin*/
Ptr pluginRec;
TextEncoding sourceEncoding;
TextEncoding destEncoding;
UInt32 reserved1;
UInt32 reserved2;
TECBufferContextRec bufferContext;
/* private - manipulated only within Plugin*/
URefCon contextRefCon;
ProcPtr conversionProc;
ProcPtr flushProc;
ProcPtr clearContextInfoProc;
UInt32 options1;
UInt32 options2;
TECPluginStateRec pluginState;
};
typedef struct TECConverterContextRec TECConverterContextRec;
struct TECSnifferContextRec {
/* public - manipulated externally*/
Ptr pluginRec;
TextEncoding encoding;
ItemCount maxErrors;
ItemCount maxFeatures;
ConstTextPtr textInputBuffer;
ConstTextPtr textInputBufferEnd;
ItemCount numFeatures;
ItemCount numErrors;
/* private - manipulated only within Plugin*/
URefCon contextRefCon;
ProcPtr sniffProc;
ProcPtr clearContextInfoProc;
TECPluginStateRec pluginState;
};
typedef struct TECSnifferContextRec TECSnifferContextRec;
/*
####################################################################################
Functional Messages
####################################################################################
*/
typedef CALLBACK_API_C( OSStatus , TECPluginNewEncodingConverterPtr )(TECObjectRef *newEncodingConverter, TECConverterContextRec *plugContext, TextEncoding inputEncoding, TextEncoding outputEncoding);
typedef CALLBACK_API_C( OSStatus , TECPluginClearContextInfoPtr )(TECObjectRef encodingConverter, TECConverterContextRec *plugContext);
typedef CALLBACK_API_C( OSStatus , TECPluginConvertTextEncodingPtr )(TECObjectRef encodingConverter, TECConverterContextRec *plugContext);
typedef CALLBACK_API_C( OSStatus , TECPluginFlushConversionPtr )(TECObjectRef encodingConverter, TECConverterContextRec *plugContext);
typedef CALLBACK_API_C( OSStatus , TECPluginDisposeEncodingConverterPtr )(TECObjectRef newEncodingConverter, TECConverterContextRec *plugContext);
typedef CALLBACK_API_C( OSStatus , TECPluginNewEncodingSnifferPtr )(TECSnifferObjectRef *encodingSniffer, TECSnifferContextRec *snifContext, TextEncoding inputEncoding);
typedef CALLBACK_API_C( OSStatus , TECPluginClearSnifferContextInfoPtr )(TECSnifferObjectRef encodingSniffer, TECSnifferContextRec *snifContext);
typedef CALLBACK_API_C( OSStatus , TECPluginSniffTextEncodingPtr )(TECSnifferObjectRef encodingSniffer, TECSnifferContextRec *snifContext);
typedef CALLBACK_API_C( OSStatus , TECPluginDisposeEncodingSnifferPtr )(TECSnifferObjectRef encodingSniffer, TECSnifferContextRec *snifContext);
typedef CALLBACK_API_C( OSStatus , TECPluginGetCountAvailableTextEncodingsPtr )(TextEncoding *availableEncodings, ItemCount maxAvailableEncodings, ItemCount *actualAvailableEncodings);
typedef CALLBACK_API_C( OSStatus , TECPluginGetCountAvailableTextEncodingPairsPtr )(TECConversionInfo *availableEncodings, ItemCount maxAvailableEncodings, ItemCount *actualAvailableEncodings);
typedef CALLBACK_API_C( OSStatus , TECPluginGetCountDestinationTextEncodingsPtr )(TextEncoding inputEncoding, TextEncoding *destinationEncodings, ItemCount maxDestinationEncodings, ItemCount *actualDestinationEncodings);
typedef CALLBACK_API_C( OSStatus , TECPluginGetCountSubTextEncodingsPtr )(TextEncoding inputEncoding, TextEncoding subEncodings[], ItemCount maxSubEncodings, ItemCount *actualSubEncodings);
typedef CALLBACK_API_C( OSStatus , TECPluginGetCountAvailableSniffersPtr )(TextEncoding *availableEncodings, ItemCount maxAvailableEncodings, ItemCount *actualAvailableEncodings);
typedef CALLBACK_API_C( OSStatus , TECPluginGetTextEncodingInternetNamePtr )(TextEncoding textEncoding, Str255 encodingName);
typedef CALLBACK_API_C( OSStatus , TECPluginGetTextEncodingFromInternetNamePtr )(TextEncoding *textEncoding, ConstStr255Param encodingName);
typedef CALLBACK_API_C( OSStatus , TECPluginGetCountWebEncodingsPtr )(TextEncoding *availableEncodings, ItemCount maxAvailableEncodings, ItemCount *actualAvailableEncodings);
typedef CALLBACK_API_C( OSStatus , TECPluginGetCountMailEncodingsPtr )(TextEncoding *availableEncodings, ItemCount maxAvailableEncodings, ItemCount *actualAvailableEncodings);
/*
####################################################################################
Dispatch Table Definition
####################################################################################
*/
enum {
kTECPluginDispatchTableVersion1 = 0x00010000, /* 1.0 through 1.0.3 releases*/
kTECPluginDispatchTableVersion1_1 = 0x00010001, /* 1.1 releases*/
kTECPluginDispatchTableVersion1_2 = 0x00010002, /* 1.2 releases*/
kTECPluginDispatchTableCurrentVersion = kTECPluginDispatchTableVersion1_2
};
struct TECPluginDispatchTable {
TECPluginVersion version;
TECPluginVersion compatibleVersion;
TECPluginSignature PluginID;
TECPluginNewEncodingConverterPtr PluginNewEncodingConverter;
TECPluginClearContextInfoPtr PluginClearContextInfo;
TECPluginConvertTextEncodingPtr PluginConvertTextEncoding;
TECPluginFlushConversionPtr PluginFlushConversion;
TECPluginDisposeEncodingConverterPtr PluginDisposeEncodingConverter;
TECPluginNewEncodingSnifferPtr PluginNewEncodingSniffer;
TECPluginClearSnifferContextInfoPtr PluginClearSnifferContextInfo;
TECPluginSniffTextEncodingPtr PluginSniffTextEncoding;
TECPluginDisposeEncodingSnifferPtr PluginDisposeEncodingSniffer;
TECPluginGetCountAvailableTextEncodingsPtr PluginGetCountAvailableTextEncodings;
TECPluginGetCountAvailableTextEncodingPairsPtr PluginGetCountAvailableTextEncodingPairs;
TECPluginGetCountDestinationTextEncodingsPtr PluginGetCountDestinationTextEncodings;
TECPluginGetCountSubTextEncodingsPtr PluginGetCountSubTextEncodings;
TECPluginGetCountAvailableSniffersPtr PluginGetCountAvailableSniffers;
TECPluginGetCountWebEncodingsPtr PluginGetCountWebTextEncodings;
TECPluginGetCountMailEncodingsPtr PluginGetCountMailTextEncodings;
TECPluginGetTextEncodingInternetNamePtr PluginGetTextEncodingInternetName;
TECPluginGetTextEncodingFromInternetNamePtr PluginGetTextEncodingFromInternetName;
};
typedef struct TECPluginDispatchTable TECPluginDispatchTable;
/*
The last prototype here is for MacOS X plugins only. TEC Plugins in MacOS X need to export a
a function called ConverterPluginGetPluginDispatchTable with the following prototype:
extern TECPluginDispatchTable *ConverterPluginGetPluginDispatchTable( void )
This function will need to return a pointer to the plugin's function dispatch table
when called. It is important that the function be called exactly
"ConverterPluginGetPluginDispatchTable". TECPluginGetPluginDispatchTablePtr is a
function pointer to this function.
*/
typedef CALLBACK_API_C( TECPluginDispatchTable *, TECPluginGetPluginDispatchTablePtr )(void);
#if defined(__x86_64__)
#pragma pack(pop)
#endif
#endif /* __TEXTENCODINGPLUGIN__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework/Headers/DriverSynchronization.h | /*
File: CarbonCore/DriverSynchronization.h
Contains: Driver Synchronization Interfaces.
The contents of this header file are deprecated.
Use OSAtomic API instead.
Copyright: © 1985-2011 by Apple Inc. All rights reserved.
*/
#ifndef __DRIVERSYNCHRONIZATION__
#define __DRIVERSYNCHRONIZATION__
#ifndef __CONDITIONALMACROS__
#include <ConditionalMacros.h>
#endif
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
/*
* CompareAndSwap()
*
* Summary:
* Compare and swap operation, performed atomically with respect to
* all devices that participate in the coherency architecture of the
* platform.
*
* Discussion:
* The CompareAndSwap function compares the value at the specified
* address with oldVal. The value of newValue is written to the
* address only if oldValue and the value at the address are equal.
* CompareAndSwap returns true if newValue is written to the
* address; otherwise, it returns false.
* This function guarantees atomicity only with main system memory.
* It is specifically unsuitable for use on noncacheable memory such
* as that in devices; this function cannot guarantee atomicity, for
* example, on memory mapped from a PCI device.
*
* Parameters:
*
* oldValue:
* The value to compare at address.
*
* newValue:
* The value to write to address if oldValue compares true.
*
* address:
* The 4-byte aligned address of the data to update atomically.
*
* Result:
* true if newValue was written to the address.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 8.5 and later
*/
extern Boolean
CompareAndSwap(
UInt32 oldValue,
UInt32 newValue,
UInt32 * address) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* TestAndClear()
*
* Summary:
* Bit test and clear operation, performed atomically with respect
* to all devices that participate in the coherency architecture of
* the platform.
*
* Discussion:
* The TestAndClear function clears a single bit in a byte at a
* specified address. It returns false if the bit was already clear,
* true otherwise.
* ------------------------------------------------------------
* THIS ROUTINE WAS DOCUMENTED AS RETURNING TRUE IF THE BIT WAS
* ALREADY CLEAR AND FALSE OTHERWISE, and on MAC OS 9.x and earlier
* it did have this behavior, but on Mac OS X 10.0 and later it has
* always returned the state of the bit before the operation ( false
* if the bit was clear; true if it was set ). We have decided that
* changing the documentation ( leaving the implementation as is )
* is less risky than changing the implementation to match the
* documented behavior.
* ------------------------------------------------------------
* This function guarantees atomicity only with main system memory.
* It is specifically unsuitable for use on noncacheable memory such
* as that in devices; this function cannot guarantee atomicity, for
* example, on memory mapped from a PCI device.
*
* Parameters:
*
* bit:
* The bit number in the range 0 through 7.
*
* address:
* The address of the byte to update atomically.
*
* Result:
* true if the bit was already clear, false otherwise.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 8.5 and later
*/
extern Boolean
TestAndClear(
UInt32 bit,
UInt8 * address) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* TestAndSet()
*
* Summary:
* Bit test and set operation, performed atomically with respect to
* all devices that participate in the coherency architecture of the
* platform.
* This function guarantees atomicity only with main system memory.
* It is specifically unsuitable for use on noncacheable memory such
* as that in devices; this function cannot guarantee atomicity, for
* example, on memory mapped from a PCI device.
*
* Discussion:
* The TestAndSet function sets a single bit in a byte at a
* specified address. It returns true if the bit was already set,
* false otherwise.
*
* Parameters:
*
* bit:
* The bit number in the range 0 through 7.
*
* address:
* The address of the byte to update atomically.
*
* Result:
* true if the bit was already set, false otherwise.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 8.5 and later
*/
extern Boolean
TestAndSet(
UInt32 bit,
UInt8 * address) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* IncrementAtomic8()
*
* Summary:
* 8-bit increment operation, performed atomically with respect to
* all devices that participate in the coherency architecture of the
* platform.
*
* Discussion:
* The IncrementAtomic8 function increments the value at the
* specified address by one and returns the original value.
* This function guarantees atomicity only with main system memory.
* It is specifically unsuitable for use on noncacheable memory such
* as that in devices; this function cannot guarantee atomicity, for
* example, on memory mapped from a PCI device.
*
* Parameters:
*
* address:
* The address of the value to update atomically.
*
* Result:
* The value before the increment.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 8.5 and later
*/
extern SInt8
IncrementAtomic8(SInt8 * address) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* DecrementAtomic8()
*
* Summary:
* 8-bit decrement operation, performed atomically with respect to
* all devices that participate in the coherency architecture of the
* platform.
*
* Discussion:
* The DecrementAtomic8 function decrements the value at the
* specified address by one and returns the original value.
* This function guarantees atomicity only with main system memory.
* It is specifically unsuitable for use on noncacheable memory such
* as that in devices; this function cannot guarantee atomicity, for
* example, on memory mapped from a PCI device.
*
* Parameters:
*
* address:
* The address of the value to update atomically.
*
* Result:
* The value before the decrement.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 8.5 and later
*/
extern SInt8
DecrementAtomic8(SInt8 * address) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* AddAtomic8()
*
* Summary:
* 8-bit add operation, performed atomically with respect to all
* devices that participate in the coherency architecture of the
* platform.
*
* Discussion:
* The AddAtomic8 function adds the specified amount to the value at
* the specified address and returns the original value.
* This function guarantees atomicity only with main system memory.
* It is specifically unsuitable for use on noncacheable memory such
* as that in devices; this function cannot guarantee atomicity, for
* example, on memory mapped from a PCI device.
*
* Parameters:
*
* amount:
* The amount to add.
*
* address:
* The address of the value to update atomically.
*
* Result:
* The value before the addition
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 8.5 and later
*/
extern SInt8
AddAtomic8(
SInt32 amount,
SInt8 * address) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* BitAndAtomic8()
*
* Summary:
* 8-bit logical and operation, performed atomically with respect to
* all devices that participate in the coherency architecture of the
* platform.
*
* Discussion:
* The BitAndAtomic8 function logically ands the bits of the
* specified mask into the value at the specified address and
* returns the original value.
* This function guarantees atomicity only with main system memory.
* It is specifically unsuitable for use on noncacheable memory such
* as that in devices; this function cannot guarantee atomicity, for
* example, on memory mapped from a PCI device.
*
* Parameters:
*
* mask:
* The mask to logically and with the value.
*
* address:
* The address of the value to update atomically.
*
* Result:
* The value before the bitwise operation.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 8.5 and later
*/
extern UInt8
BitAndAtomic8(
UInt32 mask,
UInt8 * address) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* BitOrAtomic8()
*
* Summary:
* 8-bit logical or operation, performed atomically with respect to
* all devices that participate in the coherency architecture of the
* platform.
* This function guarantees atomicity only with main system memory.
* It is specifically unsuitable for use on noncacheable memory such
* as that in devices; this function cannot guarantee atomicity, for
* example, on memory mapped from a PCI device.
*
* Discussion:
* The BitOrAtomic8 function logically ors the bits of the specified
* mask into the value at the specified address and returns the
* original value.
*
* Parameters:
*
* mask:
* The mask to logically or with the value.
*
* address:
* The address of the value to update atomically.
*
* Result:
* The value before the bitwise operation.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 8.5 and later
*/
extern UInt8
BitOrAtomic8(
UInt32 mask,
UInt8 * address) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* BitXorAtomic8()
*
* Summary:
* 8-bit logical xor operation, performed atomically with respect to
* all devices that participate in the coherency architecture of the
* platform.
* This function guarantees atomicity only with main system memory.
* It is specifically unsuitable for use on noncacheable memory such
* as that in devices; this function cannot guarantee atomicity, for
* example, on memory mapped from a PCI device.
*
* Discussion:
* The BitXorAtomic8 function logically xors the bits of the
* specified mask into the value at the specified address and
* returns the original value.
*
* Parameters:
*
* mask:
* The mask to logically or with the value.
*
* address:
* The address of the value to update atomically.
*
* Result:
* The value before the bitwise operation.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 8.5 and later
*/
extern UInt8
BitXorAtomic8(
UInt32 mask,
UInt8 * address) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* IncrementAtomic16()
*
* Summary:
* 16-bit increment operation, performed atomically with respect to
* all devices that participate in the coherency architecture of the
* platform.
*
* Discussion:
* The IncrementAtomic16 function increments the value at the
* specified address by one and returns the original value.
* This function guarantees atomicity only with main system memory.
* It is specifically unsuitable for use on noncacheable memory such
* as that in devices; this function cannot guarantee atomicity, for
* example, on memory mapped from a PCI device.
*
* Parameters:
*
* address:
* The 2-byte aligned address of the value to update atomically.
*
* Result:
* The value before the increment.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 8.5 and later
*/
extern SInt16
IncrementAtomic16(SInt16 * address) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* DecrementAtomic16()
*
* Summary:
* 16-bit decrement operation, performed atomically with respect to
* all devices that participate in the coherency architecture of the
* platform.
*
* Discussion:
* The DecrementAtomic16 function decrements the value at the
* specified address by one and returns the original value.
* This function guarantees atomicity only with main system memory.
* It is specifically unsuitable for use on noncacheable memory such
* as that in devices; this function cannot guarantee atomicity, for
* example, on memory mapped from a PCI device.
*
* Parameters:
*
* address:
* The 2-byte aligned address of the value to update atomically.
*
* Result:
* The value before the decrement.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 8.5 and later
*/
extern SInt16
DecrementAtomic16(SInt16 * address) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* AddAtomic16()
*
* Summary:
* 16-bit add operation, performed atomically with respect to all
* devices that participate in the coherency architecture of the
* platform.
*
* Discussion:
* The AddAtomic16 function adds the specified amount to the value
* at the specified address and returns the original value.
* This function guarantees atomicity only with main system memory.
* It is specifically unsuitable for use on noncacheable memory such
* as that in devices; this function cannot guarantee atomicity, for
* example, on memory mapped from a PCI device.
*
* Parameters:
*
* amount:
* The amount to add.
*
* address:
* The 2-byte aligned address of the value to update atomically.
*
* Result:
* The value before the addition
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 8.5 and later
*/
extern SInt16
AddAtomic16(
SInt32 amount,
SInt16 * address) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* BitAndAtomic16()
*
* Summary:
* 16-bit logical and operation, performed atomically with respect
* to all devices that participate in the coherency architecture of
* the platform.
*
* Discussion:
* The BitAndAtomic16 function logically ands the bits of the
* specified mask into the value at the specified address and
* returns the original value.
* This function guarantees atomicity only with main system memory.
* It is specifically unsuitable for use on noncacheable memory such
* as that in devices; this function cannot guarantee atomicity, for
* example, on memory mapped from a PCI device.
*
* Parameters:
*
* mask:
* The mask to logically and with the value.
*
* address:
* The 2-byte aligned address of the value to update atomically.
*
* Result:
* The value before the bitwise operation.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 8.5 and later
*/
extern UInt16
BitAndAtomic16(
UInt32 mask,
UInt16 * address) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* BitOrAtomic16()
*
* Summary:
* 16-bit logical or operation, performed atomically with respect to
* all devices that participate in the coherency architecture of the
* platform.
*
* Discussion:
* The BitOrAtomic16 function logically ors the bits of the
* specified mask into the value at the specified address and
* returns the original value. This function guarantees atomicity
* only with main system memory. It is specifically unsuitable for
* use on noncacheable memory such as that in devices; this function
* cannot guarantee atomicity, for example, on memory mapped from a
* PCI device.
*
* Parameters:
*
* mask:
* The mask to logically or with the value.
*
* address:
* The 2-byte aligned address of the value to update atomically.
*
* Result:
* The value before the bitwise operation.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 8.5 and later
*/
extern UInt16
BitOrAtomic16(
UInt32 mask,
UInt16 * address) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* BitXorAtomic16()
*
* Summary:
* 16-bit logical xor operation, performed atomically with respect
* to all devices that participate in the coherency architecture of
* the platform.
*
* Discussion:
* The BitXorAtomic16 function logically xors the bits of the
* specified mask into the value at the specified address and
* returns the original value. This function guarantees atomicity
* only with main system memory. It is specifically unsuitable for
* use on noncacheable memory such as that in devices; this function
* cannot guarantee atomicity, for example, on memory mapped from a
* PCI device.
*
* Parameters:
*
* mask:
* The mask to logically or with the value.
*
* address:
* The 2-byte aligned address of the value to update atomically.
*
* Result:
* The value before the bitwise operation.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 8.5 and later
*/
extern UInt16
BitXorAtomic16(
UInt32 mask,
UInt16 * address) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* IncrementAtomic()
*
* Summary:
* 32-bit increment operation, performed atomically with respect to
* all devices that participate in the coherency architecture of the
* platform.
*
* Discussion:
* The IncrementAtomic function increments the value at the
* specified address by one and returns the original value. This
* function guarantees atomicity only with main system memory. It is
* specifically unsuitable for use on noncacheable memory such as
* that in devices; this function cannot guarantee atomicity, for
* example, on memory mapped from a PCI device.
*
* Parameters:
*
* address:
* The 4-byte aligned address of the value to update atomically.
*
* Result:
* The value before the increment.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 8.5 and later
*/
extern SInt32
IncrementAtomic(SInt32 * address) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* DecrementAtomic()
*
* Summary:
* 32-bit decrement operation, performed atomically with respect to
* all devices that participate in the coherency architecture of the
* platform.
*
* Discussion:
* The DecrementAtomic function decrements the value at the
* specified address by one and returns the original value. This
* function guarantees atomicity only with main system memory. It is
* specifically unsuitable for use on noncacheable memory such as
* that in devices; this function cannot guarantee atomicity, for
* example, on memory mapped from a PCI device.
*
* Parameters:
*
* address:
* The 4-byte aligned address of the value to update atomically.
*
* Result:
* The value before the decrement.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 8.5 and later
*/
extern SInt32
DecrementAtomic(SInt32 * address) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* AddAtomic()
*
* Summary:
* 32-bit add operation, performed atomically with respect to all
* devices that participate in the coherency architecture of the
* platform.
*
* Discussion:
* The AddAtomic function adds the specified amount to the value at
* the specified address and returns the original value. This
* function guarantees atomicity only with main system memory. It is
* specifically unsuitable for use on noncacheable memory such as
* that in devices; this function cannot guarantee atomicity, for
* example, on memory mapped from a PCI device.
*
* Parameters:
*
* amount:
* The amount to add.
*
* address:
* The 4-byte aligned address of the value to update atomically.
*
* Result:
* The value before the addition
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 8.5 and later
*/
extern SInt32
AddAtomic(
SInt32 amount,
SInt32 * address) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* BitAndAtomic()
*
* Summary:
* 32-bit logical and operation, performed atomically with respect
* to all devices that participate in the coherency architecture of
* the platform.
*
* Discussion:
* The BitAndAtomic function logically ands the bits of the
* specified mask into the value at the specified address and
* returns the original value. This function guarantees atomicity
* only with main system memory. It is specifically unsuitable for
* use on noncacheable memory such as that in devices; this function
* cannot guarantee atomicity, for example, on memory mapped from a
* PCI device.
*
* Parameters:
*
* mask:
* The mask to logically and with the value.
*
* address:
* The 4-byte aligned address of the value to update atomically.
*
* Result:
* The value before the bitwise operation
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 8.5 and later
*/
extern UInt32
BitAndAtomic(
UInt32 mask,
UInt32 * address) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* BitOrAtomic()
*
* Summary:
* 32-bit logical or operation, performed atomically with respect to
* all devices that participate in the coherency architecture of the
* platform.
*
* Discussion:
* The BitOrAtomic function logically ors the bits of the specified
* mask into the value at the specified address and returns the
* original value. This function guarantees atomicity only with main
* system memory. It is specifically unsuitable for use on
* noncacheable memory such as that in devices; this function cannot
* guarantee atomicity, for example, on memory mapped from a PCI
* device.
*
* Parameters:
*
* mask:
* The mask to logically or with the value.
*
* address:
* The 4-byte aligned address of the value to update atomically.
*
* Result:
* The value before the bitwise operation.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 8.5 and later
*/
extern UInt32
BitOrAtomic(
UInt32 mask,
UInt32 * address) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* BitXorAtomic()
*
* Summary:
* 32-bit logical xor operation, performed atomically with respect
* to all devices that participate in the coherency architecture of
* the platform. This function guarantees atomicity only with main
* system memory. It is specifically unsuitable for use on
* noncacheable memory such as that in devices; this function cannot
* guarantee atomicity, for example, on memory mapped from a PCI
* device.
*
* Discussion:
* The BitXorAtomic function logically xors the bits of the
* specified mask into the value at the specified address and
* returns the original value.
*
* Parameters:
*
* mask:
* The mask to logically or with the value.
*
* address:
* The 4-byte aligned address of the value to update atomically.
*
* Result:
* The value before the bitwise operation.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 8.5 and later
*/
extern UInt32
BitXorAtomic(
UInt32 mask,
UInt32 * address) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
#ifdef __cplusplus
}
#endif
#endif /* __DRIVERSYNCHRONIZATION__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework/Headers/AVLTree.h | /*
File: CarbonCore/AVLTree.h
Contains: Interfaces for AVL balanced trees.
The contents of this header file are deprecated.
Copyright: © 1999-2011 by Apple Inc. All rights reserved.
*/
#ifndef __AVLTREE__
#define __AVLTREE__
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
#ifndef __MIXEDMODE__
#include <CarbonCore/MixedMode.h>
#endif
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
#pragma pack(push, 2)
/*
* AVLVisitStage
*
* Discussion:
* The visit stage for AVLWalk() walkProcs
*/
typedef UInt16 AVLVisitStage;
enum {
/*
* Passed the first time AVLWalk iterates thru a given node.
*/
kAVLPreOrder = 0,
/*
* Passed the AVLWalk iterates thru a given node when it is 'in
* order'.
*/
kAVLInOrder = 1,
/*
* Passed the last time AVLWalk iterates thru a given node.
*/
kAVLPostOrder = 2
};
/*
* AVLOrder
*
* Discussion:
* The order the tree is walked or disposed of.
*/
typedef UInt16 AVLOrder;
enum {
/*
* Walk the tree in left-to-right order ( smaller to bigger, usually )
*/
kLeftToRight = 0,
/*
* Walk the tree in right-to-left order ( bigger to smaller, usually )
*/
kRightToLeft = 1
};
/*
* AVLNodeType
*
* Discussion:
* The type of the node being passed to a callback proc.
*/
typedef UInt16 AVLNodeType;
enum {
kAVLIsTree = 0,
kAVLIsLeftBranch = 1,
kAVLIsRightBranch = 2,
kAVLIsLeaf = 3,
kAVLNullNode = 4
};
enum {
errItemAlreadyInTree = -960,
errNotValidTree = -961,
errItemNotFoundInTree = -962,
errCanNotInsertWhileWalkProcInProgress = -963,
errTreeIsLocked = -964
};
/*
* AVLTreeStruct
*
* Summary:
* An opaque structure for a balanced binary tree.
*
* Discussion:
* The structure of a tree. It's opaque; don't assume it's 36 bytes
* in size.
*/
struct AVLTreeStruct {
OSType signature;
unsigned long privateStuff[8];
};
typedef struct AVLTreeStruct AVLTreeStruct;
typedef AVLTreeStruct * AVLTreePtr;
/*
* AVLCompareItemsProcPtr
*
* Summary:
* A callback function which compares two data items and returns
* their ordering.
*
* Discussion:
* Every tree must have a function which compares the data for two
* items and returns < 0, 0, or >0 for the items - < 0 if the first
* item is 'before' the second item according to some criteria, == 0
* if the two items are identical according to the criteria, or > 0
* if the first item is 'after' the second item according to the
* criteria. The comparison function is also passed the node type,
* but most of the time this can be ignored.
*
* Parameters:
*
* tree:
* The tree which contains the items being compared
*
* i1:
* A pointer to the first item
*
* i2:
* A pointer to the second item
*
* nd_typ:
* The type of the nodes being compared. This is not terribly
* useful most of the time.
*
* Result:
* A value < 0 if i1 is 'before' i2, > 0 if i1 is 'after' i2, or ==
* 0 if i1 is equal to i2.
*/
typedef CALLBACK_API( SInt32 , AVLCompareItemsProcPtr )(AVLTreePtr tree, const void *i1, const void *i2, AVLNodeType nd_typ);
/*
* AVLItemSizeProcPtr
*
* Summary:
* A callback function which returns the size of an item.
*
* Discussion:
* Every tree must have a itemSizeProc; this routine gets passed a
* pointer to the item's data and returns the size of the data. If
* a tree contains records of a fixed size, this function can just
* return sizeof( that-struct ); otherwise it should calculate the
* size of the item based on the data for the item.
*
* Parameters:
*
* tree:
* The tree which contains the item whose size is being requested.
*
* itemPtr:
* A pointer to the item whose size is being returned.
*
* Result:
* The size of the item.
*/
typedef CALLBACK_API( ByteCount , AVLItemSizeProcPtr )(AVLTreePtr tree, const void *itemPtr);
/*
* AVLDisposeItemProcPtr
*
* Summary:
* Dispose of any additional memory associated with an item in the
* tree.
*
* Discussion:
* A tree may have an optional disposeItemProc, which gets called
* whenever an item is removed from the tree ( via AVLRemove() or
* when AVLDispose() deletes all of the items in the tree ). This
* might be useful if the nodes in the tree own 'resources' ( like,
* open files ) which should be released before the item is removed.
*
* Parameters:
*
* tree:
* The tree containing the item being disposed.
*
* dataP:
* A pointer to the data for the item being disposed.
*/
typedef CALLBACK_API( void , AVLDisposeItemProcPtr )(AVLTreePtr tree, const void *dataP);
/*
* AVLWalkProcPtr
*
* Summary:
* A callback function which gets passed each item in the tree, in a
* specified order.
*
* Discussion:
* The common way to iterate across all of the items in a tree is
* via AVLWalk(), which takes a walkProcPtr. This function will get
* called for every item in the tree three times, as the tree is
* being walked across. First, the walkProc will get called with
* visitStage == kAVLPreOrder, at which point internally the node of
* the tree for the given data has just been reached. Later, this
* function will get called with visitStage == kAVLInOrder, and
* lastly this function will get called with visitStage ==
* kAVLPostOrder. The 'minimum' item in the tree will get called
* with visitStage == kInOrder first, followed by the 'next' item in
* the tree, up until the last item in the tree structure is called.
* In general, you'll only care about calls to this function when
* visitStage == kAVLInOrder.
*
* Parameters:
*
* tree:
* The tree being walked.
*
* dataPtr:
* A pointer to the data for an item in the tree.
*
* visitStage:
* The stage of the walk for the given node.
*
* node:
* The type of the given node. This is not terribly useful most of
* the time.
*
* level:
* How 'deep' in the tree the given node is. This is not terribly
* useful most of the time.
*
* balance:
* How balanced the given node in the tree is. This is not
* terribly useful most of the time.
*
* refCon:
* The refCon passed into AVLWalk() for this call.
*
* Result:
* Return 0 to continue walking the tree, or 1 to terminate.
*/
typedef CALLBACK_API( OSErr , AVLWalkProcPtr )(AVLTreePtr tree, const void *dataPtr, AVLVisitStage visitStage, AVLNodeType node, UInt32 level, SInt32 balance, void *refCon);
typedef STACK_UPP_TYPE(AVLCompareItemsProcPtr) AVLCompareItemsUPP;
typedef STACK_UPP_TYPE(AVLItemSizeProcPtr) AVLItemSizeUPP;
typedef STACK_UPP_TYPE(AVLDisposeItemProcPtr) AVLDisposeItemUPP;
typedef STACK_UPP_TYPE(AVLWalkProcPtr) AVLWalkUPP;
/*
* NewAVLCompareItemsUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern AVLCompareItemsUPP
NewAVLCompareItemsUPP(AVLCompareItemsProcPtr userRoutine) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* NewAVLItemSizeUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern AVLItemSizeUPP
NewAVLItemSizeUPP(AVLItemSizeProcPtr userRoutine) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* NewAVLDisposeItemUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern AVLDisposeItemUPP
NewAVLDisposeItemUPP(AVLDisposeItemProcPtr userRoutine) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* NewAVLWalkUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern AVLWalkUPP
NewAVLWalkUPP(AVLWalkProcPtr userRoutine) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* DisposeAVLCompareItemsUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
DisposeAVLCompareItemsUPP(AVLCompareItemsUPP userUPP) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* DisposeAVLItemSizeUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
DisposeAVLItemSizeUPP(AVLItemSizeUPP userUPP) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* DisposeAVLDisposeItemUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
DisposeAVLDisposeItemUPP(AVLDisposeItemUPP userUPP) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* DisposeAVLWalkUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
DisposeAVLWalkUPP(AVLWalkUPP userUPP) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* InvokeAVLCompareItemsUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern SInt32
InvokeAVLCompareItemsUPP(
AVLTreePtr tree,
const void * i1,
const void * i2,
AVLNodeType nd_typ,
AVLCompareItemsUPP userUPP) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* InvokeAVLItemSizeUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern ByteCount
InvokeAVLItemSizeUPP(
AVLTreePtr tree,
const void * itemPtr,
AVLItemSizeUPP userUPP) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* InvokeAVLDisposeItemUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
InvokeAVLDisposeItemUPP(
AVLTreePtr tree,
const void * dataP,
AVLDisposeItemUPP userUPP) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* InvokeAVLWalkUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern OSErr
InvokeAVLWalkUPP(
AVLTreePtr tree,
const void * dataPtr,
AVLVisitStage visitStage,
AVLNodeType node,
UInt32 level,
SInt32 balance,
void * refCon,
AVLWalkUPP userUPP) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
#if __MACH__
#ifdef __cplusplus
inline AVLCompareItemsUPP NewAVLCompareItemsUPP(AVLCompareItemsProcPtr userRoutine) { return userRoutine; }
inline AVLItemSizeUPP NewAVLItemSizeUPP(AVLItemSizeProcPtr userRoutine) { return userRoutine; }
inline AVLDisposeItemUPP NewAVLDisposeItemUPP(AVLDisposeItemProcPtr userRoutine) { return userRoutine; }
inline AVLWalkUPP NewAVLWalkUPP(AVLWalkProcPtr userRoutine) { return userRoutine; }
inline void DisposeAVLCompareItemsUPP(AVLCompareItemsUPP) { }
inline void DisposeAVLItemSizeUPP(AVLItemSizeUPP) { }
inline void DisposeAVLDisposeItemUPP(AVLDisposeItemUPP) { }
inline void DisposeAVLWalkUPP(AVLWalkUPP) { }
inline SInt32 InvokeAVLCompareItemsUPP(AVLTreePtr tree, const void * i1, const void * i2, AVLNodeType nd_typ, AVLCompareItemsUPP userUPP) { return (*userUPP)(tree, i1, i2, nd_typ); }
inline ByteCount InvokeAVLItemSizeUPP(AVLTreePtr tree, const void * itemPtr, AVLItemSizeUPP userUPP) { return (*userUPP)(tree, itemPtr); }
inline void InvokeAVLDisposeItemUPP(AVLTreePtr tree, const void * dataP, AVLDisposeItemUPP userUPP) { (*userUPP)(tree, dataP); }
inline OSErr InvokeAVLWalkUPP(AVLTreePtr tree, const void * dataPtr, AVLVisitStage visitStage, AVLNodeType node, UInt32 level, SInt32 balance, void * refCon, AVLWalkUPP userUPP) { return (*userUPP)(tree, dataPtr, visitStage, node, level, balance, refCon); }
#else
#define NewAVLCompareItemsUPP(userRoutine) ((AVLCompareItemsUPP)userRoutine)
#define NewAVLItemSizeUPP(userRoutine) ((AVLItemSizeUPP)userRoutine)
#define NewAVLDisposeItemUPP(userRoutine) ((AVLDisposeItemUPP)userRoutine)
#define NewAVLWalkUPP(userRoutine) ((AVLWalkUPP)userRoutine)
#define DisposeAVLCompareItemsUPP(userUPP)
#define DisposeAVLItemSizeUPP(userUPP)
#define DisposeAVLDisposeItemUPP(userUPP)
#define DisposeAVLWalkUPP(userUPP)
#define InvokeAVLCompareItemsUPP(tree, i1, i2, nd_typ, userUPP) (*userUPP)(tree, i1, i2, nd_typ)
#define InvokeAVLItemSizeUPP(tree, itemPtr, userUPP) (*userUPP)(tree, itemPtr)
#define InvokeAVLDisposeItemUPP(tree, dataP, userUPP) (*userUPP)(tree, dataP)
#define InvokeAVLWalkUPP(tree, dataPtr, visitStage, node, level, balance, refCon, userUPP) (*userUPP)(tree, dataPtr, visitStage, node, level, balance, refCon)
#endif
#endif
#if !__LP64__
/*
* AVLInit() *** DEPRECATED ***
*
* Summary:
* Create an AVL ( balanced binary ) tree
*
* Discussion:
* Create an AVL tree. The compareItemsProc and the sizeItemProc
* are required; disposeItemProc is optional and can be nil. The
* refCon is stored with the list, and is passed back to the
* compareItemsProc, sizeItemProc, and disposeItemsProc calls. The
* allocation of the tree ( and all nodes later added to the list
* with AVLInsert ) will be created in what is the current zone at
* the time AVLInit() is called. Always call AVLDispose() to
* dispose of a list created with AVLInit().
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* flags:
* Creation flags. Currently, no flags are defined, so pass 0.
*
* compareItemsProc:
* A UPP for a function which compares two data items, and returns
* a value which is < 0, == 0, or > 0 depending on whether the
* first item is 'before', 'equal', or 'after' the first item.
*
* sizeItemProc:
* A UPP for a function which takes a pointer to a data item, and
* returns the size in bytes which it requires to store.
*
* disposeItemProc:
* A UPP for a function which takes a pointer to a data item, and
* disposes of any memory which may have been allocated for the
* item. This does not need to dispose of the item itself ( the
* AVLTree Manager will do that ), only any memory which the item
* passed in may be pointing to. This function may be NULL if
* data items do not use any memory besides that taken up by the
* item itself.
*
* refCon:
* A 32 bit quantity which is stored with this tree, and can be
* retrieved at an time ( and in a callback, if desired ) with
* AVLGetRefcon().
*
* tree:
* The created AVLTree, or NULL if there is an error.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 9.0 and later
*/
extern OSErr
AVLInit(
UInt32 flags,
AVLCompareItemsUPP compareItemsProc,
AVLItemSizeUPP sizeItemProc,
AVLDisposeItemUPP disposeItemProc,
void * refCon,
AVLTreePtr * tree) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* AVLDispose() *** DEPRECATED ***
*
* Summary:
* Dispose of an AVL tree created with AVLInit()
*
* Discussion:
* Dispose of an AVL tree. This will dispose of each item in the
* tree in the order specified, call the tree's disposeProc proc for
* each item, and then dispose of the space allocated for the tree
* itself.
*
* Mac OS X threading:
* Thread safe
* AVLDispose is thread safe provided no other thread is still using
* the tree being dispose.
*
* Parameters:
*
* tree:
* The tree to dispose, which was created with AVLInit().
*
* order:
* The order to dispose of the items in the tree.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 9.0 and later
*/
extern OSErr
AVLDispose(
AVLTreePtr * tree,
AVLOrder order) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* AVLWalk() *** DEPRECATED ***
*
* Summary:
* Iterate across all of the items in an AVL tree, in a specified
* order.
*
* Discussion:
* Iterate across all of the items in the tree, in the order
* specified. kLeftToRight is basically lowest-to-highest order,
* kRightToLeft is highest-to-lowest order. For each node in the
* tree, it will call the walkProc with three messages ( at the
* appropriate time ). First, with kAVLPreOrder when the walking
* gets to this node in the tree, before handling either the left or
* right subtree, secondly, with kAVLInOrder after handling one
* subtree but before handling the other, and lastly with
* kAVLPostOrder after handling both subtrees. If you want to
* handle items in order, then only do something if the visit stage
* is kAVLInOrder. You can only call AVLRemove() from inside a
* walkProc if visit stage is kAVLPostOrder ( because if you remove
* a node during the pre or in order stages you will corrupt the
* list ) OR if you return a non-zero result from the walkProc call
* which called AVLRemove() to immediately terminate the walkProc.
* Do not call AVLInsert() to insert a node into the tree from
* inside a walkProc. The walkProc function gets called with the
* AVLTreePtr, a pointer to the data for the current node ( which
* you can change in place as long as you do not affect the order
* within the tree ), the visit stage, the type of the current node
* ( leaf node, right or left branch, or full tree ), the level
* within the tree ( the root is level 1 ), the balance for the
* current node, and the refCon passed to AVLWalk(). This refCon is
* different from the one passed into AVLInit(); use AVLGetRefCon()
* to get that refCon if you want it inside a walkProc. ( Most
* walkProcs will not care about the values for node type, level, or
* balance. )
*
* Mac OS X threading:
* Thread safe
* AVLWalk is thread safe as long as no other thread tries to modify
* the tree by inserting or removing an item, or disposing of the
* tree itself.
*
* Parameters:
*
* tree:
* The tree to dispose, which was created with AVLInit().
*
* walkProc:
* A UPP for a function which is called during the walk thru the
* tree for each item.
*
* order:
* The order to iterate thru the tree.
*
* walkRefCon:
* A 32 bit value passed to the walkProc each time it is called.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 9.0 and later
*/
extern OSErr
AVLWalk(
AVLTreePtr tree,
AVLWalkUPP walkProc,
AVLOrder order,
void * walkRefCon) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* AVLCount() *** DEPRECATED ***
*
* Summary:
* Return the number of items in the given tree.
*
* Discussion:
* Return the number of items in the given tree.
*
* Mac OS X threading:
* Thread safe
* AVLCount is thread safe as long as no other thread tries to
* modify the tree by inserting or removing an item, or disposing of
* the tree itself.
*
* Parameters:
*
* tree:
* The tree to return the count of items for.
*
* count:
* On return, the count of items ( 1-based ) in the tree.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 9.0 and later
*/
extern OSErr
AVLCount(
AVLTreePtr tree,
UInt32 * count) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* AVLGetIndItem() *** DEPRECATED ***
*
* Summary:
* Return the data of the index-th item from the tree.
*
* Discussion:
* Return the one-based index-th item from the tree by putting it's
* data at dataPtr if dataPtr is non-nil, and it's size into
* *itemSize if itemSize is non-nil. If index is out of range,
* return errItemNotFoundInTree. ( Internally, this does an
* AVLWalk(), so the tree can not be modified while this call is in
* progress ).
*
* Mac OS X threading:
* Thread safe
* AVLGetIndItem is thread safe as long as no other thread tries to
* modify the tree by inserting or removing an item, or disposing of
* the tree itself.
*
* Parameters:
*
* tree:
* The tree to return the index-th items for.
*
* index:
* A index of the item to return. The 'first' item in the tree is
* index = 1, the last item is index = the count of items in the
* tree.
*
* dataPtr:
* An address in memory to return the data for the item, or NULL
* if you don not want data returned. The memory point to must be
* large enough to hold all of the data for the item.
*
* itemSize:
* On return, the size of the data for the index-th item. If you
* do not care about the size of the data, pass NULL.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 9.0 and later
*/
extern OSErr
AVLGetIndItem(
AVLTreePtr tree,
UInt32 index,
void * dataPtr,
ByteCount * itemSize) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* AVLInsert() *** DEPRECATED ***
*
* Summary:
* Insert an item into the tree.
*
* Discussion:
* Insert the given item into the tree. This will call the tree's
* sizeItemProc to determine how big the item at data is, and then
* will make a copy of the item and insert it into the tree in the
* appropriate place. If an item already exists in the tree with
* the same key ( so that the compareItemsUPP returns 0 when asked
* to compare this item to an existing one ), then it will return
* errItemNotFoundInTree.
*
* Mac OS X threading:
* Thread safe
* AVLInsert is thread safe as long as no other thread tries to walk
* or modify the tree by inserting or removing an item, or disposing
* of the tree itself.
*
* Parameters:
*
* tree:
* The tree to return the index-th items for.
*
* data:
* A pointer to the item to be inserted.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 9.0 and later
*/
extern OSErr
AVLInsert(
AVLTreePtr tree,
const void * data) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* AVLRemove() *** DEPRECATED ***
*
* Summary:
* Remove an item from the tree.
*
* Discussion:
* Remove any item from the tree with the given key. If dataPtr !=
* nil, then copy the item's data to dataPtr before removing it from
* the tree. Before removing the item, call the tree's
* disposeItemProc to let it release anything used by the data in
* the tree. It is not necessary to fill in a complete record for
* key, only that the compareItemsProc return 0 when asked to
* compare the data at key with the node in the tree to be deleted.
* If the item cannot be found in the tree, this will return
* errItemNotFoundInTree.
*
* Mac OS X threading:
* Thread safe
* AVLRemove is thread safe as long as no other thread tries to walk
* or modify the tree by inserting or removing an item, or disposing
* of the tree itself.
*
* Parameters:
*
* tree:
* The tree to return the index-th items for.
*
* key:
* A pointer to the item to be removed ( or, enough of the item
* that it can be found in the tree ).
*
* dataPtr:
* An address in memory to return the data for the item, or NULL
* if you don not want data returned. The memory point to must be
* large enough to hold all of the data for the item.
*
* itemSize:
* On return, the size of the data for the index-th item. If you
* do not care about the size of the data, pass NULL.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 9.0 and later
*/
extern OSErr
AVLRemove(
AVLTreePtr tree,
const void * key,
void * dataPtr,
ByteCount * itemSize) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* AVLFind() *** DEPRECATED ***
*
* Summary:
* Remove an item from the tree.
*
* Discussion:
* Find the item in the tree with the given key, and return it's
* data in dataPtr ( if dataPtr != nil ), and it's size in *itemSize
* ( if itemSize != nil ). It is not necessary to fill in a
* complete record for key, only that the compareItemsProc return 0
* when asked to compare the data at key with the node in the tree
* to be deleted. If the item cannot be found in the tree, this
* will return errItemNotFoundInTree.
*
* Mac OS X threading:
* Thread safe
* AVLRemove is thread safe as long as no other thread tries to walk
* or modify the tree by inserting or removing an item, or disposing
* of the tree itself.
*
* Parameters:
*
* tree:
* The tree to return the index-th items for.
*
* key:
* A pointer to the item to be found ( or, enough of the item that
* it can be found in the tree ).
*
* dataPtr:
* An address in memory to return the data for the item, or NULL
* if you don not want data returned. The memory point to must be
* large enough to hold all of the data for the item.
*
* itemSize:
* On return, the size of the data for the index-th item. If you
* do not care about the size of the data, pass NULL.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 9.0 and later
*/
extern OSErr
AVLFind(
AVLTreePtr tree,
const void * key,
void * dataPtr,
ByteCount * itemSize) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* AVLGetRefcon() *** DEPRECATED ***
*
* Summary:
* Return the refCon set when the tree was created.
*
* Discussion:
* Get the refCon for the given tree ( set in AVLInit ) and return
* it.
*
* Mac OS X threading:
* Thread safe
* AVLGetRefcon is thread safe as long as no other thread tries to
* dispose of the tree itself.
*
* Parameters:
*
* tree:
* The tree to return the refcon for.
*
* refCon:
* On return, the refCon for the tree, or NULL if tree is invalid.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 9.0 and later
*/
extern OSErr
AVLGetRefcon(
AVLTreePtr tree,
void ** refCon) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
#endif /* !__LP64__ */
#pragma pack(pop)
#ifdef __cplusplus
}
#endif
#endif /* __AVLTREE__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework/Headers/Components.h | /*
File: CarbonCore/Components.h
Contains: Component Manager Interfaces.
The contents of this header file are deprecated.
Use Foundation or CoreFoundation bundles and plugins instead.
Copyright: © 1991-2011 by Apple Inc. All rights reserved.
*/
#ifndef __COMPONENTS__
#define __COMPONENTS__
#ifndef __MACERRORS__
#include <CarbonCore/MacErrors.h>
#endif
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
#ifndef __MIXEDMODE__
#include <CarbonCore/MixedMode.h>
#endif
#ifndef __FILES__
#include <CarbonCore/Files.h>
#endif
#ifndef __RESOURCES__
#include <CarbonCore/Resources.h>
#endif
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
#pragma pack(push, 2)
enum {
kAppleManufacturer = 'appl', /* Apple supplied components */
kComponentResourceType = 'thng', /* a components resource type */
kComponentAliasResourceType = 'thga' /* component alias resource type */
};
enum {
kAnyComponentType = 0,
kAnyComponentSubType = 0,
kAnyComponentManufacturer = 0,
kAnyComponentFlagsMask = 0
};
enum {
cmpThreadSafe = 1UL << 28, /* component is thread-safe */
cmpIsMissing = 1UL << 29,
cmpWantsRegisterMessage = 1UL << 31
};
enum {
kComponentOpenSelect = -1, /* ComponentInstance for this open */
kComponentCloseSelect = -2, /* ComponentInstance for this close */
kComponentCanDoSelect = -3, /* selector # being queried */
kComponentVersionSelect = -4, /* no params */
kComponentRegisterSelect = -5, /* no params */
kComponentTargetSelect = -6, /* ComponentInstance for top of call chain */
kComponentUnregisterSelect = -7, /* no params */
kComponentGetMPWorkFunctionSelect = -8, /* some params */
kComponentExecuteWiredActionSelect = -9, /* QTAtomContainer actionContainer, QTAtom actionAtom, QTCustomActionTargetPtr target, QTEventRecordPtr event */
kComponentGetPublicResourceSelect = -10 /* OSType resourceType, short resourceId, Handle *resource */
};
/* Component Resource Extension flags */
enum {
componentDoAutoVersion = (1 << 0),
componentWantsUnregister = (1 << 1),
componentAutoVersionIncludeFlags = (1 << 2),
componentHasMultiplePlatforms = (1 << 3),
componentLoadResident = (1 << 4)
};
/* Set Default Component flags */
enum {
defaultComponentIdentical = 0,
defaultComponentAnyFlags = 1,
defaultComponentAnyManufacturer = 2,
defaultComponentAnySubType = 4,
defaultComponentAnyFlagsAnyManufacturer = (defaultComponentAnyFlags + defaultComponentAnyManufacturer),
defaultComponentAnyFlagsAnyManufacturerAnySubType = (defaultComponentAnyFlags + defaultComponentAnyManufacturer + defaultComponentAnySubType)
};
/* RegisterComponentResource flags */
enum {
registerComponentGlobal = 1,
registerComponentNoDuplicates = 2,
registerComponentAfterExisting = 4,
registerComponentAliasesOnly = 8
};
struct ComponentDescription {
OSType componentType; /* A unique 4-byte code indentifying the command set */
OSType componentSubType; /* Particular flavor of this instance */
OSType componentManufacturer; /* Vendor indentification */
UInt32 componentFlags; /* 8 each for Component,Type,SubType,Manuf/revision */
UInt32 componentFlagsMask; /* Mask for specifying which flags to consider in search, zero during registration */
};
typedef struct ComponentDescription ComponentDescription;
struct ResourceSpec {
OSType resType; /* 4-byte code */
SInt16 resID; /* */
};
typedef struct ResourceSpec ResourceSpec;
struct ComponentResource {
ComponentDescription cd; /* Registration parameters */
ResourceSpec component; /* resource where Component code is found */
ResourceSpec componentName; /* name string resource */
ResourceSpec componentInfo; /* info string resource */
ResourceSpec componentIcon; /* icon resource */
};
typedef struct ComponentResource ComponentResource;
typedef ComponentResource * ComponentResourcePtr;
typedef ComponentResourcePtr * ComponentResourceHandle;
struct ComponentPlatformInfo {
SInt32 componentFlags; /* flags of Component */
ResourceSpec component; /* resource where Component code is found */
SInt16 platformType; /* gestaltSysArchitecture result */
};
typedef struct ComponentPlatformInfo ComponentPlatformInfo;
struct ComponentResourceExtension {
SInt32 componentVersion; /* version of Component */
SInt32 componentRegisterFlags; /* flags for registration */
SInt16 componentIconFamily; /* resource id of Icon Family */
};
typedef struct ComponentResourceExtension ComponentResourceExtension;
struct ComponentPlatformInfoArray {
SInt32 count;
ComponentPlatformInfo platformArray[1];
};
typedef struct ComponentPlatformInfoArray ComponentPlatformInfoArray;
struct ExtComponentResource {
ComponentDescription cd; /* registration parameters */
ResourceSpec component; /* resource where Component code is found */
ResourceSpec componentName; /* name string resource */
ResourceSpec componentInfo; /* info string resource */
ResourceSpec componentIcon; /* icon resource */
SInt32 componentVersion; /* version of Component */
SInt32 componentRegisterFlags; /* flags for registration */
SInt16 componentIconFamily; /* resource id of Icon Family */
SInt32 count; /* elements in platformArray */
ComponentPlatformInfo platformArray[1];
};
typedef struct ExtComponentResource ExtComponentResource;
typedef ExtComponentResource * ExtComponentResourcePtr;
typedef ExtComponentResourcePtr * ExtComponentResourceHandle;
struct ComponentAliasResource {
ComponentResource cr; /* Registration parameters */
ComponentDescription aliasCD; /* component alias description */
};
typedef struct ComponentAliasResource ComponentAliasResource;
/* Structure received by Component: */
struct ComponentParameters {
UInt8 flags; /* call modifiers: sync/async, deferred, immed, etc */
UInt8 paramSize; /* size in bytes of actual parameters passed to this call */
SInt16 what; /* routine selector, negative for Component management calls */
#if __LP64__
UInt32 padding;
#endif
long params[1]; /* actual parameters for the indicated routine */
};
typedef struct ComponentParameters ComponentParameters;
struct ComponentRecord {
long data[1];
};
typedef struct ComponentRecord ComponentRecord;
typedef ComponentRecord * Component;
struct ComponentInstanceRecord {
long data[1];
};
typedef struct ComponentInstanceRecord ComponentInstanceRecord;
typedef ComponentInstanceRecord * ComponentInstance;
struct RegisteredComponentRecord {
long data[1];
};
typedef struct RegisteredComponentRecord RegisteredComponentRecord;
typedef RegisteredComponentRecord * RegisteredComponentRecordPtr;
struct RegisteredComponentInstanceRecord {
long data[1];
};
typedef struct RegisteredComponentInstanceRecord RegisteredComponentInstanceRecord;
typedef RegisteredComponentInstanceRecord * RegisteredComponentInstanceRecordPtr;
typedef SInt32 ComponentResult;
enum {
platform68k = 1, /* platform type (response from gestaltComponentPlatform) */
platformPowerPC = 2, /* (when gestaltComponentPlatform is not implemented, use */
platformInterpreted = 3, /* gestaltSysArchitecture) */
platformWin32 = 4,
platformPowerPCNativeEntryPoint = 5,
platformIA32NativeEntryPoint = 6,
platformPowerPC64NativeEntryPoint = 7,
platformX86_64NativeEntryPoint = 8,
platformArm64NativeEntryPoint = 9
};
enum {
platformIRIXmips = 1000,
platformSunOSsparc = 1100,
platformSunOSintel = 1101,
platformLinuxppc = 1200,
platformLinuxintel = 1201,
platformAIXppc = 1300,
platformNeXTIntel = 1400,
platformNeXTppc = 1401,
platformNeXTsparc = 1402,
platformNeXT68k = 1403,
platformMacOSx86 = 1500
};
enum {
mpWorkFlagDoWork = (1 << 0),
mpWorkFlagDoCompletion = (1 << 1),
mpWorkFlagCopyWorkBlock = (1 << 2),
mpWorkFlagDontBlock = (1 << 3),
mpWorkFlagGetProcessorCount = (1 << 4),
mpWorkFlagGetIsRunning = (1 << 6)
};
enum {
cmpAliasNoFlags = 0,
cmpAliasOnlyThisFile = 1
};
typedef UInt32 CSComponentsThreadMode;
enum {
kCSAcceptAllComponentsMode = 0,
kCSAcceptThreadSafeComponentsOnlyMode = 1
};
/*
* CSSetComponentsThreadMode()
*
* Summary:
* Set whether or not using thread-unsafe components is allowed on
* the current thread.
*
* Discussion:
* When set to kCSAcceptThreadSafeComponentsOnlyMode, the current
* thread can only make thread-safe calls. Applications and other
* high-level code that wants to call QuickTime (and other) APIs
* from preemptive threads should call SetComponentsThreadMode(
* kCSAcceptThreadSafeComponentsOnlyMode ); from their thread
* beforehand. The safeguard flag should only be left
* kCSAcceptAllComponentsMode for the main thread and other threads
* that participate in cooperative locking with it (such as the
* Carbon Thread Manager-style cooperative threads and application
* threads that perform private locking).
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Parameters:
*
* mode:
* The thread-safety mode in current thread.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
CSSetComponentsThreadMode(CSComponentsThreadMode mode) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_3, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* CSGetComponentsThreadMode()
*
* Summary:
* Get the current thread's thread-safety mode.
*
* Discussion:
* Returns kCSAcceptThreadSafeComponentsOnlyMode if only thread-safe
* components are allowed in current thread and
* kCSAcceptAllComponentsMode if all components are accepted
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CSComponentsThreadMode
CSGetComponentsThreadMode(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_3, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
struct ComponentMPWorkFunctionHeaderRecord {
UInt32 headerSize;
UInt32 recordSize;
UInt32 workFlags;
UInt16 processorCount;
UInt8 unused;
UInt8 isRunning;
};
typedef struct ComponentMPWorkFunctionHeaderRecord ComponentMPWorkFunctionHeaderRecord;
typedef ComponentMPWorkFunctionHeaderRecord * ComponentMPWorkFunctionHeaderRecordPtr;
typedef CALLBACK_API( ComponentResult , ComponentMPWorkFunctionProcPtr )(void *globalRefCon, ComponentMPWorkFunctionHeaderRecordPtr header);
typedef CALLBACK_API( ComponentResult , ComponentRoutineProcPtr )(ComponentParameters *cp, Handle componentStorage);
typedef CALLBACK_API( OSErr , GetMissingComponentResourceProcPtr )(Component c, OSType resType, SInt16 resID, void *refCon, Handle *resource);
typedef STACK_UPP_TYPE(ComponentMPWorkFunctionProcPtr) ComponentMPWorkFunctionUPP;
typedef STACK_UPP_TYPE(ComponentRoutineProcPtr) ComponentRoutineUPP;
typedef STACK_UPP_TYPE(GetMissingComponentResourceProcPtr) GetMissingComponentResourceUPP;
/*
The parameter list for each ComponentFunction is unique. It is
therefore up to users to create the appropriate procInfo for their
own ComponentFunctions where necessary.
*/
typedef UniversalProcPtr ComponentFunctionUPP;
/*
* NewComponentFunctionUPP()
*
* Discussion:
* For use in writing a Carbon compliant Component. It is used to
* create a ComponentFunctionUPP needed to call
* CallComponentFunction in the Components dispatch routine.
*
* Mac OS X threading:
* Thread safe since version 10.0
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern ComponentFunctionUPP
NewComponentFunctionUPP(
ProcPtr userRoutine,
ProcInfoType procInfo) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* DisposeComponentFunctionUPP()
*
* Discussion:
* For use in writing a Carbon compliant Component. It is used to
* dispose of a ComponentFunctionUPP created by
* NewComponentFunctionUPP.
*
* Mac OS X threading:
* Thread safe since version 10.0
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
DisposeComponentFunctionUPP(ComponentFunctionUPP userUPP) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
#if TARGET_RT_MAC_CFM
/*
CallComponentUPP is a global variable exported from InterfaceLib.
It is the ProcPtr passed to CallUniversalProc to manually call a component function.
*/
/*
* CallComponentUPP
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern UniversalProcPtr CallComponentUPP;
#endif
#define ComponentCallNow( callNumber, paramSize ) \
FIVEWORDINLINE( 0x2F3C,paramSize,callNumber,0x7000,0xA82A )
/********************************************************
* *
* APPLICATION LEVEL CALLS *
* *
********************************************************/
/********************************************************
* Component Database Add, Delete, and Query Routines
********************************************************/
/*
* RegisterComponent()
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern Component
RegisterComponent(
ComponentDescription * cd,
ComponentRoutineUPP componentEntryPoint,
SInt16 global,
Handle componentName,
Handle componentInfo,
Handle componentIcon) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* RegisterComponentResource()
*
* Mac OS X threading:
* Not thread safe
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern Component
RegisterComponentResource(
ComponentResourceHandle cr,
SInt16 global) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* UnregisterComponent()
*
* Mac OS X threading:
* Not thread safe
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern OSErr
UnregisterComponent(Component aComponent) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* FindNextComponent()
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern Component
FindNextComponent(
Component aComponent,
ComponentDescription * looking) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* CountComponents()
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern long
CountComponents(ComponentDescription * looking) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* GetComponentInfo()
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern OSErr
GetComponentInfo(
Component aComponent,
ComponentDescription * cd,
Handle componentName,
Handle componentInfo,
Handle componentIcon) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* GetComponentListModSeed()
*
* Mac OS X threading:
* Not thread safe
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern SInt32
GetComponentListModSeed(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* GetComponentTypeModSeed()
*
* Mac OS X threading:
* Not thread safe
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib via QuickTime 2.5 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern SInt32
GetComponentTypeModSeed(OSType componentType) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/********************************************************
* Component Instance Allocation and dispatch routines
********************************************************/
/*
* OpenAComponent()
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib via QuickTime 2.5 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern OSErr
OpenAComponent(
Component aComponent,
ComponentInstance * ci) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* OpenComponent()
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern ComponentInstance
OpenComponent(Component aComponent) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* CloseComponent()
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern OSErr
CloseComponent(ComponentInstance aComponentInstance) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* GetComponentInstanceError()
*
* Mac OS X threading:
* Thread safe since version 10.4
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern OSErr
GetComponentInstanceError(ComponentInstance aComponentInstance) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/********************************************************
* Component aliases
********************************************************/
/*
* ResolveComponentAlias()
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib via QuickTime 3.0 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern Component
ResolveComponentAlias(Component aComponent) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/********************************************************
* Component public resources and public string lists
********************************************************/
/* Note: GetComponentPublicResource returns a Handle, not a resource. The caller must dispose it with DisposeHandle. */
/*
* GetComponentPublicResource()
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0.2 and later
* Non-Carbon CFM: in InterfaceLib via QuickTime 4.0 and later
*/
extern OSErr
GetComponentPublicResource(
Component aComponent,
OSType resourceType,
SInt16 resourceID,
Handle * theResource) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* GetComponentPublicResourceList()
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0.2 and later
* Non-Carbon CFM: in InterfaceLib via QuickTime 4.0 and later
*/
extern OSErr
GetComponentPublicResourceList(
OSType resourceType,
SInt16 resourceID,
SInt32 flags,
ComponentDescription * cd,
GetMissingComponentResourceUPP missingProc,
void * refCon,
void * atomContainerPtr) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* GetComponentPublicIndString()
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.3 and later
* Non-Carbon CFM: in InterfaceLib via QuickTime 4.0 and later
*/
extern OSErr
GetComponentPublicIndString(
Component aComponent,
Str255 theString,
SInt16 strListID,
SInt16 index) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/********************************************************
* *
* CALLS MADE BY COMPONENTS *
* *
********************************************************/
/********************************************************
* Component Management routines
********************************************************/
/*
* SetComponentInstanceError()
*
* Mac OS X threading:
* Thread safe since version 10.4
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern void
SetComponentInstanceError(
ComponentInstance aComponentInstance,
OSErr theError) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* GetComponentRefcon()
*
* Mac OS X threading:
* Thread safe since version 10.4
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern long
GetComponentRefcon(Component aComponent) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* SetComponentRefcon()
*
* Mac OS X threading:
* Thread safe since version 10.4
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern void
SetComponentRefcon(
Component aComponent,
long theRefcon) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* OpenComponentResFile()
*
* Mac OS X threading:
* Not thread safe
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern ResFileRefNum
OpenComponentResFile(Component aComponent) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* OpenAComponentResFile()
*
* Mac OS X threading:
* Not thread safe
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib via QuickTime 2.5 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern OSErr
OpenAComponentResFile(
Component aComponent,
ResFileRefNum * resRef) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* CloseComponentResFile()
*
* Mac OS X threading:
* Not thread safe
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern OSErr
CloseComponentResFile(ResFileRefNum refnum) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/* Note: GetComponentResource returns a Handle, not a resource. The caller must dispose it with DisposeHandle. */
/*
* GetComponentResource()
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib via QuickTime 3.0 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern OSErr
GetComponentResource(
Component aComponent,
OSType resType,
SInt16 resID,
Handle * theResource) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* GetComponentIndString()
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib via QuickTime 3.0 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern OSErr
GetComponentIndString(
Component aComponent,
Str255 theString,
SInt16 strListID,
SInt16 index) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/********************************************************
* Component Instance Management routines
********************************************************/
/*
* GetComponentInstanceStorage()
*
* Mac OS X threading:
* Thread safe since version 10.4
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern Handle
GetComponentInstanceStorage(ComponentInstance aComponentInstance) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* SetComponentInstanceStorage()
*
* Mac OS X threading:
* Thread safe since version 10.4
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern void
SetComponentInstanceStorage(
ComponentInstance aComponentInstance,
Handle theStorage) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* CountComponentInstances()
*
* Mac OS X threading:
* Thread safe since version 10.4
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern long
CountComponentInstances(Component aComponent) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/* useful helper routines for convenient method dispatching */
/*
* CallComponentFunction()
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern ComponentResult
CallComponentFunction(
ComponentParameters * params,
ComponentFunctionUPP func) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* CallComponentFunctionWithStorage()
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern ComponentResult
CallComponentFunctionWithStorage(
Handle storage,
ComponentParameters * params,
ComponentFunctionUPP func) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* CallComponentFunctionWithStorageProcInfo()
*
* Mac OS X threading:
* Not thread safe
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib via QuickTime 2.5 and later
*/
extern ComponentResult
CallComponentFunctionWithStorageProcInfo(
Handle storage,
ComponentParameters * params,
ProcPtr func,
ProcInfoType funcProcInfo) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* DelegateComponentCall()
*
* Mac OS X threading:
* Not thread safe
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern ComponentResult
DelegateComponentCall(
ComponentParameters * originalParams,
ComponentInstance ci) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* SetDefaultComponent()
*
* Mac OS X threading:
* Not thread safe
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern OSErr
SetDefaultComponent(
Component aComponent,
SInt16 flags) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* OpenDefaultComponent()
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern ComponentInstance
OpenDefaultComponent(
OSType componentType,
OSType componentSubType) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* OpenADefaultComponent()
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib via QuickTime 2.5 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern OSErr
OpenADefaultComponent(
OSType componentType,
OSType componentSubType,
ComponentInstance * ci) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* CaptureComponent()
*
* Mac OS X threading:
* Thread safe since version 10.4
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern Component
CaptureComponent(
Component capturedComponent,
Component capturingComponent) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* UncaptureComponent()
*
* Mac OS X threading:
* Thread safe since version 10.4
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern OSErr
UncaptureComponent(Component aComponent) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* RegisterComponentResourceFile()
*
* Mac OS X threading:
* Not thread safe
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern SInt32
RegisterComponentResourceFile(
SInt16 resRefNum,
SInt16 global) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/* This call is deprecated. Please use GetIconRefFromComponent() instead.*/
#if !__LP64__
/*
* GetComponentIconSuite()
*
* Mac OS X threading:
* Not thread safe
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only]
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern OSErr
GetComponentIconSuite(
Component aComponent,
Handle * iconSuite) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
#endif /* !__LP64__ */
/*
* These calls allow you to register a file system entity. The
* Component Manager will "do the right thing" with the entity,
* whether it is a standard resource fork based CFM component, CFM
* bundle, mach-o bundle, or packaged bundle.
*
* The *Entries calls allow you to specify a component description
* which will be used to register selective components. (Passing
* NULL, 0 means to register all components.
*/
#if !__LP64__
/*
* RegisterComponentFile() *** DEPRECATED ***
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern OSErr
RegisterComponentFile(
const FSSpec * spec,
short global) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* RegisterComponentFileEntries() *** DEPRECATED ***
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern OSErr
RegisterComponentFileEntries(
const FSSpec * spec,
short global,
const ComponentDescription * toRegister, /* can be NULL */
UInt32 registerCount) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
#endif /* !__LP64__ */
/*
* RegisterComponentFileRef()
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern OSErr
RegisterComponentFileRef(
const FSRef * ref,
SInt16 global) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* RegisterComponentFileRefEntries()
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern OSErr
RegisterComponentFileRefEntries(
const FSRef * ref,
SInt16 global,
const ComponentDescription * toRegister, /* can be NULL */
UInt32 registerCount) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/********************************************************
* *
* Direct calls to the Components *
* *
********************************************************/
/* Old style names*/
#if !__LP64__
/*
* ComponentFunctionImplemented() *** DEPRECATED ***
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern ComponentResult
ComponentFunctionImplemented(
ComponentInstance ci,
SInt16 ftnNumber) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* GetComponentVersion() *** DEPRECATED ***
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern ComponentResult
GetComponentVersion(ComponentInstance ci) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* ComponentSetTarget() *** DEPRECATED ***
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern ComponentResult
ComponentSetTarget(
ComponentInstance ci,
ComponentInstance target) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/* New style names*/
#endif /* !__LP64__ */
/*
* CallComponentOpen()
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib via QuickTime 2.5 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern ComponentResult
CallComponentOpen(
ComponentInstance ci,
ComponentInstance self) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* CallComponentClose()
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib via QuickTime 2.5 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern ComponentResult
CallComponentClose(
ComponentInstance ci,
ComponentInstance self) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* CallComponentCanDo()
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib via QuickTime 2.5 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern ComponentResult
CallComponentCanDo(
ComponentInstance ci,
SInt16 ftnNumber) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* CallComponentVersion()
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib via QuickTime 2.5 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern ComponentResult
CallComponentVersion(ComponentInstance ci) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* CallComponentRegister()
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib via QuickTime 2.5 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern ComponentResult
CallComponentRegister(ComponentInstance ci) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* CallComponentTarget()
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib via QuickTime 2.5 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern ComponentResult
CallComponentTarget(
ComponentInstance ci,
ComponentInstance target) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* CallComponentUnregister()
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib via QuickTime 2.5 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern ComponentResult
CallComponentUnregister(ComponentInstance ci) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* CallComponentGetMPWorkFunction()
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib via QuickTime 2.5 and later
* Windows: in qtmlClient.lib 3.0 and later
*/
extern ComponentResult
CallComponentGetMPWorkFunction(
ComponentInstance ci,
ComponentMPWorkFunctionUPP * workFunction,
void ** refCon) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* CallComponentGetPublicResource()
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in InterfaceLib via QuickTime 4.0 and later
*/
extern ComponentResult
CallComponentGetPublicResource(
ComponentInstance ci,
OSType resourceType,
SInt16 resourceID,
Handle * resource) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
CallComponentDispatch is a CarbonLib routine that replaces CallComponent inline glue
to call a component function.
*/
/*
* CallComponentDispatch()
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: not available
*/
extern ComponentResult
CallComponentDispatch(ComponentParameters * cp) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/* UPP call backs */
/*
* NewComponentMPWorkFunctionUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern ComponentMPWorkFunctionUPP
NewComponentMPWorkFunctionUPP(ComponentMPWorkFunctionProcPtr userRoutine) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* NewComponentRoutineUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern ComponentRoutineUPP
NewComponentRoutineUPP(ComponentRoutineProcPtr userRoutine) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* NewGetMissingComponentResourceUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern GetMissingComponentResourceUPP
NewGetMissingComponentResourceUPP(GetMissingComponentResourceProcPtr userRoutine) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* DisposeComponentMPWorkFunctionUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
DisposeComponentMPWorkFunctionUPP(ComponentMPWorkFunctionUPP userUPP) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* DisposeComponentRoutineUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
DisposeComponentRoutineUPP(ComponentRoutineUPP userUPP) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* DisposeGetMissingComponentResourceUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
DisposeGetMissingComponentResourceUPP(GetMissingComponentResourceUPP userUPP) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* InvokeComponentMPWorkFunctionUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern ComponentResult
InvokeComponentMPWorkFunctionUPP(
void * globalRefCon,
ComponentMPWorkFunctionHeaderRecordPtr header,
ComponentMPWorkFunctionUPP userUPP) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* InvokeComponentRoutineUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern ComponentResult
InvokeComponentRoutineUPP(
ComponentParameters * cp,
Handle componentStorage,
ComponentRoutineUPP userUPP) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* InvokeGetMissingComponentResourceUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern OSErr
InvokeGetMissingComponentResourceUPP(
Component c,
OSType resType,
SInt16 resID,
void * refCon,
Handle * resource,
GetMissingComponentResourceUPP userUPP) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
#if __MACH__
#ifdef __cplusplus
inline ComponentMPWorkFunctionUPP NewComponentMPWorkFunctionUPP(ComponentMPWorkFunctionProcPtr userRoutine) { return userRoutine; }
inline ComponentRoutineUPP NewComponentRoutineUPP(ComponentRoutineProcPtr userRoutine) { return userRoutine; }
inline GetMissingComponentResourceUPP NewGetMissingComponentResourceUPP(GetMissingComponentResourceProcPtr userRoutine) { return userRoutine; }
inline void DisposeComponentMPWorkFunctionUPP(ComponentMPWorkFunctionUPP) { }
inline void DisposeComponentRoutineUPP(ComponentRoutineUPP) { }
inline void DisposeGetMissingComponentResourceUPP(GetMissingComponentResourceUPP) { }
inline ComponentResult InvokeComponentMPWorkFunctionUPP(void * globalRefCon, ComponentMPWorkFunctionHeaderRecordPtr header, ComponentMPWorkFunctionUPP userUPP) { return (*userUPP)(globalRefCon, header); }
inline ComponentResult InvokeComponentRoutineUPP(ComponentParameters * cp, Handle componentStorage, ComponentRoutineUPP userUPP) { return (*userUPP)(cp, componentStorage); }
inline OSErr InvokeGetMissingComponentResourceUPP(Component c, OSType resType, SInt16 resID, void * refCon, Handle * resource, GetMissingComponentResourceUPP userUPP) { return (*userUPP)(c, resType, resID, refCon, resource); }
#else
#define NewComponentMPWorkFunctionUPP(userRoutine) ((ComponentMPWorkFunctionUPP)userRoutine)
#define NewComponentRoutineUPP(userRoutine) ((ComponentRoutineUPP)userRoutine)
#define NewGetMissingComponentResourceUPP(userRoutine) ((GetMissingComponentResourceUPP)userRoutine)
#define DisposeComponentMPWorkFunctionUPP(userUPP)
#define DisposeComponentRoutineUPP(userUPP)
#define DisposeGetMissingComponentResourceUPP(userUPP)
#define InvokeComponentMPWorkFunctionUPP(globalRefCon, header, userUPP) (*userUPP)(globalRefCon, header)
#define InvokeComponentRoutineUPP(cp, componentStorage, userUPP) (*userUPP)(cp, componentStorage)
#define InvokeGetMissingComponentResourceUPP(c, resType, resID, refCon, resource, userUPP) (*userUPP)(c, resType, resID, refCon, resource)
#endif
#endif
/* ProcInfos */
/* MixedMode ProcInfo constants for component calls */
enum {
uppComponentFunctionImplementedProcInfo = 0x000002F0,
uppGetComponentVersionProcInfo = 0x000000F0,
uppComponentSetTargetProcInfo = 0x000003F0,
uppCallComponentOpenProcInfo = 0x000003F0,
uppCallComponentCloseProcInfo = 0x000003F0,
uppCallComponentCanDoProcInfo = 0x000002F0,
uppCallComponentVersionProcInfo = 0x000000F0,
uppCallComponentRegisterProcInfo = 0x000000F0,
uppCallComponentTargetProcInfo = 0x000003F0,
uppCallComponentUnregisterProcInfo = 0x000000F0,
uppCallComponentGetMPWorkFunctionProcInfo = 0x00000FF0,
uppCallComponentGetPublicResourceProcInfo = 0x00003BF0
};
#pragma pack(pop)
#ifdef __cplusplus
}
#endif
#endif /* __COMPONENTS__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework/Headers/AIFF.h | /*
File: CarbonCore/AIFF.h
Contains: Definition of AIFF file format components.
The contents of this header file are deprecated.
Copyright: © 1989-2011 by Apple Inc. All rights reserved.
*/
#ifndef __AIFF__
#define __AIFF__
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
#include <stdint.h> /* uint32_t */
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#pragma pack(push, 2)
enum {
AIFFID = 'AIFF',
AIFCID = 'AIFC',
FormatVersionID = 'FVER',
CommonID = 'COMM',
FORMID = 'FORM',
SoundDataID = 'SSND',
MarkerID = 'MARK',
InstrumentID = 'INST',
MIDIDataID = 'MIDI',
AudioRecordingID = 'AESD',
ApplicationSpecificID = 'APPL',
CommentID = 'COMT',
NameID = 'NAME',
AuthorID = 'AUTH',
CopyrightID = '(c) ',
AnnotationID = 'ANNO'
};
enum {
NoLooping = 0,
ForwardLooping = 1,
ForwardBackwardLooping = 2
};
enum {
/* AIFF-C Versions */
AIFCVersion1 = (uint32_t)0xA2805140
};
/* Compression Names */
#define NoneName "\pnot compressed"
#define ACE2to1Name "\pACE 2-to-1"
#define ACE8to3Name "\pACE 8-to-3"
#define MACE3to1Name "\pMACE 3-to-1"
#define MACE6to1Name "\pMACE 6-to-1"
enum {
/* Compression Types */
NoneType = 'NONE',
ACE2Type = 'ACE2',
ACE8Type = 'ACE8',
MACE3Type = 'MAC3',
MACE6Type = 'MAC6'
};
/*
AIFF.h use to define a type, ID, which causes conflicts with other headers and application which want to use
this pretty common name as their own type. If you were previously relying on this being defined here, you
should either define it yourself or change your references to it into a UInt32.
typedef UInt32 ID;
*/
typedef SInt16 MarkerIdType;
struct ChunkHeader {
UInt32 ckID;
SInt32 ckSize;
};
typedef struct ChunkHeader ChunkHeader;
struct ContainerChunk {
UInt32 ckID;
SInt32 ckSize;
UInt32 formType;
};
typedef struct ContainerChunk ContainerChunk;
struct FormatVersionChunk {
UInt32 ckID;
SInt32 ckSize;
UInt32 timestamp;
};
typedef struct FormatVersionChunk FormatVersionChunk;
typedef FormatVersionChunk * FormatVersionChunkPtr;
struct CommonChunk {
UInt32 ckID;
SInt32 ckSize;
SInt16 numChannels;
UInt32 numSampleFrames;
SInt16 sampleSize;
extended80 sampleRate;
};
typedef struct CommonChunk CommonChunk;
typedef CommonChunk * CommonChunkPtr;
struct ExtCommonChunk {
UInt32 ckID;
SInt32 ckSize;
SInt16 numChannels;
UInt32 numSampleFrames;
SInt16 sampleSize;
extended80 sampleRate;
UInt32 compressionType;
char compressionName[1]; /* variable length array, Pascal string */
};
typedef struct ExtCommonChunk ExtCommonChunk;
typedef ExtCommonChunk * ExtCommonChunkPtr;
struct SoundDataChunk {
UInt32 ckID;
SInt32 ckSize;
UInt32 offset;
UInt32 blockSize;
};
typedef struct SoundDataChunk SoundDataChunk;
typedef SoundDataChunk * SoundDataChunkPtr;
struct Marker {
MarkerIdType id;
UInt32 position;
Str255 markerName;
};
typedef struct Marker Marker;
struct MarkerChunk {
UInt32 ckID;
SInt32 ckSize;
UInt16 numMarkers;
Marker Markers[1]; /* variable length array */
};
typedef struct MarkerChunk MarkerChunk;
typedef MarkerChunk * MarkerChunkPtr;
struct AIFFLoop {
SInt16 playMode;
MarkerIdType beginLoop;
MarkerIdType endLoop;
};
typedef struct AIFFLoop AIFFLoop;
struct InstrumentChunk {
UInt32 ckID;
SInt32 ckSize;
UInt8 baseFrequency;
UInt8 detune;
UInt8 lowFrequency;
UInt8 highFrequency;
UInt8 lowVelocity;
UInt8 highVelocity;
SInt16 gain;
AIFFLoop sustainLoop;
AIFFLoop releaseLoop;
};
typedef struct InstrumentChunk InstrumentChunk;
typedef InstrumentChunk * InstrumentChunkPtr;
struct MIDIDataChunk {
UInt32 ckID;
SInt32 ckSize;
UInt8 MIDIdata[1]; /* variable length array */
};
typedef struct MIDIDataChunk MIDIDataChunk;
typedef MIDIDataChunk * MIDIDataChunkPtr;
struct AudioRecordingChunk {
UInt32 ckID;
SInt32 ckSize;
UInt8 AESChannelStatus[24];
};
typedef struct AudioRecordingChunk AudioRecordingChunk;
typedef AudioRecordingChunk * AudioRecordingChunkPtr;
struct ApplicationSpecificChunk {
UInt32 ckID;
SInt32 ckSize;
OSType applicationSignature;
UInt8 data[1]; /* variable length array */
};
typedef struct ApplicationSpecificChunk ApplicationSpecificChunk;
typedef ApplicationSpecificChunk * ApplicationSpecificChunkPtr;
struct Comment {
UInt32 timeStamp;
MarkerIdType marker;
UInt16 count;
char text[1]; /* variable length array, Pascal string */
};
typedef struct Comment Comment;
struct CommentsChunk {
UInt32 ckID;
SInt32 ckSize;
UInt16 numComments;
Comment comments[1]; /* variable length array */
};
typedef struct CommentsChunk CommentsChunk;
typedef CommentsChunk * CommentsChunkPtr;
struct TextChunk {
UInt32 ckID;
SInt32 ckSize;
char text[1]; /* variable length array, Pascal string */
};
typedef struct TextChunk TextChunk;
typedef TextChunk * TextChunkPtr;
#pragma pack(pop)
#endif /* __AIFF__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework/Headers/Math64.h | /*
File: CarbonCore/Math64.h
Contains: 64-bit integer math Interfaces.
The contents of this header file are deprecated.
Copyright: © 1994-2011 by Apple Inc. All rights reserved.
*/
#ifndef __MATH64__
#define __MATH64__
#ifndef __CONDITIONALMACROS__
#include <ConditionalMacros.h>
#endif
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
/*
* S64Max()
*
* Discussion:
* Returns largest possible SInt64 value
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern SInt64
S64Max(void);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline SInt64 S64Max(void) { return 9223372036854775807LL; }
#else
#define S64Max() (9223372036854775807LL)
#endif
#endif
/*
* S64Min()
*
* Discussion:
* Returns smallest possible SInt64 value
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern SInt64
S64Min(void);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline SInt64 S64Min(void) { return -S64Max() - 1; }
#else
#define S64Min() (-S64Max() - 1)
#endif
#endif
/*
* S64Add()
*
* Discussion:
* Adds two integers, producing an integer result. If an overflow
* occurs the result is congruent mod (2^64) as if the operands and
* result were unsigned. No overflow is signaled.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern SInt64
S64Add(
SInt64 left,
SInt64 right);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline SInt64 S64Add(SInt64 left, SInt64 right) { return (SInt64)(left) + (SInt64)(right); }
#else
#define S64Add(left, right) ((SInt64)(left) + (SInt64)(right))
#endif
#endif
/*
* S64Subtract()
*
* Discussion:
* Subtracts two integers, producing an integer result. If an
* overflow occurs the result is congruent mod (2^64) as if the
* operands and result were unsigned. No overflow is signaled.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern SInt64
S64Subtract(
SInt64 left,
SInt64 right);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline SInt64 S64Subtract(SInt64 left, SInt64 right) { return (SInt64)(left) - (SInt64)(right); }
#else
#define S64Subtract(left, right) ((SInt64)(left) - (SInt64)(right))
#endif
#endif
/*
* S64Negate()
*
* Discussion:
* Returns the additive inverse of a signed number (i.e. it returns
* 0 - the number). S64Negate (S64Min) is not representable (in
* fact, it returns S64Min).
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern SInt64
S64Negate(SInt64 value);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline SInt64 S64Negate(SInt64 value) { return -(SInt64)(value); }
#else
#define S64Negate(value) (-(SInt64)(value))
#endif
#endif
#if !TYPE_LONGLONG
/*
* S64Absolute()
*
* Discussion:
* Returns the absolute value of the number (i.e. the number if it
* is positive, or 0 - the number if it is negative). Disabled for
* compilers that support long long until llabs() is available
* everywhere.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern SInt64
S64Absolute(SInt64 value);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline SInt64 S64Absolute(SInt64 value) { return llabs((SInt64)value); }
#else
#define S64Absolute(value) (llabs((SInt64)value))
#endif
#endif
#endif /* !TYPE_LONGLONG */
/*
* S64Multiply()
*
* Discussion:
* Multiplies two signed numbers, producing a signed result.
* Overflow is ignored and the low-order part of the product is
* returned. The sign of the result is not guaranteed to be correct
* if the magnitude of the product is not representable.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern SInt64
S64Multiply(
SInt64 left,
SInt64 right);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline SInt64 S64Multiply(SInt64 left, SInt64 right) { return (SInt64)(left) * (SInt64)(right); }
#else
#define S64Multiply(left, right) ((SInt64)(left) * (SInt64)(right))
#endif
#endif
/*
* S64Mod()
*
* Discussion:
* Returns the remainder of divide of dividend by divisor. The sign
* of the remainder is the same as the sign of the dividend (i.e.,
* it takes the absolute values of the operands, does the division,
* then fixes the sign of the quotient and remainder).
*
* Availability:
* Implemented by client
*/
extern SInt64
S64Mod(
SInt64 dividend,
SInt64 divisor);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline SInt64 S64Mod(SInt64 dividend, SInt64 divisor) { return (SInt64)(dividend) % (SInt64)(divisor); }
#else
#define S64Mod(dividend, divisor) ((SInt64)(dividend) % (SInt64)(divisor))
#endif
#endif
/*
* S64Divide()
*
* Discussion:
* Divides dividend by divisor, returning the quotient. The
* remainder is returned in *remainder if remainder (the pointer) is
* non-NULL. The sign of the remainder is the same as the sign of
* the dividend (i.e. it takes the absolute values of the operands,
* does the division, then fixes the sign of the quotient and
* remainder). If the divisor is zero, then S64Max() will be
* returned (or S64Min() if the dividend is negative), and the
* remainder will be the dividend; no error is reported.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern SInt64
S64Divide(
SInt64 dividend,
SInt64 divisor,
SInt64 * remainder); /* can be NULL */
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline SInt64 S64Divide(SInt64 dividend, SInt64 divisor, SInt64 *remainder) { return ( (void)((remainder) && (*((SInt64*)(remainder)) = ((SInt64)(dividend) % (SInt64)(divisor)))), ((SInt64)(dividend) / (SInt64)(divisor)) ); }
#else
#define S64Divide(dividend, divisor, remainder) (( (void)((remainder) && (*((SInt64*)(remainder)) = ((SInt64)(dividend) % (SInt64)(divisor)))), ((SInt64)(dividend) / (SInt64)(divisor)) ))
#endif
#endif
/*
* S64Div()
*
* Discussion:
* Divides dividend by divisor, returning the quotient.
*
* Availability:
* Implemented by client
*/
extern SInt64
S64Div(
SInt64 dividend,
SInt64 divisor);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline SInt64 S64Div(SInt64 dividend, SInt64 divisor) { return S64Divide((dividend), (divisor), NULL); }
#else
#define S64Div(dividend, divisor) (S64Divide((dividend), (divisor), NULL))
#endif
#endif
/*
* S64Set()
*
* Discussion:
* Given an SInt32, returns an SInt64 with the same value. Use this
* routine instead of coding 64-bit constants (at least when the
* constant will fit in an SInt32).
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern SInt64
S64Set(SInt32 value);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline SInt64 S64Set(SInt32 value) { return (SInt64)(value); }
#else
#define S64Set(value) ((SInt64)(value))
#endif
#endif
/*
* S64SetU()
*
* Discussion:
* Given a UInt32, returns a SInt64 with the same value.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern SInt64
S64SetU(UInt32 value);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline SInt64 S64SetU(UInt32 value) { return (SInt64)(value); }
#else
#define S64SetU(value) ((SInt64)(value))
#endif
#endif
/*
* S32Set()
*
* Discussion:
* Given an SInt64, returns an SInt32 by discarding the high-order
* 32 bits.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern SInt32
S32Set(SInt64 value);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline SInt32 S32Set(SInt64 value) { return (SInt32)(value); }
#else
#define S32Set(value) ((SInt32)(value))
#endif
#endif
/*
* S64And()
*
* Discussion:
* Returns one if left and right are non-zero, otherwise returns zero
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern Boolean
S64And(
SInt64 left,
SInt64 right);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline Boolean S64And(SInt64 left, SInt64 right) { return (SInt64)(left) && (SInt64)(right); }
#else
#define S64And(left, right) ((SInt64)(left) && (SInt64)(right))
#endif
#endif
/*
* S64Or()
*
* Discussion:
* Returns one if left or right are non-zero, otherwise returns zero
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern Boolean
S64Or(
SInt64 left,
SInt64 right);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline Boolean S64Or(SInt64 left, SInt64 right) { return (SInt64)(left) || (SInt64)(right); }
#else
#define S64Or(left, right) ((SInt64)(left) || (SInt64)(right))
#endif
#endif
/*
* S64Eor()
*
* Discussion:
* Returns one if left xor right are non-zero, otherwise returns zero
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern Boolean
S64Eor(
SInt64 left,
SInt64 right);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline Boolean S64Eor(SInt64 left, SInt64 right) { return (Boolean)(((SInt64)(left) ? 1 : 0) ^ ((SInt64)(right) ? 1 : 0)); }
#else
#define S64Eor(left, right) ((Boolean)(((SInt64)(left) ? 1 : 0) ^ ((SInt64)(right) ? 1 : 0)))
#endif
#endif
/*
* S64Not()
*
* Discussion:
* Returns one if value is non-zero, otherwisze returns zero.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern Boolean
S64Not(SInt64 value);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline Boolean S64Not(SInt64 value) { return !((SInt64)(value)); }
#else
#define S64Not(value) (!((SInt64)(value)))
#endif
#endif
/*
* S64Compare()
*
* Discussion:
* Given two signed numbers, left and right, returns an SInt32 that
* compares with zero the same way left compares with right. If you
* wanted to perform a comparison on 64-bit integers of the
* form:
* operand_1 <operation> operand_2
* then you could use an expression of the form:
* xxxS64Compare(operand_1,operand_2) <operation> 0
* to test for the same condition. CAUTION: DO NOT depend on the
* exact value returned by this routine. Only the sign (i.e.
* positive, zero, or negative) of the result is guaranteed.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: not available
*/
extern SInt32
S64Compare(
SInt64 left,
SInt64 right) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* S64BitwiseAnd()
*
* Discussion:
* bitwise AND
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern SInt64
S64BitwiseAnd(
SInt64 left,
SInt64 right);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline SInt64 S64BitwiseAnd(SInt64 left, SInt64 right) { return (SInt64)(left) & (SInt64)(right); }
#else
#define S64BitwiseAnd(left, right) ((SInt64)(left) & (SInt64)(right))
#endif
#endif
/*
* S64BitwiseOr()
*
* Discussion:
* bitwise OR
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern SInt64
S64BitwiseOr(
SInt64 left,
SInt64 right);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline SInt64 S64BitwiseOr(SInt64 left, SInt64 right) { return (SInt64)(left) | (SInt64)(right); }
#else
#define S64BitwiseOr(left, right) ((SInt64)(left) | (SInt64)(right))
#endif
#endif
/*
* S64BitwiseEor()
*
* Discussion:
* bitwise XOR
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern SInt64
S64BitwiseEor(
SInt64 left,
SInt64 right);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline SInt64 S64BitwiseEor(SInt64 left, SInt64 right) { return (SInt64)(left) ^ (SInt64)(right); }
#else
#define S64BitwiseEor(left, right) ((SInt64)(left) ^ (SInt64)(right))
#endif
#endif
/*
* S64BitwiseNot()
*
* Discussion:
* bitwise negate
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern SInt64
S64BitwiseNot(SInt64 value);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline SInt64 S64BitwiseNot(SInt64 value) { return ~((SInt64)(value)); }
#else
#define S64BitwiseNot(value) (~((SInt64)(value)))
#endif
#endif
/*
* S64ShiftRight()
*
* Discussion:
* Arithmetic shift of value by the lower 7 bits of the shift.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern SInt64
S64ShiftRight(
SInt64 value,
UInt32 shift);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline SInt64 S64ShiftRight(SInt64 value, UInt32 shift) { return (SInt64)(value) >> ((shift) & 0x7F); }
#else
#define S64ShiftRight(value, shift) ((SInt64)(value) >> ((shift) & 0x7F))
#endif
#endif
/*
* S64ShiftLeft()
*
* Discussion:
* Logical shift of value by the lower 7 bits of the shift.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern SInt64
S64ShiftLeft(
SInt64 value,
UInt32 shift);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline SInt64 S64ShiftLeft(SInt64 value, UInt32 shift) { return (SInt64)(value) << ((shift) & 0x7F); }
#else
#define S64ShiftLeft(value, shift) ((SInt64)(value) << ((shift) & 0x7F))
#endif
#endif
#if !TYPE_LONGDOUBLE_IS_DOUBLE
/*
* SInt64ToLongDouble()
*
* Discussion:
* Converts SInt64 to long double. Note all SInt64s fit exactly
* into long doubles, thus, the binary -> decimal conversion
* routines in fp.h can be used to achieve SInt64 -> long double ->
* decimal conversions. Note: The function implementation assumes
* long double is a 128-bit floating point on PowerPC and 80-bit
* type on 68K
*
* Availability:
* Mac OS X: not available
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern long double
SInt64ToLongDouble(SInt64 value);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline long double SInt64ToLongDouble(SInt64 value) { return (long double)(value); }
#else
#define SInt64ToLongDouble(value) ((long double)(value))
#endif
#endif
/*
* LongDoubleToSInt64()
*
* Discussion:
* Converts a long double to a SInt64. Any decimal string that fits
* into a SInt64 can be converted exactly into a long double, using
* the conversion routines found in fp.h. Then this routine can be
* used to complete the conversion to SInt64. Note: The function
* implementation assumes long double is a 128-bit floating point on
* PowerPC and 80-bit type on 68K
*
* Availability:
* Mac OS X: not available
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern SInt64
LongDoubleToSInt64(long double value);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline SInt64 LongDoubleToSInt64(long double value) { return (SInt64)(value); }
#else
#define LongDoubleToSInt64(value) ((SInt64)(value))
#endif
#endif
#endif /* !TYPE_LONGDOUBLE_IS_DOUBLE */
/*
* U64Max()
*
* Discussion:
* Returns largest possible UInt64 value
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern UInt64
U64Max(void);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline UInt64 U64Max(void) { return 0xffffffffffffffffULL; }
#else
#define U64Max() (0xffffffffffffffffULL)
#endif
#endif
/*
* U64Add()
*
* Discussion:
* Adds two unsigned integers, producing an integer result. If an
* overflow occurs the result is congruent mod (2^64) as if the
* operands and result were unsigned. No overflow is signaled.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern UInt64
U64Add(
UInt64 left,
UInt64 right);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline UInt64 U64Add(UInt64 left, UInt64 right) { return (UInt64)(left) + (UInt64)(right); }
#else
#define U64Add(left, right) ((UInt64)(left) + (UInt64)(right))
#endif
#endif
/*
* U64Subtract()
*
* Discussion:
* Subtracts two unsigned integers, producing an integer result. If
* an overflow occurs the result is congruent mod (2^64) as if the
* operands and result were unsigned. No overflow is signaled.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern UInt64
U64Subtract(
UInt64 left,
UInt64 right);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline UInt64 U64Subtract(UInt64 left, UInt64 right) { return (UInt64)(left) - (UInt64)(right); }
#else
#define U64Subtract(left, right) ((UInt64)(left) - (UInt64)(right))
#endif
#endif
/*
* U64Multiply()
*
* Discussion:
* Multiplies two unsigned numbers, producing a signed result.
* Overflow is ignored and the low-order part of the product is
* returned. The sign of the result is not guaranteed to be correct
* if the magnitude of the product is not representable.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern UInt64
U64Multiply(
UInt64 left,
UInt64 right);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline UInt64 U64Multiply(UInt64 left, UInt64 right) { return (UInt64)(left) * (UInt64)(right); }
#else
#define U64Multiply(left, right) ((UInt64)(left) * (UInt64)(right))
#endif
#endif
/*
* U64Mod()
*
* Discussion:
* Returns the remainder of divide of dividend by divisor. The sign
* of the remainder is the same as the sign of the dividend (i.e.,
* it takes the absolute values of the operands, does the division,
* then fixes the sign of the quotient and remainder).
*
* Availability:
* Implemented by client
*/
extern UInt64
U64Mod(
UInt64 dividend,
UInt64 divisor);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline UInt64 U64Mod(UInt64 dividend, UInt64 divisor) { return (UInt64)(dividend) % (UInt64)(divisor); }
#else
#define U64Mod(dividend, divisor) ((UInt64)(dividend) % (UInt64)(divisor))
#endif
#endif
/*
* U64Divide()
*
* Discussion:
* Divides dividend by divisor, returning the quotient. The
* remainder is returned in *remainder if remainder (the pointer) is
* non-NULL. The sign of the remainder is the same as the sign of
* the dividend (i.e. it takes the absolute values of the operands,
* does the division, then fixes the sign of the quotient and
* remainder). If the divisor is zero, then U64Max() will be
* returned (or U64Min() if the dividend is negative), and the
* remainder will be the dividend; no error is reported.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern UInt64
U64Divide(
UInt64 dividend,
UInt64 divisor,
UInt64 * remainder); /* can be NULL */
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline UInt64 U64Divide(UInt64 dividend, UInt64 divisor, UInt64 *remainder) { return ( (void)((remainder) && (*((UInt64*)(remainder)) = ((UInt64)(dividend) % (UInt64)(divisor)))), ((UInt64)(dividend) / (UInt64)(divisor)) ); }
#else
#define U64Divide(dividend, divisor, remainder) (( (void)((remainder) && (*((UInt64*)(remainder)) = ((UInt64)(dividend) % (UInt64)(divisor)))), ((UInt64)(dividend) / (UInt64)(divisor)) ))
#endif
#endif
/*
* U64Div()
*
* Discussion:
* Divides dividend by divisor, returning the quotient.
*
* Availability:
* Implemented by client
*/
extern UInt64
U64Div(
UInt64 dividend,
UInt64 divisor);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline UInt64 U64Div(UInt64 dividend, UInt64 divisor) { return U64Divide((dividend), (divisor), NULL); }
#else
#define U64Div(dividend, divisor) (U64Divide((dividend), (divisor), NULL))
#endif
#endif
/*
* U64Set()
*
* Discussion:
* Given an SInt32, returns an UInt64 with the same value. Use this
* routine instead of coding 64-bit constants (at least when the
* constant will fit in an SInt32).
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern UInt64
U64Set(SInt32 value);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline UInt64 U64Set(SInt32 value) { return (UInt64)(value); }
#else
#define U64Set(value) ((UInt64)(value))
#endif
#endif
/*
* U64SetU()
*
* Discussion:
* Given a UInt32, returns a UInt64 with the same value.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern UInt64
U64SetU(UInt32 value);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline UInt64 U64SetU(UInt32 value) { return (UInt64)(value); }
#else
#define U64SetU(value) ((UInt64)(value))
#endif
#endif
/*
* U32SetU()
*
* Discussion:
* Given an UInt64, returns an UInt32 by discarding the high-order
* 32 bits.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern UInt32
U32SetU(UInt64 value);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline UInt32 U32SetU(UInt64 value) { return (UInt32)(value); }
#else
#define U32SetU(value) ((UInt32)(value))
#endif
#endif
/*
* U64And()
*
* Discussion:
* Returns one if left and right are non-zero, otherwise returns zero
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern Boolean
U64And(
UInt64 left,
UInt64 right);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline Boolean U64And(UInt64 left, UInt64 right) { return (UInt64)(left) && (UInt64)(right); }
#else
#define U64And(left, right) ((UInt64)(left) && (UInt64)(right))
#endif
#endif
/*
* U64Or()
*
* Discussion:
* Returns one if left or right are non-zero, otherwise returns zero
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern Boolean
U64Or(
UInt64 left,
UInt64 right);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline Boolean U64Or(UInt64 left, UInt64 right) { return (UInt64)(left) || (UInt64)(right); }
#else
#define U64Or(left, right) ((UInt64)(left) || (UInt64)(right))
#endif
#endif
/*
* U64Eor()
*
* Discussion:
* Returns one if left xor right are non-zero, otherwise returns zero
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern Boolean
U64Eor(
UInt64 left,
UInt64 right);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline Boolean U64Eor(UInt64 left, UInt64 right) { return (Boolean)(((UInt64)(left) ? 1 : 0) ^ ((UInt64)(right) ? 1 : 0)); }
#else
#define U64Eor(left, right) ((Boolean)(((UInt64)(left) ? 1 : 0) ^ ((UInt64)(right) ? 1 : 0)))
#endif
#endif
/*
* U64Not()
*
* Discussion:
* Returns one if value is non-zero, otherwisze returns zero.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern Boolean
U64Not(UInt64 value);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline Boolean U64Not(UInt64 value) { return !((UInt64)(value)); }
#else
#define U64Not(value) (!((UInt64)(value)))
#endif
#endif
/*
* U64Compare()
*
* Discussion:
* Given two unsigned numbers, left and right, returns an SInt32
* that compares with zero the same way left compares with right.
* If you wanted to perform a comparison on 64-bit integers of the
* form:
* operand_1 <operation> operand_2
* then you could use an expression of the form:
* xxxU64Compare(operand_1,operand_2) <operation> 0
* to test for the same condition. CAUTION: DO NOT depend on the
* exact value returned by this routine. Only the sign (i.e.
* positive, zero, or negative) of the result is guaranteed.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: not available
*/
extern SInt32
U64Compare(
UInt64 left,
UInt64 right) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* U64BitwiseAnd()
*
* Discussion:
* bitwise AND
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern UInt64
U64BitwiseAnd(
UInt64 left,
UInt64 right);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline UInt64 U64BitwiseAnd(UInt64 left, UInt64 right) { return (UInt64)(left) & (UInt64)(right); }
#else
#define U64BitwiseAnd(left, right) ((UInt64)(left) & (UInt64)(right))
#endif
#endif
/*
* U64BitwiseOr()
*
* Discussion:
* bitwise OR
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern UInt64
U64BitwiseOr(
UInt64 left,
UInt64 right);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline UInt64 U64BitwiseOr(UInt64 left, UInt64 right) { return (UInt64)(left) | (UInt64)(right); }
#else
#define U64BitwiseOr(left, right) ((UInt64)(left) | (UInt64)(right))
#endif
#endif
/*
* U64BitwiseEor()
*
* Discussion:
* bitwise XOR
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern UInt64
U64BitwiseEor(
UInt64 left,
UInt64 right);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline UInt64 U64BitwiseEor(UInt64 left, UInt64 right) { return (UInt64)(left) ^ (UInt64)(right); }
#else
#define U64BitwiseEor(left, right) ((UInt64)(left) ^ (UInt64)(right))
#endif
#endif
/*
* U64BitwiseNot()
*
* Discussion:
* bitwise negate
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern UInt64
U64BitwiseNot(UInt64 value);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline UInt64 U64BitwiseNot(UInt64 value) { return ~((UInt64)(value)); }
#else
#define U64BitwiseNot(value) (~((UInt64)(value)))
#endif
#endif
/*
* U64ShiftRight()
*
* Discussion:
* Arithmetic shift of value by the lower 7 bits of the shift.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern UInt64
U64ShiftRight(
UInt64 value,
UInt32 shift);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline UInt64 U64ShiftRight(UInt64 value, UInt32 shift) { return (UInt64)(value) >> ((shift) & 0x7F); }
#else
#define U64ShiftRight(value, shift) ((UInt64)(value) >> ((shift) & 0x7F))
#endif
#endif
/*
* U64ShiftLeft()
*
* Discussion:
* Logical shift of value by the lower 7 bits of the shift.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern UInt64
U64ShiftLeft(
UInt64 value,
UInt32 shift);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline UInt64 U64ShiftLeft(UInt64 value, UInt32 shift) { return (UInt64)(value) << ((shift) & 0x7F); }
#else
#define U64ShiftLeft(value, shift) ((UInt64)(value) << ((shift) & 0x7F))
#endif
#endif
#if !TYPE_LONGDOUBLE_IS_DOUBLE
/*
* UInt64ToLongDouble()
*
* Discussion:
* Convert an signed 64 bit integer to a long double (128-bit on
* PowerPC floating point)
*
* Availability:
* Mac OS X: not available
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern long double
UInt64ToLongDouble(UInt64 value);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline long double UInt64ToLongDouble(UInt64 value) { return (long double)(value); }
#else
#define UInt64ToLongDouble(value) ((long double)(value))
#endif
#endif
/*
* LongDoubleToUInt64()
*
* Discussion:
* Convert long double (128-bit on PowerPC floating point) to a
* signed 64-bit integer
*
* Availability:
* Mac OS X: not available
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern UInt64
LongDoubleToUInt64(long double value);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline UInt64 LongDoubleToUInt64(long double value) { return (UInt64)(value); }
#else
#define LongDoubleToUInt64(value) ((UInt64)(value))
#endif
#endif
#endif /* !TYPE_LONGDOUBLE_IS_DOUBLE */
/*
* UInt64ToSInt64()
*
* Discussion:
* converts UInt64 -> SInt64
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern SInt64
UInt64ToSInt64(UInt64 value);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline SInt64 UInt64ToSInt64(UInt64 value) { return (SInt64)(value); }
#else
#define UInt64ToSInt64(value) ((SInt64)(value))
#endif
#endif
/*
* SInt64ToUInt64()
*
* Discussion:
* converts SInt64 -> UInt64
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern UInt64
SInt64ToUInt64(SInt64 value);
#if TYPE_LONGLONG
#if MATH64_USE_INLINE
inline UInt64 SInt64ToUInt64(SInt64 value) { return (UInt64)(value); }
#else
#define SInt64ToUInt64(value) ((UInt64)(value))
#endif
#endif
/*
Functions to convert between [Unsigned]Wide and [S|U]Int64 types.
These functions are necessary if source code which uses both
wide and SInt64 is to compile under a compiler that supports
long long, where SInt64 and UInt64 are supported natively as
64 bit values by the compiler.
SInt64ToWide
Converts a SInt64 to a wide struct. If SInt64 is implemented
as a typedef of wide, the macro does nothing. If SInt64 is
implemented as a long long, it returns the long long in a
wide struct.
WideToSInt64
Converts a wide struct into a SInt64. If SInt64 is implemented
as a typedef of wide, the macro does nothing. If SInt64 is
implemented as a long long, it returns the value in the struct
as a long long.
*/
#if TYPE_LONGLONG
#if defined(__STDC_VERSION__) && __STDC_VERSION__ >= 199409L
static inline wide SInt64ToWide(SInt64 s) { wide result; result.hi = (SInt32)(((UInt64)s >> 32) & 0xffffffffUL); result.lo = (UInt32)((UInt64)s & 0xffffffffUL); return result; }
static inline SInt64 WideToSInt64(wide w) { SInt64 result = w.hi; result = (result << 32) | w.lo; return result; }
static inline UnsignedWide UInt64ToUnsignedWide(UInt64 u) { UnsignedWide result; result.hi = (UInt32)((u >> 32) & 0xffffffffUL); result.lo = (UInt32)(u & 0xffffffffUL); return result; }
static inline UInt64 UnsignedWideToUInt64(UnsignedWide uw) { UInt64 result = uw.hi; result = (result << 32) | uw.lo; return result; }
#elif defined(__GNUC__)
static __inline wide SInt64ToWide(SInt64 s) { wide result; result.hi = (SInt32)(((UInt64)s >> 32) & 0xffffffffUL); result.lo = (UInt32)((UInt64)s & 0xffffffffUL); return result; }
static __inline SInt64 WideToSInt64(wide w) { SInt64 result = w.hi; result = (result << 32) | w.lo; return result; }
static __inline UnsignedWide UInt64ToUnsignedWide(UInt64 u) { UnsignedWide result; result.hi = (UInt32)((u >> 32) & 0xffffffffUL); result.lo = (UInt32)(u & 0xffffffffUL); return result; }
static __inline UInt64 UnsignedWideToUInt64(UnsignedWide uw) { UInt64 result = uw.hi; result = (result << 32) | uw.lo; return result; }
#else
// Although this isn't as efficent as it could be, there's no safe way to do this in a way which complies with both -ansi and -pedantic,
// on all the compilers I know about, so CarbonCore.framework just exports these so folks can link to them. Only applications built with
// TYPE_LONGLONG defined though should call them, since the ABI is different in those cases.
extern wide _SInt64ToWideLL(SInt64 s);
extern SInt64 _WideToSInt64LL(wide w);
extern wide _UInt64ToUnsignedWide(UInt64 u);
extern UInt64 _UnsignedWideToUInt64(UnsignedWide uw);
#define SInt64ToWide(x) _SInt64ToWide(x)
#define WideToSInt64(x) _WideToSInt64(x)
#define UInt64ToUnsignedWide(x) _UInt64ToUnsignedWide(x)
#define UnsignedWideToUInt64(x) _UnsignedWideToUInt64(x)
#endif
#else
#define SInt64ToWide(x) (x)
#define WideToSInt64(x) (x)
#define UInt64ToUnsignedWide(x) (x)
#define UnsignedWideToUInt64(x) (x)
#endif
#ifdef __cplusplus
}
#endif
#endif /* __MATH64__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework/Headers/DriverServices.h | /*
File: CarbonCore/DriverServices.h
Contains: Driver Services Interfaces.
The contents of this header file are deprecated.
Use CFAbsoluteTime or mach time routines instead.
Copyright: © 1985-2011 by Apple Inc. All rights reserved.
*/
#ifndef __DRIVERSERVICES__
#define __DRIVERSERVICES__
#ifndef __CONDITIONALMACROS__
#include <ConditionalMacros.h>
#endif
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
#ifndef __MACERRORS__
#include <CarbonCore/MacErrors.h>
#endif
#ifndef __MACHINEEXCEPTIONS__
#include <CarbonCore/MachineExceptions.h>
#endif
#ifndef __DRIVERSYNCHRONIZATION__
#include <CarbonCore/DriverSynchronization.h>
#endif
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
#pragma options align=power
enum {
durationMicrosecond = -1L, /* Microseconds are negative*/
durationMillisecond = 1, /* Milliseconds are positive*/
durationSecond = 1000, /* 1000 * durationMillisecond*/
durationMinute = 60000, /* 60 * durationSecond,*/
durationHour = 3600000, /* 60 * durationMinute,*/
durationDay = 86400000, /* 24 * durationHour,*/
durationNoWait = 0, /* don't block*/
durationForever = 0x7FFFFFFF /* no time limit*/
};
typedef UnsignedWide Nanoseconds;
/*
* UpTime()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0.2 and later
* Non-Carbon CFM: in InterfaceLib 8.6 and later
*/
extern AbsoluteTime
UpTime(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* GetTimeBaseInfo()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 8.6 and later
*/
/*
* AbsoluteToNanoseconds()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0.2 and later
* Non-Carbon CFM: in InterfaceLib 8.6 and later
*/
extern Nanoseconds
AbsoluteToNanoseconds(AbsoluteTime absoluteTime) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* AbsoluteToDuration()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0.2 and later
* Non-Carbon CFM: in InterfaceLib 8.6 and later
*/
extern Duration
AbsoluteToDuration(AbsoluteTime absoluteTime) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* NanosecondsToAbsolute()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0.2 and later
* Non-Carbon CFM: in InterfaceLib 8.6 and later
*/
extern AbsoluteTime
NanosecondsToAbsolute(Nanoseconds nanoseconds) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* DurationToAbsolute()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0.2 and later
* Non-Carbon CFM: in InterfaceLib 8.6 and later
*/
extern AbsoluteTime
DurationToAbsolute(Duration duration) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* AddAbsoluteToAbsolute()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0.2 and later
* Non-Carbon CFM: in InterfaceLib 8.6 and later
*/
extern AbsoluteTime
AddAbsoluteToAbsolute(
AbsoluteTime absoluteTime1,
AbsoluteTime absoluteTime2) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* SubAbsoluteFromAbsolute()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0.2 and later
* Non-Carbon CFM: in InterfaceLib 8.6 and later
*/
extern AbsoluteTime
SubAbsoluteFromAbsolute(
AbsoluteTime leftAbsoluteTime,
AbsoluteTime rightAbsoluteTime) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* AddNanosecondsToAbsolute()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0.2 and later
* Non-Carbon CFM: in InterfaceLib 8.6 and later
*/
extern AbsoluteTime
AddNanosecondsToAbsolute(
Nanoseconds nanoseconds,
AbsoluteTime absoluteTime) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* AddDurationToAbsolute()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0.2 and later
* Non-Carbon CFM: in InterfaceLib 8.6 and later
*/
extern AbsoluteTime
AddDurationToAbsolute(
Duration duration,
AbsoluteTime absoluteTime) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* SubNanosecondsFromAbsolute()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0.2 and later
* Non-Carbon CFM: in InterfaceLib 8.6 and later
*/
extern AbsoluteTime
SubNanosecondsFromAbsolute(
Nanoseconds nanoseconds,
AbsoluteTime absoluteTime) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* SubDurationFromAbsolute()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0.2 and later
* Non-Carbon CFM: in InterfaceLib 8.6 and later
*/
extern AbsoluteTime
SubDurationFromAbsolute(
Duration duration,
AbsoluteTime absoluteTime) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* AbsoluteDeltaToNanoseconds()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0.2 and later
* Non-Carbon CFM: in InterfaceLib 8.6 and later
*/
extern Nanoseconds
AbsoluteDeltaToNanoseconds(
AbsoluteTime leftAbsoluteTime,
AbsoluteTime rightAbsoluteTime) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* AbsoluteDeltaToDuration()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0.2 and later
* Non-Carbon CFM: in InterfaceLib 8.6 and later
*/
extern Duration
AbsoluteDeltaToDuration(
AbsoluteTime leftAbsoluteTime,
AbsoluteTime rightAbsoluteTime) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* DurationToNanoseconds()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0.2 and later
* Non-Carbon CFM: in InterfaceLib 8.6 and later
*/
extern Nanoseconds
DurationToNanoseconds(Duration theDuration) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* NanosecondsToDuration()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0.2 and later
* Non-Carbon CFM: in InterfaceLib 8.6 and later
*/
extern Duration
NanosecondsToDuration(Nanoseconds theNanoseconds) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
#pragma options align=reset
#ifdef __cplusplus
}
#endif
#endif /* __DRIVERSERVICES__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework/Headers/Aliases.h | /*
File: CarbonCore/Aliases.h
Contains: Alias Manager Interfaces.
The contents of this header file are deprecated.
Use Foundation or CoreFoundation URL Bookmarks instead.
Copyright: © 1989-2011 by Apple Inc. All rights reserved.
*/
#ifndef __ALIASES__
#define __ALIASES__
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
#ifndef __FILES__
#include <CarbonCore/Files.h>
#endif
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
#pragma pack(push, 2)
typedef UInt32 FSAliasInfoBitmap;
enum {
kFSAliasInfoNone = 0x00000000, /* no valid info*/
kFSAliasInfoVolumeCreateDate = 0x00000001, /* volume creation date is valid*/
kFSAliasInfoTargetCreateDate = 0x00000002, /* target creation date is valid*/
kFSAliasInfoFinderInfo = 0x00000004, /* file type and creator are valid*/
kFSAliasInfoIsDirectory = 0x00000008, /* isDirectory boolean is valid*/
kFSAliasInfoIDs = 0x00000010, /* parentDirID and nodeID are valid*/
kFSAliasInfoFSInfo = 0x00000020, /* filesystemID and signature are valid*/
kFSAliasInfoVolumeFlags = 0x00000040 /* volumeIsBootVolume, volumeIsAutomounted, volumeIsEjectable and volumeHasPersistentFileIDs are valid*/
};
enum {
rAliasType = 'alis' /* Aliases are stored as resources of this type */
};
enum {
/* define alias resolution action rules mask */
kARMMountVol = 0x00000001, /* mount the volume automatically */
kARMNoUI = 0x00000002, /* no user interface allowed during resolution */
kARMMultVols = 0x00000008, /* search on multiple volumes */
kARMSearch = 0x00000100, /* search quickly */
kARMSearchMore = 0x00000200, /* search further */
kARMSearchRelFirst = 0x00000400, /* search target on a relative path first */
kARMTryFileIDFirst = 0x00000800 /* search by file id before path */
};
enum {
/* define alias record information types */
asiZoneName = -3, /* get zone name */
asiServerName = -2, /* get server name */
asiVolumeName = -1, /* get volume name */
asiAliasName = 0, /* get aliased file/folder/volume name */
asiParentName = 1 /* get parent folder name */
};
/* ResolveAliasFileWithMountFlags options */
enum {
kResolveAliasFileNoUI = 0x00000001, /* no user interaction during resolution */
kResolveAliasTryFileIDFirst = 0x00000002 /* search by file id before path */
};
#if MAC_OS_X_VERSION_MIN_REQUIRED >= MAC_OS_X_VERSION_10_4
#define __AL_USE_OPAQUE_RECORD__ 1
#else
#define __AL_USE_OPAQUE_RECORD__ 0
#endif
/* define the alias record that will be the blackbox for the caller */
#if __AL_USE_OPAQUE_RECORD__
struct AliasRecord {
UInt8 hidden[6];
};
typedef struct AliasRecord AliasRecord;
#else
struct AliasRecord {
OSType userType; /* appl stored type like creator type */
unsigned short aliasSize; /* alias record size in bytes, for appl usage */
};
typedef struct AliasRecord AliasRecord;
#endif /* __AL_USE_OPAQUE_RECORD__ */
typedef AliasRecord * AliasPtr;
typedef AliasPtr * AliasHandle;
/* info block to pass to FSCopyAliasInfo */
struct FSAliasInfo {
UTCDateTime volumeCreateDate;
UTCDateTime targetCreateDate;
OSType fileType;
OSType fileCreator;
UInt32 parentDirID;
UInt32 nodeID;
UInt16 filesystemID;
UInt16 signature;
Boolean volumeIsBootVolume;
Boolean volumeIsAutomounted;
Boolean volumeIsEjectable;
Boolean volumeHasPersistentFileIDs;
Boolean isDirectory;
};
typedef struct FSAliasInfo FSAliasInfo;
typedef FSAliasInfo * FSAliasInfoPtr;
/* alias record information type */
typedef short AliasInfoType;
#if !__LP64__
typedef CALLBACK_API( Boolean , AliasFilterProcPtr )(CInfoPBPtr cpbPtr, Boolean *quitFlag, Ptr myDataPtr);
typedef STACK_UPP_TYPE(AliasFilterProcPtr) AliasFilterUPP;
/*
* NewAliasFilterUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern AliasFilterUPP
NewAliasFilterUPP(AliasFilterProcPtr userRoutine) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* DisposeAliasFilterUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
DisposeAliasFilterUPP(AliasFilterUPP userUPP) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* InvokeAliasFilterUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern Boolean
InvokeAliasFilterUPP(
CInfoPBPtr cpbPtr,
Boolean * quitFlag,
Ptr myDataPtr,
AliasFilterUPP userUPP) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
#if __MACH__
#ifdef __cplusplus
inline AliasFilterUPP NewAliasFilterUPP(AliasFilterProcPtr userRoutine) { return userRoutine; }
inline void DisposeAliasFilterUPP(AliasFilterUPP) { }
inline Boolean InvokeAliasFilterUPP(CInfoPBPtr cpbPtr, Boolean * quitFlag, Ptr myDataPtr, AliasFilterUPP userUPP) { return (*userUPP)(cpbPtr, quitFlag, myDataPtr); }
#else
#define NewAliasFilterUPP(userRoutine) ((AliasFilterUPP)userRoutine)
#define DisposeAliasFilterUPP(userUPP)
#define InvokeAliasFilterUPP(cpbPtr, quitFlag, myDataPtr, userUPP) (*userUPP)(cpbPtr, quitFlag, myDataPtr)
#endif
#endif
#endif /* !__LP64__ */
typedef CALLBACK_API_C( Boolean , FSAliasFilterProcPtr )(const FSRef *ref, Boolean *quitFlag, Ptr myDataPtr);
/*
* FSNewAlias()
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in InterfaceLib 9.1 and later
*/
extern OSErr
FSNewAlias(
const FSRef * fromFile, /* can be NULL */
const FSRef * target,
AliasHandle * inAlias) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* FSNewAliasMinimal()
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in InterfaceLib 9.1 and later
*/
extern OSErr
FSNewAliasMinimal(
const FSRef * target,
AliasHandle * inAlias) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* FSIsAliasFile()
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in InterfaceLib 9.1 and later
*/
extern OSErr
FSIsAliasFile(
const FSRef * fileRef,
Boolean * aliasFileFlag,
Boolean * folderFlag) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* FSResolveAliasWithMountFlags()
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in InterfaceLib 9.1 and later
*/
extern OSErr
FSResolveAliasWithMountFlags(
const FSRef * fromFile, /* can be NULL */
AliasHandle inAlias,
FSRef * target,
Boolean * wasChanged,
unsigned long mountFlags) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* FSResolveAlias()
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in InterfaceLib 9.1 and later
*/
extern OSErr
FSResolveAlias(
const FSRef * fromFile, /* can be NULL */
AliasHandle alias,
FSRef * target,
Boolean * wasChanged) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* FSResolveAliasFileWithMountFlags()
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in InterfaceLib 9.1 and later
*/
extern OSErr
FSResolveAliasFileWithMountFlags(
FSRef * theRef,
Boolean resolveAliasChains,
Boolean * targetIsFolder,
Boolean * wasAliased,
unsigned long mountFlags) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* FSResolveAliasFile()
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in InterfaceLib 9.1 and later
*/
extern OSErr
FSResolveAliasFile(
FSRef * theRef,
Boolean resolveAliasChains,
Boolean * targetIsFolder,
Boolean * wasAliased) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* FSFollowFinderAlias()
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in InterfaceLib 9.1 and later
*/
extern OSErr
FSFollowFinderAlias(
FSRef * fromFile, /* can be NULL */
AliasHandle alias,
Boolean logon,
FSRef * target,
Boolean * wasChanged) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* FSUpdateAlias()
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in InterfaceLib 9.1 and later
*/
extern OSErr
FSUpdateAlias(
const FSRef * fromFile, /* can be NULL */
const FSRef * target,
AliasHandle alias,
Boolean * wasChanged) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* FSNewAliasUnicode()
*
* Summary:
* Creates an alias given a ref to the target's parent directory and
* the target's unicode name. If the target does not exist fnfErr
* will be returned but the alias will still be created. This
* allows the creation of aliases to targets that do not exist.
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Parameters:
*
* fromFile:
* The starting point for a relative search.
*
* targetParentRef:
* An FSRef to the parent directory of the target.
*
* targetNameLength:
* Number of Unicode characters in the target's name.
*
* targetName:
* A pointer to the Unicode name.
*
* inAlias:
* A Handle to the newly created alias record.
*
* isDirectory:
* On input, if target does not exist, a flag to indicate whether
* or not the target is a directory. On output, if the target did
* exist, a flag indicating if the target is a directory. Pass
* NULL in the non-existant case if unsure.
*
* Availability:
* Mac OS X: in version 10.2 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x, is available on Mac OS X version 10.2 and later
* Non-Carbon CFM: not available
*/
extern OSErr
FSNewAliasUnicode(
const FSRef * fromFile, /* can be NULL */
const FSRef * targetParentRef,
UniCharCount targetNameLength,
const UniChar * targetName,
AliasHandle * inAlias,
Boolean * isDirectory) /* can be NULL */ __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_2, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* FSNewAliasMinimalUnicode()
*
* Summary:
* Creates a minimal alias given a ref to the target's parent
* directory and the target's unicode name. If the target does not
* exist fnfErr will be returned but the alias will still be created.
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Parameters:
*
* targetParentRef:
* An FSRef to the parent directory of the target.
*
* targetNameLength:
* Number of Unicode characters in the target's name.
*
* targetName:
* A pointer to the Unicode name.
*
* inAlias:
* A Handle to the newly created alias record.
*
* isDirectory:
* On input, if target does not exist, a flag to indicate whether
* or not the target is a directory. On output, if the target did
* exist, a flag indicating if the target is a directory. Pass
* NULL in the non-existant case if unsure.
*
* Availability:
* Mac OS X: in version 10.2 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x, is available on Mac OS X version 10.2 and later
* Non-Carbon CFM: not available
*/
extern OSErr
FSNewAliasMinimalUnicode(
const FSRef * targetParentRef,
UniCharCount targetNameLength,
const UniChar * targetName,
AliasHandle * inAlias,
Boolean * isDirectory) /* can be NULL */ __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_2, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* FSNewAliasFromPath()
*
* Summary:
* Creates an alias given a POSIX style utf-8 path to the target.
* If the target file does not exist but the path up to the leaf
* does then fnfErr will be returned but the alias will still be
* created.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* fromFilePath:
* The starting point for a relative search.
*
* targetPath:
* POSIX style UTF-8 path to target.
*
* flags:
* Options for future use. Pass in 0.
*
* inAlias:
* A Handle to the newly created alias record.
*
* isDirectory:
* On input, if target does not exist, a flag to indicate whether
* or not the target is a directory. On output, if the target did
* exist, a flag indicating if the target is a directory. Pass
* NULL in the non-existant case if unsure.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x, is available on Mac OS X version 10.5 and later
* Non-Carbon CFM: not available
*/
extern OSStatus
FSNewAliasFromPath(
const char * fromFilePath, /* can be NULL */
const char * targetPath,
OptionBits flags,
AliasHandle * inAlias,
Boolean * isDirectory) /* can be NULL */ __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_5, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* FSMatchAliasBulk()
*
* Summary:
* Given an alias handle and fromFile, match the alias and return
* FSRefs to the aliased file(s) and needsUpdate flag
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern OSStatus
FSMatchAliasBulk(
const FSRef * fromFile, /* can be NULL */
unsigned long rulesMask,
AliasHandle inAlias,
short * aliasCount,
FSRef * aliasList,
Boolean * needsUpdate,
FSAliasFilterProcPtr aliasFilter, /* can be NULL */
void * yourDataPtr) /* can be NULL */ __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_5, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* FSCopyAliasInfo()
*
* Discussion:
* This routine will return the requested information from the
* passed in aliasHandle. The information is gathered only from the
* alias record so it may not match what is on disk (no disk i/o is
* performed). The whichInfo paramter is an output parameter that
* signifies which fields in the info record contain valid data.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* inAlias:
* A handle to the alias record to get the information from.
*
* targetName:
* The name of the target item.
*
* volumeName:
* The name of the volume the target resides on.
*
* pathString:
* POSIX path to target.
*
* whichInfo:
* An indication of which fields in the info block contain valid
* data.
*
* info:
* Returned information about the alias.
*
* Availability:
* Mac OS X: in version 10.2 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x, is available on Mac OS X version 10.2 and later
* Non-Carbon CFM: not available
*/
extern OSStatus
FSCopyAliasInfo(
AliasHandle inAlias,
HFSUniStr255 * targetName, /* can be NULL */
HFSUniStr255 * volumeName, /* can be NULL */
CFStringRef * pathString, /* can be NULL */
FSAliasInfoBitmap * whichInfo, /* can be NULL */
FSAliasInfo * info) /* can be NULL */ __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_2, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* GetAliasSize()
*
* Discussion:
* This routine will return the size of the alias record referenced
* by the AliasHandle alias. This will be smaller than the size
* returned by GetHandleSize if any custom data has been added (IM
* Files 4-13).
*
* Mac OS X threading:
* Thread safe since version 10.4
*
* Parameters:
*
* alias:
* A handle to the alias record to get the information from.
*
* Result:
* The size of the private section of the alias record.
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x, is available on Mac OS X version 10.4 and later
* Non-Carbon CFM: not available
*/
extern Size
GetAliasSize(AliasHandle alias) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_4, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* GetAliasUserType()
*
* Discussion:
* This routine will return the usertype associated with the alias
* record referenced by the AliasHandle alias.
*
* Mac OS X threading:
* Thread safe since version 10.4
*
* Parameters:
*
* alias:
* A handle to the alias record to get the userType from.
*
* Result:
* The userType associated with the alias as an OSType
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x, is available on Mac OS X version 10.4 and later
* Non-Carbon CFM: not available
*/
extern OSType
GetAliasUserType(AliasHandle alias) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_4, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* SetAliasUserType()
*
* Discussion:
* This routine will set the userType associated with an alias
* record.
*
* Mac OS X threading:
* Thread safe since version 10.4
*
* Parameters:
*
* alias:
* A handle to the alias record to set the userType for.
*
* userType:
* The OSType to set the userType to.
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x, is available on Mac OS X version 10.4 and later
* Non-Carbon CFM: not available
*/
extern void
SetAliasUserType(
AliasHandle alias,
OSType userType) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_4, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* GetAliasSizeFromPtr()
*
* Discussion:
* This routine will return the size of the alias record referenced
* by a pointer to the AliasRecord.
*
* Mac OS X threading:
* Thread safe since version 10.4
*
* Parameters:
*
* alias:
* A pointer to the alias record to get the information from.
*
* Result:
* The size of the private section of the alias record.
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern Size
GetAliasSizeFromPtr(const AliasRecord * alias) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_4, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* GetAliasUserTypeFromPtr()
*
* Discussion:
* This routine will return the usertype associated withthe alias
* record pointed to by alias.
*
* Mac OS X threading:
* Thread safe since version 10.4
*
* Parameters:
*
* alias:
* A pointer to the alias record to get the userType from.
*
* Result:
* The userType associated with the alias as an OSType
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern OSType
GetAliasUserTypeFromPtr(const AliasRecord * alias) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_4, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* SetAliasUserTypeWithPtr()
*
* Discussion:
* This routine will set the userType associated with an alias
* record.
*
* Mac OS X threading:
* Thread safe since version 10.4
*
* Parameters:
*
* alias:
* A pointer to the alias record to set the userType for.
*
* userType:
* The OSType to set the userType to.
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
SetAliasUserTypeWithPtr(
AliasPtr alias,
OSType userType) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_4, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/* Functions beyond this point are deprecated*/
#if !__LP64__
/*
* FSMatchAlias() *** DEPRECATED ***
*
* Deprecated:
* Use FSMatchAliasBulk instead
*
* Summary:
* Given an alias handle and fromFile, match the alias and return
* FSRefs to the aliased file(s) and needsUpdate flag
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.2 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: not available in CarbonLib 1.x, is available on Mac OS X version 10.2 and later
* Non-Carbon CFM: not available
*/
extern OSErr
FSMatchAlias(
const FSRef * fromFile, /* can be NULL */
unsigned long rulesMask,
AliasHandle inAlias,
short * aliasCount,
FSRef * aliasList,
Boolean * needsUpdate,
AliasFilterUPP aliasFilter,
void * yourDataPtr) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_2, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* FSMatchAliasNoUI() *** DEPRECATED ***
*
* Deprecated:
* Use FSMatchAliasBulk with the kARMNoUI flag instead
*
* Summary:
* variation on FSMatchAlias that does not prompt user with a dialog
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.2 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: not available in CarbonLib 1.x, is available on Mac OS X version 10.2 and later
* Non-Carbon CFM: not available
*/
extern OSErr
FSMatchAliasNoUI(
const FSRef * fromFile, /* can be NULL */
unsigned long rulesMask,
AliasHandle inAlias,
short * aliasCount,
FSRef * aliasList,
Boolean * needsUpdate,
AliasFilterUPP aliasFilter,
void * yourDataPtr) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_2, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* NewAlias() *** DEPRECATED ***
*
* Deprecated:
* Use FSNewAlias
*
* Summary:
* create a new alias between fromFile and target, returns alias
* record handle
*
* Discussion:
* Create an alias betwen fromFile and target, and return it in an
* AliasHandle. This function is deprecated in Mac OS X 10.4;
* instead, you should use FSNewAliasUnicode() because NewAlias()
* has problems creating aliases to certain files, including those
* which are impossible to represent in an FSSpec.
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
NewAlias(
const FSSpec * fromFile, /* can be NULL */
const FSSpec * target,
AliasHandle * alias) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* NewAliasMinimal() *** DEPRECATED ***
*
* Deprecated:
* Use FSNewAliasMinimalUnicode
*
* Summary:
* create a minimal new alias for a target and return alias record
* handle
*
* Discussion:
* Create a minimal alias for a target, and return it in an
* AliasHandle. This function is deprecated in Mac OS X 10.4;
* instead, you should use FSNewAliasMinimalUnicode() because
* NewAliasMinimalAlias() has problems creating aliases to certain
* files, including those which are impossible to represent in an
* FSSpec.
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
NewAliasMinimal(
const FSSpec * target,
AliasHandle * alias) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* NewAliasMinimalFromFullPath() *** DEPRECATED ***
*
* Deprecated:
* Use FSNewAliasMinimalUnicode
*
* Summary:
* create a minimal new alias from a target fullpath (optional zone
* and server name) and return alias record handle
*
* Discussion:
* Create a minimal alias for a target fullpath, and return it in an
* AliasHandle. This function is deprecated in Mac OS X 10.4;
* instead, you should use FSNewAliasMinimalUnicode() because
* NewAliasMinimalFromFullPath() has problems creating aliases to
* certain files, including those which are impossible to represent
* in an FSSpec.
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
NewAliasMinimalFromFullPath(
short fullPathLength,
const void * fullPath,
ConstStr32Param zoneName,
ConstStr31Param serverName,
AliasHandle * alias) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* ResolveAlias() *** DEPRECATED ***
*
* Deprecated:
* Use FSResolveAlias() or FSResolveAliasWithMountFlags() instead.
*
* Summary:
* given an alias handle and fromFile, resolve the alias, update the
* alias record and return aliased filename and wasChanged flag.
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
ResolveAlias(
const FSSpec * fromFile, /* can be NULL */
AliasHandle alias,
FSSpec * target,
Boolean * wasChanged) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* GetAliasInfo() *** DEPRECATED ***
*
* Deprecated:
* Use FSCopyAliasInfo instead.
*
* Summary:
* This call does not work on all aliases. Given an alias handle and
* an index specifying requested alias information type, return the
* information from alias record as a string. An empty string is
* returned when the index is greater than the number of levels
* between the target and root.
*
* Mac OS X threading:
* Thread safe since version 10.0
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.3
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
GetAliasInfo(
AliasHandle alias,
AliasInfoType itemIndex,
Str63 theString) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_3, __IPHONE_NA, __IPHONE_NA);
/*
* IsAliasFile() *** DEPRECATED ***
*
* Deprecated:
* Use FSIsAliasFile() instead.
*
* Summary:
* Return true if the file pointed to by fileFSSpec is an alias file.
*
* Mac OS X threading:
* Thread safe since version 10.0
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 8.5 and later
*/
extern OSErr
IsAliasFile(
const FSSpec * fileFSSpec,
Boolean * aliasFileFlag,
Boolean * folderFlag) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* ResolveAliasWithMountFlags() *** DEPRECATED ***
*
* Deprecated:
* Use FSResolveAliasWithMountFlags() instead.
*
* Summary:
* Given an AliasHandle, return target file spec. It resolves the
* entire alias chain or one step of the chain. It returns info
* about whether the target is a folder or file; and whether the
* input file spec was an alias or not.
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 8.5 and later
*/
extern OSErr
ResolveAliasWithMountFlags(
const FSSpec * fromFile, /* can be NULL */
AliasHandle alias,
FSSpec * target,
Boolean * wasChanged,
unsigned long mountFlags) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* ResolveAliasFile() *** DEPRECATED ***
*
* Deprecated:
* Use FSResolveAliasFile
*
* Summary:
* Given a file spec, return target file spec if input file spec is
* an alias. It resolves the entire alias chain or one step of the
* chain. It returns info about whether the target is a folder or
* file; and whether the input file spec was an alias or not.
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
ResolveAliasFile(
FSSpec * theSpec,
Boolean resolveAliasChains,
Boolean * targetIsFolder,
Boolean * wasAliased) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/* Deprecated: Use FSResolveAliasFileWithMountFlags instead*/
/*
* ResolveAliasFileWithMountFlags() *** DEPRECATED ***
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 8.5 and later
*/
extern OSErr
ResolveAliasFileWithMountFlags(
FSSpec * theSpec,
Boolean resolveAliasChains,
Boolean * targetIsFolder,
Boolean * wasAliased,
unsigned long mountFlags) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/* Deprecated: Use FSFollowFinderAlias instead*/
/*
* FollowFinderAlias() *** DEPRECATED ***
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 8.5 and later
*/
extern OSErr
FollowFinderAlias(
const FSSpec * fromFile, /* can be NULL */
AliasHandle alias,
Boolean logon,
FSSpec * target,
Boolean * wasChanged) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
Low Level Routines
*/
/*
* UpdateAlias() *** DEPRECATED ***
*
* Deprecated:
* UseFSUpdateAlias
*
* Summary:
* given a fromFile-target pair and an alias handle, update the
* alias record pointed to by alias handle to represent target as
* the new alias.
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
UpdateAlias(
const FSSpec * fromFile, /* can be NULL */
const FSSpec * target,
AliasHandle alias,
Boolean * wasChanged) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* MatchAlias() *** DEPRECATED ***
*
* Deprecated:
* Use FSMatchAliasBulk instead
*
* Summary:
* Given an alias handle and fromFile, match the alias and return
* FSSpecs to the aliased file(s) and needsUpdate flag
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
MatchAlias(
const FSSpec * fromFile, /* can be NULL */
unsigned long rulesMask,
AliasHandle alias,
short * aliasCount,
FSSpecArrayPtr aliasList,
Boolean * needsUpdate,
AliasFilterUPP aliasFilter,
void * yourDataPtr) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* ResolveAliasFileWithMountFlagsNoUI() *** DEPRECATED ***
*
* Deprecated:
* Use FSResolveAliasFileWithMountFlags passing in the
* kResolveAliasFileNoUI flag
*
* Summary:
* variation on ResolveAliasFile that does not prompt user with a
* dialog
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: not available
*/
extern OSErr
ResolveAliasFileWithMountFlagsNoUI(
FSSpec * theSpec,
Boolean resolveAliasChains,
Boolean * targetIsFolder,
Boolean * wasAliased,
unsigned long mountFlags) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* MatchAliasNoUI() *** DEPRECATED ***
*
* Deprecated:
* Use FSMatchAliasBulk with the kARMNoUI flag instead
*
* Summary:
* variation on MatchAlias that does not prompt user with a dialog
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: not available
*/
extern OSErr
MatchAliasNoUI(
const FSSpec * fromFile, /* can be NULL */
unsigned long rulesMask,
AliasHandle alias,
short * aliasCount,
FSSpecArrayPtr aliasList,
Boolean * needsUpdate,
AliasFilterUPP aliasFilter,
void * yourDataPtr) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
#endif /* !__LP64__ */
#pragma pack(pop)
#ifdef __cplusplus
}
#endif
#endif /* __ALIASES__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework/Headers/TextUtils.h | /*
File: CarbonCore/TextUtils.h
Contains: Text Utilities Interfaces.
Copyright: © 1985-2011 Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __TEXTUTILS__
#define __TEXTUTILS__
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
#ifndef __NUMBERFORMATTING__
#include <CarbonCore/NumberFormatting.h>
#endif
#ifndef __STRINGCOMPARE__
#include <CarbonCore/StringCompare.h>
#endif
#ifndef __DATETIMEUTILS__
#include <CarbonCore/DateTimeUtils.h>
#endif
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
#pragma pack(push, 2)
/*
Here are the current System 7 routine names and the translations to the older forms.
Please use the newer forms in all new code and migrate the older names out of existing
code as maintainance permits.
NEW NAME OLD NAMEs OBSOLETE FORM (no script code)
FindScriptRun
FindWordBreaks NFindWord, FindWord
GetIndString
GetString
Munger
NewString
SetString
StyledLineBreak
TruncString
TruncText
UpperString ($A054) UprString, UprText
UppercaseText SCUpperText (a only) UpperText ($A456)
LowercaseText LwrString, LowerText, LwrText ($A056)
StripDiacritics StripText ($A256)
UppercaseStripDiacritics StripUpperText ($A656)
*/
/* TruncCode, StyledLineBreakCode, and truncation constants moved to QuickDrawText.i */
#if !__LP64__
struct ScriptRunStatus {
SInt8 script;
SInt8 runVariant;
};
typedef struct ScriptRunStatus ScriptRunStatus;
struct BreakTable {
char charTypes[256];
short tripleLength;
short triples[1];
};
typedef struct BreakTable BreakTable;
typedef BreakTable * BreakTablePtr;
struct NBreakTable {
SInt8 flags1;
SInt8 flags2;
short version;
short classTableOff;
short auxCTableOff;
short backwdTableOff;
short forwdTableOff;
short doBackup;
short length; /* length of NBreakTable */
char charTypes[256];
short tables[1];
};
typedef struct NBreakTable NBreakTable;
typedef NBreakTable * NBreakTablePtr;
#endif /* !__LP64__ */
/* The following functions are new names that work on 68k and PowerPC*/
/*
* Munger() *** DEPRECATED ***
*
* Deprecated:
* Use CFStringFindAndReplace or CFDataFind plus CFDataReplaceBytes
* (or strstr plus memmove), depending on usage; see discussion.
*
* Discussion:
* For text operations performed with Munger, use
* CFStringFindAndReplace instead.
*
* For operations on arbitrary bytes performed with Munger, use
* CFDataFind plus CFDataReplaceBytes instead (Another option is to
* use strstr plus memmove).
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.6
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern long
Munger(
Handle h,
long offset,
const void * ptr1,
long len1,
const void * ptr2,
long len2) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_6, __IPHONE_NA, __IPHONE_NA);
#if !__LP64__
/*
* NewString() *** DEPRECATED ***
*
* Deprecated:
* use CFStringCreateCopy instead.
*
* Discussion:
* This function is no longer recommended. Please use
* CFStringCreateCopy instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern StringHandle
NewString(ConstStr255Param theString) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* SetString() *** DEPRECATED ***
*
* Deprecated:
* use CFStringCreateWithPascalString and CFStringReplaceAll instead.
*
* Discussion:
* This function is no longer recommended. Please use
* CFStringCreateWithPascalString and CFStringReplaceAll instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void
SetString(
StringHandle theString,
ConstStr255Param strNew) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* GetString() *** DEPRECATED ***
*
* Deprecated:
* use CFBundleCopyLocalizedString instead.
*
* Discussion:
* This function is no longer recommended. Please use
* CFBundleCopyLocalizedString instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern StringHandle
GetString(short stringID) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
#endif /* !__LP64__ */
#if !__LP64__
/*
* GetIndString() *** DEPRECATED ***
*
* Deprecated:
* use CFBundleCopyLocalizedString instead.
*
* Discussion:
* This function is no longer recommended. Please use
* CFBundleCopyLocalizedString instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void
GetIndString(
Str255 theString,
short strListID,
short itemIndex) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
#endif /* !__LP64__ */
/*
* setstring()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
#if !__LP64__
/*
* newstring() *** DEPRECATED ***
*
* Deprecated:
* use CFStringCreateCopy instead.
*
* Discussion:
* This function is no longer recommended. Please use
* CFStringCreateCopy instead.
*
* Availability:
* Mac OS X: not available [32-bit only] but deprecated in 10.4
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
#endif /* !__LP64__ */
/*
* getindstring()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
#if !__LP64__
/*
* FindWordBreaks() *** DEPRECATED ***
*
* Deprecated:
* use UCFindTextBreak instead.
*
* Discussion:
* This function is no longer recommended. Please use
* UCFindTextBreak instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void
FindWordBreaks(
Ptr textPtr,
short textLength,
short offset,
Boolean leadingEdge,
BreakTablePtr breaks,
OffsetTable offsets,
ScriptCode script) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* LowercaseText() *** DEPRECATED ***
*
* Deprecated:
* use CFStringLowercase instead.
*
* Discussion:
* This function is no longer recommended. Please use
* CFStringLowercase instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void
LowercaseText(
Ptr textPtr,
short len,
ScriptCode script) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* UppercaseText() *** DEPRECATED ***
*
* Deprecated:
* use CFStringUppercase instead.
*
* Discussion:
* This function is no longer recommended. Please use
* CFStringUppercase instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void
UppercaseText(
Ptr textPtr,
short len,
ScriptCode script) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* StripDiacritics() *** DEPRECATED ***
*
* Deprecated:
* use CFStringTransform instead.
*
* Discussion:
* This function is no longer recommended. Please use
* CFStringTransform instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void
StripDiacritics(
Ptr textPtr,
short len,
ScriptCode script) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* UppercaseStripDiacritics() *** DEPRECATED ***
*
* Deprecated:
* use CFStringTransform instead.
*
* Discussion:
* This function is no longer recommended. Please use
* CFStringTransform instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void
UppercaseStripDiacritics(
Ptr textPtr,
short len,
ScriptCode script) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* FindScriptRun() *** DEPRECATED ***
*
* Deprecated:
* No longer needed on MacOS X.
*
* Discussion:
* This function is obsolate.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern ScriptRunStatus
FindScriptRun(
Ptr textPtr,
long textLen,
long * lenUsed) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
The following functions are old names, but are required for PowerPC builds
because InterfaceLib exports these names, instead of the new ones.
*/
#endif /* !__LP64__ */
/*
* FindWord()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
* NFindWord()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
On 68K machines, LwrText, LowerText, StripText, UpperText and StripUpperText
return an error code in register D0, but System 7 PowerMacs do not emulate
this properly, so checking D0 is unreliable.
*/
/*
* LwrText()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
* LowerText()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
* StripText()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
* UpperText()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
* StripUpperText()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/* The following are new names which are exported by InterfaceLib*/
#if !__LP64__
/*
* UpperString() *** DEPRECATED ***
*
* Deprecated:
* use CFStringUppercase instead.
*
* Discussion:
* This function is no longer recommended. Please use
* CFStringUppercase instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void
UpperString(
Str255 theString,
Boolean diacSensitive) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
#endif /* !__LP64__ */
#if !__LP64__
/*
* upperstring() *** DEPRECATED ***
*
* Deprecated:
* use CFStringUppercase instead.
*
* Discussion:
* This function is no longer recommended. Please use
* CFStringUppercase instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void
upperstring(
char * theString,
Boolean diacSensitive) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
#endif /* !__LP64__ */
/* The following are macros which map old names to the names exported by InterfaceLib*/
#if OLDROUTINENAMES
#define UprString(theString, diacSensitive) \
UpperString(theString, diacSensitive)
#endif /* OLDROUTINENAMES */
/* Old routine name but no new names are mapped to it:*/
/*
* UprText()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
Functions for converting between C and Pascal Strings
(Previously in Strings.h)
Note: CopyPascalStringToC, CopyCStringToPascal, c2pstrcpy, and p2cstrcpy
are written to allow inplace conversion. That is, the src and dst
parameters can point to the memory location. These functions
are available in CarbonLib and CarbonAccessors.o.
Note: c2pstr, C2PStr, p2cstr, and P2CStr are all deprecated. These functions
only do inplace conversion and often require casts to call them. This can
cause bugs because you can easily cast away a const and change the
contents of a read-only buffer. These functions are available
in InterfaceLib, or when building for Carbon if you #define OLDP2C,
then they are available as a macro.
*/
#if !__LP64__
/*
* c2pstrcpy() *** DEPRECATED ***
*
* Deprecated:
* use CFString instead.
*
* Discussion:
* This function is no longer recommended. Please use CFString
* instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CarbonAccessors.o 1.0.2 and later
*/
extern void
c2pstrcpy(
Str255 dst,
const char * src) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* p2cstrcpy() *** DEPRECATED ***
*
* Deprecated:
* use CFString instead.
*
* Discussion:
* This function is no longer recommended. Please use CFString
* instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CarbonAccessors.o 1.0.2 and later
*/
extern void
p2cstrcpy(
char * dst,
ConstStr255Param src) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* CopyPascalStringToC() *** DEPRECATED ***
*
* Deprecated:
* use CFString instead.
*
* Discussion:
* This function is no longer recommended. Please use CFString
* instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CarbonAccessors.o 1.0.2 and later
*/
extern void
CopyPascalStringToC(
ConstStr255Param src,
char * dst) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* CopyCStringToPascal() *** DEPRECATED ***
*
* Deprecated:
* use CFString instead.
*
* Discussion:
* This function is no longer recommended. Please use CFString
* instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CarbonAccessors.o 1.0.2 and later
*/
extern void
CopyCStringToPascal(
const char * src,
Str255 dst) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
#endif /* !__LP64__ */
#if !__LP64__
/*
* c2pstr() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern StringPtr
c2pstr(char * aStr) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_4, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* C2PStr() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern StringPtr
C2PStr(Ptr cString) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_4, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/*
* p2cstr() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern char *
p2cstr(StringPtr aStr) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* P2CStr() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern Ptr
P2CStr(StringPtr pString) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
#endif /* !__LP64__ */
#if !TARGET_OS_MAC
/* Added for QuickTime 3.0 */
#define C2PStr(a) (StringPtr)c2pstr((Ptr)(a))
#define P2CStr(a) (Ptr)p2cstr(a)
#define CopyPascalStringToC(src,dst) p2cstrcpy(dst,src)
#define CopyCStringToPascal(src,dst) c2pstrcpy(dst,src)
#endif
#if TARGET_OS_MAC && TARGET_API_MAC_CARBON && OLDP2C
/* macros to help source code that uses deprecated inplace */
/* conversion routines to compiler for carbon */
#define p2cstr(aStr) (p2cstrcpy((char *) aStr, aStr) , (char *) aStr)
#define c2pstr(aStr) (c2pstrcpy((StringPtr)aStr, aStr) , (StringPtr) aStr)
#define C2PStr(a) (StringPtr)c2pstr((Ptr)(a))
#define P2CStr(a) (Ptr)p2cstr(a)
#endif
#pragma pack(pop)
#ifdef __cplusplus
}
#endif
#endif /* __TEXTUTILS__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework/Headers/Collections.h | /*
File: CarbonCore/Collections.h
Contains: Collection Manager Interfaces
The contents of this header file are deprecated.
Use Foundation or CoreFoundation collection objects instead.
Copyright: © 1989-2011 by Apple Inc. All rights reserved.
*/
#ifndef __COLLECTIONS__
#define __COLLECTIONS__
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
#ifndef __MIXEDMODE__
#include <CarbonCore/MixedMode.h>
#endif
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
/*************/
/* Constants */
/*************/
/* Convenience constants for functions which optionally return values */
enum {
kCollectionDontWantTag = 0,
kCollectionDontWantId = 0,
kCollectionDontWantSize = 0,
kCollectionDontWantAttributes = 0,
kCollectionDontWantIndex = 0,
kCollectionDontWantData = 0
};
/* attributes bits */
enum {
kCollectionNoAttributes = 0x00000000, /* no attributes bits set */
kCollectionAllAttributes = (int)0xFFFFFFFF, /* all attributes bits set */
kCollectionUserAttributes = 0x0000FFFF, /* user attributes bits */
kCollectionDefaultAttributes = 0x40000000 /* default attributes - unlocked, persistent */
};
/*
Attribute bits 0 through 15 (entire low word) are reserved for use by the application.
Attribute bits 16 through 31 (entire high word) are reserved for use by the Collection Manager.
Only bits 31 (kCollectionLockBit) and 30 (kCollectionPersistenceBit) currently have meaning.
*/
enum {
kCollectionUser0Bit = 0,
kCollectionUser1Bit = 1,
kCollectionUser2Bit = 2,
kCollectionUser3Bit = 3,
kCollectionUser4Bit = 4,
kCollectionUser5Bit = 5,
kCollectionUser6Bit = 6,
kCollectionUser7Bit = 7,
kCollectionUser8Bit = 8,
kCollectionUser9Bit = 9,
kCollectionUser10Bit = 10,
kCollectionUser11Bit = 11,
kCollectionUser12Bit = 12,
kCollectionUser13Bit = 13,
kCollectionUser14Bit = 14,
kCollectionUser15Bit = 15,
kCollectionReserved0Bit = 16,
kCollectionReserved1Bit = 17,
kCollectionReserved2Bit = 18,
kCollectionReserved3Bit = 19,
kCollectionReserved4Bit = 20,
kCollectionReserved5Bit = 21,
kCollectionReserved6Bit = 22,
kCollectionReserved7Bit = 23,
kCollectionReserved8Bit = 24,
kCollectionReserved9Bit = 25,
kCollectionReserved10Bit = 26,
kCollectionReserved11Bit = 27,
kCollectionReserved12Bit = 28,
kCollectionReserved13Bit = 29,
kCollectionPersistenceBit = 30,
kCollectionLockBit = 31
};
/* attribute masks */
enum {
kCollectionUser0Mask = 1UL << kCollectionUser0Bit,
kCollectionUser1Mask = 1UL << kCollectionUser1Bit,
kCollectionUser2Mask = 1UL << kCollectionUser2Bit,
kCollectionUser3Mask = 1UL << kCollectionUser3Bit,
kCollectionUser4Mask = 1UL << kCollectionUser4Bit,
kCollectionUser5Mask = 1UL << kCollectionUser5Bit,
kCollectionUser6Mask = 1UL << kCollectionUser6Bit,
kCollectionUser7Mask = 1UL << kCollectionUser7Bit,
kCollectionUser8Mask = 1UL << kCollectionUser8Bit,
kCollectionUser9Mask = 1UL << kCollectionUser9Bit,
kCollectionUser10Mask = 1UL << kCollectionUser10Bit,
kCollectionUser11Mask = 1UL << kCollectionUser11Bit,
kCollectionUser12Mask = 1UL << kCollectionUser12Bit,
kCollectionUser13Mask = 1UL << kCollectionUser13Bit,
kCollectionUser14Mask = 1UL << kCollectionUser14Bit,
kCollectionUser15Mask = 1UL << kCollectionUser15Bit,
kCollectionReserved0Mask = 1UL << kCollectionReserved0Bit,
kCollectionReserved1Mask = 1UL << kCollectionReserved1Bit,
kCollectionReserved2Mask = 1UL << kCollectionReserved2Bit,
kCollectionReserved3Mask = 1UL << kCollectionReserved3Bit,
kCollectionReserved4Mask = 1UL << kCollectionReserved4Bit,
kCollectionReserved5Mask = 1UL << kCollectionReserved5Bit,
kCollectionReserved6Mask = 1UL << kCollectionReserved6Bit,
kCollectionReserved7Mask = 1UL << kCollectionReserved7Bit,
kCollectionReserved8Mask = 1UL << kCollectionReserved8Bit,
kCollectionReserved9Mask = 1UL << kCollectionReserved9Bit,
kCollectionReserved10Mask = 1UL << kCollectionReserved10Bit,
kCollectionReserved11Mask = 1UL << kCollectionReserved11Bit,
kCollectionReserved12Mask = 1UL << kCollectionReserved12Bit,
kCollectionReserved13Mask = 1UL << kCollectionReserved13Bit,
kCollectionPersistenceMask = 1UL << kCollectionPersistenceBit,
kCollectionLockMask = 1UL << kCollectionLockBit
};
/***********/
/* Types */
/***********/
/* abstract data type for a collection */
typedef struct OpaqueCollection* Collection;
/* collection member 4 byte tag */
typedef FourCharCode CollectionTag;
typedef CALLBACK_API( OSErr , CollectionFlattenProcPtr )(SInt32 size, void *data, void *refCon);
typedef CALLBACK_API( OSErr , CollectionExceptionProcPtr )(Collection c, OSErr status);
typedef STACK_UPP_TYPE(CollectionFlattenProcPtr) CollectionFlattenUPP;
typedef STACK_UPP_TYPE(CollectionExceptionProcPtr) CollectionExceptionUPP;
/*
* NewCollectionFlattenUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern CollectionFlattenUPP
NewCollectionFlattenUPP(CollectionFlattenProcPtr userRoutine) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* NewCollectionExceptionUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern CollectionExceptionUPP
NewCollectionExceptionUPP(CollectionExceptionProcPtr userRoutine) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* DisposeCollectionFlattenUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
DisposeCollectionFlattenUPP(CollectionFlattenUPP userUPP) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* DisposeCollectionExceptionUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
DisposeCollectionExceptionUPP(CollectionExceptionUPP userUPP) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* InvokeCollectionFlattenUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern OSErr
InvokeCollectionFlattenUPP(
SInt32 size,
void * data,
void * refCon,
CollectionFlattenUPP userUPP) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* InvokeCollectionExceptionUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern OSErr
InvokeCollectionExceptionUPP(
Collection c,
OSErr status,
CollectionExceptionUPP userUPP) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
#if __MACH__
#ifdef __cplusplus
inline CollectionFlattenUPP NewCollectionFlattenUPP(CollectionFlattenProcPtr userRoutine) { return userRoutine; }
inline CollectionExceptionUPP NewCollectionExceptionUPP(CollectionExceptionProcPtr userRoutine) { return userRoutine; }
inline void DisposeCollectionFlattenUPP(CollectionFlattenUPP) { }
inline void DisposeCollectionExceptionUPP(CollectionExceptionUPP) { }
inline OSErr InvokeCollectionFlattenUPP(SInt32 size, void * data, void * refCon, CollectionFlattenUPP userUPP) { return (*userUPP)(size, data, refCon); }
inline OSErr InvokeCollectionExceptionUPP(Collection c, OSErr status, CollectionExceptionUPP userUPP) { return (*userUPP)(c, status); }
#else
#define NewCollectionFlattenUPP(userRoutine) ((CollectionFlattenUPP)userRoutine)
#define NewCollectionExceptionUPP(userRoutine) ((CollectionExceptionUPP)userRoutine)
#define DisposeCollectionFlattenUPP(userUPP)
#define DisposeCollectionExceptionUPP(userUPP)
#define InvokeCollectionFlattenUPP(size, data, refCon, userUPP) (*userUPP)(size, data, refCon)
#define InvokeCollectionExceptionUPP(c, status, userUPP) (*userUPP)(c, status)
#endif
#endif
/*********************************************/
/************* Public interfaces *************/
/*********************************************/
/*
* NewCollection()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CollectionsLib 1.0 and later
*/
extern Collection
NewCollection(void) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* DisposeCollection()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CollectionsLib 1.0 and later
*/
extern void
DisposeCollection(Collection c) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* CloneCollection()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CollectionsLib 1.0 and later
*/
extern Collection
CloneCollection(Collection c) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* CountCollectionOwners()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CollectionsLib 1.0 and later
*/
extern SInt32
CountCollectionOwners(Collection c) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* RetainCollection()
*
* Availability:
* Mac OS X: in version 10.1 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: not available
*/
extern OSStatus
RetainCollection(Collection c) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_1, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* ReleaseCollection()
*
* Availability:
* Mac OS X: in version 10.1 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: not available
*/
extern OSStatus
ReleaseCollection(Collection c) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_1, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* GetCollectionRetainCount()
*
* Availability:
* Mac OS X: in version 10.1 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: not available
*/
extern ItemCount
GetCollectionRetainCount(Collection c) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_1, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* CopyCollection()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CollectionsLib 1.0 and later
*/
extern Collection
CopyCollection(
Collection srcCollection,
Collection dstCollection) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* GetCollectionDefaultAttributes()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CollectionsLib 1.0 and later
*/
extern SInt32
GetCollectionDefaultAttributes(Collection c) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* SetCollectionDefaultAttributes()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CollectionsLib 1.0 and later
*/
extern void
SetCollectionDefaultAttributes(
Collection c,
SInt32 whichAttributes,
SInt32 newAttributes) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* CountCollectionItems()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CollectionsLib 1.0 and later
*/
extern SInt32
CountCollectionItems(Collection c) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* AddCollectionItem()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CollectionsLib 1.0 and later
*/
extern OSErr
AddCollectionItem(
Collection c,
CollectionTag tag,
SInt32 id,
SInt32 itemSize,
const void * itemData) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* GetCollectionItem()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CollectionsLib 1.0 and later
*/
extern OSErr
GetCollectionItem(
Collection c,
CollectionTag tag,
SInt32 id,
SInt32 * itemSize,
void * itemData) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* RemoveCollectionItem()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CollectionsLib 1.0 and later
*/
extern OSErr
RemoveCollectionItem(
Collection c,
CollectionTag tag,
SInt32 id) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* SetCollectionItemInfo()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CollectionsLib 1.0 and later
*/
extern OSErr
SetCollectionItemInfo(
Collection c,
CollectionTag tag,
SInt32 id,
SInt32 whichAttributes,
SInt32 newAttributes) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* GetCollectionItemInfo()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CollectionsLib 1.0 and later
*/
extern OSErr
GetCollectionItemInfo(
Collection c,
CollectionTag tag,
SInt32 id,
SInt32 * itemIndex,
SInt32 * itemSize,
SInt32 * attributes) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* ReplaceIndexedCollectionItem()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CollectionsLib 1.0 and later
*/
extern OSErr
ReplaceIndexedCollectionItem(
Collection c,
SInt32 itemIndex,
SInt32 itemSize,
const void * itemData) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* GetIndexedCollectionItem()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CollectionsLib 1.0 and later
*/
extern OSErr
GetIndexedCollectionItem(
Collection c,
SInt32 itemIndex,
SInt32 * itemSize,
void * itemData) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* RemoveIndexedCollectionItem()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CollectionsLib 1.0 and later
*/
extern OSErr
RemoveIndexedCollectionItem(
Collection c,
SInt32 itemIndex) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* SetIndexedCollectionItemInfo()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CollectionsLib 1.0 and later
*/
extern OSErr
SetIndexedCollectionItemInfo(
Collection c,
SInt32 itemIndex,
SInt32 whichAttributes,
SInt32 newAttributes) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* GetIndexedCollectionItemInfo()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CollectionsLib 1.0 and later
*/
extern OSErr
GetIndexedCollectionItemInfo(
Collection c,
SInt32 itemIndex,
CollectionTag * tag,
SInt32 * id,
SInt32 * itemSize,
SInt32 * attributes) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* CollectionTagExists()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CollectionsLib 1.0 and later
*/
extern Boolean
CollectionTagExists(
Collection c,
CollectionTag tag) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* CountCollectionTags()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CollectionsLib 1.0 and later
*/
extern SInt32
CountCollectionTags(Collection c) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* GetIndexedCollectionTag()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CollectionsLib 1.0 and later
*/
extern OSErr
GetIndexedCollectionTag(
Collection c,
SInt32 tagIndex,
CollectionTag * tag) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* CountTaggedCollectionItems()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CollectionsLib 1.0 and later
*/
extern SInt32
CountTaggedCollectionItems(
Collection c,
CollectionTag tag) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* GetTaggedCollectionItem()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CollectionsLib 1.0 and later
*/
extern OSErr
GetTaggedCollectionItem(
Collection c,
CollectionTag tag,
SInt32 whichItem,
SInt32 * itemSize,
void * itemData) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* GetTaggedCollectionItemInfo()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CollectionsLib 1.0 and later
*/
extern OSErr
GetTaggedCollectionItemInfo(
Collection c,
CollectionTag tag,
SInt32 whichItem,
SInt32 * id,
SInt32 * itemIndex,
SInt32 * itemSize,
SInt32 * attributes) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* PurgeCollection()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CollectionsLib 1.0 and later
*/
extern void
PurgeCollection(
Collection c,
SInt32 whichAttributes,
SInt32 matchingAttributes) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* PurgeCollectionTag()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CollectionsLib 1.0 and later
*/
extern void
PurgeCollectionTag(
Collection c,
CollectionTag tag) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* EmptyCollection()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CollectionsLib 1.0 and later
*/
extern void
EmptyCollection(Collection c) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* FlattenCollection()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CollectionsLib 1.0 and later
*/
extern OSErr
FlattenCollection(
Collection c,
CollectionFlattenUPP flattenProc,
void * refCon) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* FlattenPartialCollection()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CollectionsLib 1.0 and later
*/
extern OSErr
FlattenPartialCollection(
Collection c,
CollectionFlattenUPP flattenProc,
void * refCon,
SInt32 whichAttributes,
SInt32 matchingAttributes) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* UnflattenCollection()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CollectionsLib 1.0 and later
*/
extern OSErr
UnflattenCollection(
Collection c,
CollectionFlattenUPP flattenProc,
void * refCon) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* GetCollectionExceptionProc()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CollectionsLib 1.0 and later
*/
extern CollectionExceptionUPP
GetCollectionExceptionProc(Collection c) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* SetCollectionExceptionProc()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CollectionsLib 1.0 and later
*/
extern void
SetCollectionExceptionProc(
Collection c,
CollectionExceptionUPP exceptionProc) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* GetNewCollection()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CollectionsLib 1.0 and later
*/
extern Collection
GetNewCollection(SInt16 collectionID) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/**********************************************************************/
/************** Utility routines for handle-based access **************/
/**********************************************************************/
/*
* AddCollectionItemHdl()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CollectionsLib 1.0 and later
*/
extern OSErr
AddCollectionItemHdl(
Collection aCollection,
CollectionTag tag,
SInt32 id,
Handle itemData) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* GetCollectionItemHdl()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CollectionsLib 1.0 and later
*/
extern OSErr
GetCollectionItemHdl(
Collection aCollection,
CollectionTag tag,
SInt32 id,
Handle itemData) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* ReplaceIndexedCollectionItemHdl()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CollectionsLib 1.0 and later
*/
extern OSErr
ReplaceIndexedCollectionItemHdl(
Collection aCollection,
SInt32 itemIndex,
Handle itemData) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* GetIndexedCollectionItemHdl()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CollectionsLib 1.0 and later
*/
extern OSErr
GetIndexedCollectionItemHdl(
Collection aCollection,
SInt32 itemIndex,
Handle itemData) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* FlattenCollectionToHdl()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CollectionsLib 1.0 and later
*/
extern OSErr
FlattenCollectionToHdl(
Collection aCollection,
Handle flattened) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* UnflattenCollectionFromHdl()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CollectionsLib 1.0 and later
*/
extern OSErr
UnflattenCollectionFromHdl(
Collection aCollection,
Handle flattened) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
#if OLDROUTINENAMES
enum {
dontWantTag = kCollectionDontWantTag,
dontWantId = kCollectionDontWantId,
dontWantSize = kCollectionDontWantSize,
dontWantAttributes = kCollectionDontWantAttributes,
dontWantIndex = kCollectionDontWantIndex,
dontWantData = kCollectionDontWantData
};
enum {
noCollectionAttributes = kCollectionNoAttributes,
allCollectionAttributes = kCollectionAllAttributes,
userCollectionAttributes = kCollectionUserAttributes,
defaultCollectionAttributes = kCollectionDefaultAttributes
};
enum {
collectionUser0Bit = kCollectionUser0Bit,
collectionUser1Bit = kCollectionUser1Bit,
collectionUser2Bit = kCollectionUser2Bit,
collectionUser3Bit = kCollectionUser3Bit,
collectionUser4Bit = kCollectionUser4Bit,
collectionUser5Bit = kCollectionUser5Bit,
collectionUser6Bit = kCollectionUser6Bit,
collectionUser7Bit = kCollectionUser7Bit,
collectionUser8Bit = kCollectionUser8Bit,
collectionUser9Bit = kCollectionUser9Bit,
collectionUser10Bit = kCollectionUser10Bit,
collectionUser11Bit = kCollectionUser11Bit,
collectionUser12Bit = kCollectionUser12Bit,
collectionUser13Bit = kCollectionUser13Bit,
collectionUser14Bit = kCollectionUser14Bit,
collectionUser15Bit = kCollectionUser15Bit,
collectionReserved0Bit = kCollectionReserved0Bit,
collectionReserved1Bit = kCollectionReserved1Bit,
collectionReserved2Bit = kCollectionReserved2Bit,
collectionReserved3Bit = kCollectionReserved3Bit,
collectionReserved4Bit = kCollectionReserved4Bit,
collectionReserved5Bit = kCollectionReserved5Bit,
collectionReserved6Bit = kCollectionReserved6Bit,
collectionReserved7Bit = kCollectionReserved7Bit,
collectionReserved8Bit = kCollectionReserved8Bit,
collectionReserved9Bit = kCollectionReserved9Bit,
collectionReserved10Bit = kCollectionReserved10Bit,
collectionReserved11Bit = kCollectionReserved11Bit,
collectionReserved12Bit = kCollectionReserved12Bit,
collectionReserved13Bit = kCollectionReserved13Bit,
collectionPersistenceBit = kCollectionPersistenceBit,
collectionLockBit = kCollectionLockBit
};
enum {
collectionUser0Mask = kCollectionUser0Mask,
collectionUser1Mask = kCollectionUser1Mask,
collectionUser2Mask = kCollectionUser2Mask,
collectionUser3Mask = kCollectionUser3Mask,
collectionUser4Mask = kCollectionUser4Mask,
collectionUser5Mask = kCollectionUser5Mask,
collectionUser6Mask = kCollectionUser6Mask,
collectionUser7Mask = kCollectionUser7Mask,
collectionUser8Mask = kCollectionUser8Mask,
collectionUser9Mask = kCollectionUser9Mask,
collectionUser10Mask = kCollectionUser10Mask,
collectionUser11Mask = kCollectionUser11Mask,
collectionUser12Mask = kCollectionUser12Mask,
collectionUser13Mask = kCollectionUser13Mask,
collectionUser14Mask = kCollectionUser14Mask,
collectionUser15Mask = kCollectionUser15Mask,
collectionReserved0Mask = kCollectionReserved0Mask,
collectionReserved1Mask = kCollectionReserved1Mask,
collectionReserved2Mask = kCollectionReserved2Mask,
collectionReserved3Mask = kCollectionReserved3Mask,
collectionReserved4Mask = kCollectionReserved4Mask,
collectionReserved5Mask = kCollectionReserved5Mask,
collectionReserved6Mask = kCollectionReserved6Mask,
collectionReserved7Mask = kCollectionReserved7Mask,
collectionReserved8Mask = kCollectionReserved8Mask,
collectionReserved9Mask = kCollectionReserved9Mask,
collectionReserved10Mask = kCollectionReserved10Mask,
collectionReserved11Mask = kCollectionReserved11Mask,
collectionReserved12Mask = kCollectionReserved12Mask,
collectionReserved13Mask = kCollectionReserved13Mask,
collectionPersistenceMask = kCollectionPersistenceMask,
collectionLockMask = kCollectionLockMask
};
#endif /* OLDROUTINENAMES */
#ifdef __cplusplus
}
#endif
#endif /* __COLLECTIONS__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework/Headers/StringCompare.h | /*
File: CarbonCore/StringCompare.h
Contains: Public interfaces for String Comparison and related operations
The contents of this header file are deprecated.
Copyright: © 1985-2011 by Apple Inc., all rights reserved.
*/
#ifndef __STRINGCOMPARE__
#define __STRINGCOMPARE__
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
#ifndef __MIXEDMODE__
#include <CarbonCore/MixedMode.h>
#endif
#ifndef __TEXTCOMMON__
#include <CarbonCore/TextCommon.h>
#endif
#ifndef __SCRIPT__
#include <CarbonCore/Script.h>
#endif
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
/*
Here are the current System 7 routine names and the translations to the older forms.
Please use the newer forms in all new code and migrate the older names out of existing
code as maintenance permits.
NEW NAME OLD NAME OBSOLETE FORM (no handle)
CompareString (Str255) IUCompPString (hp only) IUCompString (hp only)
CompareText (ptr/len) IUMagPString IUMagString
IdenticalString (Str255) IUEqualPString (hp only) IUEqualString (hp only)
IdenticalText (ptr/len) IUMagIDPString IUMagIDString
LanguageOrder IULangOrder
ScriptOrder IUScriptOrder
StringOrder (Str255) IUStringOrder (hp only)
TextOrder (ptr/len) IUTextOrder
RelString
CmpString (a only)
EqualString (hp only)
ReplaceText
Carbon only supports the new names. The old names are undefined for Carbon targets.
InterfaceLib always has exported the old names. For C macros have been defined to allow
the use of the new names. For Pascal and Assembly using the new names will result
in link errors.
*/
enum {
/* Special language code values for Language Order*/
systemCurLang = -2, /* current (itlbLang) lang for system script*/
systemDefLang = -3, /* default (table) lang for system script*/
currentCurLang = -4, /* current (itlbLang) lang for current script*/
currentDefLang = -5, /* default lang for current script*/
scriptCurLang = -6, /* current (itlbLang) lang for specified script*/
scriptDefLang = -7 /* default language for a specified script*/
};
/* obsolete names*/
enum {
iuSystemCurLang = systemCurLang,
iuSystemDefLang = systemDefLang,
iuCurrentCurLang = currentCurLang,
iuCurrentDefLang = currentDefLang,
iuScriptCurLang = scriptCurLang,
iuScriptDefLang = scriptDefLang
};
/*
* These routines are available in Carbon with the new names.
*/
#if !__LP64__
/*
* [Mac]ReplaceText() *** DEPRECATED ***
*
* Deprecated:
* use CFStringReplace instead.
*
* Discussion:
* This function is no longer recommended. Please use
* CFStringReplace instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
#if TARGET_OS_MAC
#define MacReplaceText ReplaceText
#endif
extern short
MacReplaceText(
Handle baseText,
Handle substitutionText,
Str15 key) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* ScriptOrder() *** DEPRECATED ***
*
* Deprecated:
* use CFStringCompare or UCCompareText instead.
*
* Discussion:
* This function is no longer recommended. Please use
* CFStringCompare or UCCompareText instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern short
ScriptOrder(
ScriptCode script1,
ScriptCode script2) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* [Mac]CompareString() *** DEPRECATED ***
*
* Deprecated:
* use CFStringCompare or UCCompareText instead.
*
* Discussion:
* This function is no longer recommended. Please use
* CFStringCompare or UCCompareText instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: not available
*/
#if TARGET_OS_MAC
#define MacCompareString CompareString
#endif
extern short
MacCompareString(
ConstStr255Param aStr,
ConstStr255Param bStr,
Handle itl2Handle) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* IdenticalString() *** DEPRECATED ***
*
* Deprecated:
* use CFStringCompare instead.
*
* Discussion:
* This function is no longer recommended. Please use
* CFStringCompare instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: not available
*/
extern short
IdenticalString(
ConstStr255Param aStr,
ConstStr255Param bStr,
Handle itl2Handle) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* StringOrder() *** DEPRECATED ***
*
* Deprecated:
* use CFStringCompare or UCCompareText instead.
*
* Discussion:
* This function is no longer recommended. Please use
* CFStringCompare or UCCompareText instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: not available
*/
extern short
StringOrder(
ConstStr255Param aStr,
ConstStr255Param bStr,
ScriptCode aScript,
ScriptCode bScript,
LangCode aLang,
LangCode bLang) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* CompareText() *** DEPRECATED ***
*
* Deprecated:
* use CFStringCompare or UCCompareText instead.
*
* Discussion:
* This function is no longer recommended. Please use
* CFStringCompare or UCCompareText instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: not available
*/
extern short
CompareText(
const void * aPtr,
const void * bPtr,
short aLen,
short bLen,
Handle itl2Handle) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* IdenticalText() *** DEPRECATED ***
*
* Deprecated:
* use CFStringCompare instead.
*
* Discussion:
* This function is no longer recommended. Please use
* CFStringCompare instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: not available
*/
extern short
IdenticalText(
const void * aPtr,
const void * bPtr,
short aLen,
short bLen,
Handle itl2Handle) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* TextOrder() *** DEPRECATED ***
*
* Deprecated:
* use CFStringCompare or UCCompareText instead.
*
* Discussion:
* This function is no longer recommended. Please use
* CFStringCompare or UCCompareText instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: not available
*/
extern short
TextOrder(
const void * aPtr,
const void * bPtr,
short aLen,
short bLen,
ScriptCode aScript,
ScriptCode bScript,
LangCode aLang,
LangCode bLang) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* LanguageOrder() *** DEPRECATED ***
*
* Deprecated:
* use CFStringCompare or UCCompareText instead.
*
* Discussion:
* This function is no longer recommended. Please use
* CFStringCompare or UCCompareText instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: not available
*/
extern short
LanguageOrder(
LangCode language1,
LangCode language2) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* These routines are available in InterfaceLib with old names.
* Macros are provided for C to allow source code use to the new names.
*/
#endif /* !__LP64__ */
/*
* IUMagPString()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
* IUMagIDPString()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
* IUTextOrder()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
* IULangOrder()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
* IUScriptOrder()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
* IUMagString()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
* IUMagIDString()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
* IUCompPString()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
* IUEqualPString()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
* IUStringOrder()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
* IUCompString()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
* IUEqualString()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
#if CALL_NOT_IN_CARBON
#if TARGET_OS_MAC
#define CompareString(aStr, bStr, itl2Handle) \
IUCompPString(aStr, bStr, itl2Handle)
#endif
#define CompareText(aPtr, bPtr, aLen, bLen, itl2Handle) \
IUMagPString(aPtr, bPtr, aLen, bLen, itl2Handle)
#define IdenticalString(aStr, bStr, itl2Handle) \
IUEqualPString(aStr, bStr, itl2Handle)
#define IdenticalText(aPtr, bPtr, aLen, bLen, itl2Handle) \
IUMagIDPString(aPtr, bPtr, aLen, bLen, itl2Handle)
#define StringOrder(aStr, bStr, aScript, bScript, aLang, bLang) \
IUStringOrder(aStr, bStr, aScript, bScript, aLang, bLang)
#define TextOrder(aPtr, bPtr, aLen, bLen, aScript, bScript, aLang, bLang) \
IUTextOrder(aPtr, bPtr, aLen, bLen, aScript, bScript, aLang, bLang)
#define LanguageOrder(language1, language2) \
IULangOrder(language1, language2)
#endif /* CALL_NOT_IN_CARBON */
/*
* iucomppstring()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
* iuequalpstring()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
* iustringorder()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
* iucompstring()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
* iuequalstring()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
#if !__LP64__
/*
* RelString() *** DEPRECATED ***
*
* Deprecated:
* use CFStringCompare or UCCompareText instead.
*
* Discussion:
* This function is no longer recommended. Please use
* CFStringCompare or UCCompareText instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern short
RelString(
ConstStr255Param str1,
ConstStr255Param str2,
Boolean caseSensitive,
Boolean diacSensitive) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* EqualString() *** DEPRECATED ***
*
* Deprecated:
* use CFStringCompare instead.
*
* Discussion:
* This function is no longer recommended. Please use
* CFStringCompare instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern Boolean
EqualString(
ConstStr255Param str1,
ConstStr255Param str2,
Boolean caseSensitive,
Boolean diacSensitive) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
#endif /* !__LP64__ */
#if !__LP64__
/*
* relstring() *** DEPRECATED ***
*
* Deprecated:
* use CFStringCompare or UCCompareText instead.
*
* Discussion:
* This function is no longer recommended. Please use
* CFStringCompare or UCCompareText instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern short
relstring(
const char * str1,
const char * str2,
Boolean caseSensitive,
Boolean diacSensitive) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* equalstring()
*
* Availability:
* Mac OS X: not available [32-bit only]
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
#endif /* !__LP64__ */
#ifdef __cplusplus
}
#endif
#endif /* __STRINGCOMPARE__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework/Headers/Finder.h | /*
File: CarbonCore/Finder.h
Contains: Finder flags and container types.
The contents of this header file are deprecated.
Copyright: © 1990-2011 by Apple Inc. All rights reserved.
*/
#ifndef __FINDER__
#define __FINDER__
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#pragma pack(push, 2)
/* Creator and type of clipping files */
enum {
kClippingCreator = 'drag',
kClippingPictureType = 'clpp',
kClippingTextType = 'clpt',
kClippingSoundType = 'clps',
kClippingUnknownType = 'clpu'
};
/* Creator and type of Internet Location files */
enum {
kInternetLocationCreator = 'drag',
kInternetLocationHTTP = 'ilht',
kInternetLocationFTP = 'ilft',
kInternetLocationFile = 'ilfi',
kInternetLocationMail = 'ilma',
kInternetLocationNNTP = 'ilnw',
kInternetLocationAFP = 'ilaf',
kInternetLocationAppleTalk = 'ilat',
kInternetLocationNSL = 'ilns',
kInternetLocationGeneric = 'ilge'
};
enum {
kCustomIconResource = -16455 /* Custom icon family resource ID */
};
/* In order to specify any of the information described in the */
/* CustomBadgeResource data structure you must clear the kExtendedFlagsAreInvalid */
/* and set kExtendedFlagHasCustomBadge of the FXInfo.fdXFlags or DXInfo.frXFlags field, */
/* and add a resource of type kCustomBadgeResourceType and ID kCustomBadgeResourceID to */
/* the file or to the "Icon/n" file for a folder */
enum {
kCustomBadgeResourceType = 'badg',
kCustomBadgeResourceID = kCustomIconResource,
kCustomBadgeResourceVersion = 0
};
struct CustomBadgeResource {
SInt16 version; /* This is version kCustomBadgeResourceVersion*/
SInt16 customBadgeResourceID; /* If not 0, the ID of a resource to use on top*/
/* of the icon for this file or folder*/
OSType customBadgeType; /* If not 0, the type and creator of an icon*/
OSType customBadgeCreator; /* to use on top of the icon*/
OSType windowBadgeType; /* If not 0, the type and creator of an icon*/
OSType windowBadgeCreator; /* to display in the header of the window for this */
/* file or folder*/
OSType overrideType; /* If not 0, the type and creator of an icon to*/
OSType overrideCreator; /* use INSTEAD of the icon for this file or folder*/
};
typedef struct CustomBadgeResource CustomBadgeResource;
typedef CustomBadgeResource * CustomBadgeResourcePtr;
typedef CustomBadgeResourcePtr * CustomBadgeResourceHandle;
/* You can specify routing information for a file by including a 'rout' 0
resource in it and setting the kExtendedFlagHasRoutingInfo bit in the extended
Finder flags.
The 'rout' resource is an array of RoutingResourceEntry. Each entry is considered
in turn. The first matching entry is used.
If the creator and fileType match the file being dropped and targetFolder match
the folder ID of the folder being dropped onto, then the file is rerouted
into the specified destination folder.
The only target folder currently supported is the system folder,
kSystemFolderType = 'macs'.
*/
enum {
kRoutingResourceType = 'rout',
kRoutingResourceID = 0
};
struct RoutingResourceEntry {
OSType creator; /* Use '****' or 0 to match any creator */
OSType fileType; /* Use '****' or 0 to match any file type */
OSType targetFolder; /* Folder ID of the folder this file was dropped onto */
OSType destinationFolder; /* Folder that the source will be routed to */
OSType reservedField; /* Set to 0 */
};
typedef struct RoutingResourceEntry RoutingResourceEntry;
typedef RoutingResourceEntry * RoutingResourcePtr;
typedef RoutingResourcePtr * RoutingResourceHandle;
/* Types for special container aliases */
enum {
kContainerFolderAliasType = 'fdrp', /* type for folder aliases */
kContainerTrashAliasType = 'trsh', /* type for trash folder aliases */
kContainerHardDiskAliasType = 'hdsk', /* type for hard disk aliases */
kContainerFloppyAliasType = 'flpy', /* type for floppy aliases */
kContainerServerAliasType = 'srvr', /* type for server aliases */
kApplicationAliasType = 'adrp', /* type for application aliases */
kContainerAliasType = 'drop', /* type for all other containers */
kDesktopPrinterAliasType = 'dtpa', /* type for Desktop Printer alias */
kContainerCDROMAliasType = 'cddr', /* type for CD-ROM alias */
kApplicationCPAliasType = 'acdp', /* type for application control panel alias */
kApplicationDAAliasType = 'addp', /* type for application DA alias */
kPackageAliasType = 'fpka', /* type for plain package alias */
kAppPackageAliasType = 'fapa' /* type for application package alias */
};
/* Types for Special folder aliases */
enum {
kSystemFolderAliasType = 'fasy',
kAppleMenuFolderAliasType = 'faam',
kStartupFolderAliasType = 'fast',
kPrintMonitorDocsFolderAliasType = 'fapn',
kPreferencesFolderAliasType = 'fapf',
kControlPanelFolderAliasType = 'fact',
kExtensionFolderAliasType = 'faex'
};
/* Types for AppleShare folder aliases */
enum {
kExportedFolderAliasType = 'faet',
kDropFolderAliasType = 'fadr',
kSharedFolderAliasType = 'fash',
kMountedFolderAliasType = 'famn'
};
/* Finder flags (finderFlags, fdFlags and frFlags) */
/* Any flag reserved or not specified should be set to 0. */
/* If a flag applies to a file, but not to a folder, make sure to check */
/* that the item is not a folder by checking ((ParamBlockRec.ioFlAttrib & ioDirMask) == 0) */
enum {
kIsOnDesk = 0x0001, /* Files and folders (System 6) */
kColor = 0x000E, /* Files and folders */
/* bit 0x0020 was kRequireSwitchLaunch, but is now reserved for future use*/
kIsShared = 0x0040, /* Files only (Applications only) */
/* If clear, the application needs to write to */
/* its resource fork, and therefore cannot be */
/* shared on a server */
kHasNoINITs = 0x0080, /* Files only (Extensions/Control Panels only) */
/* This file contains no INIT resource */
kHasBeenInited = 0x0100, /* Files only */
/* Clear if the file contains desktop database */
/* resources ('BNDL', 'FREF', 'open', 'kind'...) */
/* that have not been added yet. Set only by the Finder */
/* Reserved for folders - make sure this bit is cleared for folders */
/* bit 0x0200 was the letter bit for AOCE, but is now reserved for future use */
kHasCustomIcon = 0x0400, /* Files and folders */
kIsStationery = 0x0800, /* Files only */
kNameLocked = 0x1000, /* Files and folders */
kHasBundle = 0x2000, /* Files and folders */
/* Indicates that a file has a BNDL resource */
/* Indicates that a folder is displayed as a package */
kIsInvisible = 0x4000, /* Files and folders */
kIsAlias = 0x8000 /* Files only */
};
/* Obsolete. Use names defined above. */
enum {
fOnDesk = kIsOnDesk,
fHasBundle = kHasBundle,
fInvisible = kIsInvisible
};
/* Obsolete */
enum {
fTrash = -3,
fDesktop = -2,
fDisk = 0
};
#if OLDROUTINENAMES
enum {
kIsStationary = kIsStationery
};
#endif /* OLDROUTINENAMES */
/* Extended flags (extendedFinderFlags, fdXFlags and frXFlags) */
/* Any flag not specified should be set to 0. */
enum {
kExtendedFlagsAreInvalid = 0x8000, /* If set the other extended flags are ignored */
kExtendedFlagHasCustomBadge = 0x0100, /* Set if the file or folder has a badge resource */
kExtendedFlagObjectIsBusy = 0x0080, /* Set if the object is marked as busy/incomplete */
kExtendedFlagHasRoutingInfo = 0x0004 /* Set if the file contains routing info resource */
};
/* Use a filetype in this range to indicate that a file is temporarily busy */
/* (while it is being downloaded or installed, for example). This prevents */
/* Finder 8.5 and later from trying to change the item's attributes before it */
/* is fully created. -- If you provide a series of 'BNDL' icons for your creator */
/* and some of these filetypes, you can achieve limited icon animation while */
/* the file creation progresses. */
enum {
kFirstMagicBusyFiletype = 'bzy ',
kLastMagicBusyFiletype = 'bzy?'
};
/* Use this date as a file's or folder's creation date to indicate that it is */
/* temporarily busy (while it is being downloaded or installed, for example). */
/* This prevents Finder from trying to change the item's attributes before it */
/* is fully created (Finder 8.5 and 8.6 check file creation dates; later Finders */
/* may check folder creation dates as well). */
enum {
kMagicBusyCreationDate = 0x4F3AFDB0
};
/*------------------------------------------------------------------------*/
/*
The following data structures are binary compatible with FInfo, DInfo,
FXInfo and DXInfo but represent the Mac OS 8 semantic of the fields.
Use these data structures preferably to FInfo, etc...
*/
/*------------------------------------------------------------------------*/
struct FileInfo {
OSType fileType; /* The type of the file */
OSType fileCreator; /* The file's creator */
UInt16 finderFlags; /* ex: kHasBundle, kIsInvisible... */
Point location; /* File's location in the folder */
/* If set to {0, 0}, the Finder will place the item automatically */
UInt16 reservedField; /* (set to 0) */
};
typedef struct FileInfo FileInfo;
struct FolderInfo {
Rect windowBounds; /* The position and dimension of the folder's window */
UInt16 finderFlags; /* ex. kIsInvisible, kNameLocked, etc.*/
Point location; /* Folder's location in the parent folder */
/* If set to {0, 0}, the Finder will place the item automatically */
UInt16 reservedField; /* (set to 0) */
};
typedef struct FolderInfo FolderInfo;
struct ExtendedFileInfo {
SInt16 reserved1[4]; /* Reserved (set to 0) */
UInt16 extendedFinderFlags; /* Extended flags (custom badge, routing info...) */
SInt16 reserved2; /* Reserved (set to 0). Comment ID if high-bit is clear */
SInt32 putAwayFolderID; /* Put away folder ID */
};
typedef struct ExtendedFileInfo ExtendedFileInfo;
struct ExtendedFolderInfo {
Point scrollPosition; /* Scroll position (for icon views) */
SInt32 reserved1; /* Reserved (set to 0) */
UInt16 extendedFinderFlags; /* Extended flags (custom badge, routing info...) */
SInt16 reserved2; /* Reserved (set to 0). Comment ID if high-bit is clear */
SInt32 putAwayFolderID; /* Put away folder ID */
};
typedef struct ExtendedFolderInfo ExtendedFolderInfo;
/*------------------------------------------------------------------------*/
/*
The following data structures are here for compatibility.
Use the new data structures replacing them if possible (i.e. FileInfo
instead of FInfo, etc...)
*/
/*------------------------------------------------------------------------*/
/* File info */
/*
IMPORTANT:
In MacOS 8, the fdFldr field has become reserved for the Finder.
*/
struct FInfo {
OSType fdType; /* The type of the file */
OSType fdCreator; /* The file's creator */
UInt16 fdFlags; /* Flags ex. kHasBundle, kIsInvisible, etc. */
Point fdLocation; /* File's location in folder. */
/* If set to {0, 0}, the Finder will place the item automatically */
SInt16 fdFldr; /* Reserved (set to 0) */
};
typedef struct FInfo FInfo;
/* Extended file info */
/*
IMPORTANT:
In MacOS 8, the fdIconID and fdComment fields were changed
to become reserved fields for the Finder.
The fdScript has become an extended flag.
*/
struct FXInfo {
SInt16 fdIconID; /* Reserved (set to 0) */
SInt16 fdReserved[3]; /* Reserved (set to 0) */
SInt8 fdScript; /* Extended flags. Script code if high-bit is set */
SInt8 fdXFlags; /* Extended flags */
SInt16 fdComment; /* Reserved (set to 0). Comment ID if high-bit is clear */
SInt32 fdPutAway; /* Put away folder ID */
};
typedef struct FXInfo FXInfo;
/* Folder info */
/*
IMPORTANT:
In MacOS 8, the frView field was changed to become reserved
field for the Finder.
*/
struct DInfo {
Rect frRect; /* Folder's window bounds */
UInt16 frFlags; /* Flags ex. kIsInvisible, kNameLocked, etc.*/
Point frLocation; /* Folder's location in parent folder */
/* If set to {0, 0}, the Finder will place the item automatically */
SInt16 frView; /* Reserved (set to 0) */
};
typedef struct DInfo DInfo;
/* Extended folder info */
/*
IMPORTANT:
In MacOS 8, the frOpenChain and frComment fields were changed
to become reserved fields for the Finder.
The frScript has become an extended flag.
*/
struct DXInfo {
Point frScroll; /* Scroll position */
SInt32 frOpenChain; /* Reserved (set to 0) */
SInt8 frScript; /* Extended flags. Script code if high-bit is set */
SInt8 frXFlags; /* Extended flags */
SInt16 frComment; /* Reserved (set to 0). Comment ID if high-bit is clear */
SInt32 frPutAway; /* Put away folder ID */
};
typedef struct DXInfo DXInfo;
/* ControlPanelDefProcPtr and cdev constants have all been moved to Processes.i*/
#pragma pack(pop)
#endif /* __FINDER__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework/Headers/TextEncodingConverter.h | /*
File: CarbonCore/TextEncodingConverter.h
Contains: Text Encoding Conversion Interfaces.
Copyright: © 1994-2011 Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __TEXTENCODINGCONVERTER__
#define __TEXTENCODINGCONVERTER__
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
#ifndef __TEXTCOMMON__
#include <CarbonCore/TextCommon.h>
#endif
#ifndef __CFSTRING__
#include <CoreFoundation/CFString.h>
#endif
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
#pragma pack(push, 2)
typedef OSType TECPluginSignature;
typedef UInt32 TECPluginVersion;
/* plugin signatures */
enum {
kTECSignature = 'encv',
kTECUnicodePluginSignature = 'puni',
kTECJapanesePluginSignature = 'pjpn',
kTECChinesePluginSignature = 'pzho',
kTECKoreanPluginSignature = 'pkor'
};
/* converter object reference */
typedef struct OpaqueTECObjectRef* TECObjectRef;
typedef struct OpaqueTECSnifferObjectRef* TECSnifferObjectRef;
typedef OSType TECPluginSig;
struct TECConversionInfo {
TextEncoding sourceEncoding;
TextEncoding destinationEncoding;
UInt16 reserved1;
UInt16 reserved2;
};
typedef struct TECConversionInfo TECConversionInfo;
/*
* TECInternetNameUsageMask
*
* Discussion:
* Mask values that control the mapping between TextEncoding and
* IANA charset name or MIB enum.
*/
typedef UInt32 TECInternetNameUsageMask;
enum {
/* Use one of the following*/
/*
* Use the default type of mapping given other usage information
* (none currently defined).
*/
kTECInternetNameDefaultUsageMask = 0,
/*
* Use the closest possible match between TextEncoding value and IANA
* charset name or MIB enum
*/
kTECInternetNameStrictUsageMask = 1,
/*
* When mapping from IANA charset name or MIB enum to TextEncoding,
* map to the largest superset of the encoding specified by the
* charset name or MIB enum (i.e. be tolerant). When mapping from
* TextEncoding to IANA charset name or MIB enum, typically map to
* the most generic or widely recognized charset name or MIB enum.
*/
kTECInternetNameTolerantUsageMask = 2
};
/* Special values for MIB enums */
enum {
kTEC_MIBEnumDontCare = -1
};
/* Additional control flags for TECSetBasicOptions */
enum {
kTECDisableFallbacksBit = 16,
kTECDisableLooseMappingsBit = 17
};
enum {
kTECDisableFallbacksMask = 1L << kTECDisableFallbacksBit,
kTECDisableLooseMappingsMask = 1L << kTECDisableLooseMappingsBit
};
/* return number of encodings types supported by user's configuraton of the encoding converter */
/*
* TECCountAvailableTextEncodings()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in TextEncodingConverter 1.1 and later
*/
extern OSStatus
TECCountAvailableTextEncodings(ItemCount * numberEncodings) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/* fill in an array of type TextEncoding passed in by the user with types of encodings the current configuration of the encoder can handle. */
/*
* TECGetAvailableTextEncodings()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in TextEncodingConverter 1.2 and later
*/
extern OSStatus
TECGetAvailableTextEncodings(
TextEncoding availableEncodings[],
ItemCount maxAvailableEncodings,
ItemCount * actualAvailableEncodings) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/* return number of from-to encoding conversion pairs supported */
/*
* TECCountDirectTextEncodingConversions()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in TextEncodingConverter 1.2 and later
*/
extern OSStatus
TECCountDirectTextEncodingConversions(ItemCount * numberOfEncodings) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/* fill in an array of type TextEncodingPair passed in by the user with types of encoding pairs the current configuration of the encoder can handle. */
/*
* TECGetDirectTextEncodingConversions()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in TextEncodingConverter 1.2 and later
*/
extern OSStatus
TECGetDirectTextEncodingConversions(
TECConversionInfo availableConversions[],
ItemCount maxAvailableConversions,
ItemCount * actualAvailableConversions) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/* return number of encodings a given encoding can be converter into */
/*
* TECCountDestinationTextEncodings()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in TextEncodingConverter 1.2 and later
*/
extern OSStatus
TECCountDestinationTextEncodings(
TextEncoding inputEncoding,
ItemCount * numberOfEncodings) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/* fill in an array of type TextEncodingPair passed in by the user with types of encodings pairs the current configuration of the encoder can handle. */
/*
* TECGetDestinationTextEncodings()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in TextEncodingConverter 1.2 and later
*/
extern OSStatus
TECGetDestinationTextEncodings(
TextEncoding inputEncoding,
TextEncoding destinationEncodings[],
ItemCount maxDestinationEncodings,
ItemCount * actualDestinationEncodings) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/* get info about a text encoding */
/*
* TECGetTextEncodingInternetName()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in TextEncodingConverter 1.1 and later
*/
extern OSStatus
TECGetTextEncodingInternetName(
TextEncoding textEncoding,
Str255 encodingName) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/*
* TECGetTextEncodingFromInternetName()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in TextEncodingConverter 1.1 and later
*/
extern OSStatus
TECGetTextEncodingFromInternetName(
TextEncoding * textEncoding,
ConstStr255Param encodingName) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/* create/dispose converters */
/*
* TECCreateConverter()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in TextEncodingConverter 1.1 and later
*/
extern OSStatus
TECCreateConverter(
TECObjectRef * newEncodingConverter,
TextEncoding inputEncoding,
TextEncoding outputEncoding) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/*
* TECCreateConverterFromPath()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in TextEncodingConverter 1.2 and later
*/
extern OSStatus
TECCreateConverterFromPath(
TECObjectRef * newEncodingConverter,
const TextEncoding inPath[],
ItemCount inEncodings) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/*
* TECDisposeConverter()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in TextEncodingConverter 1.1 and later
*/
extern OSStatus
TECDisposeConverter(TECObjectRef newEncodingConverter) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/* convert text encodings */
/*
* TECClearConverterContextInfo()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in TextEncodingConverter 1.2 and later
*/
extern OSStatus
TECClearConverterContextInfo(TECObjectRef encodingConverter) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/*
* TECConvertText()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in TextEncodingConverter 1.2 and later
*/
extern OSStatus
TECConvertText(
TECObjectRef encodingConverter,
ConstTextPtr inputBuffer,
ByteCount inputBufferLength,
ByteCount * actualInputLength,
TextPtr outputBuffer,
ByteCount outputBufferLength,
ByteCount * actualOutputLength) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/*
* TECFlushText()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in TextEncodingConverter 1.2 and later
*/
extern OSStatus
TECFlushText(
TECObjectRef encodingConverter,
TextPtr outputBuffer,
ByteCount outputBufferLength,
ByteCount * actualOutputLength) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/* one-to-many routines */
/*
* TECCountSubTextEncodings()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in TextEncodingConverter 1.2 and later
*/
extern OSStatus
TECCountSubTextEncodings(
TextEncoding inputEncoding,
ItemCount * numberOfEncodings) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/*
* TECGetSubTextEncodings()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in TextEncodingConverter 1.2 and later
*/
extern OSStatus
TECGetSubTextEncodings(
TextEncoding inputEncoding,
TextEncoding subEncodings[],
ItemCount maxSubEncodings,
ItemCount * actualSubEncodings) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/*
* TECGetEncodingList()
*
* Parameters:
*
* encodingConverter:
* The encodingConverter to return the encoding list for
*
* numEncodings:
* On exit, the number of encodings in encodingList
*
* encodingList:
* On exit, a handle containing numEncodings values of type
* TextEncoding, for each known encoding. Do not dispose of this
* handle.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in TextEncodingConverter 1.1 and later
*/
extern OSStatus
TECGetEncodingList(
TECObjectRef encodingConverter,
ItemCount * numEncodings,
Handle * encodingList) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/*
* TECCreateOneToManyConverter()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in TextEncodingConverter 1.2 and later
*/
extern OSStatus
TECCreateOneToManyConverter(
TECObjectRef * newEncodingConverter,
TextEncoding inputEncoding,
ItemCount numOutputEncodings,
const TextEncoding outputEncodings[]) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/*
* TECConvertTextToMultipleEncodings()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in TextEncodingConverter 1.2 and later
*/
extern OSStatus
TECConvertTextToMultipleEncodings(
TECObjectRef encodingConverter,
ConstTextPtr inputBuffer,
ByteCount inputBufferLength,
ByteCount * actualInputLength,
TextPtr outputBuffer,
ByteCount outputBufferLength,
ByteCount * actualOutputLength,
TextEncodingRun outEncodingsBuffer[],
ItemCount maxOutEncodingRuns,
ItemCount * actualOutEncodingRuns) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/*
* TECFlushMultipleEncodings()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in TextEncodingConverter 1.2 and later
*/
extern OSStatus
TECFlushMultipleEncodings(
TECObjectRef encodingConverter,
TextPtr outputBuffer,
ByteCount outputBufferLength,
ByteCount * actualOutputLength,
TextEncodingRun outEncodingsBuffer[],
ItemCount maxOutEncodingRuns,
ItemCount * actualOutEncodingRuns) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/* international internet info */
/*
* TECCountWebTextEncodings()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in TextEncodingConverter 1.2 and later
*/
extern OSStatus
TECCountWebTextEncodings(
RegionCode locale,
ItemCount * numberEncodings) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/*
* TECGetWebTextEncodings()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in TextEncodingConverter 1.2 and later
*/
extern OSStatus
TECGetWebTextEncodings(
RegionCode locale,
TextEncoding availableEncodings[],
ItemCount maxAvailableEncodings,
ItemCount * actualAvailableEncodings) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/*
* TECCountMailTextEncodings()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in TextEncodingConverter 1.2 and later
*/
extern OSStatus
TECCountMailTextEncodings(
RegionCode locale,
ItemCount * numberEncodings) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/*
* TECGetMailTextEncodings()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in TextEncodingConverter 1.2 and later
*/
extern OSStatus
TECGetMailTextEncodings(
RegionCode locale,
TextEncoding availableEncodings[],
ItemCount maxAvailableEncodings,
ItemCount * actualAvailableEncodings) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/* examine text encodings */
/*
* TECCountAvailableSniffers()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in TextEncodingConverter 1.2 and later
*/
extern OSStatus
TECCountAvailableSniffers(ItemCount * numberOfEncodings) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/*
* TECGetAvailableSniffers()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in TextEncodingConverter 1.2 and later
*/
extern OSStatus
TECGetAvailableSniffers(
TextEncoding availableSniffers[],
ItemCount maxAvailableSniffers,
ItemCount * actualAvailableSniffers) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/*
* TECCreateSniffer()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in TextEncodingConverter 1.2 and later
*/
extern OSStatus
TECCreateSniffer(
TECSnifferObjectRef * encodingSniffer,
const TextEncoding testEncodings[],
ItemCount numTextEncodings) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/*
* TECSniffTextEncoding()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in TextEncodingConverter 1.2 and later
*/
extern OSStatus
TECSniffTextEncoding(
TECSnifferObjectRef encodingSniffer,
ConstTextPtr inputBuffer,
ByteCount inputBufferLength,
TextEncoding testEncodings[],
ItemCount numTextEncodings,
ItemCount numErrsArray[],
ItemCount maxErrs,
ItemCount numFeaturesArray[],
ItemCount maxFeatures) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/*
* TECDisposeSniffer()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in TextEncodingConverter 1.2 and later
*/
extern OSStatus
TECDisposeSniffer(TECSnifferObjectRef encodingSniffer) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/*
* TECClearSnifferContextInfo()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in TextEncodingConverter 1.2 and later
*/
extern OSStatus
TECClearSnifferContextInfo(TECSnifferObjectRef encodingSniffer) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/*
* TECSetBasicOptions()
*
* Summary:
* Sets encodingConverter options affecting
* TECConvertText[ToMultipleEncodings].
*
* Parameters:
*
* encodingConverter:
* The high-level encoding converter object created by
* TECCreateConverter or TECCreateOneToManyConverter whose
* behavior is to be modified by the options specified in
* controlFlags.
*
* controlFlags:
* A bit mask specifying the desired options. The following mask
* constants are valid for this parameter; multiple mask constants
* may be ORed together to set multiple options; passing 0 for
* this parameter clears all options:
*
* kUnicodeForceASCIIRangeMask, kUnicodeNoHalfwidthCharsMask
* (defined in UnicodeConverter.h)
*
* kTECDisableFallbacksMask, kTECDisableLooseMappingsMask (defined
* above) - loose and fallback mappings are both enabled by
* default for the TextEncodingConverter.h conversion APIs
* (TECConvertText, TECConvertTextToMultipleEncodings), unlike the
* behavior of the conversion APIs in UnicodeConverter.h. These
* options may be used to disable loose and/or fallback mappings
* for the TextEncodingConverter.h conversion APIs.
*
* Result:
* The function returns paramErr for invalid masks,
* kTECCorruptConverterErr for an invalid encodingConverter, noErr
* otherwise.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x, is available on Mac OS X version 10.3 and later
* Non-Carbon CFM: in TextEncodingConverter 1.5 and later
*/
extern OSStatus
TECSetBasicOptions(
TECObjectRef encodingConverter,
OptionBits controlFlags) __OSX_AVAILABLE_STARTING(__MAC_10_3, __IPHONE_NA);
/* Map TextEncoding values to/from IANA charset names and/or MIB enums, with usage control */
/*
* TECCopyTextEncodingInternetNameAndMIB()
*
* Summary:
* Converts a TextEncoding value to an IANA charset name and/or a
* MIB enum value
*
* Discussion:
* Given a TextEncoding value, this function maps it to an IANA
* charset name (if encodingNamePtr is non-NULL) and/or a MIB enum
* value (if mibEnumPtr is non-NULL), as specified by the usage
* parameter.
*
* Parameters:
*
* textEncoding:
* A TextEncoding value to map to a charset name and/or MIB enum.
*
* usage:
* Specifies the type of mapping desired (see
* TECInternetNameUsageMask above).
*
* encodingNamePtr:
* If non-NULL, is a pointer to a CStringRef for an immutable
* CFString created by this function; when the caller is finished
* with it, the caller must dispose of it by calling CFRelease.
*
* mibEnumPtr:
* If non-NULL, is a pointer to an SInt32 that will be set to the
* appropriate MIB enum value, or to 0 (or kTEC_MIBEnumDontCare)
* if there is no appropriate MIB enum value (valid MIB enums
* begin at 3).
*
* Result:
* The function returns paramErr if encodingNamePtr and mibEnumPtr
* are both NULL. It returns kTextUnsupportedEncodingErr if it has
* no data for the supplied textEncoding. It returns noErr if it
* found useful data.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern OSStatus
TECCopyTextEncodingInternetNameAndMIB(
TextEncoding textEncoding,
TECInternetNameUsageMask usage,
CFStringRef * encodingNamePtr, /* can be NULL */
SInt32 * mibEnumPtr) /* can be NULL */ __OSX_AVAILABLE_STARTING(__MAC_10_3, __IPHONE_NA);
/*
* TECGetTextEncodingFromInternetNameOrMIB()
*
* Summary:
* Converts an IANA charset name or a MIB enum value to a
* TextEncoding value
*
* Discussion:
* If encodingName is non-NULL, this function treats it as an IANA
* charset name and maps it to a TextEncoding value; in this case
* mibEnum is ignored, and may be set to kTEC_MIBEnumDontCare.
* Otherwise, this function maps the mibEnum to a TextEncoding
* value. In either case, the mapping is controlled by the usage
* parameter. The textEncodingPtr parameter must be non-NULL.
*
* Result:
* The function returns paramErr if textEncodingPtr is NULL. It
* returns kTextUnsupportedEncodingErr if it has no data for the
* supplied encodingName or mibEnum. It returns noErr if it found
* useful data.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern OSStatus
TECGetTextEncodingFromInternetNameOrMIB(
TextEncoding * textEncodingPtr,
TECInternetNameUsageMask usage,
CFStringRef encodingName,
SInt32 mibEnum) __OSX_AVAILABLE_STARTING(__MAC_10_3, __IPHONE_NA);
#pragma pack(pop)
#ifdef __cplusplus
}
#endif
#endif /* __TEXTENCODINGCONVERTER__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework/Headers/FixMath.h | /*
File: CarbonCore/FixMath.h
Contains: Fixed Math Interfaces.
The contents of this header file are deprecated.
Copyright: © 1985-2011 by Apple Inc. All rights reserved.
*/
#ifndef __FIXMATH__
#define __FIXMATH__
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
#define fixed1 ((Fixed) 0x00010000L)
#define fract1 ((Fract) 0x40000000L)
#define positiveInfinity ((Fixed) 0x7FFFFFFFL)
#define negativeInfinity ((Fixed) -0x80000000L)
/* The _IntSaturate macro converts a float to an int with saturation:
If x <= -2**31, the result is 0x80000000.
If -2**31 < x < 2**31, the result is x truncated to an integer.
If 2**31 <= x, the result is 0x7fffffff.
*/
#if (defined (__i386__) || defined(__x86_64__)) && __GNUC__
// For comments, see the annotated version below.
#define _IntSaturate(x) ({ \
int _Result = (int) (x); \
__asm__(" \
ucomisd %[LimitFloat], %[xx] \n \
cmovae %[LimitInt], %[_Result] " \
: [_Result] "+r" (_Result) \
: [LimitFloat] "mx" (0x1p31), \
[LimitInt] "mr" (0x7fffffff), \
[xx] "x" ((double)(x)) \
: "cc" \
); \
_Result; })
/*
// Assume result will be x.
int _Result = (x);
__asm__("
// Compare x to the floating-point limit.
ucomisd %[LimitFloat], %[xx] \n
// If xx is too large, set _Result to the integer limit.
cmovae %[LimitInt], %[_Result]
// _Result is input and output, in a general register.
: [_Result] "+r" (_Result)
// LimitFloat is 0x1p31f and may be in memory or an XMM
// register.
: [LimitFloat] "mx" (0x1p31f),
// LimitInt is 0x7fffffff and may be in memory or a general
// register.
[LimitInt] "mr" (0x7fffffff),
// xx is x and must be in an XMM register.
[xx] "x" ((double)(x))
// The condition code is changed.
: "cc"
);
// Return _Result.
_Result;
*/
#elif defined __ppc__ || __ppc64__ || __arm64__
#define _IntSaturate(x) ((int) (x))
#else
#error "Unknown architecture."
// To use unoptimized standard C code, remove above line.
#define _IntSaturate(x) ((x) <= -0x1p31f ? (int) -0x80000000 : \
0x1p31f <= (x) ? (int) 0x7fffffff : (int) (x))
#endif
#define FloatToFixed(a) (_IntSaturate((a) * fixed1))
#define FloatToFract(a) (_IntSaturate((a) * fract1))
#define FixedRound(a) ((short)(((Fixed)(a) + fixed1/2) >> 16))
#define FixedSquareRoot(a) (((Fixed)FractSquareRoot(a) + 64) >> 7)
#define FixedTruncate(a) ((short)((Fixed)(a) >> 16))
#define FixedToFract(a) ((Fract)(a) << 14)
#define FractToFixed(a) (((Fixed)(a) + 8192L) >> 14)
#define FixedToInt(a) ((short)(((Fixed)(a) + fixed1/2) >> 16))
#define IntToFixed(a) ((Fixed)(a) << 16)
#define FixedToFloat(a) ((float)(a) / fixed1)
#define FractToFloat(a) ((float)(a) / fract1)
#define ColorToFract(a) (((Fract) (a) << 14) + ((Fract)(a) + 2 >> 2))
#define FractToColor(a) ((gxColorValue) ((a) - ((a) >> 16) + 8191 >> 14))
/* These macros were removed because of developer complaints of variable name collision. */
//#ifndef ff /* ff is already defined on some platforms */
//#define ff(a) IntToFixed(a)
//#define fl(a) FloatToFixed(a)
//#endif
/*
FixRatio, FixMul, and FixRound were previously in ToolUtils.h
*/
/*
* FixRatio()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern Fixed
FixRatio(
short numer,
short denom) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* FixMul()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern Fixed
FixMul(
Fixed a,
Fixed b) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* FixRound()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern short
FixRound(Fixed x) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* Fix2Frac()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern Fract
Fix2Frac(Fixed x) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* Fix2Long()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern SInt32
Fix2Long(Fixed x) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* Long2Fix()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern Fixed
Long2Fix(SInt32 x) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* Frac2Fix()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern Fixed
Frac2Fix(Fract x) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* FracMul()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern Fract
FracMul(
Fract x,
Fract y) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* FixDiv()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern Fixed
FixDiv(
Fixed x,
Fixed y) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* FracDiv()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern Fract
FracDiv(
Fract x,
Fract y) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* FracSqrt()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern Fract
FracSqrt(Fract x) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* FracSin()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern Fract
FracSin(Fixed x) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* FracCos()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern Fract
FracCos(Fixed x) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* FixATan2()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern Fixed
FixATan2(
SInt32 x,
SInt32 y) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
Frac2X, Fix2X, X2Fix, and X2Frac translate to and from
the floating point type "extended" (that's what the X is for).
On the original Mac this was 80-bits and the functions could be
accessed via A-Traps. When the 68881 co-processor was added,
it used 96-bit floating point types, so the A-Traps could not
be used. When PowerPC was added, it used 64-bit floating point
types, so yet another prototype was added.
*/
/*
* Frac2X()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern double
Frac2X(Fract x) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* Fix2X()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern double
Fix2X(Fixed x) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* X2Fix()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern Fixed
X2Fix(double x) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* X2Frac()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern Fract
X2Frac(double x) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* WideCompare()
*
* Parameters:
*
* target:
* a pointer to the first wide to compare
*
* source:
* a pointer to the second wide to compare
*
* Result:
* return 0 if the value in target == the value in source ; a value
* < 0 if *target < *source and a value > 0 if *target > *source
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern short
WideCompare(
const wide * target,
const wide * source) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* WideAdd()
*
* Discussion:
* Adds the value in source to target and returns target. Note that
* target is updated to the new value.
*
* Parameters:
*
* target:
* a pointer to the value to have source added to
*
* source:
* a pointer to the value to be added to target
*
* Result:
* returns the value target
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern wide *
WideAdd(
wide * target,
const wide * source) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* WideSubtract()
*
* Discussion:
* Subtracts the value in source from target and returns target.
* Note that target is updated to the new value.
*
* Parameters:
*
* target:
* a pointer to the value to have source subtracted from
*
* source:
* a pointer to the value to be substracted from target
*
* Result:
* returns the value target
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern wide *
WideSubtract(
wide * target,
const wide * source) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* WideNegate()
*
* Discussion:
* Negates the value ( twos complement ) in target and returns
* target. Note that target is updated to the new value.
*
* Parameters:
*
* target:
*
* Result:
* returns the value target
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern wide *
WideNegate(wide * target) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* WideShift()
*
* Discussion:
* Shift the value in target by shift bits with upwards rounding of
* the remainder. Note that target is updated to the new value.
*
* Parameters:
*
* target:
* the value to be shifted
*
* shift:
* the count of bits to shift, positive values shift right and
* negative values shift left
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern wide *
WideShift(
wide * target,
SInt32 shift) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* WideSquareRoot()
*
* Discussion:
* Return the closest integer value to the square root for the given
* number.
*
* Parameters:
*
* source:
* the value to calculate the root for
*
* Result:
* the closest integer value to the square root of source
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern UInt32
WideSquareRoot(const wide * source) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* WideMultiply()
*
* Discussion:
* Returns the wide result of multipling two SInt32 values
*
* Parameters:
*
* multiplicand:
*
* multiplier:
*
* target:
* a pointer to where to put the result of multiplying
* multiplicand and multiplier, must not be NULL
*
* Result:
* the value target
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern wide *
WideMultiply(
SInt32 multiplicand,
SInt32 multiplier,
wide * target) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* WideDivide()
*
* Discussion:
* Returns the integer and remainder results after dividing a wide
* value by an SInt32. Will overflow to positiveInfinity or
* negativeInfinity if the result won't fit into an SInt32. If
* remainder is (SInt32) -1 then any overflow rounds to
* negativeInfinity.
*
* Parameters:
*
* dividend:
* the value to be divided
*
* divisor:
* the value to divide by
*
* remainder:
* a pointer to where to put the remainder result, between 0 and
* divisor, after dividing divident by divisor. If NULL, no
* remainder is returned. If (SInt32*) -1, then any overflow
* result will round to negativeInfinity.
*
* Result:
* the integer signed result of dividend / divisor
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern SInt32
WideDivide(
const wide * dividend,
SInt32 divisor,
SInt32 * remainder) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* WideWideDivide()
*
* Discussion:
* Returns the wide integer and remainder results after dividing a
* wide value by an SInt32. Note that dividend is updated with the
* result.
*
* Parameters:
*
* dividend:
* the value to be divided
*
* divisor:
* the value to divide by
*
* remainder:
* a pointer to where to put the remainder result, between 0 and
* divisor, after dividing divident by divisor
*
* Result:
* the wide result of dividend / divisor
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern wide *
WideWideDivide(
wide * dividend,
SInt32 divisor,
SInt32 * remainder) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* WideBitShift()
*
* Discussion:
* Shift the value in target by shift bits. Note that target is
* updated with the shifted result.
*
* Parameters:
*
* target:
* the value to be shifted
*
* shift:
* the count of bits to shift, positive values shift right and
* negative values shift left
*
* Result:
* return the value target
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern wide *
WideBitShift(
wide * target,
SInt32 shift) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* UnsignedFixedMulDiv()
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern UnsignedFixed
UnsignedFixedMulDiv(
UnsignedFixed value,
UnsignedFixed multiplier,
UnsignedFixed divisor) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_4, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
#ifdef __cplusplus
}
#endif
#endif /* __FIXMATH__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework/Headers/NumberFormatting.h | /*
File: CarbonCore/NumberFormatting.h
Contains: Utilites for formatting numbers
Copyright: © 1996-2012 by Apple Inc., all rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __NUMBERFORMATTING__
#define __NUMBERFORMATTING__
#ifndef __CONDITIONALMACROS__
#include <ConditionalMacros.h>
#endif
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
#ifndef __INTLRESOURCES__
#include <CarbonCore/IntlResources.h>
#endif
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
#pragma pack(push, 2)
/*
Here are the current System 7 routine names and the translations to the older forms.
Please use the newer forms in all new code and migrate the older names out of existing
code as maintainance permits.
New Name Old Name(s)
ExtendedToString FormatX2Str
FormatRecToString Format2Str
NumToString
StringToExtended FormatStr2X
StringToFormatRec Str2Format
StringToNum
*/
struct NumFormatString {
UInt8 fLength;
UInt8 fVersion;
char data[254]; /* private data */
};
typedef struct NumFormatString NumFormatString;
typedef NumFormatString NumFormatStringRec;
typedef short FormatStatus;
enum {
fVNumber = 0 /* first version of NumFormatString */
};
typedef SInt8 FormatClass;
enum {
fPositive = 0,
fNegative = 1,
fZero = 2
};
typedef SInt8 FormatResultType;
enum {
fFormatOK = 0,
fBestGuess = 1,
fOutOfSynch = 2,
fSpuriousChars = 3,
fMissingDelimiter = 4,
fExtraDecimal = 5,
fMissingLiteral = 6,
fExtraExp = 7,
fFormatOverflow = 8,
fFormStrIsNAN = 9,
fBadPartsTable = 10,
fExtraPercent = 11,
fExtraSeparator = 12,
fEmptyFormatString = 13
};
struct FVector {
short start;
short length;
};
typedef struct FVector FVector;
/* index by [fPositive..fZero] */
typedef FVector TripleInt[3];
/*
* stringtonum()
*
* Availability:
* Mac OS X: not available
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
/*
* numtostring() *** DEPRECATED ***
*
* Deprecated:
* Depending on requirements, use CFStringCreateWithFormat / CFStringAppendFormat,
* CFNumberFormatterCreate + CFNumberFormatterCreateStringWithNumber, etc.
*
* Discussion:
* This function is no longer recommended. Please use alternates such as
* (depending on requirements) CFStringCreateWithFormat / CFStringAppendFormat,
* CFNumberFormatterCreate + CFNumberFormatterCreateStringWithNumber, etc.
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework but deprecated in 10.8
* CarbonLib: not available
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void
numtostring(
long theNum,
char * theString) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_4, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
#if !__LP64__
/*
* StringToNum() *** DEPRECATED ***
*
* Deprecated:
* use CFStringGetIntValue instead.
*
* Discussion:
* This function is no longer recommended. Please use
* CFStringGetIntValue instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void
StringToNum(
ConstStr255Param theString,
long * theNum) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* NumToString() *** DEPRECATED ***
*
* Deprecated:
* use CFStringCreateWithFormat instead.
*
* Discussion:
* This function is no longer recommended. Please use
* CFStringCreateWithFormat instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void
NumToString(
long theNum,
Str255 theString) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
#endif /* !__LP64__ */
#if !__LP64__
/*
* ExtendedToString() *** DEPRECATED ***
*
* Deprecated:
* use CFNumberFormatterCreateStringWithNumber instead.
*
* Discussion:
* This function is no longer recommended. Please use
* CFNumberFormatterCreateStringWithNumber instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern FormatStatus
ExtendedToString(
const extended80 * x,
const NumFormatString * myCanonical,
const NumberParts * partsTable,
Str255 outString) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* StringToExtended() *** DEPRECATED ***
*
* Deprecated:
* use CFNumberFormatterCreateNumberFromString instead.
*
* Discussion:
* This function is no longer recommended. Please use
* CFNumberFormatterCreateNumberFromString instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern FormatStatus
StringToExtended(
ConstStr255Param source,
const NumFormatString * myCanonical,
const NumberParts * partsTable,
extended80 * x) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* StringToFormatRec() *** DEPRECATED ***
*
* Deprecated:
* use CFNumberFormatterSetFormat instead.
*
* Discussion:
* This function is no longer recommended. Please use
* CFNumberFormatterSetFormat instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern FormatStatus
StringToFormatRec(
ConstStr255Param inString,
const NumberParts * partsTable,
NumFormatString * outString) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* FormatRecToString() *** DEPRECATED ***
*
* Deprecated:
* use CFNumberFormatterSetFormat instead.
*
* Discussion:
* This function is no longer recommended. Please use
* CFNumberFormatterSetFormat instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern FormatStatus
FormatRecToString(
const NumFormatString * myCanonical,
const NumberParts * partsTable,
Str255 outString,
TripleInt positions) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
#endif /* !__LP64__ */
#if OLDROUTINENAMES
#define FormatX2Str(x, myCanonical, partsTable, outString) \
ExtendedToString( x, myCanonical, partsTable, outString)
#define FormatStr2X(source, myCanonical, partsTable, x) \
StringToExtended( source, myCanonical, partsTable, x)
#define Str2Format(inString, partsTable, outString) \
StringToFormatRec(inString, partsTable, outString)
#define Format2Str(myCanonical, partsTable, outString, positions) \
FormatRecToString(myCanonical, partsTable, outString, positions)
#endif /* OLDROUTINENAMES */
#pragma pack(pop)
#ifdef __cplusplus
}
#endif
#endif /* __NUMBERFORMATTING__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework/Headers/MacLocales.h | /*
File: CarbonCore/MacLocales.h
Contains: Types & prototypes for locale functions
Copyright: © 1998-2012 by Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __MACLOCALES__
#define __MACLOCALES__
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
#ifndef __MACERRORS__
#include <CarbonCore/MacErrors.h>
#endif
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
#pragma pack(push, 2)
/*
-------------------------------------------------------------------------------------------------
TYPES & CONSTANTS
-------------------------------------------------------------------------------------------------
*/
typedef struct OpaqueLocaleRef* LocaleRef;
typedef UInt32 LocalePartMask;
enum {
/* bit set requests the following:*/
kLocaleLanguageMask = 1L << 0, /* ISO 639-1 or -2 language code (2 or 3 letters)*/
kLocaleLanguageVariantMask = 1L << 1, /* custom string for language variant*/
kLocaleScriptMask = 1L << 2, /* ISO 15924 script code (2 letters)*/
kLocaleScriptVariantMask = 1L << 3, /* custom string for script variant*/
kLocaleRegionMask = 1L << 4, /* ISO 3166 country/region code (2 letters)*/
kLocaleRegionVariantMask = 1L << 5, /* custom string for region variant*/
kLocaleAllPartsMask = 0x0000003F /* all of the above*/
};
typedef FourCharCode LocaleOperationClass;
/* constants for LocaleOperationClass are in UnicodeUtilities interfaces*/
typedef FourCharCode LocaleOperationVariant;
struct LocaleAndVariant {
LocaleRef locale;
LocaleOperationVariant opVariant;
};
typedef struct LocaleAndVariant LocaleAndVariant;
typedef UInt32 LocaleNameMask;
enum {
/* bit set requests the following:*/
kLocaleNameMask = 1L << 0, /* name of locale*/
kLocaleOperationVariantNameMask = 1L << 1, /* name of LocaleOperationVariant*/
kLocaleAndVariantNameMask = 0x00000003 /* all of the above*/
};
/*
-------------------------------------------------------------------------------------------------
FUNCTION PROTOTYPES
-------------------------------------------------------------------------------------------------
*/
/* Convert to or from LocaleRefs (and related utilities)*/
/*
* LocaleRefFromLangOrRegionCode()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in LocalesLib 8.6 and later
*/
extern OSStatus
LocaleRefFromLangOrRegionCode(
LangCode lang,
RegionCode region,
LocaleRef * locale) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/*
* LocaleRefFromLocaleString()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in LocalesLib 8.6 and later
*/
extern OSStatus
LocaleRefFromLocaleString(
const char localeString[],
LocaleRef * locale) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/*
* LocaleRefGetPartString()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in LocalesLib 8.6 and later
*/
extern OSStatus
LocaleRefGetPartString(
LocaleRef locale,
LocalePartMask partMask,
ByteCount maxStringLen,
char partString[]) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/*
* LocaleStringToLangAndRegionCodes()
*
* Summary:
* Map a CFLocale-style locale string to old Script Manager LangCode
* and RegionCode values.
*
* Parameters:
*
* localeString:
* A null-terminated C-string version of a CFLocale-style locale
* identifier of the sort that could be passed to
* CFLocaleCreateCanonicalLocaleIdentifierFromString, based on BCP
* 47 language tags: <http://www.rfc-editor.org/rfc/bcp/bcp47.txt>.
*
* lang:
* A pointer to a LangCode to be set from the locale identifier;
* will be set to langUnspecified or -1 if no language code can be
* derived from the identifier. May be NULL if region is not also
* NULL.
*
* region:
* A pointer to a RegionCode to be set from the locale identifier;
* will be set to -1 if no language code can be derived from the
* identifier. May be NULL if lang is not also NULL.
*
* Result:
* OSStatus, noErr if operation successful, otherwise paramErr or
* possibly other errors.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in LocalesLib 9.0 and later
*/
extern OSStatus
LocaleStringToLangAndRegionCodes(
const char localeString[],
LangCode * lang,
RegionCode * region) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/* Enumerate locales for a LocaleOperationClass */
/*
* LocaleOperationCountLocales() *** DEPRECATED ***
*
* Deprecated:
* use CFLocaleCopyAvailableLocaleIdentifiers instead.
*
* Discussion:
* This function is no longer recommended. Please use
* CFLocaleCopyAvailableLocaleIdentifiers instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.8
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in LocalesLib 8.6 and later
*/
extern OSStatus
LocaleOperationCountLocales(
LocaleOperationClass opClass,
ItemCount * localeCount) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* LocaleOperationGetLocales() *** DEPRECATED ***
*
* Deprecated:
* use CFXxxxx instead.
*
* Discussion:
* This function is no longer recommended. Please use
* CFLocaleCopyAvailableLocaleIdentifiers instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.8
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in LocalesLib 8.6 and later
*/
extern OSStatus
LocaleOperationGetLocales(
LocaleOperationClass opClass,
ItemCount maxLocaleCount,
ItemCount * actualLocaleCount,
LocaleAndVariant localeVariantList[]) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/* Get names for a locale (or a region's language)*/
/*
* LocaleGetName() *** DEPRECATED ***
*
* Deprecated:
* use CFLocaleCopyDisplayNameForPropertyValue instead.
*
* Discussion:
* This function is no longer recommended. Please use
* CFLocaleCopyDisplayNameForPropertyValue instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.8
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in LocalesLib 8.6 and later
*/
extern OSStatus
LocaleGetName(
LocaleRef locale,
LocaleOperationVariant opVariant,
LocaleNameMask nameMask,
LocaleRef displayLocale,
UniCharCount maxNameLen,
UniCharCount * actualNameLen,
UniChar displayName[]) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* LocaleCountNames() *** DEPRECATED ***
*
* Deprecated:
* use CFLocaleCopyAvailableLocaleIdentifiers instead.
*
* Discussion:
* This function is no longer recommended. Please use
* CFLocaleCopyAvailableLocaleIdentifiers instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.8
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in LocalesLib 8.6 and later
*/
extern OSStatus
LocaleCountNames(
LocaleRef locale,
LocaleOperationVariant opVariant,
LocaleNameMask nameMask,
ItemCount * nameCount) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
/*
* LocaleGetIndName() *** DEPRECATED ***
*
* Deprecated:
* use CFLocaleCopyAvailableLocaleIdentifiers and
* CFLocaleCopyDisplayNameForPropertyValue instead.
*
* Discussion:
* This function is no longer recommended. Please use
* CFLocaleCopyAvailableLocaleIdentifiers and
* CFLocaleCopyDisplayNameForPropertyValue instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.8
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in LocalesLib 8.6 and later
*/
extern OSStatus
LocaleGetIndName(
LocaleRef locale,
LocaleOperationVariant opVariant,
LocaleNameMask nameMask,
ItemCount nameIndex,
UniCharCount maxNameLen,
UniCharCount * actualNameLen,
UniChar displayName[],
LocaleRef * displayLocale) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_8, __IPHONE_NA, __IPHONE_NA);
#if !__LP64__
/*
* LocaleGetRegionLanguageName() *** DEPRECATED ***
*
* Deprecated:
* use CFLocaleCreateCanonicalLocaleIdentifierFromScriptManagerCodes
* and CFLocaleCopyDisplayNameForPropertyValue instead.
*
* Discussion:
* This function is no longer recommended. Please use
* CFLocaleCreateCanonicalLocaleIdentifierFromScriptManagerCodes and
* CFLocaleCopyDisplayNameForPropertyValue instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in LocalesLib 9.0 and later
*/
extern OSStatus
LocaleGetRegionLanguageName(
RegionCode region,
Str255 languageName) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_5, __IPHONE_NA, __IPHONE_NA);
/* Get names for a LocaleOperationClass*/
#endif /* !__LP64__ */
/*
* LocaleOperationGetName()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in LocalesLib 8.6 and later
*/
extern OSStatus
LocaleOperationGetName(
LocaleOperationClass opClass,
LocaleRef displayLocale,
UniCharCount maxNameLen,
UniCharCount * actualNameLen,
UniChar displayName[]) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/*
* LocaleOperationCountNames()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in LocalesLib 8.6 and later
*/
extern OSStatus
LocaleOperationCountNames(
LocaleOperationClass opClass,
ItemCount * nameCount) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
/*
* LocaleOperationGetIndName()
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in LocalesLib 8.6 and later
*/
extern OSStatus
LocaleOperationGetIndName(
LocaleOperationClass opClass,
ItemCount nameIndex,
UniCharCount maxNameLen,
UniCharCount * actualNameLen,
UniChar displayName[],
LocaleRef * displayLocale) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_NA);
#pragma pack(pop)
#ifdef __cplusplus
}
#endif
#endif /* __MACLOCALES__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework/Headers/IntlResources.h | /*
File: CarbonCore/IntlResources.h
Contains: International Resource definitions.
Copyright: © 1983-2011 by Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __INTLRESOURCES__
#define __INTLRESOURCES__
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#pragma pack(push, 2)
enum {
/* Bits in the itlcFlags byte */
itlcShowIcon = 7, /*Show icon even if only one script*/
itlcDualCaret = 6, /*Use dual caret for mixed direction text*/
/* Bits in the itlcSysFlags word */
itlcSysDirection = 15 /*System direction - left to right/right to left*/
};
enum {
/* One more flag in the itlcFlags byte */
itlcDisableKeyScriptSync = 3 /*Disable font and keyboard script synchrinozation*/
};
enum {
/* We should define masks, too. */
itlcDisableKeyScriptSyncMask = 1 << itlcDisableKeyScriptSync /*Disable font and keyboard script synchrinozation mask*/
};
enum {
tokLeftQuote = 1, /* NumberParts.data[] enumerators */
tokRightQuote = 2, /* In general, these are NOT to be considered indices into the data[] array */
tokLeadPlacer = 3,
tokLeader = 4,
tokNonLeader = 5,
tokZeroLead = 6,
tokPercent = 7,
tokPlusSign = 8,
tokMinusSign = 9,
tokThousands = 10,
tokReserved = 11, /* 11 is reserved field */
tokSeparator = 12,
tokEscape = 13,
tokDecPoint = 14,
tokEPlus = 15,
tokEMinus = 16,
tokMaxSymbols = 31,
curNumberPartsVersion = 1 /*current version of NumberParts record*/
};
enum {
currSymLead = 16,
currNegSym = 32,
currTrailingZ = 64,
currLeadingZ = 128
};
enum {
mdy = 0,
dmy = 1,
ymd = 2,
myd = 3,
dym = 4,
ydm = 5
};
typedef SInt8 DateOrders;
enum {
timeCycle24 = 0, /*time sequence 0:00 - 23:59*/
timeCycleZero = 1, /*time sequence 0:00-11:59, 0:00 - 11:59*/
timeCycle12 = 255, /*time sequence 12:00 - 11:59, 12:00 - 11:59*/
zeroCycle = 1, /*old name for timeCycleZero*/
longDay = 0, /*day of the month*/
longWeek = 1, /*day of the week*/
longMonth = 2, /*month of the year*/
longYear = 3, /*year*/
supDay = 1, /*suppress day of month*/
supWeek = 2, /*suppress day of week*/
supMonth = 4, /*suppress month*/
supYear = 8, /*suppress year*/
dayLdingZ = 32,
mntLdingZ = 64,
century = 128,
secLeadingZ = 32,
minLeadingZ = 64,
hrLeadingZ = 128
};
/* moved OffsetTable back here from QuickdrawText */
struct OffPair {
short offFirst;
short offSecond;
};
typedef struct OffPair OffPair;
typedef OffPair OffsetTable[3];
struct Intl0Rec {
char decimalPt; /*decimal point character*/
char thousSep; /*thousands separator character*/
char listSep; /*list separator character*/
char currSym1; /*currency symbol*/
char currSym2;
char currSym3;
UInt8 currFmt; /*currency format flags*/
UInt8 dateOrder; /*order of short date elements: mdy, dmy, etc.*/
UInt8 shrtDateFmt; /*format flags for each short date element*/
char dateSep; /*date separator character*/
UInt8 timeCycle; /*specifies time cycle: 0..23, 1..12, or 0..11*/
UInt8 timeFmt; /*format flags for each time element*/
char mornStr[4]; /*trailing string for AM if 12-hour cycle*/
char eveStr[4]; /*trailing string for PM if 12-hour cycle*/
char timeSep; /*time separator character*/
char time1Suff; /*trailing string for AM if 24-hour cycle*/
char time2Suff;
char time3Suff;
char time4Suff;
char time5Suff; /*trailing string for PM if 24-hour cycle*/
char time6Suff;
char time7Suff;
char time8Suff;
UInt8 metricSys; /*255 if metric, 0 if inches etc.*/
short intl0Vers; /*region code (hi byte) and version (lo byte)*/
};
typedef struct Intl0Rec Intl0Rec;
typedef Intl0Rec * Intl0Ptr;
typedef Intl0Ptr * Intl0Hndl;
struct Intl1Rec {
Str15 days[7]; /*day names*/
Str15 months[12]; /*month names*/
UInt8 suppressDay; /*255 for no day, or flags to suppress any element*/
UInt8 lngDateFmt; /*order of long date elements*/
UInt8 dayLeading0; /*255 for leading 0 in day number*/
UInt8 abbrLen; /*length for abbreviating names*/
char st0[4]; /*separator strings for long date format*/
char st1[4];
char st2[4];
char st3[4];
char st4[4];
short intl1Vers; /*region code (hi byte) and version (lo byte)*/
short localRtn[1]; /*now a flag for opt extension*/
};
typedef struct Intl1Rec Intl1Rec;
typedef Intl1Rec * Intl1Ptr;
typedef Intl1Ptr * Intl1Hndl;
/*fields for optional itl1 extension*/
struct Itl1ExtRec {
Intl1Rec base; /*un-extended Intl1Rec*/
short version;
short format;
short calendarCode; /*calendar code for this itl1 resource*/
SInt32 extraDaysTableOffset; /*offset in itl1 to extra days table*/
SInt32 extraDaysTableLength; /*length of extra days table*/
SInt32 extraMonthsTableOffset; /*offset in itl1 to extra months table*/
SInt32 extraMonthsTableLength; /*length of extra months table*/
SInt32 abbrevDaysTableOffset; /*offset in itl1 to abbrev days table*/
SInt32 abbrevDaysTableLength; /*length of abbrev days table*/
SInt32 abbrevMonthsTableOffset; /*offset in itl1 to abbrev months table*/
SInt32 abbrevMonthsTableLength; /*length of abbrev months table*/
SInt32 extraSepsTableOffset; /*offset in itl1 to extra seps table*/
SInt32 extraSepsTableLength; /*length of extra seps table*/
short tables[1]; /*now a flag for opt extension*/
};
typedef struct Itl1ExtRec Itl1ExtRec;
struct UntokenTable {
short len;
short lastToken;
short index[256]; /*index table; last = lastToken*/
};
typedef struct UntokenTable UntokenTable;
typedef UntokenTable * UntokenTablePtr;
typedef UntokenTablePtr * UntokenTableHandle;
#if MAC_OS_X_VERSION_MIN_REQUIRED >= MAC_OS_X_VERSION_10_4
#define __WIDE_CHAR_USE_STRUCT__ 1
#else
#define __WIDE_CHAR_USE_STRUCT__ 0
#endif
#if __WIDE_CHAR_USE_STRUCT__
#if __BIG_ENDIAN__
union WideChar {
struct {
char hi;
char lo;
} a;
short b;
};
typedef union WideChar WideChar;
#else
union WideChar {
struct {
char lo;
char hi;
} a;
short b;
};
typedef union WideChar WideChar;
#endif /* __BIG_ENDIAN__ */
#else
union WideChar {
char a[2]; /*0 is the high order character*/
short b;
};
typedef union WideChar WideChar;
#endif /* __WIDE_CHAR_USE_STRUCT__ */
struct WideCharArr {
short size;
WideChar data[10];
};
typedef struct WideCharArr WideCharArr;
struct NumberParts {
short version;
WideChar data[31]; /*index by [tokLeftQuote..tokMaxSymbols]*/
WideCharArr pePlus;
WideCharArr peMinus;
WideCharArr peMinusPlus;
WideCharArr altNumTable;
char reserved[20];
};
typedef struct NumberParts NumberParts;
typedef NumberParts * NumberPartsPtr;
struct Itl4Rec {
short flags; /*reserved*/
SInt32 resourceType; /*contains 'itl4'*/
short resourceNum; /*resource ID*/
short version; /*version number*/
SInt32 resHeader1; /*reserved*/
SInt32 resHeader2; /*reserved*/
short numTables; /*number of tables, one-based*/
SInt32 mapOffset; /*offset to table that maps byte to token*/
SInt32 strOffset; /*offset to routine that copies canonical string*/
SInt32 fetchOffset; /*offset to routine that gets next byte of character*/
SInt32 unTokenOffset; /*offset to table that maps token to canonical string*/
SInt32 defPartsOffset; /*offset to default number parts table*/
SInt32 resOffset6; /*reserved*/
SInt32 resOffset7; /*reserved*/
SInt32 resOffset8; /*reserved*/
};
typedef struct Itl4Rec Itl4Rec;
typedef Itl4Rec * Itl4Ptr;
typedef Itl4Ptr * Itl4Handle;
/* New NItl4Rec for System 7.0: */
struct NItl4Rec {
short flags; /*reserved*/
SInt32 resourceType; /*contains 'itl4'*/
short resourceNum; /*resource ID*/
short version; /*version number*/
short format; /*format code*/
short resHeader; /*reserved*/
SInt32 resHeader2; /*reserved*/
short numTables; /*number of tables, one-based*/
SInt32 mapOffset; /*offset to table that maps byte to token*/
SInt32 strOffset; /*offset to routine that copies canonical string*/
SInt32 fetchOffset; /*offset to routine that gets next byte of character*/
SInt32 unTokenOffset; /*offset to table that maps token to canonical string*/
SInt32 defPartsOffset; /*offset to default number parts table*/
SInt32 whtSpListOffset; /*offset to white space code list*/
SInt32 resOffset7; /*reserved*/
SInt32 resOffset8; /*reserved*/
short resLength1; /*reserved*/
short resLength2; /*reserved*/
short resLength3; /*reserved*/
short unTokenLength; /*length of untoken table*/
short defPartsLength; /*length of default number parts table*/
short whtSpListLength; /*length of white space code list*/
short resLength7; /*reserved*/
short resLength8; /*reserved*/
};
typedef struct NItl4Rec NItl4Rec;
typedef NItl4Rec * NItl4Ptr;
typedef NItl4Ptr * NItl4Handle;
struct TableDirectoryRecord {
OSType tableSignature; /*4 byte long table name */
UInt32 reserved; /*Reserved for internal use */
UInt32 tableStartOffset; /*Table start offset in byte*/
UInt32 tableSize; /*Table size in byte*/
};
typedef struct TableDirectoryRecord TableDirectoryRecord;
struct Itl5Record {
Fixed versionNumber; /*itl5 resource version number */
unsigned short numberOfTables; /*Number of tables it contains */
unsigned short reserved[3]; /*Reserved for internal use */
TableDirectoryRecord tableDirectory[1]; /*Table directory records */
};
typedef struct Itl5Record Itl5Record;
struct RuleBasedTrslRecord {
short sourceType; /*Transliterate target type for the LHS of the rule */
short targetType; /*Transliterate target type for the RHS of the rule */
short formatNumber; /*Transliterate resource format number */
short propertyFlag; /*Transliterate property flags */
short numberOfRules; /*Number of rules following this field */
};
typedef struct RuleBasedTrslRecord RuleBasedTrslRecord;
struct ItlcRecord {
short itlcSystem; /*default system script*/
short itlcReserved; /*reserved*/
SInt8 itlcFontForce; /*default font force flag*/
SInt8 itlcIntlForce; /*default intl force flag*/
SInt8 itlcOldKybd; /*MacPlus intl keybd flag*/
SInt8 itlcFlags; /*general flags*/
short itlcIconOffset; /*keyboard icon offset; not used in 7.0*/
SInt8 itlcIconSide; /*keyboard icon side; not used in 7.0*/
SInt8 itlcIconRsvd; /*rsvd for other icon info*/
short itlcRegionCode; /*preferred verXxx code*/
short itlcSysFlags; /*flags for setting system globals*/
SInt8 itlcReserved4[32]; /*for future use*/
};
typedef struct ItlcRecord ItlcRecord;
struct ItlbRecord {
short itlbNumber; /*itl0 id number*/
short itlbDate; /*itl1 id number*/
short itlbSort; /*itl2 id number*/
short itlbFlags; /*Script flags*/
short itlbToken; /*itl4 id number*/
short itlbEncoding; /*itl5 ID # (optional; char encoding)*/
short itlbLang; /*current language for script */
SInt8 itlbNumRep; /*number representation code*/
SInt8 itlbDateRep; /*date representation code */
short itlbKeys; /*KCHR id number*/
short itlbIcon; /*ID # of SICN or kcs#/kcs4/kcs8 suite.*/
};
typedef struct ItlbRecord ItlbRecord;
/* New ItlbExtRecord structure for System 7.0 */
struct ItlbExtRecord {
ItlbRecord base; /*un-extended ItlbRecord*/
SInt32 itlbLocalSize; /*size of script's local record*/
short itlbMonoFond; /*default monospace FOND ID*/
short itlbMonoSize; /*default monospace font size*/
short itlbPrefFond; /*preferred FOND ID*/
short itlbPrefSize; /*preferred font size*/
short itlbSmallFond; /*default small FOND ID*/
short itlbSmallSize; /*default small font size*/
short itlbSysFond; /*default system FOND ID*/
short itlbSysSize; /*default system font size*/
short itlbAppFond; /*default application FOND ID*/
short itlbAppSize; /*default application font size*/
short itlbHelpFond; /*default Help Mgr FOND ID*/
short itlbHelpSize; /*default Help Mgr font size*/
Style itlbValidStyles; /*set of valid styles for script*/
Style itlbAliasStyle; /*style (set) to mark aliases*/
};
typedef struct ItlbExtRecord ItlbExtRecord;
#pragma pack(pop)
#endif /* __INTLRESOURCES__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework/Headers/PLStringFuncs.h | /*
File: CarbonCore/PLStringFuncs.h
Contains: Pascal string manipulation routines that parallel ANSI C string.h
The contents of this header file are deprecated.
Copyright: © 1999-2011 by Apple Inc. All rights reserved.
*/
#ifndef __PLSTRINGFUNCS__
#define __PLSTRINGFUNCS__
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
/*
* PLstrcmp() *** DEPRECATED ***
*
* Deprecated:
* use CFString instead.
*
* Summary:
* Compare two pascal strings
*
* Discussion:
* This function compares two pascal strings, and returns a value <
* 0 if the first string is lexicographically less than the second
* string, or 0 if the two strings are identical, or a value > 0 if
* the first string is lexicographically greater than the second.
* This function should be deprecated since pascal strings are
* obsolete on MacOSX and CFString should be used instead.
*
* Mac OS X threading:
* Thread safe
* Thread safe provided no other thread is modifying str1 or str2.
*
* Parameters:
*
* str1:
* the first pascal string
*
* str2:
* the second pascal string
*
* Result:
* This function returns an integer greater than, equal to, or less
* than 0, according as the string str1 is greater than, equal to,
* or less than the string str2. The comparison is done using
* unsigned characters, so that `\200' is greater than `\0'.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: not available
*/
extern short
PLstrcmp(
ConstStr255Param str1,
ConstStr255Param str2) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* PLstrncmp() *** DEPRECATED ***
*
* Deprecated:
* use CFString instead.
*
* Summary:
* Compare two pascal strings
*
* Discussion:
* This function compares two pascal strings, and returns a value <
* 0 if the first string is lexicographically less than the second
* string, or 0 if the two strings are identical, or a value > 0 if
* the first string is lexicographically greater than the second.
* This function compares not more than num characters of either
* string, even if their lengths are greater than num. Two strings
* whose first num characters are identical will return 0 when
* compared. This function should be deprecated since pascal strings
* are obsolete on MacOSX and CFString should be used instead.
*
* Mac OS X threading:
* Thread safe
* Thread safe provided no other thread is modifying str1 or str2.
*
* Parameters:
*
* str1:
* the first pascal string
*
* str2:
* the second pascal string
*
* num:
* the maximum number of characters to compare
*
* Result:
* This function returns an integer greater than, equal to, or less
* than 0, according as the string str1 is greater than, equal to,
* or less than the string str2. The comparison is done using
* unsigned characters, so that `\200' is greater than `\0'.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: not available
*/
extern short
PLstrncmp(
ConstStr255Param str1,
ConstStr255Param str2,
short num) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* PLstrcpy() *** DEPRECATED ***
*
* Deprecated:
* use CFString instead.
*
* Summary:
* Copy a pascal string
*
* Discussion:
* This function copies the string source to dest (including the
* initial length byte ). The caller must ensure that neither source
* or dest are NULL, and that dest is large enough to hold the
* entire contents of source. This function should be deprecated
* since pascal strings are obsolete on MacOSX and CFString should
* be used instead.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* dest:
* the destination pascal string
*
* source:
* the source pascal string
*
* Result:
* This function returns dest.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: not available
*/
extern StringPtr
PLstrcpy(
StringPtr dest,
ConstStr255Param source) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* PLstrncpy() *** DEPRECATED ***
*
* Deprecated:
* use CFString instead.
*
* Summary:
* Copy a pascal string
*
* Discussion:
* This function copies the string source to dest (including the
* initial length byte ), provided the length of source is <= num.
* If the length of source is > num, then the first num characters
* of source are copied into dest, and the length of dest is set to
* num. The caller must ensure that neither source or dest are
* NULL, and that dest is large enough to hold the entire contents
* of source. This function should be deprecated since pascal
* strings are obsolete on MacOSX and CFString should be used
* instead.
*
* Mac OS X threading:
* Thread safe
* Thread safe provided no other thread is modifying source.
*
* Parameters:
*
* dest:
* the destination pascal string
*
* source:
* the source pascal string
*
* num:
* the maximum number of bytes to copy
*
* Result:
* This function returns dest.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: not available
*/
extern StringPtr
PLstrncpy(
StringPtr dest,
ConstStr255Param source,
short num) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* PLstrcat() *** DEPRECATED ***
*
* Deprecated:
* use CFString instead.
*
* Summary:
* Append a pascal string to another pascal string
*
* Discussion:
* This function append a copy of the pascal string append to the
* end of the pascal string str. If the length of str plus the
* length of append is greater than 255 ( the maximum size of a
* pascal string ) then only enough characters are copied to str to
* reach the 255 character limit, and the length of str is set to
* 255. The caller must ensure that neither str nor append are
* NULL, and that str is large enough to hold the entire contents of
* append. This function should be deprecated since pascal strings
* are obsolete on MacOSX and CFString should be used instead.
*
* Mac OS X threading:
* Thread safe
* Thread safe provided no other thread is modifying str or append.
*
* Parameters:
*
* str:
* the destination pascal string
*
* append:
* the pascal string to append
*
* Result:
* This function returns s.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: not available
*/
extern StringPtr
PLstrcat(
StringPtr str,
ConstStr255Param append) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* PLstrncat() *** DEPRECATED ***
*
* Deprecated:
* use CFString instead.
*
* Summary:
* Append up to num bytes of a pascal string to another pascal string
*
* Discussion:
* This function append up to the first num bytes of the pascal
* string append to the end of the pascal string s. If the length
* of str plus the length of append is greater than 255 ( the
* maximum size of a pascal string ) then only enough characters are
* copied to str to reach the 255 character limit, and the length of
* str is set to 255. The caller must ensure that neither str nor
* append are NULL, and that str is large enough to hold the entire
* contents of append. This function should be deprecated since
* pascal strings are obsolete on MacOSX and CFString should be used
* instead.
*
* Mac OS X threading:
* Thread safe
* Thread safe provided no other thread is modifying str1 or append.
*
* Parameters:
*
* str1:
* the destination pascal string
*
* append:
* the pascal string to append
*
* num:
* the maximum number of bytes of append to append onto s
*
* Result:
* This function returns str.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: not available
*/
extern StringPtr
PLstrncat(
StringPtr str1,
ConstStr255Param append,
short num) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* PLstrchr() *** DEPRECATED ***
*
* Deprecated:
* use CFString instead.
*
* Summary:
* Return a pointer to the first occurrence of ch1 in str.
*
* Discussion:
* The PLstrrchr() function locates the first occurrence of ch1
* (converted to an unsigned char) in the string s. If ch1 does not
* occur in the string, this returns NULL. This function should be
* deprecated since pascal strings are obsolete on MacOSX and
* CFString should be used instead.
*
* Mac OS X threading:
* Thread safe
* Thread safe provided no other thread is modifying str1.
*
* Parameters:
*
* str1:
* the pascal string
*
* ch1:
* the character to find
*
* Result:
* A pointer to the first occurrence of ch1 in str1, or NULL.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: not available
*/
extern Ptr
PLstrchr(
ConstStr255Param str1,
short ch1) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* PLstrrchr() *** DEPRECATED ***
*
* Deprecated:
* use CFString instead.
*
* Summary:
* Return a pointer to the last occurrence of ch1 in str.
*
* Discussion:
* The PLstrrchr() function locates the last occurrence of ch1
* (converted to an unsigned char) in the string s. If ch1 does not
* occur in the string, this returns NULL. This function should be
* deprecated since pascal strings are obsolete on MacOSX and
* CFString should be used instead.
*
* Mac OS X threading:
* Thread safe
* Thread safe provided no other thread is modifying str1.
*
* Parameters:
*
* str1:
* the pascal string
*
* ch1:
* the character to find
*
* Result:
* A pointer to the last occurrence of ch1 in str1, or NULL.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: not available
*/
extern Ptr
PLstrrchr(
ConstStr255Param str1,
short ch1) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* PLstrpbrk() *** DEPRECATED ***
*
* Deprecated:
* use CFString instead.
*
* Summary:
* Return a pointer to the first occurrence in str of any character
* in charSet.
*
* Discussion:
* The PLstrpbrk() function returns a pointer to the first
* occurrence in str of any character in searchStr. If none of the
* characters in searchStr can be found in str, then NULL is
* returned. This function should be deprecated since pascal strings
* are obsolete on MacOSX and CFString should be used instead.
*
* Mac OS X threading:
* Thread safe
* Thread safe provided no other thread is modifying str1 or charSet.
*
* Parameters:
*
* str1:
* the pascal string
*
* charSet:
* the character to find
*
* Result:
* A pointer to the first occurrence of any character in charSet in
* str1, or NULL.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: not available
*/
extern Ptr
PLstrpbrk(
ConstStr255Param str1,
ConstStr255Param charSet) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* PLstrspn() *** DEPRECATED ***
*
* Deprecated:
* use CFString instead.
*
* Summary:
* Spans the initial part of str1 as long as the characters from
* str1 occur in string charset
*
* Discussion:
* The PLstrspn() function spans the initial part of the pascal
* string str1 as long as the characters from s occur in string
* charset. In effect, this returns a count of the number of
* characters at the beginning of the pascal string str1 which are
* in charset. This function should be deprecated since pascal
* strings are obsolete on MacOSX and CFString should be used
* instead.
*
* Mac OS X threading:
* Thread safe
* Thread safe provided no other thread is modifying str1 or charSet.
*
* Parameters:
*
* str1:
* the pascal string
*
* charSet:
* the character to find
*
* Result:
* The count of characters at the beginning of str1 which are in
* charSet.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: not available
*/
extern short
PLstrspn(
ConstStr255Param str1,
ConstStr255Param charSet) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* PLstrstr() *** DEPRECATED ***
*
* Deprecated:
* use CFString instead.
*
* Summary:
* Returns a pointer to the first occurrence of searchStr in str1
*
* Discussion:
* The PLstrstr() function returns a pointer to the first occurrence
* of searchStr in str1, or NULL if searchStr does not exist in
* str1. This function should be deprecated since pascal strings are
* obsolete on MacOSX and CFString should be used instead.
*
* Mac OS X threading:
* Thread safe
* Thread safe provided no other thread is modifying str1 or
* searchStr.
*
* Parameters:
*
* str1:
* the pascal string
*
* searchStr:
* the string to find
*
* Result:
* The count of characters at the beginning of str1 which are in
* charSet.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: not available
*/
extern Ptr
PLstrstr(
ConstStr255Param str1,
ConstStr255Param searchStr) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* PLstrlen() *** DEPRECATED ***
*
* Deprecated:
* use CFString instead.
*
* Summary:
* Returns the length of the pascal string
*
* Discussion:
* The PLstrlen() function returns the length of the pascal string
* str. This function should be deprecated since pascal strings are
* obsolete on MacOSX and CFString should be used instead.
*
* Mac OS X threading:
* Thread safe
* Thread safe provided no other thread is modifying str.
*
* Parameters:
*
* str:
* the pascal string
*
* Result:
* The length of the pascal string str.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: not available
*/
extern short
PLstrlen(ConstStr255Param str) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
/*
* PLpos() *** DEPRECATED ***
*
* Deprecated:
* use CFString instead.
*
* Summary:
* Returns the offset to the first occurrence of searchStr in str1
*
* Discussion:
* The PLpos() function returns the offset of the string searchStr
* in str1, or 0 if searchStr does not occur in str1. For example,
* if str1 is "\pHello World" and searchStr is "\pWorld", then this
* function will return the value 7. This function should be
* deprecated since pascal strings are obsolete on MacOSX and
* CFString should be used instead.
*
* Mac OS X threading:
* Thread safe
* Thread safe provided no other thread is modifying str1 or
* searchStr.
*
* Parameters:
*
* str1:
* the pascal string
*
* searchStr:
* the string to find
*
* Result:
* The count of characters at the beginning of str1 which are in
* charSet.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.4
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: not available
*/
extern short
PLpos(
ConstStr255Param str1,
ConstStr255Param searchStr) __OSX_AVAILABLE_BUT_DEPRECATED(__MAC_10_0, __MAC_10_4, __IPHONE_NA, __IPHONE_NA);
#ifdef __cplusplus
}
#endif
#endif /* __PLSTRINGFUNCS__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/CarbonCore.framework/Headers/CarbonCore.h | /*
File: CarbonCore/CarbonCore.h
Contains: Master include for CarbonCore private framework
Copyright: © 1999-2011 by Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __CARBONCORE__
#define __CARBONCORE__
#ifndef __COREFOUNDATION__
#include <CoreFoundation/CoreFoundation.h>
#endif
#ifndef __CONDITIONALMACROS__
#include <ConditionalMacros.h>
#endif
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
#ifndef __FINDER__
#include <CarbonCore/Finder.h>
#endif
#ifndef __FIXMATH__
#include <CarbonCore/FixMath.h>
#endif
#ifndef __SCRIPT__
#include <CarbonCore/Script.h>
#endif
#ifndef __UTCUTILS__
#include <CarbonCore/UTCUtils.h>
#endif
#ifndef __TEXTCOMMON__
#include <CarbonCore/TextCommon.h>
#endif
#ifndef __COLLECTIONS__
#include <CarbonCore/Collections.h>
#endif
#ifndef __ENDIAN__
#include <CarbonCore/Endian.h>
#endif
#ifndef __GESTALT__
#include <CarbonCore/Gestalt.h>
#endif
#ifndef __MACMEMORY__
#include <CarbonCore/MacMemory.h>
#endif
#ifndef __MATH64__
#include <CarbonCore/Math64.h>
#endif
#ifndef __MIXEDMODE__
#include <CarbonCore/MixedMode.h>
#endif
#ifndef __MACERRORS__
#include <CarbonCore/MacErrors.h>
#endif
#ifndef __BACKUPCORE__
#include <CarbonCore/BackupCore.h>
#endif
#ifndef __DISKSPACERECOVERY__
#include <CarbonCore/DiskSpaceRecovery.h>
#endif
#ifndef __COMPONENTS__
#include <CarbonCore/Components.h>
#endif
#ifndef __OSUTILS__
#include <CarbonCore/OSUtils.h>
#endif
#ifndef __FILES__
#include <CarbonCore/Files.h>
#endif
#ifndef __RESOURCES__
#include <CarbonCore/Resources.h>
#endif
#ifndef __CODEFRAGMENTS__
#include <CarbonCore/CodeFragments.h>
#endif
#ifndef __ALIASES__
#include <CarbonCore/Aliases.h>
#endif
#ifndef __MACLOCALES__
#include <CarbonCore/MacLocales.h>
#endif
#ifndef __DEBUGGING__
#include <CarbonCore/Debugging.h>
#endif
#ifndef __PLSTRINGFUNCS__
#include <CarbonCore/PLStringFuncs.h>
#endif
#ifndef __DRIVERSYNCHRONIZATION__
#include <CarbonCore/DriverSynchronization.h>
#endif
#ifndef __DRIVERSERVICES__
#include <CarbonCore/DriverServices.h>
#endif
#ifndef __INTLRESOURCES__
#include <CarbonCore/IntlResources.h>
#endif
#ifndef __NUMBERFORMATTING__
#include <CarbonCore/NumberFormatting.h>
#endif
#ifndef __DATETIMEUTILS__
#include <CarbonCore/DateTimeUtils.h>
#endif
#ifndef __STRINGCOMPARE__
#include <CarbonCore/StringCompare.h>
#endif
#ifndef __TEXTUTILS__
#include <CarbonCore/TextUtils.h>
#endif
#ifndef __TOOLUTILS__
#include <CarbonCore/ToolUtils.h>
#endif
#ifndef __UNICODEUTILITIES__
#include <CarbonCore/UnicodeUtilities.h>
#endif
#ifndef __FP__
#include <CarbonCore/fp.h>
#endif
#include <fenv.h>
#ifndef __TEXTENCODINGCONVERTER__
#include <CarbonCore/TextEncodingConverter.h>
#endif
#ifndef __UNICODECONVERTER__
#include <CarbonCore/UnicodeConverter.h>
#endif
#ifndef __THREADS__
#include <CarbonCore/Threads.h>
#endif
#ifndef __FOLDERS__
#include <CarbonCore/Folders.h>
#endif
#ifndef __TIMER__
#include <CarbonCore/Timer.h>
#endif
#ifndef __MULTIPROCESSINGINFO__
#include <CarbonCore/MultiprocessingInfo.h>
#endif
#ifndef __MULTIPROCESSING__
#include <CarbonCore/Multiprocessing.h>
#endif
#ifndef __MACHINEEXCEPTIONS__
#include <CarbonCore/MachineExceptions.h>
#endif
#ifndef __LOWMEM__
#include <CarbonCore/LowMem.h>
#endif
#ifndef __AVLTREE__
#include <CarbonCore/AVLTree.h>
#endif
#ifndef __PEFBINARYFORMAT__
#include <CarbonCore/PEFBinaryFormat.h>
#endif
#ifndef __HFSVOLUMES__
#include <CarbonCore/HFSVolumes.h>
#endif
#ifndef __AIFF__
#include <CarbonCore/AIFF.h>
#endif
#ifndef __TEXTENCODINGPLUGIN__
#include <CarbonCore/TextEncodingPlugin.h>
#endif
#endif /* __CARBONCORE__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/SearchKit.framework/SearchKit.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: 215422CE-8CCC-393F-813A-9DD9DB3B992A
- target: x86_64-maccatalyst
value: 215422CE-8CCC-393F-813A-9DD9DB3B992A
- target: arm64-macos
value: 00000000-0000-0000-0000-000000000000
- target: arm64-maccatalyst
value: 00000000-0000-0000-0000-000000000000
- target: arm64e-macos
value: 3E01AD82-E12C-38E7-9167-EEB9E88BDAEB
- target: arm64e-maccatalyst
value: 3E01AD82-E12C-38E7-9167-EEB9E88BDAEB
install-name: '/System/Library/Frameworks/CoreServices.framework/Versions/A/Frameworks/SearchKit.framework/Versions/A/SearchKit'
current-version: 417.1
parent-umbrella:
- targets: [ x86_64-macos, x86_64-maccatalyst, arm64-macos, arm64-maccatalyst,
arm64e-macos, arm64e-maccatalyst ]
umbrella: CoreServices
exports:
- targets: [ x86_64-maccatalyst, x86_64-macos, arm64e-maccatalyst, arm64e-macos,
arm64-macos, arm64-maccatalyst ]
symbols: [ _AIATFree, _AIATGetAllocator, _AIATMalloc, _AIATRegisterReportErrorUPP,
_AIATSetAllocator, _DisposeIASearchIsHitFilterUPP, _IACFDataDocAccessorCreate,
_IACFDataDocAccessorDispose, _IADocKeyAccessorCreate, _IADocKeyAccessorLength,
_IADocKeyAccessorRead, _IADocKeyAccessorRelease, _IADocKeyAccessorRetain,
_IADocKeyCanCreateAccessor, _IADocKeyCanCreateIterator, _IADocKeyCompare,
_IADocKeyCopyFilePath, _IADocKeyCopyMIMEType, _IADocKeyCopyModDate,
_IADocKeyCopyURL, _IADocKeyCopyURLEncodedName, _IADocKeyCreate,
_IADocKeyCreateFromFSRef, _IADocKeyCreateFromFilePath, _IADocKeyGetFSRef,
_IADocKeyGetName, _IADocKeyGetParent, _IADocKeyGetSchemeName,
_IADocKeyIteratorCopyNextDoc, _IADocKeyIteratorCreate, _IADocKeyIteratorDispose,
_IADocKeyRelease, _IADocKeyRetain, _IAGetHFSDocSchemeName,
_IAIndexAddDoc, _IAIndexAddDocAsync, _IAIndexAddDocWithTextStream,
_IAIndexAddDocWithTextStreamAsync, _IAIndexCompact, _IAIndexCompactAsync,
_IAIndexCopyDocKeyFromID, _IAIndexCopyDocProperties, _IAIndexCopyDocTermIDArrray,
_IAIndexCopyTermData, _IAIndexCopyTermDocIDArrray, _IAIndexDocIteratorCopyNext,
_IAIndexDocIteratorCreate, _IAIndexDocIteratorDispose, _IAIndexFlush,
_IAIndexGetBytesForUpdate, _IAIndexGetDocKeyID, _IAIndexGetDocState,
_IAIndexGetDocTermCount, _IAIndexGetDocTermFrequency, _IAIndexGetMaxDocID,
_IAIndexGetMaxTermID, _IAIndexGetNumDocuments, _IAIndexGetRootDocKeyCount,
_IAIndexGetRootDocKeys, _IAIndexGetStorage, _IAIndexGetTermDocCount,
_IAIndexGetTermID, _IAIndexGetTextAnalysisTypeCount, _IAIndexGetTextAnalysisTypes,
_IAIndexGetType, _IAIndexInitialize, _IAIndexInitializeFromFSRef,
_IAIndexInitializeFromFilePath, _IAIndexMakeRootDocKey, _IAIndexMoveDoc,
_IAIndexOpen, _IAIndexOpenFromFSRef, _IAIndexOpenFromFilePath,
_IAIndexRelease, _IAIndexRemoveDoc, _IAIndexRemoveDocAsync,
_IAIndexRenameDoc, _IAIndexReplaceRootDocKey, _IAIndexRetain,
_IAIndexSetBytesForUpdate, _IAIndexSetDocProperties, _IAIndexUpdate,
_IAIndexUpdateAsync, _IAInputBlockCreate, _IAInputBlockDispose,
_IAInputBlockGetPosition, _IAInputBlockReadBuffer, _IAInputBlockReadByte,
_IAInputBlockReadCFData, _IAInputBlockReadCFString, _IAInputBlockReadCFType,
_IAInputBlockReadUInt32, _IAInputBlockReadUInt64, _IAInputBlockReadVInt32,
_IAInputBlockReadVInt64, _IALoadDefaultExtractorPlugIns, _IALoadExtractorPlugIn,
_IAMutexCreate, _IAMutexDispose, _IAMutexGetGlobalMutex, _IAMutexLock,
_IAMutexUnlock, _IAOutputBlockCreate, _IAOutputBlockDispose,
_IAOutputBlockGetPosition, _IAOutputBlockWriteBuffer, _IAOutputBlockWriteByte,
_IAOutputBlockWriteCFData, _IAOutputBlockWriteCFString, _IAOutputBlockWriteCFType,
_IAOutputBlockWriteUInt32, _IAOutputBlockWriteUInt64, _IAOutputBlockWriteVInt32,
_IAOutputBlockWriteVInt64, _IASearchResultsCopyMatchingTerms,
_IASearchResultsDispose, _IASearchResultsGetCount, _IASearchResultsGetInfoBulk,
_IASearchSetAddIndices, _IASearchSetCreate, _IASearchSetFindSimilarDocuments,
_IASearchSetGetIndexCount, _IASearchSetGetIndices, _IASearchSetQuery,
_IASearchSetQueryAsync, _IASearchSetRankedQueryFromTextStream,
_IASearchSetRelease, _IASearchSetRetain, _IASearchSetTaskGetSearchResults,
_IASentenceParserCopyNextSentence, _IASentenceParserCreate,
_IASentenceParserRegister, _IASentenceParserRelease, _IASentenceParserRetain,
_IASentenceParserSetSourceText, _IAStorageAllocateBlock, _IAStorageAllocateNamedBlock,
_IAStorageCFDataSize, _IAStorageCFStringSize, _IAStorageCFTypeSize,
_IAStorageCommit, _IAStorageCompact, _IAStorageCopyBlockNames,
_IAStorageCopyFilePath, _IAStorageDeallocateBlock, _IAStorageDeallocateNamedBlock,
_IAStorageFreeSpace, _IAStorageGetBlockSize, _IAStorageGetCFData,
_IAStorageGetDiskBlockSize, _IAStorageGetFSRef, _IAStorageGetMaxBlockID,
_IAStorageGetNamedBlock, _IAStorageGetReadAddress, _IAStorageGetStream,
_IAStorageGetStreamCallbacks, _IAStorageGetType, _IAStorageGetWriteAddress,
_IAStorageIsOpen, _IAStorageIsWritable, _IAStorageLockMutex,
_IAStorageMemoryOpen, _IAStorageOpenFromFSRef, _IAStorageOpenFromFilePath,
_IAStorageRelease, _IAStorageRemoveBlockName, _IAStorageRetain,
_IAStorageSetBlockName, _IAStorageSetDiskBlockSize, _IAStorageTotalSpace,
_IAStorageUnlockMutex, _IAStorageVInt32Size, _IAStorageVInt64Size,
_IASummaryCopyParagraphs, _IASummaryCopyRankedSentenceArray,
_IASummaryCopySentenceArray, _IASummaryCopyText, _IASummaryCreate,
_IASummaryCreateWithQuery, _IASummaryDispose, _IASummaryGetHitCount,
_IASummaryGetNthRankedSentence, _IASummaryGetNthSentence,
_IASummaryGetSentenceCount, _IASummmaryCopyText, _IATaskCancel,
_IATaskCopyProperties, _IATaskCreate, _IATaskDispose, _IATaskGetContext,
_IATaskGetCurrent, _IATaskGetProgress, _IATaskIsDone, _IATaskSetProperties,
_IATaskWasCanceled, _IATaskYield, _IATextAnalysisCreate, _IATextAnalysisGetCallbacks,
_IATextAnalysisGetProperties, _IATextAnalysisGetType, _IATextAnalysisRegister,
_IATextAnalysisRelease, _IATextAnalysisRetain, _IATextAnalysisSetProperties,
_IATextAnalysisUnregister, _IATextStreamCreate, _IATextStreamCreateFromCFData,
_IATextStreamCreateFromCFString, _IATextStreamGetCurrentEncoding,
_IATextStreamRead, _IATextStreamRelease, _IATextStreamRetain,
_IATextStreamRewind, _IATokenizerCreate, _IATokenizerGetNextToken,
_IATokenizerRelease, _IATokenizerRetain, _InvokeIASearchIsHitFilterUPP,
_NewIASearchIsHitFilterUPP, _SKCurrentLocaleData, _SKDocumentCopyText,
_SKDocumentCopyURL, _SKDocumentCreate, _SKDocumentCreateWithURL,
_SKDocumentGetName, _SKDocumentGetParent, _SKDocumentGetSchemeName,
_SKDocumentGetTypeID, _SKIndexAddDocument, _SKIndexAddDocumentWithText,
_SKIndexClose, _SKIndexCompact, _SKIndexContainsContentForDocumentID,
_SKIndexCopyDocumentForDocumentID, _SKIndexCopyDocumentIDArrayForTermID,
_SKIndexCopyDocumentNameForDocumentID, _SKIndexCopyDocumentProperties,
_SKIndexCopyDocumentRefsForDocumentIDs, _SKIndexCopyDocumentURLsForDocumentIDs,
_SKIndexCopyInfoForDocumentIDs, _SKIndexCopyTermIDArrayForDocumentID,
_SKIndexCopyTermStringForTermID, _SKIndexCopyUniqueTerms,
_SKIndexCreateTermIterator, _SKIndexCreateWithMutableData,
_SKIndexCreateWithURL, _SKIndexDocumentIteratorCopyNext, _SKIndexDocumentIteratorCreate,
_SKIndexDocumentIteratorGetTypeID, _SKIndexEnumerateTokens,
_SKIndexFlush, _SKIndexFlushCache, _SKIndexFlushInternal,
_SKIndexGetAnalysisProperties, _SKIndexGetDocumentCount, _SKIndexGetDocumentID,
_SKIndexGetDocumentState, _SKIndexGetDocumentTermCount, _SKIndexGetDocumentTermFrequency,
_SKIndexGetIndexType, _SKIndexGetMaximumBytesBeforeFlush,
_SKIndexGetMaximumDocumentID, _SKIndexGetMaximumTermID, _SKIndexGetParentDocumentIDForDocumentID,
_SKIndexGetTermDocumentCount, _SKIndexGetTermIDForTermString,
_SKIndexGetTypeID, _SKIndexGetVersion, _SKIndexMatchQueryForDocumentIDs,
_SKIndexMoveDocument, _SKIndexOpenWithData, _SKIndexOpenWithDataAndLocale,
_SKIndexOpenWithMutableData, _SKIndexOpenWithMutableDataAndLocale,
_SKIndexOpenWithURL, _SKIndexOpenWithURLAndLocale, _SKIndexRemoveDocument,
_SKIndexRenameDocument, _SKIndexSetDocumentProperties, _SKIndexSetMaximumBytesBeforeFlush,
_SKIndexShouldFlushCache, _SKIndexTermIteratorCopyNext, _SKIndexTokenizeString,
_SKLoadDefaultExtractorPlugIns, _SKQueryNodeGetData, _SKSearchCancel,
_SKSearchCreate, _SKSearchFindMatches, _SKSearchGetQueryNode,
_SKSearchGetTypeID, _SKSearchGroupCopyIndexes, _SKSearchGroupCreate,
_SKSearchGroupGetTypeID, _SKSearchResultsCopyMatchingTerms,
_SKSearchResultsCreateWithDocuments, _SKSearchResultsCreateWithQuery,
_SKSearchResultsGetCount, _SKSearchResultsGetInfoInRange,
_SKSearchResultsGetTypeID, _SKSetDefault, _SKSummaryCopyParagraphAtIndex,
_SKSummaryCopyParagraphSummaryString, _SKSummaryCopySentenceAtIndex,
_SKSummaryCopySentenceSummaryString, _SKSummaryCreateWithString,
_SKSummaryGetParagraphCount, _SKSummaryGetParagraphSummaryInfo,
_SKSummaryGetSentenceCount, _SKSummaryGetSentenceSummaryInfo,
_SKSummaryGetTypeID, _gSKGlobalFlags, _kIAIndexDefaultAnalysis,
_kIAStoreStreamCFDataType, _kIAStoreStreamFSRefType, _kIAStoreStreamFileType,
_kSKEndTermChars, _kSKLanguageTypes, _kSKMaximumTerms, _kSKMinTermLength,
_kSKProximityIndexing, _kSKStartTermChars, _kSKStopWords,
_kSKSubstitutions, _kSKTermChars ]
...
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/SearchKit.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/SearchKit.framework/Headers/SKDocument.h | /*
File: SearchKit/SKDocument.h
Contains: SearchKit Interfaces.
Version: SearchKit-417.1
Copyright: 2003-2019 by Apple, Inc., all rights reserved
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __SKDOCUMENT__
#define __SKDOCUMENT__
#ifndef __CFBASE__
#include <CoreFoundation/CFBase.h>
#endif
#ifndef __CFURL__
#include <CoreFoundation/CFURL.h>
#endif
#include <AvailabilityMacros.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
/*
* SKDocumentRef
*
* Summary:
* An opaque data type representing a document.
*
* Discussion:
* A document reference is a generic descriptor to a document. It is
* built from a document scheme, a parent document, and a document
* name.
*/
typedef CFTypeRef SKDocumentRef;
/*
* SKDocumentGetTypeID()
*
* Summary:
* Returns the type identifier of the SKDocument type.
*
* Result:
* Returns a CFTypeID object, or <tt>NULL</tt> on failure.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFTypeID
SKDocumentGetTypeID(void) API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* SKDocumentCreateWithURL()
*
* Summary:
* Creates a reference to a document with a URL.
*
* Discussion:
* Use SKDocumentCreateWithURL to create a reference to a file or
* other URL. This function must be balanced with a call at a later
* time to CFRelease.
*
* Parameters:
*
* inURL:
* Only "file:" URLs can be used with the SKIndexAddDocument
* function, but the URL scheme may be anything you like if you
* use the SKIndexAddDocumentWithText function. The scheme of the
* document created is set to the scheme of the URL used.
*
* Result:
* Returns a reference to the document, or <tt>NULL</tt> on failure.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern SKDocumentRef
SKDocumentCreateWithURL(CFURLRef inURL) API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* SKDocumentCopyURL()
*
* Summary:
* Builds a CFURL object from a document reference.
*
* Result:
* Returns a CFURL object, or <tt>NULL</tt> on failure.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFURLRef
SKDocumentCopyURL(SKDocumentRef inDocument) API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* SKDocumentCreate()
*
* Summary:
* Create a document based on a scheme, parent, and name.
*
* Discussion:
* The parent can be <tt>NULL</tt>, but either a scheme or a parent
* must be specified. This function must be balanced with a call at
* a later time to CFRelease
*
* Parameters:
*
* inScheme:
* Analogous to the scheme of a URL. Documents with a "file"
* scheme can be read by the <tt>SKIndexAddDocument</tt> function
* (see SearchKit.h). The scheme may be anything you like if you
* use the SKIndexAddDocumentWithText function. If the scheme is
* <tt>NULL</tt>, it will be set to be the same as the parent.
*
* inParent:
* The reference to the document or container one step up in the
* document hierarchy.
*
* inName:
* The name of this document. For a "file" scheme, it is the name
* of the file or the container, not its path. The path can be
* constructed by following parent links.
*
* Result:
* Returns a reference to the document, or <tt>NULL</tt> on failure.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern SKDocumentRef
SKDocumentCreate(
CFStringRef inScheme,
SKDocumentRef inParent, /* can be NULL */
CFStringRef inName) API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* SKDocumentGetSchemeName()
*
* Summary:
* Gets the scheme name of a document.
*
* Parameters:
*
* inDocument:
* The document whose scheme name you want to get.
*
* Result:
* Returns a CFString object, or <tt>NULL</tt> on failure.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFStringRef
SKDocumentGetSchemeName(SKDocumentRef inDocument) API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* SKDocumentGetName()
*
* Summary:
* Gets the name of a document.
*
* Parameters:
*
* inDocument:
* The document whose name you want to get.
*
* Result:
* Returns a CFString object, or <tt>NULL</tt> on failure.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFStringRef
SKDocumentGetName(SKDocumentRef inDocument) API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* SKDocumentGetParent()
*
* Summary:
* Gets a reference to the parent document of a document.
*
* Parameters:
*
* inDocument:
* The document whose parent you want to get.
*
* Result:
* Returns a reference to the parent document, or <tt>NULL</tt> on
* failure.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern SKDocumentRef
SKDocumentGetParent(SKDocumentRef inDocument) API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
#ifdef __cplusplus
}
#endif
#endif /* __SKDOCUMENT__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/SearchKit.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/SearchKit.framework/Headers/SKSummary.h | /*
File: SearchKit/SKSummary.h
Contains: SearchKit Interfaces.
Version: SearchKit-417.1
Copyright: 2004-2019 by Apple, Inc., all rights reserved
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __SKSUMMARY__
#define __SKSUMMARY__
#ifndef __CFBASE__
#include <CoreFoundation/CFBase.h>
#endif
#ifndef __CFSTRING__
#include <CoreFoundation/CFString.h>
#endif
/*
* Summarization API
*/
#include <AvailabilityMacros.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
/*
* SKSummaryRef
*
* Summary:
* An opaque data type representing summary information.
*
* Discussion:
* A summary reference contains summary information, from which
* summary text can be obtained.
*/
typedef struct __SKSummary* SKSummaryRef;
/*
* SKSummaryGetTypeID()
*
* Summary:
* Returns the type identifier of the SKSummaryRef type.
*
* Result:
* Returns a CFTypeID object, or <tt>NULL</tt> on failure.
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFTypeID
SKSummaryGetTypeID(void) API_AVAILABLE( macos(10.4) ) API_UNAVAILABLE( macCatalyst );
/*
* SKSummaryCreateWithString()
*
* Summary:
* Creates a summary reference with text string.
*
* Discussion:
* Creates a summary reference that pre-computes what is needed for
* fast summarization. This function must be balanced with a call at
* a later time to CFRelease.
*
* Parameters:
*
* inString:
* the text string.
*
* Result:
* Returns a summary reference, or <tt>NULL</tt> on failure.
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern SKSummaryRef
SKSummaryCreateWithString(CFStringRef inString) API_AVAILABLE( macos(10.4) ) API_UNAVAILABLE( macCatalyst );
/*
* SKSummaryGetSentenceCount()
*
* Summary:
* Gets the number of sentences available.
*
* Parameters:
*
* summary:
* A reference to the summary object
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFIndex
SKSummaryGetSentenceCount(SKSummaryRef summary) API_AVAILABLE( macos(10.4) ) API_UNAVAILABLE( macCatalyst );
/*
* SKSummaryGetParagraphCount()
*
* Summary:
* Gets the number of paragraphs available.
*
* Parameters:
*
* summary:
* A reference to the summary object
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFIndex
SKSummaryGetParagraphCount(SKSummaryRef summary) API_AVAILABLE( macos(10.4) ) API_UNAVAILABLE( macCatalyst );
/*
* SKSummaryCopySentenceAtIndex()
*
* Summary:
* Gets the ith sentence from the original text.
*
* Parameters:
*
* summary:
* A reference to the summary object
*
* i:
* zero-based index
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFStringRef
SKSummaryCopySentenceAtIndex(
SKSummaryRef summary,
CFIndex i) API_AVAILABLE( macos(10.4) ) API_UNAVAILABLE( macCatalyst );
/*
* SKSummaryCopyParagraphAtIndex()
*
* Summary:
* Gets the ith paragraph from the original text.
*
* Parameters:
*
* summary:
* A reference to the summary object
*
* i:
* zero-based index
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFStringRef
SKSummaryCopyParagraphAtIndex(
SKSummaryRef summary,
CFIndex i) API_AVAILABLE( macos(10.4) ) API_UNAVAILABLE( macCatalyst );
/*
* SKSummaryCopySentenceSummaryString()
*
* Summary:
* Gets a summary string that includes at most the requested number
* of sentences.
*
* Parameters:
*
* summary:
* A reference to the summary object
*
* numSentences:
* the number of sentences desired
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFStringRef
SKSummaryCopySentenceSummaryString(
SKSummaryRef summary,
CFIndex numSentences) API_AVAILABLE( macos(10.4) ) API_UNAVAILABLE( macCatalyst );
/*
* SKSummaryCopyParagraphSummaryString()
*
* Summary:
* Gets a summary string that includes at most the requested number
* of paragraphs.
*
* Parameters:
*
* summary:
* A reference to the summary object
*
* numParagraphs:
* the number of paragraphs desired
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFStringRef
SKSummaryCopyParagraphSummaryString(
SKSummaryRef summary,
CFIndex numParagraphs) API_AVAILABLE( macos(10.4) ) API_UNAVAILABLE( macCatalyst );
/*
* SKSummaryGetSentenceSummaryInfo()
*
* Summary:
* Get detailed information about a sentence-based summary. Useful
* for constructing your own summary string. Arrays must be of size
* numSentences or they can be nil. Return value is the number of
* sentences actually returned. Sentences are returned in text order
* via outSentenceIndexOfSentences.
*
* Parameters:
*
* summary:
* A reference to the summary object
*
* numSentencesInSummary:
* the number of sentences desired
*
* outRankOrderOfSentences:
* array for returning the rank of each sentence; most important
* sentence is rank 1
*
* outSentenceIndexOfSentences:
* array for returning the index of each sentence; use
* SKSummaryCopySentenceAtIndex to get sentence
*
* outParagraphIndexOfSentences:
* array for returning the index of the paragraph in which
* sentence occured
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFIndex
SKSummaryGetSentenceSummaryInfo(
SKSummaryRef summary,
CFIndex numSentencesInSummary,
CFIndex * outRankOrderOfSentences,
CFIndex * outSentenceIndexOfSentences,
CFIndex * outParagraphIndexOfSentences) API_AVAILABLE( macos(10.4) ) API_UNAVAILABLE( macCatalyst );
/*
* SKSummaryGetParagraphSummaryInfo()
*
* Summary:
* Get detailed information about a paragraph-based summary. Useful
* for constructing your own summary string. Arrays must be of size
* numParagraphs or they can be nil. Return value is the number of
* paragraphs actually returned. Paragraphs are returned in text
* order via outParagraphIndexOfParagraphs.
*
* Parameters:
*
* summary:
* A reference to the summary object
*
* numParagraphsInSummary:
* the number of sentences desired
*
* outRankOrderOfParagraphs:
* array for returning the rank of each paragraph; most important
* paragraph is rank 1
*
* outParagraphIndexOfParagraphs:
* array for returning the index of each paragraph; use
* SKSummaryCopyParagraphAtIndex to get paragraph
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFIndex
SKSummaryGetParagraphSummaryInfo(
SKSummaryRef summary,
CFIndex numParagraphsInSummary,
CFIndex * outRankOrderOfParagraphs,
CFIndex * outParagraphIndexOfParagraphs) API_AVAILABLE( macos(10.4) ) API_UNAVAILABLE( macCatalyst );
#ifdef __cplusplus
}
#endif
#endif /* __SKSUMMARY__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/SearchKit.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/SearchKit.framework/Headers/SKSearch.h | /*
File: SearchKit/SKSearch.h
Contains: SearchKit Interfaces.
Version: SearchKit-417.1
Copyright: 2003-2019 by Apple, Inc., all rights reserved
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __SKSEARCH__
#define __SKSEARCH__
#ifndef __CFBASE__
#include <CoreFoundation/CFBase.h>
#endif
#ifndef __CFURL__
#include <CoreFoundation/CFURL.h>
#endif
#ifndef __CFDICTIONARY__
#include <CoreFoundation/CFDictionary.h>
#endif
#ifndef __CFDATE__
#include <CoreFoundation/CFDate.h>
#endif
#ifndef __SKINDEX__
#include <SearchKit/SKIndex.h>
#endif
/*
* Asynchronous search
*/
#include <AvailabilityMacros.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
#if PRAGMA_ENUM_ALWAYSINT
#pragma enumsalwaysint on
#endif
/*
* SKSearchRef
*
* Summary:
* An opaque data type representing an asynchronous search.
*/
typedef struct __SKSearch* SKSearchRef;
/*
* SKSearchGetTypeID()
*
* Summary:
* Returns the type identifier for the SKSearch type.
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFTypeID
SKSearchGetTypeID(void) API_AVAILABLE( macos(10.4) ) API_UNAVAILABLE( macCatalyst );
/*
* SKSearchOptions
*
* Summary:
* The various search options you can use with
* <tt>SKSearchCreate</tt>.
*/
typedef UInt32 SKSearchOptions;
enum {
kSKSearchOptionDefault = 0,
kSKSearchOptionNoRelevanceScores = 1L << 0, /* Save time by not computing relevance scores. */
kSKSearchOptionSpaceMeansOR = 1L << 1, /* Space in a query means OR instead of AND. */
kSKSearchOptionFindSimilar = 1L << 2 /* Find documents similar to given text string */
};
/*
* SKSearchCreate()
*
* Summary:
* Create an asynchronous search request.
*
* Discussion:
* A call to this function must be balanced with a call at a later
* time to <tt>CFRelease</tt>.
*
* Parameters:
*
* inIndex:
* A reference to the index to be searched.
*
* inQuery:
* The query string to search for.
*
* inSearchOptions:
* The search options. See the <tt>SKSearchOptions</tt>
* enumeration for options.
*
* Result:
* SKSearchRef A reference to a SKSearch opaque type.
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern SKSearchRef
SKSearchCreate(
SKIndexRef inIndex,
CFStringRef inQuery,
SKSearchOptions inSearchOptions) API_AVAILABLE( macos(10.4) ) API_UNAVAILABLE( macCatalyst );
/*
* SKSearchCancel()
*
* Summary:
* Cancel the search request.
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
SKSearchCancel(SKSearchRef inSearch) API_AVAILABLE( macos(10.4) ) API_UNAVAILABLE( macCatalyst );
/*
* SKSearchFindMatches()
*
* Summary:
* Search for up to maximumTime seconds or until inMaximumCount (or
* all) items are found.
*
* Discussion:
* Returns TRUE if more to search, FALSE when the search is
* exhausted. Returns number of entries actually found in
* *outFoundCount. The maximumTime of 0 means return quickly, so may
* return TRUE, and 0 outFoundCount. The relevance score is not
* normalized, so it can be very large.
*
* Parameters:
*
* inSearch:
* A reference to the SKSearch opaque type.
*
* inMaximumCount:
* The maximum number of found items to return.
*
* outDocumentIDsArray:
* An array of found document IDs. Must be inMaximumCount in size.
*
* outScoresArray:
* An array of relevance scores for found items. May be
* <tt>NULL</tt>.
*
* maximumTime:
* The maximum seconds before return.
*
* outFoundCount:
* The number of items actually found.
*
* Result:
* Boolean Returns TRUE if more to search, FALSE when
* the search is exhausted.
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern Boolean
SKSearchFindMatches(
SKSearchRef inSearch,
CFIndex inMaximumCount,
SKDocumentID * outDocumentIDsArray,
float * outScoresArray,
CFTimeInterval maximumTime,
CFIndex * outFoundCount) API_AVAILABLE( macos(10.4) ) API_UNAVAILABLE( macCatalyst );
/*
* SKIndexCopyInfoForDocumentIDs()
*
* Summary:
* Copies document names and parent ids by way of document IDs in an
* index.
*
* Parameters:
*
* inIndex:
* A reference to the index.
*
* inCount:
* The number of inDocumentIDsArray.
*
* inDocumentIDsArray:
* An array of document IDs.
*
* outNamesArray:
* An array of names for the specified document IDs. May be
* <tt>NULL</tt>.
*
* outParentIDsArray:
* An array of parent ids for the specified document IDs. May be
* <tt>NULL</tt>.
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
SKIndexCopyInfoForDocumentIDs(
SKIndexRef inIndex,
CFIndex inCount,
SKDocumentID * inDocumentIDsArray,
CFStringRef * outNamesArray,
SKDocumentID * outParentIDsArray) API_AVAILABLE( macos(10.4) ) API_UNAVAILABLE( macCatalyst );
/*
* SKIndexCopyDocumentRefsForDocumentIDs()
*
* Summary:
* Copies document references by way of document IDs in an index.
*
* Parameters:
*
* inIndex:
* A reference to the index.
*
* inCount:
* The number of inDocumentIDsArray.
*
* inDocumentIDsArray:
* An array of document IDs.
*
* outDocumentRefsArray:
* An array of document references for the specified document IDs.
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
SKIndexCopyDocumentRefsForDocumentIDs(
SKIndexRef inIndex,
CFIndex inCount,
SKDocumentID * inDocumentIDsArray,
SKDocumentRef * outDocumentRefsArray) API_AVAILABLE( macos(10.4) ) API_UNAVAILABLE( macCatalyst );
/*
* SKIndexCopyDocumentURLsForDocumentIDs()
*
* Summary:
* Copies document URLs by way of document IDs in an index.
*
* Parameters:
*
* inIndex:
* A reference to the index.
*
* inCount:
* The number of inDocumentIDsArray.
*
* inDocumentIDsArray:
* An array of document IDs.
*
* outDocumentURLsArray:
* An array of CFURLs for the specified document IDs.
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
SKIndexCopyDocumentURLsForDocumentIDs(
SKIndexRef inIndex,
CFIndex inCount,
SKDocumentID * inDocumentIDsArray,
CFURLRef * outDocumentURLsArray) API_AVAILABLE( macos(10.4) ) API_UNAVAILABLE( macCatalyst );
/*
* Synchronous search
*/
/*
* SKSearchGroupRef
*
* Summary:
* An opaque data type representing a search group.
*
* Discussion:
* A search group is a group of indexes to be searched.
*/
typedef struct __SKSearchGroup* SKSearchGroupRef;
/*
* SKSearchGroupGetTypeID() *** DEPRECATED ***
*
* Summary:
* Returns the type identifier for the SKSearchGroup type.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework but deprecated in 10.4
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFTypeID
SKSearchGroupGetTypeID(void) API_DEPRECATED("No longer supported", macos(10.3, 10.4)) API_UNAVAILABLE( macCatalyst );
/*
* SKSearchResultsRef
*
* Summary:
* An opaque data type representing search results.
*/
typedef struct __SKSearchResults* SKSearchResultsRef;
/*
* SKSearchResultsGetTypeID() *** DEPRECATED ***
*
* Summary:
* Returns the type identifier for the SKSearchResults object.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework but deprecated in 10.4
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFTypeID
SKSearchResultsGetTypeID(void) API_DEPRECATED("No longer supported", macos(10.3, 10.4)) API_UNAVAILABLE( macCatalyst );
/*
* SKSearchType
*
* Discussion:
* The various search types you can use with
* <tt>SKSearchResultsCreateWithQuery</tt>. Each of these specifies
* a set of ranked search hits. The kSKSearchRanked and
* kSKSearchPrefixRanked constants can be used for all index types.
* The kSKSearchBooleanRanked and kSKSearchRequiredRanked constants
* cannot be used for Vector indexes.
*/
enum SKSearchType {
/*
* Basic ranked search.
*/
kSKSearchRanked = 0,
/*
* The query can include boolean operators including '|', '&', '!',
* '(', and ')'.
*/
kSKSearchBooleanRanked = 1,
/*
* The query can specify required ('+') or excluded ('-') terms.
*/
kSKSearchRequiredRanked = 2,
/*
* Prefix-based search.
*/
kSKSearchPrefixRanked = 3
};
typedef enum SKSearchType SKSearchType;
/*
* SKSearchResultsFilterCallBack
*
* Summary:
* A callback function for hit testing during searching.
*
* Discussion:
* Return <tt>true</tt> to keep this document in the results,
* <tt>false</tt> to filter it out.
*/
typedef CALLBACK_API_C( Boolean , SKSearchResultsFilterCallBack )(SKIndexRef inIndex, SKDocumentRef inDocument, void *inContext);
/*
* SKSearchGroupCreate() *** DEPRECATED ***
*
* Summary:
* Creates a search group as an array of references to indexes.
*
* Discussion:
* A search group is used to search one or more indexes.
*
* Parameters:
*
* inArrayOfInIndexes:
* A CFArray object containing SKIndex objects.
*
* Result:
* SKSearchGroupRef A reference to an SKSearchGroup opaque type.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework but deprecated in 10.4
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern SKSearchGroupRef
SKSearchGroupCreate(CFArrayRef inArrayOfInIndexes) API_DEPRECATED("No longer supported", macos(10.3, 10.4)) API_UNAVAILABLE( macCatalyst );
/*
* SKSearchGroupCopyIndexes() *** DEPRECATED ***
*
* Summary:
* Gets the indexes for a search group.
*
* Result:
* A CFArray object containing SKIndex objects.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework but deprecated in 10.4
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFArrayRef
SKSearchGroupCopyIndexes(SKSearchGroupRef inSearchGroup) API_DEPRECATED("No longer supported", macos(10.3, 10.4)) API_UNAVAILABLE( macCatalyst );
/*
* SKSearchResultsCreateWithQuery() *** DEPRECATED ***
*
* Summary:
* Queries the indexes in a search group. This call has been
* deprecated in favor of <tt>SKSearchCreate</tt>.
*
* Discussion:
* A call to this function must be balanced with a call at a later
* time to <tt>CFRelease</tt>.
*
* Parameters:
*
* inSearchGroup:
* A reference to the search group.
*
* inQuery:
* The query string to search for.
*
* inSearchType:
* The type of search to perform. See the <tt>SKSearchType</tt>
* enumeration for options.
*
* inMaxFoundDocuments:
* The maximum number of found items to return. Your client must
* specify a positive value.
*
* inContext:
* A client-specified context. May be <tt>NULL</tt>.
*
* inFilterCallBack:
* A callback function for hit testing during searching. May be
* <tt>NULL</tt>.
*
* Result:
* SKSearchResultsRef A reference to an SKSearchResults opaque type.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework but deprecated in 10.4
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern SKSearchResultsRef
SKSearchResultsCreateWithQuery(
SKSearchGroupRef inSearchGroup,
CFStringRef inQuery,
SKSearchType inSearchType,
CFIndex inMaxFoundDocuments,
void * inContext,
SKSearchResultsFilterCallBack inFilterCallBack) API_DEPRECATED("No longer supported", macos(10.3, 10.4)) API_UNAVAILABLE( macCatalyst );
/*
* SKSearchResultsCreateWithDocuments() *** DEPRECATED ***
*
* Summary:
* Finds documents similar to given example documents by searching
* the indexes in a search group. This call has been deprecated in
* favor of <tt>SKSearchCreate</tt>.
*
* Discussion:
* A call to SKSearchResultsCreateWithDocuments must be balanced
* with a call at a later time to <tt>CFRelease</tt>.
*
* Parameters:
*
* inSearchGroup:
* A reference to the search group.
*
* inExampleDocuments:
* An array of example documents. The documents must previously
* have been indexed.
*
* inMaxFoundDocuments:
* The maximum number of found items to return. Your client must
* specify a positive value.
*
* inContext:
* A client-specified context. May be <tt>NULL</tt>.
*
* inFilterCallBack:
* A callback function for hit testing during searching. May be
* <tt>NULL</tt>.
*
* Result:
* SKSearchResultsRef A reference to an SKSearchResults opaque type.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework but deprecated in 10.4
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern SKSearchResultsRef
SKSearchResultsCreateWithDocuments(
SKSearchGroupRef inSearchGroup,
CFArrayRef inExampleDocuments,
CFIndex inMaxFoundDocuments,
void * inContext,
SKSearchResultsFilterCallBack inFilterCallBack) API_DEPRECATED("No longer supported", macos(10.3, 10.4)) API_UNAVAILABLE( macCatalyst );
/*
* SKSearchResultsGetCount() *** DEPRECATED ***
*
* Summary:
* Gets the total number of found items in a search.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework but deprecated in 10.4
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFIndex
SKSearchResultsGetCount(SKSearchResultsRef inSearchResults) API_DEPRECATED("No longer supported", macos(10.3, 10.4)) API_UNAVAILABLE( macCatalyst );
/*
* SKSearchResultsGetInfoInRange() *** DEPRECATED ***
*
* Summary:
* Fills in requested results, returns number of items that were
* returned.
*
* Discussion:
* Search results are returned in descending order of relevance
* score.
*
* Parameters:
*
* inSearchResults:
* A reference to the search results.
*
* inRange:
* A CFRange value pair, specified as (location, length). The
* location value specifies the starting item by ranking. The
* length value specifies the total number of items. Examples:
* (0,1) means the first item, which is also the highest ranking
* item. (1,1) means the second item, which is also the
* second-highest ranking item. (0,5) means to get the first 5
* items.
*
* outDocumentsArray:
* An array of found documents.
*
* outIndexesArray:
* An array of indexes in which the found docouments reside. May
* be <tt>NULL</tt> provided that the client does not care.
*
* outScoresArray:
* An array of correspondence scores for found items. May be
* <tt>NULL</tt>.
*
* Result:
* The number of items returned -- usually the same number as
* specified.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework but deprecated in 10.4
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFIndex
SKSearchResultsGetInfoInRange(
SKSearchResultsRef inSearchResults,
CFRange inRange,
SKDocumentRef * outDocumentsArray,
SKIndexRef * outIndexesArray,
float * outScoresArray) API_DEPRECATED("No longer supported", macos(10.3, 10.4)) API_UNAVAILABLE( macCatalyst );
/*
* SKSearchResultsCopyMatchingTerms() *** DEPRECATED ***
*
* Summary:
* Gets the matching terms for the specified search result item
* index.
*
* Parameters:
*
* inSearchResults:
* A reference to the search results.
*
* inItem:
* The search result item index, starting from 1.
*
* Result:
* A reference to a CFArray object of term IDs.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework but deprecated in 10.4
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFArrayRef
SKSearchResultsCopyMatchingTerms(
SKSearchResultsRef inSearchResults,
CFIndex inItem) API_DEPRECATED("No longer supported", macos(10.3, 10.4)) API_UNAVAILABLE( macCatalyst );
#if PRAGMA_ENUM_ALWAYSINT
#pragma enumsalwaysint reset
#endif
#ifdef __cplusplus
}
#endif
#endif /* __SKSEARCH__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/SearchKit.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/SearchKit.framework/Headers/SKIndex.h | /*
File: SearchKit/SKIndex.h
Contains: SearchKit Interfaces.
Version: SearchKit-417.1
Copyright: 2003-2019 by Apple, Inc., all rights reserved
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __SKINDEX__
#define __SKINDEX__
#ifndef __CFBASE__
#include <CoreFoundation/CFBase.h>
#endif
#ifndef __CFURL__
#include <CoreFoundation/CFURL.h>
#endif
#ifndef __CFDICTIONARY__
#include <CoreFoundation/CFDictionary.h>
#endif
#ifndef __SKDOCUMENT__
#include <SearchKit/SKDocument.h>
#endif
/*
* CFTypes for use with SearchKit
*/
#include <AvailabilityMacros.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
#if PRAGMA_ENUM_ALWAYSINT
#pragma enumsalwaysint on
#endif
/*
* SKIndexRef
*
* Summary:
* An opaque data type representing an index.
*/
typedef struct __SKIndex* SKIndexRef;
/*
* SKIndexGetTypeID()
*
* Summary:
* Returns the type identifier for the index.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFTypeID
SKIndexGetTypeID(void) API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* SKIndexDocumentIteratorRef
*
* Summary:
* An opaque data type representing an index iterator.
*/
typedef struct __SKIndexDocumentIterator* SKIndexDocumentIteratorRef;
/*
* SKIndexDocumentIteratorGetTypeID()
*
* Summary:
* Returns the type identifier of the index iterator.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFTypeID
SKIndexDocumentIteratorGetTypeID(void) API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* enumeration types
*/
/*
* SKIndexType
*
* Summary:
* The possible index types for SearchKit indexes.
*/
enum SKIndexType {
/*
* Unknown index type.
*/
kSKIndexUnknown = 0,
/*
* Inverted index, mapping terms to documents.
*/
kSKIndexInverted = 1,
/*
* Vector index, mapping documents to terms.
*/
kSKIndexVector = 2,
/*
* Index type with all the capabilities of an inverted and a vector
* index.
*/
kSKIndexInvertedVector = 3
};
typedef enum SKIndexType SKIndexType;
/*
* SKDocumentIndexState
*
* Summary:
* The indexing state of a document.
*/
enum SKDocumentIndexState {
/*
* Document is not indexed.
*/
kSKDocumentStateNotIndexed = 0,
/*
* Document is indexed.
*/
kSKDocumentStateIndexed = 1,
/*
* Document is not in the index but will be added after the index is
* flushed or closed.
*/
kSKDocumentStateAddPending = 2,
/*
* Document is in the index but will be deleted after the index is
* flushed or closed.
*/
kSKDocumentStateDeletePending = 3
};
typedef enum SKDocumentIndexState SKDocumentIndexState;
/*
* SKIndexCreateWithURL()
*
* Summary:
* Creates a named index in a file whose location is specified with
* a CFURL object.
*
* Discussion:
* When an index is created, the client must also specify the index
* type. The name can be <tt>NULL</tt>. A file can contain more than
* one index. If the analysis properties dictionary is not
* specified, the default dictionary is used. The various analysis
* properties are described in the SKAnalysis.h header file. Use the
* <tt>SKIndexGetAnalysisProperties</tt> function to get the
* analysis properties of an index. A call to this function must be
* balanced with a call at a later time to <tt>CFRelease</tt>.
*
* Parameters:
*
* inURL:
* A reference to a CFURL object containing the location of the
* index.
*
* inIndexName:
* A reference to a CFString object containing the name of the
* index. May be <tt>NULL</tt>.
*
* inIndexType:
* The index type.
*
* inAnalysisProperties:
* A reference to the analysis properties dictionary. May be
* <tt>NULL</tt>.
*
* Result:
* SKIndexRef A reference to the index.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern SKIndexRef
SKIndexCreateWithURL(
CFURLRef inURL,
CFStringRef inIndexName, /* can be NULL */
SKIndexType inIndexType,
CFDictionaryRef inAnalysisProperties) /* can be NULL */ API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* SKIndexOpenWithURL()
*
* Summary:
* Opens an existing, named index stored in a file whose location is
* specified with a CFURL object.
*
* Discussion:
* A call to this function must be balanced with a call at a later
* time to <tt>CFRelease</tt>.
*
* Parameters:
*
* inURL:
* A reference to a file CFURL object containing the location of
* the index.
*
* inIndexName:
* A reference to a CFString object containing the name of the
* index. May be <tt>NULL</tt>.
*
* inWriteAccess:
* A boolean value indicating whether the index is open for
* writing.
*
* Result:
* SKIndexRef A reference to the index.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern SKIndexRef
SKIndexOpenWithURL(
CFURLRef inURL,
CFStringRef inIndexName, /* can be NULL */
Boolean inWriteAccess) API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* SKIndexCreateWithMutableData()
*
* Summary:
* Creates a named index stored in a CFData object; the name can be
* <tt>NULL</tt>.
*
* Parameters:
*
* inData:
* A reference to a CFMutableData object containing the index to
* create.
*
* inIndexName:
* A reference to a CFString object containing the name of the
* index. May be <tt>NULL</tt>.
*
* inIndexType:
* A reference to the index type.
*
* inAnalysisProperties:
* A reference to the analysis properties dictionary. May be
* <tt>NULL</tt>.
*
* Result:
* SKIndexRef A reference to the index.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern SKIndexRef
SKIndexCreateWithMutableData(
CFMutableDataRef inData,
CFStringRef inIndexName, /* can be NULL */
SKIndexType inIndexType,
CFDictionaryRef inAnalysisProperties) /* can be NULL */ API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* SKIndexOpenWithData()
*
* Summary:
* Opens an existing, named index stored in a CFData object.
*
* Discussion:
* The index may be searched but not updated. To open the index for
* updating, use the <tt>SKIndexOpenWithMutableData</tt> function. A
* call to this function must be balanced with a call at a later
* time to <tt>CFRelease</tt>.
*
* Parameters:
*
* inData:
* A reference to a CFData object containing the index to open.
*
* inIndexName:
* A reference to a CFString object containing the name of the
* index. May be <tt>NULL</tt>.
*
* Result:
* SKIndexRef A reference to the index.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern SKIndexRef
SKIndexOpenWithData(
CFDataRef inData,
CFStringRef inIndexName) /* can be NULL */ API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* SKIndexOpenWithMutableData()
*
* Summary:
* Opens an existing, named index stored in a CFData object.
*
* Discussion:
* The index may be searched or updated. To open the index for
* search only, use the <tt>SKIndexOpenWithData</tt> function. A
* call to this function must be balanced with a call at a later
* time to <tt>CFRelease</tt>.
*
* Parameters:
*
* inData:
* A reference to a CFMutableData object containing the index to
* open.
*
* inIndexName:
* A reference to a CFString object containing the name of the
* index. May be <tt>NULL</tt>.
*
* Result:
* SKIndexRef A reference to the index.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern SKIndexRef
SKIndexOpenWithMutableData(
CFMutableDataRef inData,
CFStringRef inIndexName) /* can be NULL */ API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* SKIndexFlush()
*
* Summary:
* Forces SearchKit to flush all caches associated with an index.
*
* Discussion:
* Index caches can become stale when clients add or remove
* documents. Before searching an index you need to call
* <tt>SKIndexFlush</tt>, even though the cache flushing may take
* some time.
*
* Result:
* Returns a Boolean value of <tt>true</tt> on success or
* <tt>false</tt> on failure.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern Boolean
SKIndexFlush(SKIndexRef inIndex) API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* SKIndexSetMaximumBytesBeforeFlush()
*
* Summary:
* Sets the memory size limit for an index.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
SKIndexSetMaximumBytesBeforeFlush(
SKIndexRef inIndex,
CFIndex inBytesForUpdate) API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* SKIndexGetMaximumBytesBeforeFlush()
*
* Summary:
* Gets the memory size limit for an index, measured in bytes.
*
* Result:
* Returns a CFIndex object containing the memory size limit for an
* index. On failure, returns 0.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFIndex
SKIndexGetMaximumBytesBeforeFlush(SKIndexRef inIndex) API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* SKIndexCompact()
*
* Summary:
* Attempts to defragment and compact the index.
*
* Discussion:
* This function takes time. Call it only when the index is too
* fragmented. You can test for fragmentation be examining the ratio
* of the total document count, obtained with
* <tt>SKIndexGetDocumentCount</tt>, to the maximum document ID,
* obtained with <tt>SKIndexGetMaximumDocumentID</tt>.
*
* Result:
* Returns a Boolean value of <tt>true</tt> on success or
* <tt>false</tt> on failure.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern Boolean
SKIndexCompact(SKIndexRef inIndex) API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* SKIndexGetIndexType()
*
* Summary:
* Gets the type of an index.
*
* Discussion:
* See the <tt>SKIndexType</tt> enumeration for a list of the
* various index types.
*
* Result:
* Returns the type of the index. On failure, returns a value of
* kSKIndexUnknown.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern SKIndexType
SKIndexGetIndexType(SKIndexRef inIndex) API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* SKIndexGetAnalysisProperties()
*
* Summary:
* Gets the text analysis properties of an index.
*
* Result:
* Returns a CFDictionary object containing the index's text
* analysis properties. On failure, returns <tt>NULL</tt>.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFDictionaryRef
SKIndexGetAnalysisProperties(SKIndexRef inIndex) API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* SKIndexGetDocumentCount()
*
* Summary:
* Gets the total number of documents represented in an index.
*
* Discussion:
* Indexed documents have an indexing state of
* kSKDocumentStateIndexed. See the <tt>SKDocumentIndexState</tt>
* enumeration.
*
* Result:
* Returns CFIndex object containing the number of documents in the
* index. On failure, returns 0.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFIndex
SKIndexGetDocumentCount(SKIndexRef inIndex) API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* SKIndexClose()
*
* Summary:
* Close the index.
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
SKIndexClose(SKIndexRef inIndex) API_AVAILABLE( macos(10.4) ) API_UNAVAILABLE( macCatalyst );
/*
* Managing documents inside an index
*/
typedef CFIndex SKDocumentID;
/*
* SKIndexAddDocumentWithText()
*
* Summary:
* Adds a document and its text to an index.
*
* Parameters:
*
* inIndex:
* A reference to the index to which you are adding the document.
*
* inDocument:
* A reference to the document to add.
*
* inDocumentText:
* A reference to the document text. May be <tt>NULL</tt>.
*
* inCanReplace:
* A boolean value indicating whether a document with the same
* descriptor can be overwritten.
*
* Result:
* Returns a Boolean value of <tt>true</tt> on success or
* <tt>false</tt> on failure.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern Boolean
SKIndexAddDocumentWithText(
SKIndexRef inIndex,
SKDocumentRef inDocument,
CFStringRef inDocumentText, /* can be NULL */
Boolean inCanReplace) API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* SKIndexAddDocument()
*
* Summary:
* Adds a document to an index.
*
* Discussion:
* This function uses the input document and the optional MIME type
* hint to get the document text using plug-in-based text
* extractors. Call <tt>SKLoadDefaultExtractorPlugIns</tt> to load
* the default text extractors.
*
* Parameters:
*
* inDocument:
* A reference to the document to add. The document scheme must be
* of type "file" to use this function. If it's not, call
* <tt>SKIndexAddDocumentWithText</tt> instead.
*
* inIndex:
* A reference to the index to which you are adding the document.
*
* inDocument:
* A reference to the document to add.
*
* inMIMETypeHint:
* The MIME type hint for the document. May be <tt>NULL</tt>.
*
* inCanReplace:
* A boolean value indicating whether a document with the same
* descriptor can be overwritten.
*
* Result:
* Returns a Boolean value of <tt>true</tt> on success or
* <tt>false</tt> on failure.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern Boolean
SKIndexAddDocument(
SKIndexRef inIndex,
SKDocumentRef inDocument,
CFStringRef inMIMETypeHint, /* can be NULL */
Boolean inCanReplace) API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* SKIndexRemoveDocument()
*
* Summary:
* Removes a document and its children, if any, from an index.
*
* Parameters:
*
* inIndex:
* A reference to the index from which you want to remove the
* document.
*
* inDocument:
* A reference to the document to remove.
*
* Result:
* Returns a Boolean value of <tt>true</tt> on success or
* <tt>false</tt> on failure.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern Boolean
SKIndexRemoveDocument(
SKIndexRef inIndex,
SKDocumentRef inDocument) API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* SKIndexCopyDocumentProperties()
*
* Summary:
* Copies the user-defined properties of a document in an index to a
* dictionary.
*
* Result:
* Returns a CFDictionary object, or <tt>NULL</tt> on failure.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFDictionaryRef
SKIndexCopyDocumentProperties(
SKIndexRef inIndex,
SKDocumentRef inDocument) API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* SKIndexSetDocumentProperties()
*
* Summary:
* Sets the user-defined properties of a document in an index. A
* document's properties are persistently stored in the index. The
* existing properties dictionary will be replaced with the new one.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
SKIndexSetDocumentProperties(
SKIndexRef inIndex,
SKDocumentRef inDocument,
CFDictionaryRef inProperties) API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* SKIndexGetDocumentState()
*
* Summary:
* Gets the current indexing state of a document in an index.
*
* Discussion:
* A document can be in 1 of 4 states, as defined by the
* <tt>SKDocumentIndexState</tt> enumeration: not indexed, indexed,
* not in the index but will be added after the index is flushed or
* closed, and in the index but will be deleted after the index is
* flushed or closed.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern SKDocumentIndexState
SKIndexGetDocumentState(
SKIndexRef inIndex,
SKDocumentRef inDocument) API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* SKIndexGetDocumentID()
*
* Summary:
* Gets the ID of a document in an index.
*
* Discussion:
* The document ID is a persistent way to identify the document in
* an index.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern SKDocumentID
SKIndexGetDocumentID(
SKIndexRef inIndex,
SKDocumentRef inDocument) API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* SKIndexCopyDocumentForDocumentID()
*
* Summary:
* Copies a document reference by way of a document ID in an index.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern SKDocumentRef
SKIndexCopyDocumentForDocumentID(
SKIndexRef inIndex,
SKDocumentID inDocumentID) API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* SKIndexRenameDocument()
*
* Summary:
* Changes the name of a document in an index.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern Boolean
SKIndexRenameDocument(
SKIndexRef inIndex,
SKDocumentRef inDocument,
CFStringRef inNewName) API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* SKIndexMoveDocument()
*
* Summary:
* Changes the parent of a document in an index.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern Boolean
SKIndexMoveDocument(
SKIndexRef inIndex,
SKDocumentRef inDocument,
SKDocumentRef inNewParent) API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* SKIndexDocumentIteratorCreate()
*
* Summary:
* Creates an iterator for an index based on a starting document
* reference.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern SKIndexDocumentIteratorRef
SKIndexDocumentIteratorCreate(
SKIndexRef inIndex,
SKDocumentRef inParentDocument) API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* SKIndexDocumentIteratorCopyNext()
*
* Summary:
* Gets the next document reference from a document iterator.
*
* Discussion:
* This function returns <tt>NULL</tt> when there are no more
* documents. You must call <tt>CFRelease</tt> on all retrieved
* document references that are non-null.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern SKDocumentRef
SKIndexDocumentIteratorCopyNext(SKIndexDocumentIteratorRef inIterator) API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* Documents in Index
*/
/*
* SKIndexGetMaximumDocumentID()
*
* Summary:
* Gets the highest-numbered document ID in an index.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern SKDocumentID
SKIndexGetMaximumDocumentID(SKIndexRef inIndex) API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* SKIndexGetDocumentTermCount()
*
* Summary:
* Gets the number of terms for a given document in an index.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFIndex
SKIndexGetDocumentTermCount(
SKIndexRef inIndex,
SKDocumentID inDocumentID) API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* SKIndexCopyTermIDArrayForDocumentID()
*
* Summary:
* Gets the IDs for the terms of a document in an index.
*
* Result:
* A reference to a CFArray object containing CFNumber objects.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFArrayRef
SKIndexCopyTermIDArrayForDocumentID(
SKIndexRef inIndex,
SKDocumentID inDocumentID) API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* SKIndexGetDocumentTermFrequency()
*
* Summary:
* Gets the frequency of occurrences of a given term in a document.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFIndex
SKIndexGetDocumentTermFrequency(
SKIndexRef inIndex,
SKDocumentID inDocumentID,
CFIndex inTermID) API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* Terms in Index
*
* A term is a word from the content of a document.
*/
/*
* SKIndexGetMaximumTermID()
*
* Summary:
* Gets the highest-numbered term ID in an index.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFIndex
SKIndexGetMaximumTermID(SKIndexRef inIndex) API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* SKIndexGetTermDocumentCount()
*
* Summary:
* Gets the number of documents containing a given term in an index.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFIndex
SKIndexGetTermDocumentCount(
SKIndexRef inIndex,
CFIndex inTermID) API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* SKIndexCopyDocumentIDArrayForTermID()
*
* Summary:
* Gets the IDs of the documents containing a given term in an index.
*
* Result:
* A reference to a CFArray object containing CFNumber objects.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFArrayRef
SKIndexCopyDocumentIDArrayForTermID(
SKIndexRef inIndex,
CFIndex inTermID) API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* SKIndexCopyTermStringForTermID()
*
* Summary:
* Gets the term specified by a term ID in an index.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFStringRef
SKIndexCopyTermStringForTermID(
SKIndexRef inIndex,
CFIndex inTermID) API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* SKIndexGetTermIDForTermString()
*
* Summary:
* Gets the term ID for a given term in an index.
*
* Discussion:
* If the term isn't found, return a value of kCFNotFound.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFIndex
SKIndexGetTermIDForTermString(
SKIndexRef inIndex,
CFStringRef inTermString) API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* SKLoadDefaultExtractorPlugIns()
*
* Summary:
* Loads the default text extractor plug-ins.
*
* Discussion:
* A text extractor knows the format of a specific kind of document.
* For example, various text extractors can return the text of a PDF
* document, strip the tags of an HTML document, and so on. Loading
* extractors allows the <tt>SKIndexAddDocument</tt> function to
* extract the text from supported documents, leaving the markup
* behind.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
SKLoadDefaultExtractorPlugIns(void) API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
#if PRAGMA_ENUM_ALWAYSINT
#pragma enumsalwaysint reset
#endif
#ifdef __cplusplus
}
#endif
#endif /* __SKINDEX__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/SearchKit.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/SearchKit.framework/Headers/SKAnalysis.h | /*
File: SearchKit/SKAnalysis.h
Contains: SearchKit Interfaces.
Version: SearchKit-417.1
Copyright: 2003-2019 by Apple, Inc., all rights reserved
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __SKANALYSIS__
#define __SKANALYSIS__
#ifndef __CFSTRING__
#include <CoreFoundation/CFString.h>
#endif
/*
The possible text analysis properties of an index, used by
SKIndexCreateWithURL or SKIndexCreateWithMutableData.
*/
#include <AvailabilityMacros.h>
#if PRAGMA_ONCE
#pragma once
#endif
/*
* kSKMinTermLength
*
* Summary:
* The minimum term length to index.
*
* Discussion:
* The kSKMinTermLength constant is an optional key in the text
* analysis properties dictionary whose corresponding value is a
* CFNumber object containing the minimum term length to index. If
* this key is not present, SearchKit indexing defaults to a minimum
* term length of 1.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern const CFStringRef kSKMinTermLength API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* kSKSubstitutions
*
* Summary:
* A dictionary of term substitutions.
*
* Discussion:
* The kSKSubstitutions constant is an optional key in the text
* analysis properties dictionary whose corresponding value is a
* CFDictionary object containing term substitutions.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern const CFStringRef kSKSubstitutions API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* kSKStopWords
*
* Summary:
* A set of stop words--words not to index.
*
* Discussion:
* The kSKStopWords constant is an optional key in the text analysis
* properties dictionary whose corresponding value is a CFSet object
* containing words not to index.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern const CFStringRef kSKStopWords API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( macCatalyst );
/*
* kSKProximityIndexing
*
* Summary:
* The proximity indexing option.
*
* Discussion:
* The kSKProximityIndexing constant is an optional key in the text
* analysis properties dictionary whose corresponding value is a
* CFBoolean object containing the proximity indexing option. If
* this key is not present, SearchKit indexing defaults to not doing
* proximity indexing.
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern const CFStringRef kSKProximityIndexing API_AVAILABLE( macos(10.4) ) API_UNAVAILABLE( macCatalyst );
/*
* kSKMaximumTerms
*
* Summary:
* The maximum unique terms per document to index.
*
* Discussion:
* The kSKMaximumTerms constant is an optional key in the text
* analysis properties dictionary whose corresponding value is a
* CFNumber object containing the maximum unique terms per document
* to index. If this key is not present, SearchKit indexing defaults
* to 2000. If the value of this key is zero, there is no limit of
* the maximum unique terms per document to index.
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern const CFStringRef kSKMaximumTerms API_AVAILABLE( macos(10.4) ) API_UNAVAILABLE( macCatalyst );
/*
* kSKTermChars
*
* Summary:
* The extra valid characters for indexing.
*
* Discussion:
* The kSKTermCharSet constant is an optional key in the text
* analysis properties dictionary whose corresponding value is a
* CFString object containing the extra valid characters that a
* valid term (word) can contain. Used for indexing and query
* processing.
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern const CFStringRef kSKTermChars API_AVAILABLE( macos(10.4) ) API_UNAVAILABLE( macCatalyst );
/*
* kSKStartTermChars
*
* Summary:
* The extra valid characters for indexing.
*
* Discussion:
* The kSKStartTermChars constant is an optional key in the text
* analysis properties dictionary whose corresponding value is a
* CFString object containing the extra valid characters that can
* occur as the first character of a term. Overrides the
* kSKTermChars for the first character of a term.
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern const CFStringRef kSKStartTermChars API_AVAILABLE( macos(10.4) ) API_UNAVAILABLE( macCatalyst );
/*
* kSKEndTermChars
*
* Summary:
* The extra valid characters for indexing.
*
* Discussion:
* The kSKEndTermChars constant is an optional key in the text
* analysis properties dictionary whose corresponding value is a
* CFString object containing the extra valid characters that can
* occur as the last character of a term. Overrides the kSKTermChars
* for the last character of a term.
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern const CFStringRef kSKEndTermChars API_AVAILABLE( macos(10.4) ) API_UNAVAILABLE( macCatalyst );
/*
* kSKLanguageTypes *** DEPRECATED ***
*
* Summary:
* An array of string objects that specify the languages to use for
* indexing.
*
* Discussion:
* The kSKLanguageTypes constant is an optional key in the text
* analysis properties dictionary whose corresponding value is an
* array of string objects that together specify the languages to
* use for indexing. Each string should be a two character ISO 639-1
* code indicating a language to use. For example, 'en' for English,
* 'ja' for Japanese, and so on. If this key is not present,
* SearchKit uses the Mac OS X preferences system to determine the
* primary language from the user's locale.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework but deprecated in 10.4
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern const CFStringRef kSKLanguageTypes API_DEPRECATED("No longer supported", macos(10.3, 10.4)) API_UNAVAILABLE( macCatalyst );
#endif /* __SKANALYSIS__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/SearchKit.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/SearchKit.framework/Headers/SearchKit.h | /*
File: SearchKit/SearchKit.h
Contains: SearchKit Interfaces.
Version: SearchKit-417.1
Copyright: 2003-2019 by Apple, Inc., all rights reserved
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
/*
* This framework provides required capabilities to index, search, and analyze the
* text of documents. A document is simply an item from which terms can be extracted.
* (i.e. a file on a computer, a record in a database, a sentence, ...)
*/
#ifndef __SEARCHKIT__
#define __SEARCHKIT__
#ifndef __COREFOUNDATION__
#include <CoreFoundation/CoreFoundation.h>
#endif
#ifndef __SKDOCUMENT__
#include <SearchKit/SKDocument.h>
#endif
#ifndef __SKANALYSIS__
#include <SearchKit/SKAnalysis.h>
#endif
#ifndef __SKINDEX__
#include <SearchKit/SKIndex.h>
#endif
#ifndef __SKSEARCH__
#include <SearchKit/SKSearch.h>
#endif
#ifndef __SKSUMMARY__
#include <SearchKit/SKSummary.h>
#endif
#endif /* __SEARCHKIT__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/AE.framework/AE.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: 3F027CDA-3649-35AB-A3BF-CE76CDB6192A
- target: x86_64-maccatalyst
value: 3F027CDA-3649-35AB-A3BF-CE76CDB6192A
- target: arm64-macos
value: 00000000-0000-0000-0000-000000000000
- target: arm64-maccatalyst
value: 00000000-0000-0000-0000-000000000000
- target: arm64e-macos
value: EC2CC19C-A2FA-37CD-9664-DF8F9947D367
- target: arm64e-maccatalyst
value: EC2CC19C-A2FA-37CD-9664-DF8F9947D367
install-name: '/System/Library/Frameworks/CoreServices.framework/Versions/A/Frameworks/AE.framework/Versions/A/AE'
current-version: 924
compatibility-version: 0
parent-umbrella:
- targets: [ x86_64-macos, x86_64-maccatalyst, arm64-macos, arm64-maccatalyst,
arm64e-macos, arm64e-maccatalyst ]
umbrella: CoreServices
allowable-clients:
- targets: [ x86_64-macos, x86_64-maccatalyst, arm64-macos, arm64-maccatalyst,
arm64e-macos, arm64e-maccatalyst ]
clients: [ DesktopServices, Foundation, HIServices, LaunchServices, PrintCore ]
exports:
- targets: [ x86_64-maccatalyst, x86_64-macos, arm64e-maccatalyst, arm64e-macos,
arm64-macos, arm64-maccatalyst ]
symbols: [ _AEBuildAppleEvent, _AEBuildDesc, _AEBuildParameters, _AECallObjectAccessor,
_AECheckIsRecord, _AECoerceDesc, _AECoercePtr, _AECoercionHandlersApplyFunction,
_AECompareDesc, _AEConvertFromMsg, _AECountItems, _AECreateAppleEvent,
_AECreateDesc, _AECreateDescFromExternalPtr, _AECreateList,
_AECreateRemoteProcessResolver, _AEDecodeMessage, _AEDeleteItem,
_AEDeleteParam, _AEDescribeDesc, _AEDeterminePermissionToAutomateTarget,
_AEDispatchEvent, _AEDisposeDesc, _AEDisposeRemoteProcessResolver,
_AEDisposeToken, _AEDuplicateDesc, _AEEventHandlersApplyFunction,
_AEFlattenDesc, _AEGetArray, _AEGetAttributeDesc, _AEGetAttributePtr,
_AEGetCoercionHandler, _AEGetDescData, _AEGetDescDataRange,
_AEGetDescDataSize, _AEGetEventHandler, _AEGetNthDesc, _AEGetNthPtr,
_AEGetObjectAccessor, _AEGetParamDesc, _AEGetParamPtr, _AEGetRegisteredMachPort,
_AEGetSpecialHandler, _AEInitializeDesc, _AEInstallCoercionHandler,
_AEInstallEventHandler, _AEInstallObjectAccessor, _AEInstallSpecialHandler,
_AEInstallSystemDispatcher, _AEManagerInfo, _AEObjectInit,
_AEPrintDescToHandle, _AEProcessMessage, _AEPutArray, _AEPutAttributeDesc,
_AEPutAttributePtr, _AEPutDesc, _AEPutParamDesc, _AEPutParamPtr,
_AEPutPtr, _AEReceiveFromMach, _AERemoteProcessResolverGetProcesses,
_AERemoteProcessResolverScheduleWithRunLoop, _AERemoveCoercionHandler,
_AERemoveEventHandler, _AERemoveObjectAccessor, _AERemoveSpecialHandler,
_AEReplaceDescData, _AEResolve, _AESendMessage, _AESendWithMach,
_AESetObjectCallbacks, _AESizeOfAttribute, _AESizeOfFlattenedDesc,
_AESizeOfNthItem, _AESizeOfParam, _AEStreamClose, _AEStreamCloseDesc,
_AEStreamCloseList, _AEStreamCloseRecord, _AEStreamCreateEvent,
_AEStreamOpen, _AEStreamOpenDesc, _AEStreamOpenEvent, _AEStreamOpenKeyDesc,
_AEStreamOpenList, _AEStreamOpenRecord, _AEStreamOptionalParam,
_AEStreamSetRecordType, _AEStreamWriteAEDesc, _AEStreamWriteData,
_AEStreamWriteDesc, _AEStreamWriteKey, _AEStreamWriteKeyDesc,
_AEUnflattenDesc, _AEUnflattenDescFromBytes, _CreateCompDescriptor,
_CreateLogicalDescriptor, _CreateObjSpecifier, _CreateOffsetDescriptor,
_CreateRangeDescriptor, _GDBPrintAECoercionTables, _GDBPrintAEDesc,
_GDBPrintAEHandlerTables, _GDBPrintHelpDebuggingAppleEvents,
__AEAddAnnotationsToAppleEvent, __AEAppleEventMergeAnnotations,
__AECanSandboxedApplicationSendAppleEvent, __AECopyEntitlementForToken,
__AECopyRegisteredMachPort, __AECreateAEReceiveMachPort, __AECreateAEReceivePortInRunLoopWithSource,
__AECreateAnnotatedAppleEvent, __AEDescEventGetCounts, __AEDescEventIndexedAttributeItem,
__AEDescEventIndexedParamItem, __AEDescGetAsString, __AEDescInformation,
__AEDescListGetCount, __AEDescListIndexedItem, __AEDescRecordGetCount,
__AEDescRecordIndexedItem, __AEDescToInternalImpl, __AEDoesAppleEventContainAnyTypesWhichRequireAnnotation,
__AEEventDescGetInformation, __AEEventRequiresSecurityHandlerChecks,
__AEEventSecurityHandlerDoChecks, __AEGenerateAnnotations,
__AEInstallAEInteractWithUserCallback, __AEInstallEventHandlerBlock,
__AEInstallEventSecurityHandler, __AEInstallEventSecurityHandlerBlock,
__AEIsAppleEventTargetInSandbox, __AERegisterCurrentApplicationInfomationWithAppleEventsD,
__AERemoveAEReceivePort, __AERemoveEventSecurityHandler, __AEUnflattenDescFromBytes,
__AppleEventsCheckInApp, __AppleEventsCheckInAppWithBlock,
__AppleEventsCopyApplicationEntitlements, __AppleEventsCopyApplicationEntitlementsWithBlock,
__AppleEventsCopyStatusString, __AppleEventsCopyStatusStringWithBlock,
__AppleEventsForwardEntitlements, __AppleEventsForwardEntitlementsWithBlock,
__AppleEventsHintApp, __AppleEventsHintAppWithBlock, __AppleEventsListApplications,
__AppleEventsListApplicationsWithBlock, __AppleEventsLookupApplicationPort,
__AppleEventsLookupApplicationPortWithBlock, __AppleEventsReleaseProcessAssertion,
__AppleEventsReleaseProcessAssertionWithBlock, __AppleEventsRequestProcessAssertion,
__AppleEventsRequestProcessAssertionWithBlock, __AppleEventsSendPortRequiresProcessAssertions,
__kAppleEventsScriptingEntitlementKey, _aeAddFilter, _aeAppendToImplEnd,
_aeBindToArbitraryMachPort, _aeCheckMessage, _aeCheckinApp,
_aeClassicCompatFlattenDesc, _aeClassicCompatSizeOfFlattenedDesc,
_aeConvertCarbonToClassic, _aeConvertClassicToCarbon, _aeCreateBuffer,
_aeCreateDefaultReply, _aeDecodeMachMsg, _aeDescToCFStringCopy,
_aeDescToCFTypeCopy, _aeEventToEppcMsg, _aeGetInteractionAllowed,
_aeGetTheCurrentEvent, _aeHintApp, _aeInitializeFromHIToolbox,
_aeInstallBulk, _aeInstallRunLoopDispatcher, _aeInteractWithUser,
_aeMakeMeta, _aeProcessAppleEvent, _aePushHighLevelEvent,
_aeReconstructAppleEvent, _aeReconstructReplyAppleEvent, _aeRemoveFromImplEnd,
_aeResetTimer, _aeResumeTheCurrentEvent, _aeRmvFilter, _aeSend,
_aeSetInteractionAllowed, _aeSetTheCurrentEvent, _aeSimpleMunger,
_aeSuspendTheCurrentEvent, _kAERemoteProcessNameKey, _kAERemoteProcessProcessIDKey,
_kAERemoteProcessURLKey, _kAERemoteProcessUserIDKey, _pushHighLevelEvent,
_vAEBuildAppleEvent, _vAEBuildDesc, _vAEBuildParameters ]
...
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/AE.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/AE.framework/Headers/AE.h | /*
File: AE/AE.h
Contains: Master include for AE private framework
Copyright: � 1999-2008 by Apple Computer, Inc., all rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __AE__
#define __AE__
#ifndef __CARBONCORE__
#include <CarbonCore/CarbonCore.h>
#endif
#ifndef __AEDATAMODEL__
#include <AE/AEDataModel.h>
#endif
#ifndef __APPLEEVENTS__
#include <AE/AppleEvents.h>
#endif
#ifndef __AEPACKOBJECT__
#include <AE/AEPackObject.h>
#endif
#ifndef __AEOBJECTS__
#include <AE/AEObjects.h>
#endif
#ifndef __AEREGISTRY__
#include <AE/AERegistry.h>
#endif
#ifndef __AEUSERTERMTYPES__
#include <AE/AEUserTermTypes.h>
#endif
#ifndef __AEHELPERS__
#include <AE/AEHelpers.h>
#endif
#ifndef __AEMACH__
#include <AE/AEMach.h>
#endif
#endif /* __AE__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/AE.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/AE.framework/Headers/AERegistry.h | /*
File: AE/AERegistry.h
Contains: AppleEvents Registry Interface.
Copyright: � 1993-2008 by Apple Computer, Inc., all rights reserved
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __AEREGISTRY__
#define __AEREGISTRY__
#ifndef __CARBONCORE__
#include <CarbonCore/CarbonCore.h>
#endif
#ifndef __APPLEEVENTS__
#include <AE/AppleEvents.h>
#endif
#include <os/availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#pragma pack(push, 2)
CF_ENUM(OSType) {
cAEList = 'list', /* 0x6c697374 */
cApplication = 'capp', /* 0x63617070 */
cArc = 'carc', /* 0x63617263 */
cBoolean = 'bool', /* 0x626f6f6c */
cCell = 'ccel', /* 0x6363656c */
cChar = 'cha ', /* 0x63686120 */
cColorTable = 'clrt', /* 0x636c7274 */
cColumn = 'ccol', /* 0x63636f6c */
cDocument = 'docu', /* 0x646f6375 */
cDrawingArea = 'cdrw', /* 0x63647277 */
cEnumeration = 'enum', /* 0x656e756d */
cFile = 'file', /* 0x66696c65 */
cFixed = 'fixd', /* 0x66697864 */
cFixedPoint = 'fpnt', /* 0x66706e74 */
cFixedRectangle = 'frct', /* 0x66726374 */
cGraphicLine = 'glin', /* 0x676c696e */
cGraphicObject = 'cgob', /* 0x63676f62 */
cGraphicShape = 'cgsh', /* 0x63677368 */
cGraphicText = 'cgtx', /* 0x63677478 */
cGroupedGraphic = 'cpic' /* 0x63706963 */
};
CF_ENUM(OSType) {
cInsertionLoc = 'insl', /* 0x696e736c */
cInsertionPoint = 'cins', /* 0x63696e73 */
cIntlText = 'itxt', /* 0x69747874 */
cIntlWritingCode = 'intl', /* 0x696e746c */
cItem = 'citm', /* 0x6369746d */
cLine = 'clin', /* 0x636c696e */
cLongDateTime = 'ldt ', /* 0x6c647420 */
cLongFixed = 'lfxd', /* 0x6c667864 */
cLongFixedPoint = 'lfpt', /* 0x6c667074 */
cLongFixedRectangle = 'lfrc', /* 0x6c667263 */
cLongInteger = 'long', /* 0x6c6f6e67 */
cLongPoint = 'lpnt', /* 0x6c706e74 */
cLongRectangle = 'lrct', /* 0x6c726374 */
cMachineLoc = 'mLoc', /* 0x6d4c6f63 */
cMenu = 'cmnu', /* 0x636d6e75 */
cMenuItem = 'cmen', /* 0x636d656e */
cObject = 'cobj', /* 0x636f626a */
cObjectSpecifier = 'obj ', /* 0x6f626a20 */
cOpenableObject = 'coob', /* 0x636f6f62 */
cOval = 'covl' /* 0x636f766c */
};
CF_ENUM(OSType) {
cParagraph = 'cpar', /* 0x63706172 */
cPICT = 'PICT', /* 0x50494354 */
cPixel = 'cpxl', /* 0x6370786c */
cPixelMap = 'cpix', /* 0x63706978 */
cPolygon = 'cpgn', /* 0x6370676e */
cProperty = 'prop', /* 0x70726f70 */
cQDPoint = 'QDpt', /* 0x51447074 */
cQDRectangle = 'qdrt', /* 0x71647274 */
cRectangle = 'crec', /* 0x63726563 */
cRGBColor = 'cRGB', /* 0x63524742 */
cRotation = 'trot', /* 0x74726f74 */
cRoundedRectangle = 'crrc', /* 0x63727263 */
cRow = 'crow', /* 0x63726f77 */
cSelection = 'csel', /* 0x6373656c */
cShortInteger = 'shor', /* 0x73686f72 */
cTable = 'ctbl', /* 0x6374626c */
cText = 'ctxt', /* 0x63747874 */
cTextFlow = 'cflo', /* 0x63666c6f */
cTextStyles = 'tsty', /* 0x74737479 */
cType = 'type' /* 0x74797065 */
};
CF_ENUM(OSType) {
cVersion = 'vers', /* 0x76657273 */
cWindow = 'cwin', /* 0x6377696e */
cWord = 'cwor', /* 0x63776f72 */
enumArrows = 'arro', /* 0x6172726f */
enumJustification = 'just', /* 0x6a757374 */
enumKeyForm = 'kfrm', /* 0x6b66726d */
enumPosition = 'posi', /* 0x706f7369 */
enumProtection = 'prtn', /* 0x7072746e */
enumQuality = 'qual', /* 0x7175616c */
enumSaveOptions = 'savo', /* 0x7361766f */
enumStyle = 'styl', /* 0x7374796c */
enumTransferMode = 'tran', /* 0x7472616e */
kAEAbout = 'abou', /* 0x61626f75 */
kAEAfter = 'afte', /* 0x61667465 */
kAEAliasSelection = 'sali', /* 0x73616c69 */
kAEAllCaps = 'alcp', /* 0x616c6370 */
kAEArrowAtEnd = 'aren', /* 0x6172656e */
kAEArrowAtStart = 'arst', /* 0x61727374 */
kAEArrowBothEnds = 'arbo' /* 0x6172626f */
};
CF_ENUM(OSType) {
kAEAsk = 'ask ', /* 0x61736b20 */
kAEBefore = 'befo', /* 0x6265666f */
kAEBeginning = 'bgng', /* 0x62676e67 */
kAEBeginsWith = 'bgwt', /* 0x62677774 */
kAEBeginTransaction = 'begi', /* 0x62656769 */
kAEBold = 'bold', /* 0x626f6c64 */
kAECaseSensEquals = 'cseq', /* 0x63736571 */
kAECentered = 'cent', /* 0x63656e74 */
kAEChangeView = 'view', /* 0x76696577 */
kAEClone = 'clon', /* 0x636c6f6e */
kAEClose = 'clos', /* 0x636c6f73 */
kAECondensed = 'cond', /* 0x636f6e64 */
kAEContains = 'cont', /* 0x636f6e74 */
kAECopy = 'copy', /* 0x636f7079 */
kAECoreSuite = 'core', /* 0x636f7265 */
kAECountElements = 'cnte', /* 0x636e7465 */
kAECreateElement = 'crel', /* 0x6372656c */
kAECreatePublisher = 'cpub', /* 0x63707562 */
kAECut = 'cut ', /* 0x63757420 */
kAEDelete = 'delo' /* 0x64656c6f */
};
CF_ENUM(OSType) {
kAEDoObjectsExist = 'doex', /* 0x646f6578 */
kAEDoScript = 'dosc', /* 0x646f7363 */
kAEDrag = 'drag', /* 0x64726167 */
kAEDuplicateSelection = 'sdup', /* 0x73647570 */
kAEEditGraphic = 'edit', /* 0x65646974 */
kAEEmptyTrash = 'empt', /* 0x656d7074 */
kAEEnd = 'end ', /* 0x656e6420 */
kAEEndsWith = 'ends', /* 0x656e6473 */
kAEEndTransaction = 'endt', /* 0x656e6474 */
kAEEquals = '= ', /* 0x3d202020 */
kAEExpanded = 'pexp', /* 0x70657870 */
kAEFast = 'fast', /* 0x66617374 */
kAEFinderEvents = 'FNDR', /* 0x464e4452 */
kAEFormulaProtect = 'fpro', /* 0x6670726f */
kAEFullyJustified = 'full', /* 0x66756c6c */
kAEGetClassInfo = 'qobj', /* 0x716f626a */
kAEGetData = 'getd', /* 0x67657464 */
kAEGetDataSize = 'dsiz', /* 0x6473697a */
kAEGetEventInfo = 'gtei', /* 0x67746569 */
kAEGetInfoSelection = 'sinf' /* 0x73696e66 */
};
CF_ENUM(OSType) {
kAEGetPrivilegeSelection = 'sprv', /* 0x73707276 */
kAEGetSuiteInfo = 'gtsi', /* 0x67747369 */
kAEGreaterThan = '> ', /* 0x3e202020 */
kAEGreaterThanEquals = '>= ', /* 0x3e3d2020 */
kAEGrow = 'grow', /* 0x67726f77 */
kAEHidden = 'hidn', /* 0x6869646e */
kAEHiQuality = 'hiqu', /* 0x68697175 */
kAEImageGraphic = 'imgr', /* 0x696d6772 */
kAEIsUniform = 'isun', /* 0x6973756e */
kAEItalic = 'ital', /* 0x6974616c */
kAELeftJustified = 'left', /* 0x6c656674 */
kAELessThan = '< ', /* 0x3c202020 */
kAELessThanEquals = '<= ', /* 0x3c3d2020 */
kAELowercase = 'lowc', /* 0x6c6f7763 */
kAEMakeObjectsVisible = 'mvis', /* 0x6d766973 */
kAEMiscStandards = 'misc', /* 0x6d697363 */
kAEModifiable = 'modf', /* 0x6d6f6466 */
kAEMove = 'move', /* 0x6d6f7665 */
kAENo = 'no ', /* 0x6e6f2020 */
kAENoArrow = 'arno' /* 0x61726e6f */
};
CF_ENUM(OSType) {
kAENonmodifiable = 'nmod', /* 0x6e6d6f64 */
kAEOpen = 'odoc', /* 0x6f646f63 */
kAEOpenSelection = 'sope', /* 0x736f7065 */
kAEOutline = 'outl', /* 0x6f75746c */
kAEPageSetup = 'pgsu', /* 0x70677375 */
kAEPaste = 'past', /* 0x70617374 */
kAEPlain = 'plan', /* 0x706c616e */
kAEPrint = 'pdoc', /* 0x70646f63 */
kAEPrintSelection = 'spri', /* 0x73707269 */
kAEPrintWindow = 'pwin', /* 0x7077696e */
kAEPutAwaySelection = 'sput', /* 0x73707574 */
kAEQDAddOver = 'addo', /* 0x6164646f */
kAEQDAddPin = 'addp', /* 0x61646470 */
kAEQDAdMax = 'admx', /* 0x61646d78 */
kAEQDAdMin = 'admn', /* 0x61646d6e */
kAEQDBic = 'bic ', /* 0x62696320 */
kAEQDBlend = 'blnd', /* 0x626c6e64 */
kAEQDCopy = 'cpy ', /* 0x63707920 */
kAEQDNotBic = 'nbic', /* 0x6e626963 */
kAEQDNotCopy = 'ncpy' /* 0x6e637079 */
};
CF_ENUM(OSType) {
kAEQDNotOr = 'ntor', /* 0x6e746f72 */
kAEQDNotXor = 'nxor', /* 0x6e786f72 */
kAEQDOr = 'or ', /* 0x6f722020 */
kAEQDSubOver = 'subo', /* 0x7375626f */
kAEQDSubPin = 'subp', /* 0x73756270 */
kAEQDSupplementalSuite = 'qdsp', /* 0x71647370 */
kAEQDXor = 'xor ', /* 0x786f7220 */
kAEQuickdrawSuite = 'qdrw', /* 0x71647277 */
kAEQuitAll = 'quia', /* 0x71756961 */
kAERedo = 'redo', /* 0x7265646f */
kAERegular = 'regl', /* 0x7265676c */
kAEReopenApplication = 'rapp', /* 0x72617070 */
kAEReplace = 'rplc', /* 0x72706c63 */
kAERequiredSuite = 'reqd', /* 0x72657164 */
kAERestart = 'rest', /* 0x72657374 */
kAERevealSelection = 'srev', /* 0x73726576 */
kAERevert = 'rvrt', /* 0x72767274 */
kAERightJustified = 'rght', /* 0x72676874 */
kAESave = 'save', /* 0x73617665 */
kAESelect = 'slct', /* 0x736c6374 */
kAESetData = 'setd' /* 0x73657464 */
};
CF_ENUM(OSType) {
kAESetPosition = 'posn', /* 0x706f736e */
kAEShadow = 'shad', /* 0x73686164 */
kAEShowClipboard = 'shcl', /* 0x7368636c */
kAEShutDown = 'shut', /* 0x73687574 */
kAESleep = 'slep', /* 0x736c6570 */
kAESmallCaps = 'smcp', /* 0x736d6370 */
kAESpecialClassProperties = 'c@#!', /* 0x63402321 */
kAEStrikethrough = 'strk', /* 0x7374726b */
kAESubscript = 'sbsc', /* 0x73627363 */
kAESuperscript = 'spsc', /* 0x73707363 */
kAETableSuite = 'tbls', /* 0x74626c73 */
kAETextSuite = 'TEXT', /* 0x54455854 */
kAETransactionTerminated = 'ttrm', /* 0x7474726d */
kAEUnderline = 'undl', /* 0x756e646c */
kAEUndo = 'undo', /* 0x756e646f */
kAEWholeWordEquals = 'wweq', /* 0x77776571 */
kAEYes = 'yes ', /* 0x79657320 */
kAEZoom = 'zoom' /* 0x7a6f6f6d */
};
/* events that can be sent to the "system" process (eg, loginwindow) on OS X 10.2 or later */
CF_ENUM(OSType) {
kAELogOut = 'logo',
kAEReallyLogOut = 'rlgo',
kAEShowRestartDialog = 'rrst',
kAEShowShutdownDialog = 'rsdn'
};
/* EventRecord Classes and EventIDs */
CF_ENUM(OSType) {
kAEMouseClass = 'mous',
kAEDown = 'down',
kAEUp = 'up ',
kAEMoved = 'move',
kAEStoppedMoving = 'stop',
kAEWindowClass = 'wind',
kAEUpdate = 'updt',
kAEActivate = 'actv',
kAEDeactivate = 'dact',
kAECommandClass = 'cmnd', /* Modern Command Event Class */
kAEKeyClass = 'keyc',
kAERawKey = 'rkey', /* Modern Raw Key Event */
kAEVirtualKey = 'keyc', /* Modern Virtual Key Event */
kAENavigationKey = 'nave', /* Modern Navigation Key Event */
kAEAutoDown = 'auto',
kAEApplicationClass = 'appl',
kAESuspend = 'susp',
kAEResume = 'rsme',
kAEDiskEvent = 'disk',
kAENullEvent = 'null',
kAEWakeUpEvent = 'wake',
kAEScrapEvent = 'scrp',
kAEHighLevel = 'high'
};
CF_ENUM(AEKeyword) {
keyAEAngle = 'kang', /* 0x6b616e67 */
keyAEArcAngle = 'parc' /* 0x70617263 */
};
CF_ENUM(AEKeyword) {
keyAEBaseAddr = 'badd', /* 0x62616464 */
keyAEBestType = 'pbst', /* 0x70627374 */
keyAEBgndColor = 'kbcl', /* 0x6b62636c */
keyAEBgndPattern = 'kbpt', /* 0x6b627074 */
keyAEBounds = 'pbnd', /* 0x70626e64 */
keyAECellList = 'kclt', /* 0x6b636c74 */
keyAEClassID = 'clID', /* 0x636c4944 */
keyAEColor = 'colr', /* 0x636f6c72 */
keyAEColorTable = 'cltb', /* 0x636c7462 */
keyAECurveHeight = 'kchd', /* 0x6b636864 */
keyAECurveWidth = 'kcwd', /* 0x6b637764 */
keyAEDashStyle = 'pdst', /* 0x70647374 */
keyAEData = 'data', /* 0x64617461 */
keyAEDefaultType = 'deft', /* 0x64656674 */
keyAEDefinitionRect = 'pdrt', /* 0x70647274 */
keyAEDescType = 'dstp', /* 0x64737470 */
keyAEDestination = 'dest', /* 0x64657374 */
keyAEDoAntiAlias = 'anta', /* 0x616e7461 */
keyAEDoDithered = 'gdit', /* 0x67646974 */
keyAEDoRotate = 'kdrt' /* 0x6b647274 */
};
CF_ENUM(AEKeyword) {
keyAEDoScale = 'ksca', /* 0x6b736361 */
keyAEDoTranslate = 'ktra', /* 0x6b747261 */
keyAEEditionFileLoc = 'eloc', /* 0x656c6f63 */
keyAEElements = 'elms', /* 0x656c6d73 */
keyAEEndPoint = 'pend', /* 0x70656e64 */
keyAEEventClass = 'evcl', /* 0x6576636c */
keyAEEventID = 'evti', /* 0x65767469 */
keyAEFile = 'kfil', /* 0x6b66696c */
keyAEFileType = 'fltp', /* 0x666c7470 */
keyAEFillColor = 'flcl', /* 0x666c636c */
keyAEFillPattern = 'flpt', /* 0x666c7074 */
keyAEFlipHorizontal = 'kfho', /* 0x6b66686f */
keyAEFlipVertical = 'kfvt', /* 0x6b667674 */
keyAEFont = 'font', /* 0x666f6e74 */
keyAEFormula = 'pfor', /* 0x70666f72 */
keyAEGraphicObjects = 'gobs', /* 0x676f6273 */
keyAEID = 'ID ', /* 0x49442020 */
keyAEImageQuality = 'gqua', /* 0x67717561 */
keyAEInsertHere = 'insh', /* 0x696e7368 */
keyAEKeyForms = 'keyf' /* 0x6b657966 */
};
CF_ENUM(AEKeyword) {
keyAEKeyword = 'kywd', /* 0x6b797764 */
keyAELevel = 'levl', /* 0x6c65766c */
keyAELineArrow = 'arro', /* 0x6172726f */
keyAEName = 'pnam', /* 0x706e616d */
keyAENewElementLoc = 'pnel', /* 0x706e656c */
keyAEObject = 'kobj', /* 0x6b6f626a */
keyAEObjectClass = 'kocl', /* 0x6b6f636c */
keyAEOffStyles = 'ofst', /* 0x6f667374 */
keyAEOnStyles = 'onst', /* 0x6f6e7374 */
keyAEParameters = 'prms', /* 0x70726d73 */
keyAEParamFlags = 'pmfg', /* 0x706d6667 */
keyAEPenColor = 'ppcl', /* 0x7070636c */
keyAEPenPattern = 'pppa', /* 0x70707061 */
keyAEPenWidth = 'ppwd', /* 0x70707764 */
keyAEPixelDepth = 'pdpt', /* 0x70647074 */
keyAEPixMapMinus = 'kpmm', /* 0x6b706d6d */
keyAEPMTable = 'kpmt', /* 0x6b706d74 */
keyAEPointList = 'ptlt', /* 0x70746c74 */
keyAEPointSize = 'ptsz', /* 0x7074737a */
keyAEPosition = 'kpos' /* 0x6b706f73 */
};
CF_ENUM(AEKeyword) {
keyAEPropData = 'prdt', /* 0x70726474 */
keyAEProperties = 'qpro', /* 0x7170726f */
keyAEProperty = 'kprp', /* 0x6b707270 */
keyAEPropFlags = 'prfg', /* 0x70726667 */
keyAEPropID = 'prop', /* 0x70726f70 */
keyAEProtection = 'ppro', /* 0x7070726f */
keyAERenderAs = 'kren', /* 0x6b72656e */
keyAERequestedType = 'rtyp', /* 0x72747970 */
keyAEResult = '----', /* 0x2d2d2d2d */
keyAEResultInfo = 'rsin', /* 0x7273696e */
keyAERotation = 'prot', /* 0x70726f74 */
keyAERotPoint = 'krtp', /* 0x6b727470 */
keyAERowList = 'krls', /* 0x6b726c73 */
keyAESaveOptions = 'savo', /* 0x7361766f */
keyAEScale = 'pscl', /* 0x7073636c */
keyAEScriptTag = 'psct', /* 0x70736374 */
keyAESearchText = 'stxt', /* 0x73747874 */
keyAEShowWhere = 'show', /* 0x73686f77 */
keyAEStartAngle = 'pang', /* 0x70616e67 */
keyAEStartPoint = 'pstp', /* 0x70737470 */
keyAEStyles = 'ksty' /* 0x6b737479 */
};
CF_ENUM(AEKeyword) {
keyAESuiteID = 'suit', /* 0x73756974 */
keyAEText = 'ktxt', /* 0x6b747874 */
keyAETextColor = 'ptxc', /* 0x70747863 */
keyAETextFont = 'ptxf', /* 0x70747866 */
keyAETextPointSize = 'ptps', /* 0x70747073 */
keyAETextStyles = 'txst', /* 0x74787374 */
keyAETextLineHeight = 'ktlh', /* type ShortInteger */
keyAETextLineAscent = 'ktas', /* type ShortInteger */
keyAETheText = 'thtx', /* 0x74687478 */
keyAETransferMode = 'pptm', /* 0x7070746d */
keyAETranslation = 'ptrs', /* 0x70747273 */
keyAETryAsStructGraf = 'toog', /* 0x746f6f67 */
keyAEUniformStyles = 'ustl', /* 0x7573746c */
keyAEUpdateOn = 'pupd', /* 0x70757064 */
keyAEUserTerm = 'utrm', /* 0x7574726d */
keyAEWindow = 'wndw', /* 0x776e6477 */
keyAEWritingCode = 'wrcd' /* 0x77726364 */
};
CF_ENUM(AEKeyword) {
keyMiscellaneous = 'fmsc', /* 0x666d7363 */
keySelection = 'fsel', /* 0x6673656c */
keyWindow = 'kwnd', /* 0x6b776e64 */
/* EventRecord keys */
keyWhen = 'when',
keyWhere = 'wher',
keyModifiers = 'mods',
keyKey = 'key ',
keyKeyCode = 'code',
keyKeyboard = 'keyb',
keyDriveNumber = 'drv#',
keyErrorCode = 'err#',
keyHighLevelClass = 'hcls',
keyHighLevelID = 'hid '
};
CF_ENUM(OSType) {
pArcAngle = 'parc', /* 0x70617263 */
pBackgroundColor = 'pbcl', /* 0x7062636c */
pBackgroundPattern = 'pbpt', /* 0x70627074 */
pBestType = 'pbst', /* 0x70627374 */
pBounds = 'pbnd', /* 0x70626e64 */
pClass = 'pcls', /* 0x70636c73 */
pClipboard = 'pcli', /* 0x70636c69 */
pColor = 'colr', /* 0x636f6c72 */
pColorTable = 'cltb', /* 0x636c7462 */
pContents = 'pcnt', /* 0x70636e74 */
pCornerCurveHeight = 'pchd', /* 0x70636864 */
pCornerCurveWidth = 'pcwd', /* 0x70637764 */
pDashStyle = 'pdst', /* 0x70647374 */
pDefaultType = 'deft', /* 0x64656674 */
pDefinitionRect = 'pdrt', /* 0x70647274 */
pEnabled = 'enbl', /* 0x656e626c */
pEndPoint = 'pend', /* 0x70656e64 */
pFillColor = 'flcl', /* 0x666c636c */
pFillPattern = 'flpt', /* 0x666c7074 */
pFont = 'font' /* 0x666f6e74 */
};
CF_ENUM(OSType) {
pFormula = 'pfor', /* 0x70666f72 */
pGraphicObjects = 'gobs', /* 0x676f6273 */
pHasCloseBox = 'hclb', /* 0x68636c62 */
pHasTitleBar = 'ptit', /* 0x70746974 */
pID = 'ID ', /* 0x49442020 */
pIndex = 'pidx', /* 0x70696478 */
pInsertionLoc = 'pins', /* 0x70696e73 */
pIsFloating = 'isfl', /* 0x6973666c */
pIsFrontProcess = 'pisf', /* 0x70697366 */
pIsModal = 'pmod', /* 0x706d6f64 */
pIsModified = 'imod', /* 0x696d6f64 */
pIsResizable = 'prsz', /* 0x7072737a */
pIsStationeryPad = 'pspd', /* 0x70737064 */
pIsZoomable = 'iszm', /* 0x69737a6d */
pIsZoomed = 'pzum', /* 0x707a756d */
pItemNumber = 'itmn', /* 0x69746d6e */
pJustification = 'pjst', /* 0x706a7374 */
pLineArrow = 'arro', /* 0x6172726f */
pMenuID = 'mnid', /* 0x6d6e6964 */
pName = 'pnam' /* 0x706e616d */
};
CF_ENUM(OSType) {
pNewElementLoc = 'pnel', /* 0x706e656c */
pPenColor = 'ppcl', /* 0x7070636c */
pPenPattern = 'pppa', /* 0x70707061 */
pPenWidth = 'ppwd', /* 0x70707764 */
pPixelDepth = 'pdpt', /* 0x70647074 */
pPointList = 'ptlt', /* 0x70746c74 */
pPointSize = 'ptsz', /* 0x7074737a */
pProtection = 'ppro', /* 0x7070726f */
pRotation = 'prot', /* 0x70726f74 */
pScale = 'pscl', /* 0x7073636c */
pScript = 'scpt', /* 0x73637074 */
pScriptTag = 'psct', /* 0x70736374 */
pSelected = 'selc', /* 0x73656c63 */
pSelection = 'sele', /* 0x73656c65 */
pStartAngle = 'pang', /* 0x70616e67 */
pStartPoint = 'pstp', /* 0x70737470 */
pTextColor = 'ptxc', /* 0x70747863 */
pTextFont = 'ptxf', /* 0x70747866 */
pTextItemDelimiters = 'txdl', /* 0x7478646c */
pTextPointSize = 'ptps' /* 0x70747073 */
};
CF_ENUM(OSType) {
pTextStyles = 'txst', /* 0x74787374 */
pTransferMode = 'pptm', /* 0x7070746d */
pTranslation = 'ptrs', /* 0x70747273 */
pUniformStyles = 'ustl', /* 0x7573746c */
pUpdateOn = 'pupd', /* 0x70757064 */
pUserSelection = 'pusl', /* 0x7075736c */
pVersion = 'vers', /* 0x76657273 */
pVisible = 'pvis' /* 0x70766973 */
};
CF_ENUM(DescType) {
typeAEText = 'tTXT', /* 0x74545854 */
typeArc = 'carc', /* 0x63617263 */
typeBest = 'best', /* 0x62657374 */
typeCell = 'ccel', /* 0x6363656c */
typeClassInfo = 'gcli', /* 0x67636c69 */
typeColorTable = 'clrt', /* 0x636c7274 */
typeColumn = 'ccol', /* 0x63636f6c */
typeDashStyle = 'tdas', /* 0x74646173 */
typeData = 'tdta', /* 0x74647461 */
typeDrawingArea = 'cdrw', /* 0x63647277 */
typeElemInfo = 'elin', /* 0x656c696e */
typeEnumeration = 'enum', /* 0x656e756d */
typeEPS = 'EPS ', /* 0x45505320 */
typeEventInfo = 'evin' /* 0x6576696e */
};
CF_ENUM(DescType) {
typeFinderWindow = 'fwin', /* 0x6677696e */
typeFixedPoint = 'fpnt', /* 0x66706e74 */
typeFixedRectangle = 'frct', /* 0x66726374 */
typeGraphicLine = 'glin', /* 0x676c696e */
typeGraphicText = 'cgtx', /* 0x63677478 */
typeGroupedGraphic = 'cpic', /* 0x63706963 */
typeInsertionLoc = 'insl', /* 0x696e736c */
typeIntlText = 'itxt', /* 0x69747874 */
typeIntlWritingCode = 'intl', /* 0x696e746c */
typeLongDateTime = 'ldt ', /* 0x6c647420 */
typeCFAbsoluteTime = 'cfat',
typeISO8601DateTime = 'isot', /* 0x69736f74 data is ascii text of an ISO8601 date */
typeLongFixed = 'lfxd', /* 0x6c667864 */
typeLongFixedPoint = 'lfpt', /* 0x6c667074 */
typeLongFixedRectangle = 'lfrc', /* 0x6c667263 */
typeLongPoint = 'lpnt', /* 0x6c706e74 */
typeLongRectangle = 'lrct', /* 0x6c726374 */
typeMachineLoc = 'mLoc', /* 0x6d4c6f63 */
typeOval = 'covl', /* 0x636f766c */
typeParamInfo = 'pmin', /* 0x706d696e */
typePict = 'PICT' /* 0x50494354 */
};
CF_ENUM(DescType) {
typePixelMap = 'cpix', /* 0x63706978 */
typePixMapMinus = 'tpmm', /* 0x74706d6d */
typePolygon = 'cpgn', /* 0x6370676e */
typePropInfo = 'pinf', /* 0x70696e66 */
typePtr = 'ptr ', /* 0x70747220 */
typeQDPoint = 'QDpt', /* 0x51447074 */
typeQDRegion = 'Qrgn', /* 0x51447074 (data is actual region data, including rectangle and size, _not_ region handle or ptr)*/
typeRectangle = 'crec', /* 0x63726563 */
typeRGB16 = 'tr16', /* 0x74723136 */
typeRGB96 = 'tr96', /* 0x74723936 */
typeRGBColor = 'cRGB', /* 0x63524742 */
typeRotation = 'trot', /* 0x74726f74 */
typeRoundedRectangle = 'crrc', /* 0x63727263 */
typeRow = 'crow', /* 0x63726f77 */
typeScrapStyles = 'styl', /* 0x7374796c */
typeScript = 'scpt', /* 0x73637074 */
typeStyledText = 'STXT', /* 0x53545854 */
typeSuiteInfo = 'suin', /* 0x7375696e */
typeTable = 'ctbl', /* 0x6374626c */
typeTextStyles = 'tsty' /* 0x74737479 */
};
CF_ENUM(DescType) {
typeTIFF = 'TIFF', /* 0x54494646 */
typeJPEG = 'JPEG',
typeGIF = 'GIFf',
typeVersion = 'vers' /* 0x76657273 */
};
CF_ENUM(OSType) {
kAEMenuClass = 'menu',
kAEMenuSelect = 'mhit',
kAEMouseDown = 'mdwn',
kAEMouseDownInBack = 'mdbk',
kAEKeyDown = 'kdwn',
kAEResized = 'rsiz',
kAEPromise = 'prom'
};
CF_ENUM(AEKeyword) {
keyMenuID = 'mid ',
keyMenuItem = 'mitm',
keyCloseAllWindows = 'caw ',
keyOriginalBounds = 'obnd',
keyNewBounds = 'nbnd',
keyLocalWhere = 'lwhr'
};
CF_ENUM(DescType) {
typeHIMenu = 'mobj',
typeHIWindow = 'wobj'
};
CF_ENUM(OSType) {
kAEQuitPreserveState = 'stat', /* in a kAEQuitApplication event, this optional parameter hints the application as to whether it should write out */
/* persistent state which may be restored on the next launch. The possible values are kAENo ( the default ), or kAEYes */
kAEQuitReason = 'why?' /* in a kAEQuitApplication event, this parameter if present is the reason the quit is being sent. The possible values are kAEQuitAll, kAEShutDown, kAERestart, kAEReallyLogOut */
};
enum {
kBySmallIcon = 0,
kByIconView = 1,
kByNameView = 2,
kByDateView = 3,
kBySizeView = 4,
kByKindView = 5,
kByCommentView = 6,
kByLabelView = 7,
kByVersionView = 8
};
enum {
kAEInfo = 11,
kAEMain = 0,
kAESharing = 13
};
enum {
kAEZoomIn = 7,
kAEZoomOut = 8
};
CF_ENUM(OSType) {
kTextServiceClass = 'tsvc',
kUpdateActiveInputArea = 'updt', /* update the active input area */
kShowHideInputWindow = 'shiw', /* show or hide the input window */
kPos2Offset = 'p2st', /* converting global coordinates to char position */
kOffset2Pos = 'st2p', /* converting char position to global coordinates */
kUnicodeNotFromInputMethod = 'unim', /* Unicode text when event not handled by Input Method or no Input Method */
kGetSelectedText = 'gtxt', /* Get text for current selection */
keyAETSMDocumentRefcon = 'refc', /* TSM document refcon, typeLongInteger */
keyAEServerInstance = 'srvi', /* component instance */
keyAETheData = 'kdat', /* typeText */
keyAEFixLength = 'fixl', /* fix len */
keyAEUpdateRange = 'udng', /* typeTextRangeArray */
keyAECurrentPoint = 'cpos', /* current point */
keyAEBufferSize = 'buff', /* buffer size to get the text */
keyAEMoveView = 'mvvw', /* move view flag */
keyAENextBody = 'nxbd', /* next or previous body */
keyAETSMScriptTag = 'sclg',
keyAETSMTextFont = 'ktxf', /* FMFontFamily or FOND ID */
keyAETSMTextFMFont = 'ktxm', /* FMFont */
keyAETSMTextPointSize = 'ktps',
keyAETSMEventRecord = 'tevt', /* Low level Event Record, typeLowLevelEventRecord */
keyAETSMEventRef = 'tevr', /* Carbon EventRef, typeEventRef */
keyAETextServiceEncoding = 'tsen', /* Text Service encoding, mac or Unicode in UpdateActiveInputArea or GetSelectedText events. */
keyAETextServiceMacEncoding = 'tmen', /* Target mac encoding for TSM conversion of text from Unicode text service. */
keyAETSMGlyphInfoArray = 'tgia', /* typeGlyphInfoArray */
typeTextRange = 'txrn', /* TextRange */
typeComponentInstance = 'cmpi', /* server instance */
typeOffsetArray = 'ofay', /* offset array */
typeTextRangeArray = 'tray',
typeLowLevelEventRecord = 'evtr', /* Low Level Event Record */
typeGlyphInfoArray = 'glia', /* Glyph/FMFont info array for sub ranges of Unicode text. See GlyphInfoArray in TextServices.h */
typeEventRef = 'evrf', /* Carbon EventRef */
typeText = typeChar /* Plain text */
};
/* Desc type constants */
enum {
kTSMOutsideOfBody = 1,
kTSMInsideOfBody = 2,
kTSMInsideOfActiveInputArea = 3
};
enum {
kNextBody = 1,
kPreviousBody = 2
};
struct TextRange {
SInt32 fStart;
SInt32 fEnd;
SInt16 fHiliteStyle;
};
typedef struct TextRange TextRange;
typedef TextRange * TextRangePtr;
typedef TextRangePtr * TextRangeHandle;
struct TextRangeArray {
SInt16 fNumOfRanges; /* specify the size of the fRange array */
TextRange fRange[1]; /* when fNumOfRanges > 1, the size of this array has to be calculated */
};
typedef struct TextRangeArray TextRangeArray;
typedef TextRangeArray * TextRangeArrayPtr;
typedef TextRangeArrayPtr * TextRangeArrayHandle;
struct OffsetArray {
SInt16 fNumOfOffsets; /* specify the size of the fOffset array */
SInt32 fOffset[1]; /* when fNumOfOffsets > 1, the size of this array has to be calculated */
};
typedef struct OffsetArray OffsetArray;
typedef OffsetArray * OffsetArrayPtr;
typedef OffsetArrayPtr * OffsetArrayHandle;
struct WritingCode {
ScriptCode theScriptCode;
LangCode theLangCode;
};
typedef struct WritingCode WritingCode;
struct IntlText {
ScriptCode theScriptCode;
LangCode theLangCode;
char theText[1]; /* variable length data */
};
typedef struct IntlText IntlText;
/* Hilite styles */
enum {
kTSMHiliteCaretPosition = 1, /* specify caret position */
kTSMHiliteRawText = 2, /* specify range of raw text */
kTSMHiliteSelectedRawText = 3, /* specify range of selected raw text */
kTSMHiliteConvertedText = 4, /* specify range of converted text */
kTSMHiliteSelectedConvertedText = 5, /* specify range of selected converted text */
kTSMHiliteBlockFillText = 6, /* Block Fill hilite style */
kTSMHiliteOutlineText = 7, /* Outline hilite style */
kTSMHiliteSelectedText = 8, /* Selected hilite style */
kTSMHiliteNoHilite = 9 /* specify range of non-hilited text */
};
#if OLDROUTINENAMES
/* Hilite styles */
enum {
kCaretPosition = kTSMHiliteCaretPosition,
kRawText = kTSMHiliteRawText,
kSelectedRawText = kTSMHiliteSelectedRawText,
kConvertedText = kTSMHiliteConvertedText,
kSelectedConvertedText = kTSMHiliteSelectedConvertedText,
kBlockFillText = kTSMHiliteBlockFillText,
kOutlineText = kTSMHiliteOutlineText,
kSelectedText = kTSMHiliteSelectedText
};
#endif /* OLDROUTINENAMES */
CF_ENUM(AEKeyword) {
keyAEHiliteRange = 'hrng', /* typeTextRangeArray for System 7, typeHiliteRangeArray for System 8 */
keyAEPinRange = 'pnrg', /* typeTextRange for System 7, typeTextRegionRange for System 8 */
keyAEClauseOffsets = 'clau', /* typeOffsetArray for System 7, typeClauseOffsetArray for System 8 */
keyAEOffset = 'ofst', /* typeLongInteger for System 7, typeByteOffset for System 8 */
keyAEPoint = 'gpos', /* typePoint for System 7, typeQDPoint for System 8 */
keyAELeftSide = 'klef', /* typeBoolean */
keyAERegionClass = 'rgnc', /* typeShortInteger for System 7, typeRegionClass for System 8 */
keyAEDragging = 'bool' /* typeBoolean */
};
#if OLDROUTINENAMES
enum {
keyAELeadingEdge = keyAELeftSide
};
#endif /* OLDROUTINENAMES */
CF_ENUM(DescType) {
/* AppleScript 1.3: Unit types */
typeMeters = 'metr', /* Base Unit */
typeInches = 'inch',
typeFeet = 'feet',
typeYards = 'yard',
typeMiles = 'mile',
typeKilometers = 'kmtr',
typeCentimeters = 'cmtr',
typeSquareMeters = 'sqrm', /* Base Unit */
typeSquareFeet = 'sqft',
typeSquareYards = 'sqyd',
typeSquareMiles = 'sqmi',
typeSquareKilometers = 'sqkm',
typeLiters = 'litr', /* Base Unit */
typeQuarts = 'qrts',
typeGallons = 'galn',
typeCubicMeters = 'cmet', /* Base Unit */
typeCubicFeet = 'cfet',
typeCubicInches = 'cuin',
typeCubicCentimeter = 'ccmt',
typeCubicYards = 'cyrd',
typeKilograms = 'kgrm', /* Base Unit */
typeGrams = 'gram',
typeOunces = 'ozs ',
typePounds = 'lbs ',
typeDegreesC = 'degc', /* Base Unit */
typeDegreesF = 'degf',
typeDegreesK = 'degk'
};
CF_ENUM(OSType) {
/* AppleScript 1.3: Folder Actions */
kFAServerApp = 'ssrv', /* Creator code for Folder Actions Server*/
kDoFolderActionEvent = 'fola', /* Event the Finder sends to the Folder Actions FBA*/
kFolderActionCode = 'actn', /* Parameter that contains the Folder Action*/
kFolderOpenedEvent = 'fopn', /* Value of kFolderActionCode parameter; sent to script as event*/
kFolderClosedEvent = 'fclo',
kFolderWindowMovedEvent = 'fsiz',
kFolderItemsAddedEvent = 'fget',
kFolderItemsRemovedEvent = 'flos',
kItemList = 'flst', /* List parameter for added and removed items*/
kNewSizeParameter = 'fnsz', /* Parameter for moved window*/
kFASuiteCode = 'faco', /* Suite code for the following events*/
kFAAttachCommand = 'atfa', /* Attach event id*/
kFARemoveCommand = 'rmfa', /* Remove event id*/
kFAEditCommand = 'edfa', /* Edit event id*/
kFAFileParam = 'faal', /* Key for file parameter for Attach*/
kFAIndexParam = 'indx' /* Key for index (0-based) parameter for Remove and Edit*/
};
/* AppleScript 1.3 Internet Suite */
CF_ENUM(OSType) {
/* Suite code */
kAEInternetSuite = 'gurl',
kAEISWebStarSuite = 0x575757BD
};
CF_ENUM(OSType) {
/* Events */
kAEISGetURL = 'gurl',
KAEISHandleCGI = 'sdoc'
};
CF_ENUM(OSType) {
/* Classes */
cURL = 'url ',
cInternetAddress = 'IPAD',
cHTML = 'html',
cFTPItem = 'ftp '
};
CF_ENUM(OSType) {
/* Parameters */
kAEISHTTPSearchArgs = 'kfor',
kAEISPostArgs = 'post',
kAEISMethod = 'meth',
kAEISClientAddress = 'addr',
kAEISUserName = 'user',
kAEISPassword = 'pass',
kAEISFromUser = 'frmu',
kAEISServerName = 'svnm',
kAEISServerPort = 'svpt',
kAEISScriptName = 'scnm',
kAEISContentType = 'ctyp',
kAEISReferrer = 'refr',
kAEISUserAgent = 'Agnt',
kAEISAction = 'Kact',
kAEISActionPath = 'Kapt',
kAEISClientIP = 'Kcip',
kAEISFullRequest = 'Kfrq'
};
CF_ENUM(OSType) {
/* Properties */
pScheme = 'pusc',
pHost = 'HOST',
pPath = 'FTPc',
pUserName = 'RAun',
pUserPassword = 'RApw',
pDNSForm = 'pDNS',
pURL = 'pURL',
pTextEncoding = 'ptxe',
pFTPKind = 'kind'
};
CF_ENUM(OSType) {
/* Scheme enumerations */
eScheme = 'esch',
eurlHTTP = 'http', /* RFC 2068 */
eurlHTTPS = 'htps',
eurlFTP = 'ftp ', /* RFC 1738 */
eurlMail = 'mail', /* RFC 2638 */
eurlFile = 'file', /* RFC 1738 */
eurlGopher = 'gphr', /* RFC 1738 */
eurlTelnet = 'tlnt', /* RFC 1738 */
eurlNews = 'news', /* RFC 1738 */
eurlSNews = 'snws',
eurlNNTP = 'nntp', /* RFC 1738 */
eurlMessage = 'mess',
eurlMailbox = 'mbox',
eurlMulti = 'mult',
eurlLaunch = 'laun',
eurlAFP = 'afp ',
eurlAT = 'at ',
eurlEPPC = 'eppc',
eurlRTSP = 'rtsp', /* RFC 2326 */
eurlIMAP = 'imap', /* RFC 2192 */
eurlNFS = 'unfs', /* RFC 2224 */
eurlPOP = 'upop', /* RFC 2384 */
eurlLDAP = 'uldp', /* RFC 2255 */
eurlUnknown = 'url?'
};
CF_ENUM(OSType) {
/* AppleScript 1.3: Connectivity Suite in aeut */
kConnSuite = 'macc',
cDevSpec = 'cdev',
cAddressSpec = 'cadr',
cADBAddress = 'cadb',
cAppleTalkAddress = 'cat ',
cBusAddress = 'cbus',
cEthernetAddress = 'cen ',
cFireWireAddress = 'cfw ',
cIPAddress = 'cip ',
cLocalTalkAddress = 'clt ',
cSCSIAddress = 'cscs',
cTokenRingAddress = 'ctok',
cUSBAddress = 'cusb', /* */
/* Properties */
pDeviceType = 'pdvt',
pDeviceAddress = 'pdva',
pConduit = 'pcon',
pProtocol = 'pprt', /* cde 4/27/98 was 'ppro' conflicted with DB suite */
pATMachine = 'patm',
pATZone = 'patz',
pATType = 'patt',
pDottedDecimal = 'pipd',
pDNS = 'pdns',
pPort = 'ppor',
pNetwork = 'pnet',
pNode = 'pnod',
pSocket = 'psoc',
pSCSIBus = 'pscb',
pSCSILUN = 'pslu', /* cde 5/22/98 per WWDC developer request */
/* Enumerations and enumerators */
eDeviceType = 'edvt',
eAddressSpec = 'eads',
eConduit = 'econ',
eProtocol = 'epro',
eADB = 'eadb',
eAnalogAudio = 'epau',
eAppleTalk = 'epat',
eAudioLineIn = 'ecai',
eAudioLineOut = 'ecal', /* cde 4/24/98 changed from 'ecao' to not conflict */
eAudioOut = 'ecao',
eBus = 'ebus',
eCDROM = 'ecd ',
eCommSlot = 'eccm',
eDigitalAudio = 'epda',
eDisplay = 'edds',
eDVD = 'edvd',
eEthernet = 'ecen',
eFireWire = 'ecfw',
eFloppy = 'efd ',
eHD = 'ehd ',
eInfrared = 'ecir',
eIP = 'epip',
eIrDA = 'epir',
eIRTalk = 'epit',
eKeyboard = 'ekbd',
eLCD = 'edlc',
eLocalTalk = 'eclt',
eMacIP = 'epmi',
eMacVideo = 'epmv',
eMicrophone = 'ecmi',
eModemPort = 'ecmp',
eModemPrinterPort = 'empp',
eModem = 'edmm',
eMonitorOut = 'ecmn',
eMouse = 'emou',
eNuBusCard = 'ednb',
eNuBus = 'enub',
ePCcard = 'ecpc',
ePCIbus = 'ecpi',
ePCIcard = 'edpi',
ePDSslot = 'ecpd',
ePDScard = 'epds',
ePointingDevice = 'edpd',
ePostScript = 'epps',
ePPP = 'eppp',
ePrinterPort = 'ecpp',
ePrinter = 'edpr',
eSvideo = 'epsv',
eSCSI = 'ecsc',
eSerial = 'epsr',
eSpeakers = 'edsp',
eStorageDevice = 'edst',
eSVGA = 'epsg',
eTokenRing = 'etok',
eTrackball = 'etrk',
eTrackpad = 'edtp',
eUSB = 'ecus',
eVideoIn = 'ecvi',
eVideoMonitor = 'edvm',
eVideoOut = 'ecvo'
};
CF_ENUM(OSType) {
/* AppleScript 1.3: Keystroke class */
cKeystroke = 'kprs',
pKeystrokeKey = 'kMsg',
pModifiers = 'kMod',
pKeyKind = 'kknd',
eModifiers = 'eMds',
eOptionDown = 'Kopt',
eCommandDown = 'Kcmd',
eControlDown = 'Kctl',
eShiftDown = 'Ksft',
eCapsLockDown = 'Kclk',
eKeyKind = 'ekst', /* */
/* Special keys all start with 'ks' */
eEscapeKey = 0x6B733500, /* Third byte is virtual key code byte */
eDeleteKey = 0x6B733300, /* (see IM Mac Toolbox Essentials, pp. 2-43) */
eTabKey = 0x6B733000,
eReturnKey = 0x6B732400,
eClearKey = 0x6B734700,
eEnterKey = 0x6B734C00,
eUpArrowKey = 0x6B737E00,
eDownArrowKey = 0x6B737D00,
eLeftArrowKey = 0x6B737B00,
eRightArrowKey = 0x6B737C00,
eHelpKey = 0x6B737200,
eHomeKey = 0x6B737300,
ePageUpKey = 0x6B737400,
ePageDownKey = 0x6B737900,
eForwardDelKey = 0x6B737500,
eEndKey = 0x6B737700,
eF1Key = 0x6B737A00,
eF2Key = 0x6B737800,
eF3Key = 0x6B736300,
eF4Key = 0x6B737600,
eF5Key = 0x6B736000,
eF6Key = 0x6B736100,
eF7Key = 0x6B736200,
eF8Key = 0x6B736400,
eF9Key = 0x6B736500,
eF10Key = 0x6B736D00,
eF11Key = 0x6B736700,
eF12Key = 0x6B736F00,
eF13Key = 0x6B736900,
eF14Key = 0x6B736B00,
eF15Key = 0x6B737100
};
CF_ENUM(AEKeyword) {
keyAELaunchedAsLogInItem = 'lgit', /* If present in a kAEOpenApplication event, application was launched as a login item and probably shouldn't open up untitled documents, etc. Mac OS X 10.4 and later. */
keyAELaunchedAsServiceItem = 'svit' /* If present in a kAEOpenApplication event, application was launched as a service item and probably shouldn't open up untitled documents, etc. Mac OS X 10.4 and later. */
};
#pragma pack(pop)
#endif /* __AEREGISTRY__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/AE.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/AE.framework/Headers/AEMach.h | /*
File: AE/AEMach.h
Contains: AppleEvent over mach_msg interfaces
Copyright: � 2000-2008 by Apple Computer, Inc., all rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __AEMACH__
#define __AEMACH__
#ifndef __CARBONCORE__
#include <CarbonCore/CarbonCore.h>
#endif
#ifndef __AEDATAMODEL__
#include <AE/AEDataModel.h>
#endif
#if TARGET_RT_MAC_MACHO
#ifdef __cplusplus
extern "C" {
#endif
#include <mach/message.h>
#ifdef __cplusplus
}
#endif
#endif
#include <os/availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
/*-
* AE Mach API --
*
* AppleEvents on OS X are implemented in terms of mach messages.
* To facilitate writing server processes that can send and receive
* AppleEvents, the following APIs are provided.
*
* AppleEvents are directed to a well known port uniquely tied to a
* process. The AE framework will discover this port based on the
* keyAddressAttr of the event (as specifed in AECreateAppleEvent by
* the target parameter.) If a port cannot be found,
* procNotFound (-600) will be returned on AESend.
*
* Of note is a new attribute for an AppleEvent, keyReplyPortAttr.
* This specifies the mach_port_t to which an AppleEvent reply
* should be directed. By default, replies are sent to the
* processes' registered port where they are culled from the normal
* event stream if there is an outstanding AESend + kAEWaitReply.
* But it may be desirable for a client to specify their own port to
* receive queud replies.
*
* In the case of AESendMessage with kAEWaitReply specified, an
* anonymous port will be used to block until the reply is received.
*
* Not supplied is a convenience routine to block a server and
* process AppleEvents. This implementation will be detailed in a
* tech note.
*
* In general, the AppleEvent APIs are thread safe, but the mechanism
* of their delivery (AEProcessAppleEvent, AEResumeTheCurrentEvent)
* are not. If you're attemping to write a thread safe server, you
* should avoid AppleEvent routines that don't explicitly state their
* thread safety.
*
**/
CF_ENUM(AEKeyword) {
keyReplyPortAttr = 'repp'
};
/* typeReplyPortAttr was misnamed and is deprecated; use keyReplyPortAttr instead. */
CF_ENUM(DescType) {
typeReplyPortAttr = keyReplyPortAttr
};
/*
* AEGetRegisteredMachPort()
*
* Discussion:
* Return the mach_port_t that was registered by the AppleEvent
* framework for this process. This port is considered public, and
* will be used by other applications to target your process. You
* are free to use this mach_port_t to add to a port set, if and
* only if, you are not also using routines from HIToolbox. In that
* case, HIToolbox retains control of this port and AppleEvents are
* dispatched through the main event loop.
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: not available in CarbonLib 1.x, is available on Mac OS X version 10.0 and later
* Non-Carbon CFM: not available
*/
extern mach_port_t
AEGetRegisteredMachPort(void) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AEDecodeMessage()
*
* Discussion:
* Decode a mach_msg into an AppleEvent and its related reply. (The
* reply is set up from fields of the event.) You can call this
* routine if you wish to dispatch or handle the event yourself. To
* return a reply to the sender, you should call:
* AESendMessage(reply, NULL, kAENoReply, kAENormalPriority,
* kAEDefaultTimeout);
* If this message is a reply, the 'reply' parameter will be
* initialized to { typeNull, 0 }, and the 'event' parameter will be
* the AppleEvent reply with a event class attribute of
* typeAppleEvent, class typeAppleEventReply:
* The contents of the header are invalid after this call.
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Parameters:
*
* header:
* The incoming mach message to be dispatched
*
* event:
* The AppleEvent to decode the message in header into
*
* reply:
* The AppleEvent reply is decoded into reply
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: not available in CarbonLib 1.x, is available on Mac OS X version 10.0 and later
* Non-Carbon CFM: not available
*/
extern OSStatus
AEDecodeMessage(
mach_msg_header_t * header,
AppleEvent * event,
AppleEvent * reply) /* can be NULL */ API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AEProcessMessage()
*
* Discussion:
* Decodes and dispatches an event to an event handler. Handles
* packaging and returning the reply to the sender.
* The contents of the header are invalid after this call.
*
* Mac OS X threading:
* Not thread safe since version 10.3
*
* Parameters:
*
* header:
* The incoming mach message to be dispatched.
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: not available in CarbonLib 1.x, is available on Mac OS X version 10.0 and later
* Non-Carbon CFM: not available
*/
extern OSStatus
AEProcessMessage(mach_msg_header_t * header) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AESendMessage()
*
* Discussion:
* Send an AppleEvent to a target process. If the target is the
* current process (as specified by using typeProcessSerialNumber of
* { 0, kCurrentProcess } it is dispatched directly to the
* appropriate event handler in your process and not serialized.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* event:
* The event to be sent
*
* reply:
* The reply for the event, if non-NULL
*
* sendMode:
* The mode to send the event
*
* timeOutInTicks:
* The timeout for sending the event, in ticks. If 0, there is no
* timeout.
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: not available in CarbonLib 1.x, is available on Mac OS X version 10.0 and later
* Non-Carbon CFM: not available
*/
extern OSStatus
AESendMessage(
const AppleEvent * event,
AppleEvent * reply, /* can be NULL */
AESendMode sendMode,
long timeOutInTicks) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
#ifdef __cplusplus
}
#endif
#endif /* __AEMACH__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/AE.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/AE.framework/Headers/AppleEvents.h | /*
File: AE/AppleEvents.h
Contains: AppleEvent Package Interfaces.
Copyright: � 1989-2008 by Apple Computer, Inc., all rights reserved
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __APPLEEVENTS__
#define __APPLEEVENTS__
#ifndef __COREFOUNDATION__
#include <CoreFoundation/CoreFoundation.h>
#endif
#ifndef __CARBONCORE__
#include <CarbonCore/CarbonCore.h>
#endif
/*
Note: The functions and types for the building and parsing AppleEvent
messages has moved to AEDataModel.h
*/
#ifndef __AEDATAMODEL__
#include <AE/AEDataModel.h>
#endif
#include <os/availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
#pragma pack(push, 2)
CF_ENUM(AEKeyword) {
/* Keywords for Apple event parameters */
keyDirectObject = '----',
keyErrorNumber = 'errn',
keyErrorString = 'errs',
keyProcessSerialNumber = 'psn ', /* Keywords for special handlers */
keyPreDispatch = 'phac', /* preHandler accessor call */
keySelectProc = 'selh', /* more selector call */
/* Keyword for recording */
keyAERecorderCount = 'recr', /* available only in vers 1.0.1 and greater */
/* Keyword for version information */
keyAEVersion = 'vers' /* available only in vers 1.0.1 and greater */
};
/* Event Class */
CF_ENUM(DescType) {
kCoreEventClass = 'aevt'
};
/* Event ID's */
CF_ENUM(AEEventID) {
kAEOpenApplication = 'oapp',
kAEOpenDocuments = 'odoc',
kAEPrintDocuments = 'pdoc',
kAEOpenContents = 'ocon',
kAEQuitApplication = 'quit', /* may include a property kAEQuitReason indicating what lead to the quit being sent. */
kAEAnswer = 'ansr',
kAEApplicationDied = 'obit',
kAEShowPreferences = 'pref' /* sent by Mac OS X when the user chooses the Preferences item */
};
/* Constants for recording */
CF_ENUM(AEEventID) {
kAEStartRecording = 'reca', /* available only in vers 1.0.1 and greater */
kAEStopRecording = 'recc', /* available only in vers 1.0.1 and greater */
kAENotifyStartRecording = 'rec1', /* available only in vers 1.0.1 and greater */
kAENotifyStopRecording = 'rec0', /* available only in vers 1.0.1 and greater */
kAENotifyRecording = 'recr' /* available only in vers 1.0.1 and greater */
};
/**
* AEEventSource is defined as an SInt8 for compatability with pascal.
* Important note: keyEventSourceAttr is returned by AttributePtr as a typeShortInteger.
* Be sure to pass at least two bytes of storage to AEGetAttributePtr - the result can be
* compared directly against the following enums.
*/
typedef SInt8 AEEventSource;
enum {
kAEUnknownSource = 0,
kAEDirectCall = 1,
kAESameProcess = 2,
kAELocalProcess = 3,
kAERemoteProcess = 4
};
#if __MAC_OS_X_VERSION_MIN_REQUIRED >= 1080
enum {
errAETargetAddressNotPermitted = -1742, /* Mac OS X 10.8 and later, the target of an AppleEvent is not accessible to this process, perhaps due to sandboxing */
errAEEventNotPermitted = -1743, /* Mac OS X 10.8 and later, the target of the AppleEvent does not allow this sender to execute this event */
};
#endif
/**************************************************************************
These calls are used to set up and modify the event dispatch table.D
**************************************************************************/
/*
* AEInstallEventHandler()
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
AEInstallEventHandler(
AEEventClass theAEEventClass,
AEEventID theAEEventID,
AEEventHandlerUPP handler,
SRefCon handlerRefcon,
Boolean isSysHandler) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AERemoveEventHandler()
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
AERemoveEventHandler(
AEEventClass theAEEventClass,
AEEventID theAEEventID,
AEEventHandlerUPP handler,
Boolean isSysHandler) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AEGetEventHandler()
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
AEGetEventHandler(
AEEventClass theAEEventClass,
AEEventID theAEEventID,
AEEventHandlerUPP * handler,
SRefCon * handlerRefcon,
Boolean isSysHandler) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/**************************************************************************
These calls are used to set up and modify special hooks into the
AppleEvent manager.
**************************************************************************/
/*
* AEInstallSpecialHandler()
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
AEInstallSpecialHandler(
AEKeyword functionClass,
AEEventHandlerUPP handler,
Boolean isSysHandler) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AERemoveSpecialHandler()
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
AERemoveSpecialHandler(
AEKeyword functionClass,
AEEventHandlerUPP handler,
Boolean isSysHandler) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AEGetSpecialHandler()
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
AEGetSpecialHandler(
AEKeyword functionClass,
AEEventHandlerUPP * handler,
Boolean isSysHandler) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/**************************************************************************
This call was added in version 1.0.1. If called with the keyword
keyAERecorderCount ('recr'), the number of recorders that are
currently active is returned in 'result'
(available only in vers 1.0.1 and greater).
**************************************************************************/
/*
* AEManagerInfo()
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
AEManagerInfo(
AEKeyword keyWord,
long * result) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
AERemoteProcessResolver:
These calls subsume the functionality of using the PPCToolbox on Mac
OS 9 to locate processes on remote computers. (PPCToolbox is not
part of Carbon.) These calls are supported on Mac OS X 10.3 or
later.
The model is to create a resolver for a particular URL and schedule
it on a CFRunLoop to retrieve the results asynchronously. If
synchronous behavior is desired, just call
AERemoteProcessResolverGetProcesses to get the array; the call will
block until the request is completed.
A resolver can only be used once; once it has fetched the data or
gotten an error it can no longer be scheduled.
The data obtained from the resolver is a CFArrayRef of
CFDictionaryRef objects. Each dictionary contains the URL of the
remote application and its human readable name.
*/
/*
* kAERemoteProcessURLKey
*
* Discussion:
* the full URL to this application, a CFURLRef.
*
* Availability:
* Mac OS X: in version 10.3 and later in ApplicationServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern const CFStringRef kAERemoteProcessURLKey API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* kAERemoteProcessNameKey
*
* Discussion:
* the visible name to this application, in the localization
* supplied by the server, a CFStringRef.
*
* Availability:
* Mac OS X: in version 10.3 and later in ApplicationServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern const CFStringRef kAERemoteProcessNameKey API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* kAERemoteProcessUserIDKey
*
* Discussion:
* the userid of this application, if available. If present, a
* CFNumberRef.
*
* Availability:
* Mac OS X: in version 10.3 and later in ApplicationServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern const CFStringRef kAERemoteProcessUserIDKey API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* kAERemoteProcessProcessIDKey
*
* Discussion:
* the process id of this application, if available. If present, a
* CFNumberRef.
*
* Availability:
* Mac OS X: in version 10.3 and later in ApplicationServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern const CFStringRef kAERemoteProcessProcessIDKey API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AERemoteProcessResolverContext
*
* Discussion:
* An optional context parameter for asynchronous resolution. The
* context is copied and the info pointer retained. When the
* callback is made, the info pointer is passed to the callback.
*/
struct AERemoteProcessResolverContext {
/*
* set to zero (0)
*/
CFIndex version;
/*
* info pointer to be passed to the callback
*/
void * info;
/*
* callback made on the info pointer. This field may be NULL.
*/
CFAllocatorRetainCallBack retain;
/*
* callback made on the info pointer. This field may be NULL.
*/
CFAllocatorReleaseCallBack release;
/*
* callback made on the info pointer. This field may be NULL.
*/
CFAllocatorCopyDescriptionCallBack copyDescription;
};
typedef struct AERemoteProcessResolverContext AERemoteProcessResolverContext;
/*
* AERemoteProcessResolverRef
*
* Discussion:
* An opaque reference to an object that encapsulates the mechnanism
* by which a list of processes running on a remote machine are
* obtained. Created by AECreateRemoteProcessResolver, and must be
* disposed of by AEDisposeRemoteProcessResolver. A
* AERemoteProcessResolverRef is not a CFType.
*/
typedef struct AERemoteProcessResolver* AERemoteProcessResolverRef;
/*
* AECreateRemoteProcessResolver()
*
* Discussion:
* Create a Remote Process List Resolver object. The allocator is
* used for any CoreFoundation types created or returned by this
* API. The resulting object can be scheduled on a run loop, or
* queried synchronously. Once the object has retreived results
* from the server, or got an error doing so, it will not re-fetch
* the data. To retrieve a new list of processes, create a new
* instance of this object.
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Parameters:
*
* allocator:
* a CFAllocatorRef to use when creating CFTypes
*
* url:
* a CFURL identifying the remote host and port.
*
* Result:
* a AECreateRemoteProcessResolverRef, which must be disposed of
* with AEDisposeRemoteProcessResolver.
*
* Availability:
* Mac OS X: in version 10.3 and later in ApplicationServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern AERemoteProcessResolverRef
AECreateRemoteProcessResolver(
CFAllocatorRef allocator,
CFURLRef url) API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AEDisposeRemoteProcessResolver()
*
* Discussion:
* Disposes of a AERemoteProcessResolverRef. If this resolver is
* currently scheduled on a run loop, it is unscheduled. In this
* case, the asynchronous callback will not be executed.
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Parameters:
*
* ref:
* The AERemoteProcessResolverRef to dispose
*
* Availability:
* Mac OS X: in version 10.3 and later in ApplicationServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
AEDisposeRemoteProcessResolver(AERemoteProcessResolverRef ref) API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AERemoteProcessResolverGetProcesses()
*
* Discussion:
* Returns a CFArrayRef containing CFDictionary objects containing
* information about processses running on a remote machine. If the
* result array is NULL, the query failed and the error out
* parameter will contain information about the failure. If the
* resolver had not been previously scheduled for execution, this
* call will block until the resulting array is available or an
* error occurs. If the resolver had been scheduled but had not yet
* completed fetching the array, this call will block until the
* resolver does complete. The array returned is owned by the
* resolver, so callers must retain it before disposing of the
* resolver object itself.
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Parameters:
*
* ref:
* The AERemoteProcessResolverRef to query
*
* outError:
* If the result is NULL, outError will contain a CFStreamError
* with information about the type of failure
*
* Result:
* a CFArray of CFDictionary objects containing information about
* the remote applications.
*
* Availability:
* Mac OS X: in version 10.3 and later in ApplicationServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFArrayRef
AERemoteProcessResolverGetProcesses(
AERemoteProcessResolverRef ref,
CFStreamError * outError) API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AERemoteProcessResolverCallback
*
* Discussion:
* A callback made when the asynchronous execution of a resolver
* completes, either due to success or failure. The data itself
* should be obtained with AERemoteProcessResolverGetProcesses.
*/
typedef CALLBACK_API( void , AERemoteProcessResolverCallback )(AERemoteProcessResolverRef ref, void *info);
/*
* AERemoteProcessResolverScheduleWithRunLoop()
*
* Discussion:
* Schedules a resolver for execution on a given runloop in a given
* mode. The resolver will move through various internal states as
* long as the specified run loop is run. When the resolver
* completes, either with success or an error condition, the
* callback is executed. There is no explicit unschedule of the
* resolver; you must dispose of it to remove it from the run loop.
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Parameters:
*
* ref:
* The AERemoteProcessResolverRef to scheduile
*
* runLoop:
* a CFRunLoop
*
* runLoopMode:
* a CFString specifying the run loop mode
*
* callback:
* a callback to be executed when the reolver completes
*
* ctx:
* a AERemoteProcessResolverContext. If this parameter is not
* NULL, the info field of this structure will be passed to the
* callback (otherwise, the callback info parameter will
* explicitly be NULL.)
*
* Availability:
* Mac OS X: in version 10.3 and later in ApplicationServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
AERemoteProcessResolverScheduleWithRunLoop(
AERemoteProcessResolverRef ref,
CFRunLoopRef runLoop,
CFStringRef runLoopMode,
AERemoteProcessResolverCallback callback,
const AERemoteProcessResolverContext * ctx) /* can be NULL */ API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( ios, tvos, watchos );
/**
Determines whether the current application is able to send an AppleEvent with the given eventClass and eventID to the application described as targetAddressDesc.
Mac OS 10.14 and later impose additional requirements on applications when they send AppleEvents to other applications in order
to insure that users are aware of and consent to allowing such control or information exchange. Generally this involves
the user being prompted in a secure fashion the first time an application attempts to send an AppleEvent to another application.
If the user consents then this application can send events to the target. If the user does not consent then any future
attempts to send AppleEvents will result in a failure with errAEEventNotPermitted being returned.
Certain AppleEvents are allowed to be sent without prompting the user. Pass typeWildCard for the eventClass and eventID
to determine if every event is allowed to be sent from this application to the target.
Applications can determine, without sending an AppleEvent to a target application, whether they are allowed to send AppleEvents
to the target with this function. If askUserIfNeeded is true, and this application does not yet have permission to send
AppleEvents to the target, then the user will be asked if permission can be granted; if askUserIfNeeded is false and permission
has not been granted, then errAEEventWouldRequireUserConsent will be returned.
The target AEAddressDesc must refer to an already running application.
@subsection macOS Threading
Thread safe since version 10.14. Do not call this function on your main thread because it may take arbitrarily long
to return if the user needs to be prompted for consent.
@param target
A pointer to an address descriptor. Before calling AEDeterminePermissionToAutomateTarget, you set the descriptor to identify
the target application for the Apple event. The target address descriptor must refer to a running application. If
the target application is on another machine, then Remote AppleEvents must be enabled on that machine for the user.
@param theAEEventClass
The event class of the Apple event to determine permission for.
@param theAEEventID
The event ID of the Apple event to determine permission for.
@param askUserIfNeeded
a Boolean; if true, and if this application does not yet have permission to send events to the target application, then
prompt the user to obtain permission. If false, do not prompt the user.
@returns If the current application is permitted to send the given AppleEvent to the target, then noErr will be returned. If the
current application is not permitted to send the event, errAEEventNotPermitted will be returned. If the target application
is not running, then procNotFound will be returned. If askUserIfNeeded is false, and this application is not yet permitted
to send AppleEvents to the target, then errAEEventWouldRequireUserConsent will be returned.
*/
extern OSStatus AEDeterminePermissionToAutomateTarget( const AEAddressDesc* target, AEEventClass theAEEventClass, AEEventID theAEEventID, Boolean askUserIfNeeded ) API_AVAILABLE( macos(10.14) ) API_UNAVAILABLE( ios, tvos, watchos );
#if defined(__MAC_10_14) && __MAC_OS_X_VERSION_MIN_REQUIRED >= __MAC_10_14
enum {
errAEEventWouldRequireUserConsent = -1744, ///< Determining whether this can be sent would require prompting the user, and the AppleEvent was sent with kAEDoNotPromptForPermission
};
/*
* AESendMode flag
*
* In AESend(), when sending an AppleEvent, if this is masked into AESendMode and if the AppleEvent would require user consent, then AESend() will return errAEEventWouldRequireUserConsent.
*
*/
enum {
kAEDoNotPromptForUserConsent = 0x00020000, /* If set, and the AppleEvent requires user consent, do not prompt and instead return errAEEventWouldRequireUserConsent */
};
#endif
#pragma pack(pop)
#ifdef __cplusplus
}
#endif
#endif /* __APPLEEVENTS__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/AE.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/AE.framework/Headers/AEPackObject.h | /*
File: AE/AEPackObject.h
Contains: AppleEvents object packing Interfaces.
Copyright: � 1991-2008 by Apple Computer, Inc., all rights reserved
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __AEPACKOBJECT__
#define __AEPACKOBJECT__
#ifndef __APPLEEVENTS__
#include <AE/AppleEvents.h>
#endif
#include <os/availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
/* These are the object packing routines. */
/*
* CreateOffsetDescriptor()
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in ObjectSupportLib 1.0 and later
*/
extern OSErr
CreateOffsetDescriptor(
long theOffset,
AEDesc * theDescriptor) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* CreateCompDescriptor()
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in ObjectSupportLib 1.0 and later
*/
extern OSErr
CreateCompDescriptor(
DescType comparisonOperator,
AEDesc * operand1,
AEDesc * operand2,
Boolean disposeInputs,
AEDesc * theDescriptor) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* CreateLogicalDescriptor()
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in ObjectSupportLib 1.0 and later
*/
extern OSErr
CreateLogicalDescriptor(
AEDescList * theLogicalTerms,
DescType theLogicOperator,
Boolean disposeInputs,
AEDesc * theDescriptor) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* CreateObjSpecifier()
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in ObjectSupportLib 1.0 and later
*/
extern OSErr
CreateObjSpecifier(
DescType desiredClass,
AEDesc * theContainer,
DescType keyForm,
AEDesc * keyData,
Boolean disposeInputs,
AEDesc * objSpecifier) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* CreateRangeDescriptor()
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in ObjectSupportLib 1.0 and later
*/
extern OSErr
CreateRangeDescriptor(
AEDesc * rangeStart,
AEDesc * rangeStop,
Boolean disposeInputs,
AEDesc * theDescriptor) __API_AVAILABLE(macos(10.0));
#ifdef __cplusplus
}
#endif
#endif /* __AEPACKOBJECT__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/AE.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/AE.framework/Headers/AEUserTermTypes.h | /*
File: AE/AEUserTermTypes.h
Contains: AppleEvents AEUT resource format Interfaces.
Copyright: � 1991-2008 by Apple Computer, Inc., all rights reserved
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __AEUSERTERMTYPES__
#define __AEUSERTERMTYPES__
#ifndef __CARBONCORE__
#include <CarbonCore/CarbonCore.h>
#endif
#include <os/availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#pragma pack(push, 2)
CF_ENUM(OSType) {
kAEUserTerminology = 'aeut', /* 0x61657574 */
kAETerminologyExtension = 'aete', /* 0x61657465 */
kAEScriptingSizeResource = 'scsz', /* 0x7363737a */
kAEOSAXSizeResource = 'osiz'
};
enum {
kAEUTHasReturningParam = 31, /* if event has a keyASReturning param */
kAEUTOptional = 15, /* if something is optional */
kAEUTlistOfItems = 14, /* if property or reply is a list. */
kAEUTEnumerated = 13, /* if property or reply is of an enumerated type. */
kAEUTReadWrite = 12, /* if property is writable. */
kAEUTChangesState = 12, /* if an event changes state. */
kAEUTTightBindingFunction = 12, /* if this is a tight-binding precedence function. */
/* AppleScript 1.3: new bits for reply, direct parameter, parameter, and property flags */
kAEUTEnumsAreTypes = 11, /* if the enumeration is a list of types, not constants */
kAEUTEnumListIsExclusive = 10, /* if the list of enumerations is a proper set */
kAEUTReplyIsReference = 9, /* if the reply is a reference, not a value */
kAEUTDirectParamIsReference = 9, /* if the direct parameter is a reference, not a value */
kAEUTParamIsReference = 9, /* if the parameter is a reference, not a value */
kAEUTPropertyIsReference = 9, /* if the property is a reference, not a value */
kAEUTNotDirectParamIsTarget = 8, /* if the direct parameter is not the target of the event */
kAEUTParamIsTarget = 8, /* if the parameter is the target of the event */
kAEUTApostrophe = 3, /* if a term contains an apostrophe. */
kAEUTFeminine = 2, /* if a term is feminine gender. */
kAEUTMasculine = 1, /* if a term is masculine gender. */
kAEUTPlural = 0 /* if a term is plural. */
};
struct TScriptingSizeResource {
SInt16 scriptingSizeFlags;
UInt32 minStackSize;
UInt32 preferredStackSize;
UInt32 maxStackSize;
UInt32 minHeapSize;
UInt32 preferredHeapSize;
UInt32 maxHeapSize;
};
typedef struct TScriptingSizeResource TScriptingSizeResource;
enum {
kLaunchToGetTerminology = (1 << 15), /* If kLaunchToGetTerminology is 0, 'aete' is read directly from res file. If set to 1, then launch and use 'gdut' to get terminology. */
kDontFindAppBySignature = (1 << 14), /* If kDontFindAppBySignature is 0, then find app with signature if lost. If 1, then don't */
kAlwaysSendSubject = (1 << 13) /* If kAlwaysSendSubject 0, then send subject when appropriate. If 1, then every event has Subject Attribute */
};
/* old names for above bits. */
enum {
kReadExtensionTermsMask = (1 << 15)
};
enum {
/* AppleScript 1.3: Bit positions for osiz resource */
/* AppleScript 1.3: Bit masks for osiz resources */
kOSIZDontOpenResourceFile = 15, /* If set, resource file is not opened when osax is loaded */
kOSIZdontAcceptRemoteEvents = 14, /* If set, handler will not be called with events from remote machines */
kOSIZOpenWithReadPermission = 13, /* If set, file will be opened with read permission only */
kOSIZCodeInSharedLibraries = 11 /* If set, loader will look for handler in shared library, not osax resources */
};
#pragma pack(pop)
#endif /* __AEUSERTERMTYPES__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/AE.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/AE.framework/Headers/AEObjects.h | /*
File: AE/AEObjects.h
Contains: Object Support Library Interfaces.
Copyright: � 1991-2008 by Apple Computer, Inc., all rights reserved
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __AEOBJECTS__
#define __AEOBJECTS__
#ifndef __CARBONCORE__
#include <CarbonCore/CarbonCore.h>
#endif
#ifndef __APPLEEVENTS__
#include <AE/AppleEvents.h>
#endif
#include <os/availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
#pragma pack(push, 2)
enum {
/**** LOGICAL OPERATOR CONSTANTS ****/
kAEAND = 'AND ', /* 0x414e4420 */
kAEOR = 'OR ', /* 0x4f522020 */
kAENOT = 'NOT ', /* 0x4e4f5420 */
/**** ABSOLUTE ORDINAL CONSTANTS ****/
kAEFirst = 'firs', /* 0x66697273 */
kAELast = 'last', /* 0x6c617374 */
kAEMiddle = 'midd', /* 0x6d696464 */
kAEAny = 'any ', /* 0x616e7920 */
kAEAll = 'all ', /* 0x616c6c20 */
/**** RELATIVE ORDINAL CONSTANTS ****/
kAENext = 'next', /* 0x6e657874 */
kAEPrevious = 'prev', /* 0x70726576 */
/**** KEYWORD CONSTANT ****/
keyAECompOperator = 'relo', /* 0x72656c6f */
keyAELogicalTerms = 'term', /* 0x7465726d */
keyAELogicalOperator = 'logc', /* 0x6c6f6763 */
keyAEObject1 = 'obj1', /* 0x6f626a31 */
keyAEObject2 = 'obj2', /* 0x6f626a32 */
/* ... for Keywords for getting fields out of object specifier records. */
keyAEDesiredClass = 'want', /* 0x77616e74 */
keyAEContainer = 'from', /* 0x66726f6d */
keyAEKeyForm = 'form', /* 0x666f726d */
keyAEKeyData = 'seld' /* 0x73656c64 */
};
CF_ENUM(AEKeyword) {
/* ... for Keywords for getting fields out of Range specifier records. */
keyAERangeStart = 'star', /* 0x73746172 */
keyAERangeStop = 'stop', /* 0x73746f70 */
/* ... special handler selectors for OSL Callbacks. */
keyDisposeTokenProc = 'xtok', /* 0x78746f6b */
keyAECompareProc = 'cmpr', /* 0x636d7072 */
keyAECountProc = 'cont', /* 0x636f6e74 */
keyAEMarkTokenProc = 'mkid', /* 0x6d6b6964 */
keyAEMarkProc = 'mark', /* 0x6d61726b */
keyAEAdjustMarksProc = 'adjm', /* 0x61646a6d */
keyAEGetErrDescProc = 'indc' /* 0x696e6463 */
};
/**** VALUE and TYPE CONSTANTS ****/
enum {
/* ... possible values for the keyAEKeyForm field of an object specifier. */
formAbsolutePosition = 'indx', /* 0x696e6478 */
formRelativePosition = 'rele', /* 0x72656c65 */
formTest = 'test', /* 0x74657374 */
formRange = 'rang', /* 0x72616e67 */
formPropertyID = 'prop', /* 0x70726f70 */
formName = 'name', /* 0x6e616d65 */
formUniqueID = 'ID ', /* 0x49442020 */
}
;
CF_ENUM(DescType) {
/* ... relevant types (some of these are often pared with forms above). */
typeObjectSpecifier = 'obj ', /* 0x6f626a20 */
typeObjectBeingExamined = 'exmn', /* 0x65786d6e */
typeCurrentContainer = 'ccnt', /* 0x63636e74 */
typeToken = 'toke', /* 0x746f6b65 */
typeRelativeDescriptor = 'rel ', /* 0x72656c20 */
typeAbsoluteOrdinal = 'abso', /* 0x6162736f */
typeIndexDescriptor = 'inde', /* 0x696e6465 */
typeRangeDescriptor = 'rang', /* 0x72616e67 */
typeLogicalDescriptor = 'logi', /* 0x6c6f6769 */
typeCompDescriptor = 'cmpd', /* 0x636d7064 */
typeOSLTokenList = 'ostl' /* 0x6F73746C */
};
/* Possible values for flags parameter to AEResolve. They're additive */
enum {
kAEIDoMinimum = 0x0000,
kAEIDoWhose = 0x0001,
kAEIDoMarking = 0x0004,
kAEPassSubDescs = 0x0008,
kAEResolveNestedLists = 0x0010,
kAEHandleSimpleRanges = 0x0020,
kAEUseRelativeIterators = 0x0040
};
/**** SPECIAL CONSTANTS FOR CUSTOM WHOSE-CLAUSE RESOLUTION */
enum {
typeWhoseDescriptor = 'whos', /* 0x77686f73 */
formWhose = 'whos', /* 0x77686f73 */
typeWhoseRange = 'wrng', /* 0x77726e67 */
keyAEWhoseRangeStart = 'wstr', /* 0x77737472 */
keyAEWhoseRangeStop = 'wstp', /* 0x77737470 */
keyAEIndex = 'kidx', /* 0x6b696478 */
keyAETest = 'ktst' /* 0x6b747374 */
};
/*
used for rewriting tokens in place of 'ccnt' descriptors
This record is only of interest to those who, when they...
...get ranges as key data in their accessor procs, choose
...to resolve them manually rather than call AEResolve again.
*/
struct ccntTokenRecord {
DescType tokenClass;
AEDesc token;
};
typedef struct ccntTokenRecord ccntTokenRecord;
typedef ccntTokenRecord * ccntTokenRecPtr;
typedef ccntTokenRecPtr * ccntTokenRecHandle;
#if OLDROUTINENAMES
typedef AEDesc * DescPtr;
typedef DescPtr * DescHandle;
#endif /* OLDROUTINENAMES */
/* typedefs providing type checking for procedure pointers */
typedef CALLBACK_API( OSErr , OSLAccessorProcPtr )(DescType desiredClass, const AEDesc *container, DescType containerClass, DescType form, const AEDesc *selectionData, AEDesc *value, SRefCon accessorRefcon);
typedef CALLBACK_API( OSErr , OSLCompareProcPtr )(DescType oper, const AEDesc *obj1, const AEDesc *obj2, Boolean *result);
typedef CALLBACK_API( OSErr , OSLCountProcPtr )(DescType desiredType, DescType containerClass, const AEDesc *container, long *result);
typedef CALLBACK_API( OSErr , OSLDisposeTokenProcPtr )(AEDesc * unneededToken);
typedef CALLBACK_API( OSErr , OSLGetMarkTokenProcPtr )(const AEDesc *dContainerToken, DescType containerClass, AEDesc *result);
typedef CALLBACK_API( OSErr , OSLGetErrDescProcPtr )(AEDesc ** appDescPtr);
typedef CALLBACK_API( OSErr , OSLMarkProcPtr )(const AEDesc *dToken, const AEDesc *markToken, long index);
typedef CALLBACK_API( OSErr , OSLAdjustMarksProcPtr )(long newStart, long newStop, const AEDesc *markToken);
typedef STACK_UPP_TYPE(OSLAccessorProcPtr) OSLAccessorUPP;
typedef STACK_UPP_TYPE(OSLCompareProcPtr) OSLCompareUPP;
typedef STACK_UPP_TYPE(OSLCountProcPtr) OSLCountUPP;
typedef STACK_UPP_TYPE(OSLDisposeTokenProcPtr) OSLDisposeTokenUPP;
typedef STACK_UPP_TYPE(OSLGetMarkTokenProcPtr) OSLGetMarkTokenUPP;
typedef STACK_UPP_TYPE(OSLGetErrDescProcPtr) OSLGetErrDescUPP;
typedef STACK_UPP_TYPE(OSLMarkProcPtr) OSLMarkUPP;
typedef STACK_UPP_TYPE(OSLAdjustMarksProcPtr) OSLAdjustMarksUPP;
/*
* NewOSLAccessorUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern OSLAccessorUPP
NewOSLAccessorUPP(OSLAccessorProcPtr userRoutine) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* NewOSLCompareUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern OSLCompareUPP
NewOSLCompareUPP(OSLCompareProcPtr userRoutine) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* NewOSLCountUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern OSLCountUPP
NewOSLCountUPP(OSLCountProcPtr userRoutine) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* NewOSLDisposeTokenUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern OSLDisposeTokenUPP
NewOSLDisposeTokenUPP(OSLDisposeTokenProcPtr userRoutine) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* NewOSLGetMarkTokenUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern OSLGetMarkTokenUPP
NewOSLGetMarkTokenUPP(OSLGetMarkTokenProcPtr userRoutine) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* NewOSLGetErrDescUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern OSLGetErrDescUPP
NewOSLGetErrDescUPP(OSLGetErrDescProcPtr userRoutine) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* NewOSLMarkUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern OSLMarkUPP
NewOSLMarkUPP(OSLMarkProcPtr userRoutine) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* NewOSLAdjustMarksUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern OSLAdjustMarksUPP
NewOSLAdjustMarksUPP(OSLAdjustMarksProcPtr userRoutine) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* DisposeOSLAccessorUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
DisposeOSLAccessorUPP(OSLAccessorUPP userUPP) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* DisposeOSLCompareUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
DisposeOSLCompareUPP(OSLCompareUPP userUPP) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* DisposeOSLCountUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
DisposeOSLCountUPP(OSLCountUPP userUPP) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* DisposeOSLDisposeTokenUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
DisposeOSLDisposeTokenUPP(OSLDisposeTokenUPP userUPP) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* DisposeOSLGetMarkTokenUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
DisposeOSLGetMarkTokenUPP(OSLGetMarkTokenUPP userUPP) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* DisposeOSLGetErrDescUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
DisposeOSLGetErrDescUPP(OSLGetErrDescUPP userUPP) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* DisposeOSLMarkUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
DisposeOSLMarkUPP(OSLMarkUPP userUPP) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* DisposeOSLAdjustMarksUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
DisposeOSLAdjustMarksUPP(OSLAdjustMarksUPP userUPP) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* InvokeOSLAccessorUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern OSErr
InvokeOSLAccessorUPP(
DescType desiredClass,
const AEDesc * container,
DescType containerClass,
DescType form,
const AEDesc * selectionData,
AEDesc * value,
SRefCon accessorRefcon,
OSLAccessorUPP userUPP) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* InvokeOSLCompareUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern OSErr
InvokeOSLCompareUPP(
DescType oper,
const AEDesc * obj1,
const AEDesc * obj2,
Boolean * result,
OSLCompareUPP userUPP) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* InvokeOSLCountUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern OSErr
InvokeOSLCountUPP(
DescType desiredType,
DescType containerClass,
const AEDesc * container,
long * result,
OSLCountUPP userUPP) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* InvokeOSLDisposeTokenUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern OSErr
InvokeOSLDisposeTokenUPP(
AEDesc * unneededToken,
OSLDisposeTokenUPP userUPP) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* InvokeOSLGetMarkTokenUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern OSErr
InvokeOSLGetMarkTokenUPP(
const AEDesc * dContainerToken,
DescType containerClass,
AEDesc * result,
OSLGetMarkTokenUPP userUPP) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* InvokeOSLGetErrDescUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern OSErr
InvokeOSLGetErrDescUPP(
AEDesc ** appDescPtr,
OSLGetErrDescUPP userUPP) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* InvokeOSLMarkUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern OSErr
InvokeOSLMarkUPP(
const AEDesc * dToken,
const AEDesc * markToken,
long index,
OSLMarkUPP userUPP) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* InvokeOSLAdjustMarksUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern OSErr
InvokeOSLAdjustMarksUPP(
long newStart,
long newStop,
const AEDesc * markToken,
OSLAdjustMarksUPP userUPP) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
#if __MACH__
#ifdef __cplusplus
inline OSLAccessorUPP NewOSLAccessorUPP(OSLAccessorProcPtr userRoutine) { return userRoutine; }
inline OSLCompareUPP NewOSLCompareUPP(OSLCompareProcPtr userRoutine) { return userRoutine; }
inline OSLCountUPP NewOSLCountUPP(OSLCountProcPtr userRoutine) { return userRoutine; }
inline OSLDisposeTokenUPP NewOSLDisposeTokenUPP(OSLDisposeTokenProcPtr userRoutine) { return userRoutine; }
inline OSLGetMarkTokenUPP NewOSLGetMarkTokenUPP(OSLGetMarkTokenProcPtr userRoutine) { return userRoutine; }
inline OSLGetErrDescUPP NewOSLGetErrDescUPP(OSLGetErrDescProcPtr userRoutine) { return userRoutine; }
inline OSLMarkUPP NewOSLMarkUPP(OSLMarkProcPtr userRoutine) { return userRoutine; }
inline OSLAdjustMarksUPP NewOSLAdjustMarksUPP(OSLAdjustMarksProcPtr userRoutine) { return userRoutine; }
inline void DisposeOSLAccessorUPP(OSLAccessorUPP) { }
inline void DisposeOSLCompareUPP(OSLCompareUPP) { }
inline void DisposeOSLCountUPP(OSLCountUPP) { }
inline void DisposeOSLDisposeTokenUPP(OSLDisposeTokenUPP) { }
inline void DisposeOSLGetMarkTokenUPP(OSLGetMarkTokenUPP) { }
inline void DisposeOSLGetErrDescUPP(OSLGetErrDescUPP) { }
inline void DisposeOSLMarkUPP(OSLMarkUPP) { }
inline void DisposeOSLAdjustMarksUPP(OSLAdjustMarksUPP) { }
inline OSErr InvokeOSLAccessorUPP(DescType desiredClass, const AEDesc * container, DescType containerClass, DescType form, const AEDesc * selectionData, AEDesc * value, SRefCon accessorRefcon, OSLAccessorUPP userUPP) { return (*userUPP)(desiredClass, container, containerClass, form, selectionData, value, accessorRefcon); }
inline OSErr InvokeOSLCompareUPP(DescType oper, const AEDesc * obj1, const AEDesc * obj2, Boolean * result, OSLCompareUPP userUPP) { return (*userUPP)(oper, obj1, obj2, result); }
inline OSErr InvokeOSLCountUPP(DescType desiredType, DescType containerClass, const AEDesc * container, long * result, OSLCountUPP userUPP) { return (*userUPP)(desiredType, containerClass, container, result); }
inline OSErr InvokeOSLDisposeTokenUPP(AEDesc * unneededToken, OSLDisposeTokenUPP userUPP) { return (*userUPP)(unneededToken); }
inline OSErr InvokeOSLGetMarkTokenUPP(const AEDesc * dContainerToken, DescType containerClass, AEDesc * result, OSLGetMarkTokenUPP userUPP) { return (*userUPP)(dContainerToken, containerClass, result); }
inline OSErr InvokeOSLGetErrDescUPP(AEDesc ** appDescPtr, OSLGetErrDescUPP userUPP) { return (*userUPP)(appDescPtr); }
inline OSErr InvokeOSLMarkUPP(const AEDesc * dToken, const AEDesc * markToken, long index, OSLMarkUPP userUPP) { return (*userUPP)(dToken, markToken, index); }
inline OSErr InvokeOSLAdjustMarksUPP(long newStart, long newStop, const AEDesc * markToken, OSLAdjustMarksUPP userUPP) { return (*userUPP)(newStart, newStop, markToken); }
#else
#define NewOSLAccessorUPP(userRoutine) ((OSLAccessorUPP)userRoutine)
#define NewOSLCompareUPP(userRoutine) ((OSLCompareUPP)userRoutine)
#define NewOSLCountUPP(userRoutine) ((OSLCountUPP)userRoutine)
#define NewOSLDisposeTokenUPP(userRoutine) ((OSLDisposeTokenUPP)userRoutine)
#define NewOSLGetMarkTokenUPP(userRoutine) ((OSLGetMarkTokenUPP)userRoutine)
#define NewOSLGetErrDescUPP(userRoutine) ((OSLGetErrDescUPP)userRoutine)
#define NewOSLMarkUPP(userRoutine) ((OSLMarkUPP)userRoutine)
#define NewOSLAdjustMarksUPP(userRoutine) ((OSLAdjustMarksUPP)userRoutine)
#define DisposeOSLAccessorUPP(userUPP)
#define DisposeOSLCompareUPP(userUPP)
#define DisposeOSLCountUPP(userUPP)
#define DisposeOSLDisposeTokenUPP(userUPP)
#define DisposeOSLGetMarkTokenUPP(userUPP)
#define DisposeOSLGetErrDescUPP(userUPP)
#define DisposeOSLMarkUPP(userUPP)
#define DisposeOSLAdjustMarksUPP(userUPP)
#define InvokeOSLAccessorUPP(desiredClass, container, containerClass, form, selectionData, value, accessorRefcon, userUPP) (*userUPP)(desiredClass, container, containerClass, form, selectionData, value, accessorRefcon)
#define InvokeOSLCompareUPP(oper, obj1, obj2, result, userUPP) (*userUPP)(oper, obj1, obj2, result)
#define InvokeOSLCountUPP(desiredType, containerClass, container, result, userUPP) (*userUPP)(desiredType, containerClass, container, result)
#define InvokeOSLDisposeTokenUPP(unneededToken, userUPP) (*userUPP)(unneededToken)
#define InvokeOSLGetMarkTokenUPP(dContainerToken, containerClass, result, userUPP) (*userUPP)(dContainerToken, containerClass, result)
#define InvokeOSLGetErrDescUPP(appDescPtr, userUPP) (*userUPP)(appDescPtr)
#define InvokeOSLMarkUPP(dToken, markToken, index, userUPP) (*userUPP)(dToken, markToken, index)
#define InvokeOSLAdjustMarksUPP(newStart, newStop, markToken, userUPP) (*userUPP)(newStart, newStop, markToken)
#endif
#endif
/*
* AEObjectInit()
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in ObjectSupportLib 1.0 and later
*/
extern OSErr
AEObjectInit(void) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/* Not done by inline, but by direct linking into code. It sets up the pack
such that further calls can be via inline */
/*
* AESetObjectCallbacks()
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in ObjectSupportLib 1.0 and later
*/
extern OSErr
AESetObjectCallbacks(
OSLCompareUPP myCompareProc,
OSLCountUPP myCountProc,
OSLDisposeTokenUPP myDisposeTokenProc,
OSLGetMarkTokenUPP myGetMarkTokenProc,
OSLMarkUPP myMarkProc,
OSLAdjustMarksUPP myAdjustMarksProc,
OSLGetErrDescUPP myGetErrDescProcPtr) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AEResolve()
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in ObjectSupportLib 1.0 and later
*/
extern OSErr
AEResolve(
const AEDesc * objectSpecifier,
short callbackFlags,
AEDesc * theToken) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AEInstallObjectAccessor()
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in ObjectSupportLib 1.0 and later
*/
extern OSErr
AEInstallObjectAccessor(
DescType desiredClass,
DescType containerType,
OSLAccessorUPP theAccessor,
SRefCon accessorRefcon,
Boolean isSysHandler) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AERemoveObjectAccessor()
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in ObjectSupportLib 1.0 and later
*/
extern OSErr
AERemoveObjectAccessor(
DescType desiredClass,
DescType containerType,
OSLAccessorUPP theAccessor,
Boolean isSysHandler) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AEGetObjectAccessor()
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in ObjectSupportLib 1.0 and later
*/
extern OSErr
AEGetObjectAccessor(
DescType desiredClass,
DescType containerType,
OSLAccessorUPP * accessor,
SRefCon * accessorRefcon,
Boolean isSysHandler) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AEDisposeToken()
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in ObjectSupportLib 1.0 and later
*/
extern OSErr
AEDisposeToken(AEDesc * theToken) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AECallObjectAccessor()
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in ObjectSupportLib 1.0 and later
*/
extern OSErr
AECallObjectAccessor(
DescType desiredClass,
const AEDesc * containerToken,
DescType containerClass,
DescType keyForm,
const AEDesc * keyData,
AEDesc * token) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
#pragma pack(pop)
#ifdef __cplusplus
}
#endif
#endif /* __AEOBJECTS__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/AE.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/AE.framework/Headers/AEDataModel.h | /*
File: AE/AEDataModel.h
Contains: AppleEvent Data Model Interfaces.
Copyright: � 1996-2008 by Apple Computer, Inc., all rights reserved
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __AEDATAMODEL__
#define __AEDATAMODEL__
#ifndef __CARBONCORE__
#include <CarbonCore/CarbonCore.h>
#endif
#include <os/availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
#pragma pack(push, 2)
/* Apple event manager data types */
typedef ResType DescType;
typedef FourCharCode AEKeyword;
/* Apple event descriptor types */
CF_ENUM(DescType) {
typeBoolean = 'bool',
typeChar = 'TEXT' /* Deprecated, use typeUTF8Text instead. */
};
/*
* The following descriptor types are deprecated due to their lack of
* explicit encoding or byte order definition. Please use
* typeUTF16ExternalRepresentation or typeUTF8Text instead. */
CF_ENUM(DescType) {
typeStyledUnicodeText = 'sutx', /* Not implemented */
typeEncodedString = 'encs', /* Not implemented */
typeUnicodeText = 'utxt', /* native byte ordering, optional BOM */
typeCString = 'cstr', /* MacRoman characters followed by a NULL byte */
typePString = 'pstr' /* Unsigned length byte followed by MacRoman characters */
};
/*
* The preferred unicode text types. In both cases, there is no explicit null termination or length byte.
*/
CF_ENUM(DescType) {
typeUTF16ExternalRepresentation = 'ut16', /* big-endian 16 bit unicode with optional byte-order-mark, or little-endian 16 bit unicode with required byte-order-mark. */
typeUTF8Text = 'utf8' /* 8 bit unicode */
};
/* Preferred numeric Apple event descriptor types */
CF_ENUM(DescType) {
typeSInt16 = 'shor', /* SInt16 : signed, 16 bit integer */
typeUInt16 = 'ushr', /* UInt16 : unsigned, 16 bit integer */
typeSInt32 = 'long', /* SInt32 : signed, 32 bit integer */
typeUInt32 = 'magn', /* UInt32 : unsigned, 32 bit integer */
typeSInt64 = 'comp', /* SInt64 : signed, 64 bit integer */
typeUInt64 = 'ucom', /* UInt64 : unsigned, 64 bit integer */
typeIEEE32BitFloatingPoint = 'sing', /* float */
typeIEEE64BitFloatingPoint = 'doub', /* double */
type128BitFloatingPoint = 'ldbl',
typeDecimalStruct = 'decm'
};
/* Non-preferred Apple event descriptor types */
#if __LP64__
/* On Mac OS X 64 bit, the following types have been removed because their meaning is unclear or confusing.
For example, people have assumed that the appropriate data type for typeLongInteger would be long; but
on 64 bit 'long' is a 64 bit value and the appropriate type should be typeComp.
You should change your existing code to not use the following types, and use the more specific ones. Check
through your code to make sure that the datasize referenced by these types is the correct type.
type constant change to data type should be
------------- --------- -------------------
typeSMInt typeSInt16 SInt16
typeShortInteger typeSInt16 SInt16
typeInteger typeSInt32 SInt32
typeLongInteger typeSInt32 SInt32
typeComp typeSInt64 SInt64 or Wide
typeSMFloat typeIEEE32BitFloatingPoint Float32
typeShortFloat typeIEEE32BitFloatingPoint Float32
typeLongFloat typeIEEE64BitFloatingPoint Float64
There is no good type on 64 bit to use for typeEntended; either change your code to pass typeIEEE64BitFloatingPoint
for typeExtended and live with the reduction in range or use type128BitFloatingPoint.
*/
#else
CF_ENUM(OSType) {
typeSMInt = typeSInt16,
typeShortInteger = typeSInt16,
typeInteger = typeSInt32,
typeLongInteger = typeSInt32,
typeMagnitude = typeUInt32,
typeComp = typeSInt64,
typeSMFloat = typeIEEE32BitFloatingPoint,
typeShortFloat = typeIEEE32BitFloatingPoint,
typeFloat = typeIEEE64BitFloatingPoint,
typeLongFloat = typeIEEE64BitFloatingPoint,
typeExtended = 'exte'
};
#endif /* __LP64__ */
/* More Apple event descriptor types */
CF_ENUM(DescType) {
typeAEList = 'list',
typeAERecord = 'reco',
typeAppleEvent = 'aevt',
typeEventRecord = 'evrc',
typeTrue = 'true',
typeFalse = 'fals',
typeAlias = 'alis', /* AliasPtr, from a valid AliasHandle. Deprecated; use typeFileURL or typeBookmark data to refer to files */
typeEnumerated = 'enum',
typeType = 'type', /* OSType */
typeAppParameters = 'appa',
typeProperty = 'prop',
typeFSRef = 'fsrf', /* FSRef. Deprecated; use typeFileURL or typeBookmark data to refer to files in AppleEvents */
typeFileURL = 'furl', /* a UTF-8 encoded full path, using native path separators */
typeBookmarkData = 'bmrk', /* the bytes of a CFURLBookmarkData */
typeKeyword = 'keyw', /* OSType */
typeSectionH = 'sect',
typeWildCard = '****',
typeApplSignature = 'sign', /* OSType */
typeQDRectangle = 'qdrt', /* Deprecated */
typeFixed = 'fixd',
typeProcessSerialNumber = 'psn ', /* ProcessSerialNumber */
typeApplicationURL = 'aprl',
typeNull = 'null' /* null or nonexistent data */
};
#if !__LP64__
/*
FSSpecs are deprecated on Mac OS X, and their use in AppleEvents is discouraged. You should change
your code to use typeFileURL or typeFileBookmark. In __LP64__ code, coercions into typeFSS is not supported,
and coercion from typeFSS is not guaranteed to work correctly in all cases.
*/
CF_ENUM(DescType) {
typeFSS = 'fss ' /* FSSpec */
};
#endif /* !__LP64__ */
CF_ENUM(DescType) {
typeCFAttributedStringRef = 'cfas',
typeCFMutableAttributedStringRef = 'cfaa',
typeCFStringRef = 'cfst',
typeCFMutableStringRef = 'cfms',
typeCFArrayRef = 'cfar',
typeCFMutableArrayRef = 'cfma',
typeCFDictionaryRef = 'cfdc',
typeCFMutableDictionaryRef = 'cfmd',
typeCFNumberRef = 'cfnb',
typeCFBooleanRef = 'cftf',
typeCFTypeRef = 'cfty'
};
/* New addressing modes for MacOS X */
CF_ENUM(DescType) {
typeKernelProcessID = 'kpid',
typeMachPort = 'port'
};
CF_ENUM(DescType) {
typeAuditToken = 'tokn', /* Mac OS X 10.8, returned as keyAuditTokenAttr and is a typedef audit_token_t */
};
/* Targeting applications by bundle ID is only available in Mac OS X 10.3 or later. */
CF_ENUM(DescType) {
typeApplicationBundleID = 'bund'
};
/* Keywords for Apple event attributes */
CF_ENUM(AEKeyword) {
keyTransactionIDAttr = 'tran', /* AETransactionID */
keyReturnIDAttr = 'rtid', /* AEReturnID */
keyEventClassAttr = 'evcl', /* AEEventClass */
keyEventIDAttr = 'evid', /* AEEventID */
keyAddressAttr = 'addr',
keyOptionalKeywordAttr = 'optk',
keyTimeoutAttr = 'timo', /* SInt32 */
keyInteractLevelAttr = 'inte', /* this attribute is read only - will be set in AESend */
keyEventSourceAttr = 'esrc', /* this attribute is read only - returned as typeShortInteger */
keyMissedKeywordAttr = 'miss', /* this attribute is read only */
keyOriginalAddressAttr = 'from', /* new in 1.0.1 */
keyAcceptTimeoutAttr = 'actm', /* new for Mac OS X */
keyReplyRequestedAttr = 'repq', /* Was a reply requested for this event - returned as typeBoolean */
#if __MAC_OS_X_VERSION_MIN_REQUIRED >= 1060
keySenderEUIDAttr = 'seid', /* read only, returned as typeSInt32. Will be the euid of the sender of this event. */
keySenderEGIDAttr = 'sgid', /* read only, returned as typeSInt32. Will be the egid of the sender of this event. */
keySenderUIDAttr = 'uids', /* read only, returned as typeSInt32. Will be the uid of the sender of this event. */
keySenderGIDAttr = 'gids', /* read only, returned as typeSInt32. Will be the gid of the sender of this event. */
keySenderPIDAttr = 'spid', /* read only, returned as typeSInt32. Will be the pid of the sender of this event. */
keySenderAuditTokenAttr = 'tokn', /* read only, returned as an audit_token_t. Will be the audit token of the sender of this event. */
#endif
#if __MAC_OS_X_VERSION_MIN_REQUIRED >= 1080
keySenderApplescriptEntitlementsAttr = 'entl', /* read only, an AEDesc containing opaque data representing the entitlements held by the sender. Interpreted by sandbox routines. */
keySenderApplicationIdentifierEntitlementAttr = 'aiea',
keySenderApplicationSandboxed = 'sssb', /* read-only, an AEDesc typeBoolean, true if the sender application was in an application sandbox */
keyActualSenderAuditToken = 'acat', /* read-only, an AEDesc typeAuditToken of the acual ( possibly over-ridden ) audit token for the sender of this event */
#endif
#if defined(__MAC_10_13) && __MAC_OS_X_VERSION_MIN_REQUIRED >= __MAC_10_13
keyAppleEventAttributesAttr = 'attr', /* read-only, an AEDescList of AEKeyword entries of the attributes on this event. */
#endif
};
/* These bits are specified in the keyXMLDebuggingAttr (an SInt32) */
enum {
kAEDebugPOSTHeader = (1 << 0), /* headers of the HTTP post we sent - typeChar */
kAEDebugReplyHeader = (1 << 1), /* headers returned by the server */
kAEDebugXMLRequest = (1 << 2), /* the XML request we sent */
kAEDebugXMLResponse = (1 << 3), /* the XML reply from the server */
kAEDebugXMLDebugAll = (int)0xFFFFFFFF /* everything! */
};
/* These values can be added as a parameter to the direct object of a
SOAP message to specify the serialization schema. If not
specified, kSOAP1999Schema is the default. These should be added as
typeType. */
enum {
kSOAP1999Schema = 'ss99',
kSOAP2001Schema = 'ss01'
};
CF_ENUM(AEKeyword) {
/* outgoing event attributes */
keyUserNameAttr = 'unam',
keyUserPasswordAttr = 'pass', /* not sent with the event */
keyDisableAuthenticationAttr = 'auth', /* When present and with a non zero value (that is, false, or integer 0), */
/* AESend will not authenticate the user. If not present, or with a non-zero*/
/* value, AESend will prompt for authentication information from the user if the interaction level allows. */
keyXMLDebuggingAttr = 'xdbg', /* a bitfield of specifying which XML debugging data is to be returned with the event */
/* Event class / id */
kAERPCClass = 'rpc ', /* for outgoing XML events */
kAEXMLRPCScheme = 'RPC2', /* event ID: event should be sent to an XMLRPC endpoint */
kAESOAPScheme = 'SOAP', /* event ID: event should be sent to a SOAP endpoint */
kAESharedScriptHandler = 'wscp', /* event ID: handler for incoming XML requests */
/* these parameters exist as part of the direct object of the event for both incoming and outgoing requests */
keyRPCMethodName = 'meth', /* name of the method to call */
keyRPCMethodParam = 'parm', /* the list (or structure) of parameters */
keyRPCMethodParamOrder = '/ord', /* if a structure, the order of parameters (a list) */
/* when keyXMLDebugginAttr so specifies, these additional parameters will be part of the reply. */
keyAEPOSTHeaderData = 'phed', /* what we sent to the server */
keyAEReplyHeaderData = 'rhed', /* what the server sent to us */
keyAEXMLRequestData = 'xreq', /* what we sent to the server */
keyAEXMLReplyData = 'xrep', /* what the server sent to us */
/* additional parameters that can be specified in the direct object of the event */
keyAdditionalHTTPHeaders = 'ahed', /* list of additional HTTP headers (a list of 2 element lists) */
keySOAPAction = 'sact', /* the SOAPAction header (required for SOAP messages) */
keySOAPMethodNameSpace = 'mspc', /* Optional namespace (defaults to m:) */
keySOAPMethodNameSpaceURI = 'mspu', /* Required namespace URI */
keySOAPSchemaVersion = 'ssch' /* Optional XML Schema version, defaults to kSOAP1999Schama */
};
/*
When serializing AERecords as SOAP structures, it is possible
to specify the namespace and type of the structure. To do this,
add a keySOAPStructureMetaData record to the top level of the
record to be serialized. If present, this will be used to specify
the structure namespace. This will produce a structure elment that
looks like:
<myStruct
xmlns:myNamespace="http://myUri.org/xsd",
xsi:type="myNamespace:MyStructType">
...
</myStruct>
*/
CF_ENUM(AEKeyword) {
keySOAPStructureMetaData = '/smd',
keySOAPSMDNamespace = 'ssns', /* "myNamespace"*/
keySOAPSMDNamespaceURI = 'ssnu', /* "http://myUri.org/xsd"*/
keySOAPSMDType = 'sstp' /* "MyStructType"*/
};
/*
* Web Services Proxy support. Available only on Mac OS X 10.2 or later.
* These constants should be added as attributes on the event that is
* being sent (not part of the direct object.)
*/
enum {
/* Automatically configure the proxy based on System Configuration */
kAEUseHTTPProxyAttr = 'xupr', /* a typeBoolean. Defaults to true.*/
/* manually specify the proxy host and port. */
kAEHTTPProxyPortAttr = 'xhtp', /* a typeSInt32*/
kAEHTTPProxyHostAttr = 'xhth' /* a typeChar*/
};
/*
* Web Services SOCKS support. kAEUseSocksAttr is a boolean that
* specifies whether to automatically configure SOCKS proxies by
* querying System Configuration.
*/
enum {
kAESocks4Protocol = 4,
kAESocks5Protocol = 5
};
enum {
kAEUseSocksAttr = 'xscs', /* a typeBoolean. Defaults to true.*/
/* This attribute specifies a specific SOCKS protocol to be used */
kAESocksProxyAttr = 'xsok', /* a typeSInt32*/
/* if version >= 4 */
kAESocksHostAttr = 'xshs', /* a typeChar*/
kAESocksPortAttr = 'xshp', /* a typeSInt32*/
kAESocksUserAttr = 'xshu', /* a typeChar*/
/* if version >= 5 */
kAESocksPasswordAttr = 'xshw' /* a typeChar*/
};
/* Constants used for specifying the factoring of AEDescLists. */
enum {
kAEDescListFactorNone = 0,
kAEDescListFactorType = 4,
kAEDescListFactorTypeAndSize = 8
};
/* Constants used creating an AppleEvent */
enum {
/* Constant for the returnID param of AECreateAppleEvent */
kAutoGenerateReturnID = -1, /* AECreateAppleEvent will generate a session-unique ID */
/* Constant for transaction IDs */
kAnyTransactionID = 0 /* no transaction is in use */
};
#if OPAQUE_TOOLBOX_STRUCTS
typedef struct OpaqueAEDataStorageType* AEDataStorageType;
#else
typedef Ptr AEDataStorageType;
#endif /* OPAQUE_TOOLBOX_STRUCTS */
typedef AEDataStorageType * AEDataStorage;
struct AEDesc {
DescType descriptorType;
AEDataStorage dataHandle;
};
typedef struct AEDesc AEDesc;
typedef AEDesc * AEDescPtr;
struct AEKeyDesc {
AEKeyword descKey;
AEDesc descContent;
};
typedef struct AEKeyDesc AEKeyDesc;
/* a list of AEDesc's is a special kind of AEDesc */
typedef AEDesc AEDescList;
/* AERecord is a list of keyworded AEDesc's */
typedef AEDescList AERecord;
/* an AEDesc which contains address data */
typedef AEDesc AEAddressDesc;
/* an AERecord that contains an AppleEvent, and related data types */
typedef AERecord AppleEvent;
typedef AppleEvent * AppleEventPtr;
typedef SInt16 AEReturnID;
typedef SInt32 AETransactionID;
typedef FourCharCode AEEventClass;
typedef FourCharCode AEEventID;
typedef SInt8 AEArrayType;
enum {
kAEDataArray = 0,
kAEPackedArray = 1,
kAEDescArray = 3,
kAEKeyDescArray = 4
};
enum {
kAEHandleArray = 2
};
union AEArrayData {
SInt16 kAEDataArray[1];
char kAEPackedArray[1];
Handle kAEHandleArray[1];
AEDesc kAEDescArray[1];
AEKeyDesc kAEKeyDescArray[1];
};
typedef union AEArrayData AEArrayData;
typedef AEArrayData * AEArrayDataPointer;
/**************************************************************************
These constants are used by AEMach and AEInteraction APIs. They are not
strictly part of the data format, but are declared here due to layering.
**************************************************************************/
typedef SInt16 AESendPriority;
enum {
kAENormalPriority = 0x00000000, /* post message at the end of the event queue */
kAEHighPriority = 0x00000001 /* post message at the front of the event queue (same as nAttnMsg) */
};
typedef SInt32 AESendMode;
enum {
kAENoReply = 0x00000001, /* sender doesn't want a reply to event */
kAEQueueReply = 0x00000002, /* sender wants a reply but won't wait */
kAEWaitReply = 0x00000003, /* sender wants a reply and will wait */
kAEDontReconnect = 0x00000080, /* don't reconnect if there is a sessClosedErr from PPCToolbox */
kAEWantReceipt = 0x00000200, /* (nReturnReceipt) sender wants a receipt of message */
kAENeverInteract = 0x00000010, /* server should not interact with user */
kAECanInteract = 0x00000020, /* server may try to interact with user */
kAEAlwaysInteract = 0x00000030, /* server should always interact with user where appropriate */
kAECanSwitchLayer = 0x00000040, /* interaction may switch layer */
kAEDontRecord = 0x00001000, /* don't record this event - available only in vers 1.0.1 and greater */
kAEDontExecute = 0x00002000, /* don't send the event for recording - available only in vers 1.0.1 and greater */
kAEProcessNonReplyEvents = 0x00008000, /* allow processing of non-reply events while awaiting synchronous AppleEvent reply */
kAEDoNotAutomaticallyAddAnnotationsToEvent = 0x00010000, /* if set, don't automatically add any sandbox or other annotations to the event */
};
/* Constants for timeout durations */
enum {
kAEDefaultTimeout = -1, /* timeout value determined by AEM */
kNoTimeOut = -2 /* wait until reply comes back, however long it takes */
};
/**************************************************************************
These calls are used to set up and modify the coercion dispatch table.
**************************************************************************/
typedef CALLBACK_API( OSErr , AECoerceDescProcPtr )(const AEDesc *fromDesc, DescType toType, SRefCon handlerRefcon, AEDesc *toDesc);
typedef CALLBACK_API( OSErr , AECoercePtrProcPtr )(DescType typeCode, const void *dataPtr, Size dataSize, DescType toType, SRefCon handlerRefcon, AEDesc *result);
typedef STACK_UPP_TYPE(AECoerceDescProcPtr) AECoerceDescUPP;
typedef STACK_UPP_TYPE(AECoercePtrProcPtr) AECoercePtrUPP;
/*
* NewAECoerceDescUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern AECoerceDescUPP
NewAECoerceDescUPP(AECoerceDescProcPtr userRoutine) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* NewAECoercePtrUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern AECoercePtrUPP
NewAECoercePtrUPP(AECoercePtrProcPtr userRoutine) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* DisposeAECoerceDescUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
DisposeAECoerceDescUPP(AECoerceDescUPP userUPP) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* DisposeAECoercePtrUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
DisposeAECoercePtrUPP(AECoercePtrUPP userUPP) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* InvokeAECoerceDescUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern OSErr
InvokeAECoerceDescUPP(
const AEDesc * fromDesc,
DescType toType,
SRefCon handlerRefcon,
AEDesc * toDesc,
AECoerceDescUPP userUPP) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* InvokeAECoercePtrUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern OSErr
InvokeAECoercePtrUPP(
DescType typeCode,
const void * dataPtr,
Size dataSize,
DescType toType,
SRefCon handlerRefcon,
AEDesc * result,
AECoercePtrUPP userUPP) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
#if __MACH__
#ifdef __cplusplus
inline AECoerceDescUPP NewAECoerceDescUPP(AECoerceDescProcPtr userRoutine) { return userRoutine; }
inline AECoercePtrUPP NewAECoercePtrUPP(AECoercePtrProcPtr userRoutine) { return userRoutine; }
inline void DisposeAECoerceDescUPP(AECoerceDescUPP) { }
inline void DisposeAECoercePtrUPP(AECoercePtrUPP) { }
inline OSErr InvokeAECoerceDescUPP(const AEDesc * fromDesc, DescType toType, SRefCon handlerRefcon, AEDesc * toDesc, AECoerceDescUPP userUPP) { return (*userUPP)(fromDesc, toType, handlerRefcon, toDesc); }
inline OSErr InvokeAECoercePtrUPP(DescType typeCode, const void * dataPtr, Size dataSize, DescType toType, SRefCon handlerRefcon, AEDesc * result, AECoercePtrUPP userUPP) { return (*userUPP)(typeCode, dataPtr, dataSize, toType, handlerRefcon, result); }
#else
#define NewAECoerceDescUPP(userRoutine) ((AECoerceDescUPP)userRoutine)
#define NewAECoercePtrUPP(userRoutine) ((AECoercePtrUPP)userRoutine)
#define DisposeAECoerceDescUPP(userUPP)
#define DisposeAECoercePtrUPP(userUPP)
#define InvokeAECoerceDescUPP(fromDesc, toType, handlerRefcon, toDesc, userUPP) (*userUPP)(fromDesc, toType, handlerRefcon, toDesc)
#define InvokeAECoercePtrUPP(typeCode, dataPtr, dataSize, toType, handlerRefcon, result, userUPP) (*userUPP)(typeCode, dataPtr, dataSize, toType, handlerRefcon, result)
#endif
#endif
/* a AECoercionHandlerUPP is by default a AECoerceDescUPP. If you are registering a
Ptr based coercion handler you will have to add a cast to AECoerceDescUPP from
your AECoercePtrUPP type. A future release of the interfaces will fix this by
introducing seperate Desc and Ptr coercion handler installation/remove/query routines. */
typedef AECoerceDescUPP AECoercionHandlerUPP;
/*
* AEInstallCoercionHandler()
*
* Summary:
* Installs a coercion handler in either the application or system
* coercion handler dispatch table.
*
* Discussion:
* Before using AEInstallCoercionHandler to install a handler for a
* particular descriptor type, you can use the AEGetCoercionHandler
* function to determine whether the table already contains a
* coercion handler for that type.
* Version Notes
* See the Version Notes section for the AECoercePtr function for
* information on when to use descriptor-based versus pointer-based
* coercion handlers starting in Mac OS X version 10.2.
* Your application should not install a coercion handler in a
* system coercion handler dispatch table with the goal that the
* handler will get called when other applications perform coercions
* - this won't work in Mac OS X. For more information, see "Writing
* and Installing Coercion Handlers" in Apple Events Programming
* Guide.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* fromType:
* The descriptor type of the data coerced by the handler.
*
* toType:
* The descriptor type of the resulting data.
* If there was already an entry in the specified coercion handler
* table for the same source descriptor type and result descriptor
* type, the existing entry is replaced.
*
* handler:
* A universal procedure pointer to the coercion handler function
* to install.
*
* handlerRefcon:
* A reference constant. The Apple Event Manager passes this value
* to the handler each time it calls it. If your handler doesn't
* require a reference constant, pass 0 for this parameter.
*
* fromTypeIsDesc:
* Specifies the form of the data to coerce. Pass TRUE if the
* coercion handler expects the data as a descriptor or FALSE if
* the coercion handler expects a pointer to the data. The Apple
* Event Manager can provide a pointer to data more efficiently
* than it can provide a descriptor, so all coercion functions
* should accept a pointer to data if possible.
*
* isSysHandler:
* Specifies the coercion table to add the handler to. Pass TRUE
* to add the handler to the system coercion table or FALSE to add
* the handler to your application's coercion table. Use of the
* system coercion table is not recommended.
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
AEInstallCoercionHandler(
DescType fromType,
DescType toType,
AECoercionHandlerUPP handler,
SRefCon handlerRefcon,
Boolean fromTypeIsDesc,
Boolean isSysHandler) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AERemoveCoercionHandler()
*
* Discussion:
* Removes a coercion handler from a coercion handler dispatch table.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* fromType:
* The descriptor type of the data coerced by the handler.
*
* toType:
* The descriptor type of the resulting data.
*
* handler:
* A universal procedure pointer to the coercion handler to
* remove. Although the parameters fromType and toType are
* sufficient to identify the handler, you can identify the
* handler explicitly as a safeguard. If you pass NULL for this
* parameter, the Apple Event Manager relies solely on the event
* class and event ID to identify the handler.
*
* isSysHandler:
* Specifies the coercion table to remove the handler from. Pass
* TRUE to remove the handler from the system coercion table or
* FALSE to remove the handler from your application's coercion
* table. Use of the system coercion table is not recommended.
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
AERemoveCoercionHandler(
DescType fromType,
DescType toType,
AECoercionHandlerUPP handler,
Boolean isSysHandler) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AEGetCoercionHandler()
*
* Discussion:
* Gets the coercion handler for a specified descriptor type.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* fromType:
* The descriptor type of the data coerced by the handler.
*
* toType:
* The descriptor type of the resulting data.
*
* handler:
* A universal procedure pointer. On return, a pointer to the
* specified handler, if a coercion table entry exists that
* exactly matches the values supplied in the parameters fromType
* and toType. See AECoercionHandlerUPP.
*
* handlerRefcon:
* A pointer to a reference constant. On return, the reference
* constant from the coercion table entry for the specified
* coercion handler. The Apple Event Manager passes this reference
* constant to the handler each time it calls the handler. The
* reference constant may have a value of 0.
*
* fromTypeIsDesc:
* A pointer to a Boolean value. The AEGetCoercionHandler function
* returns a value of TRUE in this parameter if the coercion
* handler expects the data as a descriptor or FALSE, if the
* coercion handler expects a pointer to the data.
*
* isSysHandler:
* Specifies the coercion table to get the handler from. Pass TRUE
* to get the handler from the system coercion table or FALSE to
* get the handler from your application's coercion table. Use of
* the system coercion table is not recommended.
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
AEGetCoercionHandler(
DescType fromType,
DescType toType,
AECoercionHandlerUPP * handler,
SRefCon * handlerRefcon,
Boolean * fromTypeIsDesc,
Boolean isSysHandler) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/**************************************************************************
The following calls provide for a coercion interface.
**************************************************************************/
/*
* AECoercePtr()
*
* Discussion:
* Coerces data to a desired descriptor type and creates a
* descriptor containing the newly coerced data.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* typeCode:
* The descriptor type of the source data.
*
* dataPtr:
* A pointer to the data to coerce.
*
* dataSize:
* The length, in bytes, of the data to coerce.
*
* toType:
* The desired descriptor type of the resulting descriptor.
*
* result:
* A pointer to a descriptor. On successful return, a descriptor
* containing the coerced data and matching the descriptor type
* specified in toType. On error, a null descriptor. If the
* function returns successfully, your application should call the
* AEDisposeDesc function to dispose of the resulting descriptor
* after it has finished using it. See AEDesc.
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
AECoercePtr(
DescType typeCode,
const void * dataPtr,
Size dataSize,
DescType toType,
AEDesc * result) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AECoerceDesc()
*
* Discussion:
* Coerces the data in a descriptor to another descriptor type and
* creates a descriptor containing the newly coerced data.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* theAEDesc:
* A pointer to the descriptor containing the data to coerce.
*
* toType:
* The desired descriptor type of the resulting descriptor.
*
* result:
* A pointer to a descriptor. On successful return, a descriptor
* containing the coerced data and matching the descriptor type
* specified in toType. On error, a null descriptor. If the
* function returns successfully, your application should call the
* AEDisposeDesc function to dispose of the resulting descriptor
* after it has finished using it.
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
AECoerceDesc(
const AEDesc * theAEDesc,
DescType toType,
AEDesc * result) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/**************************************************************************
The following calls apply to any AEDesc. Every 'result' descriptor is
created for you, so you will be responsible for memory management
(including disposing) of the descriptors so created.
**************************************************************************/
/* . */
/*
* AEInitializeDesc()
*
* Discussion:
* The function sets the type of the descriptor to typeNull and sets
* the data handle to NULL. If you need to initialize a descriptor
* that already has some data in it, use AEDisposeDesc to deallocate
* the memory and initialize the descriptor.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* desc:
* A pointer to a new descriptor.
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.4 and later
* Non-Carbon CFM: not available
*/
extern void
AEInitializeDesc(AEDesc * desc) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
#ifdef __cplusplus
inline void AEInitializeDescInline(AEDesc* d) { d->descriptorType = typeNull; d->dataHandle = NULL; }
#else
#define AEInitializeDescInline(__d) do { AEDesc* d = __d; d->descriptorType = typeNull; d->dataHandle = NULL; } while (0)
#endif
/*
* AECreateDesc()
*
* Summary:
* Creates a new descriptor that incorporates the specified data.
*
* Discussion:
* While it is possible to create an Apple event descriptor or a
* descriptor list or a descriptor with the AECreateDesc function
* (assuming you have access to the raw data for an Apple event,
* list, or descriptor), you typically create these structured
* objects with their specific creation routines -
* AECreateAppleEvent, AECreateList, or AECreateDesc.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* typeCode:
* The descriptor type for the new descriptor.
*
* dataPtr:
* A pointer to the data for the new descriptor. This data is
* copied into a newly-allocated block of memory for the
* descriptor that is created. To minimize copying overhead,
* consider using AECreateDescFromExternalPtr.
*
* dataSize:
* The length, in bytes, of the data for the new descriptor.
*
* result:
* A pointer to a descriptor. On successful return, a descriptor
* that incorporates the data specified by the dataPtr parameter.
* On error, a null descriptor. If the function returns
* successfully, your application should call the AEDisposeDesc
* function to dispose of the resulting descriptor after it has
* finished using it.
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
AECreateDesc(
DescType typeCode,
const void * dataPtr,
Size dataSize,
AEDesc * result) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AEDisposeDesc()
*
* Summary:
* Deallocates the memory used by a descriptor.
*
* Discussion:
* The AEDisposeDesc function deallocates the memory used by a
* descriptor. After calling this method, the descriptor becomes an
* empty descriptor with a type of typeNULL. Because all Apple event
* structures (except for keyword-specified descriptors) are
* descriptors, you can use AEDisposeDesc for any of them.
* Do not call AEDisposeDesc on a descriptor obtained from another
* Apple Event Manager function (such as the reply event from a call
* to AESend) unless that function returns successfully.
* Special Considerations
* If the AEDesc might contain an OSL token, dispose of it with
* AEDisposeToken.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* theAEDesc:
* A pointer to the descriptor to deallocate. On return, a null
* descriptor. If you pass a null descriptor in this parameter,
* AEDisposeDesc returns noErr.
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
AEDisposeDesc(AEDesc * theAEDesc) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AEDuplicateDesc()
*
* Summary:
* Creates a copy of a descriptor.
*
* Discussion:
* It is common for applications to send Apple events that have one
* or more attributes or parameters in common. For example, if you
* send a series of Apple events to the same application, the
* address attribute is the same. In these cases, the most efficient
* way to create the necessary Apple events is to make a template
* Apple event that you can then copy - by calling the
* AEDuplicateDesc function - as needed. You then fill in or change
* the remaining parameters and attributes of the copy, send the
* copy by calling the AESend function and, after AESend returns a
* result code, dispose of the copy by calling AEDisposeDesc. You
* can use this approach to prepare structures of type AEDesc,
* AEDescList, AERecord, and AppleEvent.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* theAEDesc:
* A pointer to the descriptor to duplicate. See AEDesc.
*
* result:
* A pointer to a descriptor. On return, the descriptor contains a
* copy of the descriptor specified by the theAEDesc parameter. If
* the function returns successfully, your application should call
* the AEDisposeDesc function to dispose of the resulting
* descriptor after it has finished using it.
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
AEDuplicateDesc(
const AEDesc * theAEDesc,
AEDesc * result) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
typedef CALLBACK_API( void , AEDisposeExternalProcPtr )(const void *dataPtr, Size dataLength, SRefCon refcon);
typedef STACK_UPP_TYPE(AEDisposeExternalProcPtr) AEDisposeExternalUPP;
/*
* AECreateDescFromExternalPtr()
*
* Summary:
* Creates a new descriptor that uses a memory buffer supplied by
* the caller.
*
* Discussion:
* This function is different than AECreateDesc, in that it creates
* a descriptor that uses the data block provided by the caller "in
* place," rather than allocate a block of memory and copy the data
* to it. This function can provide dramatically improved
* performance if you're working with large chunks of data. It
* attempts to copy the descriptor to the address space of any
* recipient process using virtual memory APIs, avoiding an actual
* memory copy. For example, you might want to use this function to
* pass a large image in an Apple event.
* You can use the AEGetDescDataRange function to access a specific
* section of a large block of data.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* descriptorType:
* The descriptor type for the new descriptor.
*
* dataPtr:
* A pointer to the data for the new descriptor. The memory that
* is pointed to cannot be a Handle (which may move in memory),
* cannot be modified by the caller, and must be preserved in
* place (and not freed), until the disposeCallback function is
* called.
* If possible, the descriptor will be mapped into the address
* space of the recipient using shared memory, avoiding an actual
* memory copy.
* The pointer that is passed in does not need to be aligned to
* any particular boundary, but is optimized to transfer data on a
* page boundary. You can get the current page size (4096 on all
* current Mac OS X systems) with the getpagesize(3) call. (Type
* man 3 getpagesize in a Terminal window for documentation.)
*
* dataLength:
* The length, in bytes, of the data for the new descriptor.
*
* disposeCallback:
* A universal procedure pointer to a dispose callback function of
* type AEDisposeExternalProcPtr. Your callback function will be
* called when the block of memory provided by dataPtr is no
* longer needed by the Apple Event Manager. The function can be
* called at any time, including during creation of the descriptor.
*
* disposeRefcon:
* A reference constant the Apple Event Manager passes to the
* disposeCallback function whenever it calls the function. If
* your dispose function doesn't require a reference constant,
* pass 0 for this parameter.
*
* theDesc:
* A pointer to a descriptor. On successful return, a descriptor
* that incorporates the data specified by the dataPtr parameter.
* On error, a null descriptor. If the function returns
* successfully, your application should call the AEDisposeDesc
* function to dispose of the resulting descriptor after it has
* finished using it.
*
* Availability:
* Mac OS X: in version 10.2 and later in ApplicationServices.framework
* CarbonLib: not available in CarbonLib 1.x, is available on Mac OS X version 10.2 and later
* Non-Carbon CFM: not available
*/
extern OSStatus
AECreateDescFromExternalPtr(
OSType descriptorType,
const void * dataPtr,
Size dataLength,
AEDisposeExternalUPP disposeCallback,
SRefCon disposeRefcon,
AEDesc * theDesc) API_AVAILABLE( macos(10.2) ) API_UNAVAILABLE( ios, tvos, watchos );
#ifndef AVAILABLE_MAC_OS_X_VERSION_10_8_AND_LATER
#define AVAILABLE_MAC_OS_X_VERSION_10_8_AND_LATER
#endif
/*
* AECompareDesc()
*
* Discussion:
* Compare two AEDesc descriptors and return whether they are
* identical or not.
*
* Mac OS X threading:
* Thread safe since version 10.8
*
* Parameters:
*
* desc1, desc2:
* A pointer to an AEDesc to be compared.
*
* resultP:
* If non-NULL, on a noErr return will be filled in with
* true or false indicating whether the descriptors are
* equilavent or not.
*
* Two descriptors are identical if they are the same type and have
* the same data; typeAEList descriptors must contain the same number
* of items and every item in each list must itself be identical;
* typeAERecord descriptors must contain the same number of keys
* and values and each key/value must match between the two.
* typeAppleEvents match like typeAERecord and also require that
* most attributes of the two events are identical.
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSStatus
AECompareDesc( const AEDesc * desc1, const AEDesc* desc2, Boolean* resultP ) API_AVAILABLE( macos(10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/**************************************************************************
The following calls apply to AEDescList. Since AEDescList is a subtype of
AEDesc, the calls in the previous section can also be used for AEDescList.
All list and array indices are 1-based. If the data was greater than
maximumSize in the routines below, then actualSize will be greater than
maximumSize, but only maximumSize bytes will actually be retrieved.
**************************************************************************/
/*
* AECreateList()
*
* Discussion:
* Creates an empty descriptor list or Apple event record.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* factoringPtr:
* A pointer to the data at the beginning of each descriptor that
* is the same for all descriptors in the list. If there is no
* common data, or if you decide not to isolate the common data,
* pass NULL as the value of this parameter.
*
* factoredSize:
* The size of the common data. If there is no common data, or if
* you decide not to isolate the common data, pass 0 as the value
* of this parameter. (See the Discussion section for more
* information.)
*
* isRecord:
* A Boolean value that specifies the kind of list to create. Pass
* a value of TRUE to create an Apple event record (a data
* structure of type AERecord) or FALSE to create a descriptor
* list.
*
* resultList:
* A pointer to a descriptor list variable. On successful return,
* the descriptor list or Apple event record that the AECreateList
* function creates. On error, a null descriptor. See AEDescList.
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
AECreateList(
const void * factoringPtr,
Size factoredSize,
Boolean isRecord,
AEDescList * resultList) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AECountItems()
*
* Discussion:
* Counts the number of descriptors in a descriptor list.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* theAEDescList:
* A pointer to the descriptor list to count
*
* theCount:
* A pointer to a count variable. On return, the number of
* descriptors in the specified descriptor list. Currently an
* AEDescList is limited to 2^31 items.
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
AECountItems(
const AEDescList * theAEDescList,
long * theCount) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AEPutPtr()
*
* Discussion:
* Puts data specified in a buffer to a descriptor list as a
* descriptor, possibly replacing an existing descriptor in the list.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* theAEDescList:
* A pointer to the descriptor list to add a descriptor to. See
* AEDescList.
*
* index:
* A one-based positive integer indicating the position to insert
* the descriptor at. If there is already a descriptor in the
* specified position, it is replaced. You can pass a value of
* zero or count + 1 to add the descriptor at the end of the list.
* AEPutPtr returns an error (AEIllegalIndex) if you pass a
* negative number or a value that is out of range. Currently the
* upper limit on index is 2^31 items.
*
* typeCode:
* The descriptor type for the descriptor to be put into the list.
*
* dataPtr:
* A pointer to the data for the descriptor to add.
*
* dataSize:
* The length, in bytes, of the data for the descriptor to add.
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
AEPutPtr(
AEDescList * theAEDescList,
long index,
DescType typeCode,
const void * dataPtr,
Size dataSize) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AEPutDesc()
*
* Discussion:
* Adds a descriptor to any descriptor list, possibly replacing an
* existing descriptor in the list.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* theAEDescList:
* A pointer to the descriptor list to add a descriptor to. See
* AEDescList.
*
* index:
* A one-based positive integer indicating the position to insert
* the descriptor at. If there is already a descriptor in the
* specified position, it is replaced. You can pass a value of
* zero or count + 1 to add the descriptor at the end of the list.
* AEPutPtr returns an error (AEIllegalIndex) if you pass a
* negative number or a value that is out of range. Currently the
* upper limit on index is 2^31 items.
*
* theAEDesc:
* A pointer to the descriptor to add to the list.
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
AEPutDesc(
AEDescList * theAEDescList,
long index,
const AEDesc * theAEDesc) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AEGetNthPtr()
*
* Discussion:
* Gets a copy of the data from a descriptor at a specified position
* in a descriptor list; typically used when your application needs
* to work with the extracted data directly.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* theAEDescList:
* A pointer to the descriptor list to add a descriptor to. See
* AEDescList.
*
* index:
* A one-based positive integer indicating the position in the
* descriptor list of the descriptor to get the data from.
* AEGetNthPtr returns an error if you pass zero, a negative
* number, or a value that is out of range. Currently the upper
* limit on index is 2^31 items.
*
* desiredType:
* The desired descriptor type for the copied data. For a list of
* AppleScript's predefined descriptor types. If the descriptor
* specified by the index parameter is not of the desired type,
* AEGetNthPtr attempts to coerce the data to this type. If you
* pass a value of typeWildCard, no coercion is performed, and the
* descriptor type of the copied data is the same as the
* descriptor type of the original descriptor.
*
* theAEKeyword:
* A pointer to a keyword or NULL. On return, the keyword for the
* specified descriptor, if you are getting data from a list of
* keyword-specified descriptors; otherwise, AEGetNthPtr returns
* the value typeWildCard.
*
* typeCode:
* A pointer to a descriptor type or NULL. On return, specifies
* the descriptor type of the data pointed to by dataPtr.
*
* dataPtr:
* A pointer to a buffer, local variable, or other storage
* location created and disposed of by your application. The size
* in bytes must be at least as large as the value you pass in the
* maximumSize parameter. On return, contains the data from the
* descriptor at the position in the descriptor list specified by
* the index parameter.
*
* maximumSize:
* The maximum length, in bytes, of the expected data. The
* AEGetNthPtr function will not return more data than you specify
* in this parameter.
*
* actualSize:
* A pointer to a size variable or NULL. On return, the length, in
* bytes, of the data for the specified descriptor. If this value
* is larger than the value of the maximumSize parameter, the
* buffer pointed to by dataPtr was not large enough to contain
* all of the data for the descriptor, though AEGetNthPtr does not
* write beyond the end of the buffer. If the buffer was too
* small, you can resize it and call AEGetNthPtr again.
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
AEGetNthPtr(
const AEDescList * theAEDescList,
long index,
DescType desiredType,
AEKeyword * theAEKeyword, /* can be NULL */
DescType * typeCode, /* can be NULL */
void * dataPtr,
Size maximumSize,
Size * actualSize) /* can be NULL */ API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AEGetNthDesc()
*
* Discussion:
* Copies a descriptor from a specified position in a descriptor
* list into a specified descriptor; typically used when your
* application needs to pass the extracted data to another function
* as a descriptor.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* theAEDescList:
* A pointer to the descriptor list to add a descriptor to. See
* AEDescList.
*
* index:
* A one-based positive integer indicating the position in the
* descriptor list of the descriptor to get the data from.
* AEGetNthDesc returns an error if you pass zero, a negative
* number, or a value that is out of range. Currently the upper
* limit on index is 2^31 items.
*
* desiredType:
* The desired descriptor type for the copied data. For a list of
* AppleScript's predefined descriptor types. If the descriptor
* specified by the index parameter is not of the desired type,
* AEGetNthDesc attempts to coerce the data to this type. If you
* pass a value of typeWildCard, no coercion is performed, and the
* descriptor type of the copied data is the same as the
* descriptor type of the original descriptor.
*
* theAEKeyword:
* A pointer to a keyword or NULL. On return, the keyword for the
* specified descriptor, if you are getting data from a list of
* keyword-specified descriptors; otherwise, AEGetNthDesc returns
* the value typeWildCard.
*
* result:
* A pointer to a descriptor. On successful return, a copy of the
* descriptor specified by the index parameter, coerced, if
* necessary, to the descriptor type specified by the desiredType
* parameter. On error, a null descriptor. If the function returns
* successfully, your application should call the AEDisposeDesc
* function to dispose of the resulting descriptor after it has
* finished using it.
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
AEGetNthDesc(
const AEDescList * theAEDescList,
long index,
DescType desiredType,
AEKeyword * theAEKeyword, /* can be NULL */
AEDesc * result) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AESizeOfNthItem()
*
* Discussion:
* Gets the data size and descriptor type of the descriptor at a
* specified position in a descriptor list.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* theAEDescList:
* A pointer to the descriptor list to add a descriptor to. See
* AEDescList.
*
* index:
* A one-based positive integer indicating the position in the
* descriptor list of the descriptor to get the data from.
* AESizeOfNthItem returns an error if you pass zero, a negative
* number, or a value that is out of range. Currently the upper
* limit on index is 2^31 items.
*
* typeCode:
* A pointer to a descriptor type or NULL. On return, specifies
* the descriptor type of the descriptor.
*
* dataSize:
* A pointer to a size variable or NULL. On return, the length (in
* bytes) of the data in the descriptor.
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
AESizeOfNthItem(
const AEDescList * theAEDescList,
long index,
DescType * typeCode, /* can be NULL */
Size * dataSize) /* can be NULL */ API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AEGetArray()
*
* Discussion:
* Extracts data from an Apple event array created with the
* AEPutArray function and stores it as a standard array of fixed
* size items in the specified buffer.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* theAEDescList:
* A pointer to the descriptor list to add a descriptor to. See
* AEDescList.
*
* arrayType:
* The Apple event array type to convert. Pass one of the
* constants: kAEDataArray, kAEPackedArray, kAEDescArray,
* kAEKeyDescArray
*
* arrayPtr:
* A pointer to a buffer, allocated and disposed of by your
* application, for storing the array. The size in bytes must be
* at least as large as the value you pass in the maximumSize
* parameter. On return, the buffer contains the array of
* fixed-size items.
*
* maximumSize:
* The maximum length, in bytes, of the expected data. The
* AEGetArray function will not return more data than you specify
* in this parameter.
*
* itemType:
* A pointer to a descriptor type. On return, for arrays of type
* kAEDataArray, kAEPackedArray, or kAEHandleArray, the descriptor
* type of the items in the returned array. The AEGetArray
* function doesn't supply a value in itemType for arrays of type
* kAEDescArray and kAEKeyDescArray because they may contain
* descriptors of different types.
*
* itemSize:
* A pointer to a size variable. On return, for arrays of type
* kAEDataArray or kAEPackedArray, the size (in bytes) of each
* item in the returned array. You don't get an item size for
* arrays of type kAEDescArray, kAEKeyDescArray, or kAEHandleArray
* because descriptors and handles (though not the data they point
* to) have a known size.
*
* itemCount:
* A pointer to a size variable. On return, the number of items in
* the returned array. Currently the upper limit on the size of
* an array is 2^31 items.
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
AEGetArray(
const AEDescList * theAEDescList,
AEArrayType arrayType,
AEArrayDataPointer arrayPtr,
Size maximumSize,
DescType * itemType,
Size * itemSize,
long * itemCount) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AEPutArray()
*
* Discussion:
* Extracts data from an Apple event array created with the
* AEPutArray function and stores it as a standard array of fixed
* size items in the specified buffer.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* theAEDescList:
* A pointer to the descriptor list to add a descriptor to. See
* AEDescList.
*
* arrayType:
* The Apple event array type to convert. Pass one of the
* constants: kAEDataArray, kAEPackedArray, kAEDescArray,
* kAEKeyDescArray
*
* arrayPtr:
* A pointer to a buffer, local variable, or other storage
* location, created and disposed of by your application, that
* contains the array to put into the descriptor list.
*
* itemType:
* For arrays of type kAEDataArray, kAEPackedArray, or
* kAEHandleArray, the descriptor type of the array items to
* create. Use one of the constants such as typeLongInteger. You
* don't need to specify an item type for arrays of type
* kAEDescArray or kAEKeyDescArray because the data is already
* stored in descriptors which contain a descriptor type.
*
* itemSize:
* For arrays of type kAEDataArray or kAEPackedArray, the size (in
* bytes) of the array items to create. You don't need to specify
* an item size for arrays of type kAEDescArray, kAEKeyDescArray,
* or kAEHandleArray because their descriptors (though not the
* data they point to) have a known size.
*
* itemCount:
* A pointer to a size variable. On return, the number of items in
* the returned array. Currently the upper limit on the size of
* an array is 2^31 items.
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
AEPutArray(
AEDescList * theAEDescList,
AEArrayType arrayType,
const AEArrayData * arrayPtr,
DescType itemType,
Size itemSize,
long itemCount) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AEDeleteItem()
*
* Discussion:
* Deletes a descriptor from a descriptor list, causing all
* subsequent descriptors to move up one place.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* theAEDescList:
* A pointer to the descriptor list to add a descriptor to. See
* AEDescList.
*
* index:
* A one-based positive integer indicating the position in the
* descriptor list of the descriptor to delete. AEDeleteItem
* returns an error if you pass zero, a negative number, or a
* value that is out of range. Currently the upper limit on index
* is 2^31 items.
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
AEDeleteItem(
AEDescList * theAEDescList,
long index) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/**************************************************************************
The following calls apply to AERecord. Since AERecord is a subtype of
AEDescList, the calls in the previous sections can also be used for
AERecord an AERecord can be created by using AECreateList with isRecord
set to true.
**************************************************************************/
/*************************************************************************
AERecords can have an abitrary descriptorType. This allows you to
check if desc is truly an AERecord
************************************************************************/
/*
* AECheckIsRecord()
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.4 and later
* Non-Carbon CFM: not available
*/
extern Boolean
AECheckIsRecord(const AEDesc * theDesc) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
Note: The following #defines map "key" calls on AERecords into "param" calls on
AppleEvents. Although no errors are currently returned if AERecords are
passed to "param" calls and AppleEvents to "key" calls, the behavior of
this type of API-mixing is not explicitly documented in Inside Macintosh.
It just happens that the "key" calls have the same functionality as their
"param" counterparts. Since none of the "key" calls are currently available
in the PowerPC IntefaceLib, the #defines exploit the fact that "key" and
"param" routines can be used interchangeably, and makes sure that every
invocation of a "key" API becomes an invocation of a "param" API.
*/
#define AEPutKeyPtr(theAERecord, theAEKeyword, typeCode, dataPtr, dataSize) \
AEPutParamPtr((theAERecord), (theAEKeyword), (typeCode), (dataPtr), (dataSize))
#define AEPutKeyDesc(theAERecord, theAEKeyword, theAEDesc) \
AEPutParamDesc((theAERecord), (theAEKeyword), (theAEDesc))
#define AEGetKeyPtr(theAERecord, theAEKeyword, desiredType, typeCode, dataPtr, maxSize, actualSize) \
AEGetParamPtr((theAERecord), (theAEKeyword), (desiredType), (typeCode), (dataPtr), (maxSize), (actualSize))
#define AEGetKeyDesc(theAERecord, theAEKeyword, desiredType, result) \
AEGetParamDesc((theAERecord), (theAEKeyword), (desiredType), (result))
#define AESizeOfKeyDesc(theAERecord, theAEKeyword, typeCode, dataSize) \
AESizeOfParam((theAERecord), (theAEKeyword), (typeCode), (dataSize))
#define AEDeleteKeyDesc(theAERecord, theAEKeyword) \
AEDeleteParam((theAERecord), (theAEKeyword))
/**************************************************************************
The following calls create and manipulate the AppleEvent data type.
**************************************************************************/
/*
* AECreateAppleEvent()
*
* Summary:
* Creates an Apple event with several important attributes but no
* parameters.
*
* Discussion:
* The AECreateAppleEvent function creates an empty Apple event. You
* can add parameters to the Apple event after you create it with
* the functions described in "Adding Parameters and Attributes to
* an Apple Event".
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* theAEEventClass:
* The event class of the Apple event to create. This parameter
* becomes accessible through the keyEventClassAttr attribute of
* the Apple event. Some event classes are described in "Event
* Class Constants".
*
* theAEEventID:
* The event ID of the Apple event to create. This parameter
* becomes accessible through the keyEventIDAttr attribute of the
* Apple event.
*
* target:
* A pointer to an address descriptor. Before calling
* AECreateAppleEvent, you set the descriptor to identify the
* target (or server) application for the Apple event. This
* parameter becomes accessible through the keyAddressAttr
* attribute of the Apple event.
*
* returnID:
* The return ID for the created Apple event. If you pass a value
* of kAutoGenerateReturnID, the Apple Event Manager assigns the
* created Apple event a return ID that is unique to the current
* session. If you pass any other value, the Apple Event Manager
* assigns that value for the ID. This parameter becomes
* accessible through the keyReturnIDAttr attribute of the Apple
* event. The return ID constant is described in "ID Constants for
* the AECreateAppleEvent Function".
*
* transactionID:
* The transaction ID for this Apple event. A transaction is a
* sequence of Apple events that are sent back and forth between
* the client and server applications, beginning with the client's
* initial request for a service. All Apple events that are part
* of a transaction must have the same transaction ID. You can
* specify the kAnyTransactionID constant if the Apple event is
* not one of a series of interdependent Apple events. This
* parameter becomes accessible through the keyTransactionIDAttr
* attribute of the Apple event.
*
* result:
* A pointer to an Apple event. On successful return, the new
* Apple event. On error, a null descriptor (one with descriptor
* type typeNull). If the function returns successfully, your
* application should call the AEDisposeDesc function to dispose
* of the resulting Apple event after it has finished using it.
* See the AppleEvent data type.
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
AECreateAppleEvent(
AEEventClass theAEEventClass,
AEEventID theAEEventID,
const AEAddressDesc * target, /* can be NULL */
AEReturnID returnID,
AETransactionID transactionID,
AppleEvent * result) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/**************************************************************************
The following calls are used to pack and unpack parameters from records
of type AppleEvent. Since AppleEvent is a subtype of AERecord, the calls
in the previous sections can also be used for variables of type
AppleEvent. The next six calls are in fact identical to the six calls
for AERecord.
**************************************************************************/
/*
* AEPutParamPtr()
*
* Discussion:
* Puts a pointer to data, a descriptor type, and a keyword into an
* Apple event or Apple event record as an Apple event parameter.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* theAppleEvent:
* A pointer to the Apple event to add a parameter to. See the
* AppleEvent data type.
*
* theAEKeyword:
* The keyword for the parameter to add. If the Apple event
* already includes an parameter with this keyword, the parameter
* is replaced.
*
* typeCode:
* The descriptor type for the parameter to add.
*
* dataPtr:
* A pointer to the data for the parameter to add.
*
* dataSize:
* The length, in bytes, of the data for the parameter to add.
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
AEPutParamPtr(
AppleEvent * theAppleEvent,
AEKeyword theAEKeyword,
DescType typeCode,
const void * dataPtr,
Size dataSize) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AEPutParamDesc()
*
* Discussion:
* Puts a descriptor and a keyword into an Apple event or Apple
* event record as an Apple event parameter.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* theAppleEvent:
* A pointer to the Apple event to add a parameter to.
*
* theAEKeyword:
* The keyword specifying the parameter to add. If the Apple event
* already has a parameter with this keyword, the parameter is
* replaced.
*
* theAEDesc:
* A pointer to the descriptor for the parameter to add. See
* AEDesc.
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
AEPutParamDesc(
AppleEvent * theAppleEvent,
AEKeyword theAEKeyword,
const AEDesc * theAEDesc) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AEGetParamPtr()
*
* Summary:
* Gets a copy of the data for a specified Apple event parameter
* from an Apple event or an Apple event record (type AERecord);
* typically used when your application needs to work with the
* extracted data directly.
*
* Discussion:
* You should use this function only to extract data from value
* descriptors such as typeUTF8Text.
* Because this function allows you to specify a desired type, it
* can result in coercion. When used correctly, this has the
* positive effect of returning the data in the desired format.
* However, it can have side effects you may not be expecting, such
* as the overhead of calls to coercion handlers. See also the
* Version Notes section below for possible problems with
* coercion.
* To get Apple event parameter data for your application to use
* directly, call AEGetParamPtr. To get a descriptor for an Apple
* event parameter to pass on to another Apple Event Manager
* routine, call AEGetParamDesc.
* Before calling AEGetParamPtr, you can call the AESizeOfParam
* function to determine a size for the dataPtr buffer. However,
* unless you specify typeWildCard for the desiredType parameter,
* AEGetParamPtr may coerce the data, which may cause the size of
* the data to change.
* In some cases, you may get improved efficiency extracting
* information from an Apple event with the AEGetDescDataRange
* function.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* theAppleEvent:
* A pointer to the Apple event to get the parameter data from.
* See AppleEvent.
*
* theAEKeyword:
* The keyword that specifies the desired Apple event parameter.
*
* desiredType:
* The desired descriptor type for the copied data. If the
* descriptor specified by the theAEKeyword parameter is not of
* the desired type, AEGetParamPtr attempts to coerce the data to
* this type. However, if the desired type is typeWildCard, no
* coercion is performed. On return, you can determine the actual
* descriptor type by examining the typeCode parameter.
*
* actualType:
* A pointer to a descriptor type. On return, specifies the
* descriptor type of the data pointed to by dataPtr. The returned
* type is either the same as the type specified by the
* desiredType parameter or, if the desired type was typeWildcard,
* the true type of the descriptor. Specify NULL if you do not
* care about this return value.
*
* dataPtr:
* A pointer to a buffer, local variable, or other storage
* location created and disposed of by your application. The size
* in bytes must be at least as large as the value you pass in the
* maximumSize parameter. On return, contains the parameter data.
* Specify NULL if you do not care about this return value.
*
* maximumSize:
* The maximum length, in bytes, of the expected Apple event
* parameter data. The AEGetParamPtr function will not return more
* data than you specify in this parameter.
*
* actualSize:
* A pointer to a variable of type Size. On return, the length, in
* bytes, of the data for the specified Apple event parameter. If
* this value is larger than the value you passed in the
* maximumSize parameter, the buffer pointed to by dataPtr was not
* large enough to contain all of the data for the parameter,
* though AEGetParamPtr does not write beyond the end of the
* buffer. If the buffer was too small, you can resize it and call
* AEGetParamPtr again. Specify NULL if you do not care about this
* return value.
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
AEGetParamPtr(
const AppleEvent * theAppleEvent,
AEKeyword theAEKeyword,
DescType desiredType,
DescType * actualType, /* can be NULL */
void * dataPtr,
Size maximumSize,
Size * actualSize) /* can be NULL */ API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AEGetParamDesc()
*
* Summary:
* Gets a copy of the descriptor for a keyword-specified Apple event
* parameter from an Apple event or an Apple event record (type
* AERecord); typically used when your application needs to pass the
* extracted data to another function as a descriptor.
*
* Discussion:
* To get Apple event parameter data for your application to use
* directly, call AEGetParamPtr. To get a descriptor for an Apple
* event parameter to pass on to another Apple Event Manager
* routine, call AEGetParamDesc.
* If the actual parameter you are getting with AEGetParamDesc is a
* record, AEGetParamDesc will only allow you to request it as a
* typeAERecord, typeAEList, or typeWildcard. For any other type, it
* will return errAECoercionFail.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* theAppleEvent:
* A pointer to the Apple event to get the parameter descriptor
* from.
*
* theAEKeyword:
* A keyword that specifies the desired Apple event parameter.
*
* desiredType:
* The descriptor type for the desired Apple event parameter. If
* the requested Apple event parameter is not of the desired type,
* the Apple Event Manager attempts to coerce it to the desired
* type. However, if you pass a value of typeWildCard, no coercion
* is performed, and the descriptor type of the returned
* descriptor is the same as the descriptor type of the Apple
* event parameter.
*
* result:
* A pointer to a descriptor. On successful return, a copy of the
* descriptor for the specified Apple event parameter, coerced, if
* necessary, to the descriptor type specified by the desiredType
* parameter. On error, a null descriptor. If the function returns
* successfully, your application should call the AEDisposeDesc
* function to dispose of the resulting descriptor after it has
* finished using it. See AEDesc.
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
AEGetParamDesc(
const AppleEvent * theAppleEvent,
AEKeyword theAEKeyword,
DescType desiredType,
AEDesc * result) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AESizeOfParam()
*
* Discussion:
* Gets the size and descriptor type of an Apple event parameter
* from a descriptor of type AERecord or AppleEvent.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* theAppleEvent:
* A pointer to the Apple event to get the parameter data from.
* See AppleEvent.
*
* theAEKeyword:
* The keyword that specifies the desired parameter.
*
* typeCode:
* A pointer to a descriptor type. On return, specifies the
* descriptor type of the Apple event parameter.
*
* dataSize:
* A pointer to a size variable. On return, the length, in bytes,
* of the data in the Apple event parameter.
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
AESizeOfParam(
const AppleEvent * theAppleEvent,
AEKeyword theAEKeyword,
DescType * typeCode, /* can be NULL */
Size * dataSize) /* can be NULL */ API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AEDeleteParam()
*
* Discussion:
* Deletes a keyword-specified parameter from an Apple event or
* Apple event record.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* theAppleEvent:
* A pointer to the Apple event or Apple event record to delete
* the parameter from.
*
* theAEKeyword:
* The keyword that specifies the parameter to delete.
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
AEDeleteParam(
AppleEvent * theAppleEvent,
AEKeyword theAEKeyword) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/**************************************************************************
The following calls also apply to type AppleEvent. Message attributes are
far more restricted, and can only be accessed through the following 5
calls. The various list and record routines cannot be used to access the
attributes of an event.
**************************************************************************/
/*
* AEGetAttributePtr()
*
* Summary:
* Gets a copy of the data for a specified Apple event attribute
* from an Apple event; typically used when your application needs
* to work with the data directly.
*
* Discussion:
* To get Apple event attribute data for your application to use
* directly, call AEGetAttributePtr. To get a descriptor for an
* Apple event attribute to pass on to another Apple Event Manager
* routine, call AEGetAttributeDesc.
* Before calling AEGetAttributePtr, you can call the
* AESizeOfAttribute function to determine a size for the dataPtr
* buffer. However, unless you specify typeWildCard for the
* desiredType parameter, AEGetAttributePtr may coerce the data,
* which may cause the size of the data to change.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* theAppleEvent:
* A pointer to the Apple event to get the attribute data from.
*
* theAEKeyword:
* The keyword that specifies the desired attribute.
*
* desiredType:
* The desired descriptor type for the copied data. If the
* descriptor specified by the theAEKeyword parameter is not of
* the desired type, AEGetAttributePtr attempts to coerce the data
* to this type. However, if you pass a value of typeWildCard, no
* coercion is performed, and the descriptor type of the returned
* data is the same as the descriptor type of the Apple event
* attribute. On return, you can determine the actual descriptor
* type by examining the typeCode parameter.
*
* typeCode:
* A pointer to a descriptor type. On return, specifies the
* descriptor type of the attribute data pointed to by dataPtr.
* The returned type is either the same as the type specified by
* the desiredType parameter or, if the desired type was type
* wildcard, the true type of the descriptor. For a list of
* AppleScript's predefined descriptor types, see "Descriptor Type
* Constants". See DescType.
*
* dataPtr:
* A pointer to a buffer, local variable, or other storage
* location, created and disposed of by your application. The size
* in bytes must be at least as large as the value you pass in the
* maximumSize parameter. On return, contains the attribute data.
*
* maximumSize:
* The maximum length, in bytes, of the expected attribute data.
* The AEGetAttributePtr function will not return more data than
* you specify in this parameter.
*
* actualSize:
* A pointer to a size variable. On return, the length, in bytes,
* of the data for the specified Apple event attribute. If this
* value is larger than the value you passed in the maximumSize
* parameter, the buffer pointed to by dataPtr was not large
* enough to contain all of the data for the attribute, though
* AEGetAttributePtr does not write beyond the end of the buffer.
* If the buffer was too small, you can resize it and call
* AEGetAttributePtr again.
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
AEGetAttributePtr(
const AppleEvent * theAppleEvent,
AEKeyword theAEKeyword,
DescType desiredType,
DescType * typeCode, /* can be NULL */
void * dataPtr,
Size maximumSize,
Size * actualSize) /* can be NULL */ API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AEGetAttributeDesc()
*
* Summary:
* Gets a copy of the descriptor for a specified Apple event
* attribute from an Apple event; typically used when your
* application needs to pass the descriptor on to another function.
*
* Discussion:
* To get Apple event attribute data for your application to use
* directly, call AEGetAttributePtr. To get a descriptor for an
* Apple event attribute to pass on to another Apple Event Manager
* routine, call AEGetAttributeDesc.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* theAppleEvent:
* A pointer to the Apple event to get the attribute descriptor
* from. See AppleEvent.
*
* theAEKeyword:
* The keyword that specifies the desired attribute.
*
* desiredType:
* The desired descriptor type for the copied data. If the
* descriptor specified by the theAEKeyword parameter is not of
* the desired type, AEGetAttributePtr attempts to coerce the data
* to this type. However, if you pass a value of typeWildCard, no
* coercion is performed, and the descriptor type of the returned
* data is the same as the descriptor type of the Apple event
* attribute. On return, you can determine the actual descriptor
* type by examining the typeCode parameter.
*
* result:
* A pointer to a descriptor. On successful return, a copy of the
* specified Apple event attribute, coerced, if necessary, to the
* descriptor type specified in desiredType. On error, a null
* descriptor. If the function returns successfully, your
* application should call the AEDisposeDesc function to dispose
* of the resulting descriptor after it has finished using it. See
* AEDesc.
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
AEGetAttributeDesc(
const AppleEvent * theAppleEvent,
AEKeyword theAEKeyword,
DescType desiredType,
AEDesc * result) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AESizeOfAttribute()
*
* Discussion:
* Gets the size and descriptor type of an Apple event attribute
* from a descriptor of type AppleEvent.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* theAppleEvent:
* A pointer to the Apple event to get the attribute data from.
*
* theAEKeyword:
* The keyword that specifies the attribute.
*
* typeCode:
* A pointer to a descriptor type. On return, specifies the
* descriptor type of the attribute. Can be NULL.
*
* dataSize:
* A pointer to a size variable. On return, the length, in bytes,
* of the data in the attribute. Can be NULL.
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
AESizeOfAttribute(
const AppleEvent * theAppleEvent,
AEKeyword theAEKeyword,
DescType * typeCode, /* can be NULL */
Size * dataSize) /* can be NULL */ API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AEPutAttributePtr()
*
* Discussion:
* Adds a pointer to data, a descriptor type, and a keyword to an
* Apple event as an attribute.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* theAppleEvent:
* A pointer to the Apple event to add an attribute to. See the
* AppleEvent data type.
*
* theAEKeyword:
* The keyword for the attribute to add. If the Apple event
* already includes an attribute with this keyword, the attribute
* is replaced.
*
* typeCode:
* The descriptor type for the attribute to add.
*
* dataPtr:
* A pointer to the data for the attribute to add.
*
* dataSize:
* The length, in bytes, of the data for the attribute to add.
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
AEPutAttributePtr(
AppleEvent * theAppleEvent,
AEKeyword theAEKeyword,
DescType typeCode,
const void * dataPtr,
Size dataSize) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AEPutAttributeDesc()
*
* Summary:
* Adds a descriptor and a keyword to an Apple event as an attribute.
*
* Discussion:
* The AEPutAttributeDesc function takes a descriptor and a keyword
* and adds them to an Apple event as an attribute. If the
* descriptor type required for the attribute is different from the
* descriptor type of the descriptor, the Apple Event Manager
* attempts to coerce the descriptor into the required type, with
* one exception: the Apple Event Manager does not attempt to coerce
* the data for an address attribute, thereby allowing applications
* to use their own address types.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* theAppleEvent:
* A pointer to the Apple event to add an attribute to. See the
* AppleEvent data type.
*
* theAEKeyword:
* The keyword for the attribute to add. If the Apple event
* already includes an attribute with this keyword, the attribute
* is replaced.
*
* theAEDesc:
* A pointer to the descriptor to assign to the attribute. The
* descriptor type of the specified descriptor should match the
* defined descriptor type for that attribute.
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern OSErr
AEPutAttributeDesc(
AppleEvent * theAppleEvent,
AEKeyword theAEKeyword,
const AEDesc * theAEDesc) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/**************************************************************************
AppleEvent Serialization Support
AESizeOfFlattenedDesc, AEFlattenDesc, AEUnflattenDesc
These calls will work for all AppleEvent data types and between different
versions of the OS (including between Mac OS 9 and X)
Basic types, AEDesc, AEList and AERecord are OK, but AppleEvent records
themselves may not be reliably flattened for storage.
**************************************************************************/
/*
* AESizeOfFlattenedDesc()
*
* Discussion:
* Returns the amount of buffer space needed to flatten the AEDesc.
* Call this before AEFlattenDesc to make sure your buffer has
* enough room for the operation.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* theAEDesc:
* A pointer to the descriptor to be flattened.
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.4 and later
* Non-Carbon CFM: not available
*/
extern Size
AESizeOfFlattenedDesc(const AEDesc * theAEDesc) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AEFlattenDesc()
*
* Discussion:
* Fills a buffer with a flattened representation of the AEDesc and
* returns the amount of buffer used in actualSize. If bufferSize
* was too small it returns errAEBufferTooSmall (-1741) and does not
* fill in any of the buffer. The resulting buffer is only useful
* with an AEUnflattenDescFromBytes call.
* Note: if you pass a NULL buffer pointer it returns noErr but
* fills in the actualSize field anyway.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* theAEDesc:
* A pointer to the descriptor to be flattened.
*
* buffer:
* A pointer to memory, allocated by the application, where the
* flattened data will be stored. See the bufferSize parameter for
* information on how large a buffer you should allocate.
*
* bufferSize:
* The size of the buffer pointed to by buffer. Prior to calling
* AEFlattenDesc, you call the AESizeOfFlattenedDesc function to
* determine the required size of the buffer for the flatten
* operation.
* If bufferSize is too small, AEFlattenDesc returns
* errAEBufferTooSmall and doesn't store any data in the buffer.
*
* actualSize:
* A pointer to a size variable. On return, the variable contains
* the actual size of the flattened data. You can specify NULL for
* this parameter if you do not care about the returned size.
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.4 and later
* Non-Carbon CFM: not available
*/
extern OSStatus
AEFlattenDesc(
const AEDesc * theAEDesc,
Ptr buffer,
Size bufferSize,
Size * actualSize) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
extern OSStatus
AEUnflattenDesc(
const void * buffer,
AEDesc * result) API_DEPRECATED_WITH_REPLACEMENT("AEUnflattenDescFromBytes", macos(10.0,11.0)) API_UNAVAILABLE( ios, tvos, watchos );
/**
* Allocates an AEDesc (given a Null Desc) constructed from a flattened data
* buffer produced by calling AEFlattenDesc.
*
* @param buffer A pointer to data produced by `AEFlattenDesc`
* @param bufferLen The size of the data referenced by `buffer`
* @param result On successful completion, a pointer to an `AEDesc*` containing the unflattened descriptor. The caller is responsible for disposing of it.
* @return `noErr` on success, `paramErr` if the buffer could not be parsed, or `memFullErr` for irrational memory sizes.
*/
extern OSStatus AEUnflattenDescFromBytes( const void* buffer, size_t bufferLen, AEDesc* result ) API_AVAILABLE( macos(11.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/**************************************************************************
The following calls are necessary to deal with opaque data in AEDescs, because the
traditional way of dealing with a basic AEDesc has been to dereference the dataHandle
directly. This is not supported under Carbon.
**************************************************************************/
/*
* AEGetDescData()
*
* Discussion:
* Gets the data from the specified descriptor. AEGetDescData no
* longer supports automatic coercion. If you'd like to coerce the
* descriptor use AECoerceDesc.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* theAEDesc:
* A pointer to the descriptor to get the data from.
*
* dataPtr:
* A pointer to a buffer, local variable, or other storage
* location created and disposed of by your application. The size
* in bytes should be the same as the value you pass in the
* maximumSize parameter. On return, contains the data from the
* descriptor.
*
* maximumSize:
* The length, in bytes, of the expected descriptor data. The
* AEGetDescData function will not return more data than you
* specify in this parameter. You typically determine the maximum
* size by calling AEGetDescDataSize.
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CarbonAccessors.o 1.0 and later
*/
extern OSErr
AEGetDescData(
const AEDesc * theAEDesc,
void * dataPtr,
Size maximumSize) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AEGetDescDataSize()
*
* Discussion:
* Gets the size, in bytes, of the data in the specified descriptor.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* theAEDesc:
* A pointer to the descriptor to obtain the data size for. See
* AEDesc.
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CarbonAccessors.o 1.0 and later
*/
extern Size
AEGetDescDataSize(const AEDesc * theAEDesc) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AEReplaceDescData()
*
* Discussion:
* Copies the specified data into the specified descriptor,
* replacing any previous data.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* typeCode:
* Specifies the descriptor type of the data pointed to by dataPtr.
*
* dataPtr:
* A pointer to the data to store in the specified descriptor.
*
* dataSize:
* The size, in bytes, of the data pointed to by the dataSize
* parameter.
*
* theAEDesc:
* A pointer to a descriptor. On return, contains the copied data.
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in CarbonAccessors.o 1.0 and later
*/
extern OSErr
AEReplaceDescData(
DescType typeCode,
const void * dataPtr,
Size dataSize,
AEDesc * theAEDesc) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* AEGetDescDataRange()
*
* Discussion:
* Retrieve a range of bytes from an AEDesc. This obviates the need
* to retrieve the entire data from the event using AEGetDescData.
* This is only valid for data type AEDescs. If the requested
* length and offset are such that they do not fit entirely with the
* data of the desc, errAEBufferTooSmall is returned.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* dataDesc:
* A pointer to the descriptor to get the data from.
*
* buffer:
* A pointer to a buffer, local variable, or other storage
* location created and disposed of by your application. The size
* in bytes should be at least as large as the value you pass in
* the length parameter. On return, contains the specified data
* from the descriptor.
*
* offset:
* The zero-based offset to the data to be retrieved from the
* descriptor.
*
* length:
* The number of bytes of contiguous data to retrieve.
*
* Availability:
* Mac OS X: in version 10.2 and later in ApplicationServices.framework
* CarbonLib: not available in CarbonLib 1.x, is available on Mac OS X version 10.2 and later
* Non-Carbon CFM: not available
*/
extern OSStatus
AEGetDescDataRange(
const AEDesc * dataDesc,
void * buffer,
Size offset,
Size length) API_AVAILABLE( macos(10.2) ) API_UNAVAILABLE( ios, tvos, watchos );
/**************************************************************************
A AEEventHandler is installed to process an AppleEvent
**************************************************************************/
typedef CALLBACK_API( OSErr , AEEventHandlerProcPtr )(const AppleEvent *theAppleEvent, AppleEvent *reply, SRefCon handlerRefcon);
typedef STACK_UPP_TYPE(AEEventHandlerProcPtr) AEEventHandlerUPP;
/*
* NewAEDisposeExternalUPP()
*
* Availability:
* Mac OS X: in version 10.2 and later in ApplicationServices.framework
* CarbonLib: not available in CarbonLib 1.x, is available on Mac OS X version 10.2 and later
* Non-Carbon CFM: available as macro/inline
*/
extern AEDisposeExternalUPP
NewAEDisposeExternalUPP(AEDisposeExternalProcPtr userRoutine) API_AVAILABLE( macos(10.2) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* NewAEEventHandlerUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern AEEventHandlerUPP
NewAEEventHandlerUPP(AEEventHandlerProcPtr userRoutine) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* DisposeAEDisposeExternalUPP()
*
* Availability:
* Mac OS X: in version 10.2 and later in ApplicationServices.framework
* CarbonLib: not available in CarbonLib 1.x, is available on Mac OS X version 10.2 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
DisposeAEDisposeExternalUPP(AEDisposeExternalUPP userUPP) API_AVAILABLE( macos(10.2) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* DisposeAEEventHandlerUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
DisposeAEEventHandlerUPP(AEEventHandlerUPP userUPP) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* InvokeAEDisposeExternalUPP()
*
* Availability:
* Mac OS X: in version 10.2 and later in ApplicationServices.framework
* CarbonLib: not available in CarbonLib 1.x, is available on Mac OS X version 10.2 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
InvokeAEDisposeExternalUPP(
const void * dataPtr,
Size dataLength,
SRefCon refcon,
AEDisposeExternalUPP userUPP) API_AVAILABLE( macos(10.2) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* InvokeAEEventHandlerUPP()
*
* Availability:
* Mac OS X: in version 10.0 and later in ApplicationServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern OSErr
InvokeAEEventHandlerUPP(
const AppleEvent * theAppleEvent,
AppleEvent * reply,
SRefCon handlerRefcon,
AEEventHandlerUPP userUPP) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
#if __MACH__
#ifdef __cplusplus
inline AEDisposeExternalUPP NewAEDisposeExternalUPP(AEDisposeExternalProcPtr userRoutine) { return userRoutine; }
inline AEEventHandlerUPP NewAEEventHandlerUPP(AEEventHandlerProcPtr userRoutine) { return userRoutine; }
inline void DisposeAEDisposeExternalUPP(AEDisposeExternalUPP) { }
inline void DisposeAEEventHandlerUPP(AEEventHandlerUPP) { }
inline void InvokeAEDisposeExternalUPP(const void * dataPtr, Size dataLength, SRefCon refcon, AEDisposeExternalUPP userUPP) { (*userUPP)(dataPtr, dataLength, refcon); }
inline OSErr InvokeAEEventHandlerUPP(const AppleEvent * theAppleEvent, AppleEvent * reply, SRefCon handlerRefcon, AEEventHandlerUPP userUPP) { return (*userUPP)(theAppleEvent, reply, handlerRefcon); }
#else
#define NewAEDisposeExternalUPP(userRoutine) ((AEDisposeExternalUPP)userRoutine)
#define NewAEEventHandlerUPP(userRoutine) ((AEEventHandlerUPP)userRoutine)
#define DisposeAEDisposeExternalUPP(userUPP)
#define DisposeAEEventHandlerUPP(userUPP)
#define InvokeAEDisposeExternalUPP(dataPtr, dataLength, refcon, userUPP) (*userUPP)(dataPtr, dataLength, refcon)
#define InvokeAEEventHandlerUPP(theAppleEvent, reply, handlerRefcon, userUPP) (*userUPP)(theAppleEvent, reply, handlerRefcon)
#endif
#endif
#pragma pack(pop)
#ifdef __cplusplus
}
#endif
#endif /* __AEDATAMODEL__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/FSEvents.framework/FSEvents.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: 542109F0-F83B-3DBC-A947-66C18148446D
- target: x86_64-maccatalyst
value: 542109F0-F83B-3DBC-A947-66C18148446D
- target: arm64-macos
value: 00000000-0000-0000-0000-000000000000
- target: arm64-maccatalyst
value: 00000000-0000-0000-0000-000000000000
- target: arm64e-macos
value: 4FF8C103-0BBC-313E-8FED-3A5964439A4E
- target: arm64e-maccatalyst
value: 4FF8C103-0BBC-313E-8FED-3A5964439A4E
install-name: '/System/Library/Frameworks/CoreServices.framework/Versions/A/Frameworks/FSEvents.framework/Versions/A/FSEvents'
current-version: 1325.0.7
parent-umbrella:
- targets: [ x86_64-macos, x86_64-maccatalyst, arm64-macos, arm64-maccatalyst,
arm64e-macos, arm64e-maccatalyst ]
umbrella: CoreServices
exports:
- targets: [ x86_64-maccatalyst, x86_64-macos, arm64e-maccatalyst, arm64e-macos,
arm64-macos, arm64-maccatalyst ]
symbols: [ _FSEventStreamCopyDescription, _FSEventStreamCopyPathsBeingWatched,
_FSEventStreamCreate, _FSEventStreamCreateRelativeToDevice,
_FSEventStreamFlushAsync, _FSEventStreamFlushSync, _FSEventStreamGetDeviceBeingWatched,
_FSEventStreamGetLatestEventId, _FSEventStreamInvalidate,
_FSEventStreamRelease, _FSEventStreamRetain, _FSEventStreamScheduleWithRunLoop,
_FSEventStreamSetDispatchQueue, _FSEventStreamSetExclusionPaths,
_FSEventStreamShow, _FSEventStreamStart, _FSEventStreamStop,
_FSEventStreamUnscheduleFromRunLoop, _FSEventsCopyUUIDForDevice,
_FSEventsGetCurrentEventId, _FSEventsGetLastEventIdForDeviceBeforeTime,
_FSEventsPurgeEventsForDeviceUpToEventId ]
...
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/FSEvents.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/FSEvents.framework/Headers/FSEvents.h | /*
File: FSEvents/FSEvents.h
Contains: FSEventStream API
Copyright: © 2006-2014 by Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __FSEVENTS__
#define __FSEVENTS__
#ifndef __CFRUNLOOP__
#include <CoreFoundation/CFRunLoop.h>
#endif
#ifndef __CFUUID__
#include <CoreFoundation/CFUUID.h>
#endif
#include <Block.h>
#include <dispatch/dispatch.h>
#include <sys/types.h>
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
CF_ASSUME_NONNULL_BEGIN
#pragma pack(push, 2)
#if PRAGMA_ENUM_ALWAYSINT
#pragma enumsalwaysint on
#endif
/*
*
*
* Discussion:
* This header describes the FSEvents API. This API provides a
* mechanism to notify clients about directories they ought to
* re-scan in order to keep their internal data structures
* up-to-date with respect to the true state of the file system.
* (For example, when files or directories are created, modified, or
* removed.) It sends these notifications "in bulk", possibly
* notifying the client of changes to several directories in a
* single callback. By using the API, clients can notice such
* changes quickly, without needing to resort to recursive
* polling/scanning of the file system.
*
* Much like kqueues, the FSEvents API allows an application to find
* near-immediately when the contents of a particular directory has
* changed. However, unlike kqueues, the FSEvents API allows the
* application to monitor the whole file system hierarchy rooted at
* a specified directory (and still get precise per-directory
* notifications) -- to do this with the kqueues API would require
* the client to monitor each directory individually.
*
* Clients can register interest in a chunk of the filesystem
* hierarchy and will receive callbacks from their runloop whenever
* an event occurs that modifies the filesystem therein. The
* callback will indicate the exact directory in which the event
* occurred, so the client only has to scan that directory for
* updated info, not all its children. Clients can supply a
* "latency" parameter that tells how long to wait after an event
* occurs before forwarding it; this reduces the volume of events
* and reduces the chance that the client will see an "intermediate"
* state, like those that arise when doing a "safe save" of a file,
* creating a package, or downloading a file via Safari.
*
*
*
* The lifecycle of an FSEventStream consists of these stages:
*
*
* 1. FSEventStreamCreate() / FSEventStreamCreateRelativeToDevice()
* -> Creates an FSEventStream.
*
* 2. FSEventStreamScheduleWithRunLoop() -> Schedules an
* FSEventStream on a runloop, like CFRunLoopAddSource() does for a
* CFRunLoopSourceRef.
*
* 3. FSEventStreamStart() -> Starts receiving events and servicing
* them from the client's runloop(s) using the callback supplied by
* the client when the stream was created. If a value was supplied
* for the sinceWhen parameter then "historical" events will be sent
* via your callback first, then a HistoryDone event, then
* "contemporary" events will be sent on an ongoing basis (as though
* you had supplied kFSEventStreamEventIdSinceNow for sinceWhen).
*
*
* 4. FSEventStreamStop() -> Stops the stream, ensuring the
* client's callback will not be called again for this stream.
* After stopping the stream, it can be restarted seamlessly via
* FSEventStreamStart() without missing any events.
*
* 5. FSEventStreamInvalidate() -> Invalidates the stream, like
* CFRunLoopSourceInvalidate() does for a CFRunLoopSourcRef.
*
*
* 6. FSEventStreamRelease() -> Decrements the refcount on the
* stream (initially one and incremented via FSEventStreamRetain()).
* If the refcount reaches zero, the stream is deallocated.
*
*
* Once the event stream has been started, the following calls can
* be used:
*
* FSEventStreamGetLatestEventId() -> Initially, this returns the
* sinceWhen value supplied when the stream was created; thereafter,
* it is updated with the highest-numbered event ID mentioned in the
* current batch of events just before invoking the client's
* callback. Clients can store this value persistently as long as
* they also store the UUID for the device (obtained via
* FSEventsCopyUUIDForDevice()). Clients can then later supply this
* event ID as the sinceWhen parameter to
* FSEventStreamCreateRelativeToDevice(), as long as its UUID
* matches what you stored. This works because the FSEvents service
* stores events in a persistent, per-volume database. In this
* regard,the stream of event IDs acts like a global, system-wide
* clock, but bears no relation to any particular timebase.
*
* FSEventStreamFlushAsync() -> Requests that the fseventsd daemon
* send any events it has already buffered (via the latency
* parameter to one of the FSEventStreamCreate...() functions). This
* occurs asynchronously; clients will not have received all the
* callbacks by the time this call returns to them.
*
* FSEventStreamFlushSync() -> Requests that the fseventsd daemon
* send any events it has already buffered (via the latency
* parameter to one of the FSEventStreamCreate...() functions). Then
* runs the runloop in its private mode till all events that have
* occurred have been reported (via the clients callback). This
* occurs synchronously; clients will have received all the
* callbacks by the time this call returns to them.
*
* FSEventStreamGetDeviceBeingWatched() -> Gets the dev_t value
* supplied when the stream was created with
* FSEventStreamCreateRelativeToDevice(), otherwise 0.
*
* FSEventStreamCopyPathsBeingWatched() -> Gets the paths supplied
* when the stream was created with one of the
* FSEventStreamCreate...() functions.
*
* Calls that can be made without a stream:
*
* FSEventsCopyUUIDForDevice() -> Gets a UUID that uniquely
* identifies the FSEvents database for that volume. If the database
* gets discarded then its replacement will have a different UUID so
* that clients will be able to detect this situation and avoid
* trying to use event IDs that they stored as the sinceWhen
* parameter to the FSEventStreamCreate...() functions.
*
* FSEventsGetCurrentEventId() -> Gets the most recently generated
* event ID, system-wide (not just for one stream).
*
* FSEventsGetLastEventIdForDeviceBeforeTime() -> Gets the last
* event ID for the given device that was returned before the given
* time. This is conservative in the sense that if you then use the
* returned event ID as the sinceWhen parameter of
* FSEventStreamCreateRelativeToDevice() that you will not miss any
* events that happened since that time. On the other hand, you
* might receive some (harmless) extra events.
*
* FSEventsPurgeEventsForDeviceUpToEventId() -> Purges old events
* from the persistent per-volume database maintained by the
* service. You can combine this with
* FSEventsGetLastEventIdForDeviceBeforeTime(). Can only be called
* by the root user.
*/
/*
* Types and Constants
*/
/*
* FSEventStreamCreateFlags
*
* Discussion:
* Flags that can be passed to the FSEventStreamCreate...()
* functions to modify the behavior of the stream being created.
*/
typedef UInt32 FSEventStreamCreateFlags;
/*
* FSEventStreamCreateFlags
*
* Discussion:
* Flags that can be passed to the FSEventStreamCreate...()
* functions to modify the behavior of the stream being created.
*/
enum {
/*
* The default.
*/
kFSEventStreamCreateFlagNone = 0x00000000,
/*
* The framework will invoke your callback function with CF types
* rather than raw C types (i.e., a CFArrayRef of CFStringRefs,
* rather than a raw C array of raw C string pointers). See
* FSEventStreamCallback.
*/
kFSEventStreamCreateFlagUseCFTypes = 0x00000001,
/*
* Affects the meaning of the latency parameter. If you specify this
* flag and more than latency seconds have elapsed since the last
* event, your app will receive the event immediately. The delivery
* of the event resets the latency timer and any further events will
* be delivered after latency seconds have elapsed. This flag is
* useful for apps that are interactive and want to react immediately
* to changes but avoid getting swamped by notifications when changes
* are occurringin rapid succession. If you do not specify this flag,
* then when an event occurs after a period of no events, the latency
* timer is started. Any events that occur during the next latency
* seconds will be delivered as one group (including that first
* event). The delivery of the group of events resets the latency
* timer and any further events will be delivered after latency
* seconds. This is the default behavior and is more appropriate for
* background, daemon or batch processing apps.
*/
kFSEventStreamCreateFlagNoDefer = 0x00000002,
/*
* Request notifications of changes along the path to the path(s)
* you're watching. For example, with this flag, if you watch
* "/foo/bar" and it is renamed to "/foo/bar.old", you would receive
* a RootChanged event. The same is true if the directory "/foo" were
* renamed. The event you receive is a special event: the path for
* the event is the original path you specified, the flag
* kFSEventStreamEventFlagRootChanged is set and event ID is zero.
* RootChanged events are useful to indicate that you should rescan a
* particular hierarchy because it changed completely (as opposed to
* the things inside of it changing). If you want to track the
* current location of a directory, it is best to open the directory
* before creating the stream so that you have a file descriptor for
* it and can issue an F_GETPATH fcntl() to find the current path.
*/
kFSEventStreamCreateFlagWatchRoot = 0x00000004,
/*
* Don't send events that were triggered by the current process. This
* is useful for reducing the volume of events that are sent. It is
* only useful if your process might modify the file system hierarchy
* beneath the path(s) being monitored. Note: this has no effect on
* historical events, i.e., those delivered before the HistoryDone
* sentinel event. Also, this does not apply to RootChanged events
* because the WatchRoot feature uses a separate mechanism that is
* unable to provide information about the responsible process.
*/
kFSEventStreamCreateFlagIgnoreSelf __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_6_0) = 0x00000008,
/*
* Request file-level notifications. Your stream will receive events
* about individual files in the hierarchy you're watching instead of
* only receiving directory level notifications. Use this flag with
* care as it will generate significantly more events than without it.
*/
kFSEventStreamCreateFlagFileEvents __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_6_0) = 0x00000010,
/*
* Tag events that were triggered by the current process with the "OwnEvent" flag.
* This is only useful if your process might modify the file system hierarchy
* beneath the path(s) being monitored and you wish to know which events were
* triggered by your process. Note: this has no effect on historical events, i.e.,
* those delivered before the HistoryDone sentinel event.
*/
kFSEventStreamCreateFlagMarkSelf __OSX_AVAILABLE_STARTING(__MAC_10_9, __IPHONE_7_0) = 0x00000020,
/*
* Requires kFSEventStreamCreateFlagUseCFTypes and instructs the
* framework to invoke your callback function with CF types but,
* instead of passing it a CFArrayRef of CFStringRefs, a CFArrayRef of
* CFDictionaryRefs is passed. Each dictionary will contain the event
* path and possibly other "extended data" about the event. See the
* kFSEventStreamEventExtendedData*Key definitions for the set of keys
* that may be set in the dictionary. (See also FSEventStreamCallback.)
*/
kFSEventStreamCreateFlagUseExtendedData __OSX_AVAILABLE_STARTING(__MAC_10_13, __IPHONE_11_0) = 0x00000040,
/*
* When requesting historical events it is possible that some events
* may get skipped due to the way they are stored. With this flag
* all historical events in a given chunk are returned even if their
* event-id is less than the sinceWhen id. Put another way, deliver
* all the events in the first chunk of historical events that contains
* the sinceWhen id so that none are skipped even if their id is less
* than the sinceWhen id. This overlap avoids any issue with missing
* events that happened at/near the time of an unclean restart of the
* client process.
*/
kFSEventStreamCreateFlagFullHistory __OSX_AVAILABLE_STARTING(__MAC_10_15, __IPHONE_13_0) = 0x00000080,
};
/*
* kFSEventStreamCreateFlagUseExtendedData
*
* Discussion:
* Keys for extended data CFDictionary
*/
/*
* Path to file system object.
* Value of type CFStringRef (per CFStringCreateWithFileSystemRepresentation()).
*/
#define kFSEventStreamEventExtendedDataPathKey CFSTR("path")
/*
* File system object inode number.
* Value of type CFNumberRef.
* (Set only if you specified the FileEvents flag when creating the stream.)
*/
#define kFSEventStreamEventExtendedFileIDKey CFSTR("fileID")
/*
* FSEventStreamEventFlags
*
* Discussion:
* Flags that can be passed to your FSEventStreamCallback function.
*/
typedef UInt32 FSEventStreamEventFlags;
/*
* FSEventStreamEventFlags
*
* Discussion:
* Flags that can be passed to your FSEventStreamCallback function.
*
* It is important to note that event flags are simply hints about the
* sort of operations that occurred at that path.
*
* Furthermore, the FSEvent stream should NOT be treated as a form of
* historical log that could somehow be replayed to arrive at the
* current state of the file system.
*
* The FSEvent stream simply indicates what paths changed; and clients
* need to reconcile what is really in the file system with their internal
* data model - and recognize that what is actually in the file system can
* change immediately after you check it.
*/
enum {
/*
* There was some change in the directory at the specific path
* supplied in this event.
*/
kFSEventStreamEventFlagNone = 0x00000000,
/*
* Your application must rescan not just the directory given in the
* event, but all its children, recursively. This can happen if there
* was a problem whereby events were coalesced hierarchically. For
* example, an event in /Users/jsmith/Music and an event in
* /Users/jsmith/Pictures might be coalesced into an event with this
* flag set and path=/Users/jsmith. If this flag is set you may be
* able to get an idea of whether the bottleneck happened in the
* kernel (less likely) or in your client (more likely) by checking
* for the presence of the informational flags
* kFSEventStreamEventFlagUserDropped or
* kFSEventStreamEventFlagKernelDropped.
*/
kFSEventStreamEventFlagMustScanSubDirs = 0x00000001,
/*
* The kFSEventStreamEventFlagUserDropped or
* kFSEventStreamEventFlagKernelDropped flags may be set in addition
* to the kFSEventStreamEventFlagMustScanSubDirs flag to indicate
* that a problem occurred in buffering the events (the particular
* flag set indicates where the problem occurred) and that the client
* must do a full scan of any directories (and their subdirectories,
* recursively) being monitored by this stream. If you asked to
* monitor multiple paths with this stream then you will be notified
* about all of them. Your code need only check for the
* kFSEventStreamEventFlagMustScanSubDirs flag; these flags (if
* present) only provide information to help you diagnose the problem.
*/
kFSEventStreamEventFlagUserDropped = 0x00000002,
kFSEventStreamEventFlagKernelDropped = 0x00000004,
/*
* If kFSEventStreamEventFlagEventIdsWrapped is set, it means the
* 64-bit event ID counter wrapped around. As a result,
* previously-issued event ID's are no longer valid arguments for the
* sinceWhen parameter of the FSEventStreamCreate...() functions.
*/
kFSEventStreamEventFlagEventIdsWrapped = 0x00000008,
/*
* Denotes a sentinel event sent to mark the end of the "historical"
* events sent as a result of specifying a sinceWhen value in the
* FSEventStreamCreate...() call that created this event stream. (It
* will not be sent if kFSEventStreamEventIdSinceNow was passed for
* sinceWhen.) After invoking the client's callback with all the
* "historical" events that occurred before now, the client's
* callback will be invoked with an event where the
* kFSEventStreamEventFlagHistoryDone flag is set. The client should
* ignore the path supplied in this callback.
*/
kFSEventStreamEventFlagHistoryDone = 0x00000010,
/*
* Denotes a special event sent when there is a change to one of the
* directories along the path to one of the directories you asked to
* watch. When this flag is set, the event ID is zero and the path
* corresponds to one of the paths you asked to watch (specifically,
* the one that changed). The path may no longer exist because it or
* one of its parents was deleted or renamed. Events with this flag
* set will only be sent if you passed the flag
* kFSEventStreamCreateFlagWatchRoot to FSEventStreamCreate...() when
* you created the stream.
*/
kFSEventStreamEventFlagRootChanged = 0x00000020,
/*
* Denotes a special event sent when a volume is mounted underneath
* one of the paths being monitored. The path in the event is the
* path to the newly-mounted volume. You will receive one of these
* notifications for every volume mount event inside the kernel
* (independent of DiskArbitration). Beware that a newly-mounted
* volume could contain an arbitrarily large directory hierarchy.
* Avoid pitfalls like triggering a recursive scan of a non-local
* filesystem, which you can detect by checking for the absence of
* the MNT_LOCAL flag in the f_flags returned by statfs(). Also be
* aware of the MNT_DONTBROWSE flag that is set for volumes which
* should not be displayed by user interface elements.
*/
kFSEventStreamEventFlagMount = 0x00000040,
/*
* Denotes a special event sent when a volume is unmounted underneath
* one of the paths being monitored. The path in the event is the
* path to the directory from which the volume was unmounted. You
* will receive one of these notifications for every volume unmount
* event inside the kernel. This is not a substitute for the
* notifications provided by the DiskArbitration framework; you only
* get notified after the unmount has occurred. Beware that
* unmounting a volume could uncover an arbitrarily large directory
* hierarchy, although Mac OS X never does that.
*/
kFSEventStreamEventFlagUnmount = 0x00000080,
/*
* A file system object was created at the specific path supplied in this event.
* (This flag is only ever set if you specified the FileEvents flag when creating the stream.)
*/
kFSEventStreamEventFlagItemCreated __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_6_0) = 0x00000100,
/*
* A file system object was removed at the specific path supplied in this event.
* (This flag is only ever set if you specified the FileEvents flag when creating the stream.)
*/
kFSEventStreamEventFlagItemRemoved __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_6_0) = 0x00000200,
/*
* A file system object at the specific path supplied in this event had its metadata modified.
* (This flag is only ever set if you specified the FileEvents flag when creating the stream.)
*/
kFSEventStreamEventFlagItemInodeMetaMod __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_6_0) = 0x00000400,
/*
* A file system object was renamed at the specific path supplied in this event.
* (This flag is only ever set if you specified the FileEvents flag when creating the stream.)
*/
kFSEventStreamEventFlagItemRenamed __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_6_0) = 0x00000800,
/*
* A file system object at the specific path supplied in this event had its data modified.
* (This flag is only ever set if you specified the FileEvents flag when creating the stream.)
*/
kFSEventStreamEventFlagItemModified __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_6_0) = 0x00001000,
/*
* A file system object at the specific path supplied in this event had its FinderInfo data modified.
* (This flag is only ever set if you specified the FileEvents flag when creating the stream.)
*/
kFSEventStreamEventFlagItemFinderInfoMod __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_6_0) = 0x00002000,
/*
* A file system object at the specific path supplied in this event had its ownership changed.
* (This flag is only ever set if you specified the FileEvents flag when creating the stream.)
*/
kFSEventStreamEventFlagItemChangeOwner __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_6_0) = 0x00004000,
/*
* A file system object at the specific path supplied in this event had its extended attributes modified.
* (This flag is only ever set if you specified the FileEvents flag when creating the stream.)
*/
kFSEventStreamEventFlagItemXattrMod __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_6_0) = 0x00008000,
/*
* The file system object at the specific path supplied in this event is a regular file.
* (This flag is only ever set if you specified the FileEvents flag when creating the stream.)
*/
kFSEventStreamEventFlagItemIsFile __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_6_0) = 0x00010000,
/*
* The file system object at the specific path supplied in this event is a directory.
* (This flag is only ever set if you specified the FileEvents flag when creating the stream.)
*/
kFSEventStreamEventFlagItemIsDir __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_6_0) = 0x00020000,
/*
* The file system object at the specific path supplied in this event is a symbolic link.
* (This flag is only ever set if you specified the FileEvents flag when creating the stream.)
*/
kFSEventStreamEventFlagItemIsSymlink __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_6_0) = 0x00040000,
/*
* Indicates the event was triggered by the current process.
* (This flag is only ever set if you specified the MarkSelf flag when creating the stream.)
*/
kFSEventStreamEventFlagOwnEvent __OSX_AVAILABLE_STARTING(__MAC_10_9, __IPHONE_7_0) = 0x00080000,
/*
* Indicates the object at the specified path supplied in this event is a hard link.
* (This flag is only ever set if you specified the FileEvents flag when creating the stream.)
*/
kFSEventStreamEventFlagItemIsHardlink __OSX_AVAILABLE_STARTING(__MAC_10_10, __IPHONE_9_0) = 0x00100000,
/* Indicates the object at the specific path supplied in this event was the last hard link.
* (This flag is only ever set if you specified the FileEvents flag when creating the stream.)
*/
kFSEventStreamEventFlagItemIsLastHardlink __OSX_AVAILABLE_STARTING(__MAC_10_10, __IPHONE_9_0) = 0x00200000,
/*
* The file system object at the specific path supplied in this event is a clone or was cloned.
* (This flag is only ever set if you specified the FileEvents flag when creating the stream.)
*/
kFSEventStreamEventFlagItemCloned __OSX_AVAILABLE_STARTING(__MAC_10_13, __IPHONE_11_0) = 0x00400000
};
/*
* FSEventStreamEventId
*
* Discussion:
* Event IDs that can be passed to the FSEventStreamCreate...()
* functions and FSEventStreamCallback(). They are monotonically
* increasing per system, even across reboots and drives coming and
* going. They bear no relation to any particular clock or timebase.
*/
typedef UInt64 FSEventStreamEventId;
enum {
kFSEventStreamEventIdSinceNow = 0xFFFFFFFFFFFFFFFFULL
};
/*
* FSEventStreamRef
*
* Discussion:
* This is the type of a reference to an FSEventStream.
*/
typedef struct __FSEventStream* FSEventStreamRef;
/*
* ConstFSEventStreamRef
*
* Discussion:
* This is the type of a reference to a constant FSEventStream.
*/
typedef const struct __FSEventStream* ConstFSEventStreamRef;
/*
* FSEventStreamContext
*
* Discussion:
* Structure containing client-supplied data (and callbacks to
* manage it) that should be associated with a newly-created stream.
*/
struct FSEventStreamContext {
/*
* Currently the only valid value is zero.
*/
CFIndex version;
/*
* An arbitrary client-defined value (for instance, a pointer) to be
* associated with the stream and passed to the callback when it is
* invoked. If a non-NULL value is supplied for the retain callback
* the framework will use it to retain this value. If a non-NULL
* value is supplied for the release callback then when the stream is
* deallocated it will be used to release this value. This can be
* NULL.
*/
void * __nullable info;
/*
* The callback used retain the info pointer. This can be NULL.
*/
CFAllocatorRetainCallBack __nullable retain;
/*
* The callback used release a retain on the info pointer. This can
* be NULL.
*/
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 can be NULL.
*/
CFAllocatorCopyDescriptionCallBack __nullable copyDescription;
};
typedef struct FSEventStreamContext FSEventStreamContext;
/*
* FSEventStreamCallback
*
* Discussion:
* This is the type of the callback function supplied by the client
* when creating a new stream. This callback is invoked by the
* service from the client's runloop(s) when events occur, per the
* parameters specified when the stream was created.
*
* Parameters:
*
* streamRef:
* The stream for which event(s) occurred.
*
* clientCallBackInfo:
* The info field that was supplied in the context when this
* stream was created.
*
* numEvents:
* The number of events being reported in this callback. Each of
* the arrays (eventPaths, eventFlags, eventIds) will have this
* many elements.
*
* eventPaths:
* An array of paths to the directories in which event(s)
* occurred. The type of this parameter depends on the flags
* passed to FSEventStreamCreate...().
* * If kFSEventStreamCreateFlagUseCFTypes was not set, then the
* framework will pass your callback a raw C array of raw C
* strings that will be deallocated by the framework after your
* callback returns.
* * If both kFSEventStreamCreateFlagUseCFTypes and
* kFSEventStreamCreateFlagUseExtendedData are set, then this will be a
* CFArrayRef containing CFDictionaryRef objects (containing entries
* as described by the kFSEventStreamEventExtendedData*Key constants).
* Ownership follows the Get rule, and they will be released by the
* framework after your callback returns.
* * If kFSEventStreamCreateFlagUseCFTypes was set, then this will be a
* CFArrayRef containing CFStringRef objects (per
* CFStringCreateWithFileSystemRepresentation()). Ownership
* follows the Get rule, and they will be released by the
* framework after your callback returns.
*
* A path might be "/" if ether of these flags is set for the event:
* kFSEventStreamEventFlagUserDropped,
* kFSEventStreamEventFlagKernelDropped.
*
* eventFlags:
* An array of flag words corresponding to the paths in the
* eventPaths parameter. If no flags are set, then there was some
* change in the directory at the specific path supplied in this
* event. See FSEventStreamEventFlags.
*
* eventIds:
* An array of FSEventStreamEventIds corresponding to the paths in
* the eventPaths parameter. Each event ID comes from the most
* recent event being reported in the corresponding directory
* named in the eventPaths parameter. Event IDs all come from a
* single global source. They are guaranteed to always be
* increasing, usually in leaps and bounds, even across system
* reboots and moving drives from one machine to another. Just
* before invoking your callback your stream is updated so that
* calling the accessor FSEventStreamGetLatestEventId() will
* return the largest of the values passed in the eventIds
* parameter; if you were to stop processing events from this
* stream after this callback and resume processing them later
* from a newly-created FSEventStream, this is the value you would
* pass for the sinceWhen parameter to the
* FSEventStreamCreate...() function.
*/
typedef CALLBACK_API_C( void , FSEventStreamCallback )(ConstFSEventStreamRef streamRef, void * __nullable clientCallBackInfo, size_t numEvents, void *eventPaths, const FSEventStreamEventFlags * _Nonnull eventFlags, const FSEventStreamEventId * _Nonnull eventIds);
/*
* Create
*/
/*
* FSEventStreamCreate()
*
* Discussion:
* Creates a new FS event stream object with the given parameters.
* In order to start receiving callbacks you must also call
* FSEventStreamScheduleWithRunLoop() and FSEventStreamStart().
*
* Parameters:
*
* allocator:
* The CFAllocator to be used to allocate memory for the stream.
* Pass NULL or kCFAllocatorDefault to use the current default
* allocator.
*
* callback:
* An FSEventStreamCallback which will be called when FS events
* occur.
*
* context:
* A pointer to the FSEventStreamContext structure the client
* wants to associate with this stream. Its fields are copied out
* into the stream itself so its memory can be released after the
* stream is created. Passing NULL is allowed and has the same
* effect as passing a structure whose fields are all set to zero.
*
* pathsToWatch:
* A CFArray of CFStringRefs, each specifying a path to a
* directory, signifying the root of a filesystem hierarchy to be
* watched for modifications.
*
* sinceWhen:
* The service will supply events that have happened after the
* given event ID. To ask for events "since now" pass the constant
* kFSEventStreamEventIdSinceNow. Often, clients will supply the
* highest-numbered FSEventStreamEventId they have received in a
* callback, which they can obtain via the
* FSEventStreamGetLatestEventId() accessor. Do not pass zero for
* sinceWhen, unless you want to receive events for every
* directory modified since "the beginning of time" -- an unlikely
* scenario.
*
* latency:
* The number of seconds the service should wait after hearing
* about an event from the kernel before passing it along to the
* client via its callback. Specifying a larger value may result
* in more effective temporal coalescing, resulting in fewer
* callbacks and greater overall efficiency.
*
* flags:
* Flags that modify the behavior of the stream being created. See
* FSEventStreamCreateFlags.
*
* Result:
* A valid FSEventStreamRef or NULL if there was a problem creating the object.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern FSEventStreamRef __nullable
FSEventStreamCreate(
CFAllocatorRef __nullable allocator,
FSEventStreamCallback callback,
FSEventStreamContext * __nullable context,
CFArrayRef pathsToWatch,
FSEventStreamEventId sinceWhen,
CFTimeInterval latency,
FSEventStreamCreateFlags flags) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_6_0);
/*
* FSEventStreamCreateRelativeToDevice()
*
* Discussion:
* Creates a new FS event stream object for a particular device with
* the given parameters. Note that only one path may be specified.
* In order to start receiving callbacks you must also call
* FSEventStreamScheduleWithRunLoop() and FSEventStreamStart().
*
* Parameters:
*
* allocator:
* The CFAllocator to be used to allocate memory for the stream.
* Pass NULL or kCFAllocatorDefault to use the current default
* allocator.
*
* callback:
* An FSEventStreamCallback which will be called when FS events
* occur.
*
* context:
* A pointer to the FSEventStreamContext structure the client
* wants to associate with this stream. Its fields are copied out
* into the stream itself so its memory can be released after the
* stream is created.
*
* deviceToWatch:
* A dev_t corresponding to the device which you want to receive
* notifications from. The dev_t is the same as the st_dev field
* from a stat structure of a file on that device or the f_fsid[0]
* field of a statfs structure. If the value of dev is zero, it
* is ignored.
*
* pathsToWatchRelativeToDevice:
* A CFArray of CFStringRefs, each specifying a relative path to a
* directory on the device identified by the dev parameter. The
* paths should be relative to the root of the device. For
* example, if a volume "MyData" is mounted at "/Volumes/MyData"
* and you want to watch "/Volumes/MyData/Pictures/July", specify
* a path string of "Pictures/July". To watch the root of a
* volume pass a path of "" (the empty string). Note that even
* though this is an array of paths, only one path may be specified.
*
* sinceWhen:
* The service will supply events that have happened after the
* given event ID. To ask for events "since now" pass the constant
* kFSEventStreamEventIdSinceNow. Often, clients will supply the
* highest-numbered FSEventStreamEventId they have received in a
* callback, which they can obtain via the
* FSEventStreamGetLatestEventId() accessor. Do not pass zero for
* sinceWhen, unless you want to receive events for every
* directory modified since "the beginning of time" -- an unlikely
* scenario.
*
* latency:
* The number of seconds the service should wait after hearing
* about an event from the kernel before passing it along to the
* client via its callback. Specifying a larger value may result
* in more effective temporal coalescing, resulting in fewer
* callbacks.
*
* flags:
* Flags that modify the behavior of the stream being created. See
* FSEventStreamCreateFlags.
*
* Result:
* A valid FSEventStreamRef.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern FSEventStreamRef __nullable
FSEventStreamCreateRelativeToDevice(
CFAllocatorRef __nullable allocator,
FSEventStreamCallback callback,
FSEventStreamContext * __nullable context,
dev_t deviceToWatch,
CFArrayRef pathsToWatchRelativeToDevice,
FSEventStreamEventId sinceWhen,
CFTimeInterval latency,
FSEventStreamCreateFlags flags) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_6_0);
/*
* Accessors
*/
/*
* FSEventStreamGetLatestEventId()
*
* Discussion:
* Fetches the sinceWhen property of the stream. Upon receiving an
* event (and just before invoking the client's callback) this
* attribute is updated to the highest-numbered event ID mentioned
* in the event.
*
* Parameters:
*
* streamRef:
* A valid stream.
*
* Result:
* The sinceWhen attribute of the stream.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern FSEventStreamEventId
FSEventStreamGetLatestEventId(ConstFSEventStreamRef streamRef) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_6_0);
/*
* FSEventStreamGetDeviceBeingWatched()
*
* Discussion:
* Fetches the dev_t supplied when the stream was created via
* FSEventStreamCreateRelativeToDevice(), otherwise 0.
*
* Parameters:
*
* streamRef:
* A valid stream.
*
* Result:
* The dev_t for a device-relative stream, otherwise 0.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern dev_t
FSEventStreamGetDeviceBeingWatched(ConstFSEventStreamRef streamRef) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_6_0);
/*
* FSEventStreamCopyPathsBeingWatched()
*
* Discussion:
* Fetches the paths supplied when the stream was created via one of
* the FSEventStreamCreate...() functions.
*
* Parameters:
*
* streamRef:
* A valid stream.
*
* Result:
* A CFArray of CFStringRefs corresponding to those supplied when
* the stream was created. Ownership follows the Copy rule.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CF_RETURNS_RETAINED CFArrayRef
FSEventStreamCopyPathsBeingWatched(ConstFSEventStreamRef streamRef) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_6_0);
/*
* FSEventsGetCurrentEventId()
*
* Discussion:
* Fetches the most recently generated event ID, system-wide (not
* just for one stream). By thetime it is returned to your
* application even newer events may have already been generated.
*
* Result:
* The event ID of the most recent event generated by the system.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern FSEventStreamEventId
FSEventsGetCurrentEventId(void) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_6_0);
/*
* FSEventsCopyUUIDForDevice()
*
* Discussion:
* Gets the UUID associated with a device, or NULL if not possible
* (for example, on read-only device). A (non-NULL) UUID uniquely
* identifies a given stream of FSEvents. If this (non-NULL) UUID
* is different than one that you stored from a previous run then
* the event stream is different (for example, because FSEvents were
* purged, because the disk was erased, or because the event ID
* counter wrapped around back to zero). A NULL return value
* indicates that "historical" events are not available, i.e., you
* should not supply a "sinceWhen" value to FSEventStreamCreate...()
* other than kFSEventStreamEventIdSinceNow.
*
* Parameters:
*
* dev:
* The dev_t of the device that you want to get the UUID for.
*
* Result:
* The UUID associated with the stream of events on this device, or
* NULL if no UUID is available (for example, on a read-only
* device). The UUID is stored on the device itself and travels
* with it even when the device is attached to different computers.
* Ownership follows the Copy Rule.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CF_RETURNS_RETAINED CFUUIDRef __nullable
FSEventsCopyUUIDForDevice(dev_t dev) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_6_0);
/*
* FSEventsGetLastEventIdForDeviceBeforeTime()
*
* Discussion:
* Gets the last event ID for the given device that was returned
* before the given time. This is conservative in the sense that if
* you then use the returned event ID as the sinceWhen parameter of
* FSEventStreamCreateRelativeToDevice() that you will not miss any
* events that happened since that time. On the other hand, you
* might receive some (harmless) extra events. Beware: there are
* things that can cause this to fail to be accurate. For example,
* someone might change the system's clock (either backwards or
* forwards). Or an external drive might be used on different
* systems without perfectly synchronized clocks.
*
* Parameters:
*
* dev:
* The dev_t of the device.
*
* time:
* The time as a CFAbsoluteTime whose value is the number of
* seconds since Jan 1, 1970 (i.e. a posix style time_t).
*
* Result:
* The last event ID for the given device that was returned before
* the given time.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern FSEventStreamEventId
FSEventsGetLastEventIdForDeviceBeforeTime(
dev_t dev,
CFAbsoluteTime time) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_6_0);
/*
* FSEventsPurgeEventsForDeviceUpToEventId()
*
* Discussion:
* Purges old events from the persistent per-volume database
* maintained by the service. Can only be called by the root user.
*
* Parameters:
*
* dev:
* The dev_t of the device.
*
* eventId:
* The event ID.
*
* Result:
* True if it succeeds, otherwise False if it fails.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern Boolean
FSEventsPurgeEventsForDeviceUpToEventId(
dev_t dev,
FSEventStreamEventId eventId) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_6_0);
/*
* Retain, Release
*/
/*
* @function FSEventStreamRetain
* Increments the stream's refcount. The refcount is initially one and is
* decremented via FSEventStreamRelease().
*
* @param streamRef
* A valid stream.
*
*/
/*
* FSEventStreamRetain()
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
FSEventStreamRetain(FSEventStreamRef streamRef) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_6_0);
/*
* FSEventStreamRelease()
*
* Discussion:
* Decrements the stream's refcount. The refcount is initially one
* and is incremented via FSEventStreamRetain(). If the refcount
* reaches zero then the stream is deallocated.
*
* Parameters:
*
* streamRef:
* A valid stream.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
FSEventStreamRelease(FSEventStreamRef streamRef) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_6_0);
/*
* ScheduleWithRunLoop, UnscheduleFromRunLoop, Invalidate
*/
/*
* FSEventStreamScheduleWithRunLoop()
*
* Discussion:
* This function schedules the stream on the specified run loop,
* like CFRunLoopAddSource() does for a CFRunLoopSourceRef. The
* caller is responsible for ensuring that the stream is scheduled
* on at least one run loop and that at least one of the run loops
* on which the stream is scheduled is being run. To start receiving
* events on the stream, call FSEventStreamStart(). To remove the
* stream from the run loops upon which it has been scheduled, call
* FSEventStreamUnscheduleFromRunLoop() or FSEventStreamInvalidate().
*
* Parameters:
*
* streamRef:
* A valid stream.
*
* runLoop:
* The run loop on which to schedule the stream.
*
* runLoopMode:
* A run loop mode on which to schedule the stream.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
FSEventStreamScheduleWithRunLoop(
FSEventStreamRef streamRef,
CFRunLoopRef runLoop,
CFStringRef runLoopMode) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_6_0);
/*
* FSEventStreamUnscheduleFromRunLoop()
*
* Discussion:
* This function removes the stream from the specified run loop,
* like CFRunLoopRemoveSource() does for a CFRunLoopSourceRef.
*
* Parameters:
*
* streamRef:
* A valid stream.
*
* runLoop:
* The run loop from which to unschedule the stream.
*
* runLoopMode:
* The run loop mode from which to unschedule the stream.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
FSEventStreamUnscheduleFromRunLoop(
FSEventStreamRef streamRef,
CFRunLoopRef runLoop,
CFStringRef runLoopMode) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_6_0);
/*
* FSEventStreamSetDispatchQueue()
*
* Discussion:
* This function schedules the stream on the specified dispatch
* queue. The caller is responsible for ensuring that the stream is
* scheduled on a dispatch queue and that the queue is started. If
* there is a problem scheduling the stream on the queue an error
* will be returned when you try to Start the stream. To start
* receiving events on the stream, call FSEventStreamStart(). To
* remove the stream from the queue on which it was scheduled, call
* FSEventStreamSetDispatchQueue() with a NULL queue parameter or
* call FSEventStreamInvalidate() which will do the same thing.
* Note: you must eventually call FSEventStreamInvalidate() and it
* is an error to call FSEventStreamInvalidate() without having the
* stream either scheduled on a runloop or a dispatch queue, so do
* not set the dispatch queue to NULL before calling
* FSEventStreamInvalidate().
*
* Parameters:
*
* streamRef:
* A valid stream.
*
* q:
* The dispatch queue to use to receive events (or NULL to to stop
* receiving events from the stream).
*
* Availability:
* Mac OS X: in version 10.6 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
FSEventStreamSetDispatchQueue(
FSEventStreamRef streamRef,
dispatch_queue_t __nullable q) __OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_6_0);
/*
* FSEventStreamInvalidate()
*
* Discussion:
* Invalidates the stream, like CFRunLoopSourceInvalidate() does for
* a CFRunLoopSourceRef. It will be unscheduled from any runloops
* or dispatch queues upon which it had been scheduled.
* FSEventStreamInvalidate() can only be called on the stream after
* you have called FSEventStreamScheduleWithRunLoop() or
* FSEventStreamSetDispatchQueue().
*
* Parameters:
*
* streamRef:
* A valid stream.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
FSEventStreamInvalidate(FSEventStreamRef streamRef) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_6_0);
/*
* Start, Flush, Stop
*/
/*
* FSEventStreamStart()
*
* Discussion:
* Attempts to register with the FS Events service to receive events
* per the parameters in the stream. FSEventStreamStart() can only
* be called once the stream has been scheduled on at least one
* runloop, via FSEventStreamScheduleWithRunLoop(). Once started,
* the stream can be stopped via FSEventStreamStop().
*
* Parameters:
*
* streamRef:
* A valid stream.
*
* Result:
* True if it succeeds, otherwise False if it fails. It ought to
* always succeed, but in the event it does not then your code
* should fall back to performing recursive scans of the directories
* of interest as appropriate.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern Boolean
FSEventStreamStart(FSEventStreamRef streamRef) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_6_0);
/*
* FSEventStreamFlushAsync()
*
* Discussion:
* Asks the FS Events service to flush out any events that have
* occurred but have not yet been delivered, due to the latency
* parameter that was supplied when the stream was created. This
* flushing occurs asynchronously -- do not expect the events to
* have already been delivered by the time this call returns.
* FSEventStreamFlushAsync() can only be called after the stream has
* been started, via FSEventStreamStart().
*
* Parameters:
*
* streamRef:
* A valid stream.
*
* Result:
* The largest event id of any event ever queued for this stream,
* otherwise zero if no events have been queued for this stream.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern FSEventStreamEventId
FSEventStreamFlushAsync(FSEventStreamRef streamRef) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_6_0);
/*
* FSEventStreamFlushSync()
*
* Discussion:
* Asks the FS Events service to flush out any events that have
* occurred but have not yet been delivered, due to the latency
* parameter that was supplied when the stream was created. This
* flushing occurs synchronously -- by the time this call returns,
* your callback will have been invoked for every event that had
* already occurred at the time you made this call.
* FSEventStreamFlushSync() can only be called after the stream has
* been started, via FSEventStreamStart().
*
* Parameters:
*
* streamRef:
* A valid stream.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
FSEventStreamFlushSync(FSEventStreamRef streamRef) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_6_0);
/*
* FSEventStreamStop()
*
* Discussion:
* Unregisters with the FS Events service. The client callback will
* not be called for this stream while it is stopped.
* FSEventStreamStop() can only be called if the stream has been
* started, via FSEventStreamStart(). Once stopped, the stream can
* be restarted via FSEventStreamStart(), at which point it will
* resume receiving events from where it left off ("sinceWhen").
*
* Parameters:
*
* streamRef:
* A valid stream.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
FSEventStreamStop(FSEventStreamRef streamRef) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_6_0);
/*
* Debugging
*/
/*
* FSEventStreamShow()
*
* Discussion:
* Prints a description of the supplied stream to stderr. For
* debugging only.
*
* Parameters:
*
* streamRef:
* A valid stream.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
FSEventStreamShow(ConstFSEventStreamRef streamRef) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_6_0);
/*
* FSEventStreamCopyDescription()
*
* Discussion:
* Returns a CFStringRef containing the description of the supplied
* stream. For debugging only.
*
* Result:
* A CFStringRef containing the description of the supplied stream.
* Ownership follows the Copy rule.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CF_RETURNS_RETAINED CFStringRef
FSEventStreamCopyDescription(ConstFSEventStreamRef streamRef) __OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_6_0);
/*
* FSEventStreamSetExclusionPaths()
*
* Discussion:
* Sets directories to be filtered from the EventStream.
* A maximum of 8 directories maybe specified.
*
* Result:
* True if it succeeds, otherwise False if it fails.
*
* Availability:
* Mac OS X: in version 10.9 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern Boolean
FSEventStreamSetExclusionPaths(FSEventStreamRef streamRef, CFArrayRef pathsToExclude) __OSX_AVAILABLE_STARTING(__MAC_10_9, __IPHONE_8_0);
#if PRAGMA_ENUM_ALWAYSINT
#pragma enumsalwaysint reset
#endif
#pragma pack(pop)
CF_ASSUME_NONNULL_END
#ifdef __cplusplus
}
#endif
#endif /* __FSEVENTS__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/SharedFileList.framework/SharedFileList.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: CDE97B98-5C70-3120-BA12-1A0408C41F09
- target: x86_64-maccatalyst
value: CDE97B98-5C70-3120-BA12-1A0408C41F09
- target: arm64-macos
value: 00000000-0000-0000-0000-000000000000
- target: arm64-maccatalyst
value: 00000000-0000-0000-0000-000000000000
- target: arm64e-macos
value: A30F9F46-7FF0-3404-9585-F54117864BAB
- target: arm64e-maccatalyst
value: A30F9F46-7FF0-3404-9585-F54117864BAB
install-name: '/System/Library/Frameworks/CoreServices.framework/Versions/A/Frameworks/SharedFileList.framework/Versions/A/SharedFileList'
current-version: 155
parent-umbrella:
- targets: [ x86_64-macos, x86_64-maccatalyst, arm64-macos, arm64-maccatalyst,
arm64e-macos, arm64e-maccatalyst ]
umbrella: CoreServices
allowable-clients:
- targets: [ x86_64-macos, x86_64-maccatalyst, arm64-macos, arm64-maccatalyst,
arm64e-macos, arm64e-maccatalyst ]
clients: [ Foundation ]
exports:
- targets: [ x86_64-macos, arm64e-macos, x86_64-maccatalyst, arm64e-maccatalyst,
arm64-macos, arm64-maccatalyst ]
symbols: [ _SFLListChangeNotification, _SFLListLaunchNotification, _SFLServiceName,
_kSFLDefaultsDomain ]
objc-classes: [ SFLBookmark, SFLDefaults, SFLItem, SFLManager, SFLResolveResult,
_SFLItem, _SFLList ]
- targets: [ x86_64-macos, arm64e-macos, arm64-macos ]
symbols: [ _LSSharedFileListAddObserver, _LSSharedFileListAddObserverOnQueue,
_LSSharedFileListCopyProperty, _LSSharedFileListCopySnapshot,
_LSSharedFileListCreate, _LSSharedFileListGetSeedValue, _LSSharedFileListGetTypeID,
_LSSharedFileListInsertItemAlias, _LSSharedFileListInsertItemBookmark,
_LSSharedFileListInsertItemFSRef, _LSSharedFileListInsertItemURL,
_LSSharedFileListItemCopyAliasData, _LSSharedFileListItemCopyBookmarkData,
_LSSharedFileListItemCopyDisplayName, _LSSharedFileListItemCopyIconRef,
_LSSharedFileListItemCopyProperty, _LSSharedFileListItemCopyResolvedURL,
_LSSharedFileListItemGetID, _LSSharedFileListItemGetTypeID,
_LSSharedFileListItemMove, _LSSharedFileListItemRemove, _LSSharedFileListItemResolve,
_LSSharedFileListItemSetProperty, _LSSharedFileListItemUpdate,
_LSSharedFileListRemoveAllItems, _LSSharedFileListRemoveObserver,
_LSSharedFileListRemoveObserverOnQueue, _LSSharedFileListSetAuthorization,
_LSSharedFileListSetProperty, __LSSharedFileListCopyListType,
__LSSharedFileListIsURLSharePoint, __LSSharedFileListItemCopyBinding,
__LSSharedFileListItemCopyURL, __LSSharedFileListItemOpen,
__LSSharedFileListItemSetBookmarkData, __LSSharedFileListItemSetURL,
__LSSharedFileListUpgrade, __LSSharedFileListVolumeIsVisibleInSidebar,
__SFLCreateSnapshot, __SFLGetRestrictedCustomFileList, __SFLIsFolderShareable,
__SFLRelease, __SFLReleaseSnapshot, __kLSSharedFileListFavoriteItems,
__kLSSharedFileListFavoriteVolumes, __kLSSharedFileListGlobalLoginItems,
__kLSSharedFileListItemBeforeFirst, __kLSSharedFileListItemHidden,
__kLSSharedFileListItemLast, __kLSSharedFileListLoginItemHidden,
__kLSSharedFileListRecentApplicationItems, __kLSSharedFileListRecentDocumentItems,
__kLSSharedFileListRecentItemsMaxAmount, __kLSSharedFileListRecentServerItems,
__kLSSharedFileListSessionLoginItems, __kLSSharedFileListSharePoints,
__kLSSharedFileListVolumesComputerVisible, __kLSSharedFileListVolumesICloudDriveVisible,
__kLSSharedFileListVolumesIDiskVisible, __kLSSharedFileListVolumesNetworkVisible,
__kLSSharedFileListiCloudItems, _kLSSharedFileListAFPCancelShutdown,
_kLSSharedFileListAFPConnectionUserName, _kLSSharedFileListAFPConnections,
_kLSSharedFileListAFPSecondsToShutdown, _kLSSharedFileListAFPServerActivity,
_kLSSharedFileListAFPServerName, _kLSSharedFileListAFPServerState,
_kLSSharedFileListAFPServerStateGoingToShutDown, _kLSSharedFileListAFPServerStateNotRunning,
_kLSSharedFileListAFPServerStateRefusingConnections, _kLSSharedFileListAFPServerStateServerIsEnabled,
_kLSSharedFileListAFPServerStateShuttingDown, _kLSSharedFileListAFPServerStateStartingUp,
_kLSSharedFileListAFPServerStateUnknown, _kLSSharedFileListAFPServerTimedShutdownMessage,
_kLSSharedFileListAFPServerTimedShutdownTime, _kLSSharedFileListAFPServerVersion,
_kLSSharedFileListAFPSharingEnabled, _kLSSharedFileListAFPStatus,
_kLSSharedFileListAFPTimedShutdown, _kLSSharedFileListApplicationRecentDocuments,
_kLSSharedFileListAutomountedServers, _kLSSharedFileListCancelShutdown,
_kLSSharedFileListDockApplications, _kLSSharedFileListFTPSharingEnabled,
_kLSSharedFileListFavoriteItems, _kLSSharedFileListFavoriteServers,
_kLSSharedFileListFavoriteVolumes, _kLSSharedFileListFinderProjectsItems,
_kLSSharedFileListGlobalLoginItems, _kLSSharedFileListGuestAccessEnabled,
_kLSSharedFileListItemBeforeFirst, _kLSSharedFileListItemBinding,
_kLSSharedFileListItemHidden, _kLSSharedFileListItemIsComputer,
_kLSSharedFileListItemIsEjectableVolume, _kLSSharedFileListItemIsICloudDrive,
_kLSSharedFileListItemIsIDisk, _kLSSharedFileListItemIsMeetingRoom,
_kLSSharedFileListItemIsMobileTimeMachine, _kLSSharedFileListItemIsNetwork,
_kLSSharedFileListItemIsRemoteDisc, _kLSSharedFileListItemIsShared,
_kLSSharedFileListItemIsVideoDisc, _kLSSharedFileListItemLast,
_kLSSharedFileListItemLocked, _kLSSharedFileListItemManaged,
_kLSSharedFileListItemPersistent, _kLSSharedFileListItemRepairedVolume,
_kLSSharedFileListItemShareName, _kLSSharedFileListItemSharePointNotAvailable,
_kLSSharedFileListItemSharingUUID, _kLSSharedFileListItemTargetIsDirectory,
_kLSSharedFileListItemTargetIsVolume, _kLSSharedFileListItemTargetName,
_kLSSharedFileListItemVolumeRefNum, _kLSSharedFileListLoginItemHidden,
_kLSSharedFileListManagedSessionLoginItems, _kLSSharedFileListManagedSharedItems,
_kLSSharedFileListNMBSharingEnabled, _kLSSharedFileListNetworkBrowser,
_kLSSharedFileListRecentApplicationItems, _kLSSharedFileListRecentDocumentItems,
_kLSSharedFileListRecentHostItems, _kLSSharedFileListRecentItemsMaxAmount,
_kLSSharedFileListRecentServerItems, _kLSSharedFileListRestrictedItemFSProperties,
_kLSSharedFileListRestrictedItemFileSecurity, _kLSSharedFileListRestrictedItemOnVolumeSupportingPerms,
_kLSSharedFileListRestrictedItemOnWritableVolume, _kLSSharedFileListRestrictedItemOwner,
_kLSSharedFileListSMBPrintingEnabled, _kLSSharedFileListSMBSharingEnabled,
_kLSSharedFileListSavedSearchesItems, _kLSSharedFileListSessionLoginItems,
_kLSSharedFileListSharePoints, _kLSSharedFileListSharingEnabled,
_kLSSharedFileListSpecialItemIdentifier, _kLSSharedFileListTimedShutdown,
_kLSSharedFileListVolumesComputerVisible, _kLSSharedFileListVolumesIDiskVisible,
_kLSSharedFileListVolumesNetworkVisible, _kLSSharedFileListVolumesShowEjectableVolumes,
_kLSSharedFileListVolumesShowEjectableVolumesExceptions, _kLSSharedFileListVolumesShowHardDrives,
_kLSSharedFileListVolumesShowHardDrivesExceptions, _kLSSharedFileListVolumesShowRemovableVolumes,
_kLSSharedFileListVolumesShowRemovableVolumesExceptions, _kLSSharedFileListVolumesShowRepairing ]
...
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/SharedFileList.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/SharedFileList.framework/Headers/SharedFileList.h | //
// SharedFileList.h
// SharedFileList
//
// Copyright (c) 2013 Apple Inc. All rights reserved.
//
#ifndef __SHAREDFILELIST__
#define __SHAREDFILELIST__
#include <TargetConditionals.h>
#if TARGET_OS_OSX
#include <SharedFileList/LSSharedFileList.h>
#endif // TARGET_OS_OSX
#endif // __SHAREDFILELIST__
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/SharedFileList.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/SharedFileList.framework/Headers/LSSharedFileList.h | /*
File: LSSharedFileList.h
Contains: Services to load and share file lists.
Copyright: (c) 2003-2012 by Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#include <TargetConditionals.h>
#if TARGET_OS_OSX
#ifndef __LSSHAREDFILELIST__
#define __LSSHAREDFILELIST__
#ifndef __COREFOUNDATION__
#include <CoreFoundation/CoreFoundation.h>
#endif
#ifndef __CARBONCORE__
#include <CarbonCore/CarbonCore.h>
#endif
#ifndef __ICONSCORE__
#include <LaunchServices/IconsCore.h>
#endif
#ifndef __AUTHORIZATION__
#include <Security/Authorization.h>
#endif
#include <os/availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
CF_ASSUME_NONNULL_BEGIN
#ifdef __cplusplus
extern "C" {
#endif
/* The shared file list API is for sharing and storing list of references to file system objects.
The shared file list is a persistent list of objects, where each item has assigned display name, icon, and url
as well as other optional properties.
Each list can also have various properties attached.
*/
typedef struct OpaqueLSSharedFileListRef* LSSharedFileListRef;
typedef struct OpaqueLSSharedFileListItemRef* LSSharedFileListItemRef;
/* list types */
/*
* kLSSharedFileListFavoriteVolumes *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFStringRef kLSSharedFileListFavoriteVolumes API_DEPRECATED("No longer supported", macos(10.5, 10.11)) API_UNAVAILABLE(ios, tvos, watchos);
/*
* kLSSharedFileListFavoriteItems *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFStringRef kLSSharedFileListFavoriteItems API_DEPRECATED("No longer supported", macos(10.5, 10.11)) API_UNAVAILABLE(ios, tvos, watchos);
/*
* kLSSharedFileListRecentApplicationItems *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFStringRef kLSSharedFileListRecentApplicationItems API_DEPRECATED("No longer supported", macos(10.5, 10.11)) API_UNAVAILABLE(ios, tvos, watchos);
/*
* kLSSharedFileListRecentDocumentItems *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFStringRef kLSSharedFileListRecentDocumentItems API_DEPRECATED("No longer supported", macos(10.5, 10.11)) API_UNAVAILABLE(ios, tvos, watchos);
/*
* kLSSharedFileListRecentServerItems *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFStringRef kLSSharedFileListRecentServerItems API_DEPRECATED("No longer supported", macos(10.5, 10.11)) API_UNAVAILABLE(ios, tvos, watchos);
/*
* kLSSharedFileListSessionLoginItems *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFStringRef kLSSharedFileListSessionLoginItems API_DEPRECATED_WITH_REPLACEMENT("Use a LaunchAgent, XPCService or the ServiceManagement APIs instead.", macos(10.5, 10.11)) API_UNAVAILABLE(ios, tvos, watchos);
/*
* kLSSharedFileListGlobalLoginItems *** DEPRECATED ***
*
* Deprecated:
* Use a LaunchAgent instead.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFStringRef kLSSharedFileListGlobalLoginItems API_DEPRECATED_WITH_REPLACEMENT("Use a LaunchAgent instead.", macos(10.5, 10.9)) API_UNAVAILABLE(ios, tvos, watchos);
/* LSSharedFileList property keys */
/*
* kLSSharedFileListRecentItemsMaxAmount *** DEPRECATED ***
*
* Discussion:
* maximum amount of items in the list. Associated property is
* CFNumber
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFStringRef kLSSharedFileListRecentItemsMaxAmount API_DEPRECATED("No longer supported", macos(10.5, 10.11)) API_UNAVAILABLE(ios, tvos, watchos);
/*
* kLSSharedFileListVolumesComputerVisible *** DEPRECATED ***
*
* Discussion:
* is Computer item visible in favorite volumes list. Associated
* property is CFBoolean.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFStringRef kLSSharedFileListVolumesComputerVisible API_DEPRECATED("No longer supported", macos(10.5, 10.11)) API_UNAVAILABLE(ios, tvos, watchos);
/*
* kLSSharedFileListVolumesIDiskVisible *** DEPRECATED ***
*
* Discussion:
* is iDisk item visible in favorite volumes list. Associated
* property is CFBoolean.
*
* Deprecated:
* iDisk is no longer available.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFStringRef kLSSharedFileListVolumesIDiskVisible API_DEPRECATED("iDisk is no longer available", macos(10.5, 10.8)) API_UNAVAILABLE(ios, tvos, watchos);
/*
* kLSSharedFileListVolumesNetworkVisible *** DEPRECATED ***
*
* Discussion:
* is Network item visible in favorite volumes list. Associated
* property is CFBoolean.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFStringRef kLSSharedFileListVolumesNetworkVisible API_DEPRECATED("No longer supported", macos(10.5, 10.11)) API_UNAVAILABLE(ios, tvos, watchos);
/* item default positions */
/*
* kLSSharedFileListItemBeforeFirst *** DEPRECATED ***
*
* Discussion:
* A virtual item reference for inserting new item at beginning of
* the list.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern LSSharedFileListItemRef kLSSharedFileListItemBeforeFirst API_DEPRECATED("No longer supported", macos(10.5, 10.11)) API_UNAVAILABLE(ios, tvos, watchos);
/*
* kLSSharedFileListItemLast *** DEPRECATED ***
*
* Discussion:
* A virtual item reference for inserting new item at end of the
* list.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern LSSharedFileListItemRef kLSSharedFileListItemLast API_DEPRECATED("No longer supported", macos(10.5, 10.11)) API_UNAVAILABLE(ios, tvos, watchos);
/* LSSharedFileListItem property keys */
/*
* kLSSharedFileListItemHidden *** DEPRECATED ***
*
* Discussion:
* Is item hidden in UI? Associated property is CFBoolean.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFStringRef kLSSharedFileListItemHidden API_DEPRECATED("No longer supported", macos(10.5, 10.11)) API_UNAVAILABLE(ios, tvos, watchos);
/*
* kLSSharedFileListLoginItemHidden *** DEPRECATED ***
*
* Discussion:
* Should UI hide login item's window? Associated property is
* CFBoolean.
*
* Availability:
* Mac OS X: in version 10.6 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFStringRef kLSSharedFileListLoginItemHidden API_DEPRECATED("No longer supported", macos(10.6, 10.11)) API_UNAVAILABLE(ios, tvos, watchos);
/* LSSharedFileListItemCopyResolvedURL flags */
typedef UInt32 LSSharedFileListResolutionFlags;
enum {
kLSSharedFileListNoUserInteraction = 1 << 0, /* no user interaction during resolution */
kLSSharedFileListDoNotMountVolumes = 1 << 1 /* do not mount volumes during resolution */
};
/*
* LSSharedFileListChangedProcPtr *** DEPRECATED ***
*
* Discussion:
* callback to use with LSSharedFileListAddObserver and
* LSSharedFileListRemoveObserver.
*/
typedef CALLBACK_API_C( void , LSSharedFileListChangedProcPtr )(LSSharedFileListRef inList, void *context);
/*
* LSSharedFileListGetTypeID() *** DEPRECATED ***
*
* Discussion:
* This routine will return the CFTypeID for the LSSharedFileListRef
* type.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Result:
* CFTypeID for the LSSharedFileListRef type.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFTypeID
LSSharedFileListGetTypeID(void) API_DEPRECATED("No longer supported", macos(10.5, 10.11)) API_UNAVAILABLE(ios, tvos, watchos);
/*
* LSSharedFileListItemGetTypeID() *** DEPRECATED ***
*
* Discussion:
* This routine will return the CFTypeID for the
* LSSharedFileListItemRef type.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Result:
* CFTypeID for the LSSharedFileListItemRef type.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFTypeID
LSSharedFileListItemGetTypeID(void) API_DEPRECATED("No longer supported", macos(10.5, 10.11)) API_UNAVAILABLE(ios, tvos, watchos);
/*
* LSSharedFileListCreate() *** DEPRECATED ***
*
* Summary:
* Create shared file list reference.
*
* Discussion:
* Creates shared file list reference to be used for changing list
* and reading its various properties.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* inAllocator:
* CFAllocatorRef used to allocate the LSSharedFileListRef object.
* As usual, NULL means default allocator.
*
* inListType:
* A constant indicating list type to create (for example
* kLSSharedFileListSessionLoginItems).
*
* listOptions:
* Additional parameters for the list type (as applicable). NULL
* means no options.
*
* Result:
* A reference to created shared file list object or NULL if
* creation failed. Release with CFRelease when list
* object is not needed anymore.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern LSSharedFileListRef _Nullable
LSSharedFileListCreate(
CFAllocatorRef _Nullable inAllocator,
CFStringRef inListType,
CFTypeRef _Nullable listOptions) API_DEPRECATED("No longer supported", macos(10.5, 10.11)) API_UNAVAILABLE(ios, tvos, watchos);
/*
* LSSharedFileListSetAuthorization() *** DEPRECATED ***
*
* Summary:
* Set authorization reference for the shared list.
*
* Discussion:
* Sets authorization reference for the shared list. Before
* attempting to perform a privileged operation on the shared list
* caller must authorize appropriate rights. For example, modifying
* kLSSharedFileListGlobalLoginItems list requires
* "system.global-login-items." right authorized.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* inList:
* Shared list reference.
*
* inAuthorization:
* Authorization reference.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern OSStatus
LSSharedFileListSetAuthorization(
LSSharedFileListRef inList,
AuthorizationRef inAuthorization) API_DEPRECATED("No longer supported", macos(10.5, 10.11)) API_UNAVAILABLE(ios, tvos, watchos);
/*
* LSSharedFileListAddObserver() *** DEPRECATED ***
*
* Summary:
* Add observer of shared list changes.
*
* Discussion:
* Adds observer of shared list changes. The provided function will
* be called when the list has changed (or any item property has
* changed).
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* inList:
* Shared list reference.
*
* inRunloop:
* Runloop to run on.
*
* inRunloopMode:
* Mode for runloop.
*
* callback:
* Function to call when list has changed.
*
* context:
* Context pointer defined by client.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
LSSharedFileListAddObserver(
LSSharedFileListRef _Nullable inList,
CFRunLoopRef inRunloop,
CFStringRef inRunloopMode,
LSSharedFileListChangedProcPtr callback,
void * _Nullable context) API_DEPRECATED("No longer supported", macos(10.5, 10.11)) API_UNAVAILABLE(ios, tvos, watchos);
/*
* LSSharedFileListRemoveObserver() *** DEPRECATED ***
*
* Summary:
* Remove observer of shared list changes.
*
* Discussion:
* Removes observer of shared list changes.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* inList:
* Shared list reference.
*
* inRunloop:
* Runloop to run on.
*
* inRunloopMode:
* Mode for runloop.
*
* callback:
* Function to call when list has changed.
*
* context:
* Context pointer defined by client.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
LSSharedFileListRemoveObserver(
LSSharedFileListRef inList,
CFRunLoopRef inRunloop,
CFStringRef inRunloopMode,
LSSharedFileListChangedProcPtr callback,
void * _Nullable context) API_DEPRECATED("No longer supported", macos(10.5, 10.11)) API_UNAVAILABLE(ios, tvos, watchos);
/*
* LSSharedFileListGetSeedValue() *** DEPRECATED ***
*
* Summary:
* Return current seed value.
*
* Discussion:
* Returns seed value of the shared list.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* inList:
* Shared list reference.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern UInt32
LSSharedFileListGetSeedValue(LSSharedFileListRef inList) API_DEPRECATED("No longer supported", macos(10.5, 10.11)) API_UNAVAILABLE(ios, tvos, watchos);
/*
* LSSharedFileListCopyProperty() *** DEPRECATED ***
*
* Summary:
* Return property by its name.
*
* Discussion:
* Returns lists named property as CFTypeRef object.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* inList:
* Shared list reference.
*
* inPropertyName:
* Name of the property to return.
*
* Result:
* CFTypeRef containing requested property. NULL means list has no
* property with this name. Has to be released with CFRelease when
* property object is not needed anymore.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFTypeRef _Nullable
LSSharedFileListCopyProperty(
LSSharedFileListRef inList,
CFStringRef inPropertyName) API_DEPRECATED("No longer supported", macos(10.5, 10.11)) API_UNAVAILABLE(ios, tvos, watchos);
/*
* LSSharedFileListSetProperty() *** DEPRECATED ***
*
* Summary:
* Set property by its name.
*
* Discussion:
* Set lists named property as CFTypeRef object.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* inList:
* Shared list reference.
*
* inPropertyName:
* Name of the property to return.
*
* inPropertyData:
* Property data to set. Pass NULL to remove existing property.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern OSStatus
LSSharedFileListSetProperty(
LSSharedFileListRef inList,
CFStringRef inPropertyName,
CFTypeRef _Nullable inPropertyData) API_DEPRECATED("No longer supported", macos(10.5, 10.11)) API_UNAVAILABLE(ios, tvos, watchos);
/*
* LSSharedFileListCopySnapshot() *** DEPRECATED ***
*
* Summary:
* Create snapshot array.
*
* Discussion:
* Creates snapshot array, which is list of all items at the moment
* LSSharedFileListCopySnapshot was called.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* inList:
* Shared list reference.
*
* outSnapshotSeed:
* Returned seed value at which snapshot was taken.
*
* Result:
* Immutable CFArray of LSSharedFileListItemRef values. Has to be
* released with CFRelease when snapshot array is not needed anymore.
* Returns NULL if an error occurred.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFArrayRef _Nullable
LSSharedFileListCopySnapshot(
LSSharedFileListRef inList,
UInt32 * _Nullable outSnapshotSeed) API_DEPRECATED("No longer supported", macos(10.5, 10.11)) API_UNAVAILABLE(ios, tvos, watchos);
/*
* LSSharedFileListInsertItemURL() *** DEPRECATED ***
*
* Summary:
* Insert item into shared list.
*
* Discussion:
* Inserts item into shared list at specified location. If the item
* already exists in the list it will be moved and its icon, display
* name and properties will be updated.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* inList:
* Shared list reference.
*
* insertAfterThisItem:
* Item after which new item has to be inserted. To insert at the
* beginning of the list use kLSSharedFileListItemBeforeFirst or
* to insert at the end of the list use kLSSharedFileListItemLast.
*
* inDisplayName:
* Display name of the new item. Can be NULL.
*
* inIconRef:
* Icon of the new item. Can be NULL.
*
* inURL:
* URL of the new item.
*
* inPropertiesToSet:
* CFDictionary of properties to set. Keys are property names and
* values are property values. The property values are retained
* and copied by the API. Can be NULL.
*
* inPropertiesToClear:
* CFArray of property names to clear if item already exists. Can
* be NULL.
*
* Result:
* Reference to new item. Has to be released with CFRelease when the
* item is not needed anymore. Returns NULL if an error occurred.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern LSSharedFileListItemRef _Nullable
LSSharedFileListInsertItemURL(
LSSharedFileListRef inList,
LSSharedFileListItemRef insertAfterThisItem,
CFStringRef _Nullable inDisplayName,
IconRef _Nullable inIconRef,
CFURLRef inURL,
CFDictionaryRef _Nullable inPropertiesToSet,
CFArrayRef _Nullable inPropertiesToClear) API_DEPRECATED("No longer supported", macos(10.5, 10.11)) API_UNAVAILABLE(ios, tvos, watchos);
/*
* LSSharedFileListInsertItemFSRef() *** DEPRECATED ***
*
* Summary:
* Insert item into shared list.
*
* Discussion:
* Inserts item into shared list at specified location. If the item
* already exists in the list it will be moved and its icon, display
* name and properties will be updated.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* inList:
* Shared list reference.
*
* insertAfterThisItem:
* Item after which new item has to be inserted. To insert at the
* beginning of the list use kLSSharedFileListItemBeforeFirst or
* to insert at the end of the list use kLSSharedFileListItemLast.
*
* inDisplayName:
* Display name of the new item. Can be NULL.
*
* inIconRef:
* Icon of the new item. Can be NULL.
*
* inFSRef:
* FSRef of the new item.
*
* inPropertiesToSet:
* CFDictionary of properties to set. Keys are property names and
* values are property values. The property values are retained
* and copied by the API. Can be NULL.
*
* inPropertiesToClear:
* CFArray of property names to clear if item already exists. Can
* be NULL.
*
* Result:
* Reference to new item. Has to be released with CFRelease when the
* item is not needed anymore.
*
* Deprecated:
* Use LSSharedFileListInsertItemURL instead.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern LSSharedFileListItemRef
LSSharedFileListInsertItemFSRef(
LSSharedFileListRef inList,
LSSharedFileListItemRef insertAfterThisItem,
CFStringRef _Nullable inDisplayName,
IconRef _Nullable inIconRef,
const FSRef * inFSRef,
CFDictionaryRef _Nullable inPropertiesToSet,
CFArrayRef _Nullable inPropertiesToClear) API_DEPRECATED_WITH_REPLACEMENT("LSSharedFileListInsertItemURL", macos(10.5, 10.10)) API_UNAVAILABLE(ios, tvos, watchos);
/*
* LSSharedFileListItemMove() *** DEPRECATED ***
*
* Summary:
* Move item.
*
* Discussion:
* Moves item at specified location.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* inList:
* Shared list reference.
*
* inItem:
* Item to move.
*
* inMoveAfterItem:
* New icon of the new item. Use kLSSharedFileListItemBeforeFirst
* and kLSSharedFileListItemLast to move at the beginning or the
* end of the shared list.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern OSStatus
LSSharedFileListItemMove(
LSSharedFileListRef inList,
LSSharedFileListItemRef inItem,
LSSharedFileListItemRef inMoveAfterItem) API_DEPRECATED("No longer supported", macos(10.5, 10.11)) API_UNAVAILABLE(ios, tvos, watchos);
/*
* LSSharedFileListItemRemove() *** DEPRECATED ***
*
* Summary:
* Remove item from shared list.
*
* Discussion:
* Removes item from shared list.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* inList:
* Shared list reference.
*
* inItem:
* Item to remove.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern OSStatus
LSSharedFileListItemRemove(
LSSharedFileListRef inList,
LSSharedFileListItemRef inItem) API_DEPRECATED("No longer supported", macos(10.5, 10.11)) API_UNAVAILABLE(ios, tvos, watchos);
/*
* LSSharedFileListRemoveAllItems() *** DEPRECATED ***
*
* Summary:
* Remove all items from shared list.
*
* Discussion:
* Removes all items from shared list.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* inList:
* Shared list to clear.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern OSStatus
LSSharedFileListRemoveAllItems(LSSharedFileListRef inList) API_DEPRECATED("No longer supported", macos(10.5, 10.11)) API_UNAVAILABLE(ios, tvos, watchos);
/*
* LSSharedFileListItemGetID() *** DEPRECATED ***
*
* Summary:
* Obtain unique item id.
*
* Discussion:
* Returns unique item id.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern UInt32
LSSharedFileListItemGetID(LSSharedFileListItemRef inItem) API_DEPRECATED("No longer supported", macos(10.5, 10.11)) API_UNAVAILABLE(ios, tvos, watchos);
/*
* LSSharedFileListItemCopyIconRef() *** DEPRECATED ***
*
* Summary:
* Obtain item's icon.
*
* Discussion:
* Returns icon ref for the item.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Result:
* IconRef to the item. Caller is responsible to releasing it by
* calling ReleaseIconRef().
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern IconRef
LSSharedFileListItemCopyIconRef(LSSharedFileListItemRef inItem) API_DEPRECATED("No longer supported", macos(10.5, 10.11)) API_UNAVAILABLE(ios, tvos, watchos);
/*
* LSSharedFileListItemCopyDisplayName() *** DEPRECATED ***
*
* Summary:
* Obtain item's display name.
*
* Discussion:
* Returns display name of the item. Caller is responsible to
* releasing it by calling CFRelease().
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFStringRef
LSSharedFileListItemCopyDisplayName(LSSharedFileListItemRef inItem) API_DEPRECATED("No longer supported", macos(10.5, 10.11)) API_UNAVAILABLE(ios, tvos, watchos);
/*
* LSSharedFileListItemResolve() *** DEPRECATED ***
*
* Summary:
* Resolve LSSharedFileListItemRef's item and return its FSRef.
*
* Discussion:
* Resolves LSSharedFileListItemRef's item and returns its FSRef.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* inItem:
* Item to resolve.
*
* inFlags:
* Resolution flags. Pass zero for default resolution flags.
*
* outURL:
* CFURL of original item. Can be NULL. Returned valus has to be
* released with CFRelease().
*
* outRef:
* FSRef of original item. Can be NULL.
*
* Deprecated:
* Use LSSharedFileListItemCopyResolvedURL instead.
*
*/
extern OSStatus
LSSharedFileListItemResolve(
LSSharedFileListItemRef inItem,
LSSharedFileListResolutionFlags inFlags,
CFURLRef _Nullable * _Nullable outURL,
FSRef * _Nullable outRef) API_DEPRECATED_WITH_REPLACEMENT("LSSharedFileListItemCopyResolvedURL", macos(10.5, 10.10)) API_UNAVAILABLE(ios, tvos, watchos);
/*
* LSSharedFileListItemCopyResolvedURL() *** DEPRECATED ***
*
* Summary:
* Resolve the shared file list item and return its URL.
*
* Discussion:
* Resolves the shared file list item and returns its URL. For backwards
* compatibility, a sandboxed app will receive an extension to its
* sandbox for the URL. It is the responsibility of the caller to
* call -stopAccessingSecurityScopedResource to avoid leaking resources
* when it is no longer needs access.
*
* Parameters:
*
* inItem:
* The item to resolve. Must not be NULL.
*
* inFlags:
* Resolution flags. Pass zero for default resolution flags.
*
* outError:
* On failure, set to a CFError describing the problem. If you are
* not interested in this information, pass NULL. The caller is
* responsible for releasing this object.
*
* Result:
* A URL corresponding to the shared file list item, if available,
* or NULL if it cannot be resolved. Note that an item may be present in
* a shared file list but no longer present in the file system, in
* which case NULL will be returned.
* The caller is responsible for releasing this URL.
*/
extern CFURLRef _Nullable
LSSharedFileListItemCopyResolvedURL(
LSSharedFileListItemRef inItem,
LSSharedFileListResolutionFlags inFlags,
CFErrorRef _Nullable * _Nullable outError) API_DEPRECATED("No longer supported", macos(10.10, 10.11)) API_UNAVAILABLE(ios, tvos, watchos);
/*
* LSSharedFileListItemCopyProperty() *** DEPRECATED ***
*
* Summary:
* Obtain item's property by its name.
*
* Discussion:
* Returns persistent item's property as CF object. Caller is
* responsible to releasing it by calling CFRelease().
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFTypeRef _Nullable
LSSharedFileListItemCopyProperty(
LSSharedFileListItemRef inItem,
CFStringRef inPropertyName) API_DEPRECATED("No longer supported", macos(10.5, 10.11)) API_UNAVAILABLE(ios, tvos, watchos);
/*
* LSSharedFileListItemSetProperty() *** DEPRECATED ***
*
* Summary:
* Set item property by its name.
*
* Discussion:
* Sets persistent item property by its name.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern OSStatus
LSSharedFileListItemSetProperty(
LSSharedFileListItemRef inItem,
CFStringRef inPropertyName,
CFTypeRef inPropertyData) API_DEPRECATED("No longer supported", macos(10.5, 10.11)) API_UNAVAILABLE(ios, tvos, watchos);
#ifdef __cplusplus
}
#endif
CF_ASSUME_NONNULL_END
#endif /* __LSSHAREDFILELIST__ */
#endif // TARGET_OS_OSX
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/OSServices.framework/OSServices.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: 2AC37B30-0810-3E4E-B266-A8C13C2F61A2
- target: x86_64-maccatalyst
value: 2AC37B30-0810-3E4E-B266-A8C13C2F61A2
- target: arm64-macos
value: 00000000-0000-0000-0000-000000000000
- target: arm64-maccatalyst
value: 00000000-0000-0000-0000-000000000000
- target: arm64e-macos
value: BA1BB273-1814-3EFF-B4ED-DDDFDB622786
- target: arm64e-maccatalyst
value: BA1BB273-1814-3EFF-B4ED-DDDFDB622786
install-name: '/System/Library/Frameworks/CoreServices.framework/Versions/A/Frameworks/OSServices.framework/Versions/A/OSServices'
current-version: 1141.1
parent-umbrella:
- targets: [ x86_64-macos, x86_64-maccatalyst, arm64-macos, arm64-maccatalyst,
arm64e-macos, arm64e-maccatalyst ]
umbrella: CoreServices
exports:
- targets: [ x86_64-maccatalyst, x86_64-macos, arm64e-maccatalyst, arm64e-macos,
arm64-macos, arm64-maccatalyst ]
symbols: [ _AlertSoundPlay, _AlertSoundPlayCustomSound, _BatteryCount,
_CSGetDefaultIdentityAuthority, _CSGetLocalIdentityAuthority,
_CSGetManagedIdentityAuthority, _CSIdentityAddAlias, _CSIdentityAddMember,
_CSIdentityAuthenticateUsingPassword, _CSIdentityAuthorityCopyLocalizedName,
_CSIdentityAuthorityGetTypeID, _CSIdentityCommit, _CSIdentityCommitAsynchronously,
_CSIdentityCreate, _CSIdentityCreateCopy, _CSIdentityCreateGroupMembershipQuery,
_CSIdentityCreatePersistentReference, _CSIdentityDelete, _CSIdentityGetAliases,
_CSIdentityGetAuthority, _CSIdentityGetCertificate, _CSIdentityGetClass,
_CSIdentityGetEmailAddress, _CSIdentityGetFullName, _CSIdentityGetImageData,
_CSIdentityGetImageDataType, _CSIdentityGetImageURL, _CSIdentityGetPosixID,
_CSIdentityGetPosixName, _CSIdentityGetTypeID, _CSIdentityGetUUID,
_CSIdentityIsCommitting, _CSIdentityIsEnabled, _CSIdentityIsHidden,
_CSIdentityIsMemberOfGroup, _CSIdentityQueryCopyResults, _CSIdentityQueryCreate,
_CSIdentityQueryCreateForCurrentUser, _CSIdentityQueryCreateForName,
_CSIdentityQueryCreateForPersistentReference, _CSIdentityQueryCreateForPosixID,
_CSIdentityQueryCreateForUUID, _CSIdentityQueryExecute, _CSIdentityQueryExecuteAsynchronously,
_CSIdentityQueryGetTypeID, _CSIdentityQueryStop, _CSIdentityRemoveAlias,
_CSIdentityRemoveClient, _CSIdentityRemoveMember, _CSIdentitySetCertificate,
_CSIdentitySetEmailAddress, _CSIdentitySetFullName, _CSIdentitySetImageData,
_CSIdentitySetImageURL, _CSIdentitySetIsEnabled, _CSIdentitySetPassword,
_CurrentProcessorSpeed, _GetCPUSpeed, _KCAddCallback, _KCCopyItem,
_KCCountKeychains, _KCDeleteItem, _KCFindAppleSharePassword,
_KCFindFirstItem, _KCFindGenericPassword, _KCFindInternetPassword,
_KCFindInternetPasswordWithPath, _KCFindNextItem, _KCGetAttribute,
_KCGetData, _KCGetDefaultKeychain, _KCGetIndKeychain, _KCGetKeychain,
_KCGetKeychainManagerVersion, _KCGetKeychainName, _KCGetStatus,
_KCIsInteractionAllowed, _KCLock, _KCMakeAliasFromKCRef, _KCMakeKCRefFromAlias,
_KCMakeKCRefFromFSRef, _KCNewItem, _KCReleaseItem, _KCReleaseKeychain,
_KCReleaseSearch, _KCRemoveCallback, _KCSetAttribute, _KCSetData,
_KCSetDefaultKeychain, _KCSetInteractionAllowed, _KCUnlockNoUI,
_KCUpdateItem, _MakeAppleSharePasswordKCItemRef, _MakeGenericPasswordKCItemRef,
_MakeInternetPasswordKCItemRef, _MaximumProcessorSpeed, _MinimumProcessorSpeed,
_SecNewAFPXVolMountInfo, _Sleep, _SleepQInstall, _SleepQRemove,
_SystemSoundGetActionID, _SystemSoundGetProperty, _SystemSoundGetPropertyInfo,
_SystemSoundPlay, _SystemSoundRemoveActionID, _SystemSoundRemoveCompletionRoutine,
_SystemSoundSetCompletionRoutine, _SystemSoundSetProperty,
_UpdateSystemActivity, _WSGetCFTypeIDFromWSTypeID, _WSGetWSTypeIDFromCFType,
_WSMethodInvocationAddDeserializationOverride, _WSMethodInvocationAddSerializationOverride,
_WSMethodInvocationCopyParameters, _WSMethodInvocationCopyProperty,
_WSMethodInvocationCopySerialization, _WSMethodInvocationCreate,
_WSMethodInvocationCreateFromSerialization, _WSMethodInvocationGetTypeID,
_WSMethodInvocationInvoke, _WSMethodInvocationScheduleWithRunLoop,
_WSMethodInvocationSetCallBack, _WSMethodInvocationSetParameters,
_WSMethodInvocationSetProperty, _WSMethodInvocationUnscheduleFromRunLoop,
_WSMethodResultIsFault, _WSProtocolHandlerCopyFaultDocument,
_WSProtocolHandlerCopyProperty, _WSProtocolHandlerCopyReplyDictionary,
_WSProtocolHandlerCopyReplyDocument, _WSProtocolHandlerCopyRequestDictionary,
_WSProtocolHandlerCopyRequestDocument, _WSProtocolHandlerCreate,
_WSProtocolHandlerGetTypeID, _WSProtocolHandlerSetDeserializationOverride,
_WSProtocolHandlerSetProperty, _WSProtocolHandlerSetSerializationOverride,
__AppleIDAuthenticatePassword, __AppleIDAuthenticatePasswordWithBlock,
__AppleIDAuthenticationAddAppleID, __AppleIDAuthenticationAddAppleIDWithBlock,
__AppleIDAuthenticationCopyAppleIDs, __AppleIDAuthenticationCopyCertificateInfo,
__AppleIDAuthenticationCopyCertificateInfoWithBlock, __AppleIDAuthenticationCopyMyInfo,
__AppleIDAuthenticationCopyMyInfoWithBlock, __AppleIDAuthenticationCopyStatus,
__AppleIDAuthenticationCopyStatusWithBlock, __AppleIDAuthenticationFindPerson,
__AppleIDAuthenticationFindPersonWithBlock, __AppleIDAuthenticationForgetAppleID,
__AppleIDAuthenticationForgetAppleIDWithBlock, __AppleIDBreadcrumbCheckinWithBlock,
__AppleIDCopyDSIDForCertificate, __AppleIDCopySecIdentityForAppleIDAccount,
__AppleIDGetBreadcrumbEncryptedKeyWithBlock, __AppleIDSetBreadcrumbEncryptedKeyWithBlock,
__AppleIDUpdateLinkedIdentityProvisioning, __AppleIDUpdateLinkedIdentityProvisioningWithBlock,
__CSAddAppleIDAccount, __CSAddAppleIDAccountUsingCompletionBlock,
__CSBackToMyMacCopyDomain, __CSBackToMyMacCopyDomains, __CSBackToMyMacDisableEveryone,
__CSBackToMyMacIsEnabledForSomeUser, __CSBackToMyMacResetForUser,
__CSCopyAccountIdentifierForAppleIDCertificate, __CSCopyAccountIdentifierForAppleIDCertificateChain,
__CSCopyAccountInfoForAppleID, __CSCopyAccountStatusForAppleID,
__CSCopyAppleIDAccountForAppleIDCertificate, __CSCopyAppleIDAccounts,
__CSCopyCommentForServerName, __CSCopyDefaultSharingSecIdentities,
__CSCopyKerberosPrincipalForCertificate, __CSCopyLocalHostnameForComputerName,
__CSCopySecIdentityForAppleID, __CSCopyUserIdentityForPersonInfo,
__CSCreateAppleIDIdentityWithCertificate, __CSCreateAppleIDIdentityWithCertificateChain,
__CSCreateAppleIDIdentityWithNameAndAccountIdentifier, __CSCreatePosixNameFromString,
__CSDeviceSupportsAirDrop, __CSDeviceSupportsODisk, __CSDisassociateWireless,
__CSEnableWirelessP2P, __CSGetAppleIDIdentityAuthority, __CSIdentityAddLinkedIdentityWithNameAndAuthority,
__CSIdentityAllowsPasswordResetWithAuthority, __CSIdentityAllowsPasswordResetWithAuthorityFromDSAttrData,
__CSIdentityAuthenticateUsingCertificate, __CSIdentityAuthenticateUsingCertificateChain,
__CSIdentityAuthenticateUsingPassword, __CSIdentityAuthorityAuthenticateNameAndPassword,
__CSIdentityAuthorityCopyIdentityWithName, __CSIdentityChangePassword,
__CSIdentityCopyCurrentUser, __CSIdentityCopyLinkedIdentityAuthorities,
__CSIdentityCopyLinkedIdentityNameWithAuthorityFromDSAttrData,
__CSIdentityCopyLinkedIdentityNamesWithAuthority, __CSIdentityCopyLinkedIdentityNamesWithAuthorityFromDSAttrData,
__CSIdentityGetHomeDirectoryURL, __CSIdentityGetLinkedIdentityNameWithAuthority,
__CSIdentityGetLoginShellURL, __CSIdentityIsLoginUser, __CSIdentityRemoveLinkedIdentityWithAuthority,
__CSIdentityRemoveLinkedIdentityWithNameAndAuthority, __CSIdentitySetAllowsPasswordResetWithAuthority,
__CSIdentityUpdateLinkedIdentityProvisioning, __CSIsComputerToComputerEnabled,
__CSIsCurrentUserAdmin, __CSIsMobileTimeMachineDisk, __CSIsMobileTimeMachineEnabled,
__CSIsOpticalDisk, __CSIsWirelessAccessPointEnabled, __CSIsWirelessP2PEnabled,
__CSLinkCurrentUserToAppleIDWithVerifiedAccountIdentifier,
__CSRemoveAppleIDAccount, __CSRemoveDotMacIdentitiesFromKeychain,
__CSUnlinkCurrentUserFromAppleID, __ISGetIconIndex, __ISGetIconIndexInfo,
__ISIconIndexHasJPEGFlag, __LWCopyNextFireDateForScheduledAction,
__LWRemoveScheduledAction, __LWScheduleCommandAction, __LWScheduleOpenItemAction,
__LWScheduleOpenURLAction, __LWSchedulerNotifyPortName, __OSS_InstallGestaltSelectors,
__kCSAppleIDAccountAllEmailAddresses, __kCSAppleIDAccountAppleID,
__kCSAppleIDAccountCertificateExpirationDate, __kCSAppleIDAccountCertificateSerialNumber,
__kCSAppleIDAccountFirstName, __kCSAppleIDAccountLastName,
__kCSAppleIDAccountStateCertificateAssumedOK, __kCSAppleIDAccountStateCertificateExpired,
__kCSAppleIDAccountStateCertificateMustBeRenewed, __kCSAppleIDAccountStateCertificateOK,
__kCSAppleIDAccountStateCertificatePending, __kCSAppleIDAccountStateCertificateRevoked,
__kCSAppleIDAccountStateCertificateShouldBeRenewed, __kCSAppleIDAccountStateNoCertificate,
__kCSAppleIDAccountStateNoEncodedDSID, __kCSAppleIDAccountStatePasswordInaccessibleInKeychain,
__kCSAppleIDAccountStatePasswordInvalid, __kCSAppleIDAccountStateUnknown,
__kCSAppleIDAccountStatusAccountStateKey, __kCSAppleIDAccountStatusNextActionTimeKey,
__kCSAppleIDAccountStatusRequiresUserActionKey, __kCSAppleIDAccountStatusValidationDateKey,
__kCSAppleIDAccountVerifiedEmailAddresses, __kCSAppleIDAccountVerifiedPhoneNumbers,
__kCSAppleIDOptionDeferServerCheck, __kCSAppleIDOptionForceServerCheck,
__kCSAppleIDOptionSkipServerCheck, _kAppleIDAccountAddedOrRemovedNotificationKey,
_kAppleIDAccountConfigurationChangeNotificationKey, _kAppleIDAuthenticationStatusTerminateServerKey,
_kAppleIDDoNotSaveSessionInformation, _kAppleIDEncodedDSIDCertificateType,
_kAppleIDValidatedItemsRecordDataCertificateType, _kAppleIDValidationRecordOptionDoNotCheckValidAsOfDateKey,
_kAppleIDValidationRecordOptionDoNotCheckVersionKey, _kAppleIDValidationRecordOptionDoNotEvaluateTrustRefKey,
_kAppleIDValidationRecordOptionOverrideSuggestedDurationValueKey,
_kCSIdentityErrorDomain, _kCSIdentityGeneratePosixName, _kISIconResType,
_kWSAuthInfo, _kWSAuthInfo_authScheme, _kWSAuthInfo_forProxy,
_kWSAuthInfo_password, _kWSAuthInfo_user, _kWSDebugIncomingBody,
_kWSDebugIncomingHeaders, _kWSDebugOutgoingBody, _kWSDebugOutgoingHeaders,
_kWSFaultCode, _kWSFaultExtra, _kWSFaultString, _kWSHTTPExtraHeaders,
_kWSHTTPFollowsRedirects, _kWSHTTPMessage, _kWSHTTPProxy,
_kWSHTTPResponseMessage, _kWSHTTPVersion, _kWSMethodInvocationResult,
_kWSMethodInvocationResultParameterName, _kWSMethodInvocationTimeoutValue,
_kWSNetworkStreamFaultString, _kWSPostingMethod, _kWSRecordNamespaceURI,
_kWSRecordParameterOrder, _kWSRecordType, _kWSSOAP1999Protocol,
_kWSSOAP2001Protocol, _kWSSOAPBodyEncodingStyle, _kWSSOAPMessageHeaders,
_kWSSOAPMethodNamespaceURI, _kWSSOAPStyleDoc, _kWSSOAPStyleRPC,
_kWSStreamErrorDomain, _kWSStreamErrorError, _kWSStreamErrorMessage,
_kWSXMLRPCProtocol, _kcfindapplesharepassword, _kcfindgenericpassword,
_kcfindinternetpassword, _kcfindinternetpasswordwithpath,
_kcgetkeychainname, _wsCFDateToISO8601String, _wsCreateDateFromISO8601 ]
...
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/OSServices.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/OSServices.framework/Headers/CSIdentityAuthority.h | /*
File: OSServices/CSIdentityAuthority.h
Contains: CSIdentityAuthority APIs
Copyright: (c) 2006-2011 Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __CSIDENTITYAUTHORITY__
#define __CSIDENTITYAUTHORITY__
#ifndef __COREFOUNDATION__
#include <CoreFoundation/CoreFoundation.h>
#endif
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
/*
* CSIdentityAuthorityRef
*
* Discussion:
* A reference to an identity authority object. An identity
* authority is a logical repository for identities.
*/
typedef struct __CSIdentityAuthority* CSIdentityAuthorityRef;
/*
* CSIdentityAuthorityGetTypeID()
*
* Summary:
* Returns the CSIdentityAuthority type identifier
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Result:
* The CFTypeID of the CSIdentityAuthority Core Foundation type
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFTypeID
CSIdentityAuthorityGetTypeID(void) API_AVAILABLE( ios(5.0), macos(10.5), tvos(9.0), watchos(1.0) );
/*
* CSGetDefaultIdentityAuthority()
*
* Summary:
* Returns the system's default identity authority
*
* Discussion:
* The default identity authority is a pseudo-authority representing
* the union of the local identity authority and the managed
* identity authority. The function CSIdentityGetAuthority will
* never return the default authority instance.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Result:
* The CSIdentityAuthorityRef of the default authority
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CSIdentityAuthorityRef
CSGetDefaultIdentityAuthority(void) API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* CSGetLocalIdentityAuthority()
*
* Summary:
* Returns the identity authority for identities defined on the
* local host
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Result:
* The CSIdentityAuthorityRef of the local authority
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CSIdentityAuthorityRef
CSGetLocalIdentityAuthority(void) API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* CSGetManagedIdentityAuthority()
*
* Summary:
* Returns the identity authority for identities defined in the
* system's managed directory server(s)
*
* Discussion:
* There is always a valid managed identity authority instance, but
* if the system is not bound to any managed directory servers, the
* managed identity authority will contain no identities.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Result:
* The CSIdentityAuthorityRef of the managed authority
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CSIdentityAuthorityRef
CSGetManagedIdentityAuthority(void) API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* CSIdentityAuthorityCopyLocalizedName()
*
* Summary:
* Returns the localized name of an identity authority
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* authority:
* The identity authority to access
*
* Result:
* A CFStringRef containing the localized authority name
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFStringRef
CSIdentityAuthorityCopyLocalizedName(CSIdentityAuthorityRef authority) API_AVAILABLE( ios(5.0), macos(10.5), tvos(9.0), watchos(1.0) );
#ifdef __cplusplus
}
#endif
#endif /* __CSIDENTITYAUTHORITY__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/OSServices.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/OSServices.framework/Headers/KeychainCore.h | /*
File: OSServices/KeychainCore.h
Contains: *** DEPRECATED *** Keychain low-level Interfaces
Copyright: (c) 2000-2011 Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __KEYCHAINCORE__
#define __KEYCHAINCORE__
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
#ifndef __FILES__
#include <CarbonCore/Files.h>
#endif
#ifndef __ALIASES__
#include <CarbonCore/Aliases.h>
#endif
#ifndef __CODEFRAGMENTS__
#include <CarbonCore/CodeFragments.h>
#endif
#ifndef __MACERRORS__
#include <CarbonCore/MacErrors.h>
#endif
#ifndef __SEC_TYPES__
#include <Security/SecBase.h>
#endif
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
#pragma pack(push, 2)
typedef SecKeychainRef KCRef;
typedef SecKeychainItemRef KCItemRef;
typedef SecKeychainSearchRef KCSearchRef;
typedef SecKeychainAttribute KCAttribute;
typedef SecKeychainAttributeList KCAttributeList;
typedef SecKeychainAttrType KCAttrType;
typedef SecKeychainStatus KCStatus;
typedef UInt16 KCEvent;
enum {
kIdleKCEvent = 0, /* null event */
kLockKCEvent = 1, /* a keychain was locked */
kUnlockKCEvent = 2, /* a keychain was unlocked */
kAddKCEvent = 3, /* an item was added to a keychain */
kDeleteKCEvent = 4, /* an item was deleted from a keychain */
kUpdateKCEvent = 5, /* an item was updated */
kPasswordChangedKCEvent = 6, /* the keychain identity was changed */
kSystemKCEvent = 8, /* the keychain client can process events */
kDefaultChangedKCEvent = 9, /* the default keychain was changed */
kDataAccessKCEvent = 10, /* a process has accessed a keychain item's data */
kKeychainListChangedKCEvent = 11 /* the list of keychains has changed */
};
typedef UInt16 KCEventMask;
enum {
kIdleKCEventMask = 1 << kIdleKCEvent,
kLockKCEventMask = 1 << kLockKCEvent,
kUnlockKCEventMask = 1 << kUnlockKCEvent,
kAddKCEventMask = 1 << kAddKCEvent,
kDeleteKCEventMask = 1 << kDeleteKCEvent,
kUpdateKCEventMask = 1 << kUpdateKCEvent,
kPasswordChangedKCEventMask = 1 << kPasswordChangedKCEvent,
kSystemEventKCEventMask = 1 << kSystemKCEvent,
kDefaultChangedKCEventMask = 1 << kDefaultChangedKCEvent,
kDataAccessKCEventMask = 1 << kDataAccessKCEvent,
kEveryKCEventMask = 0xFFFF /* all of the above*/
};
typedef UInt8 AFPServerSignature[16];
typedef UInt8 KCPublicKeyHash[20];
struct KCCallbackInfo {
UInt32 version;
KCItemRef item;
SInt32 processID[2]; /* unavailable on Mac OS X*/
SInt32 event[4]; /* unavailable on Mac OS X*/
KCRef keychain;
};
typedef struct KCCallbackInfo KCCallbackInfo;
enum {
kUnlockStateKCStatus = 1,
kRdPermKCStatus = 2,
kWrPermKCStatus = 4
};
enum {
kCertificateKCItemClass = 'cert', /* Certificate */
kAppleSharePasswordKCItemClass = 'ashp', /* Appleshare password */
kInternetPasswordKCItemClass = 'inet', /* Internet password */
kGenericPasswordKCItemClass = 'genp' /* Generic password */
};
typedef FourCharCode KCItemClass;
enum {
/* Common attributes */
kClassKCItemAttr = 'clas', /* Item class (KCItemClass) */
kCreationDateKCItemAttr = 'cdat', /* Date the item was created (UInt32) */
kModDateKCItemAttr = 'mdat', /* Last time the item was updated (UInt32) */
kDescriptionKCItemAttr = 'desc', /* User-visible description string (string) */
kCommentKCItemAttr = 'icmt', /* User's comment about the item (string) */
kCreatorKCItemAttr = 'crtr', /* Item's creator (OSType) */
kTypeKCItemAttr = 'type', /* Item's type (OSType) */
kScriptCodeKCItemAttr = 'scrp', /* Script code for all strings (ScriptCode) */
kLabelKCItemAttr = 'labl', /* Item label (string) */
kInvisibleKCItemAttr = 'invi', /* Invisible (boolean) */
kNegativeKCItemAttr = 'nega', /* Negative (boolean) */
kCustomIconKCItemAttr = 'cusi', /* Custom icon (boolean) */
kAccountKCItemAttr = 'acct', /* User account (string) */
/* Unique Generic password attributes */
kServiceKCItemAttr = 'svce', /* Service (string) */
kGenericKCItemAttr = 'gena', /* User-defined attribute (untyped bytes) */
/* Unique Internet password attributes */
kSecurityDomainKCItemAttr = 'sdmn', /* Security domain (string) */
kServerKCItemAttr = 'srvr', /* Server's domain name or IP address (string) */
kAuthTypeKCItemAttr = 'atyp', /* Authentication Type (KCAuthType) */
kPortKCItemAttr = 'port', /* Port (UInt16) */
kPathKCItemAttr = 'path', /* Path (string) */
/* Unique Appleshare password attributes */
kVolumeKCItemAttr = 'vlme', /* Volume (string) */
kAddressKCItemAttr = 'addr', /* Server address (IP or domain name) or zone name (string) */
kSignatureKCItemAttr = 'ssig', /* Server signature block (AFPServerSignature) */
/* Unique AppleShare and Internet attributes */
kProtocolKCItemAttr = 'ptcl', /* Protocol (KCProtocolType) */
/* Certificate attributes */
kSubjectKCItemAttr = 'subj', /* Subject distinguished name (DER-encoded data) */
kCommonNameKCItemAttr = 'cn ', /* Common Name (UTF8-encoded string) */
kIssuerKCItemAttr = 'issu', /* Issuer distinguished name (DER-encoded data) */
kSerialNumberKCItemAttr = 'snbr', /* Certificate serial number (DER-encoded data) */
kEMailKCItemAttr = 'mail', /* E-mail address (ASCII-encoded string) */
kPublicKeyHashKCItemAttr = 'hpky', /* Hash of public key (KCPublicKeyHash), 20 bytes max. */
kIssuerURLKCItemAttr = 'iurl', /* URL of the certificate issuer (ASCII-encoded string) */
/* Shared by keys and certificates */
kEncryptKCItemAttr = 'encr', /* Encrypt (Boolean) */
kDecryptKCItemAttr = 'decr', /* Decrypt (Boolean) */
kSignKCItemAttr = 'sign', /* Sign (Boolean) */
kVerifyKCItemAttr = 'veri', /* Verify (Boolean) */
kWrapKCItemAttr = 'wrap', /* Wrap (Boolean) */
kUnwrapKCItemAttr = 'unwr', /* Unwrap (Boolean) */
kStartDateKCItemAttr = 'sdat', /* Start Date (UInt32) */
kEndDateKCItemAttr = 'edat' /* End Date (UInt32) */
};
typedef FourCharCode KCItemAttr;
enum {
kKCAuthTypeNTLM = 'ntlm',
kKCAuthTypeMSN = 'msna',
kKCAuthTypeDPA = 'dpaa',
kKCAuthTypeRPA = 'rpaa',
kKCAuthTypeHTTPDigest = 'httd',
kKCAuthTypeDefault = 'dflt'
};
typedef FourCharCode KCAuthType;
enum {
kKCProtocolTypeFTP = 'ftp ',
kKCProtocolTypeFTPAccount = 'ftpa',
kKCProtocolTypeHTTP = 'http',
kKCProtocolTypeIRC = 'irc ',
kKCProtocolTypeNNTP = 'nntp',
kKCProtocolTypePOP3 = 'pop3',
kKCProtocolTypeSMTP = 'smtp',
kKCProtocolTypeSOCKS = 'sox ',
kKCProtocolTypeIMAP = 'imap',
kKCProtocolTypeLDAP = 'ldap',
kKCProtocolTypeAppleTalk = 'atlk',
kKCProtocolTypeAFP = 'afp ',
kKCProtocolTypeTelnet = 'teln'
};
typedef FourCharCode KCProtocolType;
typedef UInt32 KCCertAddOptions;
enum {
kSecOptionReserved = 0x000000FF, /* First byte reserved for SecOptions flags */
kCertUsageShift = 8, /* start at bit 8 */
kCertUsageSigningAdd = 1 << (kCertUsageShift + 0),
kCertUsageSigningAskAndAdd = 1 << (kCertUsageShift + 1),
kCertUsageVerifyAdd = 1 << (kCertUsageShift + 2),
kCertUsageVerifyAskAndAdd = 1 << (kCertUsageShift + 3),
kCertUsageEncryptAdd = 1 << (kCertUsageShift + 4),
kCertUsageEncryptAskAndAdd = 1 << (kCertUsageShift + 5),
kCertUsageDecryptAdd = 1 << (kCertUsageShift + 6),
kCertUsageDecryptAskAndAdd = 1 << (kCertUsageShift + 7),
kCertUsageKeyExchAdd = 1 << (kCertUsageShift + 8),
kCertUsageKeyExchAskAndAdd = 1 << (kCertUsageShift + 9),
kCertUsageRootAdd = 1 << (kCertUsageShift + 10),
kCertUsageRootAskAndAdd = 1 << (kCertUsageShift + 11),
kCertUsageSSLAdd = 1 << (kCertUsageShift + 12),
kCertUsageSSLAskAndAdd = 1 << (kCertUsageShift + 13),
kCertUsageAllAdd = 0x7FFFFF00
};
typedef UInt16 KCVerifyStopOn;
enum {
kPolicyKCStopOn = 0,
kNoneKCStopOn = 1,
kFirstPassKCStopOn = 2,
kFirstFailKCStopOn = 3
};
typedef UInt32 KCCertSearchOptions;
enum {
kCertSearchShift = 0, /* start at bit 0 */
kCertSearchSigningIgnored = 0,
kCertSearchSigningAllowed = 1 << (kCertSearchShift + 0),
kCertSearchSigningDisallowed = 1 << (kCertSearchShift + 1),
kCertSearchSigningMask = ((kCertSearchSigningAllowed) | (kCertSearchSigningDisallowed)),
kCertSearchVerifyIgnored = 0,
kCertSearchVerifyAllowed = 1 << (kCertSearchShift + 2),
kCertSearchVerifyDisallowed = 1 << (kCertSearchShift + 3),
kCertSearchVerifyMask = ((kCertSearchVerifyAllowed) | (kCertSearchVerifyDisallowed)),
kCertSearchEncryptIgnored = 0,
kCertSearchEncryptAllowed = 1 << (kCertSearchShift + 4),
kCertSearchEncryptDisallowed = 1 << (kCertSearchShift + 5),
kCertSearchEncryptMask = ((kCertSearchEncryptAllowed) | (kCertSearchEncryptDisallowed)),
kCertSearchDecryptIgnored = 0,
kCertSearchDecryptAllowed = 1 << (kCertSearchShift + 6),
kCertSearchDecryptDisallowed = 1 << (kCertSearchShift + 7),
kCertSearchDecryptMask = ((kCertSearchDecryptAllowed) | (kCertSearchDecryptDisallowed)),
kCertSearchWrapIgnored = 0,
kCertSearchWrapAllowed = 1 << (kCertSearchShift + 8),
kCertSearchWrapDisallowed = 1 << (kCertSearchShift + 9),
kCertSearchWrapMask = ((kCertSearchWrapAllowed) | (kCertSearchWrapDisallowed)),
kCertSearchUnwrapIgnored = 0,
kCertSearchUnwrapAllowed = 1 << (kCertSearchShift + 10),
kCertSearchUnwrapDisallowed = 1 << (kCertSearchShift + 11),
kCertSearchUnwrapMask = ((kCertSearchUnwrapAllowed) | (kCertSearchUnwrapDisallowed)),
kCertSearchPrivKeyRequired = 1 << (kCertSearchShift + 12),
kCertSearchAny = 0
};
/* Other constants */
enum {
kAnyPort = 0
};
enum {
kAnyProtocol = 0,
kAnyAuthType = 0
};
/* Opening and getting information about the Keychain Manager */
/*
* KCGetKeychainManagerVersion() *** DEPRECATED ***
*
* Deprecated:
* Use SecKeychainGetVersion
*
* Availability:
* Mac OS X: not available but deprecated in 10.6
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in KeychainLib 1.0 and later
*/
extern OSStatus
KCGetKeychainManagerVersion(UInt32 * returnVers) API_DEPRECATED("No longer supported", macos(10.0,10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
#if TARGET_RT_MAC_CFM
#ifdef __cplusplus
inline pascal Boolean KeychainManagerAvailable() { return ((KCGetKeychainManagerVersion != (void*)kUnresolvedCFragSymbolAddress) && (KCGetKeychainManagerVersion(nil) != cfragNoSymbolErr)); }
#else
#define KeychainManagerAvailable() ((KCGetKeychainManagerVersion != (void*)kUnresolvedCFragSymbolAddress) && (KCGetKeychainManagerVersion(nil) != cfragNoSymbolErr))
#endif
#elif TARGET_RT_MAC_MACHO
/* Keychain is always available on OS X */
#ifdef __cplusplus
inline pascal Boolean KeychainManagerAvailable() { return true; }
#else
#define KeychainManagerAvailable() (true)
#endif
#endif /* */
/* Managing the Human Interface */
/*
* KCSetInteractionAllowed() *** DEPRECATED ***
*
* Deprecated:
* Use SecKeychainSetUserInteractionAllowed
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.6
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in KeychainLib 2.0 and later
*/
extern OSStatus
KCSetInteractionAllowed(Boolean state) API_DEPRECATED("No longer supported", macos(10.0,10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* KCIsInteractionAllowed() *** DEPRECATED ***
*
* Deprecated:
* Use SecKeychainGetUserInteractionAllowed
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.6
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in KeychainLib 2.0 and later
*/
extern Boolean
KCIsInteractionAllowed(void) API_DEPRECATED("No longer supported", macos(10.0,10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
/* Creating references to keychains */
#if !__LP64__
/*
* KCMakeKCRefFromFSSpec() *** DEPRECATED ***
*
* Deprecated:
* Use SecKeychainOpen
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in KeychainLib 2.0 and later
*/
extern OSStatus
KCMakeKCRefFromFSSpec(
FSSpec * keychainFSSpec,
KCRef * keychain) API_DEPRECATED("No longer supported", macos(10.0,10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
#endif /* !__LP64__ */
/*
* KCMakeKCRefFromFSRef() *** DEPRECATED ***
*
* Deprecated:
* Use SecKeychainOpen
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.6
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in KeychainLib 2.0 and later
*/
extern OSStatus
KCMakeKCRefFromFSRef(
FSRef * keychainFSRef,
KCRef * keychain) API_DEPRECATED("No longer supported", macos(10.0,10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* KCMakeKCRefFromAlias() *** DEPRECATED ***
*
* Deprecated:
* Use SecKeychainOpen
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.6
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in KeychainLib 2.0 and later
*/
extern OSStatus
KCMakeKCRefFromAlias(
AliasHandle keychainAlias,
KCRef * keychain) API_DEPRECATED("No longer supported", macos(10.0,10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* KCMakeAliasFromKCRef() *** DEPRECATED ***
*
* Deprecated:
* Use SecKeychainOpen
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.6
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in KeychainLib 2.0 and later
*/
extern OSStatus
KCMakeAliasFromKCRef(
KCRef keychain,
AliasHandle * keychainAlias) API_DEPRECATED("No longer supported", macos(10.0,10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* KCReleaseKeychain() *** DEPRECATED ***
*
* Deprecated:
* Use CFRelease when releasing SecKeychainRef objects
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.6
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in KeychainLib 2.0 and later
*/
extern OSStatus
KCReleaseKeychain(KCRef * keychain) API_DEPRECATED("No longer supported", macos(10.0,10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
/* Specifying the default keychain */
/*
* KCGetDefaultKeychain() *** DEPRECATED ***
*
* Deprecated:
* Use SecKeychainCopyDefault
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.6
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in KeychainLib 2.0 and later
*/
extern OSStatus
KCGetDefaultKeychain(KCRef * keychain) API_DEPRECATED("No longer supported", macos(10.0,10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* KCSetDefaultKeychain() *** DEPRECATED ***
*
* Deprecated:
* Use SecKeychainSetDefault
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.6
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in KeychainLib 2.0 and later
*/
extern OSStatus
KCSetDefaultKeychain(KCRef keychain) API_DEPRECATED("No longer supported", macos(10.0,10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
/* Getting information about a keychain */
/*
* KCGetStatus() *** DEPRECATED ***
*
* Deprecated:
* Use SecKeychainGetStatus
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.6
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in KeychainLib 1.0 and later
*/
extern OSStatus
KCGetStatus(
KCRef keychain, /* can be NULL */
UInt32 * keychainStatus) API_DEPRECATED("No longer supported", macos(10.0,10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* KCGetKeychain() *** DEPRECATED ***
*
* Deprecated:
* Use SecKeychainItemCopyKeychain
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.6
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in KeychainLib 1.0 and later
*/
extern OSStatus
KCGetKeychain(
KCItemRef item,
KCRef * keychain) API_DEPRECATED("No longer supported", macos(10.0,10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* KCGetKeychainName() *** DEPRECATED ***
*
* Deprecated:
* Use SecKeychainGetPath
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.6
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in KeychainLib 2.0 and later
*/
extern OSStatus
KCGetKeychainName(
KCRef keychain,
StringPtr keychainName) API_DEPRECATED("No longer supported", macos(10.0,10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
/* Enumerating available keychains */
/*
* KCCountKeychains() *** DEPRECATED ***
*
* Deprecated:
* Use SecKeychainCopySearchList
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.6
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in KeychainLib 1.0 and later
*/
extern UInt16
KCCountKeychains(void) API_DEPRECATED("No longer supported", macos(10.0,10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* KCGetIndKeychain() *** DEPRECATED ***
*
* Deprecated:
* Use SecKeychainCopySearchList
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.6
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in KeychainLib 1.0 and later
*/
extern OSStatus
KCGetIndKeychain(
UInt16 index,
KCRef * keychain) API_DEPRECATED("No longer supported", macos(10.0,10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
typedef CALLBACK_API( OSStatus , KCCallbackProcPtr )(KCEvent keychainEvent, KCCallbackInfo *info, void *userContext);
typedef STACK_UPP_TYPE(KCCallbackProcPtr) KCCallbackUPP;
/*
* NewKCCallbackUPP() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: available as macro/inline
*/
extern KCCallbackUPP
NewKCCallbackUPP(KCCallbackProcPtr userRoutine) API_DEPRECATED("No longer supported", macos(10.0,10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* DisposeKCCallbackUPP() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
DisposeKCCallbackUPP(KCCallbackUPP userUPP) API_DEPRECATED("No longer supported", macos(10.0,10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* InvokeKCCallbackUPP() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: available as macro/inline
*/
extern OSStatus
InvokeKCCallbackUPP(
KCEvent keychainEvent,
KCCallbackInfo * info,
void * userContext,
KCCallbackUPP userUPP) API_DEPRECATED("No longer supported", macos(10.0,10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
#if __MACH__
#ifdef __cplusplus
inline KCCallbackUPP NewKCCallbackUPP(KCCallbackProcPtr userRoutine) { return userRoutine; }
inline void DisposeKCCallbackUPP(KCCallbackUPP) { }
inline OSStatus InvokeKCCallbackUPP(KCEvent keychainEvent, KCCallbackInfo * info, void * userContext, KCCallbackUPP userUPP) { return (*userUPP)(keychainEvent, info, userContext); }
#else
#define NewKCCallbackUPP(userRoutine) ((KCCallbackUPP)userRoutine)
#define DisposeKCCallbackUPP(userUPP)
#define InvokeKCCallbackUPP(keychainEvent, info, userContext, userUPP) (*userUPP)(keychainEvent, info, userContext)
#endif
#endif
/* High-level interface for retrieving passwords */
/*
* KCFindAppleSharePassword() *** DEPRECATED ***
*
* Deprecated:
* Use SecKeychainFindInternetPassword
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.6
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in KeychainLib 1.0 and later
*/
extern OSStatus
KCFindAppleSharePassword(
AFPServerSignature * serverSignature, /* can be NULL */
ConstStringPtr serverAddress, /* can be NULL */
ConstStringPtr serverName, /* can be NULL */
ConstStringPtr volumeName, /* can be NULL */
ConstStringPtr accountName, /* can be NULL */
UInt32 maxLength,
void * passwordData,
UInt32 * actualLength,
KCItemRef * item) /* can be NULL */ API_DEPRECATED("No longer supported", macos(10.0,10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* KCFindInternetPassword() *** DEPRECATED ***
*
* Deprecated:
* Use SecKeychainFindInternetPassword
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.6
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in KeychainLib 1.0 and later
*/
extern OSStatus
KCFindInternetPassword(
ConstStringPtr serverName, /* can be NULL */
ConstStringPtr securityDomain, /* can be NULL */
ConstStringPtr accountName, /* can be NULL */
UInt16 port,
OSType protocol,
OSType authType,
UInt32 maxLength,
void * passwordData,
UInt32 * actualLength,
KCItemRef * item) /* can be NULL */ API_DEPRECATED("No longer supported", macos(10.0,10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* KCFindInternetPasswordWithPath() *** DEPRECATED ***
*
* Deprecated:
* Use SecKeychainFindInternetPassword
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.6
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in KeychainLib 2.0 and later
*/
extern OSStatus
KCFindInternetPasswordWithPath(
ConstStringPtr serverName, /* can be NULL */
ConstStringPtr securityDomain, /* can be NULL */
ConstStringPtr accountName, /* can be NULL */
ConstStringPtr path, /* can be NULL */
UInt16 port,
OSType protocol,
OSType authType,
UInt32 maxLength,
void * passwordData,
UInt32 * actualLength,
KCItemRef * item) /* can be NULL */ API_DEPRECATED("No longer supported", macos(10.0,10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* KCFindGenericPassword() *** DEPRECATED ***
*
* Deprecated:
* Use SecKeychainFindGenericPassword
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.6
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in KeychainLib 1.0 and later
*/
extern OSStatus
KCFindGenericPassword(
ConstStringPtr serviceName, /* can be NULL */
ConstStringPtr accountName, /* can be NULL */
UInt32 maxLength,
void * passwordData,
UInt32 * actualLength,
KCItemRef * item) /* can be NULL */ API_DEPRECATED("No longer supported", macos(10.0,10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
/* Keychain Manager callbacks */
/*
* KCAddCallback() *** DEPRECATED ***
*
* Deprecated:
* Use SecKeychainAddCallback
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.6
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in KeychainLib 1.0 and later
*/
extern OSStatus
KCAddCallback(
KCCallbackUPP callbackProc,
KCEventMask eventMask,
void * userContext) API_DEPRECATED("No longer supported", macos(10.0,10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* KCRemoveCallback() *** DEPRECATED ***
*
* Deprecated:
* Use SecKeychainRemoveCallback
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.6
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in KeychainLib 1.0 and later
*/
extern OSStatus
KCRemoveCallback(KCCallbackUPP callbackProc) API_DEPRECATED("No longer supported", macos(10.0,10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
/* Creating and editing a keychain item */
/*
* KCNewItem() *** DEPRECATED ***
*
* Deprecated:
* Use SecKeychainItemCreateFromContent
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.6
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in KeychainLib 1.0 and later
*/
extern OSStatus
KCNewItem(
KCItemClass itemClass,
OSType itemCreator,
UInt32 length,
const void * data,
KCItemRef * item) API_DEPRECATED("No longer supported", macos(10.0,10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* KCSetAttribute() *** DEPRECATED ***
*
* Deprecated:
* Use SecKeychainItemModifyAttributesAndData
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.6
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in KeychainLib 1.0 and later
*/
extern OSStatus
KCSetAttribute(
KCItemRef item,
KCAttribute * attr) API_DEPRECATED("No longer supported", macos(10.0,10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* KCGetAttribute() *** DEPRECATED ***
*
* Deprecated:
* Use SecKeychainItemCopyAttributesAndData
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.6
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in KeychainLib 1.0 and later
*/
extern OSStatus
KCGetAttribute(
KCItemRef item,
KCAttribute * attr,
UInt32 * actualLength) API_DEPRECATED("No longer supported", macos(10.0,10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* KCSetData() *** DEPRECATED ***
*
* Deprecated:
* Use SecKeychainItemModifyAttributesAndData
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.6
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in KeychainLib 1.0 and later
*/
extern OSStatus
KCSetData(
KCItemRef item,
UInt32 length,
const void * data) API_DEPRECATED("No longer supported", macos(10.0,10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
/* Managing keychain items */
/*
* KCUpdateItem() *** DEPRECATED ***
*
* Deprecated:
* Use SecKeychainItemModifyAttributesAndData
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.6
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in KeychainLib 1.0 and later
*/
extern OSStatus
KCUpdateItem(KCItemRef item) API_DEPRECATED("No longer supported", macos(10.0,10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* KCReleaseItem() *** DEPRECATED ***
*
* Deprecated:
* Use CFRelease when releasing SecKeychainItemRef objects
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.6
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in KeychainLib 1.0 and later
*/
extern OSStatus
KCReleaseItem(KCItemRef * item) API_DEPRECATED("No longer supported", macos(10.0,10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* KCCopyItem() *** DEPRECATED ***
*
* Deprecated:
* Use SecKeychainItemCreateCopy
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.6
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in KeychainLib 2.0 and later
*/
extern OSStatus
KCCopyItem(
KCItemRef item,
KCRef destKeychain,
KCItemRef * copy) API_DEPRECATED("No longer supported", macos(10.0,10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
/* Searching and enumerating keychain items */
/*
* KCFindFirstItem() *** DEPRECATED ***
*
* Deprecated:
* Use SecKeychainSearchCreateFromAttributes /
* SecKeychainSearchCopyNext
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.6
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in KeychainLib 1.0 and later
*/
extern OSStatus
KCFindFirstItem(
KCRef keychain, /* can be NULL */
const KCAttributeList * attrList, /* can be NULL */
KCSearchRef * search,
KCItemRef * item) API_DEPRECATED("No longer supported", macos(10.0,10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* KCFindNextItem() *** DEPRECATED ***
*
* Deprecated:
* Use SecKeychainSearchCopyNext
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.6
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in KeychainLib 1.0 and later
*/
extern OSStatus
KCFindNextItem(
KCSearchRef search,
KCItemRef * item) API_DEPRECATED("No longer supported", macos(10.0,10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* KCReleaseSearch() *** DEPRECATED ***
*
* Deprecated:
* Use CFRelease when releasing SecKeychainSearchRef objects
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.6
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in KeychainLib 1.0 and later
*/
extern OSStatus
KCReleaseSearch(KCSearchRef * search) API_DEPRECATED("No longer supported", macos(10.0,10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
/* Managing keychain items */
/*
* KCDeleteItem() *** DEPRECATED ***
*
* Deprecated:
* Use SecKeychainItemDelete
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.6
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in KeychainLib 1.0 and later
*/
extern OSStatus
KCDeleteItem(KCItemRef item) API_DEPRECATED("No longer supported", macos(10.0,10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* KCGetData() *** DEPRECATED ***
*
* Deprecated:
* Use SecKeychainItemCopyAttributesAndData
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.6
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in KeychainLib 1.0 and later
*/
extern OSStatus
KCGetData(
KCItemRef item,
UInt32 maxLength,
void * data,
UInt32 * actualLength) API_DEPRECATED("No longer supported", macos(10.0,10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
/* Locking a keychain */
/*
* KCLock() *** DEPRECATED ***
*
* Deprecated:
* Use SecKeychainLock
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.6
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in KeychainLib 1.0 and later
*/
extern OSStatus
KCLock(KCRef keychain) API_DEPRECATED("No longer supported", macos(10.0,10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
/* Routines that use "C" strings */
/*
* kcgetkeychainname() *** DEPRECATED ***
*
* Deprecated:
* Use SecKeychainGetPath
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.6
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in KeychainLib 2.0 and later
*/
extern OSStatus
kcgetkeychainname(
KCRef keychain,
char * keychainName) API_DEPRECATED("No longer supported", macos(10.0,10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* kcfindapplesharepassword() *** DEPRECATED ***
*
* Deprecated:
* Use SecKeychainFindInternetPassword
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.6
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in KeychainLib 1.0 and later
*/
extern OSStatus
kcfindapplesharepassword(
AFPServerSignature * serverSignature, /* can be NULL */
const char * serverAddress, /* can be NULL */
const char * serverName, /* can be NULL */
const char * volumeName, /* can be NULL */
const char * accountName, /* can be NULL */
UInt32 maxLength,
void * passwordData,
UInt32 * actualLength,
KCItemRef * item) /* can be NULL */ API_DEPRECATED("No longer supported", macos(10.0,10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* kcfindinternetpassword() *** DEPRECATED ***
*
* Deprecated:
* Use SecKeychainFindInternetPassword
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.6
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in KeychainLib 1.0 and later
*/
extern OSStatus
kcfindinternetpassword(
const char * serverName, /* can be NULL */
const char * securityDomain, /* can be NULL */
const char * accountName, /* can be NULL */
UInt16 port,
OSType protocol,
OSType authType,
UInt32 maxLength,
void * passwordData,
UInt32 * actualLength,
KCItemRef * item) /* can be NULL */ API_DEPRECATED("No longer supported", macos(10.0,10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* kcfindinternetpasswordwithpath() *** DEPRECATED ***
*
* Deprecated:
* Use SecKeychainFindInternetPassword
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.6
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in KeychainLib 2.0 and later
*/
extern OSStatus
kcfindinternetpasswordwithpath(
const char * serverName, /* can be NULL */
const char * securityDomain, /* can be NULL */
const char * accountName, /* can be NULL */
const char * path, /* can be NULL */
UInt16 port,
OSType protocol,
OSType authType,
UInt32 maxLength,
void * passwordData,
UInt32 * actualLength,
KCItemRef * item) /* can be NULL */ API_DEPRECATED("No longer supported", macos(10.0,10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* kcfindgenericpassword() *** DEPRECATED ***
*
* Deprecated:
* Use SecKeychainFindGenericPassword
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.6
* CarbonLib: in CarbonLib 1.1 and later
* Non-Carbon CFM: in KeychainLib 1.0 and later
*/
extern OSStatus
kcfindgenericpassword(
const char * serviceName, /* can be NULL */
const char * accountName, /* can be NULL */
UInt32 maxLength,
void * passwordData,
UInt32 * actualLength,
KCItemRef * item) /* can be NULL */ API_DEPRECATED("No longer supported", macos(10.0,10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
#pragma pack(pop)
#ifdef __cplusplus
}
#endif
#endif /* __KEYCHAINCORE__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/OSServices.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/OSServices.framework/Headers/SecurityCore.h | /*
File: OSServices/SecurityCore.h
Contains: *** DEPRECATED *** Master include for SecurityCore private framework
Copyright: (c) 2000-2011 Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __SECURITYCORE__
#define __SECURITYCORE__
#ifndef __CARBONCORE__
#include <CarbonCore/CarbonCore.h>
#endif
#ifndef __KEYCHAINCORE__
#include <OSServices/KeychainCore.h>
#endif
#endif /* __SECURITYCORE__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/OSServices.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/OSServices.framework/Headers/CSIdentity.h | /*
File: OSServices/CSIdentity.h
Contains: CSIdentity APIs
Copyright: (c) 2006-2011 Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __CSIDENTITY__
#define __CSIDENTITY__
#ifndef __COREFOUNDATION__
#include <CoreFoundation/CoreFoundation.h>
#endif
#ifndef __CSIDENTITYBASE__
#if TARGET_OS_IPHONE && (TARGET_OS_EMBEDDED || TARGET_OS_SIMULATOR || !TARGET_OS_MACCATALYST)
#include <CoreServices/CSIdentityBase.h>
#else
#include <OSServices/CSIdentityBase.h>
#endif
#endif
#ifndef __CSIDENTITYAUTHORITY__
#if TARGET_OS_IPHONE && (TARGET_OS_EMBEDDED || TARGET_OS_SIMULATOR || !TARGET_OS_MACCATALYST)
#include <CoreServices/CSIdentityAuthority.h>
#else
#include <OSServices/CSIdentityAuthority.h>
#endif
#endif
#ifndef __SECBASE__
#include <Security/SecBase.h>
#endif
#ifndef __AUTHORIZATION__
#include <Security/Security.h>
#if TARGET_OS_OSX
#include <Security/Authorization.h>
#endif
#endif
#include <Availability.h>
#include <ConditionalMacros.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
#pragma pack(push, 2)
#include <sys/types.h>
/*
CSIdentity
A CSIdentity object represents a user or group entity known to the system. An
identity object has the following required attributes: a class (user
or group), a unique identitfier (UUID), a full name, a Posix ID
(UID or GID), and a Posix name (a.k.a. "short" name). There are also a number
of optional attributes such as email address, image data, etc.
Group identities have a membership which may include both users as well as
other groups. An identity can be tested for membership in a specific group.
A CSIdentity object is a private copy of the identity information. It can be
modified in memory, but requires authorization to commit changes back to
the identity authority database. On Mac OS X version 10.5, only local identities
can be created, modified or deleted, and only by users with Administrator
credentials.
Changes may be committed synchronously or asynchronously. All data validation
occurs at commit time.
Two identities are CFEqual if they have the same class and UUID.
*/
/*
* CSIdentityRef
*
* Discussion:
* A reference to an identity object. Can be either a user or group.
*/
typedef struct __CSIdentity* CSIdentityRef;
/*
* CSIdentityQueryRef
*
* Discussion:
* A reference to an identity query object, used to lookup
* identities in an identity authority's database.
*/
typedef struct __CSIdentityQuery* CSIdentityQueryRef;
/*
kCSIdentityGeneratePosixName
Passing this constant as the Posix name when creating an indentity
will generate a unique Posix name, based on the full name. The Posix
name is generated at commit time.
*/
/*
* kCSIdentityGeneratePosixName
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern const CFStringRef kCSIdentityGeneratePosixName API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* CSIdentityClass
*
* Discussion:
* Enum specifying an identity class
*/
enum {
/*
* The class value for user identities
*/
kCSIdentityClassUser = 1,
/*
* The class value for group identities
*/
kCSIdentityClassGroup = 2
};
typedef CFIndex CSIdentityClass;
/*
* CSIdentityFlags
*
* Discussion:
* Flags used when creating new identities
*/
enum {
/*
* Use this flag to set no optional attributes for a new identity
*/
kCSIdentityFlagNone = 0,
/*
* This flag causes the identity to be "hidden," that is, excluded
* from most user-visible identity lists. Hidden identities include
* administrative users and groups such as root, www, and mysql.
* System service access control groups should be created with the
* hidden flag.
*/
kCSIdentityFlagHidden = 1
};
typedef CFOptionFlags CSIdentityFlags;
/*
* CSIdentityGetTypeID()
*
* Summary:
* Returns the CSIdentity type identifier
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Result:
* The CFTypeID of the CSIdentity Core Foundation type
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFTypeID
CSIdentityGetTypeID(void) API_AVAILABLE( ios(5.0), macos(10.5), tvos(9.0), watchos(1.0) );
/*
*
* Creating Identities
*
*/
/*
* CSIdentityCreate()
*
* Summary:
* Creates a new identity
*
* Discussion:
* The new identity is allocated but is not committed to the
* identity authority's database. It will become persistent and
* available to other clients after being committed using
* CSIdentityCommit or CSIdentityCommitAsynchronously.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* allocator:
* The allocator to use when creating the object. NULL is
* equivalent to specifying kCFAllocatorDefault.
*
* identityClass:
* The type of identity to be created. Specifying
* kCSIdentityClassUser creates a user, while
* kCSIdentityClassGroup creates a group.
*
* fullName:
* The primary name of the new identity.
*
* posixName:
* The POSIX name of the new identity. Specify
* kCSIdentityGeneratePosixName to have a name generated
* autmatically from the full name.
*
* flags:
* A CSIdentityFlags mask defining attributes of the new identity
*
* authority:
* The identity authority to host the identity. Caller must have
* write access to the identity authority or commit will fail.
* Currently, only local identities may be created, so callers
* must specify the local identity authority for this argument.
*
* Result:
* The CSIdentityRef of the newly created identity object. Returns
* NULL only if allocation fails.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CSIdentityRef
CSIdentityCreate(
CFAllocatorRef allocator,
CSIdentityClass identityClass,
CFStringRef fullName,
CFStringRef posixName,
CSIdentityFlags flags,
CSIdentityAuthorityRef authority) API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* CSIdentityCreateCopy()
*
* Summary:
* Creates a copy of an identity
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* allocator:
* The allocator to use for the new identity. NULL is equivalent
* to specifying kCFAllocatorDefault.
*
* identity:
* The identity to copy
*
* Result:
* The CSIdentityRef of the newly created identity object
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CSIdentityRef
CSIdentityCreateCopy(
CFAllocatorRef allocator,
CSIdentityRef identity) API_AVAILABLE( ios(5.0), macos(10.5), tvos(9.0), watchos(1.0) );
/*
*
* Getting Identity Attributes
*
*/
/*
* CSIdentityGetClass()
*
* Summary:
* Returns an identity's class
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* identity:
* The identity object to access
*
* Result:
* The CSIdentityClass of an identity
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CSIdentityClass
CSIdentityGetClass(CSIdentityRef identity) API_AVAILABLE( ios(5.0), macos(10.5), tvos(9.0), watchos(1.0) );
/*
* CSIdentityGetAuthority()
*
* Summary:
* Returns the identity authority of an identity
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* identity:
* The identity object to access
*
* Result:
* A CSIdentityAuthorityRef object
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CSIdentityAuthorityRef
CSIdentityGetAuthority(CSIdentityRef identity) API_AVAILABLE( ios(5.0), macos(10.5), tvos(9.0), watchos(1.0) );
/*
* CSIdentityGetUUID()
*
* Summary:
* Returns an identity's UUID.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* identity:
* The identity object to access
*
* Result:
* A CFUUID object containing identity's UUID. Will never return
* NULL.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFUUIDRef
CSIdentityGetUUID(CSIdentityRef identity) API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* CSIdentityGetFullName()
*
* Summary:
* Retrieve the full name of an identity
*
* Discussion:
* The full name is the name that is displayed in the user interface.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* identity:
* The identity object to access
*
* Result:
* Returns an identity's full name as a CFStringRef. This attribute
* is always non-NULL. The identity object may release its reference
* to the return value when the identity is modified.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFStringRef
CSIdentityGetFullName(CSIdentityRef identity) API_AVAILABLE( ios(5.0), macos(10.5), tvos(9.0), watchos(1.0) );
/*
* CSIdentityGetPosixID()
*
* Summary:
* Retrieve POSIX ID of an identity.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* identity:
* The identity to access
*
* Result:
* Returns an identity's POSIX identifier (a UID or GID).
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern id_t
CSIdentityGetPosixID(CSIdentityRef identity) API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* CSIdentityGetPosixName()
*
* Summary:
* Retrieve the POSIX name (short name) of an identity.
*
* Discussion:
* The POSIX name cannot be changed after an identity has been
* created.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* identity:
* The identity object to access.
*
* Result:
* Returns an identity's POSIX name. This attribute is always
* non-NULL. The identity object may release its reference to the
* return value when the identity is modified.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFStringRef
CSIdentityGetPosixName(CSIdentityRef identity) API_AVAILABLE( ios(5.0), macos(10.5), tvos(9.0), watchos(1.0) );
/*
* CSIdentityGetEmailAddress()
*
* Summary:
* Retrieve the email address of a user identity
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* identity:
* The identity to access
*
* Result:
* Returns the email address of the identity or NULL if there is no
* email address. The identity object may release its reference to
* the return value when the identity is modified.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFStringRef
CSIdentityGetEmailAddress(CSIdentityRef identity) API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* CSIdentityGetImageURL()
*
* Summary:
* Retrieve the URL to an identity's image file
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* identity:
* The identity to access
*
* Result:
* Returns a CFURLRef that contains the location of the user's image
* file, or NULL if there is no image URL. The identity object may
* release its reference to the return value when the identity is
* modified.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFURLRef
CSIdentityGetImageURL(CSIdentityRef identity) API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* CSIdentityGetImageData()
*
* Summary:
* Retrieve the image associated with a user identity
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* identity:
* The identity to access
*
* Result:
* Returns the identity's image data as a CFDataRef or NULL if there
* is no image data. The identity object may release its reference
* to the return value when the identity is modified.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFDataRef
CSIdentityGetImageData(CSIdentityRef identity) API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* CSIdentityGetImageDataType()
*
* Summary:
* Retrieve the uniform type identifier (UTI) of an identity's image
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* identity:
* The identity to access
*
* Result:
* Returns a UTI as a CFStringRef for this identity's image data or
* NULL if there is no image data. The identity object may release
* its reference to the return value when the identity is modified.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFStringRef
CSIdentityGetImageDataType(CSIdentityRef identity) API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* CSIdentityGetAliases()
*
* Summary:
* Retrieve the aliases of an identity.
*
* Discussion:
* Aliases are alternate names for identities. As with all identity
* names, aliases must be unique within the entire namespace of of
* the identity authority.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* identity:
* The identity to access
*
* Result:
* Returns an array containing the identity's name aliases as
* CFStringRefs. The array may be empty. The identity object may
* release its reference to the return value when the identity is
* modified.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFArrayRef
CSIdentityGetAliases(CSIdentityRef identity) API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* CSIdentityIsMemberOfGroup()
*
* Summary:
* Check if an identity is a memeber of a group
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* identity:
* The identity whose membership is in question
*
* group:
* The group identity whose membership is to be checked
*
* Result:
* Returns true if the identity is a member (directly or indirectly)
* of the specified group
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern Boolean
CSIdentityIsMemberOfGroup(
CSIdentityRef identity,
CSIdentityRef group) API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* CSIdentityIsHidden()
*
* Summary:
* Determine if a identity's hidden attribute is enabled
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* identity:
* The identity object to access
*
* Result:
* Returns true if the identity was created with the hidden attribute
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern Boolean
CSIdentityIsHidden(CSIdentityRef identity) API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* CSIdentityCreatePersistentReference()
*
* Summary:
* Create an opaque, persistent data reference to an identity
*
* Discussion:
* A persistent identity reference is an opaque data object from
* which an identity object may queried the future (see
* CSIdentityQueryCreateForPersistentReference). A persistent
* reference is suitable for storage in an external data store, for
* example, as an entry in an application-specific access control
* list associated with a shared resource. Use of a persistent
* identity reference is preferred over a pure UUID-based identity
* reference because the peristent reference contains additional
* information needed to optimize the identity query and to improve
* the user experience when working in a distributed identity
* environment (LDAP, Active Directory, etc.).
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* allocator:
* The allocator for the data
*
* identity:
* The identity to reference
*
* Result:
* Returns a new persistent reference for the identity
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFDataRef
CSIdentityCreatePersistentReference(
CFAllocatorRef allocator,
CSIdentityRef identity) API_AVAILABLE( ios(5.0), macos(10.5), tvos(9.0), watchos(1.0) );
/*
*
* Methods which apply only to users
*
*/
/*
* CSIdentityIsEnabled()
*
* Summary:
* Determine if a user is enabled
*
* Discussion:
* A user that is not enabled cannot authenticate. This setting may
* be used to temporarily allow a user's access to all services and
* resources.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* user:
* The user identity to access
*
* Result:
* Returns true if the user is enabled. A user that is not enabled
* cannot authenticate.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern Boolean
CSIdentityIsEnabled(CSIdentityRef user) API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* CSIdentityAuthenticateUsingPassword()
*
* Summary:
* Attempt to autenticate a password for a user identity
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* user:
* The user identity to access
*
* password:
* The password to authenticate
*
* Result:
* Returns true if the passord is correct for the specified user
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern Boolean
CSIdentityAuthenticateUsingPassword(
CSIdentityRef user,
CFStringRef password) API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* CSIdentityGetCertificate()
*
* Summary:
* Get a user's authentication certificate
*
* Discussion:
* The authentication certificate can be used in PKI-based protocols
* to authenticate users.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* user:
* The user identity to access
*
* Result:
* The identity's certificate, or NULL if there is no certificate.
* The identity object may release its reference to the return value
* when the identity is modified.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern SecCertificateRef
CSIdentityGetCertificate(CSIdentityRef user) API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
*
* Methods which apply only to groups
*
*/
/*
* CSIdentityCreateGroupMembershipQuery()
*
* Summary:
* Creates a query to find a group's members
*
* Discussion:
* Using a query to lookup group membership allows the caller to
* execute the query synchronously or asynchronously.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* allocator:
* The allocator to use for the query
*
* group:
* The group identity whose members are to be queried
*
* Result:
* The CSIdentityQueryRef of the newly created object. The query is
* ready to be executed.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CSIdentityQueryRef
CSIdentityCreateGroupMembershipQuery(
CFAllocatorRef allocator,
CSIdentityRef group) API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
*
* Methods that modify identities
*
*/
/*
* CSIdentitySetFullName()
*
* Summary:
* Sets an identity's full name.
*
* Discussion:
* This change must be committed.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* identity:
* The identity object to access
*
* fullName:
* The new full name of the identity
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
CSIdentitySetFullName(
CSIdentityRef identity,
CFStringRef fullName) API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* CSIdentitySetEmailAddress()
*
* Summary:
* Set an identity's email address
*
* Discussion:
* This change must be committed.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* identity:
* The user identity to access
*
* emailAddress:
* The user's new email address value. Pass NULL to remove an
* email address.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
CSIdentitySetEmailAddress(
CSIdentityRef identity,
CFStringRef emailAddress) /* can be NULL */ API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* CSIdentitySetImageURL()
*
* Summary:
* Set the URL of an identity's external image storage
*
* Discussion:
* This change must be committed.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* identity:
* The identity to access
*
* url:
* The URL file of the image. For local identities, this must be a
* file URL. Pass NULL to remove the image URL from the identity.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
CSIdentitySetImageURL(
CSIdentityRef identity,
CFURLRef url) /* can be NULL */ API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* CSIdentitySetImageData()
*
* Summary:
* Set the internally-stored image data and data type for an identity
*
* Discussion:
* This change must be committed.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* identity:
* The identity to access
*
* imageData:
* The image data. Pass NULL to remove image data.
*
* imageDataType:
* The uniform type identitier (UTI) of the image data. Currently,
* kUTTypeJPEG ("public.jpeg") is the only type supported.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
CSIdentitySetImageData(
CSIdentityRef identity,
CFDataRef imageData, /* can be NULL */
CFStringRef imageDataType) /* can be NULL */ API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* CSIdentityAddAlias()
*
* Summary:
* Add a name alias to an identity
*
* Discussion:
* This change must be committed.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* identity:
* The identity to access
*
* alias:
* The alias to add
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
CSIdentityAddAlias(
CSIdentityRef identity,
CFStringRef alias) API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* CSIdentityRemoveAlias()
*
* Summary:
* Remove an alias name from an identity
*
* Discussion:
* This change must be committed.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* identity:
* The identity to access
*
* alias:
* The alias name to remove
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
CSIdentityRemoveAlias(
CSIdentityRef identity,
CFStringRef alias) API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
*
* Methods that modify group membership
*
*/
/*
* CSIdentityAddMember()
*
* Summary:
* Add an identity to a group
*
* Discussion:
* This change to the group must be committed.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* group:
* The group identity to access
*
* member:
* The identity to add to the group. Can be a user or group
* identity.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
CSIdentityAddMember(
CSIdentityRef group,
CSIdentityRef member) API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* CSIdentityRemoveMember()
*
* Summary:
* Remove a member from a group
*
* Discussion:
* This change to the group must be committed.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* group:
* The group identity to access
*
* member:
* The member identity to remove
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
CSIdentityRemoveMember(
CSIdentityRef group,
CSIdentityRef member) API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
Methods that modfify user credentials
*/
/*
* CSIdentitySetIsEnabled()
*
* Summary:
* Enable or disable a user
*
* Discussion:
* A disabled user account cannot authenticate. Credentials
* (password and certificate) are not affected. This change must be
* committed.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* user:
* The identity object to access
*
* isEnabled:
* The new value of the isEnabled attribute
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
CSIdentitySetIsEnabled(
CSIdentityRef user,
Boolean isEnabled) API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* CSIdentitySetPassword()
*
* Summary:
* Set a user password
*
* Discussion:
* Setting the password to NULL removes the current password and
* disables password authentication for the user. Setting the
* password to a zero-length string allows authentication with a
* blank password. This change must be committed.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* user:
* The user identity to access
*
* password:
* The new password, or NULL to remove the current password and
* disable password-based authentication
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
CSIdentitySetPassword(
CSIdentityRef user,
CFStringRef password) /* can be NULL */ API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* CSIdentitySetCertificate()
*
* Summary:
* Set a user's authentication certificate
*
* Discussion:
* The subject name in the certificate will function as an alias for
* the identity. As with all identity names, the subject name must
* be unique within the entire name space of the identity authority.
* This change must be submitted.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* user:
* The user identity to access
*
* certificate:
* The user's certificate, or NULL to remove the current
* certificate
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
CSIdentitySetCertificate(
CSIdentityRef user,
SecCertificateRef certificate) /* can be NULL */ API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
*
* Permanent Deletion
*
*/
/*
* CSIdentityDelete()
*
* Summary:
* Permanently delete an identity from the identity database
*
* Discussion:
* Sets an identity to deleted state. This change must be committed.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* identity:
* The identity to delete
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
CSIdentityDelete(CSIdentityRef identity) API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
*
*
* Committing changes
*
*/
#if TARGET_OS_OSX
/*
* CSIdentityCommit()
*
* Summary:
* Synchronously commit all pending changes to the identity
* authority database
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* identity:
* The identity to commit
*
* authorization:
* The authorization object holding credentials necessary to allow
* modification to the identity database. As a convenience,
* callers may pass NULL for the authorization, and the
* implmentation will attempt to acquire the necessary credentials
* from Authorization Services.
*
* error:
* Optional pointer to a CFErrorRef which will be set if this
* function returns false. When this occurs, the caller is
* responsible for releasing the error.
*
* Result:
* Returns true if successful, false if an error occurred
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern Boolean
CSIdentityCommit(
CSIdentityRef identity,
AuthorizationRef authorization, /* can be NULL */
CFErrorRef * error) /* can be NULL */ API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
#endif // TARGET_OS_OSX
/*
* Status values
*
*/
enum {
/*
* The identity has been committed to the authority database
*/
kCSIdentityCommitCompleted = 1
};
typedef void (*CSIdentityStatusUpdatedCallback)(CSIdentityRef identity, CFIndex status, CFErrorRef error, void *info);
/*
* CSIdentityClientContext
*
* Discussion:
* Structure containing the user-defined data and callbacks used
* during asynchronous commits
*/
struct CSIdentityClientContext {
/*
* The version number of the client structure type. The current
* version number is 0.
*/
CFIndex version;
/*
* An arbitrary pointer to client-defined data, which can be
* associated with the client and is passed to the callbacks.
*/
void * info;
/*
* The callback used to add a retain for the on the client object for
* the life of the asynchronous operation, and may be used for
* temporary references the identity needs to take. This callback
* returns the actual info pointer to be passed to the statusUpdated
* callback. May be NULL.
*/
CFAllocatorRetainCallBack retain;
/*
* The callback used to remove a retain previously acquired for the
* client object. May be NULL.
*/
CFAllocatorReleaseCallBack release;
/*
* The callback used to create a descriptive string representation of
* the client object for debugging purposes. This is used by the
* CFCopyDescription() function. May be NULL.
*/
CFAllocatorCopyDescriptionCallBack copyDescription;
/*
* The client callback invoked when the status of an asnchronous
* operation changes
*/
CSIdentityStatusUpdatedCallback statusUpdated;
};
typedef struct CSIdentityClientContext CSIdentityClientContext;
#if TARGET_OS_OSX
/*
* CSIdentityCommitAsynchronously()
*
* Summary:
* Asychronously commit all pending changes to the identity
* authority's database
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* identity:
* The identity to commit
*
* clientContext:
* The client structure specifying context and callbacks for the
* asynchronous operation
*
* runLoop:
* The run loop on which to schedule the statusUpdated callback
*
* runLoopMode:
* The run loop mode in which the callback can be scheduled
*
* authorization:
* The authorization object holding credentials necessary to allow
* modification to the identity database. As a convenience,
* callers may pass NULL for the authorization, and the
* implmentation will attempt to acquire the necessary credentials
* from Authorization Services. Modifying the local system
* identity database requires Admin credentials.
*
* Result:
* Returns true if the commit operation is started, indicated that
* an statusUpdated callback will follow. Returns false if the
* identity has no uncommitted changes or a commit is already in
* progress
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern Boolean
CSIdentityCommitAsynchronously(
CSIdentityRef identity,
const CSIdentityClientContext * clientContext,
CFRunLoopRef runLoop,
CFStringRef runLoopMode,
AuthorizationRef authorization) /* can be NULL */ API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
#endif // TARGET_OS_OSX
/*
* CSIdentityIsCommitting()
*
* Summary:
* Determine if a commit operation is in progress
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* identity:
* The identity to access
*
* Result:
* Returns true if a commit operation is in progress
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern Boolean
CSIdentityIsCommitting(CSIdentityRef identity) API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* CSIdentityRemoveClient()
*
* Summary:
* Invalidate an identity's client structure to stop client callbacks
*
* Discussion:
* After returning, this function guarantees that client callbacks
* will never be invoked again. Use this function when releasing an
* identity which may have an outstanding asynchronous request. This
* function does not cancel an outstanding commit operation because
* a commit cannot be interrupted.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* identity:
* The identity to access
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
CSIdentityRemoveClient(CSIdentityRef identity) API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
#pragma pack(pop)
#ifdef __cplusplus
}
#endif
#endif /* __CSIDENTITY__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/OSServices.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/OSServices.framework/Headers/CSIdentityBase.h | /*
File: OSServices/CSIdentityBase.h
Contains: CSIdentity APIs
Copyright: (c) 2006-2011 Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __CSIDENTITYBASE__
#define __CSIDENTITYBASE__
#ifndef __COREFOUNDATION__
#include <CoreFoundation/CoreFoundation.h>
#endif
#ifndef __SECBASE__
#include <Security/SecBase.h>
#endif
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
#pragma pack(push, 2)
#include <sys/types.h>
/*
The error domain of all CFErrors reported by Identity Services
*/
/*
* kCSIdentityErrorDomain
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern const CFStringRef kCSIdentityErrorDomain API_AVAILABLE( ios(5.0 ), macos(10.5), tvos(9.0), watchos(4.0) );
/*
* CSIdentity error codes
*
* Discussion:
* Error codes in the CSIdentity error domain
*/
enum {
/*
* The specified authority is not recognized
*/
kCSIdentityUnknownAuthorityErr = -1,
/*
* The specified authority is currently not accessible
*/
kCSIdentityAuthorityNotAccessibleErr = -2,
/*
* The caller does not have permission to perform the operation
*/
kCSIdentityPermissionErr = -3,
/*
* The requested identity has been deteled
*/
kCSIdentityDeletedErr = -4,
/*
* The full name is not valid (length: [1-255])
*/
kCSIdentityInvalidFullNameErr = -5,
/*
* The full name is aleady assigned to another identity
*/
kCSIdentityDuplicateFullNameErr = -6,
/*
* The Posix name is not valid (char set: [a-zA-Z0-9_-] length:
* [1-255])
*/
kCSIdentityInvalidPosixNameErr = -7,
/*
* The Posix name is aleady assigned to another identity
*/
kCSIdentityDuplicatePosixNameErr = -8,
};
#pragma pack(pop)
#ifdef __cplusplus
}
#endif
#endif /* __CSIDENTITYBASE__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/OSServices.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/OSServices.framework/Headers/CSIdentityQuery.h | /*
File: OSServices/CSIdentityQuery.h
Contains: Identity Query APIs
Copyright: (c) 2006-2011 Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __CSIDENTITYQUERY__
#define __CSIDENTITYQUERY__
#ifndef __CSIDENTITY__
#include <OSServices/CSIdentity.h>
#endif
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
#pragma pack(push, 2)
/*
* CSIdentityQueryGetTypeID()
*
* Summary:
* Retrieve the CFTypeID of the CSIdentityQuery class
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFTypeID
CSIdentityQueryGetTypeID(void) API_AVAILABLE( ios(5.0), macos(10.5), tvos(9.0), watchos(1.0) );
/*
* CSIdentityQueryFlags
*
* Summary:
* Execution options for an identity query
*
* Discussion:
* A bit mask for setting execution options on a query
*/
enum {
/*
* After the intial query phase is complete, monitor the result set
* for live updates
*/
kCSIdentityQueryGenerateUpdateEvents = 0x0001,
/*
* Include all matching identities in the result set, including
* hidden "system" users and groups (root, www, etc.)
*/
kCSIdentityQueryIncludeHiddenIdentities = 0x0002
};
typedef CFOptionFlags CSIdentityQueryFlags;
/*
* CSIdentityQueryStringComparisonMethod
*
* Summary:
* Options for querying the database by name
*
* Discussion:
* When searching for identities by name, this value specifies the
* string comparison function
*/
enum {
/*
* The identity name must equal the search string
*/
kCSIdentityQueryStringEquals = 1,
/*
* The identity name must begin with the search string
*/
kCSIdentityQueryStringBeginsWith = 2
};
typedef CFIndex CSIdentityQueryStringComparisonMethod;
/*
* CSIdentityQueryCreate()
*
* Summary:
* Creates an identity query object for all identities in the
* specified authority
*
* Discussion:
* The results of this query include all of the identities in the
* specified authority's database.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* allocator:
* The allocator to use for this instance
*
* identityClass:
* The class of identity to find
*
* authority:
* The identity authority to query
*
* Result:
* A new CSIdentityQuery object
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CSIdentityQueryRef
CSIdentityQueryCreate(
CFAllocatorRef allocator,
CSIdentityClass identityClass,
CSIdentityAuthorityRef authority) API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* CSIdentityQueryCreateForName()
*
* Summary:
* Creates an identity query object based on a name
*
* Discussion:
* The query finds identities by name. It searches the full names,
* posix names and aliases for matches.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* allocator:
* The allocator to use for this instance
*
* name:
* The name criteria for the query.
*
* comparisonMethod:
* The comparision function (equal or begins with)
*
* identityClass:
* The class of identity to find
*
* authority:
* The identity authority to query
*
* Result:
* A new CSIdentityQuery object
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CSIdentityQueryRef
CSIdentityQueryCreateForName(
CFAllocatorRef allocator,
CFStringRef name,
CSIdentityQueryStringComparisonMethod comparisonMethod,
CSIdentityClass identityClass,
CSIdentityAuthorityRef authority) API_AVAILABLE( ios(5.0), macos(10.5), tvos(9.0), watchos(1.0) );
/*
* CSIdentityQueryCreateForUUID()
*
* Summary:
* Creates an identity query object based on a UUID
*
* Discussion:
* Finds an identity by its UUID
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* allocator:
* The allocator to use for this instance
*
* uuid:
* The UUID of the identity to find
*
* authority:
* The identity authority to query
*
* Result:
* A new CSIdentityQuery object
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CSIdentityQueryRef
CSIdentityQueryCreateForUUID(
CFAllocatorRef allocator,
CFUUIDRef uuid,
CSIdentityAuthorityRef authority) API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* CSIdentityQueryCreateForPosixID()
*
* Summary:
* Creates an identity query object based on a POSIX ID
*
* Discussion:
* Finds an identity by its UID or GID
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* allocator:
* The allocator to use for this instance
*
* posixID:
* The UID or GID of the identity to find
*
* identityClass:
* The class of identity to find
*
* authority:
* The identity authority to query
*
* Result:
* A new CSIdentityQuery object
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CSIdentityQueryRef
CSIdentityQueryCreateForPosixID(
CFAllocatorRef allocator,
id_t posixID,
CSIdentityClass identityClass,
CSIdentityAuthorityRef authority) API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* CSIdentityQueryCreateForPersistentReference()
*
* Summary:
* Creates an identity query object based on an identity reference
* data object
*
* Discussion:
* Finds an identity by reference data obtained from
* CSIdentityCreateReferenceData
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* allocator:
* The allocator to use for this instance
*
* referenceData:
* The reference data that fully describes an identity
*
* Result:
* A new CSIdentityQuery object
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CSIdentityQueryRef
CSIdentityQueryCreateForPersistentReference(
CFAllocatorRef allocator,
CFDataRef referenceData) API_AVAILABLE( ios(5.0), macos(10.5), tvos(9.0), watchos(1.0) );
/*
* CSIdentityQueryCreateForCurrentUser()
*
* Summary:
* Creates a query for the current session user's identity
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* allocator:
* The allocator to use for this instance
*
* Result:
* A new CSIdentityQuery object
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CSIdentityQueryRef
CSIdentityQueryCreateForCurrentUser(CFAllocatorRef allocator) API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* CSIdentityQueryCopyResults()
*
* Summary:
* Retrieve the results of executing an identity query
*
* Discussion:
* Returns an immutable array of CSIdentityRefs, reflecting the
* current results of the query's execution.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* query:
* The query object to access
*
* Result:
* An array of zero or more CSIdentityRefs
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFArrayRef
CSIdentityQueryCopyResults(CSIdentityQueryRef query) API_AVAILABLE( ios(5.0), macos(10.5), tvos(9.0), watchos(1.0) );
/*
* CSIdentityQueryExecute()
*
* Summary:
* Execute an identity query synchronously
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* query:
* The query object to execute
*
* flags:
* Execution options
*
* error:
* Optional pointer to a CFError object which must be released by
* the caller if CSIdentityQueryExecute returns false
*
* Result:
* Returns true if the query executed successfully, false if an
* error occurred.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern Boolean
CSIdentityQueryExecute(
CSIdentityQueryRef query,
CSIdentityQueryFlags flags,
CFErrorRef * error) /* can be NULL */ API_AVAILABLE( ios(5.0), macos(10.5), tvos(9.0), watchos(1.0) );
/*
* CSIdentityQueryEvent
*
* Summary:
* Results from executing an asynchronous query
*
* Discussion:
* Events generated during asynchronous query execution
*/
enum {
/*
* Event generated when the initial lookup of identities has
* finished. Live update events will follow if caller requests the
* kCSIdentityQueryGenerateUpdateEvents option.
*/
kCSIdentityQueryEventSearchPhaseFinished = 1,
/*
* Event generated when identities are added to the query results
*/
kCSIdentityQueryEventResultsAdded = 2,
/*
* Event generated when identities already in the query results have
* been modified
*/
kCSIdentityQueryEventResultsChanged = 3,
/*
* Event generated when identities are removed from the query results
*/
kCSIdentityQueryEventResultsRemoved = 4,
/*
* Used to report an error. Query execution stops (permanently) if
* this event is sent.
*/
kCSIdentityQueryEventErrorOccurred = 5
};
typedef CFIndex CSIdentityQueryEvent;
/*
* CSIdentityQueryReceiveEventCallback
*
* Summary:
* The client event callback function for receiving asynchronous
* query events
*
* Parameters:
*
* query:
* The identity query object that has completed an event
*
* event:
* The event the identity query object has completed
*
* identities:
* a CFArray containing identities resulting from the query
*
* error:
* A CFError object if there was an error from the query
*
* info:
* Any other information you want passed to the callback function
*/
typedef void (*CSIdentityQueryReceiveEventCallback)(CSIdentityQueryRef query, CSIdentityQueryEvent event, CFArrayRef identities, CFErrorRef error, void *info);
/*
* CSIdentityQueryClientContext
*
* Summary:
* Client structure specifying callbacks and private context data
*/
struct CSIdentityQueryClientContext {
CFIndex version;
void * info;
CFAllocatorRetainCallBack retainInfo;
CFAllocatorReleaseCallBack releaseInfo;
CFAllocatorCopyDescriptionCallBack copyInfoDescription;
CSIdentityQueryReceiveEventCallback receiveEvent;
};
typedef struct CSIdentityQueryClientContext CSIdentityQueryClientContext;
/*
* CSIdentityQueryExecuteAsynchronously()
*
* Summary:
* Execute an identity query asynchronously
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* query:
* The query object to execute
*
* flags:
* Execution options
*
* clientContext:
* The client context and callbacks to be used during execution
*
* runLoop:
* The run loop on which to schedule callbacks
*
* runLoopMode:
* The run loop mode in which callbacks may be scheduled
*
* Result:
* Returns true if query execution started, false if the query has
* already been executed.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern Boolean
CSIdentityQueryExecuteAsynchronously(
CSIdentityQueryRef query,
CSIdentityQueryFlags flags,
const CSIdentityQueryClientContext * clientContext,
CFRunLoopRef runLoop,
CFStringRef runLoopMode) API_AVAILABLE( ios(5.0), macos(10.5), tvos(9.0), watchos(1.0) );
/*
* CSIdentityQueryStop()
*
* Summary:
* Invalidate an identity query client
*
* Discussion:
* Invalidate a query client so that its callback will never be
* called in the future. Clients should call CSIdentityQueryStop
* when an query will no longer be used, prior to releasing the
* final query reference.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* query:
* The query to access
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
CSIdentityQueryStop(CSIdentityQueryRef query) API_AVAILABLE( ios(5.0), macos(10.5), tvos(9.0), watchos(1.0) );
#pragma pack(pop)
#ifdef __cplusplus
}
#endif
#endif /* __CSIDENTITYQUERY__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/OSServices.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/OSServices.framework/Headers/WSMethodInvocation.h | /*
File: OSServices/WSMethodInvocation.h
Contains: *** DEPRECATED *** WebServicesCore Method Invocation API
Copyright: (c) 2002-2011 Apple Inc. All rights reserved
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __WSMETHODINVOCATION__
#define __WSMETHODINVOCATION__
#ifndef __COREFOUNDATION__
#include <CoreFoundation/CoreFoundation.h>
#endif
#ifndef __MIXEDMODE__
#include <CarbonCore/MixedMode.h>
#endif
#ifndef __WSTYPES__
#include <OSServices/WSTypes.h>
#endif
#include <Availability.h>
/*
WSMethodInvocation
*/
#ifdef __cplusplus
extern "C" {
#endif
/*
Dictionary entry if the invocation result is not a fault. This is
always available in method responses, although for SOAP messages,
it may be more correctly to query the result dictionary for the
specific field you're interested in. What this really means is
that the dictionary returned by the invocation may contain more
than one value, wherein the result data is duplicated several
times. If you don't know what to ask for to dump the reply, you
can ask for this key. If you do know what you want, you should
request that field expliclty.
You can also specify the name of the reply parameter in the
invocation using kWSMethodInvocationResultParameterName. This will
add an alias for the given name to the result dictionary such that
kWSMethodInvocationResult will always return the correct
parameter. (This won't work for multi-value returns, however.)
*/
extern CFStringRef kWSMethodInvocationResult API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
Dictionary entries if the result is a fault
*/
extern CFStringRef kWSFaultString /* a CFString */ API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
extern CFStringRef kWSFaultCode /* a CFNumber */ API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
extern CFStringRef kWSFaultExtra /* a CFString or CFDictionary, or NULL */ API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
If the result is a fault, and if the value of kWSFaultString in
the reply dictionary is kWSNetworkStreamFaultString, then
kWSFaultExtra will be a dictionary indicating the network error
and kWSFaultCode is ignored in this case. See
<CoreFoundation/CFStream.h> for details on what the domain and
error numbers mean.
*/
extern CFStringRef kWSNetworkStreamFaultString API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
extern CFStringRef kWSStreamErrorMessage /* A CFString (for debug purposes only) */ API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
extern CFStringRef kWSStreamErrorDomain /* A CFNumberRef */ API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
extern CFStringRef kWSStreamErrorError /* A CFNumberRef */ API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
For HTTP[S] based invocations, you can specify a CFHTTPMessageRef
as a property which will be used instead of creating a new
outgoing message. The CFHTTPMessageRef can contain header, proxy
and authentication information. The body of the message will be
ignored and replaced with the outgoing, serialized invocation.
After the invocation has executed, you can retrieve a copy of the
actual CFHTTPMessageRef, containing the details of the invocation
using kWSHTTPResponseMessage. Attempting to retrieve the response
message property before the invocation completes will result
return NULL.
See: <CFNetwork/CFHTTPMessage.h> for more information.
*/
extern CFStringRef kWSHTTPMessage /* CFHTTPMessageRef */ API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
extern CFStringRef kWSHTTPResponseMessage /* CFHTTPMessageRef */ API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
To avoid having to create an entire CFHTTPMessageRef, these properties are
individually settable. If they are set, they will override any CFHTTPMessageRef
previously specified.
*/
extern CFStringRef kWSHTTPExtraHeaders /* a CFDictionary of { key (CFString), val (CFString) } pairs */ API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
extern CFStringRef kWSHTTPVersion /* "http/1.1" */ API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
extern CFStringRef kWSHTTPProxy /* CFURLRef */ API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
extern CFStringRef kWSHTTPFollowsRedirects /* kCFBooleanFalse */ API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
SOCKS proxy support. WSMethodInvocation uses the same flags as
CFSocketStream.h in configuring SOCKS proxy support. You can set
the kCFStreamPropertySOCKSProxy property on the invocation and the
value will be applied to the underlying stream. See CFSocketStream.h
for more information and valid keys.
*/
/*
These debugging flags will populate the WSInvocationResultRef
with some potentially useful debugging output. The property
name of the flag is the same as the the field in the result
dictionary.
*/
extern CFStringRef kWSDebugOutgoingHeaders /* kCFBooleanFalse */ API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
extern CFStringRef kWSDebugOutgoingBody /* kCFBooleanFalse */ API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
extern CFStringRef kWSDebugIncomingHeaders /* kCFBooleanFalse */ API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
extern CFStringRef kWSDebugIncomingBody /* kCFBooleanFalse */ API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
Extra properties for SOAP messages. These apply to the message
namespace and format itself. Individual message elements can
be modified using the kWSRecord constants below.
*/
extern CFStringRef kWSSOAPBodyEncodingStyle /* CFStringRef { kWSSOAPStyleDoc, kWSSOAPStyleRPC } */ API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
extern CFStringRef kWSSOAPMethodNamespaceURI /* CFStringRef */ API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
extern CFStringRef kWSSOAPStyleDoc API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
extern CFStringRef kWSSOAPStyleRPC API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
For SOAP messages, this is an array of CFStringRefs which
contain valid XML header elements that are sent with the
message. These are only applicable to the Header of a SOAP
message.
*/
extern CFStringRef kWSSOAPMessageHeaders /* CFArrayRef */ API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
When serializing a record (dictionary) these keys present in
the dictionary can modify the behavior of the serialization.
*/
extern CFStringRef kWSRecordParameterOrder /* CFArrayRef of CFStringRef */ API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
extern CFStringRef kWSRecordNamespaceURI /* CFStringRef */ API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
extern CFStringRef kWSRecordType /* CFStringRef */ API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
Specifies that the result parameter will be found as this name. This
forces the deserializer to alias the named output parameter to kWSMethodInvocationResult
*/
extern CFStringRef kWSMethodInvocationResultParameterName API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
Specifies a timeout (as CFNumber) which specifies in seconds the
amount of time to wait for the invocation to complete. If the
invocation times out before the server results are returned,
a fault will be returned with the error code errWSTimeoutError.
*/
extern CFStringRef kWSMethodInvocationTimeoutValue API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
#ifdef __cplusplus
}
#endif
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
#if PRAGMA_ENUM_ALWAYSINT
#pragma enumsalwaysint on
#endif
/*
* WSMethodInvocationRef
*
* Discussion:
* a WSMethodInvocationRef represents an object that can be executed
* to obtain a rsult from a web service. This is CFType and is
* therefore reference counted and and should be managed via
* CFRetain and CFRelease.
*/
typedef struct OpaqueWSMethodInvocationRef* WSMethodInvocationRef;
/*
* WSMethodInvocationGetTypeID() *** DEPRECATED ***
*
* Mac OS X threading:
* Thread safe
*
* Availability:
* Mac OS X: in version 10.2 and later but deprecated in 10.8
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFTypeID
WSMethodInvocationGetTypeID(void) API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* WSMethodInvocationCreate() *** DEPRECATED ***
*
* Discussion:
* Creates a web services method invocation object. This object may
* be executed synchronously or scheduled on a run loop for
* asynchronous execution.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* url:
* the endpoint of the service
*
* methodName:
* the name of the method to be called
*
* protocol:
* a string, defined above, that determines the type of invocation
* object to create (XML-RPC vs. SOAP)
*
* Result:
* A WSMethodInvocationRef object that can be passed to
* WSMethodInvocationInvoke or scheduled with a run loop.
*
* Availability:
* Mac OS X: in version 10.2 and later but deprecated in 10.8
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern WSMethodInvocationRef
WSMethodInvocationCreate(
CFURLRef url,
CFStringRef methodName,
CFStringRef protocol) API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* WSMethodInvocationCreateFromSerialization() *** DEPRECATED ***
*
* Discussion:
* Creates a web services method invocation object from a previously
* serialized contract.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* contract:
* the result of a previously serialized WSMethodInvocationRef
*
* Result:
* A WSMethodInvocationRef object that can be passed to
* WSMethodInvocationInvoke or scheduled with a run loop.
*
* Availability:
* Mac OS X: in version 10.2 and later but deprecated in 10.8
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern WSMethodInvocationRef
WSMethodInvocationCreateFromSerialization(CFDataRef contract) API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* WSMethodInvocationCopySerialization() *** DEPRECATED ***
*
* Discussion:
* Create a serialized version of the Method Invocation which can be
* reconstituted at a later time.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* invocation:
* the invocation to serialize
*
* Result:
* a CFDataRef
*
* Availability:
* Mac OS X: in version 10.2 and later but deprecated in 10.8
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFDataRef
WSMethodInvocationCopySerialization(WSMethodInvocationRef invocation) API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* WSMethodInvocationSetParameters() *** DEPRECATED ***
*
* Discussion:
* Set the parameters for a method invocation. The parameterOrder
* may be NULL, in which case the order of th parameters is
* undefined. If it is not NULL and the parameters dictionary
* contains more parameters than are specified by the order, the
* behavior is undefined. If the parameterOrder specifies more
* parameters than are present in the dictionary, the result is
* undefined.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* invocation:
* the invocation object
*
* parameters:
* a CFDictionaryRef of CFString keys and CFTypeRef values.
*
* parameterOrder:
* a CFArrayRef of CFString parameter names.
*
* Availability:
* Mac OS X: in version 10.2 and later but deprecated in 10.8
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
WSMethodInvocationSetParameters(
WSMethodInvocationRef invocation,
CFDictionaryRef parameters,
CFArrayRef parameterOrder) /* can be NULL */ API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* WSMethodInvocationCopyParameters() *** DEPRECATED ***
*
* Discussion:
* Copies the parameters from the invocation. The resulting
* dictionary contains the parameter dictionary. The parameterOrder
* output parameter, if not NULL, will contain the order used to
* serialize the parameters.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* invocation:
* the invocation
*
* parameterOrder:
* a pointer to a CFArray which will will receive the names, in
* their specified order, of the input parameter values. This
* parameter may be NULL.
*
* Result:
* a CFDictionaryRef
*
* Availability:
* Mac OS X: in version 10.2 and later but deprecated in 10.8
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFDictionaryRef
WSMethodInvocationCopyParameters(
WSMethodInvocationRef invocation,
CFArrayRef * parameterOrder) /* can be NULL */ API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* WSMethodInvocationSetProperty() *** DEPRECATED ***
*
* Discussion:
* Add "properties" to a method invocation. These properties can be
* user defined or one of the WebServicesCore declared properties
* (which may modify the behavior of the invocation.) All
* WebServicesCore declared properties will start with the string
* "kWS", eg, kWSHTTPFollowsRedirects. Properties are serialized
* along with the contract, so you may want to avoid sticking raw
* pointers in a CFNumber (for example).
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* invocation:
* the invocation
*
* propertyName:
* a CFStringRef name of the property to modify
*
* propertyValue:
* a CFTypeRef containing the new property value
*
* Result:
* none
*
* Availability:
* Mac OS X: in version 10.2 and later but deprecated in 10.8
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
WSMethodInvocationSetProperty(
WSMethodInvocationRef invocation,
CFStringRef propertyName,
CFTypeRef propertyValue) API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* WSMethodInvocationCopyProperty() *** DEPRECATED ***
*
* Discussion:
* Return a property from a invocation. If the result is NULL, the
* property doesn't exist. Being a "Copy" call, you must release
* the result.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* invocation:
* the invocation
*
* propertyName:
* the name of the property to retreive
*
* Result:
* the CFTypeRef value of the property, or NULL if the property was
* not specified.
*
* Availability:
* Mac OS X: in version 10.2 and later but deprecated in 10.8
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFTypeRef
WSMethodInvocationCopyProperty(
WSMethodInvocationRef invocation,
CFStringRef propertyName) API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* WSMethodInvocationInvoke() *** DEPRECATED ***
*
* Discussion:
* Execute the invocation. If the call was successful, the result
* will contain the result of the invocation. If for some reason the
* invocation failed, including out of memory or invalid parameter
* errors, then the result will contain a fault structure. You must
* release the result when you're done with it.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* invocation:
* the invocation
*
* Result:
* a CFDictionaryRef containing the result of the execution or a
* fault, and optional debug information.
*
* Availability:
* Mac OS X: in version 10.2 and later but deprecated in 10.8
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CF_RETURNS_RETAINED CFDictionaryRef
WSMethodInvocationInvoke(WSMethodInvocationRef invocation) API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
These calls implemented the asynchronous variant of the WSMethodInvocationInvoke.
The strategy is to schedule the invocation on a given runloop.
When the invocation completes, it calls the specified callback with
the result of the execution. The callback is responsible for
releasing the result ref. Your code is responsible for
unscheduling the invocation from the run loop, whether it completes
or not.
You can re-schedule an invocation after it completes.
When you unschedule with the run loop, the CallBack is not called.
If a network error occurs, the kWSFaultString entry of the result
will contain some textual description of the error, kWSFaultCode
will contain kWSNetworkingFault and kWSFaultExtra will be a
dictionary containing two CFNumber values called kWSStreamErrorDomain
and kWSStreamErrorError.
*/
/*
* WSMethodInvocationCallBackProcPtr
*
* Discussion:
* Prototypes the callback made when an asynchronous invocation
* completes. This callback is passed a reference to the invocation
* just completed, a pointer to private data, and a dictionary that
* contains the return value or falut for this invocation. The
* callback is responsible for releasing the dictionary when it is
* no longer used.
*
* Parameters:
*
* invocation:
* the invocation just completed
*
* info:
* private callback data
*
* outRef:
* a CFDictionaryRef containing the result of the execution or a
* fault, and optional debug information.
*
* Availability:
* Mac OS X: in version 10.2 and later but deprecated in 10.8
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
typedef void(*WSMethodInvocationCallBackProcPtr)(WSMethodInvocationRef invocation, void *info, CFDictionaryRef outRef) API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* WSMethodInvocationSetCallBack() *** DEPRECATED ***
*
* Discussion:
* sets the callback for an asynchronous method invocation. Call
* with a clientCB and context of NULL to clear the invocation
* callback.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* invocation:
* the invocation
*
* clientCB:
* a ProcPtr to be called when the invocation completes.
*
* context:
* a pointer to a WSClientContext. The structure will be copied.
*
* Availability:
* Mac OS X: in version 10.2 and later but deprecated in 10.8
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
WSMethodInvocationSetCallBack(
WSMethodInvocationRef invocation,
WSMethodInvocationCallBackProcPtr clientCB,
WSClientContext * context) API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* WSMethodInvocationScheduleWithRunLoop() *** DEPRECATED ***
*
* Discussion:
* Schedules the invocation to execute on the run loop.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* invocation:
* the invocation.
*
* runLoop:
* the run loop upon which to scheduile the invocation.
*
* runLoopMode:
* the run loop mode.
*
* Availability:
* Mac OS X: in version 10.2 and later but deprecated in 10.8
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
WSMethodInvocationScheduleWithRunLoop(
WSMethodInvocationRef invocation,
CFRunLoopRef runLoop,
CFStringRef runLoopMode) API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* WSMethodInvocationUnscheduleFromRunLoop() *** DEPRECATED ***
*
* Discussion:
* Unschedules the invocation from a given run loop and
* mode. If the invocation has not yet completed,
* its callback will not be called.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* invocation:
* the invocation.
*
* runLoop:
* the run loop upon which to scheduile the invocation.
*
* runLoopMode:
* the run loop mode.
*
* Availability:
* Mac OS X: in version 10.2 and later but deprecated in 10.8
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
WSMethodInvocationUnscheduleFromRunLoop(
WSMethodInvocationRef invocation,
CFRunLoopRef runLoop,
CFStringRef runLoopMode) API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
Result interrogation.
If the result is a fault, look in the kWSFaultCode, kWSFaultString
and kWSFaultExtra fields of the resulting dictionary. If not a
fault, kWSMethodInvocationResult will contain the result of the
execution. If debugging information was requested, it will be
available in the dictionary as well.
*/
/*
* WSMethodResultIsFault() *** DEPRECATED ***
*
* Discussion:
* returns TRUE if the method invocation result contains a fault.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* methodResult:
* the result ref
*
* Result:
* TRUE if the result contains a fault condition
*
* Availability:
* Mac OS X: in version 10.2 and later but deprecated in 10.8
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern Boolean
WSMethodResultIsFault(CFDictionaryRef methodResult) API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
Serialization / Deserialization override support.
You can add serialization and deserialization callbacks for custom
types, or types not otherwise handled by the framework. Note that these
properties are *not* serialized if the invocation is serialized.
*/
/*
* WSMethodInvocationSerializationProcPtr
*
* Discussion:
* Prototypes the callback function for a custom serialization proc.
* This callback is called whenever a type has the given CFTypeID.
* The callback should return an XML snippet that will be understood
* by the server as a correct serialization for a given type. If
* the callback returns NULL, the default serializer will be used.
*
* Parameters:
*
* invocation:
* the invocation currently being serialized
*
* obj:
* the CFTypeRef to be serialized
*
* info:
* private callback data
*
* Result:
* a CFStringRef containing valid XML. The caller of this callback
* will release the string.
*
* Availability:
* Mac OS X: in version 10.2 and later but deprecated in 10.8
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
typedef CFStringRef(*WSMethodInvocationSerializationProcPtr)(WSMethodInvocationRef invocation, CFTypeRef obj, void *info) API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* WSMethodInvocationAddSerializationOverride() *** DEPRECATED ***
*
* Discussion:
* Specifies a callback which will be called to produce the XML that
* represents the serialization of a given type ref. See
* WSDescription.h for a list of CFTypes for which there currently
* exist serializers. If your callback returns NULL, the default
* serializer will be used.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* invocation:
* the invocation
*
* objType:
* the CFTypeID of the object
*
* serializationProc:
* the callback called
*
* context:
* a pointer to a WSClientContext. The structure will be copied.
*
* Availability:
* Mac OS X: in version 10.2 and later but deprecated in 10.8
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
WSMethodInvocationAddSerializationOverride(
WSMethodInvocationRef invocation,
CFTypeID objType,
WSMethodInvocationSerializationProcPtr serializationProc,
WSClientContext * context) API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* WSMethodInvocationDeserializationProcPtr
*
* Discussion:
* Prototypes the callback function for a custom deserializer. This
* callback is passed a reference to the invocation currently being
* executed, the root of the response parse tree, the current node
* being deserialized, and a pointer to private data. The return
* result should be a valid CFTypeRef object (which will be released
* by the caller) or NULL to allow the default deserializer to act.
*
* Parameters:
*
* invocation:
* the invocation executing
*
* msgRoot:
* the root tree element
*
* deserializeRoot:
* the tree element that needs to be deserialied
*
* info:
* private callback data
*
* Result:
* a CFTypeRef representing the deserialized data, or NULL to allow
* the default deserializers to act.
*
* Availability:
* Mac OS X: in version 10.2 and later but deprecated in 10.8
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
typedef CFTypeRef(*WSMethodInvocationDeserializationProcPtr)(WSMethodInvocationRef invocation, CFXMLTreeRef msgRoot, CFXMLTreeRef deserializeRoot, void *info) API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* WSMethodInvocationAddDeserializationOverride() *** DEPRECATED ***
*
* Discussion:
* Specifies a callback to be made when parsing an XML method
* response. The callback should return a CFTypeRef containing the
* deserialized object value. If the callback returns NULL, the
* default deserializer will be used.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* invocation:
* the invocation
*
* typeNamespace:
* the fully resolved namespace for a specific type. If NULL, the
* default namespace will be used. For example, this field could
* be: CFSTR("http://www.w3.org/2001/XMLSchema-instance").
*
* typeName:
* the non-qualified type name. This parameter must not be NULL.
*
* deserializationProc:
* a ProcPtr to be called to perform the deserialization
*
* context:
* a pointer to a WSClientContext. The structure will be copied.
*
* Availability:
* Mac OS X: in version 10.2 and later but deprecated in 10.8
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
WSMethodInvocationAddDeserializationOverride(
WSMethodInvocationRef invocation,
CFStringRef typeNamespace,
CFStringRef typeName,
WSMethodInvocationDeserializationProcPtr deserializationProc,
WSClientContext * context) API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
#if PRAGMA_ENUM_ALWAYSINT
#pragma enumsalwaysint reset
#endif
#ifdef __cplusplus
}
#endif
#endif /* __WSMETHODINVOCATION__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/OSServices.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/OSServices.framework/Headers/WSTypes.h | /*
File: OSServices/WSTypes.h
Contains: *** DEPRECATED *** WebServicesCore Method Invocation API
Copyright: (c) 2002-2011 Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __WSTYPES__
#define __WSTYPES__
#ifndef __COREFOUNDATION__
#include <CoreFoundation/CoreFoundation.h>
#endif
#ifndef __MIXEDMODE__
#include <CarbonCore/MixedMode.h>
#endif
/*
WSTypes
*/
/*
WebServicesCore error codes
*/
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
#pragma pack(push, 2)
#if PRAGMA_ENUM_ALWAYSINT
#pragma enumsalwaysint on
#endif
enum {
errWSInternalError = -65793L, /* An internal framework error */
errWSTransportError = -65794L, /* A network error occured */
errWSParseError = -65795L, /* The server response wasn't valid XML */
errWSTimeoutError = -65796L /* The invocation timed out */
};
/*
* WSTypeID
*
* Discussion:
* Internally, WebServicesCore uses the following enumeration when
* serializing between CoreFoundation and XML types. Because CFTypes
* are defined at runtime, it isn't always possible to produce a
* static mapping to a particular CFTypeRef. This enum and
* associated API allows for static determination of the expected
* serialization.
*/
enum WSTypeID {
/*
* No mapping is known for this type
*/
eWSUnknownType = 0,
/*
* CFNullRef
*/
eWSNullType = 1,
/*
* CFBooleanRef
*/
eWSBooleanType = 2,
/*
* CFNumberRef for 8, 16, 32 bit integers
*/
eWSIntegerType = 3,
/*
* CFNumberRef for long double real numbers
*/
eWSDoubleType = 4,
/*
* CFStringRef
*/
eWSStringType = 5,
/*
* CFDateRef
*/
eWSDateType = 6,
/*
* CFDataRef
*/
eWSDataType = 7,
/*
* CFArrayRef
*/
eWSArrayType = 8,
/*
* CFDictionaryRef
*/
eWSDictionaryType = 9
};
typedef enum WSTypeID WSTypeID;
typedef void *(*WSClientContextRetainCallBackProcPtr)(void * info) API_AVAILABLE( macos(10.2) ) API_UNAVAILABLE( ios, tvos, watchos );
typedef void (*WSClientContextReleaseCallBackProcPtr)(void * info) API_AVAILABLE( macos(10.2) ) API_UNAVAILABLE( ios, tvos, watchos );
typedef CFStringRef (*WSClientContextCopyDescriptionCallBackProcPtr)(void * info) API_AVAILABLE( macos(10.2) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* WSClientContext
*
* Discussion:
* Several calls in WebServicesCore take a callback with an optional
* context pointer. The context is copied and the info pointer
* retained. When the callback is made, the info pointer is passed
* to the callback.
*/
struct API_AVAILABLE( macos(10.2) ) API_UNAVAILABLE( ios, tvos, watchos ) WSClientContext {
/*
* set to zero (0)
*/
CFIndex version;
/*
* info pointer to be passed to the callback
*/
void * info;
/*
* callback made on the info pointer. This field may be NULL.
*/
WSClientContextRetainCallBackProcPtr retain;
/*
* callback made on the info pointer. This field may be NULL.
*/
WSClientContextReleaseCallBackProcPtr release;
/*
* callback made on the info pointer. This field may be NULL.
*/
WSClientContextCopyDescriptionCallBackProcPtr copyDescription;
};
typedef struct WSClientContext WSClientContext API_AVAILABLE( macos(10.2) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
Web Service protocol types. These constant strings specify the type
of web service method invocation created. These are passed to
WSMethodInvocationCreate.
For information on these service types, see:
XML-RPC: <http://www.xml-rpc.com/spec/>
SOAP 1.1: <http://www.w3.org/TR/SOAP/>
SOAP 1.2: <http://www.w3.org/2002/ws/>
*/
extern CFStringRef kWSXMLRPCProtocol API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
extern CFStringRef kWSSOAP1999Protocol API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
extern CFStringRef kWSSOAP2001Protocol API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* WSGetWSTypeIDFromCFType() *** DEPRECATED ***
*
* Discussion:
* Returns the WSTypeID associated with CFTypeRef. There is not a
* one to one mapping between CFTypeID and WSTypesID therefore an
* actual instance of a CFType must be passed.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* ref:
* a CFTypeRef object
*
* Result:
* the WSTypeID used in serializing the object. If no WSTypeID
* matches, eWSUnknownType is returned.
*
* Availability:
* Mac OS X: in version 10.2 and later but deprecated in 10.8
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern WSTypeID
WSGetWSTypeIDFromCFType(CFTypeRef ref) API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* WSGetCFTypeIDFromWSTypeID() *** DEPRECATED ***
*
* Discussion:
* Returns the CFTypeID that is associated with a given WSTypeID.
* CFTypeIDs are only valid during a particular instance of a
* process and should not be used as static values.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* typeID:
* a WSTypeID constant
*
* Result:
* a CFTypeID, or 0 if not found
*
* Availability:
* Mac OS X: in version 10.2 and later but deprecated in 10.8
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFTypeID
WSGetCFTypeIDFromWSTypeID(WSTypeID typeID) API_DEPRECATED("No longer supported", macos(10.2,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
#if PRAGMA_ENUM_ALWAYSINT
#pragma enumsalwaysint reset
#endif
#pragma pack(pop)
#ifdef __cplusplus
}
#endif
#endif /* __WSTYPES__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/OSServices.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/OSServices.framework/Headers/WSProtocolHandler.h | /*
File: OSServices/WSProtocolHandler.h
Contains: *** DEPRECATED *** WebServicesCore Method implementation API
Copyright: (c) 2002-2011 Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __WSPROTOCOLHANDLER__
#define __WSPROTOCOLHANDLER__
#ifndef __COREFOUNDATION__
#include <CoreFoundation/CoreFoundation.h>
#endif
#ifndef __MIXEDMODE__
#include <CarbonCore/MixedMode.h>
#endif
#ifndef __WSTYPES__
#include <OSServices/WSTypes.h>
#endif
/*
WSProtocolHandler
*/
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
#if PRAGMA_ENUM_ALWAYSINT
#pragma enumsalwaysint on
#endif
/*
* WSProtocolHandlerRef
*
* Discussion:
* a WSProtocolHandlerRef represents an object that translates
* dictionaries into web services requests. Typically, it is used
* to implement the server side of a web service by converting XML
* into CoreFoundation types, but it can also be used to produced
* serialzed web services requests without going through a
* WSMethodInvocation. It is created with a string specifying the
* web services protocol (XML-RPC or SOAP) and can also be modified
* through a set of external properties.
*/
typedef struct OpaqueWSProtocolHandlerRef* WSProtocolHandlerRef;
/*
* WSProtocolHandlerGetTypeID() *** DEPRECATED ***
*
* Mac OS X threading:
* Thread safe
*
* Availability:
* Mac OS X: in version 10.3 and later but deprecated in 10.8
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFTypeID
WSProtocolHandlerGetTypeID(void) API_DEPRECATED("No longer supported", macos(10.3,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* WSProtocolHandlerCreate() *** DEPRECATED ***
*
* Discussion:
* Creates a WSProtocolHandlerRef for use in translating an XML
* document.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* allocator:
* a CFAllocatorRef used to allocate the protocol handler.
*
* protocol:
* a constant string, defiend in WSMethodInvocation.h, that
* determines the type of implementation to create (XML-RPC vs.
* SOAP).
*
* Result:
* a WSProtocolHandlerRef, NULL if a parse error occured.
*
* Availability:
* Mac OS X: in version 10.3 and later but deprecated in 10.8
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern WSProtocolHandlerRef
WSProtocolHandlerCreate(
CFAllocatorRef allocator,
CFStringRef protocol) API_DEPRECATED("No longer supported", macos(10.3,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* WSProtocolHandlerCopyRequestDictionary() *** DEPRECATED ***
*
* Discussion:
* Parse an incoming XML document for the method name and
* parameters. The results are in a dictionory as kWSMethodName (a
* CFString), kWSMethodParameters (a CFDict) and
* kWSMethodParameterOrder (a CFArray). If there was a parse error,
* NULL is returned. Protocol specific additions (eg,
* kWSSOAPMessageHeaders) may also be present in the dictionary.
* The dictionary returned also represents the context with which
* XML reply documents are created (see
* WSProtocolHandlerCreateReply). The caller must release the
* resulting dictionary.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* ref:
* the protocol handler to use
*
* data:
* the XML document to parse
*
* Result:
* a CFDictionary
*
* Availability:
* Mac OS X: in version 10.3 and later but deprecated in 10.8
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFDictionaryRef
WSProtocolHandlerCopyRequestDictionary(
WSProtocolHandlerRef ref,
CFDataRef data) API_DEPRECATED("No longer supported", macos(10.3,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* WSProtocolHandlerCopyReplyDictionary() *** DEPRECATED ***
*
* Discussion:
* Parse an incoming XML document as if it were the reply of a
* method. The results are the same as the WSMethodInvocationInvoke
* response; that is, the reply could be a fault. If there was a
* parse error, NULL is returned. Protocol specific additions (eg,
* kWSSOAPMessageHeaders) may also be present in the dictionary.
* The caller must release the resulting dictionary.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* ref:
* the protocol handler to use
*
* methodName:
* the method name corrosponding to this result
*
* data:
* the XML document to parse
*
* Result:
* a CFDictionary
*
* Availability:
* Mac OS X: in version 10.3 and later but deprecated in 10.8
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFDictionaryRef
WSProtocolHandlerCopyReplyDictionary(
WSProtocolHandlerRef ref,
CFStringRef methodName,
CFDataRef data) API_DEPRECATED("No longer supported", macos(10.3,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* WSProtocolHandlerCopyReplyDocument() *** DEPRECATED ***
*
* Discussion:
* Creates a Reply XML document for a given WSProtocolHandler and
* context dictionary. Protocol specific addtions (eg,
* kWSSOAPMessageHeaders) may also be present in the dictionary.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* ref:
* the WSProtocolHandler to respond
*
* methodContext:
* the CFDictionary containing the context for this method call,
* as returned by WSProtocolHandlerParseRequest
*
* resultValue:
* a CFTypeRef representing the reply data to be serialized
*
* Result:
* a CFDataRef containing the XML response
*
* Availability:
* Mac OS X: in version 10.3 and later but deprecated in 10.8
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFDataRef
WSProtocolHandlerCopyReplyDocument(
WSProtocolHandlerRef ref,
CFDictionaryRef methodContext,
CFTypeRef resultValue) API_DEPRECATED("No longer supported", macos(10.3,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* WSProtocolHandlerCopyFaultDocument() *** DEPRECATED ***
*
* Discussion:
* Creates a Fault XML response for a given WSProtocolHandler and
* fault details dictionary
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* ref:
* the WSProtocolHandler
*
* methodContext:
* the CFDictionary containing the context for this method call,
* as returned by WSProtocolHandlerParseRequest
*
* faultDict:
* a CFDictionary containing the fault information. See
* WSMethodInvocation.h for valid keys.
*
* Result:
* a CFDataRef containing the XML fault
*
* Availability:
* Mac OS X: in version 10.3 and later but deprecated in 10.8
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFDataRef
WSProtocolHandlerCopyFaultDocument(
WSProtocolHandlerRef ref,
CFDictionaryRef methodContext,
CFDictionaryRef faultDict) API_DEPRECATED("No longer supported", macos(10.3,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* WSProtocolHandlerCopyRequestDocument() *** DEPRECATED ***
*
* Discussion:
* Creates an XML request for a given WSProtocolHandler and
* parameter list. This is the request sent to a server.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* ref:
* the WSProtocolHandler
*
* methodName:
* a CFString of the method name to call
*
* methodParams:
* a CFDictionary containing the parameters to send
*
* methodParamOrder:
* a CFArray, which, if not NULL, specifies the order of the
* parameters in the CFDictionary
*
* methodExtras:
* a CFDictionary, which, if not NULL, contains additional
* information for the protocol (eg, kWSSoapMessageHeaders)
*
* Result:
* a CFDataRef
*
* Availability:
* Mac OS X: in version 10.3 and later but deprecated in 10.8
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFDataRef
WSProtocolHandlerCopyRequestDocument(
WSProtocolHandlerRef ref,
CFStringRef methodName,
CFDictionaryRef methodParams,
CFArrayRef methodParamOrder,
CFDictionaryRef methodExtras) API_DEPRECATED("No longer supported", macos(10.3,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* WSProtocolHandlerCopyProperty() *** DEPRECATED ***
*
* Discussion:
* returns a property from a protocol handler. If the result is
* NULL, the property doesn't exist. Being a "Copy" call, you must
* release the result.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* ref:
* the implementation
*
* propertyName:
* the name of the property to retreive
*
* Result:
* the CFTypeRef value of the property, or NULL if the property was
* not specified.
*
* Availability:
* Mac OS X: in version 10.3 and later but deprecated in 10.8
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern CFTypeRef
WSProtocolHandlerCopyProperty(
WSProtocolHandlerRef ref,
CFStringRef propertyName) API_DEPRECATED("No longer supported", macos(10.3,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* WSProtocolHandlerSetProperty() *** DEPRECATED ***
*
* Discussion:
* Sets a property to a method implementation.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* ref:
* the implementation
*
* propertyName:
* the name of the property to retreive
*
* propertyValue:
* the value to set in the method implementation
*
* Availability:
* Mac OS X: in version 10.3 and later but deprecated in 10.8
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
WSProtocolHandlerSetProperty(
WSProtocolHandlerRef ref,
CFStringRef propertyName,
CFTypeRef propertyValue) API_DEPRECATED("No longer supported", macos(10.3,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
Serialization / Deserialization override support.
You can add serialization and deserialization callbacks for custom
types, or types not otherwise handled by the framework.
*/
/*
* WSProtocolHandlerSerializationProcPtr
*
* Discussion:
* Prototypes the callback function for a custom serialization proc.
* This callback is called whenever a type has the given CFTypeID.
* The callback should return an XML snippet that will be understood
* by the server as a correct serialization for a given type. If
* the callback returns NULL, the default serializer will be used.
* Note for for SOAP serializations, the parameter key (element
* name) is not part of the callback; it will be substituded for all
* occurances of "%@" in the returned string.
*
* Parameters:
*
* protocol:
* the protocol currently being serialized
*
* obj:
* the CFTypeRef to be serialized
*
* info:
* private callback data
*
* Result:
* a CFStringRef containing valid XML. The caller of this callback
* will release the string.
*
* Availability:
* Mac OS X: in version 10.3 and later but deprecated in 10.8
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
typedef CFStringRef(*WSProtocolHandlerSerializationProcPtr)(WSProtocolHandlerRef protocol, CFTypeRef obj, void *info)API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* WSProtocolHandlerSetSerializationOverride() *** DEPRECATED ***
*
* Discussion:
* Specifies a callback which will be called to produce the XML that
* represents the serialization of a given type ref. See
* WSDescription.h for a list of CFTypes for which there currently
* exist serializers. If your callback returns NULL, the default
* serializer will be used.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* protocol:
* the protocol
*
* objType:
* the CFTypeID of the object
*
* serializationProc:
* the callback called
*
* context:
* a pointer to a WSClientContext. The structure will be copied.
*
* Availability:
* Mac OS X: in version 10.3 and later but deprecated in 10.8
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
WSProtocolHandlerSetSerializationOverride(
WSProtocolHandlerRef protocol,
CFTypeID objType,
WSProtocolHandlerSerializationProcPtr serializationProc,
WSClientContext * context) API_DEPRECATED("No longer supported", macos(10.3,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* WSProtocolHandlerDeserializationProcPtr
*
* Discussion:
* Prototypes the callback function for a custom deserializer. This
* callback is passed a reference to the protocol element currently
* being executed, the root of the response parse tree, the current
* node being deserialized, and a pointer to private data. The
* return result should be a valid CFTypeRef object (which will be
* released by the caller) or NULL to allow the default deserializer
* to act.
*
* Parameters:
*
* protocol:
* the protocol executing
*
* msgRoot:
* the root tree element
*
* deserializeRoot:
* the tree element that needs to be deserialied
*
* info:
* private callback data
*
* Result:
* a CFTypeRef representing the deserialized data, or NULL to allow
* the default deserializers to act.
*
* Availability:
* Mac OS X: in version 10.3 and later but deprecated in 10.8
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
typedef CFTypeRef(*WSProtocolHandlerDeserializationProcPtr)(WSProtocolHandlerRef protocol, CFXMLTreeRef msgRoot, CFXMLTreeRef deserializeRoot, void *info)API_AVAILABLE( macos(10.3) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* WSProtocolHandlerSetDeserializationOverride() *** DEPRECATED ***
*
* Discussion:
* Specifies a callback to be made when parsing an XML method
* response. The callback should return a CFTypeRef containing the
* deserialized object value. If the callback returns NULL, the
* default deserializer will be used.
*
* Mac OS X threading:
* Thread safe
*
* Parameters:
*
* protocol:
* the protocol
*
* typeNamespace:
* the fully resolved namespace for a specific type. If NULL, the
* default namespace will be used. For example, this field could
* be: CFSTR("http://www.w3.org/2001/XMLSchema-instance").
*
* typeName:
* the non-qualified type name. This parameter must not be NULL.
*
* deserializationProc:
* a ProcPtr to be called to perform the deserialization
*
* context:
* a pointer to a WSClientContext. The structure will be copied.
*
* Availability:
* Mac OS X: in version 10.3 and later but deprecated in 10.8
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern void
WSProtocolHandlerSetDeserializationOverride(
WSProtocolHandlerRef protocol,
CFStringRef typeNamespace,
CFStringRef typeName,
WSProtocolHandlerDeserializationProcPtr deserializationProc,
WSClientContext * context) API_DEPRECATED("No longer supported", macos(10.3,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* Properties in the Request Dictionary
*/
#define kWSMethodName CFSTR("/WSMethodName")
#define kWSMethodParameters CFSTR("/WSMethodParameters")
#define kWSMethodParameterOrder CFSTR("/WSMethodParameterOrder")
#if PRAGMA_ENUM_ALWAYSINT
#pragma enumsalwaysint reset
#endif
#ifdef __cplusplus
}
#endif
#endif /* __WSPROTOCOLHANDLER__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/OSServices.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/OSServices.framework/Headers/Power.h | /*
File: OSServices/Power.h
Contains: *** DEPRECATED *** Power Manager Interfaces.
Copyright: (c) 1990-2012 Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __POWER__
#define __POWER__
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
#ifndef __MIXEDMODE__
#include <CarbonCore/MixedMode.h>
#endif
#ifndef __MULTIPROCESSING__
#include <CarbonCore/Multiprocessing.h>
#endif
#ifndef __MACERRORS__
#include <CarbonCore/MacErrors.h>
#endif
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
#pragma pack(push, 2)
enum {
/* commands to SleepQRec sleepQProc */
kSleepRequest = 1,
kSleepDemand = 2,
kSleepWakeUp = 3,
kSleepRevoke = 4,
kSleepUnlock = 4,
kSleepDeny = 5, /* A non-zero value clients can use to deny requests*/
kSleepNow = 6,
kDozeDemand = 7,
kDozeWakeUp = 8,
kDozeRequest = 9, /* additional messages for Power Mgr 2.0*/
kEnterStandby = 10, /* Idle Queue Only*/
kEnterRun = 11, /* Idle Queue Only*/
kSuspendRequest = 12,
kSuspendDemand = 13,
kSuspendRevoke = 14,
kSuspendWakeUp = 15,
kGetPowerLevel = 16,
kSetPowerLevel = 17,
kDeviceInitiatedWake = 18,
kWakeToDoze = 19,
kDozeToFullWakeUp = 20,
kGetPowerInfo = 21,
kGetWakeOnNetInfo = 22,
kSuspendWakeToDoze = 23,
kEnterIdle = 24, /* Idle Queue Only*/
kStillIdle = 25, /* Idle Queue Only*/
kExitIdle = 26 /* Idle Queue Only*/
};
enum {
/* SleepQRec.sleepQFlags */
noCalls = 1,
noRequest = 2,
slpQType = 16,
sleepQType = 16
};
/* System Activity Selectors */
/* Notes: The IdleActivity selector is not available unless the hasAggressiveIdling PMFeatures bit is set. */
/* Use IdleActivity where you used to use OverallAct if necessary. OverallAct will only delay power cycling */
/* if it's enabled, and will delay sleep by a small amount when hasAggressiveIdling is set. Don't use */
/* IdleActivity unless hasAggressiveIdling is set; when hasAggressiveIdling is not set, the use of IdleActivity */
/* is undefined, and well do different things depending on which Power Manager is currently running. */
enum {
OverallAct = 0, /* Delays idle sleep by small amount */
UsrActivity = 1, /* Delays idle sleep and dimming by timeout time */
NetActivity = 2, /* Delays idle sleep and power cycling by small amount */
HDActivity = 3, /* Delays hard drive spindown and idle sleep by small amount */
IdleActivity = 4 /* Delays idle sleep by timeout time */
};
typedef struct SleepQRec SleepQRec;
typedef SleepQRec * SleepQRecPtr;
typedef CALLBACK_API( long , SleepQProcPtr )(long message, SleepQRecPtr qRecPtr);
typedef STACK_UPP_TYPE(SleepQProcPtr) SleepQUPP;
/*
* NewSleepQUPP() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern SleepQUPP
NewSleepQUPP(SleepQProcPtr userRoutine) API_DEPRECATED("No longer supported", macos(10.0,10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* DisposeSleepQUPP() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern void
DisposeSleepQUPP(SleepQUPP userUPP) API_DEPRECATED("No longer supported", macos(10.0,10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* InvokeSleepQUPP() *** DEPRECATED ***
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework [32-bit only] but deprecated in 10.5
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: available as macro/inline
*/
extern long
InvokeSleepQUPP(
long message,
SleepQRecPtr qRecPtr,
SleepQUPP userUPP) API_DEPRECATED("No longer supported", macos(10.0,10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
#ifdef __cplusplus
inline SleepQUPP NewSleepQUPP(SleepQProcPtr userRoutine) { return userRoutine; }
inline void DisposeSleepQUPP(SleepQUPP) { }
inline long InvokeSleepQUPP(long message, SleepQRecPtr qRecPtr, SleepQUPP userUPP) { return (*userUPP)(message, qRecPtr); }
#else
#define NewSleepQUPP(userRoutine) ((SleepQUPP)userRoutine)
#define DisposeSleepQUPP(userUPP)
#define InvokeSleepQUPP(message, qRecPtr, userUPP) (*userUPP)(message, qRecPtr)
#endif
struct SleepQRec {
SleepQRecPtr sleepQLink; /* pointer to next queue element */
short sleepQType; /* queue element type (must be SleepQType) */
SleepQUPP sleepQProc; /* pointer to sleep universal proc ptr */
short sleepQFlags; /* flags */
};
/*
* GetCPUSpeed() *** DEPRECATED ***
*
* Deprecated:
* Use sysctlbyname("hw.cpufrequency"). Found in <sys/sysctl.h>.
*
* Discussion:
* GetCPUSpeed() returns the current effective clock speed of the
* CPU in megahertz.
*
* Result:
* the current effective clock speed of the CPU in megahertz.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.8
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern long
GetCPUSpeed(void) API_DEPRECATED("No longer supported", macos(10.0,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* SleepQInstall() *** DEPRECATED ***
*
* Deprecated:
* Use IORegisterForSystemPower(). Found in <IOKit/pwr_mgt/IOPMLib.h>.
*
* Discussion:
* Adds an entry to the sleep queue.
*
* Parameters:
*
* qRecPtr:
* A pointer to a sleep queue record to be installed.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.8
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void
SleepQInstall(SleepQRecPtr qRecPtr) API_DEPRECATED("No longer supported", macos(10.0,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* SleepQRemove() *** DEPRECATED ***
*
* Deprecated:
* Use IODeregisterForSystemPower(). Found in <IOKit/pwr_mgt/IOPMLib.h>.
*
* Discussion:
* Remove an entry from the sleep queue.
*
* Parameters:
*
* qRecPtr:
* A pointer to a sleep queue record to be removed.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.8
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in InterfaceLib 7.1 and later
*/
extern void
SleepQRemove(SleepQRecPtr qRecPtr) API_DEPRECATED("No longer supported", macos(10.0,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* MaximumProcessorSpeed() *** DEPRECATED ***
*
* Deprecated:
* Use sysctlbyname("hw.cpufrequency_max"). Found in <sys/sysctl.h>.
*
* Discussion:
* MaximumProcessorSpeed() returns the maximum effective clock speed
* of the CPU in megahertz.
*
* Result:
* the maximum effective clock speed of the CPU in megahertz.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.8
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in PowerMgrLib 1.0 and later
*/
extern short
MaximumProcessorSpeed(void) API_DEPRECATED("No longer supported", macos(10.0,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* MinimumProcessorSpeed() *** DEPRECATED ***
*
* Deprecated:
* Use sysctlbyname("hw.cpufrequency_min"). Found in <sys/sysctl.h>.
*
* Discussion:
* MinimumProcessorSpeed() returns the minimum effective clock speed
* of the CPU in megahertz. Before Mac OS X 10.4, this function
* always returns the maximum cpu speed, not the minimum as expected.
*
* Result:
* the minimum effective clock speed of the CPU in megahertz.
*
* Availability:
* Mac OS X: in version 10.1 and later in CoreServices.framework but deprecated in 10.8
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in PowerMgrLib 1.0 and later
*/
extern short
MinimumProcessorSpeed(void) API_DEPRECATED("No longer supported", macos(10.1,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* CurrentProcessorSpeed() *** DEPRECATED ***
*
* Deprecated:
* Use sysctlbyname("hw.cpufrequency"). Found in <sys/sysctl.h>.
*
* Discussion:
* CurrentProcessorSpeed() returns the current effective clock speed
* of the CPU in megahertz. Before Mac OS X 10.4, this function
* always returns the maximum cpu speed, not the actual current
* speed the processor is running at. One MHz represents one
* million cycles per second.
*
* Result:
* the current effective clock speed of the CPU in megahertz.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.8
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in PowerMgrLib 1.0 and later
*/
extern short
CurrentProcessorSpeed(void) API_DEPRECATED("No longer supported", macos(10.0,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* BatteryCount() *** DEPRECATED ***
*
* Deprecated:
* Use IOPowerSources API. Found in <IOKit/ps/IOPowerSources.h>.
*
* Summary:
* Return the count of batteries installed on this computer.
*
* Result:
* the count of batteries installed.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.8
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in PowerMgrLib 1.0 and later
*/
extern short
BatteryCount(void) API_DEPRECATED("No longer supported", macos(10.0,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* UpdateSystemActivity() *** DEPRECATED ***
*
* Deprecated:
* Use IOPMAssertionCreateWithName(). Found in <IOKit/pwr_mgt/IOPMLib.h>.
*
* Summary:
* You can use the UpdateSystemActivity function to notify the Power
* Manager that activity has taken place.
*
* Discussion:
* The UpdateSystemActivity function is used to notify the Power
* Manager that activity has taken place and the timers used to
* measure idle time should be updated to the time of this call.
* This function can be used by device drivers to prevent the
* computer from entering a low-power mode while critical activity
* is taking place on a particular device. The function is passed a
* parameter indicating the type of activity that has
* occurred.
*
* This function is slightly different from DelaySystemIdle, which
* should be used to prevent sleep or idle during a critical
* section. UpdateSystemActivity simply updates the tick count for
* the activity type selected. Conversely, DelaySystemIdle actually
* moves the counter to some number of ticks into the future, which
* allows the caller to go off and do somethingwithout fear of
* idling.
*
* The valid types of activity are:
* Value Name Value Description
* OverallAct 0 general type of activity
* UsrActivity 1 user activity (i.e.keyboard or mouse)
* NetActivity 2 interaction with network(s)
* HDActivity 3 hard disk or storage device in use
*
* Parameters:
*
* activity:
* The type of activity which has occurred.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework but deprecated in 10.8
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in PowerMgrLib 1.0 and later
*/
extern OSErr
UpdateSystemActivity(UInt8 activity) API_DEPRECATED("No longer supported", macos(10.0,10.8) ) API_UNAVAILABLE( ios, tvos, watchos );
#pragma pack(pop)
#ifdef __cplusplus
}
#endif
#endif /* __POWER__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/OSServices.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/OSServices.framework/Headers/IconStorage.h | /*
File: OSServices/IconStorage.h
Contains: Services to load and share icon family data.
Copyright: (c) 2000-2011 Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __ICONSTORAGE__
#define __ICONSTORAGE__
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#pragma pack(push, 2)
/* virtual ARGB icon types. Each type will be split into separate 24 bit RGB data and 8 bit mask for storage in icns container */
/* the ARGB bitmap must be non-premultiplied */
enum {
kIconServices16PixelDataARGB = 'ic04', /* uses kSmall32BitIconIndex and kSmallDeepMaskIconIndex*/
kIconServices32PixelDataARGB = 'ic05', /* uses kLarge32BitIconIndex and kLargeDeepMaskIconIndex*/
kIconServices48PixelDataARGB = 'ic06', /* uses kHuge32BitIconIndex and kHugeDeepMaskIconIndex*/
kIconServices128PixelDataARGB = 'ic07' /* uses kThumbnailDataIndex and kThumbnailMaskIndex*/
};
/* The following icon types can only be used as an icon element */
/* inside a 'icns' icon family */
enum {
kIconServices256PixelDataARGB = 'ic08', /* non-premultiplied 256x256 ARGB bitmap*/
kIconServices512PixelDataARGB = 'ic09', /* non-premultiplied 512x512 ARGB bitmap*/
kIconServices1024PixelDataARGB = 'ic10', /* non-premultiplied 1024x1024 ARGB bitmap*/
kThumbnail32BitData = 'it32',
kThumbnail8BitMask = 't8mk'
};
enum {
kHuge1BitMask = 'ich#',
kHuge4BitData = 'ich4',
kHuge8BitData = 'ich8',
kHuge32BitData = 'ih32',
kHuge8BitMask = 'h8mk'
};
/* The following icon types can be used as a resource type */
/* or as an icon element type inside a 'icns' icon family */
enum {
kLarge1BitMask = 'ICN#',
kLarge4BitData = 'icl4',
kLarge8BitData = 'icl8',
kLarge32BitData = 'il32',
kLarge8BitMask = 'l8mk',
kSmall1BitMask = 'ics#',
kSmall4BitData = 'ics4',
kSmall8BitData = 'ics8',
kSmall32BitData = 'is32',
kSmall8BitMask = 's8mk',
kMini1BitMask = 'icm#',
kMini4BitData = 'icm4',
kMini8BitData = 'icm8'
};
/* Obsolete. Use names defined above. */
enum {
large1BitMask = kLarge1BitMask,
large4BitData = kLarge4BitData,
large8BitData = kLarge8BitData,
small1BitMask = kSmall1BitMask,
small4BitData = kSmall4BitData,
small8BitData = kSmall8BitData,
mini1BitMask = kMini1BitMask,
mini4BitData = kMini4BitData,
mini8BitData = kMini8BitData
};
/*
IconFamily 'icns' resources contain an entire IconFamily (all sizes and depths).
For custom icons, icns IconFamily resources of the custom icon resource ID are fetched first before
the classic custom icons (individual 'ics#, ICN#, etc) are fetched. If the fetch of the icns resource
succeeds then the icns is looked at exclusively for the icon data.
For custom icons, new icon features such as 32-bit deep icons are only fetched from the icns resource.
This is to avoid incompatibilities with cut & paste of new style icons with an older version of the
MacOS Finder.
DriverGestalt is called with code kdgMediaIconSuite by IconServices after calling FSM to determine a
driver icon for a particular device. The result of the kdgMediaIconSuite call to DriverGestalt should
be a pointer an an IconFamily. In this manner driver vendors can provide rich, detailed drive icons
instead of the 1-bit variety previously supported.
The IconFamilyElement and IconFamilyResource data types (which also include the data types
IconFamilyPtr and IconFamilyHandle) are always big-endian.
*/
enum {
kIconFamilyType = 'icns'
};
struct IconFamilyElement {
OSType elementType; /* 'ICN#', 'icl8', etc...*/
SInt32 elementSize; /* Size of this element*/
unsigned char elementData[1];
};
typedef struct IconFamilyElement IconFamilyElement;
struct IconFamilyResource {
OSType resourceType; /* Always 'icns'*/
SInt32 resourceSize; /* Total size of this resource*/
IconFamilyElement elements[1];
};
typedef struct IconFamilyResource IconFamilyResource;
typedef IconFamilyResource* IconFamilyPtr;
typedef IconFamilyPtr* IconFamilyHandle;
/* Icon Variants */
/* These can be used as an element of an 'icns' icon family */
/* or as a parameter to GetIconRefVariant */
enum {
kTileIconVariant = 'tile',
kRolloverIconVariant = 'over',
kDropIconVariant = 'drop',
kOpenIconVariant = 'open',
kOpenDropIconVariant = 'odrp'
};
#pragma pack(pop)
#endif /* __ICONSTORAGE__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/OSServices.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/OSServices.framework/Headers/OSServices.h | /*
File: OSServices/OSServices.h
Contains: Master include for OSServices private framework
Copyright: (c) 2000-2012 Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __OSSERVICES__
#define __OSSERVICES__
#ifndef __COREFOUNDATION__
#include <CoreFoundation/CoreFoundation.h>
#endif
#if TARGET_OS_OSX
#ifndef __CARBONCORE__
#include <CarbonCore/CarbonCore.h>
#endif
#endif
#ifndef __CSIDENTITY__
#include <OSServices/CSIdentity.h>
#endif
#ifndef __CSIDENTITYAUTHORITY__
#include <OSServices/CSIdentityAuthority.h>
#endif
#ifndef __CSIDENTITYBASE__
#include <OSServices/CSIdentityBase.h>
#endif
#ifndef __CSIDENTITYQUERY__
#include <OSServices/CSIdentityQuery.h>
#endif
#if TARGET_OS_OSX
#ifndef __ICONSTORAGE__
#include <OSServices/IconStorage.h>
#endif
#endif
#if TARGET_OS_OSX
#ifndef __POWER__
#include <OSServices/Power.h>
#endif
#endif
#if TARGET_OS_OSX
#ifndef __SECURITYCORE__
#include <OSServices/SecurityCore.h>
#endif
#endif
#if TARGET_OS_OSX
#ifndef __WSMETHODINVOCATION__
#include <OSServices/WSMethodInvocation.h>
#endif
#endif
#if TARGET_OS_OSX
#ifndef __WSPROTOCOLHANDLER__
#include <OSServices/WSProtocolHandler.h>
#endif
#endif
#if TARGET_OS_OSX
#ifndef __WSTYPES__
#include <OSServices/WSTypes.h>
#endif
#endif
#endif /* __OSSERVICES__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/DictionaryServices.framework/DictionaryServices.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: 45B3781F-3D4D-3EB1-ABFC-987AE940DABE
- target: x86_64-maccatalyst
value: 45B3781F-3D4D-3EB1-ABFC-987AE940DABE
- target: arm64-macos
value: 00000000-0000-0000-0000-000000000000
- target: arm64-maccatalyst
value: 00000000-0000-0000-0000-000000000000
- target: arm64e-macos
value: 23D9E702-80B5-39E1-9B9B-FEA156349D01
- target: arm64e-maccatalyst
value: 23D9E702-80B5-39E1-9B9B-FEA156349D01
install-name: '/System/Library/Frameworks/CoreServices.framework/Versions/A/Frameworks/DictionaryServices.framework/Versions/A/DictionaryServices'
current-version: 350
parent-umbrella:
- targets: [ x86_64-macos, x86_64-maccatalyst, arm64-macos, arm64-maccatalyst,
arm64e-macos, arm64e-maccatalyst ]
umbrella: CoreServices
exports:
- targets: [ x86_64-macos, arm64e-macos, x86_64-maccatalyst, arm64e-maccatalyst,
arm64-macos, arm64-maccatalyst ]
symbols: [ _DCSActivateDictionaryPanel, _DCSCopyActiveDictionaries, _DCSCopyAvailableDictionaries,
_DCSCopyDefinitionMarkup, _DCSCopyDefinitionRecords, _DCSCopyDefinitions,
_DCSCopyInactiveDictionaries, _DCSCopyLanguagesOfPreparedDefaultDictionaries,
_DCSCopyRecordForReference, _DCSCopyRecordsForHeadword, _DCSCopyRecordsForSearchString,
_DCSCopyRecordsWithHeadword, _DCSCopyTextDefinition, _DCSCreateAppleWordEquivalenceList,
_DCSCreateHeadwordList, _DCSCreateUserDictionariesDirectory,
_DCSDictionaryAssetAttributesDownloaded, _DCSDictionaryAssetAttributesWillBePurged,
_DCSDictionaryAssetCopyDiagnosticLog, _DCSDictionaryAssetCopyDownloadedDictionaryIdentifiers,
_DCSDictionaryAssetCopyRemovedDictionaryIdentifiers, _DCSDictionaryAssetGetAssetType,
_DCSDictionaryAssetGetCompatibilityVersion, _DCSDictionaryCopyResourceURLsOfType,
_DCSDictionaryCreate, _DCSDictionaryCreateWithAssetAttributes,
_DCSDictionaryCreateWithIdentifier, _DCSDictionaryDownloadFinished,
_DCSDictionaryGetAssetObj, _DCSDictionaryGetBaseURL, _DCSDictionaryGetIdentifier,
_DCSDictionaryGetLanguages, _DCSDictionaryGetName, _DCSDictionaryGetParentDictionary,
_DCSDictionaryGetPreference, _DCSDictionaryGetPreferenceHTML,
_DCSDictionaryGetPrimaryLanguage, _DCSDictionaryGetShortName,
_DCSDictionaryGetStyleSheetURL, _DCSDictionaryGetSubDictionaries,
_DCSDictionaryGetTypeID, _DCSDictionaryGetURL, _DCSDictionaryIsLanguageDictionary,
_DCSDictionaryIsNetworkService, _DCSDictionaryIsSupportedDefinitionStyle,
_DCSDictionarySetDataHeader, _DCSDictionarySetPreference,
_DCSGetActiveDictionaries, _DCSGetDefaultDictionary, _DCSGetDefaultThesaurus,
_DCSGetServicePresentationType, _DCSGetTermRangeInString,
_DCSGetTermRangeInStringWithOptions, _DCSHasDefinitionForTerm,
_DCSInvalidateDictionaryCache, _DCSNormalizeSearchString,
_DCSNormalizeSearchStringWithOptionsAndLocale, _DCSPreferredOrderOfDictionaryAssetAttributesForLanguages,
_DCSPrepareMobileAssetQuery, _DCSRecordCopyData, _DCSRecordCopyDataURL,
_DCSRecordCopyDefinition, _DCSRecordCopyTextElements, _DCSRecordGetAnchor,
_DCSRecordGetAssociatedObj, _DCSRecordGetDictionary, _DCSRecordGetHeadword,
_DCSRecordGetRawHeadword, _DCSRecordGetString, _DCSRecordGetSubDictionary,
_DCSRecordGetSupplementalHeadword, _DCSRecordGetTitle, _DCSRecordGetTypeID,
_DCSRecordSetAssociatedObj, _DCSRecordSetHeadword, _DCSSearchFoundationCopyResults,
_DCSSearchFoundationCopyResultsWithOptions, _DCSSearchSessionCreate,
_DCSSearchSessionScheduleWithRunLoop, _DCSSearchSessionUnscheduleFromRunLoop,
_DCSSetActiveDictionaries, _DCSSetServicePresentationType,
_DCSSortRecordsWithHeadword, _IDXAddRecord, _IDXBuildIndexWithRecords,
_IDXContainsMatchData, _IDXCopyIndexNames, _IDXCreateDictionaryPackage,
_IDXCreateFlattenData, _IDXCreateIndexObject, _IDXDeleteRecord,
_IDXGetDataByID, _IDXGetDataPtrByID, _IDXGetFieldDataPtrs,
_IDXGetMatchData, _IDXGetMatchDataPtr, _IDXIndexGetTypeID,
_IDXPerformSearch, _IDXSetRequestFields, _IDXSetSearchCharacters,
_IDXSetSearchString, _IDXSupportDataPtr, _kDCSActiveDictionariesChangedNotification,
_kDCSDictionaryDescriptionLanguage, _kDCSDictionaryIndexLanguage,
_kDCSFilterOptionAllowNetworkServices, _kDCSFilterOptionDescriptionLanguage,
_kDCSFilterOptionIndexLanguage, _kDCSResourceTypePrivateFont,
_kDCSResourceTypeStyleSheet, _kDCSTextElementKeyHeadword,
_kDCSTextElementKeyPartOfSpeech, _kDCSTextElementKeyPronunciation,
_kDCSTextElementKeyRecordID, _kDCSTextElementKeySenses, _kDCSTextElementKeySensesWithAttributes,
_kDCSTextElementKeySyllabifiedHeadword, _kDCSTextElementSenseKeyIsExplicit,
_kDCSTextElementSenseKeyText, _kIDXPropertyDataFieldName,
_kIDXPropertyDataFields, _kIDXPropertyDataSize, _kIDXPropertyDataSizeLength,
_kIDXPropertyExternalFields, _kIDXPropertyFixedFields, _kIDXPropertyIndexAccessMethod,
_kIDXPropertyIndexBigEndian, _kIDXPropertyIndexDataSizeLength,
_kIDXPropertyIndexKeyMatchingMethods, _kIDXPropertyIndexList,
_kIDXPropertyIndexName, _kIDXPropertyIndexPath, _kIDXPropertyIndexSupportDataID,
_kIDXPropertyIndexWritable, _kIDXPropertyVariableFields, _kIDXPropertyVersion,
_kIDXSearchAllMatch, _kIDXSearchCommonPrefixMatch, _kIDXSearchExactMatch,
_kIDXSearchPrefixMatch, _kIDXSearchWildcardMatch ]
...
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/DictionaryServices.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/DictionaryServices.framework/Headers/DictionaryServices.h | /*
DictionaryServices.h
DictionaryServices framework
Copyright (c) 2007 Apple Inc. All rights reserved.
*/
#ifndef __DICTIONARYSERVICES__
#define __DICTIONARYSERVICES__
#ifndef __COREFOUNDATION__
#include <CoreFoundation/CoreFoundation.h>
#endif
#ifndef __AVAILABILITYMACROS__
#include <AvailabilityMacros.h>
#endif
CF_EXTERN_C_BEGIN
CF_ASSUME_NONNULL_BEGIN
/*!
@typedef DCSDictionaryRef
@abstract Opaque CF object that represents a dictionary file
*/
typedef const struct CF_BRIDGED_TYPE(id) __DCSDictionary* DCSDictionaryRef;
/*!
@function DCSGetTermRangeInString
@abstract Look for a word or a phrase that contains the specified offset in dictionaries
activated in Dictionary.app preference
@param dictionary
This parameter is not supported for Leopard. You should always pass NULL.
@param textString
Text that contains the word or phrase to look up
@param offset
Specifies a character offset in textString
@result Returns a detected range of word or phrase around the specified offset,
or (kCFNotFound, 0) is returned if any term is not found in active dictionaries.
The result range can be used as an input parameter of DCSCopyTextDefinition()
and HIDictionaryWindowShow() in Carbon framework.
*/
extern CFRange DCSGetTermRangeInString( DCSDictionaryRef __nullable dictionary, CFStringRef textString, CFIndex offset ) API_AVAILABLE(macos(10.5), ios(5.0));
/*!
@function DCSCopyTextDefinition
@abstract Copies definition for a specified range of text
@param dictionary
This parameter is not supported for Leopard. You should always pass NULL.
@param textString
Text that contains the word or phrase to look up
@param range
Range of the target word or phrase in textString
@result Returns a definition of the specified term in range in plain text
*/
extern CFStringRef __nullable DCSCopyTextDefinition( DCSDictionaryRef __nullable dictionary, CFStringRef textString, CFRange range ) API_AVAILABLE(macos(10.5), ios(5.0));
CF_ASSUME_NONNULL_END
CF_EXTERN_C_END
#endif // __DICTIONARYSERVICES__
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/LaunchServices.framework/LaunchServices.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: 4D53BFD9-3D56-3BFA-A68A-3F03F355AE78
- target: x86_64-maccatalyst
value: 4D53BFD9-3D56-3BFA-A68A-3F03F355AE78
- target: arm64-macos
value: 00000000-0000-0000-0000-000000000000
- target: arm64-maccatalyst
value: 00000000-0000-0000-0000-000000000000
- target: arm64e-macos
value: 4E0BB03C-088B-3EFA-9FFE-E3DC6E90547D
- target: arm64e-maccatalyst
value: 4E0BB03C-088B-3EFA-9FFE-E3DC6E90547D
install-name: '/System/Library/Frameworks/CoreServices.framework/Versions/A/Frameworks/LaunchServices.framework/Versions/A/LaunchServices'
current-version: 1141.1
parent-umbrella:
- targets: [ x86_64-macos, x86_64-maccatalyst, arm64-macos, arm64-maccatalyst,
arm64e-macos, arm64e-maccatalyst ]
umbrella: CoreServices
allowable-clients:
- targets: [ x86_64-macos, x86_64-maccatalyst, arm64-macos, arm64-maccatalyst,
arm64e-macos, arm64e-maccatalyst ]
clients: [ Foundation ]
exports:
- targets: [ x86_64-maccatalyst, x86_64-macos, arm64e-maccatalyst, arm64e-macos,
arm64-macos, arm64-maccatalyst ]
symbols: [ _AcquireIconRef, _CompositeIconRef, _GetCustomIconsEnabled,
_GetIconRef, _GetIconRefFromComponent, _GetIconRefFromFileInfo,
_GetIconRefFromFolder, _GetIconRefFromIconFamilyPtr, _GetIconRefFromTypeInfo,
_GetIconRefFromUTI, _GetIconRefOwners, _IsDataAvailableInIconRef,
_IsIconRefComposite, _IsValidIconRef, _LSApplicationSINFKey,
_LSApplicationWorkspaceErrorDomain, _LSApplicationsChangedNotificationName,
_LSApplyURLOverridesForContacts, _LSBindingCopyVariant, _LSBlockUntilCompleteKey,
_LSCanRefAcceptItem, _LSCanURLAcceptURL, _LSContinuityErrorDomain,
_LSCopyAllHandlersForURLScheme, _LSCopyAllRoleHandlersForContentType,
_LSCopyApplicationForMIMEType, _LSCopyApplicationURLsForBundleIdentifier,
_LSCopyApplicationURLsForURL, _LSCopyDefaultApplicationURLForContentType,
_LSCopyDefaultApplicationURLForURL, _LSCopyDefaultHandlerForURLScheme,
_LSCopyDefaultRoleHandlerForContentType, _LSCopyDisplayNameForRef,
_LSCopyDisplayNameForURL, _LSCopyItemAttribute, _LSCopyItemAttributes,
_LSCopyItemInfoForRef, _LSCopyItemInfoForURL, _LSCopyKindStringForMIMEType,
_LSCopyKindStringForRef, _LSCopyKindStringForTypeInfo, _LSCopyKindStringForURL,
_LSDefaultApplicationManagementDomain, _LSDefaultIconName,
_LSDisableURLOverrides, _LSDocumentTypesChangedNotificationName,
_LSFileProviderStringKey, _LSFindApplicationForInfo, _LSGeoJSONKey,
_LSGetApplicationForInfo, _LSGetApplicationForItem, _LSGetApplicationForURL,
_LSGetExtensionInfo, _LSGetHandlerOptionsForContentType, _LSGetOpenRoles,
_LSHiddenAppType, _LSInit, _LSInstallTypeKey, _LSInternalApplicationType,
_LSMoveDocumentOnOpenKey, _LSNewsstandArtworkKey, _LSOpenApplication,
_LSOpenApplicationPayloadOptionsKey, _LSOpenCFURLRef, _LSOpenFSRef,
_LSOpenFromRefSpec, _LSOpenFromURLSpec, _LSOpenInBackgroundKey,
_LSOpenItemsWithRole, _LSOpenURLsWithRole, _LSPackageTypeCarrierBundle,
_LSPackageTypeCustomer, _LSPackageTypeDeveloper, _LSPackageTypeKey,
_LSPackageTypePlaceholder, _LSPlugInKitType, _LSReferrerURLKey,
_LSRegisterFSRef, _LSRegisterURL, _LSRequireOpenInPlaceKey,
_LSRestrictedKey, _LSSetDefaultHandlerForURLScheme, _LSSetDefaultRoleHandlerForContentType,
_LSSetExtensionHiddenForRef, _LSSetExtensionHiddenForURL,
_LSSetHandlerOptionsForContentType, _LSSetItemAttribute, _LSSimulatorRootPathKey,
_LSSimulatorUserPathKey, _LSSupressNotificationKey, _LSSystemApplicationType,
_LSSystemPlaceholderType, _LSTargetBSServiceConnectionEndpointKey,
_LSTerm, _LSTypeDeclarationsChangedNotificationName, _LSURLTypesChangedNotificationName,
_LSUninstallUserDataOnly, _LSUpdatePlaceholderIconKey, _LSUserActivityAlwaysEligibleKey,
_LSUserActivityAlwaysPickKey, _LSUserActivityHasWebPageURLOptionKey,
_LSUserActivityIsForPairedDeviceOptionKey, _LSUserActivityIsHighPriorityOptionKey,
_LSUserActivityIsNotificationOptionKey, _LSUserActivityManagerActivityContinuationIsEnabledChangedNotification,
_LSUserActivityTypeNowPlaying, _LSUserActivityTypeSiri, _LSUserActivityTypeTeamIDOverideKey,
_LSUserApplicationType, _LSUserInitiatedUninstall, _LSVPNPluginType,
_LSiTunesArtworkKey, _LSiTunesMetadataKey, _OverrideIconRef,
_ReadIconFromFSRef, _RegisterIconRefFromFSRef, _RegisterIconRefFromIconFamily,
_ReleaseIconRef, _RemoveIconRefOverride, _SetCustomIconsEnabled,
_UTCreateStringForOSType, _UTGetOSTypeFromString, _UTTypeConformsTo,
_UTTypeCopyAllTagsWithClass, _UTTypeCopyChildIdentifiers,
_UTTypeCopyDeclaration, _UTTypeCopyDeclaringBundleURL, _UTTypeCopyDescription,
_UTTypeCopyParentIdentifiers, _UTTypeCopyPreferredTagWithClass,
_UTTypeCreateAllIdentifiersForTag, _UTTypeCreatePreferredIdentifierForTag,
_UTTypeEqual, _UTTypeIsDeclared, _UTTypeIsDynamic, _UTTypeShow,
_UnregisterIconRef, _UpdateIconRef, __FlattenIconRef, __GDBIconRefsList,
__GetIconRefFromIOKitDevice, __GetIconRefFromURL, __IconRefCopyResourceURLs,
__IconRefIsTemplate, __LSASNCreate, __LSASNCreateCopy, __LSASNCreateWithPid,
__LSASNCreateWithUInt64, __LSASNExtractHighAndLowParts, __LSASNGetTypeID,
__LSASNReturnASNForPIDFromWithinCoreServicesd, __LSASNToUInt64,
__LSAddRecentItem, __LSAddToRecentsAfterOpening, __LSAdvertisementBytesKind,
__LSAgentCheckRiskLevelForURL, __LSAgentCopyDisplayNameWithLanguageCode,
__LSAgentGetAuditToken, __LSAllocatePSN, __LSAnnotateAndSendAppleEvent,
__LSAppStateBlockedKey, __LSAppStateInstalledKey, __LSAppStatePlaceholderKey,
__LSAppStateRemovedKey, __LSAppStateRestrictedKey, __LSAppStateValidKey,
__LSApplicationCheckIn, __LSApplicationQuitting, __LSAssertRunningInServer,
__LSBindingCopyIconRef, __LSBindingCopyUTI, __LSBindingCopyVariant,
__LSBindingCreateVariant, __LSBindingCreateWithBookmarkData,
__LSBindingCreateWithData, __LSBindingCreateWithIconRef, __LSBindingCreateWithResourceData,
__LSBindingCreateWithResourceURL, __LSBindingCreateWithTypeInfo,
__LSBindingCreateWithURL, __LSBindingCreateWithUTI, __LSBindingEnumerateIconResourceInfo,
__LSBindingGetBadge, __LSBindingGetCachingProfile, __LSBindingGetDataRepresentation,
__LSBindingGetIconRef, __LSBindingGetLegacyIconRef, __LSBindingGetType,
__LSBindingGetTypeID, __LSBindingGetValidationState, __LSBindingGetValidationToken,
__LSBindingGetVariantFlags, __LSBindingSetLogFile, __LSBindingSetReasonTrackingEnabled,
__LSBindingValidationStateIsStale, __LSBindingValidationStateIsValid,
__LSCEResultAlwaysAllowDeveloperKey, __LSCEResultSubmitMalwareReportKey,
__LSCEResultUnquarantineDiskImageKey, __LSCEResultUnquarantineServerKey,
__LSCanOpenContentsOfPasteboard, __LSCanURLAcceptContentType,
__LSClientSideReconnectionPhase1, __LSCompareASNs, __LSCompareASNsLong,
__LSCompareHashedBytesFromAdvertisingStrings, __LSConflictResolutionContinueOpening,
__LSConflictResolutionCopyDocumentURL, __LSConflictResolverProcessIdentifier,
__LSCopyActivityTypesClaimedHashedAdvertisingStrings, __LSCopyAdvertisementStringForTeamIdentifierAndActivityType,
__LSCopyAllApplicationArray, __LSCopyAllApplicationURLs, __LSCopyAllClaimedContentTypesForApplicationURL,
__LSCopyAllClaimedURLSchemesForApplicationURL, __LSCopyApplicationArray,
__LSCopyApplicationArrayInFrontToBackOrder, __LSCopyApplicationCategories,
__LSCopyApplicationDeathInformationForPid, __LSCopyApplicationInformation,
__LSCopyApplicationInformationItem, __LSCopyApplicationURLsForContentType,
__LSCopyApplicationURLsForItemURL, __LSCopyApplicationURLsWithInfoFlags,
__LSCopyApplicationsWithPath, __LSCopyArchitecturePreferenceForApplicationURL,
__LSCopyBundleIdentifierForRegisteredSurrogate, __LSCopyBundleIdentifierFromSurrogateData,
__LSCopyBundleURLForRegisteredSurrogate, __LSCopyBundleURLWithIdentifier,
__LSCopyClaimedActivityIdentifiersAndDomains, __LSCopyCurrentApplicationASN,
__LSCopyDefaultSchemeHandlerURL, __LSCopyDisplayNameForCanonicalName,
__LSCopyDownloadAssessmentDictionary, __LSCopyFrontApplication,
__LSCopyFrontUIApplication, __LSCopyItemAttributesForRefInfo,
__LSCopyKernelPackageExtensions, __LSCopyKindStringForInfo,
__LSCopyLSASNForAuditToken, __LSCopyLaunchModifiers, __LSCopyLibraryItemURLs,
__LSCopyLoginItemURLWithBundleIdentifiers, __LSCopyMatchingApplications,
__LSCopyMatchingApplicationsWithItems, __LSCopyMetaApplicationInformation,
__LSCopyMetaApplicationInformationItem, __LSCopyNULLApplicationASN,
__LSCopyPendingApplicationArray, __LSCopyProcessQuarantineProperties,
__LSCopyRecentItems, __LSCopyRunningApplicationArray, __LSCopySchemesAndHandlerURLs,
__LSCopySystemApplicationASN, __LSCopyTypeIdentifierForItemRefInfo,
__LSCopyURLOverrideForURL, __LSCopyUserActivityDomainNamesForBundleID,
__LSCopyValidApplicationCategories, __LSCreateCSUIConnectionForLaunching,
__LSCreateDatabaseChangeNotificationNameForCurrentUser, __LSCreateDatabaseLookupStringFromHashedBytesForAdvertising,
__LSCreateDeviceTypeIdentifierWithModelCode, __LSCreateDeviceTypeIdentifierWithModelCodeAndColorComponents,
__LSCreateHashedBytesForAdvertisingFromString, __LSCreatePackageExtensionsArray,
__LSCreateSurrogateDataForApplication, __LSCreateVisualizerForDatabaseAtURL,
__LSCreateVisualizerForDatabaseAtURLWithStore, __LSDServiceGetXPCProxyForServiceClass,
__LSDataContainerPersonalityCopyInfo, __LSDataContainerPersonalityRemoveInfo,
__LSDataContainerPersonalitySetInfo, __LSDataContainerPersonalitySetInfoWithApplicationIdentifier,
__LSDatabaseContextSetDetachProxyObjects, __LSDatabaseCopyURLForUser,
__LSDebugAdvertismentValue, __LSDebugGetSharedMemoryPageAddress,
__LSDefaultLog, __LSDeleteAllQuarantineHistory, __LSDeleteQuarantineHistoryForFileURL,
__LSDeleteQuarantineHistoryInDateRange, __LSDisplayData, __LSEnumerateApplicationsFromSpotlight,
__LSExceptionsGetAppStoreInfoForBundleIdentifier, __LSExceptionsIsBundleIdentifierInternallyBlocked,
__LSExtensionsLog, __LSFindApplications, __LSFindApplicationsItem,
__LSGetApplicationInformationSeed, __LSGetApplicationListSeed,
__LSGetBundle, __LSGetCurrentApplicationASN, __LSGetFrontApplicationSeed,
__LSGetIconRefForURL, __LSGetMainBundleURL, __LSGetMenuBarOwnerApplicationSeed,
__LSGetNotificationInformation, __LSGetPointerAuthKeyStatePreferenceForCurrentApplication,
__LSGetRecentItemCount, __LSGetSharedMemoryPageInfoTEST, __LSGetShowAllExtensionsPreference,
__LSGetStatus, __LSGetVersionFromString, __LSGetVisibleApplicationListSeed,
__LSHandlerRankAlternate, __LSHandlerRankDefault, __LSHandlerRankNone,
__LSHandlerRankOwner, __LSIconDictionarySupportsAssetCatalogs,
__LSInstall_ocon_EventHandler, __LSIsApplicationRunning, __LSKillApplication,
__LSLaunchApplication, __LSLog, __LSMakeVersionNumber, __LSMigrateLaunchServices,
__LSModifyNotification, __LSOpen2CopyDiagnostics, __LSOpen2SetDiagnostics,
__LSOpenApplicationURL, __LSOpenCallInvokeWithXPC, __LSOpenContentsOfPasteboardWithCompletionHandler,
__LSOpenExtractBackgroundLaunchReasonFromAppleEvent, __LSOpenURLWithCompletionHandler,
__LSOpenURLsUsingASNWithCompletionHandler, __LSOpenURLsUsingBundleIdentifierWithCompletionHandler,
__LSOpenURLsWithCompletionHandler, __LSOrderApplications,
__LSPassDownCurrentEventState, __LSPersistentIdentifierCompare,
__LSPersistentIdentifierGetDebugDescription, __LSPersistentIdentifierGetKnowledgeUUID4CoreDevice,
__LSPersistentIdentifierGetSequenceNumber4CoreDevice, __LSPostLaunchModifiers,
__LSQuarantinePropertiesCreateData, __LSQuarantinePropertiesCreateWithBytes,
__LSReCheckinApplication, __LSReRegisterNotifications, __LSRecentItemsChanged,
__LSRecentsInit, __LSRegisterAsSessionLauncherClient, __LSRegisterExtensionPointInfo,
__LSRegisterFilePropertyProvider, __LSRegisterLibraryBundle,
__LSRegisterNamedXPCConnection, __LSRegisterPlatformExtensionPointInfo,
__LSRegisterPlatformFrameworkExtensionPointInfo, __LSRegisterPluginURL,
__LSRegisterURLWithOptions, __LSRemoveDefaultRoleHandlerForContentType,
__LSRemoveRecentItems, __LSRequestProcessBecomeFrontmost,
__LSSaveAndRefresh, __LSScheduleNotificationFunction, __LSScheduleNotificationFunctionOnQueue_f,
__LSScheduleNotificationOnQueueWithBlock, __LSSecretManagementDecryptData,
__LSSecretManagementEncryptData, __LSSecretManagementVersion,
__LSSendNotification, __LSServerMain, __LSSetApplicationCategories,
__LSSetApplicationInformation, __LSSetApplicationInformationItem,
__LSSetApplicationLaunchServicesServerConnectionStatus, __LSSetArchitecturePreferenceForApplicationURL,
__LSSetDatabaseIsSeeded, __LSSetDefaultSchemeHandlerURL, __LSSetDefaultSchemeHandlerURLWaitingUntilDone,
__LSSetDefaultWebBrowserWithApplicationURL, __LSSetDefaultWebBrowserWithBundleIdentifierAndVersion,
__LSSetDefaultXPCConnection, __LSSetFrontApplication, __LSSetFrontApplicationLong,
__LSSetFrontApplicationLongWithCompletion, __LSSetMetaApplicationInformation,
__LSSetMetaApplicationInformationItem, __LSSetPointerAuthKeyStatePreferenceForCurrentApplication,
__LSSetProcessQuarantineProperties, __LSSetRecentItemCount,
__LSSetShowAllExtensionsPreference, __LSSetUpClientSideReconnectionServices,
__LSSetWeakBindingForFileURL, __LSSetWeakBindingURLForType,
__LSSetWeakBindingURLForUTI, __LSSharedMemoryBumpApplicationInformationSeed,
__LSSharedMemoryBumpApplicationListSeed, __LSSharedMemoryBumpFrontApplicationASNSeed,
__LSSharedMemoryBumpMenuBarOwnerASNSeed, __LSSharedMemoryBumpPendingApplicationListSeed,
__LSSharedMemoryBumpVisibleApplicationListSeed, __LSSharedMemoryClearIndexedApplicationInformation,
__LSSharedMemoryCopyForSessionID, __LSSharedMemoryCopySystemUIPresentationModeStrRef,
__LSSharedMemoryGetApplicationInformation, __LSSharedMemoryGetApplicationInformationForPid,
__LSSharedMemoryGetApplicationInformationSeed, __LSSharedMemoryGetApplicationListCount,
__LSSharedMemoryGetApplicationListSeed, __LSSharedMemoryGetCGSSessionID,
__LSSharedMemoryGetChangeCount, __LSSharedMemoryGetDebugLevel,
__LSSharedMemoryGetExpectedFrontApplicationASNLow, __LSSharedMemoryGetFrontASNLow,
__LSSharedMemoryGetFrontApplicationASNSeed, __LSSharedMemoryGetIndexedApplicationAdditionalInformation,
__LSSharedMemoryGetIndexedApplicationInformation, __LSSharedMemoryGetLaunchProgressFlags,
__LSSharedMemoryGetLaunchProgressUserActivityCount, __LSSharedMemoryGetLockCount,
__LSSharedMemoryGetMenuBarOwnerASNLow, __LSSharedMemoryGetMenuBarOwnerASNSeed,
__LSSharedMemoryGetMetaInformationFlags, __LSSharedMemoryGetNextAppToBringForwardASNLow,
__LSSharedMemoryGetPagePtr, __LSSharedMemoryGetPendingApplicationListSeed,
__LSSharedMemoryGetSessionID, __LSSharedMemoryGetSessionLauncherASNLow,
__LSSharedMemoryGetSize, __LSSharedMemoryGetSystemProcessASNLow,
__LSSharedMemoryGetSystemUIPresentationMode, __LSSharedMemoryGetSystemUIPresentationModeStrRef,
__LSSharedMemoryGetSystemUIPresentationOptions, __LSSharedMemoryGetTypeID,
__LSSharedMemoryGetVersion, __LSSharedMemoryGetVisibleApplicationListSeed,
__LSSharedMemoryIncrementLaunchProgressUserActivityCount,
__LSSharedMemoryInvalidateCachedSharedMemoryPages, __LSSharedMemoryIsApplicationInformationUsable,
__LSSharedMemoryIsLocked, __LSSharedMemoryIsUnlocked, __LSSharedMemoryLock,
__LSSharedMemoryPageCreate, __LSSharedMemorySetApplicationInformationFromToken,
__LSSharedMemorySetApplicationListCount, __LSSharedMemorySetCGSSessionID,
__LSSharedMemorySetDebugLevel, __LSSharedMemorySetExpectedFrontApplicationASNLow,
__LSSharedMemorySetFrontASNLow, __LSSharedMemorySetIndexedApplicationInformation,
__LSSharedMemorySetLaunchProgressFlags, __LSSharedMemorySetMenuBarOwnerASNLow,
__LSSharedMemorySetMetaInformationFlags, __LSSharedMemorySetNextAppToBringForwardASNLow,
__LSSharedMemorySetSessionLauncherASNLow, __LSSharedMemorySetSystemProcessASNLow,
__LSSharedMemorySetSystemUIPresentationMode, __LSSharedMemorySetSystemUIPresentationOptions,
__LSSharedMemoryUnlock, __LSSignalApplicationReady, __LSStartLaunchedApplication,
__LSURLBindingReasonKey, __LSURLIsDataContainer4IS, __LSUnregisterPluginsInDirectory,
__LSUnregisterURL, __LSUnregisterURLsRelativeToURL, __LSUnscheduleNotificationFunction,
__LSUpdateRegistrationForURLsRelativeToURL, __LSUseCoreApplicationServices,
__LSUserActivityContainsFileProviderURLKey, __LSUserActivityContainsUnsynchronizedCloudDocsKey,
__LSUserActivityOptionInvalidateAfterFetchKey, __LSVersionNumberCompare,
__LSVersionNumberCopyStringRepresentation, __LSVersionNumberGetBugFixComponent,
__LSVersionNumberGetCurrentSystemVersion, __LSVersionNumberGetMajorComponent,
__LSVersionNumberGetMinorComponent, __LSVersionNumberGetStringRepresentation,
__LSVersionNumberHash, __LSVersionNumberMakeWithString, __LSWaitForApplicationCheckIn,
__LSWaitUntilSeedingComplete, __LSWriteApplicationPlaceholderToURL,
__LSWriteSurrogateForApplicationToURL, __UTCopyDeclaredTypeIdentifiers,
__UTTypeCopyDescriptionLocalizationDictionary, __UTTypeCopyDynamicIdentifiersForTags,
__UTTypeCopyGlyphName, __UTTypeCopyIconFileURL, __UTTypeCopyIconName,
__UTTypeCopyIdentifierForPromiseAtURL, __UTTypeCopyKindStringDictionaryForNonMaterializedItem,
__UTTypeCopyKindStringForNonMaterializedItem, __UTTypeCopyPedigree,
__UTTypeCopyPedigreeSet, __UTTypeCreateDynamicIdentifierForTaggedPointerObject,
__UTTypeCreateSuggestedFilename, __UTTypeGetStatus, __UTTypeHash,
__UTTypeIdentifierIsValid, __UTTypeIsWildcard, __UTTypePrecachePropertiesOfIdentifiers,
__UnlattenIconRef, ___LSDefaultsGetSharedInstance, __kLSASNKey,
__kLSASNToBringForwardAtNextApplicationExitKey, __kLSActivePageUserVisibleOriginsKey,
__kLSAddToPermittedFrontASNsArrayKey, __kLSAllowedToBecomeFrontmostKey,
__kLSApplicationBackgroundOnlyTypeKey, __kLSApplicationBackgroundPriorityKey,
__kLSApplicationCountKey, __kLSApplicationDelayLaunchUntilTimeKey,
__kLSApplicationDesiresAttentionKey, __kLSApplicationDoNotTALRelaunchKey,
__kLSApplicationForegroundPriorityKey, __kLSApplicationForegroundTypeKey,
__kLSApplicationHasRegisteredKey, __kLSApplicationHasSignalledItIsReadyKey,
__kLSApplicationInSandboxKey, __kLSApplicationInStoppedStateKey,
__kLSApplicationInThrottledStateAfterLaunchKey, __kLSApplicationInformationSeedKey,
__kLSApplicationIsBetaKey, __kLSApplicationIsHiddenKey, __kLSApplicationListSeedKey,
__kLSApplicationLockedInStoppedStateKey, __kLSApplicationOverriddenBackgroundDomainNameKey,
__kLSApplicationReadyToBeFrontableKey, __kLSApplicationSandboxedInformationItemsKey,
__kLSApplicationTypeKey, __kLSApplicationTypeToRestoreKey,
__kLSApplicationUIElementTypeKey, __kLSApplicationVersionKey,
__kLSApplicationWasTerminatedByTALKey, __kLSApplicationWouldBeTerminatedByTALKey,
__kLSApplicationsRecordingAppleEventsKey, __kLSArchitectureARM64Value,
__kLSArchitectureKey, __kLSArchitecturePowerPC64Value, __kLSArchitecturePowerPCValue,
__kLSArchitectureUnknownValue, __kLSArchitecturei386Value,
__kLSArchitecturex86_64Value, __kLSAuditTokenKey, __kLSBackgroundPriorityKey,
__kLSBackgroundPriorityOnceKey, __kLSBindingResourceInfoBadgeableKey,
__kLSBindingResourceInfoNameKey, __kLSBindingResourceInfoResourceKey,
__kLSBindingResourceInfoVariantFlagsKey, __kLSBringForwardDelayKey,
__kLSBringForwardRequestCausedByUserIntentKey, __kLSBringForwardRequestForcedKey,
__kLSBringForwardRequestIfFrontReservationExistsKey, __kLSBringForwardRequestImmediateKey,
__kLSBringForwardRequestStandardActivationKey, __kLSBringForwardWindowIDKey,
__kLSBringNextApplicationForwardKey, __kLSBundleIdentifierLowerCaseKey,
__kLSBundleNameLowerCaseKey, __kLSBundlePathDeviceIDKey, __kLSBundlePathINodeKey,
__kLSBundlePathKey, __kLSBundlePathLastComponentLowerCaseKey,
__kLSBundlePathSandboxExtensionKey, __kLSCheckInTimeKey, __kLSDYLDPlatformKey,
__kLSDataContainerPersonalityIconKey, __kLSDataContainerPersonalityLocalizedNameKey,
__kLSDebugLevelKey, __kLSDisableAllPostLaunchBringForwardRequestsKey,
__kLSDisplayNameKey, __kLSDoNotBFIfFrontApplicationSeedIsChangedKey,
__kLSDoNotBringAllWindowsForwardKey, __kLSDoNotBringAnyWindowsForwardKey,
__kLSDoNotSetTaskPolicyAutomaticallyKey, __kLSDontDropRootPermissionsKey,
__kLSErrorMessageStringKey, __kLSExecutableFilenameLowerCaseKey,
__kLSExecutableFormatCFMKey, __kLSExecutableFormatKey, __kLSExecutableFormatMachOKey,
__kLSExecutableFormatPoundBangKey, __kLSExecutablePathDeviceIDKey,
__kLSExecutablePathINodeKey, __kLSExecutablePathKey, __kLSExecutablePlatformKey,
__kLSExecutableSDKVersionKey, __kLSExitStatusKey, __kLSExpectedFrontApplicationASNKey,
__kLSFileCreatorKey, __kLSFileTypeKey, __kLSFlavorKey, __kLSForegroundPriorityKey,
__kLSForegroundPriorityOnceKey, __kLSFrontASNKey, __kLSFrontApplicationSeedKey,
__kLSFrontReservationExistsKey, __kLSHiddenApplicationCountKey,
__kLSIsProxiedForTALKey, __kLSKeyBeingAddedKey, __kLSKeyBeingChangedKey,
__kLSKeyBeingRemovedKey, __kLSKnownLSSessionIDsKey, __kLSLaunchBeforeTranslocationLaunchBundlePathDeviceIDKey,
__kLSLaunchBeforeTranslocationLaunchBundlePathINodeKey, __kLSLaunchBeforeTranslocationLaunchBundlePathKey,
__kLSLaunchBeforeTranslocationLaunchExecutablePathDeviceIDKey,
__kLSLaunchBeforeTranslocationLaunchExecutablePathINodeKey,
__kLSLaunchBeforeTranslocationLaunchExecutablePathKey, __kLSLaunchDLabelKey,
__kLSLaunchEventRecordTimeKey, __kLSLaunchInProgressKey, __kLSLaunchModifierAddPSNToArgumentListKey,
__kLSLaunchModifierAdditionalEnvironmentVarsDictKey, __kLSLaunchModifierArchitectures,
__kLSLaunchModifierAsGIDKey, __kLSLaunchModifierAsUIDKey,
__kLSLaunchModifierAsyncKey, __kLSLaunchModifierDataKey, __kLSLaunchModifierDataTypeAppParametersKey,
__kLSLaunchModifierDataTypeAppleEventKey, __kLSLaunchModifierDataTypeKey,
__kLSLaunchModifierDoNotAddCOMMAND_MODEEnvironmentVariableKey,
__kLSLaunchModifierDoNotAddToRecentApplicationsKey, __kLSLaunchModifierDoNotMakeFrontmostWhenReadyKey,
__kLSLaunchModifierFailureErrorCodeKey, __kLSLaunchModifierFailureErrorStringKey,
__kLSLaunchModifierForce32Bit, __kLSLaunchModifierFullEnvironmentVarsDictKey,
__kLSLaunchModifierLaunchAndHideOthersKey, __kLSLaunchModifierLaunchAndLetLauncherStartProcessKey,
__kLSLaunchModifierLaunchInStoppedStateKey, __kLSLaunchModifierLaunchWithASLRDisabledKey,
__kLSLaunchModifierLaunchedHiddenKey, __kLSLaunchModifierLeaveOpenFilesAloneKey,
__kLSLaunchModifierLeaveSTDERRAloneKey, __kLSLaunchModifierLeaveSTDINAloneKey,
__kLSLaunchModifierLeaveSTDOUTAloneKey, __kLSLaunchModifierNewCopyKey,
__kLSLaunchModifierOverriddenApplicationType, __kLSLaunchModifierRefConKey,
__kLSLaunchModifierUMaskKey, __kLSLaunchModifierUserActivityCountAtLaunchKey,
__kLSLaunchModifierWithLoginKey, __kLSLaunchModifiersBFIfFrontSeedChangesDuringLaunchKey,
__kLSLaunchModifiersBFIfMouseButtonIsDownDuringLaunchKey,
__kLSLaunchModifiersBFIfUserActivityOccursDuringLaunchKey,
__kLSLaunchModifiersFrontApplicationSeedKey, __kLSLaunchModifiersKey,
__kLSLaunchModifiersLaunchProgressTimeoutKey, __kLSLaunchModifiersLaunchedBecauseOfPersistenceKey,
__kLSLaunchModifiersTimeoutBeforeRestoringBackgroundPriorityKey,
__kLSLaunchTimeKey, __kLSLaunchedByLaunchServicesKey, __kLSLaunchedByLaunchServicesThruForkExecKey,
__kLSLaunchedByLaunchServicesThruLaunchDKey, __kLSLaunchedByLaunchServicesThruSessionLauncherKey,
__kLSLaunchedInQuarantineKey, __kLSLaunchedPersonaUIDKey,
__kLSMenuBarOwnerApplicationSeedKey, __kLSMenuBarOwningASNKey,
__kLSMetaExpectedFrontAppsASNsKey, __kLSMetaInfoActiveCGSSessionIDKey,
__kLSMetaInfoAddUIDsToSessionKey, __kLSMetaInfoCGSSessionIDKey,
__kLSMetaMultiplyProhibitedApplicationBundleIDsArrayKey, __kLSMetaProcessShouldNotConnectToLSServerKey,
__kLSMetaRecentApplicationsArrayIntervalKey, __kLSMetaRecentApplicationsArrayKey,
__kLSMetaRecentApplicationsArraySizeKey, __kLSModifierLaunchedForPersistenceKey,
__kLSModifierRefConKey, __kLSMouseButtonDownKey, __kLSNotificationsDelayedCountKey,
__kLSNotificationsPendingCountKey, __kLSNotificationsSentCountKey,
__kLSNotifyBecameFrontmostAnotherLaunchKey, __kLSNotifyBecameFrontmostFirstActivationKey,
__kLSNotifyLaunchRequestArgumentListKey, __kLSNotifyLaunchRequestLaunchModifiersKey,
__kLSOpenOptionAEParamDescKey, __kLSOpenOptionAEParamKeyKey,
__kLSOpenOptionActivateKey, __kLSOpenOptionAddToRecentsKey,
__kLSOpenOptionAllowConflictResolutionUIKey, __kLSOpenOptionAllowErrorUIKey,
__kLSOpenOptionAllowLoginUIKey, __kLSOpenOptionAlwaysOpenPasteboardContentsKey,
__kLSOpenOptionArchitectureKey, __kLSOpenOptionArchitectureSubtypeKey,
__kLSOpenOptionArgumentsKey, __kLSOpenOptionBackgroundLaunchInformationKey,
__kLSOpenOptionBackgroundLaunchKey, __kLSOpenOptionBackgroundLaunchReasonKey,
__kLSOpenOptionCaptureDiagnosticsKey, __kLSOpenOptionEnableURLOverridesKey,
__kLSOpenOptionEnvironmentVariablesKey, __kLSOpenOptionForegroundLaunchKey,
__kLSOpenOptionHideKey, __kLSOpenOptionHideOthersKey, __kLSOpenOptionInitialAppleEventKey,
__kLSOpenOptionLaunchSessionIDDKey, __kLSOpenOptionLaunchStdErrPathKey,
__kLSOpenOptionLaunchStdInPathKey, __kLSOpenOptionLaunchStdOutPathKey,
__kLSOpenOptionLaunchUIDKey, __kLSOpenOptionLaunchWhenThisProcessExitsKey,
__kLSOpenOptionLaunchedByPersistenceKey, __kLSOpenOptionOverrideBackgroundPriorityDomainNameKey,
__kLSOpenOptionPreferRunningInstanceKey, __kLSOpenOptionPrintDocumentsKey,
__kLSOpenOptionRequiresUniversalLinksKey, __kLSOpenOptionRolesMaskKey,
__kLSOpenOptionStopProcessKey, __kLSOpenOptionUIElementLaunchKey,
__kLSOpenOptionUserInfoKey, __kLSOpenOptionWaitForApplicationToCheckInKey,
__kLSOriginalExecutablePathDeviceIDKey, __kLSOriginalExecutablePathINodeKey,
__kLSOriginalExecutablePathKey, __kLSOriginalPIDKey, __kLSPIDKey,
__kLSPIDsInSessionKey, __kLSPSNToBringForwardAtNextApplicationExitKey,
__kLSParentASNKey, __kLSParentASNWasInferredKey, __kLSPermittedFrontASNsArrayKey,
__kLSPersistenceSuppressRelaunchAtLoginKey, __kLSPidThisProcessIsAWrapperForKey,
__kLSPidThisProcessIsWrappingKey, __kLSPluginBundleIdentifierKey,
__kLSPreviousASNKey, __kLSPreviousPresentationModeKey, __kLSPreviousValueKey,
__kLSRecordingAppleEventsKey, __kLSRemoveFromPermittedFrontASNsArrayKey,
__kLSServerMessageCountKey, __kLSSessionAttributesKey, __kLSSessionIDKey,
__kLSSessionLauncherASNKey, __kLSShellExecutablePathKey, __kLSSystemProcessASNKey,
__kLSUIDsInSessionKey, __kLSUIPresentationModeAllHiddenValue,
__kLSUIPresentationModeAllSuppressedValue, __kLSUIPresentationModeContentHiddenValue,
__kLSUIPresentationModeContentSuppressedValue, __kLSUIPresentationModeKey,
__kLSUIPresentationModeNormalValue, __kLSUIPresentationOptionsKey,
__kLSUnhiddenApplicationCountKey, __kLSUserActivityCountKey,
__kLSVisibleApplicationCountKey, __kLSVisibleApplicationListSeedKey,
__kLSWantsToComeForwardAtRegistrationTimeKey, __kUTTypeGlyphNameKey,
__kUTTypeIconNameKey, __kUTTypeIconsKey, __kUTTypePassBundle,
__kUTTypePassData, _kLSAppleInternalLibraryBundleIdentifier,
_kLSComputerRootCanonicalName, _kLSCurrentDeviceModelCode,
_kLSDefaultLocalizedValueKey, _kLSItemContentType, _kLSItemDisplayKind,
_kLSItemDisplayName, _kLSItemExtension, _kLSItemExtensionIsHidden,
_kLSItemFileCreator, _kLSItemFileType, _kLSItemIsInvisible,
_kLSItemQuarantineProperties, _kLSItemRoleHandlerDisplayName,
_kLSLocalLibraryBundleIdentifier, _kLSMeetingRoomCanonicalName,
_kLSNetworkLibraryBundleIdentifier, _kLSNetworkRootCanonicalName,
_kLSNotificationDatabaseSeedingComplete, _kLSNotificationDatabaseSeedingStart,
_kLSNotificationSystemConfigurationChange, _kLSQuarantineAgentBundleIdentifierKey,
_kLSQuarantineAgentNameKey, _kLSQuarantineDataURLKey, _kLSQuarantineOriginURLKey,
_kLSQuarantineTimeStampKey, _kLSQuarantineTypeCalendarEventAttachment,
_kLSQuarantineTypeEmailAttachment, _kLSQuarantineTypeInstantMessageAttachment,
_kLSQuarantineTypeKey, _kLSQuarantineTypeOtherAttachment,
_kLSQuarantineTypeOtherDownload, _kLSQuarantineTypeWebDownload,
_kLSRemoteDiscRootCanonicalName, _kLSSystemLibraryBundleIdentifier,
_kLSUserLibraryBundleIdentifier, _kLSVersionNumberNull, _kUTExportedTypeDeclarationsKey,
_kUTImportedTypeDeclarationsKey, _kUTTagClassDeviceModelCode,
_kUTTagClassFilenameExtension, _kUTTagClassMIMEType, _kUTTagClassNSPboardType,
_kUTTagClassOSType, _kUTType3DContent, _kUTTypeAVIMovie, _kUTTypeAliasFile,
_kUTTypeAliasRecord, _kUTTypeAppCategory, _kUTTypeAppCategoryActionGames,
_kUTTypeAppCategoryAdventureGames, _kUTTypeAppCategoryArcadeGames,
_kUTTypeAppCategoryBoardGames, _kUTTypeAppCategoryBusiness,
_kUTTypeAppCategoryCardGames, _kUTTypeAppCategoryCasinoGames,
_kUTTypeAppCategoryDeveloperTools, _kUTTypeAppCategoryDiceGames,
_kUTTypeAppCategoryEducation, _kUTTypeAppCategoryEducationalGames,
_kUTTypeAppCategoryEntertainment, _kUTTypeAppCategoryFamilyGames,
_kUTTypeAppCategoryFinance, _kUTTypeAppCategoryGames, _kUTTypeAppCategoryGraphicsDesign,
_kUTTypeAppCategoryHealthcareFitness, _kUTTypeAppCategoryKidsGames,
_kUTTypeAppCategoryLifestyle, _kUTTypeAppCategoryMedical,
_kUTTypeAppCategoryMusic, _kUTTypeAppCategoryMusicGames, _kUTTypeAppCategoryNews,
_kUTTypeAppCategoryPhotography, _kUTTypeAppCategoryProductivity,
_kUTTypeAppCategoryPuzzleGames, _kUTTypeAppCategoryRacingGames,
_kUTTypeAppCategoryReference, _kUTTypeAppCategoryRolePlayingGames,
_kUTTypeAppCategorySimulationGames, _kUTTypeAppCategorySocialNetworking,
_kUTTypeAppCategorySports, _kUTTypeAppCategorySportsGames,
_kUTTypeAppCategoryStrategyGames, _kUTTypeAppCategoryTravel,
_kUTTypeAppCategoryTriviaGames, _kUTTypeAppCategoryUtilities,
_kUTTypeAppCategoryVideo, _kUTTypeAppCategoryWeather, _kUTTypeAppCategoryWordGames,
_kUTTypeAppleICNS, _kUTTypeAppleMac, _kUTTypeAppleProtectedMPEG4Audio,
_kUTTypeAppleProtectedMPEG4Video, _kUTTypeAppleScript, _kUTTypeApplication,
_kUTTypeApplicationBundle, _kUTTypeApplicationFile, _kUTTypeApplicationsFolder,
_kUTTypeArchive, _kUTTypeAssemblyLanguageSource, _kUTTypeAudio,
_kUTTypeAudioInterchangeFileFormat, _kUTTypeAudiovisualContent,
_kUTTypeBMP, _kUTTypeBinaryPropertyList, _kUTTypeBookmark,
_kUTTypeBundle, _kUTTypeBzip2Archive, _kUTTypeCHeader, _kUTTypeCPlusPlusHeader,
_kUTTypeCPlusPlusSource, _kUTTypeCSource, _kUTTypeCalendarEvent,
_kUTTypeCommaSeparatedText, _kUTTypeCompositeContent, _kUTTypeComputer,
_kUTTypeConformsToKey, _kUTTypeContact, _kUTTypeContent, _kUTTypeData,
_kUTTypeDatabase, _kUTTypeDelimitedText, _kUTTypeDeprecatedApplicationFile,
_kUTTypeDescriptionKey, _kUTTypeDevice, _kUTTypeDirectory,
_kUTTypeDiskImage, _kUTTypeDotMac, _kUTTypeDropFolder, _kUTTypeElectronicPublication,
_kUTTypeEmailMessage, _kUTTypeExecutable, _kUTTypeFileSharepoint,
_kUTTypeFileURL, _kUTTypeFlatRTFD, _kUTTypeFolder, _kUTTypeFont,
_kUTTypeFramework, _kUTTypeGIF, _kUTTypeGNUZipArchive, _kUTTypeGenericPC,
_kUTTypeHTML, _kUTTypeICO, _kUTTypeIconFileKey, _kUTTypeIdentifierKey,
_kUTTypeImage, _kUTTypeInkText, _kUTTypeInternetLocation,
_kUTTypeItem, _kUTTypeJPEG, _kUTTypeJPEG2000, _kUTTypeJSON,
_kUTTypeJavaArchive, _kUTTypeJavaClass, _kUTTypeJavaScript,
_kUTTypeJavaSource, _kUTTypeLibraryFolder, _kUTTypeLivePhoto,
_kUTTypeLog, _kUTTypeM3UPlaylist, _kUTTypeMIDIAudio, _kUTTypeMP3,
_kUTTypeMPEG, _kUTTypeMPEG2TransportStream, _kUTTypeMPEG2Video,
_kUTTypeMPEG4, _kUTTypeMPEG4Audio, _kUTTypeMessage, _kUTTypeMountPoint,
_kUTTypeMovie, _kUTTypeNetworkNeighborhood, _kUTTypeOSAScript,
_kUTTypeOSAScriptBundle, _kUTTypeObjectiveCPlusPlusSource,
_kUTTypeObjectiveCSource, _kUTTypePDF, _kUTTypePHPScript,
_kUTTypePICT, _kUTTypePKCS12, _kUTTypePNG, _kUTTypePackage,
_kUTTypePerlScript, _kUTTypePlainText, _kUTTypePlaylist, _kUTTypePluginBundle,
_kUTTypePresentation, _kUTTypePropertyList, _kUTTypePythonScript,
_kUTTypeQuickLookGenerator, _kUTTypeQuickTimeImage, _kUTTypeQuickTimeMovie,
_kUTTypeRTF, _kUTTypeRTFD, _kUTTypeRawImage, _kUTTypeReferenceURLKey,
_kUTTypeResolvable, _kUTTypeRubyScript, _kUTTypeScalableVectorGraphics,
_kUTTypeScript, _kUTTypeServersFolder, _kUTTypeShellScript,
_kUTTypeSourceCode, _kUTTypeSpotlightImporter, _kUTTypeSpreadsheet,
_kUTTypeSwiftSource, _kUTTypeSymLink, _kUTTypeSystemPreferencesPane,
_kUTTypeTIFF, _kUTTypeTXNTextAndMultimediaData, _kUTTypeTabSeparatedText,
_kUTTypeTagSpecificationKey, _kUTTypeText, _kUTTypeToDoItem,
_kUTTypeTraditionalMacPlainText, _kUTTypeURL, _kUTTypeURLBookmarkData,
_kUTTypeUTF16ExternalPlainText, _kUTTypeUTF16PlainText, _kUTTypeUTF8PlainText,
_kUTTypeUTF8TabSeparatedText, _kUTTypeUnixExecutable, _kUTTypeVCard,
_kUTTypeVersionKey, _kUTTypeVideo, _kUTTypeVolume, _kUTTypeWaveformAudio,
_kUTTypeWebArchive, _kUTTypeWindowsExecutable, _kUTTypeX509Certificate,
_kUTTypeXML, _kUTTypeXMLPropertyList, _kUTTypeXPCService,
_kUTTypeZipArchive ]
objc-classes: [ LSAppLink, LSAppTranslocationResult, LSApplicationExtensionRecord,
LSApplicationIdentity, LSApplicationProxy, LSApplicationRecord,
LSApplicationWorkspace, LSApplicationWorkspaceObserver, LSBundleInfoCachedValues,
LSBundleProxy, LSBundleRecord, LSBundleWrapperCreator, LSBundleWrapperStagingReceipt,
LSBundleWrapperUpdater, LSClaimBinding, LSClaimBindingConfiguration,
LSClaimRecord, LSCodeEvaluation, LSCodeEvaluationInfo, LSDatabaseContext,
LSDocumentProxy, LSEnumerator, LSExtensionPoint, LSExtensionPointRecord,
LSIconResource, LSObserver, LSOpenWithMenuConstructor, LSPlugInKitProxy,
LSPlugInQuery, LSPlugInQueryWithIdentifier, LSPlugInQueryWithQueryDictionary,
LSPlugInQueryWithURL, LSPropertyList, LSRecord, LSRecordPromise,
LSResourceProxy, LSServiceRecord, LSSpotlightAction, UTTypeRecord,
_LSApplicationState, _LSDatabase, _LSDefaults, _LSDiskUsage,
_LSDisplayNameConstructor, _LSExceptions, _LSInternetLocator,
_LSLazyPropertyList, _LSOpenConfiguration, _LSQuery, _LSQueryContext,
_LSQueryResult, _LSRecordEnumerator, _LSStringLocalizer, _LSURLOverride ]
objc-ivars: [ _LSDatabase.schema, _LSDatabase.store ]
reexports:
- targets: [ x86_64-maccatalyst, x86_64-macos, arm64e-maccatalyst, arm64e-macos,
arm64-macos, arm64-maccatalyst ]
objc-classes: [ NSUserActivity ]
...
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/LaunchServices.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/LaunchServices.framework/Headers/IconsCore.h | /*
File: IconsCore.h
Contains: Icon Utilities and Icon Services Interfaces.
Copyright: (c) 2003-2012 by Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __ICONSCORE__
#define __ICONSCORE__
#ifndef __CARBONCORE__
#include <CarbonCore/CarbonCore.h>
#endif
#ifndef __OSSERVICES__
#include <OSServices/OSServices.h>
#endif
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
/* The following are icons for which there are both icon suites and SICNs. */
/* Avoid using icon resources if possible. Use IconServices instead. */
enum {
kGenericDocumentIconResource = -4000,
kGenericStationeryIconResource = -3985,
kGenericEditionFileIconResource = -3989,
kGenericApplicationIconResource = -3996,
kGenericDeskAccessoryIconResource = -3991,
kGenericFolderIconResource = -3999,
kPrivateFolderIconResource = -3994,
kFloppyIconResource = -3998,
kTrashIconResource = -3993,
kGenericRAMDiskIconResource = -3988,
kGenericCDROMIconResource = -3987
};
/* The following are icons for which there are SICNs only. */
/* Avoid using icon resources if possible. Use IconServices instead. */
enum {
kDesktopIconResource = -3992,
kOpenFolderIconResource = -3997,
kGenericHardDiskIconResource = -3995,
kGenericFileServerIconResource = -3972,
kGenericSuitcaseIconResource = -3970,
kGenericMoverObjectIconResource = -3969
};
/* The following are icons for which there are icon suites only. */
/* Avoid using icon resources if possible. Use IconServices instead. */
enum {
kGenericPreferencesIconResource = -3971,
kGenericQueryDocumentIconResource = -16506,
kGenericExtensionIconResource = -16415,
kSystemFolderIconResource = -3983,
kHelpIconResource = -20271,
kAppleMenuFolderIconResource = -3982
};
/* Obsolete. Use named constants defined above. */
enum {
genericDocumentIconResource = kGenericDocumentIconResource,
genericStationeryIconResource = kGenericStationeryIconResource,
genericEditionFileIconResource = kGenericEditionFileIconResource,
genericApplicationIconResource = kGenericApplicationIconResource,
genericDeskAccessoryIconResource = kGenericDeskAccessoryIconResource,
genericFolderIconResource = kGenericFolderIconResource,
privateFolderIconResource = kPrivateFolderIconResource,
floppyIconResource = kFloppyIconResource,
trashIconResource = kTrashIconResource,
genericRAMDiskIconResource = kGenericRAMDiskIconResource,
genericCDROMIconResource = kGenericCDROMIconResource,
desktopIconResource = kDesktopIconResource,
openFolderIconResource = kOpenFolderIconResource,
genericHardDiskIconResource = kGenericHardDiskIconResource,
genericFileServerIconResource = kGenericFileServerIconResource,
genericSuitcaseIconResource = kGenericSuitcaseIconResource,
genericMoverObjectIconResource = kGenericMoverObjectIconResource,
genericPreferencesIconResource = kGenericPreferencesIconResource,
genericQueryDocumentIconResource = kGenericQueryDocumentIconResource,
genericExtensionIconResource = kGenericExtensionIconResource,
systemFolderIconResource = kSystemFolderIconResource,
appleMenuFolderIconResource = kAppleMenuFolderIconResource
};
/* Avoid using icon resources if possible. Use IconServices instead. */
enum {
kStartupFolderIconResource = -3981,
kOwnedFolderIconResource = -3980,
kDropFolderIconResource = -3979,
kSharedFolderIconResource = -3978,
kMountedFolderIconResource = -3977,
kControlPanelFolderIconResource = -3976,
kPrintMonitorFolderIconResource = -3975,
kPreferencesFolderIconResource = -3974,
kExtensionsFolderIconResource = -3973,
kFontsFolderIconResource = -3968,
kFullTrashIconResource = -3984
};
/* Obsolete. Use named constants defined above. */
enum {
startupFolderIconResource = kStartupFolderIconResource,
ownedFolderIconResource = kOwnedFolderIconResource,
dropFolderIconResource = kDropFolderIconResource,
sharedFolderIconResource = kSharedFolderIconResource,
mountedFolderIconResource = kMountedFolderIconResource,
controlPanelFolderIconResource = kControlPanelFolderIconResource,
printMonitorFolderIconResource = kPrintMonitorFolderIconResource,
preferencesFolderIconResource = kPreferencesFolderIconResource,
extensionsFolderIconResource = kExtensionsFolderIconResource,
fontsFolderIconResource = kFontsFolderIconResource,
fullTrashIconResource = kFullTrashIconResource
};
/* IconRefs identify cached icon data. IconRef 0 is invalid.*/
typedef struct OpaqueIconRef* IconRef;
/*
IconServices is an efficient mechanism to share icon data amongst multiple
clients. It avoids duplication of data; it provides efficient caching,
releasing memory when the icon data is no longer needed; it can provide
the appropriate icon for any filesystem object; it can provide commonly
used icons (caution, note, help...); it is Appearance-savvy: the icons
are switched when appropriate.
IconServices refer to cached icon data using IconRef, a 32-bit opaque
value. IconRefs are reference counted. When there are no more "owners"
of an IconRef, the memory used by the icon bitmap is disposed of.
Two files of same type and creator with no custom icon will have the same IconRef.
Files with custom icons will have their own IconRef.
*/
/*
Use the special creator kSystemIconsCreator to get "standard" icons
that are not associated with a file, such as the help icon.
Note that all lowercase creators are reserved by Apple.
*/
enum {
kSystemIconsCreator = 'macs'
};
/*
Type of the predefined/generic icons. For example, the call:
err = GetIconRef(kOnSystemDisk, kSystemIconsCreator, kHelpIcon, &iconRef);
will retun in iconRef the IconRef for the standard help icon.
*/
/* Generic Finder icons */
enum {
kClipboardIcon = 'CLIP',
kClippingUnknownTypeIcon = 'clpu',
kClippingPictureTypeIcon = 'clpp',
kClippingTextTypeIcon = 'clpt',
kClippingSoundTypeIcon = 'clps',
kDesktopIcon = 'desk',
kFinderIcon = 'FNDR',
kComputerIcon = 'root',
kFontSuitcaseIcon = 'FFIL',
kFullTrashIcon = 'ftrh',
kGenericApplicationIcon = 'APPL',
kGenericCDROMIcon = 'cddr',
kGenericControlPanelIcon = 'APPC',
kGenericControlStripModuleIcon = 'sdev',
kGenericComponentIcon = 'thng',
kGenericDeskAccessoryIcon = 'APPD',
kGenericDocumentIcon = 'docu',
kGenericEditionFileIcon = 'edtf',
kGenericExtensionIcon = 'INIT',
kGenericFileServerIcon = 'srvr',
kGenericFontIcon = 'ffil',
kGenericFontScalerIcon = 'sclr',
kGenericFloppyIcon = 'flpy',
kGenericHardDiskIcon = 'hdsk',
kGenericIDiskIcon = 'idsk',
kGenericRemovableMediaIcon = 'rmov',
kGenericMoverObjectIcon = 'movr',
kGenericPCCardIcon = 'pcmc',
kGenericPreferencesIcon = 'pref',
kGenericQueryDocumentIcon = 'qery',
kGenericRAMDiskIcon = 'ramd',
kGenericSharedLibaryIcon = 'shlb',
kGenericStationeryIcon = 'sdoc',
kGenericSuitcaseIcon = 'suit',
kGenericURLIcon = 'gurl',
kGenericWORMIcon = 'worm',
kInternationalResourcesIcon = 'ifil',
kKeyboardLayoutIcon = 'kfil',
kSoundFileIcon = 'sfil',
kSystemSuitcaseIcon = 'zsys',
kTrashIcon = 'trsh',
kTrueTypeFontIcon = 'tfil',
kTrueTypeFlatFontIcon = 'sfnt',
kTrueTypeMultiFlatFontIcon = 'ttcf',
kUserIDiskIcon = 'udsk',
kUnknownFSObjectIcon = 'unfs',
kInternationResourcesIcon = kInternationalResourcesIcon /* old name*/
};
/* Internet locations */
enum {
kInternetLocationHTTPIcon = 'ilht',
kInternetLocationFTPIcon = 'ilft',
kInternetLocationAppleShareIcon = 'ilaf',
kInternetLocationAppleTalkZoneIcon = 'ilat',
kInternetLocationFileIcon = 'ilfi',
kInternetLocationMailIcon = 'ilma',
kInternetLocationNewsIcon = 'ilnw',
kInternetLocationNSLNeighborhoodIcon = 'ilns',
kInternetLocationGenericIcon = 'ilge'
};
/* Folders */
enum {
kGenericFolderIcon = 'fldr',
kDropFolderIcon = 'dbox',
kMountedFolderIcon = 'mntd',
kOpenFolderIcon = 'ofld',
kOwnedFolderIcon = 'ownd',
kPrivateFolderIcon = 'prvf',
kSharedFolderIcon = 'shfl'
};
/* Sharing Privileges icons */
enum {
kSharingPrivsNotApplicableIcon = 'shna',
kSharingPrivsReadOnlyIcon = 'shro',
kSharingPrivsReadWriteIcon = 'shrw',
kSharingPrivsUnknownIcon = 'shuk',
kSharingPrivsWritableIcon = 'writ'
};
/* Users and Groups icons */
enum {
kUserFolderIcon = 'ufld',
kWorkgroupFolderIcon = 'wfld',
kGuestUserIcon = 'gusr',
kUserIcon = 'user',
kOwnerIcon = 'susr',
kGroupIcon = 'grup'
};
/* Special folders */
enum {
kAppearanceFolderIcon = 'appr',
kAppleExtrasFolderIcon = 0x616578C4/*'aexƒ'*/,
kAppleMenuFolderIcon = 'amnu',
kApplicationsFolderIcon = 'apps',
kApplicationSupportFolderIcon = 'asup',
kAssistantsFolderIcon = 0x617374C4/*'astƒ'*/,
kColorSyncFolderIcon = 'prof',
kContextualMenuItemsFolderIcon = 'cmnu',
kControlPanelDisabledFolderIcon = 'ctrD',
kControlPanelFolderIcon = 'ctrl',
kControlStripModulesFolderIcon = 0x736476C4/*'sdvƒ'*/,
kDocumentsFolderIcon = 'docs',
kExtensionsDisabledFolderIcon = 'extD',
kExtensionsFolderIcon = 'extn',
kFavoritesFolderIcon = 'favs',
kFontsFolderIcon = 'font',
kHelpFolderIcon = (int)0xC4686C70/*'ƒhlp' */,
kInternetFolderIcon = 0x696E74C4/*'intƒ'*/,
kInternetPlugInFolderIcon = (int)0xC46E6574/*'ƒnet' */,
kInternetSearchSitesFolderIcon = 'issf',
kLocalesFolderIcon = (int)0xC46C6F63/*'ƒloc' */,
kMacOSReadMeFolderIcon = 0x6D6F72C4/*'morƒ'*/,
kPublicFolderIcon = 'pubf',
kPreferencesFolderIcon = 0x707266C4/*'prfƒ'*/,
kPrinterDescriptionFolderIcon = 'ppdf',
kPrinterDriverFolderIcon = (int)0xC4707264/*'ƒprd' */,
kPrintMonitorFolderIcon = 'prnt',
kRecentApplicationsFolderIcon = 'rapp',
kRecentDocumentsFolderIcon = 'rdoc',
kRecentServersFolderIcon = 'rsrv',
kScriptingAdditionsFolderIcon = (int)0xC4736372/*'ƒscr' */,
kSharedLibrariesFolderIcon = (int)0xC46C6962/*'ƒlib' */,
kScriptsFolderIcon = 0x736372C4/*'scrƒ'*/,
kShutdownItemsDisabledFolderIcon = 'shdD',
kShutdownItemsFolderIcon = 'shdf',
kSpeakableItemsFolder = 'spki',
kStartupItemsDisabledFolderIcon = 'strD',
kStartupItemsFolderIcon = 'strt',
kSystemExtensionDisabledFolderIcon = 'macD',
kSystemFolderIcon = 'macs',
kTextEncodingsFolderIcon = (int)0xC4746578/*'ƒtex' */,
kUsersFolderIcon = 0x757372C4/*'usrƒ'*/,
kUtilitiesFolderIcon = 0x757469C4/*'utiƒ'*/,
kVoicesFolderIcon = 'fvoc'
};
/* Badges */
enum {
kAppleScriptBadgeIcon = 'scrp',
kLockedBadgeIcon = 'lbdg',
kMountedBadgeIcon = 'mbdg',
kSharedBadgeIcon = 'sbdg',
kAliasBadgeIcon = 'abdg',
kAlertCautionBadgeIcon = 'cbdg'
};
/* Alert icons */
enum {
kAlertNoteIcon = 'note',
kAlertCautionIcon = 'caut',
kAlertStopIcon = 'stop'
};
/* Networking icons */
enum {
kAppleTalkIcon = 'atlk',
kAppleTalkZoneIcon = 'atzn',
kAFPServerIcon = 'afps',
kFTPServerIcon = 'ftps',
kHTTPServerIcon = 'htps',
kGenericNetworkIcon = 'gnet',
kIPFileServerIcon = 'isrv'
};
/* Toolbar icons */
enum {
kToolbarCustomizeIcon = 'tcus',
kToolbarDeleteIcon = 'tdel',
kToolbarFavoritesIcon = 'tfav',
kToolbarHomeIcon = 'thom',
kToolbarAdvancedIcon = 'tbav',
kToolbarInfoIcon = 'tbin',
kToolbarLabelsIcon = 'tblb',
kToolbarApplicationsFolderIcon = 'tAps',
kToolbarDocumentsFolderIcon = 'tDoc',
kToolbarMovieFolderIcon = 'tMov',
kToolbarMusicFolderIcon = 'tMus',
kToolbarPicturesFolderIcon = 'tPic',
kToolbarPublicFolderIcon = 'tPub',
kToolbarDesktopFolderIcon = 'tDsk',
kToolbarDownloadsFolderIcon = 'tDwn',
kToolbarLibraryFolderIcon = 'tLib',
kToolbarUtilitiesFolderIcon = 'tUtl',
kToolbarSitesFolderIcon = 'tSts'
};
/* Other icons */
enum {
kAppleLogoIcon = 'capl',
kAppleMenuIcon = 'sapl',
kBackwardArrowIcon = 'baro',
kFavoriteItemsIcon = 'favr',
kForwardArrowIcon = 'faro',
kGridIcon = 'grid',
kHelpIcon = 'help',
kKeepArrangedIcon = 'arng',
kLockedIcon = 'lock',
kNoFilesIcon = 'nfil',
kNoFolderIcon = 'nfld',
kNoWriteIcon = 'nwrt',
kProtectedApplicationFolderIcon = 'papp',
kProtectedSystemFolderIcon = 'psys',
kRecentItemsIcon = 'rcnt',
kShortcutIcon = 'shrt',
kSortAscendingIcon = 'asnd',
kSortDescendingIcon = 'dsnd',
kUnlockedIcon = 'ulck',
kConnectToIcon = 'cnct',
kGenericWindowIcon = 'gwin',
kQuestionMarkIcon = 'ques',
kDeleteAliasIcon = 'dali',
kEjectMediaIcon = 'ejec',
kBurningIcon = 'burn',
kRightContainerArrowIcon = 'rcar'
};
/* IconServicesUsageFlags */
typedef UInt32 IconServicesUsageFlags;
enum {
kIconServicesNormalUsageFlag = 0x00000000,
kIconServicesNoBadgeFlag = 0x00000001, /* available on Panther and later */
kIconServicesUpdateIfNeededFlag = 0x00000002 /* available on Panther and later */
};
/*
kIconServicesCatalogInfoMask - Minimal bitmask for use with
GetIconRefFromFileInfo(). Use this mask with FSGetCatalogInfo
before calling GetIconRefFromFileInfo(). Please note kFSCatInfoFinderXInfo flag is
valid only on MacOS X and must be cleared from CatalogInfoMask before
passing to GetIconRefFromFileInfo while running under MacOS 9 (or error will be returned)
*/
enum {
kIconServicesCatalogInfoMask = (kFSCatInfoNodeID | kFSCatInfoParentDirID | kFSCatInfoVolume | kFSCatInfoNodeFlags | kFSCatInfoFinderInfo | kFSCatInfoFinderXInfo | kFSCatInfoUserAccess | kFSCatInfoPermissions | kFSCatInfoContentMod)
};
/*
==============================================================================
Reference counting
==============================================================================
*/
/*
GetIconRefOwners
This routine returns the reference count for the IconRef, or number of owners.
A valid IconRef always has at least one owner.
*/
/*
* GetIconRefOwners()
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in IconServicesLib 8.5 and later
*/
extern OSErr
GetIconRefOwners(
IconRef theIconRef,
UInt16 * owners) API_DEPRECATED( "This function is no longer supported. Use NSWorkspace and NSImage to get icons.", macos( 10.0, 10.15 ) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
AcquireIconRef
This routine increments the reference count for the IconRef
*/
/*
* AcquireIconRef()
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in IconServicesLib 8.5 and later
*/
extern OSErr
AcquireIconRef(IconRef theIconRef) API_DEPRECATED( "This function is no longer supported. Use NSWorkspace and NSImage to get icons.", macos( 10.0, 10.15 ) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
ReleaseIconRef
This routine decrements the reference count for the IconRef.
When the reference count reaches 0, all memory allocated for the icon
is disposed. Any subsequent use of the IconRef is invalid.
*/
/*
* ReleaseIconRef()
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in IconServicesLib 8.5 and later
*/
extern OSErr
ReleaseIconRef(IconRef theIconRef) API_DEPRECATED( "This function is no longer supported. Use NSWorkspace and NSImage to get icons.", macos( 10.0, 10.15 ) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
==============================================================================
Getting an IconRef
==============================================================================
*/
/*
GetIconRef
This routine returns an icon ref for an icon in the desktop database or
for a registered icon.
The system registers a set of icon such as the help icon with the creator
code kSystemIconsCreator. See above for a list of the registered system types.
The vRefNum is used as a hint on where to look for the icon first. Use
kOnSystemDisk if you don't know what to pass.
This routine increments the reference count of the returned IconRef. Call
ReleaseIconRef() when you're done with it.
*/
/*
* GetIconRef()
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in IconServicesLib 8.5 and later
*/
extern OSErr
GetIconRef(
SInt16 vRefNum,
OSType creator,
OSType iconType,
IconRef * theIconRef) API_DEPRECATED( "Use -[NSWorkspace iconForFile:] instead.", macos( 10.0, 10.15 ) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
GetIconRefFromFolder
This routine returns an icon ref for a folder with no custom icon.
Use the more generic, but slightly slower, GetIconRefFromFile() if
you don't already have the necessary info about the file.
Attributes should be CInfoPBRec.dirInfo.ioFlAttrib for this folder.
Access privileges should be CInfoPBRec.dirInfo.ioACUser for this folder.
This routine increments the reference count of the IconRef. Call ReleaseIconRef()
when you're done with it.
*/
/*
* GetIconRefFromFolder()
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in IconServicesLib 8.5 and later
*/
extern OSErr
GetIconRefFromFolder(
SInt16 vRefNum,
SInt32 parentFolderID,
SInt32 folderID,
SInt8 attributes,
SInt8 accessPrivileges,
IconRef * theIconRef) API_DEPRECATED( "Use -[NSWorkspace iconForFile:] instead.", macos( 10.0, 10.15 ) ) API_UNAVAILABLE( ios, tvos, watchos );
/* GetIconRefFromFileInfo*/
/*
* GetIconRefFromFileInfo()
*
* Summary:
* This routine returns an IconRef for a file with minimal file I/O.
*
* Discussion:
* To minimize file operations, FSGetCatalogInfo should be called
* prior to calling this routine. The FSCatalogInfo should
* correspond to kIconServicesCatalogInfoMask The name should be
* fetched and passed in. If either the name or the correct catalog
* info is not passed in, this routine will do file operations for
* this information instead.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* inRef:
* An FSRef for the target file
*
* inFileNameLength:
* The length of the name of the target file
*
* inFileName:
* The name of the target file
*
* inWhichInfo:
* The mask of file info already acquired.
*
* inCatalogInfo:
* The catalog info already acquired.
*
* inUsageFlags:
* The usage flags for this call (use
* kIconServicesNormalUsageFlag).
*
* outIconRef:
* The output IconRef for the routine.
*
* outLabel:
* The output label for the icon/file.
*
* Availability:
* Mac OS X: in version 10.1 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x, is available on Mac OS X version 10.1 and later
* Non-Carbon CFM: not available
*/
extern OSStatus
GetIconRefFromFileInfo(
const FSRef * inRef,
UniCharCount inFileNameLength,
const UniChar * inFileName, /* can be NULL */
FSCatalogInfoBitmap inWhichInfo,
const FSCatalogInfo * inCatalogInfo, /* can be NULL */
IconServicesUsageFlags inUsageFlags,
IconRef * outIconRef,
SInt16 * outLabel) /* can be NULL */ API_DEPRECATED("Use -[NSWorkspace iconForFile:] instead.", macos(10.1,10.13) ) API_UNAVAILABLE( ios, tvos, watchos );
/* GetIconRefFromTypeInfo*/
/*
* GetIconRefFromTypeInfo()
*
* Summary:
* Create an IconRef for a type information.
*
* Discussion:
* Creates IconRef based on provided type info. Any of the input
* parameters can be zero (meaning it is unknown). Returns generic
* document icon in case if all parameters are zeroes. Calling the
* routine with non zero inCreator and inType and zero inExtension
* and inMIMEType is equivalent to GetIconRef(kOnSystemDisk,
* inCreator, inType).
*
* Mac OS X threading:
* Not thread safe
*
* Parameters:
*
* inCreator:
* The creator.
*
* inType:
* The type.
*
* inExtension:
* The extension.
*
* inMIMEType:
* The MIME type.
*
* inUsageFlags:
* The usage flags for this call (use
* kIconServicesNormalUsageFlag).
*
* outIconRef:
* The output IconRef for the routine.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x, is available on Mac OS X version 10.3 and later
* Non-Carbon CFM: not available
*/
extern OSErr
GetIconRefFromTypeInfo(
OSType inCreator,
OSType inType,
CFStringRef inExtension,
CFStringRef inMIMEType,
IconServicesUsageFlags inUsageFlags,
IconRef * outIconRef) API_DEPRECATED( "Use -[NSWorkspace iconForFileType:] instead.", macos( 10.3, 10.15 ) ) API_UNAVAILABLE( ios, tvos, watchos );
/* GetIconRefFromIconFamilyPtr*/
/*
* GetIconRefFromIconFamilyPtr()
*
* Summary:
* Create an IconRef for the IconFamilyPtr.
*
* Discussion:
* This routine creates IconRef for the IconFamilyPtr.
*
* Mac OS X threading:
* Not thread safe
*
* Parameters:
*
* inIconFamilyPtr:
* The icon data
*
* inSize:
* The icon data size
*
* outIconRef:
* The output IconRef for the routine.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x, is available on Mac OS X version 10.3 and later
* Non-Carbon CFM: not available
*/
extern OSStatus
GetIconRefFromIconFamilyPtr(
const IconFamilyResource * inIconFamilyPtr,
Size inSize,
IconRef * outIconRef) API_DEPRECATED( "This function is no longer supported. Use NSWorkspace and NSImage to get icons.", macos( 10.3, 10.15 ) ) API_UNAVAILABLE( ios, tvos, watchos );
/* GetIconRefFromComponent*/
/*
* GetIconRefFromComponent()
*
* Summary:
* Create an IconRef for the component.
*
* Discussion:
* Creates IconRef based on componentIconFamily field of component's
* 'thng' resource.. This routine increments the reference count of
* the IconRef. Call ReleaseIconRef() when you're done with it.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* inComponent:
* A component identifier.
*
* outIconRef:
* The output IconRef for the routine.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x, is available on Mac OS X version 10.5 and later
* Non-Carbon CFM: not available
*/
extern OSStatus
GetIconRefFromComponent(
Component inComponent,
IconRef * outIconRef) API_DEPRECATED( "This function is no longer supported. Use NSWorkspace and NSImage to get icons.", macos( 10.5, 10.15 ) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
==============================================================================
Adding and modifying IconRef
==============================================================================
*/
/*
RegisterIconRefFromIconFamily
This routine adds a new entry to the IconRef registry. Other clients will be
able to access it using the (creator, iconType) pair specified here.
Lower-case creators are reserved for the system.
The iconFamily data is copied and the caller is reponsible for disposing of it.
This routine increments the reference count of the IconRef. Call ReleaseIconRef()
when you're done with it.
*/
/*
* RegisterIconRefFromIconFamily()
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in IconServicesLib 8.5 and later
*/
extern OSErr
RegisterIconRefFromIconFamily(
OSType creator,
OSType iconType,
IconFamilyHandle iconFamily,
IconRef * theIconRef) API_DEPRECATED( "This function is no longer supported. Use NSWorkspace and NSImage to get icons.", macos( 10.0, 10.15 ) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* RegisterIconRefFromFSRef()
*
* Discussion:
* This routine registers an IconRef from a ".icns" file and
* associates it with a creator/type pair.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* creator:
* The creator code for the icns file.
*
* iconType:
* The type code for the icns file
*
* iconFile:
* The FSRef of the icns file.
*
* theIconRef:
* The output IconRef for the routine.
*
* Availability:
* Mac OS X: in version 10.1 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x, is available on Mac OS X version 10.1 and later
* Non-Carbon CFM: not available
*/
extern OSStatus
RegisterIconRefFromFSRef(
OSType creator,
OSType iconType,
const FSRef * iconFile,
IconRef * theIconRef) API_DEPRECATED("You do not need to register .icns files to use them with -[NSImage initWithContentsOfURL:].", macos(10.1,10.13) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
UnregisterIconRef
Removes the specified icon from the icon cache (if there are no users of it).
If some clients are using this iconRef, then the IconRef will be removed when the
last user calls ReleaseIconRef.
*/
/*
* UnregisterIconRef()
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in IconServicesLib 8.5 and later
*/
extern OSErr
UnregisterIconRef(
OSType creator,
OSType iconType) API_DEPRECATED("You do not need to unregister icons.", macos(10.0,10.13) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
UpdateIconRef
Call this routine to force an update of the data for iconRef.
For example after changing an icon in the desktop database or changing the custom
icon of a file. Note that after _adding_ a custom icon to file or folder, you
need to call GetIconRefFromFile() to get a new IconRef specific to this file.
This routine does nothing if the IconRef is a registered icon.
*/
/*
* UpdateIconRef()
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in IconServicesLib 8.5 and later
*/
extern OSErr
UpdateIconRef(IconRef theIconRef) API_DEPRECATED( "This function is no longer supported. Use NSWorkspace and NSImage to get icons.", macos( 10.0, 10.15 ) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
OverrideIconRef
This routines replaces the bitmaps of the specified IconRef with the ones
from the new IconRef.
*/
/*
* OverrideIconRef()
*
* Mac OS X threading:
* Not thread safe
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in IconServicesLib 8.5 and later
*/
extern OSErr
OverrideIconRef(
IconRef oldIconRef,
IconRef newIconRef) API_DEPRECATED( "This function is no longer supported. Use NSWorkspace and NSImage to get icons.", macos( 10.0, 10.15 ) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
RemoveIconRefOverride
This routine remove an override if one was applied to the icon and
reverts back to the original bitmap data.
*/
/*
* RemoveIconRefOverride()
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in IconServicesLib 8.5 and later
*/
extern OSErr
RemoveIconRefOverride(IconRef theIconRef) API_DEPRECATED( "This function is no longer supported. Use NSWorkspace and NSImage to get icons.", macos( 10.0, 10.15 ) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
==============================================================================
Creating composite IconRef
==============================================================================
*/
/*
CompositeIconRef
Superimposes an IconRef on top of another one
*/
/*
* CompositeIconRef()
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in IconServicesLib 8.5 and later
*/
extern OSErr
CompositeIconRef(
IconRef backgroundIconRef,
IconRef foregroundIconRef,
IconRef * compositeIconRef) API_DEPRECATED( "Use NSImage or Core Graphics to composite images.", macos( 10.0, 10.15 ) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
IsIconRefComposite
Indicates if a given icon ref is a composite of two other icon refs (and which ones)
If it isn't a composite, backgroundIconRef and foreGroundIconRef will be 0.
*/
/*
* IsIconRefComposite()
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in IconServicesLib 8.5 and later
*/
extern OSErr
IsIconRefComposite(
IconRef compositeIconRef,
IconRef * backgroundIconRef,
IconRef * foregroundIconRef) API_DEPRECATED( "Use NSImage or Core Graphics to composite images.", macos( 10.0, 10.15 ) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
==============================================================================
Using IconRef
==============================================================================
*/
/*
IsValidIconRef
Return true if the iconRef passed in is a valid icon ref
*/
/*
* IsValidIconRef()
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in IconServicesLib 8.5 and later
*/
extern Boolean
IsValidIconRef(IconRef theIconRef) API_DEPRECATED( "This function is no longer supported. Use NSWorkspace and NSImage to get icons.", macos( 10.0, 10.15 ) ) API_UNAVAILABLE( ios, tvos, watchos );
/* IsDataAvailableInIconRef*/
/*
* IsDataAvailableInIconRef()
*
* Summary:
* Check if IconRef has specific data.
*
* Discussion:
* This routine returns true if inIconKind icon data is availabe or
* can be created.
*
* Mac OS X threading:
* Thread safe since version 10.4
*
* Parameters:
*
* inIconKind:
* The icon data kind
*
* inIconRef:
* The IconRef to test.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x, is available on Mac OS X version 10.3 and later
* Non-Carbon CFM: not available
*/
extern Boolean
IsDataAvailableInIconRef(
OSType inIconKind,
IconRef inIconRef) API_DEPRECATED( "This function is no longer supported. Use NSWorkspace and NSImage to get icons.", macos( 10.3, 10.15 ) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
==============================================================================
Flushing IconRef data
==============================================================================
*/
/*
SetCustomIconsEnabled
Enable or disable custom icons on the specified volume.
*/
/*
* SetCustomIconsEnabled()
*
* Mac OS X threading:
* Not thread safe
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in IconServicesLib 8.5 and later
*/
extern OSErr
SetCustomIconsEnabled(
SInt16 vRefNum,
Boolean enableCustomIcons) API_DEPRECATED( "This function is no longer supported. Use NSWorkspace and NSImage to get icons.", macos( 10.0, 10.15 ) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
GetCustomIconsEnabled
Return true if custom icons are enabled on the specified volume, false otherwise.
*/
/*
* GetCustomIconsEnabled()
*
* Mac OS X threading:
* Not thread safe
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: in CarbonLib 1.0 and later
* Non-Carbon CFM: in IconServicesLib 8.5 and later
*/
extern OSErr
GetCustomIconsEnabled(
SInt16 vRefNum,
Boolean * customIconsEnabled) API_DEPRECATED( "This function is no longer supported. Use NSWorkspace and NSImage to get icons.", macos( 10.0, 10.15 ) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
==============================================================================
Icon files (.icns files)
==============================================================================
*/
/*
* ReadIconFromFSRef()
*
* Discussion:
* This routine reads an icon (icns) file into memory.
*
* Mac OS X threading:
* Not thread safe
*
* Parameters:
*
* ref:
* The FSRef for the icon file.
*
* iconFamily:
* The handle for the icon family.
*
* Availability:
* Mac OS X: in version 10.1 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x, is available on Mac OS X version 10.1 and later
* Non-Carbon CFM: not available
*/
extern OSStatus
ReadIconFromFSRef(
const FSRef * ref,
IconFamilyHandle * iconFamily) API_DEPRECATED("Use -[NSWorkspace iconForFile:] instead.", macos(10.1,10.13) ) API_UNAVAILABLE( ios, tvos, watchos );
#ifdef __cplusplus
}
#endif
#endif /* __ICONSCORE__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/LaunchServices.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/LaunchServices.framework/Headers/LSInfoDeprecated.h | /*
File: LSInfoDeprecated.h
Contains: Deprecated interfaces for LaunchServices.framework
Copyright: (c) 2001-2015 by Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __LSINFODEPRECATED__
#define __LSINFODEPRECATED__
#include <LaunchServices/LSInfo.h>
#ifdef __cplusplus
extern "C" {
#endif
#pragma pack(push, 2)
typedef CF_OPTIONS(OptionBits, LSRequestedInfo) {
kLSRequestExtension __OS_AVAILABILITY_MSG(macosx, deprecated=10.11, "Use CFURLCopyPathExtension(), -[NSURL pathExtension], or -[NSString pathExtension] instead.") = 0x00000001, /* thread-safe in 10.0*/
kLSRequestTypeCreator __OS_AVAILABILITY_MSG(macosx, deprecated=10.11, "Creator codes are deprecated on OS X.") = 0x00000002, /* thread-safe in 10.0*/
kLSRequestBasicFlagsOnly __OS_AVAILABILITY_MSG(macosx, deprecated=10.11, "Use CFURLCopyResourcePropertiesForKeys or -[NSURL resourceValuesForKeys:error:] instead.") = 0x00000004, /* thread-safe in 10.2*/
kLSRequestAppTypeFlags __OS_AVAILABILITY_MSG(macosx, deprecated=10.11, "Use CFURLCopyResourcePropertiesForKeys or -[NSURL resourceValuesForKeys:error:] instead.") = 0x00000008, /* thread-safe in 10.2*/
kLSRequestAllFlags __OS_AVAILABILITY_MSG(macosx, deprecated=10.11, "Use CFURLCopyResourcePropertiesForKeys or -[NSURL resourceValuesForKeys:error:] instead.") = 0x00000010, /* thread-safe in 10.2*/
kLSRequestIconAndKind __OS_AVAILABILITY_MSG(macosx, deprecated=10.11, "Use CFURLCopyResourcePropertiesForKeys or -[NSURL resourceValuesForKeys:error:] instead.") = 0x00000020, /* thread-safe in 10.2*/
kLSRequestExtensionFlagsOnly __OS_AVAILABILITY_MSG(macosx, deprecated=10.11, "Use CFURLCopyResourcePropertiesForKeys or -[NSURL resourceValuesForKeys:error:] instead.") = 0x00000040, /* thread-safe in 10.0*/
kLSRequestAllInfo __OS_AVAILABILITY_MSG(macosx, deprecated=10.11, "Use CFURLCopyResourcePropertiesForKeys or -[NSURL resourceValuesForKeys:error:] instead.") = (UInt32)0xFFFFFFFF /* thread-safe in 10.2*/
};
typedef CF_OPTIONS(OptionBits, LSItemInfoFlags) {
kLSItemInfoIsPlainFile __OS_AVAILABILITY_MSG(macosx, deprecated=10.11, "Use the URL resource property kCFURLIsRegularFileKey or NSURLIsRegularFileKey instead.") = 0x00000001, /* Not a directory, volume, or symlink*/
kLSItemInfoIsPackage __OS_AVAILABILITY_MSG(macosx, deprecated=10.11, "Use the URL resource property kCFURLIsPackageKey or NSURLIsPackageKey instead.") = 0x00000002, /* Packaged directory*/
kLSItemInfoIsApplication __OS_AVAILABILITY_MSG(macosx, deprecated=10.11, "Use the URL resource property kCFURLIsApplicationKey or NSURLIsApplicationKey instead.") = 0x00000004, /* Single-file or packaged application*/
kLSItemInfoIsContainer __OS_AVAILABILITY_MSG(macosx, deprecated=10.11, "Use the URL resource property kCFURLIsDirectoryKey or NSURLIsDirectoryKey instead.") = 0x00000008, /* Directory (includes packages) or volume*/
kLSItemInfoIsAliasFile __OS_AVAILABILITY_MSG(macosx, deprecated=10.11, "Use the URL resource property kCFURLIsAliasFileKey or NSURLIsAliasFileKey instead.") = 0x00000010, /* Alias file (includes sym links)*/
kLSItemInfoIsSymlink __OS_AVAILABILITY_MSG(macosx, deprecated=10.11, "Use the URL resource property kCFURLIsSymbolicLinkKey or NSURLIsSymbolicLinkKey.") = 0x00000020, /* UNIX sym link*/
kLSItemInfoIsInvisible __OS_AVAILABILITY_MSG(macosx, deprecated=10.11, "Use the URL resource property kCFURLIsHiddenKey or NSURLIsHiddenKey instead.") = 0x00000040, /* Invisible by any known mechanism*/
kLSItemInfoIsNativeApp __OS_AVAILABILITY_MSG(macosx, deprecated=10.11, "The Classic environment is no longer supported.") = 0x00000080, /* Carbon or Cocoa native app*/
kLSItemInfoIsClassicApp __OS_AVAILABILITY_MSG(macosx, deprecated=10.11, "The Classic environment is no longer supported.") = 0x00000100, /* CFM/68K Classic app*/
kLSItemInfoAppPrefersNative __OS_AVAILABILITY_MSG(macosx, deprecated=10.11, "The Classic environment is no longer supported.") = 0x00000200, /* Carbon app that prefers to be launched natively*/
kLSItemInfoAppPrefersClassic __OS_AVAILABILITY_MSG(macosx, deprecated=10.11, "The Classic environment is no longer supported.") = 0x00000400, /* Carbon app that prefers to be launched in Classic*/
kLSItemInfoAppIsScriptable __OS_AVAILABILITY_MSG(macosx, deprecated=10.11, "Use the URL resource property kCFURLApplicationIsScriptableKey or NSURLApplicationIsScriptableKey instead.") = 0x00000800, /* App can be scripted*/
kLSItemInfoIsVolume __OS_AVAILABILITY_MSG(macosx, deprecated=10.11, "Use the URL resource property kCFURLIsVolumeKey or NSURLIsVolumeKey instead.") = 0x00001000, /* Item is a volume*/
kLSItemInfoExtensionIsHidden __OS_AVAILABILITY_MSG(macosx, deprecated=10.11, "Use the URL resource property kCFURLHasHiddenExtensionKey or NSURLHasHiddenExtensionKey instead.") = 0x00100000 /* Item has a hidden extension*/
};
#define kLSInvalidExtensionIndex ULONG_MAX // Index returned from LSGetExtensionInfo when name has no extension
typedef struct LSItemInfoRecord {
LSItemInfoFlags flags;
OSType filetype;
OSType creator;
CFStringRef extension; /* release when finished*/
} LSItemInfoRecord __OS_AVAILABILITY_MSG(macosx, deprecated=10.11, "Use CFURLCopyResourcePropertiesForKeys or -[NSURL resourceValuesForKeys:error:] instead.");
#if TARGET_OS_OSX
/*
* LSCopyItemInfoForURL() *** DEPRECATED ***
*
* Summary:
* Return information about an item.
*
* Discussion:
* Returns as much or as little information as requested about inURL.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* inURL:
* The CFURLRef of the item about which information is requested.
*
* inWhichInfo:
* Flags indicating which information to return
*
* outItemInfo:
* Information is returned in this structure. Must not be NULL
*
* Deprecated:
* Use URL resource properties instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x
* Non-Carbon CFM: not available
*/
extern OSStatus
LSCopyItemInfoForURL(
CFURLRef inURL,
LSRequestedInfo inWhichInfo,
LSItemInfoRecord * outItemInfo) API_DEPRECATED("Use URL resource properties instead.", macos(10.0,10.11) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* LSCopyItemInfoForRef() *** DEPRECATED ***
*
* Summary:
* Return information about an item.
*
* Discussion:
* Returns as much or as little information as requested about
* inItemRef.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* inItemRef:
* The FSRef of the item about which information is requested.
*
* inWhichInfo:
* Flags indicating which information to return
*
* outItemInfo:
* Information is returned in this structure. Must not be NULL
*
* Deprecated:
* Use URL resource properties instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x
* Non-Carbon CFM: not available
*/
extern OSStatus
LSCopyItemInfoForRef(
const FSRef * inItemRef,
LSRequestedInfo inWhichInfo,
LSItemInfoRecord * outItemInfo) API_DEPRECATED("Use URL resource properties instead.", macos(10.0,10.10) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* LSGetExtensionInfo() *** DEPRECATED ***
*
* Summary:
* Get information about the extension for a file system name.
*
* Discussion:
* Returns the starting index of the extension (not including the
* period) or kLSInvalidExtensionIndex if the input name has no
* extension.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* inNameLen:
* The number of the UniChars in inNameBuffer.
*
* inNameBuffer:
* The buffer containing the name's Unicode characters.
*
* outExtStartIndex:
* On success, the starting index of the extension if there is one
* (not including the period). Set to kLSInvalidExtensionIndex if
* inNameBuffer does not contain a valid extension.
*
* Deprecated:
* Use CFURLCopyPathExtension(), -[NSURL pathExtension], or -[NSString pathExtension] instead.
*
* Availability:
* Mac OS X: in version 10.1 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x
* Non-Carbon CFM: not available
*/
extern OSStatus
LSGetExtensionInfo(
UniCharCount inNameLen,
const UniChar inNameBuffer[],
UniCharCount * outExtStartIndex) API_DEPRECATED("Use CFURLCopyPathExtension(), -[NSURL pathExtension], or -[NSString pathExtension] instead.", macos(10.1,10.11) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* LSCopyDisplayNameForRef() *** DEPRECATED ***
*
* Summary:
* Get the display name for an FSRef.
*
* Discussion:
* Return a copy of the display name for an FSRef. Takes into
* consideration whether this item has a hidden extension or not.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* inRef:
* The FSRef for which the display name is desired.
*
* outDisplayName:
* Pointer to the CFString into which the display name should be
* copied. Callers must dispose of the resulting CFString.
*
* Deprecated:
* Use the URL resource property kCFURLLocalizedNameKey or NSURLLocalizedNameKey instead.
*
* Availability:
* Mac OS X: in version 10.1 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x
* Non-Carbon CFM: not available
*/
extern OSStatus
LSCopyDisplayNameForRef(
const FSRef * inRef,
CFStringRef * outDisplayName) API_DEPRECATED("Use the URL resource property kCFURLLocalizedNameKey or NSURLLocalizedNameKey instead.", macos(10.1,10.10) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* LSCopyDisplayNameForURL() *** DEPRECATED ***
*
* Summary:
* Get the display name for a CFURLRef.
*
* Discussion:
* Return a copy of the display name for a CFURLRef. Takes into
* consideration whether this item has a hidden extension or not.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* inURL:
* The URL for which the display name is desired.
*
* outDisplayName:
* Pointer to the CFString into which the display name should be
* copied. Callers must dispose of the resulting CFString.
*
* Deprecated:
* Use the URL resource property kCFURLLocalizedNameKey or NSURLLocalizedNameKey instead.
*
* Availability:
* Mac OS X: in version 10.1 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x
* Non-Carbon CFM: not available
*/
extern OSStatus
LSCopyDisplayNameForURL(
CFURLRef inURL,
CFStringRef * outDisplayName) API_DEPRECATED("Use the URL resource property kCFURLLocalizedNameKey or NSURLLocalizedNameKey instead.", macos(10.1,10.11) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* LSSetExtensionHiddenForRef() *** DEPRECATED ***
*
* Summary:
* Sets whether the extension for an FSRef is hidden or not.
*
* Discussion:
* Sets the necessary file system state to indicate that the
* extension for inRef is hidden, as in the Finder. You can
* determine if an FSRef's extension is hidden using
* LSCopyItemInfoForRef.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* inRef:
* The FSRef for which the extension is to be hidden or shown.
*
* inHide:
* True to hide inRef's extension, false to show it.
*
* Deprecated:
* Use the URL resource property kCFURLHasHiddenExtensionKey or NSURLHasHiddenExtensionKey instead.
*
* Availability:
* Mac OS X: in version 10.1 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x
* Non-Carbon CFM: not available
*/
extern OSStatus
LSSetExtensionHiddenForRef(
const FSRef * inRef,
Boolean inHide) API_DEPRECATED("Use the URL resource property kCFURLHasHiddenExtensionKey or NSURLHasHiddenExtensionKey instead.", macos(10.1,10.10) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* LSSetExtensionHiddenForURL() *** DEPRECATED ***
*
* Summary:
* Sets whether the extension for a CFURLRef is hidden or not.
*
* Discussion:
* Sets the necessary file system state to indicate that the
* extension for inURL is hidden, as in the Finder. You can
* determine if a CFURLRef's extension is hidden using
* kCFURLHasHiddenExtensionKey.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* inURL:
* The CFURLRef for which the extension is to be hidden or shown.
*
* inHide:
* True to hide inURL's extension, false to show it.
*
* Deprecated:
* Use the URL resource property kCFURLHasHiddenExtensionKey or NSURLHasHiddenExtensionKey instead.
*
* Availability:
* Mac OS X: in version 10.1 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x
* Non-Carbon CFM: not available
*/
extern OSStatus
LSSetExtensionHiddenForURL(
CFURLRef inURL,
Boolean inHide) API_DEPRECATED("Use the URL resource property kCFURLHasHiddenExtensionKey or NSURLHasHiddenExtensionKey instead.", macos(10.1,10.11) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* LSCopyKindStringForRef() *** DEPRECATED ***
*
* Summary:
* Get the kind string for an item.
*
* Discussion:
* Returns the kind string as used in the Finder and elsewhere for
* inFSRef. The CFStringRef must be released after use.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* inFSRef:
* The item for which the kind string is requested.
*
* outKindString:
* A CFStringRef* to receive the copied kind string object. This
* CFStringRef must be released eventually.
*
* Deprecated:
* Use the URL resource property kCFURLLocalizedTypeDescriptionKey or NSURLLocalizedTypeDescriptionKey instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x
* Non-Carbon CFM: not available
*/
extern OSStatus
LSCopyKindStringForRef(
const FSRef * inFSRef,
CFStringRef * outKindString) API_DEPRECATED("Use the URL resource property kCFURLLocalizedTypeDescriptionKey or NSURLLocalizedTypeDescriptionKey instead.", macos(10.0,10.10) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* LSCopyKindStringForURL() *** DEPRECATED ***
*
* Summary:
* Get the kind string for an item.
*
* Discussion:
* Returns the kind string as used in the Finder and elsewhere for
* inURL. The CFStringRef must be released after use.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* inURL:
* The item for which the kind string is requested.
*
* outKindString:
* A CFStringRef* to receive the copied kind string object. This
* CFStringRef must be released eventually.
*
* Deprecated:
* Use the URL resource property kCFURLLocalizedTypeDescriptionKey or NSURLLocalizedTypeDescriptionKey instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x
* Non-Carbon CFM: not available
*/
extern OSStatus
LSCopyKindStringForURL(
CFURLRef inURL,
CFStringRef * outKindString) API_DEPRECATED("Use the URL resource property kCFURLLocalizedTypeDescriptionKey or NSURLLocalizedTypeDescriptionKey instead.", macos(10.0,10.11) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* LSCopyKindStringForTypeInfo() *** DEPRECATED ***
*
* Summary:
* Return the kind string for items like the provided info
*
* Discussion:
* Returns the kind string as shown in the Finder for the those
* items whose type, creator, and/or extension match the provided
* information. The kind string returned will be the one that most
* closely describes all the information provided. The kind string
* is subject to the document binding preferences that have been
* specified by the user. For example, if a creator is specified but
* the user has asked for files with the given
* creator/type/extension combination to open in an application with
* a different creator, the kind string will be loaded from the
* user's preferred application.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* inType:
* The OSType file type for which you want a kind string. Specify
* kLSUnknownType if no file type information is available.
*
* inCreator:
* The OSType creator for which you want a kind string. Specify
* kLSUnknownCreator if no creator information is available.
*
* inExtension:
* The extension for which you want a kind string. Specify NULL if
* no extension information is available.
*
* outKindString:
* A CFStringRef* to receive the copied kind string object. This
* CFStringRef must be released eventually.
*
* Deprecated:
* Use UTTypeCopyDescription instead.
*
* Availability:
* Mac OS X: in version 10.2 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x
* Non-Carbon CFM: not available
*/
extern OSStatus
LSCopyKindStringForTypeInfo(
OSType inType,
OSType inCreator,
CFStringRef inExtension, /* can be NULL */
CFStringRef * outKindString) API_DEPRECATED("Use UTTypeCopyDescription instead.", macos(10.2,10.10) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* LSCopyKindStringForMIMEType() *** DEPRECATED ***
*
* Summary:
* Get the kind string for the specified MIME type.
*
* Discussion:
* Returns the localized kind string describing the specified MIME
* type.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* inMIMEType:
* The string specifying the MIME type.
*
* outKindString:
* A CFStringRef* to receive the copied kind string object. This
* CFStringRef must be released eventually.
*
* Deprecated:
* Use UTTypeCopyDescription instead.
*
* Availability:
* Mac OS X: in version 10.2 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x
* Non-Carbon CFM: not available
*/
extern OSStatus
LSCopyKindStringForMIMEType(
CFStringRef inMIMEType,
CFStringRef * outKindString) API_DEPRECATED("Use UTTypeCopyDescription instead.", macos(10.2,10.10) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* LSGetApplicationForItem() *** DEPRECATED ***
*
* Summary:
* Return the application used to open an item.
*
* Discussion:
* Consults the binding tables to return the application that would
* be used to open inItemRef if it were double-clicked in the
* Finder. This application will be the user-specified override if
* appropriate or the default otherwise. If no application is known
* to LaunchServices suitable for opening this item,
* kLSApplicationNotFoundErr will be returned.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* inItemRef:
* The FSRef of the item for which the application is requested.
*
* inRoleMask:
* Whether to return the editor or viewer for inItemRef. If you
* don't care which, use kLSRolesAll.
*
* outAppRef:
* Filled in with the FSRef of the application if not NULL.
*
* outAppURL:
* Filled in with the CFURLRef of the application if not NULL.
* THIS FUNCTION, DESPITE ITS NAME, RETAINS THE URL REFERENCE ON
* BEHALF OF THE CALLER. THE CALLER MUST EVENTUALLY RELEASE THE
* RETURNED URL REFERENCE.
*
* Deprecated:
* Use LSCopyDefaultApplicationURLForURL instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x
* Non-Carbon CFM: not available
*/
extern OSStatus
LSGetApplicationForItem(
const FSRef * inItemRef,
LSRolesMask inRoleMask,
FSRef * outAppRef, /* can be NULL */
CFURLRef * outAppURL) /* can be NULL */ API_DEPRECATED("Use LSCopyDefaultApplicationURLForURL instead.", macos(10.0,10.10) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* LSGetApplicationForInfo() *** DEPRECATED ***
*
* Summary:
* Return the application used to open items with particular data.
*
* Discussion:
* Consults the binding tables to return the application that would
* be used to open items with type, creator, and/or extension as
* provided if they were double-clicked in the Finder. This
* application will be the default for items like this if one has
* been set. If no application is known to LaunchServices suitable
* for opening such items, kLSApplicationNotFoundErr will be
* returned. Not all three input parameters can be NULL at the same
* time nor can both output parameters be NULL at the same time.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* inType:
* The file type to consider. Can be kLSUnknownType.
*
* inCreator:
* The file creator to consider. Can be kLSUnknownCreator.
*
* inExtension:
* The file name extension to consider. Can be NULL.
*
* inRoleMask:
* Whether to return the editor or viewer for inItemRef. If you
* don't care which, use kLSRolesAll.
*
* outAppRef:
* Filled in with the FSRef of the application if not NULL.
*
* outAppURL:
* Filled in with the CFURLRef of the application if not NULL.
* THIS FUNCTION, DESPITE ITS NAME, RETAINS THE URL REFERENCE ON
* BEHALF OF THE CALLER. THE CALLER MUST EVENTUALLY RELEASE THE
* RETURNED URL REFERENCE.
*
* Deprecated:
* Use LSCopyDefaultApplicationURLForContentType instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x
* Non-Carbon CFM: not available
*/
extern OSStatus
LSGetApplicationForInfo(
OSType inType,
OSType inCreator,
CFStringRef inExtension, /* can be NULL */
LSRolesMask inRoleMask,
FSRef * outAppRef, /* can be NULL */
CFURLRef * outAppURL) /* can be NULL */ API_DEPRECATED("Use -[NSWorkspace URLForApplicationToOpenContentType:] instead.", macos(10.0,10.10) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* LSCopyApplicationForMIMEType() *** DEPRECATED ***
*
* Summary:
* Return the application used to handle data with the specified
* MIME type.
*
* Discussion:
* The returned application URL will be the user's preferred handler
* for the MIME type if one has been set. If no user preferred
* application has been set, Launch Services will select a default
* handler for the MIME type. If no application is known to handle
* the MIME type, kLSApplicationNotFoundErr will be returned.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* inMIMEType:
* The string specifying the MIME type.
*
* inRoleMask:
* A role mask that the chosen application must satisfy. Use
* kLSRolesAll if the role is not important.
*
* outAppURL:
* Receives the copied CFURLRef, which must be released by the
* caller.
*
* Deprecated:
* Use LSCopyDefaultApplicationURLForContentType instead.
*
* Availability:
* Mac OS X: in version 10.2 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x
* Non-Carbon CFM: not available
*/
extern OSStatus
LSCopyApplicationForMIMEType(
CFStringRef inMIMEType,
LSRolesMask inRoleMask,
CFURLRef * outAppURL) API_DEPRECATED("Use -[NSWorkspace URLForApplicationToOpenContentType:] instead.", macos(10.2,10.10) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* LSGetApplicationForURL() *** DEPRECATED ***
*
* Summary:
* Return the application used to open an item.
*
* Discussion:
* Consults the binding tables to return the application that would
* be used to open inURL if it were double-clicked in the Finder.
* This application will be the user-specified override if
* appropriate or the default otherwise. If no application is known
* to LaunchServices suitable for opening this item,
* kLSApplicationNotFoundErr will be returned.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* inURL:
* The CFURLRef of the item for which the application is requested.
*
* inRoleMask:
* Whether to return the editor or viewer for inItemRef. If you
* don't care which, use kLSRolesAll.
*
* outAppRef:
* Filled in with the FSRef of the application if not NULL.
*
* outAppURL:
* Filled in with the CFURLRef of the application if not NULL.
* THIS FUNCTION, DESPITE ITS NAME, RETAINS THE URL REFERENCE ON
* BEHALF OF THE CALLER. THE CALLER MUST EVENTUALLY RELEASE THE
* RETURNED URL REFERENCE.
*
* Deprecated:
* Use LSCopyDefaultApplicationURLForURL instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x
* Non-Carbon CFM: not available
*/
extern OSStatus
LSGetApplicationForURL(
CFURLRef inURL,
LSRolesMask inRoleMask,
FSRef * outAppRef, /* can be NULL */
CFURLRef * outAppURL) /* can be NULL */ API_DEPRECATED("Use LSCopyDefaultApplicationURLForURL instead.", macos(10.0,10.10) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* LSFindApplicationForInfo() *** DEPRECATED ***
*
* Summary:
* Locate a specific application.
*
* Discussion:
* Returns the application with the corresponding input information.
* The registry of applications is consulted first in order of
* bundleID, then creator, then name. All comparisons are case
* insensitive and 'ties' are decided first by version, then by
* native vs. Classic.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* inCreator:
* The file creator to consider. Can be kLSUnknownCreator.
*
* inBundleID:
* The bundle ID to consider. Can be NULL.
*
* inName:
* The name to consider. Can be NULL. Must include any extensions
* that are part of the file system name, e.g. '.app'.
*
* outAppRef:
* Filled in with the FSRef of the application if not NULL.
*
* outAppURL:
* Filled in with the CFURLRef of the application if not NULL.
* THIS FUNCTION, DESPITE ITS NAME, RETAINS THE URL REFERENCE ON
* BEHALF OF THE CALLER. THE CALLER MUST EVENTUALLY RELEASE THE
* RETURNED URL REFERENCE.
*
* Deprecated:
* Use LSCopyApplicationURLsForBundleIdentifier instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x
* Non-Carbon CFM: not available
*/
extern OSStatus
LSFindApplicationForInfo(
OSType inCreator,
CFStringRef inBundleID, /* can be NULL */
CFStringRef inName, /* can be NULL */
FSRef * outAppRef, /* can be NULL */
CFURLRef * outAppURL) /* can be NULL */ API_DEPRECATED("Use LSCopyApplicationURLsForBundleIdentifier instead.", macos(10.0,10.10) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* LSCanRefAcceptItem() *** DEPRECATED ***
*
* Summary:
* Determine whether an item can accept another item.
*
* Discussion:
* Returns in outAcceptsItem whether inTargetRef can accept
* inItemFSRef as in a drag and drop operation. If inRoleMask is
* other than kLSRolesAll then make sure inTargetRef claims to
* fulfill the requested role.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* inItemFSRef:
* FSRef of the item about which acceptance is requested.
*
* inTargetRef:
* FSRef of the potential target.
*
* inRoleMask:
* The role(s) the target must claim in order to consider
* acceptance.
*
* inFlags:
* Use kLSAcceptDefault.
*
* outAcceptsItem:
* Filled in with result. Must not be NULL.
*
* Deprecated:
* Use LSCanURLAcceptURL instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x
* Non-Carbon CFM: not available
*/
extern OSStatus
LSCanRefAcceptItem(
const FSRef * inItemFSRef,
const FSRef * inTargetRef,
LSRolesMask inRoleMask,
LSAcceptanceFlags inFlags,
Boolean * outAcceptsItem) API_DEPRECATED("Use LSCanURLAcceptURL instead.", macos(10.0,10.10) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* LSRegisterFSRef() *** DEPRECATED ***
*
* Discussion:
* If the specified FSRef refers to an application or other bundle
* claiming to handle documents or URLs, add the bundle's document
* and URL claims to the Launch Services database.
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Parameters:
*
* inRef:
* The FSRef of the item to be registered.
*
* inUpdate:
* When false, LSRegisterFSRef does not register the item if it
* has already been registered and the current modification date
* of the item has not changed from when it was last registered.
* When true, the item's registered info is updated, even if the
* modification has not changed.
*
* Result:
* An OSStatus value: noErr - Success kLSNoRegistrationInfoErr - The
* item does not contain info requiring registration kLSDataErr -
* The item's property list info is malformed.
*
* Deprecated:
* Use LSRegisterURL instead.
*
* Availability:
* Mac OS X: in version 10.3 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x
* Non-Carbon CFM: not available
*/
extern OSStatus
LSRegisterFSRef(
const FSRef * inRef,
Boolean inUpdate) API_DEPRECATED("Use LSRegisterURL instead.", macos(10.3,10.10) ) API_UNAVAILABLE( ios, tvos, watchos );
#endif // TARGET_OS_OSX
/* ================================================================================== */
/* API for retrieving item attributes */
/* ================================================================================== */
/*
* Attributes Names
*
* kLSItemContentType
*
* The item's content type identifier (a uniform type identifier string)
* Value type CFStringRef
*
*
* kLSItemFileType
*
* The item's file type (OSType)
* Value type CFStringRef
*
*
* kLSItemFileCreator
*
* The item's file creator (OSType)
* Value type CFStringRef
*
*
* kLSItemExtension
*
* The item's filename extension
* Value type CFStringRef
*
*
* kLSItemDisplayName
*
* The item's name as displayed to the user
* (The display name reflects localization and
* extension hiding which may be in effect)
* Value type CFStringRef
*
*
* kLSItemDisplayKind
*
* The localized kind string describing this item's type
* Value type CFStringRef
*
*
* kLSItemRoleHandlerDisplayName
*
* The display name of the application set to handle (open) this item
* (subject to the role mask)
* value type CFStringRef
*
*
* kLSItemIsInvisible
*
* True if the item is normally hidden from users
* Value type CFBooleanRef
*
*
* kLSItemExtensionIsHidden
*
* True if the item's extension is set to be hidden
* Value type CFBooleanRef
*
*
* kLSItemQuarantineProperties (can be set)
*
* A dictionary of quarantine properties. See LSQuarantine.h for
* quarantine property definitions. This attribute is not
* present if the item is not quarantined.
* Value type CFDictionaryRef. May be NULL.
*/
/*
* kLSItemContentType *** DEPRECATED ***
*
* Deprecated:
* Use the URL resource property NSURLContentTypeKey instead.
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern const CFStringRef kLSItemContentType API_DEPRECATED("Use the URL resource property NSURLContentTypeKey instead.", ios(4.0,8.0), macos(10.4,10.10), tvos(9.0,9.0), watchos(4.0,4.0) );
/*
* kLSItemFileType *** DEPRECATED ***
*
* Deprecated:
* Use the URL resource property NSURLContentTypeKey to get the file's UTI instead.
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern const CFStringRef kLSItemFileType API_DEPRECATED("Use the URL resource property NSURLContentTypeKey to get the file's UTI instead.", ios(4.0,8.0), macos(10.4,10.10), tvos(9.0,9.0), watchos(4.0,4.0) );
/*
* kLSItemFileCreator *** DEPRECATED ***
*
* Deprecated:
* Use the URL resource property NSURLContentTypeKey to get the file's UTI instead.
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern const CFStringRef kLSItemFileCreator API_DEPRECATED("Use the URL resource property NSURLContentTypeKey to get the file's UTI instead.", ios(4.0,8.0), macos(10.4,10.10), tvos(9.0,9.0), watchos(4.0,4.0) );
/*
* kLSItemExtension *** DEPRECATED ***
*
* Deprecated:
* Use CFURLCopyPathExtension or -[NSURL pathExtension] instead.
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern const CFStringRef kLSItemExtension API_DEPRECATED("Use CFURLCopyPathExtension or -[NSURL pathExtension] instead.", ios(4.0,8.0), macos(10.4,10.10), tvos(9.0,9.0), watchos(4.0,4.0) );
/*
* kLSItemDisplayName *** DEPRECATED ***
*
* Deprecated:
* Use the URL resource property kCFURLLocalizedNameKey or NSURLLocalizedNameKey instead.
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern const CFStringRef kLSItemDisplayName API_DEPRECATED("Use the URL resource property kCFURLLocalizedNameKey or NSURLLocalizedNameKey instead.", ios(4.0,8.0), macos(10.4,10.10), tvos(9.0,9.0), watchos(4.0,4.0) );
/*
* kLSItemDisplayKind *** DEPRECATED ***
*
* Deprecated:
* Use the URL resource property kCFURLLocalizedTypeDescriptionKey or NSURLLocalizedTypeDescriptionKey instead.
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern const CFStringRef kLSItemDisplayKind API_DEPRECATED("Use the URL resource property kCFURLLocalizedTypeDescriptionKey or NSURLLocalizedTypeDescriptionKey instead.", ios(4.0,8.0), macos(10.4,10.10), tvos(9.0,9.0), watchos(4.0,4.0) );
/*
* kLSItemRoleHandlerDisplayName *** DEPRECATED ***
*
* Deprecated:
* Instead, resolve the desired role handler for the file, then use the URL resource
* property kCFURLLocalizedNameKey or NSURLLocalizedNameKey on the role handler's URL.
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern const CFStringRef kLSItemRoleHandlerDisplayName API_DEPRECATED("Instead, resolve the desired role handler for the file, then use the URL resource property kCFURLLocalizedNameKey or NSURLLocalizedNameKey on the role handler's URL.", ios(4.0,8.0), macos(10.4,10.10), tvos(9.0,9.0), watchos(4.0,4.0) );
/*
* kLSItemIsInvisible *** DEPRECATED ***
*
* Deprecated:
* Use the URL resource property kCFURLIsHiddenKey or NSURLIsHiddenKey instead.
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern const CFStringRef kLSItemIsInvisible API_DEPRECATED("Use the URL resource property kCFURLIsHiddenKey or NSURLIsHiddenKey instead.", ios(4.0,8.0), macos(10.4,10.10), tvos(9.0,9.0), watchos(4.0,4.0) );
/*
* kLSItemExtensionIsHidden *** DEPRECATED ***
*
* Deprecated:
* Use the URL resource property kCFURLHasHiddenExtensionKey or NSURLHasHiddenExtensionKey instead.
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern const CFStringRef kLSItemExtensionIsHidden API_DEPRECATED("Use the URL resource property kCFURLHasHiddenExtensionKey or NSURLHasHiddenExtensionKey instead.", ios(4.0,8.0), macos(10.4,10.10), tvos(9.0,9.0), watchos(4.0,4.0) );
/*
* kLSItemQuarantineProperties *** DEPRECATED ***
*
* Deprecated:
* Use the URL resource property kCFURLQuarantinePropertiesKey or NSURLQuarantinePropertiesKey instead.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern const CFStringRef kLSItemQuarantineProperties API_DEPRECATED("Use the URL resource property kCFURLQuarantinePropertiesKey or NSURLQuarantinePropertiesKey instead.", ios(4.0,8.0), macos(10.5,10.10), tvos(9.0,9.0), watchos(4.0,4.0) );
#if TARGET_OS_OSX
/*
* LSCopyItemAttribute() *** DEPRECATED ***
*
* Discussion:
* Assigns the value of the specified item's attribute (or NULL, if
* the item has no such attribute or an error occurs) to *outValue.
*
* Mac OS X threading:
* Thread safe since version 10.4
*
* Parameters:
*
* inItem:
* The FSRef of the item
*
* inRoles:
* The role(s), at least one of which must be provided by the
* application selected when computing attributes related to
* document binding (such as kLSItemRoleHandlerDisplayName). Pass
* kLSRolesAll if any role is acceptable.
*
* inAttributeName:
* The name of the attribute to copy
*
* outValue:
* Receives the attribute value
*
* Result:
* an OSStatus value. Returns kLSAttributeNotFoundErr if the item
* does not have the requested attribute.
*
* Deprecated:
* Use CFURLCopyResourcePropertyForKey or -[NSURL getResourceValue:forKey:error:] instead.
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern OSStatus
LSCopyItemAttribute(
const FSRef * inItem,
LSRolesMask inRoles,
CFStringRef inAttributeName,
CFTypeRef * outValue) API_DEPRECATED("Use CFURLCopyResourcePropertyForKey or -[NSURL getResourceValue:forKey:error:] instead.", macos(10.4,10.10) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* LSCopyItemAttributes() *** DEPRECATED ***
*
* Discussion:
* Creates a dictionary containing the specified attribute values
* and assigns it to *outValues. The output dictionary keys are the
* attribute names. The CFTypeID of each value in the dictionary
* varies by attribute. See each attribute name constant for a
* description of its value type. An attribute key will be absent
* from the values dictionary if the item has no such attribute.
*
* Mac OS X threading:
* Thread safe since version 10.4
*
* Parameters:
*
* inItem:
* The FSRef of the item
*
* inRoles:
* The role(s), at least one of which must be provided by the
* application selected when computing attributes related to
* document binding (such as kLSItemRoleHandlerDisplayName). Pass
* kLSRolesAll if any role is acceptable.
*
* inAttributeNames:
* The array of attribute names
*
* outValues:
* Receives the dictionary of attribure name-value pairs
*
* Result:
* an OSStatus value.
*
* Deprecated:
* Use CFURLCopyResourcePropertiesForKeys or -[NSURL resourceValuesForKeys:error:] instead.
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern OSStatus
LSCopyItemAttributes(
const FSRef * inItem,
LSRolesMask inRoles,
CFArrayRef inAttributeNames,
CFDictionaryRef * outValues) API_DEPRECATED("Use CFURLCopyResourcePropertiesForKeys or -[NSURL resourceValuesForKeys:error:] instead.", macos(10.4,10.10) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* LSSetItemAttribute() *** DEPRECATED ***
*
* Discussion:
* Sets the value of a settable item's attribute. Currently, only
* the kLSItemQuarantineProperties attribute may be set.
*
* Mac OS X threading:
* Thread safe since version 10.5
*
* Parameters:
*
* inItem:
* The FSRef of the item
*
* inRoles:
* Reserved for future use. To ensure compatibility, pass
* kLSRolesAll for this argument.
*
* inAttributeName:
* The name of the attribute to set
*
* inValue:
* The new value of the attribute. If NULL, removes the attribute
* from the item.
*
* Result:
* an OSStatus value. Returns kLSAttributeNotSettableErr if the
* attribute is read-only.
*
* Deprecated:
* Use CFURLSetResourcePropertyForKey or -[NSURL setResourceValue:forKey:error:] instead.
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern OSStatus
LSSetItemAttribute(
const FSRef * inItem,
LSRolesMask inRoles,
CFStringRef inAttributeName,
CFTypeRef inValue) /* can be NULL */ API_DEPRECATED("Use CFURLSetResourcePropertyForKey or -[NSURL setResourceValue:forKey:error:] instead.", macos(10.5,10.10) ) API_UNAVAILABLE( ios, tvos, watchos );
#endif // TARGET_OS_OSX
/*
* LSHandlerOptions *** DEPRECATED ***
*
* Options controlling how content handlers are selected.
*
* kLSHandlerOptionsDefault - by default, Launch Services will
* use a content item's creator (when available) to select a handler
* kLSHandlerOptionsIgnoreCreator - Launch Services will ignore content item
* creator information when selecting a role handler for the specified
* content type
*
* Deprecated:
* Creator codes are deprecated on OS X.
*
*/
typedef CF_OPTIONS(OptionBits, LSHandlerOptions) {
kLSHandlerOptionsDefault API_DEPRECATED("Creator codes are deprecated on OS X.", ios(4.0,9.0), macos(10.4,10.11), tvos(9.0,9.0), watchos(4.0,4.0) ) = 0,
kLSHandlerOptionsIgnoreCreator API_DEPRECATED("Creator codes are deprecated on OS X.", ios(4.0,9.0), macos(10.4,10.11), tvos(9.0,9.0), watchos(4.0,4.0) ) = 1
};
/*
* LSGetHandlerOptionsForContentType() *** DEPRECATED ***
*
* Get the handler options for the specified content type (UTI).
*
* Mac OS X threading:
* Thread safe since version 10.4
*
* Deprecated:
* Creator codes are deprecated on OS X.
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern LSHandlerOptions
LSGetHandlerOptionsForContentType(CFStringRef inContentType) API_DEPRECATED("Creator codes are deprecated on OS X.", ios(4.0,9.0), macos(10.4,10.11), tvos(9.0,9.0), watchos(4.0,4.0) );
/*
* LSSetHandlerOptionsForContentType() *** DEPRECATED ***
*
* Set the handler options for the specified content type (UTI).
*
* Mac OS X threading:
* Thread safe since version 10.4
*
* Deprecated:
* Creator codes are deprecated on OS X.
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern OSStatus
LSSetHandlerOptionsForContentType(
CFStringRef inContentType,
LSHandlerOptions inOptions) API_DEPRECATED("Creator codes are deprecated on OS X.", ios(4.0,9.0), macos(10.4,10.11), tvos(9.0,9.0), watchos(4.0,4.0) );
#pragma pack(pop)
#ifdef __cplusplus
}
#endif
#endif /* __LSINFODEPRECATED__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/LaunchServices.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/LaunchServices.framework/Headers/LSOpen.h | /*
File: LSOpen.h
Contains: Public interfaces for LaunchServices.framework
Copyright: (c) 2003-2012 by Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __LSOPEN__
#define __LSOPEN__
#ifndef __COREFOUNDATION__
#include <CoreFoundation/CoreFoundation.h>
#endif
#if TARGET_OS_OSX
#ifndef __CARBONCORE__
#include <CarbonCore/CarbonCore.h>
#endif
#endif
#ifndef __LSINFO__
#include <LaunchServices/LSInfo.h>
#endif
#if TARGET_OS_OSX
#ifndef __AE__
#include <AE/AE.h>
#endif
#endif
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
#pragma pack(push, 2)
CF_ASSUME_NONNULL_BEGIN
/* ======================================================================================================== */
/* LaunchServices Type & Constants */
/* ======================================================================================================== */
typedef CF_OPTIONS(OptionBits, LSLaunchFlags) {
kLSLaunchDefaults = 0x00000001, /* Defaults = open, async*/
kLSLaunchAndPrint = 0x00000002, /* Print items instead of open them*/
kLSLaunchAndDisplayErrors = 0x00000040, /* Report launch/open failures in the UI*/
kLSLaunchDontAddToRecents = 0x00000100, /* Do not add app or documents to recents menus.*/
kLSLaunchDontSwitch = 0x00000200, /* Do not bring new app to the foreground.*/
kLSLaunchAsync = 0x00010000, /* Asynchronous launch; return as soon as the app starts launching.*/
kLSLaunchNewInstance = 0x00080000, /* Instantiate app even if it is already running.*/
kLSLaunchAndHide = 0x00100000, /* Send child a "hide" request as soon as it checks in.*/
kLSLaunchAndHideOthers = 0x00200000, /* Hide all other apps when the app checks in.*/
};
#if TARGET_OS_OSX
typedef struct LSLaunchURLSpec {
__nullable CFURLRef appURL; /* app to use*/
__nullable CFArrayRef itemURLs; /* items to open/print*/
const AEDesc * __nullable passThruParams; /* passed untouched to application as optional parameter*/
LSLaunchFlags launchFlags;
void * __nullable asyncRefCon; /* used if you register for app birth/death notification*/
} LSLaunchURLSpec API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* LSOpenCFURLRef()
*
* Summary:
* Open an application, document, or folder.
*
* Discussion:
* Opens applications, documents, and folders. Applications are
* opened via an 'oapp' or 'rapp' event. Documents are opened in
* their user-overridden or default applications as appropriate.
* Folders are opened in the Finder. Use the more specific
* LSOpenFromURLSpec for more control over launching.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* inURL:
* The CFURLRef of the item to launch.
*
* outLaunchedURL:
* The CFURLRef of the item actually launched. For inURLs that are
* documents, outLaunchedURL will be the application used to
* launch the document. Can be NULL. THIS FUNCTION, DESPITE ITS
* NAME, RETAINS THE URL REFERENCE ON BEHALF OF THE CALLER. THE
* CALLER MUST EVENTUALLY RELEASE THE RETURNED URL REFERENCE.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x
* Non-Carbon CFM: not available
*/
extern OSStatus
LSOpenCFURLRef(
CFURLRef inURL,
__nullable CFURLRef *__nullable outLaunchedURL) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* LSOpenFromURLSpec()
*
* Summary:
* Opens an application or one or more documents or folders.
*
* Discussion:
* Opens applications, documents, and folders.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* inLaunchSpec:
* The specification of what to launch and how to launch it.
*
* outLaunchedURL:
* The CFURLRef of the item actually launched. For inURLs that are
* documents, outLaunchedURL will be the application used to
* launch the document. Can be NULL. THIS FUNCTION, DESPITE ITS
* NAME, RETAINS THE URL REFERENCE ON BEHALF OF THE CALLER. THE
* CALLER MUST EVENTUALLY RELEASE THE RETURNED URL REFERENCE.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x
* Non-Carbon CFM: not available
*/
extern OSStatus
LSOpenFromURLSpec(
const LSLaunchURLSpec * inLaunchSpec,
__nullable CFURLRef *__nullable outLaunchedURL) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
#endif
CF_ASSUME_NONNULL_END
#pragma pack(pop)
#ifdef __cplusplus
}
#endif
#include <LaunchServices/LSOpenDeprecated.h>
#endif /* __LSOPEN__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/LaunchServices.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/LaunchServices.framework/Headers/LaunchServices.h | /*
File: LaunchServices.h
Contains: Public interfaces for LaunchServices.framework
Copyright: (c) 2003-2012 by Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __LAUNCHSERVICES__
#define __LAUNCHSERVICES__
#include <TargetConditionals.h>
#if TARGET_OS_OSX
#ifndef __ICONSCORE__
#include <LaunchServices/IconsCore.h>
#endif
#endif // TARGET_OS_OSX
#ifndef __LSINFO__
#include <LaunchServices/LSInfo.h>
#endif
#ifndef __LSOPEN__
#include <LaunchServices/LSOpen.h>
#endif
#if TARGET_OS_OSX
#ifndef __LSQUARANTINE__
#include <LaunchServices/LSQuarantine.h>
#endif
#endif // TARGET_OS_OSX
#ifndef __UTCORETYPES__
#include <LaunchServices/UTCoreTypes.h>
#endif
#ifndef __UTTYPE__
#include <LaunchServices/UTType.h>
#endif
#endif /* __LAUNCHSERVICES__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/LaunchServices.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/LaunchServices.framework/Headers/UTType.h | /*
File: UTType.h
Contains: Public interfaces for uniform type identifiers
Copyright: (c) 2003-2012 by Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __UTTYPE__
#define __UTTYPE__
#ifndef __COREFOUNDATION__
#include <CoreFoundation/CoreFoundation.h>
#endif
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
CF_ASSUME_NONNULL_BEGIN
/* ======================================================================================================== */
/* Uniform Type Identification API */
/* ======================================================================================================== */
/*
Uniform Type Identification Primer
Uniform Type Identifiers (or UTIs) are strings which uniquely identify
abstract types. They can be used to describe a file format or an
in-memory data type, but can also be used to describe the type of
other sorts of entities, such as directories, volumes, or packages.
The syntax of a uniform type identifier looks like a bundle identifier.
It has the form of a reversed DNS name, although some special top-level
UTI domains are reserved by Apple and are outside the current IANA
top-level Internet domain name space.
Examples:
public.jpeg
public.utf16-plain-text
com.apple.xml-property-list
Types which are standard or not controlled by any one organization
are declared in the "public" domain. Currently, public types may
be declared only by Apple.
Types specific to Mac OS are declared with identifiers in the
com.apple.macos domain.
Third parties should declare their own uniform type identifiers
in their respective registered Internet domain spaces.
Type declarations appear in bundle property lists and tell
the system several things about a type, including the following:
Conformance
A type may "conform" to one or more other types. For example, the
type com.apple.xml-property-list conforms to both the
com.apple.property-list and public.xml types. The public.xml
type in turn conforms to type public.text. Finally, type public.text
conforms to public.data, which is the base type for all types
describing bytes stream formats. Conformance relationships between
types are established in type declarations.
Conformance relationships establish a multiple inheritanace hierarchy
between types. Type property values may be inherited at runtime
according to the conformance relationships for each type. When a type's
declaration does not include a value for particular type property,
then the type's supertypes are searched for a value. Supertypes are
searched depth-first, in the order given in the type declaration.
This is the only way in which the declared order of the conforms-to
supertypes is significant.
Tags
A "tag" is a string which indicates a type in some other type
identification space, such as a filename extension, MIME Type,
or NSPboardType. Each type declaration may include a
"tag specification", which is a dictionary listing all of the
tags associated with the type.
A tag's "class" is the namespace of a tag: filename extension,
MIME type, OSType, etc. Tag classes are themselves identified by
uniform type identifiers so that the set of valid tag classes is
easily extendend in the future.
Other Type Properties
Type declarations may include several other properties: a localizable
user description of the type, the name of an icon resource in
the declaring bundle, a reference URL identifying technical
documentation about the type itself, and finally a version number,
which can be incremented as a type evolves. All of these properties
are optional.
Exported vs. Imported Type Declarations
Type declarations are either exported or imported. An exported
type declaration means that the type itself is defined or owned
by the organization making the declaration. For example, a propietary
document type declaration should only be exported by the application
which controls the document format.
An imported declaration is for applications which depend on the
existence of someone else's type declaration. If application A can
open application B's document format, then application A makes
an imported declaration of application B's document type so that
even if application B is not present on the system, there is an
acessible declaration of its document type.
An exported declaration of a particular type identifier is always
preferred over an imported declaration.
Example XML Type Declaration
Appearing below is an XML excerpt from a bundle Info.plist file which
declares the public type "public.jpeg":
<key>UTExportedTypeDeclarations</key>
<array>
<dict>
<key>UTTypeIdentifier</key>
<string>public.jpeg</string>
<key>UTTypeDescription</key>
<string>JPEG image</string>
<key>UTTypeIconFile</key>
<string>public.jpeg.icns</string>
<key>UTTypeConformsTo</key>
<array>
<string>public.image</string>
</array>
<key>UTTypeTagSpecification</key>
<dict>
<key>com.apple.ostype</key>
<string>JPEG</string>
<key>public.filename-extension</key>
<array>
<string>jpeg</string>
<string>jpg</string>
</array>
<key>public.mime-type</key>
<string>image/jpeg</string>
</dict>
</dict>
</array>
Dynamic Type Identifiers
Uniform Type Identifiation uses dynamic type identifiers to
represent types for which no identifier has been declared. A
dynamic type identifier is syntactially a regular uniform
type identifier in the "dyn" domain. However, after the
initial domain label, a dynamic type identifier is an
opaque encoding of a tag specification. Dynamic type
identifiers cannot be declared. They are generated on-demand
with whatever type information is available at the time, often
a single (otherwise unknown) type tag.
A dynamic identifier therefore carries within it a minimal
amount of type information, but enough to work well with the
Uniform Type Identification API. For example, a client can
extract from a dynamic type identifier the original tag
specification with which it was created. A client can also
test a dynamic type identifier for equality to another
uniform type identifier. If the dynamic identifier's
tag specification is a subset of the other identifier's
tags, the two are considered equal.
Dynamic type identifiers do not express the full richness
of type information associated with a declared type
identifier, but dynamic type identifiers allow the behavior
to degrade gracefully in the presence of incomplete
declared type information.
A dynamic type identifier may be transmitted across processes
on a given system, but it should never be stored persistently
or transmitted over the wire to another system. In particular,
dynamic identifiers should not appear in bundle info property
lists, and they will generally be ignored when they do. Apple
reserves the right to change the opaque format of dynamic
identifiers in future versions of Mac OS X.
*/
/*
Type Declaration Dictionary Keys
The following keys are used in type declarations
*/
/*
* kUTExportedTypeDeclarationsKey
*/
extern const CFStringRef kUTExportedTypeDeclarationsKey API_AVAILABLE( ios(3.0), macos(10.3), tvos(9.0), watchos(1.0) );
/*
* kUTImportedTypeDeclarationsKey
*/
extern const CFStringRef kUTImportedTypeDeclarationsKey API_AVAILABLE( ios(3.0), macos(10.3), tvos(9.0), watchos(1.0) );
/*
* kUTTypeIdentifierKey
*/
extern const CFStringRef kUTTypeIdentifierKey API_AVAILABLE( ios(3.0), macos(10.3), tvos(9.0), watchos(1.0) );
/*
* kUTTypeTagSpecificationKey
*/
extern const CFStringRef kUTTypeTagSpecificationKey API_AVAILABLE( ios(3.0), macos(10.3), tvos(9.0), watchos(1.0) );
/*
* kUTTypeConformsToKey
*/
extern const CFStringRef kUTTypeConformsToKey API_AVAILABLE( ios(3.0), macos(10.3), tvos(9.0), watchos(1.0) );
/*
* kUTTypeDescriptionKey
*/
extern const CFStringRef kUTTypeDescriptionKey API_AVAILABLE( ios(3.0), macos(10.3), tvos(9.0), watchos(1.0) );
/*
* kUTTypeIconFileKey
*/
extern const CFStringRef kUTTypeIconFileKey API_AVAILABLE( ios(3.0), macos(10.3), tvos(9.0), watchos(1.0) );
/*
* kUTTypeReferenceURLKey
*/
extern const CFStringRef kUTTypeReferenceURLKey API_AVAILABLE( ios(3.0), macos(10.3), tvos(9.0), watchos(1.0) );
/*
* kUTTypeVersionKey
*/
extern const CFStringRef kUTTypeVersionKey API_AVAILABLE( ios(3.0), macos(10.3), tvos(9.0), watchos(1.0) );
/*
Type Tag Classes
The following constant strings identify tag classes for use
when converting uniform type identifiers to and from
equivalent tags.
*/
/*
* kUTTagClassFilenameExtension *** DEPRECATED ***
*/
extern const CFStringRef kUTTagClassFilenameExtension API_DEPRECATED("Use UTTagClassFilenameExtension instead.", ios(3.0, 15.0), macos(10.3, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
/*
* kUTTagClassMIMEType *** DEPRECATED ***
*/
extern const CFStringRef kUTTagClassMIMEType API_DEPRECATED("Use UTTagClassMIMEType instead.", ios(3.0, 15.0), macos(10.3, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
/*
* kUTTagClassNSPboardType *** DEPRECATED ***
*/
extern const CFStringRef kUTTagClassNSPboardType API_DEPRECATED("NSPasteboard types are obsolete.", macos(10.3, 12.0)) API_UNAVAILABLE(ios, tvos, watchos);
/*
* kUTTagClassOSType *** DEPRECATED ***
*/
extern const CFStringRef kUTTagClassOSType API_DEPRECATED("HFS file types are obsolete.", macos(10.3, 12.0)) API_UNAVAILABLE(ios, tvos, watchos);
/*
* UTTypeCreatePreferredIdentifierForTag() *** DEPRECATED ***
*
* Discussion:
* Creates a uniform type identifier for the type indicated by the
* specified tag. This is the primary function to use for going from
* tag (extension/MIMEType/OSType) to uniform type identifier.
* Optionally, the returned type identifiers must conform to the
* identified "conforming-to" type argument. This is a hint to the
* implementation to constrain the search to a particular tree of
* types. For example, the client may want to know the type
* indicated by a particular extension tag. If the client knows that
* the extension is associated with a directory (rather than a
* file), the client may specify "public.directory" for the
* conforming-to argument. This will allow the implementation to
* ignore all types associated with byte data formats (public.data
* base type). If more than one type is indicated, preference is
* given to a public type over a non-public type on the theory that
* instances of public types are more common, and therefore more
* likely to be correct. When there a choice must be made between
* multiple public types or multiple non-public types, the selection
* rules are undefined. Clients needing finer control should use
* UTTypeCreateAllIdentifiersForTag. If no declared type is
* indicated, a dynamic type identifier is generated which satisfies
* the parameters.
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Parameters:
*
* inTagClass:
* the class identifier of the tag argument
*
* inTag:
* the tag string
*
* inConformingToUTI:
* the identifier of a type to which the result must conform
*
* Result:
* a new CFStringRef containing the type identifier, or NULL if
* inTagClass is not a known tag class
*/
extern __nullable CFStringRef
UTTypeCreatePreferredIdentifierForTag(
CFStringRef inTagClass,
CFStringRef inTag,
__nullable CFStringRef inConformingToUTI) API_DEPRECATED("Use the UTType class instead.", ios(3.0, 15.0), macos(10.3, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
/*
* UTTypeCreateAllIdentifiersForTag() *** DEPRECATED ***
*
* Discussion:
* Creates an array of all uniform type identifiers indicated by the
* specified tag. An overloaded tag (e.g., an extension used by
* several applications for different file formats) may indicate
* multiple types. If no declared type identifiers have the
* specified tag, then a single dynamic type identifier will be
* created for the tag. Optionally, the returned type identifiers
* must conform to the identified "conforming-to" type argument.
* This is a hint to the implementation to constrain the search to a
* particular tree of types. For example, the client may want to
* know the type indicated by a particular extension tag. If the
* client knows that the extension is associated with a directory
* (rather than a file), the client may specify "public.directory"
* for the conforming-to argument. This will allow the
* implementation to ignore all types associated with byte data
* formats (public.data base type).
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Parameters:
*
* inTagClass:
* the class identifier of the tag argument
*
* inTag:
* the tag string
*
* inConformingToUTI:
* the identifier of a type to which the results must conform
*
* Result:
* An array of uniform type identifiers, or NULL if inTagClass is
* not a known tag class
*/
extern __nullable CFArrayRef
UTTypeCreateAllIdentifiersForTag(
CFStringRef inTagClass,
CFStringRef inTag,
__nullable CFStringRef inConformingToUTI) API_DEPRECATED("Use the UTType class instead.", ios(3.0, 15.0), macos(10.3, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
/*
* UTTypeCopyPreferredTagWithClass() *** DEPRECATED ***
*
* Discussion:
* Returns the identified type's preferred tag with the specified
* tag class as a CFString. This is the primary function to use for
* going from uniform type identifier to tag. If the type
* declaration included more than one tag with the specified class,
* the first tag in the declared tag array is the preferred tag.
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Parameters:
*
* inUTI:
* the uniform type identifier
*
* inTagClass:
* the class of tags to return
*
* Result:
* the tag string, or NULL if there is no tag of the specified class.
*/
extern __nullable CFStringRef
UTTypeCopyPreferredTagWithClass(
CFStringRef inUTI,
CFStringRef inTagClass) API_DEPRECATED("Use the UTType class instead.", ios(3.0, 15.0), macos(10.3, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
/*
* UTTypeCopyAllTagsWithClass() *** DEPRECATED ***
*
* Discussion:
* Returns each of the identified type's tags with the specified
* tag class as a CFArray of CFStrings.
*
* Parameters:
*
* inUTI:
* the uniform type identifier
*
* inTagClass:
* the class of tags to return
*
* Result:
* an array of tag strings, or NULL if there is no tag of the specified class.
*/
extern __nullable CFArrayRef
UTTypeCopyAllTagsWithClass(
CFStringRef inUTI,
CFStringRef inTagClass) API_DEPRECATED("Use the UTType class instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
/*
* UTTypeEqual() *** DEPRECATED ***
*
* Discussion:
* Compares two identified types for equality. Types are equal if
* their identifier strings are equal using a case-insensitive
* comparison.
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Parameters:
*
* inUTI1:
* a uniform type identifier
*
* inUTI2:
* another uniform type identifier
*/
extern Boolean
UTTypeEqual(
CFStringRef inUTI1,
CFStringRef inUTI2) API_DEPRECATED("Use -[UTType isEqual:] instead.", ios(3.0, 15.0), macos(10.3, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
/*
* UTTypeConformsTo() *** DEPRECATED ***
*
* Discussion:
* Tests for a conformance relationship between the two identified
* types. Returns true if the types are equal, or if the first type
* conforms, directly or indirectly, to the second type.
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Parameters:
*
* inUTI:
* the uniform type identifier to test
*
* inConformsToUTI:
* the uniform type identifier against which to test conformance.
*/
extern Boolean
UTTypeConformsTo(
CFStringRef inUTI,
CFStringRef inConformsToUTI) API_DEPRECATED("Use -[UTType conformsToType:] instead.", ios(3.0, 15.0), macos(10.3, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
/*
* UTTypeCopyDescription() *** DEPRECATED ***
*
* Discussion:
* Returns the localized, user-readable type description string
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Parameters:
*
* inUTI:
* the uniform type identifier
*
* Result:
* a localized string, or NULL of no type description is available
*/
extern __nullable CFStringRef
UTTypeCopyDescription(CFStringRef inUTI) API_DEPRECATED("Use UTType.localizedDescription instead.", ios(3.0, 15.0), macos(10.3, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
/*
* UTTypeIsDeclared() *** DEPRECATED ***
*
* Discussion:
* Returns whether or not the specified UTI has a declaration
* registered on the current system. Dynamic UTIs are never
* registered.
*
* Parameters:
*
* inUTI:
* the uniform type identifier
*
* Result:
* Whether or not the UTI is registered.
*/
extern Boolean
UTTypeIsDeclared(CFStringRef inUTI) API_DEPRECATED("Use UTType.declared instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
/*
* UTTypeIsDynamic() *** DEPRECATED ***
*
* Discussion:
* Returns whether or not the specified UTI is a dynamic UTI.
*
* Parameters:
*
* inUTI:
* the uniform type identifier
*
* Result:
* Whether or not the UTI is dynamic.
*/
extern Boolean
UTTypeIsDynamic(CFStringRef inUTI) API_DEPRECATED("Use UTType.dynamic instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
/*
* UTTypeCopyDeclaration() *** DEPRECATED ***
*
* Discussion:
* Returns the identified type's declaration dictionary, as it
* appears in the declaring bundle's info property list. This the
* access path to other type properties for which direct access is
* rarely needed.
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Parameters:
*
* inUTI:
* the uniform type identifier
*
* Result:
* a tag declaration dictionary, or NULL if the type is not declared
*/
extern __nullable CFDictionaryRef
UTTypeCopyDeclaration(CFStringRef inUTI) API_DEPRECATED("Use the UTType class instead.", ios(3.0, 15.0), macos(10.3, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
/*
* UTTypeCopyDeclaringBundleURL() *** DEPRECATED ***
*
* Discussion:
* Returns the URL of the bundle containing the type declaration of
* the identified type.
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Parameters:
*
* inUTI:
* the uniform type identifier
*
* Result:
* a URL, or NULL if the bundle cannot be located.
*/
extern __nullable CFURLRef
UTTypeCopyDeclaringBundleURL(CFStringRef inUTI) API_DEPRECATED("", ios(3.0, 14.0), macos(10.3, 11.0), tvos(9.0, 14.0), watchos(1.0, 7.0));
/*
* UTCreateStringForOSType() *** DEPRECATED ***
*
* Discussion:
* A helper function to canonically encode an OSType as a CFString
* suitable for use as a tag argument.
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Parameters:
*
* inOSType:
* the OSType value to encode
*
* Result:
* a new CFString representing the OSType
*/
extern CFStringRef
UTCreateStringForOSType(OSType inOSType) API_DEPRECATED("HFS type codes are obsolete.", macos(10.3, 12.0)) API_UNAVAILABLE(ios, tvos, watchos);
/*
* UTGetOSTypeFromString() *** DEPRECATED ***
*
* Discussion:
* A helper function to canonically decode a string-encoded OSType
* back to the original OSType value.
*
* Mac OS X threading:
* Thread safe since version 10.3
*
* Parameters:
*
* inString:
* the string to decode
*
* Result:
* the OSType value encoded in the string, or 0 if the string is not
* a valid encoding of an OSType
*/
extern OSType
UTGetOSTypeFromString(CFStringRef inString) API_DEPRECATED("HFS type codes are obsolete.", macos(10.3, 12.0)) API_UNAVAILABLE(ios, tvos, watchos);
CF_ASSUME_NONNULL_END
#ifdef __cplusplus
}
#endif
#endif /* __UTTYPE__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/LaunchServices.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/LaunchServices.framework/Headers/UTCoreTypes.h | /*
File: UTCoreTypes.h
Contains: String constants for core uniform type identifiers
Copyright: (c) 2004-2012 by Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __UTCORETYPES__
#define __UTCORETYPES__
#ifndef __COREFOUNDATION__
#include <CoreFoundation/CoreFoundation.h>
#endif
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
CF_ASSUME_NONNULL_BEGIN
#pragma mark - Abstract base types
/*
* kUTTypeItem *** DEPRECATED ***
*
* generic base type for most things
* (files, directories)
*
* UTI: public.item
*
*
* kUTTypeContent *** DEPRECATED ***
*
* base type for anything containing user-viewable document content
* (documents, pasteboard data, and document packages.) Types describing
* files or packages must also conform to kUTTypeData or kUTTypePackage
* in order for the system to bind documents to them.
*
* UTI: public.content
*
*
* kUTTypeCompositeContent *** DEPRECATED ***
*
* base type for content formats supporting mixed embedded content
* (i.e., compound documents)
*
* UTI: public.composite-content
* conforms to: public.content
*
*
* kUTTypeMessage *** DEPRECATED ***
*
* base type for messages (email, IM, etc.)
*
* UTI: public.message
*
*
* kUTTypeContact *** DEPRECATED ***
*
* contact information, e.g. for a person, group, organization
*
* UTI: public.contact
*
*
* kUTTypeArchive *** DEPRECATED ***
*
* an archive of files and directories
*
* UTI: public.archive
*
*
* kUTTypeDiskImage *** DEPRECATED ***
*
* a data item mountable as a volume
*
* UTI: public.disk-image
*
*/
extern const CFStringRef kUTTypeItem API_DEPRECATED("Use UTTypeItem instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeContent API_DEPRECATED("Use UTTypeContent instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeCompositeContent API_DEPRECATED("Use UTTypeCompositeContent instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeMessage API_DEPRECATED("Use UTTypeMessage instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeContact API_DEPRECATED("Use UTTypeContact instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeArchive API_DEPRECATED("Use UTTypeArchive instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeDiskImage API_DEPRECATED("Use UTTypeDiskImage instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
#pragma mark - Concrete base types
/*
* kUTTypeData *** DEPRECATED ***
*
* base type for any sort of simple byte stream,
* including files and in-memory data
*
* UTI: public.data
* conforms to: public.item
*
*
* kUTTypeDirectory *** DEPRECATED ***
*
* file system directory
* (includes packages AND folders)
*
* UTI: public.directory
* conforms to: public.item
*
*
* kUTTypeResolvable *** DEPRECATED ***
*
* symlink and alias file types conform to this UTI
*
* UTI: com.apple.resolvable
*
*
* kUTTypeSymLink *** DEPRECATED ***
*
* a symbolic link
*
* UTI: public.symlink
* conforms to: public.item, com.apple.resolvable
*
*
* kUTTypeExecutable *** DEPRECATED ***
*
* an executable item
* UTI: public.executable
* conforms to: public.item
*
*
* kUTTypeMountPoint *** DEPRECATED ***
*
* a volume mount point (resolvable, resolves to the root dir of a volume)
*
* UTI: com.apple.mount-point
* conforms to: public.item, com.apple.resolvable
*
*
* kUTTypeAliasFile *** DEPRECATED ***
*
* a fully-formed alias file
*
* UTI: com.apple.alias-file
* conforms to: public.data, com.apple.resolvable
*
*
* kUTTypeAliasRecord *** DEPRECATED ***
*
* raw alias data
*
* UTI: com.apple.alias-record
* conforms to: public.data, com.apple.resolvable
*
*
* kUTTypeURLBookmarkData *** DEPRECATED ***
*
* URL bookmark
*
* UTI: com.apple.bookmark
* conforms to: public.data, com.apple.resolvable
*
*/
extern const CFStringRef kUTTypeData API_DEPRECATED("Use UTTypeData instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeDirectory API_DEPRECATED("Use UTTypeDirectory instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeResolvable API_DEPRECATED("Use UTTypeResolvable instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeSymLink API_DEPRECATED("Use UTTypeSymLink instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeExecutable API_DEPRECATED("Use UTTypeExecutable instead.", ios(8.0, 15.0), macos(10.5, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeMountPoint API_DEPRECATED("Use UTTypeMountPoint instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeAliasFile API_DEPRECATED("Use UTTypeAliasFile instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeAliasRecord API_DEPRECATED("The Alias Manager is obsolete.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeURLBookmarkData API_DEPRECATED("Use UTTypeURLBookmarkData instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
#pragma mark - URL types
/*
* kUTTypeURL *** DEPRECATED ***
*
* The bytes of a URL
* (OSType 'url ')
*
* UTI: public.url
* conforms to: public.data
*
*
* kUTTypeFileURL *** DEPRECATED ***
*
* The text of a "file:" URL
* (OSType 'furl')
*
* UTI: public.file-url
* conforms to: public.url
*
*/
extern const CFStringRef kUTTypeURL API_DEPRECATED("Use UTTypeURL instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeFileURL API_DEPRECATED("Use UTTypeFileURL instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
#pragma mark - Text types
/*
* kUTTypeText *** DEPRECATED ***
*
* base type for all text-encoded data,
* including text with markup (HTML, RTF, etc.)
*
* UTI: public.text
* conforms to: public.data, public.content
*
*
* kUTTypePlainText *** DEPRECATED ***
*
* text with no markup, unspecified encoding
*
* UTI: public.plain-text
* conforms to: public.text
*
*
* kUTTypeUTF8PlainText *** DEPRECATED ***
*
* plain text, UTF-8 encoding
* (OSType 'utf8', NSPasteboardType "NSStringPBoardType")
*
* UTI: public.utf8-plain-text
* conforms to: public.plain-text
*
*
* kUTTypeUTF16ExternalPlainText *** DEPRECATED ***
*
* plain text, UTF-16 encoding, with BOM, or if BOM
* is not present, has "external representation"
* byte order (big-endian).
* (OSType 'ut16')
*
* UTI: public.utf16-external-plain-text
* conforms to: public.plain-text
*
*
* kUTTypeUTF16PlainText *** DEPRECATED ***
*
* plain text, UTF-16 encoding, native byte order, optional BOM
* (OSType 'utxt')
*
* UTI: public.utf16-plain-text
* conforms to: public.plain-text
*
*
* kUTTypeDelimitedText *** DEPRECATED ***
*
* text containing delimited values
*
* UTI: public.delimited-values-text
* conforms to: public.text
*
*
* kUTTypeCommaSeparatedText *** DEPRECATED ***
*
* text containing comma-separated values (.csv)
*
* UTI: public.comma-separated-values-text
* conforms to: public.delimited-values-text
*
*
* kUTTypeTabSeparatedText *** DEPRECATED ***
*
* text containing tab-separated values
*
* UTI: public.tab-separated-values-text
* conforms to: public.delimited-values-text
*
*
* kUTTypeUTF8TabSeparatedText *** DEPRECATED ***
*
* UTF-8 encoded text containing tab-separated values
*
* UTI: public.utf8-tab-separated-values-text
* conforms to: public.tab-separated-values-text, public.utf8-plain-text
*
*
* kUTTypeRTF *** DEPRECATED ***
*
* Rich Text Format
*
* UTI: public.rtf
* conforms to: public.text
*
*/
extern const CFStringRef kUTTypeText API_DEPRECATED("Use UTTypeText instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypePlainText API_DEPRECATED("Use UTTypePlainText instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeUTF8PlainText API_DEPRECATED("Use UTTypeUTF8PlainText instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeUTF16ExternalPlainText API_DEPRECATED("Use UTTypeUTF16ExternalPlainText instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeUTF16PlainText API_DEPRECATED("Use UTTypeUTF16PlainText instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeDelimitedText API_DEPRECATED("Use UTTypeDelimitedText instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeCommaSeparatedText API_DEPRECATED("Use UTTypeCommaSeparatedText instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeTabSeparatedText API_DEPRECATED("Use UTTypeTabSeparatedText instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeUTF8TabSeparatedText API_DEPRECATED("Use UTTypeUTF8TabSeparatedText instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeRTF API_DEPRECATED("Use UTTypeRTF instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
#pragma mark - Markup languages
/*
* kUTTypeHTML *** DEPRECATED ***
*
* HTML, any version
*
* UTI: public.html
* conforms to: public.text
*
*
* kUTTypeXML *** DEPRECATED ***
*
* generic XML
*
* UTI: public.xml
* conforms to: public.text
*
*/
extern const CFStringRef kUTTypeHTML API_DEPRECATED("Use UTTypeHTML instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeXML API_DEPRECATED("Use UTTypeXML instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
#pragma mark - Programming languages
/*
* kUTTypeSourceCode *** DEPRECATED ***
*
* abstract type for source code (any language)
*
* UTI: public.source-code
* conforms to: public.plain-text
*
*
* kUTTypeAssemblyLanguageSource *** DEPRECATED ***
*
* assembly language source (.s)
*
* UTI: public.assembly-source
* conforms to: public.source-code
*
*
* kUTTypeCSource *** DEPRECATED ***
*
* C source code (.c)
*
* UTI: public.c-source
* conforms to: public.source-code
*
*
* kUTTypeObjectiveCSource *** DEPRECATED ***
*
* Objective-C source code (.m)
*
* UTI: public.objective-c-source
* conforms to: public.source-code
*
*
* kUTTypeSwiftSource *** DEPRECATED ***
*
* Swift source code (.swift)
*
* UTI: public.swift-source
* conforms to: public.source-code
*
*
* kUTTypeCPlusPlusSource *** DEPRECATED ***
*
* C++ source code (.cp, etc.)
*
* UTI: public.c-plus-plus-source
* conforms to: public.source-code
*
*
* kUTTypeObjectiveCPlusPlusSource *** DEPRECATED ***
*
* Objective-C++ source code
*
* UTI: public.objective-c-plus-plus-source
* conforms to: public.source-code
*
*
* kUTTypeCHeader *** DEPRECATED ***
*
* C header
*
* UTI: public.c-header
* conforms to: public.source-code
*
*
* kUTTypeCPlusPlusHeader *** DEPRECATED ***
*
* C++ header
*
* UTI: public.c-plus-plus-header
* conforms to: public.source-code
*
*
* kUTTypeJavaSource *** DEPRECATED ***
*
* Java source code
*
* UTI: com.sun.java-source
* conforms to: public.source-code
*
*/
extern const CFStringRef kUTTypeSourceCode API_DEPRECATED("Use UTTypeSourceCode instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeAssemblyLanguageSource API_DEPRECATED("Use UTTypeAssemblyLanguageSource instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeCSource API_DEPRECATED("Use UTTypeCSource instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeObjectiveCSource API_DEPRECATED("Use UTTypeObjectiveCSource instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeSwiftSource API_DEPRECATED("Use UTTypeSwiftSource instead.", ios(9.0, 15.0), macos(10.11, 12.0), tvos(9.0, 15.0), watchos(2.0, 8.0));
extern const CFStringRef kUTTypeCPlusPlusSource API_DEPRECATED("Use UTTypeCPlusPlusSource instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeObjectiveCPlusPlusSource API_DEPRECATED("Use UTTypeObjectiveCPlusPlusSource instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeCHeader API_DEPRECATED("Use UTTypeCHeader instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeCPlusPlusHeader API_DEPRECATED("Use UTTypeCPlusPlusHeader instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeJavaSource API_DEPRECATED("Java support is no longer provided by this operating system. Install a JDK to use Java.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
#pragma mark - Scripting languages
/*
* kUTTypeScript *** DEPRECATED ***
*
* scripting language source
*
* UTI: public.script
* conforms to: public.source-code
*
*
* kUTTypeAppleScript *** DEPRECATED ***
*
* AppleScript text format (.applescript)
*
* UTI: com.apple.applescript.text
* conforms to: public.script
*
*
* kUTTypeOSAScript *** DEPRECATED ***
*
* Open Scripting Architecture script binary format (.scpt)
*
* UTI: com.apple.applescript.script
* conforms to: public.data, public.script
*
*
* kUTTypeOSAScriptBundle *** DEPRECATED ***
*
* Open Scripting Architecture script bundle format (.scptd)
*
* UTI: com.apple.applescript.script-bundle
* conforms to: com.apple.bundle, com.apple.package, public.script
*
*
* kUTTypeJavaScript *** DEPRECATED ***
*
* JavaScript source code
*
* UTI: com.netscape.javascript-source
* conforms to: public.source-code, public.executable
*
*
* kUTTypeShellScript *** DEPRECATED ***
*
* base type for shell scripts
*
* UTI: public.shell-script
* conforms to: public.script
*
*
* kUTTypePerlScript *** DEPRECATED ***
*
* Perl script
*
* UTI: public.perl-script
* conforms to: public.shell-script
*
*
* kUTTypePythonScript *** DEPRECATED ***
*
* Python script
*
* UTI: public.python-script
* conforms to: public.shell-script
*
*
* kUTTypeRubyScript *** DEPRECATED ***
*
* Ruby script
*
* UTI: public.ruby-script
* conforms to: public.shell-script
*
*
* kUTTypePHPScript *** DEPRECATED ***
*
* PHP script
*
* UTI: public.php-script
* conforms to: public.shell-script
*
*/
extern const CFStringRef kUTTypeScript API_DEPRECATED("Use UTTypeScript instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeAppleScript API_DEPRECATED("Use UTTypeAppleScript instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeOSAScript API_DEPRECATED("Use UTTypeOSAScript instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeOSAScriptBundle API_DEPRECATED("Use UTTypeOSAScriptBundle instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeJavaScript API_DEPRECATED("Use UTTypeJavaScript instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeShellScript API_DEPRECATED("Use UTTypeShellScript instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypePerlScript API_DEPRECATED("Use UTTypePerlScript instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypePythonScript API_DEPRECATED("Use UTTypePythonScript instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeRubyScript API_DEPRECATED("Use UTTypeRubyScript instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypePHPScript API_DEPRECATED("Use UTTypePHPScript instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
#pragma mark - Serialized data types
/*
* kUTTypeJSON *** DEPRECATED ***
*
* JavaScript object notation (JSON) data
* NOTE: JSON almost but doesn't quite conform to
* com.netscape.javascript-source
*
* UTI: public.json
* conforms to: public.text
*
*
* kUTTypePropertyList *** DEPRECATED ***
*
* base type for property lists
*
* UTI: com.apple.property-list
* conforms to: public.data
*
*
* kUTTypeXMLPropertyList *** DEPRECATED ***
*
* XML property list
*
* UTI: com.apple.xml-property-list
* conforms to: public.xml, com.apple.property-list
*
*
* kUTTypeBinaryPropertyList *** DEPRECATED ***
*
* XML property list
*
* UTI: com.apple.binary-property-list
* conforms to: com.apple.property-list
*
*/
extern const CFStringRef kUTTypeJSON API_DEPRECATED("Use UTTypeJSON instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypePropertyList API_DEPRECATED("Use UTTypePropertyList instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeXMLPropertyList API_DEPRECATED("Use UTTypeXMLPropertyList instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeBinaryPropertyList API_DEPRECATED("Use UTTypeBinaryPropertyList instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
#pragma mark - Composite content types
/*
* kUTTypePDF *** DEPRECATED ***
*
* Adobe PDF
*
* UTI: com.adobe.pdf
* conforms to: public.data, public.composite-content
*
*
* kUTTypeRTFD *** DEPRECATED ***
*
* Rich Text Format Directory
* (RTF with content embedding, on-disk format)
*
* UTI: com.apple.rtfd
* conforms to: com.apple.package, public.composite-content
*
*
* kUTTypeFlatRTFD *** DEPRECATED ***
*
* Flattened RTFD (pasteboard format)
*
* UTI: com.apple.flat-rtfd
* conforms to: public.data, public.composite-content
*
*
* kUTTypeTXNTextAndMultimediaData *** DEPRECATED ***
*
* MLTE (Textension) format for mixed text & multimedia data
* (OSType 'txtn')
*
* UTI: com.apple.txn.text-multimedia-data
* conforms to: public.data, public.composite-content
*
*
* kUTTypeWebArchive *** DEPRECATED ***
*
* The WebKit webarchive format
*
* UTI: com.apple.webarchive
* conforms to: public.data, public.composite-content
*/
extern const CFStringRef kUTTypePDF API_DEPRECATED("Use UTTypePDF instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeRTFD API_DEPRECATED("Use UTTypeRTFD instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeFlatRTFD API_DEPRECATED("Use UTTypeFlatRTFD instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeTXNTextAndMultimediaData API_DEPRECATED("The Multilingual Text Engine is obsolete.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeWebArchive API_DEPRECATED("Use UTTypeWebArchive instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
#pragma mark - Image content types
/*
* kUTTypeImage *** DEPRECATED ***
*
* abstract image data
*
* UTI: public.image
* conforms to: public.data, public.content
*
*
* kUTTypeJPEG *** DEPRECATED ***
*
* JPEG image
*
* UTI: public.jpeg
* conforms to: public.image
*
*
* kUTTypeJPEG2000 *** DEPRECATED ***
*
* JPEG-2000 image
*
* UTI: public.jpeg-2000
* conforms to: public.image
*
*
* kUTTypeTIFF *** DEPRECATED ***
*
* TIFF image
*
* UTI: public.tiff
* conforms to: public.image
*
*
* kUTTypePICT *** DEPRECATED ***
*
* Quickdraw PICT format
*
* UTI: com.apple.pict
* conforms to: public.image
*
*
* kUTTypeGIF *** DEPRECATED ***
*
* GIF image
*
* UTI: com.compuserve.gif
* conforms to: public.image
*
*
* kUTTypePNG *** DEPRECATED ***
*
* PNG image
*
* UTI: public.png
* conforms to: public.image
*
*
* kUTTypeQuickTimeImage *** DEPRECATED ***
*
* QuickTime image format (OSType 'qtif')
*
* UTI: com.apple.quicktime-image
* conforms to: public.image
*
*
* kUTTypeAppleICNS *** DEPRECATED ***
*
* Apple icon data
*
* UTI: com.apple.icns
* conforms to: public.image
*
*
* kUTTypeBMP *** DEPRECATED ***
*
* Windows bitmap
*
* UTI: com.microsoft.bmp
* conforms to: public.image
*
*
* kUTTypeICO *** DEPRECATED ***
*
* Windows icon data
*
* UTI: com.microsoft.ico
* conforms to: public.image
*
*
* kUTTypeRawImage *** DEPRECATED ***
*
* base type for raw image data (.raw)
*
* UTI: public.camera-raw-image
* conforms to: public.image
*
*
* kUTTypeScalableVectorGraphics *** DEPRECATED ***
*
* SVG image
*
* UTI: public.svg-image
* conforms to: public.image
*
* kUTTypeLivePhoto *** DEPRECATED ***
*
* Live Photo
*
* UTI: com.apple.live-photo
*
*
*/
extern const CFStringRef kUTTypeImage API_DEPRECATED("Use UTTypeImage instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeJPEG API_DEPRECATED("Use UTTypeJPEG instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeJPEG2000 API_DEPRECATED("JPEG2000 is no longer supported by this operating system.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeTIFF API_DEPRECATED("Use UTTypeTIFF instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypePICT API_DEPRECATED("QuickDraw is obsolete.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeGIF API_DEPRECATED("Use UTTypeGIF instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypePNG API_DEPRECATED("Use UTTypePNG instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeQuickTimeImage API_DEPRECATED("The QuickTime Image file format is obsolete.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeAppleICNS API_DEPRECATED("Use UTTypeICNS instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeBMP API_DEPRECATED("Use UTTypeBMP instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeICO API_DEPRECATED("Use UTTypeICO instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeRawImage API_DEPRECATED("Use UTTypeRAWImage instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeScalableVectorGraphics API_DEPRECATED("Use UTTypeSVG instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeLivePhoto API_DEPRECATED("Use UTTypeLivePhoto instead.", ios(9.1, 15.0), macos(10.12, 12.0), tvos(9.0, 15.0), watchos(2.1, 8.0));
#pragma mark - Audiovisual content types
/*
* kUTTypeAudiovisualContent *** DEPRECATED ***
*
* audio and/or video content
*
* UTI: public.audiovisual-content
* conforms to: public.data, public.content
*
*
* kUTTypeMovie *** DEPRECATED ***
*
* A media format which may contain both video and audio
* Corresponds to what users would label a "movie"
*
* UTI: public.movie
* conforms to: public.audiovisual-content
*
*
* kUTTypeVideo *** DEPRECATED ***
*
* pure video (no audio)
*
* UTI: public.video
* conforms to: public.movie
*
*
* kUTTypeAudio *** DEPRECATED ***
*
* pure audio (no video)
*
* UTI: public.audio
* conforms to: public.audiovisual-content
*
*
* kUTTypeQuickTimeMovie *** DEPRECATED ***
*
* QuickTime movie
*
* UTI: com.apple.quicktime-movie
* conforms to: public.movie
*
*
* kUTTypeMPEG *** DEPRECATED ***
*
* MPEG-1 or MPEG-2 movie
*
* UTI: public.mpeg
* conforms to: public.movie
*
*
* kUTTypeMPEG2Video *** DEPRECATED ***
*
* MPEG-2 video
*
* UTI: public.mpeg-2-video
* conforms to: public.video
*
*
* kUTTypeMPEG2TransportStream *** DEPRECATED ***
*
* MPEG-2 Transport Stream movie format
*
* UTI: public.mpeg-2-transport-stream
* conforms to: public.movie
*
*
* kUTTypeMP3 *** DEPRECATED ***
*
* MP3 audio
*
* UTI: public.mp3
* conforms to: public.audio
*
*
* kUTTypeMPEG4 *** DEPRECATED ***
*
* MPEG-4 movie
*
* UTI: public.mpeg-4
* conforms to: public.movie
*
*
* kUTTypeMPEG4Audio *** DEPRECATED ***
*
* MPEG-4 audio layer
*
* UTI: public.mpeg-4-audio
* conforms to: public.mpeg-4, public.audio
*
*
* kUTTypeAppleProtectedMPEG4Audio *** DEPRECATED ***
*
* Apple protected MPEG4 format
* (.m4p, iTunes music store format)
*
* UTI: com.apple.protected-mpeg-4-audio
* conforms to: public.audio
*
*
* kUTTypeAppleProtectedMPEG4Video *** DEPRECATED ***
*
* Apple protected MPEG-4 movie
*
* UTI: com.apple.protected-mpeg-4-video
* conforms to: com.apple.m4v-video
*
*
* kUTTypeAVIMovie *** DEPRECATED ***
*
* Audio Video Interleaved (AVI) movie format
*
* UTI: public.avi
* conforms to: public.movie
*
*
* kUTTypeAudioInterchangeFileFormat *** DEPRECATED ***
*
* AIFF audio format
*
* UTI: public.aiff-audio
* conforms to: public.aifc-audio
*
*
* kUTTypeWaveformAudio *** DEPRECATED ***
*
* Waveform audio format (.wav)
*
* UTI: com.microsoft.waveform-audio
* conforms to: public.audio
*
*
* kUTTypeMIDIAudio *** DEPRECATED ***
*
* MIDI audio format
*
* UTI: public.midi-audio
* conforms to: public.audio
*
*
*/
extern const CFStringRef kUTTypeAudiovisualContent API_DEPRECATED("Use UTTypeAudiovisualContent instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeMovie API_DEPRECATED("Use UTTypeMovie instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeVideo API_DEPRECATED("Use UTTypeVideo instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeAudio API_DEPRECATED("Use UTTypeAudio instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeQuickTimeMovie API_DEPRECATED("Use UTTypeQuickTimeMovie instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeMPEG API_DEPRECATED("Use UTTypeMPEG instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeMPEG2Video API_DEPRECATED("Use UTTypeMPEG2Video instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeMPEG2TransportStream API_DEPRECATED("Use UTTypeMPEG2TransportStream instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeMP3 API_DEPRECATED("Use UTTypeMP3 instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeMPEG4 API_DEPRECATED("Use UTTypeMPEG4Movie instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeMPEG4Audio API_DEPRECATED("Use UTTypeMPEG4Audio instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeAppleProtectedMPEG4Audio API_DEPRECATED("Use UTTypeAppleProtectedMPEG4Audio instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeAppleProtectedMPEG4Video API_DEPRECATED("Use UTTypeAppleProtectedMPEG4Video instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeAVIMovie API_DEPRECATED("Use UTTypeAVI instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeAudioInterchangeFileFormat API_DEPRECATED("Use UTTypeAIFF instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeWaveformAudio API_DEPRECATED("Use UTTypeWAV instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeMIDIAudio API_DEPRECATED("Use UTTypeMIDI instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
/*
* kUTTypePlaylist *** DEPRECATED ***
*
* base type for playlists
*
* UTI: public.playlist
*
*
* kUTTypeM3UPlaylist *** DEPRECATED ***
*
* M3U or M3U8 playlist
*
* UTI: public.m3u-playlist
* conforms to: public.text, public.playlist
*
*/
extern const CFStringRef kUTTypePlaylist API_DEPRECATED("Use UTTypePlaylist instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeM3UPlaylist API_DEPRECATED("Use UTTypeM3UPlaylist instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
#pragma mark - Directory types
/*
* kUTTypeFolder *** DEPRECATED ***
*
* a user-browsable directory (i.e., not a package)
*
* UTI: public.folder
* conforms to: public.directory
*
*
* kUTTypeVolume *** DEPRECATED ***
*
* the root folder of a volume/mount point
*
* UTI: public.volume
* conforms to: public.folder
*
*
* kUTTypePackage *** DEPRECATED ***
*
* a packaged directory
*
* UTI: com.apple.package
* conforms to: public.directory
*
*
* kUTTypeBundle *** DEPRECATED ***
*
* a directory conforming to one of the CFBundle layouts
*
* UTI: com.apple.bundle
* conforms to: public.directory
*
*
* kUTTypePluginBundle *** DEPRECATED ***
*
* base type for bundle-based plugins
*
* UTI: com.apple.plugin
* conforms to: com.apple.bundle, com.apple.package
*
*
* kUTTypeSpotlightImporter *** DEPRECATED ***
*
* a Spotlight metadata importer
*
* UTI: com.apple.metadata-importer
* conforms to: com.apple.plugin
*
*
* kUTTypeQuickLookGenerator *** DEPRECATED ***
*
* a QuickLook preview generator
*
* UTI: com.apple.quicklook-generator
* conforms to: com.apple.plugin
*
*
* kUTTypeXPCService *** DEPRECATED ***
*
* an XPC service
*
* UTI: com.apple.xpc-service
* conforms to: com.apple.bundle, com.apple.package
*
*
* kUTTypeFramework *** DEPRECATED ***
*
* a Mac OS X framework
*
* UTI: com.apple.framework
* conforms to: com.apple.bundle
*
*/
extern const CFStringRef kUTTypeFolder API_DEPRECATED("Use UTTypeFolder instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeVolume API_DEPRECATED("Use UTTypeVolume instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypePackage API_DEPRECATED("Use UTTypePackage instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeBundle API_DEPRECATED("Use UTTypeBundle instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypePluginBundle API_DEPRECATED("Use UTTypePluginBundle instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeSpotlightImporter API_DEPRECATED("Use UTTypeSpotlightImporter instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeQuickLookGenerator API_DEPRECATED("Use UTTypeQuickLookGenerator instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeXPCService API_DEPRECATED("Use UTTypeXPCService instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeFramework API_DEPRECATED("Use UTTypeFramework instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
#pragma mark - Application and executable types
/*
* kUTTypeApplication *** DEPRECATED ***
*
* base type for OS X applications, launchable items
*
* UTI: com.apple.application
* conforms to: public.executable
*
*
* kUTTypeApplicationBundle *** DEPRECATED ***
*
* a bundled application
*
* UTI: com.apple.application-bundle
* conforms to: com.apple.application, com.apple.bundle, com.apple.package
*
*
* kUTTypeApplicationFile *** DEPRECATED ***
*
* a single-file Carbon/Classic application
*
* UTI: com.apple.application-file
* conforms to: com.apple.application, public.data
*
*
* kUTTypeUnixExecutable *** DEPRECATED ***
*
* a UNIX executable (flat file)
*
* UTI: public.unix-executable
* conforms to: public.data, public.executable
*
*
* kUTTypeWindowsExecutable *** DEPRECATED ***
*
* a Windows executable (.exe files)
*
* UTI: com.microsoft.windows-executable
* conforms to: public.data, public.executable
*
*
* kUTTypeJavaClass *** DEPRECATED ***
*
* a Java class
*
* UTI: com.sun.java-class
* conforms to: public.data, public.executable
*
*
* kUTTypeJavaArchive *** DEPRECATED ***
*
* a Java archive (.jar)
*
* UTI: com.sun.java-archive
* conforms to: public.zip-archive, public.executable
*
*
* kUTTypeSystemPreferencesPane *** DEPRECATED ***
*
* a System Preferences pane
*
* UTI: com.apple.systempreference.prefpane
* conforms to: com.apple.package, com.apple.bundle
*
*/
// Abstract executable types
extern const CFStringRef kUTTypeApplication API_DEPRECATED("Use UTTypeApplication instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeApplicationBundle API_DEPRECATED("Use UTTypeApplicationBundle instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeApplicationFile API_DEPRECATED("Classic applications are obsolete.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeUnixExecutable API_DEPRECATED("Use UTTypeUnixExecutable instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
// Other platform binaries
extern const CFStringRef kUTTypeWindowsExecutable API_DEPRECATED("Use UTTypeEXE instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeJavaClass API_DEPRECATED("Java support is no longer provided by this operating system. Install a JDK to use Java.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeJavaArchive API_DEPRECATED("Java support is no longer provided by this operating system. Install a JDK to use Java.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
// Misc. binaries
extern const CFStringRef kUTTypeSystemPreferencesPane API_DEPRECATED("Use UTTypeSystemPreferencesPane instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
#pragma mark - Archival and compression types
/*
* kUTTypeGNUZipArchive *** DEPRECATED ***
*
* a GNU zip archive (gzip)
*
* UTI: org.gnu.gnu-zip-archive
* conforms to: public.data, public.archive
*
*
* kUTTypeBzip2Archive *** DEPRECATED ***
*
* a bzip2 archive (.bz2)
*
* UTI: public.bzip2-archive
* conforms to: public.data, public.archive
*
*
* kUTTypeZipArchive *** DEPRECATED ***
*
* a zip archive
*
* UTI: public.zip-archive
* conforms to: com.pkware.zip-archive
*
*/
extern const CFStringRef kUTTypeGNUZipArchive API_DEPRECATED("Use UTTypeGZIP instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeBzip2Archive API_DEPRECATED("Use UTTypeBZ2 instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeZipArchive API_DEPRECATED("Use UTTypeZIP instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
#pragma mark - Document types
/*
* kUTTypeSpreadsheet *** DEPRECATED ***
*
* base spreadsheet document type
*
* UTI: public.spreadsheet
* conforms to: public.content
*
*
* kUTTypePresentation *** DEPRECATED ***
*
* base presentation document type
*
* UTI: public.presentation
* conforms to: public.composite-content
*
*
* kUTTypeDatabase *** DEPRECATED ***
*
* a database store
*
* UTI: public.database
*
*/
extern const CFStringRef kUTTypeSpreadsheet API_DEPRECATED("Use UTTypeSpreadsheet instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypePresentation API_DEPRECATED("Use UTTypePresentation instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeDatabase API_DEPRECATED("Use UTTypeDatabase instead.", ios(8.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
#pragma mark - Messages, contacts, and calendar types
/*
* kUTTypeVCard *** DEPRECATED ***
*
* VCard format
*
* UTI: public.vcard
* conforms to: public.text, public.contact
*
*
* kUTTypeToDoItem *** DEPRECATED ***
*
* to-do item
*
* UTI: public.to-do-item
*
*
* kUTTypeCalendarEvent *** DEPRECATED ***
*
* calendar event
*
* UTI: public.calendar-event
*
*
* kUTTypeEmailMessage *** DEPRECATED ***
*
* e-mail message
*
* UTI: public.email-message
* conforms to: public.message
*
*/
extern const CFStringRef kUTTypeVCard API_DEPRECATED("Use UTTypeVCard instead.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeToDoItem API_DEPRECATED("Use UTTypeToDoItem instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeCalendarEvent API_DEPRECATED("Use UTTypeCalendarEvent instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeEmailMessage API_DEPRECATED("Use UTTypeEmailMessage instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
#pragma mark - Internet locations
/*
* kUTTypeInternetLocation *** DEPRECATED ***
*
* base type for Apple Internet locations
*
* UTI: com.apple.internet-location
* conforms to: public.data
*
*/
extern const CFStringRef kUTTypeInternetLocation API_DEPRECATED("Use UTTypeInternetLocation instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
#pragma mark - Miscellaneous types
/*
* kUTTypeInkText *** DEPRECATED ***
*
* Opaque InkText data
*
* UTI: com.apple.ink.inktext
* conforms to: public.data
*
*
* kUTTypeFont *** DEPRECATED ***
*
* base type for fonts
*
* UTI: public.font
*
*
* kUTTypeBookmark *** DEPRECATED ***
*
* bookmark
*
* UTI: public.bookmark
*
*
* kUTType3DContent *** DEPRECATED ***
*
* base type for 3D content
*
* UTI: public.3d-content
* conforms to: public.content
*
*
* kUTTypePKCS12 *** DEPRECATED ***
*
* PKCS#12 format
*
* UTI: com.rsa.pkcs-12
* conforms to: public.data
*
*
* kUTTypeX509Certificate *** DEPRECATED ***
*
* X.509 certificate format
*
* UTI: public.x509-certificate
* conforms to: public.data
*
*
* kUTTypeElectronicPublication *** DEPRECATED ***
*
* ePub format
*
* UTI: org.idpf.epub-container
* conforms to: public.data, public.composite-content
*
*
* kUTTypeLog *** DEPRECATED ***
*
* console log
*
* UTI: public.log
*
*/
extern const CFStringRef kUTTypeInkText API_DEPRECATED("The Ink framework is obsolete.", ios(3.0, 15.0), macos(10.4, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeFont API_DEPRECATED("Use UTTypeFont instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeBookmark API_DEPRECATED("Use UTTypeBookmark instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTType3DContent API_DEPRECATED("Use UTType3DContent instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypePKCS12 API_DEPRECATED("Use UTTypePKCS12 instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeX509Certificate API_DEPRECATED("Use UTTypeX509Certificate instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeElectronicPublication API_DEPRECATED("Use UTTypeEPUB instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
extern const CFStringRef kUTTypeLog API_DEPRECATED("Use UTTypeLog instead.", ios(8.0, 15.0), macos(10.10, 12.0), tvos(9.0, 15.0), watchos(1.0, 8.0));
CF_ASSUME_NONNULL_END
#ifdef __cplusplus
}
#endif
#endif /* __UTCORETYPES__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/LaunchServices.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/LaunchServices.framework/Headers/LSQuarantine.h | /*
File: LSQuarantine.h
Contains: File quarantine property keys
Copyright: (c) 2003-2012 by Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __LSQUARANTINE__
#define __LSQUARANTINE__
#ifndef __COREFOUNDATION__
#include <CoreFoundation/CoreFoundation.h>
#endif
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
CF_ASSUME_NONNULL_BEGIN
/*
* The following keys may appear in a quarantine properties dictionary. To access a
* file's quarantine properties dictionary, fetch the kCFURLQuarantinePropertiesKey
* property using CFURLCopyResourcePropertyForKey() or CFURLCopyResourcePropertiesForKeys().
* The quarantine property dictionary can be set using CFURLSetResourcePropertyForKey().
*
*
* kLSQuarantineAgentNameKey - value type CFStringRef
*
* The name of the quarantining agent (application or program). When setting quarantine
* properties, this value is set automatically to the current process name if this key is not
* present in the caller's dictionary.
*
*
* kLSQuarantineAgentBundleIdentifierKey - value type CFStringRef
*
* The bundle identifier of the quarantining agent, if available. When setting quarantine
* properties, this value is set automatically if the key is not present in the caller's
* dictionary. The automatic value is the main bundle identifier of the current process.
*
*
* kLSQuarantineTimeStampKey - value type CFDateRef
*
* The date and time the item was quarantined. When setting quarantine properties,
* this property is set automatically to the current date and time if this key is not present
* in the caller's dictionary.
*
*
* kLSQuarantineTypeKey - value type CFStringRef
*
* A symbolic string identifying the why the item is quarantined, if available.
* The value is one of the following:
*
* kLSQuarantineTypeWebDownload
* kLSQuarantineTypeOtherDownload
* kLSQuarantineTypeEmailAttachment
* kLSQuarantineTypeInstantMessageAttachment
* kLSQuarantineTypeCalendarEventAttachment
* kLSQuarantineTypeOtherAttachment
*
*
* kLSQuarantineDataURLKey - value type CFURLRef
*
* The URL from which the data for the quarantined item data was actually streamed
* or downloaded, if available.
*
*
* kLSQuarantineOriginURLKey - value type CFURLRef
*
* The URL of the resource originally hosting the quarantined item, from the user's point of
* view. For web downloads, this property is the URL of the web page on which the user initiated
* the download. For attachments, this property is the URL of the resource to which the quarantined
* item was attached (e.g. the email message, calendar event, etc.). The origin URL may be a file URL
* for local resources, or a custom URL to which the quarantining application will respond when asked
* to open it. The quarantining application should respond by displaying the resource to the user.
* Note: The origin URL should not be set to the data URL, or the quarantining application may start
* downloading the file again if the user choses to view the origin URL while resolving a quarantine
* warning.
*
*/
/*
* kLSQuarantineAgentNameKey
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern const CFStringRef kLSQuarantineAgentNameKey API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* kLSQuarantineAgentBundleIdentifierKey
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern const CFStringRef kLSQuarantineAgentBundleIdentifierKey API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* kLSQuarantineTimeStampKey
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern const CFStringRef kLSQuarantineTimeStampKey API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* kLSQuarantineTypeKey
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern const CFStringRef kLSQuarantineTypeKey API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* kLSQuarantineTypeWebDownload
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern const CFStringRef kLSQuarantineTypeWebDownload API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* kLSQuarantineTypeOtherDownload
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern const CFStringRef kLSQuarantineTypeOtherDownload API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* kLSQuarantineTypeEmailAttachment
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern const CFStringRef kLSQuarantineTypeEmailAttachment API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* kLSQuarantineTypeInstantMessageAttachment
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern const CFStringRef kLSQuarantineTypeInstantMessageAttachment API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* kLSQuarantineTypeCalendarEventAttachment
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern const CFStringRef kLSQuarantineTypeCalendarEventAttachment API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* kLSQuarantineTypeOtherAttachment
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern const CFStringRef kLSQuarantineTypeOtherAttachment API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* kLSQuarantineOriginURLKey
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern const CFStringRef kLSQuarantineOriginURLKey API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* kLSQuarantineDataURLKey
*
* Availability:
* Mac OS X: in version 10.5 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern const CFStringRef kLSQuarantineDataURLKey API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos );
CF_ASSUME_NONNULL_END
#endif /* __LSQUARANTINE__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/LaunchServices.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/LaunchServices.framework/Headers/LSOpenDeprecated.h | /*
File: LSOpenDeprecated.h
Contains: Deprecated interfaces for LaunchServices.framework
Copyright: (c) 2003-2015 by Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __LSOPENDEPRECATED__
#define __LSOPENDEPRECATED__
#include <LaunchServices/LSOpen.h>
#ifdef __cplusplus
extern "C" {
#endif
#pragma pack(push, 2)
enum {
kLSLaunchInhibitBGOnly API_DEPRECATED("This option does nothing.", macos(10.0,10.12) ) API_UNAVAILABLE( ios, tvos, watchos ) = 0x00000080, /* Does nothing.*/
kLSLaunchNoParams API_DEPRECATED("This option does nothing.", macos(10.0,10.12) ) API_UNAVAILABLE( ios, tvos, watchos ) = 0x00000800, /* Does nothing.*/
kLSLaunchStartClassic API_DEPRECATED("The Classic environment is no longer supported.", macos(10.0,10.11) ) API_UNAVAILABLE( ios, tvos, watchos ) = 0x00020000, /* Does nothing.*/
kLSLaunchInClassic API_DEPRECATED("The Classic environment is no longer supported.", macos(10.0,10.11) ) API_UNAVAILABLE( ios, tvos, watchos ) = 0x00040000, /* Always fails with kLSNoClassicEnvironmentErr.*/
kLSLaunchHasUntrustedContents API_DEPRECATED("This option does nothing.", macos(10.4,10.12) ) API_UNAVAILABLE( ios, tvos, watchos ) = 0x00400000, /* Does nothing.*/
};
#if TARGET_OS_OSX
typedef struct LSLaunchFSRefSpec {
const FSRef * appRef; /* app to use, can be NULL*/
ItemCount numDocs; /* items to open/print, can be zero*/
const FSRef * itemRefs; /* array of FSRefs, ignored when numDocs is zero*/
const AEDesc * passThruParams; /* passed untouched to application as optional event parameter, */
/* with keyword keyAEPropData (can be NULL)*/
LSLaunchFlags launchFlags;
void * asyncRefCon; /* used if you register for app birth/death notification*/
} LSLaunchFSRefSpec API_DEPRECATED("Use LSLaunchURLSpec instead.", macos(10.0,10.10) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* LSOpenFSRef() *** DEPRECATED ***
*
* Summary:
* Open an application, document, or folder.
*
* Discussion:
* Opens applications, documents, and folders. Applications are
* opened via an 'oapp' or 'rapp' event. Documents are opened in
* their user-overridden or default applications as appropriate.
* Folders are opened in the Finder. Use the more specific
* LSOpenFromRefSpec for more control over launching.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* inRef:
* The FSRef of the item to launch.
*
* outLaunchedRef:
* The FSRef of the item actually launched. For inRefs that are
* documents, outLaunchedRef will be the application used to
* launch the document. Can be NULL.
*
* Deprecated:
* Use LSOpenCFURLRef or -[NSWorkspace openURL:] instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x
* Non-Carbon CFM: not available
*/
extern OSStatus
LSOpenFSRef(
const FSRef * inRef,
FSRef * outLaunchedRef) /* can be NULL */ API_DEPRECATED("Use LSOpenCFURLRef or -[NSWorkspace openURL:] instead.", macos(10.0,10.10) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* LSOpenFromRefSpec() *** DEPRECATED ***
*
* Summary:
* Opens an application or one or more documents or folders.
*
* Discussion:
* Opens applications, documents, and folders.
*
* Mac OS X threading:
* Thread safe since version 10.2
*
* Parameters:
*
* inLaunchSpec:
* The specification of what to launch and how to launch it.
*
* outLaunchedRef:
* The FSRef of the item actually launched. For inRefs that are
* documents, outLaunchedRef will be the application used to
* launch the document. Can be NULL.
*
* Deprecated:
* Use LSOpenFromURLSpec or NSWorkspace instead.
*
* Availability:
* Mac OS X: in version 10.0 and later in CoreServices.framework
* CarbonLib: not available in CarbonLib 1.x
* Non-Carbon CFM: not available
*/
extern OSStatus
LSOpenFromRefSpec(
const LSLaunchFSRefSpec * inLaunchSpec,
FSRef * outLaunchedRef) /* can be NULL */ API_DEPRECATED("Use LSOpenFromURLSpec or NSWorkspace instead.", macos(10.0,10.10) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* LSApplicationParameters *** DEPRECATED ***
*
* This structure is used by the new LSOpen functions to specify
* an application, launch flags, and additional parameters
* controlling how an application is launched.
*
* A version field allows the structure to be extended in
* future releases.
*
* Deprecated:
* Use NSWorkspace instead.
*
*/
typedef struct LSApplicationParameters {
CFIndex version; /* This must be set to zero by the client */
LSLaunchFlags flags; /* See the LSLaunchFlags enum */
const FSRef * application; /* The application to open (and possibly handle documents/URLs) */
void * asyncLaunchRefCon; /* The client refCon which will appear in subsequent launch notifications */
CFDictionaryRef environment; /* Environment variables to set in the launched process */
/* (a dictionary of CFStringRef keys and values). Can be NULL. */
CFArrayRef argv; /* Note: argv is ignored on 10.4. On 10.5 and later, the array elements */
/* (which must be CFStringRefs) are passed as arguments to main() in the launched process. */
AppleEvent * initialEvent; /* The first Apple Event to be sent to the launched process. Can be NULL. */
} LSApplicationParameters API_DEPRECATED("Use NSWorkspace instead.", macos(10.4,10.10) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* LSOpenApplication() *** DEPRECATED ***
*
* LSOpenApplication launches one application. This function
* is an updated alternative to the Process Manager's LaunchApplication().
*
* Launch arguments are specified in the inAppParams argument, which
* must be supplied. If the application is already running in the current
* session, it will be made the front process (unless the kLSLaunchNewInstance
* flag is used, which will always cause a new process to be created).
*
* If outPSN is not NULL, the structure it points to will contain the process
* serial number of the launched (or activated) process. Note that for
* asynchronous launches, the application may not have finished launching
* when this function returns.
*
* Mac OS X threading:
* Thread safe since version 10.4
*
* Deprecated:
* Use -[NSWorkspace launchApplicationAtURL:options:configuration:error:] instead.
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern OSStatus
LSOpenApplication(
const LSApplicationParameters * appParams,
ProcessSerialNumber * outPSN) /* can be NULL */ API_DEPRECATED("Use -[NSWorkspace launchApplicationAtURL:options:configuration:error:] instead.", macos(10.4,10.10) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* LSOpenItemsWithRole() *** DEPRECATED ***
*
* Opens the items specified as an array of FSRefs with the role
* specified by inRoleMask. If the role doesn't matter, use kLSRolesAll.
*
* Clients can optionally specify the application and launch parameters
* in inAppParams. If a specific application is given in inAppParams, then
* inRoleMask is ignored and the application is launched (if necessary).
* Otherwise, an application will be selected which can handle each input
* item in the specified role(s).
*
* Each launched application will receive an 'odoc' Apple Event specifying
* which items are to be opened.
*
* Note that if the input items array contains any applications, this
* function will not launch them unless the kLSRolesShell bit is set
* in the inRolesMask (in which case the application is its own shell).
*
* The optional inAEParam argument specifies an AEDesc to be attached to
* the Apple Event(s) generated by Launch Services with the specified
* AEKeyword.
*
* If not NULL, the outPSNs buffer will be filled with the PSN which
* was used to open each item at the same index of the input FSRef array. The
* PSN capacity of the output buffer is specified by inMaxPSNCount.
*
* Mac OS X threading:
* Thread safe since version 10.4
*
* Deprecated:
* Use NSWorkspace instead.
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern OSStatus
LSOpenItemsWithRole(
const FSRef * inItems,
CFIndex inItemCount,
LSRolesMask inRole,
const AEKeyDesc * inAEParam, /* can be NULL */
const LSApplicationParameters * inAppParams, /* can be NULL */
ProcessSerialNumber * outPSNs, /* can be NULL */
CFIndex inMaxPSNCount) API_DEPRECATED("Use NSWorkspace instead.", macos(10.4,10.10) ) API_UNAVAILABLE( ios, tvos, watchos );
/*
* LSOpenURLsWithRole() *** DEPRECATED ***
*
* Opens the URLs specified by inURLs (an array of CFURLRefs) with the role
* specified by inRoleMask. If the role doesn't matter, use kLSRolesAll.
*
* Clients can optionally specify the application and launch parameters
* in inAppParams. If a specific application is given in inAppParams, then
* inRoleMask is ignored and the application is launched (if necessary).
* Otherwise, an application will be selected which can handle each input
* URL in at least one of the specified role(s).
*
* Each launched application will receive one or more 'GURL' Apple Event
* specifying the URLs to be opened. Clients may also pass file URLs, which
* will be interpreted as file system items and opened in the manner of
* LSOpenItemsWithRole (i.e., a handler will be selected base on the item's
* metadata).
*
* Note that if the input array contains any application URLs, this
* function will not launch them unless the kLSRolesShell bit is set
* in the inRolesMask (in which case the application is its own shell).
*
* The optional inAEParam argument specifies an AEDesc to be attached to
* the Apple Event(s) generated by Launch Services with the specified
* AEKeyword.
*
* If not NULL, the outPSNs buffer will be filled with the PSN which
* was used to open each URL at the same index of the input URL array. The
* PSN capacity of the output buffer is specified by inMaxPSNCount.
*
* Mac OS X threading:
* Thread safe since version 10.4
*
* Deprecated:
* Use NSWorkspace instead.
*
* Availability:
* Mac OS X: in version 10.4 and later in CoreServices.framework
* CarbonLib: not available
* Non-Carbon CFM: not available
*/
extern OSStatus
LSOpenURLsWithRole(
CFArrayRef inURLs,
LSRolesMask inRole,
const AEKeyDesc * inAEParam, /* can be NULL */
const LSApplicationParameters * inAppParams, /* can be NULL */
ProcessSerialNumber * outPSNs, /* can be NULL */
CFIndex inMaxPSNCount) API_DEPRECATED("Use NSWorkspace instead.", macos(10.4,10.10) ) API_UNAVAILABLE( ios, tvos, watchos );
#endif
#pragma pack(pop)
#ifdef __cplusplus
}
#endif
#endif /* __LSOPENDEPRECATED__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/LaunchServices.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/LaunchServices.framework/Headers/LSInfo.h | /*
File: LSInfo.h
Contains: Public interfaces for LaunchServices.framework
Copyright: (c) 2001-2012 by Apple Inc. All rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
*/
#ifndef __LSINFO__
#define __LSINFO__
#ifndef __COREFOUNDATION__
#include <CoreFoundation/CoreFoundation.h>
#endif
#if TARGET_OS_OSX
#ifndef __CARBONCORE__
#include <CarbonCore/CarbonCore.h>
#endif
#endif // TARGET_OS_OSX
#include <Availability.h>
#if PRAGMA_ONCE
#pragma once
#endif
#ifdef __cplusplus
extern "C" {
#endif
#pragma pack(push, 2)
CF_ASSUME_NONNULL_BEGIN
/* ======================================================================================================== */
/* LaunchServices Type & Constants */
/* ======================================================================================================== */
CF_ENUM(OSStatus) {
kLSNo32BitEnvironmentErr = -10386, /* i386 is no longer supported*/
kLSAppInTrashErr = -10660, /* The app cannot be run when inside a Trash folder*/
kLSExecutableIncorrectFormat = -10661, /* No compatible executable was found*/
kLSAttributeNotFoundErr = -10662, /* An item attribute value could not be found with the specified name*/
kLSAttributeNotSettableErr = -10663, /* The attribute is not settable*/
kLSIncompatibleApplicationVersionErr = -10664, /* The app is incompatible with the current OS*/
kLSNoRosettaEnvironmentErr = -10665, /* PowerPC apps are no longer supported */
kLSGarbageCollectionUnsupportedErr = -10666, /* Objective-C garbage collection is no longer supported*/
kLSUnknownErr = -10810, /* Unexpected internal error*/
kLSNotAnApplicationErr = -10811, /* Item needs to be an application, but is not*/
kLSNotInitializedErr = -10812, /* Not used in 10.2 and later*/
kLSDataUnavailableErr = -10813, /* E.g. no kind string*/
kLSApplicationNotFoundErr = -10814, /* E.g. no application claims the file*/
kLSUnknownTypeErr = -10815, /* Don't know anything about the type of the item*/
kLSDataTooOldErr = -10816, /* Not used in 10.3 and later*/
kLSDataErr = -10817, /* Not used in 10.4 and later*/
kLSLaunchInProgressErr = -10818, /* E.g. launching an already launching application*/
kLSNotRegisteredErr = -10819, /* Not used in 10.3 and later*/
kLSAppDoesNotClaimTypeErr = -10820, /* One or more documents are of types (and/or one or more URLs are of schemes) not supported by the target application (sandboxed callers only)*/
kLSAppDoesNotSupportSchemeWarning = -10821, /* Not used in 10.2 and later*/
kLSServerCommunicationErr = -10822, /* The server process (registration and recent items) is not available*/
kLSCannotSetInfoErr = -10823, /* The extension visibility on this item cannot be changed*/
kLSNoRegistrationInfoErr = -10824, /* The item contains no registration info*/
kLSIncompatibleSystemVersionErr = -10825, /* The app cannot run on the current OS version*/
kLSNoLaunchPermissionErr = -10826, /* User doesn't have permission to launch the app (managed networks)*/
kLSNoExecutableErr = -10827, /* The executable is missing*/
kLSNoClassicEnvironmentErr = -10828, /* The Classic environment was required but is not available*/
kLSMultipleSessionsNotSupportedErr = -10829, /* The app cannot run simultaneously in two different sessions*/
};
typedef CF_OPTIONS(OptionBits, LSRolesMask) {
kLSRolesNone = 0x00000001, /* no claim is made about support for this type/scheme*/
kLSRolesViewer = 0x00000002, /* claim to view items of this type*/
kLSRolesEditor = 0x00000004, /* claim to edit items of this type/scheme*/
kLSRolesShell = 0x00000008, /* claim to execute items of this type*/
kLSRolesAll = (UInt32)0xFFFFFFFF /* claim to do it all*/
};
CF_ENUM(OSType) {
kLSUnknownType = 0,
kLSUnknownCreator = 0
};
typedef CF_OPTIONS(OptionBits, LSAcceptanceFlags) {
kLSAcceptDefault = 0x00000001,
kLSAcceptAllowLoginUI = 0x00000002 /* show UI to log in if necessary*/
};
/* ======================================================================================================== */
/* LaunchServices API */
/* ======================================================================================================== */
/*!
* @abstract
* Return the application used to open an item.
*
* @discussion
* Consults the binding tables to return the application that would
* be used to open inURL if it were double-clicked in the
* Finder. This application will be the user-specified override if
* appropriate or the default otherwise.
*
* @param inURL
* The URL of the item for which the application is requested.
*
* @param inRoleMask
* Whether to return the editor or viewer for inURL. If you
* don't care which, use kLSRolesAll.
*
* @param outError
* On failure, set to a CFError describing the problem. If you are
* not interested in this information, pass NULL. The caller is
* responsible for releasing this object.
*
* @result
* If an acceptable application is found, its URL is returned.
* If the URL is a file:// URL, the application bound to the specified
* file or directory's type is returned. If the URL's scheme is something
* else, its default scheme handler is returned. If no application could
* be found, NULL is returned and outError (if not NULL) is populated.
* with kLSApplicationNotFoundErr.
* The caller is responsible for releasing this URL.
*/
extern __nullable CFURLRef
LSCopyDefaultApplicationURLForURL(
CFURLRef inURL,
LSRolesMask inRoleMask,
__nullable CFErrorRef *__nullable outError) API_DEPRECATED("Use -[NSWorkspace URLForApplicationToOpenURL:] instead.", macos(10.10, API_TO_BE_DEPRECATED)) API_UNAVAILABLE(ios, tvos, watchos);
/*!
* @abstract
* Return the application used to open a content type (UTI).
*
* @discussion
* Consults the binding tables to return the application that would
* be used to open a file of type inContentType if it were double-clicked
* in the Finder. This application will be the user-specified override if
* appropriate or the default otherwise.
*
* @param inContentType
* The Uniform Type Identifier (UTI) of the item for which the
* application is requested.
*
* @param inRoleMask
* Whether to return the editor or viewer for inContentType. If you
* don't care which, use kLSRolesAll.
*
* @param outError
* On failure, set to a CFError describing the problem. If you are
* not interested in this information, pass NULL. The caller is
* responsible for releasing this object.
*
* @result
* If an acceptable application is found, its URL is returned.
* If no application could be found, NULL is returned and
* outError (if not NULL) is populated with kLSApplicationNotFoundErr.
* The caller is responsible for releasing this URL.
*/
extern __nullable CFURLRef
LSCopyDefaultApplicationURLForContentType(
CFStringRef inContentType,
LSRolesMask inRoleMask,
__nullable CFErrorRef *__nullable outError) API_DEPRECATED("Use -[NSWorkspace URLForApplicationToOpenContentType:] instead.", macos(10.10, API_TO_BE_DEPRECATED)) API_UNAVAILABLE(ios, tvos, watchos);
/*!
* @abstract Given a bundle identifier (such as com.apple.finder), find all URLs to the corresponding application.
*
* @discussion
* Returns zero or more URLs to applications that have the specified
* bundle identifier.
*
* @param inBundleIdentifier The bundle identifier of interest, such as "com.apple.finder". Must
* not be NULL.
*
* @param outError
* On failure, set to a CFError describing the problem. If you are
* not interested in this information, pass NULL. The caller is
* responsible for releasing this object.
*
* @result
* If any applications with the specified bundle identifier are found,
* their URLs are returned in a CFArray. If no application could be found,
* NULL is returned and outError (if not NULL) is populated with kLSApplicationNotFoundErr.
* In macOS 10.15 and later, the returned array is sorted with the first element containing the
* best available application with the specified bundle identifier. Prior to macOS 10.15, the
* order of elements in the array was undefined.
*
*/
extern __nullable CFArrayRef
LSCopyApplicationURLsForBundleIdentifier(
CFStringRef inBundleIdentifier,
__nullable CFErrorRef *__nullable outError) API_DEPRECATED("Use -[NSWorkspace URLsForApplicationsWithBundleIdentifier:] instead.", macos(10.10, API_TO_BE_DEPRECATED)) API_UNAVAILABLE(ios, tvos, watchos);
/*!
* @abstract
* Returns an array of URLs to applications that offer the requested
* role(s) for the input item.
*
* @param inURL
* The CFURLRef of the item for which all suitable applications
* are desired. If the URL is a file URL, it is treated as a
* document, and applications are selected based on the document's
* type information. Otherwise, applications are selected based on
* the URL's scheme.
*
* @param inRoleMask
* The role(s) which must intersect with the role provided by an
* application for the specified item in order for the application
* to be included in the result. Pass kLSRolesAll if any role is
* acceptable.
*
* @result
* An array of CFURLRefs, one for each application which can open
* inURL with at least one of the roles in inRoleMask, or NULL if no
* applications can open the item. When an array is returned, you
* must eventually release it.
*
* The order of the resulting array is undefined. If you need the
* default application for the specified URL, use LSCopyDefaultApplicationURLForURL.
*
*/
extern __nullable CFArrayRef
LSCopyApplicationURLsForURL(
CFURLRef inURL,
LSRolesMask inRoleMask) API_DEPRECATED("Use -[NSWorkspace URLsForApplicationsToOpenURL:] instead.", macos(10.3, API_TO_BE_DEPRECATED)) API_UNAVAILABLE(ios, tvos, watchos);
/*!
* @abstract
* Determine whether an item can accept another item.
*
* @discussion
* Returns in outAcceptsItem whether inTargetURL can accept
* inItemURL as in a drag and drop operation. If inRoleMask is other
* than kLSRolesAll then make sure inTargetRef claims to fulfill the
* requested role.
*
* @param inItemURL
* CFURLRef of the item about which acceptance is requested.
*
* @param inTargetURL
* CFURLRef of the potential target.
*
* @param inRoleMask
* The role(s) the target must claim in order to consider
* acceptance.
*
* @param inFlags
* Use kLSAcceptDefault.
*
* @param outAcceptsItem
* Filled in with result. Must not be NULL.
*
*/
extern OSStatus
LSCanURLAcceptURL(
CFURLRef inItemURL,
CFURLRef inTargetURL,
LSRolesMask inRoleMask,
LSAcceptanceFlags inFlags,
Boolean * outAcceptsItem) API_AVAILABLE( macos(10.0) ) API_UNAVAILABLE( ios, tvos, watchos );
/*!
* @discussion
* If the specified URL refers to an application or other bundle
* claiming to handle documents or URLs, add the bundle's document
* and URL claims to the Launch Services database.
*
* @param inURL
* The CFURLRef of the item (a directory or file) to be registered.
*
* @param inUpdate
* When false, LSRegisterURL does not register the item if it has
* already been registered and the current modification date of
* the item has not changed from when it was last registered. When
* true, the item's registered info is updated, even if the
* modification has not changed.
*
* @result
* An OSStatus value: noErr - Success kLSNoRegistrationInfoErr - The
* item does not contain info requiring registration kLSDataErr -
* The item's property list info is malformed.
*
*/
extern OSStatus
LSRegisterURL(
CFURLRef inURL,
Boolean inUpdate) API_AVAILABLE( ios(4.0), macos(10.3), tvos(9.0), watchos(1.0) );
/* ================================================================================== */
/* API for accessing content and URL handler preferences */
/* ================================================================================== */
/*!
* @discussion Returns the application bundle identifier of the default handler
* for the specified content type (UTI), in the specified role(s).
* For any role, specify kLSRolesAll. Returns NULL if no handler
* is available.
*
* @param inContentType a string UTI type identifier
* @param inRole a LSRole
*
* @result an application bundle identifier which is the default handler for the given type and role, or NULL if there is no default handler
*/
extern __nullable CFStringRef
LSCopyDefaultRoleHandlerForContentType(
CFStringRef inContentType,
LSRolesMask inRole) API_DEPRECATED("Use -[NSWorkspace URLForApplicationToOpenContentType:] instead.", ios(4.0, API_TO_BE_DEPRECATED), macos(10.4, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED), watchos(1.0, API_TO_BE_DEPRECATED));
/*!
* @discussion Returns an array of application bundle identifiers for
* applications capable of handling the specified content type
* (UTI) with the specified role(s). Application content handling
* capabilities are determined according to the kCFBundleDocumentTypes
* listed in an application's Info.plist). For any role, specify kLSRolesAll.
* Returns NULL if no handlers are available.
*
* @param inContentType a string UTI type identifier
* @param inRole a LSRole
*
* @return an array of of CFStringRef bundle identifiers, or NULL
*/
extern __nullable CFArrayRef
LSCopyAllRoleHandlersForContentType(
CFStringRef inContentType,
LSRolesMask inRole) API_DEPRECATED("Use -[NSWorkspace URLsForApplicationsToOpenContentType:] instead.", macos(10.4, API_TO_BE_DEPRECATED)) API_UNAVAILABLE(ios, tvos, watchos);
/*!
* @discussion Sets the user's preferred handler for the specified content
* type (UTI) in the specified role(s). For all roles, specify
* kLSRolesAll. The handler is specified as an application
* bundle identifier.
*
* @param inContentType a string UTI type identifier
* @param inRole the role type(s) to set
* @param inHandlerBundleID the bundle identifier to set as the default handler for the given contet type and role(s)
*
* @result noErr on success, or an error indicating why the call failed
*
*/
extern OSStatus
LSSetDefaultRoleHandlerForContentType(
CFStringRef inContentType,
LSRolesMask inRole,
CFStringRef inHandlerBundleID) API_DEPRECATED("Use -[NSWorkspace setDefaultApplicationAtURL:toOpenContentType:completionHandler:] instead.", ios(4.0, API_TO_BE_DEPRECATED), macos(10.4, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED), watchos(1.0, API_TO_BE_DEPRECATED));
/*!
* @discussion Returns the bundle identifier of the default handler for
* the specified URL scheme. Returns NULL if no handler
* is available.
*
* @param inURLScheme the scheme to return the default handler bundle identifier for
*
* @result a CFStringRef bundle identifier of the default handler, or NULL if no handler is available
*
*/
extern __nullable CFStringRef
LSCopyDefaultHandlerForURLScheme(CFStringRef inURLScheme) API_DEPRECATED("Use -[NSWorkspace URLForApplicationToOpenURL:] instead.", macos(10.4, 10.15)) API_UNAVAILABLE(ios, watchos, tvos);
/*!
* @discussion Returns an array of application bundle identifiers for
* applications capable of handling the specified URL scheme.
* URL handling capability is determined according to the
* kCFBundleURLTypes listed in an application's Info.plist).
* Returns NULL if no handlers are available.
*
* @param inURLScheme the scheme to return an array of bundle identifiers for applications capable of handling the scheme
*
* @result
* An array of bundle identifier strings
*
*/
extern __nullable CFArrayRef
LSCopyAllHandlersForURLScheme(CFStringRef inURLScheme) API_DEPRECATED("Use -[NSWorkspace URLsForApplicationsToOpenURL:] instead.", macos(10.4, 10.15)) API_UNAVAILABLE(ios, watchos, tvos);
/*!
* @abstract Sets the user's preferred handler for the specified URL
* scheme. The handler is specified as an application
* bundle identifier.
*
* @param inURLScheme the url scheme to set a default handler for
* @param inHandlerBundeID the bundle identifier to be set as the default handler for the given scheme
*/
extern OSStatus
LSSetDefaultHandlerForURLScheme(
CFStringRef inURLScheme,
CFStringRef inHandlerBundleID) API_DEPRECATED("Use -[NSWorkspace setDefaultApplicationAtURL:toOpenURLsWithScheme:completionHandler:] instead.", ios(4.0, API_TO_BE_DEPRECATED), macos(10.4, API_TO_BE_DEPRECATED), tvos(9.0, API_TO_BE_DEPRECATED), watchos(1.0, API_TO_BE_DEPRECATED));
CF_ASSUME_NONNULL_END
#pragma pack(pop)
#ifdef __cplusplus
}
#endif
#include <LaunchServices/LSInfoDeprecated.h>
#endif /* __LSINFO__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/Metadata.framework/Metadata.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: 16862C7C-BFF9-368F-A2A0-B2FB630E5E6D
- target: x86_64-maccatalyst
value: 16862C7C-BFF9-368F-A2A0-B2FB630E5E6D
- target: arm64-macos
value: 00000000-0000-0000-0000-000000000000
- target: arm64-maccatalyst
value: 00000000-0000-0000-0000-000000000000
- target: arm64e-macos
value: 8B70FB9F-57B2-30D4-A1B4-1FF35BFF1194
- target: arm64e-maccatalyst
value: 8B70FB9F-57B2-30D4-A1B4-1FF35BFF1194
install-name: '/System/Library/Frameworks/CoreServices.framework/Versions/A/Frameworks/Metadata.framework/Versions/A/Metadata'
current-version: 2179.2
parent-umbrella:
- targets: [ x86_64-macos, x86_64-maccatalyst, arm64-macos, arm64-maccatalyst,
arm64e-macos, arm64e-maccatalyst ]
umbrella: CoreServices
allowable-clients:
- targets: [ x86_64-macos, x86_64-maccatalyst, arm64-macos, arm64-maccatalyst,
arm64e-macos, arm64e-maccatalyst ]
clients: [ Foundation ]
exports:
- targets: [ x86_64-maccatalyst, x86_64-macos, arm64e-maccatalyst, arm64e-macos,
arm64-macos, arm64-maccatalyst ]
symbols: [ _MDBackupBegin, _MDBackupCancel, _MDBackupCreate, _MDBackupEnd,
_MDBackupFileWasIndexed, _MDBackupFinishedForVolume, _MDBackupFlushFallbackBackup,
_MDBackupIndexFile, _MDBackupPendingUnmount, _MDBackupQuiescentForVolume,
_MDBackupResume, _MDBackupWriteRawAttributesToPath, _MDCopyLabelKinds,
_MDCopyLabelWithID, _MDCopyLabelWithUUID, _MDCopyLabelsMatchingExpression,
_MDCopyLabelsWithKind, _MDCopyPathForSpotlight, _MDCopySessionBegin,
_MDCopySessionCancel, _MDCopySessionCreate, _MDCopySessionEnd,
_MDCopySessionEnterUserDirectory, _MDCopySessionIndexFile,
_MDCopySessionLeaveUserDirectory, _MDItemCopyAttribute, _MDItemCopyAttributeNames,
_MDItemCopyAttributes, _MDItemCopyAttributesBulk, _MDItemCopyLabels,
_MDItemCreate, _MDItemCreateForAbsolutePaths, _MDItemCreateWithURL,
_MDItemGetTypeID, _MDItemRemoveAttribute, _MDItemRemoveAttributes,
_MDItemRemoveAttributesForAbsolutePaths, _MDItemRemoveLabel,
_MDItemSetAttribute, _MDItemSetAttributes, _MDItemSetAttributesForAbsolutePaths,
_MDItemSetLabel, _MDItemSetLocalizedAttribute, _MDItemsCopyAttributes,
_MDItemsCreateWithURLs, _MDItemsSetAttributes, _MDItemsSetAttributesNoExAttr,
_MDLabelAddToItems, _MDLabelCopyAttribute, _MDLabelCopyAttributeName,
_MDLabelCreate, _MDLabelDelete, _MDLabelGetTypeID, _MDLabelRemoveFromItems,
_MDLabelSetAttributes, _MDQueryCopyQueryString, _MDQueryCopySortingAttributes,
_MDQueryCopyValueListAttributes, _MDQueryCopyValuesOfAttribute,
_MDQueryCreate, _MDQueryCreateForItems, _MDQueryCreateSubset,
_MDQueryDisableUpdates, _MDQueryEnableUpdates, _MDQueryExecute,
_MDQueryGetAttributeValueOfResultAtIndex, _MDQueryGetBatchingParameters,
_MDQueryGetCountOfResultsWithAttributeValue, _MDQueryGetIndexOfResult,
_MDQueryGetResultAtIndex, _MDQueryGetResultCount, _MDQueryGetTypeID,
_MDQueryIsGatheringComplete, _MDQueryIsStopped, _MDQuerySetBatchingParameters,
_MDQuerySetCreateResultFunction, _MDQuerySetCreateValueFunction,
_MDQuerySetDispatchQueue, _MDQuerySetMatchesSupportFiles,
_MDQuerySetMaxCount, _MDQuerySetSearchScope, _MDQuerySetSortComparator,
_MDQuerySetSortComparatorBlock, _MDQuerySetSortOptionFlagsForAttribute,
_MDQuerySetSortOrder, _MDQueryStop, _MDSchemaCopyAllAttributes,
_MDSchemaCopyAttributesForContentType, _MDSchemaCopyDisplayDescriptionForAttribute,
_MDSchemaCopyDisplayNameForAttribute, _MDSchemaCopyMetaAttributesForAttribute,
_MDServiceConnectionBindChannelUUID, _MDServiceConnectionDropChannelUUID,
_MDServiceConnectionGetConnection, _MDServiceConnectionGetTypeID,
_MDServiceConnectionReceive, _MDServiceConnectionReceiveBlock,
_MDServiceConnectionSend, _MDServiceConnectionSendEnv, _MDServiceConnectionSendReceive,
_NSMetadataItemAcquisitionMakeKey, _NSMetadataItemAcquisitionModelKey,
_NSMetadataItemAlbumKey, _NSMetadataItemAltitudeKey, _NSMetadataItemApertureKey,
_NSMetadataItemAppleLoopDescriptorsKey, _NSMetadataItemAppleLoopsKeyFilterTypeKey,
_NSMetadataItemAppleLoopsLoopModeKey, _NSMetadataItemAppleLoopsRootKeyKey,
_NSMetadataItemApplicationCategoriesKey, _NSMetadataItemAttributeChangeDateKey,
_NSMetadataItemAudiencesKey, _NSMetadataItemAudioBitRateKey,
_NSMetadataItemAudioChannelCountKey, _NSMetadataItemAudioEncodingApplicationKey,
_NSMetadataItemAudioSampleRateKey, _NSMetadataItemAudioTrackNumberKey,
_NSMetadataItemAuthorAddressesKey, _NSMetadataItemAuthorEmailAddressesKey,
_NSMetadataItemAuthorsKey, _NSMetadataItemBitsPerSampleKey,
_NSMetadataItemCFBundleIdentifierKey, _NSMetadataItemCameraOwnerKey,
_NSMetadataItemCityKey, _NSMetadataItemCodecsKey, _NSMetadataItemColorSpaceKey,
_NSMetadataItemCommentKey, _NSMetadataItemComposerKey, _NSMetadataItemContactKeywordsKey,
_NSMetadataItemContentCreationDateKey, _NSMetadataItemContentModificationDateKey,
_NSMetadataItemContentTypeKey, _NSMetadataItemContentTypeTreeKey,
_NSMetadataItemContributorsKey, _NSMetadataItemCopyrightKey,
_NSMetadataItemCountryKey, _NSMetadataItemCoverageKey, _NSMetadataItemCreatorKey,
_NSMetadataItemDateAddedKey, _NSMetadataItemDeliveryTypeKey,
_NSMetadataItemDescriptionKey, _NSMetadataItemDirectorKey,
_NSMetadataItemDownloadedDateKey, _NSMetadataItemDueDateKey,
_NSMetadataItemDurationSecondsKey, _NSMetadataItemEXIFGPSVersionKey,
_NSMetadataItemEXIFVersionKey, _NSMetadataItemEditorsKey,
_NSMetadataItemEmailAddressesKey, _NSMetadataItemEncodingApplicationsKey,
_NSMetadataItemExecutableArchitecturesKey, _NSMetadataItemExecutablePlatformKey,
_NSMetadataItemExposureModeKey, _NSMetadataItemExposureProgramKey,
_NSMetadataItemExposureTimeSecondsKey, _NSMetadataItemExposureTimeStringKey,
_NSMetadataItemFNumberKey, _NSMetadataItemFinderCommentKey,
_NSMetadataItemFlashOnOffKey, _NSMetadataItemFocalLength35mmKey,
_NSMetadataItemFocalLengthKey, _NSMetadataItemFontsKey, _NSMetadataItemGPSAreaInformationKey,
_NSMetadataItemGPSDOPKey, _NSMetadataItemGPSDateStampKey,
_NSMetadataItemGPSDestBearingKey, _NSMetadataItemGPSDestDistanceKey,
_NSMetadataItemGPSDestLatitudeKey, _NSMetadataItemGPSDestLongitudeKey,
_NSMetadataItemGPSDifferentalKey, _NSMetadataItemGPSMapDatumKey,
_NSMetadataItemGPSMeasureModeKey, _NSMetadataItemGPSProcessingMethodKey,
_NSMetadataItemGPSStatusKey, _NSMetadataItemGPSTrackKey, _NSMetadataItemGenreKey,
_NSMetadataItemHasAlphaChannelKey, _NSMetadataItemHeadlineKey,
_NSMetadataItemISOSpeedKey, _NSMetadataItemIdentifierKey,
_NSMetadataItemImageDirectionKey, _NSMetadataItemInformationKey,
_NSMetadataItemInstantMessageAddressesKey, _NSMetadataItemInstructionsKey,
_NSMetadataItemIsApplicationManagedKey, _NSMetadataItemIsGeneralMIDISequenceKey,
_NSMetadataItemIsLikelyJunkKey, _NSMetadataItemKeySignatureKey,
_NSMetadataItemKeywordsKey, _NSMetadataItemKindKey, _NSMetadataItemLanguagesKey,
_NSMetadataItemLastUsedDateKey, _NSMetadataItemLatitudeKey,
_NSMetadataItemLayerNamesKey, _NSMetadataItemLensModelKey,
_NSMetadataItemLongitudeKey, _NSMetadataItemLyricistKey, _NSMetadataItemMaxApertureKey,
_NSMetadataItemMediaTypesKey, _NSMetadataItemMeteringModeKey,
_NSMetadataItemMusicalGenreKey, _NSMetadataItemMusicalInstrumentCategoryKey,
_NSMetadataItemMusicalInstrumentNameKey, _NSMetadataItemNamedLocationKey,
_NSMetadataItemNumberOfPagesKey, _NSMetadataItemOrganizationsKey,
_NSMetadataItemOrientationKey, _NSMetadataItemOriginalFormatKey,
_NSMetadataItemOriginalSourceKey, _NSMetadataItemPageHeightKey,
_NSMetadataItemPageWidthKey, _NSMetadataItemParticipantsKey,
_NSMetadataItemPerformersKey, _NSMetadataItemPhoneNumbersKey,
_NSMetadataItemPixelCountKey, _NSMetadataItemPixelHeightKey,
_NSMetadataItemPixelWidthKey, _NSMetadataItemProducerKey,
_NSMetadataItemProfileNameKey, _NSMetadataItemProjectsKey,
_NSMetadataItemPublishersKey, _NSMetadataItemRecipientAddressesKey,
_NSMetadataItemRecipientEmailAddressesKey, _NSMetadataItemRecipientsKey,
_NSMetadataItemRecordingDateKey, _NSMetadataItemRecordingYearKey,
_NSMetadataItemRedEyeOnOffKey, _NSMetadataItemResolutionHeightDPIKey,
_NSMetadataItemResolutionWidthDPIKey, _NSMetadataItemRightsKey,
_NSMetadataItemSecurityMethodKey, _NSMetadataItemSpeedKey,
_NSMetadataItemStarRatingKey, _NSMetadataItemStateOrProvinceKey,
_NSMetadataItemStreamableKey, _NSMetadataItemSubjectKey, _NSMetadataItemTempoKey,
_NSMetadataItemTextContentKey, _NSMetadataItemThemeKey, _NSMetadataItemTimeSignatureKey,
_NSMetadataItemTimestampKey, _NSMetadataItemTitleKey, _NSMetadataItemTotalBitRateKey,
_NSMetadataItemVersionKey, _NSMetadataItemVideoBitRateKey,
_NSMetadataItemWhereFromsKey, _NSMetadataItemWhiteBalanceKey,
_NSMetadataQueryIndexedLocalComputerScope, _NSMetadataQueryIndexedNetworkScope,
_NSMetadataQueryUpdateAddedItemsKey, _NSMetadataQueryUpdateChangedItemsKey,
_NSMetadataQueryUpdateRemovedItemsKey, _SIUINT32SetAddValue,
_SIUINT32SetContainsValue, _SIUINT32SetCreate, _SIUINT32SetGetTypeID,
_SIUINT64SetAddValue, _SIUINT64SetContainsValue, _SIUINT64SetCreate,
_SIUINT64SetGetTypeID, _SIUINT64SetIterate, _SIUINT64SetRemoveValue,
__MDAppRankEvaluatorDeallocate, __MDAppRankOfItem, __MDBackupCatchup,
__MDBackupDeletes, __MDBackupFileEndOfLife, __MDConfigClearStoreUUID,
__MDConfigCopyImporterInformation, __MDConfigCopyImporterUIDs,
__MDConfigCopyIndexingStorePaths, __MDConfigCopyStoreAttributes,
__MDConfigCopyStoreInformation, __MDConfigCopyStorePaths,
__MDConfigCreateStore, __MDConfigCreateVolumeIndex, __MDConfigForceStoreSync,
__MDConfigRegisterMountPoint, __MDConfigRemoveStore, __MDConfigSetStoreAttributes,
__MDConfigUnregisterMountPoint, __MDConnectToServer, __MDCopyAltGroupNameToGroupNameDictionary,
__MDCopyAppleLanguages, __MDCopyAttributeSchema, __MDCopyBundlePaths,
__MDCopyExclusionList, __MDCopyExtendedAttributes, __MDCopyGroupIndexToNameDictionary,
__MDCopyGroupNameToGroupNumberDictionary, __MDCopyGroupNameToQueryDictionary,
__MDCopyImportInfo, __MDCopyImporterPluginPathForFile, __MDCopyIndexSize,
__MDCopyIndexingStatus, __MDCopyIndexingStatusForVolume, __MDCopyLabelUserUUID,
__MDCopyLocalizedGroupNameDictionary, __MDCopyMDSimpleGroupingsPlist,
__MDCopyShortcutsDictionary, __MDCopyTextShortcutsSet, __MDCopyUTIToGroupNumberDictionary,
__MDCopyVolumeFilter, __MDCopyVolumeFilterEngine, __MDCreateAppRankEvaluator,
__MDCreateDictionaryByMappingXMPDictionary, __MDCreateSimpleQueryEvaluator,
__MDCreateSimpleQueryEvaluatorWithBlock, __MDCreateSimpleQueryEvaluatorWithOptions,
__MDCreateSimpleQueryEvaluatorWithOptionsAndLanguages, __MDCustomizeGroupNameWithUTITypeAndTree,
__MDDynamicAppRankOfItem, __MDFilterIsItemExcludedFromIndexing,
__MDFilterIsItemOut, __MDGetAllowedTaskCount, __MDGetCurrentTaskCount,
__MDGetLabelServicesConnection, __MDGetLastUsedDate, __MDGetPrivateXattrServicesConnection,
__MDGetPublicXattrServicesConnection, __MDHealthCheckDirectory,
__MDIgnoreFileOperations, __MDImportDirectory, __MDImportFile,
__MDImportFilesWithUTIs, __MDImportPrivateXattrsFromItems,
__MDIndexingProgress, __MDIsAppDirPath, __MDIsCompatibleArchitecture,
__MDIsCustomizableGroupName, __MDIsRootVolumePath, __MDIssueStoreCommand,
__MDItemCopyCFURL, __MDItemCopyExAttrWithURL, __MDItemCreate,
__MDItemCreateFSRef, __MDItemCreateFileSystemObject, __MDItemGetContentType,
__MDItemGetDevice, __MDItemGetFileId, __MDItemGetTextEncodingHint,
__MDItemGetTextSnippets, __MDItemGetVRefNum, __MDItemMarkAsCreated,
__MDItemMarkAsDownloaded, __MDItemMarkAsModified, __MDItemMarkAsPrinted,
__MDItemMarkAsReceived, __MDItemMarkAsSent, __MDItemMarkAsUsed,
__MDItemMarkAsUsedWithAbsoluteTime, __MDItemMarkAsUsedWithPathAndCatInfo,
__MDItemMarkAsUsedWithPathAndStatBuf, __MDItemMarkAsUsedWithURL,
__MDItemMarkAsUsedWithURLAndAbsoluteTime, __MDItemRemoveAttributesWithURL,
__MDItemSetAttributesForAbsolutePathsNoExAttr, __MDItemSetAttributesForAbsolutePathsNoExAttrNoImport,
__MDItemSetAttributesWithURL, __MDItemSetCommonAttributesForOids,
__MDItemSetContentType, __MDItemSetFinderColor, __MDItemSetInSniffer,
__MDItemSetPrivateAttributes, __MDItemSetTextEncodingHint,
__MDItemsCreateWithFileIdsAndAbsolutePathsOnDevice, __MDItemsWritePrivateXattrUpdatesWithKeysAndValues,
__MDLabelCopyAttributeNameForUUID, __MDLabelCopyPrivateAttrs,
__MDLabelCopyPrivateAttrsForUid, __MDLabelMatchExpressionApply,
__MDLabelUUIDEncode, __MDMatchKeyCreate, __MDMatchKeyDeallocate,
__MDMatchKeyEvaluate, __MDOpenUserFile, __MDOptionAddBooleanGetter,
__MDOptionAddIntegerGetter, __MDOptionAddObjectGetter, __MDOptionCopyDump,
__MDOptionGetValues, __MDOptionNamedPthreadKey, __MDPerfCopyStoreLifeCycleInfo,
__MDPerfCreateFileEventMarker, __MDPerfCreateFileIndexingMarker,
__MDPerfFlushAuditLog, __MDPerfSetAuditLevel, __MDPerfWaitFileIndexingMarkerProcessed,
__MDPerfWaitForStoreState, __MDPreHeatIndex, __MDPrepareForSnapshot,
__MDPrepareForSnapshotTimeout, __MDPrepareForSoftwareUpdate,
__MDPrivateXattrUUIDsGetter, __MDQueryAttributesChanged, __MDQueryClearIgnoreUpdateList,
__MDQueryCopyCompletions, __MDQueryCopyDictionary, __MDQueryCopyMenuRankingQueries,
__MDQueryCopyMenuSortingAttributes, __MDQueryCopyMenuValueListAttributes,
__MDQueryCopyParams, __MDQueryCopyPerfData, __MDQueryCopyRankingTerms,
__MDQueryCopyTextTerms, __MDQueryCopyUserStringForGroupName,
__MDQueryCreateExpr, __MDQueryCreateForItems, __MDQueryCreateFromDictionary,
__MDQueryCreateFromSavedSearch, __MDQueryCreateQueryDictionaryWithOptionsDict,
__MDQueryCreateQueryString, __MDQueryCreateQueryStringToMatchAttribute,
__MDQueryCreateQueryStringToMatchAttributeWithOptions, __MDQueryCreateQueryStringToMatchDisplayName,
__MDQueryCreateQueryStringToMatchDisplayNameWithOptions, __MDQueryCreateQueryStringToMatchDisplayNamesWithOptions,
__MDQueryCreateQueryStringWithOptions, __MDQueryCreateQueryStringWithOptionsDict,
__MDQueryCreateStringByAddingBackslashEscapes, __MDQueryDontEnforceTopN,
__MDQueryEnablePerfGathering, __MDQueryEnumerateNodesInQueryString,
__MDQueryExtractTextTerms, __MDQueryFastWillStop, __MDQueryGetAttributeValueOfResultAtIndexForGroup,
__MDQueryGetAttributeValuesOfResultAtIndex, __MDQueryGetGeneration,
__MDQueryGetGroupCount, __MDQueryGetResultAtIndexForGroup,
__MDQueryGetResultCountForAllGroups, __MDQueryGetResultCountForGroup,
__MDQueryGetSortFlagsForAttribute, __MDQueryIgnoreAllLastUsedUpdatesForItem,
__MDQueryIgnoreNextLastUsedUpdateForItem, __MDQueryProcessUpdates,
__MDQuerySendPerformanceFeedback, __MDQuerySetCompletionOptions,
__MDQuerySetCompletionQuery, __MDQuerySetCompletionQueryWithWeights,
__MDQuerySetCompletionResultCount, __MDQuerySetCreateResultFunctionWithKeyCallBacks,
__MDQuerySetGroupComparator, __MDQuerySetGroupingRules, __MDQuerySetHasUpdateNotification,
__MDQuerySetLabel, __MDQuerySetMDFilter, __MDQuerySetMDFilterQueries,
__MDQuerySetMatchesOnlyFinderFiles, __MDQuerySetMaxCountPerGroup,
__MDQuerySetMenuSortFlagsForQuery, __MDQuerySetNoProgress,
__MDQuerySetRankingTerms, __MDQuerySetSearchScopes, __MDQuerySetSortFlagsForAttribute,
__MDQuerySetSortOrder, __MDQuerySetSortToNone, __MDQuerySortDatesDescending,
__MDQueryStringCopyUserInput, __MDQueryStringCreateForRanking,
__MDQueryStringPreload, __MDQueryTotalCount, __MDQueryUserStringFacetsApplyDoWhileBlock,
__MDQueryWillSendPerformanceFeedback, __MDRankBitForShortcut,
__MDRankIsExactPhraseMatch, __MDRankIsMeaningfulForTopHit,
__MDRankIsOnOldBootVolume, __MDRegisterMailClient, __MDRemoveExtendedAttributes,
__MDRemoveExtendedAttributesForPath, __MDRemoveExtenedAttributes,
__MDRemoveExtenedAttributesForPath, __MDRequestVolumeRecycle,
__MDResumeIndexing, __MDResumeIndexingDirectory, __MDSchemaAddSchemaChangedHandler,
__MDSchemaCopyAll, __MDSchemaCopyAllStringsFiles, __MDSchemaCopyShortDisplayNameForAttribute,
__MDSchemaCopyShortNamesForAttribute, __MDSetExclusion, __MDSetExtendedAttributes,
__MDSetExtendedAttributesForPath, __MDSetLastUsedDate, __MDSetMailMessageAttributes,
__MDSetMailMessageAttributesAtTime, __MDSimpleQueryDeallocate,
__MDSimpleQueryGatherRangesForKeyAndValue, __MDSimpleQueryModifyForMatching,
__MDSimpleQueryObjectMatches, __MDSimpleQuerySetWidcardAttributes,
__MDSoftwareUpdateComplete, __MDStaticAppRankOfItem, __MDStringCompareLocalized,
__MDStringCopyCollationData, __MDStringPrefixOfString, __MDSuspendIndexing,
__MDSuspendIndexingDirectory, __MDTransferExtendedAttributes,
__MDUserListChange, __MDWaitForServerDeath, ___MDItemCopyAttributesEllipsis1,
___MDItemRemoveAttributesEllipsis1, ___MDItemSetAttributesEllipsis1,
__kMDImportIsForBackup, __kMDImporterTextLimitInK, __kMDItemAdamID,
__kMDItemContentChangeDate, __kMDItemCreationDate, __kMDItemCreatorCode,
__kMDItemExportImporterAvaliable, __kMDItemFSContentType,
__kMDItemFSContentTypeTree, __kMDItemFSDisplayName, __kMDItemFileName,
__kMDItemFinderFlags, __kMDItemFinderLabel, __kMDItemHasCustomIcon,
__kMDItemHasExtensionHidden, __kMDItemImporterResult, __kMDItemIncomingCalendarCounts,
__kMDItemIncomingCounts, __kMDItemIncomingFileProviderCounts,
__kMDItemIncomingMailCounts, __kMDItemIncomingSMSCounts, __kMDItemInvisibleFileType,
__kMDItemIsEvictedFile, __kMDItemIsExtensionHidden, __kMDItemIsShared,
__kMDItemIsStationery, __kMDItemLocked, __kMDItemMailAccountsAttributesMissing,
__kMDItemNodeCount, __kMDItemOutgoingCalendarCounts, __kMDItemOutgoingCounts,
__kMDItemOutgoingFileProviderCounts, __kMDItemOutgoingMailCounts,
__kMDItemOutgoingSMSCounts, __kMDItemOwnerGroupID, __kMDItemOwnerName,
__kMDItemOwnerUserID, __kMDItemPrescanCandidate, __kMDItemServerVersion,
__kMDItemSharedItemCurrentUserRole, __kMDItemSortIdentityAttr,
__kMDItemStaticInterestScore, __kMDItemSupportFileType, __kMDItemTextContentIndexExists,
__kMDItemTypeCode, __kMDItemUserTags, __kMDParametersForImporter,
__kMDQueryItemInScopeForRankingOnly, __kMDQueryScope, __kMDUserQueryAttributedInputDateKey,
__kMDUserQueryAttributedInputRecipientKey, __kMDUserQueryAttributedInputSenderKey,
__kMDUserQueryAttributedInputTitleKey, __kMDUserQueryAttributedInputTopicKey,
__kMDUserQueryDictionaryQueryAttributedInputKey, __kMDUserQueryDictionaryQueryConfidenceHighValue,
__kMDUserQueryDictionaryQueryConfidenceKey, __kMDUserQueryDictionaryQueryConfidenceLowValue,
__kMDUserQueryDictionaryQueryConfidenceMediumValue, __kMDUserQueryDictionaryQueryConfidenceNoneValue,
__kMDUserQueryDictionaryQueryDefaultStringKey, __kMDUserQueryDictionaryQueryDisplayCriteriaKey,
__kMDUserQueryDictionaryQueryDisplayCriteriaSortFieldDateValue,
__kMDUserQueryDictionaryQueryDisplayCriteriaSortFieldKey,
__kMDUserQueryDictionaryQueryDisplayCriteriaSortOrderKey,
__kMDUserQueryDictionaryQueryDisplayCriteriaSortOrderMaxValue,
__kMDUserQueryDictionaryQueryDisplayCriteriaSortOrderMinValue,
__kMDUserQueryDictionaryQueryKindKey, __kMDUserQueryDictionaryQueryLanguageSupportedKey,
__kMDUserQueryDictionaryQueryRankingCategoriesKey, __kMDUserQueryDictionaryQueryRankingTermsKey,
__kMDUserQueryDictionaryQueryStringKey, __kMDUserQueryDictionaryQueryTokenCountKey,
_kMDAttributeAllValues, _kMDAttributeArray, _kMDAttributeDisplayValues,
_kMDAttributeMultiValued, _kMDAttributeName, _kMDAttributePreviewValues,
_kMDAttributeReadOnlyValues, _kMDAttributeRelatedValues, _kMDAttributeType,
_kMDConfigChangedNotification, _kMDConfigCreateDefaultIndex,
_kMDConfigCurrentSearchLevel, _kMDConfigErase, _kMDConfigFilterRules,
_kMDConfigIsDistantStore, _kMDConfigSearchLevel, _kMDConfigSearchLevelFSSearchOnly,
_kMDConfigSearchLevelForbidden, _kMDConfigSearchLevelOff,
_kMDConfigSearchLevelReadOnly, _kMDConfigSearchLevelReadWrite,
_kMDConfigSearchLevelTransitioning, _kMDExclusionsNotification,
_kMDExporterAvaliable, _kMDIndexingNotification, _kMDIndexingNotificationActualScanCount,
_kMDIndexingNotificationArray, _kMDIndexingNotificationArrayItemPath,
_kMDIndexingNotificationCompletedRepair, _kMDIndexingNotificationCurrentlyIndexing,
_kMDIndexingNotificationCurrentlyScanning, _kMDIndexingNotificationFilesInflightFModWatch,
_kMDIndexingNotificationFilesInflightFModWatchSystem, _kMDIndexingNotificationFilesInflightFModWatchUser,
_kMDIndexingNotificationFilesInflightRepair, _kMDIndexingNotificationFilesInflightScan,
_kMDIndexingNotificationHasExclusions, _kMDIndexingNotificationIsBackup,
_kMDIndexingNotificationIsInternalVolume, _kMDIndexingNotificationPlayedBackRepair,
_kMDIndexingNotificationPlayedBackScanCount, _kMDIndexingNotificationPoppedTotalFModWatch,
_kMDIndexingNotificationPoppedTotalFModWatchSystem, _kMDIndexingNotificationPoppedTotalFModWatchUser,
_kMDIndexingNotificationPoppedTotalRepair, _kMDIndexingNotificationPoppedTotalScan,
_kMDIndexingNotificationPushedTotalRepair, _kMDIndexingNotificationRequestedRepair,
_kMDIndexingNotificationRetiredTotalFModWatch, _kMDIndexingNotificationRetiredTotalFModWatchSystem,
_kMDIndexingNotificationRetiredTotalFModWatchUser, _kMDIndexingNotificationRetiredTotalRepair,
_kMDIndexingNotificationRetiredTotalScan, _kMDIndexingNotificationScanBaseTime,
_kMDIndexingNotificationSession, _kMDIndexingNotificationTargetPolicySearch,
_kMDIndexingNotificationVolumeRoot, _kMDItemAcquisitionMake,
_kMDItemAcquisitionModel, _kMDItemAlbum, _kMDItemAlternateNames,
_kMDItemAltitude, _kMDItemAperture, _kMDItemAppleLoopDescriptors,
_kMDItemAppleLoopsKeyFilterType, _kMDItemAppleLoopsLoopMode,
_kMDItemAppleLoopsRootKey, _kMDItemApplicationCategories,
_kMDItemAttributeChangeDate, _kMDItemAudiences, _kMDItemAudioBitRate,
_kMDItemAudioChannelCount, _kMDItemAudioEncodingApplication,
_kMDItemAudioSampleRate, _kMDItemAudioTrackNumber, _kMDItemAuthorAddresses,
_kMDItemAuthorEmailAddresses, _kMDItemAuthors, _kMDItemBitsPerSample,
_kMDItemCFBundleIdentifier, _kMDItemCalendarDelegateIdentifier,
_kMDItemCalendarHolidayIdentifier, _kMDItemCameraOwner, _kMDItemCity,
_kMDItemCodecs, _kMDItemColorSpace, _kMDItemComment, _kMDItemComposer,
_kMDItemContactKeywords, _kMDItemContentCreationDate, _kMDItemContentModificationDate,
_kMDItemContentType, _kMDItemContentTypeTree, _kMDItemContributors,
_kMDItemCopyright, _kMDItemCountry, _kMDItemCoverage, _kMDItemCreator,
_kMDItemDateAdded, _kMDItemDeliveryType, _kMDItemDescription,
_kMDItemDestinationRecipients, _kMDItemDidChangeNotification,
_kMDItemDirector, _kMDItemDisplayName, _kMDItemDisplayNameInitials,
_kMDItemDocumentContainer, _kMDItemDocumentIdentifier, _kMDItemDownloadedDate,
_kMDItemDueDate, _kMDItemDurationSeconds, _kMDItemEXIFGPSVersion,
_kMDItemEXIFVersion, _kMDItemEditors, _kMDItemEmailAddresses,
_kMDItemEncodingApplications, _kMDItemExecutableArchitectures,
_kMDItemExecutablePlatform, _kMDItemExposureMode, _kMDItemExposureProgram,
_kMDItemExposureTimeSeconds, _kMDItemExposureTimeString, _kMDItemFNumber,
_kMDItemFSContentChangeDate, _kMDItemFSCreationDate, _kMDItemFSCreatorCode,
_kMDItemFSExists, _kMDItemFSFinderFlags, _kMDItemFSHasCustomIcon,
_kMDItemFSInvisible, _kMDItemFSIsExtensionHidden, _kMDItemFSIsReadable,
_kMDItemFSIsStationery, _kMDItemFSIsWriteable, _kMDItemFSLabel,
_kMDItemFSName, _kMDItemFSNodeCount, _kMDItemFSOwnerGroupID,
_kMDItemFSOwnerUserID, _kMDItemFSSize, _kMDItemFSTypeCode,
_kMDItemFinderComment, _kMDItemFinderOpenDate, _kMDItemFlashOnOff,
_kMDItemFocalLength, _kMDItemFocalLength35mm, _kMDItemFonts,
_kMDItemGPSAreaInformation, _kMDItemGPSDOP, _kMDItemGPSDateStamp,
_kMDItemGPSDestBearing, _kMDItemGPSDestDistance, _kMDItemGPSDestLatitude,
_kMDItemGPSDestLongitude, _kMDItemGPSDifferental, _kMDItemGPSMapDatum,
_kMDItemGPSMeasureMode, _kMDItemGPSProcessingMethod, _kMDItemGPSStatus,
_kMDItemGPSTrack, _kMDItemGenre, _kMDItemHTMLContent, _kMDItemHasAlphaChannel,
_kMDItemHeadline, _kMDItemISOSpeed, _kMDItemIdentifier, _kMDItemImageDirection,
_kMDItemInformation, _kMDItemInstantMessageAddresses, _kMDItemInstructions,
_kMDItemIsApplicationManaged, _kMDItemIsGeneralMIDISequence,
_kMDItemIsLikelyJunk, _kMDItemIsQuarantined, _kMDItemKeySignature,
_kMDItemKeywords, _kMDItemKind, _kMDItemLabelID, _kMDItemLabelIcon,
_kMDItemLabelKind, _kMDItemLabelUUID, _kMDItemLanguages, _kMDItemLastUsedDate,
_kMDItemLatitude, _kMDItemLayerNames, _kMDItemLensModel, _kMDItemLogicalSize,
_kMDItemLongitude, _kMDItemLyricist, _kMDItemMaxAperture,
_kMDItemMediaTypes, _kMDItemMeteringMode, _kMDItemMusicalGenre,
_kMDItemMusicalInstrumentCategory, _kMDItemMusicalInstrumentName,
_kMDItemNamedLocation, _kMDItemNumberOfPages, _kMDItemOrganizations,
_kMDItemOrientation, _kMDItemOriginApplicationIdentifier,
_kMDItemOriginMessageID, _kMDItemOriginSenderDisplayName,
_kMDItemOriginSenderHandle, _kMDItemOriginSubject, _kMDItemOriginalFormat,
_kMDItemOriginalSource, _kMDItemPageHeight, _kMDItemPageWidth,
_kMDItemParticipants, _kMDItemPath, _kMDItemPerformers, _kMDItemPhoneNumbers,
_kMDItemPhysicalSize, _kMDItemPixelCount, _kMDItemPixelHeight,
_kMDItemPixelWidth, _kMDItemProducer, _kMDItemProfileName,
_kMDItemProjects, _kMDItemPublishers, _kMDItemPurchaseDate,
_kMDItemRecipientAddresses, _kMDItemRecipientEmailAddresses,
_kMDItemRecipients, _kMDItemRecordingDate, _kMDItemRecordingYear,
_kMDItemRedEyeOnOff, _kMDItemResolutionHeightDPI, _kMDItemResolutionWidthDPI,
_kMDItemRights, _kMDItemSecurityMethod, _kMDItemSpeed, _kMDItemStarRating,
_kMDItemStateOrProvince, _kMDItemStreamable, _kMDItemSubject,
_kMDItemSupportFileType, _kMDItemTempo, _kMDItemTextContent,
_kMDItemTheme, _kMDItemTimeSignature, _kMDItemTimestamp, _kMDItemTitle,
_kMDItemTotalBitRate, _kMDItemURL, _kMDItemUsedDates, _kMDItemUserCreatedDate,
_kMDItemUserCreatedUserHandle, _kMDItemUserDownloadedDate,
_kMDItemUserDownloadedUserHandle, _kMDItemUserModifiedDate,
_kMDItemUserModifiedUserHandle, _kMDItemUserPrintedDate, _kMDItemUserPrintedUserHandle,
_kMDItemUserSharedReceivedDate, _kMDItemUserSharedReceivedRecipient,
_kMDItemUserSharedReceivedRecipientHandle, _kMDItemUserSharedReceivedSender,
_kMDItemUserSharedReceivedSenderHandle, _kMDItemUserSharedReceivedTransport,
_kMDItemUserSharedSentDate, _kMDItemUserSharedSentRecipient,
_kMDItemUserSharedSentRecipientHandle, _kMDItemUserSharedSentSender,
_kMDItemUserSharedSentSenderHandle, _kMDItemUserSharedSentTransport,
_kMDItemUserTags, _kMDItemVersion, _kMDItemVideoBitRate, _kMDItemWhereFroms,
_kMDItemWhiteBalance, _kMDLabelAddedNotification, _kMDLabelAttributeBits,
_kMDLabelBundleURL, _kMDLabelChangedNotification, _kMDLabelContentChangeDate,
_kMDLabelDisplayName, _kMDLabelExtendedFinderColor, _kMDLabelHasPreviewIcon,
_kMDLabelID, _kMDLabelIconData, _kMDLabelIconURL, _kMDLabelIconUUID,
_kMDLabelIsMutuallyExclusiveSetMember, _kMDLabelKind, _kMDLabelKindIsMutuallyExclusiveSetKey,
_kMDLabelKindVisibilityKey, _kMDLabelRemovedNotification,
_kMDLabelSetsFinderColor, _kMDLabelUUID, _kMDLabelVisibility,
_kMDPrivateVisibility, _kMDPublicVisibility, _kMDQueryAllowTranslation,
_kMDQueryBatchFirstCount, _kMDQueryBatchFirstDelay, _kMDQueryBatchProgressCount,
_kMDQueryBatchProgressDelay, _kMDQueryBatchUpdateCount, _kMDQueryBatchUpdateDelay,
_kMDQueryCompletionFields, _kMDQueryCompletionOptions, _kMDQueryCompletionResultCount,
_kMDQueryCompletionString, _kMDQueryCompletionWeights, _kMDQueryDidFinishNotification,
_kMDQueryDidUpdateNotification, _kMDQueryFilters, _kMDQueryFlatScopes,
_kMDQueryGroupMaxCount, _kMDQueryGroupingRules, _kMDQueryHasUpdateNotification,
_kMDQueryIndexedOnly, _kMDQueryIsLive, _kMDQueryIsLowPriority,
_kMDQueryItemArray, _kMDQueryLiftingRules, _kMDQueryMDFilter,
_kMDQueryMatchOnlyFinderFiles, _kMDQueryMatchSupportFiles,
_kMDQueryMaxCount, _kMDQueryNoProgress, _kMDQueryNoRewrite,
_kMDQueryOptionContextIdentifier, _kMDQueryOptionFinderLabelsDict,
_kMDQueryOptionFinderLabelsDictLocale, _kMDQueryProgressNotification,
_kMDQueryQoSClass, _kMDQueryResultContentRelevance, _kMDQueryResultGroupId,
_kMDQueryResultMLRelevance, _kMDQueryResultMatchedDisplayNameField,
_kMDQueryResultMatchedExtraQueriesField, _kMDQueryResultMatchedFields,
_kMDQueryResultMenuRelevance, _kMDQueryResultNewMatchedExtraQueriesField,
_kMDQueryResultTopMatchedField, _kMDQueryScopeAllIndexed,
_kMDQueryScopeComputer, _kMDQueryScopeComputerIndexed, _kMDQueryScopeHome,
_kMDQueryScopeMyFiles, _kMDQueryScopeMyLocalFiles, _kMDQueryScopeNetwork,
_kMDQueryScopeNetworkIndexed, _kMDQueryString, _kMDQueryStringMatchAllMetadata,
_kMDQueryStringMatchAllMetadataOrContent, _kMDQueryUniqueId,
_kMDQueryUpdateAddedItems, _kMDQueryUpdateChangedItems, _kMDQueryUpdateRemovedItems,
_kMDQueryWantsPerfData, _kMDSAttributeSchema, _kMDSAttributeSchemaPlistBytes,
_kMDSBundlePathArray, _kMDSCompleteSchema, _kMDSDiskStoreIsLowLatency,
_kMDSDiskStorePolicy, _kMDSDiskStoreSpindleNumber, _kMDSGroupIDVectorData,
_kMDSHomeDirectoryPath, _kMDSLanguageArray, _kMDSPreferencesName,
_kMDSStoreDevice, _kMDSStoreHasPersistentUUID, _kMDSStoreMetaScopes,
_kMDSStorePathScopes, _kMDSStorePrivateForUser, _kMDSStoreSnapshots,
_kMDSStoreSupportsVolFS, _kMDSStoreURLScopes, _kMDSStoreUUID,
_kMDSStoreVolFSPrefix, _kMDSTimeoutDontWait, _kMDSTimeoutLong,
_kMDSTimeoutShort, _kMDSTimeoutWaitForever, _kMDSVolumeUUID,
_kMDScopeArray, _kMDServerPortName, _kMDServiceConnectionAdvisoryNotification,
_kMDServiceConnectionDownNotification, _kMDServiceConnectionUpNotification,
_kMDSystemFile, _mach_msg_dispatch, _mach_msg_dispatch_chain_init,
_mach_msg_dispatch_gcd, _mach_msg_dispatchx, _mach_port_set_queue_limit,
_mdsChannelRequest, _mdsClientCheckin, _mdsFetchAccessTokenIDForUID,
_mdsManageCheckin, _mdsMarkItemsAsUsed, _mdsPeerCheckin, _mdsRequestVolume,
_mdsServerBootstrap ]
objc-classes: [ MDSPathFilter, MDSPathFilterGenerator, _MDLabel, _MDServiceConnection ]
reexports:
- targets: [ x86_64-maccatalyst, x86_64-macos, arm64e-maccatalyst, arm64e-macos,
arm64-macos, arm64-maccatalyst ]
symbols: [ _MDChildPlistBytesContextCreate, _MDChildPlistBytesContextDestroy,
_MDPlistArrayGetCount, _MDPlistArrayGetPlistObjectAtIndex,
_MDPlistArrayIterate, _MDPlistBooleanGetValue, _MDPlistBytesAddBoolean,
_MDPlistBytesAddCString, _MDPlistBytesAddData, _MDPlistBytesAddDate,
_MDPlistBytesAddInteger, _MDPlistBytesAddInternedCString,
_MDPlistBytesAddNull, _MDPlistBytesAddPlistBytes, _MDPlistBytesAddRawInternedCStringKey,
_MDPlistBytesAddRawInternedCStringKeyWithString, _MDPlistBytesAddReal,
_MDPlistBytesAddString, _MDPlistBytesAddUUID, _MDPlistBytesAppendMultiplePlistBytes,
_MDPlistBytesAppendPlist, _MDPlistBytesAppendPlistBytes, _MDPlistBytesBeginArray,
_MDPlistBytesBeginDictionary, _MDPlistBytesBeginPlist, _MDPlistBytesCopyChildPlistBytesAtIndex,
_MDPlistBytesCopyDispatchData, _MDPlistBytesCopyPlistAtIndex,
_MDPlistBytesCopyPlistAtIndexWithAllocator, _MDPlistBytesCopyPlistAtIndexWithCallbacks,
_MDPlistBytesCopyPlistAtIndexWithCallbacksAndAllocator, _MDPlistBytesCopyPlistBytesAtIndex,
_MDPlistBytesCreate, _MDPlistBytesCreateMutable, _MDPlistBytesCreateMutableCopy,
_MDPlistBytesCreateMutableUsingMalloc, _MDPlistBytesCreateUniquedString,
_MDPlistBytesCreateWithDeallocator, _MDPlistBytesEndArray,
_MDPlistBytesEndDictionary, _MDPlistBytesEndPlist, _MDPlistBytesGetByteVector,
_MDPlistBytesGetByteVectorCount, _MDPlistBytesGetMappedByteVector,
_MDPlistBytesGetTypeID, _MDPlistBytesSetShouldDeallocate,
_MDPlistBytesSetShouldUseMalloc, _MDPlistContainerAddBooleanValue,
_MDPlistContainerAddCString, _MDPlistContainerAddDataValue,
_MDPlistContainerAddDateValue, _MDPlistContainerAddDoubleValue,
_MDPlistContainerAddFloatValue, _MDPlistContainerAddInt32Value,
_MDPlistContainerAddInt64Value, _MDPlistContainerAddNullValue,
_MDPlistContainerAddObject, _MDPlistContainerAddPlistObject,
_MDPlistContainerAddUUIDValue, _MDPlistContainerBeginArray,
_MDPlistContainerBeginContainer, _MDPlistContainerBeginDictionary,
_MDPlistContainerCopyDispatchData, _MDPlistContainerCopyObject,
_MDPlistContainerCopyObjectAtKeyArray, _MDPlistContainerCopyObjectAtKeyPath,
_MDPlistContainerCopyObjectsAtKeyPath, _MDPlistContainerCopyObjectsAtPlistObject,
_MDPlistContainerCopyRootObject, _MDPlistContainerCreateCopy,
_MDPlistContainerCreateMutable, _MDPlistContainerCreateMutableWithStaticBuffer,
_MDPlistContainerCreateWithBytes, _MDPlistContainerCreateWithBytesAndDeallocator,
_MDPlistContainerCreateWithCopiedBytes, _MDPlistContainerCreateWithObject,
_MDPlistContainerEndArray, _MDPlistContainerEndContainer,
_MDPlistContainerEndDictionary, _MDPlistContainerGetBytes,
_MDPlistContainerGetLength, _MDPlistContainerGetPlistObjectAtKeyArray,
_MDPlistContainerGetPlistObjectAtKeyPath, _MDPlistContainerHasObjectAtKeyPath,
_MDPlistContainerWillUseMalloc, _MDPlistDataGetBytePtr, _MDPlistDateGetValue,
_MDPlistDictionaryGetCount, _MDPlistDictionaryGetPlistObjectForKey,
_MDPlistDictionaryIterate, _MDPlistEmbeddedReferenceToPlistObject,
_MDPlistEnumerateQueryResults, _MDPlistGetPlistObjectSize,
_MDPlistGetPlistObjectType, _MDPlistGetRootPlistObject, _MDPlistNumberGetDoubleValue,
_MDPlistNumberGetIntValue, _MDPlistPlistObjectToEmbeddedReference,
_MDPlistReferenceToPlistObject, _MDPlistStringGetValue, _MDPlistUUIDGetValue,
_MDSPathFilterDumpRawFilterInternal, _MDStoreOIDArrayAddOID,
_MDStoreOIDArrayAppendOIDArray, _MDStoreOIDArrayApplyBlock,
_MDStoreOIDArrayApplyBlockParallel, _MDStoreOIDArrayApplyFunction,
_MDStoreOIDArrayApplyParallelFunction, _MDStoreOIDArrayBeginBulkAdd,
_MDStoreOIDArrayBeginSequence, _MDStoreOIDArrayCreate, _MDStoreOIDArrayCreateMutable,
_MDStoreOIDArrayCreateMutableCopy, _MDStoreOIDArrayCreateMutableUsingMalloc,
_MDStoreOIDArrayCreateMutableWithOids, _MDStoreOIDArrayCreateWithDeallocator,
_MDStoreOIDArrayEndBulkAdd, _MDStoreOIDArrayEndSequence, _MDStoreOIDArrayGetMappedVector,
_MDStoreOIDArrayGetTypeID, _MDStoreOIDArrayGetVector, _MDStoreOIDArrayGetVectorCount,
_MDStoreOIDArrayRoom, _MDStoreOIDArraySetShouldDeallocate,
_MDStoreOIDArraySetShouldUseMalloc, _MDUniquiedStringDictCreate,
__MDPlistBytesAddObject, __MDPlistBytesAddUInt64Array, __MDPlistBytesAddURL,
__MDPlistBytesAppendChunk, __MDPlistBytesFirstChunk, __MDPlistBytesNextChunk,
__MDPlistBytesReadFromFile, __MDPlistBytesWriteToFile, __MDPlistGetRootPlistObject,
_kMDPlistBytesDeserializationCallbacks ]
objc-classes: [ _MDMutablePlistBytes, _MDPlistBytes ]
...
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/Metadata.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/Metadata.framework/Headers/MDImporter.h | /*
* MDImporter.h
* Copyright (c) 2004-2019, Apple Inc. All rights reserved.
*/
/*!
@header MDImporter.h
MDImporter is the link between the metadata contained within a
file and an MDItem. The Server listens for changes to files
and loads in a CFPlugIn (MDImporter) and the importer will then
extract all interesting data out of the file to store in a MDItem.
*/
#if !defined(__MDIMPORTER__)
#define __MDIMPORTER__ 1
#include <CoreFoundation/CoreFoundation.h>
#if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_4
#include <Metadata/MDItem.h>
#if defined(__cplusplus)
extern "C" {
#endif
/*!
@constant kMDImporterTypeID The importer only loads CFPlugIns of type
kMDImporterTypeID - 8B08C4BF-415B-11D8-B3F9-0003936726FC
@constant kMDImporterInterfaceID Importers must implement this
Interface - 6EBC27C4-899C-11D8-84A3-0003936726FC
@constant kMDExporterInterfaceID Exporters can optionaly also implement this
Interface - B41C6074-7DFB-4057-969D-31C8E861A8D4
@constant kMDImporterURLInterfaceID Importers can optionaly also implement this
Interface - B41C6074-7DFB-4057-969D-31C8E861A8D4
@constant kMDImporterBundleWrapperURLInterfaceID Importers can optionaly also implement this
Interface - CF76374B-0C83-47C5-AB2F-7B950884670A
*/
#define kMDImporterTypeID CFUUIDGetConstantUUIDWithBytes(kCFAllocatorDefault,0x8B,0x08,0xC4,0xBF,0x41,0x5B,0x11,0xD8,0xB3,0xF9,0x00,0x03,0x93,0x67,0x26,0xFC)
#define kMDImporterInterfaceID CFUUIDGetConstantUUIDWithBytes(kCFAllocatorDefault,0x6E,0xBC,0x27,0xC4,0x89,0x9C,0x11,0xD8,0x84,0xAE,0x00,0x03,0x93,0x67,0x26,0xFC)
#define kMDExporterInterfaceID CFUUIDGetConstantUUIDWithBytes(kCFAllocatorDefault,0xB4,0x1C,0x60,0x74,0x7D,0xFB,0x40,0x57,0x96,0x9D,0x31,0xC8,0xE8,0x61,0xA8,0xD4)
#define kMDImporterURLInterfaceID CFUUIDGetConstantUUIDWithBytes(kCFAllocatorDefault, 0x13,0xF6,0x0F,0x02,0x36,0x22,0x4F,0x35,0x98,0x91,0xEC,0x10,0xE6,0xCD,0x08,0xF8)
#define kMDImporterBundleWrapperURLInterfaceID CFUUIDGetConstantUUIDWithBytes(kCFAllocatorDefault, 0xCF,0x76,0x37,0x4B,0x0C,0x83,0x47,0xC5,0xAB,0x2F,0x7B,0x95,0x08,0x84,0x67,0x0A)
/*!
@typedef MDImporterInterfaceStruct
Interface for the plugIn. The plugin needs to provide at least
the ImporterImportData function.
@function ImporterImportData
Import data from the file given to by path into the system.
@param thisInterface this plugin
@param attributes any attributes that can be gotten from the
file should be places in the attributes
CFMutableDictionaryRef. For example if the file has a
kMDItemDurationSeconds then the key would be kMDItemDurationSeconds and the
value would be a CFNumberRef containing the duration of the
song etc. If you want to remove an attribute, then in the
dictionary place the attribute and set the value of the
attribute to kCFNull.
@param contentTypeUTI The content type (a uniform type identifier)
of the file that is given to this plugin.
@param pathToFile location of the file on disk.
@result Boolean indicating if the import was successful
@typedef MDExporterInterfaceStruct
Interface for exporting data from the mdimport system back to the file.
@function ImporterExportData
@param thisInterface this plugin
@param attributes any attributes should be written back to the file
@param contentTypeUTI The content type (a uniform type identifier)
of the file that is given to this plugin.
@param pathToFile location of the file on disk.
@result Boolean indicating if the export was successful
*/
#if defined(__COREFOUNDATION_CFPLUGINCOM__)
typedef struct {
IUNKNOWN_C_GUTS;
Boolean (*ImporterImportData)(void *thisInterface,
CFMutableDictionaryRef attributes,
CFStringRef contentTypeUTI,
CFStringRef pathToFile);
} MDImporterInterfaceStruct;
typedef struct {
IUNKNOWN_C_GUTS;
Boolean (*ImporterExportData)(void *thisInterface,
CFDictionaryRef attributes,
CFStringRef contentTypeUTI,
CFStringRef pathToFile);
} MDExporterInterfaceStruct;
typedef struct {
IUNKNOWN_C_GUTS;
Boolean (*ImporterImportURLData)(void *thisInterface,
CFMutableDictionaryRef attributes,
CFStringRef contentTypeUTI,
CFURLRef urlForFile);
} MDImporterURLInterfaceStruct;
typedef struct {
IUNKNOWN_C_GUTS;
Boolean (*ImporterImportBundleWrapperURLData)(void *thisInterface,
CFMutableDictionaryRef attributes,
CFStringRef contentTypeUTI,
CFURLRef urlForFile);
} MDImporterBundleWrapperURLInterfaceStruct;
#endif
#if defined(__cplusplus)
}
#endif
#endif /* MAC_OS_X_VERSION_MAX_ALLOWED */
#endif /* __MDIMPORTER__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/Metadata.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/Metadata.framework/Headers/MDQuery.h | /*
* MDQuery.h
* Copyright (c) 2003-2019, Apple Inc. All rights reserved.
*/
/*!
@header MDQuery
MDQuery is a CF-compliant object, and follows the CF conventions,
and can be used with the CF polymorphic functions, like CFRetain().
MDQuery encapsulates all queries against the MetaData
database. Queries gather results or process updates only while
the current thread's run loop is running. Queries normally
operate asynchronously, and only send out progress
notificiations as the list is being collected. The query list
is kept up to date with respect to value lists and sorting as
the progress notifications are sent out, so the query is in a
good state during those events.
Result Retreval
An MDQueryRef presents its results as if it were a simple
array object. The results can either be MDItemRefs (the
default) or custom structs, CFTypeRefs, or Objective C
objects. For example if the result objects are represented
as 'FSNodes' (a type defined in the client application) a
call to MDQueryGetResultAtIndex() will return an FSNode
object. This is useful, because it allows the Metadata
library to maintain the results in a form that is directly
useable in the application.
Query Sorting
Sorting the results from a query can be performed in one of
two ways. First is to let the library sort the results for you
by passing an array of attributes to sort on to
MDQueryCreate(). The default sort provided by MDQueryCreate()
is a assending sort strings are compared using
CFStringCompare() with the options kCFCompareNonliteral |
kCFCompareLocalized | kCFCompareNumerically. CFDataRefs are
compared by using memcmp() of the data pointers. If an Item
does not have the attribute, it compares less than the
attribute that is there.
If you need to do a more complex sort (like a case insensitive
sort on CFStringRefs) then you will need to also provide a
comparitor function and call MDQuerySetSortComparator(), and
also provide which attributes to sort on to MDQueryCreate().
Undefined Behavior
For functions which take an MDQueryRef parameter, if this
parameter is not a valid MDQueryRef, the behavior is
undefined. NULL is not a valid MDQueryRef.
For functions which take CF*Ref parameters, such as
CFStringRef and CFArrayRef, if this parameter is not a
valid CF object of the correct type, the behavior is
undefined. NULL is not a valid CF*Ref.
Additional constraints or allowed values on parameters
are noted with the specific functions.
*/
#if !defined(__MDQUERY__)
#define __MDQUERY__ 1
#include <CoreFoundation/CoreFoundation.h>
#if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_4
#include <Metadata/MDItem.h>
CF_IMPLICIT_BRIDGING_ENABLED
MD_BEGIN_C_DECLS
/*!
@typedef MDQueryRef
This is the type of a reference to MDQuerys.
*/
typedef struct CF_BRIDGED_TYPE(id) __MDQuery * MDQueryRef;
typedef enum {
kMDQuerySynchronous = 1,
kMDQueryWantsUpdates = 4,
kMDQueryAllowFSTranslation = 8
} MDQueryOptionFlags;
/*!
@enum MDQueryOptionFlags
@constant kMDQuerySynchronous Block during the gathering phase.
If this parameter is true, the function will not return
until the query has finished gathering the initial
results. The run loop will run in the default mode, which
will allow anything registered in that mode with this run
loop to execute as well. If this parameter is false, the
function returns immediately after starting the query
asychronously.
@constant kMDQueryWantsUpdates When set, after gathering the initial results
the query will watch for changes in the system which should
update the list of results. This can be changes which cause
new files to now match the query, or changes which cause
files in the result list to continue to match, or no longer
match, the query. Files which begin to match the query are
added to the result list, and files which no longer match
the query expression are removed from the result list.
Currently, this parameter is ignored if the synchronous
parameter is true. This is subject to change, and you
should always pass in the value you want here.
*/
/*!
@function MDQueryGetTypeID
Returns the type identifier of all MDQuery instances.
*/
MD_EXPORT CFTypeID MDQueryGetTypeID(void) MD_AVAIL;
/*!
@function MDQueryCreate
Creates a new query with the given query expression.
@param allocator The CFAllocator which should be used to allocate
memory for the query and its sub-storage. This
parameter may be NULL in which case the current default
CFAllocator is used.
@param queryString The query expression string for this query. The
syntax for query expressions is explained above in the
header overview documentation.
@param valueListAttrs An optional array of attribute names. The
query will collect the values of these attributes into
uniqued lists, which can be used or displayed to summarize
the results of the query, or allow a user to further
qualify the items for which they are searching. This
parameter may be NULL if no value lists are desired. Value
list collection increases CPU usage and significantly
increases the memory usage of an MDQuery. The attribute
names are CFStrings.
@param sortingAttrs An optional array of attribute names. The
query will results of the query based on the values of
these attributes. The first name in the array is used as
the primary sort key, the second as the secondary key, and
so on. The comparison of like-typed values is a simple,
literal comparison. This parameter may be NULL if no
sorting is desired. Sorting increases memory usage and
significantly increases the CPU usage of an MDQuery.
However, when possible, it is almost always cheaper to have
the MDQuery do the sorting, rather than you fetching all
the results and attributes from each of them and doing the
sorting yourself. The attribute names are CFStrings.
@result An MDQueryRef, or NULL on failure. If the query string
is empty or malformed (invalid syntax), returns NULL.
*/
MD_EXPORT MDQueryRef MDQueryCreate(CFAllocatorRef allocator, CFStringRef queryString, CFArrayRef valueListAttrs, CFArrayRef sortingAttrs) MD_AVAIL;
/*!
@function MDQueryCreateSubset
Creates a new query, which is a subset of the given query. Only
results matched by the given query can be matched by the
query expression of this query.
@param allocator The CFAllocator which should be used to allocate
memory for the query and its sub-storage. This
parameter may be NULL in which case the current default
CFAllocator is used.
@param query The parent query of the new query.
@param queryString The query expression string for this query.
This expression in effect may further restrict the matches
found by the parent query. If the string is empty the
behavior is undefined.
@param valueListAttrs An optional array of attribute names. The
query will collect the values of these attributes into
uniqued lists, which can be used or displayed to summarize
the results of the query, or allow a user to further
qualify the items for which they are searching. This
parameter may be NULL if no value lists are desired. Value
list collection increases CPU usage and significantly
increases the memory usage of an MDQuery. The attribute
names are CFStrings.
@param sortingAttrs An optional array of attribute names. The
query will sort results of the query based on the values of
these attributes. The first name in the array is used as
the primary sort key, the second as the secondary key, and
so on. The comparison of like-typed values is a simple,
literal comparison. This parameter may be NULL if no
sorting is desired. Sorting increases memory usage and
significantly increases the CPU usage of an MDQuery.
However, when possible, it is almost always cheaper to have
the MDQuery do the sorting, rather than you fetching all
the results and attributes from each of them and doing the
sorting yourself. The attribute names are CFStrings.
@result An MDQueryRef, or NULL on failure. If the query string
is empty or malformed (invalid syntax), returns NULL.
*/
MD_EXPORT MDQueryRef MDQueryCreateSubset(CFAllocatorRef allocator, MDQueryRef query, CFStringRef queryString, CFArrayRef valueListAttrs, CFArrayRef sortingAttrs) MD_AVAIL;
/*!
@function MDQueryCreateForItems
Creates a new query with the given query expression.
@param allocator The CFAllocator which should be used to allocate
memory for the query and its sub-storage. This
parameter may be NULL in which case the current default
CFAllocator is used.
@param queryString The query expression string for this query. The
syntax for query expressions is explained above in the
header overview documentation.
@param valueListAttrs An optional array of attribute names. The
query will collect the values of these attributes into
uniqued lists, which can be used or displayed to summarize
the results of the query, or allow a user to further
qualify the items for which they are searching. This
parameter may be NULL if no value lists are desired. Value
list collection increases CPU usage and significantly
increases the memory usage of an MDQuery. The attribute
names are CFStrings.
@param sortingAttrs An optional array of attribute names. The
query will results of the query based on the values of
these attributes. The first name in the array is used as
the primary sort key, the second as the secondary key, and
so on. The comparison of like-typed values is a simple,
literal comparison. This parameter may be NULL if no
sorting is desired. Sorting increases memory usage and
significantly increases the CPU usage of an MDQuery.
However, when possible, it is almost always cheaper to have
the MDQuery do the sorting, rather than you fetching all
the results and attributes from each of them and doing the
sorting yourself. The attribute names are CFStrings.
@param items An array of items. The query will only return results
in this set.
@result An MDQueryRef, or NULL on failure. If the query string
is empty or malformed (invalid syntax), returns NULL.
*/
MD_EXPORT MDQueryRef MDQueryCreateForItems(CFAllocatorRef allocator,
CFStringRef queryString,
CFArrayRef valueListAttrs,
CFArrayRef sortingAttrs,
CFArrayRef items) API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos );
/*!
@function MDQueryCopyQueryString
Returns the query string of the query.
@param query The query to be interrogated.
@result The query string of the query.
*/
MD_EXPORT CFStringRef MDQueryCopyQueryString(MDQueryRef query) MD_AVAIL;
/*!
@function MDQueryCopyValueListAttributes
Returns the list of attribute names for which the query is
collecting the lists of values.
@param query The query to be interrogated.
@result The list of value list attribute names of the query.
*/
MD_EXPORT CFArrayRef MDQueryCopyValueListAttributes(MDQueryRef query) MD_AVAIL;
/*!
@function MDQueryCopySortingAttributes
Returns the list of attribute names the query is using to sort
the results.
@param query The query to be interrogated.
@result The list of sorting attribute names of the query.
*/
MD_EXPORT CFArrayRef MDQueryCopySortingAttributes(MDQueryRef query) MD_AVAIL;
/*!
@typedef MDQueryBatchingParams
Structure containing the progress notification batching
parameters of an MDQuery. The first notification can be
triggered by the either first_max_num or first_max_ms limit
being exceeded. Subsequent notifications are triggered by
either the progress_max_num or progress_max_ms limit. The
default batching parameters are undefined and subject to
change.
@field first_max_num The maximum number of results that can
accumulate before a progress notification is sent out
by the MDQuery, for the first notification.
@field first_max_ms The maximum number of milliseconds that can
pass before a progress notification is sent out. This
value is advisory, in that the notification will be
triggered "at some point after first_max_ms milliseconds
have passed since the query began accumulating results",
but generally not very long after, for the first
progress notification.
@field progress_max_num The maximum number of results that can
accumulate before a progress notification is sent out
by the MDQuery, for notifications after the first,
during the initial gathering phase of the query.
@field progress_max_ms The maximum number of milliseconds that can
pass before a progress notification is sent out. This
value is advisory, in that the notification will be
triggered "at some point after first_max_ms milliseconds
have passed since the query began accumulating results",
but generally not very long after, for progress
notifications after the first, during the initial
gathering phase of the query.
@field update_max_num The maximum number of results that can
accumulate before an update notification is sent out
by the MDQuery, for notifications after the gathering
phase of the query has finished.
@field update_max_ms The maximum number of milliseconds that can
pass before a progress notification is sent out. This
value is advisory, in that the notification will be
triggered "at some point after first_max_ms milliseconds
have passed since the query began accumulating results",
but generally not very long after, for update notifications
after the gathering phase of the query has finished.
*/
typedef struct {
size_t first_max_num;
size_t first_max_ms;
size_t progress_max_num;
size_t progress_max_ms;
size_t update_max_num;
size_t update_max_ms;
} MDQueryBatchingParams;
/*!
@function MDQueryGetBatchingParameters
Returns the current parameters that control batching of progress
notifications.
@param query The query to be interrogated.
@result An MDQueryBatchingParams structure with the current
batching parameters.
*/
MD_EXPORT MDQueryBatchingParams MDQueryGetBatchingParameters(MDQueryRef query) MD_AVAIL;
/*!
@function MDQuerySetBatchingParameters
@param query The query whose batching parameters are to be set.
@param params An MDQueryBatchingParams structure with the batching
parameters to set.
*/
MD_EXPORT void MDQuerySetBatchingParameters(MDQueryRef query, MDQueryBatchingParams params) MD_AVAIL;
/*!
@typedef MDQueryCreateResultFunction
Type of the callback function used to create the result objects
stored and returned by an MDQuery. The function may
hold onto the given MDItemRef in some other data
structure, but must retain it for it to remain valid.
The create-result function is called lazily as results
are requested from a query, so it will not generally
be called on all results, if in fact any. This avoids
the cost of creating potentially hundreds of thousands
of what might be temporary objects.
@param query The MDQuery instance.
@param item The default MDItemRef for the result.
@param context The user-defined context parameter given to
MDQuerySetCreateResultFunction().
@result The function must return a pointer-sized value that can
be managed with the callbacks which were set at the same
time the create function was given to the query. The
value must be returned with a reference (such as if the
retain callback had been called on it), as implied by the
Create name. If this function doesn't wish to create a
new object, it can return the given MDItemRef, but must
also return it with a new retain, and the callbacks must
be able to handle an MDItemRef as an input value. If
this function returns NULL, NULL will be stored for the
moment in the query, MDQueryGetResultAtIndex() may return
NULL for that result, and the next time the query wants
the result, it will call this function again.
*/
typedef const void *(*MDQueryCreateResultFunction)(MDQueryRef query, MDItemRef item, void *context);
/*!
@function MDQuerySetCreateResultFunction
Sets the function used to create the result objects of the
MDQuery. If no create function is set on an MDQuery,
the default result objects are MDItemRefs. Results
created after a create function is set will be created
through the given create function, but values created
before the function was set (or after it is unset) are
not modified. Therefore it is not advisable to change
this function after MDQueryExecute() has been called
with the query. The create-result function is called
lazily as results are requested from a query, so it will
not generally be called on all results, if in fact any.
This avoids the cost of creating potentially hundreds
of thousands of what might be temporary objects.
@param query The query to whose result create function is to be set.
@param func The callback function the MDQuery will use to
create its results, such as those returned from
MDQueryGetResultAtIndex(). This parameter
may be NULL, in which case any previous result creation
settings are cancelled, and the MDQuery will subsequently
produce MDItemRefs. If the function (when the parameter is
not NULL) is not of type MDQueryCreateResultFunction or
does not behave as a MDQueryCreateResultFunction must,
the behavior is undefined.
@param context A pointer-sized user-defined value, which is
passed as the third parameter to the create function,
but is otherwise unused by MDQuery. The MDQuery does
not retain the context in any way, so it must remain
valid for at least the lifetime of the query. If the
context is not what is expected by the create function,
the behavior is undefined.
@param cb A pointer to a CFArrayCallBacks structure
initialized with the callbacks for the query to use to
manage the created result objects. 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 query creations. Only version
0 of the CFArrayCallBacks is supported. The retain field
may be NULL, in which case the MDQuery will do nothing to
add a retain to the created results for the query. The
release field may be NULL, in which case the MDQuery will
do nothing to remove the query's retain (such as the one
it gets from the create function) on the result objects
when the query is destroyed. If the copyDescription field
is NULL, the query will create a simple description for
the result objects. If the equal field is NULL, the query
will use pointer equality to test for equality of results.
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 value values returned from the
create function is not one understood by one or more of
the callback functions, the behavior when those callback
functions are used is undefined. For example, if the create
function can return NULL, then NULL must be understood by
the callback functions as a possible parameter. The retain
and release callbacks must be a matched set -- do not
assume that the retain function will be unused or that
additional reference counts will not be taken on the
created results.
*/
MD_EXPORT void MDQuerySetCreateResultFunction(MDQueryRef query, MDQueryCreateResultFunction func, void *context, const CFArrayCallBacks *cb) MD_AVAIL;
/*!
@typedef MDQueryCreateValueFunction
Type of the callback function used to create the value objects
stored and returned by an MDQuery. The function may
hold onto the given attribute name and/or value in some
other data structure, but must retain them for them to
remain valid.
@param query The MDQuery instance.
@param attrName The attribute name of the value.
@param attrValue The default value of the value.
@param context The user-defined context parameter given to
MDQuerySetCreateValueFunction().
@result The function must return a pointer-sized value that can
be managed with the callbacks which were set at the same
time the create function was given to the query. The
value must be returned with a reference (such as if the
retain callback had been called on it), as implied by the
Create name. If this function doesn't wish to create a
new object, it can return the given CFTypeRef, but must
also return it with a new retain, and the callbacks must
be able to handle a CFTypeRef as an input value.
*/
typedef const void *(*MDQueryCreateValueFunction)(MDQueryRef query, CFStringRef attrName, CFTypeRef attrValue, void *context);
/*!
@function MDQuerySetCreateValueFunction
Sets the function used to create the value objects of the
MDQuery. These are the values of the value lists that
were requested when the query was created. If no create
function is set on an MDQuery, the default value objects
are the CFTypeRef values of the attributes. Values
created after a create function is set will be created
through the given create function, but values created
before the function was set (or after it is unset)
are not modified. Therefore it is not advisable to
change this function after MDQueryExecute() has been
called with the query.
@param query The query to whose value create function is to be set.
@param func The callback function the MDQuery will use to
create the value list values, such as those returned from
MDQueryCopyValuesOfAttribute(). This parameter
may be NULL, in which case any previous value creation
settings are cancelled, and the MDQuery will subsequently
produce the default CFTypeRefs. If the function (when the
parameter is not NULL) is not of type
MDQueryCreateValueFunction or does not behave as a
MDQueryCreateValueFunction must, the behavior is undefined.
@param context A pointer-sized user-defined value, which is
passed as the fourth parameter to the create function,
but is otherwise unused by MDQuery. The MDQuery does
not retain the context in any way, so it must remain
valid for at least the lifetime of the query. If the
context is not what is expected by the create function,
the behavior is undefined.
@param cb A pointer to a CFArrayCallBacks structure
initialized with the callbacks for the query to use to
manage the created value objects. 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 query creations. Only version
0 of the CFArrayCallBacks is supported. The retain field
may be NULL, in which case the MDQuery will do nothing to
add a retain to the created values for the query. The
release field may be NULL, in which case the MDQuery will
do nothing to remove the query's retain (such as the one
it gets from the create function) on the value objects
when the query is destroyed. If the copyDescription field
is NULL, the query will create a simple description for
the value objects. If the equal field is NULL, the query
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 value values returned from the
create function is not one understood by one or more of
the callback functions, the behavior when those callback
functions are used is undefined. For example, if the
create function can return NULL, then NULL must be
understood by the callback functions as a possible
parameter. The retain and release callbacks must be a
matched set -- do not assume that the retain function will
be unused or that additional reference counts will not be
taken on the created values.
*/
MD_EXPORT void MDQuerySetCreateValueFunction(MDQueryRef query, MDQueryCreateValueFunction func, void *context, const CFArrayCallBacks *cb) MD_AVAIL;
/*!
@function MDQuerySetDispatchQueue
Set the dispatch queue on which query results will be delivered
by MDQueryExecute. It is not advisable to change set
dispatch queue after MDQueryExecute() has been called with
the query. Setting the dispatch queue for a synchronous
query (kMDQuerySynchronous) has no effect.
@param query The query for which the dispatch queue should be set.
@param queue The dispatch queue on which results should be delivered.
*/
MD_EXPORT void MDQuerySetDispatchQueue(MDQueryRef query, dispatch_queue_t queue) API_AVAILABLE( macos(10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
/*!
@function MDQueryExecute
Run the query, and populate the query with the results. Queries
only gather results or process updates while the current
thread's run loop is running. Queries normally operate
asynchronously, and send out progress and update
notifications to report changes to the list of results
that has been collected. Queries have two phases: the
initial gathering of all currently matching results, and
a second live-update phase where queries monitor the
state of the system and update themselves to external
changes in files or the operating environment (for example,
as time advances, files which did not match the query
when it was started may later match the query). Query
notifications are posted within the context of the same
thread which executes the query.
[[There are three operational modes: (1) synchronous static
queries, which collect the list of current results and then
do not watch for updates to the results, (2) asynchronous
static queries, which collect the results asychronously
after this function returns, and then do not watch for
updates to the results, and (3) asynchronous live queries
which collect the initial results asychronously after this
function returns, and then do watch for updates to the
results, until the query is destroyed. There is little
reason not to allow the fourth case, synchronous collection
of initial results, followed by asynchronous monitoring
for updates, so this may change in the future.]]
@param query The query to execute.
@param optionFlags Bitwise or of MDQueryOptionFlags
@result Returns true if the query was started (executed in the case
of a synchronous query), false otherwise. Queries cannot be
executed more than once.
*/
MD_EXPORT Boolean MDQueryExecute(MDQueryRef query, CFOptionFlags optionFlags) MD_AVAIL;
/*!
@function MDQueryStop
Stops the query from ever generating more results. Queries may be
executed only once, so a stopped query cannot be
restarted. The query will also not generate any result
updates. The query is static after this function returns.
The query will do final processing of results that have
come in but not yet been processed (because, say, the
batching parameters hasn't triggered that yet). That may
trigger a progress notification, so be aware of that if
you are stopping a query from within your progress note
handler; that is, during this function, a recursive
progress and/or finished notification might occur, which
might recursively call your notification handler. It is
safe to call this function recursively. You would call
this function to stop a query that is generating way too
many results to be useful, but still want to access the
results that have come in so far. If a query is stopped
before the gathering phase finishes, it will not report
itself as finished, nor will it send out a finished
notification.
@param query The query to stop.
*/
MD_EXPORT void MDQueryStop(MDQueryRef query) MD_AVAIL;
/*!
@function MDQueryDisableUpdates
Disables updates to the query result list. This should be called
before iterating through the list of results to prevent
the result list from changing during the iteration. The
disabled state is a counter, and disabling can be done
recursively and from different threads.
@param query The query for which updates are to be disabled.
@result The generation number of the query. This changes each time the query's
result set has changed.
*/
MD_EXPORT void MDQueryDisableUpdates(MDQueryRef query) MD_AVAIL;
/*!
@function MDQueryEnableUpdates
Re-enables updates to the query result list. This should be called
when finished iterating through the list of results, to
allow changes to the result list to occur. Changes will
be allowed when all the disables have been matched by a
corresponding enable.
@param query The query for which updates are to be enabled.
*/
MD_EXPORT void MDQueryEnableUpdates(MDQueryRef query) MD_AVAIL;
/*!
@function MDQueryIsGatheringComplete
Returns true if the first phase of a query, the initial result
gathering, has finished.
@param query The query to be interrogated.
@result A boolean indicating whether or not the first phase
of a query has completed.
*/
MD_EXPORT Boolean MDQueryIsGatheringComplete(MDQueryRef query) MD_AVAIL;
/*!
@function MDQueryGetResultCount
Returns the number of results currently collected by the query.
Note that the number of results in a query will change
over time as the query's result list is updated.
@param query The query to be interrogated.
@result The number of results in the query.
*/
MD_EXPORT CFIndex MDQueryGetResultCount(MDQueryRef query) MD_AVAIL;
/*!
@function MDQueryGetResultAtIndex
Returns the current result at the given index. This function
causes the result object to be created if it hasn't
been created already. For performance reasons, it is
not advisable to ask for results that you don't need,
to avoid the cost of creating them. If possible, call
this function to fetch only the results you need to
display or otherwise process. Note that the index of
a particular result will change over time, as the
query's result list is updated.
@param query The query to be interrogated.
@param idx The index into the query's result list. If the index is
negative, or is equal to or larger than the current
number of results in the query, the behavior is undefined.
@result Returns the MDItemRef currently at the given index, or
if a result-create function has been set, returns the
result returned by that function.
*/
MD_EXPORT const void *MDQueryGetResultAtIndex(MDQueryRef query, CFIndex idx) MD_AVAIL;
/*!
@function MDQueryGetIndexOfResult
Returns the current index of the given result. If a result-create
function has been set, and the equal callback is non-NULL,
it will be used to test the query's results against the
candidate result. Note that the index of a result will
change over time, as the query's result list is updated.
@param query The query to be interrogated.
@param result The candidate result object for which to search.
If a custom create-result function has been set, and this
parameter is not a valid result object that the provided
callbacks can handle, the behavior is undefined. If a custom
create-result function has not been set, this parameter
must be a valid MDItemRef.
@result The index of the given result, or kCFNotFound if the
value is not one of the query's existing results. If
you provided a custom result creation function,
as well as a custom object comparator function,
result will be objects created by that function.
*/
MD_EXPORT CFIndex MDQueryGetIndexOfResult(MDQueryRef query, const void *result) MD_AVAIL;
/*!
@function MDQueryGetAttributeValueOfResultAtIndex
Returns the value of the named attribute for the result at
the given index.
@param query The query to be interrogated.
@param name The attribute name for which to return the values.
If the attribute is not one of those requested in the
valueListAttrs or sortingAttrs parameters to one of
the query creation functions, the result will be NULL.
@param idx The index into the query's result list. If the index is
negative, or is equal to or larger than the current
number of results in the query, the behavior is undefined.
@result The value of the attribute, or NULL if the attribute
doesn't exist in the query on that result.
*/
MD_EXPORT void *MDQueryGetAttributeValueOfResultAtIndex(MDQueryRef query, CFStringRef name, CFIndex idx) MD_AVAIL;
/*!
@function MDQueryCopyValuesOfAttribute
Returns the list of values, from the results of the query, of the
named attribute. The list is not ordered in any way. The
list contains only one occurrence of each value. Note that
this list may change over time, as the query's result list
is updated.
@param query The query to be interrogated.
@param name The attribute name for which to return the values.
If the attribute is not one of those requested in the
valueListAttrs parameter to one of the query creation
functions, the behavior is undefined.
@result A CFArray holding the value objects for that attribute.
*/
MD_EXPORT CFArrayRef MDQueryCopyValuesOfAttribute(MDQueryRef query, CFStringRef name) MD_AVAIL;
/*!
@function MDQueryGetCountOfResultsWithAttributeValue
Returns the number of results which have the given attribute and
attribute value. Note that this count may change over time,
as the query's result list is updated.
@param query The query to be interrogated.
@param name The attribute name for which to return the number
of results with the given value. If the attribute is not
one of those requested in the valueListAttrs parameter to
one of the query creation functions, the behavior is
undefined.
@param value The attribute value for which to return the number
of results with that value. This parameter may be NULL,
in which case the number of results that do not contain
the named attribute is returned.
@result The number of results with that attribute and value.
*/
MD_EXPORT CFIndex MDQueryGetCountOfResultsWithAttributeValue(MDQueryRef query, CFStringRef name, CFTypeRef value) MD_AVAIL;
/*!
@function MDQuerySetSortOrder
Sets the sort order for a query.
@param query The query for which the sort order is to be set.
@param sortingAttrs An array of attribute names, as in MDQueryCreate.
The query's result set will be sorted according to the order of
these attributes. All names in the array have to have been passed
as sortingAttrs when the query was created. The attribute names
are CFStrings
@result A boolean, true on success, false on failure.
*/
MD_EXPORT Boolean MDQuerySetSortOrder(MDQueryRef query, CFArrayRef sortingAttrs) API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos );
/*!
@enum MDQuerySortOptionFlags
@constant kMDQueryReverseSortOrderFlag Sort the attribute in reverse order.
*/
typedef enum {
kMDQueryReverseSortOrderFlag = (1<<0),
} MDQuerySortOptionFlags;
/*!
@function MDQuerySetSortOptionFlagsForAttribute
Sets the sort flags for a query.
@param query The query for which the sort flags is to be set.
@param fieldName The attribute name for which sort option flags are to be set.
The attribute name must have been part of the sortingFlags when the query was created.
@param flags A uint32_t containing MDQuerySortOptionFlags to be applied to the attibute
@result A boolean, true on success, false on failure.
*/
MD_EXPORT Boolean MDQuerySetSortOptionFlagsForAttribute(MDQueryRef query, CFStringRef fieldName, uint32_t flags) API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos );
/*!
@function MDQueryGetSortOptionFlagsForAttribute
Gets the sort option flags for a sorting attribute.
@param query The query for which fetch sort option flags.
@param fieldName The attribute name for which sort option flags are to be fetched.
@result A uint32_t, with MDQuerySortOptionFlags set for the attribute.
*/
MD_EXPORT uint32_t MDQueryGetSortOptionFlagsForAttribute(MDQueryRef query, CFStringRef fieldName) API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos );
/*!
@typedef MDQuerySortComparatorFunction
Type of the callback function used to sort the results of an
MDQuery.
@param query The MDQuery instance.
@param attrs1 A C array of attribute values for a result. The
values occur in the array in the same order and position
that the attribute names were passed in the sortingAttrs
array when the query was created. The values of the
attributes might be NULL, if the attribute doesn't exist
on a result or if read access to that attribute is not
allowed.
@param attrs2 A C array of attribute values for a result. The
values occur in the array in the same order and position
that the attribute names were passed in the sortingAttrs
array when the query was created. The values of the
attributes might be NULL, if the attribute doesn't exist
on a result or if read access to that attribute is not
allowed.
@param context The user-defined context parameter given to
MDQuerySetSortComparator().
@result The function must return one of the CFComparisonResults
kCFCompareLessThan, kCFCompareEqualTo, or
kCFCompareGreaterThan. There is no provision for unordered
results. The comparison must be a total order relation,
and additionally produce temporally identical results (that
is, produce the same results for the same inputs in the
future as now), for the sort results to be predictable.
*/
typedef CFComparisonResult (*MDQuerySortComparatorFunction)(const CFTypeRef attrs1[], const CFTypeRef attrs2[], void *context);
/*!
@function MDQuerySetSortComparator
Sets the function used to sort the results of an MDQuery. You
may set the comparator function as many times as you
like, even while the query is executing. Whenever the
comparator function is set, all results are re-sorted
using the new comparator function before the function
returns. The function pointer can be NULL to cancel
custom sorting and revert to the default sorting.
The default sort provided by MDQueryCreate()
is a assending sort strings are compared using
CFStringCompare() with the options kCFCompareNonliteral |
kCFCompareLocalized | kCFCompareNumerically. CFDataRefs are
compared by using memcmp() of the data pointers.
@param query The query to whose result sort function is to be set.
@param func The callback function the MDQuery will use to
sort its results. If the function (when the parameter is
not NULL) is not of type MDQuerySortComparatorFunction or
does not behave as a MDQuerySortComparatorFunction must,
the behavior is undefined. The function pointer may
be NULL to cancel any custom comparator.
@param context A pointer-sized user-defined value, which is
passed as the third parameter to the sort function,
but is otherwise unused by MDQuery. The MDQuery does
not retain the context in any way, so it must remain
valid for the lifetime of the query or until the sort
function is set again. If the context is not what is
expected by the comparator, the behavior is undefined.
*/
MD_EXPORT void MDQuerySetSortComparator(MDQueryRef query, MDQuerySortComparatorFunction comparator, void *context) MD_AVAIL;
/*!
@function MDQuerySetSortComparatorBlock
Sets the block used to sort the results of an MDQuery. You
may set the comparator block as many times as you
like, even while the query is executing. Whenever the
comparator block is set, all results are re-sorted
using the new comparator block before the function
returns. The block can be NULL to cancel
custom sorting and revert to the default sorting.
The default sort provided by MDQueryCreate()
is a assending sort strings are compared using
CFStringCompare() with the options kCFCompareNonliteral |
kCFCompareLocalized | kCFCompareNumerically. CFDataRefs are
compared by using memcmp() of the data pointers.
@param query The query to whose result sort block is to be set.
@param comparator The callback block the MDQuery will use to
sort its results. The comparator may be called on multiple threads in
parallel, and must be reentrant. To take advantage of parallel
sorting, it is best to avoid any locking in the comparator.
The block may be NULL to cancel any custom comparator.
*/
#ifdef __BLOCKS__
MD_EXPORT void MDQuerySetSortComparatorBlock(MDQueryRef query, CFComparisonResult (^comparator)(const CFTypeRef attrs1[], const CFTypeRef attrs2[])) API_AVAILABLE( macos(10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
#endif
/*!
@constant kMDQueryProgressNotification
The name of the notification sent to indicate changes to the
query's results list during the initial gathering phase
of a query's execution. Mostly adds will occur during
this phase, but removals and changes can also occur, as
in any update. This info dictionary parameter of the
notification can carry the kMDQueryUpdateChangedItems
and kMDQueryUpdateRemovedItems keys. Note that these
keys may be have empty arrays for values, or be missing,
if there are no changes of that particular type. For
performance reasons, added results are not indicated in
progress notifications (to avoid the cost of creating
the result objects). These notifications are sent out
by a query before the kMDQueryDidFinishNotification.
*/
MD_EXPORT const CFStringRef kMDQueryProgressNotification MD_AVAIL;
/*!
@constant kMDQueryDidFinishNotification
The name of the notification sent to indicate that the query has
finished with the initial result-gathering phase, and may
now proceed into the live-update phase (if that option
was chosen when the query was executed). This notification
often shortly follows after the last progress notification.
It is usually not necessary to update any displayed UI in
response to this notification, since it doesn't indicate
any change in the result list of a query.
*/
MD_EXPORT const CFStringRef kMDQueryDidFinishNotification MD_AVAIL;
/*!
@constant kMDQueryDidUpdateNotification
The name of the notification sent to indicate changes to the
query's results list during the second, live-update, phase
of a query's execution. This notification can carry the
kMDQueryUpdateAddedItems, kMDQueryUpdateChangedItems,
and kMDQueryUpdateRemovedItems keys in the info
dictionary parameter of the notification. Note that these
keys may be have empty arrays for values, or be missing,
if there are no changes of that particular type. These
notifications are sent out by a query after the
kMDQueryDidUpdateNotification.
*/
MD_EXPORT const CFStringRef kMDQueryDidUpdateNotification MD_AVAIL;
/*!
@constant kMDQueryUpdateAddedItems
The name of the key in a query notification's info dictionary
which identifies the list of added results. A result is
added if the file contents or some metadata attribute
of it is changed, and it now matches the query. Result
objects are created for the newly added results, to be
put in the list.
*/
MD_EXPORT const CFStringRef kMDQueryUpdateAddedItems MD_AVAIL;
/*!
@constant kMDQueryUpdateChangedItems
The name of the key in a query notification's info dictionary
which identifies the list of changed results. A result
is changed if the file contents or some metadata
attribute of it is changed, but it still matches the
query. The list only contains result objects which have
previously been created, and does not indicate results
which have been changed for which result objects have
not been created.
[[This is for performance reasons, to avoid creating
result objects just to represent a change of a result
which has not been looked at, but this semantic may
change.]]
*/
MD_EXPORT const CFStringRef kMDQueryUpdateChangedItems MD_AVAIL;
/*!
@constant kMDQueryUpdateRemovedItems
The name of the key in a query notification's info dictionary
which identifies the list of removed results. A result
can be removed if it no longer matches the query. The
list only contains result objects which have previously
been created, and does not indicate results which have
been removed for which result objects have not been
created.
[[This is for performance reasons, to avoid creating
temporary result objects just to represent the deletion
of the result, but this semantic may change.]]
*/
MD_EXPORT const CFStringRef kMDQueryUpdateRemovedItems MD_AVAIL;
/*!
@constant kMDQueryResultContentRelevance
The name of a query-specific attribute for use in sorting.
The relevance of an item is a CFNumberRef with a
floating point value. This is the relevance for
content searches.
The maximum and minimum values for a particular
search cannot be determined until all of the results
have been returned. If there are multiple
kMDItemTextContent predicates in the query, no
relevance is returned.
This is an attribute of a result item that is
specific to the item in the context of the query.
Also, the relevance does not compare the result
relative to the other results of a query, but is
computed just on the result item itself. Finally,
this is only the relevance value for content,
not a relevance for the item as a whole. The
relevance attribute may not even be computed for
an item if the item is found to match the query
through evaluation of other attributes of the
item than its contents. If the value is not
computed, it is treated as an attribute on the
item which does not exist (for sorting purposes,
for example).
*/
MD_EXPORT const CFStringRef kMDQueryResultContentRelevance MD_AVAIL;
/*!
@function MDQuerySetSearchScope
@discussion Use MDQuerySetSearchScope to limit the results
returned by the query engine to those MDItemRefs that
appear within the specified directories. This may be
used to limit searching to particular volumes. Tilde
paths, or environment variables are not expanded.
Calling this multiple times will replace the previous
options. This must be called before the query is executed.
@param query The query object to modify.
@param scopeDirectories a CFArray of CFStringRef or CFURLRef objects which
specify where to search. For conveinience, the kMDQueryScopeHome,
kMDQueryScopeComputer and kMDQueryScopeNetwork constants may also
be present in this array.
@param scopeOptions additional options for modifying the search.
Currently, pass 0 (zero).
*/
MD_EXPORT void MDQuerySetSearchScope(MDQueryRef query, CFArrayRef scopeDirectories, OptionBits scopeOptions) MD_AVAIL;
/*!
@constant kMDQueryScopeHome
A constant, which can be passed in the scopeDirectories array, to specify
that the search should be restricted to the volume and directory that contains
the current user's home directory
*/
MD_EXPORT const CFStringRef kMDQueryScopeHome MD_AVAIL;
/*!
@constant kMDQueryScopeComputer
A constant, which can be passed in the scopeDirectories array, to specify
that the search should be restricted to all locally mounted volumes, plus the user's
home directory (which may be on a remote volume).
*/
MD_EXPORT const CFStringRef kMDQueryScopeComputer MD_AVAIL;
/*!
@constant kMDQueryScopeNetwork
A constant, which can be passed in the scopeDirectories array, to specify
that the search should include all user mounted remote volumes.
*/
MD_EXPORT const CFStringRef kMDQueryScopeNetwork MD_AVAIL;
/*!
@constant kMDQueryScopeAllIndexed
A constant, which can be passed in the scopeDirectories array, to specify
that the search should be restricted to indexed, locally mounted volumes and
indexed user mounted remote volumes, plus the user's home directory.
*/
MD_EXPORT const CFStringRef kMDQueryScopeAllIndexed API_AVAILABLE( macos(10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
/*!
@constant kMDQueryScopeComputerIndexed
A constant, which can be passed in the scopeDirectories array, to specify
that the search should be restricted to indexed, locally mounted volumes, plus the user's
home directory (which may be on a remote volume).
*/
MD_EXPORT const CFStringRef kMDQueryScopeComputerIndexed API_AVAILABLE( macos(10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
/*!
@constant kMDQueryScopeNetworkIndexed
A constant, which can be passed in the scopeDirectories array, to specify
that the search should include indexed user mounted remote volumes.
*/
MD_EXPORT const CFStringRef kMDQueryScopeNetworkIndexed API_AVAILABLE( macos(10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
/*!
@function MDQuerySetMaxCount
@discussion Use MDQuerySetMaxCount to limit the number of results
returned by the query engine. This must be called before the query is executed.
@param query The query object to modify.
@param size The maximum number of results desired.
*/
MD_EXPORT void MDQuerySetMaxCount(MDQueryRef query, CFIndex size) MD_AVAIL_LEOPARD;
MD_END_C_DECLS
CF_IMPLICIT_BRIDGING_DISABLED
#endif /* MAC_OS_X_VERSION_MAX_ALLOWED */
#endif /* __MDQUERY__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/Metadata.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/Metadata.framework/Headers/MDItem.h | /* MDItem.h
Copyright (c) 2003-2019, Apple Inc. All rights reserved.
*/
/*!
@header MDItem
MDItem is a CF-compliant object, and follows the CF conventions,
and can be used with the CF polymorphic functions, like CFRetain().
An MDItemRef represents a file in the Metadata database, and the
metadata associated with the file.
Undefined Behavior
For functions which take an MDItemRef parameter, if this
parameter is not a valid MDItemRef, the behavior is
undefined. NULL is not a valid MDItemRef.
For functions which take CF*Ref parameters, such as
CFStringRef and CFArrayRef, if this parameter is not a
valid CF object of the correct type, the behavior is
undefined. NULL is not a valid CF*Ref.
A NULL CF*Ref parameter value is allowed only where
explicitly noted below.
Additional constraints or allowed values on parameters
are noted with the specific functions.
*/
#if !defined(__MDITEM__)
#define __MDITEM__ 1
#include <CoreFoundation/CoreFoundation.h>
#if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_4
#if !defined(MD_EXPORT)
#if defined(macintosh) && defined(__MWERKS__)
#define MD_EXPORT __declspec(export) extern
#else
#define MD_EXPORT extern
#endif
#define MD_AVAIL API_AVAILABLE( macos(10.4) ) API_UNAVAILABLE( ios, tvos, watchos )
#define MD_AVAIL_LEOPARD API_AVAILABLE( macos(10.5) ) API_UNAVAILABLE( ios, tvos, watchos )
#if defined(__cplusplus)
#define MD_BEGIN_C_DECLS extern "C" {
#define MD_END_C_DECLS }
#else
#define MD_BEGIN_C_DECLS
#define MD_END_C_DECLS
#endif
#if defined(macintosh) && defined(__MWERKS__)
#define MD_DEPRECATED
#else
#define MD_DEPRECATED __attribute__ ((deprecated))
#endif
#endif
CF_IMPLICIT_BRIDGING_ENABLED
MD_BEGIN_C_DECLS
/*!
@typedef MDItemRef
This is the type of a reference to MDItems.
*/
typedef struct CF_BRIDGED_TYPE(id) __MDItem * MDItemRef;
/*!
@function MDItemGetTypeID
Returns the type identifier of all MDItem instances.
*/
MD_EXPORT CFTypeID MDItemGetTypeID(void) MD_AVAIL;
/*!
@function MDItemCreate
Returns an metadata item for the given path.
@param allocator The CFAllocator which should be used to allocate
memory for the query and its sub-storage. This
parameter may be NULL in which case the current default
CFAllocator is used.
@param path A path to the file for which to create the MDItem.
[[Currently, the path must exist. MDItemRefs may or
may not be uniqued. Use CFEqual() to compare them.]]
@result An MDItemRef, or NULL on failure.
*/
MD_EXPORT MDItemRef MDItemCreate(CFAllocatorRef allocator, CFStringRef path) MD_AVAIL;
/*!
@function MDItemCreateWithURL
Returns an metadata item for the given path.
@param allocator The CFAllocator which should be used to allocate
memory for the query and its sub-storage. This
parameter may be NULL in which case the current default
CFAllocator is used.
@param url A url to the file for which to create the MDItem.
[[Currently, the file must exist. MDItemRefs may or
may not be uniqued. Use CFEqual() to compare them.]]
@result An MDItemRef, or NULL on failure.
*/
MD_EXPORT MDItemRef MDItemCreateWithURL(CFAllocatorRef allocator, CFURLRef url) API_AVAILABLE( macos(10.6) ) API_UNAVAILABLE( ios, tvos, watchos );
/*!
@function MDItemsCreateWithURLs
Returns metadata items for the given urls.
@param allocator The CFAllocator which should be used to allocate
memory for the array. This parameter may be NULL in which case the current default
CFAllocator is used.
@param urls A CFArray of urls to the file for which to create the MDItem.
@result A CFArrayRef of MDItemRefs, or NULL on failure. Missing items will have kCFNull entries in the result array.
*/
MD_EXPORT CFArrayRef MDItemsCreateWithURLs(CFAllocatorRef allocator, CFArrayRef urls) API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos );
/*!
@function MDItemCopyAttribute
Returns the value of the given attribute for the item.
@param item The item to be interrogated.
@param name The name of the desired attribute.
@result A CFTypeRef, or NULL on failure, or if the attribute
does not exist, of if the attribute is not readable.
*/
MD_EXPORT CFTypeRef MDItemCopyAttribute(MDItemRef item, CFStringRef name) MD_AVAIL;
/*!
@function MDItemCopyAttributes
Returns the values of the given attributes for the item.
@param item The item to be interrogated.
@param names A CFArray of the names of the desired attributes.
@result A CFDictionary where the keys are the attribute names,
and the values are the attribute values, or NULL on
failure. If an attribute does not exist, or is
unreadable, there will be no key-value pair for it
in the dictionary.
*/
MD_EXPORT CFDictionaryRef MDItemCopyAttributes(MDItemRef item, CFArrayRef names) MD_AVAIL;
/*!
@function MDItemCopyAttributeList
Returns the values of the given attributes for the item.
@param item The item to be interrogated.
@param ... A comma-separated varargs list of the string
attribute names.
@result A CFDictionary where the keys are the attribute names,
and the values are the attribute values, or NULL on
failure. If an attribute does not exist, or is
unreadable, there will be no key-value pair for
it in the dictionary.
*/
MD_EXPORT CFDictionaryRef MDItemCopyAttributeList(MDItemRef item, ... /* CFStringRef names */) MD_AVAIL;
/*!
@function MDItemCopyAttributeNames
Returns an array of the attribute names existing in the item.
@param item The item to be interrogated.
@result A CFArray of CFString attribute names, or NULL on
failure.
*/
MD_EXPORT CFArrayRef MDItemCopyAttributeNames(MDItemRef item) MD_AVAIL;
/*!
@function MDItemsCopyAttributes
Returns metadata for the given items.
@param items A CFArray of MDItemRefs to items for which to fetch data
@param names A CFArray of attribute names for which to fetch data.
The attribute names are CFStrings
@result A CFArrayRef, or NULL on failure. Each entry in the array is either kCFNull,
if the item is not accessible, or a CFArray of attribute values.
If an attribute is not available, there will be a kCFNull in its slot in the nested array.
*/
MD_EXPORT CFArrayRef MDItemsCopyAttributes(CFArrayRef items, CFArrayRef names) API_AVAILABLE( macos(10.12) ) API_UNAVAILABLE( ios, tvos, watchos );
/* List of well-known attributes */
/*!
@constant kMDItemAttributeChangeDate
This is the date that the last metadata attribute was changed.
@constant kMDItemContentType
UTI Type pedigree for a file for example a jpeg file will have the
following ItemContentType public.jpeg/public.image/public.data
the kMDItemContentType is set by the sniffer, any changes to this
value will get over written by the sniffer when the contents of
this MDItemRef changes. Type is a CFStringRef
@constant kMDItemKeywords
Represents keywords associated with this particular
MDItemRef. Example Keywords might be Birthday,Important etc. Type
is a CFArray of CFStrings
@constant kMDItemTitle
The title of this particular MDItemRef. Title of the document, or
it could be the title of this mp3 or a subject of a mail
message. Type is a CFString
@constant kMDItemAuthors
The list of author/authors that has worked on this file. There
could be 0 or more authors of a particular file. The order of the
authors in the array is preserved, but is not intended to represent
the main author or relative importance of the authors. Type is a
CFArray of CFStrings.
@constant kMDItemEditors
The list of editor/editors that has worked on this file. There
could be 0 or more editors of a particular file. The order of the
editors in the array is preserved, but is not intended to represent
the main editor or relative importance of the editors. Type is a
CFArray of CFStrings.
@constant kMDItemParticipants
The list of people who are visible in an image or movie or
written about in a document. Type is CFArray of CFStrings.
@constant kMDItemProjects
The list of projects etc that this file is part of. For example if
you were working on a movie, all of the movie files could be marked
as belonging to the project "My movie" then a query could be done
kMDItemProjects = "My movie" and all of the related files would
show up. Type is a CFArray of CFStrings
@constant kMDItemComment
This is a comment related to a file, and can be any random
string. Type is a CFString
@constant kMDItemCopyright
This is the copyright of the content. Type is a CFString
@constant kMDItemDownloadedDate
This is the date that the file was last downloaded / received.
@constant kMDItemWhereFroms
This attribute indicates where the item was obtained from.
Examples:
- downloaded file may refer to the site they were downloaded from,
the refering URL, etc
- files reveived by email may indicate who sent the file, the
message subject, etc
Type is a CFArray of CFStrings
@constant kMDItemLastUsedDate
This is the date that the file was last used, this field is updated
by LaunchServices everytime a file is opend by double clicking or
by asking LaunchServices to open a file. Type is a CFDate
@constant kMDItemContentCreationDate
This is the date that the contents of the file were created,
has an application specific semantic.
Type is a CFDate.
@constant kMDItemContentModificationDate
This is the date that the contents of the file were last
modified, has an application specific semantic. For example an
application can use this field to mark when the file was last
modified, this date is not related to the file system modification
date, but can be independent of that. This allows tracking of the
last time the content was modified irrespective of the last time the
file was modified. Type is a CFDate.
@constant kMDItemDateAdded
This is the date that the file was moved into the current location.
Not all files will have this attribute. Not all file systems support
this attribute.
@constant kMDItemDurationSeconds
This is the duration, in seconds, of the content of the file (if
appropriate). A value of 10.5 represents media whose content is
10 and 1/2 seconds long. Type is a CFNumber.
@constant kMDItemContactKeywords
A list of contacts that are somehow associated with this document,
beyond what is captured as Author.
@constant kMDItemVersion
A version number for this item. Type is a CFString
@constant kMDItemPixelHeight
The height of the document in pixels (ie Image height or Video frame height)
@constant kMDItemPixelWidth
The width of the document in pixels (ie Image width or Video frame width)
@constant kMDItemPixelCount
The total number of pixels in the document. Type is a CFNumber.
@constant kMDItemColorSpace
What color space model is this document following
(For example, are examples "RGB", "CMYK", "YUV", "YCbCr")
@constant kMDItemBitsPerSample
Number of bits per sample
For example bit depth of an image (8-bit, 16-bit etc..) or bit
depth per audio sample of uncompressed audio data (8, 16, 24, 32,
64, etc..)
@constant kMDItemFlashOnOff
Indicates if the flash was used to take the picture. 0 means flash did not fire
@constant kMDItemFocalLength
The actual focal length of the lens in mm.
@constant kMDItemAcquisitionMake
Device make that was used to acquire this document
@constant kMDItemAcquisitionModel
Device model that was used to acquire this document
@const kMDItemISOSpeed
The ISO Speed the camera was set to when the image was
taken. Examples are 100, 200, 400, etc.
@const kMDItemOrientation
The orientation of the data. Values are 0 is "Landscape" or 1 is "Portrait"
@const kMDItemLayerNames
The names of the various layers in the file
@const kMDItemWhiteBalance
The white balance setting of the camera when the image was
acquired. 0 is auto white balance and 1 is manual
@const kMDItemAperture
The size of the lens aperture as a log-scale APEX value
when the image was acquired.
@const kMDItemProfileName
Name of the color profile used for the image
@const kMDItemResolutionWidthDPI
Resolution width of this image in DPI
@const kMDItemResolutionHeightDPI
Resolution height of this image in DPI
@const kMDItemExposureMode
Mode that was used for the exposure. 0 is auto exposure, 1 is
manual, and 2 is auto bracket.
@const kMDItemExposureTimeSeconds
Time that the lens was open during exposure
@const kMDItemLensModel
Lens model that was used to acquire this document
@const kMDItemEXIFVersion
The verion of the EXIF header that was used to generate the metadata
@const kMDItemEXIFGPSVersion
The version of GPSInfoIFD header that was used to generate the metadata
@const kMDItemCodecs
The codecs used to encode/decode the media
@const kMDItemMediaTypes
Media types present in the content
@const kMDItemStreamable
Whether the content is prepared for streaming
@const kMDItemTotalBitRate
The total byte rate (audio & video combined) of the media
@const kMDItemVideoBitRate
The video byte rate
@const kMDItemAudioBitRate
The audio byte rate
@const kMDItemDeliveryType
Delivery type Fast start or RTSP
@constant kMDItemAlbum
The title for a collection of media. This is analagous to a record album,
or photo album whichs are collections of audio or images. Type is a CFString.
@constant kMDItemHasAlphaChannel
Boolean indicating if this image file has an alpha channel. Type is
a CFBoolean.
@constant kMDItemRedEyeOnOff
Indicates if the flash was used to take the picture. 0 means no
red-eye reduction mode or unknown. 1 means red-eye reduction
supported.
@const kMDItemMeteringMode
The metering mode (Unknown, Average, CenterWeightedAverage, Spot,
MultiSpot, Pattern, Partial)
@const kMDItemMaxAperture
The smallest F number of the lens. The unit is the APEX
value. Ordinarily it is given in the range of 00.00 to 99.99.
@const kMDItemFNumber
The focal length of the lens divided by the diameter of the aperture
when the image was acquired.
@const kMDItemExposureProgram
The class of the program used by the camera to set exposure when
the picture is taken (Manual, Normal, Aperture priority, ...)
@const kMDItemExposureTimeString
The time of the exposure.
@const kMDItemHeadline
A publishable entry providing a synopsis of the contents of the
objectdata.
@const kMDItemInstructions
Other editorial instructions concerning the use of the objectdata,
such as embargoes and warnings.
@const kMDItemCity
Identifies city of objectdata origin according to guidelines
established by the provider.
@const kMDItemStateOrProvince
Identifies Province/State of origin according to guidelines
established by the provider.
@const kMDItemCountry
Provides full, publishable, name of the country/primary location
where the intellectual property of the objectdata was created,
according to guidelines of the provider.
@const kMDItemEXIFGPSVersion
The version of GPSInfoIFD in EXIF used to generate the metadata.
@const kMDItemAltitude
The altitude of the item in meters above sea level, expressed
using the WGS84 datum. Negative values lie below sea level.
@const kMDItemLatitude
The latitude of the item in degrees north of the equator, expressed
using the WGS84 datum. Negative values lie south of the equator.
@const kMDItemLongitude
The longitude of the item in degrees east of the prime meridian,
expressed using the WGS84 datum. Negative values lie west of the prime meridian.
@const kMDItemTimestamp
The timestamp on the item. This generally is used to indicate the time at
which the event captured by the item took place.
@const kMDItemSpeed
The speed of the item, in kilometers per hour.
@const kMDItemGPSTrack
The direction of travel of the item, in degrees from true north.
@const kMDItemImageDirection
The direction of the item's image, in degrees from true north.
@const kMDItemNamedLocation
The name of the location or point of interest associated with the item.
The name may be user provided.
*/
MD_EXPORT const CFStringRef kMDItemAttributeChangeDate MD_AVAIL; // CFDate
MD_EXPORT const CFStringRef kMDItemContentType MD_AVAIL; // CFString
MD_EXPORT const CFStringRef kMDItemContentTypeTree MD_AVAIL_LEOPARD; // CFArray of CFStringRef
MD_EXPORT const CFStringRef kMDItemKeywords MD_AVAIL; // CFArray of CFString
MD_EXPORT const CFStringRef kMDItemTitle MD_AVAIL; // CFString
MD_EXPORT const CFStringRef kMDItemAuthors MD_AVAIL; // CFArray of CFString
MD_EXPORT const CFStringRef kMDItemEditors MD_AVAIL_LEOPARD; // CFArray of CFString
MD_EXPORT const CFStringRef kMDItemParticipants API_AVAILABLE( macos(10.6) ) API_UNAVAILABLE( ios, tvos, watchos ); // CFArray of CFString
MD_EXPORT const CFStringRef kMDItemProjects MD_AVAIL; // CFArray of CFString
MD_EXPORT const CFStringRef kMDItemDownloadedDate API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos ); // CFDate
MD_EXPORT const CFStringRef kMDItemWhereFroms MD_AVAIL; // CFArray of CFString
MD_EXPORT const CFStringRef kMDItemComment MD_AVAIL; // CFString
MD_EXPORT const CFStringRef kMDItemCopyright MD_AVAIL; // CFString
MD_EXPORT const CFStringRef kMDItemLastUsedDate MD_AVAIL; // CFDate
MD_EXPORT const CFStringRef kMDItemContentCreationDate MD_AVAIL; // CFDate
MD_EXPORT const CFStringRef kMDItemContentModificationDate MD_AVAIL; // CFDate
MD_EXPORT const CFStringRef kMDItemDateAdded API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos ); // CFDate
MD_EXPORT const CFStringRef kMDItemDurationSeconds MD_AVAIL; // CFNumber
MD_EXPORT const CFStringRef kMDItemContactKeywords MD_AVAIL; // CFArray of CFString
MD_EXPORT const CFStringRef kMDItemVersion MD_AVAIL; // CFString
MD_EXPORT const CFStringRef kMDItemPixelHeight MD_AVAIL; // CFNumber
MD_EXPORT const CFStringRef kMDItemPixelWidth MD_AVAIL; // CFNumber
MD_EXPORT const CFStringRef kMDItemPixelCount API_AVAILABLE( macos(10.6) ) API_UNAVAILABLE( ios, tvos, watchos ); // CFNumber
MD_EXPORT const CFStringRef kMDItemColorSpace MD_AVAIL; // CFString
MD_EXPORT const CFStringRef kMDItemBitsPerSample MD_AVAIL; // CFNumber
MD_EXPORT const CFStringRef kMDItemFlashOnOff MD_AVAIL; // CFBoolean
MD_EXPORT const CFStringRef kMDItemFocalLength MD_AVAIL; // CFNumber
MD_EXPORT const CFStringRef kMDItemAcquisitionMake MD_AVAIL; // CFString
MD_EXPORT const CFStringRef kMDItemAcquisitionModel MD_AVAIL; // CFString
MD_EXPORT const CFStringRef kMDItemISOSpeed MD_AVAIL; // CFNumber
MD_EXPORT const CFStringRef kMDItemOrientation MD_AVAIL; // CFNumber
MD_EXPORT const CFStringRef kMDItemLayerNames MD_AVAIL; // CFArray of CFString
MD_EXPORT const CFStringRef kMDItemWhiteBalance MD_AVAIL; // CFNumber
MD_EXPORT const CFStringRef kMDItemAperture MD_AVAIL; // CFNumber
MD_EXPORT const CFStringRef kMDItemProfileName MD_AVAIL; // CFString
MD_EXPORT const CFStringRef kMDItemResolutionWidthDPI MD_AVAIL; // CFNumber
MD_EXPORT const CFStringRef kMDItemResolutionHeightDPI MD_AVAIL; // CFNumber
MD_EXPORT const CFStringRef kMDItemExposureMode MD_AVAIL; // CFNumber
MD_EXPORT const CFStringRef kMDItemExposureTimeSeconds MD_AVAIL; // CFNumber
MD_EXPORT const CFStringRef kMDItemEXIFVersion MD_AVAIL; // CFString
MD_EXPORT const CFStringRef kMDItemCameraOwner API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos ); // CFString
MD_EXPORT const CFStringRef kMDItemFocalLength35mm API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos ); // CFNumber
MD_EXPORT const CFStringRef kMDItemLensModel API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos ); // CFString
MD_EXPORT const CFStringRef kMDItemEXIFGPSVersion MD_AVAIL_LEOPARD; // CFString
MD_EXPORT const CFStringRef kMDItemAltitude MD_AVAIL_LEOPARD; // CFNumber
MD_EXPORT const CFStringRef kMDItemLatitude MD_AVAIL_LEOPARD; // CFNumber
MD_EXPORT const CFStringRef kMDItemLongitude MD_AVAIL_LEOPARD; // CFNumber
MD_EXPORT const CFStringRef kMDItemSpeed MD_AVAIL_LEOPARD; // CFNumber
MD_EXPORT const CFStringRef kMDItemTimestamp MD_AVAIL_LEOPARD; // CFDate
MD_EXPORT const CFStringRef kMDItemGPSTrack MD_AVAIL_LEOPARD; // CFNumber
MD_EXPORT const CFStringRef kMDItemImageDirection MD_AVAIL_LEOPARD; // CFNumber
MD_EXPORT const CFStringRef kMDItemNamedLocation API_AVAILABLE( macos(10.6) ) API_UNAVAILABLE( ios, tvos, watchos ); // CFString
MD_EXPORT const CFStringRef kMDItemGPSStatus API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos ); // CFString
MD_EXPORT const CFStringRef kMDItemGPSMeasureMode API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos ); // CFString
MD_EXPORT const CFStringRef kMDItemGPSDOP API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos ); // CFNumber
MD_EXPORT const CFStringRef kMDItemGPSMapDatum API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos ); // CFString
MD_EXPORT const CFStringRef kMDItemGPSDestLatitude API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos ); // CFNumber
MD_EXPORT const CFStringRef kMDItemGPSDestLongitude API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos ); // CFNumber
MD_EXPORT const CFStringRef kMDItemGPSDestBearing API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos ); // CFNumber
MD_EXPORT const CFStringRef kMDItemGPSDestDistance API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos ); // CFNumber
MD_EXPORT const CFStringRef kMDItemGPSProcessingMethod API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos ); // CFString
MD_EXPORT const CFStringRef kMDItemGPSAreaInformation API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos ); // CFString
MD_EXPORT const CFStringRef kMDItemGPSDateStamp API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos ); // CFDate
MD_EXPORT const CFStringRef kMDItemGPSDifferental API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos ); // CFNumber
MD_EXPORT const CFStringRef kMDItemCodecs MD_AVAIL; // CFArray of CFString
MD_EXPORT const CFStringRef kMDItemMediaTypes MD_AVAIL; // CFArray of CFString
MD_EXPORT const CFStringRef kMDItemStreamable MD_AVAIL; // CFBoolean
MD_EXPORT const CFStringRef kMDItemTotalBitRate MD_AVAIL; // CFNumber
MD_EXPORT const CFStringRef kMDItemVideoBitRate MD_AVAIL; // CFNumber
MD_EXPORT const CFStringRef kMDItemAudioBitRate MD_AVAIL; // CFNumber
MD_EXPORT const CFStringRef kMDItemDeliveryType MD_AVAIL; // CFString
MD_EXPORT const CFStringRef kMDItemAlbum MD_AVAIL; // CFString
MD_EXPORT const CFStringRef kMDItemHasAlphaChannel MD_AVAIL; // CFBoolean
MD_EXPORT const CFStringRef kMDItemRedEyeOnOff MD_AVAIL; // CFBoolean
MD_EXPORT const CFStringRef kMDItemMeteringMode MD_AVAIL; // CFString
MD_EXPORT const CFStringRef kMDItemMaxAperture MD_AVAIL; // CFNumber
MD_EXPORT const CFStringRef kMDItemFNumber MD_AVAIL; // CFNumber
MD_EXPORT const CFStringRef kMDItemExposureProgram MD_AVAIL; // CFString
MD_EXPORT const CFStringRef kMDItemExposureTimeString MD_AVAIL; // CFString
/* From IPTC */
MD_EXPORT const CFStringRef kMDItemHeadline MD_AVAIL; // CFString
MD_EXPORT const CFStringRef kMDItemInstructions MD_AVAIL; // CFString
MD_EXPORT const CFStringRef kMDItemCity MD_AVAIL; // CFString
MD_EXPORT const CFStringRef kMDItemStateOrProvince MD_AVAIL; // CFString
MD_EXPORT const CFStringRef kMDItemCountry MD_AVAIL; // CFString
/*!
@constant kMDItemHTMLContent
Contains the HTML content of the document. Type is a CFString.
This field is only used by Spotlight importers to return HTML contents of a file. Except in special cases,
this field is not a replacement for kMDItemTextContent which should still be returned.
This field does not particpate in Spotlight queries.
@constant kMDItemTextContent
Contains the text content of the document. Type is a CFString.
@constant kMDItemDisplayName
This is the localized version of the LaunchServices call
LSCopyDisplayNameForURL()/LSCopyDisplayNameForRef().
@constant kMDItemFSName
This is the file name of the MDItemRef. Type is a CFString
@constant kMDItemPath
This is the complete path to the MDItemRef. Type is a CFString.
@constant kMDItemFSSize
The total logical size of the file (data and resources) on disk in bytes. Type is a CFNumber.
@constant kMDItemFSCreationDate
This is the date that the file was created. Type is a CFDate.
@constant kMDItemFSContentChangeDate
This is the date the the file content last changed. This is a CFDate.
@constant kMDItemFSOwnerUserID
User-id of owner of the file. Type is a CFNumber.
@constant kMDItemFSOwnerGroupID
Group-id of owner of the file. Type is a CFNumber.
@constant kMDItemFSExists *** DEPRECATED ***
Boolean indicating if this MDItem references a file that still
exists. The file that the MDItem references might have been
deleted. Type is a CFBoolean.
@constant kMDItemFSIsReadable *** DEPRECATED ***
Boolean indicating if this file is readable. Type is a CFBoolean.
@constant kMDItemFSIsWriteable *** DEPRECATED ***
Boolean indicating if this file is writable. Type is a CFBoolean.
@constant kMDItemFSNodeCount
Number of files in directory. Type is a CFNumber.
@constant kMDItemFSHasCustomIcon
Boolean indicating if this file has a custom icon. Type is a CFBoolean.
@constant kMDItemFSIsExtensionHidden
Boolean indicating if this file has its extension hidden. Type is a CFBoolean.
@constant kMDItemFSIsStationery
Boolean indicating if this file is stationery. Type is a CFBoolean.
@constant kMDItemFSInvisible
Boolean indicating if this file is visible. Type is a CFBoolean.
@constant kMDItemFSLabel
Number indicating which finder label is in use (0-7). Type is a CFNumber.
*/
MD_EXPORT const CFStringRef kMDItemFSName MD_AVAIL; // CFString
MD_EXPORT const CFStringRef kMDItemDisplayName MD_AVAIL; // CFString
MD_EXPORT const CFStringRef kMDItemPath MD_AVAIL; // CFString
MD_EXPORT const CFStringRef kMDItemFSSize MD_AVAIL; // CFNumber
MD_EXPORT const CFStringRef kMDItemFSCreationDate MD_AVAIL; // CFDate
MD_EXPORT const CFStringRef kMDItemFSContentChangeDate MD_AVAIL; // CFDate
MD_EXPORT const CFStringRef kMDItemFSOwnerUserID MD_AVAIL; // CFNumber
MD_EXPORT const CFStringRef kMDItemFSOwnerGroupID MD_AVAIL; // CFNumber
MD_EXPORT const CFStringRef kMDItemFSExists API_DEPRECATED("No longer supported", macos(10.4, 10.4)) API_UNAVAILABLE( ios, tvos, watchos );
MD_EXPORT const CFStringRef kMDItemFSIsReadable API_DEPRECATED("No longer supported", macos(10.4, 10.4)) API_UNAVAILABLE( ios, tvos, watchos );
MD_EXPORT const CFStringRef kMDItemFSIsWriteable API_DEPRECATED("No longer supported", macos(10.4, 10.4)) API_UNAVAILABLE( ios, tvos, watchos );
MD_EXPORT const CFStringRef kMDItemFSHasCustomIcon MD_AVAIL; // CFBoolean
MD_EXPORT const CFStringRef kMDItemFSIsExtensionHidden MD_AVAIL; // CFBoolean
MD_EXPORT const CFStringRef kMDItemFSIsStationery MD_AVAIL; // CFBoolean
MD_EXPORT const CFStringRef kMDItemFSInvisible MD_AVAIL; // CFBoolean
MD_EXPORT const CFStringRef kMDItemFSLabel MD_AVAIL; // CFNumber
MD_EXPORT const CFStringRef kMDItemFSNodeCount MD_AVAIL; // CFNumber
MD_EXPORT const CFStringRef kMDItemHTMLContent API_AVAILABLE( macos(10.11) ) API_UNAVAILABLE( ios, tvos, watchos ); // a Write-Only CFString
MD_EXPORT const CFStringRef kMDItemTextContent MD_AVAIL; // a Write-Only CFString
/*!
@constant kMDItemAudioSampleRate
The sample rate of the audio data contained in the file. The sample rate is a
float value representing hz (audio_frames/second). For example: 44100.0, 22254.54.
Type is a CFNumber (float).
@constant kMDItemAudioChannelCount
The number of channels in the audio data contained in the file. This item only represents
the number of discreet channels of audio data found in the file. It does not indicate
any configuration of the data in regards to a user's speaker setup.
Type is a CFNumber (integer).
@constant kMDItemTempo
The tempo of the music contained in the audio file in Beats Per Minute.
Type is a CFNumber (float).
@constant kMDItemKeySignature
The musical key of the song/composition contained in an audio file.
For example: C, Dm, F#m, Bb. Type is a CFString.
@constant kMDItemTimeSignature
The time signature of the musical composition contained in the audio/MIDI file.
For example: "4/4", "7/8". Type is a CFString.
@constant kMDItemAudioEncodingApplication
The name of the application that encoded the data contained in the audio file.
Type is a CFString.
@constant kMDItemComposer
The composer of the song/composition contained in the audio file.
Type is a CFString.
@constant kMDItemLyricist
The lyricist/text writer for song/composition contained in the audio file.
Type is a CFString.
@constant kMDItemAudioTrackNumber
The track number of a song/composition when it is part of an album (kMDItemAlbum).
Type is a CFNumber (integer).
@constant kMDItemRecordingDate
The recording date of the song/composition. This information differs from
the kMDItemContentCreationDate attribute as it indicates the date that the
'art' was created, in contrast to ContentCreationDate which for example, could indicate
the creation date of an edited or 'mastered' version of the original art.
Type is a CFDate.
@constant kMDItemMusicalGenre
The musical genre of the song/composition contained in the audio file.
For example: Jazz, Pop, Rock, Classical. Type is a CFString.
@constant kMDItemIsGeneralMIDISequence
This attribute indicates whether the MIDI sequence contained in the file
is setup for use with a General MIDI device. Type is a CFBoolean.
@const kMDItemRecordingYear
This attribute indicates what year the item was recorded on.
Type is a CFNumber
*/
MD_EXPORT const CFStringRef kMDItemAudioSampleRate MD_AVAIL; // CFNumber
MD_EXPORT const CFStringRef kMDItemAudioChannelCount MD_AVAIL; // CFNumber
MD_EXPORT const CFStringRef kMDItemTempo MD_AVAIL; // CFNumber
MD_EXPORT const CFStringRef kMDItemKeySignature MD_AVAIL; // CFString
MD_EXPORT const CFStringRef kMDItemTimeSignature MD_AVAIL; // CFString
MD_EXPORT const CFStringRef kMDItemAudioEncodingApplication MD_AVAIL; // CFString
MD_EXPORT const CFStringRef kMDItemComposer MD_AVAIL; // CFString
MD_EXPORT const CFStringRef kMDItemLyricist MD_AVAIL; // CFString
MD_EXPORT const CFStringRef kMDItemAudioTrackNumber MD_AVAIL; // CFNumber
MD_EXPORT const CFStringRef kMDItemRecordingDate MD_AVAIL; // CFDate
MD_EXPORT const CFStringRef kMDItemMusicalGenre MD_AVAIL; // CFString
MD_EXPORT const CFStringRef kMDItemIsGeneralMIDISequence MD_AVAIL; // CFBoolean
MD_EXPORT const CFStringRef kMDItemRecordingYear MD_AVAIL; // CFNumber
/*!
@const kMDItemOrganizations
Used to indicate company/Organization that created the document.
Type is a CFArray of CFStrings.
@const kMDItemLanguages
Used to designate the languages of the intellectual content of the
resource. Recommended best practice for the values of the Language
element is defined by RFC 3066.
Type is a CFArray of CFStrings.
@const kMDItemRights
Used to provide a link to information about rights held in and
over the resource. Typically a Rights element will contain a
rights management statement for the resource, or reference a
service providing such information. Rights information often
encompasses Intellectual Property Rights (IPR), Copyright, and
various Property Rights. If the rights element is absent, no
assumptions can be made about the status of these and other rights
with respect to the resource. Type is a CFString type.
@const kMDItemPublishers
Used to designate the entity responsible for making the resource
available. Examples of a Publisher include a person, an
organization, or a service. Typically, the name of a Publisher
should be used to indicate the entity. Type is a CFArray of CFStrings.
@const kMDItemContributors
Used to designate the entity responsible for making contributions
to the content of the resource. Examples of a Contributor include
a person, an organization or a service. Typically, the name of a
Contributor should be used to indicate the entity. Type is a
CFArray of CFStrings.
@const kMDItemCoverage
Used to designate the extent or scope of the content of the
resource. Coverage will typically include spatial location (a
place name or geographic co-ordinates), temporal period (a period
label, date, or date range) or jurisdiction (such as a named
administrative entity). Recommended best practice is to select a
value from a controlled vocabulary, and that, where appropriate,
named places or time periods be used in preference to numeric
identifiers such as sets of co-ordinates or date ranges. Type is a
CFString.
@const kMDItemSubject
Subject of the this item. Type is a CFString.
@const kMDItemTheme
Theme of the this item. Type is a CFString.
@const kMDItemDescription
An account of the content of the resource. Description may include
but is not limited to: an abstract, table of contents, reference
to a graphical representation of content or a free-text account of
the content. Type is a CFString.
@const kMDItemIdentifier
Used to reference to the resource within a given
context. Recommended best practice is to identify the resource by
means of a string or number conforming to a formal identification
system. Type is a CFString.
@const kMDItemAudiences
A class of entity for whom the resource is intended or useful. A
class of entity may be determined by the creator or the publisher
or by a third party. Type is a CFArray of CFString.
*/
MD_EXPORT const CFStringRef kMDItemOrganizations MD_AVAIL; // CFArray of CFStrings
MD_EXPORT const CFStringRef kMDItemLanguages MD_AVAIL; // CFArray of CFStrings
MD_EXPORT const CFStringRef kMDItemRights MD_AVAIL; // CFString
MD_EXPORT const CFStringRef kMDItemPublishers MD_AVAIL; // CFArray of CFStrings
MD_EXPORT const CFStringRef kMDItemContributors MD_AVAIL; // CFArray of CFStrings
MD_EXPORT const CFStringRef kMDItemCoverage MD_AVAIL; // CFArray of CFStrings
MD_EXPORT const CFStringRef kMDItemSubject MD_AVAIL; // CFString
MD_EXPORT const CFStringRef kMDItemTheme MD_AVAIL; // CFString
MD_EXPORT const CFStringRef kMDItemDescription MD_AVAIL; // CFString
MD_EXPORT const CFStringRef kMDItemIdentifier MD_AVAIL; // CFString
MD_EXPORT const CFStringRef kMDItemAudiences MD_AVAIL; // CFArray of CFStrings
/*!
@const kMDItemNumberOfPages
Number of pages in the item. Type is a CFNumberRef
@const kMDItemPageWidth
Width in points (72 points per inch) of the document page
(first page only for PDF's - other pages within the PDF may
not be the same width). Type is a CFNumber.
@const kMDItemPageHeight
Height in points (72 points per inch) of the document page
(first page only for PDF's - other pages within the PDF may
not be the same height). Type is a CFNumber.
@const kMDItemSecurityMethod
Security (encryption) method used in the file, for a PDF will be one of:
"Password Encrypted" or "None". Type is a CFStrings.
@const kMDItemCreator
Application used to create the document content (e.g. "Word",
"Framemaker", etc.). Type is a CFStrings.
@const kMDItemEncodingApplications
Software used to convert the original content into a PDF stream
(e.g. "Distiller", etc.). Type is a Array of CFStrings.
@const kMDItemDueDate
Date this item is due. Type is a CFDate.
@const kMDItemStarRating
User rate of this item like iTunes. Type is a CFNumber
@const kMDItemPhoneNumbers
Phone numbers for this item. Type is an Array of CFStrings.
@const kMDItemEmailAddresses
Email addresses for this item. Type is an Array of CFStrings.
@const kMDItemInstantMessageAddresses
Instant message addresses for this item. Type is an Array of CFStrings.
@const kMDItemKind
Kind that this item represents. Type is a CFString.
@const kMDItemRecipients
This attribute indicates the recipients of this item. Type is a Array of CFStrings
@const kMDItemFinderComment
These are the finder comments for this item. Type is a CFString.
@const kMDItemFonts
Array of font names used in the item. Attribute would store the Fonts
full name, the postscript name or the font family name based on whats available.
Type is an Array of CFStrings.
*/
MD_EXPORT const CFStringRef kMDItemNumberOfPages MD_AVAIL; // CFNumber
MD_EXPORT const CFStringRef kMDItemPageWidth MD_AVAIL; // CFNumber
MD_EXPORT const CFStringRef kMDItemPageHeight MD_AVAIL; // CFNumber
MD_EXPORT const CFStringRef kMDItemSecurityMethod MD_AVAIL; // CFNumber
MD_EXPORT const CFStringRef kMDItemCreator MD_AVAIL; // CFString
MD_EXPORT const CFStringRef kMDItemEncodingApplications MD_AVAIL; // CFArray of CFStrings
MD_EXPORT const CFStringRef kMDItemDueDate MD_AVAIL; // CFDate
MD_EXPORT const CFStringRef kMDItemStarRating MD_AVAIL; // CFNumber
MD_EXPORT const CFStringRef kMDItemPhoneNumbers MD_AVAIL; // CFArray of CFStrings
MD_EXPORT const CFStringRef kMDItemEmailAddresses MD_AVAIL; // CFArray of CFStrings
MD_EXPORT const CFStringRef kMDItemInstantMessageAddresses MD_AVAIL; // CFArray of CFStrings
MD_EXPORT const CFStringRef kMDItemKind MD_AVAIL; // CFStrings
MD_EXPORT const CFStringRef kMDItemRecipients MD_AVAIL; // CFArray of CFStrings
MD_EXPORT const CFStringRef kMDItemFinderComment MD_AVAIL; // CFString
MD_EXPORT const CFStringRef kMDItemFonts MD_AVAIL; // CFArray of CFString
/*!
@const kMDItemAppleLoopsRootKey
Meta data attribute that stores the root note or tonic for the
loop, and does not include the scale type. The root key is
represented as follows: "C" "C#/Db" "D" "D#/Eb" "E" "F"
"F#/Gb" "G" "G#/Ab" "A" "A#/Bb" "B" "NoKey"
@const kMDItemAppleLoopsKeyFilterType
Meta data attribute that stores key filtering information
about a loop. Loops are matched against projects that often in
a major or minor key. To assist users in identifying loops
that will "fit" with their compositions, loops can be tagged
with one of the following key filters: "AnyKey" "Minor"
"Major" "NeitherKey" "BothKeys". AnyKey means that it fits
with anything (whether in a major key, minor key or
neither). Minor fits with compositions in a minor
key. NeitherKey doesn't work well with compositions that are
in major or minor key. BothKeys means it fits with major or
minor key.
@const kMDItemAppleLoopsLoopMode
Meta data attribute that stores how a file should be
played. Tagged files can either be loops or non-loops (e.g., a
cymbal crash). "Looping" indicates if the file should be
treated as a loop. "Non-looping" indicates the file should not
be treated as a loop.
@const kMDItemAppleLoopDescriptors
Meta data attribute that stores multiple pieces of descriptive
information about a loop. Besides genre and instrument, files
can contain descriptive information that help users in
refining searches. A file can have multiple descriptors
associated with them, though they come in pairs of antonyms
(e.g., "Acoustic" and "Electric"). A file can have zero or
more descriptors.
@const kMDItemMusicalInstrumentCategory
Meta data attribute that stores the category of
instrument. Files should have an instrument associated with
them ("Other Instrument" is provided as a catch-all). For some
categories, like "Keyboards" there are instrument names which
provide a more detailed instrument definition (e.g., Piano,
Organ, etc.)
@const kMDItemMusicalInstrumentName
Meta data attribute that stores the name of instrument
(relative to the instrument category) Files can have an
instrument name associated with them if they have certain
instrument categories (e.g., the category Percussion has
multiple instruments, including Conga and Bongo).
@const kMDItemCFBundleIdentifier
If this item is a bundle, then this is the CFBundleIdentifier
*/
MD_EXPORT const CFStringRef kMDItemAppleLoopsRootKey MD_AVAIL; // CFString
MD_EXPORT const CFStringRef kMDItemAppleLoopsKeyFilterType MD_AVAIL; // CFString
MD_EXPORT const CFStringRef kMDItemAppleLoopsLoopMode MD_AVAIL; // CFString
MD_EXPORT const CFStringRef kMDItemAppleLoopDescriptors MD_AVAIL; // CFArray of CFStrings
MD_EXPORT const CFStringRef kMDItemMusicalInstrumentCategory MD_AVAIL; // CFString
MD_EXPORT const CFStringRef kMDItemMusicalInstrumentName MD_AVAIL; // CFString
MD_EXPORT const CFStringRef kMDItemCFBundleIdentifier MD_AVAIL_LEOPARD; // CFString
MD_EXPORT const CFStringRef kMDItemSupportFileType API_DEPRECATED("No longer supported", macos(10.5, 10.5)) API_UNAVAILABLE( ios, tvos, watchos ); // CFArray of CFStrings
/*!
@const kMDItemInformation
Information about the item
@const kMDItemDirector
Director of the movie
@const kMDItemProducer
Producer of the content
@const kMDItemGenre
Genre of the movie
@const kMDItemPerformers
Performers in the movie
@const kMDItemOriginalFormat
Original format of the movie
@const kMDItemOriginalSource
Original source of the movie
@const kMDItemAuthorEmailAddresses
This attribute indicates the author of the emails message addresses. (This is always
the email address, and not the human readable version)
@const kMDItemRecipientEmailAddresses
This attribute indicates the reciepients email addresses. (This is always the email
address, and not the human readable version).
@const kMDItemAuthorAddresses
This attribute indicates the author addresses of the document.
@const kMDItemRecipientAddresses
This attribute indicates the recipient addresses of the document.
@const kMDItemURL
Url of the item
@const kMDItemIsLikelyJunk
This attribute indicates if the document is likely to be considered junk.
@const kMDItemExecutableArchitectures
Array of executables architectures the item contains.
@const kMDItemExecutablePlatform
Indicates platform required to execute this application.
@const kMDItemApplicationCategories
Array of categories the item application is a member of.
*/
MD_EXPORT const CFStringRef kMDItemInformation MD_AVAIL_LEOPARD; // CFString
MD_EXPORT const CFStringRef kMDItemDirector MD_AVAIL_LEOPARD; // CFString
MD_EXPORT const CFStringRef kMDItemProducer MD_AVAIL_LEOPARD; // CFString
MD_EXPORT const CFStringRef kMDItemGenre MD_AVAIL_LEOPARD; // CFString
MD_EXPORT const CFStringRef kMDItemPerformers MD_AVAIL_LEOPARD; // CFArray of CFString
MD_EXPORT const CFStringRef kMDItemOriginalFormat MD_AVAIL_LEOPARD; // CFString
MD_EXPORT const CFStringRef kMDItemOriginalSource MD_AVAIL_LEOPARD; // CFString
MD_EXPORT const CFStringRef kMDItemAuthorEmailAddresses MD_AVAIL_LEOPARD; // CFArray of CFString
MD_EXPORT const CFStringRef kMDItemRecipientEmailAddresses MD_AVAIL_LEOPARD; // CFArray of CFString
MD_EXPORT const CFStringRef kMDItemAuthorAddresses API_AVAILABLE( macos(10.6) ) API_UNAVAILABLE( ios, tvos, watchos ); // CFArray of CFString
MD_EXPORT const CFStringRef kMDItemRecipientAddresses API_AVAILABLE( macos(10.6) ) API_UNAVAILABLE( ios, tvos, watchos ); // CFArray of CFString
MD_EXPORT const CFStringRef kMDItemURL MD_AVAIL_LEOPARD; // CFString
MD_EXPORT const CFStringRef kMDItemLabelIcon API_DEPRECATED("No longer supported", macos(10.7, 10.7)) API_UNAVAILABLE( ios, tvos, watchos );
MD_EXPORT const CFStringRef kMDItemLabelID API_DEPRECATED("No longer supported", macos(10.7, 10.7)) API_UNAVAILABLE( ios, tvos, watchos );
MD_EXPORT const CFStringRef kMDItemLabelKind API_DEPRECATED("No longer supported", macos(10.7, 10.7)) API_UNAVAILABLE( ios, tvos, watchos );
MD_EXPORT const CFStringRef kMDItemLabelUUID API_DEPRECATED("No longer supported", macos(10.7, 10.7)) API_UNAVAILABLE( ios, tvos, watchos );
MD_EXPORT const CFStringRef kMDItemIsLikelyJunk API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos ); // CFBoolean
MD_EXPORT const CFStringRef kMDItemExecutableArchitectures API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos ); // CFArray of CFString
MD_EXPORT const CFStringRef kMDItemExecutablePlatform API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos ); // CFString
MD_EXPORT const CFStringRef kMDItemApplicationCategories API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos ); // CFArray of CFString
MD_EXPORT const CFStringRef kMDItemIsApplicationManaged API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos ); // CFBoolean
MD_END_C_DECLS
/* ================================================================ */
#if defined(__GNUC__) || __STDC_VERSION__ >= 199901L
/* Private function rewriting */
MD_BEGIN_C_DECLS
#define MDItemCopyAttributeList(item, ...) __MDItemCopyAttributesEllipsis1(item, __VA_ARGS__, NULL)
extern CFDictionaryRef __MDItemCopyAttributesEllipsis1(MDItemRef item, ...) MD_AVAIL;
MD_END_C_DECLS
#endif
CF_IMPLICIT_BRIDGING_DISABLED
#endif /* MAC_OS_X_VERSION_MAX_ALLOWED */
#endif /* __MDITEM__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/Metadata.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/Metadata.framework/Headers/MDLabel.h | /*
* MDLabel.h
* Copyright (c) 2009-2019, Apple Inc. All rights reserved.
*/
/*!
@header MDLabel
@abstract An MDLabelRef represents a label which may be applied to a file for searches.
*/
#if !defined(__MDLABEL__)
#define __MDLABEL__ 1
#include <CoreFoundation/CoreFoundation.h>
#include <CoreFoundation/CoreFoundation.h>
#if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_7
#include <Metadata/MDItem.h>
#include <Metadata/MDQuery.h>
CF_IMPLICIT_BRIDGING_ENABLED
MD_BEGIN_C_DECLS
/*!
@typedef MDLabelRef
@abstract This is the type of a reference to an MDLabel.
*/
typedef struct __MDLabel * MDLabelRef;
MD_EXPORT CFTypeID MDLabelGetTypeID(void)
API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos );
/* MDItem API additions for Labels */
/*!
@function MDItemCopyLabels
@abstract Returns an array of the labels set on the specified item.
@param item The item to be interrogated.
@result A CFArrayRef containing MDLabelRefs for the labels set on the item, or NULL on failure.
*/
MD_EXPORT CFArrayRef MDItemCopyLabels(MDItemRef item)
API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos );
/*!
@function MDItemSetLabel
@abstract Sets a label on the specified item.
@param item The item to be updated.
@param label The label.
@result True if the label was successfully set on the item, false otherwise.
*/
MD_EXPORT Boolean MDItemSetLabel(MDItemRef item, MDLabelRef label)
API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos );
/*!
@function MDItemRemoveLabel
@abstract Removes a label from the specified item.
@param item The item to be updated.
@param label The label.
@result True if the label was successfully removed from the item, false otherwise.
*/
MD_EXPORT Boolean MDItemRemoveLabel(MDItemRef item, MDLabelRef label)
API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos );
/*!
@typedef MDLabelDomain
@abstract These constants are used to specify a domain to MDLabelCreate().
*/
typedef enum {
kMDLabelUserDomain, // ~/Library/Metadata/
kMDLabelLocalDomain, // /Library/Metadata/
} MDLabelDomain;
/* MDLabel APIs */
/*!
@function MDLabelCreate
@abstract Returns a label with the specified parameters. If there is already a label that exactly matches the parameters, a reference to the existing label will be returned; otherwise this will attempt to create a new label. A successful creation of a new private label definition will generate a kMDLabelAddedNotification. Note that this function can only create labels with "Private" visibility. Creating "Public" labels requires creating and installing a label bundle.
@param allocator The CFAllocator which should be used to allocate memory for the label. This parameter may be NULL in which case the current default CFAllocator is used. Use kCFAllocatorNull to request a reference to an existing label only.
@param displayName The label's display name.
@param kind The label's kind string.
@param domain The domain of the label (normally kMDLabelUserDomain).
@result An MDLabelRef, or NULL on failure.
*/
MD_EXPORT MDLabelRef MDLabelCreate(CFAllocatorRef allocator,
CFStringRef displayName,
CFStringRef kind,
MDLabelDomain domain)
API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos );
/*!
@function MDLabelCopyAttribute
@abstract Copy the value of the named attribute of a label.
@param label The label.
@param name The name of the desired attribute.
@result A CFTypeRef, or NULL on failure, or if the attribute does not exist, or if the attribute is not readable.
*/
MD_EXPORT CFTypeRef MDLabelCopyAttribute(MDLabelRef label,
CFStringRef name)
API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos );
/*!
@function MDLabelCopyAttributeName
@abstract Copy the MDItem attribute name of a label. The attribute name can be used in an MDQuery string to search for MDItems that have the label set. The value of the MDItem attribute is a CFDate corresponding to the time the label was set on the item.
@param label The label.
@result A CFStringRef, or NULL on failure.
*/
MD_EXPORT CFStringRef MDLabelCopyAttributeName(MDLabelRef label)
API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos );
/*!
@function MDLabelDelete
@abstract Deletes the user's definition or override of the specified label from ~/Library/Metadata. Labels defined in bundles elsewhere in the filesystem cannot be deleted using this API. Deleting an override of a label merely makes the original definition of the label visible again and thus will generate a kMDLabelChangedNotification. A successful deletion of a private label definition will generate a kMDLabelRemovedNotification.
@param label The label.
@result True if a label definition or override was successfully deleted.
*/
MD_EXPORT Boolean MDLabelDelete(MDLabelRef label)
API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos );
/*!
@function MDLabelSetAttributes
@abstract Updates the attributes of the specified label. Labels defined in ~/Library/Metadata are modified directly. Labels defined in bundles elsewhere in the filesystem are overridden by creating a private copy of the label definition in ~/Library/Metadata. The updated attributes are then stored in the private copy. A successful call to MDLabelSetAttributes() will generate a kMDLabelChangedNotification.
@param label The label.
@param attrs A dictionary containing the attributes to be modified. To remove an attribute, include it in the dictionary with kCFNull as its value.
@result True if the label definition or override was successfully updated.
*/
MD_EXPORT Boolean MDLabelSetAttributes(MDLabelRef label,
CFDictionaryRef attrs)
API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos );
/*!
@function MDCopyLabelKinds
@abstract Copy the list of label kind strings.
@result A CFArrayRef containing all of the label kind strings, or NULL on failure.
*/
MD_EXPORT CFArrayRef MDCopyLabelKinds(void)
API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos );
/*!
@function MDCopyLabelsMatchingExpression
@abstract Copy the list of labels matching the specified query expression.
@param simpleQueryString The query expression string.
@result A CFArrayRef containing all of the matching labels, or NULL on failure.
*/
MD_EXPORT CFArrayRef MDCopyLabelsMatchingExpression(CFStringRef simpleQueryString)
API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos );
/*!
@function MDCopyLabelsWithKind
@abstract Copy the list of labels with the specified kind string.
@param kind The kind string, or NULL to copy all labels.
@result A CFArrayRef containing all of the labels with the specified kind string, or NULL on failure.
*/
MD_EXPORT CFArrayRef MDCopyLabelsWithKind(CFStringRef kind)
API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos );
/*!
@function MDCopyLabelWithUUID
@abstract Copy the label with the specified UUID.
@param labelUUID The label UUID.
@result An MDLabelRef, or NULL on failure.
*/
MD_EXPORT MDLabelRef MDCopyLabelWithUUID(CFUUIDRef labelUUID)
API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos );
/*!
@constant kMDLabelBundleURL
@abstract This is the bundle URL for the label.
Type is a CFURL. This attribute is read-only.
@constant kMDLabelContentChangeDate
@abstract This is the date the the label content last changed.
Type is a CFDate. This attribute is read-only, but its value will be altered by setting any of the writable attributes described below.
@constant kMDLabelDisplayName
@abstract This is the localized name of the label.
Type is a CFString.
@constant kMDLabelIconData
@abstract This is the data that should be used to create an icon image source for the label. Pass this data to the ImageIO framework to create a CGImageSourceRef. To reset a label's icon to its default image, set kMDLabelIconData to kCFNull.
Type is a CFData.
@constant kMDLabelIconUUID
@abstract This is the UUID of the icon image source for the label. Labels that share the same icon image source will have the same icon UUID.
Type is a CFUUID. This attribute is read-only, but its value may be altered by setting the kMDLabelIconData attribute described above.
@constant kMDLabelIsMutuallyExclusiveSetMember
@abstract This attribute is true if the label kind specifies a mutually-exclusive set of labels.
Type is a CFBoolean. This attribute is read-only.
@constant kMDLabelKind
@abstract This is the kind string for the label. The label kind is the name of the bundle the label is defined in.
Type is a CFString. This attribute is read-only.
@constant kMDLabelSetsFinderColor
@abstract This attribute is optional and applicable only to labels with "Public" visibility. If it is present, then when the label is set on a file the file's Finder color will be set to the specified value (0 - 7). If the label is later removed, the file's Finder color will be reverted either to the color specified by the most-recently-set label with this attribute that remains set on the file, or to 0 (none).
Type is a CFNumber. This attribute is ignored for unless the label's visibility is "Public".
@constant kMDLabelUUID
@abstract This is the UUID of the label.
Type is a CFUUID. This attribute is read-only.
@constant kMDLabelVisibility
@abstract This is a constant describing the label's visibility, either "Public" (kMDPublicVisibility) or "Private" (kMDPrivateVisibility).
Type is a CFString. This attribute is read-only.
*/
MD_EXPORT CFStringRef kMDLabelBundleURL // CFURL
API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos );
MD_EXPORT CFStringRef kMDLabelContentChangeDate // CFDate
API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos );
MD_EXPORT CFStringRef kMDLabelDisplayName // CFString
API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos );
MD_EXPORT CFStringRef kMDLabelIconData // CFData (kUTTypeAppleICNS)
API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos );
MD_EXPORT CFStringRef kMDLabelIconUUID // CFUUID
API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos );
MD_EXPORT CFStringRef kMDLabelIsMutuallyExclusiveSetMember // CFBoolean
API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos );
MD_EXPORT CFStringRef kMDLabelKind // CFString
API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos );
MD_EXPORT CFStringRef kMDLabelSetsFinderColor // CFNumber (0 - 7)
API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos );
MD_EXPORT CFStringRef kMDLabelUUID // CFUUID
API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos );
MD_EXPORT CFStringRef kMDLabelVisibility // CFString
API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos );
/*!
@constant kMDLabelKindIsMutuallyExclusiveSetKey
@abstract This key is used in the Info.plist file of a label bundle to specify that the label kind constitutes a mutually exclusive set.
The value is a CFBoolean.
@constant kMDLabelKindVisibilityKey
@abstract This key is used in the Info.plist file of a label bundle to specify the visibility of the labels defined by the bundle.
The value is a CFString constant, either "Public" (kMDPublicVisibility) or "Private" (kMDPrivateVisibility).
*/
MD_EXPORT CFStringRef kMDLabelKindIsMutuallyExclusiveSetKey // Boolean
API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos );
MD_EXPORT CFStringRef kMDLabelKindVisibilityKey // "Private" (the default) or "Public"
API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos );
MD_EXPORT CFStringRef kMDPrivateVisibility // "Private"
API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos );
MD_EXPORT CFStringRef kMDPublicVisibility // "Public"
API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos );
/*!
@constant kMDLabelAddedNotification
@abstract The name of the notification sent when a label has been added. The notification object is the subject MDLabelRef. All label notifications are distributed to processes owned by the same uid that have initialized the Metadata framework label APIs.
*/
MD_EXPORT const CFStringRef kMDLabelAddedNotification
API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos );
/*!
@constant kMDLabelChangedNotification
@abstract The name of the notification sent when a label has been changed. The notification object is the subject MDLabelRef. The label's new attributes can be retrieved using MDLabelCopyAttribute().
*/
MD_EXPORT const CFStringRef kMDLabelChangedNotification
API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos );
/*!
@constant kMDLabelRemovedNotification
@abstract The name of the notification sent when a label has been deleted. The notification object is the subject MDLabelRef. The label's kMDLabelIconUUID, kMDLabelKind, kMDLabelKindBundleURL and kMDLabelUUID attributes can still be retrieved using MDLabelCopyAttribute(), and the label may still be passed to MDLabelCopyAttributeName().
*/
MD_EXPORT const CFStringRef kMDLabelRemovedNotification
API_AVAILABLE( macos(10.7) ) API_UNAVAILABLE( ios, tvos, watchos );
MD_END_C_DECLS
CF_IMPLICIT_BRIDGING_DISABLED
#endif /* MAC_OS_X_VERSION_MAX_ALLOWED */
#endif /* __MDLABEL__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/Metadata.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/Metadata.framework/Headers/Metadata.h | /*
* Metadata.h
* Copyright (c) 2003-2019, Apple Inc. All rights reserved.
*/
#if !defined(__METADATA_METADATA__)
#define __METADATA_METADATA__ 1
#include <Metadata/MDItem.h>
#include <Metadata/MDLabel.h>
#include <Metadata/MDQuery.h>
#include <Metadata/MDSchema.h>
#include <Metadata/MDImporter.h>
#endif /* __METADATA_METADATA__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/Metadata.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreServices.framework/Frameworks/Metadata.framework/Headers/MDSchema.h | /*
* MDSchema.h
* Copyright (c) 2003-2019, Apple Inc. All rights reserved.
*/
/*!
@header MDSchema
Functions in MDSchema return meta data about attributes, for example
the type of an attribute, and a localized string for an attribute that is
sutable to display to a user.
*/
#if !defined(__MDSCHEMA__)
#define __MDSCHEMA__ 1
#include <CoreFoundation/CoreFoundation.h>
#if MAC_OS_X_VERSION_MAX_ALLOWED >= MAC_OS_X_VERSION_10_4
#include <Metadata/MDItem.h>
CF_IMPLICIT_BRIDGING_ENABLED
MD_BEGIN_C_DECLS
/*!
@function MDSchemaCopyAttributesForContentType
Returns an dictionary attributes to display or show the
user for a given UTI type. This function does not walk up the
UTI hiearchy and perform a union of the information.
@param utiType the UTI type to be interrogated.
@result A CFDictionaryRef with keys == to kMDAttributeDisplayValues etc..
*/
MD_EXPORT CFDictionaryRef MDSchemaCopyAttributesForContentType(CFStringRef contentTypeUTI) MD_AVAIL;
/*!
@function MDSchemaCopyMetaAttributesForAttribute
Returns an dictionary of the meta attributes of attribute
@param name the attribute whose schema you are interested in.
@result A CFDictionary of the description of the attribute.
*/
MD_EXPORT CFDictionaryRef MDSchemaCopyMetaAttributesForAttribute(CFStringRef name) MD_AVAIL;
/*!
@function MDSchemaCopyAllAttributes
Returns an array of all of the attributes defined in the schema
@result A CFArray of the attribute names.
*/
MD_EXPORT CFArrayRef MDSchemaCopyAllAttributes(void) MD_AVAIL;
/*!
@function MDSchemaCopyDisplayNameForAttribute
Returns the localized name of an attribute
@param name the attribute whose localization you are interested in
@result the localized name of the passed in attribute, or NULL if there is
no localized name is avaliable.
*/
MD_EXPORT CFStringRef MDSchemaCopyDisplayNameForAttribute(CFStringRef name) MD_AVAIL;
/*!
@function MDSchemaCopyDisplayDescriptionForAttribute
Returns the localized description of an attribute.
@param name the attribute whose localization you are interested in
@result the localized description of the passed in attribute, or NULL if there is
no localized description is avaliable.
*/
MD_EXPORT CFStringRef MDSchemaCopyDisplayDescriptionForAttribute(CFStringRef name) MD_AVAIL;
/* Returned by MDSchemaCopyAttributesForContentType */
MD_EXPORT const CFStringRef kMDAttributeDisplayValues MD_AVAIL;
/* Value == CFArray of CFString attribute names or
* NULL if the type is not known by the system
*/
MD_EXPORT const CFStringRef kMDAttributeAllValues MD_AVAIL; /* Value == CFArray of CFString attribute names or
* NULL if the type is not known by the system
*/
MD_EXPORT const CFStringRef kMDAttributeReadOnlyValues MD_AVAIL_LEOPARD;
/* Value == CFArray of CFString attribute names or
* NULL if the type is not known by the system
*/
MD_EXPORT const CFStringRef kMDExporterAvaliable MD_AVAIL_LEOPARD;
/* Value == CFBoolean
* indicates if an exporter is avaliable for this
* uti type
*/
/* Keys in the dictionary returned from the MDSchemaCopyMetaAttributesForAttribute call */
MD_EXPORT const CFStringRef kMDAttributeName MD_AVAIL; /* Value == name of attribute (CFStringRef) */
MD_EXPORT const CFStringRef kMDAttributeType MD_AVAIL; /* Value == type of Attribute (CFNumberRef, CFTypeID) */
MD_EXPORT const CFStringRef kMDAttributeMultiValued MD_AVAIL; /* Value == if multivalued (CFBooleanRef) */
MD_END_C_DECLS
CF_IMPLICIT_BRIDGING_DISABLED
#endif /* MAC_OS_X_VERSION_MAX_ALLOWED */
#endif /* __MDSCHEMA__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Kernel.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Kernel.framework/Headers/ptrauth.h | /*===---- ptrauth.h - Pointer authentication -------------------------------===
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*
*===-----------------------------------------------------------------------===
*/
#ifndef __PTRAUTH_H
#define __PTRAUTH_H
#include <stdint.h>
typedef enum {
ptrauth_key_asia = 0,
ptrauth_key_asib = 1,
ptrauth_key_asda = 2,
ptrauth_key_asdb = 3,
/* A process-independent key which can be used to sign code pointers.
Signing and authenticating with this key is a no-op in processes
which disable ABI pointer authentication. */
ptrauth_key_process_independent_code = ptrauth_key_asia,
/* A process-specific key which can be used to sign code pointers.
Signing and authenticating with this key is enforced even in processes
which disable ABI pointer authentication. */
ptrauth_key_process_dependent_code = ptrauth_key_asib,
/* A process-independent key which can be used to sign data pointers.
Signing and authenticating with this key is a no-op in processes
which disable ABI pointer authentication. */
ptrauth_key_process_independent_data = ptrauth_key_asda,
/* A process-specific key which can be used to sign data pointers.
Signing and authenticating with this key is a no-op in processes
which disable ABI pointer authentication. */
ptrauth_key_process_dependent_data = ptrauth_key_asdb,
/* The key used to sign C function pointers.
The extra data is always 0. */
ptrauth_key_function_pointer = ptrauth_key_process_independent_code,
/* The key used to sign return addresses on the stack.
The extra data is based on the storage address of the return address.
On ARM64, that is always the storage address of the return address plus 8
(or, in other words, the value of the stack pointer on function entry) */
ptrauth_key_return_address = ptrauth_key_process_dependent_code,
/* The key used to sign frame pointers on the stack.
The extra data is based on the storage address of the frame pointer.
On ARM64, that is always the storage address of the frame pointer plus 16
(or, in other words, the value of the stack pointer on function entry) */
ptrauth_key_frame_pointer = ptrauth_key_process_dependent_data,
/* The key used to sign block function pointers, including:
invocation functions,
block object copy functions,
block object destroy functions,
__block variable copy functions, and
__block variable destroy functions.
The extra data is always the address at which the function pointer
is stored.
Note that block object pointers themselves (i.e. the direct
representations of values of block-pointer type) are not signed. */
ptrauth_key_block_function = ptrauth_key_asia,
/* The key used to sign C++ v-table pointers.
The extra data is always 0. */
ptrauth_key_cxx_vtable_pointer = ptrauth_key_asda,
/* Other pointers signed under the ABI use private ABI rules. */
} ptrauth_key;
/* An integer type of the appropriate size for an extra-data argument. */
typedef uintptr_t ptrauth_extra_data_t;
/* An integer type of the appropriate size for a generic signature. */
typedef uintptr_t ptrauth_generic_signature_t;
/* A signed pointer value embeds the original pointer together with
a signature that attests to the validity of that pointer. Because
this signature must use only "spare" bits of the pointer, a
signature's validity is probabilistic in practice: it is unlikely
but still plausible that an invalidly-derived signature will
somehow equal the correct signature and therefore successfully
authenticate. Nonetheless, this scheme provides a strong degree
of protection against certain kinds of attacks. */
/* Authenticating a pointer that was not signed with the given key
and extra-data value will (likely) fail. However, an
authentication failure will not lead immediately to a trap.
Instead, it will yield a value which is guaranteed to trap
if actually dereferenced. */
/* The null function pointer is always the all-zero bit pattern.
Signing an all-zero bit pattern will embed a (likely) non-zero
signature in the result, and so the result will not seem to be
a null function pointer. Authenticating this value will yield
a null function pointer back. However, authenticating an
all-zero bit pattern will probably fail, because the
authentication will expect a (likely) non-zero signature to
embedded in the value.
Because of this, if a pointer may validly be null, you should
check for null before attempting to authenticate it. */
#ifdef __PTRAUTH_INTRINSICS__
/* Strip the signature from a value without authenticating it.
If the value is a function pointer, the result will not be a
legal function pointer because of the missing signature, and
attempting to call it will result in an authentication failure.
The value must be an expression of pointer type.
The key must be a constant expression of type ptrauth_key.
The result will have the same type as the original value. */
#define ptrauth_strip(__value, __key) \
__builtin_ptrauth_strip(__value, __key)
/* Blend a pointer and a small integer to form a new extra-data
discriminator. Not all bits of the inputs are guaranteed to
contribute to the result.
On ARM64, only the low 16 bits of the integer will be considered.
For the purposes of ptrauth_sign_constant, the result of calling
this function is considered a constant expression if the arguments
are constant. Some restrictions may be imposed on the pointer.
The first argument must be an expression of pointer type.
The second argument must be an expression of integer type.
The result will have type uintptr_t. */
#define ptrauth_blend_discriminator(__pointer, __integer) \
__builtin_ptrauth_blend_discriminator(__pointer, __integer)
/* Compute the 16-bit integer discriminator of the given type.
The argument must be a type.
*/
#if __has_builtin(__builtin_ptrauth_type_discriminator)
#define ptrauth_type_discriminator(__type) \
__builtin_ptrauth_type_discriminator(__type)
#else
#define ptrauth_type_discriminator(__type) ((uintptr_t)0)
#endif
/* Compute the constant discriminator used by Clang to sign pointers with the
given C function pointer type.
A call to this function is an integer constant expression*/
#if __has_feature(ptrauth_function_pointer_type_discrimination)
#define ptrauth_function_pointer_type_discriminator(__type) \
__builtin_ptrauth_type_discriminator(__type)
#else
#define ptrauth_function_pointer_type_discriminator(__type) ((uintptr_t)0)
#endif
/* Add a signature to the given pointer value using a specific key,
using the given extra data as a salt to the signing process.
The value must be a constant expression of pointer type.
The key must be a constant expression of type ptrauth_key.
The extra data must be a constant expression of pointer or integer type;
if an integer, it will be coerced to ptrauth_extra_data_t.
The result will have the same type as the original value.
This is a constant expression if the extra data is an integer or
null pointer constant. */
#define ptrauth_sign_constant(__value, __key, __data) \
__builtin_ptrauth_sign_constant(__value, __key, __data)
/* Add a signature to the given pointer value using a specific key,
using the given extra data as a salt to the signing process.
This operation does not authenticate the original value and is
therefore potentially insecure if an attacker could possibly
control that value.
The value must be an expression of pointer type.
The key must be a constant expression of type ptrauth_key.
The extra data must be an expression of pointer or integer type;
if an integer, it will be coerced to ptrauth_extra_data_t.
The result will have the same type as the original value. */
#define ptrauth_sign_unauthenticated(__value, __key, __data) \
__builtin_ptrauth_sign_unauthenticated(__value, __key, __data)
/* Authenticate a pointer using one scheme and resign it using another.
If the result is subsequently authenticated using the new scheme, that
authentication is guaranteed to fail if and only if the initial
authentication failed.
The value must be an expression of pointer type.
The key must be a constant expression of type ptrauth_key.
The extra data must be an expression of pointer or integer type;
if an integer, it will be coerced to ptrauth_extra_data_t.
The result will have the same type as the original value.
This operation is guaranteed to not leave the intermediate value
available for attack before it is re-signed.
Do not pass a null pointer to this function. A null pointer
will not successfully authenticate. */
#define ptrauth_auth_and_resign(__value, __old_key, __old_data, __new_key, __new_data) \
__builtin_ptrauth_auth_and_resign(__value, __old_key, __old_data, __new_key, __new_data)
/* Authenticate a pointer using one scheme and resign it as a C
function pointer.
If the result is subsequently authenticated using the new scheme, that
authentication is guaranteed to fail if and only if the initial
authentication failed.
The value must be an expression of function pointer type.
The key must be a constant expression of type ptrauth_key.
The extra data must be an expression of pointer or integer type;
if an integer, it will be coerced to ptrauth_extra_data_t.
The result will have the same type as the original value.
This operation is guaranteed to not leave the intermediate value
available for attack before it is re-signed. Additionally, if this
expression is used syntactically as the function expression in a
call, only a single authentication will be performed. */
#define ptrauth_auth_function(__value, __old_key, __old_data) \
ptrauth_auth_and_resign(__value, __old_key, __old_data, ptrauth_key_function_pointer, 0)
/* Cast a pointer to the given type without changing any signature.
The type must have the same size as a pointer type.
The type of value must have the same size as a pointer type, and will be
converted to an rvalue prior to the cast.
The result has type given by the first argument.
The result has an identical bit-pattern to the input pointer. */
#define ptrauth_nop_cast(__type, __value) \
({ union { \
typeof(__value) __fptr; \
typeof(__type) __opaque; \
} __storage; \
__storage.__fptr = (__value); \
__storage.__opaque; })
/* Authenticate a data pointer.
The value must be an expression of non-function pointer type.
The key must be a constant expression of type ptrauth_key.
The extra data must be an expression of pointer or integer type;
if an integer, it will be coerced to ptrauth_extra_data_t.
The result will have the same type as the original value.
If the authentication fails, dereferencing the resulting pointer
will fail. */
#define ptrauth_auth_data(__value, __old_key, __old_data) \
__builtin_ptrauth_auth(__value, __old_key, __old_data)
/* Return an extra-discriminator value which can validly be used
as the second argument to ptrauth_blend_discriminator or the
third argument to the __ptrauth qualifier.
The argument must be a string literal.
A call to this function is an integer constant expression. */
#define ptrauth_string_discriminator(__string) \
__builtin_ptrauth_string_discriminator(__string)
/* Compute a full pointer-width generic signature for the given
value, using the given data as a salt.
This generic signature is process-independent, but may not be
consistent across reboots.
This can be used to validate the integrity of arbitrary data
by storing a signature for that data together with it. Because
the signature is pointer-sized, if the stored signature matches
the result of re-signing the current data, a match provides very
strong evidence that the data has not been corrupted.
The value must be an expression of pointer or integer type; if
an integer, it will be coerced to uintptr_t.
The extra data must be an expression of pointer or integer type;
if an integer, it will be coerced to ptrauth_extra_data_t.
The result will have type ptrauth_generic_signature_t.
This operation will compute a meaningful signature even in processes
which disable ABI pointer authentication. */
#define ptrauth_sign_generic_data(__value, __data) \
__builtin_ptrauth_sign_generic_data(__value, __data)
/* Define some standard __ptrauth qualifiers used in the ABI. */
#define __ptrauth_function_pointer \
__ptrauth(ptrauth_key_function_pointer,0,0)
#define __ptrauth_return_address \
__ptrauth(ptrauth_key_return_address,1,0)
#define __ptrauth_block_invocation_pointer \
__ptrauth(ptrauth_key_function_pointer,1,0)
#define __ptrauth_block_copy_helper \
__ptrauth(ptrauth_key_function_pointer,1,0)
#define __ptrauth_block_destroy_helper \
__ptrauth(ptrauth_key_function_pointer,1,0)
#define __ptrauth_block_byref_copy_helper \
__ptrauth(ptrauth_key_function_pointer,1,0)
#define __ptrauth_block_byref_destroy_helper \
__ptrauth(ptrauth_key_function_pointer,1,0)
#define __ptrauth_objc_method_list_imp \
__ptrauth(ptrauth_key_function_pointer,1,0)
#define __ptrauth_cxx_vtable_pointer \
__ptrauth(ptrauth_key_cxx_vtable_pointer,0,0)
#define __ptrauth_cxx_vtt_vtable_pointer \
__ptrauth(ptrauth_key_cxx_vtable_pointer,0,0)
#define __ptrauth_swift_heap_object_destructor \
__ptrauth(ptrauth_key_function_pointer,1,0xbbbf)
/* Some situations in the C++ and Swift ABIs use declaration-specific
or type-specific extra discriminators. */
#define __ptrauth_cxx_virtual_function_pointer(__declkey) \
__ptrauth(ptrauth_key_function_pointer,1,__declkey)
#define __ptrauth_swift_function_pointer(__typekey) \
__ptrauth(ptrauth_key_function_pointer,0,__typekey)
#define __ptrauth_swift_class_method_pointer(__declkey) \
__ptrauth(ptrauth_key_function_pointer,1,__declkey)
#define __ptrauth_swift_protocol_witness_function_pointer(__declkey) \
__ptrauth(ptrauth_key_function_pointer,1,__declkey)
#define __ptrauth_swift_value_witness_function_pointer(__key) \
__ptrauth(ptrauth_key_function_pointer,1,__key)
#else
#define ptrauth_strip(__value, __key) ({ (void)__key; __value; })
#define ptrauth_blend_discriminator(__pointer, __integer) ({ (void)__pointer; (void)__integer; (uintptr_t)0; })
#define ptrauth_type_discriminator(__type) ((uintptr_t)0)
#define ptrauth_function_pointer_type_discriminator(__type) ((uintptr_t)0)
#define ptrauth_sign_constant(__value, __key, __data) ({ (void)__key; (void)__data; __value; })
#define ptrauth_sign_unauthenticated(__value, __key, __data) ({ (void)__key; (void)__data; __value; })
#define ptrauth_auth_and_resign(__value, __old_key, __old_data, __new_key, __new_data) ({ \
(void)__old_key; \
(void)__old_data; \
(void)__new_key; \
(void)__new_data; \
__value; })
#define ptrauth_auth_function(__value, __old_key, __old_data) ({ (void)__old_key; (void)__old_data; __value; })
#define ptrauth_nop_cast(__type, __value) ((__type)__value)
#define ptrauth_auth_data(__value, __old_key, __old_data) ({ (void)__old_key; (void)__old_data; __value; })
#define ptrauth_string_discriminator(__string) ({ (void)__string; (int)0; })
#define ptrauth_sign_generic_data(__value, __data) ({ (void)__value; (void)__data; (ptrauth_generic_signature_t)0; })
#define __ptrauth_function_pointer
#define __ptrauth_return_address
#define __ptrauth_block_invocation_pointer
#define __ptrauth_block_copy_helper
#define __ptrauth_block_destroy_helper
#define __ptrauth_block_byref_copy_helper
#define __ptrauth_block_byref_destroy_helper
#define __ptrauth_objc_method_list_imp
#define __ptrauth_cxx_vtable_pointer
#define __ptrauth_cxx_vtt_vtable_pointer
#define __ptrauth_swift_heap_object_destructor
#define __ptrauth_cxx_virtual_function_pointer(__declkey)
#define __ptrauth_swift_function_pointer(__typekey)
#define __ptrauth_swift_class_method_pointer(__declkey)
#define __ptrauth_swift_protocol_witness_function_pointer(__declkey)
#define __ptrauth_swift_value_witness_function_pointer(__key)
#endif /* __PTRAUTH_INTRINSICS__ */
#endif /* __PTRAUTH_H */
|
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.