--- gforth/prims2x.fs	2001/02/08 21:30:08	1.79
+++ gforth/prims2x.fs	2001/06/16 22:53:36	1.98
@@ -40,24 +40,27 @@
 \ add the store optimization for doubles
 \ regarding problem 1 above: It would be better (for over) to implement
 \ 	the alternative
+\ store optimization for combined instructions.
 
-warnings off
+\ Design Uglyness:
 
-[IFUNDEF] vocabulary	\ we are executed just with kernel image
-			\ load the rest that is needed
-			\ (require fails because this file is needed from a
-			\ different directory with the wordlibraries)
-include ./search.fs			
-include ./extend.fs
-[THEN]
-include ./stuff.fs
+\ - global state (values, variables) in connection with combined instructions.
+
+\ - index computation is different for instruction-stream and the
+\ stacks; there are two mechanisms for dealing with that
+\ (stack-in-index-xt and a test for stack==instruction-stream); there
+\ should be only one.
 
-[IFUNDEF] environment?
-include ./environ.fs
+warnings off
+
+[IFUNDEF] try
+include startup.fs
 [THEN]
 
 : struct% struct ; \ struct is redefined in gray
 
+warnings off
+
 include ./gray.fs
 
 32 constant max-effect \ number of things on one side of a stack effect
@@ -90,6 +93,13 @@ skipsynclines on
     loop
     drop ;
 
+: insert-wordlist { c-addr u wordlist xt -- }
+    \ adds name "addr u" to wordlist using defining word xt
+    \ xt may cause additional stack effects
+    get-current >r wordlist set-current
+    c-addr u nextname xt execute
+    r> set-current ;
+
 : start ( -- addr )
  cookedinput @ ;
 
@@ -120,14 +130,10 @@ skipsynclines on
 variable output          \ xt ( -- ) of output word for simple primitives
 variable output-combined \ xt ( -- ) of output word for combined primitives
 
-: printprim ( -- )
- output @ execute ;
-
 struct%
     cell%    field stack-number \ the number of this stack
     cell% 2* field stack-pointer \ stackpointer name
     cell%    field stack-type \ name for default type of stack items
-    cell% 2* field stack-cast \ cast string for assignments to stack elements
     cell%    field stack-in-index-xt \ ( in-size item -- in-index )
 end-struct stack%
 
@@ -156,15 +162,22 @@ create stacks max-stacks cells allot \ a
 : inst-in-index ( in-size item -- in-index )
     nip dup item-offset @ swap item-type @ type-size @ + 1- ;
 
-: make-stack ( addr-ptr u1 type addr-cast u2 "stack-name" -- )
+: make-stack ( addr-ptr u1 type "stack-name" -- )
+    next-stack-number @ max-stacks < s" too many stacks" ?print-error
     create stack% %allot >r
     r@ stacks next-stack-number @ th !
