doc-src/Codegen/Thy/document/Adaption.tex
author haftmann
Tue, 03 Mar 2009 13:20:53 +0100
changeset 30227 853abb4853cc
parent 30226 2f4684e2ea95
child 30836 1344132160bb
permissions -rw-r--r--
tuned manuals
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}%
28601
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
    95
The following figure illustrates what \qt{adaption} is conceptually
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]
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
    99
    \begin{tikzpicture}[scale = 0.5]
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   100
      \tikzstyle water=[color = blue, thick]
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   101
      \tikzstyle ice=[color = black, very thick, cap = round, join = round, fill = white]
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   102
      \tikzstyle process=[color = green, semithick, ->]
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   103
      \tikzstyle adaption=[color = red, semithick, ->]
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   104
      \tikzstyle target=[color = black]
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   105
      \foreach \x in {0, ..., 24}
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   106
        \draw[style=water] (\x, 0.25) sin + (0.25, 0.25) cos + (0.25, -0.25) sin
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   107
          + (0.25, -0.25) cos + (0.25, 0.25);
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   108
      \draw[style=ice] (1, 0) --
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   109
        (3, 6) node[above, fill=white] {logic} -- (5, 0) -- cycle;
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   110
      \draw[style=ice] (9, 0) --
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   111
        (11, 6) node[above, fill=white] {intermediate language} -- (13, 0) -- cycle;
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   112
      \draw[style=ice] (15, -6) --
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   113
        (19, 6) node[above, fill=white] {target language} -- (23, -6) -- cycle;
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   114
      \draw[style=process]
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   115
        (3.5, 3) .. controls (7, 5) .. node[fill=white] {translation} (10.5, 3);
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   116
      \draw[style=process]
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   117
        (11.5, 3) .. controls (15, 5) .. node[fill=white] (serialisation) {serialisation} (18.5, 3);
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   118
      \node (adaption) at (11, -2) [style=adaption] {adaption};
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   119
      \node at (19, 3) [rotate=90] {generated};
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   120
      \node at (19.5, -5) {language};
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   121
      \node at (19.5, -3) {library};
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   122
      \node (includes) at (19.5, -1) {includes};
28609
d8fdecb1ea00 correct rounding
haftmann
parents: 28608
diff changeset
   123
      \node (reserved) at (16.5, -3) [rotate=72] {reserved}; % proper 71.57
28601
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   124
      \draw[style=process]
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   125
        (includes) -- (serialisation);
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   126
      \draw[style=process]
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   127
        (reserved) -- (serialisation);
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   128
      \draw[style=adaption]
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   129
        (adaption) -- (serialisation);
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   130
      \draw[style=adaption]
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   131
        (adaption) -- (includes);
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   132
      \draw[style=adaption]
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   133
        (adaption) -- (reserved);
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   134
    \end{tikzpicture}
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   135
    \caption{The adaption principle}
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   136
    \label{fig:adaption}
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   137
  \end{figure}
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   138
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   139
  \noindent In the tame view, code generation acts as broker between
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   140
  \isa{logic}, \isa{intermediate\ language} and
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   141
  \isa{target\ language} by means of \isa{translation} and
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   142
  \isa{serialisation};  for the latter, the serialiser has to observe
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   143
  the structure of the \isa{language} itself plus some \isa{reserved}
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   144
  keywords which have to be avoided for generated code.
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   145
  However, if you consider \isa{adaption} mechanisms, the code generated
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   146
  by the serializer is just the tip of the iceberg:
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   147
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   148
  \begin{itemize}
28635
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   149
    \item \isa{serialisation} can be \emph{parametrised} such that
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   150
      logical entities are mapped to target-specific ones
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   151
      (e.g. target-specific list syntax,
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   152
        see also \secref{sec:adaption_mechanisms})
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   153
    \item Such parametrisations can involve references to a
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   154
      target-specific standard \isa{library} (e.g. using
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   155
      the \isa{Haskell} \verb|Maybe| type instead
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   156
      of the \isa{HOL} \isa{option} type);
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   157
      if such are used, the corresponding identifiers
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   158
      (in our example, \verb|Maybe|, \verb|Nothing|
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   159
      and \verb|Just|) also have to be considered \isa{reserved}.
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   160
    \item Even more, the user can enrich the library of the
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   161
      target-language by providing code snippets
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   162
      (\qt{\isa{includes}}) which are prepended to
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   163
      any generated code (see \secref{sec:include});  this typically
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   164
      also involves further \isa{reserved} identifiers.
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   165
  \end{itemize}
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   166
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   167
  \noindent As figure \ref{fig:adaption} illustrates, all these adaption mechanisms
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   168
  have to act consistently;  it is at the discretion of the user
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   169
  to take care for this.%
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   170
\end{isamarkuptext}%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   171
\isamarkuptrue%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   172
%
28635
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   173
\isamarkupsubsection{Common adaption patterns%
28447
haftmann
parents:
diff changeset
   174
}
haftmann
parents:
diff changeset
   175
\isamarkuptrue%
haftmann
parents:
diff changeset
   176
%
haftmann
parents:
diff changeset
   177
\begin{isamarkuptext}%
haftmann
parents:
diff changeset
   178
The \hyperlink{theory.HOL}{\mbox{\isa{HOL}}} \hyperlink{theory.Main}{\mbox{\isa{Main}}} theory already provides a code
haftmann
parents:
diff changeset
   179
  generator setup
28593
f087237af65d continued codegen tutorial
haftmann
parents: 28564
diff changeset
   180
  which should be suitable for most applications.  Common extensions
28447
haftmann
parents:
diff changeset
   181
  and modifications are available by certain theories of the \isa{HOL}
haftmann
parents:
diff changeset
   182
  library; beside being useful in applications, they may serve
haftmann
parents:
diff changeset
   183
  as a tutorial for customising the code generator setup (see below
haftmann
parents:
diff changeset
   184
  \secref{sec:adaption_mechanisms}).
