Annotation of gforth/libcc.fs, revision 1.75

1.1       anton       1: \ libcc.fs     foreign function interface implemented using a C compiler
                      2: 
1.69      anton       3: \ Copyright (C) 2006,2007,2008,2009,2010,2011 Free Software Foundation, Inc.
1.1       anton       4: 
                      5: \ This file is part of Gforth.
                      6: 
                      7: \ Gforth is free software; you can redistribute it and/or
                      8: \ modify it under the terms of the GNU General Public License
1.28      anton       9: \ as published by the Free Software Foundation, either version 3
1.1       anton      10: \ of the License, or (at your option) any later version.
                     11: 
                     12: \ This program is distributed in the hope that it will be useful,
                     13: \ but WITHOUT ANY WARRANTY; without even the implied warranty of
                     14: \ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
                     15: \ GNU General Public License for more details.
                     16: 
                     17: \ You should have received a copy of the GNU General Public License
1.28      anton      18: \ along with this program. If not, see http://www.gnu.org/licenses/.
1.1       anton      19: 
                     20: 
                     21: \ What this implementation does is this: if it sees a declaration like
                     22: 
1.2       anton      23: \ \ something that tells it that the current library is libc
1.6       anton      24: \ \c #include <unistd.h>
1.2       anton      25: \ c-function dlseek lseek n d n -- d
1.1       anton      26: 
                     27: \ it genererates C code similar to the following:
                     28: 
                     29: \ #include <gforth.h>
1.2       anton      30: \ #include <unistd.h>
1.1       anton      31: \ 
1.2       anton      32: \ void gforth_c_lseek_ndn_d(void)
1.1       anton      33: \ {
                     34: \   Cell *sp = gforth_SP;
                     35: \   Float *fp = gforth_FP;
1.2       anton      36: \   long long result;  /* longest type in C */
                     37: \   gforth_ll2d(lseek(sp[3],gforth_d2ll(sp[2],sp[1]),sp[0]),sp[3],sp[2]);
                     38: \   gforth_SP = sp+2;
1.1       anton      39: \ }
                     40: 
                     41: \ Then it compiles this code and dynamically links it into the Gforth
                     42: \ system (batching and caching are future work).  It also dynamically
                     43: \ links lseek.  Performing DLSEEK then puts the function pointer of
1.2       anton      44: \ the function pointer of gforth_c_lseek_ndn_d on the stack and
                     45: \ calls CALL-C.
                     46: 
1.7       anton      47: \ ToDo:
                     48: 
                     49: \ Batching, caching and lazy evaluation:
                     50: 
                     51: \ Batching:
                     52: 
                     53: \ New words are deferred, and the corresponding C functions are
                     54: \ collected in one file, until the first word is EXECUTEd; then the
                     55: \ file is compiled and linked into the system, and the word is
                     56: \ resolved.
                     57: 
                     58: \ Caching:
                     59: 
                     60: \ Instead of compiling all this stuff anew for every execution, we
                     61: \ keep the files around and have an index file containing the function
                     62: \ names and their corresponding .so files.  If the needed wrapper name
                     63: \ is already present, it is just linked instead of generating the
                     64: \ wrapper again.  This is all done by loading the index file(s?),
                     65: \ which define words for the wrappers in a separate wordlist.
                     66: 
1.71      pazsan     67: \ The files are built in .../lib/gforth$ARCH/$VERSION/libcc/ or
                     68: \ ~/.gforth$ARCH/libcc/$HOST/.
1.7       anton      69: 
1.20      anton      70: \ Todo: conversion between function pointers and xts (both directions)
                     71: 
                     72: \ taking an xt and turning it into a function pointer:
                     73: 
                     74: \ e.g., assume we have the xt of + and want to create a C function int
                     75: \ gforth_callback_plus(int, int), and then pass the pointer to that
                     76: \ function:
                     77: 
                     78: \ There should be Forth code like this:
                     79: \   ] + 0 (bye)
                     80: \ Assume that the start of this code is START
                     81:         
                     82: \ Now, there should be a C function:
                     83: 
                     84: \ int gforth_callback_plus(int p1, int p2)
                     85: \ {
                     86: \   Cell   *sp = gforth_SP;
                     87: \   Float  *fp = gforth_FP;
                     88: \   Float  *fp = gforth_FP;
                     89: \   Address lp = gforth_LP;
                     90: \   sp -= 2;
                     91: \   sp[0] = p1;
                     92: \   sp[1] = p2;
                     93: \   gforth_engine(START, sp, rp, fp, lp);
                     94: \   sp += 1;
                     95: \   gforth_RP = rp;
                     96: \   gforth_SP = sp;
                     97: \   gforth_FP = fp;
                     98: \   gforth_LP = lp;
                     99: \   return sp[0];
                    100: \ }
                    101: 
                    102: \ and the pointer to that function is the C function pointer for the XT of +.
                    103: 
                    104: \ Future problems:
                    105: \   how to combine the Forth code generation with inlining
                    106: \   START is not a constant across executions (when caching the C files)
                    107: \      Solution: make START a variable, and store into it on startup with dlsym
                    108: 
                    109: \ Syntax:
                    110: \  callback <rettype> <params> <paramtypes> -- <rettype>
                    111: 
