5 %%% (c) 2015 Straylight/Edgeware
8 %%%----- Licensing notice ---------------------------------------------------
10 %%% This file is part of the Sensible Object Design, an object system for C.
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.
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.
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.
26 \chapter{Modules
} \label{ch:module
}
28 %%%--------------------------------------------------------------------------
30 \begin{describe
}{fun
}{add-module-binding @<symbol> @<thunk>
}
33 \begin{describe
}{mac
}{define-module-var @<name> @<value-form> @<doc-string>
}
37 {with-module-environment (@
[@<module>@
]) @<declaration>^* @<form>^*
}
40 \begin{describe
}{fun
}{add-clear-the-decks-function @<symbol> @<thunk>
}
44 {define-clear-the-decks @<symbol>
45 @
[[ @<declaration>^* @! @<doc-string> @
]]
49 \begin{describe
}{fun
}{clear-the-decks
}
54 \&key :name :pset :items :files :dependencies :variables :state
}
58 {\dhead{gf
}{module-name @<module> @> @<pathname>
}
59 \dhead{gf
}{module-pset @<module> @> @<pset>
}
60 \dhead{gf
}{module-errors @<module> @> @<integer>
}
61 \dhead{gf
}{module-items @<module> @> @<list>
}
62 \dhead{gf
}{setf (module-items @<module>) @<list>
}
63 \dhead{gf
}{module-files @<module> @> @<list>
}
64 \dhead{gf
}{setf (module-files @<module>) @<list>
}
65 \dhead{gf
}{module-dependencies @<module> @> @<list>
}
66 \dhead{gf
}{setf (module-dependencies @<module>) @<list>
}
67 \dhead{gf
}{module-state @<module> @> @<symbol>
}
68 \dhead{gf
}{setf (module-state @<module>) @<keyword>
}}
71 \begin{describe
}{var
}{*module*
}
74 \begin{describe
}{gf
}{module-import @<object>
}
77 \begin{describe
}{gf
}{add-to-module @<module> @<item>
}
80 \begin{describe
}{gf
}{finalize-module @<module>
}
85 (@<name> @
[[ :truename @<pathname> @! :location @<floc> @
]])
91 \begin{describe
}{mac
}{with-temporary-module () @<declaration>^* @<body>^*
}
94 \begin{describe
}{cls
}{type-item () \&key :name
}
98 {code-fragment-item () \&key :fragment :reason :name :constraints
}
102 {\dhead{gf
}{code-fragment @<fragment-item> @> @<fragment>
}
103 \dhead{gf
}{code-fragment-name @<fragment-item> @> @<name>
}
104 \dhead{gf
}{code-fragment-reason @<fragment-item> @> @<keyword>
}
105 \dhead{gf
}{code-fragment-constraints @<fragment-item> @> @<list>
}}
108 \begin{describe
}{var
}{*module-dirs*
}
111 \begin{describe
}{fun
}{find-file @<home> @<name> @<what> @<thunk>
}
114 \begin{describe
}{fun
}
115 {read-module @<pathname> \&key :truename :location @> @<module>
}
118 \begin{describe
}{plug
}{module @<scanner> @<pset>
}
121 \begin{describe
}{plug
}{class-item @<scanner> @<class> @<pset>
}
124 \begin{describe
}{var
}{*builtin-module*
}
127 \begin{describe
}{fun
}{make-builtin-module @> @<module>
}
130 %%%----- That's all, folks --------------------------------------------------
134 %%% TeX-master: "sod.tex"