haftmann
parents:
diff changeset
   185
haftmann
parents:
diff changeset
   186
  \begin{description}
haftmann
parents:
diff changeset
   187
haftmann
parents:
diff changeset
   188
    \item[\hyperlink{theory.Code-Integer}{\mbox{\isa{Code{\isacharunderscore}Integer}}}] represents \isa{HOL} integers by big
haftmann
parents:
diff changeset
   189
       integer literals in target languages.
haftmann
parents:
diff changeset
   190
    \item[\hyperlink{theory.Code-Char}{\mbox{\isa{Code{\isacharunderscore}Char}}}] represents \isa{HOL} characters by 
haftmann
parents:
diff changeset
   191
       character literals in target languages.
haftmann
parents:
diff changeset
   192
    \item[\hyperlink{theory.Code-Char-chr}{\mbox{\isa{Code{\isacharunderscore}Char{\isacharunderscore}chr}}}] like \isa{Code{\isacharunderscore}Char},
haftmann
parents:
diff changeset
   193
       but also offers treatment of character codes; includes
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   194
       \hyperlink{theory.Code-Char}{\mbox{\isa{Code{\isacharunderscore}Char}}}.
28447
haftmann
parents:
diff changeset
   195
    \item[\hyperlink{theory.Efficient-Nat}{\mbox{\isa{Efficient{\isacharunderscore}Nat}}}] \label{eff_nat} implements natural numbers by integers,
haftmann
parents:
diff changeset
   196
       which in general will result in higher efficiency; pattern
haftmann
parents:
diff changeset
   197
       matching with \isa{{\isadigit{0}}} / \isa{Suc}
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   198
       is eliminated;  includes \hyperlink{theory.Code-Integer}{\mbox{\isa{Code{\isacharunderscore}Integer}}}
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   199
       and \hyperlink{theory.Code-Index}{\mbox{\isa{Code{\isacharunderscore}Index}}}.
28447
haftmann
parents:
diff changeset
   200
    \item[\hyperlink{theory.Code-Index}{\mbox{\isa{Code{\isacharunderscore}Index}}}] provides an additional datatype
haftmann
parents:
diff changeset
   201
       \isa{index} which is mapped to target-language built-in integers.
haftmann
parents:
diff changeset
   202
       Useful for code setups which involve e.g. indexing of
haftmann
parents:
diff changeset
   203
       target-language arrays.
haftmann
parents:
diff changeset
   204
    \item[\hyperlink{theory.Code-Message}{\mbox{\isa{Code{\isacharunderscore}Message}}}] provides an additional datatype
haftmann
parents:
diff changeset
   205
       \isa{message{\isacharunderscore}string} which is isomorphic to strings;
haftmann
parents:
diff changeset
   206
       \isa{message{\isacharunderscore}string}s are mapped to target-language strings.
haftmann
parents:
diff changeset
   207
       Useful for code setups which involve e.g. printing (error) messages.
haftmann
parents:
diff changeset
   208
haftmann
parents:
diff changeset
   209
  \end{description}
haftmann
parents:
diff changeset
   210
haftmann
parents:
diff changeset
   211
  \begin{warn}
haftmann
parents:
diff changeset
   212
    When importing any of these theories, they should form the last
haftmann
parents:
diff changeset
   213
    items in an import list.  Since these theories adapt the
haftmann
parents:
diff changeset
   214
    code generator setup in a non-conservative fashion,
haftmann
parents:
diff changeset
   215
    strange effects may occur otherwise.
haftmann
parents:
diff changeset
   216
  \end{warn}%
haftmann
parents:
diff changeset
   217
\end{isamarkuptext}%
haftmann
parents:
diff changeset
   218
\isamarkuptrue%
haftmann
parents:
diff changeset
   219
%
28635
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   220
\isamarkupsubsection{Parametrising serialisation \label{sec:adaption_mechanisms}%
28447
haftmann
parents:
diff changeset
   221
}
haftmann
parents:
diff changeset
   222
\isamarkuptrue%
haftmann
parents:
diff changeset
   223
%
haftmann
parents:
diff changeset
   224
\begin{isamarkuptext}%
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   225
Consider the following function and its corresponding
28447
haftmann
parents:
diff changeset
   226
  SML code:%
haftmann
parents:
diff changeset
   227
\end{isamarkuptext}%
haftmann
parents:
diff changeset
   228
\isamarkuptrue%
haftmann
parents:
diff changeset
   229
%
28564
haftmann
parents: 28561
diff changeset
   230
\isadelimquote
28447
haftmann
parents:
diff changeset
   231
%
28564
haftmann
parents: 28561
diff changeset
   232
\endisadelimquote
28447
haftmann
parents:
diff changeset
   233
%
28564
haftmann
parents: 28561
diff changeset
   234
\isatagquote
28447
haftmann
parents:
diff changeset
   235
\isacommand{primrec}\isamarkupfalse%
haftmann
parents:
diff changeset
   236
\ in{\isacharunderscore}interval\ {\isacharcolon}{\isacharcolon}\ {\isachardoublequoteopen}nat\ {\isasymtimes}\ nat\ {\isasymRightarrow}\ nat\ {\isasymRightarrow}\ bool{\isachardoublequoteclose}\ \isakeyword{where}\isanewline
haftmann
parents:
diff changeset
   237
\ \ {\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
   238
\endisatagquote
haftmann
parents: 28561
diff changeset
   239
{\isafoldquote}%
28447
haftmann
parents:
diff changeset
   240
%
28564
haftmann
parents: 28561
diff changeset
   241
\isadelimquote
28447
haftmann
parents:
diff changeset
   242
%
28564
haftmann
parents: 28561
diff changeset
   243
\endisadelimquote
28447
haftmann
parents:
diff changeset
   244
%
haftmann
parents:
diff changeset
   245
\isadeliminvisible
haftmann
parents:
diff changeset
   246
%
haftmann
parents:
diff changeset
   247
\endisadeliminvisible
haftmann
parents:
diff changeset
   248
%
haftmann
parents:
diff changeset
   249
\isataginvisible
haftmann
parents:
diff changeset
   250
%
haftmann
parents:
diff changeset
   251
\endisataginvisible
haftmann
parents:
diff changeset
   252
{\isafoldinvisible}%
haftmann
parents:
diff changeset
   253
%
haftmann
parents:
diff changeset
   254
\isadeliminvisible
haftmann
parents:
diff changeset
   255
%
haftmann
parents:
diff changeset
   256
\endisadeliminvisible
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
%
28564
haftmann
parents: 28561
diff changeset
   262
\isatagquote
28447
haftmann
parents:
diff changeset
   263
%
haftmann
parents:
diff changeset
   264
\begin{isamarkuptext}%
28727
185110a4b97a clarified verbatim vs. typewriter
haftmann
parents: 28714
diff changeset
   265
\isatypewriter%
28447
haftmann
parents:
diff changeset
   266
\noindent%
28714
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   267
\hspace*{0pt}structure Example = \\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   268
\hspace*{0pt}struct\\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   269
\hspace*{0pt}\\
30121
5c7bcb296600 updated generated files;
wenzelm
parents: 29297
diff changeset
   270
\hspace*{0pt}datatype nat = Zero{\char95}nat | Suc of nat;\\
28714
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   271
\hspace*{0pt}\\
30121
5c7bcb296600 updated generated files;
wenzelm
parents: 29297
diff changeset
   272
\hspace*{0pt}datatype boola = True | False;\\
28714
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   273
\hspace*{0pt}\\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   274
\hspace*{0pt}fun anda x True = x\\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   275
\hspace*{0pt} ~| anda x False = False\\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   276
\hspace*{0pt} ~| anda True x = x\\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   277
\hspace*{0pt} ~| anda False x = False;\\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   278
\hspace*{0pt}\\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   279
\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
   280
\hspace*{0pt} ~| less{\char95}nat n Zero{\char95}nat = False\\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   281
\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
   282
\hspace*{0pt} ~| less{\char95}eq{\char95}nat Zero{\char95}nat n = True;\\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   283
\hspace*{0pt}\\
29297
62e0f892e525 updated generated files;
wenzelm
parents: 28727
diff changeset
   284
\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
   285
\hspace*{0pt}\\
29297
62e0f892e525 updated generated files;
wenzelm
parents: 28727
diff changeset
   286
\hspace*{0pt}end;~(*struct Example*)%
28447
haftmann
parents:
diff changeset
   287
\end{isamarkuptext}%
haftmann
parents:
diff changeset
   288
\isamarkuptrue%
haftmann
parents:
diff changeset
   289
%
28564
haftmann
parents: 28561
diff changeset
   290
\endisatagquote
haftmann
parents: 28561
diff changeset
   291
{\isafoldquote}%
28447
haftmann
parents:
diff changeset
   292
%
28564
haftmann
parents: 28561
diff changeset
   293
\isadelimquote
28447
haftmann
parents:
diff changeset
   294
%
28564
haftmann
parents: 28561
diff changeset
   295
\endisadelimquote
28447
haftmann
parents:
diff changeset
   296
%
haftmann
parents:
diff changeset
   297
\begin{isamarkuptext}%
haftmann
parents:
diff changeset
   298
\noindent Though this is correct code, it is a little bit unsatisfactory:
haftmann
parents:
diff changeset
   299
  boolean values and operators are materialised as distinguished
haftmann
parents:
diff changeset
   300
  entities with have nothing to do with the SML-built-in notion
haftmann
parents:
diff changeset
   301
  of \qt{bool}.  This results in less readable code;
haftmann
parents:
diff changeset
   302
  additionally, eager evaluation may cause programs to
haftmann
parents:
diff changeset
   303
  loop or break which would perfectly terminate when
haftmann
parents:
diff changeset
   304
  the existing SML \verb|bool| would be used.  To map
haftmann
parents:
diff changeset
   305
  the HOL \isa{bool} on SML \verb|bool|, we may use
haftmann
parents:
diff changeset
   306
  \qn{custom serialisations}:%
haftmann
parents:
diff changeset
   307
\end{isamarkuptext}%
haftmann
parents:
diff changeset
   308
\isamarkuptrue%
haftmann
parents:
diff changeset
   309
%
28564
haftmann
parents: 28561
diff changeset
   310
\isadelimquotett
28447
haftmann
parents:
diff changeset
   311
%
28564
haftmann
parents: 28561
diff changeset
   312
\endisadelimquotett
28447
haftmann
parents:
diff changeset
   313
%
28564
haftmann
parents: 28561
diff changeset
   314
\isatagquotett
28447
haftmann
parents:
diff changeset
   315
\isacommand{code{\isacharunderscore}type}\isamarkupfalse%
haftmann
parents:
diff changeset
   316
\ bool\isanewline
haftmann
parents:
diff changeset
   317
\ \ {\isacharparenleft}SML\ {\isachardoublequoteopen}bool{\isachardoublequoteclose}{\isacharparenright}\isanewline
haftmann
parents:
diff changeset
   318
\isacommand{code{\isacharunderscore}const}\isamarkupfalse%
haftmann
parents:
diff changeset
   319
\ True\ \isakeyword{and}\ False\ \isakeyword{and}\ {\isachardoublequoteopen}op\ {\isasymand}{\isachardoublequoteclose}\isanewline
haftmann
parents:
diff changeset
   320
\ \ {\isacharparenleft}SML\ {\isachardoublequoteopen}true{\isachardoublequoteclose}\ \isakeyword{and}\ {\isachardoublequoteopen}false{\isachardoublequoteclose}\ \isakeyword{and}\ {\isachardoublequoteopen}{\isacharunderscore}\ andalso\ {\isacharunderscore}{\isachardoublequoteclose}{\isacharparenright}%
28564
haftmann
parents: 28561
diff changeset
   321
\endisatagquotett
haftmann
parents: 28561
diff changeset
   322
{\isafoldquotett}%
28447
haftmann
parents:
diff changeset
   323
%
28564
haftmann
parents: 28561
diff changeset
   324
\isadelimquotett
28447
haftmann
parents:
diff changeset
   325
%
28564
haftmann
parents: 28561
diff changeset
   326
\endisadelimquotett
28447
haftmann
parents:
diff changeset
   327
%
haftmann
parents:
diff changeset
   328
\begin{isamarkuptext}%
haftmann
parents:
diff changeset
   329
\noindent The \hyperlink{command.code-type}{\mbox{\isa{\isacommand{code{\isacharunderscore}type}}}} command takes a type constructor
haftmann
parents:
diff changeset
   330
  as arguments together with a list of custom serialisations.
haftmann
parents:
diff changeset
   331
  Each custom serialisation starts with a target language
haftmann
parents:
diff changeset
   332
  identifier followed by an expression, which during
haftmann
parents:
diff changeset
   333
  code serialisation is inserted whenever the type constructor
haftmann
parents:
diff changeset
   334
  would occur.  For constants, \hyperlink{command.code-const}{\mbox{\isa{\isacommand{code{\isacharunderscore}const}}}} implements
haftmann
parents:
diff changeset
   335
  the corresponding mechanism.  Each ``\verb|_|'' in
haftmann
parents:
diff changeset
   336
  a serialisation expression is treated as a placeholder
haftmann
parents:
diff changeset
   337
  for the type constructor's (the constant's) arguments.%
