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