• Top
  • Documentation
  • Books
  • Boolean-reasoning
  • Projects
  • Debugging
  • Std
  • Proof-automation
  • Macro-libraries
  • ACL2
  • Interfacing-tools
  • Hardware-verification
    • Gl
    • Esim
    • Vl2014
    • Sv
    • Vwsim
    • Fgl
    • Vl
      • Syntax
      • Loader
        • Preprocessor
        • Vl-loadconfig
        • Vl-loadstate
        • Lexer
        • Parser
        • Vl-load-merge-descriptions
        • Vl-find-basename/extension
        • Vl-load-file
        • Vl-loadresult
        • Scope-of-defines
        • Vl-find-file
        • Vl-flush-out-descriptions
        • Vl-description
        • Vl-read-file
          • Vl-read-file-loop
          • Vl-read-file-loop-aux
          • Vl-read-file-hook
        • Vl-includeskips-report-gather
        • Vl-load-main
        • Extended-characters
        • Vl-load
        • Vl-load-description
        • Vl-descriptions-left-to-load
        • Inject-warnings
        • Vl-preprocess-debug
        • Vl-write-preprocessor-debug-file
        • Vl-read-file-report-gather
        • Vl-load-descriptions
        • Vl-load-files
        • Translate-off
        • Vl-load-read-file-hook
        • Vl-read-file-report
        • Vl-loadstate-pad
        • Vl-load-summary
        • Vl-collect-modules-from-descriptions
        • Vl-loadstate->warnings
        • Vl-iskips-report
        • Vl-descriptionlist
      • Warnings
      • Getting-started
      • Utilities
      • Printer
      • Kit
      • Mlib
      • Transforms
    • X86isa
    • Svl
    • Rtl
  • Software-verification
  • Math
  • Testing-utilities

• Loader

Vl-read-file

Read an entire file into a list of extended characters.

Signature

(vl-read-file filename &key (state 'state)) 
  → 
(mv okp result len state)

Arguments

filename — The file to read.
    Guard (stringp filename).

Returns

okp — Type (booleanp okp).

result — On success, the entire contents of filename as a list of extended-characters.
    Type (vl-echarlist-p result).

len — Type (equal len (len result)).

state — Type (state-p1 state), given (force (state-p1 state)).

We read the file with read-byte$ instead of read-char$, because this seems perhaps to be more reliable. In particular, even if the Lisp system wants to use Unicode or some other encoding for character streams, read-byte$ should always safely return octets.

Definitions and Theorems

Function: vl-read-file-fn

(defun vl-read-file-fn (filename state)
  (declare (xargs :stobjs (state)))
  (declare (xargs :guard (stringp filename)))
  (let ((__function__ 'vl-read-file))
    (declare (ignorable __function__))
    (b* ((filename (string-fix filename))
         ((mv channel state)
          (open-input-channel filename
                              :byte state))
         ((unless channel) (mv nil nil 0 state))
         ((mv data len state)
          (vl-read-file-loop channel filename 1 0))
         (state (close-input-channel channel state))
         (state (vl-read-file-hook filename data len state)))
      (mv t data len state))))

Theorem: booleanp-of-vl-read-file.okp

(defthm booleanp-of-vl-read-file.okp
  (b* (((mv ?okp ?result acl2::?len acl2::?state)
        (vl-read-file-fn filename state)))
    (booleanp okp))
  :rule-classes :type-prescription)

Theorem: vl-echarlist-p-of-vl-read-file.result

(defthm vl-echarlist-p-of-vl-read-file.result
  (b* (((mv ?okp ?result acl2::?len acl2::?state)
        (vl-read-file-fn filename state)))
    (vl-echarlist-p result))
  :rule-classes :rewrite)

Theorem: return-type-of-vl-read-file.len

(defthm return-type-of-vl-read-file.len
  (b* (((mv ?okp ?result acl2::?len acl2::?state)
        (vl-read-file-fn filename state)))
    (equal len (len result)))
  :rule-classes :rewrite)

Theorem: state-p1-of-vl-read-file.state

(defthm state-p1-of-vl-read-file.state
  (implies (force (state-p1 state))
           (b* (((mv ?okp ?result acl2::?len acl2::?state)
                 (vl-read-file-fn filename state)))
             (state-p1 state)))
  :rule-classes :rewrite)

Theorem: true-listp-of-vl-read-file

(defthm true-listp-of-vl-read-file
  (true-listp (mv-nth 1 (vl-read-file filename)))
  :rule-classes :type-prescription)

Theorem: vl-read-file-when-error

(defthm vl-read-file-when-error
  (b* (((mv okp result ?state)
        (vl-read-file filename)))
    (implies (not okp) (not result))))

Subtopics

Vl-read-file-loop

Logically nice loop for vl-read-file.

Vl-read-file-loop-aux

Tail-recursive, executable loop for vl-read-file.

Vl-read-file-hook

Customizable hook for vl-read-file.