haftmann
parents:
diff changeset
   338
\end{isamarkuptext}%
haftmann
parents:
diff changeset
   339
\isamarkuptrue%
haftmann
parents:
diff changeset
   340
%
28564
haftmann
parents: 28561
diff changeset
   341
\isadelimquote
28447
haftmann
parents:
diff changeset
   342
%
28564
haftmann
parents: 28561
diff changeset
   343
\endisadelimquote
28447
haftmann
parents:
diff changeset
   344
%
28564
haftmann
parents: 28561
diff changeset
   345
\isatagquote
28447
haftmann
parents:
diff changeset
   346
%
haftmann
parents:
diff changeset
   347
\begin{isamarkuptext}%
28727
185110a4b97a clarified verbatim vs. typewriter
haftmann
parents: 28714
diff changeset
   348
\isatypewriter%
28447
haftmann
parents:
diff changeset
   349
\noindent%
28714
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   350
\hspace*{0pt}structure Example = \\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   351
\hspace*{0pt}struct\\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   352
\hspace*{0pt}\\
30121
5c7bcb296600 updated generated files;
wenzelm
parents: 29297
diff changeset
   353
\hspace*{0pt}datatype nat = Zero{\char95}nat | Suc of nat;\\
28714
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   354
\hspace*{0pt}\\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   355
\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
   356
\hspace*{0pt} ~| less{\char95}nat n Zero{\char95}nat = false\\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   357
\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
   358
\hspace*{0pt} ~| less{\char95}eq{\char95}nat Zero{\char95}nat n = true;\\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   359
\hspace*{0pt}\\
29297
62e0f892e525 updated generated files;
wenzelm
parents: 28727
diff changeset
   360
\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
   361
\hspace*{0pt}\\
29297
62e0f892e525 updated generated files;
wenzelm
parents: 28727
diff changeset
   362
\hspace*{0pt}end;~(*struct Example*)%
28447
haftmann
parents:
diff changeset
   363
\end{isamarkuptext}%
haftmann
parents:
diff changeset
   364
\isamarkuptrue%
haftmann
parents:
diff changeset
   365
%
28564
haftmann
parents: 28561
diff changeset
   366
\endisatagquote
haftmann
parents: 28561
diff changeset
   367
{\isafoldquote}%
28447
haftmann
parents:
diff changeset
   368
%
28564
haftmann
parents: 28561
diff changeset
   369
\isadelimquote
28447
haftmann
parents:
diff changeset
   370
%
28564
haftmann
parents: 28561
diff changeset
   371
\endisadelimquote
28447
haftmann
parents:
diff changeset
   372
%
haftmann
parents:
diff changeset
   373
\begin{isamarkuptext}%
haftmann
parents:
diff changeset
   374
\noindent This still is not perfect: the parentheses
haftmann
parents:
diff changeset
   375
  around the \qt{andalso} expression are superfluous.
28593
f087237af65d continued codegen tutorial
haftmann
parents: 28564
diff changeset
   376
  Though the serialiser
28447
haftmann
parents:
diff changeset
   377
  by no means attempts to imitate the rich Isabelle syntax
haftmann
parents:
diff changeset
   378
  framework, it provides some common idioms, notably
haftmann
parents:
diff changeset
   379
  associative infixes with precedences which may be used here:%
haftmann
parents:
diff changeset
   380
\end{isamarkuptext}%
haftmann
parents:
diff changeset
   381
\isamarkuptrue%
haftmann
parents:
diff changeset
   382
%
28564
haftmann
parents: 28561
diff changeset
   383
\isadelimquotett
28447
haftmann
parents:
diff changeset
   384
%
28564
haftmann
parents: 28561
diff changeset
   385
\endisadelimquotett
28447
haftmann
parents:
diff changeset
   386
%
28564
haftmann
parents: 28561
diff changeset
   387
\isatagquotett
28447
haftmann
parents:
diff changeset
   388
\isacommand{code{\isacharunderscore}const}\isamarkupfalse%
haftmann
parents:
diff changeset
   389
