src/forth.jl

   1 module forth
   2
   3 import Base.REPLCompletions
   4
   5 # VM mem size
   6 size_mem = 1000000 # 1 mega-int
   7
   8 # Buffer sizes
   9 size_RS = 1000   # Return stack size
  10 size_PS = 1000   # Parameter stack size
  11 size_TIB = 1000  # Terminal input buffer size
  12
  13 # Memory arrays
  14 mem = Array{Int64,1}(size_mem)
  15 primitives = Array{Function,1}()
  16 primNames = Array{AbstractString,1}()
  17
  18 # Memory geography and built-in variables
  19
  20 nextVarAddr = 1
  21 H = nextVarAddr; nextVarAddr += 1              # Next free memory address
  22 FORTH_LATEST = nextVarAddr; nextVarAddr += 1   # FORTH dict latest
  23 CURRENT = nextVarAddr; nextVarAddr += 1        # Current compilation dict
  24
  25 RSP0 = nextVarAddr                  # bottom of RS
  26 PSP0 = RSP0 + size_RS               # bottom of PS
  27 TIB = PSP0 + size_PS                # address of terminal input buffer
  28 mem[H] = TIB + size_TIB             # location of bottom of dictionary
  29 mem[FORTH_LATEST] = 0               # zero FORTH dict latest (no previous def)
  30 mem[CURRENT] = FORTH_LATEST-1       # Compile words to system dict initially
  31
  32 DICT = mem[H] # Save bottom of dictionary as constant
  33
  34 # VM registers
  35 type Reg
  36     RSP::Int64  # Return stack pointer
  37     PSP::Int64  # Parameter/data stack pointer
  38     IP::Int64   # Instruction pointer
  39     W::Int64    # Working register
  40 end
  41 reg = Reg(RSP0, PSP0, 0, 0)
  42
  43 # Stack manipulation functions
  44
  45 function ensurePSDepth(depth::Int64)
  46     if reg.PSP - PSP0 < depth
  47         error("Parameter stack underflow.")
  48     end
  49 end
  50
  51 function ensurePSCapacity(toAdd::Int64)
  52     if reg.PSP + toAdd >= PSP0 + size_PS
  53         error("Parameter stack overflow.")
  54     end
  55 end
  56
  57 function ensureRSDepth(depth::Int64)
  58     if reg.RSP - RSP0 < depth
  59         error("Return stack underflow.")
  60     end
  61 end
  62
  63 function ensureRSCapacity(toAdd::Int64)
  64     if reg.RSP + toAdd >= RSP0 + size_RS
  65         error("Return stack overflow.")
  66     end
  67 end
  68
  69 function pushRS(val::Int64)
  70     ensureRSCapacity(1)
  71     mem[reg.RSP+=1] = val
  72 end
  73
  74 function popRS()
  75     ensureRSDepth(1)
  76
  77     val = mem[reg.RSP]
  78     reg.RSP -= 1
  79     return val
  80 end
  81
  82 function pushPS(val::Int64)
  83     ensurePSCapacity(1)
  84
  85     mem[reg.PSP += 1] = val
  86 end
  87
  88 function popPS()
  89     ensurePSDepth(1)
  90
  91     val = mem[reg.PSP]
  92     reg.PSP -= 1
  93     return val
  94 end
  95
  96 # Handy functions for adding/retrieving strings to/from memory.
  97
  98 getString(addr::Int64, len::Int64) = AbstractString([Char(c) for c in mem[addr:(addr+len-1)]])
  99
 100 function putString(str::AbstractString, addr::Int64, maxLen::Int64)
 101     len = min(length(str), maxLen)
 102     mem[addr:(addr+len-1)] = [Int64(c) for c in str]
 103 end
 104
 105 stringAsInts(str::AbstractString) = [Int(c) for c in collect(str)]
 106
 107 # Primitive creation and calling functions
 108
 109 function defPrim(f::Function; name="nameless")
 110     push!(primitives, f)
 111     push!(primNames, replace(name, "\004", "EOF"))
 112
 113     return -length(primitives)
 114 end
 115
 116 function callPrim(addr::Int64)
 117     if addr >=0 || -addr>length(primitives)
 118         error("Attempted to execute non-existent primitive at address $addr.")
 119     else
 120         primitives[-addr]()
 121     end
 122 end
 123 getPrimName(addr::Int64) = primNames[-addr]
 124
 125 # Word creation functions
 126
 127 F_LENMASK = 31
 128 F_IMMED = 32
 129 F_HIDDEN = 64
 130 NFA_MARK = 128
 131
 132 function dictWrite(ints::Array{Int64,1})
 133     mem[mem[H]:(mem[H]+length(ints)-1)] = ints
 134     mem[H] += length(ints)
 135 end
 136 dictWrite(int::Int64) = dictWrite([int])
 137 dictWriteString(string::AbstractString) = dictWrite([Int64(c) for c in string])
 138
 139 function createHeader(name::AbstractString, flags::Int64)
 140     mem[mem[H]] = mem[mem[CURRENT]+1]
 141     mem[mem[CURRENT]+1] = mem[H]
 142     mem[H] += 1
 143
 144     dictWrite(length(name) | flags | NFA_MARK)
 145     dictWriteString(name)
 146 end
 147
 148 function defPrimWord(name::AbstractString, f::Function; flags::Int64=0)
 149     createHeader(name, flags)
 150
 151     codeWordAddr = mem[H]
 152     dictWrite(defPrim(f, name=name))
 153
 154     return codeWordAddr
 155 end
 156
 157 function defWord(name::AbstractString, wordAddrs::Array{Int64,1}; flags::Int64=0)
 158     createHeader(name, flags)
 159
 160     addr = mem[H]
 161     dictWrite(DOCOL)
 162
 163     dictWrite(wordAddrs)
 164
 165     return addr
 166 end
 167
 168 # Variable creation functions
 169
 170 function defExistingVar(name::AbstractString, varAddr::Int64; flags::Int64=0)
 171
 172     defPrimWord(name, eval(:(() -> begin
 173         pushPS($(varAddr))
 174         return NEXT
 175     end)))
 176 end
 177
 178 function defNewVar(name::AbstractString, initial::Array{Int64,1}; flags::Int64=0)
 179     createHeader(name, flags)
 180
 181     codeWordAddr = mem[H]
 182     varAddr = mem[H] + 1
 183
 184     dictWrite(DOVAR)
 185     dictWrite(initial)
 186
 187     return varAddr, codeWordAddr
 188 end
 189
 190 defNewVar(name::AbstractString, initial::Int64; flags::Int64=0) =
 191     defNewVar(name, [initial]; flags=flags)
 192
 193 function defConst(name::AbstractString, val::Int64; flags::Int64=0)
 194     createHeader(name, flags)
 195
 196     codeWordAddr = mem[H]
 197
 198     dictWrite(DOCON)
 199     dictWrite(val)
 200
 201     return codeWordAddr
 202 end
 203
 204 # Threading Primitives (inner interpreter)
 205
 206 NEXT = defPrim(() -> begin
 207     reg.W = mem[reg.IP]
 208     reg.IP += 1
 209     return mem[reg.W]
 210 end, name="NEXT")
 211
 212 DOCOL = defPrim(() -> begin
 213     pushRS(reg.IP)
 214     reg.IP = reg.W + 1
 215     return NEXT
 216 end, name="DOCOL")
 217
 218 DOVAR = defPrim(() -> begin
 219     pushPS(reg.W + 1)
 220     return NEXT
 221 end, name="DOVAR")
 222
 223 DOCON = defPrim(() -> begin
 224     pushPS(mem[reg.W + 1])
 225     return NEXT
 226 end, name="DOVAR")
 227
 228 EXIT_CFA = defPrimWord("EXIT", () -> begin
 229     reg.IP = popRS()
 230     return NEXT
 231 end)
 232
 233 # Dictionary entries for core built-in variables, constants
 234
 235 H_CFA = defExistingVar("H", H)
 236
 237 PSP0_CFA = defConst("PSP0", PSP0)
 238 RSP0_CFA = defConst("RSP0", RSP0)
 239
 240 defConst("DOCOL", DOCOL)
 241 defConst("DOCON", DOCON)
 242 defConst("DOVAR", DOVAR)
 243
 244 defConst("DICT", DICT)
 245 defConst("MEMSIZE", size_mem)
 246
 247 F_IMMED_CFA = defConst("F_IMMED", F_IMMED)
 248 F_HIDDEN_CFA = defConst("F_HIDDEN", F_HIDDEN)
 249 F_LENMASK_CFA = defConst("F_LENMASK", F_LENMASK)
 250 NFA_MARK_CFA = defConst("NFA_MARK", NFA_MARK)
 251
 252 # Basic forth primitives
 253
 254 DROP_CFA = defPrimWord("DROP", () -> begin
 255     popPS()
 256     return NEXT
 257 end)
 258
 259 SWAP_CFA = defPrimWord("SWAP", () -> begin
 260     a = popPS()
 261     b = popPS()
 262     pushPS(a)
 263     pushPS(b)
 264     return NEXT
 265 end)
 266
 267 DUP_CFA = defPrimWord("DUP", () -> begin
 268     ensurePSDepth(1)
 269     pushPS(mem[reg.PSP])
 270     return NEXT
 271 end)
 272
 273 OVER_CFA = defPrimWord("OVER", () -> begin
 274     ensurePSDepth(2)
 275     pushPS(mem[reg.PSP-1])
 276     return NEXT
 277 end)
 278
 279 ROT_CFA = defPrimWord("ROT", () -> begin
 280     a = popPS()
 281     b = popPS()
 282     c = popPS()
 283     pushPS(b)
 284     pushPS(a)
 285     pushPS(c)
 286     return NEXT
 287 end)
 288
 289 NROT_CFA = defPrimWord("-ROT", () -> begin
 290     a = popPS()
 291     b = popPS()
 292     c = popPS()
 293     pushPS(a)
 294     pushPS(c)
 295     pushPS(b)
 296     return NEXT
 297 end)
 298
 299
 300 TWODROP_CFA = defPrimWord("2DROP", () -> begin
 301     popPS()
 302     popPS()
 303     return NEXT
 304 end)
 305
 306 TWODUP_CFA = defPrimWord("2DUP", () -> begin
 307     ensurePSDepth(2)
 308     a = mem[reg.PSP-1]
 309     b = mem[reg.PSP]
 310     pushPS(a)
 311     pushPS(b)
 312     return NEXT
 313 end)
 314
 315 TWOSWAP_CFA = defPrimWord("2SWAP", () -> begin
 316     a = popPS()
 317     b = popPS()
 318     c = popPS()
 319     d = popPS()
 320     pushPS(b)
 321     pushPS(a)
 322     pushPS(d)
 323     pushPS(c)
 324     return NEXT
 325 end)
 326
 327 TWOOVER_CFA = defPrimWord("2OVER", () -> begin
 328     ensurePSDepth(4)
 329     a = mem[reg.PSP-3]
 330     b = mem[reg.PSP-2]
 331     pushPS(a)
 332     pushPS(b)
 333     return NEXT
 334 end)
 335
 336 QDUP_CFA = defPrimWord("?DUP", () -> begin
 337     ensurePSDepth(1)
 338     val = mem[reg.PSP]
 339     if val != 0
 340         pushPS(val)
 341     end
 342     return NEXT
 343 end)
 344
 345 INCR_CFA = defPrimWord("1+", () -> begin
 346     ensurePSDepth(1)
 347     mem[reg.PSP] += 1
 348     return NEXT
 349 end)
 350
 351 DECR_CFA = defPrimWord("1-", () -> begin
 352     ensurePSDepth(1)
 353     mem[reg.PSP] -= 1
 354     return NEXT
 355 end)
 356
 357 INCR2_CFA = defPrimWord("2+", () -> begin
 358     ensurePSDepth(1)
 359     mem[reg.PSP] += 2
 360     return NEXT
 361 end)
 362
 363 DECR2_CFA = defPrimWord("2-", () -> begin
 364     ensurePSDepth(1)
 365     mem[reg.PSP] -= 2
 366     return NEXT
 367 end)
 368
 369 ADD_CFA = defPrimWord("+", () -> begin
 370     b = popPS()
 371     a = popPS()
 372     pushPS(a+b)
 373     return NEXT
 374 end)
 375
 376 SUB_CFA = defPrimWord("-", () -> begin
 377     b = popPS()
 378     a = popPS()
 379     pushPS(a-b)
 380     return NEXT
 381 end)
 382
 383 MUL_CFA = defPrimWord("*", () -> begin
 384     b = popPS()
 385     a = popPS()
 386     pushPS(a*b)
 387     return NEXT
 388 end)
 389
 390 DIVMOD_CFA = defPrimWord("/MOD", () -> begin
 391     b = popPS()
 392     a = popPS()
 393     q,r = divrem(a,b)
 394     pushPS(r)
 395     pushPS(q)
 396     return NEXT
 397 end)
 398
 399 TWOMUL_CFA = defPrimWord("2*", () -> begin
 400     pushPS(popPS() << 1)
 401     return NEXT
 402 end)
 403
 404 TWODIV_CFA = defPrimWord("2/", () -> begin
 405     pushPS(popPS() >> 1)
 406     return NEXT
 407 end)
 408
 409 EQ_CFA = defPrimWord("=", () -> begin
 410     b = popPS()
 411     a = popPS()
 412     pushPS(a==b ? -1 : 0)
 413     return NEXT
 414 end)
 415
 416 NE_CFA = defPrimWord("<>", () -> begin
 417     b = popPS()
 418     a = popPS()
 419     pushPS(a!=b ? -1 : 0)
 420     return NEXT
 421 end)
 422
 423 LT_CFA = defPrimWord("<", () -> begin
 424     b = popPS()
 425     a = popPS()
 426     pushPS(a<b ? -1 : 0)
 427     return NEXT
 428 end)
 429
 430 GT_CFA = defPrimWord(">", () -> begin
 431     b = popPS()
 432     a = popPS()
 433     pushPS(a>b ? -1 : 0)
 434     return NEXT
 435 end)
 436
 437 LE_CFA = defPrimWord("<=", () -> begin
 438     b = popPS()
 439     a = popPS()
 440     pushPS(a<=b ? -1 : 0)
 441     return NEXT
 442 end)
 443
 444 GE_CFA = defPrimWord(">=", () -> begin
 445     b = popPS()
 446     a = popPS()
 447     pushPS(a>=b ? -1 : 0)
 448     return NEXT
 449 end)
 450
 451 ZE_CFA = defPrimWord("0=", () -> begin
 452     pushPS(popPS() == 0 ? -1 : 0)
 453     return NEXT
 454 end)
 455
 456 ZNE_CFA = defPrimWord("0<>", () -> begin
 457     pushPS(popPS() != 0 ? -1 : 0)
 458     return NEXT
 459 end)
 460
 461 ZLT_CFA = defPrimWord("0<", () -> begin
 462     pushPS(popPS() < 0 ? -1 : 0)
 463     return NEXT
 464 end)
 465
 466 ZGT_CFA = defPrimWord("0>", () -> begin
 467     pushPS(popPS() > 0 ? -1 : 0)
 468     return NEXT
 469 end)
 470
 471 ZLE_CFA = defPrimWord("0<=", () -> begin
 472     pushPS(popPS() <= 0 ? -1 : 0)
 473     return NEXT
 474 end)
 475
 476 ZGE_CFA = defPrimWord("0>=", () -> begin
 477     pushPS(popPS() >= 0 ? -1 : 0)
 478     return NEXT
 479 end)
 480
 481 AND_CFA = defPrimWord("AND", () -> begin
 482     b = popPS()
 483     a = popPS()
 484     pushPS(a & b)
 485     return NEXT
 486 end)
 487
 488 OR_CFA = defPrimWord("OR", () -> begin
 489     b = popPS()
 490     a = popPS()
 491     pushPS(a | b)
 492     return NEXT
 493 end)
 494
 495 XOR_CFA = defPrimWord("XOR", () -> begin
 496     b = popPS()
 497     a = popPS()
 498     pushPS(a $ b)
 499     return NEXT
 500 end)
 501
 502 INVERT_CFA = defPrimWord("INVERT", () -> begin
 503     pushPS(~popPS())
 504     return NEXT
 505 end)
 506
 507 # Literals
 508
 509 LIT_CFA = defPrimWord("LIT", () -> begin
 510     pushPS(mem[reg.IP])
 511     reg.IP += 1
 512     return NEXT
 513 end)
 514
 515 # Memory primitives
 516
 517 STORE_CFA = defPrimWord("!", () -> begin
 518     addr = popPS()
 519     dat = popPS()
 520     mem[addr] = dat
 521     return NEXT
 522 end)
 523
 524 FETCH_CFA = defPrimWord("@", () -> begin
 525     addr = popPS()
 526     pushPS(mem[addr])
 527     return NEXT
 528 end)
 529
 530 ADDSTORE_CFA = defPrimWord("+!", () -> begin
 531     addr = popPS()
 532     toAdd = popPS()
 533     mem[addr] += toAdd
 534     return NEXT
 535 end)
 536
 537 SUBSTORE_CFA = defPrimWord("-!", () -> begin
 538     addr = popPS()
 539     toSub = popPS()
 540     mem[addr] -= toSub
 541     return NEXT
 542 end)
 543
 544
 545 # Return Stack
 546
 547 TOR_CFA = defPrimWord(">R", () -> begin
 548     pushRS(popPS())
 549     return NEXT
 550 end)
 551
 552 FROMR_CFA = defPrimWord("R>", () -> begin
 553     pushPS(popRS())
 554     return NEXT
 555 end)
 556
 557 RFETCH_CFA = defPrimWord("R@", () -> begin
 558     pushPS(mem[reg.RSP])
 559     return NEXT
 560 end)
 561
 562 RSPFETCH_CFA = defPrimWord("RSP@", () -> begin
 563     pushPS(reg.RSP)
 564     return NEXT
 565 end)
 566
 567 RSPSTORE_CFA = defPrimWord("RSP!", () -> begin
 568     reg.RSP = popPS()
 569     return NEXT
 570 end)
 571
 572 RDROP_CFA = defPrimWord("RDROP", () -> begin
 573     popRS()
 574     return NEXT
 575 end)
 576
 577 # Parameter Stack
 578
 579 PSPFETCH_CFA = defPrimWord("PSP@", () -> begin
 580     pushPS(reg.PSP)
 581     return NEXT
 582 end)
 583
 584 PSPSTORE_CFA = defPrimWord("PSP!", () -> begin
 585     reg.PSP = popPS()
 586     return NEXT
 587 end)
 588
 589 # Working Register
 590
 591 WFETCH_CFA = defPrimWord("W@", () -> begin
 592     pushPS(reg.W)
 593     return NEXT
 594 end)
 595
 596 WSTORE_CFA = defPrimWord("W!", () -> begin
 597     reg.W = popPS()
 598     return NEXT
 599 end)
 600
 601 # I/O
 602
 603 openFiles = Dict{Int64,IOStream}()
 604 nextFileID = 1
 605 SOURCE_ID, SOURCE_ID_CFA = defNewVar("SOURCE-ID", 0)
 606
 607 EMIT_CFA = defPrimWord("EMIT", () -> begin
 608     print(Char(popPS()))
 609     return NEXT
 610 end)
 611
 612 function raw_mode!(mode::Bool)
 613     if ccall(:jl_tty_set_mode, Int32, (Ptr{Void}, Int32), STDIN.handle, mode) != 0
 614         throw("FATAL: Terminal unable to enter raw mode.")
 615     end
 616 end
 617
 618 function getKey()
 619     raw_mode!(true)
 620     byte = readbytes(STDIN, 1)[1]
 621     raw_mode!(false)
 622
 623     if byte == 0x0d
 624         return 0x0a
 625     elseif byte == 127
 626         return 0x08
 627     else
 628         return byte
 629     end
 630 end
 631
 632 KEY_CFA = defPrimWord("KEY", () -> begin
 633     pushPS(Int(getKey()))
 634     return NEXT
 635 end)
 636
 637 function getLineFromSTDIN()
 638
 639     function getFrag(s)
 640         chars = collect(s)
 641         slashIdx = findlast(chars, '\\')
 642
 643         if slashIdx > 0
 644             return join(chars[slashIdx:length(chars)])
 645         else
 646             return nothing
 647         end
 648     end
 649
 650     function backspaceStr(s, bsCount)
 651         oldLen = length(s)
 652         newLen = max(0, oldLen - bsCount)
 653         return join(collect(s)[1:newLen])
 654     end
 655
 656     line = ""
 657     while true
 658         key = Char(getKey())
 659
 660         if key == '\n'
 661             print(" ")
 662             return AbstractString(line)
 663
 664         elseif key == '\x04'
 665             if isempty(line)
 666                 return string("\x04")
 667             end
 668
 669         elseif key == '\b'
 670             if !isempty(line)
 671                 print("\b\033[K")
 672                 line = backspaceStr(line, 1)
 673             end
 674
 675         elseif key == '\e'
 676             # Strip ANSI escape sequence
 677             nextKey = Char(getKey())
 678             if nextKey == '['
 679                 while true
 680                     nextKey = Char(getKey())
 681                     if nextKey >= '@' || nextKey <= '~'
 682                         break
 683                     end
 684                 end
 685             end
 686
 687         elseif key == '\t'
 688             # Currently do nothing
 689
 690             frag = getFrag(line)
 691             if frag != nothing
 692                 if haskey(REPLCompletions.latex_symbols, frag)
 693                     print(repeat("\b", length(frag)))
 694                     print("\033[K")
 695                     comp = REPLCompletions.latex_symbols[frag]
 696                     line = string(backspaceStr(line, length(frag)), comp)
 697                     print(comp)
 698                 end
 699             end
 700
 701         else
 702             print(key)
 703             line = string(line, key)
 704         end
 705     end
 706 end
 707
 708 SPAN, SPAN_CFA = defNewVar("SPAN", 0)
 709 EXPECT_CFA = defPrimWord("EXPECT", () -> begin
 710     maxLen = popPS()
 711     addr = popPS()
 712
 713     line = getLineFromSTDIN()
 714
 715     mem[SPAN] = min(length(line), maxLen)
 716     putString(line, addr, maxLen)
 717
 718     return NEXT
 719 end)
 720
 721 BASE, BASE_CFA = defNewVar("BASE", 10)
 722 NUMBER_CFA = defPrimWord("NUMBER", () -> begin
 723     wordAddr = popPS()+1
 724     wordLen = mem[wordAddr-1]
 725
 726     s = getString(wordAddr, wordLen)
 727
 728     pushPS(parse(Int64, s, mem[BASE]))
 729
 730     return NEXT
 731 end)
 732
 733 # Dictionary searches
 734
 735 FROMLINK_CFA = defPrimWord("LINK>", () -> begin
 736
 737     addr = popPS()
 738     lenAndFlags = mem[addr+1]
 739     len = lenAndFlags & F_LENMASK
 740
 741     pushPS(addr + 2 + len)
 742
 743     return NEXT
 744 end)
 745
 746 NUMCONTEXT, NUMCONTEXT_CFA = defNewVar("#CONTEXT", 1)
 747
 748 createHeader("FORTH", 0)
 749 FORTH_CFA = mem[H]
 750 dictWrite(defPrim(() -> begin
 751     mem[CONTEXT + mem[NUMCONTEXT] - 1] = reg.W
 752     return NEXT
 753 end, name="FORTH"))
 754 dictWrite(0) # cell for latest
 755
 756 CURRENT_CFA = defExistingVar("CURRENT", CURRENT)
 757
 758 # Switch to new FORTH vocabulary cfa
 759 mem[FORTH_CFA+1] = mem[mem[CURRENT]+1]
 760 mem[CURRENT] = FORTH_CFA
 761
 762 CONTEXT, CONTEXT_CFA = defNewVar("CONTEXT", zeros(Int64, 10))
 763 mem[CONTEXT] = FORTH_CFA
 764
 765 FINDVOCAB_CFA = defPrimWord("FINDVOCAB", () -> begin
 766     vocabCFA = popPS()
 767     countedAddr = popPS()
 768
 769     wordAddr = countedAddr + 1
 770     wordLen = mem[countedAddr]
 771     word = lowercase(getString(wordAddr, wordLen))
 772
 773     lfa = vocabCFA+1
 774     lenAndFlags = 0
 775
 776     while (lfa = mem[lfa]) > 0
 777
 778         lenAndFlags = mem[lfa+1]
 779         len = lenAndFlags & F_LENMASK
 780         hidden = (lenAndFlags & F_HIDDEN) == F_HIDDEN
 781
 782         if hidden || len != wordLen
 783             continue
 784         end
 785
 786         thisWord = lowercase(getString(lfa+2, len))
 787
 788         if thisWord == word
 789             break
 790         end
 791     end
 792
 793     if lfa > 0
 794         pushPS(lfa)
 795         callPrim(mem[FROMLINK_CFA])
 796         if (lenAndFlags & F_IMMED) == F_IMMED
 797             pushPS(1)
 798         else
 799             pushPS(-1)
 800         end
 801     else
 802         pushPS(countedAddr)
 803         pushPS(0)
 804     end
 805
 806     return NEXT
 807 end)
 808
 809 FIND_CFA = defPrimWord("FIND", () -> begin
 810
 811     countedAddr = popPS()
 812     context = mem[CONTEXT:(CONTEXT+mem[NUMCONTEXT]-1)]
 813
 814     for vocabCFA in reverse(context)
 815         pushPS(countedAddr)
 816         pushPS(vocabCFA)
 817         callPrim(mem[FINDVOCAB_CFA])
 818
 819         callPrim(mem[DUP_CFA])
 820         if popPS() != 0
 821             return NEXT
 822         else
 823             popPS()
 824             popPS()
 825         end
 826     end
 827
 828     pushPS(countedAddr)
 829     pushPS(0)
 830
 831     return NEXT
 832 end)
 833
 834
 835 # Branching
 836
 837 BRANCH_CFA = defPrimWord("BRANCH", () -> begin
 838     reg.IP += mem[reg.IP]
 839     return NEXT
 840 end)
 841
 842 ZBRANCH_CFA = defPrimWord("0BRANCH", () -> begin
 843     if (popPS() == 0)
 844         reg.IP += mem[reg.IP]
 845     else
 846         reg.IP += 1
 847     end
 848
 849     return NEXT
 850 end)
 851
 852 # Strings
 853
 854 LITSTRING_CFA = defPrimWord("LITSTRING", () -> begin
 855     len = mem[reg.IP]
 856     reg.IP += 1
 857     pushPS(reg.IP)
 858     pushPS(len)
 859     reg.IP += len
 860
 861     return NEXT
 862 end)
 863
 864 TYPE_CFA = defPrimWord("TYPE", () -> begin
 865     len = popPS()
 866     addr = popPS()
 867     str = getString(addr, len)
 868     print(str)
 869     return NEXT
 870 end)
 871
 872 # Interpreter/Compiler-specific I/O
 873
 874 TIB_CFA = defConst("TIB", TIB)
 875 NUMTIB, NUMTIB_CFA = defNewVar("#TIB", 0)
 876 TOIN, TOIN_CFA = defNewVar(">IN", 0)
 877
 878 QUERY_CFA = defWord("QUERY",
 879     [TIB_CFA, LIT_CFA, 160, EXPECT_CFA,
 880     SPAN_CFA, FETCH_CFA, NUMTIB_CFA, STORE_CFA,
 881     LIT_CFA, 0, TOIN_CFA, STORE_CFA,
 882     EXIT_CFA])
 883
 884 WORD_CFA = defPrimWord("WORD", () -> begin
 885     delim = popPS()
 886
 887     # Chew up initial occurrences of delim
 888     while (mem[TOIN]<mem[NUMTIB] && mem[TIB+mem[TOIN]] == delim)
 889         mem[TOIN] += 1
 890     end
 891
 892     countAddr = mem[H]
 893     addr = mem[H]+1
 894
 895     # Start reading in word
 896     count = 0
 897     while (mem[TOIN]<mem[NUMTIB])
 898         mem[addr] = mem[TIB+mem[TOIN]]
 899         mem[TOIN] += 1
 900
 901         if (mem[addr] == delim)
 902             break
 903         end
 904
 905         count += 1
 906         addr += 1
 907     end
 908
 909     # Record count
 910     mem[countAddr] = count
 911     pushPS(countAddr)
 912
 913     return NEXT
 914 end)
 915
 916 # Compilation
 917
 918 STATE, STATE_CFA = defNewVar("STATE", 0)
 919
 920 COMMA_CFA = defPrimWord(",", () -> begin
 921     mem[mem[H]] = popPS()
 922     mem[H] += 1
 923
 924     return NEXT
 925 end)
 926
 927 HERE_CFA = defWord("HERE",
 928     [H_CFA, FETCH_CFA, EXIT_CFA])
 929
 930 HEADER_CFA = defPrimWord("HEADER", () -> begin
 931     wordAddr = popPS()+1
 932     wordLen = mem[wordAddr-1]
 933     word = getString(wordAddr, wordLen)
 934
 935     createHeader(word, 0)
 936
 937     return NEXT
 938 end)
 939
 940 CREATE_CFA = defWord("CREATE",
 941     [LIT_CFA, 32, WORD_CFA, HEADER_CFA,
 942     LIT_CFA, DOVAR, COMMA_CFA,
 943     EXIT_CFA])
 944
 945 DODOES = defPrim(() -> begin
 946     pushRS(reg.IP)
 947     reg.IP = popPS()
 948     pushPS(reg.W + 1)
 949     return NEXT
 950 end, name="DODOES")
 951
 952 DOES_HELPER_CFA = defPrimWord("(DOES>)", () -> begin
 953
 954     pushPS(mem[mem[CURRENT]+1])
 955     callPrim(mem[FROMLINK_CFA])
 956     cfa = popPS()
 957
 958     runtimeAddr = popPS()
 959
 960     mem[cfa] = defPrim(eval(:(() -> begin
 961         pushPS($(runtimeAddr))
 962         return DODOES
 963     end)), name="doesPrim")
 964
 965     return NEXT
 966 end, flags=F_IMMED | F_HIDDEN)
 967
 968 DOES_CFA = defWord("DOES>",
 969     [LIT_CFA, LIT_CFA, COMMA_CFA, HERE_CFA, LIT_CFA, 3, ADD_CFA, COMMA_CFA,
 970     LIT_CFA, DOES_HELPER_CFA, COMMA_CFA, LIT_CFA, EXIT_CFA, COMMA_CFA, EXIT_CFA],
 971     flags=F_IMMED)
 972
 973 LBRAC_CFA = defPrimWord("[", () -> begin
 974     mem[STATE] = 0
 975     return NEXT
 976 end, flags=F_IMMED)
 977
 978 RBRAC_CFA = defPrimWord("]", () -> begin
 979     mem[STATE] = 1
 980     return NEXT
 981 end, flags=F_IMMED)
 982
 983 HIDDEN_CFA = defPrimWord("HIDDEN", () -> begin
 984     lenAndFlagsAddr = mem[mem[CURRENT]+1] + 1
 985     mem[lenAndFlagsAddr] = mem[lenAndFlagsAddr] $ F_HIDDEN
 986     return NEXT
 987 end)
 988
 989 COLON_CFA = defWord(":",
 990     [LIT_CFA, 32, WORD_CFA,
 991     HEADER_CFA,
 992     LIT_CFA, DOCOL, COMMA_CFA,
 993     HIDDEN_CFA,
 994     RBRAC_CFA,
 995     EXIT_CFA])
 996
 997 SEMICOLON_CFA = defWord(";",
 998     [LIT_CFA, EXIT_CFA, COMMA_CFA,
 999     HIDDEN_CFA,
1000     LBRAC_CFA,
1001     EXIT_CFA], flags=F_IMMED)
1002
1003 IMMEDIATE_CFA = defPrimWord("IMMEDIATE", () -> begin
1004     lenAndFlagsAddr = mem[mem[CURRENT]+1] + 1
1005     mem[lenAndFlagsAddr] = mem[lenAndFlagsAddr] $ F_IMMED
1006     return NEXT
1007 end, flags=F_IMMED)
1008
1009 CODE_CFA = defPrimWord("CODE", () -> begin
1010     pushPS(32)
1011     callPrim(mem[WORD_CFA])
1012     callPrim(mem[HEADER_CFA])
1013
1014     exprString = "() -> begin\n"
1015     while true
1016         if mem[TOIN] >= mem[NUMTIB]
1017             exprString = string(exprString, "\n")
1018             if currentSource() == STDIN
1019                 println()
1020             end
1021
1022             pushPS(TIB)
1023             pushPS(160)
1024             callPrim(mem[EXPECT_CFA])
1025             mem[NUMTIB] = mem[SPAN]
1026             mem[TOIN] = 0
1027         end
1028
1029         pushPS(32)
1030         callPrim(mem[WORD_CFA])
1031         cAddr = popPS()
1032         thisWord = getString(cAddr+1, mem[cAddr])
1033
1034         if uppercase(thisWord) == "END-CODE"
1035             break
1036         end
1037
1038         exprString = string(exprString, " ", thisWord)
1039     end
1040     exprString = string(exprString, "\nreturn NEXT\nend")
1041
1042     func = eval(parse(exprString))
1043     dictWrite(defPrim(func))
1044
1045     return NEXT
1046 end)
1047
1048 # Outer Interpreter
1049
1050 EXECUTE_CFA = defPrimWord("EXECUTE", () -> begin
1051     reg.W = popPS()
1052     return mem[reg.W]
1053 end)
1054
1055 INTERPRET_CFA = defWord("INTERPRET",
1056     [LIT_CFA, 32, WORD_CFA, # Read next space-delimited word
1057
1058     DUP_CFA, FETCH_CFA, ZE_CFA, ZBRANCH_CFA, 3,
1059         DROP_CFA, EXIT_CFA, # Exit if TIB is exhausted
1060
1061     STATE_CFA, FETCH_CFA, ZBRANCH_CFA, 24,
1062         # Compiling
1063         FIND_CFA, QDUP_CFA, ZBRANCH_CFA, 13,
1064
1065             # Found word.
1066             LIT_CFA, -1, EQ_CFA, INVERT_CFA, ZBRANCH_CFA, 4,
1067
1068                 # Immediate: Execute!
1069                 EXECUTE_CFA, BRANCH_CFA, -26,
1070
1071                 # Not immediate: Compile!
1072                 COMMA_CFA, BRANCH_CFA, -29,
1073
1074             # No word found, parse number
1075             NUMBER_CFA, LIT_CFA, LIT_CFA, COMMA_CFA, COMMA_CFA, BRANCH_CFA, -36,
1076
1077        # Interpreting
1078         FIND_CFA, QDUP_CFA, ZBRANCH_CFA, 5,
1079
1080             # Found word. Execute!
1081             DROP_CFA, EXECUTE_CFA, BRANCH_CFA, -44,
1082
1083             # No word found, parse number and leave on stack
1084             NUMBER_CFA, BRANCH_CFA, -47,
1085     EXIT_CFA])
1086
1087 PROMPT_CFA = defPrimWord("PROMPT", () -> begin
1088     if mem[STATE] == 0
1089         print(" ok")
1090     end
1091     println()
1092
1093     return NEXT
1094 end)
1095
1096 QUIT_CFA = defWord("QUIT",
1097     [LIT_CFA, 0, STATE_CFA, STORE_CFA,
1098     LIT_CFA, 0, NUMTIB_CFA, STORE_CFA,
1099     RSP0_CFA, RSPSTORE_CFA,
1100     QUERY_CFA,
1101     INTERPRET_CFA, PROMPT_CFA,
1102     BRANCH_CFA,-4])
1103
1104 ABORT_CFA = defWord("ABORT",
1105     [CLOSEFILES_CFA, PSP0_CFA, PSPSTORE_CFA, QUIT_CFA])
1106
1107 BYE_CFA = defPrimWord("BYE", () -> begin
1108     println("\nBye!")
1109     return 0
1110 end)
1111
1112 # File I/O
1113
1114 INCLUDE_CFA = defPrimWord("INCLUDE", () -> begin
1115     pushPS(32)
1116     callPrim(mem[WORD_CFA])
1117     wordAddr = popPS()+1
1118     wordLen = mem[wordAddr-1]
1119     word = getString(wordAddr, wordLen)
1120
1121     fname = word
1122     if !isfile(fname)
1123         fname = Pkg.dir("forth","src",word)
1124         if !isfile(fname)
1125             error("No file named $word found in current directory or package source directory.")
1126         end
1127     end
1128     push!(sources, open(fname, "r"))
1129
1130     # Clear input buffer
1131     mem[NUMTIB] = 0
1132
1133     return NEXT
1134 end)
1135
1136
1137 #### VM loop ####
1138
1139 initialized = false
1140 initFileName = nothing
1141 if isfile("lib.4th")
1142     initFileName = "lib.4th"
1143 elseif isfile(Pkg.dir("forth","src", "lib.4th"))
1144     initFileName = Pkg.dir("forth","src","lib.4th")
1145 end
1146
1147 function run(;initialize=true)
1148     # Begin with STDIN as source
1149     push!(sources, STDIN)
1150
1151     global initialized, initFileName
1152     if !initialized && initialize
1153         if initFileName != nothing
1154             print("Including definitions from $initFileName...")
1155             push!(sources, open(initFileName, "r"))
1156             initialized = true
1157         else
1158             println("No library file found. Only primitive words available.")
1159         end
1160     end
1161
1162     # Start with IP pointing to first instruction of outer interpreter
1163     reg.IP = QUIT_CFA + 1
1164
1165     # Primitive processing loop.
1166     # Everyting else is simply a consequence of this loop!
1167     jmp = NEXT
1168     while jmp != 0
1169         try
1170             #println("Entering prim $(getPrimName(jmp))")
1171             jmp = callPrim(jmp)
1172
1173         catch ex
1174             showerror(STDOUT, ex)
1175             println()
1176
1177             while !isempty(sources) && currentSource() != STDIN
1178                 close(pop!(sources))
1179             end
1180
1181             # QUIT
1182             reg.IP = ABORT_CFA + 1
1183             jmp = NEXT
1184         end
1185     end
1186 end
1187
1188 # Debugging tools
1189
1190 TRACE_CFA = defPrimWord("TRACE", () -> begin
1191     println("reg.W: $(reg.W) reg.IP: $(reg.IP)")
1192     print("PS: "); printPS()
1193     print("RS: "); printRS()
1194     print("[paused]")
1195     readline()
1196
1197     return NEXT
1198 end)
1199
1200 function dump(startAddr::Int64; count::Int64 = 100, cellsPerLine::Int64 = 10)
1201     chars = Array{Char,1}(cellsPerLine)
1202
1203     lineStartAddr = cellsPerLine*div((startAddr-1),cellsPerLine) + 1
1204     endAddr = startAddr + count - 1
1205
1206     q, r = divrem((endAddr-lineStartAddr+1), cellsPerLine)
1207     numLines = q + (r > 0 ? 1 : 0)
1208
1209     i = lineStartAddr
1210     for l in 1:numLines
1211         print(i,":")
1212
1213         for c in 1:cellsPerLine
1214             if i >= startAddr && i <= endAddr
1215                 print("\t",mem[i])
1216                 if mem[i]>=32 && mem[i]<128
1217                     chars[c] = Char(mem[i])
1218                 else
1219                     chars[c] = '.'
1220                 end
1221             else
1222                 print("\t")
1223                 chars[c] = ' '
1224             end
1225
1226             i += 1
1227         end
1228
1229         println("\t", AbstractString(chars))
1230     end
1231 end
1232
1233 function printPS()
1234     count = reg.PSP - PSP0
1235
1236     if count > 0
1237         print("<$count>")
1238         for i in (PSP0+1):reg.PSP
1239             print(" $(mem[i])")
1240         end
1241         println()
1242     else
1243         println("Parameter stack empty")
1244     end
1245 end
1246
1247 function printRS()
1248     count = reg.RSP - RSP0
1249
1250     if count > 0
1251         print("<$count>")
1252         for i in (RSP0+1):reg.RSP
1253             print(" $(mem[i])")
1254         end
1255         println()
1256     else
1257         println("Return stack empty")
1258     end
1259 end
1260
1261 DUMP = defPrimWord("DUMP", () -> begin
1262     count = popPS()
1263     addr = popPS()
1264
1265     println()
1266     dump(addr, count=count)
1267
1268     return NEXT
1269 end)
1270
1271 end