4 size_mem = 1000000 # 1 mega-int
7 size_RS = 1000 # Return stack size
8 size_PS = 1000 # Parameter stack size
9 size_TIB = 1000 # Terminal input buffer size
12 mem = Array{Int64,1}(size_mem)
13 primitives = Array{Function,1}()
14 primNames = Array{ASCIIString,1}()
19 H = nextVarAddr; nextVarAddr += 1 # Next free memory address
20 FORTH_LATEST = nextVarAddr; nextVarAddr += 1 # FORTH dict latest
21 CURRENT = nextVarAddr; nextVarAddr += 1 # Current compilation dict
23 RSP0 = nextVarAddr # bottom of RS
24 PSP0 = RSP0 + size_RS # bottom of PS
25 TIB = PSP0 + size_PS # address of terminal input buffer
26 mem[H] = TIB + size_TIB # location of bottom of dictionary
27 mem[FORTH_LATEST] = 0 # zero FORTH dict latest (no previous def)
28 mem[CURRENT] = FORTH_LATEST-1 # Compile words to system dict initially
30 DICT = mem[H] # Save bottom of dictionary as constant
34 RSP::Int64 # Return stack pointer
35 PSP::Int64 # Parameter/data stack pointer
36 IP::Int64 # Instruction pointer
37 W::Int64 # Working register
39 reg = Reg(RSP0, PSP0, 0, 0)
41 # Stack manipulation functions
43 function ensurePSDepth(depth::Int64)
44 if reg.PSP - PSP0 < depth
45 error("Parameter stack underflow.")
49 function ensureRSDepth(depth::Int64)
50 if reg.RSP - RSP0 < depth
51 error("Return stack underflow.")
55 function pushRS(val::Int64)
67 function pushPS(val::Int64)
68 mem[reg.PSP += 1] = val
79 # Handy functions for adding/retrieving strings to/from memory.
81 getString(addr::Int64, len::Int64) = ASCIIString([Char(c) for c in mem[addr:(addr+len-1)]])
83 function putString(str::ASCIIString, addr::Int64)
84 mem[addr:(addr+length(str)-1)] = [Int64(c) for c in str]
87 # Primitive creation and calling functions
89 function defPrim(f::Function; name="nameless")
91 push!(primNames, replace(name, "\004", "EOF"))
93 return -length(primitives)
96 function callPrim(addr::Int64)
97 if addr >=0 || -addr>length(primitives)
98 error("Attempted to execute non-existent primitive at address $addr.")
103 getPrimName(addr::Int64) = primNames[-addr]
105 # Word creation functions
112 function dictWrite(ints::Array{Int64,1})
113 mem[mem[H]:(mem[H]+length(ints)-1)] = ints
114 mem[H] += length(ints)
116 dictWrite(int::Int64) = dictWrite([int])
117 dictWriteString(string::ASCIIString) = dictWrite([Int64(c) for c in string])
119 function createHeader(name::AbstractString, flags::Int64)
120 mem[mem[H]] = mem[mem[CURRENT]+1]
121 mem[mem[CURRENT]+1] = mem[H]
124 dictWrite(length(name) | flags | NFA_MARK)
125 dictWriteString(name)
128 function defPrimWord(name::AbstractString, f::Function; flags::Int64=0)
129 createHeader(name, flags)
131 codeWordAddr = mem[H]
132 dictWrite(defPrim(f, name=name))
137 function defWord(name::AbstractString, wordAddrs::Array{Int64,1}; flags::Int64=0)
138 createHeader(name, flags)
148 # Variable creation functions
150 function defExistingVar(name::AbstractString, varAddr::Int64; flags::Int64=0)
152 defPrimWord(name, eval(:(() -> begin
158 function defNewVar(name::AbstractString, initial::Array{Int64,1}; flags::Int64=0)
159 createHeader(name, flags)
161 codeWordAddr = mem[H]
167 return varAddr, codeWordAddr
170 defNewVar(name::AbstractString, initial::Int64; flags::Int64=0) =
171 defNewVar(name, [initial]; flags=flags)
173 function defConst(name::AbstractString, val::Int64; flags::Int64=0)
174 createHeader(name, flags)
176 codeWordAddr = mem[H]
184 # Threading Primitives (inner interpreter)
186 NEXT = defPrim(() -> begin
192 DOCOL = defPrim(() -> begin
198 DOVAR = defPrim(() -> begin
203 DOCON = defPrim(() -> begin
204 pushPS(mem[reg.W + 1])
208 EXIT_CFA = defPrimWord("EXIT", () -> begin
213 # Dictionary entries for core built-in variables, constants
215 H_CFA = defExistingVar("H", H)
217 PSP0_CFA = defConst("PSP0", PSP0)
218 RSP0_CFA = defConst("RSP0", RSP0)
220 defConst("DOCOL", DOCOL)
221 defConst("DOCON", DOCON)
222 defConst("DOVAR", DOVAR)
224 defConst("DICT", DICT)
225 defConst("MEMSIZE", size_mem)
227 F_IMMED_CFA = defConst("F_IMMED", F_IMMED)
228 F_HIDDEN_CFA = defConst("F_HIDDEN", F_HIDDEN)
229 F_LENMASK_CFA = defConst("F_LENMASK", F_LENMASK)
230 NFA_MARK_CFA = defConst("NFA_MARK", NFA_MARK)
232 # Basic forth primitives
234 DROP_CFA = defPrimWord("DROP", () -> begin
239 SWAP_CFA = defPrimWord("SWAP", () -> begin
247 DUP_CFA = defPrimWord("DUP", () -> begin
253 OVER_CFA = defPrimWord("OVER", () -> begin
255 pushPS(mem[reg.PSP-1])
259 ROT_CFA = defPrimWord("ROT", () -> begin
269 NROT_CFA = defPrimWord("-ROT", () -> begin
280 TWODROP_CFA = defPrimWord("2DROP", () -> begin
286 TWODUP_CFA = defPrimWord("2DUP", () -> begin
295 TWOSWAP_CFA = defPrimWord("2SWAP", () -> begin
307 TWOOVER_CFA = defPrimWord("2OVER", () -> begin
316 QDUP_CFA = defPrimWord("?DUP", () -> begin
325 INCR_CFA = defPrimWord("1+", () -> begin
331 DECR_CFA = defPrimWord("1-", () -> begin
337 INCR2_CFA = defPrimWord("2+", () -> begin
343 DECR2_CFA = defPrimWord("2-", () -> begin
349 ADD_CFA = defPrimWord("+", () -> begin
356 SUB_CFA = defPrimWord("-", () -> begin
363 MUL_CFA = defPrimWord("*", () -> begin
370 DIVMOD_CFA = defPrimWord("/MOD", () -> begin
379 TWOMUL_CFA = defPrimWord("2*", () -> begin
384 TWODIV_CFA = defPrimWord("2/", () -> begin
389 EQ_CFA = defPrimWord("=", () -> begin
392 pushPS(a==b ? -1 : 0)
396 NE_CFA = defPrimWord("<>", () -> begin
399 pushPS(a!=b ? -1 : 0)
403 LT_CFA = defPrimWord("<", () -> begin
410 GT_CFA = defPrimWord(">", () -> begin
417 LE_CFA = defPrimWord("<=", () -> begin
420 pushPS(a<=b ? -1 : 0)
424 GE_CFA = defPrimWord(">=", () -> begin
427 pushPS(a>=b ? -1 : 0)
431 ZE_CFA = defPrimWord("0=", () -> begin
432 pushPS(popPS() == 0 ? -1 : 0)
436 ZNE_CFA = defPrimWord("0<>", () -> begin
437 pushPS(popPS() != 0 ? -1 : 0)
441 ZLT_CFA = defPrimWord("0<", () -> begin
442 pushPS(popPS() < 0 ? -1 : 0)
446 ZGT_CFA = defPrimWord("0>", () -> begin
447 pushPS(popPS() > 0 ? -1 : 0)
451 ZLE_CFA = defPrimWord("0<=", () -> begin
452 pushPS(popPS() <= 0 ? -1 : 0)
456 ZGE_CFA = defPrimWord("0>=", () -> begin
457 pushPS(popPS() >= 0 ? -1 : 0)
461 AND_CFA = defPrimWord("AND", () -> begin
468 OR_CFA = defPrimWord("OR", () -> begin
475 XOR_CFA = defPrimWord("XOR", () -> begin
482 INVERT_CFA = defPrimWord("INVERT", () -> begin
489 LIT_CFA = defPrimWord("LIT", () -> begin
497 STORE_CFA = defPrimWord("!", () -> begin
504 FETCH_CFA = defPrimWord("@", () -> begin
510 ADDSTORE_CFA = defPrimWord("+!", () -> begin
517 SUBSTORE_CFA = defPrimWord("-!", () -> begin
527 TOR_CFA = defPrimWord(">R", () -> begin
532 FROMR_CFA = defPrimWord("R>", () -> begin
537 RFETCH_CFA = defPrimWord("R@", () -> begin
542 RSPFETCH_CFA = defPrimWord("RSP@", () -> begin
547 RSPSTORE_CFA = defPrimWord("RSP!", () -> begin
552 RDROP_CFA = defPrimWord("RDROP", () -> begin
559 PSPFETCH_CFA = defPrimWord("PSP@", () -> begin
564 PSPSTORE_CFA = defPrimWord("PSP!", () -> begin
571 WFETCH_CFA = defPrimWord("W@", () -> begin
576 WSTORE_CFA = defPrimWord("W!", () -> begin
583 sources = Array{Any,1}()
584 currentSource() = sources[length(sources)]
586 EOF_CFA = defPrimWord("\x04", () -> begin
587 if currentSource() != STDIN
595 EMIT_CFA = defPrimWord("EMIT", () -> begin
600 function raw_mode!(mode::Bool)
601 if ccall(:jl_tty_set_mode, Int32, (Ptr{Void}, Int32), STDIN.handle, mode) != 0
602 throw("FATAL: Terminal unable to enter raw mode.")
608 byte = readbytes(STDIN, 1)[1]
620 KEY_CFA = defPrimWord("KEY", () -> begin
621 pushPS(Int(getKey()))
625 function getLineFromSTDIN()
632 return ASCIIString(line)
636 return string("\x04")
641 line = line[1:length(line)-1]
646 # Strip ANSI escape sequence
647 nextKey = Char(getKey())
650 nextKey = Char(getKey())
651 if nextKey >= '@' || nextKey <= '~'
659 line = string(line, key)
664 SPAN, SPAN_CFA = defNewVar("SPAN", 0)
665 EXPECT_CFA = defPrimWord("EXPECT", () -> begin
669 if currentSource() == STDIN
670 line = getLineFromSTDIN()
672 if !eof(currentSource())
673 line = chomp(readline(currentSource()))
679 mem[SPAN] = min(length(line), maxLen)
680 putString(line[1:mem[SPAN]], addr)
685 BASE, BASE_CFA = defNewVar("BASE", 10)
686 NUMBER_CFA = defPrimWord("NUMBER", () -> begin
688 wordLen = mem[wordAddr-1]
690 s = getString(wordAddr, wordLen)
692 pushPS(parse(Int64, s, mem[BASE]))
697 # Dictionary searches
699 FROMLINK_CFA = defPrimWord("LINK>", () -> begin
702 lenAndFlags = mem[addr+1]
703 len = lenAndFlags & F_LENMASK
705 pushPS(addr + 2 + len)
710 createHeader("FORTH", 0)
712 dictWrite(defPrim(() -> begin
716 dictWrite(0) # cell for latest
718 CURRENT_CFA = defExistingVar("CURRENT", CURRENT)
720 # Switch to new FORTH vocabulary cfa
721 mem[FORTH_CFA+1] = mem[mem[CURRENT]+1]
722 mem[CURRENT] = FORTH_CFA
724 CONTEXT, CONTEXT_CFA = defNewVar("CONTEXT", zeros(Int64, 10))
725 mem[CONTEXT] = FORTH_CFA
726 NUMCONTEXT, NUMCONTEXT_CFA = defNewVar("#CONTEXT", 1)
728 FIND_CFA = defPrimWord("FIND", () -> begin
730 countedAddr = popPS()
731 wordAddr = countedAddr + 1
732 wordLen = mem[countedAddr]
733 word = lowercase(getString(wordAddr, wordLen))
735 context = mem[CONTEXT:(CONTEXT+mem[NUMCONTEXT]-1)]
740 for vocabCFA in reverse(context)
743 while (lfa = mem[lfa]) > 0
745 lenAndFlags = mem[lfa+1]
746 len = lenAndFlags & F_LENMASK
747 hidden = (lenAndFlags & F_HIDDEN) == F_HIDDEN
749 if hidden || len != wordLen
753 thisWord = lowercase(getString(lfa+2, len))
767 callPrim(mem[FROMLINK_CFA])
768 if (lenAndFlags & F_IMMED) == F_IMMED
784 BRANCH_CFA = defPrimWord("BRANCH", () -> begin
785 reg.IP += mem[reg.IP]
789 ZBRANCH_CFA = defPrimWord("0BRANCH", () -> begin
791 reg.IP += mem[reg.IP]
801 LITSTRING_CFA = defPrimWord("LITSTRING", () -> begin
811 TYPE_CFA = defPrimWord("TYPE", () -> begin
814 str = getString(addr, len)
819 # Interpreter/Compiler-specific I/O
821 TIB_CFA = defConst("TIB", TIB)
822 NUMTIB, NUMTIB_CFA = defNewVar("#TIB", 0)
823 TOIN, TOIN_CFA = defNewVar(">IN", 0)
825 QUERY_CFA = defWord("QUERY",
826 [TIB_CFA, LIT_CFA, 160, EXPECT_CFA,
827 SPAN_CFA, FETCH_CFA, NUMTIB_CFA, STORE_CFA,
828 LIT_CFA, 0, TOIN_CFA, STORE_CFA,
831 WORD_CFA = defPrimWord("WORD", () -> begin
834 # Chew up initial occurrences of delim
835 while (mem[TOIN]<mem[NUMTIB] && mem[TIB+mem[TOIN]] == delim)
842 # Start reading in word
844 while (mem[TOIN]<mem[NUMTIB])
845 mem[addr] = mem[TIB+mem[TOIN]]
848 if (mem[addr] == delim)
857 mem[countAddr] = count
865 STATE, STATE_CFA = defNewVar("STATE", 0)
867 COMMA_CFA = defPrimWord(",", () -> begin
868 mem[mem[H]] = popPS()
874 HERE_CFA = defWord("HERE",
875 [H_CFA, FETCH_CFA, EXIT_CFA])
877 HEADER_CFA = defPrimWord("HEADER", () -> begin
879 wordLen = mem[wordAddr-1]
880 word = getString(wordAddr, wordLen)
882 createHeader(word, 0)
887 CREATE_CFA = defWord("CREATE",
888 [LIT_CFA, 32, WORD_CFA, HEADER_CFA,
889 LIT_CFA, DOVAR, COMMA_CFA,
892 DODOES = defPrim(() -> begin
899 DOES_HELPER_CFA = defPrimWord("(DOES>)", () -> begin
901 pushPS(mem[mem[CURRENT]+1])
902 callPrim(mem[FROMLINK_CFA])
905 runtimeAddr = popPS()
907 mem[cfa] = defPrim(eval(:(() -> begin
908 pushPS($(runtimeAddr))
910 end)), name="doesPrim")
913 end, flags=F_IMMED | F_HIDDEN)
915 DOES_CFA = defWord("DOES>",
916 [LIT_CFA, LIT_CFA, COMMA_CFA, HERE_CFA, LIT_CFA, 3, ADD_CFA, COMMA_CFA,
917 LIT_CFA, DOES_HELPER_CFA, COMMA_CFA, LIT_CFA, EXIT_CFA, COMMA_CFA, EXIT_CFA],
920 LBRAC_CFA = defPrimWord("[", () -> begin
925 RBRAC_CFA = defPrimWord("]", () -> begin
930 HIDDEN_CFA = defPrimWord("HIDDEN", () -> begin
931 lenAndFlagsAddr = mem[mem[CURRENT]+1] + 1
932 mem[lenAndFlagsAddr] = mem[lenAndFlagsAddr] $ F_HIDDEN
936 COLON_CFA = defWord(":",
937 [LIT_CFA, 32, WORD_CFA,
939 LIT_CFA, DOCOL, COMMA_CFA,
944 SEMICOLON_CFA = defWord(";",
945 [LIT_CFA, EXIT_CFA, COMMA_CFA,
948 EXIT_CFA], flags=F_IMMED)
950 IMMEDIATE_CFA = defPrimWord("IMMEDIATE", () -> begin
951 lenAndFlagsAddr = mem[mem[CURRENT]+1] + 1
952 mem[lenAndFlagsAddr] = mem[lenAndFlagsAddr] $ F_IMMED
958 EXECUTE_CFA = defPrimWord("EXECUTE", () -> begin
963 INTERPRET_CFA = defWord("INTERPRET",
964 [LIT_CFA, 32, WORD_CFA, # Read next space-delimited word
966 DUP_CFA, FETCH_CFA, ZE_CFA, ZBRANCH_CFA, 3,
967 DROP_CFA, EXIT_CFA, # Exit if TIB is exhausted
969 STATE_CFA, FETCH_CFA, ZBRANCH_CFA, 24,
971 FIND_CFA, QDUP_CFA, ZBRANCH_CFA, 13,
974 LIT_CFA, -1, EQ_CFA, INVERT_CFA, ZBRANCH_CFA, 4,
976 # Immediate: Execute!
977 EXECUTE_CFA, BRANCH_CFA, -26,
979 # Not immediate: Compile!
980 COMMA_CFA, BRANCH_CFA, -29,
982 # No word found, parse number
983 NUMBER_CFA, LIT_CFA, LIT_CFA, COMMA_CFA, COMMA_CFA, BRANCH_CFA, -36,
986 FIND_CFA, QDUP_CFA, ZBRANCH_CFA, 5,
988 # Found word. Execute!
989 DROP_CFA, EXECUTE_CFA, BRANCH_CFA, -44,
991 # No word found, parse number and leave on stack
992 NUMBER_CFA, BRANCH_CFA, -47,
995 PROMPT_CFA = defPrimWord("PROMPT", () -> begin
996 if (mem[STATE] == 0 && currentSource() == STDIN)
1003 QUIT_CFA = defWord("QUIT",
1004 [LIT_CFA, 0, STATE_CFA, STORE_CFA,
1005 LIT_CFA, 0, NUMTIB_CFA, STORE_CFA,
1006 RSP0_CFA, RSPSTORE_CFA,
1008 INTERPRET_CFA, PROMPT_CFA,
1011 ABORT_CFA = defWord("ABORT",
1012 [PSP0_CFA, PSPSTORE_CFA, QUIT_CFA])
1014 BYE_CFA = defPrimWord("BYE", () -> begin
1021 INCLUDE_CFA = defPrimWord("INCLUDE", () -> begin
1023 callPrim(mem[WORD_CFA])
1024 wordAddr = popPS()+1
1025 wordLen = mem[wordAddr-1]
1026 word = getString(wordAddr, wordLen)
1030 fname = Pkg.dir("forth","src",word)
1032 error("No file named $word found in current directory or package source directory.")
1035 push!(sources, open(fname, "r"))
1037 # Clear input buffer
1047 initFileName = nothing
1048 if isfile("lib.4th")
1049 initFileName = "lib.4th"
1050 elseif isfile(Pkg.dir("forth","src", "lib.4th"))
1051 initFileName = Pkg.dir("forth","src","lib.4th")
1054 function run(;initialize=true)
1055 # Begin with STDIN as source
1056 push!(sources, STDIN)
1058 global initialized, initFileName
1059 if !initialized && initialize
1060 if initFileName != nothing
1061 print("Including definitions from $initFileName...")
1062 push!(sources, open(initFileName, "r"))
1065 println("No library file found. Only primitive words available.")
1069 # Start with IP pointing to first instruction of outer interpreter
1070 reg.IP = QUIT_CFA + 1
1072 # Primitive processing loop.
1073 # Everyting else is simply a consequence of this loop!
1077 #println("Entering prim $(getPrimName(jmp))")
1081 showerror(STDOUT, ex)
1084 while !isempty(sources) && currentSource() != STDIN
1085 close(pop!(sources))
1089 reg.IP = ABORT_CFA + 1
1097 TRACE_CFA = defPrimWord("TRACE", () -> begin
1098 println("reg.W: $(reg.W) reg.IP: $(reg.IP)")
1099 print("PS: "); printPS()
1100 print("RS: "); printRS()
1107 function dump(startAddr::Int64; count::Int64 = 100, cellsPerLine::Int64 = 10)
1108 chars = Array{Char,1}(cellsPerLine)
1110 lineStartAddr = cellsPerLine*div((startAddr-1),cellsPerLine) + 1
1111 endAddr = startAddr + count - 1
1113 q, r = divrem((endAddr-lineStartAddr+1), cellsPerLine)
1114 numLines = q + (r > 0 ? 1 : 0)
1120 for c in 1:cellsPerLine
1121 if i >= startAddr && i <= endAddr
1123 if mem[i]>=32 && mem[i]<128
1124 chars[c] = Char(mem[i])
1136 println("\t", ASCIIString(chars))
1141 count = reg.PSP - PSP0
1145 for i in (PSP0+1):reg.PSP
1150 println("Parameter stack empty")
1155 count = reg.RSP - RSP0
1159 for i in (RSP0+1):reg.RSP
1164 println("Return stack empty")
1168 DUMP = defPrimWord("DUMP", () -> begin
1173 dump(addr, count=count)