5 %%% (c) 2015 Straylight/Edgeware
8 %%%----- Licensing notice ---------------------------------------------------
10 %%% This file is part of the Sensble 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> @
]]
50 {module () \&key :name :pset :items :dependencies :variables :state
}
54 {\dhead{gf
}{module-name @<module> @> @<pathname>
}
55 \dhead{gf
}{module-pset @<module> @> @<pset>
}
56 \dhead{gf
}{module-items @<module> @> @<list>
}
57 \dhead{gf
}{module-dependencies @<module> @> @<list>
}
58 \dhead{gf
}{module-state @<module> @> @<keyword>
}}
61 \begin{describe
}{var
}{*module*
}
64 \begin{describe
}{gf
}{module-import @<object>
}
67 \begin{describe
}{gf
}{add-to-module @<module> @<item>
}
70 \begin{describe
}{gf
}{finalize-module @<module>
}
75 (@<name> @
[[ :truename @<pathname> @! :location @<floc> @
]])
81 \begin{describe
}{mac
}{with-temporary-module () @<declaration>^* @<body>^*
}
84 \begin{describe
}{cls
}{type-item () \&key :name
}
88 {code-fragment-item () \&key :fragment :reason :name :constraints
}
92 {\dhead{gf
}{code-fragment @<fragment-item> @> @<fragment>
}
93 \dhead{gf
}{code-fragment-name @<fragment-item> @> @<name>
}
94 \dhead{gf
}{code-fragment-reason @<fragment-item> @> @<keyword>
}
95 \dhead{gf
}{code-fragment-constraints @<fragment-item> @> @<list>
}}
98 \begin{describe
}{var
}{*module-dirs*
}
101 \begin{describe
}{fun
}{find-file @<scanner> @<name> @<what> @<thunk>
}
104 \begin{describe
}{fun
}
105 {read-module @<pathname> \&key :truename :location @> @<module>
}
108 \begin{describe
}{plug
}{module @<scanner> @<pset>
}
111 \begin{describe
}{plug
}{class-item @<scanner> @<class> @<pset>
}
114 \begin{describe
}{var
}{*builtin-module*
}
117 \begin{describe
}{fun
}{make-builtin-module @> @<module>
}
120 %%%----- That's all, folks --------------------------------------------------
124 %%% TeX-master: "sod.tex"