Removed old INCLUDE def.
[forth.jl.git] / src / forth.jl
index 63e7d57..2bd68b9 100644 (file)
@@ -1,5 +1,7 @@
 module forth
 
+import Base.REPLCompletions
+
 # VM mem size
 size_mem = 1000000 # 1 mega-int
 
@@ -11,21 +13,21 @@ size_TIB = 1000  # Terminal input buffer size
 # 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              # Next free memory address
-FORTH_LATEST = nextVarAddr; nextVarAddr += 1   # LFA of latest word in system dict
+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[FORTH_LATEST] = 0               # no previous definition
-mem[CURRENT] = FORTH_LATEST         # Compile words to system dict initially
+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
 
@@ -46,13 +48,26 @@ function ensurePSDepth(depth::Int64)
     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
 
@@ -65,6 +80,8 @@ function popRS()
 end
 
 function pushPS(val::Int64)
+    ensurePSCapacity(1)
+
     mem[reg.PSP += 1] = val
 end
 
@@ -78,12 +95,15 @@ 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")
@@ -114,11 +134,11 @@ function dictWrite(ints::Array{Int64,1})
     mem[H] += length(ints)
 end
 dictWrite(int::Int64) = dictWrite([int])
-dictWriteString(string::ASCIIString) = dictWrite([Int64(c) for c in string])
+dictWriteString(string::AbstractString) = dictWrite([Int64(c) for c in string])
 
 function createHeader(name::AbstractString, flags::Int64)
-    mem[mem[H]] = mem[mem[CURRENT]]
-    mem[mem[CURRENT]] = mem[H]
+    mem[mem[H]] = mem[mem[CURRENT]+1]
+    mem[mem[CURRENT]+1] = mem[H]
     mem[H] += 1
 
     dictWrite(length(name) | flags | NFA_MARK)
@@ -213,7 +233,6 @@ end)
 # Dictionary entries for core built-in variables, constants
 
 H_CFA = defExistingVar("H", H)
-CURRENT_CFA = defExistingVar("CURRENT", CURRENT)
 
 PSP0_CFA = defConst("PSP0", PSP0)
 RSP0_CFA = defConst("RSP0", RSP0)
@@ -581,18 +600,70 @@ end)
 
 # I/O
 
-sources = Array{Any,1}()
-currentSource() = sources[length(sources)]
+openFiles = Dict{Int64,IOStream}()
+nextFileID = 1
+SOURCE_ID, SOURCE_ID_CFA = defNewVar("SOURCE-ID", 0)
+
+
+## File access modes
+FAM_RO = 0
+FAM_WO = 1
+FAM_RO_CFA = defConst("R/O", FAM_RO)
+FAM_WO_CFA = defConst("W/O", FAM_WO)
 
-EOF_CFA = defPrimWord("\x04", () -> begin
-    if currentSource() != STDIN
-        close(pop!(sources))
+function fileOpener(create::Bool)
+    fnameLen = popPS()
+    fnameAddr = popPS()
+    fam = popPS()
+
+    fname = getString(fnameAddr, fnameLen)
+
+    if create && !isfile(fname)
+        pushPS(0)
+        pushPS(-1) # error
         return NEXT
+    end
+
+    if (fam == FAM_RO)
+        mode = "r"
     else
-        return 0
+        mode = "w"
     end
+
+    openFiles[nextFileID] = open(fname, mode)
+    pushPS(nextFileID)
+    pushPS(0)
+    
+    nextFileID += 1
+end
+
+OPEN_FILE_CFA = defPrimWord("OPEN-FILE", () -> begin
+    fileOpener(false)
+    return NEXT
+end);
+
+CREATE_FILE_CFA = defPrimWord("CREATE-FILE", () -> begin
+    fileOpener(true)
+    return NEXT
+end);
+
+CLOSE_FILE_CFA = defPrimWord("CLOSE-FILE", () -> begin
+    fid = popPS()
+    close(openFiles[fid])
+    delete!(openFiles, fid)
+    return NEXT
 end)
 
+CLOSE_FILES_CFA = defPrimWord("CLOSE-FILES", () -> begin
+    for fh in values(openFiles)
+        close(fh)
+    end
+    empty!(openFiles)
+
+    return NEXT
+end)
+                              
+
 EMIT_CFA = defPrimWord("EMIT", () -> begin
     print(Char(popPS()))
     return NEXT
@@ -624,13 +695,31 @@ KEY_CFA = defPrimWord("KEY", () -> begin
 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)
@@ -639,8 +728,8 @@ function getLineFromSTDIN()
 
         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'
@@ -655,6 +744,20 @@ function getLineFromSTDIN()
                 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)
@@ -667,18 +770,10 @@ EXPECT_CFA = 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
+    line = getLineFromSTDIN()
 
     mem[SPAN] = min(length(line), maxLen)
-    putString(line[1:mem[SPAN]], addr)
+    putString(line, addr, maxLen)
 
     return NEXT
 end)
@@ -708,51 +803,49 @@ FROMLINK_CFA = defPrimWord("LINK>", () -> begin
     return NEXT
 end)
 
