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 # The mem array constitutes the memory of the VM. It has the following geography:
  12 #
  13 # mem = +-----------------------+
  14 #       | Built-in Variables    |
  15 #       +-----------------------+
  16 #       | Return Stack          |
  17 #       +-----------------------+
  18 #       | Parameter Stack       |
  19 #       +-----------------------+
  20 #       | Terminal Input Buffer |
  21 #       +-----------------------+
  22 #       | Dictionary            |
  23 #       +-----------------------+
  24 #
  25 # Note that all words (user-defined, primitive, variables, etc) are included in
  26 # the dictionary.
  27 #
  28 # Simple linear addressing is used with one exception: references to primitive code
  29 # blocks, which are represented as anonymous functions, appear as negative indicies
  30 # into the primitives array which contains these functions.
  31
  32 mem = Array{Int64,1}(size_mem)
  33 primitives = Array{Function,1}()
  34 primNames = Array{ASCIIString,1}()
  35
  36 # Built-in variables
  37
  38 nextVarAddr = 1
  39 HERE = nextVarAddr; nextVarAddr += 1
  40 LATEST = nextVarAddr; nextVarAddr += 1
  41
  42 RSP0 = nextVarAddr                  # bottom of RS
  43 PSP0 = RSP0 + size_RS               # bottom of PS
  44 TIB = PSP0 + size_PS                # address of terminal input buffer
  45 mem[HERE] = TIB + size_TIB          # location of bottom of dictionary
  46 mem[LATEST] = 0                     # no previous definition
  47
  48 DICT = mem[HERE] # Save bottom of dictionary as constant
  49
  50 # VM registers
  51 type Reg
  52     RSP::Int64  # Return stack pointer
  53     PSP::Int64  # Parameter/data stack pointer
  54     IP::Int64   # Instruction pointer
  55     W::Int64    # Working register
  56 end
  57 reg = Reg(RSP0, PSP0, 0, 0)
  58
  59 # Stack manipulation functions
  60
  61 type ParamStackUnderflow <: Exception end
  62 type ReturnStackUnderflow <: Exception end
  63
  64 Base.showerror(io::IO, ex::ParamStackUnderflow) = print(io, "Parameter stack underflow.")
  65 Base.showerror(io::IO, ex::ReturnStackUnderflow) = print(io, "Return stack underflow.")
  66
  67 getRSDepth() = reg.RSP - RSP0
  68 getPSDepth() = reg.PSP - PSP0
  69
  70 function ensurePSDepth(depth::Int64)
  71     if getPSDepth()<depth
  72         throw(ParamStackUnderflow())
  73     end
  74 end
  75
  76 function ensureRSDepth(depth::Int64)
  77     if getRSDepth()<depth
  78         throw(ReturnStackUnderflow())
  79     end
  80 end
  81
  82 function pushRS(val::Int64)
  83     mem[reg.RSP+=1] = val
  84 end
  85
  86 function popRS()
  87     ensureRSDepth(1)
  88
  89     val = mem[reg.RSP]
  90     reg.RSP -= 1
  91     return val
  92 end
  93
  94 function pushPS(val::Int64)
  95     mem[reg.PSP += 1] = val
  96 end
  97
  98 function popPS()
  99     ensurePSDepth(1)
 100
 101     val = mem[reg.PSP]
 102     reg.PSP -= 1
 103     return val
 104 end
 105
 106 # Handy functions for adding/retrieving strings to/from memory.
 107
 108 getString(addr::Int64, len::Int64) = ASCIIString([Char(c) for c in mem[addr:(addr+len-1)]])
 109
 110 function putString(str::ASCIIString, addr::Int64)
 111     mem[addr:(addr+length(str)-1)] = [Int64(c) for c in str]
 112 end
 113
 114 # Primitive creation and calling functions
 115
 116 function defPrim(f::Function; name="nameless")
 117     push!(primitives, f)
 118     push!(primNames, replace(name, "\004", "EOF"))
 119
 120     return -length(primitives)
 121 end
 122
 123 function callPrim(addr::Int64)
 124     if addr >=0 || -addr>length(primitives)
 125         error("Attempted to execute non-existent primitive at address $addr.")
 126     else
 127         primitives[-addr]()
 128     end
 129 end
 130 getPrimName(addr::Int64) = primNames[-addr]
 131
 132 # Word creation functions
 133
 134 F_IMMED = 128
 135 F_HIDDEN = 256
 136 F_LENMASK = 127
 137
 138 function createHeader(name::AbstractString, flags::Int64)
 139     mem[mem[HERE]] = mem[LATEST]
 140     mem[LATEST] = mem[HERE]
 141     mem[HERE] += 1
 142
 143     mem[mem[HERE]] = length(name) | flags; mem[HERE] += 1
 144     putString(name, mem[HERE]); mem[HERE] += length(name)
 145 end
 146
 147 function defPrimWord(name::AbstractString, f::Function; flags::Int64=0)
 148     createHeader(name, flags)
 149
 150     codeWordAddr = mem[HERE]
 151     mem[codeWordAddr] = defPrim(f, name=name)
 152     mem[HERE] += 1
 153
 154     return codeWordAddr
 155 end
 156
 157 function defWord(name::AbstractString, wordAddrs::Array{Int64,1}; flags::Int64=0)
 158     createHeader(name, flags)
 159
 160     addr = mem[HERE]
 161     mem[mem[HERE]] = DOCOL
 162     mem[HERE] += 1
 163
 164     for wordAddr in wordAddrs
 165         mem[mem[HERE]] = wordAddr
 166         mem[HERE] += 1
 167     end
 168
 169     return addr
 170 end
 171
 172 # Variable creation functions
 173
 174 function defExistingVar(name::AbstractString, varAddr::Int64; flags::Int64=0)
 175
 176     defPrimWord(name, eval(:(() -> begin
 177         pushPS($(varAddr))
 178         return NEXT
 179     end)))
 180 end
 181
 182 function defNewVar(name::AbstractString, initial::Int64; flags::Int64=0)
 183     createHeader(name, flags)
 184
 185     codeWordAddr = mem[HERE]
 186     varAddr = mem[HERE] + 1
 187
 188     mem[mem[HERE]] = DOVAR; mem[HERE] += 1
 189     mem[mem[HERE]] = initial; mem[HERE] += 1
 190
 191     return varAddr, codeWordAddr
 192 end
 193
 194 function defConst(name::AbstractString, val::Int64; flags::Int64=0)
 195     createHeader(name, flags)
 196
 197     codeWordAddr = mem[HERE]
 198
 199     mem[mem[HERE]] = DOCON; mem[HERE] += 1
 200     mem[mem[HERE]] = val; mem[HERE] += 1
 201
 202     return codeWordAddr
 203 end
 204
 205 # Threading Primitives (inner interpreter)
 206
 207 NEXT = defPrim(() -> begin
 208     reg.W = mem[reg.IP]
 209     reg.IP += 1
 210     return mem[reg.W]
 211 end, name="NEXT")
 212
 213 DOCOL = defPrim(() -> begin
 214     pushRS(reg.IP)
 215     reg.IP = reg.W + 1
 216     return NEXT
 217 end, name="DOCOL")
 218
 219 DOVAR = defPrim(() -> begin
 220     pushPS(reg.W + 1)
 221     return NEXT
 222 end, name="DOVAR")
 223
 224 DOCON = defPrim(() -> begin
 225     pushPS(mem[reg.W + 1])
 226     return NEXT
 227 end, name="DOVAR")
 228
 229 EXIT = defPrimWord("EXIT", () -> begin
 230     reg.IP = popRS()
 231     return NEXT
 232 end)
 233
 234 # Dictionary entries for core built-in variables, constants
 235
 236 HERE_CFA = defExistingVar("HERE", HERE)
 237 LATEST_CFA = defExistingVar("LATEST", LATEST)
 238
 239 PSP0_CFA = defConst("PSP0", PSP0)
 240 RSP0_CFA = defConst("RSP0", RSP0)
 241
 242 defConst("DOCOL", DOCOL)
 243 defConst("DOCON", DOCON)
 244 defConst("DOVAR", DOVAR)
 245
 246 defConst("DICT", DICT)
 247 defConst("MEMSIZE", size_mem)
 248
 249 F_IMMED_CFA = defConst("F_IMMED", F_IMMED)
 250 F_HIDDEN_CFA = defConst("F_HIDDEN", F_HIDDEN)
 251 F_LENMASK_CFA = defConst("F_LENMASK", F_LENMASK)
 252
 253 # Basic forth primitives
 254
 255 DROP = defPrimWord("DROP", () -> begin
 256     popPS()
 257     return NEXT
 258 end)
 259
 260 SWAP = defPrimWord("SWAP", () -> begin
 261     a = popPS()
 262     b = popPS()
 263     pushPS(a)
 264     pushPS(b)
 265     return NEXT
 266 end)
 267
 268 DUP = defPrimWord("DUP", () -> begin
 269     ensurePSDepth(1)
 270     pushPS(mem[reg.PSP])
 271     return NEXT
 272 end)
 273
 274 OVER = defPrimWord("OVER", () -> begin
 275     ensurePSDepth(2)
 276     pushPS(mem[reg.PSP-1])
 277     return NEXT
 278 end)
 279
 280 ROT = defPrimWord("ROT", () -> begin
 281     a = popPS()
 282     b = popPS()
 283     c = popPS()
 284     pushPS(b)
 285     pushPS(a)
 286     pushPS(c)
 287     return NEXT
 288 end)
 289
 290 NROT = defPrimWord("-ROT", () -> begin
 291     a = popPS()
 292     b = popPS()
 293     c = popPS()
 294     pushPS(a)
 295     pushPS(c)
 296     pushPS(b)
 297     return NEXT
 298 end)
 299
 300
 301 TWODROP = defPrimWord("2DROP", () -> begin
 302     popPS()
 303     popPS()
 304     return NEXT
 305 end)
 306
 307 TWODUP = defPrimWord("2DUP", () -> begin
 308     ensurePSDepth(2)
 309     a = mem[reg.PSP-1]
 310     b = mem[reg.PSP]
 311     pushPS(a)
 312     pushPS(b)
 313     return NEXT
 314 end)
 315
 316 TWOSWAP = defPrimWord("2SWAP", () -> begin
 317     a = popPS()
 318     b = popPS()
 319     c = popPS()
 320     d = popPS()
 321     pushPS(b)
 322     pushPS(a)
 323     pushPS(d)
 324     pushPS(c)
 325     return NEXT
 326 end)
 327
 328 TWOOVER = defPrimWord("2OVER", () -> begin
 329     ensurePSDepth(4)
 330     a = mem[reg.PSP-3]
 331     b = mem[reg.PSP-2]
 332     pushPS(a)
 333     pushPS(b)
 334     return NEXT
 335 end)
 336
 337 QDUP = defPrimWord("?DUP", () -> begin
 338     ensurePSDepth(1)
 339     val = mem[reg.PSP]
 340     if val != 0
 341         pushPS(val)
 342     end
 343     return NEXT
 344 end)
 345
 346 INCR = defPrimWord("1+", () -> begin
 347     ensurePSDepth(1)
 348     mem[reg.PSP] += 1
 349     return NEXT
 350 end)
 351
 352 DECR = defPrimWord("1-", () -> begin
 353     ensurePSDepth(1)
 354     mem[reg.PSP] -= 1
 355     return NEXT
 356 end)
 357
 358 INCR2 = defPrimWord("2+", () -> begin
 359     ensurePSDepth(1)
 360     mem[reg.PSP] += 2
 361     return NEXT
 362 end)
 363
 364 DECR2 = defPrimWord("2-", () -> begin
 365     ensurePSDepth(1)
 366     mem[reg.PSP] -= 2
 367     return NEXT
 368 end)
 369
 370 ADD = defPrimWord("+", () -> begin
 371     b = popPS()
 372     a = popPS()
 373     pushPS(a+b)
 374     return NEXT
 375 end)
 376
 377 SUB = defPrimWord("-", () -> begin
 378     b = popPS()
 379     a = popPS()
 380     pushPS(a-b)
 381     return NEXT
 382 end)
 383
 384 MUL = defPrimWord("*", () -> begin
 385     b = popPS()
 386     a = popPS()
 387     pushPS(a*b)
 388     return NEXT
 389 end)
 390
 391 DIVMOD = defPrimWord("/MOD", () -> begin
 392     b = popPS()
 393     a = popPS()
 394     q,r = divrem(a,b)
 395     pushPS(r)
 396     pushPS(q)
 397     return NEXT
 398 end)
 399
 400 TWOMUL = defPrimWord("2*", () -> begin
 401     pushPS(popPS() << 1)
 402     return NEXT
 403 end)
 404
 405 TWODIV = defPrimWord("2/", () -> begin
 406     pushPS(popPS() >> 1)
 407     return NEXT
 408 end)
 409
 410 EQ = defPrimWord("=", () -> begin
 411     b = popPS()
 412     a = popPS()
 413     pushPS(a==b ? -1 : 0)
 414     return NEXT
 415 end)
 416
 417 NE = defPrimWord("<>", () -> begin
 418     b = popPS()
 419     a = popPS()
 420     pushPS(a!=b ? -1 : 0)
 421     return NEXT
 422 end)
 423
 424 LT = defPrimWord("<", () -> begin
 425     b = popPS()
 426     a = popPS()
 427     pushPS(a<b ? -1 : 0)
 428     return NEXT
 429 end)
 430
 431 GT = defPrimWord(">", () -> begin
 432     b = popPS()
 433     a = popPS()
 434     pushPS(a>b ? -1 : 0)
 435     return NEXT
 436 end)
 437
 438 LE = defPrimWord("<=", () -> begin
 439     b = popPS()
 440     a = popPS()
 441     pushPS(a<=b ? -1 : 0)
 442     return NEXT
 443 end)
 444
 445 GE = defPrimWord(">=", () -> begin
 446     b = popPS()
 447     a = popPS()
 448     pushPS(a>=b ? -1 : 0)
 449     return NEXT
 450 end)
 451
 452 ZE = defPrimWord("0=", () -> begin
 453     pushPS(popPS() == 0 ? -1 : 0)
 454     return NEXT
 455 end)
 456
 457 ZNE = defPrimWord("0<>", () -> begin
 458     pushPS(popPS() != 0 ? -1 : 0)
 459     return NEXT
 460 end)
 461
 462 ZLT = defPrimWord("0<", () -> begin
 463     pushPS(popPS() < 0 ? -1 : 0)
 464     return NEXT
 465 end)
 466
 467 ZGT = defPrimWord("0>", () -> begin
 468     pushPS(popPS() > 0 ? -1 : 0)
 469     return NEXT
 470 end)
 471
 472 ZLE = defPrimWord("0<=", () -> begin
 473     pushPS(popPS() <= 0 ? -1 : 0)
 474     return NEXT
 475 end)
 476
 477 ZGE = defPrimWord("0>=", () -> begin
 478     pushPS(popPS() >= 0 ? -1 : 0)
 479     return NEXT
 480 end)
 481
 482 AND = defPrimWord("AND", () -> begin
 483     b = popPS()
 484     a = popPS()
 485     pushPS(a & b)
 486     return NEXT
 487 end)
 488
 489 OR = defPrimWord("OR", () -> begin
 490     b = popPS()
 491     a = popPS()
 492     pushPS(a | b)
 493     return NEXT
 494 end)
 495
 496 XOR = defPrimWord("XOR", () -> begin
 497     b = popPS()
 498     a = popPS()
 499     pushPS(a $ b)
 500     return NEXT
 501 end)
 502
 503 INVERT = defPrimWord("INVERT", () -> begin
 504     pushPS(~popPS())
 505     return NEXT
 506 end)
 507
 508 # Literals
 509
 510 LIT = defPrimWord("LIT", () -> begin
 511     pushPS(mem[reg.IP])
 512     reg.IP += 1
 513     return NEXT
 514 end)
 515
 516 # Memory primitives
 517
 518 STORE = defPrimWord("!", () -> begin
 519     addr = popPS()
 520     dat = popPS()
 521     mem[addr] = dat
 522     return NEXT
 523 end)
 524
 525 FETCH = defPrimWord("@", () -> begin
 526     addr = popPS()
 527     pushPS(mem[addr])
 528     return NEXT
 529 end)
 530
 531 ADDSTORE = defPrimWord("+!", () -> begin
 532     addr = popPS()
 533     toAdd = popPS()
 534     mem[addr] += toAdd
 535     return NEXT
 536 end)
 537
 538 SUBSTORE = defPrimWord("-!", () -> begin
 539     addr = popPS()
 540     toSub = popPS()
 541     mem[addr] -= toSub
 542     return NEXT
 543 end)
 544
 545
 546 # Return Stack
 547
 548 TOR = defPrimWord(">R", () -> begin
 549     pushRS(popPS())
 550     return NEXT
 551 end)
 552
 553 FROMR = defPrimWord("R>", () -> begin
 554     pushPS(popRS())
 555     return NEXT
 556 end)
 557
 558 RFETCH = defPrimWord("R@", () -> begin
 559     pushPS(mem[reg.RSP])
 560     return NEXT
 561 end)
 562
 563 RSPFETCH = defPrimWord("RSP@", () -> begin
 564     pushPS(reg.RSP)
 565     return NEXT
 566 end)
 567
 568 RSPSTORE = defPrimWord("RSP!", () -> begin
 569     reg.RSP = popPS()
 570     return NEXT
 571 end)
 572
 573 RDROP = defPrimWord("RDROP", () -> begin
 574     popRS()
 575     return NEXT
 576 end)
 577
 578 # Parameter Stack
 579
 580 PSPFETCH = defPrimWord("PSP@", () -> begin
 581     pushPS(reg.PSP)
 582     return NEXT
 583 end)
 584
 585 PSPSTORE = defPrimWord("PSP!", () -> begin
 586     reg.PSP = popPS()
 587     return NEXT
 588 end)
 589
 590 # Working Register
 591
 592 WFETCH = defPrimWord("W@", () -> begin
 593     pushPS(reg.W)
 594     return NEXT
 595 end)
 596
 597 WSTORE = defPrimWord("W!", () -> begin
 598     reg.W = popPS()
 599     return NEXT
 600 end)
 601
 602 # I/O
 603
 604 sources = Array{Any,1}()
 605 currentSource() = sources[length(sources)]
 606
 607 EOF = defPrimWord("\x04", () -> begin
 608     close(pop!(sources))
 609     if !isempty(sources)
 610         return NEXT
 611     else
 612         return 0
 613     end
 614 end)
 615
 616 EMIT = defPrimWord("EMIT", () -> begin
 617     print(Char(popPS()))
 618     return NEXT
 619 end)
 620
 621 SPAN, SPAN_CFA = defNewVar("SPAN", 0)
 622 EXPECT = defPrimWord("EXPECT", () -> begin
 623     maxLen = popPS()
 624     addr = popPS()
 625
 626     if !eof(currentSource())
 627         line = chomp(readline(currentSource()))
 628         mem[SPAN] = min(length(line), maxLen)
 629         putString(line[1:mem[SPAN]], addr)
 630     else
 631         mem[SPAN] = 1
 632         mem[addr] = 4 # eof
 633     end
 634
 635     return NEXT
 636 end)
 637
 638 BASE, BASE_CFA = defNewVar("BASE", 10)
 639 NUMBER = defPrimWord("NUMBER", () -> begin
 640     wordAddr = popPS()+1
 641     wordLen = mem[wordAddr-1]
 642
 643     s = getString(wordAddr, wordLen)
 644
 645     pushPS(parse(Int64, s, mem[BASE]))
 646
 647     return NEXT
 648 end)
 649
 650 # Dictionary searches
 651
 652 FIND = defPrimWord("FIND", () -> begin
 653
 654     countedAddr = popPS()
 655     wordAddr = countedAddr + 1
 656     wordLen = mem[countedAddr]
 657     word = lowercase(getString(wordAddr, wordLen))
 658
 659     latest = LATEST
 660
 661     i = 0
 662     while (latest = mem[latest]) > 0
 663         lenAndFlags = mem[latest+1]
 664         len = lenAndFlags & F_LENMASK
 665         hidden = (lenAndFlags & F_HIDDEN) == F_HIDDEN
 666
 667         if hidden || len != wordLen
 668             continue
 669         end
 670
 671         thisAddr = latest+2
 672         thisWord = lowercase(getString(thisAddr, len))
 673
 674         if lowercase(thisWord) == lowercase(word)
 675             break
 676         end
 677     end
 678
 679     pushPS(latest)
 680
 681     return NEXT
 682 end)
 683
 684 TOCFA = defPrimWord(">CFA", () -> begin
 685
 686     addr = popPS()
 687     lenAndFlags = mem[addr+1]
 688     len = lenAndFlags & F_LENMASK
 689
 690     pushPS(addr + 2 + len)
 691
 692     return NEXT
 693 end)
 694
 695 TOPFA = defWord(">PFA", [TOCFA, INCR, EXIT])
 696
 697 # Branching
 698
 699 BRANCH = defPrimWord("BRANCH", () -> begin
 700     reg.IP += mem[reg.IP]
 701     return NEXT
 702 end)
 703
 704 ZBRANCH = defPrimWord("0BRANCH", () -> begin
 705     if (popPS() == 0)
 706         reg.IP += mem[reg.IP]
 707     else
 708         reg.IP += 1
 709     end
 710
 711     return NEXT
 712 end)
 713
 714 # Strings
 715
 716 LITSTRING = defPrimWord("LITSTRING", () -> begin
 717     len = mem[reg.IP]
 718     reg.IP += 1
 719     pushPS(reg.IP)
 720     pushPS(len)
 721     reg.IP += len
 722
 723     return NEXT
 724 end)
 725
 726 TYPE = defPrimWord("TYPE", () -> begin
 727     len = popPS()
 728     addr = popPS()
 729     str = getString(addr, len)
 730     print(str)
 731     return NEXT
 732 end)
 733
 734 # Outer interpreter
 735
 736 TRACE = defPrimWord("TRACE", () -> begin
 737     println("reg.W: $(reg.W) reg.IP: $(reg.IP)")
 738     print("PS: "); printPS()
 739     print("RS: "); printRS()
 740     print("[paused]")
 741     readline()
 742
 743     return NEXT
 744 end)
 745
 746 COMMA = defPrimWord(",", () -> begin
 747     mem[mem[HERE]] = popPS()
 748     mem[HERE] += 1
 749
 750     return NEXT
 751 end)
 752
 753 BTICK = defWord("[']",
 754     [FROMR, DUP, INCR, TOR, FETCH, EXIT])
 755
 756 EXECUTE = defPrimWord("EXECUTE", () -> begin
 757     reg.W = popPS()
 758     return mem[reg.W]
 759 end)
 760
 761 TIB_CFA = defConst("TIB", TIB)
 762 NUMTIB, NUMTIB_CFA = defNewVar("#TIB", 0)
 763 TOIN, TOIN_CFA = defNewVar(">IN", 0)
 764
 765 QUERY = defWord("QUERY",
 766     [TIB_CFA, LIT, 160, EXPECT,
 767     SPAN_CFA, FETCH, NUMTIB_CFA, STORE,
 768     LIT, 0, TOIN_CFA, STORE,
 769     EXIT])
 770
 771 WORD = defPrimWord("WORD", () -> begin
 772     delim = popPS()
 773
 774     # Chew up initial occurrences of delim
 775     while (mem[TOIN]<mem[NUMTIB] && mem[TIB+mem[TOIN]] == delim)
 776         mem[TOIN] += 1
 777     end
 778
 779     countAddr = mem[HERE]
 780     addr = mem[HERE]+1
 781
 782     # Start reading in word
 783     count = 0
 784     while (mem[TOIN]<mem[NUMTIB])
 785         mem[addr] = mem[TIB+mem[TOIN]]
 786         mem[TOIN] += 1
 787
 788         if (mem[addr] == delim)
 789             break
 790         end
 791
 792         count += 1
 793         addr += 1
 794     end
 795
 796     # Record count
 797     mem[countAddr] = count
 798     pushPS(countAddr)
 799
 800     return NEXT
 801 end)
 802
 803 PARSE = defPrimWord("PARSE", () -> begin
 804     delim = popPS()
 805
 806     # Chew up initial occurrences of delim
 807     addr = mem[HERE]
 808
 809     # Start reading input stream
 810     count = 0
 811     while (mem[TOIN]<mem[NUMTIB])
 812         mem[addr] = mem[TIB+mem[TOIN]]
 813         mem[TOIN] += 1
 814
 815         if (mem[addr] == delim)
 816             break
 817         end
 818
 819         count += 1
 820         addr += 1
 821     end
 822
 823     pushPS(addr)
 824     pushPS(count)
 825
 826     return NEXT
 827 end)
 828
 829 BYE = defPrimWord("BYE", () -> begin
 830     println("Bye!")
 831     return 0
 832 end)
 833
 834 STATE, STATE_CFA = defNewVar("STATE", 0)
 835
 836 INTERPRET = defWord("INTERPRET",
 837     [LIT, 32, WORD, # Read next space-delimited word
 838
 839     DUP, FETCH, ZE, ZBRANCH, 3,
 840         DROP, EXIT, # Exit if TIB is exhausted
 841
 842     STATE_CFA, FETCH, ZBRANCH, 31,
 843         # Compiling
 844         DUP, FIND, QDUP, ZBRANCH, 19,
 845
 846             # Found word.
 847             SWAP, DROP,
 848             DUP, TOCFA, SWAP, INCR, FETCH, LIT, F_IMMED, AND, ZBRANCH, 4,
 849                 # Immediate: Execute!
 850                 EXECUTE, BRANCH, -33,
 851
 852                 # Not immediate: Compile!
 853                 COMMA, BRANCH, -36,
 854
 855             # No word found, parse number
 856             NUMBER, BTICK, LIT, COMMA, COMMA, BRANCH, -43,
 857
 858        # Interpreting
 859         DUP, FIND, QDUP, ZBRANCH, 7,
 860
 861             # Found word. Execute!
 862             SWAP, DROP, TOCFA, EXECUTE, BRANCH, -54,
 863
 864             # No word found, parse number and leave on stack
 865             NUMBER, BRANCH, -57,
 866     EXIT]
 867 )
 868
 869 PROMPT = defPrimWord("PROMPT", () -> begin
 870     if (mem[STATE] == 0 && currentSource() == STDIN)
 871         println(" ok")
 872     end
 873
 874     return NEXT
 875 end)
 876
 877 QUIT = defWord("QUIT",
 878     [LIT, 0, STATE_CFA, STORE,
 879     LIT, 0, NUMTIB_CFA, STORE,
 880     RSP0_CFA, RSPSTORE,
 881     QUERY,
 882     INTERPRET, PROMPT,
 883     BRANCH,-4])
 884
 885 ABORT = defWord("ABORT",
 886     [PSP0_CFA, PSPSTORE, QUIT])
 887
 888 INCLUDE = defPrimWord("INCLUDE", () -> begin
 889     pushPS(32)
 890     callPrim(mem[WORD])
 891     wordAddr = popPS()+1
 892     wordLen = mem[wordAddr-1]
 893     word = getString(wordAddr, wordLen)
 894
 895     push!(sources, open(word, "r"))
 896
 897     # Clear input buffer
 898     mem[NUMTIB] = 0
 899
 900     return NEXT
 901 end)
 902
 903 # Compilation
 904
 905 HEADER = defPrimWord("HEADER", () -> begin
 906     wordAddr = popPS()+1
 907     wordLen = mem[wordAddr-1]
 908     word = getString(wordAddr, wordLen)
 909
 910     createHeader(word, 0)
 911
 912     return NEXT
 913 end)
 914
 915 LBRAC = defPrimWord("[", () -> begin
 916     mem[STATE] = 0
 917     return NEXT
 918 end, flags=F_IMMED)
 919
 920 RBRAC = defPrimWord("]", () -> begin
 921     mem[STATE] = 1
 922     return NEXT
 923 end, flags=F_IMMED)
 924
 925 HIDDEN = defPrimWord("HIDDEN", () -> begin
 926     addr = popPS() + 1
 927     mem[addr] = mem[addr] $ F_HIDDEN
 928     return NEXT
 929 end)
 930
 931 HIDE = defWord("HIDE",
 932     [LIT, 32, WORD,
 933     FIND,
 934     HIDDEN,
 935     EXIT])
 936
 937 COLON = defWord(":",
 938     [LIT, 32, WORD,
 939     HEADER,
 940     LIT, DOCOL, COMMA,
 941     LATEST_CFA, FETCH, HIDDEN,
 942     RBRAC,
 943     EXIT])
 944
 945 SEMICOLON = defWord(";",
 946     [LIT, EXIT, COMMA,
 947     LATEST_CFA, FETCH, HIDDEN,
 948     LBRAC,
 949     EXIT], flags=F_IMMED)
 950
 951 IMMEDIATE = defPrimWord("IMMEDIATE", () -> begin
 952     lenAndFlagsAddr = mem[LATEST] + 1
 953     mem[lenAndFlagsAddr] = mem[lenAndFlagsAddr] $ F_IMMED
 954     return NEXT
 955 end, flags=F_IMMED)
 956
 957
 958 #### VM loop ####
 959
 960 initialized = false
 961 initFileName = nothing
 962 if isfile("lib.4th")
 963     initFileName = "lib.4th"
 964 elseif isfile(Pkg.dir("forth/src/lib.4th"))
 965     initFileName = Pkg.dir("forth/src/lib.4th")
 966 end
 967
 968 function run(;initialize=true)
 969     # Begin with STDIN as source
 970     push!(sources, STDIN)
 971
 972     global initialized, initFileName
 973     if !initialized && initialize
 974         if initFileName != nothing
 975             print("Including definitions from $initFileName...")
 976             push!(sources, open(initFileName, "r"))
 977             initialized = true
 978         else
 979             println("No library file found. Only primitive words available.")
 980         end
 981     end
 982
 983     # Start with IP pointing to first instruction of outer interpreter
 984     reg.IP = QUIT + 1
 985
 986     # Primitive processing loop.
 987     # Everyting else is simply a consequence of this loop!
 988     jmp = NEXT
 989     while jmp != 0
 990         try
 991             #println("Entering prim $(getPrimName(jmp))")
 992             jmp = callPrim(jmp)
 993
 994         catch ex
 995             showerror(STDOUT, ex)
 996             println()
 997
 998             while !isempty(sources) && currentSource() != STDIN
 999                 close(pop!(sources))
1000             end
1001
1002             # QUIT
1003             reg.IP = ABORT + 1
1004             jmp = NEXT
1005         end
1006     end
1007 end
1008
1009 # Debugging tools
1010
1011 function dump(startAddr::Int64; count::Int64 = 100, cellsPerLine::Int64 = 10)
1012     chars = Array{Char,1}(cellsPerLine)
1013
1014     lineStartAddr = cellsPerLine*div((startAddr-1),cellsPerLine) + 1
1015     endAddr = startAddr + count - 1
1016
1017     q, r = divrem((endAddr-lineStartAddr+1), cellsPerLine)
1018     numLines = q + (r > 0 ? 1 : 0)
1019
1020     i = lineStartAddr
1021     for l in 1:numLines
1022         print(i,":")
1023
1024         for c in 1:cellsPerLine
1025             if i >= startAddr && i <= endAddr
1026                 print("\t",mem[i])
1027                 if mem[i]>=32 && mem[i]<128
1028                     chars[c] = Char(mem[i])
1029                 else
1030                     chars[c] = '.'
1031                 end
1032             else
1033                 print("\t")
1034                 chars[c] = ' '
1035             end
1036
1037             i += 1
1038         end
1039
1040         println("\t", ASCIIString(chars))
1041     end
1042 end
1043
1044 function printPS()
1045     count = reg.PSP - PSP0
1046
1047     if count > 0
1048         print("<$count>")
1049         for i in (PSP0+1):reg.PSP
1050             print(" $(mem[i])")
1051         end
1052         println()
1053     else
1054         println("Parameter stack empty")
1055     end
1056 end
1057
1058 function printRS()
1059     count = reg.RSP - RSP0
1060
1061     if count > 0
1062         print("<$count>")
1063         for i in (RSP0+1):reg.RSP
1064             print(" $(mem[i])")
1065         end
1066         println()
1067     else
1068         println("Return stack empty")
1069     end
1070 end
1071
1072 DUMP = defPrimWord("DUMP", () -> begin
1073     count = popPS()
1074     addr = popPS()
1075
1076     dump(addr, count=count)
1077
1078     return NEXT
1079 end)
1080
1081 end