• Top
    • Documentation
    • Books
    • Boolean-reasoning
    • Projects
    • Debugging
    • Std
    • Proof-automation
    • Macro-libraries
    • ACL2
      • Theories
      • Rule-classes
      • Proof-builder
      • Recursion-and-induction
      • Hons-and-memoization
      • Events
        • Defun
        • Verify-guards
        • Table
        • Mutual-recursion
        • Memoize
        • Make-event
        • Include-book
        • Encapsulate
        • Defun-sk
        • Defttag
          • Set-raw-mode
          • Include-raw
          • Remove-untouchable
          • Push-untouchable
            • Set-deferred-ttag-notes
            • Untouchable
            • Set-raw-mode-on!
            • Set-raw-mode-on
          • Defstobj
          • Defpkg
          • Defattach
          • Defabsstobj
          • Defchoose
          • Progn
          • Verify-termination
          • Redundant-events
          • Defmacro
          • Defconst
          • Skip-proofs
          • In-theory
          • Embedded-event-form
          • Value-triple
          • Comp
          • Local
          • Defthm
          • Progn!
          • Defevaluator
          • Theory-invariant
          • Assert-event
          • Defun-inline
          • Project-dir-alist
          • Partial-encapsulate
          • Define-trusted-clause-processor
          • Defproxy
          • Defexec
          • Defun-nx
          • Defthmg
          • Defpun
          • Defabbrev
          • Set-table-guard
          • Name
          • Defrec
          • Add-custom-keyword-hint
          • Regenerate-tau-database
          • Defcong
          • Deftheory
          • Defaxiom
          • Deftheory-static
          • Defund
          • Evisc-table
          • Verify-guards+
          • Logical-name
          • Profile
          • Defequiv
          • Defmacro-untouchable
          • Add-global-stobj
          • Defthmr
          • Defstub
          • Defrefinement
          • Deflabel
          • In-arithmetic-theory
          • Unmemoize
          • Defabsstobj-missing-events
          • Defthmd
          • Fake-event
          • Set-body
          • Defun-notinline
          • Functions-after
          • Macros-after
          • Dump-events
          • Defund-nx
          • Defun$
          • Remove-global-stobj
          • Remove-custom-keyword-hint
          • Dft
          • Defthy
          • Defund-notinline
          • Defnd
          • Defn
          • Defund-inline
          • Defmacro-last
        • Parallelism
        • History
        • Programming
        • Operational-semantics
        • Real
        • Start-here
        • Debugging
        • Miscellaneous
        • Output-controls
        • Macros
        • Interfacing-tools
      • Interfacing-tools
      • Hardware-verification
      • Software-verification
      • Math
      • Testing-utilities
    • Defttag

    Push-untouchable

    Add name or list of names to the list of untouchable symbols

    Untouchables are functions that cannot be called, as well as state global variables (see programming-with-state) that cannot be modified or unbound. Macros can also be untouchable in some sense; see defmacro-untouchable.

    Examples:
    (push-untouchable my-var nil)
    (push-untouchable set-mem t)
    
    General Form:
    (push-untouchable name{s} fn-p)

    where name{s} is a non-nil symbol or a non-nil true list of symbols, and fn-p is any value (but generally nil or t). If name{s} is a symbol it is treated as the singleton list containing that symbol. The effect of this event is to union the given symbols into the list of ``untouchable variables'' in the current world if fn-p is nil, else to union the symbols into the list of ``untouchable functions''. This event is redundant if every symbol listed is already a member of the appropriate untouchables list (variables or functions).

    There is a further restriction on which function names may be made untouchable: If a function symbol, g, may be introduced into a proof by a metatheorem (via the metafunction or the hypothesis metafunction) or by a clause processor and the metatheorem or clause processor has a :well-formedness-guarantee then g may not be made untouchable.

    As noted above, macros may not be made directly untouchable; the macro defmacro-untouchable is provided for that purpose. Thus, it is an error to evaluate (push-untouchable F t) if F is already a macro name, and it is also an error to define F as a macro when F has been made an untouchable function using (push-untouchable F t).

    When a symbol is on the untouchables list it is syntactically illegal for any event to call a function of that name, if fn-p is non-nil, or to change the value of a state global variable of that name, if fn-p is nil. Thus, the effect of pushing a function symbol, name, onto untouchables is to prevent any future event from using that symbol as a function, or as a state global variable (according to fn-p). This is generally done to ``fence off'' some primitive function symbol from ``users'' after the developer has used the symbol freely in the development of some higher level mechanism.

    Also see remove-untouchable.