s48-modules

  1. s48-modules
    1. Description
    2. Author
    3. Requirements
    4. Documentation
    5. Limitations and caveats
      1. include-relative
    6. Changelog
    7. License

Description

Chicken wrapper for the Scheme48 module system.

Author

Felix

Requirements

none

Documentation

This egg allows you to compile Scheme48 modules as-is, and use them in your Chicken programs.

Most of the module (or "package") syntax is supported. For information on how to use these, see the Scheme48 manual.

Limitations and caveats

This module system only generates import statements. Libraries are not loaded by import statements. This means you will have to load the libraries exporting the modules yourself prior to using the s48 modules.

The following code actually defines two modules; foo and _foo:

(define-structure foo (export bar)
  (open scheme)
  (files foo))

That's because define-structure internally expands to define-structures with only one structure defined. Generating several modules with differing export lists requires one common internal module holding the actual code, which exports all its symbols. If you have several modules defined, the name of the internal module is equal to the first in the list, prefixed by an underscore. If you ask Chicken to generate import libraries while compiling, don't forget to add an extra -j flag to generate the "hidden" import library, as well.

include-relative

This module also defines the following macro as a replacement for the regular include macro:

[syntax] (include-relative filename)

This includes filename just like include would, but if you use include-relative inside that file, it will include files relative to the directory in which filename is located (include would instead just try to find the file relative to the topmost file you're compiling).

This macro must be used to include Scheme 48 module/package files which use files declarations to load external files.

For example, this code:

;; file: /rootpath/foo.scm
(include "bar/qux.scm")
;; file: /rootpath/bar/qux.scm
(include "mooh/blah.scm")

Would fail to load /rootpath/bar/mooh/blah.scm. Instead, it gives an error because it is trying to load /rootpath/mooh/blah.scm.

Whereas this would work:

;; file: /rootpath/foo.scm
(use s48-modules)
(include-relative "bar/qux.scm")
;; file: /rootpath/bar/qux.scm
(include-relative "mooh/blah.scm")

Changelog

License

Copyright (c) 2008, Felix L. Winkelmann
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following
conditions are met:
  Redistributions of source code must retain the above copyright notice, this list of conditions and the following
    disclaimer. 
  Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
    disclaimer in the documentation and/or other materials provided with the distribution. 
  Neither the name of the author nor the names of its contributors may be used to endorse or promote
    products derived from this software without specific prior written permission. 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS
OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR
CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.