Eval-state-case
Case macro for the different kinds of eval-state structures.
This is an ACL2::fty sum-type case macro,
typically introduced by fty::defflexsum or fty::deftagsum. It
allows you to safely check the type of a eval-state structure, or to split
into cases based on its type.
Short Form
In its short form, eval-state-case allows you to safely check the type of
a eval-state structure. For example:
(eval-state-case x :init)
is essentially just a safer alternative to writing:
(equal (eval-state-kind x) :init)
Why is using eval-state-case safer? When we directly inspect the
kind with equal, there is no static checking being done to
ensure that, e.g., :init is a valid kind of eval-state structure. That means there is nothing to save you
if, later, you change the kind keyword for this type from :init to something else. It also means you get no help
if you just make a typo when writing the :init
symbol. Over the course of developing VL, we found that such
issues were very frequent sources of errors!
Long Form
In its longer form, eval-state-case allows you to split into cases based
on the kind of structure you are looking at. A typical example would be:
(eval-state-case x
:init ...
:trans ...
:final ...
:error ...)
It is also possible to consolidate ``uninteresting'' cases using
:otherwise.
For convenience, the case macro automatically binds the fields of x for
you, as appropriate for each case. That is, in the :init case,
you can use fty::defprod-style foo.bar style accessors for x
without having to explicitly add a init b*
binder.
