		Search-engine friendly clone of the ACL2 documentation.

Tterm-option

Tterm-option-case

Case macro for the different kinds of tterm-option 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 tterm-option structure, or to split into cases based on its type.

Short Form

In its short form, tterm-option-case allows you to safely check the type of a tterm-option structure. For example:

(tterm-option-case x :none)

can be used to determine whether x is a none instead of some other kind of tterm-option structure.

Long Form

In its longer form, tterm-option-case allows you to split into cases based on the kind of structure you are looking at. A typical example would be:

(tterm-option-case x
  :none ...
  :some ...)

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 :none case, you can use fty::defprod-style foo.bar style accessors for x without having to explicitly add a none b* binder.