=================================================================== RCS file: /cvs/mandoc/Attic/man.3,v retrieving revision 1.27 retrieving revision 1.30 diff -u -p -r1.27 -r1.30 --- mandoc/Attic/man.3 2010/12/17 11:41:45 1.27 +++ mandoc/Attic/man.3 2011/02/09 09:18:15 1.30 @@ -1,4 +1,4 @@ -.\" $Id: man.3,v 1.27 2010/12/17 11:41:45 kristaps Exp $ +.\" $Id: man.3,v 1.30 2011/02/09 09:18:15 kristaps Exp $ .\" .\" Copyright (c) 2009-2010 Kristaps Dzonsons .\" @@ -14,11 +14,13 @@ .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. .\" -.Dd $Mdocdate: December 17 2010 $ +.Dd $Mdocdate: February 9 2011 $ .Dt MAN 3 .Os .Sh NAME .Nm man , +.Nm man_addeqn , +.Nm man_addspan , .Nm man_alloc , .Nm man_endparse , .Nm man_free , @@ -31,6 +33,16 @@ .In mandoc.h .In man.h .Vt extern const char * const * man_macronames; +.Ft int +.Fo man_addeqn +.Fa "struct man *man" +.Fa "const struct eqn *eqn" +.Fc +.Ft int +.Fo man_addspan +.Fa "struct man *man" +.Fa "const struct tbl_span *span" +.Fc .Ft "struct man *" .Fo man_alloc .Fa "struct regset *regs" @@ -100,15 +112,32 @@ See for details. .El .Ss Functions +If +.Fn man_addeqn , +.Fn man_addspan , +.Fn man_parseln , +or +.Fn man_endparse +return 0, calls to any function but +.Fn man_reset +or +.Fn man_free +will raise an assertion. .Bl -ohang +.It Fn man_addeqn +Add an equation to the parsing stream. +Returns 0 on failure, 1 on success. +.It Fn man_addspan +Add a table span to the parsing stream. +Returns 0 on failure, 1 on success. .It Fn man_alloc Allocates a parsing structure. The .Fa data pointer is passed to .Fa msgs . -Returns NULL on failure. -If non-NULL, the pointer must be freed with +Always returns a valid pointer. +The pointer must be freed with .Fn man_free . .It Fn man_reset Reset the parser for another parse routine. @@ -127,26 +156,11 @@ The input buffer is modified by this function. .It Fn man_endparse Signals that the parse is complete. -Note that if -.Fn man_endparse -is called subsequent to -.Fn man_node , -the resulting tree is incomplete. Returns 0 on failure, 1 on success. .It Fn man_node Returns the first node of the parse. -Note that if -.Fn man_parseln -or -.Fn man_endparse -return 0, the tree will be incomplete. .It Fn man_meta Returns the document's parsed meta-data. -If this information has not yet been supplied or -.Fn man_parseln -or -.Fn man_endparse -return 0, the data will be incomplete. .El .Ss Variables The following variables are also defined: