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