version 1.260, 2019/09/03 18:08:02 |
version 1.268, 2020/04/18 20:40:10 |
|
|
/* $Id$ */ |
/* $Id$ */ |
/* |
/* |
|
* Copyright (c) 2011-2015, 2017-2020 Ingo Schwarze <schwarze@openbsd.org> |
* Copyright (c) 2008-2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv> |
* Copyright (c) 2008-2011, 2014 Kristaps Dzonsons <kristaps@bsd.lv> |
* Copyright (c) 2011-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. |
|
* |
|
* Common functions for mandoc(1) HTML formatters. |
|
* For use by individual formatters and by the main program. |
*/ |
*/ |
#include "config.h" |
#include "config.h" |
|
|
Line 88 static const struct htmldata htmltags[TAG_MAX] = { |
|
Line 91 static const struct htmldata htmltags[TAG_MAX] = { |
|
{"span", HTML_INPHRASE | HTML_TOPHRASE}, |
{"span", HTML_INPHRASE | HTML_TOPHRASE}, |
{"var", HTML_INPHRASE | HTML_TOPHRASE}, |
{"var", HTML_INPHRASE | HTML_TOPHRASE}, |
{"br", HTML_INPHRASE | HTML_NOSTACK | HTML_NLALL}, |
{"br", HTML_INPHRASE | HTML_NOSTACK | HTML_NLALL}, |
|
{"mark", HTML_INPHRASE }, |
{"math", HTML_INPHRASE | HTML_NLALL | HTML_INDENT}, |
{"math", HTML_INPHRASE | HTML_NLALL | HTML_INDENT}, |
{"mrow", 0}, |
{"mrow", 0}, |
{"mi", 0}, |
{"mi", 0}, |
Line 320 html_fillmode(struct html *h, enum roff_tok want) |
|
Line 324 html_fillmode(struct html *h, enum roff_tok want) |
|
return had; |
return had; |
} |
} |
|
|
|
/* |
|
* Allocate a string to be used for the "id=" attribute of an HTML |
|
* element and/or as a segment identifier for a URI in an <a> element. |
|
* The function may fail and return NULL if the node lacks text data |
|
* to create the attribute from. |
|
* If the "unique" argument is 0, the caller is responsible for |
|
* free(3)ing the returned string after using it. |
|
* If the "unique" argument is non-zero, the "id_unique" ohash table |
|
* is used for de-duplication and owns the returned string, so the |
|
* caller must not free(3) it. In this case, it will be freed |
|
* automatically by html_reset() or html_free(). |
|
*/ |
char * |
char * |
html_make_id(const struct roff_node *n, int unique) |
html_make_id(const struct roff_node *n, int unique) |
{ |
{ |
Line 328 html_make_id(const struct roff_node *n, int unique) |
|
Line 344 html_make_id(const struct roff_node *n, int unique) |
|
unsigned int slot; |
unsigned int slot; |
int suffix; |
int suffix; |
|
|
for (nch = n->child; nch != NULL; nch = nch->next) |
if (n->tag != NULL) |
if (nch->type != ROFFT_TEXT) |
buf = mandoc_strdup(n->tag); |
return NULL; |
else { |
|
switch (n->tok) { |
|
case MDOC_Sh: |
|
case MDOC_Ss: |
|
case MDOC_Sx: |
|
case MAN_SH: |
|
case MAN_SS: |
|
for (nch = n->child; nch != NULL; nch = nch->next) |
|
if (nch->type != ROFFT_TEXT) |
|
return NULL; |
|
buf = NULL; |
|
deroff(&buf, n); |
|
if (buf == NULL) |
|
return NULL; |
|
break; |
|
default: |
|
if (n->child == NULL || n->child->type != ROFFT_TEXT) |
|
return NULL; |
|
buf = mandoc_strdup(n->child->string); |
|
break; |
|
} |
|
} |
|
|
buf = NULL; |
|
deroff(&buf, n); |
|
if (buf == NULL) |
|
return NULL; |
|
|
|
/* |
/* |
* In ID attributes, only use ASCII characters that are |
* In ID attributes, only use ASCII characters that are |
* permitted in URL-fragment strings according to the |
* permitted in URL-fragment strings according to the |
Line 735 print_otag(struct html *h, enum htmltag tag, const cha |
|
Line 767 print_otag(struct html *h, enum htmltag tag, const cha |
|
return t; |
return t; |
} |
} |
|
|
|
/* |
|
* Print an element with an optional "id=" attribute. |
|
* If the element has phrasing content and an "id=" attribute, |
|
* also add a permalink: outside if it can be in phrasing context, |
|
* inside otherwise. |
|
*/ |
|
struct tag * |
|
print_otag_id(struct html *h, enum htmltag elemtype, const char *cattr, |
|
struct roff_node *n) |
|
{ |
|
struct roff_node *nch; |
|
struct tag *ret, *t; |
|
char *id, *href; |
|
|
|
ret = NULL; |
|
id = href = NULL; |
|
if (n->flags & NODE_ID) |
|
id = html_make_id(n, 1); |
|
if (n->flags & NODE_HREF) |
|
href = id == NULL ? html_make_id(n, 0) : id; |
|
if (href != NULL && htmltags[elemtype].flags & HTML_INPHRASE) |
|
ret = print_otag(h, TAG_A, "chR", "permalink", href); |
|
t = print_otag(h, elemtype, "ci", cattr, id); |
|
if (ret == NULL) { |
|
ret = t; |
|
if (href != NULL && (nch = n->child) != NULL) { |
|
/* man(7) is safe, it tags phrasing content only. */ |
|
if (n->tok > MDOC_MAX || |
|
htmltags[elemtype].flags & HTML_TOPHRASE) |
|
nch = NULL; |
|
else /* For mdoc(7), beware of nested blocks. */ |
|
while (nch != NULL && nch->type == ROFFT_TEXT) |
|
nch = nch->next; |
|
if (nch == NULL) |
|
print_otag(h, TAG_A, "chR", "permalink", href); |
|
} |
|
} |
|
if (id == NULL) |
|
free(href); |
|
return ret; |
|
} |
|
|
static void |
static void |
print_ctag(struct html *h, struct tag *tag) |
print_ctag(struct html *h, struct tag *tag) |
{ |
{ |
Line 804 print_gen_comment(struct html *h, struct roff_node *n) |
|
Line 878 print_gen_comment(struct html *h, struct roff_node *n) |
|
void |
void |
print_text(struct html *h, const char *word) |
print_text(struct html *h, const char *word) |
{ |
{ |
|
print_tagged_text(h, word, NULL); |
|
} |
|
|
|
void |
|
print_tagged_text(struct html *h, const char *word, struct roff_node *n) |
|
{ |
|
struct tag *t; |
|
char *href; |
|
|
/* |
/* |
* Always wrap text in a paragraph unless already contained in |
* Always wrap text in a paragraph unless already contained in |
* some flow container; never put it directly into a section. |
* some flow container; never put it directly into a section. |
Line 824 print_text(struct html *h, const char *word) |
|
Line 907 print_text(struct html *h, const char *word) |
|
} |
} |
|
|
/* |
/* |
* Print the text, optionally surrounded by HTML whitespace, |
* Optionally switch fonts, optionally write a permalink, then |
* optionally manually switching fonts before and after. |
* print the text, optionally surrounded by HTML whitespace. |
*/ |
*/ |
|
|
assert(h->metaf == NULL); |
assert(h->metaf == NULL); |
print_metaf(h); |
print_metaf(h); |
print_indent(h); |
print_indent(h); |
|
|
|
if (n != NULL && (href = html_make_id(n, 0)) != NULL) { |
|
t = print_otag(h, TAG_A, "chR", "permalink", href); |
|
free(href); |
|
} else |
|
t = NULL; |
|
|
if ( ! print_encode(h, word, NULL, 0)) { |
if ( ! print_encode(h, word, NULL, 0)) { |
if ( ! (h->flags & HTML_NONOSPACE)) |
if ( ! (h->flags & HTML_NONOSPACE)) |
h->flags &= ~HTML_NOSPACE; |
h->flags &= ~HTML_NOSPACE; |
Line 841 print_text(struct html *h, const char *word) |
|
Line 931 print_text(struct html *h, const char *word) |
|
if (h->metaf != NULL) { |
if (h->metaf != NULL) { |
print_tagq(h, h->metaf); |
print_tagq(h, h->metaf); |
h->metaf = NULL; |
h->metaf = NULL; |
} |
} else if (t != NULL) |
|
print_tagq(h, t); |
|
|
h->flags &= ~HTML_IGNDELIM; |
h->flags &= ~HTML_IGNDELIM; |
} |
} |
Line 968 print_indent(struct html *h) |
|
Line 1059 print_indent(struct html *h) |
|
{ |
{ |
size_t i; |
size_t i; |
|
|
if (h->col) |
if (h->col || h->noindent) |
return; |
return; |
|
|
if (h->noindent == 0) { |
h->col = h->indent * 2; |
h->col = h->indent * 2; |
for (i = 0; i < h->col; i++) |
for (i = 0; i < h->col; i++) |
putchar(' '); |
putchar(' '); |
|
} |
|
h->flags &= ~HTML_NOSPACE; |
|
} |
} |
|
|
/* |
/* |