1.2       anton     112: 
                    113: \ data structures
                    114: 
1.10      anton     115: \ For every c-function, we have three words: two anonymous words
                    116: \ created by c-function-ft (first time) and c-function-rt (run-time),
                    117: \ and a named deferred word.  The deferred word first points to the
                    118: \ first-time word, then to the run-time word; the run-time word calls
                    119: \ the c function.
                    120: 
1.29      anton     121: [ifundef] parse-name
                    122:     ' parse-word alias parse-name
                    123: [then]
                    124: [ifundef] defer!
                    125: : defer! ( xt xt-deferred -- ) \ gforth  defer-store
                    126: \G Changes the @code{defer}red word @var{xt-deferred} to execute @var{xt}.
                    127:     >body [ has? rom [IF] ] @ [ [THEN] ] ! ;
                    128: [then]
                    129: 
                    130: \ : delete-file 2drop 0 ;
1.12      anton     131: 
                    132: require struct.fs
1.56      anton     133: require mkdir.fs
1.12      anton     134: 
1.10      anton     135: \ c-function-ft word body:
1.12      anton     136: struct
                    137:     cell% field cff-cfr \ xt of c-function-rt word
                    138:     cell% field cff-deferred \ xt of c-function deferred word
                    139:     cell% field cff-lha \ address of the lib-handle for the lib that
                    140:                         \ contains the wrapper function of the word
1.62      pazsan    141:     char% field cff-ctype  \ call type (function=1, value=0)
1.12      anton     142:     char% field cff-rtype  \ return type
                    143:     char% field cff-np     \ number of parameters
                    144:     1 0   field cff-ptypes \ #npar parameter types
                    145:     \  counted string: c-name
                    146: end-struct cff%
                    147: 
1.14      anton     148: variable c-source-file-id \ contains the source file id of the current batch
                    149: 0 c-source-file-id !
                    150: variable lib-handle-addr \ points to the library handle of the current batch.
                    151:                          \ the library handle is 0 if the current
                    152:                          \ batch is not yet compiled.
1.39      anton     153:   here 0 , lib-handle-addr ! \ just make sure LIB-HANDLE always works
1.23      anton     154: 2variable lib-filename   \ filename without extension
                    155: 2variable lib-modulename \ basename of the file without extension
1.44      anton     156: 2variable libcc-named-dir-v \ directory for named libcc wrapper libraries
1.65      pazsan    157: Variable libcc-path      \ pointer to path of library directories
1.2       anton     158: 
1.49      anton     159: defer replace-rpath ( c-addr1 u1 -- c-addr2 u2 )
                    160: ' noop is replace-rpath
1.35      anton     161: 
1.3       anton     162: : .nb ( n -- )
1.2       anton     163:     0 .r ;
                    164: 
                    165: : const+ ( n1 "name" -- n2 )
                    166:     dup constant 1+ ;
                    167: 
1.10      anton     168: : front-string { c-addr1 u1 c-addr2 u2 -- c-addr3 u3 }
                    169:     \ insert string c-addr2 u2 in buffer c-addr1 u1; c-addr3 u3 is the
                    170:     \ remainder of the buffer.
                    171:     assert( u1 u2 u>= )
                    172:     c-addr2 c-addr1 u2 move
                    173:     c-addr1 u1 u2 /string ;
                    174: 
                    175: : front-char { c-addr1 u1 c -- c-addr3 u2 }
                    176:     \ insert c in buffer c-addr1 u1; c-addr3 u3 is the remainder of
                    177:     \ the buffer.
                    178:     assert( u1 0 u> )
                    179:     c c-addr1 c!
                    180:     c-addr1 u1 1 /string ;
                    181: 
1.15      anton     182: : s+ { addr1 u1 addr2 u2 -- addr u }
                    183:     u1 u2 + allocate throw { addr }
                    184:     addr1 addr u1 move
                    185:     addr2 addr u1 + u2 move
                    186:     addr u1 u2 +
                    187: ;
                    188: 
                    189: : append { addr1 u1 addr2 u2 -- addr u }
                    190:     addr1 u1 u2 + dup { u } resize throw { addr }
                    191:     addr2 addr u1 + u2 move
                    192:     addr u ;
                    193: 
