--- gforth/see.fs 1997/01/29 21:32:38 1.15 +++ gforth/see.fs 2010/08/28 09:48:53 1.73 @@ -1,12 +1,12 @@ \ SEE.FS highend SEE for ANSforth 16may93jaw -\ Copyright (C) 1995 Free Software Foundation, Inc. +\ Copyright (C) 1995,2000,2003,2004,2006,2007,2008 Free Software Foundation, Inc. \ This file is part of Gforth. \ Gforth is free software; you can redistribute it and/or \ modify it under the terms of the GNU General Public License -\ as published by the Free Software Foundation; either version 2 +\ as published by the Free Software Foundation, either version 3 \ of the License, or (at your option) any later version. \ This program is distributed in the hope that it will be useful, @@ -15,8 +15,7 @@ \ GNU General Public License for more details. \ You should have received a copy of the GNU General Public License -\ along with this program; if not, write to the Free Software -\ Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. +\ along with this program. If not, see http://www.gnu.org/licenses/. \ May be cross-compiled @@ -25,7 +24,9 @@ \ Ideas: Level should be a stack +require look.fs require termsize.fs +require wordinfo.fs decimal @@ -56,7 +57,7 @@ DEFER nlcount ' noop IS nlcount : nl nlflag on ; : (nl) nlcount - XPos @ Level @ = ?Exit + XPos @ Level @ = IF EXIT THEN \ ?Exit C-Formated @ IF C-Output @ IF C-Clearline @ IF cols XPos @ - spaces @@ -69,12 +70,9 @@ DEFER nlcount ' noop IS nlcount nlflag @ IF (nl) nlflag off THEN XPos @ over + cols u>= IF (nl) THEN ; -: c-to-upper - dup [char] a >= over [char] z <= and if bl - then ; - : ctype ( adr len -- ) warp? dup XPos +! C-Output @ - IF uppercase @ IF bounds ?DO i c@ c-to-upper emit LOOP + IF uppercase @ IF bounds ?DO i c@ toupper emit LOOP uppercase off ELSE type THEN ELSE 2drop THEN ; @@ -83,7 +81,7 @@ DEFER nlcount ' noop IS nlcount IF 2drop ELSE XPos +! C-Output @ IF emit ELSE drop THEN THEN ; -DEFER .string +DEFER .string ( c-addr u n -- ) [IFDEF] Green VARIABLE Colors Colors on @@ -104,11 +102,38 @@ VARIABLE Colors Colors on ' (.string) IS .string +: c-\type ( c-addr u -- ) + \ type string in \-escaped form + begin + dup while + 2dup newline string-prefix? if + '\ cemit 'n cemit + newline nip /string + else + over c@ + dup '" = over '\ = or if + '\ cemit cemit + else + dup bl 127 within if + cemit + else + base @ >r try + 8 base ! 0 <<# # # # '\ hold #> ctype #>> 0 + restore + r@ base ! + endtry + rdrop throw + endif + endif + 1 /string + endif + repeat + 2drop ; : .struc uppercase on Str# .string ; -\ CODES 15may93jaw +\ CODES (Branchtypes) 15may93jaw 21 CONSTANT RepeatCode 22 CONSTANT AgainCode @@ -118,21 +143,30 @@ VARIABLE Colors Colors on 11 CONSTANT AheadCode 13 CONSTANT WhileCode2 14 CONSTANT Disable +15 CONSTANT LeaveCode + \ FORMAT WORDS 13jun93jaw VARIABLE C-Stop VARIABLE Branches -VARIABLE BranchPointer +VARIABLE BranchPointer \ point to the end of branch table VARIABLE SearchPointer -CREATE BranchTable 500 allot + +\ The branchtable consists of three entrys: +\ address of branch , branch destination , branch type + +CREATE BranchTable 128 cells allot here 3 cells - ACONSTANT MaxTable : FirstBranch BranchTable cell+ SearchPointer ! ; -: (BranchAddr?) ( a-addr -- a-addr true | false ) +: (BranchAddr?) ( a-addr1 -- a-addr2 true | false ) +\ searches a branch with destination a-addr1 +\ a-addr1: branch destination +\ a-addr2: pointer in branch table SearchPointer @ BEGIN dup BranchPointer @ u< WHILE @@ -161,6 +195,20 @@ ACONSTANT MaxTable 2drop true THEN ; +: MyBranch ( a-addr -- a-addr a-addr2 ) +\ finds branch table entry for branch at a-addr + dup @ + BranchAddr? + BEGIN + WHILE 1 cells - @ + over <> + WHILE dup @ + MoreBranchAddr? + REPEAT + SearchPointer @ 3 cells - + ELSE true ABORT" SEE: Table failure" + THEN ; + \ \ addrw addrt \ BEGIN ... WHILE ... AGAIN ... THEN @@ -192,7 +240,8 @@ ACONSTANT MaxTable BranchPointer @ 1 cells - ! ; : Branch! ( a-addr rel -- a-addr ) - over + over ,Branch ,Branch 0 ,Branch ; + over ,Branch ,Branch 0 ,Branch ; +\ over + over ,Branch ,Branch 0 ,Branch ; \ DEFER CheckUntil VARIABLE NoOutput @@ -205,60 +254,173 @@ VARIABLE C-Pass : Scan? ( -- flag ) C-Pass @ 0= ; : Display? ( -- flag ) C-Pass @ 1 = ; : Debug? ( -- flag ) C-Pass @ 2 = ; +: ?.string ( c-addr u n -- ) Display? if .string else 2drop drop then ; -: back? ( n -- flag ) 0< ; -: ahead? ( n -- flag ) 0> ; +: back? ( addr target -- addr flag ) + over u< ; -: c-(compile) - Display? +: .word ( addr x -- addr ) + \ print x as a word if possible + dup look 0= IF + drop dup threaded>name dup 0= if + drop over 1 cells - @ dup body> look + IF + nip nip dup ." <" name>string rot wordinfo .string ." > " + ELSE + 2drop ." <" 0 .r ." > " + THEN + EXIT + then + THEN + nip dup cell+ @ immediate-mask and IF - s" POSTPONE " Com# .string - dup @ look 0= ABORT" SEE: No valid XT" - name>string 0 .string bl cemit + bl cemit ." POSTPONE " + THEN + dup name>string rot wordinfo .string + ; + +: c-call ( addr1 -- addr2 ) + Display? IF + dup @ body> .word bl cemit THEN cell+ ; -: c-lit +: c-callxt ( addr1 -- addr2 ) Display? IF - dup @ dup abs 0 <# #S rot sign #> 0 .string bl cemit + dup @ .word bl cemit THEN cell+ ; -: c-s" - count 2dup + aligned -rot - Display? - IF [char] S cemit [char] " cemit bl cemit 0 .string - [char] " cemit bl cemit - ELSE 2drop - THEN ; +\ here docon: , docol: , dovar: , douser: , dodefer: , dofield: , +\ here over - 2constant doers -: c-." - count 2dup + aligned -rot - Display? - IF [char] . cemit - [char] " cemit bl cemit 0 .string - [char] " cemit bl cemit - ELSE 2drop - THEN ; +[IFDEF] !does +: c-does> \ end of create part + Display? IF S" DOES> " Com# .string THEN ; +\ maxaligned /does-handler + ; \ !! no longer needed for non-cross stuff +[THEN] + +: c-lit ( addr1 -- addr2 ) + dup @ dup body> dup cfaligned over = swap in-dictionary? and if + ( addr1 addr1@ ) + dup body> @ dovar: = if + drop c-call EXIT + endif + endif + over 4 cells + over = if + over 1 cells + @ decompile-prim ['] call xt>threaded = >r + over 3 cells + @ decompile-prim ['] ;S xt>threaded = + r> and if + over 2 cells + @ ['] !does >body = if drop + S" DOES> " Com# ?.string 4 cells + EXIT endif + endif + [IFDEF] !;abi-code + over 2 cells + @ ['] !;abi-code >body = if drop + S" ;abi-code " Com# ?.string 4 cells + + c-stop on + EXIT + endif + [THEN] + endif + Display? if + \ !! test for cfa here, and print "['] ..." + dup abs 0 <# #S rot sign #> 0 .string bl cemit + else drop then + cell+ ; + +: c-lit+ ( addr1 -- addr2 ) + Display? if + dup @ dup abs 0 <# #S rot sign #> 0 .string bl cemit + s" + " 0 .string + endif + cell+ ; + +: .name-without ( addr -- addr ) + \ !! the stack effect cannot be correct + \ prints a name without a() e.g. a(+LOOP) or (s") + dup 1 cells - @ threaded>name dup IF + name>string over c@ 'a = IF + 1 /string + THEN + over c@ '( = IF + 1 /string + THEN + 2dup + 1- c@ ') = IF 1- THEN .struc ELSE drop + THEN ; +[ifdef] (s") : c-c" + Display? IF nl .name-without THEN count 2dup + aligned -rot Display? - IF [char] C cemit [char] " cemit bl cemit 0 .string + IF bl cemit 0 .string [char] " cemit bl cemit ELSE 2drop THEN ; +[endif] +: c-string? ( addr1 -- addr2 f ) + \ f is true if a string was found and decompiled. + \ if f is false, addr2=addr1 + \ recognizes the following patterns: + \ c": ahead X: len string then lit X + \ flit: ahead X: float then lit X f@ + \ s\": ahead X: string then lit X lit len + \ .\": ahead X: string then lit X lit len type + \ !! not recognized anywhere: + \ abort": if ahead X: len string then lit X c(abort") then + dup @ back? if false exit endif + dup @ >r + r@ @ decompile-prim ['] lit xt>threaded <> if rdrop false exit endif + r@ cell+ @ over cell+ <> if rdrop false exit endif + \ we have at least C" + r@ 2 cells + @ decompile-prim dup ['] lit xt>threaded = if + drop r@ 3 cells + @ over cell+ + aligned r@ = if + \ we have at least s" + r@ 4 cells + @ decompile-prim ['] lit-perform xt>threaded = + r@ 5 cells + @ ['] type >body = and if + 6 s\" .\\\" " + else + 4 s\" s\\\" " + endif + \ !! make newline if string too long? + display? if + 0 .string r@ cell+ @ r@ 3 cells + @ c-\type '" cemit bl cemit + else + 2drop + endif + nip cells r> + true exit + endif + endif + ['] f@ xt>threaded = if + display? if + r@ cell+ @ f@ 10 8 16 f>str-rdp 0 .string bl cemit + endif + drop r> 3 cells + true exit + endif + \ !! check if count matches space? + display? if + s\" c\" " 0 .string r@ cell+ @ count 0 .string '" cemit bl cemit + endif + drop r> 2 cells + true ; + +: Forward? ( a-addr true | false -- a-addr true | false ) + \ a-addr is pointer into branch table + \ returns true when jump is a forward jump + IF + dup dup @ swap 1 cells - @ u> IF + true + ELSE + drop false + THEN + \ only if forward jump + ELSE + false + THEN ; -: Forward? ( a-addr true | false -- ) - IF dup dup @ swap 1 cells - @ - - Ahead? IF true ELSE drop false THEN - \ only if forward jump - ELSE false THEN ; - -: RepeatCheck +: RepeatCheck ( a-addr1 a-addr2 true | false -- false ) IF BEGIN 2dup - 1 cells - @ swap dup @ + + 1 cells - @ swap @ u<= WHILE drop dup cell+ MoreBranchAddr? 0= @@ -268,7 +430,8 @@ VARIABLE C-Pass ELSE false THEN ; -: c-branch +: c-branch ( addr1 -- addr2 ) + c-string? ?exit Scan? IF dup @ Branch! dup @ back? @@ -295,36 +458,27 @@ VARIABLE C-Pass IF drop S" REPEAT " .struc nl ELSE S" AGAIN " .struc nl THEN - ELSE dup cell+ BranchAddr? Forward? - IF dup cell+ @ WhileCode2 = - IF nl S" ELSE" .struc level+ - ELSE level- nl S" ELSE" .struc level+ THEN - cell+ Disable swap ! - ELSE S" AHEAD" .struc level+ - THEN + ELSE MyBranch cell+ @ LeaveCode = + IF S" LEAVE " .struc + ELSE + dup cell+ BranchAddr? Forward? + IF dup cell+ @ WhileCode2 = + IF nl S" ELSE" .struc level+ + ELSE level- nl S" ELSE" .struc level+ THEN + cell+ Disable swap ! + ELSE S" AHEAD" .struc level+ + THEN + THEN THEN THEN Debug? - IF dup @ + + IF @ \ !!! cross-interacts with debugger !!! ELSE cell+ THEN ; -: MyBranch ( a-addr -- a-addr a-addr2 ) - dup @ over + - BranchAddr? - BEGIN - WHILE 1 cells - @ - over <> - WHILE dup @ over + - MoreBranchAddr? - REPEAT - SearchPointer @ 3 cells - - ELSE true ABORT" SEE: Table failure" - THEN ; - : DebugBranch Debug? - IF dup @ over + swap THEN ; \ return 2 different addresses + IF dup @ swap THEN ; \ return 2 different addresses : c-?branch Scan? @@ -344,7 +498,10 @@ VARIABLE C-Pass level- nl S" WHILE " .struc level+ - ELSE nl S" IF " .struc level+ + ELSE MyBranch cell+ @ LeaveCode = + IF s" 0= ?LEAVE " .struc + ELSE nl S" IF " .struc level+ + THEN THEN THEN THEN @@ -354,39 +511,36 @@ VARIABLE C-Pass : c-for Display? IF nl S" FOR" .struc level+ THEN ; -: .name-without - dup 1 cells - @ look IF name>string 1 /string 1- .struc ELSE drop THEN ; - : c-loop - Display? IF level- nl .name-without bl cemit nl THEN - DebugBranch cell+ cell+ ; + Display? IF level- nl .name-without nl bl cemit THEN + DebugBranch cell+ + Scan? + IF dup BranchAddr? + BEGIN WHILE cell+ LeaveCode swap ! + dup MoreBranchAddr? + REPEAT + THEN + cell+ ; : c-do Display? IF nl .name-without level+ THEN ; -: c-?do - Display? IF nl S" ?DO" .struc level+ THEN - DebugBranch cell+ ; - -: c-leave - Display? IF S" LEAVE " .struc THEN - Debug? IF dup @ + THEN cell+ ; - -: c-?leave - Display? IF S" ?LEAVE " .struc THEN - cell+ DebugBranch swap cell+ swap cell+ ; - -: c-exit dup 1 cells - - CheckEnd - IF Display? IF nlflag off S" ;" Com# .string THEN - C-Stop on - ELSE Display? IF S" EXIT " .struc THEN - THEN - Debug? IF drop THEN ; +: c-?do ( addr1 -- addr2 ) + Display? IF + nl .name-without level+ + THEN + DebugBranch cell+ ; -: c-does> \ end of create part - Display? IF S" DOES> " Com# .string THEN - Cell+ cell+ ; +: c-exit ( addr1 -- addr2 ) + dup 1 cells - + CheckEnd + IF + Display? IF nlflag off S" ;" Com# .string THEN + C-Stop on + ELSE + Display? IF S" EXIT " .struc THEN + THEN + Debug? IF drop THEN ; \ !!! cross-interacts with debugger !!! : c-abort" count 2dup + aligned -rot @@ -397,61 +551,79 @@ VARIABLE C-Pass ELSE 2drop THEN ; +[IFDEF] (compile) +: c-(compile) + Display? + IF + s" POSTPONE " Com# .string + dup @ look 0= ABORT" SEE: No valid XT" + name>string 0 .string bl cemit + THEN + cell+ ; +[THEN] CREATE C-Table - ' lit A, ' c-lit A, - ' (s") A, ' c-s" A, - ' (.") A, ' c-." A, - ' "lit A, ' c-c" A, - comp' leave drop A, ' c-leave A, - comp' ?leave drop A, ' c-?leave A, - ' (do) A, ' c-do A, - ' (+do) A, ' c-do A, - ' (u+do) A, ' c-do A, - ' (-do) A, ' c-do A, - ' (u-do) A, ' c-do A, - ' (?do) A, ' c-?do A, - ' (for) A, ' c-for A, - ' ?branch A, ' c-?branch A, - ' branch A, ' c-branch A, - ' (loop) A, ' c-loop A, - ' (+loop) A, ' c-loop A, - ' (s+loop) A, ' c-loop A, - ' (-loop) A, ' c-loop A, - ' (next) A, ' c-loop A, - ' ;s A, ' c-exit A, - ' (does>) A, ' c-does> A, - ' (abort") A, ' c-abort" A, - ' (compile) A, ' c-(compile) A, - 0 , here 0 , + ' lit A, ' c-lit A, + ' does-exec A, ' c-callxt A, + ' lit@ A, ' c-call A, +[IFDEF] call ' call A, ' c-call A, [THEN] +\ ' useraddr A, .... + ' lit-perform A, ' c-call A, + ' lit+ A, ' c-lit+ A, +[IFDEF] (s") ' (s") A, ' c-c" A, [THEN] +[IFDEF] (.") ' (.") A, ' c-c" A, [THEN] +[IFDEF] "lit ' "lit A, ' c-c" A, [THEN] +[IFDEF] (c") ' (c") A, ' c-c" A, [THEN] + ' (do) A, ' c-do A, +[IFDEF] (+do) ' (+do) A, ' c-?do A, [THEN] +[IFDEF] (u+do) ' (u+do) A, ' c-?do A, [THEN] +[IFDEF] (-do) ' (-do) A, ' c-?do A, [THEN] +[IFDEF] (u-do) ' (u-do) A, ' c-?do A, [THEN] + ' (?do) A, ' c-?do A, + ' (for) A, ' c-for A, + ' ?branch A, ' c-?branch A, + ' branch A, ' c-branch A, + ' (loop) A, ' c-loop A, + ' (+loop) A, ' c-loop A, +[IFDEF] (s+loop) ' (s+loop) A, ' c-loop A, [THEN] +[IFDEF] (-loop) ' (-loop) A, ' c-loop A, [THEN] + ' (next) A, ' c-loop A, + ' ;s A, ' c-exit A, +[IFDEF] (abort") ' (abort") A, ' c-abort" A, [THEN] +\ only defined if compiler is loaded +[IFDEF] (compile) ' (compile) A, ' c-(compile) A, [THEN] + 0 , here 0 , avariable c-extender c-extender ! \ DOTABLE 15may93jaw -: DoTable ( cfa -- flag ) - C-Table - BEGIN dup @ dup 0= - IF drop cell+ @ dup - IF ( next table!) dup @ ELSE - ( end!) 2drop false EXIT THEN - THEN - \ jump over to extender, if any 26jan97jaw - 2 pick <> - WHILE 2 cells + - REPEAT - nip cell+ perform - true - ; +: DoTable ( ca/cfa -- flag ) + decompile-prim C-Table BEGIN ( cfa table-entry ) + dup @ dup 0= IF + drop cell+ @ dup IF ( next table!) + dup @ + ELSE ( end!) + 2drop false EXIT + THEN + THEN + \ jump over to extender, if any 26jan97jaw + xt>threaded 2 pick <> + WHILE + 2 cells + + REPEAT + nip cell+ perform + true +; : BranchTo? ( a-addr -- a-addr ) - Display? IF dup BranchAddr? + Display? IF dup BranchAddr? IF BEGIN cell+ @ dup 20 u> IF drop nl S" BEGIN " .struc level+ ELSE - dup Disable <> + dup Disable <> over LeaveCode <> and IF WhileCode2 = IF nl S" THEN " .struc nl ELSE level- nl S" THEN " .struc nl THEN @@ -463,14 +635,15 @@ c-extender ! THEN ; : analyse ( a-addr1 -- a-addr2 ) - Branches @ IF BranchTo? THEN - dup cell+ swap @ - dup >r DoTable r> swap IF drop EXIT THEN - Display? - IF look 0= IF drop dup 1 cells - @ . \ ABORT" SEE: Bua!" - ELSE dup cell+ count 31 and rot wordinfo .string THEN bl cemit - ELSE drop - THEN ; + Branches @ IF BranchTo? THEN + dup cell+ swap @ + dup >r DoTable r> swap IF drop EXIT THEN + Display? + IF + .word bl cemit + ELSE + drop + THEN ; : c-init 0 YPos ! 0 XPos ! @@ -498,17 +671,61 @@ Defer xt-see-xt ( xt -- ) then space ; -Defer discode ( addr -- ) -\ hook for the disassembler: disassemble code at addr (as far as the -\ disassembler thinks is sensible) -:noname ( addr -- ) - drop ." ..." ; -IS discode +Defer discode ( addr u -- ) \ gforth +\G hook for the disassembler: disassemble u bytes of code at addr +' dump IS discode + +: next-head ( addr1 -- addr2 ) \ gforth + \G find the next header starting after addr1, up to here (unreliable). + here swap u+do + i head? -2 and if + i unloop exit + then + cell +loop + here ; + +[ifundef] umin \ !! bootstrapping help +: umin ( u1 u2 -- u ) + 2dup u> + if + swap + then + drop ; +[then] + +: next-prim ( addr1 -- addr2 ) \ gforth + \G find the next primitive after addr1 (unreliable) + 1+ >r -1 primstart + begin ( umin head R: boundary ) + @ dup + while + tuck name>int >code-address ( head1 umin ca R: boundary ) + r@ - umin + swap + repeat + drop dup r@ negate u>= + \ "umin+boundary within [0,boundary)" = "umin within [-boundary,0)" + if ( umin R: boundary ) \ no primitive found behind -> use a default length + drop 31 + then + r> + ; : seecode ( xt -- ) dup s" Code" .defname - >body discode - ." end-code" cr ; + >code-address + dup in-dictionary? \ user-defined code word? + if + dup next-head + else + dup next-prim + then + over - discode + ." end-code" cr ; +: seeabicode ( xt -- ) + dup s" ABI-Code" .defname + >body dup dup next-head + swap - discode + ." end-code" cr ; : seevar ( xt -- ) s" Variable" .defname cr ; : seeuser ( xt -- ) @@ -522,10 +739,10 @@ IS discode : seedefer ( xt -- ) dup >body @ xt-see-xt cr dup s" Defer" .defname cr - >name dup ??? = if - drop ." lastxt >body !" - else + >name ?dup-if ." IS " .name cr + else + ." latestxt >body !" then ; : see-threaded ( addr -- ) C-Pass @ DebugMode = IF @@ -546,30 +763,44 @@ IS discode dup >body ." 0 " ? ." 0 0 " s" Field" .defname cr ; -: xt-see ( xt -- ) +: xt-see ( xt -- ) \ gforth + \G Decompile the definition represented by @i{xt}. cr c-init dup >does-code if seedoes EXIT then - dup forthstart u< + dup xtprim? if seecode EXIT then dup >code-address CASE docon: of seecon endof +[IFDEF] dovalue: + dovalue: of seevalue endof +[THEN] docol: of seecol endof dovar: of seevar endof +[IFDEF] douser: douser: of seeuser endof +[THEN] +[IFDEF] dodefer: dodefer: of seedefer endof +[THEN] +[IFDEF] dofield: dofield: of seefield endof - over >body of seecode endof +[THEN] +[IFDEF] doabicode: + doabicode: of seeabicode endof +[THEN] + over of seecode endof \ direct threaded code words + over >body of seecode endof \ indirect threaded code words 2drop abort" unknown word type" ENDCASE ; : (xt-see-xt) ( xt -- ) - xt-see cr ." lastxt" ; + xt-see cr ." latestxt" ; ' (xt-see-xt) is xt-see-xt : (.immediate) ( xt -- ) @@ -584,21 +815,26 @@ IS discode if \ normal or immediate word swap xt-see (.immediate) else - r@ ['] compile-only-error = + r@ ['] ticking-compile-only-error = if \ compile-only word swap xt-see (.immediate) ." compile-only" else \ interpret/compile word r@ xt-see-xt cr swap xt-see-xt cr - ." interpret/compile " over .name (.immediate) + ." interpret/compile: " over .name drop then then rdrop drop ; -: see ( "name" -- ) \ tools +: see ( "name" -- ) \ tools + \G Locate @var{name} using the current search order. Display the + \G definition of @var{name}. Since this is achieved by decompiling + \G the definition, the formatting is mechanised and some source + \G information (comments, interpreted sequences within definitions + \G etc.) is lost. name find-name dup 0= IF - drop -&13 bounce + drop -&13 throw THEN name-see ;