• Top
  • Documentation
  • Books
  • Boolean-reasoning
  • Projects
  • Debugging
  • Std
  • Proof-automation
  • Macro-libraries
  • ACL2
  • Interfacing-tools
  • Hardware-verification
  • Software-verification
    • Kestrel-books
      • Crypto-hdwallet
      • Apt
        • Simplify-defun
        • Isodata
        • Tailrec
        • Schemalg
        • Restrict
        • Expdata
        • Casesplit
        • Simplify-term
        • Simplify-defun-sk
        • Parteval
        • Solve
        • Wrap-output
        • Propagate-iso
        • Simplify
        • Finite-difference
        • Drop-irrelevant-params
        • Copy-function
        • Lift-iso
        • Rename-params
        • Utilities
          • Defaults-table
          • Xdoc::apt-constructors
          • Input-processors
            • Process-input-old-soft-io-sel-mod
            • Process-input-new/wrapper-names
            • Process-input-select-old-soft-io
            • Process-input-old-to-new-name
            • Process-input-old-if-new-name
            • Process-input-old-to-wrapper-name
            • Process-input-wrapper-enable
            • Process-input-wrapper-to-old-name
            • Process-input-old-to-new-enable
            • Process-input-old-to-wrapper-enable
            • Process-input-old-if-new-enable
            • Process-input-new-name
            • Process-input-new-to-old-name
            • Process-input-wrapper-to-old-enable
            • Process-input-verify-guards
            • Process-input-new-enable
            • Process-input-new-to-old-enable
          • Transformation-table
          • Find-base-cases
          • Untranslate-specifier-utilities
          • Print-specifier-utilities
          • Hints-specifier-utilities
        • Simplify-term-programmatic
        • Simplify-defun-sk-programmatic
        • Simplify-defun-programmatic
        • Simplify-defun+
        • Common-options
        • Common-concepts
      • Error-checking
      • Fty-extensions
      • Isar
      • Kestrel-utilities
      • Soft
      • Bv
      • Imp-language
      • C
      • Event-macros
      • Java
      • Bitcoin
      • Ethereum
      • Yul
      • Zcash
      • ACL2-programming-language
      • Prime-fields
      • Json
      • Syntheto
      • File-io-light
      • Number-theory
      • Cryptography
      • Lists-light
      • Builtins
      • Axe
      • Solidity
      • Helpers
      • Htclient
      • Typed-lists-light
      • Arithmetic-light
    • X86isa
    • Axe
    • Execloader
  • Math
  • Testing-utilities

• Input-processors

Process-input-wrapper-enable

Process the :wrapper-enable input of an APT transformation.

Signature

(process-input-wrapper-enable wrapper-enable wrapper-enable-present 
                              gen-wrapper ctx state) 
 
  → 
(mv erp processed-wrapper-enable state)

Arguments

wrapper-enable-present — Guard (booleanp wrapper-enable-present).

gen-wrapper — Guard (booleanp gen-wrapper).

Returns

processed-wrapper-enable — Type (booleanp processed-wrapper-enable).

The APT transformations that use this utility have a :wrapper-enable input that specifies whether to enable or not the wrapper function, assuming it is generated. This input must be a boolean. If absent, it is taken from the APT defaults table; see set-default-input-wrapper-enable.

The gen-wrapper parameter is t iff the wrapper is generated, i.e. if the :wrapper input of the transformation is t. If this is nil, we ensure that :wrapper-enable is absent.

The caller of this utility must set the parameter wrapper-enable-present to t iff the :wrapper-enable input is present. If this is nil, the parameter wrapper-enable is ignored.

Definitions and Theorems

Function: process-input-wrapper-enable

(defun process-input-wrapper-enable
       (wrapper-enable wrapper-enable-present
                       gen-wrapper ctx state)
 (declare (xargs :stobjs (state)))
 (declare (xargs :guard (and (booleanp wrapper-enable-present)
                             (booleanp gen-wrapper))))
 (let ((__function__ 'process-input-wrapper-enable))
  (declare (ignorable __function__))
  (if gen-wrapper
      (if wrapper-enable-present
          (b* (((er &)
                (ensure-value-is-boolean$
                     wrapper-enable
                     "The :WRAPPER-ENABLE input" t nil)))
            (value wrapper-enable))
        (value (get-default-input-wrapper-enable (w state))))
   (if wrapper-enable-present
    (er-soft+
     ctx t nil
     "Since the :WRAPPER input is (perhaps by default) NIL, ~
                   no :WRAPPER-ENABLE input may be supplied,
                   but ~x0 was supplied instead."
     wrapper-enable)
    (value nil)))))

Theorem: booleanp-of-process-input-wrapper-enable.processed-wrapper-enable

(defthm
  booleanp-of-process-input-wrapper-enable.processed-wrapper-enable
  (b* (((mv ?erp
            ?processed-wrapper-enable acl2::?state)
        (process-input-wrapper-enable
             wrapper-enable wrapper-enable-present
             gen-wrapper ctx state)))
    (booleanp processed-wrapper-enable))
  :rule-classes :rewrite)