• Top
  • Documentation
  • Books
  • Boolean-reasoning
  • Projects
  • Debugging
  • Std
  • Proof-automation
  • Macro-libraries
  • ACL2
  • Interfacing-tools
  • Hardware-verification
    • Gl
    • Esim
    • Vl2014
      • Warnings
      • Primitives
      • Use-set
      • Syntax
      • Getting-started
      • Utilities
      • Loader
      • Transforms
      • Lint
      • Mlib
      • Server
      • Kit
      • Printer
        • Ps
        • Basic-printing
          • Vl-println?
          • Vl-print
          • Vl-printable-p
          • Vl-col-after-printing-string
          • Vl-col-after-printing-chars
          • Vl-print-strings-with-commas
          • Vl-string-needs-html-encoding-p
          • Vl-println-markup
          • Vl-print-strings-as-lines
          • Vl-print-url
          • Vl-print-nat
          • Vl-indent
          • Vl-println
          • Vl-print-markup
          • Vl-ps-seq
          • Vl-cw-ps-seq
          • Vl-when-html
          • Vl-ps-span
        • Verilog-printing
        • Printing-locally
        • Formatted-printing
        • Accessing-printed-output
        • Vl-printedlist
        • Json-printing
      • Esim-vl
      • Well-formedness
    • Sv
    • Vwsim
    • Fgl
    • Vl
    • X86isa
    • Svl
    • Rtl
  • Software-verification
  • Math
  • Testing-utilities

• Basic-printing

Vl-println?

(vl-println? x &key (ps 'ps)) prints text with automatic encoding, and may also inserts a newline if we have gone past the autowrap-col.

Signature

(vl-println? x &key (ps 'ps)) → ps

Arguments

x — Guard (vl-printable-p x).

This function is like vl-print, except that after x is printed, we check to see whether the current col exceeds the autowrap-col for ps. If so, we insert a newline (and, in HTML mode, a <br/> tag) as in vl-println, and indent the next line to the column specified by the ps's autowrap-ind.

When writing pretty-printers, it is useful to call this function in places that would be acceptable line-break points, so that very long lines will be split up at reasonably good places.

Definitions and Theorems

Function: vl-println?-fn

(defun vl-println?-fn (x ps)
 (declare (xargs :stobjs (ps)))
 (declare (xargs :guard (vl-printable-p x)))
 (let ((__function__ 'vl-println?))
  (declare (ignorable __function__))
  (let* ((rchars (vl-ps->rchars))
         (col (vl-ps->col))
         (htmlp (vl-ps->htmlp))
         (autowrap-col (vl-ps->autowrap-col))
         (x (vl-printable-fix x))
         (x (cond ((stringp x) x)
                  ((atom x) (explode-atom x 10))
                  (t x))))
    (if htmlp
     (b*
       ((tabsize (vl-ps->tabsize))
        ((mv col rchars)
         (if (stringp x)
             (vl-html-encode-string-aux x 0 (length x)
                                        col tabsize rchars)
           (vl-html-encode-chars-aux x col tabsize rchars)))
        ((when (< col autowrap-col))
         (vl-ps-seq (vl-ps-update-rchars rchars)
                    (vl-ps-update-col col)))
        (indent (vl-ps->autowrap-ind))
        (rchars (revappend *vl-html-newline* rchars))
        (rchars (repeated-revappend indent *vl-html-&nbsp* rchars)))
       (vl-ps-seq (vl-ps-update-rchars rchars)
                  (vl-ps-update-col indent)))
     (b* ((col (if (stringp x)
                   (vl-col-after-printing-string col x)
                 (vl-col-after-printing-chars col x)))
          (rchars (if (stringp x)
                      (cons x rchars)
                    (revappend x rchars)))
          ((when (< col autowrap-col))
           (vl-ps-seq (vl-ps-update-rchars rchars)
                      (vl-ps-update-col col)))
          (indent (vl-ps->autowrap-ind))
          (rchars (cons #\Newline rchars))
          (rchars (make-list-ac indent #\Space rchars)))
       (vl-ps-seq (vl-ps-update-rchars rchars)
                  (vl-ps-update-col indent)))))))

Theorem: vl-println?-fn-of-vl-printable-fix-x

(defthm vl-println?-fn-of-vl-printable-fix-x
  (equal (vl-println?-fn (vl-printable-fix x) ps)
         (vl-println?-fn x ps)))

Theorem: vl-println?-fn-vl-printable-equiv-congruence-on-x

(defthm vl-println?-fn-vl-printable-equiv-congruence-on-x
  (implies (vl-printable-equiv x x-equiv)
           (equal (vl-println?-fn x ps)
                  (vl-println?-fn x-equiv ps)))
  :rule-classes :congruence)