Changeset 34256 in project


Ignore:
Timestamp:
08/06/17 16:54:36 (2 months ago)
Author:
sjamaan
Message:

man/5: Move docs on provide and require to Module (chicken load)

Location:
wiki/man/5
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • wiki/man/5/Module (chicken load)

    r34052 r34256  
    88[[Module scheme]]; the {{chicken load}} module only contains
    99''extensions'' to the standard.
     10
     11=== A note on loading of shared extension libraries
     12
     13The functionality of loading shared objects into the runtime is only
     14available on platforms that support dynamic loading of compiled
     15code. Currently Linux, BSD, Solaris, Windows (with Cygwin) and HP/UX
     16are supported.  Loading source files works everywhere.
    1017
    1118=== load-relative
     
    6673
    6774
     75=== require
     76
     77<procedure>(require ID ...)</procedure>
     78
     79If any of the named extension libraries {{ID}} are not already loaded
     80into the system, then {{require}} will look up the location of the
     81shared extension library and load it.  If {{ID}} names a library-unit
     82of the base system, then it is loaded via {{load-library}}. If no
     83extension library is available for the given ID, then an attempt is
     84made to load the file {{ID.so}} or {{ID.scm}} (in that order) from one
     85of the following locations:
     86
     87* the current directory
     88* the current repository path (see {{repository-path}})
     89
     90Each {{ID}} should be a symbol.
     91
     92
     93=== provide
     94
     95<procedure>(provide ID ...)</procedure>
     96
     97Registers the extension IDs {{ID ...}} as loaded. This is mainly
     98intended to provide aliases for certain library identifiers.
     99
     100
     101=== provided?
     102
     103procedure: (provided? ID ...)
     104
     105Returns {{#t}} if extension with the IDs {{ID ...}} are currently
     106loaded, or {{#f}} otherwise.
     107
     108
    68109---
    69110Previous: [[Module (chicken keyword)]]
  • wiki/man/5/TODO/Unit eval

    r34052 r34256  
    3838same file have no effect.
    3939
    40 
    41 
    42 === Loading extension libraries
    43 
    44 This functionality is only available on platforms that support dynamic
    45 loading of compiled code. Currently Linux, BSD, Solaris, Windows (with
    46 Cygwin) and HP/UX are supported.
    47 
    48 ==== load-extension
    49 
    50 <procedure>(load-extension ID)</procedure>
    51 
    52 If the extension library {{ID}} is not already loaded into the
    53 system, then {{load-extension}} will look up the location of the shared
    54 extension library and load it. If {{ID}} names a library-unit of the
    55 base system, then it is loaded via {{load-library}}. If no extension
    56 library is available for the given ID, then an attempt is made to load
    57 the file {{ID.so}} or {{ID.scm}} (in that order) from one of the
    58 following locations:
    59 
    60 * the current directory
    61 * the current repository path (see {{repository-path}})
    62 
    63 {{ID}} should be a symbol.
    64 
    65 
    66 ==== require
    67 
    68 <procedure>(require ID ...)</procedure>
    69 
    70 An alias for {{load-extension}} that allows multiple extension
    71 identifiers to be provided.
    72 
    73 ==== provide
    74 
    75 <procedure>(require ID ...)</procedure>
    76 
    77 Registers the extension IDs {{ID ...}} as loaded. This is mainly
    78 intended to provide aliases for certain library identifiers.
    79 
    80 ==== provided?
    81 
    82 procedure: (provided? ID ...)
    83 
    84 Returns {{#t}} if extension with the IDs {{ID ...}} are currently
    85 loaded, or {{#f}} otherwise.
    86 
    87 
    8840=== Eval
    8941
Note: See TracChangeset for help on using the changeset viewer.