Fossil SCM
Fix a minor footnotes-related bug that was discovered by Stephan: if a free-standing footnote reference follows immediately after the exclamation mark then parse that as a footnote (and not as an image). This check-in also postpones initialization of a few local variables within <code>char_link()</code> function (which may save a few CPU cycles).
Commit
97b28feae320b8f1ff00e3f794f28ac9d12e644240f6a8fb3e50c980bf1e54c3
Parent
9584806cc6a8c00…
2 files changed
+16
-12
+7
+16
-12
| --- src/markdown.c | ||
| +++ src/markdown.c | ||
| @@ -1305,34 +1305,38 @@ | ||
| 1305 | 1305 | struct render *rndr, |
| 1306 | 1306 | char *data, |
| 1307 | 1307 | size_t offset, |
| 1308 | 1308 | size_t size /* parse_inline() ensures that size > 0 */ |
| 1309 | 1309 | ){ |
| 1310 | - const int is_img = (offset && data[-1] == '!'); | |
| 1311 | - size_t i = 1, txt_e; | |
| 1312 | - struct Blob *content = 0; | |
| 1313 | - struct Blob *link = 0; | |
| 1314 | - struct Blob *title = 0; | |
| 1310 | + const int bFsfn = (size>3 && data[1]=='^'); /*free-standing footnote ref*/ | |
| 1311 | + const int bImg = !bFsfn && (offset && data[-1] == '!'); | |
| 1312 | + size_t i, txt_e; | |
| 1313 | + struct Blob *content; | |
| 1314 | + struct Blob *link; | |
| 1315 | + struct Blob *title; | |
| 1315 | 1316 | struct footnote fn; |
| 1316 | 1317 | int ret; |
| 1317 | 1318 | |
| 1318 | 1319 | /* checking whether the correct renderer exists */ |
| 1319 | - if( (is_img && !rndr->make.image) || (!is_img && !rndr->make.link) ){ | |
| 1320 | - return 0; | |
| 1320 | + if( !bFsfn ){ | |
| 1321 | + if( (bImg && !rndr->make.image) || (!bImg && !rndr->make.link) ){ | |
| 1322 | + return 0; | |
| 1323 | + } | |
| 1321 | 1324 | } |
| 1322 | 1325 | |
| 1323 | 1326 | /* looking for the matching closing bracket */ |
| 1324 | 1327 | txt_e = matching_bracket_offset(data, data+size); |
| 1325 | 1328 | if( !txt_e ) return 0; |
| 1326 | 1329 | i = txt_e + 1; |
| 1327 | 1330 | ret = 0; /* error if we don't get to the callback */ |
| 1328 | - fn.nUsed = 0; | |
| 1329 | 1331 | |
| 1330 | - /* free-standing footnote refernece */ | |
| 1331 | - if(!is_img && size>3 && data[1]=='^'){ | |
| 1332 | + /* free-standing footnote reference */ | |
| 1333 | + if( bFsfn ){ | |
| 1332 | 1334 | fn = get_footnote(rndr, data+2, txt_e-2); |
| 1335 | + content = link = title = 0; | |
| 1333 | 1336 | }else{ |
| 1337 | + fn.nUsed = 0; | |
| 1334 | 1338 | |
| 1335 | 1339 | /* skip "inter-bracket-whitespace" - any amount of whitespace or newline */ |
| 1336 | 1340 | /* (this is much more lax than original markdown syntax) */ |
| 1337 | 1341 | while( i<size && (data[i]==' ' || data[i]=='\t' || data[i]=='\n') ){ i++; } |
| 1338 | 1342 | |
| @@ -1399,16 +1403,16 @@ | ||
| 1399 | 1403 | i = txt_e+1; |
| 1400 | 1404 | } |
| 1401 | 1405 | } |
| 1402 | 1406 | /* building content: img alt is escaped, link content is parsed */ |
| 1403 | 1407 | if( txt_e>1 && content ){ |
| 1404 | - if( is_img ) blob_append(content, data+1, txt_e-1); | |
| 1408 | + if( bImg ) blob_append(content, data+1, txt_e-1); | |
| 1405 | 1409 | else parse_inline(content, rndr, data+1, txt_e-1); |
| 1406 | 1410 | } |
| 1407 | 1411 | |
| 1408 | 1412 | /* calling the relevant rendering function */ |
| 1409 | - if( is_img ){ | |
| 1413 | + if( bImg ){ | |
| 1410 | 1414 | if( blob_size(ob)>0 && blob_buffer(ob)[blob_size(ob)-1]=='!' ){ |
| 1411 | 1415 | ob->nUsed--; |
| 1412 | 1416 | } |
| 1413 | 1417 | ret = rndr->make.image(ob, link, title, content, rndr->make.opaque); |
| 1414 | 1418 | }else if( fn.nUsed ){ |
| 1415 | 1419 |
| --- src/markdown.c | |
| +++ src/markdown.c | |
| @@ -1305,34 +1305,38 @@ | |
| 1305 | struct render *rndr, |
| 1306 | char *data, |
| 1307 | size_t offset, |
| 1308 | size_t size /* parse_inline() ensures that size > 0 */ |
| 1309 | ){ |
| 1310 | const int is_img = (offset && data[-1] == '!'); |
| 1311 | size_t i = 1, txt_e; |
| 1312 | struct Blob *content = 0; |
| 1313 | struct Blob *link = 0; |
| 1314 | struct Blob *title = 0; |
| 1315 | struct footnote fn; |
| 1316 | int ret; |
| 1317 | |
| 1318 | /* checking whether the correct renderer exists */ |
| 1319 | if( (is_img && !rndr->make.image) || (!is_img && !rndr->make.link) ){ |
| 1320 | return 0; |
| 1321 | } |
| 1322 | |
| 1323 | /* looking for the matching closing bracket */ |
| 1324 | txt_e = matching_bracket_offset(data, data+size); |
| 1325 | if( !txt_e ) return 0; |
| 1326 | i = txt_e + 1; |
| 1327 | ret = 0; /* error if we don't get to the callback */ |
| 1328 | fn.nUsed = 0; |
| 1329 | |
| 1330 | /* free-standing footnote refernece */ |
| 1331 | if(!is_img && size>3 && data[1]=='^'){ |
| 1332 | fn = get_footnote(rndr, data+2, txt_e-2); |
| 1333 | }else{ |
| 1334 | |
| 1335 | /* skip "inter-bracket-whitespace" - any amount of whitespace or newline */ |
| 1336 | /* (this is much more lax than original markdown syntax) */ |
| 1337 | while( i<size && (data[i]==' ' || data[i]=='\t' || data[i]=='\n') ){ i++; } |
| 1338 | |
| @@ -1399,16 +1403,16 @@ | |
| 1399 | i = txt_e+1; |
| 1400 | } |
| 1401 | } |
| 1402 | /* building content: img alt is escaped, link content is parsed */ |
| 1403 | if( txt_e>1 && content ){ |
| 1404 | if( is_img ) blob_append(content, data+1, txt_e-1); |
| 1405 | else parse_inline(content, rndr, data+1, txt_e-1); |
| 1406 | } |
| 1407 | |
| 1408 | /* calling the relevant rendering function */ |
| 1409 | if( is_img ){ |
| 1410 | if( blob_size(ob)>0 && blob_buffer(ob)[blob_size(ob)-1]=='!' ){ |
| 1411 | ob->nUsed--; |
| 1412 | } |
| 1413 | ret = rndr->make.image(ob, link, title, content, rndr->make.opaque); |
| 1414 | }else if( fn.nUsed ){ |
| 1415 |
| --- src/markdown.c | |
| +++ src/markdown.c | |
| @@ -1305,34 +1305,38 @@ | |
| 1305 | struct render *rndr, |
| 1306 | char *data, |
| 1307 | size_t offset, |
| 1308 | size_t size /* parse_inline() ensures that size > 0 */ |
| 1309 | ){ |
| 1310 | const int bFsfn = (size>3 && data[1]=='^'); /*free-standing footnote ref*/ |
| 1311 | const int bImg = !bFsfn && (offset && data[-1] == '!'); |
| 1312 | size_t i, txt_e; |
| 1313 | struct Blob *content; |
| 1314 | struct Blob *link; |
| 1315 | struct Blob *title; |
| 1316 | struct footnote fn; |
| 1317 | int ret; |
| 1318 | |
| 1319 | /* checking whether the correct renderer exists */ |
| 1320 | if( !bFsfn ){ |
| 1321 | if( (bImg && !rndr->make.image) || (!bImg && !rndr->make.link) ){ |
| 1322 | return 0; |
| 1323 | } |
| 1324 | } |
| 1325 | |
| 1326 | /* looking for the matching closing bracket */ |
| 1327 | txt_e = matching_bracket_offset(data, data+size); |
| 1328 | if( !txt_e ) return 0; |
| 1329 | i = txt_e + 1; |
| 1330 | ret = 0; /* error if we don't get to the callback */ |
| 1331 | |
| 1332 | /* free-standing footnote reference */ |
| 1333 | if( bFsfn ){ |
| 1334 | fn = get_footnote(rndr, data+2, txt_e-2); |
| 1335 | content = link = title = 0; |
| 1336 | }else{ |
| 1337 | fn.nUsed = 0; |
| 1338 | |
| 1339 | /* skip "inter-bracket-whitespace" - any amount of whitespace or newline */ |
| 1340 | /* (this is much more lax than original markdown syntax) */ |
| 1341 | while( i<size && (data[i]==' ' || data[i]=='\t' || data[i]=='\n') ){ i++; } |
| 1342 | |
| @@ -1399,16 +1403,16 @@ | |
| 1403 | i = txt_e+1; |
| 1404 | } |
| 1405 | } |
| 1406 | /* building content: img alt is escaped, link content is parsed */ |
| 1407 | if( txt_e>1 && content ){ |
| 1408 | if( bImg ) blob_append(content, data+1, txt_e-1); |
| 1409 | else parse_inline(content, rndr, data+1, txt_e-1); |
| 1410 | } |
| 1411 | |
| 1412 | /* calling the relevant rendering function */ |
| 1413 | if( bImg ){ |
| 1414 | if( blob_size(ob)>0 && blob_buffer(ob)[blob_size(ob)-1]=='!' ){ |
| 1415 | ob->nUsed--; |
| 1416 | } |
| 1417 | ret = rndr->make.image(ob, link, title, content, rndr->make.opaque); |
| 1418 | }else if( fn.nUsed ){ |
| 1419 |
| --- test/markdown-test3.md | ||
| +++ test/markdown-test3.md | ||
| @@ -67,10 +67,13 @@ | ||
| 67 | 67 | This facilitates the usage in the usual case |
| 68 | 68 | when several footnotes are refenrenced at the end |
| 69 | 69 | of a phrase.[^scipub][^many-refs](^All these four should |
| 70 | 70 | be parsed as "free-standing" footnotes)[^Coelurosauria] |
| 71 | 71 | |
| 72 | +An ambiguity between a link to an image and a *free-standing referenced | |
| 73 | +footnote* should be resolved as a footnote![^not-image] | |
| 74 | + | |
| 72 | 75 | A footnote may not be empty(^) |
| 73 | 76 | or consist just of blank characters.(^ |
| 74 | 77 | ) |
| 75 | 78 | |
| 76 | 79 | The same holds for labeled footnotes. If definition of a labeled footnote |
| @@ -220,10 +223,14 @@ | ||
| 220 | 223 | |
| 221 | 224 | [^markup]: E.g. *emphasis*, and [so on](/md_rules). |
| 222 | 225 | BTW, this note may not have a backreference to the "stray". |
| 223 | 226 | |
| 224 | 227 | [^undefined label is used]: For example due to a typo. |
| 228 | + | |
| 229 | +[^not-image]: The rationale is that URLs do not start with **^** | |
| 230 | + while a footnote may follow *immediately* after an exclamation mark | |
| 231 | + at the end of a sentence. | |
| 225 | 232 | |
| 226 | 233 | [^another stray]: Just to verify the correctness of ordering and styling. |
| 227 | 234 | |
| 228 | 235 | [^scipub]: Which is common in the scientific publications. |
| 229 | 236 | |
| 230 | 237 |
| --- test/markdown-test3.md | |
| +++ test/markdown-test3.md | |
| @@ -67,10 +67,13 @@ | |
| 67 | This facilitates the usage in the usual case |
| 68 | when several footnotes are refenrenced at the end |
| 69 | of a phrase.[^scipub][^many-refs](^All these four should |
| 70 | be parsed as "free-standing" footnotes)[^Coelurosauria] |
| 71 | |
| 72 | A footnote may not be empty(^) |
| 73 | or consist just of blank characters.(^ |
| 74 | ) |
| 75 | |
| 76 | The same holds for labeled footnotes. If definition of a labeled footnote |
| @@ -220,10 +223,14 @@ | |
| 220 | |
| 221 | [^markup]: E.g. *emphasis*, and [so on](/md_rules). |
| 222 | BTW, this note may not have a backreference to the "stray". |
| 223 | |
| 224 | [^undefined label is used]: For example due to a typo. |
| 225 | |
| 226 | [^another stray]: Just to verify the correctness of ordering and styling. |
| 227 | |
| 228 | [^scipub]: Which is common in the scientific publications. |
| 229 | |
| 230 |
| --- test/markdown-test3.md | |
| +++ test/markdown-test3.md | |
| @@ -67,10 +67,13 @@ | |
| 67 | This facilitates the usage in the usual case |
| 68 | when several footnotes are refenrenced at the end |
| 69 | of a phrase.[^scipub][^many-refs](^All these four should |
| 70 | be parsed as "free-standing" footnotes)[^Coelurosauria] |
| 71 | |
| 72 | An ambiguity between a link to an image and a *free-standing referenced |
| 73 | footnote* should be resolved as a footnote![^not-image] |
| 74 | |
| 75 | A footnote may not be empty(^) |
| 76 | or consist just of blank characters.(^ |
| 77 | ) |
| 78 | |
| 79 | The same holds for labeled footnotes. If definition of a labeled footnote |
| @@ -220,10 +223,14 @@ | |
| 223 | |
| 224 | [^markup]: E.g. *emphasis*, and [so on](/md_rules). |
| 225 | BTW, this note may not have a backreference to the "stray". |
| 226 | |
| 227 | [^undefined label is used]: For example due to a typo. |
| 228 | |
| 229 | [^not-image]: The rationale is that URLs do not start with **^** |
| 230 | while a footnote may follow *immediately* after an exclamation mark |
| 231 | at the end of a sentence. |
| 232 | |
| 233 | [^another stray]: Just to verify the correctness of ordering and styling. |
| 234 | |
| 235 | [^scipub]: Which is common in the scientific publications. |
| 236 | |
| 237 |