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

• Error-checking

Ensure-value-is-legal-variable-name

Cause an error if a value is not a legal variable name.

Signature

(ensure-value-is-legal-variable-name 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) (not val))) .

Definitions and Theorems

Function: ensure-value-is-legal-variable-name

(defun ensure-value-is-legal-variable-name
       (x description
          error-erp error-val ctx state)
 (declare (xargs :stobjs (state)))
 (declare (xargs :guard (msgp description)))
 (b*
  (((unless (legal-variablep x))
    (er-soft+
     ctx error-erp error-val
     "~@0 must be a legal name for a variable, but it is ~x1 instead."
     description x)))
  (value nil)))

Theorem: return-type-of-ensure-value-is-legal-variable-name.erp

(defthm return-type-of-ensure-value-is-legal-variable-name.erp
  (b* (((mv ?erp ?val ?state)
        (ensure-value-is-legal-variable-name
             x description
             error-erp error-val ctx state)))
    (implies erp (equal erp error-erp)))
  :rule-classes :rewrite)

Theorem: return-type-of-ensure-value-is-legal-variable-name.val

(defthm return-type-of-ensure-value-is-legal-variable-name.val
  (b* (((mv ?erp ?val ?state)
        (ensure-value-is-legal-variable-name
             x 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-value-is-legal-variable-name$

Calls ensure-value-is-legal-variable-name with ctx and state as the last two arguments.