Changeset 13526 in project


Ignore:
Timestamp:
03/06/09 06:27:40 (11 years ago)
Author:
Kon Lovett
Message:

Rmvd keyword arg style from 'box'. Save for 'stack'.

Location:
wiki/eggref/4
Files:
1 added
1 edited

Legend:

Unmodified
Added
Removed
  • wiki/eggref/4/box

    r13500 r13526  
    2323=== make-box
    2424
    25 <procedure>(make-box OBJECT [#:immutable? #f]) => BOX</procedure>
     25<procedure>(make-box [INITIAL [IMMUTABLE? #f]]) => BOX</procedure>
    2626
    27 Returns a {{BOX}} with initial value {{OBJECT}}.
     27Returns a {{BOX}} with, optional, initial value {{INITIAL}}.
    2828
    29 The {{BOX}} is mutable unless the {{immutable?}} keyword argument is {{#t}}.
    30 An attempt to mutate the boxed value will signal an exception.
     29The {{BOX}} is mutable unless the {{IMMUTABLE?}} argument is {{#t}}.
     30
     31An attempt to mutate an immutable box will signal an exception.
    3132
    3233=== make-box-variable
    3334
    34 <macro>(make-box-variable VARIABLE [#:immutable? #f]) => BOX</macro>
     35<macro>(make-box-variable VARIABLE [IMMUTABLE? #f]) => BOX</macro>
    3536
    3637Returns a boxed reference to the {{VARIABLE}}, which must be in lexical-scope.
    3738
    38 The {{BOX}} is mutable unless the {{immutable?}} keyword argument is {{#t}}.
     39The {{BOX}} is mutable unless the {{IMMUTABLE?}} argument is {{#t}}.
     40
     41An attempt to mutate an immutable box will signal an exception.
    3942
    4043=== make-box-location
    4144
    42 <macro>(make-box-location TYPE INITIAL-VALUE [#:immutable? #f]) => BOX</macro>
     45<macro>(make-box-location TYPE INITIAL-VALUE [IMMUTABLE? #f]) => BOX</macro>
    4346
    4447Returns a boxed reference to a location of {{TYPE}} and {{INITIAL-VALUE}}.
    4548
    46 The {{BOX}} is mutable unless the {{immutable?}} keyword argument is {{#t}}.
     49The {{BOX}} is mutable unless the {{IMMUTABLE?}} argument is {{#t}}.
     50
     51An attempt to mutate an immutable box will signal an exception.
    4752
    4853Unavailable in EVALuated source.
     
    9398=== box-location
    9499
    95 <procedure>(box-location BOX [#:weak? #f]) => LOCATION</procedure>
     100<procedure>(box-location BOX [WEAK? #f]) => LOCATION</procedure>
    96101
    97102Returns a {{LOCATION}} object for a boxed variable, location or locatable box.
    98103Signals an exception otherwise.
    99104
    100 The locative is "strong" unless the {{weak?}} keyword argument is {{#t}}. The
    101 {{weak?}} keyword argument is ignored for boxed variables and locations.
     105The locative is "strong" unless the {{WEAK?}} argument is {{#t}}. The
     106{{WEAK?}} argument is ignored for boxed variables and locations.
    102107
    103108The location of a boxed value or boxed location is the box. The location of a boxed
     
    168173== Version history
    169174
    170 ; 2.0.0 : Port to hygienic Chicken. Reduced memory footprint for basic usage.
     175; 2.0.0 : Port to hygienic Chicken. Reduced memory footprint for basic usage. Dropped keyword arguments.
    171176
    172177
Note: See TracChangeset for help on using the changeset viewer.