1.6       anton     194: \ linked list stuff (should go elsewhere)
                    195: 
                    196: struct
                    197:     cell% field list-next
                    198:     1 0   field list-payload
                    199: end-struct list%
                    200: 
                    201: : list-insert { node list -- }
                    202:     list list-next @ node list-next !
                    203:     node list list-next ! ;
                    204: 
                    205: : list-append { node endlistp -- }
                    206:     \ insert node at place pointed to by endlistp
                    207:     node endlistp @ list-insert
                    208:     node list-next endlistp ! ;
                    209: 
                    210: : list-map ( ... list xt -- ... )
                    211:     \ xt ( ... node -- ... )
                    212:     { xt } begin { node }
                    213:        node while
                    214:            node xt execute
                    215:            node list-next @
                    216:     repeat ;
                    217: 
1.59      pazsan    218: 2variable c-libs \ library names in a string (without "lib")
1.33      anton     219: 
1.74      pazsan    220: : lib-prefix ( -- addr u )  s" libgf" ;
                    221: 
1.53      anton     222: : add-lib ( c-addr u -- ) \ gforth
1.33      anton     223: \G Add library lib@i{string} to the list of libraries, where
1.59      pazsan    224:     \G @i{string} is represented by @i{c-addr u}.
                    225:     c-libs 2@ d0= IF  0 allocate throw 0 c-libs 2!  THEN
                    226:     c-libs 2@ s"  -l" append 2swap append c-libs 2! ;
                    227: 
                    228: : add-libpath ( c-addr u -- ) \ gforth
                    229: \G Add path @i{string} to the list of library search pathes, where
                    230:     \G @i{string} is represented by @i{c-addr u}.
                    231:     c-libs 2@ d0= IF  0 allocate throw 0 c-libs 2!  THEN
                    232:     c-libs 2@ s"  -L" append 2swap append c-libs 2! ;
1.33      anton     233: 
1.6       anton     234: \ C prefix lines
                    235: 
                    236: \ linked list of longcstrings: [ link | count-cell | characters ]
                    237: 
                    238: list%
                    239:     cell% field c-prefix-count
                    240:     1 0   field c-prefix-chars
                    241: end-struct c-prefix%
                    242: 
                    243: variable c-prefix-lines 0 c-prefix-lines !
                    244: variable c-prefix-lines-end c-prefix-lines c-prefix-lines-end !
                    245: 
