doc-src/Codegen/Thy/document/Adaption.tex
author wenzelm
Tue, 07 Apr 2009 21:24:39 +0200
changeset 30882 d15725e84091
parent 30880 257cbe43faa8
permissions -rw-r--r--
moved generated eps/pdf to main directory, for proper display in dvi;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
28447
haftmann
parents:
diff changeset
     1
%
haftmann
parents:
diff changeset
     2
\begin{isabellebody}%
haftmann
parents:
diff changeset
     3
\def\isabellecontext{Adaption}%
haftmann
parents:
diff changeset
     4
%
haftmann
parents:
diff changeset
     5
\isadelimtheory
haftmann
parents:
diff changeset
     6
%
haftmann
parents:
diff changeset
     7
\endisadelimtheory
haftmann
parents:
diff changeset
     8
%
haftmann
parents:
diff changeset
     9
\isatagtheory
haftmann
parents:
diff changeset
    10
\isacommand{theory}\isamarkupfalse%
haftmann
parents:
diff changeset
    11
\ Adaption\isanewline
haftmann
parents:
diff changeset
    12
\isakeyword{imports}\ Setup\isanewline
haftmann
parents:
diff changeset
    13
\isakeyword{begin}%
haftmann
parents:
diff changeset
    14
\endisatagtheory
haftmann
parents:
diff changeset
    15
{\isafoldtheory}%
haftmann
parents:
diff changeset
    16
%
haftmann
parents:
diff changeset
    17
\isadelimtheory
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    18
\isanewline
28447
haftmann
parents:
diff changeset
    19
%
haftmann
parents:
diff changeset
    20
\endisadelimtheory
haftmann
parents:
diff changeset
    21
%
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    22
\isadeliminvisible
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    23
\isanewline
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    24
%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    25
\endisadeliminvisible
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    26
%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    27
\isataginvisible
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    28
\isacommand{setup}\isamarkupfalse%
28679
d7384e8e99b3 explicit namings for generated code
haftmann
parents: 28635
diff changeset
    29
\ {\isacharverbatimopen}\ Code{\isacharunderscore}Target{\isachardot}extend{\isacharunderscore}target\ {\isacharparenleft}{\isachardoublequote}{\isasymSML}{\isachardoublequote}{\isacharcomma}\ {\isacharparenleft}{\isachardoublequote}SML{\isachardoublequote}{\isacharcomma}\ K\ I{\isacharparenright}{\isacharparenright}\ {\isacharverbatimclose}%
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    30
\endisataginvisible
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    31
{\isafoldinvisible}%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    32
%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    33
\isadeliminvisible
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    34
%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    35
\endisadeliminvisible
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    36
%
28447
haftmann
parents:
diff changeset
    37
\isamarkupsection{Adaption to target languages \label{sec:adaption}%
haftmann
parents:
diff changeset
    38
}
haftmann
parents:
diff changeset
    39
\isamarkuptrue%
haftmann
parents:
diff changeset
    40
%
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    41
\isamarkupsubsection{Adapting code generation%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    42
}
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    43
\isamarkuptrue%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    44
%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    45
\begin{isamarkuptext}%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    46
The aspects of code generation introduced so far have two aspects
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    47
  in common:
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    48
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    49
  \begin{itemize}
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    50
    \item They act uniformly, without reference to a specific
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    51
       target language.
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    52
    \item They are \emph{safe} in the sense that as long as you trust
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    53
       the code generator meta theory and implementation, you cannot
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    54
       produce programs that yield results which are not derivable
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    55
       in the logic.
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    56
  \end{itemize}
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    57
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    58
  \noindent In this section we will introduce means to \emph{adapt} the serialiser
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    59
  to a specific target language, i.e.~to print program fragments
28593
f087237af65d continued codegen tutorial
haftmann
parents: 28564
diff changeset
    60
  in a way which accommodates \qt{already existing} ingredients of
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    61
  a target language environment, for three reasons:
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    62
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    63
  \begin{itemize}
28593
f087237af65d continued codegen tutorial
haftmann
parents: 28564
diff changeset
    64
    \item improving readability and aesthetics of generated code
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    65
    \item gaining efficiency
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    66
    \item interface with language parts which have no direct counterpart
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    67
      in \isa{HOL} (say, imperative data structures)
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    68
  \end{itemize}
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    69
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    70
  \noindent Generally, you should avoid using those features yourself
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    71
  \emph{at any cost}:
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    72
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    73
  \begin{itemize}
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    74
    \item The safe configuration methods act uniformly on every target language,
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    75
      whereas for adaption you have to treat each target language separate.
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    76
    \item Application is extremely tedious since there is no abstraction
28593
f087237af65d continued codegen tutorial
haftmann
parents: 28564
diff changeset
    77
      which would allow for a static check, making it easy to produce garbage.
f087237af65d continued codegen tutorial
haftmann
parents: 28564
diff changeset
    78
    \item More or less subtle errors can be introduced unconsciously.
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    79
  \end{itemize}
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    80
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    81
  \noindent However, even if you ought refrain from setting up adaption
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    82
  yourself, already the \isa{HOL} comes with some reasonable default
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    83
  adaptions (say, using target language list syntax).  There also some
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    84
  common adaption cases which you can setup by importing particular
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    85
  library theories.  In order to understand these, we provide some clues here;
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    86
  these however are not supposed to replace a careful study of the sources.%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    87
\end{isamarkuptext}%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    88
\isamarkuptrue%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    89
%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    90
\isamarkupsubsection{The adaption principle%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    91
}
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    92
\isamarkuptrue%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    93
%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
    94
\begin{isamarkuptext}%
30880
257cbe43faa8 tuned manual
haftmann
parents: 30836
diff changeset
    95
Figure \ref{fig:adaption} illustrates what \qt{adaption} is conceptually
28601
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
    96
  supposed to be:
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
    97
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
    98
  \begin{figure}[here]
30882
d15725e84091 moved generated eps/pdf to main directory, for proper display in dvi;
wenzelm
parents: 30880
diff changeset
    99
    \includegraphics{adaption}
28601
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   100
    \caption{The adaption principle}
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   101
    \label{fig:adaption}
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   102
  \end{figure}
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   103
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   104
  \noindent In the tame view, code generation acts as broker between
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   105
  \isa{logic}, \isa{intermediate\ language} and
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   106
  \isa{target\ language} by means of \isa{translation} and
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   107
  \isa{serialisation};  for the latter, the serialiser has to observe
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   108
  the structure of the \isa{language} itself plus some \isa{reserved}
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   109
  keywords which have to be avoided for generated code.
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   110
  However, if you consider \isa{adaption} mechanisms, the code generated
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   111
  by the serializer is just the tip of the iceberg:
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   112
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   113
  \begin{itemize}
28635
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   114
    \item \isa{serialisation} can be \emph{parametrised} such that
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   115
      logical entities are mapped to target-specific ones
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   116
      (e.g. target-specific list syntax,
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   117
        see also \secref{sec:adaption_mechanisms})
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   118
    \item Such parametrisations can involve references to a
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   119
      target-specific standard \isa{library} (e.g. using
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   120
      the \isa{Haskell} \verb|Maybe| type instead
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   121
      of the \isa{HOL} \isa{option} type);
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   122
      if such are used, the corresponding identifiers
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   123
      (in our example, \verb|Maybe|, \verb|Nothing|
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   124
      and \verb|Just|) also have to be considered \isa{reserved}.
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   125
    \item Even more, the user can enrich the library of the
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   126
      target-language by providing code snippets
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   127
      (\qt{\isa{includes}}) which are prepended to
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   128
      any generated code (see \secref{sec:include});  this typically
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   129
      also involves further \isa{reserved} identifiers.
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   130
  \end{itemize}
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   131
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   132
  \noindent As figure \ref{fig:adaption} illustrates, all these adaption mechanisms
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   133
  have to act consistently;  it is at the discretion of the user
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   134
  to take care for this.%
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   135
\end{isamarkuptext}%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   136
\isamarkuptrue%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   137
%
28635
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   138
\isamarkupsubsection{Common adaption patterns%
28447
haftmann
parents:
diff changeset
   139
}
haftmann
parents:
diff changeset
   140
\isamarkuptrue%
haftmann
parents:
diff changeset
   141
%
haftmann
parents:
diff changeset
   142
\begin{isamarkuptext}%
haftmann
parents:
diff changeset
   143
The \hyperlink{theory.HOL}{\mbox{\isa{HOL}}} \hyperlink{theory.Main}{\mbox{\isa{Main}}} theory already provides a code
haftmann
parents:
diff changeset
   144
  generator setup
28593
f087237af65d continued codegen tutorial
haftmann
parents: 28564
diff changeset
   145
  which should be suitable for most applications.  Common extensions
28447
haftmann
parents:
diff changeset
   146
  and modifications are available by certain theories of the \isa{HOL}
haftmann
parents:
diff changeset
   147
  library; beside being useful in applications, they may serve
haftmann
parents:
diff changeset
   148
  as a tutorial for customising the code generator setup (see below
haftmann
parents:
diff changeset
   149
  \secref{sec:adaption_mechanisms}).
haftmann
parents:
diff changeset
   150
haftmann
parents:
diff changeset
   151
  \begin{description}
haftmann
parents:
diff changeset
   152
haftmann
parents:
diff changeset
   153
    \item[\hyperlink{theory.Code-Integer}{\mbox{\isa{Code{\isacharunderscore}Integer}}}] represents \isa{HOL} integers by big
haftmann
parents:
diff changeset
   154
       integer literals in target languages.
haftmann
parents:
diff changeset
   155
    \item[\hyperlink{theory.Code-Char}{\mbox{\isa{Code{\isacharunderscore}Char}}}] represents \isa{HOL} characters by 
haftmann
parents:
diff changeset
   156
       character literals in target languages.
haftmann
parents:
diff changeset
   157
    \item[\hyperlink{theory.Code-Char-chr}{\mbox{\isa{Code{\isacharunderscore}Char{\isacharunderscore}chr}}}] like \isa{Code{\isacharunderscore}Char},
haftmann
parents:
diff changeset
   158
       but also offers treatment of character codes; includes
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   159
       \hyperlink{theory.Code-Char}{\mbox{\isa{Code{\isacharunderscore}Char}}}.
28447
haftmann
parents:
diff changeset
   160
    \item[\hyperlink{theory.Efficient-Nat}{\mbox{\isa{Efficient{\isacharunderscore}Nat}}}] \label{eff_nat} implements natural numbers by integers,
haftmann
parents:
diff changeset
   161
       which in general will result in higher efficiency; pattern
haftmann
parents:
diff changeset
   162
       matching with \isa{{\isadigit{0}}} / \isa{Suc}
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   163
       is eliminated;  includes \hyperlink{theory.Code-Integer}{\mbox{\isa{Code{\isacharunderscore}Integer}}}
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   164
       and \hyperlink{theory.Code-Index}{\mbox{\isa{Code{\isacharunderscore}Index}}}.
28447
haftmann
parents:
diff changeset
   165
    \item[\hyperlink{theory.Code-Index}{\mbox{\isa{Code{\isacharunderscore}Index}}}] provides an additional datatype
haftmann
parents:
diff changeset
   166
       \isa{index} which is mapped to target-language built-in integers.
haftmann
parents:
diff changeset
   167
       Useful for code setups which involve e.g. indexing of
haftmann
parents:
diff changeset
   168
       target-language arrays.
haftmann
parents:
diff changeset
   169
    \item[\hyperlink{theory.Code-Message}{\mbox{\isa{Code{\isacharunderscore}Message}}}] provides an additional datatype
haftmann
parents:
diff changeset
   170
       \isa{message{\isacharunderscore}string} which is isomorphic to strings;
haftmann
parents:
diff changeset
   171
       \isa{message{\isacharunderscore}string}s are mapped to target-language strings.
haftmann
parents:
diff changeset
   172
       Useful for code setups which involve e.g. printing (error) messages.
haftmann
parents:
diff changeset
   173
haftmann
parents:
diff changeset
   174
  \end{description}
haftmann
parents:
diff changeset
   175
haftmann
parents:
diff changeset
   176
  \begin{warn}
haftmann
parents:
diff changeset
   177
    When importing any of these theories, they should form the last
haftmann
parents:
diff changeset
   178
    items in an import list.  Since these theories adapt the
haftmann
parents:
diff changeset
   179
    code generator setup in a non-conservative fashion,
haftmann
parents:
diff changeset
   180
    strange effects may occur otherwise.
haftmann
parents:
diff changeset
   181
  \end{warn}%
haftmann
parents:
diff changeset
   182
\end{isamarkuptext}%
haftmann
parents:
diff changeset
   183
\isamarkuptrue%
haftmann
parents:
diff changeset
   184
