diff options
author | Ingo Schwarze <schwarze@openbsd.org> | 2014-03-23 11:25:25 +0000 |
---|---|---|
committer | Ingo Schwarze <schwarze@openbsd.org> | 2014-03-23 11:25:25 +0000 |
commit | f40dcc7e2054a99977d444c5fa36868fba2c3f36 (patch) | |
tree | c8afef4d61b8627cc3dd4afa60978cec91753911 /mandoc.3 | |
parent | 119d1dcb94c6593777a29408f57b0568ec13482b (diff) | |
download | mandoc-f40dcc7e2054a99977d444c5fa36868fba2c3f36.tar.gz |
The files mandoc.c and mandoc.h contained both specialised low-level
functions used for multiple languages (mdoc, man, roff), for example
mandoc_escape(), mandoc_getarg(), mandoc_eos(), and generic auxiliary
functions. Split the auxiliaries out into their own file and header.
While here, do some #include cleanup.
Diffstat (limited to 'mandoc.3')
-rw-r--r-- | mandoc.3 | 80 |
1 files changed, 55 insertions, 25 deletions
@@ -20,7 +20,12 @@ .Os .Sh NAME .Nm mandoc , +.Nm mandoc_calloc , .Nm mandoc_escape , +.Nm mandoc_malloc , +.Nm mandoc_realloc , +.Nm mandoc_strdup , +.Nm mandoc_strndup , .Nm man_meta , .Nm man_mparse , .Nm man_node , @@ -45,28 +50,30 @@ .Sh LIBRARY .Lb libmandoc .Sh SYNOPSIS -.In man.h -.In mdoc.h .In mandoc.h +.Fd "#define ASCII_NBRSP" +.Fd "#define ASCII_HYPH" +.Fd "#define ASCII_BREAK" +.Ft "void *" +.Fo mandoc_calloc +.Fa "size_t nmemb" +.Fa "size_t size" +.Fc .Ft "enum mandoc_esc" .Fo mandoc_escape .Fa "const char **end" .Fa "const char **start" .Fa "int *sz" .Fc -.Ft "const struct man_meta *" -.Fo man_meta -.Fa "const struct man *man" -.Fc -.Ft "const struct mparse *" -.Fo man_mparse -.Fa "const struct man *man" -.Fc -.Ft "const struct man_node *" -.Fo man_node -.Fa "const struct man *man" -.Fc +.Ft "void *" +.Fn mandoc_malloc "size_t size" .Ft "struct mchars *" +.Fo mandoc_realloc +.Fa "void *ptr" +.Fa "size_t size" +.Fc +.Ft "char *" +.Fn mandoc_strdup .Fn mchars_alloc "void" .Ft void .Fn mchars_free "struct mchars *p" @@ -87,14 +94,6 @@ .Fa "const char *cp" .Fa "size_t sz" .Fc -.Ft "const struct mdoc_meta *" -.Fo mdoc_meta -.Fa "const struct mdoc *mdoc" -.Fc -.Ft "const struct mdoc_node *" -.Fo mdoc_node -.Fa "const struct mdoc *mdoc" -.Fc .Ft void .Fo mparse_alloc .Fa "enum mparset inttype" @@ -104,6 +103,15 @@ .Fa "int quick" .Fc .Ft void +.Fo (*mandocmsg) +.Fa "enum mandocerr errtype" +.Fa "enum mandoclevel level" +.Fa "const char *file" +.Fa "int line" +.Fa "int col" +.Fa "const char *msg" +.Fc +.Ft void .Fo mparse_free .Fa "struct mparse *parse" .Fc @@ -139,11 +147,33 @@ .Fo mparse_strlevel .Fa "enum mandoclevel" .Fc -.Vt extern const char * const * man_macronames; +.In mandoc.h +.In mdoc.h +.Ft "const struct mdoc_meta *" +.Fo mdoc_meta +.Fa "const struct mdoc *mdoc" +.Fc +.Ft "const struct mdoc_node *" +.Fo mdoc_node +.Fa "const struct mdoc *mdoc" +.Fc .Vt extern const char * const * mdoc_argnames; .Vt extern const char * const * mdoc_macronames; -.Fd "#define ASCII_NBRSP" -.Fd "#define ASCII_HYPH" +.In mandoc.h +.In man.h +.Ft "const struct man_meta *" +.Fo man_meta +.Fa "const struct man *man" +.Fc +.Ft "const struct mparse *" +.Fo man_mparse +.Fa "const struct man *man" +.Fc +.Ft "const struct man_node *" +.Fo man_node +.Fa "const struct man *man" +.Fc +.Vt extern const char * const * man_macronames; .Sh DESCRIPTION The .Nm mandoc |