doc-src/LaTeXsugar/Sugar/Sugar.thy
author nipkow
Wed Jan 26 17:34:42 2005 +0100 (2005-01-26 ago)
changeset 15471 e7f069887ec2
parent 15428 3f1a674b7ec7
child 15491 7c1f6e84f4ad
permissions -rw-r--r--
*** empty log message ***
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@15471
    43
typically in \texttt{root.tex}.
nipkow@15471
    44
\end{itemize}
nipkow@15342
    45
*}
nipkow@15342
    46
nipkow@15342
    47
section{* HOL syntax*}
nipkow@15342
    48
nipkow@15342
    49
subsection{* Logic *}
nipkow@15342
    50
nipkow@15342
    51
text{* The predefined constructs @{text"if"}, @{text"let"} and
nipkow@15342
    52
@{text"case"} are set in sans serif font to distinguish them from
nipkow@15342
    53
other functions. This improves readability:
nipkow@15342
    54
\begin{itemize}
nipkow@15342
    55
\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
    56
\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
    57
\item @{term"case x of True \<Rightarrow> e\<^isub>1 | False \<Rightarrow> e\<^isub>2"} instead of\\
nipkow@15342
    58
      @{text"case x of True \<Rightarrow> e\<^isub>1 | False \<Rightarrow> e\<^isub>2"}.
nipkow@15342
    59
\end{itemize}
nipkow@15342
    60
*}
nipkow@15342
    61
nipkow@15342
    62
subsection{* Sets *}
nipkow@15337
    63
nipkow@15342
    64
text{* Although set syntax in HOL is already close to
nipkow@15342
    65
standard, we provide a few further improvements:
nipkow@15342
    66
\begin{itemize}
nipkow@15342
    67
\item @{term"{x. P}"} instead of @{text"{x. P}"}.
nipkow@15342
    68
\item @{term"{}"} instead of @{text"{}"}.
nipkow@15342
    69
\item @{term"insert a (insert b (insert c M))"} instead of @{text"insert a (insert b (insert c M))"}.
nipkow@15342
    70
\end{itemize}
nipkow@15342
    71
*}
nipkow@15342
    72
nipkow@15342
    73
subsection{* Lists *}
nipkow@15342
    74
nipkow@15342
    75
text{* If lists are used heavily, the following notations increase readability:
nipkow@15342
    76
\begin{itemize}
nipkow@15342
    77
\item @{term"x # xs"} instead of @{text"x # xs"}.
nipkow@15342
    78
      Exceptionally, @{term"x # xs"} is also input syntax.
nipkow@15342
    79
If you prefer more space around the $\cdot$ you have to redefine
nipkow@15342
    80
\verb!\isasymcdot! in \LaTeX:
nipkow@15342
    81
\verb!\renewcommand{\isasymcdot}{\isamath{\,\cdot\,}}!
nipkow@15342
    82
nipkow@15342
    83
\item @{term"length xs"} instead of @{text"length xs"}.
kleing@15385
    84
\item @{term"nth xs n"} instead of @{text"nth xs n"},
nipkow@15342
    85
      the $n$th element of @{text xs}.
nipkow@15342
    86
kleing@15366
    87
\item The @{text"@"} operation associates implicitly to the right,
kleing@15366
    88
which leads to unpleasant line breaks if the term is too long for one
kleing@15366
    89
line. To avoid this, \texttt{OptionalSugar} contains syntax to group
kleing@15366
    90
@{text"@"}-terms to the left before printing, which leads to better
kleing@15366
    91
line breaking behaviour:
kleing@15366
    92
@{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>9 @ term\<^isub>1\<^isub>0"}
kleing@15366
    93
nipkow@15342
    94
\end{itemize}
nipkow@15337
    95
*}
nipkow@15337
    96
nipkow@15337
    97
section "Printing theorems"
nipkow@15337
    98
nipkow@15337
    99
subsection "Inference rules"
nipkow@15337
   100
nipkow@15342
   101
text{* To print theorems as inference rules you need to include Didier
nipkow@15342
   102
R\'emy's \texttt{mathpartir} package~\cite{mathpartir}
nipkow@15342
   103
for typesetting inference rules in your \LaTeX\ file.
nipkow@15337
   104
nipkow@15337
   105
Writing \verb!@!\verb!{thm[mode=Rule] conjI[no_vars]}! produces
nipkow@15337
   106
@{thm[mode=Rule] conjI[no_vars]}, even in the middle of a sentence.
nipkow@15342
   107
If you prefer your inference rule on a separate line, maybe with a name,
nipkow@15342
   108
\begin{center}
nipkow@15342
   109
@{thm[mode=Rule] conjI[no_vars]} {\sc conjI}
nipkow@15342
   110
\end{center}
nipkow@15342
   111
is produced by
nipkow@15337
   112
\begin{quote}
nipkow@15337
   113
\verb!\begin{center}!\\
nipkow@15337
   114
\verb!@!\verb!{thm[mode=Rule] conjI[no_vars]} {\sc conjI}!\\
nipkow@15337
   115
\verb!\end{center}!
nipkow@15337
   116
\end{quote}
nipkow@15342
   117
It is not recommended to use the standard \texttt{display} attribute
nipkow@15342
   118
together with \texttt{Rule} because centering does not work and because
nipkow@15342
   119
the line breaking mechanisms of \texttt{display} and \texttt{mathpartir} can
nipkow@15342
   120
clash.
nipkow@15342
   121
nipkow@15337
   122
Of course you can display multiple rules in this fashion:
nipkow@15337
   123
\begin{quote}
nipkow@15337
   124
\verb!\begin{center}\isastyle!\\
nipkow@15337
   125
\verb!@!\verb!{thm[mode=Rule] conjI[no_vars]} {\sc conjI} \\[1ex]!\\
nipkow@15337
   126
\verb!@!\verb!{thm[mode=Rule] conjE[no_vars]} {\sc disjI$_1$} \qquad!\\
nipkow@15337
   127
\verb!@!\verb!{thm[mode=Rule] disjE[no_vars]} {\sc disjI$_2$}!\\
nipkow@15337
   128
\verb!\end{center}!
nipkow@15337
   129
\end{quote}
nipkow@15337
   130
yields
nipkow@15337
   131
\begin{center}\isastyle
nipkow@15337
   132
@{thm[mode=Rule] conjI[no_vars]} {\sc conjI} \\[1ex]
nipkow@15337
   133
@{thm[mode=Rule] disjI1[no_vars]} {\sc disjI$_1$} \qquad
nipkow@15337
   134
@{thm[mode=Rule] disjI2[no_vars]} {\sc disjI$_2$}
nipkow@15337
   135
\end{center}
nipkow@15337
   136
Note that we included \verb!\isastyle! to obtain
nipkow@15337
   137
the smaller font that otherwise comes only with \texttt{display}.
nipkow@15337
   138
nipkow@15342
   139
The \texttt{mathpartir} package copes well if there are too many
nipkow@15342
   140
premises for one line:
nipkow@15342
   141
\begin{center}
nipkow@15342
   142
@{prop[mode=Rule] "\<lbrakk> A \<longrightarrow> B; B \<longrightarrow> C; C \<longrightarrow> D; D \<longrightarrow> E; E \<longrightarrow> F; F \<longrightarrow> G;
nipkow@15342
   143
 G \<longrightarrow> H; H \<longrightarrow> I; I \<longrightarrow> J; J \<longrightarrow> K \<rbrakk> \<Longrightarrow> A \<longrightarrow> K"}
nipkow@15342
   144
\end{center}
nipkow@15342
   145
nipkow@15471
   146
Limitations: 1. Premises and conclusion must each not be longer than
nipkow@15471
   147
the line.  2. Premises that are @{text"\<Longrightarrow>"}-implications are again
nipkow@15471
   148
displayed with a horizontal line, which looks at least unusual.
nipkow@15471
   149
nipkow@15337
   150
*}
nipkow@15342
   151
nipkow@15342
   152
subsection{*If-then*}
nipkow@15342
   153
nipkow@15342
   154
text{* If you prefer a fake ``natural language'' style you can produce
nipkow@15342
   155
the body of
nipkow@15342
   156
\newtheorem{theorem}{Theorem}
nipkow@15342
   157
\begin{theorem}
nipkow@15471
   158
@{thm[mode=IfThen] zle_trans[no_vars]}
nipkow@15342
   159
\end{theorem}
nipkow@15342
   160
by typing
nipkow@15342
   161
\begin{quote}
nipkow@15471
   162
\verb!@!\verb!{thm[mode=IfThen] le_trans[no_vars]}!
nipkow@15342
   163
\end{quote}
nipkow@15342
   164
nipkow@15342
   165
In order to prevent odd line breaks, the premises are put into boxes.
nipkow@15342
   166
At times this is too drastic:
nipkow@15342
   167
\begin{theorem}
nipkow@15342
   168
@{prop[mode=IfThen] "longpremise \<Longrightarrow> longerpremise \<Longrightarrow> P(f(f(f(f(f(f(f(f(f(x)))))))))) \<Longrightarrow> longestpremise \<Longrightarrow> conclusion"}
nipkow@15342
   169
\end{theorem}
nipkow@15342
   170
In which case you should use \texttt{mode=IfThenNoBox} instead of
nipkow@15342
   171
\texttt{mode=IfThen}:
nipkow@15342
   172
\begin{theorem}
nipkow@15342
   173
@{prop[mode=IfThenNoBox] "longpremise \<Longrightarrow> longerpremise \<Longrightarrow> P(f(f(f(f(f(f(f(f(f(x)))))))))) \<Longrightarrow> longestpremise \<Longrightarrow> conclusion"}
nipkow@15342
   174
\end{theorem}
kleing@15366
   175
*}
nipkow@15342
   176
kleing@15366
   177
subsection {*Definitions and Equations*}
kleing@15366
   178
kleing@15366
   179
text {*
kleing@15366
   180
  The \verb!thm! antiquotation works nicely for proper theorems, but
kleing@15368
   181
  sets of equations as used in definitions are more difficult to
kleing@15366
   182
  typeset nicely: for some reason people tend to prefer aligned 
kleing@15366
   183
  @{text "="} signs.
kleing@15366
   184
kleing@15366
   185
  Isabelle2005 will have a nice mechanism for that, namely the two
kleing@15366
   186
  antiquotations \verb!@!\verb!{lhs thm}! and \verb!@!\verb!{rhs thm}!.
kleing@15366
   187
kleing@15366
   188
  \begin{center}
kleing@15366
   189
  \begin{tabular}{l@ {~~@{text "="}~~}l}
kleing@15366
   190
  @{lhs foldl_Nil[no_vars]} & @{rhs foldl_Nil[no_vars]}\\
kleing@15366
   191
  @{lhs foldl_Cons[no_vars]} & @{rhs foldl_Cons[no_vars]}
kleing@15366
   192
  \end{tabular}
kleing@15366
   193
  \end{center}
kleing@15366
   194
kleing@15366
   195
  \noindent 
kleing@15366
   196
  is produced by the following code:
kleing@15366
   197
kleing@15366
   198
\begin{quote}
kleing@15366
   199
  \verb!\begin{center}!\\
kleing@15366
   200
  \verb!\begin{tabular}{l@ {~~!\verb!@!\verb!{text "="}~~}l}!\\
kleing@15366
   201
  \verb!@!\verb!{lhs foldl_Nil[no_vars]} & @!\verb!{rhs foldl_Nil[no_vars]}!\\
kleing@15366
   202
  \verb!@!\verb!{lhs foldl_Cons[no_vars]} & @!\verb!{rhs foldl_Cons[no_vars]}!\\
kleing@15366
   203
  \verb!\end{tabular}!\\
kleing@15366
   204
  \verb!\end{center}!
kleing@15366
   205
\end{quote}
kleing@15366
   206
kleing@15366
   207
  \noindent
kleing@15366
   208
  Note the space between \verb!@! and \verb!{! in the tabular argument.
kleing@15366
   209
  It prevents Isabelle from interpreting \verb!@ {~~...~~}! 
kleing@15366
   210
  as antiquotation. \verb!@!\verb!{lhs thm}! and \verb!@!\verb!{rhs thm}! 
kleing@15366
   211
  try to be smart about the interpretation of the theorem they
kleing@15366
   212
  print, they work just as well for meta equality @{text "\<equiv>"} and other
kleing@15366
   213
  binary operators like @{text "<"}.
kleing@15366
   214
kleing@15366
   215
  Should you lack both the development version of Isabelle and a time
kleing@15366
   216
  machine, you can still try to simulate the effect using the equation syntax
kleing@15366
   217
  in \texttt{sugar.sty} and \texttt{OptionalSugar}.
kleing@15366
   218
  
kleing@15366
   219
  \begin{center}
kleing@15366
   220
  \begin{tabular}{l@ { }l@ { }l}
kleing@15366
   221
  \setcounter{isatabs}{0}%
kleing@15366
   222
  @{thm [mode=tab] foldl_Nil[no_vars]}\nl
kleing@15366
   223
  @{thm [mode=tab] foldl_Cons[no_vars]}
kleing@15366
   224
  \end{tabular}
kleing@15366
   225
  \end{center}
kleing@15366
   226
kleing@15366
   227
  \noindent 
kleing@15366
   228
  is produced by:
kleing@15366
   229
kleing@15366
   230
\begin{quote}
kleing@15366
   231
  \verb!\begin{center}!\\
kleing@15366
   232
  \verb!\begin{tabular}{l@ { }l@ { }l}!\\
kleing@15366
   233
  \verb!\setcounter{isatabs}{0}%!\\
kleing@15366
   234
  \verb!@!\verb!{thm [mode=tab] foldl_Nil[no_vars]}\nl!\\
kleing@15366
   235
  \verb!@!\verb!{thm [mode=tab] foldl_Cons[no_vars]}!\\
kleing@15366
   236
  \verb!\end{tabular}!\\
kleing@15366
   237
  \verb!\end{center}!
kleing@15366
   238
\end{quote}
kleing@15366
   239
kleing@15366
   240
  \noindent
kleing@15366
   241
  These \LaTeX\ macros are not as flexible as the antiquotations
kleing@15366
   242
  above, they only work for proper equations and definitions and they
kleing@15366
   243
  only work correctly if the left hand side does not contain any
kleing@15366
   244
  @{text "="} signs.
kleing@15366
   245
*}
kleing@15366
   246
kleing@15366
   247
subsection "Patterns"
kleing@15366
   248
kleing@15366
   249
text {*
kleing@15366
   250
  Sometimes functions ignore one or more of their
kleing@15366
   251
  arguments and some functional languages have nice 
kleing@15366
   252
  syntax for that as in @{thm hd.simps [where xs=DUMMY,no_vars]}.
kleing@15366
   253
kleing@15366
   254
  You can simulate this in Isabelle by instantiating the @{term xs} in
kleing@15366
   255
  definition \mbox{@{thm hd.simps[no_vars]}} with a constant @{text DUMMY} that
kleing@15366
   256
  is printed as @{term DUMMY}. The code for the pattern above is 
kleing@15373
   257
  \verb!@!\verb!{thm hd.simps [where xs=DUMMY,no_vars]}!.
kleing@15366
   258
kleing@15366
   259
  You can drive this game even further and extend the syntax of let
kleing@15366
   260
  bindings such that certain functions like @{term fst}, @{term hd}, 
kleing@15368
   261
  etc.\ are printed as patterns. \texttt{OptionalSugar} provides the
kleing@15368
   262
  following:
kleing@15366
   263
  
kleing@15366
   264
  \begin{center}
kleing@15366
   265
  \begin{tabular}{l@ {~~produced by~~}l}
kleing@15366
   266
  @{term "let x = fst p in t"} & \verb!@!\verb!{term "let x = fst p in t"}!\\
kleing@15366
   267
  @{term "let x = snd p in t"} & \verb!@!\verb!{term "let x = snd p in t"}!\\
kleing@15366
   268
  @{term "let x = hd xs in t"} & \verb!@!\verb!{term "let x = hd xs in t"}!\\
kleing@15366
   269
  @{term "let x = tl xs in t"} & \verb!@!\verb!{term "let x = tl xs in t"}!\\
kleing@15366
   270
  @{term "let x = the y in t"} & \verb!@!\verb!{term "let x = the y in t"}!\\
kleing@15366
   271
  \end{tabular}
kleing@15366
   272
  \end{center}
kleing@15366
   273
*}
kleing@15366
   274
kleing@15366
   275
subsection "Proofs"
kleing@15366
   276
kleing@15366
   277
text {*
kleing@15367
   278
  Full proofs, even if written in beautiful Isar style, are likely to
kleing@15366
   279
  be too long and detailed to be included in conference papers, but
kleing@15366
   280
  some key lemmas might be of interest.
kleing@15366
   281
kleing@15366
   282
  It is usually easiest to put them in figures like the one in Fig.\
kleing@15366
   283
  \ref{fig:proof}. This was achieved with the \isakeyword{text\_raw}
kleing@15366
   284
  command:
kleing@15366
   285
*}
kleing@15366
   286
text_raw {*
kleing@15366
   287
  \begin{figure}
kleing@15366
   288
  \begin{center}\begin{minipage}{0.6\textwidth}  
kleing@15428
   289
  \isastyle\isamarkuptrue
kleing@15366
   290
*}
kleing@15366
   291
lemma True
kleing@15366
   292
proof -
kleing@15366
   293
  -- "pretty trivial"
kleing@15366
   294
  show True by force
kleing@15366
   295
qed
kleing@15428
   296
text_raw {*    
kleing@15366
   297
  \end{minipage}\end{center}
kleing@15366
   298
  \caption{Example proof in a figure.}\label{fig:proof}
kleing@15366
   299
  \end{figure}
kleing@15366
   300
*}
kleing@15366
   301
text {*
kleing@15366
   302
kleing@15366
   303
\begin{quote}
kleing@15366
   304
\small
kleing@15366
   305
\verb!text_raw {!\verb!*!\\
kleing@15366
   306
\verb!  \begin{figure}!\\
kleing@15366
   307
\verb!  \begin{center}\begin{minipage}{0.6\textwidth}!\\
kleing@15428
   308
\verb!  \isastyle\isamarkuptrue!\\
kleing@15366
   309
\verb!*!\verb!}!\\
kleing@15366
   310
\verb!lemma True!\\
kleing@15366
   311
\verb!proof -!\\
kleing@15366
   312
\verb!  -- "pretty trivial"!\\
kleing@15366
   313
\verb!  show True by force!\\
kleing@15366
   314
\verb!qed!\\
kleing@15366
   315
\verb!text_raw {!\verb!*!\\
kleing@15366
   316
\verb!  \end{minipage}\end{center}!\\
kleing@15366
   317
\verb!  \caption{Example proof in a figure.}\label{fig:proof}!\\
kleing@15366
   318
\verb!  \end{figure}!\\
kleing@15366
   319
\verb!*!\verb!}!
kleing@15366
   320
\end{quote}
kleing@15366
   321
  
nipkow@15342
   322
*}
nipkow@15342
   323
nipkow@15337
   324
(*<*)
nipkow@15337
   325
end
nipkow@15337
   326
(*>*)