author | wenzelm |
Mon, 04 Jun 2018 14:21:16 +0200 | |
changeset 68370 | bcdc47c9d4af |
parent 68224 | 1f7308050349 |
child 68394 | bc2fd0e2047e |
permissions | -rw-r--r-- |
61656 | 1 |
(*:maxLineLen=78:*) |
53981 | 2 |
|
53769 | 3 |
theory JEdit |
4 |
imports Base |
|
5 |
begin |
|
6 |
||
58618 | 7 |
chapter \<open>Introduction\<close> |
53769 | 8 |
|
58618 | 9 |
section \<open>Concepts and terminology\<close> |
53770
db362319d766
added/updated material from src/Tools/jEdit/README.html;
wenzelm
parents:
53769
diff
changeset
|
10 |
|
58618 | 11 |
text \<open> |
61574 | 12 |
Isabelle/jEdit is a Prover IDE that integrates \<^emph>\<open>parallel proof checking\<close> |
13 |
@{cite "Wenzel:2009" and "Wenzel:2013:ITP"} with \<^emph>\<open>asynchronous user |
|
14 |
interaction\<close> @{cite "Wenzel:2010" and "Wenzel:2012:UITP-EPTCS" and |
|
15 |
"Wenzel:2014:ITP-PIDE" and "Wenzel:2014:UITP"}, based on a document-oriented |
|
16 |
approach to \<^emph>\<open>continuous proof processing\<close> @{cite "Wenzel:2011:CICM" and |
|
17 |
"Wenzel:2012"}. Many concepts and system components are fit together in |
|
18 |
order to make this work. The main building blocks are as follows. |
|
53769 | 19 |
|
61574 | 20 |
\<^descr>[Isabelle/ML] is the implementation and extension language of Isabelle, |
21 |
see also @{cite "isabelle-implementation"}. It is integrated into the |
|
22 |
logical context of Isabelle/Isar and allows to manipulate logical entities |
|
23 |
directly. Arbitrary add-on tools may be implemented for object-logics such |
|
24 |
as Isabelle/HOL. |
|
53770
db362319d766
added/updated material from src/Tools/jEdit/README.html;
wenzelm
parents:
53769
diff
changeset
|
25 |
|
61574 | 26 |
\<^descr>[Isabelle/Scala] is the system programming language of Isabelle. It |
62183 | 27 |
extends the pure logical environment of Isabelle/ML towards the outer |
28 |
world of graphical user interfaces, text editors, IDE frameworks, web |
|
66683 | 29 |
services, SSH servers, SQL databases etc. Special infrastructure allows to |
30 |
transfer algebraic datatypes and formatted text easily between ML and |
|
31 |
Scala, using asynchronous protocol commands. |
|
54321 | 32 |
|
62183 | 33 |
\<^descr>[PIDE] is a general framework for Prover IDEs based on Isabelle/Scala. It |
34 |
is built around a concept of parallel and asynchronous document |
|
35 |
processing, which is supported natively by the parallel proof engine that |
|
36 |
is implemented in Isabelle/ML. The traditional prover command loop is |
|
37 |
given up; instead there is direct support for editing of source text, with |
|
38 |
rich formal markup for GUI rendering. |
|
39 |
||
63680 | 40 |
\<^descr>[jEdit] is a sophisticated text editor\<^footnote>\<open>\<^url>\<open>http://www.jedit.org\<close>\<close> |
68224 | 41 |
implemented in Java\<^footnote>\<open>\<^url>\<open>https://www.java.com\<close>\<close>. It is easily extensible by |
63680 | 42 |
plugins written in any language that works on the JVM. In the context of |
68224 | 43 |
Isabelle this is always Scala\<^footnote>\<open>\<^url>\<open>https://www.scala-lang.org\<close>\<close>. |
53770
db362319d766
added/updated material from src/Tools/jEdit/README.html;
wenzelm
parents:
53769
diff
changeset
|
44 |
|
62183 | 45 |
\<^descr>[Isabelle/jEdit] is the main application of the PIDE framework and the |
46 |
default user-interface for Isabelle. It targets both beginners and |
|
47 |
experts. Technically, Isabelle/jEdit consists of the original jEdit code |
|
48 |
base with minimal patches and a special plugin for Isabelle. This is |
|
49 |
integrated as a desktop application for the main operating system |
|
50 |
families: Linux, Windows, Mac OS X. |
|
53770
db362319d766
added/updated material from src/Tools/jEdit/README.html;
wenzelm
parents:
53769
diff
changeset
|
51 |
|
62183 | 52 |
End-users of Isabelle download and run a standalone application that exposes |
53 |
jEdit as a text editor on the surface. Thus there is occasionally a tendency |
|
54 |
to apply the name ``jEdit'' to any of the Isabelle Prover IDE aspects, |
|
55 |
without proper differentiation. When discussing these PIDE building blocks |
|
56 |
in public forums, mailing lists, or even scientific publications, it is |
|
57 |
particularly important to distinguish Isabelle/ML versus Standard ML, |
|
58 |
Isabelle/Scala versus Scala, Isabelle/jEdit versus jEdit. |
|
58618 | 59 |
\<close> |
53770
db362319d766
added/updated material from src/Tools/jEdit/README.html;
wenzelm
parents:
53769
diff
changeset
|
60 |
|
db362319d766
added/updated material from src/Tools/jEdit/README.html;
wenzelm
parents:
53769
diff
changeset
|
61 |
|
58618 | 62 |
section \<open>The Isabelle/jEdit Prover IDE\<close> |
53770
db362319d766
added/updated material from src/Tools/jEdit/README.html;
wenzelm
parents:
53769
diff
changeset
|
63 |
|
58618 | 64 |
text \<open> |
62183 | 65 |
\begin{figure}[!htb] |
54331 | 66 |
\begin{center} |
57312 | 67 |
\includegraphics[scale=0.333]{isabelle-jedit} |
54331 | 68 |
\end{center} |
69 |
\caption{The Isabelle/jEdit Prover IDE} |
|
54357 | 70 |
\label{fig:isabelle-jedit} |
54331 | 71 |
\end{figure} |
53773 | 72 |
|
57337 | 73 |
Isabelle/jEdit (\figref{fig:isabelle-jedit}) consists of some plugins for |
74 |
the jEdit text editor, while preserving its general look-and-feel as far as |
|
75 |
possible. The main plugin is called ``Isabelle'' and has its own menu |
|
68067 | 76 |
\<^emph>\<open>Plugins~/ Isabelle\<close> with access to several actions and add-on panels (see |
77 |
also \secref{sec:dockables}), as well as \<^emph>\<open>Plugins~/ Plugin Options~/ |
|
78 |
Isabelle\<close> (see also \secref{sec:options}). |
|
53770
db362319d766
added/updated material from src/Tools/jEdit/README.html;
wenzelm
parents:
53769
diff
changeset
|
79 |
|
62183 | 80 |
The options allow to specify a logic session name, but the same selector is |
81 |
also accessible in the \<^emph>\<open>Theories\<close> panel (\secref{sec:theories}). After |
|
66683 | 82 |
startup of the Isabelle plugin, the selected logic session image is provided |
62183 | 83 |
automatically by the Isabelle build tool @{cite "isabelle-system"}: if it is |
66683 | 84 |
absent or outdated wrt.\ its sources, the build process updates it within |
85 |
the running text editor. Prover IDE functionality is fully activated after |
|
62183 | 86 |
successful termination of the build process. A failure may require changing |
66683 | 87 |
some options and restart of the Isabelle plugin or application. Changing the |
88 |
logic session, or the underlying ML system platform (32\,bit versus 64\,bit) |
|
89 |
requires a restart of the whole application to take effect. |
|
53769 | 90 |
|
61415 | 91 |
\<^medskip> |
61574 | 92 |
The main job of the Prover IDE is to manage sources and their changes, |
93 |
taking the logical structure as a formal document into account (see also |
|
94 |
\secref{sec:document-model}). The editor and the prover are connected |
|
57337 | 95 |
asynchronously in a lock-free manner. The prover is free to organize the |
96 |
checking of the formal text in parallel on multiple cores, and provides |
|
97 |
feedback via markup, which is rendered in the editor via colors, boxes, |
|
57420 | 98 |
squiggly underlines, hyperlinks, popup windows, icons, clickable output etc. |
53770
db362319d766
added/updated material from src/Tools/jEdit/README.html;
wenzelm
parents:
53769
diff
changeset
|
99 |
|
61574 | 100 |
Using the mouse together with the modifier key \<^verbatim>\<open>CONTROL\<close> (Linux, Windows) |
62183 | 101 |
or \<^verbatim>\<open>COMMAND\<close> (Mac OS X) exposes formal content via tooltips and/or |
102 |
hyperlinks (see also \secref{sec:tooltips-hyperlinks}). Output (in popups |
|
103 |
etc.) may be explored recursively, using the same techniques as in the |
|
104 |
editor source buffer. |
|
53770
db362319d766
added/updated material from src/Tools/jEdit/README.html;
wenzelm
parents:
53769
diff
changeset
|
105 |
|
57337 | 106 |
Thus the Prover IDE gives an impression of direct access to formal content |
107 |
of the prover within the editor, but in reality only certain aspects are |
|
62183 | 108 |
exposed, according to the possibilities of the prover and its add-on tools. |
58618 | 109 |
\<close> |
53769 | 110 |
|
53770
db362319d766
added/updated material from src/Tools/jEdit/README.html;
wenzelm
parents:
53769
diff
changeset
|
111 |
|
58618 | 112 |
subsection \<open>Documentation\<close> |
54321 | 113 |
|
58618 | 114 |
text \<open> |
62183 | 115 |
The \<^emph>\<open>Documentation\<close> panel of Isabelle/jEdit provides access to some example |
116 |
theory files and the standard Isabelle documentation. PDF files are opened |
|
117 |
by regular desktop operations of the underlying platform. The section |
|
118 |
``Original jEdit Documentation'' contains the original \<^emph>\<open>User's Guide\<close> of |
|
119 |
this sophisticated text editor. The same is accessible via the \<^verbatim>\<open>Help\<close> menu |
|
120 |
or \<^verbatim>\<open>F1\<close> keyboard shortcut, using the built-in HTML viewer of Java/Swing. |
|
121 |
The latter also includes \<^emph>\<open>Frequently Asked Questions\<close> and documentation of |
|
122 |
individual plugins. |
|
54321 | 123 |
|
62183 | 124 |
Most of the information about jEdit is relevant for Isabelle/jEdit as well, |
66683 | 125 |
but users need to keep in mind that defaults sometimes differ, and the |
62183 | 126 |
official jEdit documentation does not know about the Isabelle plugin with |
127 |
its support for continuous checking of formal source text: jEdit is a plain |
|
128 |
text editor, but Isabelle/jEdit is a Prover IDE. |
|
58618 | 129 |
\<close> |
54321 | 130 |
|
131 |
||
58618 | 132 |
subsection \<open>Plugins\<close> |
54321 | 133 |
|
58618 | 134 |
text \<open> |
61574 | 135 |
The \<^emph>\<open>Plugin Manager\<close> of jEdit allows to augment editor functionality by JVM |
136 |
modules (jars) that are provided by the central plugin repository, which is |
|
137 |
accessible via various mirror sites. |
|
54321 | 138 |
|
57420 | 139 |
Connecting to the plugin server-infrastructure of the jEdit project allows |
140 |
to update bundled plugins or to add further functionality. This needs to be |
|
141 |
done with the usual care for such an open bazaar of contributions. Arbitrary |
|
142 |
combinations of add-on features are apt to cause problems. It is advisable |
|
143 |
to start with the default configuration of Isabelle/jEdit and develop some |
|
64513 | 144 |
sense how it is meant to work, before loading too many other plugins. |
54321 | 145 |
|
61415 | 146 |
\<^medskip> |
66683 | 147 |
The \<^emph>\<open>Isabelle\<close> plugin is responsible for the main Prover IDE functionality |
148 |
of Isabelle/jEdit: it manages the prover session in the background. A few |
|
66462 | 149 |
additional plugins are bundled with Isabelle/jEdit for convenience or out of |
66683 | 150 |
necessity, notably \<^emph>\<open>Console\<close> with its \<^emph>\<open>Scala\<close> sub-plugin |
66462 | 151 |
(\secref{sec:scala-console}) and \<^emph>\<open>SideKick\<close> with some Isabelle-specific |
152 |
parsers for document tree structure (\secref{sec:sidekick}). The |
|
153 |
\<^emph>\<open>Navigator\<close> plugin is particularly important for hyperlinks within the |
|
154 |
formal document-model (\secref{sec:tooltips-hyperlinks}). Further plugins |
|
155 |
(e.g.\ \<^emph>\<open>ErrorList\<close>, \<^emph>\<open>Code2HTML\<close>) are included to saturate the dependencies |
|
66683 | 156 |
of bundled plugins, but have no particular use in Isabelle/jEdit. |
157 |
\<close> |
|
54321 | 158 |
|
159 |
||
58618 | 160 |
subsection \<open>Options \label{sec:options}\<close> |
54321 | 161 |
|
61574 | 162 |
text \<open> |
163 |
Both jEdit and Isabelle have distinctive management of persistent options. |
|
54321 | 164 |
|
61574 | 165 |
Regular jEdit options are accessible via the dialogs \<^emph>\<open>Utilities~/ Global |
166 |
Options\<close> or \<^emph>\<open>Plugins~/ Plugin Options\<close>, with a second chance to flip the |
|
63669 | 167 |
two within the central options dialog. Changes are stored in @{path |
63749 | 168 |
"$JEDIT_SETTINGS/properties"} and @{path "$JEDIT_SETTINGS/keymaps"}. |
57310 | 169 |
|
170 |
Isabelle system options are managed by Isabelle/Scala and changes are stored |
|
63669 | 171 |
in @{path "$ISABELLE_HOME_USER/etc/preferences"}, independently of |
60270 | 172 |
other jEdit properties. See also @{cite "isabelle-system"}, especially the |
57310 | 173 |
coverage of sessions and command-line tools like @{tool build} or @{tool |
54372 | 174 |
options}. |
54321 | 175 |
|
62183 | 176 |
Those Isabelle options that are declared as \<^verbatim>\<open>public\<close> are configurable in |
61574 | 177 |
Isabelle/jEdit via \<^emph>\<open>Plugin Options~/ Isabelle~/ General\<close>. Moreover, there |
66683 | 178 |
are various options for rendering document content, which are configurable |
179 |
via \<^emph>\<open>Plugin Options~/ Isabelle~/ Rendering\<close>. Thus \<^emph>\<open>Plugin Options~/ |
|
180 |
Isabelle\<close> in jEdit provides a view on a subset of Isabelle system options. |
|
181 |
Note that some of these options affect general parameters that are relevant |
|
182 |
outside Isabelle/jEdit as well, e.g.\ @{system_option threads} or |
|
61574 | 183 |
@{system_option parallel_proofs} for the Isabelle build tool @{cite |
184 |
"isabelle-system"}, but it is possible to use the settings variable |
|
185 |
@{setting ISABELLE_BUILD_OPTIONS} to change defaults for batch builds |
|
62183 | 186 |
without affecting the Prover IDE. |
54329 | 187 |
|
57627
65fc7ae1bf66
added action "isabelle.options" (despite problems with initial window size);
wenzelm
parents:
57603
diff
changeset
|
188 |
The jEdit action @{action_def isabelle.options} opens the options dialog for |
65fc7ae1bf66
added action "isabelle.options" (despite problems with initial window size);
wenzelm
parents:
57603
diff
changeset
|
189 |
the Isabelle plugin; it can be mapped to editor GUI elements as usual. |
65fc7ae1bf66
added action "isabelle.options" (despite problems with initial window size);
wenzelm
parents:
57603
diff
changeset
|
190 |
|
61415 | 191 |
\<^medskip> |
192 |
Options are usually loaded on startup and saved on shutdown of |
|
66683 | 193 |
Isabelle/jEdit. Editing the generated @{path "$JEDIT_SETTINGS/properties"} |
194 |
or @{path "$ISABELLE_HOME_USER/etc/preferences"} manually while the |
|
195 |
application is running may cause surprise due to lost updates! |
|
61574 | 196 |
\<close> |
54321 | 197 |
|
198 |
||
58618 | 199 |
subsection \<open>Keymaps\<close> |
54321 | 200 |
|
61574 | 201 |
text \<open> |
62183 | 202 |
Keyboard shortcuts are managed as a separate concept of \<^emph>\<open>keymap\<close> that is |
61574 | 203 |
configurable via \<^emph>\<open>Global Options~/ Shortcuts\<close>. The \<^verbatim>\<open>imported\<close> keymap is |
204 |
derived from the initial environment of properties that is available at the |
|
62183 | 205 |
first start of the editor; afterwards the keymap file takes precedence and |
206 |
is no longer affected by change of default properties. |
|
54321 | 207 |
|
66683 | 208 |
Users may change their keymap later, but this may lead to conflicts with |
209 |
\<^verbatim>\<open>shortcut\<close> properties in \<^file>\<open>$JEDIT_HOME/src/jEdit.props\<close>. |
|
64513 | 210 |
|
211 |
The action @{action_def "isabelle.keymap-merge"} helps to resolve pending |
|
212 |
Isabelle keymap changes that are in conflict with the current jEdit keymap; |
|
66683 | 213 |
while non-conflicting changes are applied implicitly. This action is |
64513 | 214 |
automatically invoked on Isabelle/jEdit startup. |
58618 | 215 |
\<close> |
54321 | 216 |
|
217 |
||
58618 | 218 |
section \<open>Command-line invocation \label{sec:command-line}\<close> |
57320
00f2c8d1aa0b
more on command-line invocation -- moved material from system manual;
wenzelm
parents:
57319
diff
changeset
|
219 |
|
58618 | 220 |
text \<open> |
62183 | 221 |
Isabelle/jEdit is normally invoked as a single-instance desktop application, |
222 |
based on platform-specific executables for Linux, Windows, Mac OS X. |
|
62014 | 223 |
|
62183 | 224 |
It is also possible to invoke the Prover IDE on the command-line, with some |
225 |
extra options and environment settings. The command-line usage of @{tool_def |
|
226 |
jedit} is as follows: |
|
61408
9020a3ba6c9a
@{verbatim [display]} supersedes old alltt/ttbox;
wenzelm
parents:
61199
diff
changeset
|
227 |
@{verbatim [display] |
9020a3ba6c9a
@{verbatim [display]} supersedes old alltt/ttbox;
wenzelm
parents:
61199
diff
changeset
|
228 |
\<open>Usage: isabelle jedit [OPTIONS] [FILES ...] |
57320
00f2c8d1aa0b
more on command-line invocation -- moved material from system manual;
wenzelm
parents:
57319
diff
changeset
|
229 |
|
00f2c8d1aa0b
more on command-line invocation -- moved material from system manual;
wenzelm
parents:
57319
diff
changeset
|
230 |
Options are: |
68370 | 231 |
-A NAME ancestor session for options -R and -S (default: parent) |
62039 | 232 |
-D NAME=X set JVM system property |
61132 | 233 |
-J OPTION add JVM runtime option |
66683 | 234 |
(default $JEDIT_JAVA_SYSTEM_OPTIONS $JEDIT_JAVA_OPTIONS) |
68370 | 235 |
-R NAME build image with requirements from other sessions |
236 |
-S NAME like option -R, with focus on selected session |
|
57320
00f2c8d1aa0b
more on command-line invocation -- moved material from system manual;
wenzelm
parents:
57319
diff
changeset
|
237 |
-b build only |
00f2c8d1aa0b
more on command-line invocation -- moved material from system manual;
wenzelm
parents:
57319
diff
changeset
|
238 |
-d DIR include session directory |
00f2c8d1aa0b
more on command-line invocation -- moved material from system manual;
wenzelm
parents:
57319
diff
changeset
|
239 |
-f fresh build |
61132 | 240 |
-j OPTION add jEdit runtime option |
66683 | 241 |
(default $JEDIT_OPTIONS) |
61132 | 242 |
-l NAME logic image name |
57320
00f2c8d1aa0b
more on command-line invocation -- moved material from system manual;
wenzelm
parents:
57319
diff
changeset
|
243 |
-m MODE add print mode for output |
00f2c8d1aa0b
more on command-line invocation -- moved material from system manual;
wenzelm
parents:
57319
diff
changeset
|
244 |
-n no build of session image on startup |
63987
ac96fe9224f6
just one option is enough -- "isabelle jedit" java process may be prefixed directly in the shell;
wenzelm
parents:
63871
diff
changeset
|
245 |
-p CMD ML process command prefix (process policy) |
57320
00f2c8d1aa0b
more on command-line invocation -- moved material from system manual;
wenzelm
parents:
57319
diff
changeset
|
246 |
-s system build mode for session image |
00f2c8d1aa0b
more on command-line invocation -- moved material from system manual;
wenzelm
parents:
57319
diff
changeset
|
247 |
|
61512
933463440449
more uniform command-line for "isabelle jedit" and the isabelle.Main app wrapper;
wenzelm
parents:
61506
diff
changeset
|
248 |
Start jEdit with Isabelle plugin setup and open FILES |
933463440449
more uniform command-line for "isabelle jedit" and the isabelle.Main app wrapper;
wenzelm
parents:
61506
diff
changeset
|
249 |
(default "$USER_HOME/Scratch.thy" or ":" for empty buffer).\<close>} |
57320
00f2c8d1aa0b
more on command-line invocation -- moved material from system manual;
wenzelm
parents:
57319
diff
changeset
|
250 |
|
61574 | 251 |
The \<^verbatim>\<open>-l\<close> option specifies the session name of the logic image to be used |
252 |
for proof processing. Additional session root directories may be included |
|
66683 | 253 |
via option \<^verbatim>\<open>-d\<close> to augment the session name space (see also @{cite |
254 |
"isabelle-system"}). |
|
57320
00f2c8d1aa0b
more on command-line invocation -- moved material from system manual;
wenzelm
parents:
57319
diff
changeset
|
255 |
|
61574 | 256 |
By default, the specified image is checked and built on demand. The \<^verbatim>\<open>-s\<close> |
257 |
option determines where to store the result session image of @{tool build}. |
|
258 |
The \<^verbatim>\<open>-n\<close> option bypasses the implicit build process for the selected |
|
259 |
session image. |
|
57320
00f2c8d1aa0b
more on command-line invocation -- moved material from system manual;
wenzelm
parents:
57319
diff
changeset
|
260 |
|
68370 | 261 |
Option \<^verbatim>\<open>-R\<close> builds an auxiliary logic image with all required theories from |
262 |
\<^emph>\<open>other\<close> sessions, relative to an ancestor session given by option \<^verbatim>\<open>-A\<close> |
|
263 |
(default: parent session). Option \<^verbatim>\<open>-R\<close> also opens the session \<^verbatim>\<open>ROOT\<close> entry |
|
264 |
in the editor, to facilitate editing of the main session. |
|
64602 | 265 |
|
68370 | 266 |
Option \<^verbatim>\<open>-S\<close> is like \<^verbatim>\<open>-R\<close>, with a focus on the selected session and its |
267 |
descendants: the namespace of accessible theories is restricted accordingly. |
|
268 |
This reduces startup time for big projects, notably the ``Archive of Formal |
|
269 |
Proofs''. |
|
66987
352b23c97ac8
support focus_session, for much faster startup of Isabelle/jEdit;
wenzelm
parents:
66977
diff
changeset
|
270 |
|
61574 | 271 |
The \<^verbatim>\<open>-m\<close> option specifies additional print modes for the prover process. |
272 |
Note that the system option @{system_option_ref jedit_print_mode} allows to |
|
273 |
do the same persistently (e.g.\ via the \<^emph>\<open>Plugin Options\<close> dialog of |
|
274 |
Isabelle/jEdit), without requiring command-line invocation. |
|
57320
00f2c8d1aa0b
more on command-line invocation -- moved material from system manual;
wenzelm
parents:
57319
diff
changeset
|
275 |
|
66683 | 276 |
The \<^verbatim>\<open>-J\<close> and \<^verbatim>\<open>-j\<close> options pass additional low-level options to the JVM or |
277 |
jEdit, respectively. The defaults are provided by the Isabelle settings |
|
278 |
environment @{cite "isabelle-system"}, but note that these only work for the |
|
279 |
command-line tool described here, and not the regular application. |
|
57320
00f2c8d1aa0b
more on command-line invocation -- moved material from system manual;
wenzelm
parents:
57319
diff
changeset
|
280 |
|
62039 | 281 |
The \<^verbatim>\<open>-D\<close> option allows to define JVM system properties; this is passed |
282 |
directly to the underlying \<^verbatim>\<open>java\<close> process. |
|
283 |
||
61574 | 284 |
The \<^verbatim>\<open>-b\<close> and \<^verbatim>\<open>-f\<close> options control the self-build mechanism of |
285 |
Isabelle/jEdit. This is only relevant for building from sources, which also |
|
63680 | 286 |
requires an auxiliary \<^verbatim>\<open>jedit_build\<close> component from |
68224 | 287 |
\<^url>\<open>https://isabelle.in.tum.de/components\<close>. The official Isabelle release |
62014 | 288 |
already includes a pre-built version of Isabelle/jEdit. |
289 |
||
62183 | 290 |
\<^bigskip> |
62014 | 291 |
It is also possible to connect to an already running Isabelle/jEdit process |
292 |
via @{tool_def jedit_client}: |
|
293 |
@{verbatim [display] |
|
294 |
\<open>Usage: isabelle jedit_client [OPTIONS] [FILES ...] |
|
295 |
||
296 |
Options are: |
|
297 |
-c only check presence of server |
|
298 |
-n only report server name |
|
299 |
-s NAME server name (default Isabelle) |
|
300 |
||
301 |
Connect to already running Isabelle/jEdit instance and open FILES\<close>} |
|
302 |
||
303 |
The \<^verbatim>\<open>-c\<close> option merely checks the presence of the server, producing a |
|
62183 | 304 |
process return code accordingly. |
62014 | 305 |
|
306 |
The \<^verbatim>\<open>-n\<close> option reports the server name, and the \<^verbatim>\<open>-s\<close> option provides a |
|
307 |
different server name. The default server name is the official distribution |
|
66683 | 308 |
name (e.g.\ \<^verbatim>\<open>Isabelle2017\<close>). Thus @{tool jedit_client} can connect to the |
62183 | 309 |
Isabelle desktop application without further options. |
62014 | 310 |
|
63987
ac96fe9224f6
just one option is enough -- "isabelle jedit" java process may be prefixed directly in the shell;
wenzelm
parents:
63871
diff
changeset
|
311 |
The \<^verbatim>\<open>-p\<close> option allows to override the implicit default of the system |
ac96fe9224f6
just one option is enough -- "isabelle jedit" java process may be prefixed directly in the shell;
wenzelm
parents:
63871
diff
changeset
|
312 |
option @{system_option_ref ML_process_policy} for ML processes started by |
ac96fe9224f6
just one option is enough -- "isabelle jedit" java process may be prefixed directly in the shell;
wenzelm
parents:
63871
diff
changeset
|
313 |
the Prover IDE, e.g. to control CPU affinity on multiprocessor systems. |
ac96fe9224f6
just one option is enough -- "isabelle jedit" java process may be prefixed directly in the shell;
wenzelm
parents:
63871
diff
changeset
|
314 |
|
62036 | 315 |
The JVM system property \<^verbatim>\<open>isabelle.jedit_server\<close> provides a different server |
62183 | 316 |
name, e.g.\ use \<^verbatim>\<open>isabelle jedit -Disabelle.jedit_server=\<close>\<open>name\<close> and |
62036 | 317 |
\<^verbatim>\<open>isabelle jedit_client -s\<close>~\<open>name\<close> to connect later on. |
62014 | 318 |
\<close> |
57320
00f2c8d1aa0b
more on command-line invocation -- moved material from system manual;
wenzelm
parents:
57319
diff
changeset
|
319 |
|
00f2c8d1aa0b
more on command-line invocation -- moved material from system manual;
wenzelm
parents:
57319
diff
changeset
|
320 |
|
60291 | 321 |
section \<open>GUI rendering\<close> |
322 |
||
323 |
subsection \<open>Look-and-feel \label{sec:look-and-feel}\<close> |
|
54321 | 324 |
|
60291 | 325 |
text \<open> |
66683 | 326 |
jEdit is a Java/AWT/Swing application with the ambition to support |
60291 | 327 |
``native'' look-and-feel on all platforms, within the limits of what Oracle |
328 |
as Java provider and major operating system distributors allow (see also |
|
329 |
\secref{sec:problems}). |
|
54321 | 330 |
|
54329 | 331 |
Isabelle/jEdit enables platform-specific look-and-feel by default as |
57420 | 332 |
follows. |
54321 | 333 |
|
61574 | 334 |
\<^descr>[Linux:] The platform-independent \<^emph>\<open>Metal\<close> is used by default. |
54321 | 335 |
|
66683 | 336 |
The Linux-specific \<^emph>\<open>GTK+\<close> often works as well, but the overall GTK theme |
337 |
and options need to be selected to suite Java/AWT/Swing. Note that Java |
|
338 |
Virtual Machine has no direct influence of GTK rendering. |
|
54321 | 339 |
|
62183 | 340 |
\<^descr>[Windows:] Regular \<^emph>\<open>Windows\<close> is used by default. |
54372 | 341 |
|
61574 | 342 |
\<^descr>[Mac OS X:] Regular \<^emph>\<open>Mac OS X\<close> is used by default. |
54321 | 343 |
|
61574 | 344 |
The bundled \<^emph>\<open>MacOSX\<close> plugin provides various functions that are expected |
345 |
from applications on that particular platform: quit from menu or dock, |
|
346 |
preferences menu, drag-and-drop of text files on the application, |
|
347 |
full-screen mode for main editor windows. It is advisable to have the |
|
348 |
\<^emph>\<open>MacOSX\<close> plugin enabled all the time on that platform. |
|
54321 | 349 |
|
62183 | 350 |
Users may experiment with different Swing look-and-feels, but need to keep |
66683 | 351 |
in mind that this extra variance of GUI functionality often causes problems. |
352 |
The platform-independent \<^emph>\<open>Metal\<close> and \<^emph>\<open>Nimbus\<close> should always work on all |
|
353 |
platforms, although they are technically and stylistically outdated. The |
|
354 |
historic \<^emph>\<open>CDE/Motif\<close> should be ignored. |
|
54372 | 355 |
|
66683 | 356 |
Changing the look-and-feel in \<^emph>\<open>Global Options~/ Appearance\<close> may update the |
357 |
GUI only partially: proper restart of Isabelle/jEdit is usually required. |
|
60291 | 358 |
\<close> |
359 |
||
360 |
||
361 |
subsection \<open>Displays with very high resolution \label{sec:hdpi}\<close> |
|
362 |
||
363 |
text \<open> |
|
62183 | 364 |
In distant past, displays with $1024 \times 768$ or $1280 \times 1024$ |
365 |
pixels were considered ``high resolution'' and bitmap fonts with 12 or 14 |
|
66683 | 366 |
pixels as adequate for text rendering. In 2017, we routinely see much higher |
62183 | 367 |
resolutions, e.g. ``Full HD'' at $1920 \times 1080$ pixels or ``Ultra HD'' / |
368 |
``4K'' at $3840 \times 2160$. |
|
60291 | 369 |
|
62183 | 370 |
GUI frameworks are usually lagging behind, with hard-wired icon sizes and |
371 |
tiny fonts. Java and jEdit do provide reasonable support for very high |
|
372 |
resolution, but this requires manual adjustments as described below. |
|
60291 | 373 |
|
61415 | 374 |
\<^medskip> |
62183 | 375 |
The \<^bold>\<open>operating-system\<close> usually provides some configuration for global |
376 |
scaling of text fonts, e.g.\ $120\%$--$250\%$ on Windows. This impacts |
|
377 |
regular GUI elements, when used with native look-and-feel: Linux \<^emph>\<open>GTK+\<close>, |
|
378 |
\<^emph>\<open>Windows\<close>, \<^emph>\<open>Mac OS X\<close>, respectively. Alternatively, it is possible to use |
|
379 |
the platform-independent \<^emph>\<open>Metal\<close> look-and-feel and readjust its main font |
|
380 |
sizes via jEdit options explained below. The Isabelle/jEdit \<^bold>\<open>application\<close> |
|
381 |
provides further options to adjust font sizes in particular GUI elements. |
|
382 |
Here is a summary of all relevant font properties: |
|
60291 | 383 |
|
61574 | 384 |
\<^item> \<^emph>\<open>Global Options / Text Area / Text font\<close>: the main text area font, |
385 |
which is also used as reference point for various derived font sizes, |
|
62185 | 386 |
e.g.\ the \<^emph>\<open>Output\<close> (\secref{sec:output}) and \<^emph>\<open>State\<close> |
62183 | 387 |
(\secref{sec:state-output}) panels. |
60291 | 388 |
|
61574 | 389 |
\<^item> \<^emph>\<open>Global Options / Gutter / Gutter font\<close>: the font for the gutter area |
390 |
left of the main text area, e.g.\ relevant for display of line numbers |
|
391 |
(disabled by default). |
|
60291 | 392 |
|
61574 | 393 |
\<^item> \<^emph>\<open>Global Options / Appearance / Button, menu and label font\<close> as well as |
394 |
\<^emph>\<open>List and text field font\<close>: this specifies the primary and secondary font |
|
62183 | 395 |
for the \<^emph>\<open>Metal\<close> look-and-feel (\secref{sec:look-and-feel}). |
60291 | 396 |
|
61574 | 397 |
\<^item> \<^emph>\<open>Plugin Options / Isabelle / General / Reset Font Size\<close>: the main text |
398 |
area font size for action @{action_ref "isabelle.reset-font-size"}, e.g.\ |
|
62183 | 399 |
relevant for quick scaling like in common web browsers. |
60291 | 400 |
|
61574 | 401 |
\<^item> \<^emph>\<open>Plugin Options / Console / General / Font\<close>: the console window font, |
402 |
e.g.\ relevant for Isabelle/Scala command-line. |
|
60291 | 403 |
|
61574 | 404 |
In \figref{fig:isabelle-jedit-hdpi} the \<^emph>\<open>Metal\<close> look-and-feel is configured |
405 |
with custom fonts at 30 pixels, and the main text area and console at 36 |
|
62183 | 406 |
pixels. This leads to decent rendering quality, despite the old-fashioned |
407 |
appearance of \<^emph>\<open>Metal\<close>. |
|
60291 | 408 |
|
62183 | 409 |
\begin{figure}[!htb] |
60291 | 410 |
\begin{center} |
411 |
\includegraphics[width=\textwidth]{isabelle-jedit-hdpi} |
|
412 |
\end{center} |
|
413 |
\caption{Metal look-and-feel with custom fonts for very high resolution} |
|
414 |
\label{fig:isabelle-jedit-hdpi} |
|
415 |
\end{figure} |
|
416 |
\<close> |
|
54321 | 417 |
|
418 |
||
62183 | 419 |
chapter \<open>Augmented jEdit functionality\<close> |
420 |
||
58618 | 421 |
section \<open>Dockable windows \label{sec:dockables}\<close> |
57316 | 422 |
|
58618 | 423 |
text \<open> |
61574 | 424 |
In jEdit terminology, a \<^emph>\<open>view\<close> is an editor window with one or more \<^emph>\<open>text |
425 |
areas\<close> that show the content of one or more \<^emph>\<open>buffers\<close>. A regular view may |
|
426 |
be surrounded by \<^emph>\<open>dockable windows\<close> that show additional information in |
|
427 |
arbitrary format, not just text; a \<^emph>\<open>plain view\<close> does not allow dockables. |
|
428 |
The \<^emph>\<open>dockable window manager\<close> of jEdit organizes these dockable windows, |
|
429 |
either as \<^emph>\<open>floating\<close> windows, or \<^emph>\<open>docked\<close> panels within one of the four |
|
430 |
margins of the view. There may be any number of floating instances of some |
|
431 |
dockable window, but at most one docked instance; jEdit actions that address |
|
432 |
\<^emph>\<open>the\<close> dockable window of a particular kind refer to the unique docked |
|
433 |
instance. |
|
57316 | 434 |
|
435 |
Dockables are used routinely in jEdit for important functionality like |
|
61574 | 436 |
\<^emph>\<open>HyperSearch Results\<close> or the \<^emph>\<open>File System Browser\<close>. Plugins often provide |
62184 | 437 |
a central dockable to access their main functionality, which may be opened |
438 |
by the user on demand. The Isabelle/jEdit plugin takes this approach to the |
|
61574 | 439 |
extreme: its plugin menu provides the entry-points to many panels that are |
440 |
managed as dockable windows. Some important panels are docked by default, |
|
62184 | 441 |
e.g.\ \<^emph>\<open>Documentation\<close>, \<^emph>\<open>State\<close>, \<^emph>\<open>Theories\<close> \<^emph>\<open>Output\<close>, \<^emph>\<open>Query\<close>. The user |
442 |
can change this arrangement easily and persistently. |
|
57316 | 443 |
|
444 |
Compared to plain jEdit, dockable window management in Isabelle/jEdit is |
|
445 |
slightly augmented according to the the following principles: |
|
446 |
||
61477 | 447 |
\<^item> Floating windows are dependent on the main window as \<^emph>\<open>dialog\<close> in |
57316 | 448 |
the sense of Java/AWT/Swing. Dialog windows always stay on top of the view, |
449 |
which is particularly important in full-screen mode. The desktop environment |
|
450 |
of the underlying platform may impose further policies on such dependent |
|
451 |
dialogs, in contrast to fully independent windows, e.g.\ some window |
|
452 |
management functions may be missing. |
|
453 |
||
61415 | 454 |
\<^item> Keyboard focus of the main view vs.\ a dockable window is carefully |
57316 | 455 |
managed according to the intended semantics, as a panel mainly for output or |
62184 | 456 |
input. For example, activating the \<^emph>\<open>Output\<close> (\secref{sec:output}) or State |
457 |
(\secref{sec:state-output}) panel via the dockable window manager returns |
|
458 |
keyboard focus to the main text area, but for \<^emph>\<open>Query\<close> (\secref{sec:query}) |
|
459 |
or \<^emph>\<open>Sledgehammer\<close> \secref{sec:sledgehammer} the focus is given to the main |
|
460 |
input field of that panel. |
|
57316 | 461 |
|
61415 | 462 |
\<^item> Panels that provide their own text area for output have an additional |
61477 | 463 |
dockable menu item \<^emph>\<open>Detach\<close>. This produces an independent copy of the |
464 |
current output as a floating \<^emph>\<open>Info\<close> window, which displays that content |
|
57316 | 465 |
independently of ongoing changes of the PIDE document-model. Note that |
466 |
Isabelle/jEdit popup windows (\secref{sec:tooltips-hyperlinks}) provide a |
|
61477 | 467 |
similar \<^emph>\<open>Detach\<close> operation as an icon. |
58618 | 468 |
\<close> |
57316 | 469 |
|
470 |
||
58618 | 471 |
section \<open>Isabelle symbols \label{sec:symbols}\<close> |
57319 | 472 |
|
58618 | 473 |
text \<open> |
61477 | 474 |
Isabelle sources consist of \<^emph>\<open>symbols\<close> that extend plain ASCII to allow |
57420 | 475 |
infinitely many mathematical symbols within the formal sources. This works |
476 |
without depending on particular encodings and varying Unicode |
|
61574 | 477 |
standards.\<^footnote>\<open>Raw Unicode characters within formal sources would compromise |
478 |
portability and reliability in the face of changing interpretation of |
|
479 |
special features of Unicode, such as Combining Characters or Bi-directional |
|
62184 | 480 |
Text.\<close> See @{cite "Wenzel:2011:CICM"}. |
57319 | 481 |
|
57420 | 482 |
For the prover back-end, formal text consists of ASCII characters that are |
61574 | 483 |
grouped according to some simple rules, e.g.\ as plain ``\<^verbatim>\<open>a\<close>'' or symbolic |
484 |
``\<^verbatim>\<open>\<alpha>\<close>''. For the editor front-end, a certain subset of symbols is rendered |
|
485 |
physically via Unicode glyphs, in order to show ``\<^verbatim>\<open>\<alpha>\<close>'' as ``\<open>\<alpha>\<close>'', for |
|
486 |
example. This symbol interpretation is specified by the Isabelle system |
|
63680 | 487 |
distribution in \<^file>\<open>$ISABELLE_HOME/etc/symbols\<close> and may be augmented by the |
488 |
user in @{path "$ISABELLE_HOME_USER/etc/symbols"}. |
|
57319 | 489 |
|
58554 | 490 |
The appendix of @{cite "isabelle-isar-ref"} gives an overview of the |
57319 | 491 |
standard interpretation of finitely many symbols from the infinite |
58554 | 492 |
collection. Uninterpreted symbols are displayed literally, e.g.\ |
61503 | 493 |
``\<^verbatim>\<open>\<foobar>\<close>''. Overlap of Unicode characters used in symbol |
58554 | 494 |
interpretation with informal ones (which might appear e.g.\ in comments) |
495 |
needs to be avoided. Raw Unicode characters within prover source files |
|
496 |
should be restricted to informal parts, e.g.\ to write text in non-latin |
|
497 |
alphabets in comments. |
|
61506 | 498 |
\<close> |
57319 | 499 |
|
61506 | 500 |
paragraph \<open>Encoding.\<close> |
67304
3cf05d7cf174
more robust treatment of conflicts with existing Unicode text;
wenzelm
parents:
67262
diff
changeset
|
501 |
|
62184 | 502 |
text \<open>Technically, the Unicode interpretation of Isabelle symbols is an |
503 |
\<^emph>\<open>encoding\<close> called \<^verbatim>\<open>UTF-8-Isabelle\<close> in jEdit (\<^emph>\<open>not\<close> in the underlying |
|
66462 | 504 |
JVM). It is provided by the Isabelle Base plugin and enabled by default for |
67304
3cf05d7cf174
more robust treatment of conflicts with existing Unicode text;
wenzelm
parents:
67262
diff
changeset
|
505 |
all source files in Isabelle/jEdit. |
3cf05d7cf174
more robust treatment of conflicts with existing Unicode text;
wenzelm
parents:
67262
diff
changeset
|
506 |
|
3cf05d7cf174
more robust treatment of conflicts with existing Unicode text;
wenzelm
parents:
67262
diff
changeset
|
507 |
Sometimes such defaults are reset accidentally, or malformed UTF-8 sequences |
3cf05d7cf174
more robust treatment of conflicts with existing Unicode text;
wenzelm
parents:
67262
diff
changeset
|
508 |
in the text force jEdit to fall back on a different encoding like |
3cf05d7cf174
more robust treatment of conflicts with existing Unicode text;
wenzelm
parents:
67262
diff
changeset
|
509 |
\<^verbatim>\<open>ISO-8859-15\<close>. In that case, verbatim ``\<^verbatim>\<open>\<alpha>\<close>'' will be shown in the text |
3cf05d7cf174
more robust treatment of conflicts with existing Unicode text;
wenzelm
parents:
67262
diff
changeset
|
510 |
buffer instead of its Unicode rendering ``\<open>\<alpha>\<close>''. The jEdit menu operation |
3cf05d7cf174
more robust treatment of conflicts with existing Unicode text;
wenzelm
parents:
67262
diff
changeset
|
511 |
\<^emph>\<open>File~/ Reload with Encoding~/ UTF-8-Isabelle\<close> helps to resolve such |
3cf05d7cf174
more robust treatment of conflicts with existing Unicode text;
wenzelm
parents:
67262
diff
changeset
|
512 |
problems (after repairing malformed parts of the text). |
3cf05d7cf174
more robust treatment of conflicts with existing Unicode text;
wenzelm
parents:
67262
diff
changeset
|
513 |
|
3cf05d7cf174
more robust treatment of conflicts with existing Unicode text;
wenzelm
parents:
67262
diff
changeset
|
514 |
If the loaded text already contains Unicode sequences that are in conflict |
3cf05d7cf174
more robust treatment of conflicts with existing Unicode text;
wenzelm
parents:
67262
diff
changeset
|
515 |
with the Isabelle symbol encoding, the fallback-encoding UTF-8 is used and |
3cf05d7cf174
more robust treatment of conflicts with existing Unicode text;
wenzelm
parents:
67262
diff
changeset
|
516 |
Isabelle symbols remain in literal \<^verbatim>\<open>\<symbol>\<close> form. The jEdit menu |
3cf05d7cf174
more robust treatment of conflicts with existing Unicode text;
wenzelm
parents:
67262
diff
changeset
|
517 |
operation \<^emph>\<open>Utilities~/ Buffer Options~/ Character encoding\<close> allows to |
3cf05d7cf174
more robust treatment of conflicts with existing Unicode text;
wenzelm
parents:
67262
diff
changeset
|
518 |
enforce the UTF-8-Isabelle, but this will also change original Unicode |
3cf05d7cf174
more robust treatment of conflicts with existing Unicode text;
wenzelm
parents:
67262
diff
changeset
|
519 |
text into Isabelle symbols when saving the file! |
3cf05d7cf174
more robust treatment of conflicts with existing Unicode text;
wenzelm
parents:
67262
diff
changeset
|
520 |
\<close> |
57319 | 521 |
|
61506 | 522 |
paragraph \<open>Font.\<close> |
523 |
text \<open>Correct rendering via Unicode requires a font that contains glyphs for |
|
62184 | 524 |
the corresponding codepoints. There are also various unusual symbols with |
525 |
particular purpose in Isabelle, e.g.\ control symbols and very long arrows. |
|
526 |
Isabelle/jEdit prefers its own application fonts \<^verbatim>\<open>IsabelleText\<close>, which |
|
527 |
ensures that standard collection of Isabelle symbols is actually shown on |
|
528 |
the screen (or printer) as expected. |
|
57319 | 529 |
|
57420 | 530 |
Note that a Java/AWT/Swing application can load additional fonts only if |
531 |
they are not installed on the operating system already! Some outdated |
|
61574 | 532 |
version of \<^verbatim>\<open>IsabelleText\<close> that happens to be provided by the operating |
533 |
system would prevent Isabelle/jEdit to use its bundled version. This could |
|
534 |
lead to missing glyphs (black rectangles), when the system version of |
|
535 |
\<^verbatim>\<open>IsabelleText\<close> is older than the application version. This problem can be |
|
536 |
avoided by refraining to ``install'' any version of \<^verbatim>\<open>IsabelleText\<close> in the |
|
62184 | 537 |
first place, although it might be tempting to use the same font in other |
538 |
applications. |
|
539 |
||
540 |
HTML pages generated by Isabelle refer to the same \<^verbatim>\<open>IsabelleText\<close> font as a |
|
541 |
server-side resource. Thus a web-browser can use that without requiring a |
|
542 |
locally installed copy. |
|
61506 | 543 |
\<close> |
57319 | 544 |
|
61506 | 545 |
paragraph \<open>Input methods.\<close> |
546 |
text \<open>In principle, Isabelle/jEdit could delegate the problem to produce |
|
547 |
Isabelle symbols in their Unicode rendering to the underlying operating |
|
548 |
system and its \<^emph>\<open>input methods\<close>. Regular jEdit also provides various ways to |
|
549 |
work with \<^emph>\<open>abbreviations\<close> to produce certain non-ASCII characters. Since |
|
550 |
none of these standard input methods work satisfactorily for the |
|
551 |
mathematical characters required for Isabelle, various specific |
|
552 |
Isabelle/jEdit mechanisms are provided. |
|
57319 | 553 |
|
57420 | 554 |
This is a summary for practically relevant input methods for Isabelle |
555 |
symbols. |
|
57319 | 556 |
|
61504 | 557 |
\<^enum> The \<^emph>\<open>Symbols\<close> panel: some GUI buttons allow to insert certain symbols in |
558 |
the text buffer. There are also tooltips to reveal the official Isabelle |
|
559 |
representation with some additional information about \<^emph>\<open>symbol |
|
560 |
abbreviations\<close> (see below). |
|
57319 | 561 |
|
61504 | 562 |
\<^enum> Copy/paste from decoded source files: text that is rendered as Unicode |
563 |
already can be re-used to produce further text. This also works between |
|
564 |
different applications, e.g.\ Isabelle/jEdit and some web browser or mail |
|
62184 | 565 |
client, as long as the same Unicode interpretation of Isabelle symbols is |
566 |
used. |
|
57319 | 567 |
|
61504 | 568 |
\<^enum> Copy/paste from prover output within Isabelle/jEdit. The same principles |
569 |
as for text buffers apply, but note that \<^emph>\<open>copy\<close> in secondary Isabelle/jEdit |
|
570 |
windows works via the keyboard shortcuts \<^verbatim>\<open>C+c\<close> or \<^verbatim>\<open>C+INSERT\<close>, while jEdit |
|
571 |
menu actions always refer to the primary text area! |
|
57319 | 572 |
|
62184 | 573 |
\<^enum> Completion provided by the Isabelle plugin (see \secref{sec:completion}). |
61504 | 574 |
Isabelle symbols have a canonical name and optional abbreviations. This can |
575 |
be used with the text completion mechanism of Isabelle/jEdit, to replace a |
|
576 |
prefix of the actual symbol like \<^verbatim>\<open>\<lambda>\<close>, or its name preceded by backslash |
|
577 |
\<^verbatim>\<open>\lambda\<close>, or its ASCII abbreviation \<^verbatim>\<open>%\<close> by the Unicode rendering. |
|
57319 | 578 |
|
579 |
The following table is an extract of the information provided by the |
|
63680 | 580 |
standard \<^file>\<open>$ISABELLE_HOME/etc/symbols\<close> file: |
57319 | 581 |
|
61415 | 582 |
\<^medskip> |
57319 | 583 |
\begin{tabular}{lll} |
61477 | 584 |
\<^bold>\<open>symbol\<close> & \<^bold>\<open>name with backslash\<close> & \<^bold>\<open>abbreviation\<close> \\\hline |
61503 | 585 |
\<open>\<lambda>\<close> & \<^verbatim>\<open>\lambda\<close> & \<^verbatim>\<open>%\<close> \\ |
586 |
\<open>\<Rightarrow>\<close> & \<^verbatim>\<open>\Rightarrow\<close> & \<^verbatim>\<open>=>\<close> \\ |
|
587 |
\<open>\<Longrightarrow>\<close> & \<^verbatim>\<open>\Longrightarrow\<close> & \<^verbatim>\<open>==>\<close> \\[0.5ex] |
|
588 |
\<open>\<And>\<close> & \<^verbatim>\<open>\And\<close> & \<^verbatim>\<open>!!\<close> \\ |
|
589 |
\<open>\<equiv>\<close> & \<^verbatim>\<open>\equiv\<close> & \<^verbatim>\<open>==\<close> \\[0.5ex] |
|
590 |
\<open>\<forall>\<close> & \<^verbatim>\<open>\forall\<close> & \<^verbatim>\<open>!\<close> \\ |
|
591 |
\<open>\<exists>\<close> & \<^verbatim>\<open>\exists\<close> & \<^verbatim>\<open>?\<close> \\ |
|
592 |
\<open>\<longrightarrow>\<close> & \<^verbatim>\<open>\longrightarrow\<close> & \<^verbatim>\<open>-->\<close> \\ |
|
593 |
\<open>\<and>\<close> & \<^verbatim>\<open>\and\<close> & \<^verbatim>\<open>&\<close> \\ |
|
594 |
\<open>\<or>\<close> & \<^verbatim>\<open>\or\<close> & \<^verbatim>\<open>|\<close> \\ |
|
595 |
\<open>\<not>\<close> & \<^verbatim>\<open>\not\<close> & \<^verbatim>\<open>~\<close> \\ |
|
596 |
\<open>\<noteq>\<close> & \<^verbatim>\<open>\noteq\<close> & \<^verbatim>\<open>~=\<close> \\ |
|
597 |
\<open>\<in>\<close> & \<^verbatim>\<open>\in\<close> & \<^verbatim>\<open>:\<close> \\ |
|
598 |
\<open>\<notin>\<close> & \<^verbatim>\<open>\notin\<close> & \<^verbatim>\<open>~:\<close> \\ |
|
57319 | 599 |
\end{tabular} |
61415 | 600 |
\<^medskip> |
61574 | 601 |
|
57420 | 602 |
Note that the above abbreviations refer to the input method. The logical |
603 |
notation provides ASCII alternatives that often coincide, but sometimes |
|
62184 | 604 |
deviate. This occasionally causes user confusion with old-fashioned Isabelle |
605 |
source that use ASCII replacement notation like \<^verbatim>\<open>!\<close> or \<^verbatim>\<open>ALL\<close> directly in |
|
606 |
the text. |
|
57319 | 607 |
|
608 |
On the other hand, coincidence of symbol abbreviations with ASCII |
|
61574 | 609 |
replacement syntax syntax helps to update old theory sources via explicit |
610 |
completion (see also \<^verbatim>\<open>C+b\<close> explained in \secref{sec:completion}). |
|
61506 | 611 |
\<close> |
57319 | 612 |
|
61506 | 613 |
paragraph \<open>Control symbols.\<close> |
614 |
text \<open>There are some special control symbols to modify the display style of a |
|
615 |
single symbol (without nesting). Control symbols may be applied to a region |
|
616 |
of selected text, either using the \<^emph>\<open>Symbols\<close> panel or keyboard shortcuts or |
|
617 |
jEdit actions. These editor operations produce a separate control symbol for |
|
618 |
each symbol in the text, in order to make the whole text appear in a certain |
|
619 |
style. |
|
57319 | 620 |
|
61415 | 621 |
\<^medskip> |
57319 | 622 |
\begin{tabular}{llll} |
61477 | 623 |
\<^bold>\<open>style\<close> & \<^bold>\<open>symbol\<close> & \<^bold>\<open>shortcut\<close> & \<^bold>\<open>action\<close> \\\hline |
61503 | 624 |
superscript & \<^verbatim>\<open>\<^sup>\<close> & \<^verbatim>\<open>C+e UP\<close> & @{action_ref "isabelle.control-sup"} \\ |
625 |
subscript & \<^verbatim>\<open>\<^sub>\<close> & \<^verbatim>\<open>C+e DOWN\<close> & @{action_ref "isabelle.control-sub"} \\ |
|
626 |
bold face & \<^verbatim>\<open>\<^bold>\<close> & \<^verbatim>\<open>C+e RIGHT\<close> & @{action_ref "isabelle.control-bold"} \\ |
|
627 |
emphasized & \<^verbatim>\<open>\<^emph>\<close> & \<^verbatim>\<open>C+e LEFT\<close> & @{action_ref "isabelle.control-emph"} \\ |
|
628 |
reset & & \<^verbatim>\<open>C+e BACK_SPACE\<close> & @{action_ref "isabelle.control-reset"} \\ |
|
57319 | 629 |
\end{tabular} |
61415 | 630 |
\<^medskip> |
61483 | 631 |
|
632 |
To produce a single control symbol, it is also possible to complete on |
|
61504 | 633 |
\<^verbatim>\<open>\sup\<close>, \<^verbatim>\<open>\sub\<close>, \<^verbatim>\<open>\bold\<close>, \<^verbatim>\<open>\emph\<close> as for regular symbols. |
61483 | 634 |
|
62184 | 635 |
The emphasized style only takes effect in document output (when used with a |
636 |
cartouche), but not in the editor. |
|
58618 | 637 |
\<close> |
57319 | 638 |
|
639 |
||
58618 | 640 |
section \<open>Scala console \label{sec:scala-console}\<close> |
57319 | 641 |
|
58618 | 642 |
text \<open> |
61574 | 643 |
The \<^emph>\<open>Console\<close> plugin manages various shells (command interpreters), e.g.\ |
644 |
\<^emph>\<open>BeanShell\<close>, which is the official jEdit scripting language, and the |
|
645 |
cross-platform \<^emph>\<open>System\<close> shell. Thus the console provides similar |
|
646 |
functionality than the Emacs buffers \<^verbatim>\<open>*scratch*\<close> and \<^verbatim>\<open>*shell*\<close>. |
|
57319 | 647 |
|
61574 | 648 |
Isabelle/jEdit extends the repertoire of the console by \<^emph>\<open>Scala\<close>, which is |
649 |
the regular Scala toplevel loop running inside the same JVM process as |
|
57420 | 650 |
Isabelle/jEdit itself. This means the Scala command interpreter has access |
57603 | 651 |
to the JVM name space and state of the running Prover IDE application. The |
61503 | 652 |
default environment imports the full content of packages \<^verbatim>\<open>isabelle\<close> and |
653 |
\<^verbatim>\<open>isabelle.jedit\<close>. |
|
57603 | 654 |
|
61574 | 655 |
For example, \<^verbatim>\<open>PIDE\<close> refers to the Isabelle/jEdit plugin object, and \<^verbatim>\<open>view\<close> |
656 |
to the current editor view of jEdit. The Scala expression |
|
657 |
\<^verbatim>\<open>PIDE.snapshot(view)\<close> makes a PIDE document snapshot of the current buffer |
|
658 |
within the current editor view. |
|
57319 | 659 |
|
660 |
This helps to explore Isabelle/Scala functionality interactively. Some care |
|
661 |
is required to avoid interference with the internals of the running |
|
62184 | 662 |
application. |
58618 | 663 |
\<close> |
57319 | 664 |
|
665 |
||
58618 | 666 |
section \<open>File-system access\<close> |
57318 | 667 |
|
58618 | 668 |
text \<open> |
57420 | 669 |
File specifications in jEdit follow various formats and conventions |
61477 | 670 |
according to \<^emph>\<open>Virtual File Systems\<close>, which may be also provided by |
61503 | 671 |
additional plugins. This allows to access remote files via the \<^verbatim>\<open>http:\<close> |
61574 | 672 |
protocol prefix, for example. Isabelle/jEdit attempts to work with the |
673 |
file-system model of jEdit as far as possible. In particular, theory sources |
|
674 |
are passed directly from the editor to the prover, without indirection via |
|
675 |
physical files. |
|
57318 | 676 |
|
57420 | 677 |
Despite the flexibility of URLs in jEdit, local files are particularly |
62184 | 678 |
important and are accessible without protocol prefix. The file path notation |
57420 | 679 |
is that of the Java Virtual Machine on the underlying platform. On Windows |
62184 | 680 |
the preferred form uses backslashes, but happens to accept forward slashes |
681 |
like Unix/POSIX as well. Further differences arise due to Windows drive |
|
60257 | 682 |
letters and network shares. |
57318 | 683 |
|
57331 | 684 |
The Java notation for files needs to be distinguished from the one of |
61477 | 685 |
Isabelle, which uses POSIX notation with forward slashes on \<^emph>\<open>all\<close> |
62184 | 686 |
platforms. Isabelle/ML on Windows uses Unix-style path notation, too, and |
687 |
driver letter representation as in Cygwin (e.g.\ \<^verbatim>\<open>/cygdrive/c\<close>). Moreover, |
|
688 |
environment variables from the Isabelle process may be used freely, e.g.\ |
|
63680 | 689 |
\<^file>\<open>$ISABELLE_HOME/etc/symbols\<close> or \<^file>\<open>$POLYML_HOME/README\<close>. There are special |
690 |
shortcuts: \<^dir>\<open>~\<close> for \<^dir>\<open>$USER_HOME\<close> and \<^dir>\<open>~~\<close> for \<^dir>\<open>$ISABELLE_HOME\<close>. |
|
57318 | 691 |
|
61415 | 692 |
\<^medskip> |
693 |
Since jEdit happens to support environment variables within file |
|
57420 | 694 |
specifications as well, it is natural to use similar notation within the |
695 |
editor, e.g.\ in the file-browser. This does not work in full generality, |
|
696 |
though, due to the bias of jEdit towards platform-specific notation and of |
|
697 |
Isabelle towards POSIX. Moreover, the Isabelle settings environment is not |
|
698 |
yet active when starting Isabelle/jEdit via its standard application |
|
60257 | 699 |
wrapper, in contrast to @{tool jedit} run from the command line |
700 |
(\secref{sec:command-line}). |
|
57318 | 701 |
|
63749 | 702 |
Isabelle/jEdit imitates important system settings within the Java process |
703 |
environment, in order to allow easy access to these important places from |
|
704 |
the editor: \<^verbatim>\<open>$ISABELLE_HOME\<close>, \<^verbatim>\<open>$ISABELLE_HOME_USER\<close>, \<^verbatim>\<open>$JEDIT_HOME\<close>, |
|
705 |
\<^verbatim>\<open>$JEDIT_SETTINGS\<close>. The file browser of jEdit also includes \<^emph>\<open>Favorites\<close> for |
|
706 |
these two important locations. |
|
57318 | 707 |
|
61415 | 708 |
\<^medskip> |
61574 | 709 |
Path specifications in prover input or output usually include formal markup |
710 |
that turns it into a hyperlink (see also \secref{sec:tooltips-hyperlinks}). |
|
711 |
This allows to open the corresponding file in the text editor, independently |
|
62184 | 712 |
of the path notation. If the path refers to a directory, the jEdit file |
713 |
browser is opened on it. |
|
57318 | 714 |
|
715 |
Formally checked paths in prover input are subject to completion |
|
61574 | 716 |
(\secref{sec:completion}): partial specifications are resolved via directory |
717 |
content and possible completions are offered in a popup. |
|
58618 | 718 |
\<close> |
57318 | 719 |
|
720 |
||
64515 | 721 |
section \<open>Indentation\<close> |
722 |
||
723 |
text \<open> |
|
724 |
Isabelle/jEdit augments the existing indentation facilities of jEdit to take |
|
725 |
the structure of theory and proof texts into account. There is also special |
|
726 |
support for unstructured proof scripts. |
|
727 |
||
728 |
\<^descr>[Syntactic indentation] follows the outer syntax of Isabelle/Isar. |
|
729 |
||
730 |
Action @{action "indent-lines"} (shortcut \<^verbatim>\<open>C+i\<close>) indents the current line |
|
731 |
according to command keywords and some command substructure: this |
|
732 |
approximation may need further manual tuning. |
|
733 |
||
734 |
Action @{action "isabelle.newline"} (shortcut \<^verbatim>\<open>ENTER\<close>) indents the old |
|
735 |
and the new line according to command keywords only: this leads to precise |
|
736 |
alignment of the main Isar language elements. This depends on option |
|
737 |
@{system_option_def "jedit_indent_newline"} (enabled by default). |
|
738 |
||
66681 | 739 |
Regular input (via keyboard or completion) indents the current line |
66683 | 740 |
whenever an new keyword is emerging at the start of the line. This depends |
741 |
on option @{system_option_def "jedit_indent_input"} (enabled by default). |
|
66681 | 742 |
|
64515 | 743 |
\<^descr>[Semantic indentation] adds additional white space to unstructured proof |
744 |
scripts (\<^theory_text>\<open>apply\<close> etc.) via number of subgoals. This requires information |
|
745 |
of ongoing document processing and may thus lag behind, when the user is |
|
746 |
editing too quickly; see also option @{system_option_def |
|
747 |
"jedit_script_indent"} and @{system_option_def |
|
748 |
"jedit_script_indent_limit"}. |
|
749 |
||
750 |
The above options are accessible in the menu \<^emph>\<open>Plugins / Plugin Options / |
|
66681 | 751 |
Isabelle / General\<close>. A prerequisite for advanced indentation is \<^emph>\<open>Utilities |
752 |
/ Buffer Options / Automatic indentation\<close>: it needs to be set to \<^verbatim>\<open>full\<close> |
|
753 |
(default). |
|
64515 | 754 |
\<close> |
755 |
||
756 |
||
62184 | 757 |
section \<open>SideKick parsers \label{sec:sidekick}\<close> |
758 |
||
759 |
text \<open> |
|
760 |
The \<^emph>\<open>SideKick\<close> plugin provides some general services to display buffer |
|
761 |
structure in a tree view. Isabelle/jEdit provides SideKick parsers for its |
|
64513 | 762 |
main mode for theory files, ML files, as well as some minor modes for the |
763 |
\<^verbatim>\<open>NEWS\<close> file (see \figref{fig:sidekick}), session \<^verbatim>\<open>ROOT\<close> files, system |
|
764 |
\<^verbatim>\<open>options\<close>, and Bib{\TeX} files (\secref{sec:bibtex}). |
|
62184 | 765 |
|
766 |
\begin{figure}[!htb] |
|
767 |
\begin{center} |
|
768 |
\includegraphics[scale=0.333]{sidekick} |
|
769 |
\end{center} |
|
770 |
\caption{The Isabelle NEWS file with SideKick tree view} |
|
771 |
\label{fig:sidekick} |
|
772 |
\end{figure} |
|
773 |
||
64513 | 774 |
The default SideKick parser for theory files is \<^verbatim>\<open>isabelle\<close>: it provides a |
775 |
tree-view on the formal document structure, with section headings at the top |
|
776 |
and formal specification elements at the bottom. The alternative parser |
|
777 |
\<^verbatim>\<open>isabelle-context\<close> shows nesting of context blocks according to \<^theory_text>\<open>begin \<dots> |
|
778 |
end\<close> structure. |
|
779 |
||
780 |
\<^medskip> |
|
781 |
Isabelle/ML files are structured according to semi-formal comments that are |
|
782 |
explained in @{cite "isabelle-implementation"}. This outline is turned into |
|
783 |
a tree-view by default, by using the \<^verbatim>\<open>isabelle-ml\<close> parser. There is also a |
|
784 |
folding mode of the same name, for hierarchic text folds within ML files. |
|
785 |
||
786 |
\<^medskip> |
|
62184 | 787 |
The special SideKick parser \<^verbatim>\<open>isabelle-markup\<close> exposes the uninterpreted |
788 |
markup tree of the PIDE document model of the current buffer. This is |
|
789 |
occasionally useful for informative purposes, but the amount of displayed |
|
790 |
information might cause problems for large buffers. |
|
791 |
\<close> |
|
792 |
||
793 |
||
58618 | 794 |
chapter \<open>Prover IDE functionality \label{sec:document-model}\<close> |
57315 | 795 |
|
58618 | 796 |
section \<open>Document model \label{sec:document-model}\<close> |
57322 | 797 |
|
58618 | 798 |
text \<open> |
57322 | 799 |
The document model is central to the PIDE architecture: the editor and the |
800 |
prover have a common notion of structured source text with markup, which is |
|
801 |
produced by formal processing. The editor is responsible for edits of |
|
802 |
document source, as produced by the user. The prover is responsible for |
|
803 |
reports of document markup, as produced by its processing in the background. |
|
804 |
||
805 |
Isabelle/jEdit handles classic editor events of jEdit, in order to connect |
|
806 |
the physical world of the GUI (with its singleton state) to the mathematical |
|
807 |
world of multiple document versions (with timeless and stateless updates). |
|
58618 | 808 |
\<close> |
57322 | 809 |
|
54322 | 810 |
|
58618 | 811 |
subsection \<open>Editor buffers and document nodes \label{sec:buffer-node}\<close> |
57322 | 812 |
|
58618 | 813 |
text \<open> |
61477 | 814 |
As a regular text editor, jEdit maintains a collection of \<^emph>\<open>buffers\<close> to |
57322 | 815 |
store text files; each buffer may be associated with any number of visible |
61574 | 816 |
\<^emph>\<open>text areas\<close>. Buffers are subject to an \<^emph>\<open>edit mode\<close> that is determined |
817 |
from the file name extension. The following modes are treated specifically |
|
818 |
in Isabelle/jEdit: |
|
57322 | 819 |
|
61415 | 820 |
\<^medskip> |
57322 | 821 |
\begin{tabular}{lll} |
62185 | 822 |
\<^bold>\<open>mode\<close> & \<^bold>\<open>file name\<close> & \<^bold>\<open>content\<close> \\\hline |
823 |
\<^verbatim>\<open>isabelle\<close> & \<^verbatim>\<open>*.thy\<close> & theory source \\ |
|
824 |
\<^verbatim>\<open>isabelle-ml\<close> & \<^verbatim>\<open>*.ML\<close> & Isabelle/ML source \\ |
|
825 |
\<^verbatim>\<open>sml\<close> & \<^verbatim>\<open>*.sml\<close> or \<^verbatim>\<open>*.sig\<close> & Standard ML source \\ |
|
826 |
\<^verbatim>\<open>isabelle-root\<close> & \<^verbatim>\<open>ROOT\<close> & session root \\ |
|
827 |
\<^verbatim>\<open>isabelle-options\<close> & & Isabelle options \\ |
|
828 |
\<^verbatim>\<open>isabelle-news\<close> & & Isabelle NEWS \\ |
|
57322 | 829 |
\end{tabular} |
61415 | 830 |
\<^medskip> |
54321 | 831 |
|
57322 | 832 |
All jEdit buffers are automatically added to the PIDE document-model as |
61574 | 833 |
\<^emph>\<open>document nodes\<close>. The overall document structure is defined by the theory |
834 |
nodes in two dimensions: |
|
57322 | 835 |
|
61574 | 836 |
\<^enum> via \<^bold>\<open>theory imports\<close> that are specified in the \<^emph>\<open>theory header\<close> using |
837 |
concrete syntax of the @{command_ref theory} command @{cite |
|
838 |
"isabelle-isar-ref"}; |
|
57322 | 839 |
|
66683 | 840 |
\<^enum> via \<^bold>\<open>auxiliary files\<close> that are included into a theory by \<^emph>\<open>load |
61574 | 841 |
commands\<close>, notably @{command_ref ML_file} and @{command_ref SML_file} |
842 |
@{cite "isabelle-isar-ref"}. |
|
54322 | 843 |
|
57322 | 844 |
In any case, source files are managed by the PIDE infrastructure: the |
845 |
physical file-system only plays a subordinate role. The relevant version of |
|
60257 | 846 |
source text is passed directly from the editor to the prover, using internal |
57322 | 847 |
communication channels. |
58618 | 848 |
\<close> |
57322 | 849 |
|
850 |
||
58618 | 851 |
subsection \<open>Theories \label{sec:theories}\<close> |
57322 | 852 |
|
58618 | 853 |
text \<open> |
61574 | 854 |
The \<^emph>\<open>Theories\<close> panel (see also \figref{fig:theories}) provides an overview |
855 |
of the status of continuous checking of theory nodes within the document |
|
66683 | 856 |
model. |
57322 | 857 |
|
62183 | 858 |
\begin{figure}[!htb] |
57339 | 859 |
\begin{center} |
860 |
\includegraphics[scale=0.333]{theories} |
|
861 |
\end{center} |
|
62185 | 862 |
\caption{Theories panel with an overview of the document-model, and jEdit |
863 |
text areas as editable views on some of the document nodes} |
|
57339 | 864 |
\label{fig:theories} |
865 |
\end{figure} |
|
866 |
||
64842 | 867 |
Theory imports are resolved automatically by the PIDE document model: all |
868 |
required files are loaded and stored internally, without the need to open |
|
869 |
corresponding jEdit buffers. Opening or closing editor buffers later on has |
|
66683 | 870 |
no direct impact on the formal document content: it only affects visibility. |
64842 | 871 |
|
66683 | 872 |
In contrast, auxiliary files (e.g.\ from @{command ML_file} commands) are |
873 |
\<^emph>\<open>not\<close> resolved within the editor by default, but the prover process takes |
|
874 |
care of that. This may be changed by enabling the system option |
|
875 |
@{system_option jedit_auto_resolve}: it ensures that all files are uniformly |
|
876 |
provided by the editor. |
|
54321 | 877 |
|
61415 | 878 |
\<^medskip> |
61574 | 879 |
The visible \<^emph>\<open>perspective\<close> of Isabelle/jEdit is defined by the collective |
880 |
view on theory buffers via open text areas. The perspective is taken as a |
|
881 |
hint for document processing: the prover ensures that those parts of a |
|
882 |
theory where the user is looking are checked, while other parts that are |
|
883 |
presently not required are ignored. The perspective is changed by opening or |
|
884 |
closing text area windows, or scrolling within a window. |
|
54322 | 885 |
|
61574 | 886 |
The \<^emph>\<open>Theories\<close> panel provides some further options to influence the process |
887 |
of continuous checking: it may be switched off globally to restrict the |
|
888 |
prover to superficial processing of command syntax. It is also possible to |
|
889 |
indicate theory nodes as \<^emph>\<open>required\<close> for continuous checking: this means |
|
890 |
such nodes and all their imports are always processed independently of the |
|
891 |
visibility status (if continuous checking is enabled). Big theory libraries |
|
62185 | 892 |
that are marked as required can have significant impact on performance! |
54322 | 893 |
|
66683 | 894 |
The \<^emph>\<open>Purge\<close> button restricts the document model to theories that are |
895 |
required for open editor buffers: inaccessible theories are removed and will |
|
896 |
be rechecked when opened or imported later. |
|
897 |
||
61415 | 898 |
\<^medskip> |
61574 | 899 |
Formal markup of checked theory content is turned into GUI rendering, based |
62185 | 900 |
on a standard repertoire known from mainstream IDEs for programming |
901 |
languages: colors, icons, highlighting, squiggly underlines, tooltips, |
|
902 |
hyperlinks etc. For outer syntax of Isabelle/Isar there is some traditional |
|
903 |
syntax-highlighting via static keywords and tokenization within the editor; |
|
904 |
this buffer syntax is determined from theory imports. In contrast, the |
|
905 |
painting of inner syntax (term language etc.)\ uses semantic information |
|
906 |
that is reported dynamically from the logical context. Thus the prover can |
|
907 |
provide additional markup to help the user to understand the meaning of |
|
908 |
formal text, and to produce more text with some add-on tools (e.g.\ |
|
909 |
information messages with \<^emph>\<open>sendback\<close> markup by automated provers or |
|
910 |
disprovers in the background). \<close> |
|
57322 | 911 |
|
912 |
||
58618 | 913 |
subsection \<open>Auxiliary files \label{sec:aux-files}\<close> |
57322 | 914 |
|
58618 | 915 |
text \<open> |
57329 | 916 |
Special load commands like @{command_ref ML_file} and @{command_ref |
58554 | 917 |
SML_file} @{cite "isabelle-isar-ref"} refer to auxiliary files within some |
57329 | 918 |
theory. Conceptually, the file argument of the command extends the theory |
919 |
source by the content of the file, but its editor buffer may be loaded~/ |
|
920 |
changed~/ saved separately. The PIDE document model propagates changes of |
|
921 |
auxiliary file content to the corresponding load command in the theory, to |
|
922 |
update and process it accordingly: changes of auxiliary file content are |
|
923 |
treated as changes of the corresponding load command. |
|
57323 | 924 |
|
61415 | 925 |
\<^medskip> |
61574 | 926 |
As a concession to the massive amount of ML files in Isabelle/HOL itself, |
927 |
the content of auxiliary files is only added to the PIDE document-model on |
|
928 |
demand, the first time when opened explicitly in the editor. There are |
|
929 |
further tricks to manage markup of ML files, such that Isabelle/HOL may be |
|
930 |
edited conveniently in the Prover IDE on small machines with only 8\,GB of |
|
931 |
main memory. Using \<^verbatim>\<open>Pure\<close> as logic session image, the exploration may start |
|
63680 | 932 |
at the top \<^file>\<open>$ISABELLE_HOME/src/HOL/Main.thy\<close> or the bottom |
66683 | 933 |
\<^file>\<open>$ISABELLE_HOME/src/HOL/HOL.thy\<close>, for example. It is also possible to |
934 |
explore the Isabelle/Pure bootstrap process (a virtual copy) by opening |
|
935 |
\<^file>\<open>$ISABELLE_HOME/src/Pure/ROOT.ML\<close> like a theory in the Prover IDE. |
|
57323 | 936 |
|
937 |
Initially, before an auxiliary file is opened in the editor, the prover |
|
938 |
reads its content from the physical file-system. After the file is opened |
|
939 |
for the first time in the editor, e.g.\ by following the hyperlink |
|
940 |
(\secref{sec:tooltips-hyperlinks}) for the argument of its @{command |
|
941 |
ML_file} command, the content is taken from the jEdit buffer. |
|
942 |
||
943 |
The change of responsibility from prover to editor counts as an update of |
|
944 |
the document content, so subsequent theory sources need to be re-checked. |
|
57420 | 945 |
When the buffer is closed, the responsibility remains to the editor: the |
946 |
file may be opened again without causing another document update. |
|
57323 | 947 |
|
948 |
A file that is opened in the editor, but its theory with the load command is |
|
949 |
not, is presently inactive in the document model. A file that is loaded via |
|
950 |
multiple load commands is associated to an arbitrary one: this situation is |
|
951 |
morally unsupported and might lead to confusion. |
|
952 |
||
61415 | 953 |
\<^medskip> |
61574 | 954 |
Output that refers to an auxiliary file is combined with that of the |
955 |
corresponding load command, and shown whenever the file or the command are |
|
956 |
active (see also \secref{sec:output}). |
|
57323 | 957 |
|
958 |
Warnings, errors, and other useful markup is attached directly to the |
|
62185 | 959 |
positions in the auxiliary file buffer, in the manner of standard IDEs. By |
63680 | 960 |
using the load command @{command SML_file} as explained in |
961 |
\<^file>\<open>$ISABELLE_HOME/src/Tools/SML/Examples.thy\<close>, Isabelle/jEdit may be used as |
|
57323 | 962 |
fully-featured IDE for Standard ML, independently of theory or proof |
61574 | 963 |
development: the required theory merely serves as some kind of project file |
964 |
for a collection of SML source modules. |
|
58618 | 965 |
\<close> |
54322 | 966 |
|
54352 | 967 |
|
58618 | 968 |
section \<open>Output \label{sec:output}\<close> |
54353 | 969 |
|
58618 | 970 |
text \<open> |
61574 | 971 |
Prover output consists of \<^emph>\<open>markup\<close> and \<^emph>\<open>messages\<close>. Both are directly |
972 |
attached to the corresponding positions in the original source text, and |
|
973 |
visualized in the text area, e.g.\ as text colours for free and bound |
|
974 |
variables, or as squiggly underlines for warnings, errors etc.\ (see also |
|
975 |
\figref{fig:output}). In the latter case, the corresponding messages are |
|
976 |
shown by hovering with the mouse over the highlighted text --- although in |
|
977 |
many situations the user should already get some clue by looking at the |
|
62185 | 978 |
position of the text highlighting, without seeing the message body itself. |
54357 | 979 |
|
62183 | 980 |
\begin{figure}[!htb] |
54357 | 981 |
\begin{center} |
57312 | 982 |
\includegraphics[scale=0.333]{output} |
54357 | 983 |
\end{center} |
62185 | 984 |
\caption{Multiple views on prover output: gutter with icon, text area with |
985 |
popup, text overview column, \<^emph>\<open>Theories\<close> panel, \<^emph>\<open>Output\<close> panel} |
|
54357 | 986 |
\label{fig:output} |
987 |
\end{figure} |
|
54353 | 988 |
|
62185 | 989 |
The ``gutter'' on the left-hand-side of the text area uses icons to |
990 |
provide a summary of the messages within the adjacent text line. Message |
|
61574 | 991 |
priorities are used to prefer errors over warnings, warnings over |
62185 | 992 |
information messages; other output is ignored. |
54353 | 993 |
|
62185 | 994 |
The ``text overview column'' on the right-hand-side of the text area uses |
995 |
similar information to paint small rectangles for the overall status of the |
|
996 |
whole text buffer. The graphics is scaled to fit the logical buffer length |
|
997 |
into the given window height. Mouse clicks on the overview area move the |
|
998 |
cursor approximately to the corresponding text line in the buffer. |
|
54353 | 999 |
|
62185 | 1000 |
The \<^emph>\<open>Theories\<close> panel provides another course-grained overview, but without |
1001 |
direct correspondence to text positions. The coloured rectangles represent |
|
1002 |
the amount of messages of a certain kind (warnings, errors, etc.) and the |
|
66683 | 1003 |
execution status of commands. The border of each rectangle indicates the |
1004 |
overall status of processing: a thick border means it is \<^emph>\<open>finished\<close> or |
|
1005 |
\<^emph>\<open>failed\<close> (with color for errors). A double-click on one of the theory |
|
1006 |
entries with their status overview opens the corresponding text buffer, |
|
1007 |
without moving the cursor to a specific point. |
|
54353 | 1008 |
|
61415 | 1009 |
\<^medskip> |
62185 | 1010 |
The \<^emph>\<open>Output\<close> panel displays prover messages that correspond to a given |
1011 |
command, within a separate window. The cursor position in the presently |
|
1012 |
active text area determines the prover command whose cumulative message |
|
1013 |
output is appended and shown in that window (in canonical order according to |
|
1014 |
the internal execution of the command). There are also control elements to |
|
1015 |
modify the update policy of the output wrt.\ continued editor movements: |
|
1016 |
\<^emph>\<open>Auto update\<close> and \<^emph>\<open>Update\<close>. This is particularly useful for multiple |
|
1017 |
instances of the \<^emph>\<open>Output\<close> panel to look at different situations. |
|
1018 |
Alternatively, the panel can be turned into a passive \<^emph>\<open>Info\<close> window via the |
|
1019 |
\<^emph>\<open>Detach\<close> menu item. |
|
54353 | 1020 |
|
62185 | 1021 |
Proof state is handled separately (\secref{sec:state-output}), but it is |
1022 |
also possible to tick the corresponding checkbox to append it to regular |
|
1023 |
output (\figref{fig:output-including-state}). This is a globally persistent |
|
1024 |
option: it affects all open panels and future editor sessions. |
|
54353 | 1025 |
|
62185 | 1026 |
\begin{figure}[!htb] |
1027 |
\begin{center} |
|
1028 |
\includegraphics[scale=0.333]{output-including-state} |
|
1029 |
\end{center} |
|
1030 |
\caption{Proof state display within the regular output panel} |
|
1031 |
\label{fig:output-including-state} |
|
1032 |
\end{figure} |
|
54353 | 1033 |
|
61415 | 1034 |
\<^medskip> |
62185 | 1035 |
Following the IDE principle, regular messages are attached to the original |
1036 |
source in the proper place and may be inspected on demand via popups. This |
|
1037 |
excludes messages that are somehow internal to the machinery of proof |
|
1038 |
checking, notably \<^emph>\<open>proof state\<close> and \<^emph>\<open>tracing\<close>. |
|
1039 |
||
1040 |
In any case, the same display technology is used for small popups and big |
|
1041 |
output windows. The formal text contains markup that may be explored |
|
1042 |
recursively via further popups and hyperlinks (see |
|
61574 | 1043 |
\secref{sec:tooltips-hyperlinks}), or clicked directly to initiate certain |
1044 |
actions (see \secref{sec:auto-tools} and \secref{sec:sledgehammer}). |
|
1045 |
\<close> |
|
54353 | 1046 |
|
1047 |
||
62185 | 1048 |
section \<open>Proof state \label{sec:state-output}\<close> |
62154 | 1049 |
|
1050 |
text \<open> |
|
62185 | 1051 |
The main purpose of the Prover IDE is to help the user editing proof |
1052 |
documents, with ongoing formal checking by the prover in the background. |
|
1053 |
This can be done to some extent in the main text area alone, especially for |
|
1054 |
well-structured Isar proofs. |
|
1055 |
||
1056 |
Nonetheless, internal proof state needs to be inspected in many situations |
|
1057 |
of exploration and ``debugging''. The \<^emph>\<open>State\<close> panel shows exclusively such |
|
1058 |
proof state messages without further distraction, while all other messages |
|
1059 |
are displayed in \<^emph>\<open>Output\<close> (\secref{sec:output}). |
|
1060 |
\Figref{fig:output-and-state} shows a typical GUI layout where both panels |
|
1061 |
are open. |
|
62154 | 1062 |
|
62183 | 1063 |
\begin{figure}[!htb] |
62154 | 1064 |
\begin{center} |
1065 |
\includegraphics[scale=0.333]{output-and-state} |
|
1066 |
\end{center} |
|
1067 |
\caption{Separate proof state display (right) and other output (bottom).} |
|
1068 |
\label{fig:output-and-state} |
|
1069 |
\end{figure} |
|
1070 |
||
62185 | 1071 |
Another typical arrangement has more than one \<^emph>\<open>State\<close> panel open (as |
1072 |
floating windows), with \<^emph>\<open>Auto update\<close> disabled to look at an old situation |
|
1073 |
while the proof text in the vicinity is changed. The \<^emph>\<open>Update\<close> button |
|
1074 |
triggers an explicit one-shot update; this operation is also available via |
|
1075 |
the action @{action "isabelle.update-state"} (keyboard shortcut \<^verbatim>\<open>S+ENTER\<close>). |
|
1076 |
||
1077 |
On small screens, it is occasionally useful to have all messages |
|
1078 |
concatenated in the regular \<^emph>\<open>Output\<close> panel, e.g.\ see |
|
1079 |
\figref{fig:output-including-state}. |
|
1080 |
||
1081 |
\<^medskip> |
|
1082 |
The mechanics of \<^emph>\<open>Output\<close> versus \<^emph>\<open>State\<close> are slightly different: |
|
1083 |
||
1084 |
\<^item> \<^emph>\<open>Output\<close> shows information that is continuously produced and already |
|
1085 |
present when the GUI wants to show it. This is implicitly controlled by |
|
1086 |
the visible perspective on the text. |
|
1087 |
||
1088 |
\<^item> \<^emph>\<open>State\<close> initiates a real-time query on demand, with a full round trip |
|
1089 |
including a fresh print operation on the prover side. This is controlled |
|
1090 |
explicitly when the cursor is moved to the next command (\<^emph>\<open>Auto update\<close>) |
|
1091 |
or the \<^emph>\<open>Update\<close> operation is triggered. |
|
1092 |
||
1093 |
This can make a difference in GUI responsibility and resource usage within |
|
1094 |
the prover process. Applications with very big proof states that are only |
|
1095 |
inspected in isolation work better with the \<^emph>\<open>State\<close> panel. |
|
62154 | 1096 |
\<close> |
1097 |
||
62185 | 1098 |
|
58618 | 1099 |
section \<open>Query \label{sec:query}\<close> |
57311 | 1100 |
|
58618 | 1101 |
text \<open> |
61574 | 1102 |
The \<^emph>\<open>Query\<close> panel provides various GUI forms to request extra information |
62249 | 1103 |
from the prover, as a replacement of old-style diagnostic commands like |
1104 |
@{command find_theorems}. There are input fields and buttons for a |
|
1105 |
particular query command, with output in a dedicated text area. |
|
57311 | 1106 |
|
62249 | 1107 |
The main query modes are presented as separate tabs: \<^emph>\<open>Find Theorems\<close>, |
1108 |
\<^emph>\<open>Find Constants\<close>, \<^emph>\<open>Print Context\<close>, e.g.\ see \figref{fig:query}. As usual |
|
1109 |
in jEdit, multiple \<^emph>\<open>Query\<close> windows may be active at the same time: any |
|
1110 |
number of floating instances, but at most one docked instance (which is used |
|
1111 |
by default). |
|
57313 | 1112 |
|
62183 | 1113 |
\begin{figure}[!htb] |
57313 | 1114 |
\begin{center} |
1115 |
\includegraphics[scale=0.333]{query} |
|
1116 |
\end{center} |
|
62154 | 1117 |
\caption{An instance of the Query panel: find theorems} |
57313 | 1118 |
\label{fig:query} |
1119 |
\end{figure} |
|
57311 | 1120 |
|
61415 | 1121 |
\<^medskip> |
1122 |
The following GUI elements are common to all query modes: |
|
57311 | 1123 |
|
61574 | 1124 |
\<^item> The spinning wheel provides feedback about the status of a pending query |
1125 |
wrt.\ the evaluation of its context and its own operation. |
|
57311 | 1126 |
|
61574 | 1127 |
\<^item> The \<^emph>\<open>Apply\<close> button attaches a fresh query invocation to the current |
1128 |
context of the command where the cursor is pointing in the text. |
|
57311 | 1129 |
|
61574 | 1130 |
\<^item> The \<^emph>\<open>Search\<close> field allows to highlight query output according to some |
1131 |
regular expression, in the notation that is commonly used on the Java |
|
63680 | 1132 |
platform.\<^footnote>\<open>\<^url>\<open>https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html\<close>\<close> |
61574 | 1133 |
This may serve as an additional visual filter of the result. |
57311 | 1134 |
|
61574 | 1135 |
\<^item> The \<^emph>\<open>Zoom\<close> box controls the font size of the output area. |
57311 | 1136 |
|
1137 |
All query operations are asynchronous: there is no need to wait for the |
|
1138 |
evaluation of the document for the query context, nor for the query |
|
61477 | 1139 |
operation itself. Query output may be detached as independent \<^emph>\<open>Info\<close> |
57311 | 1140 |
window, using a menu operation of the dockable window manager. The printed |
1141 |
result usually provides sufficient clues about the original query, with some |
|
1142 |
hyperlink to its context (via markup of its head line). |
|
58618 | 1143 |
\<close> |
57311 | 1144 |
|
1145 |
||
58618 | 1146 |
subsection \<open>Find theorems\<close> |
57311 | 1147 |
|
58618 | 1148 |
text \<open> |
61574 | 1149 |
The \<^emph>\<open>Query\<close> panel in \<^emph>\<open>Find Theorems\<close> mode retrieves facts from the theory |
1150 |
or proof context matching all of given criteria in the \<^emph>\<open>Find\<close> text field. A |
|
68042 | 1151 |
single criterion has the following syntax: |
57311 | 1152 |
|
57313 | 1153 |
@{rail \<open> |
62969 | 1154 |
('-'?) ('name' ':' @{syntax name} | 'intro' | 'elim' | 'dest' | |
57313 | 1155 |
'solves' | 'simp' ':' @{syntax term} | @{syntax term}) |
1156 |
\<close>} |
|
1157 |
||
61574 | 1158 |
See also the Isar command @{command_ref find_theorems} in @{cite |
1159 |
"isabelle-isar-ref"}. |
|
58618 | 1160 |
\<close> |
57311 | 1161 |
|
1162 |
||
58618 | 1163 |
subsection \<open>Find constants\<close> |
57311 | 1164 |
|
58618 | 1165 |
text \<open> |
61574 | 1166 |
The \<^emph>\<open>Query\<close> panel in \<^emph>\<open>Find Constants\<close> mode prints all constants whose type |
1167 |
meets all of the given criteria in the \<^emph>\<open>Find\<close> text field. A single |
|
68042 | 1168 |
criterion has the following syntax: |
57313 | 1169 |
|
1170 |
@{rail \<open> |
|
1171 |
('-'?) |
|
62969 | 1172 |
('name' ':' @{syntax name} | 'strict' ':' @{syntax type} | @{syntax type}) |
57313 | 1173 |
\<close>} |
1174 |
||
58554 | 1175 |
See also the Isar command @{command_ref find_consts} in @{cite |
1176 |
"isabelle-isar-ref"}. |
|
58618 | 1177 |
\<close> |
57311 | 1178 |
|
1179 |
||
58618 | 1180 |
subsection \<open>Print context\<close> |
57311 | 1181 |
|
58618 | 1182 |
text \<open> |
61574 | 1183 |
The \<^emph>\<open>Query\<close> panel in \<^emph>\<open>Print Context\<close> mode prints information from the |
1184 |
theory or proof context, or proof state. See also the Isar commands |
|
57329 | 1185 |
@{command_ref print_context}, @{command_ref print_cases}, @{command_ref |
62249 | 1186 |
print_term_bindings}, @{command_ref print_theorems}, described in @{cite |
1187 |
"isabelle-isar-ref"}. |
|
58618 | 1188 |
\<close> |
57311 | 1189 |
|
1190 |
||
58618 | 1191 |
section \<open>Tooltips and hyperlinks \label{sec:tooltips-hyperlinks}\<close> |
54352 | 1192 |
|
58618 | 1193 |
text \<open> |
62249 | 1194 |
Formally processed text (prover input or output) contains rich markup that |
1195 |
can be explored by using the \<^verbatim>\<open>CONTROL\<close> modifier key on Linux and Windows, |
|
1196 |
or \<^verbatim>\<open>COMMAND\<close> on Mac OS X. Hovering with the mouse while the modifier is |
|
1197 |
pressed reveals a \<^emph>\<open>tooltip\<close> (grey box over the text with a yellow popup) |
|
1198 |
and/or a \<^emph>\<open>hyperlink\<close> (black rectangle over the text with change of mouse |
|
1199 |
pointer); see also \figref{fig:tooltip}. |
|
54331 | 1200 |
|
62183 | 1201 |
\begin{figure}[!htb] |
54331 | 1202 |
\begin{center} |
57312 | 1203 |
\includegraphics[scale=0.5]{popup1} |
54331 | 1204 |
\end{center} |
54356 | 1205 |
\caption{Tooltip and hyperlink for some formal entity} |
54350 | 1206 |
\label{fig:tooltip} |
54331 | 1207 |
\end{figure} |
1208 |
||
62249 | 1209 |
Tooltip popups use the same rendering technology as the main text area, and |
61574 | 1210 |
further tooltips and/or hyperlinks may be exposed recursively by the same |
1211 |
mechanism; see \figref{fig:nested-tooltips}. |
|
54323 | 1212 |
|
62183 | 1213 |
\begin{figure}[!htb] |
54331 | 1214 |
\begin{center} |
57312 | 1215 |
\includegraphics[scale=0.5]{popup2} |
54331 | 1216 |
\end{center} |
54356 | 1217 |
\caption{Nested tooltips over formal entities} |
54350 | 1218 |
\label{fig:nested-tooltips} |
54331 | 1219 |
\end{figure} |
54350 | 1220 |
|
61574 | 1221 |
The tooltip popup window provides some controls to \<^emph>\<open>close\<close> or \<^emph>\<open>detach\<close> the |
1222 |
window, turning it into a separate \<^emph>\<open>Info\<close> window managed by jEdit. The |
|
1223 |
\<^verbatim>\<open>ESCAPE\<close> key closes \<^emph>\<open>all\<close> popups, which is particularly relevant when |
|
1224 |
nested tooltips are stacking up. |
|
54352 | 1225 |
|
61415 | 1226 |
\<^medskip> |
61574 | 1227 |
A black rectangle in the text indicates a hyperlink that may be followed by |
1228 |
a mouse click (while the \<^verbatim>\<open>CONTROL\<close> or \<^verbatim>\<open>COMMAND\<close> modifier key is still |
|
1229 |
pressed). Such jumps to other text locations are recorded by the |
|
1230 |
\<^emph>\<open>Navigator\<close> plugin, which is bundled with Isabelle/jEdit and enabled by |
|
62249 | 1231 |
default. There are usually navigation arrows in the main jEdit toolbar. |
54352 | 1232 |
|
62249 | 1233 |
Note that the link target may be a file that is itself not subject to formal |
1234 |
document processing of the editor session and thus prevents further |
|
61574 | 1235 |
exploration: the chain of hyperlinks may end in some source file of the |
62249 | 1236 |
underlying logic image, or within the ML bootstrap sources of Isabelle/Pure. |
61574 | 1237 |
\<close> |
54321 | 1238 |
|
1239 |
||
64514 | 1240 |
section \<open>Formal scopes and semantic selection\<close> |
1241 |
||
1242 |
text \<open> |
|
1243 |
Formal entities are semantically annotated in the source text as explained |
|
1244 |
in \secref{sec:tooltips-hyperlinks}. A \<^emph>\<open>formal scope\<close> consists of the |
|
1245 |
defining position with all its referencing positions. This correspondence is |
|
1246 |
highlighted in the text according to the cursor position, see also |
|
1247 |
\figref{fig:scope1}. Here the referencing positions are rendered with an |
|
1248 |
additional border, in reminiscence to a hyperlink: clicking there moves the |
|
1249 |
cursor to the original defining position. |
|
1250 |
||
1251 |
\begin{figure}[!htb] |
|
1252 |
\begin{center} |
|
1253 |
\includegraphics[scale=0.5]{scope1} |
|
1254 |
\end{center} |
|
1255 |
\caption{Scope of formal entity: defining vs.\ referencing positions} |
|
1256 |
\label{fig:scope1} |
|
1257 |
\end{figure} |
|
1258 |
||
1259 |
The action @{action_def "isabelle.select-entity"} (shortcut \<^verbatim>\<open>CS+ENTER\<close>) |
|
1260 |
supports semantic selection of all occurrences of the formal entity at the |
|
1261 |
caret position. This facilitates systematic renaming, using regular jEdit |
|
1262 |
editing of a multi-selection, see also \figref{fig:scope2}. |
|
1263 |
||
1264 |
\begin{figure}[!htb] |
|
1265 |
\begin{center} |
|
1266 |
\includegraphics[scale=0.5]{scope2} |
|
1267 |
\end{center} |
|
1268 |
\caption{The result of semantic selection and systematic renaming} |
|
1269 |
\label{fig:scope2} |
|
1270 |
\end{figure} |
|
1271 |
\<close> |
|
1272 |
||
1273 |
||
58618 | 1274 |
section \<open>Completion \label{sec:completion}\<close> |
57324 | 1275 |
|
58618 | 1276 |
text \<open> |
61477 | 1277 |
Smart completion of partial input is the IDE functionality \<^emph>\<open>par |
1278 |
excellance\<close>. Isabelle/jEdit combines several sources of information to |
|
57328 | 1279 |
achieve that. Despite its complexity, it should be possible to get some idea |
1280 |
how completion works by experimentation, based on the overview of completion |
|
57335 | 1281 |
varieties in \secref{sec:completion-varieties}. The remaining subsections |
1282 |
explain concepts around completion more systematically. |
|
57325 | 1283 |
|
61415 | 1284 |
\<^medskip> |
61477 | 1285 |
\<^emph>\<open>Explicit completion\<close> is triggered by the action @{action_ref |
61574 | 1286 |
"isabelle.complete"}, which is bound to the keyboard shortcut \<^verbatim>\<open>C+b\<close>, and |
1287 |
thus overrides the jEdit default for @{action_ref "complete-word"}. |
|
57335 | 1288 |
|
61574 | 1289 |
\<^emph>\<open>Implicit completion\<close> hooks into the regular keyboard input stream of the |
1290 |
editor, with some event filtering and optional delays. |
|
54361 | 1291 |
|
61415 | 1292 |
\<^medskip> |
61574 | 1293 |
Completion options may be configured in \<^emph>\<open>Plugin Options~/ Isabelle~/ |
1294 |
General~/ Completion\<close>. These are explained in further detail below, whenever |
|
1295 |
relevant. There is also a summary of options in |
|
57328 | 1296 |
\secref{sec:completion-options}. |
1297 |
||
57335 | 1298 |
The asynchronous nature of PIDE interaction means that information from the |
1299 |
prover is delayed --- at least by a full round-trip of the document update |
|
1300 |
protocol. The default options already take this into account, with a |
|
57324 | 1301 |
sufficiently long completion delay to speculate on the availability of all |
57335 | 1302 |
relevant information from the editor and the prover, before completing text |
1303 |
immediately or producing a popup. Although there is an inherent danger of |
|
1304 |
non-deterministic behaviour due to such real-time parameters, the general |
|
1305 |
completion policy aims at determined results as far as possible. |
|
58618 | 1306 |
\<close> |
57324 | 1307 |
|
1308 |
||
58618 | 1309 |
subsection \<open>Varieties of completion \label{sec:completion-varieties}\<close> |
57324 | 1310 |
|
58618 | 1311 |
subsubsection \<open>Built-in templates\<close> |
57324 | 1312 |
|
58618 | 1313 |
text \<open> |
57327 | 1314 |
Isabelle is ultimately a framework of nested sub-languages of different |
57328 | 1315 |
kinds and purposes. The completion mechanism supports this by the following |
1316 |
built-in templates: |
|
1317 |
||
64513 | 1318 |
\<^descr> \<^verbatim>\<open>`\<close> (single ASCII back-quote) or \<^verbatim>\<open>"\<close> (double ASCII quote) support |
1319 |
\<^emph>\<open>quotations\<close> via text cartouches. There are three selections, which are |
|
1320 |
always presented in the same order and do not depend on any context |
|
1321 |
information. The default choice produces a template ``\<open>\<open>\<box>\<close>\<close>'', where the |
|
1322 |
box indicates the cursor position after insertion; the other choices help |
|
1323 |
to repair the block structure of unbalanced text cartouches. |
|
57324 | 1324 |
|
61574 | 1325 |
\<^descr> \<^verbatim>\<open>@{\<close> is completed to the template ``\<open>@{\<box>}\<close>'', where the box indicates |
1326 |
the cursor position after insertion. Here it is convenient to use the |
|
1327 |
wildcard ``\<^verbatim>\<open>__\<close>'' or a more specific name prefix to let semantic |
|
1328 |
completion of name-space entries propose antiquotation names. |
|
57335 | 1329 |
|
1330 |
With some practice, input of quoted sub-languages and antiquotations of |
|
1331 |
embedded languages should work fluently. Note that national keyboard layouts |
|
64513 | 1332 |
might cause problems with back-quote as dead key, but double quote can be |
1333 |
used instead. |
|
58618 | 1334 |
\<close> |
57335 | 1335 |
|
57327 | 1336 |
|
58618 | 1337 |
subsubsection \<open>Syntax keywords\<close> |
57335 | 1338 |
|
58618 | 1339 |
text \<open> |
57335 | 1340 |
Syntax completion tables are determined statically from the keywords of the |
1341 |
``outer syntax'' of the underlying edit mode: for theory files this is the |
|
60257 | 1342 |
syntax of Isar commands according to the cumulative theory imports. |
57327 | 1343 |
|
57335 | 1344 |
Keywords are usually plain words, which means the completion mechanism only |
1345 |
inserts them directly into the text for explicit completion |
|
1346 |
(\secref{sec:completion-input}), but produces a popup |
|
1347 |
(\secref{sec:completion-popup}) otherwise. |
|
1348 |
||
1349 |
At the point where outer syntax keywords are defined, it is possible to |
|
1350 |
specify an alternative replacement string to be inserted instead of the |
|
1351 |
keyword itself. An empty string means to suppress the keyword altogether, |
|
1352 |
which is occasionally useful to avoid confusion, e.g.\ the rare keyword |
|
61493 | 1353 |
@{command simproc_setup} vs.\ the frequent name-space entry \<open>simp\<close>. |
58618 | 1354 |
\<close> |
57324 | 1355 |
|
1356 |
||
58618 | 1357 |
subsubsection \<open>Isabelle symbols\<close> |
57324 | 1358 |
|
58618 | 1359 |
text \<open> |
57325 | 1360 |
The completion tables for Isabelle symbols (\secref{sec:symbols}) are |
63680 | 1361 |
determined statically from \<^file>\<open>$ISABELLE_HOME/etc/symbols\<close> and @{path |
1362 |
"$ISABELLE_HOME_USER/etc/symbols"} for each symbol specification as follows: |
|
57325 | 1363 |
|
61415 | 1364 |
\<^medskip> |
57325 | 1365 |
\begin{tabular}{ll} |
61477 | 1366 |
\<^bold>\<open>completion entry\<close> & \<^bold>\<open>example\<close> \\\hline |
61503 | 1367 |
literal symbol & \<^verbatim>\<open>\<forall>\<close> \\ |
1368 |
symbol name with backslash & \<^verbatim>\<open>\\<close>\<^verbatim>\<open>forall\<close> \\ |
|
1369 |
symbol abbreviation & \<^verbatim>\<open>ALL\<close> or \<^verbatim>\<open>!\<close> \\ |
|
57325 | 1370 |
\end{tabular} |
61415 | 1371 |
\<^medskip> |
57325 | 1372 |
|
57335 | 1373 |
When inserted into the text, the above examples all produce the same Unicode |
61503 | 1374 |
rendering \<open>\<forall>\<close> of the underlying symbol \<^verbatim>\<open>\<forall>\<close>. |
57325 | 1375 |
|
61574 | 1376 |
A symbol abbreviation that is a plain word, like \<^verbatim>\<open>ALL\<close>, is treated like a |
1377 |
syntax keyword. Non-word abbreviations like \<^verbatim>\<open>-->\<close> are inserted more |
|
1378 |
aggressively, except for single-character abbreviations like \<^verbatim>\<open>!\<close> above. |
|
57324 | 1379 |
|
62250 | 1380 |
Completion via abbreviations like \<^verbatim>\<open>ALL\<close> or \<^verbatim>\<open>-->\<close> depends on the semantic |
1381 |
language context (\secref{sec:completion-context}). In contrast, backslash |
|
1382 |
sequences like \<^verbatim>\<open>\forall\<close> \<^verbatim>\<open>\<forall>\<close> are always possible, but require |
|
1383 |
additional interaction to confirm (via popup). |
|
1384 |
||
1385 |
The latter is important in ambiguous situations, e.g.\ for Isabelle document |
|
1386 |
source, which may contain formal symbols or informal {\LaTeX} macros. |
|
1387 |
Backslash sequences also help when input is broken, and thus escapes its |
|
1388 |
normal semantic context: e.g.\ antiquotations or string literals in ML, |
|
1389 |
which do not allow arbitrary backslash sequences. |
|
58618 | 1390 |
\<close> |
57324 | 1391 |
|
1392 |
||
64513 | 1393 |
subsubsection \<open>User-defined abbreviations\<close> |
1394 |
||
1395 |
text \<open> |
|
1396 |
The theory header syntax supports abbreviations via the \<^theory_text>\<open>abbrevs\<close> keyword |
|
1397 |
@{cite "isabelle-isar-ref"}. This is a slight generalization of built-in |
|
1398 |
templates and abbreviations for Isabelle symbols, as explained above. |
|
1399 |
Examples may be found in the Isabelle sources, by searching for |
|
1400 |
``\<^verbatim>\<open>abbrevs\<close>'' in \<^verbatim>\<open>*.thy\<close> files. |
|
1401 |
||
1402 |
The \<^emph>\<open>Symbols\<close> panel shows the abbreviations that are available in the |
|
1403 |
current theory buffer (according to its \<^theory_text>\<open>imports\<close>) in the \<^verbatim>\<open>Abbrevs\<close> tab. |
|
1404 |
\<close> |
|
1405 |
||
1406 |
||
58618 | 1407 |
subsubsection \<open>Name-space entries\<close> |
57324 | 1408 |
|
58618 | 1409 |
text \<open> |
57324 | 1410 |
This is genuine semantic completion, using information from the prover, so |
61477 | 1411 |
it requires some delay. A \<^emph>\<open>failed name-space lookup\<close> produces an error |
57335 | 1412 |
message that is annotated with a list of alternative names that are legal. |
1413 |
The list of results is truncated according to the system option |
|
1414 |
@{system_option_ref completion_limit}. The completion mechanism takes this |
|
1415 |
into account when collecting information on the prover side. |
|
57324 | 1416 |
|
61574 | 1417 |
Already recognized names are \<^emph>\<open>not\<close> completed further, but completion may be |
1418 |
extended by appending a suffix of underscores. This provokes a failed |
|
57328 | 1419 |
lookup, and another completion attempt while ignoring the underscores. For |
61574 | 1420 |
example, in a name space where \<^verbatim>\<open>foo\<close> and \<^verbatim>\<open>foobar\<close> are known, the input |
1421 |
\<^verbatim>\<open>foo\<close> remains unchanged, but \<^verbatim>\<open>foo_\<close> may be completed to \<^verbatim>\<open>foo\<close> or |
|
1422 |
\<^verbatim>\<open>foobar\<close>. |
|
57324 | 1423 |
|
61574 | 1424 |
The special identifier ``\<^verbatim>\<open>__\<close>'' serves as a wild-card for arbitrary |
1425 |
completion: it exposes the name-space content to the completion mechanism |
|
1426 |
(truncated according to @{system_option completion_limit}). This is |
|
1427 |
occasionally useful to explore an unknown name-space, e.g.\ in some |
|
57324 | 1428 |
template. |
58618 | 1429 |
\<close> |
57324 | 1430 |
|
1431 |
||
58618 | 1432 |
subsubsection \<open>File-system paths\<close> |
57324 | 1433 |
|
58618 | 1434 |
text \<open> |
62250 | 1435 |
Depending on prover markup about file-system paths in the source text, e.g.\ |
1436 |
for the argument of a load command (\secref{sec:aux-files}), the completion |
|
1437 |
mechanism explores the directory content and offers the result as completion |
|
1438 |
popup. Relative path specifications are understood wrt.\ the \<^emph>\<open>master |
|
1439 |
directory\<close> of the document node (\secref{sec:buffer-node}) of the enclosing |
|
1440 |
editor buffer; this requires a proper theory, not an auxiliary file. |
|
57324 | 1441 |
|
1442 |
A suffix of slashes may be used to continue the exploration of an already |
|
1443 |
recognized directory name. |
|
58618 | 1444 |
\<close> |
57324 | 1445 |
|
1446 |
||
58618 | 1447 |
subsubsection \<open>Spell-checking\<close> |
57328 | 1448 |
|
58618 | 1449 |
text \<open> |
57328 | 1450 |
The spell-checker combines semantic markup from the prover (regions of plain |
1451 |
words) with static dictionaries (word lists) that are known to the editor. |
|
1452 |
||
57333 | 1453 |
Unknown words are underlined in the text, using @{system_option_ref |
57328 | 1454 |
spell_checker_color} (blue by default). This is not an error, but a hint to |
57335 | 1455 |
the user that some action may be taken. The jEdit context menu provides |
1456 |
various actions, as far as applicable: |
|
57328 | 1457 |
|
61415 | 1458 |
\<^medskip> |
57328 | 1459 |
\begin{tabular}{l} |
57329 | 1460 |
@{action_ref "isabelle.complete-word"} \\ |
1461 |
@{action_ref "isabelle.exclude-word"} \\ |
|
1462 |
@{action_ref "isabelle.exclude-word-permanently"} \\ |
|
1463 |
@{action_ref "isabelle.include-word"} \\ |
|
1464 |
@{action_ref "isabelle.include-word-permanently"} \\ |
|
57328 | 1465 |
\end{tabular} |
61415 | 1466 |
\<^medskip> |
57328 | 1467 |
|
57329 | 1468 |
Instead of the specific @{action_ref "isabelle.complete-word"}, it is also |
1469 |
possible to use the generic @{action_ref "isabelle.complete"} with its |
|
61503 | 1470 |
default keyboard shortcut \<^verbatim>\<open>C+b\<close>. |
57328 | 1471 |
|
61415 | 1472 |
\<^medskip> |
61574 | 1473 |
Dictionary lookup uses some educated guesses about lower-case, upper-case, |
1474 |
and capitalized words. This is oriented on common use in English, where this |
|
62250 | 1475 |
aspect is not decisive for proper spelling (in contrast to German, for |
1476 |
example). |
|
58618 | 1477 |
\<close> |
57328 | 1478 |
|
1479 |
||
58618 | 1480 |
subsection \<open>Semantic completion context \label{sec:completion-context}\<close> |
57325 | 1481 |
|
58618 | 1482 |
text \<open> |
57325 | 1483 |
Completion depends on a semantic context that is provided by the prover, |
1484 |
although with some delay, because at least a full PIDE protocol round-trip |
|
1485 |
is required. Until that information becomes available in the PIDE |
|
1486 |
document-model, the default context is given by the outer syntax of the |
|
1487 |
editor mode (see also \secref{sec:buffer-node}). |
|
1488 |
||
61477 | 1489 |
The semantic \<^emph>\<open>language context\<close> provides information about nested |
62250 | 1490 |
sub-languages of Isabelle: keywords are only completed for outer syntax, and |
1491 |
antiquotations for languages that support them. Symbol abbreviations only |
|
1492 |
work for specific sub-languages: e.g.\ ``\<^verbatim>\<open>=>\<close>'' is \<^emph>\<open>not\<close> completed in |
|
1493 |
regular ML source, but is completed within ML strings, comments, |
|
1494 |
antiquotations. Backslash representations of symbols like ``\<^verbatim>\<open>\foobar\<close>'' or |
|
1495 |
``\<^verbatim>\<open>\<foobar>\<close>'' work in any context --- after additional confirmation. |
|
57325 | 1496 |
|
61574 | 1497 |
The prover may produce \<^emph>\<open>no completion\<close> markup in exceptional situations, to |
1498 |
tell that some language keywords should be excluded from further completion |
|
62250 | 1499 |
attempts. For example, ``\<^verbatim>\<open>:\<close>'' within accepted Isar syntax looses its |
1500 |
meaning as abbreviation for symbol ``\<open>\<in>\<close>''. |
|
58618 | 1501 |
\<close> |
57325 | 1502 |
|
1503 |
||
58618 | 1504 |
subsection \<open>Input events \label{sec:completion-input}\<close> |
57324 | 1505 |
|
58618 | 1506 |
text \<open> |
57332 | 1507 |
Completion is triggered by certain events produced by the user, with |
1508 |
optional delay after keyboard input according to @{system_option |
|
1509 |
jedit_completion_delay}. |
|
57325 | 1510 |
|
61574 | 1511 |
\<^descr>[Explicit completion] works via action @{action_ref "isabelle.complete"} |
1512 |
with keyboard shortcut \<^verbatim>\<open>C+b\<close>. This overrides the shortcut for @{action_ref |
|
1513 |
"complete-word"} in jEdit, but it is possible to restore the original jEdit |
|
1514 |
keyboard mapping of @{action "complete-word"} via \<^emph>\<open>Global Options~/ |
|
1515 |
Shortcuts\<close> and invent a different one for @{action "isabelle.complete"}. |
|
57325 | 1516 |
|
61439 | 1517 |
\<^descr>[Explicit spell-checker completion] works via @{action_ref |
57332 | 1518 |
"isabelle.complete-word"}, which is exposed in the jEdit context menu, if |
1519 |
the mouse points to a word that the spell-checker can complete. |
|
1520 |
||
61574 | 1521 |
\<^descr>[Implicit completion] works via regular keyboard input of the editor. It |
1522 |
depends on further side-conditions: |
|
57325 | 1523 |
|
61574 | 1524 |
\<^enum> The system option @{system_option_ref jedit_completion} needs to be |
1525 |
enabled (default). |
|
57325 | 1526 |
|
61574 | 1527 |
\<^enum> Completion of syntax keywords requires at least 3 relevant characters in |
1528 |
the text. |
|
57325 | 1529 |
|
61574 | 1530 |
\<^enum> The system option @{system_option_ref jedit_completion_delay} determines |
1531 |
an additional delay (0.5 by default), before opening a completion popup. |
|
1532 |
The delay gives the prover a chance to provide semantic completion |
|
61458 | 1533 |
information, notably the context (\secref{sec:completion-context}). |
57325 | 1534 |
|
61458 | 1535 |
\<^enum> The system option @{system_option_ref jedit_completion_immediate} |
1536 |
(enabled by default) controls whether replacement text should be inserted |
|
1537 |
immediately without popup, regardless of @{system_option |
|
61574 | 1538 |
jedit_completion_delay}. This aggressive mode of completion is restricted |
62250 | 1539 |
to symbol abbreviations that are not plain words (\secref{sec:symbols}). |
57325 | 1540 |
|
61574 | 1541 |
\<^enum> Completion of symbol abbreviations with only one relevant character in |
1542 |
the text always enforces an explicit popup, regardless of |
|
1543 |
@{system_option_ref jedit_completion_immediate}. |
|
58618 | 1544 |
\<close> |
57324 | 1545 |
|
1546 |
||
58618 | 1547 |
subsection \<open>Completion popup \label{sec:completion-popup}\<close> |
57324 | 1548 |
|
58618 | 1549 |
text \<open> |
61574 | 1550 |
A \<^emph>\<open>completion popup\<close> is a minimally invasive GUI component over the text |
1551 |
area that offers a selection of completion items to be inserted into the |
|
1552 |
text, e.g.\ by mouse clicks. Items are sorted dynamically, according to the |
|
1553 |
frequency of selection, with persistent history. The popup may interpret |
|
1554 |
special keys \<^verbatim>\<open>ENTER\<close>, \<^verbatim>\<open>TAB\<close>, \<^verbatim>\<open>ESCAPE\<close>, \<^verbatim>\<open>UP\<close>, \<^verbatim>\<open>DOWN\<close>, \<^verbatim>\<open>PAGE_UP\<close>, |
|
1555 |
\<^verbatim>\<open>PAGE_DOWN\<close>, but all other key events are passed to the underlying text |
|
1556 |
area. This allows to ignore unwanted completions most of the time and |
|
1557 |
continue typing quickly. Thus the popup serves as a mechanism of |
|
62250 | 1558 |
confirmation of proposed items, while the default is to continue without |
61574 | 1559 |
completion. |
57324 | 1560 |
|
1561 |
The meaning of special keys is as follows: |
|
1562 |
||
61415 | 1563 |
\<^medskip> |
57324 | 1564 |
\begin{tabular}{ll} |
61477 | 1565 |
\<^bold>\<open>key\<close> & \<^bold>\<open>action\<close> \\\hline |
61503 | 1566 |
\<^verbatim>\<open>ENTER\<close> & select completion (if @{system_option jedit_completion_select_enter}) \\ |
1567 |
\<^verbatim>\<open>TAB\<close> & select completion (if @{system_option jedit_completion_select_tab}) \\ |
|
1568 |
\<^verbatim>\<open>ESCAPE\<close> & dismiss popup \\ |
|
1569 |
\<^verbatim>\<open>UP\<close> & move up one item \\ |
|
1570 |
\<^verbatim>\<open>DOWN\<close> & move down one item \\ |
|
1571 |
\<^verbatim>\<open>PAGE_UP\<close> & move up one page of items \\ |
|
1572 |
\<^verbatim>\<open>PAGE_DOWN\<close> & move down one page of items \\ |
|
57324 | 1573 |
\end{tabular} |
61415 | 1574 |
\<^medskip> |
57324 | 1575 |
|
61574 | 1576 |
Movement within the popup is only active for multiple items. Otherwise the |
1577 |
corresponding key event retains its standard meaning within the underlying |
|
1578 |
text area. |
|
58618 | 1579 |
\<close> |
57324 | 1580 |
|
1581 |
||
58618 | 1582 |
subsection \<open>Insertion \label{sec:completion-insert}\<close> |
57324 | 1583 |
|
58618 | 1584 |
text \<open> |
57333 | 1585 |
Completion may first propose replacements to be selected (via a popup), or |
1586 |
replace text immediately in certain situations and depending on certain |
|
1587 |
options like @{system_option jedit_completion_immediate}. In any case, |
|
57420 | 1588 |
insertion works uniformly, by imitating normal jEdit text insertion, |
61477 | 1589 |
depending on the state of the \<^emph>\<open>text selection\<close>. Isabelle/jEdit tries to |
57420 | 1590 |
accommodate the most common forms of advanced selections in jEdit, but not |
1591 |
all combinations make sense. At least the following important cases are |
|
1592 |
well-defined: |
|
57333 | 1593 |
|
61574 | 1594 |
\<^descr>[No selection.] The original is removed and the replacement inserted, |
1595 |
depending on the caret position. |
|
57324 | 1596 |
|
61574 | 1597 |
\<^descr>[Rectangular selection of zero width.] This special case is treated by |
1598 |
jEdit as ``tall caret'' and insertion of completion imitates its normal |
|
1599 |
behaviour: separate copies of the replacement are inserted for each line |
|
1600 |
of the selection. |
|
57333 | 1601 |
|
61574 | 1602 |
\<^descr>[Other rectangular selection or multiple selections.] Here the original |
1603 |
is removed and the replacement is inserted for each line (or segment) of |
|
1604 |
the selection. |
|
57333 | 1605 |
|
61574 | 1606 |
Support for multiple selections is particularly useful for \<^emph>\<open>HyperSearch\<close>: |
1607 |
clicking on one of the items in the \<^emph>\<open>HyperSearch Results\<close> window makes |
|
1608 |
jEdit select all its occurrences in the corresponding line of text. Then |
|
1609 |
explicit completion can be invoked via \<^verbatim>\<open>C+b\<close>, e.g.\ to replace occurrences |
|
1610 |
of \<^verbatim>\<open>-->\<close> by \<open>\<longrightarrow>\<close>. |
|
57333 | 1611 |
|
61415 | 1612 |
\<^medskip> |
61574 | 1613 |
Insertion works by removing and inserting pieces of text from the buffer. |
1614 |
This counts as one atomic operation on the jEdit history. Thus unintended |
|
1615 |
completions may be reverted by the regular @{action undo} action of jEdit. |
|
1616 |
According to normal jEdit policies, the recovered text after @{action undo} |
|
1617 |
is selected: \<^verbatim>\<open>ESCAPE\<close> is required to reset the selection and to continue |
|
1618 |
typing more text. |
|
58618 | 1619 |
\<close> |
57324 | 1620 |
|
1621 |
||
58618 | 1622 |
subsection \<open>Options \label{sec:completion-options}\<close> |
57324 | 1623 |
|
58618 | 1624 |
text \<open> |
57324 | 1625 |
This is a summary of Isabelle/Scala system options that are relevant for |
61574 | 1626 |
completion. They may be configured in \<^emph>\<open>Plugin Options~/ Isabelle~/ General\<close> |
1627 |
as usual. |
|
57332 | 1628 |
|
61415 | 1629 |
\<^item> @{system_option_def completion_limit} specifies the maximum number of |
60257 | 1630 |
items for various semantic completion operations (name-space entries etc.) |
57332 | 1631 |
|
61415 | 1632 |
\<^item> @{system_option_def jedit_completion} guards implicit completion via |
57335 | 1633 |
regular jEdit key events (\secref{sec:completion-input}): it allows to |
1634 |
disable implicit completion altogether. |
|
57324 | 1635 |
|
61574 | 1636 |
\<^item> @{system_option_def jedit_completion_select_enter} and @{system_option_def |
1637 |
jedit_completion_select_tab} enable keys to select a completion item from |
|
1638 |
the popup (\secref{sec:completion-popup}). Note that a regular mouse click |
|
1639 |
on the list of items is always possible. |
|
57833
2c2bae3da1c2
completion popup supports both ENTER and TAB (default);
wenzelm
parents:
57822
diff
changeset
|
1640 |
|
61415 | 1641 |
\<^item> @{system_option_def jedit_completion_context} specifies whether the |
57335 | 1642 |
language context provided by the prover should be used at all. Disabling |
1643 |
that option makes completion less ``semantic''. Note that incomplete or |
|
1644 |
severely broken input may cause some disagreement of the prover and the user |
|
1645 |
about the intended language context. |
|
57332 | 1646 |
|
61415 | 1647 |
\<^item> @{system_option_def jedit_completion_delay} and @{system_option_def |
57333 | 1648 |
jedit_completion_immediate} determine the handling of keyboard events for |
1649 |
implicit completion (\secref{sec:completion-input}). |
|
57332 | 1650 |
|
61574 | 1651 |
A @{system_option jedit_completion_delay}~\<^verbatim>\<open>> 0\<close> postpones the processing of |
1652 |
key events, until after the user has stopped typing for the given time span, |
|
62250 | 1653 |
but @{system_option jedit_completion_immediate}~\<^verbatim>\<open>= true\<close> means that |
61574 | 1654 |
abbreviations of Isabelle symbols are handled nonetheless. |
57332 | 1655 |
|
66158 | 1656 |
\<^item> @{system_option_def completion_path_ignore} specifies ``glob'' |
57335 | 1657 |
patterns to ignore in file-system path completion (separated by colons), |
1658 |
e.g.\ backup files ending with tilde. |
|
57332 | 1659 |
|
61574 | 1660 |
\<^item> @{system_option_def spell_checker} is a global guard for all spell-checker |
1661 |
operations: it allows to disable that mechanism altogether. |
|
57332 | 1662 |
|
61415 | 1663 |
\<^item> @{system_option_def spell_checker_dictionary} determines the current |
57335 | 1664 |
dictionary, taken from the colon-separated list in the settings variable |
57333 | 1665 |
@{setting_def JORTHO_DICTIONARIES}. There are jEdit actions to specify local |
1666 |
updates to a dictionary, by including or excluding words. The result of |
|
63669 | 1667 |
permanent dictionary updates is stored in the directory @{path |
57335 | 1668 |
"$ISABELLE_HOME_USER/dictionaries"}, in a separate file for each dictionary. |
57332 | 1669 |
|
67395
b39d596b77ce
more accurate spell-checking for nested quotations / antiquotations, notably in formal comments;
wenzelm
parents:
67304
diff
changeset
|
1670 |
\<^item> @{system_option_def spell_checker_include} specifies a comma-separated |
61574 | 1671 |
list of markup elements that delimit words in the source that is subject to |
1672 |
spell-checking, including various forms of comments. |
|
67395
b39d596b77ce
more accurate spell-checking for nested quotations / antiquotations, notably in formal comments;
wenzelm
parents:
67304
diff
changeset
|
1673 |
|
b39d596b77ce
more accurate spell-checking for nested quotations / antiquotations, notably in formal comments;
wenzelm
parents:
67304
diff
changeset
|
1674 |
\<^item> @{system_option_def spell_checker_exclude} specifies a comma-separated |
b39d596b77ce
more accurate spell-checking for nested quotations / antiquotations, notably in formal comments;
wenzelm
parents:
67304
diff
changeset
|
1675 |
list of markup elements that disable spell-checking (e.g.\ in nested |
b39d596b77ce
more accurate spell-checking for nested quotations / antiquotations, notably in formal comments;
wenzelm
parents:
67304
diff
changeset
|
1676 |
antiquotations). |
58618 | 1677 |
\<close> |
54361 | 1678 |
|
1679 |
||
58618 | 1680 |
section \<open>Automatically tried tools \label{sec:auto-tools}\<close> |
54353 | 1681 |
|
58618 | 1682 |
text \<open> |
57325 | 1683 |
Continuous document processing works asynchronously in the background. |
1684 |
Visible document source that has been evaluated may get augmented by |
|
62251 | 1685 |
additional results of \<^emph>\<open>asynchronous print functions\<close>. An example for that |
1686 |
is proof state output, if that is enabled in the Output panel |
|
1687 |
(\secref{sec:output}). More heavy-weight print functions may be applied as |
|
1688 |
well, e.g.\ to prove or disprove parts of the formal text by other means. |
|
54354 | 1689 |
|
61574 | 1690 |
Isabelle/HOL provides various automatically tried tools that operate on |
1691 |
outermost goal statements (e.g.\ @{command lemma}, @{command theorem}), |
|
1692 |
independently of the state of the current proof attempt. They work |
|
1693 |
implicitly without any arguments. Results are output as \<^emph>\<open>information |
|
1694 |
messages\<close>, which are indicated in the text area by blue squiggles and a blue |
|
1695 |
information sign in the gutter (see \figref{fig:auto-tools}). The message |
|
1696 |
content may be shown as for other output (see also \secref{sec:output}). |
|
1697 |
Some tools produce output with \<^emph>\<open>sendback\<close> markup, which means that clicking |
|
62251 | 1698 |
on certain parts of the text inserts that into the source in the proper |
1699 |
place. |
|
54356 | 1700 |
|
62183 | 1701 |
\begin{figure}[!htb] |
54356 | 1702 |
\begin{center} |
57312 | 1703 |
\includegraphics[scale=0.333]{auto-tools} |
54356 | 1704 |
\end{center} |
57312 | 1705 |
\caption{Result of automatically tried tools} |
54356 | 1706 |
\label{fig:auto-tools} |
1707 |
\end{figure} |
|
54354 | 1708 |
|
61415 | 1709 |
\<^medskip> |
61574 | 1710 |
The following Isabelle system options control the behavior of automatically |
1711 |
tried tools (see also the jEdit dialog window \<^emph>\<open>Plugin Options~/ Isabelle~/ |
|
1712 |
General~/ Automatically tried tools\<close>): |
|
54354 | 1713 |
|
61574 | 1714 |
\<^item> @{system_option_ref auto_methods} controls automatic use of a combination |
1715 |
of standard proof methods (@{method auto}, @{method simp}, @{method blast}, |
|
1716 |
etc.). This corresponds to the Isar command @{command_ref "try0"} @{cite |
|
1717 |
"isabelle-isar-ref"}. |
|
54354 | 1718 |
|
1719 |
The tool is disabled by default, since unparameterized invocation of |
|
61574 | 1720 |
standard proof methods often consumes substantial CPU resources without |
1721 |
leading to success. |
|
54354 | 1722 |
|
61574 | 1723 |
\<^item> @{system_option_ref auto_nitpick} controls a slightly reduced version of |
1724 |
@{command_ref nitpick}, which tests for counterexamples using first-order |
|
1725 |
relational logic. See also the Nitpick manual @{cite "isabelle-nitpick"}. |
|
54354 | 1726 |
|
61574 | 1727 |
This tool is disabled by default, due to the extra overhead of invoking an |
1728 |
external Java process for each attempt to disprove a subgoal. |
|
54354 | 1729 |
|
61415 | 1730 |
\<^item> @{system_option_ref auto_quickcheck} controls automatic use of |
61574 | 1731 |
@{command_ref quickcheck}, which tests for counterexamples using a series of |
1732 |
assignments for free variables of a subgoal. |
|
54354 | 1733 |
|
61574 | 1734 |
This tool is \<^emph>\<open>enabled\<close> by default. It requires little overhead, but is a |
1735 |
bit weaker than @{command nitpick}. |
|
54354 | 1736 |
|
61574 | 1737 |
\<^item> @{system_option_ref auto_sledgehammer} controls a significantly reduced |
1738 |
version of @{command_ref sledgehammer}, which attempts to prove a subgoal |
|
1739 |
using external automatic provers. See also the Sledgehammer manual @{cite |
|
1740 |
"isabelle-sledgehammer"}. |
|
54354 | 1741 |
|
61574 | 1742 |
This tool is disabled by default, due to the relatively heavy nature of |
1743 |
Sledgehammer. |
|
54354 | 1744 |
|
61415 | 1745 |
\<^item> @{system_option_ref auto_solve_direct} controls automatic use of |
61574 | 1746 |
@{command_ref solve_direct}, which checks whether the current subgoals can |
1747 |
be solved directly by an existing theorem. This also helps to detect |
|
1748 |
duplicate lemmas. |
|
54354 | 1749 |
|
61477 | 1750 |
This tool is \<^emph>\<open>enabled\<close> by default. |
54354 | 1751 |
|
1752 |
||
61574 | 1753 |
Invocation of automatically tried tools is subject to some global policies |
1754 |
of parallel execution, which may be configured as follows: |
|
54354 | 1755 |
|
61574 | 1756 |
\<^item> @{system_option_ref auto_time_limit} (default 2.0) determines the timeout |
1757 |
(in seconds) for each tool execution. |
|
54354 | 1758 |
|
61574 | 1759 |
\<^item> @{system_option_ref auto_time_start} (default 1.0) determines the start |
1760 |
delay (in seconds) for automatically tried tools, after the main command |
|
1761 |
evaluation is finished. |
|
54354 | 1762 |
|
1763 |
||
61574 | 1764 |
Each tool is submitted independently to the pool of parallel execution tasks |
1765 |
in Isabelle/ML, using hardwired priorities according to its relative |
|
1766 |
``heaviness''. The main stages of evaluation and printing of proof states |
|
1767 |
take precedence, but an already running tool is not canceled and may thus |
|
1768 |
reduce reactivity of proof document processing. |
|
54354 | 1769 |
|
61574 | 1770 |
Users should experiment how the available CPU resources (number of cores) |
1771 |
are best invested to get additional feedback from prover in the background, |
|
1772 |
by using a selection of weaker or stronger tools. |
|
58618 | 1773 |
\<close> |
54353 | 1774 |
|
1775 |
||
58618 | 1776 |
section \<open>Sledgehammer \label{sec:sledgehammer}\<close> |
54353 | 1777 |
|
61574 | 1778 |
text \<open> |
1779 |
The \<^emph>\<open>Sledgehammer\<close> panel (\figref{fig:sledgehammer}) provides a view on |
|
1780 |
some independent execution of the Isar command @{command_ref sledgehammer}, |
|
1781 |
with process indicator (spinning wheel) and GUI elements for important |
|
1782 |
Sledgehammer arguments and options. Any number of Sledgehammer panels may be |
|
1783 |
active, according to the standard policies of Dockable Window Management in |
|
1784 |
jEdit. Closing such windows also cancels the corresponding prover tasks. |
|
54356 | 1785 |
|
62183 | 1786 |
\begin{figure}[!htb] |
54356 | 1787 |
\begin{center} |
57312 | 1788 |
\includegraphics[scale=0.333]{sledgehammer} |
54356 | 1789 |
\end{center} |
1790 |
\caption{An instance of the Sledgehammer panel} |
|
1791 |
\label{fig:sledgehammer} |
|
1792 |
\end{figure} |
|
54355 | 1793 |
|
61574 | 1794 |
The \<^emph>\<open>Apply\<close> button attaches a fresh invocation of @{command sledgehammer} |
1795 |
to the command where the cursor is pointing in the text --- this should be |
|
1796 |
some pending proof problem. Further buttons like \<^emph>\<open>Cancel\<close> and \<^emph>\<open>Locate\<close> |
|
1797 |
help to manage the running process. |
|
54355 | 1798 |
|
61574 | 1799 |
Results appear incrementally in the output window of the panel. Proposed |
1800 |
proof snippets are marked-up as \<^emph>\<open>sendback\<close>, which means a single mouse |
|
1801 |
click inserts the text into a suitable place of the original source. Some |
|
1802 |
manual editing may be required nonetheless, say to remove earlier proof |
|
1803 |
attempts. |
|
1804 |
\<close> |
|
54353 | 1805 |
|
1806 |
||
60255
0466bd194d74
more on Isabelle document preparation and bibtex files;
wenzelm
parents:
58618
diff
changeset
|
1807 |
chapter \<open>Isabelle document preparation\<close> |
0466bd194d74
more on Isabelle document preparation and bibtex files;
wenzelm
parents:
58618
diff
changeset
|
1808 |
|
61574 | 1809 |
text \<open> |
1810 |
The ultimate purpose of Isabelle is to produce nicely rendered documents |
|
60255
0466bd194d74
more on Isabelle document preparation and bibtex files;
wenzelm
parents:
58618
diff
changeset
|
1811 |
with the Isabelle document preparation system, which is based on {\LaTeX}; |
60270 | 1812 |
see also @{cite "isabelle-system" and "isabelle-isar-ref"}. Isabelle/jEdit |
61574 | 1813 |
provides some additional support for document editing. |
1814 |
\<close> |
|
60255
0466bd194d74
more on Isabelle document preparation and bibtex files;
wenzelm
parents:
58618
diff
changeset
|
1815 |
|
0466bd194d74
more on Isabelle document preparation and bibtex files;
wenzelm
parents:
58618
diff
changeset
|
1816 |
|
0466bd194d74
more on Isabelle document preparation and bibtex files;
wenzelm
parents:
58618
diff
changeset
|
1817 |
section \<open>Document outline\<close> |
0466bd194d74
more on Isabelle document preparation and bibtex files;
wenzelm
parents:
58618
diff
changeset
|
1818 |
|
61574 | 1819 |
text \<open> |
1820 |
Theory sources may contain document markup commands, such as @{command_ref |
|
1821 |
chapter}, @{command_ref section}, @{command subsection}. The Isabelle |
|
1822 |
SideKick parser (\secref{sec:sidekick}) represents this document outline as |
|
1823 |
structured tree view, with formal statements and proofs nested inside; see |
|
1824 |
\figref{fig:sidekick-document}. |
|
60255
0466bd194d74
more on Isabelle document preparation and bibtex files;
wenzelm
parents:
58618
diff
changeset
|
1825 |
|
62183 | 1826 |
\begin{figure}[!htb] |
60255
0466bd194d74
more on Isabelle document preparation and bibtex files;
wenzelm
parents:
58618
diff
changeset
|
1827 |
\begin{center} |
0466bd194d74
more on Isabelle document preparation and bibtex files;
wenzelm
parents:
58618
diff
changeset
|
1828 |
\includegraphics[scale=0.333]{sidekick-document} |
0466bd194d74
more on Isabelle document preparation and bibtex files;
wenzelm
parents:
58618
diff
changeset
|
1829 |
\end{center} |
0466bd194d74
more on Isabelle document preparation and bibtex files;
wenzelm
parents:
58618
diff
changeset
|
1830 |
\caption{Isabelle document outline via SideKick tree view} |
0466bd194d74
more on Isabelle document preparation and bibtex files;
wenzelm
parents:
58618
diff
changeset
|
1831 |
\label{fig:sidekick-document} |
0466bd194d74
more on Isabelle document preparation and bibtex files;
wenzelm
parents:
58618
diff
changeset
|
1832 |
\end{figure} |
60264 | 1833 |
|
1834 |
It is also possible to use text folding according to this structure, by |
|
61574 | 1835 |
adjusting \<^emph>\<open>Utilities / Buffer Options / Folding mode\<close> of jEdit. The default |
1836 |
mode \<^verbatim>\<open>isabelle\<close> uses the structure of formal definitions, statements, and |
|
1837 |
proofs. The alternative mode \<^verbatim>\<open>sidekick\<close> uses the document structure of the |
|
1838 |
SideKick parser, as explained above. |
|
1839 |
\<close> |
|
60264 | 1840 |
|
60255
0466bd194d74
more on Isabelle document preparation and bibtex files;
wenzelm
parents:
58618
diff
changeset
|
1841 |
|
62154 | 1842 |
section \<open>Markdown structure\<close> |
1843 |
||
1844 |
text \<open> |
|
62251 | 1845 |
Document text is internally structured in paragraphs and nested lists, using |
63680 | 1846 |
notation that is similar to Markdown\<^footnote>\<open>\<^url>\<open>http://commonmark.org\<close>\<close>. There are |
1847 |
special control symbols for items of different kinds of lists, corresponding |
|
1848 |
to \<^verbatim>\<open>itemize\<close>, \<^verbatim>\<open>enumerate\<close>, \<^verbatim>\<open>description\<close> in {\LaTeX}. This is illustrated |
|
1849 |
in for \<^verbatim>\<open>itemize\<close> in \figref{fig:markdown-document}. |
|
62154 | 1850 |
|
62183 | 1851 |
\begin{figure}[!htb] |
62154 | 1852 |
\begin{center} |
1853 |
\includegraphics[scale=0.333]{markdown-document} |
|
1854 |
\end{center} |
|
1855 |
\caption{Markdown structure within document text} |
|
1856 |
\label{fig:markdown-document} |
|
1857 |
\end{figure} |
|
62251 | 1858 |
|
1859 |
Items take colour according to the depth of nested lists. This helps to |
|
1860 |
explore the implicit rules for list structure interactively. There is also |
|
1861 |
markup for individual paragraphs in the text: it may be explored via mouse |
|
1862 |
hovering with \<^verbatim>\<open>CONTROL\<close> / \<^verbatim>\<open>COMMAND\<close> as usual |
|
1863 |
(\secref{sec:tooltips-hyperlinks}). |
|
62154 | 1864 |
\<close> |
1865 |
||
1866 |
||
62184 | 1867 |
section \<open>Citations and Bib{\TeX} entries \label{sec:bibtex}\<close> |
60255
0466bd194d74
more on Isabelle document preparation and bibtex files;
wenzelm
parents:
58618
diff
changeset
|
1868 |
|
61574 | 1869 |
text \<open> |
1870 |
Citations are managed by {\LaTeX} and Bib{\TeX} in \<^verbatim>\<open>.bib\<close> files. The |
|
1871 |
Isabelle session build process and the @{tool latex} tool @{cite |
|
60270 | 1872 |
"isabelle-system"} are smart enough to assemble the result, based on the |
60257 | 1873 |
session directory layout. |
60255
0466bd194d74
more on Isabelle document preparation and bibtex files;
wenzelm
parents:
58618
diff
changeset
|
1874 |
|
61493 | 1875 |
The document antiquotation \<open>@{cite}\<close> is described in @{cite |
60255
0466bd194d74
more on Isabelle document preparation and bibtex files;
wenzelm
parents:
58618
diff
changeset
|
1876 |
"isabelle-isar-ref"}. Within the Prover IDE it provides semantic markup for |
0466bd194d74
more on Isabelle document preparation and bibtex files;
wenzelm
parents:
58618
diff
changeset
|
1877 |
tooltips, hyperlinks, and completion for Bib{\TeX} database entries. |
61574 | 1878 |
Isabelle/jEdit does \<^emph>\<open>not\<close> know about the actual Bib{\TeX} environment used |
1879 |
in {\LaTeX} batch-mode, but it can take citations from those \<^verbatim>\<open>.bib\<close> files |
|
1880 |
that happen to be open in the editor; see \figref{fig:cite-completion}. |
|
60255
0466bd194d74
more on Isabelle document preparation and bibtex files;
wenzelm
parents:
58618
diff
changeset
|
1881 |
|
62183 | 1882 |
\begin{figure}[!htb] |
60255
0466bd194d74
more on Isabelle document preparation and bibtex files;
wenzelm
parents:
58618
diff
changeset
|
1883 |
\begin{center} |
0466bd194d74
more on Isabelle document preparation and bibtex files;
wenzelm
parents:
58618
diff
changeset
|
1884 |
\includegraphics[scale=0.333]{cite-completion} |
0466bd194d74
more on Isabelle document preparation and bibtex files;
wenzelm
parents:
58618
diff
changeset
|
1885 |
\end{center} |
0466bd194d74
more on Isabelle document preparation and bibtex files;
wenzelm
parents:
58618
diff
changeset
|
1886 |
\caption{Semantic completion of citations from open Bib{\TeX} files} |
0466bd194d74
more on Isabelle document preparation and bibtex files;
wenzelm
parents:
58618
diff
changeset
|
1887 |
\label{fig:cite-completion} |
0466bd194d74
more on Isabelle document preparation and bibtex files;
wenzelm
parents:
58618
diff
changeset
|
1888 |
\end{figure} |
0466bd194d74
more on Isabelle document preparation and bibtex files;
wenzelm
parents:
58618
diff
changeset
|
1889 |
|
61574 | 1890 |
Isabelle/jEdit also provides some support for editing \<^verbatim>\<open>.bib\<close> files |
1891 |
themselves. There is syntax highlighting based on entry types (according to |
|
1892 |
standard Bib{\TeX} styles), a context-menu to compose entries |
|
60255
0466bd194d74
more on Isabelle document preparation and bibtex files;
wenzelm
parents:
58618
diff
changeset
|
1893 |
systematically, and a SideKick tree view of the overall content; see |
0466bd194d74
more on Isabelle document preparation and bibtex files;
wenzelm
parents:
58618
diff
changeset
|
1894 |
\figref{fig:bibtex-mode}. |
0466bd194d74
more on Isabelle document preparation and bibtex files;
wenzelm
parents:
58618
diff
changeset
|
1895 |
|
62183 | 1896 |
\begin{figure}[!htb] |
60255
0466bd194d74
more on Isabelle document preparation and bibtex files;
wenzelm
parents:
58618
diff
changeset
|
1897 |
\begin{center} |
0466bd194d74
more on Isabelle document preparation and bibtex files;
wenzelm
parents:
58618
diff
changeset
|
1898 |
\includegraphics[scale=0.333]{bibtex-mode} |
0466bd194d74
more on Isabelle document preparation and bibtex files;
wenzelm
parents:
58618
diff
changeset
|
1899 |
\end{center} |
0466bd194d74
more on Isabelle document preparation and bibtex files;
wenzelm
parents:
58618
diff
changeset
|
1900 |
\caption{Bib{\TeX} mode with context menu and SideKick tree view} |
0466bd194d74
more on Isabelle document preparation and bibtex files;
wenzelm
parents:
58618
diff
changeset
|
1901 |
\label{fig:bibtex-mode} |
0466bd194d74
more on Isabelle document preparation and bibtex files;
wenzelm
parents:
58618
diff
changeset
|
1902 |
\end{figure} |
0466bd194d74
more on Isabelle document preparation and bibtex files;
wenzelm
parents:
58618
diff
changeset
|
1903 |
\<close> |
0466bd194d74
more on Isabelle document preparation and bibtex files;
wenzelm
parents:
58618
diff
changeset
|
1904 |
|
0466bd194d74
more on Isabelle document preparation and bibtex files;
wenzelm
parents:
58618
diff
changeset
|
1905 |
|
66683 | 1906 |
section \<open>Document preview\<close> |
1907 |
||
1908 |
text \<open> |
|
1909 |
The action @{action_def isabelle.preview} opens an HTML preview of the |
|
67246
4cedf44f2af1
isabelle.preview presents auxiliary text files as well;
wenzelm
parents:
67092
diff
changeset
|
1910 |
current document node in the default web browser. The content is derived |
66683 | 1911 |
from the semantic markup produced by the prover, and thus depends on the |
1912 |
status of formal processing. |
|
67262 | 1913 |
|
1914 |
Action @{action_def isabelle.draft} is similar to @{action |
|
1915 |
isabelle.preview}, but shows a plain-text document draft. |
|
66683 | 1916 |
\<close> |
1917 |
||
1918 |
||
62253 | 1919 |
chapter \<open>ML debugging within the Prover IDE\<close> |
62154 | 1920 |
|
1921 |
text \<open> |
|
68224 | 1922 |
Isabelle/ML is based on Poly/ML\<^footnote>\<open>\<^url>\<open>https://www.polyml.org\<close>\<close> and thus |
62253 | 1923 |
benefits from the source-level debugger of that implementation of Standard |
1924 |
ML. The Prover IDE provides the \<^emph>\<open>Debugger\<close> dockable to connect to running |
|
1925 |
ML threads, inspect the stack frame with local ML bindings, and evaluate ML |
|
1926 |
expressions in a particular run-time context. A typical debugger session is |
|
1927 |
shown in \figref{fig:ml-debugger}. |
|
1928 |
||
1929 |
ML debugging depends on the following pre-requisites. |
|
1930 |
||
1931 |
\<^enum> ML source needs to be compiled with debugging enabled. This may be |
|
1932 |
controlled for particular chunks of ML sources using any of the subsequent |
|
1933 |
facilities. |
|
1934 |
||
1935 |
\<^enum> The system option @{system_option_ref ML_debugger} as implicit state |
|
1936 |
of the Isabelle process. It may be changed in the menu \<^emph>\<open>Plugins / |
|
1937 |
Plugin Options / Isabelle / General\<close>. ML modules need to be reloaded and |
|
1938 |
recompiled to pick up that option as intended. |
|
1939 |
||
1940 |
\<^enum> The configuration option @{attribute_ref ML_debugger}, with an |
|
1941 |
attribute of the same name, to update a global or local context (e.g.\ |
|
1942 |
with the @{command declare} command). |
|
1943 |
||
1944 |
\<^enum> Commands that modify @{attribute ML_debugger} state for individual |
|
1945 |
files: @{command_ref ML_file_debug}, @{command_ref ML_file_no_debug}, |
|
1946 |
@{command_ref SML_file_debug}, @{command_ref SML_file_no_debug}. |
|
1947 |
||
1948 |
The instrumentation of ML code for debugging causes minor run-time |
|
1949 |
overhead. ML modules that implement critical system infrastructure may |
|
1950 |
lead to deadlocks or other undefined behaviour, when put under debugger |
|
1951 |
control! |
|
1952 |
||
1953 |
\<^enum> The \<^emph>\<open>Debugger\<close> panel needs to be active, otherwise the program ignores |
|
1954 |
debugger instrumentation of the compiler and runs unmanaged. It is also |
|
1955 |
possible to start debugging with the panel open, and later undock it, to |
|
1956 |
let the program continue unhindered. |
|
1957 |
||
1958 |
\<^enum> The ML program needs to be stopped at a suitable breakpoint, which may |
|
1959 |
be activated individually or globally as follows. |
|
1960 |
||
1961 |
For ML sources that have been compiled with debugger support, the IDE |
|
1962 |
visualizes possible breakpoints in the text. A breakpoint may be toggled |
|
1963 |
by pointing accurately with the mouse, with a right-click to activate |
|
1964 |
jEdit's context menu and its \<^emph>\<open>Toggle Breakpoint\<close> item. Alternatively, the |
|
1965 |
\<^emph>\<open>Break\<close> checkbox in the \<^emph>\<open>Debugger\<close> panel may be enabled to stop ML |
|
1966 |
threads always at the next possible breakpoint. |
|
1967 |
||
1968 |
Note that the state of individual breakpoints \<^emph>\<open>gets lost\<close> when the |
|
1969 |
coresponding ML source is re-compiled! This may happen unintentionally, |
|
1970 |
e.g.\ when following hyperlinks into ML modules that have not been loaded |
|
1971 |
into the IDE before. |
|
62154 | 1972 |
|
62183 | 1973 |
\begin{figure}[!htb] |
62154 | 1974 |
\begin{center} |
1975 |
\includegraphics[scale=0.333]{ml-debugger} |
|
1976 |
\end{center} |
|
62253 | 1977 |
\caption{ML debugger session} |
62154 | 1978 |
\label{fig:ml-debugger} |
1979 |
\end{figure} |
|
62253 | 1980 |
|
1981 |
The debugger panel (\figref{fig:ml-debugger}) shows a list of all threads |
|
1982 |
that are presently stopped. Each thread shows a stack of all function |
|
1983 |
invocations that lead to the current breakpoint at the top. |
|
1984 |
||
1985 |
It is possible to jump between stack positions freely, by clicking on this |
|
1986 |
list. The current situation is displayed in the big output window, as a |
|
1987 |
local ML environment with names and printed values. |
|
1988 |
||
1989 |
ML expressions may be evaluated in the current context by entering snippets |
|
1990 |
of source into the text fields labeled \<open>Context\<close> and \<open>ML\<close>, and pushing the |
|
1991 |
\<open>Eval\<close> button. By default, the source is interpreted as Isabelle/ML with the |
|
1992 |
usual support for antiquotations (like @{command ML}, @{command ML_file}). |
|
1993 |
Alternatively, strict Standard ML may be enforced via the \<^emph>\<open>SML\<close> checkbox |
|
1994 |
(like @{command SML_file}). |
|
1995 |
||
1996 |
The context for Isabelle/ML is optional, it may evaluate to a value of type |
|
1997 |
@{ML_type theory}, @{ML_type Proof.context}, or @{ML_type Context.generic}. |
|
1998 |
Thus the given ML expression (with its antiquotations) may be subject to the |
|
1999 |
intended dynamic run-time context, instead of the static compile-time |
|
2000 |
context. |
|
2001 |
||
2002 |
\<^medskip> |
|
2003 |
The buttons labeled \<^emph>\<open>Continue\<close>, \<^emph>\<open>Step\<close>, \<^emph>\<open>Step over\<close>, \<^emph>\<open>Step out\<close> |
|
2004 |
recommence execution of the program, with different policies concerning |
|
2005 |
nested function invocations. The debugger always moves the cursor within the |
|
2006 |
ML source to the next breakpoint position, and offers new stack frames as |
|
2007 |
before. |
|
62154 | 2008 |
\<close> |
2009 |
||
2010 |
||
58618 | 2011 |
chapter \<open>Miscellaneous tools\<close> |
54358 | 2012 |
|
58618 | 2013 |
section \<open>Timing\<close> |
54359 | 2014 |
|
61574 | 2015 |
text \<open> |
2016 |
Managed evaluation of commands within PIDE documents includes timing |
|
2017 |
information, which consists of elapsed (wall-clock) time, CPU time, and GC |
|
2018 |
(garbage collection) time. Note that in a multithreaded system it is |
|
2019 |
difficult to measure execution time precisely: elapsed time is closer to the |
|
2020 |
real requirements of runtime resources than CPU or GC time, which are both |
|
2021 |
subject to influences from the parallel environment that are outside the |
|
2022 |
scope of the current command transaction. |
|
54359 | 2023 |
|
61574 | 2024 |
The \<^emph>\<open>Timing\<close> panel provides an overview of cumulative command timings for |
2025 |
each document node. Commands with elapsed time below the given threshold are |
|
2026 |
ignored in the grand total. Nodes are sorted according to their overall |
|
2027 |
timing. For the document node that corresponds to the current buffer, |
|
2028 |
individual command timings are shown as well. A double-click on a theory |
|
2029 |
node or command moves the editor focus to that particular source position. |
|
54359 | 2030 |
|
61574 | 2031 |
It is also possible to reveal individual timing information via some tooltip |
2032 |
for the corresponding command keyword, using the technique of mouse hovering |
|
62251 | 2033 |
with \<^verbatim>\<open>CONTROL\<close>~/ \<^verbatim>\<open>COMMAND\<close> modifier (\secref{sec:tooltips-hyperlinks}). |
2034 |
Actual display of timing depends on the global option @{system_option_ref |
|
2035 |
jedit_timing_threshold}, which can be configured in \<^emph>\<open>Plugin Options~/ |
|
2036 |
Isabelle~/ General\<close>. |
|
54360 | 2037 |
|
61415 | 2038 |
\<^medskip> |
61574 | 2039 |
The \<^emph>\<open>Monitor\<close> panel visualizes various data collections about recent |
2040 |
activity of the Isabelle/ML task farm and the underlying ML runtime system. |
|
2041 |
The display is continuously updated according to @{system_option_ref |
|
57869 | 2042 |
editor_chart_delay}. Note that the painting of the chart takes considerable |
2043 |
runtime itself --- on the Java Virtual Machine that runs Isabelle/Scala, not |
|
61503 | 2044 |
Isabelle/ML. Internally, the Isabelle/Scala module \<^verbatim>\<open>isabelle.ML_Statistics\<close> |
2045 |
provides further access to statistics of Isabelle/ML. |
|
2046 |
\<close> |
|
54359 | 2047 |
|
2048 |
||
58618 | 2049 |
section \<open>Low-level output\<close> |
54358 | 2050 |
|
61574 | 2051 |
text \<open> |
62251 | 2052 |
Prover output is normally shown directly in the main text area or specific |
2053 |
panels like \<^emph>\<open>Output\<close> (\secref{sec:output}) or \<^emph>\<open>State\<close> |
|
2054 |
(\secref{sec:state-output}). Beyond this, it is occasionally useful to |
|
2055 |
inspect low-level output channels via some of the following additional |
|
2056 |
panels: |
|
54358 | 2057 |
|
61574 | 2058 |
\<^item> \<^emph>\<open>Protocol\<close> shows internal messages between the Isabelle/Scala and |
2059 |
Isabelle/ML side of the PIDE document editing protocol. Recording of |
|
2060 |
messages starts with the first activation of the corresponding dockable |
|
2061 |
window; earlier messages are lost. |
|
54358 | 2062 |
|
61574 | 2063 |
Actual display of protocol messages causes considerable slowdown, so it is |
2064 |
important to undock all \<^emph>\<open>Protocol\<close> panels for production work. |
|
54358 | 2065 |
|
61503 | 2066 |
\<^item> \<^emph>\<open>Raw Output\<close> shows chunks of text from the \<^verbatim>\<open>stdout\<close> and \<^verbatim>\<open>stderr\<close> |
61574 | 2067 |
channels of the prover process. Recording of output starts with the first |
2068 |
activation of the corresponding dockable window; earlier output is lost. |
|
54358 | 2069 |
|
61574 | 2070 |
The implicit stateful nature of physical I/O channels makes it difficult to |
2071 |
relate raw output to the actual command from where it was originating. |
|
2072 |
Parallel execution may add to the confusion. Peeking at physical process I/O |
|
2073 |
is only the last resort to diagnose problems with tools that are not PIDE |
|
2074 |
compliant. |
|
54358 | 2075 |
|
57310 | 2076 |
Under normal circumstances, prover output always works via managed message |
2077 |
channels (corresponding to @{ML writeln}, @{ML warning}, @{ML |
|
57420 | 2078 |
Output.error_message} in Isabelle/ML), which are displayed by regular means |
60257 | 2079 |
within the document model (\secref{sec:output}). Unhandled Isabelle/ML |
2080 |
exceptions are printed by the system via @{ML Output.error_message}. |
|
54358 | 2081 |
|
61477 | 2082 |
\<^item> \<^emph>\<open>Syslog\<close> shows system messages that might be relevant to diagnose |
60257 | 2083 |
problems with the startup or shutdown phase of the prover process; this also |
61574 | 2084 |
includes raw output on \<^verbatim>\<open>stderr\<close>. Isabelle/ML also provides an explicit @{ML |
2085 |
Output.system_message} operation, which is occasionally useful for |
|
2086 |
diagnostic purposes within the system infrastructure itself. |
|
54358 | 2087 |
|
61574 | 2088 |
A limited amount of syslog messages are buffered, independently of the |
2089 |
docking state of the \<^emph>\<open>Syslog\<close> panel. This allows to diagnose serious |
|
2090 |
problems with Isabelle/PIDE process management, outside of the actual |
|
2091 |
protocol layer. |
|
54358 | 2092 |
|
61574 | 2093 |
Under normal situations, such low-level system output can be ignored. |
58618 | 2094 |
\<close> |
54358 | 2095 |
|
2096 |
||
58618 | 2097 |
chapter \<open>Known problems and workarounds \label{sec:problems}\<close> |
53770
db362319d766
added/updated material from src/Tools/jEdit/README.html;
wenzelm
parents:
53769
diff
changeset
|
2098 |
|
58618 | 2099 |
text \<open> |
61574 | 2100 |
\<^item> \<^bold>\<open>Problem:\<close> Odd behavior of some diagnostic commands with global |
2101 |
side-effects, like writing a physical file. |
|
53770
db362319d766
added/updated material from src/Tools/jEdit/README.html;
wenzelm
parents:
53769
diff
changeset
|
2102 |
|
61574 | 2103 |
\<^bold>\<open>Workaround:\<close> Copy/paste complete command text from elsewhere, or disable |
2104 |
continuous checking temporarily. |
|
53770
db362319d766
added/updated material from src/Tools/jEdit/README.html;
wenzelm
parents:
53769
diff
changeset
|
2105 |
|
61574 | 2106 |
\<^item> \<^bold>\<open>Problem:\<close> Keyboard shortcuts \<^verbatim>\<open>C+PLUS\<close> and \<^verbatim>\<open>C+MINUS\<close> for adjusting the |
2107 |
editor font size depend on platform details and national keyboards. |
|
2108 |
||
2109 |
\<^bold>\<open>Workaround:\<close> Rebind keys via \<^emph>\<open>Global Options~/ Shortcuts\<close>. |
|
54330 | 2110 |
|
61503 | 2111 |
\<^item> \<^bold>\<open>Problem:\<close> The Mac OS X key sequence \<^verbatim>\<open>COMMAND+COMMA\<close> for application |
61574 | 2112 |
\<^emph>\<open>Preferences\<close> is in conflict with the jEdit default keyboard shortcut for |
2113 |
\<^emph>\<open>Incremental Search Bar\<close> (action @{action_ref "quick-search"}). |
|
53770
db362319d766
added/updated material from src/Tools/jEdit/README.html;
wenzelm
parents:
53769
diff
changeset
|
2114 |
|
61574 | 2115 |
\<^bold>\<open>Workaround:\<close> Rebind key via \<^emph>\<open>Global Options~/ Shortcuts\<close> according to |
2116 |
national keyboard, e.g.\ \<^verbatim>\<open>COMMAND+SLASH\<close> on English ones. |
|
53770
db362319d766
added/updated material from src/Tools/jEdit/README.html;
wenzelm
parents:
53769
diff
changeset
|
2117 |
|
61522
4108f91ca810
workaround for problem with C-1, C-2, C-3 seen on Slovak QWERTY keyboard;
wenzelm
parents:
61512
diff
changeset
|
2118 |
\<^item> \<^bold>\<open>Problem:\<close> On Mac OS X with native Apple look-and-feel, some exotic |
4108f91ca810
workaround for problem with C-1, C-2, C-3 seen on Slovak QWERTY keyboard;
wenzelm
parents:
61512
diff
changeset
|
2119 |
national keyboards may cause a conflict of menu accelerator keys with |
4108f91ca810
workaround for problem with C-1, C-2, C-3 seen on Slovak QWERTY keyboard;
wenzelm
parents:
61512
diff
changeset
|
2120 |
regular jEdit key bindings. This leads to duplicate execution of the |
4108f91ca810
workaround for problem with C-1, C-2, C-3 seen on Slovak QWERTY keyboard;
wenzelm
parents:
61512
diff
changeset
|
2121 |
corresponding jEdit action. |
4108f91ca810
workaround for problem with C-1, C-2, C-3 seen on Slovak QWERTY keyboard;
wenzelm
parents:
61512
diff
changeset
|
2122 |
|
4108f91ca810
workaround for problem with C-1, C-2, C-3 seen on Slovak QWERTY keyboard;
wenzelm
parents:
61512
diff
changeset
|
2123 |
\<^bold>\<open>Workaround:\<close> Disable the native Apple menu bar via Java runtime option |
4108f91ca810
workaround for problem with C-1, C-2, C-3 seen on Slovak QWERTY keyboard;
wenzelm
parents:
61512
diff
changeset
|
2124 |
\<^verbatim>\<open>-Dapple.laf.useScreenMenuBar=false\<close>. |
4108f91ca810
workaround for problem with C-1, C-2, C-3 seen on Slovak QWERTY keyboard;
wenzelm
parents:
61512
diff
changeset
|
2125 |
|
61574 | 2126 |
\<^item> \<^bold>\<open>Problem:\<close> Mac OS X system fonts sometimes lead to character drop-outs in |
2127 |
the main text area. |
|
54349 | 2128 |
|
62265 | 2129 |
\<^bold>\<open>Workaround:\<close> Use the default \<^verbatim>\<open>IsabelleText\<close> font. |
2130 |
||
61574 | 2131 |
\<^item> \<^bold>\<open>Problem:\<close> Some Linux/X11 input methods such as IBus tend to disrupt key |
2132 |
event handling of Java/AWT/Swing. |
|
54329 | 2133 |
|
61574 | 2134 |
\<^bold>\<open>Workaround:\<close> Do not use X11 input methods. Note that environment variable |
2135 |
\<^verbatim>\<open>XMODIFIERS\<close> is reset by default within Isabelle settings. |
|
2136 |
||
2137 |
\<^item> \<^bold>\<open>Problem:\<close> Some Linux/X11 window managers that are not ``re-parenting'' |
|
2138 |
cause problems with additional windows opened by Java. This affects either |
|
2139 |
historic or neo-minimalistic window managers like \<^verbatim>\<open>awesome\<close> or \<^verbatim>\<open>xmonad\<close>. |
|
54329 | 2140 |
|
61477 | 2141 |
\<^bold>\<open>Workaround:\<close> Use a regular re-parenting X11 window manager. |
54329 | 2142 |
|
61574 | 2143 |
\<^item> \<^bold>\<open>Problem:\<close> Various forks of Linux/X11 window managers and desktop |
2144 |
environments (like Gnome) disrupt the handling of menu popups and mouse |
|
2145 |
positions of Java/AWT/Swing. |
|
54329 | 2146 |
|
62183 | 2147 |
\<^bold>\<open>Workaround:\<close> Use suitable version of Linux desktops. |
60291 | 2148 |
|
61477 | 2149 |
\<^item> \<^bold>\<open>Problem:\<close> Full-screen mode via jEdit action @{action_ref |
61574 | 2150 |
"toggle-full-screen"} (default keyboard shortcut \<^verbatim>\<open>F11\<close>) works on Windows, |
2151 |
but not on Mac OS X or various Linux/X11 window managers. |
|
54349 | 2152 |
|
61574 | 2153 |
\<^bold>\<open>Workaround:\<close> Use native full-screen control of the window manager (notably |
2154 |
on Mac OS X). |
|
64512 | 2155 |
|
2156 |
\<^item> \<^bold>\<open>Problem:\<close> Heap space of the JVM may fill up and render the Prover IDE |
|
2157 |
unresponsive, e.g.\ when editing big Isabelle sessions with many theories. |
|
2158 |
||
67092 | 2159 |
\<^bold>\<open>Workaround:\<close> Increase JVM heap parameters by editing platform-specific |
2160 |
files (for ``properties'' or ``options'') that are associated with the main |
|
2161 |
app bundle. |
|
64512 | 2162 |
|
2163 |
Also note that jEdit provides a heap space monitor in the status line |
|
2164 |
(bottom-right). Double-clicking on that causes full garbage-collection, |
|
2165 |
which sometimes helps in low-memory situations. |
|
58618 | 2166 |
\<close> |
53770
db362319d766
added/updated material from src/Tools/jEdit/README.html;
wenzelm
parents:
53769
diff
changeset
|
2167 |
|
67399 | 2168 |
end |