%
28635
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   185
\isamarkupsubsection{Parametrising serialisation \label{sec:adaption_mechanisms}%
28447
haftmann
parents:
diff changeset
   186
}
haftmann
parents:
diff changeset
   187
\isamarkuptrue%
haftmann
parents:
diff changeset
   188
%
haftmann
parents:
diff changeset
   189
\begin{isamarkuptext}%
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   190
Consider the following function and its corresponding
28447
haftmann
parents:
diff changeset
   191
  SML code:%
haftmann
parents:
diff changeset
   192
\end{isamarkuptext}%
haftmann
parents:
diff changeset
   193
\isamarkuptrue%
haftmann
parents:
diff changeset
   194
%
28564
haftmann
parents: 28561
diff changeset
   195
\isadelimquote
28447
haftmann
parents:
diff changeset
   196
%
28564
haftmann
parents: 28561
diff changeset
   197
\endisadelimquote
28447
haftmann
parents:
diff changeset
   198
%
28564
haftmann
parents: 28561
diff changeset
   199
\isatagquote
28447
haftmann
parents:
diff changeset
   200
\isacommand{primrec}\isamarkupfalse%
haftmann
parents:
diff changeset
   201
\ in{\isacharunderscore}interval\ {\isacharcolon}{\isacharcolon}\ {\isachardoublequoteopen}nat\ {\isasymtimes}\ nat\ {\isasymRightarrow}\ nat\ {\isasymRightarrow}\ bool{\isachardoublequoteclose}\ \isakeyword{where}\isanewline
haftmann
parents:
diff changeset
   202
\ \ {\isachardoublequoteopen}in{\isacharunderscore}interval\ {\isacharparenleft}k{\isacharcomma}\ l{\isacharparenright}\ n\ {\isasymlongleftrightarrow}\ k\ {\isasymle}\ n\ {\isasymand}\ n\ {\isasymle}\ l{\isachardoublequoteclose}%
28564
haftmann
parents: 28561
diff changeset
   203
\endisatagquote
haftmann
parents: 28561
diff changeset
   204
{\isafoldquote}%
28447
haftmann
parents:
diff changeset
   205
%
28564
haftmann
parents: 28561
diff changeset
   206
\isadelimquote
28447
haftmann
parents:
diff changeset
   207
%
28564
haftmann
parents: 28561
diff changeset
   208
\endisadelimquote
28447
haftmann
parents:
diff changeset
   209
%
haftmann
parents:
diff changeset
   210
\isadeliminvisible
haftmann
parents:
diff changeset
   211
%
haftmann
parents:
diff changeset
   212
\endisadeliminvisible
haftmann
parents:
diff changeset
   213
%
haftmann
parents:
diff changeset
   214
\isataginvisible
haftmann
parents:
diff changeset
   215
%
haftmann
parents:
diff changeset
   216
\endisataginvisible
haftmann
parents:
diff changeset
   217
{\isafoldinvisible}%
haftmann
parents:
diff changeset
   218
%
haftmann
parents:
diff changeset
   219
\isadeliminvisible
haftmann
parents:
diff changeset
   220
%
haftmann
parents:
diff changeset
   221
\endisadeliminvisible
haftmann
parents:
diff changeset
   222
%
28564
haftmann
parents: 28561
diff changeset
   223
\isadelimquote
28447
haftmann
parents:
diff changeset
   224
%
28564
haftmann
parents: 28561
diff changeset
   225
\endisadelimquote
28447
haftmann
parents:
diff changeset
   226
%
28564
haftmann
parents: 28561
diff changeset
   227
\isatagquote
28447
haftmann
parents:
diff changeset
   228
%
haftmann
parents:
diff changeset
   229
\begin{isamarkuptext}%
28727
185110a4b97a clarified verbatim vs. typewriter
haftmann
parents: 28714
diff changeset
   230
\isatypewriter%
28447
haftmann
parents:
diff changeset
   231
\noindent%
28714
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   232
\hspace*{0pt}structure Example = \\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   233
\hspace*{0pt}struct\\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   234
\hspace*{0pt}\\
30121
5c7bcb296600 updated generated files;
wenzelm
parents: 29297
diff changeset
   235
\hspace*{0pt}datatype nat = Zero{\char95}nat | Suc of nat;\\
28714
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   236
\hspace*{0pt}\\
30121
5c7bcb296600 updated generated files;
wenzelm
parents: 29297
diff changeset
   237
\hspace*{0pt}datatype boola = True | False;\\
28714
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   238
\hspace*{0pt}\\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   239
\hspace*{0pt}fun anda x True = x\\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   240
\hspace*{0pt} ~| anda x False = False\\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   241
\hspace*{0pt} ~| anda True x = x\\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   242
\hspace*{0pt} ~| anda False x = False;\\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   243
\hspace*{0pt}\\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   244
\hspace*{0pt}fun less{\char95}nat m (Suc n) = less{\char95}eq{\char95}nat m n\\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   245
\hspace*{0pt} ~| less{\char95}nat n Zero{\char95}nat = False\\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   246
\hspace*{0pt}and less{\char95}eq{\char95}nat (Suc m) n = less{\char95}nat m n\\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   247
\hspace*{0pt} ~| less{\char95}eq{\char95}nat Zero{\char95}nat n = True;\\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   248
\hspace*{0pt}\\
29297
62e0f892e525 updated generated files;
wenzelm
parents: 28727
diff changeset
   249
\hspace*{0pt}fun in{\char95}interval (k,~l) n = anda (less{\char95}eq{\char95}nat k n) (less{\char95}eq{\char95}nat n l);\\
28714
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   250
\hspace*{0pt}\\
29297
62e0f892e525 updated generated files;
wenzelm
parents: 28727
diff changeset
   251
\hspace*{0pt}end;~(*struct Example*)%
28447
haftmann
parents:
diff changeset
   252
\end{isamarkuptext}%
haftmann
parents:
diff changeset
   253
\isamarkuptrue%
haftmann
parents:
diff changeset
   254
%
28564
haftmann
parents: 28561
diff changeset
   255
\endisatagquote
haftmann
parents: 28561
diff changeset
   256
{\isafoldquote}%
28447
haftmann
parents:
diff changeset
   257
%
28564
haftmann
parents: 28561
diff changeset
   258
\isadelimquote
28447
haftmann
parents:
diff changeset
   259
%
28564
haftmann
parents: 28561
diff changeset
   260
\endisadelimquote
28447
haftmann
parents:
diff changeset
   261
%
haftmann
parents:
diff changeset
   262
