version 1.53, 2008/08/09 20:44:03
|
version 1.76, 2012/08/16 20:16:31
|
Line 1
|
Line 1
|
\ libcc.fs foreign function interface implemented using a C compiler |
\ libcc.fs foreign function interface implemented using a C compiler |
|
|
\ Copyright (C) 2006,2007,2008 Free Software Foundation, Inc. |
\ Copyright (C) 2006,2007,2008,2009,2010,2011 Free Software Foundation, Inc. |
|
|
\ This file is part of Gforth. |
\ This file is part of Gforth. |
|
|
Line 64
|
Line 64
|
\ wrapper again. This is all done by loading the index file(s?), |
\ wrapper again. This is all done by loading the index file(s?), |
\ which define words for the wrappers in a separate wordlist. |
\ which define words for the wrappers in a separate wordlist. |
|
|
\ The files are built in .../lib/gforth/$VERSION/libcc/ or |
\ The files are built in .../lib/gforth$ARCH/$VERSION/libcc/ or |
\ ~/.gforth/libcc/$HOST/. |
\ ~/.gforth$ARCH/libcc/$HOST/. |
|
|
\ other things to do: |
|
|
|
\ c-variable forth-name c-name |
|
\ c-constant forth-name c-name |
|
|
|
\ Todo: conversion between function pointers and xts (both directions) |
\ Todo: conversion between function pointers and xts (both directions) |
|
|
Line 135
|
Line 130
|
\ : delete-file 2drop 0 ; |
\ : delete-file 2drop 0 ; |
|
|
require struct.fs |
require struct.fs |
|
require mkdir.fs |
|
|
\ c-function-ft word body: |
\ c-function-ft word body: |
struct |
struct |
Line 142 struct
|
Line 138 struct
|
cell% field cff-deferred \ xt of c-function deferred word |
cell% field cff-deferred \ xt of c-function deferred word |
cell% field cff-lha \ address of the lib-handle for the lib that |
cell% field cff-lha \ address of the lib-handle for the lib that |
\ contains the wrapper function of the word |
\ contains the wrapper function of the word |
|
char% field cff-ctype \ call type (function=1, value=0) |
char% field cff-rtype \ return type |
char% field cff-rtype \ return type |
char% field cff-np \ number of parameters |
char% field cff-np \ number of parameters |
1 0 field cff-ptypes \ #npar parameter types |
1 0 field cff-ptypes \ #npar parameter types |
Line 157 variable lib-handle-addr \ points to the
|
Line 154 variable lib-handle-addr \ points to the
|
2variable lib-filename \ filename without extension |
2variable lib-filename \ filename without extension |
2variable lib-modulename \ basename of the file without extension |
2variable lib-modulename \ basename of the file without extension |
2variable libcc-named-dir-v \ directory for named libcc wrapper libraries |
2variable libcc-named-dir-v \ directory for named libcc wrapper libraries |
0 value libcc-path \ pointer to path of library directories |
Variable libcc-path \ pointer to path of library directories |
|
|
defer replace-rpath ( c-addr1 u1 -- c-addr2 u2 ) |
defer replace-rpath ( c-addr1 u1 -- c-addr2 u2 ) |
' noop is replace-rpath |
' noop is replace-rpath |
Line 218 end-struct list%
|
Line 215 end-struct list%
|
node list-next @ |
node list-next @ |
repeat ; |
repeat ; |
|
|
\ linked libraries |
2variable c-libs \ library names in a string (without "lib") |
|
|
list% |
|
cell% 2* field c-lib-string |
|
end-struct c-lib% |
|
|
|
variable c-libs \ linked list of library names (without "lib") |
: lib-prefix ( -- addr u ) s" libgf" ; |
|
|
: add-lib ( c-addr u -- ) \ gforth |
: add-lib ( c-addr u -- ) \ gforth |
\G Add library lib@i{string} to the list of libraries, where |
\G Add library lib@i{string} to the list of libraries, where |
\G @i{string} is represented by @i{c-addr u}. |
\G @i{string} is represented by @i{c-addr u}. |
c-lib% %size allocate throw dup >r |
c-libs 2@ d0= IF 0 allocate throw 0 c-libs 2! THEN |
c-lib-string 2! |
c-libs 2@ s" -l" append 2swap append c-libs 2! ; |
r> c-libs list-insert ; |
|
|
: add-libpath ( c-addr u -- ) \ gforth |
: append-l ( c-addr1 u1 node -- c-addr2 u2 ) |
\G Add path @i{string} to the list of library search pathes, where |
\ append " -l<nodelib>" to string1 |
\G @i{string} is represented by @i{c-addr u}. |
>r s" -l" append r> c-lib-string 2@ append ; |
c-libs 2@ d0= IF 0 allocate throw 0 c-libs 2! THEN |
|
c-libs 2@ s" -L" append 2swap append c-libs 2! ; |
|
|
\ C prefix lines |
\ C prefix lines |
|
|
Line 255 variable c-prefix-lines-end c-prefix-lin
|
Line 249 variable c-prefix-lines-end c-prefix-lin
|
: print-c-prefix-lines ( -- ) |
: print-c-prefix-lines ( -- ) |
c-prefix-lines @ ['] print-c-prefix-line list-map ; |
c-prefix-lines @ ['] print-c-prefix-line list-map ; |
|
|
: save-c-prefix-line ( c-addr u -- ) |
: write-c-prefix-line ( c-addr u -- ) |
c-source-file-id @ ?dup-if |
c-source-file-id @ dup if |
>r 2dup r> write-line throw |
write-line throw |
then |
else |
|
drop 2drop |
|
then ; |
|
|
|
: save-c-prefix-line1 ( c-addr u -- ) |
|
2dup write-c-prefix-line |
align here 0 , c-prefix-lines-end list-append ( c-addr u ) |
align here 0 , c-prefix-lines-end list-append ( c-addr u ) |
longstring, ; |
longstring, ; |
|
|
|
defer save-c-prefix-line ( c-addr u -- ) |
|
' save-c-prefix-line1 is save-c-prefix-line |
|
|
: \c ( "rest-of-line" -- ) \ gforth backslash-c |
: \c ( "rest-of-line" -- ) \ gforth backslash-c |
\G One line of C declarations for the C interface |
\G One line of C declarations for the C interface |
-1 parse save-c-prefix-line ; |
-1 parse save-c-prefix-line ; |
|
|
s" #include <gforth/" version-string s+ s" /libcc.h>" append ( c-addr u ) |
s" #include <gforth" arch-modifier s+ s" /" append version-string append s" /libcc.h>" append ( c-addr u ) |
2dup save-c-prefix-line drop free throw |
2dup save-c-prefix-line drop free throw |
|
|
\ Types (for parsing) |
\ Types (for parsing) |
Line 288 drop
|
Line 290 drop
|
|
|
set-current |
set-current |
|
|
: parse-libcc-type ( "libcc-type" -- u ) |
\ call types |
parse-name libcc-types search-wordlist 0= -13 and throw execute ; |
0 |
|
const+ c-func |
|
const+ c-val |
|
const+ c-var |
|
drop |
|
|
|
: libcc-type ( c-addr u -- u2 ) |
|
libcc-types search-wordlist 0= -13 and throw execute ; |
|
|
|
: parse-libcc-type ( "libcc-type" -- u ) parse-name libcc-type ; |
|
|
|
: parse-return-type ( "libcc-type" -- u ) |
|
parse-libcc-type dup 0< -32 and throw ; |
|
|
: parse-function-types ( "{libcc-type}" "--" "libcc-type" -- ) |
: parse-function-types ( "{libcc-type}" "--" "libcc-type" -- addr ) |
here 2 chars allot here begin |
c-func c, here |
|
dup 2 chars allot here begin |
parse-libcc-type dup 0>= while |
parse-libcc-type dup 0>= while |
c, |
c, |
repeat |
repeat |
drop here swap - over char+ c! |
drop here swap - over char+ c! |
parse-libcc-type dup 0< -32 and throw swap c! ; |
parse-return-type swap c! ; |
|
|
|
: parse-value-type ( "{--}" "libcc-type" -- addr ) |
|
c-val c, here |
|
parse-libcc-type dup 0< if drop parse-return-type then |
|
c, 0 c, ; |
|
|
|
: parse-variable-type ( -- addr ) |
|
c-var c, here |
|
s" a" libcc-type c, 0 c, ; |
|
|
|
0 Value is-funptr? |
|
: parse-funptr-types ( "{libcc-type}" "--" "libcc-type" -- addr ) |
|
true to is-funptr? parse-function-types ; |
|
|
: type-letter ( n -- c ) |
: type-letter ( n -- c ) |
chars s" nadrfv" drop + c@ ; |
chars s" nadrfv" drop + c@ ; |
Line 369 create gen-par-types
|
Line 397 create gen-par-types
|
|
|
\ the call itself |
\ the call itself |
|
|
: gen-wrapped-call { d: pars d: c-name fp-change1 sp-change1 -- } |
: gen-wrapped-func { d: pars d: c-name fp-change1 sp-change1 -- } |
c-name type ." (" |
c-name type ." (" |
fp-change1 sp-change1 pars over + swap u+do |
fp-change1 sp-change1 pars over + swap u+do |
i c@ gen-par |
i c@ gen-par |
Line 379 create gen-par-types
|
Line 407 create gen-par-types
|
loop |
loop |
2drop ." )" ; |
2drop ." )" ; |
|
|
|
: gen-wrapped-const { d: pars d: c-name fp-change1 sp-change1 -- } |
|
." (" c-name type ." )" ; |
|
|
|
: gen-wrapped-var { d: pars d: c-name fp-change1 sp-change1 -- } |
|
." &(" c-name type ." )" ; |
|
|
|
create gen-call-types |
|
' gen-wrapped-func , |
|
' gen-wrapped-const , |
|
' gen-wrapped-var , |
|
|
|
: gen-wrapped-call ( pars c-name fp-change1 sp-change1 -- ) |
|
5 pick 3 chars - c@ cells gen-call-types + @ execute ; |
|
|
\ calls for various kinds of return values |
\ calls for various kinds of return values |
|
|
: gen-wrapped-void ( pars c-name fp-change1 sp-change1 -- fp-change sp-change ) |
: gen-wrapped-void ( pars c-name fp-change1 sp-change1 -- fp-change sp-change ) |
Line 411 create gen-wrapped-types
|
Line 453 create gen-wrapped-types
|
: gen-wrapped-stmt ( pars c-name fp-change1 sp-change1 ret -- fp-change sp-change ) |
: gen-wrapped-stmt ( pars c-name fp-change1 sp-change1 ret -- fp-change sp-change ) |
cells gen-wrapped-types + @ execute ; |
cells gen-wrapped-types + @ execute ; |
|
|
|
: sanitize ( addr u -- ) |
|
bounds ?DO |
|
I c@ |
|
dup 'a' 'z' 1+ within |
|
over 'A' 'Z' 1+ within or |
|
over '0' '9' 1+ within or |
|
swap '_' = or 0= IF '_' I c! THEN |
|
LOOP ; |
|
|
: wrapper-function-name ( addr -- c-addr u ) |
: wrapper-function-name ( addr -- c-addr u ) |
\ addr points to the return type index of a c-function descriptor |
\ addr points to the return type index of a c-function descriptor |
count { r-type } count { d: pars } |
count { r-type } count { d: pars } |
Line 424 create gen-wrapped-types
|
Line 475 create gen-wrapped-types
|
i c@ type-letter front-char |
i c@ type-letter front-char |
loop |
loop |
'_ front-char r-type type-letter front-char assert( dup 0= ) |
'_ front-char r-type type-letter front-char assert( dup 0= ) |
2drop c-addr u ; |
2drop c-addr u 2dup sanitize ; |
|
|
: gen-wrapper-function ( addr -- ) |
: gen-wrapper-function ( addr -- ) |
\ addr points to the return type index of a c-function descriptor |
\ addr points to the return type index of a c-function descriptor |
dup { descriptor } |
dup { descriptor } |
count { ret } count 2dup { d: pars } chars + count { d: c-name } |
count { ret } count 2dup { d: pars } chars + count { d: c-name } |
." void " lib-modulename 2@ type ." _LTX_" descriptor wrapper-function-name 2dup type drop free throw |
." void " |
.\" (void)\n" |
[ lib-suffix s" .la" str= [IF] ] lib-prefix type lib-modulename 2@ type ." _LTX_" [ [THEN] ] |
|
descriptor wrapper-function-name 2dup type drop free throw |
|
.\" (GFORTH_ARGS)\n" |
.\" {\n Cell MAYBE_UNUSED *sp = gforth_SP;\n Float MAYBE_UNUSED *fp = gforth_FP;\n " |
.\" {\n Cell MAYBE_UNUSED *sp = gforth_SP;\n Float MAYBE_UNUSED *fp = gforth_FP;\n " |
|
is-funptr? IF .\" Cell ptr = *gforth_SP++;\n " 0 to is-funptr? THEN |
pars c-name 2over count-stacks ret gen-wrapped-stmt .\" ;\n" |
pars c-name 2over count-stacks ret gen-wrapped-stmt .\" ;\n" |
?dup-if |
?dup-if |
." gforth_SP = sp+" .nb .\" ;\n" |
." gforth_SP = sp+" .nb .\" ;\n" |
Line 468 create gen-wrapped-types
|
Line 522 create gen-wrapped-types
|
libcc-named-dir-v 2@ ; |
libcc-named-dir-v 2@ ; |
|
|
: libcc-tmp-dir ( -- c-addr u ) |
: libcc-tmp-dir ( -- c-addr u ) |
s" ~/.gforth/libcc-tmp/" ; |
s" ~/.gforth" arch-modifier s+ s" /libcc-tmp/" s+ ; |
|
|
: prepend-dirname ( c-addr1 u1 c-addr2 u2 -- c-addr3 u3 ) |
: prepend-dirname ( c-addr1 u1 c-addr2 u2 -- c-addr3 u3 ) |
2over s+ 2swap drop free throw ; |
2over s+ 2swap drop free throw ; |
|
|
: open-wrappers ( -- addr|0 ) |
: open-wrappers ( -- addr|0 ) |
lib-filename 2@ s" .la" s+ |
lib-filename 2@ dirname lib-prefix s+ |
|
lib-filename 2@ basename append lib-suffix append |
2dup libcc-named-dir string-prefix? if ( c-addr u ) |
2dup libcc-named-dir string-prefix? if ( c-addr u ) |
\ see if we can open it in the path |
\ see if we can open it in the path |
libcc-named-dir nip /string |
libcc-named-dir nip /string |
Line 490 create gen-wrapped-types
|
Line 545 create gen-wrapped-types
|
assert( c-source-file-id @ 0= ) |
assert( c-source-file-id @ 0= ) |
{ d: filename } |
{ d: filename } |
here 0 , lib-handle-addr ! filename lib-filename 2! |
here 0 , lib-handle-addr ! filename lib-filename 2! |
filename basename lib-modulename 2! ; |
filename basename lib-modulename 2! |
|
['] write-c-prefix-line is save-c-prefix-line ; |
|
|
: c-library-name-create ( -- ) |
: c-library-name-create ( -- ) |
lib-filename 2@ s" .c" s+ 2dup w/o create-file throw |
lib-filename 2@ s" .c" s+ 2dup w/o create-file throw |
dup c-source-file-id ! |
c-source-file-id ! |
['] print-c-prefix-lines swap outfile-execute |
|
drop free throw ; |
drop free throw ; |
|
|
: c-named-library-name ( c-addr u -- ) |
: c-named-library-name ( c-addr u -- ) |
Line 505 create gen-wrapped-types
|
Line 560 create gen-wrapped-types
|
open-wrappers dup if |
open-wrappers dup if |
lib-handle-addr @ ! |
lib-handle-addr @ ! |
else |
else |
|
libcc-named-dir $1ff mkdir-parents drop |
drop c-library-name-create |
drop c-library-name-create |
|
c-prefix-lines @ ['] print-c-prefix-line \ first line only |
|
c-source-file-id @ outfile-execute |
endif ; |
endif ; |
|
|
: c-tmp-library-name ( c-addr u -- ) |
: c-tmp-library-name ( c-addr u -- ) |
\ set up filenames for a new library; c-addr u is the basename of |
\ set up filenames for a new library; c-addr u is the basename of |
\ the library |
\ the library |
libcc-tmp-dir prepend-dirname c-library-name-setup c-library-name-create ; |
libcc-tmp-dir 2dup $1ff mkdir-parents drop |
|
prepend-dirname c-library-name-setup c-library-name-create |
|
['] print-c-prefix-lines c-source-file-id @ outfile-execute ; |
|
|
: lib-handle ( -- addr ) |
: lib-handle ( -- addr ) |
lib-handle-addr @ @ ; |
lib-handle-addr @ @ ; |
Line 553 DEFER compile-wrapper-function ( -- )
|
Line 613 DEFER compile-wrapper-function ( -- )
|
lib-handle 0= if |
lib-handle 0= if |
c-source-file close-file throw |
c-source-file close-file throw |
0 c-source-file-id ! |
0 c-source-file-id ! |
[ libtool-command s" --silent --mode=compile --tag=CC " s+ |
[ libtool-command s" --silent --tag=CC --mode=compile " s+ |
libtool-cc append s" -I " append |
libtool-cc append s" -I '" append |
s" includedir" getenv append ] sliteral |
s" includedir" getenv append s" '" append ] sliteral |
s" -O -c " s+ lib-filename 2@ append s" .c -o " append |
s" -O -c " s+ lib-filename 2@ append s" .c -o " append |
lib-filename 2@ append s" .lo" append ( c-addr u ) |
lib-filename 2@ append s" .lo" append ( c-addr u ) |
\ cr 2dup type |
\ 2dup type cr |
2dup system drop free throw $? abort" libtool compile failed" |
2dup system drop free throw $? abort" libtool compile failed" |
[ libtool-command s" --silent --mode=link --tag=CC " s+ |
[ libtool-command s" --silent --tag=CC --mode=link " s+ |
libtool-cc append s" -module -rpath " s+ ] sliteral |
libtool-cc append libtool-flags append s" -module -rpath " s+ ] sliteral |
lib-filename 2@ dirname replace-rpath s+ s" " append |
lib-filename 2@ dirname replace-rpath s+ s" " append |
lib-filename 2@ append s" .lo -o " append |
lib-filename 2@ append s" .lo -o " append |
lib-filename 2@ append s" .la" append ( c-addr u ) |
lib-filename 2@ dirname append lib-prefix append |
c-libs @ ['] append-l list-map |
lib-filename 2@ basename append s" .la" append ( c-addr u ) |
|
c-libs 2@ append |
\ 2dup type cr |
\ 2dup type cr |
2dup system drop free throw $? abort" libtool link failed" |
2dup system drop free throw $? abort" libtool link failed" |
open-wrappers dup 0= if |
open-wrappers dup 0= if |
Line 585 DEFER compile-wrapper-function ( -- )
|
Line 646 DEFER compile-wrapper-function ( -- )
|
endif |
endif |
wrapper-name drop free throw ; |
wrapper-name drop free throw ; |
|
|
: c-function-ft ( xt-defr xt-cfr "c-name" "{libcc-type}" "--" "libcc-type" -- ) |
: c-function-ft ( xt-defr xt-cfr xt-parse "c-name" "type signature" -- ) |
\ build time/first time action for c-function |
\ build time/first time action for c-function |
init-c-source-file |
{ xt-parse-types } init-c-source-file |
noname create 2, lib-handle-addr @ , |
noname create 2, lib-handle-addr @ , |
parse-name { d: c-name } |
parse-name { d: c-name } |
here parse-function-types c-name string, |
xt-parse-types execute c-name string, |
['] gen-wrapper-function c-source-file-execute |
['] gen-wrapper-function c-source-file-execute |
does> ( ... -- ... ) |
does> ( ... -- ... ) |
dup 2@ { xt-defer xt-cfr } |
dup 2@ { xt-defer xt-cfr } |
Line 608 DEFER compile-wrapper-function ( -- )
|
Line 669 DEFER compile-wrapper-function ( -- )
|
does> ( ... -- ... ) |
does> ( ... -- ... ) |
@ call-c ; |
@ call-c ; |
|
|
: c-function ( "forth-name" "c-name" "@{type@}" "--" "type" -- ) \ gforth |
: (c-function) ( xt-parse "forth-name" "c-name" "{stack effect}" -- ) |
|
{ xt-parse-types } defer lastxt dup c-function-rt |
|
lastxt xt-parse-types c-function-ft |
|
lastxt swap defer! ; |
|
|
|
: c-function ( "forth-name" "c-name" "@{type@}" "---" "type" -- ) \ gforth |
\G Define a Forth word @i{forth-name}. @i{Forth-name} has the |
\G Define a Forth word @i{forth-name}. @i{Forth-name} has the |
\G specified stack effect and calls the C function @code{c-name}. |
\G specified stack effect and calls the C function @code{c-name}. |
defer lastxt dup c-function-rt lastxt c-function-ft |
['] parse-function-types (c-function) ; |
lastxt swap defer! ; |
|
|
: c-value ( "forth-name" "c-name" "---" "type" -- ) \ gforth |
|
\G Define a Forth word @i{forth-name}. @i{Forth-name} has the |
|
\G specified stack effect and gives the C value of @code{c-name}. |
|
['] parse-value-type (c-function) ; |
|
|
|
: c-variable ( "forth-name" "c-name" -- ) \ gforth |
|
\G Define a Forth word @i{forth-name}. @i{Forth-name} returns the |
|
\G address of @code{c-name}. |
|
['] parse-variable-type (c-function) ; |
|
|
|
: c-funptr ( "forth-name" "c-typecast" "@{type@}" "---" "type" -- ) \ gforth |
|
\G Define a Forth word @i{forth-name}. @i{Forth-name} has the |
|
\G specified stack effect and calls the C function pointer |
|
\G ptr using the typecast or struct access @code{c-typecast}. |
|
['] parse-funptr-types (c-function) ; |
|
|
: clear-libs ( -- ) \ gforth |
: clear-libs ( -- ) \ gforth |
\G Clear the list of libs |
\G Clear the list of libs |
c-source-file-id @ if |
c-source-file-id @ if |
compile-wrapper-function |
compile-wrapper-function |
endif |
endif |
0 c-libs ! ; |
0. c-libs 2! ; |
clear-libs |
clear-libs |
|
|
: c-library-incomplete ( -- ) |
: c-library-incomplete ( -- ) |
Line 637 clear-libs
|
Line 718 clear-libs
|
|
|
: end-c-library ( -- ) \ gforth |
: end-c-library ( -- ) \ gforth |
\G Finish and (if necessary) build the latest C library interface. |
\G Finish and (if necessary) build the latest C library interface. |
|
['] save-c-prefix-line1 is save-c-prefix-line |
['] compile-wrapper-function1 is compile-wrapper-function |
['] compile-wrapper-function1 is compile-wrapper-function |
compile-wrapper-function1 ; |
compile-wrapper-function1 ; |
|
|
: init-libcc ( -- ) |
: init-libcc ( -- ) |
s" ~/.gforth/libcc-named/" libcc-named-dir-v 2! |
s" ~/.gforth" arch-modifier s+ s" /libcc-named/" s+ libcc-named-dir-v 2! |
[IFDEF] make-path |
[IFDEF] $init |
make-path to libcc-path |
libcc-path $init |
libcc-named-dir libcc-path also-path |
libcc-named-dir libcc-path also-path |
[ s" libccdir" getenv ] sliteral libcc-path also-path |
[ s" libccdir" getenv ] sliteral libcc-path also-path |
[THEN] |
[THEN] |