static
OSStatus SetYPositionForLineHeight(
ATSUTextLayout currentLayout,
Fixed *currentYPos )
{
OSStatus err;
ATSTrapezoid glyphBounds;
ItemCount numGlyphBounds;
Fixed lineHeight;
// we need to calculate where the line should start, so get the height of the
// line.
err = ATSUGetGlyphBounds( currentLayout, 0, 0, kATSUFromTextBeginning,
kATSUToTextEnd, kATSUseCaretOrigins, 1, &glyphBounds, &numGlyphBounds );
require_noerr( err, SetYPositionForLineHeight_err );
lineHeight = glyphBounds.lowerRight.y - glyphBounds.upperRight.y;
// reset the line position based on the line height
*currentYPos -= lineHeight;
SetYPositionForLineHeight_err:
return err;
}
oop ATSUGetGlyphBounds_wrap( ATSUTextLayout iTextLayout,
float fTextBasePointX,
float fTextBasePointY,
int iBoundsCharStart, // uint32
int iBoundsCharLength, // uint32
uint16 iTypeOfBounds,
void* FH ) {
ATSUTextMeasurement iTextBasePointX = X2Fix(fTextBasePointX);
ATSUTextMeasurement iTextBasePointY = X2Fix(fTextBasePointY);
ATSTrapezoid b;
ItemCount oActualNumberOfBounds;
OSStatus e = ATSUGetGlyphBounds(
iTextLayout,
iTextBasePointX, iTextBasePointY,
iBoundsCharStart, iBoundsCharLength,
iTypeOfBounds,
1, // ItemCount iMaxNumberOfBounds,
&b, &oActualNumberOfBounds); /* can be NULL */
if (e != noErr) {
return (oop)reportOSError(e, "ATSUGetGlyphBounds", FH);
}
if (oActualNumberOfBounds < 1) {
static char buf[1000];
sprintf(buf, "ATSUGetGlyphBounds failed: returned %d bounds instead of 1", (int)oActualNumberOfBounds);
failure(FH, buf);
return NULL;
}
float L = min((float)Fix2X(b.upperLeft.x), (float)Fix2X(b.lowerLeft.x ));
float T = max((float)Fix2X(b.upperLeft.y), (float)Fix2X(b.upperRight.y));
float R = min((float)Fix2X(b.upperRight.x), (float)Fix2X(b.lowerRight.x));
float B = max((float)Fix2X(b.lowerLeft.y ), (float)Fix2X(b.lowerRight.y));
objVectorOop r = Memory->objVectorObj->cloneSize(4);
r->obj_at_put(0, as_floatOop(L), false);
r->obj_at_put(1, as_floatOop(T), false);
r->obj_at_put(2, as_floatOop(R), false);
r->obj_at_put(3, as_floatOop(B), false);
return r;
}
static
OSStatus DrawSingleLine(
DrawContextStruct *context )
{
OSStatus err;
ATSTrapezoid glyphBounds;
ItemCount numGlyphBounds;
Fixed lineHeight;
ATSUTextMeasurement xPosition;
ATSUTextMeasurement yPosition;
// set the xPosition and the yPosition as the boundries.
xPosition = context->bounds.origin.x;
yPosition = context->bounds.size.height;
xPosition = xPosition << 16;
yPosition = yPosition << 16;
// we need to calculate where the line should start, so get the height of the
// line.
err = ATSUGetGlyphBounds( context->layoutObject, 0, 0, kATSUFromTextBeginning, kATSUToTextEnd, kATSUseCaretOrigins, 1, &glyphBounds, &numGlyphBounds );
require_noerr( err, DrawSingleLine_err );
lineHeight = glyphBounds.lowerRight.y - glyphBounds.upperRight.y;
// adjust the line position based on the line height
yPosition -= lineHeight;
// draw!
err = ATSUDrawText( context->layoutObject, kATSUFromTextBeginning, kATSUToTextEnd, xPosition, yPosition );
check_noerr( err );
DrawSingleLine_err:
return err;
}
PsychError SCREENTextBounds(void)
{
//for debugging
TextEncodingBase textEncodingBase;
TextEncodingVariant textEncodingVariant;
TextEncodingFormat textEncodingFormat;
///////
PsychWindowRecordType *winRec;
char *textCString;
Str255 textPString;
UniChar *textUniString;
OSStatus callError;
PsychRectType resultPsychRect, resultPsychNormRect;
ATSUTextLayout textLayout; //layout is a pointer to an opaque struct.
int stringLengthChars;
int uniCharBufferLengthElements, uniCharBufferLengthChars, uniCharBufferLengthBytes;
ByteCount uniCharStringLengthBytes;
TextToUnicodeInfo textToUnicodeInfo;
TextEncoding textEncoding;
ATSUStyle atsuStyle;
Boolean foundFont;
//for ATSU style attributes
PsychFontStructPtrType psychFontRecord;
//all subfunctions should have these two lines.
PsychPushHelp(useString, synopsisString, seeAlsoString);
if(PsychIsGiveHelp()){PsychGiveHelp();return(PsychError_none);};
//check for correct the number of arguments before getting involved
PsychErrorExit(PsychCapNumInputArgs(2));
PsychErrorExit(PsychRequireNumInputArgs(2));
PsychErrorExit(PsychCapNumOutputArgs(2));
//get the window pointer and the text string and check that the window record has a font set
PsychAllocInWindowRecordArg(1, kPsychArgRequired, &winRec);
foundFont=PsychGetFontRecordFromFontNumber(winRec->textAttributes.textFontNumber, &psychFontRecord);
if(!foundFont)
PsychErrorExitMsg(PsychError_user, "Attempt to determine the bounds of text with no font or invalid font number");
//it would be better to both prevent the user from setting invalid font numbers and init to the OS 9 default font.
//read in the string and get its length and convert it to a unicode string.
PsychAllocInCharArg(2, kPsychArgRequired, &textCString);
stringLengthChars=strlen(textCString);
if(stringLengthChars > 255)
PsychErrorExitMsg(PsychError_unimplemented, "Cut corners and TextBounds will not accept a string longer than 255 characters");
CopyCStringToPascal(textCString, textPString);
uniCharBufferLengthChars= stringLengthChars * CHAR_TO_UNICODE_LENGTH_FACTOR;
uniCharBufferLengthElements= uniCharBufferLengthChars + 1;
uniCharBufferLengthBytes= sizeof(UniChar) * uniCharBufferLengthElements;
textUniString=(UniChar*)malloc(uniCharBufferLengthBytes);
//Using a TextEncoding type describe the encoding of the text to be converteed.
textEncoding=CreateTextEncoding(kTextEncodingMacRoman, kMacRomanDefaultVariant, kTextEncodingDefaultFormat);
//Take apart the encoding we just made to check it:
textEncodingBase=GetTextEncodingBase(textEncoding);
textEncodingVariant=GetTextEncodingVariant(textEncoding);
textEncodingFormat=GetTextEncodingFormat(textEncoding);
//Create a structure holding conversion information from the text encoding type we just created.
callError=CreateTextToUnicodeInfoByEncoding(textEncoding,&textToUnicodeInfo);
//Convert the text to a unicode string
callError=ConvertFromPStringToUnicode(textToUnicodeInfo, textPString, (ByteCount)uniCharBufferLengthBytes, &uniCharStringLengthBytes, textUniString);
//create the text layout object
callError=ATSUCreateTextLayout(&textLayout);
//associate our unicode text string with the text layout object
callError=ATSUSetTextPointerLocation(textLayout, textUniString, kATSUFromTextBeginning, kATSUToTextEnd, (UniCharCount)stringLengthChars);
//create an ATSU style object
callError=ATSUCreateStyle(&atsuStyle);
callError=ATSUClearStyle(atsuStyle);
//Not that we have a style object we have to set style charactersitics. These include but are more general than Font Manager styles.
//ATSU Style objects have three sets of characteristics: attributes, variations, and features.
//attributes are things we need to set to match OS 9 behavior, such as the font ID, size, boldness, and italicization.
//features are esoteric settings which we don't need for reproducing OS 9 behavior. Whatever clearstyle sets should be fine.
//font variations are axes of variation through the space of font characteristics. The font definition includes available axes of variation. Something else we can ignore for now.
PsychSetATSUStyleAttributesFromPsychWindowRecord(atsuStyle, winRec);
//don't bother to set the variations of the style.
//don't bother to set the features of the style.
//associate the style with our layout object. This call assigns a style to every character of the string to be displayed.
callError=ATSUSetRunStyle(textLayout, atsuStyle, (UniCharArrayOffset)0, (UniCharCount)stringLengthChars);
//Get the bounds for our text so that and create a texture of sufficient size to containt it.
ATSTrapezoid trapezoid;
ItemCount oActualNumberOfBounds = 0;
callError=ATSUGetGlyphBounds(textLayout, 0, 0, kATSUFromTextBeginning, kATSUToTextEnd, kATSUseDeviceOrigins, 0, NULL, &oActualNumberOfBounds);
if (callError || oActualNumberOfBounds!=1) {
PsychErrorExitMsg(PsychError_internal, "Failed to compute bounding box in call 1 to ATSUGetGlyphBounds() (nrbounds!=1)\n");
}
callError=ATSUGetGlyphBounds(textLayout, 0, 0, kATSUFromTextBeginning, kATSUToTextEnd, kATSUseDeviceOrigins, 1, &trapezoid, &oActualNumberOfBounds);
if (callError || oActualNumberOfBounds!=1) {
PsychErrorExitMsg(PsychError_internal, "Failed to retrieve bounding box in call 2 to ATSUGetGlyphBounds() (nrbounds!=1)\n");
}
resultPsychRect[kPsychLeft]=(Fix2X(trapezoid.upperLeft.x) < Fix2X(trapezoid.lowerLeft.x)) ? Fix2X(trapezoid.upperLeft.x) : Fix2X(trapezoid.lowerLeft.x);
resultPsychRect[kPsychRight]=(Fix2X(trapezoid.upperRight.x) > Fix2X(trapezoid.lowerRight.x)) ? Fix2X(trapezoid.upperRight.x) : Fix2X(trapezoid.lowerRight.x);
resultPsychRect[kPsychTop]=(Fix2X(trapezoid.upperLeft.y) < Fix2X(trapezoid.upperRight.y)) ? Fix2X(trapezoid.upperLeft.y) : Fix2X(trapezoid.upperRight.y);
resultPsychRect[kPsychBottom]=(Fix2X(trapezoid.lowerLeft.y) > Fix2X(trapezoid.lowerRight.y)) ? Fix2X(trapezoid.lowerLeft.y) : Fix2X(trapezoid.lowerRight.y);
PsychNormalizeRect(resultPsychRect, resultPsychNormRect);
PsychCopyOutRectArg(1, FALSE, resultPsychNormRect);
PsychCopyOutRectArg(2, FALSE, resultPsychRect);
//release resources
free((void*)textUniString);
callError=ATSUDisposeStyle(atsuStyle);
return(PsychError_none);
}
PsychError SCREENTextBounds(void)
{
//for debugging
TextEncodingBase textEncodingBase;
TextEncodingVariant textEncodingVariant;
TextEncodingFormat textEncodingFormat;
///////
PsychWindowRecordType *winRec;
char *textCString;
Str255 textPString;
UniChar *textUniString;
OSStatus callError;
PsychRectType resultPsychRect, resultPsychNormRect;
ATSUTextLayout textLayout; //layout is a pointer to an opaque struct.
int stringLengthChars;
int uniCharBufferLengthElements, uniCharBufferLengthChars, uniCharBufferLengthBytes, yPositionIsBaseline;
double textHeightToBaseline;
ByteCount uniCharStringLengthBytes;
TextToUnicodeInfo textToUnicodeInfo;
TextEncoding textEncoding;
ATSUStyle atsuStyle;
Boolean foundFont;
//for ATSU style attributes
PsychFontStructPtrType psychFontRecord;
//all subfunctions should have these two lines.
PsychPushHelp(useString, synopsisString, seeAlsoString);
if(PsychIsGiveHelp()){PsychGiveHelp();return(PsychError_none);};
//check for correct the number of arguments before getting involved
PsychErrorExit(PsychCapNumInputArgs(5));
PsychErrorExit(PsychRequireNumInputArgs(2));
PsychErrorExit(PsychCapNumOutputArgs(2));
//get the window pointer and the text string and check that the window record has a font set
PsychAllocInWindowRecordArg(1, kPsychArgRequired, &winRec);
foundFont=PsychGetFontRecordFromFontNumber(winRec->textAttributes.textFontNumber, &psychFontRecord);
if(!foundFont)
PsychErrorExitMsg(PsychError_user, "Attempt to determine the bounds of text with no font or invalid font number");
//it would be better to both prevent the user from setting invalid font numbers and init to the OS 9 default font.
//read in the string and get its length and convert it to a unicode string.
PsychAllocInCharArg(2, kPsychArgRequired, &textCString);
stringLengthChars=strlen(textCString);
if(stringLengthChars < 1) PsychErrorExitMsg(PsychError_user, "You asked me to compute the bounding box of an empty text string?!? Sorry, that's a no no...");
if(stringLengthChars > 255) PsychErrorExitMsg(PsychError_unimplemented, "Cut corners and TextBounds will not accept a string longer than 255 characters");
CopyCStringToPascal(textCString, textPString);
uniCharBufferLengthChars= stringLengthChars * CHAR_TO_UNICODE_LENGTH_FACTOR;
uniCharBufferLengthElements= uniCharBufferLengthChars + 1;
uniCharBufferLengthBytes= sizeof(UniChar) * uniCharBufferLengthElements;
textUniString=(UniChar*)malloc(uniCharBufferLengthBytes);
PsychCopyInDoubleArg(3, kPsychArgOptional, &(winRec->textAttributes.textPositionX));
PsychCopyInDoubleArg(4, kPsychArgOptional, &(winRec->textAttributes.textPositionY));
//Using a TextEncoding type describe the encoding of the text to be converteed.
textEncoding=CreateTextEncoding(kTextEncodingMacRoman, kMacRomanDefaultVariant, kTextEncodingDefaultFormat);
//Take apart the encoding we just made to check it:
textEncodingBase=GetTextEncodingBase(textEncoding);
textEncodingVariant=GetTextEncodingVariant(textEncoding);
textEncodingFormat=GetTextEncodingFormat(textEncoding);
//Create a structure holding conversion information from the text encoding type we just created.
callError=CreateTextToUnicodeInfoByEncoding(textEncoding,&textToUnicodeInfo);
//Convert the text to a unicode string
callError=ConvertFromPStringToUnicode(textToUnicodeInfo, textPString, (ByteCount)uniCharBufferLengthBytes, &uniCharStringLengthBytes, textUniString);
//create the text layout object
callError=ATSUCreateTextLayout(&textLayout);
//associate our unicode text string with the text layout object
callError=ATSUSetTextPointerLocation(textLayout, textUniString, kATSUFromTextBeginning, kATSUToTextEnd, (UniCharCount)stringLengthChars);
//create an ATSU style object
callError=ATSUCreateStyle(&atsuStyle);
callError=ATSUClearStyle(atsuStyle);
//Not that we have a style object we have to set style charactersitics. These include but are more general than Font Manager styles.
//ATSU Style objects have three sets of characteristics: attributes, variations, and features.
//attributes are things we need to set to match OS 9 behavior, such as the font ID, size, boldness, and italicization.
//features are esoteric settings which we don't need for reproducing OS 9 behavior. Whatever clearstyle sets should be fine.
//font variations are axes of variation through the space of font characteristics. The font definition includes available axes of variation. Something else we can ignore for now.
PsychSetATSUStyleAttributesFromPsychWindowRecord(atsuStyle, winRec);
//don't bother to set the variations of the style.
//don't bother to set the features of the style.
//associate the style with our layout object. This call assigns a style to every character of the string to be displayed.
callError=ATSUSetRunStyle(textLayout, atsuStyle, (UniCharArrayOffset)0, (UniCharCount)stringLengthChars);
// Define the meaning of the y position of the specified drawing cursor.
// We get the global setting from the Screen preference, but allow to override
// it on a per-invocation basis via the optional 7th argument to 'DrawText':
yPositionIsBaseline = PsychPrefStateGet_TextYPositionIsBaseline();
PsychCopyInIntegerArg(5, kPsychArgOptional, &yPositionIsBaseline);
if (yPositionIsBaseline) {
// Y position of drawing cursor defines distance between top of text and
// baseline of text, i.e. the textheight excluding descenders of letters:
// Need to compute offset via ATSU:
ATSUTextMeasurement mleft, mright, mtop, mbottom;
callError=ATSUGetUnjustifiedBounds(textLayout, kATSUFromTextBeginning, kATSUToTextEnd, &mleft, &mright, &mbottom, &mtop);
if (callError) {
PsychErrorExitMsg(PsychError_internal, "Failed to compute unjustified text height to baseline in call to ATSUGetUnjustifiedBounds().\n");
}
// Only take height including ascenders into account, not the descenders.
// MK: Honestly, i have no clue why this is the correct calculation (or if it is
// the correct calculation), but visually it seems to provide the correct results
// and i'm not a typographic expert and don't intend to become one...
textHeightToBaseline = fabs(Fix2X(mbottom));
}
else {
// Y position of drawing cursor defines top of text, therefore no offset (==0) needed:
textHeightToBaseline = 0;
}
//Get the bounds for our text so that and create a texture of sufficient size to containt it.
ATSTrapezoid trapezoid;
ItemCount oActualNumberOfBounds = 0;
callError=ATSUGetGlyphBounds(textLayout, 0, 0, kATSUFromTextBeginning, kATSUToTextEnd, kATSUseDeviceOrigins, 0, NULL, &oActualNumberOfBounds);
if (callError || oActualNumberOfBounds!=1) {
PsychErrorExitMsg(PsychError_internal, "Failed to compute bounding box in call 1 to ATSUGetGlyphBounds() (nrbounds!=1)\n");
}
callError=ATSUGetGlyphBounds(textLayout, 0, 0, kATSUFromTextBeginning, kATSUToTextEnd, kATSUseDeviceOrigins, 1, &trapezoid, &oActualNumberOfBounds);
if (callError || oActualNumberOfBounds!=1) {
PsychErrorExitMsg(PsychError_internal, "Failed to retrieve bounding box in call 2 to ATSUGetGlyphBounds() (nrbounds!=1)\n");
}
resultPsychRect[kPsychLeft]=(Fix2X(trapezoid.upperLeft.x) < Fix2X(trapezoid.lowerLeft.x)) ? Fix2X(trapezoid.upperLeft.x) : Fix2X(trapezoid.lowerLeft.x);
resultPsychRect[kPsychRight]=(Fix2X(trapezoid.upperRight.x) > Fix2X(trapezoid.lowerRight.x)) ? Fix2X(trapezoid.upperRight.x) : Fix2X(trapezoid.lowerRight.x);
resultPsychRect[kPsychTop]=(Fix2X(trapezoid.upperLeft.y) < Fix2X(trapezoid.upperRight.y)) ? Fix2X(trapezoid.upperLeft.y) : Fix2X(trapezoid.upperRight.y);
resultPsychRect[kPsychBottom]=(Fix2X(trapezoid.lowerLeft.y) > Fix2X(trapezoid.lowerRight.y)) ? Fix2X(trapezoid.lowerLeft.y) : Fix2X(trapezoid.lowerRight.y);
PsychNormalizeRect(resultPsychRect, resultPsychNormRect);
resultPsychRect[kPsychLeft]=resultPsychNormRect[kPsychLeft] + winRec->textAttributes.textPositionX;
resultPsychRect[kPsychRight]=resultPsychNormRect[kPsychRight] + winRec->textAttributes.textPositionX;
resultPsychRect[kPsychTop]=resultPsychNormRect[kPsychTop] + winRec->textAttributes.textPositionY - textHeightToBaseline;
resultPsychRect[kPsychBottom]=resultPsychNormRect[kPsychBottom] + winRec->textAttributes.textPositionY - textHeightToBaseline;
PsychCopyOutRectArg(1, FALSE, resultPsychNormRect);
PsychCopyOutRectArg(2, FALSE, resultPsychRect);
//release resources
free((void*)textUniString);
callError=ATSUDisposeStyle(atsuStyle);
return(PsychError_none);
}
