Changeset 35241 in project


Ignore:
Timestamp:
03/04/18 21:30:32 (4 months ago)
Author:
kon
Message:

rel 2.4.0

File:
1 edited

Legend:

Unmodified
Added
Removed
  • wiki/eggref/4/box

    r34152 r35241  
    2323=== make-box
    2424
    25 <procedure>(make-box [INITIAL [IMMUTABLE? #f]]) => box</procedure>
     25<procedure>(make-box [INITIAL [IMMUTABLE? #f]]) -> box</procedure>
    2626
    2727Returns a {{BOX}} with, optional, initial value {{INITIAL}}.
     
    3333=== make-box-variable
    3434
    35 <macro>(make-box-variable VARIABLE [IMMUTABLE? #f]) => box</macro>
     35<macro>(make-box-variable VARIABLE [IMMUTABLE? #f]) -> box</macro>
    3636
    3737Returns a boxed reference to the {{VARIABLE}}, which must be in lexical-scope.
     
    4343=== make-box-location
    4444
    45 <macro>(make-box-location TYPE INITIAL-VALUE [IMMUTABLE? #f]) => box</macro>
     45<macro>(make-box-location TYPE INITIAL-VALUE [IMMUTABLE? #f]) -> box</macro>
    4646
    4747Returns a boxed reference to a location of {{TYPE}} and {{INITIAL-VALUE}}.
     
    5555=== box?
    5656
    57 <procedure>(box? OBJECT) => boolean</procedure>
     57<procedure>(box? OBJECT) -> boolean</procedure>
    5858
    5959Is {{OBJECT}} a {{BOX}}?
     
    6161=== box-mutable?
    6262
    63 <procedure>(box-mutable? OBJECT) => boolean</procedure>
     63<procedure>(box-mutable? OBJECT) -> boolean</procedure>
    6464
    6565Is {{OBJECT}} a mutable {{BOX}}?
     
    6767=== box-immutable?
    6868
    69 <procedure>(box-immutable? OBJECT) => boolean</procedure>
     69<procedure>(box-immutable? OBJECT) -> boolean</procedure>
    7070
    7171Is {{OBJECT}} an immutable {{BOX}}?
     
    7373=== box-variable?
    7474
    75 <procedure>(box-variable? OBJECT) => boolean</procedure>
     75<procedure>(box-variable? OBJECT) -> boolean</procedure>
    7676
    7777Is {{OBJECT}} a boxed variable?
     
    7979=== box-location?
    8080
    81 <procedure>(box-location? OBJECT) => boolean</procedure>
     81<procedure>(box-location? OBJECT) -> boolean</procedure>
    8282
    8383Is {{OBJECT}} a boxed location?
     
    9292=== box-ref
    9393
    94 <procedure>(box-ref BOX) => *</procedure>
     94<procedure>(box-ref BOX) -> *</procedure>
    9595
    9696Returns the boxed value of {{BOX}}.
     
    9898=== box-location
    9999
    100 <procedure>(box-location BOX [WEAK? #f]) => location</procedure>
     100<procedure>(box-location BOX [WEAK? #f]) -> location</procedure>
    101101
    102102Returns a {{LOCATION}} object for a boxed variable, location or locatable box.
     
    120120of {{BOX}}.
    121121
     122=== make-box-variable-closure
     123
     124<procedure>(make-box-variable-closure IMMUTABLE? REF SET) -> box</procedure>
     125
     126; {{IMMUTABLE?}} : {{boolean}}
     127; {{REF}} : {{(-> *)}}
     128; {{SET}} : {{(* -> void)}}
     129
     130=== make-box-location-closure
     131
     132<procedure>(make-box-location-closure IMMUTABLE? REF SET REFLOC) -> box</procedure>
     133
     134; {{IMMUTABLE?}} : {{boolean}}
     135; {{REF}} : {{(-> *)}}
     136; {{SET}} : {{(* -> void)}}
     137; {{REFLOC}} : {{(-> location)}}
     138
    122139=== box
    123140
    124 <procedure>(box OBJECT) => box</procedure>
     141<procedure>(box OBJECT) -> box</procedure>
    125142
    126143Returns a mutable {{BOX}} with initial value {{OBJECT}}.
     
    135152=== unbox
    136153
    137 <procedure>(unbox BOX) => *</procedure>
     154<procedure>(unbox BOX) -> *</procedure>
    138155
    139156Returns the boxed value of {{BOX}}.
     
    194211== Version history
    195212
     213; 2.4.0 : Add {{make-box-variable-closure}} & {{make-box-location-closure}}.
    196214; 2.3.3 : Updated type information.
    197215; 2.3.2 : Added type information.
     
    208226== License
    209227
    210 Copyright (C) 2009-2017 Kon Lovett.  All rights reserved.
     228Copyright (C) 2009-2018 Kon Lovett.  All rights reserved.
    211229
    212230Permission is hereby granted, free of charge, to any person obtaining a
Note: See TracChangeset for help on using the changeset viewer.