Let the line-number of a tbl_span be remembered.

[mandoc.git] / roff.3

diff --git a/roff.3 b/roff.3
index 961daff5b92bc70fb566775161c4e0999c0c13a5..7d8bff5c1b6ef34c7c28bb5d777a3feb1ffde04b 100644 (file)
--- a/roff.3
+++ b/roff.3
@@ -1,4 +1,4 @@
-.\"    $Id: roff.3,v 1.2 2010/06/26 15:22:19 kristaps Exp $
+.\"    $Id: roff.3,v 1.10 2011/01/01 16:18:39 kristaps Exp $

 .\"
 .\" Copyright (c) 2010 Kristaps Dzonsons <kristaps@bsd.lv>
 .\"
 .\"
 .\" Copyright (c) 2010 Kristaps Dzonsons <kristaps@bsd.lv>
 .\"


@@ -14,7 +14,7 @@
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"
 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 .\"

-.Dd $Mdocdate: June 26 2010 $
+.Dd $Mdocdate: January 1 2011 $

 .Dt ROFF 3
 .Os
 .Sh NAME
 .Dt ROFF 3
 .Os
 .Sh NAME


@@ -23,15 +23,19 @@
 .Nm roff_endparse ,
 .Nm roff_free ,
 .Nm roff_parseln ,
 .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
 .Nd roff macro compiler library
 .Sh SYNOPSIS
 .In mandoc.h

-.In regs.h

 .In roff.h
 .Ft "struct roff *"
 .In roff.h
 .Ft "struct roff *"

-.Fn roff_alloc "mandocmsg msgs" "void *data"
-.Ft int
+.Fo roff_alloc
+.Fa "struct regset *regs"
+.Fa "void *data"
+.Fa "mandocmsg msgs"
+.Fc
+.Ft void

 .Fn roff_endparse "struct roff *roff"
 .Ft void
 .Fn roff_free "struct roff *roff"
 .Fn roff_endparse "struct roff *roff"
 .Ft void
 .Fn roff_free "struct roff *roff"


@@ -46,6 +50,8 @@
 .Fc
 .Ft void
 .Fn roff_reset "struct roff *roff"
 .Fc
 .Ft void
 .Fn roff_reset "struct roff *roff"

+.Ft "const struct tbl_span *"
+.Fn roff_span "const struct roff *roff"

 .Sh DESCRIPTION
 The
 .Nm
 .Sh DESCRIPTION
 The
 .Nm


@@ -108,10 +114,6 @@ The
 .Fa data
 pointer is passed to
 .Fa msgs .
 .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 .
 Returns NULL on failure.
 If non-NULL, the pointer must be freed with
 .Fn roff_free .


@@ -139,7 +141,13 @@ 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_endparse
 Signals that the parse is complete.

-Returns 0 on failure, 1 on success.
+.It Fn roff_span
+If
+.Fn roff_parseln
+returned
+.Va ROFF_TBL ,
+return the last parsed table row.
+Returns NULL otherwise.

 .El
 .Sh EXAMPLES
 See
 .El
 .Sh EXAMPLES
 See


@@ -155,3 +163,15 @@ The
 .Nm
 library was written by
 .An Kristaps Dzonsons Aq kristaps@bsd.lv .
 .Nm
 library was written by
 .An Kristaps Dzonsons Aq kristaps@bsd.lv .

+.Sh BUGS
+The implementation of user-defined strings needs improvement:
+.Bl -dash
+.It
+String values are taken literally and are not interpreted.
+.It
+Parsing of quoted strings is incomplete.
+.It
+The stings are stored internally using a singly linked list,
+which is fine for small numbers of strings,
+but ineffient when handling many strings.
+.El