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