• 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
            • Defparser
            • Vl-endinfo-p
            • Vl-match-token
            • Vl-match-some-token
            • Vl-match-any-except
            • Vl-parse-error
            • Vl-match
            • Vl-type-of-matched-token
            • Vl-tokstream-backup-p
            • Vl-maybe-match-token
            • Vl-parse-warning
            • Vl-match-any
            • Vl-linestart-indent
            • Vl-current-loc
            • Vl-choose-parse-error
            • Vl-parse-endblock-name
            • Vl-tokenlist-fix
            • Vl-lookahead-is-some-token?
            • Vl-tokstream-fix
            • Vl-is-token?
            • Vl-is-some-token?
            • Vl-add-context-to-parser-warning
            • Vl-lookahead-is-token?
            • Vl-tokstream-save
            • Vl-tokstream->tokens
            • Vl-tokstream-restore
            • Vl-tokstream-add-warning
            • Vl-tokstream->pstate
            • Vl-tokstream->position
            • Expand-defparsers
            • Vl-tokstream-pop
            • *vl-default-token*
          • 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

• Parse-utils

Vl-parse-error

Compatible with seq. Produce an error message (stopping execution) that includes the current location.

Signature

(vl-parse-error description 
                &key (function '__function__) 
                (tokstream 'tokstream)) 
 
  → 
(mv errmsg value new-tokstream)

Arguments

description — Short description of what went wrong.
    Guard (stringp description).

function — Guard (symbolp function).

Returns

errmsg — Note that such a warning is not automatically extended with ``nearby'' context, because for backtracking these are often ephemeral.
    Type (vl-warning-p errmsg).

value — Always just nil.
    Type (equal value nil).

new-tokstream — Type (equal new-tokstream tokstream).

Definitions and Theorems

Function: vl-parse-error-fn

(defun vl-parse-error-fn (description function tokstream)
 (declare (xargs :stobjs (tokstream)))
 (declare (xargs :guard (and (stringp description)
                             (symbolp function))))
 (let ((__function__ 'vl-parse-error))
  (declare (ignorable __function__))
  (b*
   ((tokens (vl-tokstream->tokens))
    (warning
       (make-vl-warning :type :vl-parse-error
                        :msg "Parse error at ~a0: ~s1"
                        :args (list (if (consp tokens)
                                        (vl-token->loc (car tokens))
                                      "EOF")
                                    description)
                        :fn function
                        :fatalp t)))
   (mv warning nil tokstream))))

Theorem: vl-warning-p-of-vl-parse-error.errmsg

(defthm vl-warning-p-of-vl-parse-error.errmsg
  (b* (((mv ?errmsg acl2::?value ?new-tokstream)
        (vl-parse-error-fn description function tokstream)))
    (vl-warning-p errmsg))
  :rule-classes :rewrite)

Theorem: return-type-of-vl-parse-error.value

(defthm return-type-of-vl-parse-error.value
  (b* (((mv ?errmsg acl2::?value ?new-tokstream)
        (vl-parse-error-fn description function tokstream)))
    (equal value nil))
  :rule-classes :rewrite)

Theorem: return-type-of-vl-parse-error.new-tokstream

(defthm return-type-of-vl-parse-error.new-tokstream
  (b* (((mv ?errmsg acl2::?value ?new-tokstream)
        (vl-parse-error-fn description function tokstream)))
    (equal new-tokstream tokstream))
  :rule-classes :rewrite)

Theorem: vl-parse-error-0-under-iff

(defthm vl-parse-error-0-under-iff
  (b* (((mv ?errmsg acl2::?value ?new-tokstream)
        (vl-parse-error-fn description function tokstream)))
    (iff errmsg t))
  :rule-classes :rewrite)