add new header fields: d:astack d:fstack & d:descr

FossilOrigin-Name: 849d884ac4162c4c6e06eff900a704b0e02e20bf70e86fccb1d9f9285be97f24

RELEASE-NOTES

@@ -35,6 +35,9 @@
   - `s:temp` now truncates strings longer than `TempStringMax`
   - `s:filter` now truncates strings longer than `TempStringMax`
   - added new `d:stack` field for storing a stack comment
+  - added new `d:astack` field for storing an address stack comment
+  - added new `d:fstack` field for storing a float stack comment
+  - added new `d:descr` field for storing a description
   - `sigil:(` extended to store stack comments (with a form of
     `(:comment)`
   - add `d:describe`

image/retro.muri

@@ -146,7 +146,7 @@ Here's the initial memory map:
 r 9999
 
 : Heap
-d 1536
+d 2048
 
 : Version
 d 202409
@@ -155,7 +155,7 @@ d 202409
 r interpret
 r err:notfound
 r TIB
-d 1535
+d 2048
 : HashFunction
 d 0
 : RehashFunction
@@ -698,7 +698,10 @@ below.
 | class  | link to the class handler function | d:class  |
 | source | source identifier                  | d:source |
 | hash   | hash of the word name              | d:hash   |
-| source | pointer to stack comment           | d:stack  |
+| stack  | pointer to stack comment           | d:stack  |
+| astack | pointer to addr. stack comment     | d:astack |
+| fstack | pointer to float stack comment     | d:fstack |
+| descr  | pointer to description             | d:descr  |
 | name   | zero terminated string             | d:name   |
 
 The initial dictionary is constructed at the end of this file.
@@ -711,6 +714,9 @@ It'll take a form like this:
     r source-file
     d 0
     d 0
+    d 0
+    d 0
+    d 0
     s dup
 
     : 0001
@@ -720,6 +726,9 @@ It'll take a form like this:
     r source-file
     d 0
     d 0
+    d 0
+    d 0
+    d 0
     s drop
 
     : 0002
@@ -728,6 +737,9 @@ It'll take a form like this:
     r class:primitive
     d 0
     d 0
+    d 0
+    d 0
+    d 0
     s swap
 
 Each entry starts with a pointer to the prior entry (with a
@@ -770,9 +782,21 @@ d 4
 i liadre..
 d 5
 
-: d:name
+: d:astack
 i liadre..
 d 6
+
+: d:fstack
+i liadre..
+d 7
+
+: d:descr
+i liadre..
+d 8
+
+: d:name
+i liadre..
+d 9
 ~~~
 
 A traditional Forth has `create` to make a new dictionary entry
@@ -787,31 +811,56 @@ are made using the `:` sigil, or `d:create` (once defined in
 the standard library). At some point I may simplify this by
 moving `d:create` into Rx and using it in place of `d:add-header`.
 
+~~~
+: empty-stack
+s -
+~~~
+
 ~~~
 : d:add-header
 i liju....
 r _add-header
 : _add-header
+
 i lifepuli
 r Heap
 r Dictionary
 i felica..
 r comma
+
 i lica....
 r comma
+
 i lica....
 r comma
+
 i lilica..
 d 0
 r comma
+
 i lilica..
 d 0
 r comma
+
 i lilica..
 d 0
 r comma
+
+i lilica..
+r empty-stack
+r comma
+
+i lilica..
+r empty-stack
+r comma
+
+i lilica..
+d 0
+r comma
+
 i lica....
 r comma:string
+
 i polist..
 r Dictionary
 i lifezr..
@@ -1562,6 +1611,9 @@ r class:primitive
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s dup
 : 0001
 r 0000
@@ -1570,6 +1622,9 @@ r class:primitive
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s drop
 : 0002
 r 0001
@@ -1578,6 +1633,9 @@ r class:primitive
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s swap
 : 0003
 r 0002
@@ -1586,6 +1644,9 @@ r class:primitive
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s call
 : 0004
 r 0003
@@ -1594,6 +1655,9 @@ r class:primitive
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s eq?
 : 0005
 r 0004
@@ -1602,6 +1666,9 @@ r class:primitive
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s -eq?
 : 0006
 r 0005
@@ -1610,6 +1677,9 @@ r class:primitive
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s lt?
 : 0007
 r 0006
@@ -1618,6 +1688,9 @@ r class:primitive
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s gt?
 : 0008
 r 0007
@@ -1626,6 +1699,9 @@ r class:primitive
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s fetch
 : 0009
 r 0008
@@ -1634,6 +1710,9 @@ r class:primitive
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s store
 : 0010
 r 0009
@@ -1642,6 +1721,9 @@ r class:primitive
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s +
 : 0011
 r 0010
@@ -1650,6 +1732,9 @@ r class:primitive
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s -
 : 0012
 r 0011
@@ -1658,6 +1743,9 @@ r class:primitive
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s *
 : 0013
 r 0012
@@ -1666,6 +1754,9 @@ r class:primitive
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s /mod
 : 0014
 r 0013
@@ -1674,6 +1765,9 @@ r class:primitive
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s and
 : 0015
 r 0014
@@ -1682,6 +1776,9 @@ r class:primitive
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s or
 : 0016
 r 0015
@@ -1690,6 +1787,9 @@ r class:primitive
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s xor
 : 0017
 r 0016
@@ -1698,6 +1798,9 @@ r class:primitive
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s shift
 : 0018
 r 0017
@@ -1706,6 +1809,9 @@ r class:macro
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s push
 : 0019
 r 0018
@@ -1714,6 +1820,9 @@ r class:macro
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s pop
 : 0020
 r 0019
@@ -1722,6 +1831,9 @@ r class:macro
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s 0;
 : 0021
 r 0020
@@ -1730,6 +1842,9 @@ r class:word
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s fetch-next
 : 0022
 r 0021
@@ -1738,6 +1853,9 @@ r class:word
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s store-next
 : 0023
 r 0022
@@ -1746,6 +1864,9 @@ r class:word
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s s:to-number
 : 0024
 r 0023
@@ -1754,6 +1875,9 @@ r class:word
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s s:eq?
 : 0025
 r 0024
@@ -1762,6 +1886,9 @@ r class:word
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s s:length
 : 0026
 r 0025
@@ -1770,6 +1897,9 @@ r class:word
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s choose
 : 0027
 r 0026
@@ -1778,6 +1908,9 @@ r class:primitive
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s if
 : 0028
 r 0027
@@ -1786,6 +1919,9 @@ r class:word
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s -if
 : 0029
 r 0028
@@ -1794,6 +1930,9 @@ r class:macro
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s sigil:(
 : 0030
 r 0029
@@ -1802,6 +1941,9 @@ r class:data
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s Compiler
 : 0031
 r 0030
@@ -1810,6 +1952,9 @@ r class:data
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s Heap
 : 0032
 r 0031
@@ -1818,6 +1963,9 @@ r class:word
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s ,
 : 0033
 r 0032
@@ -1826,6 +1974,9 @@ r class:word
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s s,
 : 0034
 r 0033
@@ -1834,6 +1985,9 @@ r class:macro
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s ;
 : 0035
 r 0034
@@ -1842,6 +1996,9 @@ r class:macro
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s [
 : 0036
 r 0035
@@ -1850,6 +2007,9 @@ r class:macro
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s ]
 : 0037
 r 0036
@@ -1858,6 +2018,9 @@ r class:data
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s Dictionary
 : 0038
 r 0037
@@ -1866,6 +2029,9 @@ r class:word
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s d:link
 : 0039
 r 0038
@@ -1874,6 +2040,9 @@ r class:word
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s d:xt
 : 0040
 r 0039
@@ -1882,6 +2051,9 @@ r class:word
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s d:class
 : 0041
 r 0040
@@ -1890,6 +2062,9 @@ r class:word
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s d:name
 : 0042
 r 0041
@@ -1898,6 +2073,9 @@ r class:word
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s class:word
 : 0043
 r 0042
@@ -1906,6 +2084,9 @@ r class:word
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s class:macro
 : 0044
 r 0043
@@ -1914,6 +2095,9 @@ r class:word
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s class:data
 : 0045
 r 0044
@@ -1922,6 +2106,9 @@ r class:word
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s d:add-header
 : 0046
 r 0045
@@ -1930,6 +2117,9 @@ r class:macro
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s sigil:#
 : 0047
 r 0046
@@ -1938,6 +2128,9 @@ r class:macro
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s sigil::
 : 0048
 r 0047
@@ -1946,6 +2139,9 @@ r class:macro
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s sigil:&
 : 0049
 r 0048
@@ -1954,6 +2150,9 @@ r class:macro
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s sigil:$
 : 0050
 r 0049
@@ -1962,6 +2161,9 @@ r class:macro
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s repeat
 : 0051
 r 0050
@@ -1970,6 +2172,9 @@ r class:macro
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s again
 : 0052
 r 0051
@@ -1978,6 +2183,9 @@ r class:word
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s interpret
 : 0053
 r 0052
@@ -1986,6 +2194,9 @@ r class:word
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s d:lookup
 : 0054
 r 0053
@@ -1994,6 +2205,9 @@ r class:word
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s class:primitive
 : 0055
 r 0054
@@ -2002,6 +2216,9 @@ r class:data
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s Version
 : 0056
 r 0055
@@ -2010,6 +2227,9 @@ r class:word
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s i
 : 0057
 r 0056
@@ -2018,6 +2238,9 @@ r class:word
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s d
 : 0058
 r 0057
@@ -2026,6 +2249,9 @@ r class:word
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s r
 : 0059
 r 0058
@@ -2034,6 +2260,9 @@ r class:data
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s Base
 : 0060
 r 0059
@@ -2042,6 +2271,9 @@ r class:word
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s pack
 : 0061
 r 0060
@@ -2050,6 +2282,9 @@ r class:word
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s unpack
 : 0062
 r 0061
@@ -2058,6 +2293,9 @@ r class:word
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s d:source
 : 0063
 r 0062
@@ -2066,6 +2304,9 @@ r class:word
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s d:hash
 : 0064
 r 0063
@@ -2074,14 +2315,55 @@ r class:word
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s d:stack
-: 9999
+
+: 0065
 r 0064
+r d:astack
+r class:word
+r source-file
+d 0
+d 0
+r empty-stack
+r empty-stack
+d 0
+s d:astack
+: 0066
+r 0065
+r d:fstack
+r class:word
+r source-file
+d 0
+d 0
+r empty-stack
+r empty-stack
+d 0
+s d:fstack
+: 0067
+r 0066
+r d:descr
+r class:word
+r source-file
+d 0
+d 0
+r empty-stack
+r empty-stack
+d 0
+s d:descr
+
+: 9999
+r 0067
 r err:notfound
 r class:word
 r source-file
 d 0
 d 0
+r empty-stack
+r empty-stack
+d 0
 s err:notfound
 ~~~
 
@@ -2155,7 +2437,7 @@ s err:notfound
 
 ## Legalities
 
-RETRO Core is Copyright (c) 2016-2022, Charles Childers
+RETRO Core is Copyright (c) 2016-2024, Charles Childers
 
 Permission to use, copy, modify, and/or distribute this software
 for any purpose with or without fee is hereby granted, provided

interface/stack-comments.retro

@@ -6,7 +6,7 @@ comment format this introduces to add them inline.
 ~~~
 {{
   :save (s-)
-     n:inc s:chop here swap s:keep |drop #2 + d:last.name n:dec store ;
+     n:inc s:chop here swap s:keep |drop #2 + d:last.name #4 - store ;
   :stack-comment? (s-sf) dup #0 s:fetch $: eq? ;
 ---reveal---
   :sigil:( stack-comment? &save &drop choose ; immediate
@@ -14,11 +14,14 @@ comment format this introduces to add them inline.
 
 :d:describe (:s-)
   d:lookup nl
-  dup 'Name:____ s:put d:name s:put nl
+  dup 'Name:_____ s:put d:name   s:put nl
-  dup 'Address:_ s:put d:xt fetch n:put nl
+  dup 'Address:__ s:put d:xt     fetch n:put nl
-  dup 'Class:___ s:put d:class fetch dup n:put d:lookup-xt dup n:-zero? [ sp d:name s:put ] &drop choose nl
+  dup 'Class:____ s:put d:class  fetch dup n:put d:lookup-xt dup n:-zero? [ sp d:name s:put ] &drop choose nl
-  dup 'Source:__ s:put d:source fetch dup n:-zero? &s:put &drop choose nl
+  dup 'Source:___ s:put d:source fetch dup n:-zero? &s:put &drop choose nl
-  dup 'Stack:___ s:put d:stack fetch dup n:-zero? &s:put &drop choose nl
+  dup 'Stack:____ s:put d:stack  fetch dup n:-zero? &s:put &drop choose nl
+  dup 'A._Stack:_ s:put d:astack fetch dup n:-zero? &s:put &drop choose nl
+  dup 'Float:____ s:put d:fstack fetch dup n:-zero? &s:put &drop choose nl
+  dup 'Descr:____ s:put d:descr  fetch dup n:-zero? &s:put &drop choose nl
   drop ;
 
 :d:set-stack-comment (:ss-)
@@ -28,13 +31,13 @@ comment format this introduces to add them inline.
 Add the stack comments for existing words:
 
 ~~~
-'ss- 'd:set-source d:set-stack-comment
+'ss-  'd:set-source d:set-stack-comment
-'n-s 'n:to-string/reversed d:set-stack-comment
+'n-s  'n:to-string/reversed d:set-stack-comment
-'s-s 's:truncate d:set-stack-comment
+'s-s  's:truncate d:set-stack-comment
 's-sf 's:oversize? d:set-stack-comment
-'- 'err:notfound d:set-stack-comment
+'-    'err:notfound d:set-stack-comment
-'a-a 'd:stack d:set-stack-comment
+'a-a  'd:stack d:set-stack-comment
-'n- 'io:core d:set-stack-comment
+'n-   'io:core d:set-stack-comment
 
 'D:_-c__A:_-__F:_- '$ d:set-stack-comment
 'D:_-s__A:_-__F:_- '' d:set-stack-comment

tools/retro-extend.c

@@ -36,7 +36,10 @@
 #define D_OFFSET_SOURCE   3
 #define D_OFFSET_HASH     4
 #define D_OFFSET_STACK    5
-#define D_OFFSET_NAME     6
+#define D_OFFSET_RSTACK   6
+#define D_OFFSET_FSTACK   7
+#define D_OFFSET_DESCR    8
+#define D_OFFSET_NAME     9
 
 
 /* These settings can be overridden at compile time. */

tools/retro-muri.c

@@ -24,7 +24,7 @@
 #endif
 
 #define KiB * 1024
-#define MAX_NAMES 1024
+#define MAX_NAMES 4096
 #define STRING_LEN 64
 
 #ifndef IMAGE_SIZE

vm/nga-c/retro-compiler.c

@@ -50,7 +50,7 @@
 #define D_OFFSET_XT       1       /* you change the dictionary fields. */
 #define D_OFFSET_CLASS    2
 #define D_OFFSET_STACK    5
-#define D_OFFSET_NAME     6
+#define D_OFFSET_NAME     9
 
 #define NUM_DEVICES       1       /* Set the number of I/O devices     */
 

vm/nga-pascal/bridge.pas

@@ -17,7 +17,7 @@ const
   D_OFFSET_LINK  = 0;
   D_OFFSET_XT    = 1;
   D_OFFSET_CLASS = 2;
-  D_OFFSET_NAME  = 6;
+  D_OFFSET_NAME  = 9;
   TIB            = 1471;
 
 var