+NUMCONTEXT, NUMCONTEXT_CFA = defNewVar("#CONTEXT", 1)
+
 createHeader("FORTH", 0)
 FORTH_CFA = mem[H]
 dictWrite(defPrim(() -> begin
-    mem[CONTEXT] = reg.W
+    mem[CONTEXT + mem[NUMCONTEXT] - 1] = reg.W
     return NEXT
 end, name="FORTH"))
-dictWrite(FORTH_LATEST)
+dictWrite(0) # cell for latest
 
-CONTEXT, CONTEXT_CFA = defNewVar("CONTEXT", zeros(Int64, 100))
-mem[CONTEXT] = FORTH_CFA
-NUMCONTEXT, NUMCONTEXT_CFA = defNewVar("#CONTEXT", 1)
+CURRENT_CFA = defExistingVar("CURRENT", CURRENT)
 
-FIND_CFA = defPrimWord("FIND", () -> begin
+# 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))
 
-    context = mem[CONTEXT:(CONTEXT+mem[NUMCONTEXT]-1)]
-
+    lfa = vocabCFA+1
     lenAndFlags = 0
-    lfa = 0
-
-    for vocabCFA in reverse(context)
-        lfa = mem[vocabCFA+1]
 
-        while (lfa = mem[lfa]) > 0
+    while (lfa = mem[lfa]) > 0
 
-            lenAndFlags = mem[lfa+1]
-            len = lenAndFlags & F_LENMASK
-            hidden = (lenAndFlags & F_HIDDEN) == F_HIDDEN
+        lenAndFlags = mem[lfa+1]
+        len = lenAndFlags & F_LENMASK
+        hidden = (lenAndFlags & F_HIDDEN) == F_HIDDEN
 
-            if hidden || len != wordLen
-                continue
-            end
-
-            thisWord = lowercase(getString(lfa+2, len))
-
-            if thisWord == word
-                break
-            end
+        if hidden || len != wordLen
+            continue
         end
 
-        if lfa>0
+        thisWord = lowercase(getString(lfa+2, len))
+
+        if thisWord == word
             break
         end
     end
@@ -773,6 +866,31 @@ FIND_CFA = defPrimWord("FIND", () -> begin
     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
 
@@ -893,7 +1011,7 @@ end, name="DODOES")
 
 DOES_HELPER_CFA = defPrimWord("(DOES>)", () -> begin
 
-    pushPS(mem[mem[CURRENT]])
+    pushPS(mem[mem[CURRENT]+1])
     callPrim(mem[FROMLINK_CFA])
     cfa = popPS()
 
@@ -923,7 +1041,7 @@ RBRAC_CFA = defPrimWord("]", () -> begin
 end, flags=F_IMMED)
 
 HIDDEN_CFA = defPrimWord("HIDDEN", () -> begin
-    lenAndFlagsAddr = mem[mem[CURRENT]] + 1
+    lenAndFlagsAddr = mem[mem[CURRENT]+1] + 1
     mem[lenAndFlagsAddr] = mem[lenAndFlagsAddr] $ F_HIDDEN
     return NEXT
 end)
@@ -943,11 +1061,50 @@ SEMICOLON_CFA = defWord(";",
     EXIT_CFA], flags=F_IMMED)
 
 IMMEDIATE_CFA = defPrimWord("IMMEDIATE", () -> begin
-    lenAndFlagsAddr = mem[mem[CURRENT]] + 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
@@ -988,9 +1145,10 @@ INTERPRET_CFA = defWord("INTERPRET",
     EXIT_CFA])
 
 PROMPT_CFA = defPrimWord("PROMPT", () -> begin
-    if (mem[STATE] == 0 && currentSource() == STDIN)
-        println(" ok")
+    if mem[STATE] == 0
+        print(" ok")
     end
+    println()
 
     return NEXT
 end)
@@ -1004,38 +1162,13 @@ QUIT_CFA = defWord("QUIT",
     BRANCH_CFA,-4])
 
 ABORT_CFA = defWord("ABORT",
-    [PSP0_CFA, PSPSTORE_CFA, QUIT_CFA])
+    [CLOSE_FILES_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 ####
 
 initialized = false
@@ -1047,14 +1180,14 @@ elseif isfile(Pkg.dir("forth","src", "lib.4th"))
 end
 
 function run(;initialize=true)
-    # Begin with STDIN as source
-    push!(sources, STDIN)
 
     global initialized, initFileName
     if !initialized && initialize
         if initFileName != nothing
             print("Including definitions from $initFileName...")
-            push!(sources, open(initFileName, "r"))
+
+            # TODO
+
             initialized = true
         else
             println("No library file found. Only primitive words available.")
@@ -1076,10 +1209,6 @@ function run(;initialize=true)
             showerror(STDOUT, ex)
             println()
 
-            while !isempty(sources) && currentSource() != STDIN
-                close(pop!(sources))
-            end
-
             # QUIT
             reg.IP = ABORT_CFA + 1
             jmp = NEXT
@@ -1128,7 +1257,7 @@ function dump(startAddr::Int64; count::Int64 = 100, cellsPerLine::Int64 = 10)
             i += 1
         end
 
-        println("\t", ASCIIString(chars))
+        println("\t", AbstractString(chars))
     end
 end