Home  /  Autodocs  /  diskfont.library

NAME

OpenOutlineFont
Search, load, validate and relocate an .otag file, if requested open the font engine library and a glyph engine. (V47)

SYNOPSIS

outlinefont = OpenOutlineFont(fileName, list, flags)
D0 A0 A1 D0

struct OutlineFont *OpenOutlineFont(STRPTR fileName,
struct List *list, ULONG flags);

FUNCTION

This function finds the .otag file for the specified outline font on disk, loads it into memory, validates that OT_FileIdent exists and matches the file size, validates that OT_Engine exists and relocates all OT_Indirect tags. If requested, it opens the font engine library and a glyph engine and calls ESetInfo() with the appropriate OT_OTagPath and OT_OTagList tags. It returns a pointer to a struct OutlineFont. It is important to match this call with a corresponding CloseOutlineFont() call for effective management of memory.

INPUTS

fileName
file or font name to open. If fileName contains a ':', the .otag file will be searched in the path specified with fileName, otherwise it will be searched in FONTS:. The fileName may have either the ".font" or the ".otag" suffix or no suffix (just the font name, e.g. "Nimbus Sans L Regular Condensed Italic"). It is not limited in length.

list
ignored when OFF_OPEN not set. A pointer to a struct List that has to be initialized with NewList() before the first call of OpenOutlineFont() and has to be used for every subsequent call of OpenOutlineFont() and CloseOutlineFont(), or NULL. If not NULL, the function uses this list to avoid re-opening font engine libraries for your task that were already opened by a previous call of OpenOutlineFont(). You either must pass the same list for all calls of OpenOutlineFont() and CloseOutlineFont() or always use NULL. If you want to share the list between tasks, you are responsible for using an appropriate locking mechanism, e.g. a Semaphore.

flags
currently only OFF_OPEN is specified, when not set, the .otag file is only searched, loaded, validated and relocated and you can e.g. examine the OTagList and decide whether you want to use this font or not. See below how to open the font later.

RESULT

D0 is zero if the desired .otag file cannot be found, loaded or validated, the font engine library or glyph engine could not be opened or the ESetInfo() call specifying OT_OTagPath and OT_OTagList failed. Otherwise D0 points to a struct OutlineFont.

NOTES

If you did not set OFF_OPEN and want to open the font later: open the font engine library via OpenLibrary() and store it in olf_EEngine.ege_BulletBase, if successful call EOpenEngine() with the address of olf_EEngine, if successful call ESetInfo() with olf_OTagPath and olf_OTagList as OT_OTagPath / OT_OTagList, if successful you can use the font. But: you must clean up yourself when done (ECloseEngine(), CloseLibrary()) and you _must_ set all olf_EEngine members back to NULL before calling CloseOutlineFont(). Or just use your own EGlyphEngine structure instead.

EXAMPLE

struct OutlineFont *outlineFont;

if (outlineFont = OpenOutlineFont("Helvetica", NULL, OFF_OPEN))
{
if (ESetInfo(&outlineFont->olf_EEngine,
OT_DeviceDPI, (XDPI << 16) | YDPI,
OT_PointHeight, PointHeight,
TAG_END) == OTERR_Success)
{
// Now all is set up to use the font with
// ESetInfo(), EObtainInfo() and EReleaseInfo()
}
CloseOutlineFont(outlineFont, NULL);
}

SEE ALSO

CloseOutlineFont(), bullet.library/--background--, ESetInfoA(), EObtainInfoA(), EReleaseInfoA(), diskfont/diskfont.h, diskfont/diskfonttag.h, diskfont/oterrors.h