src/forth.jl

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