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