• Top
    • Documentation
    • Books
    • Recursion-and-induction
    • Boolean-reasoning
    • Projects
    • Debugging
    • Std
    • Proof-automation
    • Macro-libraries
    • ACL2
    • Interfacing-tools
    • Hardware-verification
    • Software-verification
      • Kestrel-books
        • Crypto-hdwallet
        • Error-checking
          • Def-error-checker
          • Ensure-function/macro/lambda
          • Ensure-symbol-is-fresh-event-name
          • Ensure-function/lambda/term-number-of-results
          • Ensure-function/lambda-no-stobjs
          • Ensure-function/lambda-arity
          • Ensure-function-name-or-numbered-wildcard
            • Ensure-function-name-or-numbered-wildcard$
          • Ensure-function/lambda-guard-verified-fns
          • Ensure-function/lambda-logic-mode
          • Ensure-function/lambda-closed
          • Ensure-value-is-untranslated-term
          • Ensure-function-number-of-results
          • Ensure-boolean-or-auto-and-return-boolean
          • Ensure-term-if-call
          • Ensure-is-hints-specifier
          • Ensure-symbol-new-event-name
          • Ensure-symbol-different
          • Ensure-value-is-not-in-list
          • Ensure-term-free-vars-subset
          • Ensure-function/lambda-guard-verified-exec-fns
          • Ensure-value-is-in-list
          • Ensure-list-subset
          • Ensure-lambda-guard-verified-fns
          • Ensure-function-no-stobjs
          • Ensure-function-known-measure
          • Ensure-term-not-call-of
          • Ensure-lambda-arity
          • Ensure-function-arity
          • Ensure-term-no-stobjs
          • Ensure-term-guard-verified-fns
          • Ensure-term-does-not-call
          • Ensure-lambda-logic-mode
          • Ensure-function-singly-recursive
          • Ensure-function-is-guard-verified
          • Ensure-term-logic-mode
          • Ensure-term-ground
          • Ensure-symbol-function
          • Ensure-list-functions
          • Ensure-keyword-value-list
          • Ensure-function-program-mode
          • Ensure-function-non-recursive
          • Ensure-function-is-pure-if-raw
          • Ensure-function-is-logic-mode
          • Ensure-function-is-defined
          • Ensure-function-has-args
          • Ensure-value-is-legal-variable-name
          • Ensure-value-is-function-name
          • Ensure-value-is-constant-name
          • Ensure-symbol-truelist-alist
          • Ensure-symbol-not-stobj
          • Ensure-symbol-not-keyword
          • Ensure-list-has-no-duplicates
          • Ensure-lambda-closed
          • Ensure-function-recursive
          • Ensure-function-name-list
          • Ensure-value-is-true-list
          • Ensure-value-is-symbol-list
          • Ensure-value-is-boolean
          • Ensure-tuple
          • Ensure-symbol-alist
          • Ensure-defun-mode-or-auto
          • Ensure-constant-name
          • Ensure-boolean-or-auto
          • Ensure-value-is-symbol
          • Ensure-value-is-string
          • Ensure-value-is-nil
          • Ensure-string-or-nil
          • Ensure-doublet-list
          • Ensure-defun-mode
          • Ensure-function-not-in-termination-thm
          • Ensure-lambda-guard-verified-exec-fns
          • Ensure-term-guard-verified-exec-fns
        • Apt
        • Abnf
        • Fty-extensions
        • Isar
        • Kestrel-utilities
        • Prime-field-constraint-systems
        • Soft
        • Bv
        • Imp-language
        • Event-macros
        • Bitcoin
        • Ethereum
        • Yul
        • Zcash
        • ACL2-programming-language
        • Prime-fields
        • Java
        • C
        • Syntheto
        • Number-theory
        • Cryptography
        • Lists-light
        • File-io-light
        • Json
        • Built-ins
        • Solidity
        • Axe
        • Std-extensions
        • Htclient
        • Typed-lists-light
        • Arithmetic-light
      • X86isa
      • Execloader
      • Axe
    • Testing-utilities
    • Math
  • Error-checking

Ensure-function-name-or-numbered-wildcard

Cause an error if a value is not either the name of an existing function or a numbered name with a wildcard index that resolves to the name of an existing function.

Signature
(ensure-function-name-or-numbered-wildcard 
     x description 
     error-erp error-val ctx state) 
 
  → 
(mv erp val state)
Arguments
x — Value to check.
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) (symbolp val))) .

If successful, return the name of the existing function.

The string in the description should be capitalized because it occurs at the beginning of all the error messages except one; for that one, msg-downcase-first is applied to the description.

Definitions and Theorems

Function: ensure-function-name-or-numbered-wildcard

(defun
 ensure-function-name-or-numbered-wildcard
 (x description
    error-erp error-val ctx state)
 (declare (xargs :stobjs (state)))
 (declare (xargs :guard (msgp description)))
 (let
  ((__function__ 'ensure-function-name-or-numbered-wildcard))
  (declare (ignorable __function__))
  (b* (((er &)
        (ensure-value-is-symbol$ x description error-erp error-val))
       (name (resolve-numbered-name-wildcard x (w state)))
       ((er &)
        (ensure-symbol-function$
             name
             (if (eq x name)
                 (msg "~@0, which is the symbol ~x1,"
                      description x)
                 (msg "The symbol ~x0, to which ~@1 resolves to,"
                      name (msg-downcase-first description)))
             error-erp error-val)))
      (value name))))

Theorem: return-type-of-ensure-function-name-or-numbered-wildcard.erp

(defthm return-type-of-ensure-function-name-or-numbered-wildcard.erp
        (b* (((mv ?erp ?val ?state)
              (ensure-function-name-or-numbered-wildcard
                   x description
                   error-erp error-val ctx state)))
            (implies erp (equal erp error-erp)))
        :rule-classes :rewrite)

Theorem: return-type-of-ensure-function-name-or-numbered-wildcard.val

(defthm return-type-of-ensure-function-name-or-numbered-wildcard.val
        (b* (((mv ?erp ?val ?state)
              (ensure-function-name-or-numbered-wildcard
                   x description
                   error-erp error-val ctx state)))
            (and (implies erp (equal val error-val))
                 (implies (and (not erp) error-erp)
                          (symbolp val))))
        :rule-classes :rewrite)

Subtopics

Ensure-function-name-or-numbered-wildcard$
Call ensure-function-name-or-numbered-wildcard with ctx and state as the last two arguments.