• Top
  • Documentation
  • Books
  • Boolean-reasoning
  • Projects
  • Debugging
  • Std
  • Proof-automation
  • Macro-libraries
  • ACL2
  • Interfacing-tools
  • Hardware-verification
    • Gl
    • Esim
    • Vl2014
    • Sv
    • Vwsim
    • Fgl
    • Vl
      • Syntax
      • Loader
      • Warnings
      • Getting-started
      • Utilities
      • Printer
        • Ps
        • Verilog-printing
        • Basic-printing
        • Printing-locally
        • Formatted-printing
        • Accessing-printed-output
          • Vl-print-to-file
            • Vl-print-to-file-and-clear
          • Vl-ps->chars
          • Vl-ps->string
          • With-ps-file
        • Json-printing
        • Vl-printedlist
      • Kit
      • Mlib
      • Transforms
    • X86isa
    • Svl
    • Rtl
  • Software-verification
  • Math
  • Testing-utilities

• Vl-print-to-file

Vl-print-to-file-and-clear

Write the printed characters to a file and clear out the ps.

Signature

(vl-print-to-file-and-clear filename &key (ps 'ps) (state 'state)) 
  → 
(mv ps state)

Arguments

filename — Guard (stringp filename).

Returns

state — Type (state-p1 state), given (force (state-p1 state)).

This is similar to vl-print-to-file except that it also clears out the characters in ps. This allows us to optimize this function under the hood in various ways that wouldn't be sound for vl-print-to-file.

Definitions and Theorems

Function: vl-print-to-file-and-clear-fn

(defun vl-print-to-file-and-clear-fn (filename ps state)
  (declare (xargs :stobjs (ps state)))
  (declare (xargs :guard (stringp filename)))
  (let ((__function__ 'vl-print-to-file-and-clear))
    (declare (ignorable __function__))
    (b* ((filename (string-fix filename))
         ((mv channel state)
          (open-output-channel! filename
                                :character state))
         ((unless channel)
          (raise "Error opening file ~s0 for writing."
                 filename)
          (mv ps state))
         (rchars (vl-ps->rchars))
         (ps (vl-ps-update-rchars nil))
         (ps (vl-ps-update-col 0))
         (state (princ$ (str::printtree->str rchars)
                        channel state))
         (state (close-output-channel channel state)))
      (mv ps state))))

Theorem: state-p1-of-vl-print-to-file-and-clear.state

(defthm state-p1-of-vl-print-to-file-and-clear.state
  (implies (force (state-p1 state))
           (b* (((mv ?ps acl2::?state)
                 (vl-print-to-file-and-clear-fn filename ps state)))
             (state-p1 state)))
  :rule-classes :rewrite)

Theorem: vl-print-to-file-and-clear-fn-of-str-fix-filename

(defthm vl-print-to-file-and-clear-fn-of-str-fix-filename
  (equal (vl-print-to-file-and-clear-fn (str-fix filename)
                                        ps state)
         (vl-print-to-file-and-clear-fn filename ps state)))

Theorem: vl-print-to-file-and-clear-fn-streqv-congruence-on-filename

(defthm vl-print-to-file-and-clear-fn-streqv-congruence-on-filename
 (implies
    (streqv filename filename-equiv)
    (equal (vl-print-to-file-and-clear-fn filename ps state)
           (vl-print-to-file-and-clear-fn filename-equiv ps state)))
 :rule-classes :congruence)