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 source::Any # Input stream in use
61 reg = Reg(mem[RSP0], mem[PSP0], 0, 0, STDIN)
63 # Stack manipulation functions
65 type StackUnderflow <: Exception end
67 getRSDepth() = reg.RSP - mem[RSP0]
68 getPSDepth() = reg.PSP - mem[PSP0]
70 function ensurePSDepth(depth::Int64)
72 throw(StackUnderflow())
76 function ensureRSDepth(depth::Int64)
78 throw(StackUnderflow())
82 function pushRS(val::Int64)
94 function pushPS(val::Int64)
95 mem[reg.PSP += 1] = val
106 # Handy functions for adding/retrieving strings to/from memory.
108 getString(addr::Int64, len::Int64) = ASCIIString([Char(c) for c in mem[addr:(addr+len-1)]])
109 function putString(str::ASCIIString, addr::Int64)
110 mem[addr:(addr+length(str)-1)] = [Int64(c) for c in str]
113 # Primitive creation and calling functions
115 function defPrim(f::Function; name="nameless")
117 push!(primNames, replace(replace(name, "\004", "EOF"), "\n", "\\n"))
119 return -length(primitives)
122 callPrim(addr::Int64) = primitives[-addr]()
126 function createHeader(name::AbstractString, flags::Int64)
127 mem[mem[HERE]] = mem[LATEST]
128 mem[LATEST] = mem[HERE]
131 mem[mem[HERE]] = length(name) | flags; mem[HERE] += 1
132 putString(name, mem[HERE]); mem[HERE] += length(name)
135 function defPrimWord(name::AbstractString, f::Function; flags::Int64=0)
136 createHeader(name, flags)
138 codeWordAddr = mem[HERE]
139 mem[codeWordAddr] = defPrim(f, name=name)
145 function defWord(name::AbstractString, wordAddrs::Array{Int64,1}; flags::Int64=0)
146 createHeader(name, flags)
149 mem[mem[HERE]] = DOCOL
152 for wordAddr in wordAddrs
153 mem[mem[HERE]] = wordAddr
162 function defExistingVar(name::AbstractString, varAddr::Int64; flags::Int64=0)
164 defPrimWord(name, eval(:(() -> begin
170 function defNewVar(name::AbstractString, initial::Int64; flags::Int64=0)
171 createHeader(name, flags)
173 codeWordAddr = mem[HERE]
174 varAddr = mem[HERE] + 1
176 f = eval(:(() -> begin
181 mem[mem[HERE]] = defPrim(f, name=name); mem[HERE] += 1
182 mem[mem[HERE]] = initial; mem[HERE] += 1
184 return varAddr, codeWordAddr
187 function defConst(name::AbstractString, val::Int64; flags::Int64=0)
188 defPrimWord(name, eval(:(() -> begin
196 # Threading Primitives (inner interpreter)
198 NEXT = defPrim(() -> begin
204 DOCOL = defPrim(() -> begin
210 EXIT = defPrimWord("EXIT", () -> begin
215 # Basic forth primitives
217 DROP = defPrimWord("DROP", () -> begin
222 SWAP = defPrimWord("SWAP", () -> begin
230 DUP = defPrimWord("DUP", () -> begin
236 OVER = defPrimWord("OVER", () -> begin
238 pushPS(mem[reg.PSP-1])
242 ROT = defPrimWord("ROT", () -> begin
252 NROT = defPrimWord("-ROT", () -> begin
262 TWODROP = defPrimWord("2DROP", () -> begin
268 TWODUP = defPrimWord("2DUP", () -> begin
277 TWOSWAP = defPrimWord("2SWAP", () -> begin
289 QDUP = defPrimWord("?DUP", () -> begin
298 INCR = defPrimWord("1+", () -> begin
304 DECR = defPrimWord("1-", () -> begin
310 INCR2 = defPrimWord("2+", () -> begin
316 DECR2 = defPrimWord("2-", () -> begin
322 ADD = defPrimWord("+", () -> begin
329 SUB = defPrimWord("-", () -> begin
336 MUL = defPrimWord("*", () -> begin
343 DIVMOD = defPrimWord("/MOD", () -> begin
352 EQU = defPrimWord("=", () -> begin
355 pushPS(a==b ? -1 : 0)
359 NEQU = defPrimWord("<>", () -> begin
362 pushPS(a!=b ? -1 : 0)
366 LT = defPrimWord("<", () -> begin
373 GT = defPrimWord(">", () -> begin
380 LE = defPrimWord("<=", () -> begin
383 pushPS(a<=b ? -1 : 0)
387 GE = defPrimWord(">=", () -> begin
390 pushPS(a>=b ? -1 : 0)
394 ZEQU = defPrimWord("0=", () -> begin
395 pushPS(popPS() == 0 ? -1 : 0)
399 ZNEQU = defPrimWord("0<>", () -> begin
400 pushPS(popPS() != 0 ? -1 : 0)
404 ZLT = defPrimWord("0<", () -> begin
405 pushPS(popPS() < 0 ? -1 : 0)
409 ZGT = defPrimWord("0>", () -> begin
410 pushPS(popPS() > 0 ? -1 : 0)
414 ZLE = defPrimWord("0<=", () -> begin
415 pushPS(popPS() <= 0 ? -1 : 0)
419 ZGE = defPrimWord("0>=", () -> begin
420 pushPS(popPS() >= 0 ? -1 : 0)
424 AND = defPrimWord("AND", () -> begin
431 OR = defPrimWord("OR", () -> begin
438 XOR = defPrimWord("XOR", () -> begin
445 INVERT = defPrimWord("INVERT", () -> begin
452 LIT = defPrimWord("LIT", () -> begin
460 STORE = defPrimWord("!", () -> begin
467 FETCH = defPrimWord("@", () -> begin
473 ADDSTORE = defPrimWord("+!", () -> begin
480 SUBSTORE = defPrimWord("-!", () -> begin
490 HERE_CFA = defExistingVar("HERE", HERE)
491 LATEST_CFA = defExistingVar("LATEST", LATEST)
492 PSP0_CFA = defExistingVar("PSP0", PSP0)
493 RSP0_CFA = defExistingVar("RSP0", RSP0)
494 STATE, STATE_CFA = defNewVar("STATE", 0)
495 BASE, BASE_CFA = defNewVar("BASE", 10)
499 defConst("VERSION", 1)
500 defConst("DOCOL", DOCOL)
501 defConst("DICT", DICT)
502 F_IMMED = defConst("F_IMMED", 128)
503 F_HIDDEN = defConst("F_HIDDEN", 256)
504 F_LENMASK = defConst("F_LENMASK", 127)
508 TOR = defPrimWord(">R", () -> begin
513 FROMR = defPrimWord("R>", () -> begin
518 RSPFETCH = defPrimWord("RSP@", () -> begin
523 RSPSTORE = defPrimWord("RSP!", () -> begin
528 RDROP = defPrimWord("RDROP", () -> begin
535 PSPFETCH = defPrimWord("PSP@", () -> begin
540 PSPSTORE = defPrimWord("PSP!", () -> begin
547 WFETCH = defPrimWord("W@", () -> begin
552 WSTORE = defPrimWord("W!", () -> begin
560 NUMTIB, NUMTIB_CFA = defNewVar("#TIB", 0)
561 TOIN, TOIN_CFA = defNewVar(">IN", 0)
562 EOF = defConst("EOF", 4)
564 KEY = defPrimWord("KEY", () -> begin
565 if mem[TOIN] >= mem[NUMTIB]
569 line = readline(reg.source)
570 mem[NUMTIB] = length(line)
578 pushPS(mem[TIB + mem[TOIN]])
584 EMIT = defPrimWord("EMIT", () -> begin
589 WORD = defPrimWord("WORD", () -> begin
606 if c == '\n' || c == eof_char
612 if c == ' ' || c == '\t'
622 if c == '\n' || c == eof_char
623 # Treat newline as a special word
625 mem[wordAddr + offset] = Int64(c)
632 mem[wordAddr + offset] = Int64(c)
638 if c == ' ' || c == '\t' || c == '\n' || c == eof_char
653 NUMBER = defPrimWord("NUMBER", () -> begin
658 s = getString(wordAddr, wordLen)
661 pushPS(parse(Int64, s, mem[BASE]))
664 pushPS(1) # Error indication
670 # Dictionary searches
672 FIND = defPrimWord("FIND", () -> begin
676 word = lowercase(getString(wordAddr, wordLen))
681 while (latest = mem[latest]) > 0
682 lenAndFlags = mem[latest+1]
683 len = lenAndFlags & F_LENMASK
684 hidden = (lenAndFlags & F_HIDDEN) == F_HIDDEN
686 if hidden || len != wordLen
691 thisWord = lowercase(getString(thisAddr, len))
693 if lowercase(thisWord) == lowercase(word)
703 TOCFA = defPrimWord(">CFA", () -> begin
706 lenAndFlags = mem[addr+1]
707 len = lenAndFlags & F_LENMASK
709 pushPS(addr + 2 + len)
714 TODFA = defWord(">DFA", [TOCFA, INCR, EXIT])
718 CREATE = defPrimWord("CREATE", () -> begin
722 word = getString(wordAddr, wordLen)
724 createHeader(word, 0)
729 COMMA = defPrimWord(",", () -> begin
730 mem[mem[HERE]] = popPS()
736 LBRAC = defPrimWord("[", () -> begin
741 RBRAC = defPrimWord("]", () -> begin
746 HIDDEN = defPrimWord("HIDDEN", () -> begin
748 mem[addr] = mem[addr] $ F_HIDDEN
752 HIDE = defWord("HIDE",
762 LATEST_CFA, FETCH, HIDDEN,
766 SEMICOLON = defWord(";",
768 LATEST_CFA, FETCH, HIDDEN,
770 EXIT], flags=F_IMMED)
772 IMMEDIATE = defPrimWord("IMMEDIATE", () -> begin
773 lenAndFlagsAddr = mem[LATEST] + 1
774 mem[lenAndFlagsAddr] = mem[lenAndFlagsAddr] $ F_IMMED
778 TICK = defWord("'", [WORD, FIND, TOCFA, EXIT])
782 BRANCH = defPrimWord("BRANCH", () -> begin
783 reg.IP += mem[reg.IP]
787 ZBRANCH = defPrimWord("0BRANCH", () -> begin
789 reg.IP += mem[reg.IP]
799 LITSTRING = defPrimWord("LITSTRING", () -> begin
809 TELL = defPrimWord("TELL", () -> begin
812 str = getString(addr, len)
819 EXECUTE = defPrimWord("EXECUTE", () -> begin
824 INTERPRET = defPrimWord("INTERPRET", () -> begin
828 wordName = getString(mem[reg.PSP-1], mem[reg.PSP])
829 #println("... ", replace(replace(wordName, "\004", "EOF"), "\n", "\\n"), " ...")
831 callPrim(mem[TWODUP])
834 wordAddr = mem[reg.PSP]
839 isImmediate = (mem[wordAddr+1] & F_IMMED) != 0
842 callPrim(mem[ROT]) # get rid of extra copy of word string details
846 if mem[STATE] == 0 || isImmediate
848 #println("Executing CFA at $(mem[reg.PSP])")
849 return callPrim(mem[EXECUTE])
851 # Append CFA to dictionary
855 # Not in dictionary, assume number
859 callPrim(mem[NUMBER])
862 println("Parse error at word: '$wordName'")
867 # Number already on stack!
869 # Append literal to dictionary
879 QUIT = defWord("QUIT",
884 BYE = defPrimWord("BYE", () -> begin
888 NL = defPrimWord("\n", () -> begin
889 if mem[STATE] == 0 && reg.source == STDIN
895 INCLUDE = defPrimWord("INCLUDE", () -> begin
900 word = getString(wordAddr, wordLen)
902 reg.source = open(word, "r")
910 EOF_WORD = defPrimWord("\x04", () -> begin
911 if reg.source == STDIN
922 CHAR = defPrimWord("CHAR", () -> begin
926 word = getString(wordAddr, wordLen)
927 pushPS(Int64(word[1]))
934 # Start with IP pointing to first instruction of outer interpreter
937 # Primitive processing loop.
938 # Everyting else is simply a consequence of this loop!
942 #println("Evaluating prim $jmp $(primNames[-jmp])")
946 if isa(ex, StackUnderflow)
947 println("Stack underflow!")
959 function dump(startAddr::Int64; count::Int64 = 100, cellsPerLine::Int64 = 10)
960 chars = Array{Char,1}(cellsPerLine)
962 lineStartAddr = cellsPerLine*div((startAddr-1),cellsPerLine) + 1
963 endAddr = startAddr + count - 1
965 q, r = divrem((endAddr-lineStartAddr+1), cellsPerLine)
966 numLines = q + (r > 0 ? 1 : 0)
972 for c in 1:cellsPerLine
973 if i >= startAddr && i <= endAddr
975 if mem[i]>=32 && mem[i]<128
976 chars[c] = Char(mem[i])
988 println("\t", ASCIIString(chars))
993 count = reg.PSP - mem[PSP0]
997 for i in (mem[PSP0]+1):reg.PSP
1002 println("Parameter stack empty")
1007 count = reg.RSP - mem[RSP0]
1011 for i in (mem[RSP0]+1):reg.RSP
1016 println("Return stack empty")
1020 DOT = defPrimWord(".", () -> begin
1025 DOTS = defPrimWord(".s", () -> begin
1030 DUMP = defPrimWord("DUMP", () -> begin
1034 dump(addr, count=count)