ImagerFont.mesa
Copyright © 1985 by Xerox Corporation. All rights reserved.
Michael Plass, July 31, 1984 10:58:40 am PDT
Doug Wyatt, April 15, 1985 1:55:09 pm PST
DIRECTORY
Atom USING [PropList],
Basics USING [BYTE],
ImagerTransformation USING [Transformation],
Rope USING [ROPE],
Vector2 USING [VEC];
ImagerFont: CEDAR DEFINITIONS
~ BEGIN
BYTE: TYPE ~ Basics.BYTE;
ROPE: TYPE ~ Rope.ROPE;
VEC: TYPE ~ Vector2.VEC;
Transformation: TYPE ~ ImagerTransformation.Transformation;
Xerox characters and strings
XChar: TYPE ~ MACHINE DEPENDENT RECORD [set: BYTE, code: BYTE];
nullXChar: XChar ~ [377B, 377B];
An XChar is a 16-bit Xerox character code. See the Xerox Character Code Standard.
XCharProc: TYPE ~ PROC [char: XChar];
XStringProc: TYPE ~ PROC [charAction: XCharProc];
MapRope: PROC [rope: ROPE,
start: INT ← 0, len: INT ← INT.LAST, charAction: XCharProc];
MapText: PROC [text: REF READONLY TEXT,
start: NAT ← 0, len: NAT ← NAT.LAST, charAction: XCharProc];
These assume the Xerox string encoding; they treat '\377 as an escape code.
See the Xerox Character Code Standard, section 6, and the Interpress Standard, section 2.5.3.
Fonts
Font: TYPE ~ REF FontRep;
FontRep: TYPE ~ RECORD [
name: ROPE, -- universal name of the font (see Interpress section 4.9.1)
charToClient: Transformation, -- transforms from character to client coordinates
impl: REF FontImplRep, -- private implementation data
propList: Atom.PropList ← NIL
];
FontImplRep: TYPE; -- see ImagerFontPrivate
Find: PROC [name: ROPE] RETURNS [Font];
Find the font with the given hierarchical name.
It's safe to use RefText.TrustTextAsRope for the name.
Modify: PROC [font: Font, m: Transformation] RETURNS [Font];
Modify a font by post-concatenating the given transformation.
Scale: PROC [font: Font, s: REAL] RETURNS [Font];
Equivalent to Modify[font, ImagerTransformation.Scale[s]].
Metrics
Extents: TYPE ~ RECORD [leftExtent, rightExtent, descent, ascent: REAL];
CorrectionType: TYPE ~ MACHINE DEPENDENT {none(0), space(1), mask(2), (3)};
Contains: PROC [font: Font, char: XChar] RETURNS [BOOL];
Returns TRUE iff the character exists in the font.
NextChar: PROC [font: Font, char: XChar] RETURNS [next: XChar];
Returns next char in the font, or nullXChar.
Call with nullXChar to get first char in font.
Width: PROC [font: Font, char: XChar] RETURNS [VEC];
Returns width vector for the character.
Amplified: PROC [font: Font, char: XChar] RETURNS [BOOL];
Returns TRUE iff the character is an 'amplifying' character.
Correction: PROC [font: Font, char: XChar] RETURNS [CorrectionType];
Returns the type of correction, if any, for the character.
BoundingBox: PROC [font: Font, char: XChar] RETURNS [Extents];
Returns a true bounding box for the character mask (not necessarily as tight as possible).
FontBoundingBox: PROC [font: Font] RETURNS [Extents];
Returns a bounding box for all character bounding boxes superimposed.
Kern: PROC [font: Font, char, successor: XChar] RETURNS [VEC];
Returns kerning adjustment between char and successor, or [0, 0].
NextKern: PROC [font: Font, char, successor: XChar] RETURNS [XChar];
Returns next successor that kerns with char.
Call with successor=nullXChar to get first one.
Ligature: PROC [font: Font, char, successor: XChar] RETURNS [XChar];
Returns a ligature formed from char and successor, or nullXChar.
NextLigature: PROC [font: Font, char, successor: XChar] RETURNS [XChar];
Returns next successor that has a ligature with char,
Call with successor=nullXChar to get first one.
StringWidth: PROC [font: Font, string: XStringProc] RETURNS [VEC];
RopeWidth: PROC [font: Font, rope: ROPE,
start: INT ← 0, len: INT ← INT.LAST] RETURNS [VEC];
TextWidth: PROC [font: Font, text: REF READONLY TEXT,
start: NAT ← 0, len: NAT ← NAT.LAST] RETURNS [VEC];
StringBoundingBox: PROC [font: Font, string: XStringProc] RETURNS [Extents];
RopeBoundingBox: PROC [font: Font, rope: ROPE,
start: INT ← 0, len: INT ← INT.LAST] RETURNS [Extents];
TextBoundingBox: PROC [font: Font, text: REF READONLY TEXT,
start: NAT ← 0, len: NAT ← NAT.LAST] RETURNS [Extents];
END.