• Top
    • Documentation
    • Books
    • Recursion-and-induction
    • Boolean-reasoning
    • Projects
    • Debugging
    • Std
    • Proof-automation
    • Macro-libraries
      • B*
      • Defunc
      • Fty
      • Std/util
      • Apt
      • Defdata
      • Defrstobj
      • Seq
      • Match-tree
      • Defrstobj
      • With-supporters
      • Def-partial-measure
      • Template-subst
      • Soft
      • Defthm-domain
      • Event-macros
        • Evmac-input-hints-p
        • Function-definedness
        • Event-macro-input-processing
        • Event-macro-screen-printing
        • Evmac-input-print-p
        • Make-event-terse
        • Event-macro-applicability-conditions
        • Event-macro-results
        • Template-generators
        • Event-macro-event-generators
        • Event-macro-proof-preparation
        • Try-event
        • Restore-output?
        • Restore-output
        • Fail-event
          • Cw-event
          • Event-macro-xdoc-constructors
          • Event-macro-intro-macros
        • Def-universal-equiv
        • Def-saved-obligs
        • With-supporters-after
        • Definec
        • Sig
        • Outer-local
        • Data-structures
      • ACL2
      • Interfacing-tools
      • Hardware-verification
      • Software-verification
      • Testing-utilities
      • Math
    • Event-macros

    Fail-event

    An event that always fails with a specified error context, flag, value, and message.

    This is realized by always generating a soft error (via er-soft+) during the expansion phase of make-event. The error context, flag, value, and message passed to this macro are not evaluated.

    The use of make-event-terse instead of make-event avoids any screen output other than the specified error message.

    This macro is used by try-event.

    Macro: fail-event

    (defmacro
     fail-event (ctx erp val msg)
     (declare (xargs :guard (msgp msg)))
     (cons
      'make-event-terse
      (cons
       (cons 'er-soft+
             (cons (cons 'quote (cons ctx 'nil))
                   (cons (cons 'quote (cons erp 'nil))
                         (cons (cons 'quote (cons val 'nil))
                               (cons '"~@0"
                                     (cons (cons 'quote (cons msg 'nil))
                                           'nil))))))
       'nil)))