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