NPWText.c File Reference

Helper functions for text layout. More...

#include "NPWText.h"

Go to the source code of this file.

Defines
#define	kDefaultFont   NPWFontNameCourier
	default font name
#define	kDefaultFontSize   12
	default font size
#define	Chk(e)
	Check error returned by a function and returns it unless kNPWErrOk.
#define	GetUnderlinePosition(a)   (a)[0]
	Get underline position from AFM array.
#define	GetUnderlineThickness(a)   (a)[1]
	Get underline thickness from AFM array.
#define	GetXHeight(a)   (a)[2]
	Get xHeight value from AFM array.
#define	GetAscender(a)   (a)[3]
	Get ascender value from AFM array.
#define	GetDescender(a)   (a)[4]
	Get descender value from AFM array.
#define	GetFirstCharCode(a)   (a)[5]
	Get first character code from AFM array.
#define	GetNumChar(a)   (a)[6]
	Get number of characters from AFM array.
#define	GetCharWidth(a, c)
	Get character width from AFM array.
Functions
static NPWBoolean	AreStrEq (NPWConstText s1, NPWConstText s2)
	Check if two strings are equal.
NPWErr	NPWTextFont (NPWFont *font, NPWConstText name, NPWFloat size)
	Initialize a font by name and size.
void	NPWTextSize (NPWFont const *font, NPWConstText str, NPWInt len, NPWFloat *width, NPWFloat *height)
	Calculate size of text.
NPWConstText	NPWFindFont (NPWCharStyle const *charStyle, NPWFont *font)
	Find a font by name and style.
void	NPWFontMetrics (NPWFont const *font, NPWFloat *ascender, NPWFloat *descender, NPWFloat *xHeight)
	Get font metrics.
NPWBoolean	NPWBreakNextLine (NPWConstText str, NPWInt len, NPWInt start, NPWFloat lineMaxWidth, NPWMarkupCBEntry const markupCBTable[], NPWInt *lineBr, NPWFloat *lineWidth, NPWInt *nSpaces, NPWBoolean *suspended, NPWCharStyle *style, NPWParFormat *parFormat)
	Find next line break and compute length and number of spaces.
void	NPWTextLayoutInit (NPWTextLayoutState *state, NPWMarkupCBEntry const markupCBTable[])
	Initialize text layout state.
void	NPWLayoutSetDefaultCharStyle (NPWTextLayoutState *state, NPWCharStyle const *style)
	Set default character style in text layout state.
void	NPWLayoutSetDefaultParagraphStyle (NPWTextLayoutState *state, NPWParFormat const *parFormat)
	Set default paragraph format in text layout state.
void	NPWTextLayoutSetPosition (NPWTextLayoutState *state, NPWFloat x, NPWFloat y)
	Set position of next line of text in text layout state.
void	NPWTextLayoutSetLineWidths (NPWTextLayoutState *state, NPWFloat const lineMaxWidths[], NPWInt lineMWLen)
	Set array of maximum line widths.
void	NPWTextLayoutSetBottom (NPWTextLayoutState *state, NPWFloat bottom)
	Set lower limit of text along y axis.
void	NPWTextLayoutSetText (NPWTextLayoutState *state, NPWConstText str, NPWInt len)
	Set text.
NPWErr	NPWTextLayoutWrite (NPW *pdf, NPWTextLayoutState *state)
	Write formatted text.
NPWErr	NPWTextLayoutVerticalSkip (NPWTextLayoutState *state, NPWFloat v, NPWFloat *ylow)
	Reserve some space in text layout.
NPWErr	NPWTextWrite (NPW *pdf, NPWConstText str, NPWInt len, NPWFloat x, NPWFloat y, NPWCharStyle const *style, NPWAlignment alignment)
	Write simple styeled text.
Variables
static PDFInt16	afmTimesRoman []
	Times-Roman metrics.
static PDFInt16	afmTimesItalic []
	Times-Italic metrics.
static PDFInt16	afmTimesBold []
	Times-Bold metrics.
static PDFInt16	afmTimesBoldItalic []
	Times-BoldItalic metrics.
static PDFInt16	afmHelvetica []
	Helvetica metrics.
static PDFInt16	afmHelveticaOblique []
	Helvetica-oblique metrics.
static PDFInt16	afmHelveticaBold []
	Helvetica-bold metrics.
static PDFInt16	afmHelveticaBoldOblique []
	Helvetica-boldoblique metrics.
static PDFInt16	afmCourier []
	Courier metrics.
static PDFInt16	afmSymbol []
	Symbol metrics.
static PDFInt16	afmZapfDingbats []
	Zapf Dingbats metrics.
FontMetrics const	fonts []
	AFM font metrics for standard PDF fonts.

---

Detailed Description

Helper functions for text layout.

Author:

Yves Piguet. Copyright 2007-2010, Yves Piguet.

Definition in file NPWText.c.

---

Define Documentation

#define Chk

(

e

)

Value:

do { \
        err = (e); \
        if (err != kNPWErrOk) \
            return err; \
    } while (0)

Check error returned by a function and returns it unless kNPWErrOk.

Definition at line 15 of file NPWText.c.

#define GetCharWidth	(	a,
		c		)

Value:

(a)[(c) >= GetFirstCharCode(a) && (c) < GetFirstCharCode(a) + GetNumChar(a) \
            ? 7 + (c) - GetFirstCharCode(a) : 7]

Get character width from AFM array.

Definition at line 52 of file NPWText.c.

---

Function Documentation

static NPWBoolean AreStrEq	(	NPWConstText	s1,
		NPWConstText	s2
	)			[static]

Check if two strings are equal.

Parameters:

[in]	s1	first null-terminated string
[in]	s2	second null-terminated string

Returns:

TRUE if strings are equal, else FALSE

Definition at line 423 of file NPWText.c.

NPWBoolean NPWBreakNextLine	(	NPWConstText	str,
		NPWInt	len,
		NPWInt	start,
		NPWFloat	lineMaxWidth,
		NPWMarkupCBEntry const	markupCBTable[],
		NPWInt *	lineBr,
		NPWFloat *	lineWidth,
		NPWInt *	nSpaces,
		NPWBoolean *	suspended,
		NPWCharStyle *	style,
		NPWParFormat *	parFormat
	)

Find next line break and compute length and number of spaces.

Parameters:

[in]	str	text
[in]	len	length of text (c-string if < 0); stops at first linefeed
[in]	start	offset of first character in str
[in]	lineMaxWidth	max width of line; no line break if negative, just compute line width and spaces for alignment
[in]	markupCBTable	table of markup callbacks
[out]	lineBr	offset of next line break
[out]	lineWidth	width of next line (without trailing spaces)
[out]	nSpaces	number of spaces (excluding trailing space)
[in,out]	suspended	set to TRUE if a markup callback has returned kNPWMarkupActionFlagSuspend
[in,out]	style	initial character style
[in,out]	parFormat	initial paragraph format

Returns:

TRUE if next line is found, FALSE if end-of-text

Definition at line 508 of file NPWText.c.

NPWConstText NPWFindFont	(	NPWCharStyle const *	charStyle,
		NPWFont *	font
	)

Find a font by name and style.

Parameters:

[in]	charStyle	font and character style
[out]	font	AFM metrics

Returns:

font reference to be used in PDF

Definition at line 461 of file NPWText.c.

void NPWFontMetrics	(	NPWFont const *	font,
		NPWFloat *	ascender,
		NPWFloat *	descender,
		NPWFloat *	xHeight
	)

Get font metrics.

Parameters:

[in]	font	AFM metrics
[out]	ascender	ascender (not retrieved if NULL)
[out]	descender	descender (not retrieved if NULL)
[out]	xHeight	x-height (not retrieved if NULL)

Definition at line 495 of file NPWText.c.

void NPWLayoutSetDefaultCharStyle	(	NPWTextLayoutState *	state,
		NPWCharStyle const *	style
	)

Set default character style in text layout state.

Parameters:

[in,out]	state	text layout state
[in]	style	default character style

Definition at line 633 of file NPWText.c.

void NPWLayoutSetDefaultParagraphStyle	(	NPWTextLayoutState *	state,
		NPWParFormat const *	parFormat
	)

Set default paragraph format in text layout state.

Parameters:

[in,out]	state	text layout state
[in]	parFormat	default paragraph style

