• Top
  • Documentation
  • Books
  • Boolean-reasoning
  • Projects
    • Apt
    • Zfc
    • Acre
    • Milawa
    • Smtlink
    • Abnf
    • Vwsim
    • Isar
    • Wp-gen
    • Dimacs-reader
    • Pfcs
    • Legacy-defrstobj
    • Proof-checker-array
    • Soft
    • C
    • Farray
    • Rp-rewriter
    • Instant-runoff-voting
    • Imp-language
    • Sidekick
    • Leftist-trees
    • Java
    • Riscv
    • Taspi
    • Bitcoin
    • Des
    • Ethereum
    • X86isa
    • Sha-2
    • Yul
    • Zcash
    • Proof-checker-itp13
    • Regex
    • ACL2-programming-language
    • Json
    • Jfkr
    • Equational
    • Cryptography
    • Poseidon
    • Where-do-i-place-my-book
    • Axe
    • Aleo
      • Aleobft
      • Aleovm
      • Leo
        • Grammar
        • Early-version
          • Json2ast
          • Testing
          • Definition
            • Flattening
            • Abstract-syntax
              • Expression
              • Syntax-abstraction
              • Statement
              • Files
              • Input-files
              • Identifiers
              • Types
              • Struct-init
              • Branch
              • Statements
              • Format-strings
              • Input-syntax-abstraction
              • Expressions
                • Binop
                  • Binopp
                  • Binop-case
                  • Binop-fix
                  • Binop-kind
                  • Binop-equiv
                  • Binop-add
                  • Binop-sub
                  • Binop-gt
                  • Binop-sub-wrapped
                  • Binop-shr-wrapped
                  • Binop-shr
                  • Binop-shl-wrapped
                  • Binop-shl
                  • Binop-rem-wrapped
                  • Binop-rem
                  • Binop-pow-wrapped
                  • Binop-pow
                  • Binop-or
                  • Binop-nor
                  • Binop-ne
                  • Binop-nand
                  • Binop-mul-wrapped
                  • Binop-mul
                  • Binop-lt
                  • Binop-le
                  • Binop-ge
                  • Binop-eq
                  • Binop-div-wrapped
                  • Binop-div
                  • Binop-bitxor
                  • Binop-bitior
                  • Binop-bitand
                  • Binop-and
                  • Binop-add-wrapped
                • Unop
                • Expression-option
                • Struct-init-list-result
                • Expression-option-result
                • Unop-result
                • Struct-init-result
                • Expression-result
                • Expression-list-result
                • Binop-result
                • Expression-fixtypes
              • Output-files
              • Addresses
              • Literals
              • Characters
              • Expression-list
              • Statement-list
              • Output-syntax-abstraction
              • Struct-init-list
              • Branch-list
              • Annotations
              • Abstract-syntax-trees
              • Symbols
              • Keywords
              • Programs
              • Packages
              • Bit-sizes
            • Dynamic-semantics
            • Compilation
            • Static-semantics
            • Concrete-syntax
    • Bigmems
    • Builtins
    • Execloader
    • Solidity
    • Paco
    • Concurrent-programs
    • Bls12-377-curves
  • Debugging
  • Community
  • Std
  • Proof-automation
  • Macro-libraries
  • ACL2
  • Interfacing-tools
  • Hardware-verification
  • Software-verification
  • Math
  • Testing-utilities

• Binop

Binop-case

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

Short Form

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

(binop-case x :and)

is essentially just a safer alternative to writing:

(equal (binop-kind x) :and)

Why is using binop-case safer? When we directly inspect the kind with equal, there is no static checking being done to ensure that, e.g., :and is a valid kind of binop structure. That means there is nothing to save you if, later, you change the kind keyword for this type from :and to something else. It also means you get no help if you just make a typo when writing the :and symbol. Over the course of developing VL, we found that such issues were very frequent sources of errors!

Long Form

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

(binop-case x
  :and ...
  :or ...
  :eq ...
  :ne ...
  :ge ...
  :gt ...
  :le ...
  :lt ...
  :bitxor ...
  :bitior ...
  :bitand ...
  :shl ...
  :shr ...
  :add ...
  :sub ...
  :mul ...
  :div ...
  :rem ...
  :pow ...
  :nand ...
  :nor ...
  :shl-wrapped ...
  :shr-wrapped ...
  :add-wrapped ...
  :sub-wrapped ...
  :mul-wrapped ...
  :div-wrapped ...
  :rem-wrapped ...
  :pow-wrapped ...)

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