• Top
    • Documentation
    • Books
    • Recursion-and-induction
    • Boolean-reasoning
    • Debugging
    • Projects
    • Std
    • Proof-automation
    • Macro-libraries
    • ACL2
    • Interfacing-tools
    • Hardware-verification
      • Gl
      • Esim
      • Vl2014
      • Sv
      • Fgl
      • Vl
        • Syntax
        • Loader
        • Warnings
        • Getting-started
        • Utilities
        • Printer
        • Kit
        • Mlib
          • Scopestack
            • Vl-interfaceportlist->ifnames
            • Vl-blockscope
            • Vl-scope-find-item
            • Vl-scopestack-find-item/ss/package
            • Vl-importlist-find-explicit-item
            • Vl-scopestack-find-item/context
            • Vl-importlist-find-implicit-item
            • Vl-import-stars-find-item
            • Vl-scopeinfo
            • Vl-importlist->explicit-item-alist
            • Vl-scopestack-find-definition/ss
            • Vl-scopeitem
            • Vl-scopeinfo-find-item
            • Vl-scopestack-find-package/ss
            • Vl-scopestack-find-item/ss
            • Vl-scopestack
            • Vl-scopestack-find-class/ss
            • Scopestack-constants
            • Vl-scope-namespace
            • Vl-scopestack-push
            • Vl-maybe-scope
              • Vl-maybe-scope-fix
              • Vl-maybe-scope-equiv
              • Vl-maybe-scope-case
                • Vl-maybe-scope-some
                • Vl-maybe-scope-none
                • Vl-maybe-scope-p
              • Vl-importresult
              • Vl-scope-find-item-fast
              • Vl-module-scope-find-item
              • Vl-interface-scope-find-item
              • Vl-import-stars-itemnames
              • Vl-genblob-scope-find-item
              • Vl-scope->scopeinfo
              • Vl-design-scope-find-definition
              • Vl-scopestack-find-item
              • Vl-scopestack-find-definition
              • Vl-package-scope-find-item
              • Vl-interface-scope-find-portdecl
              • Vl-design-scope-find-item
              • Vl-blockscope-scope-find-item
              • Vl-scopestack-find-package
              • Vl-scopeinfo->itemnames
              • Vl-scope-find-portdecl
              • Vl-scope-find-definition
              • Vl-module-scope-find-portdecl
              • Vl-genblob-scope-find-portdecl
              • Vl-design-scope-find-package
              • Vl-class-scope-find-item
              • Vl-scope-find-package
              • Vl-design-scope-find-class
              • Vl-scopestack-find-class
              • Vl-scope-find-class
              • Vl-scopestack->hashkey
              • Vl-scope-find-portdecl-fast
              • Vl-scope-definition-alist
              • Vl-package-scope-item-alist-top
              • Vl-scopestack->path-aux
              • Vl-scopedef
              • Vl-scope-portdecl-alist
              • Vl-scope-package-alist
              • Vl-scope-find-package-fast
              • Vl-scope-find-definition-fast
              • Vl-scope-class-alist
              • Vl-scope-find-class-fast
              • Vl-scopestack->path
              • Vl-scopestack->design
              • Vl-scopestack-init
              • Vl-scopeitem->name
              • Vl-scope
              • Vl-importlist->star-packages
              • Vl-scopestack->toplevel
              • Vl-scopestack-pop
              • Vl-scopestack-nesting-level
              • Vl-scope->scopetype
              • Vl-scope->id
              • Vl-bindlist->modinsts
              • Vl-design-scope-package-alist-top
              • Vl-scopestack-toplevel-p
              • Vl-scopestacks-free
              • Vl-importresult-alist
            • Hid-tools
            • Filtering-by-name
            • Vl-interface-mocktype
            • Stripping-functions
            • Genblob
            • Expr-tools
            • Hierarchy
            • Extract-vl-types
            • Range-tools
            • Finding-by-name
            • Stmt-tools
            • Modnamespace
            • Flat-warnings
            • Reordering-by-name
            • Datatype-tools
            • Syscalls
            • Allexprs
            • Lvalues
            • Port-tools
          • Transforms
        • X86isa
        • Svl
        • Rtl
      • Software-verification
      • Testing-utilities
      • Math
    • Vl-maybe-scope

    Vl-maybe-scope-case

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

    Short Form

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

    (vl-maybe-scope-case x :none)

    can be used to determine whether x is a none instead of some other kind of vl-maybe-scope structure.

    Long Form

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

    (vl-maybe-scope-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 defprod-style foo.bar style accessors for x without having to explicitly add a none b* binder.