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 # Memory geography and built-in variables
  17
  18 nextVarAddr = 1
  19 H = nextVarAddr; nextVarAddr += 1              # Next free memory address
  20 FORTH_LATEST = nextVarAddr; nextVarAddr += 1   # FORTH dict latest
  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_LATEST] = 0               # zero FORTH dict latest (no previous def)
  28 mem[CURRENT] = FORTH_LATEST-1       # 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 stringAsInts(str::ASCIIString) = [Int(c) for c in collect(str)]
  88
  89 # Primitive creation and calling functions
  90
  91 function defPrim(f::Function; name="nameless")
  92     push!(primitives, f)
  93     push!(primNames, replace(name, "\004", "EOF"))
  94
  95     return -length(primitives)
  96 end
  97
  98 function callPrim(addr::Int64)
  99     if addr >=0 || -addr>length(primitives)
 100         error("Attempted to execute non-existent primitive at address $addr.")
 101     else
 102         primitives[-addr]()
 103     end
 104 end
 105 getPrimName(addr::Int64) = primNames[-addr]
 106
 107 # Word creation functions
 108
 109 F_LENMASK = 31
 110 F_IMMED = 32
 111 F_HIDDEN = 64
 112 NFA_MARK = 128
 113
 114 function dictWrite(ints::Array{Int64,1})
 115     mem[mem[H]:(mem[H]+length(ints)-1)] = ints
 116     mem[H] += length(ints)
 117 end
 118 dictWrite(int::Int64) = dictWrite([int])
 119 dictWriteString(string::ASCIIString) = dictWrite([Int64(c) for c in string])
 120
 121 function createHeader(name::AbstractString, flags::Int64)
 122     mem[mem[H]] = mem[mem[CURRENT]+1]
 123     mem[mem[CURRENT]+1] = mem[H]
 124     mem[H] += 1
 125
 126     dictWrite(length(name) | flags | NFA_MARK)
 127     dictWriteString(name)
 128 end
 129
 130 function defPrimWord(name::AbstractString, f::Function; flags::Int64=0)
 131     createHeader(name, flags)
 132
 133     codeWordAddr = mem[H]
 134     dictWrite(defPrim(f, name=name))
 135
 136     return codeWordAddr
 137 end
 138
 139 function defWord(name::AbstractString, wordAddrs::Array{Int64,1}; flags::Int64=0)
 140     createHeader(name, flags)
 141
 142     addr = mem[H]
 143     dictWrite(DOCOL)
 144
 145     dictWrite(wordAddrs)
 146
 147     return addr
 148 end
 149
 150 # Variable creation functions
 151
 152 function defExistingVar(name::AbstractString, varAddr::Int64; flags::Int64=0)
 153
 154     defPrimWord(name, eval(:(() -> begin
 155         pushPS($(varAddr))
 156         return NEXT
 157     end)))
 158 end
 159
 160 function defNewVar(name::AbstractString, initial::Array{Int64,1}; flags::Int64=0)
 161     createHeader(name, flags)
 162
 163     codeWordAddr = mem[H]
 164     varAddr = mem[H] + 1
 165
 166     dictWrite(DOVAR)
 167     dictWrite(initial)
 168
 169     return varAddr, codeWordAddr
 170 end
 171
 172 defNewVar(name::AbstractString, initial::Int64; flags::Int64=0) =
 173     defNewVar(name, [initial]; flags=flags)
 174
 175 function defConst(name::AbstractString, val::Int64; flags::Int64=0)
 176     createHeader(name, flags)
 177
 178     codeWordAddr = mem[H]
 179
 180     dictWrite(DOCON)
 181     dictWrite(val)
 182
 183     return codeWordAddr
 184 end
 185
 186 # Threading Primitives (inner interpreter)
 187
 188 NEXT = defPrim(() -> begin
 189     reg.W = mem[reg.IP]
 190     reg.IP += 1
 191     return mem[reg.W]
 192 end, name="NEXT")
 193
 194 DOCOL = defPrim(() -> begin
 195     pushRS(reg.IP)
 196     reg.IP = reg.W + 1
 197     return NEXT
 198 end, name="DOCOL")
 199
 200 DOVAR = defPrim(() -> begin
 201     pushPS(reg.W + 1)
 202     return NEXT
 203 end, name="DOVAR")
 204
 205 DOCON = defPrim(() -> begin
 206     pushPS(mem[reg.W + 1])
 207     return NEXT
 208 end, name="DOVAR")
 209
 210 EXIT_CFA = defPrimWord("EXIT", () -> begin
 211     reg.IP = popRS()
 212     return NEXT
 213 end)
 214
 215 # Dictionary entries for core built-in variables, constants
 216
 217 H_CFA = defExistingVar("H", H)
 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 FROMLINK_CFA = defPrimWord("LINK>", () -> 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 NUMCONTEXT, NUMCONTEXT_CFA = defNewVar("#CONTEXT", 1)
 713
 714 createHeader("FORTH", 0)
 715 FORTH_CFA = mem[H]
 716 dictWrite(defPrim(() -> begin
 717     mem[CONTEXT + mem[NUMCONTEXT] - 1] = reg.W
 718     return NEXT
 719 end, name="FORTH"))
 720 dictWrite(0) # cell for latest
 721
 722 CURRENT_CFA = defExistingVar("CURRENT", CURRENT)
 723
 724 # Switch to new FORTH vocabulary cfa
 725 mem[FORTH_CFA+1] = mem[mem[CURRENT]+1]
 726 mem[CURRENT] = FORTH_CFA
 727
 728 CONTEXT, CONTEXT_CFA = defNewVar("CONTEXT", zeros(Int64, 10))
 729 mem[CONTEXT] = FORTH_CFA
 730
 731 FINDVOCAB_CFA = defPrimWord("FINDVOCAB", () -> begin
 732     vocabCFA = popPS()
 733     countedAddr = popPS()
 734
 735     wordAddr = countedAddr + 1
 736     wordLen = mem[countedAddr]
 737     word = lowercase(getString(wordAddr, wordLen))
 738
 739     lfa = vocabCFA+1
 740     lenAndFlags = 0
 741
 742     while (lfa = mem[lfa]) > 0
 743
 744         lenAndFlags = mem[lfa+1]
 745         len = lenAndFlags & F_LENMASK
 746         hidden = (lenAndFlags & F_HIDDEN) == F_HIDDEN
 747
 748         if hidden || len != wordLen
 749             continue
 750         end
 751
 752         thisWord = lowercase(getString(lfa+2, len))
 753
 754         if thisWord == word
 755             break
 756         end
 757     end
 758
 759     if lfa > 0
 760         pushPS(lfa)
 761         callPrim(mem[FROMLINK_CFA])
 762         if (lenAndFlags & F_IMMED) == F_IMMED
 763             pushPS(1)
 764         else
 765             pushPS(-1)
 766         end
 767     else
 768         pushPS(countedAddr)
 769         pushPS(0)
 770     end
 771
 772     return NEXT
 773 end)
 774
 775 FIND_CFA = defPrimWord("FIND", () -> begin
 776
 777     countedAddr = popPS()
 778     context = mem[CONTEXT:(CONTEXT+mem[NUMCONTEXT]-1)]
 779
 780     for vocabCFA in reverse(context)
 781         pushPS(countedAddr)
 782         pushPS(vocabCFA)
 783         callPrim(mem[FINDVOCAB_CFA])
 784
 785         callPrim(mem[DUP_CFA])
 786         if popPS() != 0
 787             return NEXT
 788         else
 789             popPS()
 790             popPS()
 791         end
 792     end
 793
 794     pushPS(countedAddr)
 795     pushPS(0)
 796
 797     return NEXT
 798 end)
 799
 800
 801 # Branching
 802
 803 BRANCH_CFA = defPrimWord("BRANCH", () -> begin
 804     reg.IP += mem[reg.IP]
 805     return NEXT
 806 end)
 807
 808 ZBRANCH_CFA = defPrimWord("0BRANCH", () -> begin
 809     if (popPS() == 0)
 810         reg.IP += mem[reg.IP]
 811     else
 812         reg.IP += 1
 813     end
 814
 815     return NEXT
 816 end)
 817
 818 # Strings
 819
 820 LITSTRING_CFA = defPrimWord("LITSTRING", () -> begin
 821     len = mem[reg.IP]
 822     reg.IP += 1
 823     pushPS(reg.IP)
 824     pushPS(len)
 825     reg.IP += len
 826
 827     return NEXT
 828 end)
 829
 830 TYPE_CFA = defPrimWord("TYPE", () -> begin
 831     len = popPS()
 832     addr = popPS()
 833     str = getString(addr, len)
 834     print(str)
 835     return NEXT
 836 end)
 837
 838 # Interpreter/Compiler-specific I/O
 839
 840 TIB_CFA = defConst("TIB", TIB)
 841 NUMTIB, NUMTIB_CFA = defNewVar("#TIB", 0)
 842 TOIN, TOIN_CFA = defNewVar(">IN", 0)
 843
 844 QUERY_CFA = defWord("QUERY",
 845     [TIB_CFA, LIT_CFA, 160, EXPECT_CFA,
 846     SPAN_CFA, FETCH_CFA, NUMTIB_CFA, STORE_CFA,
 847     LIT_CFA, 0, TOIN_CFA, STORE_CFA,
 848     EXIT_CFA])
 849
 850 WORD_CFA = defPrimWord("WORD", () -> begin
 851     delim = popPS()
 852
 853     # Chew up initial occurrences of delim
 854     while (mem[TOIN]<mem[NUMTIB] && mem[TIB+mem[TOIN]] == delim)
 855         mem[TOIN] += 1
 856     end
 857
 858     countAddr = mem[H]
 859     addr = mem[H]+1
 860
 861     # Start reading in word
 862     count = 0
 863     while (mem[TOIN]<mem[NUMTIB])
 864         mem[addr] = mem[TIB+mem[TOIN]]
 865         mem[TOIN] += 1
 866
 867         if (mem[addr] == delim)
 868             break
 869         end
 870
 871         count += 1
 872         addr += 1
 873     end
 874
 875     # Record count
 876     mem[countAddr] = count
 877     pushPS(countAddr)
 878
 879     return NEXT
 880 end)
 881
 882 # Compilation
 883
 884 STATE, STATE_CFA = defNewVar("STATE", 0)
 885
 886 COMMA_CFA = defPrimWord(",", () -> begin
 887     mem[mem[H]] = popPS()
 888     mem[H] += 1
 889
 890     return NEXT
 891 end)
 892
 893 HERE_CFA = defWord("HERE",
 894     [H_CFA, FETCH_CFA, EXIT_CFA])
 895
 896 HEADER_CFA = defPrimWord("HEADER", () -> begin
 897     wordAddr = popPS()+1
 898     wordLen = mem[wordAddr-1]
 899     word = getString(wordAddr, wordLen)
 900
 901     createHeader(word, 0)
 902
 903     return NEXT
 904 end)
 905
 906 CREATE_CFA = defWord("CREATE",
 907     [LIT_CFA, 32, WORD_CFA, HEADER_CFA,
 908     LIT_CFA, DOVAR, COMMA_CFA,
 909     EXIT_CFA])
 910
 911 DODOES = defPrim(() -> begin
 912     pushRS(reg.IP)
 913     reg.IP = popPS()
 914     pushPS(reg.W + 1)
 915     return NEXT
 916 end, name="DODOES")
 917
 918 DOES_HELPER_CFA = defPrimWord("(DOES>)", () -> begin
 919
 920     pushPS(mem[mem[CURRENT]+1])
 921     callPrim(mem[FROMLINK_CFA])
 922     cfa = popPS()
 923
 924     runtimeAddr = popPS()
 925
 926     mem[cfa] = defPrim(eval(:(() -> begin
 927         pushPS($(runtimeAddr))
 928         return DODOES
 929     end)), name="doesPrim")
 930
 931     return NEXT
 932 end, flags=F_IMMED | F_HIDDEN)
 933
 934 DOES_CFA = defWord("DOES>",
 935     [LIT_CFA, LIT_CFA, COMMA_CFA, HERE_CFA, LIT_CFA, 3, ADD_CFA, COMMA_CFA,
 936     LIT_CFA, DOES_HELPER_CFA, COMMA_CFA, LIT_CFA, EXIT_CFA, COMMA_CFA, EXIT_CFA],
 937     flags=F_IMMED)
 938
 939 LBRAC_CFA = defPrimWord("[", () -> begin
 940     mem[STATE] = 0
 941     return NEXT
 942 end, flags=F_IMMED)
 943
 944 RBRAC_CFA = defPrimWord("]", () -> begin
 945     mem[STATE] = 1
 946     return NEXT
 947 end, flags=F_IMMED)
 948
 949 HIDDEN_CFA = defPrimWord("HIDDEN", () -> begin
 950     lenAndFlagsAddr = mem[mem[CURRENT]+1] + 1
 951     mem[lenAndFlagsAddr] = mem[lenAndFlagsAddr] $ F_HIDDEN
 952     return NEXT
 953 end)
 954
 955 COLON_CFA = defWord(":",
 956     [LIT_CFA, 32, WORD_CFA,
 957     HEADER_CFA,
 958     LIT_CFA, DOCOL, COMMA_CFA,
 959     HIDDEN_CFA,
 960     RBRAC_CFA,
 961     EXIT_CFA])
 962
 963 SEMICOLON_CFA = defWord(";",
 964     [LIT_CFA, EXIT_CFA, COMMA_CFA,
 965     HIDDEN_CFA,
 966     LBRAC_CFA,
 967     EXIT_CFA], flags=F_IMMED)
 968
 969 IMMEDIATE_CFA = defPrimWord("IMMEDIATE", () -> begin
 970     lenAndFlagsAddr = mem[mem[CURRENT]+1] + 1
 971     mem[lenAndFlagsAddr] = mem[lenAndFlagsAddr] $ F_IMMED
 972     return NEXT
 973 end, flags=F_IMMED)
 974
 975 # Outer Interpreter
 976
 977 EXECUTE_CFA = defPrimWord("EXECUTE", () -> begin
 978     reg.W = popPS()
 979     return mem[reg.W]
 980 end)
 981
 982 INTERPRET_CFA = defWord("INTERPRET",
 983     [LIT_CFA, 32, WORD_CFA, # Read next space-delimited word
 984
 985     DUP_CFA, FETCH_CFA, ZE_CFA, ZBRANCH_CFA, 3,
 986         DROP_CFA, EXIT_CFA, # Exit if TIB is exhausted
 987
 988     STATE_CFA, FETCH_CFA, ZBRANCH_CFA, 24,
 989         # Compiling
 990         FIND_CFA, QDUP_CFA, ZBRANCH_CFA, 13,
 991
 992             # Found word.
 993             LIT_CFA, -1, EQ_CFA, INVERT_CFA, ZBRANCH_CFA, 4,
 994
 995                 # Immediate: Execute!
 996                 EXECUTE_CFA, BRANCH_CFA, -26,
 997
 998                 # Not immediate: Compile!
 999                 COMMA_CFA, BRANCH_CFA, -29,
1000
1001             # No word found, parse number
1002             NUMBER_CFA, LIT_CFA, LIT_CFA, COMMA_CFA, COMMA_CFA, BRANCH_CFA, -36,
1003
1004        # Interpreting
1005         FIND_CFA, QDUP_CFA, ZBRANCH_CFA, 5,
1006
1007             # Found word. Execute!
1008             DROP_CFA, EXECUTE_CFA, BRANCH_CFA, -44,
1009
1010             # No word found, parse number and leave on stack
1011             NUMBER_CFA, BRANCH_CFA, -47,
1012     EXIT_CFA])
1013
1014 PROMPT_CFA = defPrimWord("PROMPT", () -> begin
1015     if currentSource() == STDIN
1016         if mem[STATE] == 0
1017             print(" ok")
1018         end
1019         println()
1020     end
1021
1022     return NEXT
1023 end)
1024
1025 QUIT_CFA = defWord("QUIT",
1026     [LIT_CFA, 0, STATE_CFA, STORE_CFA,
1027     LIT_CFA, 0, NUMTIB_CFA, STORE_CFA,
1028     RSP0_CFA, RSPSTORE_CFA,
1029     QUERY_CFA,
1030     INTERPRET_CFA, PROMPT_CFA,
1031     BRANCH_CFA,-4])
1032
1033 ABORT_CFA = defWord("ABORT",
1034     [PSP0_CFA, PSPSTORE_CFA, QUIT_CFA])
1035
1036 BYE_CFA = defPrimWord("BYE", () -> begin
1037     println("\nBye!")
1038     return 0
1039 end)
1040
1041 # File I/O
1042
1043 INCLUDE_CFA = defPrimWord("INCLUDE", () -> begin
1044     pushPS(32)
1045     callPrim(mem[WORD_CFA])
1046     wordAddr = popPS()+1
1047     wordLen = mem[wordAddr-1]
1048     word = getString(wordAddr, wordLen)
1049
1050     fname = word
1051     if !isfile(fname)
1052         fname = Pkg.dir("forth","src",word)
1053         if !isfile(fname)
1054             error("No file named $word found in current directory or package source directory.")
1055         end
1056     end
1057     push!(sources, open(fname, "r"))
1058
1059     # Clear input buffer
1060     mem[NUMTIB] = 0
1061
1062     return NEXT
1063 end)
1064
1065
1066 #### VM loop ####
1067
1068 initialized = false
1069 initFileName = nothing
1070 if isfile("lib.4th")
1071     initFileName = "lib.4th"
1072 elseif isfile(Pkg.dir("forth","src", "lib.4th"))
1073     initFileName = Pkg.dir("forth","src","lib.4th")
1074 end
1075
1076 function run(;initialize=true)
1077     # Begin with STDIN as source
1078     push!(sources, STDIN)
1079
1080     global initialized, initFileName
1081     if !initialized && initialize
1082         if initFileName != nothing
1083             print("Including definitions from $initFileName...")
1084             push!(sources, open(initFileName, "r"))
1085             initialized = true
1086         else
1087             println("No library file found. Only primitive words available.")
1088         end
1089     end
1090
1091     # Start with IP pointing to first instruction of outer interpreter
1092     reg.IP = QUIT_CFA + 1
1093
1094     # Primitive processing loop.
1095     # Everyting else is simply a consequence of this loop!
1096     jmp = NEXT
1097     while jmp != 0
1098         try
1099             #println("Entering prim $(getPrimName(jmp))")
1100             jmp = callPrim(jmp)
1101
1102         catch ex
1103             showerror(STDOUT, ex)
1104             println()
1105
1106             while !isempty(sources) && currentSource() != STDIN
1107                 close(pop!(sources))
1108             end
1109
1110             # QUIT
1111             reg.IP = ABORT_CFA + 1
1112             jmp = NEXT
1113         end
1114     end
1115 end
1116
1117 # Debugging tools
1118
1119 TRACE_CFA = defPrimWord("TRACE", () -> begin
1120     println("reg.W: $(reg.W) reg.IP: $(reg.IP)")
1121     print("PS: "); printPS()
1122     print("RS: "); printRS()
1123     print("[paused]")
1124     readline()
1125
1126     return NEXT
1127 end)
1128
1129 function dump(startAddr::Int64; count::Int64 = 100, cellsPerLine::Int64 = 10)
1130     chars = Array{Char,1}(cellsPerLine)
1131
1132     lineStartAddr = cellsPerLine*div((startAddr-1),cellsPerLine) + 1
1133     endAddr = startAddr + count - 1
1134
1135     q, r = divrem((endAddr-lineStartAddr+1), cellsPerLine)
1136     numLines = q + (r > 0 ? 1 : 0)
1137
1138     i = lineStartAddr
1139     for l in 1:numLines
1140         print(i,":")
1141
1142         for c in 1:cellsPerLine
1143             if i >= startAddr && i <= endAddr
1144                 print("\t",mem[i])
1145                 if mem[i]>=32 && mem[i]<128
1146                     chars[c] = Char(mem[i])
1147                 else
1148                     chars[c] = '.'
1149                 end
1150             else
1151                 print("\t")
1152                 chars[c] = ' '
1153             end
1154
1155             i += 1
1156         end
1157
1158         println("\t", ASCIIString(chars))
1159     end
1160 end
1161
1162 function printPS()
1163     count = reg.PSP - PSP0
1164
1165     if count > 0
1166         print("<$count>")
1167         for i in (PSP0+1):reg.PSP
1168             print(" $(mem[i])")
1169         end
1170         println()
1171     else
1172         println("Parameter stack empty")
1173     end
1174 end
1175
1176 function printRS()
1177     count = reg.RSP - RSP0
1178
1179     if count > 0
1180         print("<$count>")
1181         for i in (RSP0+1):reg.RSP
1182             print(" $(mem[i])")
1183         end
1184         println()
1185     else
1186         println("Return stack empty")
1187     end
1188 end
1189
1190 DUMP = defPrimWord("DUMP", () -> begin
1191     count = popPS()
1192     addr = popPS()
1193
1194     println()
1195     dump(addr, count=count)
1196
1197     return NEXT
1198 end)
1199
1200 end