module forth
# VM mem size
-size_mem = 640*1024
+size_mem = 1000000 # 1 mega-int
# Buffer sizes
-size_RS = 1024 # Return stack size
-size_PS = 1024 # Parameter stack size
-size_TIB = 1096 # Terminal input buffer size
+size_RS = 1000 # Return stack size
+size_PS = 1000 # Parameter stack size
+size_TIB = 1000 # Terminal input buffer size
# The mem array constitutes the memory of the VM. It has the following geography:
#
# the dictionary.
#
# Simple linear addressing is used with one exception: references to primitive code
-# blocks, which are represented as anonymous functions, appear the negative index
-# into the primitives array which contains only these functions.
+# blocks, which are represented as anonymous functions, appear as negative indicies
+# into the primitives array which contains these functions.
mem = Array{Int64,1}(size_mem)
primitives = Array{Function,1}()
+primNames = Array{ASCIIString,1}()
# Built-in variables
nextVarAddr = 1
-RSP0 = nextVarAddr; nextVarAddr += 1
-PSP0 = nextVarAddr; nextVarAddr += 1
-HERE = nextVarAddr; nextVarAddr += 1
+H = nextVarAddr; nextVarAddr += 1
LATEST = nextVarAddr; nextVarAddr += 1
-mem[RSP0] = nextVarAddr # bottom of RS
-mem[PSP0] = mem[RSP0] + size_RS # bottom of PS
-TIB = mem[PSP0] + size_PS # address of terminal input buffer
-mem[HERE] = TIB + size_TIB # location of bottom of dictionary
-mem[LATEST] = 0 # no previous definition
+RSP0 = nextVarAddr # bottom of RS
+PSP0 = RSP0 + size_RS # bottom of PS
+TIB = PSP0 + size_PS # address of terminal input buffer
+mem[H] = TIB + size_TIB # location of bottom of dictionary
+mem[LATEST] = 0 # no previous definition
-DICT = mem[HERE] # Save bottom of dictionary as constant
+DICT = mem[H] # Save bottom of dictionary as constant
# VM registers
type Reg
PSP::Int64 # Parameter/data stack pointer
IP::Int64 # Instruction pointer
W::Int64 # Working register
- X::Int64 # Extra register
end
-reg = Reg(mem[RSP0], mem[PSP0], 0, 0, 0)
+reg = Reg(RSP0, PSP0, 0, 0)
-# Stack manipulation
+# Stack manipulation functions
-type StackUnderflow <: Exception end
+type ParamStackUnderflow <: Exception end
+type ReturnStackUnderflow <: Exception end
-getRSDepth() = reg.RSP - mem[RSP0]
-getPSDepth() = reg.PSP - mem[PSP0]
+Base.showerror(io::IO, ex::ParamStackUnderflow) = print(io, "Parameter stack underflow.")
+Base.showerror(io::IO, ex::ReturnStackUnderflow) = print(io, "Return stack underflow.")
+
+getRSDepth() = reg.RSP - RSP0
+getPSDepth() = reg.PSP - PSP0
function ensurePSDepth(depth::Int64)
if getPSDepth()<depth
- throw(StackUnderflow())
+ throw(ParamStackUnderflow())
end
end
function ensureRSDepth(depth::Int64)
if getRSDepth()<depth
- throw(StackUnderflow())
+ throw(ReturnStackUnderflow())
end
end
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 defPrim(f::Function; name="nameless")
+ push!(primitives, f)
+ push!(primNames, replace(name, "\004", "EOF"))
+
+ return -length(primitives)
+end
+
+function callPrim(addr::Int64)
+ if addr >=0 || -addr>length(primitives)
+ error("Attempted to execute non-existent primitive at address $addr.")
+ else
+ primitives[-addr]()
+ end
+end
+getPrimName(addr::Int64) = primNames[-addr]
+
+# Word creation functions
+
+F_LENMASK = 31
+F_IMMED = 32
+F_HIDDEN = 64
+NFA_MARK = 128
+
function createHeader(name::AbstractString, flags::Int64)
- mem[mem[HERE]] = mem[LATEST]
- mem[LATEST] = mem[HERE]
- mem[HERE] += 1
+ mem[mem[H]] = mem[LATEST]
+ mem[LATEST] = mem[H]
+ mem[H] += 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)
+ mem[mem[H]] = length(name) | flags | NFA_MARK; mem[H] += 1
+ putString(name, mem[H]); mem[H] += length(name)
end
-function defPrim(name::AbstractString, f::Function; flags::Int64=0)
+function defPrimWord(name::AbstractString, f::Function; flags::Int64=0)
createHeader(name, flags)
- push!(primitives, f)
- mem[mem[HERE]] = -length(primitives)
- mem[HERE] += 1
+ codeWordAddr = mem[H]
+ mem[codeWordAddr] = defPrim(f, name=name)
+ mem[H] += 1
- return -length(primitives)
+ return codeWordAddr
+end
+
+function defWord(name::AbstractString, wordAddrs::Array{Int64,1}; flags::Int64=0)
+ createHeader(name, flags)
+
+ addr = mem[H]
+ mem[mem[H]] = DOCOL
+ mem[H] += 1
+
+ for wordAddr in wordAddrs
+ mem[mem[H]] = wordAddr
+ mem[H] += 1
+ end
+
+ return addr
end
-callPrim(addr::Int64) = primitives[-addr]()
+# Variable creation functions
function defExistingVar(name::AbstractString, varAddr::Int64; flags::Int64=0)
- defPrim(name, eval(:(() -> begin
+
+ defPrimWord(name, eval(:(() -> begin
pushPS($(varAddr))
return NEXT
end)))
function defNewVar(name::AbstractString, initial::Int64; flags::Int64=0)
createHeader(name, flags)
- varAddr = mem[HERE] + 1
- push!(primitives, eval(:(() -> begin
- pushPS($(varAddr))
- return NEXT
- end)))
- mem[mem[HERE]] = -length(primitives); mem[HERE] += 1
+ codeWordAddr = mem[H]
+ varAddr = mem[H] + 1
- mem[mem[HERE]] = initial; mem[HERE] += 1
+ mem[mem[H]] = DOVAR; mem[H] += 1
+ mem[mem[H]] = initial; mem[H] += 1
- return varAddr
+ return varAddr, codeWordAddr
end
function defConst(name::AbstractString, val::Int64; flags::Int64=0)
- defPrim(name, eval(:(() -> begin
- pushPS($(val))
- return NEXT
- end)))
+ createHeader(name, flags)
- return val
+ codeWordAddr = mem[H]
+
+ mem[mem[H]] = DOCON; mem[H] += 1
+ mem[mem[H]] = val; mem[H] += 1
+
+ return codeWordAddr
end
-# Threading Primitives
+# Threading Primitives (inner interpreter)
-NEXT = defPrim("NEXT", () -> begin
+NEXT = defPrim(() -> begin
reg.W = mem[reg.IP]
reg.IP += 1
- X = mem[reg.W]
- return X
-end)
+ return mem[reg.W]
+end, name="NEXT")
-DOCOL = defPrim("DOCOL", () -> begin
+DOCOL = defPrim(() -> begin
pushRS(reg.IP)
reg.IP = reg.W + 1
return NEXT
-end)
+end, name="DOCOL")
+
+DOVAR = defPrim(() -> begin
+ pushPS(reg.W + 1)
+ return NEXT
+end, name="DOVAR")
-EXIT = defPrim("EXIT", () -> begin
+DOCON = defPrim(() -> begin
+ pushPS(mem[reg.W + 1])
+ return NEXT
+end, name="DOVAR")
+
+EXIT = defPrimWord("EXIT", () -> begin
reg.IP = popRS()
return NEXT
end)
+# Dictionary entries for core built-in variables, constants
+
+H_CFA = defExistingVar("H", H)
+LATEST_CFA = defExistingVar("LATEST", LATEST)
+
+PSP0_CFA = defConst("PSP0", PSP0)
+RSP0_CFA = defConst("RSP0", RSP0)
+
+defConst("DOCOL", DOCOL)
+defConst("DOCON", DOCON)
+defConst("DOVAR", DOVAR)
+
+defConst("DICT", DICT)
+defConst("MEMSIZE", size_mem)
+
+F_IMMED_CFA = defConst("F_IMMED", F_IMMED)
+F_HIDDEN_CFA = defConst("F_HIDDEN", F_HIDDEN)
+F_LENMASK_CFA = defConst("F_LENMASK", F_LENMASK)
+NFA_MARK_CFA = defConst("NFA_MARK", NFA_MARK)
# Basic forth primitives
-DROP = defPrim("DROP", () -> begin
+DROP = defPrimWord("DROP", () -> begin
popPS()
return NEXT
end)
-SWAP = defPrim("SWAP", () -> begin
+SWAP = defPrimWord("SWAP", () -> begin
a = popPS()
b = popPS()
pushPS(a)
return NEXT
end)
-DUP = defPrim("DUP", () -> begin
+DUP = defPrimWord("DUP", () -> begin
+ ensurePSDepth(1)
pushPS(mem[reg.PSP])
return NEXT
end)
-OVER = defPrim("OVER", () -> begin
+OVER = defPrimWord("OVER", () -> begin
ensurePSDepth(2)
pushPS(mem[reg.PSP-1])
return NEXT
end)
-ROT = defPrim("ROT", () -> begin
+ROT = defPrimWord("ROT", () -> begin
a = popPS()
b = popPS()
c = popPS()
+ pushPS(b)
pushPS(a)
pushPS(c)
- pushPS(b)
return NEXT
end)
-NROT = defPrim("-ROT", () -> begin
+NROT = defPrimWord("-ROT", () -> begin
a = popPS()
b = popPS()
c = popPS()
- pushPS(b)
pushPS(a)
pushPS(c)
+ pushPS(b)
return NEXT
end)
-TWODROP = defPrim("2DROP", () -> begin
+
+TWODROP = defPrimWord("2DROP", () -> begin
popPS()
popPS()
return NEXT
end)
-TWODUP = defPrim("2DUP", () -> begin
+TWODUP = defPrimWord("2DUP", () -> begin
ensurePSDepth(2)
a = mem[reg.PSP-1]
b = mem[reg.PSP]
return NEXT
end)
-TWOSWAP = defPrim("2SWAP", () -> begin
+TWOSWAP = defPrimWord("2SWAP", () -> begin
a = popPS()
b = popPS()
c = popPS()
d = popPS()
pushPS(b)
pushPS(a)
- pushPS(c)
pushPS(d)
+ pushPS(c)
+ return NEXT
+end)
+
+TWOOVER = defPrimWord("2OVER", () -> begin
+ ensurePSDepth(4)
+ a = mem[reg.PSP-3]
+ b = mem[reg.PSP-2]
+ pushPS(a)
+ pushPS(b)
return NEXT
end)
-QDUP = defPrim("?DUP", () -> begin
+QDUP = defPrimWord("?DUP", () -> begin
ensurePSDepth(1)
val = mem[reg.PSP]
if val != 0
return NEXT
end)
-LIT = defPrim("LIT", () -> begin
+INCR = defPrimWord("1+", () -> begin
+ ensurePSDepth(1)
+ mem[reg.PSP] += 1
+ return NEXT
+end)
+
+DECR = defPrimWord("1-", () -> begin
+ ensurePSDepth(1)
+ mem[reg.PSP] -= 1
+ return NEXT
+end)
+
+INCR2 = defPrimWord("2+", () -> begin
+ ensurePSDepth(1)
+ mem[reg.PSP] += 2
+ return NEXT
+end)
+
+DECR2 = defPrimWord("2-", () -> begin
+ ensurePSDepth(1)
+ mem[reg.PSP] -= 2
+ return NEXT
+end)
+
+ADD = defPrimWord("+", () -> begin
+ b = popPS()
+ a = popPS()
+ pushPS(a+b)
+ return NEXT
+end)
+
+SUB = defPrimWord("-", () -> begin
+ b = popPS()
+ a = popPS()
+ pushPS(a-b)
+ return NEXT
+end)
+
+MUL = defPrimWord("*", () -> begin
+ b = popPS()
+ a = popPS()
+ pushPS(a*b)
+ return NEXT
+end)
+
+DIVMOD = defPrimWord("/MOD", () -> begin
+ b = popPS()
+ a = popPS()
+ q,r = divrem(a,b)
+ pushPS(r)
+ pushPS(q)
+ return NEXT
+end)
+
+TWOMUL = defPrimWord("2*", () -> begin
+ pushPS(popPS() << 1)
+ return NEXT
+end)
+
+TWODIV = defPrimWord("2/", () -> begin
+ pushPS(popPS() >> 1)
+ return NEXT
+end)
+
+EQ = defPrimWord("=", () -> begin
+ b = popPS()
+ a = popPS()
+ pushPS(a==b ? -1 : 0)
+ return NEXT
+end)
+
+NE = defPrimWord("<>", () -> begin
+ b = popPS()
+ a = popPS()
+ pushPS(a!=b ? -1 : 0)
+ return NEXT
+end)
+
+LT = defPrimWord("<", () -> begin
+ b = popPS()
+ a = popPS()
+ pushPS(a<b ? -1 : 0)
+ return NEXT
+end)
+
+GT = defPrimWord(">", () -> begin
+ b = popPS()
+ a = popPS()
+ pushPS(a>b ? -1 : 0)
+ return NEXT
+end)
+
+LE = defPrimWord("<=", () -> begin
+ b = popPS()
+ a = popPS()
+ pushPS(a<=b ? -1 : 0)
+ return NEXT
+end)
+
+GE = defPrimWord(">=", () -> begin
+ b = popPS()
+ a = popPS()
+ pushPS(a>=b ? -1 : 0)
+ return NEXT
+end)
+
+ZE = defPrimWord("0=", () -> begin
+ pushPS(popPS() == 0 ? -1 : 0)
+ return NEXT
+end)
+
+ZNE = defPrimWord("0<>", () -> begin
+ pushPS(popPS() != 0 ? -1 : 0)
+ return NEXT
+end)
+
+ZLT = defPrimWord("0<", () -> begin
+ pushPS(popPS() < 0 ? -1 : 0)
+ return NEXT
+end)
+
+ZGT = defPrimWord("0>", () -> begin
+ pushPS(popPS() > 0 ? -1 : 0)
+ return NEXT
+end)
+
+ZLE = defPrimWord("0<=", () -> begin
+ pushPS(popPS() <= 0 ? -1 : 0)
+ return NEXT
+end)
+
+ZGE = defPrimWord("0>=", () -> begin
+ pushPS(popPS() >= 0 ? -1 : 0)
+ return NEXT
+end)
+
+AND = defPrimWord("AND", () -> begin
+ b = popPS()
+ a = popPS()
+ pushPS(a & b)
+ return NEXT
+end)
+
+OR = defPrimWord("OR", () -> begin
+ b = popPS()
+ a = popPS()
+ pushPS(a | b)
+ return NEXT
+end)
+
+XOR = defPrimWord("XOR", () -> begin
+ b = popPS()
+ a = popPS()
+ pushPS(a $ b)
+ return NEXT
+end)
+
+INVERT = defPrimWord("INVERT", () -> begin
+ pushPS(~popPS())
+ return NEXT
+end)
+
+# Literals
+
+LIT = defPrimWord("LIT", () -> begin
pushPS(mem[reg.IP])
reg.IP += 1
return NEXT
# Memory primitives
-STORE = defPrim("!", () -> begin
+STORE = defPrimWord("!", () -> begin
addr = popPS()
dat = popPS()
mem[addr] = dat
return NEXT
end)
-FETCH = defPrim("@", () -> begin
+FETCH = defPrimWord("@", () -> begin
addr = popPS()
pushPS(mem[addr])
return NEXT
end)
-ADDSTORE = defPrim("+!", () -> begin
+ADDSTORE = defPrimWord("+!", () -> begin
addr = popPS()
toAdd = popPS()
mem[addr] += toAdd
return NEXT
end)
-SUBSTORE = defPrim("-!", () -> begin
+SUBSTORE = defPrimWord("-!", () -> begin
addr = popPS()
toSub = popPS()
mem[addr] -= toSub
end)
-# Built-in variables
-
-defExistingVar("HERE", HERE)
-defExistingVar("LATEST", LATEST)
-defExistingVar("PSP0", PSP0)
-defExistingVar("RSP0", RSP0)
-STATE = defNewVar("STATE", 0)
-BASE = defNewVar("BASE", 10)
-
-# Constants
-
-defConst("VERSION", 1)
-defConst("DOCOL", DOCOL)
-defConst("DICT", DICT)
-F_IMMED = defConst("F_IMMED", 100)
-F_HIDEN = defConst("F_HIDDEN", 1000)
-
# Return Stack
-TOR = defPrim(">R", () -> begin
+TOR = defPrimWord(">R", () -> begin
pushRS(popPS())
return NEXT
end)
-FROMR = defPrim("R>", () -> begin
+FROMR = defPrimWord("R>", () -> begin
pushPS(popRS())
return NEXT
end)
-RSPFETCH = defPrim("RSP@", () -> begin
+RFETCH = defPrimWord("R@", () -> begin
+ pushPS(mem[reg.RSP])
+ return NEXT
+end)
+
+RSPFETCH = defPrimWord("RSP@", () -> begin
pushPS(reg.RSP)
return NEXT
end)
-RSPSTORE = defPrim("RSP!", () -> begin
- RSP = popPS()
+RSPSTORE = defPrimWord("RSP!", () -> begin
+ reg.RSP = popPS()
return NEXT
end)
-RDROP = defPrim("RDROP", () -> begin
+RDROP = defPrimWord("RDROP", () -> begin
popRS()
return NEXT
end)
# Parameter Stack
-PSPFETCH = defPrim("PSP@", () -> begin
+PSPFETCH = defPrimWord("PSP@", () -> begin
pushPS(reg.PSP)
return NEXT
end)
-PSPSTORE = defPrim("PSP!", () -> begin
- PSP = popPS()
+PSPSTORE = defPrimWord("PSP!", () -> begin
+ reg.PSP = popPS()
+ return NEXT
+end)
+
+# Working Register
+
+WFETCH = defPrimWord("W@", () -> begin
+ pushPS(reg.W)
+ return NEXT
+end)
+
+WSTORE = defPrimWord("W!", () -> begin
+ reg.W = popPS()
return NEXT
end)
# I/O
-defConst("TIB", TIB)
-NUMTIB = defNewVar("#TIB", 0)
-TOIN = defNewVar(">IN", 0)
+sources = Array{Any,1}()
+currentSource() = sources[length(sources)]
-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)]
+EOF = defPrimWord("\x04", () -> begin
+ if currentSource() != STDIN
+ close(pop!(sources))
+ return NEXT
+ else
+ return 0
end
+end)
- pushPS(mem[TIB + mem[TOIN]])
- mem[TOIN] += 1
+EMIT = defPrimWord("EMIT", () -> begin
+ print(Char(popPS()))
+ return NEXT
+end)
+
+function raw_mode!(mode::Bool)
+ if ccall(:jl_tty_set_mode, Int32, (Ptr{Void}, Int32), STDIN.handle, mode) != 0
+ throw("FATAL: Terminal unable to enter raw mode.")
+ end
+end
+
+function getKey()
+ raw_mode!(true)
+ byte = readbytes(STDIN, 1)[1]
+ raw_mode!(false)
+
+ if byte == 0x0d
+ return 0x0a
+ elseif byte == 127
+ return 0x08
+ else
+ return byte
+ end
+end
+KEY = defPrimWord("KEY", () -> begin
+ pushPS(Int(getKey()))
return NEXT
end)
-EMIT = defPrim("EMIT", () -> begin
- print(Char(popPS()))
+function getLineFromSTDIN()
+ line = ""
+ while true
+ key = Char(getKey())
+
+ if key == '\n'
+ print(" ")
+ return ASCIIString(line)
+
+ elseif key == '\x04'
+ if isempty(line)
+ return string("\x04")
+ end
+
+ elseif key == '\b'
+ if !isempty(line)
+ line = line[1:length(line)-1]
+ print("\b \b")
+ end
+
+ elseif key == '\e'
+ # Strip ANSI escape sequence
+ nextKey = Char(getKey())
+ if nextKey == '['
+ while true
+ nextKey = Char(getKey())
+ if nextKey >= '@' || nextKey <= '~'
+ break
+ end
+ end
+ end
+
+ else
+ print(key)
+ line = string(line, key)
+ end
+ end
+end
+
+SPAN, SPAN_CFA = defNewVar("SPAN", 0)
+EXPECT = defPrimWord("EXPECT", () -> begin
+ maxLen = popPS()
+ addr = popPS()
+
+ if currentSource() == STDIN
+ line = getLineFromSTDIN()
+ else
+ if !eof(currentSource())
+ line = chomp(readline(currentSource()))
+ else
+ line = "\x04" # eof
+ end
+ end
+
+ mem[SPAN] = min(length(line), maxLen)
+ putString(line[1:mem[SPAN]], addr)
+
return NEXT
end)
-WORD = defPrim("WORD", () -> begin
-
- c = -1
+BASE, BASE_CFA = defNewVar("BASE", 10)
+NUMBER = defPrimWord("NUMBER", () -> begin
+ wordAddr = popPS()+1
+ wordLen = mem[wordAddr-1]
- skip_to_end = false
- while true
+ s = getString(wordAddr, wordLen)
+
+ pushPS(parse(Int64, s, mem[BASE]))
+
+ return NEXT
+end)
+
+# Dictionary searches
+
+TOCFA = defPrimWord(">CFA", () -> begin
+
+ addr = popPS()
+ lenAndFlags = mem[addr+1]
+ len = lenAndFlags & F_LENMASK
+
+ pushPS(addr + 2 + len)
+
+ return NEXT
+end)
+
+TOBODY = defWord(">BODY", [INCR, EXIT])
+
+FIND = defPrimWord("FIND", () -> begin
- callPrim(KEY)
- c = Char(popPS())
+ countedAddr = popPS()
+ wordAddr = countedAddr + 1
+ wordLen = mem[countedAddr]
+ word = lowercase(getString(wordAddr, wordLen))
- if c == '\\'
- skip_to_end = true
+ latest = LATEST
+ lenAndFlags = 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
continue
end
+
+ thisAddr = latest+2
+ thisWord = lowercase(getString(thisAddr, len))
- if skip_to_end
- if c == '\n'
- skip_to_end = false
- end
- continue
+ if lowercase(thisWord) == lowercase(word)
+ break
end
+ end
- if c == ' ' || c == '\t'
- continue
+ if latest > 0
+ pushPS(latest)
+ callPrim(mem[TOCFA])
+ if (lenAndFlags & F_IMMED) == F_IMMED
+ pushPS(1)
+ else
+ pushPS(-1)
end
+ else
+ pushPS(countedAddr)
+ pushPS(0)
+ end
+
+ return NEXT
+end)
+
+
+# Branching
+
+BRANCH = defPrimWord("BRANCH", () -> begin
+ reg.IP += mem[reg.IP]
+ return NEXT
+end)
- break
+ZBRANCH = defPrimWord("0BRANCH", () -> begin
+ if (popPS() == 0)
+ reg.IP += mem[reg.IP]
+ else
+ reg.IP += 1
end
- wordAddr = mem[HERE]
- offset = 0
+ return NEXT
+end)
+
+# Strings
- while true
- mem[wordAddr + offset] = Int64(c)
- offset += 1
+LITSTRING = defPrimWord("LITSTRING", () -> begin
+ len = mem[reg.IP]
+ reg.IP += 1
+ pushPS(reg.IP)
+ pushPS(len)
+ reg.IP += len
+
+ return NEXT
+end)
+
+TYPE = defPrimWord("TYPE", () -> begin
+ len = popPS()
+ addr = popPS()
+ str = getString(addr, len)
+ print(str)
+ return NEXT
+end)
+
+# Outer interpreter
+
+TRACE = defPrimWord("TRACE", () -> begin
+ println("reg.W: $(reg.W) reg.IP: $(reg.IP)")
+ print("PS: "); printPS()
+ print("RS: "); printRS()
+ print("[paused]")
+ readline()
+
+ return NEXT
+end)
+
+COMMA = defPrimWord(",", () -> begin
+ mem[mem[H]] = popPS()
+ mem[H] += 1
+
+ return NEXT
+end)
+
+BTICK = defWord("[']",
+ [FROMR, DUP, INCR, TOR, FETCH, EXIT])
- callPrim(KEY)
- c = Char(popPS())
+EXECUTE = defPrimWord("EXECUTE", () -> begin
+ reg.W = popPS()
+ return mem[reg.W]
+end)
+
+TIB_CFA = defConst("TIB", TIB)
+NUMTIB, NUMTIB_CFA = defNewVar("#TIB", 0)
+TOIN, TOIN_CFA = defNewVar(">IN", 0)
+
+QUERY = defWord("QUERY",
+ [TIB_CFA, LIT, 160, EXPECT,
+ SPAN_CFA, FETCH, NUMTIB_CFA, STORE,
+ LIT, 0, TOIN_CFA, STORE,
+ EXIT])
+
+WORD = defPrimWord("WORD", () -> begin
+ delim = popPS()
+
+ # Chew up initial occurrences of delim
+ while (mem[TOIN]<mem[NUMTIB] && mem[TIB+mem[TOIN]] == delim)
+ mem[TOIN] += 1
+ end
- if c == ' ' || c == '\t' || c == '\n'
+ countAddr = mem[H]
+ addr = mem[H]+1
+
+ # Start reading in word
+ count = 0
+ while (mem[TOIN]<mem[NUMTIB])
+ mem[addr] = mem[TIB+mem[TOIN]]
+ mem[TOIN] += 1
+
+ if (mem[addr] == delim)
break
end
+
+ count += 1
+ addr += 1
end
- wordLen = offset
+ # Record count
+ mem[countAddr] = count
+ pushPS(countAddr)
+
+ return NEXT
+end)
+
+PARSE = defPrimWord("PARSE", () -> begin
+ delim = popPS()
+
+ # Chew up initial occurrences of delim
+ addr = mem[H]
+
+ # Start reading input stream
+ count = 0
+ while (mem[TOIN]<mem[NUMTIB])
+ mem[addr] = mem[TIB+mem[TOIN]]
+ mem[TOIN] += 1
+
+ if (mem[addr] == delim)
+ break
+ end
+
+ count += 1
+ addr += 1
+ end
- pushPS(wordAddr)
- pushPS(wordLen)
+ pushPS(addr)
+ pushPS(count)
return NEXT
end)
-NUMBER = defPrim("NUMBER", () -> begin
+BYE = defPrimWord("BYE", () -> begin
+ println("\nBye!")
+ return 0
+end)
+
+STATE, STATE_CFA = defNewVar("STATE", 0)
- wordLen = popPS()
- wordAddr = popPS()
+INTERPRET = defWord("INTERPRET",
+ [LIT, 32, WORD, # Read next space-delimited word
- s = ASCIIString([Char(c) for c in mem[wordAddr:(wordAddr+wordLen-1)]])
+ DUP, FETCH, ZE, ZBRANCH, 3,
+ DROP, EXIT, # Exit if TIB is exhausted
- try
- pushPS(parse(Int64, s, mem[BASE]))
- pushPS(0)
- catch
- pushPS(1) # Error indication
+ STATE_CFA, FETCH, ZBRANCH, 24,
+ # Compiling
+ FIND, QDUP, ZBRANCH, 13,
+
+ # Found word.
+ LIT, -1, EQ, INVERT, ZBRANCH, 4,
+
+ # Immediate: Execute!
+ EXECUTE, BRANCH, -26,
+
+ # Not immediate: Compile!
+ COMMA, BRANCH, -29,
+
+ # No word found, parse number
+ NUMBER, BTICK, LIT, COMMA, COMMA, BRANCH, -36,
+
+ # Interpreting
+ FIND, QDUP, ZBRANCH, 5,
+
+ # Found word. Execute!
+ DROP, EXECUTE, BRANCH, -44,
+
+ # No word found, parse number and leave on stack
+ NUMBER, BRANCH, -47,
+ EXIT]
+)
+
+PROMPT = defPrimWord("PROMPT", () -> begin
+ if (mem[STATE] == 0 && currentSource() == STDIN)
+ println(" ok")
end
return NEXT
end)
+QUIT = defWord("QUIT",
+ [LIT, 0, STATE_CFA, STORE,
+ LIT, 0, NUMTIB_CFA, STORE,
+ RSP0_CFA, RSPSTORE,
+ QUERY,
+ INTERPRET, PROMPT,
+ BRANCH,-4])
+
+ABORT = defWord("ABORT",
+ [PSP0_CFA, PSPSTORE, QUIT])
+
+INCLUDE = defPrimWord("INCLUDE", () -> begin
+ pushPS(32)
+ callPrim(mem[WORD])
+ wordAddr = popPS()+1
+ wordLen = mem[wordAddr-1]
+ word = getString(wordAddr, wordLen)
+
+ push!(sources, open(word, "r"))
+
+ # Clear input buffer
+ mem[NUMTIB] = 0
+
+ return NEXT
+end)
+
+# Compilation
+
+HERE = defWord("HERE",
+ [H_CFA, FETCH, EXIT])
+
+HEADER = defPrimWord("HEADER", () -> begin
+ wordAddr = popPS()+1
+ wordLen = mem[wordAddr-1]
+ word = getString(wordAddr, wordLen)
+
+ createHeader(word, 0)
+
+ return NEXT
+end)
+
+CREATE = defWord("CREATE",
+ [LIT, 32, WORD, HEADER,
+ LIT, DOVAR, COMMA,
+ EXIT])
+
+DODOES = defPrim(() -> begin
+ pushRS(reg.IP)
+ reg.IP = popPS()
+ pushPS(reg.W + 1)
+ return NEXT
+end, name="DODOES")
+
+DOES_HELPER = defPrimWord("(DOES>)", () -> begin
+
+ pushPS(mem[LATEST])
+ callPrim(mem[TOCFA])
+ cfa = popPS()
+
+ runtimeAddr = popPS()
+
+ mem[cfa] = defPrim(eval(:(() -> begin
+ pushPS($(runtimeAddr))
+ return DODOES
+ end)), name="doesPrim")
+
+ return NEXT
+end, flags=F_IMMED)
+
+DOES = defWord("DOES>",
+ [BTICK, LIT, COMMA, HERE, LIT, 3, ADD, COMMA,
+ BTICK, DOES_HELPER, COMMA, BTICK, EXIT, COMMA, EXIT],
+ flags=F_IMMED)
+
+LBRAC = defPrimWord("[", () -> begin
+ mem[STATE] = 0
+ return NEXT
+end, flags=F_IMMED)
+
+RBRAC = defPrimWord("]", () -> begin
+ mem[STATE] = 1
+ return NEXT
+end, flags=F_IMMED)
+
+HIDDEN = defPrimWord("HIDDEN", () -> begin
+ lenAndFlagsAddr = mem[LATEST] + 1
+ mem[lenAndFlagsAddr] = mem[lenAndFlagsAddr] $ F_HIDDEN
+ return NEXT
+end)
+
+COLON = defWord(":",
+ [LIT, 32, WORD,
+ HEADER,
+ LIT, DOCOL, COMMA,
+ HIDDEN,
+ RBRAC,
+ EXIT])
+
+SEMICOLON = defWord(";",
+ [LIT, EXIT, COMMA,
+ HIDDEN,
+ LBRAC,
+ EXIT], flags=F_IMMED)
+
+IMMEDIATE = defPrimWord("IMMEDIATE", () -> begin
+ lenAndFlagsAddr = mem[LATEST] + 1
+ mem[lenAndFlagsAddr] = mem[lenAndFlagsAddr] $ F_IMMED
+ return NEXT
+end, flags=F_IMMED)
+
+
#### VM loop ####
-#function runVM(reg::Reg)
-# jmp = NEXT
-# while (jmp = callPrim(reg, jmp)) != 0 end
-#end
-# Debugging tools
+initialized = false
+initFileName = nothing
+if isfile("lib.4th")
+ initFileName = "lib.4th"
+elseif isfile(Pkg.dir("forth/src/lib.4th"))
+ initFileName = Pkg.dir("forth/src/lib.4th")
+end
-function coredump(startAddr::Int64; count::Int64 = 16, cellsPerLine::Int64 = 8)
- chars = Array{Char,1}(cellsPerLine)
+function run(;initialize=true)
+ # Begin with STDIN as source
+ push!(sources, STDIN)
- for i in 0:(count-1)
- addr = startAddr + i
- if i%cellsPerLine == 0
- print("$addr:")
+ global initialized, initFileName
+ if !initialized && initialize
+ if initFileName != nothing
+ print("Including definitions from $initFileName...")
+ push!(sources, open(initFileName, "r"))
+ initialized = true
+ else
+ println("No library file found. Only primitive words available.")
end
+ end
- print("\t$(mem[addr]) ")
+ # Start with IP pointing to first instruction of outer interpreter
+ reg.IP = QUIT + 1
- if (mem[addr]>=32 && mem[addr]<176)
- chars[i%cellsPerLine + 1] = Char(mem[addr])
- else
- chars[i%cellsPerLine + 1] = '.'
+ # Primitive processing loop.
+ # Everyting else is simply a consequence of this loop!
+ jmp = NEXT
+ while jmp != 0
+ try
+ #println("Entering prim $(getPrimName(jmp))")
+ jmp = callPrim(jmp)
+
+ catch ex
+ showerror(STDOUT, ex)
+ println()
+
+ while !isempty(sources) && currentSource() != STDIN
+ close(pop!(sources))
+ end
+
+ # QUIT
+ reg.IP = ABORT + 1
+ jmp = NEXT
end
+ end
+end
- if i%cellsPerLine == cellsPerLine-1
- println(string("\t", ASCIIString(chars)))
+# 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
function printPS()
- count = reg.PSP - mem[PSP0]
+ count = reg.PSP - PSP0
if count > 0
print("<$count>")
- for i in (mem[PSP0]+1):reg.PSP
+ for i in (PSP0+1):reg.PSP
print(" $(mem[i])")
end
println()
end
end
+function printRS()
+ count = reg.RSP - RSP0
+
+ if count > 0
+ print("<$count>")
+ for i in (RSP0+1):reg.RSP
+ print(" $(mem[i])")
+ end
+ println()
+ else
+ println("Return stack empty")
+ end
+end
+
+DUMP = defPrimWord("DUMP", () -> begin
+ count = popPS()
+ addr = popPS()
+
+ println()
+ dump(addr, count=count)
+
+ return NEXT
+end)
+
end