• 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
          • Verilog-printing
            • Vl-fmt
            • Vl-ppc-module
            • Vl-pp-expr
            • Vl-maybe-escape-identifier
            • Vl-print-ext-wirename
            • Vl-pp-module
            • Vl-print-wirename
            • Vl-print-loc
            • Vl-print-modname
            • Vl-pp-origexpr
            • Vl-pps-module
              • Vl-pps-expr
              • Vl-ppc-modulelist
              • Vl-ppcs-module
              • Vl-ps-update-show-atts
              • Vl-pps-origexpr
              • Vl-pps-modulelist
              • Vl-ppcs-modulelist
              • Vl-cw-obj
              • Vl-ps->show-atts-p
              • Vl-cw
            • Printing-locally
            • Formatted-printing
            • Accessing-printed-output
            • Vl-printedlist
            • Json-printing
          • Esim-vl
          • Well-formedness
        • Sv
        • Fgl
        • Vwsim
        • Vl
        • X86isa
        • Svl
        • Rtl
      • Software-verification
      • Math
      • Testing-utilities
    • Verilog-printing

    Vl-pps-module

    Pretty-print a module to a plain-text string.

    Signature
    (vl-pps-module x) → str
    Arguments
    x — Guard (vl-module-p x).
    Returns
    str — Type (stringp str).

    (vl-pps-module x) pretty-prints the vl-module-p x into a plain-text string.

    Alternatives:

    • vl-ppcs-module preserves the order of module elements and its comments.
    • vl-pp-module can pretty-print x into a plain-text or HTML string. For proper printing it requires a scopestack.

    Definitions and Theorems

    Function: vl-pps-module

    (defun vl-pps-module (x)
      (declare (xargs :guard (vl-module-p x)))
      (let ((__function__ 'vl-pps-module))
        (declare (ignorable __function__))
        (with-local-ps (vl-pp-module x nil))))

    Theorem: stringp-of-vl-pps-module

    (defthm stringp-of-vl-pps-module
      (b* ((str (vl-pps-module x)))
        (stringp str))
      :rule-classes :type-prescription)

    Theorem: vl-pps-module-of-vl-module-fix-x

    (defthm vl-pps-module-of-vl-module-fix-x
      (equal (vl-pps-module (vl-module-fix x))
             (vl-pps-module x)))

    Theorem: vl-pps-module-vl-module-equiv-congruence-on-x

    (defthm vl-pps-module-vl-module-equiv-congruence-on-x
      (implies (vl-module-equiv x x-equiv)
               (equal (vl-pps-module x)
                      (vl-pps-module x-equiv)))
      :rule-classes :congruence)