tilde.py 5.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161
  1. """
  2. Tilde.
  3. pymdownx.tilde
  4. Really simple plugin to add support for
  5. `<del>test</del>` tags as `~~test~~` and
  6. `<sub>test</sub>` tags as `~test~`
  7. MIT license.
  8. Copyright (c) 2014 - 2017 Isaac Muse <isaacmuse@gmail.com>
  9. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
  10. documentation files (the "Software"), to deal in the Software without restriction, including without limitation
  11. the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software,
  12. and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
  13. The above copyright notice and this permission notice shall be included in all copies or substantial portions
  14. of the Software.
  15. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
  16. TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
  17. THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF
  18. CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
  19. DEALINGS IN THE SOFTWARE.
  20. """
  21. import re
  22. from markdown import Extension
  23. from . import util
  24. SMART_CONTENT = r'((?:(?<=\s)~+?(?=\s)|.)+?~*?)'
  25. SMART_MIXED_CONTENT = r'((?:~(?=[^\s])|(?<=\s)~+?(?=\s))+?~*)'
  26. CONTENT = r'(~|[^\s]+?)'
  27. CONTENT2 = r'((?:[^~]|(?<!~{2})~)+?)'
  28. # `~~~del,sub~~~`
  29. DEL_SUB = r'(~{3})(?!\s)(~{1,2}|[^~\s]+?)(?<!\s)\1'
  30. # `~~~del,sub~del~~`
  31. DEL_SUB2 = r'(~{3})(?![\s~])%s(?<!\s)~%s(?<!\s)~{2}' % (CONTENT, CONTENT2)
  32. # `~~~sub,del~~sub~`
  33. SUB_DEL = r'(~{3})(?![\s~])%s(?<!\s)~{2}%s(?<!\s)~' % (CONTENT, CONTENT)
  34. # `~~del~sub,del~~~`
  35. DEL_SUB3 = r'(~{2})(?![\s~])%s~(?![\s~])%s(?<!\s)~{3}' % (CONTENT2, CONTENT)
  36. # `~~del~~`
  37. DEL = r'(~{2})(?!\s)%s(?<!\s)\1' % CONTENT2
  38. # `~sub~`
  39. SUB = r'(~)(?!\s)%s(?<!\s)\1' % CONTENT
  40. # Smart rules for when "smart tilde" is enabled
  41. # SMART: `~~~del,sub~~~`
  42. SMART_DEL_SUB = r'(~{3})(?![\s~])%s(?<!\s)\1' % CONTENT
  43. # `~~~del,sub~ del~~`
  44. SMART_DEL_SUB2 = \
  45. r'(~{3})(?![\s~])%s(?<!\s)~(?:(?=_)|(?![\w~]))%s(?<!\s)~{2}' % (
  46. CONTENT, SMART_CONTENT
  47. )
  48. # `~~~sub,del~~ sub~`
  49. SMART_SUB_DEL = \
  50. r'(~{3})(?![\s~])%s(?<!\s)~{2}(?:(?=_)|(?![\w~]))%s(?<!\s)~' % (
  51. CONTENT, CONTENT
  52. )
  53. # `~~del~~`
  54. SMART_DEL = r'(?:(?<=_)|(?<![\w~]))(~{2})(?![\s~])%s(?<!\s)\1(?:(?=_)|(?![\w~]))' % SMART_CONTENT
  55. class TildeProcessor(util.PatternSequenceProcessor):
  56. """Emphasis processor for handling delete and subscript matches."""
  57. PATTERNS = [
  58. util.PatSeqItem(re.compile(DEL_SUB, re.DOTALL | re.UNICODE), 'double', 'del,sub'),
  59. util.PatSeqItem(re.compile(SUB_DEL, re.DOTALL | re.UNICODE), 'double', 'sub,del'),
  60. util.PatSeqItem(re.compile(DEL_SUB2, re.DOTALL | re.UNICODE), 'double', 'del,sub'),
  61. util.PatSeqItem(re.compile(DEL_SUB3, re.DOTALL | re.UNICODE), 'double2', 'del,sub'),
  62. util.PatSeqItem(re.compile(DEL, re.DOTALL | re.UNICODE), 'single', 'del'),
  63. util.PatSeqItem(re.compile(SUB, re.DOTALL | re.UNICODE), 'single', 'sub')
  64. ]
  65. class TildeSmartProcessor(util.PatternSequenceProcessor):
  66. """Smart delete and subscript processor."""
  67. PATTERNS = [
  68. util.PatSeqItem(re.compile(SMART_DEL_SUB, re.DOTALL | re.UNICODE), 'double', 'del,sub'),
  69. util.PatSeqItem(re.compile(SMART_SUB_DEL, re.DOTALL | re.UNICODE), 'double', 'sub,del'),
  70. util.PatSeqItem(re.compile(SMART_DEL_SUB2, re.DOTALL | re.UNICODE), 'double', 'del,sub'),
  71. util.PatSeqItem(re.compile(SMART_DEL, re.DOTALL | re.UNICODE), 'single', 'del'),
  72. util.PatSeqItem(re.compile(SUB, re.DOTALL | re.UNICODE), 'single', 'sub')
  73. ]
  74. class TildeSubProcessor(util.PatternSequenceProcessor):
  75. """Just subscript processor."""
  76. PATTERNS = [
  77. util.PatSeqItem(re.compile(SUB, re.DOTALL | re.UNICODE), 'single', 'sub')
  78. ]
  79. class TildeDeleteProcessor(util.PatternSequenceProcessor):
  80. """Just delete processor."""
  81. PATTERNS = [
  82. util.PatSeqItem(re.compile(DEL, re.DOTALL | re.UNICODE), 'single', 'del')
  83. ]
  84. class TildeSmartDeleteProcessor(util.PatternSequenceProcessor):
  85. """Just smart delete processor."""
  86. PATTERNS = [
  87. util.PatSeqItem(re.compile(SMART_DEL, re.DOTALL | re.UNICODE), 'single', 'del')
  88. ]
  89. class DeleteSubExtension(Extension):
  90. """Add delete and/or subscript extension to Markdown class."""
  91. def __init__(self, *args, **kwargs):
  92. """Initialize."""
  93. self.config = {
  94. 'smart_delete': [True, "Treat ~~connected~~words~~ intelligently - Default: True"],
  95. 'delete': [True, "Enable delete - Default: True"],
  96. 'subscript': [True, "Enable subscript - Default: True"]
  97. }
  98. super(DeleteSubExtension, self).__init__(*args, **kwargs)
  99. def extendMarkdown(self, md):
  100. """Insert `<del>test</del>` tags as `~~test~~` and `<sub>test</sub>` tags as `~test~`."""
  101. config = self.getConfigs()
  102. delete = bool(config.get('delete', True))
  103. subscript = bool(config.get('subscript', True))
  104. smart = bool(config.get('smart_delete', True))
  105. md.registerExtension(self)
  106. escape_chars = []
  107. if delete or subscript:
  108. escape_chars.append('~')
  109. if subscript:
  110. escape_chars.append(' ')
  111. util.escape_chars(md, escape_chars)
  112. tilde = None
  113. if delete and subscript:
  114. tilde = TildeSmartProcessor(r'~') if smart else TildeProcessor(r'~')
  115. elif delete:
  116. tilde = TildeSmartDeleteProcessor(r'~') if smart else TildeDeleteProcessor(r'~')
  117. elif subscript:
  118. tilde = TildeSubProcessor(r'~')
  119. if tilde is not None:
  120. md.inlinePatterns.register(tilde, "sub_del", 65)
  121. def makeExtension(*args, **kwargs):
  122. """Return extension."""
  123. return DeleteSubExtension(*args, **kwargs)