doc-src/IsarRef/pure.tex
author wenzelm
Sat Mar 18 19:07:47 2000 +0100 (2000-03-18)
changeset 8515 160739e1f443
parent 8510 863bc8086f62
child 8533 d534ddf14076
permissions -rw-r--r--
pure methods / atts moved here;
tactic emulation moved here;
oops moved here;
history commands;
tuned;
wenzelm@7046
     1
wenzelm@7895
     2
\chapter{Basic Isar Language Elements}\label{ch:pure-syntax}
wenzelm@7167
     3
wenzelm@8515
     4
Subsequently, we introduce the main part of Pure Isar theory and proof
wenzelm@8515
     5
commands, together with a few fundamental proof methods and attributes.
wenzelm@8515
     6
Chapter~\ref{ch:gen-tools} describes further Isar elements provided by generic
wenzelm@8515
     7
tools and packages (such as the Simplifier) that are either part of Pure
wenzelm@8515
     8
Isabelle or pre-installed by most object logics.  Chapter~\ref{ch:hol-tools}
wenzelm@8515
     9
refers to actual object-logic specific elements of Isabelle/HOL.
wenzelm@7046
    10
wenzelm@7167
    11
\medskip
wenzelm@7167
    12
wenzelm@7167
    13
Isar commands may be either \emph{proper} document constructors, or
wenzelm@7466
    14
\emph{improper commands}.  Some proof methods and attributes introduced later
wenzelm@7466
    15
are classified as improper as well.  Improper Isar language elements, which
wenzelm@7466
    16
are subsequently marked by $^*$, are often helpful when developing proof
wenzelm@7981
    17
documents, while their use is discouraged for the final outcome.  Typical
wenzelm@7981
    18
examples are diagnostic commands that print terms or theorems according to the
wenzelm@7981
    19
current context; other commands even emulate old-style tactical theorem
wenzelm@7981
    20
proving, which facilitates porting of legacy proof scripts.
wenzelm@7167
    21
wenzelm@7134
    22
wenzelm@7134
    23
\section{Theory commands}
wenzelm@7134
    24
wenzelm@7167
    25
\subsection{Defining theories}\label{sec:begin-thy}
wenzelm@7134
    26
wenzelm@7895
    27
\indexisarcmd{header}\indexisarcmd{theory}\indexisarcmd{end}\indexisarcmd{context}
wenzelm@7134
    28
\begin{matharray}{rcl}
wenzelm@7895
    29
  \isarcmd{header} & : & \isarkeep{toplevel} \\
wenzelm@8510
    30
  \isarcmd{theory} & : & \isartrans{toplevel}{theory} \\
wenzelm@8510
    31
  \isarcmd{context}^* & : & \isartrans{toplevel}{theory} \\
wenzelm@8510
    32
  \isarcmd{end} & : & \isartrans{theory}{toplevel} \\
wenzelm@7134
    33
\end{matharray}
wenzelm@7134
    34
wenzelm@7134
    35
Isabelle/Isar ``new-style'' theories are either defined via theory files or
wenzelm@7981
    36
interactively.  Both theory-level specifications and proofs are handled
wenzelm@7335
    37
uniformly --- occasionally definitional mechanisms even require some explicit
wenzelm@7335
    38
proof as well.  In contrast, ``old-style'' Isabelle theories support batch
wenzelm@7335
    39
processing only, with the proof scripts collected in separate ML files.
wenzelm@7134
    40
wenzelm@7895
    41
The first actual command of any theory has to be $\THEORY$, starting a new
wenzelm@7895
    42
theory based on the merge of existing ones.  Just preceding $\THEORY$, there
wenzelm@7895
    43
may be an optional $\isarkeyword{header}$ declaration, which is relevant to
wenzelm@7895
    44
document preparation only; it acts very much like a special pre-theory markup
wenzelm@7895
    45
command (cf.\ \S\ref{sec:markup-thy} and \S\ref{sec:markup-thy}).  The theory
wenzelm@7895
    46
context may be also changed by $\CONTEXT$ without creating a new theory.  In
wenzelm@7895
    47
both cases, $\END$ concludes the theory development; it has to be the very
wenzelm@7895
    48
last command in a theory file.
wenzelm@7134
    49
wenzelm@7134
    50
\begin{rail}
wenzelm@7895
    51
  'header' text
wenzelm@7895
    52
  ;
wenzelm@7134
    53
  'theory' name '=' (name + '+') filespecs? ':'
wenzelm@7134
    54
  ;
wenzelm@7134
    55
  'context' name
wenzelm@7134
    56
  ;
wenzelm@7134
    57
  'end'
wenzelm@7134
    58
  ;;
wenzelm@7134
    59
wenzelm@7167
    60
  filespecs: 'files' ((name | parname) +);
wenzelm@7134
    61
\end{rail}
wenzelm@7134
    62
wenzelm@7167
    63
\begin{descr}
wenzelm@7895
    64
\item [$\isarkeyword{header}~text$] provides plain text markup just preceding
wenzelm@7895
    65
  the formal begin of a theory.  In actual document preparation the
wenzelm@7895
    66
  corresponding {\LaTeX} macro \verb,\isamarkupheader, may be redefined to
wenzelm@7895
    67
  produce chapter or section headings.  See also \S\ref{sec:markup-thy} and
wenzelm@7895
    68
  \S\ref{sec:markup-prf} for further markup commands.
wenzelm@7895
    69
  
wenzelm@7981
    70
\item [$\THEORY~A = B@1 + \cdots + B@n\colon$] commences a new theory $A$
wenzelm@7981
    71
  based on existing ones $B@1 + \cdots + B@n$.  Isabelle's theory loader
wenzelm@7981
    72
  system ensures that any of the base theories are properly loaded (and fully
wenzelm@7981
    73
  up-to-date when $\THEORY$ is executed interactively).  The optional
wenzelm@7981
    74
  $\isarkeyword{files}$ specification declares additional dependencies on ML
wenzelm@7981
    75
  files.  Unless put in parentheses, any file will be loaded immediately via
wenzelm@7981
    76
  $\isarcmd{use}$ (see also \S\ref{sec:ML}).  The optional ML file
wenzelm@7981
    77
  \texttt{$A$.ML} that may be associated with any theory should \emph{not} be
wenzelm@7981
    78
  included in $\isarkeyword{files}$, though.
wenzelm@7134
    79
  
wenzelm@7895
    80
\item [$\CONTEXT~B$] enters an existing theory context, basically in read-only
wenzelm@7981
    81
  mode, so only a limited set of commands may be performed without destroying
wenzelm@7981
    82
  the theory.  Just as for $\THEORY$, the theory loader ensures that $B$ is
wenzelm@7981
    83
  loaded and up-to-date.
wenzelm@7175
    84
  
wenzelm@7167
    85
\item [$\END$] concludes the current theory definition or context switch.
wenzelm@7981
    86
Note that this command cannot be undone, but the whole theory definition has
wenzelm@7981
    87
to be retracted.
wenzelm@7167
    88
\end{descr}
wenzelm@7134
    89
wenzelm@7134
    90
wenzelm@7895
    91
\subsection{Theory markup commands}\label{sec:markup-thy}
wenzelm@7134
    92
wenzelm@7895
    93
\indexisarcmd{chapter}\indexisarcmd{section}\indexisarcmd{subsection}
wenzelm@7895
    94
\indexisarcmd{subsubsection}\indexisarcmd{text}\indexisarcmd{text-raw}
wenzelm@7134
    95
\begin{matharray}{rcl}
wenzelm@7134
    96
  \isarcmd{chapter} & : & \isartrans{theory}{theory} \\
wenzelm@7167
    97
  \isarcmd{section} & : & \isartrans{theory}{theory} \\
wenzelm@7134
    98
  \isarcmd{subsection} & : & \isartrans{theory}{theory} \\
wenzelm@7134
    99
  \isarcmd{subsubsection} & : & \isartrans{theory}{theory} \\
wenzelm@7134
   100
  \isarcmd{text} & : & \isartrans{theory}{theory} \\
wenzelm@7895
   101
  \isarcmd{text_raw} & : & \isartrans{theory}{theory} \\
wenzelm@7134
   102
\end{matharray}
wenzelm@7134
   103
wenzelm@7895
   104
Apart from formal comments (see \S\ref{sec:comments}), markup commands provide
wenzelm@7981
   105
a structured way to insert text into the document generated from a theory (see
wenzelm@7895
   106
\cite{isabelle-sys} for more information on Isabelle's document preparation
wenzelm@7895
   107
tools).
wenzelm@7134
   108
wenzelm@7895
   109
\railalias{textraw}{text\_raw}
wenzelm@7895
   110
\railterm{textraw}
wenzelm@7134
   111
wenzelm@7134
   112
\begin{rail}
wenzelm@7895
   113
  ('chapter' | 'section' | 'subsection' | 'subsubsection' | 'text' | textraw) text
wenzelm@7134
   114
  ;
wenzelm@7134
   115
\end{rail}
wenzelm@7134
   116
wenzelm@7167
   117
\begin{descr}
wenzelm@7335
   118
\item [$\isarkeyword{chapter}$, $\isarkeyword{section}$,
wenzelm@7335
   119
  $\isarkeyword{subsection}$, and $\isarkeyword{subsubsection}$] mark chapter
wenzelm@7335
   120
  and section headings.
wenzelm@7895
   121
\item [$\TEXT$] specifies paragraphs of plain text, including references to
wenzelm@7895
   122
  formal entities.\footnote{The latter feature is not yet supported.
wenzelm@7895
   123
    Nevertheless, any source text of the form
wenzelm@7895
   124
    ``\texttt{\at\ttlbrace$\dots$\ttrbrace}'' should be considered as reserved
wenzelm@7895
   125
    for future use.}
wenzelm@7895
   126
\item [$\isarkeyword{text_raw}$] inserts {\LaTeX} source into the output,
wenzelm@7895
   127
  without additional markup.  Thus the full range of document manipulations
wenzelm@7895
   128
  becomes available.  A typical application would be to emit
wenzelm@7895
   129
  \verb,\begin{comment}, and \verb,\end{comment}, commands to exclude certain
wenzelm@7895
   130
  parts from the final document.\footnote{This requires the \texttt{comment}
wenzelm@7981
   131
    package to be included in {\LaTeX}.}
wenzelm@7167
   132
\end{descr}
wenzelm@7134
   133
wenzelm@7895
   134
Any markup command (except $\isarkeyword{text_raw}$) corresponds to a {\LaTeX}
wenzelm@7981
   135
macro with the name prefixed by \verb,\isamarkup, (e.g.\ 
wenzelm@7895
   136
\verb,\isamarkupchapter, for $\isarkeyword{chapter}$). The \railqtoken{text}
wenzelm@7981
   137
argument is passed to that macro unchanged, i.e.\ further {\LaTeX} commands
wenzelm@7981
   138
may be included here as well.
wenzelm@7895
   139
wenzelm@8485
   140
\medskip
wenzelm@8485
   141
wenzelm@8485
   142
Additional markup commands are available for proofs (see
wenzelm@7895
   143
\S\ref{sec:markup-prf}).  Also note that the $\isarkeyword{header}$
wenzelm@7895
   144
