Vl-lucidocc-case
Case macro for the different kinds of vl-lucidocc structures.
This is an ACL2::fty sum-type case macro,
typically introduced by fty::defflexsum or deftagsum. It
allows you to safely check the type of a vl-lucidocc structure, or to split
into cases based on its type.
Short Form
In its short form, vl-lucidocc-case allows you to safely check the type of
a vl-lucidocc structure. For example:
(vl-lucidocc-case x :solo)
is essentially just a safer alternative to writing:
(equal (vl-lucidocc-kind x) :solo)
Why is using vl-lucidocc-case safer? When we directly inspect the
kind with equal, there is no static checking being done to
ensure that, e.g., :solo is a valid kind of vl-lucidocc structure. That means there is nothing to save you
if, later, you change the kind keyword for this type from :solo to something else. It also means you get no help
if you just make a typo when writing the :solo
symbol. Over the course of developing VL, we found that such
issues were very frequent sources of errors!
Long Form
In its longer form, vl-lucidocc-case allows you to split into cases based
on the kind of structure you are looking at. A typical example would be:
(vl-lucidocc-case x
:solo ...
:slice ...
:tail ...)
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 :solo case,
you can use defprod-style foo.bar style accessors for x
without having to explicitly add a solo b*
binder.
