7 size_RS = 1024 # Return stack size
8 size_PS = 1024 # Parameter stack size
9 size_TIB = 1096 # Terminal input buffer size
11 # The mem array constitutes the memory of the VM. It has the following geography:
13 # mem = +-----------------------+
14 # | Built-in Variables |
15 # +-----------------------+
17 # +-----------------------+
19 # +-----------------------+
20 # | Terminal Input Buffer |
21 # +-----------------------+
23 # +-----------------------+
25 # Note that all words (user-defined, primitive, variables, etc) are included in
28 # Simple linear addressing is used with one exception: references to primitive code
29 # blocks, which are represented as anonymous functions, appear as negative indicies
30 # into the primitives array which contains these functions.
32 mem = Array{Int64,1}(size_mem)
33 primitives = Array{Function,1}()
34 primNames = Array{ASCIIString,1}()
39 RSP0 = nextVarAddr; nextVarAddr += 1
40 PSP0 = nextVarAddr; nextVarAddr += 1
41 HERE = nextVarAddr; nextVarAddr += 1
42 LATEST = nextVarAddr; nextVarAddr += 1
44 mem[RSP0] = nextVarAddr # bottom of RS
45 mem[PSP0] = mem[RSP0] + size_RS # bottom of PS
46 TIB = mem[PSP0] + size_PS # address of terminal input buffer
47 mem[HERE] = TIB + size_TIB # location of bottom of dictionary
48 mem[LATEST] = 0 # no previous definition
50 DICT = mem[HERE] # Save bottom of dictionary as constant
54 RSP::Int64 # Return stack pointer
55 PSP::Int64 # Parameter/data stack pointer
56 IP::Int64 # Instruction pointer
57 W::Int64 # Working register
59 reg = Reg(mem[RSP0], mem[PSP0], 0, 0)
61 # Stack manipulation functions
63 type StackUnderflow <: Exception end
65 getRSDepth() = reg.RSP - mem[RSP0]
66 getPSDepth() = reg.PSP - mem[PSP0]
68 function ensurePSDepth(depth::Int64)
70 throw(StackUnderflow())
74 function ensureRSDepth(depth::Int64)
76 throw(StackUnderflow())
80 function pushRS(val::Int64)
92 function pushPS(val::Int64)
93 mem[reg.PSP += 1] = val
104 # Handy functions for adding/retrieving strings to/from memory.
106 getString(addr::Int64, len::Int64) = ASCIIString([Char(c) for c in mem[addr:(addr+len-1)]])
107 function putString(str::ASCIIString, addr::Int64)
108 mem[addr:(addr+length(str)-1)] = [Int64(c) for c in str]
111 # Primitive creation and calling functions
113 function defPrim(f::Function; name="nameless")
115 push!(primNames, replace(replace(name, "\004", "EOF"), "\n", "\\n"))
117 return -length(primitives)
120 callPrim(addr::Int64) = primitives[-addr]()
124 function createHeader(name::AbstractString, flags::Int64)
125 mem[mem[HERE]] = mem[LATEST]
126 mem[LATEST] = mem[HERE]
129 mem[mem[HERE]] = length(name) | flags; mem[HERE] += 1
130 putString(name, mem[HERE]); mem[HERE] += length(name)
133 function defPrimWord(name::AbstractString, f::Function; flags::Int64=0)
134 createHeader(name, flags)
136 codeWordAddr = mem[HERE]
137 mem[codeWordAddr] = defPrim(f, name=name)
143 function defWord(name::AbstractString, wordAddrs::Array{Int64,1}; flags::Int64=0)
144 createHeader(name, flags)
147 mem[mem[HERE]] = DOCOL
150 for wordAddr in wordAddrs
151 mem[mem[HERE]] = wordAddr
160 function defExistingVar(name::AbstractString, varAddr::Int64; flags::Int64=0)
162 defPrimWord(name, eval(:(() -> begin
168 function defNewVar(name::AbstractString, initial::Int64; flags::Int64=0)
169 createHeader(name, flags)
171 codeWordAddr = mem[HERE]
172 varAddr = mem[HERE] + 1
174 f = eval(:(() -> begin
179 mem[mem[HERE]] = defPrim(f, name=name); mem[HERE] += 1
180 mem[mem[HERE]] = initial; mem[HERE] += 1
182 return varAddr, codeWordAddr
185 function defConst(name::AbstractString, val::Int64; flags::Int64=0)
186 defPrimWord(name, eval(:(() -> begin
194 # Threading Primitives (inner interpreter)
196 NEXT = defPrim(() -> begin
202 DOCOL = defPrim(() -> begin
208 EXIT = defPrimWord("EXIT", () -> begin
213 # Basic forth primitives
215 DROP = defPrimWord("DROP", () -> begin
220 SWAP = defPrimWord("SWAP", () -> begin
228 DUP = defPrimWord("DUP", () -> begin
234 OVER = defPrimWord("OVER", () -> begin
236 pushPS(mem[reg.PSP-1])
240 ROT = defPrimWord("ROT", () -> begin
250 NROT = defPrimWord("-ROT", () -> begin
260 TWODROP = defPrimWord("2DROP", () -> begin
266 TWODUP = defPrimWord("2DUP", () -> begin
275 TWOSWAP = defPrimWord("2SWAP", () -> begin
287 QDUP = defPrimWord("?DUP", () -> begin
296 INCR = defPrimWord("1+", () -> begin
302 DECR = defPrimWord("1-", () -> begin
308 INCR2 = defPrimWord("2+", () -> begin
314 DECR2 = defPrimWord("2-", () -> begin
320 ADD = defPrimWord("+", () -> begin
327 SUB = defPrimWord("-", () -> begin
334 MUL = defPrimWord("*", () -> begin
341 DIVMOD = defPrimWord("/MOD", () -> begin
350 EQU = defPrimWord("=", () -> begin
353 pushPS(a==b ? -1 : 0)
357 NEQU = defPrimWord("<>", () -> begin
360 pushPS(a!=b ? -1 : 0)
364 LT = defPrimWord("<", () -> begin
371 GT = defPrimWord(">", () -> begin
378 LE = defPrimWord("<=", () -> begin
381 pushPS(a<=b ? -1 : 0)
385 GE = defPrimWord(">=", () -> begin
388 pushPS(a>=b ? -1 : 0)
392 ZEQU = defPrimWord("0=", () -> begin
393 pushPS(popPS() == 0 ? -1 : 0)
397 ZNEQU = defPrimWord("0<>", () -> begin
398 pushPS(popPS() != 0 ? -1 : 0)
402 ZLT = defPrimWord("0<", () -> begin
403 pushPS(popPS() < 0 ? -1 : 0)
407 ZGT = defPrimWord("0>", () -> begin
408 pushPS(popPS() > 0 ? -1 : 0)
412 ZLE = defPrimWord("0<=", () -> begin
413 pushPS(popPS() <= 0 ? -1 : 0)
417 ZGE = defPrimWord("0>=", () -> begin
418 pushPS(popPS() >= 0 ? -1 : 0)
422 AND = defPrimWord("AND", () -> begin
429 OR = defPrimWord("OR", () -> begin
436 XOR = defPrimWord("XOR", () -> begin
443 INVERT = defPrimWord("INVERT", () -> begin
450 LIT = defPrimWord("LIT", () -> begin
458 STORE = defPrimWord("!", () -> begin
465 FETCH = defPrimWord("@", () -> begin
471 ADDSTORE = defPrimWord("+!", () -> begin
478 SUBSTORE = defPrimWord("-!", () -> begin
488 HERE_CFA = defExistingVar("HERE", HERE)
489 LATEST_CFA = defExistingVar("LATEST", LATEST)
490 PSP0_CFA = defExistingVar("PSP0", PSP0)
491 RSP0_CFA = defExistingVar("RSP0", RSP0)
492 STATE, STATE_CFA = defNewVar("STATE", 0)
493 BASE, BASE_CFA = defNewVar("BASE", 10)
497 defConst("VERSION", 1)
498 defConst("DOCOL", DOCOL)
499 defConst("DICT", DICT)
500 F_IMMED = defConst("F_IMMED", 128)
501 F_HIDDEN = defConst("F_HIDDEN", 256)
502 F_LENMASK = defConst("F_LENMASK", 127)
506 TOR = defPrimWord(">R", () -> begin
511 FROMR = defPrimWord("R>", () -> begin
516 RSPFETCH = defPrimWord("RSP@", () -> begin
521 RSPSTORE = defPrimWord("RSP!", () -> begin
526 RDROP = defPrimWord("RDROP", () -> begin
533 PSPFETCH = defPrimWord("PSP@", () -> begin
538 PSPSTORE = defPrimWord("PSP!", () -> begin
545 WFETCH = defPrimWord("W@", () -> begin
550 WSTORE = defPrimWord("W!", () -> begin
557 sources = Array{Any,1}()
558 currentSource() = sources[length(sources)]
561 NUMTIB, NUMTIB_CFA = defNewVar("#TIB", 0)
562 TOIN, TOIN_CFA = defNewVar(">IN", 0)
563 EOF = defConst("EOF", 4)
565 KEY = defPrimWord("KEY", () -> begin
566 if mem[TOIN] >= mem[NUMTIB]
569 if !eof(currentSource())
570 line = readline(currentSource())
571 mem[NUMTIB] = length(line)
579 pushPS(mem[TIB + mem[TOIN]])
585 EMIT = defPrimWord("EMIT", () -> begin
590 WORD = defPrimWord("WORD", () -> begin
607 if c == '\n' || c == eof_char
613 if c == ' ' || c == '\t'
623 if c == '\n' || c == eof_char
624 # Treat newline as a special word
626 mem[wordAddr + offset] = Int64(c)
633 mem[wordAddr + offset] = Int64(c)
639 if c == ' ' || c == '\t' || c == '\n' || c == eof_char
654 NUMBER = defPrimWord("NUMBER", () -> begin
659 s = getString(wordAddr, wordLen)
662 pushPS(parse(Int64, s, mem[BASE]))
665 pushPS(1) # Error indication
671 # Dictionary searches
673 FIND = defPrimWord("FIND", () -> begin
677 word = lowercase(getString(wordAddr, wordLen))
682 while (latest = mem[latest]) > 0
683 lenAndFlags = mem[latest+1]
684 len = lenAndFlags & F_LENMASK
685 hidden = (lenAndFlags & F_HIDDEN) == F_HIDDEN
687 if hidden || len != wordLen
692 thisWord = lowercase(getString(thisAddr, len))
694 if lowercase(thisWord) == lowercase(word)
704 TOCFA = defPrimWord(">CFA", () -> begin
707 lenAndFlags = mem[addr+1]
708 len = lenAndFlags & F_LENMASK
710 pushPS(addr + 2 + len)
715 TODFA = defWord(">DFA", [TOCFA, INCR, EXIT])
719 BRANCH = defPrimWord("BRANCH", () -> begin
720 reg.IP += mem[reg.IP]
724 ZBRANCH = defPrimWord("0BRANCH", () -> begin
726 reg.IP += mem[reg.IP]
736 CREATE = defPrimWord("CREATE", () -> begin
740 word = getString(wordAddr, wordLen)
742 createHeader(word, 0)
747 COMMA = defPrimWord(",", () -> begin
748 mem[mem[HERE]] = popPS()
754 LBRAC = defPrimWord("[", () -> begin
759 RBRAC = defPrimWord("]", () -> begin
764 HIDDEN = defPrimWord("HIDDEN", () -> begin
766 mem[addr] = mem[addr] $ F_HIDDEN
770 HIDE = defWord("HIDE",
780 LATEST_CFA, FETCH, HIDDEN,
784 SEMICOLON = defWord(";",
786 LATEST_CFA, FETCH, HIDDEN,
788 EXIT], flags=F_IMMED)
790 IMMEDIATE = defPrimWord("IMMEDIATE", () -> begin
791 lenAndFlagsAddr = mem[LATEST] + 1
792 mem[lenAndFlagsAddr] = mem[lenAndFlagsAddr] $ F_IMMED
797 [STATE_CFA, FETCH, ZBRANCH, 7,
798 FROMR, DUP, INCR, TOR, FETCH, EXIT,
799 WORD, FIND, TOCFA, EXIT])
803 LITSTRING = defPrimWord("LITSTRING", () -> begin
813 TELL = defPrimWord("TELL", () -> begin
816 str = getString(addr, len)
823 EXECUTE = defPrimWord("EXECUTE", () -> begin
828 INTERPRET = defPrimWord("INTERPRET", () -> begin
832 wordName = getString(mem[reg.PSP-1], mem[reg.PSP])
833 #println("... ", replace(replace(wordName, "\004", "EOF"), "\n", "\\n"), " ...")
835 callPrim(mem[TWODUP])
838 wordAddr = mem[reg.PSP]
843 isImmediate = (mem[wordAddr+1] & F_IMMED) != 0
846 callPrim(mem[ROT]) # get rid of extra copy of word string details
850 if mem[STATE] == 0 || isImmediate
852 return callPrim(mem[EXECUTE])
854 # Append CFA to dictionary
858 # Not in dictionary, assume number
862 callPrim(mem[NUMBER])
865 println("Parse error at word: '$wordName'")
870 # Number already on stack!
872 # Append literal to dictionary
882 QUIT = defWord("QUIT",
887 BYE = defPrimWord("BYE", () -> begin
891 NL = defPrimWord("\n", () -> begin
892 if mem[STATE] == 0 && currentSource() == STDIN
898 INCLUDE = defPrimWord("INCLUDE", () -> begin
902 word = getString(wordAddr, wordLen)
904 push!(sources, open(word, "r"))
912 EOF_WORD = defPrimWord("\x04", () -> begin
913 if currentSource() != STDIN
914 close(currentSource())
928 CHAR = defPrimWord("CHAR", () -> begin
932 word = getString(wordAddr, wordLen)
933 pushPS(Int64(word[1]))
940 # Begin with STDIN as source
941 push!(sources, STDIN)
943 # Start with IP pointing to first instruction of outer interpreter
946 # Primitive processing loop.
947 # Everyting else is simply a consequence of this loop!
951 #println("Evaluating prim ", jmp," ", primNames[-jmp])
955 if isa(ex, StackUnderflow)
956 println("Stack underflow!")
970 function dump(startAddr::Int64; count::Int64 = 100, cellsPerLine::Int64 = 10)
971 chars = Array{Char,1}(cellsPerLine)
973 lineStartAddr = cellsPerLine*div((startAddr-1),cellsPerLine) + 1
974 endAddr = startAddr + count - 1
976 q, r = divrem((endAddr-lineStartAddr+1), cellsPerLine)
977 numLines = q + (r > 0 ? 1 : 0)
983 for c in 1:cellsPerLine
984 if i >= startAddr && i <= endAddr
986 if mem[i]>=32 && mem[i]<128
987 chars[c] = Char(mem[i])
999 println("\t", ASCIIString(chars))
1004 count = reg.PSP - mem[PSP0]
1008 for i in (mem[PSP0]+1):reg.PSP
1013 println("Parameter stack empty")
1018 count = reg.RSP - mem[RSP0]
1022 for i in (mem[RSP0]+1):reg.RSP
1027 println("Return stack empty")
1031 DOT = defPrimWord(".", () -> begin
1036 #DOTS = defPrimWord(".s", () -> begin
1041 DUMP = defPrimWord("DUMP", () -> begin
1045 dump(addr, count=count)