\begin{isamarkuptext}%
haftmann
parents:
diff changeset
   263
\noindent Though this is correct code, it is a little bit unsatisfactory:
haftmann
parents:
diff changeset
   264
  boolean values and operators are materialised as distinguished
haftmann
parents:
diff changeset
   265
  entities with have nothing to do with the SML-built-in notion
haftmann
parents:
diff changeset
   266
  of \qt{bool}.  This results in less readable code;
haftmann
parents:
diff changeset
   267
  additionally, eager evaluation may cause programs to
haftmann
parents:
diff changeset
   268
  loop or break which would perfectly terminate when
haftmann
parents:
diff changeset
   269
  the existing SML \verb|bool| would be used.  To map
haftmann
parents:
diff changeset
   270
  the HOL \isa{bool} on SML \verb|bool|, we may use
haftmann
parents:
diff changeset
   271
  \qn{custom serialisations}:%
haftmann
parents:
diff changeset
   272
\end{isamarkuptext}%
haftmann
parents:
diff changeset
   273
\isamarkuptrue%
haftmann
parents:
diff changeset
   274
%
28564
haftmann
parents: 28561
diff changeset
   275
\isadelimquotett
28447
haftmann
parents:
diff changeset
   276
%
28564
haftmann
parents: 28561
diff changeset
   277
\endisadelimquotett
28447
haftmann
parents:
diff changeset
   278
%
28564
haftmann
parents: 28561
diff changeset
   279
\isatagquotett
28447
haftmann
parents:
diff changeset
   280
\isacommand{code{\isacharunderscore}type}\isamarkupfalse%
haftmann
parents:
diff changeset
   281
\ bool\isanewline
haftmann
parents:
diff changeset
   282
\ \ {\isacharparenleft}SML\ {\isachardoublequoteopen}bool{\isachardoublequoteclose}{\isacharparenright}\isanewline
haftmann
parents:
diff changeset
   283
\isacommand{code{\isacharunderscore}const}\isamarkupfalse%
haftmann
parents:
diff changeset
   284
\ True\ \isakeyword{and}\ False\ \isakeyword{and}\ {\isachardoublequoteopen}op\ {\isasymand}{\isachardoublequoteclose}\isanewline
haftmann
parents:
diff changeset
   285
\ \ {\isacharparenleft}SML\ {\isachardoublequoteopen}true{\isachardoublequoteclose}\ \isakeyword{and}\ {\isachardoublequoteopen}false{\isachardoublequoteclose}\ \isakeyword{and}\ {\isachardoublequoteopen}{\isacharunderscore}\ andalso\ {\isacharunderscore}{\isachardoublequoteclose}{\isacharparenright}%
28564
haftmann
parents: 28561
diff changeset
   286
\endisatagquotett
haftmann
parents: 28561
diff changeset
   287
{\isafoldquotett}%
28447
haftmann
parents:
diff changeset
   288
%
28564
haftmann
parents: 28561
diff changeset
   289
\isadelimquotett
28447
haftmann
parents:
diff changeset
   290
%
28564
haftmann
parents: 28561
diff changeset
   291
\endisadelimquotett
28447
haftmann
parents:
diff changeset
   292
%
haftmann
parents:
diff changeset
   293
\begin{isamarkuptext}%
haftmann
parents:
diff changeset
   294
\noindent The \hyperlink{command.code-type}{\mbox{\isa{\isacommand{code{\isacharunderscore}type}}}} command takes a type constructor
haftmann
parents:
diff changeset
   295
  as arguments together with a list of custom serialisations.
haftmann
parents:
diff changeset
   296
  Each custom serialisation starts with a target language
haftmann
parents:
diff changeset
   297
  identifier followed by an expression, which during
haftmann
parents:
diff changeset
   298
  code serialisation is inserted whenever the type constructor
haftmann
parents:
diff changeset
   299
  would occur.  For constants, \hyperlink{command.code-const}{\mbox{\isa{\isacommand{code{\isacharunderscore}const}}}} implements
haftmann
parents:
diff changeset
   300
  the corresponding mechanism.  Each ``\verb|_|'' in
haftmann
parents:
diff changeset
   301
  a serialisation expression is treated as a placeholder
haftmann
parents:
diff changeset
   302
  for the type constructor's (the constant's) arguments.%
haftmann
parents:
diff changeset
   303
\end{isamarkuptext}%
haftmann
parents:
diff changeset
   304
\isamarkuptrue%
haftmann
parents:
diff changeset
   305
%
28564
haftmann
parents: 28561
diff changeset
   306
\isadelimquote
28447
haftmann
parents:
diff changeset
   307
%
28564
haftmann
parents: 28561
diff changeset
   308
\endisadelimquote
28447
haftmann
parents:
diff changeset
   309
%
28564
haftmann
parents: 28561
diff changeset
   310
\isatagquote
28447
haftmann
parents:
diff changeset
   311
%
haftmann
parents:
diff changeset
   312
\begin{isamarkuptext}%
28727
185110a4b97a clarified verbatim vs. typewriter
haftmann
parents: 28714
diff changeset
   313
\isatypewriter%
28447
haftmann
parents:
diff changeset
   314
\noindent%
28714
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   315
\hspace*{0pt}structure Example = \\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   316
\hspace*{0pt}struct\\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   317
\hspace*{0pt}\\
30121
5c7bcb296600 updated generated files;
wenzelm
parents: 29297
diff changeset
   318
\hspace*{0pt}datatype nat = Zero{\char95}nat | Suc of nat;\\
28714
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   319
\hspace*{0pt}\\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   320
\hspace*{0pt}fun less{\char95}nat m (Suc n) = less{\char95}eq{\char95}nat m n\\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   321
\hspace*{0pt} ~| less{\char95}nat n Zero{\char95}nat = false\\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   322
\hspace*{0pt}and less{\char95}eq{\char95}nat (Suc m) n = less{\char95}nat m n\\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   323
\hspace*{0pt} ~| less{\char95}eq{\char95}nat Zero{\char95}nat n = true;\\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   324
\hspace*{0pt}\\
29297
62e0f892e525 updated generated files;
wenzelm
parents: 28727
diff changeset
   325
\hspace*{0pt}fun in{\char95}interval (k,~l) n = (less{\char95}eq{\char95}nat k n) andalso (less{\char95}eq{\char95}nat n l);\\
28714
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   326
\hspace*{0pt}\\
29297
62e0f892e525 updated generated files;
wenzelm
parents: 28727
diff changeset
   327
