steve
/
factor
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
factor/library/primitives.factor

230 lines
18 KiB
Factor
Raw Normal View History

doc strings for primitives
2004-08-31 01:01:43 -04:00
! :folding=none:collapseFolds=1:
! $Id$
!
! Copyright (C) 2004 Slava Pestov.
!
! Redistribution and use in source and binary forms, with or without
! modification, are permitted provided that the following conditions are met:
!
! 1. Redistributions of source code must retain the above copyright notice,
! this list of conditions and the following disclaimer.
!
! 2. Redistributions in binary form must reproduce the above copyright notice,
! this list of conditions and the following disclaimer in the documentation
! and/or other materials provided with the distribution.
!
! THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
! INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
! FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
! DEVELOPERS AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
! SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
! PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
! OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
! WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
! OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
! ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
type inference work, and = for aliens
2004-12-23 01:14:07 -05:00
IN: alien
DEFER: alien
huge cleanup
2004-12-24 02:52:02 -05:00
DEFER: dll
type inference work, and = for aliens
2004-12-23 01:14:07 -05:00
start FFI
2004-09-18 18:15:01 -04:00
USE: alien
USE: compiler
throw is primitive in CFactor, working on test suite
2004-10-03 16:07:48 -04:00
USE: errors
doc strings for primitives
2004-08-31 01:01:43 -04:00
USE: files
type inference work, and = for aliens
2004-12-23 01:14:07 -05:00
USE: generic
doc strings for primitives
2004-08-31 01:01:43 -04:00
USE: io-internals
USE: kernel
string>memory and memory>string primitives
2004-12-19 21:07:17 -05:00
USE: kernel-internals
start FFI
2004-09-18 18:15:01 -04:00
USE: lists
doc strings for primitives
2004-08-31 01:01:43 -04:00
USE: math
move some words to math-internals
2004-12-10 18:38:40 -05:00
USE: math-internals
doc strings for primitives
2004-08-31 01:01:43 -04:00
USE: parser
USE: profiler
start FFI
2004-09-18 18:15:01 -04:00
USE: random
USE: strings
USE: unparser
doc strings for primitives
2004-08-31 01:01:43 -04:00
USE: vectors
USE: words
[
stack effects for all primitives, updated to do list, literal hashtable syntax {{ [ key | value ] ... }}
2004-11-11 16:45:55 -05:00
[ execute " word -- " f ]
more type inference work
2004-12-23 18:26:04 -05:00
[ call " quot -- " [ [ general-list ] [ ] ] ]
[ ifte " cond true false -- " [ [ object general-list general-list ] [ ] ] ]
type inference work, and = for aliens
2004-12-23 01:14:07 -05:00
[ cons " car cdr -- [ car | cdr ] " [ [ object object ] [ cons ] ] ]
more type inference work
2004-12-23 18:26:04 -05:00
[ <vector> " capacity -- vector" [ [ integer ] [ vector ] ] ]
[ vector-nth " n vector -- obj " [ [ integer vector ] [ object ] ] ]
[ set-vector-nth " obj n vector -- " [ [ object integer vector ] [ ] ] ]
[ str-nth " n str -- ch " [ [ integer string ] [ integer ] ] ]
[ str-compare " str str -- -1/0/1 " [ [ string string ] [ integer ] ] ]
[ str= " str str -- ? " [ [ string string ] [ boolean ] ] ]
generic cleanups and type inference work
2004-12-23 23:55:22 -05:00
[ index-of* " n str/ch str -- n " [ [ integer string text ] [ integer ] ] ]
more type inference work
2004-12-23 18:26:04 -05:00
[ substring " start end str -- str " [ [ integer integer string ] [ string ] ] ]
[ str-reverse " str -- str " [ [ string ] [ string ] ] ]
[ <sbuf> " capacity -- sbuf " [ [ integer ] [ sbuf ] ] ]
[ sbuf-length " sbuf -- n " [ [ sbuf ] [ integer ] ] ]
[ set-sbuf-length " n sbuf -- " [ [ integer sbuf ] [ ] ] ]
[ sbuf-nth " n sbuf -- ch " [ [ integer sbuf ] [ integer ] ] ]
[ set-sbuf-nth " ch n sbuf -- " [ [ integer integer sbuf ] [ ] ] ]
[ sbuf-append " ch/str sbuf -- " [ [ text sbuf ] [ ] ] ]
[ sbuf>str " sbuf -- str " [ [ sbuf ] [ string ] ] ]
[ sbuf-reverse " sbuf -- " [ [ sbuf ] [ ] ] ]
[ sbuf-clone " sbuf -- sbuf " [ [ sbuf ] [ sbuf ] ] ]
[ sbuf= " sbuf sbuf -- ? " [ [ sbuf sbuf ] [ boolean ] ] ]
type check optimization is here
2004-12-31 02:17:45 -05:00
[ sbuf-hashcode " sbuf -- n " [ [ sbuf ] [ fixnum ] ] ]
more type inference work
2004-12-23 18:26:04 -05:00
[ arithmetic-type " n n -- type " [ [ number number ] [ number number fixnum ] ] ]
[ >fixnum " n -- fixnum " [ [ number ] [ fixnum ] ] ]
[ >bignum " n -- bignum " [ [ number ] [ bignum ] ] ]
[ >float " n -- float " [ [ number ] [ float ] ] ]
huge cleanup
2004-12-24 02:52:02 -05:00
[ (fraction>) " a b -- a/b " [ [ integer integer ] [ rational ] ] ]
more type inference work
2004-12-23 18:26:04 -05:00
[ str>float " str -- float " [ [ string ] [ float ] ] ]
[ (unparse-float) " float -- str " [ [ float ] [ string ] ] ]
huge cleanup
2004-12-24 02:52:02 -05:00
[ (rect>) " re im -- #{ re im } " [ [ real real ] [ number ] ] ]
more type inference work
2004-12-23 18:26:04 -05:00
[ fixnum= " x y -- ? " [ [ fixnum fixnum ] [ boolean ] ] ]
[ fixnum+ " x y -- x+y " [ [ fixnum fixnum ] [ integer ] ] ]
[ fixnum- " x y -- x-y " [ [ fixnum fixnum ] [ integer ] ] ]
[ fixnum* " x y -- x*y " [ [ fixnum fixnum ] [ integer ] ] ]
[ fixnum/i " x y -- x/y " [ [ fixnum fixnum ] [ integer ] ] ]
[ fixnum/f " x y -- x/y " [ [ fixnum fixnum ] [ integer ] ] ]
hash tables cons less
2004-12-27 22:58:43 -05:00
[ fixnum-mod " x y -- x%y " [ [ fixnum fixnum ] [ fixnum ] ] ]
[ fixnum/mod " x y -- x/y x%y " [ [ fixnum fixnum ] [ integer fixnum ] ] ]
more type inference work
2004-12-23 18:26:04 -05:00
[ fixnum-bitand " x y -- x&y " [ [ fixnum fixnum ] [ fixnum ] ] ]
[ fixnum-bitor " x y -- x|y " [ [ fixnum fixnum ] [ fixnum ] ] ]
[ fixnum-bitxor " x y -- x^y " [ [ fixnum fixnum ] [ fixnum ] ] ]
[ fixnum-bitnot " x -- ~x " [ [ fixnum ] [ fixnum ] ] ]
[ fixnum-shift " x n -- x<<n" [ [ fixnum fixnum ] [ fixnum ] ] ]
[ fixnum< " x y -- ? " [ [ fixnum fixnum ] [ boolean ] ] ]
[ fixnum<= " x y -- ? " [ [ fixnum fixnum ] [ boolean ] ] ]
[ fixnum> " x y -- ? " [ [ fixnum fixnum ] [ boolean ] ] ]
[ fixnum>= " x y -- ? " [ [ fixnum fixnum ] [ boolean ] ] ]
type inference changes, comment out smart-terminal reference in win32-console, win32-compatible factor plugin
2004-12-29 03:35:46 -05:00
[ bignum= " x y -- ? " [ [ bignum bignum ] [ boolean ] ] ]
more type inference work
2004-12-23 18:26:04 -05:00
[ bignum+ " x y -- x+y " [ [ bignum bignum ] [ bignum ] ] ]
[ bignum- " x y -- x-y " [ [ bignum bignum ] [ bignum ] ] ]
[ bignum* " x y -- x*y " [ [ bignum bignum ] [ bignum ] ] ]
[ bignum/i " x y -- x/y " [ [ bignum bignum ] [ bignum ] ] ]
[ bignum/f " x y -- x/y " [ [ bignum bignum ] [ bignum ] ] ]
[ bignum-mod " x y -- x%y " [ [ bignum bignum ] [ bignum ] ] ]
[ bignum/mod " x y -- x/y x%y " [ [ bignum bignum ] [ bignum bignum ] ] ]
[ bignum-bitand " x y -- x&y " [ [ bignum bignum ] [ bignum ] ] ]
[ bignum-bitor " x y -- x|y " [ [ bignum bignum ] [ bignum ] ] ]
[ bignum-bitxor " x y -- x^y " [ [ bignum bignum ] [ bignum ] ] ]
[ bignum-bitnot " x -- ~x " [ [ bignum ] [ bignum ] ] ]
[ bignum-shift " x n -- x<<n" [ [ bignum bignum ] [ bignum ] ] ]
[ bignum< " x y -- ? " [ [ bignum bignum ] [ boolean ] ] ]
[ bignum<= " x y -- ? " [ [ bignum bignum ] [ boolean ] ] ]
[ bignum> " x y -- ? " [ [ bignum bignum ] [ boolean ] ] ]
[ bignum>= " x y -- ? " [ [ bignum bignum ] [ boolean ] ] ]
[ float= " x y -- ? " [ [ bignum bignum ] [ boolean ] ] ]
[ float+ " x y -- x+y " [ [ float float ] [ float ] ] ]
[ float- " x y -- x-y " [ [ float float ] [ float ] ] ]
[ float* " x y -- x*y " [ [ float float ] [ float ] ] ]
[ float/f " x y -- x/y " [ [ float float ] [ float ] ] ]
[ float< " x y -- ? " [ [ float float ] [ boolean ] ] ]
[ float<= " x y -- ? " [ [ float float ] [ boolean ] ] ]
[ float> " x y -- ? " [ [ float float ] [ boolean ] ] ]
[ float>= " x y -- ? " [ [ float float ] [ boolean ] ] ]
[ facos " x -- y " [ [ real ] [ float ] ] ]
[ fasin " x -- y " [ [ real ] [ float ] ] ]
[ fatan " x -- y " [ [ real ] [ float ] ] ]
[ fatan2 " x y -- z " [ [ real real ] [ float ] ] ]
[ fcos " x -- y " [ [ real ] [ float ] ] ]
[ fexp " x -- y " [ [ real ] [ float ] ] ]
[ fcosh " x -- y " [ [ real ] [ float ] ] ]
[ flog " x -- y " [ [ real ] [ float ] ] ]
[ fpow " x y -- z " [ [ real real ] [ float ] ] ]
[ fsin " x -- y " [ [ real ] [ float ] ] ]
[ fsinh " x -- y " [ [ real ] [ float ] ] ]
[ fsqrt " x -- y " [ [ real ] [ float ] ] ]
huge cleanup
2004-12-24 02:52:02 -05:00
[ <word> " -- word " [ [ ] [ word ] ] ]
[ update-xt " word -- " [ [ word ] [ ] ] ]
more type inference work
2004-12-23 18:26:04 -05:00
[ drop " x -- " [ [ object ] [ ] ] ]
[ dup " x -- x x " [ [ object ] [ object object ] ] ]
[ swap " x y -- y x " [ [ object object ] [ object object ] ] ]
[ over " x y -- x y x " [ [ object object ] [ object object object ] ] ]
[ pick " x y z -- x y z x " [ [ object object object ] [ object object object object ] ] ]
[ >r " x -- r:x " [ [ object ] [ ] ] ]
[ r> " r:x -- x " [ [ ] [ object ] ] ]
[ eq? " x y -- ? " [ [ object object ] [ boolean ] ] ]
[ getenv " n -- obj " [ [ fixnum ] [ object ] ] ]
[ setenv " obj n -- " [ [ object fixnum ] [ ] ] ]
huge cleanup
2004-12-24 02:52:02 -05:00
[ open-file " path r w -- port " [ [ string object object ] [ port ] ] ]
[ stat " path -- [ dir? perm size mtime ] " [ [ string ] [ cons ] ] ]
[ (directory) " path -- list " [ [ string ] [ general-list ] ] ]
[ garbage-collection " -- " [ [ ] [ ] ] ]
[ save-image " path -- " [ [ string ] [ ] ] ]
stack effects for all primitives, updated to do list, literal hashtable syntax {{ [ key | value ] ... }}
2004-11-11 16:45:55 -05:00
[ datastack " -- ds " f ]
[ callstack " -- cs " f ]
[ set-datastack " ds -- " f ]
[ set-callstack " cs -- " f ]
huge cleanup
2004-12-24 02:52:02 -05:00
[ exit* " n -- " [ [ integer ] [ ] ] ]
[ client-socket " host port -- in out " [ [ string integer ] [ port port ] ] ]
[ server-socket " port -- server " [ [ integer ] [ port ] ] ]
[ close-port " port -- " [ [ port ] ] ]
removed old effects
2004-12-24 17:29:16 -05:00
[ add-accept-io-task " server callback -- " [ [ port general-list ] [ ] ] ]
[ accept-fd " server -- host port in out " [ [ port ] [ string integer port port ] ] ]
[ can-read-line? " port -- ? " [ [ port ] [ boolean ] ] ]
[ add-read-line-io-task " port callback -- " [ [ port general-list ] [ ] ] ]
[ read-line-fd-8 " port -- sbuf " [ [ port ] [ sbuf ] ] ]
[ can-read-count? " n port -- ? " [ [ integer port ] [ boolean ] ] ]
[ add-read-count-io-task " n port callback -- " [ [ integer port general-list ] [ ] ] ]
[ read-count-fd-8 " n port -- sbuf " [ [ integer port ] [ sbuf ] ] ]
[ can-write? " n port -- ? " [ [ integer port ] [ boolean ] ] ]
[ add-write-io-task " port callback -- " [ [ port general-list ] [ ] ] ]
[ write-fd-8 " ch/str port -- " [ [ text port ] [ ] ] ]
[ add-copy-io-task " from to callback -- " [ [ port port general-list ] [ ] ] ]
[ pending-io-error " -- " [ [ ] [ ] ] ]
[ next-io-task " -- callback " [ [ ] [ general-list ] ] ]
[ room " -- free total free total " [ [ ] [ integer integer integer integer ] ] ]
[ os-env " str -- str " [ [ string ] [ object ] ] ]
huge cleanup
2004-12-24 02:52:02 -05:00
[ millis " -- n " [ [ ] [ integer ] ] ]
[ init-random " -- " [ [ ] [ ] ] ]
[ (random-int) " -- n " [ [ ] [ integer ] ] ]
[ type " obj -- n " [ [ object ] [ fixnum ] ] ]
[ call-profiling " depth -- " [ [ integer ] [ ] ] ]
[ allot-profiling " depth -- " [ [ integer ] [ ] ] ]
[ cwd " -- dir " [ [ ] [ string ] ] ]
[ cd " dir -- " [ [ string ] [ ] ] ]
[ compiled-offset " -- ptr " [ [ ] [ integer ] ] ]
[ set-compiled-offset " ptr -- " [ [ integer ] [ ] ] ]
[ literal-top " -- ptr " [ [ ] [ integer ] ] ]
[ set-literal-top " ptr -- " [ [ integer ] [ ] ] ]
[ address " obj -- ptr " [ [ object ] [ integer ] ] ]
[ dlopen " path -- dll " [ [ string ] [ dll ] ] ]
FFI relocation
2004-12-25 18:08:20 -05:00
[ dlsym " name dll -- ptr " [ [ string object ] [ integer ] ] ]
huge cleanup
2004-12-24 02:52:02 -05:00
[ dlclose " dll -- " [ [ dll ] [ ] ] ]
[ <alien> " ptr -- alien " [ [ integer ] [ alien ] ] ]
[ <local-alien> " len -- alien " [ [ integer ] [ alien ] ] ]
[ alien-cell " alien off -- n " [ [ alien integer ] [ integer ] ] ]
[ set-alien-cell " n alien off -- " [ [ integer alien integer ] [ ] ] ]
[ alien-4 " alien off -- n " [ [ alien integer ] [ integer ] ] ]
[ set-alien-4 " n alien off -- " [ [ integer alien integer ] [ ] ] ]
[ alien-2 " alien off -- n " [ [ alien integer ] [ fixnum ] ] ]
[ set-alien-2 " n alien off -- " [ [ integer alien integer ] [ ] ] ]
[ alien-1 " alien off -- n " [ [ alien integer ] [ fixnum ] ] ]
[ set-alien-1 " n alien off -- " [ [ integer alien integer ] [ ] ] ]
more type inference work
2004-12-23 18:26:04 -05:00
[ heap-stats " -- instances bytes " [ [ ] [ general-list ] ] ]
[ throw " error -- " [ [ object ] [ ] ] ]
[ string>memory " str address -- " [ [ string integer ] [ ] ] ]
[ memory>string " address length -- str " [ [ integer integer ] [ string ] ] ]
type inference work, and = for aliens
2004-12-23 01:14:07 -05:00
[ local-alien? " alien -- ? " [ [ alien ] [ object ] ] ]
[ alien-address " alien -- address " [ [ alien ] [ integer ] ] ]
kernel errors a bit better, inference cleanup
2004-12-26 01:42:09 -05:00
! Note: a correct type spec for these would have [ X ] as
! input, not [ object ]. However, we rely on the inferencer
! to handle these specially, since they are also optimized
! out in some cases, etc.
[ >cons " cons -- cons " [ [ object ] [ cons ] ] ]
[ >vector " vector -- vector " [ [ object ] [ vector ] ] ]
[ >string " string -- string " [ [ object ] [ string ] ] ]
huge cleanup
2004-12-24 02:52:02 -05:00
[ >word " word -- word " [ [ word ] [ word ] ] ]
[ slot " obj n -- obj " [ [ object fixnum ] [ object ] ] ]
[ set-slot " obj obj n -- " [ [ object object fixnum ] [ ] ] ]
[ integer-slot " obj n -- n " [ [ object fixnum ] [ integer ] ] ]
[ set-integer-slot " n obj n -- " [ [ integer object fixnum ] [ ] ] ]
[ grow-array " n array -- array " [ [ integer array ] [ integer ] ] ]
doc strings for primitives
2004-08-31 01:01:43 -04:00
] [
stack effects for all primitives, updated to do list, literal hashtable syntax {{ [ key | value ] ... }}
2004-11-11 16:45:55 -05:00
uncons dupd uncons car ( word word stack-effect infer-effect )
>r "stack-effect" set-word-property r>
"infer-effect" set-word-property
doc strings for primitives
2004-08-31 01:01:43 -04:00
] each