1. Inclub
    1. Description
    2. Authors
    3. Repository
    4. Requirements
    5. API
    6. Examples
      1. Basic Usage
    7. Acknowledgements
    8. License
    9. Version History

Inclub

Description

The syntax form inclub is a convenience substitute for include for use in multi-file projects. When the program may be run either interpreted or compiled, and may be executed from outside its directory, possibly through a symlink, inclub handles the details of making sure the "inclubbed" files get loaded as intended.

In compiled code, inclub simply expands to include, meaning the inclubbed file will be compiled into the binary.

In interpreted code, inclub resolves any symlinks back to the directory the program resides in, and calls load on the inclubbed file in that directory.

Authors

Repository

The source can be obtained or browsed on github.

Requirements

API

[syntax] (inclub STRING)

Examples

Basic Usage

To use inclub to load a file called "myfile.scm":

(use inclub)
(inclub "myfile")

If myfile.scm contains a module called myfile, add this:

(import myfile)

If the project has multiple modules that need to import a module provided by an inclubbed file, the file should be inclubbed only in the main file; the other files can then import the module.

Acknowledgements

Thanks to Zbigniew for working out the basic mechanism, and also for proposing the name "inclub" — inclub: the brute force include.

License

BSD

Version History