\ {\isachardoublequoteopen}op\ {\isasymand}{\isachardoublequoteclose}\isanewline
haftmann
parents:
diff changeset
   390
\ \ {\isacharparenleft}SML\ \isakeyword{infixl}\ {\isadigit{1}}\ {\isachardoublequoteopen}andalso{\isachardoublequoteclose}{\isacharparenright}%
28564
haftmann
parents: 28561
diff changeset
   391
\endisatagquotett
haftmann
parents: 28561
diff changeset
   392
{\isafoldquotett}%
28447
haftmann
parents:
diff changeset
   393
%
28564
haftmann
parents: 28561
diff changeset
   394
\isadelimquotett
28447
haftmann
parents:
diff changeset
   395
%
28564
haftmann
parents: 28561
diff changeset
   396
\endisadelimquotett
28447
haftmann
parents:
diff changeset
   397
%
28564
haftmann
parents: 28561
diff changeset
   398
\isadelimquote
28447
haftmann
parents:
diff changeset
   399
%
28564
haftmann
parents: 28561
diff changeset
   400
\endisadelimquote
28447
haftmann
parents:
diff changeset
   401
%
28564
haftmann
parents: 28561
diff changeset
   402
\isatagquote
28447
haftmann
parents:
diff changeset
   403
%
haftmann
parents:
diff changeset
   404
\begin{isamarkuptext}%
28727
185110a4b97a clarified verbatim vs. typewriter
haftmann
parents: 28714
diff changeset
   405
\isatypewriter%
28447
haftmann
parents:
diff changeset
   406
\noindent%
28714
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   407
\hspace*{0pt}structure Example = \\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   408
\hspace*{0pt}struct\\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   409
\hspace*{0pt}\\
30121
5c7bcb296600 updated generated files;
wenzelm
parents: 29297
diff changeset
   410
\hspace*{0pt}datatype nat = Zero{\char95}nat | Suc of nat;\\
28714
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   411
\hspace*{0pt}\\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   412
\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
   413
\hspace*{0pt} ~| less{\char95}nat n Zero{\char95}nat = false\\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   414
\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
   415
\hspace*{0pt} ~| less{\char95}eq{\char95}nat Zero{\char95}nat n = true;\\
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   416
\hspace*{0pt}\\
29297
62e0f892e525 updated generated files;
wenzelm
parents: 28727
diff changeset
   417
\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
   418
\hspace*{0pt}\\
29297
62e0f892e525 updated generated files;
wenzelm
parents: 28727
diff changeset
   419
\hspace*{0pt}end;~(*struct Example*)%
28447
haftmann
parents:
diff changeset
   420
\end{isamarkuptext}%
haftmann
parents:
diff changeset
   421
\isamarkuptrue%
haftmann
parents:
diff changeset
   422
%
28564
haftmann
parents: 28561
diff changeset
   423
\endisatagquote
haftmann
parents: 28561
diff changeset
   424
{\isafoldquote}%
28447
haftmann
parents:
diff changeset
   425
%
28564
haftmann
parents: 28561
diff changeset
   426
\isadelimquote
28447
haftmann
parents:
diff changeset
   427
%
28564
haftmann
parents: 28561
diff changeset
   428
\endisadelimquote
28447
haftmann
parents:
diff changeset
   429
%
haftmann
parents:
diff changeset
   430
\begin{isamarkuptext}%
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   431
\noindent The attentive reader may ask how we assert that no generated
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   432
  code will accidentally overwrite.  For this reason the serialiser has
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   433
  an internal table of identifiers which have to be avoided to be used
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   434
  for new declarations.  Initially, this table typically contains the
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   435
  keywords of the target language.  It can be extended manually, thus avoiding
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   436
  accidental overwrites, using the \hyperlink{command.code-reserved}{\mbox{\isa{\isacommand{code{\isacharunderscore}reserved}}}} command:%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   437
\end{isamarkuptext}%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   438
\isamarkuptrue%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   439
%
28564
haftmann
parents: 28561
diff changeset
   440
\isadelimquote
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   441
%
28564
haftmann
parents: 28561
diff changeset
   442
\endisadelimquote
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   443
%
28564
haftmann
parents: 28561
diff changeset
   444
\isatagquote
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   445
\isacommand{code{\isacharunderscore}reserved}\isamarkupfalse%
28601
b72589374396 figure for adaption
haftmann
parents: 28593
diff changeset
   446
\ {\isachardoublequoteopen}{\isasymSML}{\isachardoublequoteclose}\ bool\ true\ false\ andalso%
28564
haftmann
parents: 28561
diff changeset
   447
\endisatagquote
haftmann
parents: 28561
diff changeset
   448
{\isafoldquote}%
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   449
%
28564
haftmann
parents: 28561
diff changeset
   450
\isadelimquote
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   451
%
28564
haftmann
parents: 28561
diff changeset
   452
\endisadelimquote
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   453
%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   454
\begin{isamarkuptext}%
28447
haftmann
parents:
diff changeset
   455
\noindent Next, we try to map HOL pairs to SML pairs, using the
haftmann
parents:
diff changeset
   456
  infix ``\verb|*|'' type constructor and parentheses:%
haftmann
parents:
diff changeset
   457
\end{isamarkuptext}%
haftmann
parents:
diff changeset
   458
\isamarkuptrue%
haftmann
parents:
diff changeset
   459
%
haftmann
parents:
diff changeset
   460
\isadeliminvisible
haftmann
parents:
diff changeset
   461
%
haftmann
parents:
diff changeset
   462
\endisadeliminvisible
haftmann
parents:
diff changeset
   463
%
haftmann
parents:
diff changeset
   464
\isataginvisible
haftmann
parents:
diff changeset
   465
%
haftmann
parents:
diff changeset
   466
\endisataginvisible
haftmann
parents:
diff changeset
   467
{\isafoldinvisible}%
haftmann
parents:
diff changeset
   468
%
haftmann
parents:
diff changeset
   469
