		Search-engine friendly clone of the ACL2 documentation.

Error-checking

Ensure-function-is-logic-mode

Cause an error if a function is in program mode.

Signature
(ensure-function-is-logic-mode fn description error-erp error-val ctx state) → (mv erp val state)
Arguments: fn — Function to check.
Guard (function-namep fn (w state)).; description — Guard (msgp description).; error-erp — Flag to return in case of error.; error-val — Value to return in case of error.; ctx — Context for errors.
Returns: erp — Type (implies erp (equal erp error-erp)).; val — Type (and (implies erp (equal val error-val)) (implies (and (not erp) error-erp) (not val))) .

Definitions and Theorems

Function: ensure-function-is-logic-mode

(defun ensure-function-is-logic-mode
       (fn description
           error-erp error-val ctx state)
  (declare (xargs :stobjs (state)))
  (declare (xargs :guard (and (msgp description)
                              (function-namep fn (w state)))))
  (b* (((unless (logicp fn (w state)))
        (er-soft+ ctx error-erp
                  error-val "~@0 is not in logic mode."
                  description fn)))
    (value nil)))

Theorem: return-type-of-ensure-function-is-logic-mode.erp

(defthm return-type-of-ensure-function-is-logic-mode.erp
  (b*
   (((mv ?erp ?val ?state)
     (ensure-function-is-logic-mode fn description
                                    error-erp error-val ctx state)))
   (implies erp (equal erp error-erp)))
  :rule-classes :rewrite)

Theorem: return-type-of-ensure-function-is-logic-mode.val

(defthm return-type-of-ensure-function-is-logic-mode.val
  (b*
   (((mv ?erp ?val ?state)
     (ensure-function-is-logic-mode fn description
                                    error-erp error-val ctx state)))
   (and (implies erp (equal val error-val))
        (implies (and (not erp) error-erp)
                 (not val))))
  :rule-classes :rewrite)

Subtopics

Ensure-function-is-logic-mode$: Calls ensure-function-is-logic-mode with ctx and state as the last two arguments.