\hspace*{0pt}end;~(*struct Example*)%
28447
haftmann
parents:
diff changeset
   328
\end{isamarkuptext}%
haftmann
parents:
diff changeset
   329
\isamarkuptrue%
haftmann
parents:
diff changeset
   330
%
28564
haftmann
parents: 28561
diff changeset
   331
\endisatagquote
haftmann
parents: 28561
diff changeset
   332
{\isafoldquote}%
28447
haftmann
parents:
diff changeset
   333
%
28564
haftmann
parents: 28561
diff changeset
   334
\isadelimquote
28447
haftmann
parents:
diff changeset
   335
%
28564
haftmann
parents: 28561
diff changeset
   336
\endisadelimquote
28447
haftmann
parents:
diff changeset
   337
%
haftmann
parents:
diff changeset
   338
\begin{isamarkuptext}%
haftmann
parents:
diff changeset
   339
\noindent This still is not perfect: the parentheses
haftmann
parents:
diff changeset
   340
  around the \qt{andalso} expression are superfluous.
28593
f087237af65d continued codegen tutorial
haftmann
parents: 28564
diff changeset
   341
  Though the serialiser
28447
haftmann
parents:
diff changeset
   342
  by no means attempts to imitate the rich Isabelle syntax
haftmann
parents:
diff changeset
   343
  framework, it provides some common idioms, notably
haftmann
parents:
diff changeset
   344
  associative infixes with precedences which may be used here:%
haftmann
parents:
diff changeset
   345
\end{isamarkuptext}%
haftmann
parents:
diff changeset
   346
\isamarkuptrue%
haftmann
parents:
diff changeset
   347
%
28564
haftmann
parents: 28561
diff changeset
   348
\isadelimquotett
28447
haftmann
parents:
diff changeset
   349
%
28564
haftmann
parents: 28561
diff changeset
   350
\endisadelimquotett
28447
haftmann
parents:
diff changeset
   351
%
28564
haftmann
parents: 28561
diff changeset
   352
\isatagquotett
28447
haftmann
parents:
diff changeset
   353
\isacommand{code{\isacharunderscore}const}\isamarkupfalse%
haftmann
parents:
diff changeset
   354
\ {\isachardoublequoteopen}op\ {\isasymand}{\isachardoublequoteclose}\isanewline
haftmann
parents:
diff changeset
   355
\ \ {\isacharparenleft}SML\ \isakeyword{infixl}\ {\isadigit{1}}\ {\isachardoublequoteopen}andalso{\isachardoublequoteclose}{\isacharparenright}%
28564
haftmann
parents: 28561
diff changeset
   356
\endisatagquotett
haftmann
parents: 28561
diff changeset
   357
{\isafoldquotett}%
28447
haftmann
parents:
diff changeset
   358
%
28564
haftmann
parents: 28561
diff changeset
   359
\isadelimquotett
28447
haftmann
parents:
diff changeset
   360
%
28564
haftmann
parents: 28561
diff changeset
   361
\endisadelimquotett
28447
haftmann
parents:
diff changeset
   362
%
28564
haftmann
parents: 28561
diff changeset
   363
\isadelimquote
28447
haftmann
parents:
diff changeset
   364
%
28564
haftmann
parents: 28561
diff changeset
   365
\endisadelimquote
28447
haftmann
parents:
diff changeset
   366
%
28564
haftmann
parents: 28561
diff changeset
   367
\isatagquote
28447
haftmann
parents:
diff changeset
   368
%
haftmann
parents:
diff changeset
   369
\begin{isamarkuptext}%
28727
185110a4b97a clarified verbatim vs. typewriter
haftmann
parents: 28714
diff changeset
   370
\isatypewriter%
28447
haftmann
parents:
diff changeset
   371
\noindent%
28714
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   372
\hspace*{0pt}structure Example = \\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   373
\hspace*{0pt}struct\\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   374
\hspace*{0pt}\\
30121
5c7bcb296600 updated generated files;
wenzelm
parents: 29297
diff changeset
   375
\hspace*{0pt}datatype nat = Zero{\char95}nat | Suc of nat;\\
28714
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   376
\hspace*{0pt}\\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   377
\hspace*{0pt}fun less{\char95}nat m (Suc n) = less{\char95}eq{\char95}nat m n\\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   378
\hspace*{0pt} ~| less{\char95}nat n Zero{\char95}nat = false\\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   379
\hspace*{0pt}and less{\char95}eq{\char95}nat (Suc m) n = less{\char95}nat m n\\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   380
\hspace*{0pt} ~| less{\char95}eq{\char95}nat Zero{\char95}nat n = true;\\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   381
\hspace*{0pt}\\
29297
62e0f892e525 updated generated files;
wenzelm
parents: 28727
diff changeset
   382
\hspace*{0pt}fun in{\char95}interval (k,~l) n = less{\char95}eq{\char95}nat k n andalso less{\char95}eq{\char95}nat n l;\\
28714
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   383
\hspace*{0pt}\\
29297
62e0f892e525 updated generated files;
wenzelm
parents: 28727
diff changeset
   384
\hspace*{0pt}end;~(*struct Example*)%
28447
haftmann
parents:
diff changeset
   385
\end{isamarkuptext}%
haftmann
parents:
diff changeset
   386
\isamarkuptrue%
haftmann
parents:
diff changeset
   387
%
28564
haftmann
parents: 28561
diff changeset
   388
\endisatagquote
haftmann
parents: 28561
diff changeset
   389
{\isafoldquote}%
28447
haftmann
parents:
diff changeset
   390
%
28564
haftmann
parents: 28561
diff changeset
   391
\isadelimquote
28447
haftmann
parents:
diff changeset
   392
%
28564
haftmann
parents: 28561
diff changeset
   393
\endisadelimquote
28447
haftmann
parents:
diff changeset
   394
%
haftmann
parents:
diff changeset
   395
\begin{isamarkuptext}%
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   396
\noindent The attentive reader may ask how we assert that no generated
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   397
  code will accidentally overwrite.  For this reason the serialiser has
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   398
  an internal table of identifiers which have to be avoided to be used
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   399
  for new declarations.  Initially, this table typically contains the
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   400
  keywords of the target language.  It can be extended manually, thus avoiding
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   401
  accidental overwrites, using the \hyperlink{command.code-reserved}{\mbox{\isa{\isacommand{code{\isacharunderscore}reserved}}}} command:%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   402
\end{isamarkuptext}%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   403
\isamarkuptrue%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   404
%
28564
haftmann
parents: 28561
diff changeset
   405
