jak-project/goal_src/jak2/engine/debug/editable-h.gc
ManDude cd68cb671e
deftype and defmethod syntax major changes (#3094)
Major change to how `deftype` shows up in our code:
- the decompiler will no longer emit the `offset-assert`,
`method-count-assert`, `size-assert` and `flag-assert` parameters. There
are extremely few cases where having this in the decompiled code is
helpful, as the types there come from `all-types` which already has
those parameters. This also doesn't break type consistency because:
  - the asserts aren't compared.
- the first step of the test uses `all-types`, which has the asserts,
which will throw an error if they're bad.
- the decompiler won't emit the `heap-base` parameter unless necessary
now.
- the decompiler will try its hardest to turn a fixed-offset field into
an `overlay-at` field. It falls back to the old offset if all else
fails.
- `overlay-at` now supports field "dereferencing" to specify the offset
that's within a field that's a structure, e.g.:
```lisp
(deftype foobar (structure)
  ((vec    vector  :inline)
   (flags  int32   :overlay-at (-> vec w))
   )
  )
```
in this structure, the offset of `flags` will be 12 because that is the
final offset of `vec`'s `w` field within this structure.
- **removed ID from all method declarations.** IDs are only ever
automatically assigned now. Fixes #3068.
- added an `:overlay` parameter to method declarations, in order to
declare a new method that goes on top of a previously-defined method.
Syntax is `:overlay <method-name>`. Please do not ever use this.
- added `state-methods` list parameter. This lets you quickly specify a
list of states to be put in the method table. Same syntax as the
`states` list parameter. The decompiler will try to put as many states
in this as it can without messing with the method ID order.

Also changes `defmethod` to make the first type definition (before the
arguments) optional. The type can now be inferred from the first
argument. Fixes #3093.

---------

Co-authored-by: Hat Kid <6624576+Hat-Kid@users.noreply.github.com>
2023-10-30 03:20:02 +00:00

712 lines
19 KiB
Common Lisp

;;-*-Lisp-*-
(in-package goal)
;; name: editable-h.gc
;; name in dgo: editable-h
;; dgos: ENGINE, GAME
;; +++editable-filter
(defenum editable-filter
:type uint32
:bitfield #t
(none 0)
(unknown 1)
(sound 2)
(part 3)
(user-setting 4)
(cam-setting 5)
(load 6)
(water-command 7)
(camera 8)
(target 9)
(water 10)
(data 11)
(city_vis 12)
(sample 13)
(light 14)
(entity 15)
(selected 16)
)
;; ---editable-filter
;; +++editable-flag
(defenum editable-flag
:type uint32
:bitfield #t
(selected)
(no-save)
(orient)
(x)
(y)
(z)
(no-plane-snap)
(no-update)
(mark)
(top-set)
(bot-set)
(changed)
)
;; ---editable-flag
;; +++editable-command
(defenum editable-command
:type uint32
:bitfield #f
(none 0)
(exit 1)
(kill 2)
(select-one 3)
(select-toggle 4)
(select-all 5)
(select-none 6)
(select-region 7)
(select-face 8)
(select-prim 9)
(select-current-owner 10)
(select-current-region 11)
(select-current-face 12)
(select-current-prim 13)
(pick-target 14)
(pick-loc 15)
(pick-yes-no 16)
(cancel 17)
(drag-move-xy 18)
(drag-move-xz 19)
(drag-move-x 20)
(drag-move-y 21)
(drag-move-z 22)
(drag-resize 23)
(camera-tumble 24)
(camera-xy 25)
(camera-xz 26)
(insert-sphere 27)
(insert-point 28)
(insert-sample 29)
(insert-sample-camera 30)
(insert-light 31)
(insert-entity 32)
(insert-face 33)
(insert-plane 34)
(insert-box 35)
(delete 36)
(copy 37)
(resize 38)
(snap-to-ground 39)
(snap-xz 40)
(snap-y 41)
(flip-side 42)
(region-set 43)
(region-new 44)
(edit-plane-set 45)
(edit-plane-clear 46)
(delete-region 47)
(copy-region 48)
(region-add 49)
(save 50)
(load 51)
(update-game 52)
(print-region-info 53)
(refresh-filter 54)
(rotate-level 55)
(translate-y-level 56)
)
;; ---editable-command
(declare-type editable-array basic)
(declare-type editable-plane editable)
(declare-type editable-region basic)
(define-extern *editable-sample-region* editable-region)
(define-extern *editable-light-region* editable-region)
(define-extern *editable-entity-region* editable-region)
(define-extern *editable-menu-context* debug-menu-context)
;; DECOMP BEGINS
;; this file is debug only
(declare-file (debug))
(define *editable-temp-id* 0)
(defun editable-command->string ((arg0 editable-command))
(case arg0
(((editable-command insert-entity))
"insert-entity"
)
(((editable-command print-region-info))
"print-region-info"
)
(((editable-command resize))
"resize"
)
(((editable-command insert-face))
"insert-face"
)
(((editable-command select-one))
"select-one"
)
(((editable-command update-game))
"update-game"
)
(((editable-command region-set))
"region-set"
)
(((editable-command select-all))
"select-all"
)
(((editable-command region-add))
"region-add"
)
(((editable-command flip-side))
"flip-side"
)
(((editable-command drag-resize))
"drag-resize"
)
(((editable-command select-current-prim))
"select-current-prim"
)
(((editable-command edit-plane-set))
"edit-plane-set"
)
(((editable-command edit-plane-clear))
"edit-plane-clear"
)
(((editable-command kill))
"kill"
)
(((editable-command delete-region))
"delete-region"
)
(((editable-command select-region))
"select-region"
)
(((editable-command camera-tumble))
"camera-tumble"
)
(((editable-command select-current-face))
"select-current-face"
)
(((editable-command snap-xz))
"snap-xz"
)
(((editable-command insert-sample))
"insert-sample"
)
(((editable-command camera-xy))
"camera-xy"
)
(((editable-command pick-loc))
"pick-loc"
)
(((editable-command select-face))
"select-face"
)
(((editable-command rotate-level))
"rotate-level"
)
(((editable-command pick-yes-no))
"pick-yes-no"
)
(((editable-command translate-y-level))
"translate-y-level"
)
(((editable-command save))
"save"
)
(((editable-command copy-region))
"copy-region"
)
(((editable-command cancel))
"cancel"
)
(((editable-command insert-light))
"insert-light"
)
(((editable-command drag-move-z))
"drag-move-z"
)
(((editable-command exit))
"exit"
)
(((editable-command drag-move-y))
"drag-move-y"
)
(((editable-command drag-move-xy))
"drag-move-xy"
)
(((editable-command select-prim))
"select-prim"
)
(((editable-command none))
"none"
)
(((editable-command delete))
"delete"
)
(((editable-command drag-move-x))
"drag-move-x"
)
(((editable-command insert-plane))
"insert-plane"
)
(((editable-command insert-sphere))
"insert-sphere"
)
(((editable-command insert-point))
"insert-point"
)
(((editable-command select-current-region))
"select-current-region"
)
(((editable-command camera-xz))
"camera-xz"
)
(((editable-command region-new))
"region-new"
)
(((editable-command drag-move-xz))
"drag-move-xz"
)
(((editable-command load))
"load"
)
(((editable-command insert-box))
"insert-box"
)
(((editable-command snap-to-ground))
"snap-to-ground"
)
(((editable-command select-none))
"select-none"
)
(((editable-command select-toggle))
"select-toggle"
)
(((editable-command insert-sample-camera))
"insert-sample-camera"
)
(((editable-command pick-target))
"pick-target"
)
(((editable-command select-current-owner))
"select-current-owner"
)
(((editable-command refresh-filter))
"refresh-filter"
)
(((editable-command copy))
"copy"
)
(((editable-command snap-y))
"snap-y"
)
(else
"*unknown*"
)
)
)
;; WARN: Return type mismatch basic vs string.
(defun editable-filter->string ((arg0 editable-filter) (arg1 basic))
(if (= (logand arg0 (editable-filter target)) (editable-filter target))
(format arg1 "target ")
)
(if (= (logand arg0 (editable-filter city_vis)) (editable-filter city_vis))
(format arg1 "city_vis ")
)
(if (= (logand arg0 (editable-filter water-command)) (editable-filter water-command))
(format arg1 "water-command ")
)
(if (= (logand arg0 (editable-filter user-setting)) (editable-filter user-setting))
(format arg1 "user-setting ")
)
(if (= (logand arg0 (editable-filter sample)) (editable-filter sample))
(format arg1 "sample ")
)
(if (= (logand arg0 (editable-filter light)) (editable-filter light))
(format arg1 "light ")
)
(if (= (logand arg0 (editable-filter part)) (editable-filter part))
(format arg1 "part ")
)
(if (= (logand arg0 (editable-filter unknown)) (editable-filter unknown))
(format arg1 "unknown ")
)
(if (= (logand arg0 (editable-filter entity)) (editable-filter entity))
(format arg1 "entity ")
)
(if (= (logand arg0 (editable-filter data)) (editable-filter data))
(format arg1 "data ")
)
(if (= (logand arg0 (editable-filter water)) (editable-filter water))
(format arg1 "water ")
)
(if (= (logand arg0 (editable-filter cam-setting)) (editable-filter cam-setting))
(format arg1 "cam-setting ")
)
(if (= (logand (editable-filter selected) arg0) (editable-filter selected))
(format arg1 "selected ")
)
(if (= (logand arg0 (editable-filter none)) (editable-filter none))
(format arg1 "none ")
)
(if (= (logand arg0 (editable-filter camera)) (editable-filter camera))
(format arg1 "camera ")
)
(if (= (logand arg0 (editable-filter load)) (editable-filter load))
(format arg1 "load ")
)
(if (= (logand arg0 (editable-filter sound)) (editable-filter sound))
(format arg1 "sound ")
)
(the-as string arg1)
)
(deftype editable-region (basic)
((changed symbol)
(locked symbol)
(id uint64)
(filter editable-filter)
(tree symbol)
(level string)
(on-enter string)
(on-inside string)
(on-exit string)
)
(:methods
(new (symbol type) _type_)
(editable-region-method-9 (_type_ editable-array int int) symbol)
(editable-region-method-10 (_type_ int) symbol)
(editable-region-method-11 (_type_ vector int) none)
(editable-region-method-12 (_type_) editable-filter)
)
)
(deftype editable (basic)
((flags editable-flag)
(name string)
(id uint32)
(region editable-region)
(owner pair)
)
(:methods
(get-color (_type_ int) rgba)
(editable-method-10 (_type_) none)
(editable-method-11 (_type_ vector) symbol)
(select-editable! (_type_ symbol) none)
(edit-get-distance (_type_ vector) float)
(edit-get-trans (_type_) vector)
(editable-method-15 (_type_ vector int) none)
(edit-coord! (_type_ vector editable-flag) none)
(editable-method-17 (_type_ vector) none)
(editable-method-18 (_type_ vector matrix) none)
(editable-method-19 (_type_ vector) none)
(editable-method-20 (_type_ vector vector vector vector) none)
(editable-method-21 (_type_ editable-region) none)
(editable-method-22 (_type_ editable-array int int) symbol)
(editable-method-23 (_type_) symbol)
(editable-method-24 (_type_) none)
(editable-method-25 (_type_ editable-array) none)
(editable-method-26 (_type_ editable editable-array) none)
(editable-method-27 (_type_ editable-array) editable)
(editable-method-28 (_type_ editable-filter) none)
(editable-method-29 (_type_ editable-filter) symbol)
)
)
(deftype editable-array (basic)
((allocated-length int32)
(length int32)
(region editable-region)
(backup-region editable-region)
(region-lock? symbol)
(move-lock? symbol)
(move-speed float)
(selection (array editable))
(filter editable-filter 2)
(target editable)
(target-mode editable-command)
(target-command editable-command)
(target-message string)
(edit-plane editable-plane)
(edit-plane-center vector :inline)
(edit-plane-normal vector :inline)
(level-offset vector :inline)
(level-info-id uint32)
(level uint32)
(edit-param0 float)
(data editable :dynamic)
)
(:methods
(new (symbol type int) _type_)
(editable-array-method-9 (_type_ editable-command mouse-info) symbol :behavior editable-player)
(editable-array-method-10 (_type_ vector int) editable)
(editable-array-method-11 (_type_) int)
(editable-array-method-12 (_type_ editable-array) none)
(editable-array-method-13 (_type_ editable-command editable-command string) none)
(editable-array-method-14 (_type_ (function editable editable-region symbol) editable-region) (array editable))
(editable-array-method-15 (_type_ editable) none)
(editable-array-method-16 (_type_) none)
(editable-array-method-17 (_type_ vector vector) vector)
)
)
(defmethod new editable-array ((allocation symbol) (type-to-make type) (arg0 int))
(let ((s5-0 (object-new allocation type-to-make (the-as int (+ (-> type-to-make size) (* arg0 4))))))
(set! (-> s5-0 allocated-length) arg0)
(set! (-> s5-0 length) 0)
(set! (-> s5-0 region) #f)
(set! (-> s5-0 backup-region) #f)
(set! (-> s5-0 region-lock?) #f)
(set! (-> s5-0 move-lock?) #f)
(set! (-> s5-0 target) #f)
(set! (-> s5-0 target-command) (editable-command none))
(set! (-> s5-0 target-message) #f)
(set! (-> s5-0 selection)
(the-as (array editable) ((method-of-type array new) allocation array editable arg0))
)
(set! (-> s5-0 edit-plane) #f)
(set! (-> s5-0 filter 0) (editable-filter
none
unknown
sound
part
user-setting
cam-setting
load
water-command
city_vis
sample
light
entity
)
)
(set! (-> s5-0 filter 1) (editable-filter camera target water data city_vis sample light entity selected))
(dotimes (v1-5 arg0)
(set! (-> s5-0 data v1-5) #f)
(set! (-> s5-0 selection v1-5) #f)
)
s5-0
)
)
(deftype editable-point (editable)
((radius float)
(trans vector :inline)
)
(:methods
(new (symbol type vector editable-region) _type_)
)
)
(defmethod new editable-point ((allocation symbol) (type-to-make type) (arg0 vector) (arg1 editable-region))
(let ((gp-0 (object-new allocation type-to-make (the-as int (-> type-to-make size)))))
(set! (-> gp-0 region) #f)
(set! (-> gp-0 name) "undefined")
(editable-method-21 gp-0 (cond
(arg1
(empty)
arg1
)
(else
(new 'debug 'editable-region)
)
)
)
(set! (-> gp-0 trans quad) (-> arg0 quad))
(set! (-> gp-0 radius) 2048.0)
(set! (-> gp-0 owner) '())
gp-0
)
)
(deftype editable-sphere (editable-point)
()
(:methods
(new (symbol type vector float editable-region) _type_)
)
)
(defmethod new editable-sphere ((allocation symbol) (type-to-make type) (arg0 vector) (arg1 float) (arg2 editable-region))
(let ((s5-0 (object-new allocation type-to-make (the-as int (-> type-to-make size)))))
(set! (-> s5-0 region) #f)
(set! (-> s5-0 name) "undefined")
(editable-method-21 s5-0 (cond
(arg2
(empty)
arg2
)
(else
(new 'debug 'editable-region)
)
)
)
(set! (-> s5-0 trans quad) (-> arg0 quad))
(set! (-> s5-0 radius) arg1)
(set! (-> s5-0 owner) '())
s5-0
)
)
(deftype editable-sample (editable-point)
()
)
(deftype editable-light (editable-sphere)
((direction vector :inline)
(color vector :inline)
(decay-start float)
(ambient-point-ratio float)
(brightness float)
)
(:methods
(new (symbol type vector float editable-region) _type_)
)
)
(defmethod new editable-light ((allocation symbol) (type-to-make type) (arg0 vector) (arg1 float) (arg2 editable-region))
(let ((gp-0 (object-new allocation type-to-make (the-as int (-> type-to-make size)))))
(set! (-> gp-0 region) #f)
(editable-method-21 gp-0 (cond
(arg2
(empty)
arg2
)
(else
(new 'debug 'editable-region)
)
)
)
(set! (-> gp-0 trans quad) (-> arg0 quad))
(set! (-> gp-0 radius) arg1)
(set! (-> gp-0 owner) '())
(let ((s5-1 (new 'debug 'string 32 (the-as string #f))))
(format s5-1 "undefined-~d" *editable-temp-id*)
(set! (-> gp-0 name) s5-1)
)
(set! *editable-temp-id* (+ *editable-temp-id* 1))
(set! (-> gp-0 decay-start) 0.5)
(set! (-> gp-0 ambient-point-ratio) 1.0)
(set! (-> gp-0 brightness) 1.0)
(set-vector! (-> gp-0 color) 1.0 1.0 1.0 -1.0)
(set-vector! (-> gp-0 direction) 0.0 0.0 0.0 0.0)
gp-0
)
)
(deftype editable-entity (editable-point)
()
)
(deftype editable-face (editable)
((length int32)
(normal vector :inline)
(center vector :inline)
(vertex editable-point 6) ;; can hold up to 6 (kinda a weird number...) but still does just define 1 face!
)
(:methods
(new (symbol type editable-region) _type_)
(editable-face-method-30 (_type_ (inline-array vector)) int)
(editable-face-method-31 (_type_ vector) vector)
)
)
(defmethod new editable-face ((allocation symbol) (type-to-make type) (arg0 editable-region))
(let ((gp-0 (object-new allocation type-to-make (the-as int (-> type-to-make size)))))
(set! (-> gp-0 region) #f)
(set! (-> gp-0 name) "undefined")
(editable-method-21 gp-0 (cond
(arg0
(empty)
arg0
)
(else
(new 'debug 'editable-region)
)
)
)
(set! (-> gp-0 owner) '())
gp-0
)
)
(deftype editable-plane (editable)
"Modified from the original, in the original editor code a plane is defined by a normal vector (2 points) and a radius (equal side lengths)"
((length int32)
(normal vector :inline)
(position vector :inline)
(vertex editable-point 4) ;; was 2
)
(:methods
(new (symbol type editable-region) _type_)
(editable-plane-method-30 (_type_ (inline-array vector)) int)
(editable-plane-method-31 (_type_ vector) vector)
)
)
(defmethod new editable-plane ((allocation symbol) (type-to-make type) (arg0 editable-region))
(let ((gp-0 (object-new allocation type-to-make (the-as int (-> type-to-make size)))))
(set! (-> gp-0 region) #f)
(set! (-> gp-0 name) "undefined")
(editable-method-21 gp-0 (cond
(arg0
(empty)
arg0
)
(else
(new 'debug 'editable-region)
)
)
)
(set! (-> gp-0 owner) '())
gp-0
)
)
(deftype editable-player (process-drawable)
((current editable-array)
(select-command function)
(move-command function)
(extra-command function)
(left-handed basic)
(light-names basic)
(external-cam-mode symbol)
(command editable-command 6)
(close-menu-time time-frame)
)
(:state-methods
idle
)
(:methods
(editable-player-method-21 (_type_) none)
)
)
(deftype editable-work (basic)
((num-found int16)
(last-found int16)
(last-x float)
(last-y float)
(found editable 256)
(dists uint32 256)
)
)
(define *editable-work* (new 'global 'editable-work))
(define *editable* (the-as (pointer editable-player) #f))