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