/
coqdomain.py
1486 lines (1193 loc) · 55 KB
/
coqdomain.py
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
##########################################################################
## # The Coq Proof Assistant / The Coq Development Team ##
## v # Copyright INRIA, CNRS and contributors ##
## <O___,, # (see version control and CREDITS file for authors & dates) ##
## \VV/ ###############################################################
## // # This file is distributed under the terms of the ##
## # GNU Lesser General Public License Version 2.1 ##
## # (see LICENSE file for the text of the license) ##
##########################################################################
"""A Coq domain for Sphinx.
Currently geared towards Coq's manual, rather than Coq source files, but one
could imagine extending it.
"""
# pylint: disable=missing-type-doc, missing-param-doc
# pylint: disable=missing-return-type-doc, missing-return-doc
# pylint: disable=too-few-public-methods, too-many-ancestors, arguments-differ
# pylint: disable=import-outside-toplevel, abstract-method, too-many-lines
import os
import re
from itertools import chain
from collections import defaultdict
from docutils import nodes, utils
from docutils.transforms import Transform
from docutils.parsers.rst import Directive, directives
from docutils.parsers.rst.roles import code_role #, set_classes
from docutils.parsers.rst.directives.admonitions import BaseAdmonition
from sphinx import addnodes, version_info as sphinx_version
from sphinx.directives import ObjectDescription
from sphinx.domains import Domain, ObjType, Index
from sphinx.errors import ExtensionError
from sphinx.roles import XRefRole
from sphinx.util.docutils import ReferenceRole
from sphinx.util.logging import getLogger, get_node_location
from sphinx.util.nodes import set_source_info, set_role_source_info, make_refnode
from sphinx.writers.latex import LaTeXTranslator
from . import coqdoc
from .repl import ansicolors
from .repl.coqtop import CoqTop, CoqTopError
from .notations.parsing import ParseError
from .notations.sphinx import sphinxify
from .notations.plain import stringify_with_ellipses
# FIXME: Patch this in Sphinx
# https://github.com/coq/coq/issues/12361
if sphinx_version >= (4, 5):
from sphinx.writers.latex import CR
def visit_desc_signature(self, node):
hyper = ''
if node.parent['objtype'] != 'describe' and node['ids']:
for id in node['ids']:
hyper += self.hypertarget(id)
self.body.append(hyper)
if not self.in_desc_signature:
self.in_desc_signature = True
self.body.append(CR + r'\pysigstartsignatures')
if not node.get('is_multiline'):
self._visit_signature_line(node)
else:
self.body.append(CR + r'\pysigstartmultiline')
else:
def visit_desc_signature(self, node):
hyper = ''
if node.parent['objtype'] != 'describe' and node['ids']:
for id in node['ids']:
hyper += self.hypertarget(id)
self.body.append(hyper)
if not node.get('is_multiline'):
self._visit_signature_line(node)
else:
self.body.append('%\n\\pysigstartmultiline\n')
LaTeXTranslator.visit_desc_signature = visit_desc_signature
PARSE_ERROR = """{}:{} Parse error in notation!
Offending notation: {}
Error message: {}"""
def notation_to_sphinx(notation, source, line, rawtext=None):
"""Parse notation and wrap it in an inline node"""
try:
node = nodes.inline(rawtext or notation, '', *sphinxify(notation), classes=['notation'])
node.source, node.line = source, line
return node
except ParseError as e:
raise ExtensionError(PARSE_ERROR.format(os.path.basename(source), line, notation, e.msg)) from e
def notation_to_string(notation):
"""Parse notation and format it as a string with ellipses."""
try:
return stringify_with_ellipses(notation)
except ParseError as e:
# FIXME source and line aren't defined below — see cc93f419e0
raise ExtensionError(PARSE_ERROR.format(os.path.basename(source), line, notation, e.msg)) from e
def highlight_using_coqdoc(sentence):
"""Lex sentence using coqdoc, and yield inline nodes for each token"""
tokens = coqdoc.lex(utils.unescape(sentence, 1))
for classes, value in tokens:
yield nodes.inline(value, value, classes=classes)
def make_target(objtype, targetid):
"""Create a target to an object of type objtype and id targetid"""
return "coq:{}.{}".format(objtype, targetid)
def make_math_node(latex, docname, nowrap):
node = nodes.math_block(latex, latex)
node['label'] = None # Otherwise equations are numbered
node['nowrap'] = nowrap
node['docname'] = docname
node['number'] = None
return node
# To support any character in tacn, ... names.
# see https://github.com/coq/coq/pull/13564
def make_id(tag):
return tag.replace(" ", "-")
class CoqObject(ObjectDescription):
"""A generic Coq object for Sphinx; all Coq objects are subclasses of this.
The fields and methods to override are listed at the top of this class'
implementation. Each object supports the :name: option, which gives an
explicit name to link to.
See the comments and docstrings in CoqObject for more information.
"""
# The semantic domain in which this object lives (eg. “tac”, “cmd”, “chm”…).
# It matches exactly one of the roles used for cross-referencing.
subdomain = None # type: str
# The suffix to use in indices for objects of this type (eg. “(tac)”)
index_suffix = None # type: str
# The annotation to add to headers of objects of this type
# (eg. “Command”, “Theorem”)
annotation = None # type: str
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
self._sig_names = None
def _name_from_signature(self, signature): # pylint: disable=no-self-use, unused-argument
"""Convert a signature into a name to link to.
‘Signature’ is Sphinx parlance for an object's header (think “type
signature”); for example, the signature of the simplest form of the
``exact`` tactic is ``exact @id``.
Generates a name for the directive. Override this method to return None
to avoid generating a name automatically. This is a convenient way
to automatically generate names (link targets) without having to write
explicit names everywhere.
"""
m = re.match(r"[a-zA-Z0-9_ ]+", signature)
if m:
return m.group(0).strip()
def _render_signature(self, signature, signode):
"""Render a signature, placing resulting nodes into signode."""
raise NotImplementedError(self)
option_spec = {
# Explicit object naming
'name': directives.unchanged,
# Silence warnings produced by report_undocumented_coq_objects
'undocumented': directives.flag,
# noindex omits this object from its index
'noindex': directives.flag
}
def subdomain_data(self):
if self.subdomain is None:
raise ValueError()
return self.env.domaindata['coq']['objects'][self.subdomain]
def _render_annotation(self, signode):
if self.annotation:
annot_node = nodes.inline(self.annotation, self.annotation, classes=['sigannot'])
signode += addnodes.desc_annotation(self.annotation, '', annot_node)
signode += nodes.Text(' ')
def handle_signature(self, signature, signode):
"""Prefix signature with the proper annotation, then render it using
``_render_signature`` (for example, add “Command” in front of commands).
:returns: the names given to the resulting node.
"""
self._render_annotation(signode)
self._render_signature(signature, signode)
names = self._sig_names.get(signature)
if names is None:
name = self._name_from_signature(signature) # pylint: disable=assignment-from-none
# remove trailing ‘.’ found in commands, but not ‘...’ (ellipsis)
if name is not None and name.endswith(".") and not name.endswith("..."):
name = name[:-1]
names = [name] if name else None
return names
def _warn_if_duplicate_name(self, objects, name, signode):
"""Check that two objects in the same domain don't have the same name."""
if name in objects:
MSG = 'Duplicate name {} (other is in {}) attached to {}'
msg = MSG.format(name, self.env.doc2path(objects[name][0]), signode)
self.state_machine.reporter.warning(msg, line=self.lineno)
def _record_name(self, name, target_id, signode):
"""Record a `name` in the current subdomain, mapping it to `target_id`.
Warns if another object of the same name already exists; `signode` is
used in the warning.
"""
names_in_subdomain = self.subdomain_data()
self._warn_if_duplicate_name(names_in_subdomain, name, signode)
names_in_subdomain[name] = (self.env.docname, self.objtype, target_id)
def _target_id(self, name):
return make_target(self.objtype, make_id(name))
def _add_target(self, signode, name):
"""Register a link target ‘name’, pointing to signode."""
targetid = self._target_id(name)
if targetid not in self.state.document.ids:
signode['ids'].append(targetid)
signode['names'].append(name)
signode['first'] = (not self.names)
self._record_name(name, targetid, signode)
else:
# todo: make the following a real error or warning
# todo: then maybe the above "if" is not needed
names_in_subdomain = self.subdomain_data()
if name in names_in_subdomain:
print("Duplicate", self.subdomain, "name: ", name)
# self._warn_if_duplicate_name(names_in_subdomain, name, signode)
return targetid
def _add_index_entry(self, name, target):
"""Add `name` (pointing to `target`) to the main index."""
assert isinstance(name, str)
# remove trailing . , found in commands, but not ... (ellipsis)
trim = name.endswith(".") and not name.endswith("...")
index_text = name[:-1] if trim else name
if self.index_suffix:
index_text += " " + self.index_suffix
self.indexnode['entries'].append(('single', index_text, target, '', None))
def add_target_and_index(self, names, _, signode):
"""Attach a link target to `signode` and index entries for `names`.
This is only called (from ``ObjectDescription.run``) if ``:noindex:`` isn't specified."""
if names:
for name in names:
if isinstance(name, str) and name.startswith('_'):
continue
target = self._add_target(signode, name)
self._add_index_entry(name, target)
self.state.document.note_explicit_target(signode)
def _prepare_names(self):
"""Construct ``self._sig_names``, a map from signatures to names.
A node may have either one signature with no name, multiple signatures
with one name per signatures, or one signature with multiple names.
"""
sigs = self.get_signatures()
names = self.options.get("name")
if names is None:
self._sig_names = {}
else:
names = [n.strip() for n in names.split(";")]
if len(names) != len(sigs):
if len(sigs) != 1: #Multiple names for one signature
ERR = ("Expected {} semicolon-separated names, got {}. " +
"Please provide one name per signature line.")
raise self.error(ERR.format(len(names), len(sigs)))
self._sig_names = { sigs[0]: names }
else:
self._sig_names = { sig: [name] for (sig, name) in zip(sigs, names) }
def run(self):
self._prepare_names()
return super().run()
class DocumentableObject(CoqObject):
def _warn_if_undocumented(self):
document = self.state.document
config = document.settings.env.config
report = config.report_undocumented_coq_objects
if report and not self.content and "undocumented" not in self.options:
# This is annoyingly convoluted, but we don't want to raise warnings
# or interrupt the generation of the current node. For more details
# see https://github.com/sphinx-doc/sphinx/issues/4976.
msg = 'No contents in directive {}'.format(self.name)
node = document.reporter.info(msg, line=self.lineno)
getLogger(__name__).info(node.astext())
if report == "warning":
raise self.warning(msg)
def run(self):
self._warn_if_undocumented()
return super().run()
class PlainObject(DocumentableObject):
"""A base class for objects whose signatures should be rendered literally."""
def _render_signature(self, signature, signode):
signode += addnodes.desc_name(signature, signature)
class NotationObject(DocumentableObject):
"""A base class for objects whose signatures should be rendered as nested boxes.
Objects that inherit from this class can use the notation grammar (“{+ …}”,
“@…”, etc.) in their signature.
"""
def _render_signature(self, signature, signode):
position = self.state_machine.get_source_and_line(self.lineno)
tacn_node = notation_to_sphinx(signature, *position)
signode += addnodes.desc_name(signature, '', tacn_node)
class GallinaObject(PlainObject):
r"""A theorem.
Example::
.. thm:: Bound on the ceiling function
Let :math:`p` be an integer and :math:`c` a rational constant. Then
:math:`p \ge c \rightarrow p \ge \lceil{c}\rceil`.
"""
subdomain = "thm"
index_suffix = "(theorem)"
annotation = "Theorem"
class VernacObject(NotationObject):
"""A Coq command.
Example::
.. cmd:: Infix @string := @one_term {? ( {+, @syntax_modifier } ) } {? : @ident }
This command is equivalent to :n:`…`.
"""
subdomain = "cmd"
index_suffix = "(command)"
annotation = "Command"
def _name_from_signature(self, signature):
m = re.match(r"[a-zA-Z0-9_ ]+", signature)
return m.group(0).strip() if m else None
class VernacVariantObject(VernacObject):
"""A variant of a Coq command.
Example::
.. cmd:: Axiom @ident : @term.
This command links :token:`term` to the name :token:`term` as its specification in
the global environment. The fact asserted by :token:`term` is thus assumed as a
postulate.
.. cmdv:: Parameter @ident : @term.
This is equivalent to :n:`Axiom @ident : @term`.
"""
index_suffix = "(command variant)"
annotation = "Variant"
def _name_from_signature(self, signature):
return None
class TacticObject(NotationObject):
"""A tactic, or a tactic notation.
Example::
.. tacn:: do @natural @expr
:token:`expr` is evaluated to ``v`` which must be a tactic value. …
"""
subdomain = "tacn"
index_suffix = "(tactic)"
annotation = "Tactic"
class AttributeObject(NotationObject):
"""An attribute.
Example::
.. attr:: local
"""
subdomain = "attr"
index_suffix = "(attribute)"
annotation = "Attribute"
def _name_from_signature(self, signature):
return notation_to_string(signature)
class TacticVariantObject(TacticObject):
"""A variant of a tactic.
Example::
.. tacn:: fail
This is the always-failing tactic: it does not solve any goal. It is
useful for defining other tacticals since it can be caught by
:tacn:`try`, :tacn:`repeat`, :tacn:`match goal`, or the branching
tacticals. …
.. tacv:: fail @natural
The number is the failure level. If no level is specified, it
defaults to 0. …
"""
index_suffix = "(tactic variant)"
annotation = "Variant"
def _name_from_signature(self, signature):
return None
class OptionObject(NotationObject):
"""A Coq option (a setting with non-boolean value, e.g. a string or numeric value).
Example::
.. opt:: Hyps Limit @natural
:name Hyps Limit
Controls the maximum number of hypotheses displayed in goals after
application of a tactic.
"""
subdomain = "opt"
index_suffix = "(option)"
annotation = "Option"
class FlagObject(NotationObject):
"""A Coq flag (i.e. a boolean setting).
Example::
.. flag:: Nonrecursive Elimination Schemes
Controls whether types declared with the keywords
:cmd:`Variant` and :cmd:`Record` get an automatic declaration of
induction principles.
"""
subdomain = "flag"
index_suffix = "(flag)"
annotation = "Flag"
class TableObject(NotationObject):
"""A Coq table, i.e. a setting that is a set of values.
Example::
.. table:: Search Blacklist @string
:name: Search Blacklist
Controls ...
"""
subdomain = "table"
index_suffix = "(table)"
annotation = "Table"
class ProductionObject(CoqObject):
r"""A grammar production.
Use ``.. prodn`` to document grammar productions instead of Sphinx
`production lists
<http://www.sphinx-doc.org/en/stable/markup/para.html#directive-productionlist>`_.
prodn displays multiple productions together with alignment similar to ``.. productionlist``,
however unlike ``.. productionlist``\ s, this directive accepts notation syntax.
Example::
.. prodn:: occ_switch ::= { {? {| + | - } } {* @natural } }
term += let: @pattern := @term in @term
| second_production
The first line defines "occ_switch", which must be unique in the document. The second
references and expands the definition of "term", whose main definition is elsewhere
in the document. The third form is for continuing the
definition of a nonterminal when it has multiple productions. It leaves the first
column in the output blank.
"""
subdomain = "prodn"
#annotation = "Grammar production"
# handle_signature is called for each line of input in the prodn::
# 'signatures' accumulates them in order to combine the lines into a single table:
signatures = None # FIXME this should be in init, shouldn't it?
def _render_signature(self, signature, signode):
raise NotImplementedError(self)
SIG_ERROR = ("{}: Invalid syntax in ``.. prodn::`` directive"
+ "\nExpected ``name ::= ...`` or ``name += ...``"
+ " (e.g. ``pattern += constr:(@ident)``)\n"
+ " in `{}`")
def handle_signature(self, signature, signode):
parts = signature.split(maxsplit=1)
if parts[0].strip() == "|" and len(parts) == 2:
lhs = ""
op = "|"
rhs = parts[1].strip()
else:
parts = signature.split(maxsplit=2)
if len(parts) != 3:
loc = os.path.basename(get_node_location(signode))
raise ExtensionError(ProductionObject.SIG_ERROR.format(loc, signature))
lhs, op, rhs = (part.strip() for part in parts)
if op not in ["::=", "+="]:
loc = os.path.basename(get_node_location(signode))
raise ExtensionError(ProductionObject.SIG_ERROR.format(loc, signature))
parts = rhs.split(" ", maxsplit=1)
rhs = parts[0].strip()
tag = parts[1].strip() if len(parts) == 2 else ""
self.signatures.append((lhs, op, rhs, tag))
return [('token', lhs)] if op == '::=' else None
def _add_index_entry(self, name, target):
pass
def _target_id(self, name):
return make_id('grammar-token-{}'.format(name[1]))
def _record_name(self, name, targetid, signode):
env = self.state.document.settings.env
objects = env.domaindata['std']['objects']
self._warn_if_duplicate_name(objects, name, signode)
objects[name] = env.docname, targetid
def run(self):
self.signatures = []
indexnode = super().run()[0] # makes calls to handle_signature
table = nodes.inline(classes=['prodn-table'])
tgroup = nodes.inline(classes=['prodn-column-group'])
for _ in range(4):
tgroup += nodes.inline(classes=['prodn-column'])
table += tgroup
tbody = nodes.inline(classes=['prodn-row-group'])
table += tbody
# create rows
for signature in self.signatures:
lhs, op, rhs, tag = signature
position = self.state_machine.get_source_and_line(self.lineno)
row = nodes.inline(classes=['prodn-row'])
entry = nodes.inline(classes=['prodn-cell-nonterminal'])
if lhs != "":
target_name = make_id('grammar-token-' + lhs)
target = nodes.target('', '', ids=[target_name], names=[target_name])
# putting prodn-target on the target node won't appear in the tex file
inline = nodes.inline(classes=['prodn-target'])
inline += target
entry += inline
entry += notation_to_sphinx('@'+lhs, *position)
else:
entry += nodes.literal('', '')
row += entry
entry = nodes.inline(classes=['prodn-cell-op'])
entry += nodes.literal(op, op)
row += entry
entry = nodes.inline(classes=['prodn-cell-production'])
entry += notation_to_sphinx(rhs, *position)
row += entry
entry = nodes.inline(classes=['prodn-cell-tag'])
entry += nodes.literal(tag, tag)
row += entry
tbody += row
return [indexnode, table] # only this node goes into the doc
class ExceptionObject(NotationObject):
"""An error raised by a Coq command or tactic.
This commonly appears nested in the ``.. tacn::`` that raises the
exception.
Example::
.. tacv:: assert @form by @tactic
This tactic applies :n:`@tactic` to solve the subgoals generated by
``assert``.
.. exn:: Proof is not complete
Raised if :n:`@tactic` does not fully solve the goal.
"""
subdomain = "exn"
index_suffix = "(error)"
annotation = "Error"
# Uses “exn” since “err” already is a CSS class added by “writer_aux”.
# Generate names automatically
def _name_from_signature(self, signature):
return notation_to_string(signature)
class WarningObject(NotationObject):
"""An warning raised by a Coq command or tactic..
Do not mistake this for ``.. warning::``; this directive is for warning
messages produced by Coq.
Example::
.. warn:: Ambiguous path
When the coercion :token:`qualid` is added to the inheritance graph, non
valid coercion paths are ignored.
"""
subdomain = "warn"
index_suffix = "(warning)"
annotation = "Warning"
# Generate names automatically
def _name_from_signature(self, signature):
return notation_to_string(signature)
def NotationRole(role, rawtext, text, lineno, inliner, options={}, content=[]):
#pylint: disable=unused-argument, dangerous-default-value
"""Any text using the notation syntax (``@id``, ``{+, …}``, etc.).
Use this to explain tactic equivalences. For example, you might write
this::
:n:`generalize @term as @ident` is just like :n:`generalize @term`, but
it names the introduced hypothesis :token:`ident`.
Note that this example also uses ``:token:``. That's because ``ident`` is
defined in the Coq manual as a grammar production, and ``:token:``
creates a link to that. When referring to a placeholder that happens to be
a grammar production, ``:token:`…``` is typically preferable to ``:n:`@…```.
"""
notation = utils.unescape(text, 1)
position = inliner.reporter.get_source_and_line(lineno)
return [nodes.literal(rawtext, '', notation_to_sphinx(notation, *position, rawtext=rawtext))], []
def coq_code_role(role, rawtext, text, lineno, inliner, options={}, content=[]):
#pylint: disable=dangerous-default-value
"""Coq code.
Use this for Gallina and Ltac snippets::
:g:`apply plus_comm; reflexivity`
:g:`Set Printing All.`
:g:`forall (x: t), P(x)`
"""
options['language'] = 'Coq'
return code_role(role, rawtext, text, lineno, inliner, options, content)
## Too heavy:
## Forked from code_role to use our custom tokenizer; this doesn't work for
## snippets though: for example CoqDoc swallows the parentheses around this:
## “(a: A) (b: B)”
# set_classes(options)
# classes = ['code', 'coq']
# code = utils.unescape(text, 1)
# node = nodes.literal(rawtext, '', *highlight_using_coqdoc(code), classes=classes)
# return [node], []
CoqCodeRole = coq_code_role
class CoqtopDirective(Directive):
r"""A reST directive to describe interactions with Coqtop.
Usage::
.. coqtop:: options…
Coq code to send to coqtop
Example::
.. coqtop:: in reset
Print nat.
Definition a := 1.
The blank line after the directive is required. If you begin a proof,
use the ``abort`` option to reset coqtop for the next example.
Here is a list of permissible options:
- Display options (choose exactly one)
- ``all``: Display input and output
- ``in``: Display only input
- ``out``: Display only output
- ``none``: Display neither (useful for setup commands)
- Behavior options
- ``reset``: Send a ``Reset Initial`` command before running this block
- ``fail``: Don't die if a command fails, implies ``warn`` (so no need to put both)
- ``warn``: Don't die if a command emits a warning
- ``restart``: Send a ``Restart`` command before running this block (only works in proof mode)
- ``abort``: Send an ``Abort All`` command after running this block (leaves all pending proofs if any)
``coqtop``\ 's state is preserved across consecutive ``.. coqtop::`` blocks
of the same document (``coqrst`` creates a single ``coqtop`` process per
reST source file). Use the ``reset`` option to reset Coq's state.
"""
has_content = True
required_arguments = 1
optional_arguments = 0
final_argument_whitespace = True
option_spec = { 'name': directives.unchanged }
directive_name = "coqtop"
def run(self):
# Uses a ‘container’ instead of a ‘literal_block’ to disable
# Pygments-based post-processing (we could also set rawsource to '')
content = '\n'.join(self.content)
args = self.arguments[0].split()
node = nodes.container(content, coqtop_options = set(args),
classes=['coqtop', 'literal-block'])
self.add_name(node)
return [node]
class CoqdocDirective(Directive):
"""A reST directive to display Coqtop-formatted source code.
Usage::
.. coqdoc::
Coq code to highlight
Example::
.. coqdoc::
Definition test := 1.
"""
# TODO implement this as a Pygments highlighter?
has_content = True
required_arguments = 0
optional_arguments = 0
final_argument_whitespace = True
option_spec = { 'name': directives.unchanged }
directive_name = "coqdoc"
def run(self):
# Uses a ‘container’ instead of a ‘literal_block’ to disable
# Pygments-based post-processing (we could also set rawsource to '')
content = '\n'.join(self.content)
node = nodes.inline(content, '', *highlight_using_coqdoc(content))
wrapper = nodes.container(content, node, classes=['coqdoc', 'literal-block'])
self.add_name(wrapper)
return [wrapper]
class ExampleDirective(BaseAdmonition):
"""A reST directive for examples.
This behaves like a generic admonition; see
http://docutils.sourceforge.net/docs/ref/rst/directives.html#generic-admonition
for more details.
Optionally, any text immediately following the ``.. example::`` header is
used as the example's title.
Example::
.. example:: Adding a hint to a database
The following adds ``plus_comm`` to the ``plu`` database:
.. coqdoc::
Hint Resolve plus_comm : plu.
"""
node_class = nodes.admonition
directive_name = "example"
optional_arguments = 1
def run(self):
# ‘BaseAdmonition’ checks whether ‘node_class’ is ‘nodes.admonition’,
# and uses arguments[0] as the title in that case (in other cases, the
# title is unset, and it is instead set in the HTML visitor).
assert len(self.arguments) <= 1
self.arguments = [": ".join(['Example'] + self.arguments)]
self.options['classes'] = ['admonition', 'note']
return super().run()
class PreambleDirective(Directive):
r"""A reST directive to include a TeX file.
Mostly useful to let MathJax know about `\def`\s and `\newcommand`\s. The
contents of the TeX file are wrapped in a math environment, as MathJax
doesn't process LaTeX definitions otherwise.
Usage::
.. preamble:: preamble.tex
"""
has_content = False
required_arguments = 1
optional_arguments = 0
final_argument_whitespace = True
option_spec = {}
directive_name = "preamble"
def run(self):
document = self.state.document
env = document.settings.env
if not document.settings.file_insertion_enabled:
msg = 'File insertion disabled'
return [document.reporter.warning(msg, line=self.lineno)]
rel_fname, abs_fname = env.relfn2path(self.arguments[0])
env.note_dependency(rel_fname)
with open(abs_fname, encoding="utf-8") as ltx:
latex = ltx.read()
node = make_math_node(latex, env.docname, nowrap=False)
node['classes'] = ["math-preamble"]
set_source_info(self, node)
return [node]
class InferenceDirective(Directive):
r"""A reST directive to format inference rules.
This also serves as a small illustration of the way to create new Sphinx
directives.
Usage::
.. inference:: name
newline-separated premises
--------------------------
conclusion
Example::
.. inference:: Prod-Pro
\WTEG{T}{s}
s \in \Sort
\WTE{\Gamma::(x:T)}{U}{\Prop}
-----------------------------
\WTEG{\forall~x:T,U}{\Prop}
"""
required_arguments = 1
optional_arguments = 0
has_content = True
final_argument_whitespace = True
directive_name = "inference"
@staticmethod
def prepare_latex_operand(op):
# TODO: Could use a fancier inference class in LaTeX
return '%\n\\hspace{3em}%\n'.join(op.strip().splitlines())
def prepare_latex(self, content):
parts = re.split('^ *----+ *$', content, flags=re.MULTILINE)
if len(parts) != 2:
raise self.error('Expected two parts in ‘inference’ directive, separated by a rule (----).')
top, bottom = tuple(InferenceDirective.prepare_latex_operand(p) for p in parts)
return "%\n".join(("\\frac{", top, "}{", bottom, "}"))
def run(self):
self.assert_has_content()
title = self.arguments[0]
content = '\n'.join(self.content)
latex = self.prepare_latex(content)
docname = self.state.document.settings.env.docname
math_node = make_math_node(latex, docname, nowrap=False)
tid = make_id(title)
target = nodes.target('', '', ids=['inference-' + tid])
self.state.document.note_explicit_target(target)
term, desc = nodes.term('', title), nodes.description('', math_node)
dli = nodes.definition_list_item('', term, desc)
dl = nodes.definition_list(content, target, dli)
set_source_info(self, dl)
return [dl]
class AnsiColorsParser():
"""Parse ANSI-colored output from Coqtop into Sphinx nodes."""
# Coqtop's output crashes ansi.py, because it contains a bunch of extended codes
# This class is a fork of the original ansi.py, released under a BSD license in sphinx-contribs
COLOR_PATTERN = re.compile('\x1b\\[([^m]+)m')
def __init__(self):
self.new_nodes, self.pending_nodes = [], []
def _finalize_pending_nodes(self):
self.new_nodes.extend(self.pending_nodes)
self.pending_nodes = []
def _add_text(self, raw, beg, end):
if beg < end:
text = raw[beg:end]
if self.pending_nodes:
self.pending_nodes[-1].append(nodes.Text(text))
else:
self.new_nodes.append(nodes.inline('', text))
def colorize_str(self, raw):
"""Parse raw (an ANSI-colored output string from Coqtop) into Sphinx nodes."""
last_end = 0
for match in AnsiColorsParser.COLOR_PATTERN.finditer(raw):
self._add_text(raw, last_end, match.start())
last_end = match.end()
classes = ansicolors.parse_ansi(match.group(1))
if 'ansi-reset' in classes:
self._finalize_pending_nodes()
else:
node = nodes.inline()
self.pending_nodes.append(node)
node['classes'].extend(classes)
self._add_text(raw, last_end, len(raw))
self._finalize_pending_nodes()
return self.new_nodes
class CoqtopBlocksTransform(Transform):
"""Filter handling the actual work for the coqtop directive
Adds coqtop's responses, colorizes input and output, and merges consecutive
coqtop directives for better visual rendition.
"""
default_priority = 10
@staticmethod
def is_coqtop_block(node):
return isinstance(node, nodes.Element) and 'coqtop_options' in node
@staticmethod
def split_lines(source):
r"""Split Coq input into chunks, which may include single- or
multi-line comments. Nested comments are not supported.
A chunk is a minimal sequence of consecutive lines of the input that
ends with a '.' or '*)'
>>> split_lines('A.\nB.''')
['A.', 'B.']
>>> split_lines('A.\n\nB.''')
['A.', '\nB.']
>>> split_lines('A.\n\nB.\n''')
['A.', '\nB.']
>>> split_lines("SearchPattern (_ + _ = _ + _).\n"
... "SearchPattern (nat -> bool).\n"
... "SearchPattern (forall l : list _, _ l l).")
... # doctest: +NORMALIZE_WHITESPACE
['SearchPattern (_ + _ = _ + _).',
'SearchPattern (nat -> bool).',
'SearchPattern (forall l : list _, _ l l).']
>>> split_lines('SearchHead le.\nSearchHead (@eq bool).')
['SearchHead le.', 'SearchHead (@eq bool).']
>>> split_lines("(* *) x. (* *)\ny.\n")
['(* *) x. (* *)', 'y.']
>>> split_lines("(* *) x (* \n *)\ny.\n")
['(* *) x (* \n *)', 'y.']
"""
return re.split(r"(?:(?<=(?<!\.)\.)|(?<=\*\)))\n", source.strip())
@staticmethod
def parse_options(node):
"""Parse options according to the description in CoqtopDirective."""
options = node['coqtop_options']
# Behavior options
opt_reset = 'reset' in options
opt_fail = 'fail' in options