\isadeliminvisible
haftmann
parents:
diff changeset
   470
%
haftmann
parents:
diff changeset
   471
\endisadeliminvisible
haftmann
parents:
diff changeset
   472
%
28564
haftmann
parents: 28561
diff changeset
   473
\isadelimquotett
28447
haftmann
parents:
diff changeset
   474
%
28564
haftmann
parents: 28561
diff changeset
   475
\endisadelimquotett
28447
haftmann
parents:
diff changeset
   476
%
28564
haftmann
parents: 28561
diff changeset
   477
\isatagquotett
28447
haftmann
parents:
diff changeset
   478
\isacommand{code{\isacharunderscore}type}\isamarkupfalse%
haftmann
parents:
diff changeset
   479
\ {\isacharasterisk}\isanewline
haftmann
parents:
diff changeset
   480
\ \ {\isacharparenleft}SML\ \isakeyword{infix}\ {\isadigit{2}}\ {\isachardoublequoteopen}{\isacharasterisk}{\isachardoublequoteclose}{\isacharparenright}\isanewline
haftmann
parents:
diff changeset
   481
\isacommand{code{\isacharunderscore}const}\isamarkupfalse%
haftmann
parents:
diff changeset
   482
\ Pair\isanewline
haftmann
parents:
diff changeset
   483
\ \ {\isacharparenleft}SML\ {\isachardoublequoteopen}{\isacharbang}{\isacharparenleft}{\isacharparenleft}{\isacharunderscore}{\isacharparenright}{\isacharcomma}{\isacharslash}\ {\isacharparenleft}{\isacharunderscore}{\isacharparenright}{\isacharparenright}{\isachardoublequoteclose}{\isacharparenright}%
28564
haftmann
parents: 28561
diff changeset
   484
\endisatagquotett
haftmann
parents: 28561
diff changeset
   485
{\isafoldquotett}%
28447
haftmann
parents:
diff changeset
   486
%
28564
haftmann
parents: 28561
diff changeset
   487
\isadelimquotett
28447
haftmann
parents:
diff changeset
   488
%
28564
haftmann
parents: 28561
diff changeset
   489
\endisadelimquotett
28447
haftmann
parents:
diff changeset
   490
%
haftmann
parents:
diff changeset
   491
\begin{isamarkuptext}%
28593
f087237af65d continued codegen tutorial
haftmann
parents: 28564
diff changeset
   492
\noindent The initial bang ``\verb|!|'' tells the serialiser
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   493
  never to put
28447
haftmann
parents:
diff changeset
   494
  parentheses around the whole expression (they are already present),
haftmann
parents:
diff changeset
   495
  while the parentheses around argument place holders
haftmann
parents:
diff changeset
   496
  tell not to put parentheses around the arguments.
haftmann
parents:
diff changeset
   497
  The slash ``\verb|/|'' (followed by arbitrary white space)
haftmann
parents:
diff changeset
   498
  inserts a space which may be used as a break if necessary
haftmann
parents:
diff changeset
   499
  during pretty printing.
haftmann
parents:
diff changeset
   500
haftmann
parents:
diff changeset
   501
  These examples give a glimpse what mechanisms
haftmann
parents:
diff changeset
   502
  custom serialisations provide; however their usage
haftmann
parents:
diff changeset
   503
  requires careful thinking in order not to introduce
haftmann
parents:
diff changeset
   504
  inconsistencies -- or, in other words:
haftmann
parents:
diff changeset
   505
  custom serialisations are completely axiomatic.
haftmann
parents:
diff changeset
   506
haftmann
parents:
diff changeset
   507
  A further noteworthy details is that any special
haftmann
parents:
diff changeset
   508
  character in a custom serialisation may be quoted
haftmann
parents:
diff changeset
   509
  using ``\verb|'|''; thus, in
haftmann
parents:
diff changeset
   510
  ``\verb|fn '_ => _|'' the first
haftmann
parents:
diff changeset
   511
  ``\verb|_|'' is a proper underscore while the
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   512
  second ``\verb|_|'' is a placeholder.%
28447
haftmann
parents:
diff changeset
   513
\end{isamarkuptext}%
haftmann
parents:
diff changeset
   514
\isamarkuptrue%
haftmann
parents:
diff changeset
   515
%
haftmann
parents:
diff changeset
   516
\isamarkupsubsection{\isa{Haskell} serialisation%
haftmann
parents:
diff changeset
   517
}
haftmann
parents:
diff changeset
   518
\isamarkuptrue%
haftmann
parents:
diff changeset
   519
%
haftmann
parents:
diff changeset
   520
\begin{isamarkuptext}%
haftmann
parents:
diff changeset
   521
For convenience, the default
haftmann
parents:
diff changeset
   522
  \isa{HOL} setup for \isa{Haskell} maps the \isa{eq} class to
haftmann
parents:
diff changeset
   523
  its counterpart in \isa{Haskell}, giving custom serialisations
haftmann
parents:
diff changeset
   524
  for the class \isa{eq} (by command \hyperlink{command.code-class}{\mbox{\isa{\isacommand{code{\isacharunderscore}class}}}}) and its operation
haftmann
parents:
diff changeset
   525
  \isa{eq{\isacharunderscore}class{\isachardot}eq}%
haftmann
parents:
diff changeset
   526
\end{isamarkuptext}%
haftmann
parents:
diff changeset
   527
\isamarkuptrue%
haftmann
parents:
diff changeset
   528
%
28564
haftmann
parents: 28561
diff changeset
   529
\isadelimquotett
28447
haftmann
parents:
diff changeset
   530
%
28564
haftmann
parents: 28561
diff changeset
   531
\endisadelimquotett
28447
haftmann
parents:
diff changeset
   532
%
28564
haftmann
parents: 28561
diff changeset
   533
\isatagquotett
28447
haftmann
parents:
diff changeset
   534
