• 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
          • Lex-strings
          • Lex-identifiers
          • Vl-typo-uppercase-p
          • Vl-typo-number-p
          • Vl-typo-lowercase-p
          • Lex-numbers
          • Chartypes
          • Vl-lex
            • Vl-lex-token1
              • Vl-lex-token1-token/remainder-thms
            • Vl-lex-1step-or-number
            • Vl-lex-timescale
            • Vl-lex-plain
            • Vl-lex-plain-alist
            • Vl-lex-token
            • Vl-lex-main
            • Vl-lex-main-exec
          • Defchar
          • Tokens
          • Lex-keywords
          • Lexstate
          • Make-test-tokens
          • Lexer-utils
          • Lex-comments
          • Vl-typo-uppercase-list-p
          • Vl-typo-lowercase-list-p
          • Vl-typo-number-list-p
        • 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-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

• Vl-lex

Vl-lex-token1

Try to parse a single token at the front of echars.

Signature

(vl-lex-token1 char1 echars breakp st warnings) 
  → 
(mv token/nil remainder warnings)

Arguments

char1 — The first character in the stream. It helps a lot with guard verification to have this separate from echars.
    Guard (characterp char1).

echars — The characters we're lexing.
    Guard (and (vl-echarlist-p echars) (consp echars)).

breakp — Are we starting a new line?.
    Guard (booleanp breakp).

st — Low-level configuration options.
    Guard (vl-lexstate-p st).

warnings — Guard (vl-warninglist-p warnings).

Returns

warnings — Type (vl-warninglist-p warnings).

Definitions and Theorems

Function: vl-lex-token1$inline

(defun vl-lex-token1$inline (char1 echars breakp st warnings)
 (declare (xargs :guard (and (characterp char1)
                             (and (vl-echarlist-p echars)
                                  (consp echars))
                             (booleanp breakp)
                             (vl-lexstate-p st)
                             (vl-warninglist-p warnings))))
 (declare (ignorable breakp))
 (declare (xargs :guard (eql char1 (vl-echar->char (car echars)))))
 (let ((__function__ 'vl-lex-token1))
  (declare (ignorable __function__))
  (if
   (char<= char1 #\9)
   (b* (((when (vl-whitespace-p char1))
         (b* (((mv prefix remainder)
               (vl-read-while-whitespace echars)))
           (mv (make-vl-plaintoken :etext prefix
                                   :type :vl-ws)
               remainder (ok))))
        ((when (vl-decimal-digit-p char1))
         (vl-lex-1step-or-number echars breakp st warnings)))
    (case
     char1
     (#\!
         (vl-lex-plain-alist echars breakp (vl-lexstate->bangops st)
                             warnings))
     (#\" (mv-let (tok rem)
                  (vl-lex-string echars breakp st)
            (mv tok rem (ok))))
     (#\#
        (vl-lex-plain-alist echars breakp (vl-lexstate->poundops st)
                            warnings))
     (#\$ (b* (((mv tok remainder)
                (vl-lex-system-identifier
                     echars
                     breakp (vl-lexstate->dollarops st))))
            (mv tok remainder (ok))))
     (#\% (vl-lex-plain-alist echars breakp (vl-lexstate->remops st)
                              warnings))
     (#\& (vl-lex-plain-alist echars breakp (vl-lexstate->andops st)
                              warnings))
     (#\' (b* (((mv tok remainder warnings)
                (vl-lex-number echars breakp st warnings))
               ((when tok) (mv tok remainder warnings))
               ((unless (vl-lexstate->quotesp st))
                (mv nil remainder warnings)))
            (vl-lex-plain echars breakp "'"
                          :vl-quote warnings)))
     (#\( (vl-lex-plain-alist echars breakp
                              '(("(*" . :vl-beginattr)
                                ("(" . :vl-lparen))
                              warnings))
     (#\) (vl-lex-plain echars breakp ")"
                        :vl-rparen warnings))
     (#\*
         (vl-lex-plain-alist echars breakp (vl-lexstate->starops st)
                             warnings))
     (#\+
         (vl-lex-plain-alist echars breakp (vl-lexstate->plusops st)
                             warnings))
     (#\, (vl-lex-plain echars breakp ","
                        :vl-comma warnings))
     (#\-
         (vl-lex-plain-alist echars breakp (vl-lexstate->dashops st)
                             warnings))
     (#\. (vl-lex-plain-alist echars breakp (vl-lexstate->dotops st)
                              warnings))
     (#\/
      (cond
       ((vl-matches-string-p "//" echars)
        (mv-let (tok rem)
                (vl-lex-oneline-comment echars)
          (mv tok rem (ok))))
       ((vl-matches-string-p "/*" echars)
        (mv-let (tok rem)
                (vl-lex-block-comment echars)
          (mv tok rem (ok))))
       (t (vl-lex-plain-alist echars breakp (vl-lexstate->divops st)
                              warnings))))
     (otherwise (mv nil echars (ok)))))
   (if (vl-simple-id-head-p char1)
       (mv-let (tok rem)
               (vl-lex-simple-identifier-or-keyword
                    echars
                    breakp (vl-lexstate->kwdtable st))
         (mv tok rem (ok)))
    (case
     char1
     (#\:
      (if (vl-matches-string-p "://" echars)
          (mv (make-vl-plaintoken :etext (list (car echars))
                                  :type :vl-colon
                                  :breakp breakp)
              (cdr echars)
              (ok))
        (vl-lex-plain-alist echars breakp (vl-lexstate->colonops st)
                            warnings)))
     (#\; (vl-lex-plain echars breakp ";"
                        :vl-semi warnings))
     (#\<
         (vl-lex-plain-alist echars breakp (vl-lexstate->lessops st)
                             warnings))
     (#\= (vl-lex-plain-alist echars breakp (vl-lexstate->eqops st)
                              warnings))
     (#\> (vl-lex-plain-alist echars breakp (vl-lexstate->gtops st)
                              warnings))
     (#\? (vl-lex-plain echars breakp "?"
                        :vl-qmark warnings))
     (#\@ (vl-lex-plain echars breakp "@"
                        :vl-atsign warnings))
     (#\[ (vl-lex-plain echars breakp "["
                        :vl-lbrack warnings))
     (#\\ (mv-let (tok rem)
                  (vl-lex-escaped-identifier echars breakp)
            (mv tok rem (ok))))
     (#\] (vl-lex-plain echars breakp "]"
                        :vl-rbrack warnings))
     (#\^ (vl-lex-plain-alist echars breakp (vl-lexstate->xorops st)
                              warnings))
     (#\{ (vl-lex-plain echars breakp "{"
                        :vl-lcurly warnings))
     (#\| (vl-lex-plain-alist echars breakp (vl-lexstate->barops st)
                              warnings))
     (#\} (vl-lex-plain echars breakp "}"
                        :vl-rcurly warnings))
     (#\~ (vl-lex-plain-alist echars breakp
                              '(("~&" . :vl-nand)
                                ("~|" . :vl-nor)
                                ("~^" . :vl-xnor)
                                ("~" . :vl-bitnot))
                              warnings))
     (#\` (b* (((mv tok remainder)
                (vl-lex-timescale echars)))
            (mv tok remainder (ok))))
     (otherwise (mv nil echars (ok))))))))

