This is box.egg.info, produced by makeinfo version 4.7 from eggdoc-output.texi. INFO-DIR-SECTION The Algorithmic Language Scheme START-INFO-DIR-ENTRY * box.egg: (box.egg). Boxing END-INFO-DIR-ENTRY  File: box.egg.info, Node: Top, Next: About this egg, Up: (dir) box egg ******* Boxing Written by Kon Lovett (mailto:klovett@pacbell.net) This manual corresponds to version 1.3 of the box extension library for Chicken Scheme. * Menu: * About this egg:: * Documentation:: * License:: * Index::  File: box.egg.info, Node: About this egg, Next: Documentation, Prev: Top, Up: Top 1 About this egg **************** * Menu: * Version history:: * Usage::  File: box.egg.info, Node: Version history, Next: Usage, Up: About this egg 1.1 Version history =================== `1.3' Exports `1.2' Added MzScheme-like box api, changed references `1.1' Added references, different implementation of box `1.0' Initial release  File: box.egg.info, Node: Usage, Prev: Version history, Up: About this egg 1.2 Usage ========= Load this egg like so: `(require-extension box)'  File: box.egg.info, Node: Documentation, Next: License, Prev: About this egg, Up: Top 2 Documentation *************** This egg is *unsafe*. * Menu: * Boxed Values:: * MzScheme-Like::  File: box.egg.info, Node: Boxed Values, Next: MzScheme-Like, Up: Documentation 2.1 Boxed Values ================ -- procedure: make-box (make-box [INITIAL-VALUE (void)]) Returns a box with the optional `INITIAL-VALUE'. -- procedure: make-box-immutable (make-box-immutable VALUE) Returns a box with the `VALUE'. Signals an error upon attempted set. -- macro: make-box-variable (make-box-variable VARIABLE) Returns a boxed reference to the variable `VARIABLE', which must be in lexical-scope. -- procedure: box? (box? BOX) Is it a box? -- procedure: box-mutable? (box-mutable? BOX) Is it a mutable box? -- procedure: box-immutable? (box-immutable? BOX) Is it an immutable box? -- procedure: box-variable? (box-variable? BOX) Is it a boxed variable? -- macro: box-set! (box-set! BOX VALUE) Sets the boxed value to `VALUE'. -- macro: box-ref (box-ref BOX) Returns the boxed value.  File: box.egg.info, Node: MzScheme-Like, Prev: Boxed Values, Up: Documentation 2.2 MzScheme-Like ================= Needs `(use box-mzs)'. -- macro: box (box INITIAL-VALUE) Returns a box with the `INITIAL-VALUE'. -- macro: box-immutable (box-immutable VALUE) Returns a box with the `VALUE'. Signals an error upon attempted set. -- macro: box-variable (box-variable VARIABLE) Returns a boxed reference to the variable `VARIABLE', which must be in lexical-scope. -- macro: set-box! (set-box! BOX VALUE) Sets the boxed value to `VALUE'. -- macro: unbox (unbox BOX) Returns the boxed value.  File: box.egg.info, Node: License, Next: Index, Prev: Documentation, Up: Top 3 License ********* Copyright (c) 2006, Kon Lovett. All rights reserved. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the Software), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED ASIS, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.  File: box.egg.info, Node: Index, Prev: License, Up: Top Index ***** [index] * Menu: * box: MzScheme-Like. (line 9) * box-immutable: MzScheme-Like. (line 14) * box-immutable?: Boxed Values. (line 34) * box-mutable?: Boxed Values. (line 29) * box-ref: Boxed Values. (line 49) * box-set!: Boxed Values. (line 44) * box-variable: MzScheme-Like. (line 20) * box-variable?: Boxed Values. (line 39) * box?: Boxed Values. (line 24) * make-box: Boxed Values. (line 7) * make-box-immutable: Boxed Values. (line 12) * make-box-variable: Boxed Values. (line 18) * set-box!: MzScheme-Like. (line 26) * unbox: MzScheme-Like. (line 31)  Tag Table: Node: Top201 Node: About this egg508 Node: Version history672 Node: Usage964 Node: Documentation1120 Node: Boxed Values1314 Node: MzScheme-Like2375 Node: License3075 Node: Index4255  End Tag Table