1.14      anton     246: : print-c-prefix-line ( node -- )
                    247:     dup c-prefix-chars swap c-prefix-count @ type cr ;
                    248: 
                    249: : print-c-prefix-lines ( -- )
                    250:     c-prefix-lines @ ['] print-c-prefix-line list-map ;
                    251: 
1.61      anton     252: : write-c-prefix-line ( c-addr u -- )
                    253:     c-source-file-id @ dup if
                    254:        write-line throw
                    255:     else
                    256:        drop 2drop
                    257:     then ;
1.60      pazsan    258: 
1.61      anton     259: : save-c-prefix-line1 ( c-addr u -- )
                    260:     2dup write-c-prefix-line
1.6       anton     261:     align here 0 , c-prefix-lines-end list-append ( c-addr u )
                    262:     longstring, ;
                    263: 
1.61      anton     264: defer save-c-prefix-line ( c-addr u -- )
                    265: ' save-c-prefix-line1 is save-c-prefix-line
                    266: 
1.18      anton     267: : \c ( "rest-of-line" -- ) \ gforth backslash-c
1.17      anton     268:     \G One line of C declarations for the C interface
1.6       anton     269:     -1 parse save-c-prefix-line ;
                    270: 
1.73      pazsan    271: s" #include <gforth" arch-modifier s+ s" /" append version-string append s" /libcc.h>" append ( c-addr u )
1.19      anton     272:   2dup save-c-prefix-line drop free throw
1.5       anton     273: 
1.6       anton     274: \ Types (for parsing)
1.5       anton     275: 
1.2       anton     276: wordlist constant libcc-types
                    277: 
                    278: get-current libcc-types set-current
                    279: 
                    280: \ index values
                    281: -1
                    282: const+ -- \ end of arguments
                    283: const+ n \ integer cell
1.5       anton     284: const+ a \ address cell
1.2       anton     285: const+ d \ double
                    286: const+ r \ float
                    287: const+ func \ C function pointer
                    288: const+ void
                    289: drop
                    290: 
                    291: set-current
                    292: 
1.62      pazsan    293: \ call types
                    294: 0
                    295: const+ c-func
                    296: const+ c-val
                    297: const+ c-var
                    298: drop
                    299: 
                    300: : libcc-type ( c-addr u -- u2 )
                    301:        libcc-types search-wordlist 0= -13 and throw execute ;
                    302: 
                    303: : parse-libcc-type ( "libcc-type" -- u )  parse-name libcc-type ;
1.2       anton     304: 
1.62      pazsan    305: : parse-return-type ( "libcc-type" -- u )
                    306:        parse-libcc-type dup 0< -32 and throw ;
                    307: 
                    308: : parse-function-types ( "{libcc-type}" "--" "libcc-type" -- addr )
                    309:     c-func c, here
                    310:     dup 2 chars allot here begin
1.2       anton     311:        parse-libcc-type dup 0>= while
                    312:            c,
                    313:     repeat
1.3       anton     314:     drop here swap - over char+ c!
1.62      pazsan    315:     parse-return-type swap c! ;
                    316: 
                    317: : parse-value-type ( "{--}" "libcc-type" -- addr )
                    318:     c-val c, here
                    319:     parse-libcc-type  dup 0< if drop parse-return-type then
                    320:     c,  0 c, ;
                    321: 
                    322: : parse-variable-type ( -- addr )
1.75    ! pazsan    323:     c-var c, here
        !           324:     s" a" libcc-type c,  0 c, ;
        !           325: 
        !           326: 0 Value is-funptr?
        !           327: : parse-funptr-types ( "{libcc-type}" "--" "libcc-type" -- addr )
        !           328:     true to is-funptr?  parse-function-types ;
1.2       anton     329: 
                    330: : type-letter ( n -- c )
1.52      pazsan    331:     chars s" nadrfv" drop + c@ ;
1.2       anton     332: 
                    333: \ count-stacks
                    334: 
                    335: : count-stacks-n ( fp-change1 sp-change1 -- fp-change2 sp-change2 )
                    336:     1+ ;
                    337: 
1.5       anton     338: : count-stacks-a ( fp-change1 sp-change1 -- fp-change2 sp-change2 )
1.2       anton     339:     1+ ;
                    340: 
                    341: : count-stacks-d ( fp-change1 sp-change1 -- fp-change2 sp-change2 )
                    342:     2 + ;
                    343: 
                    344: : count-stacks-r ( fp-change1 sp-change1 -- fp-change2 sp-change2 )
                    345:     swap 1+ swap ;
                    346: 
                    347: : count-stacks-func ( fp-change1 sp-change1 -- fp-change2 sp-change2 )
                    348:     1+ ;
                    349: 
                    350: : count-stacks-void ( fp-change1 sp-change1 -- fp-change2 sp-change2 )
                    351: ;
                    352: 
                    353: create count-stacks-types
                    354: ' count-stacks-n ,
1.5       anton     355: ' count-stacks-a ,
1.2       anton     356: ' count-stacks-d ,
                    357: ' count-stacks-r ,
                    358: ' count-stacks-func ,
                    359: ' count-stacks-void ,
                    360: 
                    361: : count-stacks ( pars -- fp-change sp-change )
                    362:     \ pars is an addr u pair
                    363:     0 0 2swap over + swap u+do
1.3       anton     364:        i c@ cells count-stacks-types + @ execute
1.2       anton     365:     loop ;
                    366: 
                    367: \ gen-pars
                    368: 
                    369: : gen-par-n ( fp-depth1 sp-depth1 -- fp-depth2 sp-depth2 )
1.5       anton     370:     ." sp[" 1- dup .nb ." ]" ;
1.2       anton     371: 
1.5       anton     372: : gen-par-a ( fp-depth1 sp-depth1 -- fp-depth2 sp-depth2 )
1.2       anton     373:     ." (void *)(" gen-par-n ." )" ;
                    374: 
                    375: : gen-par-d ( fp-depth1 sp-depth1 -- fp-depth2 sp-depth2 )
1.4       anton     376:     ." gforth_d2ll(" gen-par-n ." ," gen-par-n ." )" ;
1.2       anton     377: 
                    378: : gen-par-r ( fp-depth1 sp-depth1 -- fp-depth2 sp-depth2 )
1.3       anton     379:     swap 1- tuck ." fp[" .nb ." ]" ;
1.2       anton     380: 
                    381: : gen-par-func ( fp-depth1 sp-depth1 -- fp-depth2 sp-depth2 )
1.5       anton     382:     gen-par-a ;
1.2       anton     383: 
                    384: : gen-par-void ( fp-depth1 sp-depth1 -- fp-depth2 sp-depth2 )
                    385:     -32 throw ;
                    386: 
                    387: create gen-par-types
                    388: ' gen-par-n ,
1.5       anton     389: ' gen-par-a ,
1.2       anton     390: ' gen-par-d ,
                    391: ' gen-par-r ,
                    392: ' gen-par-func ,
                    393: ' gen-par-void ,
                    394: 
                    395: : gen-par ( fp-depth1 sp-depth1 partype -- fp-depth2 sp-depth2 )
1.3       anton     396:     cells gen-par-types + @ execute ;
1.2       anton     397: 
                    398: \ the call itself
                    399: 
1.62      pazsan    400: : gen-wrapped-func { d: pars d: c-name fp-change1 sp-change1 -- }
1.2       anton     401:     c-name type ." ("
1.3       anton     402:     fp-change1 sp-change1 pars over + swap u+do 
1.2       anton     403:        i c@ gen-par
                    404:        i 1+ i' < if
                    405:            ." ,"
                    406:        endif
                    407:     loop
                    408:     2drop ." )" ;
                    409: 
1.62      pazsan    410: : gen-wrapped-const { d: pars d: c-name fp-change1 sp-change1 -- }
                    411:        ." (" c-name type ." )" ;
                    412: 
                    413: : gen-wrapped-var { d: pars d: c-name fp-change1 sp-change1 -- }
                    414:        ." &(" c-name type ." )" ;
                    415: 
                    416: create gen-call-types
                    417: ' gen-wrapped-func ,
                    418: ' gen-wrapped-const ,
                    419: ' gen-wrapped-var ,
                    420: 
                    421: : gen-wrapped-call ( pars c-name fp-change1 sp-change1 -- )
                    422:        5 pick 3 chars - c@ cells gen-call-types + @ execute ;
                    423: 
1.2       anton     424: \ calls for various kinds of return values
                    425: 
                    426: : gen-wrapped-void ( pars c-name fp-change1 sp-change1 -- fp-change sp-change )
                    427:     2dup 2>r gen-wrapped-call 2r> ;
                    428: 
1.3       anton     429: : gen-wrapped-n ( pars c-name fp-change1 sp-change1 -- fp-change sp-change )
1.5       anton     430:     2dup gen-par-n 2>r ." =" gen-wrapped-call 2r> ;
1.3       anton     431: 
1.5       anton     432: : gen-wrapped-a ( pars c-name fp-change1 sp-change1 -- fp-change sp-change )
                    433:     2dup gen-par-n 2>r ." =(Cell)" gen-wrapped-call 2r> ;
1.3       anton     434: 
                    435: : gen-wrapped-d ( pars c-name fp-change1 sp-change1 -- fp-change sp-change )
                    436:     ." gforth_ll2d(" gen-wrapped-void
1.5       anton     437:     ." ," gen-par-n ." ," gen-par-n ." )" ;
1.3       anton     438: 
                    439: : gen-wrapped-r ( pars c-name fp-change1 sp-change1 -- fp-change sp-change )
1.30      anton     440:     2dup gen-par-r 2>r ." =" gen-wrapped-call 2r> ;
1.3       anton     441: 
                    442: : gen-wrapped-func ( pars c-name fp-change1 sp-change1 -- fp-change sp-change )
1.5       anton     443:     gen-wrapped-a ;
1.3       anton     444: 
1.2       anton     445: create gen-wrapped-types
                    446: ' gen-wrapped-n ,
1.5       anton     447: ' gen-wrapped-a ,
1.2       anton     448: ' gen-wrapped-d ,
                    449: ' gen-wrapped-r ,
                    450: ' gen-wrapped-func ,
                    451: ' gen-wrapped-void ,
                    452: 
                    453: : gen-wrapped-stmt ( pars c-name fp-change1 sp-change1 ret -- fp-change sp-change )
1.3       anton     454:     cells gen-wrapped-types + @ execute ;
1.2       anton     455: 
1.10      anton     456: : wrapper-function-name ( addr -- c-addr u )
                    457:     \ addr points to the return type index of a c-function descriptor
                    458:     count { r-type } count { d: pars }
                    459:     pars + count { d: c-name }
                    460:     s" gforth_c_" { d: prefix }
                    461:     prefix nip c-name nip + pars nip + 3 + { u }
                    462:     u allocate throw { c-addr }
                    463:     c-addr u
                    464:     prefix front-string c-name front-string '_ front-char
                    465:     pars bounds u+do
                    466:        i c@ type-letter front-char
                    467:     loop
                    468:     '_ front-char r-type type-letter front-char assert( dup 0= )
                    469:     2drop c-addr u ;
                    470: 
1.2       anton     471: : gen-wrapper-function ( addr -- )
                    472:     \ addr points to the return type index of a c-function descriptor
1.10      anton     473:     dup { descriptor }
1.13      anton     474:     count { ret } count 2dup { d: pars } chars + count { d: c-name }
1.70      pazsan    475:     ." void "
1.74      pazsan    476:     [ lib-suffix s" .la" str= [IF] ] lib-prefix type lib-modulename 2@ type ." _LTX_" [ [THEN] ]
1.70      pazsan    477:     descriptor wrapper-function-name 2dup type drop free throw
1.54      pazsan    478:     .\" (GFORTH_ARGS)\n"
1.4       anton     479:     .\" {\n  Cell MAYBE_UNUSED *sp = gforth_SP;\n  Float MAYBE_UNUSED *fp = gforth_FP;\n  "
1.75    ! pazsan    480:     is-funptr? IF  .\"   Cell ptr = *gforth_SP++;\n"  0 to is-funptr?  THEN
1.2       anton     481:     pars c-name 2over count-stacks ret gen-wrapped-stmt .\" ;\n"
                    482:     ?dup-if
1.3       anton     483:        ."   gforth_SP = sp+" .nb .\" ;\n"
1.2       anton     484:     endif
                    485:     ?dup-if
1.3       anton     486:        ."   gforth_FP = fp+" .nb .\" ;\n"
1.2       anton     487:     endif
1.3       anton     488:     .\" }\n" ;
1.2       anton     489: 
1.40      anton     490: : scan-back { c-addr u1 c -- c-addr u2 }
                    491:     \ the last occurence of c in c-addr u1 is at u2-1; if it does not
                    492:     \ occur, u2=0.
                    493:     c-addr 1- c-addr u1 + 1- u-do
                    494:        i c@ c = if
                    495:            c-addr i over - 1+ unloop exit endif
                    496:     1 -loop
                    497:     c-addr 0 ;
                    498: 
                    499: : dirname ( c-addr1 u1 -- c-addr2 u2 )
                    500:     \ directory name of the file name c-addr1 u1, including the final "/".
                    501:     '/ scan-back ;
                    502: 
                    503: : basename ( c-addr1 u1 -- c-addr2 u2 )
                    504:     \ file name without directory component
                    505:     2dup dirname nip /string ;
1.16      anton     506: 
1.15      anton     507: : gen-filename ( x -- c-addr u )
1.35      anton     508:     \ generates a file basename for lib-handle-addr X
1.16      anton     509:     0 <<# ['] #s $10 base-execute #> 
1.35      anton     510:     s" gforth_c_" 2swap s+ #>> ;
                    511: 
1.40      anton     512: : libcc-named-dir ( -- c-addr u )
1.43      anton     513:     libcc-named-dir-v 2@ ;
1.40      anton     514: 
                    515: : libcc-tmp-dir ( -- c-addr u )
1.71      pazsan    516:     s" ~/.gforth" arch-modifier s+ s" /libcc-tmp/" s+ ;
1.40      anton     517: 
                    518: : prepend-dirname ( c-addr1 u1 c-addr2 u2 -- c-addr3 u3 )
1.41      anton     519:     2over s+ 2swap drop free throw ;
1.35      anton     520: 
1.42      anton     521: : open-wrappers ( -- addr|0 )
1.74      pazsan    522:     lib-filename 2@ dirname lib-prefix s+
1.73      pazsan    523:     lib-filename 2@ basename append lib-suffix append
1.42      anton     524:     2dup libcc-named-dir string-prefix? if ( c-addr u )
                    525:        \ see if we can open it in the path
                    526:        libcc-named-dir nip /string
                    527:        libcc-path open-path-file if
                    528:            0 exit endif
                    529:        ( wfile-id c-addr2 u2 ) rot close-file throw save-mem ( c-addr2 u2 )
                    530:     endif
                    531:     \ 2dup cr type
                    532:     2dup open-lib >r
                    533:     drop free throw r> ;
                    534: 
1.39      anton     535: : c-library-name-setup ( c-addr u -- )
1.35      anton     536:     assert( c-source-file-id @ 0= )
1.40      anton     537:     { d: filename }
1.37      anton     538:     here 0 , lib-handle-addr ! filename lib-filename 2!
1.61      anton     539:     filename basename lib-modulename 2!
                    540:     ['] write-c-prefix-line is save-c-prefix-line ;
1.39      anton     541:    
                    542: : c-library-name-create ( -- )
                    543:     lib-filename 2@ s" .c" s+ 2dup w/o create-file throw
1.61      anton     544:     c-source-file-id !
                    545:     drop free throw ;
1.39      anton     546: 
1.40      anton     547: : c-named-library-name ( c-addr u -- )
1.39      anton     548:     \ set up filenames for a (possibly new) library; c-addr u is the
                    549:     \ basename of the library
1.40      anton     550:     libcc-named-dir prepend-dirname c-library-name-setup
1.37      anton     551:     open-wrappers dup if
                    552:        lib-handle-addr @ !
                    553:     else
1.56      anton     554:         libcc-named-dir $1ff mkdir-parents drop
1.39      anton     555:        drop c-library-name-create
1.61      anton     556:        c-prefix-lines @ ['] print-c-prefix-line \ first line only
                    557:        c-source-file-id @ outfile-execute
1.37      anton     558:     endif ;
                    559: 
1.40      anton     560: : c-tmp-library-name ( c-addr u -- )
1.39      anton     561:     \ set up filenames for a new library; c-addr u is the basename of
                    562:     \ the library
1.56      anton     563:     libcc-tmp-dir 2dup $1ff mkdir-parents drop
1.61      anton     564:     prepend-dirname c-library-name-setup c-library-name-create
                    565:     ['] print-c-prefix-lines c-source-file-id @ outfile-execute ;
1.39      anton     566: 
1.37      anton     567: : lib-handle ( -- addr )
                    568:     lib-handle-addr @ @ ;
1.15      anton     569: 
1.12      anton     570: : init-c-source-file ( -- )
1.37      anton     571:     lib-handle 0= if
                    572:        c-source-file-id @ 0= if
1.40      anton     573:            here gen-filename c-tmp-library-name
1.37      anton     574:        endif
1.12      anton     575:     endif ;
1.11      anton     576: 
                    577: : c-source-file ( -- file-id )
1.12      anton     578:     c-source-file-id @ assert( dup ) ;
1.11      anton     579: 
1.37      anton     580: : notype-execute ( ... xt -- ... )
                    581:     what's type { oldtype } try
                    582:        ['] 2drop is type execute 0
                    583:     restore
                    584:        oldtype is type
                    585:     endtry
                    586:     throw ;
                    587: 
                    588: : c-source-file-execute ( ... xt -- ... )
                    589:     \ direct the output of xt to c-source-file, or nothing
                    590:     lib-handle if
                    591:        notype-execute
                    592:     else
                    593:        c-source-file outfile-execute
                    594:     endif ;
                    595: 
1.24      anton     596: : .lib-error ( -- )
                    597:     [ifdef] lib-error
                    598:         ['] cr stderr outfile-execute
1.31      anton     599:         lib-error ['] type stderr outfile-execute
1.24      anton     600:     [then] ;
1.23      anton     601: 
1.33      anton     602: DEFER compile-wrapper-function ( -- )
1.35      anton     603: : compile-wrapper-function1 ( -- )
1.37      anton     604:     lib-handle 0= if
                    605:        c-source-file close-file throw
                    606:        0 c-source-file-id !
1.64      dvdkhlng  607:        [ libtool-command s"  --silent --tag=CC --mode=compile " s+
1.58      pazsan    608:          libtool-cc append s"  -I '" append
                    609:          s" includedir" getenv append  s" '" append ] sliteral
1.37      anton     610:        s"  -O -c " s+ lib-filename 2@ append s" .c -o " append
                    611:        lib-filename 2@ append s" .lo" append ( c-addr u )
1.55      pazsan    612:        \    2dup type cr
1.37      anton     613:        2dup system drop free throw $? abort" libtool compile failed"
1.64      dvdkhlng  614:        [ libtool-command s"  --silent --tag=CC --mode=link " s+
1.55      pazsan    615:          libtool-cc append libtool-flags append s"  -module -rpath " s+ ] sliteral
1.49      anton     616:        lib-filename 2@ dirname replace-rpath s+ s"  " append
1.37      anton     617:        lib-filename 2@ append s" .lo -o " append
1.74      pazsan    618:        lib-filename 2@ dirname append lib-prefix append
1.72      pazsan    619:        lib-filename 2@ basename append s" .la" append ( c-addr u )
1.59      pazsan    620:        c-libs 2@ append
1.47      pazsan    621:        \    2dup type cr
1.37      anton     622:        2dup system drop free throw $? abort" libtool link failed"
                    623:        open-wrappers dup 0= if
                    624:            .lib-error true abort" open-lib failed"
                    625:        endif
                    626:        ( lib-handle ) lib-handle-addr @ !
1.23      anton     627:     endif
1.35      anton     628:     lib-filename 2@ drop free throw 0 0 lib-filename 2! ;
                    629: ' compile-wrapper-function1 IS compile-wrapper-function
1.5       anton     630: \    s" ar rcs xxx.a xxx.o" system
                    631: \    $? abort" ar generated error" ;
                    632: 
1.12      anton     633: : link-wrapper-function { cff -- sym }
                    634:     cff cff-rtype wrapper-function-name { d: wrapper-name }
1.23      anton     635:     wrapper-name cff cff-lha @ @ assert( dup ) lib-sym dup 0= if
1.24      anton     636:         .lib-error -&32 throw
1.23      anton     637:     endif
1.10      anton     638:     wrapper-name drop free throw ;
1.8       anton     639: 
1.62      pazsan    640: : c-function-ft ( xt-defr xt-cfr xt-parse "c-name" "type signature" -- )
1.8       anton     641:     \ build time/first time action for c-function
1.62      pazsan    642:     { xt-parse-types } init-c-source-file
1.12      anton     643:     noname create 2, lib-handle-addr @ ,
1.2       anton     644:     parse-name { d: c-name }
1.62      pazsan    645:     xt-parse-types execute c-name string,
1.37      anton     646:     ['] gen-wrapper-function c-source-file-execute
1.8       anton     647:   does> ( ... -- ... )
1.10      anton     648:     dup 2@ { xt-defer xt-cfr }
1.12      anton     649:     dup cff-lha @ @ 0= if
                    650:        compile-wrapper-function
                    651:     endif
                    652:     link-wrapper-function xt-cfr >body !
1.8       anton     653:     xt-cfr xt-defer defer!
                    654:     xt-cfr execute ;
                    655: 
                    656: : c-function-rt ( -- )
                    657:     \ run-time definition for c function; addr is the address where
                    658:     \ the sym should be stored
                    659:     noname create 0 ,
1.2       anton     660:   does> ( ... -- ... )
                    661:     @ call-c ;
                    662: 
1.62      pazsan    663: : (c-function) ( xt-parse "forth-name" "c-name" "{stack effect}" -- )
                    664:     { xt-parse-types } defer lastxt dup c-function-rt
                    665:     lastxt xt-parse-types c-function-ft
                    666:     lastxt swap defer! ;
                    667: 
                    668: : c-function ( "forth-name" "c-name" "@{type@}" "---" "type" -- ) \ gforth
1.17      anton     669:     \G Define a Forth word @i{forth-name}.  @i{Forth-name} has the
                    670:     \G specified stack effect and calls the C function @code{c-name}.
1.62      pazsan    671:     ['] parse-function-types (c-function) ;
                    672: 
1.68      pazsan    673: : c-value ( "forth-name" "c-name" "---" "type" -- ) \ gforth
1.62      pazsan    674:     \G Define a Forth word @i{forth-name}.  @i{Forth-name} has the
                    675:     \G specified stack effect and gives the C value of @code{c-name}.
                    676:     ['] parse-value-type (c-function) ;
                    677: 
                    678: : c-variable ( "forth-name" "c-name" -- ) \ gforth
                    679:     \G Define a Forth word @i{forth-name}.  @i{Forth-name} returns the
                    680:     \G address of @code{c-name}.
                    681:     ['] parse-variable-type (c-function) ;
1.33      anton     682: 
1.75    ! pazsan    683: : c-funptr ( "forth-name" "c-typecast" "@{type@}" "---" "type" -- ) \ gforth
        !           684:     \G Define a Forth word @i{forth-name}.  @i{Forth-name} has the
        !           685:     \G specified stack effect and calls the C function pointer
        !           686:     \G ptr using the typecast or struct access @code{c-typecast}.
        !           687:     ['] parse-funptr-types (c-function) ;
        !           688: 
1.53      anton     689: : clear-libs ( -- ) \ gforth
1.33      anton     690: \G Clear the list of libs
                    691:     c-source-file-id @ if
                    692:        compile-wrapper-function
                    693:     endif
1.59      pazsan    694:     0. c-libs 2! ;
1.33      anton     695: clear-libs
1.35      anton     696: 
                    697: : c-library-incomplete ( -- )
                    698:     true abort" Called function of unfinished named C library" ;
                    699: 
                    700: : c-library-name ( c-addr u -- ) \ gforth
1.38      anton     701: \G Start a C library interface with name @i{c-addr u}.
1.35      anton     702:     clear-libs
                    703:     ['] c-library-incomplete is compile-wrapper-function
1.40      anton     704:     c-named-library-name ;
1.35      anton     705: 
                    706: : c-library ( "name" -- ) \ gforth
                    707: \G Parsing version of @code{c-library-name}
1.39      anton     708:     parse-name save-mem c-library-name ;
1.35      anton     709: 
1.38      anton     710: : end-c-library ( -- ) \ gforth
                    711: \G Finish and (if necessary) build the latest C library interface.
1.61      anton     712:     ['] save-c-prefix-line1 is save-c-prefix-line
1.35      anton     713:     ['] compile-wrapper-function1 is compile-wrapper-function
                    714:     compile-wrapper-function1 ;
1.43      anton     715: 
                    716: : init-libcc ( -- )
1.71      pazsan    717:     s" ~/.gforth" arch-modifier s+ s" /libcc-named/" s+ libcc-named-dir-v 2!
1.66      pazsan    718: [IFDEF] $init
                    719:     libcc-path $init
1.43      anton     720:     libcc-named-dir libcc-path also-path
                    721:     [ s" libccdir" getenv ] sliteral libcc-path also-path
1.45      pazsan    722: [THEN]
1.43      anton     723: ;
                    724: 
                    725: init-libcc
                    726: 
                    727: :noname ( -- )
                    728:     defers 'cold
                    729:     init-libcc ;
                    730: is 'cold

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>