• Top
    • Documentation
    • Books
    • Recursion-and-induction
    • Boolean-reasoning
    • Projects
    • Debugging
    • Std
    • Proof-automation
    • Macro-libraries
    • ACL2
    • Interfacing-tools
      • Io
        • Fmt
        • Msg
        • Cw
          • Fmt-to-comment-window
            • Cw!
            • Fmt-to-comment-window!
            • Fmt-to-comment-window!+
            • Fmt-to-comment-window+
            • Cw!+
            • Cw+
          • Set-evisc-tuple
          • Set-iprint
          • Print-control
          • Read-file-into-string
          • Msgp
          • Std/io
          • Printing-to-strings
          • Evisc-tuple
          • Output-controls
          • Observation
          • *standard-co*
          • Pp-special-syms
          • Standard-oi
          • Standard-co
          • Without-evisc
          • Serialize
          • Output-to-file
          • Fmt-to-comment-window
            • Character-encoding
            • Princ$
            • Open-output-channel!
            • Cw-print-base-radix
            • Set-print-case
            • Set-print-base
            • Print-object$
            • Fmx-cw
            • Print-object$+
            • Set-print-radix
            • Extend-pathname
            • Set-fmt-hard-right-margin
            • Proofs-co
            • File-write-date$
            • Set-print-base-radix
            • Print-base-p
            • *standard-oi*
            • Wof
            • File-length$
            • Fms!-lst
            • *standard-ci*
            • Write-list
            • Fmt!
            • Fms
            • Delete-file$
            • Cw!
            • Fmt-to-comment-window!
            • Fms!
            • Eviscerate-hide-terms
            • Fmt1!
            • Fmt-to-comment-window!+
            • Read-file-into-byte-array-stobj
            • Fmt1
            • Fmt-to-comment-window+
            • Cw-print-base-radix!
            • Read-file-into-character-array-stobj
            • Cw!+
            • Newline
            • Fmx
            • Cw+
            • Read-object-from-file
            • Set-fmt-soft-right-margin
            • Read-objects-from-file
            • Read-file-into-byte-list
            • Read-file-into-character-list
          • Defttag
          • Sys-call
          • Save-exec
          • Quicklisp
          • Oslib
          • Std/io
          • Bridge
          • Clex
          • Tshell
          • Unsound-eval
          • Hacker
          • Startup-banner
          • Command-line
        • Hardware-verification
        • Software-verification
        • Testing-utilities
        • Math
      • Cw
      • Io
      • ACL2-built-ins

      Fmt-to-comment-window

      Print to the comment window

      General Form:
      (fmt-to-comment-window fmt-string alist col evisc-tuple print-base-radix)

      where these arguments are as described for fmt1 (see fmt) except that the last argument is as described for cw-print-base-radix.

      See cw for important background. Calls of the macro cw expand to calls of the function fmt-to-comment-window whose final three arguments are 0, nil, and nil. For variants of fmt-to-comment-window that provide readable output (suffix "!") and are never inhibited (suffix "+"), see fmt-to-comment-window!, fmt-to-comment-window+, and fmt-to-comment-window!+.

      Function fmt-to-comment-window is similar to fmt1 (see fmt), except that the channel is *standard-co* and the ACL2 state is neither an input nor an output, and moreover, an additional argument specifies the print-base and optionally the print-radix. That additional argument is treated the same as the first argument of cw-print-base-radix; see cw-print-base-radix. An analogous function, fmt-to-comment-window!, prints with fmt! instead of fmt, in order to avoid insertion of backslash (\) characters for margins; also see cw!, a macro that expands to a call of fmt-to-comment-window!. Note that even if you change the value of ld special standard-co (see standard-co), fmt-to-comment-window will print to *standard-co*, which is the original value of standard-co.