• Top
  • Documentation
  • Books
  • Recursion-and-induction
  • Boolean-reasoning
  • Projects
  • Debugging
  • Std
    • Std/lists
    • Std/alists
    • Obags
    • Std/util
    • Std/strings
    • 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
      • Print-compressed
      • Read-file-lines-no-newlines
      • 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*
    • Std/osets
    • Std/system
    • Std/basic
    • Std/typed-lists
    • Std/bitsets
    • Std/testing
    • Std/typed-alists
    • Std/stobjs
    • Std-extensions
  • Proof-automation
  • Macro-libraries
  • ACL2
  • Interfacing-tools
  • Hardware-verification
  • Software-verification
  • Testing-utilities
  • Math

• 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.