Theorem: vl-warninglist-p-of-vl-lex-token1.warnings

(defthm vl-warninglist-p-of-vl-lex-token1.warnings
  (b* (((mv ?token/nil ?remainder ?warnings)
        (vl-lex-token1$inline char1 echars breakp st warnings)))
    (vl-warninglist-p warnings))
  :rule-classes :rewrite)

Theorem: vl-token-p-of-vl-lex-token1

(defthm vl-token-p-of-vl-lex-token1
 (implies
  (and (force (vl-echarlist-p echars))
       (and (force (consp echars))
            (force (equal char1 (vl-echar->char (car echars))))
            (force (booleanp breakp))
            (force (vl-lexstate-p st))))
  (equal
      (vl-token-p
           (mv-nth 0
                   (vl-lex-token1 char1 echars breakp st warnings)))
      (if (mv-nth 0
                  (vl-lex-token1 char1 echars breakp st warnings))
          t
        nil))))

Theorem: true-listp-of-vl-lex-token1

(defthm true-listp-of-vl-lex-token1
 (equal
      (true-listp
           (mv-nth 1
                   (vl-lex-token1 char1 echars breakp st warnings)))
      (true-listp echars))
 :rule-classes
 ((:rewrite)
  (:type-prescription
   :corollary
   (implies
    (true-listp echars)
    (true-listp
       (mv-nth 1
               (vl-lex-token1 char1 echars breakp st warnings)))))))

Theorem: vl-echarlist-p-of-vl-lex-token1

(defthm vl-echarlist-p-of-vl-lex-token1
 (implies
  (force (vl-echarlist-p echars))
  (equal
      (vl-echarlist-p
           (mv-nth 1
                   (vl-lex-token1 char1 echars breakp st warnings)))
      t)))

Theorem: append-of-vl-lex-token1

(defthm append-of-vl-lex-token1
 (implies
  (and (mv-nth 0
               (vl-lex-token1 char1 echars breakp st warnings))
       (force (vl-echarlist-p echars))
       (and (force (consp echars))
            (force (equal char1 (vl-echar->char (car echars))))
            (force (booleanp breakp))
            (force (vl-lexstate-p st))))
  (equal
   (append
      (vl-token->etext
           (mv-nth 0
                   (vl-lex-token1 char1 echars breakp st warnings)))
      (mv-nth 1
              (vl-lex-token1 char1 echars breakp st warnings)))
   echars)))

Theorem: no-change-loser-of-vl-lex-token1

(defthm no-change-loser-of-vl-lex-token1
 (implies
     (not (mv-nth 0
                  (vl-lex-token1 char1 echars breakp st warnings)))
     (equal (mv-nth 1
                    (vl-lex-token1 char1 echars breakp st warnings))
            echars)))

Theorem: acl2-count-of-vl-lex-token1-weak

(defthm acl2-count-of-vl-lex-token1-weak
  (<= (acl2-count
           (mv-nth 1
                   (vl-lex-token1 char1 echars breakp st warnings)))
      (acl2-count echars))
  :rule-classes ((:rewrite) (:linear)))

Theorem: acl2-count-of-vl-lex-token1-strong

(defthm acl2-count-of-vl-lex-token1-strong
 (implies
   (and (mv-nth 0
                (vl-lex-token1 char1 echars breakp st warnings))
        (force (equal char1 (vl-echar->char (car echars)))))
   (< (acl2-count
           (mv-nth 1
                   (vl-lex-token1 char1 echars breakp st warnings)))
      (acl2-count echars)))
 :rule-classes ((:rewrite) (:linear)))

Subtopics

Vl-lex-token1-token/remainder-thms

Token and remainder theorems for vl-lex-token1, automatically generated by def-token/remainder-thms.