\isadelimquote
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   406
%
28564
haftmann
parents: 28561
diff changeset
   407
\endisadelimquote
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   408
%
28564
haftmann
parents: 28561
diff changeset
   409
\isatagquote
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   410
\isacommand{code{\isacharunderscore}reserved}\isamarkupfalse%
28601
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   411
\ {\isachardoublequoteopen}{\isasymSML}{\isachardoublequoteclose}\ bool\ true\ false\ andalso%
28564
haftmann
parents: 28561
diff changeset
   412
\endisatagquote
haftmann
parents: 28561
diff changeset
   413
{\isafoldquote}%
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   414
%
28564
haftmann
parents: 28561
diff changeset
   415
\isadelimquote
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   416
%
28564
haftmann
parents: 28561
diff changeset
   417
\endisadelimquote
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   418
%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   419
\begin{isamarkuptext}%
28447
haftmann
parents:
diff changeset
   420
\noindent Next, we try to map HOL pairs to SML pairs, using the
haftmann
parents:
diff changeset
   421
  infix ``\verb|*|'' type constructor and parentheses:%
haftmann
parents:
diff changeset
   422
\end{isamarkuptext}%
haftmann
parents:
diff changeset
   423
\isamarkuptrue%
haftmann
parents:
diff changeset
   424
%
haftmann
parents:
diff changeset
   425
\isadeliminvisible
haftmann
parents:
diff changeset
   426
%
haftmann
parents:
diff changeset
   427
\endisadeliminvisible
haftmann
parents:
diff changeset
   428
%
haftmann
parents:
diff changeset
   429
\isataginvisible
haftmann
parents:
diff changeset
   430
%
haftmann
parents:
diff changeset
   431
\endisataginvisible
haftmann
parents:
diff changeset
   432
{\isafoldinvisible}%
haftmann
parents:
diff changeset
   433
%
haftmann
parents:
diff changeset
   434
\isadeliminvisible
haftmann
parents:
diff changeset
   435
%
haftmann
parents:
diff changeset
   436
\endisadeliminvisible
haftmann
parents:
diff changeset
   437
%
28564
haftmann
parents: 28561
diff changeset
   438
\isadelimquotett
28447
haftmann
parents:
diff changeset
   439
%
28564
haftmann
parents: 28561
diff changeset
   440
\endisadelimquotett
28447
haftmann
parents:
diff changeset
   441
%
28564
haftmann
parents: 28561
diff changeset
   442
\isatagquotett
28447
haftmann
parents:
diff changeset
   443
\isacommand{code{\isacharunderscore}type}\isamarkupfalse%
haftmann
parents:
diff changeset
   444
\ {\isacharasterisk}\isanewline
haftmann
parents:
diff changeset
   445
\ \ {\isacharparenleft}SML\ \isakeyword{infix}\ {\isadigit{2}}\ {\isachardoublequoteopen}{\isacharasterisk}{\isachardoublequoteclose}{\isacharparenright}\isanewline
haftmann
parents:
diff changeset
   446
\isacommand{code{\isacharunderscore}const}\isamarkupfalse%
haftmann
parents:
diff changeset
   447
\ Pair\isanewline
haftmann
parents:
diff changeset
   448
\ \ {\isacharparenleft}SML\ {\isachardoublequoteopen}{\isacharbang}{\isacharparenleft}{\isacharparenleft}{\isacharunderscore}{\isacharparenright}{\isacharcomma}{\isacharslash}\ {\isacharparenleft}{\isacharunderscore}{\isacharparenright}{\isacharparenright}{\isachardoublequoteclose}{\isacharparenright}%
28564
haftmann
parents: 28561
diff changeset
   449
\endisatagquotett
haftmann
parents: 28561
diff changeset
   450
{\isafoldquotett}%
28447
haftmann
parents:
diff changeset
   451
%
28564
haftmann
parents: 28561
diff changeset
   452
\isadelimquotett
28447
haftmann
parents:
diff changeset
   453
%
28564
haftmann
parents: 28561
diff changeset
   454
\endisadelimquotett
28447
haftmann
parents:
diff changeset
   455
%
haftmann
parents:
diff changeset
   456
\begin{isamarkuptext}%
28593
f087237af65d continued codegen tutorial
haftmann
parents: 28564
diff changeset
   457
\noindent The initial bang ``\verb|!|'' tells the serialiser
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   458
  never to put
28447
haftmann
parents:
diff changeset
   459
  parentheses around the whole expression (they are already present),
haftmann
parents:
diff changeset
   460
  while the parentheses around argument place holders
haftmann
parents:
diff changeset
   461
  tell not to put parentheses around the arguments.
haftmann
parents:
diff changeset
   462
  The slash ``\verb|/|'' (followed by arbitrary white space)
haftmann
parents:
diff changeset
   463
  inserts a space which may be used as a break if necessary
haftmann
parents:
diff changeset
   464
  during pretty printing.
haftmann
parents:
diff changeset
   465
haftmann
parents:
diff changeset
   466
  These examples give a glimpse what mechanisms
haftmann
parents:
diff changeset
   467
  custom serialisations provide; however their usage
haftmann
parents:
diff changeset
   468
  requires careful thinking in order not to introduce
haftmann
parents:
diff changeset
   469
  inconsistencies -- or, in other words:
haftmann
parents:
diff changeset
   470
  custom serialisations are completely axiomatic.
haftmann
parents:
diff changeset
   471
haftmann
parents:
diff changeset
   472
  A further noteworthy details is that any special
haftmann
parents:
diff changeset
   473
  character in a custom serialisation may be quoted
haftmann
parents:
diff changeset
   474
  using ``\verb|'|''; thus, in
haftmann
parents:
diff changeset
   475
  ``\verb|fn '_ => _|'' the first
haftmann
parents:
diff changeset
   476
  ``\verb|_|'' is a proper underscore while the
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   477
  second ``\verb|_|'' is a placeholder.%
28447
haftmann
parents:
diff changeset
   478
\end{isamarkuptext}%
haftmann
parents:
diff changeset
   479
\isamarkuptrue%
haftmann
parents:
diff changeset
   480
%
haftmann
parents:
diff changeset
   481
\isamarkupsubsection{\isa{Haskell} serialisation%
haftmann
parents:
diff changeset
   482
}
haftmann
parents:
diff changeset
   483
\isamarkuptrue%
haftmann
parents:
diff changeset
   484
%
haftmann
parents:
diff changeset
   485
