chiark / gitweb /
b2707f6f3dcf4ff6bf950ad0f9bcaeb043752895
[sod] / 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 \usetikzlibrary{calc}
40 \usetikzlibrary{positioning}
41 \usepackage{syntax}
42 \usepackage{sverb}
43 \usepackage{mdwtab}
44 \usepackage[mdwmargin]{mdwthm}
45 \usepackage{amssymb}
46 \usepackage{footnote}
47 \usepackage{at}
48 \usepackage{mdwref}
49
50 \usepackage{sod}
51
52 \makeindex
53
54 \title{A Sensible Object Design for C}
55 \author{Mark Wooding}
56
57 \begin{document}
58
59 \frontmatter
60 \maketitle
61
62 %%%--------------------------------------------------------------------------
63
64 \tableofcontents
65
66 \mainmatter
67
68 %%%--------------------------------------------------------------------------
69 \part{Tutorial} \label{p:tut}
70
71 \include{tutorial}
72
73 %%%--------------------------------------------------------------------------
74 \part{Reference} \label{p:ref}
75
76 \include{refintro}
77 \include{concepts}
78 \include{cmdline}
79 \include{syntax}
80 \include{runtime}
81 \include{structures}
82
83 %%%--------------------------------------------------------------------------
84 \part{Lisp interface} \label{p:lisp}
85
86 \include{lispintro}
87 %% package.lisp
88 %% sod.asd.in
89 %% sod-frontend.asd.in
90 %% auto.lisp.in
91
92 \include{misc}
93 %% utilities.lisp
94 %% pset-impl.lisp
95 %% pset-parse.lisp
96 %% pset-proto.lisp
97 %% optparse.lisp
98 %% frontend.lisp
99 %% final.lisp
100
101 \include{parsing}
102 %% package.lisp
103 %% floc-impl.lisp
104 %% floc-proto.lisp
105 %% streams-impl.lisp
106 %% streams-proto.lisp
107 %% scanner-context-impl.lisp
108 %% scanner-impl.lisp
109 %% scanner-proto.lisp
110 %% scanner-token-impl.lisp
111 %% scanner-charbuf-impl.lisp
112 %% parser-impl.lisp
113 %% parser-proto.lisp
114 %% parser-expr-impl.lisp
115 %% parser-expr-proto.lisp
116 %% lexer-impl.lisp
117 %% lexer-proto.lisp
118
119 \include{clang}
120 %% c-types-class-impl.lisp
121 %% c-types-impl.lisp
122 %% c-types-parse.lisp
123 %% c-types-proto.lisp
124 %% codegen-impl.lisp
125 %% codegen-proto.lisp
126 %% fragment-parse.lisp
127
128 \include{meta}
129 %% classes.lisp
130 %% class-utilities.lisp
131 %% class-make-impl.lisp
132 %% class-make-proto.lisp
133 %% class-finalize-impl.lisp
134 %% class-finalize-proto.lisp
135
136 \include{layout}
137 %% class-layout-impl.lisp
138 %% class-layout-proto.lisp
139 %% method-impl.lisp
140 %% method-proto.lisp
141 %% method-aggregate.lisp
142
143 \include{module}
144 %% module-impl.lisp
145 %% module-parse.lisp
146 %% module-proto.lisp
147 %% builtin.lisp
148
149 \include{output}
150 %% output-impl.lisp
151 %% output-proto.lisp
152 %% class-output.lisp
153 %% module-output.lisp
154
155 %%%--------------------------------------------------------------------------
156 \part{Appendices}
157 \appendix
158
159 \include{cutting-room-floor}
160
161 %%%--------------------------------------------------------------------------
162 \backmatter
163
164 \printindex
165
166 %%%----- That's all, folks --------------------------------------------------
167 \end{document}
168
169 %%% Local variables:
170 %%% mode: LaTeX
171 %%% TeX-PDF-mode: t
172 %%% End: