version 1.2, 2014/10/26 18:07:28 |
version 1.3, 2015/10/13 22:59:54 |
|
|
.Nm mchars_spec2cp , |
.Nm mchars_spec2cp , |
.Nm mchars_spec2str |
.Nm mchars_spec2str |
.Nd character table for mandoc |
.Nd character table for mandoc |
.Sh LIBRARY |
|
.Lb libmandoc |
|
.Sh SYNOPSIS |
.Sh SYNOPSIS |
.In sys/types.h |
.In sys/types.h |
.In mandoc.h |
.In mandoc.h |
.Ft "struct mchars *" |
|
.Fn mchars_alloc "void" |
|
.Ft void |
.Ft void |
.Fo mchars_free |
.Fn mchars_alloc void |
.Fa "struct mchars *table" |
.Ft void |
.Fc |
.Fn mchars_free void |
.Ft char |
.Ft char |
.Fo mchars_num2char |
.Fo mchars_num2char |
.Fa "const char *decimal" |
.Fa "const char *decimal" |
|
|
.Fc |
.Fc |
.Ft int |
.Ft int |
.Fo mchars_spec2cp |
.Fo mchars_spec2cp |
.Fa "const struct mchars *table" |
|
.Fa "const char *name" |
.Fa "const char *name" |
.Fa "size_t sz" |
.Fa "size_t sz" |
.Fc |
.Fc |
.Ft "const char *" |
.Ft "const char *" |
.Fo mchars_spec2str |
.Fo mchars_spec2str |
.Fa "const struct mchars *table" |
|
.Fa "const char *name" |
.Fa "const char *name" |
.Fa "size_t sz" |
.Fa "size_t sz" |
.Fa "size_t *rsz" |
.Fa "size_t *rsz" |
Line 135 escape sequences. |
|
Line 129 escape sequences. |
|
.Pp |
.Pp |
The function |
The function |
.Fn mchars_alloc |
.Fn mchars_alloc |
allocates an opaque |
initializes a static |
.Vt "struct mchars *" |
.Vt "struct ohash" |
table object for subsequent use by the following two lookup functions. |
object for subsequent use by the following two lookup functions. |
When no longer needed, this object can be destroyed with |
When no longer needed, this object can be destroyed with |
.Fn mchars_free . |
.Fn mchars_free . |
.Pp |
.Pp |
Line 149 special character |
|
Line 143 special character |
|
.Fa name |
.Fa name |
consisting of |
consisting of |
.Fa sz |
.Fa sz |
characters in the |
characters and returns the corresponding Unicode codepoint. |
.Fa table |
|
and returns the corresponding Unicode codepoint. |
|
If the |
If the |
.Ar name |
.Ar name |
is not recognized, \-1 is returned. |
is not recognized, \-1 is returned. |
Line 175 special character |
|
Line 167 special character |
|
.Fa name |
.Fa name |
consisting of |
consisting of |
.Fa sz |
.Fa sz |
characters in the |
characters and returns an ASCII string representation. |
.Fa table |
|
and returns an ASCII string representation. |
|
The length of the representation is returned in |
The length of the representation is returned in |
.Fa rsz . |
.Fa rsz . |
In many cases, the meaning of such ASCII representations |
In many cases, the meaning of such ASCII representations |
Line 215 These funtions are implemented in the file |
|
Line 205 These funtions are implemented in the file |
|
.Sh SEE ALSO |
.Sh SEE ALSO |
.Xr mandoc 1 , |
.Xr mandoc 1 , |
.Xr mandoc_escape 3 , |
.Xr mandoc_escape 3 , |
|
.Xr ohash_init 3 , |
.Xr mandoc_char 7 , |
.Xr mandoc_char 7 , |
.Xr roff 7 |
.Xr roff 7 |
.Sh HISTORY |
.Sh HISTORY |