\begin{isamarkuptext}%
haftmann
parents:
diff changeset
   486
For convenience, the default
haftmann
parents:
diff changeset
   487
  \isa{HOL} setup for \isa{Haskell} maps the \isa{eq} class to
haftmann
parents:
diff changeset
   488
  its counterpart in \isa{Haskell}, giving custom serialisations
haftmann
parents:
diff changeset
   489
  for the class \isa{eq} (by command \hyperlink{command.code-class}{\mbox{\isa{\isacommand{code{\isacharunderscore}class}}}}) and its operation
haftmann
parents:
diff changeset
   490
  \isa{eq{\isacharunderscore}class{\isachardot}eq}%
haftmann
parents:
diff changeset
   491
\end{isamarkuptext}%
haftmann
parents:
diff changeset
   492
\isamarkuptrue%
haftmann
parents:
diff changeset
   493
%
28564
haftmann
parents: 28561
diff changeset
   494
\isadelimquotett
28447
haftmann
parents:
diff changeset
   495
%
28564
haftmann
parents: 28561
diff changeset
   496
\endisadelimquotett
28447
haftmann
parents:
diff changeset
   497
%
28564
haftmann
parents: 28561
diff changeset
   498
\isatagquotett
28447
haftmann
parents:
diff changeset
   499
\isacommand{code{\isacharunderscore}class}\isamarkupfalse%
haftmann
parents:
diff changeset
   500
\ eq\isanewline
28714
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   501
\ \ {\isacharparenleft}Haskell\ {\isachardoublequoteopen}Eq{\isachardoublequoteclose}{\isacharparenright}\isanewline
28447
haftmann
parents:
diff changeset
   502
\isanewline
haftmann
parents:
diff changeset
   503
\isacommand{code{\isacharunderscore}const}\isamarkupfalse%
haftmann
parents:
diff changeset
   504
\ {\isachardoublequoteopen}op\ {\isacharequal}{\isachardoublequoteclose}\isanewline
haftmann
parents:
diff changeset
   505
\ \ {\isacharparenleft}Haskell\ \isakeyword{infixl}\ {\isadigit{4}}\ {\isachardoublequoteopen}{\isacharequal}{\isacharequal}{\isachardoublequoteclose}{\isacharparenright}%
28564
haftmann
parents: 28561
diff changeset
   506
\endisatagquotett
haftmann
parents: 28561
diff changeset
   507
{\isafoldquotett}%
28447
haftmann
parents:
diff changeset
   508
%
28564
haftmann
parents: 28561
diff changeset
   509
\isadelimquotett
28447
haftmann
parents:
diff changeset
   510
%
28564
haftmann
parents: 28561
diff changeset
   511
\endisadelimquotett
28447
haftmann
parents:
diff changeset
   512
%
haftmann
parents:
diff changeset
   513
\begin{isamarkuptext}%
haftmann
parents:
diff changeset
   514
\noindent A problem now occurs whenever a type which
haftmann
parents:
diff changeset
   515
  is an instance of \isa{eq} in \isa{HOL} is mapped
haftmann
parents:
diff changeset
   516
  on a \isa{Haskell}-built-in type which is also an instance
haftmann
parents:
diff changeset
   517
  of \isa{Haskell} \isa{Eq}:%
haftmann
parents:
diff changeset
   518
\end{isamarkuptext}%
haftmann
parents:
diff changeset
   519
\isamarkuptrue%
haftmann
parents:
diff changeset
   520
%
28564
haftmann
parents: 28561
diff changeset
   521
\isadelimquote
28447
haftmann
parents:
diff changeset
   522
%
28564
haftmann
parents: 28561
diff changeset
   523
\endisadelimquote
28447
haftmann
parents:
diff changeset
   524
%
28564
haftmann
parents: 28561
diff changeset
   525
\isatagquote
28447
haftmann
parents:
diff changeset
   526
\isacommand{typedecl}\isamarkupfalse%
haftmann
parents:
diff changeset
   527
\ bar\isanewline
haftmann
parents:
diff changeset
   528
\isanewline
haftmann
parents:
diff changeset
   529
\isacommand{instantiation}\isamarkupfalse%
haftmann
parents:
diff changeset
   530
\ bar\ {\isacharcolon}{\isacharcolon}\ eq\isanewline
haftmann
parents:
diff changeset
   531
\isakeyword{begin}\isanewline
haftmann
parents:
diff changeset
   532
\isanewline
haftmann
parents:
diff changeset
   533
\isacommand{definition}\isamarkupfalse%
haftmann
parents:
diff changeset
   534
\ {\isachardoublequoteopen}eq{\isacharunderscore}class{\isachardot}eq\ {\isacharparenleft}x{\isasymColon}bar{\isacharparenright}\ y\ {\isasymlongleftrightarrow}\ x\ {\isacharequal}\ y{\isachardoublequoteclose}\isanewline
haftmann
parents:
diff changeset
   535
\isanewline
haftmann
parents:
diff changeset
   536
\isacommand{instance}\isamarkupfalse%
haftmann
parents:
diff changeset
   537
\ \isacommand{by}\isamarkupfalse%
haftmann
parents:
diff changeset
   538
\ default\ {\isacharparenleft}simp\ add{\isacharcolon}\ eq{\isacharunderscore}bar{\isacharunderscore}def{\isacharparenright}\isanewline
haftmann
parents:
diff changeset
   539
\isanewline
haftmann
parents:
diff changeset
   540
\isacommand{end}\isamarkupfalse%
haftmann
parents:
diff changeset
   541
%
28564
haftmann
parents: 28561
diff changeset
   542
\endisatagquote
haftmann
parents: 28561
diff changeset
   543
{\isafoldquote}%
28447
haftmann
parents:
diff changeset
   544
%
28564
haftmann
parents: 28561
diff changeset
   545
\isadelimquote
28447
haftmann
parents:
diff changeset
   546
%
28564
haftmann
parents: 28561
diff changeset
   547
\endisadelimquote
28447
haftmann
parents:
diff changeset
   548
%
28564
haftmann
parents: 28561
diff changeset
   549
\isadelimquotett
30880
257cbe43faa8 tuned manual
haftmann
parents: 30836
diff changeset
   550
\ %
28564
haftmann
parents: 28561
diff changeset
   551
\endisadelimquotett
28447
haftmann
parents:
diff changeset
   552
%
28564
haftmann
parents: 28561
diff changeset
   553
\isatagquotett
28447
haftmann
parents:
diff changeset
   554
\isacommand{code{\isacharunderscore}type}\isamarkupfalse%
haftmann
parents:
diff changeset
   555
\ bar\isanewline
haftmann
parents:
diff changeset
   556
\ \ {\isacharparenleft}Haskell\ {\isachardoublequoteopen}Integer{\isachardoublequoteclose}{\isacharparenright}%
28564
haftmann
parents: 28561
diff changeset
   557
\endisatagquotett
haftmann
parents: 28561
diff changeset
   558
{\isafoldquotett}%
28447
haftmann
parents:
diff changeset
   559
%
28564
haftmann
parents: 28561
diff changeset
   560
\isadelimquotett
28447
haftmann
parents:
diff changeset
   561
%
28564
haftmann
parents: 28561
diff changeset
   562
\endisadelimquotett
28447
haftmann
parents:
diff changeset
   563
%
haftmann
parents:
diff changeset
   564
\begin{isamarkuptext}%
haftmann
parents:
diff changeset
   565
\noindent The code generator would produce
28593
f087237af65d continued codegen tutorial
haftmann
parents: 28564
diff changeset
   566
  an additional instance, which of course is rejected by the \isa{Haskell}
28447
haftmann
parents:
diff changeset
   567
  compiler.
haftmann
parents:
diff changeset
   568
  To suppress this additional instance, use
haftmann
parents:
diff changeset
   569
  \isa{code{\isacharunderscore}instance}:%
haftmann
parents:
diff changeset
   570
\end{isamarkuptext}%
haftmann
parents:
diff changeset
   571
\isamarkuptrue%
haftmann
parents:
diff changeset
   572
%
28564
haftmann
parents: 28561
diff changeset
   573
\isadelimquotett
28447
haftmann
parents:
diff changeset
   574
%
28564
haftmann
parents: 28561
diff changeset
   575
\endisadelimquotett
28447
haftmann
parents:
diff changeset
   576
%
28564
haftmann
parents: 28561
diff changeset
   577
\isatagquotett
28447
haftmann
parents:
diff changeset
   578
\isacommand{code{\isacharunderscore}instance}\isamarkupfalse%
haftmann
parents:
diff changeset
   579
\ bar\ {\isacharcolon}{\isacharcolon}\ eq\isanewline
haftmann
parents:
diff changeset
   580
\ \ {\isacharparenleft}Haskell\ {\isacharminus}{\isacharparenright}%
28564
haftmann
parents: 28561
diff changeset
   581
\endisatagquotett
haftmann
parents: 28561
diff changeset
   582
{\isafoldquotett}%
28447
haftmann
parents:
diff changeset
   583
%
28564
haftmann
parents: 28561
diff changeset
   584
\isadelimquotett
28447
haftmann
parents:
diff changeset
   585
%
28564
haftmann
parents: 28561
diff changeset
   586
\endisadelimquotett
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   587
%
28635
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   588
\isamarkupsubsection{Enhancing the target language context \label{sec:include}%
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   589
}
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   590
\isamarkuptrue%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   591
%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   592
\begin{isamarkuptext}%
28593
f087237af65d continued codegen tutorial
haftmann
parents: 28564
diff changeset
   593
In rare cases it is necessary to \emph{enrich} the context of a
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   594
  target language;  this is accomplished using the \hyperlink{command.code-include}{\mbox{\isa{\isacommand{code{\isacharunderscore}include}}}}
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   595
  command:%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   596
\end{isamarkuptext}%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   597
\isamarkuptrue%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   598
%
28564
haftmann
parents: 28561
diff changeset
   599
\isadelimquotett
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   600
%
28564
haftmann
parents: 28561
diff changeset
   601
\endisadelimquotett
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   602
%
28564
haftmann
parents: 28561
diff changeset
   603
\isatagquotett
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   604
\isacommand{code{\isacharunderscore}include}\isamarkupfalse%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   605
\ Haskell\ {\isachardoublequoteopen}Errno{\isachardoublequoteclose}\isanewline
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   606
{\isacharverbatimopen}errno\ i\ {\isacharequal}\ error\ {\isacharparenleft}{\isachardoublequote}Error\ number{\isacharcolon}\ {\isachardoublequote}\ {\isacharplus}{\isacharplus}\ show\ i{\isacharparenright}{\isacharverbatimclose}\isanewline
28447
haftmann
parents:
diff changeset
   607
\isanewline
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   608
\isacommand{code{\isacharunderscore}reserved}\isamarkupfalse%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   609
\ Haskell\ Errno%
28564
haftmann
parents: 28561
diff changeset
   610
\endisatagquotett
haftmann
parents: 28561
diff changeset
   611
{\isafoldquotett}%
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   612
%
28564
haftmann
parents: 28561
diff changeset
   613
\isadelimquotett
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   614
%
28564
haftmann
parents: 28561
diff changeset
   615
\endisadelimquotett
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   616
%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   617
\begin{isamarkuptext}%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   618
\noindent Such named \isa{include}s are then prepended to every generated code.
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   619
  Inspect such code in order to find out how \hyperlink{command.code-include}{\mbox{\isa{\isacommand{code{\isacharunderscore}include}}}} behaves
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   620
  with respect to a particular target language.%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   621
\end{isamarkuptext}%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   622
\isamarkuptrue%
28447
haftmann
parents:
diff changeset
   623
%
haftmann
parents:
diff changeset
   624
\isadelimtheory
haftmann
parents:
diff changeset
   625
%
haftmann
parents:
diff changeset
   626
\endisadelimtheory
haftmann
parents:
diff changeset
   627
%
haftmann
parents:
diff changeset
   628
\isatagtheory
haftmann
parents:
diff changeset
   629
\isacommand{end}\isamarkupfalse%
haftmann
parents:
diff changeset
   630
%
haftmann
parents:
diff changeset
   631
\endisatagtheory
haftmann
parents:
diff changeset
   632
{\isafoldtheory}%
haftmann
parents:
diff changeset
   633
%
haftmann
parents:
diff changeset
   634
\isadelimtheory
haftmann
parents:
diff changeset
   635
%
haftmann
parents:
diff changeset
   636
\endisadelimtheory
haftmann
parents:
diff changeset
   637
\isanewline
haftmann
parents:
diff changeset
   638
\end{isabellebody}%
haftmann
parents:
diff changeset
   639
%%% Local Variables:
haftmann
parents:
diff changeset
   640
%%% mode: latex
haftmann
parents:
diff changeset
   641
%%% TeX-master: "root"
haftmann
parents:
diff changeset
   642
%%% End: