• Top
  • Documentation
  • Books
  • Boolean-reasoning
  • Projects
  • Debugging
  • Std
  • Proof-automation
  • Macro-libraries
  • ACL2
  • Interfacing-tools
    • Io
      • Fmt
      • Msg
      • Cw
      • Set-evisc-tuple
      • Set-iprint
      • Print-control
      • Read-file-into-string
      • Std/io
        • Open-channel-lemmas
        • Std/io/read-char$
        • Std/io/read-object
        • Std/io/open-output-channel
        • Unsound-read
        • Read-string
        • Read-bytes$
        • File-measure
        • Read-bytes$-n
        • Std/io/read-byte$
        • Std/io/open-input-channel
        • Read-file-lines-no-newlines
        • Print-compressed
        • Nthcdr-bytes
        • Read-file-lines
        • Std/io/close-output-channel
        • Read-file-characters
          • Read-char$-all
        • Read-file-bytes
        • Print-legibly
        • Std/io/close-input-channel
        • Read-file-objects
        • Logical-story-of-io
        • Take-bytes
        • Std/io/peek-char$
        • Read-file-characters-rev
        • Read-file-as-string
        • Std/io/write-byte$
        • Std/io/set-serialize-character
        • Std/io/print-object$
        • Std/io/princ$
        • Std/io/read-file-into-string
        • *file-types*
      • Msgp
      • Printing-to-strings
      • Evisc-tuple
      • Output-controls
      • Observation
      • *standard-co*
      • Ppr-special-syms
      • Standard-oi
      • Standard-co
      • Without-evisc
      • Serialize
      • Output-to-file
      • Fmt-to-comment-window
      • 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
    • Defttag
    • Sys-call
    • Save-exec
    • Quicklisp
    • Std/io
      • Open-channel-lemmas
      • Std/io/read-char$
      • Std/io/read-object
      • Std/io/open-output-channel
      • Unsound-read
      • Read-string
      • Read-bytes$
      • File-measure
      • Read-bytes$-n
      • Std/io/read-byte$
      • Std/io/open-input-channel
      • Read-file-lines-no-newlines
      • Print-compressed
      • Nthcdr-bytes
      • Read-file-lines
      • Std/io/close-output-channel
      • Read-file-characters
        • Read-char$-all
      • Read-file-bytes
      • Print-legibly
      • Std/io/close-input-channel
      • Read-file-objects
      • Logical-story-of-io
      • Take-bytes
      • Std/io/peek-char$
      • Read-file-characters-rev
      • Read-file-as-string
      • Std/io/write-byte$
      • Std/io/set-serialize-character
      • Std/io/print-object$
      • Std/io/princ$
      • Std/io/read-file-into-string
      • *file-types*
    • Oslib
    • Bridge
    • Clex
    • Tshell
    • Unsound-eval
    • Hacker
    • ACL2s-interface
    • Startup-banner
    • Command-line
  • Hardware-verification
  • Software-verification
  • Math
  • Testing-utilities

• Std/io

Read-file-characters

Read an entire file into a character-listp.

Signature

(read-file-characters filename state) 
  → 
(mv errmsg/contents state)

Arguments

filename — Guard (stringp filename).

Returns

errmsg/contents — On success: a character-listp that contains all the characters in the file. On failure, e.g., perhaps filename does not exist, a stringp saying that we failed to open the file.

Definitions and Theorems

Function: read-file-characters

(defun read-file-characters (filename state)
  (declare (xargs :stobjs (state)))
  (declare (xargs :guard (stringp filename)))
  (let ((__function__ 'read-file-characters))
    (declare (ignorable __function__))
    (b* ((filename (mbe :logic (if (stringp filename) filename "")
                        :exec filename))
         ((mv channel state)
          (open-input-channel filename
                              :character state))
         ((unless channel)
          (mv (concatenate 'string
                           "Error opening file " filename)
              state))
         ((mv contents state)
          (read-char$-all channel state))
         (state (close-input-channel channel state)))
      (mv contents state))))

Theorem: state-p1-of-read-file-characters

(defthm state-p1-of-read-file-characters
  (implies
       (force (state-p1 state))
       (state-p1 (mv-nth 1
                         (read-file-characters filename state)))))

Theorem: character-listp-of-read-file-characters

(defthm character-listp-of-read-file-characters
  (let ((contents (mv-nth 0
                          (read-file-characters filename state))))
    (equal (character-listp contents)
           (not (stringp contents)))))

Theorem: type-of-read-file-characters

(defthm type-of-read-file-characters
  (or (true-listp (mv-nth 0
                          (read-file-characters filename state)))
      (stringp (mv-nth 0
                       (read-file-characters filename state))))
  :rule-classes :type-prescription)

Subtopics

Read-char$-all

(read-char$-all channel state) reads all remaining characters from a file.