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