\isacommand{code{\isacharunderscore}class}\isamarkupfalse%
haftmann
parents:
diff changeset
   535
\ eq\isanewline
28714
1992553cccfe improved verbatim mechanism
haftmann
parents: 28679
diff changeset
   536
\ \ {\isacharparenleft}Haskell\ {\isachardoublequoteopen}Eq{\isachardoublequoteclose}{\isacharparenright}\isanewline
28447
haftmann
parents:
diff changeset
   537
\isanewline
haftmann
parents:
diff changeset
   538
\isacommand{code{\isacharunderscore}const}\isamarkupfalse%
haftmann
parents:
diff changeset
   539
\ {\isachardoublequoteopen}op\ {\isacharequal}{\isachardoublequoteclose}\isanewline
haftmann
parents:
diff changeset
   540
\ \ {\isacharparenleft}Haskell\ \isakeyword{infixl}\ {\isadigit{4}}\ {\isachardoublequoteopen}{\isacharequal}{\isacharequal}{\isachardoublequoteclose}{\isacharparenright}%
28564
haftmann
parents: 28561
diff changeset
   541
\endisatagquotett
haftmann
parents: 28561
diff changeset
   542
{\isafoldquotett}%
28447
haftmann
parents:
diff changeset
   543
%
28564
haftmann
parents: 28561
diff changeset
   544
\isadelimquotett
28447
haftmann
parents:
diff changeset
   545
%
28564
haftmann
parents: 28561
diff changeset
   546
\endisadelimquotett
28447
haftmann
parents:
diff changeset
   547
%
haftmann
parents:
diff changeset
   548
\begin{isamarkuptext}%
haftmann
parents:
diff changeset
   549
\noindent A problem now occurs whenever a type which
haftmann
parents:
diff changeset
   550
  is an instance of \isa{eq} in \isa{HOL} is mapped
haftmann
parents:
diff changeset
   551
  on a \isa{Haskell}-built-in type which is also an instance
haftmann
parents:
diff changeset
   552
  of \isa{Haskell} \isa{Eq}:%
haftmann
parents:
diff changeset
   553
\end{isamarkuptext}%
haftmann
parents:
diff changeset
   554
\isamarkuptrue%
haftmann
parents:
diff changeset
   555
%
28564
haftmann
parents: 28561
diff changeset
   556
\isadelimquote
28447
haftmann
parents:
diff changeset
   557
%
28564
haftmann
parents: 28561
diff changeset
   558
\endisadelimquote
28447
haftmann
parents:
diff changeset
   559
%
28564
haftmann
parents: 28561
diff changeset
   560
\isatagquote
28447
haftmann
parents:
diff changeset
   561
\isacommand{typedecl}\isamarkupfalse%
haftmann
parents:
diff changeset
   562
\ bar\isanewline
haftmann
parents:
diff changeset
   563
\isanewline
haftmann
parents:
diff changeset
   564
\isacommand{instantiation}\isamarkupfalse%
haftmann
parents:
diff changeset
   565
\ bar\ {\isacharcolon}{\isacharcolon}\ eq\isanewline
haftmann
parents:
diff changeset
   566
\isakeyword{begin}\isanewline
haftmann
parents:
diff changeset
   567
\isanewline
haftmann
parents:
diff changeset
   568
\isacommand{definition}\isamarkupfalse%
haftmann
parents:
diff changeset
   569
\ {\isachardoublequoteopen}eq{\isacharunderscore}class{\isachardot}eq\ {\isacharparenleft}x{\isasymColon}bar{\isacharparenright}\ y\ {\isasymlongleftrightarrow}\ x\ {\isacharequal}\ y{\isachardoublequoteclose}\isanewline
haftmann
parents:
diff changeset
   570
\isanewline
haftmann
parents:
diff changeset
   571
\isacommand{instance}\isamarkupfalse%
haftmann
parents:
diff changeset
   572
\ \isacommand{by}\isamarkupfalse%
haftmann
parents:
diff changeset
   573
\ default\ {\isacharparenleft}simp\ add{\isacharcolon}\ eq{\isacharunderscore}bar{\isacharunderscore}def{\isacharparenright}\isanewline
haftmann
parents:
diff changeset
   574
\isanewline
haftmann
parents:
diff changeset
   575
\isacommand{end}\isamarkupfalse%
haftmann
parents:
diff changeset
   576
%
28564
haftmann
parents: 28561
diff changeset
   577
\endisatagquote
haftmann
parents: 28561
diff changeset
   578
{\isafoldquote}%
28447
haftmann
parents:
diff changeset
   579
%
28564
haftmann
parents: 28561
diff changeset
   580
\isadelimquote
28447
haftmann
parents:
diff changeset
   581
%
28564
haftmann
parents: 28561
diff changeset
   582
\endisadelimquote
28447
haftmann
parents:
diff changeset
   583
\isanewline
haftmann
parents:
diff changeset
   584
%
28564
haftmann
parents: 28561
diff changeset
   585
\isadelimquotett
28447
haftmann
parents:
diff changeset
   586
%
28564
haftmann
parents: 28561
diff changeset
   587
\endisadelimquotett
28447
haftmann
parents:
diff changeset
   588
%
28564
haftmann
parents: 28561
diff changeset
   589
\isatagquotett
28447
haftmann
parents:
diff changeset
   590
\isacommand{code{\isacharunderscore}type}\isamarkupfalse%
haftmann
parents:
diff changeset
   591
\ bar\isanewline
haftmann
parents:
diff changeset
   592
\ \ {\isacharparenleft}Haskell\ {\isachardoublequoteopen}Integer{\isachardoublequoteclose}{\isacharparenright}%
28564
haftmann
parents: 28561
diff changeset
   593
\endisatagquotett
haftmann
parents: 28561
diff changeset
   594
{\isafoldquotett}%
28447
haftmann
parents:
diff changeset
   595
