version 1.174, 2019/04/30 15:53:00 |
version 1.182, 2022/07/05 21:25:29 |
|
|
/* $Id$ */ |
/* $Id$ */ |
/* |
/* |
|
* Copyright (c) 2013-2015,2017-2020,2022 Ingo Schwarze <schwarze@openbsd.org> |
* Copyright (c) 2008-2012, 2014 Kristaps Dzonsons <kristaps@bsd.lv> |
* Copyright (c) 2008-2012, 2014 Kristaps Dzonsons <kristaps@bsd.lv> |
* Copyright (c) 2013-2015, 2017-2019 Ingo Schwarze <schwarze@openbsd.org> |
|
* |
* |
* Permission to use, copy, modify, and distribute this software for any |
* Permission to use, copy, modify, and distribute this software for any |
* purpose with or without fee is hereby granted, provided that the above |
* purpose with or without fee is hereby granted, provided that the above |
|
|
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN |
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF |
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
|
* |
|
* HTML formatter for man(7) used by mandoc(1). |
*/ |
*/ |
#include "config.h" |
#include "config.h" |
|
|
|
|
#include "main.h" |
#include "main.h" |
|
|
#define MAN_ARGS const struct roff_meta *man, \ |
#define MAN_ARGS const struct roff_meta *man, \ |
const struct roff_node *n, \ |
struct roff_node *n, \ |
struct html *h |
struct html *h |
|
|
struct man_html_act { |
struct man_html_act { |
Line 121 html_man(void *arg, const struct roff_meta *man) |
|
Line 123 html_man(void *arg, const struct roff_meta *man) |
|
if ((h->oflags & HTML_FRAGMENT) == 0) { |
if ((h->oflags & HTML_FRAGMENT) == 0) { |
print_gen_decls(h); |
print_gen_decls(h); |
print_otag(h, TAG_HTML, ""); |
print_otag(h, TAG_HTML, ""); |
if (n != NULL && n->type == ROFFT_COMMENT) |
|
print_gen_comment(h, n); |
|
t = print_otag(h, TAG_HEAD, ""); |
t = print_otag(h, TAG_HEAD, ""); |
print_man_head(man, h); |
print_man_head(man, h); |
print_tagq(h, t); |
print_tagq(h, t); |
|
if (n != NULL && n->type == ROFFT_COMMENT) |
|
print_gen_comment(h, n); |
print_otag(h, TAG_BODY, ""); |
print_otag(h, TAG_BODY, ""); |
} |
} |
|
|
man_root_pre(man, h); |
man_root_pre(man, h); |
t = print_otag(h, TAG_DIV, "c", "manual-text"); |
t = print_otag(h, TAG_MAIN, "c", "manual-text"); |
print_man_nodelist(man, n, h); |
print_man_nodelist(man, n, h); |
print_tagq(h, t); |
print_tagq(h, t); |
man_root_post(man, h); |
man_root_post(man, h); |
Line 167 print_man_node(MAN_ARGS) |
|
Line 169 print_man_node(MAN_ARGS) |
|
if (n->type == ROFFT_COMMENT || n->flags & NODE_NOPRT) |
if (n->type == ROFFT_COMMENT || n->flags & NODE_NOPRT) |
return; |
return; |
|
|
html_fillmode(h, n->flags & NODE_NOFILL ? ROFF_nf : ROFF_fi); |
if ((n->flags & NODE_NOFILL) == 0) |
|
html_fillmode(h, ROFF_fi); |
|
else if (html_fillmode(h, ROFF_nf) == ROFF_nf && |
|
n->tok != ROFF_fi && n->flags & NODE_LINE && |
|
(n->prev == NULL || n->prev->tok != MAN_YS)) |
|
print_endline(h); |
|
|
child = 1; |
child = 1; |
switch (n->type) { |
switch (n->type) { |
Line 178 print_man_node(MAN_ARGS) |
|
Line 185 print_man_node(MAN_ARGS) |
|
} |
} |
if (*n->string == ' ' && n->flags & NODE_LINE && |
if (*n->string == ' ' && n->flags & NODE_LINE && |
(h->flags & HTML_NONEWLINE) == 0) |
(h->flags & HTML_NONEWLINE) == 0) |
print_endline(h); |
print_otag(h, TAG_BR, ""); |
else if (n->flags & NODE_DELIMC) |
else if (n->flags & NODE_DELIMC) |
h->flags |= HTML_NOSPACE; |
h->flags |= HTML_NOSPACE; |
t = h->tag; |
t = h->tag; |
Line 244 print_man_node(MAN_ARGS) |
|
Line 251 print_man_node(MAN_ARGS) |
|
* Close the list if no further item of the same type |
* Close the list if no further item of the same type |
* follows; otherwise, close the item only. |
* follows; otherwise, close the item only. |
*/ |
*/ |
if (list_continues(n, n->next) == '\0') { |
if (list_continues(n, roff_node_next(n)) == '\0') { |
print_tagq(h, t); |
print_tagq(h, t); |
t = NULL; |
t = NULL; |
} |
} |
} |
} |
if (t != NULL) |
if (t != NULL) |
print_stagq(h, t); |
print_stagq(h, t); |
|
|
if (n->flags & NODE_NOFILL && n->tok != MAN_YS && |
|
(n->next != NULL && n->next->flags & NODE_LINE)) { |
|
/* In .nf = <pre>, print even empty lines. */ |
|
h->col++; |
|
print_endline(h); |
|
} |
|
} |
} |
|
|
static void |
static void |
man_root_pre(const struct roff_meta *man, struct html *h) |
man_root_pre(const struct roff_meta *man, struct html *h) |
{ |
{ |
struct tag *t, *tt; |
struct tag *t; |
char *title; |
char *title; |
|
|
assert(man->title); |
assert(man->title); |
assert(man->msec); |
assert(man->msec); |
mandoc_asprintf(&title, "%s(%s)", man->title, man->msec); |
mandoc_asprintf(&title, "%s(%s)", man->title, man->msec); |
|
|
t = print_otag(h, TAG_TABLE, "c", "head"); |
t = print_otag(h, TAG_DIV, "cr?", "head", "doc-pageheader", |
tt = print_otag(h, TAG_TR, ""); |
"aria-label", "manual header line"); |
|
|
print_otag(h, TAG_TD, "c", "head-ltitle"); |
print_otag(h, TAG_SPAN, "c", "head-ltitle"); |
print_text(h, title); |
print_text(h, title); |
print_stagq(h, tt); |
print_stagq(h, t); |
|
|
print_otag(h, TAG_TD, "c", "head-vol"); |
print_otag(h, TAG_SPAN, "c", "head-vol"); |
if (man->vol != NULL) |
if (man->vol != NULL) |
print_text(h, man->vol); |
print_text(h, man->vol); |
print_stagq(h, tt); |
print_stagq(h, t); |
|
|
print_otag(h, TAG_TD, "c", "head-rtitle"); |
print_otag(h, TAG_SPAN, "c", "head-rtitle"); |
print_text(h, title); |
print_text(h, title); |
print_tagq(h, t); |
print_tagq(h, t); |
free(title); |
free(title); |
Line 291 man_root_pre(const struct roff_meta *man, struct html |
|
Line 291 man_root_pre(const struct roff_meta *man, struct html |
|
static void |
static void |
man_root_post(const struct roff_meta *man, struct html *h) |
man_root_post(const struct roff_meta *man, struct html *h) |
{ |
{ |
struct tag *t, *tt; |
struct tag *t; |
|
|
t = print_otag(h, TAG_TABLE, "c", "foot"); |
t = print_otag(h, TAG_DIV, "cr?", "foot", "doc-pagefooter", |
tt = print_otag(h, TAG_TR, ""); |
"aria-label", "manual footer line"); |
|
|
print_otag(h, TAG_TD, "c", "foot-date"); |
print_otag(h, TAG_SPAN, "c", "foot-left"); |
|
print_stagq(h, t); |
|
|
|
print_otag(h, TAG_SPAN, "c", "foot-date"); |
print_text(h, man->date); |
print_text(h, man->date); |
print_stagq(h, tt); |
print_stagq(h, t); |
|
|
print_otag(h, TAG_TD, "c", "foot-os"); |
print_otag(h, TAG_SPAN, "c", "foot-os"); |
if (man->os != NULL) |
if (man->os != NULL) |
print_text(h, man->os); |
print_text(h, man->os); |
print_tagq(h, t); |
print_tagq(h, t); |
|
|
man_SH_pre(MAN_ARGS) |
man_SH_pre(MAN_ARGS) |
{ |
{ |
const char *class; |
const char *class; |
char *id; |
|
enum htmltag tag; |
enum htmltag tag; |
|
|
if (n->tok == MAN_SH) { |
if (n->tok == MAN_SH) { |
Line 326 man_SH_pre(MAN_ARGS) |
|
Line 328 man_SH_pre(MAN_ARGS) |
|
print_otag(h, TAG_SECTION, "c", class); |
print_otag(h, TAG_SECTION, "c", class); |
break; |
break; |
case ROFFT_HEAD: |
case ROFFT_HEAD: |
id = html_make_id(n, 1); |
print_otag_id(h, tag, class, n); |
print_otag(h, tag, "ci", class, id); |
|
if (id != NULL) |
|
print_otag(h, TAG_A, "chR", "permalink", id); |
|
break; |
break; |
case ROFFT_BODY: |
case ROFFT_BODY: |
break; |
break; |
Line 445 list_continues(const struct roff_node *n1, const struc |
|
Line 444 list_continues(const struct roff_node *n1, const struc |
|
static int |
static int |
man_IP_pre(MAN_ARGS) |
man_IP_pre(MAN_ARGS) |
{ |
{ |
const struct roff_node *nn; |
struct roff_node *nn; |
const char *list_class; |
const char *list_class; |
enum htmltag list_elem, body_elem; |
enum htmltag list_elem, body_elem; |
char list_type; |
char list_type; |
|
|
nn = n->type == ROFFT_BLOCK ? n : n->parent; |
nn = n->type == ROFFT_BLOCK ? n : n->parent; |
if ((list_type = list_continues(nn->prev, nn)) == '\0') { |
list_type = list_continues(roff_node_prev(nn), nn); |
|
if (list_type == '\0') { |
/* Start a new list. */ |
/* Start a new list. */ |
if ((list_type = list_continues(nn, nn->next)) == '\0') |
list_type = list_continues(nn, roff_node_next(nn)); |
|
if (list_type == '\0') |
list_type = ' '; |
list_type = ' '; |
switch (list_type) { |
switch (list_type) { |
case ' ': |
case ' ': |
Line 487 man_IP_pre(MAN_ARGS) |
|
Line 488 man_IP_pre(MAN_ARGS) |
|
case ROFFT_HEAD: |
case ROFFT_HEAD: |
if (body_elem == TAG_LI) |
if (body_elem == TAG_LI) |
return 0; |
return 0; |
print_otag(h, TAG_DT, ""); |
print_otag_id(h, TAG_DT, NULL, n); |
break; |
break; |
case ROFFT_BODY: |
case ROFFT_BODY: |
print_otag(h, body_elem, ""); |
print_otag(h, body_elem, ""); |
Line 495 man_IP_pre(MAN_ARGS) |
|
Line 496 man_IP_pre(MAN_ARGS) |
|
default: |
default: |
abort(); |
abort(); |
} |
} |
|
|
switch(n->tok) { |
switch(n->tok) { |
case MAN_IP: /* Only print the first header element. */ |
case MAN_IP: /* Only print the first header element. */ |
if (n->child != NULL) |
if (n->child != NULL) |