From 919d4ffb4c962b86f69d0c1d8f1e783d5b150f00 Mon Sep 17 00:00:00 2001 From: avolkov Date: Tue, 11 Oct 2005 09:49:53 +0000 Subject: [PATCH] Long pending doc updates git-svn-id: svn://svn.code.sf.net/p/sc2/code/trunk@1893 8092fc87-c524-0410-9efc-e669fe64eaf9 --- sc2/doc/devel/plugins | 24 +++++++++++++++++------- 1 file changed, 17 insertions(+), 7 deletions(-) diff --git a/sc2/doc/devel/plugins b/sc2/doc/devel/plugins index e81b8410d..505d7d117 100644 --- a/sc2/doc/devel/plugins +++ b/sc2/doc/devel/plugins @@ -1,12 +1,12 @@ -UQM Dynamically Loadable Executable Code Payload Plug-in Module -(did I miss any terms? :) +UQM Code DataPlate modules ===================================================================== Terminology: ------------ -adlm Addon Dynamically Loadable Module - (official name to be agreed upon) +cdp Code DataPlate + 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 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 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' +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: ------------------------- @@ -112,8 +122,8 @@ Typical calling sequence: 11) the_mod.module_term() calls host_itf->UnregisterItf(h_itf) to unregister the interfaces it had exposed previously; then it unregisters any other objects it registered, releases all objects - it acquired through interfaces and (sometimes) destroys the objects - it created; + it acquired through interfaces and destroys any objects it is + responsible for; 12) the_mod.module_term() performs internal cleanup;