Definition at line 639 of file NPWText.c.

NPWErr NPWTextFont	(	NPWFont *	font,
		NPWConstText	name,
		NPWFloat	size
	)

Initialize a font by name and size.

Parameters:

[out]	font	font
[in]	name	font dictionary name (NPWFontNameCourier etc.)
[in]	size	font size in points

Returns:

kNPWErrOk for success, else error code

Definition at line 430 of file NPWText.c.

void NPWTextLayoutInit	(	NPWTextLayoutState *	state,
		NPWMarkupCBEntry const	markupCBTable[]
	)

Initialize text layout state.

Parameters:

[out]	state	text layout state
[in]	markupCBTable	table of markup callbacks

Definition at line 606 of file NPWText.c.

void NPWTextLayoutSetBottom	(	NPWTextLayoutState *	state,
		NPWFloat	bottom
	)

Set lower limit of text along y axis.

Parameters:

[in,out]	state	text layout state
[in]	bottom	lower limit of text

Definition at line 659 of file NPWText.c.

void NPWTextLayoutSetLineWidths	(	NPWTextLayoutState *	state,
		NPWFloat const	lmw[],
		NPWInt	n
	)

Set array of maximum line widths.

Parameters:

[in,out]	state	text layout state
[in]	lmw	array of line maximum widths
[in]	n	number of elements in lmw (last element is replicated)

Definition at line 652 of file NPWText.c.

void NPWTextLayoutSetPosition	(	NPWTextLayoutState *	state,
		NPWFloat	x,
		NPWFloat	y
	)

Set position of next line of text in text layout state.

Parameters:

[in,out]	state	text layout state
[in]	x	left margin
[in]	y	base line of first line

Definition at line 645 of file NPWText.c.

void NPWTextLayoutSetText	(	NPWTextLayoutState *	state,
		NPWConstText	str,
		NPWInt	len
	)

Set text.

Parameters:

[in,out]	state	text layout state
[in]	str	text
[in]	len	text length

Definition at line 665 of file NPWText.c.

NPWErr NPWTextLayoutVerticalSkip	(	NPWTextLayoutState *	state,
		NPWFloat	v,
		NPWFloat *	ylow
	)

Reserve some space in text layout.

Parameters:

[in,out]	state	text layout state
[in]	v	vertical distance to skip
[out]	ylow	y coordinate of free space bottom (base line one line above where next line will be displayed; free space top is the base line of previous line; not returned in NULL)

Returns:

kNPWErrOk for success, kNPWErrIncomplete if not enough space (y exceeds bottom), else error code

Definition at line 901 of file NPWText.c.

NPWErr NPWTextLayoutWrite	(	NPW *	pdf,
		NPWTextLayoutState *	state
	)

Write formatted text.

Parameters:

	pdf	reference to NPW structure
[in,out]	state	text layout state

Returns:

kNPWErrOk for success, kNPWErrIncomplete if more text to write (y exceeds bottom), else error code

Definition at line 677 of file NPWText.c.

void NPWTextSize	(	NPWFont const *	font,
		NPWConstText	str,
		NPWInt	len,
		NPWFloat *	width,
		NPWFloat *	height
	)

Calculate size of text.

Parameters:

[in]	font	font
[in]	str	text
[in]	len	length of text, or -1 if str is null-terminated
[out]	width	text width if not NULL
[out]	height	text height if not NULL

Definition at line 444 of file NPWText.c.

NPWErr NPWTextWrite	(	NPW *	pdf,
		NPWConstText	str,
		NPWInt	len,
		NPWFloat	x,
		NPWFloat	y,
		NPWCharStyle const *	style,
		NPWAlignment	alignment
	)

Write simple styeled text.

Parameters:

	pdf	reference to NPW structure
[in]	str	text
[in]	len	length of text, or -1 if str is null-terminated
[in]	x	position along x axis
[in]	y	position along y axis
[in]	style	character style
[in]	alignment	horizontal alignment (kNPWAlignmentLeft, kNPWAlignmentCenter, or kNPWAlignmentRight)

Returns:

kNPWErrOk for success, else error code

Definition at line 912 of file NPWText.c.

---

Variable Documentation

PDFInt16 afmCourier[] [static]

Initial value:

{
    -100,
    50,
    439,
    629,
    -157,
    32,
    1,
    600
}

Courier metrics.

Definition at line 305 of file NPWText.c.

PDFInt16 afmHelvetica[] [static]

Initial value:

{
    -100,
    50,
    523,
    718,
    -207,
    32,
    149,
    278,    278,    355,    556,    556,    889,    667,    222,
    333,    333,    389,    584,    278,    333,    278,    278,
    556,    556,    556,    556,    556,    556,    556,    556,
    556,    556,    278,    278,    584,    584,    584,    556,
    1015,   667,    667,    722,    722,    667,    611,    778,
    722,    278,    500,    667,    556,    833,    722,    778,
    667,    778,    722,    667,    611,    722,    667,    944,
    667,    667,    611,    278,    278,    278,    469,    556,
    222,    556,    556,    500,    556,    556,    278,    556,
    556,    222,    222,    500,    222,    833,    556,    556,
    556,    556,    333,    500,    278,    556,    500,    722,
    500,    500,    500,    334,    260,    334,    584,    333,
    556,    556,    167,    556,    556,    556,    556,    191,
    333,    556,    333,    333,    500,    500,    556,    556,
    556,    278,    537,    350,    222,    333,    333,    556,
    1000,   1000,   611,    333,    333,    333,    333,    333,
    333,    333,    333,    333,    333,    333,    333,    333,
    1000,   1000,   370,    556,    778,    1000,   365,    889,
    278,    222,    611,    944,    611
}

Helvetica metrics.

Definition at line 181 of file NPWText.c.

PDFInt16 afmHelveticaBold[] [static]

Initial value:

{
    -100,
    50,
    532,
    718,
    -207,
    32,
    149,
    278,    333,    474,    556,    556,    889,    722,    278,
    333,    333,    389,    584,    278,    333,    278,    278,
    556,    556,    556,    556,    556,    556,    556,    556,
    556,    556,    333,    333,    584,    584,    584,    611,
    975,    722,    722,    722,    722,    667,    611,    778,
    722,    278,    556,    722,    611,    833,    722,    778,
    667,    778,    722,    667,    611,    722,    667,    944,
    667,    667,    611,    333,    278,    333,    584,    556,
    278,    556,    611,    556,    611,    556,    333,    611,
    611,    278,    278,    556,    278,    889,    611,    611,
    611,    611,    389,    556,    333,    611,    556,    778,
    556,    556,    500,    389,    280,    389,    584,    333,
    556,    556,    167,    556,    556,    556,    556,    238,
    500,    556,    333,    333,    611,    611,    556,    556,
    556,    278,    556,    350,    278,    500,    500,    556,
    1000,   1000,   611,    333,    333,    333,    333,    333,
    333,    333,    333,    333,    333,    333,    333,    333,
    1000,   1000,   370,    611,    778,    1000,   365,    889,
    278,    278,    611,    944,    611
}

Helvetica-bold metrics.

Definition at line 243 of file NPWText.c.

PDFInt16 afmHelveticaBoldOblique[] [static]

Initial value:

{
    -100,
    50,
    532,
    718,
    -207,
    32,
    149,
    278,    333,    474,    556,    556,    889,    722,    278,
    333,    333,    389,    584,    278,    333,    278,    278,
    556,    556,    556,    556,    556,    556,    556,    556,
    556,    556,    333,    333,    584,    584,    584,    611,
    975,    722,    722,    722,    722,    667,    611,    778,
    722,    278,    556,    722,    611,    833,    722,    778,
    667,    778,    722,    667,    611,    722,    667,    944,
    667,    667,    611,    333,    278,    333,    584,    556,
    278,    556,    611,    556,    611,    556,    333,    611,
    611,    278,    278,    556,    278,    889,    611,    611,
    611,    611,    389,    556,    333,    611,    556,    778,
    556,    556,    500,    389,    280,    389,    584,    333,
    556,    556,    167,    556,    556,    556,    556,    238,
    500,    556,    333,    333,    611,    611,    556,    556,
    556,    278,    556,    350,    278,    500,    500,    556,
    1000,   1000,   611,    333,    333,    333,    333,    333,
    333,    333,    333,    333,    333,    333,    333,    333,
    1000,   1000,   370,    611,    778,    1000,   365,    889,
    278,    278,    611,    944,    611,
}

