• Top
    • Documentation
    • Books
    • Boolean-reasoning
    • Projects
    • Debugging
    • Community
    • Std
    • Proof-automation
    • Macro-libraries
    • ACL2
    • Interfacing-tools
    • Hardware-verification
      • Gl
      • Esim
      • Vl2014
      • Sv
      • Fgl
      • Vwsim
      • Vl
        • Syntax
        • Loader
          • Preprocessor
            • Vl-iframe
            • Preprocessor-ifdef-minutia
            • Vl-preprocess
            • Vl-preprocess-loop
            • Vl-includeskips
            • Vl-read-until-end-of-define
            • Vl-define-formallist->defaults
            • Vl-define
            • Vl-expand-define
            • Vl-read-include
            • Vl-substitute-into-macro-text
            • Vl-process-ifdef
            • Ppst
            • Vl-read-define-default-text
              • Vl-process-define
              • Preprocessor-include-minutia
              • Vl-trim-for-preproc
              • Vl-line-up-define-formals-and-actuals
              • Vl-process-undef
              • Vl-split-define-text
              • Vl-def-context
              • Vl-process-endif
              • Scan-backward-for-non-whitespace
              • Vl-ifdef-context
              • Scan-backward-for-whitespace
              • Vl-atvl-atts-text
              • Scan-for-non-whitespace
              • Vl-check-remaining-formals-all-have-defaults
              • Vl-process-else
              • Vl-is-compiler-directive-p
              • Vl-includeskips-controller-lookup
              • Vl-ifdef-use-map
              • Vl-defines
              • Vl-def-use-map
              • Vl-nice-bytes
              • Vl-safe-previous-n
              • Vl-safe-next-n
              • Vl-ppst-pad
              • Vl-filename-to-string-literal
              • Vl-maybe-update-filemap
              • *vl-preprocess-clock*
              • Vl-ppst->warnings
              • Vl-ppst->iskips
              • Vl-ppst->ifdefmap
              • Vl-ppst->idcache
              • Vl-istack
              • Vl-ppst->istack
              • Vl-ppst->includes
              • Vl-ppst->filemap
              • Vl-ppst->defmap
              • Vl-ppst->defines
              • Vl-ppst->config
              • Vl-ppst->bytes
              • Vl-ppst->activep
              • Vl-ppst->acc
              • Vl-ppst-record-ifdef-use
              • Vl-ppst-record-def-use
              • Vl-ifdef-context-list
              • Vl-def-context-list
              • Vl-ppst-update-warnings
              • Vl-ppst-update-istack
              • Vl-ppst-update-iskips
              • Vl-ppst-update-includes
              • Vl-ppst-update-ifdefmap
              • Vl-ppst-update-idcache
              • Vl-ppst-update-filemap
              • Vl-ppst-update-defmap
              • Vl-ppst-update-defines
              • Vl-ppst-update-config
              • Vl-ppst-update-activep
              • Vl-ppst-update-bytes
              • Vl-ppst-update-acc
              • Vl-ppst-unsound-nreverse-acc
            • 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-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
    • Preprocessor

    Vl-read-define-default-text

    Signature
    (vl-read-define-default-text echars starting-loc ppst) 
      → 
    (mv successp prefix remainder ppst)
    Arguments
    echars — Text starting just after the equal sign.
        Guard (vl-echarlist-p echars).
    starting-loc — Context for error messages.
        Guard (vl-location-p starting-loc).
    Returns
    successp — Type (booleanp successp).
    prefix — Type (vl-echarlist-p prefix).
    remainder — On success this should start with a comma or endparen.
        Type (vl-echarlist-p remainder).

    Definitions and Theorems

    Function: vl-read-define-default-text

    (defun vl-read-define-default-text (echars starting-loc ppst)
     (declare (xargs :stobjs (ppst)))
     (declare (xargs :guard (and (vl-echarlist-p echars)
                                 (vl-location-p starting-loc))))
     (let ((__function__ 'vl-read-define-default-text))
      (declare (ignorable __function__))
      (b*
       ((echars (vl-echarlist-fix echars))
        ((when (atom echars))
         (let
          ((ppst
                (vl-ppst-fatal
                     :msg "~a0: EOF while reading `define default text."
                     :args (list starting-loc))))
          (mv nil nil echars ppst)))
        (char1 (vl-echar->char (car echars)))
        ((when (or (eql char1 #\,) (eql char1 #\))))
         (mv t nil echars ppst))
        ((when (eql char1 #\\))
         (b*
          (((mv name prefix1 remainder)
            (vl-read-escaped-identifier echars))
           ((unless name)
            (let
             ((ppst
               (vl-ppst-fatal
                 :msg "~a0: stray backslash in define default argument?"
                 :args (list (vl-echar->loc (car echars))))))
             (mv nil nil echars ppst)))
           ((mv okp prefix2 remainder ppst)
            (vl-read-define-default-text remainder starting-loc ppst))
           ((unless okp) (mv nil nil echars ppst)))
          (mv t (append prefix1 prefix2)
              remainder ppst)))
        ((when (eql char1 #\"))
         (b*
          (((mv string prefix1 remainder)
            (vl-read-string echars
                            (vl-lexstate-init (vl-ppst->config))))
           ((unless string)
            (let
             ((ppst
               (vl-ppst-fatal
                :msg
                "~a0: unterminated string literal in `define default argument?"
                :args (list (vl-echar->loc (car echars))))))
             (mv nil nil echars ppst)))
           ((mv okp prefix2 remainder ppst)
            (vl-read-define-default-text remainder starting-loc ppst))
           ((unless okp) (mv nil nil echars ppst)))
          (mv t (append prefix1 prefix2)
              remainder ppst)))
        ((mv okp rest remainder ppst)
         (vl-read-define-default-text (cdr echars)
                                      starting-loc ppst))
        ((unless okp) (mv nil nil echars ppst)))
       (mv t (cons (car echars) rest)
           remainder ppst))))

    Theorem: booleanp-of-vl-read-define-default-text.successp

    (defthm booleanp-of-vl-read-define-default-text.successp
      (b* (((mv ?successp ?prefix ?remainder ?ppst)
            (vl-read-define-default-text echars starting-loc ppst)))
        (booleanp successp))
      :rule-classes :type-prescription)

    Theorem: vl-echarlist-p-of-vl-read-define-default-text.prefix

    (defthm vl-echarlist-p-of-vl-read-define-default-text.prefix
      (b* (((mv ?successp ?prefix ?remainder ?ppst)
            (vl-read-define-default-text echars starting-loc ppst)))
        (vl-echarlist-p prefix))
      :rule-classes :rewrite)

    Theorem: vl-echarlist-p-of-vl-read-define-default-text.remainder

    (defthm vl-echarlist-p-of-vl-read-define-default-text.remainder
      (b* (((mv ?successp ?prefix ?remainder ?ppst)
            (vl-read-define-default-text echars starting-loc ppst)))
        (vl-echarlist-p remainder))
      :rule-classes :rewrite)

    Theorem: true-listp-of-vl-read-define-default-text-prefix

    (defthm true-listp-of-vl-read-define-default-text-prefix
     (true-listp
        (mv-nth 1
                (vl-read-define-default-text echars starting-loc ppst)))
     :rule-classes :type-prescription)

    Theorem: true-listp-of-vl-read-define-default-text-remainder

    (defthm true-listp-of-vl-read-define-default-text-remainder
     (true-listp
        (mv-nth 2
                (vl-read-define-default-text echars starting-loc ppst)))
     :rule-classes :type-prescription)

    Theorem: acl2-count-of-vl-read-define-default-text-weak

    (defthm acl2-count-of-vl-read-define-default-text-weak
     (<=
      (acl2-count
         (mv-nth
              2
              (vl-read-define-default-text echars config starting-loc)))
      (acl2-count (vl-echarlist-fix echars)))
     :rule-classes ((:rewrite) (:linear)))

    Theorem: acl2-count-of-vl-read-define-default-text-strong

    (defthm acl2-count-of-vl-read-define-default-text-strong
     (implies
      (mv-nth 1
              (vl-read-define-default-text echars config starting-loc))
      (<
       (acl2-count
         (mv-nth
              2
              (vl-read-define-default-text echars config starting-loc)))
       (acl2-count (vl-echarlist-fix echars))))
     :rule-classes ((:rewrite) (:linear)))