• 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
          • Parse-expressions
          • Parse-udps
          • Parse-statements
          • Parse-property
          • Vl-genelements
          • Parse-paramdecls
          • Parse-blockitems
          • Parse-utils
          • Parse-insts
          • Parse-functions
          • Parse-assignments
          • Parse-clocking
          • Parse-strengths
          • Vl-parse-genvar-declaration
          • Vl-parse
          • Parse-netdecls
          • Parse-asserts
          • Vl-maybe-parse-lifetime
          • Parse-dpi-import-export
          • Parse-ports
          • Parse-timeunits
          • Seq
          • Parse-packages
          • Parse-eventctrl
        • 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-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

• Parser

Vl-parse

Top level parsing function.

Signature

(vl-parse tokens pstate config) → (mv successp items pstate)

Arguments

tokens — Guard (vl-tokenlist-p tokens).

pstate — Guard (vl-parsestate-p pstate).

config — Guard (vl-loadconfig-p config).

Returns

successp — Type (booleanp successp).

items — Type (vl-descriptionlist-p items), given the guard.

pstate — Type (vl-parsestate-p pstate).

Definitions and Theorems

Function: vl-parse

(defun vl-parse (tokens pstate config)
  (declare (xargs :guard (and (vl-tokenlist-p tokens)
                              (vl-parsestate-p pstate)
                              (vl-loadconfig-p config))))
  (let ((__function__ 'vl-parse))
    (declare (ignorable __function__))
    (b* (((local-stobjs tokstream)
          (mv okp val pstate tokstream))
         (tokstream (vl-tokstream-update-tokens tokens))
         (tokstream (vl-tokstream-update-pstate pstate))
         ((mv err items tokstream)
          (vl-parse-source-text))
         ((when err)
          (b* ((tokstream (vl-tokstream-add-warning err))
               (pstate (vl-tokstream->pstate)))
            (mv nil nil pstate tokstream)))
         (pstate (vl-tokstream->pstate)))
      (mv t items pstate tokstream))))

Theorem: booleanp-of-vl-parse.successp

(defthm booleanp-of-vl-parse.successp
  (b* (((mv ?successp ?items ?pstate)
        (vl-parse tokens pstate config)))
    (booleanp successp))
  :rule-classes :type-prescription)

Theorem: vl-descriptionlist-p-of-vl-parse.items

(defthm vl-descriptionlist-p-of-vl-parse.items
  (implies (and (force (vl-tokenlist-p tokens))
                (force (vl-parsestate-p pstate))
                (force (vl-loadconfig-p config)))
           (b* (((mv ?successp ?items ?pstate)
                 (vl-parse tokens pstate config)))
             (vl-descriptionlist-p items)))
  :rule-classes :rewrite)

Theorem: vl-parsestate-p-of-vl-parse.pstate

(defthm vl-parsestate-p-of-vl-parse.pstate
  (b* (((mv ?successp ?items ?pstate)
        (vl-parse tokens pstate config)))
    (vl-parsestate-p pstate))
  :rule-classes :rewrite)