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