Helvetica-boldoblique metrics.

Definition at line 274 of file NPWText.c.

PDFInt16 afmHelveticaOblique[] [static]

Initial value:

{
    -100,
    50,
    523,
    718,
    -207,
    32,
    149,
    278,    278,    355,    556,    556,    889,    667,    222,
    333,    333,    389,    584,    278,    333,    278,    278,
    556,    556,    556,    556,    556,    556,    556,    556,
    556,    556,    278,    278,    584,    584,    584,    556,
    1015,   667,    667,    722,    722,    667,    611,    778,
    722,    278,    500,    667,    556,    833,    722,    778,
    667,    778,    722,    667,    611,    722,    667,    944,
    667,    667,    611,    278,    278,    278,    469,    556,
    222,    556,    556,    500,    556,    556,    278,    556,
    556,    222,    222,    500,    222,    833,    556,    556,
    556,    556,    333,    500,    278,    556,    500,    722,
    500,    500,    500,    334,    260,    334,    584,    333,
    556,    556,    167,    556,    556,    556,    556,    191,
    333,    556,    333,    333,    500,    500,    556,    556,
    556,    278,    537,    350,    222,    333,    333,    556,
    1000,   1000,   611,    333,    333,    333,    333,    333,
    333,    333,    333,    333,    333,    333,    333,    333,
    1000,   1000,   370,    556,    778,    1000,   365,    889,
    278,    222,    611,    944,    611
}

Helvetica-oblique metrics.

Definition at line 212 of file NPWText.c.

PDFInt16 afmTimesBold[] [static]

Initial value:

{
    -100,
    50,
    461,
    683,
    -217,
    32,
    149,
    250,    333,    555,    500,    500,    1000,   833,    333,
    333,    333,    500,    570,    250,    333,    250,    278,
    500,    500,    500,    500,    500,    500,    500,    500,
    500,    500,    333,    333,    570,    570,    570,    500,
    930,    722,    667,    722,    722,    667,    611,    778,
    778,    389,    500,    778,    667,    944,    722,    778,
    611,    778,    722,    556,    667,    722,    722,    1000,
    722,    722,    667,    333,    278,    333,    581,    500,
    333,    500,    556,    444,    556,    444,    333,    500,
    556,    278,    333,    556,    278,    833,    556,    500,
    556,    556,    444,    389,    333,    556,    500,    722,
    500,    500,    444,    394,    220,    394,    520,    333,
    500,    500,    167,    500,    500,    500,    500,    278,
    500,    500,    333,    333,    556,    556,    500,    500,
    500,    250,    540,    350,    333,    500,    500,    500,
    1000,   1000,   500,    333,    333,    333,    333,    333,
    333,    333,    333,    333,    333,    333,    333,    333,
    1000,   1000,   300,    667,    778,    1000,   330,    722,
    278,    278,    500,    722,    556
}

Times-Bold metrics.

Definition at line 119 of file NPWText.c.

PDFInt16 afmTimesBoldItalic[] [static]

Initial value:

{
    -100,
    50,
    462,
    683,
    -217,
    32,
    149,
    250,    389,    555,    500,    500,    833,    778,    333,
    333,    333,    500,    570,    250,    333,    250,    278,
    500,    500,    500,    500,    500,    500,    500,    500,
    500,    500,    333,    333,    570,    570,    570,    500,
    832,    667,    667,    667,    722,    667,    667,    722,
    778,    389,    500,    667,    611,    889,    722,    722,
    611,    722,    667,    556,    611,    722,    667,    889,
    667,    611,    611,    333,    278,    333,    570,    500,
    333,    500,    500,    444,    500,    444,    333,    500,
    556,    278,    278,    500,    278,    778,    556,    500,
    500,    500,    389,    389,    278,    556,    444,    667,
    500,    444,    389,    348,    220,    348,    570,    389,
    500,    500,    167,    500,    500,    500,    500,    278,
    500,    500,    333,    333,    556,    556,    500,    500,
    500,    250,    500,    350,    333,    500,    500,    500,
    1000,   1000,   500,    333,    333,    333,    333,    333,
    333,    333,    333,    333,    333,    333,    333,    333,
    1000,   944,    266,    611,    722,    944,    300,    722,
    278,    278,    500,    722,    500
}

Times-BoldItalic metrics.

Definition at line 150 of file NPWText.c.

PDFInt16 afmTimesItalic[] [static]

Initial value:

{
    -100,
    50,
    441,
    683,
    -217,
    32,
    149,
    250,    333,    420,    500,    500,    833,    778,    333,
    333,    333,    500,    675,    250,    333,    250,    278,
    500,    500,    500,    500,    500,    500,    500,    500,
    500,    500,    333,    333,    675,    675,    675,    500,
    920,    611,    611,    667,    722,    611,    611,    722,
    722,    333,    444,    667,    556,    833,    667,    722,
    611,    722,    611,    500,    556,    722,    611,    833,
    611,    556,    556,    389,    278,    389,    422,    500,
    333,    500,    500,    444,    500,    444,    278,    500,
    500,    278,    278,    444,    278,    722,    500,    500,
    500,    500,    389,    389,    278,    500,    444,    667,
    444,    444,    389,    400,    275,    400,    541,    389,
    500,    500,    167,    500,    500,    500,    500,    214,
    556,    500,    333,    333,    500,    500,    500,    500,
    500,    250,    523,    350,    333,    556,    556,    500,
    889,    1000,   500,    333,    333,    333,    333,    333,
    333,    333,    333,    333,    333,    333,    333,    333,
    889,    889,    276,    556,    722,    944,    310,    667,
    278,    278,    500,    667,    500
}

Times-Italic metrics.

Definition at line 88 of file NPWText.c.

PDFInt16 afmTimesRoman[] [static]

Initial value:

{
    -100,
    50,
    450,
    683,
    -217,
    32,
    149,
    250,    333,    408,    500,    500,    833,    778,    333,
    333,    333,    500,    564,    250,    333,    250,    278,
    500,    500,    500,    500,    500,    500,    500,    500,
    500,    500,    278,    278,    564,    564,    564,    444,
    921,    722,    667,    667,    722,    611,    556,    722,
    722,    333,    389,    722,    611,    889,    722,    722,
    556,    722,    667,    556,    611,    722,    722,    944,
    722,    722,    611,    333,    278,    333,    469,    500,
    333,    444,    500,    444,    500,    444,    333,    500,
    500,    278,    278,    500,    278,    778,    500,    500,
    500,    500,    333,    389,    278,    500,    500,    722,
    500,    500,    444,    480,    200,    480,    541,    333,
    500,    500,    167,    500,    500,    500,    500,    180,
    444,    500,    333,    333,    556,    556,    500,    500,
    500,    250,    453,    350,    333,    444,    444,    500,
    1000,   1000,   444,    333,    333,    333,    333,    333,
    333,    333,    333,    333,    333,    333,    333,    333,
    1000,   889,    276,    611,    722,    889,    310,    667,
    278,    278,    500,    722,    500
}

Times-Roman metrics.

Definition at line 57 of file NPWText.c.

FontMetrics const fonts[]

Initial value:

{
    {NPWFontNameTimesRoman, afmTimesRoman},
    {NPWFontNameTimesItalic, afmTimesItalic},
    {NPWFontNameTimesBold, afmTimesBold},
    {NPWFontNameTimesBoldItalic, afmTimesBoldItalic},
    {NPWFontNameHelvetica, afmHelvetica},
    {NPWFontNameHelveticaOblique, afmHelveticaOblique},
    {NPWFontNameHelveticaBold, afmHelveticaBold},
    {NPWFontNameHelveticaBoldOblique, afmHelveticaBoldOblique},
    {NPWFontNameCourier, afmCourier},
    {NPWFontNameCourierOblique, afmCourier},
    {NPWFontNameCourierBold, afmCourier},
    {NPWFontNameCourierBoldOblique, afmCourier},
    {NPWFontNameSymbol, afmSymbol},
    {NPWFontNameZapfDingbats, afmZapfDingbats},
    {NULL, NULL}
}

AFM font metrics for standard PDF fonts.

Definition at line 399 of file NPWText.c.