version 1.37, 2008/06/17 20:48:21
|
version 1.63, 2009/12/31 15:32:35
|
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 Free Software Foundation, Inc. |
\ Copyright (C) 2006,2007,2008,2009 Free Software Foundation, Inc. |
|
|
\ This file is part of Gforth. |
\ This file is part of Gforth. |
|
|
Line 67
|
Line 67
|
\ The files are built in .../lib/gforth/$VERSION/libcc/ or |
\ The files are built in .../lib/gforth/$VERSION/libcc/ or |
\ ~/.gforth/libcc/$HOST/. |
\ ~/.gforth/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) |
|
|
\ taking an xt and turning it into a function pointer: |
\ taking an xt and turning it into a function pointer: |
Line 135
|
Line 130
|
\ : delete-file 2drop 0 ; |
\ : delete-file 2drop 0 ; |
|
|
require struct.fs |
require struct.fs |
|
require mkdir.fs |
|
|
\ counted-string |
|
|
|
\ c-function-ft word body: |
\ c-function-ft word body: |
struct |
struct |
cell% field cff-cfr \ xt of c-function-rt word |
cell% field cff-cfr \ xt of c-function-rt word |
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 155 variable c-source-file-id \ contains the
|
Line 150 variable c-source-file-id \ contains the
|
variable lib-handle-addr \ points to the library handle of the current batch. |
variable lib-handle-addr \ points to the library handle of the current batch. |
\ the library handle is 0 if the current |
\ the library handle is 0 if the current |
\ batch is not yet compiled. |
\ batch is not yet compiled. |
|
here 0 , lib-handle-addr ! \ just make sure LIB-HANDLE always works |
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 |
|
0 value libcc-path \ pointer to path of library directories |
|
|
: delete-file 2drop 0 ; |
defer replace-rpath ( c-addr1 u1 -- c-addr2 u2 ) |
|
' noop is replace-rpath |
|
|
: .nb ( n -- ) |
: .nb ( n -- ) |
0 .r ; |
0 .r ; |
Line 216 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") |
|
|
|
: add-lib ( c-addr u -- ) |
: 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 253 variable c-prefix-lines-end c-prefix-lin
|
Line 247 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 ; |
Line 286 drop
|
Line 288 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-function-types ( "{libcc-type}" "--" "libcc-type" -- ) |
: parse-return-type ( "libcc-type" -- u ) |
here 2 chars allot here begin |
parse-libcc-type dup 0< -32 and throw ; |
|
|
|
: parse-function-types ( "{libcc-type}" "--" "libcc-type" -- addr ) |
|
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, ; |
|
|
: type-letter ( n -- c ) |
: type-letter ( n -- c ) |
chars s" nadrfv" drop + c@ ; |
chars s" nadrfv" drop + c@ ; |
Line 367 create gen-par-types
|
Line 391 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 377 create gen-par-types
|
Line 401 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 429 create gen-wrapped-types
|
Line 467 create gen-wrapped-types
|
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 " lib-modulename 2@ type ." _LTX_" descriptor wrapper-function-name 2dup type drop free throw |
.\" (void)\n" |
.\" (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 " |
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 |
Line 440 create gen-wrapped-types
|
Line 478 create gen-wrapped-types
|
endif |
endif |
.\" }\n" ; |
.\" }\n" ; |
|
|
: open-wrappers ( -- addr ) |
: scan-back { c-addr u1 c -- c-addr u2 } |
lib-filename 2@ s" .la" s+ |
\ the last occurence of c in c-addr u1 is at u2-1; if it does not |
2dup open-lib >r |
\ occur, u2=0. |
drop free throw r> ; |
c-addr 1- c-addr u1 + 1- u-do |
|
i c@ c = if |
: tempdir ( -- c-addr u ) |
c-addr i over - 1+ unloop exit endif |
s" TMPDIR" getenv dup 0= if |
1 -loop |
2drop s" /tmp" |
c-addr 0 ; |
then ; |
|
|
: dirname ( c-addr1 u1 -- c-addr2 u2 ) |
|
\ directory name of the file name c-addr1 u1, including the final "/". |
|
'/ scan-back ; |
|
|
|
: basename ( c-addr1 u1 -- c-addr2 u2 ) |
|
\ file name without directory component |
|
2dup dirname nip /string ; |
|
|
: gen-filename ( x -- c-addr u ) |
: gen-filename ( x -- c-addr u ) |
\ generates a file basename for lib-handle-addr X |
\ generates a file basename for lib-handle-addr X |
0 <<# ['] #s $10 base-execute #> |
0 <<# ['] #s $10 base-execute #> |
s" gforth_c_" 2swap s+ #>> ; |
s" gforth_c_" 2swap s+ #>> ; |
|
|
: prepend-dirname ( c-addr1 u1 -- c-addr2 u2 ) |
: libcc-named-dir ( -- c-addr u ) |
tempdir s" /" s+ 2over append |
libcc-named-dir-v 2@ ; |
2swap drop free throw ; |
|
|
|
: c-library-name1 ( c-addr u -- ) |
: libcc-tmp-dir ( -- c-addr u ) |
\ set up filenames for a new library; c-addr u is the basename of |
s" ~/.gforth/libcc-tmp/" ; |
\ the library |
|
|
: prepend-dirname ( c-addr1 u1 c-addr2 u2 -- c-addr3 u3 ) |
|
2over s+ 2swap drop free throw ; |
|
|
|
: open-wrappers ( -- addr|0 ) |
|
lib-filename 2@ s" .la" s+ |
|
2dup libcc-named-dir string-prefix? if ( c-addr u ) |
|
\ see if we can open it in the path |
|
libcc-named-dir nip /string |
|
libcc-path open-path-file if |
|
0 exit endif |
|
( wfile-id c-addr2 u2 ) rot close-file throw save-mem ( c-addr2 u2 ) |
|
endif |
|
\ 2dup cr type |
|
2dup open-lib >r |
|
drop free throw r> ; |
|
|
|
: c-library-name-setup ( c-addr u -- ) |
assert( c-source-file-id @ 0= ) |
assert( c-source-file-id @ 0= ) |
prepend-dirname { d: filename } |
{ d: filename } |
here 0 , lib-handle-addr ! filename lib-filename 2! |
here 0 , lib-handle-addr ! filename lib-filename 2! |
filename tempdir nip 1+ /string lib-modulename 2! |
filename basename lib-modulename 2! |
|
['] write-c-prefix-line is save-c-prefix-line ; |
|
|
|
: c-library-name-create ( -- ) |
|
lib-filename 2@ s" .c" s+ 2dup w/o create-file throw |
|
c-source-file-id ! |
|
drop free throw ; |
|
|
|
: c-named-library-name ( c-addr u -- ) |
|
\ set up filenames for a (possibly new) library; c-addr u is the |
|
\ basename of the library |
|
libcc-named-dir prepend-dirname c-library-name-setup |
open-wrappers dup if |
open-wrappers dup if |
lib-handle-addr @ ! |
lib-handle-addr @ ! |
( 0 c-source-file-id ! ) \ already set |
|
else |
else |
drop |
libcc-named-dir $1ff mkdir-parents drop |
filename s" .c" s+ 2dup w/o create-file throw dup c-source-file-id ! |
drop c-library-name-create |
['] print-c-prefix-lines swap outfile-execute |
c-prefix-lines @ ['] print-c-prefix-line \ first line only |
drop free throw |
c-source-file-id @ outfile-execute |
endif ; |
endif ; |
|
|
|
: c-tmp-library-name ( c-addr u -- ) |
|
\ set up filenames for a new library; c-addr u is the basename of |
|
\ the library |
|
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 @ @ ; |
|
|
: init-c-source-file ( -- ) |
: init-c-source-file ( -- ) |
lib-handle 0= if |
lib-handle 0= if |
c-source-file-id @ 0= if |
c-source-file-id @ 0= if |
here gen-filename c-library-name1 |
here gen-filename c-tmp-library-name |
endif |
endif |
endif ; |
endif ; |
|
|
Line 516 DEFER compile-wrapper-function ( -- )
|
Line 594 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 gcc -I " s+ |
[ libtool-command s" --silent --mode=compile " s+ |
s" includedir" getenv append ] sliteral |
libtool-cc append s" -I '" append |
|
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 gcc -module -rpath " s+ ] sliteral |
[ libtool-command s" --silent --mode=link " s+ |
tempdir s+ s" " append |
libtool-cc append libtool-flags append s" -module -rpath " s+ ] sliteral |
|
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@ append s" .la" append ( c-addr u ) |
c-libs @ ['] append-l list-map |
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 546 DEFER compile-wrapper-function ( -- )
|
Line 626 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 569 DEFER compile-wrapper-function ( -- )
|
Line 649 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) ; |
|
|
: clear-libs ( -- ) |
: 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) ; |
|
|
|
: 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 ( -- ) |
true abort" Called function of unfinished named C library" ; |
true abort" Called function of unfinished named C library" ; |
|
|
: c-library-name ( c-addr u -- ) \ gforth |
: c-library-name ( c-addr u -- ) \ gforth |
\G Start a C library with name @i{c-addr u}. |
\G Start a C library interface with name @i{c-addr u}. |
clear-libs |
clear-libs |
['] c-library-incomplete is compile-wrapper-function |
['] c-library-incomplete is compile-wrapper-function |
c-library-name1 ; |
c-named-library-name ; |
|
|
: c-library ( "name" -- ) \ gforth |
: c-library ( "name" -- ) \ gforth |
\G Parsing version of @code{c-library-name} |
\G Parsing version of @code{c-library-name} |
name save-mem c-library-name ; |
parse-name save-mem c-library-name ; |
|
|
: end-c-library ( -- ) |
: end-c-library ( -- ) \ gforth |
|
\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 ( -- ) |
|
s" ~/.gforth/libcc-named/" libcc-named-dir-v 2! |
|
[IFDEF] make-path |
|
make-path to libcc-path |
|
libcc-named-dir libcc-path also-path |
|
[ s" libccdir" getenv ] sliteral libcc-path also-path |
|
[THEN] |
|
; |
|
|
|
init-libcc |
|
|
|
:noname ( -- ) |
|
defers 'cold |
|
init-libcc ; |
|
is 'cold |