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