Major character table cleanup:

[mandoc.git] / mchars_alloc.3

diff --git a/mchars_alloc.3 b/mchars_alloc.3
index 8c3f853492f24ac8a7572c6d217da5ab8132f2c7..2d42a432e5e6d8813bba3d80c0a65df1fd21771e 100644 (file)
--- a/mchars_alloc.3
+++ b/mchars_alloc.3
@@ -1,4 +1,4 @@
-.\"    $Id: mchars_alloc.3,v 1.1 2014/08/05 05:48:56 schwarze Exp $
+.\"    $Id: mchars_alloc.3,v 1.3 2015/10/13 22:59:54 schwarze Exp $
 .\"
 .\" Copyright (c) 2014 Ingo Schwarze <schwarze@openbsd.org>
 .\"
@@ -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.
 .\"
-.Dd $Mdocdate: August 5 2014 $
+.Dd $Mdocdate: October 13 2015 $
 .Dt MCHARS_ALLOC 3
 .Os
 .Sh NAME
@@ -25,17 +25,13 @@
 .Nm mchars_spec2cp ,
 .Nm mchars_spec2str
 .Nd character table for mandoc
-.Sh LIBRARY
-.Lb libmandoc
 .Sh SYNOPSIS
 .In sys/types.h
 .In mandoc.h
-.Ft "struct mchars *"
-.Fn mchars_alloc "void"
 .Ft void
-.Fo mchars_free
-.Fa "struct mchars *table"
-.Fc
+.Fn mchars_alloc void
+.Ft void
+.Fn mchars_free void
 .Ft char
 .Fo mchars_num2char
 .Fa "const char *decimal"
@@ -48,17 +44,17 @@
 .Fc
 .Ft int
 .Fo mchars_spec2cp
-.Fa "const struct mchars *table"
 .Fa "const char *name"
 .Fa "size_t sz"
 .Fc
 .Ft "const char *"
 .Fo mchars_spec2str
-.Fa "const struct mchars *table"
 .Fa "const char *name"
 .Fa "size_t sz"
 .Fa "size_t *rsz"
 .Fc
+.Ft "const char *"
+.Fn mchars_uc2str "int codepoint"
 .Sh DESCRIPTION
 These functions translate Unicode character numbers and
 .Xr roff 7
@@ -133,9 +129,9 @@ escape sequences.
 .Pp
 The function
 .Fn mchars_alloc
-allocates an opaque
-.Vt "struct mchars *"
-table object for subsequent use by the following two lookup functions.
+initializes a static
+.Vt "struct ohash"
+object for subsequent use by the following two lookup functions.
 When no longer needed, this object can be destroyed with
 .Fn mchars_free .
 .Pp
@@ -147,9 +143,7 @@ special character
 .Fa name
 consisting of
 .Fa sz
-characters in the
-.Fa table
-and returns the corresponding Unicode codepoint.
+characters and returns the corresponding Unicode codepoint.
 If the
 .Ar name
 is not recognized, \-1 is returned.
@@ -173,9 +167,7 @@ special character
 .Fa name
 consisting of
 .Fa sz
-characters in the
-.Fa table
-and returns an ASCII string representation.
+characters and returns an ASCII string representation.
 The length of the representation is returned in
 .Fa rsz .
 In many cases, the meaning of such ASCII representations
@@ -199,12 +191,21 @@ output module use this function to render
 and
 .Ic \eC\(aq Ns Ar name Ns Ic \(aq
 escape sequences.
+.Pp
+The function
+.Fn mchars_uc2str
+performs a reverse lookup of the Unicode
+.Fa codepoint
+and returns an ASCII string representation, or the string
+.Qq <?>
+if none is available.
 .Sh FILES
 These funtions are implemented in the file
 .Pa chars.c .
 .Sh SEE ALSO
 .Xr mandoc 1 ,
 .Xr mandoc_escape 3 ,
+.Xr ohash_init 3 ,
 .Xr mandoc_char 7 ,
 .Xr roff 7
 .Sh HISTORY
@@ -218,6 +219,7 @@ following mandoc versions:
 .It Fn mchars_num2uc Ta 1.11.3 Ta \(em Ta \(em
 .It Fn mchars_spec2cp Ta 1.11.2 Ta Fn chars_spec2cp Ta 1.10.5
 .It Fn mchars_spec2str Ta 1.11.2 Ta Fn a2ascii Ta 1.5.3
+.It Fn mchars_uc2str Ta 1.13.2 Ta \(em Ta \(em
 .El
 .Sh AUTHORS
 .An Kristaps Dzonsons Aq Mt kristaps@bsd.lv