home *** CD-ROM | disk | FTP | other *** search
/ Acorn User 2 / AUCD2.iso / internet / acornet.spk / !Acornet / Utils / !NetConfig / Docs / Library < prev    next >
Text File  |  1995-06-11  |  1KB  |  41 lines
  1. The library system
  2. ==================
  3.  
  4. It's a sort of dynamically-loaded library system.  It may not be wonderfully
  5. efficient, but its intended application (Internet software installation and
  6. configuration) doesn't need to be.
  7.  
  8. [Substitute 'foo' with the real name of a library module]
  9.  
  10. Routines provided:
  11.   PROClibrary(lib$)
  12.   FNlibp(lib$)
  13.  
  14. Naming
  15. ------
  16.  
  17. All functions, procedures and non-local variables should begin with "foo_" or
  18. "_foo_" (the convention is that private functions etc. have the initial
  19. underscore, though I haven't always followed this in the case of variables).
  20.  
  21. Loading
  22. -------
  23.  
  24. Call PROClibrary("foo") to ensure that library foo is loaded.  This can be
  25. done at any time, not just at initialiation.  If a library is already loaded
  26. then nothing further is done.  Library files are located from the path$
  27. specified in the initial call to PROCcore_init(path$).
  28.  
  29. Testing presence of library
  30. ---------------------------
  31.  
  32. To test if a library foo is loaded, call the function FNlibp("foo").
  33.  
  34. Initialisation
  35. --------------
  36.  
  37. A library module 'foo' must provide an initialisation function FNfoo_init
  38. which is called when the library is first loaded.  This may be a suitable
  39. place to initialise variables and to load other libraries needed by the
  40. module.  The return value of the function is ignored.
  41.