Libraries

The framework provides these libraries:

• Entire Framework
  • (require-library "framework.ss" "framework") This library adds all of the definitions and macros in this manual to the top-level.
  • (require-library "frameworks.ss" "framework")

    This library adds a signature definitions framework^ and signature definitions for each of the constituent units for the "frameworkr.ss" unit. It also requires the macro.ss library, the tests.ss library.

  • (require-library "frameworkr.ss" "framework")

    This library returns a unit/sig that imports two units. The first must be the result of (require-library "corer.ss") and the second must be mred@, which is built in to PLT MrEd: Graphical Toolbox Manual.

    This unit exports several sub-units. Each sub unit corresponds to one chapter in the Reference part of this manual.

  • (require-library "macro.ss" "framework") This defines the mixin macro. See the mixin section for more information.

• Test Suite Engine
  • (require-library "test.ss" "framework") This library adds all of the definitions in the test section to the top-level.
  • (require-library "tests.ss" "framework")

    This library adds all of the signature definitions needed for the testing engine to the top-level.

  • (require-library "testr.ss" "framework")

    This library returns a unit/sig that imports two units. The first must be mred@, which is built in to MrEd, and the second must be the result of (require-library "keys.ss" "framework")

  • (require-library "keys.ss" "framework")

    This library returns a unit/sig that imports nothing. It matches the framework:keys^ signature, defined by the "tests.ss" library, described above.

• GUI Utilities
  • (require-library "guiutils.ss" "framework")

    This libraries adds all of the definitions in the GUI utilities section to the top-level.

  • (require-library "guiutilsr.ss" "framework")

    Requiring this library results in a unit that imports the mred@ unit and exports framework:gui-utils^.

  • (require-library "guiutilss.ss" "framework")

    This libraries defines the signature framework:gui-utils^ that contains all of the names in the GUI utilities section. These names do not have the gui-utils: prefix in the signature.

• Preferences Library Filename Specification

  This is an alternate library that allows you to specify the location of the preferences file for the preferences library, instead of using the default one. The expression:

  (require-library "frameworkp.ss" "framework")

  evaluates to a unit that imports a unit matching the mred^ signature, one matching mzlib:core^ and one matching framework:prefs-file^. The signature framework:prefs-file^ only contains one name: preferences-filename. This is expected to be a string naming the preferences file location.

The framework provides libraries to accomodate two styles of program construction: with units and through the top-level. Programmers who only use the top-level to construct their programs should use "framework.ss". Programmers who use units to construct their programs should first require "frameworks.ss" and then use "frameworkr.ss" to construct their programs.