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 RSP0 = nextVarAddr; nextVarAddr += 1
  40 PSP0 = nextVarAddr; nextVarAddr += 1
  41 HERE = nextVarAddr; nextVarAddr += 1
  42 LATEST = nextVarAddr; nextVarAddr += 1
  43
  44 mem[RSP0] = nextVarAddr              # bottom of RS
  45 mem[PSP0] = mem[RSP0] + size_RS      # bottom of PS
  46 TIB = mem[PSP0] + size_PS            # address of terminal input buffer
  47 mem[HERE] = TIB + size_TIB           # location of bottom of dictionary
  48 mem[LATEST] = 0                      # no previous definition
  49
  50 DICT = mem[HERE] # Save bottom of dictionary as constant
  51
  52 # VM registers
  53 type Reg
  54     RSP::Int64  # Return stack pointer
  55     PSP::Int64  # Parameter/data stack pointer
  56     IP::Int64   # Instruction pointer
  57     W::Int64    # Working register
  58 end
  59 reg = Reg(mem[RSP0], mem[PSP0], 0, 0)
  60
  61 # Stack manipulation functions
  62
  63 type ParamStackUnderflow <: Exception end
  64 type ReturnStackUnderflow <: Exception end
  65
  66 Base.showerror(io::IO, ex::ParamStackUnderflow) = print(io, "Parameter stack underflow.")
  67 Base.showerror(io::IO, ex::ReturnStackUnderflow) = print(io, "Return stack underflow.")
  68
  69 getRSDepth() = reg.RSP - mem[RSP0]
  70 getPSDepth() = reg.PSP - mem[PSP0]
  71
  72 function ensurePSDepth(depth::Int64)
  73     if getPSDepth()<depth
  74         throw(ParamStackUnderflow())
  75     end
  76 end
  77
  78 function ensureRSDepth(depth::Int64)
  79     if getRSDepth()<depth
  80         throw(ReturnStackUnderflow())
  81     end
  82 end
  83
  84 function pushRS(val::Int64)
  85     mem[reg.RSP+=1] = val
  86 end
  87
  88 function popRS()
  89     ensureRSDepth(1)
  90
  91     val = mem[reg.RSP]
  92     reg.RSP -= 1
  93     return val
  94 end
  95
  96 function pushPS(val::Int64)
  97     mem[reg.PSP += 1] = val
  98 end
  99
 100 function popPS()
 101     ensurePSDepth(1)
 102
 103     val = mem[reg.PSP]
 104     reg.PSP -= 1
 105     return val
 106 end
 107
 108 # Handy functions for adding/retrieving strings to/from memory.
 109
 110 getString(addr::Int64, len::Int64) = ASCIIString([Char(c) for c in mem[addr:(addr+len-1)]])
 111 function putString(str::ASCIIString, addr::Int64)
 112     mem[addr:(addr+length(str)-1)] = [Int64(c) for c in str]
 113 end
 114
 115 # Primitive creation and calling functions
 116
 117 function defPrim(f::Function; name="nameless")
 118     push!(primitives, f)
 119     push!(primNames, replace(replace(name, "\004", "EOF"), "\n", "\\n"))
 120
 121     return -length(primitives)
 122 end
 123
 124 function callPrim(addr::Int64)
 125     if addr >=0 || -addr>length(primitives)
 126         error("Attempted to execute non-existent primitive at address $addr.")
 127     else
 128         primitives[-addr]()
 129     end
 130 end
 131 getPrimName(addr::Int64) = primNames[-addr]
 132
 133 # Word creation functions
 134
 135 F_IMMED = 128
 136 F_HIDDEN = 256
 137 F_LENMASK = 127
 138
 139 function createHeader(name::AbstractString, flags::Int64)
 140     mem[mem[HERE]] = mem[LATEST]
 141     mem[LATEST] = mem[HERE]
 142     mem[HERE] += 1
 143
 144     mem[mem[HERE]] = length(name) | flags; mem[HERE] += 1
 145     putString(name, mem[HERE]); mem[HERE] += length(name)
 146 end
 147
 148 function defPrimWord(name::AbstractString, f::Function; flags::Int64=0)
 149     createHeader(name, flags)
 150
 151     codeWordAddr = mem[HERE]
 152     mem[codeWordAddr] = defPrim(f, name=name)
 153     mem[HERE] += 1
 154
 155     return codeWordAddr
 156 end
 157
 158 function defWord(name::AbstractString, wordAddrs::Array{Int64,1}; flags::Int64=0)
 159     createHeader(name, flags)
 160
 161     addr = mem[HERE]
 162     mem[mem[HERE]] = DOCOL
 163     mem[HERE] += 1
 164
 165     for wordAddr in wordAddrs
 166         mem[mem[HERE]] = wordAddr
 167         mem[HERE] += 1
 168     end
 169
 170     return addr
 171 end
 172
 173 # Variable creation functions
 174
 175 function defExistingVar(name::AbstractString, varAddr::Int64; flags::Int64=0)
 176
 177     defPrimWord(name, eval(:(() -> begin
 178         pushPS($(varAddr))
 179         return NEXT
 180     end)))
 181 end
 182
 183 function defNewVar(name::AbstractString, initial::Int64; flags::Int64=0)
 184     createHeader(name, flags)
 185
 186     codeWordAddr = mem[HERE]
 187     varAddr = mem[HERE] + 1
 188
 189     mem[mem[HERE]] = DOVAR; mem[HERE] += 1
 190     mem[mem[HERE]] = initial; mem[HERE] += 1
 191
 192     return varAddr, codeWordAddr
 193 end
 194
 195 function defConst(name::AbstractString, val::Int64; flags::Int64=0)
 196     createHeader(name, flags)
 197
 198     codeWordAddr = mem[HERE]
 199
 200     mem[mem[HERE]] = DOCON; mem[HERE] += 1
 201     mem[mem[HERE]] = val; mem[HERE] += 1
 202
 203     return codeWordAddr
 204 end
 205
 206 # Threading Primitives (inner interpreter)
 207
 208 NEXT = defPrim(() -> begin
 209     reg.W = mem[reg.IP]
 210     reg.IP += 1
 211     return mem[reg.W]
 212 end, name="NEXT")
 213
 214 DOCOL = defPrim(() -> begin
 215     pushRS(reg.IP)
 216     reg.IP = reg.W + 1
 217     return NEXT
 218 end, name="DOCOL")
 219
 220 DOVAR = defPrim(() -> begin
 221     pushPS(reg.W + 1)
 222     return NEXT
 223 end, name="DOVAR")
 224
 225 DOCON = defPrim(() -> begin
 226     pushPS(mem[reg.W + 1])
 227     return NEXT
 228 end, name="DOVAR")
 229
 230 EXIT = defPrimWord("EXIT", () -> begin
 231     reg.IP = popRS()
 232     return NEXT
 233 end)
 234
 235 # Dictionary entries for core built-in variables, constants
 236
 237 HERE_CFA = defExistingVar("HERE", HERE)
 238 LATEST_CFA = defExistingVar("LATEST", LATEST)
 239 PSP0_CFA = defExistingVar("PSP0", PSP0)
 240 RSP0_CFA = defExistingVar("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     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     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_CFA = defConst("EOF", 4)
 608
 609 EMIT = defPrimWord("EMIT", () -> begin
 610     print(Char(popPS()))
 611     return NEXT
 612 end)
 613
 614 SPAN, SPAN_CFA = defNewVar("SPAN", 0)
 615 EXPECT = defPrimWord("EXPECT", () -> begin
 616     maxLen = popPS()
 617     addr = popPS()
 618
 619     if !eof(currentSource())
 620         line = chomp(readline(currentSource()))
 621         mem[SPAN] = min(length(line), maxLen)
 622         putString(line[1:mem[SPAN]], addr)
 623     else
 624         mem[SPAN] = 1
 625         mem[addr] = EOF
 626     end
 627
 628     return NEXT
 629 end)
 630
 631 BASE, BASE_CFA = defNewVar("BASE", 10)
 632 NUMBER = defPrimWord("NUMBER", () -> begin
 633     wordAddr = popPS()+1
 634     wordLen = mem[wordAddr-1]
 635
 636     s = getString(wordAddr, wordLen)
 637
 638     pushPS(parse(Int64, s, mem[BASE]))
 639
 640     return NEXT
 641 end)
 642
 643 # Dictionary searches
 644
 645 FIND = defPrimWord("FIND", () -> begin
 646
 647     countedAddr = popPS()
 648     wordAddr = countedAddr + 1
 649     wordLen = mem[countedAddr]
 650     word = lowercase(getString(wordAddr, wordLen))
 651
 652     latest = LATEST
 653
 654     i = 0
 655     while (latest = mem[latest]) > 0
 656         lenAndFlags = mem[latest+1]
 657         len = lenAndFlags & F_LENMASK
 658         hidden = (lenAndFlags & F_HIDDEN) == F_HIDDEN
 659
 660         if hidden || len != wordLen
 661             continue
 662         end
 663
 664         thisAddr = latest+2
 665         thisWord = lowercase(getString(thisAddr, len))
 666
 667         if lowercase(thisWord) == lowercase(word)
 668             break
 669         end
 670     end
 671
 672     pushPS(latest)
 673
 674     return NEXT
 675 end)
 676
 677 TOCFA = defPrimWord(">CFA", () -> begin
 678
 679     addr = popPS()
 680     lenAndFlags = mem[addr+1]
 681     len = lenAndFlags & F_LENMASK
 682
 683     pushPS(addr + 2 + len)
 684
 685     return NEXT
 686 end)
 687
 688 TOPFA = defWord(">PFA", [TOCFA, INCR, EXIT])
 689
 690 # Branching
 691
 692 BRANCH = defPrimWord("BRANCH", () -> begin
 693     reg.IP += mem[reg.IP]
 694     return NEXT
 695 end)
 696
 697 ZBRANCH = defPrimWord("0BRANCH", () -> begin
 698     if (popPS() == 0)
 699         reg.IP += mem[reg.IP]
 700     else
 701         reg.IP += 1
 702     end
 703
 704     return NEXT
 705 end)
 706
 707 # Strings
 708
 709 LITSTRING = defPrimWord("LITSTRING", () -> begin
 710     len = mem[reg.IP]
 711     reg.IP += 1
 712     pushPS(reg.IP)
 713     pushPS(len)
 714     reg.IP += len
 715
 716     return NEXT
 717 end)
 718
 719 TYPE = defPrimWord("TYPE", () -> begin
 720     len = popPS()
 721     addr = popPS()
 722     str = getString(addr, len)
 723     print(str)
 724     return NEXT
 725 end)
 726
 727 # Outer interpreter
 728
 729 TRACE = defPrimWord("TRACE", () -> begin
 730     println("reg.W: $(reg.W) reg.IP: $(reg.IP)")
 731     print("PS: "); printPS()
 732     print("RS: "); printRS()
 733     print("[paused]")
 734     readline()
 735
 736     return NEXT
 737 end)
 738
 739 COMMA = defPrimWord(",", () -> begin
 740     mem[mem[HERE]] = popPS()
 741     mem[HERE] += 1
 742
 743     return NEXT
 744 end)
 745
 746 BTICK = defWord("[']",
 747     [FROMR, DUP, INCR, TOR, FETCH, EXIT])
 748
 749 EXECUTE = defPrimWord("EXECUTE", () -> begin
 750     reg.W = popPS()
 751     return mem[reg.W]
 752 end)
 753
 754 TIB_CFA = defConst("TIB", TIB)
 755 NUMTIB, NUMTIB_CFA = defNewVar("#TIB", 0)
 756 TOIN, TOIN_CFA = defNewVar(">IN", 0)
 757
 758 QUERY = defWord("QUERY",
 759     [TIB_CFA, LIT, 80, EXPECT,
 760     SPAN_CFA, FETCH, NUMTIB_CFA, STORE,
 761     LIT, 0, TOIN_CFA, STORE,
 762     EXIT])
 763
 764 WORD = defPrimWord("WORD", () -> begin
 765     delim = popPS()
 766
 767     # Chew up initial occurrences of delim
 768     while (mem[TOIN]<mem[NUMTIB] && mem[TIB+mem[TOIN]] == delim)
 769         mem[TOIN] += 1
 770     end
 771
 772     countAddr = mem[HERE]
 773     addr = mem[HERE]+1
 774
 775     # Start reading in word
 776     count = 0
 777     while (mem[TOIN]<mem[NUMTIB])
 778         mem[addr] = mem[TIB+mem[TOIN]]
 779         mem[TOIN] += 1
 780
 781         if (mem[addr] == delim)
 782             break
 783         end
 784
 785         count += 1
 786         addr += 1
 787     end
 788
 789     # Record count
 790     mem[countAddr] = count
 791     pushPS(countAddr)
 792
 793     return NEXT
 794 end)
 795
 796 PARSE = defPrimWord("PARSE", () -> begin
 797     delim = popPS()
 798
 799     # Chew up initial occurrences of delim
 800     addr = mem[HERE]
 801
 802     # Start reading input stream
 803     count = 0
 804     while (mem[TOIN]<mem[NUMTIB])
 805         mem[addr] = mem[TIB+mem[TOIN]]
 806         mem[TOIN] += 1
 807
 808         if (mem[addr] == delim)
 809             break
 810         end
 811
 812         count += 1
 813         addr += 1
 814     end
 815
 816     pushPS(addr)
 817     pushPS(count)
 818
 819     return NEXT
 820 end)
 821
 822 BYE = defPrimWord("BYE", () -> begin
 823     println("Bye!")
 824     return 0
 825 end)
 826
 827 STATE, STATE_CFA = defNewVar("STATE", 0)
 828
 829 INTERPRET = defWord("INTERPRET",
 830     [LIT, 32, WORD, # Read next space-delimited word
 831
 832     DUP, FETCH, ZE, ZBRANCH, 3,
 833         DROP, EXIT, # Exit if TIB is exhausted
 834
 835     STATE_CFA, FETCH, ZBRANCH, 31,
 836         # Compiling
 837         DUP, FIND, QDUP, ZBRANCH, 19,
 838
 839             # Found word.
 840             SWAP, DROP,
 841             DUP, TOCFA, SWAP, INCR, FETCH, LIT, F_IMMED, AND, ZBRANCH, 4,
 842                 # Immediate: Execute!
 843                 EXECUTE, BRANCH, -33,
 844
 845                 # Not immediate: Compile!
 846                 COMMA, BRANCH, -36,
 847
 848             # No word found, parse number
 849             NUMBER, BTICK, LIT, COMMA, COMMA, BRANCH, -43,
 850
 851        # Interpreting
 852         DUP, FIND, QDUP, ZBRANCH, 7,
 853
 854             # Found word. Execute!
 855             SWAP, DROP, TOCFA, EXECUTE, BRANCH, -54,
 856
 857             # No word found, parse number and leave on stack
 858             NUMBER, BRANCH, -57,
 859     EXIT]
 860 )
 861
 862 PROMPT = defPrimWord("PROMPT", () -> begin
 863     if (mem[STATE] == 0 && currentSource() == STDIN)
 864         println(" ok")
 865     end
 866
 867     return NEXT
 868 end)
 869
 870 QUIT = defWord("QUIT",
 871     [RSP0_CFA, RSPSTORE,
 872     QUERY,
 873     INTERPRET, PROMPT,
 874     BRANCH,-4])
 875
 876 INCLUDE = defPrimWord("INCLUDE", () -> begin
 877     pushPS(32)
 878     callPrim(mem[WORD])
 879     wordAddr = popPS()+1
 880     wordLen = mem[wordAddr-1]
 881     word = getString(wordAddr, wordLen)
 882
 883     push!(sources, open(word, "r"))
 884
 885     # Clear input buffer
 886     mem[NUMTIB] = 0
 887
 888     return NEXT
 889 end)
 890
 891 # Compilation
 892
 893 HEADER = defPrimWord("HEADER", () -> begin
 894     wordAddr = popPS()+1
 895     wordLen = mem[wordAddr-1]
 896     word = getString(wordAddr, wordLen)
 897
 898     createHeader(word, 0)
 899
 900     return NEXT
 901 end)
 902
 903 LBRAC = defPrimWord("[", () -> begin
 904     mem[STATE] = 0
 905     return NEXT
 906 end, flags=F_IMMED)
 907
 908 RBRAC = defPrimWord("]", () -> begin
 909     mem[STATE] = 1
 910     return NEXT
 911 end, flags=F_IMMED)
 912
 913 HIDDEN = defPrimWord("HIDDEN", () -> begin
 914     addr = popPS() + 1
 915     mem[addr] = mem[addr] $ F_HIDDEN
 916     return NEXT
 917 end)
 918
 919 HIDE = defWord("HIDE",
 920     [LIT, 32, WORD,
 921     FIND,
 922     HIDDEN,
 923     EXIT])
 924
 925 COLON = defWord(":",
 926     [LIT, 32, WORD,
 927     HEADER,
 928     LIT, DOCOL, COMMA,
 929     LATEST_CFA, FETCH, HIDDEN,
 930     RBRAC,
 931     EXIT])
 932
 933 SEMICOLON = defWord(";",
 934     [LIT, EXIT, COMMA,
 935     LATEST_CFA, FETCH, HIDDEN,
 936     LBRAC,
 937     EXIT], flags=F_IMMED)
 938
 939 IMMEDIATE = defPrimWord("IMMEDIATE", () -> begin
 940     lenAndFlagsAddr = mem[LATEST] + 1
 941     mem[lenAndFlagsAddr] = mem[lenAndFlagsAddr] $ F_IMMED
 942     return NEXT
 943 end, flags=F_IMMED)
 944
 945
 946 #### VM loop ####
 947
 948 initialized = false
 949 initFileName = nothing
 950 if isfile("lib.4th")
 951     initFileName = "lib.4th"
 952 elseif isfile(Pkg.dir("forth/src/lib.4th"))
 953     initFileName = Pkg.dir("forth/src/lib.4th")
 954 end
 955
 956 function run(;initialize=true)
 957     # Begin with STDIN as source
 958     push!(sources, STDIN)
 959
 960     global initialized, initFileName
 961     if !initialized && initialize
 962         if initFileName != nothing
 963             print("Including definitions from $initFileName...")
 964             push!(sources, open(initFileName, "r"))
 965             initialized = true
 966         else
 967             println("No library file found. Only primitive words available.")
 968         end
 969     end
 970
 971     # Start with IP pointing to first instruction of outer interpreter
 972     reg.IP = QUIT + 1
 973
 974     # Primitive processing loop.
 975     # Everyting else is simply a consequence of this loop!
 976     jmp = NEXT
 977     while jmp != 0
 978         try
 979             #println("Entering prim $(getPrimName(jmp))")
 980             jmp = callPrim(jmp)
 981
 982         catch ex
 983             showerror(STDOUT, ex)
 984             println()
 985
 986             while !isempty(sources) && currentSource() != STDIN
 987                 close(pop!(sources))
 988             end
 989
 990             # Want backtrace in here eventually
 991             println("reg.W: $(reg.W) reg.IP: $(reg.IP)")
 992             print("PS: "); printPS()
 993             print("RS: "); printRS()
 994
 995             mem[STATE] = 0
 996             mem[NUMTIB] = 0
 997             reg.PSP = mem[PSP0]
 998             reg.RSP = mem[RSP0]
 999             reg.IP = QUIT + 1
1000             jmp = NEXT
1001         end
1002     end
1003 end
1004
1005 # Debugging tools
1006
1007 function dump(startAddr::Int64; count::Int64 = 100, cellsPerLine::Int64 = 10)
1008     chars = Array{Char,1}(cellsPerLine)
1009
1010     lineStartAddr = cellsPerLine*div((startAddr-1),cellsPerLine) + 1
1011     endAddr = startAddr + count - 1
1012
1013     q, r = divrem((endAddr-lineStartAddr+1), cellsPerLine)
1014     numLines = q + (r > 0 ? 1 : 0)
1015
1016     i = lineStartAddr
1017     for l in 1:numLines
1018         print(i,":")
1019
1020         for c in 1:cellsPerLine
1021             if i >= startAddr && i <= endAddr
1022                 print("\t",mem[i])
1023                 if mem[i]>=32 && mem[i]<128
1024                     chars[c] = Char(mem[i])
1025                 else
1026                     chars[c] = '.'
1027                 end
1028             else
1029                 print("\t")
1030                 chars[c] = ' '
1031             end
1032
1033             i += 1
1034         end
1035
1036         println("\t", ASCIIString(chars))
1037     end
1038 end
1039
1040 function printPS()
1041     count = reg.PSP - mem[PSP0]
1042
1043     if count > 0
1044         print("<$count>")
1045         for i in (mem[PSP0]+1):reg.PSP
1046             print(" $(mem[i])")
1047         end
1048         println()
1049     else
1050         println("Parameter stack empty")
1051     end
1052 end
1053
1054 function printRS()
1055     count = reg.RSP - mem[RSP0]
1056
1057     if count > 0
1058         print("<$count>")
1059         for i in (mem[RSP0]+1):reg.RSP
1060             print(" $(mem[i])")
1061         end
1062         println()
1063     else
1064         println("Return stack empty")
1065     end
1066 end
1067
1068 DUMP = defPrimWord("DUMP", () -> begin
1069     count = popPS()
1070     addr = popPS()
1071
1072     dump(addr, count=count)
1073
1074     return NEXT
1075 end)
1076
1077 end