%
28564
haftmann
parents: 28561
diff changeset
   596
\isadelimquotett
28447
haftmann
parents:
diff changeset
   597
%
28564
haftmann
parents: 28561
diff changeset
   598
\endisadelimquotett
28447
haftmann
parents:
diff changeset
   599
%
haftmann
parents:
diff changeset
   600
\begin{isamarkuptext}%
haftmann
parents:
diff changeset
   601
\noindent The code generator would produce
28593
f087237af65d continued codegen tutorial
haftmann
parents: 28564
diff changeset
   602
  an additional instance, which of course is rejected by the \isa{Haskell}
28447
haftmann
parents:
diff changeset
   603
  compiler.
haftmann
parents:
diff changeset
   604
  To suppress this additional instance, use
haftmann
parents:
diff changeset
   605
  \isa{code{\isacharunderscore}instance}:%
haftmann
parents:
diff changeset
   606
\end{isamarkuptext}%
haftmann
parents:
diff changeset
   607
\isamarkuptrue%
haftmann
parents:
diff changeset
   608
%
28564
haftmann
parents: 28561
diff changeset
   609
\isadelimquotett
28447
haftmann
parents:
diff changeset
   610
%
28564
haftmann
parents: 28561
diff changeset
   611
\endisadelimquotett
28447
haftmann
parents:
diff changeset
   612
%
28564
haftmann
parents: 28561
diff changeset
   613
\isatagquotett
28447
haftmann
parents:
diff changeset
   614
\isacommand{code{\isacharunderscore}instance}\isamarkupfalse%
haftmann
parents:
diff changeset
   615
\ bar\ {\isacharcolon}{\isacharcolon}\ eq\isanewline
haftmann
parents:
diff changeset
   616
\ \ {\isacharparenleft}Haskell\ {\isacharminus}{\isacharparenright}%
28564
haftmann
parents: 28561
diff changeset
   617
\endisatagquotett
haftmann
parents: 28561
diff changeset
   618
{\isafoldquotett}%
28447
haftmann
parents:
diff changeset
   619
%
28564
haftmann
parents: 28561
diff changeset
   620
\isadelimquotett
28447
haftmann
parents:
diff changeset
   621
%
28564
haftmann
parents: 28561
diff changeset
   622
\endisadelimquotett
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   623
%
28635
cc53d2ab0170 filled remaining gaps
haftmann
parents: 28609
diff changeset
   624
\isamarkupsubsection{Enhancing the target language context \label{sec:include}%
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   625
}
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   626
\isamarkuptrue%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   627
%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   628
\begin{isamarkuptext}%
28593
f087237af65d continued codegen tutorial
haftmann
parents: 28564
diff changeset
   629
In rare cases it is necessary to \emph{enrich} the context of a
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   630
  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
   631
  command:%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   632
\end{isamarkuptext}%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   633
\isamarkuptrue%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   634
%
28564
haftmann
parents: 28561
diff changeset
   635
\isadelimquotett
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   636
%
28564
haftmann
parents: 28561
diff changeset
   637
\endisadelimquotett
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   638
%
28564
haftmann
parents: 28561
diff changeset
   639
\isatagquotett
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   640
\isacommand{code{\isacharunderscore}include}\isamarkupfalse%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   641
\ Haskell\ {\isachardoublequoteopen}Errno{\isachardoublequoteclose}\isanewline
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   642
{\isacharverbatimopen}errno\ i\ {\isacharequal}\ error\ {\isacharparenleft}{\isachardoublequote}Error\ number{\isacharcolon}\ {\isachardoublequote}\ {\isacharplus}{\isacharplus}\ show\ i{\isacharparenright}{\isacharverbatimclose}\isanewline
28447
haftmann
parents:
diff changeset
   643
\isanewline
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   644
\isacommand{code{\isacharunderscore}reserved}\isamarkupfalse%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   645
\ Haskell\ Errno%
28564
haftmann
parents: 28561
diff changeset
   646
\endisatagquotett
haftmann
parents: 28561
diff changeset
   647
{\isafoldquotett}%
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   648
%
28564
haftmann
parents: 28561
diff changeset
   649
\isadelimquotett
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   650
%
28564
haftmann
parents: 28561
diff changeset
   651
\endisadelimquotett
28561
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   652
%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   653
\begin{isamarkuptext}%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   654
\noindent Such named \isa{include}s are then prepended to every generated code.
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   655
  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
   656
  with respect to a particular target language.%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   657
\end{isamarkuptext}%
056255ade52a some adaption
haftmann
parents: 28456
diff changeset
   658
\isamarkuptrue%
28447
haftmann
parents:
diff changeset
   659
%
haftmann
parents:
diff changeset
   660
\isadelimtheory
haftmann
parents:
diff changeset
   661
%
haftmann
parents:
diff changeset
   662
\endisadelimtheory
haftmann
parents:
diff changeset
   663
%
haftmann
parents:
diff changeset
   664
\isatagtheory
haftmann
parents:
diff changeset
   665
\isacommand{end}\isamarkupfalse%
haftmann
parents:
diff changeset
   666
%
haftmann
parents:
diff changeset
   667
\endisatagtheory
haftmann
parents:
diff changeset
   668
{\isafoldtheory}%
haftmann
parents:
diff changeset
   669
%
haftmann
parents:
diff changeset
   670
\isadelimtheory
haftmann
parents:
diff changeset
   671
%
haftmann
parents:
diff changeset
   672
\endisadelimtheory
haftmann
parents:
diff changeset
   673
\isanewline
haftmann
parents:
diff changeset
   674
\end{isabellebody}%
haftmann
parents:
diff changeset
   675
%%% Local Variables:
haftmann
parents:
diff changeset
   676
%%% mode: latex
haftmann
parents:
diff changeset
   677
%%% TeX-master: "root"
haftmann
parents:
diff changeset
   678
%%% End: