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
|
# (C) Copyright 2004-2023 Enthought, Inc., Austin, TX
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in LICENSE.txt and may be redistributed only under
# the conditions described in the aforementioned license. The license
# is also available online at http://www.enthought.com/licenses/BSD.txt
#
# Thanks for using Enthought open source!
""" Defines the HTML editor factory. HTML editors interpret and display
HTML-formatted text, but do not modify it.
"""
from traits.api import Bool, Str
from traitsui.basic_editor_factory import BasicEditorFactory
from traitsui.toolkit import toolkit_object
# Callable that returns the editor to use in the UI.
def html_editor(*args, **traits):
return toolkit_object("html_editor:SimpleEditor")(*args, **traits)
# Template used to create code blocks embedded in the module comment
block_template = """<center><table width="95%%"><tr><td bgcolor="#ECECEC"><tt>
%s</tt></td></tr></table></center>"""
# Template used to create lists embedded in the module comment
list_template = """<%s>
%s
</%s>"""
# ------------------------------------------------------------------------------
# 'ToolkitEditorFactory' class:
# ------------------------------------------------------------------------------
class ToolkitEditorFactory(BasicEditorFactory):
"""Editor factory for HTML editors."""
# --------------------------------------------------------------------------
# Trait definitions:
# --------------------------------------------------------------------------
#: Should implicit text formatting be converted to HTML?
format_text = Bool(False)
#: External objects referenced in the HTML are relative to this url
base_url = Str()
#: The object trait containing the base URL
base_url_name = Str()
#: Should links be opened in an external browser?
open_externally = Bool(False)
def parse_text(self, text):
"""Parses the contents of a formatted text string into the
corresponding HTML.
"""
text = text.replace("\r\n", "\n")
lines = [("." + line).strip()[1:] for line in text.split("\n")]
ind = min(
*(
[self.indent(line) for line in lines if line != ""]
+ [1000, 1000]
)
)
if ind >= 1000:
ind = 0
lines = [line[ind:] for line in lines]
new_lines = []
i = 0
n = len(lines)
while i < n:
line = lines[i]
m = self.indent(line)
if m > 0:
if line[m] in "-*":
i, line = self.parse_list(lines, i)
else:
i, line = self.parse_block(lines, i)
new_lines.append(line)
else:
new_lines.append(line)
i += 1
text = "\n".join(new_lines)
paragraphs = [p.strip() for p in text.split("\n\n")]
for i, paragraph in enumerate(paragraphs):
if paragraph[:3].lower() != "<p>":
paragraphs[i] = "<p>%s</p>" % paragraph
return "\n".join(paragraphs)
def parse_block(self, lines, i):
"""Parses a code block."""
m = 1000
n = len(lines)
j = i
while j < n:
line = lines[j]
if line != "":
k = self.indent(line)
if k == 0:
break
m = min(m, k)
j += 1
j -= 1
while (j > i) and (lines[j] == ""):
j -= 1
j += 1
temp = [
((" " * (self.indent(line) - m)) + line.strip())
for line in lines[i:j]
]
return (j, block_template % "\n<br>".join(temp))
def parse_list(self, lines, i):
"""Parses a list."""
line = lines[i]
m = self.indent(line)
kind = line[m]
result = ["<li>" + line[m + 1 :].strip()]
n = len(lines)
j = i + 1
while j < n:
line = lines[j]
k = self.indent(line)
if k < m:
break
if k == m:
if line[k] != kind:
break
result.append("<li>" + line[k + 1 :].strip())
j += 1
elif line[k] in "-*":
j, line = self.parse_list(lines, j)
result.append(line)
else:
result.append(line.strip())
j += 1
style = ["ul", "ol"][kind == "*"]
return (j, list_template % (style, "\n".join(result), style))
def indent(self, line):
"""Calculates the amount of white space at the beginning of a line."""
return len(line) - len((line + ".").strip()) + 1
HTMLEditor = ToolkitEditorFactory(klass=html_editor)
|