def setUp(self):
""" Sets up fixture. """
self._target = NamedTemporaryFile(suffix = ".xml", delete = False)
s = BeautifulStoneSoup()
self._a = Tag(s, "a")
self._frame = Coqdoc_Frame(command_cd = [self._a], command = "foo",
response = None)
self._coqdoc_movie = Coqdoc_Movie()
self._coqdoc_movie.addFrame(self._frame)
class Test_Coqdoc_Movie(unittest.TestCase):
""" Test several aspects of a Coqdoc movie. """
def setUp(self):
""" Sets up fixture. """
self._target = NamedTemporaryFile(suffix = ".xml", delete = False)
s = BeautifulStoneSoup()
self._a = Tag(s, "a")
self._frame = Coqdoc_Frame(command_cd = [self._a], command = "foo",
response = None)
self._coqdoc_movie = Coqdoc_Movie()
self._coqdoc_movie.addFrame(self._frame)
def test_to_file_parents(self):
""" When asked to write to a directory that does not yet exist, the
toFile function should create that directory. """
filename = join(dirname(self._target.name), "new",
basename(self._target.name))
self._coqdoc_movie.toFile(filename)
def test_from_string(self):
""" Import a document from a string representation of the xml. """
xml = """<?xml encoding="utf-8" version="1.0" ?>
<?xml-stylesheet type="text/xsl" href="proviola.xsl" ?>
<movie>
<film>
<frame framenumber="0">
<command>Spam</command>
<response>Eggs</response>
<command-coqdoc><div>Spam</div></command-coqdoc>
</frame>
</film>
<scenes>
<scene id="page" scenenumber="0" class="doc">
<frame-reference framenumber="0" />
</scene>
</scenes>
</movie>"""
self._coqdoc_movie.from_string(xml)
frame = self._coqdoc_movie.get_frames()[0]
self.assertEquals(frame.getCommand(), "Spam")
self.assertEquals(frame.getResponse(), "Eggs")
self.assertEquals(str(frame.get_coqdoc_command()), "<div>Spam</div>")
def __init__(self): """ Setup: creates an empty movie. """ CoqReader.__init__(self) self._movie = Coqdoc_Movie() self._prover = None self._coqdoc_tree = None
class Coqdoc_Reader(CoqReader):
""" Reader that reads Coqdoc-produces HTML files, creating a movie maintaining
the original layout, with state output inlined.
"""
def __init__(self):
""" Setup: creates an empty movie. """
CoqReader.__init__(self)
self._movie = Coqdoc_Movie()
self._prover = None
self._coqdoc_tree = None
def add_code(self, code):
""" Override of the corresponding method in Reader: makes a
BeautifulSoup tree out of the given Coqdoc document. """
massage = copy.copy(BeautifulSoup.MARKUP_MASSAGE)
massage.extend([(re.compile('(name|href)="([^"]*)"'),
lambda match: match.group(1) + '="' + escape(match.group(2)) +'"')])
self._coqdoc_tree = BeautifulSoup(code, markupMassage = massage)
def _find_commands(self, div):
""" Find the commands. This is a wrapper around parent's parse. """
try:
text = ''.join(div.fetchText(text = True))
except AttributeError:
text = div
return self.parse(text)
def _replace_html(self, text):
""" Replace HTML entitities by ASCII equivalents.
Special entities taken from SF's symbols.v """
replacements = {" ": " ",
"→": "->",
"←": "<-",
"Γ": "Gamma",
"∀": "forall",
"∃": "exists",
"&exists;": "exists",
"⇓": "||",
"&Arr;": "==>",
"↔": "<->",
"∧": "/\\",
"∨": "\/",
"⇒": "~~>",
"⇔": "<~~>",
"⊢": "|-",
""": '"',
"´": "'",
}
unicode_replacements = {u'\u2260': u'<>',
u'\u22a2': u'|-',
u'\u2265': u'>=',
u'\u2264': u'<=',
u'\u2227': u'/\\',
u'\u2228': u'\\/',
u'\xac': u'~',
u'\u2190': u'<-',
u'\u2192': u'->',
u'\u2194': u'<->',
u'\xd7': u'*',
u'\u21d2': u'=>',
u'\u2200': u'forall',
u'\u2203': u'exists',
}
text = unescape(text, replacements)
for key, value in unicode_replacements.items():
text = text.replace(key, value)
return text
def _process_code(self, div):
""" Process a code div, returning a scene and the frames referenced.
"""
frames = []
scene = Scene()
scene.set_type("code")
coqdoc = []
for child in div:
coqdoc.append(child)
commands = self._find_commands(child)
if commands and self.isCommand(commands[0]):
command = self._replace_html(commands[0])
response = self._prover.send(
command.encode(self._coqdoc_tree.originalEncoding))
frame = Coqdoc_Frame(command = command, command_cd = coqdoc,
response = response)
frames.append(frame)
scene.add_scene(frame)
coqdoc = []
trailing_frame = Coqdoc_Frame(command = ''.join([str(el) for el in coqdoc]),
command_cd = coqdoc,
response = None)
frames.append(trailing_frame)
scene.add_scene(trailing_frame)
return frames, scene
def _process_doc(self, div):
frames = []
scene = Scene()
scene.set_type("doc")
scene.set_attributes(div.attrs)
for child in div:
try:
child_name = child.name
except AttributeError:
child_name = "text"
child.text = str(child)
if child_name == "div":
if div.get("class") == "doc":
child_frames, child_scene = self._process_doc(child)
else:
child_frames, child_scene = self._process_div(child)
else:
child_scene = Coqdoc_Frame(command = child.text, command_cd = [child],
response = None)
child_frames = [child_scene]
frames += child_frames
scene.add_scene(child_scene)
return frames, scene
def _is_code(self, div):
""" Test whether the given div is a code div. """
return div.get("class") and "code" in div.get("class").split()
def _process_div(self, div):
""" Given a div element, return a list of frames with the div's content,
and a scene mimicking its structure. """
if self._is_code(div):
return self._process_code(div)
else:
return self._process_doc(div)
def make_frames(self, prover):
""" Constructor of frames: reads the given HTML file (self.script) and
produces a frame per command/comment.
- prover: handle to the prover to use to generate output.
"""
self._prover = prover
try:
self._movie.add_to_title(self._coqdoc_tree.head.title.text)
except AttributeError:
self._movie.add_to_title("")
body = self._coqdoc_tree.body
if body:
for div in body.findChildren(name = "div", recursive = False):
(frames, scene) = self._process_div(div)
for frame in frames:
self._movie.addFrame(frame)
self._movie.add_scene(scene)
return self._movie
def __init__(self):
""" Setup: creates an empty movie. """
CoqReader.__init__(self)
self._movie = Coqdoc_Movie()
self._prover = None
self._coqdoc_tree = None
class Coqdoc_Reader(CoqReader):
""" Reader that reads Coqdoc-produces HTML files, creating a movie maintaining
the original layout, with state output inlined.
"""
def __init__(self):
""" Setup: creates an empty movie. """
CoqReader.__init__(self)
self._movie = Coqdoc_Movie()
self._prover = None
self._coqdoc_tree = None
def add_code(self, code):
""" Override of the corresponding method in Reader: makes a
BeautifulSoup tree out of the given Coqdoc document. """
massage = copy.copy(BeautifulSoup.MARKUP_MASSAGE)
massage.extend([(
re.compile('(name|href)="([^"]*)"'),
lambda match: match.group(1) + '="' + escape(match.group(2)) + '"')
])
self._coqdoc_tree = BeautifulSoup(code, markupMassage=massage)
def _find_commands(self, div):
""" Find the commands. This is a wrapper around parent's parse. """
try:
text = ''.join(div.fetchText(text=True))
except AttributeError:
text = div
return self.parse(text)
def _replace_html(self, text):
""" Replace HTML entitities by ASCII equivalents.
Special entities taken from SF's symbols.v """
replacements = {
" ": " ",
"→": "->",
"←": "<-",
"Γ": "Gamma",
"∀": "forall",
"∃": "exists",
"&exists;": "exists",
"⇓": "||",
"&Arr;": "==>",
"↔": "<->",
"∧": "/\\",
"∨": "\/",
"⇒": "~~>",
"⇔": "<~~>",
"⊢": "|-",
""": '"',
"´": "'",
}
unicode_replacements = {
u'\u2260': u'<>',
u'\u22a2': u'|-',
u'\u2265': u'>=',
u'\u2264': u'<=',
u'\u2227': u'/\\',
u'\u2228': u'\\/',
u'\xac': u'~',
u'\u2190': u'<-',
u'\u2192': u'->',
u'\u2194': u'<->',
u'\xd7': u'*',
u'\u21d2': u'=>',
u'\u2200': u'forall',
u'\u2203': u'exists',
}
text = unescape(text, replacements)
for key, value in unicode_replacements.items():
text = text.replace(key, value)
return text
def _process_code(self, div):
""" Process a code div, returning a scene and the frames referenced.
"""
frames = []
scene = Scene()
scene.set_type("code")
coqdoc = []
for child in div:
coqdoc.append(child)
commands = self._find_commands(child)
if commands and self.isCommand(commands[0]):
command = self._replace_html(commands[0])
if (command.count("Notation") == 0):
response = self._prover.send(
command.encode(self._coqdoc_tree.originalEncoding))
frame = Coqdoc_Frame(command=command,
command_cd=coqdoc,
response=response)
frames.append(frame)
scene.add_scene(frame)
coqdoc = []
trailing_frame = Coqdoc_Frame(command=''.join(
[str(el) for el in coqdoc]),
command_cd=coqdoc,
response=None)
frames.append(trailing_frame)
scene.add_scene(trailing_frame)
return frames, scene
def _process_doc(self, div):
frames = []
scene = Scene()
scene.set_type("doc")
scene.set_attributes(div.attrs)
for child in div:
try:
child_name = child.name
except AttributeError:
child_name = "text"
child.text = str(child)
if child_name == "div":
if div.get("class") == "doc":
child_frames, child_scene = self._process_doc(child)
else:
child_frames, child_scene = self._process_div(child)
else:
child_scene = Coqdoc_Frame(command=child.text,
command_cd=[child],
response=None)
child_frames = [child_scene]
frames += child_frames
scene.add_scene(child_scene)
return frames, scene
def _is_code(self, div):
""" Test whether the given div is a code div. """
return div.get("class") and "code" in div.get("class").split()
def _process_div(self, div):
""" Given a div element, return a list of frames with the div's content,
and a scene mimicking its structure. """
if self._is_code(div):
return self._process_code(div)
else:
return self._process_doc(div)
def make_frames(self, prover):
""" Constructor of frames: reads the given HTML file (self.script) and
produces a frame per command/comment.
- prover: handle to the prover to use to generate output.
"""
self._prover = prover
try:
self._movie.add_to_title(self._coqdoc_tree.head.title.text)
except AttributeError:
self._movie.add_to_title("")
body = self._coqdoc_tree.body
if body:
for div in body.findChildren(name="div", recursive=False):
(frames, scene) = self._process_div(div)
for frame in frames:
self._movie.addFrame(frame)
self._movie.add_scene(scene)
return self._movie
