• Top
    • Documentation
    • Books
    • Boolean-reasoning
    • Projects
    • Debugging
    • Community
    • Std
    • Proof-automation
    • Macro-libraries
    • ACL2
      • Theories
      • Rule-classes
      • Proof-builder
      • Recursion-and-induction
      • Hons-and-memoization
      • Events
      • Parallelism
      • History
      • Programming
        • Defun
        • Declare
        • System-utilities
        • Stobj
        • State
          • World
          • 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
              • Std/io
              • Msgp
              • Printing-to-strings
              • Evisc-tuple
              • Output-controls
              • Observation
              • *standard-co*
              • Standard-co
              • Ppr-special-syms
              • Standard-oi
              • Without-evisc
              • Serialize
              • Fmt-to-comment-window
                • Output-to-file
                • Princ$
                • Character-encoding
                • Open-output-channel!
                • Cw-print-base-radix
                • Set-print-case
                • Set-print-base
                • Print-object$
                • Extend-pathname
                • Print-object$+
                • Fmx-cw
                • Set-print-radix
                • Set-fmt-hard-right-margin
                • File-write-date$
                • Proofs-co
                • Set-print-base-radix
                • Print-base-p
                • *standard-oi*
                • Wof
                • File-length$
                • Fms!-lst
                • Delete-file$
                • *standard-ci*
                • Write-list
                • Trace-co
                • Fmt!
                • Fms
                • 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
                • Fmx
                • Cw!+
                • Read-objects-from-book
                • Newline
                • Cw+
                • Probe-file
                • Write-objects-to-file!
                • Write-objects-to-file
                • Read-objects-from-file
                • Read-object-from-file
                • Read-file-into-byte-list
                • Set-fmt-soft-right-margin
                • Read-file-into-character-list
                • Io-utilities
              • Wormhole
              • Programming-with-state
              • W
              • Set-state-ok
              • Random$
            • Mutual-recursion
            • Memoize
            • Mbe
            • 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
                • Std/io
                • Msgp
                • Printing-to-strings
                • Evisc-tuple
                • Output-controls
                • Observation
                • *standard-co*
                • Standard-co
                • Ppr-special-syms
                • Standard-oi
                • Without-evisc
                • Serialize
                • Fmt-to-comment-window
                  • Output-to-file
                  • Princ$
                  • Character-encoding
                  • Open-output-channel!
                  • Cw-print-base-radix
                  • Set-print-case
                  • Set-print-base
                  • Print-object$
                  • Extend-pathname
                  • Print-object$+
                  • Fmx-cw
                  • Set-print-radix
                  • Set-fmt-hard-right-margin
                  • File-write-date$
                  • Proofs-co
                  • Set-print-base-radix
                  • Print-base-p
                  • *standard-oi*
                  • Wof
                  • File-length$
                  • Fms!-lst
                  • Delete-file$
                  • *standard-ci*
                  • Write-list
                  • Trace-co
                  • Fmt!
                  • Fms
                  • 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
                  • Fmx
                  • Cw!+
                  • Read-objects-from-book
                  • Newline
                  • Cw+
                  • Probe-file
                  • Write-objects-to-file!
                  • Write-objects-to-file
                  • Read-objects-from-file
                  • Read-object-from-file
                  • Read-file-into-byte-list
                  • Set-fmt-soft-right-margin
                  • Read-file-into-character-list
                  • Io-utilities
                • Defpkg
                • Apply$
                • Loop$
                • Programming-with-state
                • Arrays
                • Characters
                • Time$
                • Defconst
                • Fast-alists
                • Defmacro
                • Loop$-primer
                • Evaluation
                • Guard
                • Equality-variants
                • Compilation
                • Hons
                • ACL2-built-ins
                • Developers-guide
                • System-attachments
                • Advanced-features
                • Set-check-invariant-risk
                • Numbers
                • Efficiency
                • Irrelevant-formals
                • Introduction-to-programming-in-ACL2-for-those-who-know-lisp
                • Redefining-programs
                • Lists
                • Invariant-risk
                • Errors
                • Defabbrev
                • Conses
                • Alists
                • Set-register-invariant-risk
                • Strings
                • Program-wrapper
                • Get-internal-time
                • Basics
                • Packages
                • Oracle-eval
                • Defmacro-untouchable
                • <<
                • Primitive
                • Revert-world
                • Unmemoize
                • Set-duplicate-keys-action
                • Symbols
                • Def-list-constructor
                • Easy-simplify-term
                • Defiteration
                • Fake-oracle-eval
                • Defopen
                • Sleep
              • Operational-semantics
              • Real
              • Start-here
              • Miscellaneous
              • Output-controls
              • Bdd
              • Macros
              • Installation
              • Mailing-lists
            • Interfacing-tools
            • Hardware-verification
            • Software-verification
            • Math
            • Testing-utilities
          • 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.