-    next-stack-number @ r@ stack-number !  1 next-stack-number +!
-    save-mem r@ stack-cast 2!
+    next-stack-number @ r@ stack-number !
+    1 next-stack-number +!
     r@ stack-type !
     save-mem r@ stack-pointer 2! 
     ['] stack-in-index r> stack-in-index-xt ! ;
 
+: map-stacks { xt -- }
+    \ perform xt for all stacks except inst-stream
+    next-stack-number @ 1 +do
+	stacks i th @ xt execute
+    loop ;
+
 \ stack items
 
 : init-item ( addr u addr1 -- )
@@ -194,6 +207,7 @@ struct%
     cell% 2* field prim-c-code
     cell% 2* field prim-forth-code
     cell% 2* field prim-stack-string
+    cell%    field prim-num            \ ordinal number
     cell%    field prim-items-wordlist \ unique items
     item% max-effect * field prim-effect-in
     item% max-effect * field prim-effect-out
@@ -217,6 +231,9 @@ variable in-part \ true if processing a
 create combined-prims max-combined cells allot
 variable num-combined
 
+table constant combinations
+  \ the keys are the sequences of pointers to primitives
+
 create current-depth max-stacks cells allot
 create max-depth     max-stacks cells allot
 create min-depth     max-stacks cells allot
@@ -224,10 +241,7 @@ create min-depth     max-stacks cells al
 wordlist constant primitives
 
 : create-prim ( prim -- )
-    get-current >r
-    primitives set-current
-    dup prim-name 2@ nextname constant
-    r> set-current ;
+    dup prim-name 2@ primitives ['] constant insert-wordlist ;
 
 : stack-in ( stack -- addr )
     \ address of number of stack items in effect in
@@ -253,8 +267,7 @@ Variable function-number 0 function-numb
 : complement ( set1 -- set2 )
  empty ['] bit-equivalent binary-set-operation ;
 
-\ types
-
+\ stack access stuff
 
 : normal-stack-access ( n stack -- )
     stack-pointer 2@ type
@@ -265,12 +278,21 @@ Variable function-number 0 function-numb
 	drop ." TOS"
     endif ;
 
+\ forward declaration for inst-stream (breaks cycle in definitions)
+defer inst-stream-f ( -- stack )
+
 : part-stack-access { n stack -- }
-    \ print _<stack><x>, x=maxdepth-currentdepth-n-1
+    \ print _<stack><x>, x=inst-stream? n : maxdepth-currentdepth-n-1
     ." _" stack stack-pointer 2@ type
     stack stack-number @ { stack# }
-    combined prim-stacks-in stack# th @ assert( dup max-depth stack# th @ = )
-    current-depth stack# th @ - n - 1-
+    current-depth stack# th @ n + { access-depth }
+    stack inst-stream-f = if
+	access-depth
+    else
+	combined prim-stacks-in stack# th @
+	assert( dup max-depth stack# th @ = )
+	access-depth - 1-
+    endif
     0 .r ;
 
 : stack-access ( n stack -- )
@@ -402,7 +424,8 @@ wordlist constant prefixes
     rdrop ;
 
 : type-prefix ( xt1 xt2 n stack "prefix" -- )
-    create-type
+    get-current >r prefixes set-current
+    create-type r> set-current
 does> ( item -- )
     \ initialize item
     { item typ }
@@ -428,7 +451,7 @@ does> ( item -- )
 	endif
 	-1 s+loop
     \ we did not find a type, abort
-    true abort" unknown prefix" ;
+    false s" unknown prefix" ?print-error ;
 
 : declaration ( item -- )
     dup item-name 2@ execute-prefix ;
@@ -452,7 +475,9 @@ does> ( item -- )
     prim prim-effect-out prim prim-effect-out-end @ ['] print-declaration map-items ;
     
 : stack-prefix ( stack "prefix" -- )
+    get-current >r prefixes set-current
     name tuck nextname create ( stack length ) 2,
+    r> set-current
 does> ( item -- )
     2@ { item stack prefix-length }
     item item-name 2@ prefix-length /string item item-name 2!
@@ -460,14 +485,26 @@ does> ( item -- )
     item declaration ;
 
 \ types pointed to by stacks for use in combined prims
-s" Cell"  single 0 create-type cell-type
-s" Float" single 0 create-type float-type
+\ !! output-c-combined shouldn't use these names!
+: stack-type-name ( addr u "name" -- )
+    single 0 create-type ;
+
+wordlist constant type-names \ this is here just to meet the requirement
+                    \ that a type be a word; it is never used for lookup
+
+: stack ( "name" "stack-pointer" "type" -- )
+    \ define stack
+    name { d: stack-name }
+    name { d: stack-pointer }
+    name { d: stack-type }
+    get-current type-names set-current
+    stack-type 2dup nextname stack-type-name
+    set-current
+    stack-pointer lastxt >body stack-name nextname make-stack ;
 
-s" sp" save-mem cell-type  s" (Cell)" make-stack data-stack 
-s" fp" save-mem float-type s" "       make-stack fp-stack
-s" rp" save-mem cell-type  s" (Cell)" make-stack return-stack
-s" IP" save-mem cell-type  s" error don't use # on results" make-stack inst-stream
+stack inst-stream IP Cell
 ' inst-in-index inst-stream stack-in-index-xt !
+' inst-stream <is> inst-stream-f
 \ !! initialize stack-in and stack-out
 
 \ offset computation
@@ -490,11 +527,17 @@ s" IP" save-mem cell-type  s" error don'
     dup stack-in off stack-out off ;
 
 : compute-offsets ( -- )
-    data-stack clear-stack  fp-stack clear-stack return-stack clear-stack
+    ['] clear-stack map-stacks
     inst-stream clear-stack
     prim prim-effect-in  prim prim-effect-in-end  @ ['] compute-offset-in  map-items
     prim prim-effect-out prim prim-effect-out-end @ ['] compute-offset-out map-items
-    inst-stream stack-out @ 0<> abort" # can only be on the input side" ;
+    inst-stream stack-out @ 0= s" # can only be on the input side" ?print-error ;
+
+: process-simple ( -- )
+    prim prim { W^ key } key cell
+    combinations ['] constant insert-wordlist
+    declarations compute-offsets
+    output @ execute ;
 
 : flush-a-tos { stack -- }
     stack stack-out @ 0<> stack stack-in @ 0= and
@@ -504,9 +547,7 @@ s" IP" save-mem cell-type  s" error don'
     endif ;
 
 : flush-tos ( -- )
-    data-stack   flush-a-tos
-    fp-stack     flush-a-tos
-    return-stack flush-a-tos ;
+    ['] flush-a-tos map-stacks ;
 
 : fill-a-tos { stack -- }
     stack stack-out @ 0= stack stack-in @ 0<> and
@@ -517,9 +558,7 @@ s" IP" save-mem cell-type  s" error don'
 
 : fill-tos ( -- )
     \ !! inst-stream for prefetching?
-    fp-stack     fill-a-tos
-    data-stack   fill-a-tos
-    return-stack fill-a-tos ;
+    ['] fill-a-tos map-stacks ;
 
 : fetch ( addr -- )
     dup item-type @ type-fetch @ execute ;
@@ -541,9 +580,7 @@ s" IP" save-mem cell-type  s" error don'
 
 : stack-pointer-updates ( -- )
     inst-pointer-update
-    data-stack   stack-pointer-update
-    fp-stack     stack-pointer-update
-    return-stack stack-pointer-update ;
+    ['] stack-pointer-update map-stacks ;
 
 : store ( item -- )
 \ f is true if the item should be stored
@@ -553,38 +590,62 @@ s" IP" save-mem cell-type  s" error don'
 : stores ( -- )
     prim prim-effect-out prim prim-effect-out-end @ ['] store map-items ;
 
+: print-debug-arg { item -- }
+    ." fputs(" quote space item item-name 2@ type ." =" quote ." , vm_out); "
+    ." printarg_" item item-type @ print-type-prefix
+    ." (" item item-name 2@ type ." );" cr ;
+    
+: print-debug-args ( -- )
+    ." #ifdef VM_DEBUG" cr
+    ." if (vm_debug) {" cr
+    prim prim-effect-in prim prim-effect-in-end @ ['] print-debug-arg map-items
+\    ." fputc('\n', vm_out);" cr
+    ." }" cr
+    ." #endif" cr ;
+
+: print-debug-result { item -- }
+    item item-first @ if
+	item print-debug-arg
+    endif ;
+
+: print-debug-results ( -- )
+    cr
+    ." #ifdef VM_DEBUG" cr
+    ." if (vm_debug) {" cr
+    ." fputs(" quote ."  -- " quote ." , vm_out); "
+    prim prim-effect-out prim prim-effect-out-end @ ['] print-debug-result map-items
+    ." fputc('\n', vm_out);" cr
+    ." }" cr
+    ." #endif" cr ;
+
+: output-super-end ( -- )
+    prim prim-c-code 2@ s" SET_IP" search if
+	." SUPER_END;" cr
+    endif
+    2drop ;
+
 : output-c-tail ( -- )
     \ the final part of the generated C code
+    output-super-end
+    print-debug-results
     ." NEXT_P1;" cr
     stores
     fill-tos
-    ." NEXT_P2;" cr ;
+    ." NEXT_P2;" ;
 
-: type-c ( c-addr u -- )
-    \ like TYPE, but replaces "TAIL;" with tail code
+: type-c-code ( c-addr u xt -- )
+    \ like TYPE, but replaces "TAIL;" with tail code produced by xt
+    { xt }
     begin ( c-addr1 u1 )
 	2dup s" TAIL;" search
     while ( c-addr1 u1 c-addr3 u3 )
 	2dup 2>r drop nip over - type
-	output-c-tail
+	xt execute
 	2r> 5 /string
 	\ !! resync #line missing
     repeat
     2drop type ;
 
-: print-debug-arg { item -- }
-    ." fputs(" quote space item item-name 2@ type ." =" quote ." , vm_out); "
-    ." printarg_" item item-type @ print-type-prefix
-    ." (" item item-name 2@ type ." );" cr ;
-    
-: print-debug-args ( -- )
-    ." #ifdef VM_DEBUG" cr
-    ." if (vm_debug) {" cr
-    prim prim-effect-in prim prim-effect-in-end @ ['] print-debug-arg map-items
-    ." fputc('\n', vm_out);" cr
-    ." }" cr
-    ." #endif" cr ;
-
 : print-entry ( -- )
     ." I_" prim prim-c-name 2@ type ." :" ;
     
@@ -602,7 +663,7 @@ s" IP" save-mem cell-type  s" error don'
  stack-pointer-updates
  ." {" cr
  ." #line " c-line @ . quote c-filename 2@ type quote cr
- prim prim-c-code 2@ type-c
+ prim prim-c-code 2@ ['] output-c-tail type-c-code
  ." }" cr
  output-c-tail
  ." }" cr
@@ -626,7 +687,21 @@ s" IP" save-mem cell-type  s" error don'
     ."   fputs(" quote prim prim-name 2@ type quote ." , vm_out);" cr
     disasm-args
     ."   ip += " inst-stream stack-in @ 1+ 0 .r ." ;" cr
-    ." } else " ;
+    ."   goto _endif_;" cr
+    ." }" cr ;
+
+: output-profile ( -- )
+    \ generate code for postprocessing the VM block profile stuff
+    ." if (VM_IS_INST(*ip, " function-number @ 0 .r ." )) {" cr
+    ."   add_inst(b, " quote  prim prim-name 2@ type quote ." );" cr
+    ."   ip += " inst-stream stack-in @ 1+ 0 .r ." ;" cr
+    prim prim-c-code 2@  s" SET_IP"    search nip nip
+    prim prim-c-code 2@  s" SUPER_END" search nip nip or if
+	."   return;" cr
+    else
+	."   goto _endif_;" cr
+    endif
+    ." }" cr ;
 
 : gen-arg-parm { item -- }
     item item-stack @ inst-stream = if
@@ -663,32 +738,33 @@ s" IP" save-mem cell-type  s" error don'
 : output-forthname ( -- )
   '" emit prim prim-name 2@ type '" emit ." ," cr ;
 
-: output-c-func ( -- )
-\ used for word libraries
-    ." Cell * I_" prim prim-c-name 2@ type ." (Cell *SP, Cell **FP)      /* " prim prim-name 2@ type
-    ."  ( " prim prim-stack-string 2@ type ."  ) */" cr
-    ." /* " prim prim-doc 2@ type ."  */" cr
-    ." NAME(" quote prim prim-name 2@ type quote ." )" cr
-    \ debugging
-    ." {" cr
-    print-declarations
-    inst-stream  stack-used? IF ." Cell *ip=IP;" cr THEN
-    data-stack   stack-used? IF ." Cell *sp=SP;" cr THEN
-    fp-stack     stack-used? IF ." Cell *fp=*FP;" cr THEN
-    return-stack stack-used? IF ." Cell *rp=*RP;" cr THEN
-    flush-tos
-    fetches
-    stack-pointer-updates
-    fp-stack   stack-used? IF ." *FP=fp;" cr THEN
-    ." {" cr
-    ." #line " c-line @ . quote c-filename 2@ type quote cr
-    prim prim-c-code 2@ type
-    ." }" cr
-    stores
-    fill-tos
-    ." return (sp);" cr
-    ." }" cr
-    cr ;
+\  : output-c-func ( -- )
+\  \ used for word libraries
+\      ." Cell * I_" prim prim-c-name 2@ type ." (Cell *SP, Cell **FP)      /* " prim prim-name 2@ type
+\      ."  ( " prim prim-stack-string 2@ type ."  ) */" cr
+\      ." /* " prim prim-doc 2@ type ."  */" cr
+\      ." NAME(" quote prim prim-name 2@ type quote ." )" cr
+\      \ debugging
+\      ." {" cr
+\      print-declarations
+\      \ !! don't know what to do about that
+\      inst-stream  stack-used? IF ." Cell *ip=IP;" cr THEN
+\      data-stack   stack-used? IF ." Cell *sp=SP;" cr THEN
+\      fp-stack     stack-used? IF ." Cell *fp=*FP;" cr THEN
+\      return-stack stack-used? IF ." Cell *rp=*RP;" cr THEN
+\      flush-tos
+\      fetches
+\      stack-pointer-updates
+\      fp-stack   stack-used? IF ." *FP=fp;" cr THEN
+\      ." {" cr
+\      ." #line " c-line @ . quote c-filename 2@ type quote cr
+\      prim prim-c-code 2@ type
+\      ." }" cr
+\      stores
+\      fill-tos
+\      ." return (sp);" cr
+\      ." }" cr
+\      cr ;
 
 : output-label ( -- )  
     ." (Label)&&I_" prim prim-c-name 2@ type ." ," cr ;
@@ -725,14 +801,12 @@ s" IP" save-mem cell-type  s" error don'
 
 [IFDEF] documentation
 : register-doc ( -- )
-    get-current documentation set-current
-    prim prim-name 2@ nextname create
+    prim prim-name 2@ documentation ['] create insert-wordlist
     prim prim-name 2@ 2,
     prim prim-stack-string 2@ condition-stack-effect 2,
     prim prim-wordset 2@ 2,
     prim prim-c-name 2@ condition-pronounciation 2,
-    prim prim-doc 2@ 2,
-    set-current ;
+    prim prim-doc 2@ 2, ;
 [THEN]
 
 
@@ -868,6 +942,10 @@ s" IP" save-mem cell-type  s" error don'
     loop ;
 
 : process-combined ( -- )
+    combined combined-prims num-combined @ cells
+    combinations ['] constant insert-wordlist
+    combined-prims num-combined @ 1- th ( last-part )
+    @ prim-c-code 2@ prim prim-c-code 2! \ used by output-super-end
     prim compute-effects
     prim init-effects
     output-combined perform ;
@@ -890,7 +968,15 @@ s" IP" save-mem cell-type  s" error don'
     fetches ;
 
 : part-output-c-tail ( -- )
-    output-c-tail ;
+    print-debug-results
+    stores ;
+
+: output-combined-tail ( -- )
+    part-output-c-tail
+    prim >r combined to prim
+    in-part @ >r in-part off
+    output-c-tail
+    r> in-part ! r> to prim ;
 
 : output-part ( p -- )
     to prim
@@ -903,7 +989,7 @@ s" IP" save-mem cell-type  s" error don'
     prim add-depths \ !! right place?
     ." {" cr
     ." #line " c-line @ . quote c-filename 2@ type quote cr
-    prim prim-c-code 2@ type-c \ !! deal with TAIL
+    prim prim-c-code 2@ ['] output-combined-tail type-c-code
     ." }" cr
     part-output-c-tail
     ." }" cr ;
@@ -934,7 +1020,34 @@ s" IP" save-mem cell-type  s" error don'
     cr ;
 
 : output-forth-combined ( -- )
-    ;
+;
+
+
+\ peephole optimization rules
+
+\ in order for this to work as intended, shorter combinations for each
+\ length must be present, and the longer combinations must follow
+\ shorter ones (this restriction may go away in the future).
+  
+: output-peephole ( -- )
+    combined-prims num-combined @ 1- cells combinations search-wordlist
+    s" the prefix for this combination must be defined earlier" ?print-error
+    ." {"
+    execute prim-num @ 5 .r ." ,"
+    combined-prims num-combined @ 1- th @ prim-num @ 5 .r ." ,"
+    combined prim-num @ 5 .r ." }, /* "
+    combined prim-c-name 2@ type ."  */"
+    cr ;
+
+: output-forth-peephole ( -- )
+    combined-prims num-combined @ 1- cells combinations search-wordlist
+    s" the prefix for this combination must be defined earlier" ?print-error
+    execute prim-num @ 5 .r
+    combined-prims num-combined @ 1- th @ prim-num @ 5 .r
+    combined prim-num @ 5 .r ."  prim, \ "
+    combined prim-c-name 2@ type
+    cr ;
+
 
 \ the parser
 
@@ -969,11 +1082,11 @@ print-token !
     endif
     0. r> 6 chars + 20 >number drop >r drop line ! r> ( c-addr )
     dup c@ bl = if
-	char+ dup c@ [char] " <> abort" sync line syntax"
+	char+ dup c@ [char] " <> 0= s" sync line syntax" ?print-error
 	char+ dup 100 [char] " scan drop swap 2dup - save-mem filename 2!
 	char+
     endif
-    dup c@ nl-char <> abort" sync line syntax"
+    dup c@ nl-char <> 0= s" sync line syntax" ?print-error
     skipsynclines @ if
 	dup char+ rawinput !
 	rawinput @ c@ cookedinput @ c!
@@ -1063,7 +1176,13 @@ Variable c-flag
 	THEN }}
 )) <- if-comment
 
-(( (( eval-comment || forth-comment || c-comment || else-comment || if-comment )) ?? nonl ** )) <- comment-body
+(( (( ` g || ` G )) {{ start }} nonl **
+   {{ end
+      forth-flag @ IF  ." group " type cr  THEN
+      c-flag @     IF  ." GROUP(" type ." )" cr  THEN }}
+)) <- group-comment
+
+(( (( eval-comment || forth-comment || c-comment || else-comment || if-comment || group-comment )) ?? nonl ** )) <- comment-body
 
 (( ` \ comment-body nleof )) <- comment ( -- )
 
@@ -1084,19 +1203,20 @@ Variable c-flag
    {{ skipsynclines off line @ c-line ! filename 2@ c-filename 2! start }} (( nocolonnl nonl **  nleof white ** )) ** {{ end prim prim-c-code 2! skipsynclines on }}
    (( ` :  white ** nleof
       {{ start }} (( nonl ++  nleof white ** )) ++ {{ end prim prim-forth-code 2! }}
-   )) ?? {{  declarations compute-offsets printprim 1 function-number +! }}
+   )) ?? {{ process-simple }}
    nleof
 )) <- simple-primitive ( -- )
 
 (( {{ init-combined }}
-   ` = (( white ++ {{ start }} forth-ident {{ end add-prim }} )) ++
+   ` = white ** (( {{ start }} forth-ident {{ end add-prim }} white ** )) ++
    nleof {{ process-combined }}
 )) <- combined-primitive
 
 (( {{ make-prim to prim 0 to combined
       line @ name-line ! filename 2@ name-filename 2!
+      function-number @ prim prim-num !
       start }} forth-ident {{ end 2dup prim prim-name 2! prim prim-c-name 2! }}  white ++
-   (( simple-primitive || combined-primitive ))
+   (( simple-primitive || combined-primitive )) {{ 1 function-number +! }}
 )) <- primitive ( -- )
 
 (( (( comment || primitive || nl white ** )) ** eof ))
@@ -1105,6 +1225,18 @@ warnings @ [IF]
 .( parser generated ok ) cr
 [THEN]
 
+
+\ run with gforth-0.5.0 (slurp-file is missing)
+[IFUNDEF] slurp-file
+: slurp-file ( c-addr1 u1 -- c-addr2 u2 )
+    \ c-addr1 u1 is the filename, c-addr2 u2 is the file's contents
+    r/o bin open-file throw >r
+    r@ file-size throw abort" file too large"
+    dup allocate throw swap
+    2dup r@ read-file throw over <> abort" could not read whole file"
+    r> close-file throw ;
+[THEN]
+
 : primfilter ( addr u -- )
     \ process the string at addr u
     over dup rawinput ! dup line-start ! cookedinput !