ez.el

   1 ;;; ez.el --- Emacs Z-machine
   2
   3 ;; Copyright (C) 2021 Tim Vaughan
   4
   5 ;; Author: Tim Vaughan <timv@ughan.xyz>
   6 ;; Created: 13 Oct 2021
   7 ;; Version: 1.0
   8 ;; Keywords: game
   9 ;; Homepage: http://thelambdalab.xyz/ez
  10 ;; Package-Requires: ((emacs "26"))
  11
  12 ;; This file is not part of GNU Emacs.
  13
  14 ;; This program is free software: you can redistribute it and/or modify
  15 ;; it under the terms of the GNU General Public License as published by
  16 ;; the Free Software Foundation, either version 3 of the License, or
  17 ;; (at your option) any later version.
  18
  19 ;; This program is distributed in the hope that it will be useful,
  20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22 ;; GNU General Public License for more details.
  23
  24 ;; You should have received a copy of the GNU General Public License
  25 ;; along with this file.  If not, see <http://www.gnu.org/licenses/>.
  26
  27 ;;; Commentary:
  28
  29 ;; There are many Z-machine interpreters, but this one is mine.
  30 ;; It only capable of interpreting the subset of Z-code necessary
  31 ;; to run the first Zork game in z3 format.
  32 ;;
  33 ;; It is based entirely on the description of the Z-machine contained
  34 ;; Marnix Klooster's wonderful document, "The Z-machine And How to Emulate It."
  35
  36 ;;; Code:
  37
  38 ;; Utility functions
  39
  40 (defun ez-decode-signed-bits (n nbits)
  41   (if (= 0 (lsh n (- 1 nbits)))
  42       n
  43     (- n (lsh 1 nbits))))
  44
  45 (defun ez-decode-signed-byte (b)
  46   (ez-decode-signed-bits b 8))
  47
  48 (defun ez-decode-signed-word (w)
  49   (ez-decode-signed-bits w 16))
  50
  51 (defun ez-decode-signed-operand (operand operand-type)
  52   (if (eq operand-type 'b)
  53       (ez-decode-signed-byte operand)
  54     (ez-decode-signed-word operand)))
  55
  56 (defun binformat (n &optional s)
  57   (unless s
  58     (setq s ""))
  59   (let ((d (/ n 2))
  60         (new-s (concat (number-to-string (mod n 2)) s)))
  61     (if (= d 0)
  62         new-s
  63       (binformat d new-s))))
  64
  65 (defun ez-list-to-string-hex (l)
  66   (concat "("
  67           (when l
  68             (concat
  69              (format "%x" (car l))
  70              (apply 'concat (mapcar (lambda (n) (format " %x" n)) (cdr l)))))
  71           ")"))
  72
  73 ;; Memory
  74
  75 (defvar ez-memory nil
  76   "Memory of z-machine.")
  77
  78 (defvar ez-version nil)
  79
  80 (defvar ez-start-pc nil)
  81 (defvar ez-himem-base nil)
  82 (defvar ez-dict-base nil)
  83 (defvar ez-objtab-addr nil)
  84 (defvar ez-abbrevtab-addr nil)
  85 (defvar ez-globalvartab-addr nil)
  86
  87 (defun ez-mem-ref-byte (addr)
  88   (aref ez-memory addr))
  89
  90 (defun ez-mem-set-byte (addr val)
  91   (aset ez-memory addr val))
  92
  93 (defun ez-mem-ref-word (addr)
  94   (+ (* 256 (aref ez-memory addr))
  95      (aref ez-memory (+ addr 1))))
  96
  97 (defun ez-mem-set-word (addr val)
  98   (let ((byte-high (/ val 256))
  99         (byte-low (mod val 256)))
 100     (aset ez-memory addr byte-high)
 101     (aset ez-memory (+ addr 1) byte-low)))
 102
 103 (defun ez-parse-header ()
 104   (setq ez-version (ez-mem-ref-byte #x0))
 105   (setq ez-himem-addr (ez-mem-ref-word #x4))
 106   (setq ez-start-pc (ez-mem-ref-word #x6))
 107   (setq ez-dict-base (ez-mem-ref-word #x8))
 108   (setq ez-objtab-addr (ez-mem-ref-word #xA))
 109   (setq ez-globalvartab-addr (ez-mem-ref-word #xC))
 110   (setq ez-abbrevtab-addr (ez-mem-ref-word #x18)))
 111
 112 (defun ez-load-file (filename)
 113   "Load story file into memory."
 114   (with-temp-buffer
 115     (insert-file-contents-literally filename)
 116     (setq ez-memory (encode-coding-string (buffer-string) 'raw-text)))
 117   'done)
 118
 119 ;; Global variables
 120
 121 (defun ez-get-global-var (gvar)
 122   (if (> gvar 239)
 123       (error "Invalid global variable %d" gvar))
 124   (let ((val
 125          (ez-mem-ref-word (+ (* 2 gvar) ez-globalvartab-addr))))
 126     (message "\tRetrieved %x from global variable %x" val gvar)
 127     val))
 128
 129 (defun ez-set-global-var (gvar val)
 130   (ez-mem-set-word (+ (* 2 gvar) ez-globalvartab-addr) val)
 131   (message "\tSet global variabl %x to %x" gvar val))
 132
 133 ;; Object tree
 134
 135 (defvar ez-property-defaults nil)
 136
 137 (defun ez-load-property-defaults ()
 138   (setq ez-property-defaults (make-vector 31 0))
 139   (dotimes (i 31)
 140     (aset ez-property-defaults i (aref ez-memory (+ ez-objtab-addr (* 2 i))))))
 141
 142 (defun ez-get-obj-addr (obj)
 143   (+ ez-objtab-addr (* 2 31) (* 9 (- obj 1))))
 144
 145 (defun ez-get-obj-parent (obj)
 146   (let ((addr (ez-get-obj-addr obj)))
 147     (ez-mem-ref-byte (+ addr 4))))
 148
 149 (defun ez-set-obj-parent (obj new-parent)
 150   (let ((addr (ez-get-obj-addr obj)))
 151     (ez-mem-set-byte (+ addr 4) new-parent)))
 152
 153 (defun ez-get-obj-sibling (obj)
 154   (let ((addr (ez-get-obj-addr obj)))
 155     (ez-mem-ref-byte (+ addr 5))))
 156
 157 (defun ez-set-obj-sibling (obj new-sibling)
 158   (let ((addr (ez-get-obj-addr obj)))
 159     (ez-mem-set-byte (+ addr 5) new-sibling)))
 160
 161 (defun ez-get-obj-child (obj)
 162   (let ((addr (ez-get-obj-addr obj)))
 163     (ez-mem-ref-byte (+ addr 6))))
 164
 165 (defun ez-set-obj-child (obj new-child)
 166   (let ((addr (ez-get-obj-addr obj)))
 167     (ez-mem-set-byte (+ addr 6) new-child)))
 168
 169 (defun ez-get-obj-plist-addr (obj)
 170   (let ((addr (ez-get-obj-addr obj)))
 171     (ez-mem-ref-word (+ addr 7))))
 172
 173 (defun ez-get-obj-name (obj)
 174   (let ((plist-addr (ez-get-obj-plist-addr obj)))
 175     (if (> (ez-mem-ref-byte plist-addr) 0)
 176         (ez-get-zstring (+ 1 (ez-get-obj-plist-addr obj)))
 177       nil)))
 178
 179 (defun ez-get-prop-default (prop)
 180   (ez-mem-ref-word (+ ez-objtab-addr (* 2 (+ 1 prop)))))
 181
 182 (defun ez-get-prop-len (prop-size-byte)
 183   (lsh prop-size-byte -5))
 184
 185 (defun ez-get-prop-num (prop-size-byte)
 186   (logand #b00011111 prop-size-byte))
 187
 188 (defun ez-get-obj-prop-addr (obj prop)
 189   (let* ((plist-addr (ez-get-obj-plist-addr obj))
 190          (prop-addr (+ plist-addr 1 (* 2 (ez-mem-ref-byte plist-addr))))
 191          (size-byte (ez-mem-ref-byte prop-addr)))
 192     (while (not (or (= size-byte 0)
 193                     (= prop (ez-get-prop-num size-byte))))
 194       (setq prop-addr (+ prop-addr (ez-get-prop-len size-byte) 2)
 195             size-byte (ez-mem-ref-byte prop-addr)))
 196     prop-addr))
 197
 198 (defun ez-get-obj-prop (obj prop)
 199   (let* ((prop-addr (ez-get-obj-prop-addr obj prop))
 200          (size-byte (ez-mem-ref-byte prop-addr)))
 201     (if (= size-byte 0)
 202         (ez-get-prop-default prop)
 203       (let ((prop-len (ez-get-prop-len size-byte))
 204             (data-addr (+ prop-addr 1)))
 205         (cond
 206          ((= prop-len 0)
 207           (ez-mem-ref-byte data-addr))
 208          ((>= prop-len 1)
 209           (ez-mem-ref-word data-addr)))))))
 210
 211 (defun ez-set-obj-prop (obj prop value)
 212   (let* ((prop-addr (ez-get-obj-prop-addr obj prop))
 213          (size-byte (ez-mem-ref-byte prop-addr)))
 214     (cond
 215      ((= size-byte 0)
 216       (error "Tried to set non-existant property"))
 217      ((= (ez-get-prop-len size-byte) 1)
 218       (ez-mem-set-byte (+ prop-addr 1) value))
 219      (t
 220       (ez-mem-set-word (+ prop-addr 1) value)))))
 221
 222 (defun ez-get-obj-attr (obj attr)
 223   (let* ((byte-num (/ attr 8))
 224          (bit-num (mod attr 8))
 225          (bit-mask (lsh 1 (- 7 bit-num))))
 226     (if (> (logand bit-mask (ez-mem-ref-byte (+ (ez-get-obj-addr obj) byte-num))) 0)
 227         1
 228       0)))
 229
 230 (defun ez-set-obj-attr (obj attr val)
 231   (let* ((byte-num (/ attr 8))
 232          (bit-num (mod attr 8))
 233          (bit-mask (lsh 1 (- 7 bit-num)))
 234          (byte-addr (+ (ez-get-obj-addr obj) byte-num))
 235          (byte (ez-mem-ref-byte byte-addr))
 236          (current-set (> (logand bit-mask byte) 0)))
 237     (if (or (and current-set (= val 0))
 238             (and (not current-set) (> val 0)))
 239         (ez-mem-set-byte byte-addr (logxor byte bit-mask)))))
 240
 241
 242 (defun ez-remove-obj (obj)
 243   (let ((parent (ez-get-obj-parent obj))
 244         (sibling (ez-get-obj-sibling obj)))
 245     (unless (= parent 0)
 246       (let ((child (ez-get-obj-child parent)))
 247         (if (= child obj)
 248             (ez-set-obj-child parent sibling)
 249           (while (not (= obj (ez-get-obj-sibling child)))
 250             (setq child (ez-get-obj-sibling child)))
 251           (ez-set-obj-sibling child (ez-get-obj-sibling obj))))
 252       (ez-set-obj-parent obj 0))
 253     (ez-set-obj-sibling obj 0)))
 254
 255 (defun ez-insert-obj (obj new-parent)
 256   (ez-remove-obj obj)
 257   (unless (= new-parent 0)
 258     (ez-set-obj-sibling obj (ez-get-obj-child new-parent))
 259     (ez-set-obj-child new-parent obj)))
 260
 261 ;; Z-strings
 262
 263 (defvar ez-zstring-alphabets
 264   ;                1    1    2    2    3
 265   ;      0    5    0    5    0    5    0
 266   (list "      abcdefghijklmnopqrstuvwxyz"
 267         "      ABCDEFGHIJKLMNOPQRSTUVWXYZ"
 268         "       \n0123456789.,!?_#'\"/\\-:()")
 269   "Alphabets used by V3")
 270
 271 (defun ez-parse-zstring-word (word)
 272   (list (lsh word -15)
 273         (logand (lsh word -10) #b11111)
 274         (logand (lsh word -5) #b11111)
 275         (logand word #b11111)))
 276
 277 (defun ez-get-zstring-chars-and-length (base-addr)
 278   (let ((addr base-addr)
 279         (chars nil)
 280         (not-done t)
 281         (word-count 0))
 282     (while not-done
 283       (let ((components (ez-parse-zstring-word (ez-mem-ref-word addr))))
 284         (setq chars (append chars (cdr components)))
 285         (setq addr (+ addr 2))
 286         (setq word-count (+ word-count 1))
 287         (when (= (car components) 1)
 288           (setq not-done nil))))
 289     (cons word-count chars)))
 290
 291 (defun ez-get-zstring-and-length (base-addr)
 292   (let* ((word-count-and-chars (ez-get-zstring-chars-and-length base-addr))
 293          (word-count (car word-count-and-chars))
 294          (chars (cdr word-count-and-chars))
 295          (cur 0)
 296          (lock 0)
 297          (abbrev-char nil)
 298          (s ""))
 299     (dolist (char chars)
 300       (cond
 301        (abbrev-char
 302         (let ((abbrev-addr
 303                (* 2 (ez-mem-ref-word (+ ez-abbrevtab-addr
 304                                         (* 2 (+ (* (- abbrev-char 1) 32) char)))))))
 305           (setq s (concat s (cdr (ez-get-zstring-and-length abbrev-addr)))))
 306         (setq abbrev-char nil))
 307        ((memq char '(1 2 3)) ;Abbreviation
 308         (setq abbrev-char char))
 309        ((= char 4)
 310         (setq cur (mod (+ cur 1) 3)))
 311        ((= char 5)
 312         (setq cur (mod (+ 3 (- cur 1)) 3)))
 313        (t
 314         (setq s (concat s (substring (elt ez-zstring-alphabets cur)
 315                                      char (+ char 1))))
 316         (setq cur lock))))
 317     (cons word-count s)))
 318
 319 (defun ez-get-zstring (base-addr)
 320   (cdr (ez-get-zstring-and-length base-addr)))
 321
 322 ;; Call stack
 323
 324 (defvar ez-call-stack nil)
 325
 326 (defun ez-make-call-stack-frame (pc &optional call-method)
 327   (list pc
 328         nil
 329         (make-vector 15 0)
 330         call-method))
 331
 332 (defun ez-add-call-stack-frame (pc &optional call-method)
 333   (push (ez-make-call-stack-frame pc call-method) ez-call-stack))
 334
 335 (defun ez-pop-call-stack-frame ()
 336   (pop ez-call-stack))
 337
 338 (defun ez-routine-stack ()
 339   (elt (car ez-call-stack) 1))
 340
 341 (defun ez-routine-stack-push (val)
 342   (let ((frame (car ez-call-stack)))
 343     (message "\tPushed %x to stack" val)
 344     (setf (elt frame 1) (cons val (elt frame 1)))))
 345
 346 (defun ez-routine-stack-pop ()
 347   (let* ((frame (car ez-call-stack))
 348          (rs-head (car (elt frame 1))))
 349     (setf (elt frame 1) (cdr (elt frame 1)))
 350     (message "\tPopped %x from stack" rs-head)
 351     rs-head))
 352
 353 (defun ez-get-local-var (lvar)
 354   (let* ((frame (car ez-call-stack))
 355          (val (aref (elt frame 2) (- lvar 1))))
 356     (message "\tRetrieved value %x from local variable %x" val lvar)
 357     val))
 358
 359 (defun ez-set-local-var (lvar val)
 360   (let ((frame (car ez-call-stack)))
 361     (message "\tSet local variable %x to %x" lvar val)
 362     (aset (elt frame 2) (- lvar 1) val)))
 363
 364 (defun ez-get-pc ()
 365   (caar ez-call-stack))
 366
 367 (defun ez-set-pc (new-pc)
 368   (setf (car (car ez-call-stack)) new-pc))
 369
 370 (defun ez-increment-pc (inc)
 371   (ez-set-pc (+ (ez-get-pc) inc)))
 372
 373 (defun ez-read-pc-byte-and-inc ()
 374   (let ((res (ez-mem-ref-byte (ez-get-pc))))
 375     (ez-increment-pc 1)
 376     res))
 377
 378 (defun ez-read-pc-word-and-inc ()
 379   (let ((res (ez-mem-ref-word (ez-get-pc))))
 380     (ez-increment-pc 2)
 381     res))
 382
 383 ;; Instruction execution
 384
 385 (defun ez-get-var (var)
 386   (cond
 387    ((= var 0)
 388     (ez-routine-stack-pop))
 389    ((< var 16)
 390     (ez-get-local-var var))
 391    (t
 392     (ez-get-global-var (- var 16)))))
 393
 394 (defun ez-set-var (var val)
 395   (cond
 396    ((= var 0)
 397     (ez-routine-stack-push val))
 398    ((< var 16)
 399     (ez-set-local-var var val))
 400    (t
 401     (ez-set-global-var (- var 16) val))))
 402
 403 (defun ez-read-pc-var-and-inc ()
 404   (ez-get-var (ez-read-pc-byte-and-inc)))
 405
 406 (defun ez-execute-instr ()
 407   (let ((instr-pc (ez-get-pc))
 408         (opbyte (ez-read-pc-byte-and-inc))
 409         (optype) (opcode) (operands))
 410     (cond
 411      ((<= #x0 opbyte #x1f)
 412       (setq optype '2op
 413             opcode opbyte
 414             operands (list (ez-read-pc-byte-and-inc)
 415                            (ez-read-pc-byte-and-inc))
 416             operand-types '(b b)))
 417      ((<= #x20 opbyte #x3F)
 418       (setq optype '2op
 419             opcode (- opbyte #x20)
 420             operands (list (ez-read-pc-byte-and-inc)
 421                            (ez-read-pc-var-and-inc))
 422             operand-types '(b w)))
 423      ((<= #x40 opbyte #x5F)
 424       (setq optype '2op
 425             opcode (- opbyte #x40)
 426             operands (list (ez-read-pc-var-and-inc)
 427                            (ez-read-pc-byte-and-inc))
 428             operand-types '(w b)))
 429      ((<= #x60 opbyte #x7F)
 430       (setq optype '2op
 431             opcode (- opbyte #x60)
 432             operands (list (ez-read-pc-var-and-inc)
 433                            (ez-read-pc-var-and-inc))
 434             operand-types '(w w)))
 435      ((<= #x80 opbyte #x8F)
 436       (setq optype '1op
 437             opcode (- opbyte #x80)
 438             operands (list (ez-read-pc-word-and-inc))
 439             operand-types '(w)))
 440      ((<= #x90 opbyte #x9F)
 441       (setq optype '1op
 442             opcode (- opbyte #x90)
 443             operands (list (ez-read-pc-byte-and-inc))
 444             operand-types '(b)))
 445      ((<= #xA0 opbyte #xAF)
 446       (setq optype '1op
 447             opcode (- opbyte #xa0)
 448             operands (list (ez-read-pc-var-and-inc))
 449             operand-types '(w)))
 450      ((<= #xB0 opbyte #xBF)
 451       (setq optype '0op
 452             opcode (- opbyte #xb0)
 453             operands '()
 454             operand-types '()))
 455      ((<= #xC0 opbyte #xDF)
 456       (setq optype '2op
 457             opcode (- opbyte #xc0))
 458       (let ((operands-and-types (ez-read-var-operands-and-inc)))
 459         (setq operands (car operands-and-types)
 460               operand-types (cdr operands-and-types))))
 461      ((<= #xE0 opbyte #xFF)
 462       (setq optype 'var
 463             opcode (- opbyte #xe0))
 464       (let ((operands-and-types (ez-read-var-operands-and-inc)))
 465         (setq operands (car operands-and-types)
 466               operand-types (cdr operands-and-types)))))
 467     (let ((table-row (assoc (list optype opcode) ez-op-table)))
 468       (unless table-row
 469         (error "Unsupported op PC:%x Optype:%s Opcode:%x Operands:%s Operand-types:%s"
 470                instr-pc optype opcode (ez-list-to-string-hex operands) operand-types))
 471       (let ((mnemonic (elt table-row 1)))
 472         (message "PC:%x Optype:%s Opcode:%x Mnemonic:%s Operands:%s Operand-types:%s"
 473                  instr-pc optype opcode mnemonic
 474                  (ez-list-to-string-hex operands) operand-types))
 475       (funcall (elt table-row 2) operands operand-types))))
 476
 477 (defun ez-read-var-operands-and-inc ()
 478   (let* ((type-byte (ez-read-pc-byte-and-inc))
 479          (types (let ((type1 (lsh type-byte -6)))
 480                   (if (= type1 #b11)
 481                       nil
 482                     (cons type1
 483                           (let ((type2 (mod (lsh type-byte -4) 4)))
 484                             (if (= type2 #b11)
 485                                 nil
 486                               (cons type2
 487                                     (let ((type3 (mod (lsh type-byte -2) 4)))
 488                                       (if (= type3 #b11)
 489                                           nil
 490                                         (cons type3
 491                                               (let ((type4 (mod type-byte 4)))
 492                                                 (if (= type4 #b11)
 493                                                     nil
 494                                                   (list type4))))))))))))))
 495     (cons
 496      (mapcar
 497       (lambda (type)
 498         (cond
 499          ((= type 0) (ez-read-pc-word-and-inc))
 500          ((= type 1) (ez-read-pc-byte-and-inc))
 501          ((= type 2) (ez-read-pc-var-and-inc))))
 502       types)
 503      (mapcar
 504       (lambda (type)
 505         (if (= type 1)
 506             'b
 507           'w))
 508       types))))
 509
 510 ;; Branches
 511
 512 (defun ez-do-branch (branch)
 513   (let* ((branch-byte (ez-read-pc-byte-and-inc))
 514          (invert (= 0 (logand branch-byte #b10000000)))
 515          (single-byte (> (logand branch-byte #b01000000) 0))
 516          (offset
 517           (if single-byte
 518               (logand branch-byte #b00111111)
 519             (let ((pos (= (logand branch-byte #b00100000) 0))
 520                   (val (+ (* 256 (logand branch-byte #b00011111))
 521                           (ez-read-pc-byte-and-inc))))
 522               (if pos
 523                   val
 524                 (- val 8192))))))
 525     (if (or (and branch (not invert))
 526             (and (not branch) invert))
 527         (cond
 528          ((= offset 0)
 529           (ez-op-rfalse))
 530          ((= offset 1)
 531           (ez-op-rtrue))
 532          (t
 533           (ez-set-pc (+ (ez-get-pc) offset -2)))))))
 534
 535 ;; Operations
 536
 537 (defvar ez-op-table
 538   '(((0op #x00) rtrue ez-op-rtrue)
 539     ((0op #x01) rfalse ez-op-rfalse)
 540     ((1op #x00) jz ez-op-jz)
 541     ((1op #x05) inc ez-op-inc)
 542     ((1op #x06) dec ez-op-dec)
 543     ((1op #x0B) ret ez-op-ret)
 544     ((0op #x08) ret_pulled ez-op-ret-pulled)
 545     ((1op #x0C) jump ez-op-jump)
 546     ((2op #x05) inc_jg ez-op-inc-jg)
 547     ((2op #x04) dec_jg ez-op-dec-jg)
 548     ((2op #x0D) store ez-op-store)
 549     ((1op #x0E) load ez-op-load)
 550     ((var #x01) storew ez-op-storew)
 551     ((2op #x0F) loadw ez-op-loadw)
 552     ((var #x02) storeb ez-op-storeb)
 553     ((2op #x10) loadb ez-op-loadb)
 554     ((2op #x01) je ez-op-je)
 555     ((2op #x02) jl ez-op-jl)
 556     ((2op #x03) jg ez-op-jg)
 557     ((2op #x06) jin ez-op-jin)
 558     ((2op #x07) test ez-op-test)
 559     ((2op #x08) or ez-op-or)
 560     ((2op #x09) and ez-op-and)
 561     ((2op #x14) add ez-op-add)
 562     ((2op #x15) sub ez-op-sub)
 563     ((2op #x16) mul ez-op-mul)
 564     ((2op #x17) div ez-op-div)
 565     ((2op #x18) mod ez-op-mod)
 566     ((var #x00) call_fv ez-op-callfv)
 567     ((1op #x01) get_sibling ez-op-get-sibling)
 568     ((1op #x02) get_child ez-op-get-child)
 569     ((1op #x03) get_parent ez-op-get-parent)
 570     ((2op #x0A) test_attr ez-op-test-attr)
 571     ((2op #x0B) set_attr ez-op-set-attr)
 572     ((2op #x0C) clear_attr ez-op-clear-attr)
 573     ((1op #x09) remove_obj ez-op-remove-obj)
 574     ((2op #x0E) insert_obj ez-op-insert-obj)
 575     ((var #x03) put_prop ez-op-put-prop)
 576     ((2op #x11) get_prop ez-op-get-prop)
 577     ((0op #x02) print ez-op-print)
 578     ((0op #x0B) new_line ez-op-new-line)
 579     ((var #x06) print_num ez-op-print-num)
 580     ((var #x05) print_char ez-op-print-char)
 581     ((1op #x0A) print_obj ez-op-print-obj)
 582     ((var #x04) read ez-op-read)))
 583
 584 (defun ez-op-ret (operands &optional operand-types)
 585   (let ((retval (car operands)))
 586     (message "\tReturning value %x" retval)
 587     (ez-pop-call-stack-frame)
 588     (ez-set-var (ez-read-pc-byte-and-inc) retval))
 589   'run)
 590
 591 (defun ez-op-ret-pulled (operands operand-types)
 592   (let ((retval (ez-routine-stack-pop)))
 593     (message "\tReturning value %x" retval)
 594     (ez-op-ret (list retval)))
 595   'run)
 596
 597 (defun ez-op-rtrue (&optional operands operand-types)
 598   (ez-op-ret (list 1))
 599   'run)
 600
 601 (defun ez-op-rfalse (&optional operands operand-types)
 602   (ez-op-ret (list 0))
 603   'run)
 604
 605 (defun ez-op-jz (operands operand-types)
 606   (ez-do-branch (= (car operands) 0))
 607   'run)
 608
 609 (defun ez-op-je (operands operand-types)
 610   (ez-do-branch (memq (car operands) (cdr operands)))
 611   'run)
 612
 613 (defun ez-op-jg (operands operand-types)
 614   (let ((s1 (ez-decode-signed-operand (car operands) (car operand-types)))
 615         (s2 (ez-decode-signed-operand (cadr operands) (cadr operand-types))))
 616     (ez-do-branch (> s1 s2)))
 617   'run)
 618
 619 (defun ez-op-jl (operands operand-types)
 620   (let ((s1 (ez-decode-signed-operand (car operands) (car operand-types)))
 621         (s2 (ez-decode-signed-operand (cadr operands) (cadr operand-types))))
 622     (ez-do-branch (< s1 s2)))
 623   'run)
 624
 625 (defun ez-op-inc-jg (operands operand-types)
 626   (let ((var (car operands)))
 627     (ez-op-inc (list var))
 628     (ez-op-jg (cons (ez-get-var var) (cdr operands)) (cons 'w (cdr operand-types))))
 629   'run)
 630
 631 (defun ez-op-dec-jl (operands operand-types)
 632   (let ((var (car operands)))
 633     (ez-op-dec (list var))
 634     (ez-op-jl (cons (ez-get-var var) (cdr operands)) (cons 'w (cdr operand-types))))
 635   'run)
 636
 637 (defun ez-op-jin (operands operand-types)
 638   (let ((obj (car operands))
 639         (n (cadr operands)))
 640     (ez-do-branch (or (= n 0)
 641                       (= n (ez-get-obj-parent obj)))))
 642   'run)
 643
 644 (defun ez-op-test (operands operand-types)
 645   (let ((a (car operands))
 646         (b (cadr operands)))
 647     (ez-do-branch (= (logand a b) b)))
 648   'run)
 649
 650 (defun ez-op-jump (operands operand-types)
 651   (let ((offset (if (eq (car operand-types) 'b)
 652                     (ez-decode-signed-byte (car operands))
 653                   (ez-decode-signed-word (car operands)))))
 654     (ez-set-pc (+ (ez-get-pc) offset -2)))
 655   'run)
 656
 657 (defun ez-op-inc (operands &optional operand-types)
 658   (let ((var (car operands)))
 659     (ez-set-var var (mod (+ 1 (ez-get-var var)) #x10000)))
 660   'run)
 661
 662 (defun ez-op-dec (operands &optional operand-types)
 663   (let ((var (car operands)))
 664     (ez-set-var var (mod (+ (ez-get-var var) 1) #x10000)))
 665   'run)
 666
 667 (defun ez-op-store (operands operand-types)
 668   (let ((var (car operands))
 669         (a (cadr operands)))
 670     (ez-set-var var a))
 671   'run)
 672
 673 (defun ez-op-load (operands operand-types)
 674   (let ((var (car operands)))
 675     (ez-set-var (ez-read-pc-byte-and-inc) (ez-get-var var)))
 676   'run)
 677
 678 (defun ez-op-storew (operands operand-types)
 679   (let ((baddr (car operands))
 680         (n (cadr operands))
 681         (a (caddr operands)))
 682     (ez-mem-set-word (+ baddr (* 2 n)) a))
 683   'run)
 684
 685 (defun ez-op-loadw (operands operand-types)
 686   (let ((baddr (car operands))
 687         (n (cadr operands)))
 688     (ez-set-var (ez-read-pc-byte-and-inc) (ez-mem-ref-word (+ baddr (* 2 n)))))
 689   'run)
 690
 691 (defun ez-op-storeb (operands operand-types)
 692   (let ((baddr (car operands))
 693         (n (cadr operands))
 694         (a (caddr operands)))
 695     (ez-mem-set-byte (+ baddr n) a))
 696   'run)
 697
 698 (defun ez-op-loadb (operands operand-types)
 699   (let ((baddr (car operands))
 700         (n (cadr operands)))
 701     (ez-set-var (ez-read-pc-byte-and-inc) (ez-mem-ref-byte (+ baddr n))))
 702   'run)
 703
 704 (defun ez-op-and (operands operand-types)
 705   (let ((a (car operands))
 706         (b (cadr operands)))
 707     (ez-set-var (ez-read-pc-byte-and-inc) (logand a b)))
 708   'run)
 709
 710 (defun ez-op-or (operands operand-types)
 711   (let ((a (car operands))
 712         (b (cadr operands)))
 713     (ez-set-var (ez-read-pc-byte-and-inc) (logior a b)))
 714   'run)
 715
 716 (defun ez-op-add (operands operand-types)
 717   (let ((a (car operands))
 718         (b (cadr operands)))
 719     (ez-set-var (ez-read-pc-byte-and-inc) (mod (+ a b) #x10000)))
 720   'run)
 721
 722 (defun ez-op-sub (operands operand-types)
 723   (let ((a (car operands))
 724         (b (cadr operands)))
 725     (ez-set-var (ez-read-pc-byte-and-inc) (mod (+ (- a b) #x10000) #x10000)))
 726   'run)
 727
 728 (defun ez-op-mul (a b)
 729   (let ((a (car operands))
 730         (b (cadr operands)))
 731     (ez-set-var (ez-read-pc-byte-and-inc) (mod (* a b) #x10000)))
 732   'run)
 733
 734 (defun ez-op-div (a b)
 735   (error "Not implemented"))
 736
 737 (defun ez-op-mod (a b)
 738   (error "Not implemented"))
 739
 740 (defun ez-op-callfv (operands operand-types)
 741   (let* ((raddr (car operands))
 742          (call-operands (cdr operands))
 743          (r (* 2 raddr))
 744          (L (ez-mem-ref-byte r))
 745          (n (length call-operands))
 746          (new-pc (+ r 1 (* L 2))))
 747     (if (= raddr 0)
 748         (ez-set-var (ez-read-pc-byte-and-inc) 0) ; Simply return 0
 749       (ez-add-call-stack-frame new-pc)
 750       (dotimes (i L)
 751         (if (< i n)
 752             (ez-set-local-var (+ i 1) (elt call-operands i))
 753           (ez-set-local-var (+ i 1) (ez-mem-ref-word (+ r 1 (* 2 i))))))))
 754   'run)
 755
 756 (defun ez-op-test-attr (operands operand-types)
 757   (let ((obj (car operands))
 758         (attr (cadr operands)))
 759     (ez-do-branch (= 1 (ez-get-obj-attr obj attr)))
 760     'run))
 761
 762 (defun ez-op-set-attr (operands operand-types)
 763   (let ((obj (car operands))
 764         (attr (cadr operands)))
 765     (ez-set-obj-attr obj attr 1))
 766   'run)
 767
 768 (defun ez-op-clear-attr (operands operand-types)
 769   (let ((obj (car operands))
 770         (attr (cadr operands)))
 771     (ez-set-obj-attr obj attr 0))
 772   'run)
 773
 774 (defun ez-op-get-sibling (operands operand-types)
 775   (let ((sib (ez-get-obj-sibling (car operands))))
 776     (ez-set-var (ez-read-pc-byte-and-inc) sib)
 777     (ez-do-branch (> sib 0)))
 778   'run)
 779
 780 (defun ez-op-get-child (operands operand-types)
 781   (let ((child (ez-get-obj-child (car operands))))
 782     (ez-set-var (ez-read-pc-byte-and-inc) child)
 783     (ez-do-branch (> child 0)))
 784   'run)
 785
 786 (defun ez-op-get-parent (operands operand-types)
 787   (let ((parent (ez-get-obj-parent (car operands))))
 788     (ez-set-var (ez-read-pc-byte-and-inc) parent))
 789   'run)
 790
 791 (defun ez-op-remove-obj (operands operand-types)
 792   (let ((obj (car operands)))
 793     (ez-remove-obj obj))
 794   'run)
 795
 796 (defun ez-op-insert-obj (operands operand-types)
 797   (let ((obj1 (car operands))
 798         (obj2 (cadr operands)))
 799     (ez-insert-obj obj1 obj2))
 800   'run)
 801
 802 (defun ez-op-put-prop (operands operand-types)
 803   (let* ((obj (car operands))
 804          (prop (cadr operands))
 805          (a (caddr operands)))
 806     (ez-set-obj-prop obj prop a))
 807   'run)
 808
 809 (defun ez-op-get-prop (operands operand-types)
 810   (let* ((obj (car operands))
 811          (prop (cadr operands)))
 812     (ez-set-var (ez-read-pc-byte-and-inc)
 813                 (ez-get-obj-prop obj prop)))
 814   'run)
 815
 816 (defun ez-op-print (operands operand-types)
 817   (let* ((word-count-and-string (ez-get-zstring-and-length (ez-get-pc)))
 818          (word-count (car word-count-and-string))
 819          (string (cdr word-count-and-string)))
 820     (ez-print string)
 821     (ez-increment-pc (* 2 word-count)))
 822   'run)
 823
 824 (defun ez-op-new-line (operands operand-types)
 825   (ez-print "\n")
 826   'run)
 827
 828 (defun ez-op-print-num (operands operand-types)
 829   (let ((s (ez-decode-signed-operand (car operands) (car operand-types))))
 830     (ez-print (number-to-string s)))
 831   'run)
 832
 833 (defun ez-op-print-char (operands operand-types)
 834   (let ((c (car operands)))
 835     (ez-print (string c)))
 836   'run)
 837
 838 (defun ez-op-print-obj (operands operand-types)
 839   (let ((obj (car operands)))
 840     (ez-print (ez-get-obj-name obj)))
 841   'run)
 842
 843 (defun ez-op-read (operands operand-types)
 844   (let ((baddr1 (car operands))
 845         (baddr2 (cadr operands)))
 846     )
 847   'wait-for-input)
 848
 849 ;; Execution loop
 850
 851 (defun ez-load-and-run (filename)
 852   (ez-load-file filename)
 853   (ez-parse-header)
 854   (setq ez-call-stack (list (ez-make-call-stack-frame ez-start-pc)))
 855
 856   (ez-run))
 857
 858 (defvar ez-machine-state nil
 859   "Identifies the current executation state of the Z-machine.")
 860
 861 (defun ez-run ()
 862   (setq ez-machine-state 'run)
 863   (while (eq ez-machine-state 'run)
 864     (setq ez-machine-state (ez-execute-instr))))
 865
 866 ;;; Buffer and I/O
 867 ;;
 868
 869 (defvar ez-input-marker nil
 870   "Marker for input position in buffer.")
 871
 872 (defun ez-setup-buffer ()
 873   (with-current-buffer (get-buffer-create "*ez*")
 874     (let ((inhibit-read-only t))
 875       (delete-region (point-min) (point-max)))
 876     (setq-local scroll-conservatively 1)
 877     (if (markerp ez-input-marker)
 878         (set-marker ez-input-marker (point-max))
 879       (setq ez-input-marker (point-max-marker)))
 880     (goto-char (point-max))))
 881
 882
 883 (defun ez-print (string)
 884   (with-current-buffer "*ez*"
 885     (save-excursion
 886       (goto-char ez-input-marker)
 887       (insert-before-markers string))))
 888
 889 (defun ez-enter ()
 890   (interactive)
 891   (with-current-buffer "*ez*"
 892     (buffer-substring ez-input-marker (point-max))))
 893
 894 ;; Mode
 895
 896 (defvar ez-mode-map
 897   (let ((map (make-sparse-keymap)))
 898     (define-key map (kbd "RET") 'ez-enter)
 899     map))
 900
 901 (define-derived-mode ez-mode text-mode "ez"
 902   "Major mode for EZ.")
 903
 904 (when (fboundp 'evil-set-initial-state)
 905   (evil-set-initial-state 'ez-mode 'insert))
 906
 907 (defun ez (zfile)
 908   (interactive "fEnter name of z3 story file: ")
 909   (if (get-buffer "*ez*")
 910       (switch-to-buffer "*ez*")
 911     (switch-to-buffer "*ez*")
 912     (ez-mode)
 913     (ez-setup-buffer)
 914     (ez-load-and-run zfile))
 915   "Started EZ.")
 916
 917 (defun ez-debug ()
 918   (interactive)
 919   (switch-to-buffer "*ez*")
 920   (ez-mode)
 921   (ez-setup-buffer)
 922   (ez-load-and-run "zork1.z3"))
 923
 924 ;;; ez.el ends here