Interpreter almost works!!!
[forth.jl.git] / src / forth.jl
index e8478a4..27f9dc3 100644 (file)
@@ -101,6 +101,13 @@ function popPS()
     return val
 end
 
+# Handy functions for adding/retrieving strings to/from memory.
+
+getString(addr::Int64, len::Int64) = ASCIIString([Char(c) for c in mem[addr:(addr+len-1)]])
+function putString(str::ASCIIString, addr::Int64)
+    mem[addr:(addr+length(str)-1)] = [Int64(c) for c in str]
+end
+
 # Primitive creation and calling functions
 
 function createHeader(name::AbstractString, flags::Int64)
@@ -109,17 +116,18 @@ function createHeader(name::AbstractString, flags::Int64)
     mem[HERE] += 1
 
     mem[mem[HERE]] = length(name) | flags; mem[HERE] += 1
-    mem[mem[HERE]:(mem[HERE]+length(name)-1)] = [Int(c) for c in name]; mem[HERE] += length(name)
+    putString(name, mem[HERE]); mem[HERE] += length(name)
 end
 
 function defPrim(name::AbstractString, f::Function; flags::Int64=0)
     createHeader(name, flags)
 
+    codeWordAddr = mem[HERE]
     push!(primitives, f)
-    mem[mem[HERE]] = -length(primitives)
+    mem[codeWordAddr] = -length(primitives)
     mem[HERE] += 1
 
-    return -length(primitives)
+    return codeWordAddr
 end
 
 callPrim(addr::Int64) = primitives[-addr]()
@@ -127,29 +135,30 @@ callPrim(addr::Int64) = primitives[-addr]()
 function defExistingVar(name::AbstractString, varAddr::Int64; flags::Int64=0)
     defPrim(name, eval(:(() -> begin
         pushPS($(varAddr))
-        return NEXT
+        return mem[NEXT]
     end)))
 end
 
 function defNewVar(name::AbstractString, initial::Int64; flags::Int64=0)
     createHeader(name, flags)
     
+    codeWordAddr = mem[HERE]
     varAddr = mem[HERE] + 1
     push!(primitives, eval(:(() -> begin
         pushPS($(varAddr))
-        return NEXT
+        return mem[NEXT]
     end)))
     mem[mem[HERE]] = -length(primitives); mem[HERE] += 1
 
     mem[mem[HERE]] = initial; mem[HERE] += 1
 
-    return varAddr
+    return varAddr, codeWordAddr
 end
 
 function defConst(name::AbstractString, val::Int64; flags::Int64=0)
     defPrim(name, eval(:(() -> begin
         pushPS($(val))
-        return NEXT
+        return mem[NEXT]
     end)))
 
     return val
@@ -158,41 +167,42 @@ end
 function defWord(name::AbstractString, wordAddrs::Array{Int64,1}; flags::Int64=0)
     createHeader(name, flags)
 
-    mem[mem[HERE]] = DOCOL
+    addr = mem[HERE]
+    mem[mem[HERE]] = mem[DOCOL]
     mem[HERE] += 1
 
     for wordAddr in wordAddrs
         mem[mem[HERE]] = wordAddr
         mem[HERE] += 1
     end
+
+    return addr
 end
 
-# Threading Primitives
+# Threading Primitives (inner interpreter)
 
 NEXT = defPrim("NEXT", () -> begin
     reg.W = mem[reg.IP]
     reg.IP += 1
-    X = mem[reg.W]
-    return X
+    return mem[reg.W]
 end)
 
 DOCOL = defPrim("DOCOL", () -> begin
     pushRS(reg.IP)
     reg.IP = reg.W + 1
-    return NEXT
+    return mem[NEXT]
 end)
 
 EXIT = defPrim("EXIT", () -> begin
     reg.IP = popRS()
-    return NEXT
+    return mem[NEXT]
 end)
 
