• Top
  • Documentation
  • Books
  • Recursion-and-induction
  • Boolean-reasoning
  • Projects
  • Debugging
  • Std
  • Proof-automation
  • Macro-libraries
  • ACL2
  • Interfacing-tools
  • Hardware-verification
    • Gl
    • Esim
    • Vl2014
      • Warnings
      • Primitives
      • Use-set
      • Syntax
      • Getting-started
      • Utilities
      • Loader
        • Preprocessor
        • Vl-loadconfig
        • Lexer
        • Vl-loadstate
        • Parser
        • Vl-load-merge-descriptions
        • Scope-of-defines
        • Vl-load-file
        • Vl-flush-out-descriptions
        • Vl-description
        • Vl-loadresult
        • Vl-read-file
        • Vl-find-basename/extension
        • Vl-read-files
          • Vl-read-files-aux
        • Vl-find-file
        • Extended-characters
        • Vl-load
        • Vl-load-main
        • Vl-load-description
        • Vl-descriptions-left-to-load
        • Inject-warnings
        • Vl-load-descriptions
        • Vl-load-files
        • Vl-load-summary
        • Vl-collect-modules-from-descriptions
        • Vl-descriptionlist
      • Transforms
      • Lint
      • Mlib
      • Server
      • Kit
      • Printer
      • Esim-vl
      • Well-formedness
    • Sv
    • Vwsim
    • Fgl
    • Vl
    • X86isa
    • Svl
    • Rtl
  • Software-verification
  • Testing-utilities
  • Math

• Loader

Vl-read-files

Read an entire list of files into a list of extended characters.

Signature

(vl-read-files filenames &key (state 'state)) 
  → 
(mv errmsg? data state)

Arguments

filenames — The files to read.
    Guard (string-listp filenames).

Returns

errmsg? — NIL on success, or an error msg that says which file we were unable to read, otherwise.

data — On success, extended characters from all files, in order.
    Type (vl-echarlist-p data), given the guard.

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

Definitions and Theorems

Function: vl-read-files-fn

(defun
 vl-read-files-fn (filenames state)
 (declare (xargs :stobjs (state)))
 (declare (xargs :guard (string-listp filenames)))
 (let
  ((__function__ 'vl-read-files))
  (declare (ignorable __function__))
  (mbe
      :logic (b* (((when (atom filenames))
                   (mv nil nil state))
                  ((mv okp first state)
                   (vl-read-file (car filenames)))
                  ((unless okp)
                   (mv (msg "Error reading file ~s0."
                            (car filenames))
                       nil state))
                  ((mv okp rest state)
                   (vl-read-files (cdr filenames))))
                 (mv okp (append first rest) state))
      :exec (with-local-stobj
                 nrev
                 (mv-let (errmsg echars nrev state)
                         (b* (((mv errmsg nrev state)
                               (vl-read-files-aux filenames nrev))
                              ((mv echars nrev) (nrev-finish nrev)))
                             (mv errmsg echars nrev state))
                         (mv errmsg echars state))))))

Theorem: vl-echarlist-p-of-vl-read-files.data

(defthm vl-echarlist-p-of-vl-read-files.data
        (implies (and (force (state-p state))
                      (force (string-listp filenames)))
                 (b* (((mv ?errmsg? ?data acl2::?state)
                       (vl-read-files-fn filenames state)))
                     (vl-echarlist-p data)))
        :rule-classes :rewrite)

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

(defthm state-p1-of-vl-read-files.state
        (implies (force (state-p1 state))
                 (b* (((mv ?errmsg? ?data acl2::?state)
                       (vl-read-files-fn filenames state)))
                     (state-p1 state)))
        :rule-classes :rewrite)

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

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

Theorem: vl-read-files-aux-redef

(defthm vl-read-files-aux-redef
        (equal (vl-read-files-aux filenames acc)
               (b* (((mv errmsg data state)
                     (vl-read-files filenames)))
                   (mv errmsg (append acc data) state))))

Subtopics

Vl-read-files-aux

Tail recursive loop for vl-read-files.