core: trim using lists with lint.vocabs tool

[factor.git] / core / alien / alien.factor

diff --git a/core/alien/alien.factor b/core/alien/alien.factor
index 3f2b5f95bf18219f4ec7533610c930221d7a266a..689053efd88bfadc9b07ea8722e15d533e3c08ab 100644 (file)
--- a/core/alien/alien.factor
+++ b/core/alien/alien.factor
@@ -1,31 +1,56 @@
-! Copyright (C) 2004, 2009 Slava Pestov.
+! Copyright (C) 2004, 2010 Slava Pestov.
 ! See http://factorcode.org/license.txt for BSD license.
-USING: accessors assocs kernel math namespaces sequences system
-kernel.private byte-arrays arrays init ;
+USING: accessors assocs byte-arrays byte-vectors continuations
+continuations.private kernel kernel.private math namespaces
+sequences ;
+USE: init ! required but does not reference words
 IN: alien
 
-! Some predicate classes used by the compiler for optimization
-! purposes
-PREDICATE: simple-alien < alien underlying>> not ;
+BUILTIN: alien { underlying c-ptr read-only initial: f } expired ;
+BUILTIN: dll { path byte-array read-only initial: B{ } } ;
 
-UNION: simple-c-ptr
-simple-alien POSTPONE: f byte-array ;
+PRIMITIVE: <callback> ( word return-rewind -- alien )
+PRIMITIVE: <displaced-alien> ( displacement c-ptr -- alien )
+PRIMITIVE: alien-address ( c-ptr -- addr )
+PRIMITIVE: free-callback ( alien -- )
 
-DEFER: pinned-c-ptr?
+<PRIVATE
+PRIMITIVE: current-callback ( -- n )
+PRIVATE>
+
+PREDICATE: pinned-alien < alien underlying>> not ;
+
+UNION: pinned-c-ptr pinned-alien POSTPONE: f ;
+
+GENERIC: element-size ( seq -- n ) flushable
+
+M: byte-array element-size drop 1 ; inline
 
-PREDICATE: pinned-alien < alien underlying>> pinned-c-ptr? ;
+M: byte-vector element-size drop 1 ; inline
 
-UNION: pinned-c-ptr
-    pinned-alien POSTPONE: f ;
+M: slice element-size seq>> element-size ; inline
 
-GENERIC: >c-ptr ( obj -- c-ptr )
+M: f element-size drop 1 ; inline
+
+GENERIC: byte-length ( obj -- n ) flushable
+
+M: object byte-length [ length ] [ element-size ] bi * ; inline
+
+GENERIC: >c-ptr ( obj -- c-ptr ) flushable
 
 M: c-ptr >c-ptr ; inline
 
+M: slice >c-ptr
+    [ [ from>> ] [ element-size ] bi * ] [ seq>> >c-ptr ] bi
+    <displaced-alien> ; inline
+
 SLOT: underlying
 
 M: object >c-ptr underlying>> ; inline
 
+: binary-object ( obj -- c-ptr n )
+    [ >c-ptr ] [ byte-length ] bi ; inline
+
 GENERIC: expired? ( c-ptr -- ? ) flushable
 
 M: alien expired? expired>> ;
@@ -33,7 +58,7 @@ M: alien expired? expired>> ;
 M: f expired? drop t ;
 
 : <alien> ( address -- alien )
-    f <displaced-alien> { simple-c-ptr } declare ; inline
+    f <displaced-alien> { pinned-c-ptr } declare ; inline
 
 : <bad-alien> ( -- alien )
     -1 <alien> t >>expired ; inline
@@ -43,28 +68,37 @@ M: alien equal?
         2dup [ expired? ] either? [
             [ expired? ] both?
         ] [
-            [ alien-address ] bi@ =
+            [ alien-address ] same?
         ] if
     ] [
         2drop f
     ] if ;
 
-M: simple-alien hashcode* nip dup expired>> [ drop 1234 ] [ alien-address ] if ;
+M: pinned-alien hashcode*
+    nip dup expired>> [ drop 1234 ] [ alien-address ] if ;
 
-ERROR: alien-callback-error ;
+SINGLETONS: stdcall thiscall fastcall cdecl mingw ;
 
-: alien-callback ( return parameters abi quot -- alien )
-    alien-callback-error ;
+UNION: abi stdcall thiscall fastcall cdecl mingw ;
+
+: callee-cleanup? ( abi -- ? )
+    { stdcall fastcall thiscall } member? ;
+
+ERROR: callsite-not-compiled word ;
 
-ERROR: alien-indirect-error ;
+: alien-assembly ( args... return parameters abi quot -- return... )
+    \ alien-assembly callsite-not-compiled ;
+
+: alien-callback ( return parameters abi quot -- alien )
+    \ alien-callback callsite-not-compiled ;
 
-: alien-indirect ( ... funcptr return parameters abi -- )
-    alien-indirect-error ;
+: alien-indirect ( args... funcptr return parameters abi -- return... )
+    \ alien-indirect callsite-not-compiled ;
 
-ERROR: alien-invoke-error library symbol ;
+: alien-invoke ( args... return library function parameters varargs? -- return... )
+    \ alien-invoke callsite-not-compiled ;
 
-: alien-invoke ( ... return library function parameters -- ... )
-    2over alien-invoke-error ;
+<PRIVATE
 
 ! Callbacks are registered in a global hashtable. Note that they
 ! are also pinned in a special callback area, so clearing this
@@ -72,17 +106,34 @@ ERROR: alien-invoke-error library symbol ;
 ! cleared on startup.
 SYMBOL: callbacks
 
-[ H{ } clone callbacks set-global ] "alien" add-init-hook
+STARTUP-HOOK: [ H{ } clone callbacks set-global ]
 
-<PRIVATE
+! Used by compiler.codegen to wrap callback bodies
+: do-callback ( callback-quot wait-quot: ( callback -- ) -- )
+    t CONTEXT-OBJ-IN-CALLBACK-P set-context-object
+    init-namestack
+    init-catchstack
+    current-callback
+    [ 2drop call ] [ swap call( callback -- ) drop ] 3bi ; inline
 
+! A utility for defining global variables that are recompiled in
+! every session
 TUPLE: expiry-check object alien ;
 
 : recompute-value? ( check -- ? )
-    dup [ alien>> expired? ] [ drop t ] if ;
+    [ alien>> expired? ] [ t ] if* ;
+
+: delete-values ( value assoc -- )
+    [ rot drop = ] with assoc-reject! drop ;
 
 PRIVATE>
 
+: unregister-and-free-callback ( alien -- )
+    [ callbacks get delete-values ] [ free-callback ] bi ;
+
+: with-callback ( alien quot -- )
+    over [ unregister-and-free-callback ] curry finally ; inline
+
 : initialize-alien ( symbol quot -- )
     swap dup get-global dup recompute-value?
     [ drop [ call dup 31337 <alien> expiry-check boa ] dip set-global ]