mdw@git.distorted.org.uk Git - sod/blob - doc/module.tex

   1 %%% -*-latex-*-
   2 %%%
   3 %%% Modules
   4 %%%
   5 %%% (c) 2015 Straylight/Edgeware
   6 %%%
   7
   8 %%%----- Licensing notice ---------------------------------------------------
   9 %%%
  10 %%% This file is part of the Sensible Object Design, an object system for C.
  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 \chapter{Modules} \label{ch:module}
  27
  28 %%%--------------------------------------------------------------------------
  29
  30 \begin{describe}{fun}{add-module-binding @<symbol> @<thunk>}
  31 \end{describe}
  32
  33 \begin{describe}{mac}{define-module-var @<name> @<value-form> @<doc-string>}
  34 \end{describe}
  35
  36 \begin{describe}{mac}
  37     {with-module-environment (@[@<module>@]) @<declaration>^* @<form>^*}
  38 \end{describe}
  39
  40 \begin{describe}{fun}{add-clear-the-decks-function @<symbol> @<thunk>}
  41 \end{describe}
  42
  43 \begin{describe}{mac}
  44   {define-clear-the-decks @<symbol>
  45     @[[ @<declaration>^* @! @<doc-string> @]]
  46     @<form>^*}
  47 \end{describe}
  48
  49 \begin{describe}{fun}{clear-the-decks}
  50 \end{describe}
  51
  52 \begin{describe}{cls}
  53     {module ()
  54       \&key :name :pset :items :files :dependencies :variables :state}
  55 \end{describe}
  56
  57 \begin{describe*}
  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>}}
  69 \end{describe*}
  70
  71 \begin{describe}{var}{*module*}
  72 \end{describe}
  73
  74 \begin{describe}{gf}{module-import @<object>}
  75 \end{describe}
  76
  77 \begin{describe}{gf}{add-to-module @<module> @<item>}
  78 \end{describe}
  79
  80 \begin{describe}{gf}{finalize-module @<module>}
  81 \end{describe}
  82
  83 \begin{describe}{mac}
  84     {define-module
  85         (@<name> @[[ :truename @<pathname> @! :location @<floc> @]])
  86       @<declaration>^*
  87       @<form>^*
  88      \nlret @<module>}
  89 \end{describe}
  90
  91 \begin{describe}{mac}{with-temporary-module () @<declaration>^* @<body>^*}
  92 \end{describe}
  93
  94 \begin{describe}{cls}{type-item () \&key :name}
  95 \end{describe}
  96
  97 \begin{describe}{cls}
  98     {code-fragment-item () \&key :fragment :reason :name :constraints}
  99 \end{describe}
 100
 101 \begin{describe*}
 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>}}
 106 \end{describe*}
 107
 108 \begin{describe}{var}{*module-dirs*}
 109 \end{describe}
 110
 111 \begin{describe}{fun}{find-file @<home> @<name> @<what> @<thunk>}
 112 \end{describe}
 113
 114 \begin{describe}{fun}
 115     {read-module @<pathname> \&key :truename :location @> @<module>}
 116 \end{describe}
 117
 118 \begin{describe}{plug}{module @<scanner> @<pset>}
 119 \end{describe}
 120
 121 \begin{describe}{plug}{class-item @<scanner> @<class> @<pset>}
 122 \end{describe}
 123
 124 \begin{describe}{var}{*builtin-module*}
 125 \end{describe}
 126
 127 \begin{describe}{fun}{make-builtin-module @> @<module>}
 128 \end{describe}
 129
 130 %%%----- That's all, folks --------------------------------------------------
 131
 132 %%% Local variables:
 133 %%% mode: LaTeX
 134 %%% TeX-master: "sod.tex"
 135 %%% TeX-PDF-mode: t
 136 %%% End: