mandoc/roff.3 - diff

Return to roff.3 CVS log

Up to [cvsweb.bsd.lv] / mandoc

Diff for /mandoc/Attic/roff.3 between version 1.5 and 1.10

version 1.5, 2010/07/04 22:04:04

version 1.10, 2011/01/01 16:18:39

Line 1

.\" $Id$

.\"

.\" Permission to use, copy, modify, and distribute this software for any

.\" purpose with or without fee is hereby granted, provided that the above

Line 24

Line 23

.Nm roff_endparse ,

.Nm roff_free ,

.Nm roff_parseln ,

.Nm roff_reset

.Nm roff_reset ,

.Nm roff_span

.Nd roff macro compiler library

.Sh SYNOPSIS

.In mandoc.h

.In regs.h

.In roff.h

.Ft "struct roff *"

.Fo roff_alloc

.Fa "struct regset *regs"

.Fa "mandocmsg msgs"

.Fa "void *data"

.Fa "mandocmsg msgs"

.Fc

.Ft int

.Ft void

.Fn roff_endparse "struct roff *roff"

.Ft void

.Fn roff_free "struct roff *roff"

Line 51

Line 50

.Fc

.Ft void

.Fn roff_reset "struct roff *roff"

.In regs.h

.Ft "const struct tbl_span *"

.Ft "char *"

.Fn roff_span "const struct roff *roff"

.Fn roff_setstr "const char *name" "const char *string"

.Ft "char *"

.Fn roff_getstr "const char *name"

.Ft "char *"

.Fn roff_getstrn "const char *name" "size_t len"

.Ft void

.Fn roff_freestr void

.Sh DESCRIPTION

The

.Nm

Line 122 The

Line 114 The

.Fa data

pointer is passed to

.Fa msgs .

The

.Fa pflags

arguments are defined in

.Pa roff.h .

Returns NULL on failure.

If non-NULL, the pointer must be freed with

.Fn roff_free .

Line 153 This line should not contain the trailing newline.

Line 141 This line should not contain the trailing newline.

Returns 0 on failure, 1 on success.

.It Fn roff_endparse

Signals that the parse is complete.

Returns 0 on failure, 1 on success.

.It Fn roff_span

.Fn roff_parseln

returned

.Va ROFF_TBL ,

return the last parsed table row.

Returns NULL otherwise.

.El

.Sh USER-DEFINED STRINGS

Strings defined by the

.Xr roff 7

.Sx \&ds

instruction are saved using the

.Fn roff_setstr

function and retrieved using the

.Fn roff_getstr

and

.Fn roff_getstrn

functions.

.Pp

These functions take the name of the string to be accessed

as their first argument.

While

.Fn roff_getstr

requires the name to be null-terminated,

.Fn roff_getstrn

accepts non-terminated strings, but requires the length of the name

to be specified.

.Pp

The second argument to

.Fn roff_setstr

is the new value of the string.

It will be copied to internal storage, so both pointers to constant

strings and pointers to volatile storage are acceptable.

.Pp

All of these functions return a pointer to the new value of the string

in internal storage, which should be considered read-only, so use

.Xr strdup 3

on it as appropriate.

The read functions return NULL when a string of the specified name

is not available or empty, and

.Fn roff_setstr

returns NULL when memory allocation fails.

In the latter case, the string will remain unset.

.Pp

The function

.Fn roff_freestr

clears all user-defined strings.

It always succeeds.

Both

.Fn roff_reset

and

.Fn roff_free

call it.

.Sh EXAMPLES

See

.Pa main.c

CVSweb