• Top
    • Documentation
    • Books
    • Boolean-reasoning
    • Projects
    • Debugging
    • Std
    • Community
    • 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-parse-define-formal-arguments
            • 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-split-define-text

Split up the rest of a define line into macro arguments and macro text.

Signature
(vl-split-define-text text ppst) 
  → 
(mv successp formals body ppst)
Arguments
text — The text that occurs after `define foo, perhaps including any macro arguments such as (a,b) in the case of macros such as `define max(a,b) ....
    Guard (vl-echarlist-p text).
Returns
successp — Type (booleanp successp).
formals — Type (vl-define-formallist-p formals).
body — Remaining characters after any macro arguments.
    Type (vl-echarlist-p body).

Definitions and Theorems

Function: vl-split-define-text

(defun vl-split-define-text (text ppst)
  (declare (xargs :stobjs (ppst)))
  (declare (xargs :guard (vl-echarlist-p text)))
  (let ((__function__ 'vl-split-define-text))
    (declare (ignorable __function__))
    (b* ((text (vl-echarlist-fix text))
         ((unless (and (consp text)
                       (eql (vl-echar->char (car text)) #\()))
          (mv t nil (vl-echarlist-fix text)
              ppst)))
      (vl-parse-define-formal-arguments (cdr text)
                                        (vl-echar->loc (car text))
                                        ppst))))

Theorem: booleanp-of-vl-split-define-text.successp

(defthm booleanp-of-vl-split-define-text.successp
  (b* (((mv ?successp ?formals ?body ?ppst)
        (vl-split-define-text text ppst)))
    (booleanp successp))
  :rule-classes :type-prescription)

Theorem: vl-define-formallist-p-of-vl-split-define-text.formals

(defthm vl-define-formallist-p-of-vl-split-define-text.formals
  (b* (((mv ?successp ?formals ?body ?ppst)
        (vl-split-define-text text ppst)))
    (vl-define-formallist-p formals))
  :rule-classes :rewrite)

Theorem: vl-echarlist-p-of-vl-split-define-text.body

(defthm vl-echarlist-p-of-vl-split-define-text.body
  (b* (((mv ?successp ?formals ?body ?ppst)
        (vl-split-define-text text ppst)))
    (vl-echarlist-p body))
  :rule-classes :rewrite)

Subtopics

Vl-parse-define-formal-arguments