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