doc-src/LaTeXsugar/Sugar/Sugar.thy
author nipkow
Fri Aug 31 12:24:00 2007 +0200 (2007-08-31)
changeset 24496 65f3b37f80b7
parent 22834 bf67f798f063
child 24497 7840f760a744
permissions -rw-r--r--
added short_names explanation
nipkow@15337
     1
(*<*)
nipkow@15337
     2
theory Sugar
kleing@15366
     3
imports LaTeXsugar OptionalSugar
nipkow@15337
     4
begin
nipkow@15337
     5
(*>*)
nipkow@15337
     6
nipkow@15337
     7
section "Introduction"
nipkow@15337
     8
kleing@15385
     9
text{* This document is for those Isabelle users who have mastered
nipkow@15337
    10
the art of mixing \LaTeX\ text and Isabelle theories and never want to
nipkow@15337
    11
typeset a theorem by hand anymore because they have experienced the
nipkow@15337
    12
bliss of writing \verb!@!\verb!{thm[display]setsum_cartesian_product[no_vars]}!
nipkow@15337
    13
and seeing Isabelle typeset it for them:
nipkow@15337
    14
@{thm[display,eta_contract=false] setsum_cartesian_product[no_vars]}
nipkow@15342
    15
No typos, no omissions, no sweat.
nipkow@15342
    16
If you have not experienced that joy, read Chapter 4, \emph{Presenting
nipkow@15342
    17
Theories}, \cite{LNCS2283} first.
nipkow@15337
    18
nipkow@15337
    19
If you have mastered the art of Isabelle's \emph{antiquotations},
nipkow@15337
    20
i.e.\ things like the above \verb!@!\verb!{thm...}!, beware: in your vanity
nipkow@15337
    21
you may be tempted to think that all readers of the stunning ps or pdf
nipkow@15337
    22
documents you can now produce at the drop of a hat will be struck with
nipkow@15337
    23
awe at the beauty unfolding in front of their eyes. Until one day you
nipkow@15337
    24
come across that very critical of readers known as the ``common referee''.
nipkow@15337
    25
He has the nasty habit of refusing to understand unfamiliar notation
nipkow@15337
    26
like Isabelle's infamous @{text"\<lbrakk> \<rbrakk> \<Longrightarrow>"} no matter how many times you
nipkow@15337
    27
explain it in your paper. Even worse, he thinks that using @{text"\<lbrakk>
nipkow@15337
    28
\<rbrakk>"} for anything other than denotational semantics is a cardinal sin
nipkow@15342
    29
that must be punished by instant rejection.
nipkow@15337
    30
nipkow@15337
    31
nipkow@15337
    32
This document shows you how to make Isabelle and \LaTeX\ cooperate to
nipkow@15337
    33
produce ordinary looking mathematics that hides the fact that it was
nipkow@15471
    34
typeset by a machine. You merely need to load the right files:
nipkow@15471
    35
\begin{itemize}
nipkow@15471
    36
\item Import theory \texttt{LaTeXsugar} in the header of your own
nipkow@15471
    37
theory.  You may also want bits of \texttt{OptionalSugar}, which you can
nipkow@15471
    38
copy selectively into your own theory or import as a whole.  Both
nipkow@15471
    39
theories live in \texttt{HOL/Library} and are found automatically.
kleing@15378
    40
nipkow@15471
    41
\item Should you need additional \LaTeX\ packages (the text will tell
nipkow@15471
    42
you so), you include them at the beginning of your \LaTeX\ document,
nipkow@16153
    43
typically in \texttt{root.tex}. For a start, you should
nipkow@16153
    44
\verb!\usepackage{amssymb}! --- otherwise typesetting
nipkow@16153
    45
@{prop[source]"\<not>(\<exists>x. P x)"} will fail because the AMS symbol
nipkow@16153
    46
@{text"\<nexists>"} is missing.
nipkow@15471
    47
\end{itemize}
nipkow@15342
    48
*}
nipkow@15342
    49
nipkow@15342
    50
section{* HOL syntax*}
nipkow@15342
    51
nipkow@15342
    52
subsection{* Logic *}
nipkow@15342
    53
nipkow@16153
    54
text{* 
nipkow@16153
    55
  The formula @{prop[source]"\<not>(\<exists>x. P x)"} is typeset as @{prop"~(EX x. P x)"}.
nipkow@16153
    56
nipkow@16153
    57
The predefined constructs @{text"if"}, @{text"let"} and
nipkow@15342
    58
@{text"case"} are set in sans serif font to distinguish them from
nipkow@15342
    59
other functions. This improves readability:
nipkow@15342
    60
\begin{itemize}
nipkow@15342
    61
\item @{term"if b then e\<^isub>1 else e\<^isub>2"} instead of @{text"if b then e\<^isub>1 else e\<^isub>2"}.
nipkow@15342
    62
\item @{term"let x = e\<^isub>1 in e\<^isub>2"} instead of @{text"let x = e\<^isub>1 in e\<^isub>2"}.
nipkow@15342
    63
\item @{term"case x of True \<Rightarrow> e\<^isub>1 | False \<Rightarrow> e\<^isub>2"} instead of\\
nipkow@15342
    64
      @{text"case x of True \<Rightarrow> e\<^isub>1 | False \<Rightarrow> e\<^isub>2"}.
nipkow@15342
    65
\end{itemize}
nipkow@15342
    66
*}
nipkow@15342
    67
nipkow@15342
    68
subsection{* Sets *}
nipkow@15337
    69
nipkow@15342
    70
text{* Although set syntax in HOL is already close to
nipkow@15342
    71
standard, we provide a few further improvements:
nipkow@15342
    72
\begin{itemize}
nipkow@15342
    73
\item @{term"{x. P}"} instead of @{text"{x. P}"}.
nipkow@15342
    74
\item @{term"{}"} instead of @{text"{}"}.
nipkow@15342
    75
\item @{term"insert a (insert b (insert c M))"} instead of @{text"insert a (insert b (insert c M))"}.
nipkow@15342
    76
\end{itemize}
nipkow@15342
    77
*}
nipkow@15342
    78
nipkow@15342
    79
subsection{* Lists *}
nipkow@15342
    80
nipkow@15342
    81
text{* If lists are used heavily, the following notations increase readability:
nipkow@15342
    82
\begin{itemize}
nipkow@15342
    83
\item @{term"x # xs"} instead of @{text"x # xs"}.
nipkow@15342
    84
      Exceptionally, @{term"x # xs"} is also input syntax.
nipkow@15342
    85
If you prefer more space around the $\cdot$ you have to redefine
nipkow@15342
    86
\verb!\isasymcdot! in \LaTeX:
nipkow@15342
    87
\verb!\renewcommand{\isasymcdot}{\isamath{\,\cdot\,}}!
nipkow@15342
    88
nipkow@15342
    89
\item @{term"length xs"} instead of @{text"length xs"}.
kleing@15385
    90
\item @{term"nth xs n"} instead of @{text"nth xs n"},
nipkow@15342
    91
      the $n$th element of @{text xs}.
nipkow@15342
    92
nipkow@22834
    93
\item Human readers are good at converting automatically from lists to
nipkow@22834
    94
sets. Hence \texttt{OptionalSugar} contains syntax for supressing the
nipkow@22834
    95
conversion function @{const set}: for example, @{prop[source]"x \<in> set xs"}
nipkow@22834
    96
becomes @{prop"x \<in> set xs"}.
nipkow@22834
    97
kleing@15366
    98
\item The @{text"@"} operation associates implicitly to the right,
kleing@15366
    99
which leads to unpleasant line breaks if the term is too long for one
kleing@15366
   100
line. To avoid this, \texttt{OptionalSugar} contains syntax to group
kleing@15366
   101
@{text"@"}-terms to the left before printing, which leads to better
kleing@15366
   102
line breaking behaviour:
wenzelm@15673
   103
@{term[display]"term\<^isub>0 @ term\<^isub>1 @ term\<^isub>2 @ term\<^isub>3 @ term\<^isub>4 @ term\<^isub>5 @ term\<^isub>6 @ term\<^isub>7 @ term\<^isub>8 @ term\<^isub>9 @ term\<^isub>1\<^isub>0"}
kleing@15366
   104
nipkow@15342
   105
\end{itemize}
nipkow@15337
   106
*}
nipkow@15337
   107
nipkow@15337
   108
section "Printing theorems"
nipkow@15337
   109
nipkow@15689
   110
subsection "Question marks"
nipkow@15689
   111
nipkow@15689
   112
text{* If you print anything, especially theorems, containing
nipkow@15689
   113
schematic variables they are prefixed with a question mark:
nipkow@15689
   114
\verb!@!\verb!{thm conjI}! results in @{thm conjI}. Most of the time
nipkow@15689
   115
you would rather not see the question marks. There is an attribute
nipkow@15689
   116
\verb!no_vars! that you can attach to the theorem that turns its
nipkow@15689
   117
schematic into ordinary free variables: \verb!@!\verb!{thm conjI[no_vars]}!
nipkow@15689
   118
results in @{thm conjI[no_vars]}.
nipkow@15689
   119
nipkow@15689
   120
This \verb!no_vars! business can become a bit tedious.
nipkow@15689
   121
If you would rather never see question marks, simply put
nipkow@15689
   122
\begin{verbatim}
wenzelm@15983
   123
reset show_question_marks;
nipkow@15689
   124
\end{verbatim}
nipkow@15689
   125
at the beginning of your file \texttt{ROOT.ML}.
nipkow@15689
   126
The rest of this document is produced with this flag reset.
nipkow@16075
   127
nipkow@16075
   128
Hint: Resetting \verb!show_question_marks! only supresses question
nipkow@16075
   129
marks; variables that end in digits, e.g. @{text"x1"}, are still
nipkow@16075
   130
printed with a trailing @{text".0"}, e.g. @{text"x1.0"}, their
nipkow@16075
   131
internal index. This can be avoided by turning the last digit into a
nipkow@16075
   132
subscript: write \verb!x\<^isub>1! and obtain the much nicer @{text"x\<^isub>1"}. *}
nipkow@15689
   133
wenzelm@15983
   134
(*<*)ML"reset show_question_marks"(*>*)
nipkow@15689
   135
nipkow@24496
   136
subsection {*Qualified names*}
nipkow@24496
   137
nipkow@24496
   138
text{* If there are multiple declarations of the same name, Isabelle prints
nipkow@24496
   139
the qualified name, for example @{text "T.length"}, where @{text T} is the
nipkow@24496
   140
theory it is defined in, to distinguish it from the predefined @{const[source]
nipkow@24496
   141
"List.length"}. In case there is no danger of confusion, you can insist on
nipkow@24496
   142
short names (no qualifiers) by setting \verb!short_names!, typically
nipkow@24496
   143
in \texttt{ROOT.ML}:
nipkow@24496
   144
\begin{verbatim}
nipkow@24496
   145
set short_names;
nipkow@24496
   146
\end{verbatim}
nipkow@24496
   147
*}
nipkow@24496
   148
nipkow@17127
   149
subsection {*Variable names\label{sec:varnames}*}
nipkow@16395
   150
nipkow@16395
   151
text{* It sometimes happens that you want to change the name of a
nipkow@16395
   152
variable in a theorem before printing it. This can easily be achieved
nipkow@16395
   153
with the help of Isabelle's instantiation attribute \texttt{where}:
nipkow@16395
   154
@{thm conjI[where P = \<phi> and Q = \<psi>]} is the result of
nipkow@16395
   155
\begin{quote}
nipkow@16395
   156
\verb!@!\verb!{thm conjI[where P = \<phi> and Q = \<psi>]}!
nipkow@16395
   157
\end{quote}
nipkow@16395
   158
To support the ``\_''-notation for irrelevant variables
nipkow@16395
   159
the constant \texttt{DUMMY} has been introduced:
nipkow@16395
   160
@{thm fst_conv[where b = DUMMY]} is produced by
nipkow@16395
   161
\begin{quote}
nipkow@16395
   162
\verb!@!\verb!{thm fst_conv[where b = DUMMY]}!
nipkow@16395
   163
\end{quote}
nipkow@16395
   164
*}
nipkow@16395
   165
nipkow@15337
   166
subsection "Inference rules"
nipkow@15337
   167
nipkow@15342
   168
text{* To print theorems as inference rules you need to include Didier
nipkow@15342
   169
R\'emy's \texttt{mathpartir} package~\cite{mathpartir}
nipkow@15342
   170
for typesetting inference rules in your \LaTeX\ file.
nipkow@15337
   171
nipkow@15689
   172
Writing \verb!@!\verb!{thm[mode=Rule] conjI}! produces
nipkow@15689
   173
@{thm[mode=Rule] conjI}, even in the middle of a sentence.
nipkow@15342
   174
If you prefer your inference rule on a separate line, maybe with a name,
nipkow@15342
   175
\begin{center}
nipkow@15689
   176
@{thm[mode=Rule] conjI} {\sc conjI}
nipkow@15342
   177
\end{center}
nipkow@15342
   178
is produced by
nipkow@15337
   179
\begin{quote}
nipkow@15337
   180
\verb!\begin{center}!\\
nipkow@15689
   181
\verb!@!\verb!{thm[mode=Rule] conjI} {\sc conjI}!\\
nipkow@15337
   182
\verb!\end{center}!
nipkow@15337
   183
\end{quote}
nipkow@15342
   184
It is not recommended to use the standard \texttt{display} attribute
nipkow@15342
   185
together with \texttt{Rule} because centering does not work and because
nipkow@15342
   186
the line breaking mechanisms of \texttt{display} and \texttt{mathpartir} can
nipkow@15342
   187
clash.
nipkow@15342
   188
nipkow@15337
   189
Of course you can display multiple rules in this fashion:
nipkow@15337
   190
\begin{quote}
nipkow@15337
   191
\verb!\begin{center}\isastyle!\\
nipkow@15689
   192
\verb!@!\verb!{thm[mode=Rule] conjI} {\sc conjI} \\[1ex]!\\
nipkow@15689
   193
\verb!@!\verb!{thm[mode=Rule] conjE} {\sc disjI$_1$} \qquad!\\
nipkow@15689
   194
\verb!@!\verb!{thm[mode=Rule] disjE} {\sc disjI$_2$}!\\
nipkow@15337
   195
\verb!\end{center}!
nipkow@15337
   196
\end{quote}
nipkow@15337
   197
yields
nipkow@15337
   198
\begin{center}\isastyle
nipkow@15689
   199
@{thm[mode=Rule] conjI} {\sc conjI} \\[1ex]
nipkow@15689
   200
@{thm[mode=Rule] disjI1} {\sc disjI$_1$} \qquad
nipkow@15689
   201
@{thm[mode=Rule] disjI2} {\sc disjI$_2$}
nipkow@15337
   202
\end{center}
nipkow@15337
   203
Note that we included \verb!\isastyle! to obtain
nipkow@15337
   204
the smaller font that otherwise comes only with \texttt{display}.
nipkow@15337
   205
nipkow@15342
   206
The \texttt{mathpartir} package copes well if there are too many
nipkow@15342
   207
premises for one line:
nipkow@15342
   208
\begin{center}
nipkow@15342
   209
@{prop[mode=Rule] "\<lbrakk> A \<longrightarrow> B; B \<longrightarrow> C; C \<longrightarrow> D; D \<longrightarrow> E; E \<longrightarrow> F; F \<longrightarrow> G;
nipkow@15342
   210
 G \<longrightarrow> H; H \<longrightarrow> I; I \<longrightarrow> J; J \<longrightarrow> K \<rbrakk> \<Longrightarrow> A \<longrightarrow> K"}
nipkow@15342
   211
\end{center}
nipkow@15342
   212
nipkow@15471
   213
Limitations: 1. Premises and conclusion must each not be longer than
nipkow@15471
   214
the line.  2. Premises that are @{text"\<Longrightarrow>"}-implications are again
nipkow@15471
   215
displayed with a horizontal line, which looks at least unusual.
nipkow@15471
   216
schirmer@22329
   217
schirmer@22329
   218
In case you print theorems without premises no rule will be printed by the
schirmer@22329
   219
\texttt{Rule} print mode. However, you can use \texttt{Axiom} instead:
schirmer@22329
   220
\begin{quote}
schirmer@22329
   221
\verb!\begin{center}\isastyle!\\
schirmer@22329
   222
\verb!@!\verb!{thm[mode=Axiom] refl} {\sc refl}! \\
schirmer@22329
   223
\verb!\end{center}!
schirmer@22329
   224
\end{quote}
schirmer@22329
   225
yields
schirmer@22329
   226
\begin{center}\isastyle
schirmer@22329
   227
@{thm[mode=Axiom] refl} {\sc refl} 
schirmer@22329
   228
\end{center}
schirmer@22329
   229
schirmer@22329
   230
schirmer@22329
   231
nipkow@15337
   232
*}
nipkow@15342
   233
nipkow@15342
   234
subsection{*If-then*}
nipkow@15342
   235
nipkow@15342
   236
text{* If you prefer a fake ``natural language'' style you can produce
nipkow@15342
   237
the body of
nipkow@15342
   238
\newtheorem{theorem}{Theorem}
nipkow@15342
   239
\begin{theorem}
nipkow@15689
   240
@{thm[mode=IfThen] le_trans}
nipkow@15342
   241
\end{theorem}
nipkow@15342
   242
by typing
nipkow@15342
   243
\begin{quote}
nipkow@15689
   244
\verb!@!\verb!{thm[mode=IfThen] le_trans}!
nipkow@15342
   245
\end{quote}
nipkow@15342
   246
nipkow@15342
   247
In order to prevent odd line breaks, the premises are put into boxes.
nipkow@15342
   248
At times this is too drastic:
nipkow@15342
   249
\begin{theorem}
nipkow@15342
   250
@{prop[mode=IfThen] "longpremise \<Longrightarrow> longerpremise \<Longrightarrow> P(f(f(f(f(f(f(f(f(f(x)))))))))) \<Longrightarrow> longestpremise \<Longrightarrow> conclusion"}
nipkow@15342
   251
\end{theorem}
nipkow@16153
   252
In which case you should use \texttt{IfThenNoBox} instead of
nipkow@16153
   253
\texttt{IfThen}:
nipkow@15342
   254
\begin{theorem}
nipkow@15342
   255
@{prop[mode=IfThenNoBox] "longpremise \<Longrightarrow> longerpremise \<Longrightarrow> P(f(f(f(f(f(f(f(f(f(x)))))))))) \<Longrightarrow> longestpremise \<Longrightarrow> conclusion"}
nipkow@15342
   256
\end{theorem}
kleing@15366
   257
*}
nipkow@15342
   258
haftmann@16166
   259
subsection{* Doing it yourself\label{sec:yourself}*}
nipkow@16153
   260
nipkow@16153
   261
text{* If for some reason you want or need to present theorems your
nipkow@16153
   262
own way, you can extract the premises and the conclusion explicitly
nipkow@16153
   263
and combine them as you like:
nipkow@16153
   264
\begin{itemize}
haftmann@16167
   265
\item \verb!@!\verb!{thm_style prem1! $thm$\verb!}!
haftmann@16167
   266
prints premise 1 of $thm$ (and similarly up to \texttt{prem9}).
haftmann@16165
   267
\item \verb!@!\verb!{thm_style concl! $thm$\verb!}!
nipkow@16153
   268
prints the conclusion of $thm$.
nipkow@16153
   269
\end{itemize}
haftmann@16167
   270
For example, ``from @{thm_style prem2 conjI} and
haftmann@16167
   271
@{thm_style prem1 conjI} we conclude @{thm_style concl conjI}''
nipkow@16153
   272
is produced by
nipkow@16153
   273
\begin{quote}
nipkow@16175
   274
\verb!from !\verb!@!\verb!{thm_style prem2 conjI}! \verb!and !\verb!@!\verb!{thm_style prem1 conjI}!\\
haftmann@16165
   275
\verb!we conclude !\verb!@!\verb!{thm_style concl conjI}!
nipkow@16153
   276
\end{quote}
nipkow@16153
   277
Thus you can rearrange or hide premises and typeset the theorem as you like.
nipkow@16153
   278
The \verb!thm_style! antiquotation is a general mechanism explained
nipkow@16153
   279
in \S\ref{sec:styles}.
nipkow@16153
   280
*}
nipkow@16153
   281
kleing@15366
   282
subsection "Patterns"
kleing@15366
   283
kleing@15366
   284
text {*
kleing@15366
   285
nipkow@17127
   286
  In \S\ref{sec:varnames} we shows how to create patterns containing
nipkow@17127
   287
  ``@{term DUMMY}''.
kleing@15366
   288
  You can drive this game even further and extend the syntax of let
kleing@15366
   289
  bindings such that certain functions like @{term fst}, @{term hd}, 
kleing@15368
   290
  etc.\ are printed as patterns. \texttt{OptionalSugar} provides the
kleing@15368
   291
  following:
kleing@15366
   292
  
kleing@15366
   293
  \begin{center}
kleing@15366
   294
  \begin{tabular}{l@ {~~produced by~~}l}
kleing@15366
   295
  @{term "let x = fst p in t"} & \verb!@!\verb!{term "let x = fst p in t"}!\\
kleing@15366
   296
  @{term "let x = snd p in t"} & \verb!@!\verb!{term "let x = snd p in t"}!\\
kleing@15366
   297
  @{term "let x = hd xs in t"} & \verb!@!\verb!{term "let x = hd xs in t"}!\\
kleing@15366
   298
  @{term "let x = tl xs in t"} & \verb!@!\verb!{term "let x = tl xs in t"}!\\
kleing@15366
   299
  @{term "let x = the y in t"} & \verb!@!\verb!{term "let x = the y in t"}!\\
kleing@15366
   300
  \end{tabular}
kleing@15366
   301
  \end{center}
kleing@15366
   302
*}
kleing@15366
   303
nipkow@16155
   304
section "Proofs"
kleing@15366
   305
kleing@15366
   306
text {*
kleing@15367
   307
  Full proofs, even if written in beautiful Isar style, are likely to
kleing@15366
   308
  be too long and detailed to be included in conference papers, but
kleing@15366
   309
  some key lemmas might be of interest.
kleing@15366
   310
kleing@15366
   311
  It is usually easiest to put them in figures like the one in Fig.\
kleing@15366
   312
  \ref{fig:proof}. This was achieved with the \isakeyword{text\_raw}
kleing@15366
   313
  command:
kleing@15366
   314
*}
kleing@15366
   315
text_raw {*
kleing@15366
   316
  \begin{figure}
kleing@15366
   317
  \begin{center}\begin{minipage}{0.6\textwidth}  
kleing@15428
   318
  \isastyle\isamarkuptrue
kleing@15366
   319
*}
kleing@15366
   320
lemma True
kleing@15366
   321
proof -
kleing@15366
   322
  -- "pretty trivial"
kleing@15366
   323
  show True by force
kleing@15366
   324
qed
kleing@15428
   325
text_raw {*    
kleing@15366
   326
  \end{minipage}\end{center}
kleing@15366
   327
  \caption{Example proof in a figure.}\label{fig:proof}
kleing@15366
   328
  \end{figure}
kleing@15366
   329
*}
kleing@15366
   330
text {*
kleing@15366
   331
kleing@15366
   332
\begin{quote}
kleing@15366
   333
\small
kleing@15366
   334
\verb!text_raw {!\verb!*!\\
kleing@15366
   335
\verb!  \begin{figure}!\\
kleing@15366
   336
\verb!  \begin{center}\begin{minipage}{0.6\textwidth}!\\
kleing@15428
   337
\verb!  \isastyle\isamarkuptrue!\\
kleing@15366
   338
\verb!*!\verb!}!\\
kleing@15366
   339
\verb!lemma True!\\
kleing@15366
   340
\verb!proof -!\\
kleing@15366
   341
\verb!  -- "pretty trivial"!\\
kleing@15366
   342
\verb!  show True by force!\\
kleing@15366
   343
\verb!qed!\\
kleing@15366
   344
\verb!text_raw {!\verb!*!\\
kleing@15366
   345
\verb!  \end{minipage}\end{center}!\\
kleing@15366
   346
\verb!  \caption{Example proof in a figure.}\label{fig:proof}!\\
kleing@15366
   347
\verb!  \end{figure}!\\
kleing@15366
   348
\verb!*!\verb!}!
kleing@15366
   349
\end{quote}
kleing@15366
   350
  
nipkow@15342
   351
*}
nipkow@15342
   352
nipkow@16155
   353
section {*Styles\label{sec:styles}*}
haftmann@15917
   354
haftmann@15917
   355
text {*
nipkow@15953
   356
  The \verb!thm! antiquotation works nicely for single theorems, but
haftmann@15917
   357
  sets of equations as used in definitions are more difficult to
haftmann@16040
   358
  typeset nicely: people tend to prefer aligned @{text "="} signs.
haftmann@15917
   359
haftmann@15917
   360
  To deal with such cases where it is desirable to dive into the structure
haftmann@16040
   361
  of terms and theorems, Isabelle offers antiquotations featuring
haftmann@15917
   362
  ``styles'':
haftmann@15917
   363
haftmann@15917
   364
    \begin{quote}
haftmann@15917
   365
    \verb!@!\verb!{thm_style stylename thm}!\\
haftmann@15917
   366
    \verb!@!\verb!{term_style stylename term}!
haftmann@15917
   367
    \end{quote}
haftmann@15917
   368
haftmann@16040
   369
  A ``style'' is a transformation of propositions. There are predefined
webertj@21558
   370
  styles, namely \verb!lhs! and \verb!rhs!, \verb!prem1! up to \verb!prem9!, and \verb!concl!.
haftmann@16166
   371
  For example, 
kleing@16076
   372
  the output
haftmann@15917
   373
  \begin{center}
haftmann@15917
   374
  \begin{tabular}{l@ {~~@{text "="}~~}l}
haftmann@15917
   375
  @{thm_style lhs foldl_Nil} & @{thm_style rhs foldl_Nil}\\
haftmann@15917
   376
  @{thm_style lhs foldl_Cons} & @{thm_style rhs foldl_Cons}
haftmann@15917
   377
  \end{tabular}
haftmann@15917
   378
  \end{center}
haftmann@15917
   379
  is produced by the following code:
haftmann@15917
   380
  \begin{quote}
haftmann@15917
   381
    \verb!\begin{center}!\\
haftmann@15917
   382
    \verb!\begin{tabular}{l@ {~~!\verb!@!\verb!{text "="}~~}l}!\\
haftmann@15917
   383
    \verb!@!\verb!{thm_style lhs foldl_Nil} & @!\verb!{thm_style rhs foldl_Nil}!\\
haftmann@15917
   384
    \verb!@!\verb!{thm_style lhs foldl_Cons} & @!\verb!{thm_style rhs foldl_Cons}!\\
haftmann@15917
   385
    \verb!\end{tabular}!\\
haftmann@15917
   386
    \verb!\end{center}!
haftmann@15917
   387
  \end{quote}
haftmann@15917
   388
  Note the space between \verb!@! and \verb!{! in the tabular argument.
haftmann@15917
   389
  It prevents Isabelle from interpreting \verb!@ {~~...~~}! 
kleing@16076
   390
  as an antiquotation. The styles \verb!lhs! and \verb!rhs!
haftmann@16040
   391
  extract the left hand side (or right hand side respectivly) from the
kleing@16076
   392
  conclusion of propositions consisting of a binary operator
haftmann@16040
   393
  (e.~g.~@{text "="}, @{text "\<equiv>"}, @{text "<"}).
haftmann@15917
   394
haftmann@16165
   395
  Likewise, \verb!concl! may be used as a style to show just the
kleing@16076
   396
  conclusion of a proposition. For example, take \verb!hd_Cons_tl!:
haftmann@16040
   397
  \begin{center}
haftmann@17031
   398
    @{thm [show_types] hd_Cons_tl}
haftmann@16040
   399
  \end{center}
haftmann@16040
   400
  To print just the conclusion,
haftmann@15917
   401
  \begin{center}
haftmann@17031
   402
    @{thm_style [show_types] concl hd_Cons_tl}
haftmann@15917
   403
  \end{center}
haftmann@16040
   404
  type
haftmann@15917
   405
  \begin{quote}
haftmann@15917
   406
    \verb!\begin{center}!\\
haftmann@17031
   407
    \verb!@!\verb!{thm_style [show_types] concl hd_Cons_tl}!\\
haftmann@15917
   408
    \verb!\end{center}!
haftmann@15917
   409
  \end{quote}
nipkow@17127
   410
  Beware that any options must be placed \emph{before}
haftmann@17031
   411
  the name of the style, as in this example.
haftmann@17031
   412
haftmann@16166
   413
  Further use cases can be found in \S\ref{sec:yourself}.
haftmann@16166
   414
nipkow@15953
   415
  If you are not afraid of ML, you may also define your own styles.
haftmann@15960
   416
  A style is implemented by an ML function of type
haftmann@15960
   417
  \verb!Proof.context -> term -> term!.
haftmann@15960
   418
  Have a look at the following example:
haftmann@15960
   419
haftmann@16040
   420
*}
nipkow@16075
   421
(*<*)
haftmann@16040
   422
setup {*
haftmann@16040
   423
let
haftmann@16040
   424
  fun my_concl ctxt = Logic.strip_imp_concl
wenzelm@18708
   425
  in TermStyle.add_style "my_concl" my_concl
haftmann@16040
   426
end;
haftmann@16040
   427
*}
nipkow@16075
   428
(*>*)
haftmann@16040
   429
text {*
haftmann@16040
   430
haftmann@15917
   431
  \begin{quote}
haftmann@15917
   432
    \verb!setup {!\verb!*!\\
haftmann@15917
   433
    \verb!let!\\
haftmann@16040
   434
    \verb!  fun my_concl ctxt = Logic.strip_imp_concl!\\
wenzelm@18708
   435
    \verb!  in TermStyle.add_style "my_concl" my_concl!\\
haftmann@15917
   436
    \verb!end;!\\
haftmann@15917
   437
    \verb!*!\verb!}!\\
haftmann@15917
   438
  \end{quote}
haftmann@15960
   439
kleing@16076
   440
  \noindent
haftmann@16165
   441
  This example shows how the \verb!concl! style is implemented
kleing@16076
   442
  and may be used as as a ``copy-and-paste'' pattern to write your own styles.
haftmann@15960
   443
kleing@16076
   444
  The code should go into your theory file, separate from the \LaTeX\ text.
haftmann@16040
   445
  The \verb!let! expression avoids polluting the
haftmann@15960
   446
  ML global namespace. Each style receives the current proof context
kleing@16076
   447
  as first argument; this is helpful in situations where the
kleing@16076
   448
  style has some object-logic specific behaviour for example.
haftmann@15960
   449
haftmann@15960
   450
  The mapping from identifier name to the style function
nipkow@17123
   451
  is done by the @{ML TermStyle.add_style} expression which expects the desired
haftmann@15960
   452
  style name and the style function as arguments.
haftmann@15960
   453
  
haftmann@15960
   454
  After this \verb!setup!,
haftmann@16040
   455
  there will be a new style available named \verb!my_concl!, thus allowing
haftmann@16040
   456
  antiquoations like \verb!@!\verb!{thm_style my_concl hd_Cons_tl}!
haftmann@16040
   457
  yielding @{thm_style my_concl hd_Cons_tl}.
haftmann@15917
   458
haftmann@15917
   459
*}
haftmann@15917
   460
nipkow@15337
   461
(*<*)
nipkow@15337
   462
end
nipkow@16175
   463
(*>*)