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