• 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-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
            • Vl-make-hidden-variables-for-portdecls
            • Vl-parse-function-declaration-2005
            • Vl-parse-task-declaration-2005
            • Vl-parse-task-item-declaration-noatts
            • Vl-parse-taskport-declaration
            • Parse-functions-sv2012
              • Vl-parse-tf-port-item
              • Vl-parse-function-data-type-and-name
              • Vl-parse-function-declaration-2012
              • Vl-parse-function-statements
              • Vl-parse-task-declaration-2012
              • Vl-parse-tf-port-declaration
              • Vl-tf-parsed-var-id-p
              • Vl-parse-list-of-tf-variable-identifiers
              • Vl-parse-tf-item-declaration-noatts
              • Vl-parse-0+-tf-item-declarations
              • Vl-datatype-or-implicit
              • Vl-parse-tf-variable-identifier
              • Vl-parse-tf-port-list
              • Vl-parse-tf-item-declaration
              • Vl-parse-function-declaration
              • Vl-parse-task-declaration
              • Vl-make-tf-ports-from-parsed-ids
              • Vl-tf-parsed-var-idlist-p
            • Vl-parse-taskport-list
            • Vl-make-fundecl-for-parser
            • Vl-make-taskdecl-for-parser
            • Vl-parse-0+-task-item-declarations
            • Vl-parse-optional-function-range-or-type
            • Vl-parse-task-item-declaration
            • Vl-skip-through-endfunction
            • Vl-skip-through-endtask
            • Vl-make-hidden-variable-for-portdecl
            • Vl-filter-portdecl-or-blockitem-list
            • Vl-build-taskports
            • Vl-portdecllist-find-noninput
          • 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-functions-sv2012

Vl-parse-function-declaration-2012

Signature

(vl-parse-function-declaration-2012 atts &key (tokstream 'tokstream) 
                                    (config 'config)) 
 
  → 
(mv errmsg? value new-tokstream)

Arguments

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

function_declaration ::= 'function' [ lifetime ] function_body_declaration

function_body_declaration ::=

  function_data_type_or_implicit                                                           ; Variant 1
    [ interface_identifier '.' | class_scope ] identifier ';'
    { tf_item_declaration }
    { function_statement_or_null }
  'endfunction' [ ':' identifier ]

 | function_data_type_or_implicit
     [ interface_identifier '.' | class_scope ] identifier '(' [tf_port_list] ')' ';'      ; Variant 2
     { block_item_declaration }
     { function_statement_or_null }
   'endfunction' [ ':' identifier ]

As is often the case with data_type_or_implicit forms, we need to backtrack to figure out whether an identifier is a datatype or the function name with an empty implicit datatype. We do this in vl-parse-function-data-type-and-name.

BOZO we don't yet handle the interface identifier / class scope stuff, but instead just expect the function name to be a regular identifier.

Definitions and Theorems

Function: vl-parse-function-declaration-2012-fn

(defun vl-parse-function-declaration-2012-fn (atts tokstream config)
 (declare (xargs :stobjs (tokstream)))
 (declare (xargs :guard (vl-loadconfig-p config)))
 (declare (ignorable config))
 (declare (xargs :guard (vl-atts-p atts)))
 (let ((__function__ 'vl-parse-function-declaration-2012))
  (declare (ignorable __function__))
  (seq
   tokstream
   (:= (vl-match-token :vl-kwd-function))
   (lifetime := (vl-maybe-parse-lifetime))
   ((rettype . name)
    := (vl-parse-function-data-type-and-name t))
   (when
    (vl-is-token? :vl-semi)
    (:= (vl-match))
    (items := (vl-parse-0+-tf-item-declarations))
    (body := (vl-parse-function-statements))
    (:= (vl-match-token :vl-kwd-endfunction))
    (:= (vl-parse-endblock-name (vl-idtoken->name name)
                                "function/endfunction"))
    (return
       (b* (((mv portdecls blockitems)
             (vl-filter-portdecl-or-blockitem-list items)))
         (list (vl-make-fundecl-for-parser
                    :name (vl-idtoken->name name)
                    :lifetime lifetime
                    :rettype (vl-datatype-or-implicit->type rettype)
                    :inputs portdecls
                    :decls blockitems
                    :loaditems items
                    :body body
                    :atts atts
                    :loc (vl-token->loc name))))))
   (:= (vl-match-token :vl-lparen))
   (unless (vl-is-token? :vl-rparen)
           (portdecls := (vl-parse-tf-port-list)))
   (:= (vl-match-token :vl-rparen))
   (:= (vl-match-token :vl-semi))
   (decls := (vl-parse-0+-block-item-declarations))
   (body := (vl-parse-function-statements))
   (:= (vl-match-token :vl-kwd-endfunction))
   (:= (vl-parse-endblock-name (vl-idtoken->name name)
                               "function/endfunction"))
   (return
        (list (vl-make-fundecl-for-parser
                   :name (vl-idtoken->name name)
                   :lifetime lifetime
                   :rettype (vl-datatype-or-implicit->type rettype)
                   :inputs portdecls
                   :decls decls
                   :loaditems (append portdecls decls)
                   :body body
                   :atts atts
                   :loc (vl-token->loc name)))))))

Theorem: vl-parse-function-declaration-2012-fails-gracefully

(defthm vl-parse-function-declaration-2012-fails-gracefully
 (implies (mv-nth 0
                  (vl-parse-function-declaration-2012 atts))
          (not (mv-nth 1
                       (vl-parse-function-declaration-2012 atts)))))

Theorem: vl-warning-p-of-vl-parse-function-declaration-2012

(defthm vl-warning-p-of-vl-parse-function-declaration-2012
 (iff
   (vl-warning-p (mv-nth 0
                         (vl-parse-function-declaration-2012 atts)))
   (mv-nth 0
           (vl-parse-function-declaration-2012 atts))))

Theorem: vl-parse-function-declaration-2012-result

(defthm vl-parse-function-declaration-2012-result
 (implies (and (force (vl-atts-p atts)))
          (vl-fundecllist-p
               (mv-nth 1
                       (vl-parse-function-declaration-2012 atts)))))

Theorem: vl-parse-function-declaration-2012-true-listp

(defthm vl-parse-function-declaration-2012-true-listp
  (true-listp (mv-nth 1
                      (vl-parse-function-declaration-2012 atts)))
  :rule-classes :type-prescription)

Theorem: vl-parse-function-declaration-2012-count-strong

(defthm vl-parse-function-declaration-2012-count-strong
 (and
  (<=
   (vl-tokstream-measure
      :tokstream (mv-nth 2
                         (vl-parse-function-declaration-2012 atts)))
   (vl-tokstream-measure))
  (implies
   (not (mv-nth 0
                (vl-parse-function-declaration-2012 atts)))
   (<
    (vl-tokstream-measure
      :tokstream (mv-nth 2
                         (vl-parse-function-declaration-2012 atts)))
    (vl-tokstream-measure))))
 :rule-classes ((:rewrite) (:linear)))