• 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-iframe
          • Preprocessor-ifdef-minutia
          • Vl-preprocess
          • Vl-preprocess-loop
          • Vl-includeskips
          • Vl-read-until-end-of-define
          • Vl-define-formallist->defaults
          • Vl-define
            • Vl-define-formallist->names
            • Vl-parse-cmdline-define
            • Vl-parse-cmdline-defines-aux
            • Vl-parse-cmdline-defines
            • Vl-define-fix
            • Vl-maybe-define
            • Vl-define-formal
              • Vl-define-formal-fix
              • Vl-define-formal-equiv
              • Make-vl-define-formal
              • Vl-define-formal->default
              • Vl-define-formal->name
              • Change-vl-define-formal
              • Vl-define-formal-p
            • Vl-make-initial-defines
            • Vl-add-define
            • Vl-define-equiv
            • Make-vl-define
            • Vl-pp-define
            • Vl-delete-define
            • Vl-find-define
            • Vl-define->formals
            • Vl-define->stickyp
            • Change-vl-define
            • Vl-define->loc
            • Vl-define->body
            • Vl-define-p
            • Vl-defines->names
            • Vl-define-formallist
          • 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

• Vl-define

Vl-define-formal

A formal argument to a `define directive.

This is a product type introduced by defprod.

Fields

name — stringp

Name of the formal argument. This should be a simple identifier.

default — maybe-string

SystemVerilog only: default text for the argument, if applicable, or NIL if no default was provided. Note that we generally expect this to be trimmed of any whitespace.

Subtopics

Vl-define-formal-fix

Fixing function for vl-define-formal structures.

Vl-define-formal-equiv

Basic equivalence relation for vl-define-formal structures.

Make-vl-define-formal

Basic constructor macro for vl-define-formal structures.

Vl-define-formal->default

Get the default field from a vl-define-formal.

Vl-define-formal->name

Get the name field from a vl-define-formal.

Change-vl-define-formal

Modifying constructor for vl-define-formal structures.

Vl-define-formal-p

Recognizer for vl-define-formal structures.