jak-project/goal_src/jak2/engine/util/glist-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

80 lines
1.5 KiB
Common Lisp

;;-*-Lisp-*-
(in-package goal)
;; name: glist-h.gc
;; name in dgo: glist-h
;; dgos: ENGINE, GAME
;; DECOMP BEGINS
;; this file is debug only
(declare-file (debug))
(deftype glst-node (structure)
((next glst-node)
(prev glst-node)
)
)
(deftype glst-named-node (glst-node)
((privname string)
)
)
(deftype glst-list (structure)
((head glst-node)
(tail glst-node)
(tailpred glst-node)
(numelem int32)
)
)
(defun glst-next ((arg0 glst-node))
"return the next node in the list"
(-> arg0 next)
)
(defun glst-prev ((arg0 glst-node))
"return the previous node in the list"
(-> arg0 prev)
)
(defun glst-head ((arg0 glst-list))
"return the start of the list"
(-> arg0 head)
)
(defun glst-tail ((arg0 glst-list))
"return the tail of the list"
(-> arg0 tailpred)
)
(defun glst-end-of-list? ((arg0 glst-node))
"is this node the end of the list. #t = end"
(not (-> arg0 next))
)
(defun glst-start-of-list? ((arg0 glst-node))
"is this node the start of the list. #t = start"
(not (-> arg0 prev))
)
(defun glst-empty? ((arg0 glst-list))
"is the list empty, #t = empty"
(= (-> arg0 tailpred) arg0)
)
(defun glst-node-name ((arg0 glst-named-node))
"Returns the `privname` of the provided [[glst-named-node]]"
(-> arg0 privname)
)
(defun glst-set-name! ((arg0 glst-named-node) (arg1 string))
"Sets the `privname` of the provided [[glst-named-node]]"
(set! (-> arg0 privname) arg1)
arg1
)