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/CoreAudio.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreAudio.framework/Headers/HostTime.h | /*==================================================================================================
File: CoreAudio/HostTime.h
Contains: Routines for accessing the host's time base
Copyright: (c) 1985-2010 by Apple, Inc., all rights reserved.
Bugs?: For bug reports, consult the following page on
the World Wide Web:
http://developer.apple.com/bugreporter/
==================================================================================================*/
#if !defined(CoreAudio_HostTime_h)
#define CoreAudio_HostTime_h
//==================================================================================================
/*!
@header HostTime
This collection of functions provides access to the host's time base. It also provides
discriptive information about the time base and translations to and from nanoseconds.
*/
//==================================================================================================
#pragma mark -
#pragma mark Includes
#include <Availability.h>
#include <CoreAudioTypes/CoreAudioTypes.h>
//==================================================================================================
#if defined(__cplusplus)
extern "C"
{
#endif
//==================================================================================================
#pragma mark -
#pragma mark Functions
/*!
@functiongroup HostTime
*/
/*!
@function AudioGetCurrentHostTime
@abstract Gets the current host time.
@result A UInt64 containing the current host time.
*/
extern UInt64
AudioGetCurrentHostTime(void) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_2_0);
/*!
@function AudioGetHostClockFrequency
@abstract Gets the number of ticks per second in the host time base.
@result A Float64 containing the number of ticks per second in the host time base.
*/
extern Float64
AudioGetHostClockFrequency(void) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_2_0);
/*!
@function AudioGetHostClockMinimumTimeDelta
@abstract Gets the smallest number of ticks that two succeeding values will ever differ.
by.
@result A UInt32 containing the smallest number of ticks that two succeeding values will
ever differ.
*/
extern UInt32
AudioGetHostClockMinimumTimeDelta(void) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_2_0);
/*!
@function AudioConvertHostTimeToNanos
@abstract Convert the given host time into a time in nanoseconds.
@param inHostTime
A UInt64 containing the host time to convert.
@result A UInt64 containining the converted host time.
*/
extern UInt64
AudioConvertHostTimeToNanos(UInt64 inHostTime) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_2_0);
/*!
@function AudioConvertNanosToHostTime
@abstract Convert the given nanosecond time into a host time.
@param inNanos
A UInt64 containing the nanosecond time to convert.
@result A UInt64 containining the converted nanosecond time.
*/
extern UInt64
AudioConvertNanosToHostTime(UInt64 inNanos) __OSX_AVAILABLE_STARTING(__MAC_10_0, __IPHONE_2_0);
//==================================================================================================
#if defined(__cplusplus)
}
#endif
#endif // CoreAudio_HostTime_h
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreAudio.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreAudio.framework/Modules/module.modulemap | framework module CoreAudio [extern_c]
{
umbrella header "CoreAudio.h"
exclude header "AudioDriverPlugIn.h"
exclude header "CoreAudioTypes.h"
exclude header "AudioHardwareTapping.h"
exclude header "CATapDescription.h"
explicit module AudioServerPlugIn
{
header "AudioServerPlugIn.h"
export *
}
module AudioHardware
{
header "AudioHardware.h"
textual header "AudioHardwareDeprecated.h"
export *
}
export *
module * { export * }
}
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreAudioTypes.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreAudioTypes.framework/Headers/AudioSessionTypes.h | /*!
@file AudioSessionTypes.h
@framework CoreAudioTypes.framework
@copyright (c) 2009-2019 by Apple, Inc., all rights reserved.
@abstract Definitions for types used by AVAudioSession.
*/
#ifndef CoreAudioTypes_AudioSessionTypes_h
#define CoreAudioTypes_AudioSessionTypes_h
#include <CoreFoundation/CFAvailability.h>
#include <stdint.h>
// Types which are binary-compatible with NS(U)Integer but without pulling in objc headers.
#if __LP64__ || 0 || NS_BUILD_32_LIKE_64
typedef long AVAudioInteger;
typedef unsigned long AVAudioUInteger;
#else
typedef int AVAudioInteger;
typedef unsigned int AVAudioUInteger;
#endif
#ifdef __OBJC__
// Needed for apinotes.
@class AVAudioSession;
#endif
/*!
@typedef AudioSessionID
@brief Defines a unique identifier for an audio session.
*/
typedef uint32_t AudioSessionID;
/*!
@enum AVAudioSessionErrorCode
@brief Error codes returned from the AVAudioSession API.
@var AVAudioSessionErrorCodeNone
Operation succeeded.
@var AVAudioSessionErrorCodeMediaServicesFailed
The app attempted to use the audio session during or after a Media Services failure. App
should wait for a AVAudioSessionMediaServicesWereResetNotification and then rebuild all
its state.
@var AVAudioSessionErrorCodeIsBusy
The app attempted to set its audio session inactive or change its AVAudioSessionIOType,
but it is still actively playing and/or recording.
@var AVAudioSessionErrorCodeIncompatibleCategory
The app tried to perform an operation on a session but its category does not support it.
For instance, if the app calls setPreferredInputNumberOfChannels: while in a playback-only
category.
@var AVAudioSessionErrorCodeCannotInterruptOthers
The app's audio session is non-mixable and trying to go active while in the background.
This is allowed only when the app is the NowPlaying app.
@var AVAudioSessionErrorCodeMissingEntitlement
The app does not have the required entitlements to perform an operation.
@var AVAudioSessionErrorCodeSiriIsRecording
The app tried to do something with the audio session that is not allowed while Siri is
recording.
@var AVAudioSessionErrorCodeCannotStartPlaying
The app is not allowed to start recording and/or playing, usually because of a lack of audio
key in its Info.plist. This could also happen if the app has this key but uses a category
that can't record and/or play in the background (AVAudioSessionCategoryAmbient,
AVAudioSessionCategorySoloAmbient, etc.).
@var AVAudioSessionErrorCodeCannotStartRecording
The app is not allowed to start recording, usually because it is starting a mixable
recording from the background and is not an Inter-App Audio app.
@var AVAudioSessionErrorCodeBadParam
An illegal value was used for a property.
@var AVAudioSessionErrorInsufficientPriority
The app was not allowed to set the audio category because another app (Phone, etc.) is
controlling it.
@var AVAudioSessionErrorCodeResourceNotAvailable
The operation failed because the device does not have sufficient hardware resources to
complete the action. For example, the operation requires audio input hardware, but the
device has no audio input available.
@var AVAudioSessionErrorCodeExpiredSession
The operation failed because the associated session has been destroyed.
@var AVAudioSessionErrorCodeUnspecified
An unspecified error has occurred.
@var AVAudioSessionErrorCodeSessionNotActive
The operation failed because the session is not active.
*/
typedef CF_ENUM(AVAudioInteger, AVAudioSessionErrorCode) {
AVAudioSessionErrorCodeNone = 0,
AVAudioSessionErrorCodeMediaServicesFailed = 'msrv', // 0x6D737276, 1836282486
AVAudioSessionErrorCodeIsBusy = '!act', // 0x21616374, 560030580
AVAudioSessionErrorCodeIncompatibleCategory = '!cat', // 0x21636174, 560161140
AVAudioSessionErrorCodeCannotInterruptOthers = '!int', // 0x21696E74, 560557684
AVAudioSessionErrorCodeMissingEntitlement = 'ent?', // 0x656E743F, 1701737535
AVAudioSessionErrorCodeSiriIsRecording = 'siri', // 0x73697269, 1936290409
AVAudioSessionErrorCodeCannotStartPlaying = '!pla', // 0x21706C61, 561015905
AVAudioSessionErrorCodeCannotStartRecording = '!rec', // 0x21726563, 561145187
AVAudioSessionErrorCodeBadParam = -50,
AVAudioSessionErrorCodeInsufficientPriority = '!pri', // 0x21707269, 561017449
AVAudioSessionErrorCodeResourceNotAvailable = '!res', // 0x21726573, 561145203
AVAudioSessionErrorCodeUnspecified = 'what', // 0x77686174, 2003329396
AVAudioSessionErrorCodeExpiredSession = '!ses', // 0x21736573, 561210739
AVAudioSessionErrorCodeSessionNotActive = 'inac', // 0x696e6163, 1768841571
};
enum {
AVAudioSessionErrorInsufficientPriority API_DEPRECATED_WITH_REPLACEMENT("AVAudioSessionErrorCodeInsufficientPriority", ios(7.0, 12.0)) API_UNAVAILABLE(macos) = AVAudioSessionErrorCodeInsufficientPriority
};
#endif // CoreAudioTypes_AudioSessionTypes_h
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreAudioTypes.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreAudioTypes.framework/Headers/CoreAudioTypes.h | /*!
@file CoreAudioTypes.h
@framework CoreAudioTypes.framework
@copyright (c) 2018 by Apple, Inc., all rights reserved.
@abstract Umbrella header for CoreAudioTypes framework
*/
#include <CoreAudioTypes/CoreAudioBaseTypes.h>
#include <CoreAudioTypes/AudioSessionTypes.h>
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreAudioTypes.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreAudioTypes.framework/Headers/CoreAudioBaseTypes.h | /*!
@file CoreAudioBaseTypes.h
@framework CoreAudioTypes.framework
@copyright (c) 1985-2021 by Apple, Inc., all rights reserved.
@abstract Definition of types common to the Core Audio APIs.
*/
#ifndef CoreAudioTypes_CoreAudioBaseTypes_h
#define CoreAudioTypes_CoreAudioBaseTypes_h
//==================================================================================================
#pragma mark -
#pragma mark Includes
#define COREAUDIOTYPES_VERSION 20210401
#include <TargetConditionals.h>
#include <CoreFoundation/CFBase.h>
// CA_PREFER_FIXED_POINT is true on iOS, but the concept is no longer true. This symbol WILL
// be removed in a future release. (Only deprecated symbols depend on it.)
#if !defined(CA_PREFER_FIXED_POINT)
#if TARGET_OS_IPHONE && !TARGET_OS_MACCATALYST
#define CA_PREFER_FIXED_POINT 1
#endif
#endif
#if defined(__has_feature) && __has_feature(attribute_deprecated_with_message)
#define CA_CANONICAL_DEPRECATED __attribute__((deprecated("The concept of canonical formats is deprecated")))
#else
#define CA_CANONICAL_DEPRECATED
#endif
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wold-style-cast"
#if defined(__cplusplus)
#include <string.h>
#endif
//==================================================================================================
#if defined(__cplusplus)
extern "C"
{
#endif
//==================================================================================================
#pragma mark -
#pragma mark General Error Codes
/*!
@enum General Audio error codes
@abstract These are the error codes returned from the APIs found through Core Audio related frameworks.
@constant kAudio_UnimplementedError
Unimplemented core routine.
@constant kAudio_FileNotFoundError
File not found.
@constant kAudio_FilePermissionError
File cannot be opened due to either file, directory, or sandbox permissions.
@constant kAudio_TooManyFilesOpenError
File cannot be opened because too many files are already open.
@constant kAudio_BadFilePathError
File cannot be opened because the specified path is malformed.
@constant kAudio_ParamError
Error in user parameter list.
@constant kAudio_MemFullError
Not enough room in heap zone.
*/
CF_ENUM(OSStatus)
{
kAudio_UnimplementedError = -4,
kAudio_FileNotFoundError = -43,
kAudio_FilePermissionError = -54,
kAudio_TooManyFilesOpenError = -42,
kAudio_BadFilePathError = '!pth', // 0x21707468, 561017960
kAudio_ParamError = -50,
kAudio_MemFullError = -108
};
//==================================================================================================
#pragma mark -
#pragma mark AudioValueRange
/*!
@struct AudioValueRange
@abstract This structure holds a pair of numbers that represent a continuous range of
values.
@var mMinimum
The minimum value.
@var mMaximum
The maximum value.
*/
struct AudioValueRange
{
Float64 mMinimum;
Float64 mMaximum;
};
typedef struct AudioValueRange AudioValueRange;
//==================================================================================================
#pragma mark -
#pragma mark AudioValueTranslation
/*!
@struct AudioValueTranslation
@abstract This stucture holds the buffers necessary for translation operations.
@var mInputData
The buffer containing the data to be translated.
@var mInputDataSize
The number of bytes in the buffer pointed at by mInputData.
@var mOutputData
The buffer to hold the result of the translation.
@var mOutputDataSize
The number of bytes in the buffer pointed at by mOutputData.
*/
struct AudioValueTranslation
{
void* __nonnull mInputData;
UInt32 mInputDataSize;
void* __nonnull mOutputData;
UInt32 mOutputDataSize;
};
typedef struct AudioValueTranslation AudioValueTranslation;
//==================================================================================================
#pragma mark -
#pragma mark AudioBuffer/AudioBufferList
/*!
@struct AudioBuffer
@abstract A structure to hold a buffer of audio data.
@var mNumberChannels
The number of interleaved channels in the buffer.
@var mDataByteSize
The number of bytes in the buffer pointed at by mData.
@var mData
A pointer to the buffer of audio data.
*/
struct AudioBuffer
{
UInt32 mNumberChannels;
UInt32 mDataByteSize;
void* __nullable mData;
};
typedef struct AudioBuffer AudioBuffer;
/*!
@struct AudioBufferList
@abstract A variable length array of AudioBuffer structures.
@var mNumberBuffers
The number of AudioBuffers in the mBuffers array.
@var mBuffers
A variable length array of AudioBuffers.
*/
struct AudioBufferList
{
UInt32 mNumberBuffers;
AudioBuffer mBuffers[1]; // this is a variable length array of mNumberBuffers elements
#if defined(__cplusplus) && defined(CA_STRICT) && CA_STRICT
public:
AudioBufferList() {}
private:
// Copying and assigning a variable length struct is problematic; generate a compile error.
AudioBufferList(const AudioBufferList&);
AudioBufferList& operator=(const AudioBufferList&);
#endif
};
typedef struct AudioBufferList AudioBufferList;
//==================================================================================================
#pragma mark -
#pragma mark Audio Formats
/*!
@typedef AudioSampleType
@abstract The canonical audio sample type used by the various CoreAudio APIs
@discussion
These types are deprecated. Code performing signal processing should use concrete types
(e.g. float, Float32, SInt16, SInt32). Format-agnostic code, instead of relying on the sizes
of these types, should calculate the size of a sample from an AudioStreamBasicDescription's
mBytesPerChannel, mChannelsPerFrame, and (mFlags & kLinearPCMFormatFlagIsNonInterleaved).
For interleaved formats, the size of a sample is mBytesPerFrame / mChannelsPerFrame.
For non-interleaved formats, it is simply mBytesPerFrame.
*/
#if !defined(CA_PREFER_FIXED_POINT) || !CA_PREFER_FIXED_POINT
CA_CANONICAL_DEPRECATED typedef Float32 AudioSampleType;
CA_CANONICAL_DEPRECATED typedef Float32 AudioUnitSampleType;
#else
CA_CANONICAL_DEPRECATED typedef SInt16 AudioSampleType;
CA_CANONICAL_DEPRECATED typedef SInt32 AudioUnitSampleType;
#define kAudioUnitSampleFractionBits 24
#endif
/*!
@typedef AudioFormatID
@abstract A four char code indicating the general kind of data in the stream.
*/
typedef UInt32 AudioFormatID;
/*!
@typedef AudioFormatFlags
@abstract Flags that are specific to each format.
*/
typedef UInt32 AudioFormatFlags;
/*!
@struct AudioStreamBasicDescription
@abstract This structure encapsulates all the information for describing the basic
format properties of a stream of audio data.
@discussion This structure is sufficient to describe any constant bit rate format that has
channels that are the same size. Extensions are required for variable bit rate
data and for constant bit rate data where the channels have unequal sizes.
However, where applicable, the appropriate fields will be filled out correctly
for these kinds of formats (the extra data is provided via separate properties).
In all fields, a value of 0 indicates that the field is either unknown, not
applicable or otherwise is inapproprate for the format and should be ignored.
Note that 0 is still a valid value for most formats in the mFormatFlags field.
In audio data a frame is one sample across all channels. In non-interleaved
audio, the per frame fields identify one channel. In interleaved audio, the per
frame fields identify the set of n channels. In uncompressed audio, a Packet is
one frame, (mFramesPerPacket == 1). In compressed audio, a Packet is an
indivisible chunk of compressed data, for example an AAC packet will contain
1024 sample frames.
@var mSampleRate
The number of sample frames per second of the data in the stream.
@var mFormatID
The AudioFormatID indicating the general kind of data in the stream.
@var mFormatFlags
The AudioFormatFlags for the format indicated by mFormatID.
@var mBytesPerPacket
The number of bytes in a packet of data.
@var mFramesPerPacket
The number of sample frames in each packet of data.
@var mBytesPerFrame
The number of bytes in a single sample frame of data.
@var mChannelsPerFrame
The number of channels in each frame of data.
@var mBitsPerChannel
The number of bits of sample data for each channel in a frame of data.
@var mReserved
Pads the structure out to force an even 8 byte alignment.
*/
struct AudioStreamBasicDescription
{
Float64 mSampleRate;
AudioFormatID mFormatID;
AudioFormatFlags mFormatFlags;
UInt32 mBytesPerPacket;
UInt32 mFramesPerPacket;
UInt32 mBytesPerFrame;
UInt32 mChannelsPerFrame;
UInt32 mBitsPerChannel;
UInt32 mReserved;
};
typedef struct AudioStreamBasicDescription AudioStreamBasicDescription;
/*!
@constant kAudioStreamAnyRate
The format can use any sample rate. Note that this constant can only appear
in listings of supported formats. It will never appear in a current format.
*/
static const Float64 kAudioStreamAnyRate = 0.0;
/*!
@enum Format IDs
@abstract The AudioFormatIDs used to identify individual formats of audio data.
@constant kAudioFormatLinearPCM
Linear PCM, uses the standard flags.
@constant kAudioFormatAC3
AC-3, has no flags.
@constant kAudioFormat60958AC3
AC-3 packaged for transport over an IEC 60958 compliant digital audio
interface. Uses the standard flags.
@constant kAudioFormatAppleIMA4
Apples implementation of IMA 4:1 ADPCM, has no flags.
@constant kAudioFormatMPEG4AAC
MPEG-4 Low Complexity AAC audio object, has no flags.
@constant kAudioFormatMPEG4CELP
MPEG-4 CELP audio object, has no flags.
@constant kAudioFormatMPEG4HVXC
MPEG-4 HVXC audio object, has no flags.
@constant kAudioFormatMPEG4TwinVQ
MPEG-4 TwinVQ audio object type, has no flags.
@constant kAudioFormatMACE3
MACE 3:1, has no flags.
@constant kAudioFormatMACE6
MACE 6:1, has no flags.
@constant kAudioFormatULaw
µLaw 2:1, has no flags.
@constant kAudioFormatALaw
aLaw 2:1, has no flags.
@constant kAudioFormatQDesign
QDesign music, has no flags
@constant kAudioFormatQDesign2
QDesign2 music, has no flags
@constant kAudioFormatQUALCOMM
QUALCOMM PureVoice, has no flags
@constant kAudioFormatMPEGLayer1
MPEG-1/2, Layer 1 audio, has no flags
@constant kAudioFormatMPEGLayer2
MPEG-1/2, Layer 2 audio, has no flags
@constant kAudioFormatMPEGLayer3
MPEG-1/2, Layer 3 audio, has no flags
@constant kAudioFormatTimeCode
A stream of IOAudioTimeStamps, uses the IOAudioTimeStamp flags (see
IOKit/audio/IOAudioTypes.h).
@constant kAudioFormatMIDIStream
A stream of MIDIPacketLists where the time stamps in the MIDIPacketList are
sample offsets in the stream. The mSampleRate field is used to describe how
time is passed in this kind of stream and an AudioUnit that receives or
generates this stream can use this sample rate, the number of frames it is
rendering and the sample offsets within the MIDIPacketList to define the
time for any MIDI event within this list. It has no flags.
@constant kAudioFormatParameterValueStream
A "side-chain" of Float32 data that can be fed or generated by an AudioUnit
and is used to send a high density of parameter value control information.
An AU will typically run a ParameterValueStream at either the sample rate of
the AudioUnit's audio data, or some integer divisor of this (say a half or a
third of the sample rate of the audio). The Sample Rate of the ASBD
describes this relationship. It has no flags.
@constant kAudioFormatAppleLossless
Apple Lossless, the flags indicate the bit depth of the source material.
@constant kAudioFormatMPEG4AAC_HE
MPEG-4 High Efficiency AAC audio object, has no flags.
@constant kAudioFormatMPEG4AAC_LD
MPEG-4 AAC Low Delay audio object, has no flags.
@constant kAudioFormatMPEG4AAC_ELD
MPEG-4 AAC Enhanced Low Delay audio object, has no flags. This is the formatID of
the base layer without the SBR extension. See also kAudioFormatMPEG4AAC_ELD_SBR
@constant kAudioFormatMPEG4AAC_ELD_SBR
MPEG-4 AAC Enhanced Low Delay audio object with SBR extension layer, has no flags.
@constant kAudioFormatMPEG4AAC_HE_V2
MPEG-4 High Efficiency AAC Version 2 audio object, has no flags.
@constant kAudioFormatMPEG4AAC_Spatial
MPEG-4 Spatial Audio audio object, has no flags.
@constant kAudioFormatMPEGD_USAC
MPEG-D Unified Speech and Audio Coding, has no flags.
@constant kAudioFormatAMR
The AMR Narrow Band speech codec.
@constant kAudioFormatAMR_WB
The AMR Wide Band speech codec.
@constant kAudioFormatAudible
The format used for Audible audio books. It has no flags.
@constant kAudioFormatiLBC
The iLBC narrow band speech codec. It has no flags.
@constant kAudioFormatDVIIntelIMA
DVI/Intel IMA ADPCM - ACM code 17.
@constant kAudioFormatMicrosoftGSM
Microsoft GSM 6.10 - ACM code 49.
@constant kAudioFormatAES3
This format is defined by AES3-2003, and adopted into MXF and MPEG-2
containers and SDTI transport streams with SMPTE specs 302M-2002 and
331M-2000. It has no flags.
@constant kAudioFormatEnhancedAC3
Enhanced AC-3, has no flags.
@constant kAudioFormatFLAC
Free Lossless Audio Codec, the flags indicate the bit depth of the source material.
@constant kAudioFormatOpus
Opus codec, has no flags.
*/
CF_ENUM(AudioFormatID)
{
kAudioFormatLinearPCM = 'lpcm',
kAudioFormatAC3 = 'ac-3',
kAudioFormat60958AC3 = 'cac3',
kAudioFormatAppleIMA4 = 'ima4',
kAudioFormatMPEG4AAC = 'aac ',
kAudioFormatMPEG4CELP = 'celp',
kAudioFormatMPEG4HVXC = 'hvxc',
kAudioFormatMPEG4TwinVQ = 'twvq',
kAudioFormatMACE3 = 'MAC3',
kAudioFormatMACE6 = 'MAC6',
kAudioFormatULaw = 'ulaw',
kAudioFormatALaw = 'alaw',
kAudioFormatQDesign = 'QDMC',
kAudioFormatQDesign2 = 'QDM2',
kAudioFormatQUALCOMM = 'Qclp',
kAudioFormatMPEGLayer1 = '.mp1',
kAudioFormatMPEGLayer2 = '.mp2',
kAudioFormatMPEGLayer3 = '.mp3',
kAudioFormatTimeCode = 'time',
kAudioFormatMIDIStream = 'midi',
kAudioFormatParameterValueStream = 'apvs',
kAudioFormatAppleLossless = 'alac',
kAudioFormatMPEG4AAC_HE = 'aach',
kAudioFormatMPEG4AAC_LD = 'aacl',
kAudioFormatMPEG4AAC_ELD = 'aace',
kAudioFormatMPEG4AAC_ELD_SBR = 'aacf',
kAudioFormatMPEG4AAC_ELD_V2 = 'aacg',
kAudioFormatMPEG4AAC_HE_V2 = 'aacp',
kAudioFormatMPEG4AAC_Spatial = 'aacs',
kAudioFormatMPEGD_USAC = 'usac',
kAudioFormatAMR = 'samr',
kAudioFormatAMR_WB = 'sawb',
kAudioFormatAudible = 'AUDB',
kAudioFormatiLBC = 'ilbc',
kAudioFormatDVIIntelIMA = 0x6D730011,
kAudioFormatMicrosoftGSM = 0x6D730031,
kAudioFormatAES3 = 'aes3',
kAudioFormatEnhancedAC3 = 'ec-3',
kAudioFormatFLAC = 'flac',
kAudioFormatOpus = 'opus'
};
/*!
@enum Standard AudioFormatFlags Values for AudioStreamBasicDescription
@abstract These are the standard AudioFormatFlags for use in the mFormatFlags field of the
AudioStreamBasicDescription structure.
@discussion Typically, when an ASBD is being used, the fields describe the complete layout
of the sample data in the buffers that are represented by this description -
where typically those buffers are represented by an AudioBuffer that is
contained in an AudioBufferList.
However, when an ASBD has the kAudioFormatFlagIsNonInterleaved flag, the
AudioBufferList has a different structure and semantic. In this case, the ASBD
fields will describe the format of ONE of the AudioBuffers that are contained in
the list, AND each AudioBuffer in the list is determined to have a single (mono)
channel of audio data. Then, the ASBD's mChannelsPerFrame will indicate the
total number of AudioBuffers that are contained within the AudioBufferList -
where each buffer contains one channel. This is used primarily with the
AudioUnit (and AudioConverter) representation of this list - and won't be found
in the AudioHardware usage of this structure.
@constant kAudioFormatFlagIsFloat
Set for floating point, clear for integer.
@constant kAudioFormatFlagIsBigEndian
Set for big endian, clear for little endian.
@constant kAudioFormatFlagIsSignedInteger
Set for signed integer, clear for unsigned integer. This is only valid if
kAudioFormatFlagIsFloat is clear.
@constant kAudioFormatFlagIsPacked
Set if the sample bits occupy the entire available bits for the channel,
clear if they are high or low aligned within the channel. Note that even if
this flag is clear, it is implied that this flag is set if the
AudioStreamBasicDescription is filled out such that the fields have the
following relationship:
((mBitsPerSample / 8) * mChannelsPerFrame) == mBytesPerFrame
@constant kAudioFormatFlagIsAlignedHigh
Set if the sample bits are placed into the high bits of the channel, clear
for low bit placement. This is only valid if kAudioFormatFlagIsPacked is
clear.
@constant kAudioFormatFlagIsNonInterleaved
Set if the samples for each channel are located contiguously and the
channels are layed out end to end, clear if the samples for each frame are
layed out contiguously and the frames layed out end to end.
@constant kAudioFormatFlagIsNonMixable
Set to indicate when a format is non-mixable. Note that this flag is only
used when interacting with the HAL's stream format information. It is not a
valid flag for any other uses.
@constant kAudioFormatFlagsAreAllClear
Set if all the flags would be clear in order to preserve 0 as the wild card
value.
@constant kLinearPCMFormatFlagIsFloat
Synonym for kAudioFormatFlagIsFloat.
@constant kLinearPCMFormatFlagIsBigEndian
Synonym for kAudioFormatFlagIsBigEndian.
@constant kLinearPCMFormatFlagIsSignedInteger
Synonym for kAudioFormatFlagIsSignedInteger.
@constant kLinearPCMFormatFlagIsPacked
Synonym for kAudioFormatFlagIsPacked.
@constant kLinearPCMFormatFlagIsAlignedHigh
Synonym for kAudioFormatFlagIsAlignedHigh.
@constant kLinearPCMFormatFlagIsNonInterleaved
Synonym for kAudioFormatFlagIsNonInterleaved.
@constant kLinearPCMFormatFlagIsNonMixable
Synonym for kAudioFormatFlagIsNonMixable.
@constant kLinearPCMFormatFlagsAreAllClear
Synonym for kAudioFormatFlagsAreAllClear.
@constant kLinearPCMFormatFlagsSampleFractionShift
The linear PCM flags contain a 6-bit bitfield indicating that an integer
format is to be interpreted as fixed point. The value indicates the number
of bits are used to represent the fractional portion of each sample value.
This constant indicates the bit position (counting from the right) of the
bitfield in mFormatFlags.
@constant kLinearPCMFormatFlagsSampleFractionMask
number_fractional_bits = (mFormatFlags &
kLinearPCMFormatFlagsSampleFractionMask) >>
kLinearPCMFormatFlagsSampleFractionShift
@constant kAppleLosslessFormatFlag_16BitSourceData
This flag is set for Apple Lossless data that was sourced from 16 bit native
endian signed integer data.
@constant kAppleLosslessFormatFlag_20BitSourceData
This flag is set for Apple Lossless data that was sourced from 20 bit native
endian signed integer data aligned high in 24 bits.
@constant kAppleLosslessFormatFlag_24BitSourceData
This flag is set for Apple Lossless data that was sourced from 24 bit native
endian signed integer data.
@constant kAppleLosslessFormatFlag_32BitSourceData
This flag is set for Apple Lossless data that was sourced from 32 bit native
endian signed integer data.
*/
CF_ENUM(AudioFormatFlags)
{
kAudioFormatFlagIsFloat = (1U << 0), // 0x1
kAudioFormatFlagIsBigEndian = (1U << 1), // 0x2
kAudioFormatFlagIsSignedInteger = (1U << 2), // 0x4
kAudioFormatFlagIsPacked = (1U << 3), // 0x8
kAudioFormatFlagIsAlignedHigh = (1U << 4), // 0x10
kAudioFormatFlagIsNonInterleaved = (1U << 5), // 0x20
kAudioFormatFlagIsNonMixable = (1U << 6), // 0x40
kAudioFormatFlagsAreAllClear = 0x80000000,
kLinearPCMFormatFlagIsFloat = kAudioFormatFlagIsFloat,
kLinearPCMFormatFlagIsBigEndian = kAudioFormatFlagIsBigEndian,
kLinearPCMFormatFlagIsSignedInteger = kAudioFormatFlagIsSignedInteger,
kLinearPCMFormatFlagIsPacked = kAudioFormatFlagIsPacked,
kLinearPCMFormatFlagIsAlignedHigh = kAudioFormatFlagIsAlignedHigh,
kLinearPCMFormatFlagIsNonInterleaved = kAudioFormatFlagIsNonInterleaved,
kLinearPCMFormatFlagIsNonMixable = kAudioFormatFlagIsNonMixable,
kLinearPCMFormatFlagsSampleFractionShift = 7,
kLinearPCMFormatFlagsSampleFractionMask = (0x3F << kLinearPCMFormatFlagsSampleFractionShift),
kLinearPCMFormatFlagsAreAllClear = kAudioFormatFlagsAreAllClear,
kAppleLosslessFormatFlag_16BitSourceData = 1,
kAppleLosslessFormatFlag_20BitSourceData = 2,
kAppleLosslessFormatFlag_24BitSourceData = 3,
kAppleLosslessFormatFlag_32BitSourceData = 4
};
/*!
@enum Commonly Used Combinations of AudioFormatFlags
@abstract Some commonly used combinations of flags for AudioStreamBasicDescriptions.
@constant kAudioFormatFlagsNativeEndian
Defined to set or clear kAudioFormatFlagIsBigEndian depending on the
endianness of the processor at build time.
@constant kAudioFormatFlagsCanonical
The flags for the canonical audio sample type. This matches AudioSampleType.
@constant kAudioFormatFlagsAudioUnitCanonical
The flags for the canonical audio unit sample type. This matches
AudioUnitSampleType.
@constant kAudioFormatFlagsNativeFloatPacked
The flags for fully packed, native endian floating point data.
@discussion
The "canonical" flags are deprecated. CA_PREFER_FIXED_POINT is discouraged because floating-
point performance on iOS is such that fixed point is no longer truly preferred. All Apple-
supplied AudioUnits support floating point. Replacement should be done with careful
consideration of the format being specified or expected, but often
kAudioFormatFlagsCanonical can be replaced with kAudioFormatFlagsNativeFloatPacked, and
kAudioFormatFlagsAudioUnitCanonical with kAudioFormatFlagsNativeFloatPacked |
kAudioFormatFlagIsNonInterleaved.
*/
CF_ENUM(AudioFormatFlags)
{
#if TARGET_RT_BIG_ENDIAN
kAudioFormatFlagsNativeEndian = kAudioFormatFlagIsBigEndian,
#else
kAudioFormatFlagsNativeEndian = 0,
#endif
#if !defined(CA_PREFER_FIXED_POINT) || !CA_PREFER_FIXED_POINT
kAudioFormatFlagsCanonical CA_CANONICAL_DEPRECATED = kAudioFormatFlagIsFloat | kAudioFormatFlagsNativeEndian | kAudioFormatFlagIsPacked,
kAudioFormatFlagsAudioUnitCanonical CA_CANONICAL_DEPRECATED = kAudioFormatFlagIsFloat | kAudioFormatFlagsNativeEndian | kAudioFormatFlagIsPacked | kAudioFormatFlagIsNonInterleaved,
#else
kAudioFormatFlagsCanonical CA_CANONICAL_DEPRECATED = kAudioFormatFlagIsSignedInteger | kAudioFormatFlagsNativeEndian | kAudioFormatFlagIsPacked,
kAudioFormatFlagsAudioUnitCanonical CA_CANONICAL_DEPRECATED = kAudioFormatFlagIsSignedInteger | kAudioFormatFlagsNativeEndian | kAudioFormatFlagIsPacked | kAudioFormatFlagIsNonInterleaved | (kAudioUnitSampleFractionBits << kLinearPCMFormatFlagsSampleFractionShift),
#endif
kAudioFormatFlagsNativeFloatPacked = kAudioFormatFlagIsFloat | kAudioFormatFlagsNativeEndian | kAudioFormatFlagIsPacked
};
/*!
@defined TestAudioFormatNativeEndian
@abstract A macro for checking if an ASBD indicates native endian linear PCM data.
*/
#define TestAudioFormatNativeEndian(f) ((f.mFormatID == kAudioFormatLinearPCM) && ((f.mFormatFlags & kAudioFormatFlagIsBigEndian) == kAudioFormatFlagsNativeEndian))
/*!
@function IsAudioFormatNativeEndian
@abstract A C++ inline function for checking if an ASBD indicates native endian linear PCM
data.
@param f
The AudioStreamBasicDescription to examine.
@result Whether or not the ASBD indicates native endian linear PCM data.
*/
#if defined(__cplusplus)
static inline bool IsAudioFormatNativeEndian(const AudioStreamBasicDescription& f) { return (f.mFormatID == kAudioFormatLinearPCM) && ((f.mFormatFlags & kAudioFormatFlagIsBigEndian) == kAudioFormatFlagsNativeEndian); }
#endif
/*!
@function CalculateLPCMFlags
@abstract A C++ inline function for calculating the mFormatFlags for linear PCM data. Note
that this function does not support specifying sample formats that are either
unsigned integer or low-aligned.
@param inSampleRate
@param inValidBitsPerChannel
The number of valid bits in each sample.
@param inTotalBitsPerChannel
The total number of bits in each sample.
@param inIsFloat
Whether or not the samples are represented with floating point numbers.
@param isIsBigEndian
Whether the samples are big endian or little endian.
@result A UInt32 containing the format flags.
*/
#if defined(__cplusplus)
static inline AudioFormatFlags CalculateLPCMFlags(UInt32 inValidBitsPerChannel, UInt32 inTotalBitsPerChannel, bool inIsFloat, bool inIsBigEndian, bool inIsNonInterleaved = false) { return (inIsFloat ? kAudioFormatFlagIsFloat : kAudioFormatFlagIsSignedInteger) | (inIsBigEndian ? ((UInt32)kAudioFormatFlagIsBigEndian) : 0) | ((inValidBitsPerChannel == inTotalBitsPerChannel) ? kAudioFormatFlagIsPacked : kAudioFormatFlagIsAlignedHigh) | (inIsNonInterleaved ? ((UInt32)kAudioFormatFlagIsNonInterleaved) : 0); }
#endif
/*!
@function FillOutASBDForLPCM
@abstract A C++ inline function for filling out an AudioStreamBasicDescription to describe
linear PCM data. Note that this function does not support specifying sample formats
that are either unsigned integer or low-aligned.
@param outASBD
The AudioStreamBasicDescription to fill out.
@param inSampleRate
The number of sample frames per second of the data in the stream.
@param inChannelsPerFrame
The number of channels in each frame of data.
@param inValidBitsPerChannel
The number of valid bits in each sample.
@param inTotalBitsPerChannel
The total number of bits in each sample.
@param inIsFloat
Whether or not the samples are represented with floating point numbers.
@param isIsBigEndian
Whether the samples are big endian or little endian.
*/
#if defined(__cplusplus)
static inline void FillOutASBDForLPCM(AudioStreamBasicDescription& outASBD, Float64 inSampleRate, UInt32 inChannelsPerFrame, UInt32 inValidBitsPerChannel, UInt32 inTotalBitsPerChannel, bool inIsFloat, bool inIsBigEndian, bool inIsNonInterleaved = false) { outASBD.mSampleRate = inSampleRate; outASBD.mFormatID = kAudioFormatLinearPCM; outASBD.mFormatFlags = CalculateLPCMFlags(inValidBitsPerChannel, inTotalBitsPerChannel, inIsFloat, inIsBigEndian, inIsNonInterleaved); outASBD.mBytesPerPacket = (inIsNonInterleaved ? 1 : inChannelsPerFrame) * (inTotalBitsPerChannel / 8); outASBD.mFramesPerPacket = 1; outASBD.mBytesPerFrame = (inIsNonInterleaved ? 1 : inChannelsPerFrame) * (inTotalBitsPerChannel / 8); outASBD.mChannelsPerFrame = inChannelsPerFrame; outASBD.mBitsPerChannel = inValidBitsPerChannel; }
#endif
/*!
@struct AudioStreamPacketDescription
@abstract This structure describes the packet layout of a buffer of data where the size of
each packet may not be the same or where there is extraneous data between
packets.
@var mStartOffset
The number of bytes from the start of the buffer to the beginning of the
packet.
@var mVariableFramesInPacket
The number of sample frames of data in the packet. For formats with a
constant number of frames per packet, this field is set to 0.
@var mDataByteSize
The number of bytes in the packet.
*/
struct AudioStreamPacketDescription
{
SInt64 mStartOffset;
UInt32 mVariableFramesInPacket;
UInt32 mDataByteSize;
};
typedef struct AudioStreamPacketDescription AudioStreamPacketDescription;
//==================================================================================================
#pragma mark -
#pragma mark Audio Time Stamps
// SMPTETime is also defined in the CoreVideo headers.
#if !defined(__SMPTETime__)
#define __SMPTETime__
/*!
@enum SMPTE Time Types
@abstract Constants that describe the type of SMPTE time.
@constant kSMPTETimeType24
24 Frame
@constant kSMPTETimeType25
25 Frame
@constant kSMPTETimeType30Drop
30 Drop Frame
@constant kSMPTETimeType30
30 Frame
@constant kSMPTETimeType2997
29.97 Frame
@constant kSMPTETimeType2997Drop
29.97 Drop Frame
@constant kSMPTETimeType60
60 Frame
@constant kSMPTETimeType5994
59.94 Frame
@constant kSMPTETimeType60Drop
60 Drop Frame
@constant kSMPTETimeType5994Drop
59.94 Drop Frame
@constant kSMPTETimeType50
50 Frame
@constant kSMPTETimeType2398
23.98 Frame
*/
typedef CF_ENUM(UInt32, SMPTETimeType)
{
kSMPTETimeType24 = 0,
kSMPTETimeType25 = 1,
kSMPTETimeType30Drop = 2,
kSMPTETimeType30 = 3,
kSMPTETimeType2997 = 4,
kSMPTETimeType2997Drop = 5,
kSMPTETimeType60 = 6,
kSMPTETimeType5994 = 7,
kSMPTETimeType60Drop = 8,
kSMPTETimeType5994Drop = 9,
kSMPTETimeType50 = 10,
kSMPTETimeType2398 = 11
};
/*!
@enum SMPTETimeFlags
@abstract Flags that describe the SMPTE time state.
@constant kSMPTETimeValid
The full time is valid.
@constant kSMPTETimeRunning
Time is running.
*/
typedef CF_OPTIONS(UInt32, SMPTETimeFlags)
{
kSMPTETimeUnknown = 0,
kSMPTETimeValid = (1U << 0),
kSMPTETimeRunning = (1U << 1)
};
/*!
@struct SMPTETime
@abstract A structure for holding a SMPTE time.
@var mSubframes
The number of subframes in the full message.
@var mSubframeDivisor
The number of subframes per frame (typically 80).
@var mCounter
The total number of messages received.
@var mType
The kind of SMPTE time using the SMPTE time type constants.
@var mFlags
A set of flags that indicate the SMPTE state.
@var mHours
The number of hours in the full message.
@var mMinutes
The number of minutes in the full message.
@var mSeconds
The number of seconds in the full message.
@var mFrames
The number of frames in the full message.
*/
struct SMPTETime
{
SInt16 mSubframes;
SInt16 mSubframeDivisor;
UInt32 mCounter;
SMPTETimeType mType;
SMPTETimeFlags mFlags;
SInt16 mHours;
SInt16 mMinutes;
SInt16 mSeconds;
SInt16 mFrames;
};
typedef struct SMPTETime SMPTETime;
#endif
/*!
@enum AudioTimeStampFlags
@abstract The flags that indicate which fields in an AudioTimeStamp structure are valid.
@constant kAudioTimeStampSampleTimeValid
The sample frame time is valid.
@constant kAudioTimeStampHostTimeValid
The host time is valid.
@constant kAudioTimeStampRateScalarValid
The rate scalar is valid.
@constant kAudioTimeStampWordClockTimeValid
The word clock time is valid.
@constant kAudioTimeStampSMPTETimeValid
The SMPTE time is valid.
@constant kAudioTimeStampSampleHostTimeValid
The sample frame time and the host time are valid.
*/
typedef CF_OPTIONS(UInt32, AudioTimeStampFlags)
{
kAudioTimeStampNothingValid = 0,
kAudioTimeStampSampleTimeValid = (1U << 0),
kAudioTimeStampHostTimeValid = (1U << 1),
kAudioTimeStampRateScalarValid = (1U << 2),
kAudioTimeStampWordClockTimeValid = (1U << 3),
kAudioTimeStampSMPTETimeValid = (1U << 4),
kAudioTimeStampSampleHostTimeValid = (kAudioTimeStampSampleTimeValid | kAudioTimeStampHostTimeValid)
};
/*!
@struct AudioTimeStamp
@abstract A structure that holds different representations of the same point in time.
@var mSampleTime
The absolute sample frame time.
@var mHostTime
The host machine's time base, mach_absolute_time.
@var mRateScalar
The ratio of actual host ticks per sample frame to the nominal host ticks
per sample frame.
@var mWordClockTime
The word clock time.
@var mSMPTETime
The SMPTE time.
@var mFlags
A set of flags indicating which representations of the time are valid.
@var mReserved
Pads the structure out to force an even 8 byte alignment.
*/
struct AudioTimeStamp
{
Float64 mSampleTime;
UInt64 mHostTime;
Float64 mRateScalar;
UInt64 mWordClockTime;
SMPTETime mSMPTETime;
AudioTimeStampFlags mFlags;
UInt32 mReserved;
};
typedef struct AudioTimeStamp AudioTimeStamp;
/*!
@function FillOutAudioTimeStampWithSampleTime
@abstract A C++ inline function for filling out an AudioTimeStamp with a sample time
@param outATS
The AudioTimeStamp to fill out.
@param inSampleTime
The sample time to put in the AudioTimeStamp.
*/
#if defined(__cplusplus)
static inline void FillOutAudioTimeStampWithSampleTime(AudioTimeStamp& outATS, Float64 inSampleTime) { outATS.mSampleTime = inSampleTime; outATS.mHostTime = 0; outATS.mRateScalar = 0; outATS.mWordClockTime = 0; memset(&outATS.mSMPTETime, 0, sizeof(SMPTETime)); outATS.mFlags = kAudioTimeStampSampleTimeValid; }
#endif
/*!
@function FillOutAudioTimeStampWithHostTime
@abstract A C++ inline function for filling out an AudioTimeStamp with a host time
@param outATS
The AudioTimeStamp to fill out.
@param inHostTime
The host time to put in the AudioTimeStamp.
*/
#if defined(__cplusplus)
static inline void FillOutAudioTimeStampWithHostTime(AudioTimeStamp& outATS, UInt64 inHostTime) { outATS.mSampleTime = 0; outATS.mHostTime = inHostTime; outATS.mRateScalar = 0; outATS.mWordClockTime = 0; memset(&outATS.mSMPTETime, 0, sizeof(SMPTETime)); outATS.mFlags = kAudioTimeStampHostTimeValid; }
#endif
/*!
@function FillOutAudioTimeStampWithSampleAndHostTime
@abstract A C++ inline function for filling out an AudioTimeStamp with a sample time and a
host time
@param outATS
The AudioTimeStamp to fill out.
@param inSampleTime
The sample time to put in the AudioTimeStamp.
@param inHostTime
The host time to put in the AudioTimeStamp.
*/
#if defined(__cplusplus)
static inline void FillOutAudioTimeStampWithSampleAndHostTime(AudioTimeStamp& outATS, Float64 inSampleTime, UInt64 inHostTime) { outATS.mSampleTime = inSampleTime; outATS.mHostTime = inHostTime; outATS.mRateScalar = 0; outATS.mWordClockTime = 0; memset(&outATS.mSMPTETime, 0, sizeof(SMPTETime)); outATS.mFlags = kAudioTimeStampSampleTimeValid | kAudioTimeStampHostTimeValid; }
#endif
//==================================================================================================
#pragma mark -
#pragma mark AudioClassDescription
/*!
@struct AudioClassDescription
@abstract This structure is used to describe codecs installed on the system.
@var mType
The four char code codec type.
@var mSubType
The four char code codec subtype.
@var mManufacturer
The four char code codec manufacturer.
*/
struct AudioClassDescription {
OSType mType;
OSType mSubType;
OSType mManufacturer;
};
typedef struct AudioClassDescription AudioClassDescription;
//==================================================================================================
#pragma mark -
#pragma mark Audio Channel Layout
/*!
@typedef AudioChannelLabel
@abstract A tag identifying how the channel is to be used.
*/
typedef UInt32 AudioChannelLabel;
/*!
@typedef AudioChannelLayoutTag
@abstract A tag identifying a particular pre-defined channel layout.
*/
typedef UInt32 AudioChannelLayoutTag;
/*!
@enum AudioChannelLabel Constants
@abstract These constants are for use in the mChannelLabel field of an
AudioChannelDescription structure.
@discussion These channel labels attempt to list all labels in common use. Due to the
ambiguities in channel labeling by various groups, there may be some overlap or
duplication in the labels below. Use the label which most clearly describes what
you mean.
WAVE files seem to follow the USB spec for the channel flags. A channel map lets
you put these channels in any order, however a WAVE file only supports labels
1-18 and if present, they must be in the order given below. The integer values
for the labels below match the bit position of the label in the USB bitmap and
thus also the WAVE file bitmap.
*/
CF_ENUM(AudioChannelLabel)
{
kAudioChannelLabel_Unknown = 0xFFFFFFFF, ///< unknown or unspecified other use
kAudioChannelLabel_Unused = 0, ///< channel is present, but has no intended use or destination
kAudioChannelLabel_UseCoordinates = 100, ///< channel is described by the mCoordinates fields.
kAudioChannelLabel_Left = 1,
kAudioChannelLabel_Right = 2,
kAudioChannelLabel_Center = 3,
kAudioChannelLabel_LFEScreen = 4,
kAudioChannelLabel_LeftSurround = 5,
kAudioChannelLabel_RightSurround = 6,
kAudioChannelLabel_LeftCenter = 7,
kAudioChannelLabel_RightCenter = 8,
kAudioChannelLabel_CenterSurround = 9, ///< WAVE: "Back Center" or plain "Rear Surround"
kAudioChannelLabel_LeftSurroundDirect = 10,
kAudioChannelLabel_RightSurroundDirect = 11,
kAudioChannelLabel_TopCenterSurround = 12,
kAudioChannelLabel_VerticalHeightLeft = 13, ///< WAVE: "Top Front Left"
kAudioChannelLabel_VerticalHeightCenter = 14, ///< WAVE: "Top Front Center"
kAudioChannelLabel_VerticalHeightRight = 15, ///< WAVE: "Top Front Right"
kAudioChannelLabel_TopBackLeft = 16,
kAudioChannelLabel_TopBackCenter = 17,
kAudioChannelLabel_TopBackRight = 18,
kAudioChannelLabel_RearSurroundLeft = 33,
kAudioChannelLabel_RearSurroundRight = 34,
kAudioChannelLabel_LeftWide = 35,
kAudioChannelLabel_RightWide = 36,
kAudioChannelLabel_LFE2 = 37,
kAudioChannelLabel_LeftTotal = 38, ///< matrix encoded 4 channels
kAudioChannelLabel_RightTotal = 39, ///< matrix encoded 4 channels
kAudioChannelLabel_HearingImpaired = 40,
kAudioChannelLabel_Narration = 41,
kAudioChannelLabel_Mono = 42,
kAudioChannelLabel_DialogCentricMix = 43,
kAudioChannelLabel_CenterSurroundDirect = 44, ///< back center, non diffuse
kAudioChannelLabel_Haptic = 45,
kAudioChannelLabel_LeftTopFront = kAudioChannelLabel_VerticalHeightLeft,
kAudioChannelLabel_CenterTopFront = kAudioChannelLabel_VerticalHeightCenter,
kAudioChannelLabel_RightTopFront = kAudioChannelLabel_VerticalHeightRight,
kAudioChannelLabel_LeftTopMiddle = 49,
kAudioChannelLabel_CenterTopMiddle = kAudioChannelLabel_TopCenterSurround,
kAudioChannelLabel_RightTopMiddle = 51,
kAudioChannelLabel_LeftTopRear = 52,
kAudioChannelLabel_CenterTopRear = 53,
kAudioChannelLabel_RightTopRear = 54,
// first order ambisonic channels
kAudioChannelLabel_Ambisonic_W = 200,
kAudioChannelLabel_Ambisonic_X = 201,
kAudioChannelLabel_Ambisonic_Y = 202,
kAudioChannelLabel_Ambisonic_Z = 203,
// Mid/Side Recording
kAudioChannelLabel_MS_Mid = 204,
kAudioChannelLabel_MS_Side = 205,
// X-Y Recording
kAudioChannelLabel_XY_X = 206,
kAudioChannelLabel_XY_Y = 207,
// Binaural Recording
kAudioChannelLabel_BinauralLeft = 208,
kAudioChannelLabel_BinauralRight = 209,
// other
kAudioChannelLabel_HeadphonesLeft = 301,
kAudioChannelLabel_HeadphonesRight = 302,
kAudioChannelLabel_ClickTrack = 304,
kAudioChannelLabel_ForeignLanguage = 305,
// generic discrete channel
kAudioChannelLabel_Discrete = 400,
// numbered discrete channel
kAudioChannelLabel_Discrete_0 = (1U<<16) | 0,
kAudioChannelLabel_Discrete_1 = (1U<<16) | 1,
kAudioChannelLabel_Discrete_2 = (1U<<16) | 2,
kAudioChannelLabel_Discrete_3 = (1U<<16) | 3,
kAudioChannelLabel_Discrete_4 = (1U<<16) | 4,
kAudioChannelLabel_Discrete_5 = (1U<<16) | 5,
kAudioChannelLabel_Discrete_6 = (1U<<16) | 6,
kAudioChannelLabel_Discrete_7 = (1U<<16) | 7,
kAudioChannelLabel_Discrete_8 = (1U<<16) | 8,
kAudioChannelLabel_Discrete_9 = (1U<<16) | 9,
kAudioChannelLabel_Discrete_10 = (1U<<16) | 10,
kAudioChannelLabel_Discrete_11 = (1U<<16) | 11,
kAudioChannelLabel_Discrete_12 = (1U<<16) | 12,
kAudioChannelLabel_Discrete_13 = (1U<<16) | 13,
kAudioChannelLabel_Discrete_14 = (1U<<16) | 14,
kAudioChannelLabel_Discrete_15 = (1U<<16) | 15,
kAudioChannelLabel_Discrete_65535 = (1U<<16) | 65535,
// generic HOA ACN channel
kAudioChannelLabel_HOA_ACN = 500,
// numbered HOA ACN channels, SN3D normalization
kAudioChannelLabel_HOA_ACN_0 = (2U << 16) | 0,
kAudioChannelLabel_HOA_ACN_1 = (2U << 16) | 1,
kAudioChannelLabel_HOA_ACN_2 = (2U << 16) | 2,
kAudioChannelLabel_HOA_ACN_3 = (2U << 16) | 3,
kAudioChannelLabel_HOA_ACN_4 = (2U << 16) | 4,
kAudioChannelLabel_HOA_ACN_5 = (2U << 16) | 5,
kAudioChannelLabel_HOA_ACN_6 = (2U << 16) | 6,
kAudioChannelLabel_HOA_ACN_7 = (2U << 16) | 7,
kAudioChannelLabel_HOA_ACN_8 = (2U << 16) | 8,
kAudioChannelLabel_HOA_ACN_9 = (2U << 16) | 9,
kAudioChannelLabel_HOA_ACN_10 = (2U << 16) | 10,
kAudioChannelLabel_HOA_ACN_11 = (2U << 16) | 11,
kAudioChannelLabel_HOA_ACN_12 = (2U << 16) | 12,
kAudioChannelLabel_HOA_ACN_13 = (2U << 16) | 13,
kAudioChannelLabel_HOA_ACN_14 = (2U << 16) | 14,
kAudioChannelLabel_HOA_ACN_15 = (2U << 16) | 15,
kAudioChannelLabel_HOA_ACN_65024 = (2U << 16) | 65024, // 254th order uses 65025 channels
// Specific SN3D alias
kAudioChannelLabel_HOA_SN3D = kAudioChannelLabel_HOA_ACN_0, // Needs to be ORed with the channel index, not HOA order
// HOA N3D
kAudioChannelLabel_HOA_N3D = (3U << 16), // Needs to be ORed with the channel index, not HOA order
kAudioChannelLabel_BeginReserved = 0xF0000000, // Channel label values in this range are reserved for internal use
kAudioChannelLabel_EndReserved = 0xFFFFFFFE
};
/*!
@enum AudioChannelBitmap
@abstract These constants are for use in the mChannelBitmap field of an
AudioChannelLayout structure.
*/
typedef CF_OPTIONS(UInt32, AudioChannelBitmap)
{
kAudioChannelBit_Left = (1U<<0),
kAudioChannelBit_Right = (1U<<1),
kAudioChannelBit_Center = (1U<<2),
kAudioChannelBit_LFEScreen = (1U<<3),
kAudioChannelBit_LeftSurround = (1U<<4),
kAudioChannelBit_RightSurround = (1U<<5),
kAudioChannelBit_LeftCenter = (1U<<6),
kAudioChannelBit_RightCenter = (1U<<7),
kAudioChannelBit_CenterSurround = (1U<<8), // WAVE: "Back Center"
kAudioChannelBit_LeftSurroundDirect = (1U<<9),
kAudioChannelBit_RightSurroundDirect = (1U<<10),
kAudioChannelBit_TopCenterSurround = (1U<<11),
kAudioChannelBit_VerticalHeightLeft = (1U<<12), // WAVE: "Top Front Left"
kAudioChannelBit_VerticalHeightCenter = (1U<<13), // WAVE: "Top Front Center"
kAudioChannelBit_VerticalHeightRight = (1U<<14), // WAVE: "Top Front Right"
kAudioChannelBit_TopBackLeft = (1U<<15),
kAudioChannelBit_TopBackCenter = (1U<<16),
kAudioChannelBit_TopBackRight = (1U<<17),
kAudioChannelBit_LeftTopFront = kAudioChannelBit_VerticalHeightLeft,
kAudioChannelBit_CenterTopFront = kAudioChannelBit_VerticalHeightCenter,
kAudioChannelBit_RightTopFront = kAudioChannelBit_VerticalHeightRight,
kAudioChannelBit_LeftTopMiddle = (1U<<21),
kAudioChannelBit_CenterTopMiddle = kAudioChannelBit_TopCenterSurround,
kAudioChannelBit_RightTopMiddle = (1U<<23),
kAudioChannelBit_LeftTopRear = (1U<<24),
kAudioChannelBit_CenterTopRear = (1U<<25),
kAudioChannelBit_RightTopRear = (1U<<26),
};
/*!
@enum AudioChannelFlags
@abstract These constants are used in the mChannelFlags field of an
AudioChannelDescription structure.
@constant kAudioChannelFlags_RectangularCoordinates
The channel is specified by the cartesian coordinates of the speaker
position. This flag is mutally exclusive with
kAudioChannelFlags_SphericalCoordinates.
@constant kAudioChannelFlags_SphericalCoordinates
The channel is specified by the spherical coordinates of the speaker
position. This flag is mutally exclusive with
kAudioChannelFlags_RectangularCoordinates.
@constant kAudioChannelFlags_Meters
Set to indicate the units are in meters, clear to indicate the units are
relative to the unit cube or unit sphere.
*/
typedef CF_OPTIONS(UInt32, AudioChannelFlags)
{
kAudioChannelFlags_AllOff = 0,
kAudioChannelFlags_RectangularCoordinates = (1U<<0),
kAudioChannelFlags_SphericalCoordinates = (1U<<1),
kAudioChannelFlags_Meters = (1U<<2)
};
// these are indices for accessing the mCoordinates array in struct AudioChannelDescription
/*!
@enum AudioChannelCoordinateIndex
@abstract Constants for indexing the mCoordinates array in an AudioChannelDescription
structure.
@constant kAudioChannelCoordinates_LeftRight
For rectangular coordinates, negative is left and positive is right.
@constant kAudioChannelCoordinates_BackFront
For rectangular coordinates, negative is back and positive is front.
@constant kAudioChannelCoordinates_DownUp
For rectangular coordinates, negative is below ground level, 0 is ground
level, and positive is above ground level.
@constant kAudioChannelCoordinates_Azimuth
For spherical coordinates, 0 is front center, positive is right, negative is
left. This is measured in degrees.
@constant kAudioChannelCoordinates_Elevation
For spherical coordinates, +90 is zenith, 0 is horizontal, -90 is nadir.
This is measured in degrees.
@constant kAudioChannelCoordinates_Distance
For spherical coordinates, the units are described by flags.
*/
typedef CF_ENUM(UInt32, AudioChannelCoordinateIndex)
{
kAudioChannelCoordinates_LeftRight = 0,
kAudioChannelCoordinates_BackFront = 1,
kAudioChannelCoordinates_DownUp = 2,
kAudioChannelCoordinates_Azimuth = 0,
kAudioChannelCoordinates_Elevation = 1,
kAudioChannelCoordinates_Distance = 2
};
/*!
@enum AudioChannelLayoutTag Constants
@abstract These constants are used in the mChannelLayoutTag field of an AudioChannelLayout
structure.
*/
CF_ENUM(AudioChannelLayoutTag)
{
// Some channel abbreviations used below:
// L - left
// R - right
// C - center
// Ls - left surround
// Rs - right surround
// Cs - center surround
// Rls - rear left surround
// Rrs - rear right surround
// Lw - left wide
// Rw - right wide
// Lsd - left surround direct
// Rsd - right surround direct
// Lc - left center
// Rc - right center
// Ts - top surround
// Vhl - vertical height left
// Vhc - vertical height center
// Vhr - vertical height right
// Ltm - left top middle
// Rtm - right top middle
// Ltr - left top rear
// Ctr - center top rear
// Rtr - right top rear
// Lt - left matrix total. for matrix encoded stereo.
// Rt - right matrix total. for matrix encoded stereo.
// General layouts
kAudioChannelLayoutTag_UseChannelDescriptions = (0U<<16) | 0, ///< use the array of AudioChannelDescriptions to define the mapping.
kAudioChannelLayoutTag_UseChannelBitmap = (1U<<16) | 0, ///< use the bitmap to define the mapping.
kAudioChannelLayoutTag_Mono = (100U<<16) | 1, ///< a standard mono stream
kAudioChannelLayoutTag_Stereo = (101U<<16) | 2, ///< a standard stereo stream (L R) - implied playback
kAudioChannelLayoutTag_StereoHeadphones = (102U<<16) | 2, ///< a standard stereo stream (L R) - implied headphone playback
kAudioChannelLayoutTag_MatrixStereo = (103U<<16) | 2, ///< a matrix encoded stereo stream (Lt, Rt)
kAudioChannelLayoutTag_MidSide = (104U<<16) | 2, ///< mid/side recording
kAudioChannelLayoutTag_XY = (105U<<16) | 2, ///< coincident mic pair (often 2 figure 8's)
kAudioChannelLayoutTag_Binaural = (106U<<16) | 2, ///< binaural stereo (left, right)
kAudioChannelLayoutTag_Ambisonic_B_Format = (107U<<16) | 4, ///< W, X, Y, Z
kAudioChannelLayoutTag_Quadraphonic = (108U<<16) | 4, ///< L R Ls Rs -- 90 degree speaker separation
kAudioChannelLayoutTag_Pentagonal = (109U<<16) | 5, ///< L R Ls Rs C -- 72 degree speaker separation
kAudioChannelLayoutTag_Hexagonal = (110U<<16) | 6, ///< L R Ls Rs C Cs -- 60 degree speaker separation
kAudioChannelLayoutTag_Octagonal = (111U<<16) | 8, ///< L R Ls Rs C Cs Lw Rw -- 45 degree speaker separation
kAudioChannelLayoutTag_Cube = (112U<<16) | 8, ///< left, right, rear left, rear right
///< top left, top right, top rear left, top rear right
// MPEG defined layouts
kAudioChannelLayoutTag_MPEG_1_0 = kAudioChannelLayoutTag_Mono, ///< C
kAudioChannelLayoutTag_MPEG_2_0 = kAudioChannelLayoutTag_Stereo, ///< L R
kAudioChannelLayoutTag_MPEG_3_0_A = (113U<<16) | 3, ///< L R C
kAudioChannelLayoutTag_MPEG_3_0_B = (114U<<16) | 3, ///< C L R
kAudioChannelLayoutTag_MPEG_4_0_A = (115U<<16) | 4, ///< L R C Cs
kAudioChannelLayoutTag_MPEG_4_0_B = (116U<<16) | 4, ///< C L R Cs
kAudioChannelLayoutTag_MPEG_5_0_A = (117U<<16) | 5, ///< L R C Ls Rs
kAudioChannelLayoutTag_MPEG_5_0_B = (118U<<16) | 5, ///< L R Ls Rs C
kAudioChannelLayoutTag_MPEG_5_0_C = (119U<<16) | 5, ///< L C R Ls Rs
kAudioChannelLayoutTag_MPEG_5_0_D = (120U<<16) | 5, ///< C L R Ls Rs
kAudioChannelLayoutTag_MPEG_5_1_A = (121U<<16) | 6, ///< L R C LFE Ls Rs
kAudioChannelLayoutTag_MPEG_5_1_B = (122U<<16) | 6, ///< L R Ls Rs C LFE
kAudioChannelLayoutTag_MPEG_5_1_C = (123U<<16) | 6, ///< L C R Ls Rs LFE
kAudioChannelLayoutTag_MPEG_5_1_D = (124U<<16) | 6, ///< C L R Ls Rs LFE
kAudioChannelLayoutTag_MPEG_6_1_A = (125U<<16) | 7, ///< L R C LFE Ls Rs Cs
kAudioChannelLayoutTag_MPEG_7_1_A = (126U<<16) | 8, ///< L R C LFE Ls Rs Lc Rc
kAudioChannelLayoutTag_MPEG_7_1_B = (127U<<16) | 8, ///< C Lc Rc L R Ls Rs LFE (doc: IS-13818-7 MPEG2-AAC Table 3.1)
kAudioChannelLayoutTag_MPEG_7_1_C = (128U<<16) | 8, ///< L R C LFE Ls Rs Rls Rrs
kAudioChannelLayoutTag_Emagic_Default_7_1 = (129U<<16) | 8, ///< L R Ls Rs C LFE Lc Rc
kAudioChannelLayoutTag_SMPTE_DTV = (130U<<16) | 8, ///< L R C LFE Ls Rs Lt Rt
///< (kAudioChannelLayoutTag_ITU_5_1 plus a matrix encoded stereo mix)
// ITU defined layouts
kAudioChannelLayoutTag_ITU_1_0 = kAudioChannelLayoutTag_Mono, ///< C
kAudioChannelLayoutTag_ITU_2_0 = kAudioChannelLayoutTag_Stereo, ///< L R
kAudioChannelLayoutTag_ITU_2_1 = (131U<<16) | 3, ///< L R Cs
kAudioChannelLayoutTag_ITU_2_2 = (132U<<16) | 4, ///< L R Ls Rs
kAudioChannelLayoutTag_ITU_3_0 = kAudioChannelLayoutTag_MPEG_3_0_A, ///< L R C
kAudioChannelLayoutTag_ITU_3_1 = kAudioChannelLayoutTag_MPEG_4_0_A, ///< L R C Cs
kAudioChannelLayoutTag_ITU_3_2 = kAudioChannelLayoutTag_MPEG_5_0_A, ///< L R C Ls Rs
kAudioChannelLayoutTag_ITU_3_2_1 = kAudioChannelLayoutTag_MPEG_5_1_A, ///< L R C LFE Ls Rs
kAudioChannelLayoutTag_ITU_3_4_1 = kAudioChannelLayoutTag_MPEG_7_1_C, ///< L R C LFE Ls Rs Rls Rrs
// DVD defined layouts
kAudioChannelLayoutTag_DVD_0 = kAudioChannelLayoutTag_Mono, ///< C (mono)
kAudioChannelLayoutTag_DVD_1 = kAudioChannelLayoutTag_Stereo, ///< L R
kAudioChannelLayoutTag_DVD_2 = kAudioChannelLayoutTag_ITU_2_1, ///< L R Cs
kAudioChannelLayoutTag_DVD_3 = kAudioChannelLayoutTag_ITU_2_2, ///< L R Ls Rs
kAudioChannelLayoutTag_DVD_4 = (133U<<16) | 3, ///< L R LFE
kAudioChannelLayoutTag_DVD_5 = (134U<<16) | 4, ///< L R LFE Cs
kAudioChannelLayoutTag_DVD_6 = (135U<<16) | 5, ///< L R LFE Ls Rs
kAudioChannelLayoutTag_DVD_7 = kAudioChannelLayoutTag_MPEG_3_0_A, ///< L R C
kAudioChannelLayoutTag_DVD_8 = kAudioChannelLayoutTag_MPEG_4_0_A, ///< L R C Cs
kAudioChannelLayoutTag_DVD_9 = kAudioChannelLayoutTag_MPEG_5_0_A, ///< L R C Ls Rs
kAudioChannelLayoutTag_DVD_10 = (136U<<16) | 4, ///< L R C LFE
kAudioChannelLayoutTag_DVD_11 = (137U<<16) | 5, ///< L R C LFE Cs
kAudioChannelLayoutTag_DVD_12 = kAudioChannelLayoutTag_MPEG_5_1_A, ///< L R C LFE Ls Rs
// 13 through 17 are duplicates of 8 through 12.
kAudioChannelLayoutTag_DVD_13 = kAudioChannelLayoutTag_DVD_8, ///< L R C Cs
kAudioChannelLayoutTag_DVD_14 = kAudioChannelLayoutTag_DVD_9, ///< L R C Ls Rs
kAudioChannelLayoutTag_DVD_15 = kAudioChannelLayoutTag_DVD_10, ///< L R C LFE
kAudioChannelLayoutTag_DVD_16 = kAudioChannelLayoutTag_DVD_11, ///< L R C LFE Cs
kAudioChannelLayoutTag_DVD_17 = kAudioChannelLayoutTag_DVD_12, ///< L R C LFE Ls Rs
kAudioChannelLayoutTag_DVD_18 = (138U<<16) | 5, ///< L R Ls Rs LFE
kAudioChannelLayoutTag_DVD_19 = kAudioChannelLayoutTag_MPEG_5_0_B, ///< L R Ls Rs C
kAudioChannelLayoutTag_DVD_20 = kAudioChannelLayoutTag_MPEG_5_1_B, ///< L R Ls Rs C LFE
// These layouts are recommended for AudioUnit usage
// These are the symmetrical layouts
kAudioChannelLayoutTag_AudioUnit_4 = kAudioChannelLayoutTag_Quadraphonic,
kAudioChannelLayoutTag_AudioUnit_5 = kAudioChannelLayoutTag_Pentagonal,
kAudioChannelLayoutTag_AudioUnit_6 = kAudioChannelLayoutTag_Hexagonal,
kAudioChannelLayoutTag_AudioUnit_8 = kAudioChannelLayoutTag_Octagonal,
// These are the surround-based layouts
kAudioChannelLayoutTag_AudioUnit_5_0 = kAudioChannelLayoutTag_MPEG_5_0_B, ///< L R Ls Rs C
kAudioChannelLayoutTag_AudioUnit_6_0 = (139U<<16) | 6, ///< L R Ls Rs C Cs
kAudioChannelLayoutTag_AudioUnit_7_0 = (140U<<16) | 7, ///< L R Ls Rs C Rls Rrs
kAudioChannelLayoutTag_AudioUnit_7_0_Front = (148U<<16) | 7, ///< L R Ls Rs C Lc Rc
kAudioChannelLayoutTag_AudioUnit_5_1 = kAudioChannelLayoutTag_MPEG_5_1_A, ///< L R C LFE Ls Rs
kAudioChannelLayoutTag_AudioUnit_6_1 = kAudioChannelLayoutTag_MPEG_6_1_A, ///< L R C LFE Ls Rs Cs
kAudioChannelLayoutTag_AudioUnit_7_1 = kAudioChannelLayoutTag_MPEG_7_1_C, ///< L R C LFE Ls Rs Rls Rrs
kAudioChannelLayoutTag_AudioUnit_7_1_Front = kAudioChannelLayoutTag_MPEG_7_1_A, ///< L R C LFE Ls Rs Lc Rc
kAudioChannelLayoutTag_AAC_3_0 = kAudioChannelLayoutTag_MPEG_3_0_B, ///< C L R
kAudioChannelLayoutTag_AAC_Quadraphonic = kAudioChannelLayoutTag_Quadraphonic, ///< L R Ls Rs
kAudioChannelLayoutTag_AAC_4_0 = kAudioChannelLayoutTag_MPEG_4_0_B, ///< C L R Cs
kAudioChannelLayoutTag_AAC_5_0 = kAudioChannelLayoutTag_MPEG_5_0_D, ///< C L R Ls Rs
kAudioChannelLayoutTag_AAC_5_1 = kAudioChannelLayoutTag_MPEG_5_1_D, ///< C L R Ls Rs Lfe
kAudioChannelLayoutTag_AAC_6_0 = (141U<<16) | 6, ///< C L R Ls Rs Cs
kAudioChannelLayoutTag_AAC_6_1 = (142U<<16) | 7, ///< C L R Ls Rs Cs Lfe
kAudioChannelLayoutTag_AAC_7_0 = (143U<<16) | 7, ///< C L R Ls Rs Rls Rrs
kAudioChannelLayoutTag_AAC_7_1 = kAudioChannelLayoutTag_MPEG_7_1_B, ///< C Lc Rc L R Ls Rs Lfe
kAudioChannelLayoutTag_AAC_7_1_B = (183U<<16) | 8, ///< C L R Ls Rs Rls Rrs LFE
kAudioChannelLayoutTag_AAC_7_1_C = (184U<<16) | 8, ///< C L R Ls Rs LFE Vhl Vhr
kAudioChannelLayoutTag_AAC_Octagonal = (144U<<16) | 8, ///< C L R Ls Rs Rls Rrs Cs
kAudioChannelLayoutTag_TMH_10_2_std = (145U<<16) | 16, ///< L R C Vhc Lsd Rsd Ls Rs Vhl Vhr Lw Rw Csd Cs LFE1 LFE2
kAudioChannelLayoutTag_TMH_10_2_full = (146U<<16) | 21, ///< TMH_10_2_std plus: Lc Rc HI VI Haptic
kAudioChannelLayoutTag_AC3_1_0_1 = (149U<<16) | 2, ///< C LFE
kAudioChannelLayoutTag_AC3_3_0 = (150U<<16) | 3, ///< L C R
kAudioChannelLayoutTag_AC3_3_1 = (151U<<16) | 4, ///< L C R Cs
kAudioChannelLayoutTag_AC3_3_0_1 = (152U<<16) | 4, ///< L C R LFE
kAudioChannelLayoutTag_AC3_2_1_1 = (153U<<16) | 4, ///< L R Cs LFE
kAudioChannelLayoutTag_AC3_3_1_1 = (154U<<16) | 5, ///< L C R Cs LFE
kAudioChannelLayoutTag_EAC_6_0_A = (155U<<16) | 6, ///< L C R Ls Rs Cs
kAudioChannelLayoutTag_EAC_7_0_A = (156U<<16) | 7, ///< L C R Ls Rs Rls Rrs
kAudioChannelLayoutTag_EAC3_6_1_A = (157U<<16) | 7, ///< L C R Ls Rs LFE Cs
kAudioChannelLayoutTag_EAC3_6_1_B = (158U<<16) | 7, ///< L C R Ls Rs LFE Ts
kAudioChannelLayoutTag_EAC3_6_1_C = (159U<<16) | 7, ///< L C R Ls Rs LFE Vhc
kAudioChannelLayoutTag_EAC3_7_1_A = (160U<<16) | 8, ///< L C R Ls Rs LFE Rls Rrs
kAudioChannelLayoutTag_EAC3_7_1_B = (161U<<16) | 8, ///< L C R Ls Rs LFE Lc Rc
kAudioChannelLayoutTag_EAC3_7_1_C = (162U<<16) | 8, ///< L C R Ls Rs LFE Lsd Rsd
kAudioChannelLayoutTag_EAC3_7_1_D = (163U<<16) | 8, ///< L C R Ls Rs LFE Lw Rw
kAudioChannelLayoutTag_EAC3_7_1_E = (164U<<16) | 8, ///< L C R Ls Rs LFE Vhl Vhr
kAudioChannelLayoutTag_EAC3_7_1_F = (165U<<16) | 8, ///< L C R Ls Rs LFE Cs Ts
kAudioChannelLayoutTag_EAC3_7_1_G = (166U<<16) | 8, ///< L C R Ls Rs LFE Cs Vhc
kAudioChannelLayoutTag_EAC3_7_1_H = (167U<<16) | 8, ///< L C R Ls Rs LFE Ts Vhc
kAudioChannelLayoutTag_DTS_3_1 = (168U<<16) | 4, ///< C L R LFE
kAudioChannelLayoutTag_DTS_4_1 = (169U<<16) | 5, ///< C L R Cs LFE
kAudioChannelLayoutTag_DTS_6_0_A = (170U<<16) | 6, ///< Lc Rc L R Ls Rs
kAudioChannelLayoutTag_DTS_6_0_B = (171U<<16) | 6, ///< C L R Rls Rrs Ts
kAudioChannelLayoutTag_DTS_6_0_C = (172U<<16) | 6, ///< C Cs L R Rls Rrs
kAudioChannelLayoutTag_DTS_6_1_A = (173U<<16) | 7, ///< Lc Rc L R Ls Rs LFE
kAudioChannelLayoutTag_DTS_6_1_B = (174U<<16) | 7, ///< C L R Rls Rrs Ts LFE
kAudioChannelLayoutTag_DTS_6_1_C = (175U<<16) | 7, ///< C Cs L R Rls Rrs LFE
kAudioChannelLayoutTag_DTS_7_0 = (176U<<16) | 7, ///< Lc C Rc L R Ls Rs
kAudioChannelLayoutTag_DTS_7_1 = (177U<<16) | 8, ///< Lc C Rc L R Ls Rs LFE
kAudioChannelLayoutTag_DTS_8_0_A = (178U<<16) | 8, ///< Lc Rc L R Ls Rs Rls Rrs
kAudioChannelLayoutTag_DTS_8_0_B = (179U<<16) | 8, ///< Lc C Rc L R Ls Cs Rs
kAudioChannelLayoutTag_DTS_8_1_A = (180U<<16) | 9, ///< Lc Rc L R Ls Rs Rls Rrs LFE
kAudioChannelLayoutTag_DTS_8_1_B = (181U<<16) | 9, ///< Lc C Rc L R Ls Cs Rs LFE
kAudioChannelLayoutTag_DTS_6_1_D = (182U<<16) | 7, ///< C L R Ls Rs LFE Cs
kAudioChannelLayoutTag_WAVE_2_1 = kAudioChannelLayoutTag_DVD_4, ///< 3 channels, L R LFE
kAudioChannelLayoutTag_WAVE_3_0 = kAudioChannelLayoutTag_MPEG_3_0_A, ///< 3 channels, L R C
kAudioChannelLayoutTag_WAVE_4_0_A = kAudioChannelLayoutTag_ITU_2_2, ///< 4 channels, L R Ls Rs
kAudioChannelLayoutTag_WAVE_4_0_B = (185U<<16) | 4, ///< 4 channels, L R Rls Rrs
kAudioChannelLayoutTag_WAVE_5_0_A = kAudioChannelLayoutTag_MPEG_5_0_A, ///< 5 channels, L R C Ls Rs
kAudioChannelLayoutTag_WAVE_5_0_B = (186U<<16) | 5, ///< 5 channels, L R C Rls Rrs
kAudioChannelLayoutTag_WAVE_5_1_A = kAudioChannelLayoutTag_MPEG_5_1_A, ///< 6 channels, L R C LFE Ls Rs
kAudioChannelLayoutTag_WAVE_5_1_B = (187U<<16) | 6, ///< 6 channels, L R C LFE Rls Rrs
kAudioChannelLayoutTag_WAVE_6_1 = (188U<<16) | 7, ///< 7 channels, L R C LFE Cs Ls Rs
kAudioChannelLayoutTag_WAVE_7_1 = (189U<<16) | 8, ///< 8 channels, L R C LFE Rls Rrs Ls Rs
kAudioChannelLayoutTag_HOA_ACN_SN3D = (190U<<16) | 0, ///< Higher Order Ambisonics, Ambisonics Channel Number, SN3D normalization
///< needs to be ORed with the actual number of channels (not the HOA order)
kAudioChannelLayoutTag_HOA_ACN_N3D = (191U<<16) | 0, ///< Higher Order Ambisonics, Ambisonics Channel Number, N3D normalization
///< needs to be ORed with the actual number of channels (not the HOA order)
kAudioChannelLayoutTag_Atmos_5_1_2 = (194U<<16) | 8, ///< L R C LFE Ls Rs Ltm Rtm
kAudioChannelLayoutTag_Atmos_5_1_4 = (195U<<16) | 10, ///< L R C LFE Ls Rs Vhl Vhr Ltr Rtr
kAudioChannelLayoutTag_Atmos_7_1_2 = (196U<<16) | 10, ///< L R C LFE Ls Rs Rls Rrs Ltm Rtm
kAudioChannelLayoutTag_Atmos_7_1_4 = (192U<<16) | 12, ///< L R C LFE Ls Rs Rls Rrs Vhl Vhr Ltr Rtr
kAudioChannelLayoutTag_Atmos_9_1_6 = (193U<<16) | 16, ///< L R C LFE Ls Rs Rls Rrs Lw Rw Vhl Vhr Ltm Rtm Ltr Rtr
kAudioChannelLayoutTag_Logic_Mono = kAudioChannelLayoutTag_Mono, ///< C
kAudioChannelLayoutTag_Logic_Stereo = kAudioChannelLayoutTag_Stereo, ///< L R
kAudioChannelLayoutTag_Logic_Quadraphonic = kAudioChannelLayoutTag_Quadraphonic, ///< L R Ls Rs
kAudioChannelLayoutTag_Logic_4_0_A = kAudioChannelLayoutTag_MPEG_4_0_A, ///< L R C Cs
kAudioChannelLayoutTag_Logic_4_0_B = kAudioChannelLayoutTag_MPEG_4_0_B, ///< C L R Cs
kAudioChannelLayoutTag_Logic_4_0_C = (197U<<16) | 4, ///< L R Cs C
kAudioChannelLayoutTag_Logic_5_0_A = kAudioChannelLayoutTag_MPEG_5_0_A, ///< L R C Ls Rs
kAudioChannelLayoutTag_Logic_5_0_B = kAudioChannelLayoutTag_MPEG_5_0_B, ///< L R Ls Rs C
kAudioChannelLayoutTag_Logic_5_0_C = kAudioChannelLayoutTag_MPEG_5_0_C, ///< L C R Ls Rs
kAudioChannelLayoutTag_Logic_5_0_D = kAudioChannelLayoutTag_MPEG_5_0_D, ///< C L R Ls Rs
kAudioChannelLayoutTag_Logic_5_1_A = kAudioChannelLayoutTag_MPEG_5_1_A, ///< L R C LFE Ls Rs
kAudioChannelLayoutTag_Logic_5_1_B = kAudioChannelLayoutTag_MPEG_5_1_B, ///< L R Ls Rs C LFE
kAudioChannelLayoutTag_Logic_5_1_C = kAudioChannelLayoutTag_MPEG_5_1_C, ///< L C R Ls Rs LFE
kAudioChannelLayoutTag_Logic_5_1_D = kAudioChannelLayoutTag_MPEG_5_1_D, ///< C L R Ls Rs LFE
kAudioChannelLayoutTag_Logic_6_0_A = kAudioChannelLayoutTag_AAC_6_0, ///< C L R Ls Rs Cs
kAudioChannelLayoutTag_Logic_6_0_B = (198U<<16) | 6, ///< L R Ls Rs Cs C
kAudioChannelLayoutTag_Logic_6_0_C = kAudioChannelLayoutTag_AudioUnit_6_0, ///< L R Ls Rs C Cs
kAudioChannelLayoutTag_Logic_6_1_A = kAudioChannelLayoutTag_AAC_6_1, ///< C L R Ls Rs Cs LFE
kAudioChannelLayoutTag_Logic_6_1_B = (199U<<16) | 7, ///< L R Ls Rs Cs C LFE
kAudioChannelLayoutTag_Logic_6_1_C = kAudioChannelLayoutTag_MPEG_6_1_A, ///< L R C LFE Ls Rs Cs
kAudioChannelLayoutTag_Logic_6_1_D = (200U<<16) | 7, ///< L C R Ls Cs Rs LFE
kAudioChannelLayoutTag_Logic_7_1_A = kAudioChannelLayoutTag_AudioUnit_7_1, ///< L R C LFE Ls Rs Rls Rrs
kAudioChannelLayoutTag_Logic_7_1_B = (201U<<16) | 8, ///< L R Ls Rs Rls Rrs C LFE
kAudioChannelLayoutTag_Logic_7_1_C = kAudioChannelLayoutTag_MPEG_7_1_C, ///< L R C LFE Ls Rs Rls Rrs
kAudioChannelLayoutTag_Logic_7_1_SDDS_A = kAudioChannelLayoutTag_MPEG_7_1_A, ///< L R C LFE Ls Rs Lc Rc
kAudioChannelLayoutTag_Logic_7_1_SDDS_B = kAudioChannelLayoutTag_MPEG_7_1_B, ///< C Lc Rc L R Ls Rs LFE
kAudioChannelLayoutTag_Logic_7_1_SDDS_C = kAudioChannelLayoutTag_Emagic_Default_7_1, ///< L R Ls Rs C LFE Lc Rc
kAudioChannelLayoutTag_Logic_Atmos_5_1_2 = kAudioChannelLayoutTag_Atmos_5_1_2, ///< L R C LFE Ls Rs Ltm Rtm
kAudioChannelLayoutTag_Logic_Atmos_5_1_4 = kAudioChannelLayoutTag_Atmos_5_1_4, ///< L R C LFE Ls Rs Vhl Vhr Ltr Rtr
kAudioChannelLayoutTag_Logic_Atmos_7_1_2 = kAudioChannelLayoutTag_Atmos_7_1_2, ///< L R C LFE Ls Rs Rls Rrs Ltm Rtm
kAudioChannelLayoutTag_Logic_Atmos_7_1_4_A = kAudioChannelLayoutTag_Atmos_7_1_4, ///< L R C LFE Ls Rs Rls Rrs Vhl Vhr Ltr Rtr
kAudioChannelLayoutTag_Logic_Atmos_7_1_4_B = (202U<<16) | 12, ///< L R Rls Rrs Ls Rs C LFE Vhl Vhr Ltr Rtr
kAudioChannelLayoutTag_Logic_Atmos_7_1_6 = (203U<<16) | 14, ///< L R Rls Rrs Ls Rs C LFE Vhl Vhr Ltm Rtm Ltr Rtr
kAudioChannelLayoutTag_DiscreteInOrder = (147U<<16) | 0, ///< needs to be ORed with the actual number of channels
kAudioChannelLayoutTag_BeginReserved = 0xF0000000, ///< Channel layout tag values in this range are reserved for internal use
kAudioChannelLayoutTag_EndReserved = 0xFFFEFFFF,
kAudioChannelLayoutTag_Unknown = 0xFFFF0000 ///< needs to be ORed with the actual number of channels
};
/*!
@struct AudioChannelDescription
@abstract This structure describes a single channel.
@var mChannelLabel
The AudioChannelLabel that describes the channel.
@var mChannelFlags
Flags that control the interpretation of mCoordinates.
@var mCoordinates
An ordered triple that specifies a precise speaker location.
*/
struct AudioChannelDescription
{
AudioChannelLabel mChannelLabel;
AudioChannelFlags mChannelFlags;
Float32 mCoordinates[3];
};
typedef struct AudioChannelDescription AudioChannelDescription;
/*!
@struct AudioChannelLayout
@abstract This structure is used to specify channel layouts in files and hardware.
@var mChannelLayoutTag
The AudioChannelLayoutTag that indicates the layout.
@var mChannelBitmap
If mChannelLayoutTag is set to kAudioChannelLayoutTag_UseChannelBitmap, this
field is the channel usage bitmap.
@var mNumberChannelDescriptions
The number of items in the mChannelDescriptions array.
@var mChannelDescriptions
A variable length array of AudioChannelDescriptions that describe the
layout.
*/
struct AudioChannelLayout
{
AudioChannelLayoutTag mChannelLayoutTag;
AudioChannelBitmap mChannelBitmap;
UInt32 mNumberChannelDescriptions;
AudioChannelDescription mChannelDescriptions[1]; // this is a variable length array of mNumberChannelDescriptions elements
#if defined(__cplusplus) && defined(CA_STRICT) && CA_STRICT
public:
AudioChannelLayout() {}
private:
// Copying and assigning a variable length struct is problematic so turn their use into a
// compile time error for easy spotting.
AudioChannelLayout(const AudioChannelLayout&);
AudioChannelLayout& operator=(const AudioChannelLayout&);
#endif
};
typedef struct AudioChannelLayout AudioChannelLayout;
/*!
@function AudioChannelLayoutTag_GetNumberOfChannels
@abstract A macro to get the number of channels out of an AudioChannelLayoutTag
@discussion The low 16 bits of an AudioChannelLayoutTag gives the number of channels except
for kAudioChannelLayoutTag_UseChannelDescriptions and
kAudioChannelLayoutTag_UseChannelBitmap.
@param inLayoutTag
The AudioChannelLayoutTag to examine.
@result The number of channels the tag indicates.
*/
#ifdef CF_INLINE
CF_INLINE UInt32 AudioChannelLayoutTag_GetNumberOfChannels(AudioChannelLayoutTag inLayoutTag) { return (UInt32)(inLayoutTag & 0x0000FFFF); }
#else
#define AudioChannelLayoutTag_GetNumberOfChannels(inLayoutTag) ((UInt32)((inLayoutTag) & 0x0000FFFF))
#endif
/*!
@struct AudioFormatListItem
@abstract this struct is used as output from the kAudioFormatProperty_FormatList property
@var mASBD
an AudioStreamBasicDescription
@var mChannelLayoutTag
an AudioChannelLayoutTag
*/
struct AudioFormatListItem
{
AudioStreamBasicDescription mASBD;
AudioChannelLayoutTag mChannelLayoutTag;
};
typedef struct AudioFormatListItem AudioFormatListItem;
// Deprecated constants
/*! @enum MPEG4ObjectID
@ deprecated in version 10.5
@abstract Constants that describe the various kinds of MPEG-4 audio data.
@discussion These constants are used in the flags field of an AudioStreamBasicDescription
that describes an MPEG-4 audio stream.
*/
typedef CF_ENUM(long, MPEG4ObjectID)
{
kMPEG4Object_AAC_Main = 1,
kMPEG4Object_AAC_LC = 2,
kMPEG4Object_AAC_SSR = 3,
kMPEG4Object_AAC_LTP = 4,
kMPEG4Object_AAC_SBR = 5,
kMPEG4Object_AAC_Scalable = 6,
kMPEG4Object_TwinVQ = 7,
kMPEG4Object_CELP = 8,
kMPEG4Object_HVXC = 9
};
//==================================================================================================
#if defined(__cplusplus)
}
#endif
#pragma clang diagnostic pop
#endif // CoreAudioTypes_CoreAudioBaseTypes_h
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreAudioTypes.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreAudioTypes.framework/Modules/module.modulemap | framework module CoreAudioTypes [system] {
umbrella header "CoreAudioTypes.h"
export *
module * { export * }
}
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework/CoreText.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: C6421DED-14DA-3EF3-810E-C1DE8F742FF6
- target: x86_64-maccatalyst
value: C6421DED-14DA-3EF3-810E-C1DE8F742FF6
- target: arm64-macos
value: 00000000-0000-0000-0000-000000000000
- target: arm64-maccatalyst
value: 00000000-0000-0000-0000-000000000000
- target: arm64e-macos
value: 9A6A89D5-8CE4-32EA-9513-3336E4B7FE94
- target: arm64e-maccatalyst
value: 9A6A89D5-8CE4-32EA-9513-3336E4B7FE94
install-name: '/System/Library/Frameworks/CoreText.framework/Versions/A/CoreText'
exports:
- targets: [ x86_64-macos, arm64e-macos, x86_64-maccatalyst, arm64e-maccatalyst,
arm64-macos, arm64-maccatalyst ]
symbols: [ _CTCopyDescriptionDictionary, _CTFontCollectionCopyAttributes,
_CTFontCollectionCopyExclusionDescriptors, _CTFontCollectionCopyFontAttribute,
_CTFontCollectionCopyFontAttributes, _CTFontCollectionCopyMatchingOptions,
_CTFontCollectionCopyQueryDescriptors, _CTFontCollectionCreateCopyWithFontDescriptors,
_CTFontCollectionCreateForLocale, _CTFontCollectionCreateFromAvailableFonts,
_CTFontCollectionCreateMatchingFontDescriptors, _CTFontCollectionCreateMatchingFontDescriptorsForFamily,
_CTFontCollectionCreateMatchingFontDescriptorsSortedWithCallback,
_CTFontCollectionCreateMatchingFontDescriptorsWithOptions,
_CTFontCollectionCreateMutableCopy, _CTFontCollectionCreateWithFilterCallback,
_CTFontCollectionCreateWithFontDescriptors, _CTFontCollectionGetTypeID,
_CTFontCollectionSetAttributes, _CTFontCollectionSetExclusionDescriptors,
_CTFontCollectionSetMatchingOptions, _CTFontCollectionSetQueryDescriptors,
_CTFontCopyAttribute, _CTFontCopyAvailableTables, _CTFontCopyCharacterSet,
_CTFontCopyCharacterSetOfDefaultCascadeListForSystemUIFonts,
_CTFontCopyConvertedTables, _CTFontCopyDefaultCascadeList,
_CTFontCopyDefaultCascadeListForLanguages, _CTFontCopyDisplayName,
_CTFontCopyExternalFontName, _CTFontCopyFamilyName, _CTFontCopyFeatureSettings,
_CTFontCopyFeatures, _CTFontCopyFeaturesInternal, _CTFontCopyFontDescriptor,
_CTFontCopyFullName, _CTFontCopyGlyphCoverageForFeature, _CTFontCopyGraphicsFont,
_CTFontCopyImageForGlyph, _CTFontCopyLocalizedName, _CTFontCopyLocalizedNameWithLanguages,
_CTFontCopyLogicalCharacterSet, _CTFontCopyName, _CTFontCopyNameForGlyph,
_CTFontCopyOTFontFeatureTable, _CTFontCopyOTName, _CTFontCopyPhysicalFont,
_CTFontCopyPostScriptName, _CTFontCopyQuickdrawInstances,
_CTFontCopySampleString, _CTFontCopySampleStringForLanguage,
_CTFontCopyShapingLanguages, _CTFontCopySupportedLanguages,
_CTFontCopySystemUIFontExcessiveLineHeightCharacterSet, _CTFontCopyTable,
_CTFontCopyTraits, _CTFontCopyVariantsOfGlyph, _CTFontCopyVariation,
_CTFontCopyVariationAxes, _CTFontCreateCopyOfSystemUIFontWithGrade,
_CTFontCreateCopyWithAttributes, _CTFontCreateCopyWithFamily,
_CTFontCreateCopyWithSymbolicTraits, _CTFontCreateEmojiFontForFont,
_CTFontCreateForCharacterRange, _CTFontCreateForCharacters,
_CTFontCreateForCharactersWithLanguage, _CTFontCreateForCharactersWithLanguageAndOption,
_CTFontCreateForString, _CTFontCreateForStringWithLanguage,
_CTFontCreatePathForGlyph, _CTFontCreateUIFontForLanguage,
_CTFontCreateWithFontDescriptor, _CTFontCreateWithFontDescriptorAndOptions,
_CTFontCreateWithFontToken, _CTFontCreateWithGraphicsFont,
_CTFontCreateWithName, _CTFontCreateWithNameAndOptions, _CTFontCreateWithPlatformFont,
_CTFontCreateWithQuickdrawInstance, _CTFontDescriptorCanCreateWithTextStyle,
_CTFontDescriptorCopyAttribute, _CTFontDescriptorCopyAttributes,
_CTFontDescriptorCopyDownloadableFontAttributesForRequests,
_CTFontDescriptorCopyLocalizedAttribute, _CTFontDescriptorCopyName,
_CTFontDescriptorCopyNameForSystemFontOfWeight, _CTFontDescriptorCreateCopyWithAttributes,
_CTFontDescriptorCreateCopyWithFamily, _CTFontDescriptorCreateCopyWithFeature,
_CTFontDescriptorCreateCopyWithSymbolicTraits, _CTFontDescriptorCreateCopyWithVariation,
_CTFontDescriptorCreateForCSSFamily, _CTFontDescriptorCreateForUIType,
_CTFontDescriptorCreateLastResort, _CTFontDescriptorCreateMatchingFontDescriptor,
_CTFontDescriptorCreateMatchingFontDescriptors, _CTFontDescriptorCreateMatchingFontDescriptorsWithOptions,
_CTFontDescriptorCreateWithAttributes, _CTFontDescriptorCreateWithAttributesAndOptions,
_CTFontDescriptorCreateWithNameAndSize, _CTFontDescriptorCreateWithTextStyle,
_CTFontDescriptorCreateWithTextStyleAndAttributes, _CTFontDescriptorDownloadMatchingFontDescriptors,
_CTFontDescriptorGetClientObject, _CTFontDescriptorGetContentSizeCategoryIndex,
_CTFontDescriptorGetDefaultTextStylePlatform, _CTFontDescriptorGetOptions,
_CTFontDescriptorGetSymbolicTraits, _CTFontDescriptorGetTextStyleSize,
_CTFontDescriptorGetTextStyleWithSymbolicTraits, _CTFontDescriptorGetTypeID,
_CTFontDescriptorGetWeight, _CTFontDescriptorHasPostScriptNameAlias,
_CTFontDescriptorIsAppleFont, _CTFontDescriptorIsSystemUIFont,
_CTFontDescriptorIsValid, _CTFontDescriptorIsVisible, _CTFontDescriptorMatchFontDescriptorsWithProgressHandler,
_CTFontDescriptorRequiresFontAssetRequest, _CTFontDescriptorSetClientObject,
_CTFontDescriptorsCopyAttribute, _CTFontDescriptorsCopyAttributes,
_CTFontDescriptorsCopyLocalizedAttribute, _CTFontDrawGlyphs,
_CTFontDrawGlyphsAtPoint, _CTFontDrawGlyphsAtPositions, _CTFontDrawGlyphsWithAdvances,
_CTFontEnumerateOverlappingGlyphs, _CTFontGetAccessibilityBoldWeightOfWeight,
_CTFontGetAdvancesForGlyphs, _CTFontGetAscent, _CTFontGetAscentForSystemFontOfSize,
_CTFontGetBoundingBox, _CTFontGetBoundingRectsForGlyphs, _CTFontGetCapHeight,
_CTFontGetCapHeightForSystemFontOfSize, _CTFontGetClientObject,
_CTFontGetDescent, _CTFontGetDescentForSystemFontOfSize, _CTFontGetExuberatedLineHeightForLineHeight,
_CTFontGetFontToken, _CTFontGetGlyphCount, _CTFontGetGlyphWithName,
_CTFontGetGlyphsAndAdvancesForCharacterRange, _CTFontGetGlyphsForCharacterRange,
_CTFontGetGlyphsForCharacters, _CTFontGetLanguageAwareOutsets,
_CTFontGetLatin1GlyphsAndAdvanceWidths, _CTFontGetLeading,
_CTFontGetLigatureCaretPositions, _CTFontGetMatrix, _CTFontGetMaximumAdvance,
_CTFontGetOpticalBoundsForGlyphs, _CTFontGetPhysicalSymbolicTraits,
_CTFontGetPlatformFont, _CTFontGetSbixImageSizeForGlyph, _CTFontGetSbixImageSizeForGlyphAndContentsScale,
_CTFontGetSize, _CTFontGetSlantAngle, _CTFontGetStringEncoding,
_CTFontGetSymbolicTraits, _CTFontGetTextStyle, _CTFontGetTrackingFloor,
_CTFontGetTransformedAdvancesForGlyphsAndStyle, _CTFontGetTransformedBoundingRectsForGlyphsAndStyle,
_CTFontGetTypeID, _CTFontGetUIFontDesign, _CTFontGetUIFontType,
_CTFontGetUnderlinePosition, _CTFontGetUnderlineThickness,
_CTFontGetUnitsPerEm, _CTFontGetUnsummedAdvancesForGlyphsAndStyle,
_CTFontGetVerticalGlyphsForCharacters, _CTFontGetVerticalTranslationsForGlyphs,
_CTFontGetWeight, _CTFontGetXHeight, _CTFontHasDerivedOpticalSize,
_CTFontHasExuberatedLineHeight, _CTFontHasFeatureSettingWithTypeAndSelector,
_CTFontHasFeatureWithTypeAndSelector, _CTFontHasTable, _CTFontInitializeShapingGlyphs,
_CTFontIsAppleColorEmoji, _CTFontIsExternalFontName, _CTFontIsLastResort,
_CTFontIsSystemUIFont, _CTFontIsTextStyleFont, _CTFontIsVertical,
_CTFontManagerCompareFontDescriptors, _CTFontManagerCompareFontFamilyNames,
_CTFontManagerCopyAvailableFontFamilyNames, _CTFontManagerCopyAvailableFontFamilyNamesForLanguage,
_CTFontManagerCopyAvailableFontURLs, _CTFontManagerCopyAvailablePostScriptNames,
_CTFontManagerCopyRegisteredFontDescriptors, _CTFontManagerCreateFontDescriptorFromData,
_CTFontManagerCreateFontDescriptorsFromData, _CTFontManagerCreateFontDescriptorsFromURL,
_CTFontManagerCreateFontRequestRunLoopSource, _CTFontManagerEnableAllUserFonts,
_CTFontManagerEnableFontDescriptors, _CTFontManagerEnableSystemVisibleFonts,
_CTFontManagerGetAutoActivationSetting, _CTFontManagerGetScopeForURL,
_CTFontManagerInstalledFontsChanged, _CTFontManagerIsSupportedFont,
_CTFontManagerRegisterFontDescriptors, _CTFontManagerRegisterFontForData,
_CTFontManagerRegisterFontURLs, _CTFontManagerRegisterFontsForURL,
_CTFontManagerRegisterFontsForURLs, _CTFontManagerRegisterFontsWithAssetNames,
_CTFontManagerRegisterGraphicsFont, _CTFontManagerRequestFonts,
_CTFontManagerSetAutoActivationSetting, _CTFontManagerSystemVisibleFontsEnabled,
_CTFontManagerUnregisterFontDescriptors, _CTFontManagerUnregisterFontForData,
_CTFontManagerUnregisterFontURLs, _CTFontManagerUnregisterFontsForURL,
_CTFontManagerUnregisterFontsForURLs, _CTFontManagerUnregisterGraphicsFont,
_CTFontManagerValidateFonts, _CTFontRemoveFromCaches, _CTFontSetAltTextStyleSpec,
_CTFontSetClientObject, _CTFontShapeGlyphs, _CTFontShouldAntiAlias,
_CTFontStrikeMetricsCreateDictionaryRepresentation, _CTFontSupportsConnectedLanguage,
_CTFontSwapDefaultLineHeightAdjustment, _CTFontSwapDefaultSize,
_CTFontSwapEmojiPolicy, _CTFontTransformGlyphs, _CTFontTransformGlyphsWithLanguage,
_CTFrameCopyVisibleString, _CTFrameDraw, _CTFrameGetFrameAttributes,
_CTFrameGetLineOrigins, _CTFrameGetLines, _CTFrameGetPath,
_CTFrameGetStringRange, _CTFrameGetTypeID, _CTFrameGetVisibleStringRange,
_CTFramesetterCreateCGRectArray, _CTFramesetterCreateCGRectArrayVertical,
_CTFramesetterCreateFrame, _CTFramesetterCreateWithAttributedString,
_CTFramesetterCreateWithTypesetter, _CTFramesetterCreateWithUniCharProvider,
_CTFramesetterFindRectPosition, _CTFramesetterGetTypeID, _CTFramesetterGetTypesetter,
_CTFramesetterSuggestFrameSizeWithConstraints, _CTGetCoreTextVersion,
_CTGlyphInfoCreateWithCharacterIdentifier, _CTGlyphInfoCreateWithGlyph,
_CTGlyphInfoCreateWithGlyphName, _CTGlyphInfoGetCharacterCollection,
_CTGlyphInfoGetCharacterIdentifier, _CTGlyphInfoGetGlyph,
_CTGlyphInfoGetGlyphName, _CTGlyphInfoGetTypeID, _CTGlyphStorageCreateMutableWithInterface,
_CTGlyphStorageGetInterface, _CTGlyphStorageGetRefCon, _CTGlyphStorageSyncWithInterface,
_CTLineCopyCaretPathForStringIndex, _CTLineCopyHighlightPathForStringRange,
_CTLineCreateFromLineWithOffset, _CTLineCreateHyphenatedLineWithOffset,
_CTLineCreateJustifiedLine, _CTLineCreateJustifiedLineWithOptions,
_CTLineCreateTruncatedLine, _CTLineCreateTruncatedLineWithTokenCallback,
_CTLineCreateTruncatedLineWithTokenHandler, _CTLineCreateWithAttributedString,
_CTLineCreateWithRunArray, _CTLineCreateWithString, _CTLineCreateWithUniCharProvider,
_CTLineDraw, _CTLineDrawAttributedString, _CTLineDrawCharsWithUnicodeProvider,
_CTLineDrawWithAttributeOverrides, _CTLineEnumerateCaretOffsets,
_CTLineGetBoundsWithOptions, _CTLineGetDefaultBounds, _CTLineGetGlyphCount,
_CTLineGetGlyphRuns, _CTLineGetImageBounds, _CTLineGetOffsetForStringIndex,
_CTLineGetPenOffsetForFlush, _CTLineGetStringIndexForPosition,
_CTLineGetStringRange, _CTLineGetTrailingWhitespaceWidth,
_CTLineGetTypeID, _CTLineGetTypographicBounds, _CTLineGetWidthForStringRangeWithOffset,
_CTLineHasBidiLevels, _CTLineIsRightToLeft, _CTLineSuggestClusterBreakWithOffset,
_CTLineSuggestLineBreakWithOffset, _CTLineSyncWithRuns, _CTParagraphStyleCreate,
_CTParagraphStyleCreateCopy, _CTParagraphStyleGetCompositionLanguage,
_CTParagraphStyleGetCompositionLanguageForLanguage, _CTParagraphStyleGetTypeID,
_CTParagraphStyleGetValueForSpecifier, _CTParagraphStyleSetCompositionLanguage,
_CTRubyAnnotationCreate, _CTRubyAnnotationCreateCopy, _CTRubyAnnotationCreateWithAttributedString,
_CTRubyAnnotationCreateWithAttributes, _CTRubyAnnotationGetAlignment,
_CTRubyAnnotationGetOverhang, _CTRubyAnnotationGetSizeFactor,
_CTRubyAnnotationGetTextForPosition, _CTRubyAnnotationGetTypeID,
_CTRunCopyRubyAnnotationLineForPosition, _CTRunCreateMutableRunsWithStorageAndOptions,
_CTRunDelegateCreate, _CTRunDelegateGetRefCon, _CTRunDelegateGetTypeID,
_CTRunDraw, _CTRunGetAdvances, _CTRunGetAdvancesPtr, _CTRunGetAttachmentCounts,
_CTRunGetAttachmentCountsPtr, _CTRunGetAttributes, _CTRunGetBackgroundBounds,
_CTRunGetBaseAdvancesAndOrigins, _CTRunGetFont, _CTRunGetGlyphCount,
_CTRunGetGlyphStorage, _CTRunGetGlyphs, _CTRunGetGlyphsPtr,
_CTRunGetImageBounds, _CTRunGetInitialAdvance, _CTRunGetInitialBaseAdvance,
_CTRunGetMetrics, _CTRunGetPositions, _CTRunGetPositionsPtr,
_CTRunGetPropertiesPtr, _CTRunGetScript, _CTRunGetStatus,
_CTRunGetStretchFactors, _CTRunGetStringIndices, _CTRunGetStringIndicesPtr,
_CTRunGetStringRange, _CTRunGetTextMatrix, _CTRunGetTypeID,
_CTRunGetTypographicBounds, _CTRunSyncWithStorage, _CTSwapLineBreakEpsilon,
_CTTextTabCreate, _CTTextTabGetAlignment, _CTTextTabGetLocation,
_CTTextTabGetOptions, _CTTextTabGetTypeID, _CTTypesetterCreateLine,
_CTTypesetterCreateLineWithOffset, _CTTypesetterCreateWithAttributedString,
_CTTypesetterCreateWithAttributedStringAndOptions, _CTTypesetterCreateWithRunArray,
_CTTypesetterCreateWithRunArrayAndOptions, _CTTypesetterCreateWithUniCharProvider,
_CTTypesetterCreateWithUniCharProviderAndOptions, _CTTypesetterGetTypeID,
_CTTypesetterSuggestClusterBreak, _CTTypesetterSuggestClusterBreakWithOffset,
_CTTypesetterSuggestLineBreak, _CTTypesetterSuggestLineBreakWithOffset,
_CTWriteDescriptionDictionaryToFile, _NSFontCollectionActionKey,
_NSFontCollectionAllFonts, _NSFontCollectionDidChangeNotification,
_NSFontCollectionDisallowAutoActivationOption, _NSFontCollectionFavorites,
_NSFontCollectionIncludeDisabledFontsOption, _NSFontCollectionNameKey,
_NSFontCollectionOldNameKey, _NSFontCollectionRecentlyUsed,
_NSFontCollectionRemoveDuplicatesOption, _NSFontCollectionUser,
_NSFontCollectionVisibilityKey, _NSFontCollectionWasHidden,
_NSFontCollectionWasRenamed, _NSFontCollectionWasShown, __CTClearFontFallbacksCache,
__CTCopyDefaultFontFallbacksDictionary, __CTEnumerateScriptRanges,
__CTFontCopyPredefinedCharacterSet, __CTFontCreateWithNameAndSymbolicTraits,
__CTFontGetBaseFontType, __CTFontManagerDisableSystemVisibleFonts,
__CTFontManagerGetCharacterCoverage, __CTGetCharacterClass,
__CTGetEmojiFontName, __CTGetFrameworkBundleForLocalization,
__CTGetVisibleFormatterCharacterSet, __CTGlyphInfoGetBaseString,
__CTGlyphInfoGetFont, __CTGlyphInfoGetGlyph, __CTSetFrameworkBundleForLocalization,
_kCTBackgroundColorAttributeName, _kCTBaselineAttributeName,
_kCTBaselineClassAttributeName, _kCTBaselineClassHanging,
_kCTBaselineClassICFBottom, _kCTBaselineClassICFTop, _kCTBaselineClassIdeographicCentered,
_kCTBaselineClassIdeographicHigh, _kCTBaselineClassIdeographicLow,
_kCTBaselineClassMath, _kCTBaselineClassRoman, _kCTBaselineInfoAttributeName,
_kCTBaselineOffsetAttributeName, _kCTBaselineOriginalFont,
_kCTBaselineReferenceFont, _kCTBaselineReferenceInfoAttributeName,
_kCTBaselineVerticalOriginalFont, _kCTCharacterShapeAttributeName,
_kCTFallbackWritingDirectionAttributeName, _kCTFontAssetFontInfoKey,
_kCTFontAssetType, _kCTFontAttributeName, _kCTFontBaselineAdjustAttribute,
_kCTFontCSSFamilyCursive, _kCTFontCSSFamilyEmoji, _kCTFontCSSFamilyFangSong,
_kCTFontCSSFamilyFantasy, _kCTFontCSSFamilyMonospace, _kCTFontCSSFamilyMonospaceUI,
_kCTFontCSSFamilyRoundedUI, _kCTFontCSSFamilySansSerif, _kCTFontCSSFamilySerif,
_kCTFontCSSFamilySerifUI, _kCTFontCSSFamilySystemUI, _kCTFontCSSWeightAttribute,
_kCTFontCSSWidthAttribute, _kCTFontCacheGlyphImagesAttribute,
_kCTFontCascadeListAttribute, _kCTFontCharacterSetAttribute,
_kCTFontCodableVariationAttribute, _kCTFontCollectionDisallowAutoActivationOption,
_kCTFontCollectionIncludeDisabledFontsOption, _kCTFontCollectionIncludeInvisibleFontsOption,
_kCTFontCollectionIncludeStubFontsOption, _kCTFontCollectionRemoveDuplicatesOption,
_kCTFontCompatibleFullNameKey, _kCTFontComponentListAttribute,
_kCTFontContentSizeCategoryAccessibilityL, _kCTFontContentSizeCategoryAccessibilityM,
_kCTFontContentSizeCategoryAccessibilityXL, _kCTFontContentSizeCategoryAccessibilityXXL,
_kCTFontContentSizeCategoryAccessibilityXXXL, _kCTFontContentSizeCategoryL,
_kCTFontContentSizeCategoryM, _kCTFontContentSizeCategoryS,
_kCTFontContentSizeCategoryXL, _kCTFontContentSizeCategoryXS,
_kCTFontContentSizeCategoryXXL, _kCTFontContentSizeCategoryXXXL,
_kCTFontCopyrightNameKey, _kCTFontDefaultWeights, _kCTFontDescriptionNameKey,
_kCTFontDescriptorLanguageAttribute, _kCTFontDescriptorMatchingCancelDownloadHandler,
_kCTFontDescriptorMatchingCurrentAssetSize, _kCTFontDescriptorMatchingDescriptors,
_kCTFontDescriptorMatchingError, _kCTFontDescriptorMatchingEstimatedSecondsRemaining,
_kCTFontDescriptorMatchingLocalizedDescription, _kCTFontDescriptorMatchingLocalizedFamilyName,
_kCTFontDescriptorMatchingPercentage, _kCTFontDescriptorMatchingProcessedAssetCount,
_kCTFontDescriptorMatchingResult, _kCTFontDescriptorMatchingSourceDescriptor,
_kCTFontDescriptorMatchingTotalAssetCount, _kCTFontDescriptorMatchingTotalAssetSize,
_kCTFontDescriptorMatchingTotalDownloadedSize, _kCTFontDescriptorTextStyleAttribute,
_kCTFontDescriptorTextStyleBlack, _kCTFontDescriptorTextStyleBlackItalic,
_kCTFontDescriptorTextStyleBold, _kCTFontDescriptorTextStyleBoldItalic,
_kCTFontDescriptorTextStyleEmphasized, _kCTFontDescriptorTextStyleEmphasizedOblique,
_kCTFontDescriptorTextStyleHeavy, _kCTFontDescriptorTextStyleHeavyItalic,
_kCTFontDescriptorTextStyleLight, _kCTFontDescriptorTextStyleLightItalic,
_kCTFontDescriptorTextStyleMedium, _kCTFontDescriptorTextStyleMediumItalic,
_kCTFontDescriptorTextStyleOblique, _kCTFontDescriptorTextStyleRegular,
_kCTFontDescriptorTextStyleSemibold, _kCTFontDescriptorTextStyleSemiboldItalic,
_kCTFontDescriptorTextStyleThin, _kCTFontDescriptorTextStyleThinAlways,
_kCTFontDescriptorTextStyleThinItalic, _kCTFontDescriptorTextStyleUltraLight,
_kCTFontDescriptorTextStyleUltraLightAlways, _kCTFontDescriptorTextStyleUltraLightItalic,
_kCTFontDesignLanguagesAttribute, _kCTFontDesignerNameKey,
_kCTFontDesignerURLNameKey, _kCTFontDisplayNameAttribute,
_kCTFontDownloadableAttribute, _kCTFontDownloadedAttribute,
_kCTFontEnabledAttribute, _kCTFontFallbackOptionAttribute,
_kCTFontFamilyNameAttribute, _kCTFontFamilyNameKey, _kCTFontFeatureSampleTextKey,
_kCTFontFeatureSampleTextNameIDKey, _kCTFontFeatureSelectorDefaultKey,
_kCTFontFeatureSelectorIdentifierKey, _kCTFontFeatureSelectorNameIDKey,
_kCTFontFeatureSelectorNameKey, _kCTFontFeatureSelectorSettingKey,
_kCTFontFeatureSettingsAttribute, _kCTFontFeatureTooltipTextKey,
_kCTFontFeatureTooltipTextNameIDKey, _kCTFontFeatureTypeExclusiveKey,
_kCTFontFeatureTypeIdentifierKey, _kCTFontFeatureTypeNameIDKey,
_kCTFontFeatureTypeNameKey, _kCTFontFeatureTypeSelectorsKey,
_kCTFontFeaturesAttribute, _kCTFontFixedAdvanceAttribute,
_kCTFontFormatAttribute, _kCTFontFullNameKey, _kCTFontGradeTrait,
_kCTFontIgnoreLegibilityWeightAttribute, _kCTFontIgnoreScriptAnalysisAttribute,
_kCTFontLanguageAwareLineHeightRatioAttribute, _kCTFontLanguagesAttribute,
_kCTFontLegibilityWeightAttribute, _kCTFontLicenseNameKey,
_kCTFontLicenseURLNameKey, _kCTFontMacintoshEncodingsAttribute,
_kCTFontManagerAvailableFontURLsAddedKey, _kCTFontManagerAvailableFontURLsRemovedKey,
_kCTFontManagerBundleIdentifier, _kCTFontManagerErrorDomain,
_kCTFontManagerErrorFontAssetNameKey, _kCTFontManagerErrorFontDescriptorsKey,
_kCTFontManagerErrorFontURLsKey, _kCTFontManagerRegisteredFontsChangedNotification,
_kCTFontManufacturerNameKey, _kCTFontMarketingNameKey, _kCTFontMatrixAttribute,
_kCTFontNameAttribute, _kCTFontOpenTypeFeatureTag, _kCTFontOpenTypeFeatureValue,
_kCTFontOpticalPointSizesAttribute, _kCTFontOpticalSizeAttribute,
_kCTFontOrientationAttribute, _kCTFontPaletteAttribute, _kCTFontPaletteColorsAttribute,
_kCTFontPostScriptCIDNameKey, _kCTFontPostScriptNameAttribute,
_kCTFontPostScriptNameKey, _kCTFontPreferredFamilyNameKey,
_kCTFontPreferredSubFamilyNameKey, _kCTFontPriorityAttribute,
_kCTFontQuickdrawEncodingKey, _kCTFontQuickdrawFamilyIdentifierKey,
_kCTFontQuickdrawFamilyNameKey, _kCTFontQuickdrawStyleKey,
_kCTFontReferenceURLAttribute, _kCTFontRegistrationScopeAttribute,
_kCTFontRegistrationUserInfoAttribute, _kCTFontSampleTextNameKey,
_kCTFontSearchDomainAttribute, _kCTFontSizeAttribute, _kCTFontSizeCategoryAttribute,
_kCTFontSlantTrait, _kCTFontStyleNameAttribute, _kCTFontStyleNameKey,
_kCTFontSubFamilyNameKey, _kCTFontSymbolicTrait, _kCTFontSyntheticFamilyNameKey,
_kCTFontSyntheticNameKey, _kCTFontSystemAlternate, _kCTFontSystemAlternateBlack,
_kCTFontSystemAlternateBlackItalic, _kCTFontSystemAlternateBold,
_kCTFontSystemAlternateBoldItalic, _kCTFontSystemAlternateDemi,
_kCTFontSystemAlternateDemiItalic, _kCTFontSystemAlternateHeavy,
_kCTFontSystemAlternateHeavyItalic, _kCTFontSystemAlternateItalic,
_kCTFontSystemAlternateLight, _kCTFontSystemAlternateLightItalic,
_kCTFontSystemAlternateMedium, _kCTFontSystemAlternateMediumItalic,
_kCTFontSystemAlternateThin, _kCTFontSystemAlternateThinItalic,
_kCTFontSystemAlternateUltraLight, _kCTFontSystemAlternateUltraLightItalic,
_kCTFontSystemCondensed, _kCTFontSystemCondensedBlack, _kCTFontSystemCondensedBold,
_kCTFontSystemCondensedDemi, _kCTFontSystemCondensedHeavy,
_kCTFontSystemCondensedLight, _kCTFontSystemCondensedMedium,
_kCTFontSystemCondensedThin, _kCTFontSystemCondensedUltraLight,
_kCTFontTextStylePlatformAttribute, _kCTFontTextStyleTraitsAttribute,
_kCTFontTrackAttribute, _kCTFontTrademarkNameKey, _kCTFontTraitsAttribute,
_kCTFontUIFontDesignAlternate, _kCTFontUIFontDesignCompact,
_kCTFontUIFontDesignCompactRounded, _kCTFontUIFontDesignCompactSoft,
_kCTFontUIFontDesignDefault, _kCTFontUIFontDesignMonospaced,
_kCTFontUIFontDesignRounded, _kCTFontUIFontDesignSerif, _kCTFontUIFontDesignSoft,
_kCTFontUIFontDesignTrait, _kCTFontURLAttribute, _kCTFontUniqueNameKey,
_kCTFontUnscaledTrackingAttribute, _kCTFontUserInstalledAttribute,
_kCTFontValidationActivationInfo, _kCTFontValidationFontMD5,
_kCTFontValidationOptionActivationInfoKeep, _kCTFontValidationOptionDynamicActivationInfo,
_kCTFontValidationOptionDynamicGlyphTests, _kCTFontValidationOptionFontSummaryOnly,
_kCTFontValidationOptionGenerateFontChecksum, _kCTFontValidationOptionIgnoreDumpFiles,
_kCTFontValidationOptionIgnoreErrors, _kCTFontValidationOptionRulesList,
_kCTFontValidationOptionRunDynamic, _kCTFontValidationOptionSkipDuplicateFontCheck,
_kCTFontValidationOverallResult, _kCTFontValidationPostScriptName,
_kCTFontValidationResults, _kCTFontValidationRuleAuthor, _kCTFontValidationRuleComponents,
_kCTFontValidationRuleCoverage, _kCTFontValidationRuleDescription,
_kCTFontValidationRuleFormat, _kCTFontValidationRuleName,
_kCTFontValidationRulePriority, _kCTFontValidationRuleResult,
_kCTFontValidationRuleSeverity, _kCTFontValidationRuleVersion,
_kCTFontValidationTestsFailed, _kCTFontValidationTestsPassed,
_kCTFontValidationTestsRun, _kCTFontValidationTestsWarned,
_kCTFontVariationAttribute, _kCTFontVariationAxesAttribute,
_kCTFontVariationAxisDefaultValueKey, _kCTFontVariationAxisHiddenKey,
_kCTFontVariationAxisIdentifierKey, _kCTFontVariationAxisMaximumValueKey,
_kCTFontVariationAxisMinimumValueKey, _kCTFontVariationAxisNameKey,
_kCTFontVendorURLNameKey, _kCTFontVersionNameKey, _kCTFontWeightBlack,
_kCTFontWeightBold, _kCTFontWeightHeavy, _kCTFontWeightLight,
_kCTFontWeightMedium, _kCTFontWeightRegular, _kCTFontWeightSemibold,
_kCTFontWeightThin, _kCTFontWeightTrait, _kCTFontWeightUltraLight,
_kCTFontWidthCompressed, _kCTFontWidthCondensed, _kCTFontWidthExpanded,
_kCTFontWidthExtraCompressed, _kCTFontWidthExtraCondensed,
_kCTFontWidthExtraExpanded, _kCTFontWidthSemiCondensed, _kCTFontWidthSemiExpanded,
_kCTFontWidthStandard, _kCTFontWidthTrait, _kCTFontWidthUltraCompressed,
_kCTFontWildcardNameMatchAttribute, _kCTFontWildcardNameMatchKeyName,
_kCTFontWildcardNameMatchKeyString, _kCTFontWildcardNameMatchKeyType,
_kCTForegroundColorAttributeName, _kCTForegroundColorFromContextAttributeName,
_kCTFrameClippingPathsAttributeName, _kCTFrameForceNonRectPathAttributeName,
_kCTFrameHangingDescendersAttributeName, _kCTFrameHangingLeadingAttributeName,
_kCTFrameIntegerLineMetricsAttributeName, _kCTFrameMaximumNumberOfLinesAttributeName,
_kCTFramePathClippingPathAttributeName, _kCTFramePathFillRuleAttributeName,
_kCTFramePathWidthAttributeName, _kCTFrameProgressionAttributeName,
_kCTGlyphInfoAttributeName, _kCTHorizontalInVerticalFormsAttributeName,
_kCTImposedGlyphAttributeName, _kCTIntegerMetricsAttributeName,
_kCTKernAttributeName, _kCTLanguageAttributeName, _kCTLigatureAttributeName,
_kCTParagraphStyleAttributeName, _kCTRenderingStyleAttributeName,
_kCTRubyAnnotationAttributeName, _kCTRubyAnnotationDrawBaseTextAttributeName,
_kCTRubyAnnotationScaleToFitAttributeName, _kCTRubyAnnotationSizeFactorAttributeName,
_kCTRunDelegateAttributeName, _kCTStrikethroughColorAttributeName,
_kCTStrikethroughStyleAttributeName, _kCTStrokeColorAttributeName,
_kCTStrokeWidthAttributeName, _kCTSuperscriptAttributeName,
_kCTTabColumnTerminatorsAttributeName, _kCTTextEffectsContextAttributeName,
_kCTTrackingAttributeName, _kCTTrimWhitespaceBackgroundAttributeName,
_kCTTypesetterOptionAllowUnboundedLayout, _kCTTypesetterOptionDisableBidiProcessing,
_kCTTypesetterOptionForcedEmbeddingLevel, _kCTTypesetterOptionVerticalLayout,
_kCTUIFontTextStyleBody, _kCTUIFontTextStyleCallout, _kCTUIFontTextStyleCaption1,
_kCTUIFontTextStyleCaption2, _kCTUIFontTextStyleEmphasizedBody,
_kCTUIFontTextStyleFootnote, _kCTUIFontTextStyleFootnote1,
_kCTUIFontTextStyleFootnote2, _kCTUIFontTextStyleHeadline,
_kCTUIFontTextStyleHeadline1, _kCTUIFontTextStyleHeadline2,
_kCTUIFontTextStyleHeadline3, _kCTUIFontTextStyleItalicBody,
_kCTUIFontTextStyleSection1, _kCTUIFontTextStyleSection2,
_kCTUIFontTextStyleSection3, _kCTUIFontTextStyleShortBody,
_kCTUIFontTextStyleShortCaption1, _kCTUIFontTextStyleShortFootnote,
_kCTUIFontTextStyleShortHeadline, _kCTUIFontTextStyleShortSubhead,
_kCTUIFontTextStyleSubhead, _kCTUIFontTextStyleSubhead1, _kCTUIFontTextStyleSubhead2,
_kCTUIFontTextStyleSubtitle1, _kCTUIFontTextStyleSubtitle2,
_kCTUIFontTextStyleSubtitle3, _kCTUIFontTextStyleTallBody,
_kCTUIFontTextStyleTitle0, _kCTUIFontTextStyleTitle1, _kCTUIFontTextStyleTitle2,
_kCTUIFontTextStyleTitle3, _kCTUIFontTextStyleTitle4, _kCTUnderlineColorAttributeName,
_kCTUnderlineStyleAttributeName, _kCTVerticalFormsAttributeName,
_kCTWritingDirectionAttributeName, _kFOComponentsKey, _kFOFontMetricsKey,
_kFOFontNameKey, _kFOFontNamesArrayKey, _kFOFontVersionKey,
_kFOGlyphHAdvancesOverrideKey, _kFOGlyphHAdvancesPerAltFontKey,
_kFOLanguageKey, _kFOMatrixKey, _kFOStringKey, _kFOTypeKey,
_kFOUnicodeCharSetKey, _kFOUnicodeRangeKey, _kFOcmapOverrideKey ]
objc-classes: [ CTGlyphStorageInterface, NSFontCollection, NSMutableFontCollection ]
objc-ivars: [ CTGlyphStorageInterface._absorbedCounts, CTGlyphStorageInterface._advances,
CTGlyphStorageInterface._glyphCount, CTGlyphStorageInterface._glyphs,
CTGlyphStorageInterface._origins, CTGlyphStorageInterface._props,
CTGlyphStorageInterface._stringIndexes ]
- targets: [ x86_64-macos, arm64e-macos, arm64-macos ]
symbols: [ '$ld$install_name$os10.5$/System/Library/Frameworks/ApplicationServices.framework/Versions/A/ApplicationServices',
'$ld$install_name$os10.6$/System/Library/Frameworks/ApplicationServices.framework/Versions/A/ApplicationServices',
'$ld$install_name$os10.7$/System/Library/Frameworks/ApplicationServices.framework/Versions/A/ApplicationServices',
__CTFontManagerUnregisterFontForData ]
...
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework/Headers/SFNTTypes.h | /*
* SFNTTypes.h
* CoreText
*
* Copyright 1994-2021 Apple Inc. All rights reserved.
*
*/
#ifndef __SFNTTYPES__
#define __SFNTTYPES__
#include <TargetConditionals.h>
#if !TARGET_OS_WIN32
#include <MacTypes.h>
#elif !defined(__MACTYPES__)
typedef SInt32 Fixed;
#endif
#ifdef __cplusplus
extern "C" {
#endif
#pragma pack(push, 2)
struct sfntDirectoryEntry {
FourCharCode tableTag;
UInt32 checkSum;
UInt32 offset;
UInt32 length;
};
typedef struct sfntDirectoryEntry sfntDirectoryEntry;
/* The search fields limits numOffsets to 4096. */
struct sfntDirectory {
FourCharCode format;
UInt16 numOffsets; /* number of tables */
UInt16 searchRange; /* (max2 <= numOffsets)*16 */
UInt16 entrySelector; /* log2(max2 <= numOffsets) */
UInt16 rangeShift; /* numOffsets*16-searchRange*/
sfntDirectoryEntry table[1]; /* table[numOffsets] */
};
typedef struct sfntDirectory sfntDirectory;
enum {
sizeof_sfntDirectory = 12
};
/* Cmap - character id to glyph id mapping */
enum {
cmapFontTableTag = 0x636D6170 /* 'cmap' */
};
enum {
kFontUnicodePlatform = 0,
kFontMacintoshPlatform = 1,
kFontReservedPlatform = 2,
kFontMicrosoftPlatform = 3,
kFontCustomPlatform = 4
};
enum {
kFontUnicodeDefaultSemantics = 0,
kFontUnicodeV1_1Semantics = 1,
kFontISO10646_1993Semantics = 2,
kFontUnicodeV2_0BMPOnlySemantics = 3,
kFontUnicodeV2_0FullCoverageSemantics = 4,
kFontUnicodeV4_0VariationSequenceSemantics = 5,
kFontUnicode_FullRepertoire = 6
};
enum {
kFontRomanScript = 0,
kFontJapaneseScript = 1,
kFontTraditionalChineseScript = 2,
kFontChineseScript = kFontTraditionalChineseScript,
kFontKoreanScript = 3,
kFontArabicScript = 4,
kFontHebrewScript = 5,
kFontGreekScript = 6,
kFontCyrillicScript = 7,
kFontRussian = kFontCyrillicScript,
kFontRSymbolScript = 8,
kFontDevanagariScript = 9,
kFontGurmukhiScript = 10,
kFontGujaratiScript = 11,
kFontOriyaScript = 12,
kFontBengaliScript = 13,
kFontTamilScript = 14,
kFontTeluguScript = 15,
kFontKannadaScript = 16,
kFontMalayalamScript = 17,
kFontSinhaleseScript = 18,
kFontBurmeseScript = 19,
kFontKhmerScript = 20,
kFontThaiScript = 21,
kFontLaotianScript = 22,
kFontGeorgianScript = 23,
kFontArmenianScript = 24,
kFontSimpleChineseScript = 25,
kFontTibetanScript = 26,
kFontMongolianScript = 27,
kFontGeezScript = 28,
kFontEthiopicScript = kFontGeezScript,
kFontAmharicScript = kFontGeezScript,
kFontSlavicScript = 29,
kFontEastEuropeanRomanScript = kFontSlavicScript,
kFontVietnameseScript = 30,
kFontExtendedArabicScript = 31,
kFontSindhiScript = kFontExtendedArabicScript,
kFontUninterpretedScript = 32
};
enum {
kFontMicrosoftSymbolScript = 0,
kFontMicrosoftStandardScript = 1,
kFontMicrosoftUCS4Script = 10
};
enum {
kFontCustom8BitScript = 0,
kFontCustom816BitScript = 1,
kFontCustom16BitScript = 2
};
/* Language codes are zero based everywhere but within a 'cmap' table */
enum {
kFontEnglishLanguage = 0,
kFontFrenchLanguage = 1,
kFontGermanLanguage = 2,
kFontItalianLanguage = 3,
kFontDutchLanguage = 4,
kFontSwedishLanguage = 5,
kFontSpanishLanguage = 6,
kFontDanishLanguage = 7,
kFontPortugueseLanguage = 8,
kFontNorwegianLanguage = 9,
kFontHebrewLanguage = 10,
kFontJapaneseLanguage = 11,
kFontArabicLanguage = 12,
kFontFinnishLanguage = 13,
kFontGreekLanguage = 14,
kFontIcelandicLanguage = 15,
kFontMalteseLanguage = 16,
kFontTurkishLanguage = 17,
kFontCroatianLanguage = 18,
kFontTradChineseLanguage = 19,
kFontUrduLanguage = 20,
kFontHindiLanguage = 21,
kFontThaiLanguage = 22,
kFontKoreanLanguage = 23,
kFontLithuanianLanguage = 24,
kFontPolishLanguage = 25,
kFontHungarianLanguage = 26,
kFontEstonianLanguage = 27,
kFontLettishLanguage = 28,
kFontLatvianLanguage = kFontLettishLanguage,
kFontSaamiskLanguage = 29,
kFontLappishLanguage = kFontSaamiskLanguage,
kFontFaeroeseLanguage = 30,
kFontFarsiLanguage = 31,
kFontPersianLanguage = kFontFarsiLanguage,
kFontRussianLanguage = 32,
kFontSimpChineseLanguage = 33,
kFontFlemishLanguage = 34,
kFontIrishLanguage = 35,
kFontAlbanianLanguage = 36,
kFontRomanianLanguage = 37,
kFontCzechLanguage = 38,
kFontSlovakLanguage = 39,
kFontSlovenianLanguage = 40,
kFontYiddishLanguage = 41,
kFontSerbianLanguage = 42,
kFontMacedonianLanguage = 43,
kFontBulgarianLanguage = 44,
kFontUkrainianLanguage = 45,
kFontByelorussianLanguage = 46,
kFontUzbekLanguage = 47,
kFontKazakhLanguage = 48,
kFontAzerbaijaniLanguage = 49,
kFontAzerbaijanArLanguage = 50,
kFontArmenianLanguage = 51,
kFontGeorgianLanguage = 52,
kFontMoldavianLanguage = 53,
kFontKirghizLanguage = 54,
kFontTajikiLanguage = 55,
kFontTurkmenLanguage = 56,
kFontMongolianLanguage = 57,
kFontMongolianCyrLanguage = 58,
kFontPashtoLanguage = 59,
kFontKurdishLanguage = 60,
kFontKashmiriLanguage = 61,
kFontSindhiLanguage = 62,
kFontTibetanLanguage = 63,
kFontNepaliLanguage = 64,
kFontSanskritLanguage = 65,
kFontMarathiLanguage = 66,
kFontBengaliLanguage = 67,
kFontAssameseLanguage = 68,
kFontGujaratiLanguage = 69,
kFontPunjabiLanguage = 70,
kFontOriyaLanguage = 71,
kFontMalayalamLanguage = 72,
kFontKannadaLanguage = 73,
kFontTamilLanguage = 74,
kFontTeluguLanguage = 75,
kFontSinhaleseLanguage = 76,
kFontBurmeseLanguage = 77,
kFontKhmerLanguage = 78,
kFontLaoLanguage = 79,
kFontVietnameseLanguage = 80,
kFontIndonesianLanguage = 81,
kFontTagalogLanguage = 82,
kFontMalayRomanLanguage = 83,
kFontMalayArabicLanguage = 84,
kFontAmharicLanguage = 85,
kFontTigrinyaLanguage = 86,
kFontGallaLanguage = 87,
kFontOromoLanguage = kFontGallaLanguage,
kFontSomaliLanguage = 88,
kFontSwahiliLanguage = 89,
kFontRuandaLanguage = 90,
kFontRundiLanguage = 91,
kFontChewaLanguage = 92,
kFontMalagasyLanguage = 93,
kFontEsperantoLanguage = 94,
kFontWelshLanguage = 128,
kFontBasqueLanguage = 129,
kFontCatalanLanguage = 130,
kFontLatinLanguage = 131,
kFontQuechuaLanguage = 132,
kFontGuaraniLanguage = 133,
kFontAymaraLanguage = 134,
kFontTatarLanguage = 135,
kFontUighurLanguage = 136,
kFontDzongkhaLanguage = 137,
kFontJavaneseRomLanguage = 138,
kFontSundaneseRomLanguage = 139
};
/* The following are special "don't care" values to be used in interfaces */
enum {
kFontNoPlatformCode = (unsigned int)(~0),
kFontNoScriptCode = (unsigned int)(~0),
kFontNoLanguageCode = (unsigned int)(~0)
};
struct sfntCMapSubHeader {
UInt16 format;
UInt16 length;
UInt16 languageID; /* base-1 */
};
typedef struct sfntCMapSubHeader sfntCMapSubHeader;
enum {
sizeof_sfntCMapSubHeader = 6
};
struct sfntCMapExtendedSubHeader {
UInt16 format;
UInt16 reserved;
UInt32 length;
UInt32 language;
};
typedef struct sfntCMapExtendedSubHeader sfntCMapExtendedSubHeader;
enum {
sizeof_sfntCMapExtendedSubHeader = 12
};
struct sfntCMapEncoding {
UInt16 platformID; /* base-0 */
UInt16 scriptID; /* base-0 */
UInt32 offset;
};
typedef struct sfntCMapEncoding sfntCMapEncoding;
enum {
sizeof_sfntCMapEncoding = 8
};
struct sfntCMapHeader {
UInt16 version;
UInt16 numTables;
sfntCMapEncoding encoding[1];
};
typedef struct sfntCMapHeader sfntCMapHeader;
enum {
sizeof_sfntCMapHeader = 4
};
/* Name table */
enum {
nameFontTableTag = 0x6E616D65 /* 'name' */
};
enum {
kFontCopyrightName = 0,
kFontFamilyName = 1,
kFontStyleName = 2,
kFontUniqueName = 3,
kFontFullName = 4,
kFontVersionName = 5,
kFontPostscriptName = 6,
kFontTrademarkName = 7,
kFontManufacturerName = 8,
kFontDesignerName = 9,
kFontDescriptionName = 10,
kFontVendorURLName = 11,
kFontDesignerURLName = 12,
kFontLicenseDescriptionName = 13,
kFontLicenseInfoURLName = 14,
kFontPreferredFamilyName = 16,
kFontPreferredSubfamilyName = 17,
kFontMacCompatibleFullName = 18,
kFontSampleTextName = 19,
kFontPostScriptCIDName = 20,
kFontLastReservedName = 255
};
/* The following is a special "don't care" value to be used in interfaces */
enum {
kFontNoNameCode = (unsigned int)(~0)
};
struct sfntNameRecord {
UInt16 platformID; /* base-0 */
UInt16 scriptID; /* base-0 */
UInt16 languageID; /* base-0 */
UInt16 nameID; /* base-0 */
UInt16 length;
UInt16 offset;
};
typedef struct sfntNameRecord sfntNameRecord;
enum {
sizeof_sfntNameRecord = 12
};
struct sfntNameHeader {
UInt16 format;
UInt16 count;
UInt16 stringOffset;
sfntNameRecord rec[1];
};
typedef struct sfntNameHeader sfntNameHeader;
enum {
sizeof_sfntNameHeader = 6
};
/* Fvar table - font variations */
enum {
variationFontTableTag = 0x66766172 /* 'fvar' */
};
/* These define each font variation */
struct sfntVariationAxis {
FourCharCode axisTag;
Fixed minValue;
Fixed defaultValue;
Fixed maxValue;
SInt16 flags;
SInt16 nameID;
};
typedef struct sfntVariationAxis sfntVariationAxis;
enum {
sizeof_sfntVariationAxis = 20
};
/* These are named locations in style-space for the user */
struct sfntInstance {
SInt16 nameID;
SInt16 flags;
Fixed coord[1]; /* [axisCount] */
/* room to grow since the header carries a tupleSize field */
};
typedef struct sfntInstance sfntInstance;
enum {
sizeof_sfntInstance = 4
};
struct sfntVariationHeader {
Fixed version; /* 1.0 Fixed */
UInt16 offsetToData; /* to first axis = 16*/
UInt16 countSizePairs; /* axis+inst = 2 */
UInt16 axisCount;
UInt16 axisSize;
UInt16 instanceCount;
UInt16 instanceSize;
/* …other <count,size> pairs */
sfntVariationAxis axis[1]; /* [axisCount] */
sfntInstance instance[1]; /* [instanceCount] …other arrays of data */
};
typedef struct sfntVariationHeader sfntVariationHeader;
enum {
sizeof_sfntVariationHeader = 16
};
/* Fdsc table - font descriptor */
enum {
descriptorFontTableTag = 0x66647363 /* 'fdsc' */
};
struct sfntFontDescriptor {
FourCharCode name;
Fixed value;
};
typedef struct sfntFontDescriptor sfntFontDescriptor;
struct sfntDescriptorHeader {
Fixed version; /* 1.0 in Fixed */
SInt32 descriptorCount;
sfntFontDescriptor descriptor[1];
};
typedef struct sfntDescriptorHeader sfntDescriptorHeader;
enum {
sizeof_sfntDescriptorHeader = 8
};
/* Feat Table - layout feature table */
enum {
featureFontTableTag = 0x66656174 /* 'feat' */
};
struct sfntFeatureName {
UInt16 featureType;
UInt16 settingCount;
SInt32 offsetToSettings;
UInt16 featureFlags;
SInt16 nameID;
};
typedef struct sfntFeatureName sfntFeatureName;
struct sfntFontFeatureSetting {
UInt16 setting;
SInt16 nameID;
};
typedef struct sfntFontFeatureSetting sfntFontFeatureSetting;
struct sfntFontRunFeature {
UInt16 featureType;
UInt16 setting;
};
typedef struct sfntFontRunFeature sfntFontRunFeature;
struct sfntFeatureHeader {
SInt32 version; /* 1.0 */
UInt16 featureNameCount;
UInt16 featureSetCount;
SInt32 reserved; /* set to 0 */
sfntFeatureName names[1];
sfntFontFeatureSetting settings[1];
sfntFontRunFeature runs[1];
};
typedef struct sfntFeatureHeader sfntFeatureHeader;
/* OS/2 Table */
enum {
os2FontTableTag = 0x4F532F32 /* 'OS/2' */
};
/* Special invalid glyph ID value, useful as a sentinel value, for example */
enum {
nonGlyphID = 65535
};
/* Data type used to access names from font name table */
typedef UInt32 FontNameCode;
/* Data types for encoding components as used in interfaces */
typedef UInt32 FontPlatformCode;
typedef UInt32 FontScriptCode;
typedef UInt32 FontLanguageCode;
/*
** FontVariation is used to specify a coordinate along a variation axis. The name
** identifies the axes to be applied, and value is the setting to be used.
*/
struct FontVariation {
FourCharCode name;
Fixed value;
};
typedef struct FontVariation FontVariation;
#pragma pack(pop)
#ifdef __cplusplus
}
#endif
#endif // __SFNTTYPES__
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework/Headers/CTRubyAnnotation.h | /*
* CTRubyAnnotation.h
* CoreText
*
* Copyright (c) 2012-2018 Apple Inc. All rights reserved.
*
*/
/*!
@header
Thread Safety Information
All functions in this header are thread safe unless otherwise specified.
*/
#ifndef __CTRUBYANNOTATION__
#define __CTRUBYANNOTATION__
#include <CoreText/CTDefines.h>
#include <CoreFoundation/CoreFoundation.h>
#include <CoreGraphics/CoreGraphics.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
CF_ASSUME_NONNULL_BEGIN
/* --------------------------------------------------------------------------- */
/* RubyAnnotation Types */
/* --------------------------------------------------------------------------- */
typedef const struct CF_BRIDGED_TYPE(id) __CTRubyAnnotation * CTRubyAnnotationRef;
/*!
@function CTRubyAnnotationGetTypeID
@abstract Returns the CFType of the ruby annotation object
*/
CFTypeID CTRubyAnnotationGetTypeID( void ) CT_AVAILABLE(macos(10.10), ios(8.0), watchos(2.0), tvos(9.0));
/* --------------------------------------------------------------------------- */
/* Ruby alignment Values */
/* --------------------------------------------------------------------------- */
/*!
@enum CTRubyAlignment
@abstract These constants specify how to align the ruby annotation and the base text relative to each other when they don't have the same length.
@constant kCTRubyAlignmentAuto
CoreText will determine the alignment.
@constant kCTRubyAlignmentStart
The ruby text is aligned with the start edge of the base text.
@constant kCTRubyAlignmentCenter
The ruby text is centered within the width of the base text. If the ruby text is wider than the base text the base text is centered in the width of the ruby text.
@constant kCTRubyAlignmentEnd
The ruby text is aligned with the end edge of the base text.
@constant kCTRubyAlignmentDistributeLetter
If the width of the ruby text is less than the width of the base text, the ruby text is evenly distributed over the width of the base text, with the first letter of the ruby text aligning with the first letter of the base text and the last letter of the ruby text aligning with the last letter of the base text. If the width of the base text is less than the width of the ruby text, the base text is evenly distributed over the width of the ruby text.
@constant kCTRubyAlignmentDistributeSpace
If the width of the ruby text is less than the width of the base text, the ruby text is evenly distributed over the width of the base text, with a certain amount of space, usually half the inter-character width of the ruby text, before the first and after the last character. If the width of the base text is less than the width of the ruby text, the base text is similarly aligned to the width of the ruby text.
@constant kCTRubyAlignmentLineEdge
If the ruby text is not adjacent to a line edge it is aligned as with kCTRubyAlignmentAuto. If it is adjacent to a line edge the end of ruby text adjacent to the line edge is aligned to the line edge. This is only relevant if the width of the ruby text is greater than the width of the base text; otherwise alignment is as with kCTRubyAlignmentAuto.
*/
typedef CF_ENUM(uint8_t, CTRubyAlignment) {
kCTRubyAlignmentInvalid = (uint8_t)-1,
kCTRubyAlignmentAuto = 0,
kCTRubyAlignmentStart = 1,
kCTRubyAlignmentCenter = 2,
kCTRubyAlignmentEnd = 3,
kCTRubyAlignmentDistributeLetter = 4,
kCTRubyAlignmentDistributeSpace = 5,
kCTRubyAlignmentLineEdge = 6
} CT_AVAILABLE(macos(10.10), ios(8.0), watchos(2.0), tvos(9.0));
/* --------------------------------------------------------------------------- */
/* Ruby overhang Values */
/* --------------------------------------------------------------------------- */
/*!
@enum CTRubyOverhang
@abstract These constants specify whether, and on which side, ruby text is allowed to overhang adjacent text if it is wider than the base text.
@constant kCTRubyOverhangAuto
The ruby text can overhang adjacent text on both sides.
@constant kCTRubyOverhangStart
The ruby text can overhang the text that proceeds it.
@constant kCTRubyOverhangEnd
The ruby text can overhang the text that follows it.
@constant kCTRubyOverhangNone
The ruby text cannot overhang the proceeding or following text.
*/
typedef CF_ENUM(uint8_t, CTRubyOverhang) {
kCTRubyOverhangInvalid = (uint8_t)-1,
kCTRubyOverhangAuto = 0,
kCTRubyOverhangStart = 1,
kCTRubyOverhangEnd = 2,
kCTRubyOverhangNone = 3
} CT_AVAILABLE(macos(10.10), ios(8.0), watchos(2.0), tvos(9.0));
/* --------------------------------------------------------------------------- */
/* Ruby position Values */
/* --------------------------------------------------------------------------- */
/*!
@enum CTRubyPosition
@abstract These constants specify the position of the ruby text with respect to the base text.
@constant kCTRubyPositionBefore
The ruby text is positioned before the base text; i.e. above horizontal text and to the right of vertical text.
@constant kCTRubyPositionAfter
The ruby text is positioned after the base text; i.e. below horizontal text and to the left of vertical text.
@constant kCTRubyPositionInterCharacter
The ruby text is positioned to the right of the base text whether it is horizontal or vertical. This is the way that Bopomofo annotations are attached to Chinese text in Taiwan.
@constant kCTRubyPositionInline
The ruby text follows the base text with no special styling.
*/
typedef CF_ENUM(uint8_t, CTRubyPosition) {
kCTRubyPositionBefore = 0,
kCTRubyPositionAfter = 1,
kCTRubyPositionInterCharacter = 2,
kCTRubyPositionInline = 3,
kCTRubyPositionCount
} CT_AVAILABLE(macos(10.10), ios(8.0), watchos(2.0), tvos(9.0));
/* --------------------------------------------------------------------------- */
/* Ruby Annotation Creation */
/* --------------------------------------------------------------------------- */
/*!
@function CTRubyAnnotationCreate
@abstract Creates an immutable ruby annotation object.
@discussion Using this function is the easiest and most efficient way to
create a ruby annotation object.
@param alignment
Specifies how the ruby text and the base text should be aligned relative to each other.
@param overhang
Specifies how the ruby text can overhang adjacent characters.
@param sizeFactor
Specifies the size of the annotation text as a percent of the size of the base text.
@param text
An array of CFStringRef, indexed by CTRubyPosition. Supply NULL for any unused positions.
@result This function will return a reference to a CTRubyAnnotation object.
*/
CTRubyAnnotationRef CTRubyAnnotationCreate(
CTRubyAlignment alignment,
CTRubyOverhang overhang,
CGFloat sizeFactor,
CFStringRef _Nullable text[_Nonnull kCTRubyPositionCount] ) CT_AVAILABLE(macos(10.10), ios(8.0), watchos(2.0), tvos(9.0));
/*!
@const kCTRubyAnnotationSizeFactorAttributeName
@abstract Specifies the size of the annotation text as a percent of the size of the base text.
@discussion Value must be a CFNumberRef.
*/
CT_EXPORT const CFStringRef kCTRubyAnnotationSizeFactorAttributeName CT_AVAILABLE(macos(10.12), ios(10.0), watchos(3.0), tvos(10.0));
/*!
@const kCTRubyAnnotationScaleToFitAttributeName
@abstract Treat the size specified in kCTRubyAnnotationSizeFactorAttributeName as the maximum
scale factor, when the base text size is smaller than annotation text size, we will
try to scale the annotation font size down so that it will fit the base text without
overhang or adding extra padding between base text.
@discussion Value must be a CFBooleanRef. Default is false.
*/
CT_EXPORT const CFStringRef kCTRubyAnnotationScaleToFitAttributeName CT_AVAILABLE(macos(10.12), ios(10.0), watchos(3.0), tvos(10.0));
/*!
@function CTRubyAnnotationCreateWithAttributes
@abstract Creates an immutable ruby annotation object.
@discussion Using this function to create a ruby annotation object with more precise
control of the annotation text.
@param alignment
Specifies how the ruby text and the base text should be aligned relative to each other.
@param overhang
Specifies how the ruby text can overhang adjacent characters.
@param position
The position of the annotation text.
@param string
A string without any formatting, its format will be derived from the attrs specified below.
@param attributes
A attribute dictionary to combine with the string specified above. If you don't specify
kCTFontAttributeName, the font used by the Ruby annotation will be deduced from the base
text, with a size factor specified by a CFNumberRef value keyed by
kCTRubyAnnotationSizeFactorAttributeName.
@result This function will return a reference to a CTRubyAnnotation object.
*/
CTRubyAnnotationRef CTRubyAnnotationCreateWithAttributes(
CTRubyAlignment alignment,
CTRubyOverhang overhang,
CTRubyPosition position,
CFStringRef string,
CFDictionaryRef attributes ) CT_AVAILABLE(macos(10.12), ios(10.0), watchos(3.0), tvos(10.0));
/*!
@function CTRubyAnnotationCreateCopy
@abstract Creates an immutable copy of a ruby annotation object.
@param rubyAnnotation
The ruby annotation that you wish to copy.
@result If the "rubyAnnotation" reference is valid, then this
function will return valid reference to an immutable
CTRubyAnnotation object that is a copy of the one passed into
"rubyAnnotation".
*/
CTRubyAnnotationRef CTRubyAnnotationCreateCopy(
CTRubyAnnotationRef rubyAnnotation ) CT_AVAILABLE(macos(10.10), ios(8.0), watchos(2.0), tvos(9.0));
/*!
@function CTRubyAnnotationGetAlignment
@abstract Get the alignment value of a ruby annotation object.
@param rubyAnnotation
The ruby annotation object.
@result If the "rubyAnnotation" reference is valid, then this
function will return its alignment. Otherwise it will return kCTRubyAlignmentInvalid.
*/
CTRubyAlignment CTRubyAnnotationGetAlignment(
CTRubyAnnotationRef rubyAnnotation ) CT_AVAILABLE(macos(10.10), ios(8.0), watchos(2.0), tvos(9.0));
/*!
@function CTRubyAnnotationGetOverhang
@abstract Get the overhang value of a ruby annotation object.
@param rubyAnnotation
The ruby annotation object.
@result If the "rubyAnnotation" reference is valid, then this
function will return its overhang value. Otherwise it will return kCTRubyOverhangInvalid.
*/
CTRubyOverhang CTRubyAnnotationGetOverhang(
CTRubyAnnotationRef rubyAnnotation ) CT_AVAILABLE(macos(10.10), ios(8.0), watchos(2.0), tvos(9.0));
/*!
@function CTRubyAnnotationGetSizeFactor
@abstract Get the size factor of a ruby annotation object.
@param rubyAnnotation
The ruby annotation object.
@result If the "rubyAnnotation" reference is valid, then this
function will return its sizeFactor. Otherwise it will return 0.
*/
CGFloat CTRubyAnnotationGetSizeFactor(
CTRubyAnnotationRef rubyAnnotation ) CT_AVAILABLE(macos(10.10), ios(8.0), watchos(2.0), tvos(9.0));
/*!
@function CTRubyAnnotationGetTextForPosition
@abstract Get the ruby text for a particular position in a ruby annotation.
@param rubyAnnotation
The ruby annotation object.
@param position
The position for which you want to get the ruby text.
@result If the "rubyAnnotation" reference and the position are valid, then this
function will return a CFStringRef for the text. Otherwise it will return NULL.
*/
CFStringRef _Nullable CTRubyAnnotationGetTextForPosition(
CTRubyAnnotationRef rubyAnnotation,
CTRubyPosition position ) CT_AVAILABLE(macos(10.10), ios(8.0), watchos(2.0), tvos(9.0));
CF_ASSUME_NONNULL_END
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework/Headers/CTFont.h | /*
* CTFont.h
* CoreText
*
* Copyright (c) 2006-2020 Apple Inc. All rights reserved.
*
*/
/*!
@header
Thread Safety Information
All functions in this header are thread safe unless otherwise specified.
*/
#ifndef __CTFONT__
#define __CTFONT__
#include <CoreText/CTFontDescriptor.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
CF_ASSUME_NONNULL_BEGIN
/*! --------------------------------------------------------------------------
@group Font Types
*///--------------------------------------------------------------------------
/*!
@typedef CTFontRef
@abstract The Core Text Font reference.
@discussion This is a opaque reference to a core font object.
*/
#if TARGET_OS_IPHONE
typedef const struct CF_BRIDGED_TYPE(UIFont) __CTFont * CTFontRef;
#else
typedef const struct CF_BRIDGED_TYPE(NSFont) __CTFont * CTFontRef;
#endif
/*!
@function CTFontGetTypeID
@abstract Returns the type identifier for Core Text font references.
@result The identifier for the opaque type CTFontRef.
*/
CFTypeID CTFontGetTypeID( void ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*! --------------------------------------------------------------------------
@group Font Constants
*///--------------------------------------------------------------------------
// Name specifier constants
/*!
@defined kCTFontCopyrightNameKey
@abstract The name specifier for the copyright name.
*/
CT_EXPORT const CFStringRef kCTFontCopyrightNameKey CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontFamilyNameKey
@abstract The name specifier for the family name.
*/
CT_EXPORT const CFStringRef kCTFontFamilyNameKey CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontSubFamilyNameKey
@abstract The name specifier for the subfamily name.
*/
CT_EXPORT const CFStringRef kCTFontSubFamilyNameKey CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontStyleNameKey
@abstract The name specifier for the style name.
*/
CT_EXPORT const CFStringRef kCTFontStyleNameKey CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontUniqueNameKey
@abstract The name specifier for the unique name.
@discussion Note that this name is often not unique and should not be
assumed to be truly unique.
*/
CT_EXPORT const CFStringRef kCTFontUniqueNameKey CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontFullNameKey
@abstract The name specifier for the full name.
*/
CT_EXPORT const CFStringRef kCTFontFullNameKey CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontVersionNameKey
@abstract The name specifier for the version name.
*/
CT_EXPORT const CFStringRef kCTFontVersionNameKey CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontPostScriptNameKey
@abstract The name specifier for the PostScript name.
*/
CT_EXPORT const CFStringRef kCTFontPostScriptNameKey CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontTrademarkNameKey
@abstract The name specifier for the trademark name.
*/
CT_EXPORT const CFStringRef kCTFontTrademarkNameKey CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontManufacturerNameKey
@abstract The name specifier for the manufacturer name.
*/
CT_EXPORT const CFStringRef kCTFontManufacturerNameKey CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontDesignerNameKey
@abstract The name specifier for the designer name.
*/
CT_EXPORT const CFStringRef kCTFontDesignerNameKey CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontDescriptionNameKey
@abstract The name specifier for the description name.
*/
CT_EXPORT const CFStringRef kCTFontDescriptionNameKey CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontVendorURLNameKey
@abstract The name specifier for the vendor url name.
*/
CT_EXPORT const CFStringRef kCTFontVendorURLNameKey CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontDesignerURLNameKey
@abstract The name specifier for the designer url name.
*/
CT_EXPORT const CFStringRef kCTFontDesignerURLNameKey CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontLicenseNameKey
@abstract The name specifier for the license name.
*/
CT_EXPORT const CFStringRef kCTFontLicenseNameKey CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontLicenseURLNameKey
@abstract The name specifier for the license url name.
*/
CT_EXPORT const CFStringRef kCTFontLicenseURLNameKey CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontSampleTextNameKey
@abstract The name specifier for the sample text name string.
*/
CT_EXPORT const CFStringRef kCTFontSampleTextNameKey CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontPostScriptCIDNameKey
@abstract The name specifier for the PostScript CID name.
*/
CT_EXPORT const CFStringRef kCTFontPostScriptCIDNameKey CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*! --------------------------------------------------------------------------
@group Font Creation
*///--------------------------------------------------------------------------
/*!
@function CTFontCreateWithName
@abstract Returns a new font reference for the given name.
@discussion This function uses font descriptor matching so only registered fonts can be returned; see CTFontManager.h for more information. If you are trying to create a system UI font (with name beginning with a "."), you should use CTFontCreateUIFontForLanguage() or appropriate AppKit/UIKit APIs instead.
@param name
The font name for which you wish to create a new font reference. A valid PostScript name is preferred, although other font name types will be matched in a fallback manner. Any font name beginning with a "." is reserved for the system and should not be used here.
@param size
The point size for the font reference. If 0.0 is specified, the default font size of 12.0 will be used.
@param matrix
The transformation matrix for the font. If unspecified, the identity matrix will be used. Optional.
@result This function will return a CTFontRef that best matches the name provided with size and matrix attributes. The name parameter is the only required parameters, and default values will be used for unspecified parameters. A best match will be found if all parameters cannot be matched identically.
*/
CTFontRef CTFontCreateWithName(
CFStringRef name,
CGFloat size,
const CGAffineTransform * _Nullable matrix ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
#ifdef __swift__
static inline CF_SWIFT_NAME(CTFont.init(_:size:)) CTFontRef _CTFontCreateWithName(CFStringRef name, CGFloat size)
{
return CTFontCreateWithName(name, size, NULL);
}
static inline CF_SWIFT_NAME(CTFont.init(_:transform:)) CTFontRef _CTFontCreateWithNameAndMatrix(CFStringRef name, CGAffineTransform matrix)
{
return CTFontCreateWithName(name, 1.0, &matrix);
}
#endif // __swift__
/*!
@function CTFontCreateWithFontDescriptor
@abstract Returns a new font reference that best matches the font descriptor.
@param descriptor
A font descriptor containing attributes that specify the requested font.
@param size
The point size for the font reference. If 0.0 is specified, the default font size of 12.0 will be used.
@param matrix
The transformation matrix for the font. If unspecified, the identity matrix will be used. Optional.
@result This function will return a CTFontRef that best matches the attributes provided with the font descriptor. The size and matrix parameters will override any specified in the font descriptor, unless they are unspecified. A best match font will always be returned, and default values will be used for any unspecified.
*/
CTFontRef CTFontCreateWithFontDescriptor(
CTFontDescriptorRef descriptor,
CGFloat size,
const CGAffineTransform * _Nullable matrix ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
#ifdef __swift__
static inline CF_SWIFT_NAME(CTFont.init(_:size:)) CTFontRef _CTFontCreateWithFontDescriptor(CTFontDescriptorRef descriptor, CGFloat size)
{
return CTFontCreateWithFontDescriptor(descriptor, size, NULL);
}
static inline CF_SWIFT_NAME(CTFont.init(_:transform:)) CTFontRef _CTFontCreateWithFontDescriptorAndMatrix(CTFontDescriptorRef descriptor, CGAffineTransform matrix)
{
return CTFontCreateWithFontDescriptor(descriptor, 1.0, &matrix);
}
#endif // __swift__
/*!
@enum CTFontOptions
@abstract Options for descriptor match and font creation.
@constant kCTFontOptionsPreventAutoActivation
Prevents automatic font activation from taking place.
@constant kCTFontOptionsPreferSystemFont
Font matching will prefer to match Apple system fonts.
*/
typedef CF_OPTIONS(CFOptionFlags, CTFontOptions) {
kCTFontOptionsDefault = 0,
kCTFontOptionsPreventAutoActivation = 1 << 0,
kCTFontOptionsPreferSystemFont = 1 << 2
};
/*!
@function CTFontCreateWithNameAndOptions
@abstract Returns a new font reference for the given name.
@discussion This function uses font descriptor matching so only registered fonts can be returned; see CTFontManager.h for more information. If you are trying to create a system UI font (with name beginning with a "."), you should use CTFontCreateUIFontForLanguage() or appropriate AppKit/UIKit APIs instead.
@param name
The font name for which you wish to create a new font reference. A valid PostScript name is preferred, although other font name types will be matched in a fallback manner. Any font name beginning with a "." is reserved for the system and should not be used here.
@param size
The point size for the font reference. If 0.0 is specified, the default font size of 12.0 will be used.
@param matrix
The transformation matrix for the font. If unspecified, the identity matrix will be used. Optional.
@param options
Options flags.
@result This function will return a CTFontRef that best matches the name provided with size and matrix attributes. The name parameter is the only required parameters, and default values will be used for unspecified parameters. A best match will be found if all parameters cannot be matched identically.
*/
CTFontRef CTFontCreateWithNameAndOptions(
CFStringRef name,
CGFloat size,
const CGAffineTransform * _Nullable matrix,
CTFontOptions options ) CT_AVAILABLE(macos(10.6), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontCreateWithFontDescriptorAndOptions
@abstract Returns a new font reference that best matches the font descriptor.
@param descriptor
A font descriptor containing attributes that specify the requested font.
@param size
The point size for the font reference. If 0.0 is specified, the default font size of 12.0 will be used.
@param matrix
The transformation matrix for the font. If unspecified, the identity matrix will be used. Optional.
@param options
Options flags.
@result This function will return a CTFontRef that best matches the attributes provided with the font descriptor. The size and matrix parameters will override any specified in the font descriptor, unless they are unspecified. A best match font will always be returned, and default values will be used for any unspecified.
*/
CTFontRef CTFontCreateWithFontDescriptorAndOptions(
CTFontDescriptorRef descriptor,
CGFloat size,
const CGAffineTransform * _Nullable matrix,
CTFontOptions options ) CT_AVAILABLE(macos(10.6), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@enum UI Type constants
@abstract These constants represent the specific user interface purpose to specify for font creation.
@discussion Use these constants with CTFontCreateUIFontForLanguage to indicate the intended user interface usage of the font reference to be created.
*/
typedef CF_ENUM(uint32_t, CTFontUIFontType) {
kCTFontUIFontNone = (uint32_t)-1,
kCTFontUIFontUser = 0,
kCTFontUIFontUserFixedPitch = 1,
kCTFontUIFontSystem = 2,
kCTFontUIFontEmphasizedSystem = 3,
kCTFontUIFontSmallSystem = 4,
kCTFontUIFontSmallEmphasizedSystem = 5,
kCTFontUIFontMiniSystem = 6,
kCTFontUIFontMiniEmphasizedSystem = 7,
kCTFontUIFontViews = 8,
kCTFontUIFontApplication = 9,
kCTFontUIFontLabel = 10,
kCTFontUIFontMenuTitle = 11,
kCTFontUIFontMenuItem = 12,
kCTFontUIFontMenuItemMark = 13,
kCTFontUIFontMenuItemCmdKey = 14,
kCTFontUIFontWindowTitle = 15,
kCTFontUIFontPushButton = 16,
kCTFontUIFontUtilityWindowTitle = 17,
kCTFontUIFontAlertHeader = 18,
kCTFontUIFontSystemDetail = 19,
kCTFontUIFontEmphasizedSystemDetail = 20,
kCTFontUIFontToolbar = 21,
kCTFontUIFontSmallToolbar = 22,
kCTFontUIFontMessage = 23,
kCTFontUIFontPalette = 24,
kCTFontUIFontToolTip = 25,
kCTFontUIFontControlContent = 26,
kCTFontNoFontType CT_ENUM_DEPRECATED("Deprecated", macos(10.5, 10.11), ios(3.2, 9.0)) CT_ENUM_UNAVAILABLE(watchos, tvos)
= kCTFontUIFontNone,
kCTFontUserFontType CT_ENUM_DEPRECATED("Deprecated", macos(10.5, 10.11), ios(3.2, 9.0)) CT_ENUM_UNAVAILABLE(watchos, tvos)
= kCTFontUIFontUser,
kCTFontUserFixedPitchFontType CT_ENUM_DEPRECATED("Deprecated", macos(10.5, 10.11), ios(3.2, 9.0)) CT_ENUM_UNAVAILABLE(watchos, tvos)
= kCTFontUIFontUserFixedPitch,
kCTFontSystemFontType CT_ENUM_DEPRECATED("Deprecated", macos(10.5, 10.11), ios(3.2, 9.0)) CT_ENUM_UNAVAILABLE(watchos, tvos)
= kCTFontUIFontSystem,
kCTFontEmphasizedSystemFontType CT_ENUM_DEPRECATED("Deprecated", macos(10.5, 10.11), ios(3.2, 9.0)) CT_ENUM_UNAVAILABLE(watchos, tvos)
= kCTFontUIFontEmphasizedSystem,
kCTFontSmallSystemFontType CT_ENUM_DEPRECATED("Deprecated", macos(10.5, 10.11), ios(3.2, 9.0)) CT_ENUM_UNAVAILABLE(watchos, tvos)
= kCTFontUIFontSmallSystem,
kCTFontSmallEmphasizedSystemFontType CT_ENUM_DEPRECATED("Deprecated", macos(10.5, 10.11), ios(3.2, 9.0)) CT_ENUM_UNAVAILABLE(watchos, tvos)
= kCTFontUIFontSmallEmphasizedSystem,
kCTFontMiniSystemFontType CT_ENUM_DEPRECATED("Deprecated", macos(10.5, 10.11), ios(3.2, 9.0)) CT_ENUM_UNAVAILABLE(watchos, tvos)
= kCTFontUIFontMiniSystem,
kCTFontMiniEmphasizedSystemFontType CT_ENUM_DEPRECATED("Deprecated", macos(10.5, 10.11), ios(3.2, 9.0)) CT_ENUM_UNAVAILABLE(watchos, tvos)
= kCTFontUIFontMiniEmphasizedSystem,
kCTFontViewsFontType CT_ENUM_DEPRECATED("Deprecated", macos(10.5, 10.11), ios(3.2, 9.0)) CT_ENUM_UNAVAILABLE(watchos, tvos)
= kCTFontUIFontViews,
kCTFontApplicationFontType CT_ENUM_DEPRECATED("Deprecated", macos(10.5, 10.11), ios(3.2, 9.0)) CT_ENUM_UNAVAILABLE(watchos, tvos)
= kCTFontUIFontApplication,
kCTFontLabelFontType CT_ENUM_DEPRECATED("Deprecated", macos(10.5, 10.11), ios(3.2, 9.0)) CT_ENUM_UNAVAILABLE(watchos, tvos)
= kCTFontUIFontLabel,
kCTFontMenuTitleFontType CT_ENUM_DEPRECATED("Deprecated", macos(10.5, 10.11), ios(3.2, 9.0)) CT_ENUM_UNAVAILABLE(watchos, tvos)
= kCTFontUIFontMenuTitle,
kCTFontMenuItemFontType CT_ENUM_DEPRECATED("Deprecated", macos(10.5, 10.11), ios(3.2, 9.0)) CT_ENUM_UNAVAILABLE(watchos, tvos)
= kCTFontUIFontMenuItem,
kCTFontMenuItemMarkFontType CT_ENUM_DEPRECATED("Deprecated", macos(10.5, 10.11), ios(3.2, 9.0)) CT_ENUM_UNAVAILABLE(watchos, tvos)
= kCTFontUIFontMenuItemMark,
kCTFontMenuItemCmdKeyFontType CT_ENUM_DEPRECATED("Deprecated", macos(10.5, 10.11), ios(3.2, 9.0)) CT_ENUM_UNAVAILABLE(watchos, tvos)
= kCTFontUIFontMenuItemCmdKey,
kCTFontWindowTitleFontType CT_ENUM_DEPRECATED("Deprecated", macos(10.5, 10.11), ios(3.2, 9.0)) CT_ENUM_UNAVAILABLE(watchos, tvos)
= kCTFontUIFontWindowTitle,
kCTFontPushButtonFontType CT_ENUM_DEPRECATED("Deprecated", macos(10.5, 10.11), ios(3.2, 9.0)) CT_ENUM_UNAVAILABLE(watchos, tvos)
= kCTFontUIFontPushButton,
kCTFontUtilityWindowTitleFontType CT_ENUM_DEPRECATED("Deprecated", macos(10.5, 10.11), ios(3.2, 9.0)) CT_ENUM_UNAVAILABLE(watchos, tvos)
= kCTFontUIFontUtilityWindowTitle,
kCTFontAlertHeaderFontType CT_ENUM_DEPRECATED("Deprecated", macos(10.5, 10.11), ios(3.2, 9.0)) CT_ENUM_UNAVAILABLE(watchos, tvos)
= kCTFontUIFontAlertHeader,
kCTFontSystemDetailFontType CT_ENUM_DEPRECATED("Deprecated", macos(10.5, 10.11), ios(3.2, 9.0)) CT_ENUM_UNAVAILABLE(watchos, tvos)
= kCTFontUIFontSystemDetail,
kCTFontEmphasizedSystemDetailFontType CT_ENUM_DEPRECATED("Deprecated", macos(10.5, 10.11), ios(3.2, 9.0)) CT_ENUM_UNAVAILABLE(watchos, tvos)
= kCTFontUIFontEmphasizedSystemDetail,
kCTFontToolbarFontType CT_ENUM_DEPRECATED("Deprecated", macos(10.5, 10.11), ios(3.2, 9.0)) CT_ENUM_UNAVAILABLE(watchos, tvos)
= kCTFontUIFontToolbar,
kCTFontSmallToolbarFontType CT_ENUM_DEPRECATED("Deprecated", macos(10.5, 10.11), ios(3.2, 9.0)) CT_ENUM_UNAVAILABLE(watchos, tvos)
= kCTFontUIFontSmallToolbar,
kCTFontMessageFontType CT_ENUM_DEPRECATED("Deprecated", macos(10.5, 10.11), ios(3.2, 9.0)) CT_ENUM_UNAVAILABLE(watchos, tvos)
= kCTFontUIFontMessage,
kCTFontPaletteFontType CT_ENUM_DEPRECATED("Deprecated", macos(10.5, 10.11), ios(3.2, 9.0)) CT_ENUM_UNAVAILABLE(watchos, tvos)
= kCTFontUIFontPalette,
kCTFontToolTipFontType CT_ENUM_DEPRECATED("Deprecated", macos(10.5, 10.11), ios(3.2, 9.0)) CT_ENUM_UNAVAILABLE(watchos, tvos)
= kCTFontUIFontToolTip,
kCTFontControlContentFontType CT_ENUM_DEPRECATED("Deprecated", macos(10.5, 10.11), ios(3.2, 9.0)) CT_ENUM_UNAVAILABLE(watchos, tvos)
= kCTFontUIFontControlContent
};
/*!
@function CTFontCreateUIFontForLanguage
@abstract Returns the special UI font for the given language and UI type.
@param uiType
A uiType constant specifying the intended UI use for the requested font reference.
@param size
The point size for the font reference. If 0.0 is specified, the default size for the requested uiType is used.
@param language
Language identifier to select a font for a particular localization. If unspecified, the current system language is used. The format of the language identifier should conform to UTS #35.
@result This function returns the correct font for various UI uses. The only required parameter is the uiType selector, unspecified optional parameters will use default values.
*/
CTFontRef _Nullable CTFontCreateUIFontForLanguage(
CTFontUIFontType uiType,
CGFloat size,
CFStringRef _Nullable language ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
#ifdef __swift__
static inline CF_SWIFT_NAME(CTFont.init(_:size:)) CTFontRef _CTFontCreateUIFont(CTFontUIFontType uiType, CGFloat size)
{
return CTFontCreateUIFontForLanguage(uiType, size, NULL);
}
static inline CF_SWIFT_NAME(CTFont.init(_:size:language:)) CTFontRef _CTFontCreateUIFontForLanguage(CTFontUIFontType uiType, CGFloat size, CFStringRef _Nullable language)
{
return CTFontCreateUIFontForLanguage(uiType, size, language);
}
#endif // __swift__
/*!
@function CTFontCreateCopyWithAttributes
@abstract Returns a new font with additional attributes based on the original font.
@discussion This function provides a mechanism to quickly change attributes on a given font reference in response to user actions. For instance, the size can be changed in response to a user manipulating a size slider.
@param font
Original font reference to base new font on.
@param size
The point size for the font reference. If 0.0 is specified, the original font's size will be preserved.
@param matrix
The transformation matrix for the font. If unspecified, the original font matrix will be preserved. Optional.
@param attributes
A font descriptor containing additional attributes that the new font should contain.
@result Returns a new font reference converted from the original with the specified attributes.
*/
CTFontRef CTFontCreateCopyWithAttributes(
CTFontRef font,
CGFloat size,
const CGAffineTransform * _Nullable matrix,
CTFontDescriptorRef _Nullable attributes ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontCreateCopyWithSymbolicTraits
@abstract Returns a new font based on the original font with the specified symbolic traits.
@param font
Original font reference on which to base the new font.
@param size
The point size for the font reference. If 0.0 is specified, the original font's size will be preserved.
@param matrix
The transformation matrix for the font. If unspecified, the original font matrix will be preserved. Optional.
@param symTraitValue
The value of the symbolic traits. This bitfield is used to indicate the desired value for the traits specified by the symTraitMask parameter. Used in conjunction, they can allow for trait removal as well as addition.
@param symTraitMask
The mask bits of the symbolic traits. This bitfield is used to indicate the traits that should be changed.
@result Returns a new font reference in the same family with the given symbolic traits, or NULL if none found in the system.
*/
CTFontRef _Nullable CTFontCreateCopyWithSymbolicTraits(
CTFontRef font,
CGFloat size,
const CGAffineTransform * _Nullable matrix,
CTFontSymbolicTraits symTraitValue,
CTFontSymbolicTraits symTraitMask ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontCreateCopyWithFamily
@abstract Returns a new font in the specified family based on the traits of the original font.
@param font
Original font reference to base new font on.
@param size
The point size for the font reference. If 0.0 is specified, the original font's size will be preserved.
@param matrix
The transformation matrix for the font. If unspecified, the original font matrix will be preserved. Optional.
@param family
The name of the desired family.
@result Returns a new font reference with the original traits in the given family. NULL if non found in the system.
*/
CTFontRef _Nullable CTFontCreateCopyWithFamily(
CTFontRef font,
CGFloat size,
const CGAffineTransform * _Nullable matrix,
CFStringRef family ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*! --------------------------------------------------------------------------
@group Font Cascading
*///--------------------------------------------------------------------------
/*!
@function CTFontCreateForString
@abstract Returns a new font reference that can best map the given string range based on the current font.
@discussion This function is to be used when the current font does not cover the given range of the string. The current font itself will not be returned, but preference is given to fonts in its cascade list.
@param currentFont
The current font that contains a valid cascade list.
@param string
A unicode string containing characters that cannot be encoded by the current font.
@param range
A CFRange specifying the range of the string that needs to be mapped.
@result This function returns the best substitute font that can encode the specified string range.
@seealso CTFontCopyCharacterSet
@seealso CTFontGetGlyphsForCharacters
@seealso kCTFontCascadeListAttribute
*/
CTFontRef CTFontCreateForString(
CTFontRef currentFont,
CFStringRef string,
CFRange range ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontCreateForStringWithLanguage
@abstract Returns a new font reference that can best map the given string range based on the current font and language specified.
@discussion The current font itself can be returned if it covers the string provided.
@param currentFont
The current font that contains a valid cascade list.
@param string
A unicode string containing characters that cannot be encoded by the current font.
@param range
A CFRange specifying the range of the string that needs to be mapped.
@param language
Language identifier to select a font for a particular localization. If unspecified, the current system language is used. The format of the language identifier should conform to UTS #35.
@result This function returns the best substitute font that can encode the specified string range.
@seealso CTFontCopyCharacterSet
@seealso CTFontGetGlyphsForCharacters
@seealso kCTFontCascadeListAttribute
*/
CTFontRef CTFontCreateForStringWithLanguage(
CTFontRef currentFont,
CFStringRef string,
CFRange range,
CFStringRef _Nullable language ) CT_AVAILABLE(macos(10.9), ios(7.0), watchos(2.0), tvos(9.0));
#ifdef __swift__
static inline CF_SWIFT_NAME(CTFont.init(font:string:range:)) CTFontRef _CTFontCreateForString(CTFontRef currentFont, CFStringRef string, CFRange range)
{
return CTFontCreateForString(currentFont, string, range);
}
static inline CF_SWIFT_NAME(CTFont.init(font:string:range:language:)) CTFontRef _CTFontCreateForStringWithLanguage(CTFontRef currentFont, CFStringRef string, CFRange range, CFStringRef _Nullable language)
{
return CTFontCreateForStringWithLanguage(currentFont, string, range, language);
}
#endif // __swift__
/*! --------------------------------------------------------------------------
@group Font Accessors
*///--------------------------------------------------------------------------
/*!
@function CTFontCopyFontDescriptor
@abstract Returns the normalized font descriptors for the given font reference.
@param font
The font reference.
@result This function returns a normalized font descriptor for a font. The font descriptor contains enough information to recreate this font at a later time.
*/
CTFontDescriptorRef CTFontCopyFontDescriptor(
CTFontRef font ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontCopyAttribute
@abstract Returns the value associated with an arbitrary attribute.
@param font
The font reference.
@param attribute
The requested attribute.
@result This function returns a retained reference to an arbitrary attribute. If the requested attribute is not present, NULL is returned. Refer to the attribute definitions for documentation as to how each attribute is packaged as a CFType.
*/
CFTypeRef _Nullable CTFontCopyAttribute(
CTFontRef font,
CFStringRef attribute ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontGetSize
@abstract Returns the point size of the font reference.
@param font
The font reference.
@result This function returns the point size of the given font reference. This is the point size provided when the font was created.
*/
CGFloat CTFontGetSize( CTFontRef font ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontGetMatrix
@abstract Returns the transformation matrix of the font.
@param font
The font reference.
@result This function returns the transformation matrix for this given font reference. This is the matrix that was provided when the font was created.
*/
CGAffineTransform CTFontGetMatrix( CTFontRef font ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontGetSymbolicTraits
@abstract Returns the symbolic font traits.
@param font
The font reference.
@result This function returns the symbolic traits of the font. This is equivalent to the kCTFontSymbolicTrait of traits dictionary. See CTFontTraits.h for a definition of the font traits.
*/
CTFontSymbolicTraits CTFontGetSymbolicTraits( CTFontRef font ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontCopyTraits
@abstract Returns the font traits dictionary.
@param font
The font reference.
@result This function returns a retained reference to the font traits dictionary. Individual traits can be accessed with the trait key constants. See CTFontTraits.h for a definition of the font traits.
*/
CFDictionaryRef CTFontCopyTraits( CTFontRef font ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*! --------------------------------------------------------------------------
@group Font Names
*///--------------------------------------------------------------------------
/*!
@function CTFontCopyPostScriptName
@abstract Returns the PostScript name.
@param font
The font reference.
@result This function returns a retained reference to the PostScript name of the font.
*/
CFStringRef CTFontCopyPostScriptName( CTFontRef font ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontCopyFamilyName
@abstract Returns the family name.
@param font
The font reference.
@result This function returns a retained reference to the family name of the font.
*/
CFStringRef CTFontCopyFamilyName( CTFontRef font ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontCopyFullName
@abstract Returns the display name.
@param font
The font reference.
@result This function returns a retained reference to the full name of the font.
*/
CFStringRef CTFontCopyFullName( CTFontRef font ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontCopyDisplayName
@abstract Returns the display name.
@param font
The font reference.
@result This function returns a retained reference to the localized display name of the font.
*/
CFStringRef CTFontCopyDisplayName( CTFontRef font ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontCopyName
@abstract Returns a reference to the requested name.
@param font
The font reference.
@param nameKey
The name specifier. See name specifier constants.
@result This function creates the requested name for the font, or NULL if the font does not have an entry for the requested name. The Unicode version of the name will be preferred, otherwise the first available will be used.
*/
CFStringRef _Nullable CTFontCopyName(
CTFontRef font,
CFStringRef nameKey ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontCopyLocalizedName
@abstract Returns a reference to a localized font name.
@param font
The font reference.
@param nameKey
The name specifier. See name specifier constants.
@param actualLanguage
Pointer to a CFStringRef to receive the language identifier of the returned name string. The format of the language identifier will conform to UTS #35.
If CoreText can supply its own localized string where the font cannot, this value will be NULL.
@result This function returns a specific localized name from the font reference. The name is localized based on the user's global language precedence. If the font does not have an entry for the requested name, NULL will be returned. The matched language will be returned in the caller's buffer.
*/
CFStringRef _Nullable CTFontCopyLocalizedName(
CTFontRef font,
CFStringRef nameKey,
CFStringRef _Nullable * _Nullable actualLanguage ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*! --------------------------------------------------------------------------
@group Font Encoding
*///--------------------------------------------------------------------------
/*!
@function CTFontCopyCharacterSet
@abstract Returns the Unicode character set of the font.
@param font
The font reference.
@result This function returns a retained reference to the font's character set. This character set covers the nominal referenced by the font's Unicode cmap table (or equivalent).
*/
CFCharacterSetRef CTFontCopyCharacterSet( CTFontRef font ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontGetStringEncoding
@abstract Returns the best string encoding for legacy format support.
@param font
The font reference.
@result This function returns the best string encoding for the font.
*/
CFStringEncoding CTFontGetStringEncoding( CTFontRef font ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontCopySupportedLanguages
@abstract Returns an array of languages supported by the font.
@param font
The font reference.
@result This function returns a retained reference to an array of languages supported by the font. The array contains language identifier strings as CFStringRefs. The format of the language identifier will conform to UTS #35.
*/
CFArrayRef CTFontCopySupportedLanguages( CTFontRef font ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontGetGlyphsForCharacters
@abstract Performs basic character-to-glyph mapping.
@discussion This function only provides the nominal mapping as specified by the font's Unicode cmap (or equivalent); such mapping does not constitute proper Unicode layout: it is the caller's responsibility to handle the Unicode properties of the characters.
@param font
The font reference.
@param characters
An array of characters (UTF-16 code units). Non-BMP characters must be encoded as surrogate pairs.
@param glyphs
A pointer to a buffer to receive the glyphs. Glyphs for non-BMP characters are sparse: the first glyph corresponds to the full character and the second glyph will be 0.
@param count
The capacity of both the characters and glyphs arrays.
@result The return value indicates whether all provided characters were successfully mapped. A return value of true indicates that the font mapped all characters. A return value of false indicates that some or all of the characters were not mapped; glyphs for unmapped characters will be 0 (with the exception of those corresponding non-BMP characters as described above).
@seealso CTFontCopyCharacterSet
*/
bool CTFontGetGlyphsForCharacters(
CTFontRef font,
const UniChar characters[_Nonnull],
CGGlyph glyphs[_Nonnull],
CFIndex count ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*! --------------------------------------------------------------------------
@group Font Metrics
*///--------------------------------------------------------------------------
/*!
@function CTFontGetAscent
@abstract Returns the scaled font ascent metric.
@param font
The font reference.
@result This function returns the font ascent metric scaled based on the point size and matrix of the font reference.
*/
CGFloat CTFontGetAscent( CTFontRef font ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontGetDescent
@abstract Returns the scaled font descent metric.
@param font
The font reference.
@result This function returns the font descent metric scaled based on the point size and matrix of the font reference.
*/
CGFloat CTFontGetDescent( CTFontRef font ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontGetLeading
@abstract Returns the scaled font leading metric.
@param font
The font reference.
@result This function returns the font leading metric scaled based on the point size and matrix of the font reference.
*/
CGFloat CTFontGetLeading( CTFontRef font ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontGetUnitsPerEm
@abstract Returns the units per em metric.
@param font
The font reference.
@result This function returns the units per em of the font.
*/
unsigned CTFontGetUnitsPerEm( CTFontRef font ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontGetGlyphCount
@abstract Returns the number of glyphs.
@param font
The font reference.
@result This function returns the number of glyphs in the font.
*/
CFIndex CTFontGetGlyphCount( CTFontRef font ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontGetBoundingBox
@abstract Returns the scaled bounding box.
@param font
The font reference.
@result This will return the design bounding box of the font, which is the rectangle defined by xMin, yMin, xMax, and yMax values for the font.
*/
CGRect CTFontGetBoundingBox( CTFontRef font ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontGetUnderlinePosition
@abstract Returns the scaled underline position.
@param font
The font reference.
@result This function returns the font underline position metric scaled based on the point size and matrix of the font reference.
*/
CGFloat CTFontGetUnderlinePosition( CTFontRef font ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontGetUnderlineThickness
@abstract Returns the scaled underline thickness metric.
@param font
The font reference.
@result This function returns the font underline thickness metric scaled based on the point size and matrix of the font reference.
*/
CGFloat CTFontGetUnderlineThickness( CTFontRef font ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontGetSlantAngle
@abstract Returns the slant angle of the font.
@param font
The font reference.
@result This function returns the transformed slant angle of the font. This is equivalent to the italic or caret angle with any skew from the transformation matrix applied.
*/
CGFloat CTFontGetSlantAngle( CTFontRef font ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontGetCapHeight
@abstract Returns the cap height metric.
@param font
The font reference.
@result This function returns the font cap height metric scaled based on the point size and matrix of the font reference.
*/
CGFloat CTFontGetCapHeight( CTFontRef font ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontGetXHeight
@abstract Returns the X height metric.
@param font
The font reference.
@result This function returns the font X height metric scaled based on the point size and matrix of the font reference.
*/
CGFloat CTFontGetXHeight( CTFontRef font ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*! --------------------------------------------------------------------------
@group Font Glyphs
*///--------------------------------------------------------------------------
/*!
@function CTFontGetGlyphWithName
@abstract Returns the CGGlyph for the specified glyph name.
@param font
The font reference.
@param glyphName
The glyph name as a CFString.
@result The glyph with the specified name or 0 if the name is not recognized; this glyph can be used with other Core Text glyph data accessors or with Quartz.
*/
CGGlyph CTFontGetGlyphWithName(
CTFontRef font,
CFStringRef glyphName ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontCopyNameForGlyph
@abstract Returns the name for the specified glyph.
@param font
The font reference.
@param glyph
The glyph.
@result The glyph name as a CFString or NULL if the glyph is invalid.
@seealso CTFontGetGlyphWithName
*/
CFStringRef _Nullable CTFontCopyNameForGlyph(
CTFontRef font,
CGGlyph glyph ) CT_AVAILABLE(macos(10.8), ios(6.0), watchos(2.0), tvos(9.0));
/*!
@function CTFontGetBoundingRectsForGlyphs
@abstract Calculates the bounding rects for an array of glyphs and returns the overall bounding rect for the run.
@param font
The font reference.
@param orientation
The intended drawing orientation of the glyphs. Used to determined which glyph metrics to return.
@param glyphs
An array of count number of glyphs.
@param boundingRects
An array of count number of CGRects to receive the computed glyph rects. Can be NULL, in which case only the overall bounding rect is calculated.
@param count
The capacity of the glyphs and boundingRects buffers.
@result This function returns the overall bounding rectangle for an array or run of glyphs. The bounding rects of the individual glyphs are returned through the boundingRects parameter. These are the design metrics from the font transformed in font space.
*/
CGRect CTFontGetBoundingRectsForGlyphs(
CTFontRef font,
CTFontOrientation orientation,
const CGGlyph glyphs[_Nonnull],
CGRect boundingRects[_Nullable],
CFIndex count ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontGetOpticalBoundsForGlyphs
@abstract Calculates the optical bounding rects for an array of glyphs and returns the overall optical bounding rect for the run.
@discussion Fonts may specify the optical edges of glyphs that can be used to make the edges of lines of text line up in a more visually pleasing way. This function returns bounding rects corresponding to this information if present in a font, otherwise it returns typographic bounding rects (composed of the font's ascent and descent and a glyph's advance width).
@param font
The font reference.
@param glyphs
An array of count number of glyphs.
@param boundingRects
An array of count number of CGRects to receive the computed glyph rects. Can be NULL, in which case only the overall bounding rect is calculated.
@param count
The capacity of the glyphs and boundingRects buffers.
@param options
Reserved, set to zero.
@result This function returns the overall bounding rectangle for an array or run of glyphs. The bounding rects of the individual glyphs are returned through the boundingRects parameter. These are the design metrics from the font transformed in font space.
*/
CGRect CTFontGetOpticalBoundsForGlyphs(
CTFontRef font,
const CGGlyph glyphs[_Nonnull],
CGRect boundingRects[_Nullable],
CFIndex count,
CFOptionFlags options ) CT_AVAILABLE(macos(10.8), ios(6.0), watchos(2.0), tvos(9.0));
/*!
@function CTFontGetAdvancesForGlyphs
@abstract Calculates the advances for an array of glyphs and returns the summed advance.
@param font
The font reference.
@param orientation
The intended drawing orientation of the glyphs. Used to determined which glyph metrics to return.
@param glyphs
An array of count number of glyphs.
@param advances
An array of count number of CGSize to receive the computed glyph advances. Can be NULL, in which case only the overall advance is calculated.
@param count
The capacity of the glyphs and advances buffers.
@result This function returns the summed glyph advance of an array of glyphs. Individual glyph advances are passed back via the advances parameter. These are the ideal metrics for each glyph scaled and transformed in font space.
*/
double CTFontGetAdvancesForGlyphs(
CTFontRef font,
CTFontOrientation orientation,
const CGGlyph glyphs[_Nonnull],
CGSize advances[_Nullable],
CFIndex count ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontGetVerticalTranslationsForGlyphs
@abstract Calculates the offset from the default (horizontal) origin to the vertical origin for an array of glyphs.
@param font
The font reference.
@param glyphs
An array of count number of glyphs.
@param translations
An array of count number of CGSize to receive the computed origin offsets.
@param count
The capacity of the glyphs and translations buffers.
*/
void CTFontGetVerticalTranslationsForGlyphs(
CTFontRef font,
const CGGlyph glyphs[_Nonnull],
CGSize translations[_Nonnull],
CFIndex count ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontCreatePathForGlyph
@abstract Creates a path for the specified glyph.
@discussion Creates a path from the outlines of the glyph for the specified font. The path will reflect the font point size, matrix, and transform parameter, in that order. The transform parameter will most commonly be used to provide a translation to the desired glyph origin.
@param font
The font reference.
@param glyph
The glyph.
@param matrix
An affine transform applied to the path. Can be NULL, in which case CGAffineTransformIdentity will be used.
@result A retained CGPath reference containing the glyph outlines or NULL if there is no such glyph or it has no outline.
*/
CGPathRef _Nullable CTFontCreatePathForGlyph(
CTFontRef font,
CGGlyph glyph,
const CGAffineTransform * _Nullable matrix ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*! --------------------------------------------------------------------------
@group Font Variations
*///--------------------------------------------------------------------------
/*!
@defined kCTFontVariationAxisIdentifierKey
@abstract Key to get the variation axis identifier.
@discussion This key is used with a variation axis dictionary to get the axis identifier value as a CFNumberRef.
*/
CT_EXPORT const CFStringRef kCTFontVariationAxisIdentifierKey CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontVariationAxisMinimumValueKey
@abstract Key to get the variation axis minimum value.
@discussion This key is used with a variation axis dictionary to get the minimum axis value as a CFNumberRef.
*/
CT_EXPORT const CFStringRef kCTFontVariationAxisMinimumValueKey CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontVariationAxisMaximumValueKey
@abstract Key to get the variation axis maximum value.
@discussion This key is used with a variation axis dictionary to get the maximum axis value as a CFNumberRef.
*/
CT_EXPORT const CFStringRef kCTFontVariationAxisMaximumValueKey CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontVariationAxisDefaultValueKey
@abstract Key to get the variation axis default value.
@discussion This key is used with a variation axis dictionary to get the default axis value as a CFNumberRef.
*/
CT_EXPORT const CFStringRef kCTFontVariationAxisDefaultValueKey CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontVariationAxisNameKey
@abstract Key to get the variation axis name string.
@discussion This key is used with a variation axis dictionary to get the localized variation axis name.
*/
CT_EXPORT const CFStringRef kCTFontVariationAxisNameKey CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontVariationAxisHiddenKey
@abstract Key to get the hidden axis flag.
@discussion This key contains a CFBoolean value that is true when the font designer recommends the axis not be exposed directly to end users in application interfaces.
*/
CT_EXPORT const CFStringRef kCTFontVariationAxisHiddenKey CT_AVAILABLE(macos(10.13), ios(11.0), watchos(4.0), tvos(11.0));
/*!
@function CTFontCopyVariationAxes
@abstract Returns an array of variation axis dictionaries.
@param font
The font reference.
@result This function returns an array of variation axis dictionaries or null if the font does not support variations. Each variation axis dictionary contains the five kCTFontVariationAxis* keys above.
*/
CFArrayRef _Nullable CTFontCopyVariationAxes( CTFontRef font ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontCopyVariation
@abstract Returns a variation dictionary.
@discussion This function describes the current configuration of a variation font: a dictionary of number values with variation identifier number keys. As of macOS 10.12 and iOS 10.0, only non-default values (as determined by the variation axis) are returned.
@param font
The font reference.
@result This function returns a variation dictionary or null if the font does not support variations.
@seealso kCTFontVariationAxisIdentifierKey
@seealso kCTFontVariationAxisDefaultValueKey
*/
CFDictionaryRef _Nullable CTFontCopyVariation( CTFontRef font ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*! --------------------------------------------------------------------------
@group Font Features
*///--------------------------------------------------------------------------
/*!
@defined kCTFontOpenTypeFeatureTag
@abstract Key to get the OpenType feature tag.
@discussion This key can be used with a font feature dictionary to get the tag as a CFStringRef.
*/
CT_EXPORT const CFStringRef kCTFontOpenTypeFeatureTag CT_AVAILABLE(macos(10.10), ios(8.0), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontOpenTypeFeatureValue
@abstract Key to get the OpenType feature value.
@discussion This key can be used with a font feature dictionary to get the value as a CFNumberRef.
*/
CT_EXPORT const CFStringRef kCTFontOpenTypeFeatureValue CT_AVAILABLE(macos(10.10), ios(8.0), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontFeatureTypeIdentifierKey
@abstract Key to get the font feature type value.
@discussion This key can be used with a font feature dictionary to get the type identifier as a CFNumberRef.
*/
CT_EXPORT const CFStringRef kCTFontFeatureTypeIdentifierKey CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontFeatureTypeNameKey
@abstract Key to get the font feature name.
@discussion This key can be used with a font feature dictionary to get the localized type name string as a CFString.
*/
CT_EXPORT const CFStringRef kCTFontFeatureTypeNameKey CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontFeatureTypeExclusiveKey
@abstract Key to get the font feature exclusive setting.
@discussion This key can be used with a font feature dictionary to get the the exclusive setting of the feature as a CFBoolean. The value associated with this key indicates whether the feature selectors associated with this type should be mutually exclusive.
*/
CT_EXPORT const CFStringRef kCTFontFeatureTypeExclusiveKey CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontFeatureTypeSelectorsKey
@abstract Key to get the font feature selectors.
@discussion This key can be used with a font feature dictionary to get the array of font feature selectors as a CFArrayRef. This is an array of selector dictionaries that contain the values for the following selector keys.
*/
CT_EXPORT const CFStringRef kCTFontFeatureTypeSelectorsKey CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontFeatureSelectorIdentifierKey
@abstract Key to get the font feature selector identifier.
@discussion This key can be used with a selector dictionary corresponding to a feature type to obtain the selector identifier value as a CFNumberRef.
*/
CT_EXPORT const CFStringRef kCTFontFeatureSelectorIdentifierKey CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontFeatureSelectorNameKey
@abstract Key to get the font feature selector name.
@discussion This key is used with a selector dictionary to get the localized name string for the selector as a CFStringRef.
*/
CT_EXPORT const CFStringRef kCTFontFeatureSelectorNameKey CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontFeatureSelectorDefaultKey
@abstract Key to get the font feature selector default setting value.
@discussion This key is used with a selector dictionary to get the default indicator for the selector. This value is a CFBooleanRef which if present and true indicates that this selector is the default setting for the current feature type.
*/
CT_EXPORT const CFStringRef kCTFontFeatureSelectorDefaultKey CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontFeatureSelectorSettingKey
@abstract Key to get or specify the current feature setting.
@discussion This key is used with a selector dictionary to get or specify the current setting for the selector. This value is a CFBooleanRef to indicate whether this selector is on or off. If this key is not present, the default setting is used.
*/
CT_EXPORT const CFStringRef kCTFontFeatureSelectorSettingKey CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontFeatureSampleTextKey
@abstract Key to get the font feature sample text.
@discussion This key can be used with a font feature dictionary to get the localized sample text as a CFStringRef.
*/
CT_EXPORT const CFStringRef kCTFontFeatureSampleTextKey CT_AVAILABLE(macos(10.15), ios(13.0), watchos(6.0), tvos(13.0));
/*!
@defined kCTFontFeatureTooltipTextKey
@abstract Key to get the font feature tooltip text.
@discussion This key can be used with a font feature dictionary to get the localized tooltip text as a CFStringRef.
*/
CT_EXPORT const CFStringRef kCTFontFeatureTooltipTextKey CT_AVAILABLE(macos(10.15), ios(13.0), watchos(6.0), tvos(13.0));
/*!
@function CTFontCopyFeatures
@abstract Returns an array of font features
@param font
The font reference.
@result This function returns an array of font feature dictionaries for the font reference.
*/
CFArrayRef _Nullable CTFontCopyFeatures( CTFontRef font ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontCopyFeatureSettings
@abstract Returns an array of font feature setting tuples
@discussion A setting tuple is a dictionary of a kCTFontFeatureTypeIdentifierKey key-value pair and a kCTFontFeatureSelectorIdentifierKey key-value pair. Each tuple corresponds to an enabled non-default setting. It is the caller's responsibility to handle exclusive and non-exclusive settings as necessary.
@param font
The font reference.
@result This function returns a normalized array of font feature setting dictionaries. The array will only contain the non-default settings that should be applied to the font, or NULL if the default settings should be used.
*/
CFArrayRef _Nullable CTFontCopyFeatureSettings( CTFontRef font ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*! --------------------------------------------------------------------------
@group Font Conversion
*///--------------------------------------------------------------------------
/*!
@function CTFontCopyGraphicsFont
@abstract Returns a CGFontRef and attributes.
@param font
The font reference.
@param attributes
A pointer to a CTFontDescriptorRef to receive a font descriptor containing additional attributes. Can be NULL. Must be released by caller.
@result This function returns a CGFontRef for the given font reference. Additional attributes from the font will be passed back as a font descriptor via the attributes parameter. The result must be released by the caller.
*/
CGFontRef CTFontCopyGraphicsFont(
CTFontRef font,
CTFontDescriptorRef _Nullable * _Nullable attributes ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontCreateWithGraphicsFont
@abstract Creates a new font reference from a CGFontRef.
@param graphicsFont
A valid CGFontRef.
@param size
The point size for the font reference. If 0.0 is specified, the default font size of 12.0 will be used.
@param matrix
The transformation matrix for the font. If unspecified, the identity matrix will be used. Optional.
@param attributes
A CTFontDescriptorRef containing additional attributes that should be matched. Optional.
@result This function returns a new font reference for an existing CGFontRef with the specified size, matrix, and additional attributes.
*/
CTFontRef CTFontCreateWithGraphicsFont(
CGFontRef graphicsFont,
CGFloat size,
const CGAffineTransform * _Nullable matrix,
CTFontDescriptorRef _Nullable attributes ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
#ifndef ATSFONTREF_DEFINED
typedef UInt32 ATSFontRef;
#define ATSFONTREF_DEFINED 1
#endif
/*!
@function CTFontGetPlatformFont
@abstract Returns the ATSFontRef and attributes.
@param font
The font reference.
@param attributes
A pointer to a CTFontDescriptorRef to receive a font descriptor containing additional attributes. Can be NULL. Must be released by caller.
@result This function returns a an ATSFontRef for the given font reference. Additional attributes from the font will be passed back as a font descriptor via the attributes parameter.
*/
ATSFontRef CTFontGetPlatformFont(
CTFontRef font,
CTFontDescriptorRef _Nullable * _Nullable attributes ) CT_DEPRECATED("ATS is deprecated", macos(10.5, 11.0)) CT_UNAVAILABLE(ios, watchos, tvos);
/*!
@function CTFontCreateWithPlatformFont
@abstract Creates a new font reference from an ATSFontRef.
@param platformFont
A valid ATSFontRef.
@param size
The point size for the font reference. If 0.0 is specified, the default font size of 12.0 will be used.
@param matrix
The transformation matrix for the font. If unspecified, the identity matrix will be used. Optional.
@param attributes
A CTFontDescriptorRef containing additional attributes that should be matched. Optional.
@result This function returns a new font reference for an ATSFontRef with the specified size, matrix, and additional attributes.
*/
CTFontRef _Nullable CTFontCreateWithPlatformFont(
ATSFontRef platformFont,
CGFloat size,
const CGAffineTransform * _Nullable matrix,
CTFontDescriptorRef _Nullable attributes ) CT_DEPRECATED("ATS is deprecated", macos(10.5, 11.0)) CT_UNAVAILABLE(ios, watchos, tvos);
/*!
@function CTFontCreateWithQuickdrawInstance
@abstract Returns a font reference for the given Quickdraw instance.
@discussion This function is provided for compatibility support between Core Text and clients needing to support Quickdraw font references.
@param name
The Quickdraw font name. If NULL or zero length, an identifier must be specified instead.
@param identifier
The Quickdraw font identifier. If 0, a name must be specified instead.
@param style
The Quickdraw font style.
@param size
The point size for the font reference. If 0.0 is specified, the default size of 12.0 is used.
@result This function returns the best font instance matching the Quickdraw instance information.
*/
CTFontRef CTFontCreateWithQuickdrawInstance(
ConstStr255Param _Nullable name,
int16_t identifier,
uint8_t style,
CGFloat size ) CT_DEPRECATED("Quickdraw font references are deprecated", macos(10.5, 10.15)) CT_UNAVAILABLE(ios, watchos, tvos);
/*! --------------------------------------------------------------------------
@group Font Tables
*///--------------------------------------------------------------------------
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wfour-char-constants"
enum {
kCTFontTableBASE = 'BASE', // Baseline data
kCTFontTableCBDT = 'CBDT', // Color bitmap data
kCTFontTableCBLC = 'CBLC', // Color bitmap location data
kCTFontTableCFF = 'CFF ', // Compact Font Format 1.0
kCTFontTableCFF2 = 'CFF2', // Compact Font Format 2.0
kCTFontTableCOLR = 'COLR', // Color table
kCTFontTableCPAL = 'CPAL', // Color palette table
kCTFontTableDSIG = 'DSIG', // Digital signature
kCTFontTableEBDT = 'EBDT', // Embedded bitmap data
kCTFontTableEBLC = 'EBLC', // Embedded bitmap location data
kCTFontTableEBSC = 'EBSC', // Embedded bitmap scaling data
kCTFontTableGDEF = 'GDEF', // Glyph definition data
kCTFontTableGPOS = 'GPOS', // Glyph positioning data
kCTFontTableGSUB = 'GSUB', // Glyph substitution data
kCTFontTableHVAR = 'HVAR', // Horizontal metrics variations
kCTFontTableJSTF = 'JSTF', // Justification data
kCTFontTableLTSH = 'LTSH', // Linear threshold data
kCTFontTableMATH = 'MATH', // Math layout data
kCTFontTableMERG = 'MERG', // Merge
kCTFontTableMVAR = 'MVAR', // Metrics variations
kCTFontTableOS2 = 'OS/2', // OS/2 and Windows specific metrics
kCTFontTablePCLT = 'PCLT', // PCL 5 data
kCTFontTableSTAT = 'STAT', // Style attributes
kCTFontTableSVG = 'SVG ', // Scalable vector graphics
kCTFontTableVDMX = 'VDMX', // Vertical device metrics
kCTFontTableVORG = 'VORG', // Vertical origin
kCTFontTableVVAR = 'VVAR', // Vertical metrics variations
kCTFontTableZapf = 'Zapf', // Glyph reference
kCTFontTableAcnt = 'acnt', // Accent attachment
kCTFontTableAnkr = 'ankr', // Anchor points
kCTFontTableAvar = 'avar', // Axis variations
kCTFontTableBdat = 'bdat', // Bitmap data
kCTFontTableBhed = 'bhed', // Bitmap font header
kCTFontTableBloc = 'bloc', // Bitmap location
kCTFontTableBsln = 'bsln', // Baseline
kCTFontTableCidg = 'cidg', // CID to glyph mapping
kCTFontTableCmap = 'cmap', // Character to glyph mapping
kCTFontTableCvar = 'cvar', // CVT variations
kCTFontTableCvt = 'cvt ', // Control value table
kCTFontTableFdsc = 'fdsc', // Font descriptor
kCTFontTableFeat = 'feat', // Layout feature
kCTFontTableFmtx = 'fmtx', // Font metrics
kCTFontTableFond = 'fond', // 'FOND' and 'NFNT' data
kCTFontTableFpgm = 'fpgm', // Font program
kCTFontTableFvar = 'fvar', // Font variations
kCTFontTableGasp = 'gasp', // Grid-fitting/scan-conversion
kCTFontTableGlyf = 'glyf', // Glyph data
kCTFontTableGvar = 'gvar', // Glyph variations
kCTFontTableHdmx = 'hdmx', // Horizontal device metrics
kCTFontTableHead = 'head', // Font header
kCTFontTableHhea = 'hhea', // Horizontal header
kCTFontTableHmtx = 'hmtx', // Horizontal metrics
kCTFontTableHsty = 'hsty', // Horizontal style
kCTFontTableJust = 'just', // Justification
kCTFontTableKern = 'kern', // Kerning
kCTFontTableKerx = 'kerx', // Extended kerning
kCTFontTableLcar = 'lcar', // Ligature caret
kCTFontTableLoca = 'loca', // Index to location
kCTFontTableLtag = 'ltag', // Language tags
kCTFontTableMaxp = 'maxp', // Maximum profile
kCTFontTableMeta = 'meta', // Metadata
kCTFontTableMort = 'mort', // Morph
kCTFontTableMorx = 'morx', // Extended morph
kCTFontTableName = 'name', // Naming table
kCTFontTableOpbd = 'opbd', // Optical bounds
kCTFontTablePost = 'post', // PostScript information
kCTFontTablePrep = 'prep', // CVT program
kCTFontTableProp = 'prop', // Properties
kCTFontTableSbit = 'sbit', // Bitmap data
kCTFontTableSbix = 'sbix', // Standard bitmap graphics
kCTFontTableTrak = 'trak', // Tracking
kCTFontTableVhea = 'vhea', // Vertical header
kCTFontTableVmtx = 'vmtx', // Vertical metrics
kCTFontTableXref = 'xref' // Cross-reference
};
typedef FourCharCode CTFontTableTag;
#pragma clang diagnostic pop
typedef CF_OPTIONS(uint32_t, CTFontTableOptions) {
kCTFontTableOptionNoOptions = 0,
kCTFontTableOptionExcludeSynthetic CT_ENUM_DEPRECATED("Unsupported", macos(10.5, 10.8), ios(3.2, 6.0)) CT_ENUM_UNAVAILABLE(watchos, tvos) = (1 << 0)
};
/*!
@function CTFontCopyAvailableTables
@abstract Returns an array of font table tags.
@param font
The font reference.
@param options
The options used when copying font tables.
@result This function returns an array of CTFontTableTag values for the given font and the supplied options. The returned set will contain unboxed values, which may be extracted like so:
<code>CTFontTableTag tag = (CTFontTableTag)(uintptr_t)CFArrayGetValueAtIndex(tags, index);</code>
*/
CFArrayRef _Nullable CTFontCopyAvailableTables(
CTFontRef font,
CTFontTableOptions options ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontCopyTable
@abstract Returns a reference to the font table data.
@param font
The font reference.
@param table
The font table identifier as a CTFontTableTag.
@param options
The options used when copying font table.
@result This function returns a retained reference to the font table data as CFDataRef or NULL if the table is not present.
*/
CFDataRef _Nullable CTFontCopyTable(
CTFontRef font,
CTFontTableTag table,
CTFontTableOptions options ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontDrawGlyphs
@abstract Renders the given glyphs from the CTFont at the given positions in the CGContext.
@discussion This function will modify the CGContext's font, text size, and text matrix if specified in the CTFont. These attributes will not be restored.
The given glyphs should be the result of proper Unicode text layout operations (such as CTLine). Results from CTFontGetGlyphsForCharacters (or similar APIs) do not perform any Unicode text layout.
@param font
The font to render glyphs from. If the font has a size or matrix attribute, the CGContext will be set with these values.
@param glyphs
The glyphs to be rendered. See above discussion of how the glyphs should be derived.
@param positions
The positions (origins) for each glyph. The positions are in user space. The number of positions passed in must be equivalent to the number of glyphs.
@param count
The number of glyphs to be rendered from the glyphs array.
@param context
CGContext used to render the glyphs.
*/
void CTFontDrawGlyphs(
CTFontRef font,
const CGGlyph glyphs[_Nonnull],
const CGPoint positions[_Nonnull],
size_t count,
CGContextRef context ) CT_AVAILABLE(macos(10.7), ios(4.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontGetLigatureCaretPositions
@abstract Returns caret positions within a glyph.
@discussion This function is used to obtain caret positions for a specific glyph.
The return value is the max number of positions possible, and the function
will populate the caller's positions buffer with available positions if possible.
This function may not be able to produce positions if the font does not
have the appropriate data, in which case it will return 0.
@param font
The font reference.
@param glyph
The glyph.
@param positions
A buffer of at least maxPositions to receive the ligature caret positions for
the glyph.
@param maxPositions
The maximum number of positions to return.
@result Returns the number of caret positions for the specified glyph.
*/
CFIndex CTFontGetLigatureCaretPositions(
CTFontRef font,
CGGlyph glyph,
CGFloat positions[_Nullable],
CFIndex maxPositions ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*! --------------------------------------------------------------------------
@group Baseline Alignment
*///--------------------------------------------------------------------------
/*!
@defined kCTBaselineClassRoman
@abstract Key to reference the Roman baseline class.
@discussion This key can be used with a baseline info dictionary to offset to the Roman baseline as a CFNumberRef float. It can also be used as the value for kCTBaselineClassAttributeName.
*/
CT_EXPORT const CFStringRef kCTBaselineClassRoman CT_AVAILABLE(macos(10.8), ios(6.0), watchos(2.0), tvos(9.0));
/*!
@defined kCTBaselineClassIdeographicCentered
@abstract Key to reference the Ideographic Centered baseline class.
@discussion This key can be used with a baseline info dictionary to offset to the Ideographic Centered baseline as a CFNumberRef float. It can also be used as the value for kCTBaselineClassAttributeName.
*/
CT_EXPORT const CFStringRef kCTBaselineClassIdeographicCentered CT_AVAILABLE(macos(10.8), ios(6.0), watchos(2.0), tvos(9.0));
/*!
@defined kCTBaselineClassIdeographicLow
@abstract Key to reference the Ideographic Low baseline class.
@discussion This key can be used with a baseline info dictionary to offset to the Ideographic Low baseline as a CFNumberRef float. It can also be used as the value for kCTBaselineClassAttributeName.
*/
CT_EXPORT const CFStringRef kCTBaselineClassIdeographicLow CT_AVAILABLE(macos(10.8), ios(6.0), watchos(2.0), tvos(9.0));
/*!
@defined kCTBaselineClassIdeographicHigh
@abstract Key to reference the Ideographic High baseline class.
@discussion This key can be used with a baseline info dictionary to offset to the Ideographic High baseline as a CFNumberRef float. It can also be used as the value for kCTBaselineClassAttributeName.
*/
CT_EXPORT const CFStringRef kCTBaselineClassIdeographicHigh CT_AVAILABLE(macos(10.8), ios(6.0), watchos(2.0), tvos(9.0));
/*!
@defined kCTBaselineClassHanging
@abstract Key to reference the Hanging baseline class.
@discussion This key can be used with a baseline info dictionary to offset to the Hanging baseline as a CFNumberRef float. It can also be used as the value for kCTBaselineClassAttributeName.
*/
CT_EXPORT const CFStringRef kCTBaselineClassHanging CT_AVAILABLE(macos(10.8), ios(6.0), watchos(2.0), tvos(9.0));
/*!
@defined kCTBaselineClassMath
@abstract Key to reference the Math baseline class.
@discussion This key can be used with a baseline info dictionary to offset to the Math baseline as a CFNumberRef float. It can also be used as the value for kCTBaselineClassAttributeName.
*/
CT_EXPORT const CFStringRef kCTBaselineClassMath CT_AVAILABLE(macos(10.8), ios(6.0), watchos(2.0), tvos(9.0));
/*!
@defined kCTBaselineReferenceFont
@abstract Key to reference a font for the reference baseline.
@discussion This key can be used to specify a font for the reference baseline. The value is a CTFontRef or the kCTBaselineOriginalFont constant.
*/
CT_EXPORT const CFStringRef kCTBaselineReferenceFont CT_AVAILABLE(macos(10.8), ios(6.0), watchos(2.0), tvos(9.0));
/*!
@defined kCTBaselineOriginalFont
@abstract Use the original font for setting the reference baseline.
@discussion This constant can be used as the value for kCTBaselineReferenceFont to specify that the original font should be used for the reference baseline.
*/
CT_EXPORT const CFStringRef kCTBaselineOriginalFont CT_AVAILABLE(macos(10.8), ios(6.0), watchos(2.0), tvos(9.0));
/*!
@function CTFontCopyDefaultCascadeListForLanguages
@abstract Return an ordered list of CTFontDescriptorRef's for font fallback derived from the system default fallback region according to the given language preferences. The style of the given is also matched as well as the weight and width of the font is not one of the system UI font, otherwise the UI font fallback is applied.
@param font
The font reference.
@param languagePrefList
The language preference list - ordered array of CFStringRef's of ISO language codes.
@result The ordered list of fallback fonts - ordered array of CTFontDescriptors.
*/
CFArrayRef _Nullable CTFontCopyDefaultCascadeListForLanguages( CTFontRef font, CFArrayRef _Nullable languagePrefList ) CT_AVAILABLE(macos(10.8), ios(6.0), watchos(2.0), tvos(9.0));
CF_ASSUME_NONNULL_END
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework/Headers/CTFontDescriptor.h | /*
* CTFontDescriptor.h
* CoreText
*
* Copyright (c) 2006-2020 Apple Inc. All rights reserved.
*
*/
/*!
@header
Thread Safety Information
All functions in this header are thread safe unless otherwise specified.
*/
#ifndef __CTFONTDESCRIPTOR__
#define __CTFONTDESCRIPTOR__
#include <CoreText/CTFontTraits.h>
#include <CoreGraphics/CoreGraphics.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
CF_ASSUME_NONNULL_BEGIN
/*! --------------------------------------------------------------------------
@group Descriptor Types
*///--------------------------------------------------------------------------
/*!
@typedef CTFontDescriptorRef
@abstract The Core Text Font Descriptor reference.
@discussion This is a opaque reference to a font descriptor.
*/
#if TARGET_OS_IPHONE
typedef const struct CF_BRIDGED_TYPE(UIFontDescriptor) __CTFontDescriptor * CTFontDescriptorRef;
#else
typedef const struct CF_BRIDGED_TYPE(NSFontDescriptor) __CTFontDescriptor * CTFontDescriptorRef;
#endif
/*!
@function CTFontDescriptorGetTypeID
@abstract Returns the type identifier for Core Text font descriptor
references.
@result The identifier for the opaque type CTFontDescriptorRef.
*/
CFTypeID CTFontDescriptorGetTypeID( void ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*! --------------------------------------------------------------------------
@group Descriptor Constants
*///--------------------------------------------------------------------------
/*!
@defined kCTFontURLAttribute
@abstract The font URL.
@discussion This is the key for accessing the font URL from the font descriptor. The value associated with this key is a CFURLRef.
*/
CT_EXPORT const CFStringRef kCTFontURLAttribute CT_AVAILABLE(macos(10.6), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontNameAttribute
@abstract The PostScript name.
@discussion This is the key for retrieving the PostScript name from the font descriptor. When matching, this is treated more generically: the system first tries to find fonts with this PostScript name. If none is found, the system tries to find fonts with this family name, and, finally, if still nothing, tries to find fonts with this display name. The value associated with this key is a CFStringRef. If unspecified, defaults to "Helvetica", if unavailable falls back to global font cascade list.
*/
CT_EXPORT const CFStringRef kCTFontNameAttribute CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontDisplayNameAttribute
@abstract The display name.
@discussion This is the key for accessing the name used to display the font. Most commonly this is the full name. The value associated with this key is a CFStringRef.
*/
CT_EXPORT const CFStringRef kCTFontDisplayNameAttribute CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontFamilyNameAttribute
@abstract The family name.
@discussion This is the key for accessing the family name from the font descriptor. The value associated with this key is a CFStringRef.
*/
CT_EXPORT const CFStringRef kCTFontFamilyNameAttribute CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontStyleNameAttribute
@abstract The style name.
@discussion This is the key for accessing the style name of the font. This name represents the designer's description of the font's style. The value associated with this key is a CFStringRef.
*/
CT_EXPORT const CFStringRef kCTFontStyleNameAttribute CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontTraitsAttribute
@abstract The font traits dictionary.
@discussion This is the key for accessing the dictionary of font traits for stylistic information. See CTFontTraits.h for the list of font traits. The value associated with this key is a CFDictionaryRef.
*/
CT_EXPORT const CFStringRef kCTFontTraitsAttribute CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontVariationAttribute
@abstract The font variation dictionary.
@discussion This key is used to obtain the font variation instance as a CFDictionaryRef. If specified in a font descriptor, fonts with the specified axes will be primary match candidates, if no such fonts exist, this attribute will be ignored.
*/
CT_EXPORT const CFStringRef kCTFontVariationAttribute CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontVariationAxesAttribute
@discussion An array of variation axis dictionaries or null if the font does not support variations. Each variation axis dictionary contains the five kCTFontVariationAxis* keys.
*/
CT_EXPORT const CFStringRef kCTFontVariationAxesAttribute CT_AVAILABLE(macos(10.13), ios(11.0), watchos(4.0), tvos(11.0));
/*!
@defined kCTFontSizeAttribute
@abstract The font point size.
@discussion This key is used to obtain or specify the font point size. Creating a font with this unspecified will default to a point size of 12.0. The value for this key is represented as a CFNumberRef.
*/
CT_EXPORT const CFStringRef kCTFontSizeAttribute CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontMatrixAttribute
@abstract The font transformation matrix.
@discussion This key is used to specify the font transformation matrix when creating a font. The default value is CGAffineTransformIdentity. The value for this key is a CFDataRef containing a CGAffineTransform, of which only the a, b, c, and d fields are used.
*/
CT_EXPORT const CFStringRef kCTFontMatrixAttribute CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontCascadeListAttribute
@abstract The font cascade list.
@discussion This key is used to specify or obtain the cascade list used for a font reference. The cascade list is a CFArrayRef containing CTFontDescriptorRefs. If unspecified, the global cascade list is used. This list is not consulted for private-use characters on OS X 10.10, iOS 8, or earlier.
*/
CT_EXPORT const CFStringRef kCTFontCascadeListAttribute CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontCharacterSetAttribute
@abstract The font Unicode character coverage set.
@discussion The value for this key is a CFCharacterSetRef. Creating a font with this attribute will restrict the font to a subset of its actual character set.
*/
CT_EXPORT const CFStringRef kCTFontCharacterSetAttribute CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontLanguagesAttribute
@abstract The list of supported languages.
@discussion The value for this key is a CFArrayRef of CFStringRef language identifiers conforming to UTS #35. It can be requested from any font. If present in a descriptor used for matching, only fonts supporting the specified languages will be returned.
*/
CT_EXPORT const CFStringRef kCTFontLanguagesAttribute CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontBaselineAdjustAttribute
@abstract The baseline adjustment to apply to font metrics.
@discussion The value for this key is a floating-point CFNumberRef. This is primarily used when defining font descriptors for a cascade list to keep the baseline of all fonts even.
*/
CT_EXPORT const CFStringRef kCTFontBaselineAdjustAttribute CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontMacintoshEncodingsAttribute
@abstract The Macintosh encodings (legacy script codes).
@discussion The value associated with this key is a CFNumberRef containing a bitfield of the script codes in <CoreText/SFNTTypes.h>; bit 0 corresponds to kFontRomanScript, and so on. This attribute is provided for legacy compatibility.
*/
CT_EXPORT const CFStringRef kCTFontMacintoshEncodingsAttribute CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontFeaturesAttribute
@abstract The array of font features.
@discussion This key is used to specify or obtain the font features for a font reference. The value associated with this key is a CFArrayRef of font feature dictionaries. This features list contains the feature information from the 'feat' table of the font. See the CTFontCopyFeatures() API in CTFont.h.
*/
CT_EXPORT const CFStringRef kCTFontFeaturesAttribute CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontFeatureSettingsAttribute
@abstract The array of typographic feature settings.
@discussion This key is used to specify an array of zero or more feature settings. Each setting dictionary indicates which setting should be applied. In the case of duplicate or conflicting settings the last setting in the list will take precedence. In the case of AAT settings, it is the caller's responsibility to handle exclusive and non-exclusive settings as necessary.
An AAT setting dictionary contains a tuple of a kCTFontFeatureTypeIdentifierKey key-value pair and a kCTFontFeatureSelectorIdentifierKey key-value pair.
An OpenType setting dictionary contains a tuple of a kCTFontOpenTypeFeatureTag key-value pair and a kCTFontOpenTypeFeatureValue key-value pair.
Starting with OS X 10.10 and iOS 8.0, settings are also accepted (but not returned) in the following simplified forms:
An OpenType setting can be either an array pair of tag string and value number, or a tag string on its own. For example: @[ @"c2sc", @1 ] or simply @"c2sc". An unspecified value enables the feature and a value of zero disables it.
An AAT setting can be specified as an array pair of type and selector numbers. For example: @[ @(kUpperCaseType), @(kUpperCaseSmallCapsSelector) ].
*/
CT_EXPORT const CFStringRef kCTFontFeatureSettingsAttribute CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontFixedAdvanceAttribute
@abstract Specifies advance width.
@discussion This key is used to specify a constant advance width, which affects the glyph metrics of any font instance created with this key; it overrides font values and the font transformation matrix, if any. The value associated with this key must be a CFNumberRef.
Starting with macOS 10.14 and iOS 12.0, this only affects glyph advances that have non-zero width when this attribute is not present.
*/
CT_EXPORT const CFStringRef kCTFontFixedAdvanceAttribute CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontOrientationAttribute
@abstract The orientation attribute.
@discussion This key is used to specify a particular orientation for the glyphs of the font. The value associated with this key is a int as a CFNumberRef. If you want to receive vertical metrics from a font for vertical rendering, specify kCTFontVerticalOrientation. If unspecified, the font will use its native orientation.
*/
CT_EXPORT const CFStringRef kCTFontOrientationAttribute CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@enum CTFontOrientation
@abstract Specifies the intended rendering orientation of the font for obtaining glyph metrics.
*/
typedef CF_ENUM(uint32_t, CTFontOrientation) {
kCTFontOrientationDefault = 0,
kCTFontOrientationHorizontal = 1,
kCTFontOrientationVertical = 2,
kCTFontDefaultOrientation CT_ENUM_DEPRECATED("Deprecated", macos(10.5, 10.11), ios(3.2, 9.0)) CT_ENUM_UNAVAILABLE(watchos, tvos)
= kCTFontOrientationDefault,
kCTFontHorizontalOrientation CT_ENUM_DEPRECATED("Deprecated", macos(10.5, 10.11), ios(3.2, 9.0)) CT_ENUM_UNAVAILABLE(watchos, tvos)
= kCTFontOrientationHorizontal,
kCTFontVerticalOrientation CT_ENUM_DEPRECATED("Deprecated", macos(10.5, 10.11), ios(3.2, 9.0)) CT_ENUM_UNAVAILABLE(watchos, tvos)
= kCTFontOrientationVertical
};
/*!
@defined kCTFontFormatAttribute
@abstract Specifies the recognized format of the font.
@discussion The attribute is used to specify or obtain the format of the font. The returned value is a CFNumber containing one of the constants defined below.
*/
CT_EXPORT const CFStringRef kCTFontFormatAttribute CT_AVAILABLE(macos(10.6), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@constant kCTFontFormatUnrecognized
The font is not a recognized format
@constant kCTFontFormatOpenTypePostScript
The font is an OpenType format containing PostScript data
@constant kCTFontFormatOpenTypeTrueType
The font is an OpenType format containing TrueType data
@constant kCTFontFormatTrueType
The font is a recognized TrueType format
@constant kCTFontFormatPostScript
The font is a recognized PostScript format
@constant kCTFontFormatBitmap
The font is a bitmap only format
*/
typedef CF_ENUM(uint32_t, CTFontFormat) {
kCTFontFormatUnrecognized = 0,
kCTFontFormatOpenTypePostScript = 1,
kCTFontFormatOpenTypeTrueType = 2,
kCTFontFormatTrueType = 3,
kCTFontFormatPostScript = 4,
kCTFontFormatBitmap = 5
};
/*!
@defined kCTFontRegistrationScopeAttribute
@abstract Specifies the font descriptor's registration scope.
@discussion The attribute is used to specify or obtain the font registration scope. The value returned is a CFNumberRef containing one of the CTFontManagerScope enumerated values. A value of NULL can be returned for font descriptors that are not registered.
*/
CT_EXPORT const CFStringRef kCTFontRegistrationScopeAttribute CT_AVAILABLE(macos(10.6), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontPriorityAttribute
@abstract The font descriptors priority when resolving duplicates and sorting match results.
@discussion This key is used to obtain or specify the font priority. The value returned is a CFNumberRef containing an integer value as defined below. The higher the value, the higher the priority of the font. Only registered fonts will have a priority. Unregistered font descriptors will return NULL.
*/
CT_EXPORT const CFStringRef kCTFontPriorityAttribute CT_AVAILABLE(macos(10.6), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@constant kCTFontPrioritySystem
Priority of system fonts (located in /System/Library/Fonts).
@constant kCTFontPriorityNetwork
Priority of network fonts (located in /Network/Library/Fonts).
@constant kCTFontPriorityComputer
Priority of computer local fonts (located in /Library/Fonts).
@constant kCTFontPriorityUser
Priority of local fonts (located in user's Library/Fonts).
@constant kCTFontPriorityDynamic
Priority of fonts registered dynamically, not located in a standard location (either kCTFontManagerScopeUser, or kCTFontManagerScopeSession).
@constant kCTFontPriorityProcess
Priority of fonts registered for the process (kCTFontManagerScopeProcess).
*/
enum {
kCTFontPrioritySystem = 10000,
kCTFontPriorityNetwork = 20000,
kCTFontPriorityComputer = 30000,
kCTFontPriorityUser = 40000,
kCTFontPriorityDynamic = 50000,
kCTFontPriorityProcess = 60000
};
typedef uint32_t CTFontPriority;
/*!
@defined kCTFontEnabledAttribute
@abstract The font enabled state.
@discussion The value associated with this key is a CFBoolean. Unregistered font descriptors will return NULL, which is equivalent to false.
*/
CT_EXPORT const CFStringRef kCTFontEnabledAttribute CT_AVAILABLE(macos(10.6), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontDownloadableAttribute
@abstract The font downloadable state.
@discussion The value associated with this key is a CFBoolean. If it is true, CoreText attempts to download a font if necessary when matching a descriptor.
*/
CT_EXPORT const CFStringRef kCTFontDownloadableAttribute CT_AVAILABLE(macos(10.8), ios(6.0), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontDownloadedAttribute
@abstract The download state.
@discussion The value associated with this key is a CFBoolean. If it is true, corresponding FontAsset has been downloaded. (but still it may be necessary to call appropriate API in order to use the font in the FontAsset.)
*/
CT_EXPORT const CFStringRef kCTFontDownloadedAttribute CT_AVAILABLE(macos(10.12), ios(7.0), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontOpticalSizeAttribute
@abstract The point size at which this font is intended to be used.
@discussion The value is a CFNumber used to activate size-specific (not linearly scaled) metrics. Starting with macOS 10.14 and iOS 12.0, the CFString "auto" can be used instead to request an optical size matching the point size. Starting with macOS 10.15 and iOS 13.0, the CFString "none" can be used instead to explicitly disable automatic optical sizing enabled by the font.
*/
CT_EXPORT const CFStringRef kCTFontOpticalSizeAttribute CT_AVAILABLE(macos(10.9), ios(7.0), watchos(2.0), tvos(9.0));
/*! --------------------------------------------------------------------------
@group Descriptor Creation
*///--------------------------------------------------------------------------
/*!
@function CTFontDescriptorCreateWithNameAndSize
@abstract Creates a new font descriptor with the provided PostScript name and size.
@param name
The PostScript name to be used for the font descriptor as a CFStringRef. Any font name beginning with a "." is reserved for the system and should not be used here.
@param size
The point size. If 0.0, the kCTFontSizeAttribute will be omitted from the font descriptor.
@result This function creates a new font descriptor reference with the given PostScript name and point size.
@discussion If you are trying to create a system UI font descriptor (with name beginning with a "."), you should create a font with CTFontCreateUIFontForLanguage() or appropriate AppKit/UIKit APIs instead, then use CTFontCopyFontDescriptor() to get its font descriptor.
*/
CTFontDescriptorRef CTFontDescriptorCreateWithNameAndSize(
CFStringRef name,
CGFloat size ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontDescriptorCreateWithAttributes
@abstract Creates a new font descriptor reference from a dictionary of attributes.
@param attributes
A CFDictionaryRef of arbitrary attributes.
@result This function creates a new font descriptor with the attributes specified. This dictionary can contain arbitrary attributes that will be preserved, however unrecognized attributes will be ignored on font creation and and may not be preserved over the round trip (descriptor -> font -> descriptor).
*/
CTFontDescriptorRef CTFontDescriptorCreateWithAttributes(
CFDictionaryRef attributes ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontDescriptorCreateCopyWithAttributes
@abstract Creates a copy of the original font descriptor with new attributes.
@param original
The original font descriptor reference.
@param attributes
A CFDictionaryRef of arbitrary attributes.
@result This function creates a new copy of the original font descriptor with attributes augmented by those specified. If there are conflicts between attributes, the new attributes will replace existing ones, except for kCTFontVariationAttribute and kCTFontFeatureSettingsAttribute which will be merged.
Starting with macOS 10.12 and iOS 10.0, setting the value of kCTFontFeatureSettingsAttribute to kCFNull will clear the feature settings of the original font descriptor. Setting the value of any individual feature settings pair in the kCTFontFeatureSettingsAttribute value array to kCFNull will clear that feature setting alone. For example, an element like @{ (id)kCTFontFeatureTypeIdentifierKey: @(kLigaturesType), (id)kCTFontFeatureSelectorIdentifierKey: (id)kCFNull } means clear the kLigatureType feature set in the original font descriptor. An element like @[ @"liga", (id)kCFNull ] will have the same effect.
*/
CTFontDescriptorRef CTFontDescriptorCreateCopyWithAttributes(
CTFontDescriptorRef original,
CFDictionaryRef attributes ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontCreateCopyWithFamily
@abstract Returns a new font descriptor in the specified family based on the traits of the original descriptor.
@param original
The original font descriptor reference.
@param family
The name of the desired family.
@result Returns a new font reference with the original traits in the given family, or NULL if none found in the system.
*/
CTFontDescriptorRef _Nullable CTFontDescriptorCreateCopyWithFamily(
CTFontDescriptorRef original,
CFStringRef family ) CT_AVAILABLE(macos(10.9), ios(7.0), watchos(2.0), tvos(9.0));
/*!
@function CTFontDescriptorCreateCopyWithSymbolicTraits
@abstract Returns a new font descriptor based on the original descriptor having the specified symbolic traits.
@param original
The original font descriptor reference.
@param symTraitValue
The value of the symbolic traits. This bitfield is used to indicate the desired value for the traits specified by the symTraitMask parameter. Used in conjunction, they can allow for trait removal as well as addition.
@param symTraitMask
The mask bits of the symbolic traits. This bitfield is used to indicate the traits that should be changed.
@result Returns a new font descriptor reference in the same family with the given symbolic traits, or NULL if none found in the system.
*/
CTFontDescriptorRef _Nullable CTFontDescriptorCreateCopyWithSymbolicTraits(
CTFontDescriptorRef original,
CTFontSymbolicTraits symTraitValue,
CTFontSymbolicTraits symTraitMask ) CT_AVAILABLE(macos(10.9), ios(7.0), watchos(2.0), tvos(9.0));
/*!
@function CTFontDescriptorCreateCopyWithVariation
@abstract Creates a copy of the original font descriptor with a new variation instance.
@param original
The original font descriptor reference.
@param variationIdentifier
The variation axis identifier. This is the four character code of the variation axis as a CFNumberRef.
@param variationValue
The value corresponding with the variation instance.
@result This function returns a copy of the original font descriptor with a new variation instance. This is a convenience method for easily creating new variation font instances.
*/
CTFontDescriptorRef CTFontDescriptorCreateCopyWithVariation(
CTFontDescriptorRef original,
CFNumberRef variationIdentifier,
CGFloat variationValue ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontDescriptorCreateCopyWithFeature
@abstract Copies a font descriptor with new feature setting.
@discussion This is a convenience method to more easily toggle the state of individual features.
@param original
The original font descriptor reference.
@param featureTypeIdentifier
The feature type identifier.
@param featureSelectorIdentifier
The feature selector identifier.
@result A copy of the original font descriptor modified with the given feature settings.
*/
CTFontDescriptorRef CTFontDescriptorCreateCopyWithFeature(
CTFontDescriptorRef original,
CFNumberRef featureTypeIdentifier,
CFNumberRef featureSelectorIdentifier ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontDescriptorCreateMatchingFontDescriptors
@abstract Returns an array of font normalized font descriptors matching the provided descriptor.
@param descriptor
The font descriptor reference.
@param mandatoryAttributes
A set of attribute keys which are required to be identically matched in any returned font descriptors. Optional.
@result This function returns a retained array of normalized font descriptors matching the attributes present in descriptor. If descriptor itself is normalized then the array will contain only one item, the original descriptor.
*/
CFArrayRef _Nullable CTFontDescriptorCreateMatchingFontDescriptors(
CTFontDescriptorRef descriptor,
CFSetRef _Nullable mandatoryAttributes ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontDescriptorCreateMatchingFontDescriptor
@abstract Returns an the single preferred matching font descriptor based on the original descriptor and system precedence.
@param descriptor
The font descriptor reference.
@param mandatoryAttributes
A set of attribute keys which are required to be identically matched in any returned font descriptors. Optional.
@result This function returns a retained normalized font descriptor matching the attributes present in descriptor. The original descriptor may be returned in normalized form.
*/
CTFontDescriptorRef _Nullable CTFontDescriptorCreateMatchingFontDescriptor(
CTFontDescriptorRef descriptor,
CFSetRef _Nullable mandatoryAttributes ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
Progress state
*/
typedef CF_ENUM(uint32_t, CTFontDescriptorMatchingState) {
kCTFontDescriptorMatchingDidBegin, // called once at the beginning.
kCTFontDescriptorMatchingDidFinish, // called once at the end.
kCTFontDescriptorMatchingWillBeginQuerying, // called once before talking to the server. Skipped if not necessary.
kCTFontDescriptorMatchingStalled, // called when stalled. (e.g. while waiting for server response.)
// Downloading and activating are repeated for each descriptor.
kCTFontDescriptorMatchingWillBeginDownloading, // Downloading part may be skipped if all the assets are already downloaded
kCTFontDescriptorMatchingDownloading,
kCTFontDescriptorMatchingDidFinishDownloading,
kCTFontDescriptorMatchingDidMatch, // called when font descriptor is matched.
kCTFontDescriptorMatchingDidFailWithError // called when an error occurred. (may be called multiple times.)
};
/*!
keys for progressParameter dictionary.
*/
/* CTFontDescriptorRef; The current font descriptor. Valid when state is kCTFontDescriptorMatchingDidMatch. */
CT_EXPORT const CFStringRef kCTFontDescriptorMatchingSourceDescriptor CT_AVAILABLE(macos(10.8), ios(6.0), watchos(2.0), tvos(9.0));
/* CFArray; Array of descriptors to be queried. Valid while downloading or when state is kCTFontDescriptorMatchingWillBeginQuerying. */
CT_EXPORT const CFStringRef kCTFontDescriptorMatchingDescriptors CT_AVAILABLE(macos(10.8), ios(6.0), watchos(2.0), tvos(9.0));
/* CFArray; Array of matched font descriptors. Valid when state is kCTFontDescriptorMatchingDidMatch or CTFontDescriptorMatchingEnd. */
CT_EXPORT const CFStringRef kCTFontDescriptorMatchingResult CT_AVAILABLE(macos(10.8), ios(6.0), watchos(2.0), tvos(9.0));
/* CFNumber; Download progress in 0 - 100. Valid during Downloading state. */
CT_EXPORT const CFStringRef kCTFontDescriptorMatchingPercentage CT_AVAILABLE(macos(10.8), ios(6.0), watchos(2.0), tvos(9.0));
/* CFNumber; Byte size to download for the current descriptor. Valid during Downloading state. */
CT_EXPORT const CFStringRef kCTFontDescriptorMatchingCurrentAssetSize CT_AVAILABLE(macos(10.8), ios(6.0), watchos(2.0), tvos(9.0));
/* CFNumber; Total downloaded byte size. Valid during Downloading state. */
CT_EXPORT const CFStringRef kCTFontDescriptorMatchingTotalDownloadedSize CT_AVAILABLE(macos(10.8), ios(6.0), watchos(2.0), tvos(9.0));
/* CFNumber; Total byte size to download. Always valid, but may be Zero when information is not available. */
CT_EXPORT const CFStringRef kCTFontDescriptorMatchingTotalAssetSize CT_AVAILABLE(macos(10.8), ios(6.0), watchos(2.0), tvos(9.0));
/* CFError; Valid when state kCTFontDescriptorMatchingDidFailWithError. */
CT_EXPORT const CFStringRef kCTFontDescriptorMatchingError CT_AVAILABLE(macos(10.8), ios(6.0), watchos(2.0), tvos(9.0));
#if defined(__BLOCKS__)
/* Progress callback type */
typedef bool (^CTFontDescriptorProgressHandler)(CTFontDescriptorMatchingState state, CFDictionaryRef progressParameter);
/*
@function CTFontDescriptorMatchFontDescriptorsWithProgressHandler
This function returns immediately, but can potentially take long time to process. The progress is notified via progressBlock.
@param descriptors
An array of descriptors to process.
@param mandatoryAttributes
@param progressBlock
Callback block to indicate the progress.
Return true to continue, and return false to cancel the process.
This block is called on a private serial queue on OS X 10.15, iOS 13, and later.
@result false if it couldn't start the work.
*/
bool CTFontDescriptorMatchFontDescriptorsWithProgressHandler(
CFArrayRef descriptors,
CFSetRef _Nullable mandatoryAttributes,
CTFontDescriptorProgressHandler progressBlock) CT_AVAILABLE(macos(10.9), ios(6.0), watchos(2.0), tvos(9.0));
#endif // defined(__BLOCKS__)
/*! --------------------------------------------------------------------------
@group Descriptor Accessors
*///--------------------------------------------------------------------------
/*!
@function CTFontDescriptorCopyAttributes
@abstract Returns the attributes dictionary of the font descriptor.
@param descriptor
The font descriptor reference.
@result A retained reference to the font descriptor attributes dictionary. This dictionary will contain the minimum number of attributes to fully specify this particular font descriptor.
*/
CFDictionaryRef CTFontDescriptorCopyAttributes(
CTFontDescriptorRef descriptor ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontDescriptorCopyAttribute
@abstract Returns the value associated with an arbitrary attribute.
@param descriptor
The font descriptor.
@param attribute
The requested attribute.
@result A retained reference to the requested attribute, or NULL if the requested attribute is not present. Refer to the attribute definitions for documentation as to how each attribute is packaged as a CFType.
*/
CFTypeRef _Nullable CTFontDescriptorCopyAttribute(
CTFontDescriptorRef descriptor,
CFStringRef attribute ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
function CTFontDescriptorCopyLocalizedAttribute
@abstract Returns a localized value for the requested attribute if available.
@discussion This function returns a localized attribute based on the global language list. If localization is not possible for the attribute the behavior matches CTFontDescriptorCopyAttribute(). Generally, localization of attributes is only applicable to name attributes of a normalized font descriptor.
@param descriptor
The font descriptor reference.
@param attribute
The requested font attribute.
@param language
If non-NULL, this will be receive a retained reference to the matched language. The language identifier will conform to UTS #35.
If CoreText can supply its own localized string where the font cannot, this value will be NULL.
@result A retained reference to the requested attribute, or NULL if the requested attribute is not present. Refer to the attribute definitions for documentation as to how each attribute is packaged as a CFType.
*/
CFTypeRef _Nullable CTFontDescriptorCopyLocalizedAttribute(
CTFontDescriptorRef descriptor,
CFStringRef attribute,
CFStringRef _Nullable * _Nullable language ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
CF_ASSUME_NONNULL_END
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework/Headers/CTLine.h | /*
* CTLine.h
* CoreText
*
* Copyright (c) 2003-2018 Apple Inc. All rights reserved.
*
*/
/*!
@header
Thread Safety Information
All functions in this header are thread safe unless otherwise specified.
*/
#ifndef __CTLINE__
#define __CTLINE__
#include <CoreText/CTDefines.h>
#include <CoreFoundation/CoreFoundation.h>
#include <CoreGraphics/CoreGraphics.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
CF_ASSUME_NONNULL_BEGIN
/* --------------------------------------------------------------------------- */
/* Line Types */
/* --------------------------------------------------------------------------- */
typedef const struct CF_BRIDGED_TYPE(id) __CTLine * CTLineRef;
/*!
@enum CTLineBoundsOptions
@abstract Options for CTLineGetBoundsWithOptions.
@discussion Passing 0 (no options) returns the typographic bounds,
including typographic leading and shifts.
@constant kCTLineBoundsExcludeTypographicLeading
Pass this option to exclude typographic leading.
@constant kCTLineBoundsExcludeTypographicShifts
Pass this option to ignore cross-stream shifts due to
positioning (such as kerning or baseline alignment).
@constant kCTLineBoundsUseHangingPunctuation
Normally line bounds include all glyphs; pass this option to
treat standard punctuation hanging off either end of the line
as fully hanging.
@constant kCTLineBoundsUseGlyphPathBounds
Pass this option to use glyph path bounds rather than the
default typographic bounds.
@constant kCTLineBoundsUseOpticalBounds
Pass this option to use optical bounds. This option overrides
kCTLineBoundsUseGlyphPathBounds.
@constant kCTLineBoundsIncludeLanguageExtents
Pass this option to include additional space based on common
glyph sequences for various languages. The result is intended
to be used when drawing to avoid clipping that may be caused
by the typographic bounds. This option does not have any effect
when used with kCTLineBoundsUseGlyphPathBounds.
*/
typedef CF_OPTIONS(CFOptionFlags, CTLineBoundsOptions) {
kCTLineBoundsExcludeTypographicLeading = 1 << 0,
kCTLineBoundsExcludeTypographicShifts = 1 << 1,
kCTLineBoundsUseHangingPunctuation = 1 << 2,
kCTLineBoundsUseGlyphPathBounds = 1 << 3,
kCTLineBoundsUseOpticalBounds = 1 << 4,
kCTLineBoundsIncludeLanguageExtents = 1 << 5,
};
/*!
@enum CTLineTruncationType
@abstract Truncation types required by CTLineCreateTruncatedLine. These
will tell truncation engine which type of truncation is being
requested.
@constant kCTLineTruncationStart
Truncate at the beginning of the line, leaving the end portion
visible.
@constant kCTLineTruncationEnd
Truncate at the end of the line, leaving the start portion
visible.
@constant kCTLineTruncationMiddle
Truncate in the middle of the line, leaving both the start
and the end portions visible.
*/
typedef CF_ENUM(uint32_t, CTLineTruncationType) {
kCTLineTruncationStart = 0,
kCTLineTruncationEnd = 1,
kCTLineTruncationMiddle = 2
};
/*!
@function CTLineGetTypeID
@abstract Returns the CFType of the line object
*/
CFTypeID CTLineGetTypeID( void ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/* --------------------------------------------------------------------------- */
/* Line Creation */
/* --------------------------------------------------------------------------- */
/*!
@function CTLineCreateWithAttributedString
@abstract Creates a single immutable line object directly from an
attributed string.
@discussion This will allow clients who need very simple line generation to
create a line without needing to create a typesetter object. The
typesetting will be done under the hood. Without a typesetter
object, the line cannot be properly broken. However, for simple
things like text labels and other things, this is not an issue.
@param attrString
The attributed string which the line will be created for.
@result This function will return a reference to a CTLine object.
*/
CTLineRef CTLineCreateWithAttributedString(
CFAttributedStringRef attrString ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTLineCreateTruncatedLine
@abstract Creates a truncated line from an existing line.
@param line
The line that you want to create a truncated line for.
@param width
The width at which truncation will begin. The line will be
truncated if its width is greater than the width passed in this.
@param truncationType
The type of truncation to perform if needed.
@param truncationToken
This token will be added to the point where truncation took place
to indicate that the line was truncated. Usually, the truncation
token is the ellipsis character (U+2026). If this parameter is
set to NULL, then no truncation token is used, and the line is
simply cut off. The line specified in truncationToken should have
a width less than the width specified by the width parameter. If
the width of the line specified in truncationToken is greater,
this function will return NULL if truncation is needed.
@result This function will return a reference to a truncated CTLine
object if the call was successful. Otherwise, it will return
NULL.
*/
CTLineRef _Nullable CTLineCreateTruncatedLine(
CTLineRef line,
double width,
CTLineTruncationType truncationType,
CTLineRef _Nullable truncationToken ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTLineCreateJustifiedLine
@abstract Creates a justified line from an existing line.
@param line
The line that you want to create a justified line for.
@param justificationFactor
Allows for full or partial justification. When set to 1.0 or
greater indicates, full justification will be performed. If less
than 1.0, varying degrees of partial justification will be
performed. If set to 0 or less, then no justification will be
performed.
@param justificationWidth
The width to which the resultant line will be justified. If
justificationWidth is less than the actual width of the line,
then negative justification will be performed ("text squishing").
@result This function will return a reference to a justified CTLine
object if the call was successful. Otherwise, it will return
NULL.
*/
CTLineRef _Nullable CTLineCreateJustifiedLine(
CTLineRef line,
CGFloat justificationFactor,
double justificationWidth ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/* --------------------------------------------------------------------------- */
/* Line Access */
/* --------------------------------------------------------------------------- */
/*!
@function CTLineGetGlyphCount
@abstract Returns the total glyph count for the line object.
@discussion The total glyph count is equal to the sum of all of the glyphs in
the glyph runs forming the line.
@param line
The line that you want to obtain the glyph count for.
@result The total glyph count for the line passed in.
*/
CFIndex CTLineGetGlyphCount(
CTLineRef line ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTLineGetGlyphRuns
@abstract Returns the array of glyph runs that make up the line object.
@param line
The line that you want to obtain the glyph run array for.
@result A CFArrayRef containing the CTRun objects that make up the line.
*/
CFArrayRef CTLineGetGlyphRuns(
CTLineRef line ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTLineGetStringRange
@abstract Gets the range of characters that originally spawned the glyphs
in the line.
@param line
The line that you want to obtain the string range from.
@result A CFRange that contains the range over the backing store string
that spawned the glyphs. If the function fails for any reason, an
empty range will be returned.
*/
CFRange CTLineGetStringRange(
CTLineRef line ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTLineGetPenOffsetForFlush
@abstract Gets the pen offset required to draw flush text.
@param line
The line that you want to obtain a flush position from.
@param flushFactor
Specifies what kind of flushness you want. A flushFactor of 0 or
less indicates left flush. A flushFactor of 1.0 or more indicates
right flush. Flush factors between 0 and 1.0 indicate varying
degrees of center flush, with a value of 0.5 being totally center
flush.
@param flushWidth
Specifies the width that the flushness operation should apply to.
@result A value which can be used to offset the current pen position for
the flush operation.
*/
double CTLineGetPenOffsetForFlush(
CTLineRef line,
CGFloat flushFactor,
double flushWidth ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTLineDraw
@abstract Draws a line.
@discussion This is a convenience call, since the line could be drawn
run-by-run by getting the glyph runs and accessing the glyphs out
of them. This call may leave the graphics context in any state and
does not flush the context after drawing. This call also expects
a text matrix with `y` values increasing from bottom to top; a
flipped text matrix may result in misplaced diacritics.
@param line
The line that you want to draw.
@param context
The context to which the line will be drawn.
*/
void CTLineDraw(
CTLineRef line,
CGContextRef context ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/* --------------------------------------------------------------------------- */
/* Line Measurement */
/* --------------------------------------------------------------------------- */
/*!
@function CTLineGetTypographicBounds
@abstract Calculates the typographic bounds for a line.
@discussion A line's typographic width is the distance to the rightmost
glyph advance width edge. Note that this distance includes
trailing whitespace glyphs.
@param line
The line that you want to calculate the typographic bounds for.
@param ascent
Upon return, this parameter will contain the ascent of the line.
This may be set to NULL if not needed.
@param descent
Upon return, this parameter will contain the descent of the line.
This may be set to NULL if not needed.
@param leading
Upon return, this parameter will contain the leading of the line.
This may be set to NULL if not needed.
@result The typographic width of the line. If line is invalid, this
function will always return zero.
@seealso CTLineGetTrailingWhitespaceWidth
*/
double CTLineGetTypographicBounds(
CTLineRef line,
CGFloat * _Nullable ascent,
CGFloat * _Nullable descent,
CGFloat * _Nullable leading ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTLineGetBoundsWithOptions
@abstract Calculates the bounds for a line.
@param line
The line that you want to calculate the bounds for.
@param options
Desired options or 0 if none.
@result The bounds of the line as specified by the type and options,
such that the coordinate origin is coincident with the line
origin and the rect origin is at the bottom left. If the line
is invalid this function will return CGRectNull.
*/
CGRect CTLineGetBoundsWithOptions(
CTLineRef line,
CTLineBoundsOptions options ) CT_AVAILABLE(macos(10.8), ios(6.0), watchos(2.0), tvos(9.0));
/*!
@function CTLineGetTrailingWhitespaceWidth
@abstract Calculates the trailing whitespace width for a line.
@param line
The line that you want to calculate the trailing whitespace width
for. Creating a line for a width can result in a line that is
actually longer than the desired width due to trailing
whitespace. Normally this is not an issue due to whitespace being
invisible, but this function may be used to determine what amount
of a line's width is due to trailing whitespace.
@result The width of the line's trailing whitespace. If line is invalid,
this function will always return zero.
*/
double CTLineGetTrailingWhitespaceWidth(
CTLineRef line ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTLineGetImageBounds
@abstract Calculates the image bounds for a line.
@discussion The image bounds for a line is the union of all non-empty glyph
bounding rects, each positioned as it would be if drawn using
CTLineDraw using the current context. Note that the result is
ideal and does not account for raster coverage due to rendering.
This function is purely a convenience for using glyphs as an
image and should not be used for typographic purposes.
@param line
The line that you want to calculate the image bounds for.
@param context
The context which the image bounds will be calculated for or NULL,
in which case the bounds are relative to CGPointZero.
@result A rectangle that tightly encloses the paths of the line's glyphs,
which will be translated by the supplied context's text position.
If the line is invalid, CGRectNull will be returned.
@seealso CTLineGetTypographicBounds
@seealso CTLineGetBoundsWithOptions
@seealso CTLineGetPenOffsetForFlush
*/
CGRect CTLineGetImageBounds(
CTLineRef line,
CGContextRef _Nullable context ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/* --------------------------------------------------------------------------- */
/* Line Caret Positioning and Highlighting */
/* --------------------------------------------------------------------------- */
/*!
@function CTLineGetStringIndexForPosition
@abstract Performs hit testing.
@discussion This function can be used to determine the string index for a
mouse click or other event. This string index corresponds to the
character before which the next character should be inserted.
This determination is made by analyzing the string from which a
typesetter was created and the corresponding glyphs as embodied
by a particular line.
@param line
The line being examined.
@param position
The location of the mouse click relative to the line's origin.
@result The string index for the position. Relative to the line's string
range, this value will be no less than the first string index and
no greater than one plus the last string index. In the event of
failure, this function will return kCFNotFound.
*/
CFIndex CTLineGetStringIndexForPosition(
CTLineRef line,
CGPoint position ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTLineGetOffsetForStringIndex
@abstract Determines the graphical offset(s) for a string index.
@discussion This function returns the graphical offset(s) corresponding to
a string index, suitable for movement between adjacent lines or
for drawing a custom caret. For the former, the primary offset
may be adjusted for any relative indentation of the two lines;
a CGPoint constructed with the adjusted offset for its x value
and 0.0 for its y value is suitable for passing to
CTLineGetStringIndexForPosition. In either case, the primary
offset corresponds to the portion of the caret that represents
the visual insertion location for a character whose direction
matches the line's writing direction.
@param line
The line from which the offset is requested.
@param charIndex
The string index corresponding to the desired position.
@param secondaryOffset
An output parameter that will be set to the secondary offset
along the baseline for charIndex. When a single caret is
sufficient for a string index, this value will be the same as
the primary offset, which is the return value of this function.
This parameter may be NULL.
@result The primary offset along the baseline for charIndex, or 0.0 in
the event of failure.
*/
CGFloat CTLineGetOffsetForStringIndex(
CTLineRef line,
CFIndex charIndex,
CGFloat * _Nullable secondaryOffset ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
#if defined(__BLOCKS__)
/*!
@function CTLineEnumerateCaretOffsets
@abstract Enumerates caret offsets for characters in a line.
@discussion The provided block is invoked once for each logical caret edge in the line, in left-to-right visual order.
@param block
The offset parameter is relative to the line origin. The leadingEdge parameter of this block refers to logical order.
*/
void CTLineEnumerateCaretOffsets(
CTLineRef line,
void (^block)(double offset, CFIndex charIndex, bool leadingEdge, bool* stop) ) CT_AVAILABLE(macos(10.11), ios(9.0), watchos(2.0), tvos(9.0));
#endif // defined(__BLOCKS__)
CF_ASSUME_NONNULL_END
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework/Headers/CTFramesetter.h | /*
* CTFramesetter.h
* CoreText
*
* Copyright (c) 2003-2019 Apple Inc. All rights reserved.
*
*/
/*!
@header
Thread Safety Information
All functions in this header are thread safe unless otherwise specified.
*/
#ifndef __CTFRAMESETTER__
#define __CTFRAMESETTER__
#include <CoreText/CTFrame.h>
#include <CoreText/CTTypesetter.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
CF_ASSUME_NONNULL_BEGIN
/* --------------------------------------------------------------------------- */
/* Framesetter Types */
/* --------------------------------------------------------------------------- */
typedef const struct CF_BRIDGED_TYPE(id) __CTFramesetter * CTFramesetterRef;
/*!
@function CTFramesetterGetTypeID
@abstract Returns the CFType of the framesetter object
*/
CFTypeID CTFramesetterGetTypeID( void ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/* --------------------------------------------------------------------------- */
/* Framesetter Creation */
/* --------------------------------------------------------------------------- */
/*!
@function CTFramesetterCreateWithTypesetter
@abstract Creates a framesetter directly from a typesetter.
@discussion Each framesetter uses a typesetter internally to perform
line breaking and other contextual analysis based on the
characters in a string. This function allows use of a
typesetter that was constructed using specific options.
@param typesetter
The typesetter to be used by the newly-created framesetter.
@result This function will return a reference to a CTFramesetter object.
@seealso CTTypesetterCreateWithAttributedStringAndOptions
*/
CTFramesetterRef CTFramesetterCreateWithTypesetter(
CTTypesetterRef typesetter ) CT_AVAILABLE(macos(10.14), ios(12.0), watchos(5.0), tvos(12.0));
/*!
@function CTFramesetterCreateWithAttributedString
@abstract Creates an immutable framesetter object from an attributed
string.
@discussion The resultant framesetter object can be used to create and
fill text frames with the CTFramesetterCreateFrame call.
@param attrString
The attributed string to construct the framesetter with.
@result This function will return a reference to a CTFramesetter object.
*/
CTFramesetterRef CTFramesetterCreateWithAttributedString(
CFAttributedStringRef attrString ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/* --------------------------------------------------------------------------- */
/* Frame Creation */
/* --------------------------------------------------------------------------- */
/*!
@function CTFramesetterCreateFrame
@abstract Creates an immutable frame from a framesetter.
@discussion This call will create a frame full of glyphs in the shape of
the path provided by the "path" parameter. The framesetter
will continue to fill the frame until it either runs out of
text or it finds that text no longer fits.
@param framesetter
The framesetter that will be used to create the frame.
@param stringRange
The string range which the new frame will be based on. The
string range is a range over the string that was used to
create the framesetter. If the length portion of the range
is set to 0, then the framesetter will continue to add lines
until it runs out of text or space.
@param path
A CGPath object that specifies the shape which the frame will
take on.
@param frameAttributes
Additional attributes that control the frame filling process
can be specified here, or NULL if there are no such attributes.
See CTFrame.h for available attributes.
@result This function will return a reference to a new CTFrame object.
*/
CTFrameRef CTFramesetterCreateFrame(
CTFramesetterRef framesetter,
CFRange stringRange,
CGPathRef path,
CFDictionaryRef _Nullable frameAttributes ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFramesetterGetTypesetter
@abstract Returns the typesetter object being used by the framesetter.
@discussion Each framesetter uses a typesetter internally to perform
line breaking and other contextual analysis based on the
characters in a string; this function returns the typesetter
being used by a particular framesetter if the caller would
like to perform other operations on that typesetter.
@param framesetter
The framesetter from which a typesetter is being requested.
@result This function will return a reference to a CTTypesetter
object, which should not be released by the caller.
*/
CTTypesetterRef CTFramesetterGetTypesetter(
CTFramesetterRef framesetter ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/* --------------------------------------------------------------------------- */
/* Frame Sizing */
/* --------------------------------------------------------------------------- */
/*!
@function CTFramesetterSuggestFrameSizeWithConstraints
@abstract Determines the frame size needed for a string range.
@discussion This function may be used to determine how much space is needed
to display a string, optionally by constraining the space along
either dimension.
@param framesetter
The framesetter that will be used for measuring the frame size.
@param stringRange
The string range to which the frame size will apply. The
string range is a range over the string that was used to
create the framesetter. If the length portion of the range
is set to 0, then the framesetter will continue to add lines
until it runs out of text or space.
@param frameAttributes
Additional attributes that control the frame filling process
can be specified here, or NULL if there are no such attributes.
@param constraints
The width and height to which the frame size will be constrained,
A value of CGFLOAT_MAX for either dimension indicates that it
should be treated as unconstrained.
@param fitRange
The range of the string that actually fit in the constrained size.
@result The actual dimensions for the given string range and constraints.
*/
CGSize CTFramesetterSuggestFrameSizeWithConstraints(
CTFramesetterRef framesetter,
CFRange stringRange,
CFDictionaryRef _Nullable frameAttributes,
CGSize constraints,
CFRange * _Nullable fitRange ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
CF_ASSUME_NONNULL_END
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework/Headers/CTFontCollection.h | /*
* CTFontCollection.h
* CoreText
*
* Copyright (c) 2006-2018 Apple Inc. All rights reserved.
*
*/
/*!
@header
Thread Safety Information
All functions in this header are thread safe unless otherwise specified.
*/
#ifndef __CTFONTCOLLECTION__
#define __CTFONTCOLLECTION__
#include <CoreText/CTFontDescriptor.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
CF_ASSUME_NONNULL_BEGIN
/*! --------------------------------------------------------------------------
@group Collection Types
*///--------------------------------------------------------------------------
/*!
@typedef CTFontCollectionRef
@abstract The Core Text font collection reference.
@discussion An opaque reference to an immutable font collection.
*/
#if TARGET_OS_IPHONE
typedef const struct CF_BRIDGED_TYPE(id) __CTFontCollection * CTFontCollectionRef;
#else
typedef const struct CF_BRIDGED_TYPE(NSFontCollection) __CTFontCollection * CTFontCollectionRef;
#endif
/*!
@typedef CTMutableFontCollectionRef
@abstract The Core Text mutable font collection reference.
@discussion An opaque reference to a mutable font collection.
*/
#if TARGET_OS_IPHONE
typedef struct CF_BRIDGED_TYPE(id) __CTFontCollection * CTMutableFontCollectionRef;
#else
typedef struct CF_BRIDGED_MUTABLE_TYPE(NSMutableFontCollection) __CTFontCollection * CTMutableFontCollectionRef;
#endif
/*!
@function CTFontCollectionGetTypeID
@abstract Returns the type identifier for Core Text font collection references.
@result The identifier for the opaque types CTFontCollectionRef or CTMutableFontCollectionRef.
*/
CFTypeID CTFontCollectionGetTypeID( void ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@typedef CTFontCollectionSortDescriptorsCallback
@abstract Collection sorting callback.
@discussion This callback can be specified to obtain the matching font descriptors of a collection in sorted order. Return the appropriate comparison result of first descriptor to second descriptor.
*/
typedef CFComparisonResult (*CTFontCollectionSortDescriptorsCallback)(
CTFontDescriptorRef first,
CTFontDescriptorRef second,
void *refCon );
/*! --------------------------------------------------------------------------
@group Collection Matching Options
*///--------------------------------------------------------------------------
/*!
@defined kCTFontCollectionRemoveDuplicatesOption
@abstract Option key to specify filtering of duplicates.
@discussion Specify this option key in the options dictionary with a non- zero value to enable automatic filtering of duplicate font descriptors.
*/
CT_EXPORT const CFStringRef kCTFontCollectionRemoveDuplicatesOption CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontCollectionIncludeDisabledFontsOption
@abstract Option key to include disabled fonts in the matching results.
@discussion Specify this option key in the options dictionary with a non-zero value to enable matching of disabled fonts. You can pass font descriptors specifying disabled fonts to CTFontManagerEnableFontDescriptors, but you cannot use such a font descriptor to query font attributes from the system database or create a CTFontRef.
*/
CT_EXPORT const CFStringRef kCTFontCollectionIncludeDisabledFontsOption CT_AVAILABLE(macos(10.7)) CT_UNAVAILABLE(ios, watchos, tvos);
/*!
@defined kCTFontCollectionDisallowAutoActivationOption
@abstract Option key to avoid auto-activating fonts.
@discussion Specify this option key in the options dictionary with a non-zero value to disallow searches for missing fonts (font descriptors returning no results).
*/
CT_EXPORT const CFStringRef kCTFontCollectionDisallowAutoActivationOption CT_AVAILABLE(macos(10.7)) CT_UNAVAILABLE(ios, watchos, tvos);
/*! --------------------------------------------------------------------------
@group Collection Creation
*///--------------------------------------------------------------------------
/*!
@function CTFontCollectionCreateFromAvailableFonts
@abstract Returns a new font collection matching all available fonts.
@param options
The options dictionary. See constant option keys.
@result This function creates a new collection containing all fonts available to the current application.
*/
CTFontCollectionRef CTFontCollectionCreateFromAvailableFonts(
CFDictionaryRef _Nullable options ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontCollectionCreateWithFontDescriptors
@abstract Returns a new collection based on the array of font descriptors.
@param queryDescriptors
An array of font descriptors to use for matching. May be NULL, in which case the matching descriptors will be NULL.
@param options
The options dictionary. See constant option keys.
@result This function creates a new collection based on the provided font descriptors. The contents of this collection is defined by matching the provided descriptors against all available font descriptors.
*/
CTFontCollectionRef CTFontCollectionCreateWithFontDescriptors(
CFArrayRef _Nullable queryDescriptors,
CFDictionaryRef _Nullable options ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontCollectionCreateCopyWithFontDescriptors
@abstract Returns a copy of the original collection augmented with the new font descriptors.
@param original
The original font collection reference.
@param queryDescriptors
An array of font descriptors to augment those of the original collection.
@param options
The options dictionary. See constant option keys.
@result This function creates a copy of the original font collection augmented by the new font descriptors and options. The new font descriptors are merged with the existing descriptors to create a single set.
*/
CTFontCollectionRef CTFontCollectionCreateCopyWithFontDescriptors(
CTFontCollectionRef original,
CFArrayRef _Nullable queryDescriptors,
CFDictionaryRef _Nullable options ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontCollectionCreateMutableCopy
@abstract Returns a mutable copy of the original collection.
@param original
The original font collection reference.
@result This function creates a mutable copy of the original font collection.
*/
CTMutableFontCollectionRef CTFontCollectionCreateMutableCopy(
CTFontCollectionRef original ) CT_AVAILABLE(macos(10.7)) CT_UNAVAILABLE(ios, watchos, tvos);
/*! --------------------------------------------------------------------------
@group Editing the query descriptors
*///--------------------------------------------------------------------------
/*!
@function CTFontCollectionCopyQueryDescriptors
@abstract Returns the array of descriptors to match.
@param collection
The font collection reference.
@result This function returns a retained reference to the array of descriptors to be used to query (match) the system font database. The return value is undefined if CTFontCollectionCreateFromAvailableFonts was used to create the collection.
*/
CFArrayRef _Nullable CTFontCollectionCopyQueryDescriptors(
CTFontCollectionRef collection ) CT_AVAILABLE(macos(10.7)) CT_UNAVAILABLE(ios, watchos, tvos);
/*!
@function CTFontCollectionSetQueryDescriptors
@abstract Replaces the array of descriptors to match.
@param collection
The font collection reference.
@param descriptors
An array of CTFontDescriptorRef. May be NULL to represent an empty collection, in which case the matching descriptors will also be NULL.
*/
void CTFontCollectionSetQueryDescriptors(
CTMutableFontCollectionRef collection,
CFArrayRef _Nullable descriptors ) CT_AVAILABLE(macos(10.7)) CT_UNAVAILABLE(ios, watchos, tvos);
/*!
@function CTFontCollectionCopyExclusionDescriptors
@abstract Returns the array of descriptors to exclude from the match.
@param collection
The font collection reference.
@result This function returns a retained reference to the array of descriptors to be used to query (match) the system font database.
*/
CFArrayRef _Nullable CTFontCollectionCopyExclusionDescriptors( CTFontCollectionRef collection ) CT_AVAILABLE(macos(10.7)) CT_UNAVAILABLE(ios, watchos, tvos);
/*!
@function CTFontCollectionSetExclusionDescriptors
@abstract Replaces the array of descriptors to exclude from the match.
@param collection
The font collection reference.
@param descriptors
An array of CTFontDescriptorRef. May be NULL.
*/
void CTFontCollectionSetExclusionDescriptors(
CTMutableFontCollectionRef collection,
CFArrayRef _Nullable descriptors ) CT_AVAILABLE(macos(10.7)) CT_UNAVAILABLE(ios, watchos, tvos);
/*! --------------------------------------------------------------------------
@group Retrieving Matching Descriptors
*///--------------------------------------------------------------------------
/*!
@function CTFontCollectionCreateMatchingFontDescriptors
@abstract Returns an array of font descriptors matching the collection.
@param collection
The font collection reference.
@result An array of CTFontDescriptors matching the collection definition or NULL if there are none.
*/
CFArrayRef _Nullable CTFontCollectionCreateMatchingFontDescriptors(
CTFontCollectionRef collection ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontCollectionCreateMatchingFontDescriptorsSortedWithCallback
@abstract Returns the array of matching font descriptors sorted with the callback function.
@param collection
The collection reference.
@param sortCallback
The sorting callback function that defines the sort order.
@param refCon
Pointer to client data define context for the callback.
@result An array of CTFontDescriptors matching the criteria of the collection, sorted by the results of the sorting callback function, or NULL if there are none.
*/
CFArrayRef _Nullable CTFontCollectionCreateMatchingFontDescriptorsSortedWithCallback(
CTFontCollectionRef collection,
CTFontCollectionSortDescriptorsCallback _Nullable sortCallback,
void * _Nullable refCon ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFontCollectionCreateMatchingFontDescriptorsWithOptions
@abstract Returns an array of font descriptors matching the collection.
@param collection
The font collection reference.
@param options
The options dictionary. See constant option keys. May be NULL, in which case this call returns the same results as CTFontCollectionCreateMatchingFontDescriptors, using the options passed in when the collection was created.
@result An array of CTFontDescriptors matching the collection definition or NULL if there are none.
*/
CFArrayRef _Nullable CTFontCollectionCreateMatchingFontDescriptorsWithOptions(
CTFontCollectionRef collection,
CFDictionaryRef _Nullable options ) CT_AVAILABLE(macos(10.7), ios(12.0), watchos(5.0), tvos(12.0));
/*!
@function CTFontCollectionCreateMatchingFontDescriptorsForFamily
@abstract Returns an array of font descriptors matching the specified family, one descriptor for each style in the collection.
@param collection
The font collection reference.
@param familyName
The font family name
@result An array of CTFontDescriptors matching the specified family in the collection or NULL if there are none.
*/
CFArrayRef _Nullable CTFontCollectionCreateMatchingFontDescriptorsForFamily(
CTFontCollectionRef collection,
CFStringRef familyName,
CFDictionaryRef _Nullable options ) CT_AVAILABLE(macos(10.7)) CT_UNAVAILABLE(ios, watchos, tvos);
/*! --------------------------------------------------------------------------
@group Bulk attribute access
*///--------------------------------------------------------------------------
/*!
@enum CTFontCollectionCopyOptions
@abstract Option bits for use with CTFontCollectionCopyFontAttribute(s).
@constant kCTFontCollectionCopyStandardSort
Passing this option indicates that the return values should be sorted in standard UI order, suitable for display to the user. This is the same sorting behavior used by NSFontPanel and Font Book.
@constant kCTFontCollectionCopyUnique
Passing this option indicates that duplicate values should be removed from the results.
*/
typedef CF_OPTIONS(uint32_t, CTFontCollectionCopyOptions) {
kCTFontCollectionCopyDefaultOptions = 0,
kCTFontCollectionCopyUnique = (1 << 0),
kCTFontCollectionCopyStandardSort = (1 << 1)
} CT_AVAILABLE(macos(10.7), ios(12.0), watchos(5.0), tvos(12.0));
/*!
@function CTFontCollectionCopyFontAttribute
@abstract Returns an array of font descriptor attribute values.
@param collection
The font collection reference.
@param attributeName
The attribute to retrieve for each descriptor in the collection.
@param options
Options to alter the return value.
@result An array containing one value for each descriptor. With kCTFontCollectionCopyDefaultOptions, the values will be in the same order as the results from CTFontCollectionCreateMatchingFontDescriptors and NULL values will be transformed to kCFNull. When the kCTFontCollectionCopyUnique is set, duplicate values will be removed. When kCTFontCollectionCopyStandardSort is set, the values will be sorted in standard UI order.
*/
CFArrayRef CTFontCollectionCopyFontAttribute(
CTFontCollectionRef collection,
CFStringRef attributeName,
CTFontCollectionCopyOptions options ) CT_AVAILABLE(macos(10.7), ios(15.0), watchos(8.0), tvos(15.0));
/*!
@function CTFontCollectionCopyFontAttributes
@abstract Returns an array of dictionaries containing font descriptor attribute values.
@param collection
The font collection reference.
@param attributeNames
The attributes to retrieve for each descriptor in the collection.
@param options
Options to alter the return value.
@result An array containing one CFDictionary value for each descriptor mapping the requested attribute names. With kCTFontCollectionCopyDefaultOptions, the values will be in the same order as the results from CTFontCollectionCreateMatchingFontDescriptors. When the kCTFontCollectionCopyUnique is set, duplicate values will be removed. When kCTFontCollectionCopyStandardSort is set, the values will be sorted in standard UI order.
*/
CFArrayRef CTFontCollectionCopyFontAttributes(
CTFontCollectionRef collection,
CFSetRef attributeNames,
CTFontCollectionCopyOptions options ) CT_AVAILABLE(macos(10.7), ios(15.0), watchos(8.0), tvos(15.0));
CF_ASSUME_NONNULL_END
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework/Headers/CTRun.h | /*
* CTRun.h
* CoreText
*
* Copyright (c) 2004-2018 Apple Inc. All rights reserved.
*
*/
/*!
@header
Thread Safety Information
All functions in this header are thread safe unless otherwise specified.
*/
#ifndef __CTRUN__
#define __CTRUN__
#include <CoreText/CTDefines.h>
#include <CoreFoundation/CoreFoundation.h>
#include <CoreGraphics/CoreGraphics.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
CF_ASSUME_NONNULL_BEGIN
/* --------------------------------------------------------------------------- */
/* Glyph Run Types */
/* --------------------------------------------------------------------------- */
typedef const struct CF_BRIDGED_TYPE(id) __CTRun * CTRunRef;
/*!
@enum CTRunStatus
@abstract A bitfield passed back by CTRunGetStatus that is used to
indicate the disposition of the run.
@constant kCTRunStatusNoStatus
The run has no special attributes.
@constant kCTRunStatusRightToLeft
When set, the run is right to left.
@constant kCTRunStatusNonMonotonic
When set, the run has been reordered in some way such that
the string indices associated with the glyphs are no longer
strictly increasing (for left to right runs) or decreasing
(for right to left runs).
@constant kCTRunStatusHasNonIdentityMatrix
When set, the run requires a specific text matrix to be set
in the current CG context for proper drawing.
*/
typedef CF_OPTIONS(uint32_t, CTRunStatus)
{
kCTRunStatusNoStatus = 0,
kCTRunStatusRightToLeft = (1 << 0),
kCTRunStatusNonMonotonic = (1 << 1),
kCTRunStatusHasNonIdentityMatrix = (1 << 2)
};
/*!
@function CTRunGetTypeID
@abstract Returns the CFType of the run object
*/
CFTypeID CTRunGetTypeID( void ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/* --------------------------------------------------------------------------- */
/* Glyph Run Access */
/* --------------------------------------------------------------------------- */
/*!
@function CTRunGetGlyphCount
@abstract Gets the glyph count for the run.
@param run
The run whose glyph count you wish to access.
@result The number of glyphs that the run contains. It is totally
possible that this function could return a value of zero,
indicating that there are no glyphs in this run.
*/
CFIndex CTRunGetGlyphCount(
CTRunRef run ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTRunGetAttributes
@abstract Returns the attribute dictionary that was used to create the
glyph run.
@discussion This dictionary returned is either the same exact one that was
set as an attribute dictionary on the original attributed string
or a dictionary that has been manufactured by the layout engine.
Attribute dictionaries can be manufactured in the case of font
substitution or if they are missing critical attributes.
@param run
The run whose attributes you wish to access.
@result The attribute dictionary.
*/
CFDictionaryRef CTRunGetAttributes(
CTRunRef run ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTRunGetStatus
@abstract Returns the run's status.
@discussion In addition to attributes, runs also have status that can be
used to expedite certain operations. Knowing the direction and
ordering of a run's glyphs can aid in string index analysis,
whereas knowing whether the positions reference the identity
text matrix can avoid expensive comparisons. Note that this
status is provided as a convenience, since this information is
not strictly necessary but can certainly be helpful.
@param run
The run whose status you wish to access.
@result The run's status.
*/
CTRunStatus CTRunGetStatus(
CTRunRef run ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTRunGetGlyphsPtr
@abstract Returns a direct pointer for the glyph array stored in the run.
@discussion The glyph array will have a length equal to the value returned by
CTRunGetGlyphCount. The caller should be prepared for this
function to return NULL even if there are glyphs in the stream.
Should this function return NULL, the caller will need to
allocate their own buffer and call CTRunGetGlyphs to fetch the
glyphs.
@param run
The run whose glyphs you wish to access.
@result A valid pointer to an array of CGGlyph structures or NULL.
*/
const CGGlyph * _Nullable CTRunGetGlyphsPtr(
CTRunRef run ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTRunGetGlyphs
@abstract Copies a range of glyphs into user-provided buffer.
@param run
The run whose glyphs you wish to copy.
@param range
The range of glyphs to be copied, with the entire range having a
location of 0 and a length of CTRunGetGlyphCount. If the length
of the range is set to 0, then the operation will continue from
the range's start index to the end of the run.
@param buffer
The buffer where the glyphs will be copied to. The buffer must be
allocated to at least the value specified by the range's length.
*/
void CTRunGetGlyphs(
CTRunRef run,
CFRange range,
CGGlyph buffer[_Nonnull] ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTRunGetPositionsPtr
@abstract Returns a direct pointer for the glyph position array stored in
the run.
@discussion The glyph positions in a run are relative to the origin of the
line containing the run. The position array will have a length
equal to the value returned by CTRunGetGlyphCount. The caller
should be prepared for this function to return NULL even if there
are glyphs in the stream. Should this function return NULL, the
caller will need to allocate their own buffer and call
CTRunGetPositions to fetch the positions.
@param run
The run whose positions you wish to access.
@result A valid pointer to an array of CGPoint structures or NULL.
*/
const CGPoint * _Nullable CTRunGetPositionsPtr(
CTRunRef run ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTRunGetPositions
@abstract Copies a range of glyph positions into a user-provided buffer.
@discussion The glyph positions in a run are relative to the origin of the
line containing the run.
@param run
The run whose positions you wish to copy.
@param range
The range of glyph positions to be copied, with the entire range
having a location of 0 and a length of CTRunGetGlyphCount. If the
length of the range is set to 0, then the operation will continue
from the range's start index to the end of the run.
@param buffer
The buffer where the glyph positions will be copied to. The buffer
must be allocated to at least the value specified by the range's
length.
*/
void CTRunGetPositions(
CTRunRef run,
CFRange range,
CGPoint buffer[_Nonnull] ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTRunGetAdvancesPtr
@abstract Returns a direct pointer for the glyph advance array stored in
the run.
@discussion The advance array will have a length equal to the value returned
by CTRunGetGlyphCount. The caller should be prepared for this
function to return NULL even if there are glyphs in the stream.
Should this function return NULL, the caller will need to
allocate their own buffer and call CTRunGetAdvances to fetch the
advances. Note that advances alone are not sufficient for correctly
positioning glyphs in a line, as a run may have a non-identity
matrix or the initial glyph in a line may have a non-zero origin;
callers should consider using positions instead.
@param run
The run whose advances you wish to access.
@result A valid pointer to an array of CGSize structures or NULL.
*/
const CGSize * _Nullable CTRunGetAdvancesPtr(
CTRunRef run ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTRunGetAdvances
@abstract Copies a range of glyph advances into a user-provided buffer.
@param run
The run whose advances you wish to copy.
@param range
The range of glyph advances to be copied, with the entire range
having a location of 0 and a length of CTRunGetGlyphCount. If the
length of the range is set to 0, then the operation will continue
from the range's start index to the end of the run.
@param buffer
The buffer where the glyph advances will be copied to. The buffer
must be allocated to at least the value specified by the range's
length.
*/
void CTRunGetAdvances(
CTRunRef run,
CFRange range,
CGSize buffer[_Nonnull] ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTRunGetStringIndicesPtr
@abstract Returns a direct pointer for the string indices stored in the run.
@discussion The indices are the character indices that originally spawned the
glyphs that make up the run. They can be used to map the glyphs in
the run back to the characters in the backing store. The string
indices array will have a length equal to the value returned by
CTRunGetGlyphCount. The caller should be prepared for this
function to return NULL even if there are glyphs in the stream.
Should this function return NULL, the caller will need to allocate
their own buffer and call CTRunGetStringIndices to fetch the
indices.
@param run
The run whose string indices you wish to access.
@result A valid pointer to an array of CFIndex structures or NULL.
*/
const CFIndex * _Nullable CTRunGetStringIndicesPtr(
CTRunRef run ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTRunGetStringIndices
@abstract Copies a range of string indices into a user-provided buffer.
@discussion The indices are the character indices that originally spawned the
glyphs that make up the run. They can be used to map the glyphs
in the run back to the characters in the backing store.
@param run
The run whose string indices you wish to copy.
@param range
The range of string indices to be copied, with the entire range
having a location of 0 and a length of CTRunGetGlyphCount. If the
length of the range is set to 0, then the operation will continue
from the range's start index to the end of the run.
@param buffer
The buffer where the string indices will be copied to. The buffer
must be allocated to at least the value specified by the range's
length.
*/
void CTRunGetStringIndices(
CTRunRef run,
CFRange range,
CFIndex buffer[_Nonnull] ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTRunGetStringRange
@abstract Gets the range of characters that originally spawned the glyphs
in the run.
@param run
The run whose string range you wish to access.
@result Returns the range of characters that originally spawned the
glyphs. If run is invalid, this will return an empty range.
*/
CFRange CTRunGetStringRange(
CTRunRef run ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTRunGetTypographicBounds
@abstract Gets the typographic bounds of the run.
@param run
The run that you want to calculate the typographic bounds for.
@param range
The range of glyphs to be measured, with the entire range having
a location of 0 and a length of CTRunGetGlyphCount. If the length
of the range is set to 0, then the operation will continue from
the range's start index to the end of the run.
@param ascent
Upon return, this parameter will contain the ascent of the run.
This may be set to NULL if not needed.
@param descent
Upon return, this parameter will contain the descent of the run.
This may be set to NULL if not needed.
@param leading
Upon return, this parameter will contain the leading of the run.
This may be set to NULL if not needed.
@result The typographic width of the run. If run or range is
invalid, then this function will always return zero.
*/
double CTRunGetTypographicBounds(
CTRunRef run,
CFRange range,
CGFloat * _Nullable ascent,
CGFloat * _Nullable descent,
CGFloat * _Nullable leading ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTRunGetImageBounds
@abstract Calculates the image bounds for a glyph range.
@discussion The image bounds for a run is the union of all non-empty glyph
bounding rects, each positioned as it would be if drawn using
CTRunDraw using the current context (for clients linked against
macOS High Sierra or iOS 11 and later) or the text position of
the supplied context (for all others). Note that the result is
ideal and does not account for raster coverage due to rendering.
This function is purely a convenience for using glyphs as an
image and should not be used for typographic purposes.
@param run
The run that you want to calculate the image bounds for.
@param context
The context which the image bounds will be calculated for or NULL,
in which case the bounds are relative to CGPointZero.
@param range
The range of glyphs to be measured, with the entire range having
a location of 0 and a length of CTRunGetGlyphCount. If the length
of the range is set to 0, then the operation will continue from
the range's start index to the end of the run.
@result A rect that tightly encloses the paths of the run's glyphs. The
rect origin will match the drawn position of the requested range;
that is, it will be translated by the supplied context's text
position and the positions of the individual glyphs. If the run
or range is invalid, CGRectNull will be returned.
@seealso CTRunGetTypographicBounds
*/
CGRect CTRunGetImageBounds(
CTRunRef run,
CGContextRef _Nullable context,
CFRange range ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTRunGetTextMatrix
@abstract Returns the text matrix needed to draw this run.
@discussion To properly draw the glyphs in a run, the fields 'tx' and 'ty' of
the CGAffineTransform returned by this function should be set to
the current text position.
@param run
The run object from which to get the text matrix.
@result A CGAffineTransform.
*/
CGAffineTransform CTRunGetTextMatrix(
CTRunRef run ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTRunGetBaseAdvancesAndOrigins
@abstract Copies a range of base advances and/or origins into user-provided
buffers.
@discussion A run's base advances and origins determine the positions of its
glyphs but require additional processing before being used for
drawing. Similar to the advances returned by CTRunGetAdvances,
base advances are the displacement from the origin of a glyph
to the origin of the next glyph, except base advances do not
include any positioning the font layout tables may have done
relative to another glyph (such as a mark relative to its base).
The actual position of the current glyph is determined by the
displacement of its origin from the starting position, and the
position of the next glyph by the displacement of the current
glyph's base advance from the starting position.
@param runRef
The run whose base advances and/or origins you wish to copy.
@param range
The range of values to be copied. If the length of the
range is set to 0, then the copy operation will continue from the
range's start index to the end of the run.
@param advancesBuffer
The buffer where the base advances will be copied to, or NULL.
If not NULL, the buffer must allow for at least as many elements
as specified by the range's length.
@param originsBuffer
The buffer where the origins will be copied to, or NULL. If not
NULL, the buffer must allow for at least as many elements as
specified by the range's length.
*/
void CTRunGetBaseAdvancesAndOrigins(
CTRunRef runRef,
CFRange range,
CGSize advancesBuffer[_Nullable],
CGPoint originsBuffer[_Nullable] ) CT_AVAILABLE(macos(10.11), ios(9.0), watchos(2.0), tvos(9.0));
/*!
@function CTRunDraw
@abstract Draws a complete run or part of one.
@discussion This is a convenience call, since the run could also be drawn by
accessing its glyphs, positions, and text matrix. Unlike when
drawing the entire line containing the run with CTLineDraw, the
run's underline (if any) will not be drawn, since the underline's
appearance may depend on other runs in the line. This call may
leave the graphics context in any state and does not flush the
context after drawing. This call also expects a text matrix with
`y` values increasing from bottom to top; a flipped text matrix
may result in misplaced diacritics.
@param run
The run that you want to draw.
@param context
The context to draw the run to.
@param range
The range of glyphs to be drawn, with the entire range having a
location of 0 and a length of CTRunGetGlyphCount. If the length
of the range is set to 0, then the operation will continue from
the range's start index to the end of the run.
*/
void CTRunDraw(
CTRunRef run,
CGContextRef context,
CFRange range ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
CF_ASSUME_NONNULL_END
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework/Headers/CTGlyphInfo.h | /*
* CTGlyphInfo.h
* CoreText
*
* Copyright (c) 2006-2019 Apple Inc. All rights reserved.
*
*/
/*!
@header
Thread Safety Information
All functions in this header are thread safe unless otherwise specified.
*/
#ifndef __CTGLYPHINFO__
#define __CTGLYPHINFO__
#include <CoreText/CTFont.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
CF_ASSUME_NONNULL_BEGIN
/* --------------------------------------------------------------------------- */
/* Glyph Info Types */
/* --------------------------------------------------------------------------- */
#if TARGET_OS_IPHONE
typedef const struct CF_BRIDGED_TYPE(id) __CTGlyphInfo * CTGlyphInfoRef;
#else
typedef const struct CF_BRIDGED_TYPE(NSGlyphInfo) __CTGlyphInfo * CTGlyphInfoRef;
#endif
/*!
@function CTGlyphInfoGetTypeID
@abstract Returns the CFType of the glyph info object
*/
CFTypeID CTGlyphInfoGetTypeID( void ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/* --------------------------------------------------------------------------- */
/* Glyph Info Values */
/* --------------------------------------------------------------------------- */
/*!
@enum CTCharacterCollection
@abstract These constants specify character collections.
@constant kCTCharacterCollectionIdentityMapping
Indicates that the character identifier is equal to the CGGlyph
glyph index.
@constant kCTCharacterCollectionAdobeCNS1
Indicates the Adobe-CNS1 mapping.
@constant kCTCharacterCollectionAdobeGB1
Indicates the Adobe-GB1 mapping.
@constant kCTCharacterCollectionAdobeJapan1
Indicates the Adobe-Japan1 mapping.
@constant kCTCharacterCollectionAdobeJapan2
Indicates the Adobe-Japan2 mapping.
@constant kCTCharacterCollectionAdobeKorea1
Indicates the Adobe-Korea1 mapping.
*/
typedef CF_ENUM(uint16_t, CTCharacterCollection) {
kCTCharacterCollectionIdentityMapping = 0,
kCTCharacterCollectionAdobeCNS1 = 1,
kCTCharacterCollectionAdobeGB1 = 2,
kCTCharacterCollectionAdobeJapan1 = 3,
kCTCharacterCollectionAdobeJapan2 = 4,
kCTCharacterCollectionAdobeKorea1 = 5,
kCTIdentityMappingCharacterCollection CT_ENUM_DEPRECATED("Deprecated", macos(10.5, 10.11), ios(3.2, 9.0)) CT_ENUM_UNAVAILABLE(watchos, tvos)
= kCTCharacterCollectionIdentityMapping,
kCTAdobeCNS1CharacterCollection CT_ENUM_DEPRECATED("Deprecated", macos(10.5, 10.11), ios(3.2, 9.0)) CT_ENUM_UNAVAILABLE(watchos, tvos)
= kCTCharacterCollectionAdobeCNS1,
kCTAdobeGB1CharacterCollection CT_ENUM_DEPRECATED("Deprecated", macos(10.5, 10.11), ios(3.2, 9.0)) CT_ENUM_UNAVAILABLE(watchos, tvos)
= kCTCharacterCollectionAdobeGB1,
kCTAdobeJapan1CharacterCollection CT_ENUM_DEPRECATED("Deprecated", macos(10.5, 10.11), ios(3.2, 9.0)) CT_ENUM_UNAVAILABLE(watchos, tvos)
= kCTCharacterCollectionAdobeJapan1,
kCTAdobeJapan2CharacterCollection CT_ENUM_DEPRECATED("Deprecated", macos(10.5, 10.11), ios(3.2, 9.0)) CT_ENUM_UNAVAILABLE(watchos, tvos)
= kCTCharacterCollectionAdobeJapan2,
kCTAdobeKorea1CharacterCollection CT_ENUM_DEPRECATED("Deprecated", macos(10.5, 10.11), ios(3.2, 9.0)) CT_ENUM_UNAVAILABLE(watchos, tvos)
= kCTCharacterCollectionAdobeKorea1
};
/* --------------------------------------------------------------------------- */
/* Glyph Info Creation */
/* --------------------------------------------------------------------------- */
/*!
@function CTGlyphInfoCreateWithGlyphName
@abstract Creates an immutable glyph info object.
@discussion This function creates an immutable glyph info object for a glyph
name such as "copyright" and a specified font.
@param glyphName
The name of the glyph.
@param font
The font to be associated with the returned CTGlyphInfo object.
@param baseString
The part of the string the returned object is intended
to override.
@result This function will return a reference to a CTGlyphInfo object.
*/
CTGlyphInfoRef _Nullable CTGlyphInfoCreateWithGlyphName(
CFStringRef glyphName,
CTFontRef font,
CFStringRef baseString ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTGlyphInfoCreateWithGlyph
@abstract Creates an immutable glyph info object.
@discussion This function creates an immutable glyph info object for a glyph
index and a specified font.
@param glyph
The glyph identifier.
@param font
The font to be associated with the returned CTGlyphInfo object.
@param baseString
The part of the string the returned object is intended
to override.
@result This function will return a reference to a CTGlyphInfo object.
*/
CTGlyphInfoRef _Nullable CTGlyphInfoCreateWithGlyph(
CGGlyph glyph,
CTFontRef font,
CFStringRef baseString ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTGlyphInfoCreateWithCharacterIdentifier
@abstract Creates an immutable glyph info object.
@discussion This function creates an immutable glyph info object for a
character identifier and a character collection.
@param cid
A character identifier.
@param collection
A character collection identifier.
@param baseString
The part of the string the returned object is intended
to override.
@result This function will return a reference to a CTGlyphInfo object.
*/
CTGlyphInfoRef _Nullable CTGlyphInfoCreateWithCharacterIdentifier(
CGFontIndex cid,
CTCharacterCollection collection,
CFStringRef baseString ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/* --------------------------------------------------------------------------- */
/* Glyph Info Access */
/* --------------------------------------------------------------------------- */
/*!
@function CTGlyphInfoGetGlyphName
@abstract Gets the glyph name for a glyph info, if applicable.
@discussion This function will return the glyph name.
@param glyphInfo
The glyph info for which you would like the glyph name.
@result If the glyph info object was created with a glyph name, it will
be returned. Otherwise, this function will return NULL.
*/
CFStringRef _Nullable CTGlyphInfoGetGlyphName(
CTGlyphInfoRef glyphInfo ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTGlyphInfoGetGlyph
@abstract Gets the glyph for a glyph info, if applicable.
@discussion This function will return the glyph.
@param glyphInfo
The glyph info from which you would like the glyph.
@result If the glyph info object was created with a font, it will be
returned. Otherwise, this function will return 0.
*/
CGGlyph CTGlyphInfoGetGlyph(
CTGlyphInfoRef glyphInfo ) CT_AVAILABLE(macos(10.15), ios(13.0), watchos(6.0), tvos(13.0));
/*!
@function CTGlyphInfoGetCharacterIdentifier
@abstract Gets the character identifier for a glyph info.
@discussion This function will return the character identifier.
@param glyphInfo
The glyph info for which you would like the character identifier.
@result If the glyph info object was created with a character identifier,
it will be returned. Otherwise, this function will return 0.
*/
CGFontIndex CTGlyphInfoGetCharacterIdentifier(
CTGlyphInfoRef glyphInfo ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTGlyphInfoGetCharacterCollection
@abstract Gets the character collection for a glyph info.
@discussion This function will return the character collection. If the glyph
info object was created with a glyph name or a glyph index, its
character collection will be
kCTIdentityMappingCharacterCollection.
@param glyphInfo
The glyph info for which you would like the character collection.
@result This function will return the character collection of the given
glyph info.
*/
CTCharacterCollection CTGlyphInfoGetCharacterCollection(
CTGlyphInfoRef glyphInfo ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
CF_ASSUME_NONNULL_END
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework/Headers/CTFontManager.h | /*
* CTFontManager.h
* CoreText
*
* Copyright (c) 2008-2021 Apple Inc. All rights reserved.
*
*/
/*!
@header
Thread Safety Information
All functions in this header are thread safe unless otherwise specified.
*/
#ifndef __CTFONTMANAGER__
#define __CTFONTMANAGER__
#include <CoreText/CTFontDescriptor.h>
#include <CoreText/CTFontManagerErrors.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
CF_ASSUME_NONNULL_BEGIN
/*!
@constant CTRegisterBundleFonts
@discussion If this key is defined in the application bundle info dictionary with a boolean value of true, CTFontManager will register all fonts in the Fonts subdirectory of the bundle's Resources directory in the process scope.
*/
/*!
@function CTFontManagerCopyAvailablePostScriptNames
@abstract Returns an array of unique PostScript font names.
@result An array of CFStrings.
*/
CFArrayRef CTFontManagerCopyAvailablePostScriptNames( void ) CT_AVAILABLE(macos(10.6), ios(10.0), watchos(3.0), tvos(10.0));
/*!
@function CTFontManagerCopyAvailableFontFamilyNames
@abstract Returns an array of visible font family names sorted for UI display.
@result An array of CFStrings.
*/
CFArrayRef CTFontManagerCopyAvailableFontFamilyNames( void ) CT_AVAILABLE(macos(10.6), ios(10.0), watchos(3.0), tvos(10.0));
/*!
@function CTFontManagerCopyAvailableFontURLs
@abstract Returns an array of font URLs.
@result An array of CFURLs.
*/
CFArrayRef CTFontManagerCopyAvailableFontURLs( void ) CT_AVAILABLE(macos(10.6)) CT_UNAVAILABLE(ios, watchos, tvos);
/*!
@function CTFontManagerCompareFontFamilyNames
@abstract A CFComparatorFunction to compare font family names and sort them according to Apple guidelines.
@discussion This function compares font family names and sorts them in the preferred order for display in user interfaces.
@param family1
The first localized font family name, as CFStringRef.
@param family2
The second localized font family name, as CFStringRef.
@param context
Unused. Can be NULL.
@result A CFComparisonResult value indicating the sort order for the two family names. kCFComparisonResultGreaterThan if family1 is greater than family2, kCFComparisonResultLessThan if family1 is less than family2, and kCFComparisonResultEqualTo if they are equal.
*/
CFComparisonResult CTFontManagerCompareFontFamilyNames(
const void * family1,
const void * family2,
void * _Nullable context ) CT_AVAILABLE(macos(10.6)) API_UNAVAILABLE(ios, watchos, tvos);
/*!
@function CTFontManagerCreateFontDescriptorsFromURL
@abstract Returns an array of font descriptors representing each of the fonts in the specified URL.
Note: these font descriptors are not available through font descriptor matching.
@param fileURL
A file system URL referencing a valid font file.
@result An array of CTFontDescriptors or NULL if there are no valid fonts.
*/
CFArrayRef _Nullable CTFontManagerCreateFontDescriptorsFromURL(
CFURLRef fileURL ) CT_AVAILABLE(macos(10.6), ios(7.0), watchos(2.0), tvos(9.0));
/*!
@function CTFontManagerCreateFontDescriptorFromData
@abstract Returns a font descriptor representing the font in the supplied data.
Note: the font descriptor is not available through font descriptor matching.
@discussion If the data contains a font collection (TTC or OTC), only the first font in the collection will be returned.
@param data
A CFData containing font data.
@result A font descriptor created from the data or NULL if it is not a valid font.
*/
CTFontDescriptorRef _Nullable CTFontManagerCreateFontDescriptorFromData(
CFDataRef data ) CT_AVAILABLE(macos(10.7), ios(7.0), watchos(2.0), tvos(9.0));
/*!
@function CTFontManagerCreateFontDescriptorsFromData
@abstract Returns an array of font descriptors for the fonts in the supplied data.
Note: the font descriptors are not available through font descriptor matching.
@param data
A CFData containing font data.
@result An array of font descriptors. This can be an empty array in the event of invalid or unsupported font data.
*/
CFArrayRef CTFontManagerCreateFontDescriptorsFromData(CFDataRef data) CT_AVAILABLE(macos(10.13), ios(11.0), watchos(4.0), tvos(11.0));
/*!
@enum CTFontManagerScope
@abstract Scope for font registration. A uses session refers to a login session in macOS, and the current booted session in iOS.
@constant kCTFontManagerScopeNone
The font is not registered and does not participate in font descriptor matching. This isn't a valid scope to specify while registering fonts.
@constant kCTFontManagerScopeProcess
The font is available to the current process for the duration of the process unless directly unregistered.
@constant kCTFontManagerScopePersistent
The font is available to all processes for the current user session and will be available in subsequent sessions unless unregistered.
@constant kCTFontManagerScopeSession
The font is available to the current user session, and will not be available in subsequent sessions.
Session scope is only available in macOS.
*/
typedef CF_ENUM(uint32_t, CTFontManagerScope) {
kCTFontManagerScopeNone = 0,
kCTFontManagerScopeProcess = 1,
kCTFontManagerScopePersistent CT_ENUM_AVAILABLE(macos(10.6), ios(13.0), watchos(6.0), tvos(13.0))
= 2,
kCTFontManagerScopeSession CT_ENUM_AVAILABLE(macos(10.6)) CT_ENUM_UNAVAILABLE(ios, watchos, tvos)
= 3,
kCTFontManagerScopeUser CT_ENUM_AVAILABLE(macos(10.6), ios(13.0), watchos(6.0), tvos(13.0))
= 2,
};
/*!
@defined kCTFontRegistrationUserInfoAttribute
@abstract Optional user defined information that can be attached to an entry in the Font Manager registration catalog.
@discussion This is the key for accessing font registration user information for the font descriptor. This information can be used in descriptor matching to disambiguate between two fonts with equivalent Postscript names. The value associated with this key is a CFStringRef.
*/
CT_EXPORT const CFStringRef kCTFontRegistrationUserInfoAttribute CT_AVAILABLE(ios(13.0)) API_UNAVAILABLE(macos, watchos, tvos);
/*!
@function CTFontManagerRegisterFontsForURL
@abstract Registers fonts from the specified font URL with the font manager. Registered fonts participate in font descriptor matching.
@param fontURL
A file URL for the font or collection (TTC or OTC) to be registered. Once fonts have been registered from a file, it shouldn't be moved or renamed.
@param scope
Scope constant defining the availability and lifetime of the registration. See scope constants for more details.
@param error
Pointer to receive CFError in the case of failed registration.
@result Returns true if registration of the fonts was successful.
*/
bool CTFontManagerRegisterFontsForURL(
CFURLRef fontURL,
CTFontManagerScope scope,
CFErrorRef * error ) CT_AVAILABLE(macos(10.6), ios(4.1), watchos(2.0), tvos(9.0));
/*!
@function CTFontManagerUnregisterFontsForURL
@abstract Unregisters fonts from the specified font URL with the font manager. Unregistered fonts do not participate in font descriptor matching.
iOS note: only fonts registered with CTFontManagerRegisterFontsForURL or CTFontManagerRegisterFontsForURLs can be unregistered with this API.
@param fontURL
Font URL.
@param scope
Scope constant defining the availability and lifetime of the registration. Should match the scope the fonts are registered in. See scope constants for more details.
@param error
Pointer to receive CFError in the case of failed unregistration.
@result Returns true if unregistration of the fonts was successful.
*/
bool CTFontManagerUnregisterFontsForURL(
CFURLRef fontURL,
CTFontManagerScope scope,
CFErrorRef * error ) CT_AVAILABLE(macos(10.6), ios(4.1), watchos(2.0), tvos(9.0));
/*!
@function CTFontManagerRegisterGraphicsFont
@abstract Registers the specified graphics font with the font manager. Registered fonts participate in font descriptor matching.
Attempts to register a font that is either already registered or contains the same PostScript name of an already registered font will fail.
This functionality is useful for fonts that may be embedded in documents or present/constructed in memory. A graphics font is obtained
by calling CGFontCreateWithDataProvider. Fonts that are backed by files should be registered using CTFontManagerRegisterFontsForURL.
@param font
Graphics font to be registered.
@param error
Pointer to receive CFError in the case of failed registration.
@result Returns true if registration of the fonts was successful.
*/
bool CTFontManagerRegisterGraphicsFont(
CGFontRef font,
CFErrorRef * error ) CT_AVAILABLE(macos(10.8), ios(4.1), watchos(2.0), tvos(9.0));
/*!
@function CTFontManagerUnregisterGraphicsFont
@abstract Unregisters the specified graphics font with the font manager. Unregistered fonts do not participate in font descriptor matching.
@param font
Graphics font to be unregistered.
@param error
Pointer to receive CFError in the case of failed unregistration.
@result Returns true if unregistration of the font was successful.
*/
bool CTFontManagerUnregisterGraphicsFont(
CGFontRef font,
CFErrorRef * error ) CT_AVAILABLE(macos(10.8), ios(4.1), watchos(2.0), tvos(9.0));
/*!
@function CTFontManagerRegisterFontsForURLs
@abstract Registers fonts from the specified font URLs with the font manager. Registered fonts are discoverable through font descriptor matching.
@param fontURLs
An array of file URLs for the fonts or collections (TTC or OTC) to be registered. Once fonts have been registered from a file, it shouldn't be moved or renamed.
@param scope
Scope constant defining the availability and lifetime of the registration. See scope constants for more details.
@param errors
Pointer to CFArrayRef to receive array of CFError references. Each error will contain a CFArray of font URLs corresponding to kCTFontManagerErrorFontURLsKey. These URLs represent the font files that caused the error, and were not successfully registered. Must be released by caller. Can be NULL.
@result Returns true if registration of all font URLs was successful. Otherwise false.
*/
bool CTFontManagerRegisterFontsForURLs(
CFArrayRef fontURLs,
CTFontManagerScope scope,
CFArrayRef _Nullable * _Nullable errors ) CT_DEPRECATED_WITH_REPLACEMENT("CTFontManagerRegisterFontURLs", macos(10.6, 10.15), ios(4.1, 13.0), watchos(2.0, 6.0), tvos(9.0, 13.0));
/*!
@function CTFontManagerUnregisterFontsForURLs
@abstract Unregisters fonts from the specified font URLs with the font manager. Unregistered fonts do not participate in font descriptor matching.
iOS note: only fonts registered with CTFontManagerRegisterFontsForURL or CTFontManagerRegisterFontsForURLs can be unregistered with this API.
@param fontURLs
Array of font URLs.
@param scope
Scope constant defining the availability and lifetime of the registration. Should match the scope the fonts are registered in. See scope constants for more details.
@param errors
Pointer to CFArrayRef to receive array of CFError references. Each error will contain a CFArray of font URLs corresponding to kCTFontManagerErrorFontURLsKey. These URLs represent the font files that caused the error, and were not successfully unregistered. Must be released by caller. Can be NULL.
@result Returns true if unregistration of all font URLs was successful. Otherwise false.
*/
bool CTFontManagerUnregisterFontsForURLs(
CFArrayRef fontURLs,
CTFontManagerScope scope,
CFArrayRef _Nullable * _Nullable errors ) CT_DEPRECATED_WITH_REPLACEMENT("CTFontManagerUnregisterFontURLs", macos(10.6, 10.15), ios(4.1, 13.0), watchos(2.0, 6.0), tvos(9.0, 13.0));
#if defined(__BLOCKS__)
/*!
@function CTFontManagerRegisterFontURLs
@abstract Registers fonts from the specified font URLs with the font manager. Registered fonts are discoverable through font descriptor matching in the calling process
@discussion In iOS, fonts registered with the persistent scope are not automatically available to other processes. Other process may call CTFontManagerRequestFonts to get access to these fonts.
@param fontURLs
A file URL for the fonts or collections (TTC or OTC) to be registered. Once fonts have been registered from a file, it shouldn't be moved or renamed.
@param scope
Scope constant defining the availability and lifetime of the registration. See scope constants for more details.
@param enabled
Boolean value indicating whether the font derived from the URL should be enabled for font descriptor matching and/or discoverable via CTFontManagerRequestFonts.
@param registrationHandler
Block called as errors are discovered or upon completion. The errors parameter contains an array of CFError references. An empty array indicates no errors. Each error reference will contain a CFArray of font URLs corresponding to kCTFontManagerErrorFontURLsKey. These URLs represent the font files that caused the error, and were not successfully registered. Note, the handler may be called multiple times during the registration process. The done parameter will be set to true when the registration process has completed. The handler should return false if the operation is to be stopped. This may be desirable after receiving an error.
*/
void CTFontManagerRegisterFontURLs(
CFArrayRef fontURLs,
CTFontManagerScope scope,
bool enabled,
bool (^ _Nullable registrationHandler)(CFArrayRef errors, bool done) ) CT_AVAILABLE(macos(10.15), ios(13.0), watchos(6.0), tvos(13.0));
/*!
@function CTFontManagerUnregisterFontURLs
@abstract Unregisters fonts from the specified font URLs with the font manager. Unregistered fonts do not participate in font descriptor matching.
iOS note: only fonts registered with CTFontManagerRegisterFontsForURL or CTFontManagerRegisterFontsForURLs can be unregistered with this API.
@param fontURLs
Array of font URLs.
@param scope
Scope constant defining the availability and lifetime of the registration. Should match the scope the fonts are registered in. See scope constants for more details.
@param registrationHandler
Block called as errors are discovered or upon completion. The errors parameter will be an empty array if all files are unregistered. Otherwise, it will contain an array of CFError references. Each error reference will contain a CFArray of font URLs corresponding to kCTFontManagerErrorFontURLsKey. These URLs represent the font files that caused the error, and were not successfully unregistered. Note, the handler may be called multiple times during the unregistration process. The done parameter will be set to true when the unregistration process has completed. The handler should return false if the operation is to be stopped. This may be desirable after receiving an error.
*/
void CTFontManagerUnregisterFontURLs(
CFArrayRef fontURLs,
CTFontManagerScope scope,
bool (^ _Nullable registrationHandler)(CFArrayRef errors, bool done) ) CT_AVAILABLE(macos(10.15), ios(13.0), watchos(6.0), tvos(13.0));
/*!
@function CTFontManagerRegisterFontDescriptors
@abstract Registers font descriptors with the font manager. Registered fonts are discoverable through font descriptor matching in the calling process.
@discussion Fonts descriptors registered in disabled state are not immediately available for descriptor matching but the font manager will know the descriptors could be made available if necessary. These decriptors can be enabled by making this called again with the enabled parameter set to true. This operation may fail if there is another font registered and enabled with the same Postscript name. In iOS, fonts registered with the persistent scope are not automatically available to other processes. Other process may call CTFontManagerRequestFonts to get access to these fonts.
@param fontDescriptors
Array of font descriptors to register. Font descriptor keys used for registration are: kCTFontURLAttribute, kCTFontNameAttribute, kCTFontFamilyNameAttribute, or kCTFontRegistrationUserInfoAttribute.
@param scope
Scope constant defining the availability and lifetime of the registration. See scope constants for more details.
@param enabled
Boolean value indicating whether the font descriptors should be enabled for font descriptor matching and/or discoverable via CTFontManagerRequestFonts.
@param registrationHandler
Block called as errors are discovered or upon completion. The errors parameter contains an array of CFError references. An empty array indicates no errors. Each error reference will contain a CFArray of font descriptors corresponding to kCTFontManagerErrorFontDescriptorsKey. These represent the font descriptors that caused the error, and were not successfully registered. Note, the handler may be called multiple times during the registration process. The done parameter will be set to true when the registration process has completed. The handler should return false if the operation is to be stopped. This may be desirable after receiving an error.
*/
void CTFontManagerRegisterFontDescriptors(
CFArrayRef fontDescriptors,
CTFontManagerScope scope,
bool enabled,
bool (^ _Nullable registrationHandler)(CFArrayRef errors, bool done) ) CT_AVAILABLE(macos(10.15), ios(13.0), watchos(6.0), tvos(13.0));
/*!
@function CTFontManagerUnregisterFontDescriptors
@abstract Unregisters font descriptors with the font manager. Unregistered fonts do not participate in font descriptor matching.
@param fontDescriptors
Array of font descriptors to unregister.
@param scope
Scope constant defining the availability and lifetime of the registration. See scope constants for more details.
@param registrationHandler
Block called as errors are discovered or upon completion. The errors parameter will be an empty array if all font descriptors are unregistered. Otherwise, it will contain an array of CFError references. Each error reference will contain a CFArray of font descriptors corresponding to kCTFontManagerErrorFontDescriptorsKey. These represent the font descriptors that caused the error, and were not successfully unregistered. Note, the handler may be called multiple times during the unregistration process. The done parameter will be set to true when the unregistration process has completed. The handler should return false if the operation is to be stopped. This may be desirable after receiving an error.
*/
void CTFontManagerUnregisterFontDescriptors(
CFArrayRef fontDescriptors,
CTFontManagerScope scope,
bool (^ _Nullable registrationHandler)(CFArrayRef errors, bool done) ) CT_AVAILABLE(macos(10.15), ios(13.0), watchos(6.0), tvos(13.0));
#endif // defined(__BLOCKS__)
/*!
@function CTFontManagerRegisterFontsWithAssetNames
@abstract Registers named font assets in the specified bundle with the font manager. Registered fonts are discoverable through font descriptor matching in the calling process.
@discussion Font assets are extracted from the asset catalog and registered. This call must be made after the completion handler of either NSBundleResourceRequest beginAccessingResourcesWithCompletionHandler: or conditionallyBeginAccessingResourcesWithCompletionHandler: is called successfully.
Name the assets using Postscript names for individual faces, or family names for variable/collection fonts. The same names can be used to unregister the fonts with CTFontManagerUnregisterFontDescriptors. In iOS, fonts registered with the persistent scope are not automatically available to other processes. Other process may call CTFontManagerRequestFonts to get access to these fonts.
@param fontAssetNames
Array of font name assets in asset catalog.
@param bundle
Bundle containing asset catalog. A null value resolves to the main bundle.
@param scope
Scope constant defining the availability and lifetime of the registration. kCTFontManagerScopePersistent is the only supported scope for iOS.
@param enabled
Boolean value indicating whether the font assets should be enabled for font descriptor matching and/or discoverable via CTFontManagerRequestFonts.
@param registrationHandler
Block called as errors are discovered, or upon completion. The errors parameter contains an array of CFError references. An empty array indicates no errors. Each error reference will contain a CFArray of font asset names corresponding to kCTFontManagerErrorFontAssetNameKey. These represent the font asset names that were not successfully registered. Note, the handler may be called multiple times during the registration process. The done parameter will be set to true when the registration process has completed. The handler should return false if the operation is to be stopped. This may be desirable after receiving an error.
*/
void CTFontManagerRegisterFontsWithAssetNames(
CFArrayRef fontAssetNames,
CFBundleRef _Nullable bundle,
CTFontManagerScope scope,
bool enabled,
bool (^ _Nullable registrationHandler)(CFArrayRef errors, bool done) ) CT_AVAILABLE(ios(13.0)) API_UNAVAILABLE(macos, watchos, tvos);
/*!
@function CTFontManagerEnableFontDescriptors
@abstract Enables or disables the matching font descriptors for font descriptor matching.
@param descriptors
Array of font descriptors.
@param enable
Boolean value indicating whether the fonts matching descriptors should be enabled for font descriptor matching.
*/
void CTFontManagerEnableFontDescriptors(
CFArrayRef descriptors,
bool enable ) CT_AVAILABLE(macos(10.6)) CT_UNAVAILABLE(ios, watchos, tvos);
/*!
@function CTFontManagerGetScopeForURL
@abstract Returns the registration scope of the specified URL.
@param fontURL
Font URL.
@result Returns the registration scope of the specified URL, will return kCTFontManagerScopeNone if not currently registered.
*/
CTFontManagerScope CTFontManagerGetScopeForURL(
CFURLRef fontURL ) CT_AVAILABLE(macos(10.6)) CT_UNAVAILABLE(ios, watchos, tvos);
/*!
@function CTFontManagerCopyRegisteredFontDescriptors
@abstract Returns the font descriptors that were registered with the font manager.
@discussion In the case the persistent scope is specified, only macOS can return fonts registered by any process. Other platforms can only return font descriptors registered by the application's process.
@param scope
Scope constant defining the availability and lifetime of the registration. See scope constants for more details.
@param enabled
Boolean value indicating if the caller is interested in registered font descriptors that are enabled or disabled.
@result Array of of font descriptors registered by the application. Array may be empty if nothing is registered.
*/
CFArrayRef CTFontManagerCopyRegisteredFontDescriptors(
CTFontManagerScope scope,
bool enabled ) CT_AVAILABLE(ios(13.0)) API_UNAVAILABLE(macos, watchos, tvos);
#if defined(__BLOCKS__)
/*!
@function CTFontManagerRequestFonts
@abstract Resolves font descriptors specified on input. On iOS only, if the font descriptors cannot be found, the user is presented with a dialog indicating fonts that could not be resolved. The user may optionally be provided with a way to resolve the missing fonts if the font manager has a way to enable them.
@discussion On iOS, fonts registered by font provider applications in the persistent scope are not automatically available to other applications. Client applications must call this function to make the requested fonts available for font descriptor matching.
@param fontDescriptors
Array of font descriptors to make available to the process. Keys used to describe the fonts may be a combination of: kCTFontNameAttribute, kCTFontFamilyNameAttribute, or kCTFontRegistrationUserInfoAttribute.
@param completionHandler
Block called after request operation completes. Block takes a single parameter containing an array of those descriptors that could not be resolved/found. The array can be empty if all descriptors were resolved.
*/
void CTFontManagerRequestFonts(
CFArrayRef fontDescriptors,
void (^completionHandler)(CFArrayRef unresolvedFontDescriptors) ) CT_AVAILABLE(ios(13.0)) API_UNAVAILABLE(macos, watchos, tvos);
#endif // defined(__BLOCKS__)
/*!
@function CTFontManagerIsSupportedFont
@abstract Determines whether a file is in a supported font format.
@discussion This function does not validate any font data, so clients using it must still be prepared to handle failed registration or font descriptor creation.
@param fontURL
A file URL.
@result This function returns true if the file is in a supported font format.
*/
bool CTFontManagerIsSupportedFont(
CFURLRef fontURL ) CT_AVAILABLE(macos(10.6)) CT_UNAVAILABLE(ios, watchos, tvos);
/*! --------------------------------------------------------------------------
@group Manager Auto-Activation
*///--------------------------------------------------------------------------
#if defined(__BLOCKS__)
/*!
@function CTFontManagerCreateFontRequestRunLoopSource
@abstract Creates a CFRunLoopSourceRef that will be used to convey font requests from CTFontManager.
@param sourceOrder
The order of the created run loop source.
@param createMatchesCallback
A block to handle the font request.
@result A CFRunLoopSourceRef that should be added to the run loop. To stop receiving requests, invalidate this run loop source. Will return NULL on error, in the case of a duplicate requestPortName or invalid context structure.
*/
CFRunLoopSourceRef _Nullable CTFontManagerCreateFontRequestRunLoopSource(
CFIndex sourceOrder,
CFArrayRef (^createMatchesCallback)(CFDictionaryRef requestAttributes, pid_t requestingProcess)) CT_DEPRECATED("This functionality will be removed in a future release", macos(10.6, 11.0)) CT_UNAVAILABLE(ios, watchos, tvos);
#endif // defined(__BLOCKS__)
/*!
@const kCTFontManagerBundleIdentifier
@abstract CTFontManage bundle identifier
@discussion The CTFontManager bundle identifier to be used with get or set global auto-activation settings.
*/
CT_EXPORT const CFStringRef kCTFontManagerBundleIdentifier CT_AVAILABLE(macos(10.6)) CT_UNAVAILABLE(ios, watchos, tvos);
/*!
@enum
@abstract Auto-activation settings.
@constant kCTFontManagerAutoActivationDefault
Default auto-activation setting. When specified, the application will use the global setting.
@constant kCTFontManagerAutoActivationDisabled
Disables auto-activation.
@constant kCTFontManagerAutoActivationEnabled
Enables auto-activation.
@constant kCTFontManagerAutoActivationPromptUser - deprecated and treated as kCTFontManagerAutoActivationDefault on 10.13.
Requires user input for auto-activation. A dialog will be presented to the user to confirm auto
activation of the font.
*/
typedef CF_ENUM(uint32_t, CTFontManagerAutoActivationSetting) {
kCTFontManagerAutoActivationDefault = 0,
kCTFontManagerAutoActivationDisabled = 1,
kCTFontManagerAutoActivationEnabled = 2,
kCTFontManagerAutoActivationPromptUser CT_ENUM_DEPRECATED("Deprecated", macos(10.6, 10.13)) CT_ENUM_UNAVAILABLE(ios, watchos, tvos) = 3
};
/*!
@function CTFontManagerSetAutoActivationSetting
@abstract Sets the auto-activation for the specified bundle identifier.
@param bundleIdentifier
The bundle identifier. Used to specify a particular application bundle. If NULL,
the current application bundle will be used. If kCTFontManagerBundleIdentifier is specified,
will set the global auto-activation settings.
@param setting
The new setting.
@discussion Function will apply the setting to the appropriate preferences location.
*/
void CTFontManagerSetAutoActivationSetting(
CFStringRef _Nullable bundleIdentifier,
CTFontManagerAutoActivationSetting setting ) CT_AVAILABLE(macos(10.6)) CT_UNAVAILABLE(ios, watchos, tvos);
/*!
@function CTFontManagerGetAutoActivationSetting
@abstract Accessor for the auto-activation setting.
@param bundleIdentifier
The bundle identifier. Used to specify a particular application bundle. If NULL,
the current application bundle will be used. If kCTFontManagerBundleIdentifier is specified,
will set the global auto-activation settings.
@result Will return the auto-activation setting for specified bundle identifier.
*/
CTFontManagerAutoActivationSetting CTFontManagerGetAutoActivationSetting(
CFStringRef _Nullable bundleIdentifier ) CT_AVAILABLE(macos(10.6)) CT_UNAVAILABLE(ios, watchos, tvos);
/*! --------------------------------------------------------------------------
@group Manager Notifications
*///--------------------------------------------------------------------------
/*!
@constant kCTFontManagerRegisteredFontsChangedNotification
@abstract Notification name for font registry changes.
@discussion This is the string to use as the notification name when subscribing
to CTFontManager notifications. This notification will be posted when fonts are added or removed.
OS X clients should register as an observer of the notification with the distributed notification center
for changes in session or persistent scopes and with the local notification center for changes in process scope.
iOS clients should register as an observer of the notification with the local notification center for all changes.
*/
CT_EXPORT const CFStringRef kCTFontManagerRegisteredFontsChangedNotification CT_AVAILABLE(macos(10.6), ios(7.0), watchos(2.0), tvos(9.0));
CF_ASSUME_NONNULL_END
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework/Headers/CTRunDelegate.h | /*
* CTRunDelegate.h
* CoreText
*
* Copyright (c) 2006-2018 Apple Inc. All rights reserved.
*
*/
#ifndef __CTRUNDELEGATE__
#define __CTRUNDELEGATE__
#include <CoreText/CTRun.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
CF_ASSUME_NONNULL_BEGIN
/* --------------------------------------------------------------------------- */
/* Run Delegate Types */
/* --------------------------------------------------------------------------- */
typedef const struct CF_BRIDGED_TYPE(id) __CTRunDelegate * CTRunDelegateRef;
/*!
@function CTRunDelegateGetTypeID
@abstract Returns the CFType of CTRunDelegate objects.
*/
CFTypeID CTRunDelegateGetTypeID( void ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/* --------------------------------------------------------------------------- */
/* Run Delegate Callbacks */
/* --------------------------------------------------------------------------- */
/*!
@typedef CTRunDelegateDeallocateCallback
@abstract The callback invoked when a CTRunDelegate is deallocated.
@param refCon
The value supplied to CTRunDelegateCreate.
*/
typedef void (*CTRunDelegateDeallocateCallback) (
void * refCon );
/*!
@typedef CTRunDelegateGetAscentCallback
@abstract The callback used to determine typographic ascent.
@param refCon
The value supplied to CTRunDelegateCreate.
@result A CGFloat value indicating the typographic ascent of glyphs to
which a run delegate pertains.
*/
typedef CGFloat (*CTRunDelegateGetAscentCallback) (
void * refCon );
/*!
@typedef CTRunDelegateGetDescentCallback
@abstract The callback used to determine typographic descent.
@param refCon
The value supplied to CTRunDelegateCreate.
@result A CGFloat value indicating the typographic descent of glyphs to
which a run delegate pertains.
*/
typedef CGFloat (*CTRunDelegateGetDescentCallback) (
void * refCon );
/*!
@typedef CTRunDelegateGetWidthCallback
@abstract The callback used to determine width.
@param refCon
The value supplied to CTRunDelegateCreate.
@result A CGFloat value indicating the width of glyphs to which a run
delegate pertains. A value of 0.0 indicates that the glyphs
should not be drawn.
*/
typedef CGFloat (*CTRunDelegateGetWidthCallback) (
void * refCon );
/*!
@typedef CTRunDelegateCallbacks
@abstract Structure containing the callbacks of a CTRunDelegate.
@discussion These callbacks are provided by the owner of a run delegate and
are used to modify glyph metrics during layout. The values
returned by a delegate are applied to each glyph in the run(s)
corresponding to the attribute containing that delegate.
@field version
The version number of the callbacks being passed in as a
parameter to CTRunDelegateCreate. This field should always
be set to kCTRunDelegateCurrentVersion.
@field dealloc
The callback used when a CTRunDelegate's retain count reaches
0 and the CTRunDelegate is deallocated. This callback may be
NULL.
@field getAscent
The callback used to indicate the ascent of the
CTRunDelegate. This callback may be NULL, which is equivalent
to a getAscent callback that always returns 0.
@field getDescent
The callback used to indicate the descent of the
CTRunDelegate. This callback may be NULL, which is equivalent
to a getDescent callback that always returns 0.
@field getWidth
The callback used to indicate the width of the
CTRunDelegate. This callback may be NULL, which is equivalent
to a getWidth callback that always returns 0.
*/
typedef struct
{
CFIndex version;
CTRunDelegateDeallocateCallback dealloc;
CTRunDelegateGetAscentCallback getAscent;
CTRunDelegateGetDescentCallback getDescent;
CTRunDelegateGetWidthCallback getWidth;
} CTRunDelegateCallbacks;
/* --------------------------------------------------------------------------- */
/* Run Delegate Versions */
/* --------------------------------------------------------------------------- */
/*!
@enum Run Delegate Versions
@discussion Set version field of CTRunDelegateCallbacks to kCTRunDelegateCurrentVersion
when calling CTRunDelegateCreate.
*/
enum {
kCTRunDelegateVersion1 = 1,
kCTRunDelegateCurrentVersion = kCTRunDelegateVersion1
};
/* --------------------------------------------------------------------------- */
/* Run Delegate Creation */
/* --------------------------------------------------------------------------- */
/*!
@function CTRunDelegateCreate
@abstract Creates an immutable instance of a run delegate.
@discussion This function creates an immutable instance of a run delegate
that can be used for reserving space in a line or for eliding the
glyphs for a range of text altogether.
@param callbacks
The callbacks for this run delegate.
@result If run delegate creation was successful, this function will
return a valid reference to an immutable CTRunDelegate
object. Otherwise, this function will return NULL.
*/
CTRunDelegateRef _Nullable CTRunDelegateCreate(
const CTRunDelegateCallbacks* callbacks,
void * _Nullable refCon ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/* --------------------------------------------------------------------------- */
/* Run Delegate Access */
/* --------------------------------------------------------------------------- */
/*!
@function CTRunDelegateGetRefCon
@abstract Returns a run delegate's refCon value.
@discussion This function returns the refCon value that a run delegate was
created with.
@param runDelegate
The run delegate to be queried.
@result The refCon value of the supplied run delegate.
*/
void * CTRunDelegateGetRefCon(
CTRunDelegateRef runDelegate ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
CF_ASSUME_NONNULL_END
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework/Headers/SFNTLayoutTypes.h | /*
* SFNTLayoutTypes.h
* CoreText
*
* Copyright 1994-2021 Apple Inc. All rights reserved.
*
*/
#ifndef __SFNTLAYOUTTYPES__
#define __SFNTLAYOUTTYPES__
#include <TargetConditionals.h>
#include <Availability.h>
#if !TARGET_OS_WIN32
#include <MacTypes.h>
#elif !defined(__MACTYPES__)
typedef SInt32 Fixed;
#endif
#ifdef __cplusplus
extern "C" {
#endif
#pragma pack(push, 2)
/* ----------------------------------------------------------------------------------------- */
/* CONSTANTS */
/*
The following values can be used to set run feature values. Note that unless the
feature is defaulted differently in different fonts, the zero value for the
selectors represents the default value. Consult the following URL for further info:
<https://developer.apple.com/fonts/TrueType-Reference-Manual/RM09/AppendixF.html>
*/
/*
* Summary:
* Feature types
*/
enum {
kAllTypographicFeaturesType = 0,
kLigaturesType = 1,
kCursiveConnectionType = 2,
kLetterCaseType = 3, /* deprecated - use kLowerCaseType or kUpperCaseType instead */
kVerticalSubstitutionType = 4,
kLinguisticRearrangementType = 5,
kNumberSpacingType = 6,
kSmartSwashType = 8,
kDiacriticsType = 9,
kVerticalPositionType = 10,
kFractionsType = 11,
kOverlappingCharactersType = 13,
kTypographicExtrasType = 14,
kMathematicalExtrasType = 15,
kOrnamentSetsType = 16,
kCharacterAlternativesType = 17,
kDesignComplexityType = 18,
kStyleOptionsType = 19,
kCharacterShapeType = 20,
kNumberCaseType = 21,
kTextSpacingType = 22,
kTransliterationType = 23,
kAnnotationType = 24,
kKanaSpacingType = 25,
kIdeographicSpacingType = 26,
kUnicodeDecompositionType = 27,
kRubyKanaType = 28,
kCJKSymbolAlternativesType = 29,
kIdeographicAlternativesType = 30,
kCJKVerticalRomanPlacementType = 31,
kItalicCJKRomanType = 32,
kCaseSensitiveLayoutType = 33,
kAlternateKanaType = 34,
kStylisticAlternativesType = 35,
kContextualAlternatesType = 36,
kLowerCaseType = 37,
kUpperCaseType = 38,
kLanguageTagType = 39,
kCJKRomanSpacingType = 103,
kLastFeatureType = -1
};
/*
* Summary:
* Selectors for feature type kAllTypographicFeaturesType
*/
enum {
kAllTypeFeaturesOnSelector = 0,
kAllTypeFeaturesOffSelector = 1
};
/*
* Summary:
* Selectors for feature type kLigaturesType
*/
enum {
kRequiredLigaturesOnSelector = 0,
kRequiredLigaturesOffSelector = 1,
kCommonLigaturesOnSelector = 2,
kCommonLigaturesOffSelector = 3,
kRareLigaturesOnSelector = 4,
kRareLigaturesOffSelector = 5,
kLogosOnSelector = 6,
kLogosOffSelector = 7,
kRebusPicturesOnSelector = 8,
kRebusPicturesOffSelector = 9,
kDiphthongLigaturesOnSelector = 10,
kDiphthongLigaturesOffSelector = 11,
kSquaredLigaturesOnSelector = 12,
kSquaredLigaturesOffSelector = 13,
kAbbrevSquaredLigaturesOnSelector = 14,
kAbbrevSquaredLigaturesOffSelector = 15,
kSymbolLigaturesOnSelector = 16,
kSymbolLigaturesOffSelector = 17,
kContextualLigaturesOnSelector = 18,
kContextualLigaturesOffSelector = 19,
kHistoricalLigaturesOnSelector = 20,
kHistoricalLigaturesOffSelector = 21
};
/*
* Summary:
* Selectors for feature type kCursiveConnectionType
*/
enum {
kUnconnectedSelector = 0,
kPartiallyConnectedSelector = 1,
kCursiveSelector = 2
};
/*
* Summary:
* Selectors for feature type kLetterCaseType
*/
enum {
kUpperAndLowerCaseSelector = 0, /* deprecated */
kAllCapsSelector = 1, /* deprecated */
kAllLowerCaseSelector = 2, /* deprecated */
kSmallCapsSelector = 3, /* deprecated */
kInitialCapsSelector = 4, /* deprecated */
kInitialCapsAndSmallCapsSelector = 5 /* deprecated */
};
/*
* Summary:
* Selectors for feature type kVerticalSubstitutionType
*/
enum {
kSubstituteVerticalFormsOnSelector = 0,
kSubstituteVerticalFormsOffSelector = 1
};
/*
* Summary:
* Selectors for feature type kLinguisticRearrangementType
*/
enum {
kLinguisticRearrangementOnSelector = 0,
kLinguisticRearrangementOffSelector = 1
};
/*
* Summary:
* Selectors for feature type kNumberSpacingType
*/
enum {
kMonospacedNumbersSelector = 0,
kProportionalNumbersSelector = 1,
kThirdWidthNumbersSelector = 2,
kQuarterWidthNumbersSelector = 3
};
/*
* Summary:
* Selectors for feature type kSmartSwashType
*/
enum {
kWordInitialSwashesOnSelector = 0,
kWordInitialSwashesOffSelector = 1,
kWordFinalSwashesOnSelector = 2,
kWordFinalSwashesOffSelector = 3,
kLineInitialSwashesOnSelector = 4,
kLineInitialSwashesOffSelector = 5,
kLineFinalSwashesOnSelector = 6,
kLineFinalSwashesOffSelector = 7,
kNonFinalSwashesOnSelector = 8,
kNonFinalSwashesOffSelector = 9
};
/*
* Summary:
* Selectors for feature type kDiacriticsType
*/
enum {
kShowDiacriticsSelector = 0,
kHideDiacriticsSelector = 1,
kDecomposeDiacriticsSelector = 2
};
/*
* Summary:
* Selectors for feature type kVerticalPositionType
*/
enum {
kNormalPositionSelector = 0,
kSuperiorsSelector = 1,
kInferiorsSelector = 2,
kOrdinalsSelector = 3,
kScientificInferiorsSelector = 4
};
/*
* Summary:
* Selectors for feature type kFractionsType
*/
enum {
kNoFractionsSelector = 0,
kVerticalFractionsSelector = 1,
kDiagonalFractionsSelector = 2
};
/*
* Summary:
* Selectors for feature type kOverlappingCharactersType
*/
enum {
kPreventOverlapOnSelector = 0,
kPreventOverlapOffSelector = 1
};
/*
* Summary:
* Selectors for feature type kTypographicExtrasType
*/
enum {
kHyphensToEmDashOnSelector = 0,
kHyphensToEmDashOffSelector = 1,
kHyphenToEnDashOnSelector = 2,
kHyphenToEnDashOffSelector = 3,
kSlashedZeroOnSelector = 4,
kSlashedZeroOffSelector = 5,
kFormInterrobangOnSelector = 6,
kFormInterrobangOffSelector = 7,
kSmartQuotesOnSelector = 8,
kSmartQuotesOffSelector = 9,
kPeriodsToEllipsisOnSelector = 10,
kPeriodsToEllipsisOffSelector = 11
};
/*
* Summary:
* Selectors for feature type kMathematicalExtrasType
*/
enum {
kHyphenToMinusOnSelector = 0,
kHyphenToMinusOffSelector = 1,
kAsteriskToMultiplyOnSelector = 2,
kAsteriskToMultiplyOffSelector = 3,
kSlashToDivideOnSelector = 4,
kSlashToDivideOffSelector = 5,
kInequalityLigaturesOnSelector = 6,
kInequalityLigaturesOffSelector = 7,
kExponentsOnSelector = 8,
kExponentsOffSelector = 9,
kMathematicalGreekOnSelector = 10,
kMathematicalGreekOffSelector = 11
};
/*
* Summary:
* Selectors for feature type kOrnamentSetsType
*/
enum {
kNoOrnamentsSelector = 0,
kDingbatsSelector = 1,
kPiCharactersSelector = 2,
kFleuronsSelector = 3,
kDecorativeBordersSelector = 4,
kInternationalSymbolsSelector = 5,
kMathSymbolsSelector = 6
};
/*
* Summary:
* Selectors for feature type kCharacterAlternativesType
*/
enum {
kNoAlternatesSelector = 0
};
/*
* Summary:
* Selectors for feature type kDesignComplexityType
*/
enum {
kDesignLevel1Selector = 0,
kDesignLevel2Selector = 1,
kDesignLevel3Selector = 2,
kDesignLevel4Selector = 3,
kDesignLevel5Selector = 4
};
/*
* Summary:
* Selectors for feature type kStyleOptionsType
*/
enum {
kNoStyleOptionsSelector = 0,
kDisplayTextSelector = 1,
kEngravedTextSelector = 2,
kIlluminatedCapsSelector = 3,
kTitlingCapsSelector = 4,
kTallCapsSelector = 5
};
/*
* Summary:
* Selectors for feature type kCharacterShapeType
*/
enum {
kTraditionalCharactersSelector = 0,
kSimplifiedCharactersSelector = 1,
kJIS1978CharactersSelector = 2,
kJIS1983CharactersSelector = 3,
kJIS1990CharactersSelector = 4,
kTraditionalAltOneSelector = 5,
kTraditionalAltTwoSelector = 6,
kTraditionalAltThreeSelector = 7,
kTraditionalAltFourSelector = 8,
kTraditionalAltFiveSelector = 9,
kExpertCharactersSelector = 10,
kJIS2004CharactersSelector = 11,
kHojoCharactersSelector = 12,
kNLCCharactersSelector = 13,
kTraditionalNamesCharactersSelector = 14
};
/*
* Summary:
* Selectors for feature type kNumberCaseType
*/
enum {
kLowerCaseNumbersSelector = 0,
kUpperCaseNumbersSelector = 1
};
/*
* Summary:
* Selectors for feature type kTextSpacingType
*/
enum {
kProportionalTextSelector = 0,
kMonospacedTextSelector = 1,
kHalfWidthTextSelector = 2,
kThirdWidthTextSelector = 3,
kQuarterWidthTextSelector = 4,
kAltProportionalTextSelector = 5,
kAltHalfWidthTextSelector = 6
};
/*
* Summary:
* Selectors for feature type kTransliterationType
*/
enum {
kNoTransliterationSelector = 0,
kHanjaToHangulSelector = 1,
kHiraganaToKatakanaSelector = 2,
kKatakanaToHiraganaSelector = 3,
kKanaToRomanizationSelector = 4,
kRomanizationToHiraganaSelector = 5,
kRomanizationToKatakanaSelector = 6,
kHanjaToHangulAltOneSelector = 7,
kHanjaToHangulAltTwoSelector = 8,
kHanjaToHangulAltThreeSelector = 9
};
/*
* Summary:
* Selectors for feature type kAnnotationType
*/
enum {
kNoAnnotationSelector = 0,
kBoxAnnotationSelector = 1,
kRoundedBoxAnnotationSelector = 2,
kCircleAnnotationSelector = 3,
kInvertedCircleAnnotationSelector = 4,
kParenthesisAnnotationSelector = 5,
kPeriodAnnotationSelector = 6,
kRomanNumeralAnnotationSelector = 7,
kDiamondAnnotationSelector = 8,
kInvertedBoxAnnotationSelector = 9,
kInvertedRoundedBoxAnnotationSelector = 10
};
/*
* Summary:
* Selectors for feature type kKanaSpacingType
*/
enum {
kFullWidthKanaSelector = 0,
kProportionalKanaSelector = 1
};
/*
* Summary:
* Selectors for feature type kIdeographicSpacingType
*/
enum {
kFullWidthIdeographsSelector = 0,
kProportionalIdeographsSelector = 1,
kHalfWidthIdeographsSelector = 2
};
/*
* Summary:
* Selectors for feature type kUnicodeDecompositionType
*/
enum {
kCanonicalCompositionOnSelector = 0,
kCanonicalCompositionOffSelector = 1,
kCompatibilityCompositionOnSelector = 2,
kCompatibilityCompositionOffSelector = 3,
kTranscodingCompositionOnSelector = 4,
kTranscodingCompositionOffSelector = 5
};
/*
* Summary:
* Selectors for feature type kRubyKanaType
*/
enum {
kNoRubyKanaSelector = 0, /* deprecated - use kRubyKanaOffSelector instead */
kRubyKanaSelector = 1, /* deprecated - use kRubyKanaOnSelector instead */
kRubyKanaOnSelector = 2,
kRubyKanaOffSelector = 3
};
/*
* Summary:
* Selectors for feature type kCJKSymbolAlternativesType
*/
enum {
kNoCJKSymbolAlternativesSelector = 0,
kCJKSymbolAltOneSelector = 1,
kCJKSymbolAltTwoSelector = 2,
kCJKSymbolAltThreeSelector = 3,
kCJKSymbolAltFourSelector = 4,
kCJKSymbolAltFiveSelector = 5
};
/*
* Summary:
* Selectors for feature type kIdeographicAlternativesType
*/
enum {
kNoIdeographicAlternativesSelector = 0,
kIdeographicAltOneSelector = 1,
kIdeographicAltTwoSelector = 2,
kIdeographicAltThreeSelector = 3,
kIdeographicAltFourSelector = 4,
kIdeographicAltFiveSelector = 5
};
/*
* Summary:
* Selectors for feature type kCJKVerticalRomanPlacementType
*/
enum {
kCJKVerticalRomanCenteredSelector = 0,
kCJKVerticalRomanHBaselineSelector = 1
};
/*
* Summary:
* Selectors for feature type kItalicCJKRomanType
*/
enum {
kNoCJKItalicRomanSelector = 0, /* deprecated - use kCJKItalicRomanOffSelector instead */
kCJKItalicRomanSelector = 1, /* deprecated - use kCJKItalicRomanOnSelector instead */
kCJKItalicRomanOnSelector = 2,
kCJKItalicRomanOffSelector = 3
};
/*
* Summary:
* Selectors for feature type kCaseSensitiveLayoutType
*/
enum {
kCaseSensitiveLayoutOnSelector = 0,
kCaseSensitiveLayoutOffSelector = 1,
kCaseSensitiveSpacingOnSelector = 2,
kCaseSensitiveSpacingOffSelector = 3
};
/*
* Summary:
* Selectors for feature type kAlternateKanaType
*/
enum {
kAlternateHorizKanaOnSelector = 0,
kAlternateHorizKanaOffSelector = 1,
kAlternateVertKanaOnSelector = 2,
kAlternateVertKanaOffSelector = 3
};
/*
* Summary:
* Selectors for feature type kStylisticAlternativesType
*/
enum {
kNoStylisticAlternatesSelector = 0,
kStylisticAltOneOnSelector = 2,
kStylisticAltOneOffSelector = 3,
kStylisticAltTwoOnSelector = 4,
kStylisticAltTwoOffSelector = 5,
kStylisticAltThreeOnSelector = 6,
kStylisticAltThreeOffSelector = 7,
kStylisticAltFourOnSelector = 8,
kStylisticAltFourOffSelector = 9,
kStylisticAltFiveOnSelector = 10,
kStylisticAltFiveOffSelector = 11,
kStylisticAltSixOnSelector = 12,
kStylisticAltSixOffSelector = 13,
kStylisticAltSevenOnSelector = 14,
kStylisticAltSevenOffSelector = 15,
kStylisticAltEightOnSelector = 16,
kStylisticAltEightOffSelector = 17,
kStylisticAltNineOnSelector = 18,
kStylisticAltNineOffSelector = 19,
kStylisticAltTenOnSelector = 20,
kStylisticAltTenOffSelector = 21,
kStylisticAltElevenOnSelector = 22,
kStylisticAltElevenOffSelector = 23,
kStylisticAltTwelveOnSelector = 24,
kStylisticAltTwelveOffSelector = 25,
kStylisticAltThirteenOnSelector = 26,
kStylisticAltThirteenOffSelector = 27,
kStylisticAltFourteenOnSelector = 28,
kStylisticAltFourteenOffSelector = 29,
kStylisticAltFifteenOnSelector = 30,
kStylisticAltFifteenOffSelector = 31,
kStylisticAltSixteenOnSelector = 32,
kStylisticAltSixteenOffSelector = 33,
kStylisticAltSeventeenOnSelector = 34,
kStylisticAltSeventeenOffSelector = 35,
kStylisticAltEighteenOnSelector = 36,
kStylisticAltEighteenOffSelector = 37,
kStylisticAltNineteenOnSelector = 38,
kStylisticAltNineteenOffSelector = 39,
kStylisticAltTwentyOnSelector = 40,
kStylisticAltTwentyOffSelector = 41
};
/*
* Summary:
* Selectors for feature type kContextualAlternatesType
*/
enum {
kContextualAlternatesOnSelector = 0,
kContextualAlternatesOffSelector = 1,
kSwashAlternatesOnSelector = 2,
kSwashAlternatesOffSelector = 3,
kContextualSwashAlternatesOnSelector = 4,
kContextualSwashAlternatesOffSelector = 5
};
/*
* Summary:
* Selectors for feature type kLowerCaseType
*/
enum {
kDefaultLowerCaseSelector = 0,
kLowerCaseSmallCapsSelector = 1,
kLowerCasePetiteCapsSelector = 2
};
/*
* Summary:
* Selectors for feature type kUpperCaseType
*/
enum {
kDefaultUpperCaseSelector = 0,
kUpperCaseSmallCapsSelector = 1,
kUpperCasePetiteCapsSelector = 2
};
/*
* Summary:
* Selectors for feature type kCJKRomanSpacingType
*/
enum {
kHalfWidthCJKRomanSelector = 0,
kProportionalCJKRomanSelector = 1,
kDefaultCJKRomanSelector = 2,
kFullWidthCJKRomanSelector = 3
};
/* --------------------------------------------------------------------------- */
/* ---------------- Table Specific Typedefs and Constants -------------------- */
/* --------------------------------------------------------------------------- */
/* FORMATS FOR TABLE: lookup tables - used within various other tables */
enum {
kSFNTLookupSimpleArray = 0, /* a simple array indexed by glyph code */
kSFNTLookupSegmentSingle = 2, /* segment mapping to single value */
kSFNTLookupSegmentArray = 4, /* segment mapping to lookup array */
kSFNTLookupSingleTable = 6, /* sorted list of glyph, value pairs */
kSFNTLookupTrimmedArray = 8, /* a simple trimmed array indexed by glyph code */
kSFNTLookupVector = 10 /* a simple trimmed vector indexed by glyph code */
};
typedef UInt16 SFNTLookupTableFormat;
typedef UInt16 SFNTLookupValue;
typedef UInt16 SFNTLookupOffset;
typedef UInt32 SFNTLookupKind;
/*
A BinarySearchHeader defines the five standard fields needed to perform quick
lookups in a lookup table (note that using UInt16s, and not ItemCounts or
similar types, is important here, since these tables are in fonts, and the
documented font formats specify 16-bit quantities).
*/
struct SFNTLookupBinarySearchHeader {
UInt16 unitSize; /* size of a unit in bytes */
UInt16 nUnits; /* number of units in table */
UInt16 searchRange; /* (largest power of two <= nUnits) * unitSize */
UInt16 entrySelector; /* log2 (largest power of two <= nUnits) */
UInt16 rangeShift; /* (nUnits - largest power of two <= nUnits) * unitSize */
};
typedef struct SFNTLookupBinarySearchHeader SFNTLookupBinarySearchHeader;
/* A format 0 lookup table maps all glyphs in the font to lookup values */
struct SFNTLookupArrayHeader {
SFNTLookupValue lookupValues[1];
};
typedef struct SFNTLookupArrayHeader SFNTLookupArrayHeader;
/* A format 8 lookup table maps some range of glyphs in the font to lookup values */
struct SFNTLookupTrimmedArrayHeader {
UInt16 firstGlyph;
UInt16 count;
SFNTLookupValue valueArray[1];
};
typedef struct SFNTLookupTrimmedArrayHeader SFNTLookupTrimmedArrayHeader;
/* A format 10 lookup table maps some range of glyphs in the font to lookup values of the specified size */
struct SFNTLookupVectorHeader {
UInt16 valueSize;
UInt16 firstGlyph;
UInt16 count;
UInt8 values[1];
};
typedef struct SFNTLookupVectorHeader SFNTLookupVectorHeader;
/*
Format 2 and format 4 lookup tables map ranges of glyphs to either single lookup
values (format 2), or per-glyph lookup values (format 4). Since both formats
use the same kind of data, only one unified set of segment-related structures
is defined.
*/
struct SFNTLookupSegment {
UInt16 lastGlyph;
UInt16 firstGlyph;
UInt16 value[1];
};
typedef struct SFNTLookupSegment SFNTLookupSegment;
struct SFNTLookupSegmentHeader {
SFNTLookupBinarySearchHeader binSearch;
SFNTLookupSegment segments[1];
};
typedef struct SFNTLookupSegmentHeader SFNTLookupSegmentHeader;
/* A format 6 lookup table maps single glyphs to lookup values. */
struct SFNTLookupSingle {
UInt16 glyph;
UInt16 value[1];
};
typedef struct SFNTLookupSingle SFNTLookupSingle;
struct SFNTLookupSingleHeader {
SFNTLookupBinarySearchHeader binSearch;
SFNTLookupSingle entries[1];
};
typedef struct SFNTLookupSingleHeader SFNTLookupSingleHeader;
/* The format-specific part of the subtable header */
union SFNTLookupFormatSpecificHeader {
SFNTLookupArrayHeader theArray;
SFNTLookupSegmentHeader segment;
SFNTLookupSingleHeader single;
SFNTLookupTrimmedArrayHeader trimmedArray;
SFNTLookupVectorHeader vector;
};
typedef union SFNTLookupFormatSpecificHeader SFNTLookupFormatSpecificHeader;
/* The overall subtable header */
struct SFNTLookupTable {
SFNTLookupTableFormat format; /* table format */
SFNTLookupFormatSpecificHeader fsHeader; /* format specific header */
};
typedef struct SFNTLookupTable SFNTLookupTable;
typedef SFNTLookupTable * SFNTLookupTablePtr;
typedef SFNTLookupTablePtr * SFNTLookupTableHandle;
/* --------------------------------------------------------------------------- */
/* GENERAL FORMATS FOR STATE TABLES -- prefix "ST" */
enum {
kSTClassEndOfText = 0,
kSTClassOutOfBounds = 1,
kSTClassDeletedGlyph = 2,
kSTClassEndOfLine = 3,
kSTSetMark = 0x8000,
kSTNoAdvance = 0x4000,
kSTMarkEnd = 0x2000,
kSTLigActionMask = 0x3FFF,
kSTRearrVerbMask = 0x000F
};
typedef UInt8 STClass;
typedef UInt8 STEntryIndex;
struct STHeader {
UInt8 filler;
STClass nClasses;
UInt16 classTableOffset;
UInt16 stateArrayOffset;
UInt16 entryTableOffset;
};
typedef struct STHeader STHeader;
struct STClassTable {
UInt16 firstGlyph;
UInt16 nGlyphs;
STClass classes[1];
};
typedef struct STClassTable STClassTable;
struct STEntryZero {
UInt16 newState;
UInt16 flags;
};
typedef struct STEntryZero STEntryZero;
struct STEntryOne {
UInt16 newState;
UInt16 flags;
UInt16 offset1;
};
typedef struct STEntryOne STEntryOne;
struct STEntryTwo {
UInt16 newState;
UInt16 flags;
UInt16 offset1;
UInt16 offset2;
};
typedef struct STEntryTwo STEntryTwo;
/* --------------------------------------------------------------------------- */
/* GENERAL FORMATS FOR STATE TABLES to be used with 'morx' tables -- prefix "STX" */
enum {
kSTXHasLigAction = 0x2000
};
typedef UInt16 STXClass;
typedef UInt16 STXStateIndex;
typedef UInt16 STXEntryIndex;
struct STXHeader {
UInt32 nClasses;
UInt32 classTableOffset;
UInt32 stateArrayOffset;
UInt32 entryTableOffset;
};
typedef struct STXHeader STXHeader;
typedef SFNTLookupTable STXClassTable;
struct STXEntryZero {
STXStateIndex newState;
UInt16 flags;
};
typedef struct STXEntryZero STXEntryZero;
struct STXEntryOne {
STXStateIndex newState;
UInt16 flags;
UInt16 index1;
};
typedef struct STXEntryOne STXEntryOne;
struct STXEntryTwo {
STXStateIndex newState;
UInt16 flags;
UInt16 index1;
UInt16 index2;
};
typedef struct STXEntryTwo STXEntryTwo;
/* --------------------------------------------------------------------------- */
/* GENERAL FORMATS FOR STATE TABLES to be used with 'kerx' tables -- prefix "STK" */
enum {
kSTKCrossStreamReset = 0x2000
};
/* --------------------------------------------------------------------------- */
/* FORMATS FOR TABLE: 'lcar' */
/* CONSTANTS */
enum {
kLCARTag = 0x6C636172, /* 'lcar' */
kLCARCurrentVersion = 0x00010000, /* current version number for 'lcar' table */
kLCARLinearFormat = 0,
kLCARCtlPointFormat = 1
};
/* TYPES */
struct LcarCaretClassEntry {
UInt16 count;
UInt16 partials[1]; /* these are either FUnits or control-point numbers */
};
typedef struct LcarCaretClassEntry LcarCaretClassEntry;
struct LcarCaretTable {
Fixed version;
UInt16 format;
SFNTLookupTable lookup;
};
typedef struct LcarCaretTable LcarCaretTable;
typedef LcarCaretTable * LcarCaretTablePtr;
/* --------------------------------------------------------------------------- */
/* FORMATS FOR TABLE: 'just' */
/* CONSTANTS */
enum {
kJUSTTag = 0x6A757374, /* 'just' */
kJUSTCurrentVersion = 0x00010000,
kJUSTStandardFormat = 0,
kJUSTnoGlyphcode = 0xFFFF, /* used in a pcConditionalAddAction */
kJUSTpcDecompositionAction = 0,
kJUSTpcUnconditionalAddAction = 1,
kJUSTpcConditionalAddAction = 2,
kJUSTpcGlyphStretchAction = 3,
kJUSTpcDuctilityAction = 4,
kJUSTpcGlyphRepeatAddAction = 5
};
/* Justification priority levels */
enum {
kJUSTKashidaPriority = 0,
kJUSTSpacePriority = 1,
kJUSTLetterPriority = 2,
kJUSTNullPriority = 3,
kJUSTPriorityCount = 4
};
/* Justification flags */
enum {
kJUSTOverridePriority = 0x8000,
kJUSTOverrideLimits = 0x4000,
kJUSTOverrideUnlimited = 0x2000,
kJUSTUnlimited = 0x1000,
kJUSTPriorityMask = 0x0003
};
/* TYPES */
typedef UInt16 JustPCActionType;
typedef UInt16 JustificationFlags;
/* A JustPCDecompositionAction defines a ligature decomposition action. */
struct JustPCDecompositionAction {
Fixed lowerLimit;
Fixed upperLimit;
UInt16 order;
UInt16 count;
UInt16 glyphs[1];
};
typedef struct JustPCDecompositionAction JustPCDecompositionAction;
/* A JUSTPCUnconditionalAddAction defines an unconditional glyph add action. */
typedef UInt16 JustPCUnconditionalAddAction;
/*
A JUSTPCConditionalAddAction defines a glyph substitution and add action. If the addGlyph
is equal to kJUSTnoGlyphcode, then no glyph will be added, and the justification for
the line will be redone.
*/
struct JustPCConditionalAddAction {
Fixed substThreshold; /* threshold of growth factor at which subst occurs */
UInt16 addGlyph;
UInt16 substGlyph;
};
typedef struct JustPCConditionalAddAction JustPCConditionalAddAction;
/* A PCDuctilityAction defines a ductile axis along which the glyph will be varied. */
struct JustPCDuctilityAction {
UInt32 ductilityAxis;
Fixed minimumLimit;
Fixed noStretchValue;
Fixed maximumLimit;
};
typedef struct JustPCDuctilityAction JustPCDuctilityAction;
/*
A PCGlyphRepetitionAction defines a glyph which will not be stretched or otherwise
transformed, but rather which will be emplaced however many times are needed to fill
the needed gap.
*/
struct JustPCGlyphRepeatAddAction {
UInt16 flags;
UInt16 glyph;
};
typedef struct JustPCGlyphRepeatAddAction JustPCGlyphRepeatAddAction;
/* PCActionSubrecords contain the actual postcompensation actions. */
struct JustPCActionSubrecord {
UInt16 theClass; /* justification class value associated with this rec */
JustPCActionType theType;
UInt32 length;
UInt32 data; /* not really a UInt32; cast as ptr to appropriate action */
};
typedef struct JustPCActionSubrecord JustPCActionSubrecord;
/* The set of postcompensation records is defined in a PCAction struct. */
struct JustPCAction {
UInt32 actionCount; /* long for alignment purposes */
JustPCActionSubrecord actions[1];
};
typedef struct JustPCAction JustPCAction;
/*
JustWidthDeltaEntry is the justification table entry structure. The justClass value (which is
actually limited to 7 bits by the state table structure) is defined as a long for PPC alignment reasons.
*/
struct JustWidthDeltaEntry {
UInt32 justClass;
Fixed beforeGrowLimit; /* ems AW can grow by at most on LT */
Fixed beforeShrinkLimit; /* ems AW can shrink by at most on LT */
Fixed afterGrowLimit; /* ems AW can grow by at most on RB */
Fixed afterShrinkLimit; /* ems AW can shrink by at most on RB */
JustificationFlags growFlags; /* flags controlling grow case */
JustificationFlags shrinkFlags; /* flags controlling shrink case */
};
typedef struct JustWidthDeltaEntry JustWidthDeltaEntry;
struct JustWidthDeltaGroup {
UInt32 count;
JustWidthDeltaEntry entries[1];
};
typedef struct JustWidthDeltaGroup JustWidthDeltaGroup;
/* Overall structure of a postcompensation table is defined in PostcompTable. */
struct JustPostcompTable {
SFNTLookupTable lookupTable;
/* action records here */
};
typedef struct JustPostcompTable JustPostcompTable;
struct JustDirectionTable {
UInt16 justClass; /* offset to state table (0=none) */
UInt16 widthDeltaClusters; /* offset to clusters */
UInt16 postcomp; /* offset to postcomp table (0=none) */
SFNTLookupTable lookup;
};
typedef struct JustDirectionTable JustDirectionTable;
struct JustTable {
Fixed version;
UInt16 format;
UInt16 horizHeaderOffset;
UInt16 vertHeaderOffset;
};
typedef struct JustTable JustTable;
/* --------------------------------------------------------------------------- */
/* FORMATS FOR TABLE: 'opbd' */
/* CONSTANTS */
enum {
kOPBDTag = 0x6F706264, /* 'opbd' */
kOPBDCurrentVersion = 0x00010000,
kOPBDDistanceFormat = 0,
kOPBDControlPointFormat = 1
};
/* TYPES */
typedef UInt16 OpbdTableFormat;
/*
The OpbdSideValues struct is the lookup result from the FindSingle call for the
optical tables. It contains the 4 FUnit values that are relevant to the specified
glyph, or the 4 control gxPoint values.
*/
struct OpbdSideValues {
SInt16 leftSideShift;
SInt16 topSideShift;
SInt16 rightSideShift;
SInt16 bottomSideShift;
};
typedef struct OpbdSideValues OpbdSideValues;
struct OpbdTable {
Fixed version;
OpbdTableFormat format;
SFNTLookupTable lookupTable;
};
typedef struct OpbdTable OpbdTable;
/* --------------------------------------------------------------------------- */
/* FORMATS FOR TABLE: 'mort' */
/* CONSTANTS */
enum {
kMORTTag = 0x6D6F7274, /* 'mort' */
kMORTCurrentVersion = 0x00010000, /* current version number for 'mort' table */
/* Coverage masks */
kMORTCoverVertical = 0x8000,
kMORTCoverDescending = 0x4000,
kMORTCoverIgnoreVertical = 0x2000,
kMORTCoverTypeMask = 0x000F, /* Subtable types */
kMORTRearrangementType = 0,
kMORTContextualType = 1,
kMORTLigatureType = 2,
kMORTSwashType = 4,
kMORTInsertionType = 5, /* Ligature subtable constants */
kMORTLigLastAction = (int)0x80000000,
kMORTLigStoreLigature = 0x40000000,
kMORTLigFormOffsetMask = 0x3FFFFFFF,
kMORTLigFormOffsetShift = 2, /* Rearrangement subtable actions */
kMORTraNoAction = 0, /* no action */
kMORTraxA = 1, /* Ax => xA */
kMORTraDx = 2, /* xD => Dx */
kMORTraDxA = 3, /* AxD => DxA */
kMORTraxAB = 4, /* ABx => xAB */
kMORTraxBA = 5, /* ABx => xBA */
kMORTraCDx = 6, /* xCD => CDx */
kMORTraDCx = 7, /* xCD => DCx */
kMORTraCDxA = 8, /* AxCD => CDxA */
kMORTraDCxA = 9, /* AxCD => DCxA */
kMORTraDxAB = 10, /* ABxD => DxAB */
kMORTraDxBA = 11, /* ABxD => DxBA */
kMORTraCDxAB = 12, /* ABxCD => CDxAB */
kMORTraCDxBA = 13, /* ABxCD => CDxBA */
kMORTraDCxAB = 14, /* ABxCD => DCxAB */
kMORTraDCxBA = 15, /* ABxCD => DCxBA */
/* Insertion subtable constants */
kMORTDoInsertionsBefore = 0x80,
kMORTIsSplitVowelPiece = 0x40,
kMORTInsertionsCountMask = 0x3F,
kMORTCurrInsertKashidaLike = 0x2000,
kMORTMarkInsertKashidaLike = 0x1000,
kMORTCurrInsertBefore = 0x0800,
kMORTMarkInsertBefore = 0x0400,
kMORTMarkJustTableCountMask = 0x3F80,
kMORTMarkJustTableCountShift = 7, /* JustTableIndex for marked character */
kMORTCurrJustTableCountMask = 0x007F,
kMORTCurrJustTableCountShift = 0, /* JustTableIndex for current character */
kMORTCurrInsertCountMask = 0x03E0,
kMORTCurrInsertCountShift = 5, /* count to insert after current glyphRec */
kMORTMarkInsertCountMask = 0x001F,
kMORTMarkInsertCountShift = 0 /* count to insert after marked glyphRec */
};
/* TYPES */
typedef UInt32 MortSubtableMaskFlags;
typedef UInt32 MortLigatureActionEntry;
struct MortRearrangementSubtable {
STHeader header;
};
typedef struct MortRearrangementSubtable MortRearrangementSubtable;
struct MortContextualSubtable {
STHeader header;
UInt16 substitutionTableOffset;
};
typedef struct MortContextualSubtable MortContextualSubtable;
struct MortLigatureSubtable {
STHeader header;
UInt16 ligatureActionTableOffset;
UInt16 componentTableOffset;
UInt16 ligatureTableOffset;
};
typedef struct MortLigatureSubtable MortLigatureSubtable;
struct MortSwashSubtable {
SFNTLookupTable lookup;
};
typedef struct MortSwashSubtable MortSwashSubtable;
struct MortInsertionSubtable {
STHeader header;
};
typedef struct MortInsertionSubtable MortInsertionSubtable;
union MortSpecificSubtable {
MortRearrangementSubtable rearrangement;
MortContextualSubtable contextual;
MortLigatureSubtable ligature;
MortSwashSubtable swash;
MortInsertionSubtable insertion;
};
typedef union MortSpecificSubtable MortSpecificSubtable;
struct MortSubtable {
UInt16 length;
UInt16 coverage;
MortSubtableMaskFlags flags;
MortSpecificSubtable u;
};
typedef struct MortSubtable MortSubtable;
struct MortFeatureEntry {
UInt16 featureType;
UInt16 featureSelector;
MortSubtableMaskFlags enableFlags;
MortSubtableMaskFlags disableFlags;
};
typedef struct MortFeatureEntry MortFeatureEntry;
struct MortChain {
MortSubtableMaskFlags defaultFlags; /* default flags for this chain */
UInt32 length; /* byte length of this chain */
UInt16 nFeatures; /* number of feature entries */
UInt16 nSubtables; /* number of subtables */
MortFeatureEntry featureEntries[1];
/* the subtables follow */
};
typedef struct MortChain MortChain;
struct MortTable {
Fixed version;
UInt32 nChains;
MortChain chains[1];
};
typedef struct MortTable MortTable;
/* --------------------------------------------------------------------------- */
/* FORMATS FOR TABLE: 'morx' (version 2 and beyond metamorphosis tables) */
/* CONSTANTS */
enum {
kMORXTag = 0x6D6F7278, /* 'morx' */
kMORXCurrentVersion = 0x00020000, /* version number for current 'morx' table */
/* Coverage masks */
kMORXCoverVertical = (int)0x80000000,
kMORXCoverDescending = 0x40000000,
kMORXCoverIgnoreVertical = 0x20000000,
kMORXCoverLogicalOrder = 0x10000000,
kMORXCoverTypeMask = 0x000000FF
};
/* TYPES */
struct MorxRearrangementSubtable {
STXHeader header;
};
typedef struct MorxRearrangementSubtable MorxRearrangementSubtable;
struct MorxContextualSubtable {
STXHeader header;
UInt32 substitutionTableOffset;
};
typedef struct MorxContextualSubtable MorxContextualSubtable;
struct MorxLigatureSubtable {
STXHeader header;
UInt32 ligatureActionTableOffset;
UInt32 componentTableOffset;
UInt32 ligatureTableOffset;
};
typedef struct MorxLigatureSubtable MorxLigatureSubtable;
struct MorxInsertionSubtable {
STXHeader header;
UInt32 insertionGlyphTableOffset;
};
typedef struct MorxInsertionSubtable MorxInsertionSubtable;
union MorxSpecificSubtable {
MorxRearrangementSubtable rearrangement;
MorxContextualSubtable contextual;
MorxLigatureSubtable ligature;
MortSwashSubtable swash;
MorxInsertionSubtable insertion;
};
typedef union MorxSpecificSubtable MorxSpecificSubtable;
struct MorxSubtable {
UInt32 length;
UInt32 coverage;
MortSubtableMaskFlags flags;
MorxSpecificSubtable u;
};
typedef struct MorxSubtable MorxSubtable;
struct MorxChain {
MortSubtableMaskFlags defaultFlags; /* default flags for this chain */
UInt32 length; /* byte length of this chain */
UInt32 nFeatures; /* number of feature entries */
UInt32 nSubtables; /* number of subtables */
MortFeatureEntry featureEntries[1];
/* the subtables follow */
};
typedef struct MorxChain MorxChain;
struct MorxTable {
Fixed version;
UInt32 nChains;
MorxChain chains[1];
};
typedef struct MorxTable MorxTable;
/* --------------------------------------------------------------------------- */
/* FORMATS FOR TABLE: 'prop' */
/* CONSTANTS */
enum {
kPROPTag = 0x70726F70, /* 'prop' */
kPROPCurrentVersion = 0x00030000, /* current version number for 'prop' table */
kPROPPairOffsetShift = 8,
kPROPPairOffsetSign = 7,
kPROPIsFloaterMask = 0x8000, /* glyph is floater */
kPROPCanHangLTMask = 0x4000, /* glyph can hang left/top */
kPROPCanHangRBMask = 0x2000, /* glyph can hang right/bottom */
kPROPUseRLPairMask = 0x1000, /* if glyph lands in RL streak, use paired glyph */
kPROPPairOffsetMask = 0x0F00, /* 4-bit signed offset to other pair member */
kPROPRightConnectMask = 0x0080, /* glyph connects to glyph on right */
kPROPZeroReserved = 0x0060, /* must be zero */
kPROPDirectionMask = 0x001F /* direction bits */
};
/* These are the Unicode direction classes (plus the Special European Number class). */
enum {
kPROPLDirectionClass = 0, /* Left-to-Right */
kPROPRDirectionClass = 1, /* Right-to-Left */
kPROPALDirectionClass = 2, /* Right-to-Left Arabic Letter */
kPROPENDirectionClass = 3, /* European Number */
kPROPESDirectionClass = 4, /* European Number Separator */
kPROPETDirectionClass = 5, /* European Number Terminator */
kPROPANDirectionClass = 6, /* Arabic Number */
kPROPCSDirectionClass = 7, /* Common Number Separator */
kPROPPSDirectionClass = 8, /* Paragraph Separator (also referred to as Block Separator) */
kPROPSDirectionClass = 9, /* Segment Separator */
kPROPWSDirectionClass = 10, /* Whitespace */
kPROPONDirectionClass = 11, /* Other Neutral */
kPROPSENDirectionClass = 12, /* Special European Number (not a Unicode class) */
kPROPLREDirectionClass = 13, /* Left-to-Right Embedding */
kPROPLRODirectionClass = 14, /* Left-to-Right Override */
kPROPRLEDirectionClass = 15, /* Right-to-Left Embedding */
kPROPRLODirectionClass = 16, /* Right-to-Left Override */
kPROPPDFDirectionClass = 17, /* Pop Directional Format */
kPROPNSMDirectionClass = 18, /* Non-Spacing Mark */
kPROPBNDirectionClass = 19, /* Boundary Neutral */
kPROPNumDirectionClasses = 20 /* Number of Unicode directional types + Special European Number */
};
/* TYPES */
typedef UInt16 PropCharProperties;
struct PropTable {
Fixed version;
UInt16 format;
PropCharProperties defaultProps;
SFNTLookupTable lookup;
};
typedef struct PropTable PropTable;
struct PropLookupSegment {
UInt16 lastGlyph;
UInt16 firstGlyph;
UInt16 value;
};
typedef struct PropLookupSegment PropLookupSegment;
struct PropLookupSingle {
UInt16 glyph;
PropCharProperties props;
};
typedef struct PropLookupSingle PropLookupSingle;
/* --------------------------------------------------------------------------- */
/* FORMATS FOR TABLE: 'trak' */
/* CONSTANTS */
enum {
kTRAKTag = 0x7472616B, /* 'trak' */
kTRAKCurrentVersion = 0x00010000, /* current version number for 'trak' table */
kTRAKUniformFormat = 0 /* kTRAKPerGlyphFormat = 2*/
};
/* TYPES */
typedef SInt16 TrakValue;
struct TrakTableEntry {
Fixed track;
UInt16 nameTableIndex;
UInt16 sizesOffset; /* offset to array of TrackingValues */
};
typedef struct TrakTableEntry TrakTableEntry;
struct TrakTableData {
UInt16 nTracks;
UInt16 nSizes;
UInt32 sizeTableOffset;
TrakTableEntry trakTable[1];
};
typedef struct TrakTableData TrakTableData;
struct TrakTable {
Fixed version;
UInt16 format;
UInt16 horizOffset;
UInt16 vertOffset;
};
typedef struct TrakTable TrakTable;
/* --------------------------------------------------------------------------- */
/* FORMATS FOR TABLE: 'kern' */
/* CONSTANTS */
enum {
kKERNTag = 0x6B65726E, /* 'kern' */
kKERNCurrentVersion = 0x00010000,
kKERNVertical = 0x8000, /* set if this table has vertical kerning information */
kKERNResetCrossStream = 0x8000, /* this value in a cross-stream table means reset to zero */
kKERNCrossStream = 0x4000, /* set if this table contains cross-stream kerning values */
kKERNVariation = 0x2000, /* set if this table contains variation kerning values */
kKERNUnusedBits = 0x1F00, /* UNUSED, MUST BE ZERO */
kKERNFormatMask = 0x00FF /* format of this subtable */
};
enum {
kKERNOrderedList = 0, /* ordered list of kerning pairs */
kKERNStateTable = 1, /* state table for n-way contextual kerning */
kKERNSimpleArray = 2, /* simple n X m array of kerning values */
kKERNIndexArray = 3 /* modified version of SimpleArray */
};
/* Message Type Flags */
enum {
kKERNLineStart = 0x00000001, /* Array of glyphs starts a line */
kKERNLineEndKerning = 0x00000002, /* Array of glyphs ends a line */
kKERNNoCrossKerning = 0x00000004, /* Prohibit cross kerning */
kKERNNotesRequested = 0x00000008, /* Caller wants kerning notes */
kKERNNoStakeNote = 1, /* Indicates a glyph was involved in a kerning pair/group */
kKERNCrossStreamResetNote = 2, /* Indicates a return-to-baseline in cross-stream kerning */
kKERNNotApplied = 0x00000001 /* All kerning values were zero, kerning call had no effect */
};
/* TYPES */
typedef UInt8 KernTableFormat;
typedef UInt16 KernSubtableInfo;
typedef SInt16 KernKerningValue;
typedef UInt16 KernArrayOffset;
/* header for version 0 kerning table */
struct KernVersion0Header {
UInt16 version; /* font version number (will be 0!) */
UInt16 nTables; /* number of subtables present */
UInt16 firstSubtable[1]; /* first subtable starts here */
};
typedef struct KernVersion0Header KernVersion0Header;
/* Header for a kerning table */
struct KernTableHeader {
Fixed version; /* font version number (currently 1.0) */
SInt32 nTables; /* number of subtables present */
UInt16 firstSubtable[1]; /* first subtable starts here */
};
typedef struct KernTableHeader KernTableHeader;
typedef KernTableHeader * KernTableHeaderPtr;
typedef KernTableHeaderPtr * KernTableHeaderHandle;
/*
F O R M A T S P E C I F I C D E F I N I T I O N S
kernOrderedList:
The table is a sorted list of [left glyph, right glyph, value] triples.
There's enough information in the header so that the list can be
efficiently binary searched.
*/
/* defines a single kerning pair of Glyphcodes */
struct KernKerningPair {
UInt16 left;
UInt16 right;
};
typedef struct KernKerningPair KernKerningPair;
/* a single list entry */
struct KernOrderedListEntry {
KernKerningPair pair; /* the kerning pair */
KernKerningValue value; /* the kerning value for the above pair */
};
typedef struct KernOrderedListEntry KernOrderedListEntry;
typedef KernOrderedListEntry * KernOrderedListEntryPtr;
/* the header information for binary searching the list */
struct KernOrderedListHeader {
UInt16 nPairs; /* number of kerning pairs in table */
UInt16 searchRange; /* (largest power of two <= nPairs) * entry size */
UInt16 entrySelector; /* log2 (largest power of two <= nPairs) */
UInt16 rangeShift; /* (nPairs - largest power of two <= nPairs) * entry size */
UInt16 table[1]; /* entries are first glyph, second glyph, and value */
};
typedef struct KernOrderedListHeader KernOrderedListHeader;
/* KernStateTable: like the the generic state tables */
struct KernStateHeader {
STHeader header; /* state table header */
UInt16 valueTable; /* offset to kerning value table */
UInt8 firstTable[1]; /* first table starts here */
};
typedef struct KernStateHeader KernStateHeader;
struct KernStateEntry {
UInt16 newState;
UInt16 flags; /* flags per above enum */
};
typedef struct KernStateEntry KernStateEntry;
/*
Kern offset table header.
The offset table is a trimmed array from firstGlyph to limitGlyph.
Glyphs outside of this range should get zero for right-hand glyphs
and the offset of the beginning of the kerning array for left-hand glyphs.
*/
struct KernOffsetTable {
UInt16 firstGlyph; /* first glyph in class range */
UInt16 nGlyphs; /* number of glyphs in class range */
KernArrayOffset offsetTable[1]; /* offset table starts here */
};
typedef struct KernOffsetTable KernOffsetTable;
typedef KernOffsetTable * KernOffsetTablePtr;
/* Header information for accessing offset tables and kerning array */
/*
KernSimpleArray:
The array is an nXm array of kerning values. Each row in the array
represents one left-hand glyph, and each column one right-hand glyph.
The zeroth row and column always represent glyphs that are out of bounds
and will always contain zero.
A pair is looked up by indexing the left-hand glyph through the left
offset table, the right-hand glyph through the right offset table,
adding both offsets to the starting address of the kerning array,
and fetching the kerning value pointed to.
*/
/* Kern offset table header. */
/* The offset table is a trimmed array from firstGlyph to limitGlyph. */
/* Glyphs outside of this range should get zero for right-hand glyphs */
/* and the offset of the beginning of the kerning array for left- */
/* hand glyphs. */
struct KernSimpleArrayHeader {
UInt16 rowWidth; /* width, in bytes, of a row in the table */
UInt16 leftOffsetTable; /* offset to left-hand offset table */
UInt16 rightOffsetTable; /* offset to right-hand offset table */
KernArrayOffset theArray; /* offset to start of kerning array */
UInt16 firstTable[1]; /* first offset table starts here... */
};
typedef struct KernSimpleArrayHeader KernSimpleArrayHeader;
/* Index Array */
struct KernIndexArrayHeader {
UInt16 glyphCount;
UInt8 kernValueCount;
UInt8 leftClassCount;
UInt8 rightClassCount;
UInt8 flags; /* set to 0 for now */
SInt16 kernValue[1]; /* actual kerning values reference by index in kernIndex */
UInt8 leftClass[1]; /* maps left glyph to offset into kern index */
UInt8 rightClass[1]; /* maps right glyph to offset into kern index */
UInt8 kernIndex[1]; /* contains indicies into kernValue */
};
typedef struct KernIndexArrayHeader KernIndexArrayHeader;
/* format specific part of subtable header */
union KernFormatSpecificHeader {
KernOrderedListHeader orderedList;
KernStateHeader stateTable;
KernSimpleArrayHeader simpleArray;
KernIndexArrayHeader indexArray;
};
typedef union KernFormatSpecificHeader KernFormatSpecificHeader;
/* version 0 subtable header */
struct KernVersion0SubtableHeader {
UInt16 version; /* kerning table version number */
UInt16 length; /* length in bytes (including this header) */
KernSubtableInfo stInfo; /* sub-table info */
KernFormatSpecificHeader fsHeader; /* format specific sub-header */
};
typedef struct KernVersion0SubtableHeader KernVersion0SubtableHeader;
/* Overall Subtable header format */
struct KernSubtableHeader {
SInt32 length; /* length in bytes (including this header) */
KernSubtableInfo stInfo; /* subtable info */
SInt16 tupleIndex; /* tuple index for variation subtables */
KernFormatSpecificHeader fsHeader; /* format specific sub-header */
};
typedef struct KernSubtableHeader KernSubtableHeader;
typedef KernSubtableHeader * KernSubtableHeaderPtr;
/* --------------------------------------------------------------------------- */
/* FORMATS FOR TABLE: 'kerx' */
/* CONSTANTS */
enum {
kKERXTag = 0x6B657278, /* 'kerx' */
kKERXCurrentVersion = 0x00020000,
kKERXVertical = (int)0x80000000, /* set if this table has vertical kerning information */
kKERXResetCrossStream = 0x8000, /* this value in a cross-stream table means reset to zero */
kKERXCrossStream = 0x40000000, /* set if this table contains cross-stream kerning values */
kKERXVariation = 0x20000000, /* set if this table contains variation kerning values */
kKERXDescending = 0x10000000,
kKERXUnusedBits = 0x0FFFFF00, /* UNUSED, MUST BE ZERO */
kKERXFormatMask = 0x000000FF /* format of this subtable */
};
enum {
kKERXOrderedList = 0, /* ordered list of kerning pairs */
kKERXStateTable = 1, /* state table for n-way contextual kerning */
kKERXSimpleArray = 2, /* simple n X m array of kerning values */
kKERXControlPoint = 4, /* state table for control point positioning */
kKERXIndexArray = 6 /* index-based n X m array of kerning values */
};
/* Message Type Flags */
enum {
kKERXLineStart = 0x00000001, /* Array of glyphs starts a line */
kKERXLineEndKerning = 0x00000002, /* Array of glyphs ends a line */
kKERXNoCrossKerning = 0x00000004, /* Prohibit cross kerning */
kKERXNotesRequested = 0x00000008, /* Caller wants kerning notes */
kKERXNoStakeNote = 1, /* Indicates a glyph was involved in a kerning pair/group */
kKERXCrossStreamResetNote = 2, /* Indicates a return-to-baseline in cross-stream kerning */
kKERXNotApplied = 0x00000001 /* All kerning values were zero, kerning call had no effect */
};
/* Flags in KerxControlPointHeader */
enum {
kKERXActionTypeMask = (3U << 30), /* Mask to extract action type */
kKERXActionTypeControlPoints = (0U << 30), /* Actions have control point numbers */
kKERXActionTypeAnchorPoints = (1U << 30), /* Actions have anchor point numbers */
kKERXActionTypeCoordinates = (2U << 30), /* Actions have control point coordinates */
kKERXUnusedFlags = 0x3F000000, /* Unused, must be zero */
kKERXActionOffsetMask = 0x00FFFFFF, /* Mask to extract offset to action table */
};
/* Flags in KerxIndexArrayHeader */
enum {
kKERXValuesAreLong = 0x00000001
};
/* TYPES */
typedef UInt32 KerxSubtableCoverage;
typedef UInt32 KerxArrayOffset;
/* Header for an extended kerning table */
struct KerxTableHeader {
Fixed version; /* font version number (currently 1.0) */
UInt32 nTables; /* number of subtables present */
UInt32 firstSubtable[1]; /* first subtable starts here */
};
typedef struct KerxTableHeader KerxTableHeader;
typedef KerxTableHeader * KerxTableHeaderPtr;
typedef KerxTableHeaderPtr * KerxTableHeaderHandle;
/*
F O R M A T S P E C I F I C D E F I N I T I O N S
kerxOrderedList:
The table is a sorted list of [left glyph, right glyph, value] triples.
There's enough information in the header so that the list can be
efficiently binary searched.
*/
/* defines a single kerning pair of Glyphcodes */
struct KerxKerningPair {
UInt16 left;
UInt16 right;
};
typedef struct KerxKerningPair KerxKerningPair;
/* a single list entry */
struct KerxOrderedListEntry {
KerxKerningPair pair; /* the kerning pair */
KernKerningValue value; /* the kerning value for the above pair */
};
typedef struct KerxOrderedListEntry KerxOrderedListEntry;
typedef KerxOrderedListEntry * KerxOrderedListEntryPtr;
/* the header information for binary searching the list */
struct KerxOrderedListHeader {
UInt32 nPairs; /* number of kerning pairs in table */
UInt32 searchRange; /* (largest power of two <= nPairs) * entry size */
UInt32 entrySelector; /* log2 (largest power of two <= nPairs) */
UInt32 rangeShift; /* (nPairs - largest power of two <= nPairs) * entry size */
UInt32 table[1]; /* entries are first glyph, second glyph, and value */
};
typedef struct KerxOrderedListHeader KerxOrderedListHeader;
/* KernStateTable: like the the generic state tables */
struct KerxStateHeader {
STXHeader header; /* state table header */
UInt32 valueTable; /* offset to kerning value table */
UInt8 firstTable[1]; /* first table starts here */
};
typedef struct KerxStateHeader KerxStateHeader;
struct KerxStateEntry {
UInt16 newState;
UInt16 flags; /* flags per above enum */
UInt16 valueIndex;
};
typedef struct KerxStateEntry KerxStateEntry;
/* KerxControlPointTable: like the the generic state tables */
struct KerxControlPointHeader {
STXHeader header; /* state table header */
UInt32 flags; /* flags */
UInt8 firstTable[1]; /* first table starts here */
};
typedef struct KerxControlPointHeader KerxControlPointHeader;
struct KerxControlPointEntry {
UInt16 newState;
UInt16 flags; /* flags per above enum */
UInt16 actionIndex;
};
typedef struct KerxControlPointEntry KerxControlPointEntry;
struct KerxControlPointAction {
UInt16 markControlPoint;
UInt16 currControlPoint;
};
typedef struct KerxControlPointAction KerxControlPointAction;
struct KerxAnchorPointAction {
UInt16 markAnchorPoint;
UInt16 currAnchorPoint;
};
typedef struct KerxAnchorPointAction KerxAnchorPointAction;
struct KerxCoordinateAction {
UInt16 markX;
UInt16 markY;
UInt16 currX;
UInt16 currY;
};
typedef struct KerxCoordinateAction KerxCoordinateAction;
/*
KerxSimpleArray:
The array is an nXm array of kerning values. Each row in the array
represents one left-hand glyph, and each column one right-hand glyph.
The zeroth row and column always represent glyphs that are out of bounds
and will always contain zero.
A pair is looked up by indexing the left-hand glyph through the left
offset table, the right-hand glyph through the right offset table,
adding both offsets to the starting address of the kerning array,
and fetching the kerning value pointed to.
*/
struct KerxSimpleArrayHeader {
UInt32 rowWidth; /* width, in bytes, of a row in the table */
UInt32 leftOffsetTable; /* offset to left-hand offset table */
UInt32 rightOffsetTable; /* offset to right-hand offset table */
KerxArrayOffset theArray; /* offset to start of kerning array */
UInt32 firstTable[1]; /* first offset table starts here... */
};
typedef struct KerxSimpleArrayHeader KerxSimpleArrayHeader;
/* Index Array */
struct KerxIndexArrayHeader {
UInt32 flags;
UInt16 rowCount;
UInt16 columnCount;
UInt32 rowIndexTableOffset; /* offset to row index lookup table */
UInt32 columnIndexTableOffset; /* offset to column index offset table */
UInt32 kerningArrayOffset; /* offset to start of kerning array */
UInt32 kerningVectorOffset; /* offset to start of kerning vectors (if tupleCount is 1 or more) */
};
typedef struct KerxIndexArrayHeader KerxIndexArrayHeader;
/* format specific part of subtable header */
union KerxFormatSpecificHeader {
KerxOrderedListHeader orderedList;
KerxStateHeader stateTable;
KerxSimpleArrayHeader simpleArray;
KerxIndexArrayHeader indexArray;
KerxControlPointHeader controlPoint;
};
typedef union KerxFormatSpecificHeader KerxFormatSpecificHeader;
/* Overall Subtable header format */
struct KerxSubtableHeader {
UInt32 length; /* length in bytes (including this header) */
KerxSubtableCoverage stInfo; /* subtable coverage */
UInt32 tupleCount; /* tuple count for variation subtables (ignored if the 'kerx' table version is less than 4) */
KerxFormatSpecificHeader fsHeader; /* format specific sub-header */
};
typedef struct KerxSubtableHeader KerxSubtableHeader;
typedef KerxSubtableHeader * KerxSubtableHeaderPtr;
/* --------------------------------------------------------------------------- */
/* FORMATS FOR TABLE: 'bsln' */
/* CONSTANTS */
enum {
kBSLNTag = 0x62736C6E, /* 'bsln' */
kBSLNCurrentVersion = 0x00010000, /* current version number for 'bsln' table */
kBSLNDistanceFormatNoMap = 0,
kBSLNDistanceFormatWithMap = 1,
kBSLNControlPointFormatNoMap = 2,
kBSLNControlPointFormatWithMap = 3
};
/* Baseline classes and constants */
enum {
kBSLNRomanBaseline = 0,
kBSLNIdeographicCenterBaseline = 1,
kBSLNIdeographicLowBaseline = 2,
kBSLNHangingBaseline = 3,
kBSLNMathBaseline = 4,
kBSLNIdeographicHighBaseline = 5,
kBSLNLastBaseline = 31,
kBSLNNumBaselineClasses = kBSLNLastBaseline + 1,
kBSLNNoBaseline = 255,
kBSLNNoBaselineOverride = 255
};
/* TYPES */
typedef UInt32 BslnBaselineClass;
/* The BslnBaselineRecord array defines the baseline deltas for the line. */
typedef Fixed BslnBaselineRecord[32];
/*
BslnFormat0Part is the format-specific data for a distance table with no mapping (i.e.
all the glyphs belong to the defaultBaseline).
*/
struct BslnFormat0Part {
SInt16 deltas[32];
};
typedef struct BslnFormat0Part BslnFormat0Part;
/* BslnFormat1Part is the format-specific data for a distance table with a gxMapping. */
struct BslnFormat1Part {
SInt16 deltas[32];
SFNTLookupTable mappingData;
};
typedef struct BslnFormat1Part BslnFormat1Part;
/*
BslnFormat2Part is the format-specific data for a control-point table with no
mapping (i.e. all the glyphs belong to the defaultBaseline). It specifies a single
glyph to use and the set of control points in that glyph that designate each of
the baselines.
*/
struct BslnFormat2Part {
UInt16 stdGlyph;
SInt16 ctlPoints[32];
};
typedef struct BslnFormat2Part BslnFormat2Part;
/*
BslnFormat3Part is the format-specific data for a distance table with a mapping. Like
format 2, it contains a single glyph and its set of control-point values for each
of the baselines.
*/
struct BslnFormat3Part {
UInt16 stdGlyph;
SInt16 ctlPoints[32];
SFNTLookupTable mappingData;
};
typedef struct BslnFormat3Part BslnFormat3Part;
/* The BslnFormatUnion is a union containing the format-specific parts of the baseline table. */
union BslnFormatUnion {
BslnFormat0Part fmt0Part;
BslnFormat1Part fmt1Part;
BslnFormat2Part fmt2Part;
BslnFormat3Part fmt3Part;
};
typedef union BslnFormatUnion BslnFormatUnion;
/* The table format used in BaselineTable */
typedef UInt16 BslnTableFormat;
/* BaselineTable defines the top-level format of the baseline table in the font. */
struct BslnTable {
Fixed version;
BslnTableFormat format;
UInt16 defaultBaseline;
BslnFormatUnion parts;
};
typedef struct BslnTable BslnTable;
typedef BslnTable * BslnTablePtr;
/* --------------------------------------------------------------------------- */
/* FORMATS FOR TABLE: 'ALMX' */
/* TYPES */
struct ALMXHeader {
Fixed Version; /* 16.16 format 1.0 by default */
UInt16 Flags;
UInt16 NMasters;
UInt16 FirstGlyph;
UInt16 LastGlyph;
SFNTLookupTable lookup; /* lookup table */
};
typedef struct ALMXHeader ALMXHeader API_DEPRECATED("Superseded by OpenType", macos(10.0, 12.0), ios(1.0, 15.0), watchos(1.0, 8.0), tvos(1.0, 15.0));
struct ALMXGlyphEntry { /* lookup data for ALMX table */
SInt16 GlyphIndexOffset;
SInt16 HorizontalAdvance;
SInt16 XOffsetToHOrigin;
SInt16 VerticalAdvance;
SInt16 YOffsetToVOrigin;
};
typedef struct ALMXGlyphEntry ALMXGlyphEntry API_DEPRECATED("Superseded by OpenType", macos(10.0, 12.0), ios(1.0, 15.0), watchos(1.0, 8.0), tvos(1.0, 15.0));
/* --------------------------------------------------------------------------- */
/* FORMATS FOR TABLE: 'ROTA' */
/* TYPES */
struct ROTAHeader {
Fixed Version; /* 16.16 format 1.0 by default */
UInt16 Flags;
UInt16 NMasters;
UInt16 FirstGlyph;
UInt16 LastGlyph;
SFNTLookupTable lookup; /* lookup table */
};
typedef struct ROTAHeader ROTAHeader API_DEPRECATED("Superseded by OpenType", macos(10.0, 12.0), ios(1.0, 15.0), watchos(1.0, 8.0), tvos(1.0, 15.0));
struct ROTAGlyphEntry { /* lookup data for ROTA table */
SInt16 GlyphIndexOffset;
SInt16 HBaselineOffset; /* y offset to the rotated horizontal baseline */
SInt16 VBaselineOffset; /* x offset to the rotated vertical baseline */
};
typedef struct ROTAGlyphEntry ROTAGlyphEntry API_DEPRECATED("Superseded by OpenType", macos(10.0, 12.0), ios(1.0, 15.0), watchos(1.0, 8.0), tvos(1.0, 15.0));
/* --------------------------------------------------------------------------- */
/* FORMATS FOR TABLE 'ankr' */
/* CONSTANTS */
enum {
kANKRCurrentVersion = 0
};
/* TYPES */
struct AnchorPoint {
SInt16 x; /* x coordinate of anchor point */
SInt16 y; /* y coordinate of anchor point */
};
typedef struct AnchorPoint AnchorPoint;
struct AnchorPointTable {
UInt32 nPoints; /* number of anchor points defined for this glyph */
AnchorPoint points[1]; /* first anchor point starts here */
};
typedef struct AnchorPointTable AnchorPointTable;
struct AnkrTable {
UInt16 version; /* 0 */
UInt16 flags; /* never leave home without them (see 'Zapf') */
UInt32 lookupTableOffset; /* Byte offset to lookup table mapping glyphs to offset into anchor point table */
UInt32 anchorPointTableOffset; /* Byte offset to start of anchor point table */
};
typedef struct AnkrTable AnkrTable;
/* --------------------------------------------------------------------------- */
/* FORMATS FOR TABLE 'ltag' */
/* CONSTANTS */
enum {
kLTAGCurrentVersion = 1
};
/* TYPES */
struct LtagStringRange {
UInt16 offset; /* offset to the beginning of the string */
UInt16 length; /* string length in bytes */
};
typedef struct LtagStringRange LtagStringRange;
struct LtagTable {
UInt32 version; /* 1 */
UInt32 flags; /* none currently defined */
UInt32 numTags; /* number of language tags which follow */
LtagStringRange tagRange[1]; /* first string range starts here */
};
typedef struct LtagTable LtagTable;
/* --------------------------------------------------------------------------- */
#pragma pack(pop)
#ifdef __cplusplus
}
#endif
#endif // __SFNTLAYOUTTYPES__
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework/Headers/CTTypesetter.h | /*
* CTTypesetter.h
* CoreText
*
* Copyright (c) 2003-2018 Apple Inc. All rights reserved.
*
*/
/*!
@header
Thread Safety Information
All functions in this header are thread safe unless otherwise specified.
*/
#ifndef __CTTYPESETTER__
#define __CTTYPESETTER__
#include <CoreText/CTLine.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
CF_ASSUME_NONNULL_BEGIN
/* --------------------------------------------------------------------------- */
/* Typesetter Types */
/* --------------------------------------------------------------------------- */
typedef const struct CF_BRIDGED_TYPE(id) __CTTypesetter * CTTypesetterRef;
/*!
@function CTTypesetterGetTypeID
@abstract Returns the CFType of the typesetter object
*/
CFTypeID CTTypesetterGetTypeID( void ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/* --------------------------------------------------------------------------- */
/* Typesetter Values */
/* --------------------------------------------------------------------------- */
/*!
@const kCTTypesetterOptionAllowUnboundedLayout
@abstract Allows layout requiring a potentially unbounded amount of work.
@discussion Value must be a CFBooleanRef. Default is false for clients linked on or after macOS 10.14 or iOS 12.
Proper Unicode layout of some text requires unreasonable effort;
unless this option is set to kCFBooleanTrue such inputs will
result in CTTypesetterCreateWithAttributedStringAndOptions
returning NULL.
*/
CT_EXPORT const CFStringRef kCTTypesetterOptionAllowUnboundedLayout CT_AVAILABLE(macos(10.14), ios(12.0), watchos(5.0), tvos(12.0));
/*!
@const kCTTypesetterOptionDisableBidiProcessing
@abstract Disables bidi processing.
@discussion Value must be a CFBooleanRef. Default is false.
Normally, typesetting applies the Unicode Bidirectional
Algorithm as described in UAX #9. If a typesetter is created
with this option set to true, no directional reordering is
performed and any directional control characters are ignored.
*/
CT_EXPORT const CFStringRef kCTTypesetterOptionDisableBidiProcessing CT_DEPRECATED("Deprecated", macos(10.5, 10.8), ios(3.2, 6.0), watchos(2.0, 2.0), tvos(9.0, 9.0));
/*!
@const kCTTypesetterOptionForcedEmbeddingLevel
@abstract Specifies the embedding level.
@discussion Value must be a CFNumberRef. Default is unset. Normally,
typesetting applies the Unicode Bidirectional Algorithm as
described in UAX #9. If present, this specifies the embedding
level and any directional control characters are ignored.
*/
CT_EXPORT const CFStringRef kCTTypesetterOptionForcedEmbeddingLevel CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/* --------------------------------------------------------------------------- */
/* Typesetter Creation */
/* --------------------------------------------------------------------------- */
/*!
@function CTTypesetterCreateWithAttributedString
@abstract Creates an immutable typesetter object using an attributed
string.
@discussion The resultant typesetter can be used to create lines, perform
line breaking, and do other contextual analysis based on the
characters in the string.
@param string
The CFAttributedStringRef that you want to typeset. This
parameter must be filled in with a valid CFAttributedString.
@result This function will return a reference to a CTTypesetter.
*/
CTTypesetterRef CTTypesetterCreateWithAttributedString(
CFAttributedStringRef string ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTTypesetterCreateWithAttributedStringAndOptions
@abstract Creates an immutable typesetter object using an attributed
string and a dictionary of options.
@discussion The resultant typesetter can be used to create lines, perform
line breaking, and do other contextual analysis based on the
characters in the string.
@param string
The CFAttributedStringRef that you want to typeset. This
parameter must be filled in with a valid CFAttributedString.
@param options
A CFDictionary of typesetter options, or NULL if there are none.
@result This function will return either a reference to a CTTypesetter
or NULL if layout cannot be performed due to an attributed
string that would require unreasonable effort.
@seealso kCTTypesetterOptionAllowUnboundedLayout
*/
CTTypesetterRef _Nullable CTTypesetterCreateWithAttributedStringAndOptions(
CFAttributedStringRef string,
CFDictionaryRef _Nullable options ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/* --------------------------------------------------------------------------- */
/* Typeset Line Creation */
/* --------------------------------------------------------------------------- */
/*!
@function CTTypesetterCreateLineWithOffset
@abstract Creates an immutable line from the typesetter.
@discussion The resultant line will consist of glyphs in the correct visual
order, ready to draw.
@param typesetter
The typesetter which the line will come from.
@param stringRange
The string range which the line will be based on. If the length
portion of range is set to 0, then the typesetter will continue
to add glyphs to the line until it runs out of characters in the
string. The location and length of the range must be within the
bounds of the string, otherwise the call will fail.
@param offset
The line position offset.
@result This function will return a reference to a CTLine.
*/
CTLineRef CTTypesetterCreateLineWithOffset(
CTTypesetterRef typesetter,
CFRange stringRange,
double offset ) CT_AVAILABLE(macos(10.6), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTTypesetterCreateLine
@abstract Equivalent to CTTypesetterCreateLineWithOffset with offset = 0.0.
*/
CTLineRef CTTypesetterCreateLine(
CTTypesetterRef typesetter,
CFRange stringRange ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/* --------------------------------------------------------------------------- */
/* Typeset Line Breaking */
/* --------------------------------------------------------------------------- */
/*!
@function CTTypesetterSuggestLineBreakWithOffset
@abstract Suggests a contextual line break point based on the width
provided.
@discussion The line break can be triggered either by a hard break character
in the stream or by filling the specified width with characters.
@param typesetter
The typesetter which the line will come from.
@param startIndex
The starting point for the line break calculations. The break
calculations will include the character starting at startIndex.
@param width
The requested line break width.
@param offset
The line position offset.
@result The value returned is a count of the characters from startIndex
that would cause the line break. This value returned can be used
to construct a character range for CTTypesetterCreateLine.
*/
CFIndex CTTypesetterSuggestLineBreakWithOffset(
CTTypesetterRef typesetter,
CFIndex startIndex,
double width,
double offset ) CT_AVAILABLE(macos(10.6), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTTypesetterSuggestLineBreak
@abstract Equivalent to CTTypesetterSuggestLineBreakWithOffset with offset = 0.0.
*/
CFIndex CTTypesetterSuggestLineBreak(
CTTypesetterRef typesetter,
CFIndex startIndex,
double width ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTTypesetterSuggestClusterBreakWithOffset
@abstract Suggests a cluster line break point based on the width provided.
@discussion Suggests a typographic cluster line break point based on the width
provided. This cluster break is similar to a character break,
except that it will not break apart linguistic clusters. No other
contextual analysis will be done. This can be used by the caller
to implement a different line breaking scheme, such as
hyphenation. Note that a typographic cluster break can also be
triggered by a hard break character in the stream.
@param typesetter
The typesetter which the line will come from.
@param startIndex
The starting point for the typographic cluster break
calculations. The break calculations will include the character
starting at startIndex.
@param width
The requested typographic cluster break width.
@param offset
The line position offset.
@result The value returned is a count of the characters from startIndex
that would cause the cluster break. This value returned can be
used to construct a character range for CTTypesetterCreateLine.
*/
CFIndex CTTypesetterSuggestClusterBreakWithOffset(
CTTypesetterRef typesetter,
CFIndex startIndex,
double width,
double offset ) CT_AVAILABLE(macos(10.6), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTTypesetterSuggestClusterBreak
@abstract Equivalent to CTTypesetterSuggestClusterBreakWithOffset with offset = 0.0.
*/
CFIndex CTTypesetterSuggestClusterBreak(
CTTypesetterRef typesetter,
CFIndex startIndex,
double width ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
CF_ASSUME_NONNULL_END
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework/Headers/CTStringAttributes.h | /*
* CTStringAttributes.h
* CoreText
*
* Copyright (c) 2004-2020 Apple Inc. All rights reserved.
*
*/
#ifndef __CTSTRINGATTRIBUTES__
#define __CTSTRINGATTRIBUTES__
#include <CoreText/CTDefines.h>
#include <CoreFoundation/CoreFoundation.h>
#include <CoreGraphics/CoreGraphics.h>
CF_EXTERN_C_BEGIN
CF_ASSUME_NONNULL_BEGIN
/* The purpose of this file is to define all the attributes to which
CoreText will respond when placed in a CFAttributedString. These
are left out of other header file on purpose in order to avoid
layering problems. This file is allowed to include any other header
file it wants to. */
/* --------------------------------------------------------------------------- */
/* CFAttributedStringRef Attribute Prototypes */
/* --------------------------------------------------------------------------- */
/*!
@const kCTFontAttributeName
@abstract The font.
@discussion Value must be a CTFontRef. Default is Helvetica 12.
*/
CT_EXPORT const CFStringRef kCTFontAttributeName CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@const kCTForegroundColorFromContextAttributeName
@abstract Never set a foreground color in the CGContext; use what is set as
the context's fill color.
@discussion Value must be a CFBooleanRef. Default is false. The reason
why this exists is because an NSAttributedString defaults to a
black color if no color attribute is set. This forces CoreText to
set the color in the context. This will allow developers to
sidestep this, making CoreText set nothing but font information
in the CGContext. If set, this attribute also determines the
color used by kCTUnderlineStyleAttributeName, in which case it
overrides the foreground color.
*/
CT_EXPORT const CFStringRef kCTForegroundColorFromContextAttributeName CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@const kCTKernAttributeName
@abstract A kerning adjustment.
@discussion Value must be a CFNumberRef float. Default is standard kerning.
The kerning attribute indicate how many points the following
character should be shifted from its default offset as defined
by the current character's font in points; a positive kern
indicates a shift farther along and a negative kern indicates a
shift closer to the current character. If this attribute is not
present, standard kerning will be used. If this attribute is
set to 0.0, no kerning will be done at all.
*/
CT_EXPORT const CFStringRef kCTKernAttributeName CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@const kCTTrackingAttributeName
@abstract Applies tracking (letterspacing).
@discussion Value must be a CFNumber. Default is zero (no tracking).
The tracking attribute indicates how much additional space, in
points, should be added to each character cluster after layout.
The effect of this attribute is similar to kCTKernAttributeName
but differs in that the added tracking is treated as trailing
whitespace and a non-zero amount disables non-essential ligatures
unless overridden by kCTLigatureAttributeName being present.
If both kCTKernAttributeName and kCTTrackingAttributeName are
present kCTKernAttributeName will be ignored unless zero;
kCTTrackingAttributeName will still be honored.
@seealso kCTKernAttributeName
@seealso kCTLigatureAttributeName
*/
CT_EXPORT const CFStringRef kCTTrackingAttributeName CT_AVAILABLE(macos(10.12), ios(10.0), watchos(3.0), tvos(10.0));
/*!
@const kCTLigatureAttributeName
@abstract Controls ligature formation.
@discussion Value must be a CFNumberRef. Default is int value 1. The ligature
attribute determines what kinds of ligatures should be used when
displaying the string. A value of 0 indicates that only ligatures
essential for proper rendering of text should be used, 1
indicates that standard ligatures should be used, and 2 indicates
that all available ligatures should be used. Which ligatures are
standard depends on the script and possibly the font. Arabic
text, for example, requires ligatures for many character
sequences, but has a rich set of additional ligatures that
combine characters. English text has no essential ligatures, and
typically has only two standard ligatures, those for "fi" and
"fl" -- all others being considered more advanced or fancy.
On iOS releases prior to 6.0 essential ligatures are applied
if the font contains glyphs for any of U+FB00 through U+FB04 and
the font lacks AAT or OpenType shaping tables, but as of 6.0
shaping tables (or the lack thereof) are treated as definitive.
*/
CT_EXPORT const CFStringRef kCTLigatureAttributeName CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@const kCTForegroundColorAttributeName
@abstract The foreground color.
@discussion Value must be a CGColorRef. Default value is black.
*/
CT_EXPORT const CFStringRef kCTForegroundColorAttributeName CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@const kCTBackgroundColorAttributeName
@abstract The background color.
@discussion Value must be a CGColorRef. Default is no background color.
*/
CT_EXPORT const CFStringRef kCTBackgroundColorAttributeName CT_AVAILABLE(macos(10.12), ios(10.0), watchos(3.0), tvos(10.0));
/*!
@const kCTParagraphStyleAttributeName
@abstract A CTParagraphStyle object which is used to specify things like
line alignment, tab rulers, writing direction, etc.
@discussion Value must be a CTParagraphStyleRef. Default is an empty
CTParagraphStyle object: see CTParagraphStyle.h for more
information. The value of this attribute must be uniform over
the range of any paragraphs to which it is applied.
@seealso CFStringGetParagraphBounds
*/
CT_EXPORT const CFStringRef kCTParagraphStyleAttributeName CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@const kCTStrokeWidthAttributeName
@abstract The stroke width.
@discussion Value must be a CFNumberRef. Default value is 0.0, or no stroke.
This attribute, interpreted as a percentage of font point size,
controls the text drawing mode: positive values effect drawing
with stroke only; negative values are for stroke and fill. A
typical value for outlined text is 3.0.
*/
CT_EXPORT const CFStringRef kCTStrokeWidthAttributeName CT_AVAILABLE(macos(10.6), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@const kCTStrokeColorAttributeName
@abstract The stroke color.
@discussion Value must be a CGColorRef. Default is the foreground color.
*/
CT_EXPORT const CFStringRef kCTStrokeColorAttributeName CT_AVAILABLE(macos(10.6), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@const kCTUnderlineStyleAttributeName
@abstract Allows the setting of an underline to be applied at render
time.
@discussion Value must be a CFNumberRef. Default is kCTUnderlineStyleNone.
Set a value of something other than kCTUnderlineStyleNone to draw
an underline. In addition, the CTUnderlineStyleModifiers can be
used to modify the look of the underline. The underline color
will be determined by the text's foreground color unless
otherwise specified by kCTUnderlineColorAttributeName.
*/
CT_EXPORT const CFStringRef kCTUnderlineStyleAttributeName CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@const kCTSuperscriptAttributeName
@abstract Controls vertical text positioning.
@discussion Value must be a CFNumberRef. Default is int value 0. If supported
by the specified font, a value of 1 enables superscripting and a
value of -1 enables subscripting.
*/
CT_EXPORT const CFStringRef kCTSuperscriptAttributeName CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@const kCTUnderlineColorAttributeName
@abstract The underline color.
@discussion Value must be a CGColorRef. Default is the foreground color.
*/
CT_EXPORT const CFStringRef kCTUnderlineColorAttributeName CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@const kCTVerticalFormsAttributeName
@abstract Controls glyph orientation.
@discussion Value must be a CFBooleanRef. Default is false. A value of false
indicates that horizontal glyph forms are to be used, true
indicates that vertical glyph forms are to be used.
*/
CT_EXPORT const CFStringRef kCTVerticalFormsAttributeName CT_AVAILABLE(macos(10.5), ios(4.3), watchos(2.0), tvos(9.0));
/*!
@const kCTHorizontalInVerticalFormsAttributeName
@abstract Setting text in tate-chu-yoko form (horizontal numerals in vertical text).
@discussion Value must be a CFNumberRef. Default is int value 0. A value of 1
to 4 indicates the number of digits or letters to set in horizontal
form. This is to apply the correct feature settings for the text.
This attribute only works when kCTVerticalFormsAttributeName is set
to true.
*/
CT_EXPORT const CFStringRef kCTHorizontalInVerticalFormsAttributeName CT_AVAILABLE(macos(10.12), ios(10.0), watchos(3.0), tvos(10.0));
/*!
@const kCTGlyphInfoAttributeName
@abstract Allows the use of unencoded glyphs.
@discussion Value must be a CTGlyphInfoRef. The glyph specified by this
CTGlyphInfo object is assigned to the entire attribute range,
provided that its contents match the specified base string and
that the specified glyph is available in the font specified by
kCTFontAttributeName. See CTGlyphInfo.h for more information.
*/
CT_EXPORT const CFStringRef kCTGlyphInfoAttributeName CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@const kCTCharacterShapeAttributeName
@abstract Controls glyph selection.
@discussion Value must be a CFNumberRef. Default is value is 0 (disabled).
A non-zero value is interpreted as an SFNT kCharacterShapeType
selector + 1; see SFNTLayoutTypes.h for selectors. For example,
an attribute value of 1 corresponds to kTraditionalCharactersSelector.
*/
CT_EXPORT const CFStringRef kCTCharacterShapeAttributeName CT_DEPRECATED("Use feature type kCharacterShapeType with the appropriate selector", macos(10.5, 10.11), ios(3.2, 9.0), watchos(2.0, 2.0), tvos(9.0, 9.0));
/*!
@const kCTLanguageAttributeName
@abstract Specifies text language.
@discussion Value must be a CFStringRef containing a locale identifier. Default
is unset. When this attribute is set to a valid identifier, it will
be used to select localized glyphs (if supported by the font) and
locale-specific line breaking rules.
*/
CT_EXPORT const CFStringRef kCTLanguageAttributeName CT_AVAILABLE(macos(10.9), ios(7.0), watchos(2.0), tvos(9.0));
/*!
@const kCTRunDelegateAttributeName
@abstract Allows customization of certain aspects of a range of text's
appearance.
@discussion Value must be a CTRunDelegateRef. The values returned by the
embedded object for an attribute range apply to each glyph
resulting from the text in that range. Because an embedded object
is only a display-time modification, care should be taken to
avoid applying this attribute to a range of text with complex
behavior, such as a change of writing direction, combining marks,
etc. Consequently, it is recommended that this attribute be
applied to a range containing the single character U+FFFC. See
CTRunDelegate.h for more information.
*/
CT_EXPORT const CFStringRef kCTRunDelegateAttributeName CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@enum CTUnderlineStyle
@abstract Underline style specifiers.
@discussion These underline type specifiers can be applied to the value set
with the kCTUnderlineStyleAttributeName attribute to tell
CoreText that you want a different underline style.
*/
typedef CF_OPTIONS(int32_t, CTUnderlineStyle) {
kCTUnderlineStyleNone = 0x00,
kCTUnderlineStyleSingle = 0x01,
kCTUnderlineStyleThick = 0x02,
kCTUnderlineStyleDouble = 0x09
};
/*!
@enum CTUnderlineStyleModifiers
@abstract Underline style modifiers.
@discussion Set these bits with the CTUnderlineStyle that you set with the
kCTUnderlineStyleAttributeName attribute to modify how the
underline will be drawn.
*/
typedef CF_OPTIONS(int32_t, CTUnderlineStyleModifiers) {
kCTUnderlinePatternSolid = 0x0000,
kCTUnderlinePatternDot = 0x0100,
kCTUnderlinePatternDash = 0x0200,
kCTUnderlinePatternDashDot = 0x0300,
kCTUnderlinePatternDashDotDot = 0x0400
};
/*!
@const kCTBaselineClassAttributeName
@abstract Key to reference a baseline class override.
@discussion Value must be one of the kCTBaselineClass constants. Normally,
glyphs on the line will be assigned baseline classes according to
the 'bsln' or 'BASE' table in the font. This attribute may be
used to change this assignment.
@seealso kCTBaselineClassRoman
@seealso kCTBaselineClassIdeographicCentered
@seealso kCTBaselineClassIdeographicLow
@seealso kCTBaselineClassIdeographicHigh
@seealso kCTBaselineClassHanging
@seealso kCTBaselineClassMath
*/
CT_EXPORT const CFStringRef kCTBaselineClassAttributeName CT_AVAILABLE(macos(10.8), ios(6.0), watchos(2.0), tvos(9.0));
/*!
@const kCTBaselineInfoAttributeName
@abstract Key to reference a baseline info dictionary.
@discussion Value must be a CFDictionaryRef. Normally, baseline offsets will
be assigned based on the 'bsln' or 'BASE' table in the font. This
attribute may be used to assign different offsets. Each key in
the dictionary is one of the kCTBaselineClass constants and the
value is a CFNumberRef of the baseline offset in points. You only
need to specify the offsets you wish to change.
@seealso kCTBaselineClassRoman
@seealso kCTBaselineClassIdeographicCentered
@seealso kCTBaselineClassIdeographicLow
@seealso kCTBaselineClassIdeographicHigh
@seealso kCTBaselineClassHanging
@seealso kCTBaselineClassMath
*/
CT_EXPORT const CFStringRef kCTBaselineInfoAttributeName CT_AVAILABLE(macos(10.8), ios(6.0), watchos(2.0), tvos(9.0));
/*!
@const kCTBaselineReferenceInfoAttributeName
@abstract Key to reference a baseline info dictionary for the reference baseline.
@discussion Value must be a CFDictionaryRef. All glyphs in a run are assigned
a baseline class and then aligned to the offset for that class in
the reference baseline baseline info. See the discussion of
kCTBaselineInfoAttributeName for information about the contents
of the dictionary. You can also use the kCTBaselineReferenceFont
key to specify that the baseline offsets of a particular
CTFontRef should be used as the reference offsets.
@seealso kCTBaselineClassRoman
@seealso kCTBaselineClassIdeographicCentered
@seealso kCTBaselineClassIdeographicLow
@seealso kCTBaselineClassIdeographicHigh
@seealso kCTBaselineClassHanging
@seealso kCTBaselineClassMath
@seealso kCTBaselineReferenceFont
*/
CT_EXPORT const CFStringRef kCTBaselineReferenceInfoAttributeName CT_AVAILABLE(macos(10.8), ios(6.0), watchos(2.0), tvos(9.0));
/*!
@const kCTBaselineOffsetAttributeName
@abstract Controls vertical text positioning.
@discussion Value must be a CFNumberRef float. Default is standard positioning.
The baseline attribute indicates how many points the characters
should be shifted perpendicular to their baseline. A positive
baseline value indicates a shift above (or to the right for vertical
text) the text baseline and a negative baseline value indicates a
shift below (or to the left for vertical text) the text baseline.
If this value is set to 0.0, no baseline shift will be performed.
@seealso NSBaselineOffsetAttributeName
*/
CT_EXPORT const CFStringRef kCTBaselineOffsetAttributeName CT_AVAILABLE(macos(10.13), ios(11.0), watchos(4.0), tvos(11.0));
/*!
@const kCTWritingDirectionAttributeName
@abstract Specifies a bidirectional override or embedding.
@discussion Value must be a CFArray of CFNumberRefs, each of which should
have a value of either kCTWritingDirectionLeftToRight or
kCTWritingDirectionRightToLeft, plus one of
kCTWritingDirectionEmbedding or kCTWritingDirectionOverride.
This array represents a sequence of nested bidirectional
embeddings or overrides, in order from outermost to innermost,
with (kCTWritingDirectionLeftToRight | kCTWritingDirectionEmbedding)
corresponding to a LRE/PDF pair in plain text or
<span dir="ltr"></span> in HTML, (kCTWritingDirectionRightToLeft
| kCTWritingDirectionEmbedding) corresponding to a RLE/PDF
pair in plain text or a <span dir="rtl"></span> in HTML,
(kCTWritingDirectionLeftToRight | kCTWritingDirectionOverride)
corresponding to a LRO/PDF pair in plain text or
<bdo dir="ltr"></bdo> in HTML, and (kCTWritingDirectionRightToLeft
| kCTWritingDirectionOverride) corresponding to a RLO/PDF
pair in plain text or <bdo dir="rtl"></bdo> in HTML.
@seealso kCTWritingDirectionLeftToRight
@seealso kCTWritingDirectionRightToLeft
@seealso kCTWritingDirectionEmbedding
@seealso kCTWritingDirectionOverride
*/
CT_EXPORT const CFStringRef kCTWritingDirectionAttributeName CT_AVAILABLE(macos(10.8), ios(6.0), watchos(2.0), tvos(9.0));
/*!
@abstract Additional values for use with kCTWritingDirectionAttributeName
in combination with kCTWritingDirectionLeftToRight or
kCTWritingDirectionRightToLeft.
@seealso kCTWritingDirectionAttributeName
@seealso kCTWritingDirectionLeftToRight
@seealso kCTWritingDirectionRightToLeft
*/
enum {
kCTWritingDirectionEmbedding = (0 << 1),
kCTWritingDirectionOverride = (1 << 1)
};
/*!
@const kCTRubyAnnotationAttributeName
@abstract Key to reference a CTRubyAnnotation.
@discussion Value must be a CTRubyAnnotationRef. See CTRubyAnnotation.h for
more information.
*/
CT_EXPORT const CFStringRef kCTRubyAnnotationAttributeName CT_AVAILABLE(macos(10.10), ios(8.0), watchos(2.0), tvos(9.0));
CF_ASSUME_NONNULL_END
CF_EXTERN_C_END
#endif
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework/Headers/CTFontTraits.h | /*
* CTFontTraits.h
* CoreText
*
* Copyright (c) 2006-2018 Apple Inc. All rights reserved.
*
*/
#ifndef __CTFONTTRAITS__
#define __CTFONTTRAITS__
#include <CoreText/CTDefines.h>
#include <CoreFoundation/CoreFoundation.h>
CF_EXTERN_C_BEGIN
CF_ASSUME_NONNULL_BEGIN
/*!
@defined kCTFontSymbolicTrait
@abstract Dictionary key to access the symbolic traits value.
@discussion Use this key to access the symbolic traits value from the font traits dictionary. The value is returned as a CFNumberRef.
*/
CT_EXPORT const CFStringRef kCTFontSymbolicTrait CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontWeightTrait
@abstract Dictionary key to access the weight trait value.
@discussion Use this key to access the normalized weight trait from the font traits dictionary. The value returned is a CFNumberRef representing a float value between -1.0 and 1.0 for normalized weight. The value of 0.0 corresponds to the regular or medium font weight.
*/
CT_EXPORT const CFStringRef kCTFontWeightTrait CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontWidthTrait
@abstract Dictionary key to access the width (condense/expand) trait value.
@discussion Use this key to access the normalized proportion trait from the font traits dictionary. This value corresponds to the relative inter-glyph spacing for a given font. The value returned is a CFNumberRef representing a float between -1.0 and 1.0. The value of 0.0 corresponds to regular glyph spacing while negative values represent condensed glyph spacing.
*/
CT_EXPORT const CFStringRef kCTFontWidthTrait CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@defined kCTFontSlantTrait
@abstract Dictionary key to access the slant trait value.
@discussion Use this key to access the normalized slant angle from the font traits dictionary. The value returned is a CFNumberRef representing a float value between -1.0 and 1.0 for normalized slant angle. The value or 0.0 corresponds to 0 degree clockwise rotation from the vertical and 1.0 corresponds to 30 degrees clockwise rotation.
*/
CT_EXPORT const CFStringRef kCTFontSlantTrait CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@const kCTFontClassMaskShift
@abstract The font class shift.
@discussion This is used to shift the font class to the upper most 4 bits of the symbolic traits.
*/
enum {
kCTFontClassMaskShift = 28
};
/*!
@enum CTFontSymbolicTraits
@abstract Symbolic representation of stylistic font attributes.
@discussion CTFontSymbolicTraits symbolically describes stylistic aspects of a font. The top 4 bits is used to describe appearance of the font while the lower 28 bits for typeface. The font appearance information represented by the upper 4 bits can be used for stylistic font matching.
*/
typedef CF_OPTIONS(uint32_t, CTFontSymbolicTraits) {
kCTFontTraitItalic = (1 << 0), // Additional detail available via kCTFontSlantTrait
kCTFontTraitBold = (1 << 1), // Additional detail available via kCTFontWeightTrait
kCTFontTraitExpanded = (1 << 5), // Expanded and condensed traits are mutually exclusive
kCTFontTraitCondensed = (1 << 6), // Additional detail available via kCTFontWidthTrait
kCTFontTraitMonoSpace = (1 << 10), // Use fixed-pitch glyphs if available. May have multiple glyph advances (most CJK glyphs may contain two spaces)
kCTFontTraitVertical = (1 << 11), // Use vertical glyph variants and metrics
kCTFontTraitUIOptimized = (1 << 12), // Synthesize appropriate attributes for UI rendering such as control titles if necessary
kCTFontTraitColorGlyphs = (1 << 13), // Color glyphs ('sbix', 'COLR', or 'SVG ') are available.
kCTFontTraitComposite = (1 << 14), // The font is a CFR (Composite font reference), a cascade list is expected per font.
kCTFontTraitClassMask = (15U << kCTFontClassMaskShift),
// Mask for the font class
kCTFontItalicTrait = kCTFontTraitItalic,
kCTFontBoldTrait = kCTFontTraitBold,
kCTFontExpandedTrait = kCTFontTraitExpanded,
kCTFontCondensedTrait = kCTFontTraitCondensed,
kCTFontMonoSpaceTrait = kCTFontTraitMonoSpace,
kCTFontVerticalTrait = kCTFontTraitVertical,
kCTFontUIOptimizedTrait = kCTFontTraitUIOptimized,
kCTFontColorGlyphsTrait = kCTFontTraitColorGlyphs,
kCTFontCompositeTrait = kCTFontTraitComposite,
kCTFontClassMaskTrait = kCTFontTraitClassMask
};
/*!
@enum CTFontStylisticClass
@abstract Stylistic class values.
@discussion CTFontStylisticClass classifies certain stylistic qualities of the font. These values correspond closely to the font class values in the OpenType 'OS/2' table. The class values are bundled in the upper four bits of the CTFontSymbolicTraits and can be obtained via the kCTFontTraitClassMask.
*/
typedef CF_OPTIONS(uint32_t, CTFontStylisticClass) {
kCTFontClassUnknown = (0 << kCTFontClassMaskShift),
kCTFontClassOldStyleSerifs = (1 << kCTFontClassMaskShift),
kCTFontClassTransitionalSerifs = (2 << kCTFontClassMaskShift),
kCTFontClassModernSerifs = (3 << kCTFontClassMaskShift),
kCTFontClassClarendonSerifs = (4 << kCTFontClassMaskShift),
kCTFontClassSlabSerifs = (5 << kCTFontClassMaskShift),
kCTFontClassFreeformSerifs = (7 << kCTFontClassMaskShift),
kCTFontClassSansSerif = (8U << kCTFontClassMaskShift),
kCTFontClassOrnamentals = (9U << kCTFontClassMaskShift),
kCTFontClassScripts = (10U << kCTFontClassMaskShift),
kCTFontClassSymbolic = (12U << kCTFontClassMaskShift),
kCTFontUnknownClass = kCTFontClassUnknown,
kCTFontOldStyleSerifsClass = kCTFontClassOldStyleSerifs,
kCTFontTransitionalSerifsClass = kCTFontClassTransitionalSerifs,
kCTFontModernSerifsClass = kCTFontClassModernSerifs,
kCTFontClarendonSerifsClass = kCTFontClassClarendonSerifs,
kCTFontSlabSerifsClass = kCTFontClassSlabSerifs,
kCTFontFreeformSerifsClass = kCTFontClassFreeformSerifs,
kCTFontSansSerifClass = kCTFontClassSansSerif,
kCTFontOrnamentalsClass = kCTFontClassOrnamentals,
kCTFontScriptsClass = kCTFontClassScripts,
kCTFontSymbolicClass = kCTFontClassSymbolic
};
CF_ASSUME_NONNULL_END
CF_EXTERN_C_END
#endif
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework/Headers/CTFrame.h | /*
* CTFrame.h
* CoreText
*
* Copyright (c) 2003-2018 Apple Inc. All rights reserved.
*
*/
/*!
@header
Thread Safety Information
All functions in this header are thread safe unless otherwise specified.
*/
#ifndef __CTFRAME__
#define __CTFRAME__
#include <CoreText/CTDefines.h>
#include <CoreFoundation/CoreFoundation.h>
#include <CoreGraphics/CoreGraphics.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
CF_ASSUME_NONNULL_BEGIN
/* --------------------------------------------------------------------------- */
/* Frame Types */
/* --------------------------------------------------------------------------- */
typedef const struct CF_BRIDGED_TYPE(id) __CTFrame * CTFrameRef;
/*!
@function CTFrameGetTypeID
@abstract Returns the CFType of the frame object
*/
CFTypeID CTFrameGetTypeID( void ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/* --------------------------------------------------------------------------- */
/* Frame Values */
/* --------------------------------------------------------------------------- */
/*!
@enum CTFrameProgression
@abstract These constants specify frame progression types.
@discussion The lines of text within a frame may be stacked for either
horizontal or vertical text. Values are enumerated for each
stacking type supported by CTFrame. Frames created with a
progression type specifying vertical text will rotate lines
90 degrees counterclockwise when drawing.
@constant kCTFrameProgressionTopToBottom
Lines are stacked top to bottom for horizontal text.
@constant kCTFrameProgressionRightToLeft
Lines are stacked right to left for vertical text.
@constant kCTFrameProgressionLeftToRight
Lines are stacked left to right for vertical text.
*/
typedef CF_ENUM(uint32_t, CTFrameProgression) {
kCTFrameProgressionTopToBottom = 0,
kCTFrameProgressionRightToLeft = 1,
kCTFrameProgressionLeftToRight = 2
};
/*!
@const kCTFrameProgressionAttributeName
@abstract Specifies progression for a frame.
@discussion Value must be a CFNumberRef containing a CTFrameProgression.
Default is kCTFrameProgressionTopToBottom. This value determines
the line stacking behavior for a frame and does not affect the
appearance of the glyphs within that frame.
@seealso CTFramesetterCreateFrame
*/
CT_EXPORT const CFStringRef kCTFrameProgressionAttributeName CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@enum CTFramePathFillRule
@abstract These constants specify fill rule used by the frame.
@discussion When a path intersects with itself, the client should specify which rule to use for deciding the
area of the path.
@constant kCTFramePathFillEvenOdd
Text is filled in the area that would be painted if the path were given to CGContextEOFillPath.
@constant kCTFramePathFillWindingNumber
Text is fill in the area that would be painted if the path were given to CGContextFillPath.
*/
typedef CF_ENUM(uint32_t, CTFramePathFillRule) {
kCTFramePathFillEvenOdd = 0,
kCTFramePathFillWindingNumber = 1
};
/*!
@const kCTFramePathFillRuleAttributeName
@abstract Specifies fill rule for a frame if this attribute is used at top level of frameAttributes dictionary, or specify
fill rule for a clipping path if used in a dictionary contained in an array specified by kCTFrameClippingPathsAttributeName.
@discussion Value must be a CFNumberRef containing kCTFramePathFillEvenOdd or kCTFramePathFillWindingNumber.
Default is kCTFramePathFillEvenOdd.
@seealso CTFramesetterCreateFrame
*/
CT_EXPORT const CFStringRef kCTFramePathFillRuleAttributeName CT_AVAILABLE(macos(10.7), ios(4.2), watchos(2.0), tvos(9.0));
/*!
@const kCTFramePathWidthAttributeName
@abstract Specifies frame width if this attribute is used at top level of frameAttributes dictionary, or specify
clipping path width if used in a dictionary contained in an array specified by kCTFrameClippingPathsAttributeName.
@discussion Value must be a CFNumberRef specifying frame width.
Default is zero.
@seealso CTFramesetterCreateFrame
*/
CT_EXPORT const CFStringRef kCTFramePathWidthAttributeName CT_AVAILABLE(macos(10.7), ios(4.2), watchos(2.0), tvos(9.0));
/*!
@const kCTFrameClippingPathsAttributeName
@abstract Specifies array of paths to clip frame.
@discussion Value must be a CFArrayRef containing CFDictionaryRefs or CGPathRef. (CGPathRef is allowed on 10.8 or later.)
Each dictionary should have a kCTFramePathClippingPathAttributeName key-value pair, and can have a kCTFramePathFillRuleAttributeName key-value pair
and kCTFramePathFillRuleAttributeName key-value pair as optional parameters. In case of CGPathRef, default fill rule (kCTFramePathFillEvenOdd) and width (0.0) are used.
@seealso CTFramesetterCreateFrame
*/
CT_EXPORT const CFStringRef kCTFrameClippingPathsAttributeName CT_AVAILABLE(macos(10.7), ios(4.3), watchos(2.0), tvos(9.0));
/*!
@const kCTFramePathClippingPathAttributeName
@abstract Specifies clipping path. This attribute is valid in a dictionary contained in an array specified by kCTFrameClippingPathsAttributeName.
On 10.8 or later, This attribute is also valid in frameAttributes dictionary passed to CTFramesetterCreateFrame.
@discussion Value must be a CGPathRef specifying a clipping path.
@seealso kCTFrameClippingPathsAttributeName
*/
CT_EXPORT const CFStringRef kCTFramePathClippingPathAttributeName CT_AVAILABLE(macos(10.7), ios(4.3), watchos(2.0), tvos(9.0));
/* --------------------------------------------------------------------------- */
/* Frame Accessors */
/* --------------------------------------------------------------------------- */
/*!
@function CTFrameGetStringRange
@abstract Returns the range of characters that were originally requested
to fill the frame.
@param frame
The frame that you want to get the character range from.
@result This function will return a CFRange containing the backing
store range of characters that were originally requested
to fill the frame. If the function call is not successful,
then an empty range will be returned.
*/
CFRange CTFrameGetStringRange(
CTFrameRef frame ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFrameGetVisibleStringRange
@abstract Returns the range of characters that actually fit in the
frame.
@discussion This can be used to chain frames, as it returns the range of
characters that can be seen in the frame. The next frame would
start where this frame ends.
@param frame
The frame that you want to get the visible character range
from.
@result This function will return a CFRange containing the backing
store range of characters that fit into the frame. If the
function call is not successful, or if no characters fit
in the frame, then an empty range will be returned.
*/
CFRange CTFrameGetVisibleStringRange(
CTFrameRef frame ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFrameGetPath
@abstract Returns the path used to create the frame.
@param frame
The frame that you want to obtain the path from.
*/
CGPathRef CTFrameGetPath(
CTFrameRef frame ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFrameGetFrameAttributes
@abstract Returns the frame attributes used to create the frame.
@discussion It is possible to create a frame with an attributes dictionary
in order to control various aspects of the framing process.
These attributes are different from the ones that are used to
create an attributed string.
@param frame
The frame that you want to obtain the frame attributes from.
@result This function will return a CFDictionary containing the
frame attributes that were used to create the frame. If the
frame was created without any frame attributes, this function
will return NULL.
*/
CFDictionaryRef _Nullable CTFrameGetFrameAttributes(
CTFrameRef frame ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFrameGetLines
@abstract Returns an array of lines that make up the frame.
@discussion This function will return an array of CTLine objects that are
stored in the frame. These line objects can be accessed and
manipulated in any way that normal line objects can be. It is
possible that an empty frame exists. That is, a frame in which
no lines exist. In this case, the returned array will have 0
entries.
@param frame
The frame that you want to obtain the line array from.
@result This function will return a CFArray object containing the
CTLine objects that make up the frame.
*/
CFArrayRef CTFrameGetLines(
CTFrameRef frame ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFrameGetLineOrigins
@abstract Copies a range of line origins for a frame.
@discussion This function will copy a range of CGPoint structures. Each
CGPoint is the origin of the corresponding line in the array of
lines returned by CTFrameGetLines, relative to the origin of the
frame's path. The maximum number of line origins returned by
this function is the count of the array of lines.
@param frame
The frame that you want to obtain the line origin array from.
@param range
The range of line origins you wish to copy. If the length of the
range is set to 0, then the copy operation will continue from
the range's start index to the last line origin.
@param origins
The buffer to which the origins will be copied. The buffer must
have at least as many elements as specified by range's length.
When using the origins to calculate measurements for a frame's
contents, remember that line origins do not always correspond to
line metrics; paragraph style settings can affect line origins,
for one. The overall typographic bounds of a frame may generally
be calculated as the difference between the top of the frame and
the descent of the last line. This will obviously exclude any
spacing following the last line, but such spacing has no effect
on framesetting in the first place.
*/
void CTFrameGetLineOrigins(
CTFrameRef frame,
CFRange range,
CGPoint origins[_Nonnull] ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTFrameDraw
@abstract Draws an entire frame to a context.
@discussion This function will draw an entire frame to the context. Note
that this call may leave the context in any state and does not
flush it after the draw operation.
@param frame
The frame that you want to draw.
@param context
The context to draw the frame to.
@discussion If both the frame and the context are valid, the frame will be
drawn in the context.
*/
void CTFrameDraw(
CTFrameRef frame,
CGContextRef context ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
CF_ASSUME_NONNULL_END
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework/Headers/CTFontManagerErrors.h | /*
* CTFontManagerErrors.h
* CoreText
*
* Copyright (c) 2008-2019 Apple Inc. All rights reserved.
*
*/
#ifndef __CTFONTMANAGERERRORS__
#define __CTFONTMANAGERERRORS__
#include <CoreText/CTDefines.h>
#include <CoreFoundation/CoreFoundation.h>
CF_EXTERN_C_BEGIN
CF_ASSUME_NONNULL_BEGIN
/*!
@const kCTFontManagerErrorDomain
@abstract CFError domain for CTFontManager errors
@discussion CFErrors with this domain will have error codes corresponding to one of the CTFontManagerErrors above.
*/
CT_EXPORT const CFStringRef kCTFontManagerErrorDomain CT_AVAILABLE(macos(10.6), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@constant kCTFontManagerErrorFontURLsKey
@abstract User info key to be used with CFError references returned from registration functions.
@discussion The value associated with this key in the user info dictionary of a CFError is a CFArray of font URLs that failed with given error.
*/
CT_EXPORT const CFStringRef kCTFontManagerErrorFontURLsKey CT_AVAILABLE(macos(10.6), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@constant kCTFontManagerErrorFontDescriptorsKey
@abstract User info key to be used with CFError references returned from registration functions.
@discussion The value associated with this key in the user info dictionary of a CFError is a CFArray of font descriptors that failed with given error.
*/
CT_EXPORT const CFStringRef kCTFontManagerErrorFontDescriptorsKey CT_AVAILABLE(ios(13.0)) API_UNAVAILABLE(macos, watchos, tvos);
/*!
@constant kCTFontManagerErrorFontAssetNameKey
@abstract User info key to be used with CFError references returned from registration functions.
@discussion The value associated with this key in the user info dictionary of a CFError is a CFArray of font asset name strings that failed with given error.
*/
CT_EXPORT const CFStringRef kCTFontManagerErrorFontAssetNameKey CT_AVAILABLE(ios(13.0)) API_UNAVAILABLE(macos, watchos, tvos);
/*!
@enum
@abstract Font registration errors
@discussion Errors that would prevent registration of fonts for a specified font file URL.
@constant kCTFontManagerErrorFileNotFound
The file does not exist at the specified URL.
@constant kCTFontManagerErrorInsufficientPermissions
Cannot access the file due to insufficient permissions.
@constant kCTFontManagerErrorUnrecognizedFormat
The file is not a recognized or supported font file format.
@constant kCTFontManagerErrorInvalidFontData
The file contains invalid font data that could cause system problems.
@constant kCTFontManagerErrorAlreadyRegistered
The file has already been registered in the specified scope.
@discussion Errors that would prevent un-registration of fonts for a specified font file URL.
@constant kCTFontManagerErrorNotRegistered
The file is not registered in the specified scope.
@constant kCTFontManagerErrorInUse
The font file is actively in use and cannot be unregistered.
@constant kCTFontManagerErrorSystemRequired
The file is required by the system and cannot be unregistered.
@constant kCTFontManagerErrorRegistrationFailed
The file could not be processed due to an unexpected FontProvider error.
@constant kCTFontManagerErrorMissingEntitlement
The file could not be processed because the provider does not have a necessary entitlement.
@constant kCTFontManagerErrorInsufficientInfo
The font descriptor does not have information to specify a font file.
@constant kCTFontManagerErrorCancelledByUser
The operation was cancelled by the user.
@constant kCTFontManagerErrorDuplicatedName
The file could not be registered because of a duplicated font name.
@constant kCTFontManagerErrorInvalidFilePath
The file is not in an allowed location. It must be either in the application's bundle or an on-demand resource.
@constant kCTFontManagerErrorExceededResourceLimit
The operation failed due to a system limitation.
@constant kCTFontManagerErrorUnsupportedScope
The specified scope is not supported.
*/
typedef CF_ENUM(CFIndex, CTFontManagerError) {
kCTFontManagerErrorFileNotFound = 101,
kCTFontManagerErrorInsufficientPermissions = 102,
kCTFontManagerErrorUnrecognizedFormat = 103,
kCTFontManagerErrorInvalidFontData = 104,
kCTFontManagerErrorAlreadyRegistered = 105,
kCTFontManagerErrorExceededResourceLimit = 106,
kCTFontManagerErrorAssetNotFound = 107,
kCTFontManagerErrorNotRegistered = 201,
kCTFontManagerErrorInUse = 202,
kCTFontManagerErrorSystemRequired = 203,
kCTFontManagerErrorRegistrationFailed = 301,
kCTFontManagerErrorMissingEntitlement = 302,
kCTFontManagerErrorInsufficientInfo = 303,
kCTFontManagerErrorCancelledByUser = 304,
kCTFontManagerErrorDuplicatedName = 305,
kCTFontManagerErrorInvalidFilePath = 306,
kCTFontManagerErrorUnsupportedScope = 307,
};
CF_ASSUME_NONNULL_END
CF_EXTERN_C_END
#endif
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework/Headers/CTTextTab.h | /*
* CTTextTab.h
* CoreText
*
* Copyright (c) 2004-2018 Apple Inc. All rights reserved.
*
*/
/*!
@header
Thread Safety Information
All functions in this header are thread safe unless otherwise specified.
*/
#ifndef __CTTEXTTAB__
#define __CTTEXTTAB__
#include <CoreText/CTParagraphStyle.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
CF_ASSUME_NONNULL_BEGIN
/* --------------------------------------------------------------------------- */
/* Text Tab Types */
/* --------------------------------------------------------------------------- */
/* A CTTextTab represents a tab in an CTParagraphStyle object, storing an
alignment type and location.
CoreText supports four alignment types: left, center, right, and decimal.
These alignment types are absolute, not based on the line sweep direction
of text. For example, tabbed text is always positioned to the left of a
right-aligned tab, whether the line sweep direction is left to right or right
to left. A tab's location, on the other hand, is relative to the back margin.
A tab set at 1.5", for example, is at 1.5" from the right in right to left
text.
*/
typedef const struct CF_RELATED_TYPE(NSTextTab,,) __CTTextTab * CTTextTabRef;
/*!
@function CTTypesetterGetTypeID
@abstract Returns the CFType of the text tab object
*/
CFTypeID CTTextTabGetTypeID( void ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/* --------------------------------------------------------------------------- */
/* Text Tab Constants */
/* --------------------------------------------------------------------------- */
/*!
@const kCTTabColumnTerminatorsAttributeName
@abstract Used to specify the terminating character for a tab column
@discussion The value associated with this attribute is a CFCharacterSet. The
character set is used to determine the terminating character for
a tab column. The tab and newline characters are implied even if
they don't exist in the character set. This attribute can be used
to implement decimal tabs, for instance. This attribute is
optional.
*/
CT_EXPORT const CFStringRef kCTTabColumnTerminatorsAttributeName CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/* --------------------------------------------------------------------------- */
/* Text Tab Creation */
/* --------------------------------------------------------------------------- */
/*!
@function CTTextTabCreate
@abstract Creates and initializes a new text tab.
@param alignment
The tab's alignment. This is used to determine the position of
text inside the tab column. This parameter must be set to a valid
CTTextAlignment value or this function will return NULL.
@param location
The tab's ruler location, relative to the back margin.
@param options
Options to pass in when the tab is created. Currently, the only
option available is kCTTabColumnTerminatorsAttributeName. This
parameter is optional and can be set to NULL if not needed.
@result The new CTTextTab.
*/
CTTextTabRef CTTextTabCreate(
CTTextAlignment alignment,
double location,
CFDictionaryRef _Nullable options ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/* --------------------------------------------------------------------------- */
/* Text Tab Access */
/* --------------------------------------------------------------------------- */
/*!
@function CTTextTabGetAlignment
@abstract Returns the text alignment of the tab.
@param tab
The tab whose text alignment you wish to access.
@result The tab's text alignment value.
*/
CTTextAlignment CTTextTabGetAlignment(
CTTextTabRef tab ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTTextTabGetLocation
@abstract Returns the tab's ruler location.
@param tab
The tab whose location you wish to access.
@result The tab's ruler location relative to the back margin.
*/
double CTTextTabGetLocation(
CTTextTabRef tab ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTTextTabGetOptions
@abstract Returns the dictionary of attributes associated with the tab.
@param tab
The tab whose attributes you wish to access.
@result The dictionary of attributes associated with the tab or NULL if
no dictionary is present.
*/
CFDictionaryRef _Nullable CTTextTabGetOptions(
CTTextTabRef tab ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
CF_ASSUME_NONNULL_END
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework/Headers/CTParagraphStyle.h | /*
* CTParagraphStyle.h
* CoreText
*
* Copyright (c) 2004-2018 Apple Inc. All rights reserved.
*
*/
/*!
@header
Thread Safety Information
All functions in this header are thread safe unless otherwise specified.
*/
#ifndef __CTPARAGRAPHSTYLE__
#define __CTPARAGRAPHSTYLE__
#include <CoreText/CTDefines.h>
#include <CoreFoundation/CoreFoundation.h>
#include <CoreGraphics/CoreGraphics.h>
CF_IMPLICIT_BRIDGING_ENABLED
CF_EXTERN_C_BEGIN
CF_ASSUME_NONNULL_BEGIN
/* --------------------------------------------------------------------------- */
/* Paragraph Style Types */
/* --------------------------------------------------------------------------- */
typedef const struct CF_RELATED_TYPE(NSParagraphStyle,,) __CTParagraphStyle * CTParagraphStyleRef;
/*!
@function CTParagraphStyleGetTypeID
@abstract Returns the CFType of the paragraph style object
*/
CFTypeID CTParagraphStyleGetTypeID( void ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/* --------------------------------------------------------------------------- */
/* Paragraph Style Values */
/* --------------------------------------------------------------------------- */
/*!
@enum CTTextAlignment
@abstract These constants specify text alignment.
@constant kCTTextAlignmentLeft
Text is visually left-aligned.
@constant kCTTextAlignmentRight
Text is visually right-aligned.
@constant kCTTextAlignmentCenter
Text is visually center-aligned.
@constant kCTTextAlignmentJustified
Text is fully justified. The last line in a paragraph is
naturally aligned.
@constant kCTTextAlignmentNatural
Use the natural alignment of the text's script.
*/
typedef CF_ENUM(uint8_t, CTTextAlignment) {
kCTTextAlignmentLeft = 0,
kCTTextAlignmentRight = 1,
kCTTextAlignmentCenter = 2,
kCTTextAlignmentJustified = 3,
kCTTextAlignmentNatural = 4,
kCTLeftTextAlignment CT_ENUM_DEPRECATED("Deprecated", macos(10.5, 10.11), ios(3.2, 9.0)) CT_ENUM_UNAVAILABLE(watchos, tvos)
= kCTTextAlignmentLeft,
kCTRightTextAlignment CT_ENUM_DEPRECATED("Deprecated", macos(10.5, 10.11), ios(3.2, 9.0)) CT_ENUM_UNAVAILABLE(watchos, tvos)
= kCTTextAlignmentRight,
kCTCenterTextAlignment CT_ENUM_DEPRECATED("Deprecated", macos(10.5, 10.11), ios(3.2, 9.0)) CT_ENUM_UNAVAILABLE(watchos, tvos)
= kCTTextAlignmentCenter,
kCTJustifiedTextAlignment CT_ENUM_DEPRECATED("Deprecated", macos(10.5, 10.11), ios(3.2, 9.0)) CT_ENUM_UNAVAILABLE(watchos, tvos)
= kCTTextAlignmentJustified,
kCTNaturalTextAlignment CT_ENUM_DEPRECATED("Deprecated", macos(10.5, 10.11), ios(3.2, 9.0)) CT_ENUM_UNAVAILABLE(watchos, tvos)
= kCTTextAlignmentNatural
};
/*!
@enum CTLineBreakMode
@abstract These constants specify what happens when a line is too long for
its frame.
@constant kCTLineBreakByWordWrapping
Wrapping occurs at word boundaries, unless the word itself doesn't
fit on a single line.
@constant kCTLineBreakByCharWrapping
Wrapping occurs before the first character that doesn't fit.
@constant kCTLineBreakByClipping
Lines are simply not drawn past the edge of the frame.
@constant kCTLineBreakByTruncatingHead
Each line is displayed so that the end fits in the frame and the
missing text is indicated by some kind of ellipsis glyph.
@constant kCTLineBreakByTruncatingTail
Each line is displayed so that the beginning fits in the
container and the missing text is indicated by some kind of
ellipsis glyph.
@constant kCTLineBreakByTruncatingMiddle
Each line is displayed so that the beginning and end fit in the
container and the missing text is indicated by some kind of
ellipsis glyph in the middle.
*/
typedef CF_ENUM(uint8_t, CTLineBreakMode) {
kCTLineBreakByWordWrapping = 0,
kCTLineBreakByCharWrapping = 1,
kCTLineBreakByClipping = 2,
kCTLineBreakByTruncatingHead = 3,
kCTLineBreakByTruncatingTail = 4,
kCTLineBreakByTruncatingMiddle = 5
};
/*!
@enum CTWritingDirection
@abstract These constants specify the writing direction
@constant kCTWritingDirectionNatural
The writing direction is algorithmically determined
using the Unicode Bidirectional Algorithm rules P2 and P3.
@constant kCTWritingDirectionLeftToRight
The writing direction is left to right.
@constant kCTWritingDirectionRightToLeft
The writing direction is right to left.
*/
typedef CF_ENUM(int8_t, CTWritingDirection) {
kCTWritingDirectionNatural = -1,
kCTWritingDirectionLeftToRight = 0,
kCTWritingDirectionRightToLeft = 1
};
/*!
@enum CTParagraphStyleSpecifier
@abstract These constants are used to query and modify the CTParagraphStyle
object.
@discussion Each specifier has a type and a default value associated with it.
The type must always be observed when setting or fetching the
value from the CTParagraphStyle object. In addition, some
specifiers affect the behavior of both the framesetter and
the typesetter, and others only affect the behavior of the
framesetter; this is also noted below.
@constant kCTParagraphStyleSpecifierAlignment
The text alignment. Natural text alignment is realized as
left or right alignment, depending on the line sweep direction
of the first script contained in the paragraph.
Type: CTTextAlignment
Default: kCTTextAlignmentNatural
Application: CTFramesetter
@constant kCTParagraphStyleSpecifierFirstLineHeadIndent
The distance in points from the leading margin of a frame to
the beginning of the paragraph's first line. This value is always
nonnegative.
Type: CGFloat
Default: 0.0
Application: CTFramesetter
@constant kCTParagraphStyleSpecifierHeadIndent
The distance in points from the leading margin of a text
container to the beginning of lines other than the first.
This value is always nonnegative.
Type: CGFloat
Default: 0.0
Application: CTFramesetter
@constant kCTParagraphStyleSpecifierTailIndent
The distance in points from the margin of a frame to the end of
lines. If positive, this value is the distance from the leading
margin (for example, the left margin in left-to-right text).
If 0 or negative, it's the distance from the trailing margin.
Type: CGFloat
Default: 0.0
Application: CTFramesetter
@constant kCTParagraphStyleSpecifierTabStops
The CTTextTab objects, sorted by location, that define the tab
stops for the paragraph style.
Type: CFArray of CTTextTabRef
Default: 12 left-aligned tabs, spaced by 28.0 points
Application: CTFramesetter, CTTypesetter
@constant kCTParagraphStyleSpecifierDefaultTabInterval
The document-wide default tab interval. Tabs after the last
specified by kCTParagraphStyleSpecifierTabStops are placed at
integer multiples of this distance (if positive).
Type: CGFloat
Default: 0.0
Application: CTFramesetter, CTTypesetter
@constant kCTParagraphStyleSpecifierLineBreakMode
The mode that should be used to break lines when laying out
the paragraph's text.
Type: CTLineBreakMode
Default: kCTLineBreakByWordWrapping
Application: CTFramesetter
@constant kCTParagraphStyleSpecifierLineHeightMultiple
The line height multiple. The natural line height of the
receiver is multiplied by this factor (if positive) before
being constrained by minimum and maximum line height.
Type: CGFloat
Default: 0.0
Application: CTFramesetter
@constant kCTParagraphStyleSpecifierMaximumLineHeight
The maximum height that any line in the frame will occupy,
regardless of the font size or size of any attached graphic.
Glyphs and graphics exceeding this height will overlap
neighboring lines. A maximum height of 0 implies
no line height limit. This value is always nonnegative.
Type: CGFloat
Default: 0.0
Application: CTFramesetter
@constant kCTParagraphStyleSpecifierMinimumLineHeight
The minimum height that any line in the frame will occupy,
regardless of the font size or size of any attached graphic.
This value is always nonnegative.
Type: CGFloat
Default: 0.0
Application: CTFramesetter
@constant kCTParagraphStyleSpecifierLineSpacing
Deprecated.
Use kCTParagraphStyleSpecifierMaximumLineSpacing, kCTParagraphStyleSpecifierMinimumLineSpacing,
and kCTParagraphStyleSpecifierLineSpacingAdjustment to control
space between lines.
@constant kCTParagraphStyleSpecifierParagraphSpacing
The space added at the end of the paragraph to separate it from
the following paragraph. This value is always nonnegative and is
determined by adding the previous paragraph's
kCTParagraphStyleSpecifierParagraphSpacing setting and the
current paragraph's kCTParagraphStyleSpecifierParagraphSpacingBefore
setting.
Type: CGFloat
Default: 0.0
Application: CTFramesetter
@constant kCTParagraphStyleSpecifierParagraphSpacingBefore
The distance between the paragraph's top and the beginning of
its text content.
Type: CGFloat
Default: 0.0
Application: CTFramesetter
@constant kCTParagraphStyleSpecifierBaseWritingDirection
The base writing direction of the lines.
Type: CTWritingDirection
Default: kCTWritingDirectionNatural
Application: CTFramesetter, CTTypesetter
@constant kCTParagraphStyleSpecifierMaximumLineSpacing
The maximum space in points between lines within the paragraph
(commonly known as leading).
Type: CGFloat
Default: some large number.
Application: CTFramesetter
@constant kCTParagraphStyleSpecifierMinimumLineSpacing
The minimum space in points between lines within the paragraph
(commonly known as leading).
Type: CGFloat
Default: 0.0
Application: CTFramesetter
@constant kCTParagraphStyleSpecifierLineSpacingAdjustment
The space in points added between lines within the paragraph
(commonly known as leading).
Type: CGFloat
Default: 0.0
Application: CTFramesetter
@constant kCTParagraphStyleSpecifierLineBoundsOptions
The options controlling the alignment of the line edges with
the leading and trailing margins.
Type: CTLineBoundsOptions
Default: 0 (no options)
Application: CTTypesetter
*/
typedef CF_ENUM(uint32_t, CTParagraphStyleSpecifier) {
kCTParagraphStyleSpecifierAlignment = 0,
kCTParagraphStyleSpecifierFirstLineHeadIndent = 1,
kCTParagraphStyleSpecifierHeadIndent = 2,
kCTParagraphStyleSpecifierTailIndent = 3,
kCTParagraphStyleSpecifierTabStops = 4,
kCTParagraphStyleSpecifierDefaultTabInterval = 5,
kCTParagraphStyleSpecifierLineBreakMode = 6,
kCTParagraphStyleSpecifierLineHeightMultiple = 7,
kCTParagraphStyleSpecifierMaximumLineHeight = 8,
kCTParagraphStyleSpecifierMinimumLineHeight = 9,
kCTParagraphStyleSpecifierLineSpacing CT_ENUM_DEPRECATED("See documentation for replacements", macos(10.5, 10.8), ios(3.2, 6.0)) CT_ENUM_UNAVAILABLE(watchos, tvos) = 10,
kCTParagraphStyleSpecifierParagraphSpacing = 11,
kCTParagraphStyleSpecifierParagraphSpacingBefore = 12,
kCTParagraphStyleSpecifierBaseWritingDirection = 13,
kCTParagraphStyleSpecifierMaximumLineSpacing = 14,
kCTParagraphStyleSpecifierMinimumLineSpacing = 15,
kCTParagraphStyleSpecifierLineSpacingAdjustment = 16,
kCTParagraphStyleSpecifierLineBoundsOptions = 17,
kCTParagraphStyleSpecifierCount
};
/*!
@struct CTParagraphStyleSetting
@abstract This structure is used to alter the paragraph style.
@field spec
The specifier of the setting.
@field valueSize
The size of the value pointed to by the "value" field. This
must match the size of the value required by the
CTParagraphStyleSpecifier set in the "spec" field.
@field value
A reference to the value of the setting specified by the
"spec" field. The value must be in the proper range for the
spec value. The value must also be at least valueSize.
*/
typedef struct CTParagraphStyleSetting
{
CTParagraphStyleSpecifier spec;
size_t valueSize;
const void * value;
} CTParagraphStyleSetting;
/* --------------------------------------------------------------------------- */
/* Paragraph Style Creation */
/* --------------------------------------------------------------------------- */
/*!
@function CTParagraphStyleCreate
@abstract Creates an immutable paragraph style.
@discussion Using this function is the easiest and most efficient way to
create a paragraph style. Paragraph styles should be kept
immutable for totally lock-free operation.
If an invalid paragraph style setting specifier is passed into
the "settings" parameter, nothing bad will happen but just don't
expect to be able to query for this value. This is to allow
backwards compatibility with style setting specifiers that may
be introduced in future versions.
@param settings
The settings that you wish to pre-load the paragraph style
with. If you wish to specify the default set of settings,
then this parameter may be set to NULL.
@param settingCount
The number of settings that you have specified in the
"settings" parameter. This must be greater than or equal
to zero.
@result If the paragraph style creation was successful, this function
will return a valid reference to an immutable CTParagraphStyle
object. Otherwise, this function will return NULL.
*/
CTParagraphStyleRef CTParagraphStyleCreate(
const CTParagraphStyleSetting * _Nullable settings,
size_t settingCount ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/*!
@function CTParagraphStyleCreateCopy
@abstract Creates an immutable copy of a paragraph style.
@param paragraphStyle
The style that you wish to copy.
@result If the "paragraphStyle" reference is valid, then this
function will return valid reference to an immutable
CTParagraphStyle object that is a copy of the one passed into
"paragraphStyle".
*/
CTParagraphStyleRef CTParagraphStyleCreateCopy(
CTParagraphStyleRef paragraphStyle ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
/* --------------------------------------------------------------------------- */
/* Paragraph Style Access */
/* --------------------------------------------------------------------------- */
/*!
@function CTParagraphStyleGetValueForSpecifier
@abstract Obtains the current value for a single setting specifier.
@discussion This function will return the current value of the specifier
whether or not the user had actually set it. If the user has
not set it, this function will return the default value.
If an invalid paragraph style setting specifier is passed into
the "spec" parameter, nothing bad will happen and the buffer
value will simply be zeroed out. This is to allow backwards
compatibility with style setting specifier that may be introduced
in future versions.
@param paragraphStyle
The paragraph style that you wish to get the value from.
@param spec
The setting specifier that you want to get the value for.
@param valueBufferSize
The size of the buffer pointed to by the "valueBuffer" parameter.
This value must be at least as large as the size the required by
the CTParagraphSpecifier value set in the "spec" parameter.
@param valueBuffer
The buffer where the requested setting value will be written
upon successful completion. The buffer's size needs to be at least
as large as the value passed into "valueBufferSize".
@result This function will return "true" if the valueBuffer had been
successfully filled. Otherwise, this function will return false,
indicating that one or more of the parameters is not valid.
*/
bool CTParagraphStyleGetValueForSpecifier(
CTParagraphStyleRef paragraphStyle,
CTParagraphStyleSpecifier spec,
size_t valueBufferSize,
void * valueBuffer ) CT_AVAILABLE(macos(10.5), ios(3.2), watchos(2.0), tvos(9.0));
CF_ASSUME_NONNULL_END
CF_EXTERN_C_END
CF_IMPLICIT_BRIDGING_DISABLED
#endif
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework/Headers/CTDefines.h | /*
* CTDefines.h
* CoreText
*
* Copyright (c) 2010-2020 Apple Inc. All rights reserved.
*
*/
#ifndef __CTDEFINES__
#define __CTDEFINES__
#include <TargetConditionals.h>
#include <Availability.h>
#ifndef __has_feature
# define __has_feature(x) 0
#endif
#ifndef __has_attribute
# define __has_attribute(x) 0
#endif
#if defined(CT_BUILDING_CoreText) || TARGET_OS_WIN32
# define CT_AVAILABLE(...)
# define CT_UNAVAILABLE(...)
# define CT_DEPRECATED(...)
# define CT_DEPRECATED_WITH_REPLACEMENT(...)
#else /* defined(CT_BUILDING_CoreText) || TARGET_OS_WIN32 */
# define CT_AVAILABLE(...) API_AVAILABLE(__VA_ARGS__)
# define CT_UNAVAILABLE(...) API_UNAVAILABLE(__VA_ARGS__)
# define CT_DEPRECATED(...) API_DEPRECATED(__VA_ARGS__)
# define CT_DEPRECATED_WITH_REPLACEMENT(...) API_DEPRECATED_WITH_REPLACEMENT(__VA_ARGS__)
#endif /* defined(CT_BUILDING_CoreText) || TARGET_OS_WIN32 */
#if __has_feature(enumerator_attributes) && __has_attribute(availability)
# define CT_ENUM_DEPRECATED(...) CT_DEPRECATED(__VA_ARGS__)
# define CT_ENUM_AVAILABLE(...) CT_AVAILABLE(__VA_ARGS__)
# define CT_ENUM_UNAVAILABLE(...) CT_UNAVAILABLE(__VA_ARGS__)
#else
# define CT_ENUM_DEPRECATED(...)
# define CT_ENUM_AVAILABLE(...)
# define CT_ENUM_UNAVAILABLE(...)
#endif /* __has_feature(enumerator_attributes) && __has_attribute(availability) */
#if __has_attribute(objc_bridge)
# if defined(__OBJC__)
# if TARGET_OS_IPHONE
@class UIFont;
@class UIFontDescriptor;
# else
@class NSFont;
@class NSFontCollection;
@class NSFontDescriptor;
@class NSGlyphInfo;
@class NSMutableFontCollection;
# endif /* TARGET_OS_IPHONE */
@class NSParagraphStyle;
@class NSTextTab;
# endif /* defined(__OBJC__) */
#endif /* __has_attribute(objc_bridge) */
#if TARGET_OS_WIN32
#define _Nullable
#define _Nonnull
#define CF_BRIDGED_TYPE(T)
#define CF_BRIDGED_MUTABLE_TYPE(T)
#define CF_RELATED_TYPE(T,C,I)
#define CF_ASSUME_NONNULL_BEGIN
#define CF_ASSUME_NONNULL_END
# if defined(CT_BUILDING_CoreText) && defined(__cplusplus)
# define CT_EXPORT extern "C" __declspec(dllexport)
# elif defined(CT_BUILDING_CoreText) && !defined(__cplusplus)
# define CT_EXPORT extern __declspec(dllexport)
# elif defined(__cplusplus)
# define CT_EXPORT extern "C" __declspec(dllimport)
# else
# define CT_EXPORT extern __declspec(dllimport)
# endif
#else
# define CT_EXPORT extern
#endif
#endif
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework/Headers/CoreText.h | /*
* CoreText.h
* CoreText
*
* Copyright (c) 2006-2020 Apple Inc. All rights reserved.
*
*/
/*!
@header
Thread Safety Information
All functions in this header are thread safe unless otherwise specified.
*/
#ifndef __CORETEXT__
#define __CORETEXT__
#include <CoreText/CTFont.h>
#include <CoreText/CTFontCollection.h>
#include <CoreText/CTFontDescriptor.h>
#include <CoreText/CTFontManager.h>
#include <CoreText/CTFontTraits.h>
#include <CoreText/CTFrame.h>
#include <CoreText/CTFramesetter.h>
#include <CoreText/CTGlyphInfo.h>
#include <CoreText/CTLine.h>
#include <CoreText/CTParagraphStyle.h>
#include <CoreText/CTRubyAnnotation.h>
#include <CoreText/CTRun.h>
#include <CoreText/CTRunDelegate.h>
#include <CoreText/CTStringAttributes.h>
#include <CoreText/CTTextTab.h>
#include <CoreText/CTTypesetter.h>
#include <CoreText/SFNTLayoutTypes.h>
#include <CoreText/SFNTTypes.h>
CF_EXTERN_C_BEGIN
/*!
@function CTGetCoreTextVersion
@abstract Returns the version of the CoreText framework.
@discussion This function returns a number indicating the version of the
CoreText framework. Note that framework version is not always
an accurate indicator of feature availability. The recommended
way to use this function is first to check that the function
pointer is non-NULL, followed by calling it and comparing its
result to a defined constant (or constants). For example, to
determine whether the CoreText API is available:
if (&CTGetCoreTextVersion != NULL && CTGetCoreTextVersion() >= kCTVersionNumber10_5) {
// CoreText API is available
}
@result The version number. This value is for comparison with the
constants beginning with kCTVersionNumber and will not exceed
kCTVersionNumber11_0.
*/
uint32_t CTGetCoreTextVersion( void ) CT_DEPRECATED("Use -[NSProcessInfo operatingSystemVersion]", macos(10.5, 11.0), ios(3.2, 14.0), watchos(2.0, 7.0), tvos(9.0, 14.0));
#define kCTVersionNumber10_5 0x00020000
#define kCTVersionNumber10_5_2 0x00020001
#define kCTVersionNumber10_5_3 0x00020002
#define kCTVersionNumber10_5_5 0x00020003
#define kCTVersionNumber10_6 0x00030000
#define kCTVersionNumber10_7 0x00040000
#define kCTVersionNumber10_8 0x00050000
#define kCTVersionNumber10_9 0x00060000
#define kCTVersionNumber10_10 0x00070000
#define kCTVersionNumber10_11 0x00080000
#define kCTVersionNumber10_12 0x00090000
#define kCTVersionNumber10_13 0x000A0000
#define kCTVersionNumber10_14 0x000B0000
#define kCTVersionNumber10_15 0x000C0000
#define kCTVersionNumber11_0 0x000D0000
CF_EXTERN_C_END
#endif // __CORETEXT__
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreText.framework/Modules/module.modulemap | framework module CoreText [extern_c] {
umbrella header "CoreText.h"
export *
module * { export * }
}
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreLocation.framework/CoreLocation.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: 9071D624-3A77-3045-BAB3-DAAAADA8B2D5
- target: x86_64-maccatalyst
value: 9071D624-3A77-3045-BAB3-DAAAADA8B2D5
- target: arm64-macos
value: 00000000-0000-0000-0000-000000000000
- target: arm64-maccatalyst
value: 00000000-0000-0000-0000-000000000000
- target: arm64e-macos
value: 050DD8C4-998E-39C4-B281-18DEBFACF04A
- target: arm64e-maccatalyst
value: 050DD8C4-998E-39C4-B281-18DEBFACF04A
install-name: '/System/Library/Frameworks/CoreLocation.framework/Versions/A/CoreLocation'
current-version: 2663.3.4
exports:
- targets: [ x86_64-macos, arm64e-macos, x86_64-maccatalyst, arm64e-maccatalyst,
arm64-macos, arm64-maccatalyst ]
symbols: [ _CLAppResetChangedNotification, _CLAppStatusChangedNotification,
_CLApplyArchivedAuthorizationDecisions, _CLAuthorizationStatusChangedNotification,
_CLBeaconRegionAnyIdentifier, _CLClientCreateIso6709Notation,
_CLClientCreateWithBundleIdentifierAndPath, _CLClientCreateWithBundleIdentifierAndPathOnSilo,
_CLClientDisplayStats, _CLClientGetAuthorizationStatus, _CLClientGetAuthorizationStatusAndCorrectiveCompensation,
_CLClientGetDistanceCoordinates, _CLClientGetDistanceHighPrecision,
_CLClientGetError, _CLClientGetGroundAltitudeAtLocation, _CLClientGetHeading,
_CLClientGetLocation, _CLClientGetTypeID, _CLClientInvalidate,
_CLClientIsAuthorizationPromptMapDisplayEnabled, _CLClientIsHeadingAvailable,
_CLClientIsLocationServicesAvailable, _CLClientIsLocationServicesEnabled,
_CLClientIsValid, _CLClientLog, _CLClientLogDump, _CLClientMarkAsHavingReceivedLocation,
_CLClientPopulateRegionFromInfo, _CLClientRequestAuthorization,
_CLClientRequestTemporaryPrecise, _CLClientRetrieveAuthorizationStatus,
_CLClientRetrieveAuthorizationStatusForIdentity, _CLClientRetrieveIncidentalUseMode,
_CLClientRetrieveLocation, _CLClientRetrieveLocationWithDynamicAccuracyReductionAndAlteredAccessoryLocations,
_CLClientRetrievePrecisionPermission, _CLClientSetAllowsMapCorrection,
_CLClientSetAutomaticPromptingEnabled, _CLClientSetCallback,
_CLClientSetShowLocationPrompt, _CLClientShowHeadingCalibration,
_CLClientShutdownDaemon, _CLClientStartHeadingUpdates, _CLClientStartLocationUpdates,
_CLClientStartLocationUpdatesWithDynamicAccuracyReductionAndAlteredAccessoryLocations,
_CLClientStartVehicleHeadingUpdates, _CLClientStartVehicleSpeedUpdates,
_CLClientStopHeadingUpdates, _CLClientStopLocationUpdates,
_CLClientStopVehicleHeadingUpdates, _CLClientStopVehicleSpeedUpdates,
_CLClientUpdateARSessionState, _CLClientUpdateVIOEstimation,
_CLClientUpdateVLLocalizationResult, _CLCopyAppsUsingLocation,
_CLCopyGnssBandsInUse, _CLCopyMicroLocationInternalVersion,
_CLCopyNearbyAssetSettings, _CLCopyNearbyAssetSettingsOfAccessoryFile,
_CLCopyTechnologiesInUse, _CLCopyZaxisStats, _CLDaemonStartedNotification,
_CLDeleteCurrentEmergencyLocationAsset, _CLGenerateRoadSegmentId,
_CLGetAccessoryTypeBitSet, _CLGetArchivedAuthorizationDecisions,
_CLGetClientTransientAuthorizationInfo, _CLGetControlPlaneStatusReport,
_CLGetEmergencyLocationSettingsVersionInfo, _CLGetLocationDefault,
_CLGetStatusBarIconState, _CLGetUncertaintyScaleFactors, _CLGnssBandsChangedNotification,
_CLInternalPerformMigration, _CLLocationCoordinate2DGetDistanceFrom,
_CLLocationCoordinate2DIsValid, _CLLocationCoordinate2DMake,
_CLLocationDistanceMax, _CLLocationPushServiceErrorDomain,
_CLPassKitNotifyPayment, _CLPingDaemon, _CLSetClientTransientAuthorizationInfo,
_CLSetLocationDefault, _CLSetMapMatchingRouteHint, _CLSetRouteHintsForMapMatching,
_CLShouldDisplayEEDUI, _CLShouldDisplayStatusBarIconChangedNotification,
_CLStartStopAdvertisingBeacon, _CLTechStatusChangedNotification,
_CLTimeIntervalMax, _CLWeatherNotifyForecast, __CLLinkedOnOrAfter,
_kCLClientDistanceFilterNone, _kCLClientHeadingFilterNone,
_kCLCommonLocationAlwaysAndWhenInUseUsageDescriptionKey, _kCLCommonLocationAlwaysUsageDescriptionKey,
_kCLCommonLocationDefaultAccuracyReducedKey, _kCLCommonLocationInterestZonesKey,
_kCLCommonLocationTemporaryUsageDescriptionDictionaryKey,
_kCLCommonLocationUsageDescriptionKey, _kCLCommonLocationWhenInUseUsageDescriptionKey,
_kCLCommonNSWidgetWantsLocationKey, _kCLCommonWKRunsIndependentlyOfCompanionAppKey,
_kCLCommonWKWatchOnlyKey, _kCLDistanceFilterNone, _kCLErrorDomain,
_kCLErrorDomainPrivate, _kCLErrorUserInfoAlternateRegionKey,
_kCLHeadingFilterNone, _kCLLocationAccuracyBest, _kCLLocationAccuracyBestForNavigation,
_kCLLocationAccuracyBystander, _kCLLocationAccuracyBystanderPreLoiOverride,
_kCLLocationAccuracyE911CallInviteHigh, _kCLLocationAccuracyE911CallInviteLow,
_kCLLocationAccuracyHundredMeters, _kCLLocationAccuracyKilometer,
_kCLLocationAccuracyLeech, _kCLLocationAccuracyNearestTenMeters,
_kCLLocationAccuracyPrecisionLimitation, _kCLLocationAccuracyReduced,
_kCLLocationAccuracyThreeKilometers, _kCLLocationCoordinate2DInvalid,
_kCLLocationIntegrityHigh, _kCLLocationIntegrityLow, _kCLLocationIntegrityMedium,
_kCLLocationIntegrityNone, _kCLPolygonalRegionMaxVertices,
_kCLPolygonalRegionMinVertices, _kInvalidMacAddress ]
objc-classes: [ CLAssertion, CLBBTimeFreqTransferCallbackAssertion, CLBeacon,
CLBeaconIdentityConstraint, CLBeaconRegion, CLCircularRegion,
CLEmergencyEnablementAssertion, CLFindMyAccessoryAbsoluteWildConfiguration,
CLFindMyAccessoryAccelerometerOrientationModeConfiguration,
CLFindMyAccessoryAccelerometerSlopeModeConfiguration, CLFindMyAccessoryConnectionMaterial,
CLFindMyAccessoryFirmwareUpdateManager, CLFindMyAccessoryFirmwareVersion,
CLFindMyAccessoryManager, CLFindMyAccessoryRangingManager,
CLFindMyAccessorySoundSequence, CLFindMyAccessoryWildConfiguration,
CLFloor, CLGeocoder, CLGnssDisablementAssertion, CLHeading,
CLLocation, CLLocationManager, CLLocationManagerRoutine, CLLocationMatchInfo,
CLLocationSourceInformation, CLPlacemark, CLReductiveFilterOptions,
CLReductiveFilterSuite, CLRegion, CLRegulatoryConfig, CLSimulationManager,
CLStateTracker, CLVisit, _CLLSLHeading, _CLLSLHeadingEstimation,
_CLLSLHeadingSupplInfo, _CLLSLLocation, _CLLSLLocationCoordinate,
_CLLSLMapRoadSegment, _CLLocationFusionInfo, _CLLocationGroundAltitude,
_CLPlaceInference, _CLPolygonalRegion, _CLRangingPeer, _CLRangingPeerDistance,
_CLSignificantRegion, _CLVIOEstimation, _CLVLLocalizationResult,
_CLVertex ]
- targets: [ x86_64-macos, arm64e-macos, arm64-macos ]
symbols: [ _CLAuthStatusChangedNotification, _CLDaemonShutdownNotification ]
...
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreLocation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreLocation.framework/Headers/CLBeaconRegion.h | /*
* CLBeaconRegion.h
* CoreLocation
*
* Copyright (c) 2012 Apple Inc. All rights reserved.
*
*/
#import <Foundation/Foundation.h>
#import <CoreLocation/CLRegion.h>
#import <CoreLocation/CLAvailability.h>
#import <CoreLocation/CLBeaconIdentityConstraint.h>
NS_ASSUME_NONNULL_BEGIN
/*
* CLBeaconRegion
*
* Discussion:
* A region containing similar beacons.
*
* Such a region can be defined by UUID, major and minor values.
* UUID must be specified. If only UUID is specified, the major and
* minor values will be wildcarded and the region will match any
* beacons with the same UUID. Similarly if only UUID and major
* value are specified, the minor value will be wildcarded and the
* region will match against any beacons with the same UUID and
* major value.
*
*/
CL_EXTERN
API_AVAILABLE(ios(7.0), macos(10.15)) API_UNAVAILABLE(watchos, tvos)
@interface CLBeaconRegion : CLRegion
/*
* initWithUUID:identifier:
*
* Discussion:
* Initialize a beacon region with a UUID. Major and minor values will be wildcarded.
*
*/
- (instancetype)initWithUUID:(NSUUID *)uuid identifier:(NSString *)identifier API_AVAILABLE(ios(13.0), macos(10.15)) API_UNAVAILABLE(watchos, tvos);
- (instancetype)initWithProximityUUID:(NSUUID *)proximityUUID identifier:(NSString *)identifier API_DEPRECATED_WITH_REPLACEMENT("-initWithUUID:identifier:", ios(7.0, 13.0), macos(10.15, 10.15));
/*
* initWithUUID:major:identifier:
*
* Discussion:
* Initialize a beacon region with a UUID and major value. Minor value will be wildcarded.
*
*/
- (instancetype)initWithUUID:(NSUUID *)uuid major:(CLBeaconMajorValue)major identifier:(NSString *)identifier API_AVAILABLE(ios(13.0), macos(10.15)) API_UNAVAILABLE(watchos, tvos);
- (instancetype)initWithProximityUUID:(NSUUID *)proximityUUID major:(CLBeaconMajorValue)major identifier:(NSString *)identifier API_DEPRECATED_WITH_REPLACEMENT("-initWithUUID:major:identifier:", ios(7.0, 13.0), macos(10.15, 10.15));
/*
* initWithUUID:major:minor:identifier:
*
* Discussion:
* Initialize a beacon region identified by a UUID, major and minor values.
*
*/
- (instancetype)initWithUUID:(NSUUID *)uuid major:(CLBeaconMajorValue)major minor:(CLBeaconMinorValue)minor identifier:(NSString *)identifier API_AVAILABLE(ios(13.0), macos(10.15)) API_UNAVAILABLE(watchos, tvos);
- (instancetype)initWithProximityUUID:(NSUUID *)proximityUUID major:(CLBeaconMajorValue)major minor:(CLBeaconMinorValue)minor identifier:(NSString *)identifier API_DEPRECATED_WITH_REPLACEMENT("-initWithUUID:major:identifier:", ios(7.0, 13.0), macos(10.15, 10.15));
/*
* initWithBeaconIdentityConstraint:identifier:
*
* Discussion:
* Initialize a beacon region described by a beacon identity
* constraint.
*
*/
- (instancetype)initWithBeaconIdentityConstraint:(CLBeaconIdentityConstraint *)beaconIdentityConstraint identifier:(NSString *)identifier API_AVAILABLE(ios(13.0), macos(10.15)) API_UNAVAILABLE(watchos, tvos);
/*
* peripheralDataWithMeasuredPower:
*
* Discussion:
* This dictionary can be used to advertise the current device as a beacon when
* used in conjunction with CoreBluetooth's CBPeripheralManager startAdvertising: method.
* The dictionary will contain data that represents the current region in addition to a measured power value.
*
* measuredPower is the RSSI of the device observed from one meter in its intended environment.
* This value is optional, but should be specified to achieve the best ranging performance.
* If not specified, it will default to a pre-determined value for the device.
*
*/
- (NSMutableDictionary<NSString *, id> *)peripheralDataWithMeasuredPower:(nullable NSNumber *)measuredPower;
/*
* beaconIdentityConstraint
*
* Discussion:
* Returns a CLBeaconIdentityConstraint describing the beacons this region monitors.
*/
@property (readonly, nonatomic, copy) CLBeaconIdentityConstraint *beaconIdentityConstraint API_AVAILABLE(ios(13.0), macos(10.15)) API_UNAVAILABLE(watchos, tvos);
/*
* UUID
*
* Discussion:
* UUID associated with the region.
*
*/
@property (readonly, nonatomic, copy) NSUUID *UUID API_AVAILABLE(ios(13.0), macos(10.15)) API_UNAVAILABLE(watchos, tvos);
@property (readonly, nonatomic, copy) NSUUID *proximityUUID API_DEPRECATED_WITH_REPLACEMENT("-UUID", ios(7.0, 13.0), macos(10.15, 10.15));
/*
* major
*
* Discussion:
* Most significant value associated with the region. If a major value wasn't specified, this will be nil.
*
*/
@property (readonly, nonatomic, copy, nullable) NSNumber *major;
/*
* minor
*
* Discussion:
* Least significant value associated with the region. If a minor value wasn't specified, this will be nil.
*
*/
@property (readonly, nonatomic, copy, nullable) NSNumber *minor;
/*
* notifyEntryStateOnDisplay
*
* Discussion:
* App will be launched and the delegate will be notified via locationManager:didDetermineState:forRegion:
* when the device's screen is turned on and the user is in the region. By default, this is NO.
*/
@property (atomic, assign) BOOL notifyEntryStateOnDisplay;
@end
@class CLBeaconInternal;
/*
* CLBeacon
*
* Discussion:
* A single beacon within a CLBeaconRegion.
*
*/
API_AVAILABLE(ios(7.0), macos(10.15)) API_UNAVAILABLE(watchos, tvos)
@interface CLBeacon : NSObject <NSCopying, NSSecureCoding>
{
@package
CLBeaconInternal *_internal;
}
/*
* timestamp
*
* Discussion:
* The time when this beacon was observed.
*
*/
@property (readonly, nonatomic, copy) NSDate *timestamp API_AVAILABLE(ios(13.0), macos(10.15)) API_UNAVAILABLE(watchos, tvos);
/*
* UUID
*
* Discussion:
* UUID associated with the beacon.
*
*/
@property (readonly, nonatomic, copy) NSUUID *UUID API_AVAILABLE(ios(13.0), macos(10.15)) API_UNAVAILABLE(watchos, tvos);
@property (readonly, nonatomic, copy) NSUUID *proximityUUID API_DEPRECATED_WITH_REPLACEMENT("-UUID", ios(7.0, 13.0), macos(10.15, 10.15));
/*
* major
*
* Discussion:
* Most significant value associated with the beacon.
*
*/
@property (readonly, nonatomic, copy) NSNumber *major;
/*
* minor
*
* Discussion:
* Least significant value associated with the beacon.
*
*/
@property (readonly, nonatomic, copy) NSNumber *minor;
/*
* proximity
*
* Discussion:
* Proximity of the beacon from the device.
*
*/
@property (readonly, nonatomic) CLProximity proximity;
/*
* accuracy
*
* Discussion:
* Represents an one sigma horizontal accuracy in meters where the measuring device's location is
* referenced at the beaconing device. This value is heavily subject to variations in an RF environment.
* A negative accuracy value indicates the proximity is unknown.
*
*/
@property (readonly, nonatomic) CLLocationAccuracy accuracy;
/*
* rssi
*
* Discussion:
* Received signal strength in decibels of the specified beacon.
* This value is an average of the RSSI samples collected since this beacon was last reported.
*
*/
@property (readonly, nonatomic) NSInteger rssi;
@end
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreLocation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreLocation.framework/Headers/CoreLocation.h | /*
* CoreLocation.h
* CoreLocation
*
* Copyright (c) 2008-2010 Apple Inc. All rights reserved.
*
*/
#ifndef __CORELOCATION__
#define __CORELOCATION__
#ifndef __CL_INDIRECT__
#define __CL_INDIRECT__
#endif
#import <CoreLocation/CLAvailability.h>
#import <CoreLocation/CLErrorDomain.h>
#import <CoreLocation/CLError.h>
#import <CoreLocation/CLRegion.h>
#import <CoreLocation/CLCircularRegion.h>
#import <CoreLocation/CLBeaconRegion.h>
#import <CoreLocation/CLBeaconIdentityConstraint.h>
#import <CoreLocation/CLHeading.h>
#import <CoreLocation/CLLocation.h>
#import <CoreLocation/CLLocationManager.h>
#import <CoreLocation/CLLocationManagerDelegate.h>
#import <CoreLocation/CLLocationManager+CLVisitExtensions.h>
#import <CoreLocation/CLPlacemark.h>
#import <CoreLocation/CLGeocoder.h>
#import <CoreLocation/CLVisit.h>
#import <CoreLocation/CLLocationPushServiceExtension.h>
#import <CoreLocation/CLLocationPushServiceError.h>
#endif /* __CORELOCATION__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreLocation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreLocation.framework/Headers/CLVisit.h | /*
* CLVisit.h
* CoreLocation
*
* Copyright (c) 2014 Apple Inc. All rights reserved.
*
*/
#import <Foundation/Foundation.h>
#import <CoreLocation/CLLocation.h>
#import <CoreLocation/CLAvailability.h>
NS_ASSUME_NONNULL_BEGIN
/*
* CLVisit
*
* Discussion
* An instance of this class represents a possibly open-ended event
* during which the device was at the specified coordinate.
*/
CL_EXTERN
API_AVAILABLE(ios(8.0), macos(10.15)) API_UNAVAILABLE(watchos, tvos)
@interface CLVisit : NSObject <NSSecureCoding, NSCopying>
/*
* arrivalDate
*
* Discussion:
* The date when the visit began. This may be equal to [NSDate
* distantPast] if the true arrival date isn't available.
*/
@property (nonatomic, readonly, copy) NSDate *arrivalDate;
/*
* departureDate
*
* Discussion:
* The date when the visit ended. This is equal to [NSDate
* distantFuture] if the device hasn't yet left.
*/
@property (nonatomic, readonly, copy) NSDate *departureDate;
/*
* coordinate
*
* Discussion:
* The center of the region which the device is visiting.
*/
@property (nonatomic, readonly) CLLocationCoordinate2D coordinate;
/*
*
* horizontalAccuracy
*
* Discussion:
* An estimate of the radius (in meters) of the region which the
* device is visiting.
*/
@property (nonatomic, readonly) CLLocationAccuracy horizontalAccuracy;
@end
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreLocation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreLocation.framework/Headers/CLError.h | /*
* CLError.h
* CoreLocation
*
* Copyright (c) 2008-2010 Apple Inc. All rights reserved.
*
*/
#import <Foundation/Foundation.h>
#import <CoreLocation/CLAvailability.h>
NS_ASSUME_NONNULL_BEGIN
/*
* CLError
*
* Discussion:
* Error returned as code to NSError from CoreLocation.
*/
typedef NS_ENUM(NSInteger, CLError) {
kCLErrorLocationUnknown = 0, // location is currently unknown, but CL will keep trying
kCLErrorDenied, // Access to location or ranging has been denied by the user
kCLErrorNetwork, // general, network-related error
kCLErrorHeadingFailure, // heading could not be determined
kCLErrorRegionMonitoringDenied, // Location region monitoring has been denied by the user
kCLErrorRegionMonitoringFailure, // A registered region cannot be monitored
kCLErrorRegionMonitoringSetupDelayed, // CL could not immediately initialize region monitoring
kCLErrorRegionMonitoringResponseDelayed, // While events for this fence will be delivered, delivery will not occur immediately
kCLErrorGeocodeFoundNoResult, // A geocode request yielded no result
kCLErrorGeocodeFoundPartialResult, // A geocode request yielded a partial result
kCLErrorGeocodeCanceled, // A geocode request was cancelled
kCLErrorDeferredFailed, // Deferred mode failed
kCLErrorDeferredNotUpdatingLocation, // Deferred mode failed because location updates disabled or paused
kCLErrorDeferredAccuracyTooLow, // Deferred mode not supported for the requested accuracy
kCLErrorDeferredDistanceFiltered, // Deferred mode does not support distance filters
kCLErrorDeferredCanceled, // Deferred mode request canceled a previous request
kCLErrorRangingUnavailable, // Ranging cannot be performed
kCLErrorRangingFailure, // General ranging failure
kCLErrorPromptDeclined, // Authorization request not presented to user
};
/*
* kCLErrorUserInfoAlternateRegionKey
*
* Discussion:
* When an error with code kCLErrorRegionMonitoringResponseDelayed is received, this key may be populated
* in the userInfo dictionary. The value is a CLRegion that the location service can more effectively monitor.
*/
CL_EXTERN NSString *const kCLErrorUserInfoAlternateRegionKey NS_AVAILABLE(10_7, 5_0) API_UNAVAILABLE(watchos, tvos);
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreLocation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreLocation.framework/Headers/CLRegion.h | /*
* CLRegion.h
* CoreLocation
*
* Copyright (c) 2009-2010 Apple Inc. All rights reserved.
*
*/
#import <Foundation/Foundation.h>
#import <CoreLocation/CLLocation.h>
#import <CoreLocation/CLAvailability.h>
NS_ASSUME_NONNULL_BEGIN
/*
* CLRegionState
*
* Discussion:
* Represents the current state of the device with reference to a region.
*
*/
typedef NS_CLOSED_ENUM(NSInteger, CLRegionState) {
CLRegionStateUnknown,
CLRegionStateInside,
CLRegionStateOutside
} API_AVAILABLE(macos(10.10), ios(7.0)) API_UNAVAILABLE(watchos, tvos);
/*
* CLProximity
*
* Discussion:
* Represents the current proximity of an entity.
*
*/
typedef NS_ENUM(NSInteger, CLProximity) {
CLProximityUnknown,
CLProximityImmediate,
CLProximityNear,
CLProximityFar
} API_AVAILABLE(ios(7.0), macos(10.15)) API_UNAVAILABLE(watchos, tvos);
/*
* CLRegion
*
* Discussion:
* A logical area.
*/
CL_EXTERN
API_AVAILABLE(macos(10.7), ios(4.0))
@interface CLRegion : NSObject <NSCopying, NSSecureCoding>
/*
* initCircularRegionWithCenter:radius:identifier:
*
* Discussion:
* Initialize a region. center gives the coordinates of center of the region, while radius gives
* the distance in meters between the center and the region's boundary. identifier is a description
* for the region that could be displayed to the user, and ideally should be chosen by the user.
*
* This method has been deprecated, please see CLCircularRegion.
*/
- (instancetype)initCircularRegionWithCenter:(CLLocationCoordinate2D)center
radius:(CLLocationDistance)radius
identifier:(NSString *)identifier API_DEPRECATED("Please see CLCircularRegion", ios(4.0, 7.0), macos(10.7, 10.10)) API_UNAVAILABLE(tvos);
/*
* center
*
* Discussion:
* Returns the coordinate of the center of the region.
*
* This method has been deprecated, please see CLCircularRegion.
*/
@property (readonly, atomic) CLLocationCoordinate2D center API_DEPRECATED("Please see CLCircularRegion", ios(4.0, 7.0), macos(10.7, 10.10)) API_UNAVAILABLE(tvos);
/*
* radius
*
* Discussion:
* Returns the radius of the region.
*
* This method has been deprecated, please see CLCircularRegion.
*/
@property (readonly, atomic) CLLocationDistance radius API_DEPRECATED("Please see CLCircularRegion", ios(4.0, 7.0), macos(10.7, 10.10)) API_UNAVAILABLE(tvos);
/*
* identifier
*
* Discussion:
* Returns the region's identifier.
*/
@property (readonly, nonatomic, copy) NSString *identifier API_AVAILABLE(ios(4.0), macos(10.7));
/*
* notifyOnEntry
*
* Discussion:
* App will be launched and the delegate will be notified via locationManager:didEnterRegion:
* when the user enters the region. By default, this is YES.
*/
@property (atomic, assign) BOOL notifyOnEntry API_AVAILABLE(ios(7.0), macos(10.10));
/*
* notifyOnExit
*
* Discussion:
* App will be launched and the delegate will be notified via locationManager:didExitRegion:
* when the user exits the region. By default, this is YES.
*/
@property (atomic, assign) BOOL notifyOnExit API_AVAILABLE(ios(7.0), macos(10.10));
/*
* containsCoordinate:
*
* Discussion:
* Returns YES if the coordinate lies inside the region, and NO otherwise.
*
* This method has been deprecated, please see CLCircularRegion.
*/
- (BOOL)containsCoordinate:(CLLocationCoordinate2D)coordinate API_DEPRECATED("Please see CLCircularRegion", ios(4.0, 7.0), macos(10.7, 10.10)) API_UNAVAILABLE(tvos);
@end
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreLocation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreLocation.framework/Headers/CLGeocoder.h | /*
* CLGeocoder.h
* CoreLocation
*
* Copyright (c) 2010 Apple Inc. All rights reserved.
*/
#import <Foundation/Foundation.h>
#import <CoreLocation/CLLocation.h>
#import <CoreLocation/CLAvailability.h>
NS_ASSUME_NONNULL_BEGIN
@class CLRegion;
@class CLPlacemark;
@class CLGeocoderInternal;
@class CNPostalAddress;
// geocoding handler, CLPlacemarks are provided in order of most confident to least confident
typedef void (^CLGeocodeCompletionHandler)(NSArray< CLPlacemark *> * __nullable placemarks, NSError * __nullable error);
CL_EXTERN
API_AVAILABLE(macos(10.8), ios(5.0))
@interface CLGeocoder : NSObject
{
@private
CLGeocoderInternal *_internal;
}
@property (nonatomic, readonly, getter=isGeocoding) BOOL geocoding;
// reverse geocode requests
- (void)reverseGeocodeLocation:(CLLocation *)location completionHandler:(CLGeocodeCompletionHandler)completionHandler;
- (void)reverseGeocodeLocation:(CLLocation *)location preferredLocale:(nullable NSLocale *)locale completionHandler:(CLGeocodeCompletionHandler)completionHandler API_AVAILABLE(macos(10.13), ios(11.0), watchos(4.0), tvos(11.0));
// forward geocode requests
// geocodeAddressDictionary:completionHandler: takes an address dictionary as defined by the AddressBook framework.
// You can obtain an address dictionary from an ABPerson by retrieving the kABPersonAddressProperty property.
// Alternately, one can be constructed using the kABPersonAddress* keys defined in <AddressBook/ABPerson.h>.
- (void)geocodeAddressDictionary:(NSDictionary *)addressDictionary completionHandler:(CLGeocodeCompletionHandler)completionHandler API_DEPRECATED("Use -geocodePostalAddress:completionHandler:", macos(10.8, 10.13), ios(5.0, 11.0), watchos(1.0, 4.0));
- (void)geocodeAddressString:(NSString *)addressString completionHandler:(CLGeocodeCompletionHandler)completionHandler;
- (void)geocodeAddressString:(NSString *)addressString inRegion:(nullable CLRegion *)region completionHandler:(CLGeocodeCompletionHandler)completionHandler;
- (void)geocodeAddressString:(NSString *)addressString inRegion:(nullable CLRegion *)region preferredLocale:(nullable NSLocale *)locale completionHandler:(CLGeocodeCompletionHandler)completionHandler API_AVAILABLE(macos(10.13), ios(11.0), watchos(4.0), tvos(11.0));
- (void)cancelGeocode;
@end
@interface CLGeocoder (ContactsAdditions)
- (void)geocodePostalAddress:(CNPostalAddress *)postalAddress completionHandler:(CLGeocodeCompletionHandler)completionHandler API_AVAILABLE(ios(11.0), macos(10.13), watchos(4.0)) API_UNAVAILABLE(tvos);
- (void)geocodePostalAddress:(CNPostalAddress *)postalAddress preferredLocale:(nullable NSLocale *)locale completionHandler:(CLGeocodeCompletionHandler)completionHandler API_AVAILABLE(macos(10.13), ios(11.0), watchos(4.0)) API_UNAVAILABLE(tvos);
@end
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreLocation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreLocation.framework/Headers/CLLocation.h | /*
* CLLocation.h
* CoreLocation
*
* Copyright (c) 2008-2010 Apple Inc. All rights reserved.
*
*/
#import <Foundation/Foundation.h>
#import <CoreLocation/CLAvailability.h>
NS_ASSUME_NONNULL_BEGIN
/*
* CLLocationDegrees
*
* Discussion:
* Type used to represent a latitude or longitude coordinate in degrees under the WGS 84 reference
* frame. The degree can be positive (North and East) or negative (South and West).
*/
typedef double CLLocationDegrees;
/*
* CLLocationAccuracy
*
* Discussion:
* Type used to represent a location accuracy level in meters. The lower the value in meters, the
* more physically precise the location is. A negative accuracy value indicates an invalid location.
*/
typedef double CLLocationAccuracy;
/*
* CLLocationSpeed
*
* Discussion:
* Type used to represent the speed in meters per second.
*/
typedef double CLLocationSpeed;
/*
* CLLocationSpeedAccuracy
*
* Discussion:
* Type used to represent a speed accuracy level in meters/second. The lower the value the more
* precise the speed is. A negative accuracy value indicates an invalid speed.
*/
typedef double CLLocationSpeedAccuracy;
/*
* CLLocationDirection
*
* Discussion:
* Type used to represent the direction in degrees from 0 to 359.9. A negative value indicates an
* invalid direction.
*/
typedef double CLLocationDirection;
/*
* CLLocationDirectionAccuracy
*
* Discussion:
* Type used to represent a direction accuracy in degrees. The lower the value the more precise the
* direction is. A negative accuracy value indicates an invalid direction.
*/
typedef double CLLocationDirectionAccuracy;
/*
* CLLocationCoordinate2D
*
* Discussion:
* A structure that contains a geographical coordinate.
*
* Fields:
* latitude:
* The latitude in degrees.
* longitude:
* The longitude in degrees.
*/
struct CLLocationCoordinate2D {
CLLocationDegrees latitude;
CLLocationDegrees longitude;
};
typedef struct CLLocationCoordinate2D CLLocationCoordinate2D;
/*
* CLLocationDistance
*
* Discussion:
* Type used to represent a distance in meters.
*/
typedef double CLLocationDistance;
/*
* kCLDistanceFilterNone
*
* Discussion:
* Use as the distanceFilter property for CLLocationManager. This indicates
* to the location service that no minimum movement filter is desired - ie, client will be informed
* of any movement.
*/
CL_EXTERN const CLLocationDistance kCLDistanceFilterNone;
/*
* kCLLocationAccuracy<x>
*
* Discussion:
* Used to specify the accuracy level desired. The location service will try its best to achieve
* your desired accuracy. However, it is not guaranteed. To optimize
* power performance, be sure to specify an appropriate accuracy for your usage scenario (eg,
* use a large accuracy value when only a coarse location is needed).
*/
CL_EXTERN const CLLocationAccuracy kCLLocationAccuracyBestForNavigation API_AVAILABLE(ios(4.0), macos(10.7));
CL_EXTERN const CLLocationAccuracy kCLLocationAccuracyBest;
CL_EXTERN const CLLocationAccuracy kCLLocationAccuracyNearestTenMeters;
CL_EXTERN const CLLocationAccuracy kCLLocationAccuracyHundredMeters;
CL_EXTERN const CLLocationAccuracy kCLLocationAccuracyKilometer;
CL_EXTERN const CLLocationAccuracy kCLLocationAccuracyThreeKilometers;
/*
* kCLLocationAccuracyReduced
*
* Discussion:
* If you set your CLLocationManager's desiredAccuracy property to
* this value, locations delivered to your delegate in response to
* startUpdatingLocation or requestLocation will have their
* accuracy reduced. The locations you receive will match the
* locations your app would have received if the user had decided
* not to grant your app authorization for precise location.
*/
CL_EXTERN const CLLocationAccuracy kCLLocationAccuracyReduced API_AVAILABLE(ios(14.0), macos(11.0), watchos(7.0), tvos(14.0));
/*
* CLLocationDistanceMax
*
* Discussion:
* Used to specify the maximum CLLocationDistance
*/
CL_EXTERN const CLLocationDistance CLLocationDistanceMax API_AVAILABLE(ios(6.0), macos(10.14));
/*
* CLTimeIntervalMax
*
* Discussion:
* Used to specify the maximum NSTimeInterval
*/
CL_EXTERN const NSTimeInterval CLTimeIntervalMax API_AVAILABLE(ios(6.0), macos(10.14));
/*
* kCLLocationCoordinate2DInvalid
*
* Discussion:
* Used to specify an invalid CLLocationCoordinate2D.
*/
CL_EXTERN const CLLocationCoordinate2D kCLLocationCoordinate2DInvalid API_AVAILABLE(ios(4.0), macos(10.7));
#ifdef __cplusplus
extern "C" {
#endif
/*
* CLLocationCoordinate2DIsValid
*
* Discussion:
* Returns YES if the specified coordinate is valid, NO otherwise.
*/
CL_EXTERN
BOOL CLLocationCoordinate2DIsValid(CLLocationCoordinate2D coord) API_AVAILABLE(ios(4.0), macos(10.7));
/*
* CLLocationCoordinate2DMake:
*
* Discussion:
* Returns a new CLLocationCoordinate2D at the given latitude and longitude
*/
CL_EXTERN
CLLocationCoordinate2D CLLocationCoordinate2DMake(CLLocationDegrees latitude, CLLocationDegrees longitude) API_AVAILABLE(ios(4.0), macos(10.7));
#ifdef __cplusplus
}
#endif
/*
* CLFloor
*
* Discussion:
* Encapsulates the information about a floor.
*/
CL_EXTERN
API_AVAILABLE(ios(8.0), macos(10.15))
@interface CLFloor : NSObject <NSCopying, NSSecureCoding>
/*
* level
*
* Discussion:
* This is a logical representation that will vary on definition from building-to-building.
* Floor 0 will always represent the floor designated as "ground".
* This number may be negative to designate floors below the ground floor
* and positive to indicate floors above the ground floor.
* It is not intended to match any numbering that might actually be used in the building.
* It is erroneous to use as an estimate of altitude.
*/
@property(readonly, nonatomic) NSInteger level;
@end
/*
* CLLocationSourceInformation
*
* Discussion:
* For a CLLocation, represents information about the source of the location, including whether it came from a simulator
*/
CL_EXTERN
API_AVAILABLE(ios(15.0), watchos(8.0), tvos(15.0), macos(12.0))
@interface CLLocationSourceInformation : NSObject <NSCopying, NSSecureCoding>
- (instancetype)initWithSoftwareSimulationState:(BOOL)isSoftware
andExternalAccessoryState:(BOOL)isAccessory;
/*
* isSimulatedBySoftware
*
* Discussion:
* Set to YES if this location was detected as being generated by a software simulator, such as Xcode
*/
@property(readonly, nonatomic) BOOL isSimulatedBySoftware;
/*
* isProducedByAccessory
*
* Discussion:
* Set to YES if this location was generated from an external accessory, such as CarPlay or an MFi accessory
*/
@property(readonly, nonatomic) BOOL isProducedByAccessory;
@end
/*
* CLLocation
*
* Discussion:
* Represents a geographical coordinate along with accuracy and timestamp information.
*/
CL_EXTERN
API_AVAILABLE(macos(10.6), ios(2.0))
@interface CLLocation : NSObject <NSCopying, NSSecureCoding>
{
@private
id _internal;
}
/*
* initWithLatitude:longitude:
*
* Discussion:
* Initialize with the specified latitude and longitude.
*/
- (instancetype)initWithLatitude:(CLLocationDegrees)latitude
longitude:(CLLocationDegrees)longitude;
/*
* initWithCoordinate:altitude:horizontalAccuracy:verticalAccuracy:timestamp:
*
* Discussion:
* Initialize with the specified parameters.
*/
- (instancetype)initWithCoordinate:(CLLocationCoordinate2D)coordinate
altitude:(CLLocationDistance)altitude
horizontalAccuracy:(CLLocationAccuracy)hAccuracy
verticalAccuracy:(CLLocationAccuracy)vAccuracy
timestamp:(NSDate *)timestamp;
/*
* initWithCoordinate:altitude:horizontalAccuracy:verticalAccuracy:course:speed:timestamp:
*
* Discussion:
* Initialize with the specified parameters.
*/
- (instancetype)initWithCoordinate:(CLLocationCoordinate2D)coordinate
altitude:(CLLocationDistance)altitude
horizontalAccuracy:(CLLocationAccuracy)hAccuracy
verticalAccuracy:(CLLocationAccuracy)vAccuracy
course:(CLLocationDirection)course
speed:(CLLocationSpeed)speed
timestamp:(NSDate *)timestamp API_AVAILABLE(ios(4.2), macos(10.7));
/*
* initWithCoordinate:altitude:horizontalAccuracy:verticalAccuracy:course:courseAccuracy:speed:speedAccuracy:timestamp:
*
* Discussion:
* Initialize with the specified parameters.
*/
- (instancetype)initWithCoordinate:(CLLocationCoordinate2D)coordinate
altitude:(CLLocationDistance)altitude
horizontalAccuracy:(CLLocationAccuracy)hAccuracy
verticalAccuracy:(CLLocationAccuracy)vAccuracy
course:(CLLocationDirection)course
courseAccuracy:(CLLocationDirectionAccuracy)courseAccuracy
speed:(CLLocationSpeed)speed
speedAccuracy:(CLLocationSpeedAccuracy)speedAccuracy
timestamp:(NSDate *)timestamp API_AVAILABLE(ios(13.4), macos(10.15.4), watchos(6.2), tvos(13.4));
/*
* initWithCoordinate:altitude:horizontalAccuracy:verticalAccuracy:course:courseAccuracy:speed:speedAccuracy:timestamp:sourceInfo
*
* Discussion:
* Initialize with the specified parameters.
*/
- (instancetype)initWithCoordinate:(CLLocationCoordinate2D)coordinate
altitude:(CLLocationDistance)altitude
horizontalAccuracy:(CLLocationAccuracy)hAccuracy
verticalAccuracy:(CLLocationAccuracy)vAccuracy
course:(CLLocationDirection)course
courseAccuracy:(CLLocationDirectionAccuracy)courseAccuracy
speed:(CLLocationSpeed)speed
speedAccuracy:(CLLocationSpeedAccuracy)speedAccuracy
timestamp:(NSDate *)timestamp
sourceInfo:(CLLocationSourceInformation*)sourceInfo API_AVAILABLE(ios(15.0), watchos(8.0), tvos(15.0), macos(12.0));
/*
* coordinate
*
* Discussion:
* Returns the coordinate of the current location.
*/
@property(readonly, nonatomic) CLLocationCoordinate2D coordinate;
/*
* altitude
*
* Discussion:
* Returns the altitude of the location. Can be positive (above sea level) or negative (below sea level).
*/
@property(readonly, nonatomic) CLLocationDistance altitude;
/*
* ellipsoidalAltitude
*
* Discussion:
* Returns the ellipsoidal altitude of the location under the WGS 84 reference frame.
* Can be positive or negative.
*/
@property(readonly, nonatomic) CLLocationDistance ellipsoidalAltitude API_AVAILABLE(ios(15), macos(12), watchos(8), tvos(15));
/*
* horizontalAccuracy
*
* Discussion:
* Returns the horizontal accuracy of the location. Negative if the lateral location is invalid.
*/
@property(readonly, nonatomic) CLLocationAccuracy horizontalAccuracy;
/*
* verticalAccuracy
*
* Discussion:
* Returns the vertical accuracy of the location. Negative if the altitude is invalid.
*/
@property(readonly, nonatomic) CLLocationAccuracy verticalAccuracy;
/*
* course
*
* Discussion:
* Returns the course of the location in degrees true North. Negative if course is invalid.
*
* Range:
* 0.0 - 359.9 degrees, 0 being true North
*/
@property(readonly, nonatomic) CLLocationDirection course API_AVAILABLE(ios(2.2), macos(10.7));
/*
* courseAccuracy
*
* Discussion:
* Returns the course accuracy of the location in degrees. Returns negative if course is invalid.
*/
@property(readonly, nonatomic) CLLocationDirectionAccuracy courseAccuracy API_AVAILABLE(ios(13.4), macos(10.15.4), watchos(6.2), tvos(13.4));
/*
* speed
*
* Discussion:
* Returns the speed of the location in m/s. Negative if speed is invalid.
*/
@property(readonly, nonatomic) CLLocationSpeed speed API_AVAILABLE(ios(2.2), macos(10.7));
/*
* speedAccuracy
*
* Discussion:
* Returns the speed accuracy of the location in m/s. Returns -1 if invalid.
*/
@property(readonly, nonatomic) CLLocationSpeedAccuracy speedAccuracy API_AVAILABLE(macos(10.15), ios(10.0), watchos(3.0), tvos(10.0));
/*
* timestamp
*
* Discussion:
* Returns the timestamp when this location was determined.
*/
@property(readonly, nonatomic, copy) NSDate *timestamp;
/*
* floor
*
* Discussion:
* Contains information about the logical floor that you are on
* in the current building if you are inside a supported venue.
* This will be nil if the floor is unavailable.
*/
@property(readonly, nonatomic, copy, nullable) CLFloor *floor API_AVAILABLE(ios(8.0), macos(10.15));
/*
* sourceInformation
*
* Discussion:
* Contains information about the source of this location.
*/
@property(readonly, nonatomic, nullable) CLLocationSourceInformation *sourceInformation API_AVAILABLE(ios(15.0), watchos(8.0), tvos(15.0), macos(12.0));
/*
* getDistanceFrom:
*
* Discussion:
* Deprecated. Use -distanceFromLocation: instead.
*/
- (CLLocationDistance)getDistanceFrom:(const CLLocation *)location API_DEPRECATED_WITH_REPLACEMENT("-distanceFromLocation:", ios(2.0, 3.2), macos(10.15, 10.15)) API_UNAVAILABLE(watchos, tvos);
/*
* distanceFromLocation:
*
* Discussion:
* Returns the lateral distance between two locations.
*/
- (CLLocationDistance)distanceFromLocation:(const CLLocation *)location API_AVAILABLE(ios(3.2), macos(10.6));
@end
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreLocation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreLocation.framework/Headers/CLHeading.h | /*
* CLHeading.h
* CoreLocation
*
* Copyright 2008 Apple, Inc. All rights reserved.
*
*/
#import <CoreLocation/CLAvailability.h>
#import <CoreLocation/CLLocation.h>
#import <Foundation/Foundation.h>
NS_ASSUME_NONNULL_BEGIN
/*
* CLHeadingComponentValue
*
* Discussion:
* Type represents a geomagnetic value, measured in microteslas, relative to a device axis in three dimensional space.
*
*/
typedef double CLHeadingComponentValue;
/*
* kCLHeadingFilterNone
*
* Discussion:
* Use as the headingFilter property for CLLocationManager. This indicates
* to the heading service that no minimum movement filter is desired - ie, client will be informed
* of any movement.
*/
CL_EXTERN const CLLocationDegrees kCLHeadingFilterNone;
/*
* CLHeading
*
* Discussion:
* Represents a vector pointing to magnetic North constructed from axis component values x, y, and z. An accuracy of the heading calculation is also provided along with timestamp information.
*/
CL_EXTERN
API_AVAILABLE(macos(10.7), ios(3.0), watchos(2.0)) API_UNAVAILABLE(tvos)
@interface CLHeading : NSObject <NSCopying, NSSecureCoding>
{
@private
id _internal;
}
/*
* magneticHeading
*
* Discussion:
* Represents the direction in degrees, where 0 degrees is magnetic North. The direction is referenced from the top of the device regardless of device orientation as well as the orientation of the user interface.
*
* Range:
* 0.0 - 359.9 degrees, 0 being magnetic North
*/
@property(readonly, nonatomic) CLLocationDirection magneticHeading;
/*
* trueHeading
*
* Discussion:
* Represents the direction in degrees, where 0 degrees is true North. The direction is referenced
* from the top of the device regardless of device orientation as well as the orientation of the
* user interface.
*
* Range:
* 0.0 - 359.9 degrees, 0 being true North
*/
@property(readonly, nonatomic) CLLocationDirection trueHeading;
/*
* headingAccuracy
*
* Discussion:
* Represents the maximum deviation of where the magnetic heading may differ from the actual geomagnetic heading in degrees. A negative value indicates an invalid heading.
*/
@property(readonly, nonatomic) CLLocationDirection headingAccuracy;
/*
* x
*
* Discussion:
* Returns a raw value for the geomagnetism measured in the x-axis.
*
*/
@property(readonly, nonatomic) CLHeadingComponentValue x;
/*
* y
*
* Discussion:
* Returns a raw value for the geomagnetism measured in the y-axis.
*
*/
@property(readonly, nonatomic) CLHeadingComponentValue y;
/*
* z
*
* Discussion:
* Returns a raw value for the geomagnetism measured in the z-axis.
*
*/
@property(readonly, nonatomic) CLHeadingComponentValue z;
/*
* timestamp
*
* Discussion:
* Returns a timestamp for when the magnetic heading was determined.
*/
@property(readonly, nonatomic, copy) NSDate *timestamp;
@end
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreLocation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreLocation.framework/Headers/CLPlacemark.h | /*
* CLPlacemark.h
* CoreLocation
*
* Copyright (c) 2010 Apple Inc. All rights reserved.
*/
#import <Foundation/Foundation.h>
#import <CoreLocation/CLAvailability.h>
NS_ASSUME_NONNULL_BEGIN
@class CLLocation;
@class CLRegion;
@class CLPlacemarkInternal;
@class CNPostalAddress;
/*
* CLPlacemark
*
* Discussion:
* Represents placemark data for a geographic location. Placemark data can be
* information such as the country, state, city, and street address.
*/
CL_EXTERN
API_AVAILABLE(macos(10.8), ios(5.0))
@interface CLPlacemark : NSObject <NSCopying, NSSecureCoding>
{
@private
CLPlacemarkInternal *_internal;
}
/*
* initWithPlacemark:
*
* Discussion:
* Initialize a newly allocated placemark from another placemark, copying its data.
*/
- (instancetype)initWithPlacemark:(CLPlacemark *) placemark;
/*
* location
*
* Discussion:
* Returns the geographic location associated with the placemark.
*/
@property (nonatomic, readonly, copy, nullable) CLLocation *location;
/*
* region
*
* Discussion:
* Returns the geographic region associated with the placemark.
*/
@property (nonatomic, readonly, copy, nullable) CLRegion *region;
/*
* timeZone
*
* Discussion:
* Returns the time zone associated with the placemark.
*/
@property (nonatomic, readonly, copy, nullable) NSTimeZone *timeZone NS_AVAILABLE(10_11,9_0);
/*
* addressDictionary
*
* Discussion:
* This dictionary can be formatted as an address using ABCreateStringWithAddressDictionary,
* defined in the AddressBookUI framework.
*/
@property (nonatomic, readonly, copy, nullable) NSDictionary *addressDictionary API_DEPRECATED("Use @properties", macos(10.8, 10.13), ios(5.0, 11.0), watchos(1.0, 4.0));
// address dictionary properties
@property (nonatomic, readonly, copy, nullable) NSString *name; // eg. Apple Inc.
@property (nonatomic, readonly, copy, nullable) NSString *thoroughfare; // street name, eg. Infinite Loop
@property (nonatomic, readonly, copy, nullable) NSString *subThoroughfare; // eg. 1
@property (nonatomic, readonly, copy, nullable) NSString *locality; // city, eg. Cupertino
@property (nonatomic, readonly, copy, nullable) NSString *subLocality; // neighborhood, common name, eg. Mission District
@property (nonatomic, readonly, copy, nullable) NSString *administrativeArea; // state, eg. CA
@property (nonatomic, readonly, copy, nullable) NSString *subAdministrativeArea; // county, eg. Santa Clara
@property (nonatomic, readonly, copy, nullable) NSString *postalCode; // zip code, eg. 95014
@property (nonatomic, readonly, copy, nullable) NSString *ISOcountryCode; // eg. US
@property (nonatomic, readonly, copy, nullable) NSString *country; // eg. United States
@property (nonatomic, readonly, copy, nullable) NSString *inlandWater; // eg. Lake Tahoe
@property (nonatomic, readonly, copy, nullable) NSString *ocean; // eg. Pacific Ocean
@property (nonatomic, readonly, copy, nullable) NSArray<NSString *> *areasOfInterest; // eg. Golden Gate Park
@end
@interface CLPlacemark (ContactsAdditions)
@property (nonatomic, nullable, readonly) CNPostalAddress *postalAddress API_AVAILABLE(macos(10.13), ios(11.0), watchos(4.0)) API_UNAVAILABLE(tvos);
@end
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreLocation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreLocation.framework/Headers/CLErrorDomain.h | /*
* CLErrorDomain.h
* CoreLocation
*
* Copyright 2008 Apple, Inc. All rights reserved.
*
*/
#import <CoreLocation/CLAvailability.h>
#import <Foundation/Foundation.h>
NS_ASSUME_NONNULL_BEGIN
/*
* kCLErrorDomain
*
* Discussion:
* Error returned as the domain to NSError from CoreLocation.
*
* The file CLError.h defines constants for the errors in kCLErrorDomain.
*/
CL_EXTERN NSString *const kCLErrorDomain;
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreLocation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreLocation.framework/Headers/CLLocationManagerDelegate.h | /*
* CLLocationManagerDelegate.h
* CoreLocation
*
* Copyright (c) 2008-2010 Apple Inc. All rights reserved.
*
*/
#import <Availability.h>
#import <Foundation/Foundation.h>
#import <CoreLocation/CLLocationManager.h>
#import <CoreLocation/CLRegion.h>
#import <CoreLocation/CLVisit.h>
NS_ASSUME_NONNULL_BEGIN
@class CLLocation;
@class CLHeading;
@class CLBeacon;
@class CLVisit;
/*
* CLLocationManagerDelegate
*
* Discussion:
* Delegate for CLLocationManager.
*/
@protocol CLLocationManagerDelegate<NSObject>
@optional
/*
* locationManager:didUpdateToLocation:fromLocation:
*
* Discussion:
* Invoked when a new location is available. oldLocation may be nil if there is no previous location
* available.
*
* This method is deprecated. If locationManager:didUpdateLocations: is
* implemented, this method will not be called.
*/
- (void)locationManager:(CLLocationManager *)manager
didUpdateToLocation:(CLLocation *)newLocation
fromLocation:(CLLocation *)oldLocation API_AVAILABLE(macos(10.6)) API_DEPRECATED("Implement -locationManager:didUpdateLocations: instead", ios(2.0, 6.0)) API_UNAVAILABLE(watchos, tvos);
/*
* locationManager:didUpdateLocations:
*
* Discussion:
* Invoked when new locations are available. Required for delivery of
* deferred locations. If implemented, updates will
* not be delivered to locationManager:didUpdateToLocation:fromLocation:
*
* locations is an array of CLLocation objects in chronological order.
*/
- (void)locationManager:(CLLocationManager *)manager
didUpdateLocations:(NSArray<CLLocation *> *)locations API_AVAILABLE(ios(6.0), macos(10.9));
/*
* locationManager:didUpdateHeading:
*
* Discussion:
* Invoked when a new heading is available.
*/
- (void)locationManager:(CLLocationManager *)manager
didUpdateHeading:(CLHeading *)newHeading API_AVAILABLE(ios(3.0), macos(10.15), watchos(2.0)) API_UNAVAILABLE(tvos);
/*
* locationManagerShouldDisplayHeadingCalibration:
*
* Discussion:
* Invoked when a new heading is available. Return YES to display heading calibration info. The display
* will remain until heading is calibrated, unless dismissed early via dismissHeadingCalibrationDisplay.
*/
- (BOOL)locationManagerShouldDisplayHeadingCalibration:(CLLocationManager *)manager API_AVAILABLE(ios(3.0), macos(10.15), watchos(2.0)) API_UNAVAILABLE(tvos);
/*
* locationManager:didDetermineState:forRegion:
*
* Discussion:
* Invoked when there's a state transition for a monitored region or in response to a request for state via a
* a call to requestStateForRegion:.
*/
- (void)locationManager:(CLLocationManager *)manager
didDetermineState:(CLRegionState)state forRegion:(CLRegion *)region API_AVAILABLE(ios(7.0), macos(10.10)) API_UNAVAILABLE(watchos, tvos);
/*
* locationManager:didRangeBeacons:inRegion:
*
* Discussion:
* Invoked when a new set of beacons are available in the specified region.
* beacons is an array of CLBeacon objects.
* If beacons is empty, it may be assumed no beacons that match the specified region are nearby.
* Similarly if a specific beacon no longer appears in beacons, it may be assumed the beacon is no longer received
* by the device.
*/
- (void)locationManager:(CLLocationManager *)manager
didRangeBeacons:(NSArray<CLBeacon *> *)beacons
inRegion:(CLBeaconRegion *)region API_DEPRECATED_WITH_REPLACEMENT("Use locationManager:didRangeBeacons:satisfyingConstraint:", ios(7.0, 13.0), macos(10.15, 10.15)) API_UNAVAILABLE(watchos, tvos);
/*
* locationManager:rangingBeaconsDidFailForRegion:withError:
*
* Discussion:
* Invoked when an error has occurred ranging beacons in a region. Error types are defined in "CLError.h".
*/
- (void)locationManager:(CLLocationManager *)manager
rangingBeaconsDidFailForRegion:(CLBeaconRegion *)region
withError:(NSError *)error API_DEPRECATED_WITH_REPLACEMENT("Use locationManager:didFailRangingBeaconsForConstraint:error:", ios(7.0, 13.0), macos(10.15, 10.15)) API_UNAVAILABLE(watchos, tvos);
- (void)locationManager:(CLLocationManager *)manager
didRangeBeacons:(NSArray<CLBeacon *> *)beacons
satisfyingConstraint:(CLBeaconIdentityConstraint *)beaconConstraint API_AVAILABLE(ios(13.0), macos(10.15)) API_UNAVAILABLE(watchos, tvos);
- (void)locationManager:(CLLocationManager *)manager
didFailRangingBeaconsForConstraint:(CLBeaconIdentityConstraint *)beaconConstraint
error:(NSError *)error API_AVAILABLE(ios(13.0), macos(10.15)) API_UNAVAILABLE(watchos, tvos);
/*
* locationManager:didEnterRegion:
*
* Discussion:
* Invoked when the user enters a monitored region. This callback will be invoked for every allocated
* CLLocationManager instance with a non-nil delegate that implements this method.
*/
- (void)locationManager:(CLLocationManager *)manager
didEnterRegion:(CLRegion *)region API_AVAILABLE(ios(4.0), macos(10.8)) API_UNAVAILABLE(watchos, tvos);
/*
* locationManager:didExitRegion:
*
* Discussion:
* Invoked when the user exits a monitored region. This callback will be invoked for every allocated
* CLLocationManager instance with a non-nil delegate that implements this method.
*/
- (void)locationManager:(CLLocationManager *)manager
didExitRegion:(CLRegion *)region API_AVAILABLE(ios(4.0), macos(10.8)) API_UNAVAILABLE(watchos, tvos);
/*
* locationManager:didFailWithError:
*
* Discussion:
* Invoked when an error has occurred. Error types are defined in "CLError.h".
*/
- (void)locationManager:(CLLocationManager *)manager
didFailWithError:(NSError *)error;
/*
* locationManager:monitoringDidFailForRegion:withError:
*
* Discussion:
* Invoked when a region monitoring error has occurred. Error types are defined in "CLError.h".
*/
- (void)locationManager:(CLLocationManager *)manager
monitoringDidFailForRegion:(nullable CLRegion *)region
withError:(NSError *)error API_AVAILABLE(ios(4.0), macos(10.8)) API_UNAVAILABLE(watchos, tvos);
/*
* locationManager:didChangeAuthorizationStatus:
*
* Discussion:
* Invoked when the authorization status changes for this application.
*/
- (void)locationManager:(CLLocationManager *)manager didChangeAuthorizationStatus:(CLAuthorizationStatus)status API_DEPRECATED_WITH_REPLACEMENT("-locationManagerDidChangeAuthorization:", ios(4.2, 14.0), macos(10.7, 11.0), watchos(1.0, 7.0), tvos(9.0, 14.0));
/*
* locationManagerDidChangeAuthorization:
*
* Discussion:
* Invoked when either the authorizationStatus or
* accuracyAuthorization properties change
*/
- (void)locationManagerDidChangeAuthorization:(CLLocationManager *)manager API_AVAILABLE(ios(14.0), macos(11.0), watchos(7.0), tvos(14.0));
/*
* locationManager:didStartMonitoringForRegion:
*
* Discussion:
* Invoked when a monitoring for a region started successfully.
*/
- (void)locationManager:(CLLocationManager *)manager
didStartMonitoringForRegion:(CLRegion *)region API_AVAILABLE(ios(5.0), macos(10.8)) API_UNAVAILABLE(watchos, tvos);
/*
* Discussion:
* Invoked when location updates are automatically paused.
*/
- (void)locationManagerDidPauseLocationUpdates:(CLLocationManager *)manager API_AVAILABLE(ios(6.0), macos(10.15)) API_UNAVAILABLE(watchos, tvos);
/*
* Discussion:
* Invoked when location updates are automatically resumed.
*
* In the event that your application is terminated while suspended, you will
* not receive this notification.
*/
- (void)locationManagerDidResumeLocationUpdates:(CLLocationManager *)manager API_AVAILABLE(ios(6.0), macos(10.15)) API_UNAVAILABLE(watchos, tvos);
/*
* locationManager:didFinishDeferredUpdatesWithError:
*
* Discussion:
* Invoked when deferred updates will no longer be delivered. Stopping
* location, disallowing deferred updates, and meeting a specified criterion
* are all possible reasons for finishing deferred updates.
*
* An error will be returned if deferred updates end before the specified
* criteria are met (see CLError), otherwise error will be nil.
*/
- (void)locationManager:(CLLocationManager *)manager
didFinishDeferredUpdatesWithError:(nullable NSError *)error API_AVAILABLE(ios(6.0), macos(10.9)) API_UNAVAILABLE(watchos, tvos);
/*
* locationManager:didVisit:
*
* Discussion:
* Invoked when the CLLocationManager determines that the device has visited
* a location, if visit monitoring is currently started (possibly from a
* prior launch).
*/
- (void)locationManager:(CLLocationManager *)manager didVisit:(CLVisit *)visit API_AVAILABLE(ios(8.0), macos(10.15)) API_UNAVAILABLE(watchos, tvos);
@end
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreLocation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreLocation.framework/Headers/CLLocationPushServiceExtension.h | /*
* CLLocationPushServiceExtension.h
* CoreLocation
*
* Copyright © 2021 Apple Inc. All rights reserved.
*/
#import <Foundation/Foundation.h>
#import <CoreLocation/CoreLocation.h>
NS_ASSUME_NONNULL_BEGIN
API_AVAILABLE(ios(15.0)) API_UNAVAILABLE(watchos, tvos, macos, macCatalyst)
@protocol CLLocationPushServiceExtension <NSObject>
@required
// Call the completion handler once the location push has been handled.
- (void)didReceiveLocationPushPayload:(NSDictionary <NSString *, id> *)payload completion:(void (^)(void))completion;
@optional
// Called just before this extension is terminated by the system.
- (void)serviceExtensionWillTerminate;
@end
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreLocation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreLocation.framework/Headers/CLLocationManager+CLVisitExtensions.h | /*
* CLLocationManager+CLVisitExtensions.h
* CoreLocation
*
* Copyright (c) 2014 Apple Inc. All rights reserved.
*
*/
#import <CoreLocation/CLLocationManager.h>
#import <CoreLocation/CLAvailability.h>
NS_ASSUME_NONNULL_BEGIN
@interface CLLocationManager (CLVisitExtensions)
/*
* startMonitoringVisits
*
* Discussion:
* Begin monitoring for visits. All CLLLocationManagers allocated by your
* application, both current and future, will deliver detected visits to
* their delegates. This will continue until -stopMonitoringVisits is sent
* to any such CLLocationManager, even across application relaunch events.
*
* Detected visits are sent to the delegate's -locationManager:didVisit:
* method.
*/
- (void)startMonitoringVisits API_AVAILABLE(ios(8.0), macos(10.15)) API_UNAVAILABLE(watchos, tvos);
/*
* stopMonitoringVisits
*
* Discussion:
* Stop monitoring for visits. To resume visit monitoring, send
* -startMonitoringVisits.
*
* Note that stopping and starting are asynchronous operations and may not
* immediately reflect in delegate callback patterns.
*/
- (void)stopMonitoringVisits API_AVAILABLE(ios(8.0), macos(10.15)) API_UNAVAILABLE(watchos, tvos);
@end
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreLocation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreLocation.framework/Headers/CLCircularRegion.h | /*
* CLCircularRegion.h
* CoreLocation
*
* Copyright (c) 2012 Apple Inc. All rights reserved.
*
*/
#import <Foundation/Foundation.h>
#import <CoreLocation/CLRegion.h>
#import <CoreLocation/CLLocation.h>
#import <CoreLocation/CLAvailability.h>
NS_ASSUME_NONNULL_BEGIN
/*
* CLCircularRegion
*
* Discussion:
* A circular geographic area.
*/
CL_EXTERN
API_AVAILABLE(macos(10.10), ios(7.0))
@interface CLCircularRegion : CLRegion
/*
* initWithCenter:radius:identifier:
*
* Discussion:
* Initialize a region. center gives the coordinates of center of the region, while radius gives
* the distance in meters between the center and the region's boundary. identifier is a description
* for the region that could be displayed to the user, and ideally should be chosen by the user.
*/
- (instancetype)initWithCenter:(CLLocationCoordinate2D)center
radius:(CLLocationDistance)radius
identifier:(NSString *)identifier;
/*
* center
*
* Discussion:
* Returns the coordinate of the center of the region.
*/
@property (readonly, atomic) CLLocationCoordinate2D center;
/*
* radius
*
* Discussion:
* Returns the radius of the region.
*/
@property (readonly, atomic) CLLocationDistance radius;
/*
* containsCoordinate:
*
* Discussion:
* Returns YES if the coordinate lies inside the region, and NO otherwise.
*/
- (BOOL)containsCoordinate:(CLLocationCoordinate2D)coordinate;
@end
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreLocation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreLocation.framework/Headers/CLLocationPushServiceError.h | /*
* CLLocationPushServiceError.h
* CoreLocation
*
* Copyright (c) 2021 Apple Inc. All rights reserved.
*
*/
#import <Foundation/Foundation.h>
#import <CoreLocation/CLAvailability.h>
/*
* CLLocationPushServiceErrorDomain
*
* Discussion:
* Error returned as the domain to NSError from -[CLLocationManager startMonitoringLocationPushesWithCompletion:].
*
*/
CL_EXTERN NSErrorDomain const CLLocationPushServiceErrorDomain API_AVAILABLE(ios(15.0)) API_UNAVAILABLE(watchos, tvos, macos, macCatalyst);
/*
* CLLocationPushServiceError
*
* Discussion:
* Error returned as code to NSError from -[CLLocationManager startMonitoringLocationPushesWithCompletion:].
*/
typedef NS_ERROR_ENUM(CLLocationPushServiceErrorDomain, CLLocationPushServiceError) {
CLLocationPushServiceErrorUnknown = 0,
CLLocationPushServiceErrorMissingPushExtension = 1, // App is lacking a Location Push Service Extension
CLLocationPushServiceErrorMissingPushServerEnvironment = 2, // App is lacking APNS environment
CLLocationPushServiceErrorMissingEntitlement = 3, // App is lacking the com.apple.developer.location.push entitlement
} API_AVAILABLE(ios(15.0)) API_UNAVAILABLE(watchos, tvos, macos, macCatalyst);
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreLocation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreLocation.framework/Headers/CLAvailability.h | /*
* CLAvailability.h
* CoreLocation
*
* Copyright 2011 Apple Inc. All rights reserved.
*
*/
/*
#ifndef __CL_INDIRECT__
#error "Please #include <CoreLocation/CoreLocation.h> instead of this file directly."
#endif // __CL_INDIRECT__
*/
#import <Availability.h>
#import <os/availability.h>
#if defined(__has_include)
#if __has_include(<AppleFeatures/AppleFeatures.h>)
#include <AppleFeatures/AppleFeatures.h>
#endif // AppleFeatures
#else // !defined(__has_include)
#error "__has_include not defined."
#endif // __has_include
#ifdef __cplusplus
#define CL_EXTERN extern "C" __attribute__((visibility ("default")))
#else
#define CL_EXTERN extern __attribute__((visibility ("default")))
#endif
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreLocation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreLocation.framework/Headers/CLBeaconIdentityConstraint.h | /*
* CLBeaconIdentityConstraint.h
* CoreLocation
*
* Copyright (c) 2019 Apple Inc. All rights reserved.
*
*/
#import <Foundation/Foundation.h>
#import <CoreLocation/CLAvailability.h>
NS_ASSUME_NONNULL_BEGIN
/*
* CLBeaconMajorValue
*
* Discussion:
* Type represents the most significant value in a beacon.
*
*/
typedef uint16_t CLBeaconMajorValue;
/*
* CLBeaconMinorValue
*
* Discussion:
* Type represents the least significant value in a beacon.
*
*/
typedef uint16_t CLBeaconMinorValue;
/*
* CLBeaconIdentityConstraint
*
* Discussion:
* A constraint that describes the identity caracteristics of a beacon.
*
* A beacon identity is defined by UUID, major and minor values.
* UUID must be specified. If only UUID is specified, the major and
* minor values will be wildcarded and any beacons with the same
* UUID will satisfy the constraint. Similarly if only UUID and
* major value are specified, the minor value will be wildcarded
* and any beacons with the same UUID and major value will satisfy
* the constraint.
*
*/
CL_EXTERN
API_AVAILABLE(ios(13.0), macos(10.15)) API_UNAVAILABLE(watchos, tvos)
@interface CLBeaconIdentityConstraint : NSObject <NSCopying, NSSecureCoding>
/*
* UUID
*
* Discussion:
* UUID associated with the beacon.
*
*/
@property (readonly, nonatomic, copy) NSUUID *UUID;
/*
* major
*
* Discussion:
* Most significant value associated with the beacon.
*
*/
@property (readonly, nonatomic, copy, nullable) NSNumber *major;
/*
* minor
*
* Discussion:
* Least significant value associated with the beacon.
*
*/
@property (readonly, nonatomic, copy, nullable) NSNumber *minor;
/*
* initWithUUID:
*
* Discussion:
* Initialize a beacon identity constraint with a UUID. Major and
* minor values will be wildcarded.
*
*/
- (instancetype)initWithUUID:(NSUUID *)uuid;
/*
* initWithUUID:major:
*
* Discussion:
* Initialize a beacon identity constraint with a UUID and major
* value. Minor value will be wildcarded.
*
*/
- (instancetype)initWithUUID:(NSUUID *)uuid major:(CLBeaconMajorValue)major;
/*
* initWithUUID:major:minor:
*
* Discussion:
* Initialize a beacon identity constraint with a UUID, major, and
* minor values.
*
*/
- (instancetype)initWithUUID:(NSUUID *)uuid major:(CLBeaconMajorValue)major minor:(CLBeaconMinorValue)minor;
@end
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreLocation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreLocation.framework/Headers/CLLocationManager.h | /*
* CLLocationManager.h
* CoreLocation
*
* Copyright (c) 2008-2010 Apple Inc. All rights reserved.
*
*/
#import <Foundation/Foundation.h>
#import <CoreLocation/CLAvailability.h>
#import <CoreLocation/CLLocation.h>
#import <CoreLocation/CLRegion.h>
NS_ASSUME_NONNULL_BEGIN
/*
* CLDeviceOrientation
*
* Discussion:
* Specifies a physical device orientation, equivalent to UIDeviceOrientation.
*
*/
typedef NS_ENUM(int, CLDeviceOrientation) {
CLDeviceOrientationUnknown = 0,
CLDeviceOrientationPortrait,
CLDeviceOrientationPortraitUpsideDown,
CLDeviceOrientationLandscapeLeft,
CLDeviceOrientationLandscapeRight,
CLDeviceOrientationFaceUp,
CLDeviceOrientationFaceDown
};
/*
* CLAuthorizationStatus
*
* Discussion:
* Represents the current authorization state of the application.
*
*/
typedef NS_ENUM(int, CLAuthorizationStatus) {
// User has not yet made a choice with regards to this application
kCLAuthorizationStatusNotDetermined = 0,
// This application is not authorized to use location services. Due
// to active restrictions on location services, the user cannot change
// this status, and may not have personally denied authorization
kCLAuthorizationStatusRestricted,
// User has explicitly denied authorization for this application, or
// location services are disabled in Settings.
kCLAuthorizationStatusDenied,
// User has granted authorization to use their location at any
// time. Your app may be launched into the background by
// monitoring APIs such as visit monitoring, region monitoring,
// and significant location change monitoring.
//
// This value should be used on iOS, tvOS and watchOS. It is available on
// MacOS, but kCLAuthorizationStatusAuthorized is synonymous and preferred.
kCLAuthorizationStatusAuthorizedAlways API_AVAILABLE(macos(10.12), ios(8.0)),
// User has granted authorization to use their location only while
// they are using your app. Note: You can reflect the user's
// continued engagement with your app using
// -allowsBackgroundLocationUpdates.
//
// This value is not available on MacOS. It should be used on iOS, tvOS and
// watchOS.
kCLAuthorizationStatusAuthorizedWhenInUse API_AVAILABLE(ios(8.0)) API_UNAVAILABLE(macos),
// User has authorized this application to use location services.
//
// This value is deprecated or prohibited on iOS, tvOS and watchOS.
// It should be used on MacOS.
kCLAuthorizationStatusAuthorized API_DEPRECATED("Use kCLAuthorizationStatusAuthorizedAlways", ios(2.0, 8.0)) API_AVAILABLE(macos(10.6)) API_UNAVAILABLE(watchos, tvos) = kCLAuthorizationStatusAuthorizedAlways
};
typedef NS_ENUM(NSInteger, CLAccuracyAuthorization) {
// This application has the user's permission to receive accurate location information.
CLAccuracyAuthorizationFullAccuracy,
// The user has chosen to grant this application access to location information with reduced accuracy.
// Region monitoring and beacon ranging are not available to the application. Other CoreLocation APIs
// are available with reduced accuracy.
// Location estimates will have a horizontalAccuracy on the order of about 5km. To achieve the
// reduction in accuracy, CoreLocation will snap location estimates to a nearby point which represents
// the region the device is in. Furthermore, CoreLocation will reduce the rate at which location
// estimates are produced. Applications should be prepared to receive locations that are up to 20
// minutes old.
CLAccuracyAuthorizationReducedAccuracy,
};
/*
* CLActivityType
*
* Discussion:
* Expected user activity for the lifetime of the corresponding CLLocationManager instance.
* Used to optimize the positioning experience delivered to this CLLocationManager instance
* for the expected activity.
*/
typedef NS_ENUM(NSInteger, CLActivityType) {
CLActivityTypeOther = 1, // positioning in activities that are not covered by one of
// the other activity types. Includes activities without a
// specific user intention; for example, positioning while
// the user sits on a bench interacting with the device
CLActivityTypeAutomotiveNavigation, // positioning in an automobile following a road network
CLActivityTypeFitness, // positioning in dedicated fitness sessions, e.g. walking
// workouts, running workouts, cycling workouts, etc.
CLActivityTypeOtherNavigation, // positioning for transportation that does not or may not
// adhere to roads such as cycling, scooters, trains, boats
// and off-road vehicles; also for positioning indoors and
// outdoors that isn’t tied to a dedicated fitness session,
// e.g. walking
CLActivityTypeAirborne API_AVAILABLE(ios(12.0), macos(10.14), tvos(12.0), watchos(5.0)),
// positioning for activities in the air, e.g. flying in an
// airplane or helicopter, paragliding, flying on a drone,
// skydiving, etc. Also includes runway taxiing
};
@class CLLocation;
@class CLHeading;
@class CLBeaconRegion;
@class CLBeaconIdentityConstraint;
@protocol CLLocationManagerDelegate;
/*
* CLLocationManager
*
* Discussion:
* The CLLocationManager object is your entry point to the location service.
*/
CL_EXTERN
API_AVAILABLE(macos(10.6), ios(2.0))
@interface CLLocationManager : NSObject
{
@private
id _internal;
}
/*
* locationServicesEnabled
*
* Discussion:
* Determines whether the user has location services enabled.
* If NO, and you proceed to call other CoreLocation API, user will be prompted with the warning
* dialog. You may want to check this property and use location services only when explicitly requested by the user.
*/
+ (BOOL)locationServicesEnabled API_AVAILABLE(ios(4.0), macos(10.7));
/*
* headingAvailable
*
* Discussion:
* Returns YES if the device supports the heading service, otherwise NO.
*/
+ (BOOL)headingAvailable API_AVAILABLE(ios(4.0), macos(10.7), watchos(2.0)) API_UNAVAILABLE(tvos);
/*
* significantLocationChangeMonitoringAvailable
*
* Discussion:
* Returns YES if the device supports significant location change monitoring, otherwise NO.
*/
+ (BOOL)significantLocationChangeMonitoringAvailable API_AVAILABLE(ios(4.0), macos(10.7)) API_UNAVAILABLE(watchos, tvos);
/*
* isMonitoringAvailableForClass:
*
* Discussion:
* Determines whether the device supports monitoring for the specified type of region.
* If NO, all attempts to monitor the specified type of region will fail.
*/
+ (BOOL)isMonitoringAvailableForClass:(Class)regionClass API_AVAILABLE(ios(7.0), macos(10.10)) API_UNAVAILABLE(watchos, tvos);
/*
* regionMonitoringAvailable
*
* Discussion:
* Deprecated. Use +isMonitoringAvailableForClass: instead.
*/
+ (BOOL)regionMonitoringAvailable API_DEPRECATED_WITH_REPLACEMENT("+isMonitoringAvailableForClass:", ios(4.0, 7.0), macos(10.8, 10.10)) API_UNAVAILABLE(watchos, tvos);
/*
* regionMonitoringEnabled
*
* Discussion:
* Deprecated. Use +isMonitoringAvailableForClass: and -authorizationStatus instead.
*/
+ (BOOL)regionMonitoringEnabled API_DEPRECATED("Use +isMonitoringAvailableForClass: and -authorizationStatus instead", ios(4.0, 6.0), macos(10.8, 10.10)) API_UNAVAILABLE(watchos, tvos);
/*
* isRangingAvailable
*
* Discussion:
* Determines whether the device supports ranging.
* If NO, all attempts to range beacons will fail.
*/
+ (BOOL)isRangingAvailable API_AVAILABLE(ios(7.0), macos(10.15)) API_UNAVAILABLE(watchos, tvos);
/*
* authorizationStatus
*
* Discussion:
* Returns the current authorization status of the calling application.
*/
@property (nonatomic, readonly) CLAuthorizationStatus authorizationStatus API_AVAILABLE(ios(14.0), macos(11.0), watchos(7.0), tvos(14.0));
/*
* authorizationStatus
*
* Discussion:
* Deprecated. Use the instance property authorizationStatus instead.
*/
+ (CLAuthorizationStatus)authorizationStatus API_DEPRECATED_WITH_REPLACEMENT("-authorizationStatus", ios(4.2, 14.0), macos(10.7, 11.0), watchos(1.0, 7.0), tvos(9.0, 14.0));
/*
* accuracyAuthorization
*
* Discussion:
* Returns information about the calling application's access to accurate location. See the
* documentation for CLAccuracyAuthorization for information about how to interpret the return value.
*
* Note that this property should generally be interpreted in the context of the authorizationStatus
* property. For example, if authorizationStatus == kCLAuthorizationStatusNotDetermined then accurate
* location information cannot be received even when accuracyAuthorization is
* CLAccuracyAuthorizationFullAccuracy.
*/
@property (nonatomic, readonly) CLAccuracyAuthorization accuracyAuthorization API_AVAILABLE(ios(14.0), macos(11.0), watchos(7.0), tvos(14.0));
/*
* authorizedForWidgetUpdates
*
* Discussion:
* Returns true if widgets of the calling application may be eligible to receive location updates.
*
* If the calling application has authorizationStatus == kCLAuthorizationStatusAuthorizedWhenInUse,
* and authorizedForWidgetUpdates == YES, then widgets will be able to get location updates if called upon
* to refresh within a few minutes of having been seen.
*
* If the calling application has authorizationStatus == kCLAuthorizationStatusAuthorizedAlways,
* then authorizedForWidgetUpdates will always be YES.
*/
@property (nonatomic, readonly, getter=isAuthorizedForWidgetUpdates) BOOL authorizedForWidgetUpdates API_AVAILABLE(ios(14.0), macos(11.0)) API_UNAVAILABLE(watchos, tvos);
@property(weak, nonatomic, nullable) id<CLLocationManagerDelegate> delegate;
/*
* locationServicesEnabled
*
* Discussion:
* Deprecated. Use +locationServicesEnabled instead.
*/
@property(readonly, nonatomic) BOOL locationServicesEnabled API_DEPRECATED_WITH_REPLACEMENT("+locationServicesEnabled", ios(2.0, 4.0), macos(10.15, 10.15)) API_UNAVAILABLE(watchos, tvos);
/*
* purpose
*
* Discussion:
* Allows the application to specify what location will be used for in their app. This
* will be displayed along with the standard Location permissions dialogs. This property will need to be
* set prior to calling startUpdatingLocation.
*
* Deprecated. Set the purpose string in Info.plist using key NSLocationUsageDescription.
*/
@property(copy, nonatomic, nullable) NSString *purpose API_DEPRECATED("Set the purpose string in Info.plist using key NSLocationUsageDescription", ios(3.2, 6.0), macos(10.7, 11.0)) API_UNAVAILABLE(watchos, tvos);
/*
* activityType
*
* Discussion:
* Specifies the type of user activity. Currently affects behavior such as
* the determination of when location updates may be automatically paused.
* By default, CLActivityTypeOther is used.
*/
@property(assign, nonatomic) CLActivityType activityType API_AVAILABLE(ios(6.0), macos(10.15), watchos(4.0)) API_UNAVAILABLE(tvos);
/*
* distanceFilter
*
* Discussion:
* Specifies the minimum update distance in meters. Client will not be notified of movements of less
* than the stated value, unless the accuracy has improved. Pass in kCLDistanceFilterNone to be
* notified of all movements. By default, kCLDistanceFilterNone is used.
*/
@property(assign, nonatomic) CLLocationDistance distanceFilter;
/*
* desiredAccuracy
*
* Discussion:
* The desired location accuracy. The location service will try its best to achieve
* your desired accuracy. However, it is not guaranteed. To optimize
* power performance, be sure to specify an appropriate accuracy for your usage scenario (eg,
* use a large accuracy value when only a coarse location is needed). Use kCLLocationAccuracyBest to
* achieve the best possible accuracy. Use kCLLocationAccuracyBestForNavigation for navigation.
* The default value varies by platform.
*/
@property(assign, nonatomic) CLLocationAccuracy desiredAccuracy;
/*
* pausesLocationUpdatesAutomatically
*
* Discussion:
* Specifies that location updates may automatically be paused when possible.
* By default, this is YES for applications linked against iOS 6.0 or later.
*/
@property(assign, nonatomic) BOOL pausesLocationUpdatesAutomatically API_AVAILABLE(ios(6.0), macos(10.15)) API_UNAVAILABLE(watchos, tvos);
/*
* allowsBackgroundLocationUpdates
*
* Discussion:
* By default, this is NO for applications linked against iOS 9.0 or later,
* regardless of minimum deployment target.
*
* With UIBackgroundModes set to include "location" in Info.plist, you must
* also set this property to YES at runtime whenever calling
* -startUpdatingLocation with the intent to continue in the background.
*
* Setting this property to YES when UIBackgroundModes does not include
* "location" is a fatal error.
*
* Resetting this property to NO is equivalent to omitting "location" from
* the UIBackgroundModes value. Access to location is still permitted
* whenever the application is running (ie not suspended), and has
* sufficient authorization (ie it has WhenInUse authorization and is in
* use, or it has Always authorization). However, the app will still be
* subject to the usual task suspension rules.
*
* See -requestWhenInUseAuthorization and -requestAlwaysAuthorization for
* more details on possible authorization values.
*/
@property(assign, nonatomic) BOOL allowsBackgroundLocationUpdates API_AVAILABLE(ios(9.0), macos(10.15), watchos(4.0)) API_UNAVAILABLE(tvos);
/*
* showsBackgroundLocationIndicator
*
* Discussion:
* Specifies that an indicator be shown when the app makes use of continuous
* background location updates. Starting continuous background location
* updates requires the app to set UIBackgroundModes to include "location"
* and to set the property allowsBackgroundLocationUpdates to YES before
* calling -startUpdatingLocation with the intent to continue in the
* background.
*
* Note that this property only applies to apps with Always authorization.
* For apps with WhenInUse authorization, the indicator is always shown when
* using continuous background location updates in order to maintain user
* visibility and that the app is still in use.
*
* The default value of this property is NO.
*/
@property(assign, nonatomic) BOOL showsBackgroundLocationIndicator API_AVAILABLE(ios(11.0)) API_UNAVAILABLE(watchos, tvos, macos);
/*
* location
*
* Discussion:
* The last location received. Will be nil until a location has been received.
*/
@property(readonly, nonatomic, copy, nullable) CLLocation *location;
/*
* headingAvailable
*
* Discussion:
* Deprecated. Use +headingAvailable instead.
*/
@property(readonly, nonatomic) BOOL headingAvailable API_DEPRECATED_WITH_REPLACEMENT("+headingAvailable", ios(3.0, 4.0), macos(10.15, 10.15)) API_UNAVAILABLE(watchos, tvos);
/*
* headingFilter
*
* Discussion:
* Specifies the minimum amount of change in degrees needed for a heading service update. Client will not
* be notified of updates less than the stated filter value. Pass in kCLHeadingFilterNone to be
* notified of all updates. By default, 1 degree is used.
*/
@property(assign, nonatomic) CLLocationDegrees headingFilter API_AVAILABLE(ios(3.0), macos(10.15), watchos(2.0)) API_UNAVAILABLE(tvos);
/*
* headingOrientation
*
* Discussion:
* Specifies a physical device orientation from which heading calculation should be referenced. By default,
* CLDeviceOrientationPortrait is used. CLDeviceOrientationUnknown, CLDeviceOrientationFaceUp, and
* CLDeviceOrientationFaceDown are ignored.
*
*/
@property(assign, nonatomic) CLDeviceOrientation headingOrientation API_AVAILABLE(ios(4.0), macos(10.15), watchos(2.0)) API_UNAVAILABLE(tvos);
/*
* heading
*
* Discussion:
* Returns the latest heading update received, or nil if none is available.
*/
@property(readonly, nonatomic, copy, nullable) CLHeading *heading API_AVAILABLE(ios(4.0), macos(10.15), watchos(2.0)) API_UNAVAILABLE(tvos);
/*
* maximumRegionMonitoringDistance
*
* Discussion:
* the maximum region size, in terms of a distance from a central point, that the framework can support.
* Attempts to register a region larger than this will generate a kCLErrorRegionMonitoringFailure.
* This value may vary based on the hardware features of the device, as well as on dynamically changing resource constraints.
*/
@property (readonly, nonatomic) CLLocationDistance maximumRegionMonitoringDistance API_AVAILABLE(ios(4.0), macos(10.8)) API_UNAVAILABLE(watchos, tvos);
/*
* monitoredRegions
*
* Discussion:
* Retrieve a set of objects for the regions that are currently being monitored. If any location manager
* has been instructed to monitor a region, during this or previous launches of your application, it will
* be present in this set.
*/
@property (readonly, nonatomic, copy) NSSet<__kindof CLRegion *> *monitoredRegions API_AVAILABLE(ios(4.0), macos(10.8)) API_UNAVAILABLE(watchos, tvos);
/*
* rangedRegions
*
* Discussion:
* Retrieve a set of objects representing the regions for which this location manager is actively providing ranging.
*/
@property (readonly, nonatomic, copy) NSSet<__kindof CLRegion *> *rangedRegions API_DEPRECATED("Use -rangedBeaconConstraints", ios(7.0, 13.0), macos(10.15, 10.15), macCatalyst(14.0, 14.0)) API_UNAVAILABLE(watchos, tvos);
/*
* rangedBeaconConstraints
*
* Discussion:
* Retrieve a set of beacon constraints for which this location manager is actively providing ranging.
*/
@property (readonly, nonatomic, copy) NSSet<CLBeaconIdentityConstraint *> *rangedBeaconConstraints API_AVAILABLE(ios(13.0), macos(10.15)) API_UNAVAILABLE(watchos, tvos);
/*
* requestWhenInUseAuthorization
*
* Discussion:
* When -authorizationStatus == kCLAuthorizationStatusNotDetermined,
* calling this method will trigger a prompt to request "when-in-use"
* authorization from the user. Any authorization change as a result of
* the prompt will be reflected via the usual delegate callback:
* -locationManager:didChangeAuthorizationStatus:.
*
* If possible, perform this call in response to direct user request for a
* location-based service so that the reason for the prompt will be clear,
* and the utility of a one-time grant is maximized.
*
* If received, "when-in-use" authorization grants access to the user's
* location via any CoreLocation API as long as your app is being actively
* used by the user. Typically this means your app must be in the
* foreground. If you start a Continuous Background Location session (see
* -allowsBackgroundLocationUpdates), then CoreLocation will maintain
* visibility for your app as it enters the background. This will enable
* your app to continue receiving location information even as another app
* enters the foreground. Your app will remain visible in this way until
* location updates are stopped or your app is killed by the user.
*
* When -authorizationStatus != kCLAuthorizationStatusNotDetermined, (ie
* generally after the first call) this method will do nothing.
*
* If your app is not currently in use, this method will do nothing.
*
* The NSLocationWhenInUseUsageDescription key must be specified in your
* Info.plist; otherwise, this method will do nothing, as your app will be
* assumed not to support WhenInUse authorization.
*/
- (void)requestWhenInUseAuthorization API_AVAILABLE(ios(8.0), macos(10.15));
/*
* requestAlwaysAuthorization
*
* Discussion:
* When -authorizationStatus == kCLAuthorizationStatusNotDetermined,
* calling this method will start the process of requesting "always"
* authorization from the user. Any authorization change as a result of
* the prompt will be reflected via the usual delegate callback:
* -locationManager:didChangeAuthorizationStatus:.
*
* If possible, perform this call in response to direct user request for a
* location-based service so that the reason for the prompt will be clear,
* and the utility of a one-time grant is maximized.
*
* If received, "always" authorization grants access to the user's location
* via any CLLocationManager API. In addition, monitoring APIs may launch
* your app into the background when they detect an event. Even if killed by
* the user, launch events triggered by monitoring APIs will cause a
* relaunch.
*
* "Always" authorization presents a significant risk to user privacy, and
* as such requesting it is discouraged unless background launch behavior
* is genuinely required. Do not call +requestAlwaysAuthorization unless
* you think users will thank you for doing so.
*
* An application which currently has "when-in-use" authorization and has
* never before requested "always" authorization may use this method to
* request "always" authorization one time only. Otherwise, if
* -authorizationStatus != kCLAuthorizationStatusNotDetermined, (ie
* generally after the first call) this method will do nothing.
*
* If your app is not currently in use, this method will do nothing.
*
* Both the NSLocationAlwaysAndWhenInUseUsageDescription and
* NSLocationWhenInUseUsageDescription keys must be specified in your
* Info.plist; otherwise, this method will do nothing, as your app will be
* assumed not to support Always authorization.
*/
- (void)requestAlwaysAuthorization API_AVAILABLE(ios(8.0), macos(10.15)) API_UNAVAILABLE(tvos);
/*
* requestTemporaryFullAccuracyAuthorizationWithPurposeKey:completion:
*
* Discussion:
* If your app doesn't have permission to access accurate location (see
* -accuracyAuthorization), you can use this method to request temporary access
* to accurate location. This access will expire automatically, but it won't expire
* while the user is still engaged with your app. So, for example, while your app
* is in the foreground your app will retain the temporary access it was granted.
* Similarly, if your app starts a Continuous Background Location session with the
* background location indicator enabled (see -showsBackgroundLocationIndicator),
* your access to accurate location will remain as long as the background location
* indicator remains enabled. This allows your app to provide session-oriented
* experiences which require accurate location (e.g. fitness or navigation), even if
* the user has decided not to grant your app persistent access to accurate location.
*
* When CoreLocation prepares the prompt for display, it will look at the
* NSLocationTemporaryUsageDescriptionDictionary key in your Info.plist. The value
* should be a dictionary containing usage descriptions. The purposeKey you provide
* to this method must correspond to an entry in that dictionary. To retrieve a
* localized string, CoreLocation will load your InfoPlist.strings file and try to
* look up a string using the purposeKey you provided. If that fails, CoreLocation
* will use the content provided in your Info.plist. For example, suppose your
* Info.plist contains the following.
*
* <key>NSLocationTemporaryUsageDescriptionDictionary</key>
* <dict>
* <key>ExampleUsageDescription</key>
* <string>This app needs accurate location so it can verify that you're in a supported region.</string>
* <key>AnotherUsageDescription</key>
* <string>This app needs accurate location so it can show you relevant results.</string>
* </dict>
*
* In this case, you would be able to provide either "ExampleUsageDescription" or
* "AnotherUsageDescription" for the purposeKey argument. Passing any other string
* would result in the prompt not being displayed. To localize these usage
* descriptions, you would add entries for "ExampleUsageDescription" and
* "AnotherUsageDescription" to your InfoPlist.strings file.
*
* CoreLocation may decide against showing the user a prompt. For example, if your
* app already has access to accurate location or it is currently in the background.
* When that happens, your completion block will be called with an appropriate
* NSError. If the user responded to the prompt, your completion block will be
* called with a nil error. At that point, you may query the state of your
* CLLocationManager to see if you have been granted accurate access.
*
* The completion block will be called in the same threading context where delegate
* callbacks occur. That is, it will be called on the runloop where the
* CLLocationManager was originally initialized.
*/
- (void)requestTemporaryFullAccuracyAuthorizationWithPurposeKey:(NSString *)purposeKey completion:(void(^ _Nullable)(NSError * _Nullable))completion API_AVAILABLE(ios(14.0), macos(11.0), watchos(7.0), tvos(14.0));
/*
* requestTemporaryFullAccuracyAuthorizationWithPurposeKey:
*
* Discussion:
* This is a variant of requestTemporaryAccurateLocationAuthorizationWithPurposeKey:completion:
* which doesn't take a completion block. This is equivalent to passing in a nil
* completion block.
*/
- (void)requestTemporaryFullAccuracyAuthorizationWithPurposeKey:(NSString *)purposeKey API_AVAILABLE(ios(14.0), macos(11.0), watchos(7.0), tvos(14.0));
/*
* startUpdatingLocation
*
* Discussion:
* Start updating locations.
*/
- (void)startUpdatingLocation API_AVAILABLE(watchos(3.0)) API_UNAVAILABLE(tvos);
/*
* stopUpdatingLocation
*
* Discussion:
* Stop updating locations.
*/
- (void)stopUpdatingLocation;
/*
* requestLocation
*
* Discussion:
* Request a single location update.
*
* The service will attempt to determine location with accuracy according
* to the desiredAccuracy property. The location update will be delivered
* via the standard delegate callback, i.e. locationManager:didUpdateLocations:
*
* If the best available location has lower accuracy, then it will be
* delivered via the standard delegate callback after timeout.
*
* If no location can be determined, the locationManager:didFailWithError:
* delegate callback will be delivered with error location unknown.
*
* There can only be one outstanding location request and this method can
* not be used concurrently with startUpdatingLocation or
* allowDeferredLocationUpdates. Calling either of those methods will
* immediately cancel the location request. The method
* stopUpdatingLocation can be used to explicitly cancel the request.
*/
- (void)requestLocation API_AVAILABLE(ios(9.0), macos(10.14));
/*
* startUpdatingHeading
*
* Discussion:
* Start updating heading.
*/
- (void)startUpdatingHeading API_AVAILABLE(ios(3.0), macos(10.15), watchos(2.0)) API_UNAVAILABLE(tvos);
/*
* stopUpdatingHeading
*
* Discussion:
* Stop updating heading.
*/
- (void)stopUpdatingHeading API_AVAILABLE(ios(3.0), watchos(2.0)) API_UNAVAILABLE(tvos, macos);
/*
* dismissHeadingCalibrationDisplay
*
* Discussion:
* Dismiss the heading calibration immediately.
*/
- (void)dismissHeadingCalibrationDisplay API_AVAILABLE(ios(3.0), macos(10.15), watchos(2.0)) API_UNAVAILABLE(tvos);
/*
* startMonitoringSignificantLocationChanges
*
* Discussion:
* Start monitoring significant location changes. The behavior of this service is not affected by the desiredAccuracy
* or distanceFilter properties. Locations will be delivered through the same delegate callback as the standard
* location service.
*
*/
- (void)startMonitoringSignificantLocationChanges API_AVAILABLE(ios(4.0), macos(10.7)) API_UNAVAILABLE(watchos, tvos);
/*
* stopMonitoringSignificantLocationChanges
*
* Discussion:
* Stop monitoring significant location changes.
*
*/
- (void)stopMonitoringSignificantLocationChanges API_AVAILABLE(ios(4.0), macos(10.7)) API_UNAVAILABLE(watchos, tvos);
/*
* startMonitoringLocationPushes
*
* Discussion:
* Request an Apple Push Notification service token to be used to send location pushes. Incoming location pushes launch the app's Location Push Service Extension. Requires the com.apple.developer.location.push entitlement.
*
*/
- (void)startMonitoringLocationPushesWithCompletion:(void(^ _Nullable)(NSData * _Nullable token, NSError * _Nullable))completion API_AVAILABLE(ios(15.0)) API_UNAVAILABLE(macos, macCatalyst, tvos, watchos);
/*
* stopMonitoringLocationPushes
*
* Discussion:
* Stop monitoring for location pushes.
*
*/
- (void)stopMonitoringLocationPushes API_AVAILABLE(ios(15.0)) API_UNAVAILABLE(macos, macCatalyst, tvos, watchos);
/*
* startMonitoringForRegion:desiredAccuracy:
*
* Discussion:
* Start monitoring the specified region. desiredAccuracy represents the distance past the border of the region at
* which the application would like to be notified that the region border has been crossed. This is useful to prevent
* repeated notifications when the user is on the border of the region. This value will be honored on a best-effort basis,
* and may not be respected if desiredAccuracy is large with respect to the size of the region, or if the device is not
* capable of providing the precision desired.
*
* If a region of the same type with the same identifier is already being monitored for this application, it will be
* removed from monitoring.
*
* This is done asynchronously and may not be immediately reflected in monitoredRegions.
*/
- (void)startMonitoringForRegion:(CLRegion *)region
desiredAccuracy:(CLLocationAccuracy)accuracy API_DEPRECATED_WITH_REPLACEMENT("-startMonitoringForRegion:", ios(4.0, 6.0), macos(10.15, 10.15)) API_UNAVAILABLE(watchos, tvos);
/*
* stopMonitoringForRegion:
*
* Discussion:
* Stop monitoring the specified region. It is valid to call stopMonitoringForRegion: for a region that was registered
* for monitoring with a different location manager object, during this or previous launches of your application.
*
* This is done asynchronously and may not be immediately reflected in monitoredRegions.
*/
- (void)stopMonitoringForRegion:(CLRegion *)region API_AVAILABLE(ios(4.0), macos(10.8)) API_UNAVAILABLE(watchos, tvos);
/*
* startMonitoringForRegion:
*
* Discussion:
* Start monitoring the specified region.
*
* If a region of the same type with the same identifier is already being monitored for this application,
* it will be removed from monitoring. For circular regions, the region monitoring service will prioritize
* regions by their size, favoring smaller regions over larger regions.
*
* This is done asynchronously and may not be immediately reflected in monitoredRegions.
*/
- (void)startMonitoringForRegion:(CLRegion *)region API_AVAILABLE(ios(5.0), macos(10.8)) API_UNAVAILABLE(watchos, tvos);
/*
* requestStateForRegion:
*
* Discussion:
* Asynchronously retrieve the cached state of the specified region. The state is returned to the delegate via
* locationManager:didDetermineState:forRegion:.
*/
- (void)requestStateForRegion:(CLRegion *)region API_AVAILABLE(ios(7.0), macos(10.10)) API_UNAVAILABLE(watchos, tvos);
/*
* startRangingBeaconsInRegion:
*
* Discussion:
* Start calculating ranges for beacons in the specified region.
*/
- (void)startRangingBeaconsInRegion:(CLBeaconRegion *)region API_DEPRECATED("Use -startRangingBeaconsSatisfyingConstraint:", ios(7.0, 13.0), macos(11.0, 11.0), macCatalyst(14.0, 14.0)) API_UNAVAILABLE(watchos, tvos);
/*
* stopRangingBeaconsInRegion:
*
* Discussion:
* Stop calculating ranges for the specified region.
*/
- (void)stopRangingBeaconsInRegion:(CLBeaconRegion *)region API_DEPRECATED("Use -stopRangingBeaconsSatisfyingConstraint:", ios(7.0, 13.0), macos(11.0, 11.0), macCatalyst(14.0, 14.0)) API_UNAVAILABLE(watchos, tvos);
/*
* startRangingBeaconsSatisfyingConstraint:
*
* Discussion:
* Start producing ranging measurements for beacons that satisfy
* the provided constraint. Ranging will continue until you pass
* an equivalent constraint to stopRangingBeaconsSatisfyingConstraint:.
*/
- (void)startRangingBeaconsSatisfyingConstraint:(CLBeaconIdentityConstraint *)constraint API_AVAILABLE(ios(13.0), macos(10.15)) API_UNAVAILABLE(watchos, tvos);
/*
* stopRangingBeaconsSatisfyingConstraint:
*
* Discussion:
* Stop an earlier beacon ranging request. See startRangingBeaconsSatisfyingConstraint:.
*/
- (void)stopRangingBeaconsSatisfyingConstraint:(CLBeaconIdentityConstraint *)constraint API_AVAILABLE(ios(13.0), macos(10.15)) API_UNAVAILABLE(watchos, tvos);
/*
* allowDeferredLocationUpdatesUntilTraveled:timeout:
*
* Discussion:
* Indicate that the application will allow the location manager to defer
* location updates until an exit criterion is met. This may allow the
* device to enter a low-power state in which updates are held for later
* delivery. Once an exit condition is met, the location manager will
* continue normal updates until this method is invoked again.
*
* Exit conditions, distance and timeout, can be specified using the constants
* CLLocationDistanceMax and CLTimeIntervalMax, respectively, if you are
* trying to achieve an unlimited distance or timeout.
*
* The CLLocationManagerDelegate will continue to receive normal updates as
* long as the application remains in the foreground. While the process is
* in the background, the device may be able to enter a low-power state for
* portions of the specified distance and time interval. While in this
* state, locations will be coalesced for later delivery.
*
* Location updates will be deferred as much as is reasonable to save
* power. If another process is using location, the device may not enter a
* low-power state and instead updates will continue normally. Deferred
* updates may be interspersed with normal updates if the device exits and
* re-enters a low-power state.
*
* All location updates, including deferred updates, will be delivered via
* the delegate callback locationManager:didUpdateLocations:
*
* When deferred updates have ended, the manager will invoke the delegate
* callback locationManagerDidFinishDeferredUpdates:withError:. An error
* will be returned if the manager will not defer updates and the exit
* criteria have not been met.
*/
- (void)allowDeferredLocationUpdatesUntilTraveled:(CLLocationDistance)distance
timeout:(NSTimeInterval)timeout API_DEPRECATED("You can remove calls to this method", ios(6.0, 13.0), macos(10.15, 10.15)) API_UNAVAILABLE(watchos, tvos);
/*
* disallowDeferredLocationUpdates
*
* Discussion:
* Disallow deferred location updates if previously enabled. Any outstanding
* updates will be sent and regular location updates will resume.
*/
- (void)disallowDeferredLocationUpdates API_DEPRECATED("You can remove calls to this method", ios(6.0, 13.0), macos(10.15, 10.15)) API_UNAVAILABLE(watchos, tvos);
/*
* deferredLocationUpdatesAvailable
*
* Discussion:
* Returns YES if the device supports deferred location updates, otherwise NO.
*/
+ (BOOL)deferredLocationUpdatesAvailable API_DEPRECATED("You can remove calls to this method", ios(6.0, 13.0), macos(10.9, 10.15)) API_UNAVAILABLE(watchos, tvos);
@end
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreLocation.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreLocation.framework/Modules/module.modulemap | framework module CoreLocation [extern_c] {
umbrella header "CoreLocation.h"
export *
module * {
export *
}
}
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Cocoa.framework/Cocoa.tbd | --- !tapi-tbd
tbd-version: 4
targets: [ x86_64-macos, arm64-macos, arm64e-macos ]
uuids:
- target: x86_64-macos
value: DDC94193-6A78-3F24-AE77-1667F2FD66B7
- target: arm64-macos
value: 00000000-0000-0000-0000-000000000000
- target: arm64e-macos
value: A715DD7B-6CD2-34D5-962A-E9EFF7E63840
install-name: '/System/Library/Frameworks/Cocoa.framework/Versions/A/Cocoa'
current-version: 23
exports:
- targets: [ arm64e-macos, x86_64-macos, arm64-macos ]
symbols: [ _CocoaVersionNumber, _CocoaVersionString ]
...
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Cocoa.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Cocoa.framework/Headers/Cocoa.h | /*
Cocoa.h
Cocoa Framework
Copyright (c) 2000-2015, Apple Inc.
All rights reserved.
This file should be included by all Cocoa application source files for easy building. Using this file is preferred over importing individual files because it will use a precompiled version.
Tools with no UI and no AppKit dependencies may prefer to include just <Foundation/Foundation.h>.
*/
#import <Foundation/Foundation.h>
#import <AppKit/AppKit.h>
#import <CoreData/CoreData.h>
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Cocoa.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Cocoa.framework/Modules/module.modulemap | framework module Cocoa [extern_c] {
umbrella header "Cocoa.h"
export *
module * { export * }
}
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework/CoreImage.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: C174F275-F538-37D8-AA96-798B97F03D5B
- target: x86_64-maccatalyst
value: C174F275-F538-37D8-AA96-798B97F03D5B
- target: arm64-macos
value: 00000000-0000-0000-0000-000000000000
- target: arm64-maccatalyst
value: 00000000-0000-0000-0000-000000000000
- target: arm64e-macos
value: 96F16B00-FBAC-3C75-AA3C-618D7C66B2D4
- target: arm64e-maccatalyst
value: 96F16B00-FBAC-3C75-AA3C-618D7C66B2D4
install-name: '/System/Library/Frameworks/CoreImage.framework/Versions/A/CoreImage'
current-version: 5
compatibility-version: 1.0.1
exports:
- targets: [ x86_64-macos, arm64e-macos, x86_64-maccatalyst, arm64e-maccatalyst,
arm64-macos, arm64-maccatalyst ]
symbols: [ _CIDetectorAccuracy, _CIDetectorAccuracyHigh, _CIDetectorAccuracyLow,
_CIDetectorAspectRatio, _CIDetectorBetterEyeLocs, _CIDetectorDetectDiacritics,
_CIDetectorExtraCharacters, _CIDetectorEyeBlink, _CIDetectorFocalLength,
_CIDetectorImageOrientation, _CIDetectorLanguage, _CIDetectorLanguageASCII,
_CIDetectorLanguageDanish, _CIDetectorLanguageDutch, _CIDetectorLanguageEnglish,
_CIDetectorLanguageFrench, _CIDetectorLanguageGerman, _CIDetectorLanguageIcelandic,
_CIDetectorLanguageItalian, _CIDetectorLanguageNone, _CIDetectorLanguageNorwegian,
_CIDetectorLanguagePortuguese, _CIDetectorLanguageSpanish,
_CIDetectorLanguageSwedish, _CIDetectorMaxFeatureCount, _CIDetectorMinFeatureSize,
_CIDetectorNumberOfAngles, _CIDetectorReturnSubFeatures, _CIDetectorSmile,
_CIDetectorTracking, _CIDetectorTypeFace, _CIDetectorTypeQRCode,
_CIDetectorTypeRectangle, _CIDetectorTypeText, _CIDualRedEyeRepairMetadataKey_DeviceModelName,
_CIDualRedEyeRepairMetadataKey_ExifOrientation, _CIDualRedEyeRepairMetadataKey_NormalizedSNR,
_CIDualRedEyeRepairMetadataKey_PortType, _CIDualRedEyeRepairMetadataKey_TuningParametersByPortType,
_CIDualRedEyeRepairMetadataKey_WouldAutoFlashTurnOn, _CIFeatureTypeFace,
_CIFeatureTypeQRCode, _CIFeatureTypeRectangle, _CIFeatureTypeText,
_CIRAWDecoderVersion6, _CIRAWDecoderVersion6DNG, _CIRAWDecoderVersion7,
_CIRAWDecoderVersion7DNG, _CIRAWDecoderVersion8, _CIRAWDecoderVersion8DNG,
_CIRAWDecoderVersionNone, _CITextDetectorMinimizeFalseDetections,
_CI_GenericRGBLinear_to_TempTint, _CI_TempTint_to_xy, _CI_xy_to_TempTint,
_kCIActiveKeys, _kCIApplyOptionColorSpace, _kCIApplyOptionDefinition,
_kCIApplyOptionExtent, _kCIApplyOptionUserInfo, _kCIAttributeClass,
_kCIAttributeDefault, _kCIAttributeDescription, _kCIAttributeDisplayName,
_kCIAttributeFilterAvailable_Mac, _kCIAttributeFilterAvailable_iOS,
_kCIAttributeFilterCategories, _kCIAttributeFilterDisplayName,
_kCIAttributeFilterName, _kCIAttributeIdentity, _kCIAttributeMax,
_kCIAttributeMin, _kCIAttributeName, _kCIAttributeReferenceDocumentation,
_kCIAttributeSliderMax, _kCIAttributeSliderMin, _kCIAttributeType,
_kCIAttributeTypeAngle, _kCIAttributeTypeBoolean, _kCIAttributeTypeColor,
_kCIAttributeTypeCount, _kCIAttributeTypeDistance, _kCIAttributeTypeGradient,
_kCIAttributeTypeImage, _kCIAttributeTypeInteger, _kCIAttributeTypeOffset,
_kCIAttributeTypeOpaqueColor, _kCIAttributeTypePosition, _kCIAttributeTypePosition3,
_kCIAttributeTypeRectangle, _kCIAttributeTypeScalar, _kCIAttributeTypeTime,
_kCIAttributeTypeTransform, _kCIAutoPerspectiveContext, _kCIAutoPerspectiveFocalLength,
_kCIAutoPerspectiveGenerateDebugImage, _kCIAutoPerspectiveLineSearchRangeH,
_kCIAutoPerspectiveLineSearchRangeV, _kCIAutoPerspectiveMinimumPitchCorrectionArea,
_kCIAutoPerspectiveMinimumYawCorrectionArea, _kCIAutoPerspectivePitchLimit,
_kCIAutoPerspectiveRollLimit, _kCIAutoPerspectiveSaliencyHeatMap,
_kCIAutoPerspectiveVersion, _kCIAutoPerspectiveVersion1, _kCIAutoPerspectiveVersion2,
_kCIAutoPerspectiveYawLimit, _kCICategoryApplePrivate, _kCICategoryBlur,
_kCICategoryBuiltIn, _kCICategoryColorAdjustment, _kCICategoryColorEffect,
_kCICategoryCompositeOperation, _kCICategoryDistortionEffect,
_kCICategoryFilterGenerator, _kCICategoryGenerator, _kCICategoryGeometryAdjustment,
_kCICategoryGradient, _kCICategoryHalftoneEffect, _kCICategoryHighDynamicRange,
_kCICategoryInterlaced, _kCICategoryLightingEffect, _kCICategoryNonSquarePixels,
_kCICategoryReduction, _kCICategorySharpen, _kCICategoryStillImage,
_kCICategoryStylize, _kCICategoryTileEffect, _kCICategoryTransition,
_kCICategoryVideo, _kCICategoryXMPSerializable, _kCIContextAllowClampToAlpha,
_kCIContextAllowHalfPrecision, _kCIContextAllowLowPower, _kCIContextCacheIntermediates,
_kCIContextColorCubeSize, _kCIContextDefaultCGImageFormat,
_kCIContextDisableSoftwareFallback, _kCIContextEnableBlending,
_kCIContextHLGOpticalScale, _kCIContextHighQualityDownsample,
_kCIContextInlineAffineTransforms, _kCIContextIntermediateMemoryTarget,
_kCIContextLossyCompressedIntermediates, _kCIContextName,
_kCIContextOpenGLShareContext, _kCIContextOutputColorSpace,
_kCIContextOutputPremultiplied, _kCIContextParametricColorMatching,
_kCIContextPriorityRequestHigh, _kCIContextPriorityRequestLow,
_kCIContextQuality, _kCIContextUseMetalRenderer, _kCIContextUseSoftwareRenderer,
_kCIContextWorkingColorSpace, _kCIContextWorkingFormat, _kCIFilterGeneratorExportedKey,
_kCIFilterGeneratorExportedKeyName, _kCIFilterGeneratorExportedKeyTargetObject,
_kCIFormat420f, _kCIFormat420f10, _kCIFormat420f10packed,
_kCIFormat420f601, _kCIFormat420f709, _kCIFormat420fh, _kCIFormat420v,
_kCIFormat420v10, _kCIFormat420v10packed, _kCIFormat420v601,
_kCIFormat420v709, _kCIFormat444f601, _kCIFormat444f709, _kCIFormat444v601,
_kCIFormat444v709, _kCIFormatA16, _kCIFormatA2BGR10, _kCIFormatA2RGB10,
_kCIFormatA8, _kCIFormatABGR8, _kCIFormatARGB10WideGamut,
_kCIFormatARGB10WideLinear, _kCIFormatARGB16, _kCIFormatARGB8,
_kCIFormatARGBf, _kCIFormatAf, _kCIFormatAh, _kCIFormatAllowSRGB,
_kCIFormatBGRA8, _kCIFormatBGRX8, _kCIFormatCbYCrY8, _kCIFormatCbYCrY8f,
_kCIFormatI16, _kCIFormatI8, _kCIFormatIf, _kCIFormatIh, _kCIFormatL16,
_kCIFormatL8, _kCIFormatLA16, _kCIFormatLA8, _kCIFormatLAf,
_kCIFormatLAh, _kCIFormatLf, _kCIFormatLh, _kCIFormatNil,
_kCIFormatR16, _kCIFormatR8, _kCIFormatRG16, _kCIFormatRG8,
_kCIFormatRGB10WideGamut, _kCIFormatRGB10WideLinear, _kCIFormatRGB16,
_kCIFormatRGB8, _kCIFormatRGBA14, _kCIFormatRGBA16, _kCIFormatRGBA8,
_kCIFormatRGBAf, _kCIFormatRGBAh, _kCIFormatRGBX16, _kCIFormatRGBX8,
_kCIFormatRGBf, _kCIFormatRGBh, _kCIFormatRGf, _kCIFormatRGh,
_kCIFormatRf, _kCIFormatRh, _kCIFormatXBGR8, _kCIFormatXRGB8,
_kCIFormatYCbYCr8, _kCIFormatYCbYCr8f, _kCIImageAVDepthData,
_kCIImageAVPortraitEffectsMatte, _kCIImageAVSemanticSegmentationMatte,
_kCIImageAccumulatorAbortable, _kCIImageAccumulatorBlendKernel,
_kCIImageAccumulatorColorSpace, _kCIImageAlphaOne, _kCIImageApplyColorCorrectionVideoFilter,
_kCIImageApplyColorspaceCorrectionVideoFilter, _kCIImageApplyGammaCorrectionVideoFilter,
_kCIImageApplyGeometryCorrectionVideoFilter, _kCIImageApplyOrientationProperty,
_kCIImageAutoAdjustCrop, _kCIImageAutoAdjustEnhance, _kCIImageAutoAdjustFeatures,
_kCIImageAutoAdjustLevel, _kCIImageAutoAdjustLevel_DominantAngleDiffThreshold,
_kCIImageAutoAdjustLevel_MaxAngle, _kCIImageAutoAdjustLevel_MinAngle,
_kCIImageAutoAdjustLevel_UseVerticalDetector, _kCIImageAutoAdjustLevel_VerticalAngleThreshold,
_kCIImageAutoAdjustRedEye, _kCIImageAutoApplyVideoFilter,
_kCIImageAuxiliaryDepth, _kCIImageAuxiliaryDisparity, _kCIImageAuxiliaryHDRGainMap,
_kCIImageAuxiliaryPortraitEffectsMatte, _kCIImageAuxiliarySemanticSegmentationGlassesMatte,
_kCIImageAuxiliarySemanticSegmentationHairMatte, _kCIImageAuxiliarySemanticSegmentationSkinMatte,
_kCIImageAuxiliarySemanticSegmentationSkyMatte, _kCIImageAuxiliarySemanticSegmentationTeethMatte,
_kCIImageCacheHint, _kCIImageCacheImmediately, _kCIImageClampToEdge,
_kCIImageColorSpace, _kCIImageEdgeRepeat, _kCIImageEdgesAreClear,
_kCIImageFlipped, _kCIImageIgnorePixelFormatFor601Fixup, _kCIImageNearestSampling,
_kCIImageOpaque, _kCIImagePremultiplied, _kCIImageProcessorAllowPartialOutputRegion,
_kCIImageProcessorSynchronizeInputs, _kCIImageProperties,
_kCIImageProviderContentDigest, _kCIImageProviderMaximumTileSize,
_kCIImageProviderName, _kCIImageProviderTileSize, _kCIImageProviderUserInfo,
_kCIImageRepresentationAVDepthData, _kCIImageRepresentationAVPortraitEffectsMatte,
_kCIImageRepresentationAVSemanticSegmentationMattes, _kCIImageRepresentationDepthImage,
_kCIImageRepresentationDisparityImage, _kCIImageRepresentationHDRGainMapImage,
_kCIImageRepresentationPortraitEffectsMatteImage, _kCIImageRepresentationSemanticSegmentationGlassesMatteImage,
_kCIImageRepresentationSemanticSegmentationHairMatteImage,
_kCIImageRepresentationSemanticSegmentationSkinMatteImage,
_kCIImageRepresentationSemanticSegmentationSkyMatteImage,
_kCIImageRepresentationSemanticSegmentationTeethMatteImage,
_kCIImageTextScaleFactor, _kCIImageTextureFormat, _kCIImageTextureTarget,
_kCIImageToneMapHDRtoSDR, _kCIImageYCCMatrix, _kCIInputAllowDraftModeKey,
_kCIInputAmountKey, _kCIInputAngleKey, _kCIInputAspectRatioKey,
_kCIInputBackgroundImageKey, _kCIInputBaselineExposureKey,
_kCIInputBiasKey, _kCIInputBoostKey, _kCIInputBoostShadowAmountKey,
_kCIInputBrightnessKey, _kCIInputCenterKey, _kCIInputColorKey,
_kCIInputColorNoiseReductionAmountKey, _kCIInputContrastKey,
_kCIInputDecoderVersionKey, _kCIInputDepthImageKey, _kCIInputDisableGamutMapKey,
_kCIInputDisparityImageKey, _kCIInputEVKey, _kCIInputEnableChromaticNoiseTrackingKey,
_kCIInputEnableEDRModeKey, _kCIInputEnableSharpeningKey, _kCIInputEnableVendorLensCorrectionKey,
_kCIInputExtentKey, _kCIInputGradientImageKey, _kCIInputIgnoreImageOrientationKey,
_kCIInputImageKey, _kCIInputImageOrientationKey, _kCIInputIntensityKey,
_kCIInputLinearSpaceFilter, _kCIInputLocalToneMapAmountKey,
_kCIInputLuminanceNoiseReductionAmountKey, _kCIInputMaskImageKey,
_kCIInputMatteImageKey, _kCIInputMoireAmountKey, _kCIInputNeutralChromaticityXKey,
_kCIInputNeutralChromaticityYKey, _kCIInputNeutralLocationKey,
_kCIInputNeutralTemperatureKey, _kCIInputNeutralTintKey, _kCIInputNoiseReductionAmountKey,
_kCIInputNoiseReductionContrastAmountKey, _kCIInputNoiseReductionDetailAmountKey,
_kCIInputNoiseReductionSharpnessAmountKey, _kCIInputRadiusKey,
_kCIInputRefractionKey, _kCIInputSaturationKey, _kCIInputScaleFactorKey,
_kCIInputScaleKey, _kCIInputShadingImageKey, _kCIInputSharpnessKey,
_kCIInputTargetImageKey, _kCIInputTimeKey, _kCIInputTransformKey,
_kCIInputVersionKey, _kCIInputWeightsKey, _kCIInputWidthKey,
_kCIKernelMessageDescription, _kCIKernelMessageFilename, _kCIKernelMessageLineNumber,
_kCIKernelMessageOffset, _kCIKernelMessageType, _kCIKernelMessageTypeError,
_kCIKernelMessageTypeFatal, _kCIKernelMessageTypeFunctionName,
_kCIKernelMessageTypeInternalError, _kCIKernelMessageTypeNote,
_kCIKernelMessageTypeRemark, _kCIKernelMessageTypeSyntaxError,
_kCIKernelMessageTypeWarning, _kCIKernelOutputFormat, _kCIKernelThreadgroupsPerGrid,
_kCIKernelThreadsPerThreadgroup, _kCIOutputImageKey, _kCIOutputNativeSizeKey,
_kCIPhotoFilterBinaryArchive, _kCIPortraitFilterV2FullSizeBinaryArchive,
_kCIPortraitFilterV2ProxySizeBinaryArchive, _kCIPropertiesKey,
_kCISamplerAffineMatrix, _kCISamplerBlur, _kCISamplerBlurFormat,
_kCISamplerColorSpace, _kCISamplerFilterLinear, _kCISamplerFilterMode,
_kCISamplerFilterNearest, _kCISamplerFilterPoint, _kCISamplerWrapBlack,
_kCISamplerWrapClamp, _kCISamplerWrapMode, _kCISamplerWrapPeriodic,
_kCISupportedDecoderVersionsKey, _kCIUIParameterSet, _kCIUISetAdvanced,
_kCIUISetBasic, _kCIUISetDevelopment, _kCIUISetIntermediate,
_metaFilterForFilter ]
objc-classes: [ CIAztecCodeDescriptor, CIBarcodeDescriptor, CIBitmapContext,
CIBlendKernel, CICGContext, CICGSFilter, CIColor, CIColorKernel,
CIContext, CIContextCache, CIDataMatrixCodeDescriptor, CIDetector,
CIDualRedEyeRepairSession, CIFaceFeature, CIFeature, CIFilter,
CIFilterGenerator, CIFilterGeneratorConnection, CIFilterShape,
CIImage, CIImageAccumulator, CIImageProcessorKernel, CIKernel,
CIOpenGLContext, CIPDF417CodeDescriptor, CIQRCodeDescriptor,
CIQRCodeFeature, CIRAWFilter, CIRectangleFeature, CIRenderDestination,
CIRenderInfo, CIRenderTask, CISampler, CITextFeature, CIVector,
CIWarpKernel ]
objc-ivars: [ CIAztecCodeDescriptor.dataCodewordCount, CIAztecCodeDescriptor.errorCorrectedPayload,
CIAztecCodeDescriptor.isCompact, CIAztecCodeDescriptor.layerCount,
CIBitmapContext._bcpriv, CICGContext._cgPriv, CICGSFilter._cid,
CICGSFilter._filter_id, CIColor._pad, CIColor._priv, CIContext._priv,
CIDataMatrixCodeDescriptor.columnCount, CIDataMatrixCodeDescriptor.eccVersion,
CIDataMatrixCodeDescriptor.errorCorrectedPayload, CIDataMatrixCodeDescriptor.rowCount,
CIFaceFeature.bounds, CIFaceFeature.faceAngle, CIFaceFeature.hasFaceAngle,
CIFaceFeature.hasLeftEyePosition, CIFaceFeature.hasMouthPosition,
CIFaceFeature.hasRightEyePosition, CIFaceFeature.hasSmile,
CIFaceFeature.hasTrackingFrameCount, CIFaceFeature.hasTrackingID,
CIFaceFeature.leftEyeClosed, CIFaceFeature.leftEyePosition,
CIFaceFeature.mouthPosition, CIFaceFeature.rightEyeClosed,
CIFaceFeature.rightEyePosition, CIFaceFeature.trackingFrameCount,
CIFaceFeature.trackingID, CIFilter._priv, CIFilterShape._pad,
CIFilterShape._priv, CIImage._priv, CIImage._state, CIImageAccumulator._state,
CIKernel._priv, CIOpenGLContext._glPriv, CIPDF417CodeDescriptor.columnCount,
CIPDF417CodeDescriptor.errorCorrectedPayload, CIPDF417CodeDescriptor.isCompact,
CIPDF417CodeDescriptor.rowCount, CIQRCodeDescriptor.errorCorrectedPayload,
CIQRCodeDescriptor.errorCorrectionLevel, CIQRCodeDescriptor.maskPattern,
CIQRCodeDescriptor.symbolVersion, CIQRCodeFeature.bottomLeft,
CIQRCodeFeature.bottomRight, CIQRCodeFeature.bounds, CIQRCodeFeature.symbolDescriptor,
CIQRCodeFeature.topLeft, CIQRCodeFeature.topRight, CIRectangleFeature.bottomLeft,
CIRectangleFeature.bottomRight, CIRectangleFeature.bounds,
CIRectangleFeature.topLeft, CIRectangleFeature.topRight, CIRenderDestination._priv,
CIRenderInfo._priv, CIRenderTask._priv, CISampler._priv, CIVector._count,
CIVector._u ]
- targets: [ x86_64-macos, arm64e-macos, arm64-macos ]
symbols: [ '$ld$install_name$os10.10$/System/Library/Frameworks/QuartzCore.framework/Versions/A/QuartzCore',
'$ld$install_name$os10.11$/System/Library/Frameworks/QuartzCore.framework/Versions/A/QuartzCore',
'$ld$install_name$os10.4$/System/Library/Frameworks/QuartzCore.framework/Versions/A/QuartzCore',
'$ld$install_name$os10.5$/System/Library/Frameworks/QuartzCore.framework/Versions/A/QuartzCore',
'$ld$install_name$os10.6$/System/Library/Frameworks/QuartzCore.framework/Versions/A/QuartzCore',
'$ld$install_name$os10.7$/System/Library/Frameworks/QuartzCore.framework/Versions/A/QuartzCore',
'$ld$install_name$os10.8$/System/Library/Frameworks/QuartzCore.framework/Versions/A/QuartzCore',
'$ld$install_name$os10.9$/System/Library/Frameworks/QuartzCore.framework/Versions/A/QuartzCore' ]
objc-classes: [ CIPlugIn ]
objc-ivars: [ CIPlugIn._priv ]
...
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework/Headers/CIFeature.h | /* CoreImage - CIFeature.h
Copyright (c) 2011 Apple, Inc.
All rights reserved. */
#import <CoreImage/CoreImageDefines.h>
#import <Foundation/Foundation.h>
NS_ASSUME_NONNULL_BEGIN
/** Generic feature found by a CIDetector. */
NS_CLASS_AVAILABLE(10_7, 5_0)
@interface CIFeature : NSObject {}
/** The type of the feature. */
@property (readonly, retain) NSString *type;
/** The bounds of the feature in the image it was detected in. */
@property (readonly, assign) CGRect bounds;
@end
/** Specifies the type of a feature that is a face. */
CORE_IMAGE_EXPORT NSString* const CIFeatureTypeFace;
/** Specifies the type of a feature that is a rectangle. */
CORE_IMAGE_EXPORT NSString* const CIFeatureTypeRectangle;
/** Specifies the type of a feature that is a QR code. */
CORE_IMAGE_EXPORT NSString* const CIFeatureTypeQRCode;
/** Specifies the type of a feature that is a text. */
CORE_IMAGE_EXPORT NSString* const CIFeatureTypeText;
/** A face feature found by a CIDetector.
All positions are relative to the original image. */
NS_CLASS_AVAILABLE(10_7, 5_0)
@interface CIFaceFeature : CIFeature
{
CGRect bounds;
BOOL hasLeftEyePosition;
CGPoint leftEyePosition;
BOOL hasRightEyePosition;
CGPoint rightEyePosition;
BOOL hasMouthPosition;
CGPoint mouthPosition;
BOOL hasTrackingID;
int trackingID;
BOOL hasTrackingFrameCount;
int trackingFrameCount;
BOOL hasFaceAngle;
float faceAngle;
BOOL hasSmile;
BOOL leftEyeClosed;
BOOL rightEyeClosed;
}
/** coordinates of various cardinal points within a face.
Note that the left eye is the eye on the left side of the face
from the observer's perspective. It is not the left eye from
the subject's perspective. */
@property (readonly, assign) CGRect bounds;
@property (readonly, assign) BOOL hasLeftEyePosition;
@property (readonly, assign) CGPoint leftEyePosition;
@property (readonly, assign) BOOL hasRightEyePosition;
@property (readonly, assign) CGPoint rightEyePosition;
@property (readonly, assign) BOOL hasMouthPosition;
@property (readonly, assign) CGPoint mouthPosition;
@property (readonly, assign) BOOL hasTrackingID;
@property (readonly, assign) int trackingID;
@property (readonly, assign) BOOL hasTrackingFrameCount;
@property (readonly, assign) int trackingFrameCount;
@property (readonly, assign) BOOL hasFaceAngle;
@property (readonly, assign) float faceAngle;
@property (readonly, assign) BOOL hasSmile;
@property (readonly, assign) BOOL leftEyeClosed;
@property (readonly, assign) BOOL rightEyeClosed;
@end
/** A rectangle feature found by a CIDetector
All positions are relative to the original image. */
NS_CLASS_AVAILABLE(10_10, 8_0)
@interface CIRectangleFeature : CIFeature
{
CGRect bounds;
CGPoint topLeft;
CGPoint topRight;
CGPoint bottomLeft;
CGPoint bottomRight;
}
@property (readonly) CGRect bounds;
@property (readonly) CGPoint topLeft;
@property (readonly) CGPoint topRight;
@property (readonly) CGPoint bottomLeft;
@property (readonly) CGPoint bottomRight;
@end
/** A QR code feature found by a CIDetector
All positions are relative to the original image. */
@class CIQRCodeDescriptor;
NS_CLASS_AVAILABLE(10_10, 8_0)
@interface CIQRCodeFeature : CIFeature <NSSecureCoding, NSCopying>
{
CGRect bounds;
CGPoint topLeft;
CGPoint topRight;
CGPoint bottomLeft;
CGPoint bottomRight;
CIQRCodeDescriptor *symbolDescriptor;
}
@property (readonly) CGRect bounds;
@property (readonly) CGPoint topLeft;
@property (readonly) CGPoint topRight;
@property (readonly) CGPoint bottomLeft;
@property (readonly) CGPoint bottomRight;
@property (nullable, readonly) NSString* messageString;
@property (nullable, readonly) CIQRCodeDescriptor *symbolDescriptor NS_AVAILABLE(10_13, 11_0);
@end
/** A text feature found by a CIDetector
All positions are relative to the original image. */
#if __OBJC2__
NS_CLASS_AVAILABLE(10_11, 9_0)
@interface CITextFeature : CIFeature
{
}
@property (readonly) CGRect bounds;
@property (readonly) CGPoint topLeft;
@property (readonly) CGPoint topRight;
@property (readonly) CGPoint bottomLeft;
@property (readonly) CGPoint bottomRight;
@property (nullable, readonly) NSArray *subFeatures;
@end
#endif // __OBJC2__
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework/Headers/CIFilterGenerator.h | /* CoreImage - CIFilterGenerator.h
Copyright (c) 2015 Apple, Inc.
All rights reserved. */
#import <CoreImage/CoreImageDefines.h>
#import <CoreImage/CIFilterConstructor.h>
@class NSURL;
@class NSDictionary;
@class CIFilter;
NS_ASSUME_NONNULL_BEGIN
/** The key of the target object that is exported */
CORE_IMAGE_EXPORT NSString *const kCIFilterGeneratorExportedKey NS_AVAILABLE_MAC(10_5);
/** Target object for the exported key */
CORE_IMAGE_EXPORT NSString *const kCIFilterGeneratorExportedKeyTargetObject NS_AVAILABLE_MAC(10_5);
/** Name of the key under which it is exported. */
CORE_IMAGE_EXPORT NSString *const kCIFilterGeneratorExportedKeyName NS_AVAILABLE_MAC(10_5);
/** The goal is to CIFilters to be connected and form a single CIFilter for ease of reusability.
The CIFilterGenerator allows developers to create complex effects built out of one or more CIFilter and reuse them without changing code. The resulting CIFilterGenerator can be written into a file for which we introduce a new file type (extension). A CIFilterGenerator can be created from the API or more conveniently through an editor view that we provide.
CIFilterGenerator files can be put into the Image Units folders on the system and they will be loaded when the user invokes one of the loadPlugIns methods. They will be registered by their filename or if present by an attribute in its description.
*/
NS_CLASS_AVAILABLE_MAC(10_5)
@interface CIFilterGenerator : NSObject <NSSecureCoding, NSCopying, CIFilterConstructor>
{
@private struct CIFilterGeneratorStruct *_filterGeneratorStruct;
}
/** This creates an empty CIFilterGenerator in which you connect filters and images. */
+ (CIFilterGenerator *)filterGenerator;
/** Create a CIFilterGenerator with the contents of the file.
@result CIFilterGenerator object. If the file could not be read it returns nil.
*/
+ (nullable CIFilterGenerator *)filterGeneratorWithContentsOfURL:(NSURL *)aURL;
/** Initializes a CIFilterGenerator with the contents of the file.
@result CIFilterGenerator object. If the file could not be read it returns nil.
*/
- (nullable id)initWithContentsOfURL:(NSURL *)aURL;
/** Connect two objects into the filter chain.
This method connects two object in the filter chain. For instance you can connect the outputImage key of a CISepiaTone filter object to the inputImage key of another CIFilter.
@param sourceObject A CIFilter, CIImage, NSString, or NSURL describing the path to the image
@param sourceKey For KVC access to the source object. Can be nil which means that the source object will be used directly.
@param targetObject The object that you link the source object to.
@param targetKey The key that you assign the source object to.
*/
- (void)connectObject:(id)sourceObject
withKey:(nullable NSString *)sourceKey
toObject:(id)targetObject
withKey:(NSString *)targetKey;
/** Removes the connection between two objects in the filter chain.
Use this method to disconnect two objects that you connected using the connectObject:withKey:toObject:withKey: method.
@param sourceObject A CIFilter or CIImage or an NSString or an NSURL describing the path to the image
@param sourceKey For KVC access to the source object. Can be nil which means that the source object will be used directly.
@param targetObject The object that you linked the source object to.
@param targetKey The key that you assigned the source object to.
*/
- (void)disconnectObject:(id)sourceObject
withKey:(NSString *)sourceKey
toObject:(id)targetObject
withKey:(NSString *)targetKey;
/** This methods allows you to export an input or output key of an object in the filter chain to be available through the inputKeys or outputKeys API when converted into a CIFilter
When you create a CIFilter from the CIFilterGenerator, you might want the client of the filter being able to set some of the paramters of the filter chain. To do so these parameters have to be exported as keys much like the inputKeys and outputKeys of all CIFilters.
@param key The key path that is to be exported from the target object (eg. inputImage)
@param targetObject The object of which the key is to be exported (eg the filter).
@param exportedKeyName The name under which you want the new key to be available. This parameter can be nil in which case the original key name will be used. This name has to be unique. If a key being exported is an inputKey of the filter it will be exported as an input key and the other way around for output keys.
*/
- (void)exportKey:(NSString *)key
fromObject:(id)targetObject
withName:(nullable NSString *)exportedKeyName;
/** Removes a key that was exported before using exportKey:fromObject:withName:
Use this method when you want to remove a prior exported key. It will not show up under inputKeys or outputKeys anymore.
@param exportedKeyName Name of the key that was exported.
*/
- (void)removeExportedKey:(NSString *)exportedKeyName;
/** An array of the exported keys.
Use this method to get an NSArray of all the keys that you have exported using exportKey:fromObject:withName: or that were exported before written to a file from which you read the filter chain.
@result An array of dictionaries that describe the exported key and target object. See CIExportedKey, CIExportedKeyTargetObject and CIExportedKeyName for keys used in the dictionary.
*/
@property (readonly, nonatomic) NSDictionary *exportedKeys;
/** Set a new dictionary of attributes for an exported key.
By default, the exported key inherits the attributes from its original key and target object. Use this method to for instance change the default value or lower the maximum allowed value.
*/
- (void)setAttributes:(NSDictionary *)attributes
forExportedKey:(NSString *)key;
/** Retrieve or Set the class attributes that will be used to register the filter using the registerFilterName method.
Make sure you set the class attributes before using the registerFilterName method.
See CIFilter for a description of the classAttributes that are needed to register a filter.
*/
@property (retain, nonatomic) NSDictionary * classAttributes;
/** Create a CIFilter object based on this filter chain.
This method creates a CIFilter from the filter chain where the topology of the chain is immutable, meaning that changes to the filter chain will not be reflected in the filter. The filter will have the input and output keys that were exported as described above.
*/
- (CIFilter *)filter;
/** Register the resulting filter of the chain in the CIFilter repository.
This method allows you to register the filter chain as a named filter in the filter repository. You can then create a CIFilter object from it using the filterWithName: method. Make sure you set the class attributes first - see CIFilter for a description of the classAttributes that are needed to register a filter.
When registering Core Image automatically adds the kCIFilterGeneratorCategory to the filters categories. The kCIFilterGeneratorCategory is purely for identification purpose and will not be exposed in the filter browser as a seperate category.
@param name The name under which the filter will be registered. This name has to be unique.
*/
- (void)registerFilterName:(NSString *)name;
/** Write the CIFilterGenerator into a file
@result Returns true when the chain with written our succesfully
*/
- (BOOL)writeToURL:(NSURL *)aURL atomically:(BOOL)flag;
@end
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework/Headers/CIImageProcessor.h | /*
CoreImage - CIImageProcessor.h
Copyright (c) 2016 Apple Inc.
All rights reserved.
*/
#import <CoreImage/CIImage.h>
#if TARGET_OS_OSX
#import <IOSurface/IOSurface.h>
#elif !TARGET_OS_SIMULATOR
#import <IOSurface/IOSurfaceRef.h>
#endif
NS_ASSUME_NONNULL_BEGIN
@protocol MTLTexture, MTLCommandBuffer;
@protocol CIImageProcessorInput;
@protocol CIImageProcessorOutput;
// In order to use a CIImageProcessorInput & CIImageProcessorOutput you must
// subclass from a CIImageProcessorKernel and override the methods you need to
// produce the desired output.
NS_CLASS_AVAILABLE(10_12, 10_0)
@interface CIImageProcessorKernel : NSObject
// Override this class method to implement your processor's subclass of CIImageProcessorKernel.
// The class method will be called to produce the requested region of the output image
// given the required regions of the input images and other arguments.
//
// The class method is passed two objects:
// 'inputs’ An array of id<CIImageProcessorInput> that the block consumes to produces output.
// The input.region may be larger than the rect returned by 'roiForInputAtIndex'.
// 'output' The id<CIImageProcessorOutput> that the block must provide results to.
// ‘arguments’ The arguments dictionary passed to applyWithExtent:inputs:arguments:error:
// The contents of these objects are not valid outside the scope of this method.
//
// Note that since this is a class method you cannot use or capture any state by accident.
// All the parameters that affect the output results must be passed in ‘inputs’ and ‘arguments'.
// This supports 0, 1, 2 or more input images.
//
+ (BOOL)processWithInputs:(nullable NSArray<id<CIImageProcessorInput>> *)inputs
arguments:(nullable NSDictionary<NSString*,id> *)arguments
output:(id <CIImageProcessorOutput>)output
error:(NSError **)error;
// Override this class method to implement your processor’s ROI callback, the default implementation would return outputRect.
// This will be called one or more times per render to determine what portion
// of the input images are needed to render a given 'outputRect' of the output.
// This will not be called if there are 0 input images.
//
// Note that since this is a class method you cannot use or capture any state by accident.
// All the parameters that affect the output results must be passed in ‘inputs’ and ‘arguments’.
//
+ (CGRect)roiForInput:(int)input
arguments:(nullable NSDictionary<NSString*,id> *)arguments
outputRect:(CGRect)outputRect;
// Override this class method if you want your any of the inputs to be in a specific supported CIPixelFormat.
// The format must be one of kCIFormatBGRA8, kCIFormatRGBAh, kCIFormatRGBAf or kCIFormatR8.
// On iOS 12 and macOS 10.14, the formats kCIFormatRh and kCIFormatRf are also supported.
// If the requested inputFormat is 0, then the input will be a supported format that best
// matches the rendering context's workingFormat.
//
// If a processor wants data in a colorspace other than the context workingspace,
// then call imageByColorMatchingWorkingSpaceToColorSpace on the processor input.
// If a processor wants it input as alpha-unpremultiplied RGBA data, then call
// imageByUnpremultiplyingAlpha on the processor input.
//
+ (CIFormat)formatForInputAtIndex:(int)input;
// Override this class property if you want your processor's output to be in a specific supported CIPixelFormat.
// The format must be one of kCIFormatBGRA8, kCIFormatRGBAh, kCIFormatRGBAf or kCIFormatR8.
// On iOS 12 and macOS 10.14, the formats kCIFormatRh and kCIFormatRf are also supported.
// If the outputFormat is 0, then the output will be a supported format that best
// matches the rendering context's workingFormat.
//
// If a processor returns data in a colorspace other than the context workingspace,
// then call imageByColorMatchingColorSpaceToWorkingSpace on the processor output.
// If a processor returns data as alpha-unpremultiplied RGBA data, then call,
// imageByPremultiplyingAlpha on the processor output.
//
#if __has_feature(objc_class_property)
@property (class, readonly) CIFormat outputFormat;
#else
+(CIFormat)outputFormat;
#endif
// Override this class property if your processor's output stores 1.0 into the
// alpha channel of all pixels within the output extent.
// If not overridden, false is returned.
//
#if __has_feature(objc_class_property)
@property (class, readonly) bool outputIsOpaque NS_AVAILABLE(10_13, 11_0);
#else
+ (bool)outputIsOpaque NS_AVAILABLE(10_13, 11_0);
#endif
// Override this class property to return false if you want your processor to be given
// CIImageProcessorInput objects that have not been synchonized for CPU access.
//
// Generally, if your subclass uses the GPU your should override this method to return false.
// If not overridden, true is returned.
//
#if __has_feature(objc_class_property)
@property (class, readonly) bool synchronizeInputs;
#else
+(bool)synchronizeInputs;
#endif
// Call this method on your CIImageProcessorKernel subclass to create a new CIImage of the specified extent.
// The inputs and arguments will be retained so that your subclass can be called when the image is drawn.
// Arguments is a dictionary containing inmutable objects of type NSData, NSString, NSNumber,
// CIVector or CIColor.
//
// This method will return [CIImage emptyImage] if extent is empty.
//
// This method will return nil and an error if:
// * calling outputFormat on your subclass returns an unsupported format
// * calling formatForInputAtIndex: on your subclass returns an unsupported format
// * your subclass does not implement processWithInputs:arguments:output:error:
//
+ (nullable CIImage *)applyWithExtent:(CGRect)extent
inputs:(nullable NSArray<CIImage*> *)inputs
arguments:(nullable NSDictionary<NSString*,id> *)args
error:(NSError **)error;
@end
NS_CLASS_AVAILABLE(10_12, 10_0)
@protocol CIImageProcessorInput
// The rectangular region of the input image that the processor block can use to provide the output.
// This will be contain (but may be larger than) the rect returned by 'roiCallback'.
@property (nonatomic, readonly) CGRect region;
// The bytes per row of the input buffer that the processor block can read from.
@property (nonatomic, readonly) size_t bytesPerRow;
// The pixel format of the input buffer that the processor block can read from.
@property (nonatomic, readonly) CIFormat format;
// The base address of the input buffer that the processor block can read from.
// This memory must not be modified by the block.
@property (readonly, nonatomic) const void *baseAddress NS_RETURNS_INNER_POINTER;
#if COREIMAGE_SUPPORTS_IOSURFACE
// An input IOSurface that the processor block can read from.
// This surface must not be modified by the block.
@property (nonatomic, readonly) IOSurfaceRef surface;
#endif
// An input CVPixelBuffer that the processor block can read from.
// This buffer must not be modified by the block.
@property (nonatomic, readonly, nullable) CVPixelBufferRef pixelBuffer;
// A MTLTexture object that can be bound as input (if processing using Metal).
// This texture must not be modified by the block.
@property (nonatomic, readonly, nullable) id<MTLTexture> metalTexture;
@end
NS_CLASS_AVAILABLE(10_12, 10_0)
@protocol CIImageProcessorOutput
// The rectangular region of the output image that the processor block must provide.
@property (nonatomic, readonly) CGRect region;
// The bytes per row of the output buffer that the processor block can write to.
@property (nonatomic, readonly) size_t bytesPerRow;
// The pixel format of the output buffer that the processor block can write to.
@property (nonatomic, readonly) CIFormat format;
// The base address of the output buffer that the processor block can write output pixels to.
@property (readonly, nonatomic) void *baseAddress NS_RETURNS_INNER_POINTER;
#if COREIMAGE_SUPPORTS_IOSURFACE
// An output IOSurface that the processor block can write to.
@property (nonatomic, readonly) IOSurfaceRef surface;
#endif
// A output CVPixelBuffer that the processor block can write to.
@property (nonatomic, readonly, nullable) CVPixelBufferRef pixelBuffer;
// A MTLTexture object that can be bound as output (if processing using Metal).
@property (nonatomic, readonly, nullable) id<MTLTexture> metalTexture;
// Returns a MTLCommandBuffer that can be used for encoding commands (if rendering using Metal).
@property (nonatomic, readonly, nullable) id<MTLCommandBuffer> metalCommandBuffer;
@end
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework/Headers/CIImage.h | /*
CoreImage - CIImage.h
Copyright (c) 2015 Apple, Inc.
All rights reserved.
*/
#import <Foundation/Foundation.h>
#import <CoreImage/CoreImageDefines.h>
#import <CoreVideo/CoreVideo.h>
#import <ImageIO/ImageIO.h>
#if TARGET_OS_OSX
#import <IOSurface/IOSurface.h>
#elif COREIMAGE_SUPPORTS_IOSURFACE
#import <IOSurface/IOSurfaceRef.h>
#endif
NS_ASSUME_NONNULL_BEGIN
@class CIContext, CIFilterShape, CIColor, CIFilter;
@class AVDepthData;
@class AVPortraitEffectsMatte;
@class AVSemanticSegmentationMatte;
@protocol MTLTexture;
NS_CLASS_AVAILABLE(10_4, 5_0)
@interface CIImage : NSObject <NSSecureCoding, NSCopying>
{
#if TARGET_OS_OSX || TARGET_OS_MACCATALYST
void *_state;
#endif
void *_priv;
}
/* Pixel formats. */
typedef int CIFormat NS_TYPED_ENUM;
CORE_IMAGE_EXPORT CIFormat kCIFormatARGB8 NS_AVAILABLE(10_4, 6_0);
CORE_IMAGE_EXPORT CIFormat kCIFormatBGRA8;
CORE_IMAGE_EXPORT CIFormat kCIFormatRGBA8;
CORE_IMAGE_EXPORT CIFormat kCIFormatABGR8 NS_AVAILABLE(10_11, 9_0);
CORE_IMAGE_EXPORT CIFormat kCIFormatRGBAh NS_AVAILABLE(10_4, 6_0);
CORE_IMAGE_EXPORT CIFormat kCIFormatRGBA16 NS_AVAILABLE(10_4, 10_0);
CORE_IMAGE_EXPORT CIFormat kCIFormatRGBAf NS_AVAILABLE(10_4, 7_0);
CORE_IMAGE_EXPORT CIFormat kCIFormatA8 NS_AVAILABLE(10_11, 9_0);
CORE_IMAGE_EXPORT CIFormat kCIFormatA16 NS_AVAILABLE(10_11, 9_0);
CORE_IMAGE_EXPORT CIFormat kCIFormatAh NS_AVAILABLE(10_11, 9_0);
CORE_IMAGE_EXPORT CIFormat kCIFormatAf NS_AVAILABLE(10_11, 9_0);
CORE_IMAGE_EXPORT CIFormat kCIFormatR8 NS_AVAILABLE(10_11, 9_0);
CORE_IMAGE_EXPORT CIFormat kCIFormatR16 NS_AVAILABLE(10_11, 9_0);
CORE_IMAGE_EXPORT CIFormat kCIFormatRh NS_AVAILABLE(10_11, 9_0);
CORE_IMAGE_EXPORT CIFormat kCIFormatRf NS_AVAILABLE(10_11, 9_0);
CORE_IMAGE_EXPORT CIFormat kCIFormatRG8 NS_AVAILABLE(10_11, 9_0);
CORE_IMAGE_EXPORT CIFormat kCIFormatRG16 NS_AVAILABLE(10_11, 9_0);
CORE_IMAGE_EXPORT CIFormat kCIFormatRGh NS_AVAILABLE(10_11, 9_0);
CORE_IMAGE_EXPORT CIFormat kCIFormatRGf NS_AVAILABLE(10_11, 9_0);
CORE_IMAGE_EXPORT CIFormat kCIFormatL8 NS_AVAILABLE(10_12, 10_0);
CORE_IMAGE_EXPORT CIFormat kCIFormatL16 NS_AVAILABLE(10_12, 10_0);
CORE_IMAGE_EXPORT CIFormat kCIFormatLh NS_AVAILABLE(10_12, 10_0);
CORE_IMAGE_EXPORT CIFormat kCIFormatLf NS_AVAILABLE(10_12, 10_0);
CORE_IMAGE_EXPORT CIFormat kCIFormatLA8 NS_AVAILABLE(10_12, 10_0);
CORE_IMAGE_EXPORT CIFormat kCIFormatLA16 NS_AVAILABLE(10_12, 10_0);
CORE_IMAGE_EXPORT CIFormat kCIFormatLAh NS_AVAILABLE(10_12, 10_0);
CORE_IMAGE_EXPORT CIFormat kCIFormatLAf NS_AVAILABLE(10_12, 10_0);
/* Image options dictionary keys.
These keys can be passed with appropriate values to the methods:
+ [CIImage imageWith... options:]
- [CIImage initWith... options:]
to modify the default behavior of how CIImages are created.
*/
typedef NSString * CIImageOption NS_TYPED_ENUM;
/* A CGColorSpaceRef defining the color space of the image. This value
* overrides the image's implicit color space.
* If [NSNull null] then dont color manage the image. */
CORE_IMAGE_EXPORT CIImageOption const kCIImageColorSpace;
/* A boolean value specifying whether an image returned by [CIImage with...] should have kernels
* applied that will tone map to standard dynamic range (SDR).
* The option will only have an effect if the image has a CGColorSpace that is high dynamic range (HDR).
* This option can be useful if further usage of an image is not prepared for HDR values.
* If the value for this option is @YES, then the HDR input image will be tone mapped to working space SDR.
* If the value for this option is @NO, then the HDR input image will be linearized to unclamped working space.
* If this option is not specified, then it will behave as if @NO was specified.
*/
CORE_IMAGE_EXPORT CIImageOption const kCIImageToneMapHDRtoSDR NS_AVAILABLE(11_0, 14_1);
/* A boolean value specifying whether the image should sampled using "nearest neighbor"
* behavior. If not specified, the image will be sampled using "linear sampling" */
CORE_IMAGE_EXPORT CIImageOption const kCIImageNearestSampling NS_AVAILABLE(10_13, 11_0);
/* A NSDictionary of metadata properties to pass to CIImage initialization methods.
* When used with imageWithCGImage:options:, initWithCGImage:options:, imageWithData:options:, initWithData:options:
* If this option is not specified, the properties will be set to CGImageSourceCopyPropertiesAtIndex.
* If this option is [NSNull null], the properties will be set to nil.
*/
CORE_IMAGE_EXPORT CIImageOption const kCIImageProperties NS_AVAILABLE(10_8, 5_0);
/* A boolean value specifying whether the image should transformed according to orientation metadata properties.
* This can be used with imageWithContentsOfURL: or initWithData: when the image contains orientation metadata
* or with any of the initWith:options: method if the kCIImageProperties option is also provided.
* If this option value is @YES, the image will transformed according to the orientation metadata
* and the orientation metadata will be be removed.
* If this option not present or the value is @NO, then the image will not be transformed
* and the orientation metadata will left unaltered.
*/
CORE_IMAGE_EXPORT CIImageOption const kCIImageApplyOrientationProperty NS_AVAILABLE(10_13, 11_0);
CORE_IMAGE_EXPORT CIImageOption const kCIImageTextureTarget CI_GL_DEPRECATED_MAC(10_9,10_14);
CORE_IMAGE_EXPORT CIImageOption const kCIImageTextureFormat CI_GL_DEPRECATED_MAC(10_9,10_14);
/* The kCIImageAuxiliaryDepth or kCIImageAuxiliaryDisparity or kCIImageAuxiliaryPortraitEffectsMatte keys can be passed to the methods:
+ [CIImage imageWithContentsOfURL:options:]
+ [CIImage imageWithData:options:]
If the value of one of these keys is @YES, the auxiliary image be returned instead of the primary image.
If an auxiliary image is not present, then nil will be returned.
The returned image will be a half float monochrome image.
*/
CORE_IMAGE_EXPORT CIImageOption const kCIImageAuxiliaryDepth NS_AVAILABLE(10_13, 11_0);
CORE_IMAGE_EXPORT CIImageOption const kCIImageAuxiliaryDisparity NS_AVAILABLE(10_13, 11_0);
CORE_IMAGE_EXPORT CIImageOption const kCIImageAuxiliaryPortraitEffectsMatte NS_AVAILABLE(10_14, 12_0);
CORE_IMAGE_EXPORT CIImageOption const kCIImageAuxiliarySemanticSegmentationSkinMatte NS_AVAILABLE(10_15, 13_0);
CORE_IMAGE_EXPORT CIImageOption const kCIImageAuxiliarySemanticSegmentationHairMatte NS_AVAILABLE(10_15, 13_0);
CORE_IMAGE_EXPORT CIImageOption const kCIImageAuxiliarySemanticSegmentationTeethMatte NS_AVAILABLE(10_15, 13_0);
CORE_IMAGE_EXPORT CIImageOption const kCIImageAuxiliarySemanticSegmentationGlassesMatte NS_AVAILABLE(11_0, 14_1);
CORE_IMAGE_EXPORT CIImageOption const kCIImageAuxiliarySemanticSegmentationSkyMatte NS_AVAILABLE(11_1, 14_3);
/* Creates a new image from the contents of 'image'. */
+ (CIImage *)imageWithCGImage:(CGImageRef)image;
+ (CIImage *)imageWithCGImage:(CGImageRef)image
options:(nullable NSDictionary<CIImageOption, id> *)options;
/* Creates a new image from the contents of 'source'. */
+ (CIImage *)imageWithCGImageSource:(CGImageSourceRef)source
index:(size_t)index
options:(nullable NSDictionary<CIImageOption, id> *)dict NS_AVAILABLE(10_15, 13_0);
/* Creates a new image from the contents of 'layer'. */
+ (CIImage *)imageWithCGLayer:(CGLayerRef)layer NS_DEPRECATED_MAC(10_4,10_11);
+ (CIImage *)imageWithCGLayer:(CGLayerRef)layer
options:(nullable NSDictionary<CIImageOption, id> *)options NS_DEPRECATED_MAC(10_4,10_11);
/* Creates a new image whose bitmap data is from 'data'. Each row contains 'bytesPerRow'
* bytes. The dimensions of the image are defined by 'size'. 'format' defines
* the format and size of each pixel. 'colorSpace' defines the color space
* that the image is defined in, if nil, the image is not color matched. */
+ (CIImage *)imageWithBitmapData:(NSData *)data
bytesPerRow:(size_t)bytesPerRow
size:(CGSize)size
format:(CIFormat)format
colorSpace:(nullable CGColorSpaceRef)colorSpace;
/* Creates a new image referencing the contents of the GL texture object
* with identifier 'name'. The texture should have dimensions as defined
* by 'size'. If 'flipped' is true, then the contents of the texture are
* flipped vertically when referenced. 'colorSpace' defines the color space
* that the image is defined in, if nil, the texture is not color matched.*/
+ (CIImage *)imageWithTexture:(unsigned int)name
size:(CGSize)size
flipped:(BOOL)flipped
colorSpace:(nullable CGColorSpaceRef)colorSpace CI_GL_DEPRECATED(10_4,10_14, 6_0,12_0);
/* In the options dictionary you can specify the following:
* - kCIImageColorSpace which should be a CGColorSpaceRef or [NSNull null]
* - kCIImageTextureTarget which should be a NSNumber with either GL_TEXTURE_2D or GL_TEXTURE_RECTANGLE_ARB.
* - kCIImageTextureFormat which should be a NSNumber with a CIFormat value
*/
+ (CIImage *)imageWithTexture:(unsigned int)name
size:(CGSize)size
flipped:(BOOL)flipped
options:(nullable NSDictionary<CIImageOption, id> *)options CI_GL_DEPRECATED_MAC(10_9,10_14);
/* Creates a new image referencing the contents of the Metal texture object.
* The texture type must be MTLTextureType2D and the texture format must be unsigned normalized or floating-point.
* When rendering a CIImage referencing this Metal texture, there should not be any uncommitted Metal comand buffers writing to the texture. */
+ (nullable CIImage *)imageWithMTLTexture:(id<MTLTexture>)texture
options:(nullable NSDictionary<CIImageOption, id> *)options NS_AVAILABLE(10_11, 9_0);
+ (nullable CIImage *)imageWithContentsOfURL:(NSURL *)url;
+ (nullable CIImage *)imageWithContentsOfURL:(NSURL *)url
options:(nullable NSDictionary<CIImageOption, id> *)options;
+ (nullable CIImage *)imageWithData:(NSData *)data;
+ (nullable CIImage *)imageWithData:(NSData *)data
options:(nullable NSDictionary<CIImageOption, id> *)options;
/* Creates a new image whose data is from the contents of a CVImageBuffer. */
+ (CIImage *)imageWithCVImageBuffer:(CVImageBufferRef)imageBuffer NS_AVAILABLE(10_4, 9_0);
+ (CIImage *)imageWithCVImageBuffer:(CVImageBufferRef)imageBuffer
options:(nullable NSDictionary<CIImageOption, id> *)options NS_AVAILABLE(10_4, 9_0);
/* Creates a new image whose data is from the contents of a CVPixelBufferRef. */
+ (CIImage *)imageWithCVPixelBuffer:(CVPixelBufferRef)pixelBuffer NS_AVAILABLE(10_11, 5_0);
+ (CIImage *)imageWithCVPixelBuffer:(CVPixelBufferRef)pixelBuffer
options:(nullable NSDictionary<CIImageOption, id> *)options NS_AVAILABLE(10_11, 5_0);
#if COREIMAGE_SUPPORTS_IOSURFACE
/* Creates a new image from the contents of an IOSurface. */
+ (CIImage *)imageWithIOSurface:(IOSurfaceRef)surface NS_AVAILABLE(10_6, 5_0);
+ (CIImage *)imageWithIOSurface:(IOSurfaceRef)surface
options:(nullable NSDictionary<CIImageOption, id> *)options NS_AVAILABLE(10_6, 5_0);
#endif
/* Return or initialize a new image with an infinite amount of the color
* 'color'. */
+ (CIImage *)imageWithColor:(CIColor *)color;
/* Create an empty Image. */
+ (CIImage *)emptyImage;
/* Convenience constant color CIImages in the sRGB colorspace. */
@property (class, strong, readonly) CIImage *blackImage NS_AVAILABLE(10_15, 13_0);
@property (class, strong, readonly) CIImage *whiteImage NS_AVAILABLE(10_15, 13_0);
@property (class, strong, readonly) CIImage *grayImage NS_AVAILABLE(10_15, 13_0);
@property (class, strong, readonly) CIImage *redImage NS_AVAILABLE(10_15, 13_0);
@property (class, strong, readonly) CIImage *greenImage NS_AVAILABLE(10_15, 13_0);
@property (class, strong, readonly) CIImage *blueImage NS_AVAILABLE(10_15, 13_0);
@property (class, strong, readonly) CIImage *cyanImage NS_AVAILABLE(10_15, 13_0);
@property (class, strong, readonly) CIImage *magentaImage NS_AVAILABLE(10_15, 13_0);
@property (class, strong, readonly) CIImage *yellowImage NS_AVAILABLE(10_15, 13_0);
@property (class, strong, readonly) CIImage *clearImage NS_AVAILABLE(10_15, 13_0);
/* Initializers. */
- (instancetype)initWithCGImage:(CGImageRef)image;
- (instancetype)initWithCGImage:(CGImageRef)image
options:(nullable NSDictionary<CIImageOption, id> *)options;
- (instancetype) initWithCGImageSource:(CGImageSourceRef)source
index:(size_t)index
options:(nullable NSDictionary<CIImageOption, id> *)dict NS_AVAILABLE(10_15, 13_0);
- (instancetype)initWithCGLayer:(CGLayerRef)layer
NS_DEPRECATED_MAC(10_4,10_11,"Use initWithCGImage: instead.");
- (instancetype)initWithCGLayer:(CGLayerRef)layer
options:(nullable NSDictionary<CIImageOption, id> *)options
NS_DEPRECATED_MAC(10_4,10_11,"Use initWithCGImage:options instead.");
- (nullable instancetype)initWithData:(NSData *)data;
- (nullable instancetype)initWithData:(NSData *)data
options:(nullable NSDictionary<CIImageOption, id> *)options;
- (instancetype)initWithBitmapData:(NSData *)data
bytesPerRow:(size_t)bytesPerRow
size:(CGSize)size
format:(CIFormat)format
colorSpace:(nullable CGColorSpaceRef)colorSpace;
- (instancetype)initWithTexture:(unsigned int)name
size:(CGSize)size
flipped:(BOOL)flipped
colorSpace:(nullable CGColorSpaceRef)colorSpace CI_GL_DEPRECATED(10_4,10_14, 6_0,12_0);
- (instancetype)initWithTexture:(unsigned int)name
size:(CGSize)size
flipped:(BOOL)flipped
options:(nullable NSDictionary<CIImageOption, id> *)options CI_GL_DEPRECATED_MAC(10_9,10_14);
// initWithMTLTexture will return nil if textureType is not MTLTextureType2D.
- (nullable instancetype)initWithMTLTexture:(id<MTLTexture>)texture
options:(nullable NSDictionary<CIImageOption, id> *)options NS_AVAILABLE(10_11, 9_0);
- (nullable instancetype)initWithContentsOfURL:(NSURL *)url;
- (nullable instancetype)initWithContentsOfURL:(NSURL *)url
options:(nullable NSDictionary<CIImageOption, id> *)options;
#if COREIMAGE_SUPPORTS_IOSURFACE
- (instancetype)initWithIOSurface:(IOSurfaceRef)surface NS_AVAILABLE(10_6, 5_0);
- (instancetype)initWithIOSurface:(IOSurfaceRef)surface
options:(nullable NSDictionary<CIImageOption, id> *)options NS_AVAILABLE(10_6, 5_0);
#endif
#if TARGET_OS_OSX
- (instancetype)initWithIOSurface:(IOSurfaceRef)surface
plane:(size_t)plane
format:(CIFormat)format
options:(nullable NSDictionary<CIImageOption, id> *)options NS_DEPRECATED_MAC(10_9,10_11);
#endif
- (instancetype)initWithCVImageBuffer:(CVImageBufferRef)imageBuffer NS_AVAILABLE(10_4, 9_0);
- (instancetype)initWithCVImageBuffer:(CVImageBufferRef)imageBuffer
options:(nullable NSDictionary<CIImageOption, id> *)options NS_AVAILABLE(10_4, 9_0);
- (instancetype)initWithCVPixelBuffer:(CVPixelBufferRef)pixelBuffer NS_AVAILABLE(10_11, 5_0);
- (instancetype)initWithCVPixelBuffer:(CVPixelBufferRef)pixelBuffer
options:(nullable NSDictionary<CIImageOption, id> *)options NS_AVAILABLE(10_11, 5_0);
- (instancetype)initWithColor:(CIColor *)color;
/* Returns a new image representing the original image with the transform
* 'matrix' appended to it. */
- (CIImage *)imageByApplyingTransform:(CGAffineTransform)matrix;
// specifying true or false here will override the context's kCIContextHighQualityDownsample setting.
- (CIImage *)imageByApplyingTransform:(CGAffineTransform)matrix
highQualityDownsample:(BOOL)highQualityDownsample NS_AVAILABLE(10_12, 10_0);
/* Returns a new image representing the original image with a transform applied to it based on an orientation value.
* CGImagePropertyOrientation enum values from 1 to 8 as defined in the TIFF spec are supported.
* Returns original image if the image is of infinite extent. */
- (CIImage *)imageByApplyingOrientation:(int)orientation NS_AVAILABLE(10_10, 8_0);
/* Returns a CGAffineTransform for an orientation value that can be applied to an image.
* CGImagePropertyOrientation enum values from 1 to 8 as defined in the TIFF spec are supported.
* Returns CGAffineTransformIdentity if the image is of infinite extent.*/
- (CGAffineTransform)imageTransformForOrientation:(int)orientation NS_AVAILABLE(10_10, 8_0);
/* Returns a new image representing the original image transformeded for the given CGImagePropertyOrientation */
- (CIImage *)imageByApplyingCGOrientation:(CGImagePropertyOrientation)orientation NS_AVAILABLE(10_13, 11_0);
/* Returns a CGAffineTransform for the CGImagePropertyOrientation value that can be applied to an image.*/
- (CGAffineTransform)imageTransformForCGOrientation:(CGImagePropertyOrientation)orientation NS_AVAILABLE(10_13, 11_0);
/* Return a new image formed by compositing the receiver image over 'dest'.
* This is equivalent to the CISourceOverCompositing filter. */
- (CIImage *)imageByCompositingOverImage:(CIImage *)dest NS_AVAILABLE(10_4, 8_0);
/* Return a new image cropped to a rectangle. */
- (CIImage *)imageByCroppingToRect:(CGRect)rect;
/* Return a new infinite image by replicating the edge pixels of the receiver image. */
- (CIImage *)imageByClampingToExtent NS_AVAILABLE(10_10, 8_0);
/* Return a new infinite image by replicating the edge pixels of a rectangle.
* This is equivalent to the CICrop filter. */
- (CIImage *)imageByClampingToRect:(CGRect)rect NS_AVAILABLE(10_12, 10_0);
/* A convenience method for applying a filter to an image.
* The method returns outputImage of the filter after setting the
* filter's inputImage to the method receiver and other parameters
* from the key/value pairs of 'params'. */
- (CIImage *)imageByApplyingFilter:(NSString *)filterName
withInputParameters:(nullable NSDictionary<NSString *,id> *)params NS_AVAILABLE(10_10, 8_0);
/* A convenience method for applying a filter to an image.
* The method returns outputImage of the filter after setting the
* filter's inputImage to the method receiver and any other parameters
* from the filter's defaults. */
- (CIImage *)imageByApplyingFilter:(NSString *)filterName NS_AVAILABLE(10_13, 11_0);
/* Return a new image by color matching from the colorSpace to the context's working space.
* This method will return nil if the CGColorSpace is not kCGColorSpaceModelRGB. */
- (nullable CIImage *)imageByColorMatchingColorSpaceToWorkingSpace:(CGColorSpaceRef)colorSpace NS_AVAILABLE(10_12, 10_0);
/* Return a new image by color matching from the context's working space to the colorSpace.
* This method will return nil if the CGColorSpace is not kCGColorSpaceModelRGB. */
- (nullable CIImage *)imageByColorMatchingWorkingSpaceToColorSpace:(CGColorSpaceRef)colorSpace NS_AVAILABLE(10_12, 10_0);
/* Return a new image by multiplying the receiver's RGB values by its alpha. */
- (CIImage *)imageByPremultiplyingAlpha NS_AVAILABLE(10_12, 10_0);
/* Return a new image by dividing the receiver's RGB values by its alpha. */
- (CIImage *)imageByUnpremultiplyingAlpha NS_AVAILABLE(10_12, 10_0);
/* Return a new image with alpha set to 1 within the rectangle and 0 outside. */
- (CIImage *)imageBySettingAlphaOneInExtent:(CGRect)extent NS_AVAILABLE(10_12, 10_0);
/* Return a new image by applying a gaussian blur to the receiver. */
- (CIImage *)imageByApplyingGaussianBlurWithSigma:(double)sigma NS_AVAILABLE(10_12, 10_0);
/* Return a new image by changing the recevier's properties. */
- (CIImage *)imageBySettingProperties:(NSDictionary*)properties NS_AVAILABLE(10_12, 10_0);
/* Returns a new image by changing the receiver's sample mode to bilinear interpolation. */
- (CIImage *)imageBySamplingLinear NS_AVAILABLE(10_13, 11_0);
/* Returns a new image by changing the receiver's sample mode to nearest neighbor. */
- (CIImage *)imageBySamplingNearest NS_AVAILABLE(10_13, 11_0);
/* Returns a new image that inserts a intermediate that is cacheable
* according to the CIContext's kCIContextCacheIntermediates option. */
- (CIImage *)imageByInsertingIntermediate NS_AVAILABLE(10_14, 12_0);
/* Returns a new image that inserts a intermediate that is cacheable
* independent of the CIContext's kCIContextCacheIntermediates option. */
- (CIImage *)imageByInsertingIntermediate:(BOOL)cache NS_AVAILABLE(10_14, 12_0);
/* Return a rect the defines the bounds of non-(0,0,0,0) pixels */
@property (NS_NONATOMIC_IOSONLY, readonly) CGRect extent;
/* Returns the metadata properties of an image. If the image is the
* output of one or more CIFilters, then the metadata of the root inputImage
* will be returned. See also kCIImageProperties. */
@property (atomic, readonly) NSDictionary<NSString *,id> *properties NS_AVAILABLE(10_8, 5_0);
/* Return the Domain of Definition of the image. */
@property (atomic, readonly) CIFilterShape *definition NS_AVAILABLE_MAC(10_4);
/* Returns the URL of the image when the image was created using the imageWithContentsOfURL APIs.
* This method will return nil, if the URL cannot be determined. */
@property (atomic, readonly, nullable) NSURL *url NS_AVAILABLE(10_4, 9_0);
/* Returns if possible the color space of the image it was defined in.
* This method will return nil, if the color space cannot be determined. */
@property (atomic, readonly, nullable) CGColorSpaceRef colorSpace NS_AVAILABLE(10_4, 9_0) CF_RETURNS_NOT_RETAINED;
/* Returns a CVPixelBufferRef if the CIImage was created with [CIImage imageWithCVPixelBuffer] and no options.
* Otherwise this property will be nil and calling [CIContext render:toCVPixelBuffer:] is recommended.
* Modifying the contents of this pixelBuffer will cause the CIImage to render with undefined results. */
@property (nonatomic, readonly, nullable) CVPixelBufferRef pixelBuffer NS_AVAILABLE(10_12, 10_0);
/* Returns a CGImageRef if the CIImage was created with [CIImage imageWithCGImage] or [CIImage imageWithContentsOfURL] and no options.
* Otherwise this property will be nil and calling [CIContext createCGImage:fromRect:] is recommended. */
@property (nonatomic, readonly, nullable) CGImageRef CGImage NS_AVAILABLE(10_12,10_0);
/* Returns the rectangle of 'image' that is required to render the
* rectangle 'rect' of the receiver. This may return a null rect. */
- (CGRect)regionOfInterestForImage:(CIImage *)image
inRect:(CGRect)rect NS_AVAILABLE(10_11, 6_0);
@end
@interface CIImage (AutoAdjustment)
/* Image auto adjustment keys. */
typedef NSString * CIImageAutoAdjustmentOption NS_TYPED_ENUM;
/* These are the options dictionary keys which can be specified when calling
* the autoAdjustmentFiltersWithOptions: method.
*/
/* If CFBoolean value is false then dont attempt to apply enhancement filters.
* If not specified, the option is assumed to be present and true.
*/
CORE_IMAGE_EXPORT CIImageAutoAdjustmentOption const kCIImageAutoAdjustEnhance NS_AVAILABLE(10_8, 5_0);
/* If CFBoolean value is false then dont attempt to apply red eye filter.
* If not specified, the option is assumed to be present and true.
*/
CORE_IMAGE_EXPORT CIImageAutoAdjustmentOption const kCIImageAutoAdjustRedEye NS_AVAILABLE(10_8, 5_0);
/* If value is an array of detected CIFeatures, then use these features
* to determine the AutoAdjustEnhance and or AutoAdjustRedEye filters.
* If not specified, receiver will call CIDetector.
*/
CORE_IMAGE_EXPORT CIImageAutoAdjustmentOption const kCIImageAutoAdjustFeatures NS_AVAILABLE(10_8, 5_0);
/* If CFBoolean value is false then don't attempt to apply crop filter.
* If not specified, the option is assumed to be present and false.
*/
CORE_IMAGE_EXPORT CIImageAutoAdjustmentOption const kCIImageAutoAdjustCrop NS_AVAILABLE(10_10, 8_0);
/* If CFBoolean value is false then don't attempt to apply auto-level.
* If not specified, the option is assumed to be present and false.
*/
CORE_IMAGE_EXPORT CIImageAutoAdjustmentOption const kCIImageAutoAdjustLevel NS_AVAILABLE(10_10, 8_0);
/* Return an array of filters to apply to an image to improve its
* skin tones, saturation, contrast, shadows and repair red-eyes or LED-eyes.
*
* The options dictionary can contain a CIDetectorImageOrientation key value.
* The value for this key is an integer NSNumber from 1..8 such as that
* found in kCGImagePropertyOrientation. If present, the adjustment will be done
* based on that orientation but any coordinates in the returned filters will
* still be based on those of the sender image.
*/
- (NSArray<CIFilter *> *)autoAdjustmentFilters NS_AVAILABLE(10_8, 5_0);
- (NSArray<CIFilter *> *)autoAdjustmentFiltersWithOptions:(nullable NSDictionary<CIImageAutoAdjustmentOption, id> *)options
NS_AVAILABLE(10_8, 5_0);
@end
@interface CIImage (AVDepthData)
/* Returns a AVDepthData if the CIImage was created with [CIImage imageWithData] or [CIImage imageWithContentsOfURL] and.
* one the options kCIImageAuxiliaryDepth or kCIImageAuxiliaryDisparity. */
@property (nonatomic, readonly, nullable) AVDepthData *depthData NS_AVAILABLE(10_13,11_0);
-(nullable instancetype) initWithDepthData:(AVDepthData *)data
options:(nullable NSDictionary<NSString *,id> *)options NS_AVAILABLE(10_13, 11_0);
-(nullable instancetype)initWithDepthData:(AVDepthData *)data NS_AVAILABLE(10_13, 11_0);
+(nullable instancetype)imageWithDepthData:(AVDepthData *)data
options:(nullable NSDictionary<NSString *,id> *)options NS_AVAILABLE(10_13, 11_0);
+(nullable instancetype)imageWithDepthData:(AVDepthData *)data NS_AVAILABLE(10_13, 11_0);
@end
@interface CIImage (AVPortraitEffectsMatte)
/* Returns a AVPortraitEffectsMatte if the CIImage was created with [CIImage imageWithData] or [CIImage imageWithContentsOfURL] and.
* one the options kCIImageAuxiliaryPortraitEffectsMatte. */
@property (nonatomic, readonly, nullable) AVPortraitEffectsMatte *portraitEffectsMatte NS_AVAILABLE(10_14,12_0);
-(nullable instancetype) initWithPortaitEffectsMatte:(AVPortraitEffectsMatte *)matte
options:(nullable NSDictionary<CIImageOption,id> *)options NS_AVAILABLE(10_14, 12_0);
-(nullable instancetype)initWithPortaitEffectsMatte:(AVPortraitEffectsMatte *)matte NS_AVAILABLE(10_13, 11_0);
+(nullable instancetype)imageWithPortaitEffectsMatte:(AVPortraitEffectsMatte *)matte
options:(nullable NSDictionary<CIImageOption,id> *)options NS_AVAILABLE(10_14, 12_0);
+(nullable instancetype)imageWithPortaitEffectsMatte:(AVPortraitEffectsMatte *)matte NS_AVAILABLE(10_14, 12_0);
@end
@interface CIImage (AVSemanticSegmentationMatte)
/* Returns a AVSemanticSegmentationMatte if the CIImage was created with [CIImage imageWithData] or [CIImage imageWithContentsOfURL] and.
* one the options like kCIImageAuxiliarySemanticSegmentationSkinMatte. */
@property (nonatomic, readonly, nullable) AVSemanticSegmentationMatte *semanticSegmentationMatte NS_AVAILABLE(10_15, 13_0);
-(nullable instancetype)initWithSemanticSegmentationMatte:(AVSemanticSegmentationMatte *)matte
options:(nullable NSDictionary<CIImageOption,id> *)options NS_AVAILABLE(10_15, 13_0);
-(nullable instancetype)initWithSemanticSegmentationMatte:(AVSemanticSegmentationMatte *)matte NS_AVAILABLE(10_15, 13_0);
+(nullable instancetype)imageWithSemanticSegmentationMatte:(AVSemanticSegmentationMatte *)matte
options:(nullable NSDictionary<CIImageOption,id> *)options NS_AVAILABLE(10_15, 13_0);
+(nullable instancetype)imageWithSemanticSegmentationMatte:(AVSemanticSegmentationMatte *)matte NS_AVAILABLE(10_15, 13_0);
@end
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework/Headers/CoreImage.h | /* CoreImage - CoreImage.h
Copyright (c) 2014 Apple, Inc.
All rights reserved. */
#ifdef __OBJC__
#import <CoreImage/CoreImageDefines.h>
#import <Foundation/Foundation.h>
#define UNIFIED_CORE_IMAGE 1
#import <CoreImage/CIVector.h>
#import <CoreImage/CIColor.h>
#import <CoreImage/CIImage.h>
#import <CoreImage/CIContext.h>
#import <CoreImage/CIFilter.h>
#import <CoreImage/CIKernel.h>
#import <CoreImage/CIDetector.h>
#import <CoreImage/CIFeature.h>
#import <CoreImage/CIImageProvider.h>
#import <CoreImage/CIImageProcessor.h>
#import <CoreImage/CIImageAccumulator.h>
#import <CoreImage/CIFilterConstructor.h>
#import <CoreImage/CIFilterShape.h>
#import <CoreImage/CISampler.h>
#import <CoreImage/CIRAWFilter.h>
#import <CoreImage/CIRenderDestination.h>
#import <CoreImage/CIBarcodeDescriptor.h>
#import <CoreImage/CIFilterGenerator.h>
#import <CoreImage/CIPlugIn.h>
#endif /* __OBJC__ */
#import <CoreImage/CIKernelMetalLib.h>
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework/Headers/CIFilterShape.h | /*
CoreImage - CIFilterShape.h
Copyright (c) 2015 Apple, Inc.
All rights reserved.
*/
#import <Foundation/Foundation.h>
#import <CoreImage/CoreImageDefines.h>
NS_ASSUME_NONNULL_BEGIN
NS_CLASS_AVAILABLE(10_4, 9_0)
@interface CIFilterShape : NSObject <NSCopying>
{
@public
uint32_t _pad;
void *_priv;
}
/* Create a shape representing the smallest integral rect containing 'r'. */
+ (instancetype)shapeWithRect:(CGRect)r;
/* Initializer. */
- (instancetype)initWithRect:(CGRect)r;
/* Create a shape from the result of transforming the shape by 'm'. If
* 'flag' is false the new shape will contain all pixels in the
* transformed shape (and possibly some outside the transformed shape).
* If 'flag' is true the new shape will contain a subset of the pixels
* in the transformed shape (but none of those outside the transformed
* shape). */
- (CIFilterShape *)transformBy:(CGAffineTransform)m interior:(BOOL)flag;
/* Create a shape representing the shape inset by 'delta'. */
- (CIFilterShape *)insetByX:(int)dx Y:(int)dy;
/* Create a shape representing the union of the shape and 's2'. */
- (CIFilterShape *)unionWith:(CIFilterShape *)s2;
/* Create a shape representing the union of the shape and the smallest
* integral rect containing 'r'. */
- (CIFilterShape *)unionWithRect:(CGRect)r;
/* Create a shape representing the intersection of the shape and 's2'. */
- (CIFilterShape *)intersectWith:(CIFilterShape *)s2;
/* Create a shape representing the intersection of the shape and the smallest
* integral rect containing 'r'. */
- (CIFilterShape *)intersectWithRect:(CGRect)r;
/* Returns an integral rect that bounds the shape. */
@property (readonly) CGRect extent;
@end
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework/Headers/CIRAWFilter.h | /* CoreImage - CIRAWFilter.h
Copyright (c) 2006 Apple, Inc.
All rights reserved. */
#import <CoreImage/CIFilter.h>
#import <CoreImage/CoreImageDefines.h>
#import <CoreVideo/CoreVideo.h>
#import <ImageIO/CGImageProperties.h>
@class NSURL;
@class NSDictionary;
@class NSData;
NS_ASSUME_NONNULL_BEGIN
NS_CLASS_AVAILABLE(12_0, 15_0)
@interface CIRAWFilter : CIFilter
typedef NSString* CIRAWDecoderVersion NS_TYPED_ENUM;
CORE_IMAGE_EXPORT CIRAWDecoderVersion const CIRAWDecoderVersionNone;
CORE_IMAGE_EXPORT CIRAWDecoderVersion const CIRAWDecoderVersion8;
CORE_IMAGE_EXPORT CIRAWDecoderVersion const CIRAWDecoderVersion8DNG;
CORE_IMAGE_EXPORT CIRAWDecoderVersion const CIRAWDecoderVersion7;
CORE_IMAGE_EXPORT CIRAWDecoderVersion const CIRAWDecoderVersion7DNG;
CORE_IMAGE_EXPORT CIRAWDecoderVersion const CIRAWDecoderVersion6;
CORE_IMAGE_EXPORT CIRAWDecoderVersion const CIRAWDecoderVersion6DNG;
/* Returns a NSArray containing the names of all supported camera models. */
@property(class, readonly) NSArray<NSString*>* supportedCameraModels;
/* Array of all supported decoder versions for the given image type, sorted in increasingly newer order. All entries would represent a valid version identifier set to 'decoderVersion'.*/
@property(readonly) NSArray<CIRAWDecoderVersion>* supportedDecoderVersions;
/* The full native size of the unscaled image. This is not affected by changing orientation */
@property(readonly) CGSize nativeSize;
/* Metadata properties CIRAWFilter instance
This is a dictionary with the same contents as CGImageSourceCopyProperties. */
@property(readonly) NSDictionary* properties;
/* Changing this value allows the user to change the orientation of the image.
The valid values are in range 1...8 and follow the EXIF specification. */
@property(readwrite) CGImagePropertyOrientation orientation;
/* Setting Draft Mode to true can improve image decoding speed with minimal loss of quality. */
@property(readwrite, getter= isDraftModeEnabled) BOOL draftModeEnabled;
/* Version string representing the decoder version to be used. A newly initialized object defaults to the newest available decoder version for the given image type. User can request an alternative, older version in order to maintain compatibility with older releases. Must be one of supportedDecoderVersions (above), otherwise a nil output image will be generated. */
@property(readwrite, retain) CIRAWDecoderVersion decoderVersion;
/* The desired scale factor at which the image will be eventually drawn. Setting this value can greatly improve the drawing performance.
A value of 1.0 results in a full size output image, values smaller than 1 will result in a smaller output image.
The value should be the range of 0...1. Default value is 1 */
@property(readwrite) float scaleFactor;
/* A value controlling the amount of exposure to apply to the image. Default value is 0. */
@property(readwrite) float exposure;
/* A value for baseline exposure applied to the image. Default value can vary based on the image. */
@property(readwrite) float baselineExposure;
/* A value controlling an amount to subtract from shadows the image. Default value can vary based on the image. */
@property(readwrite) float shadowBias;
/* A value to control the amount of global tone curve to apply to the image.
A value of 0 indicates no global tone curve, i.e. linear response.
A value of 1 indicates full global tone curve.
The value should be the range of 0...1. The default value is 1. */
@property(readwrite) float boostAmount;
/* The amount to boost the shadow areas of the image. Can be used to lighten details in shadows. This has no effect if the boostAmount is 0.
A value less than 1 will darken the shadows. A value greater than 1 will lighten the shadows.
The value should be the range of 0...2. The default value is 1. */
@property(readwrite) float boostShadowAmount;
/* A boolean value to control if gamut mapping is enabled or not.
The default value is true. */
@property(readwrite, getter= isGamutMappingEnabled) BOOL gamutMappingEnabled;
/* A boolean value to control if gamut mapping is enabled or not.
The default value can vary based on the image.
The 'isLensCorrectionSupported' property is false if the current image doesn't support this setting. */
@property(readonly, getter= isLensCorrectionSupported) BOOL lensCorrectionSupported;
@property(readwrite, getter= isLensCorrectionEnabled) BOOL lensCorrectionEnabled;
/* A value to control the amount of luminance noise reduction to apply to the image.
A value of 0 indicates no luminance noise reduction.
A value of 1 indicates maximum luminance noise reduction.
The value should be the range of 0...1. The default value will vary per image.
The 'isLuminanceNoiseReductionSupported' property is false if the current image doesn't support this adjustment. */
@property(readonly, getter= isLuminanceNoiseReductionSupported) BOOL luminanceNoiseReductionSupported;
@property(readwrite) float luminanceNoiseReductionAmount;
/* A value to control the amount of chroma noise reduction to apply to the image.
A value of 0 indicates no chroma noise reduction.
A value of 1 indicates maximum chroma noise reduction.
The value should be the range of 0...1. The default value will vary per image.
The 'isColorNoiseReductionSupported' property is false if the current image doesn't support this adjustment. */
@property(readonly, getter= isColorNoiseReductionSupported) BOOL colorNoiseReductionSupported;
@property(readwrite) float colorNoiseReductionAmount;
/* A value to control the amount of sharpness to apply to the edges of the image.
A value of 0 indicates no sharpness applied.
A value of 1 indicates maximum sharpness applied.
The value should be the range of 0...1. The default value will vary per image.
The 'isSharpnessSupported' property is false if the current image doesn't support this adjustment. */
@property(readonly, getter= isSharpnessSupported) BOOL sharpnessSupported;
@property(readwrite) float sharpnessAmount;
/* A value to control the amount of local contrast to apply to the edges of the image.
A value of 0 indicates no contrast applied.
A value of 1 indicates maximum contrast applied.
The value should be the range of 0...1. The default value will vary per image.
The 'isContrastSupported' property is false if the current image doesn't support this adjustment. */
@property(readonly, getter= isContrastSupported) BOOL contrastSupported;
@property(readwrite) float contrastAmount;
/* A value to control the amount of detail enhancement to apply to the edges of the image.
A value of 0 indicates no detail enhancement.
A value of 3 indicates maximum detail enhancement.
The value should be the range of 0...3. The default value will vary per image.
The 'isDetailSupported' property is false if the current image doesn't support this adjustment. */
@property(readonly, getter= isDetailSupported) BOOL detailSupported;
@property(readwrite) float detailAmount;
/* A value to control the amount of moire artifact reduction to apply to high frequency areas of the image.
A value of 0 indicates no moire reduction.
A value of 3 indicates maximum moire reduction.
The value should be the range of 0...1. The default value will vary per image.
The 'isMoireReductionSupported' property is false if the current image doesn't support this adjustment. */
@property(readonly, getter= isMoireReductionSupported) BOOL moireReductionSupported;
@property(readwrite) float moireReductionAmount;
/* A value to control the amount of local tone curve to apply to the image.
A value of 0 indicates no local tone curve, i.e. linear response.
A value of 1 indicates full global tone curve.
The value should be the range of 0...1. The default value will vary per image.
The 'isLocalToneMapSupported' property is false if the current image doesn't support this adjustment. */
@property(readonly, getter= isLocalToneMapSupported) BOOL localToneMapSupported;
@property(readwrite) float localToneMapAmount;
/* Allows the output to have an Extended Dynamic Range with values greater than 1 possible.
A value of 0 indicates no extended dynamic range output.
A value of 1 indicates default extended dynamic range output.
A value of 2 indicates maximum extended dynamic range output.
The value should be the range of 0...2. The default value is 0. */
@property(readwrite) float extendedDynamicRangeAmount;
/* These properties provide differnet was to query or modify the image white balance
Use 'neutralChromaticity' to query or change white balance based on x,y chromaticity values in the range (0..1)
Use 'neutralTemperature' and 'neutralTemperature' to query or change white balance based temp/tint values in the ranges (2000K..50000K, -150..150)
Use 'neutralLocation' to change the white balance based on an x,y pixel coordiniates in the image.
*/
@property(readwrite) CGPoint neutralChromaticity;
@property(readwrite) CGPoint neutralLocation;
@property(readwrite) float neutralTemperature;
@property(readwrite) float neutralTint;
/* An optional CIFilter to be applied to the RAW image while it is in linear space. */
@property(readwrite, retain, nullable) CIFilter* linearSpaceFilter;
/* Properties for auxiliary images that may be present in the file */
@property(readonly, nullable) CIImage* previewImage;
@property(readonly, nullable) CIImage* portraitEffectsMatte;
@property(readonly, nullable) CIImage* semanticSegmentationSkinMatte;
@property(readonly, nullable) CIImage* semanticSegmentationHairMatte;
@property(readonly, nullable) CIImage* semanticSegmentationGlassesMatte;
@property(readonly, nullable) CIImage* semanticSegmentationSkyMatte;
@property(readonly, nullable) CIImage* semanticSegmentationTeethMatte;
+ (nullable instancetype)filterWithImageURL:(NSURL *)url;
+ (nullable instancetype)filterWithImageData:(NSData *)data
identifierHint:(nullable NSString *)identifierHint;
+ (nullable instancetype)filterWithCVPixelBuffer:(CVPixelBufferRef)buffer
properties:(NSDictionary *)properties;
@end
NS_ASSUME_NONNULL_END
API_DEPRECATED("Use new CIRAWFilter class instead.", macos(10.5, API_TO_BE_DEPRECATED), ios(10.0, API_TO_BE_DEPRECATED), tvos(10.0, API_TO_BE_DEPRECATED))
typedef NSString * CIRAWFilterOption NS_TYPED_ENUM;
/** CIRAWFilter is a category of CIFilter which returns a CIFilter initialized with a RAW image. It allows the user to influence key aspects of the raw processing, such as white balance, exposure, sharpening or boost. */
@interface CIFilter (CIRAWFilter)
/** Returns a CIFilter that will in turn return a properly processed CIImage as "outputImage". */
+ (CIFilter *)filterWithImageURL:(NSURL *)url options:(NSDictionary<CIRAWFilterOption, id> *)options API_DEPRECATED("Use new CIRAWFilter class instead.", macos(10.5, API_TO_BE_DEPRECATED), ios(10.0, API_TO_BE_DEPRECATED), tvos(10.0, API_TO_BE_DEPRECATED));
/** Returns a CIFilter that will in turn return a properly processed CIImage as "outputImage".
Note that when using this initializer, you should pass in a source type identifier hint (kCGImageSourceTypeIdentifierHint) key/value pair in order to help the decoder determine the file type, as otherwise confusion and incorrect results are possible. */
+ (CIFilter *)filterWithImageData:(NSData *)data options:(NSDictionary<CIRAWFilterOption, id> *)options API_DEPRECATED("Use new CIRAWFilter class instead.", macos(10.5, API_TO_BE_DEPRECATED), ios(10.0, API_TO_BE_DEPRECATED), tvos(10.0, API_TO_BE_DEPRECATED));
/** Returns a CIFilter that will in turn return a properly processed CIImage as "outputImage".
Note that when using this initializer, you should pass in a CVPixelBufferRef with one of the following Raw pixel format types
kCVPixelFormatType_14Bayer_GRBG, kCVPixelFormatType_14Bayer_RGGB, kCVPixelFormatType_14Bayer_BGGR, kCVPixelFormatType_14Bayer_GBRG
as well as the root properties attachment from the CMSampleBufferRef. */
+ (CIFilter *) filterWithCVPixelBuffer:(CVPixelBufferRef)pixelBuffer properties:(NSDictionary *)properties options:(NSDictionary<CIRAWFilterOption, id> *)options API_DEPRECATED("Use new CIRAWFilter class instead.", macos(10.12, API_TO_BE_DEPRECATED), ios(10.0, API_TO_BE_DEPRECATED), tvos(10.0, API_TO_BE_DEPRECATED));
/** Returns a NSArray containing the names of all supported RAW cameras. */
+ (NSArray<NSString*> *) supportedRawCameraModels API_DEPRECATED("Use new CIRAWFilter class instead.", macos(10.15, API_TO_BE_DEPRECATED), ios(13.0, API_TO_BE_DEPRECATED), tvos(13.0, API_TO_BE_DEPRECATED));
/** NSNumber (BOOL) : Setting Draft Mode to YES can improve image decoding speed without minimal loss of quality.
The default value is NO. */
API_DEPRECATED("Use new CIRAWFilter class instead.", macos(10.5, API_TO_BE_DEPRECATED), ios(10.0, API_TO_BE_DEPRECATED), tvos(10.0, API_TO_BE_DEPRECATED))
CORE_IMAGE_EXPORT CIRAWFilterOption const kCIInputAllowDraftModeKey;
/** NSString: Version string representing the decoder version to be used. A newly initialized object defaults to the newest available decoder version for the given image type. User can request an alternative, older version in order to maintain compatibility with older releases. Must be one of kCISupportedDecoderVersions (below), otherwise a nil output image will be generated. */
API_DEPRECATED("Use new CIRAWFilter class instead.", macos(10.5, API_TO_BE_DEPRECATED), ios(10.0, API_TO_BE_DEPRECATED), tvos(10.0, API_TO_BE_DEPRECATED))
CORE_IMAGE_EXPORT CIRAWFilterOption const kCIInputDecoderVersionKey;
/** NSArray : Array of all supported decoder versions for the given image type, sorted in increasingly newer order. Each entry is a NSString. All entries would represent a valid version identifier to be passed in for kCIInputDecoderVersion. This value can be only read; setting this value will raise an exception.*/
API_DEPRECATED("Use new CIRAWFilter class instead.", macos(10.5, API_TO_BE_DEPRECATED), ios(10.0, API_TO_BE_DEPRECATED), tvos(10.0, API_TO_BE_DEPRECATED))
CORE_IMAGE_EXPORT CIRAWFilterOption const kCISupportedDecoderVersionsKey;
/** @const kCIInputEVKey
NSNumber (float) : Exposure adjustment, default = 0.0. Declared in CIFilter.h */
/** @const kCIInputBiasKey
NSNumber (float) : Exposure bias adjustment, default = 0.0. Declared in CIFilter.h */
/** NSNumber (float) : A value controlling the amount of baseline exposure applied to the image.
A value of 0 indicates no baseline exposure, i.e. linear response. Default varies from with camera settings. */
API_DEPRECATED("Use new CIRAWFilter class instead.", macos(10.12, API_TO_BE_DEPRECATED), ios(10.0, API_TO_BE_DEPRECATED), tvos(10.0, API_TO_BE_DEPRECATED))
CORE_IMAGE_EXPORT CIRAWFilterOption const kCIInputBaselineExposureKey;
/** NSNumber (float) : A value in the range of 0...1, controlling the amount of boost applied to the image.
A value of 0 indicates no boost, i.e. linear response. Default is 1, full boost. */
API_DEPRECATED("Use new CIRAWFilter class instead.", macos(10.5, API_TO_BE_DEPRECATED), ios(10.0, API_TO_BE_DEPRECATED), tvos(10.0, API_TO_BE_DEPRECATED))
CORE_IMAGE_EXPORT CIRAWFilterOption const kCIInputBoostKey;
/** NSNumber (float) : The amount to boost the shadow areas of the image. Can be used to lighten details in shadows.
Has no effect if the image used for initialization was not RAW. */
API_DEPRECATED("Use new CIRAWFilter class instead.", macos(10.5, API_TO_BE_DEPRECATED), ios(10.0, API_TO_BE_DEPRECATED), tvos(10.0, API_TO_BE_DEPRECATED))
CORE_IMAGE_EXPORT CIRAWFilterOption const kCIInputBoostShadowAmountKey;
/** NSNumber (BOOL) : Setting DisableGamutMap to YES disables gamut mapping.
The default value is NO. */
API_DEPRECATED("Use new CIRAWFilter class instead.", macos(10.12, API_TO_BE_DEPRECATED), ios(10.0, API_TO_BE_DEPRECATED), tvos(10.0, API_TO_BE_DEPRECATED))
CORE_IMAGE_EXPORT CIRAWFilterOption const kCIInputDisableGamutMapKey;
/** NSNumber (float): The X value of the chromaticity. You can always query this value and you'll get the current X value for neutral X,Y. */
API_DEPRECATED("Use new CIRAWFilter class instead.", macos(10.5, API_TO_BE_DEPRECATED), ios(10.0, API_TO_BE_DEPRECATED), tvos(10.0, API_TO_BE_DEPRECATED))
CORE_IMAGE_EXPORT CIRAWFilterOption const kCIInputNeutralChromaticityXKey;
/** NSNumber (float): The Y value of the chromaticity. You can always query this value and you'll get the current Y value for neutral X,Y. */
API_DEPRECATED("Use new CIRAWFilter class instead.", macos(10.5, API_TO_BE_DEPRECATED), ios(10.0, API_TO_BE_DEPRECATED), tvos(10.0, API_TO_BE_DEPRECATED))
CORE_IMAGE_EXPORT CIRAWFilterOption const kCIInputNeutralChromaticityYKey;
/** NSNumber (float) : The color temperature to be considered neutral. You can always query this value and you'll get the current value for temperature. */
API_DEPRECATED("Use new CIRAWFilter class instead.", macos(10.5, API_TO_BE_DEPRECATED), ios(10.0, API_TO_BE_DEPRECATED), tvos(10.0, API_TO_BE_DEPRECATED))
CORE_IMAGE_EXPORT CIRAWFilterOption const kCIInputNeutralTemperatureKey;
/** NSNumber (float) : The tint to be considered neutral. You can always query this value and you'll get the current value for tint. */
API_DEPRECATED("Use new CIRAWFilter class instead.", macos(10.5, API_TO_BE_DEPRECATED), ios(10.0, API_TO_BE_DEPRECATED), tvos(10.0, API_TO_BE_DEPRECATED))
CORE_IMAGE_EXPORT CIRAWFilterOption const kCIInputNeutralTintKey;
/** CIVector : (x, y) location in geometric coordinates of the unrotated output image that should be used as neutral.
You can't query this value - it's undefined for reading. */
API_DEPRECATED("Use new CIRAWFilter class instead.", macos(10.5, API_TO_BE_DEPRECATED), ios(10.0, API_TO_BE_DEPRECATED), tvos(10.0, API_TO_BE_DEPRECATED))
CORE_IMAGE_EXPORT CIRAWFilterOption const kCIInputNeutralLocationKey;
/** NSNumber (float) : The desired scale factor at which the image will be eventually drawn. Setting this value can greatly improve the drawing performance. A value of 1 would mean identity, values smaller than 1 will result in a smaller output image. Changing the Scale Factor with enabled Draft Mode may also improve performance. */
API_DEPRECATED("Use new CIRAWFilter class instead.", macos(10.5, API_TO_BE_DEPRECATED), ios(10.0, API_TO_BE_DEPRECATED), tvos(10.0, API_TO_BE_DEPRECATED))
CORE_IMAGE_EXPORT CIRAWFilterOption const kCIInputScaleFactorKey;
/** NSNumber (BOOL) : Normally, an image is loaded in its proper orientation, given the associated metadata gives an indication about the orientation. For special purposes it may be useful to load the image in its physical orientation. The exact meaning of this is dependent on the image in question. The default value is NO. */
API_DEPRECATED("Use new CIRAWFilter class instead.", macos(10.5, API_TO_BE_DEPRECATED), ios(10.0, API_TO_BE_DEPRECATED), tvos(10.0, API_TO_BE_DEPRECATED))
CORE_IMAGE_EXPORT CIRAWFilterOption const kCIInputIgnoreImageOrientationKey;
/** NSNumber (int) : Overriding this value allows the user to change the orientation of the image. The valid values are in range 1...8 and follow the EXIF specification. Changing this value makes for instance rotation in 90-degree increments easy. The value is disregarded when the kCIInputIgnoreImageOrientationKey flag is set.
*/
API_DEPRECATED("Use new CIRAWFilter class instead.", macos(10.5, API_TO_BE_DEPRECATED), ios(10.0, API_TO_BE_DEPRECATED), tvos(10.0, API_TO_BE_DEPRECATED))
CORE_IMAGE_EXPORT CIRAWFilterOption const kCIInputImageOrientationKey;
/** NSNumber (BOOL) : Determines if the default sharpening should be on. default = YES. Has no effect if the image used for initialization was not RAW. */
API_DEPRECATED("Use new CIRAWFilter class instead.", macos(10.5, API_TO_BE_DEPRECATED), ios(10.0, API_TO_BE_DEPRECATED), tvos(10.0, API_TO_BE_DEPRECATED))
CORE_IMAGE_EXPORT CIRAWFilterOption const kCIInputEnableSharpeningKey;
/** NSNumber (BOOL) : Determines if progressive chromatic noise tracking (based on ISO and exposure time) should be used. default = YES. Has no effect if the image used for initialization was not RAW. */
API_DEPRECATED("Use new CIRAWFilter class instead.", macos(10.5, API_TO_BE_DEPRECATED), ios(10.0, API_TO_BE_DEPRECATED), tvos(10.0, API_TO_BE_DEPRECATED))
CORE_IMAGE_EXPORT CIRAWFilterOption const kCIInputEnableChromaticNoiseTrackingKey;
/** NSNumber (double) : The amount of noise reduction applied. Range is 0 to 1. */
API_DEPRECATED("Use new CIRAWFilter class instead.", macos(10.7, API_TO_BE_DEPRECATED), ios(10.0, API_TO_BE_DEPRECATED), tvos(10.0, API_TO_BE_DEPRECATED))
CORE_IMAGE_EXPORT CIRAWFilterOption const kCIInputNoiseReductionAmountKey;
/** NSNumber (double) : The amount of moire reduction applied. Range is 0 to 1. */
API_DEPRECATED("Use new CIRAWFilter class instead.", macos(10.13, API_TO_BE_DEPRECATED), ios(11.0, API_TO_BE_DEPRECATED), tvos(11.0, API_TO_BE_DEPRECATED))
CORE_IMAGE_EXPORT CIRAWFilterOption const kCIInputMoireAmountKey;
/** NSNumber (BOOL) : Determines if the default vendor lens correction be on. default = YES if raw image used for initialization contains lens distortion parameters. */
API_DEPRECATED("Use new CIRAWFilter class instead.", macos(10.10, API_TO_BE_DEPRECATED), ios(10.0, API_TO_BE_DEPRECATED), tvos(10.0, API_TO_BE_DEPRECATED))
CORE_IMAGE_EXPORT CIRAWFilterOption const kCIInputEnableVendorLensCorrectionKey;
/** NSNumber (double) : The amount of luminance noise reduction applied. Range is 0 to 1. */
API_DEPRECATED("Use new CIRAWFilter class instead.", macos(10.10, API_TO_BE_DEPRECATED), ios(10.0, API_TO_BE_DEPRECATED), tvos(10.0, API_TO_BE_DEPRECATED))
CORE_IMAGE_EXPORT CIRAWFilterOption const kCIInputLuminanceNoiseReductionAmountKey;
/** NSNumber (double) : The amount of color noise reduction applied. Range is 0 to 1. */
API_DEPRECATED("Use new CIRAWFilter class instead.", macos(10.10, API_TO_BE_DEPRECATED), ios(10.0, API_TO_BE_DEPRECATED), tvos(10.0, API_TO_BE_DEPRECATED))
CORE_IMAGE_EXPORT CIRAWFilterOption const kCIInputColorNoiseReductionAmountKey;
/** NSNumber (double) : The amount of noise reduction sharpness applied. Range is 0 to 1. */
API_DEPRECATED("Use new CIRAWFilter class instead.", macos(10.10, API_TO_BE_DEPRECATED), ios(10.0, API_TO_BE_DEPRECATED), tvos(10.0, API_TO_BE_DEPRECATED))
CORE_IMAGE_EXPORT CIRAWFilterOption const kCIInputNoiseReductionSharpnessAmountKey;
/** NSNumber (double) : The amount of noise reduction contrast applied. Range is 0 to 1. */
API_DEPRECATED("Use new CIRAWFilter class instead.", macos(10.10, API_TO_BE_DEPRECATED), ios(10.0, API_TO_BE_DEPRECATED), tvos(10.0, API_TO_BE_DEPRECATED))
CORE_IMAGE_EXPORT CIRAWFilterOption const kCIInputNoiseReductionContrastAmountKey;
/** NSNumber (double) : The amount of noise reduction detail applied. Range is 0 to 1. */
API_DEPRECATED("Use new CIRAWFilter class instead.", macos(10.10, API_TO_BE_DEPRECATED), ios(10.0, API_TO_BE_DEPRECATED), tvos(10.0, API_TO_BE_DEPRECATED))
CORE_IMAGE_EXPORT CIRAWFilterOption const kCIInputNoiseReductionDetailAmountKey;
/** NSNumber (BOOL) : Allows the output to have an Extended Dynamic Range with values greater than 1 possible */
API_DEPRECATED("Use new CIRAWFilter class instead.", macos(10.14, API_TO_BE_DEPRECATED), ios(12.0, API_TO_BE_DEPRECATED), tvos(12.0, API_TO_BE_DEPRECATED))
CORE_IMAGE_EXPORT CIRAWFilterOption const kCIInputEnableEDRModeKey;
/** NSNumber (double): The amount of the local tone map. Range is 0 to 1. Default is 1 */
API_DEPRECATED("Use new CIRAWFilter class instead.", macos(11.1, API_TO_BE_DEPRECATED), ios(14.3, API_TO_BE_DEPRECATED), tvos(14.3, API_TO_BE_DEPRECATED))
CORE_IMAGE_EXPORT CIRAWFilterOption const kCIInputLocalToneMapAmountKey;
/** CIFilter (id) : CIFilter to be applied to the RAW image while it is in linear space. */
API_DEPRECATED("Use new CIRAWFilter class instead.", macos(10.7, API_TO_BE_DEPRECATED), ios(10.0, API_TO_BE_DEPRECATED), tvos(10.0, API_TO_BE_DEPRECATED))
CORE_IMAGE_EXPORT CIRAWFilterOption const kCIInputLinearSpaceFilter;
/** CIVector containing the full native size of the unscaled image. The vector's X value is the width, Y is the height.
This is not affected by changing either kCIInputIgnoreImageOrientationKey or kCIInputImageOrientationKey. */
API_DEPRECATED("Use new CIRAWFilter class instead.", macos(10.5, API_TO_BE_DEPRECATED), ios(10.0, API_TO_BE_DEPRECATED), tvos(10.0, API_TO_BE_DEPRECATED))
CORE_IMAGE_EXPORT CIRAWFilterOption const kCIOutputNativeSizeKey;
/** Read-only NSSet containing a list of keys that affect the output image.
Depending on the RAW decoder version (kCIInputDecoderVersionKey) and the input image type,
some input keys might have no effect. */
API_DEPRECATED("Use new CIRAWFilter class instead.", macos(10.7, API_TO_BE_DEPRECATED), ios(10.0, API_TO_BE_DEPRECATED), tvos(10.0, API_TO_BE_DEPRECATED))
CORE_IMAGE_EXPORT CIRAWFilterOption const kCIActiveKeys;
/** Read-only NSDictionary containing properties for the output image. */
API_DEPRECATED("Use new CIRAWFilter class instead.", macos(12.0, API_TO_BE_DEPRECATED), ios(15.0, API_TO_BE_DEPRECATED), tvos(15.0, API_TO_BE_DEPRECATED))
CORE_IMAGE_EXPORT CIRAWFilterOption const kCIPropertiesKey;
@end
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework/Headers/CIKernel.h | /* CoreImage - CIKernel.h
Copyright (c) 2014 Apple, Inc.
All rights reserved. */
#import <CoreImage/CoreImageDefines.h>
#import <CoreImage/CIImage.h>
#import <Foundation/Foundation.h>
NS_ASSUME_NONNULL_BEGIN
/* Block callback used by Core Image to ask what rectangles of a kernel's input images
* are needed to produce a desired rectangle of the kernel's output image.
*
* 'index' is the 0-based index specifying which of the kernel's input images is being queried.
* 'destRect' is the extent rectangle of kernel's output image being queried.
*
* Returns the rectangle of the index'th input image that is needed to produce destRect.
* Returning CGRectNull indicates that the index'th input image is not needed to produce destRect.
* The returned rectangle need not be contained by the extent of the index'th input image.
*/
typedef CGRect (^CIKernelROICallback)(int index, CGRect destRect);
@class CIImage;
/*
* CIKernel is an object that encapsulates a Core Image Kernel Language
* routine that generates a new images based on input images and agruments.
*
* General kernel functions are declared akin to this example:
* kernel vec4 myColorKernel (sampler fore, sampler back, vec4 params)
*
* The function must take a sampler argument for each input image.
* Additional arguments can be of type float, vec2, vec3, vec4, or __color.
* The destination pixel location is obtained by calling destCoord().
* The kernel should call sample() with coordinates based on either
* samplerCoord() or samplerTransform() to read pixel values from input images.
* The function must return a vec4 pixel color.
*/
NS_CLASS_AVAILABLE(10_4, 8_0)
@interface CIKernel : NSObject
{
void *_priv;
}
/* The string argument should contain a program in the Core Image Kernel Language.
* All the kernel functions in the program are converted to instances of a CIKernel objects
* and returned in an array.
* On OSX 10.10 and before, the array will contain instances of CIKernel class.
* On OSX after 10.10, the array will contain instances of CIKernel, CIColorKernel or CIWarpKernel classes.
* On iOS, the array will contain instances of CIKernel, CIColorKernel or CIWarpKernel classes.
*/
+ (nullable NSArray<CIKernel *> *)kernelsWithString:(NSString *)string CIKL_DEPRECATED(10_4,10_14, 8_0,12_0);
/* The string argument should contain a program in the Metal Language.
* All the kernel functions in the program are converted to instances of a CIKernel objects
* and returned in an array.
* The array will contain instances of CIKernel, CIColorKernel or CIWarpKernel classes.
* The kernels will only be usable on Metal-backed CIContext on a device that 'supportsDynamicLibraries'
*/
+ (nullable NSArray<CIKernel *> *)kernelsWithMetalString:(NSString *)source error:(NSError **)error NS_AVAILABLE(12_0, 15_0);
/* The string argument should contain a program with one kernel.
* On OSX 10.10 and before, this returns a CIKernel object.
* On OSX after 10.10, this returns a CIKernel, CIColorKernel, or CIWarpKernel object.
* On iOS this returns a CIKernel, CIColorKernel, or CIWarpKernel object.
*/
+ (nullable instancetype)kernelWithString:(NSString *)string CIKL_DEPRECATED(10_10,10_14, 8_0,12_0);
/* The data argument should represent a metallib file compiled with the Core Image Standard Library
* and contain the given function written in the Metal Shading Language.
*
* An optional output pixel format can be specified, and would be used if the output of the kernel
* needs to be written to an intermediate texture.
*/
+ (nullable instancetype)kernelWithFunctionName:(NSString *)name
fromMetalLibraryData:(NSData *)data
error:(NSError **)error NS_AVAILABLE(10_13, 11_0);
+ (nullable instancetype)kernelWithFunctionName:(NSString *)name
fromMetalLibraryData:(NSData *)data
outputPixelFormat:(CIFormat)format
error:(NSError **)error NS_AVAILABLE(10_13, 11_0);
// This method will return an array of strings corresponding to names of all of the kernels
// contained within the underlying Metal library in the associated NSData.
+ (NSArray<NSString *> *)kernelNamesFromMetalLibraryData:(NSData *)data NS_AVAILABLE(11_0,14_0);
/* The name of the kernel. */
@property (atomic, readonly) NSString *name NS_AVAILABLE(10_4, 8_0);
/* Sets the selector used by Core Image to ask what rectangles of a kernel's input images
* are needed to produce a desired rectangle of the kernel's output image.
*
* Using setROISelector: is suppoted but not recommended.
* The selector is only used if one the [CIFilter apply:...] methods is used.
* Instead, use one of the [CIKernel applyWithExtent:roiCallback:...] methods.
*
* The method should have one of the following signatures:
* - (CGRect)regionOf:(int)samplerIndex destRect:(CGRect)r userInfo:obj;
* - (CGRect)regionOf:(int)samplerIndex destRect:(CGRect)r;
*
* 'samplerIndex' is the 0-based index specifying which of the kernel's input images is being queried.
* 'destRect' is the extent rectangle of kernel's output image being queried.
* 'userInfo' is the object associated with the kCIApplyOptionUserInfo when the kernel was applied.
*
* The method should return the rectangle of the index'th input image that is needed to produce destRect.
* Returning CGRectNull indicates that the index'th input image is not needed to produce destRect.
*/
- (void)setROISelector:(SEL)method NS_AVAILABLE(10_4, 9_0);
/* Apply the receiver CIKernel to produce a new CIImage object.
*
* The 'extent' is the bounding box of all non-clear pixels produced by the kernel.
*
* The 'callback' is a block that should return the rectangle of each input image
* that is needed to produce a given rectangle in the coordinate space of the
* new image.
*
* The 'args' is an array of parameters needed to describe the new image.
* The object types of the items in the array correspond to the argument types of the
* kernel function. For example, if the first argument in the kernel is a sampler,
* then the first object in the array must be a CIImage.
*/
- (nullable CIImage *)applyWithExtent:(CGRect)extent
roiCallback:(CIKernelROICallback)callback
arguments:(nullable NSArray<id> *)args NS_AVAILABLE(10_11, 8_0);
@end
/*
* CIColorKernel is an object that encapsulates a Core Image Kernel Language
* routine that processes only the color information in images.
*
* Color kernel functions are declared akin to this example:
* kernel vec4 myColorKernel (__sample fore, __sample back, vec4 params)
*
* The function must take a __sample argument for each input image.
* Additional arguments can be of type float, vec2, vec3, vec4, or __color.
* The destination pixel location is obtained by calling destCoord().
* The kernel should not call sample(), samplerCoord(), or samplerTransform().
* The function must return a vec4 pixel color.
*/
NS_CLASS_AVAILABLE(10_11, 8_0)
@interface CIColorKernel : CIKernel
{
}
/* The string argument should contain a program with one color kernel.
* On iOS8 [CIColorKernel kernelWithString:] can return a CIKernel, CIColorKernel, or CIWarpKernel object.
* On iOS9 [CIColorKernel kernelWithString:] will return a CIColorKernel object or nil.
* On OS X [CIColorKernel kernelWithString:] will return a CIColorKernel object or nil.
*/
+ (nullable instancetype)kernelWithString:(NSString *)string CIKL_DEPRECATED(10_10,10_14, 8_0,12_0);
/* Apply the receiver CIColorKernel to produce a new CIImage object.
*
* The 'extent' is the bounding box of all non-clear pixels produced by the kernel.
*
* The 'args' is an array of parameters needed to describe the new image.
* The object types of the items in the array correspond to the argument types of the
* kernel function. For example, if the first argument in the kernel is a __sample,
* then the first object in the array must be a CIImage.
*/
- (nullable CIImage *)applyWithExtent:(CGRect)extent
arguments:(nullable NSArray<id> *)args;
@end
/*
* CIWarpKernel is an object that encapsulates a Core Image Kernel Language
* function that processes only the geometry of an image.
*
* Warp kernel functions are declared akin to this example:
* kernel vec2 myWarpKernel (vec4 params)
*
* Additional arguments can be of type float, vec2, vec3, vec4.
* The destination pixel location is obtained by calling destCoord().
* The kernel should not call sample(), samplerCoord(), or samplerTransform().
* The function must return a vec2 source location.
*/
NS_CLASS_AVAILABLE(10_11, 8_0)
@interface CIWarpKernel : CIKernel
{
}
/* The string argument should contain a program with one warp kernel.
* On iOS8 [CIWarpKernel kernelWithString:] can return a CIKernel, CIColorKernel, or CIWarpKernel object.
* On iOS9 [CIWarpKernel kernelWithString:] will return a CIWarpKernel object or nil.
* On OS X [CIWarpKernel kernelWithString:] will return a CIWarpKernel object or nil.
*/
+ (nullable instancetype)kernelWithString:(NSString *)string CIKL_DEPRECATED(10_10,10_14, 8_0,12_0);
/* Apply the receiver CIWarpKernel to produce a new CIImage object.
*
* The 'extent' is the bounding box of all pixel coordinates that are warped by the
* kernel to fall within the extent of 'image'.
*
* The 'image' is the input image that will be warped into a new image.
*
* The 'callback' is a block that should return the rectangle of the input image
* that is needed to produce a given rectangle in the coordinate space of the
* new image.
*
* The 'args' is an array of parameters needed to describe the warping function.
* The object types of the items in the array correspond to the argument types of the
* kernel function. For example, if the first argument in the kernel is a vec3,
* then the first object in the array must be a CIVector of count 3.
*/
- (nullable CIImage *)applyWithExtent:(CGRect)extent
roiCallback:(CIKernelROICallback)callback
inputImage:(CIImage*)image
arguments:(nullable NSArray<id> *)args;
@end
/* CIBlendKernel is a special type of color kernel that blends two images.
*
* Blend kernel functions are declared akin to this example:
* kernel vec4 myBlendKernel (__sample fore, __sample back)
*
* A blend kernel function must have exactly two arguments of type __sample.
* The first argument represents the value of the source pixel and the second
* represents that of the old destination. The vec4 returned by the kernel will
* be the new destination color.
* The kernel should not call sample(), samplerCoord(), or samplerTransform().
* The function must return a vec4 pixel color.
*/
NS_CLASS_AVAILABLE(10_13, 11_0)
@interface CIBlendKernel : CIColorKernel
{
}
/* The string argument should contain a program with one custom blend kernel. */
+ (nullable instancetype)kernelWithString:(NSString *)string CIKL_DEPRECATED(10_10,10_14, 8_0,12_0);
/* Apply the receiver CIBlendKernel to produce a new CIImage object
* by blending a foreground and background images.
*
* The 'extent' of the result image will be determined by the reciver and
* the extent of the forground and background images. For most of the
* builtin blend kernels (as well as custom blend kernels) the result image
* extent will be the union of the forground and background image
* extents.
*/
- (nullable CIImage *)applyWithForeground:(CIImage*)foreground
background:(CIImage*)background;
/* Apply the receiver CIBlendKernel to produce a new CIImage object
* by blending a foreground and background images in the specifid colorspace.
*
* The 'extent' of the result image will be determined by the reciver and
* the extent of the forground and background images. For most of the
* builtin blend kernels (as well as custom blend kernels) the result image
* extent will be the union of the forground and background image
* extents.
*/
- (nullable CIImage *)applyWithForeground:(CIImage*)foreground
background:(CIImage*)background
colorSpace:(CGColorSpaceRef)colorSpace NS_AVAILABLE(10_15, 13_0);
@end
@interface CIBlendKernel (BuiltIn)
/* Core Image builtin blend kernels */
/* Component-wise operators */
@property (class, strong, readonly) CIBlendKernel *componentAdd;
@property (class, strong, readonly) CIBlendKernel *componentMultiply;
@property (class, strong, readonly) CIBlendKernel *componentMin;
@property (class, strong, readonly) CIBlendKernel *componentMax;
/* Porter Duff
* http://dl.acm.org/citation.cfm?id=808606
*/
@property (class, strong, readonly) CIBlendKernel *clear;
@property (class, strong, readonly) CIBlendKernel *source;
@property (class, strong, readonly) CIBlendKernel *destination;
@property (class, strong, readonly) CIBlendKernel *sourceOver;
@property (class, strong, readonly) CIBlendKernel *destinationOver;
@property (class, strong, readonly) CIBlendKernel *sourceIn;
@property (class, strong, readonly) CIBlendKernel *destinationIn;
@property (class, strong, readonly) CIBlendKernel *sourceOut;
@property (class, strong, readonly) CIBlendKernel *destinationOut;
@property (class, strong, readonly) CIBlendKernel *sourceAtop;
@property (class, strong, readonly) CIBlendKernel *destinationAtop;
@property (class, strong, readonly) CIBlendKernel *exclusiveOr;
/* PDF 1.7 blend modes
* http://wwwimages.adobe.com/content/dam/Adobe/en/devnet/pdf/pdfs/PDF32000_2008.pdf
*/
/* Standard separable blend modes */
@property (class, strong, readonly) CIBlendKernel *multiply;
@property (class, strong, readonly) CIBlendKernel *screen;
@property (class, strong, readonly) CIBlendKernel *overlay;
@property (class, strong, readonly) CIBlendKernel *darken;
@property (class, strong, readonly) CIBlendKernel *lighten;
@property (class, strong, readonly) CIBlendKernel *colorDodge;
@property (class, strong, readonly) CIBlendKernel *colorBurn;
@property (class, strong, readonly) CIBlendKernel *hardLight;
@property (class, strong, readonly) CIBlendKernel *softLight;
@property (class, strong, readonly) CIBlendKernel *difference;
@property (class, strong, readonly) CIBlendKernel *exclusion;
/* Standard nonseparable blend modes */
@property (class, strong, readonly) CIBlendKernel *hue;
@property (class, strong, readonly) CIBlendKernel *saturation;
@property (class, strong, readonly) CIBlendKernel *color;
@property (class, strong, readonly) CIBlendKernel *luminosity;
/* Additional blend modes */
@property (class, strong, readonly) CIBlendKernel *subtract;
@property (class, strong, readonly) CIBlendKernel *divide;
@property (class, strong, readonly) CIBlendKernel *linearBurn;
@property (class, strong, readonly) CIBlendKernel *linearDodge;
@property (class, strong, readonly) CIBlendKernel *vividLight;
@property (class, strong, readonly) CIBlendKernel *linearLight;
@property (class, strong, readonly) CIBlendKernel *pinLight;
@property (class, strong, readonly) CIBlendKernel *hardMix;
@property (class, strong, readonly) CIBlendKernel *darkerColor;
@property (class, strong, readonly) CIBlendKernel *lighterColor;
@end
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework/Headers/CIRenderDestination.h | /*
CoreImage - CIRenderDestination.h
Copyright (c) 2017 Apple, Inc.
All rights reserved.
*/
#import <Foundation/Foundation.h>
#import <CoreImage/CoreImageDefines.h>
#import <CoreImage/CIImage.h>
#import <CoreImage/CIContext.h>
#import <CoreImage/CIKernel.h>
#import <CoreVideo/CoreVideo.h>
#if COREIMAGE_SUPPORTS_IOSURFACE
#import <IOSurface/IOSurfaceObjC.h>
#endif
#import <Metal/MTLPixelFormat.h>
@protocol MTLTexture, MTLCommandBuffer;
NS_ASSUME_NONNULL_BEGIN
// This is a lightweight API to allow clients to specify all the
// attributes of a render that pertain to the render's destination.
// It is intended to be used for issuing renders that return to the
// caller as soon as all the work has been issued but before it completes/
//
NS_CLASS_AVAILABLE(10_13, 11_0)
@interface CIRenderDestination : NSObject
{
void *_priv;
}
// MARK: PixelBuffer destinations
// Create a CIRenderDestination based on a CVPixelBufferRef object.
//
// The destination's 'colorspace' property will default a CGColorSpace created by,
// querying the CVPixelBufferRef attributes.
//
- (instancetype) initWithPixelBuffer:(CVPixelBufferRef)pixelBuffer;
// MARK: Surface destinations
#if COREIMAGE_SUPPORTS_IOSURFACE
// Create a CIRenderDestination based on an IOSurface object.
//
// The destination's 'colorspace' property will default a CGColorSpace created by,
// querying the IOSurface attributes.
//
- (instancetype) initWithIOSurface:(IOSurface*)surface;
#endif
// MARK: Metal destinations
// A render to a MTLTexture-backed CIRenderDestination is only supported by MTLTexture-backed CIContexts.
// The texture must have a MTLTextureType of MTLTextureType2D
//
// An optional MTLCommandBuffer can be specified, with which to use for rendering to the MTLTexture.
// NOTE: Rendering to a texture initialized with a commandBuffer requires encoding all the commands to render an image into the specified buffer.
// This may impact system responsiveness and may result in higher memory usage if the image requires many passes to render.
// To avoid this impact, it is recommended to create a context using [CIContext contextWithMTLCommandQueue:] and create the CIRenderDestination without specifying a buffer.
//
// The destination's 'colorspace' property will default a CGColorSpace created with kCGColorSpaceSRGB,
// kCGColorSpaceExtendedSRGB, or kCGColorSpaceGenericGrayGamma2_2.
//
- (instancetype) initWithMTLTexture:(id<MTLTexture>)texture
commandBuffer:(nullable id<MTLCommandBuffer>)commandBuffer;
// Create a CIRenderDestination based on a Metal texture.
//
// Rendering to a MTLTexture-backed CIRenderDestination is only supported by MTLTexture-backed CIContexts.
// The provider 'block' will be called lazily when the destination is rendered to.
// The block must return a texture with a MTLTextureType of MTLTextureType2D.
// The 'width', 'height' and 'pixelFormat' argument values should be the same as the
// width, height and pixelFormat of the MTLTexture that will be returned by 'block'
//
// An optional MTLCommandBuffer can be specified, with which to use for rendering to the MTLTexture.
// NOTE: Rendering to a texture initialized with a commandBuffer requires encoding all the commands to render an image into the specified buffer.
// This may impact system responsiveness and may result in higher memory usage if the image requires many passes to render.
// To avoid this impact, it is recommended to create a context using [CIContext contextWithMTLCommandQueue:] and create the CIRenderDestination without specifying a buffer.
//
// The destination's 'colorspace' property will default a CGColorSpace created with kCGColorSpaceSRGB,
// kCGColorSpaceExtendedSRGB, or kCGColorSpaceGenericGrayGamma2_2.
//
- (instancetype) initWithWidth:(NSUInteger)width
height:(NSUInteger)height
pixelFormat:(MTLPixelFormat)pixelFormat
commandBuffer:(nullable id<MTLCommandBuffer>)commandBuffer
mtlTextureProvider:(nullable id<MTLTexture> (^)(void))block;
// MARK: OpenGL destination
// Create a CIRenderDestination based on an OpenGL texture.
//
// Rendering to a GLTexture-backed CIRenderDestination is only supported by GLContext-backed CIContexts.
// The texture id must be bound to a GLContext that is shared with that of the GLContext-backed CIContext.
//
// The destination's 'colorspace' property will default a CGColorSpace created with kCGColorSpaceSRGB,
// kCGColorSpaceExtendedSRGB, or kCGColorSpaceGenericGrayGamma2_2.
//
- (instancetype) initWithGLTexture:(unsigned int)texture
target:(unsigned int)target // GL_TEXTURE_2D or GL_TEXTURE_RECTANGLE_EXT
width:(NSUInteger)width
height:(NSUInteger)height;
// MARK: Bitmap data destination
// Create a CIRenderDestination based on client-managed buffer.
//
// The 'data' parameter must point to a buffer that is at least bytesPerRow * height bytes in size.
//
// The destination's 'colorspace' property will default a CGColorSpace created with kCGColorSpaceSRGB,
// kCGColorSpaceExtendedSRGB, or kCGColorSpaceGenericGrayGamma2_2.
- (instancetype) initWithBitmapData:(void *)data
width:(NSUInteger)width
height:(NSUInteger)height
bytesPerRow:(NSUInteger)bytesPerRow
format:(CIFormat)format;
// MARK: Properties
@property (readonly) NSUInteger width;
@property (readonly) NSUInteger height;
typedef NS_ENUM(NSUInteger, CIRenderDestinationAlphaMode) {
CIRenderDestinationAlphaNone = 0,
CIRenderDestinationAlphaPremultiplied = 1,
CIRenderDestinationAlphaUnpremultiplied = 2
};
// This property will defualt to an appropriate value given
// the object that the CIRenderDestination was initialized with.
// This property can be set to a different value if desired.
@property CIRenderDestinationAlphaMode alphaMode;
// The logical coordinate system of a CIRenderDestination is always cartesian:
// (0,0) represents the lower-left corner
// (0.5,0.5) represents the lower-left pixel center
// (pixelsWide-0.5,pixelsHigh-0.5) represents the upper-right pixel center
// (pixelsWide,pixelsHigh) represents the upper-right corner.
//
// The 'flipped' property controls how pixels this logical coordinate system
// are stored into the memory of the object backing the destination.
//
// If 'flipped' is false, then the base address of the backing stores the
// pixel centered on the logical coordinate (0.5,0.5)
//
// If 'flipped' is true, then the base address of the backing stores the
// pixel centered on the logical coordinate (0.5,height-0.5)
//
@property (getter=isFlipped) BOOL flipped;
// Instructs the render to add pseudo-random luma noise given the depth of the destination.
// The magnitude of the noise is approximatly ±pow(2,-(bitPerComponent+1))
@property (getter=isDithered) BOOL dithered;
// If true, the render will clamp color channels
// to 0..alpha if 'alphaMode' is premultiplied otherwise 0..1
// This property is initialized to false if the destination's format supports extended range
@property (getter=isClamped) BOOL clamped;
// This property will defualt to an appropriate value given
// the object that the CIRenderDestination was initialized with.
// This property can be set to a different colorSpace if desired.
// This property can be set to nil to disable color matching
// from the working space to the destination.
@property (nullable, nonatomic) CGColorSpaceRef colorSpace;
// Allow client to specify a CIBlendKernel (e.g. CIBlendKernel.sourceOver)
// to be used on the destination.
@property (nullable, nonatomic, retain) CIBlendKernel* blendKernel;
// If true, then the blendKernel is applied in the destination's colorSpace.
// If false, then the blendKernel is applied in the CIContext's working colorspace.
// This is false by default.
@property BOOL blendsInDestinationColorSpace;
@end
// An Xcode quicklook of this object will show a graph visualization of the render
// with detailed timing information.
NS_CLASS_AVAILABLE(10_13, 11_0)
@interface CIRenderInfo : NSObject
{
void *_priv;
}
// This property will return how much time a render spent executing kernels.
@property (readonly) NSTimeInterval kernelExecutionTime;
// This property will return how many passes the render requires.
// If passCount is 1 than the render can be fully concatinated and no
// intermediate buffers will be required.
@property (readonly) NSInteger passCount;
// This property will return how many pixels a render produced executing kernels.
@property (readonly) NSInteger pixelsProcessed;
@end
// An Xcode quicklook of this object will show a graph visualization of the render
NS_CLASS_AVAILABLE(10_13, 11_0)
@interface CIRenderTask : NSObject
{
void *_priv;
}
- (nullable CIRenderInfo*) waitUntilCompletedAndReturnError:(NSError**)error;
@end
@interface CIContext (CIRenderDestination)
// Renders a portion of image to a point of destination
// It renders as if 'image' is cropped to 'fromRect'
// and the origin of the result is placed at 'atPoint'
//
// If image.extent and fromRect are infinite, then it renders
// so that point (0,0) of image is placed at 'atPoint'
//
// MTLTexture-backed CIRenderDestinations are only supported by MTLTexture-backed CIContexts.
// GLTexture-backed CIRenderDestinations are only supported by GLContext-backed CIContexts.
//
// For contexts that are initialized with a command queue, this call will return as soon as all the work for the render is enqueued on the
// context's device.
// Otherwise, it will return as soon as all the work is scheduled.
//
// In many situations, after issuing a render, the client can use the destination
// or its backing object without waiting for the enqueued work to complete.
// For example, after rendering a surface CIRenderDestination, the surface can be passed
// on for further processing by the GPU.
//
// In other situations, the client may need to wait for the render to be complete.
// For example, after rendering a surface CIRenderDestination, the surface can be accessed
// by CPU code by calling IOSurfaceGetBytePointer only after the render is completed.
//
// In this case the client can use the returned CIRenderTask like this:
// CIRenderTask* task = [context render:...];
// [task waitUntilCompletedAndReturnError:&error];
//
- (nullable CIRenderTask*) startTaskToRender:(CIImage*)image
fromRect:(CGRect)fromRect
toDestination:(CIRenderDestination*)destination
atPoint:(CGPoint)atPoint
error:(NSError**)error NS_AVAILABLE(10_13, 11_0);
// Renders an image to a destination so that point (0,0) of image.
// is placed at point (0,0) of the destination.
//
- (nullable CIRenderTask*) startTaskToRender:(CIImage*)image
toDestination:(CIRenderDestination*)destination
error:(NSError**)error NS_AVAILABLE(10_13, 11_0);
// This is an optional call which can be used to "warm up" a CIContext so that
// a subsequent call to render with the same arguments can be more efficient.
// By making this call, Core Image will ensure that
// - any needed kernels will be compiled
// - any intermedate buffers are allocated and marked volatile
//
- (BOOL) prepareRender:(CIImage*)image
fromRect:(CGRect)fromRect
toDestination:(CIRenderDestination*)destination
atPoint:(CGPoint)atPoint
error:(NSError**)error NS_AVAILABLE(10_13, 11_0);
// Fill the entire destination with black (0,0,0,1) if its alphaMode is None
// or clear (0,0,0,0) if its alphaMode is Premultiplied or Unpremultiplied.
//
- (nullable CIRenderTask*) startTaskToClear:(CIRenderDestination*)destination
error:(NSError**)error NS_AVAILABLE(10_13, 11_0);
@end
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework/Headers/CIPlugIn.h | //
// CIPlugIn.h
//
//
// Created on Fri May 14 2004.
// Copyright (c) 2004 Apple Computer. All rights reserved.
//
#import <Foundation/Foundation.h>
#if TARGET_OS_OSX
#import <CoreImage/CIPlugInInterface.h>
#import <CoreImage/CoreImageDefines.h>
/**
The CIPlugIn class is responsible for loading Image Units.
The implementation of the CIPlugIn objects is private.
An application can, however, call the 2 public class method to load plug-ins.
Loading executable CIFilter plugins is deprecated starting in macOS 10.15.
*/
NS_CLASS_AVAILABLE_MAC(10_4)
@interface CIPlugIn : NSObject {
void *_priv[8];
}
/** This call will scan for plugins with the extension .plugin in
/Library/Graphics/Image Units
~Library/Graphics/Image Units
If called more than once, newly added plug-ins will be loaded but you cannot remove a plug-in and its filters. */
+ (void)loadAllPlugIns NS_DEPRECATED_MAC(10_4, 10_15);
/** Same as loadAllPlugIns does not load filters that contain executable code. */
+ (void)loadNonExecutablePlugIns;
/** Loads a plug-in specified by its URL. */
+ (void)loadPlugIn:(NSURL *)url allowNonExecutable:(BOOL)allowNonExecutable NS_DEPRECATED_MAC(10_4, 10_7);
/** Loads a plug-in specified by its URL.
If allowExecutableCode is NO, filters containing executable code will not be loaded. If YES, any kind of filter will be loaded. */
+ (void)loadPlugIn:(NSURL *)url allowExecutableCode:(BOOL)allowExecutableCode NS_DEPRECATED_MAC(10_7, 10_15);
/** Loads a non-executable plug-in specified by its URL.
If the filters containing executable code, it will not be loaded. */
+ (void)loadNonExecutablePlugIn:(NSURL *)url NS_AVAILABLE_MAC(10_15);
@end
#endif
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework/Headers/CIFilterConstructor.h | /* CoreImage - CIFilterConstructor.h
Copyright (c) 2014 Apple, Inc.
All rights reserved. */
@class NSString;
@class CIFilter;
// Used by +[CIFilter registerFilterName:constructor:classAttributes:]
NS_ASSUME_NONNULL_BEGIN
@protocol CIFilterConstructor
- (nullable CIFilter *)filterWithName:(NSString *)name;
@end
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework/Headers/CIDetector.h | /* CoreImage - CIDetector.h
Copyright (c) 2011 Apple, Inc.
All rights reserved. */
#import <CoreImage/CoreImageDefines.h>
#import <Foundation/Foundation.h>
NS_ASSUME_NONNULL_BEGIN
@class CIImage;
@class CIContext;
@class CIFeature;
/** Detects features in images.
This class potentially holds onto a lot of state. Hence it may be beneficial from a performance perspective to re-use the same CIDetector instance. Specifying a CIContext when creating a detector may have an impact on performance since this context may be used when analyzing an image.
*/
NS_CLASS_AVAILABLE(10_7, 5_0)
@interface CIDetector : NSObject {}
/** Returns a new detector instance of the given type.
The type is used to specify the detection intent.
This will return value if the detector type is not supported.
The context argument specifies the CIContext to be used to operate on the image. May be nil.
If the input image to -featuresInImage: is the output of a CoreImage operation, it may improve performance to specify the same context that was used to operate on that image.
The detector may do image processing in this context and if the image is on the GPU and the specified context is a GPU context this may avoid additional upload to / download from the GPU. If the input image is on the CPU (or the output from a CPU based context) specifying a GPU based context (or vice versa) may reduce performance.
The options parameter lets you optinally specify a accuracy / performance tradeoff. Can be nil or an empty dictionary. */
+ (nullable CIDetector *)detectorOfType:(NSString*)type
context:(nullable CIContext *)context
options:(nullable NSDictionary<NSString *,id> *)options
NS_AVAILABLE(10_7, 5_0);
/** Returns an array of CIFeature instances in the given image.
The array is sorted by confidence, highest confidence first. */
- (NSArray<CIFeature *> *)featuresInImage:(CIImage *)image
NS_AVAILABLE(10_7, 5_0);
/** Returns an array of CIFeature instances in the given image.
The array is sorted by confidence, highest confidence first.
The options dictionary can contain a CIDetectorImageOrientation key value. */
- (NSArray<CIFeature *> *)featuresInImage:(CIImage *)image
options:(nullable NSDictionary<NSString *,id> *)options
NS_AVAILABLE(10_8, 5_0);
@end
// Types to be used for +[CIDetector detectorOfType:context:options:]
/* Specifies a detector type for face recognition. */
CORE_IMAGE_EXPORT NSString* const CIDetectorTypeFace NS_AVAILABLE(10_7, 5_0);
/* Specifies a detector type for rectangle detection. */
CORE_IMAGE_EXPORT NSString* const CIDetectorTypeRectangle NS_AVAILABLE(10_10, 8_0);
/* Specifies a detector type for barcode detection. */
CORE_IMAGE_EXPORT NSString* const CIDetectorTypeQRCode NS_AVAILABLE(10_10, 8_0);
/* Specifies a detector type for text detection. */
#if __OBJC2__
CORE_IMAGE_EXPORT NSString* const CIDetectorTypeText NS_AVAILABLE(10_11, 9_0);
#endif
// Options that can be used with +[CIDetector detectorOfType:context:options:]
/* The key in the options dictionary used to specify a accuracy / performance tradeoff to be used. */
CORE_IMAGE_EXPORT NSString* const CIDetectorAccuracy NS_AVAILABLE(10_7, 5_0);
/* These are values to be used with the CIDetectorAccuracy key when created a CIDetector.
There is a performance / accuracy tradeoff to be made. The default value will work well for most
situations, but using these the detector will favour performance over accuracy or
accuracy over performance. */
CORE_IMAGE_EXPORT NSString* const CIDetectorAccuracyLow NS_AVAILABLE(10_7, 5_0); /* Lower accuracy, higher performance */
CORE_IMAGE_EXPORT NSString* const CIDetectorAccuracyHigh NS_AVAILABLE(10_7, 5_0); /* Lower performance, higher accuracy */
/*The key in the options dictionary used to specify that feature tracking should be used. */
CORE_IMAGE_EXPORT NSString* const CIDetectorTracking NS_AVAILABLE(10_8, 6_0);
/* The key in the options dictionary used to specify the minimum size that the
detector will recognize as a feature. */
/* For face detector, the value for this key is an float NSNumber
from 0.0 ... 1.0 that represents a percentage of shorter edge of an input image.
valid values range: 0.01 <= CIDetectorMinFeatureSize <= 0.5.
Setting a higher value for this parameter is used for performance gain only. The default value is 0.15. */
/* For rectangle detector, the value for this key is an float NSNumber
from 0.0 ... 1.0 that represents a percentage of shorter edge of an input image.
valid values range: 0.2 <= CIDetectorMinFeatureSize <= 1.0 The default value is 0.2. */
/* For text detector, the value for this key is an float NSNumber
from 0.0 ... 1.0 that represents a percentage of height of an input image.
valid values range: 0.0 <= CIDetectorMinFeatureSize <= 1.0. The default value is 10/(height of input image). */
CORE_IMAGE_EXPORT NSString* const CIDetectorMinFeatureSize NS_AVAILABLE(10_8, 6_0);
/* For rectangle detector, the value for this key is an integer NSNumber
from 1 ... 256 that represents the maximum number of features to return.
valid value range: 1 <= CIDetectorMaxFeatureCount <= 256. The default value is 1.
*/
CORE_IMAGE_EXPORT NSString* const CIDetectorMaxFeatureCount NS_AVAILABLE(10_12, 10_0);
/* The key in the options dictionary used to specify number of angles, the value for this key is one of 1, 3, 5, 7, 9, 11.*/
CORE_IMAGE_EXPORT NSString* const CIDetectorNumberOfAngles NS_AVAILABLE(10_11, 9_0);
// Options that can be used with -[CIDetector featuresInImage:options:]
/* The value for this key is an integer NSNumber from 1..8 such as that
found in kCGImagePropertyOrientation. If present, the detection will be done
based on that orientation but the coordinates in the returned features will
still be based on those of the image. */
CORE_IMAGE_EXPORT NSString *const CIDetectorImageOrientation NS_AVAILABLE(10_8, 5_0);
/* The value for this key is a bool NSNumber. If true, facial expressions, such as blinking and closed eyes are extracted */
CORE_IMAGE_EXPORT NSString *const CIDetectorEyeBlink NS_AVAILABLE(10_9, 7_0);
/* The value for this key is a bool NSNumber. If true, facial expressions, such as smile are extracted */
CORE_IMAGE_EXPORT NSString *const CIDetectorSmile NS_AVAILABLE(10_9, 7_0);
/* The value for this key is a float NSNumber. Specifies the per frame focal length. */
CORE_IMAGE_EXPORT NSString* const CIDetectorFocalLength NS_AVAILABLE(10_10, 8_0);
/* The value for this key is a float NSNumber. Specifies the aspect ratio of the rectangle detected. */
CORE_IMAGE_EXPORT NSString* const CIDetectorAspectRatio NS_AVAILABLE(10_10, 8_0);
#if __OBJC2__
/* The value for this key is a bool NSNumber. Controls whether the text detector should detect subfeatures or not. The default value is NO */
CORE_IMAGE_EXPORT NSString* const CIDetectorReturnSubFeatures __OSX_AVAILABLE_STARTING(__MAC_10_11, __IPHONE_9_0);
#endif
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework/Headers/CIColor.h | /*
CoreImage - CIColor.h
Copyright (c) 2015 Apple, Inc.
All rights reserved.
*/
#import <CoreImage/CoreImageDefines.h>
#import <Foundation/Foundation.h>
#import <CoreImage/CIVector.h>
NS_ASSUME_NONNULL_BEGIN
NS_CLASS_AVAILABLE(10_4, 5_0)
@interface CIColor : NSObject <NSSecureCoding, NSCopying>
{
void *_priv;
void *_pad[3];
}
/* Create a new color object. */
+ (instancetype)colorWithCGColor:(CGColorRef)c;
/* Create a new color object in CI's default RGB colorspace
which is kCGColorSpaceSRGB or, if running on OSX before 10.10,
kCGColorSpaceGenericRGB. */
+ (instancetype)colorWithRed:(CGFloat)r green:(CGFloat)g blue:(CGFloat)b alpha:(CGFloat)a;
+ (instancetype)colorWithRed:(CGFloat)r green:(CGFloat)g blue:(CGFloat)b;
/* Create a new color object in a given colorspace.
* Will return null if the colorspace is not kCGColorSpaceModelRGB. */
+ (nullable instancetype)colorWithRed:(CGFloat)r green:(CGFloat)g blue:(CGFloat)b alpha:(CGFloat)a colorSpace:(CGColorSpaceRef)colorSpace NS_AVAILABLE(10_12, 10_0);
+ (nullable instancetype)colorWithRed:(CGFloat)r green:(CGFloat)g blue:(CGFloat)b colorSpace:(CGColorSpaceRef)colorSpace NS_AVAILABLE(10_12, 10_0);
/* Create a new color object, 'representation' should be a string in one of
* the formats returned by the stringRepresentation method. */
+ (instancetype)colorWithString:(NSString *)representation;
/* Initialize a new color object. */
- (instancetype)initWithCGColor:(CGColorRef)c NS_DESIGNATED_INITIALIZER;
/* Initialize a new color object in CI's default RGB colorspace
which is kCGColorSpaceSRGB or, if running on OSX before 10.10,
kCGColorSpaceGenericRGB. */
- (instancetype)initWithRed:(CGFloat)r green:(CGFloat)g blue:(CGFloat)b alpha:(CGFloat)a;
- (instancetype)initWithRed:(CGFloat)r green:(CGFloat)g blue:(CGFloat)b NS_AVAILABLE(10_11, 9_0);
/* Initialize a new color object in a given colorspace.
* Will return null if the colorspace is not kCGColorSpaceModelRGB. */
- (nullable instancetype)initWithRed:(CGFloat)r green:(CGFloat)g blue:(CGFloat)b alpha:(CGFloat)a colorSpace:(CGColorSpaceRef)colorSpace NS_AVAILABLE(10_12, 10_0);
- (nullable instancetype)initWithRed:(CGFloat)r green:(CGFloat)g blue:(CGFloat)b colorSpace:(CGColorSpaceRef)colorSpace NS_AVAILABLE(10_12, 10_0);
/* Return the number of color components (including alpha). */
@property (readonly) size_t numberOfComponents;
/* Return the color components (including alpha). */
@property (readonly) const CGFloat *components NS_RETURNS_INNER_POINTER;
/* Return the alpha value of the color. */
@property (readonly) CGFloat alpha;
/* Return the color space object associated with the color. */
@property (readonly) CGColorSpaceRef colorSpace CF_RETURNS_NOT_RETAINED;
/* Return the (unpremultiplied) red, green or blue components of the color. */
@property (readonly) CGFloat red;
@property (readonly) CGFloat green;
@property (readonly) CGFloat blue;
/* Returns a formatted string with the components of the color.
* The string is suitable for passing to [CIColor colorWithString:].
* This property is not KVO-safe because it returns a new NSString each time.
* The value of the NSString will be the same each time it is called. */
@property (readonly) NSString *stringRepresentation;
/* Convenience constant CIColors in the sRGB colorspace. */
@property (class, strong, readonly) CIColor *blackColor NS_AVAILABLE(10_12, 10_0);
@property (class, strong, readonly) CIColor *whiteColor NS_AVAILABLE(10_12, 10_0);
@property (class, strong, readonly) CIColor *grayColor NS_AVAILABLE(10_12, 10_0);
@property (class, strong, readonly) CIColor *redColor NS_AVAILABLE(10_12, 10_0);
@property (class, strong, readonly) CIColor *greenColor NS_AVAILABLE(10_12, 10_0);
@property (class, strong, readonly) CIColor *blueColor NS_AVAILABLE(10_12, 10_0);
@property (class, strong, readonly) CIColor *cyanColor NS_AVAILABLE(10_12, 10_0);
@property (class, strong, readonly) CIColor *magentaColor NS_AVAILABLE(10_12, 10_0);
@property (class, strong, readonly) CIColor *yellowColor NS_AVAILABLE(10_12, 10_0);
@property (class, strong, readonly) CIColor *clearColor NS_AVAILABLE(10_12, 10_0);
@end
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework/Headers/CIBarcodeDescriptor.h | /* CoreImage - CIBarcodeDescriptor.h
Copyright (c) 2017 Apple, Inc.
All rights reserved. */
#import <CoreImage/CoreImageDefines.h>
#import <Foundation/Foundation.h>
NS_ASSUME_NONNULL_BEGIN
/*!
@class CIBarcodeDescriptor
@abstract
CIBarcodeDescriptor is an abstract base class that defines an abstract representation of a machine readable code's symbol attributes.
@discsussion
Each subclass is sufficient to recreate the symbol exactly as seen or to be used with a custom parser. Subclasses of CIBarcodeDescriptor are defined for each code type to contain the formal specification of each symbology.
*/
NS_CLASS_AVAILABLE(10_13, 11_0)
@interface CIBarcodeDescriptor : NSObject <NSSecureCoding, NSCopying>
@end
/*!
@enum CIQRCodeErrorCorrectionLevel
@abstract
Constants indicating the percentage of the symbol that is dedicated to error correction.
@constant CIQRCodeErrorCorrectionLevelL
Indicates that approximately 20% of the symbol data is dedicated to error correction.
@constant CIQRCodeErrorCorrectionLevelM
Indicates that approximately 37% of the symbol data is dedicated to error correction.
@constant CIQRCodeErrorCorrectionLevelQ
Indicates that approximately 55% of the symbol data is dedicated to error correction.
@constant CIQRCodeErrorCorrectionLevelH
Indicates that approximately 65% of the symbol data is dedicated to error correction.
*/
typedef CF_ENUM(NSInteger, CIQRCodeErrorCorrectionLevel)
{
CIQRCodeErrorCorrectionLevelL NS_SWIFT_NAME(levelL) = 'L',
CIQRCodeErrorCorrectionLevelM NS_SWIFT_NAME(levelM) = 'M',
CIQRCodeErrorCorrectionLevelQ NS_SWIFT_NAME(levelQ) = 'Q',
CIQRCodeErrorCorrectionLevelH NS_SWIFT_NAME(levelH) = 'H',
} NS_SWIFT_NAME(CIQRCodeDescriptor.ErrorCorrectionLevel);
/*!
@class CIQRCodeDescriptor
@abstract
CIQRCodeDescriptor is a concrete subclass of CIBarcodeDescriptor that defines an abstract representation of a QR code symbol.
*/
NS_CLASS_AVAILABLE(10_13, 11_0)
@interface CIQRCodeDescriptor : CIBarcodeDescriptor
{
NSData *errorCorrectedPayload;
NSInteger symbolVersion;
uint8_t maskPattern;
CIQRCodeErrorCorrectionLevel errorCorrectionLevel;
}
/*!
@property errorCorrectedPayload
@abstract
The error-corrected codewords that comprise the QR code symbol.
@discussion
QR Codes are formally specified in ISO/IEC 18004:2006(E). Section 6.4.10 "Bitstream to codeword conversion" specifies the set of 8-bit codewords in the symbol immediately prior to splitting the message into blocks and applying error correction.
During decode, error correction is applied and if successful, the message is re-ordered to the state immediately following "Bitstream to codeword coversion." The errorCorrectedPayload corresponds to this sequence of 8-bit codewords.
*/
@property (readonly) NSData *errorCorrectedPayload;
/*!
@property symbolVersion
@abstract
The version property corresponds to the size of the QR Code.
@discussion
QR Codes are square. ISO/IEC 18004 defines versions from 1 to 40, where a higher symbol version indicates a larger data carrying capacity. This field is required in order to properly interpret the error corrected payload.
*/
@property (readonly) NSInteger symbolVersion;
/*!
@property maskPattern
@abstract
The data mask pattern for the QR code symbol.
@discussion
QR Codes support eight data mask patterns, which are used to avoid large black or large white areas inside the symbol body. Valid values range from 0 to 7.
*/
@property (readonly) uint8_t maskPattern;
/*!
@property errorCorrectionLevel
@abstract
The error correction level of the QR code.
@discussion
QR Codes support four levels of Reed-Solomon error correction, in increasing error correction capability: L, M, Q, and H.
*/
@property (readonly) CIQRCodeErrorCorrectionLevel errorCorrectionLevel;
// Initializes a descriptor that can be used as input to CIBarcodeGenerator
- (nullable instancetype)initWithPayload:(NSData *)errorCorrectedPayload
symbolVersion:(NSInteger)symbolVersion
maskPattern:(uint8_t)maskPattern
errorCorrectionLevel:(CIQRCodeErrorCorrectionLevel)errorCorrectionLevel;
// Construct an autoreleased descriptor that can be used as input to CIBarcodeGenerator
+ (nullable instancetype)descriptorWithPayload:(NSData *)errorCorrectedPayload
symbolVersion:(NSInteger)symbolVersion
maskPattern:(uint8_t)maskPattern
errorCorrectionLevel:(CIQRCodeErrorCorrectionLevel)errorCorrectionLevel;
@end
/*!
@class CIAztecCodeDescriptor
@abstract
CIAztecCodeDescriptor is a concrete subclass of CIBarcodeDescriptor that defines an abstract representation of an Aztec Code symbol.
@discussion
CIAztecCodeDescriptor may not be instantiated directly.
*/
NS_CLASS_AVAILABLE(10_13, 11_0)
@interface CIAztecCodeDescriptor : CIBarcodeDescriptor
{
NSData *errorCorrectedPayload;
BOOL isCompact;
NSInteger layerCount;
NSInteger dataCodewordCount;
}
/*!
@property errorCorrectedPayload
@abstract
The error-corrected codewords that comprise the Aztec code symbol.
@discussion
Aztec Codes are formally specified in ISO/IEC 24778:2008(E).
The error corrected payload consists of the 6-, 8-, 10-, or 12-bit message codewords produced at the end of the step described in section 7.3.1.2 "Formation of data codewords", which exists immediately prior to adding error correction. These codewords have dummy bits inserted to ensure that an entire codeword isn't all 0's or all 1's. Clients will need to remove these extra bits as part of interpreting the payload.
*/
@property (readonly) NSData *errorCorrectedPayload;
/*!
@property isCompact
@abstract
A BOOL indicating whether the symbol is compact.
@discussion
Compact Aztec symbols use one-fewer ring in the central finder pattern than full-range Aztec symbols of the same number of data layers.
*/
@property (readonly) BOOL isCompact;
/*!
@property layerCount
@abstract
The number of data layers in the Aztec code symbol.
@discussion
Combined with the isCompact property, the number of data layers determines the number of modules in the Aztec Code symbol. Valid values range from 1 to 32. Compact symbols can have up to 4 data layers.
The number of data layers also determines the number of bits in each data codeword of the message carried by the Aztec Code symbol.
*/
@property (readonly) NSInteger layerCount;
/*!
@property dataCodewordCount
@abstract
The number of non-error-correction codewords carried by the Aztec code symbol.
@discussion
Used to determine the level of error correction in conjunction with the number of data layers. Valid values are 1...2048. Compact symbols can have up to 64 message codewords.
Note that this value can exceed the number of message codewords allowed by the number of data layers in this symbol. In this case, the actual number of message codewords is 1024 fewer than this value and the message payload is to be interpreted in an application-defined manner.
*/
@property (readonly) NSInteger dataCodewordCount;
// Initializes a descriptor that can be used as input to CIBarcodeGenerator
- (nullable instancetype)initWithPayload:(NSData *)errorCorrectedPayload
isCompact:(BOOL)isCompact
layerCount:(NSInteger)layerCount
dataCodewordCount:(NSInteger)dataCodewordCount;
// Construct an autoreleased descriptor that can be used as input to CIBarcodeGenerator
+ (nullable instancetype)descriptorWithPayload:(NSData *)errorCorrectedPayload
isCompact:(BOOL)isCompact
layerCount:(NSInteger)layerCount
dataCodewordCount:(NSInteger)dataCodewordCount;
@end
/*!
@class CIPDF417CodeDescriptor
@abstract
CIPDF417CodeDescriptor is a concrete subclass of CIBarcodeDescriptor that defines an abstract representation of a PDF417 code symbol.
@discussion
Refer to the ISO/IEC 15438:2006(E) for the PDF417 symbol specification.
*/
NS_CLASS_AVAILABLE(10_13, 11_0)
@interface CIPDF417CodeDescriptor : CIBarcodeDescriptor
{
NSData *errorCorrectedPayload;
BOOL isCompact;
NSInteger rowCount;
NSInteger columnCount;
}
/*!
@property errorCorrectedPayload
@abstract
The error-corrected codewords which comprise the PDF417 symbol. The first codeword indicates the number of data codewords in the errorCorrectedPayload.
@discussion
PDF417 codes are comprised of a start character on the left and a stop character on the right. Each row begins and ends with special characters indicating the current row as well as information about the dimensions of the PDF417 symbol. The errorCorrectedPayload represents the sequence of PDF417 codewords that make up the body of the message. The first codeword indicates the number of codewords in the message. This count includes the "count" codeword and any padding codewords, but does not include the error correction codewords. Each codeword is a 16-bit value in the range of 0...928. The sequence is to be interpreted as described in the PDF417 bar code symbology specification -- ISO/IEC 15438:2006(E).
*/
@property(readonly) NSData *errorCorrectedPayload;
/*!
@property isCompact
@abstract
A BOOL indicating whether the symbol is compact.
@discussion
Compact PDF417 symbols have abbreviated right-side guard bars.
*/
@property (readonly) BOOL isCompact;
/*!
@property rowCount
@abstract
Indicates the number of rows in the rectangular matrix.
@discussion
rowCount values range from 3 to 90.
*/
@property (readonly) NSInteger rowCount;
/*!
@property columnCount
@abstract
Indicates the number of columns in the rectangular matrix, excluding the columns used to indicate the symbol structure.
@discussion
columnCount values range from 1 to 30.
*/
@property (readonly) NSInteger columnCount;
// Initializes a descriptor that can be used as input to CIBarcodeGenerator
- (nullable instancetype)initWithPayload:(NSData *)errorCorrectedPayload
isCompact:(BOOL)isCompact
rowCount:(NSInteger)rowCount
columnCount:(NSInteger)columnCount;
// Construct an autoreleased descriptor that can be used as input to CIBarcodeGenerator
+ (nullable instancetype)descriptorWithPayload:(NSData *)errorCorrectedPayload
isCompact:(BOOL)isCompact
rowCount:(NSInteger)rowCount
columnCount:(NSInteger)columnCount;
@end
/*!
@enum CIDataMatrixCodeECCVersion
@abstract
Constants indicating the Data Matrix code ECC version.
@discussion
ECC 000 - 140 symbols offer five levels of error correction using convolutional code error correction. Each successive level of error correction offers more protection for the message data and increases the size of the symbol required to carry a specific message. ECC 000 symbols offer no data protection. The other modes are described in ISO/IEC 16022:2006 and enumerated in this list only for completeness.
ECC 200 symbols utilize Reed-Solomon error correction. The error correction capacity for any given Data Matrix symbol is fixed by the size (in rows and columns) of the symbol. See Table 7 of ISO/IEC 16022:2006(E) for more details.
@constant CIDataMatrixCodeECCVersion000
Indicates error correction using convolutional code error correction with no data protection.
@constant CIDataMatrixCodeECCVersion050
Indicates 1/4 of the symbol is dedicated to convolutional code error correction.
@constant CIDataMatrixCodeECCVersion080
Indicates 1/3 of the symbol is dedicated to convolutional code error correction.
@constant CIDataMatrixCodeECCVersion100
Indicates 1/2 of the symbol is dedicated to convolutional code error correction.
@constant CIDataMatrixCodeECCVersion140
Indicates 3/4 of the symbol is dedicated to convolutional code error correction.
@constant CIDataMatrixCodeECCVersion200
Indicates error correction using Reed-Solomon error correction. Data protection overhead varies based on symbol size.
*/
typedef CF_ENUM(NSInteger, CIDataMatrixCodeECCVersion)
{
CIDataMatrixCodeECCVersion000 NS_SWIFT_NAME(v000) = 0,
CIDataMatrixCodeECCVersion050 NS_SWIFT_NAME(v050) = 50,
CIDataMatrixCodeECCVersion080 NS_SWIFT_NAME(v080) = 80,
CIDataMatrixCodeECCVersion100 NS_SWIFT_NAME(v100) = 100,
CIDataMatrixCodeECCVersion140 NS_SWIFT_NAME(v140) = 140,
CIDataMatrixCodeECCVersion200 NS_SWIFT_NAME(v200) = 200,
} NS_SWIFT_NAME(CIDataMatrixCodeDescriptor.ECCVersion);
/*!
@class CIDataMatrixCodeDescriptor
@abstract
CIDataMatrixCodeDescriptor is a concrete subclass of CIBarcodeDescriptor that defines an abstract representation of a Data Matrix code symbol.
*/
NS_CLASS_AVAILABLE(10_13, 11_0)
@interface CIDataMatrixCodeDescriptor : CIBarcodeDescriptor
{
NSData *errorCorrectedPayload;
NSInteger rowCount;
NSInteger columnCount;
CIDataMatrixCodeECCVersion eccVersion;
}
/*!
@property errorCorrectedPayload
@abstract
The error corrected payload that comprise the Data Matrix code symbol.
@discussion
DataMatrix symbols are specified bn ISO/IEC 16022:2006(E). ECC 200-type symbols will always have an even number of rows and columns.
For ECC 200-type symbols, the phases of encoding data into a symbol are described in section 5.1 -- Encode procedure overview. The error corrected payload comprises the de-interleaved bits of the message described at the end of Step 1: Data encodation.
*/
@property (readonly) NSData *errorCorrectedPayload;
/*!
@property rowCount
@abstract
The number of module rows.
@discussion
Refer to ISO/IEC 16022:2006(E) for valid module row and column count combinations.
*/
@property (readonly) NSInteger rowCount;
/*!
@property columnCount
@abstract
The number of module columns.
@discussion
Refer to ISO/IEC 16022:2006(E) for valid module row and column count combinations.
*/
@property (readonly) NSInteger columnCount;
/*!
@property eccVersion
@abstract
The Data Matrix code ECC version.
@discussion
Valid values are 000, 050, 080, 100, 140, and 200. Any symbol with an even number of rows and columns will be ECC 200.
*/
@property (readonly) CIDataMatrixCodeECCVersion eccVersion;
// Initializes a descriptor that can be used as input to CIBarcodeGenerator
- (nullable instancetype)initWithPayload:(NSData *)errorCorrectedPayload
rowCount:(NSInteger)rowCount
columnCount:(NSInteger)columnCount
eccVersion:(CIDataMatrixCodeECCVersion)eccVersion;
// Construct an autoreleased descriptor that can be used as input to CIBarcodeGenerator
+ (nullable instancetype)descriptorWithPayload:(NSData *)errorCorrectedPayload
rowCount:(NSInteger)rowCount
columnCount:(NSInteger)columnCount
eccVersion:(CIDataMatrixCodeECCVersion)eccVersion;
@end
/*!
@extension NSUserActivity
@abstract
A NSUserActivity extension for passing detected barcodes.
*/
#if __OBJC2__
@class NSUserActivity;
@interface NSUserActivity (CIBarcodeDescriptor)
/*!
@abstract The scanned code in the user activity passed in by system scanner.
*/
@property (nonatomic, nullable, readonly, copy) CIBarcodeDescriptor *detectedBarcodeDescriptor API_AVAILABLE(macos(10.13.4), ios(11.3), tvos(11.3));
@end
#endif // __OBJC2__
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework/Headers/CISampler.h | /*
CoreImage - CISampler.h
Copyright (c) 2015 Apple, Inc.
All rights reserved.
*/
#import <CoreImage/CoreImageDefines.h>
#import <Foundation/Foundation.h>
NS_ASSUME_NONNULL_BEGIN
@class CIFilterShape, CIImage;
NS_CLASS_AVAILABLE(10_4, 9_0)
@interface CISampler : NSObject <NSCopying>
{
void *_priv;
}
/* Creates a new sampler object refencing 'im'. */
+ (instancetype)samplerWithImage:(CIImage *)im;
/* Creates a new sampler object from 'im' specifying key/value option
* pairs. Each key is an NSString. Supported keys include:
*
* kCISamplerAffineMatrix: An NSArray [a b c d tx ty] defining the
* transformation to be applied to the sampler.
*
* kCISamplerWrapMode: An NSString defining how pixels outside the
* sampler's extent are produced. Options include kCISamplerWrapBlack
* (pixels are transparent black, the default) and kCISamplerWrapClamp
* (coordinates are clamped to the extent).
*
* kCISamplerFilterMode: An NSString defining the filter to use when
* sampling the image. One of kCISamplerFilterNearest (point sampling)
* or kCISamplerFilterLinear (bilinear interpolation, the default).
*/
+ (instancetype)samplerWithImage:(CIImage *)im keysAndValues:key0, ... NS_REQUIRES_NIL_TERMINATION;
+ (instancetype)samplerWithImage:(CIImage *)im options:(nullable NSDictionary *)dict;
/* Initializers. */
- (instancetype)initWithImage:(CIImage *)im;
- (instancetype)initWithImage:(CIImage *)im keysAndValues:key0, ...;
- (instancetype)initWithImage:(CIImage *)im options:(nullable NSDictionary *)dict NS_DESIGNATED_INITIALIZER;
/* Returns the shape containing the Domain Of Definition (DOD) of the
* sampler. The DOD is defined such that it contains all non-transparent
* pixels produced by referencing the sampler.
* This property is KVO-safe
*/
@property (readonly) CIFilterShape * definition;
/* Returns the extent of the sampler. Sampling outside the extent will
* bring the sampler's wrap mode into action.
*/
@property (readonly) CGRect extent;
@end
/* Sampler options. */
CORE_IMAGE_EXPORT NSString *const kCISamplerAffineMatrix NS_AVAILABLE(10_4, 9_0);
CORE_IMAGE_EXPORT NSString *const kCISamplerWrapMode NS_AVAILABLE(10_4, 9_0);
CORE_IMAGE_EXPORT NSString *const kCISamplerFilterMode NS_AVAILABLE(10_4, 9_0);
CORE_IMAGE_EXPORT NSString *const kCISamplerWrapBlack NS_AVAILABLE(10_4, 9_0);
CORE_IMAGE_EXPORT NSString *const kCISamplerWrapClamp NS_AVAILABLE(10_4, 9_0);
CORE_IMAGE_EXPORT NSString *const kCISamplerFilterNearest NS_AVAILABLE(10_4, 9_0);
CORE_IMAGE_EXPORT NSString *const kCISamplerFilterLinear NS_AVAILABLE(10_4, 9_0);
/* If used, the value of the kCISamplerColorSpace key be must be an RGB CGColorSpaceRef.
* Using this option specifies that samples should be converted to this color space before being passed to a kernel.
* If not specified, samples will be passed to the kernel in the working color space of the rendering CIContext. */
CORE_IMAGE_EXPORT NSString *const kCISamplerColorSpace NS_AVAILABLE(10_4, 9_0);
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework/Headers/CIKernelMetalLib.h | //
// Extensions to Metal Shading Language for Core Image Kernels
//
// Copyright (c) 2017 Apple, Inc. All rights reserved.
//
#if __METAL_VERSION__
#ifndef CIKERNELMETALLIB_H
#define CIKERNELMETALLIB_H
#ifndef __CIKERNEL_METAL_VERSION__ // if not explicitly defined already
#if !defined(__ENVIRONMENT_MAC_OS_X_VERSION_MIN_REQUIRED__) && \
!defined(__ENVIRONMENT_IPHONE_OS_VERSION_MIN_REQUIRED__) && \
!defined(__ENVIRONMENT_TV_OS_VERSION_MIN_REQUIRED__)
#define __CIKERNEL_METAL_VERSION__ 200 // the includer of this didn't specify a MIN_REQUIRED compatibility
#elif (__ENVIRONMENT_MAC_OS_X_VERSION_MIN_REQUIRED__ >= 120000 || \
__ENVIRONMENT_IPHONE_OS_VERSION_MIN_REQUIRED__ >= 150000 || \
__ENVIRONMENT_TV_OS_VERSION_MIN_REQUIRED__ >= 150000)
#if __METAL_CIKERNEL__
#define __CIKERNEL_METAL_VERSION__ 200
#else
#define __CIKERNEL_METAL_VERSION__ 300
#endif
#elif (__ENVIRONMENT_MAC_OS_X_VERSION_MIN_REQUIRED__ >= 101400 || \
__ENVIRONMENT_IPHONE_OS_VERSION_MIN_REQUIRED__ >= 120000 || \
__ENVIRONMENT_TV_OS_VERSION_MIN_REQUIRED__ >= 120000)
#define __CIKERNEL_METAL_VERSION__ 200 // compatible w/ macOS 10.14/iOS 12.0/tvOS 12.0 or later
#else
#define __CIKERNEL_METAL_VERSION__ 100 // compatible w/ macOS 10.13/iOS 11.0/tvOS 11.0 or later
#endif
#endif
#include <metal_stdlib>
namespace coreimage
{
using namespace metal;
typedef float4 sample_t;
#if __CIKERNEL_METAL_VERSION__ >= 200
typedef half4 sample_h;
#endif
//MARK: - Sampler
#if __CIKERNEL_METAL_VERSION__ >= 300
typedef struct Sampler
{
friend Sampler make_sampler(texture2d<float, access::sample> t, metal::sampler s, constant float4x4& m, float2 dc );
private:
Sampler(texture2d<float, access::sample> t_, metal::sampler s_, constant float4x4& m_, float2 dc_):t(t_), s(s_),m(m_), dc(dc_){}
public:
#else
typedef struct
{
#endif
// Returns the pixel value produced from sampler at the position p, where p is specified in sampler space.
float4 sample(float2 p) const;
// Returns the position in the coordinate space of the source that is associated with the position defined in working-space coordinates.
float2 transform(float2 p) const;
// Returns the position, in sampler space, of the sampler that is associated with the current output pixel (that is, after any transformation matrix
// associated with sampler is applied). The sample space refers to the coordinate space of that you are texturing from. Note that if your source data is tiled,
// the sample coordinate will have an offset (dx/dy). You can convert a destination location to the sampler location using the transform function.
float2 coord() const;
// Returns the extent of the sampler in world coordinates, as a four-element vector [x, y, width, height].
float4 extent() const;
inline float2 origin() const { return extent().xy; }
inline float2 size() const { return extent().zw; }
#if __CIKERNEL_METAL_VERSION__ >= 200
// Returns four samples (placed in CCW order starting with sample to the lower left) that would be used for bilinear interpolation when sampling at the position p,
// where p is specified in sampler space.
float4 gatherX(float2 p) const;
float4 gatherY(float2 p) const;
float4 gatherZ(float2 p) const;
float4 gatherW(float2 p) const;
// Returns four (unordered) samples that would be used for bilinear interpolation when sampling at the position p, where p is specified in sampler space.
float4 gatherX_unordered(float2 p) const;
float4 gatherY_unordered(float2 p) const;
float4 gatherZ_unordered(float2 p) const;
float4 gatherW_unordered(float2 p) const;
#endif
private:
texture2d<float, access::sample> t;
metal::sampler s;
constant float4x4& m;
float2 dc;
} sampler;
#if __CIKERNEL_METAL_VERSION__ >= 200
#if __CIKERNEL_METAL_VERSION__ >= 300
typedef struct Sampler_h
{
friend Sampler_h make_sampler_h(texture2d<half, access::sample> t, metal::sampler s, constant float4x4& m, float2 dc );
private:
Sampler_h(texture2d<half, access::sample> t_, metal::sampler s_, constant float4x4& m_, float2 dc_):t(t_), s(s_),m(m_), dc(dc_){}
public:
#else
typedef struct
{
#endif //__CIKERNEL_METAL_VERSION__ >= 300
// Returns the pixel value produced from sampler at the position p, where p is specified in sampler space.
half4 sample(float2 p) const;
// Returns the position in the coordinate space of the source that is associated with the position defined in working-space coordinates.
float2 transform(float2 p) const;
// Returns the position, in sampler space, of the sampler that is associated with the current output pixel (that is, after any transformation matrix
// associated with sampler is applied). The sample space refers to the coordinate space of that you are texturing from. Note that if your source data is tiled,
// the sample coordinate will have an offset (dx/dy). You can convert a destination location to the sampler location using the transform function.
float2 coord() const;
// Returns the extent of the sampler in world coordinates, as a four-element vector [x, y, width, height].
float4 extent() const;
inline float2 origin() const { return extent().xy; }
inline float2 size() const { return extent().zw; }
// Returns four samples (placed in CCW order starting with sample to the lower left) that would be used for bilinear interpolation when sampling at the position p,
// where p is specified in sampler space.
half4 gatherX(float2 p) const;
half4 gatherY(float2 p) const;
half4 gatherZ(float2 p) const;
half4 gatherW(float2 p) const;
// Returns four (unordered) samples that would be used for bilinear interpolation when sampling at the position p, where p is specified in sampler space.
half4 gatherX_unordered(float2 p) const;
half4 gatherY_unordered(float2 p) const;
half4 gatherZ_unordered(float2 p) const;
half4 gatherW_unordered(float2 p) const;
private:
texture2d<half, access::sample> t;
metal::sampler s;
constant float4x4& m;
float2 dc;
} sampler_h;
#endif
// Global equivalents of sampler struct member functions, to facilitate porting of non-Metal legacy CI kernels.
// Equivalent to src.sample(p)
float4 sample (sampler src, float2 p);
// Equivalent to src.transform(p)
float2 samplerTransform (sampler src, float2 p);
// Equivalent to src.coord()
float2 samplerCoord (sampler src);
// Equivalent to src.extent()
float4 samplerExtent (sampler src);
// Equivalent to src.origin()
float2 samplerOrigin (sampler src);
// Equivalent to src.size()
float2 samplerSize (sampler src);
//MARK: - Destination
typedef struct
{
// Returns the position, in working space coordinates, of the pixel currently being computed.
// The destination space refers to the coordinate space of the image you are rendering.
inline float2 coord() const { return c; }
private:
float2 c;
} destination;
#if __CIKERNEL_METAL_VERSION__ >= 200
namespace group
{
typedef struct
{
// Returns the position, in working space coordinates, of the pixel currently being computed.
// The destination space refers to the coordinate space of the image you are rendering.
inline float2 coord() const { return c; }
// Writes 4 color values to the destination texture for the current 2x2 group of pixels.
void write(float4 v0, float4 v1, float4 v2, float4 v3);
private:
float2 c;
uint2 gid;
float4 r;
float4x4 m;
texture2d<float, access::write> t;
} __attribute__((packed)) destination;
typedef struct
{
// Returns the position, in working space coordinates, of the pixel currently being computed.
// The destination space refers to the coordinate space of the image you are rendering.
inline float2 coord() const { return c; }
// Writes 4 color values to the destination texture for the current 2x2 group of pixels.
void write(half4 v0, half4 v1, half4 v2, half4 v3);
private:
float2 c;
uint2 gid;
float4 r;
float4x4 m;
texture2d<half, access::write> t;
} __attribute__((packed)) destination_h;
}
#endif
//MARK: - Common Functions
float4 premultiply(float4 s);
float4 unpremultiply(float4 s);
float3 srgb_to_linear(float3 s);
float3 linear_to_srgb(float3 s);
#if __CIKERNEL_METAL_VERSION__ >= 200
half4 premultiply(half4 s);
half4 unpremultiply(half4 s);
half3 srgb_to_linear(half3 s);
half3 linear_to_srgb(half3 s);
#endif
//MARK: - Relational Functions
// for each component, returns x < 0 ? y : z
float compare(float x, float y, float z);
float2 compare(float2 x, float2 y, float2 z);
float3 compare(float3 x, float3 y, float3 z);
float4 compare(float4 x, float4 y, float4 z);
#if __CIKERNEL_METAL_VERSION__ >= 200
half compare(half x, half y, half z);
half2 compare(half2 x, half2 y, half2 z);
half3 compare(half3 x, half3 y, half3 z);
half4 compare(half4 x, half4 y, half4 z);
#endif
//MARK: - Math Functions
float2 cossin(float x);
float2 sincos(float x);
}
namespace ci = coreimage;
#endif /* CIKERNELMETALLIB_H */
#endif /* __METAL_VERSION__ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework/Headers/CIPlugInInterface.h | /*
* CIPlugInInterface.h
*
*
* Copyright (c) 2004 Apple Computer. All rights reserved.
*
*/
#if TARGET_OS_OSX
/*!
@header CIPlugInInterface
@abstract Definition of the plug-in registration protocol
@discussion The principal class of a CIPlugIn must support the CIPlugInRegistration protocol
*/
/*!
@protocol CIPlugInRegistration
@abstract This protocol defines the calls made by the host to the CIPlugIn when initializing it
@discussion The principal class of a CIPlugIn must support the CIPlugInRegistration protocol
*/
@protocol CIPlugInRegistration
/*!
@method load
@abstract the plugin gets a chance to do custom initialization (like registration check ) here
@discussion Load gets called once by the host when the first filter from the plug-in gets instantiated. Return of true means that the plugIn successfully initialized
@param host for future use only
*/
- (BOOL)load:(void *)host;
@end
#endif
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework/Headers/CIFilterBuiltins.h |
#if TARGET_OS_OSX || TARGET_OS_IOS || TARGET_OS_TV
#import <CoreImage/CIFilter.h>
@class CIVector;
@class CIColor;
@class CIBarcodeDescriptor;
@class MLModel;
NS_ASSUME_NONNULL_BEGIN
// CICategoryGradient
@protocol CIGaussianGradient <CIFilter>
@property (nonatomic) CGPoint center;
@property (nonatomic, retain) CIColor *color0;
@property (nonatomic, retain) CIColor *color1;
@property (nonatomic) float radius;
@end
@protocol CIHueSaturationValueGradient <CIFilter>
@property (nonatomic) float value;
@property (nonatomic) float radius;
@property (nonatomic) float softness;
@property (nonatomic) float dither;
@property (nonatomic, nullable) CGColorSpaceRef colorSpace;
@end
@protocol CILinearGradient <CIFilter>
@property (nonatomic) CGPoint point0;
@property (nonatomic) CGPoint point1;
@property (nonatomic, retain) CIColor *color0;
@property (nonatomic, retain) CIColor *color1;
@end
@protocol CIRadialGradient <CIFilter>
@property (nonatomic) CGPoint center;
@property (nonatomic) float radius0;
@property (nonatomic) float radius1;
@property (nonatomic, retain) CIColor *color0;
@property (nonatomic, retain) CIColor *color1;
@end
@protocol CISmoothLinearGradient <CIFilter>
@property (nonatomic) CGPoint point0;
@property (nonatomic) CGPoint point1;
@property (nonatomic, retain) CIColor *color0;
@property (nonatomic, retain) CIColor *color1;
@end
// CICategorySharpen
@protocol CISharpenLuminance <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) float sharpness;
@property (nonatomic) float radius;
@end
@protocol CIUnsharpMask <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) float radius;
@property (nonatomic) float intensity;
@end
// CICategoryHalftoneEffect
@protocol CICircularScreen <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) CGPoint center;
@property (nonatomic) float width;
@property (nonatomic) float sharpness;
@end
@protocol CICMYKHalftone <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) CGPoint center;
@property (nonatomic) float width;
@property (nonatomic) float angle;
@property (nonatomic) float sharpness;
@property (nonatomic) float grayComponentReplacement;
@property (nonatomic) float underColorRemoval;
@end
@protocol CIDotScreen <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) CGPoint center;
@property (nonatomic) float angle;
@property (nonatomic) float width;
@property (nonatomic) float sharpness;
@end
@protocol CIHatchedScreen <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) CGPoint center;
@property (nonatomic) float angle;
@property (nonatomic) float width;
@property (nonatomic) float sharpness;
@end
@protocol CILineScreen <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) CGPoint center;
@property (nonatomic) float angle;
@property (nonatomic) float width;
@property (nonatomic) float sharpness;
@end
// CICategoryGeometryAdjustment
@protocol CIFourCoordinateGeometryFilter <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) CGPoint topLeft;
@property (nonatomic) CGPoint topRight;
@property (nonatomic) CGPoint bottomRight;
@property (nonatomic) CGPoint bottomLeft;
@end
@protocol CIBicubicScaleTransform <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) float scale;
@property (nonatomic) float aspectRatio;
@property (nonatomic) float parameterB;
@property (nonatomic) float parameterC;
@end
@protocol CIEdgePreserveUpsample <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic, retain, nullable) CIImage *smallImage;
@property (nonatomic) float spatialSigma;
@property (nonatomic) float lumaSigma;
@end
@protocol CIKeystoneCorrectionCombined <CIFourCoordinateGeometryFilter>
@property (nonatomic) float focalLength;
@end
@protocol CIKeystoneCorrectionHorizontal <CIFourCoordinateGeometryFilter>
@property (nonatomic) float focalLength;
@end
@protocol CIKeystoneCorrectionVertical <CIFourCoordinateGeometryFilter>
@property (nonatomic) float focalLength;
@end
@protocol CILanczosScaleTransform <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) float scale;
@property (nonatomic) float aspectRatio;
@end
@protocol CIPerspectiveCorrection <CIFourCoordinateGeometryFilter>
@property (nonatomic) bool crop;
@end
@protocol CIPerspectiveRotate <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) float focalLength;
@property (nonatomic) float pitch;
@property (nonatomic) float yaw;
@property (nonatomic) float roll;
@end
@protocol CIPerspectiveTransform <CIFourCoordinateGeometryFilter>
@end
@protocol CIPerspectiveTransformWithExtent <CIFourCoordinateGeometryFilter>
@property (nonatomic) CGRect extent;
@end
@protocol CIStraighten <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) float angle;
@end
// CICategoryTransition
@protocol CITransitionFilter <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic, retain, nullable) CIImage *targetImage;
@property (nonatomic) float time;
@end
@protocol CIAccordionFoldTransition <CITransitionFilter>
@property (nonatomic) float bottomHeight;
@property (nonatomic) float numberOfFolds;
@property (nonatomic) float foldShadowAmount;
@end
@protocol CIBarsSwipeTransition <CITransitionFilter>
@property (nonatomic) float angle;
@property (nonatomic) float width;
@property (nonatomic) float barOffset;
@end
@protocol CICopyMachineTransition <CITransitionFilter>
@property (nonatomic) CGRect extent;
@property (nonatomic, retain) CIColor *color;
@property (nonatomic) float angle;
@property (nonatomic) float width;
@property (nonatomic) float opacity;
@end
@protocol CIDisintegrateWithMaskTransition <CITransitionFilter>
@property (nonatomic, retain, nullable) CIImage *maskImage;
@property (nonatomic) float shadowRadius;
@property (nonatomic) float shadowDensity;
@property (nonatomic) CGPoint shadowOffset;
@end
@protocol CIDissolveTransition <CITransitionFilter>
@end
@protocol CIFlashTransition <CITransitionFilter>
@property (nonatomic) CGPoint center;
@property (nonatomic) CGRect extent;
@property (nonatomic, retain) CIColor *color;
@property (nonatomic) float maxStriationRadius;
@property (nonatomic) float striationStrength;
@property (nonatomic) float striationContrast;
@property (nonatomic) float fadeThreshold;
@end
@protocol CIModTransition <CITransitionFilter>
@property (nonatomic) CGPoint center;
@property (nonatomic) float angle;
@property (nonatomic) float radius;
@property (nonatomic) float compression;
@end
@protocol CIPageCurlTransition <CITransitionFilter>
@property (nonatomic, retain, nullable) CIImage *backsideImage;
@property (nonatomic, retain, nullable) CIImage *shadingImage;
@property (nonatomic) CGRect extent;
@property (nonatomic) float angle;
@property (nonatomic) float radius;
@end
@protocol CIPageCurlWithShadowTransition <CITransitionFilter>
@property (nonatomic, retain, nullable) CIImage *backsideImage;
@property (nonatomic) CGRect extent;
@property (nonatomic) float angle;
@property (nonatomic) float radius;
@property (nonatomic) float shadowSize;
@property (nonatomic) float shadowAmount;
@property (nonatomic) CGRect shadowExtent;
@end
@protocol CIRippleTransition <CITransitionFilter>
@property (nonatomic, retain, nullable) CIImage *shadingImage;
@property (nonatomic) CGPoint center;
@property (nonatomic) CGRect extent;
@property (nonatomic) float width;
@property (nonatomic) float scale;
@end
@protocol CISwipeTransition <CITransitionFilter>
@property (nonatomic) CGRect extent;
@property (nonatomic, retain) CIColor *color;
@property (nonatomic) float angle;
@property (nonatomic) float width;
@property (nonatomic) float opacity;
@end
// CICategoryCompositeOperation
@protocol CICompositeOperation <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic, retain, nullable) CIImage *backgroundImage;
@end
// CICategoryColorAdjustment
@protocol CIColorAbsoluteDifference <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic, retain, nullable) CIImage *inputImage2;
@end
@protocol CIColorClamp <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic, retain) CIVector *minComponents;
@property (nonatomic, retain) CIVector *maxComponents;
@end
@protocol CIColorControls <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) float saturation;
@property (nonatomic) float brightness;
@property (nonatomic) float contrast;
@end
@protocol CIColorMatrix <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic, retain) CIVector *RVector;
@property (nonatomic, retain) CIVector *GVector;
@property (nonatomic, retain) CIVector *BVector;
@property (nonatomic, retain) CIVector *AVector;
@property (nonatomic, retain) CIVector *biasVector;
@end
@protocol CIColorPolynomial <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic, retain) CIVector *redCoefficients;
@property (nonatomic, retain) CIVector *greenCoefficients;
@property (nonatomic, retain) CIVector *blueCoefficients;
@property (nonatomic, retain) CIVector *alphaCoefficients;
@end
@protocol CIColorThreshold <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) float threshold;
@end
@protocol CIColorThresholdOtsu <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@end
@protocol CIDepthToDisparity <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@end
@protocol CIDisparityToDepth <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@end
@protocol CIExposureAdjust <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) float EV;
@end
@protocol CIGammaAdjust <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) float power;
@end
@protocol CIHueAdjust <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) float angle;
@end
@protocol CILinearToSRGBToneCurve <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@end
@protocol CISRGBToneCurveToLinear <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@end
@protocol CITemperatureAndTint <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic, retain) CIVector *neutral;
@property (nonatomic, retain) CIVector *targetNeutral;
@end
@protocol CIToneCurve <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) CGPoint point0;
@property (nonatomic) CGPoint point1;
@property (nonatomic) CGPoint point2;
@property (nonatomic) CGPoint point3;
@property (nonatomic) CGPoint point4;
@end
@protocol CIVibrance <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) float amount;
@end
@protocol CIWhitePointAdjust <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic, retain) CIColor *color;
@end
// CICategoryColorEffect
@protocol CIColorCrossPolynomial <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic, retain) CIVector *redCoefficients;
@property (nonatomic, retain) CIVector *greenCoefficients;
@property (nonatomic, retain) CIVector *blueCoefficients;
@end
@protocol CIColorCube <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) float cubeDimension;
@property (nonatomic, retain) NSData *cubeData;
@end
@protocol CIColorCubesMixedWithMask <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic, retain, nullable) CIImage *maskImage;
@property (nonatomic) float cubeDimension;
@property (nonatomic, retain) NSData *cube0Data;
@property (nonatomic, retain) NSData *cube1Data;
@property (nonatomic, nullable) CGColorSpaceRef colorSpace;
@end
@protocol CIColorCubeWithColorSpace <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) float cubeDimension;
@property (nonatomic, retain) NSData *cubeData;
@property (nonatomic, nullable) CGColorSpaceRef colorSpace;
@end
@protocol CIColorCurves <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic, retain) NSData *curvesData;
@property (nonatomic, retain) CIVector *curvesDomain;
@property (nonatomic, nullable) CGColorSpaceRef colorSpace;
@end
@protocol CIColorInvert <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@end
@protocol CIColorMap <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic, retain, nullable) CIImage *gradientImage;
@end
@protocol CIColorMonochrome <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic, retain) CIColor *color;
@property (nonatomic) float intensity;
@end
@protocol CIColorPosterize <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) float levels;
@end
@protocol CIDither <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) float intensity;
@end
@protocol CIDocumentEnhancer <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) float amount;
@end
@protocol CIFalseColor <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic, retain) CIColor *color0;
@property (nonatomic, retain) CIColor *color1;
@end
@protocol CILabDeltaE <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic, retain, nullable) CIImage *image2;
@end
@protocol CIMaskToAlpha <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@end
@protocol CIMaximumComponent <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@end
@protocol CIMinimumComponent <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@end
@protocol CIPaletteCentroid <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic, retain, nullable) CIImage *paletteImage;
@property (nonatomic) bool perceptual;
@end
@protocol CIPalettize <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic, retain, nullable) CIImage *paletteImage;
@property (nonatomic) bool perceptual;
@end
@protocol CIPhotoEffect <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@end
@protocol CISepiaTone <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) float intensity;
@end
@protocol CIThermal <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@end
@protocol CIVignette <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) float intensity;
@property (nonatomic) float radius;
@end
@protocol CIVignetteEffect <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) CGPoint center;
@property (nonatomic) float radius;
@property (nonatomic) float intensity;
@property (nonatomic) float falloff;
@end
@protocol CIXRay <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@end
// CICategoryDistortionEffect
@protocol CIBumpDistortion <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) CGPoint center;
@property (nonatomic) float radius;
@property (nonatomic) float scale;
@end
@protocol CIBumpDistortionLinear <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) CGPoint center;
@property (nonatomic) float radius;
@property (nonatomic) float angle;
@property (nonatomic) float scale;
@end
@protocol CICircleSplashDistortion <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) CGPoint center;
@property (nonatomic) float radius;
@end
@protocol CICircularWrap <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) CGPoint center;
@property (nonatomic) float radius;
@property (nonatomic) float angle;
@end
@protocol CIDisplacementDistortion <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic, retain, nullable) CIImage *displacementImage;
@property (nonatomic) float scale;
@end
@protocol CIDroste <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) CGPoint insetPoint0;
@property (nonatomic) CGPoint insetPoint1;
@property (nonatomic) float strands;
@property (nonatomic) float periodicity;
@property (nonatomic) float rotation;
@property (nonatomic) float zoom;
@end
@protocol CIGlassDistortion <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic, retain, nullable) CIImage *textureImage;
@property (nonatomic) CGPoint center;
@property (nonatomic) float scale;
@end
@protocol CIGlassLozenge <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) CGPoint point0;
@property (nonatomic) CGPoint point1;
@property (nonatomic) float radius;
@property (nonatomic) float refraction;
@end
@protocol CIHoleDistortion <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) CGPoint center;
@property (nonatomic) float radius;
@end
@protocol CILightTunnel <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) CGPoint center;
@property (nonatomic) float rotation;
@property (nonatomic) float radius;
@end
@protocol CINinePartStretched <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) CGPoint breakpoint0;
@property (nonatomic) CGPoint breakpoint1;
@property (nonatomic) CGPoint growAmount;
@end
@protocol CINinePartTiled <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) CGPoint breakpoint0;
@property (nonatomic) CGPoint breakpoint1;
@property (nonatomic) CGPoint growAmount;
@property (nonatomic) bool flipYTiles;
@end
@protocol CIPinchDistortion <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) CGPoint center;
@property (nonatomic) float radius;
@property (nonatomic) float scale;
@end
@protocol CIStretchCrop <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) CGPoint size;
@property (nonatomic) float cropAmount;
@property (nonatomic) float centerStretchAmount;
@end
@protocol CITorusLensDistortion <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) CGPoint center;
@property (nonatomic) float radius;
@property (nonatomic) float width;
@property (nonatomic) float refraction;
@end
@protocol CITwirlDistortion <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) CGPoint center;
@property (nonatomic) float radius;
@property (nonatomic) float angle;
@end
@protocol CIVortexDistortion <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) CGPoint center;
@property (nonatomic) float radius;
@property (nonatomic) float angle;
@end
// CICategoryTileEffect
@protocol CIAffineClamp <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) CGAffineTransform transform;
@end
@protocol CIAffineTile <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) CGAffineTransform transform;
@end
@protocol CIEightfoldReflectedTile <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) CGPoint center;
@property (nonatomic) float angle;
@property (nonatomic) float width;
@end
@protocol CIFourfoldReflectedTile <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) CGPoint center;
@property (nonatomic) float angle;
@property (nonatomic) float width;
@property (nonatomic) float acuteAngle;
@end
@protocol CIFourfoldRotatedTile <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) CGPoint center;
@property (nonatomic) float angle;
@property (nonatomic) float width;
@end
@protocol CIFourfoldTranslatedTile <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) CGPoint center;
@property (nonatomic) float angle;
@property (nonatomic) float width;
@property (nonatomic) float acuteAngle;
@end
@protocol CIGlideReflectedTile <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) CGPoint center;
@property (nonatomic) float angle;
@property (nonatomic) float width;
@end
@protocol CIKaleidoscope <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) NSInteger count;
@property (nonatomic) CGPoint center;
@property (nonatomic) float angle;
@end
@protocol CIOpTile <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) CGPoint center;
@property (nonatomic) float scale;
@property (nonatomic) float angle;
@property (nonatomic) float width;
@end
@protocol CIParallelogramTile <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) CGPoint center;
@property (nonatomic) float angle;
@property (nonatomic) float acuteAngle;
@property (nonatomic) float width;
@end
@protocol CIPerspectiveTile <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) CGPoint topLeft;
@property (nonatomic) CGPoint topRight;
@property (nonatomic) CGPoint bottomRight;
@property (nonatomic) CGPoint bottomLeft;
@end
@protocol CISixfoldReflectedTile <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) CGPoint center;
@property (nonatomic) float angle;
@property (nonatomic) float width;
@end
@protocol CISixfoldRotatedTile <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) CGPoint center;
@property (nonatomic) float angle;
@property (nonatomic) float width;
@end
@protocol CITriangleKaleidoscope <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) CGPoint point;
@property (nonatomic) float size;
@property (nonatomic) float rotation;
@property (nonatomic) float decay;
@end
@protocol CITriangleTile <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) CGPoint center;
@property (nonatomic) float angle;
@property (nonatomic) float width;
@end
@protocol CITwelvefoldReflectedTile <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) CGPoint center;
@property (nonatomic) float angle;
@property (nonatomic) float width;
@end
// CICategoryGenerator
@protocol CIAttributedTextImageGenerator <CIFilter>
@property (nonatomic, retain) NSAttributedString *text;
@property (nonatomic) float scaleFactor;
@end
@protocol CIAztecCodeGenerator <CIFilter>
@property (nonatomic, retain) NSData *message;
@property (nonatomic) float correctionLevel;
@property (nonatomic) float layers;
@property (nonatomic) float compactStyle;
@end
@protocol CIBarcodeGenerator <CIFilter>
@property (nonatomic, retain) CIBarcodeDescriptor *barcodeDescriptor;
@end
@protocol CICheckerboardGenerator <CIFilter>
@property (nonatomic) CGPoint center;
@property (nonatomic, retain) CIColor *color0;
@property (nonatomic, retain) CIColor *color1;
@property (nonatomic) float width;
@property (nonatomic) float sharpness;
@end
@protocol CICode128BarcodeGenerator <CIFilter>
@property (nonatomic, retain) NSData *message;
@property (nonatomic) float quietSpace;
@property (nonatomic) float barcodeHeight;
@end
@protocol CILenticularHaloGenerator <CIFilter>
@property (nonatomic) CGPoint center;
@property (nonatomic, retain) CIColor *color;
@property (nonatomic) float haloRadius;
@property (nonatomic) float haloWidth;
@property (nonatomic) float haloOverlap;
@property (nonatomic) float striationStrength;
@property (nonatomic) float striationContrast;
@property (nonatomic) float time;
@end
@protocol CIMeshGenerator <CIFilter>
@property (nonatomic) float width;
@property (nonatomic, retain) CIColor *color;
@property (nonatomic, retain) NSArray *mesh;
@end
@protocol CIPDF417BarcodeGenerator <CIFilter>
@property (nonatomic, retain) NSData *message;
@property (nonatomic) float minWidth;
@property (nonatomic) float maxWidth;
@property (nonatomic) float minHeight;
@property (nonatomic) float maxHeight;
@property (nonatomic) float dataColumns;
@property (nonatomic) float rows;
@property (nonatomic) float preferredAspectRatio;
@property (nonatomic) float compactionMode;
@property (nonatomic) float compactStyle;
@property (nonatomic) float correctionLevel;
@property (nonatomic) float alwaysSpecifyCompaction;
@end
@protocol CIQRCodeGenerator <CIFilter>
@property (nonatomic, retain) NSData *message;
@property (nonatomic, retain) NSString *correctionLevel;
@end
@protocol CIRandomGenerator <CIFilter>
@end
@protocol CIRoundedRectangleGenerator <CIFilter>
@property (nonatomic) CGRect extent;
@property (nonatomic) float radius;
@property (nonatomic, retain) CIColor *color;
@end
@protocol CIStarShineGenerator <CIFilter>
@property (nonatomic) CGPoint center;
@property (nonatomic, retain) CIColor *color;
@property (nonatomic) float radius;
@property (nonatomic) float crossScale;
@property (nonatomic) float crossAngle;
@property (nonatomic) float crossOpacity;
@property (nonatomic) float crossWidth;
@property (nonatomic) float epsilon;
@end
@protocol CIStripesGenerator <CIFilter>
@property (nonatomic) CGPoint center;
@property (nonatomic, retain) CIColor *color0;
@property (nonatomic, retain) CIColor *color1;
@property (nonatomic) float width;
@property (nonatomic) float sharpness;
@end
@protocol CISunbeamsGenerator <CIFilter>
@property (nonatomic) CGPoint center;
@property (nonatomic, retain) CIColor *color;
@property (nonatomic) float sunRadius;
@property (nonatomic) float maxStriationRadius;
@property (nonatomic) float striationStrength;
@property (nonatomic) float striationContrast;
@property (nonatomic) float time;
@end
@protocol CITextImageGenerator <CIFilter>
@property (nonatomic, retain) NSString *text;
@property (nonatomic, retain) NSString *fontName;
@property (nonatomic) float fontSize;
@property (nonatomic) float scaleFactor;
@end
// CICategoryStylize
@protocol CIBlendWithMask <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic, retain, nullable) CIImage *backgroundImage;
@property (nonatomic, retain, nullable) CIImage *maskImage;
@end
@protocol CIBloom <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) float radius;
@property (nonatomic) float intensity;
@end
@protocol CIComicEffect <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@end
@protocol CIConvolution <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic, retain) CIVector *weights;
@property (nonatomic) float bias;
@end
@protocol CICoreMLModel <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic, retain) MLModel *model;
@property (nonatomic) float headIndex;
@property (nonatomic) bool softmaxNormalization;
@end
@protocol CICrystallize <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) float radius;
@property (nonatomic) CGPoint center;
@end
@protocol CIDepthOfField <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) CGPoint point0;
@property (nonatomic) CGPoint point1;
@property (nonatomic) float saturation;
@property (nonatomic) float unsharpMaskRadius;
@property (nonatomic) float unsharpMaskIntensity;
@property (nonatomic) float radius;
@end
@protocol CIEdges <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) float intensity;
@end
@protocol CIEdgeWork <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) float radius;
@end
@protocol CIGaborGradients <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@end
@protocol CIGloom <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) float radius;
@property (nonatomic) float intensity;
@end
@protocol CIHeightFieldFromMask <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) float radius;
@end
@protocol CIHexagonalPixellate <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) CGPoint center;
@property (nonatomic) float scale;
@end
@protocol CIHighlightShadowAdjust <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) float radius;
@property (nonatomic) float shadowAmount;
@property (nonatomic) float highlightAmount;
@end
@protocol CILineOverlay <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) float NRNoiseLevel;
@property (nonatomic) float NRSharpness;
@property (nonatomic) float edgeIntensity;
@property (nonatomic) float threshold;
@property (nonatomic) float contrast;
@end
@protocol CIMix <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic, retain, nullable) CIImage *backgroundImage;
@property (nonatomic) float amount;
@end
@protocol CIPersonSegmentation <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) NSUInteger qualityLevel;
@end
@protocol CIPixellate <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) CGPoint center;
@property (nonatomic) float scale;
@end
@protocol CIPointillize <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) float radius;
@property (nonatomic) CGPoint center;
@end
@protocol CISaliencyMap <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@end
@protocol CIShadedMaterial <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic, retain, nullable) CIImage *shadingImage;
@property (nonatomic) float scale;
@end
@protocol CISpotColor <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic, retain) CIColor *centerColor1;
@property (nonatomic, retain) CIColor *replacementColor1;
@property (nonatomic) float closeness1;
@property (nonatomic) float contrast1;
@property (nonatomic, retain) CIColor *centerColor2;
@property (nonatomic, retain) CIColor *replacementColor2;
@property (nonatomic) float closeness2;
@property (nonatomic) float contrast2;
@property (nonatomic, retain) CIColor *centerColor3;
@property (nonatomic, retain) CIColor *replacementColor3;
@property (nonatomic) float closeness3;
@property (nonatomic) float contrast3;
@end
@protocol CISpotLight <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic, retain) CIVector *lightPosition;
@property (nonatomic, retain) CIVector *lightPointsAt;
@property (nonatomic) float brightness;
@property (nonatomic) float concentration;
@property (nonatomic, retain) CIColor *color;
@end
// CICategoryBlur
@protocol CIBokehBlur <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) float radius;
@property (nonatomic) float ringAmount;
@property (nonatomic) float ringSize;
@property (nonatomic) float softness;
@end
@protocol CIBoxBlur <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) float radius;
@end
@protocol CIDiscBlur <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) float radius;
@end
@protocol CIGaussianBlur <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) float radius;
@end
@protocol CIMaskedVariableBlur <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic, retain, nullable) CIImage *mask;
@property (nonatomic) float radius;
@end
@protocol CIMedian <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@end
@protocol CIMorphologyGradient <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) float radius;
@end
@protocol CIMorphologyMaximum <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) float radius;
@end
@protocol CIMorphologyMinimum <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) float radius;
@end
@protocol CIMorphologyRectangleMaximum <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) float width;
@property (nonatomic) float height;
@end
@protocol CIMorphologyRectangleMinimum <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) float width;
@property (nonatomic) float height;
@end
@protocol CIMotionBlur <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) float radius;
@property (nonatomic) float angle;
@end
@protocol CINoiseReduction <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) float noiseLevel;
@property (nonatomic) float sharpness;
@end
@protocol CIZoomBlur <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) CGPoint center;
@property (nonatomic) float amount;
@end
// CICategoryReduction
@protocol CIAreaReductionFilter <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) CGRect extent;
@end
@protocol CIAreaAverage <CIAreaReductionFilter>
@end
@protocol CIAreaHistogram <CIAreaReductionFilter>
@property (nonatomic) float scale;
@property (nonatomic) NSInteger count;
@end
@protocol CIAreaMaximum <CIAreaReductionFilter>
@end
@protocol CIAreaMaximumAlpha <CIAreaReductionFilter>
@end
@protocol CIAreaMinimum <CIAreaReductionFilter>
@end
@protocol CIAreaMinimumAlpha <CIAreaReductionFilter>
@end
@protocol CIAreaMinMax <CIAreaReductionFilter>
@end
@protocol CIAreaMinMaxRed <CIAreaReductionFilter>
@end
@protocol CIColumnAverage <CIAreaReductionFilter>
@end
@protocol CIHistogramDisplay <CIFilter>
@property (nonatomic, retain, nullable) CIImage *inputImage;
@property (nonatomic) float height;
@property (nonatomic) float highLimit;
@property (nonatomic) float lowLimit;
@end
@protocol CIKMeans <CIAreaReductionFilter>
@property (nonatomic, retain, nullable) CIImage *inputMeans;
@property (nonatomic) NSInteger count;
@property (nonatomic) float passes;
@property (nonatomic) bool perceptual;
@end
@protocol CIRowAverage <CIAreaReductionFilter>
@end
NS_CLASS_AVAILABLE(10_15, 13_0)
@interface CIFilter (Builtins)
// CICategoryGradient
+ (CIFilter<CIGaussianGradient>*) gaussianGradientFilter;
+ (CIFilter<CIHueSaturationValueGradient>*) hueSaturationValueGradientFilter;
+ (CIFilter<CILinearGradient>*) linearGradientFilter;
+ (CIFilter<CIRadialGradient>*) radialGradientFilter;
+ (CIFilter<CISmoothLinearGradient>*) smoothLinearGradientFilter;
// CICategorySharpen
+ (CIFilter<CISharpenLuminance>*) sharpenLuminanceFilter;
+ (CIFilter<CIUnsharpMask>*) unsharpMaskFilter;
// CICategoryHalftoneEffect
+ (CIFilter<CICircularScreen>*) circularScreenFilter;
+ (CIFilter<CICMYKHalftone>*) CMYKHalftone;
+ (CIFilter<CIDotScreen>*) dotScreenFilter;
+ (CIFilter<CIHatchedScreen>*) hatchedScreenFilter;
+ (CIFilter<CILineScreen>*) lineScreenFilter;
// CICategoryGeometryAdjustment
+ (CIFilter<CIBicubicScaleTransform>*) bicubicScaleTransformFilter;
+ (CIFilter<CIEdgePreserveUpsample>*) edgePreserveUpsampleFilter;
+ (CIFilter<CIKeystoneCorrectionCombined>*) keystoneCorrectionCombinedFilter;
+ (CIFilter<CIKeystoneCorrectionHorizontal>*) keystoneCorrectionHorizontalFilter;
+ (CIFilter<CIKeystoneCorrectionVertical>*) keystoneCorrectionVerticalFilter;
+ (CIFilter<CILanczosScaleTransform>*) lanczosScaleTransformFilter;
+ (CIFilter<CIPerspectiveCorrection>*) perspectiveCorrectionFilter;
+ (CIFilter<CIPerspectiveRotate>*) perspectiveRotateFilter;
+ (CIFilter<CIPerspectiveTransform>*) perspectiveTransformFilter;
+ (CIFilter<CIPerspectiveTransformWithExtent>*) perspectiveTransformWithExtentFilter;
+ (CIFilter<CIStraighten>*) straightenFilter;
// CICategoryTransition
+ (CIFilter<CIAccordionFoldTransition>*) accordionFoldTransitionFilter;
+ (CIFilter<CIBarsSwipeTransition>*) barsSwipeTransitionFilter;
+ (CIFilter<CICopyMachineTransition>*) copyMachineTransitionFilter NS_RETURNS_NOT_RETAINED;
+ (CIFilter<CIDisintegrateWithMaskTransition>*) disintegrateWithMaskTransitionFilter;
+ (CIFilter<CIDissolveTransition>*) dissolveTransitionFilter;
+ (CIFilter<CIFlashTransition>*) flashTransitionFilter;
+ (CIFilter<CIModTransition>*) modTransitionFilter;
+ (CIFilter<CIPageCurlTransition>*) pageCurlTransitionFilter;
+ (CIFilter<CIPageCurlWithShadowTransition>*) pageCurlWithShadowTransitionFilter;
+ (CIFilter<CIRippleTransition>*) rippleTransitionFilter;
+ (CIFilter<CISwipeTransition>*) swipeTransitionFilter;
// CICategoryCompositeOperation
+ (CIFilter<CICompositeOperation>*) additionCompositingFilter;
+ (CIFilter<CICompositeOperation>*) colorBlendModeFilter;
+ (CIFilter<CICompositeOperation>*) colorBurnBlendModeFilter;
+ (CIFilter<CICompositeOperation>*) colorDodgeBlendModeFilter;
+ (CIFilter<CICompositeOperation>*) darkenBlendModeFilter;
+ (CIFilter<CICompositeOperation>*) differenceBlendModeFilter;
+ (CIFilter<CICompositeOperation>*) divideBlendModeFilter;
+ (CIFilter<CICompositeOperation>*) exclusionBlendModeFilter;
+ (CIFilter<CICompositeOperation>*) hardLightBlendModeFilter;
+ (CIFilter<CICompositeOperation>*) hueBlendModeFilter;
+ (CIFilter<CICompositeOperation>*) lightenBlendModeFilter;
+ (CIFilter<CICompositeOperation>*) linearBurnBlendModeFilter;
+ (CIFilter<CICompositeOperation>*) linearDodgeBlendModeFilter;
+ (CIFilter<CICompositeOperation>*) linearLightBlendModeFilter NS_AVAILABLE(12_0, 15_0);
+ (CIFilter<CICompositeOperation>*) luminosityBlendModeFilter;
+ (CIFilter<CICompositeOperation>*) maximumCompositingFilter;
+ (CIFilter<CICompositeOperation>*) minimumCompositingFilter;
+ (CIFilter<CICompositeOperation>*) multiplyBlendModeFilter;
+ (CIFilter<CICompositeOperation>*) multiplyCompositingFilter;
+ (CIFilter<CICompositeOperation>*) overlayBlendModeFilter;
+ (CIFilter<CICompositeOperation>*) pinLightBlendModeFilter;
+ (CIFilter<CICompositeOperation>*) saturationBlendModeFilter;
+ (CIFilter<CICompositeOperation>*) screenBlendModeFilter;
+ (CIFilter<CICompositeOperation>*) softLightBlendModeFilter;
+ (CIFilter<CICompositeOperation>*) sourceAtopCompositingFilter;
+ (CIFilter<CICompositeOperation>*) sourceInCompositingFilter;
+ (CIFilter<CICompositeOperation>*) sourceOutCompositingFilter;
+ (CIFilter<CICompositeOperation>*) sourceOverCompositingFilter;
+ (CIFilter<CICompositeOperation>*) subtractBlendModeFilter;
+ (CIFilter<CICompositeOperation>*) vividLightBlendModeFilter NS_AVAILABLE(12_0, 15_0);
// CICategoryColorAdjustment
+ (CIFilter<CIColorAbsoluteDifference>*) colorAbsoluteDifferenceFilter NS_AVAILABLE(11_0, 14_0);
+ (CIFilter<CIColorClamp>*) colorClampFilter;
+ (CIFilter<CIColorControls>*) colorControlsFilter;
+ (CIFilter<CIColorMatrix>*) colorMatrixFilter;
+ (CIFilter<CIColorPolynomial>*) colorPolynomialFilter;
+ (CIFilter<CIColorThreshold>*) colorThresholdFilter NS_AVAILABLE(11_0, 14_0);
+ (CIFilter<CIColorThresholdOtsu>*) colorThresholdOtsuFilter NS_AVAILABLE(11_0, 14_0);
+ (CIFilter<CIDepthToDisparity>*) depthToDisparityFilter;
+ (CIFilter<CIDisparityToDepth>*) disparityToDepthFilter;
+ (CIFilter<CIExposureAdjust>*) exposureAdjustFilter;
+ (CIFilter<CIGammaAdjust>*) gammaAdjustFilter;
+ (CIFilter<CIHueAdjust>*) hueAdjustFilter;
+ (CIFilter<CILinearToSRGBToneCurve>*) linearToSRGBToneCurveFilter;
+ (CIFilter<CISRGBToneCurveToLinear>*) sRGBToneCurveToLinearFilter;
+ (CIFilter<CITemperatureAndTint>*) temperatureAndTintFilter;
+ (CIFilter<CIToneCurve>*) toneCurveFilter;
+ (CIFilter<CIVibrance>*) vibranceFilter;
+ (CIFilter<CIWhitePointAdjust>*) whitePointAdjustFilter;
// CICategoryColorEffect
+ (CIFilter<CIColorCrossPolynomial>*) colorCrossPolynomialFilter;
+ (CIFilter<CIColorCube>*) colorCubeFilter;
+ (CIFilter<CIColorCubesMixedWithMask>*) colorCubesMixedWithMaskFilter;
+ (CIFilter<CIColorCubeWithColorSpace>*) colorCubeWithColorSpaceFilter;
+ (CIFilter<CIColorCurves>*) colorCurvesFilter;
+ (CIFilter<CIColorInvert>*) colorInvertFilter;
+ (CIFilter<CIColorMap>*) colorMapFilter;
+ (CIFilter<CIColorMonochrome>*) colorMonochromeFilter;
+ (CIFilter<CIColorPosterize>*) colorPosterizeFilter;
+ (CIFilter<CIDither>*) ditherFilter;
+ (CIFilter<CIDocumentEnhancer>*) documentEnhancerFilter;
+ (CIFilter<CIFalseColor>*) falseColorFilter;
+ (CIFilter<CILabDeltaE>*) LabDeltaE;
+ (CIFilter<CIMaskToAlpha>*) maskToAlphaFilter;
+ (CIFilter<CIMaximumComponent>*) maximumComponentFilter;
+ (CIFilter<CIMinimumComponent>*) minimumComponentFilter;
+ (CIFilter<CIPaletteCentroid>*) paletteCentroidFilter;
+ (CIFilter<CIPalettize>*) palettizeFilter;
+ (CIFilter<CIPhotoEffect>*) photoEffectChromeFilter;
+ (CIFilter<CIPhotoEffect>*) photoEffectFadeFilter;
+ (CIFilter<CIPhotoEffect>*) photoEffectInstantFilter;
+ (CIFilter<CIPhotoEffect>*) photoEffectMonoFilter;
+ (CIFilter<CIPhotoEffect>*) photoEffectNoirFilter;
+ (CIFilter<CIPhotoEffect>*) photoEffectProcessFilter;
+ (CIFilter<CIPhotoEffect>*) photoEffectTonalFilter;
+ (CIFilter<CIPhotoEffect>*) photoEffectTransferFilter;
+ (CIFilter<CISepiaTone>*) sepiaToneFilter;
+ (CIFilter<CIThermal>*) thermalFilter;
+ (CIFilter<CIVignette>*) vignetteFilter;
+ (CIFilter<CIVignetteEffect>*) vignetteEffectFilter;
+ (CIFilter<CIXRay>*) xRayFilter;
// CICategoryDistortionEffect
+ (CIFilter<CIBumpDistortion>*) bumpDistortionFilter NS_AVAILABLE(11_0, 14_0);
+ (CIFilter<CIBumpDistortionLinear>*) bumpDistortionLinearFilter NS_AVAILABLE(11_0, 14_0);
+ (CIFilter<CICircleSplashDistortion>*) circleSplashDistortionFilter NS_AVAILABLE(11_0, 14_0);
+ (CIFilter<CICircularWrap>*) circularWrapFilter NS_AVAILABLE(11_0, 14_0);
+ (CIFilter<CIDisplacementDistortion>*) displacementDistortionFilter NS_AVAILABLE(11_0, 14_0);
+ (CIFilter<CIDroste>*) drosteFilter NS_AVAILABLE(11_0, 14_0);
+ (CIFilter<CIGlassDistortion>*) glassDistortionFilter NS_AVAILABLE(11_0, 14_0);
+ (CIFilter<CIGlassLozenge>*) glassLozengeFilter NS_AVAILABLE(11_0, 14_0);
+ (CIFilter<CIHoleDistortion>*) holeDistortionFilter NS_AVAILABLE(11_0, 14_0);
+ (CIFilter<CILightTunnel>*) lightTunnelFilter NS_AVAILABLE(11_0, 14_0);
+ (CIFilter<CINinePartStretched>*) ninePartStretchedFilter NS_AVAILABLE(11_0, 14_0);
+ (CIFilter<CINinePartTiled>*) ninePartTiledFilter NS_AVAILABLE(11_0, 14_0);
+ (CIFilter<CIPinchDistortion>*) pinchDistortionFilter NS_AVAILABLE(11_0, 14_0);
+ (CIFilter<CIStretchCrop>*) stretchCropFilter NS_AVAILABLE(11_0, 14_0);
+ (CIFilter<CITorusLensDistortion>*) torusLensDistortionFilter NS_AVAILABLE(11_0, 14_0);
+ (CIFilter<CITwirlDistortion>*) twirlDistortionFilter NS_AVAILABLE(11_0, 14_0);
+ (CIFilter<CIVortexDistortion>*) vortexDistortionFilter NS_AVAILABLE(11_0, 14_0);
// CICategoryTileEffect
+ (CIFilter<CIAffineClamp>*) affineClampFilter;
+ (CIFilter<CIAffineTile>*) affineTileFilter;
+ (CIFilter<CIEightfoldReflectedTile>*) eightfoldReflectedTileFilter;
+ (CIFilter<CIFourfoldReflectedTile>*) fourfoldReflectedTileFilter;
+ (CIFilter<CIFourfoldRotatedTile>*) fourfoldRotatedTileFilter;
+ (CIFilter<CIFourfoldTranslatedTile>*) fourfoldTranslatedTileFilter;
+ (CIFilter<CIGlideReflectedTile>*) glideReflectedTileFilter;
+ (CIFilter<CIKaleidoscope>*) kaleidoscopeFilter;
+ (CIFilter<CIOpTile>*) opTileFilter;
+ (CIFilter<CIParallelogramTile>*) parallelogramTileFilter;
+ (CIFilter<CIPerspectiveTile>*) perspectiveTileFilter;
+ (CIFilter<CISixfoldReflectedTile>*) sixfoldReflectedTileFilter;
+ (CIFilter<CISixfoldRotatedTile>*) sixfoldRotatedTileFilter;
+ (CIFilter<CITriangleKaleidoscope>*) triangleKaleidoscopeFilter;
+ (CIFilter<CITriangleTile>*) triangleTileFilter;
+ (CIFilter<CITwelvefoldReflectedTile>*) twelvefoldReflectedTileFilter;
// CICategoryGenerator
+ (CIFilter<CIAttributedTextImageGenerator>*) attributedTextImageGeneratorFilter;
+ (CIFilter<CIAztecCodeGenerator>*) aztecCodeGeneratorFilter;
+ (CIFilter<CIBarcodeGenerator>*) barcodeGeneratorFilter;
+ (CIFilter<CICheckerboardGenerator>*) checkerboardGeneratorFilter;
+ (CIFilter<CICode128BarcodeGenerator>*) code128BarcodeGeneratorFilter;
+ (CIFilter<CILenticularHaloGenerator>*) lenticularHaloGeneratorFilter;
+ (CIFilter<CIMeshGenerator>*) meshGeneratorFilter;
+ (CIFilter<CIPDF417BarcodeGenerator>*) PDF417BarcodeGenerator;
+ (CIFilter<CIQRCodeGenerator>*) QRCodeGenerator;
+ (CIFilter<CIRandomGenerator>*) randomGeneratorFilter;
+ (CIFilter<CIRoundedRectangleGenerator>*) roundedRectangleGeneratorFilter;
+ (CIFilter<CIStarShineGenerator>*) starShineGeneratorFilter;
+ (CIFilter<CIStripesGenerator>*) stripesGeneratorFilter;
+ (CIFilter<CISunbeamsGenerator>*) sunbeamsGeneratorFilter;
+ (CIFilter<CITextImageGenerator>*) textImageGeneratorFilter;
// CICategoryStylize
+ (CIFilter<CIBlendWithMask>*) blendWithAlphaMaskFilter;
+ (CIFilter<CIBlendWithMask>*) blendWithBlueMaskFilter;
+ (CIFilter<CIBlendWithMask>*) blendWithMaskFilter;
+ (CIFilter<CIBlendWithMask>*) blendWithRedMaskFilter;
+ (CIFilter<CIBloom>*) bloomFilter;
+ (CIFilter<CIComicEffect>*) comicEffectFilter;
+ (CIFilter<CIConvolution>*) convolution3X3Filter;
+ (CIFilter<CIConvolution>*) convolution5X5Filter;
+ (CIFilter<CIConvolution>*) convolution7X7Filter;
+ (CIFilter<CIConvolution>*) convolution9HorizontalFilter;
+ (CIFilter<CIConvolution>*) convolution9VerticalFilter;
+ (CIFilter<CIConvolution>*) convolutionRGB3X3Filter NS_AVAILABLE(12_0, 15_0);
+ (CIFilter<CIConvolution>*) convolutionRGB5X5Filter NS_AVAILABLE(12_0, 15_0);
+ (CIFilter<CIConvolution>*) convolutionRGB7X7Filter NS_AVAILABLE(12_0, 15_0);
+ (CIFilter<CIConvolution>*) convolutionRGB9HorizontalFilter NS_AVAILABLE(12_0, 15_0);
+ (CIFilter<CIConvolution>*) convolutionRGB9VerticalFilter NS_AVAILABLE(12_0, 15_0);
+ (CIFilter<CICoreMLModel>*) coreMLModelFilter;
+ (CIFilter<CICrystallize>*) crystallizeFilter;
+ (CIFilter<CIDepthOfField>*) depthOfFieldFilter;
+ (CIFilter<CIEdges>*) edgesFilter;
+ (CIFilter<CIEdgeWork>*) edgeWorkFilter;
+ (CIFilter<CIGaborGradients>*) gaborGradientsFilter;
+ (CIFilter<CIGloom>*) gloomFilter;
+ (CIFilter<CIHeightFieldFromMask>*) heightFieldFromMaskFilter;
+ (CIFilter<CIHexagonalPixellate>*) hexagonalPixellateFilter;
+ (CIFilter<CIHighlightShadowAdjust>*) highlightShadowAdjustFilter;
+ (CIFilter<CILineOverlay>*) lineOverlayFilter;
+ (CIFilter<CIMix>*) mixFilter;
+ (CIFilter<CIPersonSegmentation>*) personSegmentationFilter NS_AVAILABLE(12_0, 15_0);
+ (CIFilter<CIPixellate>*) pixellateFilter;
+ (CIFilter<CIPointillize>*) pointillizeFilter;
+ (CIFilter<CISaliencyMap>*) saliencyMapFilter;
+ (CIFilter<CIShadedMaterial>*) shadedMaterialFilter;
+ (CIFilter<CISpotColor>*) spotColorFilter;
+ (CIFilter<CISpotLight>*) spotLightFilter;
// CICategoryBlur
+ (CIFilter<CIBokehBlur>*) bokehBlurFilter;
+ (CIFilter<CIBoxBlur>*) boxBlurFilter;
+ (CIFilter<CIDiscBlur>*) discBlurFilter;
+ (CIFilter<CIGaussianBlur>*) gaussianBlurFilter;
+ (CIFilter<CIMaskedVariableBlur>*) maskedVariableBlurFilter;
+ (CIFilter<CIMedian>*) medianFilter;
+ (CIFilter<CIMorphologyGradient>*) morphologyGradientFilter;
+ (CIFilter<CIMorphologyMaximum>*) morphologyMaximumFilter;
+ (CIFilter<CIMorphologyMinimum>*) morphologyMinimumFilter;
+ (CIFilter<CIMorphologyRectangleMaximum>*) morphologyRectangleMaximumFilter;
+ (CIFilter<CIMorphologyRectangleMinimum>*) morphologyRectangleMinimumFilter;
+ (CIFilter<CIMotionBlur>*) motionBlurFilter;
+ (CIFilter<CINoiseReduction>*) noiseReductionFilter;
+ (CIFilter<CIZoomBlur>*) zoomBlurFilter;
// CICategoryReduction
+ (CIFilter<CIAreaAverage>*) areaAverageFilter NS_AVAILABLE(11_0, 14_0);
+ (CIFilter<CIAreaHistogram>*) areaHistogramFilter NS_AVAILABLE(11_0, 14_0);
+ (CIFilter<CIAreaMaximum>*) areaMaximumFilter NS_AVAILABLE(11_0, 14_0);
+ (CIFilter<CIAreaMaximumAlpha>*) areaMaximumAlphaFilter NS_AVAILABLE(11_0, 14_0);
+ (CIFilter<CIAreaMinimum>*) areaMinimumFilter NS_AVAILABLE(11_0, 14_0);
+ (CIFilter<CIAreaMinimumAlpha>*) areaMinimumAlphaFilter NS_AVAILABLE(11_0, 14_0);
+ (CIFilter<CIAreaMinMax>*) areaMinMaxFilter NS_AVAILABLE(11_0, 14_0);
+ (CIFilter<CIAreaMinMaxRed>*) areaMinMaxRedFilter NS_AVAILABLE(11_0, 14_0);
+ (CIFilter<CIColumnAverage>*) columnAverageFilter NS_AVAILABLE(11_0, 14_0);
+ (CIFilter<CIHistogramDisplay>*) histogramDisplayFilter NS_AVAILABLE(11_0, 14_0);
+ (CIFilter<CIKMeans>*) KMeansFilter NS_AVAILABLE(11_0, 14_0);
+ (CIFilter<CIRowAverage>*) rowAverageFilter NS_AVAILABLE(11_0, 14_0);
@end
NS_ASSUME_NONNULL_END
#endif // TARGET_OS_OSX || TARGET_OS_IOS || TARGET_OS_TV
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework/Headers/CoreImageDefines.h | /* CoreImage - CoreImageDefines.h
Copyright (c) 2014 Apple, Inc.
All rights reserved. */
#ifndef COREIMAGEDEFINES_H
#define COREIMAGEDEFINES_H
#include <TargetConditionals.h>
#include <stdbool.h>
#include <stdint.h>
#include <stddef.h>
#if TARGET_OS_IPHONE
#include <CoreGraphics/CoreGraphics.h>
#else
#include <ApplicationServices/ApplicationServices.h>
#endif
#ifdef __cplusplus
#define CI_EXTERN_C_BEGIN extern "C" {
#define CI_EXTERN_C_END }
#else
#define CI_EXTERN_C_BEGIN
#define CI_EXTERN_C_END
#endif
#ifdef __cplusplus
# define CORE_IMAGE_EXPORT extern "C" __attribute__((visibility("default")))
#else
# define CORE_IMAGE_EXPORT extern __attribute__((visibility("default")))
#endif
#define CORE_IMAGE_CLASS_EXPORT __attribute__((visibility("default")))
#ifdef CI_SILENCE_GL_DEPRECATION
#define CI_GL_DEPRECATED_IOS(from, to) NS_AVAILABLE_IOS(from)
#define CI_GL_DEPRECATED_MAC(from, to) NS_AVAILABLE_MAC(from)
#define CI_GL_DEPRECATED(fromM,toM, fromI,toI) NS_AVAILABLE(fromM,fromI)
#define CIKL_DEPRECATED(fromM,toM, fromI,toI) NS_AVAILABLE(fromM,fromI)
#else
#define CI_GL_DEPRECATED_IOS(from, to) NS_DEPRECATED_IOS(from, to, "Core Image OpenGLES API deprecated. (Define CI_SILENCE_GL_DEPRECATION to silence these warnings)")
#define CI_GL_DEPRECATED_MAC(from, to) NS_DEPRECATED_MAC(from, to, "Core Image OpenGL API deprecated. (Define CI_SILENCE_GL_DEPRECATION to silence these warnings)")
#define CI_GL_DEPRECATED(fromM,toM, fromI,toI) NS_DEPRECATED(fromM,toM, fromI,toI, "Core Image OpenGL API deprecated. (Define CI_SILENCE_GL_DEPRECATION to silence these warnings)")
#define CIKL_DEPRECATED(fromM,toM, fromI,toI) NS_DEPRECATED(fromM,toM, fromI,toI, "Core Image Kernel Language API deprecated. (Define CI_SILENCE_GL_DEPRECATION to silence these warnings)")
#endif
#if TARGET_OS_MAC || !TARGET_OS_SIMULATOR || defined(__IPHONE_13_0)
#define COREIMAGE_SUPPORTS_IOSURFACE 1
#else
#define COREIMAGE_SUPPORTS_IOSURFACE 0
#endif
#endif /* COREIMAGEDEFINES_H */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework/Headers/CIImageAccumulator.h | /* CoreImage - CIImageAccumulator.h
Copyright (c) 2004 Apple, Inc.
All rights reserved. */
#import <CoreImage/CoreImageDefines.h>
#import <CoreImage/CIImage.h>
NS_ASSUME_NONNULL_BEGIN
NS_CLASS_AVAILABLE(10_4, 9_0)
@interface CIImageAccumulator : NSObject
{
void *_state;
}
/* Create a new accumulator object.
For pixel format options see CIImage.h.
The specified color space is used to render the image.
If no color space is specified, no color matching is done.
The return values will be null if the format is unsupported or the extent is too big.
*/
+ (nullable instancetype)imageAccumulatorWithExtent:(CGRect)extent
format:(CIFormat)format;
+ (nullable instancetype)imageAccumulatorWithExtent:(CGRect)extent
format:(CIFormat)format
colorSpace:(CGColorSpaceRef)colorSpace
NS_AVAILABLE(10_7, 9_0);
- (nullable instancetype)initWithExtent:(CGRect)extent
format:(CIFormat)format;
- (nullable instancetype)initWithExtent:(CGRect)extent
format:(CIFormat)format
colorSpace:(CGColorSpaceRef)colorSpace
NS_AVAILABLE(10_7, 9_0);
/* Return the extent of the accumulator. */
@property (readonly) CGRect extent;
/* Return the pixel format of the accumulator. */
@property (readonly) CIFormat format;
/* Return an image representing the current contents of the accumulator.
* Rendering the image after subsequently calling setImage: has
* undefined behavior. */
- (CIImage *)image;
/* Set the image 'im' as the current contents of the accumulator. */
- (void)setImage:(CIImage *)image;
/* Set the image 'im' as the accumulator's contents. The caller guarantees
* that the new contents only differ from the old within the specified
* region. */
- (void)setImage:(CIImage *)image dirtyRect:(CGRect)dirtyRect;
/* Reset the accumulator, discarding any pending updates and current content. */
- (void)clear;
@end
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework/Headers/CIContext.h | /* CoreImage - CIContext.h
Copyright (c) 2014 Apple, Inc.
All rights reserved. */
#import <CoreImage/CIImage.h>
#import <CoreImage/CoreImageDefines.h>
#import <CoreVideo/CoreVideo.h>
#if TARGET_OS_IPHONE && (TARGET_OS_EMBEDDED || TARGET_OS_SIMULATOR || !TARGET_OS_MACCATALYST)
#import <OpenGLES/EAGL.h>
#elif TARGET_OS_OSX
#import <OpenGL/CGLTypes.h>
#endif
@class CIFilter;
@protocol MTLDevice, MTLTexture, MTLCommandBuffer, MTLCommandQueue;
NS_ASSUME_NONNULL_BEGIN
NS_CLASS_AVAILABLE(10_4, 5_0)
@interface CIContext : NSObject
{
void *_priv;
}
/* Keys that may be passed in the dictionary while creating contexts: */
typedef NSString * CIContextOption NS_TYPED_ENUM;
/* A CGColorSpaceRef object defining the color space that images are
* converted to before rendering into the context. */
CORE_IMAGE_EXPORT CIContextOption const kCIContextOutputColorSpace;
/* A CGColorSpaceRef object defining the color space in which all
* intermediate operations are performed. */
CORE_IMAGE_EXPORT CIContextOption const kCIContextWorkingColorSpace;
/* An NSNumber with a CIFormat value defining the pixel format to use for intermediate buffers.
* On iOS the supported values for this key are RGBA8 and RGBAh. If not specified:
* RGBA8 is used if app is linked against OSX 10.12 SDK or earlier.
* RGBAh is used if app is linked against OSX 10.13 SDK or later.
* On OSX the supported values for this key are RGBA8, RGBAh and RGBAf. If not specified, RGBAh is used. */
CORE_IMAGE_EXPORT CIContextOption const kCIContextWorkingFormat NS_AVAILABLE(10_4,8_0);
/* A boolean NSNumber controlling the quality of affine downsample operations.
* @YES implies that more quality is desired.
* On iOS the default value is @NO.
* On OSX the default value is @YES. */
CORE_IMAGE_EXPORT CIContextOption const kCIContextHighQualityDownsample NS_AVAILABLE(10_11,9_0);
/* A boolean NSNumber controlling whether output renders produce alpha-premultiplied pixels.
* The default value is @YES. */
CORE_IMAGE_EXPORT CIContextOption const kCIContextOutputPremultiplied NS_AVAILABLE(10_4,7_0);
/* A boolean NSNumber controlling how intermediate buffers are cached.
* If @NO, the context will empty intermediates during and after renders.
* The default value is @YES. */
CORE_IMAGE_EXPORT CIContextOption const kCIContextCacheIntermediates NS_AVAILABLE(10_12,10_0);
/* An NSNumber with a boolean value. When @YES the context will use
* software rendering on macOS. */
CORE_IMAGE_EXPORT CIContextOption const kCIContextUseSoftwareRenderer;
/* An NSNumber with a boolean value. When @YES the context will use
* low priority rendering on the GPU. */
CORE_IMAGE_EXPORT CIContextOption const kCIContextPriorityRequestLow NS_AVAILABLE(10_12, 8_0);
/* A boolean value specifying whether or not to allow use of low-power devices for GPU rendering.
* If @YES, the context will use a low power GPU if available and the high power device is not already in use.
* The default value is @NO which instructs the context to use the highest power/performance device. */
CORE_IMAGE_EXPORT CIContextOption const kCIContextAllowLowPower NS_AVAILABLE(10_12, 13_0);
/* An NSString specifying a client-provided name for a context.
* This name will be used in QuickLook graphs and the output of CI_PRINT_TREE. */
CORE_IMAGE_EXPORT CIContextOption const kCIContextName NS_AVAILABLE(10_14,12_0);
#pragma mark - contextWithCGLContext
/* Create a new CoreImage context object, all output will be drawn
* into the surface attached to the OpenGL context 'cglctx'. If 'pixelFormat' is
* non-null it should be the pixel format object used to create 'cglctx';
* it's required to be valid for the lifetime of the CIContext.
* The colorspace should be set to the colorspace of your target otherwise
* CI will take the colorspace from the CGLContext if available. */
#if TARGET_OS_OSX
+ (CIContext *)contextWithCGLContext:(CGLContextObj)cglctx
pixelFormat:(nullable CGLPixelFormatObj)pixelFormat
colorSpace:(nullable CGColorSpaceRef)colorSpace
options:(nullable NSDictionary<CIContextOption, id> *)options
CI_GL_DEPRECATED_MAC(10_6,10_14);
#endif
/* DEPRECATED, please use the method above or if you need this
* for backward capability, make sure that you specify the colorspace
* in the options dictionary */
#if TARGET_OS_OSX
+ (CIContext *)contextWithCGLContext:(CGLContextObj)cglctx
pixelFormat:(nullable CGLPixelFormatObj)pixelFormat
options:(nullable NSDictionary<CIContextOption, id> *)options
CI_GL_DEPRECATED_MAC(10_4,10_6);
#endif
#pragma mark - contextWithCGContext
/* Create a context specifying a destination CGContext.
*
* Core Image will use an internal destination context when methods such
* as [context render:to...] or [context createCGImage:...] are called.
*
* The [context drawImage:...] render methods will render to the CGContext.
*/
+ (CIContext *)contextWithCGContext:(CGContextRef)cgctx
options:(nullable NSDictionary<CIContextOption, id> *)options
NS_AVAILABLE(10_4,9_0);
#pragma mark - context without specifying a destination
/* Create a context without specifying a destination CG/GL/Metal context.
*
* Core Image will use an internal destination context when methods such
* as [context render:to...] or [context createCGImage:...] are called.
*
* The [context drawImage:...] render methods will not operate on this type
* of context.
*/
+ (CIContext *)contextWithOptions:(nullable NSDictionary<CIContextOption, id> *)options
NS_AVAILABLE(10_4,5_0);
+ (CIContext *)context NS_AVAILABLE(10_4,5_0);
- (instancetype)initWithOptions:(nullable NSDictionary<CIContextOption, id> *)options
NS_AVAILABLE(10_4,5_0);
- (instancetype)init NS_AVAILABLE(10_4,5_0);
#pragma mark - contextWithEAGLContext
/* Create a context specifying a destination EAGLContext.
*
* Core Image will use an internal destination context when methods such
* as [context render:to...] or [context createCGImage:...] are called.
*
* The [context drawImage:...] render methods will render to the EAGLContext.
*/
#if TARGET_OS_IPHONE && (TARGET_OS_EMBEDDED || TARGET_OS_SIMULATOR || !TARGET_OS_MACCATALYST)
+ (CIContext *)contextWithEAGLContext:(EAGLContext *)eaglContext
CI_GL_DEPRECATED_IOS(5_0,12_0);
+ (CIContext *)contextWithEAGLContext:(EAGLContext *)eaglContext
options:(nullable NSDictionary<CIContextOption, id> *)options
CI_GL_DEPRECATED_IOS(5_0,12_0);
#endif
#pragma mark - contextWithMTLDevice
/* If a system has more than one MTLDevice, then you can create a CIContext
* that uses a specific device. If a client wishes to use the default MTLDevice
* then call [CIContext contextWithOptions:] instead. */
+ (CIContext *)contextWithMTLDevice:(id<MTLDevice>)device NS_AVAILABLE(10_11,9_0);
+ (CIContext *)contextWithMTLDevice:(id<MTLDevice>)device
options:(nullable NSDictionary<CIContextOption, id> *)options
NS_AVAILABLE(10_11,9_0);
#pragma mark - contextWithMTLCommandQueue
/* Create a CIContext that commits commands to a specific queue.*/
+ (CIContext *)contextWithMTLCommandQueue:(id<MTLCommandQueue>)commandQueue NS_AVAILABLE(10_15,13_0);
+ (CIContext *)contextWithMTLCommandQueue:(id<MTLCommandQueue>)commandQueue
options:(nullable NSDictionary<CIContextOption, id> *)options
NS_AVAILABLE(10_15,13_0);
#pragma mark - properties
// The working color space of the CIContext
// The property will be null if the context was created with color management disabled.
@property (nullable, nonatomic, readonly) CGColorSpaceRef workingColorSpace NS_AVAILABLE(10_11,9_0);
// The working pixel format of the CIContext used for intermediate buffers
@property (nonatomic, readonly) CIFormat workingFormat NS_AVAILABLE(10_11,9_0);
#pragma mark - render methods
/* DEPRECATED, please use drawImage:inRect:fromRect: instead.
* Render the subregion 'fromRect' of 'image' to point 'atPoint' in the context's destination. */
- (void)drawImage:(CIImage *)image
atPoint:(CGPoint)atPoint
fromRect:(CGRect)fromRect NS_DEPRECATED(10_4,10_8, 5_0,6_0);
/* Render the rectangle 'fromRect' of 'image' to the rectangle 'inRect' in the
* context's destination. */
- (void)drawImage:(CIImage *)image
inRect:(CGRect)inRect
fromRect:(CGRect)fromRect;
/* Create a CoreGraphics layer object suitable for creating content for
* subsequently rendering into this CI context. The 'info' parameter is
* passed into CGLayerCreate () as the auxiliaryInfo dictionary.
* This will return null if size is empty or infinite. */
- (nullable CGLayerRef)createCGLayerWithSize:(CGSize)size
info:(nullable CFDictionaryRef)info
CF_RETURNS_RETAINED NS_DEPRECATED_MAC(10_4,10_11);
/* Render 'image' to the given bitmap.
* The 'data' parameter must point to at least rowBytes*floor(bounds.size.height) bytes.
* The 'bounds' parameter has the following behavior:
* The 'bounds' parameter acts to specify the region of 'image' to render.
* This region (regardless of its origin) is rendered at upper-left corner of 'data'.
* Passing a 'colorSpace' value of null means:
* Disable output color management if app is linked against iOS SDK
* Disable output color management if app is linked against OSX 10.11 SDK or later
* Match to context's output color space if app is linked against OSX 10.10 SDK or earlier
*/
- (void)render:(CIImage *)image
toBitmap:(void *)data
rowBytes:(ptrdiff_t)rowBytes
bounds:(CGRect)bounds
format:(CIFormat)format
colorSpace:(nullable CGColorSpaceRef)colorSpace;
#if COREIMAGE_SUPPORTS_IOSURFACE
/* Render 'image' to the given IOSurface.
* The 'bounds' parameter has the following behavior:
* The 'image' is rendered into 'surface' so that
* point (0,0) of 'image' aligns to the lower left corner of 'surface'.
* The 'bounds' acts like a clip rect to limit what region of 'surface' is modified.
*/
- (void)render:(CIImage *)image
toIOSurface:(IOSurfaceRef)surface
bounds:(CGRect)bounds
colorSpace:(nullable CGColorSpaceRef)colorSpace NS_AVAILABLE(10_6,5_0);
#endif
/* Render 'image' into the given CVPixelBuffer.
* In OS X 10.11.3 and iOS 9.3 and later
* CI will color match to the colorspace of the buffer.
* otherwise
* CI will color match to the context's output colorspace.
*/
- (void)render:(CIImage *)image
toCVPixelBuffer:(CVPixelBufferRef)buffer NS_AVAILABLE(10_11,5_0);
/* Render 'image' to the given CVPixelBufferRef.
* The 'bounds' parameter has the following behavior:
* In OS X and iOS 9 and later: The 'image' is rendered into 'buffer' so that
* point (0,0) of 'image' aligns to the lower left corner of 'buffer'.
* The 'bounds' acts like a clip rect to limit what region of 'buffer' is modified.
* In iOS 8 and earlier: The 'bounds' parameter acts to specify the region of 'image' to render.
* This region (regardless of its origin) is rendered at upper-left corner of 'buffer'.
* If 'colorSpace' is nil, CI will not color match to the destination.
*/
- (void)render:(CIImage *)image
toCVPixelBuffer:(CVPixelBufferRef)buffer
bounds:(CGRect)bounds
colorSpace:(nullable CGColorSpaceRef)colorSpace NS_AVAILABLE(10_11,5_0);
/* Render 'bounds' of 'image' to a Metal texture, optionally specifying what command buffer to use.
* Texture type must be MTLTexture2D.
* NOTE: Rendering to a texture initialized with a commandBuffer requires encoding all the commands to render an image into the specified buffer.
* This may impact system responsiveness and may result in higher memory usage if the image requires many passes to render.
* To avoid this impact, it is recommended to create a context using [CIContext contextWithMTLCommandQueue:].
*/
- (void)render:(CIImage *)image
toMTLTexture:(id<MTLTexture>)texture
commandBuffer:(nullable id<MTLCommandBuffer>)commandBuffer
bounds:(CGRect)bounds
colorSpace:(CGColorSpaceRef)colorSpace NS_AVAILABLE(10_11,9_0);
#pragma mark -
/* Runs the context's garbage collector to reclaim any resources that
* are no longer required (e.g. removes textures from the texture cache
* that reference deleted images.) This method is called automatically
* after every rendering operation. */
- (void)reclaimResources NS_AVAILABLE_MAC(10_4);
/* Frees any cached data (such as temporary images) associated with the
* context. This also runs the garbage collector. */
- (void)clearCaches NS_AVAILABLE(10_4,10_0);
/* Returns the maximum dimension for input images that can be processed
* on the context. */
- (CGSize)inputImageMaximumSize NS_AVAILABLE_IOS(5_0);
/* Returns the maximum dimension for image that can be rendered
* on the context. */
- (CGSize)outputImageMaximumSize NS_AVAILABLE_IOS(5_0);
@end
@interface CIContext (createCGImage)
/* Render the region 'fromRect' of image 'image' into a temporary buffer using
* the context, then create and return a new CoreGraphics image with
* the results. The caller is responsible for releasing the returned image.
* The return value will be null if size is empty or too big. */
- (nullable CGImageRef)createCGImage:(CIImage *)image
fromRect:(CGRect)fromRect
CF_RETURNS_RETAINED;
/* Create a new CGImage from the specified subrect of the image. If
* non-nil the new image will be created in the specified format and colorspace.
* The CGColorSpace must be kCGColorSpaceModelRGB or kCGColorSpaceModelMonochrome
* and must match the specified CIFormat.
* This will return null if fromRect is empty or infinite or the format isn't supported.
*/
- (nullable CGImageRef)createCGImage:(CIImage *)image
fromRect:(CGRect)fromRect
format:(CIFormat)format
colorSpace:(nullable CGColorSpaceRef)colorSpace
CF_RETURNS_RETAINED;
/* Create a new CGImage from the specified subrect of the image.
* The new CGImageRef will be created in the specified format and colorspace.
* The return value will be null if fromRect is empty or infinite.
* The CGColorSpace must be kCGColorSpaceModelRGB or kCGColorSpaceModelMonochrome
* and must match the specified CIFormat.
* This will return null if fromRect is empty or infinite or the format isn't supported.
* If deferred is NO, then the CIImage will be rendered once when this method is called.
* If deferred is YES, then the CIImage will be rendered whenever the CGImage is rendered.
*/
- (nullable CGImageRef)createCGImage:(CIImage *)image
fromRect:(CGRect)fromRect
format:(CIFormat)format
colorSpace:(nullable CGColorSpaceRef)colorSpace
deferred:(BOOL)deferred
CF_RETURNS_RETAINED NS_AVAILABLE(10_12,10_0);
@end
@interface CIContext (OfflineGPUSupport)
/* Not all GPUs will be driving a display. If they are offline we can still use them
* to do work with Core Image. This method returns the number of offline GPUs which
* can be used for this purpose */
+(unsigned int)offlineGPUCount NS_AVAILABLE_MAC(10_10);
/* These two methods lets you create a CIContext based on an offline gpu index.
* The first method takes only the GPU index as a parameter, the second, takes
* an optional colorspace, options dictionary and a CGLContext which can be
* shared with other GL resources. The return value will be null if index is
* out of range (e.g. if the device has no offline GPUs).
*/
#if TARGET_OS_OSX
+ (nullable CIContext *)contextForOfflineGPUAtIndex:(unsigned int)index CI_GL_DEPRECATED_MAC(10_10,10_14);
+ (nullable CIContext *)contextForOfflineGPUAtIndex:(unsigned int)index
colorSpace:(nullable CGColorSpaceRef)colorSpace
options:(nullable NSDictionary<CIContextOption, id> *)options
sharedContext:(nullable CGLContextObj)sharedContext CI_GL_DEPRECATED_MAC(10_10,10_14);
#endif
@end
typedef NSString * CIImageRepresentationOption NS_TYPED_ENUM;
@interface CIContext (ImageRepresentation)
// The value for kCIImageRepresentationAVDepthData should be an AVDepthData object. */
CORE_IMAGE_EXPORT CIImageRepresentationOption const kCIImageRepresentationAVDepthData NS_AVAILABLE(10_13,11_0);
// The value for kCIImageRepresentationDepthImage should be a monochome CIImage object. */
CORE_IMAGE_EXPORT CIImageRepresentationOption const kCIImageRepresentationDepthImage NS_AVAILABLE(10_13,11_0);
// The value for kCIImageRepresentationDisparityImage should be a monochome CIImage object. */
CORE_IMAGE_EXPORT CIImageRepresentationOption const kCIImageRepresentationDisparityImage NS_AVAILABLE(10_13,11_0);
// The value for kCIImageRepresentationAVPortraitEffectsMatte should be an AVPortraitEffectsMatte object. */
CORE_IMAGE_EXPORT CIImageRepresentationOption const kCIImageRepresentationAVPortraitEffectsMatte NS_AVAILABLE(10_14,12_0);
// The value for kCIImageRepresentationPortraitEffectsMatteImage should be a monochome CIImage object. */
CORE_IMAGE_EXPORT CIImageRepresentationOption const kCIImageRepresentationPortraitEffectsMatteImage NS_AVAILABLE(10_14,12_0);
// The value for kCIImageRepresentationAVSemanticSegmentationMattes should be an array of AVSemanticSegmentationMatte objects. */
CORE_IMAGE_EXPORT CIImageRepresentationOption const kCIImageRepresentationAVSemanticSegmentationMattes NS_AVAILABLE(10_15, 13_0);
// The value for kCIImageRepresentationSemanticSegmentationSkinMatteImage should be a monochome CIImage object. */
CORE_IMAGE_EXPORT CIImageRepresentationOption const kCIImageRepresentationSemanticSegmentationSkinMatteImage NS_AVAILABLE(10_15, 13_0);
// The value for kCIImageRepresentationSemanticSegmentationHairMatteImage should be a monochome CIImage object. */
CORE_IMAGE_EXPORT CIImageRepresentationOption const kCIImageRepresentationSemanticSegmentationHairMatteImage NS_AVAILABLE(10_15, 13_0);
// The value for kCIImageRepresentationSemanticSegmentationTeethMatteImage should be a monochome CIImage object. */
CORE_IMAGE_EXPORT CIImageRepresentationOption const kCIImageRepresentationSemanticSegmentationTeethMatteImage NS_AVAILABLE(10_15, 13_0);
// The value for kCIImageRepresentationSemanticSegmentationGlassesMatteImage should be a monochome CIImage object. */
CORE_IMAGE_EXPORT CIImageRepresentationOption const kCIImageRepresentationSemanticSegmentationGlassesMatteImage NS_AVAILABLE(11_0, 14_1);
// The value for kCIImageRepresentationSemanticSegmentationSkyMatteImage should be a monochome CIImage object. */
CORE_IMAGE_EXPORT CIImageRepresentationOption const kCIImageRepresentationSemanticSegmentationSkyMatteImage NS_AVAILABLE(11_1, 14_3);
/* Render a CIImage to TIFF data. Image must have a finite non-empty extent. */
/* The CGColorSpace must be kCGColorSpaceModelRGB or kCGColorSpaceModelMonochrome */
/* and must match the specified CIFormat. */
/* No options keys are supported at this time. */
- (nullable NSData*) TIFFRepresentationOfImage:(CIImage*)image
format:(CIFormat)format
colorSpace:(CGColorSpaceRef)colorSpace
options:(NSDictionary<CIImageRepresentationOption, id>*)options NS_AVAILABLE(10_12,10_0);
/* Render a CIImage to JPEG data. Image must have a finite non-empty extent. */
/* The CGColorSpace must be kCGColorSpaceModelRGB or kCGColorSpaceModelMonochrome. */
/* Supported options keys are kCGImageDestinationLossyCompressionQuality, */
/* and the depth, disparity, and matte options. */
- (nullable NSData*) JPEGRepresentationOfImage:(CIImage*)image
colorSpace:(CGColorSpaceRef)colorSpace
options:(NSDictionary<CIImageRepresentationOption, id>*)options NS_AVAILABLE(10_12,10_0);
/* Render a CIImage to HEIF data. Image must have a finite non-empty extent. */
/* The CGColorSpace must be kCGColorSpaceModelRGB or kCGColorSpaceModelMonochrome */
/* and must match the specified CIFormat. */
/* Supported options keys are kCGImageDestinationLossyCompressionQuality, */
/* and the depth, disparity, and matte options. */
- (nullable NSData*) HEIFRepresentationOfImage:(CIImage*)image
format:(CIFormat)format
colorSpace:(CGColorSpaceRef)colorSpace
options:(NSDictionary<CIImageRepresentationOption, id>*)options NS_AVAILABLE(10_13_4,11_0);
/* Render a CIImage to HEIF data. Image must have a finite non-empty extent. */
/* The CGColorSpace must be kCGColorSpaceModelRGB or kCGColorSpaceModelMonochrome. */
/* Supported options keys are kCGImageDestinationLossyCompressionQuality, */
/* and the depth, disparity, and matte options. */
- (nullable NSData*) HEIF10RepresentationOfImage:(CIImage*)image
colorSpace:(CGColorSpaceRef)colorSpace
options:(NSDictionary<CIImageRepresentationOption, id>*)options
error:(NSError **)errorPtr NS_AVAILABLE(12_0,15_0);
/* Render a CIImage to PNG data. Image must have a finite non-empty extent. */
/* The CGColorSpace must be kCGColorSpaceModelRGB or kCGColorSpaceModelMonochrome */
/* and must match the specified CIFormat. */
/* No options keys are supported at this time. */
- (nullable NSData*) PNGRepresentationOfImage:(CIImage*)image
format:(CIFormat)format
colorSpace:(CGColorSpaceRef)colorSpace
options:(NSDictionary<CIImageRepresentationOption, id>*)options NS_AVAILABLE(10_13,11_0);
/* Render a CIImage to TIFF file. Image must have a finite non-empty extent. */
/* The CGColorSpace must be kCGColorSpaceModelRGB or kCGColorSpaceModelMonochrome */
/* and must match the specified CIFormat. */
/* No options keys are supported at this time. */
- (BOOL) writeTIFFRepresentationOfImage:(CIImage*)image
toURL:(NSURL*)url
format:(CIFormat)format
colorSpace:(CGColorSpaceRef)colorSpace
options:(NSDictionary<CIImageRepresentationOption, id>*)options
error:(NSError **)errorPtr NS_AVAILABLE(10_12,10_0);
/* Render a CIImage to PNG file. Image must have a finite non-empty extent. */
/* The CGColorSpace must be kCGColorSpaceModelRGB or kCGColorSpaceModelMonochrome */
/* and must match the specified CIFormat. */
/* No options keys are supported at this time. */
- (BOOL) writePNGRepresentationOfImage:(CIImage*)image
toURL:(NSURL*)url
format:(CIFormat)format
colorSpace:(CGColorSpaceRef)colorSpace
options:(NSDictionary<CIImageRepresentationOption, id>*)options
error:(NSError **)errorPtr NS_AVAILABLE(10_13,11_0);
/* Render a CIImage to JPEG file. Image must have a finite non-empty extent. */
/* The CGColorSpace must be kCGColorSpaceModelRGB or kCGColorSpaceModelMonochrome. */
/* Supported options keys are kCGImageDestinationLossyCompressionQuality, */
/* and the depth, disparity, and matte options. */
- (BOOL) writeJPEGRepresentationOfImage:(CIImage*)image
toURL:(NSURL*)url
colorSpace:(CGColorSpaceRef)colorSpace
options:(NSDictionary<CIImageRepresentationOption, id>*)options
error:(NSError **)errorPtr NS_AVAILABLE(10_12,10_0);
/* Render a CIImage to HEIF file. Image must have a finite non-empty extent. */
/* The CGColorSpace must be kCGColorSpaceModelRGB or kCGColorSpaceModelMonochrome */
/* and must match the specified CIFormat. */
/* Supported options keys are kCGImageDestinationLossyCompressionQuality, */
/* and the depth, disparity, and matte options. */
- (BOOL) writeHEIFRepresentationOfImage:(CIImage*)image
toURL:(NSURL*)url
format:(CIFormat)format
colorSpace:(CGColorSpaceRef)colorSpace
options:(NSDictionary<CIImageRepresentationOption, id>*)options
error:(NSError **)errorPtr NS_AVAILABLE(10_13_4,11_0);
/* Render a CIImage to 10-bit deep HEIF file. Image must have a finite non-empty extent. */
/* The CGColorSpace must be kCGColorSpaceModelRGB or kCGColorSpaceModelMonochrome. */
/* Supported options keys are kCGImageDestinationLossyCompressionQuality, */
/* and the depth, disparity, and matte options. */
- (BOOL) writeHEIF10RepresentationOfImage:(CIImage*)image
toURL:(NSURL*)url
colorSpace:(CGColorSpaceRef)colorSpace
options:(NSDictionary<CIImageRepresentationOption, id>*)options
error:(NSError **)errorPtr NS_AVAILABLE(12_0,15_0);
@end
@interface CIContext (CIDepthBlurEffect)
/* Create and CIFilter instance for 'image' that can be used to apply the CIDepthBlurEffect.
*
* The receiver context is user to render the image in order to get the facial landmarks
*
* The 'options' parameter is a key value/pair reserved for future use.
*
*/
- (nullable CIFilter *) depthBlurEffectFilterForImageURL:(NSURL *)url options:(nullable NSDictionary *)options NS_AVAILABLE(10_14,12_0);
/* This is the same as the method above expect it uses NSData to instantiate the image data
* instead of the contents of a NSURL.
*
*/
- (nullable CIFilter *) depthBlurEffectFilterForImageData:(NSData *)data options:(nullable NSDictionary *)options NS_AVAILABLE(10_14,12_0);
/* Create and CIFilter instance for 'image' that can be used to apply the CIDepthBlurEffect.
*
* The receiver context is user to render the image in order to get the facial landmarks
*
* The 'orientation' parameter should be CGImagePropertyOrientation enum value
* as defined in the TIFF spec.
*
* The 'options' parameter is a key value/pair reserved for future use.
*
*/
- (nullable CIFilter *) depthBlurEffectFilterForImage:(CIImage *)image
disparityImage:(CIImage *)disparityImage
portraitEffectsMatte:(nullable CIImage *)portraitEffectsMatte
orientation:(CGImagePropertyOrientation)orientation
options:(nullable NSDictionary *)options NS_AVAILABLE(10_14,12_0);
- (nullable CIFilter *) depthBlurEffectFilterForImage:(CIImage *)image
disparityImage:(CIImage *)disparityImage
portraitEffectsMatte:(nullable CIImage *)portraitEffectsMatte
hairSemanticSegmentation:(nullable CIImage *)hairSemanticSegmentation
orientation:(CGImagePropertyOrientation)orientation
options:(nullable NSDictionary *)options NS_AVAILABLE(10_15,13_0);
- (nullable CIFilter *) depthBlurEffectFilterForImage:(CIImage *)image
disparityImage:(CIImage *)disparityImage
portraitEffectsMatte:(nullable CIImage *)portraitEffectsMatte
hairSemanticSegmentation:(nullable CIImage *)hairSemanticSegmentation
glassesMatte:(nullable CIImage *)glassesMatte
gainMap:(nullable CIImage *)gainMap
orientation:(CGImagePropertyOrientation)orientation
options:(nullable NSDictionary *)options NS_AVAILABLE(11_0,14_1);
@end
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework/Headers/CIImageProvider.h | /*
CoreImage - CIImageProvider.h
Copyright (c) 2015 Apple, Inc.
All rights reserved.
*/
#import <CoreImage/CIImage.h>
NS_ASSUME_NONNULL_BEGIN
@interface CIImage (CIImageProvider)
/* Create a new CIImage populated when rendered with data provided by 'p'.
* The provider object 'p' is retained until the image is deallocated.
* The 'options' dictionary supports kCIImageProviderTileSize as well as
* other options defined in CIImage.h
*/
+ (CIImage *)imageWithImageProvider:(id)p
size:(size_t)width
:(size_t)height
format:(CIFormat)f
colorSpace:(nullable CGColorSpaceRef)cs
options:(nullable NSDictionary<CIImageOption,id> *)options
NS_AVAILABLE(10_4, 9_0);
- (instancetype)initWithImageProvider:(id)p
size:(size_t)width
:(size_t)height
format:(CIFormat)f
colorSpace:(nullable CGColorSpaceRef)cs
options:(nullable NSDictionary<CIImageOption,id> *)options
NS_AVAILABLE(10_4, 9_0);
@end
/** Informal protocol used to lazily supply image data. */
@interface NSObject (CIImageProvider)
/* Callee should initialize the given bitmap with the subregion x,y
* width,height of the image. (this subregion is defined in the image's
* local coordinate space, i.e. the origin is the top left corner of
* the image).
*
* By default, this method will be called to requests the full image
* data regardless of what subregion is needed for the current render.
* All of the image is loaded or none of it is.
*
* If the kCIImageProviderTileSize option is specified, then only the
* tiles that are needed are requested.
*
* Changing the virtual memory mapping of the supplied buffer (e.g. using
* vm_copy () to modify it) will give undefined behavior.
*/
- (void)provideImageData:(void *)data
bytesPerRow:(size_t)rowbytes
origin:(size_t)x
:(size_t)y
size:(size_t)width
:(size_t)height
userInfo:(nullable id)info;
@end
/* Options that may be supplied to image providers through the dictionary. */
/* Specifies the the tile size that the provideImageData: method will be called for.
* If the value is:
* An NSNumber, then the value specifies a square tile size.
*
* An NSArray or CIVector with two values, then it specifies a rectangular tile width and height.
*
* Not specified, then provideImageData: will be called for the entire image.
*
* NSNull, then provideImageData: can be called for any possible origin and size.
*/
CORE_IMAGE_EXPORT CIImageOption const kCIImageProviderTileSize NS_AVAILABLE(10_4, 9_0);
/* The object passed when the provideImageData: method is called.
* It is retained until the image is deallocated.
*/
CORE_IMAGE_EXPORT CIImageOption const kCIImageProviderUserInfo NS_AVAILABLE(10_4, 9_0);
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework/Headers/CIVector.h | /*
CoreImage - CIVector.h
Copyright (c) 2015 Apple, Inc.
All rights reserved.
*/
#import <CoreImage/CoreImageDefines.h>
#import <Foundation/Foundation.h>
NS_ASSUME_NONNULL_BEGIN
NS_CLASS_AVAILABLE(10_4, 5_0)
@interface CIVector : NSObject <NSCopying, NSSecureCoding>
{
size_t _count;
union {
CGFloat vec[4];
CGFloat *ptr;
}
_u;
}
/* Create a new vector object. */
+ (instancetype)vectorWithValues:(const CGFloat *)values count:(size_t)count;
+ (instancetype)vectorWithX:(CGFloat)x;
+ (instancetype)vectorWithX:(CGFloat)x Y:(CGFloat)y;
+ (instancetype)vectorWithX:(CGFloat)x Y:(CGFloat)y Z:(CGFloat)z;
+ (instancetype)vectorWithX:(CGFloat)x Y:(CGFloat)y Z:(CGFloat)z W:(CGFloat)w;
/* the CGPoint x and y values are stored in the first X and Y values of the CIVector. */
+ (instancetype)vectorWithCGPoint:(CGPoint)p NS_AVAILABLE(10_9, 5_0);
/* the CGRect x, y, width, height values are stored in the first X, Y, Z, W values of the CIVector. */
+ (instancetype)vectorWithCGRect:(CGRect)r NS_AVAILABLE(10_9, 5_0);
/* the CGAffineTransform's six values are stored in the first six values of the CIVector. */
+ (instancetype)vectorWithCGAffineTransform:(CGAffineTransform)t NS_AVAILABLE(10_9, 5_0);
+ (instancetype)vectorWithString:(NSString *)representation;
/* Initializers. */
- (instancetype)initWithValues:(const CGFloat *)values count:(size_t)count NS_DESIGNATED_INITIALIZER;
- (instancetype)initWithX:(CGFloat)x;
- (instancetype)initWithX:(CGFloat)x Y:(CGFloat)y;
- (instancetype)initWithX:(CGFloat)x Y:(CGFloat)y Z:(CGFloat)z;
- (instancetype)initWithX:(CGFloat)x Y:(CGFloat)y Z:(CGFloat)z W:(CGFloat)w;
- (instancetype)initWithCGPoint:(CGPoint)p NS_AVAILABLE(10_9, 5_0);
- (instancetype)initWithCGRect:(CGRect)r NS_AVAILABLE(10_9, 5_0);
- (instancetype)initWithCGAffineTransform:(CGAffineTransform)r NS_AVAILABLE(10_9, 5_0);
- (instancetype)initWithString:(NSString *)representation;
/* Return the value from the vector at position 'index' (zero-based).
* Any 'index' value is valid, if the component would otherwise be
* undefined, zero is returned. */
- (CGFloat)valueAtIndex:(size_t)index;
/* Return the number of values stored in the vector. */
@property (readonly) size_t count;
/* Properties. */
@property (readonly) CGFloat X;
@property (readonly) CGFloat Y;
@property (readonly) CGFloat Z;
@property (readonly) CGFloat W;
@property (readonly) CGPoint CGPointValue NS_AVAILABLE(10_9, 5_0);
@property (readonly) CGRect CGRectValue NS_AVAILABLE(10_9, 5_0);
@property (readonly) CGAffineTransform CGAffineTransformValue NS_AVAILABLE(10_9, 5_0);
/* Returns a formatted string with the components of the vector.
* The string is suitable for passing to [CIVector vectorWithString:].
* This property is not KVO-safe because it returns a new NSString each time.
* The value of the NSString will be the same each time it is called. */
@property (readonly) NSString *stringRepresentation;
@end
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework/Headers/CIFilter.h | /*
CoreImage - CIFilter.h
Copyright (c) 2015 Apple, Inc.
All rights reserved.
*/
#import <Foundation/Foundation.h>
#import <CoreImage/CoreImageDefines.h>
#import <CoreImage/CIFilterConstructor.h>
NS_ASSUME_NONNULL_BEGIN
/* Filter attributes keys */
/** Name of the filter */
CORE_IMAGE_EXPORT NSString * const kCIAttributeFilterName;
/** Name of the filter intended for UI display (eg. localized) */
CORE_IMAGE_EXPORT NSString * const kCIAttributeFilterDisplayName;
/** Description of the filter intended for UI display (eg. localized) */
CORE_IMAGE_EXPORT NSString * const kCIAttributeDescription NS_AVAILABLE(10_5, 9_0);
/** The version of OS X and iOS a filter was first available in. */
CORE_IMAGE_EXPORT NSString * const kCIAttributeFilterAvailable_Mac NS_AVAILABLE(10_11, 9_0);
CORE_IMAGE_EXPORT NSString * const kCIAttributeFilterAvailable_iOS NS_AVAILABLE(10_11, 9_0);
/** URL for the reference documentation of the filter. See localizedReferenceDocumentationForFilterName. */
CORE_IMAGE_EXPORT NSString * const kCIAttributeReferenceDocumentation NS_AVAILABLE(10_5, 9_0);
/** Array of filter category names (see below) */
CORE_IMAGE_EXPORT NSString * const kCIAttributeFilterCategories;
/** Class name of the filter. */
CORE_IMAGE_EXPORT NSString * const kCIAttributeClass;
/** The type of the attribute e.g. scalar, time, distance, etc. */
CORE_IMAGE_EXPORT NSString * const kCIAttributeType;
/** Minimum value for the attribute. */
CORE_IMAGE_EXPORT NSString * const kCIAttributeMin;
/** Maximum value for the attribute. */
CORE_IMAGE_EXPORT NSString * const kCIAttributeMax;
/** Minimum value for the slider. */
CORE_IMAGE_EXPORT NSString * const kCIAttributeSliderMin;
/** Maximum value for the slider. */
CORE_IMAGE_EXPORT NSString * const kCIAttributeSliderMax;
/** Default value for the slider. */
CORE_IMAGE_EXPORT NSString * const kCIAttributeDefault;
/** The identity value is the value at which the filter has no effect. */
CORE_IMAGE_EXPORT NSString * const kCIAttributeIdentity;
/** The non-localized name of the attribute. */
CORE_IMAGE_EXPORT NSString * const kCIAttributeName;
/** The localized name of the attribute to be used for display to the user. */
CORE_IMAGE_EXPORT NSString * const kCIAttributeDisplayName;
/** Key to request the desired set of controls in a filter UIView. The defined values for this key are:
CIUISetBasic, CIUISetIntermediate, CIUISetAdvanced and CIUISetDevelopment. */
CORE_IMAGE_EXPORT NSString * const kCIUIParameterSet NS_AVAILABLE(10_5, 9_0);
/** Constant for requesting controls that are appropiate in an basic user scenario, meaning the bare minimum of settings to control the filter. */
CORE_IMAGE_EXPORT NSString * const kCIUISetBasic NS_AVAILABLE(10_5, 9_0);
/** Constant for requesting controls that are appropiate in an intermediate user scenario. */
CORE_IMAGE_EXPORT NSString * const kCIUISetIntermediate NS_AVAILABLE(10_5, 9_0);
/** Constant for requesting controls that are appropiate in an advanced user scenario. */
CORE_IMAGE_EXPORT NSString * const kCIUISetAdvanced NS_AVAILABLE(10_5, 9_0);
/** Constant for requesting controls that should only be visible for development purposes. */
CORE_IMAGE_EXPORT NSString * const kCIUISetDevelopment NS_AVAILABLE(10_5, 9_0);
/* Types for numbers */
CORE_IMAGE_EXPORT NSString * const kCIAttributeTypeTime;
CORE_IMAGE_EXPORT NSString * const kCIAttributeTypeScalar;
CORE_IMAGE_EXPORT NSString * const kCIAttributeTypeDistance;
CORE_IMAGE_EXPORT NSString * const kCIAttributeTypeAngle;
CORE_IMAGE_EXPORT NSString * const kCIAttributeTypeBoolean;
/** Indicates that the key uses integer values. */
CORE_IMAGE_EXPORT NSString * const kCIAttributeTypeInteger NS_AVAILABLE(10_5, 5_0);
/** Indicates that the key uses non negative integer values. */
CORE_IMAGE_EXPORT NSString * const kCIAttributeTypeCount NS_AVAILABLE(10_5, 5_0);
/* Types for 2-element vectors */
CORE_IMAGE_EXPORT NSString * const kCIAttributeTypePosition;
CORE_IMAGE_EXPORT NSString * const kCIAttributeTypeOffset;
/* Types for 3-element vectors */
CORE_IMAGE_EXPORT NSString * const kCIAttributeTypePosition3;
/* Types for 4-element vectors */
CORE_IMAGE_EXPORT NSString * const kCIAttributeTypeRectangle;
/* Types for colors */
CORE_IMAGE_EXPORT NSString * const kCIAttributeTypeOpaqueColor NS_AVAILABLE(10_4, 9_0);
CORE_IMAGE_EXPORT NSString * const kCIAttributeTypeColor NS_AVAILABLE(10_11, 5_0);
/* Types for images */
CORE_IMAGE_EXPORT NSString * const kCIAttributeTypeGradient NS_AVAILABLE(10_4, 9_0);
CORE_IMAGE_EXPORT NSString * const kCIAttributeTypeImage NS_AVAILABLE(10_11, 5_0);
/* Types for NSValue of CGAffineTransform */
CORE_IMAGE_EXPORT NSString * const kCIAttributeTypeTransform NS_AVAILABLE(10_11, 5_0);
/* Categories */
CORE_IMAGE_EXPORT NSString * const kCICategoryDistortionEffect;
CORE_IMAGE_EXPORT NSString * const kCICategoryGeometryAdjustment;
CORE_IMAGE_EXPORT NSString * const kCICategoryCompositeOperation;
CORE_IMAGE_EXPORT NSString * const kCICategoryHalftoneEffect;
CORE_IMAGE_EXPORT NSString * const kCICategoryColorAdjustment;
CORE_IMAGE_EXPORT NSString * const kCICategoryColorEffect;
CORE_IMAGE_EXPORT NSString * const kCICategoryTransition;
CORE_IMAGE_EXPORT NSString * const kCICategoryTileEffect;
CORE_IMAGE_EXPORT NSString * const kCICategoryGenerator;
CORE_IMAGE_EXPORT NSString * const kCICategoryReduction NS_AVAILABLE(10_5, 5_0);
CORE_IMAGE_EXPORT NSString * const kCICategoryGradient;
CORE_IMAGE_EXPORT NSString * const kCICategoryStylize;
CORE_IMAGE_EXPORT NSString * const kCICategorySharpen;
CORE_IMAGE_EXPORT NSString * const kCICategoryBlur;
CORE_IMAGE_EXPORT NSString * const kCICategoryVideo;
CORE_IMAGE_EXPORT NSString * const kCICategoryStillImage;
CORE_IMAGE_EXPORT NSString * const kCICategoryInterlaced;
CORE_IMAGE_EXPORT NSString * const kCICategoryNonSquarePixels;
CORE_IMAGE_EXPORT NSString * const kCICategoryHighDynamicRange;
CORE_IMAGE_EXPORT NSString * const kCICategoryBuiltIn;
CORE_IMAGE_EXPORT NSString * const kCICategoryFilterGenerator NS_AVAILABLE(10_5, 9_0);
/* Options keys for [CIFilter apply:arguments:options:] and [CIFilter apply:...] methods. */
CORE_IMAGE_EXPORT NSString * const kCIApplyOptionExtent NS_AVAILABLE_MAC(10_4);
CORE_IMAGE_EXPORT NSString * const kCIApplyOptionDefinition NS_AVAILABLE_MAC(10_4);
CORE_IMAGE_EXPORT NSString * const kCIApplyOptionUserInfo NS_AVAILABLE_MAC(10_4);
/* If used, the value of the kCIApplyOptionColorSpace key be must be an RGB CGColorSpaceRef.
* Using this option specifies that the output of the kernel is in this color space.
* If not specified, the output of the kernel is in the working color space of the rendering CIContext. */
CORE_IMAGE_EXPORT NSString * const kCIApplyOptionColorSpace NS_AVAILABLE_MAC(10_4);
/* common filter parameter keys */
CORE_IMAGE_EXPORT NSString * const kCIOutputImageKey NS_AVAILABLE(10_5, 5_0);
CORE_IMAGE_EXPORT NSString * const kCIInputBackgroundImageKey NS_AVAILABLE(10_5, 5_0);
CORE_IMAGE_EXPORT NSString * const kCIInputImageKey NS_AVAILABLE(10_5, 5_0);
CORE_IMAGE_EXPORT NSString * const kCIInputDepthImageKey NS_AVAILABLE(10_13, 11_0);
CORE_IMAGE_EXPORT NSString * const kCIInputDisparityImageKey NS_AVAILABLE(10_13, 11_0);
CORE_IMAGE_EXPORT NSString * const kCIInputAmountKey NS_AVAILABLE(10_14, 12_0);
CORE_IMAGE_EXPORT NSString * const kCIInputTimeKey NS_AVAILABLE(10_5, 7_0);
CORE_IMAGE_EXPORT NSString * const kCIInputTransformKey NS_AVAILABLE(10_5, 7_0);
CORE_IMAGE_EXPORT NSString * const kCIInputScaleKey NS_AVAILABLE(10_5, 7_0);
CORE_IMAGE_EXPORT NSString * const kCIInputAspectRatioKey NS_AVAILABLE(10_5, 7_0);
CORE_IMAGE_EXPORT NSString * const kCIInputCenterKey NS_AVAILABLE(10_5, 7_0);
CORE_IMAGE_EXPORT NSString * const kCIInputRadiusKey NS_AVAILABLE(10_5, 7_0);
CORE_IMAGE_EXPORT NSString * const kCIInputAngleKey NS_AVAILABLE(10_5, 7_0);
CORE_IMAGE_EXPORT NSString * const kCIInputRefractionKey NS_AVAILABLE(10_5, 9_0);
CORE_IMAGE_EXPORT NSString * const kCIInputWidthKey NS_AVAILABLE(10_5, 7_0);
CORE_IMAGE_EXPORT NSString * const kCIInputSharpnessKey NS_AVAILABLE(10_5, 7_0);
CORE_IMAGE_EXPORT NSString * const kCIInputIntensityKey NS_AVAILABLE(10_5, 7_0);
CORE_IMAGE_EXPORT NSString * const kCIInputEVKey NS_AVAILABLE(10_5, 7_0);
CORE_IMAGE_EXPORT NSString * const kCIInputSaturationKey NS_AVAILABLE(10_5, 7_0);
CORE_IMAGE_EXPORT NSString * const kCIInputColorKey NS_AVAILABLE(10_5, 7_0);
CORE_IMAGE_EXPORT NSString * const kCIInputBrightnessKey NS_AVAILABLE(10_5, 7_0);
CORE_IMAGE_EXPORT NSString * const kCIInputContrastKey NS_AVAILABLE(10_5, 7_0);
CORE_IMAGE_EXPORT NSString * const kCIInputBiasKey NS_AVAILABLE(10_5, 9_0);
CORE_IMAGE_EXPORT NSString * const kCIInputWeightsKey NS_AVAILABLE(10_11, 9_0);
CORE_IMAGE_EXPORT NSString * const kCIInputGradientImageKey NS_AVAILABLE(10_5, 9_0);
CORE_IMAGE_EXPORT NSString * const kCIInputMaskImageKey NS_AVAILABLE(10_5, 7_0);
CORE_IMAGE_EXPORT NSString * const kCIInputMatteImageKey NS_AVAILABLE(10_14, 12_0);
CORE_IMAGE_EXPORT NSString * const kCIInputShadingImageKey NS_AVAILABLE(10_5, 9_0);
CORE_IMAGE_EXPORT NSString * const kCIInputTargetImageKey NS_AVAILABLE(10_5, 7_0);
CORE_IMAGE_EXPORT NSString * const kCIInputExtentKey NS_AVAILABLE(10_5, 7_0);
CORE_IMAGE_EXPORT NSString * const kCIInputVersionKey NS_AVAILABLE(10_11, 6_0);
@class CIKernel, CIImage;
@protocol CIFilterConstructor;
/** CIFilter are filter objects for Core Image that encapsulate the filter with its attributes
The CIFilter class produces a CIImage object as output. Typically, a filter takes one or more images as input. Some filters, however, generate an image based on other types of input parameters. The parameters of a CIFilter object are set and retrieved through the use of key-value pairs. You use the CIFilter object in conjunction with the CIImage, CIContext, CIVector, CIImageAccumulator, and CIColor objects to take advantage of the built-in Core Image filters when processing images. CIFilter objects are also used along with CIKernel, CISampler, and CIFilterShape objects to create custom filters. */
NS_CLASS_AVAILABLE(10_4, 5_0)
@interface CIFilter : NSObject <NSSecureCoding, NSCopying>
{
void *_priv[8];
}
@property (readonly, nonatomic, nullable) CIImage *outputImage NS_AVAILABLE(10_10, 5_0);
/* The name of the filter. On OSX and iOS 10, this property is read-write.
* This can be useful when using CIFilters with CoreAnimation or SceneKit.
* For example, to set an attribute of a filter attached to a layer,
* a unique path such as "filters.myExposureFilter.inputEV" could be used.
* CALayer animations may also access filter attributes via key-paths. */
@property (nonatomic, copy) NSString *name;
- (NSString *)name NS_AVAILABLE(10_5,5_0);
- (void)setName:(NSString *)aString NS_AVAILABLE(10_5,10_0);
/* The 'enabled' property is used only by CoreAnimation and is animatable.
* In Core Animation, a CIFilter only applied to its input when this
* property is set to true. */
@property (getter=isEnabled) BOOL enabled NS_AVAILABLE_MAC(10_5);
/** Returns an array containing the names of all inputs in the filter. */
@property (nonatomic, readonly) NSArray<NSString *> *inputKeys;
/** Returns an array containing the names of all outputs in the filter. */
@property (nonatomic, readonly) NSArray<NSString *> *outputKeys;
/** Sets all inputs to their default values (where default values are defined, other inputs are left as-is). */
- (void)setDefaults;
/** Returns a dictionary containing key/value pairs describing the filter. (see description of keys below) */
@property (nonatomic, readonly) NSDictionary<NSString *,id> *attributes;
/** Used by CIFilter subclasses to apply the array of argument values 'args' to the kernel function 'k'. The supplied arguments must be type-compatible with the function signature of the kernel.
The key-value pairs defined by 'dict' (if non-nil) are used to control exactly how the kernel is evaluated. Valid keys include:
kCIApplyOptionExtent: the size of the produced image. Value is a four element NSArray [X Y WIDTH HEIGHT].
kCIApplyOptionDefinition: the Domain of Definition of the produced image. Value is either a CIFilterShape object, or a four element NSArray defining a rectangle.
@param k CIKernel of the filter
@param args Array of arguments that are applied to the kernel
@param dict Array of additional options
*/
- (nullable CIImage *)apply:(CIKernel *)k
arguments:(nullable NSArray *)args
options:(nullable NSDictionary<NSString *,id> *)dict NS_AVAILABLE_MAC(10_4);
/** Similar to above except that all argument values and option key-value are specified inline. The list of key-value pairs must be terminated by the 'nil' object. */
- (nullable CIImage *)apply:(CIKernel *)k, ... NS_REQUIRES_NIL_TERMINATION NS_AVAILABLE_MAC(10_4) NS_SWIFT_UNAVAILABLE("");
@end
@protocol CIFilter
@property (readonly, nonatomic, nullable) CIImage *outputImage;
@optional
// CIFilter subclasses can implement 'customAttributes' to return a dictionary
// containing key/value pairs describing the filter. (see description of keys below)
+ (nullable NSDictionary<NSString *,id>*) customAttributes;
@end
/** Methods to register a filter and get access to the list of registered filters
Use these methods to create filters and find filters. */
@interface CIFilter (CIFilterRegistry)
/** Creates a new filter of type 'name'.
On OSX, all input values will be undefined.
On iOS, all input values will be set to default values. */
+ (nullable CIFilter *) filterWithName:(NSString *) name;
/** Creates a new filter of type 'name'.
The filter's input parameters are set from the list of key-value pairs which must be nil-terminated.
On OSX, any of the filter input parameters not specified in the list will be undefined.
On iOS, any of the filter input parameters not specified in the list will be set to default values. */
+ (nullable CIFilter *)filterWithName:(NSString *)name
keysAndValues:key0, ... NS_REQUIRES_NIL_TERMINATION NS_SWIFT_UNAVAILABLE("");
/** Creates a new filter of type 'name'.
The filter's input parameters are set from the dictionary of key-value pairs.
On OSX, any of the filter input parameters not specified in the dictionary will be undefined.
On iOS, any of the filter input parameters not specified in the dictionary will be set to default values. */
+ (nullable CIFilter *)filterWithName:(NSString *)name
withInputParameters:(nullable NSDictionary<NSString *,id> *)params NS_AVAILABLE(10_10, 8_0);
/** Returns an array containing all published filter names in a category. */
+ (NSArray<NSString *> *)filterNamesInCategory:(nullable NSString *)category;
/** Returns an array containing all published filter names that belong to all listed categories. */
+ (NSArray<NSString *> *)filterNamesInCategories:(nullable NSArray<NSString *> *)categories;
/** Publishes a new filter called 'name'.
The constructor object 'anObject' should implement the filterWithName: method.
That method will be invoked with the name of the filter to create.
The class attributes must have a kCIAttributeFilterCategories key associated with a set of categories.
@param attributes Dictionary of the registration attributes of the filter. See below for attribute keys.
*/
+ (void)registerFilterName:(NSString *)name
constructor:(id<CIFilterConstructor>)anObject
classAttributes:(NSDictionary<NSString *,id> *)attributes NS_AVAILABLE(10_4, 9_0);
/** Returns the localized name of a filter for display in the UI. */
+ (nullable NSString *)localizedNameForFilterName:(NSString *)filterName NS_AVAILABLE(10_4, 9_0);
/** Returns the localized name of a category for display in the UI. */
+ (NSString *)localizedNameForCategory:(NSString *)category NS_AVAILABLE(10_4, 9_0);
/** Returns the localized description of a filter for display in the UI. */
+ (nullable NSString *)localizedDescriptionForFilterName:(NSString *)filterName NS_AVAILABLE(10_4, 9_0);
/** Returns the URL to the localized reference documentation describing the filter.
The URL can be a local file or a remote document on a webserver. It is possible, that this method returns nil (like filters that predate this feature). A client of this API has to handle this case gracefully. */
+ (nullable NSURL *)localizedReferenceDocumentationForFilterName:(NSString *)filterName NS_AVAILABLE(10_4, 9_0);
@end
/** Methods to serialize arrays of filters to xmp. */
@interface CIFilter (CIFilterXMPSerialization)
/* Given an array of filters, serialize the filters' parameters
into XMP form that is suitable for embedding in to an image.
At this time the only filters classes that are serialized
are, CIAffineTransform, CICrop, and the filters returned by
[CIImage autoAdjustmentFilters].
The parameters of other filter classes will not be serialized.
The return value will be null if none of the filters can be serialized.
*/
+ (nullable NSData*)serializedXMPFromFilters:(NSArray<CIFilter *> *)filters
inputImageExtent:(CGRect)extent
NS_AVAILABLE(10_9, 6_0);
/* Return an array of CIFilters de-serialized from XMP data.
*/
+ (NSArray<CIFilter *> *)filterArrayFromSerializedXMP:(NSData *)xmpData
inputImageExtent:(CGRect)extent
error:(NSError **)outError
NS_AVAILABLE(10_9, 6_0);
@end
NS_ASSUME_NONNULL_END
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/CoreImage.framework/Modules/module.modulemap | framework module CoreImage [extern_c] [system] {
umbrella header "CoreImage.h"
export *
module * { export * }
explicit module CIFilterBuiltins {
header "CIFilterBuiltins.h"
export *
}
}
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Security.framework/Security.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: 21FAA1B0-CDFC-3A65-BB1D-83D6D4F17471
- target: x86_64-maccatalyst
value: 21FAA1B0-CDFC-3A65-BB1D-83D6D4F17471
- target: arm64-macos
value: 00000000-0000-0000-0000-000000000000
- target: arm64-maccatalyst
value: 00000000-0000-0000-0000-000000000000
- target: arm64e-macos
value: BC3748B0-15D9-3223-AD86-71600B4E22BA
- target: arm64e-maccatalyst
value: BC3748B0-15D9-3223-AD86-71600B4E22BA
install-name: '/System/Library/Frameworks/Security.framework/Versions/A/Security'
current-version: 60157.30.13
exports:
- targets: [ x86_64-maccatalyst, arm64e-maccatalyst, arm64-maccatalyst ]
symbols: [ _SecKeyRawSign, _SecKeyRawVerify ]
- targets: [ arm64e-macos, x86_64-macos, x86_64-maccatalyst, arm64e-maccatalyst,
arm64-macos, arm64-maccatalyst ]
symbols: [ _ApplyScopeDictionaryForID, _ApplyScopeListForID, _AuthorizationCopyInfo,
_AuthorizationCopyPreloginPreferencesValue, _AuthorizationCopyPreloginUserDatabase,
_AuthorizationCopyPrivilegedReference, _AuthorizationCopyRightProperties,
_AuthorizationCopyRights, _AuthorizationCopyRightsAsync, _AuthorizationCreate,
_AuthorizationCreateFromExternalForm, _AuthorizationCreateWithAuditToken,
_AuthorizationDismiss, _AuthorizationEnableSmartCard, _AuthorizationExecuteWithPrivileges,
_AuthorizationExecuteWithPrivilegesExternalForm, _AuthorizationExecuteWithPrivilegesExternalFormInternal,
_AuthorizationExecuteWithPrivilegesInternal, _AuthorizationFree,
_AuthorizationFreeItemSet, _AuthorizationHandlePreloginOverride,
_AuthorizationMakeExternalForm, _AuthorizationRightGet, _AuthorizationRightRemove,
_AuthorizationRightSet, _CFArrayOfSOSPeerInfosSortByID, _CFDataCreateWithDER,
_CFPropertyListCreateDERData, _CFPropertyListCreateWithDERData,
_CFSetCreateMutableForSOSPeerInfosByID, _CFSetCreateMutableForSOSPeerInfosByIDWithArray,
_CKDKVSPerfCounterIncomingMessages, _CKDKVSPerfCounterLongestWaitTimeSynchronize,
_CKDKVSPerfCounterOutgoingMessages, _CKDKVSPerfCounterSynchronize,
_CKDKVSPerfCounterSynchronizeFailures, _CKDKVSPerfCounterSynchronizeWithCompletionHandler,
_CKDKVSPerfCounterTotalWaitTimeSynchronize, _CKDKVSPerformanceCountersSampler,
_CKKSSEViewPTA, _CKKSSEViewPTC, _CKKSSetupControlProtocol,
_CMSDecoderCopyAllCerts, _CMSDecoderCopyContent, _CMSDecoderCopyDetachedContent,
_CMSDecoderCopyEncapsulatedContentType, _CMSDecoderCopySignerAppleCodesigningHashAgility,
_CMSDecoderCopySignerAppleCodesigningHashAgilityV2, _CMSDecoderCopySignerAppleExpirationTime,
_CMSDecoderCopySignerCert, _CMSDecoderCopySignerEmailAddress,
_CMSDecoderCopySignerSigningTime, _CMSDecoderCopySignerStatus,
_CMSDecoderCopySignerTimestamp, _CMSDecoderCopySignerTimestampCertificates,
_CMSDecoderCopySignerTimestampWithPolicy, _CMSDecoderCreate,
_CMSDecoderFinalizeMessage, _CMSDecoderGetCmsMessage, _CMSDecoderGetDecoder,
_CMSDecoderGetNumSigners, _CMSDecoderGetTypeID, _CMSDecoderIsContentEncrypted,
_CMSDecoderSetDecoder, _CMSDecoderSetDetachedContent, _CMSDecoderUpdateMessage,
_CMSEncodeContent, _CMSEncoderAddRecipients, _CMSEncoderAddSignedAttributes,
_CMSEncoderAddSigners, _CMSEncoderAddSupportingCerts, _CMSEncoderCopyEncapsulatedContentType,
_CMSEncoderCopyEncodedContent, _CMSEncoderCopyRecipients,
_CMSEncoderCopySignerTimestamp, _CMSEncoderCopySignerTimestampWithPolicy,
_CMSEncoderCopySigners, _CMSEncoderCopySupportingCerts, _CMSEncoderCreate,
_CMSEncoderGetCertificateChainMode, _CMSEncoderGetCmsMessage,
_CMSEncoderGetEncoder, _CMSEncoderGetHasDetachedContent, _CMSEncoderGetTypeID,
_CMSEncoderSetAppleCodesigningHashAgility, _CMSEncoderSetAppleCodesigningHashAgilityV2,
_CMSEncoderSetAppleExpirationTime, _CMSEncoderSetCertificateChainMode,
_CMSEncoderSetEncapsulatedContentTypeOID, _CMSEncoderSetEncoder,
_CMSEncoderSetHasDetachedContent, _CMSEncoderSetSignerAlgorithm,
_CMSEncoderSetSigningTime, _CMSEncoderUpdateContent, _CSSMOID_ADC_CERT_POLICY,
_CSSMOID_AD_CA_ISSUERS, _CSSMOID_AD_CA_REPOSITORY, _CSSMOID_AD_OCSP,
_CSSMOID_AD_TIME_STAMPING, _CSSMOID_ANSI_DH_EPHEM, _CSSMOID_ANSI_DH_EPHEM_SHA1,
_CSSMOID_ANSI_DH_HYBRID1, _CSSMOID_ANSI_DH_HYBRID1_SHA1, _CSSMOID_ANSI_DH_HYBRID2,
_CSSMOID_ANSI_DH_HYBRID2_SHA1, _CSSMOID_ANSI_DH_HYBRID_ONEFLOW,
_CSSMOID_ANSI_DH_ONE_FLOW, _CSSMOID_ANSI_DH_ONE_FLOW_SHA1,
_CSSMOID_ANSI_DH_PUB_NUMBER, _CSSMOID_ANSI_DH_STATIC, _CSSMOID_ANSI_DH_STATIC_SHA1,
_CSSMOID_ANSI_MQV1, _CSSMOID_ANSI_MQV1_SHA1, _CSSMOID_ANSI_MQV2,
_CSSMOID_ANSI_MQV2_SHA1, _CSSMOID_APPLEID_CERT_POLICY, _CSSMOID_APPLEID_SHARING_CERT_POLICY,
_CSSMOID_APPLE_ASC, _CSSMOID_APPLE_CERT_POLICY, _CSSMOID_APPLE_ECDSA,
_CSSMOID_APPLE_EKU_CODE_SIGNING, _CSSMOID_APPLE_EKU_CODE_SIGNING_DEV,
_CSSMOID_APPLE_EKU_ICHAT_ENCRYPTION, _CSSMOID_APPLE_EKU_ICHAT_SIGNING,
_CSSMOID_APPLE_EKU_PASSBOOK_SIGNING, _CSSMOID_APPLE_EKU_PROFILE_SIGNING,
_CSSMOID_APPLE_EKU_QA_PROFILE_SIGNING, _CSSMOID_APPLE_EKU_RESOURCE_SIGNING,
_CSSMOID_APPLE_EKU_SYSTEM_IDENTITY, _CSSMOID_APPLE_EXTENSION,
_CSSMOID_APPLE_EXTENSION_AAI_INTERMEDIATE, _CSSMOID_APPLE_EXTENSION_ADC_APPLE_SIGNING,
_CSSMOID_APPLE_EXTENSION_ADC_DEV_SIGNING, _CSSMOID_APPLE_EXTENSION_APPLEID_INTERMEDIATE,
_CSSMOID_APPLE_EXTENSION_APPLEID_SHARING, _CSSMOID_APPLE_EXTENSION_APPLE_SIGNING,
_CSSMOID_APPLE_EXTENSION_CODE_SIGNING, _CSSMOID_APPLE_EXTENSION_DEVELOPER_AUTHENTICATION,
_CSSMOID_APPLE_EXTENSION_ESCROW_SERVICE, _CSSMOID_APPLE_EXTENSION_INTERMEDIATE_MARKER,
_CSSMOID_APPLE_EXTENSION_ITMS_INTERMEDIATE, _CSSMOID_APPLE_EXTENSION_MACAPPSTORE_RECEIPT,
_CSSMOID_APPLE_EXTENSION_PASSBOOK_SIGNING, _CSSMOID_APPLE_EXTENSION_PROVISIONING_PROFILE_SIGNING,
_CSSMOID_APPLE_EXTENSION_SERVER_AUTHENTICATION, _CSSMOID_APPLE_EXTENSION_SYSINT2_INTERMEDIATE,
_CSSMOID_APPLE_EXTENSION_WWDR_INTERMEDIATE, _CSSMOID_APPLE_FEE,
_CSSMOID_APPLE_FEED, _CSSMOID_APPLE_FEEDEXP, _CSSMOID_APPLE_FEE_MD5,
_CSSMOID_APPLE_FEE_SHA1, _CSSMOID_APPLE_ISIGN, _CSSMOID_APPLE_TP_APPLEID_SHARING,
_CSSMOID_APPLE_TP_CODE_SIGN, _CSSMOID_APPLE_TP_CODE_SIGNING,
_CSSMOID_APPLE_TP_CSR_GEN, _CSSMOID_APPLE_TP_EAP, _CSSMOID_APPLE_TP_ESCROW_SERVICE,
_CSSMOID_APPLE_TP_ICHAT, _CSSMOID_APPLE_TP_IP_SEC, _CSSMOID_APPLE_TP_LOCAL_CERT_GEN,
_CSSMOID_APPLE_TP_MACAPPSTORE_RECEIPT, _CSSMOID_APPLE_TP_MOBILE_STORE,
_CSSMOID_APPLE_TP_PACKAGE_SIGNING, _CSSMOID_APPLE_TP_PASSBOOK_SIGNING,
_CSSMOID_APPLE_TP_PCS_ESCROW_SERVICE, _CSSMOID_APPLE_TP_PKINIT_CLIENT,
_CSSMOID_APPLE_TP_PKINIT_SERVER, _CSSMOID_APPLE_TP_PROFILE_SIGNING,
_CSSMOID_APPLE_TP_PROVISIONING_PROFILE_SIGNING, _CSSMOID_APPLE_TP_QA_PROFILE_SIGNING,
_CSSMOID_APPLE_TP_RESOURCE_SIGN, _CSSMOID_APPLE_TP_REVOCATION,
_CSSMOID_APPLE_TP_REVOCATION_CRL, _CSSMOID_APPLE_TP_REVOCATION_OCSP,
_CSSMOID_APPLE_TP_SMIME, _CSSMOID_APPLE_TP_SSL, _CSSMOID_APPLE_TP_SW_UPDATE_SIGNING,
_CSSMOID_APPLE_TP_TEST_MOBILE_STORE, _CSSMOID_APPLE_TP_TIMESTAMPING,
_CSSMOID_APPLE_X509_BASIC, _CSSMOID_AliasedEntryName, _CSSMOID_AuthorityInfoAccess,
_CSSMOID_AuthorityKeyIdentifier, _CSSMOID_AuthorityRevocationList,
_CSSMOID_BasicConstraints, _CSSMOID_BiometricInfo, _CSSMOID_BusinessCategory,
_CSSMOID_CACertificate, _CSSMOID_CSSMKeyStruct, _CSSMOID_CertIssuer,
_CSSMOID_Certicom, _CSSMOID_CerticomEllCurve, _CSSMOID_CertificatePolicies,
_CSSMOID_CertificateRevocationList, _CSSMOID_ChallengePassword,
_CSSMOID_ClientAuth, _CSSMOID_CollectiveFacsimileTelephoneNumber,
_CSSMOID_CollectiveInternationalISDNNumber, _CSSMOID_CollectiveOrganizationName,
_CSSMOID_CollectiveOrganizationalUnitName, _CSSMOID_CollectivePhysicalDeliveryOfficeName,
_CSSMOID_CollectivePostOfficeBox, _CSSMOID_CollectivePostalAddress,
_CSSMOID_CollectivePostalCode, _CSSMOID_CollectiveStateProvinceName,
_CSSMOID_CollectiveStreetAddress, _CSSMOID_CollectiveTelephoneNumber,
_CSSMOID_CollectiveTelexNumber, _CSSMOID_CollectiveTelexTerminalIdentifier,
_CSSMOID_CommonName, _CSSMOID_ContentType, _CSSMOID_CounterSignature,
_CSSMOID_CountryName, _CSSMOID_CrlDistributionPoints, _CSSMOID_CrlNumber,
_CSSMOID_CrlReason, _CSSMOID_CrossCertificatePair, _CSSMOID_DES_CBC,
_CSSMOID_DH, _CSSMOID_DNQualifier, _CSSMOID_DOTMAC_CERT, _CSSMOID_DOTMAC_CERT_EMAIL_ENCRYPT,
_CSSMOID_DOTMAC_CERT_EMAIL_SIGN, _CSSMOID_DOTMAC_CERT_EXTENSION,
_CSSMOID_DOTMAC_CERT_IDENTITY, _CSSMOID_DOTMAC_CERT_POLICY,
_CSSMOID_DOTMAC_CERT_REQ, _CSSMOID_DOTMAC_CERT_REQ_ARCHIVE_FETCH,
_CSSMOID_DOTMAC_CERT_REQ_ARCHIVE_LIST, _CSSMOID_DOTMAC_CERT_REQ_ARCHIVE_REMOVE,
_CSSMOID_DOTMAC_CERT_REQ_ARCHIVE_STORE, _CSSMOID_DOTMAC_CERT_REQ_EMAIL_ENCRYPT,
_CSSMOID_DOTMAC_CERT_REQ_EMAIL_SIGN, _CSSMOID_DOTMAC_CERT_REQ_IDENTITY,
_CSSMOID_DOTMAC_CERT_REQ_SHARED_SERVICES, _CSSMOID_DOTMAC_CERT_REQ_VALUE_ASYNC,
_CSSMOID_DOTMAC_CERT_REQ_VALUE_HOSTNAME, _CSSMOID_DOTMAC_CERT_REQ_VALUE_IS_PENDING,
_CSSMOID_DOTMAC_CERT_REQ_VALUE_PASSWORD, _CSSMOID_DOTMAC_CERT_REQ_VALUE_RENEW,
_CSSMOID_DOTMAC_CERT_REQ_VALUE_USERNAME, _CSSMOID_DSA, _CSSMOID_DSA_CMS,
_CSSMOID_DSA_JDK, _CSSMOID_DeltaCrlIndicator, _CSSMOID_Description,
_CSSMOID_DestinationIndicator, _CSSMOID_DistinguishedName,
_CSSMOID_DomainComponent, _CSSMOID_ECDSA_WithSHA1, _CSSMOID_ECDSA_WithSHA224,
_CSSMOID_ECDSA_WithSHA256, _CSSMOID_ECDSA_WithSHA384, _CSSMOID_ECDSA_WithSHA512,
_CSSMOID_ECDSA_WithSpecified, _CSSMOID_EKU_IPSec, _CSSMOID_ETSI_QCS_QC_COMPLIANCE,
_CSSMOID_ETSI_QCS_QC_LIMIT_VALUE, _CSSMOID_ETSI_QCS_QC_RETENTION,
_CSSMOID_ETSI_QCS_QC_SSCD, _CSSMOID_EmailAddress, _CSSMOID_EmailProtection,
_CSSMOID_EnhancedSearchGuide, _CSSMOID_ExtendedCertificateAttributes,
_CSSMOID_ExtendedKeyUsage, _CSSMOID_ExtendedKeyUsageAny, _CSSMOID_ExtendedUseCodeSigning,
_CSSMOID_FacsimileTelephoneNumber, _CSSMOID_GenerationQualifier,
_CSSMOID_GivenName, _CSSMOID_HoldInstructionCode, _CSSMOID_HouseIdentifier,
_CSSMOID_InhibitAnyPolicy, _CSSMOID_Initials, _CSSMOID_InternationalISDNNumber,
_CSSMOID_InvalidityDate, _CSSMOID_IssuerAltName, _CSSMOID_IssuingDistributionPoint,
_CSSMOID_IssuingDistributionPoints, _CSSMOID_KERBv5_PKINIT_AUTH_DATA,
_CSSMOID_KERBv5_PKINIT_DH_KEY_DATA, _CSSMOID_KERBv5_PKINIT_KP_CLIENT_AUTH,
_CSSMOID_KERBv5_PKINIT_KP_KDC, _CSSMOID_KERBv5_PKINIT_RKEY_DATA,
_CSSMOID_KeyUsage, _CSSMOID_KnowledgeInformation, _CSSMOID_LocalityName,
_CSSMOID_MACAPPSTORE_CERT_POLICY, _CSSMOID_MACAPPSTORE_RECEIPT_CERT_POLICY,
_CSSMOID_MD2, _CSSMOID_MD2WithRSA, _CSSMOID_MD4, _CSSMOID_MD4WithRSA,
_CSSMOID_MD5, _CSSMOID_MD5WithRSA, _CSSMOID_MOBILE_STORE_SIGNING_POLICY,
_CSSMOID_Member, _CSSMOID_MessageDigest, _CSSMOID_MicrosoftSGC,
_CSSMOID_Name, _CSSMOID_NameConstraints, _CSSMOID_NetscapeCertSequence,
_CSSMOID_NetscapeCertType, _CSSMOID_NetscapeSGC, _CSSMOID_OAEP_ID_PSPECIFIED,
_CSSMOID_OAEP_MGF1, _CSSMOID_OCSPSigning, _CSSMOID_OID_QCS_SYNTAX_V1,
_CSSMOID_OID_QCS_SYNTAX_V2, _CSSMOID_ObjectClass, _CSSMOID_OrganizationName,
_CSSMOID_OrganizationalUnitName, _CSSMOID_Owner, _CSSMOID_PDA_COUNTRY_CITIZEN,
_CSSMOID_PDA_COUNTRY_RESIDENCE, _CSSMOID_PDA_DATE_OF_BIRTH,
_CSSMOID_PDA_GENDER, _CSSMOID_PDA_PLACE_OF_BIRTH, _CSSMOID_PKCS12_certBag,
_CSSMOID_PKCS12_crlBag, _CSSMOID_PKCS12_keyBag, _CSSMOID_PKCS12_pbeWithSHAAnd128BitRC2CBC,
_CSSMOID_PKCS12_pbeWithSHAAnd128BitRC4, _CSSMOID_PKCS12_pbeWithSHAAnd2Key3DESCBC,
_CSSMOID_PKCS12_pbeWithSHAAnd3Key3DESCBC, _CSSMOID_PKCS12_pbeWithSHAAnd40BitRC4,
_CSSMOID_PKCS12_pbewithSHAAnd40BitRC2CBC, _CSSMOID_PKCS12_safeContentsBag,
_CSSMOID_PKCS12_secretBag, _CSSMOID_PKCS12_shroudedKeyBag,
_CSSMOID_PKCS3, _CSSMOID_PKCS5_DES_EDE3_CBC, _CSSMOID_PKCS5_DIGEST_ALG,
_CSSMOID_PKCS5_ENCRYPT_ALG, _CSSMOID_PKCS5_HMAC_SHA1, _CSSMOID_PKCS5_PBES2,
_CSSMOID_PKCS5_PBKDF2, _CSSMOID_PKCS5_PBMAC1, _CSSMOID_PKCS5_RC2_CBC,
_CSSMOID_PKCS5_RC5_CBC, _CSSMOID_PKCS5_pbeWithMD2AndDES, _CSSMOID_PKCS5_pbeWithMD2AndRC2,
_CSSMOID_PKCS5_pbeWithMD5AndDES, _CSSMOID_PKCS5_pbeWithMD5AndRC2,
_CSSMOID_PKCS5_pbeWithSHA1AndDES, _CSSMOID_PKCS5_pbeWithSHA1AndRC2,
_CSSMOID_PKCS7_Data, _CSSMOID_PKCS7_DataWithAttributes, _CSSMOID_PKCS7_DigestedData,
_CSSMOID_PKCS7_EncryptedData, _CSSMOID_PKCS7_EncryptedPrivateKeyInfo,
_CSSMOID_PKCS7_EnvelopedData, _CSSMOID_PKCS7_SignedAndEnvelopedData,
_CSSMOID_PKCS7_SignedData, _CSSMOID_PKCS9_CertTypes, _CSSMOID_PKCS9_CrlTypes,
_CSSMOID_PKCS9_FriendlyName, _CSSMOID_PKCS9_Id_Ct_TSTInfo,
_CSSMOID_PKCS9_LocalKeyId, _CSSMOID_PKCS9_SdsiCertificate,
_CSSMOID_PKCS9_TimeStampToken, _CSSMOID_PKCS9_X509Certificate,
_CSSMOID_PKCS9_X509Crl, _CSSMOID_PKIX_OCSP, _CSSMOID_PKIX_OCSP_ARCHIVE_CUTOFF,
_CSSMOID_PKIX_OCSP_BASIC, _CSSMOID_PKIX_OCSP_CRL, _CSSMOID_PKIX_OCSP_NOCHECK,
_CSSMOID_PKIX_OCSP_NONCE, _CSSMOID_PKIX_OCSP_RESPONSE, _CSSMOID_PKIX_OCSP_SERVICE_LOCATOR,
_CSSMOID_PhysicalDeliveryOfficeName, _CSSMOID_PolicyConstraints,
_CSSMOID_PolicyMappings, _CSSMOID_PostOfficeBox, _CSSMOID_PostalAddress,
_CSSMOID_PostalCode, _CSSMOID_PreferredDeliveryMethod, _CSSMOID_PresentationAddress,
_CSSMOID_PrivateKeyUsagePeriod, _CSSMOID_ProtocolInformation,
_CSSMOID_QC_Statements, _CSSMOID_QT_CPS, _CSSMOID_QT_UNOTICE,
_CSSMOID_RSA, _CSSMOID_RSAWithOAEP, _CSSMOID_RegisteredAddress,
_CSSMOID_RoleOccupant, _CSSMOID_SHA1, _CSSMOID_SHA1WithDSA,
_CSSMOID_SHA1WithDSA_CMS, _CSSMOID_SHA1WithDSA_JDK, _CSSMOID_SHA1WithRSA,
_CSSMOID_SHA1WithRSA_OIW, _CSSMOID_SHA224, _CSSMOID_SHA224WithRSA,
_CSSMOID_SHA256, _CSSMOID_SHA256WithRSA, _CSSMOID_SHA384,
_CSSMOID_SHA384WithRSA, _CSSMOID_SHA512, _CSSMOID_SHA512WithRSA,
_CSSMOID_SearchGuide, _CSSMOID_SeeAlso, _CSSMOID_SerialNumber,
_CSSMOID_ServerAuth, _CSSMOID_SigningTime, _CSSMOID_StateProvinceName,
_CSSMOID_StreetAddress, _CSSMOID_SubjectAltName, _CSSMOID_SubjectDirectoryAttributes,
_CSSMOID_SubjectEmailAddress, _CSSMOID_SubjectInfoAccess,
_CSSMOID_SubjectKeyIdentifier, _CSSMOID_SubjectPicture, _CSSMOID_SubjectSignatureBitmap,
_CSSMOID_SupportedApplicationContext, _CSSMOID_Surname, _CSSMOID_TEST_MOBILE_STORE_SIGNING_POLICY,
_CSSMOID_TelephoneNumber, _CSSMOID_TelexNumber, _CSSMOID_TelexTerminalIdentifier,
_CSSMOID_TimeStamping, _CSSMOID_Title, _CSSMOID_UniqueIdentifier,
_CSSMOID_UniqueMember, _CSSMOID_UnstructuredAddress, _CSSMOID_UnstructuredName,
_CSSMOID_UseExemptions, _CSSMOID_UserCertificate, _CSSMOID_UserID,
_CSSMOID_UserPassword, _CSSMOID_X509V1CRLIssuerNameCStruct,
_CSSMOID_X509V1CRLIssuerNameLDAP, _CSSMOID_X509V1CRLIssuerStruct,
_CSSMOID_X509V1CRLNextUpdate, _CSSMOID_X509V1CRLNumberOfRevokedCertEntries,
_CSSMOID_X509V1CRLRevokedCertificatesCStruct, _CSSMOID_X509V1CRLRevokedCertificatesStruct,
_CSSMOID_X509V1CRLRevokedEntryCStruct, _CSSMOID_X509V1CRLRevokedEntryRevocationDate,
_CSSMOID_X509V1CRLRevokedEntrySerialNumber, _CSSMOID_X509V1CRLRevokedEntryStruct,
_CSSMOID_X509V1CRLThisUpdate, _CSSMOID_X509V1CertificateIssuerUniqueId,
_CSSMOID_X509V1CertificateSubjectUniqueId, _CSSMOID_X509V1IssuerName,
_CSSMOID_X509V1IssuerNameCStruct, _CSSMOID_X509V1IssuerNameLDAP,
_CSSMOID_X509V1IssuerNameStd, _CSSMOID_X509V1SerialNumber,
_CSSMOID_X509V1Signature, _CSSMOID_X509V1SignatureAlgorithm,
_CSSMOID_X509V1SignatureAlgorithmParameters, _CSSMOID_X509V1SignatureAlgorithmTBS,
_CSSMOID_X509V1SignatureCStruct, _CSSMOID_X509V1SignatureStruct,
_CSSMOID_X509V1SubjectName, _CSSMOID_X509V1SubjectNameCStruct,
_CSSMOID_X509V1SubjectNameLDAP, _CSSMOID_X509V1SubjectNameStd,
_CSSMOID_X509V1SubjectPublicKey, _CSSMOID_X509V1SubjectPublicKeyAlgorithm,
_CSSMOID_X509V1SubjectPublicKeyAlgorithmParameters, _CSSMOID_X509V1SubjectPublicKeyCStruct,
_CSSMOID_X509V1ValidityNotAfter, _CSSMOID_X509V1ValidityNotBefore,
_CSSMOID_X509V1Version, _CSSMOID_X509V2CRLAllExtensionsCStruct,
_CSSMOID_X509V2CRLAllExtensionsStruct, _CSSMOID_X509V2CRLExtensionCritical,
_CSSMOID_X509V2CRLExtensionId, _CSSMOID_X509V2CRLExtensionType,
_CSSMOID_X509V2CRLNumberOfExtensions, _CSSMOID_X509V2CRLRevokedEntryAllExtensionsCStruct,
_CSSMOID_X509V2CRLRevokedEntryAllExtensionsStruct, _CSSMOID_X509V2CRLRevokedEntryExtensionCritical,
_CSSMOID_X509V2CRLRevokedEntryExtensionId, _CSSMOID_X509V2CRLRevokedEntryExtensionType,
_CSSMOID_X509V2CRLRevokedEntryExtensionValue, _CSSMOID_X509V2CRLRevokedEntryNumberOfExtensions,
_CSSMOID_X509V2CRLRevokedEntrySingleExtensionCStruct, _CSSMOID_X509V2CRLRevokedEntrySingleExtensionStruct,
_CSSMOID_X509V2CRLSignedCrlCStruct, _CSSMOID_X509V2CRLSignedCrlStruct,
_CSSMOID_X509V2CRLSingleExtensionCStruct, _CSSMOID_X509V2CRLSingleExtensionStruct,
_CSSMOID_X509V2CRLTbsCertListCStruct, _CSSMOID_X509V2CRLTbsCertListStruct,
_CSSMOID_X509V2CRLVersion, _CSSMOID_X509V3Certificate, _CSSMOID_X509V3CertificateCStruct,
_CSSMOID_X509V3CertificateExtensionCStruct, _CSSMOID_X509V3CertificateExtensionCritical,
_CSSMOID_X509V3CertificateExtensionId, _CSSMOID_X509V3CertificateExtensionStruct,
_CSSMOID_X509V3CertificateExtensionType, _CSSMOID_X509V3CertificateExtensionValue,
_CSSMOID_X509V3CertificateExtensionsCStruct, _CSSMOID_X509V3CertificateExtensionsStruct,
_CSSMOID_X509V3CertificateNumberOfExtensions, _CSSMOID_X509V3SignedCertificate,
_CSSMOID_X509V3SignedCertificateCStruct, _CSSMOID_X9_62, _CSSMOID_X9_62_C_TwoCurve,
_CSSMOID_X9_62_EllCurve, _CSSMOID_X9_62_FieldType, _CSSMOID_X9_62_PrimeCurve,
_CSSMOID_X9_62_PubKeyType, _CSSMOID_X9_62_SigType, _CSSMOID_X_121Address,
_CSSMOID_ecPublicKey, _CSSMOID_secp112r1, _CSSMOID_secp112r2,
_CSSMOID_secp128r1, _CSSMOID_secp128r2, _CSSMOID_secp160k1,
_CSSMOID_secp160r1, _CSSMOID_secp160r2, _CSSMOID_secp192k1,
_CSSMOID_secp192r1, _CSSMOID_secp224k1, _CSSMOID_secp224r1,
_CSSMOID_secp256k1, _CSSMOID_secp256r1, _CSSMOID_secp384r1,
_CSSMOID_secp521r1, _CSSMOID_sect113r1, _CSSMOID_sect113r2,
_CSSMOID_sect131r1, _CSSMOID_sect131r2, _CSSMOID_sect163k1,
_CSSMOID_sect163r1, _CSSMOID_sect163r2, _CSSMOID_sect193r1,
_CSSMOID_sect193r2, _CSSMOID_sect233k1, _CSSMOID_sect233r1,
_CSSMOID_sect239k1, _CSSMOID_sect283k1, _CSSMOID_sect283r1,
_CSSMOID_sect409k1, _CSSMOID_sect409r1, _CSSMOID_sect571k1,
_CSSMOID_sect571r1, _CSSM_AC_AuthCompute, _CSSM_AC_PassThrough,
_CSSM_CL_CertAbortCache, _CSSM_CL_CertAbortQuery, _CSSM_CL_CertCache,
_CSSM_CL_CertCreateTemplate, _CSSM_CL_CertDescribeFormat,
_CSSM_CL_CertGetAllFields, _CSSM_CL_CertGetAllTemplateFields,
_CSSM_CL_CertGetFirstCachedFieldValue, _CSSM_CL_CertGetFirstFieldValue,
_CSSM_CL_CertGetKeyInfo, _CSSM_CL_CertGetNextCachedFieldValue,
_CSSM_CL_CertGetNextFieldValue, _CSSM_CL_CertGroupFromVerifiedBundle,
_CSSM_CL_CertGroupToSignedBundle, _CSSM_CL_CertSign, _CSSM_CL_CertVerify,
_CSSM_CL_CertVerifyWithKey, _CSSM_CL_CrlAbortCache, _CSSM_CL_CrlAbortQuery,
_CSSM_CL_CrlAddCert, _CSSM_CL_CrlCache, _CSSM_CL_CrlCreateTemplate,
_CSSM_CL_CrlDescribeFormat, _CSSM_CL_CrlGetAllCachedRecordFields,
_CSSM_CL_CrlGetAllFields, _CSSM_CL_CrlGetFirstCachedFieldValue,
_CSSM_CL_CrlGetFirstFieldValue, _CSSM_CL_CrlGetNextCachedFieldValue,
_CSSM_CL_CrlGetNextFieldValue, _CSSM_CL_CrlRemoveCert, _CSSM_CL_CrlSetFields,
_CSSM_CL_CrlSign, _CSSM_CL_CrlVerify, _CSSM_CL_CrlVerifyWithKey,
_CSSM_CL_FreeFieldValue, _CSSM_CL_FreeFields, _CSSM_CL_IsCertInCachedCrl,
_CSSM_CL_IsCertInCrl, _CSSM_CL_PassThrough, _CSSM_CSP_ChangeLoginAcl,
_CSSM_CSP_ChangeLoginOwner, _CSSM_CSP_CreateAsymmetricContext,
_CSSM_CSP_CreateDeriveKeyContext, _CSSM_CSP_CreateDigestContext,
_CSSM_CSP_CreateKeyGenContext, _CSSM_CSP_CreateMacContext,
_CSSM_CSP_CreatePassThroughContext, _CSSM_CSP_CreateRandomGenContext,
_CSSM_CSP_CreateSignatureContext, _CSSM_CSP_CreateSymmetricContext,
_CSSM_CSP_GetLoginAcl, _CSSM_CSP_GetLoginOwner, _CSSM_CSP_GetOperationalStatistics,
_CSSM_CSP_Login, _CSSM_CSP_Logout, _CSSM_CSP_ObtainPrivateKeyFromPublicKey,
_CSSM_CSP_PassThrough, _CSSM_ChangeKeyAcl, _CSSM_ChangeKeyOwner,
_CSSM_DL_Authenticate, _CSSM_DL_ChangeDbAcl, _CSSM_DL_ChangeDbOwner,
_CSSM_DL_CreateRelation, _CSSM_DL_DataAbortQuery, _CSSM_DL_DataDelete,
_CSSM_DL_DataGetFirst, _CSSM_DL_DataGetFromUniqueRecordId,
_CSSM_DL_DataGetNext, _CSSM_DL_DataInsert, _CSSM_DL_DataModify,
_CSSM_DL_DbClose, _CSSM_DL_DbCreate, _CSSM_DL_DbDelete, _CSSM_DL_DbOpen,
_CSSM_DL_DestroyRelation, _CSSM_DL_FreeNameList, _CSSM_DL_FreeUniqueRecord,
_CSSM_DL_GetDbAcl, _CSSM_DL_GetDbNameFromHandle, _CSSM_DL_GetDbNames,
_CSSM_DL_GetDbOwner, _CSSM_DL_PassThrough, _CSSM_DecryptData,
_CSSM_DecryptDataFinal, _CSSM_DecryptDataInit, _CSSM_DecryptDataInitP,
_CSSM_DecryptDataP, _CSSM_DecryptDataUpdate, _CSSM_DeleteContext,
_CSSM_DeleteContextAttributes, _CSSM_DeriveKey, _CSSM_DigestData,
_CSSM_DigestDataClone, _CSSM_DigestDataFinal, _CSSM_DigestDataInit,
_CSSM_DigestDataUpdate, _CSSM_EncryptData, _CSSM_EncryptDataFinal,
_CSSM_EncryptDataInit, _CSSM_EncryptDataInitP, _CSSM_EncryptDataP,
_CSSM_EncryptDataUpdate, _CSSM_FreeContext, _CSSM_FreeKey,
_CSSM_GenerateAlgorithmParams, _CSSM_GenerateKey, _CSSM_GenerateKeyP,
_CSSM_GenerateKeyPair, _CSSM_GenerateKeyPairP, _CSSM_GenerateMac,
_CSSM_GenerateMacFinal, _CSSM_GenerateMacInit, _CSSM_GenerateMacUpdate,
_CSSM_GenerateRandom, _CSSM_GetAPIMemoryFunctions, _CSSM_GetContext,
_CSSM_GetContextAttribute, _CSSM_GetKeyAcl, _CSSM_GetKeyOwner,
_CSSM_GetModuleGUIDFromHandle, _CSSM_GetPrivilege, _CSSM_GetSubserviceUIDFromHandle,
_CSSM_GetTimeValue, _CSSM_Init, _CSSM_Introduce, _CSSM_ListAttachedModuleManagers,
_CSSM_ModuleAttach, _CSSM_ModuleDetach, _CSSM_ModuleLoad,
_CSSM_ModuleUnload, _CSSM_QueryKeySizeInBits, _CSSM_QuerySize,
_CSSM_RetrieveCounter, _CSSM_RetrieveUniqueId, _CSSM_SetContext,
_CSSM_SetPrivilege, _CSSM_SignData, _CSSM_SignDataFinal, _CSSM_SignDataInit,
_CSSM_SignDataUpdate, _CSSM_TP_ApplyCrlToDb, _CSSM_TP_CertCreateTemplate,
_CSSM_TP_CertGetAllTemplateFields, _CSSM_TP_CertGroupConstruct,
_CSSM_TP_CertGroupPrune, _CSSM_TP_CertGroupToTupleGroup, _CSSM_TP_CertGroupVerify,
_CSSM_TP_CertReclaimAbort, _CSSM_TP_CertReclaimKey, _CSSM_TP_CertRemoveFromCrlTemplate,
_CSSM_TP_CertRevoke, _CSSM_TP_CertSign, _CSSM_TP_ConfirmCredResult,
_CSSM_TP_CrlCreateTemplate, _CSSM_TP_CrlSign, _CSSM_TP_CrlVerify,
_CSSM_TP_FormRequest, _CSSM_TP_FormSubmit, _CSSM_TP_PassThrough,
_CSSM_TP_ReceiveConfirmation, _CSSM_TP_RetrieveCredResult,
_CSSM_TP_SubmitCredRequest, _CSSM_TP_TupleGroupToCertGroup,
_CSSM_Terminate, _CSSM_Unintroduce, _CSSM_UnwrapKey, _CSSM_UnwrapKeyP,
_CSSM_UpdateContextAttributes, _CSSM_VerifyData, _CSSM_VerifyDataFinal,
_CSSM_VerifyDataInit, _CSSM_VerifyDataUpdate, _CSSM_VerifyDevice,
_CSSM_VerifyMac, _CSSM_VerifyMacFinal, _CSSM_VerifyMacInit,
_CSSM_VerifyMacUpdate, _CSSM_WrapKey, _CSSM_WrapKeyP, _CmsMessageSetTSAContext,
_CopyCurrentScopePlist, _CreateArrayOfPeerInfoWithXPCObject,
_CreateCFDataFromBase64CFString, _CreatePrivateKeyMatchingQuery,
_CreateXPCObjectWithArrayOfPeerInfo, _CreateXPCObjectWithCFSetRef,
_CuttlefishErrorDomain, _CuttlefishErrorRetryAfterKey, _GenerateECPair,
_GeneratePermanentECPair, _LKABackupReportEnd, _LKABackupReportStart,
_LKAEventStash, _LKAEventStashLoad, _LKAEventUpgrade, _LKAForceClose,
_LKAReportKeychainUpgradeOutcome, _LKAReportKeychainUpgradeOutcomeWithError,
_MDS_Initialize, _MDS_Install, _MDS_InstallFile, _MDS_RemoveSubservice,
_MDS_Terminate, _MDS_Uninstall, _OTCDPStatusToString, _OTCliqueCDPContextTypeConfirmPasscodeCyrus,
_OTCliqueCDPContextTypeFinishPasscodeChange, _OTCliqueCDPContextTypeNone,
_OTCliqueCDPContextTypeRecoveryKeyGenerate, _OTCliqueCDPContextTypeRecoveryKeyNew,
_OTCliqueCDPContextTypeRepair, _OTCliqueCDPContextTypeSignIn,
_OTCliqueCDPContextTypeUpdatePasscode, _OTCliqueStatusFromString,
_OTCliqueStatusToString, _OTDefaultContext, _OTDefaultsDomain,
_OTEscrowRecordPrefix, _OTProtocolPairing, _OTProtocolPiggybacking,
_OTSetupControlProtocol, _OTTrustStatusChangeNotification,
_OctagonErrorDomain, _OctagonIsSOSFeatureEnabled, _OctagonPlatformSupportsSOS,
_OctagonSetPlatformSupportsSOS, _OctagonSetSOSFeatureEnabled,
_SFAnalyticsAttributeErrorCode, _SFAnalyticsAttributeErrorDomain,
_SFAnalyticsAttributeErrorUnderlyingChain, _SFAnalyticsAttributeLastUploadTime,
_SFAnalyticsColumnHardFailureCount, _SFAnalyticsColumnSampleName,
_SFAnalyticsColumnSampleValue, _SFAnalyticsColumnSoftFailureCount,
_SFAnalyticsColumnSuccessCount, _SFAnalyticsErrorDomain, _SFAnalyticsEventClassKey,
_SFAnalyticsEventErrorDestription, _SFAnalyticsEventTime,
_SFAnalyticsEventType, _SFAnalyticsEventTypeErrorEvent, _SFAnalyticsFireSamplersNotification,
_SFAnalyticsMaxEventsToReport, _SFAnalyticsPostTime, _SFAnalyticsSamplerIntervalOncePerReport,
_SFAnalyticsTableHardFailures, _SFAnalyticsTableNotes, _SFAnalyticsTableSamples,
_SFAnalyticsTableSchema, _SFAnalyticsTableSoftFailures, _SFAnalyticsTableSuccessCount,
_SFAnalyticsTopicCloudServices, _SFAnalyticsTopicKeySync,
_SFAnalyticsTopicNetworking, _SFAnalyticsTopicTransparency,
_SFAnalyticsTopicTrust, _SFAnalyticsUserDefaultsSuite, _SFSQLiteJournalSuffixes,
_SOSBKSBKeyIsInKeyBag, _SOSBKSBPeerBackupKeyIsInKeyBag, _SOSBKSBPrefixedKeyIsInKeyBag,
_SOSBSKBAllPeersBackupKeysAreInKeyBag, _SOSBSKBCopyAKSBag,
_SOSBSKBCopyEncoded, _SOSBSKBCopyRecoveryKey, _SOSBSKBCountPeers,
_SOSBSKBGetPeers, _SOSBSKBHasRecoveryKey, _SOSBSKBHasThisRecoveryKey,
_SOSBSKBIsDirect, _SOSBSKBIsGoodBackupPublic, _SOSBSKBLoadAndUnlockWithDirectSecret,
_SOSBSKBLoadAndUnlockWithPeerIDAndSecret, _SOSBSKBLoadAndUnlockWithPeerSecret,
_SOSBSKBLoadAndUnlockWithWrappingSecret, _SOSBSKBLoadLocked,
_SOSBSKBPeerIsInKeyBag, _SOSBackupSliceKeyBagCreate, _SOSBackupSliceKeyBagCreateDirect,
_SOSBackupSliceKeyBagCreateFromData, _SOSBackupSliceKeyBagCreateWithAdditionalKeys,
_SOSCCAcceptApplicants, _SOSCCAccountGetAccountPrivateCredential,
_SOSCCAccountGetKeyCircleGeneration, _SOSCCAccountGetPublicKey,
_SOSCCAccountHasPublicKey, _SOSCCAccountSetToNew, _SOSCCBailFromCircle_BestEffort,
_SOSCCCanAuthenticate, _SOSCCCircleHash, _SOSCCCleanupKVSKeys,
_SOSCCCopyApplicantPeerInfo, _SOSCCCopyApplication, _SOSCCCopyCircleJoiningBlob,
_SOSCCCopyConcurringPeerPeerInfo, _SOSCCCopyGenerationPeerInfo,
_SOSCCCopyInitialSyncData, _SOSCCCopyMyPeerInfo, _SOSCCCopyMyPeerWithNewDeviceRecoverySecret,
_SOSCCCopyNotValidPeerPeerInfo, _SOSCCCopyPeerPeerInfo, _SOSCCCopyRecoveryPublicKey,
_SOSCCCopyRetirementPeerInfo, _SOSCCCopyValidPeerPeerInfo,
_SOSCCCopyViewUnawarePeerInfo, _SOSCCCredentialQueue, _SOSCCForEachEngineStateAsString,
_SOSCCForEachEngineStateAsStringFromArray, _SOSCCGetLastDepartureReason,
_SOSCCGetStatusDescription, _SOSCCGetViewResultDescription,
_SOSCCGhostBust, _SOSCCGhostBustInfo, _SOSCCGhostBustTriggerTimed,
_SOSCCIsAppleTVSyncing, _SOSCCIsContinuityUnlockSyncing, _SOSCCIsHomeKitSyncing,
_SOSCCIsIcloudKeychainSyncing, _SOSCCIsSafariSyncing, _SOSCCIsWiFiSyncing,
_SOSCCJoinWithCircleJoiningBlob, _SOSCCLoggedIntoAccount,
_SOSCCLoggedOutOfAccount, _SOSCCMessageFromPeerIsPending,
_SOSCCPeersHaveViewsEnabled, _SOSCCProcessEnsurePeerRegistration,
_SOSCCProcessSyncWithAllPeers, _SOSCCProcessSyncWithPeers,
_SOSCCPurgeUserCredentials, _SOSCCRegisterRecoveryPublicKey,
_SOSCCRegisterSingleRecoverySecret, _SOSCCRegisterUserCredentials,
_SOSCCRejectApplicants, _SOSCCRemovePeersFromCircle, _SOSCCRemoveThisDeviceFromCircle,
_SOSCCRequestToJoinCircle, _SOSCCRequestToJoinCircleAfterRestore,
_SOSCCResetToEmpty, _SOSCCResetToOffering, _SOSCCSendToPeerIsPending,
_SOSCCSetLastDepartureReason, _SOSCCSetUserCredentials, _SOSCCSetUserCredentialsAndDSID,
_SOSCCThisDeviceIsInCircle, _SOSCCThisDeviceIsInCircleNonCached,
_SOSCCTryUserCredentials, _SOSCCTryUserCredentialsAndDSID,
_SOSCCValidateUserPublic, _SOSCCView, _SOSCCViewSet, _SOSCCWaitForInitialSync,
_SOSCachedNotificationOperation, _SOSCachedViewBitmask, _SOSCircleAcceptPeerFromHSA2,
_SOSCircleAcceptRequest, _SOSCircleAcceptRequests, _SOSCircleAppendConcurringPeers,
_SOSCircleConcordanceSign, _SOSCircleConcordanceTrust, _SOSCircleCopyAllSignatures,
_SOSCircleCopyApplicants, _SOSCircleCopyBackupCapablePeersForView,
_SOSCircleCopyCircle, _SOSCircleCopyConcurringPeers, _SOSCircleCopyEncodedData,
_SOSCircleCopyHashString, _SOSCircleCopyNextGenSignatureWithPeerAdded,
_SOSCircleCopyPeerWithID, _SOSCircleCopyPeers, _SOSCircleCopyRejectedApplicant,
_SOSCircleCopyRejectedApplicants, _SOSCircleCopyiCloudFullPeerInfoRef,
_SOSCircleCopyiCloudFullPeerInfoVerifier, _SOSCircleCountActivePeers,
_SOSCircleCountActiveValidPeers, _SOSCircleCountApplicants,
_SOSCircleCountPeers, _SOSCircleCountRejectedApplicants, _SOSCircleCountRetiredPeers,
_SOSCircleCountValidSyncingPeers, _SOSCircleCreate, _SOSCircleCreateFromDER,
_SOSCircleCreateFromData, _SOSCircleCreateIncompatibleCircleDER,
_SOSCircleEncodeToDER, _SOSCircleForEachActivePeer, _SOSCircleForEachActiveValidPeer,
_SOSCircleForEachApplicant, _SOSCircleForEachBackupCapablePeerForView,
_SOSCircleForEachPeer, _SOSCircleForEachRetiredPeer, _SOSCircleForEachValidPeer,
_SOSCircleForEachValidSyncingPeer, _SOSCircleForEachiCloudIdentityPeer,
_SOSCircleGenerationIncrement, _SOSCircleGenerationSetValue,
_SOSCircleGenerationSign, _SOSCircleGetDEREncodedSize, _SOSCircleGetGeneration,
_SOSCircleGetGenerationSint, _SOSCircleGetName, _SOSCircleGetNameC,
_SOSCircleGetSignature, _SOSCircleGetTypeID, _SOSCircleHasActivePeer,
_SOSCircleHasActivePeerWithID, _SOSCircleHasActiveValidPeer,
_SOSCircleHasActiveValidPeerWithID, _SOSCircleHasApplicant,
_SOSCircleHasPeer, _SOSCircleHasPeerWithID, _SOSCircleHasRejectedApplicant,
_SOSCircleHasValidSyncingPeer, _SOSCircleIsLegacy, _SOSCircleIsOlderGeneration,
_SOSCircleKeyCopyCircleName, _SOSCircleKeyCreateWithCircle,
_SOSCircleKeyCreateWithName, _SOSCircleLogState, _SOSCirclePeerSigUpdate,
_SOSCirclePreGenerationSign, _SOSCircleRejectRequest, _SOSCircleRemovePeer,
_SOSCircleRemovePeers, _SOSCircleRemovePeersByID, _SOSCircleRemovePeersByIDUnsigned,
_SOSCircleRemoveRejectedPeer, _SOSCircleRemoveRetired, _SOSCircleRequestAdmission,
_SOSCircleRequestReadmission, _SOSCircleResetToEmpty, _SOSCircleResetToEmptyWithSameGeneration,
_SOSCircleResetToOffering, _SOSCircleSetGeneration, _SOSCircleSetSignature,
_SOSCircleSharedTrustedPeers, _SOSCircleSign, _SOSCircleSignOldStyleResetToOfferingCircle,
_SOSCircleUpdatePeerInfo, _SOSCircleVerify, _SOSCircleVerifyPeerSignatureExists,
_SOSCircleVerifyPeerSigned, _SOSCircleVerifySignatureExists,
_SOSCircleWithdrawRequest, _SOSCloudCopyKVSState, _SOSCloudKeychainClearAll,
_SOSCloudKeychainFlush, _SOSCloudKeychainGetAllObjectsFromCloud,
_SOSCloudKeychainGetObjectsFromCloud, _SOSCloudKeychainHandleUpdateMessage,
_SOSCloudKeychainHasPendingKey, _SOSCloudKeychainPutObjectsInCloud,
_SOSCloudKeychainRemoveKeys, _SOSCloudKeychainRequestEnsurePeerRegistration,
_SOSCloudKeychainRequestPerfCounters, _SOSCloudKeychainRequestSyncWithPeers,
_SOSCloudKeychainSetItemsChangedBlock, _SOSCloudKeychainSynchronize,
_SOSCloudKeychainSynchronizeAndWait, _SOSCloudKeychainUpdateKeys,
_SOSCloudTransportSetDefaultTransport, _SOSCopyDeviceBackupPublicKey,
_SOSCopyECUnwrappedData, _SOSCopyECWrappedData, _SOSCopyHashBufAsString,
_SOSCopyIDOfDataBuffer, _SOSCopyIDOfDataBufferWithLength,
_SOSCopyIDOfKey, _SOSCopyIDOfKeyWithLength, _SOSCreateCachedViewStatus,
_SOSCreateError, _SOSCreateErrorWithFormat, _SOSCreateErrorWithFormatAndArguments,
_SOSCreateRandomDateBetweenNowPlus, _SOSDateCreate, _SOSDebugInfoKeyCreateWithTypeName,
_SOSDoWithCredentialsWhileUnlocked, _SOSErrorCreate, _SOSFullPeerInfoCopyDeviceKey,
_SOSFullPeerInfoCopyEncodedData, _SOSFullPeerInfoCopyFullPeerInfo,
_SOSFullPeerInfoCopyOctagonEncryptionKey, _SOSFullPeerInfoCopyOctagonPublicEncryptionKey,
_SOSFullPeerInfoCopyOctagonPublicSigningKey, _SOSFullPeerInfoCopyOctagonSigningKey,
_SOSFullPeerInfoCopyPubKey, _SOSFullPeerInfoCreate, _SOSFullPeerInfoCreateCloudIdentity,
_SOSFullPeerInfoCreateFromDER, _SOSFullPeerInfoCreateFromData,
_SOSFullPeerInfoCreateWithViews, _SOSFullPeerInfoEncodeToDER,
_SOSFullPeerInfoGetDEREncodedSize, _SOSFullPeerInfoGetPeerInfo,
_SOSFullPeerInfoPing, _SOSFullPeerInfoPrivKeyExists, _SOSFullPeerInfoPromoteToApplication,
_SOSFullPeerInfoPromoteToRetiredAndCopy, _SOSFullPeerInfoPurgePersistentKey,
_SOSFullPeerInfoReplaceEscrowRecords, _SOSFullPeerInfoSetCKKS4AllSupport,
_SOSFullPeerInfoUpdate, _SOSFullPeerInfoUpdateBackupKey, _SOSFullPeerInfoUpdateGestalt,
_SOSFullPeerInfoUpdateOctagonEncryptionKey, _SOSFullPeerInfoUpdateOctagonKeys,
_SOSFullPeerInfoUpdateOctagonSigningKey, _SOSFullPeerInfoUpdateToCurrent,
_SOSFullPeerInfoUpdateToThisPeer, _SOSFullPeerInfoUpdateV2Dictionary,
_SOSFullPeerInfoUpdateViews, _SOSFullPeerInfoUpgradeSignatures,
_SOSFullPeerInfoValidate, _SOSFullPeerInfoViewStatus, _SOSGenCountCreateFromDER,
_SOSGenCountEncodeToDER, _SOSGenCountGetDEREncodedSize, _SOSGenerateDeviceBackupFullKey,
_SOSGenerationCopy, _SOSGenerationCountCopyDescription, _SOSGenerationCountWithDescription,
_SOSGenerationCreate, _SOSGenerationCreateWithBaseline, _SOSGenerationCreateWithValue,
_SOSGenerationIncrementAndCreate, _SOSGenerationIsOlder, _SOSGestaltSerial,
_SOSGetBackupKeyCurveParameters, _SOSGetCachedCircleBitmask,
_SOSGetCachedCircleStatus, _SOSGetGenerationSint, _SOSItemsChangedCopyDescription,
_SOSKVSKeyGetKeyType, _SOSKVSKeyGetKeyTypeAndParse, _SOSKVSKeyParse,
_SOSLastKeyParametersPushedKeyCreateWithAccountGestalt, _SOSLastKeyParametersPushedKeyCreateWithPeerID,
_SOSMessageKeyCopyCircleName, _SOSMessageKeyCopyFromPeerName,
_SOSMessageKeyCreateFromPeerToTransport, _SOSMessageKeyCreateFromTransportToPeer,
_SOSMessageKeyCreateWithCircleAndPeerInfos, _SOSMessageKeyCreateWithCircleAndPeerNames,
_SOSMessageKeyCreateWithCircleNameAndPeerNames, _SOSPeerGestaltGetAnswer,
_SOSPeerGestaltGetName, _SOSPeerGetGestalt, _SOSPeerInfoApplicationVerify,
_SOSPeerInfoArrayCreateFromDER, _SOSPeerInfoArrayEncodeToDER,
_SOSPeerInfoArrayGetDEREncodedSize, _SOSPeerInfoCompareByApplicationDate,
_SOSPeerInfoCompareByID, _SOSPeerInfoCopyAsApplication, _SOSPeerInfoCopyBackupKey,
_SOSPeerInfoCopyData, _SOSPeerInfoCopyDeviceID, _SOSPeerInfoCopyEnabledViews,
_SOSPeerInfoCopyEncodedData, _SOSPeerInfoCopyOctagonEncryptionPublicKey,
_SOSPeerInfoCopyOctagonSigningPublicKey, _SOSPeerInfoCopyPeerGestalt,
_SOSPeerInfoCopyPubKey, _SOSPeerInfoCopySerialNumber, _SOSPeerInfoCopyTransportType,
_SOSPeerInfoCopyWithBackupKeyUpdate, _SOSPeerInfoCopyWithGestaltUpdate,
_SOSPeerInfoCopyWithPing, _SOSPeerInfoCopyWithReplacedEscrowRecords,
_SOSPeerInfoCopyWithV2DictionaryUpdate, _SOSPeerInfoCopyWithViewsChange,
_SOSPeerInfoCreate, _SOSPeerInfoCreateCloudIdentity, _SOSPeerInfoCreateCopy,
_SOSPeerInfoCreateCurrentCopy, _SOSPeerInfoCreateFromDER,
_SOSPeerInfoCreateFromData, _SOSPeerInfoCreateRetirementTicket,
_SOSPeerInfoCreateWithTransportAndViews, _SOSPeerInfoEncodeToDER,
_SOSPeerInfoExpandV2Data, _SOSPeerInfoGetApplicationDate,
_SOSPeerInfoGetAutoAcceptInfo, _SOSPeerInfoGetClass, _SOSPeerInfoGetDEREncodedSize,
_SOSPeerInfoGetPeerDeviceType, _SOSPeerInfoGetPeerID, _SOSPeerInfoGetPeerName,
_SOSPeerInfoGetPeerProtocolVersion, _SOSPeerInfoGetPermittedViews,
_SOSPeerInfoGetRetirementDate, _SOSPeerInfoGetSPID, _SOSPeerInfoGetTypeID,
_SOSPeerInfoGetVersion, _SOSPeerInfoHasBackupKey, _SOSPeerInfoInspectRetirementTicket,
_SOSPeerInfoIsCloudIdentity, _SOSPeerInfoIsEnabledView, _SOSPeerInfoIsLegacy,
_SOSPeerInfoIsRetirementTicket, _SOSPeerInfoIsViewPermitted,
_SOSPeerInfoKVSOnly, _SOSPeerInfoLogState, _SOSPeerInfoLookupGestaltValue,
_SOSPeerInfoPackV2Data, _SOSPeerInfoPeerIDEqual, _SOSPeerInfoRetireRetirementTicket,
_SOSPeerInfoSerialNumberIsSet, _SOSPeerInfoSetContainsIdenticalPeers,
_SOSPeerInfoSetCreateFromArrayDER, _SOSPeerInfoSetEncodeToArrayDER,
_SOSPeerInfoSetFindByID, _SOSPeerInfoSetGetDEREncodedArraySize,
_SOSPeerInfoSetOctagonEncryptionKey, _SOSPeerInfoSetOctagonKeys,
_SOSPeerInfoSetOctagonKeysInDescription, _SOSPeerInfoSetOctagonSigningKey,
_SOSPeerInfoSetSerialNumber, _SOSPeerInfoSetSupportsCKKSForAll,
_SOSPeerInfoSetTestSerialNumber, _SOSPeerInfoSign, _SOSPeerInfoSupportsCKKSForAll,
_SOSPeerInfoUpdateDigestWithDescription, _SOSPeerInfoUpdateDigestWithPublicKeyBytes,
_SOSPeerInfoUpdateToV2, _SOSPeerInfoUpgradeSignatures, _SOSPeerInfoV0ViewsEnabled,
_SOSPeerInfoV2DictionaryCopyBoolean, _SOSPeerInfoV2DictionaryCopyData,
_SOSPeerInfoV2DictionaryCopyDictionary, _SOSPeerInfoV2DictionaryCopySet,
_SOSPeerInfoV2DictionaryCopyString, _SOSPeerInfoV2DictionaryForEachSetValue,
_SOSPeerInfoV2DictionaryHasBoolean, _SOSPeerInfoV2DictionaryHasData,
_SOSPeerInfoV2DictionaryHasSet, _SOSPeerInfoV2DictionaryHasSetContaining,
_SOSPeerInfoV2DictionaryHasString, _SOSPeerInfoV2DictionaryHasStringValue,
_SOSPeerInfoV2DictionaryRemoveValue, _SOSPeerInfoV2DictionarySetValue,
_SOSPeerInfoV2DictionaryWithSet, _SOSPeerInfoVersionHasV2Data,
_SOSPeerInfoVersionIsCurrent, _SOSPeerInfoViewBitMask, _SOSPeerInfoViewStatus,
_SOSPeerInfoWithEnabledViewSet, _SOSPerformWithDeviceBackupFullKey,
_SOSPerformWithUnwrappedData, _SOSPiggyBackAddToKeychain,
_SOSPiggyBackBlobCopyEncodedData, _SOSPiggyBackBlobCreateFromDER,
_SOSPiggyBackBlobCreateFromData, _SOSPiggyCopyInitialSyncData,
_SOSRKNullKey, _SOSRetirementKeyCreateWithCircleAndPeer, _SOSRetirementKeyCreateWithCircleNameAndPeer,
_SOSRingKeyCreateWithName, _SOSRingKeyCreateWithRingName,
_SOSTransportMessageTypeIDSV2, _SOSTransportMessageTypeKVS,
_SOSViewBitmaskFromSet, _SOSViewCopyViewSet, _SOSViewCreateSetFromBitmask,
_SOSViewHintInCKKSSystem, _SOSViewHintInSOSSystem, _SOSViewInSOSSystem,
_SOSViewSetDisable, _SOSViewSetEnable, _SOSViewSetIntersectsV0,
_SOSViewsDisable, _SOSViewsEnable, _SOSViewsForEachDefaultEnabledViewName,
_SOSViewsGetAllCurrent, _SOSViewsGetV0BackupBagViewSet, _SOSViewsGetV0BackupViewSet,
_SOSViewsGetV0SubviewSet, _SOSViewsGetV0ViewSet, _SOSViewsIsV0Subview,
_SOSViewsQuery, _SOSViewsSetTestViewsSet, _SOSViewsXlateAction,
_SOSVisibleKeychainNotAllowed, _SSLAddDistinguishedName, _SSLCiphersuiteGetName,
_SSLCiphersuiteGroupContainsCiphersuite, _SSLCiphersuiteGroupToCiphersuiteList,
_SSLCiphersuiteMaximumTLSVersion, _SSLCiphersuiteMinimumTLSVersion,
_SSLClose, _SSLContextGetTypeID, _SSLCopyALPNProtocols, _SSLCopyDistinguishedNames,
_SSLCopyPeerTrust, _SSLCopyRequestedPeerName, _SSLCopyRequestedPeerNameLength,
_SSLCreateContext, _SSLCreateContextWithRecordFuncs, _SSLGetALPNData,
_SSLGetAllowAnonymousCiphers, _SSLGetBufferedReadSize, _SSLGetCertificate,
_SSLGetCipherSizes, _SSLGetClientAuthTypes, _SSLGetClientCertificateState,
_SSLGetClientSideAuthenticate, _SSLGetConnection, _SSLGetDHEEnabled,
_SSLGetDatagramWriteSize, _SSLGetECDSACurves, _SSLGetEnabledCiphers,
_SSLGetEncryptionCertificate, _SSLGetMaxDatagramRecordSize,
_SSLGetMinimumDHGroupSize, _SSLGetNPNData, _SSLGetNegotiatedCipher,
_SSLGetNegotiatedClientAuthType, _SSLGetNegotiatedCurve, _SSLGetNegotiatedProtocolVersion,
_SSLGetNumberEnabledCiphers, _SSLGetNumberOfClientAuthTypes,
_SSLGetNumberOfECDSACurves, _SSLGetNumberOfSignatureAlgorithms,
_SSLGetNumberSupportedCiphers, _SSLGetPSKIdentity, _SSLGetPeerDomainName,
_SSLGetPeerDomainNameLength, _SSLGetPeerID, _SSLGetPeerSecTrust,
_SSLGetProtocolVersionMax, _SSLGetProtocolVersionMin, _SSLGetResumableSessionInfo,
_SSLGetSessionOption, _SSLGetSessionState, _SSLGetSignatureAlgorithms,
_SSLGetSupportedCiphers, _SSLHandshake, _SSLInternalClientRandom,
_SSLInternalMasterSecret, _SSLInternalServerRandom, _SSLInternalSetMasterSecretFunction,
_SSLInternalSetSessionTicket, _SSLInternal_PRF, _SSLProtocolFromVersionCodepoint,
_SSLProtocolGetVersionCodepoint, _SSLReHandshake, _SSLRead,
_SSLSetALPNData, _SSLSetALPNFunc, _SSLSetALPNProtocols, _SSLSetAllowAnonymousCiphers,
_SSLSetCertificate, _SSLSetClientSideAuthenticate, _SSLSetConnection,
_SSLSetDHEEnabled, _SSLSetDatagramHelloCookie, _SSLSetECDSACurves,
_SSLSetEnabledCiphers, _SSLSetEncryptionCertificate, _SSLSetError,
_SSLSetIOFuncs, _SSLSetMaxDatagramRecordSize, _SSLSetMinimumDHGroupSize,
_SSLSetNPNData, _SSLSetNPNFunc, _SSLSetOCSPResponse, _SSLSetPSKIdentity,
_SSLSetPSKSharedSecret, _SSLSetPeerDomainName, _SSLSetPeerID,
_SSLSetProtocolVersionMax, _SSLSetProtocolVersionMin, _SSLSetRecordContext,
_SSLSetSessionCacheTimeout, _SSLSetSessionConfig, _SSLSetSessionOption,
_SSLSetSessionTicketsEnabled, _SSLWrite, _SecACLCopyAuthorizations,
_SecACLGetAuthorizations, _SecACLSetAuthorizations, _SecACLUpdateAuthorizations,
_SecASN1PrintableString, _SecASN1UTF8String, _SecAbsoluteTimeFromDateContent,
_SecAbsoluteTimeFromDateContentWithError, _SecAccessConstraintCreateBiometryAny,
_SecAccessConstraintCreateBiometryCurrentSet, _SecAccessConstraintCreateKofN,
_SecAccessConstraintCreatePasscode, _SecAccessConstraintCreatePolicy,
_SecAccessConstraintCreateTouchIDAny, _SecAccessConstraintCreateTouchIDCurrentSet,
_SecAccessConstraintCreateWatch, _SecAccessControlAddConstraintForOperation,
_SecAccessControlCopyConstraintData, _SecAccessControlCopyData,
_SecAccessControlCreate, _SecAccessControlCreateFromData,
_SecAccessControlCreateWithFlags, _SecAccessControlGetConstraint,
_SecAccessControlGetConstraints, _SecAccessControlGetProtection,
_SecAccessControlGetRequirePassword, _SecAccessControlGetTypeID,
_SecAccessControlIsBound, _SecAccessControlSetBound, _SecAccessControlSetConstraints,
_SecAccessControlSetProtection, _SecAccessControlSetRequirePassword,
_SecAccessCopyACLList, _SecAccessCopyMatchingACLList, _SecAccessCopyOwnerAndACL,
_SecAccessCopySelectedACLList, _SecAccessCreate, _SecAccessCreateFromOwnerAndACL,
_SecAccessCreateWithOwnerAndACL, _SecAccessCreateWithTrustedApplications,
_SecAccessGetOwnerAndACL, _SecAccessGetTypeID, _SecAccessGroupsGetCurrent,
_SecAccessGroupsSetCurrent, _SecAddSharedWebCredential, _SecAsn1AllocCopy,
_SecAsn1AllocCopyItem, _SecAsn1AllocItem, _SecAsn1CoderCreate,
_SecAsn1CoderRelease, _SecAsn1Decode, _SecAsn1DecodeData,
_SecAsn1EncodeItem, _SecAsn1Malloc, _SecAsn1OidCompare, _SecAsn1TaggedTemplateChooser,
_SecAssessmentControl, _SecAssessmentCopyResult, _SecAssessmentCopyUpdate,
_SecAssessmentCreate, _SecAssessmentGetTypeID, _SecAssessmentLegacyCheck,
_SecAssessmentRegisterPackageTicket, _SecAssessmentTicketLookup,
_SecAssessmentTicketRegister, _SecAssessmentUpdate, _SecBackupKeybagAdd,
_SecBackupKeybagDelete, _SecBase64Decode, _SecBase64Decode2,
_SecBase64Encode, _SecBase64Encode2, _SecCFAllocatorZeroize,
_SecCMSCertificatesOnlyMessageCopyCertificates, _SecCMSCreateCertificatesOnlyMessage,
_SecCMSCreateCertificatesOnlyMessageIAP, _SecCMSCreateEnvelopedData,
_SecCMSCreateSignedData, _SecCMSDecryptEnvelopedData, _SecCMSSignDataAndAttributes,
_SecCMSSignDigestAndAttributes, _SecCMSVerify, _SecCMSVerifyCopyDataAndAttributes,
_SecCMSVerifySignedData, _SecCertificateAppendToXPCArray,
_SecCertificateArrayCopyXPCArray, _SecCertificateCopyAppleExternalRoots,
_SecCertificateCopyAttributeDictionary, _SecCertificateCopyCTLogForKeyID,
_SecCertificateCopyCommonName, _SecCertificateCopyCommonNames,
_SecCertificateCopyCompanyName, _SecCertificateCopyComponentAttributes,
_SecCertificateCopyComponentType, _SecCertificateCopyCompressedMFiCert,
_SecCertificateCopyCountry, _SecCertificateCopyDNSNames, _SecCertificateCopyDNSNamesFromSAN,
_SecCertificateCopyData, _SecCertificateCopyEmailAddresses,
_SecCertificateCopyEscrowRoots, _SecCertificateCopyExtendedKeyUsage,
_SecCertificateCopyExtensionValue, _SecCertificateCopyIPAddressDatas,
_SecCertificateCopyIPAddresses, _SecCertificateCopyIssuerSHA1Digest,
_SecCertificateCopyIssuerSequence, _SecCertificateCopyIssuerSummary,
_SecCertificateCopyKey, _SecCertificateCopyKeychainItem, _SecCertificateCopyLegacyProperties,
_SecCertificateCopyLocalizedProperties, _SecCertificateCopyNTPrincipalNames,
_SecCertificateCopyNormalizedIssuerSequence, _SecCertificateCopyNormalizedSubjectSequence,
_SecCertificateCopyOrganization, _SecCertificateCopyOrganizationFromX501NameContent,
_SecCertificateCopyOrganizationalUnit, _SecCertificateCopyPrecertTBS,
_SecCertificateCopyProperties, _SecCertificateCopyPublicKey,
_SecCertificateCopyPublicKeySHA1Digest, _SecCertificateCopyPublicKey_ios,
_SecCertificateCopyRFC822Names, _SecCertificateCopyRFC822NamesFromSubject,
_SecCertificateCopySHA256Digest, _SecCertificateCopySerialNumber,
_SecCertificateCopySerialNumberData, _SecCertificateCopySignedCertificateTimestamps,
_SecCertificateCopySubjectAttributeValue, _SecCertificateCopySubjectPublicKeyInfoSHA1Digest,
_SecCertificateCopySubjectPublicKeyInfoSHA256Digest, _SecCertificateCopySubjectSequence,
_SecCertificateCopySubjectString, _SecCertificateCopySubjectSummary,
_SecCertificateCopySummaryProperties, _SecCertificateCopyTrustedCTLogs,
_SecCertificateCopyiAPAuthCapabilities, _SecCertificateCopyiAPSWAuthCapabilities,
_SecCertificateCopyiPhoneDeviceCAChain, _SecCertificateCreateFromAttributeDictionary,
_SecCertificateCreateOidDataFromString, _SecCertificateCreateWithBytes,
_SecCertificateCreateWithCompressedMFiCert, _SecCertificateCreateWithData,
_SecCertificateCreateWithKeychainItem, _SecCertificateCreateWithPEM,
_SecCertificateCreateWithXPCArrayAtIndex, _SecCertificateGetAuthorityKeyID,
_SecCertificateGetBasicConstraints, _SecCertificateGetBytePtr,
_SecCertificateGetCAIssuers, _SecCertificateGetCRLDistributionPoints,
_SecCertificateGetCertificatePolicies, _SecCertificateGetDeveloperIDDate,
_SecCertificateGetDuplicateExtension, _SecCertificateGetExcludedSubtrees,
_SecCertificateGetExtensionValue, _SecCertificateGetInhibitAnyPolicySkipCerts,
_SecCertificateGetKeyUsage, _SecCertificateGetLength, _SecCertificateGetNormalizedIssuerContent,
_SecCertificateGetNormalizedSubjectContent, _SecCertificateGetOCSPResponders,
_SecCertificateGetPermittedSubtrees, _SecCertificateGetPolicyConstraints,
_SecCertificateGetPolicyMappings, _SecCertificateGetPublicKeyAlgorithm,
_SecCertificateGetPublicKeyData, _SecCertificateGetSHA1Digest,
_SecCertificateGetSignatureHashAlgorithm, _SecCertificateGetSubjectAltName,
_SecCertificateGetSubjectKeyID, _SecCertificateGetTypeID,
_SecCertificateGetUnparseableKnownExtension, _SecCertificateGetiAuthVersion,
_SecCertificateHasCriticalSubjectAltName, _SecCertificateHasMarkerExtension,
_SecCertificateHasOCSPNoCheckMarkerExtension, _SecCertificateHasSubject,
_SecCertificateHasUnknownCriticalExtension, _SecCertificateIsAtLeastMinKeySize,
_SecCertificateIsCA, _SecCertificateIsOidString, _SecCertificateIsSelfSigned,
_SecCertificateIsSelfSignedCA, _SecCertificateIsSignedBy,
_SecCertificateIsStrongKey, _SecCertificateIsValid, _SecCertificateIsWeakHash,
_SecCertificateIsWeakKey, _SecCertificateNotValidAfter, _SecCertificateNotValidBefore,
_SecCertificateParseGeneralNameContentProperty, _SecCertificateParseGeneralNames,
_SecCertificateSetKeychainItem, _SecCertificateShow, _SecCertificateVersion,
_SecCertificateXPCArrayCopyArray, _SecCmsContentInfoGetBulkKey,
_SecCmsContentInfoGetBulkKeySize, _SecCmsContentInfoGetChildContentInfo,
_SecCmsContentInfoGetContent, _SecCmsContentInfoGetContentEncAlg,
_SecCmsContentInfoGetContentEncAlgTag, _SecCmsContentInfoGetContentTypeOID,
_SecCmsContentInfoGetContentTypeTag, _SecCmsContentInfoGetInnerContent,
_SecCmsContentInfoSetBulkKey, _SecCmsContentInfoSetContentData,
_SecCmsContentInfoSetContentDigestedData, _SecCmsContentInfoSetContentEncAlg,
_SecCmsContentInfoSetContentEncAlgID, _SecCmsContentInfoSetContentEncryptedData,
_SecCmsContentInfoSetContentEnvelopedData, _SecCmsContentInfoSetContentOther,
_SecCmsContentInfoSetContentSignedData, _SecCmsDecoderCreate,
_SecCmsDecoderDestroy, _SecCmsDecoderFinish, _SecCmsDecoderUpdate,
_SecCmsDigestContextCancel, _SecCmsDigestContextStartMultiple,
_SecCmsDigestContextUpdate, _SecCmsDigestedDataCreate, _SecCmsDigestedDataDestroy,
_SecCmsDigestedDataGetContentInfo, _SecCmsEncoderCreate, _SecCmsEncoderDestroy,
_SecCmsEncoderFinish, _SecCmsEncoderUpdate, _SecCmsEncryptedDataCreate,
_SecCmsEncryptedDataDestroy, _SecCmsEncryptedDataGetContentInfo,
_SecCmsEnvelopedDataCreate, _SecCmsEnvelopedDataDestroy, _SecCmsEnvelopedDataGetContentInfo,
_SecCmsMessageContainsCertsOrCrls, _SecCmsMessageContentLevel,
_SecCmsMessageContentLevelCount, _SecCmsMessageCopy, _SecCmsMessageCreate,
_SecCmsMessageDecode, _SecCmsMessageDestroy, _SecCmsMessageEncode,
_SecCmsMessageGetContent, _SecCmsMessageGetContentInfo, _SecCmsMessageIsContentEmpty,
_SecCmsMessageIsEncrypted, _SecCmsMessageIsSigned, _SecCmsMessageSetTSAContext,
_SecCmsRecipientInfoCreate, _SecCmsRecipientInfoCreateWithSubjKeyID,
_SecCmsRecipientInfoCreateWithSubjKeyIDFromCert, _SecCmsSignedDataAddCertChain,
_SecCmsSignedDataAddCertList, _SecCmsSignedDataAddCertificate,
_SecCmsSignedDataContainsCertsOrCrls, _SecCmsSignedDataCreate,
_SecCmsSignedDataCreateCertsOnly, _SecCmsSignedDataDestroy,
_SecCmsSignedDataGetCertificateList, _SecCmsSignedDataGetContentInfo,
_SecCmsSignedDataGetDigestAlgs, _SecCmsSignedDataGetSignerInfo,
_SecCmsSignedDataGetSignerInfos, _SecCmsSignedDataHasDigests,
_SecCmsSignedDataImportCerts, _SecCmsSignedDataSignerInfoCount,
_SecCmsSignedDataVerifyCertsOnly, _SecCmsSignedDataVerifyCertsOnlyMessage,
_SecCmsSignedDataVerifySigner, _SecCmsSignedDataVerifySignerInfo,
_SecCmsSignerInfoAddAppleCodesigningHashAgility, _SecCmsSignerInfoAddAppleCodesigningHashAgilityV2,
_SecCmsSignerInfoAddAppleExpirationTime, _SecCmsSignerInfoAddCounterSignature,
_SecCmsSignerInfoAddMSSMIMEEncKeyPreferences, _SecCmsSignerInfoAddMSSMIMEEncKeyPrefs,
_SecCmsSignerInfoAddSMIMECaps, _SecCmsSignerInfoAddSMIMEEncKeyPreferences,
_SecCmsSignerInfoAddSMIMEEncKeyPrefs, _SecCmsSignerInfoAddSigningTime,
_SecCmsSignerInfoCopyCertFromEncryptionKeyPreference, _SecCmsSignerInfoCreate,
_SecCmsSignerInfoCreateWithSubjKeyID, _SecCmsSignerInfoGetAppleCodesigningHashAgility,
_SecCmsSignerInfoGetAppleCodesigningHashAgilityV2, _SecCmsSignerInfoGetAppleExpirationTime,
_SecCmsSignerInfoGetCertList, _SecCmsSignerInfoGetDigestAlg,
_SecCmsSignerInfoGetDigestAlgTag, _SecCmsSignerInfoGetSignerCommonName,
_SecCmsSignerInfoGetSignerEmailAddress, _SecCmsSignerInfoGetSigningCert,
_SecCmsSignerInfoGetSigningCertificate, _SecCmsSignerInfoGetSigningTime,
_SecCmsSignerInfoGetVerificationStatus, _SecCmsSignerInfoIncludeCerts,
_SecCmsSignerInfoSaveSMIMEProfile, _SecCmsTSADefaultCallback,
_SecCmsTSAGetDefaultContext, _SecCmsUtilVerificationStatusToString,
_SecCodeCheckValidity, _SecCodeCheckValidityWithErrors, _SecCodeCopyComponent,
_SecCodeCopyDesignatedRequirement, _SecCodeCopyHost, _SecCodeCopyInternalRequirement,
_SecCodeCopyPath, _SecCodeCopySelf, _SecCodeCopySigningInformation,
_SecCodeCopyStaticCode, _SecCodeGetStatus, _SecCodeGetTypeID,
_SecCodeMapMemory, _SecCodeSetDetachedSignature, _SecCodeSetStatus,
_SecCodeSignerAddSignature, _SecCodeSignerAddSignatureWithErrors,
_SecCodeSignerCreate, _SecCodeSignerGetTypeID, _SecCodeSpecialSlotIsPresent,
_SecCodeValidateFileResource, _SecCopyBaseFilesURL, _SecCopyDecryptedForServer,
_SecCopyEncryptedToServer, _SecCopyEncryptedToServerKey, _SecCopyErrorMessageString,
_SecCopyHomeURL, _SecCopyLastError, _SecCoreAnalyticsSendKernEntropyAnalytics,
_SecCoreAnalyticsSendValue, _SecCoreAnalyticsValue, _SecCreateCFErrorWithXPCObject,
_SecCreateCollectTransform, _SecCreateMaskGenerationFunctionTransform,
_SecCreateRecoveryPassword, _SecCreateSharedWebCredentialPassword,
_SecCreateXPCObjectWithCFError, _SecDERItemCopyOIDDecimalRepresentation,
_SecDHComputeKey, _SecDHCreate, _SecDHCreateFromAlgorithmId,
_SecDHCreateFromParameters, _SecDHDecodeParams, _SecDHDestroy,
_SecDHEncodeParams, _SecDHGenerateKeypair, _SecDHGetMaxKeyLength,
_SecDNSIsTLD, _SecDecodeTransformCreate, _SecDecryptTransformCreate,
_SecDecryptTransformGetTypeID, _SecDigestCreate, _SecDigestTransformCreate,
_SecDigestTransformGetTypeID, _SecDistinguishedNameCopyNormalizedContent,
_SecDistinguishedNameCopyNormalizedSequence, _SecECDoWithFullKey,
_SecECDoWithPubKey, _SecECKeyCopyPublicBits, _SecECKeyGetNamedCurve,
_SecEncodeTransformCreate, _SecEncryptTransformCreate, _SecEncryptTransformGetTypeID,
_SecErrorGetOSStatus, _SecErrorIsNestedErrorCappingEnabled,
_SecErrorSetOverrideNestedErrorCappingIsEnabled, _SecEscrowRequestHavePrecord,
_SecEscrowRequestPendingCertificate, _SecEscrowRequestPendingPasscode,
_SecEscrowRequestSetupControlProtocol, _SecExternalSourceSetValue,
_SecExternalSourceTransformCreate, _SecFDERecoveryUnwrapCRSKWithPrivKey,
_SecFDERecoveryWrapCRSKWithPubKey, _SecFrameworkCopyIPAddressData,
_SecFrameworkCopyLocalizedString, _SecFrameworkIsDNSName,
_SecFrameworkIsIPAddress, _SecGenerateCertificateRequest,
_SecGenerateCertificateRequestSubject, _SecGenerateCertificateRequestWithParameters,
_SecGenerateSelfSignedCertificate, _SecGenericPasswordCreate,
_SecGetCurrentServerLoggingInfo, _SecGroupTransformFindLastTransform,
_SecGroupTransformFindMonitor, _SecGroupTransformGetTypeID,
_SecGroupTransformHasMember, _SecHostCreateGuest, _SecHostRemoveGuest,
_SecHostSelectGuest, _SecHostSelectedGuest, _SecHostSetGuestStatus,
_SecHostSetHostingPort, _SecIdentityCopyCertificate, _SecIdentityCopyPrivateKey,
_SecIdentityCreate, _SecIdentityGetTypeID, _SecIdentitySearchCopyNext,
_SecIdentitySearchCreate, _SecIdentitySearchCreateWithAttributes,
_SecIdentitySearchCreateWithPolicy, _SecIdentitySearchGetTypeID,
_SecIdentitySignCertificate, _SecIdentitySignCertificateWithAlgorithm,
_SecIdentitySignCertificateWithParameters, _SecIsInternalRelease,
_SecItemAdd, _SecItemBackupCreateManifest, _SecItemBackupRestore,
_SecItemBackupSetConfirmedManifest, _SecItemBackupWithChanges,
_SecItemBackupWithRegisteredBackups, _SecItemBackupWithRegisteredViewBackup,
_SecItemCertificateExists, _SecItemCopyMatching, _SecItemCopyParentCertificates_ios,
_SecItemDelete, _SecItemDeleteAll, _SecItemDeleteAllWithAccessGroups,
_SecItemDeleteKeychainItemsForAppClip, _SecItemFetchCurrentItemAcrossAllDevices,
_SecItemPersistKeychainWritesAtHighPerformanceCost, _SecItemSetCurrentItemAcrossAllDevices,
_SecItemUpdate, _SecItemUpdateTokenItemsForAccessGroups, _SecItemUpdateWithError,
_SecItemVerifyBackupIntegrity, _SecKVSOnCloudKitIsEnabled,
_SecKVSOnCloudKitSetOverrideIsEnabled, _SecKeyControlLifetime,
_SecKeyCopyAttestationKey, _SecKeyCopyAttributeDictionary,
_SecKeyCopyAttributes, _SecKeyCopyExponent, _SecKeyCopyExternalRepresentation,
_SecKeyCopyKeyExchangeResult, _SecKeyCopyMatchingPrivateKey,
_SecKeyCopyModulus, _SecKeyCopyPersistentRef, _SecKeyCopyPublicBytes,
_SecKeyCopyPublicKey, _SecKeyCopyPublicKeyHash, _SecKeyCopySubjectPublicKeyInfo,
_SecKeyCopySystemKey, _SecKeyCreate, _SecKeyCreateAttestation,
_SecKeyCreateDecryptedData, _SecKeyCreateDecryptedDataWithParameters,
_SecKeyCreateDuplicate, _SecKeyCreateECPrivateKey, _SecKeyCreateECPublicKey,
_SecKeyCreateEncryptedData, _SecKeyCreateEncryptedDataWithParameters,
_SecKeyCreateFromAttributeDictionary, _SecKeyCreateFromPublicBytes,
_SecKeyCreateFromPublicData, _SecKeyCreateFromSubjectPublicKeyInfoData,
_SecKeyCreatePersistentRefToMatchingPrivateKey, _SecKeyCreatePublicFromDER,
_SecKeyCreatePublicFromPrivate, _SecKeyCreateRSAPrivateKey,
_SecKeyCreateRSAPublicKey, _SecKeyCreateRSAPublicKey_ios,
_SecKeyCreateRandomKey, _SecKeyCreateSignature, _SecKeyCreateWithData,
_SecKeyDecrypt, _SecKeyDigestAndSign, _SecKeyDigestAndVerify,
_SecKeyEncrypt, _SecKeyFindWithPersistentRef, _SecKeyGeneratePair,
_SecKeyGeneratePrivateAttributeDictionary, _SecKeyGeneratePublicAttributeDictionary,
_SecKeyGetAlgorithmID, _SecKeyGetAlgorithmId, _SecKeyGetBlockSize,
_SecKeyGetMatchingPrivateKeyStatus, _SecKeyGetSize, _SecKeyGetTypeID,
_SecKeyIsAlgorithmSupported, _SecKeySetParameter, _SecKeySignDigest,
_SecKeyVerifyDigest, _SecKeyVerifySignature, _SecKeychainAddCallback,
_SecKeychainAddDBToKeychainList, _SecKeychainAddGenericPassword,
_SecKeychainAddInternetPassword, _SecKeychainAttemptMigrationWithMasterKey,
_SecKeychainAttributeInfoForItemID, _SecKeychainChangeKeyStorePassphrase,
_SecKeychainChangePassword, _SecKeychainCleanupHandles, _SecKeychainCopyAccess,
_SecKeychainCopyBlob, _SecKeychainCopyDefault, _SecKeychainCopyDomainDefault,
_SecKeychainCopyDomainSearchList, _SecKeychainCopyLogin, _SecKeychainCopySearchList,
_SecKeychainCopySettings, _SecKeychainCopySignature, _SecKeychainCreate,
_SecKeychainCreateNew, _SecKeychainCreateWithBlob, _SecKeychainDBIsInKeychainList,
_SecKeychainDelete, _SecKeychainEraseUnlockKeyWithPubKeyHash,
_SecKeychainErrFromOSStatus, _SecKeychainFindGenericPassword,
_SecKeychainFindInternetPassword, _SecKeychainFreeAttributeInfo,
_SecKeychainGetCSPHandle, _SecKeychainGetDLDBHandle, _SecKeychainGetKeychainVersion,
_SecKeychainGetPath, _SecKeychainGetPreferenceDomain, _SecKeychainGetStatus,
_SecKeychainGetTypeID, _SecKeychainGetUserInteractionAllowed,
_SecKeychainGetUserPromptAttempts, _SecKeychainGetVersion,
_SecKeychainIsStaticPersistentRefsEnabled, _SecKeychainIsValid,
_SecKeychainItemAdd, _SecKeychainItemAddNoUI, _SecKeychainItemCopyAccess,
_SecKeychainItemCopyAllExtendedAttributes, _SecKeychainItemCopyAttributesAndData,
_SecKeychainItemCopyAttributesAndEncryptedData, _SecKeychainItemCopyContent,
_SecKeychainItemCopyExtendedAttribute, _SecKeychainItemCopyFromPersistentReference,
_SecKeychainItemCopyFromRecordIdentifier, _SecKeychainItemCopyKeychain,
_SecKeychainItemCopyRecordIdentifier, _SecKeychainItemCreateCopy,
_SecKeychainItemCreateFromContent, _SecKeychainItemCreateFromEncryptedContent,
_SecKeychainItemCreateNew, _SecKeychainItemCreatePersistentReference,
_SecKeychainItemDelete, _SecKeychainItemFindFirst, _SecKeychainItemFreeAttributesAndData,
_SecKeychainItemFreeContent, _SecKeychainItemGetAttribute,
_SecKeychainItemGetDLDBHandle, _SecKeychainItemGetData, _SecKeychainItemGetTypeID,
_SecKeychainItemGetUniqueRecordID, _SecKeychainItemModifyAttributesAndData,
_SecKeychainItemModifyContent, _SecKeychainItemModifyEncryptedData,
_SecKeychainItemSetAccess, _SecKeychainItemSetAccessWithPassword,
_SecKeychainItemSetAttribute, _SecKeychainItemSetData, _SecKeychainItemSetExtendedAttribute,
_SecKeychainItemUpdate, _SecKeychainListCopyKeychainAtIndex,
_SecKeychainListGetCount, _SecKeychainListRemoveKeychain,
_SecKeychainLock, _SecKeychainLockAll, _SecKeychainLogin,
_SecKeychainLogout, _SecKeychainMDSInstall, _SecKeychainMakeFromFullPath,
_SecKeychainOpen, _SecKeychainRecodeKeychain, _SecKeychainRemoveCallback,
_SecKeychainRemoveDBFromKeychainList, _SecKeychainRemoveFromSearchList,
_SecKeychainResetLogin, _SecKeychainSearchCopyNext, _SecKeychainSearchCreateFromAttributes,
_SecKeychainSearchCreateFromAttributesExtended, _SecKeychainSearchGetTypeID,
_SecKeychainSetAccess, _SecKeychainSetBatchMode, _SecKeychainSetDefault,
_SecKeychainSetDomainDefault, _SecKeychainSetDomainSearchList,
_SecKeychainSetOverrideStaticPersistentRefsIsEnabled, _SecKeychainSetPreferenceDomain,
_SecKeychainSetSearchList, _SecKeychainSetServerMode, _SecKeychainSetSettings,
_SecKeychainSetUserInteractionAllowed, _SecKeychainStash,
_SecKeychainStoreUnlockKey, _SecKeychainStoreUnlockKeyWithPubKeyHash,
_SecKeychainSystemKeychainCheckWouldDeadlock, _SecKeychainUnlock,
_SecKeychainVerifyKeyStorePassphrase, _SecLogAPICreate, _SecNullTransformCreate,
_SecOSStatusWith, _SecOTRAdvertiseHashes, _SecOTRFIAppendSerialization,
_SecOTRFIPurgeAllFromKeychain, _SecOTRFIPurgeFromKeychain,
_SecOTRFullIdentityCreate, _SecOTRFullIdentityCreateFromBytes,
_SecOTRFullIdentityCreateFromData, _SecOTRFullIdentityCreateFromSecKeyRef,
_SecOTRFullIdentityCreateFromSecKeyRefSOS, _SecOTRPIAppendSerialization,
_SecOTRPacketTypeString, _SecOTRPublicIdentityCopyFromPrivate,
_SecOTRPublicIdentityCreateFromBytes, _SecOTRPublicIdentityCreateFromData,
_SecOTRPublicIdentityCreateFromSecKeyRef, _SecOTRSAppendRestartPacket,
_SecOTRSAppendSerialization, _SecOTRSAppendStartPacket, _SecOTRSGetIsIdle,
_SecOTRSGetIsReadyForMessages, _SecOTRSGetMessageKind, _SecOTRSIsForKeys,
_SecOTRSPrecalculateKeys, _SecOTRSProcessPacket, _SecOTRSSignAndProtectMessage,
_SecOTRSVerifyAndExposeMessage, _SecOTRSessionCreateFromData,
_SecOTRSessionCreateFromID, _SecOTRSessionCreateFromIDAndFlags,
_SecOTRSessionCreateRemote, _SecOTRSessionIsSessionInAwaitingState,
_SecOTRSessionProcessPacketRemote, _SecOTRSessionReset, _SecPKCS12Import,
_SecPaddingCompute, _SecPasswordAction, _SecPasswordCopyDefaultPasswordLength,
_SecPasswordCreateWithRandomDigits, _SecPasswordGenerate,
_SecPasswordIsPasswordWeak, _SecPasswordIsPasswordWeak2, _SecPasswordSetInitialAccess,
_SecPasswordValidatePasswordFormat, _SecPolicyCheckCertCertificatePolicy,
_SecPolicyCheckCertCriticalExtensions, _SecPolicyCheckCertDuplicateExtension,
_SecPolicyCheckCertEAPTrustedServerNames, _SecPolicyCheckCertEmail,
_SecPolicyCheckCertExtendedKeyUsage, _SecPolicyCheckCertKeySize,
_SecPolicyCheckCertKeyUsage, _SecPolicyCheckCertLeafMarkerOid,
_SecPolicyCheckCertLeafMarkerOidWithoutValueCheck, _SecPolicyCheckCertLeafMarkersProdAndQA,
_SecPolicyCheckCertNonEmptySubject, _SecPolicyCheckCertNotCA,
_SecPolicyCheckCertNotValidBefore, _SecPolicyCheckCertSSLHostname,
_SecPolicyCheckCertSignatureHashAlgorithms, _SecPolicyCheckCertSubjectCommonName,
_SecPolicyCheckCertSubjectCommonNamePrefix, _SecPolicyCheckCertSubjectCommonNameTEST,
_SecPolicyCheckCertSubjectCountry, _SecPolicyCheckCertSubjectOrganization,
_SecPolicyCheckCertSubjectOrganizationalUnit, _SecPolicyCheckCertTemporalValidity,
_SecPolicyCheckCertUnparseableExtension, _SecPolicyCheckCertWeakKeySize,
_SecPolicyCheckCertWeakSignature, _SecPolicyCopyProperties,
_SecPolicyCreateAggregateMetricEncryption, _SecPolicyCreateAggregateMetricTransparency,
_SecPolicyCreateAlisha, _SecPolicyCreateAppleAST2Service,
_SecPolicyCreateAppleATVVPNProfileSigning, _SecPolicyCreateAppleAccessoryUpdateSigning,
_SecPolicyCreateAppleAppTransportSecurity, _SecPolicyCreateAppleAssetReceipt,
_SecPolicyCreateAppleBasicAttestationSystem, _SecPolicyCreateAppleBasicAttestationUser,
_SecPolicyCreateAppleCHIPUpdateSigning, _SecPolicyCreateAppleCompatibilityEscrowProxyService,
_SecPolicyCreateAppleCompatibilityMMCSService, _SecPolicyCreateAppleCompatibilityiCloudSetupService,
_SecPolicyCreateAppleComponentCertificate, _SecPolicyCreateAppleDeveloperIDPlusTicket,
_SecPolicyCreateAppleEscrowProxyService, _SecPolicyCreateAppleExternalDeveloper,
_SecPolicyCreateAppleFDRProvisioning, _SecPolicyCreateAppleFMiPService,
_SecPolicyCreateAppleGSService, _SecPolicyCreateAppleHomeKitServerAuth,
_SecPolicyCreateAppleIDAuthorityPolicy, _SecPolicyCreateAppleIDSService,
_SecPolicyCreateAppleIDSServiceContext, _SecPolicyCreateAppleIDValidationRecordSigningPolicy,
_SecPolicyCreateAppleKeyTransparency, _SecPolicyCreateAppleMMCSService,
_SecPolicyCreateApplePPQService, _SecPolicyCreateApplePPQSigning,
_SecPolicyCreateApplePackageSigning, _SecPolicyCreateApplePayIssuerEncryption,
_SecPolicyCreateApplePayModelSigning, _SecPolicyCreateApplePayQRCodeEncryption,
_SecPolicyCreateApplePayQRCodeSigning, _SecPolicyCreateApplePinned,
_SecPolicyCreateApplePushService, _SecPolicyCreateApplePushServiceLegacy,
_SecPolicyCreateAppleSMPEncryption, _SecPolicyCreateAppleSSLPinned,
_SecPolicyCreateAppleSSLService, _SecPolicyCreateAppleSWUpdateSigning,
_SecPolicyCreateAppleSecureIOStaticAsset, _SecPolicyCreateAppleSoftwareSigning,
_SecPolicyCreateAppleTVOSApplicationSigning, _SecPolicyCreateAppleTimeStamping,
_SecPolicyCreateAppleUniqueDeviceCertificate, _SecPolicyCreateAppleWarsaw,
_SecPolicyCreateAppleiCloudSetupService, _SecPolicyCreateBasicX509,
_SecPolicyCreateCodeSigning, _SecPolicyCreateConfigurationProfileSigner,
_SecPolicyCreateDemoDigitalCatalogSigning, _SecPolicyCreateDeveloperIDInstaller,
_SecPolicyCreateEAP, _SecPolicyCreateEscrowServiceIdKeySigning,
_SecPolicyCreateEscrowServiceSigner, _SecPolicyCreateFactoryDeviceCertificate,
_SecPolicyCreateIPSec, _SecPolicyCreateLegacySSL, _SecPolicyCreateLockdownPairing,
_SecPolicyCreateMDLTerminalAuth, _SecPolicyCreateMacAppStoreInstaller,
_SecPolicyCreateMacAppStoreReceipt, _SecPolicyCreateMacDistributionInstaller,
_SecPolicyCreateMacOSProfileApplicationSigning, _SecPolicyCreateMeasuredBootPolicySigning,
_SecPolicyCreateMobileAsset, _SecPolicyCreateMobileAssetDevelopment,
_SecPolicyCreateMobileSoftwareUpdate, _SecPolicyCreateMobileStoreSigner,
_SecPolicyCreateOCSPSigner, _SecPolicyCreateOSXProvisioningProfileSigning,
_SecPolicyCreateOTATasking, _SecPolicyCreatePCSEscrowServiceIdKeySigning,
_SecPolicyCreatePCSEscrowServiceSigner, _SecPolicyCreatePassbookCardSigner,
_SecPolicyCreateQAConfigurationProfileSigner, _SecPolicyCreateRevocation,
_SecPolicyCreateSMIME, _SecPolicyCreateSSL, _SecPolicyCreateSSLWithKeyUsage,
_SecPolicyCreateTestApplePPQSigning, _SecPolicyCreateTestAppleSMPEncryption,
_SecPolicyCreateTestMobileStoreSigner, _SecPolicyCreateURLBag,
_SecPolicyCreateWithProperties, _SecPolicyCreateiAP, _SecPolicyCreateiAPSWAuth,
_SecPolicyCreateiAPSWAuthWithExpiration, _SecPolicyCreateiPhoneActivation,
_SecPolicyCreateiPhoneApplicationSigning, _SecPolicyCreateiPhoneDeviceCertificate,
_SecPolicyCreateiPhoneProfileApplicationSigning, _SecPolicyCreateiPhoneProvisioningProfileSigning,
_SecPolicyCreateiPhoneVPNApplicationSigning, _SecPolicyCreateiTunesStoreURLBag,
_SecPolicyGetName, _SecPolicyGetOidString, _SecPolicyGetTypeID,
_SecPolicyReconcilePinningRequiredIfInfoSpecified, _SecPolicySearchCopyNext,
_SecPolicySearchCreate, _SecPolicySearchGetTypeID, _SecPolicySetName,
_SecPolicySetOptionsValue, _SecPolicySetSHA256Pins, _SecPolicyXPCArrayCopyArray,
_SecRKCopyAccountRecoveryPassword, _SecRKCopyAccountRecoveryVerifier,
_SecRKCopyBackupFullKey, _SecRKCopyBackupPublicKey, _SecRKCreateRecoveryKey,
_SecRKCreateRecoveryKeyString, _SecRKCreateRecoveryKeyWithError,
_SecRKRegisterBackupPublicKey, _SecRandomCopyBytes, _SecRandomCopyData,
_SecRequestSharedWebCredential, _SecRequirementCopyData, _SecRequirementCopyString,
_SecRequirementCreateGroup, _SecRequirementCreateWithData,
_SecRequirementCreateWithResource, _SecRequirementCreateWithString,
_SecRequirementCreateWithStringAndErrors, _SecRequirementEvaluate,
_SecRequirementGetTypeID, _SecRequirementsCopyRequirements,
_SecRequirementsCopyString, _SecRequirementsCreateFromRequirements,
_SecRequirementsCreateWithString, _SecSCEPCertifyRequest,
_SecSCEPCertifyRequestWithAlgorithms, _SecSCEPCreateTemporaryIdentity,
_SecSCEPGenerateCertificateRequest, _SecSCEPGetCertInitial,
_SecSCEPValidateCACertMessage, _SecSCEPVerifyReply, _SecSHA1DigestCreate,
_SecSHA256DigestCreate, _SecSHA256DigestCreateFromData, _SecSMIMEFindBulkAlgForRecipients,
_SecSecurityClientAppClipToRegular, _SecSecurityClientGet,
_SecSecurityClientRegularToAppClip, _SecSecurityClientSetApplicationIdentifier,
_SecSecuritySetMusrMode, _SecSecuritySetPersonaMusr, _SecServerSetTrustdMachServiceName,
_SecSetCustomHomeURL, _SecSetCustomHomeURLString, _SecSetLoggingInfoForCircleScope,
_SecSetLoggingInfoForXPCScope, _SecSignTransformCreate, _SecSignatureHashAlgorithmForAlgorithmOid,
_SecStaticCodeCancelValidation, _SecStaticCodeCheckValidity,
_SecStaticCodeCheckValidityWithErrors, _SecStaticCodeCreateWithPath,
_SecStaticCodeCreateWithPathAndAttributes, _SecStaticCodeEnableOnlineNotarizationCheck,
_SecStaticCodeGetTypeID, _SecStaticCodeSetCallback, _SecStaticCodeSetValidationConditions,
_SecStaticCodeValidateResourceWithErrors, _SecTaskCopySigningIdentifier,
_SecTaskCopyTeamIdentifier, _SecTaskCopyValueForEntitlement,
_SecTaskCopyValuesForEntitlements, _SecTaskCreateFromSelf,
_SecTaskCreateWithAuditToken, _SecTaskCreateWithXPCMessage,
_SecTaskEntitlementsValidated, _SecTaskGetCodeSignStatus,
_SecTaskGetTypeID, _SecTokenItemValueCopy, _SecTranformCustomGetAttribute,
_SecTransformConnectTransforms, _SecTransformConnectTransformsInternal,
_SecTransformCopyExternalRepresentation, _SecTransformCreate,
_SecTransformCreateFromExternalRepresentation, _SecTransformCreateGroupTransform,
_SecTransformCreateReadTransformWithReadStream, _SecTransformCreateValidatorForCFtype,
_SecTransformCustomSetAttribute, _SecTransformDisconnectTransforms,
_SecTransformDotForDebugging, _SecTransformExecute, _SecTransformExecuteAsync,
_SecTransformFindByName, _SecTransformGetAttribute, _SecTransformGetTypeID,
_SecTransformNoData, _SecTransformPushbackAttribute, _SecTransformRegister,
_SecTransformSetAttribute, _SecTransformSetAttributeAction,
_SecTransformSetDataAction, _SecTransformSetTransformAction,
_SecTranslocateAppLaunchCheckin, _SecTranslocateCreateGeneric,
_SecTranslocateCreateOriginalPathForURL, _SecTranslocateCreateSecureDirectoryForURL,
_SecTranslocateDeleteSecureDirectory, _SecTranslocateIsTranslocatedURL,
_SecTranslocateStartListening, _SecTranslocateStartListeningWithOptions,
_SecTranslocateURLShouldRunTranslocated, _SecTrustAddToInputCertificates,
_SecTrustCopyCertificateChain, _SecTrustCopyCustomAnchorCertificates,
_SecTrustCopyDetailedPropertiesAtIndex, _SecTrustCopyExceptions,
_SecTrustCopyFailureDescription, _SecTrustCopyFilteredDetails,
_SecTrustCopyInfo, _SecTrustCopyInputCertificates, _SecTrustCopyKey,
_SecTrustCopyPolicies, _SecTrustCopyProperties, _SecTrustCopyProperties_ios,
_SecTrustCopyPublicKey, _SecTrustCopyResult, _SecTrustCopySummaryPropertiesAtIndex,
_SecTrustCreateWithCertificates, _SecTrustDeserialize, _SecTrustEvaluate,
_SecTrustEvaluateAsync, _SecTrustEvaluateAsyncWithError, _SecTrustEvaluateFastAsync,
_SecTrustEvaluateLeafOnly, _SecTrustEvaluateWithError, _SecTrustFlushResponseCache,
_SecTrustGetAppleAnchors, _SecTrustGetAssetVersionNumber,
_SecTrustGetCertificateAtIndex, _SecTrustGetCertificateCount,
_SecTrustGetDetails, _SecTrustGetExceptionResetCount, _SecTrustGetKeychainsAllowed,
_SecTrustGetNetworkFetchAllowed, _SecTrustGetTrustExceptionsArray,
_SecTrustGetTrustResult, _SecTrustGetTrustStoreVersionNumber,
_SecTrustGetTypeID, _SecTrustGetVerifyTime, _SecTrustIncrementExceptionResetCount,
_SecTrustIsExpiredOnly, _SecTrustIsTrustResultValid, _SecTrustLegacySourcesListenForKeychainEvents,
_SecTrustOTAPKIGetUpdatedAsset, _SecTrustOTASecExperimentCopyAsset,
_SecTrustOTASecExperimentGetUpdatedAsset, _SecTrustReportNetworkingAnalytics,
_SecTrustReportTLSAnalytics, _SecTrustSerialize, _SecTrustSetAnchorCertificates,
_SecTrustSetAnchorCertificatesOnly, _SecTrustSetClientAuditToken,
_SecTrustSetExceptions, _SecTrustSetKeychainsAllowed, _SecTrustSetNeedsEvaluation,
_SecTrustSetNetworkFetchAllowed, _SecTrustSetOCSPResponse,
_SecTrustSetPinningException, _SecTrustSetPinningPolicyName,
_SecTrustSetPolicies, _SecTrustSetSignedCertificateTimestamps,
_SecTrustSetTrustedLogs, _SecTrustSetVerifyDate, _SecTrustSettingsDomainForName,
_SecTrustSettingsDomainName, _SecTrustStoreContains, _SecTrustStoreCopyAll,
_SecTrustStoreCopyCARevocationAdditions, _SecTrustStoreCopyCTExceptions,
_SecTrustStoreCopyTransparentConnectionPins, _SecTrustStoreCopyUsageConstraints,
_SecTrustStoreDomainName, _SecTrustStoreForDomain, _SecTrustStoreGetSettingsAssetVersionNumber,
_SecTrustStoreGetSettingsVersionNumber, _SecTrustStoreRemoveAll,
_SecTrustStoreRemoveCertificate, _SecTrustStoreSetCARevocationAdditions,
_SecTrustStoreSetCTExceptions, _SecTrustStoreSetTransparentConnectionPins,
_SecTrustStoreSetTrustSettings, _SecTrustTriggerValidUpdate,
_SecTrustedApplicationCopyData, _SecTrustedApplicationCopyExternalRepresentation,
_SecTrustedApplicationCopyRequirement, _SecTrustedApplicationCreateApplicationGroup,
_SecTrustedApplicationCreateFromPath, _SecTrustedApplicationCreateFromRequirement,
_SecTrustedApplicationCreateWithExternalRepresentation, _SecTrustedApplicationGetTypeID,
_SecTrustedApplicationIsUpdateCandidate, _SecTrustedApplicationMakeEquivalent,
_SecTrustedApplicationRemoveEquivalence, _SecTrustedApplicationSetData,
_SecTrustedApplicationUseAlternateSystem, _SecTrustedApplicationValidateWithPath,
_SecUnwrapRecoveryPasswordWithAnswers, _SecVerifyCertificateRequest,
_SecVerifyTransformCreate, _SecWrapRecoveryPasswordWithAnswers,
_SecureDownloadCopyCreationDate, _SecureDownloadCopyName,
_SecureDownloadCopyTicketLocation, _SecureDownloadCopyURLs,
_SecureDownloadCreateWithTicket, _SecureDownloadFinished,
_SecureDownloadGetDownloadSize, _SecureDownloadRelease, _SecureDownloadUpdateWithData,
_SessionCreate, _SessionGetDistinguishedUser, _SessionGetInfo,
_SessionSetDistinguishedUser, _SessionSetUserPreferences,
__OctagonSignpostCreate, __OctagonSignpostGetNanoseconds,
__OctagonSignpostLogSystem, __SOSControlSetupInterface, __SSLProtocolVersionToWireFormatValue,
__SecItemAddAndNotifyOnSync, __SecItemCreatePersistentRef,
__SecItemCreateUUIDBasedPersistentRef, __SecItemFetchDigests,
__SecItemParsePersistentRef, __SecKeyCopyUnwrapKey, __SecKeyCopyWrapKey,
__SecKeychainBackupSyncable, __SecKeychainCopyBackup, __SecKeychainCopyEMCSBackup,
__SecKeychainCopyKeybagUUIDFromFileDescriptor, __SecKeychainCopyOTABackup,
__SecKeychainDeleteMultiUser, __SecKeychainRestoreBackup,
__SecKeychainRestoreBackupFromFileDescriptor, __SecKeychainRestoreSyncable,
__SecKeychainRollKeys, __SecKeychainSyncUpdateMessage, __SecKeychainWriteBackupToFileDescriptor,
__SecSecuritydCopyCKKSEndpoint, __SecSecuritydCopyKeychainControlEndpoint,
__SecSecuritydCopySFKeychainEndpoint, __SecSecuritydCopyWhoAmI,
__SecSetSecuritydTargetUID, __SecSyncBubbleTransfer, __SecSyncDeleteUserViews,
__SecSystemKeychainTransfer, ___security_simulatecrash, ___security_simulatecrash_enable,
___security_simulatecrash_enabled, ___security_stackshotreport,
__kSecKeyWrapPGPFingerprint, __kSecKeyWrapPGPSymAlg, __kSecKeyWrapPGPWrapAlg,
__kSecKeyWrapRFC6637Flags, __kSecKeyWrapRFC6637WrapDigestSHA256KekAES128,
__kSecKeyWrapRFC6637WrapDigestSHA512KekAES256, _api_trace,
_bskbRkbgPrefix, _checkpw, _checkpw_internal, _debugDumpCircle,
_der_decode_BackupSliceKeyBag, _der_decode_data_or_null, _der_decode_plist,
_der_encode_BackupSliceKeyBag, _der_encode_data_or_null, _der_encode_plist,
_der_encode_plist_repair, _der_sizeof_BackupSliceKeyBag, _der_sizeof_data_or_null,
_der_sizeof_plist, _gSecurityd, _gTrustd, _kCKKSViewApplePay,
_kCKKSViewAutoUnlock, _kCKKSViewEngram, _kCKKSViewHealth,
_kCKKSViewHome, _kCKKSViewLimitedPeersAllowed, _kCKKSViewMFi,
_kCKKSViewManatee, _kCMSEncoderDigestAlgorithmSHA1, _kCMSEncoderDigestAlgorithmSHA256,
_kDisabledOverride, _kPIDeviceModelNameKey, _kPIMessageProtocolVersionKey,
_kPIOSVersionKey, _kPIUserDefinedDeviceNameKey, _kSOSCCCircleChangedNotification,
_kSOSCCCircleOctagonKeysChangedNotification, _kSOSCCEngineStateCoderKey,
_kSOSCCEngineStateManifestCountKey, _kSOSCCEngineStateManifestHashKey,
_kSOSCCEngineStatePeerIDKey, _kSOSCCEngineStateSyncSetKey,
_kSOSCCHoldLockForInitialSync, _kSOSCCInitialSyncChangedNotification,
_kSOSCCPeerAvailable, _kSOSCCRecoveryKeyChanged, _kSOSCCViewMembershipChangedNotification,
_kSOSCountKey, _kSOSDSIDKey, _kSOSErrorDomain, _kSOSHsaCrKeyDictionary,
_kSOSInternalAccessGroup, _kSOSKVSAccountChangedKey, _kSOSKVSInitialSyncKey,
_kSOSKVSKeyParametersKey, _kSOSKVSLastCleanupTimestampKey,
_kSOSKVSOTRConfigVersion, _kSOSKVSOfficialDSIDKey, _kSOSKVSRequiredKey,
_kSOSKVSWroteLastKeyParams, _kSOSNoCachedValue, _kSOSPeerSetCallbacks,
_kSOSViewAccessoryPairing, _kSOSViewAppleTV, _kSOSViewAutofillPasswords,
_kSOSViewAutofillPasswords_tomb, _kSOSViewBackupBagV0, _kSOSViewBackupBagV0_tomb,
_kSOSViewContinuityUnlock, _kSOSViewHintAppleTV, _kSOSViewHintHomeKit,
_kSOSViewHintPCSCloudKit, _kSOSViewHintPCSEscrow, _kSOSViewHintPCSFDE,
_kSOSViewHintPCSMailDrop, _kSOSViewHintPCSMasterKey, _kSOSViewHintPCSNotes,
_kSOSViewHintPCSPhotos, _kSOSViewHintPCSiCloudBackup, _kSOSViewHintPCSiCloudDrive,
_kSOSViewHintPCSiMessage, _kSOSViewHomeKit, _kSOSViewKeychainV0,
_kSOSViewKeychainV0_tomb, _kSOSViewNanoRegistry, _kSOSViewOtherSyncable,
_kSOSViewOtherSyncable_tomb, _kSOSViewPCSCloudKit, _kSOSViewPCSEscrow,
_kSOSViewPCSFDE, _kSOSViewPCSFeldspar, _kSOSViewPCSMailDrop,
_kSOSViewPCSMasterKey, _kSOSViewPCSNotes, _kSOSViewPCSPhotos,
_kSOSViewPCSSharing, _kSOSViewPCSiCloudBackup, _kSOSViewPCSiCloudDrive,
_kSOSViewPCSiMessage, _kSOSViewSafariCreditCards, _kSOSViewSafariCreditCards_tomb,
_kSOSViewWatchMigration, _kSOSViewWiFi, _kSOSViewWiFi_tomb,
_kSOSViewiCloudIdentity, _kSOSViewiCloudIdentity_tomb, _kSSLSessionConfig_3DES_fallback,
_kSSLSessionConfig_ATSv1, _kSSLSessionConfig_ATSv1_noPFS,
_kSSLSessionConfig_RC4_fallback, _kSSLSessionConfig_TLSv1_3DES_fallback,
_kSSLSessionConfig_TLSv1_RC4_fallback, _kSSLSessionConfig_TLSv1_fallback,
_kSSLSessionConfig_anonymous, _kSSLSessionConfig_default,
_kSSLSessionConfig_legacy, _kSSLSessionConfig_legacy_DHE,
_kSSLSessionConfig_standard, _kSecACLAuthorizationAny, _kSecACLAuthorizationChangeACL,
_kSecACLAuthorizationChangeOwner, _kSecACLAuthorizationDecrypt,
_kSecACLAuthorizationDelete, _kSecACLAuthorizationDerive,
_kSecACLAuthorizationEncrypt, _kSecACLAuthorizationExportClear,
_kSecACLAuthorizationExportWrapped, _kSecACLAuthorizationGenKey,
_kSecACLAuthorizationImportClear, _kSecACLAuthorizationImportWrapped,
_kSecACLAuthorizationIntegrity, _kSecACLAuthorizationKeychainCreate,
_kSecACLAuthorizationKeychainDelete, _kSecACLAuthorizationKeychainItemDelete,
_kSecACLAuthorizationKeychainItemInsert, _kSecACLAuthorizationKeychainItemModify,
_kSecACLAuthorizationKeychainItemRead, _kSecACLAuthorizationLogin,
_kSecACLAuthorizationMAC, _kSecACLAuthorizationPartitionID,
_kSecACLAuthorizationSign, _kSecAsn1ATVTemplate, _kSecAsn1AccessDescriptionTemplate,
_kSecAsn1AlgorithmIDTemplate, _kSecAsn1AnyTemplate, _kSecAsn1AttributeTemplate,
_kSecAsn1AuthorityInfoAccessTemplate, _kSecAsn1AuthorityKeyIdTemplate,
_kSecAsn1BMPStringTemplate, _kSecAsn1BasicConstraintsTemplate,
_kSecAsn1BitStringTemplate, _kSecAsn1BooleanTemplate, _kSecAsn1CRLDistributionPointsTemplate,
_kSecAsn1CertExtensionTemplate, _kSecAsn1CertPoliciesTemplate,
_kSecAsn1CertRequestInfoTemplate, _kSecAsn1CertRequestTemplate,
_kSecAsn1DHAlgorithmIdentifierX942Template, _kSecAsn1DHDomainParamsX942Template,
_kSecAsn1DHParameterBlockTemplate, _kSecAsn1DHParameterTemplate,
_kSecAsn1DHPrivateKeyPKCS8Template, _kSecAsn1DHPrivateKeyTemplate,
_kSecAsn1DHPublicKeyX509Template, _kSecAsn1DHValidationParamsTemplate,
_kSecAsn1DSAAlgParamsBSAFETemplate, _kSecAsn1DSAAlgParamsTemplate,
_kSecAsn1DSAAlgorithmIdBSAFETemplate, _kSecAsn1DSAAlgorithmIdX509Template,
_kSecAsn1DSAPrivateKeyBSAFETemplate, _kSecAsn1DSAPrivateKeyOctsTemplate,
_kSecAsn1DSAPrivateKeyOpensslTemplate, _kSecAsn1DSAPrivateKeyPKCS8Template,
_kSecAsn1DSAPublicKeyBSAFETemplate, _kSecAsn1DSAPublicKeyX509Template,
_kSecAsn1DSASignatureTemplate, _kSecAsn1DigestInfoTemplate,
_kSecAsn1DistPointFullNameTemplate, _kSecAsn1DistPointRDNTemplate,
_kSecAsn1DistributionPointTemplate, _kSecAsn1ECDSAPrivateKeyInfoTemplate,
_kSecAsn1EncryptedPrivateKeyInfoTemplate, _kSecAsn1EnumeratedTemplate,
_kSecAsn1GenNameOtherNameTemplate, _kSecAsn1GeneralNameTemplate,
_kSecAsn1GeneralizedTimeTemplate, _kSecAsn1IA5StringTemplate,
_kSecAsn1IntegerTemplate, _kSecAsn1IssuingDistributionPointTemplate,
_kSecAsn1NameConstraintsTemplate, _kSecAsn1NameTemplate, _kSecAsn1NullTemplate,
_kSecAsn1OCSPBasicResponseTemplate, _kSecAsn1OCSPCertIDTemplate,
_kSecAsn1OCSPCertStatusGoodTemplate, _kSecAsn1OCSPCertStatusRevokedTemplate,
_kSecAsn1OCSPCertStatusUnknownTemplate, _kSecAsn1OCSPDRepliesTemplate,
_kSecAsn1OCSPDReplyTemplate, _kSecAsn1OCSPDRequestTemplate,
_kSecAsn1OCSPDRequestsTemplate, _kSecAsn1OCSPRequestTemplate,
_kSecAsn1OCSPResponderIDAsKeyTemplate, _kSecAsn1OCSPResponderIDAsNameTemplate,
_kSecAsn1OCSPResponseBytesTemplate, _kSecAsn1OCSPResponseDataTemplate,
_kSecAsn1OCSPResponseTemplate, _kSecAsn1OCSPRevokedInfoTemplate,
_kSecAsn1OCSPSignatureTemplate, _kSecAsn1OCSPSignedRequestTemplate,
_kSecAsn1OCSPSingleResponseTemplate, _kSecAsn1OCSPTbsRequestTemplate,
_kSecAsn1ObjectIDTemplate, _kSecAsn1OctetStringTemplate, _kSecAsn1OtherNameTemplate,
_kSecAsn1PointerToAnyTemplate, _kSecAsn1PointerToBMPStringTemplate,
_kSecAsn1PointerToBitStringTemplate, _kSecAsn1PointerToBooleanTemplate,
_kSecAsn1PointerToEnumeratedTemplate, _kSecAsn1PointerToGeneralizedTimeTemplate,
_kSecAsn1PointerToIA5StringTemplate, _kSecAsn1PointerToIntegerTemplate,
_kSecAsn1PointerToNullTemplate, _kSecAsn1PointerToObjectIDTemplate,
_kSecAsn1PointerToOctetStringTemplate, _kSecAsn1PointerToPrintableStringTemplate,
_kSecAsn1PointerToT61StringTemplate, _kSecAsn1PointerToTeletexStringTemplate,
_kSecAsn1PointerToUTCTimeTemplate, _kSecAsn1PointerToUTF8StringTemplate,
_kSecAsn1PointerToUniversalStringTemplate, _kSecAsn1PointerToVisibleStringTemplate,
_kSecAsn1PolicyConstraintsTemplate, _kSecAsn1PolicyInformationTemplate,
_kSecAsn1PolicyMappingsTemplate, _kSecAsn1PolicyQualifierTemplate,
_kSecAsn1PrintableStringTemplate, _kSecAsn1PrivateKeyInfoTemplate,
_kSecAsn1QC_StatementTemplate, _kSecAsn1QC_StatementsTemplate,
_kSecAsn1RDNTemplate, _kSecAsn1RSAPrivateKeyPKCS1Template,
_kSecAsn1RSAPublicKeyPKCS1Template, _kSecAsn1RevokedCertTemplate,
_kSecAsn1SemanticsInformationTemplate, _kSecAsn1SequenceOfAnyTemplate,
_kSecAsn1SequenceOfBMPStringTemplate, _kSecAsn1SequenceOfBitStringTemplate,
_kSecAsn1SequenceOfBooleanTemplate, _kSecAsn1SequenceOfCertExtensionTemplate,
_kSecAsn1SequenceOfEnumeratedTemplate, _kSecAsn1SequenceOfGeneralizedTimeTemplate,
_kSecAsn1SequenceOfIA5StringTemplate, _kSecAsn1SequenceOfIntegerTemplate,
_kSecAsn1SequenceOfNullTemplate, _kSecAsn1SequenceOfObjectIDTemplate,
_kSecAsn1SequenceOfOctetStringTemplate, _kSecAsn1SequenceOfPrintableStringTemplate,
_kSecAsn1SequenceOfRevokedCertTemplate, _kSecAsn1SequenceOfT61StringTemplate,
_kSecAsn1SequenceOfTeletexStringTemplate, _kSecAsn1SequenceOfUTCTimeTemplate,
_kSecAsn1SequenceOfUTF8StringTemplate, _kSecAsn1SequenceOfUniversalStringTemplate,
_kSecAsn1SequenceOfVisibleStringTemplate, _kSecAsn1SetOfAnyTemplate,
_kSecAsn1SetOfAttributeTemplate, _kSecAsn1SetOfBMPStringTemplate,
_kSecAsn1SetOfBitStringTemplate, _kSecAsn1SetOfBooleanTemplate,
_kSecAsn1SetOfEnumeratedTemplate, _kSecAsn1SetOfGeneralizedTimeTemplate,
_kSecAsn1SetOfIA5StringTemplate, _kSecAsn1SetOfIntegerTemplate,
_kSecAsn1SetOfNullTemplate, _kSecAsn1SetOfObjectIDTemplate,
_kSecAsn1SetOfOctetStringTemplate, _kSecAsn1SetOfPrintableStringTemplate,
_kSecAsn1SetOfT61StringTemplate, _kSecAsn1SetOfTeletexStringTemplate,
_kSecAsn1SetOfUTCTimeTemplate, _kSecAsn1SetOfUTF8StringTemplate,
_kSecAsn1SetOfUniversalStringTemplate, _kSecAsn1SetOfVisibleStringTemplate,
_kSecAsn1SignedCertOrCRLTemplate, _kSecAsn1SignedCertRequestTemplate,
_kSecAsn1SignedCertTemplate, _kSecAsn1SignedCrlTemplate, _kSecAsn1SkipTemplate,
_kSecAsn1SubjectPublicKeyInfoTemplate, _kSecAsn1T61StringTemplate,
_kSecAsn1TBSCertificateTemplate, _kSecAsn1TBSCrlTemplate,
_kSecAsn1TeletexStringTemplate, _kSecAsn1TimeTemplate, _kSecAsn1UTCTimeTemplate,
_kSecAsn1UTF8StringTemplate, _kSecAsn1UniversalStringTemplate,
_kSecAsn1UnsignedIntegerTemplate, _kSecAsn1ValidityTemplate,
_kSecAsn1VisibleStringTemplate, _kSecAssessmentAssessmentAuthority,
_kSecAssessmentAssessmentAuthorityFlags, _kSecAssessmentAssessmentAuthorityOriginalVerdict,
_kSecAssessmentAssessmentAuthorityOverride, _kSecAssessmentAssessmentAuthorityRow,
_kSecAssessmentAssessmentCodeSigningError, _kSecAssessmentAssessmentFromCache,
_kSecAssessmentAssessmentNotarizationDate, _kSecAssessmentAssessmentOriginator,
_kSecAssessmentAssessmentSource, _kSecAssessmentAssessmentVerdict,
_kSecAssessmentAssessmentWeakSignature, _kSecAssessmentContextKeyFeedback,
_kSecAssessmentContextKeyOperation, _kSecAssessmentContextKeyPrimarySignature,
_kSecAssessmentContextKeyUTI, _kSecAssessmentContextKeyUpdate,
_kSecAssessmentFeedbackInfoCurrent, _kSecAssessmentFeedbackInfoTotal,
_kSecAssessmentFeedbackProgress, _kSecAssessmentOperationTypeExecute,
_kSecAssessmentOperationTypeInstall, _kSecAssessmentOperationTypeOpenDocument,
_kSecAssessmentRuleKeyAllow, _kSecAssessmentRuleKeyBookmark,
_kSecAssessmentRuleKeyDisabled, _kSecAssessmentRuleKeyExpires,
_kSecAssessmentRuleKeyID, _kSecAssessmentRuleKeyLabel, _kSecAssessmentRuleKeyPriority,
_kSecAssessmentRuleKeyRemarks, _kSecAssessmentRuleKeyRequirement,
_kSecAssessmentRuleKeyType, _kSecAssessmentUpdateKeyAllow,
_kSecAssessmentUpdateKeyAuthorization, _kSecAssessmentUpdateKeyCount,
_kSecAssessmentUpdateKeyExpires, _kSecAssessmentUpdateKeyFound,
_kSecAssessmentUpdateKeyLabel, _kSecAssessmentUpdateKeyPriority,
_kSecAssessmentUpdateKeyRemarks, _kSecAssessmentUpdateKeyRow,
_kSecAssessmentUpdateOperationAdd, _kSecAssessmentUpdateOperationDisable,
_kSecAssessmentUpdateOperationEnable, _kSecAssessmentUpdateOperationFind,
_kSecAssessmentUpdateOperationRemove, _kSecAttrAFPServerSignature,
_kSecAttrAccess, _kSecAttrAccessControl, _kSecAttrAccessGroup,
_kSecAttrAccessGroupToken, _kSecAttrAccessible, _kSecAttrAccessibleAfterFirstUnlock,
_kSecAttrAccessibleAfterFirstUnlockThisDeviceOnly, _kSecAttrAccessibleAlways,
_kSecAttrAccessibleAlwaysPrivate, _kSecAttrAccessibleAlwaysThisDeviceOnly,
_kSecAttrAccessibleAlwaysThisDeviceOnlyPrivate, _kSecAttrAccessibleUntilReboot,
_kSecAttrAccessibleWhenPasscodeSetThisDeviceOnly, _kSecAttrAccessibleWhenUnlocked,
_kSecAttrAccessibleWhenUnlockedThisDeviceOnly, _kSecAttrAccount,
_kSecAttrAddress, _kSecAttrAlias, _kSecAttrApplicationLabel,
_kSecAttrApplicationTag, _kSecAttrAuthenticationType, _kSecAttrAuthenticationTypeDPA,
_kSecAttrAuthenticationTypeDefault, _kSecAttrAuthenticationTypeHTMLForm,
_kSecAttrAuthenticationTypeHTTPBasic, _kSecAttrAuthenticationTypeHTTPDigest,
_kSecAttrAuthenticationTypeMSN, _kSecAttrAuthenticationTypeNTLM,
_kSecAttrAuthenticationTypeRPA, _kSecAttrCRLEncoding, _kSecAttrCRLType,
_kSecAttrCanDecrypt, _kSecAttrCanDerive, _kSecAttrCanEncrypt,
_kSecAttrCanSign, _kSecAttrCanSignRecover, _kSecAttrCanUnwrap,
_kSecAttrCanVerify, _kSecAttrCanVerifyRecover, _kSecAttrCanWrap,
_kSecAttrCertificateEncoding, _kSecAttrCertificateType, _kSecAttrComment,
_kSecAttrCreationDate, _kSecAttrCreator, _kSecAttrDeriveSyncIDFromItemAttributes,
_kSecAttrDescription, _kSecAttrEffectiveKeySize, _kSecAttrEndDate,
_kSecAttrGeneric, _kSecAttrHasCustomIcon, _kSecAttrIsExtractable,
_kSecAttrIsInvisible, _kSecAttrIsModifiable, _kSecAttrIsNegative,
_kSecAttrIsPermanent, _kSecAttrIsPrivate, _kSecAttrIsSensitive,
_kSecAttrIssuer, _kSecAttrKeyClass, _kSecAttrKeyClassPrivate,
_kSecAttrKeyClassPublic, _kSecAttrKeyClassSymmetric, _kSecAttrKeyCreator,
_kSecAttrKeySizeInBits, _kSecAttrKeyType, _kSecAttrKeyType3DES,
_kSecAttrKeyTypeAES, _kSecAttrKeyTypeCAST, _kSecAttrKeyTypeDES,
_kSecAttrKeyTypeDSA, _kSecAttrKeyTypeEC, _kSecAttrKeyTypeECDSA,
_kSecAttrKeyTypeECSECPrimeRandom, _kSecAttrKeyTypeECSECPrimeRandomPKA,
_kSecAttrKeyTypeRC2, _kSecAttrKeyTypeRC4, _kSecAttrKeyTypeRSA,
_kSecAttrKeyTypeSecureEnclaveAttestation, _kSecAttrLabel,
_kSecAttrModificationDate, _kSecAttrMultiUser, _kSecAttrNoLegacy,
_kSecAttrPCSPlaintextPublicIdentity, _kSecAttrPCSPlaintextPublicKey,
_kSecAttrPCSPlaintextServiceIdentifier, _kSecAttrPRF, _kSecAttrPRFHmacAlgSHA1,
_kSecAttrPRFHmacAlgSHA224, _kSecAttrPRFHmacAlgSHA256, _kSecAttrPRFHmacAlgSHA384,
_kSecAttrPRFHmacAlgSHA512, _kSecAttrPath, _kSecAttrPersistantReference,
_kSecAttrPersistentReference, _kSecAttrPort, _kSecAttrProtocol,
_kSecAttrProtocolAFP, _kSecAttrProtocolAppleTalk, _kSecAttrProtocolDAAP,
_kSecAttrProtocolEPPC, _kSecAttrProtocolFTP, _kSecAttrProtocolFTPAccount,
_kSecAttrProtocolFTPProxy, _kSecAttrProtocolFTPS, _kSecAttrProtocolHTTP,
_kSecAttrProtocolHTTPProxy, _kSecAttrProtocolHTTPS, _kSecAttrProtocolHTTPSProxy,
_kSecAttrProtocolIMAP, _kSecAttrProtocolIMAPS, _kSecAttrProtocolIPP,
_kSecAttrProtocolIRC, _kSecAttrProtocolIRCS, _kSecAttrProtocolLDAP,
_kSecAttrProtocolLDAPS, _kSecAttrProtocolNNTP, _kSecAttrProtocolNNTPS,
_kSecAttrProtocolPOP3, _kSecAttrProtocolPOP3S, _kSecAttrProtocolRTSP,
_kSecAttrProtocolRTSPProxy, _kSecAttrProtocolSMB, _kSecAttrProtocolSMTP,
_kSecAttrProtocolSOCKS, _kSecAttrProtocolSSH, _kSecAttrProtocolTelnet,
_kSecAttrProtocolTelnetS, _kSecAttrPublicKeyHash, _kSecAttrRounds,
_kSecAttrSHA1, _kSecAttrSalt, _kSecAttrScriptCode, _kSecAttrSecureEnclaveKeyBlob,
_kSecAttrSecurityDomain, _kSecAttrSerialNumber, _kSecAttrServer,
_kSecAttrService, _kSecAttrStartDate, _kSecAttrSubject, _kSecAttrSubjectKeyID,
_kSecAttrSyncViewHint, _kSecAttrSynchronizable, _kSecAttrSynchronizableAny,
_kSecAttrSysBound, _kSecAttrTokenID, _kSecAttrTokenIDAppleKeyStore,
_kSecAttrTokenIDSecureElement, _kSecAttrTokenIDSecureEnclave,
_kSecAttrTokenOID, _kSecAttrTombstone, _kSecAttrType, _kSecAttrUUID,
_kSecAttrViewHintAccessoryPairing, _kSecAttrViewHintApplePay,
_kSecAttrViewHintAppleTV, _kSecAttrViewHintAutoUnlock, _kSecAttrViewHintContinuityUnlock,
_kSecAttrViewHintEngram, _kSecAttrViewHintHealth, _kSecAttrViewHintHome,
_kSecAttrViewHintHomeKit, _kSecAttrViewHintLimitedPeersAllowed,
_kSecAttrViewHintMFi, _kSecAttrViewHintManatee, _kSecAttrViewHintNanoRegistry,
_kSecAttrViewHintPCSCloudKit, _kSecAttrViewHintPCSEscrow,
_kSecAttrViewHintPCSFDE, _kSecAttrViewHintPCSFeldspar, _kSecAttrViewHintPCSMailDrop,
_kSecAttrViewHintPCSMasterKey, _kSecAttrViewHintPCSNotes,
_kSecAttrViewHintPCSPhotos, _kSecAttrViewHintPCSSharing, _kSecAttrViewHintPCSiCloudBackup,
_kSecAttrViewHintPCSiCloudDrive, _kSecAttrViewHintPCSiMessage,
_kSecAttrViewHintWatchMigration, _kSecAttrVolume, _kSecAttrWasAlwaysSensitive,
_kSecAttrWasNeverExtractable, _kSecBase32Encoding, _kSecBase64Encoding,
_kSecCARevocationAdditionsKey, _kSecCARevocationHashAlgorithmKey,
_kSecCARevocationSPKIHashKey, _kSecCFErrorArchitecture, _kSecCFErrorGuestAttributes,
_kSecCFErrorInfoPlist, _kSecCFErrorPath, _kSecCFErrorPattern,
_kSecCFErrorRequirementSyntax, _kSecCFErrorResourceAdded,
_kSecCFErrorResourceAltered, _kSecCFErrorResourceMissing,
_kSecCFErrorResourceSeal, _kSecCFErrorResourceSideband, _kSecCMSAdditionalCerts,
_kSecCMSAllCerts, _kSecCMSBulkEncryptionAlgorithm, _kSecCMSCertChainMode,
_kSecCMSCertChainModeNone, _kSecCMSEncryptionAlgorithmAESCBC,
_kSecCMSEncryptionAlgorithmDESCBC, _kSecCMSExpirationDate,
_kSecCMSHashAgility, _kSecCMSHashAgilityV2, _kSecCMSHashingAlgorithmMD5,
_kSecCMSHashingAlgorithmSHA1, _kSecCMSHashingAlgorithmSHA256,
_kSecCMSHashingAlgorithmSHA384, _kSecCMSHashingAlgorithmSHA512,
_kSecCMSSignDate, _kSecCMSSignDetached, _kSecCMSSignDigest,
_kSecCMSSignHashAlgorithm, _kSecCMSSignedAttributes, _kSecCSRBasicContraintsPathLen,
_kSecCSRChallengePassword, _kSecCTExceptionsCAsKey, _kSecCTExceptionsDomainsKey,
_kSecCTExceptionsHashAlgorithmKey, _kSecCTExceptionsSPKIHashKey,
_kSecCertificateDetailSHA1Digest, _kSecCertificateDetailStatusCodes,
_kSecCertificateEscrowFileName, _kSecCertificateExtendedKeyUsage,
_kSecCertificateExtensions, _kSecCertificateExtensionsEncoded,
_kSecCertificateKeyUsage, _kSecCertificateLifetime, _kSecCertificateProductionEscrowKey,
_kSecCertificateProductionPCSEscrowKey, _kSecClass, _kSecClassAppleSharePassword,
_kSecClassCertificate, _kSecClassGenericPassword, _kSecClassIdentity,
_kSecClassInternetPassword, _kSecClassKey, _kSecCodeAttributeArchitecture,
_kSecCodeAttributeBundleVersion, _kSecCodeAttributeSubarchitecture,
_kSecCodeAttributeUniversalFileOffset, _kSecCodeDirectoryFlagTable,
_kSecCodeInfoCMS, _kSecCodeInfoCMSDigest, _kSecCodeInfoCMSDigestHashType,
_kSecCodeInfoCdHashes, _kSecCodeInfoCdHashesFull, _kSecCodeInfoCertificates,
_kSecCodeInfoChangedFiles, _kSecCodeInfoCodeDirectory, _kSecCodeInfoCodeOffset,
_kSecCodeInfoDesignatedRequirement, _kSecCodeInfoDigestAlgorithm,
_kSecCodeInfoDigestAlgorithms, _kSecCodeInfoDiskRepInfo, _kSecCodeInfoDiskRepNoLibraryValidation,
_kSecCodeInfoDiskRepVersionMin, _kSecCodeInfoDiskRepVersionPlatform,
_kSecCodeInfoDiskRepVersionSDK, _kSecCodeInfoEntitlements,
_kSecCodeInfoEntitlementsDER, _kSecCodeInfoEntitlementsDict,
_kSecCodeInfoFlags, _kSecCodeInfoFormat, _kSecCodeInfoIdentifier,
_kSecCodeInfoImplicitDesignatedRequirement, _kSecCodeInfoMainExecutable,
_kSecCodeInfoNotarizationDate, _kSecCodeInfoPList, _kSecCodeInfoPlatformIdentifier,
_kSecCodeInfoRequirementData, _kSecCodeInfoRequirements, _kSecCodeInfoResourceDirectory,
_kSecCodeInfoRuntimeVersion, _kSecCodeInfoSignatureVersion,
_kSecCodeInfoSource, _kSecCodeInfoStatus, _kSecCodeInfoTeamIdentifier,
_kSecCodeInfoTime, _kSecCodeInfoTimestamp, _kSecCodeInfoTrust,
_kSecCodeInfoUnique, _kSecCodeSignerApplicationData, _kSecCodeSignerDetached,
_kSecCodeSignerDigestAlgorithm, _kSecCodeSignerDryRun, _kSecCodeSignerEditCMS,
_kSecCodeSignerEditCpuSubtype, _kSecCodeSignerEditCpuType,
_kSecCodeSignerEntitlements, _kSecCodeSignerFlags, _kSecCodeSignerIdentifier,
_kSecCodeSignerIdentifierPrefix, _kSecCodeSignerIdentity,
_kSecCodeSignerOmitAdhocFlag, _kSecCodeSignerPageSize, _kSecCodeSignerPlatformIdentifier,
_kSecCodeSignerPreserveAFSC, _kSecCodeSignerPreserveMetadata,
_kSecCodeSignerRequireTimestamp, _kSecCodeSignerRequirements,
_kSecCodeSignerResourceRules, _kSecCodeSignerRuntimeVersion,
_kSecCodeSignerSDKRoot, _kSecCodeSignerSigningTime, _kSecCodeSignerTeamIdentifier,
_kSecCodeSignerTimestampAuthentication, _kSecCodeSignerTimestampOmitCertificates,
_kSecCodeSignerTimestampServer, _kSecCompressionRatio, _kSecDataInetExtraClientDefined0,
_kSecDataInetExtraClientDefined1, _kSecDataInetExtraClientDefined2,
_kSecDataInetExtraClientDefined3, _kSecDataInetExtraHistory,
_kSecDataInetExtraNotes, _kSecDecodeTypeAttribute, _kSecDigestHMACKeyAttribute,
_kSecDigestHMACMD5, _kSecDigestHMACSHA1, _kSecDigestHMACSHA2,
_kSecDigestLengthAttribute, _kSecDigestMD2, _kSecDigestMD4,
_kSecDigestMD5, _kSecDigestSHA1, _kSecDigestSHA2, _kSecDigestTypeAttribute,
_kSecEKUClientAuth, _kSecEKUCodesigning, _kSecEKUEmailProtection,
_kSecEKUOCSPSigning, _kSecEKUServerAuth, _kSecEKUTimeStamping,
_kSecEncodeLineLengthAttribute, _kSecEncodeTypeAttribute,
_kSecEncryptKey, _kSecEncryptionMode, _kSecEntitlementPrivateOctagonEscrow,
_kSecEntitlementPrivateOctagonSecureElement, _kSecEntitlementPrivateOctagonWalrus,
_kSecExperimentDefaultsDomain, _kSecExperimentTLSProbe, _kSecFrameworkBundleID,
_kSecGuestAttributeArchitecture, _kSecGuestAttributeAudit,
_kSecGuestAttributeCanonical, _kSecGuestAttributeDynamicCode,
_kSecGuestAttributeDynamicCodeInfoPlist, _kSecGuestAttributeHash,
_kSecGuestAttributeMachPort, _kSecGuestAttributePid, _kSecGuestAttributeSubarchitecture,
_kSecIVKey, _kSecImportExportAccess, _kSecImportExportKeychain,
_kSecImportExportPassphrase, _kSecImportItemCertChain, _kSecImportItemIdentity,
_kSecImportItemKeyID, _kSecImportItemLabel, _kSecImportItemTrust,
_kSecInputIsAttributeName, _kSecInputIsDigest, _kSecInputIsPlainText,
_kSecInputIsRaw, _kSecKeyAlgorithmECDHKeyExchangeCofactor,
_kSecKeyAlgorithmECDHKeyExchangeCofactorX963SHA1, _kSecKeyAlgorithmECDHKeyExchangeCofactorX963SHA224,
_kSecKeyAlgorithmECDHKeyExchangeCofactorX963SHA256, _kSecKeyAlgorithmECDHKeyExchangeCofactorX963SHA384,
_kSecKeyAlgorithmECDHKeyExchangeCofactorX963SHA512, _kSecKeyAlgorithmECDHKeyExchangeStandard,
_kSecKeyAlgorithmECDHKeyExchangeStandardX963SHA1, _kSecKeyAlgorithmECDHKeyExchangeStandardX963SHA224,
_kSecKeyAlgorithmECDHKeyExchangeStandardX963SHA256, _kSecKeyAlgorithmECDHKeyExchangeStandardX963SHA384,
_kSecKeyAlgorithmECDHKeyExchangeStandardX963SHA512, _kSecKeyAlgorithmECDSASignatureDigestX962,
_kSecKeyAlgorithmECDSASignatureDigestX962SHA1, _kSecKeyAlgorithmECDSASignatureDigestX962SHA224,
_kSecKeyAlgorithmECDSASignatureDigestX962SHA256, _kSecKeyAlgorithmECDSASignatureDigestX962SHA384,
_kSecKeyAlgorithmECDSASignatureDigestX962SHA512, _kSecKeyAlgorithmECDSASignatureMessageX962SHA1,
_kSecKeyAlgorithmECDSASignatureMessageX962SHA224, _kSecKeyAlgorithmECDSASignatureMessageX962SHA256,
_kSecKeyAlgorithmECDSASignatureMessageX962SHA384, _kSecKeyAlgorithmECDSASignatureMessageX962SHA512,
_kSecKeyAlgorithmECDSASignatureRFC4754, _kSecKeyAlgorithmECIESEncryptionAKSSmartCard,
_kSecKeyAlgorithmECIESEncryptionCofactorVariableIVX963SHA224AESGCM,
_kSecKeyAlgorithmECIESEncryptionCofactorVariableIVX963SHA256AESGCM,
_kSecKeyAlgorithmECIESEncryptionCofactorVariableIVX963SHA384AESGCM,
_kSecKeyAlgorithmECIESEncryptionCofactorVariableIVX963SHA512AESGCM,
_kSecKeyAlgorithmECIESEncryptionCofactorX963SHA1AESGCM, _kSecKeyAlgorithmECIESEncryptionCofactorX963SHA224AESGCM,
_kSecKeyAlgorithmECIESEncryptionCofactorX963SHA256AESGCM,
_kSecKeyAlgorithmECIESEncryptionCofactorX963SHA384AESGCM,
_kSecKeyAlgorithmECIESEncryptionCofactorX963SHA512AESGCM,
_kSecKeyAlgorithmECIESEncryptionStandardVariableIVX963SHA224AESGCM,
_kSecKeyAlgorithmECIESEncryptionStandardVariableIVX963SHA256AESGCM,
_kSecKeyAlgorithmECIESEncryptionStandardVariableIVX963SHA384AESGCM,
_kSecKeyAlgorithmECIESEncryptionStandardVariableIVX963SHA512AESGCM,
_kSecKeyAlgorithmECIESEncryptionStandardX963SHA1AESGCM, _kSecKeyAlgorithmECIESEncryptionStandardX963SHA224AESGCM,
_kSecKeyAlgorithmECIESEncryptionStandardX963SHA256AESGCM,
_kSecKeyAlgorithmECIESEncryptionStandardX963SHA384AESGCM,
_kSecKeyAlgorithmECIESEncryptionStandardX963SHA512AESGCM,
_kSecKeyAlgorithmRSAEncryptionOAEPSHA1, _kSecKeyAlgorithmRSAEncryptionOAEPSHA1AESGCM,
_kSecKeyAlgorithmRSAEncryptionOAEPSHA224, _kSecKeyAlgorithmRSAEncryptionOAEPSHA224AESGCM,
_kSecKeyAlgorithmRSAEncryptionOAEPSHA256, _kSecKeyAlgorithmRSAEncryptionOAEPSHA256AESGCM,
_kSecKeyAlgorithmRSAEncryptionOAEPSHA384, _kSecKeyAlgorithmRSAEncryptionOAEPSHA384AESGCM,
_kSecKeyAlgorithmRSAEncryptionOAEPSHA512, _kSecKeyAlgorithmRSAEncryptionOAEPSHA512AESGCM,
_kSecKeyAlgorithmRSAEncryptionPKCS1, _kSecKeyAlgorithmRSAEncryptionRaw,
_kSecKeyAlgorithmRSAEncryptionRawCCUnit, _kSecKeyAlgorithmRSASignatureDigestPKCS1v15MD5,
_kSecKeyAlgorithmRSASignatureDigestPKCS1v15Raw, _kSecKeyAlgorithmRSASignatureDigestPKCS1v15SHA1,
_kSecKeyAlgorithmRSASignatureDigestPKCS1v15SHA224, _kSecKeyAlgorithmRSASignatureDigestPKCS1v15SHA256,
_kSecKeyAlgorithmRSASignatureDigestPKCS1v15SHA384, _kSecKeyAlgorithmRSASignatureDigestPKCS1v15SHA512,
_kSecKeyAlgorithmRSASignatureDigestPSSSHA1, _kSecKeyAlgorithmRSASignatureDigestPSSSHA224,
_kSecKeyAlgorithmRSASignatureDigestPSSSHA256, _kSecKeyAlgorithmRSASignatureDigestPSSSHA384,
_kSecKeyAlgorithmRSASignatureDigestPSSSHA512, _kSecKeyAlgorithmRSASignatureMessagePKCS1v15MD5,
_kSecKeyAlgorithmRSASignatureMessagePKCS1v15SHA1, _kSecKeyAlgorithmRSASignatureMessagePKCS1v15SHA224,
_kSecKeyAlgorithmRSASignatureMessagePKCS1v15SHA256, _kSecKeyAlgorithmRSASignatureMessagePKCS1v15SHA384,
_kSecKeyAlgorithmRSASignatureMessagePKCS1v15SHA512, _kSecKeyAlgorithmRSASignatureMessagePSSSHA1,
_kSecKeyAlgorithmRSASignatureMessagePSSSHA224, _kSecKeyAlgorithmRSASignatureMessagePSSSHA256,
_kSecKeyAlgorithmRSASignatureMessagePSSSHA384, _kSecKeyAlgorithmRSASignatureMessagePSSSHA512,
_kSecKeyAlgorithmRSASignatureRaw, _kSecKeyAlgorithmRSASignatureRawCCUnit,
_kSecKeyApplePayEnabled, _kSecKeyAttributeName, _kSecKeyEncryptionParameterRecryptCertificate,
_kSecKeyEncryptionParameterRecryptParameters, _kSecKeyEncryptionParameterSymmetricAAD,
_kSecKeyEncryptionParameterSymmetricKeySizeInBits, _kSecKeyKeyExchangeParameterRequestedSize,
_kSecKeyKeyExchangeParameterSharedInfo, _kSecKeyParameterSETokenAttestationNonce,
_kSecLineLength64, _kSecLineLength76, _kSecMatchCaseInsensitive,
_kSecMatchDiacriticInsensitive, _kSecMatchEmailAddressIfPresent,
_kSecMatchIssuers, _kSecMatchItemList, _kSecMatchLimit, _kSecMatchLimitAll,
_kSecMatchLimitOne, _kSecMatchPolicy, _kSecMatchSearchList,
_kSecMatchSubjectContains, _kSecMatchSubjectEndsWith, _kSecMatchSubjectStartsWith,
_kSecMatchSubjectWholeString, _kSecMatchTrustedOnly, _kSecMatchValidOnDate,
_kSecMatchWidthInsensitive, _kSecModeCBCKey, _kSecModeCFBKey,
_kSecModeECBKey, _kSecModeNoneKey, _kSecModeOFBKey, _kSecNetworkExtensionAccessGroupSuffix,
_kSecNullTransformName, _kSecOAEPEncodingParametersAttributeName,
_kSecOAEPMGF1DigestAlgorithmAttributeName, _kSecOAEPMessageLengthAttributeName,
_kSecOIDADC_CERT_POLICY, _kSecOIDAPPLE_CERT_POLICY, _kSecOIDAPPLE_EKU_CODE_SIGNING,
_kSecOIDAPPLE_EKU_CODE_SIGNING_DEV, _kSecOIDAPPLE_EKU_ICHAT_ENCRYPTION,
_kSecOIDAPPLE_EKU_ICHAT_SIGNING, _kSecOIDAPPLE_EKU_RESOURCE_SIGNING,
_kSecOIDAPPLE_EKU_SYSTEM_IDENTITY, _kSecOIDAPPLE_EXTENSION,
_kSecOIDAPPLE_EXTENSION_AAI_INTERMEDIATE, _kSecOIDAPPLE_EXTENSION_ADC_APPLE_SIGNING,
_kSecOIDAPPLE_EXTENSION_ADC_DEV_SIGNING, _kSecOIDAPPLE_EXTENSION_APPLEID_INTERMEDIATE,
_kSecOIDAPPLE_EXTENSION_APPLE_SIGNING, _kSecOIDAPPLE_EXTENSION_CODE_SIGNING,
_kSecOIDAPPLE_EXTENSION_INTERMEDIATE_MARKER, _kSecOIDAPPLE_EXTENSION_ITMS_INTERMEDIATE,
_kSecOIDAPPLE_EXTENSION_WWDR_INTERMEDIATE, _kSecOIDAuthorityInfoAccess,
_kSecOIDAuthorityKeyIdentifier, _kSecOIDBasicConstraints,
_kSecOIDBiometricInfo, _kSecOIDCSSMKeyStruct, _kSecOIDCertIssuer,
_kSecOIDCertificatePolicies, _kSecOIDClientAuth, _kSecOIDCollectiveStateProvinceName,
_kSecOIDCollectiveStreetAddress, _kSecOIDCommonName, _kSecOIDCountryName,
_kSecOIDCrlDistributionPoints, _kSecOIDCrlNumber, _kSecOIDCrlReason,
_kSecOIDDOTMAC_CERT_EMAIL_ENCRYPT, _kSecOIDDOTMAC_CERT_EMAIL_SIGN,
_kSecOIDDOTMAC_CERT_EXTENSION, _kSecOIDDOTMAC_CERT_IDENTITY,
_kSecOIDDOTMAC_CERT_POLICY, _kSecOIDDeltaCrlIndicator, _kSecOIDDescription,
_kSecOIDEKU_IPSec, _kSecOIDEmailAddress, _kSecOIDEmailProtection,
_kSecOIDExtendedKeyUsage, _kSecOIDExtendedKeyUsageAny, _kSecOIDExtendedUseCodeSigning,
_kSecOIDGivenName, _kSecOIDHoldInstructionCode, _kSecOIDInvalidityDate,
_kSecOIDIssuerAltName, _kSecOIDIssuingDistributionPoint, _kSecOIDIssuingDistributionPoints,
_kSecOIDKERBv5_PKINIT_KP_CLIENT_AUTH, _kSecOIDKERBv5_PKINIT_KP_KDC,
_kSecOIDKeyUsage, _kSecOIDLocalityName, _kSecOIDMS_NTPrincipalName,
_kSecOIDMicrosoftSGC, _kSecOIDNameConstraints, _kSecOIDNetscapeCertSequence,
_kSecOIDNetscapeCertType, _kSecOIDNetscapeSGC, _kSecOIDOCSPSigning,
_kSecOIDOrganizationName, _kSecOIDOrganizationalUnitName,
_kSecOIDPolicyConstraints, _kSecOIDPolicyMappings, _kSecOIDPrivateKeyUsagePeriod,
_kSecOIDQC_Statements, _kSecOIDSRVName, _kSecOIDSerialNumber,
_kSecOIDServerAuth, _kSecOIDStateProvinceName, _kSecOIDStreetAddress,
_kSecOIDSubjectAltName, _kSecOIDSubjectDirectoryAttributes,
_kSecOIDSubjectEmailAddress, _kSecOIDSubjectInfoAccess, _kSecOIDSubjectKeyIdentifier,
_kSecOIDSubjectPicture, _kSecOIDSubjectSignatureBitmap, _kSecOIDSurname,
_kSecOIDTimeStamping, _kSecOIDTitle, _kSecOIDUseExemptions,
_kSecOIDX509V1CertificateIssuerUniqueId, _kSecOIDX509V1CertificateSubjectUniqueId,
_kSecOIDX509V1IssuerName, _kSecOIDX509V1IssuerNameCStruct,
_kSecOIDX509V1IssuerNameLDAP, _kSecOIDX509V1IssuerNameStd,
_kSecOIDX509V1SerialNumber, _kSecOIDX509V1Signature, _kSecOIDX509V1SignatureAlgorithm,
_kSecOIDX509V1SignatureAlgorithmParameters, _kSecOIDX509V1SignatureAlgorithmTBS,
_kSecOIDX509V1SignatureCStruct, _kSecOIDX509V1SignatureStruct,
_kSecOIDX509V1SubjectName, _kSecOIDX509V1SubjectNameCStruct,
_kSecOIDX509V1SubjectNameLDAP, _kSecOIDX509V1SubjectNameStd,
_kSecOIDX509V1SubjectPublicKey, _kSecOIDX509V1SubjectPublicKeyAlgorithm,
_kSecOIDX509V1SubjectPublicKeyAlgorithmParameters, _kSecOIDX509V1SubjectPublicKeyCStruct,
_kSecOIDX509V1ValidityNotAfter, _kSecOIDX509V1ValidityNotBefore,
_kSecOIDX509V1Version, _kSecOIDX509V3Certificate, _kSecOIDX509V3CertificateCStruct,
_kSecOIDX509V3CertificateExtensionCStruct, _kSecOIDX509V3CertificateExtensionCritical,
_kSecOIDX509V3CertificateExtensionId, _kSecOIDX509V3CertificateExtensionStruct,
_kSecOIDX509V3CertificateExtensionType, _kSecOIDX509V3CertificateExtensionValue,
_kSecOIDX509V3CertificateExtensionsCStruct, _kSecOIDX509V3CertificateExtensionsStruct,
_kSecOIDX509V3CertificateNumberOfExtensions, _kSecOIDX509V3SignedCertificate,
_kSecOIDX509V3SignedCertificateCStruct, _kSecOidCommonName,
_kSecOidCountryName, _kSecOidLocalityName, _kSecOidOrganization,
_kSecOidOrganizationalUnit, _kSecOidStateProvinceName, _kSecPaddingKey,
_kSecPaddingNoneKey, _kSecPaddingOAEPKey, _kSecPaddingPKCS1Key,
_kSecPaddingPKCS5Key, _kSecPaddingPKCS7Key, _kSecPasswordAllowedCharactersKey,
_kSecPasswordCantEndWithChars, _kSecPasswordCantStartWithChars,
_kSecPasswordCharacterCount, _kSecPasswordCharacters, _kSecPasswordContainsAtLeastNSpecificCharacters,
_kSecPasswordContainsNoMoreThanNConsecutiveIdenticalCharacters,
_kSecPasswordContainsNoMoreThanNSpecificCharacters, _kSecPasswordDefaultForType,
_kSecPasswordDisallowedCharacters, _kSecPasswordGroupSize,
_kSecPasswordMaxLengthKey, _kSecPasswordMinLengthKey, _kSecPasswordNumberOfGroups,
_kSecPasswordRequiredCharactersKey, _kSecPasswordSeparator,
_kSecPolicyAppleAST2DiagnosticsServerAuth, _kSecPolicyAppleATVVPNProfileSigning,
_kSecPolicyAppleAccessoryUpdateSigning, _kSecPolicyAppleAggregateMetricEncryption,
_kSecPolicyAppleAggregateMetricTransparency, _kSecPolicyAppleAlisha,
_kSecPolicyAppleAnchorIncludeTestRoots, _kSecPolicyAppleAppTransportSecurity,
_kSecPolicyAppleAssetReceipt, _kSecPolicyAppleBasicAttestationSystem,
_kSecPolicyAppleBasicAttestationUser, _kSecPolicyAppleCHIPUpdateSigning,
_kSecPolicyAppleCodeSigning, _kSecPolicyAppleComponentCertificate,
_kSecPolicyAppleDemoDigitalCatalog, _kSecPolicyAppleDeveloperIDInstaller,
_kSecPolicyAppleDeveloperIDPlusTicket, _kSecPolicyAppleEAP,
_kSecPolicyAppleEscrowProxyCompatibilityServerAuth, _kSecPolicyAppleEscrowProxyServerAuth,
_kSecPolicyAppleEscrowService, _kSecPolicyAppleEscrowServiceIdKeySigning,
_kSecPolicyAppleExternalDeveloper, _kSecPolicyAppleFMiPServerAuth,
_kSecPolicyAppleFactoryDeviceCertificate, _kSecPolicyAppleGSService,
_kSecPolicyAppleGenericApplePinned, _kSecPolicyAppleGenericAppleSSLPinned,
_kSecPolicyAppleHomeKitServerAuth, _kSecPolicyAppleIDAuthority,
_kSecPolicyAppleIDSService, _kSecPolicyAppleIDSServiceContext,
_kSecPolicyAppleIDValidation, _kSecPolicyAppleIDValidationRecordSigning,
_kSecPolicyAppleIPsec, _kSecPolicyAppleKeyTransparency, _kSecPolicyAppleLegacyPushService,
_kSecPolicyAppleLegacySSL, _kSecPolicyAppleLockdownPairing,
_kSecPolicyAppleMDLTerminalAuth, _kSecPolicyAppleMMCSCompatibilityServerAuth,
_kSecPolicyAppleMMCService, _kSecPolicyAppleMacAppStoreInstaller,
_kSecPolicyAppleMacDistributionInstaller, _kSecPolicyAppleMacOSProfileApplicationSigning,
_kSecPolicyAppleMeasuredBootPolicySigning, _kSecPolicyAppleMobileAsset,
_kSecPolicyAppleMobileAssetDevelopment, _kSecPolicyAppleMobileSoftwareUpdate,
_kSecPolicyAppleMobileStore, _kSecPolicyAppleOCSPSigner, _kSecPolicyAppleOSXProvisioningProfileSigning,
_kSecPolicyAppleOTATasking, _kSecPolicyApplePCSEscrowService,
_kSecPolicyApplePCSEscrowServiceIdKeySigning, _kSecPolicyApplePKINITClient,
_kSecPolicyApplePKINITServer, _kSecPolicyApplePPQService,
_kSecPolicyApplePPQSigning, _kSecPolicyApplePackageSigning,
_kSecPolicyApplePassbookSigning, _kSecPolicyApplePayIssuerEncryption,
_kSecPolicyApplePayModelSigning, _kSecPolicyApplePayQRCodeEncryption,
_kSecPolicyApplePayQRCodeSigning, _kSecPolicyAppleProfileSigner,
_kSecPolicyApplePushService, _kSecPolicyAppleQAProfileSigner,
_kSecPolicyAppleRevocation, _kSecPolicyAppleSMIME, _kSecPolicyAppleSMPEncryption,
_kSecPolicyAppleSSL, _kSecPolicyAppleSWUpdateSigning, _kSecPolicyAppleSecureIOStaticAsset,
_kSecPolicyAppleServerAuthentication, _kSecPolicyAppleSoftwareSigning,
_kSecPolicyAppleTVOSApplicationSigning, _kSecPolicyAppleTestMobileStore,
_kSecPolicyAppleTestPPQSigning, _kSecPolicyAppleTestSMPEncryption,
_kSecPolicyAppleTimeStamping, _kSecPolicyAppleURLBag, _kSecPolicyAppleUniqueDeviceIdentifierCertificate,
_kSecPolicyAppleWarsaw, _kSecPolicyAppleX509Basic, _kSecPolicyAppleiAP,
_kSecPolicyAppleiAPSWAuth, _kSecPolicyAppleiCloudSetupCompatibilityServerAuth,
_kSecPolicyAppleiCloudSetupServerAuth, _kSecPolicyAppleiPhoneActivation,
_kSecPolicyAppleiPhoneApplicationSigning, _kSecPolicyAppleiPhoneDeviceCertificate,
_kSecPolicyAppleiPhoneProfileApplicationSigning, _kSecPolicyAppleiPhoneProvisioningProfileSigning,
_kSecPolicyAppleiPhoneVPNApplicationSigning, _kSecPolicyAppleiTunesStoreURLBag,
_kSecPolicyCheckAnchorApple, _kSecPolicyCheckAnchorSHA256,
_kSecPolicyCheckAnchorTrusted, _kSecPolicyCheckBasicCertificateProcessing,
_kSecPolicyCheckBasicConstraints, _kSecPolicyCheckBasicConstraintsCA,
_kSecPolicyCheckBasicConstraintsPathLen, _kSecPolicyCheckBlackListedKey,
_kSecPolicyCheckBlackListedLeaf, _kSecPolicyCheckCAspkiSHA256,
_kSecPolicyCheckCTRequired, _kSecPolicyCheckCertificatePolicy,
_kSecPolicyCheckChainLength, _kSecPolicyCheckCriticalExtensions,
_kSecPolicyCheckDuplicateExtension, _kSecPolicyCheckEAPTrustedServerNames,
_kSecPolicyCheckEmail, _kSecPolicyCheckExtendedKeyUsage, _kSecPolicyCheckExtendedValidation,
_kSecPolicyCheckGrayListedKey, _kSecPolicyCheckGrayListedLeaf,
_kSecPolicyCheckIdLinkage, _kSecPolicyCheckIntermediateCountry,
_kSecPolicyCheckIntermediateEKU, _kSecPolicyCheckIntermediateMarkerOid,
_kSecPolicyCheckIntermediateMarkerOidWithoutValueCheck, _kSecPolicyCheckIntermediateOrganization,
_kSecPolicyCheckIntermediateSPKISHA256, _kSecPolicyCheckIssuerCommonName,
_kSecPolicyCheckIssuerNameConstraints, _kSecPolicyCheckIssuerPolicyConstraints,
_kSecPolicyCheckKeySize, _kSecPolicyCheckKeyUsage, _kSecPolicyCheckLeafMarkerOid,
_kSecPolicyCheckLeafMarkerOidWithoutValueCheck, _kSecPolicyCheckLeafMarkersProdAndQA,
_kSecPolicyCheckLeafSPKISHA256, _kSecPolicyCheckMissingIntermediate,
_kSecPolicyCheckNameConstraints, _kSecPolicyCheckNoNetworkAccess,
_kSecPolicyCheckNonEmptySubject, _kSecPolicyCheckNonTlsCTRequired,
_kSecPolicyCheckNotCA, _kSecPolicyCheckNotValidBefore, _kSecPolicyCheckPinningRequired,
_kSecPolicyCheckPolicyConstraints, _kSecPolicyCheckRevocation,
_kSecPolicyCheckRevocationAny, _kSecPolicyCheckRevocationCRL,
_kSecPolicyCheckRevocationIfTrusted, _kSecPolicyCheckRevocationOCSP,
_kSecPolicyCheckRevocationOnline, _kSecPolicyCheckRevocationResponseRequired,
_kSecPolicyCheckSSLHostname, _kSecPolicyCheckServerAuthEKU,
_kSecPolicyCheckSignatureHashAlgorithms, _kSecPolicyCheckSubjectCommonName,
_kSecPolicyCheckSubjectCommonNamePrefix, _kSecPolicyCheckSubjectCommonNameTEST,
_kSecPolicyCheckSubjectOrganization, _kSecPolicyCheckSubjectOrganizationalUnit,
_kSecPolicyCheckSystemTrustedCTRequired, _kSecPolicyCheckSystemTrustedWeakHash,
_kSecPolicyCheckSystemTrustedWeakKey, _kSecPolicyCheckTemporalValidity,
_kSecPolicyCheckUnparseableExtension, _kSecPolicyCheckUsageConstraints,
_kSecPolicyCheckValidRoot, _kSecPolicyCheckValidityPeriodMaximums,
_kSecPolicyCheckWeakKeySize, _kSecPolicyCheckWeakSignature,
_kSecPolicyClient, _kSecPolicyContext, _kSecPolicyIntermediateMarkerOid,
_kSecPolicyLeafMarkerOid, _kSecPolicyLeafMarkerProd, _kSecPolicyLeafMarkerQA,
_kSecPolicyMacAppStoreReceipt, _kSecPolicyName, _kSecPolicyNameAppleAIDCService,
_kSecPolicyNameAppleAMPService, _kSecPolicyNameAppleAST2Service,
_kSecPolicyNameAppleEscrowProxyService, _kSecPolicyNameAppleFMiPService,
_kSecPolicyNameAppleGSService, _kSecPolicyNameAppleHealthProviderService,
_kSecPolicyNameAppleHomeAppClipUploadService, _kSecPolicyNameAppleHomeKitService,
_kSecPolicyNameAppleIDSService, _kSecPolicyNameAppleMMCSService,
_kSecPolicyNameAppleMapsService, _kSecPolicyNameApplePPQService,
_kSecPolicyNameAppleParsecService, _kSecPolicyNameApplePotluckService,
_kSecPolicyNameApplePushCertPortal, _kSecPolicyNameApplePushService,
_kSecPolicyNameAppleSiriService, _kSecPolicyNameAppleUpdatesService,
_kSecPolicyNameAppleiCloudSetupService, _kSecPolicyNameCodeSigning,
_kSecPolicyNameEAPClient, _kSecPolicyNameEAPServer, _kSecPolicyNameIPSecClient,
_kSecPolicyNameIPSecServer, _kSecPolicyNameOCSPSigner, _kSecPolicyNameSMIME,
_kSecPolicyNameSSLClient, _kSecPolicyNameSSLServer, _kSecPolicyNameTimeStamping,
_kSecPolicyNameX509Basic, _kSecPolicyOid, _kSecPolicyPolicyName,
_kSecPolicyRevocationFlags, _kSecPolicyRootDigest, _kSecPolicyTeamIdentifier,
_kSecPrivateKeyAttrs, _kSecPropertyKeyLabel, _kSecPropertyKeyLocalizedLabel,
_kSecPropertyKeyType, _kSecPropertyKeyValue, _kSecPropertyTypeArray,
_kSecPropertyTypeData, _kSecPropertyTypeDate, _kSecPropertyTypeError,
_kSecPropertyTypeNumber, _kSecPropertyTypeSection, _kSecPropertyTypeString,
_kSecPropertyTypeSuccess, _kSecPropertyTypeTitle, _kSecPropertyTypeURL,
_kSecPropertyTypeWarning, _kSecPublicKeyAttrs, _kSecRVIterations,
_kSecRVMasterID, _kSecRVProtocol, _kSecRVSalt, _kSecRVVerifier,
_kSecRandomDefault, _kSecRecIV, _kSecRecLocale, _kSecRecQuestions,
_kSecRecVersionNumber, _kSecRecWrappedPassword, _kSecRequirementKeyChecksumAlgorithm,
_kSecRequirementKeyEntitlements, _kSecRequirementKeyIdentifier,
_kSecRequirementKeyInfoPlist, _kSecRequirementKeyPackageChecksum,
_kSecRequirementKeySecureTimestamp, _kSecRequirementKeyTeamIdentifier,
_kSecReturnAttributes, _kSecReturnData, _kSecReturnPersistentRef,
_kSecReturnRef, _kSecSharedPassword, _kSecSignatureAttributeName,
_kSecSignatureDigestAlgorithmUnknown, _kSecSubjectAltName,
_kSecSubjectAltNameDNSName, _kSecSubjectAltNameEmailAddress,
_kSecSubjectAltNameNTPrincipalName, _kSecSubjectAltNameURI,
_kSecTransformAbortAttributeName, _kSecTransformAbortOriginatorKey,
_kSecTransformActionAttributeNotification, _kSecTransformActionAttributeValidation,
_kSecTransformActionCanExecute, _kSecTransformActionExternalizeExtraData,
_kSecTransformActionFinalize, _kSecTransformActionInternalizeExtraData,
_kSecTransformActionProcessData, _kSecTransformActionStartingExecution,
_kSecTransformDebugAttributeName, _kSecTransformErrorDomain,
_kSecTransformInputAttributeName, _kSecTransformOutputAttributeName,
_kSecTransformPreviousErrorKey, _kSecTransformTransformName,
_kSecTrustCertificateTransparency, _kSecTrustCertificateTransparencyWhiteList,
_kSecTrustEvaluationDate, _kSecTrustExtendedValidation, _kSecTrustInfoCertificateTransparencyKey,
_kSecTrustInfoCompanyNameKey, _kSecTrustInfoExtendedValidationKey,
_kSecTrustInfoResultNotAfter, _kSecTrustInfoResultNotBefore,
_kSecTrustInfoRevocationKey, _kSecTrustInfoRevocationValidUntilKey,
_kSecTrustOrganizationName, _kSecTrustResultDetails, _kSecTrustResultValue,
_kSecTrustRevocationChecked, _kSecTrustRevocationReason, _kSecTrustRevocationValidUntilDate,
_kSecTrustStoreHashAlgorithmKey, _kSecTrustStoreSPKIHashKey,
_kSecUseAuthenticationContext, _kSecUseAuthenticationUI, _kSecUseAuthenticationUIAllow,
_kSecUseAuthenticationUIFail, _kSecUseAuthenticationUISkip,
_kSecUseCallerName, _kSecUseCertificatesWithMatchIssuers,
_kSecUseCredentialReference, _kSecUseDataProtectionKeychain,
_kSecUseItemList, _kSecUseKeychain, _kSecUseNoAuthenticationUI,
_kSecUseOperationPrompt, _kSecUseSyncBubbleKeychain, _kSecUseSystemKeychain,
_kSecUseTokenRawItems, _kSecUseTombstones, _kSecValueData,
_kSecValuePersistentRef, _kSecValueRef, _kSecZLibEncoding,
_kTSAContextKeyNoCerts, _kTSAContextKeyURL, _oidAdCAIssuer,
_oidAdOCSP, _oidAnsip384r1, _oidAnsip521r1, _oidAnyExtendedKeyUsage,
_oidAnyPolicy, _oidAuthorityInfoAccess, _oidAuthorityKeyIdentifier,
_oidBasicConstraints, _oidCertificatePolicies, _oidCommonName,
_oidCountryName, _oidCrlDistributionPoints, _oidDescription,
_oidEcPrime192v1, _oidEcPrime256v1, _oidEcPubKey, _oidEmailAddress,
_oidEntrustVersInfo, _oidExtendedKeyUsage, _oidExtendedKeyUsageClientAuth,
_oidExtendedKeyUsageCodeSigning, _oidExtendedKeyUsageEmailProtection,
_oidExtendedKeyUsageIPSec, _oidExtendedKeyUsageMicrosoftSGC,
_oidExtendedKeyUsageNetscapeSGC, _oidExtendedKeyUsageOCSPSigning,
_oidExtendedKeyUsageServerAuth, _oidExtendedKeyUsageTimeStamping,
_oidFee, _oidFriendlyName, _oidGoogleEmbeddedSignedCertificateTimestamp,
_oidGoogleOCSPSignedCertificateTimestamp, _oidInhibitAnyPolicy,
_oidIssuerAltName, _oidKeyUsage, _oidLocalKeyId, _oidLocalityName,
_oidMSNTPrincipalName, _oidMd2, _oidMd2Rsa, _oidMd4, _oidMd4Rsa,
_oidMd5, _oidMd5Fee, _oidMd5Rsa, _oidNameConstraints, _oidNetscapeCertType,
_oidOrganizationName, _oidOrganizationalUnitName, _oidPolicyConstraints,
_oidPolicyMappings, _oidPrivateKeyUsagePeriod, _oidQtCps,
_oidQtUNotice, _oidRsa, _oidSha1, _oidSha1Dsa, _oidSha1DsaCommonOIW,
_oidSha1DsaOIW, _oidSha1Ecdsa, _oidSha1Fee, _oidSha1Rsa, _oidSha1RsaOIW,
_oidSha224, _oidSha224Ecdsa, _oidSha224Rsa, _oidSha256, _oidSha256Ecdsa,
_oidSha256Rsa, _oidSha384, _oidSha384Ecdsa, _oidSha384Rsa,
_oidSha512, _oidSha512Ecdsa, _oidSha512Rsa, _oidStateOrProvinceName,
_oidSubjectAltName, _oidSubjectInfoAccess, _oidSubjectKeyIdentifier,
_parseNSPinnedDomains, _sBackupKeyKey, _sCKKSForAll, _sCirclePrefix,
_sDebugInfoPrefix, _sDeviceID, _sEscrowRecord, _sGestaltKey,
_sMachineIDKey, _sPreferIDS, _sPreferIDSACKModel, _sPreferIDSFragmentation,
_sRetirementPrefix, _sRingPrefix, _sRingState, _sSecDERErrorDomain,
_sSecXPCErrorDomain, _sSerialNumberKey, _sTransportType, _sV2DictionaryKey,
_sVersionKey, _sViewsKey, _secLogDisable, _secLogEnable, _secLogEnabled,
_secLogObjForCFScope, _secLogObjForScope, _sec_array_append,
_sec_array_apply, _sec_array_create, _sec_array_get_count,
_sec_certificate_copy_ref, _sec_certificate_create, _sec_experiment_copy_configuration,
_sec_experiment_create, _sec_experiment_run, _sec_experiment_run_async,
_sec_experiment_run_async_with_sampling_disabled, _sec_experiment_run_with_sampling_disabled,
_sec_experiment_set_sampling_disabled, _sec_identity_access_certificates,
_sec_identity_copy_certificates_ref, _sec_identity_copy_private_key_decrypt_block,
_sec_identity_copy_private_key_queue, _sec_identity_copy_private_key_sign_block,
_sec_identity_copy_ref, _sec_identity_create, _sec_identity_create_with_certificates,
_sec_identity_create_with_certificates_and_external_private_key,
_sec_identity_has_certificates, _sec_protocol_configuration_builder_create,
_sec_protocol_configuration_copy_singleton, _sec_protocol_configuration_copy_transformed_options,
_sec_protocol_configuration_copy_transformed_options_for_host,
_sec_protocol_configuration_create_with_builder, _sec_protocol_configuration_set_ats_overrides,
_sec_protocol_configuration_tls_required, _sec_protocol_configuration_tls_required_for_address,
_sec_protocol_configuration_tls_required_for_host, _sec_protocol_helper_ciphersuite_group_contains_ciphersuite,
_sec_protocol_helper_ciphersuite_group_to_ciphersuite_list,
_sec_protocol_helper_ciphersuite_maximum_TLS_version, _sec_protocol_helper_ciphersuite_minimum_TLS_version,
_sec_protocol_helper_get_ciphersuite_name, _sec_protocol_metadata_access_distinguished_names,
_sec_protocol_metadata_access_handle, _sec_protocol_metadata_access_ocsp_response,
_sec_protocol_metadata_access_peer_certificate_chain, _sec_protocol_metadata_access_pre_shared_keys,
_sec_protocol_metadata_access_sent_certificates, _sec_protocol_metadata_access_supported_signature_algorithms,
_sec_protocol_metadata_challenge_parameters_are_equal, _sec_protocol_metadata_copy_connection_id,
_sec_protocol_metadata_copy_peer_public_key, _sec_protocol_metadata_copy_quic_transport_parameters,
_sec_protocol_metadata_copy_sec_identity, _sec_protocol_metadata_copy_sec_trust,
_sec_protocol_metadata_copy_serialized_session, _sec_protocol_metadata_create_secret,
_sec_protocol_metadata_create_secret_with_context, _sec_protocol_metadata_get_connection_strength,
_sec_protocol_metadata_get_early_data_accepted, _sec_protocol_metadata_get_experiment_identifier,
_sec_protocol_metadata_get_handshake_async_call_count, _sec_protocol_metadata_get_handshake_byte_count,
_sec_protocol_metadata_get_handshake_read_stall_count, _sec_protocol_metadata_get_handshake_received_byte_count,
_sec_protocol_metadata_get_handshake_rtt, _sec_protocol_metadata_get_handshake_sent_byte_count,
_sec_protocol_metadata_get_handshake_time_ms, _sec_protocol_metadata_get_handshake_write_stall_count,
_sec_protocol_metadata_get_negotiated_ciphersuite, _sec_protocol_metadata_get_negotiated_protocol,
_sec_protocol_metadata_get_negotiated_protocol_version, _sec_protocol_metadata_get_negotiated_tls_ciphersuite,
_sec_protocol_metadata_get_negotiated_tls_protocol_version,
_sec_protocol_metadata_get_server_name, _sec_protocol_metadata_get_session_renewed,
_sec_protocol_metadata_get_session_resumed, _sec_protocol_metadata_get_ticket_offered,
_sec_protocol_metadata_get_ticket_received, _sec_protocol_metadata_get_tls_certificate_compression_algorithm,
_sec_protocol_metadata_get_tls_certificate_compression_used,
_sec_protocol_metadata_get_tls_false_start_used, _sec_protocol_metadata_get_tls_negotiated_group,
_sec_protocol_metadata_peers_are_equal, _sec_protocol_metadata_serialize_with_options,
_sec_protocol_options_access_handle, _sec_protocol_options_add_pre_shared_key,
_sec_protocol_options_add_server_raw_public_key_certificate,
_sec_protocol_options_add_tls_application_protocol, _sec_protocol_options_add_tls_ciphersuite,
_sec_protocol_options_add_tls_ciphersuite_group, _sec_protocol_options_add_tls_key_exchange_group,
_sec_protocol_options_add_tls_key_exchange_group_set, _sec_protocol_options_add_transport_specific_application_protocol,
_sec_protocol_options_append_tls_ciphersuite, _sec_protocol_options_append_tls_ciphersuite_group,
_sec_protocol_options_append_tls_key_exchange_group, _sec_protocol_options_append_tls_key_exchange_group_set,
_sec_protocol_options_apply_config, _sec_protocol_options_are_equal,
_sec_protocol_options_clear_tls_application_protocols, _sec_protocol_options_contents_are_equal,
_sec_protocol_options_contents_compare, _sec_protocol_options_copy_transport_specific_application_protocol,
_sec_protocol_options_create_config, _sec_protocol_options_get_default_max_dtls_protocol_version,
_sec_protocol_options_get_default_max_tls_protocol_version,
_sec_protocol_options_get_default_min_dtls_protocol_version,
_sec_protocol_options_get_default_min_tls_protocol_version,
_sec_protocol_options_get_enable_encrypted_client_hello, _sec_protocol_options_get_quic_use_legacy_codepoint,
_sec_protocol_options_matches_config, _sec_protocol_options_set_allow_unknown_alpn_protos,
_sec_protocol_options_set_challenge_block, _sec_protocol_options_set_client_raw_public_key_certificates,
_sec_protocol_options_set_connection_id, _sec_protocol_options_set_eddsa_enabled,
_sec_protocol_options_set_enable_encrypted_client_hello, _sec_protocol_options_set_enforce_ev,
_sec_protocol_options_set_experiment_identifier, _sec_protocol_options_set_key_update_block,
_sec_protocol_options_set_local_certificates, _sec_protocol_options_set_local_identity,
_sec_protocol_options_set_max_tls_protocol_version, _sec_protocol_options_set_min_tls_protocol_version,
_sec_protocol_options_set_output_handler_access_block, _sec_protocol_options_set_peer_authentication_optional,
_sec_protocol_options_set_peer_authentication_required, _sec_protocol_options_set_pre_shared_key_selection_block,
_sec_protocol_options_set_private_key_blocks, _sec_protocol_options_set_quic_transport_parameters,
_sec_protocol_options_set_quic_use_legacy_codepoint, _sec_protocol_options_set_server_raw_public_key_certificates,
_sec_protocol_options_set_session_state, _sec_protocol_options_set_session_update_block,
_sec_protocol_options_set_tls_block_length_padding, _sec_protocol_options_set_tls_certificate_compression_enabled,
_sec_protocol_options_set_tls_delegated_credentials_enabled,
_sec_protocol_options_set_tls_diffie_hellman_parameters, _sec_protocol_options_set_tls_early_data_enabled,
_sec_protocol_options_set_tls_encryption_level_update_block,
_sec_protocol_options_set_tls_encryption_secret_update_block,
_sec_protocol_options_set_tls_false_start_enabled, _sec_protocol_options_set_tls_grease_enabled,
_sec_protocol_options_set_tls_is_fallback_attempt, _sec_protocol_options_set_tls_max_version,
_sec_protocol_options_set_tls_min_version, _sec_protocol_options_set_tls_ocsp_enabled,
_sec_protocol_options_set_tls_pre_shared_key_identity_hint,
_sec_protocol_options_set_tls_renegotiation_enabled, _sec_protocol_options_set_tls_resumption_enabled,
_sec_protocol_options_set_tls_sct_enabled, _sec_protocol_options_set_tls_server_name,
_sec_protocol_options_set_tls_sni_disabled, _sec_protocol_options_set_tls_ticket_request_count,
_sec_protocol_options_set_tls_tickets_enabled, _sec_protocol_options_set_verify_block,
_sec_protocol_options_tls_handshake_message_callback, _sec_release,
_sec_retain, _sec_trust_copy_ref, _sec_trust_create, _securityd_create_message,
_securityd_message_no_error, _securityd_message_with_reply_sync,
_securityd_send_async_and_do, _securityd_send_sync_and_do ]
objc-classes: [ CKKSControl, CKKSExternalKey, CKKSExternalTLKShare, LocalKeychainAnalytics,
OTBottleIDs, OTClique, OTConfigurationContext, OTControl,
OTJoiningConfiguration, OTOperationConfiguration, SFAnalytics,
SFAnalyticsActivityTracker, SFAnalyticsMultiSampler, SFAnalyticsSQLiteStore,
SFAnalyticsSampler, SFSQLite, SOSAnalytics, SOSCachedNotification,
SecCoreAnalytics, SecEscrowRequest, SecKeyProxy, SecXPCHelper,
SecuritydXPCClient ]
- targets: [ arm64e-macos, x86_64-macos, arm64-macos ]
symbols: [ _CMSDecoderSetSearchKeychain, _CMSEncode, _CMSEncoderSetEncapsulatedContentType,
_ConvertArrayToKeyUsage, _GKBIS_DS_Store_Present, _GKBIS_Dot_underbar_Present,
_GKBIS_Num_dirs, _GKBIS_Num_files, _GKBIS_Num_localizations,
_GKBIS_Num_symlinks, _PORT_FreeArena, _PORT_NewArena, _SSLCopyCertificateAuthorities,
_SSLCopyPeerCertificates, _SSLCopyTrustedLeafCertificates,
_SSLCopyTrustedRoots, _SSLDisposeContext, _SSLGetAllowsAnyRoot,
_SSLGetAllowsExpiredCerts, _SSLGetAllowsExpiredRoots, _SSLGetDiffieHellmanParams,
_SSLGetEnableCertVerify, _SSLGetPeerCertificates, _SSLGetProtocolVersion,
_SSLGetProtocolVersionEnabled, _SSLGetRsaBlinding, _SSLNewContext,
_SSLNewDatagramContext, _SSLSetAllowsAnyRoot, _SSLSetAllowsExpiredCerts,
_SSLSetAllowsExpiredRoots, _SSLSetCertificateAuthorities,
_SSLSetDiffieHellmanParams, _SSLSetEnableCertVerify, _SSLSetProtocolVersion,
_SSLSetProtocolVersionEnabled, _SSLSetRsaBlinding, _SSLSetTrustedLeafCertificates,
_SSLSetTrustedRoots, _SecACLCopyContents, _SecACLCopySimpleContents,
_SecACLCreateFromSimpleContents, _SecACLCreateWithSimpleContents,
_SecACLGetTypeID, _SecACLRemove, _SecACLSetContents, _SecACLSetSimpleContents,
_SecArenaPoolCreate, _SecArenaPoolFree, _SecCertificateAddToKeychain,
_SecCertificateCopyFieldValues, _SecCertificateCopyFirstFieldValue,
_SecCertificateCopyLongDescription, _SecCertificateCopyNormalizedIssuerContent,
_SecCertificateCopyNormalizedSubjectContent, _SecCertificateCopyPreference,
_SecCertificateCopyPreferred, _SecCertificateCopyPublicKeySHA1DigestFromCertificateData,
_SecCertificateCopyShortDescription, _SecCertificateCopySubjectComponent,
_SecCertificateCopyValues, _SecCertificateCreateFromData,
_SecCertificateCreateFromItemImplInstance, _SecCertificateCreateItemImplInstance,
_SecCertificateFindByEmail, _SecCertificateFindByIssuerAndSN,
_SecCertificateFindBySubjectKeyID, _SecCertificateGetAlgorithmID,
_SecCertificateGetCLHandle, _SecCertificateGetCLHandle_legacy,
_SecCertificateGetCommonName, _SecCertificateGetData, _SecCertificateGetEmailAddress,
_SecCertificateGetIssuer, _SecCertificateGetSubject, _SecCertificateGetType,
_SecCertificateInferLabel, _SecCertificateIsItemImplInstance,
_SecCertificateIsValidX, _SecCertificateReleaseFieldValues,
_SecCertificateReleaseFirstFieldValue, _SecCertificateSetPreference,
_SecCertificateSetPreferred, _SecCmsDigestContextFinishMultiple,
_SecCmsEnvelopedDataAddRecipient, _SecCmsMessageContainsTSTInfo,
_SecCmsMessageGetArena, _SecCmsMessageSetTSACallback, _SecCmsRecipientInfoDestroy,
_SecCmsSignedDataAddSignerInfo, _SecCmsSignedDataSetDigests,
_SecCmsSignerInfoAddTimeStamp, _SecCmsSignerInfoDestroy, _SecCmsSignerInfoGetEncDigest,
_SecCmsSignerInfoGetTimestampCertList, _SecCmsSignerInfoGetTimestampSigningCert,
_SecCmsSignerInfoGetTimestampTime, _SecCmsSignerInfoGetTimestampTimeWithPolicy,
_SecCmsSignerInfoVerifyUnAuthAttrs, _SecCmsSignerInfoVerifyUnAuthAttrsWithPolicy,
_SecCodeCopyGuestWithAttributes, _SecCodeCreateWithAuditToken,
_SecCodeCreateWithPID, _SecCodeCreateWithXPCMessage, _SecDigestGetData,
_SecIdentityCopyApplicationPreferenceItemURLs, _SecIdentityCopyPreference,
_SecIdentityCopyPreferred, _SecIdentityCopySystemIdentity,
_SecIdentityCreateWithCertificate, _SecIdentityDeleteApplicationPreferenceItems,
_SecIdentitySetPreference, _SecIdentitySetPreferred, _SecIdentitySetSystemIdentity,
_SecInferLabelFromX509Name, _SecIsAppleTrustAnchor, _SecIsAppleTrustAnchorData,
_SecItemAdd_ios, _SecItemCopyMatching_ios, _SecItemCopyParentCertificates_osx,
_SecItemCopyStoredCertificate, _SecItemCreateFromAttributeDictionary_osx,
_SecItemDelete_ios, _SecItemExport, _SecItemImport, _SecItemParentCachePurge,
_SecItemUpdate_ios, _SecKeyCreateFromData, _SecKeyCreatePair,
_SecKeyCreateRandomKey_ios, _SecKeyCreateWithCSSMKey, _SecKeyDeriveFromPassword,
_SecKeyGenerate, _SecKeyGeneratePairAsync, _SecKeyGeneratePair_ios,
_SecKeyGenerateSymmetric, _SecKeyGetCSPHandle, _SecKeyGetCSSMKey,
_SecKeyGetCredentials, _SecKeyGetStrengthInBits, _SecKeyImportPair,
_SecKeyRawSign_macOS, _SecKeyRawVerifyOSX, _SecKeyRawVerify_macOS,
_SecKeyUnwrapSymmetric, _SecKeyWrapSymmetric, _SecKeychainItemExport,
_SecKeychainItemImport, _SecKeychainSearchCreateForCertificateByEmail,
_SecKeychainSearchCreateForCertificateByIssuerAndSN, _SecKeychainSearchCreateForCertificateByIssuerAndSN_CF,
_SecKeychainSearchCreateForCertificateBySubjectKeyID, _SecPKCS12Import_ios,
_SecPolicyCopy, _SecPolicyCreate, _SecPolicyCreateAppleTimeStampingAndRevocationPolicies,
_SecPolicyCreateItemImplInstance, _SecPolicyCreateWithOID,
_SecPolicyGetOID, _SecPolicyGetStringForOID, _SecPolicyGetTPHandle,
_SecPolicyGetValue, _SecPolicySetProperties, _SecPolicySetValue,
_SecTaskValidateForRequirement, _SecTrustCopyAnchorCertificates,
_SecTrustCopyExtendedResult, _SecTrustCopyPublicKey_ios, _SecTrustGetCSSMAnchorCertificates,
_SecTrustGetCssmResult, _SecTrustGetCssmResultCode, _SecTrustGetResult,
_SecTrustGetTPHandle, _SecTrustGetUserTrust, _SecTrustSetKeychains,
_SecTrustSetOptions, _SecTrustSetParameters, _SecTrustSetUserTrust,
_SecTrustSetUserTrustLegacy, _SecTrustSettingsCertHashStrFromCert,
_SecTrustSettingsCertHashStrFromData, _SecTrustSettingsCopyCertificates,
_SecTrustSettingsCopyCertificatesForUserAdminDomains, _SecTrustSettingsCopyModificationDate,
_SecTrustSettingsCopyQualifiedCerts, _SecTrustSettingsCopyTrustSettings,
_SecTrustSettingsCopyTrustSettings_Cached, _SecTrustSettingsCopyUnrestrictedRoots,
_SecTrustSettingsCreateExternalRepresentation, _SecTrustSettingsEvaluateCert,
_SecTrustSettingsImportExternalRepresentation, _SecTrustSettingsPurgeCache,
_SecTrustSettingsPurgeUserAdminCertsCache, _SecTrustSettingsRemoveTrustSettings,
_SecTrustSettingsSetTrustSettings, _SecTrustSettingsSetTrustSettingsExternal,
_SecTrustSettingsSetTrustedCertificateForSSLHost, _SecTrustSettingsUserAdminDomainsContain,
_SecTrustSettingsXPCRead, _SecTrustSettingsXPCWrite, _SecurityVersionNumber,
_SecurityVersionString, __SecItemGetPersistentReference, _cssmAlgToOid,
_cssmErrorString, _cssmOidToAlg, _cssmPerror, _gGuidAppleCSP,
_gGuidAppleCSPDL, _gGuidAppleDotMacDL, _gGuidAppleDotMacTP,
_gGuidAppleFileDL, _gGuidAppleLDAPDL, _gGuidAppleSdCSPDL,
_gGuidAppleX509CL, _gGuidAppleX509TP, _gGuidCssm, _kSecIdentityDomainDefault,
_kSecIdentityDomainKerberosKDC, _kSecPolicyAppleiChat, _kSecPolicyKU_CRLSign,
_kSecPolicyKU_DataEncipherment, _kSecPolicyKU_DecipherOnly,
_kSecPolicyKU_DigitalSignature, _kSecPolicyKU_EncipherOnly,
_kSecPolicyKU_KeyAgreement, _kSecPolicyKU_KeyCertSign, _kSecPolicyKU_KeyEncipherment,
_kSecPolicyKU_NonRepudiation, _secdebug_internal, _secdebugfunc_internal ]
- targets: [ arm64e-macos, arm64-macos ]
symbols: [ '_SecCertificateCopyPublicKey$LEGACYMAC', '_SecCertificateCopySerialNumber$LEGACYMAC' ]
...
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Security.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Security.framework/Headers/SecAsn1Templates.h | /*
* Copyright (c) 2003-2006,2008,2010-2012 Apple Inc. All Rights Reserved.
*
* @APPLE_LICENSE_HEADER_START@
*
* This file contains Original Code and/or Modifications of Original Code
* as defined in and that are subject to the Apple Public Source License
* Version 2.0 (the 'License'). You may not use this file except in
* compliance with the License. Please obtain a copy of the License at
* http://www.opensource.apple.com/apsl/ and read it before using this
* file.
*
* The Original Code and all software distributed under the License are
* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
* Please see the License for the specific language governing rights and
* limitations under the License.
*
* @APPLE_LICENSE_HEADER_END@
*
* SecAsn1Templates.h - Common ASN1 primitive templates for use with SecAsn1Coder.
*/
#ifndef _SEC_ASN1_TEMPLATES_H_
#define _SEC_ASN1_TEMPLATES_H_
#include <Security/SecAsn1Types.h>
#ifdef __cplusplus
extern "C" {
#endif
CF_ASSUME_NONNULL_BEGIN
/************************************************************************/
/*
* Generic Templates
* One for each of the simple types, plus a special one for ANY, plus:
* - a pointer to each one of those
* - a set of each one of those
* - a sequence of each one of those
*/
extern const SecAsn1Template kSecAsn1AnyTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1BitStringTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1BMPStringTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1BooleanTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1EnumeratedTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1GeneralizedTimeTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1IA5StringTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1IntegerTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1UnsignedIntegerTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1NullTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1ObjectIDTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1OctetStringTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1PrintableStringTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1T61StringTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1UniversalStringTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1UTCTimeTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1UTF8StringTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1VisibleStringTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1TeletexStringTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1PointerToAnyTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1PointerToBitStringTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1PointerToBMPStringTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1PointerToBooleanTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1PointerToEnumeratedTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1PointerToGeneralizedTimeTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1PointerToIA5StringTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1PointerToIntegerTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1PointerToNullTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1PointerToObjectIDTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1PointerToOctetStringTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1PointerToPrintableStringTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1PointerToT61StringTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1PointerToUniversalStringTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1PointerToUTCTimeTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1PointerToUTF8StringTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1PointerToVisibleStringTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1PointerToTeletexStringTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1SequenceOfAnyTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1SequenceOfBitStringTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1SequenceOfBMPStringTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1SequenceOfBooleanTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1SequenceOfEnumeratedTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1SequenceOfGeneralizedTimeTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1SequenceOfIA5StringTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1SequenceOfIntegerTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1SequenceOfNullTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1SequenceOfObjectIDTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1SequenceOfOctetStringTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1SequenceOfPrintableStringTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1SequenceOfT61StringTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1SequenceOfUniversalStringTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1SequenceOfUTCTimeTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1SequenceOfUTF8StringTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1SequenceOfVisibleStringTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1SequenceOfTeletexStringTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1SetOfAnyTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1SetOfBitStringTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1SetOfBMPStringTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1SetOfBooleanTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1SetOfEnumeratedTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1SetOfGeneralizedTimeTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1SetOfIA5StringTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1SetOfIntegerTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1SetOfNullTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1SetOfObjectIDTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1SetOfOctetStringTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1SetOfPrintableStringTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1SetOfT61StringTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1SetOfUniversalStringTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1SetOfUTCTimeTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1SetOfUTF8StringTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1SetOfVisibleStringTemplate[] SEC_ASN1_API_DEPRECATED;
extern const SecAsn1Template kSecAsn1SetOfTeletexStringTemplate[] SEC_ASN1_API_DEPRECATED;
/*
* Template for skipping a subitem; only used when decoding.
*/
extern const SecAsn1Template kSecAsn1SkipTemplate[] SEC_ASN1_API_DEPRECATED;
CF_ASSUME_NONNULL_END
#ifdef __cplusplus
}
#endif
#endif /* _SEC_ASN1_TEMPLATES_H_ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Security.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Security.framework/Headers/SecCertificate.h | /*
* Copyright (c) 2002-2020 Apple Inc. All Rights Reserved.
*
* @APPLE_LICENSE_HEADER_START@
*
* This file contains Original Code and/or Modifications of Original Code
* as defined in and that are subject to the Apple Public Source License
* Version 2.0 (the 'License'). You may not use this file except in
* compliance with the License. Please obtain a copy of the License at
* http://www.opensource.apple.com/apsl/ and read it before using this
* file.
*
* The Original Code and all software distributed under the License are
* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
* Please see the License for the specific language governing rights and
* limitations under the License.
*
* @APPLE_LICENSE_HEADER_END@
*/
/*!
@header SecCertificate
The functions provided in SecCertificate.h implement and manage a
particular type of keychain item that represents a X.509 public key
certificate. You can store a certificate in a keychain, but a
certificate can also be a transient object.
You can use a certificate as a keychain item in most functions.
*/
#ifndef _SECURITY_SECCERTIFICATE_H_
#define _SECURITY_SECCERTIFICATE_H_
#include <CoreFoundation/CFBase.h>
#include <CoreFoundation/CFArray.h>
#include <CoreFoundation/CFData.h>
#include <CoreFoundation/CFDate.h>
#include <CoreFoundation/CFError.h>
#include <Availability.h>
#include <AvailabilityMacros.h>
#include <Security/SecBase.h>
#if SEC_OS_OSX
#define _SECURITY_VERSION_GREATER_THAN_57610_
#include <Security/cssmtype.h>
#include <Security/x509defs.h>
#endif // SEC_OS_OSX
__BEGIN_DECLS
CF_ASSUME_NONNULL_BEGIN
CF_IMPLICIT_BRIDGING_ENABLED
/*!
@function SecCertificateGetTypeID
@abstract Returns the type identifier of SecCertificate instances.
@result The CFTypeID of SecCertificate instances.
*/
CFTypeID SecCertificateGetTypeID(void)
__OSX_AVAILABLE_STARTING(__MAC_10_3, __IPHONE_2_0);
/*!
@function SecCertificateCreateWithData
@abstract Create a certificate given it's DER representation as a CFData.
@param allocator CFAllocator to allocate the certificate with.
@param data DER encoded X.509 certificate.
@result Return NULL if the passed-in data is not a valid DER-encoded
X.509 certificate, return a SecCertificateRef otherwise.
*/
__nullable
SecCertificateRef SecCertificateCreateWithData(CFAllocatorRef __nullable allocator, CFDataRef data)
__OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_2_0);
/*!
@function SecCertificateCopyData
@abstract Return the DER representation of an X.509 certificate.
@param certificate SecCertificate object created with
SecCertificateCreateWithData().
@result DER encoded X.509 certificate.
*/
CFDataRef SecCertificateCopyData(SecCertificateRef certificate)
__OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_2_0);
/*!
@function SecCertificateCopySubjectSummary
@abstract Return a simple string which hopefully represents a human
understandable summary.
@param certificate A reference to the certificate from which to derive
the subject summary string.
@discussion All the data in this string comes from the certificate itself
and thus it's in whatever language the certificate itself is in.
@result A CFStringRef which the caller should CFRelease() once it's no
longer needed.
*/
__nullable
CFStringRef SecCertificateCopySubjectSummary(SecCertificateRef certificate)
__OSX_AVAILABLE_STARTING(__MAC_10_6, __IPHONE_2_0);
/*!
@function SecCertificateCopyCommonName
@abstract Retrieves the common name of the subject of a given certificate.
@param certificate A reference to the certificate from which to retrieve the common name.
@param commonName On return, a reference to the common name. Your code must release this reference by calling the CFRelease function.
@result A result code. See "Security Error Codes" (SecBase.h).
@discussion All the data in this string comes from the certificate itself, and thus it's in whatever language the certificate itself is in.
Note that the certificate's common name field may not be present, or may be inadequate to describe the certificate; for display purposes,
you should consider using SecCertificateCopySubjectSummary instead of this function.
*/
OSStatus SecCertificateCopyCommonName(SecCertificateRef certificate, CFStringRef * __nonnull CF_RETURNS_RETAINED commonName)
__OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_10_3);
/*!
@function SecCertificateCopyEmailAddresses
@abstract Returns an array of zero or more email addresses for the subject of a given certificate.
@param certificate A reference to the certificate from which to retrieve the email addresses.
@param emailAddresses On return, an array of zero or more CFStringRef elements corresponding to each email address found.
Your code must release this array reference by calling the CFRelease function.
@result A result code. See "Security Error Codes" (SecBase.h).
*/
OSStatus SecCertificateCopyEmailAddresses(SecCertificateRef certificate, CFArrayRef * __nonnull CF_RETURNS_RETAINED emailAddresses)
__OSX_AVAILABLE_STARTING(__MAC_10_5, __IPHONE_10_3);
/*!
@function SecCertificateCopyNormalizedIssuerSequence
@abstract Return the certificate's normalized issuer
@param certificate The certificate from which to get values
@discussion The issuer is a sequence in the format used by SecItemCopyMatching. The content returned is a DER-encoded X.509 distinguished name. For a display version of the issuer, call SecCertificateCopyValues. The caller must CFRelease the value returned.
*/
__nullable
CFDataRef SecCertificateCopyNormalizedIssuerSequence(SecCertificateRef certificate)
__OSX_AVAILABLE_STARTING(__MAC_10_12_4, __IPHONE_10_3);
/*!
@function SecCertificateCopyNormalizedSubjectSequence
@abstract Return the certificate's normalized subject
@param certificate The certificate from which to get values
@discussion The subject is a sequence in the format used by SecItemCopyMatching. The content returned is a DER-encoded X.509 distinguished name. For a display version of the subject, call SecCertificateCopyValues. The caller must CFRelease the value returned.
*/
__nullable
CFDataRef SecCertificateCopyNormalizedSubjectSequence(SecCertificateRef certificate)
__OSX_AVAILABLE_STARTING(__MAC_10_12_4, __IPHONE_10_3);
/*!
@function SecCertificateCopyKey
@abstract Retrieves the public key for a given certificate.
@param certificate A reference to the certificate from which to retrieve the public key.
@result A reference to the public key for the specified certificate. Your code must release this reference by calling the CFRelease function. If the public key has an encoding issue or uses an unsupported algorithm, the returned reference will be null.
@discussion RSA and ECDSA public keys are supported. All other public key algorithms are unsupported.
*/
__nullable CF_RETURNS_RETAINED
SecKeyRef SecCertificateCopyKey(SecCertificateRef certificate)
API_AVAILABLE(macos(10.14), ios(12.0), watchos(5.0), tvos(12.0));
#if TARGET_OS_OSX && TARGET_CPU_ARM64
#define SEC_SUFFIX_LEGACYMAC(symbol) __asm("_" __STRING(symbol) "$LEGACYMAC")
#else
#define SEC_SUFFIX_LEGACYMAC(symbol) /**/
#endif
#if TARGET_OS_IPHONE
/*!
@function SecCertificateCopyPublicKey
@abstract Retrieves the public key for a given certificate.
@param certificate A reference to the certificate from which to retrieve the public key.
@result A reference to the public key for the specified certificate. Your code must release this reference by calling the CFRelease function.
@discussion NOTE: Deprecated in iOS 12.0; use SecCertificateCopyKey instead for cross-platform availability.
*/
__nullable
SecKeyRef SecCertificateCopyPublicKey(SecCertificateRef certificate)
API_DEPRECATED_WITH_REPLACEMENT("SecCertificateCopyKey", ios(10.3, 12.0)) API_UNAVAILABLE(macos, macCatalyst);
#endif
#if TARGET_OS_OSX
/*!
@function SecCertificateCopyPublicKey
@abstract Retrieves the public key for a given certificate.
@param certificate A reference to the certificate from which to retrieve the public key.
@param key On return, a reference to the public key for the specified certificate. Your code must release this reference by calling the CFRelease function.
@result A result code. See "Security Error Codes" (SecBase.h).
@discussion NOTE: Deprecated in macOS 10.14; use SecCertificateCopyKey instead for cross-platform availability.
*/
OSStatus SecCertificateCopyPublicKey(SecCertificateRef certificate, SecKeyRef * __nonnull CF_RETURNS_RETAINED key)
SEC_SUFFIX_LEGACYMAC(SecCertificateCopyPublicKey)
API_DEPRECATED_WITH_REPLACEMENT("SecCertificateCopyKey", macos(10.3, 10.14)) API_UNAVAILABLE(ios, tvos, watchos, macCatalyst);
#endif
/*!
@function SecCertificateCopySerialNumberData
@abstract Return the certificate's serial number.
@param certificate The certificate from which to get values.
@param error An optional pointer to a CFErrorRef which will be set on return from the function if an error occurred. If not NULL, the caller is responsible for releasing the CFErrorRef.
@discussion Return the content of a DER-encoded integer (without the tag and length fields) for this certificate's serial number. The caller must CFRelease the value returned.
*/
__nullable
CFDataRef SecCertificateCopySerialNumberData(SecCertificateRef certificate, CFErrorRef *error)
API_AVAILABLE(macos(10.13), ios(11.0), watchos(4.0), tvos(11.0));
#if TARGET_OS_IPHONE
/*!
@function SecCertificateCopySerialNumber
@abstract Return the certificate's serial number.
@param certificate The certificate from which to get values.
@discussion Return the content of a DER-encoded integer (without the tag and length fields) for this certificate's serial number. The caller must CFRelease the value returned. NOTE: Deprecated in iOS 11.0; use SecCertificateCopySerialNumberData instead for cross-platform availability.
*/
__nullable
CFDataRef SecCertificateCopySerialNumber(SecCertificateRef certificate)
API_DEPRECATED_WITH_REPLACEMENT("SecCertificateCopySerialNumberData", ios(10.3, 11.0)) API_UNAVAILABLE(macos, macCatalyst);
#endif
#if TARGET_OS_OSX
/*!
@function SecCertificateCopySerialNumber
@abstract Return the certificate's serial number.
@param certificate The certificate from which to get values.
@param error An optional pointer to a CFErrorRef which will be set on return from the function if an error occurred. If not NULL, the caller is responsible for releasing the CFErrorRef.
@discussion Return the content of a DER-encoded integer (without the tag and length fields) for this certificate's serial number. The caller must CFRelease the value returned. NOTE: Deprecated in macOS 10.13; use SecCertificateCopySerialNumberData instead for cross-platform availability.
*/
__nullable
CFDataRef SecCertificateCopySerialNumber(SecCertificateRef certificate, CFErrorRef *error)
SEC_SUFFIX_LEGACYMAC(SecCertificateCopySerialNumber)
API_DEPRECATED_WITH_REPLACEMENT("SecCertificateCopySerialNumberData", macos(10.7, 10.13)) API_UNAVAILABLE(ios, tvos, watchos, macCatalyst);
#endif
/*
* Legacy functions (OS X only)
*/
#if SEC_OS_OSX
/*!
@enum CertificateItemAttributes
@abstract Indicates the type of a certificate item attribute.
@constant kSecSubjectItemAttr Indicates a DER-encoded subject distinguished name.
@constant kSecIssuerItemAttr Indicates a DER-encoded issuer distinguished name.
@constant kSecSerialNumberItemAttr Indicates a DER-encoded certificate serial number (without the tag and length).
@constant kSecPublicKeyHashItemAttr Indicates a public key hash.
@constant kSecSubjectKeyIdentifierItemAttr Indicates a subject key identifier.
@constant kSecCertTypeItemAttr Indicates a certificate type.
@constant kSecCertEncodingItemAttr Indicates a certificate encoding.
*/
enum
{
kSecSubjectItemAttr = 'subj',
kSecIssuerItemAttr = 'issu',
kSecSerialNumberItemAttr = 'snbr',
kSecPublicKeyHashItemAttr = 'hpky',
kSecSubjectKeyIdentifierItemAttr = 'skid',
kSecCertTypeItemAttr = 'ctyp',
kSecCertEncodingItemAttr = 'cenc'
} /*DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER*/;
#pragma mark ---- Certificate Operations ----
/*!
@function SecCertificateCreateFromData
@abstract Creates a certificate based on the input data, type, and encoding.
@param data A pointer to the certificate data.
@param type The certificate type as defined in cssmtype.h.
@param encoding The certificate encoding as defined in cssmtype.h.
@param certificate On return, a reference to the newly created certificate.
@result A result code. See "Security Error Codes" (SecBase.h).
@discussion This API is deprecated in 10.7 Please use the SecCertificateCreateWithData API instead.
*/
OSStatus SecCertificateCreateFromData(const CSSM_DATA *data, CSSM_CERT_TYPE type, CSSM_CERT_ENCODING encoding, SecCertificateRef * __nonnull CF_RETURNS_RETAINED certificate)
DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER;
/*!
@function SecCertificateAddToKeychain
@abstract Adds a certificate to the specified keychain.
@param certificate A reference to a certificate.
@param keychain A reference to the keychain in which to add the certificate. Pass NULL to add the certificate to the default keychain.
@result A result code. See "Security Error Codes" (SecBase.h).
@discussion This function is successful only if the certificate was created using the SecCertificateCreateFromData or
SecCertificateCreateWithData functions, and the certificate has not yet been added to the specified keychain.
*/
OSStatus SecCertificateAddToKeychain(SecCertificateRef certificate, SecKeychainRef __nullable keychain)
__OSX_AVAILABLE_STARTING(__MAC_10_3, __IPHONE_NA);
/*!
@function SecCertificateGetData
@abstract Retrieves the data for a given certificate.
@param certificate A reference to the certificate from which to retrieve the data.
@param data On return, the CSSM_DATA structure pointed to by data is filled in. You must allocate the space for a CSSM_DATA structure before calling this function. This data pointer is only guaranteed to remain valid as long as the certificate remains unchanged and valid.
@result A result code. See "Security Error Codes" (SecBase.h).
@discussion This API is deprecated in 10.7. Please use the SecCertificateCopyData API instead.
*/
OSStatus SecCertificateGetData(SecCertificateRef certificate, CSSM_DATA_PTR data)
DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER;
/*!
@function SecCertificateGetType
@abstract Retrieves the type for a given certificate.
@param certificate A reference to the certificate from which to obtain the type.
@param certificateType On return, the certificate type of the certificate. Certificate types are defined in cssmtype.h.
@result A result code. See "Security Error Codes" (SecBase.h).
@discussion This API is deprecated in 10.7. Please use the SecCertificateCopyValues API instead.
*/
OSStatus SecCertificateGetType(SecCertificateRef certificate, CSSM_CERT_TYPE *certificateType)
DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER;
/*!
@function SecCertificateGetSubject
@abstract Retrieves the subject name for a given certificate.
@param certificate A reference to the certificate from which to obtain the subject name.
@param subject On return, a pointer to a CSSM_X509_NAME struct which contains the subject's X.509 name (x509defs.h). This pointer remains valid until the certificate reference is released. The caller should not attempt to free this pointer.
@result A result code. See "Security Error Codes" (SecBase.h).
@discussion Prior to Mac OS X 10.5, this function did not return any output in the subject parameter. Your code should check the returned pointer value (in addition to the function result) before attempting to use it.
For example:
const CSSM_X509_NAME *subject = NULL;
OSStatus status = SecCertificateGetSubject(certificate, &subject);
if ( (status == errSecSuccess) && (subject != NULL) ) {
// subject is valid
}
This API is deprecated in 10.7. Please use the SecCertificateCopyValues API instead.
*/
OSStatus SecCertificateGetSubject(SecCertificateRef certificate, const CSSM_X509_NAME * __nullable * __nonnull subject)
DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER;
/*!
@function SecCertificateGetIssuer
@abstract Retrieves the issuer name for a given certificate.
@param certificate A reference to the certificate from which to obtain the issuer name.
@param issuer On return, a pointer to a CSSM_X509_NAME struct which contains the issuer's X.509 name (x509defs.h). This pointer remains valid until the certificate reference is released. The caller should not attempt to free this pointer.
@result A result code. See "Security Error Codes" (SecBase.h).
@discussion Prior to Mac OS X 10.5, this function did not return any output in the issuer parameter. Your code should check the returned pointer value (in addition to the function result) before attempting to use it.
For example:
const CSSM_X509_NAME *issuer = NULL;
OSStatus status = SecCertificateGetIssuer(certificate, &issuer);
if ( (status == errSecSuccess) && (issuer != NULL) ) {
// issuer is valid
}
This API is deprecated in 10.7. Please use the SecCertificateCopyValues API instead.
*/
OSStatus SecCertificateGetIssuer(SecCertificateRef certificate, const CSSM_X509_NAME * __nullable * __nonnull issuer)
DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER;
/*!
@function SecCertificateGetCLHandle
@abstract Retrieves the certificate library handle for a given certificate.
@param certificate A reference to the certificate from which to obtain the certificate library handle.
@param clHandle On return, the certificate library handle of the given certificate. This handle remains valid at least as long as the certificate does.
@result A result code. See "Security Error Codes" (SecBase.h).
@discussion This API is deprecated in 10.7. Please use the SecCertificateCopyValues API instead.
*/
OSStatus SecCertificateGetCLHandle(SecCertificateRef certificate, CSSM_CL_HANDLE *clHandle)
DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER;
/*!
@function SecCertificateGetAlgorithmID
@abstract Retrieves the algorithm identifier for a given certificate.
@param certificate A reference to the certificate from which to retrieve the algorithm identifier.
@param algid On return, a pointer to a CSSM_X509_ALGORITHM_IDENTIFIER struct which identifies the algorithm for this certificate (x509defs.h). This pointer remains valid until the certificate reference is released. The caller should not attempt to free this pointer.
@result A result code. See "Security Error Codes" (SecBase.h).
discussion This API is deprecated in 10.7. Please use the SecCertificateCopyValues API instead.
*/
OSStatus SecCertificateGetAlgorithmID(SecCertificateRef certificate, const CSSM_X509_ALGORITHM_IDENTIFIER * __nullable * __nonnull algid)
DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER;
/*!
@function SecCertificateCopyPreference
@abstract Returns the preferred certificate for the specified name and key usage. If a preferred certificate does not exist for the specified name and key usage, NULL is returned.
@param name A string containing an email address (RFC822) or other name for which a preferred certificate is requested.
@param keyUsage A CSSM_KEYUSE key usage value, as defined in cssmtype.h. Pass 0 to ignore this parameter.
@param certificate On return, a reference to the preferred certificate, or NULL if none was found. You are responsible for releasing this reference by calling the CFRelease function.
@result A result code. See "Security Error Codes" (SecBase.h).
@discussion This function will typically be used to obtain the preferred encryption certificate for an email recipient.
This API is deprecated in 10.7. Please use the SecCertificateCopyPreferred API instead.
*/
OSStatus SecCertificateCopyPreference(CFStringRef name, uint32 keyUsage, SecCertificateRef * __nonnull CF_RETURNS_RETAINED certificate)
DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER;
/*!
@function SecCertificateCopyPreferred
@abstract Returns the preferred certificate for the specified name and key usage. If a preferred certificate does not exist for the specified name and key usage, NULL is returned.
@param name A string containing an email address (RFC822) or other name for which a preferred certificate is requested.
@param keyUsage A CFArrayRef value, containing items defined in SecItem.h Pass NULL to ignore this parameter. (kSecAttrCanEncrypt, kSecAttrCanDecrypt, kSecAttrCanDerive, kSecAttrCanSign, kSecAttrCanVerify, kSecAttrCanWrap, kSecAttrCanUnwrap)
@result On return, a reference to the preferred certificate, or NULL if none was found. You are responsible for releasing this reference by calling the CFRelease function.
@discussion This function will typically be used to obtain the preferred encryption certificate for an email recipient. If a preferred certificate has not been set
for the supplied name, the returned reference will be NULL. Your code should then perform a search for possible certificates, using the SecItemCopyMatching API.
*/
__nullable
SecCertificateRef SecCertificateCopyPreferred(CFStringRef name, CFArrayRef __nullable keyUsage)
__OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_NA);
/*!
@function SecCertificateSetPreference
@abstract Sets the preferred certificate for a specified name, key usage, and date.
@param certificate A reference to the certificate which will be preferred.
@param name A string containing an email address (RFC822) or other name for which a preferred certificate will be associated.
@param keyUsage A CSSM_KEYUSE key usage value, as defined in cssmtype.h. Pass 0 to avoid specifying a particular key usage.
@param date (optional) A date reference. If supplied, the preferred certificate will be changed only if this date is later than the currently saved setting. Pass NULL if this preference should not be restricted by date.
@result A result code. See "Security Error Codes" (SecBase.h).
@discussion This function will typically be used to set the preferred encryption certificate for an email recipient, either manually (when encrypting email to a recipient) or automatically upon receipt of encrypted email.
This API is deprecated in 10.7. Plese use the SecCertificateSetPreferred API instead.
*/
OSStatus SecCertificateSetPreference(SecCertificateRef certificate, CFStringRef name, uint32 keyUsage, CFDateRef __nullable date)
DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER;
/*!
@function SecCertificateSetPreferred
@abstract Sets the preferred certificate for a specified name and optional key usage.
@param certificate A reference to the preferred certificate. If NULL is passed, any existing preference for the specified name is cleared instead.
@param name A string containing an email address (RFC822) or other name for which a preferred certificate will be associated.
@param keyUsage A CFArrayRef value, containing items defined in SecItem.h Pass NULL to ignore this parameter. (kSecAttrCanEncrypt, kSecAttrCanDecrypt, kSecAttrCanDerive, kSecAttrCanSign, kSecAttrCanVerify, kSecAttrCanWrap, kSecAttrCanUnwrap)
@result A result code. See "Security Error Codes" (SecBase.h).
@discussion This function will typically be used to set the preferred encryption certificate for an email recipient, either manually (when encrypting email to a recipient)
or automatically upon receipt of encrypted email.
*/
OSStatus SecCertificateSetPreferred(SecCertificateRef __nullable certificate, CFStringRef name, CFArrayRef __nullable keyUsage)
__OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_NA);
/*!
@typedef SecKeyUsage
@abstract Flags to indicate key usages in the KeyUsage extension of a certificate
@constant kSecKeyUsageUnspecified No KeyUsage extension in certificate.
@constant kSecKeyUsageDigitalSignature DigitalSignature bit set in KeyUsage extension.
@constant kSecKeyUsageNonRepudiation NonRepudiation bit set in KeyUsage extension.
@constant kSecKeyUsageContentCommitment ContentCommitment bit set in KeyUsage extension.
@constant kSecKeyUsageKeyEncipherment KeyEncipherment bit set in KeyUsage extension.
@constant kSecKeyUsageDataEncipherment DataEncipherment bit set in KeyUsage extension.
@constant kSecKeyUsageKeyAgreement KeyAgreement bit set in KeyUsage extension.
@constant kSecKeyUsageKeyCertSign KeyCertSign bit set in KeyUsage extension.
@constant kSecKeyUsageCRLSign CRLSign bit set in KeyUsage extension.
@constant kSecKeyUsageEncipherOnly EncipherOnly bit set in KeyUsage extension.
@constant kSecKeyUsageDecipherOnly DecipherOnly bit set in KeyUsage extension.
@constant kSecKeyUsageCritical KeyUsage extension is marked critical.
@constant kSecKeyUsageAll For masking purposes, all SecKeyUsage values.
*/
typedef CF_OPTIONS(uint32_t, SecKeyUsage) {
kSecKeyUsageUnspecified = 0u,
kSecKeyUsageDigitalSignature = 1u << 0,
kSecKeyUsageNonRepudiation = 1u << 1,
kSecKeyUsageContentCommitment= 1u << 1,
kSecKeyUsageKeyEncipherment = 1u << 2,
kSecKeyUsageDataEncipherment = 1u << 3,
kSecKeyUsageKeyAgreement = 1u << 4,
kSecKeyUsageKeyCertSign = 1u << 5,
kSecKeyUsageCRLSign = 1u << 6,
kSecKeyUsageEncipherOnly = 1u << 7,
kSecKeyUsageDecipherOnly = 1u << 8,
kSecKeyUsageCritical = 1u << 31,
kSecKeyUsageAll = 0x7FFFFFFFu
};
/*!
@enum kSecPropertyKey
@abstract Constants used to access dictionary entries returned by SecCertificateCopyValues
@constant kSecPropertyKeyType The type of the entry
@constant kSecPropertyKeyLabel The label of the entry
@constant kSecPropertyKeyLocalizedLabel The localized label of the entry
@constant kSecPropertyKeyValue The value of the entry
*/
extern const CFStringRef kSecPropertyKeyType __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_NA);
extern const CFStringRef kSecPropertyKeyLabel __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_NA);
extern const CFStringRef kSecPropertyKeyLocalizedLabel __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_NA);
extern const CFStringRef kSecPropertyKeyValue __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_NA);
/*!
@enum kSecPropertyType
@abstract Public Constants for property list values returned by SecCertificateCopyValues
@discussion Note that kSecPropertyTypeTitle and kSecPropertyTypeError are defined in SecTrust.h
*/
extern const CFStringRef kSecPropertyTypeWarning __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_NA);
extern const CFStringRef kSecPropertyTypeSuccess __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_NA);
extern const CFStringRef kSecPropertyTypeSection __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_NA);
extern const CFStringRef kSecPropertyTypeData __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_NA);
extern const CFStringRef kSecPropertyTypeString __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_NA);
extern const CFStringRef kSecPropertyTypeURL __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_NA);
extern const CFStringRef kSecPropertyTypeDate __OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_NA);
extern const CFStringRef kSecPropertyTypeArray API_AVAILABLE(macos(10.15)) API_UNAVAILABLE(ios, watchos, tvos, macCatalyst);
extern const CFStringRef kSecPropertyTypeNumber API_AVAILABLE(macos(10.15)) API_UNAVAILABLE(ios, watchos, tvos, macCatalyst);
/*!
@function SecCertificateCopyValues
@abstract Creates a dictionary that represents a certificate's contents.
@param certificate The certificate from which to get values
@param keys An array of string OID values, or NULL. If present, this is
the subset of values from the certificate to return. If NULL,
all values will be returned. Only OIDs that are top level keys
in the returned dictionary can be specified. Unknown OIDs are
ignored.
@param error An optional pointer to a CFErrorRef. This value is
set if an error occurred. If not NULL the caller is
responsible for releasing the CFErrorRef.
@discussion The keys array will contain all of the keys used in the
returned dictionary. The top level keys in the returned
dictionary are OIDs, many of which are found in SecCertificateOIDs.h.
Each entry that is returned is itself a dictionary with four
entries, whose keys are kSecPropertyKeyType, kSecPropertyKeyLabel,
kSecPropertyKeyLocalizedLabel, kSecPropertyKeyValue. The label
entries may contain a descriptive (localized) string, or an
OID string. The kSecPropertyKeyType describes the type in the
value entry. The value entry may be any CFType, although it
is usually a CFStringRef, CFArrayRef or a CFDictionaryRef.
*/
__nullable
CFDictionaryRef SecCertificateCopyValues(SecCertificateRef certificate, CFArrayRef __nullable keys, CFErrorRef *error)
__OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_NA);
/*!
@function SecCertificateCopyLongDescription
@abstract Return the long description of a certificate
@param alloc The CFAllocator which should be used to allocate
memory for the dictionary and its storage for values. This
parameter may be NULL in which case the current default
CFAllocator is used. If this reference is not a valid
CFAllocator, the behavior is undefined.
@param certificate The certificate from which to retrieve the long description
@param error An optional pointer to a CFErrorRef. This value is
set if an error occurred. If not NULL the caller is
responsible for releasing the CFErrorRef.
@result A CFStringRef of the long description or NULL. If NULL and the error
parameter is supplied the error will be returned in the error parameter
@discussion Note that the format of this string may change in the future
*/
__nullable
CFStringRef SecCertificateCopyLongDescription(CFAllocatorRef __nullable alloc, SecCertificateRef certificate, CFErrorRef *error)
__OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_NA);
/*!
@function SecCertificateCopyShortDescription
@abstract Return the short description of a certificate
@param alloc The CFAllocator which should be used to allocate
memory for the dictionary and its storage for values. This
parameter may be NULL in which case the current default
CFAllocator is used. If this reference is not a valid
CFAllocator, the behavior is undefined.
@param certificate The certificate from which to retrieve the short description
@param error An optional pointer to a CFErrorRef. This value is
set if an error occurred. If not NULL the caller is
responsible for releasing the CFErrorRef.
@result A CFStringRef of the short description or NULL. If NULL and the error
parameter is supplied the error will be returned in the error parameter
@discussion Note that the format of this string may change in the future
*/
__nullable
CFStringRef SecCertificateCopyShortDescription(CFAllocatorRef __nullable alloc, SecCertificateRef certificate, CFErrorRef *error)
__OSX_AVAILABLE_STARTING(__MAC_10_7, __IPHONE_NA);
/*!
@function SecCertificateCopyNormalizedIssuerContent
@abstract Return the certificate's normalized issuer
@param certificate The certificate from which to get values
@param error An optional pointer to a CFErrorRef. This value is
set if an error occurred. If not NULL the caller is
responsible for releasing the CFErrorRef.
@discussion The issuer is a sequence in the format used by
SecItemCopyMatching. The content returned is a DER-encoded
X.509 distinguished name. For a display version of the issuer,
call SecCertificateCopyValues. The caller must CFRelease
the value returned.
*/
__nullable
CFDataRef SecCertificateCopyNormalizedIssuerContent(SecCertificateRef certificate, CFErrorRef *error)
__OSX_AVAILABLE_BUT_DEPRECATED_MSG(__MAC_10_7, __MAC_10_12_4, __IPHONE_NA, __IPHONE_NA, "SecCertificateCopyNormalizedIssuerContent is deprecated. Use SecCertificateCopyNormalizedIssuerSequence instead.");
/*!
@function SecCertificateCopyNormalizedSubjectContent
@abstract Return the certificate's normalized subject
@param certificate The certificate from which to get values
@param error An optional pointer to a CFErrorRef. This value is
set if an error occurred. If not NULL the caller is
responsible for releasing the CFErrorRef.
@discussion The subject is a sequence in the format used by
SecItemCopyMatching. The content returned is a DER-encoded
X.509 distinguished name. For a display version of the subject,
call SecCertificateCopyValues. The caller must CFRelease
the value returned.
*/
__nullable
CFDataRef SecCertificateCopyNormalizedSubjectContent(SecCertificateRef certificate, CFErrorRef *error)
__OSX_AVAILABLE_BUT_DEPRECATED_MSG(__MAC_10_7, __MAC_10_12_4, __IPHONE_NA, __IPHONE_NA, "SecCertificateCopyNormalizedSubjectContent is deprecated. Use SecCertificateCopyNormalizedSubjectSequence instead.");
#endif /* SEC_OS_OSX */
CF_IMPLICIT_BRIDGING_DISABLED
CF_ASSUME_NONNULL_END
__END_DECLS
#endif /* !_SECURITY_SECCERTIFICATE_H_ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Security.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Security.framework/Headers/SecProtocolOptions.h | /*
* Copyright (c) 2018 Apple Inc. All Rights Reserved.
*
* @APPLE_LICENSE_HEADER_START@
*
* This file contains Original Code and/or Modifications of Original Code
* as defined in and that are subject to the Apple Public Source License
* Version 2.0 (the 'License'). You may not use this file except in
* compliance with the License. Please obtain a copy of the License at
* http://www.opensource.apple.com/apsl/ and read it before using this
* file.
*
* The Original Code and all software distributed under the License are
* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
* Please see the License for the specific language governing rights and
* limitations under the License.
*
* @APPLE_LICENSE_HEADER_END@
*/
#ifndef SecProtocolOptions_h
#define SecProtocolOptions_h
#include <Security/SecProtocolObject.h>
#include <Security/SecProtocolTypes.h>
#include <Security/SecProtocolMetadata.h>
#include <Security/SecTrust.h>
#include <Security/SecCertificate.h>
#include <Security/SecIdentity.h>
#include <dispatch/dispatch.h>
#include <os/object.h>
#define SEC_PROTOCOL_CERT_COMPRESSION_DEFAULT 1
/*!
* The following diagram shows how clients interact with sec_protocol_options
* and sec_protocol_metadata when configuring and using network security protocols.
*
* +--------+
* | Client |
* +-+---/ \+
* | |
* +-------------+ +-------------+
* | (1) set (2) get |
* | options metadata |
* +-----\ /---------------+ +------------+----------+
* | sec_protocol_options | | sec_protocol_metadata |
* +-----------------------+ +-----------------------+
*
* Clients configure security protocols with `sec_protocol_options` instances.
* And they inspect protocol instances using `sec_protocol_metadata` instances.
*/
#ifndef SEC_OBJECT_IMPL
/*!
* A `sec_protocol_options` instance is a container of options for security protocol instances,
* such as TLS. Protocol options are used to configure security protocols in the network stack.
* For example, clients may set the maximum and minimum allowed TLS versions through protocol
* options.
*/
SEC_OBJECT_DECL(sec_protocol_options);
#endif // !SEC_OBJECT_IMPL
__BEGIN_DECLS
SEC_ASSUME_NONNULL_BEGIN
/*!
* @function sec_protocol_options_are_equal
*
* @abstract
* Compare two `sec_protocol_options_t` instances.
*
* @param optionsA
* A `sec_protocol_options_t` instance.
*
* @param optionsB
* A `sec_protocol_options_t` instance.
*
* @return True if equal, and false otherwise.
*/
API_AVAILABLE(macos(10.15), ios(13.0), watchos(6.0), tvos(13.0))
bool
sec_protocol_options_are_equal(sec_protocol_options_t optionsA, sec_protocol_options_t optionsB);
/*!
* @function sec_protocol_options_set_local_identity
*
* @abstract
* Set the local identity to be used for this protocol instance.
*
* @param options
* A `sec_protocol_options_t` instance.
*
* @param identity
* A `sec_identity_t` instance carrying the private key and certificate.
*/
API_AVAILABLE(macos(10.14), ios(12.0), watchos(5.0), tvos(12.0))
void
sec_protocol_options_set_local_identity(sec_protocol_options_t options, sec_identity_t identity);
/*!
* @function sec_protocol_options_append_tls_ciphersuite
*
* @abstract
* Append a TLS ciphersuite to the set of enabled ciphersuites.
*
* @param options
* A `sec_protocol_options_t` instance.
*
* @param ciphersuite
* A `tls_ciphersuite_t` value.
*/
API_AVAILABLE(macos(10.15), ios(13.0), watchos(6.0), tvos(13.0))
void
sec_protocol_options_append_tls_ciphersuite(sec_protocol_options_t options, tls_ciphersuite_t ciphersuite);
/*!
* @function sec_protocol_options_add_tls_ciphersuite
*
* @abstract
* Add a TLS ciphersuite to the set of enabled ciphersuites.
*
* @param options
* A `sec_protocol_options_t` instance.
*
* @param ciphersuite
* A SSLCipherSuite value.
*/
API_DEPRECATED("Use sec_protocol_options_append_tls_ciphersuite", macos(10.14, 10.15), ios(12.0, 13.0), watchos(5.0, 6.0), tvos(12.0, 13.0), macCatalyst(13.0, 13.0))
void
sec_protocol_options_add_tls_ciphersuite(sec_protocol_options_t options, SSLCipherSuite ciphersuite);
/*!
* @function sec_protocol_options_append_tls_ciphersuite_group
*
* @abstract
* Append a TLS ciphersuite group to the set of enabled ciphersuites.
*
* @param options
* A `sec_protocol_options_t` instance.
*
* @param group
* A SSLCipherSuiteGroup value.
*/
API_AVAILABLE(macos(10.15), ios(13.0), watchos(6.0), tvos(13.0))
void
sec_protocol_options_append_tls_ciphersuite_group(sec_protocol_options_t options, tls_ciphersuite_group_t group);
/*!
* @function sec_protocol_options_add_tls_ciphersuite_group
*
* @abstract
* Add a TLS ciphersuite group to the set of enabled ciphersuites.
*
* @param options
* A `sec_protocol_options_t` instance.
*
* @param group
* A SSLCipherSuiteGroup value.
*/
API_DEPRECATED("Use sec_protocol_options_append_tls_ciphersuite_group", macos(10.14, 10.15), ios(12.0, 13.0), watchos(5.0, 6.0), tvos(12.0, 13.0), macCatalyst(13.0, 13.0))
void
sec_protocol_options_add_tls_ciphersuite_group(sec_protocol_options_t options, SSLCiphersuiteGroup group);
/*!
* @function sec_protocol_options_set_tls_min_version
*
* @abstract
* Set the minimum support TLS version.
*
* @param options
* A `sec_protocol_options_t` instance.
*
* @param version
* A SSLProtocol enum value.
*/
API_DEPRECATED_WITH_REPLACEMENT("sec_protocol_options_set_min_tls_protocol_version",
macos(10.14, 10.15), ios(12.0, 13.0), watchos(5.0, 6.0), tvos(12.0, 13.0), macCatalyst(13.0, 13.0))
void
sec_protocol_options_set_tls_min_version(sec_protocol_options_t options, SSLProtocol version);
/*!
* @function sec_protocol_options_set_min_tls_protocol_version
*
* @abstract
* Set the minimum support TLS version.
*
* @param options
* A `sec_protocol_options_t` instance.
*
* @param version
* A tls_protocol_version_t enum value.
*/
API_AVAILABLE(macos(10.15), ios(13.0), watchos(6.0), tvos(13.0))
void
sec_protocol_options_set_min_tls_protocol_version(sec_protocol_options_t options, tls_protocol_version_t version);
/*!
* @function sec_protocol_options_get_default_min_tls_protocol_version
*
* @abstract
* Get the system default minimum TLS protocol version.
*
* @return The default minimum TLS version.
*/
API_AVAILABLE(macos(10.15), ios(13.0), watchos(6.0), tvos(13.0))
tls_protocol_version_t
sec_protocol_options_get_default_min_tls_protocol_version(void);
/*!
* @function sec_protocol_options_get_default_min_dtls_protocol_version
*
* @abstract
* Get the system default minimum DTLS protocol version.
*
* @return The default minimum DTLS version.
*/
API_AVAILABLE(macos(10.15), ios(13.0), watchos(6.0), tvos(13.0))
tls_protocol_version_t
sec_protocol_options_get_default_min_dtls_protocol_version(void);
/*!
* @function sec_protocol_options_set_tls_max_version
*
* @abstract
* Set the maximum support TLS version.
*
* @param options
* A `sec_protocol_options_t` instance.
*
* @param version
* A SSLProtocol enum value.
*/
API_DEPRECATED_WITH_REPLACEMENT("sec_protocol_options_set_max_tls_protocol_version",
macos(10.14, 10.15), ios(12.0, 13.0), watchos(5.0, 6.0), tvos(12.0, 13.0), macCatalyst(13.0, 13.0))
void
sec_protocol_options_set_tls_max_version(sec_protocol_options_t options, SSLProtocol version);
/*!
* @function sec_protocol_options_set_max_tls_protocol_version
*
* @abstract
* Set the maximum support TLS version.
*
* @param options
* A `sec_protocol_options_t` instance.
*
* @param version
* A tls_protocol_version_t enum value.
*/
API_AVAILABLE(macos(10.15), ios(13.0), watchos(6.0), tvos(13.0))
void
sec_protocol_options_set_max_tls_protocol_version(sec_protocol_options_t options, tls_protocol_version_t version);
/*!
* @function sec_protocol_options_get_default_max_tls_protocol_version
*
* @abstract
* Get the system default maximum TLS protocol version.
*
* @return The default maximum TLS version.
*/
API_AVAILABLE(macos(10.15), ios(13.0), watchos(6.0), tvos(13.0))
tls_protocol_version_t
sec_protocol_options_get_default_max_tls_protocol_version(void);
/*!
* @function sec_protocol_options_get_default_max_tls_protocol_version
*
* @abstract
* Get the system default maximum DTLS protocol version.
*
* @return The default maximum DTLS version.
*/
API_AVAILABLE(macos(10.15), ios(13.0), watchos(6.0), tvos(13.0))
tls_protocol_version_t
sec_protocol_options_get_default_max_dtls_protocol_version(void);
/*!
* @function sec_protocol_options_get_enable_encrypted_client_hello
*
* @abstract
* For experimental use only. Find out whether Encrypted Client Hello has been enabled.
*
* @return A boolean that indicates whether or not Encrypted Client Hello has been enabled.
*/
API_UNAVAILABLE(macos, ios, watchos, tvos)
bool
sec_protocol_options_get_enable_encrypted_client_hello(sec_protocol_options_t options);
/*!
* @function sec_protocol_options_get_quic_use_legacy_codepoint
*
* @abstract
* Check whether the QUIC legacy codepoint has been enabled.
*
* @return A boolean that indicates whether or not the QUIC legacy codepoint has been
* enabled.
*/
API_UNAVAILABLE(macos, ios, watchos, tvos)
bool
sec_protocol_options_get_quic_use_legacy_codepoint(sec_protocol_options_t options);
/*!
* @function sec_protocol_options_add_tls_application_protocol
*
* @abstract
* Add an application protocol supported by clients of this protocol instance.
*
* @param options
* A `sec_protocol_options_t` instance.
*
* @param application_protocol
* A NULL-terminated string defining the application protocol.
*/
API_AVAILABLE(macos(10.14), ios(12.0), watchos(5.0), tvos(12.0))
void
sec_protocol_options_add_tls_application_protocol(sec_protocol_options_t options, const char *application_protocol);
/*!
* @function sec_protocol_options_set_tls_server_name
*
* @abstract
* Set the server name to be used when verifying the peer's certificate. This will override
* the server name obtained from the endpoint.
*
* @param options
* A `sec_protocol_options_t` instance.
*
* @param server_name
* A NULL-terminated string carrying the server name.
*/
API_AVAILABLE(macos(10.14), ios(12.0), watchos(5.0), tvos(12.0))
void
sec_protocol_options_set_tls_server_name(sec_protocol_options_t options, const char *server_name);
/*!
* @function sec_protocol_options_set_tls_diffie_hellman_parameters
*
* @abstract
* Set the supported Diffie-Hellman parameters.
*
* @param options
* A `sec_protocol_options_t` instance.
*
* @param params
* A dispatch_data_t containing legacy Diffie-Hellman parameters.
*/
API_DEPRECATED("DHE ciphersuites are no longer supported", macos(10.14, 10.15), ios(12.0, 13.0), watchos(5.0, 6.0), tvos(12.0, 13.0))
void
sec_protocol_options_set_tls_diffie_hellman_parameters(sec_protocol_options_t options, dispatch_data_t params);
/*!
* @function sec_protocol_options_add_pre_shared_key
*
* @abstract
* Add a pre-shared key (PSK) and its identity to the options.
*
* @param options
* A `sec_protocol_options_t` instance.
*
* @param psk
* A dispatch_data_t containing a PSK blob.
*
* @param psk_identity
* A dispatch_data_t containing a PSK identity blob.
*/
API_AVAILABLE(macos(10.14), ios(12.0), watchos(5.0), tvos(12.0))
void
sec_protocol_options_add_pre_shared_key(sec_protocol_options_t options, dispatch_data_t psk, dispatch_data_t psk_identity);
/*!
* @function sec_protocol_options_set_tls_pre_shared_key_identity_hint
*
* @abstract
* Set the PSK identity hint to use by servers when negotiating a PSK ciphersuite.
* See https://tools.ietf.org/html/rfc4279 for more details.
*
* @param options
* A `sec_protocol_options_t` instance.
*
* @param psk_identity_hint
* A dispatch_data_t containing a PSK identity hint.
*/
API_AVAILABLE(macos(10.15), ios(13.0), watchos(6.0), tvos(13.0))
void
sec_protocol_options_set_tls_pre_shared_key_identity_hint(sec_protocol_options_t options, dispatch_data_t psk_identity_hint);
#ifdef __BLOCKS__
/*!
* @block sec_protocol_pre_shared_key_selection_complete_t
*
* @abstract
* Block to be invoked when a PSK selection event is complete and a PSK identity is chosen.
*
* @param psk_identity
* A `dispatch_data_t` instance carrying the chosen PSK identity, or nil if one does not match.
*/
typedef void (^sec_protocol_pre_shared_key_selection_complete_t)(dispatch_data_t _Nullable psk_identity);
/*!
* @block sec_protocol_pre_shared_key_selection_t
*
* @abstract
* Block to be invoked when the client must choose a PSK identity given a hint from its peer.
*
* @param metadata
* A `sec_protocol_metadata_t` instance.
*
* @param psk_identity_hint
* A `dispatch_data_t` object carrying the peer's (optional) PSK identity hint.
*
* @param complete
* A `sec_protocol_pre_shared_key_selection_complete_t` block to be invoked when PSK selection is complete.
*/
typedef void (^sec_protocol_pre_shared_key_selection_t)(sec_protocol_metadata_t metadata, dispatch_data_t _Nullable psk_identity_hint, sec_protocol_pre_shared_key_selection_complete_t complete);
/*!
* @function sec_protocol_options_set_pre_shared_key_selection_block
*
* @abstract
* Set the PSK selection block.
*
* @param options
* A `sec_protocol_options_t` instance.
*
* @param psk_selection_block
* A `sec_protocol_pre_shared_key_selection_t` block.
*
* @params psk_selection_queue
* A `dispatch_queue_t` on which the PSK selection block should be called.
*/
API_AVAILABLE(macos(10.15), ios(13.0), watchos(6.0), tvos(13.0))
void
sec_protocol_options_set_pre_shared_key_selection_block(sec_protocol_options_t options, sec_protocol_pre_shared_key_selection_t psk_selection_block, dispatch_queue_t psk_selection_queue);
#endif // __BLOCKS__
/*!
* @function sec_protocol_options_set_tls_tickets_enabled
*
* @abstract
* Enable or disable TLS session ticket support.
*
* @param options
* A `sec_protocol_options_t` instance.
*
* @param tickets_enabled
* Flag to enable or disable TLS session ticket support.
*/
API_AVAILABLE(macos(10.14), ios(12.0), watchos(5.0), tvos(12.0))
void
sec_protocol_options_set_tls_tickets_enabled(sec_protocol_options_t options, bool tickets_enabled);
/*!
* @function sec_protocol_options_set_tls_is_fallback_attempt
*
* @abstract
* Signal if this is a TLS fallback attempt.
*
* A fallback attempt is one following a previously failed TLS connection
* due to version or parameter incompatibility, e.g., when speaking to a server
* that does not support a client-offered ciphersuite.
*
* Clients MUST NOT enable fallback for fresh connections.
*
* @param options
* A `sec_protocol_options_t` instance.
*
* @param is_fallback_attempt
* Set a flag indicating that this is a TLS fallback attempt.
*/
API_AVAILABLE(macos(10.14), ios(12.0), watchos(5.0), tvos(12.0))
void
sec_protocol_options_set_tls_is_fallback_attempt(sec_protocol_options_t options, bool is_fallback_attempt);
/*!
* @function sec_protocol_options_set_tls_resumption_enabled
*
* @abstract
* Enable or disable TLS session resumption.
*
* @param options
* A `sec_protocol_options_t` instance.
*
* @param resumption_enabled
* Flag to enable or disable TLS session resumption.
*/
API_AVAILABLE(macos(10.14), ios(12.0), watchos(5.0), tvos(12.0))
void
sec_protocol_options_set_tls_resumption_enabled(sec_protocol_options_t options, bool resumption_enabled);
/*!
* @function sec_protocol_options_set_tls_false_start_enabled
*
* @abstract
* Enable or disable TLS False Start.
*
* @param options
* A `sec_protocol_options_t` instance.
*
* @param false_start_enabled
* Flag to enable or disable TLS False Start.
*/
API_AVAILABLE(macos(10.14), ios(12.0), watchos(5.0), tvos(12.0))
void
sec_protocol_options_set_tls_false_start_enabled(sec_protocol_options_t options, bool false_start_enabled);
/*!
* @function nw_protocol_options_set_tls_ocsp_enabled
*
* @abstract
* Enable or disable OCSP support.
*
* @param options
* A `sec_protocol_options_t` instance.
*
* @param ocsp_enabled
* Flag to enable or disable OCSP support.
*/
API_AVAILABLE(macos(10.14), ios(12.0), watchos(5.0), tvos(12.0))
void
sec_protocol_options_set_tls_ocsp_enabled(sec_protocol_options_t options, bool ocsp_enabled);
/*!
* @function sec_protocol_options_set_tls_sct_enabled
*
* @abstract
* Enable or disable SCT (signed certificate timestamp) support.
*
* @param options
* A `sec_protocol_options_t` instance.
*
* @param sct_enabled
* Flag to enable or disable SCT support.
*/
API_AVAILABLE(macos(10.14), ios(12.0), watchos(5.0), tvos(12.0))
void
sec_protocol_options_set_tls_sct_enabled(sec_protocol_options_t options, bool sct_enabled);
/*!
* @function sec_protocol_options_set_tls_renegotiation_enabled
*
* @abstract
* Enable or disable TLS (1.2 and prior) session renegotiation. This defaults to `true`.
*
* @param options
* A `sec_protocol_options_t` instance.
*
* @param renegotiation_enabled
* Flag to enable or disable TLS (1.2 and prior) session renegotiation.
*/
API_AVAILABLE(macos(10.14), ios(12.0), watchos(5.0), tvos(12.0))
void
sec_protocol_options_set_tls_renegotiation_enabled(sec_protocol_options_t options, bool renegotiation_enabled);
/*!
* @function sec_protocol_options_set_peer_authentication_required
*
* @abstract
* Enable or disable peer authentication. Clients default to true, whereas servers default to false.
*
* @param options
* A `sec_protocol_options_t` instance.
*
* @param peer_authentication_required
* Flag to enable or disable mandatory peer authentication.
*/
API_AVAILABLE(macos(10.14), ios(12.0), watchos(5.0), tvos(12.0))
void
sec_protocol_options_set_peer_authentication_required(sec_protocol_options_t options, bool peer_authentication_required);
/*!
* @function sec_protocol_options_set_peer_authentication_optional
*
* @abstract
* When this is enabled, the endpoint requests the peer certificate, but if none is provided, the
* endpoint still proceeds with the connection. Default false for servers; always false for clients (clients ignore
* this option). If peer_authentication_required is set to true via
* sec_protocol_options_set_peer_authentication_required(), peer_authentication_optional will be disregarded
* and the peer certificate will be required.
*
* @param options
* A `sec_protocol_options_t` instance.
*
* @param peer_authentication_optional
* Flag to enable or disable requested peer authentication.
*/
API_UNAVAILABLE(macos, ios, watchos, tvos)
void
sec_protocol_options_set_peer_authentication_optional(sec_protocol_options_t options, bool peer_authentication_optional);
/*!
* @function sec_protocol_options_set_enable_encrypted_client_hello
*
* @abstract
* For experimental use only. When this is enabled, the Encrypted Client Hello extension will be sent on the Client
* Hello if TLS 1.3 is among the supported TLS versions. Default false.
*
* @param options
* A `sec_protocol_options_t` instance.
*
* @param peer_authentication_optional
* Flag to enable or disable Encrypted Client Hello.
*/
API_UNAVAILABLE(macos, ios, watchos, tvos)
void
sec_protocol_options_set_enable_encrypted_client_hello(sec_protocol_options_t options, bool enable_encrypted_client_hello);
/*!
* @function sec_protocol_options_set_quic_use_legacy_codepoint
*
* @abstract
* Set QUIC to use the legacy codepoint. Defaults to true.
*
* @param options
* A `sec_protocol_options_t` instance.
*
* @param quic_use_legacy_codepoint
* A boolean to enable/disable the legacy codepoint.
*/
API_UNAVAILABLE(macos, ios, watchos, tvos)
void
sec_protocol_options_set_quic_use_legacy_codepoint(sec_protocol_options_t options, bool quic_use_legacy_codepoint);
#ifdef __BLOCKS__
/*!
* @block sec_protocol_key_update_complete_t
*
* @abstract
* Block to be invoked when a key update event is handled.
*/
typedef void (^sec_protocol_key_update_complete_t)(void);
/*!
* @block sec_protocol_key_update_t
*
* @abstract
* Block to be invoked when the protocol key MUST be updated.
*
* @param metadata
* A `sec_protocol_metadata_t` instance.
*
* @param complete
* A `sec_protocol_key_update_complete_t` to be invoked when the key update is complete.
*/
typedef void (^sec_protocol_key_update_t)(sec_protocol_metadata_t metadata, sec_protocol_key_update_complete_t complete);
/*!
* @block sec_protocol_challenge_complete_t
*
* @abstract
* Block to be invoked when an identity (authentication) challenge is complete.
*
* Note: prior to macOS 10.15, iOS 13.0, watchOS 6.0, and tvOS 13.0, calling this
* block with a NULL `identity` argument was prohibited.
*
* @param identity
* A `sec_identity_t` containing the identity to use for this challenge.
*/
typedef void (^sec_protocol_challenge_complete_t)(sec_identity_t __nullable identity);
/*!
* @block sec_protocol_challenge_t
*
* @abstract
* Block to be invoked when the protocol instance is issued a challenge (e.g., a TLS certificate request).
*
* @param metadata
* A `sec_protocol_metadata_t` instance.
*
* @param complete
* A `sec_protocol_challenge_complete_t` to be invoked when the challenge is complete.
*/
typedef void (^sec_protocol_challenge_t)(sec_protocol_metadata_t metadata, sec_protocol_challenge_complete_t complete);
/*!
* @block sec_protocol_verify_complete_t
*
* @abstract
* Block to be invoked when verification is complete.
*
* @param result
* A `bool` indicating if verification succeeded or failed.
*/
typedef void (^sec_protocol_verify_complete_t)(bool result);
/*!
* @block sec_protocol_verify_t
*
* @abstract
* Block to be invoked when the protocol instance must verify the peer.
*
* NOTE: this may be called one or more times for a given connection.
*
* @param metadata
* A `sec_protocol_metadata_t` instance.
*
* @param trust_ref
* A `sec_trust_t` instance.
*
* @param complete
* A `sec_protocol_verify_finish_t` to be invoked when verification is complete.
*/
typedef void (^sec_protocol_verify_t)(sec_protocol_metadata_t metadata, sec_trust_t trust_ref, sec_protocol_verify_complete_t complete);
/*!
* @function sec_protocol_options_set_key_update_block
*
* @abstract
* Set the key update block.
*
* @param options
* A `sec_protocol_options_t` instance.
*
* @param key_update_block
* A `sec_protocol_key_update_t` block.
*
* @params key_update_queue
* A `dispatch_queue_t` on which the key update block should be called.
*/
API_AVAILABLE(macos(10.14), ios(12.0), watchos(5.0), tvos(12.0))
void
sec_protocol_options_set_key_update_block(sec_protocol_options_t options, sec_protocol_key_update_t key_update_block, dispatch_queue_t key_update_queue);
/*!
* @function sec_protocol_options_set_challenge_block
*
* @abstract
* Set the challenge block.
*
* @param options
* A `sec_protocol_options_t` instance.
*
* @params challenge_block
* A `sec_protocol_challenge_t` block.
*
* @params challenge_queue
* A `dispatch_queue_t` on which the challenge block should be called.
*/
API_AVAILABLE(macos(10.14), ios(12.0), watchos(5.0), tvos(12.0))
void
sec_protocol_options_set_challenge_block(sec_protocol_options_t options, sec_protocol_challenge_t challenge_block, dispatch_queue_t challenge_queue);
/*!
* @function sec_protocol_options_set_verify_block
*
* @abstract
* Set the verify block.
*
* @param options
* A `sec_protocol_options_t` instance.
*
* @params verify_block
* A `sec_protocol_verify_t` block.
*
* @params verify_block_queue
* A `dispatch_queue_t` on which the verify block should be called.
*/
API_AVAILABLE(macos(10.14), ios(12.0), watchos(5.0), tvos(12.0))
void
sec_protocol_options_set_verify_block(sec_protocol_options_t options, sec_protocol_verify_t verify_block, dispatch_queue_t verify_block_queue);
#endif // __BLOCKS__
SEC_ASSUME_NONNULL_END
__END_DECLS
#endif // SecProtocolOptions_h
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Security.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Security.framework/Headers/SecKeychainSearch.h | /*
* Copyright (c) 2000-2011 Apple Inc. All Rights Reserved.
*
* @APPLE_LICENSE_HEADER_START@
*
* This file contains Original Code and/or Modifications of Original Code
* as defined in and that are subject to the Apple Public Source License
* Version 2.0 (the 'License'). You may not use this file except in
* compliance with the License. Please obtain a copy of the License at
* http://www.opensource.apple.com/apsl/ and read it before using this
* file.
*
* The Original Code and all software distributed under the License are
* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
* Please see the License for the specific language governing rights and
* limitations under the License.
*
* @APPLE_LICENSE_HEADER_END@
*/
/*!
@header SecKeychainSearch
The functions provided in SecKeychainSearch implement a query of one or more keychains to search for a particular SecKeychainItem.
*/
#ifndef _SECURITY_SECKEYCHAINSEARCH_H_
#define _SECURITY_SECKEYCHAINSEARCH_H_
#include <Security/SecKeychainItem.h>
#if defined(__cplusplus)
extern "C" {
#endif
CF_ASSUME_NONNULL_BEGIN
/*!
@function SecKeychainSearchGetTypeID
@abstract Returns the type identifier of SecKeychainSearch instances.
@result The CFTypeID of SecKeychainSearch instances.
@discussion This API is deprecated in 10.7. The SecKeychainSearchRef type is no longer used.
*/
CFTypeID SecKeychainSearchGetTypeID(void)
API_DEPRECATED("SecKeychainSearch is not supported", macos(10.0, 10.7)) API_UNAVAILABLE(ios, watchos, tvos, macCatalyst);
/*!
@function SecKeychainSearchCreateFromAttributes
@abstract Creates a search reference matching a list of zero or more specified attributes in the specified keychain.
@param keychainOrArray An reference to an array of keychains to search, a single keychain or NULL to search the user's default keychain search list.
@param itemClass The keychain item class.
@param attrList A pointer to a list of zero or more keychain attribute records to match. Pass NULL to match any keychain attribute.
@param searchRef On return, a pointer to the current search reference. You are responsible for calling the CFRelease function to release this reference when finished with it.
@result A result code. See "Security Error Codes" (SecBase.h).
@discussion This function is deprecated in Mac OS X 10.7 and later; to find keychain items which match specified attributes, please use the SecItemCopyMatching API (see SecItem.h).
*/
OSStatus SecKeychainSearchCreateFromAttributes(CFTypeRef __nullable keychainOrArray, SecItemClass itemClass, const SecKeychainAttributeList * __nullable attrList, SecKeychainSearchRef * __nonnull CF_RETURNS_RETAINED searchRef)
API_DEPRECATED("SecKeychainSearch is not supported", macos(10.0, 10.7)) API_UNAVAILABLE(ios, watchos, tvos, macCatalyst);
/*!
@function SecKeychainSearchCopyNext
@abstract Finds the next keychain item matching the given search criteria.
@param searchRef A reference to the current search criteria. The search reference is created in the SecKeychainSearchCreateFromAttributes function and must be released by calling the CFRelease function when you are done with it.
@param itemRef On return, a pointer to a keychain item reference of the next matching keychain item, if any.
@result A result code. When there are no more items that match the parameters specified to SecPolicySearchCreate, errSecItemNotFound is returned. See "Security Error Codes" (SecBase.h).
@discussion This function is deprecated in Mac OS X 10.7 and later; to find keychain items which match specified attributes, please use the SecItemCopyMatching API (see SecItem.h).
*/
OSStatus SecKeychainSearchCopyNext(SecKeychainSearchRef searchRef, SecKeychainItemRef * __nonnull CF_RETURNS_RETAINED itemRef)
API_DEPRECATED("SecKeychainSearch is not supported", macos(10.0, 10.7)) API_UNAVAILABLE(ios, watchos, tvos, macCatalyst);
CF_ASSUME_NONNULL_END
#if defined(__cplusplus)
}
#endif
#endif /* !_SECURITY_SECKEYCHAINSEARCH_H_ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Security.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Security.framework/Headers/CipherSuite.h | /*
* Copyright (c) 1999-2002,2005-2007,2010-2014 Apple Inc. All Rights Reserved.
*
* @APPLE_LICENSE_HEADER_START@
*
* This file contains Original Code and/or Modifications of Original Code
* as defined in and that are subject to the Apple Public Source License
* Version 2.0 (the 'License'). You may not use this file except in
* compliance with the License. Please obtain a copy of the License at
* http://www.opensource.apple.com/apsl/ and read it before using this
* file.
*
* The Original Code and all software distributed under the License are
* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
* Please see the License for the specific language governing rights and
* limitations under the License.
*
* @APPLE_LICENSE_HEADER_END@
*/
/*
* CipherSuite.h - SSL Cipher Suite definitions.
*/
#ifndef _SECURITY_CIPHERSUITE_H_
#define _SECURITY_CIPHERSUITE_H_
#include <TargetConditionals.h>
#include <stdint.h>
#include <CoreFoundation/CFBase.h> /* CF_ENUM */
/*
* Defined as enum for debugging, but in the protocol
* it is actually exactly two bytes
*/
#if ((TARGET_OS_IPHONE && !TARGET_OS_MACCATALYST) || (TARGET_OS_OSX && TARGET_CPU_ARM64))
/* 16-bit value on iOS */
typedef uint16_t SSLCipherSuite;
#else
/* 32-bit value elsewhere */
typedef uint32_t SSLCipherSuite;
#endif
CF_ENUM(SSLCipherSuite)
{ SSL_NULL_WITH_NULL_NULL = 0x0000,
SSL_RSA_WITH_NULL_MD5 = 0x0001,
SSL_RSA_WITH_NULL_SHA = 0x0002,
SSL_RSA_EXPORT_WITH_RC4_40_MD5 = 0x0003,
SSL_RSA_WITH_RC4_128_MD5 = 0x0004,
SSL_RSA_WITH_RC4_128_SHA = 0x0005,
SSL_RSA_EXPORT_WITH_RC2_CBC_40_MD5 = 0x0006,
SSL_RSA_WITH_IDEA_CBC_SHA = 0x0007,
SSL_RSA_EXPORT_WITH_DES40_CBC_SHA = 0x0008,
SSL_RSA_WITH_DES_CBC_SHA = 0x0009,
SSL_RSA_WITH_3DES_EDE_CBC_SHA = 0x000A,
SSL_DH_DSS_EXPORT_WITH_DES40_CBC_SHA = 0x000B,
SSL_DH_DSS_WITH_DES_CBC_SHA = 0x000C,
SSL_DH_DSS_WITH_3DES_EDE_CBC_SHA = 0x000D,
SSL_DH_RSA_EXPORT_WITH_DES40_CBC_SHA = 0x000E,
SSL_DH_RSA_WITH_DES_CBC_SHA = 0x000F,
SSL_DH_RSA_WITH_3DES_EDE_CBC_SHA = 0x0010,
SSL_DHE_DSS_EXPORT_WITH_DES40_CBC_SHA = 0x0011,
SSL_DHE_DSS_WITH_DES_CBC_SHA = 0x0012,
SSL_DHE_DSS_WITH_3DES_EDE_CBC_SHA = 0x0013,
SSL_DHE_RSA_EXPORT_WITH_DES40_CBC_SHA = 0x0014,
SSL_DHE_RSA_WITH_DES_CBC_SHA = 0x0015,
SSL_DHE_RSA_WITH_3DES_EDE_CBC_SHA = 0x0016,
SSL_DH_anon_EXPORT_WITH_RC4_40_MD5 = 0x0017,
SSL_DH_anon_WITH_RC4_128_MD5 = 0x0018,
SSL_DH_anon_EXPORT_WITH_DES40_CBC_SHA = 0x0019,
SSL_DH_anon_WITH_DES_CBC_SHA = 0x001A,
SSL_DH_anon_WITH_3DES_EDE_CBC_SHA = 0x001B,
SSL_FORTEZZA_DMS_WITH_NULL_SHA = 0x001C,
SSL_FORTEZZA_DMS_WITH_FORTEZZA_CBC_SHA = 0x001D,
/* TLS addenda using AES, per RFC 3268 */
TLS_RSA_WITH_AES_128_CBC_SHA = 0x002F,
TLS_DH_DSS_WITH_AES_128_CBC_SHA = 0x0030,
TLS_DH_RSA_WITH_AES_128_CBC_SHA = 0x0031,
TLS_DHE_DSS_WITH_AES_128_CBC_SHA = 0x0032,
TLS_DHE_RSA_WITH_AES_128_CBC_SHA = 0x0033,
TLS_DH_anon_WITH_AES_128_CBC_SHA = 0x0034,
TLS_RSA_WITH_AES_256_CBC_SHA = 0x0035,
TLS_DH_DSS_WITH_AES_256_CBC_SHA = 0x0036,
TLS_DH_RSA_WITH_AES_256_CBC_SHA = 0x0037,
TLS_DHE_DSS_WITH_AES_256_CBC_SHA = 0x0038,
TLS_DHE_RSA_WITH_AES_256_CBC_SHA = 0x0039,
TLS_DH_anon_WITH_AES_256_CBC_SHA = 0x003A,
/* ECDSA addenda, RFC 4492 */
TLS_ECDH_ECDSA_WITH_NULL_SHA = 0xC001,
TLS_ECDH_ECDSA_WITH_RC4_128_SHA = 0xC002,
TLS_ECDH_ECDSA_WITH_3DES_EDE_CBC_SHA = 0xC003,
TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA = 0xC004,
TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA = 0xC005,
TLS_ECDHE_ECDSA_WITH_NULL_SHA = 0xC006,
TLS_ECDHE_ECDSA_WITH_RC4_128_SHA = 0xC007,
TLS_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA = 0xC008,
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA = 0xC009,
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA = 0xC00A,
TLS_ECDH_RSA_WITH_NULL_SHA = 0xC00B,
TLS_ECDH_RSA_WITH_RC4_128_SHA = 0xC00C,
TLS_ECDH_RSA_WITH_3DES_EDE_CBC_SHA = 0xC00D,
TLS_ECDH_RSA_WITH_AES_128_CBC_SHA = 0xC00E,
TLS_ECDH_RSA_WITH_AES_256_CBC_SHA = 0xC00F,
TLS_ECDHE_RSA_WITH_NULL_SHA = 0xC010,
TLS_ECDHE_RSA_WITH_RC4_128_SHA = 0xC011,
TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA = 0xC012,
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA = 0xC013,
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA = 0xC014,
TLS_ECDH_anon_WITH_NULL_SHA = 0xC015,
TLS_ECDH_anon_WITH_RC4_128_SHA = 0xC016,
TLS_ECDH_anon_WITH_3DES_EDE_CBC_SHA = 0xC017,
TLS_ECDH_anon_WITH_AES_128_CBC_SHA = 0xC018,
TLS_ECDH_anon_WITH_AES_256_CBC_SHA = 0xC019,
/* ECDHE_PSK Cipher Suites for Transport Layer Security (TLS), RFC 5489 */
TLS_ECDHE_PSK_WITH_AES_128_CBC_SHA = 0xC035,
TLS_ECDHE_PSK_WITH_AES_256_CBC_SHA = 0xC036,
/* ChaCha20-Poly1305 Cipher Suites for Transport Layer Security (TLS), RFC 7905 */
TLS_PSK_WITH_CHACHA20_POLY1305_SHA256 = 0xCCAB,
/* TLS 1.2 addenda, RFC 5246 */
/* Initial state. */
TLS_NULL_WITH_NULL_NULL = 0x0000,
/* Server provided RSA certificate for key exchange. */
TLS_RSA_WITH_NULL_MD5 = 0x0001,
TLS_RSA_WITH_NULL_SHA = 0x0002,
TLS_RSA_WITH_RC4_128_MD5 = 0x0004,
TLS_RSA_WITH_RC4_128_SHA = 0x0005,
TLS_RSA_WITH_3DES_EDE_CBC_SHA = 0x000A,
TLS_RSA_WITH_NULL_SHA256 = 0x003B,
TLS_RSA_WITH_AES_128_CBC_SHA256 = 0x003C,
TLS_RSA_WITH_AES_256_CBC_SHA256 = 0x003D,
/* Server-authenticated (and optionally client-authenticated) Diffie-Hellman. */
TLS_DH_DSS_WITH_3DES_EDE_CBC_SHA = 0x000D,
TLS_DH_RSA_WITH_3DES_EDE_CBC_SHA = 0x0010,
TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA = 0x0013,
TLS_DHE_RSA_WITH_3DES_EDE_CBC_SHA = 0x0016,
TLS_DH_DSS_WITH_AES_128_CBC_SHA256 = 0x003E,
TLS_DH_RSA_WITH_AES_128_CBC_SHA256 = 0x003F,
TLS_DHE_DSS_WITH_AES_128_CBC_SHA256 = 0x0040,
TLS_DHE_RSA_WITH_AES_128_CBC_SHA256 = 0x0067,
TLS_DH_DSS_WITH_AES_256_CBC_SHA256 = 0x0068,
TLS_DH_RSA_WITH_AES_256_CBC_SHA256 = 0x0069,
TLS_DHE_DSS_WITH_AES_256_CBC_SHA256 = 0x006A,
TLS_DHE_RSA_WITH_AES_256_CBC_SHA256 = 0x006B,
/* Completely anonymous Diffie-Hellman */
TLS_DH_anon_WITH_RC4_128_MD5 = 0x0018,
TLS_DH_anon_WITH_3DES_EDE_CBC_SHA = 0x001B,
TLS_DH_anon_WITH_AES_128_CBC_SHA256 = 0x006C,
TLS_DH_anon_WITH_AES_256_CBC_SHA256 = 0x006D,
/* Addendum from RFC 4279, TLS PSK */
TLS_PSK_WITH_RC4_128_SHA = 0x008A,
TLS_PSK_WITH_3DES_EDE_CBC_SHA = 0x008B,
TLS_PSK_WITH_AES_128_CBC_SHA = 0x008C,
TLS_PSK_WITH_AES_256_CBC_SHA = 0x008D,
TLS_DHE_PSK_WITH_RC4_128_SHA = 0x008E,
TLS_DHE_PSK_WITH_3DES_EDE_CBC_SHA = 0x008F,
TLS_DHE_PSK_WITH_AES_128_CBC_SHA = 0x0090,
TLS_DHE_PSK_WITH_AES_256_CBC_SHA = 0x0091,
TLS_RSA_PSK_WITH_RC4_128_SHA = 0x0092,
TLS_RSA_PSK_WITH_3DES_EDE_CBC_SHA = 0x0093,
TLS_RSA_PSK_WITH_AES_128_CBC_SHA = 0x0094,
TLS_RSA_PSK_WITH_AES_256_CBC_SHA = 0x0095,
/* RFC 4785 - Pre-Shared Key (PSK) Ciphersuites with NULL Encryption */
TLS_PSK_WITH_NULL_SHA = 0x002C,
TLS_DHE_PSK_WITH_NULL_SHA = 0x002D,
TLS_RSA_PSK_WITH_NULL_SHA = 0x002E,
/* Addenda from rfc 5288 AES Galois Counter Mode (GCM) Cipher Suites for TLS. */
TLS_RSA_WITH_AES_128_GCM_SHA256 = 0x009C,
TLS_RSA_WITH_AES_256_GCM_SHA384 = 0x009D,
TLS_DHE_RSA_WITH_AES_128_GCM_SHA256 = 0x009E,
TLS_DHE_RSA_WITH_AES_256_GCM_SHA384 = 0x009F,
TLS_DH_RSA_WITH_AES_128_GCM_SHA256 = 0x00A0,
TLS_DH_RSA_WITH_AES_256_GCM_SHA384 = 0x00A1,
TLS_DHE_DSS_WITH_AES_128_GCM_SHA256 = 0x00A2,
TLS_DHE_DSS_WITH_AES_256_GCM_SHA384 = 0x00A3,
TLS_DH_DSS_WITH_AES_128_GCM_SHA256 = 0x00A4,
TLS_DH_DSS_WITH_AES_256_GCM_SHA384 = 0x00A5,
TLS_DH_anon_WITH_AES_128_GCM_SHA256 = 0x00A6,
TLS_DH_anon_WITH_AES_256_GCM_SHA384 = 0x00A7,
/* RFC 5487 - PSK with SHA-256/384 and AES GCM */
TLS_PSK_WITH_AES_128_GCM_SHA256 = 0x00A8,
TLS_PSK_WITH_AES_256_GCM_SHA384 = 0x00A9,
TLS_DHE_PSK_WITH_AES_128_GCM_SHA256 = 0x00AA,
TLS_DHE_PSK_WITH_AES_256_GCM_SHA384 = 0x00AB,
TLS_RSA_PSK_WITH_AES_128_GCM_SHA256 = 0x00AC,
TLS_RSA_PSK_WITH_AES_256_GCM_SHA384 = 0x00AD,
TLS_PSK_WITH_AES_128_CBC_SHA256 = 0x00AE,
TLS_PSK_WITH_AES_256_CBC_SHA384 = 0x00AF,
TLS_PSK_WITH_NULL_SHA256 = 0x00B0,
TLS_PSK_WITH_NULL_SHA384 = 0x00B1,
TLS_DHE_PSK_WITH_AES_128_CBC_SHA256 = 0x00B2,
TLS_DHE_PSK_WITH_AES_256_CBC_SHA384 = 0x00B3,
TLS_DHE_PSK_WITH_NULL_SHA256 = 0x00B4,
TLS_DHE_PSK_WITH_NULL_SHA384 = 0x00B5,
TLS_RSA_PSK_WITH_AES_128_CBC_SHA256 = 0x00B6,
TLS_RSA_PSK_WITH_AES_256_CBC_SHA384 = 0x00B7,
TLS_RSA_PSK_WITH_NULL_SHA256 = 0x00B8,
TLS_RSA_PSK_WITH_NULL_SHA384 = 0x00B9,
/* TLS 1.3 standard cipher suites for ChaCha20+Poly1305.
Note: TLS 1.3 ciphersuites do not specify the key exchange
algorithm -- they only specify the symmetric ciphers. */
TLS_AES_128_GCM_SHA256 = 0x1301,
TLS_AES_256_GCM_SHA384 = 0x1302,
TLS_CHACHA20_POLY1305_SHA256 = 0x1303,
TLS_AES_128_CCM_SHA256 = 0x1304,
TLS_AES_128_CCM_8_SHA256 = 0x1305,
/* Addenda from rfc 5289 Elliptic Curve Cipher Suites with
HMAC SHA-256/384. */
TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 = 0xC023,
TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 = 0xC024,
TLS_ECDH_ECDSA_WITH_AES_128_CBC_SHA256 = 0xC025,
TLS_ECDH_ECDSA_WITH_AES_256_CBC_SHA384 = 0xC026,
TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256 = 0xC027,
TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384 = 0xC028,
TLS_ECDH_RSA_WITH_AES_128_CBC_SHA256 = 0xC029,
TLS_ECDH_RSA_WITH_AES_256_CBC_SHA384 = 0xC02A,
/* Addenda from rfc 5289 Elliptic Curve Cipher Suites with
SHA-256/384 and AES Galois Counter Mode (GCM) */
TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 = 0xC02B,
TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 = 0xC02C,
TLS_ECDH_ECDSA_WITH_AES_128_GCM_SHA256 = 0xC02D,
TLS_ECDH_ECDSA_WITH_AES_256_GCM_SHA384 = 0xC02E,
TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 = 0xC02F,
TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 = 0xC030,
TLS_ECDH_RSA_WITH_AES_128_GCM_SHA256 = 0xC031,
TLS_ECDH_RSA_WITH_AES_256_GCM_SHA384 = 0xC032,
/* Addenda from rfc 7905 ChaCha20-Poly1305 Cipher Suites for
Transport Layer Security (TLS). */
TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 = 0xCCA8,
TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 = 0xCCA9,
/* RFC 5746 - Secure Renegotiation */
TLS_EMPTY_RENEGOTIATION_INFO_SCSV = 0x00FF,
/* Tags for SSL 2 cipher kinds which are not specified
* for SSL 3. */
SSL_RSA_WITH_RC2_CBC_MD5 = 0xFF80,
SSL_RSA_WITH_IDEA_CBC_MD5 = 0xFF81,
SSL_RSA_WITH_DES_CBC_MD5 = 0xFF82,
SSL_RSA_WITH_3DES_EDE_CBC_MD5 = 0xFF83,
SSL_NO_SUCH_CIPHERSUITE = 0xFFFF
};
/*
* Convenience ciphersuite groups that collate ciphersuites of comparable security
* properties into a single alias.
*/
typedef CF_ENUM(int, SSLCiphersuiteGroup) {
kSSLCiphersuiteGroupDefault,
kSSLCiphersuiteGroupCompatibility,
kSSLCiphersuiteGroupLegacy,
kSSLCiphersuiteGroupATS,
kSSLCiphersuiteGroupATSCompatibility,
};
#endif /* !_SECURITY_CIPHERSUITE_H_ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Security.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Security.framework/Headers/SecEncodeTransform.h | #ifndef __SECENCODETRANSFORM_H__
#define __SECENCODETRANSFORM_H__
/*
* Copyright (c) 2010-2011 Apple Inc. All Rights Reserved.
*
* @APPLE_LICENSE_HEADER_START@
*
* This file contains Original Code and/or Modifications of Original Code
* as defined in and that are subject to the Apple Public Source License
* Version 2.0 (the 'License'). You may not use this file except in
* compliance with the License. Please obtain a copy of the License at
* http://www.opensource.apple.com/apsl/ and read it before using this
* file.
*
* The Original Code and all software distributed under the License are
* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
* Please see the License for the specific language governing rights and
* limitations under the License.
*
* @APPLE_LICENSE_HEADER_END@
*/
#include <Security/SecTransform.h>
#ifdef __cplusplus
extern "C" {
#endif
CF_ASSUME_NONNULL_BEGIN
CF_IMPLICIT_BRIDGING_ENABLED
/*!
@abstract Specifies a base 64 encoding
*/
extern const CFStringRef kSecBase64Encoding;
/*!
@abstract Specifies a base 32 encoding
*/
extern const CFStringRef kSecBase32Encoding;
/*!
@abstract Specifies a compressed encoding.
*/
extern const CFStringRef kSecZLibEncoding;
/*!
@constant kSecEncodeTypeAttribute
Used with SecTransformGetAttribute to query the attribute type.
Returns one of the strings defined in the previous section.
*/
extern const CFStringRef kSecEncodeTypeAttribute;
extern const CFStringRef kSecLineLength64;
extern const CFStringRef kSecLineLength76;
/*!
@constant kSecEncodeLineLengthAttribute
Used with SecTransformSetAttribute to set the length
of encoded Base32 or Base64 lines. Some systems will
not decode or otherwise deal with excessively long lines,
or may be defined to limit lines to specific lengths
(for example RFC1421 - 64, and RFC2045 - 76).
The LineLengthAttribute may be set to any positive
value (via a CFNumberRef) to limit to a specific
length (values smaller then X for Base32 or Y for Base64
are assume to be X or Y), or to zero for no specific
limit. Either of the string constants kSecLineLength64
(RFC1421), or kSecLineLength76 (RFC2045) may be used to
set line lengths of 64 or 76 bytes.
*/
extern const CFStringRef kSecEncodeLineLengthAttribute;
extern const CFStringRef kSecCompressionRatio;
/*!
@function SecEncodeTransformCreate
@abstract Creates an encode computation object.
@param encodeType The type of encoding to compute. You may pass NULL
for this parameter, in which case an appropriate
algorithm will be chosen for you.
@param error A pointer to a CFErrorRef. This pointer will be set
if an error occurred. This value may be NULL if you
do not want an error returned.
@result A pointer to a SecTransformRef object. This object must
be released with CFRelease when you are done with
it. This function will return NULL if an error
occurred.
@discussion This function creates a transform which computes an
encode.
*/
// See SecDecodeTransformCreate for decoding...
__nullable
SecTransformRef SecEncodeTransformCreate(CFTypeRef encodeType,
CFErrorRef* error
)
__OSX_AVAILABLE_STARTING(__MAC_10_7,__IPHONE_NA);
CF_IMPLICIT_BRIDGING_DISABLED
CF_ASSUME_NONNULL_END
#ifdef __cplusplus
}
#endif
#endif
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Security.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Security.framework/Headers/oidsbase.h | /*
* Copyright (c) 1999-2001,2003-2004,2008-2014 Apple Inc. All Rights Reserved.
*
* @APPLE_LICENSE_HEADER_START@
*
* This file contains Original Code and/or Modifications of Original Code
* as defined in and that are subject to the Apple Public Source License
* Version 2.0 (the 'License'). You may not use this file except in
* compliance with the License. Please obtain a copy of the License at
* http://www.opensource.apple.com/apsl/ and read it before using this
* file.
*
* The Original Code and all software distributed under the License are
* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
* Please see the License for the specific language governing rights and
* limitations under the License.
*
* @APPLE_LICENSE_HEADER_END@
*
* oidsbase.h -- Basic Object Identifier Macros and Data Types.
*/
#ifndef _OIDSBASE_H_
#define _OIDSBASE_H_ 1
#ifdef __cplusplus
extern "C" {
#endif
#define SECASN1OID_DEF(NAME, VALUE, ARGS...) \
static const uint8_t _##NAME[] = { VALUE, ## ARGS }; \
const SecAsn1Oid NAME = { sizeof(_##NAME), (uint8_t *)_##NAME }
/* Intel CSSM */
#define INTEL 96, 134, 72, 1, 134, 248, 77
#define INTEL_LENGTH 7
#define INTEL_CDSASECURITY INTEL, 2
#define INTEL_CDSASECURITY_LENGTH (INTEL_LENGTH + 1)
#define INTEL_SEC_FORMATS INTEL_CDSASECURITY, 1
#define INTEL_SEC_FORMATS_LENGTH (INTEL_CDSASECURITY_LENGTH + 1)
#define INTEL_SEC_ALGS INTEL_CDSASECURITY, 2, 5
#define INTEL_SEC_ALGS_LENGTH (INTEL_CDSASECURITY_LENGTH + 2)
#define INTEL_SEC_OBJECT_BUNDLE INTEL_SEC_FORMATS, 4
#define INTEL_SEC_OBJECT_BUNDLE_LENGTH (INTEL_SEC_FORMATS_LENGTH + 1)
#define INTEL_CERT_AND_PRIVATE_KEY_2_0 INTEL_SEC_OBJECT_BUNDLE, 1
#define INTEL_CERT_AND_PRIVATE_KEY_2_0_LENGTH (INTEL_SEC_OBJECT_BUNDLE_LENGTH + 1)
/* Suffix specifying format or representation of a field value */
/* Note that if a format suffix is not specified, a flat data
representation is implied */
#define INTEL_X509_C_DATATYPE 1
#define INTEL_X509_LDAPSTRING_DATATYPE 2
#define OID_ISO_CCITT_DIR_SERVICE 85
#define OID_DS OID_ISO_CCITT_DIR_SERVICE
#define OID_DS_LENGTH 1
#define OID_ATTR_TYPE OID_DS, 4
#define OID_ATTR_TYPE_LENGTH OID_DS_LENGTH + 1
#define OID_EXTENSION OID_DS, 29
#define OID_EXTENSION_LENGTH OID_DS_LENGTH + 1
#define OID_ISO_STANDARD 40
#define OID_ISO_MEMBER 42
#define OID_US OID_ISO_MEMBER, 134, 72
#define OID_ISO_IDENTIFIED_ORG 43
#define OID_OSINET OID_ISO_IDENTIFIED_ORG, 4
#define OID_GOSIP OID_ISO_IDENTIFIED_ORG, 5
#define OID_DOD OID_ISO_IDENTIFIED_ORG, 6
#define OID_OIW OID_ISO_IDENTIFIED_ORG, 14
#define OID_ITU_RFCDATA_MEMBER_LENGTH 1
#define OID_ITU_RFCDATA 9
/* From the PKCS Standards */
#define OID_ISO_MEMBER_LENGTH 1
#define OID_US_LENGTH OID_ISO_MEMBER_LENGTH + 2
#define OID_RSA OID_US, 134, 247, 13
#define OID_RSA_LENGTH OID_US_LENGTH + 3
#define OID_RSA_HASH OID_RSA, 2
#define OID_RSA_HASH_LENGTH OID_RSA_LENGTH + 1
#define OID_RSA_ENCRYPT OID_RSA, 3
#define OID_RSA_ENCRYPT_LENGTH OID_RSA_LENGTH + 1
#define OID_PKCS OID_RSA, 1
#define OID_PKCS_LENGTH OID_RSA_LENGTH +1
#define OID_PKCS_1 OID_PKCS, 1
#define OID_PKCS_1_LENGTH OID_PKCS_LENGTH +1
#define OID_PKCS_2 OID_PKCS, 2
#define OID_PKCS_3 OID_PKCS, 3
#define OID_PKCS_3_LENGTH OID_PKCS_LENGTH +1
#define OID_PKCS_4 OID_PKCS, 4
#define OID_PKCS_5 OID_PKCS, 5
#define OID_PKCS_5_LENGTH OID_PKCS_LENGTH +1
#define OID_PKCS_6 OID_PKCS, 6
#define OID_PKCS_7 OID_PKCS, 7
#define OID_PKCS_7_LENGTH OID_PKCS_LENGTH +1
#define OID_PKCS_8 OID_PKCS, 8
#define OID_PKCS_9 OID_PKCS, 9
#define OID_PKCS_9_LENGTH OID_PKCS_LENGTH +1
#define OID_PKCS_10 OID_PKCS, 10
#define OID_PKCS_11 OID_PKCS, 11
#define OID_PKCS_11_LENGTH OID_PKCS_LENGTH +1
#define OID_PKCS_12 OID_PKCS, 12
#define OID_PKCS_12_LENGTH OID_PKCS_LENGTH +1
/* ANSI X9.42 */
#define OID_ANSI_X9_42 OID_US, 206, 62, 2
#define OID_ANSI_X9_42_LEN OID_US_LENGTH + 3
#define OID_ANSI_X9_42_SCHEME OID_ANSI_X9_42, 3
#define OID_ANSI_X9_42_SCHEME_LEN OID_ANSI_X9_42_LEN + 1
#define OID_ANSI_X9_42_NAMED_SCHEME OID_ANSI_X9_42, 4
#define OID_ANSI_X9_42_NAMED_SCHEME_LEN OID_ANSI_X9_42_LEN + 1
/* ANSI X9.62 (1 2 840 10045) */
#define OID_ANSI_X9_62 0x2A, 0x86, 0x48, 0xCE, 0x3D
#define OID_ANSI_X9_62_LEN 5
#define OID_ANSI_X9_62_FIELD_TYPE OID_ANSI_X9_62, 1
#define OID_ANSI_X9_62_PUBKEY_TYPE OID_ANSI_X9_62, 2
#define OID_ANSI_X9_62_ELL_CURVE OID_ANSI_X9_62, 3
#define OID_ANSI_X9_62_ELL_CURVE_LEN OID_ANSI_X9_62_LEN+1
#define OID_ANSI_X9_62_C_TWO_CURVE OID_ANSI_X9_62_ELL_CURVE, 0
#define OID_ANSI_X9_62_PRIME_CURVE OID_ANSI_X9_62_ELL_CURVE, 1
#define OID_ANSI_X9_62_SIG_TYPE OID_ANSI_X9_62, 4
#define OID_ANSI_X9_62_SIG_TYPE_LEN OID_ANSI_X9_62_LEN+1
/* PKIX */
#define OID_PKIX OID_DOD, 1, 5, 5, 7
#define OID_PKIX_LENGTH 6
#define OID_PE OID_PKIX, 1
#define OID_PE_LENGTH OID_PKIX_LENGTH + 1
#define OID_QT OID_PKIX, 2
#define OID_QT_LENGTH OID_PKIX_LENGTH + 1
#define OID_KP OID_PKIX, 3
#define OID_KP_LENGTH OID_PKIX_LENGTH + 1
#define OID_OTHER_NAME OID_PKIX, 8
#define OID_OTHER_NAME_LENGTH OID_PKIX_LENGTH + 1
#define OID_PDA OID_PKIX, 9
#define OID_PDA_LENGTH OID_PKIX_LENGTH + 1
#define OID_QCS OID_PKIX, 11
#define OID_QCS_LENGTH OID_PKIX_LENGTH + 1
#define OID_AD OID_PKIX, 48
#define OID_AD_LENGTH OID_PKIX_LENGTH + 1
#define OID_AD_OCSP OID_AD, 1
#define OID_AD_OCSP_LENGTH OID_AD_LENGTH + 1
/* ETSI */
#define OID_ETSI 0x04, 0x00
#define OID_ETSI_LENGTH 2
#define OID_ETSI_QCS 0x04, 0x00, 0x8E, 0x46, 0x01
#define OID_ETSI_QCS_LENGTH 5
#define OID_OIW_SECSIG OID_OIW, 3
#define OID_OIW_LENGTH 2
#define OID_OIW_SECSIG_LENGTH OID_OIW_LENGTH +1
#define OID_OIW_ALGORITHM OID_OIW_SECSIG, 2
#define OID_OIW_ALGORITHM_LENGTH OID_OIW_SECSIG_LENGTH +1
/* NIST defined digest algorithm arc (2, 16, 840, 1, 101, 3, 4, 2) */
#define OID_NIST_HASHALG 0x60, 0x86, 0x48, 0x01, 0x65, 0x03, 0x04, 0x02
#define OID_NIST_HASHALG_LENGTH 8
/* Kerberos PKINIT */
#define OID_KERBv5 0x2b, 6, 1, 5, 2
#define OID_KERBv5_LEN 5
#define OID_KERBv5_PKINIT OID_KERBv5, 3
#define OID_KERBv5_PKINIT_LEN OID_KERBv5_LEN + 1
/* Certicom (1 3 132) */
#define OID_CERTICOM 0x2B, 0x81, 0x04
#define OID_CERTICOM_LEN 3
#define OID_CERTICOM_ELL_CURVE OID_CERTICOM, 0
#define OID_CERTICOM_ELL_CURVE_LEN OID_CERTICOM_LEN+1
/*
* Apple-specific OID bases
*/
/*
* apple OBJECT IDENTIFIER ::=
* { iso(1) member-body(2) US(840) 113635 }
*
* BER = 06 06 2A 86 48 86 F7 63
*/
#define APPLE_OID OID_US, 0x86, 0xf7, 0x63
#define APPLE_OID_LENGTH OID_US_LENGTH + 3
/* appleDataSecurity OBJECT IDENTIFIER ::=
* { apple 100 }
* { 1 2 840 113635 100 }
*
* BER = 06 07 2A 86 48 86 F7 63 64
*/
#define APPLE_ADS_OID APPLE_OID, 0x64
#define APPLE_ADS_OID_LENGTH APPLE_OID_LENGTH + 1
/*
* appleTrustPolicy OBJECT IDENTIFIER ::=
* { appleDataSecurity 1 }
* { 1 2 840 113635 100 1 }
*
* BER = 06 08 2A 86 48 86 F7 63 64 01
*/
#define APPLE_TP_OID APPLE_ADS_OID, 1
#define APPLE_TP_OID_LENGTH APPLE_ADS_OID_LENGTH + 1
/*
* appleSecurityAlgorithm OBJECT IDENTIFIER ::=
* { appleDataSecurity 2 }
* { 1 2 840 113635 100 2 }
*
* BER = 06 08 2A 86 48 86 F7 63 64 02
*/
#define APPLE_ALG_OID APPLE_ADS_OID, 2
#define APPLE_ALG_OID_LENGTH APPLE_ADS_OID_LENGTH + 1
/*
* appleDotMacCertificate OBJECT IDENTIFIER ::=
* { appleDataSecurity 3 }
* { 1 2 840 113635 100 3 }
*/
#define APPLE_DOTMAC_CERT_OID APPLE_ADS_OID, 3
#define APPLE_DOTMAC_CERT_OID_LENGTH APPLE_ADS_OID_LENGTH + 1
/*
* Basis of Policy OIDs for .mac TP requests
*
* dotMacCertificateRequest OBJECT IDENTIFIER ::=
* { appleDotMacCertificate 1 }
* { 1 2 840 113635 100 3 1 }
*/
#define APPLE_DOTMAC_CERT_REQ_OID APPLE_DOTMAC_CERT_OID, 1
#define APPLE_DOTMAC_CERT_REQ_OID_LENGTH APPLE_DOTMAC_CERT_OID_LENGTH + 1
/*
* Basis of .mac Certificate Extensions
*
* dotMacCertificateExtension OBJECT IDENTIFIER ::=
* { appleDotMacCertificate 2 }
* { 1 2 840 113635 100 3 2 }
*/
#define APPLE_DOTMAC_CERT_EXTEN_OID APPLE_DOTMAC_CERT_OID, 2
#define APPLE_DOTMAC_CERT_EXTEN_OID_LENGTH APPLE_DOTMAC_CERT_OID_LENGTH + 1
/*
* Basis of .mac Certificate request OID/value identifiers
*
* dotMacCertificateRequestValues OBJECT IDENTIFIER ::=
* { appleDotMacCertificate 3 }
* { 1 2 840 113635 100 3 3 }
*/
#define APPLE_DOTMAC_CERT_REQ_VALUE_OID APPLE_DOTMAC_CERT_OID, 3
#define APPLE_DOTMAC_CERT_REQ_VALUE_OID_LENGTH APPLE_DOTMAC_CERT_OID_LENGTH + 1
/*
* Basis of Apple-specific extended key usages
*
* appleExtendedKeyUsage OBJECT IDENTIFIER ::=
* { appleDataSecurity 4 }
* { 1 2 840 113635 100 4 }
*/
#define APPLE_EKU_OID APPLE_ADS_OID, 4
#define APPLE_EKU_OID_LENGTH APPLE_ADS_OID_LENGTH + 1
/*
* Basis of Apple Code Signing extended key usages
* appleCodeSigning OBJECT IDENTIFIER ::=
* { appleExtendedKeyUsage 1 }
* { 1 2 840 113635 100 4 1 }
*/
#define APPLE_EKU_CODE_SIGNING APPLE_EKU_OID, 1
#define APPLE_EKU_CODE_SIGNING_LENGTH APPLE_EKU_OID_LENGTH + 1
/* -------------------------------------------------------------------------*/
/*
* Basis of Apple-specific Certificate Policy identifiers
* appleCertificatePolicies OBJECT IDENTIFIER ::=
* { appleDataSecurity 5 }
* { 1 2 840 113635 100 5 }
*/
#define APPLE_CERT_POLICIES APPLE_ADS_OID, 5
#define APPLE_CERT_POLICIES_LENGTH APPLE_ADS_OID_LENGTH + 1
/*
* Base for MacAppStore Certificate Policy identifiers
* macAppStoreCertificatePolicyIDs OBJECT IDENTIFIER ::=
* { appleCertificatePolicies 6 }
* { 1 2 840 113635 100 5 6 }
*/
#define APPLE_CERT_POLICIES_MACAPPSTORE APPLE_CERT_POLICIES, 6
#define APPLE_CERT_POLICIES_MACAPPSTORE_LENGTH APPLE_CERT_POLICIES_LENGTH + 1
/*
* MacAppStore receipt verification Certificate Policy identifier
* macAppStoreReceiptCertificatePolicyID OBJECT IDENTIFIER ::=
* { appleCertificatePolicies 6 1 }
* { 1 2 840 113635 100 5 6 1 }
*/
#define APPLE_CERT_POLICIES_MACAPPSTORE_RECEIPT APPLE_CERT_POLICIES_MACAPPSTORE, 1
#define APPLE_CERT_POLICIES_MACAPPSTORE_RECEIPT_LENGTH APPLE_CERT_POLICIES_MACAPPSTORE_LENGTH + 1
/*
* Base for AppleID Certificate Policy identifiers
* macAppStoreCertificatePolicyIDs OBJECT IDENTIFIER ::=
* { appleCertificatePolicies 7 }
* { 1 2 840 113635 100 5 7 }
*/
#define APPLE_CERT_POLICIES_APPLEID APPLE_CERT_POLICIES, 7
#define APPLE_CERT_POLICIES_APPLEID_LENGTH APPLE_CERT_POLICIES_LENGTH + 1
/*
* AppleID Sharing Certificate Policy identifier
* appleIDSharingPolicyID OBJECT IDENTIFIER ::=
* { appleCertificatePolicies 7 1 }
* { 1 2 840 113635 100 5 7 1 }
*/
#define APPLE_CERT_POLICIES_APPLEID_SHARING APPLE_CERT_POLICIES_APPLEID, 1
#define APPLE_CERT_POLICIES_APPLEID_SHARING_LENGTH APPLE_CERT_POLICIES_APPLEID_LENGTH + 1
/*
* Apple Mobile Store Signing Policy identifier
*
* appleDemoContentReleaseSigningID ::= { appleCertificatePolicies 12}
* { 1 2 840 113635 100 5 12 }
*/
#define APPLE_CERT_POLICIES_MOBILE_STORE_SIGNING APPLE_CERT_POLICIES, 12
#define APPLE_CERT_POLICIES_MOBILE_STORE_SIGNING_LENGTH APPLE_CERT_POLICIES_LENGTH + 1
/*
* Apple Test Mobile Store Signing Policy identifier
*
* appleDemoContentTestSigningID ::= { appleDemoContentReleaseSigningID 1}
* { 1 2 840 113635 100 5 12 1 }
*/
#define APPLE_CERT_POLICIES_TEST_MOBILE_STORE_SIGNING APPLE_CERT_POLICIES, 12, 1
#define APPLE_CERT_POLICIES_TEST_MOBILE_STORE_SIGNING_LENGTH APPLE_CERT_POLICIES_LENGTH + 2
/* -------------------------------------------------------------------------*/
/*
* Basis of Apple-specific certificate extensions
* appleCertificateExtensions OBJECT IDENTIFIER ::=
* { appleDataSecurity 6 }
* { 1 2 840 113635 100 6 }
*/
#define APPLE_EXTENSION_OID APPLE_ADS_OID, 6
#define APPLE_EXTENSION_OID_LENGTH APPLE_ADS_OID_LENGTH + 1
/*
* Basis of Apple-specific Code Signing certificate extensions
* appleCertificateExtensionCodeSigning OBJECT IDENTIFIER ::=
* { appleCertificateExtensions 1 }
* { 1 2 840 113635 100 6 1 }
*/
#define APPLE_EXTENSION_CODE_SIGNING APPLE_EXTENSION_OID, 1
#define APPLE_EXTENSION_CODE_SIGNING_LENGTH APPLE_EXTENSION_OID_LENGTH + 1
/*
* Basis of MacAppStore receipt verification certificate extensions
* macAppStoreReceiptExtension OBJECT IDENTIFIER ::=
* { appleCertificateExtensions 11 1 }
* { 1 2 840 113635 100 6 11 1 }
*/
#define APPLE_EXTENSION_MACAPPSTORE_RECEIPT APPLE_EXTENSION_OID, 11, 1
#define APPLE_EXTENSION_MACAPPSTORE_RECEIPT_LENGTH APPLE_EXTENSION_OID_LENGTH + 2
/*
* Basis of Apple-specific Intermediate Certificate extensions
* appleCertificateExtensionIntermediateMarker OBJECT IDENTIFIER ::=
* { appleCertificateExtensions 2 }
* { 1 2 840 113635 100 6 2 }
*/
#define APPLE_EXTENSION_INTERMEDIATE_MARKER APPLE_EXTENSION_OID, 2
#define APPLE_EXTENSION_INTERMEDIATE_MARKER_LENGTH APPLE_EXTENSION_OID_LENGTH + 1
/*
* Marker for the WWDR Intermediate Certificate
* appleCertificateExtensionWWDRIntermediate OBJECT IDENTIFIER ::=
* { appleCertificateExtensionIntermediateMarker 1 }
* { 1 2 840 113635 100 6 2 1 }
*/
#define APPLE_EXTENSION_WWDR_INTERMEDIATE APPLE_EXTENSION_INTERMEDIATE_MARKER, 1
#define APPLE_EXTENSION_WWDR_INTERMEDIATE_LENGTH APPLE_EXTENSION_INTERMEDIATE_MARKER_LENGTH + 1
/*
* Marker for the iTunes Store Intermediate Certificate
* appleCertificateExtensioniTunesStoreIntermediate OBJECT IDENTIFIER ::=
* { appleCertificateExtensionIntermediateMarker 2 }
* { 1 2 840 113635 100 6 2 2 }
*/
#define APPLE_EXTENSION_ITMS_INTERMEDIATE APPLE_EXTENSION_INTERMEDIATE_MARKER, 2
#define APPLE_EXTENSION_ITMS_INTERMEDIATE_LENGTH APPLE_EXTENSION_INTERMEDIATE_MARKER_LENGTH + 1
/*
* Marker for the Application Integration Intermediate Certificate
* appleCertificateExtensionApplicationIntegrationIntermediate OBJECT IDENTIFIER ::=
* { appleCertificateExtensionIntermediateMarker 3 }
* { 1 2 840 113635 100 6 2 3 }
*/
#define APPLE_EXTENSION_AAI_INTERMEDIATE APPLE_EXTENSION_INTERMEDIATE_MARKER, 3
#define APPLE_EXTENSION_AAI_INTERMEDIATE_LENGTH APPLE_EXTENSION_INTERMEDIATE_MARKER_LENGTH + 1
/*
* Apple Apple ID Intermediate Marker (New subCA, no longer shared with push notification server cert issuer
*
* appleCertificateExtensionAppleIDIntermediate ::=
* { appleCertificateExtensionIntermediateMarker 7 }
* { 1 2 840 113635 100 6 2 7 }
*
* shared intermediate OID is APPLE_CERT_EXT_INTERMEDIATE_MARKER_APPLEID
* Apple Apple ID Intermediate Marker
* Same as APPLE_CERT_EXT_INTERMEDIATE_MARKER_APPLEID_2 on iOS
*/
#define APPLE_EXTENSION_APPLEID_INTERMEDIATE APPLE_EXTENSION_INTERMEDIATE_MARKER, 7
#define APPLE_EXTENSION_APPLEID_INTERMEDIATE_LENGTH APPLE_EXTENSION_INTERMEDIATE_MARKER_LENGTH + 1
/*
* Apple System Integration 2 Intermediate Marker (New subCA)
*
* appleCertificateExtensionSystemIntegration2Intermediate ::=
* { appleCertificateExtensionIntermediateMarker 10 }
* { 1 2 840 113635 100 6 2 10 }
*/
#define APPLE_EXTENSION_SYSINT2_INTERMEDIATE APPLE_EXTENSION_INTERMEDIATE_MARKER, 10
#define APPLE_EXTENSION_SYSINT2_INTERMEDIATE_LENGTH APPLE_EXTENSION_INTERMEDIATE_MARKER_LENGTH + 1
/*
* Apple Developer Authentication Intermediate Marker (New subCA)
*
* appleCertificateExtensionDeveloperAuthentication ::=
* { appleCertificateExtensionIntermediateMarker 11 }
* { 1 2 840 113635 100 6 2 11 }
*/
#define APPLE_EXTENSION_DEVELOPER_AUTHENTICATION APPLE_EXTENSION_INTERMEDIATE_MARKER, 11
#define APPLE_EXTENSION_DEVELOPER_AUTHENTICATION_LENGTH APPLE_EXTENSION_INTERMEDIATE_MARKER_LENGTH + 1
/*
* Apple Server Authentication Intermediate Marker (New subCA)
*
* appleCertificateExtensionServerAuthentication ::=
* { appleCertificateExtensionIntermediateMarker 12 }
* { 1 2 840 113635 100 6 2 12 }
*/
#define APPLE_EXTENSION_SERVER_AUTHENTICATION APPLE_EXTENSION_INTERMEDIATE_MARKER, 12
#define APPLE_EXTENSION_SERVER_AUTHENTICATION_LENGTH APPLE_EXTENSION_INTERMEDIATE_MARKER_LENGTH + 1
/*
* Apple Secure Escrow Service Marker
*
* appleEscrowService ::= { appleCertificateExtensions 23 1 }
* { 1 2 840 113635 100 6 23 1 }
*/
#define APPLE_EXTENSION_ESCROW_SERVICE APPLE_EXTENSION_OID, 23, 1
#define APPLE_EXTENSION_ESCROW_SERVICE_LENGTH APPLE_EXTENSION_OID_LENGTH + 2
/*
* Apple OS X Provisioning Profile Signing Marker
* (note this is unfortunately under the EKU arc although it's used as a cert extension)
*/
#define APPLE_EXTENSION_PROVISIONING_PROFILE_SIGNING APPLE_EKU_OID, 11
#define APPLE_EXTENSION_PROVISIONING_PROFILE_SIGNING_LENGTH APPLE_EKU_OID_LENGTH + 1
/*
* Marker for the AppleID Sharing Certificate
* appleID OBJECT IDENTIFIER ::=
* { appleExtendedKeyUsage 7}
* { 1 2 840 113635 100 4 7 }
*/
#define APPLE_EXTENSION_APPLEID_SHARING APPLE_EKU_OID, 7
#define APPLE_EXTENSION_APPLEID_SHARING_LENGTH APPLE_EKU_OID_LENGTH + 1
/*
* Netscape OIDs.
*/
#define NETSCAPE_BASE_OID 0x60, 0x86, 0x48, 0x01, 0x86, 0xf8, 0x42
#define NETSCAPE_BASE_OID_LEN 7
/*
* Netscape cert extension.
*
* netscape-cert-extension OBJECT IDENTIFIER ::=
* { 2 16 840 1 113730 1 }
*
* BER = 06 08 60 86 48 01 86 F8 42 01
*/
#define NETSCAPE_CERT_EXTEN NETSCAPE_BASE_OID, 0x01
#define NETSCAPE_CERT_EXTEN_LENGTH NETSCAPE_BASE_OID_LEN + 1
#define NETSCAPE_CERT_POLICY NETSCAPE_BASE_OID, 0x04
#define NETSCAPE_CERT_POLICY_LENGTH NETSCAPE_BASE_OID_LEN + 1
/* Google OIDs: 1.3.6.1.4.1.11129. */
#define GOOGLE_BASE_OID OID_DOD, 0x01, 0x04, 0x01, 0xD6, 0x79
#define GOOGLE_BASE_OID_LEN OID_DOD_LEN + 5
#define GOOGLE_EMBEDDED_SCT_OID GOOGLE_BASE_OID, 0x02, 0x04, 0x02
#define GOOGLE_OCSP_SCT_OID GOOGLE_BASE_OID, 0x02, 0x04, 0x05
/*
* Domain Component OID
*/
#define OID_ITU_RFCDATA_2342 OID_ITU_RFCDATA, 0x49, 0x86
#define OID_ITU_RFCDATA_2342_LENGTH OID_ITU_RFCDATA_MEMBER_LENGTH + 2
#define OID_ITU_RFCDATA_2342_UCL OID_ITU_RFCDATA_2342, 0x49, 0x1F, 0x12, 0x8C
#define OID_ITU_RFCDATA_2342_UCL_LENGTH OID_ITU_RFCDATA_2342_LENGTH + 4
#define OID_ITU_RFCDATA_2342_UCL_DIRECTORYPILOT OID_ITU_RFCDATA_2342_UCL, 0xE4
#define OID_ITU_RFCDATA_2342_UCL_DIRECTORYPILOT_LENGTH OID_ITU_RFCDATA_2342_UCL_LENGTH + 1
#define OID_ITU_RFCDATA_2342_UCL_DIRECTORYPILOT_ATTRIBUTES OID_ITU_RFCDATA_2342_UCL_DIRECTORYPILOT, 0x81
#define OID_ITU_RFCDATA_2342_UCL_DIRECTORYPILOT_ATTRIBUTES_LENGTH OID_ITU_RFCDATA_2342_UCL_DIRECTORYPILOT_LENGTH + 1
#define OID_ITU_RFCDATA_2342_UCL_DIRECTORYPILOT_ATTRIBUTES_DOMAINCOMPONENT OID_ITU_RFCDATA_2342_UCL_DIRECTORYPILOT_ATTRIBUTES, 0x99
#define OID_ITU_RFCDATA_2342_UCL_DIRECTORYPILOT_ATTRIBUTES_DOMAINCOMPONENT_LENGTH OID_ITU_RFCDATA_2342_UCL_DIRECTORYPILOT_ATTRIBUTES_LENGTH + 1
#define OID_ITU_RFCDATA_2342_UCL_DIRECTORYPILOT_ATTRIBUTES_USERID OID_ITU_RFCDATA_2342_UCL_DIRECTORYPILOT_ATTRIBUTES, 0x81
#define OID_ITU_RFCDATA_2342_UCL_DIRECTORYPILOT_ATTRIBUTES_USERID_LENGTH OID_ITU_RFCDATA_2342_UCL_DIRECTORYPILOT_ATTRIBUTES_LENGTH + 1
#ifdef __cplusplus
}
#endif
#endif /* _OIDSBASE_H_ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Security.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Security.framework/Headers/SecProtocolMetadata.h | /*
* Copyright (c) 2018 Apple Inc. All Rights Reserved.
*
* @APPLE_LICENSE_HEADER_START@
*
* This file contains Original Code and/or Modifications of Original Code
* as defined in and that are subject to the Apple Public Source License
* Version 2.0 (the 'License'). You may not use this file except in
* compliance with the License. Please obtain a copy of the License at
* http://www.opensource.apple.com/apsl/ and read it before using this
* file.
*
* The Original Code and all software distributed under the License are
* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
* Please see the License for the specific language governing rights and
* limitations under the License.
*
* @APPLE_LICENSE_HEADER_END@
*/
#ifndef SecProtocolMetadata_h
#define SecProtocolMetadata_h
#include <Security/SecProtocolObject.h>
#include <Security/SecProtocolTypes.h>
#include <Security/SecProtocolOptions.h>
#include <dispatch/dispatch.h>
#include <os/object.h>
/*!
* The following diagram shows how clients interact with sec_protocol_options
* and sec_protocol_metadata when configuring and using network security protocols.
*
* +--------+
* | Client |
* +-+---/ \+
* | |
* +-------------+ +-------------+
* | (1) set (2) get |
* | options metadata |
* +-----\ /---------------+ +------------+----------+
* | sec_protocol_options | | sec_protocol_metadata |
* +-----------------------+ +-----------------------+
*
* Clients configure security protocols with `sec_protocol_options` instances.
* And they inspect protocol instances using `sec_protocol_metadata` instances.
*/
#ifndef SEC_OBJECT_IMPL
/*!
* A `sec_protocol_metadata` instance conatins read-only properties of a connected and configured
* security protocol. Clients use this object to read information about a protocol instance. Properties
* include, for example, the negotiated TLS version, ciphersuite, and peer certificates.
*/
SEC_OBJECT_DECL(sec_protocol_metadata);
#endif // !SEC_OBJECT_IMPL
__BEGIN_DECLS
SEC_ASSUME_NONNULL_BEGIN
/*!
* @function sec_protocol_metadata_get_negotiated_protocol
*
* @abstract
* Get the application protocol negotiated, e.g., via the TLS ALPN extension.
*
* @param metadata
* A `sec_protocol_metadata_t` instance.
*
* @return A NULL-terminated string carrying the negotiated protocol.
*/
API_AVAILABLE(macos(10.14), ios(12.0), watchos(5.0), tvos(12.0))
const char * _Nullable
sec_protocol_metadata_get_negotiated_protocol(sec_protocol_metadata_t metadata);
/*!
* @function sec_protocol_metadata_copy_peer_public_key
*
* @abstract
* Get the protocol instance peer's public key.
*
* @param metadata
* A `sec_protocol_metadata_t` instance.
*
* @return A `dispatch_data_t` containing the peer's raw public key.
*/
API_AVAILABLE(macos(10.14), ios(12.0), watchos(5.0), tvos(12.0))
SEC_RETURNS_RETAINED _Nullable dispatch_data_t
sec_protocol_metadata_copy_peer_public_key(sec_protocol_metadata_t metadata);
/*!
* @function sec_protocol_metadata_get_negotiated_tls_protocol_version
*
* @abstract
* Get the negotiated TLS version.
*
* @param metadata
* A `sec_protocol_metadata_t` instance.
*
* @return A `tls_protocol_version_t` value.
*/
API_AVAILABLE(macos(10.15), ios(13.0), watchos(6.0), tvos(13.0))
tls_protocol_version_t
sec_protocol_metadata_get_negotiated_tls_protocol_version(sec_protocol_metadata_t metadata);
/*!
* @function sec_protocol_metadata_get_negotiated_protocol_version
*
* @abstract
* Get the negotiated TLS version.
*
* @param metadata
* A `sec_protocol_metadata_t` instance.
*
* @return A SSLProtocol enum of the TLS version.
*/
API_DEPRECATED_WITH_REPLACEMENT("sec_protocol_metadata_get_negotiated_tls_protocol_version",
macos(10.14, 10.15), ios(12.0, 13.0), watchos(5.0, 6.0), tvos(12.0, 13.0))
SSLProtocol
sec_protocol_metadata_get_negotiated_protocol_version(sec_protocol_metadata_t metadata);
/*!
* @function sec_protocol_metadata_get_negotiated_tls_ciphersuite
*
* @abstract
* Get the negotiated TLS ciphersuite.
*
* @param metadata
* A `sec_protocol_metadata_t` instance.
*
* @return A `tls_ciphersuite_t`.
*/
API_AVAILABLE(macos(10.15), ios(13.0), watchos(6.0), tvos(13.0))
tls_ciphersuite_t
sec_protocol_metadata_get_negotiated_tls_ciphersuite(sec_protocol_metadata_t metadata);
/*!
* @function sec_protocol_metadata_get_negotiated_ciphersuite
*
* @abstract
* Get the negotiated TLS ciphersuite.
*
* @param metadata
* A `sec_protocol_metadata_t` instance.
*
* @return A SSLCipherSuite.
*/
API_DEPRECATED_WITH_REPLACEMENT("sec_protocol_metadata_get_negotiated_tls_ciphersuite",
macos(10.14, 10.15), ios(12.0, 13.0), watchos(5.0, 6.0), tvos(12.0, 13.0), macCatalyst(13.0, 13.0))
SSLCipherSuite
sec_protocol_metadata_get_negotiated_ciphersuite(sec_protocol_metadata_t metadata);
/*!
* @function sec_protocol_metadata_get_early_data_accepted
*
* @abstract
* Determine if early data was accepted by the peer.
*
* @param metadata
* A `sec_protocol_metadata_t` instance.
*
* @return A bool indicating if early data was accepted.
*/
API_AVAILABLE(macos(10.14), ios(12.0), watchos(5.0), tvos(12.0))
bool
sec_protocol_metadata_get_early_data_accepted(sec_protocol_metadata_t metadata);
#ifdef __BLOCKS__
/*!
* @function sec_protocol_metadata_access_peer_certificate_chain
*
* @abstract
* Get the certificate chain of the protocol instance peer.
*
* @param metadata
* A `sec_protocol_metadata_t` instance.
*
* @param handler
* A block to invoke one or more times with sec_certificate_t objects
*
* @return Returns true if the peer certificates were accessible, false otherwise.
*/
API_AVAILABLE(macos(10.14), ios(12.0), watchos(5.0), tvos(12.0))
bool
sec_protocol_metadata_access_peer_certificate_chain(sec_protocol_metadata_t metadata,
void (^handler)(sec_certificate_t certificate));
/*!
* @function sec_protocol_metadata_copy_ocsp_response
*
* @abstract
* Get the OCSP response from the protocol instance peer.
*
* @param metadata
* A `sec_protocol_metadata_t` instance.
*
* @param handler
* A block to invoke one or more times with OCSP data
*
* @return Returns true if the OSCP response was accessible, false otherwise.
*/
API_AVAILABLE(macos(10.14), ios(12.0), watchos(5.0), tvos(12.0))
bool
sec_protocol_metadata_access_ocsp_response(sec_protocol_metadata_t metadata,
void (^handler)(dispatch_data_t ocsp_data));
/*!
* @function sec_protocol_metadata_access_supported_signature_algorithms
*
* @abstract
* Get the signature algorithms supported by the peer. Clients may call this
* in response to a challenge block.
*
* @param metadata
* A `sec_protocol_metadata_t` instance.
*
* @param handler
* A block to invoke one or more times with OCSP data
*
* @return Returns true if the supported signature list was accessible, false otherwise.
*/
API_AVAILABLE(macos(10.14), ios(12.0), watchos(5.0), tvos(12.0))
bool
sec_protocol_metadata_access_supported_signature_algorithms(sec_protocol_metadata_t metadata,
void (^handler)(uint16_t signature_algorithm));
/*!
* @function sec_protocol_metadata_access_distinguished_names
*
* @abstract
* Get the X.509 Distinguished Names from the protocol instance peer.
*
* @param metadata
* A `sec_protocol_metadata_t` instance.
*
* @param handler
* A block to invoke one or more times with distinguished_name data
*
* @return Returns true if the distinguished names were accessible, false otherwise.
*/
API_AVAILABLE(macos(10.14), ios(12.0), watchos(5.0), tvos(12.0))
bool
sec_protocol_metadata_access_distinguished_names(sec_protocol_metadata_t metadata,
void (^handler)(dispatch_data_t distinguished_name));
/*!
* @function sec_protocol_metadata_access_pre_shared_keys
*
* @abstract
* Get the PSKs supported by the local instance.
*
* @param metadata
* A `sec_protocol_metadata_t` instance.
*
* @param handler
* A block to invoke one or more times with tuples of dispatch_data_t objects carrying PSKs and their corresponding identities.
*
* @return Returns true if the PSKs were accessible, false otherwise.
*/
API_AVAILABLE(macos(10.15), ios(13.0), watchos(6.0), tvos(13.0))
bool
sec_protocol_metadata_access_pre_shared_keys(sec_protocol_metadata_t metadata, void (^handler)(dispatch_data_t psk, dispatch_data_t psk_identity));
#endif // __BLOCKS__
/*!
* @function sec_protocol_metadata_get_server_name
*
* @abstract
* Obtain the server name offered by a client or server during
* connection establishmet. This is the value commonly carried
* in the TLS SNI extesion.
*
* @param metadata
* A `sec_protocol_metadata_t` instance.
*
* @return Returns A NULL-terminated string carrying the server name, or NULL
* if none was provided.
*/
API_AVAILABLE(macos(10.14), ios(12.0), watchos(5.0), tvos(12.0))
const char * _Nullable
sec_protocol_metadata_get_server_name(sec_protocol_metadata_t metadata);
/*!
* @function sec_protocol_metadata_peers_are_equal
*
* @abstract
* Compare peer information for two `sec_protocol_metadata` instances.
* This comparison does not include protocol configuration options, e.g., ciphersuites.
*
* @param metadataA
* A `sec_protocol_metadata_t` instance.
*
* @param metadataB
* A `sec_protocol_metadata_t` instance.
*
* @return Returns true if both metadata values refer to the same peer, and false otherwise.
*/
API_AVAILABLE(macos(10.14), ios(12.0), watchos(5.0), tvos(12.0))
bool
sec_protocol_metadata_peers_are_equal(sec_protocol_metadata_t metadataA, sec_protocol_metadata_t metadataB);
/*!
* @function sec_protocol_metadata_challenge_parameters_are_equal
*
* @abstract
* Compare challenge-relevant information for two `sec_protocol_metadata` instances.
*
* This comparison includes all information relevant to a challenge request, including:
* distinguished names, signature algorithms, and supported certificate types.
* See Section 7.4.4 of RFC5246 for more details.
*
* @param metadataA
* A `sec_protocol_metadata_t` instance.
*
* @param metadataB
* A `sec_protocol_metadata_t` instance.
*
* @return Returns true if both metadata values have the same challenge parameters.
*/
API_AVAILABLE(macos(10.14), ios(12.0), watchos(5.0), tvos(12.0))
bool
sec_protocol_metadata_challenge_parameters_are_equal(sec_protocol_metadata_t metadataA, sec_protocol_metadata_t metadataB);
/*!
* @function sec_protocol_metadata_create_secret
*
* @abstract
* Export a secret, e.g., a cryptographic key, derived from the protocol metadata using a label string.
*
* @param metadata
* A `sec_protocol_metadata_t` instance.
*
* @param label_len
* Length of the KDF label string.
*
* @param label
* KDF label string.
*
* @param exporter_length
* Length of the secret to be exported.
*
* @return Returns a dispatch_data_t object carrying the exported secret.
*/
API_AVAILABLE(macos(10.14), ios(12.0), watchos(5.0), tvos(12.0))
SEC_RETURNS_RETAINED _Nullable dispatch_data_t
sec_protocol_metadata_create_secret(sec_protocol_metadata_t metadata, size_t label_len,
const char *label, size_t exporter_length);
/*!
* @function sec_protocol_metadata_create_secret_with_context
*
* @abstract
* Export a secret, e.g., a cryptographic key, derived from the protocol metadata using a label and context string.
*
* @param metadata
* A `sec_protocol_metadata_t` instance.
*
* @param label_len
* Length of the KDF label string.
*
* @param label
* KDF label string.
*
* @param context_len
* Length of the KDF context string.
*
* @param context
* Constant opaque context value
*
* @param exporter_length
* Length of the secret to be exported.
*
* @return Returns a dispatch_data_t object carrying the exported secret.
*/
API_AVAILABLE(macos(10.14), ios(12.0), watchos(5.0), tvos(12.0))
SEC_RETURNS_RETAINED _Nullable dispatch_data_t
sec_protocol_metadata_create_secret_with_context(sec_protocol_metadata_t metadata, size_t label_len,
const char *label, size_t context_len,
const uint8_t *context, size_t exporter_length);
SEC_ASSUME_NONNULL_END
__END_DECLS
#endif // SecProtocolMetadata_h
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Security.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Security.framework/Headers/cssmtpi.h | /*
* Copyright (c) 1999-2001,2004,2011,2014 Apple Inc. All Rights Reserved.
*
* @APPLE_LICENSE_HEADER_START@
*
* This file contains Original Code and/or Modifications of Original Code
* as defined in and that are subject to the Apple Public Source License
* Version 2.0 (the 'License'). You may not use this file except in
* compliance with the License. Please obtain a copy of the License at
* http://www.opensource.apple.com/apsl/ and read it before using this
* file.
*
* The Original Code and all software distributed under the License are
* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
* Please see the License for the specific language governing rights and
* limitations under the License.
*
* @APPLE_LICENSE_HEADER_END@
*
* cssmtpi.h -- Service Provider Interface for Trust Policy Modules
*/
#ifndef _CSSMTPI_H_
#define _CSSMTPI_H_ 1
#include <Security/cssmtype.h>
#ifdef __cplusplus
extern "C" {
#endif
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdeprecated-declarations"
typedef struct DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER cssm_spi_tp_funcs {
CSSM_RETURN (CSSMTPI *SubmitCredRequest)
(CSSM_TP_HANDLE TPHandle,
const CSSM_TP_AUTHORITY_ID *PreferredAuthority,
CSSM_TP_AUTHORITY_REQUEST_TYPE RequestType,
const CSSM_TP_REQUEST_SET *RequestInput,
const CSSM_TP_CALLERAUTH_CONTEXT *CallerAuthContext,
sint32 *EstimatedTime,
CSSM_DATA_PTR ReferenceIdentifier);
CSSM_RETURN (CSSMTPI *RetrieveCredResult)
(CSSM_TP_HANDLE TPHandle,
const CSSM_DATA *ReferenceIdentifier,
const CSSM_TP_CALLERAUTH_CONTEXT *CallerAuthCredentials,
sint32 *EstimatedTime,
CSSM_BOOL *ConfirmationRequired,
CSSM_TP_RESULT_SET_PTR *RetrieveOutput);
CSSM_RETURN (CSSMTPI *ConfirmCredResult)
(CSSM_TP_HANDLE TPHandle,
const CSSM_DATA *ReferenceIdentifier,
const CSSM_TP_CALLERAUTH_CONTEXT *CallerAuthCredentials,
const CSSM_TP_CONFIRM_RESPONSE *Responses,
const CSSM_TP_AUTHORITY_ID *PreferredAuthority);
CSSM_RETURN (CSSMTPI *ReceiveConfirmation)
(CSSM_TP_HANDLE TPHandle,
const CSSM_DATA *ReferenceIdentifier,
CSSM_TP_CONFIRM_RESPONSE_PTR *Responses,
sint32 *ElapsedTime);
CSSM_RETURN (CSSMTPI *CertReclaimKey)
(CSSM_TP_HANDLE TPHandle,
const CSSM_CERTGROUP *CertGroup,
uint32 CertIndex,
CSSM_LONG_HANDLE KeyCacheHandle,
CSSM_CSP_HANDLE CSPHandle,
const CSSM_RESOURCE_CONTROL_CONTEXT *CredAndAclEntry);
CSSM_RETURN (CSSMTPI *CertReclaimAbort)
(CSSM_TP_HANDLE TPHandle,
CSSM_LONG_HANDLE KeyCacheHandle);
CSSM_RETURN (CSSMTPI *FormRequest)
(CSSM_TP_HANDLE TPHandle,
const CSSM_TP_AUTHORITY_ID *PreferredAuthority,
CSSM_TP_FORM_TYPE FormType,
CSSM_DATA_PTR BlankForm);
CSSM_RETURN (CSSMTPI *FormSubmit)
(CSSM_TP_HANDLE TPHandle,
CSSM_TP_FORM_TYPE FormType,
const CSSM_DATA *Form,
const CSSM_TP_AUTHORITY_ID *ClearanceAuthority,
const CSSM_TP_AUTHORITY_ID *RepresentedAuthority,
CSSM_ACCESS_CREDENTIALS_PTR Credentials);
CSSM_RETURN (CSSMTPI *CertGroupVerify)
(CSSM_TP_HANDLE TPHandle,
CSSM_CL_HANDLE CLHandle,
CSSM_CSP_HANDLE CSPHandle,
const CSSM_CERTGROUP *CertGroupToBeVerified,
const CSSM_TP_VERIFY_CONTEXT *VerifyContext,
CSSM_TP_VERIFY_CONTEXT_RESULT_PTR VerifyContextResult);
CSSM_RETURN (CSSMTPI *CertCreateTemplate)
(CSSM_TP_HANDLE TPHandle,
CSSM_CL_HANDLE CLHandle,
uint32 NumberOfFields,
const CSSM_FIELD *CertFields,
CSSM_DATA_PTR CertTemplate);
CSSM_RETURN (CSSMTPI *CertGetAllTemplateFields)
(CSSM_TP_HANDLE TPHandle,
CSSM_CL_HANDLE CLHandle,
const CSSM_DATA *CertTemplate,
uint32 *NumberOfFields,
CSSM_FIELD_PTR *CertFields);
CSSM_RETURN (CSSMTPI *CertSign)
(CSSM_TP_HANDLE TPHandle,
CSSM_CL_HANDLE CLHandle,
CSSM_CC_HANDLE CCHandle,
const CSSM_DATA *CertTemplateToBeSigned,
const CSSM_CERTGROUP *SignerCertGroup,
const CSSM_TP_VERIFY_CONTEXT *SignerVerifyContext,
CSSM_TP_VERIFY_CONTEXT_RESULT_PTR SignerVerifyResult,
CSSM_DATA_PTR SignedCert);
CSSM_RETURN (CSSMTPI *CrlVerify)
(CSSM_TP_HANDLE TPHandle,
CSSM_CL_HANDLE CLHandle,
CSSM_CSP_HANDLE CSPHandle,
const CSSM_ENCODED_CRL *CrlToBeVerified,
const CSSM_CERTGROUP *SignerCertGroup,
const CSSM_TP_VERIFY_CONTEXT *VerifyContext,
CSSM_TP_VERIFY_CONTEXT_RESULT_PTR RevokerVerifyResult);
CSSM_RETURN (CSSMTPI *CrlCreateTemplate)
(CSSM_TP_HANDLE TPHandle,
CSSM_CL_HANDLE CLHandle,
uint32 NumberOfFields,
const CSSM_FIELD *CrlFields,
CSSM_DATA_PTR NewCrlTemplate);
CSSM_RETURN (CSSMTPI *CertRevoke)
(CSSM_TP_HANDLE TPHandle,
CSSM_CL_HANDLE CLHandle,
CSSM_CSP_HANDLE CSPHandle,
const CSSM_DATA *OldCrlTemplate,
const CSSM_CERTGROUP *CertGroupToBeRevoked,
const CSSM_CERTGROUP *RevokerCertGroup,
const CSSM_TP_VERIFY_CONTEXT *RevokerVerifyContext,
CSSM_TP_VERIFY_CONTEXT_RESULT_PTR RevokerVerifyResult,
CSSM_TP_CERTCHANGE_REASON Reason,
CSSM_DATA_PTR NewCrlTemplate);
CSSM_RETURN (CSSMTPI *CertRemoveFromCrlTemplate)
(CSSM_TP_HANDLE TPHandle,
CSSM_CL_HANDLE CLHandle,
CSSM_CSP_HANDLE CSPHandle,
const CSSM_DATA *OldCrlTemplate,
const CSSM_CERTGROUP *CertGroupToBeRemoved,
const CSSM_CERTGROUP *RevokerCertGroup,
const CSSM_TP_VERIFY_CONTEXT *RevokerVerifyContext,
CSSM_TP_VERIFY_CONTEXT_RESULT_PTR RevokerVerifyResult,
CSSM_DATA_PTR NewCrlTemplate);
CSSM_RETURN (CSSMTPI *CrlSign)
(CSSM_TP_HANDLE TPHandle,
CSSM_CL_HANDLE CLHandle,
CSSM_CC_HANDLE CCHandle,
const CSSM_ENCODED_CRL *CrlToBeSigned,
const CSSM_CERTGROUP *SignerCertGroup,
const CSSM_TP_VERIFY_CONTEXT *SignerVerifyContext,
CSSM_TP_VERIFY_CONTEXT_RESULT_PTR SignerVerifyResult,
CSSM_DATA_PTR SignedCrl);
CSSM_RETURN (CSSMTPI *ApplyCrlToDb)
(CSSM_TP_HANDLE TPHandle,
CSSM_CL_HANDLE CLHandle,
CSSM_CSP_HANDLE CSPHandle,
const CSSM_ENCODED_CRL *CrlToBeApplied,
const CSSM_CERTGROUP *SignerCertGroup,
const CSSM_TP_VERIFY_CONTEXT *ApplyCrlVerifyContext,
CSSM_TP_VERIFY_CONTEXT_RESULT_PTR ApplyCrlVerifyResult);
CSSM_RETURN (CSSMTPI *CertGroupConstruct)
(CSSM_TP_HANDLE TPHandle,
CSSM_CL_HANDLE CLHandle,
CSSM_CSP_HANDLE CSPHandle,
const CSSM_DL_DB_LIST *DBList,
const void *ConstructParams,
const CSSM_CERTGROUP *CertGroupFrag,
CSSM_CERTGROUP_PTR *CertGroup);
CSSM_RETURN (CSSMTPI *CertGroupPrune)
(CSSM_TP_HANDLE TPHandle,
CSSM_CL_HANDLE CLHandle,
const CSSM_DL_DB_LIST *DBList,
const CSSM_CERTGROUP *OrderedCertGroup,
CSSM_CERTGROUP_PTR *PrunedCertGroup);
CSSM_RETURN (CSSMTPI *CertGroupToTupleGroup)
(CSSM_TP_HANDLE TPHandle,
CSSM_CL_HANDLE CLHandle,
const CSSM_CERTGROUP *CertGroup,
CSSM_TUPLEGROUP_PTR *TupleGroup);
CSSM_RETURN (CSSMTPI *TupleGroupToCertGroup)
(CSSM_TP_HANDLE TPHandle,
CSSM_CL_HANDLE CLHandle,
const CSSM_TUPLEGROUP *TupleGroup,
CSSM_CERTGROUP_PTR *CertTemplates);
CSSM_RETURN (CSSMTPI *PassThrough)
(CSSM_TP_HANDLE TPHandle,
CSSM_CL_HANDLE CLHandle,
CSSM_CC_HANDLE CCHandle,
const CSSM_DL_DB_LIST *DBList,
uint32 PassThroughId,
const void *InputParams,
void **OutputParams);
} CSSM_SPI_TP_FUNCS DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER, *CSSM_SPI_TP_FUNCS_PTR DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER;
#pragma clang diagnostic pop
#ifdef __cplusplus
}
#endif
#endif /* _CSSMTPI_H_ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Security.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Security.framework/Headers/oidsattr.h | /*
* Copyright (c) 1999-2001,2003-2004,2008,2010,2012 Apple Inc. All Rights Reserved.
*
* @APPLE_LICENSE_HEADER_START@
*
* This file contains Original Code and/or Modifications of Original Code
* as defined in and that are subject to the Apple Public Source License
* Version 2.0 (the 'License'). You may not use this file except in
* compliance with the License. Please obtain a copy of the License at
* http://www.opensource.apple.com/apsl/ and read it before using this
* file.
*
* The Original Code and all software distributed under the License are
* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
* Please see the License for the specific language governing rights and
* limitations under the License.
*
* @APPLE_LICENSE_HEADER_END@
*
* oidsattr.h -- Cert/CRL related OIDs.
*/
#include <Security/SecAsn1Types.h>
#include <Security/oidsbase.h>
#ifndef _CDSA_OIDSATTR_H_
#define _CDSA_OIDSATTR_H_
/*
* Directory name component identifiers.
*/
extern const SecAsn1Oid
CSSMOID_ObjectClass DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_AliasedEntryName DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_KnowledgeInformation DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_CommonName DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_Surname DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_SerialNumber DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_CountryName DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_LocalityName DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_StateProvinceName DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_CollectiveStateProvinceName DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_StreetAddress DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_CollectiveStreetAddress DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_OrganizationName DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_CollectiveOrganizationName DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_OrganizationalUnitName DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_CollectiveOrganizationalUnitName DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_Title DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_Description DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_SearchGuide DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_BusinessCategory DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_PostalAddress DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_CollectivePostalAddress DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_PostalCode DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_CollectivePostalCode DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_PostOfficeBox DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_CollectivePostOfficeBox DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_PhysicalDeliveryOfficeName DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_CollectivePhysicalDeliveryOfficeName DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_TelephoneNumber DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_CollectiveTelephoneNumber DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_TelexNumber DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_CollectiveTelexNumber DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_TelexTerminalIdentifier DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_CollectiveTelexTerminalIdentifier DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_FacsimileTelephoneNumber DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_CollectiveFacsimileTelephoneNumber DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_X_121Address DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_InternationalISDNNumber DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_CollectiveInternationalISDNNumber DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_RegisteredAddress DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_DestinationIndicator DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_PreferredDeliveryMethod DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_PresentationAddress DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_SupportedApplicationContext DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_Member DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_Owner DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_RoleOccupant DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_SeeAlso DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_UserPassword DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_UserCertificate DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_CACertificate DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_AuthorityRevocationList DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_CertificateRevocationList DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_CrossCertificatePair DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_Name DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_GivenName DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_Initials DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_GenerationQualifier DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_UniqueIdentifier DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_DNQualifier DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_EnhancedSearchGuide DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_ProtocolInformation DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_DistinguishedName DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_UniqueMember DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_HouseIdentifier DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER;
/* PKCS 9 */
extern const SecAsn1Oid
CSSMOID_EmailAddress DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_UnstructuredName DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_ContentType DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_MessageDigest DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_SigningTime DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_CounterSignature DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_ChallengePassword DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_UnstructuredAddress DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_ExtendedCertificateAttributes DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER;
extern const SecAsn1Oid
CSSMOID_PKCS9_Id_Ct_TSTInfo DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_PKCS9_TimeStampToken DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER;
/* PKIX */
extern const SecAsn1Oid
CSSMOID_QT_CPS DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_QT_UNOTICE DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_AD_OCSP DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_AD_CA_ISSUERS DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_AD_TIME_STAMPING DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_AD_CA_REPOSITORY DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_PDA_DATE_OF_BIRTH DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_PDA_PLACE_OF_BIRTH DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_PDA_GENDER DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_PDA_COUNTRY_CITIZEN DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_PDA_COUNTRY_RESIDENCE DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_OID_QCS_SYNTAX_V1 DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_OID_QCS_SYNTAX_V2 DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER;
/* ETSI */
extern const SecAsn1Oid
CSSMOID_ETSI_QCS_QC_COMPLIANCE DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_ETSI_QCS_QC_LIMIT_VALUE DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_ETSI_QCS_QC_RETENTION DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_ETSI_QCS_QC_SSCD DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER;
/* PKCS7 */
extern const SecAsn1Oid
CSSMOID_PKCS7_Data DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_PKCS7_SignedData DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_PKCS7_EnvelopedData DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_PKCS7_SignedAndEnvelopedData DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_PKCS7_DigestedData DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_PKCS7_EncryptedData DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_PKCS7_DataWithAttributes DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_PKCS7_EncryptedPrivateKeyInfo DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
/* PKCS8 */
CSSMOID_PKCS9_FriendlyName DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_PKCS9_LocalKeyId DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_PKCS9_CertTypes DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_PKCS9_CrlTypes DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_PKCS9_X509Certificate DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_PKCS9_SdsiCertificate DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_PKCS9_X509Crl DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
/* PKCS12 */
CSSMOID_PKCS12_keyBag DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_PKCS12_shroudedKeyBag DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_PKCS12_certBag DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_PKCS12_crlBag DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_PKCS12_secretBag DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_PKCS12_safeContentsBag DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
/* RFC 2798 (LDAP) */
CSSMOID_UserID DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
/* RFC 1275 (X.500) */
CSSMOID_DomainComponent DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
/* Kerberos PKINIT CMS ContentInfo types */
CSSMOID_KERBv5_PKINIT_AUTH_DATA DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_KERBv5_PKINIT_DH_KEY_DATA DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_KERBv5_PKINIT_RKEY_DATA DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER;
/* Elliptic Curve OIDs from X9.62 and Certicom SEC 2 */
extern const SecAsn1Oid
CSSMOID_X9_62 DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_X9_62_FieldType DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_X9_62_PubKeyType DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_X9_62_EllCurve DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_X9_62_C_TwoCurve DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_X9_62_PrimeCurve DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_X9_62_SigType DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_secp192r1 DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_secp256r1 DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_Certicom DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_CerticomEllCurve DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_secp112r1 DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_secp112r2 DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_secp128r1 DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_secp128r2 DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_secp160k1 DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_secp160r1 DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_secp160r2 DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_secp192k1 DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_secp224k1 DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_secp224r1 DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_secp256k1 DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_secp384r1 DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_secp521r1 DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_sect113r1 DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_sect113r2 DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_sect131r1 DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_sect131r2 DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_sect163k1 DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_sect163r1 DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_sect163r2 DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_sect193r1 DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_sect193r2 DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_sect233k1 DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_sect233r1 DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_sect239k1 DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_sect283k1 DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_sect283r1 DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_sect409k1 DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_sect409r1 DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_sect571k1 DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER,
CSSMOID_sect571r1 DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER;
#endif /* _CDSA_OIDSATTR_H_*/
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Security.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Security.framework/Headers/cssmkrspi.h | /*
* Copyright (c) 1999-2001,2004,2011,2014 Apple Inc. All Rights Reserved.
*
* @APPLE_LICENSE_HEADER_START@
*
* This file contains Original Code and/or Modifications of Original Code
* as defined in and that are subject to the Apple Public Source License
* Version 2.0 (the 'License'). You may not use this file except in
* compliance with the License. Please obtain a copy of the License at
* http://www.opensource.apple.com/apsl/ and read it before using this
* file.
*
* The Original Code and all software distributed under the License are
* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
* Please see the License for the specific language governing rights and
* limitations under the License.
*
* @APPLE_LICENSE_HEADER_END@
*
* cssmkrspi.h -- Service Provider Interface for Key Recovery Modules
*/
#ifndef _CSSMKRSPI_H_
#define _CSSMKRSPI_H_ 1
#include <Security/cssmtype.h>
#include <Security/cssmkrapi.h> /* CSSM_KRSP_HANDLE */
#ifdef __cplusplus
extern "C" {
#endif
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdeprecated-declarations"
/* Data types for Key Recovery SPI */
typedef struct DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER cssm_spi_kr_funcs {
CSSM_RETURN (CSSMKRI *RegistrationRequest)
(CSSM_KRSP_HANDLE KRSPHandle,
CSSM_CC_HANDLE KRRegistrationContextHandle,
const CSSM_CONTEXT *KRRegistrationContext,
const CSSM_DATA *KRInData,
const CSSM_ACCESS_CREDENTIALS *AccessCredentials,
CSSM_KR_POLICY_FLAGS KRFlags,
sint32 *EstimatedTime,
CSSM_HANDLE_PTR ReferenceHandle);
CSSM_RETURN (CSSMKRI *RegistrationRetrieve)
(CSSM_KRSP_HANDLE KRSPHandle,
CSSM_HANDLE ReferenceHandle,
sint32 *EstimatedTime,
CSSM_KR_PROFILE_PTR KRProfile);
CSSM_RETURN (CSSMKRI *GenerateRecoveryFields)
(CSSM_KRSP_HANDLE KRSPHandle,
CSSM_CC_HANDLE KREnablementContextHandle,
const CSSM_CONTEXT *KREnablementContext,
CSSM_CC_HANDLE CryptoContextHandle,
const CSSM_CONTEXT *CryptoContext,
const CSSM_DATA *KRSPOptions,
CSSM_KR_POLICY_FLAGS KRFlags,
CSSM_DATA_PTR KRFields);
CSSM_RETURN (CSSMKRI *ProcessRecoveryFields)
(CSSM_KRSP_HANDLE KRSPHandle,
CSSM_CC_HANDLE KREnablementContextHandle,
const CSSM_CONTEXT *KREnablementContext,
CSSM_CC_HANDLE CryptoContextHandle,
const CSSM_CONTEXT *CryptoContext,
const CSSM_DATA *KRSPOptions,
CSSM_KR_POLICY_FLAGS KRFlags,
const CSSM_DATA *KRFields);
CSSM_RETURN (CSSMKRI *RecoveryRequest)
(CSSM_KRSP_HANDLE KRSPHandle,
CSSM_CC_HANDLE KRRequestContextHandle,
const CSSM_CONTEXT *KRRequestContext,
const CSSM_DATA *KRInData,
const CSSM_ACCESS_CREDENTIALS *AccessCredentials,
sint32 *EstimatedTime,
CSSM_HANDLE_PTR ReferenceHandle);
CSSM_RETURN (CSSMKRI *RecoveryRetrieve)
(CSSM_KRSP_HANDLE KRSPHandle,
CSSM_HANDLE ReferenceHandle,
sint32 *EstimatedTime,
CSSM_HANDLE_PTR CacheHandle,
uint32 *NumberOfRecoveredKeys);
CSSM_RETURN (CSSMKRI *GetRecoveredObject)
(CSSM_KRSP_HANDLE KRSPHandle,
CSSM_HANDLE CacheHandle,
uint32 IndexInResults,
CSSM_CSP_HANDLE CSPHandle,
const CSSM_RESOURCE_CONTROL_CONTEXT *CredAndAclEntry,
uint32 Flags,
CSSM_KEY_PTR RecoveredKey,
CSSM_DATA_PTR OtherInfo);
CSSM_RETURN (CSSMKRI *RecoveryRequestAbort)
(CSSM_KRSP_HANDLE KRSPHandle,
CSSM_HANDLE ResultsHandle);
CSSM_RETURN (CSSMKRI *PassThrough)
(CSSM_KRSP_HANDLE KRSPHandle,
CSSM_CC_HANDLE KeyRecoveryContextHandle,
const CSSM_CONTEXT *KeyRecoveryContext,
CSSM_CC_HANDLE CryptoContextHandle,
const CSSM_CONTEXT *CryptoContext,
uint32 PassThroughId,
const void *InputParams,
void **OutputParams);
} CSSM_SPI_KR_FUNCS DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER, *CSSM_SPI_KR_FUNCS_PTR DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER;
#pragma clang diagnostic pop
#ifdef __cplusplus
}
#endif
#endif /* _CSSMKRSPI_H_ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Security.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Security.framework/Headers/SecProtocolTypes.h | /*
* Copyright (c) 2018 Apple Inc. All Rights Reserved.
*
* @APPLE_LICENSE_HEADER_START@
*
* This file contains Original Code and/or Modifications of Original Code
* as defined in and that are subject to the Apple Public Source License
* Version 2.0 (the 'License'). You may not use this file except in
* compliance with the License. Please obtain a copy of the License at
* http://www.opensource.apple.com/apsl/ and read it before using this
* file.
*
* The Original Code and all software distributed under the License are
* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
* Please see the License for the specific language governing rights and
* limitations under the License.
*
* @APPLE_LICENSE_HEADER_END@
*/
#ifndef SecProtocolTypes_h
#define SecProtocolTypes_h
#include <Security/SecProtocolObject.h>
#include <Security/SecTrust.h>
#include <Security/SecCertificate.h>
#include <Security/SecIdentity.h>
#include <Security/CipherSuite.h>
#include <Security/SecBase.h>
#ifndef SEC_OBJECT_IMPL
/*!
* These are os_object compatible and ARC-able wrappers around existing CoreFoundation
* Security types, including: SecTrustRef, SecIdentityRef, and SecCertificateRef. They allow
* clients to use these types in os_object-type APIs and data structures. The underlying
* CoreFoundation types may be extracted and used by clients as needed.
*/
SEC_OBJECT_DECL(sec_trust);
SEC_OBJECT_DECL(sec_identity);
SEC_OBJECT_DECL(sec_certificate);
#endif // !SEC_OBJECT_IMPL
/*!
* @enum tls_protocol_version_t enumeration
* @abstract Enumerations for the set of supported TLS and DTLS protocol versions.
*
* @constant tls_protocol_version_TLSv10 TLS 1.0 [https://tools.ietf.org/html/rfc4346]
* @constant tls_protocol_version_TLSv11 TLS 1.1 [https://tools.ietf.org/html/rfc2246]
* @constant tls_protocol_version_TLSv12 TLS 1.2 [https://tools.ietf.org/html/rfc5246]
* @constant tls_protocol_version_TLSv13 TLS 1.3 [https://tools.ietf.org/html/rfc8446]
* @constant tls_protocol_version_DTLSv10 DTLS 1.0 [https://tools.ietf.org/html/rfc4347]
* @constant tls_protocol_version_DTLSv12 DTLS 1.2 [https://tools.ietf.org/html/rfc6347]
*/
typedef CF_ENUM(uint16_t, tls_protocol_version_t) {
tls_protocol_version_TLSv10 CF_SWIFT_NAME(TLSv10) = 0x0301,
tls_protocol_version_TLSv11 CF_SWIFT_NAME(TLSv11) = 0x0302,
tls_protocol_version_TLSv12 CF_SWIFT_NAME(TLSv12) = 0x0303,
tls_protocol_version_TLSv13 CF_SWIFT_NAME(TLSv13) = 0x0304,
tls_protocol_version_DTLSv10 CF_SWIFT_NAME(DTLSv10) = 0xfeff,
tls_protocol_version_DTLSv12 CF_SWIFT_NAME(DTLSv12) = 0xfefd,
};
/*!
* @enum tls_ciphersuite_t enumeration
* @abstract Enumerations for the set of supported TLS and DTLS ciphersuites.
*
* See https://www.iana.org/assignments/tls-parameters/tls-parameters.xhtml#tls-parameters-4
* for ciphersuite codepoint allocations and reference RFCs.
*
* @constant tls_ciphersuite_RSA_WITH_3DES_EDE_CBC_SHA
* @constant tls_ciphersuite_RSA_WITH_AES_128_CBC_SHA
* @constant tls_ciphersuite_RSA_WITH_AES_256_CBC_SHA
* @constant tls_ciphersuite_RSA_WITH_AES_128_GCM_SHA256
* @constant tls_ciphersuite_RSA_WITH_AES_256_GCM_SHA384
* @constant tls_ciphersuite_RSA_WITH_AES_128_CBC_SHA256
* @constant tls_ciphersuite_RSA_WITH_AES_256_CBC_SHA256
* @constant tls_ciphersuite_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA
* @constant tls_ciphersuite_ECDHE_ECDSA_WITH_AES_128_CBC_SHA
* @constant tls_ciphersuite_ECDHE_ECDSA_WITH_AES_256_CBC_SHA
* @constant tls_ciphersuite_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA
* @constant tls_ciphersuite_ECDHE_RSA_WITH_AES_128_CBC_SHA
* @constant tls_ciphersuite_ECDHE_RSA_WITH_AES_256_CBC_SHA
* @constant tls_ciphersuite_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256
* @constant tls_ciphersuite_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384
* @constant tls_ciphersuite_ECDHE_RSA_WITH_AES_128_CBC_SHA256
* @constant tls_ciphersuite_ECDHE_RSA_WITH_AES_256_CBC_SHA384
* @constant tls_ciphersuite_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256
* @constant tls_ciphersuite_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384
* @constant tls_ciphersuite_ECDHE_RSA_WITH_AES_128_GCM_SHA256
* @constant tls_ciphersuite_ECDHE_RSA_WITH_AES_256_GCM_SHA384
* @constant tls_ciphersuite_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256
* @constant tls_ciphersuite_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256
* @constant tls_ciphersuite_AES_128_GCM_SHA256
* @constant tls_ciphersuite_AES_256_GCM_SHA384
* @constant tls_ciphersuite_CHACHA20_POLY1305_SHA256
*/
typedef CF_ENUM(uint16_t, tls_ciphersuite_t) {
tls_ciphersuite_RSA_WITH_3DES_EDE_CBC_SHA CF_SWIFT_NAME(RSA_WITH_3DES_EDE_CBC_SHA) = 0x000A,
tls_ciphersuite_RSA_WITH_AES_128_CBC_SHA CF_SWIFT_NAME(RSA_WITH_AES_128_CBC_SHA) = 0x002F,
tls_ciphersuite_RSA_WITH_AES_256_CBC_SHA CF_SWIFT_NAME(RSA_WITH_AES_256_CBC_SHA) = 0x0035,
tls_ciphersuite_RSA_WITH_AES_128_GCM_SHA256 CF_SWIFT_NAME(RSA_WITH_AES_128_GCM_SHA256) = 0x009C,
tls_ciphersuite_RSA_WITH_AES_256_GCM_SHA384 CF_SWIFT_NAME(RSA_WITH_AES_256_GCM_SHA384) = 0x009D,
tls_ciphersuite_RSA_WITH_AES_128_CBC_SHA256 CF_SWIFT_NAME(RSA_WITH_AES_128_CBC_SHA256) = 0x003C,
tls_ciphersuite_RSA_WITH_AES_256_CBC_SHA256 CF_SWIFT_NAME(RSA_WITH_AES_256_CBC_SHA256) = 0x003D,
tls_ciphersuite_ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA CF_SWIFT_NAME(ECDHE_ECDSA_WITH_3DES_EDE_CBC_SHA) = 0xC008,
tls_ciphersuite_ECDHE_ECDSA_WITH_AES_128_CBC_SHA CF_SWIFT_NAME(ECDHE_ECDSA_WITH_AES_128_CBC_SHA) = 0xC009,
tls_ciphersuite_ECDHE_ECDSA_WITH_AES_256_CBC_SHA CF_SWIFT_NAME(ECDHE_ECDSA_WITH_AES_256_CBC_SHA) = 0xC00A,
tls_ciphersuite_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA CF_SWIFT_NAME(ECDHE_RSA_WITH_3DES_EDE_CBC_SHA) = 0xC012,
tls_ciphersuite_ECDHE_RSA_WITH_AES_128_CBC_SHA CF_SWIFT_NAME(ECDHE_RSA_WITH_AES_128_CBC_SHA) = 0xC013,
tls_ciphersuite_ECDHE_RSA_WITH_AES_256_CBC_SHA CF_SWIFT_NAME(ECDHE_RSA_WITH_AES_256_CBC_SHA) = 0xC014,
tls_ciphersuite_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256 CF_SWIFT_NAME(ECDHE_ECDSA_WITH_AES_128_CBC_SHA256) = 0xC023,
tls_ciphersuite_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384 CF_SWIFT_NAME(ECDHE_ECDSA_WITH_AES_256_CBC_SHA384) = 0xC024,
tls_ciphersuite_ECDHE_RSA_WITH_AES_128_CBC_SHA256 CF_SWIFT_NAME(ECDHE_RSA_WITH_AES_128_CBC_SHA256) = 0xC027,
tls_ciphersuite_ECDHE_RSA_WITH_AES_256_CBC_SHA384 CF_SWIFT_NAME(ECDHE_RSA_WITH_AES_256_CBC_SHA384) = 0xC028,
tls_ciphersuite_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256 CF_SWIFT_NAME(ECDHE_ECDSA_WITH_AES_128_GCM_SHA256) = 0xC02B,
tls_ciphersuite_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384 CF_SWIFT_NAME(ECDHE_ECDSA_WITH_AES_256_GCM_SHA384) = 0xC02C,
tls_ciphersuite_ECDHE_RSA_WITH_AES_128_GCM_SHA256 CF_SWIFT_NAME(ECDHE_RSA_WITH_AES_128_GCM_SHA256) = 0xC02F,
tls_ciphersuite_ECDHE_RSA_WITH_AES_256_GCM_SHA384 CF_SWIFT_NAME(ECDHE_RSA_WITH_AES_256_GCM_SHA384) = 0xC030,
tls_ciphersuite_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 CF_SWIFT_NAME(ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256) = 0xCCA8,
tls_ciphersuite_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256 CF_SWIFT_NAME(ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256) = 0xCCA9,
tls_ciphersuite_AES_128_GCM_SHA256 CF_SWIFT_NAME(AES_128_GCM_SHA256) = 0x1301,
tls_ciphersuite_AES_256_GCM_SHA384 CF_SWIFT_NAME(AES_256_GCM_SHA384) = 0x1302,
tls_ciphersuite_CHACHA20_POLY1305_SHA256 CF_SWIFT_NAME(CHACHA20_POLY1305_SHA256) = 0x1303,
};
/*!
* @enum tls_ciphersuite_group_t enumeration
* @abstract Convenience ciphersuite groups that collate ciphersuites of comparable security
* properties into a single alias.
*
* @constant tls_ciphersuite_group_default
* @constant tls_ciphersuite_group_compatibility
* @constant tls_ciphersuite_group_legacy
* @constant tls_ciphersuite_group_ats
* @constant tls_ciphersuite_group_ats_compatibility
*/
typedef CF_ENUM(uint16_t, tls_ciphersuite_group_t) {
tls_ciphersuite_group_default,
tls_ciphersuite_group_compatibility,
tls_ciphersuite_group_legacy,
tls_ciphersuite_group_ats,
tls_ciphersuite_group_ats_compatibility,
};
/*!
* @enum SSLProtocol enumeration
* @abstract Enumerations for the set of supported TLS and DTLS protocol versions.
*
* @note This enumeration is deprecated. Use `tls_protocol_version_t` instead.
*/
typedef CF_ENUM(int, SSLProtocol) {
kSSLProtocolUnknown CF_ENUM_DEPRECATED(10_2, 10_15, 5_0, 13_0) = 0,
kTLSProtocol1 CF_ENUM_DEPRECATED(10_2, 10_15, 5_0, 13_0) = 4,
kTLSProtocol11 CF_ENUM_DEPRECATED(10_2, 10_15, 5_0, 13_0) = 7,
kTLSProtocol12 CF_ENUM_DEPRECATED(10_2, 10_15, 5_0, 13_0) = 8,
kDTLSProtocol1 CF_ENUM_DEPRECATED(10_2, 10_15, 5_0, 13_0) = 9,
kTLSProtocol13 CF_ENUM_DEPRECATED(10_2, 10_15, 5_0, 13_0) = 10,
kDTLSProtocol12 CF_ENUM_DEPRECATED(10_2, 10_15, 5_0, 13_0) = 11,
kTLSProtocolMaxSupported CF_ENUM_DEPRECATED(10_2, 10_15, 5_0, 13_0) = 999,
kSSLProtocol2 CF_ENUM_DEPRECATED(10_2, 10_15, 5_0, 13_0) = 1,
kSSLProtocol3 CF_ENUM_DEPRECATED(10_2, 10_15, 5_0, 13_0) = 2,
kSSLProtocol3Only CF_ENUM_DEPRECATED(10_2, 10_15, 5_0, 13_0) = 3,
kTLSProtocol1Only CF_ENUM_DEPRECATED(10_2, 10_15, 5_0, 13_0) = 5,
kSSLProtocolAll CF_ENUM_DEPRECATED(10_2, 10_15, 5_0, 13_0) = 6,
};
__BEGIN_DECLS
SEC_ASSUME_NONNULL_BEGIN
/*!
* @function sec_trust_create
*
* @abstract
* Create an ARC-able `sec_trust_t` instance from a `SecTrustRef`.
*
* @param trust
* A `SecTrustRef` instance.
*
* @return a `sec_trust_t` instance.
*/
API_AVAILABLE(macos(10.14), ios(12.0), watchos(5.0), tvos(12.0))
SEC_RETURNS_RETAINED _Nullable sec_trust_t
sec_trust_create(SecTrustRef trust);
/*!
* @function sec_trust_copy_ref
*
* @abstract
* Copy a retained reference to the underlying `SecTrustRef` instance.
*
* @param trust
* A `sec_trust_t` instance.
*
* @return The underlying `SecTrustRef` instance.
*/
API_AVAILABLE(macos(10.14), ios(12.0), watchos(5.0), tvos(12.0))
SecTrustRef
sec_trust_copy_ref(sec_trust_t trust);
/*!
* @function sec_identity_create
*
* @abstract
* Create an ARC-able `sec_identity_t` instance from a `SecIdentityRef`.
*
* @param identity
* A `SecIdentityRef` instance.
*
* @return a `sec_identity_t` instance.
*/
API_AVAILABLE(macos(10.14), ios(12.0), watchos(5.0), tvos(12.0))
SEC_RETURNS_RETAINED _Nullable sec_identity_t
sec_identity_create(SecIdentityRef identity);
/*!
* @function sec_identity_create_with_certificates
*
* @abstract
* Create an ARC-able `sec_identity_t` instance from a `SecIdentityRef` and
* array of SecCertificateRef instances.
*
* @param identity
* A `SecIdentityRef` instance.
*
* @param certificates
* An array of `SecCertificateRef` instances.
*
* @return a `sec_identity_t` instance.
*/
API_AVAILABLE(macos(10.14), ios(12.0), watchos(5.0), tvos(12.0))
SEC_RETURNS_RETAINED _Nullable sec_identity_t
sec_identity_create_with_certificates(SecIdentityRef identity, CFArrayRef certificates);
#ifdef __BLOCKS__
/*!
* @function sec_identity_access_certificates
*
* @abstract
* Access the certificates associated with the `sec_identity_t` instance.
*
* @param identity
* A `sec_identity_t` instance.
*
* @param handler
* A block to invoke one or more times with `sec_certificate_t` instances.
*
* @return Returns true if the peer certificates were accessible, false otherwise.
*/
API_AVAILABLE(macos(10.15), ios(13.0), watchos(6.0), tvos(13.0))
bool
sec_identity_access_certificates(sec_identity_t identity,
void (^handler)(sec_certificate_t certificate));
#endif // __BLOCKS__
/*!
* @function sec_identity_copy_ref
*
* @abstract
* Copy a retained reference to the underlying `SecIdentityRef` instance.
*
* @param identity
* A `sec_identity_t` instance.
*
* @return The underlying `SecIdentityRef` instance.
*/
API_AVAILABLE(macos(10.14), ios(12.0), watchos(5.0), tvos(12.0))
_Nullable SecIdentityRef
sec_identity_copy_ref(sec_identity_t identity);
/*!
* @function sec_identity_copy_certificates_ref
*
* @abstract
* Copy a retained reference to the underlying `CFArrayRef` container of `SecCertificateRef` types.
*
* @param identity
* A `sec_identity_t` instance.
*
* @return The underlying `CFArrayRef` container with `SecCertificateRef` instances.
*/
API_AVAILABLE(macos(10.14), ios(12.0), watchos(5.0), tvos(12.0))
_Nullable CFArrayRef
sec_identity_copy_certificates_ref(sec_identity_t identity);
/*!
* @function sec_certificate_create
*
* @abstract
* Create an ARC-able `sec_certificate_t` instance from a `SecCertificateRef`.
*
* @param certificate
* A `SecCertificateRef` instance.
*
* @return a `sec_certificate_t` instance.
*/
API_AVAILABLE(macos(10.14), ios(12.0), watchos(5.0), tvos(12.0))
SEC_RETURNS_RETAINED _Nullable sec_certificate_t
sec_certificate_create(SecCertificateRef certificate);
/*!
* @function sec_certificate_copy_ref
*
* @abstract
* Copy a retained reference to the underlying `SecCertificateRef` instance.
*
* @param certificate
* A `sec_certificate_t` instance.
*
* @return The underlying `SecCertificateRef` instance.
*/
API_AVAILABLE(macos(10.14), ios(12.0), watchos(5.0), tvos(12.0))
SecCertificateRef
sec_certificate_copy_ref(sec_certificate_t certificate);
SEC_ASSUME_NONNULL_END
__END_DECLS
#endif // SecProtocolTypes_h
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Security.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Security.framework/Headers/cssmerr.h | /*
* Copyright (c) 1999-2002,2004,2011,2014 Apple Inc. All Rights Reserved.
*
* @APPLE_LICENSE_HEADER_START@
*
* This file contains Original Code and/or Modifications of Original Code
* as defined in and that are subject to the Apple Public Source License
* Version 2.0 (the 'License'). You may not use this file except in
* compliance with the License. Please obtain a copy of the License at
* http://www.opensource.apple.com/apsl/ and read it before using this
* file.
*
* The Original Code and all software distributed under the License are
* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
* Please see the License for the specific language governing rights and
* limitations under the License.
*
* @APPLE_LICENSE_HEADER_END@
*
* cssmerr.h -- Error Code Definitions for CSSM
*/
#ifndef _CSSMERR_H_
#define _CSSMERR_H_ 1
#ifdef __cplusplus
extern "C" {
#endif
/*
* NOTE: To translate CSSM error codes into something vaguely
* human-readable, use the cssmPerror function in cssmapple.h.
* This function will also decode other Security layer errors
* (i.e. those with names like kSec...).
*/
/* Macros for convertible error code manipulation. */
#define CSSM_ERRCODE(CODE) \
(((CODE) - CSSM_BASE_ERROR) & (CSSM_ERRORCODE_MODULE_EXTENT - 1))
#define CSSM_ERRBASE(CODE) \
((((CODE) - CSSM_BASE_ERROR) & ~(CSSM_ERRORCODE_MODULE_EXTENT - 1)) + CSSM_BASE_ERROR)
#define CSSM_ERR_IS_CONVERTIBLE(CODE) \
(CSSM_ERRCODE(CODE) < CSSM_ERRORCODE_COMMON_EXTENT)
#define CSSM_ERR_TAG(CODE, BASE) \
(CSSM_ERRCODE(CODE) + (BASE))
/* Error Bases for different module types. */
enum {
CSSM_BASE_ERROR = -0x7FFF0000, /* 0x80010000 */
CSSM_ERRORCODE_MODULE_EXTENT = 0x00000800,
CSSM_ERRORCODE_CUSTOM_OFFSET = 0x00000400,
CSSM_ERRORCODE_COMMON_EXTENT = 0x100,
CSSM_CSSM_BASE_ERROR = CSSM_BASE_ERROR,
CSSM_CSSM_PRIVATE_ERROR = CSSM_BASE_ERROR + CSSM_ERRORCODE_CUSTOM_OFFSET,
CSSM_CSP_BASE_ERROR = CSSM_CSSM_BASE_ERROR + CSSM_ERRORCODE_MODULE_EXTENT,
CSSM_CSP_PRIVATE_ERROR = CSSM_CSP_BASE_ERROR + CSSM_ERRORCODE_CUSTOM_OFFSET,
CSSM_DL_BASE_ERROR = CSSM_CSP_BASE_ERROR + CSSM_ERRORCODE_MODULE_EXTENT,
CSSM_DL_PRIVATE_ERROR = CSSM_DL_BASE_ERROR + CSSM_ERRORCODE_CUSTOM_OFFSET,
CSSM_CL_BASE_ERROR = CSSM_DL_BASE_ERROR + CSSM_ERRORCODE_MODULE_EXTENT,
CSSM_CL_PRIVATE_ERROR = CSSM_CL_BASE_ERROR + CSSM_ERRORCODE_CUSTOM_OFFSET,
CSSM_TP_BASE_ERROR = CSSM_CL_BASE_ERROR + CSSM_ERRORCODE_MODULE_EXTENT,
CSSM_TP_PRIVATE_ERROR = CSSM_TP_BASE_ERROR + CSSM_ERRORCODE_CUSTOM_OFFSET ,
CSSM_KR_BASE_ERROR = CSSM_TP_BASE_ERROR + CSSM_ERRORCODE_MODULE_EXTENT,
CSSM_KR_PRIVATE_ERROR = CSSM_KR_BASE_ERROR + CSSM_ERRORCODE_CUSTOM_OFFSET,
CSSM_AC_BASE_ERROR = CSSM_KR_BASE_ERROR + CSSM_ERRORCODE_MODULE_EXTENT,
CSSM_AC_PRIVATE_ERROR = CSSM_AC_BASE_ERROR + CSSM_ERRORCODE_CUSTOM_OFFSET
};
/* XXX @@@ MDS Error Bases same as DL for now. */
enum {
CSSM_MDS_BASE_ERROR = CSSM_CSP_BASE_ERROR + CSSM_ERRORCODE_MODULE_EXTENT,
CSSM_MDS_PRIVATE_ERROR = CSSM_MDS_BASE_ERROR + CSSM_ERRORCODE_CUSTOM_OFFSET
};
/* General Error Values. */
enum {
CSSMERR_CSSM_INVALID_ADDIN_HANDLE = -2147417855,
CSSMERR_CSSM_NOT_INITIALIZED = -2147417854,
CSSMERR_CSSM_INVALID_HANDLE_USAGE = -2147417853,
CSSMERR_CSSM_PVC_REFERENT_NOT_FOUND = -2147417852,
CSSMERR_CSSM_FUNCTION_INTEGRITY_FAIL = -2147417851,
};
/* Common Error Codes For All Module Types. */
enum {
CSSM_ERRCODE_INTERNAL_ERROR = 0x0001,
CSSM_ERRCODE_MEMORY_ERROR = 0x0002,
CSSM_ERRCODE_MDS_ERROR = 0x0003,
CSSM_ERRCODE_INVALID_POINTER = 0x0004,
CSSM_ERRCODE_INVALID_INPUT_POINTER = 0x0005,
CSSM_ERRCODE_INVALID_OUTPUT_POINTER = 0x0006,
CSSM_ERRCODE_FUNCTION_NOT_IMPLEMENTED = 0x0007,
CSSM_ERRCODE_SELF_CHECK_FAILED = 0x0008,
CSSM_ERRCODE_OS_ACCESS_DENIED = 0x0009,
CSSM_ERRCODE_FUNCTION_FAILED = 0x000A,
CSSM_ERRCODE_MODULE_MANIFEST_VERIFY_FAILED = 0x000B,
CSSM_ERRCODE_INVALID_GUID = 0x000C
};
/* Common Error Codes for ACLs */
enum {
CSSM_ERRCODE_OPERATION_AUTH_DENIED = 0x0020,
CSSM_ERRCODE_OBJECT_USE_AUTH_DENIED = 0x0021,
CSSM_ERRCODE_OBJECT_MANIP_AUTH_DENIED = 0x0022,
CSSM_ERRCODE_OBJECT_ACL_NOT_SUPPORTED = 0x0023,
CSSM_ERRCODE_OBJECT_ACL_REQUIRED = 0x0024,
CSSM_ERRCODE_INVALID_ACCESS_CREDENTIALS = 0x0025,
CSSM_ERRCODE_INVALID_ACL_BASE_CERTS = 0x0026,
CSSM_ERRCODE_ACL_BASE_CERTS_NOT_SUPPORTED = 0x0027,
CSSM_ERRCODE_INVALID_SAMPLE_VALUE = 0x0028,
CSSM_ERRCODE_SAMPLE_VALUE_NOT_SUPPORTED = 0x0029,
CSSM_ERRCODE_INVALID_ACL_SUBJECT_VALUE = 0x002A,
CSSM_ERRCODE_ACL_SUBJECT_TYPE_NOT_SUPPORTED = 0x002B,
CSSM_ERRCODE_INVALID_ACL_CHALLENGE_CALLBACK = 0x002C,
CSSM_ERRCODE_ACL_CHALLENGE_CALLBACK_FAILED = 0x002D,
CSSM_ERRCODE_INVALID_ACL_ENTRY_TAG = 0x002E,
CSSM_ERRCODE_ACL_ENTRY_TAG_NOT_FOUND = 0x002F,
CSSM_ERRCODE_INVALID_ACL_EDIT_MODE = 0x0030,
CSSM_ERRCODE_ACL_CHANGE_FAILED = 0x0031,
CSSM_ERRCODE_INVALID_NEW_ACL_ENTRY = 0x0032,
CSSM_ERRCODE_INVALID_NEW_ACL_OWNER = 0x0033,
CSSM_ERRCODE_ACL_DELETE_FAILED = 0x0034,
CSSM_ERRCODE_ACL_REPLACE_FAILED = 0x0035,
CSSM_ERRCODE_ACL_ADD_FAILED = 0x0036
};
/* Common Error Codes for Specific Data Types */
enum {
CSSM_ERRCODE_INVALID_CONTEXT_HANDLE = 0x0040,
CSSM_ERRCODE_INCOMPATIBLE_VERSION = 0x0041,
CSSM_ERRCODE_INVALID_CERTGROUP_POINTER = 0x0042,
CSSM_ERRCODE_INVALID_CERT_POINTER = 0x0043,
CSSM_ERRCODE_INVALID_CRL_POINTER = 0x0044,
CSSM_ERRCODE_INVALID_FIELD_POINTER = 0x0045,
CSSM_ERRCODE_INVALID_DATA = 0x0046,
CSSM_ERRCODE_CRL_ALREADY_SIGNED = 0x0047,
CSSM_ERRCODE_INVALID_NUMBER_OF_FIELDS = 0x0048,
CSSM_ERRCODE_VERIFICATION_FAILURE = 0x0049,
CSSM_ERRCODE_INVALID_DB_HANDLE = 0x004A,
CSSM_ERRCODE_PRIVILEGE_NOT_GRANTED = 0x004B,
CSSM_ERRCODE_INVALID_DB_LIST = 0x004C,
CSSM_ERRCODE_INVALID_DB_LIST_POINTER = 0x004D,
CSSM_ERRCODE_UNKNOWN_FORMAT = 0x004E,
CSSM_ERRCODE_UNKNOWN_TAG = 0x004F,
CSSM_ERRCODE_INVALID_CSP_HANDLE = 0x0050,
CSSM_ERRCODE_INVALID_DL_HANDLE = 0x0051,
CSSM_ERRCODE_INVALID_CL_HANDLE = 0x0052,
CSSM_ERRCODE_INVALID_TP_HANDLE = 0x0053,
CSSM_ERRCODE_INVALID_KR_HANDLE = 0x0054,
CSSM_ERRCODE_INVALID_AC_HANDLE = 0x0055,
CSSM_ERRCODE_INVALID_PASSTHROUGH_ID = 0x0056,
CSSM_ERRCODE_INVALID_NETWORK_ADDR = 0x0057,
CSSM_ERRCODE_INVALID_CRYPTO_DATA = 0x0058
};
/* CSSM Error Values Derived from Common Error Codes For All Module Types. */
enum {
CSSMERR_CSSM_INTERNAL_ERROR = -2147418111,
CSSMERR_CSSM_MEMORY_ERROR = -2147418110,
CSSMERR_CSSM_MDS_ERROR = -2147418109,
CSSMERR_CSSM_INVALID_POINTER = -2147418108,
CSSMERR_CSSM_INVALID_INPUT_POINTER = -2147418107,
CSSMERR_CSSM_INVALID_OUTPUT_POINTER = -2147418106,
CSSMERR_CSSM_FUNCTION_NOT_IMPLEMENTED = -2147418105,
CSSMERR_CSSM_SELF_CHECK_FAILED = -2147418104,
CSSMERR_CSSM_OS_ACCESS_DENIED = -2147418103,
CSSMERR_CSSM_FUNCTION_FAILED = -2147418102,
CSSMERR_CSSM_MODULE_MANIFEST_VERIFY_FAILED = -2147418101,
CSSMERR_CSSM_INVALID_GUID = -2147418100,
};
/* CSSM Error Values for Specific Data Types. */
enum {
CSSMERR_CSSM_INVALID_CONTEXT_HANDLE = -2147418048,
CSSMERR_CSSM_INCOMPATIBLE_VERSION = -2147418047,
CSSMERR_CSSM_PRIVILEGE_NOT_GRANTED = -2147418037,
};
/* CSSM Module-Specific Error Values */
enum {
CSSM_CSSM_BASE_CSSM_ERROR =
CSSM_CSSM_BASE_ERROR + CSSM_ERRORCODE_COMMON_EXTENT + 0x10,
CSSMERR_CSSM_SCOPE_NOT_SUPPORTED = -2147417839,
CSSMERR_CSSM_PVC_ALREADY_CONFIGURED = -2147417838,
CSSMERR_CSSM_INVALID_PVC = -2147417837,
CSSMERR_CSSM_EMM_LOAD_FAILED = -2147417836,
CSSMERR_CSSM_EMM_UNLOAD_FAILED = -2147417835,
CSSMERR_CSSM_ADDIN_LOAD_FAILED = -2147417834,
CSSMERR_CSSM_INVALID_KEY_HIERARCHY = -2147417833,
CSSMERR_CSSM_ADDIN_UNLOAD_FAILED = -2147417832,
CSSMERR_CSSM_LIB_REF_NOT_FOUND = -2147417831,
CSSMERR_CSSM_INVALID_ADDIN_FUNCTION_TABLE = -2147417830,
CSSMERR_CSSM_EMM_AUTHENTICATE_FAILED = -2147417829,
CSSMERR_CSSM_ADDIN_AUTHENTICATE_FAILED = -2147417828,
CSSMERR_CSSM_INVALID_SERVICE_MASK = -2147417827,
CSSMERR_CSSM_MODULE_NOT_LOADED = -2147417826,
CSSMERR_CSSM_INVALID_SUBSERVICEID = -2147417825,
CSSMERR_CSSM_BUFFER_TOO_SMALL = -2147417824,
CSSMERR_CSSM_INVALID_ATTRIBUTE = -2147417823,
CSSMERR_CSSM_ATTRIBUTE_NOT_IN_CONTEXT = -2147417822,
CSSMERR_CSSM_MODULE_MANAGER_INITIALIZE_FAIL = -2147417821,
CSSMERR_CSSM_MODULE_MANAGER_NOT_FOUND = -2147417820,
CSSMERR_CSSM_EVENT_NOTIFICATION_CALLBACK_NOT_FOUND = -2147417819,
};
/* CSP Error Values Derived from Common Error Codes For All Module Types. */
enum {
CSSMERR_CSP_INTERNAL_ERROR = -2147416063,
CSSMERR_CSP_MEMORY_ERROR = -2147416062,
CSSMERR_CSP_MDS_ERROR = -2147416061,
CSSMERR_CSP_INVALID_POINTER = -2147416060,
CSSMERR_CSP_INVALID_INPUT_POINTER = -2147416059,
CSSMERR_CSP_INVALID_OUTPUT_POINTER = -2147416058,
CSSMERR_CSP_FUNCTION_NOT_IMPLEMENTED = -2147416057,
CSSMERR_CSP_SELF_CHECK_FAILED = -2147416056,
CSSMERR_CSP_OS_ACCESS_DENIED = -2147416055,
CSSMERR_CSP_FUNCTION_FAILED = -2147416054,
};
/* CSP Error Values Derived from ACL-based Error Codes. */
enum {
CSSMERR_CSP_OPERATION_AUTH_DENIED = -2147416032,
CSSMERR_CSP_OBJECT_USE_AUTH_DENIED = -2147416031,
CSSMERR_CSP_OBJECT_MANIP_AUTH_DENIED = -2147416030,
CSSMERR_CSP_OBJECT_ACL_NOT_SUPPORTED = -2147416029,
CSSMERR_CSP_OBJECT_ACL_REQUIRED = -2147416028,
CSSMERR_CSP_INVALID_ACCESS_CREDENTIALS = -2147416027,
CSSMERR_CSP_INVALID_ACL_BASE_CERTS = -2147416026,
CSSMERR_CSP_ACL_BASE_CERTS_NOT_SUPPORTED = -2147416025,
CSSMERR_CSP_INVALID_SAMPLE_VALUE = -2147416024,
CSSMERR_CSP_SAMPLE_VALUE_NOT_SUPPORTED = -2147416023,
CSSMERR_CSP_INVALID_ACL_SUBJECT_VALUE = -2147416022,
CSSMERR_CSP_ACL_SUBJECT_TYPE_NOT_SUPPORTED = -2147416021,
CSSMERR_CSP_INVALID_ACL_CHALLENGE_CALLBACK = -2147416020,
CSSMERR_CSP_ACL_CHALLENGE_CALLBACK_FAILED = -2147416019,
CSSMERR_CSP_INVALID_ACL_ENTRY_TAG = -2147416018,
CSSMERR_CSP_ACL_ENTRY_TAG_NOT_FOUND = -2147416017,
CSSMERR_CSP_INVALID_ACL_EDIT_MODE = -2147416016,
CSSMERR_CSP_ACL_CHANGE_FAILED = -2147416015,
CSSMERR_CSP_INVALID_NEW_ACL_ENTRY = -2147416014,
CSSMERR_CSP_INVALID_NEW_ACL_OWNER = -2147416013,
CSSMERR_CSP_ACL_DELETE_FAILED = -2147416012,
CSSMERR_CSP_ACL_REPLACE_FAILED = -2147416011,
CSSMERR_CSP_ACL_ADD_FAILED = -2147416010,
};
/* CSP Error Values for Specific Data Types. */
enum {
CSSMERR_CSP_INVALID_CONTEXT_HANDLE = -2147416000,
CSSMERR_CSP_PRIVILEGE_NOT_GRANTED = -2147415989,
CSSMERR_CSP_INVALID_DATA = -2147415994,
CSSMERR_CSP_INVALID_PASSTHROUGH_ID = -2147415978,
CSSMERR_CSP_INVALID_CRYPTO_DATA = -2147415976,
};
/* CSP Module-Specific Error Values */
enum {
/* General CSP Error Values */
CSSM_CSP_BASE_CSP_ERROR =
CSSM_CSP_BASE_ERROR + CSSM_ERRORCODE_COMMON_EXTENT,
CSSMERR_CSP_INPUT_LENGTH_ERROR = -2147415807,
CSSMERR_CSP_OUTPUT_LENGTH_ERROR = -2147415806,
CSSMERR_CSP_PRIVILEGE_NOT_SUPPORTED = -2147415805,
CSSMERR_CSP_DEVICE_ERROR = -2147415804,
CSSMERR_CSP_DEVICE_MEMORY_ERROR = -2147415803,
CSSMERR_CSP_ATTACH_HANDLE_BUSY = -2147415802,
CSSMERR_CSP_NOT_LOGGED_IN = -2147415801,
CSSMERR_CSP_INVALID_KEY = -2147415792,
CSSMERR_CSP_INVALID_KEY_REFERENCE = -2147415791,
CSSMERR_CSP_INVALID_KEY_CLASS = -2147415790,
CSSMERR_CSP_ALGID_MISMATCH = -2147415789,
CSSMERR_CSP_KEY_USAGE_INCORRECT = -2147415788,
CSSMERR_CSP_KEY_BLOB_TYPE_INCORRECT = -2147415787,
CSSMERR_CSP_KEY_HEADER_INCONSISTENT = -2147415786,
CSSMERR_CSP_UNSUPPORTED_KEY_FORMAT = -2147415785,
CSSMERR_CSP_UNSUPPORTED_KEY_SIZE = -2147415784,
CSSMERR_CSP_INVALID_KEY_POINTER = -2147415783,
CSSMERR_CSP_INVALID_KEYUSAGE_MASK = -2147415782,
CSSMERR_CSP_UNSUPPORTED_KEYUSAGE_MASK = -2147415781,
CSSMERR_CSP_INVALID_KEYATTR_MASK = -2147415780,
CSSMERR_CSP_UNSUPPORTED_KEYATTR_MASK = -2147415779,
CSSMERR_CSP_INVALID_KEY_LABEL = -2147415778,
CSSMERR_CSP_UNSUPPORTED_KEY_LABEL = -2147415777,
CSSMERR_CSP_INVALID_KEY_FORMAT = -2147415776,
CSSMERR_CSP_INVALID_DATA_COUNT = -2147415768,
CSSMERR_CSP_VECTOR_OF_BUFS_UNSUPPORTED = -2147415767,
CSSMERR_CSP_INVALID_INPUT_VECTOR = -2147415766,
CSSMERR_CSP_INVALID_OUTPUT_VECTOR = -2147415765,
CSSMERR_CSP_INVALID_CONTEXT = -2147415760,
CSSMERR_CSP_INVALID_ALGORITHM = -2147415759,
CSSMERR_CSP_INVALID_ATTR_KEY = -2147415754,
CSSMERR_CSP_MISSING_ATTR_KEY = -2147415753,
CSSMERR_CSP_INVALID_ATTR_INIT_VECTOR = -2147415752,
CSSMERR_CSP_MISSING_ATTR_INIT_VECTOR = -2147415751,
CSSMERR_CSP_INVALID_ATTR_SALT = -2147415750,
CSSMERR_CSP_MISSING_ATTR_SALT = -2147415749,
CSSMERR_CSP_INVALID_ATTR_PADDING = -2147415748,
CSSMERR_CSP_MISSING_ATTR_PADDING = -2147415747,
CSSMERR_CSP_INVALID_ATTR_RANDOM = -2147415746,
CSSMERR_CSP_MISSING_ATTR_RANDOM = -2147415745,
CSSMERR_CSP_INVALID_ATTR_SEED = -2147415744,
CSSMERR_CSP_MISSING_ATTR_SEED = -2147415743,
CSSMERR_CSP_INVALID_ATTR_PASSPHRASE = -2147415742,
CSSMERR_CSP_MISSING_ATTR_PASSPHRASE = -2147415741,
CSSMERR_CSP_INVALID_ATTR_KEY_LENGTH = -2147415740,
CSSMERR_CSP_MISSING_ATTR_KEY_LENGTH = -2147415739,
CSSMERR_CSP_INVALID_ATTR_BLOCK_SIZE = -2147415738,
CSSMERR_CSP_MISSING_ATTR_BLOCK_SIZE = -2147415737,
CSSMERR_CSP_INVALID_ATTR_OUTPUT_SIZE = -2147415708,
CSSMERR_CSP_MISSING_ATTR_OUTPUT_SIZE = -2147415707,
CSSMERR_CSP_INVALID_ATTR_ROUNDS = -2147415706,
CSSMERR_CSP_MISSING_ATTR_ROUNDS = -2147415705,
CSSMERR_CSP_INVALID_ATTR_ALG_PARAMS = -2147415704,
CSSMERR_CSP_MISSING_ATTR_ALG_PARAMS = -2147415703,
CSSMERR_CSP_INVALID_ATTR_LABEL = -2147415702,
CSSMERR_CSP_MISSING_ATTR_LABEL = -2147415701,
CSSMERR_CSP_INVALID_ATTR_KEY_TYPE = -2147415700,
CSSMERR_CSP_MISSING_ATTR_KEY_TYPE = -2147415699,
CSSMERR_CSP_INVALID_ATTR_MODE = -2147415698,
CSSMERR_CSP_MISSING_ATTR_MODE = -2147415697,
CSSMERR_CSP_INVALID_ATTR_EFFECTIVE_BITS = -2147415696,
CSSMERR_CSP_MISSING_ATTR_EFFECTIVE_BITS = -2147415695,
CSSMERR_CSP_INVALID_ATTR_START_DATE = -2147415694,
CSSMERR_CSP_MISSING_ATTR_START_DATE = -2147415693,
CSSMERR_CSP_INVALID_ATTR_END_DATE = -2147415692,
CSSMERR_CSP_MISSING_ATTR_END_DATE = -2147415691,
CSSMERR_CSP_INVALID_ATTR_VERSION = -2147415690,
CSSMERR_CSP_MISSING_ATTR_VERSION = -2147415689,
CSSMERR_CSP_INVALID_ATTR_PRIME = -2147415688,
CSSMERR_CSP_MISSING_ATTR_PRIME = -2147415687,
CSSMERR_CSP_INVALID_ATTR_BASE = -2147415686,
CSSMERR_CSP_MISSING_ATTR_BASE = -2147415685,
CSSMERR_CSP_INVALID_ATTR_SUBPRIME = -2147415684,
CSSMERR_CSP_MISSING_ATTR_SUBPRIME = -2147415683,
CSSMERR_CSP_INVALID_ATTR_ITERATION_COUNT = -2147415682,
CSSMERR_CSP_MISSING_ATTR_ITERATION_COUNT = -2147415681,
CSSMERR_CSP_INVALID_ATTR_DL_DB_HANDLE = -2147415680,
CSSMERR_CSP_MISSING_ATTR_DL_DB_HANDLE = -2147415679,
CSSMERR_CSP_INVALID_ATTR_ACCESS_CREDENTIALS = -2147415678,
CSSMERR_CSP_MISSING_ATTR_ACCESS_CREDENTIALS = -2147415677,
CSSMERR_CSP_INVALID_ATTR_PUBLIC_KEY_FORMAT = -2147415676,
CSSMERR_CSP_MISSING_ATTR_PUBLIC_KEY_FORMAT = -2147415675,
CSSMERR_CSP_INVALID_ATTR_PRIVATE_KEY_FORMAT = -2147415674,
CSSMERR_CSP_MISSING_ATTR_PRIVATE_KEY_FORMAT = -2147415673,
CSSMERR_CSP_INVALID_ATTR_SYMMETRIC_KEY_FORMAT = -2147415672,
CSSMERR_CSP_MISSING_ATTR_SYMMETRIC_KEY_FORMAT = -2147415671,
CSSMERR_CSP_INVALID_ATTR_WRAPPED_KEY_FORMAT = -2147415670,
CSSMERR_CSP_MISSING_ATTR_WRAPPED_KEY_FORMAT = -2147415669,
CSSMERR_CSP_STAGED_OPERATION_IN_PROGRESS = -2147415736,
CSSMERR_CSP_STAGED_OPERATION_NOT_STARTED = -2147415735,
CSSMERR_CSP_VERIFY_FAILED = -2147415734,
CSSMERR_CSP_INVALID_SIGNATURE = -2147415733,
CSSMERR_CSP_QUERY_SIZE_UNKNOWN = -2147415732,
CSSMERR_CSP_BLOCK_SIZE_MISMATCH = -2147415731,
CSSMERR_CSP_PRIVATE_KEY_NOT_FOUND = -2147415730,
CSSMERR_CSP_PUBLIC_KEY_INCONSISTENT = -2147415729,
CSSMERR_CSP_DEVICE_VERIFY_FAILED = -2147415728,
CSSMERR_CSP_INVALID_LOGIN_NAME = -2147415727,
CSSMERR_CSP_ALREADY_LOGGED_IN = -2147415726,
CSSMERR_CSP_PRIVATE_KEY_ALREADY_EXISTS = -2147415725,
CSSMERR_CSP_KEY_LABEL_ALREADY_EXISTS = -2147415724,
CSSMERR_CSP_INVALID_DIGEST_ALGORITHM = -2147415723,
CSSMERR_CSP_CRYPTO_DATA_CALLBACK_FAILED = -2147415722,
};
/* TP Error Values Derived from Common Error Codes For All Module Types. */
enum {
CSSMERR_TP_INTERNAL_ERROR = -2147409919,
CSSMERR_TP_MEMORY_ERROR = -2147409918,
CSSMERR_TP_MDS_ERROR = -2147409917,
CSSMERR_TP_INVALID_POINTER = -2147409916,
CSSMERR_TP_INVALID_INPUT_POINTER = -2147409915,
CSSMERR_TP_INVALID_OUTPUT_POINTER = -2147409914,
CSSMERR_TP_FUNCTION_NOT_IMPLEMENTED = -2147409913,
CSSMERR_TP_SELF_CHECK_FAILED = -2147409912,
CSSMERR_TP_OS_ACCESS_DENIED = -2147409911,
CSSMERR_TP_FUNCTION_FAILED = -2147409910,
CSSMERR_TP_INVALID_CONTEXT_HANDLE = -2147409856,
CSSMERR_TP_INVALID_DATA = -2147409850,
CSSMERR_TP_INVALID_DB_LIST = -2147409844,
CSSMERR_TP_INVALID_CERTGROUP_POINTER = -2147409854,
CSSMERR_TP_INVALID_CERT_POINTER = -2147409853,
CSSMERR_TP_INVALID_CRL_POINTER = -2147409852,
CSSMERR_TP_INVALID_FIELD_POINTER = -2147409851,
CSSMERR_TP_INVALID_NETWORK_ADDR = -2147409833,
CSSMERR_TP_CRL_ALREADY_SIGNED = -2147409849,
CSSMERR_TP_INVALID_NUMBER_OF_FIELDS = -2147409848,
CSSMERR_TP_VERIFICATION_FAILURE = -2147409847,
CSSMERR_TP_INVALID_DB_HANDLE = -2147409846,
CSSMERR_TP_UNKNOWN_FORMAT = -2147409842,
CSSMERR_TP_UNKNOWN_TAG = -2147409841,
CSSMERR_TP_INVALID_PASSTHROUGH_ID = -2147409834,
CSSMERR_TP_INVALID_CSP_HANDLE = -2147409840,
CSSMERR_TP_INVALID_DL_HANDLE = -2147409839,
CSSMERR_TP_INVALID_CL_HANDLE = -2147409838,
CSSMERR_TP_INVALID_DB_LIST_POINTER = -2147409843,
};
/* TP Module-Specific Error Values */
enum {
CSSM_TP_BASE_TP_ERROR =
CSSM_TP_BASE_ERROR + CSSM_ERRORCODE_COMMON_EXTENT,
CSSMERR_TP_INVALID_CALLERAUTH_CONTEXT_POINTER = -2147409663,
CSSMERR_TP_INVALID_IDENTIFIER_POINTER = -2147409662,
CSSMERR_TP_INVALID_KEYCACHE_HANDLE = -2147409661,
CSSMERR_TP_INVALID_CERTGROUP = -2147409660,
CSSMERR_TP_INVALID_CRLGROUP = -2147409659,
CSSMERR_TP_INVALID_CRLGROUP_POINTER = -2147409658,
CSSMERR_TP_AUTHENTICATION_FAILED = -2147409657,
CSSMERR_TP_CERTGROUP_INCOMPLETE = -2147409656,
CSSMERR_TP_CERTIFICATE_CANT_OPERATE = -2147409655,
CSSMERR_TP_CERT_EXPIRED = -2147409654,
CSSMERR_TP_CERT_NOT_VALID_YET = -2147409653,
CSSMERR_TP_CERT_REVOKED = -2147409652,
CSSMERR_TP_CERT_SUSPENDED = -2147409651,
CSSMERR_TP_INSUFFICIENT_CREDENTIALS = -2147409650,
CSSMERR_TP_INVALID_ACTION = -2147409649,
CSSMERR_TP_INVALID_ACTION_DATA = -2147409648,
CSSMERR_TP_INVALID_ANCHOR_CERT = -2147409646,
CSSMERR_TP_INVALID_AUTHORITY = -2147409645,
CSSMERR_TP_VERIFY_ACTION_FAILED = -2147409644,
CSSMERR_TP_INVALID_CERTIFICATE = -2147409643,
CSSMERR_TP_INVALID_CERT_AUTHORITY = -2147409642,
CSSMERR_TP_INVALID_CRL_AUTHORITY = -2147409641,
CSSMERR_TP_INVALID_CRL_ENCODING = -2147409640,
CSSMERR_TP_INVALID_CRL_TYPE = -2147409639,
CSSMERR_TP_INVALID_CRL = -2147409638,
CSSMERR_TP_INVALID_FORM_TYPE = -2147409637,
CSSMERR_TP_INVALID_ID = -2147409636,
CSSMERR_TP_INVALID_IDENTIFIER = -2147409635,
CSSMERR_TP_INVALID_INDEX = -2147409634,
CSSMERR_TP_INVALID_NAME = -2147409633,
CSSMERR_TP_INVALID_POLICY_IDENTIFIERS = -2147409632,
CSSMERR_TP_INVALID_TIMESTRING = -2147409631,
CSSMERR_TP_INVALID_REASON = -2147409630,
CSSMERR_TP_INVALID_REQUEST_INPUTS = -2147409629,
CSSMERR_TP_INVALID_RESPONSE_VECTOR = -2147409628,
CSSMERR_TP_INVALID_SIGNATURE = -2147409627,
CSSMERR_TP_INVALID_STOP_ON_POLICY = -2147409626,
CSSMERR_TP_INVALID_CALLBACK = -2147409625,
CSSMERR_TP_INVALID_TUPLE = -2147409624,
CSSMERR_TP_NOT_SIGNER = -2147409623,
CSSMERR_TP_NOT_TRUSTED = -2147409622,
CSSMERR_TP_NO_DEFAULT_AUTHORITY = -2147409621,
CSSMERR_TP_REJECTED_FORM = -2147409620,
CSSMERR_TP_REQUEST_LOST = -2147409619,
CSSMERR_TP_REQUEST_REJECTED = -2147409618,
CSSMERR_TP_UNSUPPORTED_ADDR_TYPE = -2147409617,
CSSMERR_TP_UNSUPPORTED_SERVICE = -2147409616,
CSSMERR_TP_INVALID_TUPLEGROUP_POINTER = -2147409615,
CSSMERR_TP_INVALID_TUPLEGROUP = -2147409614,
};
/* AC Error Values Derived from Common Error Codes For All Module Types. */
enum {
CSSMERR_AC_INTERNAL_ERROR = -2147405823,
CSSMERR_AC_MEMORY_ERROR = -2147405822,
CSSMERR_AC_MDS_ERROR = -2147405821,
CSSMERR_AC_INVALID_POINTER = -2147405820,
CSSMERR_AC_INVALID_INPUT_POINTER = -2147405819,
CSSMERR_AC_INVALID_OUTPUT_POINTER = -2147405818,
CSSMERR_AC_FUNCTION_NOT_IMPLEMENTED = -2147405817,
CSSMERR_AC_SELF_CHECK_FAILED = -2147405816,
CSSMERR_AC_OS_ACCESS_DENIED = -2147405815,
CSSMERR_AC_FUNCTION_FAILED = -2147405814,
CSSMERR_AC_INVALID_CONTEXT_HANDLE = -2147405760,
CSSMERR_AC_INVALID_DATA = -2147405754,
CSSMERR_AC_INVALID_DB_LIST = -2147405748,
CSSMERR_AC_INVALID_PASSTHROUGH_ID = -2147405738,
CSSMERR_AC_INVALID_DL_HANDLE = -2147405743,
CSSMERR_AC_INVALID_CL_HANDLE = -2147405742,
CSSMERR_AC_INVALID_TP_HANDLE = -2147405741,
CSSMERR_AC_INVALID_DB_HANDLE = -2147405750,
CSSMERR_AC_INVALID_DB_LIST_POINTER = -2147405747,
};
/* AC Module-Specific Error Values */
enum {
CSSM_AC_BASE_AC_ERROR =
CSSM_AC_BASE_ERROR + CSSM_ERRORCODE_COMMON_EXTENT,
CSSMERR_AC_INVALID_BASE_ACLS = -2147405567,
CSSMERR_AC_INVALID_TUPLE_CREDENTIALS = -2147405566,
CSSMERR_AC_INVALID_ENCODING = -2147405565,
CSSMERR_AC_INVALID_VALIDITY_PERIOD = -2147405564,
CSSMERR_AC_INVALID_REQUESTOR = -2147405563,
CSSMERR_AC_INVALID_REQUEST_DESCRIPTOR = -2147405562,
};
/* CL Error Values Derived from Common Error Codes For All Module Types. */
enum {
CSSMERR_CL_INTERNAL_ERROR = -2147411967,
CSSMERR_CL_MEMORY_ERROR = -2147411966,
CSSMERR_CL_MDS_ERROR = -2147411965,
CSSMERR_CL_INVALID_POINTER = -2147411964,
CSSMERR_CL_INVALID_INPUT_POINTER = -2147411963,
CSSMERR_CL_INVALID_OUTPUT_POINTER = -2147411962,
CSSMERR_CL_FUNCTION_NOT_IMPLEMENTED = -2147411961,
CSSMERR_CL_SELF_CHECK_FAILED = -2147411960,
CSSMERR_CL_OS_ACCESS_DENIED = -2147411959,
CSSMERR_CL_FUNCTION_FAILED = -2147411958,
CSSMERR_CL_INVALID_CONTEXT_HANDLE = -2147411904,
CSSMERR_CL_INVALID_CERTGROUP_POINTER = -2147411902,
CSSMERR_CL_INVALID_CERT_POINTER = -2147411901,
CSSMERR_CL_INVALID_CRL_POINTER = -2147411900,
CSSMERR_CL_INVALID_FIELD_POINTER = -2147411899,
CSSMERR_CL_INVALID_DATA = -2147411898,
CSSMERR_CL_CRL_ALREADY_SIGNED = -2147411897,
CSSMERR_CL_INVALID_NUMBER_OF_FIELDS = -2147411896,
CSSMERR_CL_VERIFICATION_FAILURE = -2147411895,
CSSMERR_CL_UNKNOWN_FORMAT = -2147411890,
CSSMERR_CL_UNKNOWN_TAG = -2147411889,
CSSMERR_CL_INVALID_PASSTHROUGH_ID = -2147411882,
};
/* CL Module-Specific Error Values */
enum {
CSSM_CL_BASE_CL_ERROR =
CSSM_CL_BASE_ERROR + CSSM_ERRORCODE_COMMON_EXTENT,
CSSMERR_CL_INVALID_BUNDLE_POINTER = -2147411711,
CSSMERR_CL_INVALID_CACHE_HANDLE = -2147411710,
CSSMERR_CL_INVALID_RESULTS_HANDLE = -2147411709,
CSSMERR_CL_INVALID_BUNDLE_INFO = -2147411708,
CSSMERR_CL_INVALID_CRL_INDEX = -2147411707,
CSSMERR_CL_INVALID_SCOPE = -2147411706,
CSSMERR_CL_NO_FIELD_VALUES = -2147411705,
CSSMERR_CL_SCOPE_NOT_SUPPORTED = -2147411704,
};
/* DL Error Values Derived from Common Error Codes For All Module Types. */
enum {
CSSMERR_DL_INTERNAL_ERROR = -2147414015,
CSSMERR_DL_MEMORY_ERROR = -2147414014,
CSSMERR_DL_MDS_ERROR = -2147414013,
CSSMERR_DL_INVALID_POINTER = -2147414012,
CSSMERR_DL_INVALID_INPUT_POINTER = -2147414011,
CSSMERR_DL_INVALID_OUTPUT_POINTER = -2147414010,
CSSMERR_DL_FUNCTION_NOT_IMPLEMENTED = -2147414009,
CSSMERR_DL_SELF_CHECK_FAILED = -2147414008,
CSSMERR_DL_OS_ACCESS_DENIED = -2147414007,
CSSMERR_DL_FUNCTION_FAILED = -2147414006,
CSSMERR_DL_INVALID_CSP_HANDLE = -2147413936,
CSSMERR_DL_INVALID_DL_HANDLE = -2147413935,
CSSMERR_DL_INVALID_CL_HANDLE = -2147413934,
CSSMERR_DL_INVALID_DB_LIST_POINTER = -2147413939,
};
/* DL Error Values Derived from ACL-based Error Codes. */
enum {
CSSMERR_DL_OPERATION_AUTH_DENIED = -2147413984,
CSSMERR_DL_OBJECT_USE_AUTH_DENIED = -2147413983,
CSSMERR_DL_OBJECT_MANIP_AUTH_DENIED = -2147413982,
CSSMERR_DL_OBJECT_ACL_NOT_SUPPORTED = -2147413981,
CSSMERR_DL_OBJECT_ACL_REQUIRED = -2147413980,
CSSMERR_DL_INVALID_ACCESS_CREDENTIALS = -2147413979,
CSSMERR_DL_INVALID_ACL_BASE_CERTS = -2147413978,
CSSMERR_DL_ACL_BASE_CERTS_NOT_SUPPORTED = -2147413977,
CSSMERR_DL_INVALID_SAMPLE_VALUE = -2147413976,
CSSMERR_DL_SAMPLE_VALUE_NOT_SUPPORTED = -2147413975,
CSSMERR_DL_INVALID_ACL_SUBJECT_VALUE = -2147413974,
CSSMERR_DL_ACL_SUBJECT_TYPE_NOT_SUPPORTED = -2147413973,
CSSMERR_DL_INVALID_ACL_CHALLENGE_CALLBACK = -2147413972,
CSSMERR_DL_ACL_CHALLENGE_CALLBACK_FAILED = -2147413971,
CSSMERR_DL_INVALID_ACL_ENTRY_TAG = -2147413970,
CSSMERR_DL_ACL_ENTRY_TAG_NOT_FOUND = -2147413969,
CSSMERR_DL_INVALID_ACL_EDIT_MODE = -2147413968,
CSSMERR_DL_ACL_CHANGE_FAILED = -2147413967,
CSSMERR_DL_INVALID_NEW_ACL_ENTRY = -2147413966,
CSSMERR_DL_INVALID_NEW_ACL_OWNER = -2147413965,
CSSMERR_DL_ACL_DELETE_FAILED = -2147413964,
CSSMERR_DL_ACL_REPLACE_FAILED = -2147413963,
CSSMERR_DL_ACL_ADD_FAILED = -2147413962,
};
/* DL Error Values for Specific Data Types. */
enum {
CSSMERR_DL_INVALID_DB_HANDLE = -2147413942,
CSSMERR_DL_INVALID_PASSTHROUGH_ID = -2147413930,
CSSMERR_DL_INVALID_NETWORK_ADDR = -2147413929,
};
/* DL Module-Specific Error Values */
enum {
CSSM_DL_BASE_DL_ERROR =
CSSM_DL_BASE_ERROR + CSSM_ERRORCODE_COMMON_EXTENT,
CSSMERR_DL_DATABASE_CORRUPT = -2147413759,
CSSMERR_DL_INVALID_RECORD_INDEX = -2147413752,
CSSMERR_DL_INVALID_RECORDTYPE = -2147413751,
CSSMERR_DL_INVALID_FIELD_NAME = -2147413750,
CSSMERR_DL_UNSUPPORTED_FIELD_FORMAT = -2147413749,
CSSMERR_DL_UNSUPPORTED_INDEX_INFO = -2147413748,
CSSMERR_DL_UNSUPPORTED_LOCALITY = -2147413747,
CSSMERR_DL_UNSUPPORTED_NUM_ATTRIBUTES = -2147413746,
CSSMERR_DL_UNSUPPORTED_NUM_INDEXES = -2147413745,
CSSMERR_DL_UNSUPPORTED_NUM_RECORDTYPES = -2147413744,
CSSMERR_DL_UNSUPPORTED_RECORDTYPE = -2147413743,
CSSMERR_DL_FIELD_SPECIFIED_MULTIPLE = -2147413742,
CSSMERR_DL_INCOMPATIBLE_FIELD_FORMAT = -2147413741,
CSSMERR_DL_INVALID_PARSING_MODULE = -2147413740,
CSSMERR_DL_INVALID_DB_NAME = -2147413738,
CSSMERR_DL_DATASTORE_DOESNOT_EXIST = -2147413737,
CSSMERR_DL_DATASTORE_ALREADY_EXISTS = -2147413736,
CSSMERR_DL_DB_LOCKED = -2147413735,
CSSMERR_DL_DATASTORE_IS_OPEN = -2147413734,
CSSMERR_DL_RECORD_NOT_FOUND = -2147413733,
CSSMERR_DL_MISSING_VALUE = -2147413732,
CSSMERR_DL_UNSUPPORTED_QUERY = -2147413731,
CSSMERR_DL_UNSUPPORTED_QUERY_LIMITS = -2147413730,
CSSMERR_DL_UNSUPPORTED_NUM_SELECTION_PREDS = -2147413729,
CSSMERR_DL_UNSUPPORTED_OPERATOR = -2147413727,
CSSMERR_DL_INVALID_RESULTS_HANDLE = -2147413726,
CSSMERR_DL_INVALID_DB_LOCATION = -2147413725,
CSSMERR_DL_INVALID_ACCESS_REQUEST = -2147413724,
CSSMERR_DL_INVALID_INDEX_INFO = -2147413723,
CSSMERR_DL_INVALID_SELECTION_TAG = -2147413722,
CSSMERR_DL_INVALID_NEW_OWNER = -2147413721,
CSSMERR_DL_INVALID_RECORD_UID = -2147413720,
CSSMERR_DL_INVALID_UNIQUE_INDEX_DATA = -2147413719,
CSSMERR_DL_INVALID_MODIFY_MODE = -2147413718,
CSSMERR_DL_INVALID_OPEN_PARAMETERS = -2147413717,
CSSMERR_DL_RECORD_MODIFIED = -2147413716,
CSSMERR_DL_ENDOFDATA = -2147413715,
CSSMERR_DL_INVALID_QUERY = -2147413714,
CSSMERR_DL_INVALID_VALUE = -2147413713,
CSSMERR_DL_MULTIPLE_VALUES_UNSUPPORTED = -2147413712,
CSSMERR_DL_STALE_UNIQUE_RECORD = -2147413711,
};
#ifdef __cplusplus
}
#endif
#endif /* _CSSMERR_H_ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Security.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Security.framework/Headers/SecIdentitySearch.h | /*
* Copyright (c) 2002-2011 Apple Inc. All Rights Reserved.
*
* @APPLE_LICENSE_HEADER_START@
*
* This file contains Original Code and/or Modifications of Original Code
* as defined in and that are subject to the Apple Public Source License
* Version 2.0 (the 'License'). You may not use this file except in
* compliance with the License. Please obtain a copy of the License at
* http://www.opensource.apple.com/apsl/ and read it before using this
* file.
*
* The Original Code and all software distributed under the License are
* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
* Please see the License for the specific language governing rights and
* limitations under the License.
*
* @APPLE_LICENSE_HEADER_END@
*/
/*!
@header SecIdentitySearch
The functions provided in SecIdentitySearch implement a query for SecIdentity objects.
*/
#ifndef _SECURITY_SECIDENTITYSEARCH_H_
#define _SECURITY_SECIDENTITYSEARCH_H_
#include <Security/SecBase.h>
#include <Security/cssmtype.h>
#include <CoreFoundation/CFArray.h>
#include <CoreFoundation/CFDictionary.h>
#include <CoreFoundation/CFString.h>
#include <AvailabilityMacros.h>
#if defined(__cplusplus)
extern "C" {
#endif
CF_ASSUME_NONNULL_BEGIN
/*!
@typedef SecIdentitySearchRef
@abstract Contains information about an identity search.
*/
typedef struct CF_BRIDGED_TYPE(id) OpaqueSecIdentitySearchRef *SecIdentitySearchRef;
/*!
@function SecIdentitySearchGetTypeID
@abstract Returns the type identifier of SecIdentitySearch instances.
@result The CFTypeID of SecIdentitySearch instances.
@discussion This API is deprecated in 10.7. The SecIdentitySearchRef type is no longer used.
*/
CFTypeID SecIdentitySearchGetTypeID(void)
DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER;
/*!
@function SecIdentitySearchCreate
@abstract Creates a search reference for finding identities.
@param keychainOrArray An reference to an array of keychains to search, a single keychain, or NULL to search the user's default keychain search list.
@param keyUsage A CSSM_KEYUSE value, as defined in cssmtype.h. This value narrows the search to return only those identities which match the specified key usage. Pass a value of 0 to ignore key usage and return all available identities. Note that passing CSSM_KEYUSE_ANY limits the results to only those identities that can be used for every operation.
@param searchRef On return, an identity search reference. You must release the identity search reference by calling the CFRelease function.
@result A result code. See "Security Error Codes" (SecBase.h).
@discussion You can set values for key usage, and one or more keychains, to control the search for identities. You can use the returned search reference to obtain the remaining identities in subsequent calls to the SecIentitySearchCopyNext function. You must release the identity search reference by calling the CFRelease function.
This function is deprecated in Mac OS X 10.7 and later; to find identities which match a given key usage or other attributes, please use the SecItemCopyMatching API (see SecItem.h).
*/
OSStatus SecIdentitySearchCreate(CFTypeRef __nullable keychainOrArray, CSSM_KEYUSE keyUsage, SecIdentitySearchRef * __nullable CF_RETURNS_RETAINED searchRef)
DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER;
/*!
@function SecIdentitySearchCopyNext
@abstract Finds the next identity matching the given search criteria, as previously specified by a call to SecIdentitySearchCreate or SecIdentitySearchCreateWithAttributes.
@param searchRef A reference to the current identity search. You create the identity search reference by calling either SecIdentitySearchCreate or SecIdentitySearchCreateWithAttributes.
@param identity On return, an identity reference for the next found identity, if any. You must call the CFRelease function when finished with the identity reference.
@result A result code. When there are no more identities found that match the search criteria, errSecItemNotFound is returned. See "Security Error Codes" (SecBase.h).
@discussion This function is deprecated in Mac OS X 10.7 and later; to find identities which match specified attributes, please use the SecItemCopyMatching API (see SecItem.h).
*/
OSStatus SecIdentitySearchCopyNext(SecIdentitySearchRef searchRef, SecIdentityRef * __nullable CF_RETURNS_RETAINED identity)
DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER;
CF_ASSUME_NONNULL_END
#if defined(__cplusplus)
}
#endif
#endif /* !_SECURITY_SECIDENTITYSEARCH_H_ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Security.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Security.framework/Headers/emmtype.h | /*
* Copyright (c) 1999-2001,2004,2011,2014 Apple Inc. All Rights Reserved.
*
* @APPLE_LICENSE_HEADER_START@
*
* This file contains Original Code and/or Modifications of Original Code
* as defined in and that are subject to the Apple Public Source License
* Version 2.0 (the 'License'). You may not use this file except in
* compliance with the License. Please obtain a copy of the License at
* http://www.opensource.apple.com/apsl/ and read it before using this
* file.
*
* The Original Code and all software distributed under the License are
* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
* Please see the License for the specific language governing rights and
* limitations under the License.
*
* @APPLE_LICENSE_HEADER_END@
*
* emmtype.h -- Data Structures for Elective Module Managers
*/
#ifndef _EMMTYPE_H_
#define _EMMTYPE_H_ 1
#include <Security/cssmtype.h>
#ifdef __cplusplus
extern "C" {
#endif
#pragma clang diagnostic push
#pragma clang diagnostic ignored "-Wdeprecated-declarations"
#define CSSM_HINT_CALLBACK (1)
typedef uint32 CSSM_MANAGER_EVENT_TYPES;
#define CSSM_MANAGER_SERVICE_REQUEST 1
#define CSSM_MANAGER_REPLY 2
typedef struct DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER cssm_manager_event_notification {
CSSM_SERVICE_MASK DestinationModuleManagerType;
CSSM_SERVICE_MASK SourceModuleManagerType;
CSSM_MANAGER_EVENT_TYPES Event;
uint32 EventId;
CSSM_DATA EventData;
} CSSM_MANAGER_EVENT_NOTIFICATION DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER, *CSSM_MANAGER_EVENT_NOTIFICATION_PTR DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER;
#pragma clang diagnostic pop
#ifdef __cplusplus
}
#endif
#endif /* _EMMTYPE_H_ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Security.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Security.framework/Headers/cssm.h | /*
* Copyright (c) 1999-2001,2004,2011,2014 Apple Inc. All Rights Reserved.
*
* @APPLE_LICENSE_HEADER_START@
*
* This file contains Original Code and/or Modifications of Original Code
* as defined in and that are subject to the Apple Public Source License
* Version 2.0 (the 'License'). You may not use this file except in
* compliance with the License. Please obtain a copy of the License at
* http://www.opensource.apple.com/apsl/ and read it before using this
* file.
*
* The Original Code and all software distributed under the License are
* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
* Please see the License for the specific language governing rights and
* limitations under the License.
*
* @APPLE_LICENSE_HEADER_END@
*
* cssm.h -- Common Security Services Manager Interface
*/
#ifndef _CSSM_H_
#define _CSSM_H_ 1
#include <Security/cssmtype.h>
#include <Security/emmtype.h>
#include <Security/cssmapi.h>
#include <Security/cssmerr.h>
#include <Security/cssmapple.h>
#endif /* _CSSM_H_ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Security.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Security.framework/Headers/CMSDecoder.h | /*
* Copyright (c) 2006-2018 Apple Inc. All Rights Reserved.
*
* @APPLE_LICENSE_HEADER_START@
*
* This file contains Original Code and/or Modifications of Original Code
* as defined in and that are subject to the Apple Public Source License
* Version 2.0 (the 'License'). You may not use this file except in
* compliance with the License. Please obtain a copy of the License at
* http://www.opensource.apple.com/apsl/ and read it before using this
* file.
*
* The Original Code and all software distributed under the License are
* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
* Please see the License for the specific language governing rights and
* limitations under the License.
*
* @APPLE_LICENSE_HEADER_END@
*/
/*
* CMSDecoder.h - decode, decrypt, and/or verify signatures of messages in the
* Cryptographic Message Syntax (CMS), per RFC 3852.
*
* See CMSEncoder.h for general information about CMS messages.
*/
#ifndef _CMS_DECODER_H_
#define _CMS_DECODER_H_
#include <CoreFoundation/CoreFoundation.h>
#include <Security/SecCertificate.h>
#include <Security/SecTrust.h>
#include <AvailabilityMacros.h>
#include <stdint.h>
__BEGIN_DECLS
CF_ASSUME_NONNULL_BEGIN
/*
* Opaque reference to a CMS decoder object.
* This is a CF object, with standard CF semantics; dispose of it
* with CFRelease().
*/
typedef struct CF_BRIDGED_TYPE(id) _CMSDecoder *CMSDecoderRef;
CFTypeID CMSDecoderGetTypeID(void);
/*
* Status of signature and signer information in a signed message.
*/
typedef CF_ENUM(uint32_t, CMSSignerStatus) {
kCMSSignerUnsigned = 0, /* message was not signed */
kCMSSignerValid, /* message was signed and signature verify OK */
kCMSSignerNeedsDetachedContent, /* message was signed but needs detached content
* to verify */
kCMSSignerInvalidSignature, /* message was signed but had a signature error */
kCMSSignerInvalidCert, /* message was signed but an error occurred in verifying
* the signer's certificate */
kCMSSignerInvalidIndex /* specified signer index out of range */
};
/*
* Create a CMSDecoder. Result must eventually be freed via CFRelease().
*/
OSStatus CMSDecoderCreate(CMSDecoderRef * __nonnull CF_RETURNS_RETAINED cmsDecoderOut) /* RETURNED */
__API_AVAILABLE(macos(10.5)) API_UNAVAILABLE(ios, tvos, watchos, macCatalyst);
/*
* Feed raw bytes of the message to be decoded into the decoder. Can be called
* multiple times.
* Returns errSecUnknownFormat upon detection of improperly formatted CMS
* message.
*/
OSStatus CMSDecoderUpdateMessage(
CMSDecoderRef cmsDecoder,
const void *msgBytes,
size_t msgBytesLen)
__API_AVAILABLE(macos(10.5)) API_UNAVAILABLE(ios, tvos, watchos, macCatalyst);
/*
* Indicate that no more CMSDecoderUpdateMessage() calls are forthcoming;
* finish decoding the message.
* Returns errSecUnknownFormat upon detection of improperly formatted CMS
* message.
*/
OSStatus CMSDecoderFinalizeMessage(CMSDecoderRef cmsDecoder)
__API_AVAILABLE(macos(10.5)) API_UNAVAILABLE(ios, tvos, watchos, macCatalyst);
/*
* A signed CMS message optionally includes the data which was signed. If the
* message does not include the signed data, caller specifies the signed data
* (the "detached content") here.
*
* This can be called either before or after the actual decoding of the message
* (via CMSDecoderUpdateMessage() and CMSDecoderFinalizeMessage()); the only
* restriction is that, if detached content is required, this function must
* be called befoere successfully ascertaining the signature status via
* CMSDecoderCopySignerStatus().
*/
OSStatus CMSDecoderSetDetachedContent(
CMSDecoderRef cmsDecoder,
CFDataRef detachedContent)
__API_AVAILABLE(macos(10.5)) API_UNAVAILABLE(ios, tvos, watchos, macCatalyst);
/*
* Obtain the detached content specified in CMSDecoderSetDetachedContent().
* Returns a NULL detachedContent if no detached content has been specified.
* Caller must CFRelease() the result.
*/
OSStatus CMSDecoderCopyDetachedContent(
CMSDecoderRef cmsDecoder,
CFDataRef * __nonnull CF_RETURNS_RETAINED detachedContentOut) /* RETURNED */
__API_AVAILABLE(macos(10.5)) API_UNAVAILABLE(ios, tvos, watchos, macCatalyst);
#if SEC_OS_OSX
/*
* This function no longer affects the behavior of the CMS Decoder. Please
* discontinue use.
*/
OSStatus CMSDecoderSetSearchKeychain(
CMSDecoderRef cmsDecoder,
CFTypeRef keychainOrArray)
API_DEPRECATED_WITH_REPLACEMENT("SecKeychainSetSearchList",macos(10.5, 10.13)) API_UNAVAILABLE(ios, watchos, tvos, macCatalyst);
#endif // SEC_OS_OSX
/*
* Obtain the number of signers of a message. A result of zero indicates that
* the message was not signed.
* This cannot be called until after CMSDecoderFinalizeMessage() is called.
*/
OSStatus CMSDecoderGetNumSigners(
CMSDecoderRef cmsDecoder,
size_t *numSignersOut) /* RETURNED */
__API_AVAILABLE(macos(10.5)) API_UNAVAILABLE(ios, tvos, watchos, macCatalyst);
/*
* Obtain the status of a CMS message's signature. A CMS message can
* be signed my multiple signers; this function returns the status
* associated with signer 'n' as indicated by the signerIndex parameter.
*
* This cannot be called until after CMSDecoderFinalizeMessage() is called.
*
* Note that signature and certificate verification of a decoded message
* does *not* occur until this routine is called.
*
* All returned values are optional - pass NULL if you don't need a
* particular parameter.
*
* Note that errors like "bad signature" and "bad cert" do NOT cause this
* routine to return a nonzero error status itself; such errors are reported
* in the various out parameters, listed below.
*
* Inputs:
* -------
* cmsDecoder : a CMSDecoder which has successfully performed a
* CMSDecoderFinalizeMessage().
* signerIndex : indicates which of 'n' signers is being examined.
* Range is 0...(numSigners-1).
* policyOrArray : Either a SecPolicyRef or a CFArray of them.
* These policies are used to verify the signer's certificate.
* evaluateSecTrust : When TRUE, causes the SecTrust oebject created for the
* evaluation of the signer cert to actually be evaluated
* via SecTrustEvaluate(). When FALSE, the caller performs
* the SecTrustEvaluate() operation on the SecTrust object
* returned via the secTrust out parameter.
* NOTE: it is hazardous and not recommended to pass in FALSE
* for the evaluateSecTrust parameter as well as NULL for the
* secTrust out parameter, since no evaluation of the signer
* cert can occur in that situation.
*
* Outputs:
* --------
* signerStatusOut -- An enum indicating the overall status.
* kCMSSignerUnsigned : message was not signed.
* kCMSSignerValid : both signature and signer certificate verified OK.
* kCMSSignerNeedsDetachedContent : a call to CMSDecoderSetDetachedContent()
* is required to ascertain the signature status.
* kCMSSignerInvalidSignature : bad signature.
* kCMSSignerInvalidCert : an error occurred verifying the signer's certificate.
* Further information available via the secTrust and
* certVerifyResultCode parameters. This will never be
* returned if evaluateSecTrust is FALSE.
* kCMSSignerInvalidIndex : specified signerIndex is larger than the number of
* signers (minus 1).
*
* secTrustOut -- The SecTrust object used to verify the signer's
* certificate. Caller must CFRelease this.
* certVerifyResultCodeOut -- The result of the certificate verification. If
* the evaluateSecTrust argument is set to FALSE on
* input, this out parameter is undefined on return.
*
* The certVerifyResultCode value can indicate a large number of errors; some of
* the most common and interesting errors are:
*
* CSSMERR_TP_INVALID_ANCHOR_CERT : The cert was verified back to a
* self-signed (root) cert which was present in the message, but
* that root cert is not a known, trusted root cert.
* CSSMERR_TP_NOT_TRUSTED: The cert could not be verified back to
* a root cert.
* CSSMERR_TP_VERIFICATION_FAILURE: A root cert was found which does
* not self-verify.
* CSSMERR_TP_VERIFY_ACTION_FAILED: Indicates a failure of the requested
* policy action.
* CSSMERR_TP_INVALID_CERTIFICATE: Indicates a bad leaf cert.
* CSSMERR_TP_CERT_EXPIRED: A cert in the chain was expired at the time of
* verification.
* CSSMERR_TP_CERT_NOT_VALID_YET: A cert in the chain was not yet valie at
* the time of verification.
*/
OSStatus CMSDecoderCopySignerStatus(
CMSDecoderRef cmsDecoder,
size_t signerIndex,
CFTypeRef policyOrArray,
Boolean evaluateSecTrust,
CMSSignerStatus * __nullable signerStatusOut, /* optional; RETURNED */
SecTrustRef * __nullable CF_RETURNS_RETAINED secTrustOut, /* optional; RETURNED */
OSStatus * __nullable certVerifyResultCodeOut) /* optional; RETURNED */
__API_AVAILABLE(macos(10.5)) API_UNAVAILABLE(ios, tvos, watchos, macCatalyst);
/*
* Obtain the email address of signer 'signerIndex' of a CMS message, if
* present.
*
* Returns errSecParam if the CMS message was not signed or if signerIndex
* is greater than the number of signers of the message minus one.
*
* This cannot be called until after CMSDecoderFinalizeMessage() is called.
*/
OSStatus CMSDecoderCopySignerEmailAddress(
CMSDecoderRef cmsDecoder,
size_t signerIndex,
CFStringRef * __nonnull CF_RETURNS_RETAINED signerEmailAddressOut) /* RETURNED */
__API_AVAILABLE(macos(10.5)) API_UNAVAILABLE(ios, tvos, watchos, macCatalyst);
/*
* Obtain the certificate of signer 'signerIndex' of a CMS message, if
* present.
*
* Returns errSecParam if the CMS message was not signed or if signerIndex
* is greater than the number of signers of the message minus one.
*
* This cannot be called until after CMSDecoderFinalizeMessage() is called.
*/
OSStatus CMSDecoderCopySignerCert(
CMSDecoderRef cmsDecoder,
size_t signerIndex,
SecCertificateRef * __nonnull CF_RETURNS_RETAINED signerCertOut) /* RETURNED */
__API_AVAILABLE(macos(10.5)) API_UNAVAILABLE(ios, tvos, watchos, macCatalyst);
/*
* Determine whether a CMS message was encrypted. Returns TRUE if so, FALSE if not.
* Note that if the message was encrypted, and the decoding succeeded, (i.e.,
* CMSDecoderFinalizeMessage() returned errSecSuccess), then the message was successfully
* decrypted.
* This cannot be called until after CMSDecoderFinalizeMessage() is called.
*/
OSStatus CMSDecoderIsContentEncrypted(
CMSDecoderRef cmsDecoder,
Boolean *isEncryptedOut)
__API_AVAILABLE(macos(10.5)) API_UNAVAILABLE(ios, tvos, watchos, macCatalyst);
/*
* Obtain the eContentType OID for a SignedData's EncapsulatedContentType, if
* present. If the message was not signed this will return NULL.
* This cannot be called until after CMSDecoderFinalizeMessage() is called.
* The returned OID's data is in the same format as a CSSM_OID; i.e., it's
* the encoded content of the OID, not including the tag and length bytes.
*/
OSStatus CMSDecoderCopyEncapsulatedContentType(
CMSDecoderRef cmsDecoder,
CFDataRef * __nonnull CF_RETURNS_RETAINED eContentTypeOut) /* RETURNED */
__API_AVAILABLE(macos(10.5)) API_UNAVAILABLE(ios, tvos, watchos, macCatalyst);
/*
* Obtain an array of all of the certificates in a message. Elements of the
* returned array are SecCertificateRefs. The caller must CFRelease the returned
* array. If a message does not contain any certificates (which is the case for
* a message which is encrypted but not signed), the returned *certs value
* is NULL. The function will return errSecSuccess in this case.
* This cannot be called until after CMSDecoderFinalizeMessage() is called.
*/
OSStatus CMSDecoderCopyAllCerts(
CMSDecoderRef cmsDecoder,
CFArrayRef * __nonnull CF_RETURNS_RETAINED certsOut) /* RETURNED */
__API_AVAILABLE(macos(10.5)) API_UNAVAILABLE(ios, tvos, watchos, macCatalyst);
/*
* Obtain the actual message content (payload), if any. If the message was
* signed with detached content this will return NULL.
* Caller must CFRelease the result.
* This cannot be called until after CMSDecoderFinalizeMessage() is called.
*/
OSStatus CMSDecoderCopyContent(
CMSDecoderRef cmsDecoder,
CFDataRef * __nonnull CF_RETURNS_RETAINED contentOut) /* RETURNED */
__API_AVAILABLE(macos(10.5)) API_UNAVAILABLE(ios, tvos, watchos, macCatalyst);
/*
* Obtain the signing time of signer 'signerIndex' of a CMS message, if
* present. This is an unauthenticate time, although it is part of the
* signed attributes of the message.
*
* Returns errSecParam if the CMS message was not signed or if signerIndex
* is greater than the number of signers of the message minus one.
*
* This cannot be called until after CMSDecoderFinalizeMessage() is called.
*/
OSStatus CMSDecoderCopySignerSigningTime(
CMSDecoderRef cmsDecoder,
size_t signerIndex,
CFAbsoluteTime *signingTime) /* RETURNED */
__API_AVAILABLE(macos(10.8)) API_UNAVAILABLE(ios, tvos, watchos, macCatalyst);
/*
* Obtain the timestamp of signer 'signerIndex' of a CMS message, if
* present. This timestamp is an authenticated timestamp provided by
* a timestamping authority.
*
* Returns errSecParam if the CMS message was not signed or if signerIndex
* is greater than the number of signers of the message minus one.
*
* This cannot be called until after CMSDecoderFinalizeMessage() is called.
*/
OSStatus CMSDecoderCopySignerTimestamp(
CMSDecoderRef cmsDecoder,
size_t signerIndex,
CFAbsoluteTime *timestamp) /* RETURNED */
API_AVAILABLE(macos(10.8)) API_UNAVAILABLE(ios, watchos, tvos, macCatalyst);
/*
* Obtain the timestamp of signer 'signerIndex' of a CMS message, if
* present. This timestamp is an authenticated timestamp provided by
* a timestamping authority. Use the policy provided as a parameter
*
* Returns errSecParam if the CMS message was not signed or if signerIndex
* is greater than the number of signers of the message minus one.
*
* This cannot be called until after CMSDecoderFinalizeMessage() is called.
*/
OSStatus CMSDecoderCopySignerTimestampWithPolicy(
CMSDecoderRef cmsDecoder,
CFTypeRef __nullable timeStampPolicy,
size_t signerIndex, /* usually 0 */
CFAbsoluteTime *timestamp) /* RETURNED */
API_AVAILABLE(macos(10.10)) API_UNAVAILABLE(ios, watchos, tvos, macCatalyst);
/*
* Obtain an array of the certificates in a timestamp response. Elements of the
* returned array are SecCertificateRefs. The caller must CFRelease the returned
* array. This timestamp is an authenticated timestamp provided by
* a timestamping authority.
*
* Returns errSecParam if the CMS message was not signed or if signerIndex
* is greater than the number of signers of the message minus one. It returns
* errSecItemNotFound if no certificates were found.
*
* This cannot be called until after CMSDecoderFinalizeMessage() is called.
*/
OSStatus CMSDecoderCopySignerTimestampCertificates(
CMSDecoderRef cmsDecoder,
size_t signerIndex, /* usually 0 */
CFArrayRef * __nonnull CF_RETURNS_RETAINED certificateRefs) /* RETURNED */
API_AVAILABLE(macos(10.8)) API_UNAVAILABLE(ios, watchos, tvos, macCatalyst);
CF_ASSUME_NONNULL_END
__END_DECLS
#endif /* _CMS_DECODER_H_ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Security.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Security.framework/Headers/SecImportExport.h | /*
* Copyright (c) 2000-2011,2012-2014,2016 Apple Inc. All Rights Reserved.
*
* @APPLE_LICENSE_HEADER_START@
*
* This file contains Original Code and/or Modifications of Original Code
* as defined in and that are subject to the Apple Public Source License
* Version 2.0 (the 'License'). You may not use this file except in
* compliance with the License. Please obtain a copy of the License at
* http://www.opensource.apple.com/apsl/ and read it before using this
* file.
*
* The Original Code and all software distributed under the License are
* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
* Please see the License for the specific language governing rights and
* limitations under the License.
*
* @APPLE_LICENSE_HEADER_END@
*/
/*!
@header SecImportExport
contains import/export functionality for keys and certificates.
*/
#ifndef _SECURITY_SECIMPORTEXPORT_H_
#define _SECURITY_SECIMPORTEXPORT_H_
#include <Security/SecBase.h>
#include <CoreFoundation/CoreFoundation.h>
#include <CoreFoundation/CFBase.h>
#include <CoreFoundation/CFArray.h>
#include <CoreFoundation/CFData.h>
#include <CoreFoundation/CFDictionary.h>
#if SEC_OS_OSX
#include <Security/cssmtype.h>
#include <Security/SecAccess.h>
#include <Security/SecKeychain.h>
#include <stdint.h>
#endif /* SEC_OS_OSX */
__BEGIN_DECLS
CF_ASSUME_NONNULL_BEGIN
CF_IMPLICIT_BRIDGING_ENABLED
#if SEC_OS_OSX
/*
* Supported import/export Formats
*/
typedef CF_ENUM(uint32_t, SecExternalFormat)
{
/*
* When importing: unknown format
* When exporting: default format for item
*/
kSecFormatUnknown = 0,
/*
* Public and Private Key formats.
* Default for export is kSecFormatOpenSSL.
*/
kSecFormatOpenSSL, /* a.k.a. X509 for public keys */
kSecFormatSSH, /* OpenSSH v.1 */
kSecFormatBSAFE,
/* Symmetric Key Formats */
kSecFormatRawKey, /* raw unformatted key bits; default */
/* Formats for wrapped symmetric and private keys */
kSecFormatWrappedPKCS8,
kSecFormatWrappedOpenSSL, /* traditional openssl */
kSecFormatWrappedSSH, /* OpenSSH v.1 */
kSecFormatWrappedLSH,
/* Formats for certificates */
kSecFormatX509Cert, /* DER encoded; default */
/* Aggregate Types */
kSecFormatPEMSequence, /* sequence of certs and/or keys, implies PEM
* armour. Default format for multiple items */
kSecFormatPKCS7, /* sequence of certs */
kSecFormatPKCS12, /* set of certs and private keys */
kSecFormatNetscapeCertSequence, /* sequence of certs, form netscape-cert-sequence */
/* Added in Mac OS X 10.5 */
kSecFormatSSHv2 /* OpenSSH v.2. Note that OpenSSH v2 private keys
* are in format kSecFormatOpenSSL or
* kSecFormatWrappedOpenSSL. */
};
/*
* Indication of basic item type when importing.
*/
typedef CF_ENUM(uint32_t, SecExternalItemType) {
kSecItemTypeUnknown, /* caller doesn't know what this is */
kSecItemTypePrivateKey,
kSecItemTypePublicKey,
kSecItemTypeSessionKey,
kSecItemTypeCertificate,
kSecItemTypeAggregate /* PKCS7, PKCS12, kSecFormatPEMSequence, etc. */
};
/*
* Flags passed to SecKeychainItemExport() and SecKeychainItemImport().
*/
typedef CF_OPTIONS(uint32_t, SecItemImportExportFlags)
{
kSecItemPemArmour = 0x00000001, /* exported blob is PEM formatted */
};
/*
* SecKeyRef-specific flags, specified in SecKeyImportExportParameters.flags
*/
typedef CF_OPTIONS(uint32_t, SecKeyImportExportFlags)
{
/*
* When true, prevents the importing of more than one private key
* in a given SecKeychainItemImport().
*/
kSecKeyImportOnlyOne = 0x00000001,
/*
* When true, passphrase for import/export is obtained by user prompt
* instead of by caller-supplied data (SecKeyImportExportParameters.passphrase).
* This is the preferred method for obtaining a user-supplied passphrase
* as it avoids having the cleartext passphrase appear in the app's
* address space at any time.
*/
kSecKeySecurePassphrase = 0x00000002,
/*
* When true, imported private keys will have no Access Control List
* (ACL) attached to them. In the absence of both this bit and the accessRef
* field in SecKeyImportExportParameters (see below), imported private
* keys are given a default ACL.
*/
kSecKeyNoAccessControl = 0x00000004
};
/*
* Version of a SecKeyImportExportParameters.
*/
#define SEC_KEY_IMPORT_EXPORT_PARAMS_VERSION 0
/*
* Parameters specific to SecKeyRefs.
*/
typedef struct API_UNAVAILABLE(ios, watchos, tvos, macCatalyst)
{
/* for import and export */
uint32_t version; /* SEC_KEY_IMPORT_EXPORT_PARAMS_VERSION */
SecKeyImportExportFlags flags; /* SecKeyImportExportFlags bits */
CFTypeRef __nullable passphrase; /* kSecFormatPKCS12, kSecFormatWrapped*
* formats only. Legal types are
* CFStringRef and CFDataRef. */
CFStringRef alertTitle; /* title of secure passphrase alert panel */
CFStringRef alertPrompt; /* prompt in secure passphrase alert panel */
/* for import only */
SecAccessRef __nullable accessRef; /* specifies the initial ACL of imported
* key(s) */
CSSM_KEYUSE keyUsage; /* CSSM_KEYUSE_DECRYPT, CSSM_KEYUSE_SIGN,
* etc. */
CSSM_KEYATTR_FLAGS keyAttributes; /* CSSM_KEYATTR_PERMANENT, etc. */
} SecKeyImportExportParameters API_UNAVAILABLE(ios, watchos, tvos, macCatalyst);
typedef struct API_UNAVAILABLE(ios, watchos, tvos, macCatalyst)
{
/* for import and export */
uint32_t version; /* SEC_KEY_IMPORT_EXPORT_PARAMS_VERSION */
SecKeyImportExportFlags flags; /* SecKeyImportExportFlags bits */
CFTypeRef __nullable passphrase; /* kSecFormatPKCS12, kSecFormatWrapped*
* formats only. Legal types are
* CFStringRef and CFDataRef. */
CFStringRef __nullable alertTitle; /* title of secure passphrase alert panel */
CFStringRef __nullable alertPrompt; /* prompt in secure passphrase alert panel */
/* for import only */
SecAccessRef __nullable accessRef; /* specifies the initial ACL of imported
* key(s) */
CFArrayRef __nullable keyUsage; /* An Array containing usage attributes from SecItem.h, e.g.
* kSecAttrCanEncrypt;, kSecAttrCanDecrypt, kSecAttrCanDerive, etc.
*/
CFArrayRef __nullable keyAttributes; /* An array containing zero or more key attributes
* for an imported key. Possible values (from SecItem.h):
* kSecAttrIsPermanent, kSecAttrIsSensitive, kSecAttrIsExtractable
* Pass NULL in this field to use default attributes:
* - kSecAttrIsPermanent if a keychain is specified
* - kSecAttrIsSensitive for private keys
* - kSecAttrIsExtractable by default
*/
} SecItemImportExportKeyParameters API_UNAVAILABLE(ios, watchos, tvos, macCatalyst);
/*
* SecKeychainItemExport()
*
* This function takes one or more SecKeychainItemRefs and creates an
* external representation of the item(s) in the form of a CFDataRef.
* Caller specifies the format of the external representation via a
* SecExternalFormat enum. Caller may specify kSecFormatUnknown for
* the format, in which case a the default format for the item
* being exported is used (as described in the SecExternalFormat enums).
* PEM armouring is optional and is specified by the kSecItemPemArmour
* flag in importFlags.
*
* If exactly one item is to be exported, the keychainItemOrArray argument
* can be a SecKeychainItem. Otherwise this argument is a CFArrayRef
* containing a number of SecKeychainItems.
*
* The exported item(s) is (are) returned to the caller via the
* CFDataRef *exportedData argument. Caller must CFRelease the result.
*
* The following SecKeychainItems may be exported:
*
* SecCertificateRef
* SecKeyRef
* SecIdentityRef
*
*
* Key-related SecKeyImportExportParameters fields
* -----------------------------------------------
*
* When exporting SecKeyRefs in one of the wrapped formats
* (kSecFormatWrappedOpenSSL, kSecFormatWrappedSSH,
* kSecFormatWrappedPKCS8), or in PKCS12 format, caller must
* either explicitly specify the passphrase field or set
* the kSecKeySecurePassphrase bit in SecKeyImportExportFlags.
*
* If kSecKeySecurePassphrase is selected, caller can optionally
* specify strings for the passphrase panel's title bar and for
* the prompt which appears in the panel via the alertTitle and
* alertPrompt fields in SecKeyImportExportParameters.
*
* If an explicit passphrase is specified, note that PKCS12
* explicitly requires that passphrases are in Unicode format;
* passing in a CFStringRef as the passphrase is the safest way
* to ensure that this requirement is met (and that the result
* will be compatible with other implementations). If a CFDataRef
* is supplied as the passphrase for a PKCS12 export operation,
* the referent data is assumed to be in UTF8 form and will be
* converted as appropriate.
*
* If no key items are being exported, the keyParams argument may be NULL.
* @discussion This API has been deprecated. Please us the SecItemExport API instead.
*/
OSStatus SecKeychainItemExport(
CFTypeRef keychainItemOrArray,
SecExternalFormat outputFormat,
SecItemImportExportFlags flags, /* kSecItemPemArmour, etc. */
const SecKeyImportExportParameters * __nullable keyParams, /* optional */
CFDataRef * __nonnull CF_RETURNS_RETAINED exportedData) /* external representation returned here */
API_DEPRECATED_WITH_REPLACEMENT("SecItemExport", macos(10.0, 10.7)) API_UNAVAILABLE(ios, watchos, tvos, macCatalyst);
/*
* SecItemExport()
*
* This function takes one or more SecItemRefs and creates an
* external representation of the item(s) in the form of a CFDataRef.
* Caller specifies the format of the external representation via a
* SecExternalFormat enum. Caller may specify kSecFormatUnknown for
* the format, in which case a the default format for the item
* being exported is used (as described in the SecExternalFormat enums).
* PEM armouring is optional and is specified by the kSecItemPemArmour
* flag in importFlags.
*
* If exactly one item is to be exported, the keychainItemOrArray argument
* can be a SecKeychainItem. Otherwise this argument is a CFArrayRef
* containing a number of SecKeychainItems.
*
* The exported item(s) is (are) returned to the caller via the
* CFDataRef *exportedData argument. Caller must CFRelease the result.
*
* The following SecKeychainItems may be exported:
*
* SecCertificateRef
* SecKeyRef
* SecIdentityRef
*
*
* Key-related SecItemExport fields
* -----------------------------------------------
*
* When exporting SecKeyRefs in one of the wrapped formats
* (kSecFormatWrappedOpenSSL, kSecFormatWrappedSSH,
* kSecFormatWrappedPKCS8), or in PKCS12 format, caller must
* either explicitly specify the passphrase field or set
* the kSecKeySecurePassphrase bit in SecKeyImportExportFlags.
*
* If kSecKeySecurePassphrase is selected, caller can optionally
* specify strings for the passphrase panel's title bar and for
* the prompt which appears in the panel via the alertTitle and
* alertPrompt fields in SecItemImportExportKeyParameters.
*
* If an explicit passphrase is specified, note that PKCS12
* explicitly requires that passphrases are in Unicode format;
* passing in a CFStringRef as the passphrase is the safest way
* to ensure that this requirement is met (and that the result
* will be compatible with other implementations). If a CFDataRef
* is supplied as the passphrase for a PKCS12 export operation,
* the referent data is assumed to be in UTF8 form and will be
* converted as appropriate.
*
* If no key items are being exported, the keyParams argument may be NULL.
*
*/
OSStatus SecItemExport(
CFTypeRef secItemOrArray,
SecExternalFormat outputFormat,
SecItemImportExportFlags flags, /* kSecItemPemArmour, etc. */
const SecItemImportExportKeyParameters * __nullable keyParams, /* optional */
CFDataRef * __nonnull CF_RETURNS_RETAINED exportedData) /* external representation returned here */
API_AVAILABLE(macos(10.7), ios(NA));
/*
* SecKeychainItemImport()
*
* This function takes a CFDataRef containing the external representation
* of one or more objects and creates SecKeychainItems corresponding to
* those objects and optionally imports those SecKeychainItems into a
* specified keychain. The format of the incoming representation is
* specified by one or more of the following:
*
* -- A SecExternalFormat. This optional in/out argument is used when
* the caller knows exactly what format the external representation
* is in. It's also used to return to the caller the format which the
* function actually determines the external representation to be in.
* A value of kSecFormatUnknown is specified on entry when the caller
* wishes to know the inferred format on return.
*
* -- A SecExternalItemType - optional, in/out. Used to specify what kind
* of item is in the incoming representation, if known by the caller.
* It's also used to return to the caller the item type which the
* function actually determines the external representation to contain.
* A value of kSecItemTypeUnknown is specified on entry when the caller
* wishes to know the inferred item type on return.
*
* -- fileNameOrExtension, a CFStringRef. This optional argument contains
* the name of the file from which the external representation was
* obtained; it can also be simply an extension like CFSTR(".p7r").
* This is a convenience for apps like KeychainAccess which can import a
* number of different formats.
*
* The SecKeychainItemImport() call does its best to figure out what is
* in an incoming external item given the info provided by the above three
* arguments. In most cases, SecKeychainItemImport() can even figure out
* what's in an external item if none of these are specified, but it would
* be unwise for an application to count on that ability.
*
* PEM formatting is determined internally via inspection of the incoming
* data, so the kSecItemPemArmour in the flags field is ignored.
*
* Zero, one, or both of the following occurs upon successful completion
* of this function:
*
* -- The imported item(s) is (are) imported to the specified importKeychain.
* If importKeychain is NULL, this step does not occur.
*
* -- The imported item(s) is (are) returned to the caller via the
* CFArrayRef *outItems argument. If outItems is NULL, this step
* does not occur. If outItems is NON-NULL, then *outItems will be
* a CFArrayRef containing a number of SecKeychainItems upon return.
* Caller must CFRelease the result.
*
* The possible types of returned SecKeychainItems are:
*
* SecCertificateRef
* SecKeyRef
* SecIdentityRef
*
* Note that when importing a PKCS12 blob, typically one SecIdentityRef
* and zero or more additional SecCertificateRefs are returned in
* outItems. No SecKeyRefs will appear there unless a key
* is found in the incoming blob with does not have a matching
* certificate.
*
* A typical case in which an app specifies the outItems
* argument and a NULL for importKeychain is when the app wishes to
* perform some user interaction, perhaps on a per-item basis, before
* committing to actually import the item(s). In this case, if the app
* does wish to proceed with the import, the standard import calls
* (SecCertificateAddToKeychain(), SecKeyAddToKeychain (implementation
* TBD)) would be used.
*
* Passing in NULL for both outItems and importKeychain
* is a perfectly acceptable way of using this function to determine,
* in a non-intrusive way, what is inside a given data blob. No effect
* other than returning inputFormat and/or itemType occurs in this
* case.
*
* Key-related SecKeyImportExportParameters fields
* -----------------------------------------------
*
* If importKeychain is NULL, the kSecKeyImportOnlyOne bit in the flags
* argument is ignored. Otherwise, if the kSecKeyImportOnlyOne bit is set, and
* there is more than one key in the incoming external representation, no
* items will be imported to the specified keychain and errSecMultipleKeys will
* be returned.
*
* The accessRef field allows the caller to specify the initial SecAccessRef
* for imported private keys. If more than one private key is being imported,
* all private keys get the same initial SecAccessRef. If this field is NULL
* when private keys are being imported, then the ACL attached to imported
* private keys depends on the kSecKeyNoAccessControl bit in the specified
* keyParams->flags. If this bit is 0, or keyParams is NULL, the default ACL
* will be used. If this bit is 1, no ACL will be attached to imported
* private keys.
*
* keyUsage and keyAttributes specify the low-level usage and attribute flags
* of imported keys. Each is a word of bits. The default value for keyUsage
* (used when keyParams is NULL or if keyParams->keyUsage is zero) is
* CSSM_KEYUSE_ANY. The default value for keyAttributes defaults is
* CSSM_KEYATTR_SENSITIVE | CSSM_KEYATTR_EXTRACTABLE; the CSSM_KEYATTR_PERMANENT
* bit is also added to the default if a non-NULL importKeychain is provided.
*
* The following are valid bits in keyAttributes:
*
* CSSM_KEYATTR_PERMANENT
* CSSM_KEYATTR_SENSITIVE
* CSSM_KEYATTR_EXTRACTABLE
*
* If the CSSM_KEYATTR_PERMANENT is set then the importKeychain argument must
* be valid or errSecInvalidKeychain will be returned if in fact any keys are found
* in the external representation.
*
* Note that if the caller does not set the CSSM_KEYATTR_EXTRACTABLE, this key
* will never be able to be extracted from the keychain in any form, not even
* in wrapped form. The CSSM_KEYATTR_SENSITIVE indicates that the key can only
* be extracted in wrapped form.
*
* The CSSM_KEYATTR_RETURN_xxx bits are always forced to
* CSSM_KEYATTR_RETURN_REF regardless of the specified keyAttributes
* field.
*
* When importing SecKeyRefs in one of the wrapped formats
* (kSecFormatWrappedOpenSSL, kSecFormatWrappedSSH,
* kSecFormatWrappedPKCS8), or in PKCS12 format, caller must
* either explicitly specify the passphrase field or set
* the kSecKeySecurePassphrase bit in SecKeyImportExportFlags.
*
* If kSecKeySecurePassphrase is selected, caller can optionally
* specify strings for the passphrase panel's title bar and for
* the prompt which appears in the panel via the alertTitle and
* alertPrompt fields in SecKeyImportExportParameters.
*
* If an explicit passphrase is specified, note that PKCS12
* explicitly requires that passphrases are in Unicode format;
* passing in a CFStringRef as the passphrase is the safest way
* to ensure that this requirement is met (and that the result
* will be compatible with other implementations). If a CFDataRef
* is supplied as the passphrase for a PKCS12 export operation,
* the referent data is assumed to be in UTF8 form and will be
* converted as appropriate.
* If no key items are being imported, the keyParams argument may be NULL.
*
* The SecItemImportExportFlags argument is currently unused; caller should pass
* in 0.
*
* @discussion This API has been deprecated. Please use the SecItemImport API instead.
*/
OSStatus SecKeychainItemImport(
CFDataRef importedData,
CFStringRef __nullable fileNameOrExtension, /* optional */
SecExternalFormat * __nullable inputFormat, /* optional, IN/OUT */
SecExternalItemType * __nullable itemType, /* optional, IN/OUT */
SecItemImportExportFlags flags,
const SecKeyImportExportParameters * __nullable keyParams, /* optional */
SecKeychainRef __nullable importKeychain, /* optional */
CFArrayRef * __nullable CF_RETURNS_RETAINED outItems) /* optional */
API_DEPRECATED_WITH_REPLACEMENT("SecItemImport", macos(10.0, 10.7)) API_UNAVAILABLE(ios, watchos, tvos, macCatalyst);
/*
* SecItemImport()
*
* This function takes a CFDataRef containing the external representation
* of one or more objects and creates SecKeychainItems corresponding to
* those objects and optionally imports those SecKeychainItems into a
* specified keychain. The format of the incoming representation is
* specified by one or more of the following:
*
* -- A SecExternalFormat. This optional in/out argument is used when
* the caller knows exactly what format the external representation
* is in. It's also used to return to the caller the format which the
* function actually determines the external representation to be in.
* A value of kSecFormatUnknown is specified on entry when the caller
* wishes to know the inferred format on return.
*
* -- A SecExternalItemType - optional, in/out. Used to specify what kind
* of item is in the incoming representation, if known by the caller.
* It's also used to return to the caller the item type which the
* function actually determines the external representation to contain.
* A value of kSecItemTypeUnknown is specified on entry when the caller
* wishes to know the inferred item type on return.
*
* -- fileNameOrExtension, a CFStringRef. This optional argument contains
* the name of the file from which the external representation was
* obtained; it can also be simply an extension like CFSTR(".p7r").
* This is a convenience for apps like KeychainAccess which can import a
* number of different formats.
*
* The SecItemImport() call does its best to figure out what is
* in an incoming external item given the info provided by the above three
* arguments. In most cases, SecItemImport() can even figure out
* what's in an external item if none of these are specified, but it would
* be unwise for an application to count on that ability.
*
* PEM formatting is determined internally via inspection of the incoming
* data, so the kSecItemPemArmour in the flags field is ignored.
*
* Zero, one, or both of the following occurs upon successful completion
* of this function:
*
* -- The imported item(s) is (are) imported to the specified importKeychain.
* If importKeychain is NULL, this step does not occur.
*
* -- The imported item(s) is (are) returned to the caller via the
* CFArrayRef *outItems argument. If outItems is NULL, this step
* does not occur. If outItems is NON-NULL, then *outItems will be
* a CFArrayRef containing a number of SecKeychainItems upon return.
* Caller must CFRelease the result.
*
* The possible types of returned SecKeychainItems are:
*
* SecCertificateRef
* SecKeyRef
* SecIdentityRef
*
* Note that when importing a PKCS12 blob, typically one SecIdentityRef
* and zero or more additional SecCertificateRefs are returned in
* outItems. No SecKeyRefs will appear there unless a key
* is found in the incoming blob with does not have a matching
* certificate.
*
* A typical case in which an app specifies the outItems
* argument and a NULL for importKeychain is when the app wishes to
* perform some user interaction, perhaps on a per-item basis, before
* committing to actually import the item(s). In this case, if the app
* does wish to proceed with the import, the standard import calls
* (SecCertificateAddToKeychain(), SecKeyAddToKeychain (implementation
* TBD)) would be used.
*
* Passing in NULL for both outItems and importKeychain
* is a perfectly acceptable way of using this function to determine,
* in a non-intrusive way, what is inside a given data blob. No effect
* other than returning inputFormat and/or itemType occurs in this
* case.
*
* Key-related SecItemImportExportKeyParameters fields
* -----------------------------------------------
*
* If importKeychain is NULL, the kSecKeyImportOnlyOne bit in the flags
* argument is ignored. Otherwise, if the kSecKeyImportOnlyOne bit is set, and
* there is more than one key in the incoming external representation, no
* items will be imported to the specified keychain and errSecMultipleKeys will
* be returned.
*
* The accessRef field allows the caller to specify the initial SecAccessRef
* for imported private keys. If more than one private key is being imported,
* all private keys get the same initial SecAccessRef. If this field is NULL
* when private keys are being imported, then the ACL attached to imported
* private keys depends on the kSecKeyNoAccessControl bit in the specified
* keyParams->flags. If this bit is 0, or keyParams is NULL, the default ACL
* will be used. If this bit is 1, no ACL will be attached to imported
* private keys.
*
* keyUsage and keyAttributes specify the low-level usage and attribute flags
* of imported keys. These fields contain a CFArray whose values are constants
* from SecItem.h.
*
* Possible values in the keyUsage array:
*
* kSecAttrCanEncrypt
* kSecAttrCanDecrypt
* kSecAttrCanDerive
* kSecAttrCanSign
* kSecAttrCanVerify
* kSecAttrCanWrap
* kSecAttrCanUnwrap
*
* If keyUsage is set to NULL, then any key usage is permitted.
*
* Possible values in the keyAttributes array:
*
* kSecAttrIsPermanent
* kSecAttrIsSensitive
* kSecAttrIsExtractable
*
* If keyAttributes is set to NULL, then default values are used:
* kSecAttrIsPermanent if an import keychain is specified
* kSecAttrIsSensitive for non-public keys
* kSecAttrIsExtractable
*
* If the kSecAttrIsPermanent attribute is set, then the
* importKeychain argument must be valid or errSecInvalidKeychain
* will be returned even if keys were able to be imported.
*
* Note that if the caller provides a keyAttributes array but
* does not set kSecAttrIsExtractable, this key will never be
* able to be extracted from the keychain in any form, not even
* in wrapped form. kSecAttrIsSensitive indicates that the key
* can only be extracted in wrapped form.
*
* When importing SecKeyRefs in one of the wrapped formats
* (kSecFormatWrappedOpenSSL, kSecFormatWrappedSSH,
* kSecFormatWrappedPKCS8), or in PKCS12 format, caller must
* either explicitly specify the passphrase field or set
* the kSecKeySecurePassphrase bit in SecKeyImportExportFlags.
*
* If kSecKeySecurePassphrase is selected, caller can optionally
* specify strings for the passphrase panel's title bar and for
* the prompt which appears in the panel via the alertTitle and
* alertPrompt fields in SecItemImportExportKeyParameters.
*
* If an explicit passphrase is specified, note that PKCS12
* explicitly requires that passphrases are in Unicode format;
* passing in a CFStringRef as the passphrase is the safest way
* to ensure that this requirement is met (and that the result
* will be compatible with other implementations). If a CFDataRef
* is supplied as the passphrase for a PKCS12 export operation,
* the referent data is assumed to be in UTF8 form and will be
* converted as appropriate.
* If no key items are being imported, the keyParams argument may be NULL.
*
* The SecItemImportExportFlags argument is currently unused; caller should pass
* in 0.
*/
OSStatus SecItemImport(
CFDataRef importedData,
CFStringRef __nullable fileNameOrExtension, /* optional */
SecExternalFormat * __nullable inputFormat, /* optional, IN/OUT */
SecExternalItemType * __nullable itemType, /* optional, IN/OUT */
SecItemImportExportFlags flags,
const SecItemImportExportKeyParameters * __nullable keyParams, /* optional */
SecKeychainRef __nullable importKeychain, /* optional */
CFArrayRef * __nullable CF_RETURNS_RETAINED outItems) /* optional */
API_AVAILABLE(macos(10.7), ios(NA));
#endif /* SEC_OS_OSX */
/*!
@enum Import/Export options
@discussion Predefined key constants used when passing dictionary-based arguments to import/export functions.
@constant kSecImportExportPassphrase Specifies a passphrase represented by a CFStringRef to be used when exporting to (or importing from) PKCS#12 format.
@constant kSecImportExportKeychain On OSX, specifies a keychain represented by a SecKeychainRef to be used as the target when importing from PKCS#12 format.
@constant kSecImportExportAccess On OSX, specifies an access represented by a SecAccessRef for the initial access (ACL) of a key imported from PKCS#12 format.
*/
extern const CFStringRef kSecImportExportPassphrase
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecImportExportKeychain
API_AVAILABLE(macos(10.7), ios(NA));
extern const CFStringRef kSecImportExportAccess
API_AVAILABLE(macos(10.7), ios(NA));
/*!
@enum Import/Export item description
@discussion Predefined key constants used to pass back a CFArray with a
CFDictionary per item.
@constant kSecImportItemLabel a CFStringRef representing the item label.
This implementation specific identifier cannot be expected to have
any format.
@constant kSecImportItemKeyID a CFDataRef representing the key id. Often
the SHA-1 digest of the public key.
@constant kSecImportItemIdentity a SecIdentityRef representing the identity.
@constant kSecImportItemTrust a SecTrustRef set up with all relevant
certificates. Not guaranteed to succesfully evaluate.
@constant kSecImportItemCertChain a CFArrayRef holding all relevant
certificates for this item's identity
*/
extern const CFStringRef kSecImportItemLabel
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecImportItemKeyID
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecImportItemTrust
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecImportItemCertChain
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecImportItemIdentity
API_AVAILABLE(macos(10.6), ios(2.0));
/*!
@function SecPKCS12Import
@abstract Imports the contents of a PKCS12 formatted blob.
@param pkcs12_data The PKCS#12 formatted data to be imported.
@param options A dictionary containing import options. A
kSecImportExportPassphrase entry is required at minimum. Only password-based
PKCS12 blobs are currently supported.
@param items On return, an array containing a dictionary for every item
extracted. Use kSecImportItem constants to access specific elements of
these dictionaries. Your code must CFRelease the array when it is no longer
needed.
@result errSecSuccess in case of success. errSecDecode means either the
blob can't be read or it is malformed. errSecAuthFailed means an
incorrect password was supplied, or data in the container is damaged.
*/
OSStatus SecPKCS12Import(CFDataRef pkcs12_data, CFDictionaryRef options, CFArrayRef * __nonnull CF_RETURNS_RETAINED items)
API_AVAILABLE(macos(10.6), ios(2.0));
CF_IMPLICIT_BRIDGING_DISABLED
CF_ASSUME_NONNULL_END
__END_DECLS
#endif /* !_SECURITY_SECIMPORTEXPORT_H_ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Security.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Security.framework/Headers/SecPolicySearch.h | /*
* Copyright (c) 2002-2004,2011,2014 Apple Inc. All Rights Reserved.
*
* @APPLE_LICENSE_HEADER_START@
*
* This file contains Original Code and/or Modifications of Original Code
* as defined in and that are subject to the Apple Public Source License
* Version 2.0 (the 'License'). You may not use this file except in
* compliance with the License. Please obtain a copy of the License at
* http://www.opensource.apple.com/apsl/ and read it before using this
* file.
*
* The Original Code and all software distributed under the License are
* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
* Please see the License for the specific language governing rights and
* limitations under the License.
*
* @APPLE_LICENSE_HEADER_END@
*/
/*!
@header SecPolicySearch
The functions provided in SecPolicySearch implement a query for SecPolicy objects.
*/
#ifndef _SECURITY_SECPOLICYSEARCH_H_
#define _SECURITY_SECPOLICYSEARCH_H_
#include <Security/SecBase.h>
#include <Security/cssmtype.h>
#if defined(__cplusplus)
extern "C" {
#endif
CF_ASSUME_NONNULL_BEGIN
/*!
@typedef SecPolicySearchRef
@abstract A reference to an opaque policy search structure.
*/
typedef struct CF_BRIDGED_TYPE(id) OpaquePolicySearchRef *SecPolicySearchRef;
/*!
@function SecPolicySearchGetTypeID
@abstract Returns the type identifier of SecPolicySearch instances.
@result The CFTypeID of SecPolicySearch instances.
@discussion This API is deprecated in 10.7. The SecPolicySearchRef type is no longer used.
*/
CFTypeID SecPolicySearchGetTypeID(void)
DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER;
/*!
@function SecPolicySearchCreate
@abstract Creates a search reference for finding a policy by specifying its object identifier.
@param certType The type of certificates a policy uses.
@param policyOID A pointer to a BER-encoded policy object identifier that uniquely specifies the policy.
@param value Unused. Pass NULL for this value. Use SecPolicySetValue to set per policy data.
@param searchRef On return, a pointer to a policy search reference. The policy search reference is used for subsequent calls to the SecCopyNextPolicy function to obtain the remaining trust policies. You are responsible for releasing the search reference by calling the CFRelease function when finished with it.
@result A result code. See "Security Error Codes" (SecBase.h).
@discussion This function is deprecated in 10.7. To create a SecPolicyRef, use one of the SecPolicyCreate functions in SecPolicy.h.
*/
OSStatus SecPolicySearchCreate(CSSM_CERT_TYPE certType, const CSSM_OID *policyOID, const CSSM_DATA * __nullable value, SecPolicySearchRef * __nonnull CF_RETURNS_RETAINED searchRef)
DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER;
/*!
@function SecPolicySearchCopyNext
@abstract Finds the next policy matching the given search criteria
@param searchRef A reference to the current policy search criteria. You create the policy search reference by a calling the SecPolicySearchCreate function. You are responsible for releasing the policy by calling the CFRelease function when finished with it.
@param policyRef On return, a pointer to a policy reference.
@result A result code. When there are no more policies that match the parameters specified to SecPolicySearchCreate, errSecPolicyNotFound is returned. See "Security Error Codes" (SecBase.h).
@discussion This function is deprecated in 10.7. To create a SecPolicyRef, use one of the SecPolicyCreate functions in SecPolicy.h.
*/
OSStatus SecPolicySearchCopyNext(SecPolicySearchRef searchRef, SecPolicyRef * __nonnull CF_RETURNS_RETAINED policyRef)
DEPRECATED_IN_MAC_OS_X_VERSION_10_7_AND_LATER;
CF_ASSUME_NONNULL_END
#if defined(__cplusplus)
}
#endif
#endif /* !_SECURITY_SECPOLICY_H_ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Security.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Security.framework/Headers/SecItem.h | /*
* Copyright (c) 2006-2014 Apple Inc. All Rights Reserved.
*
* @APPLE_LICENSE_HEADER_START@
*
* This file contains Original Code and/or Modifications of Original Code
* as defined in and that are subject to the Apple Public Source License
* Version 2.0 (the 'License'). You may not use this file except in
* compliance with the License. Please obtain a copy of the License at
* http://www.opensource.apple.com/apsl/ and read it before using this
* file.
*
* The Original Code and all software distributed under the License are
* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
* Please see the License for the specific language governing rights and
* limitations under the License.
*
* @APPLE_LICENSE_HEADER_END@
*/
/*!
@header SecItem
SecItem defines CoreFoundation-based constants and functions for
access to Security items (certificates, keys, identities, and
passwords.)
*/
#ifndef _SECURITY_SECITEM_H_
#define _SECURITY_SECITEM_H_
#include <Security/SecBase.h>
#include <CoreFoundation/CFNumber.h>
#include <CoreFoundation/CFArray.h>
#include <CoreFoundation/CFDictionary.h>
__BEGIN_DECLS
CF_ASSUME_NONNULL_BEGIN
CF_IMPLICIT_BRIDGING_ENABLED
/*!
@enum Class Key Constant
@discussion Predefined key constant used to get or set item class values in
a dictionary. Its value is one of the constants defined in the Value
Constants for kSecClass.
@constant kSecClass Specifies a dictionary key whose value is the item's
class code. You use this key to get or set a value of type CFTypeRef
that contains the item class code.
*/
extern const CFStringRef kSecClass
API_AVAILABLE(macos(10.6), ios(2.0));
/*!
@enum Class Value Constants
@discussion Predefined item class constants used to get or set values in
a dictionary. The kSecClass constant is the key and its value is one
of the constants defined here. Note: on Mac OS X 10.6, only items
of class kSecClassInternetPassword are supported.
@constant kSecClassInternetPassword Specifies Internet password items.
@constant kSecClassGenericPassword Specifies generic password items.
@constant kSecClassCertificate Specifies certificate items.
@constant kSecClassKey Specifies key items.
@constant kSecClassIdentity Specifies identity items.
*/
extern const CFStringRef kSecClassInternetPassword
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecClassGenericPassword
API_AVAILABLE(macos(10.7), ios(2.0));
extern const CFStringRef kSecClassCertificate
API_AVAILABLE(macos(10.7), ios(2.0));
extern const CFStringRef kSecClassKey
API_AVAILABLE(macos(10.7), ios(2.0));
extern const CFStringRef kSecClassIdentity
API_AVAILABLE(macos(10.7), ios(2.0));
/*!
@enum Attribute Key Constants
@discussion Predefined item attribute keys used to get or set values in a
dictionary. Not all attributes apply to each item class. The table
below lists the currently defined attributes for each item class:
kSecClassGenericPassword item attributes:
kSecAttrAccess (OS X only)
kSecAttrAccessControl
kSecAttrAccessGroup (iOS; also OS X if kSecAttrSynchronizable and/or kSecUseDataProtectionKeychain set)
kSecAttrAccessible (iOS; also OS X if kSecAttrSynchronizable and/or kSecUseDataProtectionKeychain set)
kSecAttrCreationDate
kSecAttrModificationDate
kSecAttrDescription
kSecAttrComment
kSecAttrCreator
kSecAttrType
kSecAttrLabel
kSecAttrIsInvisible
kSecAttrIsNegative
kSecAttrAccount
kSecAttrService
kSecAttrGeneric
kSecAttrSynchronizable
kSecClassInternetPassword item attributes:
kSecAttrAccess (OS X only)
kSecAttrAccessControl
kSecAttrAccessGroup (iOS; also OS X if kSecAttrSynchronizable and/or kSecUseDataProtectionKeychain set)
kSecAttrAccessible (iOS; also OS X if kSecAttrSynchronizable and/or kSecUseDataProtectionKeychain set)
kSecAttrCreationDate
kSecAttrModificationDate
kSecAttrDescription
kSecAttrComment
kSecAttrCreator
kSecAttrType
kSecAttrLabel
kSecAttrIsInvisible
kSecAttrIsNegative
kSecAttrAccount
kSecAttrSecurityDomain
kSecAttrServer
kSecAttrProtocol
kSecAttrAuthenticationType
kSecAttrPort
kSecAttrPath
kSecAttrSynchronizable
kSecClassCertificate item attributes:
kSecAttrAccessible (iOS only)
kSecAttrAccessControl (iOS only)
kSecAttrAccessGroup (iOS only)
kSecAttrCertificateType
kSecAttrCertificateEncoding
kSecAttrLabel
kSecAttrSubject
kSecAttrIssuer
kSecAttrSerialNumber
kSecAttrSubjectKeyID
kSecAttrPublicKeyHash
kSecAttrSynchronizable
kSecClassKey item attributes:
kSecAttrAccess (OS X only)
kSecAttrAccessControl
kSecAttrAccessGroup (iOS; also OS X if kSecAttrSynchronizable and/or kSecUseDataProtectionKeychain set)
kSecAttrAccessible (iOS; also OS X if kSecAttrSynchronizable and/or kSecUseDataProtectionKeychain set)
kSecAttrKeyClass
kSecAttrLabel
kSecAttrApplicationLabel
kSecAttrIsPermanent
kSecAttrApplicationTag
kSecAttrKeyType
kSecAttrPRF (OS X only)
kSecAttrSalt (OS X only)
kSecAttrRounds (OS X only)
kSecAttrKeySizeInBits
kSecAttrEffectiveKeySize
kSecAttrCanEncrypt
kSecAttrCanDecrypt
kSecAttrCanDerive
kSecAttrCanSign
kSecAttrCanVerify
kSecAttrCanWrap
kSecAttrCanUnwrap
kSecAttrSynchronizable
Note that the attributes kSecAttrCan* describe attributes of the
key itself at relatively high level. Some of these attributes are
mathematical -- for example, a DSA key cannot encrypt. Others are
key-level policy issues -- for example, it is good cryptographic
hygiene to use an RSA key either for encryption or signing but not
both. Compare these to the certificate-level policy values in
SecPolicy.h.
kSecClassIdentity item attributes:
Since an identity is the combination of a private key and a
certificate, this class shares attributes of both kSecClassKey and
kSecClassCertificate.
@constant kSecAttrAccessible Specifies a dictionary key whose value
indicates when your application needs access to an item's data. You
should choose the most restrictive option that meets your application's
needs to allow the system to protect that item in the best way possible.
See the "kSecAttrAccessible Value Constants" section for a list of
values which can be specified.
IMPORTANT: This attribute is currently not supported for OS X keychain
items, unless the kSecAttrSynchronizable attribute is also present. If
both attributes are specified on either OS X or iOS, the value for the
kSecAttrAccessible key may only be one whose name does not end with
"ThisDeviceOnly", as those cannot sync to another device.
@constant kSecAttrAccessControl Specifies a dictionary key whose value
is SecAccessControl instance which contains access control conditions
for item.
IMPORTANT: This attribute is mutually exclusive with kSecAttrAccess
attribute.
@constant kSecAttrAccess Specifies a dictionary key whose value
is a SecAccessRef describing the access control settings for this item.
This key is available on OS X only.
@constant kSecAttrAccessGroup Specifies a dictionary key whose value is
a CFStringRef indicating which access group a item is in. The access
groups that a particular application has membership in are determined by
two entitlements for that application. The application-identifier
entitlement contains the application's single access group, unless
there is a keychain-access-groups entitlement present. The latter
has as its value a list of access groups; the first item in this list
is the default access group. Unless a specific access group is provided
as the value of kSecAttrAccessGroup when SecItemAdd is called, new items
are created in the application's default access group. Specifying this
attribute in SecItemCopyMatching, SecItemUpdate, or SecItemDelete calls
limits the search to the specified access group (of which the calling
application must be a member to obtain matching results.) To share
keychain items between multiple applications, each application must have
a common group listed in its keychain-access-groups entitlement, and each
must specify this shared access group name as the value for the
kSecAttrAccessGroup key in the dictionary passed to SecItem functions.
@constant kSecAttrSynchronizable Specifies a dictionary key whose value is
a CFBooleanRef indicating whether the item in question can be synchronized.
To add a new item which can be synced to other devices, or to obtain
synchronizable results from a query, supply this key with a value of
kCFBooleanTrue. If the key is not supplied, or has a value of
kCFBooleanFalse, then no synchronizable items will be added or returned.
A predefined value, kSecAttrSynchronizableAny, may be provided instead of
kCFBooleanTrue if both synchronizable and non-synchronizable results are
desired.
IMPORTANT: Specifying the kSecAttrSynchronizable key has several caveats:
- Updating or deleting items using the kSecAttrSynchronizable key will
affect all copies of the item, not just the one on your local device.
Be sure that it makes sense to use the same password on all devices
before deciding to make a password synchronizable.
- Only password items can currently be synchronized. Keychain syncing
is not supported for certificates or cryptographic keys.
- Items stored or obtained using the kSecAttrSynchronizable key cannot
specify SecAccessRef-based access control with kSecAttrAccess. If a
password is intended to be shared between multiple applications, the
kSecAttrAccessGroup key must be specified, and each application
using this password must have a 'keychain-access-groups' entitlement
with the specified access group value.
- Items stored or obtained using the kSecAttrSynchronizable key may
not also specify a kSecAttrAccessible value which is incompatible
with syncing (namely, those whose names end with "ThisDeviceOnly".)
- Items stored or obtained using the kSecAttrSynchronizable key cannot
be specified by reference. You must pass kSecReturnAttributes and/or
kSecReturnData to retrieve results; kSecReturnRef is currently not
supported for synchronizable items.
- Persistent references to synchronizable items should be avoided;
while they may work locally, they cannot be moved between devices,
and may not resolve if the item is modified on some other device.
- When specifying a query that uses the kSecAttrSynchronizable key,
search keys are limited to the item's class and attributes.
The only search constant which may be used is kSecMatchLimit; other
constants using the kSecMatch prefix are not supported at this time.
@constant kSecAttrSynchronizableAny Specifies that both synchronizable and
non-synchronizable results should be returned from this query. This may be
used as a value for the kSecAttrSynchronizable dictionary key in a call to
SecItemCopyMatching, SecItemUpdate, or SecItemDelete.
@constant kSecAttrCreationDate (read-only) Specifies a dictionary key whose
value is the item's creation date. You use this key to get a value
of type CFDateRef that represents the date the item was created.
@constant kSecAttrModificationDate (read-only) Specifies a dictionary key
whose value is the item's modification date. You use this key to get
a value of type CFDateRef that represents the last time the item was
updated.
@constant kSecAttrDescription Specifies a dictionary key whose value is
the item's description attribute. You use this key to set or get a
value of type CFStringRef that represents a user-visible string
describing this particular kind of item (e.g., "disk image password").
@constant kSecAttrComment Specifies a dictionary key whose value is the
item's comment attribute. You use this key to set or get a value of
type CFStringRef containing the user-editable comment for this item.
@constant kSecAttrCreator Specifies a dictionary key whose value is the
item's creator attribute. You use this key to set or get a value of
type CFNumberRef that represents the item's creator. This number is
the unsigned integer representation of a four-character code (e.g.,
'aCrt').
@constant kSecAttrType Specifies a dictionary key whose value is the item's
type attribute. You use this key to set or get a value of type
CFNumberRef that represents the item's type. This number is the
unsigned integer representation of a four-character code (e.g.,
'aTyp').
@constant kSecAttrLabel Specifies a dictionary key whose value is the
item's label attribute. You use this key to set or get a value of
type CFStringRef containing the user-visible label for this item.
@constant kSecAttrIsInvisible Specifies a dictionary key whose value is the
item's invisible attribute. You use this key to set or get a value
of type CFBooleanRef that indicates whether the item is invisible
(i.e., should not be displayed.)
@constant kSecAttrIsNegative Specifies a dictionary key whose value is the
item's negative attribute. You use this key to set or get a value of
type CFBooleanRef that indicates whether there is a valid password
associated with this keychain item. This is useful if your application
doesn't want a password for some particular service to be stored in
the keychain, but prefers that it always be entered by the user.
@constant kSecAttrAccount Specifies a dictionary key whose value is the
item's account attribute. You use this key to set or get a CFStringRef
that contains an account name. (Items of class
kSecClassGenericPassword, kSecClassInternetPassword have this
attribute.)
@constant kSecAttrService Specifies a dictionary key whose value is the
item's service attribute. You use this key to set or get a CFStringRef
that represents the service associated with this item. (Items of class
kSecClassGenericPassword have this attribute.)
@constant kSecAttrGeneric Specifies a dictionary key whose value is the
item's generic attribute. You use this key to set or get a value of
CFDataRef that contains a user-defined attribute. (Items of class
kSecClassGenericPassword have this attribute.)
@constant kSecAttrSecurityDomain Specifies a dictionary key whose value
is the item's security domain attribute. You use this key to set or
get a CFStringRef value that represents the Internet security domain.
(Items of class kSecClassInternetPassword have this attribute.)
@constant kSecAttrServer Specifies a dictionary key whose value is the
item's server attribute. You use this key to set or get a value of
type CFStringRef that contains the server's domain name or IP address.
(Items of class kSecClassInternetPassword have this attribute.)
@constant kSecAttrProtocol Specifies a dictionary key whose value is the
item's protocol attribute. You use this key to set or get a value of
type CFNumberRef that denotes the protocol for this item (see the
SecProtocolType enum in SecKeychainItem.h). (Items of class
kSecClassInternetPassword have this attribute.)
@constant kSecAttrAuthenticationType Specifies a dictionary key whose value
is the item's authentication type attribute. You use this key to set
or get a value of type CFNumberRef that denotes the authentication
scheme for this item (see the kSecAttrAuthenticationType value
constants below).
@constant kSecAttrPort Specifies a dictionary key whose value is the item's
port attribute. You use this key to set or get a CFNumberRef value
that represents an Internet port number. (Items of class
kSecClassInternetPassword have this attribute.)
@constant kSecAttrPath Specifies a dictionary key whose value is the item's
path attribute, typically this is the path component of the URL. You use
this key to set or get a CFStringRef value that represents a path. (Items
of class kSecClassInternetPassword have this attribute.)
@constant kSecAttrSubject (read-only) Specifies a dictionary key whose
value is the item's subject. You use this key to get a value of type
CFDataRef that contains the X.500 subject name of a certificate.
(Items of class kSecClassCertificate have this attribute.)
@constant kSecAttrIssuer (read-only) Specifies a dictionary key whose value
is the item's issuer. You use this key to get a value of type
CFDataRef that contains the X.500 issuer name of a certificate. (Items
of class kSecClassCertificate have this attribute.)
@constant kSecAttrSerialNumber (read-only) Specifies a dictionary key whose
value is the item's serial number. You use this key to get a value
of type CFDataRef that contains the serial number data of a
certificate. (Items of class kSecClassCertificate have this
attribute.)
@constant kSecAttrSubjectKeyID (read-only) Specifies a dictionary key whose
value is the item's subject key ID. You use this key to get a value
of type CFDataRef that contains the subject key ID of a certificate.
(Items of class kSecClassCertificate have this attribute.)
@constant kSecAttrPublicKeyHash (read-only) Specifies a dictionary key
whose value is the item's public key hash. You use this key to get a
value of type CFDataRef that contains the hash of a certificate's
public key. (Items of class kSecClassCertificate have this attribute.)
@constant kSecAttrCertificateType (read-only) Specifies a dictionary key
whose value is the item's certificate type. You use this key to get
a value of type CFNumberRef that denotes the certificate type
(On iOS, currently the value of this attribute must be equal to the
version of the X509 certificate. So, 1 for v1, 2 for v2, and 3 for v3
certificates). (On OSX, see the CSSM_CERT_TYPE enum in cssmtype.h).
Only items of class kSecClassCertificate have this attribute.
@constant kSecAttrCertificateEncoding (read-only) Specifies a dictionary
key whose value is the item's certificate encoding. You use this key
to get a value of type CFNumberRef that denotes the certificate
encoding (On iOS, currently only the value 3 meaning
kSecAttrCertificateEncodingDER is supported). On OSX, see the
CSSM_CERT_ENCODING enum in cssmtype.h. Only items of class
kSecClassCertificate have this attribute.
@constant kSecAttrKeyClass (read only) Specifies a dictionary key whose
value is one of kSecAttrKeyClassPublic, kSecAttrKeyClassPrivate or
kSecAttrKeyClassSymmetric.
@constant kSecAttrApplicationLabel Specifies a dictionary key whose value
is the key's application label attribute. This is different from the
kSecAttrLabel (which is intended to be human-readable). This attribute
is used to look up a key programmatically; in particular, for keys of
class kSecAttrKeyClassPublic and kSecAttrKeyClassPrivate, the value of
this attribute is the hash of the public key. This item is a type of CFDataRef.
Legacy keys may contain a UUID in this field as a CFStringRef.
@constant kSecAttrIsPermanent Specifies a dictionary key whose value is a
CFBooleanRef indicating whether the key in question will be stored
permanently.
@constant kSecAttrIsSensitive Specifies a dictionary key whose value is a
CFBooleanRef indicating that the key in question can only be exported
in a wrapped (encrypted) format. OS X only.
@constant kSecAttrIsExtractable Specifies a dictionary key whose value is a
CFBooleanRef indicating whether the key in question can be exported from
its keychain container. OS X only.
@constant kSecAttrApplicationTag Specifies a dictionary key whose value is a
CFDataRef containing private tag data.
@constant kSecAttrKeyType Specifies a dictionary key whose value is a
CFNumberRef indicating the algorithm associated with this key
(On iOS, currently only the value 42 is supported, alternatively you can use
kSecAttrKeyTypeRSA). (On OSX, see the CSSM_ALGORITHMS enum in cssmtype.h).
@constant kSecAttrPRF Specifies a dictionary key whose value is the PRF
(pseudo-random function) for this key (see "kSecAttrPRF Value Constants".)
OS X only.
@constant kSecAttrSalt Specifies a dictionary key whose value is a
CFData containing the salt to use for this key. OS X only.
@constant kSecAttrRounds Specifies a dictionary key whose value is the
number of rounds for the pseudo-random function specified by kSecAttrPRF.
OS X only.
@constant kSecAttrKeySizeInBits Specifies a dictionary key whose value
is a CFNumberRef indicating the number of bits in this key.
@constant kSecAttrEffectiveKeySize Specifies a dictionary key whose value
is a CFNumberRef indicating the effective number of bits in this key.
For example, a DES key has a kSecAttrKeySizeInBits of 64, but a
kSecAttrEffectiveKeySize of 56 bits.
@constant kSecAttrCanEncrypt Specifies a dictionary key whole value is a
CFBooleanRef indicating whether the key in question can be used to
encrypt data.
@constant kSecAttrCanDecrypt Specifies a dictionary key whose value is a
CFBooleanRef indicating whether the key in question can be used to
decrypt data.
@constant kSecAttrCanDerive Specifies a dictionary key whole value is a
CFBooleanRef indicating whether the key in question can be used to
derive another key.
@constant kSecAttrCanSign Specifies a dictionary key whole value is a
CFBooleanRef indicating whether the key in question can be used to
create a digital signature.
@constant kSecAttrCanVerify Specifies a dictionary key whole value is a
CFBooleanRef indicating whether the key in question can be used to
verify a digital signature.
@constant kSecAttrCanWrap Specifies a dictionary key whole value is a
CFBooleanRef indicating whether the key in question can be used to
wrap another key.
@constant kSecAttrCanUnwrap Specifies a dictionary key whole value is a
CFBooleanRef indicating whether the key in question can be used to
unwrap another key.
@constant kSecAttrSyncViewHint Specifies a dictionary key whose value is
a CFStringRef. This value is part of the primary key of each item, and
can be used to help distiguish Sync Views when defining their
queries. iOS and sychronizable items only.
@constant kSecAttrTokenID Specifies a dictionary key whose presence
indicates that item is backed by external token. Value of this attribute
is CFStringRef uniquely identifying containing token. When this attribute
is not present, item is stored in internal keychain database.
Note that once item is created, this attribute cannot be changed - in other
words it is not possible to migrate existing items to, from or between tokens.
Currently the only available value for this attribute is
kSecAttrTokenIDSecureEnclave, which indicates that item (private key) is
backed by device's Secure Enclave.
*/
extern const CFStringRef kSecAttrAccessible
API_AVAILABLE(macos(10.9), ios(4.0));
extern const CFStringRef kSecAttrAccess
API_AVAILABLE(macos(10.7), ios(NA));
extern const CFStringRef kSecAttrAccessControl
API_AVAILABLE(macos(10.10), ios(8.0));
extern const CFStringRef kSecAttrAccessGroup
API_AVAILABLE(macos(10.9), ios(3.0));
extern const CFStringRef kSecAttrSynchronizable
API_AVAILABLE(macos(10.9), ios(7.0));
extern const CFStringRef kSecAttrSynchronizableAny
API_AVAILABLE(macos(10.9), ios(7.0));
extern const CFStringRef kSecAttrCreationDate
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrModificationDate
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrDescription
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrComment
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrCreator
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrType
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrLabel
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrIsInvisible
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrIsNegative
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrAccount
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrService
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrGeneric
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrSecurityDomain
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrServer
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrProtocol
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrAuthenticationType
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrPort
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrPath
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrSubject
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrIssuer
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrSerialNumber
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrSubjectKeyID
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrPublicKeyHash
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrCertificateType
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrCertificateEncoding
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrKeyClass
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrApplicationLabel
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrIsPermanent
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrIsSensitive
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrIsExtractable
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrApplicationTag
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrKeyType
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrPRF
API_AVAILABLE(macos(10.7), ios(NA));
extern const CFStringRef kSecAttrSalt
API_AVAILABLE(macos(10.7), ios(NA));
extern const CFStringRef kSecAttrRounds
API_AVAILABLE(macos(10.7), ios(NA));
extern const CFStringRef kSecAttrKeySizeInBits
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrEffectiveKeySize
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrCanEncrypt
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrCanDecrypt
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrCanDerive
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrCanSign
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrCanVerify
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrCanWrap
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrCanUnwrap
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrSyncViewHint
API_AVAILABLE(macos(10.11), ios(9.0));
extern const CFStringRef kSecAttrTokenID
API_AVAILABLE(macos(10.12), ios(9.0));
extern const CFStringRef kSecAttrPersistantReference
API_AVAILABLE(macos(10.13), ios(11.0), tvos(11.0), watchos(4.0));
extern const CFStringRef kSecAttrPersistentReference
API_AVAILABLE(macos(10.13), ios(11.0), tvos(11.0), watchos(4.0));
/*!
@enum kSecAttrAccessible Value Constants
@discussion Predefined item attribute constants used to get or set values
in a dictionary. The kSecAttrAccessible constant is the key and its
value is one of the constants defined here.
When asking SecItemCopyMatching to return the item's data, the error
errSecInteractionNotAllowed will be returned if the item's data is not
available until a device unlock occurs.
@constant kSecAttrAccessibleWhenUnlocked Item data can only be accessed
while the device is unlocked. This is recommended for items that only
need be accesible while the application is in the foreground. Items
with this attribute will migrate to a new device when using encrypted
backups.
@constant kSecAttrAccessibleAfterFirstUnlock Item data can only be
accessed once the device has been unlocked after a restart. This is
recommended for items that need to be accesible by background
applications. Items with this attribute will migrate to a new device
when using encrypted backups.
@constant kSecAttrAccessibleAlways Item data can always be accessed
regardless of the lock state of the device. This is not recommended
for anything except system use. Items with this attribute will migrate
to a new device when using encrypted backups.
@constant kSecAttrAccessibleWhenPasscodeSetThisDeviceOnly Item data can
only be accessed while the device is unlocked. This is recommended for
items that only need to be accessible while the application is in the
foreground and requires a passcode to be set on the device. Items with
this attribute will never migrate to a new device, so after a backup
is restored to a new device, these items will be missing. This
attribute will not be available on devices without a passcode. Disabling
the device passcode will cause all previously protected items to
be deleted.
@constant kSecAttrAccessibleWhenUnlockedThisDeviceOnly Item data can only
be accessed while the device is unlocked. This is recommended for items
that only need be accesible while the application is in the foreground.
Items with this attribute will never migrate to a new device, so after
a backup is restored to a new device, these items will be missing.
@constant kSecAttrAccessibleAfterFirstUnlockThisDeviceOnly Item data can
only be accessed once the device has been unlocked after a restart.
This is recommended for items that need to be accessible by background
applications. Items with this attribute will never migrate to a new
device, so after a backup is restored to a new device these items will
be missing.
@constant kSecAttrAccessibleAlwaysThisDeviceOnly Item data can always
be accessed regardless of the lock state of the device. This option
is not recommended for anything except system use. Items with this
attribute will never migrate to a new device, so after a backup is
restored to a new device, these items will be missing.
*/
extern const CFStringRef kSecAttrAccessibleWhenUnlocked
API_AVAILABLE(macos(10.9), ios(4.0));
extern const CFStringRef kSecAttrAccessibleAfterFirstUnlock
API_AVAILABLE(macos(10.9), ios(4.0));
extern const CFStringRef kSecAttrAccessibleAlways
API_DEPRECATED("Use an accessibility level that provides some user protection, such as kSecAttrAccessibleAfterFirstUnlock", macos(10.9, 10.14), ios(4.0, 12.0));
extern const CFStringRef kSecAttrAccessibleWhenPasscodeSetThisDeviceOnly
API_AVAILABLE(macos(10.10), ios(8.0));
extern const CFStringRef kSecAttrAccessibleWhenUnlockedThisDeviceOnly
API_AVAILABLE(macos(10.9), ios(4.0));
extern const CFStringRef kSecAttrAccessibleAfterFirstUnlockThisDeviceOnly
API_AVAILABLE(macos(10.9), ios(4.0));
extern const CFStringRef kSecAttrAccessibleAlwaysThisDeviceOnly
API_DEPRECATED("Use an accessibility level that provides some user protection, such as kSecAttrAccessibleAfterFirstUnlockThisDeviceOnly", macos(10.9, 10.14), ios(4.0, 12.0));
/*!
@enum kSecAttrProtocol Value Constants
@discussion Predefined item attribute constants used to get or set values
in a dictionary. The kSecAttrProtocol constant is the key and its
value is one of the constants defined here.
@constant kSecAttrProtocolFTP.
@constant kSecAttrProtocolFTPAccount.
@constant kSecAttrProtocolHTTP.
@constant kSecAttrProtocolIRC.
@constant kSecAttrProtocolNNTP.
@constant kSecAttrProtocolPOP3.
@constant kSecAttrProtocolSMTP.
@constant kSecAttrProtocolSOCKS.
@constant kSecAttrProtocolIMAP.
@constant kSecAttrProtocolLDAP.
@constant kSecAttrProtocolAppleTalk.
@constant kSecAttrProtocolAFP.
@constant kSecAttrProtocolTelnet.
@constant kSecAttrProtocolSSH.
@constant kSecAttrProtocolFTPS.
@constant kSecAttrProtocolHTTPS.
@constant kSecAttrProtocolHTTPProxy.
@constant kSecAttrProtocolHTTPSProxy.
@constant kSecAttrProtocolFTPProxy.
@constant kSecAttrProtocolSMB.
@constant kSecAttrProtocolRTSP.
@constant kSecAttrProtocolRTSPProxy.
@constant kSecAttrProtocolDAAP.
@constant kSecAttrProtocolEPPC.
@constant kSecAttrProtocolIPP.
@constant kSecAttrProtocolNNTPS.
@constant kSecAttrProtocolLDAPS.
@constant kSecAttrProtocolTelnetS.
@constant kSecAttrProtocolIMAPS.
@constant kSecAttrProtocolIRCS.
@constant kSecAttrProtocolPOP3S.
*/
extern const CFStringRef kSecAttrProtocolFTP
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrProtocolFTPAccount
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrProtocolHTTP
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrProtocolIRC
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrProtocolNNTP
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrProtocolPOP3
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrProtocolSMTP
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrProtocolSOCKS
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrProtocolIMAP
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrProtocolLDAP
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrProtocolAppleTalk
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrProtocolAFP
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrProtocolTelnet
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrProtocolSSH
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrProtocolFTPS
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrProtocolHTTPS
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrProtocolHTTPProxy
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrProtocolHTTPSProxy
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrProtocolFTPProxy
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrProtocolSMB
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrProtocolRTSP
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrProtocolRTSPProxy
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrProtocolDAAP
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrProtocolEPPC
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrProtocolIPP
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrProtocolNNTPS
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrProtocolLDAPS
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrProtocolTelnetS
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrProtocolIMAPS
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrProtocolIRCS
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrProtocolPOP3S
API_AVAILABLE(macos(10.6), ios(2.0));
/*!
@enum kSecAttrAuthenticationType Value Constants
@discussion Predefined item attribute constants used to get or set values
in a dictionary. The kSecAttrAuthenticationType constant is the key
and its value is one of the constants defined here.
@constant kSecAttrAuthenticationTypeNTLM.
@constant kSecAttrAuthenticationTypeMSN.
@constant kSecAttrAuthenticationTypeDPA.
@constant kSecAttrAuthenticationTypeRPA.
@constant kSecAttrAuthenticationTypeHTTPBasic.
@constant kSecAttrAuthenticationTypeHTTPDigest.
@constant kSecAttrAuthenticationTypeHTMLForm.
@constant kSecAttrAuthenticationTypeDefault.
*/
extern const CFStringRef kSecAttrAuthenticationTypeNTLM
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrAuthenticationTypeMSN
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrAuthenticationTypeDPA
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrAuthenticationTypeRPA
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrAuthenticationTypeHTTPBasic
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrAuthenticationTypeHTTPDigest
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrAuthenticationTypeHTMLForm
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecAttrAuthenticationTypeDefault
API_AVAILABLE(macos(10.6), ios(2.0));
/*!
@enum kSecAttrKeyClass Value Constants
@discussion Predefined item attribute constants used to get or set values
in a dictionary. The kSecAttrKeyClass constant is the key
and its value is one of the constants defined here.
@constant kSecAttrKeyClassPublic.
@constant kSecAttrKeyClassPrivate.
@constant kSecAttrKeyClassSymmetric.
*/
extern const CFStringRef kSecAttrKeyClassPublic
API_AVAILABLE(macos(10.7), ios(2.0));
extern const CFStringRef kSecAttrKeyClassPrivate
API_AVAILABLE(macos(10.7), ios(2.0));
extern const CFStringRef kSecAttrKeyClassSymmetric
API_AVAILABLE(macos(10.7), ios(2.0));
/*!
@enum kSecAttrKeyType Value Constants
@discussion Predefined item attribute constants used to get or set values
in a dictionary. The kSecAttrKeyType constant is the key
and its value is one of the constants defined here.
@constant kSecAttrKeyTypeECSECPrimeRandom. The used curve is P-192, P-256, P-384 or P-521.
The size is specified by kSecAttrKeySizeInBits attribute. Curves are defined in FIPS PUB 186-4 standard.
@constant kSecAttrKeyTypeEC This is the legacy name for kSecAttrKeyTypeECSECPrimeRandom, new applications should not use it.
@constant kSecAttrKeyTypeDSA (OSX only)
@constant kSecAttrKeyTypeAES (OSX only)
@constant kSecAttrKeyType3DES (OSX only)
@constant kSecAttrKeyTypeRC4 (OSX only)
@constant kSecAttrKeyTypeRC2 (OSX only)
@constant kSecAttrKeyTypeCAST (OSX only)
@constant kSecAttrKeyTypeECDSA (deprecated; use kSecAttrKeyTypeECSECPrimeRandom instead.) (OSX only)
*/
extern const CFStringRef kSecAttrKeyTypeRSA
API_AVAILABLE(macos(10.7), ios(2.0));
extern const CFStringRef kSecAttrKeyTypeDSA
API_AVAILABLE(macos(10.7), ios(NA));
extern const CFStringRef kSecAttrKeyTypeAES
API_AVAILABLE(macos(10.7), ios(NA));
extern const CFStringRef kSecAttrKeyTypeDES
API_AVAILABLE(macos(10.7), ios(NA));
extern const CFStringRef kSecAttrKeyType3DES
API_AVAILABLE(macos(10.7), ios(NA));
extern const CFStringRef kSecAttrKeyTypeRC4
API_AVAILABLE(macos(10.7), ios(NA));
extern const CFStringRef kSecAttrKeyTypeRC2
API_AVAILABLE(macos(10.7), ios(NA));
extern const CFStringRef kSecAttrKeyTypeCAST
API_AVAILABLE(macos(10.7), ios(NA));
extern const CFStringRef kSecAttrKeyTypeECDSA
API_AVAILABLE(macos(10.7), ios(NA));
extern const CFStringRef kSecAttrKeyTypeEC
API_AVAILABLE(macos(10.9), ios(4.0));
extern const CFStringRef kSecAttrKeyTypeECSECPrimeRandom
API_AVAILABLE(macos(10.12), ios(10.0));
/*
@enum kSecAttrPRF Value Constants
@discussion Predefined item attribute constants used to specify the PRF
to use with SecKeyDeriveFromPassword. OS X only.
@constant kSecAttrPRFHmacAlgSHA1
@constant kSecAttrPRFHmacAlgSHA224
@constant kSecAttrPRFHmacAlgSHA256
@constant kSecAttrPRFHmacAlgSHA384
@constant kSecAttrPRFHmacAlgSHA512
*/
extern const CFStringRef kSecAttrPRFHmacAlgSHA1
API_AVAILABLE(macos(10.7), ios(NA));
extern const CFStringRef kSecAttrPRFHmacAlgSHA224
API_AVAILABLE(macos(10.7), ios(NA));
extern const CFStringRef kSecAttrPRFHmacAlgSHA256
API_AVAILABLE(macos(10.7), ios(NA));
extern const CFStringRef kSecAttrPRFHmacAlgSHA384
API_AVAILABLE(macos(10.7), ios(NA));
extern const CFStringRef kSecAttrPRFHmacAlgSHA512
API_AVAILABLE(macos(10.7), ios(NA));
/*!
@enum Search Constants
@discussion Predefined search constants used to set values in a query
dictionary. You can specify a combination of search attributes and
item attributes when looking for matching items with the
SecItemCopyMatching function.
@constant kSecMatchPolicy Specifies a dictionary key whose value is a
SecPolicyRef. If provided, returned certificates or identities must
verify with this policy.
@constant kSecMatchItemList OS X only. Specifies a dictionary key whose value is a
CFArray of SecKeychainItemRef items. If provided, returned items will be
limited to the subset which are contained in this list.
@constant kSecMatchSearchList Specifies a dictionary key whose value is a
CFArray of SecKeychainRef items. If provided, the search will be limited
to the keychains contained in this list.
@constant kSecMatchIssuers Specifies a dictionary key whose value is a
CFArray of X.500 names (of type CFDataRef). If provided, returned
certificates or identities will be limited to those whose
certificate chain contains one of the issuers provided in this list.
@constant kSecMatchEmailAddressIfPresent Specifies a dictionary key whose
value is a CFStringRef containing an RFC822 email address. If
provided, returned certificates or identities will be limited to those
that contain the address, or do not contain any email address.
@constant kSecMatchSubjectContains Specifies a dictionary key whose value
is a CFStringRef. If provided, returned certificates or identities
will be limited to those containing this string in the subject.
@constant kSecMatchSubjectStartsWith OS X only. Specifies a dictionary key whose value
is a CFStringRef. If provided, returned certificates or identities
will be limited to those with subject names that start with this string.
@constant kSecMatchSubjectEndsWith OS X only. Specifies a dictionary key whose value
is a CFStringRef. If provided, returned certificates or identities
will be limited to those with subject names that end with this string.
@constant kSecMatchSubjectWholeString OS X only. Specifies a dictionary key whose
value is a CFStringRef. If provided, returned certificates or identities
will be limited to those matching this string exactly in the subject.
@constant kSecMatchCaseInsensitive Specifies a dictionary key whose value
is a CFBooleanRef. If this value is kCFBooleanFalse, or is not
provided, then case-sensitive string matching is performed.
@constant kSecMatchDiacriticInsensitive OS X only. Specifies a dictionary key whose
value is a CFBooleanRef. If this value is kCFBooleanFalse, or is not
provided, then diacritic-sensitive string matching is performed.
@constant kSecMatchWidthInsensitive OS X only. Specifies a dictionary key whose
value is a CFBooleanRef. If this value is kCFBooleanFalse, or is not
provided, then string matching is width-sensitive (e.g. 'a' != 0xFF41).
@constant kSecMatchTrustedOnly Specifies a dictionary key whose value is
a CFBooleanRef. If provided with a value of kCFBooleanTrue, only
certificates which can be verified back to a trusted anchor will be
returned. If this value is kCFBooleanFalse, or is not provided, then
both trusted and untrusted certificates may be returned.
@constant kSecMatchValidOnDate Specifies a dictionary key whose value is
of type CFDateRef. If provided, returned keys, certificates or
identities will be limited to those which are valid for the given date.
Pass a value of kCFNull to indicate the current date.
@constant kSecMatchLimit Specifies a dictionary key whose value is a
CFNumberRef. If provided, this value specifies the maximum number of
results to return. If not provided, results are limited to the first
item found. Predefined values are provided for a single item
(kSecMatchLimitOne) and all matching items (kSecMatchLimitAll).
@constant kSecMatchLimitOne Specifies that results are limited to the first
item found; used as a value for the kSecMatchLimit dictionary key.
@constant kSecMatchLimitAll Specifies that an unlimited number of results
may be returned; used as a value for the kSecMatchLimit dictionary
key.
*/
extern const CFStringRef kSecMatchPolicy
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecMatchItemList
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecMatchSearchList
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecMatchIssuers
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecMatchEmailAddressIfPresent
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecMatchSubjectContains
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecMatchSubjectStartsWith
API_AVAILABLE(macos(10.7), ios(NA));
extern const CFStringRef kSecMatchSubjectEndsWith
API_AVAILABLE(macos(10.7), ios(NA));
extern const CFStringRef kSecMatchSubjectWholeString
API_AVAILABLE(macos(10.7), ios(NA));
extern const CFStringRef kSecMatchCaseInsensitive
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecMatchDiacriticInsensitive
API_AVAILABLE(macos(10.7), ios(NA));
extern const CFStringRef kSecMatchWidthInsensitive
API_AVAILABLE(macos(10.7), ios(NA));
extern const CFStringRef kSecMatchTrustedOnly
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecMatchValidOnDate
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecMatchLimit
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecMatchLimitOne
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecMatchLimitAll
API_AVAILABLE(macos(10.6), ios(2.0));
/*!
@enum Return Type Key Constants
@discussion Predefined return type keys used to set values in a dictionary.
You use these keys to specify the type of results which should be
returned by the SecItemCopyMatching or SecItemAdd function. You can
specify zero or more of these return types. If more than one of these
result types is specified, the result is returned as a CFDictionaryRef
whose keys are the result types and values are the requested data.
@constant kSecReturnData Specifies a dictionary key whose value is of type
CFBooleanRef. A value of kCFBooleanTrue indicates that the data of
an item (CFDataRef) should be returned. For keys and password
items, data is secret (encrypted) and may require the user to enter
a password for access.
@constant kSecReturnAttributes Specifies a dictionary key whose value is
of type CFBooleanRef. A value of kCFBooleanTrue indicates that the
(non-encrypted) attributes of an item (CFDictionaryRef) should be
returned.
@constant kSecReturnRef Specifies a dictionary key whose value is a
CFBooleanRef. A value of kCFBooleanTrue indicates that a reference
should be returned. Depending on the item class requested, the
returned reference(s) may be of type SecKeychainItemRef, SecKeyRef,
SecCertificateRef, or SecIdentityRef.
@constant kSecReturnPersistentRef Specifies a dictionary key whose value
is of type CFBooleanRef. A value of kCFBooleanTrue indicates that a
persistent reference to an item (CFDataRef) should be returned.
*/
extern const CFStringRef kSecReturnData
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecReturnAttributes
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecReturnRef
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecReturnPersistentRef
API_AVAILABLE(macos(10.6), ios(2.0));
/*!
@enum Value Type Key Constants
@discussion Predefined value type keys used to pass values in a dictionary.
You can specify zero or more of these types depending on the function
you are calling. For SecItemCopyMatching or SecItemAdd these are
used as keys in the results dictionary.
@constant kSecValueData Specifies a dictionary key whose value is of type
CFDataRef. For keys and password items, data is secret (encrypted)
and may require the user to enter a password for access.
@constant kSecValueRef Specifies a dictionary key whose value, depending
on the item class requested, is of type SecKeychainItemRef, SecKeyRef,
SecCertificateRef, or SecIdentityRef.
@constant kSecValuePersistentRef Specifies a dictionary key whose value
is of type CFDataRef. The bytes in this CFDataRef can be stored by
the caller and used on a subsequent invocation of the application (or
even a different application) to retrieve the item referenced by it.
*/
extern const CFStringRef kSecValueData
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecValueRef
API_AVAILABLE(macos(10.6), ios(2.0));
extern const CFStringRef kSecValuePersistentRef
API_AVAILABLE(macos(10.6), ios(2.0));
/*!
@enum Other Constants
@discussion Predefined constants used to set values in a dictionary.
@constant kSecUseItemList Specifies a dictionary key whose value is a
CFArray of items. If provided, this array is treated as the set of
all possible items to search, or add if the API being called is
SecItemAdd. The items in this array may be of type SecKeyRef,
SecCertificateRef, SecIdentityRef, or CFDataRef (for a persistent
item reference.) The items in the array must all be of the same
type. When this attribute is provided, no keychains are searched.
@constant kSecUseKeychain OS X only. Specifies a dictionary key whose value is a
keychain reference. You use this key to specify a value of type
SecKeychainRef to which SecItemAdd will add the provided item(s).
@constant kSecUseOperationPrompt Specifies a dictionary key whose value
is a CFStringRef that represents a user-visible string describing
the operation for which the application is attempting to authenticate.
The application is responsible for the text localization.
@constant kSecUseNoAuthenticationUI OS X only. Specifies a dictionary key whose value
is a CFBooleanRef. If provided with a value of kCFBooleanTrue, the error
errSecInteractionNotAllowed will be returned if the item is attempting
to authenticate with UI.
@constant kSecUseAuthenticationUI Specifies a dictionary key whose value
is one of kSecUseAuthenticationUIAllow, kSecUseAuthenticationUIFail, kSecUseAuthenticationUISkip.
@constant kSecUseAuthenticationContext Specifies a dictionary key whose value
is LAContext to be used for keychain item authentication.
* If the item requires authentication and this key is omitted, a new context
will be created just for the purpose of the single call.
* If the specified context has been previously authenticated, the operation
will succeed without asking user for authentication.
* If the specified context has not been previously authenticated, the new
authentication will be started on this context, allowing caller to
eventually reuse the successfully authenticated context in subsequent
keychain operations.
@constant kSecUseDataProtectionKeychain Specifies a dictionary key whose value
is a CFBooleanRef. Set to kCFBooleanTrue to use kSecAttrAccessGroup and/or
kSecAttrAccessible on macOS without requiring the item to be marked synchronizable.
*/
extern const CFStringRef kSecUseItemList
API_AVAILABLE(macos(10.6))
API_DEPRECATED("Not implemented on this platform", ios(2.0, 12.0), tvos(9.0, 12.0), watchos(1.0, 5.0), macCatalyst(13.0, 13.0))
;
extern const CFStringRef kSecUseKeychain
API_AVAILABLE(macos(10.7), ios(NA));
extern const CFStringRef kSecUseOperationPrompt
API_DEPRECATED("Use kSecUseAuthenticationContext and set LAContext.localizedReason property", macos(10.10, 11.0), ios(8.0, 14.0));
extern const CFStringRef kSecUseNoAuthenticationUI
API_DEPRECATED("Use kSecUseAuthenticationUI instead.", macos(10.10, 10.11), ios(8.0, 9.0));
extern const CFStringRef kSecUseAuthenticationUI
API_AVAILABLE(macos(10.11), ios(9.0));
extern const CFStringRef kSecUseAuthenticationContext
API_AVAILABLE(macos(10.11), ios(9.0));
extern const CFStringRef kSecUseDataProtectionKeychain
API_AVAILABLE(macos(10.15), ios(13.0));
/*!
@enum kSecUseAuthenticationUI Value Constants
@discussion Predefined item attribute constants used to get or set values
in a dictionary. The kSecUseAuthenticationUI constant is the key and its
value is one of the constants defined here.
If the key kSecUseAuthenticationUI not provided then kSecUseAuthenticationUIAllow
is used as default.
@constant kSecUseAuthenticationUIAllow Specifies that authenticate UI can appear.
@constant kSecUseAuthenticationUIFail Specifies that the error
errSecInteractionNotAllowed will be returned if an item needs
to authenticate with UI
@constant kSecUseAuthenticationUIAllowSkip Specifies that all items which need
to authenticate with UI will be silently skipped. This value can be used
only with SecItemCopyMatching.
*/
extern const CFStringRef kSecUseAuthenticationUIAllow
API_DEPRECATED("Instead of kSecUseAuthenticationUI, use kSecUseAuthenticationContext and set LAContext.interactionNotAllowed property", macos(10.11, 11.0), ios(9.0, 14.0));
extern const CFStringRef kSecUseAuthenticationUIFail
API_DEPRECATED("Instead of kSecUseAuthenticationUI, use kSecUseAuthenticationContext and set LAContext.interactionNotAllowed property", macos(10.11, 11.0), ios(9.0, 14.0));
extern const CFStringRef kSecUseAuthenticationUISkip
API_AVAILABLE(macos(10.11), ios(9.0));
/*!
@enum kSecAttrTokenID Value Constants
@discussion Predefined item attribute constant used to get or set values
in a dictionary. The kSecAttrTokenID constant is the key and its value
can be kSecAttrTokenIDSecureEnclave.
@constant kSecAttrTokenIDSecureEnclave Specifies well-known identifier of the
token implemented using device's Secure Enclave. The only keychain items
supported by the Secure Enclave token are 256-bit elliptic curve keys
(kSecAttrKeyTypeECSecPrimeRandom). Keys must be generated on the secure enclave using
SecKeyGenerateKeyPair call with kSecAttrTokenID set to
kSecAttrTokenIDSecureEnclave in the parameters dictionary, it is not
possible to import pregenerated keys to kSecAttrTokenIDSecureEnclave token.
*/
extern const CFStringRef kSecAttrTokenIDSecureEnclave
API_AVAILABLE(macos(10.12), ios(9.0));
/*!
@enum kSecAttrAccessGroup Value Constants
@constant kSecAttrAccessGroupToken Represents well-known access group
which contains items provided by external token (typically smart card).
This may be used as a value for kSecAttrAccessGroup attribute. Every
application has access to this access group so it is not needed to
explicitly list it in keychain-access-groups entitlement, but application
must explicitly state this access group in keychain queries in order to
be able to access items from external tokens.
*/
extern const CFStringRef kSecAttrAccessGroupToken
API_AVAILABLE(macos(10.12), ios(10.0));
/*!
@function SecItemCopyMatching
@abstract Returns one or more items which match a search query.
@param query A dictionary containing an item class specification and
optional attributes for controlling the search. See the "Keychain
Search Attributes" section for a description of currently defined
search attributes.
@param result On return, a CFTypeRef reference to the found item(s). The
exact type of the result is based on the search attributes supplied
in the query, as discussed below.
@result A result code. See "Security Error Codes" (SecBase.h).
@discussion Attributes defining a search are specified by adding key/value
pairs to the query dictionary.
A typical query consists of:
* a kSecClass key, whose value is a constant from the Class
Constants section that specifies the class of item(s) to be searched
* one or more keys from the "Attribute Key Constants" section, whose value
is the attribute data to be matched
* one or more keys from the "Search Constants" section, whose value is
used to further refine the search
* a key from the "Return Type Key Constants" section, specifying the type of
results desired
Result types are specified as follows:
* To obtain the data of a matching item (CFDataRef), specify
kSecReturnData with a value of kCFBooleanTrue.
* To obtain the attributes of a matching item (CFDictionaryRef), specify
kSecReturnAttributes with a value of kCFBooleanTrue.
* To obtain a reference to a matching item (SecKeychainItemRef,
SecKeyRef, SecCertificateRef, or SecIdentityRef), specify kSecReturnRef
with a value of kCFBooleanTrue.
* To obtain a persistent reference to a matching item (CFDataRef),
specify kSecReturnPersistentRef with a value of kCFBooleanTrue. Note
that unlike normal references, a persistent reference may be stored
on disk or passed between processes.
* If more than one of these result types is specified, the result is
returned as a CFDictionaryRef containing all the requested data.
* If a result type is not specified, no results are returned.
By default, this function returns only the first match found. To obtain
more than one matching item at a time, specify kSecMatchLimit with a value
greater than 1. The result will be a CFArrayRef containing up to that
number of matching items; the items' types are described above.
To filter a provided list of items down to those matching the query,
specify a kSecMatchItemList whose value is a CFArray of SecKeychainItemRef,
SecKeyRef, SecCertificateRef, or SecIdentityRef items. The objects in the
provided array must be of the same type.
On iOS, to convert from a persistent item reference to a normal item reference,
specify a kSecValuePersistentRef whose value a CFDataRef (the persistent
reference), and a kSecReturnRef whose value is kCFBooleanTrue.
On OSX, to convert from persistent item references to normal item references,
specify a kSecMatchItemList whose value is a CFArray containing one or
more CFDataRef elements (the persistent reference), and a kSecReturnRef
whose value is kCFBooleanTrue. The objects in the provided array must be
of the same type.
*/
OSStatus SecItemCopyMatching(CFDictionaryRef query, CFTypeRef * __nullable CF_RETURNS_RETAINED result)
API_AVAILABLE(macos(10.6), ios(2.0));
/*!
@function SecItemAdd
@abstract Add one or more items to a keychain.
@param attributes A dictionary containing an item class specification and
optional entries specifying the item's attribute values. See the
"Attribute Key Constants" section for a description of currently defined
attributes.
@param result On return, a CFTypeRef reference to the newly added item(s).
The exact type of the result is based on the values supplied
in attributes, as discussed below. Pass NULL if this result is not
required.
@result A result code. See "Security Error Codes" (SecBase.h).
@discussion Attributes defining an item are specified by adding key/value
pairs to the attributes dictionary. To add multiple items to a keychain
at once use the kSecUseItemList key with an array of items as its value.
This is currently only supported for non password items.
On OSX, To add an item to a particular keychain, supply kSecUseKeychain
with a SecKeychainRef as its value.
Result types are specified as follows:
* To obtain the data of the added item (CFDataRef), specify
kSecReturnData with a value of kCFBooleanTrue.
* To obtain all the attributes of the added item (CFDictionaryRef),
specify kSecReturnAttributes with a value of kCFBooleanTrue.
* To obtain a reference to the added item (SecKeychainItemRef, SecKeyRef,
SecCertiicateRef, or SecIdentityRef), specify kSecReturnRef with a
value of kCFBooleanTrue.
* To obtain a persistent reference to the added item (CFDataRef), specify
kSecReturnPersistentRef with a value of kCFBooleanTrue. Note that
unlike normal references, a persistent reference may be stored on disk
or passed between processes.
* If more than one of these result types is specified, the result is
returned as a CFDictionaryRef containing all the requested data.
* On iOS, if a result type is not specified, no results are returned.
On OSX, the added item is returned.
*/
OSStatus SecItemAdd(CFDictionaryRef attributes, CFTypeRef * __nullable CF_RETURNS_RETAINED result)
API_AVAILABLE(macos(10.6), ios(2.0));
/*!
@function SecItemUpdate
@abstract Modify zero or more items which match a search query.
@param query A dictionary containing an item class specification and
optional attributes for controlling the search. See the "Attribute
Constants" and "Search Constants" sections for a description of
currently defined search attributes.
@param attributesToUpdate A dictionary containing one or more attributes
whose values should be set to the ones specified. Only real keychain
attributes are permitted in this dictionary (no "meta" attributes are
allowed.) See the "Attribute Key Constants" section for a description of
currently defined value attributes.
@result A result code. See "Security Error Codes" (SecBase.h).
@discussion Attributes defining a search are specified by adding key/value
pairs to the query dictionary.
*/
OSStatus SecItemUpdate(CFDictionaryRef query, CFDictionaryRef attributesToUpdate)
API_AVAILABLE(macos(10.6), ios(2.0));
/*!
@function SecItemDelete
@abstract Delete zero or more items which match a search query.
@param query A dictionary containing an item class specification and
optional attributes for controlling the search. See the "Attribute
Constants" and "Search Constants" sections for a description of
currently defined search attributes.
@result A result code. See "Security Error Codes" (SecBase.h).
@discussion Attributes defining a search are specified by adding key/value
pairs to the query dictionary.
By default, this function deletes all items matching the specified query.
You can change this behavior by specifying one of the follow keys:
* To delete an item identified by a transient reference, on iOS, specify
kSecValueRef with a item reference. On OS X, give a kSecMatchItemList
containing an item reference.
* To delete an item identified by a persistent reference, on iOS, specify
kSecValuePersistentRef with a persistent reference returned by
using the kSecReturnPersistentRef key to SecItemCopyMatching or
SecItemAdd. on OSX, use kSecMatchItemList with a persistent reference
returned by using the kSecReturnPersistentRef key with
SecItemCopyMatching or SecItemAdd.
* To delete multiple items specify kSecMatchItemList with an array
of references.
* If more than one of these result keys is specified, the behavior is
undefined.
*/
OSStatus SecItemDelete(CFDictionaryRef query)
API_AVAILABLE(macos(10.6), ios(2.0));
CF_IMPLICIT_BRIDGING_DISABLED
CF_ASSUME_NONNULL_END
__END_DECLS
#endif /* !_SECURITY_SECITEM_H_ */
|
0 | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Security.framework | repos/simulations/libs/system-sdk/macos12/System/Library/Frameworks/Security.framework/Headers/SecTask.h | /*
* Copyright (c) 2008,2012-2016 Apple Inc. All Rights Reserved.
*
* @APPLE_LICENSE_HEADER_START@
*
* This file contains Original Code and/or Modifications of Original Code
* as defined in and that are subject to the Apple Public Source License
* Version 2.0 (the 'License'). You may not use this file except in
* compliance with the License. Please obtain a copy of the License at
* http://www.opensource.apple.com/apsl/ and read it before using this
* file.
*
* The Original Code and all software distributed under the License are
* distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
* EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
* INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
* Please see the License for the specific language governing rights and
* limitations under the License.
*
* @APPLE_LICENSE_HEADER_END@
*/
#ifndef _SECURITY_SECTASK_H_
#define _SECURITY_SECTASK_H_
#include <Security/SecBase.h>
#include <CoreFoundation/CoreFoundation.h>
#include <mach/message.h>
#include <sys/cdefs.h>
#if SEC_OS_OSX
#include <Security/SecCode.h>
#endif /* SEC_OS_OSX */
__BEGIN_DECLS
CF_ASSUME_NONNULL_BEGIN
CF_IMPLICIT_BRIDGING_ENABLED
/*!
@typedef SecTaskRef
@abstract CFType used for representing a task
*/
typedef struct CF_BRIDGED_TYPE(id) __SecTask *SecTaskRef;
/*!
@function SecTaskGetTypeID
@abstract Returns the type ID for CF instances of SecTask.
@result A CFTypeID for SecTask
*/
CFTypeID SecTaskGetTypeID(void);
/*!
@function SecTaskCreateWithAuditToken
@abstract Create a SecTask object for the task that sent the mach message
represented by the audit token.
@param token The audit token of a mach message
@result The newly created SecTask object or NULL on error. The caller must
CFRelease the returned object.
*/
__nullable
SecTaskRef SecTaskCreateWithAuditToken(CFAllocatorRef __nullable allocator, audit_token_t token);
/*!
@function SecTaskCreateFromSelf
@abstract Create a SecTask object for the current task.
@result The newly created SecTask object or NULL on error. The caller must
CFRelease the returned object.
#ifndef LEFT
*/
__nullable
SecTaskRef SecTaskCreateFromSelf(CFAllocatorRef __nullable allocator);
/*!
@function SecTaskCopyValueForEntitlement
@abstract Returns the value of a single entitlement for the represented
task.
@param task A previously created SecTask object
@param entitlement The name of the entitlement to be fetched
@param error On a NULL return, this may be contain a CFError describing
the problem. This argument may be NULL if the caller is not interested in
detailed errors.
@result The value of the specified entitlement for the process or NULL if
the entitlement value could not be retrieved. The type of the returned
value will depend on the entitlement specified. The caller must release
the returned object.
@discussion A NULL return may indicate an error, or it may indicate that
the entitlement is simply not present. In the latter case, no CFError is
returned.
*/
__nullable
CFTypeRef SecTaskCopyValueForEntitlement(SecTaskRef task, CFStringRef entitlement, CFErrorRef *error);
/*!
@function SecTaskCopyValuesForEntitlements
@abstract Returns the values of multiple entitlements for the represented
task.
@param task A previously created SecTask object
@param entitlements An array of entitlement names to be fetched
@param error On a NULL return, this will contain a CFError describing
the problem. This argument may be NULL if the caller is not interested in
detailed errors. If a requested entitlement is not present for the
returned dictionary, the entitlement is not set on the task. The caller
must CFRelease the returned value
*/
__nullable
CFDictionaryRef SecTaskCopyValuesForEntitlements(SecTaskRef task, CFArrayRef entitlements, CFErrorRef *error);
/*!
@function SecTaskCopySigningIdentifier
@abstract Return the value of the codesigning identifier.
@param task A previously created SecTask object
@param error On a NULL return, this will contain a CFError describing
the problem. This argument may be NULL if the caller is not interested in
detailed errors. The caller must CFRelease the returned value
*/
__nullable
CFStringRef SecTaskCopySigningIdentifier(SecTaskRef task, CFErrorRef *error);
/*!
@function SecTaskGetCodeSignStatus
@abstract Return the code sign status flags
@param task A previously created SecTask object
*/
uint32_t SecTaskGetCodeSignStatus(SecTaskRef task)
API_AVAILABLE(ios(10.0), watchos(3.0), tvos(10.0), macCatalyst(11.0)) API_UNAVAILABLE(macos);
CF_IMPLICIT_BRIDGING_DISABLED
CF_ASSUME_NONNULL_END
__END_DECLS
#endif /* !_SECURITY_SECTASK_H_ */
|
Subsets and Splits
No saved queries yet
Save your SQL queries to embed, download, and access them later. Queries will appear here once saved.