Long pending doc updates

git-svn-id: svn://svn.code.sf.net/p/sc2/code/trunk@1893 8092fc87-c524-0410-9efc-e669fe64eaf9
This commit is contained in:
avolkov
2005-10-11 09:49:53 +00:00
parent cc24b2d3f0
commit 919d4ffb4c
+17 -7
View File
@@ -1,12 +1,12 @@
UQM Dynamically Loadable Executable Code Payload Plug-in Module UQM Code DataPlate modules
(did I miss any terms? :)
===================================================================== =====================================================================
Terminology: Terminology:
------------ ------------
adlm Addon Dynamically Loadable Module cdp Code DataPlate
(official name to be agreed upon) refers to either a module or the architecture
itself;
module ditto ^ module cdp module (ditto ^)
interface a set of functions defined by either the core interface a set of functions defined by either the core
engine or a module aimed at performing various engine or a module aimed at performing various
@@ -57,8 +57,18 @@ vtbl virtual table; a table of interface functions;
pointer to vtbl is semantically equivalent to pointer to vtbl is semantically equivalent to
an interface pointer an interface pointer
event a bindable point in code of the engine or any
module; event observer recieves event
notifications via event handlers it installs
h_foo handle to 'foo' h_foo handle to 'foo'
plate cdp module
fork interface; something to poke a plate with
spoon event;
"hit the plate with a spoon" == "notify via
event handler"
Typical calling sequence: Typical calling sequence:
------------------------- -------------------------
@@ -112,8 +122,8 @@ Typical calling sequence:
11) the_mod.module_term() calls host_itf->UnregisterItf(h_itf) to 11) the_mod.module_term() calls host_itf->UnregisterItf(h_itf) to
unregister the interfaces it had exposed previously; then it unregister the interfaces it had exposed previously; then it
unregisters any other objects it registered, releases all objects unregisters any other objects it registered, releases all objects
it acquired through interfaces and (sometimes) destroys the objects it acquired through interfaces and destroys any objects it is
it created; responsible for;
12) the_mod.module_term() performs internal cleanup; 12) the_mod.module_term() performs internal cleanup;