declaration (see \S\ref{sec:begin-thy}) admits to insert document markup
wenzelm@7895
   145
elements just preceding the actual theory definition.
wenzelm@7895
   146
wenzelm@7134
   147
wenzelm@7135
   148
\subsection{Type classes and sorts}\label{sec:classes}
wenzelm@7134
   149
wenzelm@7134
   150
\indexisarcmd{classes}\indexisarcmd{classrel}\indexisarcmd{defaultsort}
wenzelm@7134
   151
\begin{matharray}{rcl}
wenzelm@7134
   152
  \isarcmd{classes} & : & \isartrans{theory}{theory} \\
wenzelm@7134
   153
  \isarcmd{classrel} & : & \isartrans{theory}{theory} \\
wenzelm@7134
   154
  \isarcmd{defaultsort} & : & \isartrans{theory}{theory} \\
wenzelm@7134
   155
\end{matharray}
wenzelm@7134
   156
wenzelm@7134
   157
\begin{rail}
wenzelm@7167
   158
  'classes' (classdecl comment? +)
wenzelm@7134
   159
  ;
wenzelm@7134
   160
  'classrel' nameref '<' nameref comment?
wenzelm@7134
   161
  ;
wenzelm@7134
   162
  'defaultsort' sort comment?
wenzelm@7134
   163
  ;
wenzelm@7134
   164
\end{rail}
wenzelm@7134
   165
wenzelm@7167
   166
\begin{descr}
wenzelm@7335
   167
\item [$\isarkeyword{classes}~c<\vec c$] declares class $c$ to be a subclass
wenzelm@7335
   168
  of existing classes $\vec c$.  Cyclic class structures are ruled out.
wenzelm@7134
   169
\item [$\isarkeyword{classrel}~c@1<c@2$] states a subclass relation between
wenzelm@7134
   170
  existing classes $c@1$ and $c@2$.  This is done axiomatically!  The
wenzelm@7895
   171
  $\isarkeyword{instance}$ command (see \S\ref{sec:axclass}) provides a way to
wenzelm@7175
   172
  introduce proven class relations.
wenzelm@7134
   173
\item [$\isarkeyword{defaultsort}~s$] makes sort $s$ the new default sort for
wenzelm@7895
   174
  any type variables given without sort constraints.  Usually, the default
wenzelm@7134
   175
  sort would be only changed when defining new logics.
wenzelm@7167
   176
\end{descr}
wenzelm@7134
   177
wenzelm@7134
   178
wenzelm@7315
   179
\subsection{Primitive types and type abbreviations}\label{sec:types-pure}
wenzelm@7134
   180
wenzelm@7134
   181
\indexisarcmd{typedecl}\indexisarcmd{types}\indexisarcmd{nonterminals}\indexisarcmd{arities}
wenzelm@7134
   182
\begin{matharray}{rcl}
wenzelm@7134
   183
  \isarcmd{types} & : & \isartrans{theory}{theory} \\
wenzelm@7134
   184
  \isarcmd{typedecl} & : & \isartrans{theory}{theory} \\
wenzelm@7134
   185
  \isarcmd{nonterminals} & : & \isartrans{theory}{theory} \\
wenzelm@7134
   186
  \isarcmd{arities} & : & \isartrans{theory}{theory} \\
wenzelm@7134
   187
\end{matharray}
wenzelm@7134
   188
wenzelm@7134
   189
\begin{rail}
wenzelm@7134
   190
  'types' (typespec '=' type infix? comment? +)
wenzelm@7134
   191
  ;
wenzelm@7134
   192
  'typedecl' typespec infix? comment?
wenzelm@7134
   193
  ;
wenzelm@7134
   194
  'nonterminals' (name +) comment?
wenzelm@7134
   195
  ;
wenzelm@7134
   196
  'arities' (nameref '::' arity comment? +)
wenzelm@7134
   197
  ;
wenzelm@7134
   198
\end{rail}
wenzelm@7134
   199
wenzelm@7167
   200
\begin{descr}
wenzelm@7335
   201
\item [$\TYPES~(\vec\alpha)t = \tau$] introduces \emph{type synonym}
wenzelm@7134
   202
  $(\vec\alpha)t$ for existing type $\tau$.  Unlike actual type definitions,
wenzelm@7134
   203
  as are available in Isabelle/HOL for example, type synonyms are just purely
wenzelm@7895
   204
  syntactic abbreviations without any logical significance.  Internally, type
wenzelm@7981
   205
  synonyms are fully expanded.
wenzelm@7134
   206
\item [$\isarkeyword{typedecl}~(\vec\alpha)t$] declares a new type constructor
wenzelm@7895
   207
  $t$, intended as an actual logical type.  Note that object-logics such as
wenzelm@7895
   208
  Isabelle/HOL override $\isarkeyword{typedecl}$ by their own version.
wenzelm@7175
   209
\item [$\isarkeyword{nonterminals}~\vec c$] declares $0$-ary type constructors
wenzelm@7175
   210
  $\vec c$ to act as purely syntactic types, i.e.\ nonterminal symbols of
wenzelm@7175
   211
  Isabelle's inner syntax of terms or types.
wenzelm@7335
   212
\item [$\isarkeyword{arities}~t::(\vec s)s$] augments Isabelle's order-sorted
wenzelm@7335
   213
  signature of types by new type constructor arities.  This is done
wenzelm@7335
   214
  axiomatically!  The $\isarkeyword{instance}$ command (see
wenzelm@7895
   215
  \S\ref{sec:axclass}) provides a way to introduce proven type arities.
wenzelm@7167
   216
\end{descr}
wenzelm@7134
   217
wenzelm@7134
   218
wenzelm@7981
   219
\subsection{Constants and simple definitions}\label{sec:consts}
wenzelm@7134
   220
wenzelm@7175
   221
\indexisarcmd{consts}\indexisarcmd{defs}\indexisarcmd{constdefs}\indexoutertoken{constdecl}
wenzelm@7134
   222
\begin{matharray}{rcl}
wenzelm@7134
   223
  \isarcmd{consts} & : & \isartrans{theory}{theory} \\
wenzelm@7134
   224
  \isarcmd{defs} & : & \isartrans{theory}{theory} \\
wenzelm@7134
   225
  \isarcmd{constdefs} & : & \isartrans{theory}{theory} \\
wenzelm@7134
   226
\end{matharray}
wenzelm@7134
   227
wenzelm@7134
   228
\begin{rail}
wenzelm@7134
   229
  'consts' (constdecl +)
wenzelm@7134
   230
  ;
wenzelm@7608
   231
  'defs' (axmdecl prop comment? +)
wenzelm@7134
   232
  ;
wenzelm@7134
   233
  'constdefs' (constdecl prop comment? +)
wenzelm@7134
   234
  ;
wenzelm@7134
   235
wenzelm@7134
   236
  constdecl: name '::' type mixfix? comment?
wenzelm@7134
   237
  ;
wenzelm@7134
   238
\end{rail}
wenzelm@7134
   239
wenzelm@7167
   240
\begin{descr}
wenzelm@7335
   241
\item [$\CONSTS~c::\sigma$] declares constant $c$ to have any instance of type
wenzelm@7335
   242
  scheme $\sigma$.  The optional mixfix annotations may attach concrete syntax
wenzelm@7895
   243
  to the constants declared.
wenzelm@7335
   244
\item [$\DEFS~name: eqn$] introduces $eqn$ as a definitional axiom for some
wenzelm@7335
   245
  existing constant.  See \cite[\S6]{isabelle-ref} for more details on the
wenzelm@7335
   246
  form of equations admitted as constant definitions.
wenzelm@7335
   247
\item [$\isarkeyword{constdefs}~c::\sigma~eqn$] combines declarations and
wenzelm@7335
   248
  definitions of constants, using canonical name $c_def$ for the definitional
wenzelm@7335
   249
  axiom.
wenzelm@7167
   250
\end{descr}
wenzelm@7134
   251
wenzelm@7134
   252
wenzelm@7981
   253
\subsection{Syntax and translations}\label{sec:syn-trans}
wenzelm@7134
   254
wenzelm@7134
   255
\indexisarcmd{syntax}\indexisarcmd{translations}
wenzelm@7134
   256
\begin{matharray}{rcl}
wenzelm@7134
   257
  \isarcmd{syntax} & : & \isartrans{theory}{theory} \\
wenzelm@7134
   258
  \isarcmd{translations} & : & \isartrans{theory}{theory} \\
wenzelm@7134
   259
\end{matharray}
wenzelm@7134
   260
wenzelm@7134
   261
\begin{rail}
wenzelm@7134
   262
  'syntax' ('(' name 'output'? ')')? (constdecl +)
wenzelm@7134
   263
  ;
wenzelm@7134
   264
  'translations' (transpat ('==' | '=>' | '<=') transpat comment? +)
wenzelm@7134
   265
  ;
wenzelm@7134
   266
  transpat: ('(' nameref ')')? string
wenzelm@7134
   267
  ;
wenzelm@7134
   268
\end{rail}
wenzelm@7134
   269
wenzelm@7167
   270
\begin{descr}
wenzelm@7175
   271
\item [$\isarkeyword{syntax}~(mode)~decls$] is similar to $\CONSTS~decls$,
wenzelm@7175
   272
  except that the actual logical signature extension is omitted.  Thus the
wenzelm@7175
   273
  context free grammar of Isabelle's inner syntax may be augmented in
wenzelm@7335
   274
  arbitrary ways, independently of the logic.  The $mode$ argument refers to
wenzelm@7335
   275
  the print mode that the grammar rules belong; unless there is the
wenzelm@7335
   276
  \texttt{output} flag given, all productions are added both to the input and
wenzelm@7335
   277
  output grammar.
wenzelm@7175
   278
\item [$\isarkeyword{translations}~rules$] specifies syntactic translation
wenzelm@7981
   279
  rules (i.e.\ \emph{macros}): parse~/ print rules (\texttt{==}), parse rules
wenzelm@7895
   280
  (\texttt{=>}), or print rules (\texttt{<=}).  Translation patterns may be
wenzelm@7895
   281
  prefixed by the syntactic category to be used for parsing; the default is
wenzelm@7134
   282
  \texttt{logic}.
wenzelm@7167
   283
\end{descr}
wenzelm@7134
   284
wenzelm@7134
   285
wenzelm@7134
   286
\subsection{Axioms and theorems}
wenzelm@7134
   287
wenzelm@7134
   288
\indexisarcmd{axioms}\indexisarcmd{theorems}\indexisarcmd{lemmas}
wenzelm@7134
   289
\begin{matharray}{rcl}
wenzelm@7134
   290
  \isarcmd{axioms} & : & \isartrans{theory}{theory} \\
wenzelm@7134
   291
  \isarcmd{theorems} & : & \isartrans{theory}{theory} \\
wenzelm@7134
   292
  \isarcmd{lemmas} & : & \isartrans{theory}{theory} \\
wenzelm@7134
   293
\end{matharray}
wenzelm@7134
   294
wenzelm@7134
   295
\begin{rail}
wenzelm@7135
   296
  'axioms' (axmdecl prop comment? +)
wenzelm@7134
   297
  ;
wenzelm@7134
   298
  ('theorems' | 'lemmas') thmdef? thmrefs
wenzelm@7134
   299
  ;
wenzelm@7134
   300
\end{rail}
wenzelm@7134
   301
wenzelm@7167
   302
\begin{descr}
wenzelm@7335
   303
\item [$\isarkeyword{axioms}~a: \phi$] introduces arbitrary statements as
wenzelm@7895
   304
  axioms of the meta-logic.  In fact, axioms are ``axiomatic theorems'', and
wenzelm@7895
   305
  may be referred later just as any other theorem.
wenzelm@7134
   306
  
wenzelm@7134
   307
  Axioms are usually only introduced when declaring new logical systems.
wenzelm@7175
   308
  Everyday work is typically done the hard way, with proper definitions and
wenzelm@7134
   309
  actual theorems.
wenzelm@7335
   310
\item [$\isarkeyword{theorems}~a = \vec b$] stores lists of existing theorems.
wenzelm@7981
   311
  Typical applications would also involve attributes, to augment the
wenzelm@7335
   312
  Simplifier context, for example.
wenzelm@7134
   313
\item [$\isarkeyword{lemmas}$] is similar to $\isarkeyword{theorems}$, but
wenzelm@7134
   314
  tags the results as ``lemma''.
wenzelm@7167
   315
\end{descr}
wenzelm@7134
   316
wenzelm@7134
   317
wenzelm@7167
   318
\subsection{Name spaces}
wenzelm@7134
   319
wenzelm@7167
   320
\indexisarcmd{global}\indexisarcmd{local}
wenzelm@7134
   321
\begin{matharray}{rcl}
wenzelm@7134
   322
  \isarcmd{global} & : & \isartrans{theory}{theory} \\
wenzelm@7134
   323
  \isarcmd{local} & : & \isartrans{theory}{theory} \\
wenzelm@7134
   324
\end{matharray}
wenzelm@7134
   325
wenzelm@7895
   326
Isabelle organizes any kind of name declarations (of types, constants,
wenzelm@7895
   327
theorems etc.)  by hierarchically structured name spaces.  Normally the user
wenzelm@7895
   328
never has to control the behavior of name space entry by hand, yet the
wenzelm@7895
   329
following commands provide some way to do so.
wenzelm@7175
   330
wenzelm@7167
   331
\begin{descr}
wenzelm@7167
   332
\item [$\isarkeyword{global}$ and $\isarkeyword{local}$] change the current
wenzelm@7167
   333
  name declaration mode.  Initially, theories start in $\isarkeyword{local}$
wenzelm@7167
   334
  mode, causing all names to be automatically qualified by the theory name.
wenzelm@7895
   335
  Changing this to $\isarkeyword{global}$ causes all names to be declared
wenzelm@7895
   336
  without the theory prefix, until $\isarkeyword{local}$ is declared again.
wenzelm@7167
   337
\end{descr}
wenzelm@7134
   338
wenzelm@7134
   339
wenzelm@7167
   340
\subsection{Incorporating ML code}\label{sec:ML}
wenzelm@7134
   341
wenzelm@7895
   342
\indexisarcmd{use}\indexisarcmd{ML}\indexisarcmd{ML-setup}\indexisarcmd{setup}
wenzelm@7134
   343
\begin{matharray}{rcl}
wenzelm@7134
   344
  \isarcmd{use} & : & \isartrans{\cdot}{\cdot} \\
wenzelm@7134
   345
  \isarcmd{ML} & : & \isartrans{\cdot}{\cdot} \\
wenzelm@7895
   346
  \isarcmd{ML_setup} & : & \isartrans{theory}{theory} \\
wenzelm@7175
   347
  \isarcmd{setup} & : & \isartrans{theory}{theory} \\
wenzelm@7134
   348
\end{matharray}
wenzelm@7134
   349
wenzelm@7895
   350
\railalias{MLsetup}{ML\_setup}
wenzelm@7895
   351
\railterm{MLsetup}
wenzelm@7895
   352
wenzelm@7134
   353
\begin{rail}
wenzelm@7134
   354
  'use' name
wenzelm@7134
   355
  ;
wenzelm@7895
   356
  ('ML' | MLsetup | 'setup') text
wenzelm@7134
   357
  ;
wenzelm@7134
   358
\end{rail}
wenzelm@7134
   359
wenzelm@7167
   360
\begin{descr}
wenzelm@7175
   361
\item [$\isarkeyword{use}~file$] reads and executes ML commands from $file$.
wenzelm@7466
   362
  The current theory context (if present) is passed down to the ML session,
wenzelm@7981
   363
  but may not be modified.  Furthermore, the file name is checked with the
wenzelm@7466
   364
  $\isarkeyword{files}$ dependency declaration given in the theory header (see
wenzelm@7466
   365
  also \S\ref{sec:begin-thy}).
wenzelm@7466
   366
  
wenzelm@7895
   367
\item [$\isarkeyword{ML}~text$] executes ML commands from $text$.  The theory
wenzelm@7895
   368
  context is passed in the same way as for $\isarkeyword{use}$.
wenzelm@7895
   369
  
wenzelm@7895
   370
\item [$\isarkeyword{ML_setup}~text$] executes ML commands from $text$.  The
wenzelm@7895
   371
  theory context is passed down to the ML session, and fetched back
wenzelm@7895
   372
  afterwards.  Thus $text$ may actually change the theory as a side effect.
wenzelm@7895
   373
  
wenzelm@7167
   374
\item [$\isarkeyword{setup}~text$] changes the current theory context by
wenzelm@8379
   375
  applying $text$, which refers to an ML expression of type
wenzelm@8379
   376
  \texttt{(theory~->~theory)~list}.  The $\isarkeyword{setup}$ command is the
wenzelm@8379
   377
  canonical way to initialize object-logic specific tools and packages written
wenzelm@8379
   378
  in ML.
wenzelm@7167
   379
\end{descr}
wenzelm@7134
   380
wenzelm@7134
   381
wenzelm@8250
   382
\subsection{Syntax translation functions}
wenzelm@7134
   383
wenzelm@8250
   384
\indexisarcmd{parse-ast-translation}\indexisarcmd{parse-translation}
wenzelm@8250
   385
\indexisarcmd{print-translation}\indexisarcmd{typed-print-translation}
wenzelm@8250
   386
\indexisarcmd{print-ast-translation}\indexisarcmd{token-translation}
wenzelm@8250
   387
\begin{matharray}{rcl}
wenzelm@8250
   388
  \isarcmd{parse_ast_translation} & : & \isartrans{theory}{theory} \\
wenzelm@8250
   389
  \isarcmd{parse_translation} & : & \isartrans{theory}{theory} \\
wenzelm@8250
   390
  \isarcmd{print_translation} & : & \isartrans{theory}{theory} \\
wenzelm@8250
   391
  \isarcmd{typed_print_translation} & : & \isartrans{theory}{theory} \\
wenzelm@8250
   392
  \isarcmd{print_ast_translation} & : & \isartrans{theory}{theory} \\
wenzelm@8250
   393
  \isarcmd{token_translation} & : & \isartrans{theory}{theory} \\
wenzelm@8250
   394
\end{matharray}
wenzelm@7134
   395
wenzelm@8250
   396
Syntax translation functions written in ML admit almost arbitrary
wenzelm@8250
   397
manipulations of Isabelle's inner syntax.  Any of the above commands have a
wenzelm@8250
   398
single \railqtoken{text} argument that refers to an ML expression of
wenzelm@8379
   399
appropriate type.
wenzelm@8379
   400
wenzelm@8379
   401
\begin{ttbox}
wenzelm@8379
   402
val parse_ast_translation   : (string * (ast list -> ast)) list
wenzelm@8379
   403
val parse_translation       : (string * (term list -> term)) list
wenzelm@8379
   404
val print_translation       : (string * (term list -> term)) list
wenzelm@8379
   405
val typed_print_translation :
wenzelm@8379
   406
  (string * (bool -> typ -> term list -> term)) list
wenzelm@8379
   407
val print_ast_translation   : (string * (ast list -> ast)) list
wenzelm@8379
   408
val token_translation       :
wenzelm@8379
   409
  (string * string * (string -> string * real)) list
wenzelm@8379
   410
\end{ttbox}
wenzelm@8379
   411
See \cite[\S8]{isabelle-ref} for more information on syntax transformations.
wenzelm@7134
   412
wenzelm@7134
   413
wenzelm@7134
   414
\subsection{Oracles}
wenzelm@7134
   415
wenzelm@7134
   416
\indexisarcmd{oracle}
wenzelm@7134
   417
\begin{matharray}{rcl}
wenzelm@7134
   418
  \isarcmd{oracle} & : & \isartrans{theory}{theory} \\
wenzelm@7134
   419
\end{matharray}
wenzelm@7134
   420
wenzelm@7175
   421
Oracles provide an interface to external reasoning systems, without giving up
wenzelm@7175
   422
control completely --- each theorem carries a derivation object recording any
wenzelm@7175
   423
oracle invocation.  See \cite[\S6]{isabelle-ref} for more information.
wenzelm@7175
   424
wenzelm@7134
   425
\begin{rail}
wenzelm@7134
   426
  'oracle' name '=' text comment?
wenzelm@7134
   427
  ;
wenzelm@7134
   428
\end{rail}
wenzelm@7134
   429
wenzelm@7167
   430
\begin{descr}
wenzelm@7175
   431
\item [$\isarkeyword{oracle}~name=text$] declares oracle $name$ to be ML
wenzelm@8379
   432
  function $text$, which has to be of type
wenzelm@8379
   433
  \texttt{Sign.sg~*~Object.T~->~term}.
wenzelm@7167
   434
\end{descr}
wenzelm@7134
   435
wenzelm@7134
   436
wenzelm@7134
   437
\section{Proof commands}
wenzelm@7134
   438
wenzelm@7987
   439
Proof commands perform transitions of Isar/VM machine configurations, which
wenzelm@7315
   440
are block-structured, consisting of a stack of nodes with three main
wenzelm@7335
   441
components: logical proof context, current facts, and open goals.  Isar/VM
wenzelm@7335
   442
transitions are \emph{typed} according to the following three three different
wenzelm@7335
   443
modes of operation:
wenzelm@7167
   444
\begin{descr}
wenzelm@7167
   445
\item [$proof(prove)$] means that a new goal has just been stated that is now
wenzelm@7167
   446
  to be \emph{proven}; the next command may refine it by some proof method
wenzelm@7895
   447
  (read: tactic), and enter a sub-proof to establish the actual result.
wenzelm@7167
   448
\item [$proof(state)$] is like an internal theory mode: the context may be
wenzelm@7987
   449
  augmented by \emph{stating} additional assumptions, intermediate results
wenzelm@7987
   450
  etc.
wenzelm@7895
   451
\item [$proof(chain)$] is intermediate between $proof(state)$ and
wenzelm@7987
   452
  $proof(prove)$: existing facts (i.e.\ the contents of the special ``$this$''
wenzelm@7987
   453
  register) have been just picked up in order to be used when refining the
wenzelm@7987
   454
  goal claimed next.
wenzelm@7167
   455
\end{descr}
wenzelm@7134
   456
wenzelm@7167
   457
wenzelm@7895
   458
\subsection{Proof markup commands}\label{sec:markup-prf}
wenzelm@7167
   459
wenzelm@7987
   460
\indexisarcmd{sect}\indexisarcmd{subsect}\indexisarcmd{subsubsect}
wenzelm@7895
   461
\indexisarcmd{txt}\indexisarcmd{txt-raw}
wenzelm@7134
   462
\begin{matharray}{rcl}
wenzelm@8101
   463
  \isarcmd{sect} & : & \isartrans{proof}{proof} \\
wenzelm@8101
   464
  \isarcmd{subsect} & : & \isartrans{proof}{proof} \\
wenzelm@8101
   465
  \isarcmd{subsubsect} & : & \isartrans{proof}{proof} \\
wenzelm@8101
   466
  \isarcmd{txt} & : & \isartrans{proof}{proof} \\
wenzelm@8101
   467
  \isarcmd{txt_raw} & : & \isartrans{proof}{proof} \\
wenzelm@7134
   468
\end{matharray}
wenzelm@7134
   469
wenzelm@7895
   470
These markup commands for proof mode closely correspond to the ones of theory
wenzelm@7895
   471
mode (see \S\ref{sec:markup-thy}).  Note that $\isarkeyword{txt_raw}$ is
wenzelm@7895
   472
special in the same way as $\isarkeyword{text_raw}$.
wenzelm@7895
   473
wenzelm@7895
   474
\railalias{txtraw}{txt\_raw}
wenzelm@7895
   475
\railterm{txtraw}
wenzelm@7175
   476
wenzelm@7134
   477
\begin{rail}
wenzelm@7895
   478
  ('sect' | 'subsect' | 'subsubsect' | 'txt' | txtraw) text
wenzelm@7134
   479
  ;
wenzelm@7134
   480
\end{rail}
wenzelm@7134
   481
wenzelm@7134
   482
wenzelm@7315
   483
\subsection{Proof context}\label{sec:proof-context}
wenzelm@7134
   484
wenzelm@7315
   485
\indexisarcmd{fix}\indexisarcmd{assume}\indexisarcmd{presume}\indexisarcmd{def}
wenzelm@7134
   486
\begin{matharray}{rcl}
wenzelm@7134
   487
  \isarcmd{fix} & : & \isartrans{proof(state)}{proof(state)} \\
wenzelm@7134
   488
  \isarcmd{assume} & : & \isartrans{proof(state)}{proof(state)} \\
wenzelm@7134
   489
  \isarcmd{presume} & : & \isartrans{proof(state)}{proof(state)} \\
wenzelm@7134
   490
  \isarcmd{def} & : & \isartrans{proof(state)}{proof(state)} \\
wenzelm@7134
   491
\end{matharray}
wenzelm@7134
   492
wenzelm@7315
   493
The logical proof context consists of fixed variables and assumptions.  The
wenzelm@7315
   494
former closely correspond to Skolem constants, or meta-level universal
wenzelm@7315
   495
quantification as provided by the Isabelle/Pure logical framework.
wenzelm@7315
   496
Introducing some \emph{arbitrary, but fixed} variable via $\FIX x$ results in
wenzelm@7987
   497
a local value that may be used in the subsequent proof as any other variable
wenzelm@7895
   498
or constant.  Furthermore, any result $\edrv \phi[x]$ exported from the
wenzelm@7987
   499
context will be universally closed wrt.\ $x$ at the outermost level: $\edrv
wenzelm@7987
   500
\All x \phi$ (this is expressed using Isabelle's meta-variables).
wenzelm@7315
   501
wenzelm@7315
   502
Similarly, introducing some assumption $\chi$ has two effects.  On the one
wenzelm@7315
   503
hand, a local theorem is created that may be used as a fact in subsequent
wenzelm@7895
   504
proof steps.  On the other hand, any result $\chi \drv \phi$ exported from the
wenzelm@7895
   505
context becomes conditional wrt.\ the assumption: $\edrv \chi \Imp \phi$.
wenzelm@7895
   506
Thus, solving an enclosing goal using such a result would basically introduce
wenzelm@7895
   507
a new subgoal stemming from the assumption.  How this situation is handled
wenzelm@7895
   508
depends on the actual version of assumption command used: while $\ASSUMENAME$
wenzelm@7895
   509
insists on solving the subgoal by unification with some premise of the goal,
wenzelm@7895
   510
$\PRESUMENAME$ leaves the subgoal unchanged in order to be proved later by the
wenzelm@7895
   511
user.
wenzelm@7315
   512
wenzelm@7319
   513
Local definitions, introduced by $\DEF{}{x \equiv t}$, are achieved by
wenzelm@7987
   514
combining $\FIX x$ with another version of assumption that causes any
wenzelm@7987
   515
hypothetical equation $x \equiv t$ to be eliminated by the reflexivity rule.
wenzelm@7987
   516
Thus, exporting some result $x \equiv t \drv \phi[x]$ yields $\edrv \phi[t]$.
wenzelm@7175
   517
wenzelm@7134
   518
\begin{rail}
wenzelm@7431
   519
  'fix' (vars + 'and') comment?
wenzelm@7134
   520
  ;
wenzelm@7315
   521
  ('assume' | 'presume') (assm comment? + 'and')
wenzelm@7134
   522
  ;
wenzelm@7175
   523
  'def' thmdecl? \\ var '==' term termpat? comment?
wenzelm@7134
   524
  ;
wenzelm@7134
   525
wenzelm@7134
   526
  var: name ('::' type)?
wenzelm@7134
   527
  ;
wenzelm@7458
   528
  vars: (name+) ('::' type)?
wenzelm@7431
   529
  ;
wenzelm@7315
   530
  assm: thmdecl? (prop proppat? +)
wenzelm@7315
   531
  ;
wenzelm@7134
   532
\end{rail}
wenzelm@7134
   533
wenzelm@7167
   534
\begin{descr}
wenzelm@8515
   535
\item [$\FIX{\vec x}$] introduces a local \emph{arbitrary, but fixed}
wenzelm@8515
   536
  variables $\vec x$.
wenzelm@8515
   537
\item [$\ASSUME{a}{\vec\phi}$ and $\PRESUME{a}{\vec\phi}$] introduce local
wenzelm@8515
   538
  theorems $\vec\phi$ by assumption.  Subsequent results applied to an
wenzelm@8515
   539
  enclosing goal (e.g.\ by $\SHOWNAME$) are handled as follows: $\ASSUMENAME$
wenzelm@8515
   540
  expects to be able to unify with existing premises in the goal, while
wenzelm@8515
   541
  $\PRESUMENAME$ leaves $\vec\phi$ as new subgoals.
wenzelm@7335
   542
  
wenzelm@7335
   543
  Several lists of assumptions may be given (separated by
wenzelm@7895
   544
  $\isarkeyword{and}$); the resulting list of current facts consists of all of
wenzelm@7895
   545
  these concatenated.
wenzelm@7315
   546
\item [$\DEF{a}{x \equiv t}$] introduces a local (non-polymorphic) definition.
wenzelm@7315
   547
  In results exported from the context, $x$ is replaced by $t$.  Basically,
wenzelm@7987
   548
  $\DEF{}{x \equiv t}$ abbreviates $\FIX{x}~\ASSUME{}{x \equiv t}$, with the
wenzelm@7335
   549
  resulting hypothetical equation solved by reflexivity.
wenzelm@7431
   550
  
wenzelm@7431
   551
  The default name for the definitional equation is $x_def$.
wenzelm@7167
   552
\end{descr}
wenzelm@7167
   553
wenzelm@7895
   554
The special name $prems$\indexisarthm{prems} refers to all assumptions of the
wenzelm@7895
   555
current context as a list of theorems.
wenzelm@7315
   556
wenzelm@7167
   557
wenzelm@7167
   558
\subsection{Facts and forward chaining}
wenzelm@7167
   559
wenzelm@7167
   560
\indexisarcmd{note}\indexisarcmd{then}\indexisarcmd{from}\indexisarcmd{with}
wenzelm@7167
   561
\begin{matharray}{rcl}
wenzelm@7167
   562
  \isarcmd{note} & : & \isartrans{proof(state)}{proof(state)} \\
wenzelm@7167
   563
  \isarcmd{then} & : & \isartrans{proof(state)}{proof(chain)} \\
wenzelm@7167
   564
  \isarcmd{from} & : & \isartrans{proof(state)}{proof(chain)} \\
wenzelm@7167
   565
  \isarcmd{with} & : & \isartrans{proof(state)}{proof(chain)} \\
wenzelm@7167
   566
\end{matharray}
wenzelm@7167
   567
wenzelm@7319
   568
New facts are established either by assumption or proof of local statements.
wenzelm@7335
   569
Any fact will usually be involved in further proofs, either as explicit
wenzelm@7335
   570
arguments of proof methods or when forward chaining towards the next goal via
wenzelm@7335
   571
$\THEN$ (and variants).  Note that the special theorem name
wenzelm@7987
   572
$this$\indexisarthm{this} refers to the most recently established facts.
wenzelm@7167
   573
\begin{rail}
wenzelm@7167
   574
  'note' thmdef? thmrefs comment?
wenzelm@7167
   575
  ;
wenzelm@7167
   576
  'then' comment?
wenzelm@7167
   577
  ;
wenzelm@7167
   578
  ('from' | 'with') thmrefs comment?
wenzelm@7167
   579
  ;
wenzelm@7167
   580
\end{rail}
wenzelm@7167
   581
wenzelm@7167
   582
\begin{descr}
wenzelm@7175
   583
\item [$\NOTE{a}{\vec b}$] recalls existing facts $\vec b$, binding the result
wenzelm@7175
   584
  as $a$.  Note that attributes may be involved as well, both on the left and
wenzelm@7175
   585
  right hand sides.
wenzelm@7167
   586
\item [$\THEN$] indicates forward chaining by the current facts in order to
wenzelm@7895
   587
  establish the goal to be claimed next.  The initial proof method invoked to
wenzelm@7895
   588
  refine that will be offered the facts to do ``anything appropriate'' (cf.\ 
wenzelm@7895
   589
  also \S\ref{sec:proof-steps}).  For example, method $rule$ (see
wenzelm@8515
   590
  \S\ref{sec:pure-meth-att}) would typically do an elimination rather than an
wenzelm@7895
   591
  introduction.  Automatic methods usually insert the facts into the goal
wenzelm@7895
   592
  state before operation.
wenzelm@7335
   593
\item [$\FROM{\vec b}$] abbreviates $\NOTE{}{\vec b}~\THEN$; thus $\THEN$ is
wenzelm@7458
   594
  equivalent to $\FROM{this}$.
wenzelm@7175
   595
\item [$\WITH{\vec b}$] abbreviates $\FROM{\vec b~facts}$; thus the forward
wenzelm@7175
   596
  chaining is from earlier facts together with the current ones.
wenzelm@7167
   597
\end{descr}
wenzelm@7167
   598
wenzelm@8515
   599
Basic proof methods (such as $rule$, see \S\ref{sec:pure-meth-att}) expect
wenzelm@7895
   600
multiple facts to be given in their proper order, corresponding to a prefix of
wenzelm@7895
   601
the premises of the rule involved.  Note that positions may be easily skipped
wenzelm@7458
   602
using a form like $\FROM{\text{\texttt{_}}~a~b}$, for example.  This involves
wenzelm@8515
   603
the trivial rule $\PROP\psi \Imp \PROP\psi$, which happens to be bound in
wenzelm@8515
   604
Isabelle/Pure as ``\texttt{_}'' (underscore).\indexisarthm{_@\texttt{_}}
wenzelm@7389
   605
wenzelm@7167
   606
wenzelm@7167
   607
\subsection{Goal statements}
wenzelm@7167
   608
wenzelm@7167
   609
\indexisarcmd{theorem}\indexisarcmd{lemma}
wenzelm@7167
   610
\indexisarcmd{have}\indexisarcmd{show}\indexisarcmd{hence}\indexisarcmd{thus}
wenzelm@7167
   611
\begin{matharray}{rcl}
wenzelm@7167
   612
  \isarcmd{theorem} & : & \isartrans{theory}{proof(prove)} \\
wenzelm@7167
   613
  \isarcmd{lemma} & : & \isartrans{theory}{proof(prove)} \\
wenzelm@7987
   614
  \isarcmd{have} & : & \isartrans{proof(state) ~|~ proof(chain)}{proof(prove)} \\
wenzelm@7987
   615
  \isarcmd{show} & : & \isartrans{proof(state) ~|~ proof(chain)}{proof(prove)} \\
wenzelm@7167
   616
  \isarcmd{hence} & : & \isartrans{proof(state)}{proof(prove)} \\
wenzelm@7167
   617
  \isarcmd{thus} & : & \isartrans{proof(state)}{proof(prove)} \\
wenzelm@7167
   618
\end{matharray}
wenzelm@7167
   619
wenzelm@7175
   620
Proof mode is entered from theory mode by initial goal commands $\THEOREMNAME$
wenzelm@7895
   621
and $\LEMMANAME$.  New local goals may be claimed within proof mode as well.
wenzelm@7895
   622
Four variants are available, indicating whether the result is meant to solve
wenzelm@7987
   623
some pending goal or whether forward chaining is employed.
wenzelm@7175
   624
wenzelm@7167
   625
\begin{rail}
wenzelm@7167
   626
  ('theorem' | 'lemma') goal
wenzelm@7167
   627
  ;
wenzelm@7167
   628
  ('have' | 'show' | 'hence' | 'thus') goal
wenzelm@7167
   629
  ;
wenzelm@7167
   630
wenzelm@7167
   631
  goal: thmdecl? proppat comment?
wenzelm@7167
   632
  ;
wenzelm@7167
   633
\end{rail}
wenzelm@7167
   634
wenzelm@7167
   635
\begin{descr}
wenzelm@7335
   636
\item [$\THEOREM{a}{\phi}$] enters proof mode with $\phi$ as main goal,
wenzelm@7895
   637
  eventually resulting in some theorem $\turn \phi$ put back into the theory.
wenzelm@7987
   638
\item [$\LEMMA{a}{\phi}$] is similar to $\THEOREMNAME$, but tags the result as
wenzelm@7167
   639
  ``lemma''.
wenzelm@7335
   640
\item [$\HAVE{a}{\phi}$] claims a local goal, eventually resulting in a
wenzelm@7167
   641
  theorem with the current assumption context as hypotheses.
wenzelm@7335
   642
\item [$\SHOW{a}{\phi}$] is similar to $\HAVE{a}{\phi}$, but solves some
wenzelm@7895
   643
  pending goal with the result \emph{exported} into the corresponding context
wenzelm@7895
   644
  (cf.\ \S\ref{sec:proof-context}).
wenzelm@7895
   645
\item [$\HENCENAME$] abbreviates $\THEN~\HAVENAME$, i.e.\ claims a local goal
wenzelm@7895
   646
  to be proven by forward chaining the current facts.  Note that $\HENCENAME$
wenzelm@7895
   647
  is also equivalent to $\FROM{this}~\HAVENAME$.
wenzelm@7895
   648
\item [$\THUSNAME$] abbreviates $\THEN~\SHOWNAME$.  Note that $\THUSNAME$ is
wenzelm@7895
   649
  also equivalent to $\FROM{this}~\SHOWNAME$.
wenzelm@7167
   650
\end{descr}
wenzelm@7167
   651
wenzelm@7167
   652
wenzelm@7167
   653
\subsection{Initial and terminal proof steps}\label{sec:proof-steps}
wenzelm@7167
   654
wenzelm@7175
   655
\indexisarcmd{proof}\indexisarcmd{qed}\indexisarcmd{by}
wenzelm@7175
   656
\indexisarcmd{.}\indexisarcmd{..}\indexisarcmd{sorry}
wenzelm@7175
   657
\begin{matharray}{rcl}
wenzelm@7175
   658
  \isarcmd{proof} & : & \isartrans{proof(prove)}{proof(state)} \\
wenzelm@7175
   659
  \isarcmd{qed} & : & \isartrans{proof(state)}{proof(state) ~|~ theory} \\
wenzelm@7175
   660
  \isarcmd{by} & : & \isartrans{proof(prove)}{proof(state) ~|~ theory} \\
wenzelm@7175
   661
  \isarcmd{.\,.} & : & \isartrans{proof(prove)}{proof(state) ~|~ theory} \\
wenzelm@7175
   662
  \isarcmd{.} & : & \isartrans{proof(prove)}{proof(state) ~|~ theory} \\
wenzelm@7175
   663
  \isarcmd{sorry} & : & \isartrans{proof(prove)}{proof(state) ~|~ theory} \\
wenzelm@7175
   664
\end{matharray}
wenzelm@7175
   665
wenzelm@7335
   666
Arbitrary goal refinement via tactics is considered harmful.  Consequently the
wenzelm@7335
   667
Isar framework admits proof methods to be invoked in two places only.
wenzelm@7167
   668
\begin{enumerate}
wenzelm@7175
   669
\item An \emph{initial} refinement step $\PROOF{m@1}$ reduces a newly stated
wenzelm@7335
   670
  goal to a number of sub-goals that are to be solved later.  Facts are passed
wenzelm@7895
   671
  to $m@1$ for forward chaining, if so indicated by $proof(chain)$ mode.
wenzelm@7167
   672
  
wenzelm@7987
   673
\item A \emph{terminal} conclusion step $\QED{m@2}$ is intended to solve
wenzelm@7987
   674
  remaining goals.  No facts are passed to $m@2$.
wenzelm@7167
   675
\end{enumerate}
wenzelm@7167
   676
wenzelm@7335
   677
The only other proper way to affect pending goals is by $\SHOWNAME$ (or
wenzelm@7335
   678
$\THUSNAME$), which involves an explicit statement of what is to be solved.
wenzelm@7167
   679
wenzelm@7175
   680
\medskip
wenzelm@7175
   681
wenzelm@7167
   682
Also note that initial proof methods should either solve the goal completely,
wenzelm@7895
   683
or constitute some well-understood reduction to new sub-goals.  Arbitrary
wenzelm@7895
   684
automatic proof tools that are prone leave a large number of badly structured
wenzelm@7895
   685
sub-goals are no help in continuing the proof document in any intelligible
wenzelm@7987
   686
way.
wenzelm@7167
   687
wenzelm@7175
   688
\medskip
wenzelm@7175
   689
wenzelm@7175
   690
Unless given explicitly by the user, the default initial method is
wenzelm@7175
   691
``$default$'', which is usually set up to apply a single standard elimination
wenzelm@7458
   692
or introduction rule according to the topmost symbol involved.  There is no
wenzelm@7987
   693
separate default terminal method.  In any case, any goals left after that are
wenzelm@7987
   694
solved by assumption as the very last step.
wenzelm@7167
   695
wenzelm@7167
   696
\begin{rail}
wenzelm@7167
   697
  'proof' interest? meth? comment?
wenzelm@7167
   698
  ;
wenzelm@7167
   699
  'qed' meth? comment?
wenzelm@7167
   700
  ;
wenzelm@7167
   701
  'by' meth meth? comment?
wenzelm@7167
   702
  ;
wenzelm@7167
   703
  ('.' | '..' | 'sorry') comment?
wenzelm@7167
   704
  ;
wenzelm@7167
   705
wenzelm@7167
   706
  meth: method interest?
wenzelm@7167
   707
  ;
wenzelm@7167
   708
\end{rail}
wenzelm@7167
   709
wenzelm@7167
   710
\begin{descr}
wenzelm@7335
   711
\item [$\PROOF{m@1}$] refines the goal by proof method $m@1$; facts for
wenzelm@7335
   712
  forward chaining are passed if so indicated by $proof(chain)$ mode.
wenzelm@7335
   713
\item [$\QED{m@2}$] refines any remaining goals by proof method $m@2$ and
wenzelm@7895
   714
  concludes the sub-proof by assumption.  If the goal had been $\SHOWNAME$ (or
wenzelm@7895
   715
  $\THUSNAME$), some pending sub-goal is solved as well by the rule resulting
wenzelm@7895
   716
  from the result \emph{exported} into the enclosing goal context.  Thus
wenzelm@7895
   717
  $\QEDNAME$ may fail for two reasons: either $m@2$ fails, or the resulting
wenzelm@7895
   718
  rule does not fit to any pending goal\footnote{This includes any additional
wenzelm@7895
   719
    ``strong'' assumptions as introduced by $\ASSUMENAME$.} of the enclosing
wenzelm@7895
   720
  context.  Debugging such a situation might involve temporarily changing
wenzelm@7895
   721
  $\SHOWNAME$ into $\HAVENAME$, or weakening the local context by replacing
wenzelm@7895
   722
  some occurrences of $\ASSUMENAME$ by $\PRESUMENAME$.
wenzelm@7895
   723
\item [$\BYY{m@1}{m@2}$] is a \emph{terminal proof}\index{proof!terminal}; it
wenzelm@7987
   724
  abbreviates $\PROOF{m@1}~\QED{m@2}$, with backtracking across both methods,
wenzelm@7987
   725
  though.  Debugging an unsuccessful $\BYY{m@1}{m@2}$ commands might be done
wenzelm@7895
   726
  by expanding its definition; in many cases $\PROOF{m@1}$ is already
wenzelm@7175
   727
  sufficient to see what is going wrong.
wenzelm@7895
   728
\item [``$\DDOT$''] is a \emph{default proof}\index{proof!default}; it
wenzelm@8515
   729
  abbreviates $\BY{rule}$.
wenzelm@7895
   730
\item [``$\DOT$''] is a \emph{trivial proof}\index{proof!trivial}; it
wenzelm@8195
   731
  abbreviates $\BY{this}$.
wenzelm@8379
   732
\item [$\SORRY$] is a \emph{fake proof}\index{proof!fake}; provided that the
wenzelm@8379
   733
  \texttt{quick_and_dirty} flag is enabled, $\SORRY$ pretends to solve the
wenzelm@8515
   734
  goal without further ado.  Of course, the result would be a fake theorem
wenzelm@8515
   735
  only, involving some oracle in its internal derivation object (this is
wenzelm@8515
   736
  indicated as ``$[!]$'' in the printed result).  The main application of
wenzelm@8515
   737
  $\SORRY$ is to support experimentation and top-down proof development.
wenzelm@8515
   738
\end{descr}
wenzelm@8515
   739
wenzelm@8515
   740
wenzelm@8515
   741
\subsection{Fundamental methods and attributes}\label{sec:pure-meth-att}
wenzelm@8515
   742
wenzelm@8515
   743
The following proof methods and attributes refer to some basic logical
wenzelm@8515
   744
operations of Isar.  Further methods and attributes are provided by several
wenzelm@8515
   745
generic and object-logic specific tools and packages (see chapters
wenzelm@8515
   746
\ref{ch:gen-tools} and \ref{ch:hol-tools}).
wenzelm@8515
   747
wenzelm@8515
   748
\indexisarmeth{assumption}\indexisarmeth{this}\indexisarmeth{rule}\indexisarmeth{$-$}
wenzelm@8515
   749
\indexisaratt{intro}\indexisaratt{elim}\indexisaratt{dest}
wenzelm@8515
   750
\indexisaratt{OF}\indexisaratt{of}
wenzelm@8515
   751
\begin{matharray}{rcl}
wenzelm@8515
   752
  assumption & : & \isarmeth \\
wenzelm@8515
   753
  this & : & \isarmeth \\
wenzelm@8515
   754
  rule & : & \isarmeth \\
wenzelm@8515
   755
  - & : & \isarmeth \\
wenzelm@8515
   756
  OF & : & \isaratt \\
wenzelm@8515
   757
  of & : & \isaratt \\
wenzelm@8515
   758
  intro & : & \isaratt \\
wenzelm@8515
   759
  elim & : & \isaratt \\
wenzelm@8515
   760
  dest & : & \isaratt \\
wenzelm@8515
   761
  delrule & : & \isaratt \\
wenzelm@8515
   762
\end{matharray}
wenzelm@8515
   763
wenzelm@8515
   764
\begin{rail}
wenzelm@8515
   765
  'rule' thmrefs
wenzelm@8515
   766
  ;
wenzelm@8515
   767
  'OF' thmrefs
wenzelm@8515
   768
  ;
wenzelm@8515
   769
  'of' (inst * ) ('concl' ':' (inst * ))?
wenzelm@8515
   770
  ;
wenzelm@8515
   771
wenzelm@8515
   772
  inst: underscore | term
wenzelm@8515
   773
  ;
wenzelm@8515
   774
\end{rail}
wenzelm@8515
   775
wenzelm@8515
   776
\begin{descr}
wenzelm@8515
   777
\item [$assumption$] solves some goal by a single assumption step.  Any facts
wenzelm@8515
   778
  given (${} \le 1$) are guaranteed to participate in the refinement.  Recall
wenzelm@8515
   779
  that $\QEDNAME$ (see \S\ref{sec:proof-steps}) already concludes any
wenzelm@8515
   780
  remaining sub-goals by assumption.
wenzelm@8515
   781
\item [$this$] applies all of the current facts directly as rules.  Recall
wenzelm@8515
   782
  that ``$\DOT$'' (dot) abbreviates $\BY{this}$.
wenzelm@8515
   783
\item [$rule~thms$] applies some rule given as argument in backward manner;
wenzelm@8515
   784
  facts are used to reduce the rule before applying it to the goal.  Thus
wenzelm@8515
   785
  $rule$ without facts is plain \emph{introduction}, while with facts it
wenzelm@8515
   786
  becomes \emph{elimination}.
wenzelm@8515
   787
  
wenzelm@8515
   788
  When omitting the $thms$ argument, the $rule$ method tries to pick
wenzelm@8515
   789
  appropriate rules automatically, as declared in the current context using
wenzelm@8515
   790
  the $intro$, $elim$, $dest$ attributes (see below).  This is the default
wenzelm@8515
   791
  behavior of $\PROOFNAME$ and ``$\DDOT$'' (double-dot) steps (see
wenzelm@8515
   792
  \S\ref{sec:proof-steps}).
wenzelm@8515
   793
\item [``$-$''] does nothing but insert the forward chaining facts as premises
wenzelm@8515
   794
  into the goal.  Note that command $\PROOFNAME$ without any method actually
wenzelm@8515
   795
  performs a single reduction step using the $rule$ method; thus a plain
wenzelm@8515
   796
  \emph{do-nothing} proof step would be $\PROOF{-}$ rather than $\PROOFNAME$
wenzelm@8515
   797
  alone.
wenzelm@8515
   798
\item [$OF~thms$] applies $thms$ in parallel (cf.\ \texttt{MRS} in
wenzelm@8515
   799
  \cite[\S5]{isabelle-ref}, but note the reversed order).  Some premises may
wenzelm@8515
   800
  be skipped by including ``$\_$'' (underscore) as argument.
wenzelm@8515
   801
\item [$of~ts$] performs positional instantiation.  The terms $ts$ are
wenzelm@8515
   802
  substituted for any schematic variables occurring in a theorem from left to
wenzelm@8515
   803
  right; ``\texttt{_}'' (underscore) indicates to skip a position.  Arguments
wenzelm@8515
   804
  following a ``$concl\colon$'' specification refer to positions of the
wenzelm@8515
   805
  conclusion of a rule.
wenzelm@8515
   806
\item [$intro$, $elim$, and $dest$] declare introduction, elimination, and
wenzelm@8515
   807
  destruct rules, respectively.  Note that the classical reasoner (see
wenzelm@8515
   808
  \S\ref{sec:classical-basic}) introduces different versions of these
wenzelm@8515
   809
  attributes, and the $rule$ method, too.  In object-logics with classical
wenzelm@8515
   810
  reasoning enabled, the latter version should be used all the time to avoid
wenzelm@8515
   811
  confusion!
wenzelm@8515
   812
\item [$delrule$] undeclares introduction or elimination rules.
wenzelm@7315
   813
\end{descr}
wenzelm@7315
   814
wenzelm@7315
   815
wenzelm@7315
   816
\subsection{Term abbreviations}\label{sec:term-abbrev}
wenzelm@7315
   817
wenzelm@7315
   818
\indexisarcmd{let}
wenzelm@7315
   819
\begin{matharray}{rcl}
wenzelm@7315
   820
  \isarcmd{let} & : & \isartrans{proof(state)}{proof(state)} \\
wenzelm@7315
   821
  \isarkeyword{is} & : & syntax \\
wenzelm@7315
   822
\end{matharray}
wenzelm@7315
   823
wenzelm@7315
   824
Abbreviations may be either bound by explicit $\LET{p \equiv t}$ statements,
wenzelm@7987
   825
or by annotating assumptions or goal statements with a list of patterns
wenzelm@7987
   826
$\ISS{p@1\;\dots}{p@n}$.  In both cases, higher-order matching is invoked to
wenzelm@7987
   827
bind extra-logical term variables, which may be either named schematic
wenzelm@7987
   828
variables of the form $\Var{x}$, or nameless dummies ``\texttt{_}''
wenzelm@7987
   829
(underscore).\indexisarvar{_@\texttt{_}} Note that in the $\LETNAME$ form the
wenzelm@7987
   830
patterns occur on the left-hand side, while the $\ISNAME$ patterns are in
wenzelm@7987
   831
postfix position.
wenzelm@7315
   832
wenzelm@7319
   833
Term abbreviations are quite different from actual local definitions as
wenzelm@7319
   834
introduced via $\DEFNAME$ (see \S\ref{sec:proof-context}).  The latter are
wenzelm@7315
   835
visible within the logic as actual equations, while abbreviations disappear
wenzelm@7315
   836
during the input process just after type checking.
wenzelm@7315
   837
wenzelm@7315
   838
\begin{rail}
wenzelm@7315
   839
  'let' ((term + 'as') '=' term comment? + 'and')
wenzelm@7315
   840
  ;  
wenzelm@7315
   841
\end{rail}
wenzelm@7315
   842
wenzelm@7315
   843
The syntax of $\ISNAME$ patterns follows \railnonterm{termpat} or
wenzelm@7315
   844
\railnonterm{proppat} (see \S\ref{sec:term-pats}).
wenzelm@7315
   845
wenzelm@7315
   846
\begin{descr}
wenzelm@7315
   847
\item [$\LET{\vec p = \vec t}$] binds any text variables in patters $\vec p$
wenzelm@7315
   848
  by simultaneous higher-order matching against terms $\vec t$.
wenzelm@7315
   849
\item [$\IS{\vec p}$] resembles $\LETNAME$, but matches $\vec p$ against the
wenzelm@7315
   850
  preceding statement.  Also note that $\ISNAME$ is not a separate command,
wenzelm@7315
   851
  but part of others (such as $\ASSUMENAME$, $\HAVENAME$ etc.).
wenzelm@7315
   852
\end{descr}
wenzelm@7315
   853
wenzelm@7988
   854
A few \emph{automatic} term abbreviations\index{term abbreviations} for goals
wenzelm@7988
   855
and facts are available as well.  For any open goal,
wenzelm@7466
   856
$\Var{thesis_prop}$\indexisarvar{thesis-prop} refers to the full proposition
wenzelm@7466
   857
(which may be a rule), $\Var{thesis_concl}$\indexisarvar{thesis-concl} to its
wenzelm@7466
   858
(atomic) conclusion, and $\Var{thesis}$\indexisarvar{thesis} to its
wenzelm@7335
   859
object-logical statement.  The latter two abstract over any meta-level
wenzelm@7987
   860
parameters.
wenzelm@7315
   861
wenzelm@7466
   862
Fact statements resulting from assumptions or finished goals are bound as
wenzelm@7466
   863
$\Var{this_prop}$\indexisarvar{this-prop},
wenzelm@7466
   864
$\Var{this_concl}$\indexisarvar{this-concl}, and
wenzelm@7466
   865
$\Var{this}$\indexisarvar{this}, similar to $\Var{thesis}$ above.  In case
wenzelm@7466
   866
$\Var{this}$ refers to an object-logic statement that is an application
wenzelm@7895
   867
$f(t)$, then $t$ is bound to the special text variable
wenzelm@7466
   868
``$\dots$''\indexisarvar{\dots} (three dots).  The canonical application of
wenzelm@7987
   869
the latter are calculational proofs (see \S\ref{sec:calculation}).
wenzelm@7315
   870
wenzelm@7315
   871
wenzelm@7134
   872
\subsection{Block structure}
wenzelm@7134
   873
wenzelm@7397
   874
\indexisarcmd{next}\indexisarcmd{\{\{}\indexisarcmd{\}\}}
wenzelm@7397
   875
\begin{matharray}{rcl}
wenzelm@8448
   876
  \NEXT & : & \isartrans{proof(state)}{proof(state)} \\
wenzelm@7974
   877
  \BG & : & \isartrans{proof(state)}{proof(state)} \\
wenzelm@7974
   878
  \EN & : & \isartrans{proof(state)}{proof(state)} \\
wenzelm@7397
   879
\end{matharray}
wenzelm@7397
   880
wenzelm@7167
   881
While Isar is inherently block-structured, opening and closing blocks is
wenzelm@7167
   882
mostly handled rather casually, with little explicit user-intervention.  Any
wenzelm@7167
   883
local goal statement automatically opens \emph{two} blocks, which are closed
wenzelm@7167
   884
again when concluding the sub-proof (by $\QEDNAME$ etc.).  Sections of
wenzelm@8448
   885
different context within a sub-proof may be switched via $\NEXT$, which is
wenzelm@8448
   886
just a single block-close followed by block-open again.  Thus the effect of
wenzelm@8448
   887
$\NEXT$ to reset the local proof context. There is no goal focus involved
wenzelm@8448
   888
here!
wenzelm@7167
   889
wenzelm@7175
   890
For slightly more advanced applications, there are explicit block parentheses
wenzelm@7895
   891
as well.  These typically achieve a stronger forward style of reasoning.
wenzelm@7167
   892
wenzelm@7167
   893
\begin{descr}
wenzelm@8448
   894
\item [$\NEXT$] switches to a fresh block within a sub-proof, resetting the
wenzelm@8448
   895
  local context to the initial one.
wenzelm@7167
   896
\item [$\isarkeyword{\{\{}$ and $\isarkeyword{\}\}}$] explicitly open and
wenzelm@7895
   897
  close blocks.  Any current facts pass through ``$\isarkeyword{\{\{}$''
wenzelm@7895
   898
  unchanged, while ``$\isarkeyword{\}\}}$'' causes any result to be
wenzelm@7895
   899
  \emph{exported} into the enclosing context.  Thus fixed variables are
wenzelm@7895
   900
  generalized, assumptions discharged, and local definitions unfolded (cf.\ 
wenzelm@7895
   901
  \S\ref{sec:proof-context}).  There is no difference of $\ASSUMENAME$ and
wenzelm@7895
   902
  $\PRESUMENAME$ in this mode of forward reasoning --- in contrast to plain
wenzelm@7895
   903
  backward reasoning with the result exported at $\SHOWNAME$ time.
wenzelm@7167
   904
\end{descr}
wenzelm@7134
   905
wenzelm@7134
   906
wenzelm@8515
   907
\subsection{Emulating tactic scripts}
wenzelm@8515
   908
wenzelm@8515
   909
The following elements emulate unstructured tactic scripts to some extent.
wenzelm@8515
   910
While these are anathema for writing proper Isar proof documents, they might
wenzelm@8515
   911
come in handy for interactive exploration and debugging, or even actual
wenzelm@8515
   912
tactical proof within new-style theories (to benefit from document
wenzelm@8515
   913
preparation, for example).
wenzelm@8515
   914
wenzelm@8515
   915
\indexisarcmd{apply}\indexisarcmd{apply-end}
wenzelm@8515
   916
\indexisarcmd{defer}\indexisarcmd{prefer}\indexisarcmd{back}
wenzelm@8515
   917
\indexisarmeth{tactic}
wenzelm@8515
   918
\begin{matharray}{rcl}
wenzelm@8515
   919
  \isarcmd{apply} & : & \isartrans{proof(prove)}{proof(prove)} \\
wenzelm@8515
   920
  \isarcmd{apply_end} & : & \isartrans{proof(state)}{proof(state)} \\
wenzelm@8515
   921
  \isarcmd{defer} & : & \isartrans{proof}{proof} \\
wenzelm@8515
   922
  \isarcmd{prefer} & : & \isartrans{proof}{proof} \\
wenzelm@8515
   923
  \isarcmd{back} & : & \isartrans{proof}{proof} \\
wenzelm@8515
   924
  tactic & : & \isarmeth \\
wenzelm@8515
   925
\end{matharray}
wenzelm@8515
   926
wenzelm@8515
   927
\railalias{applyend}{apply\_end}
wenzelm@8515
   928
\railterm{applyend}
wenzelm@8515
   929
wenzelm@8515
   930
\begin{rail}
wenzelm@8515
   931
  'apply' method
wenzelm@8515
   932
  ;
wenzelm@8515
   933
  applyend method
wenzelm@8515
   934
  ;
wenzelm@8515
   935
  'defer' nat?
wenzelm@8515
   936
  ;
wenzelm@8515
   937
  'prefer' nat
wenzelm@8515
   938
  ;
wenzelm@8515
   939
  'tactic' text
wenzelm@8515
   940
  ;
wenzelm@8515
   941
\end{rail}
wenzelm@8515
   942
wenzelm@8515
   943
\begin{descr}
wenzelm@8515
   944
\item [$\isarkeyword{apply}~(m)$] applies proof method $m$ in an initial
wenzelm@8515
   945
  position, but retains ``$prove$'' mode (unlike $\PROOFNAME$).  Thus
wenzelm@8515
   946
  consecutive method applications may be given just as in tactic scripts.  In
wenzelm@8515
   947
  order to complete the proof properly, any of the actual structured proof
wenzelm@8515
   948
  commands (e.g.\ ``$\DOT$'') has to be given eventually.
wenzelm@8515
   949
  
wenzelm@8515
   950
  Facts are passed to $m$ as indicated by the goal's forward-chain mode.
wenzelm@8515
   951
  Common use of $\isarkeyword{apply}$ would be in a purely backward manner,
wenzelm@8515
   952
  though.
wenzelm@8515
   953
\item [$\isarkeyword{apply_end}~(m)$] applies proof method $m$ as if in
wenzelm@8515
   954
  terminal position.  Basically, this simulates a multi-step tactic script for
wenzelm@8515
   955
  $\QEDNAME$, but may be given anywhere within the proof body.
wenzelm@8515
   956
  
wenzelm@8515
   957
  No facts are passed to $m$.  Furthermore, the static context is that of the
wenzelm@8515
   958
  enclosing goal (as for actual $\QEDNAME$).  Thus the proof method may not
wenzelm@8515
   959
  refer to any assumptions introduced in the current body, for example.
wenzelm@8515
   960
\item [$\isarkeyword{defer}~n$ and $\isarkeyword{prefer}~n$] shuffle the list
wenzelm@8515
   961
  of pending goals: $defer$ puts off goal $n$ to the end of the list ($n = 1$
wenzelm@8515
   962
  by default), while $prefer$ brings goal $n$ to the top.
wenzelm@8515
   963
\item [$\isarkeyword{back}$] does back-tracking over the result sequence of
wenzelm@8515
   964
  the latest proof command.\footnote{Unlike the ML function \texttt{back}
wenzelm@8515
   965
    \cite{isabelle-ref}, the Isar command does not search upwards for further
wenzelm@8515
   966
    branch points.} Basically, any proof command may return multiple results.
wenzelm@8515
   967
\item [$tactic~text$] produces a proof method from any ML text of type
wenzelm@8515
   968
  \texttt{tactic}.  Apart from the usual ML environment, and the current
wenzelm@8515
   969
  implicit theory context, the ML code may refer to the following locally
wenzelm@8515
   970
  bound values:
wenzelm@8515
   971
%%FIXME ttbox produces too much trailing space (why?)
wenzelm@8515
   972
{\footnotesize\begin{verbatim}
wenzelm@8515
   973
val ctxt  : Proof.context
wenzelm@8515
   974
val facts : thm list
wenzelm@8515
   975
val thm   : string -> thm
wenzelm@8515
   976
val thms  : string -> thm list
wenzelm@8515
   977
\end{verbatim}}
wenzelm@8515
   978
  Here \texttt{ctxt} refers to the current proof context, \texttt{facts}
wenzelm@8515
   979
  indicates any current facts for forward-chaining, and
wenzelm@8515
   980
  \texttt{thm}~/~\texttt{thms} retrieve named facts (including global
wenzelm@8515
   981
  theorems) from the context.
wenzelm@8515
   982
\end{descr}
wenzelm@8515
   983
wenzelm@8515
   984
wenzelm@8515
   985
\subsection{Meta-linguistic features}
wenzelm@8515
   986
wenzelm@8515
   987
\indexisarcmd{oops}
wenzelm@8515
   988
\begin{matharray}{rcl}
wenzelm@8515
   989
  \isarcmd{oops} & : & \isartrans{proof}{theory} \\
wenzelm@8515
   990
\end{matharray}
wenzelm@8515
   991
wenzelm@8515
   992
The $\OOPS$ command discontinues the current proof attempt, while considering
wenzelm@8515
   993
the partial proof text as properly processed.  This is conceptually quite
wenzelm@8515
   994
different from ``faking'' actual proofs via $\SORRY$ (see
wenzelm@8515
   995
\S\ref{sec:proof-steps}): $\OOPS$ does not observe the proof structure at all,
wenzelm@8515
   996
but goes back right to the theory level.  Furthermore, $\OOPS$ does not
wenzelm@8515
   997
produce any result theorem --- there is no claim to be able to complete the
wenzelm@8515
   998
proof anyhow.
wenzelm@8515
   999
wenzelm@8515
  1000
A typical application of $\OOPS$ is to explain Isar proofs \emph{within} the
wenzelm@8515
  1001
system itself, in conjunction with the document preparation tools of Isabelle
wenzelm@8515
  1002
described in \cite{isabelle-sys}.  Thus partial or even wrong proof attempts
wenzelm@8515
  1003
can be discussed in a logically sound manner.  Note that the Isabelle {\LaTeX}
wenzelm@8515
  1004
macros can be easily adapted to print something like ``$\dots$'' instead of an
wenzelm@8515
  1005
``$\OOPS$'' keyword.
wenzelm@8515
  1006
wenzelm@8515
  1007
\medskip The $\OOPS$ command is undoable, in contrast to $\isarkeyword{kill}$
wenzelm@8515
  1008
(see \S\ref{sec:history}).  The effect is to get back to the theory
wenzelm@8515
  1009
\emph{before} the opening of the proof.
wenzelm@8515
  1010
wenzelm@8515
  1011
%FIXME remove
wenzelm@8515
  1012
% \begin{descr}
wenzelm@8515
  1013
% \item [$\isarkeyword{oops}$] dismisses the current proof, leaving the text in
wenzelm@8515
  1014
%   as properly processed.
wenzelm@8515
  1015
% \end{descr}
wenzelm@8515
  1016
wenzelm@8515
  1017
wenzelm@7134
  1018
\section{Other commands}
wenzelm@7134
  1019
wenzelm@8448
  1020
\subsection{Diagnostics}\label{sec:diag}
wenzelm@7134
  1021
wenzelm@8485
  1022
\indexisarcmd{pr}\indexisarcmd{thm}\indexisarcmd{term}\indexisarcmd{prop}\indexisarcmd{typ}
wenzelm@8485
  1023
\indexisarcmd{print-facts}\indexisarcmd{print-binds}
wenzelm@7134
  1024
\begin{matharray}{rcl}
wenzelm@8515
  1025
  \isarcmd{help}^* & : & \isarkeep{\cdot} \\
wenzelm@8515
  1026
  \isarcmd{pr}^* & : & \isarkeep{\cdot} \\
wenzelm@8515
  1027
  \isarcmd{thm}^* & : & \isarkeep{theory~|~proof} \\
wenzelm@8515
  1028
  \isarcmd{term}^* & : & \isarkeep{theory~|~proof} \\
wenzelm@8515
  1029
  \isarcmd{prop}^* & : & \isarkeep{theory~|~proof} \\
wenzelm@8515
  1030
  \isarcmd{typ}^* & : & \isarkeep{theory~|~proof} \\
wenzelm@8515
  1031
  \isarcmd{print_facts}^* & : & \isarkeep{proof} \\
wenzelm@8515
  1032
  \isarcmd{print_binds}^* & : & \isarkeep{proof} \\
wenzelm@7134
  1033
\end{matharray}
wenzelm@7134
  1034
wenzelm@7335
  1035
These commands are not part of the actual Isabelle/Isar syntax, but assist
wenzelm@7335
  1036
interactive development.  Also note that $undo$ does not apply here, since the
wenzelm@7335
  1037
theory or proof configuration is not changed.
wenzelm@7335
  1038
wenzelm@7134
  1039
\begin{rail}
wenzelm@8485
  1040
  'pr' modes? nat?
wenzelm@7134
  1041
  ;
wenzelm@8485
  1042
  'thm' modes? thmrefs
wenzelm@8485
  1043
  ;
wenzelm@8485
  1044
  'term' modes? term
wenzelm@7134
  1045
  ;
wenzelm@8485
  1046
  'prop' modes? prop
wenzelm@7134
  1047
  ;
wenzelm@8485
  1048
  'typ' modes? type
wenzelm@8485
  1049
  ;
wenzelm@8485
  1050
wenzelm@8485
  1051
  modes: '(' (name + ) ')'
wenzelm@7134
  1052
  ;
wenzelm@7134
  1053
\end{rail}
wenzelm@7134
  1054
wenzelm@7167
  1055
\begin{descr}
wenzelm@8515
  1056
\item [$\isarkeyword{help}$] prints a list of available language elements.
wenzelm@8515
  1057
  Note that methods and attributes depend on the current theory context.
wenzelm@8485
  1058
\item [$\isarkeyword{pr}~n$] prints the current top-level state, i.e.\ the
wenzelm@8485
  1059
  theory identifier or proof state.  The latter includes the proof context,
wenzelm@8485
  1060
  current facts and goals.  The optional argument $n$ affects the implicit
wenzelm@8485
  1061
  limit of goals to be displayed, which is initially 10.  Omitting the limit
wenzelm@8485
  1062
  leaves the value unchanged.
wenzelm@7974
  1063
\item [$\isarkeyword{thm}~thms$] retrieves lists of theorems from the current
wenzelm@7974
  1064
  theory or proof context.  Note that any attributes included in the theorem
wenzelm@7974
  1065
  specifications are applied to a temporary context derived from the current
wenzelm@7974
  1066
  theory or proof; the result is discarded, i.e.\ attributes involved in
wenzelm@7974
  1067
  $thms$ do not have any permanent effect.
wenzelm@7987
  1068
\item [$\isarkeyword{term}~t$, $\isarkeyword{prop}~\phi$] read, type-check and
wenzelm@7987
  1069
  print terms or propositions according to the current theory or proof
wenzelm@7895
  1070
  context; the inferred type of $t$ is output as well.  Note that these
wenzelm@7895
  1071
  commands are also useful in inspecting the current environment of term
wenzelm@7895
  1072
  abbreviations.
wenzelm@7974
  1073
\item [$\isarkeyword{typ}~\tau$] reads and prints types of the meta-logic
wenzelm@7974
  1074
  according to the current theory or proof context.
wenzelm@8379
  1075
\item [$\isarkeyword{print_facts}$] prints any named facts of the current
wenzelm@8379
  1076
  context, including assumptions and local results.
wenzelm@8379
  1077
\item [$\isarkeyword{print_binds}$] prints all term abbreviations present in
wenzelm@8379
  1078
  the context.
wenzelm@8485
  1079
\end{descr}
wenzelm@8485
  1080
wenzelm@8485
  1081
The basic diagnostic commands above admit a list of $modes$ to be specified,
wenzelm@8485
  1082
which is appended to the current print mode (see also \cite{isabelle-ref}).
wenzelm@8485
  1083
Thus the output behavior may be modified according particular print mode
wenzelm@8485
  1084
features.
wenzelm@8485
  1085
wenzelm@8485
  1086
\medskip
wenzelm@8485
  1087
wenzelm@8485
  1088
For example, $\isarkeyword{pr}~(latex~xsymbols~symbols)$ would print the
wenzelm@8485
  1089
current proof state with mathematical symbols and special characters
wenzelm@8485
  1090
represented in {\LaTeX} source, according to the Isabelle style
wenzelm@8485
  1091
\cite{isabelle-sys}.  The resulting text can be directly pasted into and
wenzelm@8485
  1092
\verb,\begin{isabelle},\dots\verb,\end{isabelle}, environment.
wenzelm@8485
  1093
wenzelm@8485
  1094
Note that $\isarkeyword{pr}~(latex)$ is sufficient to achieve the same output,
wenzelm@8485
  1095
if the current Isabelle session has the other modes already activated, say due
wenzelm@8485
  1096
to some particular user interface configuration such as Proof~General
wenzelm@8510
  1097
\cite{proofgeneral,Aspinall:TACAS:2000} with X-Symbol mode \cite{x-symbol}.
wenzelm@8485
  1098
wenzelm@8485
  1099
wenzelm@8485
  1100
\subsection{History commands}\label{sec:history}
wenzelm@8485
  1101
wenzelm@8485
  1102
\indexisarcmd{undo}\indexisarcmd{redo}\indexisarcmd{kill}
wenzelm@8485
  1103
\begin{matharray}{rcl}
wenzelm@8485
  1104
  \isarcmd{undo}^{{*}{*}} & : & \isarkeep{\cdot} \\
wenzelm@8485
  1105
  \isarcmd{redo}^{{*}{*}} & : & \isarkeep{\cdot} \\
wenzelm@8485
  1106
  \isarcmd{kill}^{{*}{*}} & : & \isarkeep{\cdot} \\
wenzelm@8485
  1107
\end{matharray}
wenzelm@8485
  1108
wenzelm@8485
  1109
The Isabelle/Isar top-level maintains a two-stage history, for theory and
wenzelm@8485
  1110
proof state transformation.  Basically, any command can be undone using
wenzelm@8485
  1111
$\isarkeyword{undo}$, excluding mere diagnostic elements.  Its effect may be
wenzelm@8485
  1112
revoked via $\isarkeyword{redo}$, unless the corresponding the
wenzelm@8485
  1113
$\isarkeyword{undo}$ step has crossed the beginning of a proof or theory.  The
wenzelm@8485
  1114
$\isarkeyword{kill}$ command aborts the current history node altogether,
wenzelm@8485
  1115
discontinuing a proof or even the whole theory.  This operation is \emph{not}
wenzelm@8485
  1116
undoable.
wenzelm@8485
  1117
wenzelm@8485
  1118
\begin{warn}
wenzelm@8485
  1119
  History commands may not be used with user interfaces such as Proof~General
wenzelm@8510
  1120
  \cite{proofgeneral,Aspinall:TACAS:2000}, which takes care of stepping forth
wenzelm@8510
  1121
  and back itself.  Interfering with manual $\isarkeyword{undo}$,
wenzelm@8510
  1122
  $\isarkeyword{redo}$, or even $\isarkeyword{kill}$ commands would quickly
wenzelm@8510
  1123
  result in utter confusion.
wenzelm@8485
  1124
\end{warn}
wenzelm@8485
  1125
wenzelm@8515
  1126
%FIXME remove
wenzelm@8515
  1127
% \begin{descr}
wenzelm@8515
  1128
% \item [$\isarkeyword{undo}$] revokes the latest state-transforming command.
wenzelm@8515
  1129
% \item [$\isarkeyword{redo}$] undos the latest $\isarkeyword{undo}$.
wenzelm@8515
  1130
% \item [$\isarkeyword{kill}$] aborts the current history level.
wenzelm@8515
  1131
% \end{descr}
wenzelm@8485
  1132
wenzelm@8379
  1133
wenzelm@7134
  1134
\subsection{System operations}
wenzelm@7134
  1135
wenzelm@7167
  1136
\indexisarcmd{cd}\indexisarcmd{pwd}\indexisarcmd{use-thy}\indexisarcmd{use-thy-only}
wenzelm@7167
  1137
\indexisarcmd{update-thy}\indexisarcmd{update-thy-only}
wenzelm@7134
  1138
\begin{matharray}{rcl}
wenzelm@8515
  1139
  \isarcmd{cd}^* & : & \isarkeep{\cdot} \\
wenzelm@8515
  1140
  \isarcmd{pwd}^* & : & \isarkeep{\cdot} \\
wenzelm@8515
  1141
  \isarcmd{use_thy}^* & : & \isarkeep{\cdot} \\
wenzelm@8515
  1142
  \isarcmd{use_thy_only}^* & : & \isarkeep{\cdot} \\
wenzelm@8515
  1143
  \isarcmd{update_thy}^* & : & \isarkeep{\cdot} \\
wenzelm@8515
  1144
  \isarcmd{update_thy_only}^* & : & \isarkeep{\cdot} \\
wenzelm@7134
  1145
\end{matharray}
wenzelm@7134
  1146
wenzelm@7167
  1147
\begin{descr}
wenzelm@7134
  1148
\item [$\isarkeyword{cd}~name$] changes the current directory of the Isabelle
wenzelm@7134
  1149
  process.
wenzelm@7134
  1150
\item [$\isarkeyword{pwd}~$] prints the current working directory.
wenzelm@7175
  1151
\item [$\isarkeyword{use_thy}$, $\isarkeyword{use_thy_only}$,
wenzelm@7987
  1152
  $\isarkeyword{update_thy}$, $\isarkeyword{update_thy_only}$] load some
wenzelm@7895
  1153
  theory given as $name$ argument.  These commands are basically the same as
wenzelm@7987
  1154
  the corresponding ML functions\footnote{The ML versions also change the
wenzelm@7987
  1155
    implicit theory context to that of the theory loaded.}  (see also
wenzelm@7987
  1156
  \cite[\S1,\S6]{isabelle-ref}).  Note that both the ML and Isar versions may
wenzelm@7987
  1157
  load new- and old-style theories alike.
wenzelm@7167
  1158
\end{descr}
wenzelm@7134
  1159
wenzelm@7987
  1160
These system commands are scarcely used when working with the Proof~General
wenzelm@7987
  1161
interface, since loading of theories is done fully transparently.
wenzelm@7134
  1162
wenzelm@8379
  1163
wenzelm@7046
  1164
%%% Local Variables: 
wenzelm@7046
  1165
%%% mode: latex
wenzelm@7046
  1166
%%% TeX-master: "isar-ref"
wenzelm@7046
  1167
%%% End: