version 1.172, 2019/03/01 10:57:18 |
version 1.187, 2023/10/24 20:53:12 |
|
|
/* $Id$ */ |
/* $Id$ */ |
/* |
/* |
|
* Copyright (c) 2013-15,2017-20,2022-23 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 46 static void print_man_head(const struct roff_meta * |
|
Line 48 static void print_man_head(const struct roff_meta * |
|
struct html *); |
struct html *); |
static void print_man_nodelist(MAN_ARGS); |
static void print_man_nodelist(MAN_ARGS); |
static void print_man_node(MAN_ARGS); |
static void print_man_node(MAN_ARGS); |
|
static char list_continues(const struct roff_node *, |
|
const struct roff_node *); |
static int man_B_pre(MAN_ARGS); |
static int man_B_pre(MAN_ARGS); |
static int man_IP_pre(MAN_ARGS); |
static int man_IP_pre(MAN_ARGS); |
static int man_I_pre(MAN_ARGS); |
static int man_I_pre(MAN_ARGS); |
|
static int man_MR_pre(MAN_ARGS); |
static int man_OP_pre(MAN_ARGS); |
static int man_OP_pre(MAN_ARGS); |
static int man_PP_pre(MAN_ARGS); |
static int man_PP_pre(MAN_ARGS); |
static int man_RS_pre(MAN_ARGS); |
static int man_RS_pre(MAN_ARGS); |
Line 56 static int man_SH_pre(MAN_ARGS); |
|
Line 61 static int man_SH_pre(MAN_ARGS); |
|
static int man_SM_pre(MAN_ARGS); |
static int man_SM_pre(MAN_ARGS); |
static int man_SY_pre(MAN_ARGS); |
static int man_SY_pre(MAN_ARGS); |
static int man_UR_pre(MAN_ARGS); |
static int man_UR_pre(MAN_ARGS); |
static int man_abort_pre(MAN_ARGS); |
|
static int man_alt_pre(MAN_ARGS); |
static int man_alt_pre(MAN_ARGS); |
static int man_ign_pre(MAN_ARGS); |
static int man_ign_pre(MAN_ARGS); |
static int man_in_pre(MAN_ARGS); |
static int man_in_pre(MAN_ARGS); |
Line 71 static const struct man_html_act man_html_acts[MAN_MAX |
|
Line 75 static const struct man_html_act man_html_acts[MAN_MAX |
|
{ man_SH_pre, NULL }, /* SS */ |
{ man_SH_pre, NULL }, /* SS */ |
{ man_IP_pre, NULL }, /* TP */ |
{ man_IP_pre, NULL }, /* TP */ |
{ man_IP_pre, NULL }, /* TQ */ |
{ man_IP_pre, NULL }, /* TQ */ |
{ man_abort_pre, NULL }, /* LP */ |
{ man_PP_pre, NULL }, /* LP */ |
{ man_PP_pre, NULL }, /* PP */ |
{ man_PP_pre, NULL }, /* PP */ |
{ man_abort_pre, NULL }, /* P */ |
{ man_PP_pre, NULL }, /* P */ |
{ man_IP_pre, NULL }, /* IP */ |
{ man_IP_pre, NULL }, /* IP */ |
{ man_PP_pre, NULL }, /* HP */ |
{ man_PP_pre, NULL }, /* HP */ |
{ man_SM_pre, NULL }, /* SM */ |
{ man_SM_pre, NULL }, /* SM */ |
Line 103 static const struct man_html_act man_html_acts[MAN_MAX |
|
Line 107 static const struct man_html_act man_html_acts[MAN_MAX |
|
{ NULL, NULL }, /* UE */ |
{ NULL, NULL }, /* UE */ |
{ man_UR_pre, NULL }, /* MT */ |
{ man_UR_pre, NULL }, /* MT */ |
{ NULL, NULL }, /* ME */ |
{ NULL, NULL }, /* ME */ |
|
{ man_MR_pre, NULL }, /* MR */ |
}; |
}; |
|
|
|
|
Line 119 html_man(void *arg, const struct roff_meta *man) |
|
Line 124 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 165 print_man_node(MAN_ARGS) |
|
Line 170 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 176 print_man_node(MAN_ARGS) |
|
Line 186 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 201 print_man_node(MAN_ARGS) |
|
Line 211 print_man_node(MAN_ARGS) |
|
* Close out scope of font prior to opening a macro |
* Close out scope of font prior to opening a macro |
* scope. |
* scope. |
*/ |
*/ |
if (HTMLFONT_NONE != h->metac) { |
if (h->metac != ESCAPE_FONTROMAN) { |
h->metal = h->metac; |
h->metal = h->metac; |
h->metac = HTMLFONT_NONE; |
h->metac = ESCAPE_FONTROMAN; |
} |
} |
|
|
/* |
/* |
Line 236 print_man_node(MAN_ARGS) |
|
Line 246 print_man_node(MAN_ARGS) |
|
if (n->type == ROFFT_BLOCK && |
if (n->type == ROFFT_BLOCK && |
(n->tok == MAN_IP || n->tok == MAN_TP || n->tok == MAN_TQ)) { |
(n->tok == MAN_IP || n->tok == MAN_TP || n->tok == MAN_TQ)) { |
t = h->tag; |
t = h->tag; |
while (t->tag != TAG_DL) |
while (t->tag != TAG_DL && t->tag != TAG_UL) |
t = t->next; |
t = t->next; |
/* |
/* |
* 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 (n->next == NULL || |
if (list_continues(n, roff_node_next(n)) == '\0') { |
(n->tok == MAN_IP && n->next->tok != MAN_IP) || |
|
(n->tok != MAN_IP && |
|
n->next->tok != MAN_TP && n->next->tok != MAN_TQ)) { |
|
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 292 man_root_pre(const struct roff_meta *man, struct html |
|
Line 292 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) { |
tag = TAG_H1; |
tag = TAG_H2; |
class = "Sh"; |
class = "Sh"; |
} else { |
} else { |
tag = TAG_H2; |
tag = TAG_H3; |
class = "Ss"; |
class = "Ss"; |
} |
} |
switch (n->type) { |
switch (n->type) { |
Line 327 man_SH_pre(MAN_ARGS) |
|
Line 329 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 408 man_PP_pre(MAN_ARGS) |
|
Line 407 man_PP_pre(MAN_ARGS) |
|
if (n->child != NULL && |
if (n->child != NULL && |
(n->child->flags & NODE_NOFILL) == 0) |
(n->child->flags & NODE_NOFILL) == 0) |
print_otag(h, TAG_P, "c", |
print_otag(h, TAG_P, "c", |
n->tok == MAN_PP ? "Pp" : "Pp HP"); |
n->tok == MAN_HP ? "Pp HP" : "Pp"); |
break; |
break; |
default: |
default: |
abort(); |
abort(); |
Line 416 man_PP_pre(MAN_ARGS) |
|
Line 415 man_PP_pre(MAN_ARGS) |
|
return 1; |
return 1; |
} |
} |
|
|
|
static char |
|
list_continues(const struct roff_node *n1, const struct roff_node *n2) |
|
{ |
|
const char *s1, *s2; |
|
char c1, c2; |
|
|
|
if (n1 == NULL || n1->type != ROFFT_BLOCK || |
|
n2 == NULL || n2->type != ROFFT_BLOCK) |
|
return '\0'; |
|
if ((n1->tok == MAN_TP || n1->tok == MAN_TQ) && |
|
(n2->tok == MAN_TP || n2->tok == MAN_TQ)) |
|
return ' '; |
|
if (n1->tok != MAN_IP || n2->tok != MAN_IP) |
|
return '\0'; |
|
n1 = n1->head->child; |
|
n2 = n2->head->child; |
|
s1 = n1 == NULL ? "" : n1->string; |
|
s2 = n2 == NULL ? "" : n2->string; |
|
c1 = strcmp(s1, "*") == 0 ? '*' : |
|
strcmp(s1, "\\-") == 0 ? '-' : |
|
strcmp(s1, "\\(bu") == 0 ? 'b' : |
|
strcmp(s1, "\\[bu]") == 0 ? 'b' : ' '; |
|
c2 = strcmp(s2, "*") == 0 ? '*' : |
|
strcmp(s2, "\\-") == 0 ? '-' : |
|
strcmp(s2, "\\(bu") == 0 ? 'b' : |
|
strcmp(s2, "\\[bu]") == 0 ? 'b' : ' '; |
|
return c1 != c2 ? '\0' : c1 == 'b' ? '*' : c1; |
|
} |
|
|
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; |
|
enum htmltag list_elem, body_elem; |
|
char list_type; |
|
|
|
nn = n->type == ROFFT_BLOCK ? n : n->parent; |
|
list_type = list_continues(roff_node_prev(nn), nn); |
|
if (list_type == '\0') { |
|
/* Start a new list. */ |
|
list_type = list_continues(nn, roff_node_next(nn)); |
|
if (list_type == '\0') |
|
list_type = ' '; |
|
switch (list_type) { |
|
case ' ': |
|
list_class = "Bl-tag"; |
|
list_elem = TAG_DL; |
|
break; |
|
case '*': |
|
list_class = "Bl-bullet"; |
|
list_elem = TAG_UL; |
|
break; |
|
case '-': |
|
list_class = "Bl-dash"; |
|
list_elem = TAG_UL; |
|
break; |
|
default: |
|
abort(); |
|
} |
|
} else { |
|
/* Continue a list that was started earlier. */ |
|
list_class = NULL; |
|
list_elem = TAG_MAX; |
|
} |
|
body_elem = list_type == ' ' ? TAG_DD : TAG_LI; |
|
|
switch (n->type) { |
switch (n->type) { |
case ROFFT_BLOCK: |
case ROFFT_BLOCK: |
html_close_paragraph(h); |
html_close_paragraph(h); |
/* |
if (list_elem != TAG_MAX) |
* Open a new list unless there is an immediately |
print_otag(h, list_elem, "c", list_class); |
* preceding item of the same type. |
|
*/ |
|
if (n->prev == NULL || |
|
(n->tok == MAN_IP && n->prev->tok != MAN_IP) || |
|
(n->tok != MAN_IP && |
|
n->prev->tok != MAN_TP && n->prev->tok != MAN_TQ)) |
|
print_otag(h, TAG_DL, "c", "Bl-tag"); |
|
return 1; |
return 1; |
case ROFFT_HEAD: |
case ROFFT_HEAD: |
print_otag(h, TAG_DT, ""); |
if (body_elem == TAG_LI) |
|
return 0; |
|
print_otag_id(h, TAG_DT, NULL, n); |
break; |
break; |
case ROFFT_BODY: |
case ROFFT_BODY: |
print_otag(h, TAG_DD, ""); |
print_otag(h, body_elem, ""); |
return 1; |
return 1; |
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) |
Line 466 man_IP_pre(MAN_ARGS) |
|
Line 521 man_IP_pre(MAN_ARGS) |
|
} |
} |
|
|
static int |
static int |
|
man_MR_pre(MAN_ARGS) |
|
{ |
|
struct tag *t; |
|
const char *name, *section, *suffix; |
|
char *label; |
|
|
|
html_setfont(h, ESCAPE_FONTROMAN); |
|
name = section = suffix = label = NULL; |
|
if (n->child != NULL) { |
|
name = n->child->string; |
|
if (n->child->next != NULL) { |
|
section = n->child->next->string; |
|
mandoc_asprintf(&label, |
|
"%s, section %s", name, section); |
|
if (n->child->next->next != NULL) |
|
suffix = n->child->next->next->string; |
|
} |
|
} |
|
|
|
if (name != NULL && section != NULL && h->base_man1 != NULL) |
|
t = print_otag(h, TAG_A, "chM?", "Xr", |
|
name, section, "aria-label", label); |
|
else |
|
t = print_otag(h, TAG_A, "c?", "Xr", "aria-label", label); |
|
|
|
free(label); |
|
if (name != NULL) { |
|
print_text(h, name); |
|
h->flags |= HTML_NOSPACE; |
|
} |
|
print_text(h, "("); |
|
h->flags |= HTML_NOSPACE; |
|
if (section != NULL) { |
|
print_text(h, section); |
|
h->flags |= HTML_NOSPACE; |
|
} |
|
print_text(h, ")"); |
|
print_tagq(h, t); |
|
if (suffix != NULL) { |
|
h->flags |= HTML_NOSPACE; |
|
print_text(h, suffix); |
|
} |
|
return 0; |
|
} |
|
|
|
static int |
man_OP_pre(MAN_ARGS) |
man_OP_pre(MAN_ARGS) |
{ |
{ |
struct tag *tt; |
struct tag *tt; |
Line 582 man_UR_pre(MAN_ARGS) |
|
Line 683 man_UR_pre(MAN_ARGS) |
|
|
|
print_man_nodelist(man, n->child, h); |
print_man_nodelist(man, n->child, h); |
return 0; |
return 0; |
} |
|
|
|
static int |
|
man_abort_pre(MAN_ARGS) |
|
{ |
|
abort(); |
|
} |
} |