module forth
+import Base.REPLCompletions
+
# VM mem size
size_mem = 1000000 # 1 mega-int
# Memory arrays
mem = Array{Int64,1}(size_mem)
primitives = Array{Function,1}()
-primNames = Array{ASCIIString,1}()
+primNames = Array{AbstractString,1}()
-# Built-in variables
+# Memory geography and built-in variables
nextVarAddr = 1
-H = nextVarAddr; nextVarAddr += 1
-LATEST = nextVarAddr; nextVarAddr += 1
+H = nextVarAddr; nextVarAddr += 1 # Next free memory address
+FORTH_LATEST = nextVarAddr; nextVarAddr += 1 # FORTH dict latest
+CURRENT = nextVarAddr; nextVarAddr += 1 # Current compilation dict
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
+mem[H] = TIB + size_TIB # location of bottom of dictionary
+mem[FORTH_LATEST] = 0 # zero FORTH dict latest (no previous def)
+mem[CURRENT] = FORTH_LATEST-1 # Compile words to system dict initially
DICT = mem[H] # Save bottom of dictionary as constant
end
end
+function ensurePSCapacity(toAdd::Int64)
+ if reg.PSP + toAdd >= PSP0 + size_PS
+ error("Parameter stack overflow.")
+ end
+end
+
function ensureRSDepth(depth::Int64)
if reg.RSP - RSP0 < depth
error("Return stack underflow.")
end
end
+function ensureRSCapacity(toAdd::Int64)
+ if reg.RSP + toAdd >= RSP0 + size_RS
+ error("Return stack overflow.")
+ end
+end
+
function pushRS(val::Int64)
+ ensureRSCapacity(1)
mem[reg.RSP+=1] = val
end
end
function pushPS(val::Int64)
+ ensurePSCapacity(1)
+
mem[reg.PSP += 1] = 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)]])
+getString(addr::Int64, len::Int64) = AbstractString([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]
+function putString(str::AbstractString, addr::Int64, maxLen::Int64)
+ len = min(length(str), maxLen)
+ mem[addr:(addr+len-1)] = [Int64(c) for c in str]
end
+stringAsInts(str::AbstractString) = [Int(c) for c in collect(str)]
+
# Primitive creation and calling functions
function defPrim(f::Function; name="nameless")
F_HIDDEN = 64
NFA_MARK = 128
+function dictWrite(ints::Array{Int64,1})
+ mem[mem[H]:(mem[H]+length(ints)-1)] = ints
+ mem[H] += length(ints)
+end
+dictWrite(int::Int64) = dictWrite([int])
+dictWriteString(string::AbstractString) = dictWrite([Int64(c) for c in string])
+
function createHeader(name::AbstractString, flags::Int64)
- mem[mem[H]] = mem[LATEST]
- mem[LATEST] = mem[H]
+ mem[mem[H]] = mem[mem[CURRENT]+1]
+ mem[mem[CURRENT]+1] = mem[H]
mem[H] += 1
- mem[mem[H]] = length(name) | flags | NFA_MARK; mem[H] += 1
- putString(name, mem[H]); mem[H] += length(name)
+ dictWrite(length(name) | flags | NFA_MARK)
+ dictWriteString(name)
end
function defPrimWord(name::AbstractString, f::Function; flags::Int64=0)
createHeader(name, flags)
codeWordAddr = mem[H]
- mem[codeWordAddr] = defPrim(f, name=name)
- mem[H] += 1
+ dictWrite(defPrim(f, name=name))
return codeWordAddr
end
createHeader(name, flags)
addr = mem[H]
- mem[mem[H]] = DOCOL
- mem[H] += 1
+ dictWrite(DOCOL)
- for wordAddr in wordAddrs
- mem[mem[H]] = wordAddr
- mem[H] += 1
- end
+ dictWrite(wordAddrs)
return addr
end
end)))
end
-function defNewVar(name::AbstractString, initial::Int64; flags::Int64=0)
+function defNewVar(name::AbstractString, initial::Array{Int64,1}; flags::Int64=0)
createHeader(name, flags)
codeWordAddr = mem[H]
varAddr = mem[H] + 1
- mem[mem[H]] = DOVAR; mem[H] += 1
- mem[mem[H]] = initial; mem[H] += 1
+ dictWrite(DOVAR)
+ dictWrite(initial)
return varAddr, codeWordAddr
end
+defNewVar(name::AbstractString, initial::Int64; flags::Int64=0) =
+ defNewVar(name, [initial]; flags=flags)
+
function defConst(name::AbstractString, val::Int64; flags::Int64=0)
createHeader(name, flags)
codeWordAddr = mem[H]
- mem[mem[H]] = DOCON; mem[H] += 1
- mem[mem[H]] = val; mem[H] += 1
+ dictWrite(DOCON)
+ dictWrite(val)
return codeWordAddr
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)
# I/O
-sources = Array{Any,1}()
-currentSource() = sources[length(sources)]
-
-EOF_CFA = defPrimWord("\x04", () -> begin
- if currentSource() != STDIN
- close(pop!(sources))
- return NEXT
- else
- return 0
- end
-end)
+openFiles = Dict{Int64,IOStream}()
+nextFileID = 1
+SOURCE_ID, SOURCE_ID_CFA = defNewVar("SOURCE-ID", 0)
EMIT_CFA = defPrimWord("EMIT", () -> begin
print(Char(popPS()))
end)
function getLineFromSTDIN()
+
+ function getFrag(s)
+ chars = collect(s)
+ slashIdx = findlast(chars, '\\')
+
+ if slashIdx > 0
+ return join(chars[slashIdx:length(chars)])
+ else
+ return nothing
+ end
+ end
+
+ function backspaceStr(s, bsCount)
+ oldLen = length(s)
+ newLen = max(0, oldLen - bsCount)
+ return join(collect(s)[1:newLen])
+ end
+
line = ""
while true
key = Char(getKey())
if key == '\n'
print(" ")
- return ASCIIString(line)
+ return AbstractString(line)
elseif key == '\x04'
if isempty(line)
elseif key == '\b'
if !isempty(line)
- line = line[1:length(line)-1]
- print("\b \b")
+ print("\b\033[K")
+ line = backspaceStr(line, 1)
end
elseif key == '\e'
end
end
+ elseif key == '\t'
+ # Currently do nothing
+
+ frag = getFrag(line)
+ if frag != nothing
+ if haskey(REPLCompletions.latex_symbols, frag)
+ print(repeat("\b", length(frag)))
+ print("\033[K")
+ comp = REPLCompletions.latex_symbols[frag]
+ line = string(backspaceStr(line, length(frag)), comp)
+ print(comp)
+ end
+ end
+
else
print(key)
line = string(line, key)
maxLen = popPS()
addr = popPS()
- if currentSource() == STDIN
- line = getLineFromSTDIN()
- else
- if !eof(currentSource())
- line = chomp(readline(currentSource()))
- else
- line = "\x04" # eof
- end
- end
+ line = getLineFromSTDIN()
mem[SPAN] = min(length(line), maxLen)
- putString(line[1:mem[SPAN]], addr)
+ putString(line, addr, maxLen)
return NEXT
end)
# Dictionary searches
-TOCFA_CFA = defPrimWord(">CFA", () -> begin
+FROMLINK_CFA = defPrimWord("LINK>", () -> begin
addr = popPS()
lenAndFlags = mem[addr+1]
return NEXT
end)
-TOBODY_CFA = defWord(">BODY", [INCR_CFA, EXIT_CFA])
+NUMCONTEXT, NUMCONTEXT_CFA = defNewVar("#CONTEXT", 1)
-FIND_CFA = defPrimWord("FIND", () -> begin
+createHeader("FORTH", 0)
+FORTH_CFA = mem[H]
+dictWrite(defPrim(() -> begin
+ mem[CONTEXT + mem[NUMCONTEXT] - 1] = reg.W
+ return NEXT
+end, name="FORTH"))
+dictWrite(0) # cell for latest
+CURRENT_CFA = defExistingVar("CURRENT", CURRENT)
+
+# Switch to new FORTH vocabulary cfa
+mem[FORTH_CFA+1] = mem[mem[CURRENT]+1]
+mem[CURRENT] = FORTH_CFA
+
+CONTEXT, CONTEXT_CFA = defNewVar("CONTEXT", zeros(Int64, 10))
+mem[CONTEXT] = FORTH_CFA
+
+FINDVOCAB_CFA = defPrimWord("FINDVOCAB", () -> begin
+ vocabCFA = popPS()
countedAddr = popPS()
+
wordAddr = countedAddr + 1
wordLen = mem[countedAddr]
word = lowercase(getString(wordAddr, wordLen))
- latest = LATEST
+ lfa = vocabCFA+1
lenAndFlags = 0
-
- i = 0
- while (latest = mem[latest]) > 0
- lenAndFlags = mem[latest+1]
+
+ while (lfa = mem[lfa]) > 0
+
+ lenAndFlags = mem[lfa+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 lowercase(thisWord) == lowercase(word)
+ thisWord = lowercase(getString(lfa+2, len))
+
+ if thisWord == word
break
end
end
- if latest > 0
- pushPS(latest)
- callPrim(mem[TOCFA_CFA])
+ if lfa > 0
+ pushPS(lfa)
+ callPrim(mem[FROMLINK_CFA])
if (lenAndFlags & F_IMMED) == F_IMMED
pushPS(1)
else
return NEXT
end)
+FIND_CFA = defPrimWord("FIND", () -> begin
+
+ countedAddr = popPS()
+ context = mem[CONTEXT:(CONTEXT+mem[NUMCONTEXT]-1)]
+
+ for vocabCFA in reverse(context)
+ pushPS(countedAddr)
+ pushPS(vocabCFA)
+ callPrim(mem[FINDVOCAB_CFA])
+
+ callPrim(mem[DUP_CFA])
+ if popPS() != 0
+ return NEXT
+ else
+ popPS()
+ popPS()
+ end
+ end
+
+ pushPS(countedAddr)
+ pushPS(0)
+
+ return NEXT
+end)
+
# Branching
return NEXT
end)
-# Outer interpreter
-
-COMMA_CFA = defPrimWord(",", () -> begin
- mem[mem[H]] = popPS()
- mem[H] += 1
-
- return NEXT
-end)
-
-BTICK_CFA = defWord("[']",
- [FROMR_CFA, DUP_CFA, INCR_CFA, TOR_CFA, FETCH_CFA, EXIT_CFA])
-
-EXECUTE_CFA = defPrimWord("EXECUTE", () -> begin
- reg.W = popPS()
- return mem[reg.W]
-end)
+# Interpreter/Compiler-specific I/O
TIB_CFA = defConst("TIB", TIB)
NUMTIB, NUMTIB_CFA = defNewVar("#TIB", 0)
return NEXT
end)
-PARSE_CFA = 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(addr)
- pushPS(count)
-
- return NEXT
-end)
-
-BYE_CFA = defPrimWord("BYE", () -> begin
- println("\nBye!")
- return 0
-end)
+# Compilation
STATE, STATE_CFA = defNewVar("STATE", 0)
-INTERPRET_CFA = defWord("INTERPRET",
- [LIT_CFA, 32, WORD_CFA, # Read next space-delimited word
-
- DUP_CFA, FETCH_CFA, ZE_CFA, ZBRANCH_CFA, 3,
- DROP_CFA, EXIT_CFA, # Exit if TIB is exhausted
-
- STATE_CFA, FETCH_CFA, ZBRANCH_CFA, 24,
- # Compiling
- FIND_CFA, QDUP_CFA, ZBRANCH_CFA, 13,
-
- # Found word.
- LIT_CFA, -1, EQ_CFA, INVERT_CFA, ZBRANCH_CFA, 4,
-
- # Immediate: Execute!
- EXECUTE_CFA, BRANCH_CFA, -26,
-
- # Not immediate: Compile!
- COMMA_CFA, BRANCH_CFA, -29,
-
- # No word found, parse number
- NUMBER_CFA, BTICK_CFA, LIT_CFA, COMMA_CFA, COMMA_CFA, BRANCH_CFA, -36,
-
- # Interpreting
- FIND_CFA, QDUP_CFA, ZBRANCH_CFA, 5,
-
- # Found word. Execute!
- DROP_CFA, EXECUTE_CFA, BRANCH_CFA, -44,
-
- # No word found, parse number and leave on stack
- NUMBER_CFA, BRANCH_CFA, -47,
- EXIT_CFA])
-
-PROMPT_CFA = defPrimWord("PROMPT", () -> begin
- if (mem[STATE] == 0 && currentSource() == STDIN)
- println(" ok")
- end
-
- return NEXT
-end)
-
-QUIT_CFA = defWord("QUIT",
- [LIT_CFA, 0, STATE_CFA, STORE_CFA,
- LIT_CFA, 0, NUMTIB_CFA, STORE_CFA,
- RSP0_CFA, RSPSTORE_CFA,
- QUERY_CFA,
- INTERPRET_CFA, PROMPT_CFA,
- BRANCH_CFA,-4])
-
-ABORT_CFA = defWord("ABORT",
- [PSP0_CFA, PSPSTORE_CFA, QUIT_CFA])
-
-INCLUDE_CFA = defPrimWord("INCLUDE", () -> begin
- pushPS(32)
- callPrim(mem[WORD_CFA])
- wordAddr = popPS()+1
- wordLen = mem[wordAddr-1]
- word = getString(wordAddr, wordLen)
-
- push!(sources, open(word, "r"))
-
- # Clear input buffer
- mem[NUMTIB] = 0
+COMMA_CFA = defPrimWord(",", () -> begin
+ mem[mem[H]] = popPS()
+ mem[H] += 1
return NEXT
end)
-# Compilation
-
HERE_CFA = defWord("HERE",
[H_CFA, FETCH_CFA, EXIT_CFA])
DOES_HELPER_CFA = defPrimWord("(DOES>)", () -> begin
- pushPS(mem[LATEST])
- callPrim(mem[TOCFA_CFA])
+ pushPS(mem[mem[CURRENT]+1])
+ callPrim(mem[FROMLINK_CFA])
cfa = popPS()
runtimeAddr = popPS()
end)), name="doesPrim")
return NEXT
-end, flags=F_IMMED)
+end, flags=F_IMMED | F_HIDDEN)
DOES_CFA = defWord("DOES>",
- [BTICK_CFA, LIT_CFA, COMMA_CFA, HERE_CFA, LIT_CFA, 3, ADD_CFA, COMMA_CFA,
- BTICK_CFA, DOES_HELPER_CFA, COMMA_CFA, BTICK_CFA, EXIT_CFA, COMMA_CFA, EXIT_CFA],
+ [LIT_CFA, LIT_CFA, COMMA_CFA, HERE_CFA, LIT_CFA, 3, ADD_CFA, COMMA_CFA,
+ LIT_CFA, DOES_HELPER_CFA, COMMA_CFA, LIT_CFA, EXIT_CFA, COMMA_CFA, EXIT_CFA],
flags=F_IMMED)
LBRAC_CFA = defPrimWord("[", () -> begin
end, flags=F_IMMED)
HIDDEN_CFA = defPrimWord("HIDDEN", () -> begin
- lenAndFlagsAddr = mem[LATEST] + 1
+ lenAndFlagsAddr = mem[mem[CURRENT]+1] + 1
mem[lenAndFlagsAddr] = mem[lenAndFlagsAddr] $ F_HIDDEN
return NEXT
end)
EXIT_CFA], flags=F_IMMED)
IMMEDIATE_CFA = defPrimWord("IMMEDIATE", () -> begin
- lenAndFlagsAddr = mem[LATEST] + 1
+ lenAndFlagsAddr = mem[mem[CURRENT]+1] + 1
mem[lenAndFlagsAddr] = mem[lenAndFlagsAddr] $ F_IMMED
return NEXT
end, flags=F_IMMED)
+CODE_CFA = defPrimWord("CODE", () -> begin
+ pushPS(32)
+ callPrim(mem[WORD_CFA])
+ callPrim(mem[HEADER_CFA])
+
+ exprString = "() -> begin\n"
+ while true
+ if mem[TOIN] >= mem[NUMTIB]
+ exprString = string(exprString, "\n")
+ if currentSource() == STDIN
+ println()
+ end
+
+ pushPS(TIB)
+ pushPS(160)
+ callPrim(mem[EXPECT_CFA])
+ mem[NUMTIB] = mem[SPAN]
+ mem[TOIN] = 0
+ end
+
+ pushPS(32)
+ callPrim(mem[WORD_CFA])
+ cAddr = popPS()
+ thisWord = getString(cAddr+1, mem[cAddr])
+
+ if uppercase(thisWord) == "END-CODE"
+ break
+ end
+
+ exprString = string(exprString, " ", thisWord)
+ end
+ exprString = string(exprString, "\nreturn NEXT\nend")
+
+ func = eval(parse(exprString))
+ dictWrite(defPrim(func))
+
+ return NEXT
+end)
+
+# Outer Interpreter
+
+EXECUTE_CFA = defPrimWord("EXECUTE", () -> begin
+ reg.W = popPS()
+ return mem[reg.W]
+end)
+
+INTERPRET_CFA = defWord("INTERPRET",
+ [LIT_CFA, 32, WORD_CFA, # Read next space-delimited word
+
+ DUP_CFA, FETCH_CFA, ZE_CFA, ZBRANCH_CFA, 3,
+ DROP_CFA, EXIT_CFA, # Exit if TIB is exhausted
+
+ STATE_CFA, FETCH_CFA, ZBRANCH_CFA, 24,
+ # Compiling
+ FIND_CFA, QDUP_CFA, ZBRANCH_CFA, 13,
+
+ # Found word.
+ LIT_CFA, -1, EQ_CFA, INVERT_CFA, ZBRANCH_CFA, 4,
+
+ # Immediate: Execute!
+ EXECUTE_CFA, BRANCH_CFA, -26,
+
+ # Not immediate: Compile!
+ COMMA_CFA, BRANCH_CFA, -29,
+
+ # No word found, parse number
+ NUMBER_CFA, LIT_CFA, LIT_CFA, COMMA_CFA, COMMA_CFA, BRANCH_CFA, -36,
+
+ # Interpreting
+ FIND_CFA, QDUP_CFA, ZBRANCH_CFA, 5,
+
+ # Found word. Execute!
+ DROP_CFA, EXECUTE_CFA, BRANCH_CFA, -44,
+
+ # No word found, parse number and leave on stack
+ NUMBER_CFA, BRANCH_CFA, -47,
+ EXIT_CFA])
+
+PROMPT_CFA = defPrimWord("PROMPT", () -> begin
+ if mem[STATE] == 0
+ print(" ok")
+ end
+ println()
+
+ return NEXT
+end)
+
+QUIT_CFA = defWord("QUIT",
+ [LIT_CFA, 0, STATE_CFA, STORE_CFA,
+ LIT_CFA, 0, NUMTIB_CFA, STORE_CFA,
+ RSP0_CFA, RSPSTORE_CFA,
+ QUERY_CFA,
+ INTERPRET_CFA, PROMPT_CFA,
+ BRANCH_CFA,-4])
+
+ABORT_CFA = defWord("ABORT",
+ [CLOSEFILES_CFA, PSP0_CFA, PSPSTORE_CFA, QUIT_CFA])
+
+BYE_CFA = defPrimWord("BYE", () -> begin
+ println("\nBye!")
+ return 0
+end)
+
+# File I/O
+
+INCLUDE_CFA = defPrimWord("INCLUDE", () -> begin
+ pushPS(32)
+ callPrim(mem[WORD_CFA])
+ wordAddr = popPS()+1
+ wordLen = mem[wordAddr-1]
+ word = getString(wordAddr, wordLen)
+
+ fname = word
+ if !isfile(fname)
+ fname = Pkg.dir("forth","src",word)
+ if !isfile(fname)
+ error("No file named $word found in current directory or package source directory.")
+ end
+ end
+ push!(sources, open(fname, "r"))
+
+ # Clear input buffer
+ mem[NUMTIB] = 0
+
+ return NEXT
+end)
+
#### VM loop ####
initFileName = nothing
if isfile("lib.4th")
initFileName = "lib.4th"
-elseif isfile(Pkg.dir("forth/src/lib.4th"))
- initFileName = Pkg.dir("forth/src/lib.4th")
+elseif isfile(Pkg.dir("forth","src", "lib.4th"))
+ initFileName = Pkg.dir("forth","src","lib.4th")
end
function run(;initialize=true)
i += 1
end
- println("\t", ASCIIString(chars))
+ println("\t", AbstractString(chars))
end
end