chiark - git - mdw - sod/blob - doc/sod.tex

   1 %%% -*-latex-*-
   2 %%%
   3 %%% Description of the internal class structure and protocol
   4 %%%
   5 %%% (c) 2009 Straylight/Edgeware
   6 %%%
   7
   8 %%%----- Licensing notice ---------------------------------------------------
   9 %%%
  10 %%% This file is part of the Simple Object Definition system.
  11 %%%
  12 %%% SOD is free software; you can redistribute it and/or modify
  13 %%% it under the terms of the GNU General Public License as published by
  14 %%% the Free Software Foundation; either version 2 of the License, or
  15 %%% (at your option) any later version.
  16 %%%
  17 %%% SOD is distributed in the hope that it will be useful,
  18 %%% but WITHOUT ANY WARRANTY; without even the implied warranty of
  19 %%% MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20 %%% GNU General Public License for more details.
  21 %%%
  22 %%% You should have received a copy of the GNU General Public License
  23 %%% along with SOD; if not, write to the Free Software Foundation,
  24 %%% Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  25
  26 \documentclass[noarticle, titlepage]{strayman}
  27
  28 \errorcontextlines=999
  29
  30 \usepackage[T1]{fontenc}
  31 \usepackage[utf8]{inputenc}
  32 \usepackage[palatino, helvetica, courier, maths=cmr]{mdwfonts}
  33 \usepackage{makeidx}
  34 \usepackage
  35   [columns=2, itemlayout=singlepar, justific=raggedright,
  36    totoc=true, font=small]
  37   {idxlayout}
  38 \usepackage{tikz}
  39 \usepackage{syntax}
  40 \usepackage{sverb}
  41 \usepackage{mdwtab}
  42 \usepackage[mdwmargin]{mdwthm}
  43 \usepackage{amssymb}
  44 \usepackage{footnote}
  45 \usepackage{at}
  46 \usepackage{mdwref}
  47
  48 \usepackage{sod}
  49
  50 \makeindex
  51
  52 \title{A Sensible Object Design for C}
  53 \author{Mark Wooding}
  54
  55 \begin{document}
  56
  57 \frontmatter
  58 \maketitle
  59
  60 %%%--------------------------------------------------------------------------
  61
  62 \tableofcontents
  63
  64 \mainmatter
  65
  66 %%%--------------------------------------------------------------------------
  67 \part{Tutorial} \label{p:tut}
  68
  69 \include{tutorial}
  70
  71 %%%--------------------------------------------------------------------------
  72 \part{Reference} \label{p:ref}
  73
  74 \include{refintro}
  75 \include{concepts}
  76 \include{cmdline}
  77 \include{syntax}
  78 \include{runtime}
  79 \include{structures}
  80
  81 %%%--------------------------------------------------------------------------
  82 \part{Lisp interface} \label{p:lisp}
  83
  84 \include{lispintro}
  85 %% package.lisp
  86 %% sod.asd.in
  87 %% sod-frontend.asd.in
  88 %% auto.lisp.in
  89
  90 \include{misc}
  91 %% utilities.lisp
  92 %% pset-impl.lisp
  93 %% pset-parse.lisp
  94 %% pset-proto.lisp
  95 %% optparse.lisp
  96 %% frontend.lisp
  97 %% final.lisp
  98
  99 \include{parsing}
 100 %% package.lisp
 101 %% floc-impl.lisp
 102 %% floc-proto.lisp
 103 %% streams-impl.lisp
 104 %% streams-proto.lisp
 105 %% scanner-context-impl.lisp
 106 %% scanner-impl.lisp
 107 %% scanner-proto.lisp
 108 %% scanner-token-impl.lisp
 109 %% scanner-charbuf-impl.lisp
 110 %% parser-impl.lisp
 111 %% parser-proto.lisp
 112 %% parser-expr-impl.lisp
 113 %% parser-expr-proto.lisp
 114 %% lexer-impl.lisp
 115 %% lexer-proto.lisp
 116
 117 \include{clang}
 118 %% c-types-class-impl.lisp
 119 %% c-types-impl.lisp
 120 %% c-types-parse.lisp
 121 %% c-types-proto.lisp
 122 %% codegen-impl.lisp
 123 %% codegen-proto.lisp
 124 %% fragment-parse.lisp
 125
 126 \include{meta}
 127 %% classes.lisp
 128 %% class-utilities.lisp
 129 %% class-make-impl.lisp
 130 %% class-make-proto.lisp
 131 %% class-finalize-impl.lisp
 132 %% class-finalize-proto.lisp
 133
 134 \include{layout}
 135 %% class-layout-impl.lisp
 136 %% class-layout-proto.lisp
 137 %% method-impl.lisp
 138 %% method-proto.lisp
 139 %% method-aggregate.lisp
 140
 141 \include{module}
 142 %% module-impl.lisp
 143 %% module-parse.lisp
 144 %% module-proto.lisp
 145 %% builtin.lisp
 146
 147 \include{output}
 148 %% output-impl.lisp
 149 %% output-proto.lisp
 150 %% class-output.lisp
 151 %% module-output.lisp
 152
 153 %%%--------------------------------------------------------------------------
 154 \part{Appendices}
 155 \appendix
 156
 157 \include{cutting-room-floor}
 158
 159 %%%--------------------------------------------------------------------------
 160 \backmatter
 161
 162 \printindex
 163
 164 %%%----- That's all, folks --------------------------------------------------
 165 \end{document}
 166
 167 %%% Local variables:
 168 %%% mode: LaTeX
 169 %%% TeX-PDF-mode: t
 170 %%% End: