clqr-compiler.tex

   1 % Copyright (C) 2008 Bert Burgemeister
   2 %
   3 % Permission is granted to copy, distribute and/or modify this
   4 % document under the terms of the GNU Free Documentation License,
   5 % Version 1.2 or any later version published by the Free Software
   6 % Foundation; with no Invariant Sections, no Front-Cover Texts and
   7 % no Back-Cover Texts. For details see file COPYING.
   8 %
   9
  10 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  11 \section{Compiler}
  12 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  13
  14 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  15 \subsection{Predicates}
  16 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  17
  18 \begin{LIST}{1cm}
  19
  20   \IT{(\FU*{SPECIAL-OPERATOR-P} \VAR{foo})}
  21   {
  22   \retval{\T} if \VAR{foo} is a special operator.
  23   }
  24
  25   \IT{(\FU*{COMPILED-FUNCTION-P} \VAR{foo})}
  26   {
  27   \retval{\T} if \VAR{foo} is of type \kwd{compiled-function}.
  28   }
  29
  30 \end{LIST}
  31
  32
  33 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  34 \subsection{Compilation}
  35 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
  36
  37 \begin{LIST}{1cm}
  38
  39   \IT{(\FU*{COMPILE}
  40     \xorGOO{\NIL\\
  41       \VAR{name}}{\}}
  42     \Op{\VAR{definition}})}
  43   {
  44   Return \retval{compiled function} or replace \retval{\VAR{name}}'s
  45   function definition with the compiled function. Return \retvalii{\T} in case
  46   of warnings or errors, and \retvaliii{\T} in case of warnings
  47   or errors excluding style warnings.
  48   }
  49
  50   \IT{(\FU*{COMPILE-FILE} \VAR{file}
  51     \orGOO{\kwd{:output-file}\VAR{ out-path}\\
  52       \kwd{:verbose} \VAR{ bool}\DF{\V{\A compile-verbose\A}}\\
  53       \kwd{:print}\VAR{ bool}\DF{\V{\A compile-print\A}}\\
  54       \kwd{:external-format} \VAR{
  55         file-format}\DF{\kwd{:default}}}{\}})}
  56   {
  57   Write compiled contents of \VAR{file} to \VAR{out-path}.
  58   Return \retval{true output path} or \retval{\NIL}, \retvalii{\T}
  59   in case of warnings or errors, \retvaliii{\T} in case of warnings
  60   or errors excluding style warnings.
  61   }
  62
  63   \IT{\arrGOO{\V*{\A compile-file-pathname\A}\DF{\NIL}\\
  64       \V*{\A compile-file-truename\A}\DF{\NIL}}{.}}
  65   {
  66   Input file used by \FU{compile-file}.
  67   }
  68
  69   \IT{\arrGOO{\V*{\A compile-print\A}\\
  70       \V*{\A compile-verbose\A}}{.}}
  71   {
  72   Defaults used in \FU{compile-file}.
  73   }
  74
  75   \IT{(\FU*{COMPILE-FILE-PATHNAME} \VAR{file} \Op{\kwd{:output-file}
  76       \VAR{path}} \Op{\VAR{other-keyargs}})}
  77   {
  78   \retval{Pathname} \FU{COMPILE-FILE} writes to if invoked with the
  79   same arguments.
  80   }
  81
  82   \IT{(\FU*{LOAD} \VAR{path}
  83     \orGOO{\kwd{:verbose} \VAR{ bool}\DF{\V{\A load-verbose\A}}\\
  84       \kwd{:print} \VAR{ bool}\DF{\V{\A load-print\A}}\\
  85       \kwd{:if-does-not-exist} \VAR{ bool}\DF{\T}\\
  86       \kwd{:external-format} \VAR{
  87         file-format}\DF{\kwd{:default}}}{\}})}
  88   {
  89   Load source file or compiled file into Lisp environment. Return
  90   \retval{\T} if successful.
  91   }
  92
  93   \IT{\arrGOO{\V*{\A load-pathname\A}\DF{\NIL}\\
  94       \V*{\A load-truename\A}\DF{\NIL}}{.}}
  95   {
  96   Input file used by \FU{load}.
  97   }
  98
  99   \IT{\arrGOO{\V*{\A load-print\A}\DF{\NIL}\\
 100       \V*{\A load-verbose\A}}{.}}
 101   {
 102   Defaults used in \FU{load}.
 103   }
 104
 105   \IT{(\SO*{EVAL-WHEN} (%
 106     \orGOO{\Goo{\kwd{:compile-toplevel}\XOR\kwd{compile}}\\
 107       \Goo{\kwd{:load-toplevel}\XOR\kwd{load}}\\
 108       \Goo{\kwd{:execute}\XOR\kwd{eval}}}{\}}) \PROGN{\VAR{form}})}
 109   {
 110   Return \retval{values of \VAR{form}s} if
 111   \SO{EVAL-WHEN} is in the top-level of a file being compiled, in the
 112   top-level of a compiled file being loaded, or anywhere,
 113   respectively. (\kwd{compile}, \kwd{load} and \kwd{eval} deprecated.)
 114   }
 115
 116   \IT{(\MC*{WITH-COMPILATION-UNIT} (\Op{\kwd{:override}
 117       \VAR{bool}\DF{\NIL}}) \PROGN{\VAR{form}})}
 118   {
 119   Return \retval{values of \VAR{form}s}. Warnings deferred by the
 120   compiler until end of compilation are deferred until the end of
 121   evaluation of \VAR{form}s.
 122   }
 123
 124   \IT{(\SO*{LOAD-TIME-VALUE} \VAR{form}
 125     \Op{\VAR{read-only}\DF{\NIL}})}
 126   {
 127   Evaluate \VAR{form} at compile time and treat \retval{its value} as
 128   literal at run time.
 129   }
 130
 131   \IT{(\SO*{QUOTE} \VAR{foo})}
 132   {
 133   Return \retval{unevaluated \VAR{foo}}.
 134   }
 135
 136   \IT{(\GFU*{MAKE-LOAD-FORM} \VAR{foo} \Op{\VAR{environment}})}
 137   {
 138   Its methods are to return a \retval{creation form} which on
 139   evaluation at \FU{load} time returns an object equivalent to
 140   \VAR{foo}, and an optional \retvalii{initialization form} which on
 141   evaluation performs some initialization of the object.
 142   }
 143
 144   \IT{(\FU*{MAKE-LOAD-FORM-SAVING-SLOTS} \VAR{foo}
 145     \orGOO{\kwd{:slot-names} \VAR{ slots}\\
 146       \kwd{:environment}  \VAR{ environment}}{\}})}
 147   {
 148   Return a \retval{creation form} and an \retvalii{initialization
 149     form} which on evaluation construct an object equivalent to
 150   \VAR{foo} with \VAR{slots} initialized with the corresponding values
 151   from \VAR{foo}.
 152   }
 153
 154   \IT{\arrGOO{(\FU*{MACRO-FUNCTION} \VAR{ symbol }
 155       \Op{\VAR{environment}})\\
 156       (\FU*{COMPILER-MACRO-FUNCTION} \VAR{ name }
 157       \Op{\VAR{environment}})}{.}}
 158   {
 159   Return specified \retval{macro function}, or \retval{compiler mac\-ro
 160     func\-tion}, respectively, if any. Return \retval{\NIL}
 161   otherwise. \kwd{setf}able.
 162   }
 163
 164   \IT{(\FU*{EVAL} \VAR{form})}
 165   {
 166   Return \retval{values of \VAR{form}}.
 167   }
 168
 169 \end{LIST}
 170
 171
 172 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 173 \subsection[REPL~\&~Debug]{REPL and Debugging}
 174 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 175
 176 \begin{LIST}{1cm}
 177
 178   \IT{\arrGOO{\V*{+}\XOR\V*{++}\XOR\V*{+++}\\[1pt]
 179       \V*{\A}\text{ }\XOR\text{ }\V*{\A\A}\text{ }\XOR\text{ }\V*{\A\A\A}\\[1pt]
 180       \V*{/}\text{ }\XOR\text{ }\V*{//}\text{ }\XOR\text{ }\V*{///}}{.}}
 181   {
 182   Last, penultimate, or antepenultimate \retval{form} evaluated in the REPL, or
 183   their respective \retval{primary value}, or a \retval{list} of their respective
 184   values.
 185   }
 186
 187   \IT{\V*{--}}
 188   {
 189   \retval{Form} currently being evaluated by the REPL.
 190   }
 191
 192   \IT{(\FU*{APROPOS} \VAR{string} \OPn{\VAR{package}})}
 193   {
 194   Print interned symbols containing \VAR{string}.
 195   }
 196
 197   \IT{(\FU*{APROPOS-LIST} \VAR{string} \OPn{\VAR{package}})}
 198   {
 199   \retval{List of interned symbols} containing \VAR{string}.
 200   }
 201
 202   \IT{(\FU*{DRIBBLE} \Op{\VAR{path}})}
 203   {
 204   Save a record of interactive session to file at \VAR{path}. Without
 205   \VAR{path}, close that file.
 206   }
 207
 208   \IT{(\FU*{ED} \Op{\VAR{file-or-function}\DF{\NIL}})}
 209   {
 210   Invoke editor if possible.
 211   }
 212
 213   \IT{(\xorGOO{\FU*{MACROEXPAND-1}\\
 214       \FU*{MACROEXPAND}}{\}} \VAR{form} \Op{\VAR{environment}})}
 215   {
 216   Return \retval{macro expansion}, once or entirely, respectively, of
 217   \VAR{form} and \retvalii{\T} if \VAR{form} is a macro form.
 218   Return \retval{\VAR{form}} and \retvalii{\NIL} otherwise.
 219   }
 220
 221   \IT{\V*{\A macroexpand-hook\A}}
 222   {
 223   Function called by \FU{macroexpand-1} to generate macro expansions.
 224   }
 225
 226   \IT{(\MC*{TRACE} \OPn{\VAR{function}})}
 227   {
 228   Cause \VAR{function}s to be traced. With no arguments,
 229   return \retval{list of traced functions}.
 230   }
 231
 232   \IT{(\MC*{UNTRACE} \OPn{\VAR{function}})}
 233   {
 234   Stop \VAR{function}s, or each currently traced function, from being
 235   traced.
 236   }
 237
 238   \IT{\V*{\A trace-output\A}}
 239   {
 240   Stream \MC{trace} and \MC{time} print their output on.
 241   }
 242
 243   \IT{(\MC*{STEP} \VAR{form})}
 244   {
 245   Step through evaluation of \VAR{form}. Return \retval{values of
 246     \VAR{form}}.
 247   }
 248
 249   \IT{(\FU*{BREAK} \Op{\VAR{control} \OPn{\VAR{arg}}})}
 250   {
 251   Jump directly into debugger; return \retval{\NIL}.
 252   See p.\ \pageref{section:Format}, \FU{format}, for \VAR{control}
 253   and \VAR{arg}s.
 254   }
 255
 256   \IT{(\MC*{TIME} \VAR{form})}
 257   {
 258   Evaluate \VAR{form}s and print timing information to
 259   \V{\A trace-output\A}. Return \retval{values of \VAR{form}s}.
 260   }
 261   \IT{(\FU*{INSPECT} \VAR{foo})}
 262   {
 263     Interactively give information about \VAR{foo}.
 264   }
 265
 266   \IT{(\FU*{DESCRIBE} \VAR{foo}
 267     \Op{\DES{\VAR{stream}}\DF{\V{\A standard-output\A}}})}
 268   {
 269   Send information about \VAR{foo} to \VAR{stream}.
 270   }
 271
 272   \IT{(\GFU*{DESCRIBE-OBJECT} \VAR{foo} \Op{\DES{\VAR{stream}}})}
 273   {
 274   Send information about \VAR{foo} to \VAR{stream}. Not to be
 275   called by user.
 276   }
 277
 278   \IT{(\FU*{DISASSEMBLE} \VAR{function})}
 279   {
 280   Send disassembled representation of \VAR{function} to
 281   \V{\A standard-output\A}. Return \retval{\NIL}.
 282   }
 283
 284 \end{LIST}
 285
 286
 287 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 288 \subsection{Declarations}
 289 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
 290 \begin{LIST}{1cm}
 291
 292   \IT{\arrGOO{(\FU*{PROCLAIM} \VAR{ decl})\\
 293       (\MC*{DECLAIM } \OPn{\NEV{\VAR{decl}}})}{.}}
 294   {
 295   Globally make declaration(s) \VAR{decl}. \VAR{decl} can be:
 296   \kwd{declaration},
 297   \kwd{type},
 298   \kwd{ftype},
 299   \kwd{inline},
 300   \kwd{notinline},
 301   \kwd{optimize}, or
 302   \kwd{special}.
 303   See below.
 304   }
 305
 306   \IT{(\kwd*{DECLARE} \OPn{\NEV{\VAR{decl}}})}
 307   {
 308   Inside certain forms, locally make declarations \VAR{decl}. \VAR{decl} can be:
 309   \kwd{dynamic-extent},
 310   \kwd{type},
 311   \kwd{ftype},
 312   \kwd{ignorable},
 313   \kwd{ignore},
 314   \kwd{inline},
 315   \kwd{notinline},
 316   \kwd{optimize}, or
 317   \kwd{special}.
 318   See below.
 319   }
 320
 321   \begin{LIST}{.5cm}
 322
 323     \IT{(\kwd*{DECLARATION} \OPn{foo})}
 324     {
 325     Make \VAR{foo}s names of declarations.
 326    }
 327
 328     \IT{(\kwd*{DYNAMIC-EXTENT} \OPn{\VAR{variable}} \OPn{(\kwd{function}
 329         \VAR{function})})}
 330     {
 331     Declare lifetime of \VAR{variable}s and/or \VAR{function}s to end
 332     when control leaves enclosing block.
 333   }
 334
 335
 336     \IT{\arrGOO{(\kwd*{TYPE} \VAR{ type} \OPn{\VAR{ variable}})\\
 337         (\kwd*{FTYPE} \VAR{ type} \OPn{\VAR{ function}})}{.}}
 338     {
 339     Declare \VAR{variable}s or \VAR{function}s to be of \VAR{type}.
 340   }
 341
 342     \IT{(\xorGOO{\kwd*{IGNORABLE}\\
 343         \kwd*{IGNORE}}{\}}
 344       \xorGOO{%
 345         \VAR{var}\\
 346         (\kwd{function} \VAR{ function})}{\}^{\!\!*}})}
 347     {
 348     Suppress warnings about used/unused bindings.
 349   }
 350
 351     \IT{\arrGOO{(\kwd*{INLINE} \OPn{\VAR{ function}})\\
 352         (\kwd*{NOTINLINE} \OPn{\VAR{ function}})}{.}}
 353     {
 354     Tell compiler to integrate/not to integrate, respectively, called
 355     \VAR{function}s into the calling routine.
 356   }
 357
 358     \IT{(\kwd*{OPTIMIZE} \orGOO{%
 359         \kwd*{COMPILATION-SPEED}\XOR(\kwd*{COMPILATION-SPEED}\VAR{ n})\\
 360         \kwd*{DEBUG}\XOR(\kwd*{DEBUG}\VAR{ n})\\
 361         \kwd*{SAFETY}\XOR(\kwd*{SAFETY}\VAR{ n})\\
 362         \kwd*{SPACE}\XOR(\kwd*{SPACE}\VAR{ n})\\
 363         \kwd*{SPEED}\XOR(\kwd*{SPEED}\VAR{ n})}{\}})}
 364     {
 365     Tell compiler how to optimize. $n=0$ means unimportant, $n=1$ is
 366     neutral, $n=3$ means important.
 367   }
 368
 369     \IT{(\kwd*{SPECIAL} \OPn{\VAR{var}})}
 370     {
 371     Declare \VAR{var}s being dynamic.
 372   }
 373
 374   \end{LIST}
 375 \end{LIST}
 376
 377
 378
 379
 380 % LocalWords:  mac ro func tion