(www._){50000}x
"), + "--fpermissive-www-autolinks") } whitespace_re = re.compile('/s+/') diff --git a/test/spec-permissive-autolinks.txt b/test/spec-permissive-autolinks.txt new file mode 100644 index 00000000..f7d26719 --- /dev/null +++ b/test/spec-permissive-autolinks.txt @@ -0,0 +1,248 @@ + +# Permissive Autolinks + +Standard autolinks (as per CommonMark specification) have to be decorated with +`<` and `>` so for example: + +```````````````````````````````` example +mailto:john.doe@gmail.com +https://example.com
+```````````````````````````````` + +With flags `MD_FLAG_PERMISSIVEURLAUTOLINKS`, `MD_FLAG_PERMISSIVEWWWAUTOLINKS` +and `MD_FLAG_PERMISSIVEEMAILAUTOLINKS`, MD4C is able also to recognize autolinks +without those marks. + +Example of permissive autolinks follows: + +```````````````````````````````` example +john.doe@gmail.com +https://www.example.com +www.example.com +. +john.doe@gmail.com +https://www.example.com +www.example.com
+. +--fpermissive-email-autolinks +--fpermissive-url-autolinks +--fpermissive-www-autolinks +```````````````````````````````` + +However as this syntax also brings some more danger of false positives, more +strict rules apply to what characters may or may not form such autolinks. +When a need arises to use a link which does not satisfy these restrictions, +standard Markdown autolinks have to be used. + +First and formost, these autolinks have to be delimited from surrounded text, +i.e. whitespace, beginning/end of line, or very limited punctuation must +precede and follow respectively. + +Therefore these are not autolinks because `:` precedes or follows: + +```````````````````````````````` example +:john.doe@gmail.com +:https://www.example.com +:www.example.com +. +:john.doe@gmail.com +:https://www.example.com +:www.example.com
+. +--fpermissive-email-autolinks +--fpermissive-url-autolinks +--fpermissive-www-autolinks +```````````````````````````````` + +Allowed punctuation right before autolink includes only opening brackets `(`, +`{` or `[`: + +```````````````````````````````` example +[john.doe@gmail.com +(https://www.example.com +{www.example.com +. +[john.doe@gmail.com +(https://www.example.com +{www.example.com
+. +--fpermissive-email-autolinks +--fpermissive-url-autolinks +--fpermissive-www-autolinks +```````````````````````````````` + +Correspondingly, the respective closing brackets may follow the autolinks. + +```````````````````````````````` example +john.doe@gmail.com] +https://www.example.com) +www.example.com} +. +john.doe@gmail.com] +https://www.example.com) +www.example.com}
+. +--fpermissive-email-autolinks +--fpermissive-url-autolinks +--fpermissive-www-autolinks +```````````````````````````````` + +Some other punctuation characters are also allowed after the autolink so that +the autolinks may appear at the end of a sentence or clause (`.`, `!`, `?`, +`,`, `;`): + +```````````````````````````````` example +Have you ever visited http://zombo.com? +. +Have you ever visited http://zombo.com?
+. +--fpermissive-url-autolinks +```````````````````````````````` + +Markdown emphasis mark can also precede (but only opening mark) or follow +(only closer mark): + +```````````````````````````````` example +You may contact me at **john.doe@example.com**. +. +You may contact me at john.doe@example.com.
+. +--fpermissive-email-autolinks +```````````````````````````````` + +However the following is not, because in this example `*` is literal `*` and +such punctuation is not allowed before the autolink: + +```````````````````````````````` example +*john.doe@example.com + +john.doe@example.com* +. +*john.doe@example.com
+john.doe@example.com*
+. +--fpermissive-email-autolinks +```````````````````````````````` + +## Permissive URL Autolinks + +Permissive URL autolinks (`MD_FLAG_PERMISSIVEURLAUTOLINKS`) are formed +by mandatory URL scheme, mandatory host, optional path, optional query and +optional fragment. + +The permissive URL autolinks recognize only `http://`, `https://` and `ftp://` +as the scheme: + +```````````````````````````````` example +https://example.com +http://example.com +ftp://example.com + +ssh://example.com +. +https://example.com +http://example.com +ftp://example.com
+ssh://example.com
+. +--fpermissive-url-autolinks +```````````````````````````````` + +The host is a sequence made of alphanumerical characters, `.`, `-` and `_`. +It has to include at least two components delimited with `.`, last component +has to have at least two characters, and occurrence of `.`, `-` and `_` has to +be immediately preceded and followed with a letter or digit. + +The host specification may optionally be followed with path. Path begins with +character `/` and uses it also for delimiting path components. Every path +component is made of alhanumerical characters and `.`, `-`, `_`. Once again, +any occurrence of `.`, `-`, `_` has to be surrounded with alphanumerical +character. + +```````````````````````````````` example +https://example.com/images/branding/logo_272x92.png +. +https://example.com/images/branding/logo_272x92.png
+. +--fpermissive-url-autolinks +```````````````````````````````` + +Then optionally query may follow. The query is made of `?` and then with +alhanumerical characters, `&`, `.`, `-`, `+`, `_`, `=`, `(` and `)`. Once again any +of those non-alhanumerical characters has to be surrounded with alpha-numerical +characters, and also brackets `(` have to be balanced `)`. + +```````````````````````````````` example +https://www.google.com/search?q=md4c+markdown +. +https://www.google.com/search?q=md4c+markdown
+. +--fpermissive-url-autolinks +```````````````````````````````` + +And finally there may be an optional fragment. + +```````````````````````````````` example +https://example.com#fragment +. + +. +--fpermissive-url-autolinks +```````````````````````````````` + +And finally one complex example: + +```````````````````````````````` example +http://commonmark.org + +(Visit https://encrypted.google.com/search?q=Markup+(business)) + +Anonymous FTP is available at ftp://foo.bar.baz. +. + +(Visit https://encrypted.google.com/search?q=Markup+(business))
+Anonymous FTP is available at ftp://foo.bar.baz.
+. +--fpermissive-url-autolinks +```````````````````````````````` + + +## Permissive WWW Autolinks + +Permissive WWW autolinks (`MD_FLAG_PERMISSIVEWWWAUTOLINKS`) are very similar +to the permissive URL autolinks. Actually the only difference is that instead +of providing an explicit scheme, they have to begin with `www.`. + +```````````````````````````````` example +www.google.com/search?q=Markdown +. +www.google.com/search?q=Markdown
+. +--fpermissive-www-autolinks +```````````````````````````````` + + +## Permissive E-mail Autolinks + +Permissive E-mail autolinks (`MD_FLAG_PERMISSIVEEMAILAUTOLINKS`) impose the +following limitations to the e-mail addresses: + +1. The username (before the `@`) can only use alphanumerical characters and + characters `.`, `-`, `_` and `+`. However every such non-alphanumerical + character must be immediately preceded and followed by an alphanumerical + character. + + For example this is not an auto-link because of that double underscore `__`. + + ```````````````````````````````` example + john__doe@example.com + . +john__doe@example.com
+ . + --fpermissive-email-autolinks + ```````````````````````````````` + +2. Same rules for domain as for URL and WWW autolinks apply. diff --git a/test/spec-permissive-email-autolinks.txt b/test/spec-permissive-email-autolinks.txt deleted file mode 100644 index f2e89979..00000000 --- a/test/spec-permissive-email-autolinks.txt +++ /dev/null @@ -1,58 +0,0 @@ - -# Permissive E-mail Autolinks - -With the flag `MD_FLAG_PERMISSIVEEMAILAUTOLINKS`, MD4C enables more permissive -recognition of e-mail addresses and transforms them to autolinks, even if they -do not exactly follow the syntax of autolink as specified in CommonMark -specification. - -This is standard CommonMark e-mail autolink: - -```````````````````````````````` example -E-mail:E-mail: mailto:john.doe@gmail.com
-. ---fpermissive-email-autolinks -```````````````````````````````` - -With the permissive autolinks enabled, this is sufficient: - -```````````````````````````````` example -E-mail: john.doe@gmail.com -. -E-mail: john.doe@gmail.com
-. ---fpermissive-email-autolinks -```````````````````````````````` - -`+` can occur before the `@`, but not after. - -```````````````````````````````` example -hello@mail+xyz.example isn't valid, but hello+xyz@mail.example is. -. -hello@mail+xyz.example isn't valid, but hello+xyz@mail.example is.
-. ---fpermissive-email-autolinks -```````````````````````````````` - -`.`, `-`, and `_` can occur on both sides of the `@`, but only `.` may occur at -the end of the email address, in which case it will not be considered part of -the address: - -```````````````````````````````` example -a.b-c_d@a.b - -a.b-c_d@a.b. - -a.b-c_d@a.b- - -a.b-c_d@a.b_ -. - - -a.b-c_d@a.b-
-a.b-c_d@a.b_
-. ---fpermissive-email-autolinks -```````````````````````````````` diff --git a/test/spec-permissive-url-autolinks.txt b/test/spec-permissive-url-autolinks.txt deleted file mode 100644 index d068499f..00000000 --- a/test/spec-permissive-url-autolinks.txt +++ /dev/null @@ -1,76 +0,0 @@ - -# Permissive URL Autolinks - -With the flag `MD_FLAG_PERMISSIVEURLAUTOLINKS`, MD4C enables more permissive recognition -of URLs and transform them to autolinks, even if they do not exactly follow the syntax -of autolink as specified in CommonMark specification. - -This is a standard CommonMark autolink: - -```````````````````````````````` example -Homepage:Homepage: https://github.com/mity/md4c
-. ---fpermissive-url-autolinks -```````````````````````````````` - -With the permissive autolinks enabled, this is sufficient: - -```````````````````````````````` example -Homepage: https://github.com/mity/md4c -. -Homepage: https://github.com/mity/md4c
-. ---fpermissive-url-autolinks -```````````````````````````````` - -But this permissive autolink feature can work only for very widely used URL -schemes, in alphabetical order `ftp:`, `http:`, `https:`. - -That's why this is not a permissive autolink: - -```````````````````````````````` example -ssh://root@example.com -. -ssh://root@example.com
-. ---fpermissive-url-autolinks -```````````````````````````````` - -The same rules for path validation as for permissivve WWW autolinks apply. -Therefore the final question mark here is not part of the autolink: - -```````````````````````````````` example -Have you ever visited http://www.zombo.com? -. -Have you ever visited http://www.zombo.com?
-. ---fpermissive-url-autolinks -```````````````````````````````` - -But in contrast, in this example it is: - -```````````````````````````````` example -http://www.bing.com/search?q=md4c -. -http://www.bing.com/search?q=md4c
-. ---fpermissive-url-autolinks -```````````````````````````````` - -And finally one complex example: - -```````````````````````````````` example -http://commonmark.org - -(Visit https://encrypted.google.com/search?q=Markup+(business)) - -Anonymous FTP is available at ftp://foo.bar.baz. -. - -(Visit https://encrypted.google.com/search?q=Markup+(business))
-Anonymous FTP is available at ftp://foo.bar.baz.
-. ---fpermissive-url-autolinks -```````````````````````````````` diff --git a/test/spec-permissive-www-autolinks.txt b/test/spec-permissive-www-autolinks.txt deleted file mode 100644 index 7a3a7725..00000000 --- a/test/spec-permissive-www-autolinks.txt +++ /dev/null @@ -1,106 +0,0 @@ - -# Permissive WWW Autolinks - -With the flag `MD_FLAG_PERMISSIVEWWWAUTOLINKS`, MD4C enables recognition of -autolinks starting with `www.`, even if they do not exactly follow the syntax -of autolink as specified in CommonMark specification. - -These do not have to be enclosed in `<` and `>`, and they even do not need -any preceding scheme specification. - -The WWW autolink will be recognized when the text `www.` is found followed by a -valid domain. A valid domain consists of segments of alphanumeric characters, -underscores (`_`) and hyphens (`-`) separated by periods (`.`). There must be -at least one period, and no underscores may be present in the last two segments -of the domain. - -The scheme `http` will be inserted automatically: - -```````````````````````````````` example -www.commonmark.org -. - -. ---fpermissive-www-autolinks -```````````````````````````````` - -After a valid domain, zero or more non-space non-`<` characters may follow: - -```````````````````````````````` example -Visit www.commonmark.org/help for more information. -. -Visit www.commonmark.org/help for more information.
-. ---fpermissive-www-autolinks -```````````````````````````````` - -We then apply extended autolink path validation as follows: - -Trailing punctuation (specifically, `?`, `!`, `.`, `,`, `:`, `*`, `_`, and `~`) -will not be considered part of the autolink, though they may be included in the -interior of the link: - -```````````````````````````````` example -Visit www.commonmark.org. - -Visit www.commonmark.org/a.b. -. -Visit www.commonmark.org.
-Visit www.commonmark.org/a.b.
-. ---fpermissive-www-autolinks -```````````````````````````````` - -When an autolink ends in `)`, we scan the entire autolink for the total number -of parentheses. If there is a greater number of closing parentheses than -opening ones, we don't consider the last character part of the autolink, in -order to facilitate including an autolink inside a parenthesis: - -```````````````````````````````` example -www.google.com/search?q=Markup+(business) - -(www.google.com/search?q=Markup+(business)) -. -www.google.com/search?q=Markup+(business)
-(www.google.com/search?q=Markup+(business))
-. ---fpermissive-www-autolinks -```````````````````````````````` - -This check is only done when the link ends in a closing parentheses `)`, so if -the only parentheses are in the interior of the autolink, no special rules are -applied: - -```````````````````````````````` example -www.google.com/search?q=(business))+ok -. -www.google.com/search?q=(business))+ok
-. ---fpermissive-www-autolinks -```````````````````````````````` - -If an autolink ends in a semicolon (`;`), we check to see if it appears to -resemble an [entity reference][entity references]; if the preceding text is `&` -followed by one or more alphanumeric characters. If so, it is excluded from -the autolink: - -```````````````````````````````` example -www.google.com/search?q=commonmark&hl=en - -www.google.com/search?q=commonmark&hl; -. -www.google.com/search?q=commonmark&hl=en
-www.google.com/search?q=commonmark&hl;
-. ---fpermissive-www-autolinks -```````````````````````````````` - -`<` immediately ends an autolink. - -```````````````````````````````` example -www.commonmark.org/he