Commit e3b14bbe984202c81dc39f688d5007dcab8ac03f
2019-12-11T18:27:04
render_html.c: Minor clean-up.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354
diff --git a/md2html/render_html.c b/md2html/render_html.c
index 8d5e309..0caea41 100644
--- a/md2html/render_html.c
+++ b/md2html/render_html.c
@@ -68,12 +68,15 @@ struct MD_RENDER_HTML_tag {
static inline void
-render_text(MD_RENDER_HTML* r, const MD_CHAR* text, MD_SIZE size)
+render_verbatim(MD_RENDER_HTML* r, const MD_CHAR* text, MD_SIZE size)
{
r->process_output(text, size, r->userdata);
}
-#define RENDER_LITERAL(r, literal) render_text((r), (literal), (MD_SIZE) strlen(literal))
+/* Keep this as a macro. Most compiler should then be smart enough to replace
+ * the strlen() call with a compile-time constant if the string is a C literal. */
+#define RENDER_VERBATIM(r, verbatim) \
+ render_verbatim((r), (verbatim), (MD_SIZE) (strlen(verbatim)))
static void
@@ -94,14 +97,14 @@ render_html_escaped(MD_RENDER_HTML* r, const MD_CHAR* data, MD_SIZE size)
off++;
if(off > beg)
- render_text(r, data + beg, off - beg);
+ render_verbatim(r, data + beg, off - beg);
if(off < size) {
switch(data[off]) {
- case '&': RENDER_LITERAL(r, "&"); break;
- case '<': RENDER_LITERAL(r, "<"); break;
- case '>': RENDER_LITERAL(r, ">"); break;
- case '"': RENDER_LITERAL(r, """); break;
+ case '&': RENDER_VERBATIM(r, "&"); break;
+ case '<': RENDER_VERBATIM(r, "<"); break;
+ case '>': RENDER_VERBATIM(r, ">"); break;
+ case '"': RENDER_VERBATIM(r, """); break;
}
off++;
} else {
@@ -125,18 +128,18 @@ render_url_escaped(MD_RENDER_HTML* r, const MD_CHAR* data, MD_SIZE size)
while(off < size && !NEED_URL_ESC(data[off]))
off++;
if(off > beg)
- render_text(r, data + beg, off - beg);
+ render_verbatim(r, data + beg, off - beg);
if(off < size) {
char hex[3];
switch(data[off]) {
- case '&': RENDER_LITERAL(r, "&"); break;
+ case '&': RENDER_VERBATIM(r, "&"); break;
default:
hex[0] = '%';
hex[1] = hex_chars[((unsigned)data[off] >> 4) & 0xf];
hex[2] = hex_chars[((unsigned)data[off] >> 0) & 0xf];
- render_text(r, hex, 3);
+ render_verbatim(r, hex, 3);
break;
}
off++;
@@ -252,7 +255,7 @@ render_attribute(MD_RENDER_HTML* r, const MD_ATTRIBUTE* attr,
const MD_CHAR* text = attr->text + off;
switch(type) {
- case MD_TEXT_NULLCHAR: render_utf8_codepoint(r, 0x0000, render_text); break;
+ case MD_TEXT_NULLCHAR: render_utf8_codepoint(r, 0x0000, render_verbatim); break;
case MD_TEXT_ENTITY: render_entity(r, text, size, fn_append); break;
default: fn_append(r, text, size); break;
}
@@ -266,78 +269,78 @@ render_open_ol_block(MD_RENDER_HTML* r, const MD_BLOCK_OL_DETAIL* det)
char buf[64];
if(det->start == 1) {
- RENDER_LITERAL(r, "<ol>\n");
+ RENDER_VERBATIM(r, "<ol>\n");
return;
}
snprintf(buf, sizeof(buf), "<ol start=\"%u\">\n", det->start);
- RENDER_LITERAL(r, buf);
+ RENDER_VERBATIM(r, buf);
}
static void
render_open_li_block(MD_RENDER_HTML* r, const MD_BLOCK_LI_DETAIL* det)
{
if(det->is_task) {
- RENDER_LITERAL(r, "<li class=\"task-list-item\">"
+ RENDER_VERBATIM(r, "<li class=\"task-list-item\">"
"<input type=\"checkbox\" class=\"task-list-item-checkbox\" disabled");
if(det->task_mark == 'x' || det->task_mark == 'X')
- RENDER_LITERAL(r, " checked");
- RENDER_LITERAL(r, ">");
+ RENDER_VERBATIM(r, " checked");
+ RENDER_VERBATIM(r, ">");
} else {
- RENDER_LITERAL(r, "<li>");
+ RENDER_VERBATIM(r, "<li>");
}
}
static void
render_open_code_block(MD_RENDER_HTML* r, const MD_BLOCK_CODE_DETAIL* det)
{
- RENDER_LITERAL(r, "<pre><code");
+ RENDER_VERBATIM(r, "<pre><code");
/* If known, output the HTML 5 attribute class="language-LANGNAME". */
if(det->lang.text != NULL) {
- RENDER_LITERAL(r, " class=\"language-");
+ RENDER_VERBATIM(r, " class=\"language-");
render_attribute(r, &det->lang, render_html_escaped);
- RENDER_LITERAL(r, "\"");
+ RENDER_VERBATIM(r, "\"");
}
- RENDER_LITERAL(r, ">");
+ RENDER_VERBATIM(r, ">");
}
static void
render_open_td_block(MD_RENDER_HTML* r, const MD_CHAR* cell_type, const MD_BLOCK_TD_DETAIL* det)
{
- RENDER_LITERAL(r, "<");
- RENDER_LITERAL(r, cell_type);
+ RENDER_VERBATIM(r, "<");
+ RENDER_VERBATIM(r, cell_type);
switch(det->align) {
- case MD_ALIGN_LEFT: RENDER_LITERAL(r, " align=\"left\">"); break;
- case MD_ALIGN_CENTER: RENDER_LITERAL(r, " align=\"center\">"); break;
- case MD_ALIGN_RIGHT: RENDER_LITERAL(r, " align=\"right\">"); break;
- default: RENDER_LITERAL(r, ">"); break;
+ case MD_ALIGN_LEFT: RENDER_VERBATIM(r, " align=\"left\">"); break;
+ case MD_ALIGN_CENTER: RENDER_VERBATIM(r, " align=\"center\">"); break;
+ case MD_ALIGN_RIGHT: RENDER_VERBATIM(r, " align=\"right\">"); break;
+ default: RENDER_VERBATIM(r, ">"); break;
}
}
static void
render_open_a_span(MD_RENDER_HTML* r, const MD_SPAN_A_DETAIL* det)
{
- RENDER_LITERAL(r, "<a href=\"");
+ RENDER_VERBATIM(r, "<a href=\"");
render_attribute(r, &det->href, render_url_escaped);
if(det->title.text != NULL) {
- RENDER_LITERAL(r, "\" title=\"");
+ RENDER_VERBATIM(r, "\" title=\"");
render_attribute(r, &det->title, render_html_escaped);
}
- RENDER_LITERAL(r, "\">");
+ RENDER_VERBATIM(r, "\">");
}
static void
render_open_img_span(MD_RENDER_HTML* r, const MD_SPAN_IMG_DETAIL* det)
{
- RENDER_LITERAL(r, "<img src=\"");
+ RENDER_VERBATIM(r, "<img src=\"");
render_attribute(r, &det->src, render_url_escaped);
- RENDER_LITERAL(r, "\" alt=\"");
+ RENDER_VERBATIM(r, "\" alt=\"");
r->image_nesting_level++;
}
@@ -346,11 +349,11 @@ static void
render_close_img_span(MD_RENDER_HTML* r, const MD_SPAN_IMG_DETAIL* det)
{
if(det->title.text != NULL) {
- RENDER_LITERAL(r, "\" title=\"");
+ RENDER_VERBATIM(r, "\" title=\"");
render_attribute(r, &det->title, render_html_escaped);
}
- RENDER_LITERAL(r, "\">");
+ RENDER_VERBATIM(r, "\">");
r->image_nesting_level--;
}
@@ -358,10 +361,10 @@ render_close_img_span(MD_RENDER_HTML* r, const MD_SPAN_IMG_DETAIL* det)
static void
render_open_wikilink_span(MD_RENDER_HTML* r, const MD_SPAN_WIKILINK_DETAIL* det)
{
- RENDER_LITERAL(r, "<x-wikilink data-target=\"");
+ RENDER_VERBATIM(r, "<x-wikilink data-target=\"");
render_attribute(r, &det->target, render_html_escaped);
- RENDER_LITERAL(r, "\">");
+ RENDER_VERBATIM(r, "\">");
}
@@ -377,19 +380,19 @@ enter_block_callback(MD_BLOCKTYPE type, void* detail, void* userdata)
switch(type) {
case MD_BLOCK_DOC: /* noop */ break;
- case MD_BLOCK_QUOTE: RENDER_LITERAL(r, "<blockquote>\n"); break;
- case MD_BLOCK_UL: RENDER_LITERAL(r, "<ul>\n"); break;
+ case MD_BLOCK_QUOTE: RENDER_VERBATIM(r, "<blockquote>\n"); break;
+ case MD_BLOCK_UL: RENDER_VERBATIM(r, "<ul>\n"); break;
case MD_BLOCK_OL: render_open_ol_block(r, (const MD_BLOCK_OL_DETAIL*)detail); break;
case MD_BLOCK_LI: render_open_li_block(r, (const MD_BLOCK_LI_DETAIL*)detail); break;
- case MD_BLOCK_HR: RENDER_LITERAL(r, "<hr>\n"); break;
- case MD_BLOCK_H: RENDER_LITERAL(r, head[((MD_BLOCK_H_DETAIL*)detail)->level - 1]); break;
+ case MD_BLOCK_HR: RENDER_VERBATIM(r, "<hr>\n"); break;
+ case MD_BLOCK_H: RENDER_VERBATIM(r, head[((MD_BLOCK_H_DETAIL*)detail)->level - 1]); break;
case MD_BLOCK_CODE: render_open_code_block(r, (const MD_BLOCK_CODE_DETAIL*) detail); break;
case MD_BLOCK_HTML: /* noop */ break;
- case MD_BLOCK_P: RENDER_LITERAL(r, "<p>"); break;
- case MD_BLOCK_TABLE: RENDER_LITERAL(r, "<table>\n"); break;
- case MD_BLOCK_THEAD: RENDER_LITERAL(r, "<thead>\n"); break;
- case MD_BLOCK_TBODY: RENDER_LITERAL(r, "<tbody>\n"); break;
- case MD_BLOCK_TR: RENDER_LITERAL(r, "<tr>\n"); break;
+ case MD_BLOCK_P: RENDER_VERBATIM(r, "<p>"); break;
+ case MD_BLOCK_TABLE: RENDER_VERBATIM(r, "<table>\n"); break;
+ case MD_BLOCK_THEAD: RENDER_VERBATIM(r, "<thead>\n"); break;
+ case MD_BLOCK_TBODY: RENDER_VERBATIM(r, "<tbody>\n"); break;
+ case MD_BLOCK_TR: RENDER_VERBATIM(r, "<tr>\n"); break;
case MD_BLOCK_TH: render_open_td_block(r, "th", (MD_BLOCK_TD_DETAIL*)detail); break;
case MD_BLOCK_TD: render_open_td_block(r, "td", (MD_BLOCK_TD_DETAIL*)detail); break;
}
@@ -405,21 +408,21 @@ leave_block_callback(MD_BLOCKTYPE type, void* detail, void* userdata)
switch(type) {
case MD_BLOCK_DOC: /*noop*/ break;
- case MD_BLOCK_QUOTE: RENDER_LITERAL(r, "</blockquote>\n"); break;
- case MD_BLOCK_UL: RENDER_LITERAL(r, "</ul>\n"); break;
- case MD_BLOCK_OL: RENDER_LITERAL(r, "</ol>\n"); break;
- case MD_BLOCK_LI: RENDER_LITERAL(r, "</li>\n"); break;
+ case MD_BLOCK_QUOTE: RENDER_VERBATIM(r, "</blockquote>\n"); break;
+ case MD_BLOCK_UL: RENDER_VERBATIM(r, "</ul>\n"); break;
+ case MD_BLOCK_OL: RENDER_VERBATIM(r, "</ol>\n"); break;
+ case MD_BLOCK_LI: RENDER_VERBATIM(r, "</li>\n"); break;
case MD_BLOCK_HR: /*noop*/ break;
- case MD_BLOCK_H: RENDER_LITERAL(r, head[((MD_BLOCK_H_DETAIL*)detail)->level - 1]); break;
- case MD_BLOCK_CODE: RENDER_LITERAL(r, "</code></pre>\n"); break;
+ case MD_BLOCK_H: RENDER_VERBATIM(r, head[((MD_BLOCK_H_DETAIL*)detail)->level - 1]); break;
+ case MD_BLOCK_CODE: RENDER_VERBATIM(r, "</code></pre>\n"); break;
case MD_BLOCK_HTML: /* noop */ break;
- case MD_BLOCK_P: RENDER_LITERAL(r, "</p>\n"); break;
- case MD_BLOCK_TABLE: RENDER_LITERAL(r, "</table>\n"); break;
- case MD_BLOCK_THEAD: RENDER_LITERAL(r, "</thead>\n"); break;
- case MD_BLOCK_TBODY: RENDER_LITERAL(r, "</tbody>\n"); break;
- case MD_BLOCK_TR: RENDER_LITERAL(r, "</tr>\n"); break;
- case MD_BLOCK_TH: RENDER_LITERAL(r, "</th>\n"); break;
- case MD_BLOCK_TD: RENDER_LITERAL(r, "</td>\n"); break;
+ case MD_BLOCK_P: RENDER_VERBATIM(r, "</p>\n"); break;
+ case MD_BLOCK_TABLE: RENDER_VERBATIM(r, "</table>\n"); break;
+ case MD_BLOCK_THEAD: RENDER_VERBATIM(r, "</thead>\n"); break;
+ case MD_BLOCK_TBODY: RENDER_VERBATIM(r, "</tbody>\n"); break;
+ case MD_BLOCK_TR: RENDER_VERBATIM(r, "</tr>\n"); break;
+ case MD_BLOCK_TH: RENDER_VERBATIM(r, "</th>\n"); break;
+ case MD_BLOCK_TD: RENDER_VERBATIM(r, "</td>\n"); break;
}
return 0;
@@ -431,20 +434,33 @@ enter_span_callback(MD_SPANTYPE type, void* detail, void* userdata)
MD_RENDER_HTML* r = (MD_RENDER_HTML*) userdata;
if(r->image_nesting_level > 0) {
- /* We are inside an image, i.e. rendering the ALT attribute of
- * <IMG> tag. */
+ /* We are inside a Markdown image label. Markdown allows to use any
+ * emphasis and other rich contents in that context similarly as in
+ * any link label.
+ *
+ * However, unlike in the case of links (where that contents becomes
+ * contents of the <a>...</a> tag), in the case of images the contents
+ * is supposed to fall into the attribute alt: <img alt="...">.
+ *
+ * In that context we naturally cannot output nested HTML tags. So lets
+ * suppress them and only output the plain text (i.e. what falls into
+ * text() callback).
+ *
+ * This make-it-a-plain-text approach is the recommended practice by
+ * CommonMark specification (for HTML output).
+ */
return 0;
}
switch(type) {
- case MD_SPAN_EM: RENDER_LITERAL(r, "<em>"); break;
- case MD_SPAN_STRONG: RENDER_LITERAL(r, "<strong>"); break;
+ case MD_SPAN_EM: RENDER_VERBATIM(r, "<em>"); break;
+ case MD_SPAN_STRONG: RENDER_VERBATIM(r, "<strong>"); break;
case MD_SPAN_A: render_open_a_span(r, (MD_SPAN_A_DETAIL*) detail); break;
case MD_SPAN_IMG: render_open_img_span(r, (MD_SPAN_IMG_DETAIL*) detail); break;
- case MD_SPAN_CODE: RENDER_LITERAL(r, "<code>"); break;
- case MD_SPAN_DEL: RENDER_LITERAL(r, "<del>"); break;
- case MD_SPAN_LATEXMATH: RENDER_LITERAL(r, "<x-equation>"); break;
- case MD_SPAN_LATEXMATH_DISPLAY: RENDER_LITERAL(r, "<x-equation type=\"display\">"); break;
+ case MD_SPAN_CODE: RENDER_VERBATIM(r, "<code>"); break;
+ case MD_SPAN_DEL: RENDER_VERBATIM(r, "<del>"); break;
+ case MD_SPAN_LATEXMATH: RENDER_VERBATIM(r, "<x-equation>"); break;
+ case MD_SPAN_LATEXMATH_DISPLAY: RENDER_VERBATIM(r, "<x-equation type=\"display\">"); break;
case MD_SPAN_WIKILINK: render_open_wikilink_span(r, (MD_SPAN_WIKILINK_DETAIL*) detail); break;
}
@@ -457,23 +473,23 @@ leave_span_callback(MD_SPANTYPE type, void* detail, void* userdata)
MD_RENDER_HTML* r = (MD_RENDER_HTML*) userdata;
if(r->image_nesting_level > 0) {
- /* We are inside an image, i.e. rendering the ALT attribute of
- * <IMG> tag. */
+ /* Ditto as in enter_span_callback(), except we have to allow the
+ * end of the <img> tag. */
if(r->image_nesting_level == 1 && type == MD_SPAN_IMG)
render_close_img_span(r, (MD_SPAN_IMG_DETAIL*) detail);
return 0;
}
switch(type) {
- case MD_SPAN_EM: RENDER_LITERAL(r, "</em>"); break;
- case MD_SPAN_STRONG: RENDER_LITERAL(r, "</strong>"); break;
- case MD_SPAN_A: RENDER_LITERAL(r, "</a>"); break;
+ case MD_SPAN_EM: RENDER_VERBATIM(r, "</em>"); break;
+ case MD_SPAN_STRONG: RENDER_VERBATIM(r, "</strong>"); break;
+ case MD_SPAN_A: RENDER_VERBATIM(r, "</a>"); break;
case MD_SPAN_IMG: /*noop, handled above*/ break;
- case MD_SPAN_CODE: RENDER_LITERAL(r, "</code>"); break;
- case MD_SPAN_DEL: RENDER_LITERAL(r, "</del>"); break;
+ case MD_SPAN_CODE: RENDER_VERBATIM(r, "</code>"); break;
+ case MD_SPAN_DEL: RENDER_VERBATIM(r, "</del>"); break;
case MD_SPAN_LATEXMATH: /*fall through*/
- case MD_SPAN_LATEXMATH_DISPLAY: RENDER_LITERAL(r, "</x-equation>"); break;
- case MD_SPAN_WIKILINK: RENDER_LITERAL(r, "</x-wikilink>"); break;
+ case MD_SPAN_LATEXMATH_DISPLAY: RENDER_VERBATIM(r, "</x-equation>"); break;
+ case MD_SPAN_WIKILINK: RENDER_VERBATIM(r, "</x-wikilink>"); break;
}
return 0;
@@ -485,10 +501,10 @@ text_callback(MD_TEXTTYPE type, const MD_CHAR* text, MD_SIZE size, void* userdat
MD_RENDER_HTML* r = (MD_RENDER_HTML*) userdata;
switch(type) {
- case MD_TEXT_NULLCHAR: render_utf8_codepoint(r, 0x0000, render_text); break;
- case MD_TEXT_BR: RENDER_LITERAL(r, (r->image_nesting_level == 0 ? "<br>\n" : " ")); break;
- case MD_TEXT_SOFTBR: RENDER_LITERAL(r, (r->image_nesting_level == 0 ? "\n" : " ")); break;
- case MD_TEXT_HTML: render_text(r, text, size); break;
+ case MD_TEXT_NULLCHAR: render_utf8_codepoint(r, 0x0000, render_verbatim); break;
+ case MD_TEXT_BR: RENDER_VERBATIM(r, (r->image_nesting_level == 0 ? "<br>\n" : " ")); break;
+ case MD_TEXT_SOFTBR: RENDER_VERBATIM(r, (r->image_nesting_level == 0 ? "\n" : " ")); break;
+ case MD_TEXT_HTML: render_verbatim(r, text, size); break;
case MD_TEXT_ENTITY: render_entity(r, text, size, render_html_escaped); break;
default: render_html_escaped(r, text, size); break;
}