-
 # Basic forth primitives
 
 DROP = defPrim("DROP", () -> begin
     popPS()
-    return NEXT
+    return mem[NEXT]
 end)
 
 SWAP = defPrim("SWAP", () -> begin
@@ -200,18 +210,18 @@ SWAP = defPrim("SWAP", () -> begin
     b = popPS()
     pushPS(a)
     pushPS(b)
-    return NEXT
+    return mem[NEXT]
 end)
 
 DUP = defPrim("DUP", () -> begin
     pushPS(mem[reg.PSP])
-    return NEXT
+    return mem[NEXT]
 end)
 
 OVER = defPrim("OVER", () -> begin
     ensurePSDepth(2)
     pushPS(mem[reg.PSP-1])
-    return NEXT
+    return mem[NEXT]
 end)
 
 ROT = defPrim("ROT", () -> begin
@@ -221,7 +231,7 @@ ROT = defPrim("ROT", () -> begin
     pushPS(a)
     pushPS(c)
     pushPS(b)
-    return NEXT
+    return mem[NEXT]
 end)
 
 NROT = defPrim("-ROT", () -> begin
@@ -231,13 +241,13 @@ NROT = defPrim("-ROT", () -> begin
     pushPS(b)
     pushPS(a)
     pushPS(c)
-    return NEXT
+    return mem[NEXT]
 end)
 
 TWODROP = defPrim("2DROP", () -> begin
     popPS()
     popPS()
-    return NEXT
+    return mem[NEXT]
 end)
 
 TWODUP = defPrim("2DUP", () -> begin
@@ -246,7 +256,7 @@ TWODUP = defPrim("2DUP", () -> begin
     b = mem[reg.PSP]
     pushPS(a)
     pushPS(b)
-    return NEXT
+    return mem[NEXT]
 end)
 
 TWOSWAP = defPrim("2SWAP", () -> begin
@@ -258,7 +268,7 @@ TWOSWAP = defPrim("2SWAP", () -> begin
     pushPS(a)
     pushPS(c)
     pushPS(d)
-    return NEXT
+    return mem[NEXT]
 end)
 
 QDUP = defPrim("?DUP", () -> begin
@@ -267,55 +277,167 @@ QDUP = defPrim("?DUP", () -> begin
     if val != 0
         pushPS(val)
     end
-    return NEXT
+    return mem[NEXT]
 end)
 
 INCR = defPrim("1+", () -> begin
     ensurePSDepth(1)
     mem[reg.PSP] += 1
-    return NEXT
+    return mem[NEXT]
 end)
 
 DECR = defPrim("1-", () -> begin
     ensurePSDepth(1)
     mem[reg.PSP] -= 1
-    return NEXT
+    return mem[NEXT]
+end)
+
+INCR2 = defPrim("2+", () -> begin
+    ensurePSDepth(1)
+    mem[reg.PSP] += 2
+    return mem[NEXT]
+end)
+
+DECR2 = defPrim("2-", () -> begin
+    ensurePSDepth(1)
+    mem[reg.PSP] -= 2
+    return mem[NEXT]
 end)
 
 ADD = defPrim("+", () -> begin
-    a = popPS()
     b = popPS()
+    a = popPS()
     pushPS(a+b)
-    return NEXT
+    return mem[NEXT]
 end)
 
 SUB = defPrim("-", () -> begin
-    a = popPS()
     b = popPS()
-    pushPS(b-a)
-    return NEXT
+    a = popPS()
+    pushPS(a-b)
+    return mem[NEXT]
 end)
 
 MUL = defPrim("*", () -> begin
-    a = popPS()
     b = popPS()
+    a = popPS()
     pushPS(a*b)
-    return NEXT
+    return mem[NEXT]
 end)
 
 DIVMOD = defPrim("/MOD", () -> begin
-    a = popPS()
     b = popPS()
-    q,r = divrem(b,a)
+    a = popPS()
+    q,r = divrem(a,b)
     pushPS(r)
     pushPS(q)
-    return NEXT
+    return mem[NEXT]
 end)
 
+EQU = defPrim("=", () -> begin
+    b = popPS()
+    a = popPS()
+    pushPS(a==b ? -1 : 0)
+    return mem[NEXT]
+end)
+
+NEQU = defPrim("<>", () -> begin
+    b = popPS()
+    a = popPS()
+    pushPS(a!=b ? -1 : 0)
+    return mem[NEXT]
+end)
+
+LT = defPrim("<", () -> begin
+    b = popPS()
+    a = popPS()
+    pushPS(a<b ? -1 : 0)
+    return mem[NEXT]
+end)
+
+GT = defPrim(">", () -> begin
+    b = popPS()
+    a = popPS()
+    pushPS(a>b ? -1 : 0)
+    return mem[NEXT]
+end)
+
+LE = defPrim("<=", () -> begin
+    b = popPS()
+    a = popPS()
+    pushPS(a<=b ? -1 : 0)
+    return mem[NEXT]
+end)
+
+GE = defPrim(">=", () -> begin
+    b = popPS()
+    a = popPS()
+    pushPS(a>=b ? -1 : 0)
+    return mem[NEXT]
+end)
+
+ZEQU = defPrim("0=", () -> begin
+    pushPS(popPS() == 0 ? -1 : 0)
+    return mem[NEXT]
+end)
+
+ZNEQU = defPrim("0<>", () -> begin
+    pushPS(popPS() != 0 ? -1 : 0)
+    return mem[NEXT]
+end)
+
+ZLT = defPrim("0<", () -> begin
+    pushPS(popPS() < 0 ? -1 : 0)
+    return mem[NEXT]
+end)
+
+ZGT = defPrim("0>", () -> begin
+    pushPS(popPS() > 0 ? -1 : 0)
+    return mem[NEXT]
+end)
+
+ZLE = defPrim("0<=", () -> begin
+    pushPS(popPS() <= 0 ? -1 : 0)
+    return mem[NEXT]
+end)
+
+ZGE = defPrim("0>=", () -> begin
+    pushPS(popPS() >= 0 ? -1 : 0)
+    return mem[NEXT]
+end)
+
+AND = defPrim("AND", () -> begin
+    b = popPS()
+    a = popPS()
+    pushPS(a & b)
+    return mem[NEXT]
+end)
+
+OR = defPrim("OR", () -> begin
+    b = popPS()
+    a = popPS()
+    pushPS(a | b)
+    return mem[NEXT]
+end)
+
+XOR = defPrim("XOR", () -> begin
+    b = popPS()
+    a = popPS()
+    pushPS(a $ b)
+    return mem[NEXT]
+end)
+
+INVERT = defPrim("INVERT", () -> begin
+    pushPS(~popPS())
+    return mem[NEXT]
+end)
+
+# Literals
+
 LIT = defPrim("LIT", () -> begin
     pushPS(mem[reg.IP])
     reg.IP += 1
-    return NEXT
+    return mem[NEXT]
 end)
 
 # Memory primitives
@@ -324,38 +446,38 @@ STORE = defPrim("!", () -> begin
     addr = popPS()
     dat = popPS()
     mem[addr] = dat
-    return NEXT
+    return mem[NEXT]
 end)
 
 FETCH = defPrim("@", () -> begin
     addr = popPS()
     pushPS(mem[addr])
-    return NEXT
+    return mem[NEXT]
 end)
 
 ADDSTORE = defPrim("+!", () -> begin
     addr = popPS()
     toAdd = popPS()
     mem[addr] += toAdd
-    return NEXT
+    return mem[NEXT]
 end)
 
 SUBSTORE = defPrim("-!", () -> begin
     addr = popPS()
     toSub = popPS()
     mem[addr] -= toSub
-    return NEXT
+    return mem[NEXT]
 end)
 
 
 # Built-in variables
 
-defExistingVar("HERE", HERE)
-defExistingVar("LATEST", LATEST)
-defExistingVar("PSP0", PSP0)
-defExistingVar("RSP0", RSP0)
-STATE = defNewVar("STATE", 0)
-BASE = defNewVar("BASE", 10)
+HERE_CFA = defExistingVar("HERE", HERE)
+LATEST_CFA = defExistingVar("LATEST", LATEST)
+PSP0_CFA = defExistingVar("PSP0", PSP0)
+RSP0_CFA = defExistingVar("RSP0", RSP0)
+STATE, STATE_CFA = defNewVar("STATE", 0)
+BASE, BASE_CFA = defNewVar("BASE", 10)
 
 # Constants
 
@@ -370,64 +492,64 @@ F_LENMASK = defConst("F_LENMASK", 127)
 
 TOR = defPrim(">R", () -> begin
     pushRS(popPS())
-    return NEXT
+    return mem[NEXT]
 end)
 
 FROMR = defPrim("R>", () -> begin
     pushPS(popRS())
-    return NEXT
+    return mem[NEXT]
 end)
 
 RSPFETCH = defPrim("RSP@", () -> begin
     pushPS(reg.RSP)
-    return NEXT
+    return mem[NEXT]
 end)
 
 RSPSTORE = defPrim("RSP!", () -> begin
     RSP = popPS()
-    return NEXT
+    return mem[NEXT]
 end)
 
 RDROP = defPrim("RDROP", () -> begin
     popRS()
-    return NEXT
+    return mem[NEXT]
 end)
 
 # Parameter Stack
 
 PSPFETCH = defPrim("PSP@", () -> begin
     pushPS(reg.PSP)
-    return NEXT
+    return mem[NEXT]
 end)
 
 PSPSTORE = defPrim("PSP!", () -> begin
     PSP = popPS()
-    return NEXT
+    return mem[NEXT]
 end)
 
 # I/O
 
 defConst("TIB", TIB)
-NUMTIB = defNewVar("#TIB", 0)
-TOIN = defNewVar(">IN", 0)
+NUMTIB, NUMTIB_CFA = defNewVar("#TIB", 0)
+TOIN, TOIN_CFA = defNewVar(">IN", 0)
 
 KEY = defPrim("KEY", () -> begin
     if mem[TOIN] >= mem[NUMTIB]
         mem[TOIN] = 0
         line = readline()
         mem[NUMTIB] = length(line)
-        mem[TIB:(TIB+mem[NUMTIB]-1)] = [Int64(c) for c in collect(line)]
+        putString(line, TIB)
     end
 
     pushPS(mem[TIB + mem[TOIN]])
     mem[TOIN] += 1
 
-    return NEXT
+    return mem[NEXT]
 end)
 
 EMIT = defPrim("EMIT", () -> begin
     print(Char(popPS()))
-    return NEXT
+    return mem[NEXT]
 end)
 
 WORD = defPrim("WORD", () -> begin
@@ -437,7 +559,7 @@ WORD = defPrim("WORD", () -> begin
     skip_to_end = false
     while true
 
-        callPrim(KEY)
+        callPrim(mem[KEY])
         c = Char(popPS())
 
         if c == '\\'
@@ -466,7 +588,7 @@ WORD = defPrim("WORD", () -> begin
         mem[wordAddr + offset] = Int64(c)
         offset += 1
 
-        callPrim(KEY)
+        callPrim(mem[KEY])
         c = Char(popPS())
 
         if c == ' ' || c == '\t' || c == '\n'
@@ -479,7 +601,7 @@ WORD = defPrim("WORD", () -> begin
     pushPS(wordAddr)
     pushPS(wordLen)
 
-    return NEXT
+    return mem[NEXT]
 end)
 
 NUMBER = defPrim("NUMBER", () -> begin
@@ -487,7 +609,7 @@ NUMBER = defPrim("NUMBER", () -> begin
     wordLen = popPS()
     wordAddr = popPS()
 
-    s = ASCIIString([Char(c) for c in mem[wordAddr:(wordAddr+wordLen-1)]])
+    s = getString(wordAddr, wordLen)
 
     try
         pushPS(parse(Int64, s, mem[BASE]))
@@ -496,7 +618,7 @@ NUMBER = defPrim("NUMBER", () -> begin
         pushPS(1) # Error indication
     end
 
-    return NEXT
+    return mem[NEXT]
 end)
 
 # Dictionary searches
@@ -505,22 +627,22 @@ FIND = defPrim("FIND", () -> begin
 
     wordLen = popPS()
     wordAddr = popPS()
-    word = ASCIIString([Char(c) for c in mem[wordAddr:(wordAddr+wordLen-1)]])
+    word = getString(wordAddr, wordLen)
 
-    latest = mem[LATEST]
+    latest = LATEST
     
-    while latest>0
+    i = 0
+    while (latest = mem[latest]) > 0
         lenAndFlags = mem[latest+1]
         len = lenAndFlags & F_LENMASK
         hidden = (lenAndFlags & F_HIDDEN) == F_HIDDEN
 
         if hidden || len != wordLen
-            latest = mem[latest]
             continue
         end
         
         thisAddr = latest+2
-        thisWord = ASCIIString([Char(c) for c in mem[thisAddr:(thisAddr+len-1)]])
+        thisWord = getString(thisAddr, len)
 
         if thisWord == word
             break
@@ -529,7 +651,7 @@ FIND = defPrim("FIND", () -> begin
 
     pushPS(latest)
 
-    return NEXT
+    return mem[NEXT]
 end)
 
 TOCFA = defPrim(">CFA", () -> begin
@@ -540,39 +662,227 @@ TOCFA = defPrim(">CFA", () -> begin
 
     pushPS(addr + 2 + len)
 
-    return NEXT
+    return mem[NEXT]
 end)
 
-TODFA = defWord(">DFA", [TOCFA, INCR1, EXIT])
+TODFA = defWord(">DFA", [TOCFA, INCR, EXIT])
 
-#### VM loop ####
-#function runVM(reg::Reg)
-#    jmp = NEXT
-#    while (jmp = callPrim(reg, jmp)) != 0 end
-#end
+# Compilation
 
-# Debugging tools
+CREATE = defPrim("CREATE", () -> begin
 
-function coredump(startAddr::Int64; count::Int64 = 16, cellsPerLine::Int64 = 8)
-    chars = Array{Char,1}(cellsPerLine)
+    wordLen = popPS()
+    wordAddr = popPS()
+    word = getString(wordAddr, wordLen)
 
-    for i in 0:(count-1)
-        addr = startAddr + i
-        if i%cellsPerLine == 0
-            print("$addr:")
+    createHeader(word, 0)
+
+    return mem[NEXT]
+end)
+
+COMMA = defPrim(",", () -> begin
+    mem[mem[HERE]] = popPS()
+    mem[HERE] += 1
+
+    return mem[NEXT]
+end)
+
+LBRAC = defPrim("[", () -> begin
+    mem[STATE] = 0
+    return mem[NEXT]
+end, flags=F_IMMED)
+
+RBRAC = defPrim("]", () -> begin
+    mem[STATE] = 1
+    return mem[NEXT]
+end, flags=F_IMMED)
+
+HIDDEN = defPrim("HIDDEN", () -> begin
+    addr = popPS() + 1
+    mem[addr] = mem[addr] $ F_HIDDEN
+    return mem[NEXT]
+end)
+
+HIDE = defWord("HIDE",
+    [WORD,
+    FIND,
+    HIDDEN,
+    EXIT])
+
+COLON = defWord(":",
+    [WORD,
+    CREATE,
+    LIT, DOCOL, COMMA,
+    LATEST, FETCH, HIDDEN,
+    RBRAC,
+    EXIT])
+
+SEMICOLON = defWord(";",
+    [LIT, EXIT, COMMA,
+    LATEST, FETCH, HIDDEN,
+    LBRAC,
+    EXIT], flags=F_IMMED)
+
+IMMEDIATE = defPrim("IMMEDIATE", () -> begin
+    lenAndFlagsAddr = mem[LATEST] + 1
+    mem[lenAndFlagsAddr] = mem[lenAndFlagsAddr] $ F_IMMED
+    return mem[NEXT]
+end, flags=F_IMMED)
+
+TICK = defWord("'", [WORD, FIND, TOCFA, EXIT])
+
+# Branching
+
+BRANCH = defPrim("BRANCH", () -> begin
+    reg.IP += mem[reg.IP]
+    return mem[NEXT]
+end)
+
+ZBRANCH = defPrim("0BRANCH", () -> begin
+    if (popPS() == 0)
+        reg.IP += mem[reg.IP]
+    else
+        reg.IP += 1
+    end
+
+    return mem[NEXT]
+end)
+
+# Strings
+
+LITSTRING = defPrim("LITSTRING", () -> begin
+    len = mem[reg.IP]
+    reg.IP += 1
+    pushPS(reg.IP)
+    pushPS(len)
+    reg.IP += len
+
+    return mem[NEXT]
+end)
+
+TELL = defPrim("TELL", () -> begin
+    len = popPS()
+    addr = popPS()
+    str = getString(addr, len)
+    print(str)
+    return mem[NEXT]
+end)
+
+# Outer interpreter
+
+INTERPRET = defPrim("INTERPRET", () -> begin
+
+    callPrim(mem[WORD])
+    callPrim(mem[TWODUP])
+    callPrim(mem[FIND])
+
+    wordAddr = mem[reg.PSP]
+
+    if wordAddr>0
+        # Word in dictionary
+
+        isImmediate = (mem[wordAddr+1] & F_IMMED) != 0
+        callPrim(mem[TOCFA])
+
+        callPrim(mem[ROT]) # get rid of extra copy of word string details
+        popPS()
+        popPS()
+
+        if mem[STATE] == 0 || isImmediate
+            # Execute!
+            return mem[popPS()]
+        else
+            # Append CFA to dictionary
+            callPrim(mem[COMMA])
         end
+    else
+        # Not in dictionary, assume number
 
-        print("\t$(mem[addr]) ")
+        popPS()
+        callPrim(mem[NUMBER])
+
+        if popPS() != 0
+            println("Parse error!")
+            return mem[NEXT]
+        end
 
-        if (mem[addr]>=32 && mem[addr]<176)
-            chars[i%cellsPerLine + 1] = Char(mem[addr])
+        if mem[STATE] == 0
+            # Number already on stack!
         else
-            chars[i%cellsPerLine + 1] = '.'
+            # Append literal to dictionary
+            pushPS(LIT)
+            callPrim(mem[COMMA])
+            callPrim(mem[COMMA])
         end
+    end
+
+    return mem[NEXT]
+end)
+
+QUIT = defWord("QUIT",
+    [RSP0_CFA, RSPSTORE,
+    INTERPRET,
+    BRANCH,-2])
+
+# Odds and Ends
 
-        if i%cellsPerLine == cellsPerLine-1
-            println(string("\t", ASCIIString(chars)))
+CHAR = defPrim("CHAR", () -> begin
+    callPrim(mem[WORD])
+    wordLen = popPS()
+    wordAddr = popPS()
+    word = getString(wordAddr, wordLen)
+    pushPS(Int64(word[1]))
+
+    return mem[NEXT]
+end)
+
+EXECUTE = defPrim("EXECUTE", () -> begin
+    return mem[popPS()]
+end)
+
+#### VM loop ####
+function runVM()
+    # Start with IP pointing to first instruction of outer interpreter
+    reg.IP = QUIT + 1
+
+    # Primitive processing loop.
+    # Everyting else is simply a consequence of this loop!
+    jmp = mem[NEXT]
+    while (jmp = callPrim(jmp)) != 0 end
+end
+
+# Debugging tools
+
+function dump(startAddr::Int64; count::Int64 = 100, cellsPerLine::Int64 = 10)
+    chars = Array{Char,1}(cellsPerLine)
+
+    lineStartAddr = cellsPerLine*div((startAddr-1),cellsPerLine) + 1
+    endAddr = startAddr + count - 1
+
+    q, r = divrem((endAddr-lineStartAddr+1), cellsPerLine)
+    numLines = q + (r > 0 ? 1 : 0)
+
+    i = lineStartAddr
+    for l in 1:numLines
+        print(i,":")
+
+        for c in 1:cellsPerLine
+            if i >= startAddr && i <= endAddr
+                print("\t",mem[i])
+                if mem[i]>=32 && mem[i]<128
+                    chars[c] = Char(mem[i])
+                else
+                    chars[c] = '.'
+                end
+            else
+                print("\t")
+                chars[c] = ' '
+            end
+
+            i += 1
         end
+
+        println("\t", ASCIIString(chars))
     end
 end
 
@@ -590,4 +900,18 @@ function printPS()
     end
 end
 
+function printRS()
+    count = reg.RSP - mem[RSP0]
+
+    if count > 0
+        print("<$count>")
+        for i in (mem[RSP0]+1):reg.RSP
+            print(" $(mem[i])")
+        end
+        println()
+    else
+        println("Return stack empty")
+    end
+end
+
 end