core/kernel/kernel.factor

   1 ! Copyright (C) 2004, 2008 Slava Pestov.
   2 ! See http://factorcode.org/license.txt for BSD license.
   3 USING: kernel.private slots.private math.private
   4 classes.tuple.private ;
   5 IN: kernel
   6
   7 DEFER: dip
   8 DEFER: 2dip
   9 DEFER: 3dip
  10
  11 ! Stack stuff
  12 : spin ( x y z -- z y x ) swap rot ; inline
  13
  14 : roll ( x y z t -- y z t x ) [ rot ] dip swap ; inline
  15
  16 : -roll ( x y z t -- t x y z ) swap [ -rot ] dip ; inline
  17
  18 : 2over ( x y z -- x y z x y ) pick pick ; inline
  19
  20 : clear ( -- ) { } set-datastack ;
  21
  22 ! Combinators
  23 GENERIC: call ( callable -- )
  24
  25 DEFER: if
  26
  27 : ? ( ? true false -- true/false )
  28     #! 'if' and '?' can be defined in terms of each other
  29     #! because the JIT special-cases an 'if' preceeded by
  30     #! two literal quotations.
  31     rot [ drop ] [ nip ] if ; inline
  32
  33 : if ( ? true false -- ) ? call ;
  34
  35 ! Single branch
  36 : unless ( ? false -- )
  37     swap [ drop ] [ call ] if ; inline
  38
  39 : when ( ? true -- )
  40     swap [ call ] [ drop ] if ; inline
  41
  42 ! Anaphoric
  43 : if* ( ? true false -- )
  44     pick [ drop call ] [ 2nip call ] if ; inline
  45
  46 : when* ( ? true -- )
  47     over [ call ] [ 2drop ] if ; inline
  48
  49 : unless* ( ? false -- )
  50     over [ drop ] [ nip call ] if ; inline
  51
  52 ! Default
  53 : ?if ( default cond true false -- )
  54     pick [ roll 2drop call ] [ 2nip call ] if ; inline
  55
  56 ! Slippers and dippers.
  57 ! Not declared inline because the compiler special-cases them
  58
  59 : slip ( quot x -- x )
  60     #! 'slip' and 'dip' can be defined in terms of each other
  61     #! because the JIT special-cases a 'dip' preceeded by
  62     #! a literal quotation.
  63     [ call ] dip ;
  64
  65 : 2slip ( quot x y -- x y )
  66     #! '2slip' and '2dip' can be defined in terms of each other
  67     #! because the JIT special-cases a '2dip' preceeded by
  68     #! a literal quotation.
  69     [ call ] 2dip ;
  70
  71 : 3slip ( quot x y z -- x y z )
  72     #! '3slip' and '3dip' can be defined in terms of each other
  73     #! because the JIT special-cases a '3dip' preceeded by
  74     #! a literal quotation.
  75     [ call ] 3dip ;
  76
  77 : dip ( x quot -- x ) swap slip ;
  78
  79 : 2dip ( x y quot -- x y ) -rot 2slip ;
  80
  81 : 3dip ( x y z quot -- x y z ) -roll 3slip ;
  82
  83 : 4dip ( w x y z quot -- w x y z ) swap [ 3dip ] dip ; inline
  84
  85 ! Keepers
  86 : keep ( x quot -- x ) over slip ; inline
  87
  88 : 2keep ( x y quot -- x y ) [ 2dup ] dip 2dip ; inline
  89
  90 : 3keep ( x y z quot -- x y z ) [ 3dup ] dip 3dip ; inline
  91
  92 ! Cleavers
  93 : bi ( x p q -- )
  94     [ keep ] dip call ; inline
  95
  96 : tri ( x p q r -- )
  97     [ [ keep ] dip keep ] dip call ; inline
  98
  99 ! Double cleavers
 100 : 2bi ( x y p q -- )
 101     [ 2keep ] dip call ; inline
 102
 103 : 2tri ( x y p q r -- )
 104     [ [ 2keep ] dip 2keep ] dip call ; inline
 105
 106 ! Triple cleavers
 107 : 3bi ( x y z p q -- )
 108     [ 3keep ] dip call ; inline
 109
 110 : 3tri ( x y z p q r -- )
 111     [ [ 3keep ] dip 3keep ] dip call ; inline
 112
 113 ! Spreaders
 114 : bi* ( x y p q -- )
 115     [ dip ] dip call ; inline
 116
 117 : tri* ( x y z p q r -- )
 118     [ [ 2dip ] dip dip ] dip call ; inline
 119
 120 ! Double spreaders
 121 : 2bi* ( w x y z p q -- )
 122     [ 2dip ] dip call ; inline
 123
 124 : 2tri* ( u v w x y z p q r -- )
 125     [ 4dip ] 2dip 2bi* ; inline
 126
 127 ! Appliers
 128 : bi@ ( x y quot -- )
 129     dup bi* ; inline
 130
 131 : tri@ ( x y z quot -- )
 132     dup dup tri* ; inline
 133
 134 ! Double appliers
 135 : 2bi@ ( w x y z quot -- )
 136     dup 2bi* ; inline
 137
 138 : 2tri@ ( u v w y x z quot -- )
 139     dup dup 2tri* ; inline
 140
 141 ! Object protocol
 142 GENERIC: hashcode* ( depth obj -- code )
 143
 144 M: object hashcode* 2drop 0 ;
 145
 146 M: f hashcode* 2drop 31337 ;
 147
 148 : hashcode ( obj -- code ) 3 swap hashcode* ; inline
 149
 150 GENERIC: equal? ( obj1 obj2 -- ? )
 151
 152 M: object equal? 2drop f ;
 153
 154 TUPLE: identity-tuple ;
 155
 156 M: identity-tuple equal? 2drop f ;
 157
 158 : = ( obj1 obj2 -- ? )
 159     2dup eq? [ 2drop t ] [
 160         2dup both-fixnums? [ 2drop f ] [ equal? ] if
 161     ] if ; inline
 162
 163 GENERIC: clone ( obj -- cloned )
 164
 165 M: object clone ;
 166
 167 M: callstack clone (clone) ;
 168
 169 ! Tuple construction
 170 GENERIC: new ( class -- tuple )
 171
 172 GENERIC: boa ( ... class -- tuple )
 173
 174 ! Quotation building
 175 : 2curry ( obj1 obj2 quot -- curry )
 176     curry curry ; inline
 177
 178 : 3curry ( obj1 obj2 obj3 quot -- curry )
 179     curry curry curry ; inline
 180
 181 : with ( param obj quot -- obj curry )
 182     swapd [ swapd call ] 2curry ; inline
 183
 184 : prepose ( quot1 quot2 -- compose )
 185     swap compose ; inline
 186
 187 ! Booleans
 188 : not ( obj -- ? ) [ f ] [ t ] if ; inline
 189
 190 : and ( obj1 obj2 -- ? ) over ? ; inline
 191
 192 : >boolean ( obj -- ? ) [ t ] [ f ] if ; inline
 193
 194 : or ( obj1 obj2 -- ? ) dupd ? ; inline
 195
 196 : xor ( obj1 obj2 -- ? ) [ f swap ? ] when* ; inline
 197
 198 : both? ( x y quot -- ? ) bi@ and ; inline
 199
 200 : either? ( x y quot -- ? ) bi@ or ; inline
 201
 202 : most ( x y quot -- z )
 203     [ 2dup ] dip call [ drop ] [ nip ] if ; inline
 204
 205 ! Loops
 206 : loop ( pred: ( -- ? ) -- )
 207     dup slip swap [ loop ] [ drop ] if ; inline recursive
 208
 209 : do ( pred body tail -- pred body tail )
 210     over 3dip ; inline
 211
 212 : while ( pred: ( -- ? ) body: ( -- ) tail: ( -- ) -- )
 213     [ pick 3dip [ do while ] 3curry ] keep if ; inline recursive
 214
 215 : until ( pred: ( -- ? ) body: ( -- ) tail: ( -- ) -- )
 216     [ [ not ] compose ] 2dip while ; inline
 217
 218 ! Error handling -- defined early so that other files can
 219 ! throw errors before continuations are loaded
 220 : throw ( error -- * ) 5 getenv [ die ] or 1 (throw) ;
 221
 222 ERROR: assert got expect ;
 223
 224 : assert= ( a b -- ) 2dup = [ 2drop ] [ assert ] if ;
 225
 226 <PRIVATE
 227
 228 : declare ( spec -- ) drop ;
 229
 230 : hi-tag ( obj -- n ) { hi-tag } declare 0 slot ; inline
 231
 232 : do-primitive ( number -- ) "Improper primitive call" throw ;
 233
 234 PRIVATE>