123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465 |
- {
- File: QD/ATSUnicodeDirectAccess.h
-
- Contains: Public Interfaces/Types for Low Level ATSUI
-
- Version: Quickdraw-150~1
-
- Copyright: © 2002-2003 by Apple Computer, Inc., all rights reserved.
-
- Bugs?: For bug reports, consult the following page on
- the World Wide Web:
-
- http://www.freepascal.org/bugs.html
-
- }
- { Pascal Translation: Peter N Lewis, <[email protected]>, 2004 }
- {
- Modified for use with Free Pascal
- Version 200
- Please report any bugs to <[email protected]>
- }
- {$mode macpas}
- {$packenum 1}
- {$macro on}
- {$inline on}
- {$CALLING MWPASCAL}
- unit ATSUnicodeDirectAccess;
- interface
- {$setc UNIVERSAL_INTERFACES_VERSION := $0342}
- {$setc GAP_INTERFACES_VERSION := $0200}
- {$ifc not defined USE_CFSTR_CONSTANT_MACROS}
- {$setc USE_CFSTR_CONSTANT_MACROS := TRUE}
- {$endc}
- {$ifc defined CPUPOWERPC and defined CPUI386}
- {$error Conflicting initial definitions for CPUPOWERPC and CPUI386}
- {$endc}
- {$ifc defined FPC_BIG_ENDIAN and defined FPC_LITTLE_ENDIAN}
- {$error Conflicting initial definitions for FPC_BIG_ENDIAN and FPC_LITTLE_ENDIAN}
- {$endc}
- {$ifc not defined __ppc__ and defined CPUPOWERPC}
- {$setc __ppc__ := 1}
- {$elsec}
- {$setc __ppc__ := 0}
- {$endc}
- {$ifc not defined __i386__ and defined CPUI386}
- {$setc __i386__ := 1}
- {$elsec}
- {$setc __i386__ := 0}
- {$endc}
- {$ifc defined __ppc__ and __ppc__ and defined __i386__ and __i386__}
- {$error Conflicting definitions for __ppc__ and __i386__}
- {$endc}
- {$ifc defined __ppc__ and __ppc__}
- {$setc TARGET_CPU_PPC := TRUE}
- {$setc TARGET_CPU_X86 := FALSE}
- {$elifc defined __i386__ and __i386__}
- {$setc TARGET_CPU_PPC := FALSE}
- {$setc TARGET_CPU_X86 := TRUE}
- {$elsec}
- {$error Neither __ppc__ nor __i386__ is defined.}
- {$endc}
- {$setc TARGET_CPU_PPC_64 := FALSE}
- {$ifc defined FPC_BIG_ENDIAN}
- {$setc TARGET_RT_BIG_ENDIAN := TRUE}
- {$setc TARGET_RT_LITTLE_ENDIAN := FALSE}
- {$elifc defined FPC_LITTLE_ENDIAN}
- {$setc TARGET_RT_BIG_ENDIAN := FALSE}
- {$setc TARGET_RT_LITTLE_ENDIAN := TRUE}
- {$elsec}
- {$error Neither FPC_BIG_ENDIAN nor FPC_LITTLE_ENDIAN are defined.}
- {$endc}
- {$setc ACCESSOR_CALLS_ARE_FUNCTIONS := TRUE}
- {$setc CALL_NOT_IN_CARBON := FALSE}
- {$setc OLDROUTINENAMES := FALSE}
- {$setc OPAQUE_TOOLBOX_STRUCTS := TRUE}
- {$setc OPAQUE_UPP_TYPES := TRUE}
- {$setc OTCARBONAPPLICATION := TRUE}
- {$setc OTKERNEL := FALSE}
- {$setc PM_USE_SESSION_APIS := TRUE}
- {$setc TARGET_API_MAC_CARBON := TRUE}
- {$setc TARGET_API_MAC_OS8 := FALSE}
- {$setc TARGET_API_MAC_OSX := TRUE}
- {$setc TARGET_CARBON := TRUE}
- {$setc TARGET_CPU_68K := FALSE}
- {$setc TARGET_CPU_MIPS := FALSE}
- {$setc TARGET_CPU_SPARC := FALSE}
- {$setc TARGET_OS_MAC := TRUE}
- {$setc TARGET_OS_UNIX := FALSE}
- {$setc TARGET_OS_WIN32 := FALSE}
- {$setc TARGET_RT_MAC_68881 := FALSE}
- {$setc TARGET_RT_MAC_CFM := FALSE}
- {$setc TARGET_RT_MAC_MACHO := TRUE}
- {$setc TYPED_FUNCTION_POINTERS := TRUE}
- {$setc TYPE_BOOL := FALSE}
- {$setc TYPE_EXTENDED := FALSE}
- {$setc TYPE_LONGLONG := TRUE}
- uses MacTypes,ATSLayoutTypes,ATSUnicodeTypes,TextCommon;
- {$ALIGN MAC68K}
- { ---------------------------------------------------------------------------- }
- { Constants }
- { ---------------------------------------------------------------------------- }
- {
- * ATSUDirectDataSelector
- *
- * Summary:
- * These are the data selectors used in the
- * ATSUDirectGetLayoutDataArrayPtr function to get the needed layout
- * data array pointer.
- }
- type ATSUDirectDataSelector = UInt32;
- const
- {
- * Returns the parallel advance delta (delta X) array. (Array Type):
- * Fixed (Return Time): Constant, unless creation is necessary, or
- * unless requested by ATSUDirectGetLayoutDataArrayPtrFromTextLayout.
- * (Creation): This array is created only on demand. Thus, if any
- * changes are to be made iCreate should be set to true. If the array
- * had not been previously allocated it will be allocated and
- * zero-filled when iCreate is set to true.
- }
- kATSUDirectDataAdvanceDeltaFixedArray = 0;
- {
- * Returns the parallel baseline delta (delta Y) array. (Array Type):
- * Fixed (Return Time): Constant, unless creation is necessary, or
- * unless requested by ATSUDirectGetLayoutDataArrayPtrFromTextLayout.
- * (Creation): This array is created only on demand. Thus, if any
- * changes are to be made iCreate should be set to true. If the array
- * had not been previously allocated it will be allocated and
- * zero-filled when iCreate is set to true.
- }
- kATSUDirectDataBaselineDeltaFixedArray = 1;
- {
- * Returns the parallel device delta array for device- specific
- * tweaking. This is an array of values which are used to adjust
- * truncated fractional values for devices that do not accept
- * fractional positioning. It is also used to provide precise
- * positioning for connected scripts. (Array Type): SInt16 (Return
- * Time): Constant, unless creation is necessary, or unless requested
- * by ATSUDirectGetLayoutDataArrayPtrFromTextLayout. (Creation): This
- * array is created only on demand. Thus, if any changes are to be
- * made iCreate should be set to true. If the array had not been
- * previously allocated it will be allocated and zero-filled when
- * iCreate is set to true.
- }
- kATSUDirectDataDeviceDeltaSInt16Array = 2;
- {
- * Returns the parallel style index array. The indexes setting in the
- * array are indexes into the the StyleSetting array, which can be
- * obtained using the
- * kATSUDirectDataStyleSettingATSUStyleSettingRefArray below. (Array
- * Type): UInt16 (Return Time): Constant, unless creation is
- * necessary, or unless requested by
- * ATSUDirectGetLayoutDataArrayPtrFromTextLayout. (Creation): This
- * array is created only on demand. Thus, if any changes are to be
- * made iCreate should be set to true. If the array had not been
- * previously allocated it will be allocated and zero-filled when
- * iCreate is set to true.
- }
- kATSUDirectDataStyleIndexUInt16Array = 3;
- {
- * Returns the style setting ref array. (Array Type):
- * ATSUStyleSettingRef (Return Time): Linear, based on the number of
- * styles applied to the given line. (Creation): This array is always
- * present if the layout has any text assigned to it at all. Setting
- * iCreate has no effect.
- }
- kATSUDirectDataStyleSettingATSUStyleSettingRefArray = 4;
- {
- * Returns the ATSLayoutRecord, version 1 array. This should not be
- * used directly at all. Rather, use the
- * kATSUDirectDataLayoutRecordATSLayoutRecordCurrent selector below.
- * This will ensure that the code will always be using the most
- * current version of the ATSLayoutRecord, should there ever be a
- * change. ATSUI will only ensure the most efficient processing will
- * occur for the latest version of ATSLayoutRecord. (Array Type):
- * ATSLayoutRecord, version 1 (Return Time): Constant, unless
- * creation is necessary, or unless requested by
- * ATSUDirectGetLayoutDataArrayPtrFromTextLayout. (Creation): This
- * array is always present if the layout has any text assigned to it
- * at all. Setting iCreate has no effect
- }
- kATSUDirectDataLayoutRecordATSLayoutRecordVersion1 = 100;
- {
- * Returns the ATSLayoutRecord. This will return the most current
- * version of the ATSLayoutRecord, and the one that's defined in this
- * file. Always use kATSUDirectDataLayoutRecordATSLayoutRecordCurrent
- * to get the array of ATSLayoutRecords. (Array Type):
- * ATSLayoutRecord (Return Time): Constant, unless creation is
- * necessary, or unless requested by
- * ATSUDirectGetLayoutDataArrayPtrFromTextLayout. (Creation): This
- * array is always present if the layout has any text assigned to it
- * at all. Setting iCreate has no effect.
- }
- kATSUDirectDataLayoutRecordATSLayoutRecordCurrent = kATSUDirectDataLayoutRecordATSLayoutRecordVersion1;
- { ---------------------------------------------------------------------------- }
- { Data Types }
- { ---------------------------------------------------------------------------- }
- {
- * ATSUStyleSettingRef
- *
- * Summary:
- * A reference to a style setting object that represents an
- * ATSUStyle plus any cached/set information about that style.
- }
- type
- ATSUStyleSettingRef = ^SInt32; { an opaque 32-bit type }
- { ---------------------------------------------------------------------------- }
- { Direct Accessors }
- { ---------------------------------------------------------------------------- }
- {
- * ATSUDirectGetLayoutDataArrayPtrFromLineRef()
- *
- * Summary:
- * Returns the data pointer specified by iDataSelector and
- * referenced by iLineRef.
- *
- * Discussion:
- * This function simply returns the data pointer specified by
- * iDataSelector and referenced by iLineRef. This data pointer
- * should not be freed directly after it's been used. Rather, it
- * should be released using ATSUDirectReleaseLayoutDataArrayPtr.
- * Doing so serves as a signal to ATSUI that the caller is done with
- * the data and that it can merge it in smoothly and adjust its
- * internal processes. Furthermore, it may be the case that the
- * pointer returned may be dynamically allocated one or contain
- * dynamically allocated data. If it's not properly freed, a memory
- * leak may result. This function may only be called within the
- * context of an ATSUDirectLayoutOperationOverrideUPP callback. The
- * pointer returned points to the exact data referenced by the
- * ATSUTextLayout object that triggered the callback call. This is
- * by far the most efficient way to use the direct access calls
- * because for most requested data, no allocation and copy is done.
- * Furthermore, because this a direct pointer to the data that ATSUI
- * will use for it's layout, the data arrays returned by this can be
- * tweaked and edited. Many of the requested arrays are created by
- * ATSUI only when necessary. If these arrays are to be altered,
- * then be sure to set iCreate to true. This will ensure that this
- * array is created. If the arrays are not created, ATSUI
- * automatically assumes that all entries in the array are zero. The
- * pointer returned by this function is only valid within the
- * context of the callback. Do not attempt to retain it for later
- * use.
- *
- * Parameters:
- *
- * iLineRef:
- * The ATSULineRef which was passed into a
- * ATSUDirectLayoutOperationOverrideUPP callback function as a
- * parameter.
- *
- * iDataSelector:
- * The selector for the data that is being requested.
- *
- * iCreate:
- * If the ATSULineRef passed in iLineRef does not reference the
- * requested array, then a zero-filled one will be created and
- * returned in oLayoutDataArray if this is set to true. For some
- * ATSUDirectDataSelectors, these cannot be simply created. Thus,
- * this flag will have no affect on these few
- * ATSUDirectDataSelectors.
- *
- * oLayoutDataArrayPtr:
- * Upon sucessful return, this parameter will contain a pointer to
- * an array of the requested values if the ATSULineRef passed in
- * iLineRef references those values. If this is not the case, then
- * NULL will be returned, unless iCreate is set to true and the
- * array can be created. This parameter itself may be set to NULL
- * if only a count of the entries is needed. can be NULL
- *
- * oLayoutDataCount:
- * Upon sucessful return, this parameter will contain a count of
- * the entries in the array returned in oLayoutDataArray.
- *
- * Availability:
- * Mac OS X: in version 10.2 and later in ApplicationServices.framework
- * CarbonLib: not available in CarbonLib 1.x, is available on Mac OS X version 10.2 and later
- * Non-Carbon CFM: not available
- }
- // AVAILABLE_MAC_OS_X_VERSION_10_2_AND_LATER
- function ATSUDirectGetLayoutDataArrayPtrFromLineRef( iLineRef: ATSULineRef; iDataSelector: ATSUDirectDataSelector; iCreate: Boolean; oLayoutDataArrayPtr: PtrPtr; var oLayoutDataCount: ItemCount ): OSStatus; external name '_ATSUDirectGetLayoutDataArrayPtrFromLineRef';
- { ---------------------------------------------------------------------------- }
- {
- * ATSUDirectGetLayoutDataArrayPtrFromTextLayout()
- *
- * Summary:
- * Returns the data pointer specified by iDataSelector and
- * referenced by iTextLayout for the line starting at iLineOffset.
- *
- * Discussion:
- * This function simply returns the data pointer specified by
- * iDataSelector and referenced by iTextLayout for the line starting
- * at iLineOffset. This data pointer should not be freed directly
- * after it's been used. Rather, it should be released using
- * ATSUDirectReleaseLayoutDataArrayPtr. Doing so serves as a signal
- * to ATSUI that the caller is done with the data. Furthermore, it
- * may be the case that the pointer returned may be dynamically
- * allocated one or contain dynamically allocated data. If it's not
- * properly freed, a memory leak may result. This function may not
- * be called inside the context of an
- * ATSUDirectLayoutOperationOverrideUPP callback for the
- * ATSUTextLayout data that triggered the callback. All data
- * returned will be a copy of the data in the object requested. This
- * means two things: first of all, this means that it's a very
- * inefficient way of using the data. All of the selectors that
- * would have returned in constant time now would be forced to
- * return in order-n time. Second of all, this means that the
- * developer cannot change any of the data. Any changes the
- * developer makes to the arrays returned by this API will have no
- * effect on the layout. Using the
- * kATSULayoutOperationPostLayoutAdjustment operation selector
- * override and the ATSUDirectGetLayoutDataArrayPtrFromLineRef is a
- * great alternative to using this API. Many of the requested arrays
- * are created by ATSUI only when necessary. This means that it's
- * possible that this API will return NULL pointer and a count of 0.
- * In this case, if there's no error returned, the array simply
- * doesn't exist and the caller should treat all of the entries in
- * the array that they would have recieved as being 0.
- *
- * Parameters:
- *
- * iTextLayout:
- * The ATSUTextLayout object from which the requested data will
- * come from.
- *
- * iLineOffset:
- * The edge offset that corresponds to the beginning of the range
- * of text of the line of the requested data. If the text has
- * multiple lines, then ATSUDirectGetLayoutDataArrayPtrFromLineRef
- * will need to be called for each of the lines in which the
- * requested data is needed.
- *
- * iDataSelector:
- * The selector for the data that is being requested.
- *
- * oLayoutDataArrayPtr:
- * Upon sucessful return, this parameter will contain a pointer to
- * an array of the requested values if the ATSUTextLayout passed
- * in iTextLayout references those values for the line offset
- * iLineOffset. If this is not the case, then NULL will be
- * returned. This parameter itself may be set to NULL if only a
- * count of the entries is needed. can be NULL
- *
- * oLayoutDataCount:
- * Upon sucessful return, this parameter will contain a count of
- * the entries in the array returned in oLayoutDataArray.
- *
- * Availability:
- * Mac OS X: in version 10.2 and later in ApplicationServices.framework
- * CarbonLib: not available in CarbonLib 1.x, is available on Mac OS X version 10.2 and later
- * Non-Carbon CFM: not available
- }
- // AVAILABLE_MAC_OS_X_VERSION_10_2_AND_LATER
- function ATSUDirectGetLayoutDataArrayPtrFromTextLayout( iTextLayout: ATSUTextLayout; iLineOffset: UniCharArrayOffset; iDataSelector: ATSUDirectDataSelector; oLayoutDataArrayPtr: PtrPtr; var oLayoutDataCount: ItemCount ): OSStatus; external name '_ATSUDirectGetLayoutDataArrayPtrFromTextLayout';
- { ---------------------------------------------------------------------------- }
- {
- * ATSUDirectReleaseLayoutDataArrayPtr()
- *
- * Summary:
- * Properly releases of an array pointer returned by
- * ATSUDirectGetLayoutDataArrayPtrFromLineRef() or
- * ATSUDirectGetLayoutDataArrayPtrFromTextLayout.
- *
- * Discussion:
- * This function is needed to let ATSUI know that the caller is
- * finished with the pointer that was previously requested by
- * ATSUDirectGetLayoutDataArrayPtrFromLineRef() or
- * ATSUDirectGetLayoutDataArrayPtrFromTextLayout(). This is needed
- * in case ATSUI needs to make any internal adjustments to it's
- * internal structures.
- *
- * Parameters:
- *
- * iLineRef:
- * The lineRef from which the layout data array pointer came from.
- * If the layout data array pointer did not come from a lineRef,
- * then set this to NULL. can be NULL
- *
- * iDataSelector:
- * The selector for which iLayoutDataArrayPtr was obtained.
- *
- * iLayoutDataArrayPtr:
- * A pointer to the layout data array which is to be disposed of.
- *
- * Availability:
- * Mac OS X: in version 10.2 and later in ApplicationServices.framework
- * CarbonLib: not available in CarbonLib 1.x, is available on Mac OS X version 10.2 and later
- * Non-Carbon CFM: not available
- }
- // AVAILABLE_MAC_OS_X_VERSION_10_2_AND_LATER
- function ATSUDirectReleaseLayoutDataArrayPtr( iLineRef: ATSULineRef; iDataSelector: ATSUDirectDataSelector; iLayoutDataArrayPtr: PtrPtr ): OSStatus; external name '_ATSUDirectReleaseLayoutDataArrayPtr';
- { ---------------------------------------------------------------------------- }
- {
- * ATSUDirectAddStyleSettingRef()
- *
- * Summary:
- * This function will fetch a style index for the
- * ATSUStyleSettingRef passed in.
- *
- * Discussion:
- * This function allows for glyph replacement or substitution from
- * one layout or line to another layout or line. Not only will it
- * look up the style index for iStyleSettingRef, but if the
- * ATSUStyleSettingRef passed in iStyleSettingRef is not yet part of
- * the line referenced by iLineRef, it will add it. If there is an
- * outstanding ATSUStyleSettingRef array obtained by using the
- * kATSUDirectDataStyleSettingATSUStyleSettingRefArray selector, the
- * pointer obtained for this may no longer be valid after this
- * function has been called. These pointers should be freed before
- * calling this function and re-obtained afterwards.
- *
- * Parameters:
- *
- * iLineRef:
- * An ATSULineRef which was passed into a
- * ATSUDirectLayoutOperationOverrideUPP callback function as a
- * parameter.
- *
- * iStyleSettingRef:
- * The ATSUStyleSettingRef to be looked up or added to the
- * ATSUTextLayout referenced by iTextLayout for the line starting
- * at the offset iLineOffset.
- *
- * oStyleIndex:
- * Upon sucessful return, this will parameter will be set to the
- * index of the ATSUStyleSettingRef passed in iStyleSettingRef for
- * the line referenced by iLineRef. If the ATSUStyleSettingRef
- * does not exist, in that context, then it will be added and the
- * new index will be returned here.
- *
- * Availability:
- * Mac OS X: in version 10.2 and later in ApplicationServices.framework
- * CarbonLib: not available in CarbonLib 1.x, is available on Mac OS X version 10.2 and later
- * Non-Carbon CFM: not available
- }
- // AVAILABLE_MAC_OS_X_VERSION_10_2_AND_LATER
- function ATSUDirectAddStyleSettingRef( iLineRef: ATSULineRef; iStyleSettingRef: ATSUStyleSettingRef; var oStyleIndex: UInt16 ): OSStatus; external name '_ATSUDirectAddStyleSettingRef';
- end.
|