• 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
      • Warnings
      • Getting-started
      • Utilities
      • Printer
      • Kit
      • Mlib
      • Transforms
        • Unparameterization
        • Elaborate
        • Addnames
        • Annotate
          • Increment-elim
          • Make-implicit-wires
            • Shadowcheck
              • Vl-shadowcheck-genelement
              • Vl-shadowcheck-reference-name
              • Vl-shadowcheck-declare-name
              • Deltemps
              • Vl-shadowcheck-modelement
              • Vl-lexscope
              • Vl-shadowcheck-reference-scopeexpr
              • Vl-shadowcheck-reference-names
              • Vl-shadowcheck-declare-names
              • Vl-shadowcheck-paramtype
              • Vl-shadowcheck-fun/task-loaditems
              • Vl-shadowcheck-fun/task-loaditem
              • Vl-shadowcheck-fundecl
              • Vl-shadowcheck-declare-typedefs
              • Vl-shadowcheck-blockitemlist
              • Vl-shadowcheck-portdecllist
              • Vl-shadowcheck-paramdecls
              • Vl-shadowcheck-dpiimports
              • Vl-shadowcheck-taskdecls
              • Vl-shadowcheck-taskdecl
              • Vl-shadowcheck-push-scope
              • Vl-shadowcheck-blockitem
              • Vl-shadowcheck-vardecls
              • Vl-shadowcheck-vardecl
              • Vl-shadowcheck-typedef
              • Vl-shadowcheck-portdecl
              • Vl-shadowcheck-paramdecl
              • Vl-shadowcheck-modport
              • Vl-shadowcheck-modinst
              • Vl-shadowcheck-imports
              • Vl-shadowcheck-import
              • Vl-shadowcheck-gateinst
              • Vl-shadowcheck-fundecls
              • Vl-shadowcheck-dpiimport
              • Vl-shadowcheck-ports
              • Vl-shadowcheck-port
              • Vl-shadowcheck-initial
              • Vl-shadowcheck-assign
              • Vl-shadowcheck-always
              • Vl-shadowcheck-final
              • Vl-shadowcheck-alias
              • Vl-shadowcheck-state
              • Vl-shadowcheck-module
              • Vl-shadowcheck-interface
              • Vl-shadowcheck-interfaces
              • Vl-shadowcheck-modules
              • Vl-packagemap-find-packages-for-name
              • Vl-shadowcheck-design
              • Vl-lexscopes
                • Vl-lexscopes-fix
                • Vl-lexscopes-direct-import-name
                • Vl-lexscopes-declare-name
                • Vl-lexscopes-do-import
                • Vl-lexscopes-find
                • Vl-lexscopes-equiv
                • Vl-lexscopes-p
                • Vl-lexscopes-exit-scope
                • Vl-lexscopes-enter-new-scope
              • Vl-expr->maybe-subtype
              • Vl-shadowcheck-pop-scope
              • Nameclash
              • Vl-portdecl-or-blockitem
              • Vl-lexscope-decls
              • Vl-packagemap
              • Vl-portdecl-or-blockitem-list
            • Implicit-wires-minutia
            • Implicit-wires-generate-scoping
            • Vl-genbase-make-implicit-wires
            • Vl-expr-names-for-implicit
            • Vl-make-implicit-wires-main
            • Vl-implicitst
            • Vl-make-port-implicit-wires
            • Vl-import-update-implicit
            • Vl-blockitemlist-update-implicit
            • Vl-blockitem-update-implicit
            • Vl-make-ordinary-implicit-wires
            • Vl-remove-declared-wires
            • Vl-implicitsts-restore-fast-alists
            • Vl-genblock-under-cond-make-implicit-wires
            • Vl-collect-exprs-for-implicit-wires-from-namedargs
            • Vl-genblock-make-implicit-wires
            • Vl-collect-exprs-for-implicit-wires-from-portargs
            • Vl-collect-exprs-for-implicit-wires-from-namedarg
            • Vl-gateinst-exprs-for-implicit-wires
            • Vl-modinst-exprs-for-implicit-wires
            • Vl-genelementlist-make-implicit-wires
            • Vl-packagemap-find-name
          • Basic-bind-elim
          • Argresolve
          • Basicsanity
          • Portdecl-sign
          • Enum-names
          • Port-resolve
          • Udp-elim
          • Vl-annotate-design
          • Vl-annotate-module
        • Clean-warnings
        • Eliminitial
        • Custom-transform-hooks
        • Problem-modules
    • X86isa
    • Svl
    • Rtl
  • Software-verification
  • Math
  • Testing-utilities

• Vl-lexscopes

Vl-lexscopes-declare-name

Extend the lexscopes with a local declaration.

Signature

(vl-lexscopes-declare-name name decl scopes warnings &key genblockp) 
  → 
(mv scopes warnings)

Arguments

name — Guard (stringp name).

decl — Guard (any-p decl).

scopes — Guard (vl-lexscopes-p scopes).

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

genblockp — Guard (booleanp genblockp).

Returns

scopes — Type (vl-lexscopes-p scopes).

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

Definitions and Theorems

Function: vl-lexscopes-declare-name-fn

(defun vl-lexscopes-declare-name-fn
       (name decl scopes warnings genblockp)
 (declare (xargs :guard (and (stringp name)
                             (any-p decl)
                             (vl-lexscopes-p scopes)
                             (vl-warninglist-p warnings)
                             (booleanp genblockp))))
 (let ((__function__ 'vl-lexscopes-declare-name))
  (declare (ignorable __function__))
  (b*
   ((name (string-fix name))
    (scopes (vl-lexscopes-fix scopes))
    (warnings (vl-warninglist-fix warnings))
    ((when (atom scopes))
     (raise "Expected at least one scope.")
     (mv scopes warnings))
    (scope1 (car scopes))
    (decls (vl-lexscope->decls scope1))
    (entry (vl-lexscope-find name scope1))
    ((unless entry)
     (mv
      (cons
       (change-vl-lexscope
           scope1
           :decls
           (hons-acons name
                       (make-vl-lexscope-entry :decl decl
                                               :direct-pkg nil
                                               :wildpkgs nil
                                               :genblockp genblockp)
                       decls))
       (cdr scopes))
      warnings))
    ((vl-lexscope-entry entry))
    (warnings
     (if entry.direct-pkg
      (fatal
          :type :vl-name-clash
          :msg "~a0: can't declare ~s1 after importing it from ~s2."
          :args (list decl name entry.direct-pkg))
      (ok)))
    (new-entry
         (change-vl-lexscope-entry entry
                                   :decl (or entry.decl decl)))
    (new-scope1
      (change-vl-lexscope scope1
                          :decls (hons-acons name new-entry decls)))
    (new-scopes (cons new-scope1 (cdr scopes))))
   (mv new-scopes warnings))))

Theorem: vl-lexscopes-p-of-vl-lexscopes-declare-name.scopes

(defthm vl-lexscopes-p-of-vl-lexscopes-declare-name.scopes
  (b* (((mv ?scopes ?warnings)
        (vl-lexscopes-declare-name-fn
             name decl scopes warnings genblockp)))
    (vl-lexscopes-p scopes))
  :rule-classes :rewrite)

Theorem: vl-warninglist-p-of-vl-lexscopes-declare-name.warnings

(defthm vl-warninglist-p-of-vl-lexscopes-declare-name.warnings
  (b* (((mv ?scopes ?warnings)
        (vl-lexscopes-declare-name-fn
             name decl scopes warnings genblockp)))
    (vl-warninglist-p warnings))
  :rule-classes :rewrite)

Theorem: vl-lexscopes-declare-name-fn-of-str-fix-name

(defthm vl-lexscopes-declare-name-fn-of-str-fix-name
  (equal
       (vl-lexscopes-declare-name-fn (str-fix name)
                                     decl scopes warnings genblockp)
       (vl-lexscopes-declare-name-fn
            name decl scopes warnings genblockp)))

Theorem: vl-lexscopes-declare-name-fn-streqv-congruence-on-name

(defthm vl-lexscopes-declare-name-fn-streqv-congruence-on-name
 (implies
  (streqv name name-equiv)
  (equal
     (vl-lexscopes-declare-name-fn
          name decl scopes warnings genblockp)
     (vl-lexscopes-declare-name-fn name-equiv
                                   decl scopes warnings genblockp)))
 :rule-classes :congruence)

Theorem: vl-lexscopes-declare-name-fn-of-identity-decl

(defthm vl-lexscopes-declare-name-fn-of-identity-decl
  (equal (vl-lexscopes-declare-name-fn name (identity decl)
                                       scopes warnings genblockp)
         (vl-lexscopes-declare-name-fn
              name decl scopes warnings genblockp)))

Theorem: vl-lexscopes-declare-name-fn-equal-congruence-on-decl

(defthm vl-lexscopes-declare-name-fn-equal-congruence-on-decl
  (implies (equal decl decl-equiv)
           (equal (vl-lexscopes-declare-name-fn
                       name decl scopes warnings genblockp)
                  (vl-lexscopes-declare-name-fn
                       name
                       decl-equiv scopes warnings genblockp)))
  :rule-classes :congruence)

Theorem: vl-lexscopes-declare-name-fn-of-vl-lexscopes-fix-scopes

(defthm vl-lexscopes-declare-name-fn-of-vl-lexscopes-fix-scopes
 (equal
   (vl-lexscopes-declare-name-fn name decl (vl-lexscopes-fix scopes)
                                 warnings genblockp)
   (vl-lexscopes-declare-name-fn
        name decl scopes warnings genblockp)))

Theorem: vl-lexscopes-declare-name-fn-vl-lexscopes-equiv-congruence-on-scopes

(defthm
 vl-lexscopes-declare-name-fn-vl-lexscopes-equiv-congruence-on-scopes
 (implies (vl-lexscopes-equiv scopes scopes-equiv)
          (equal (vl-lexscopes-declare-name-fn
                      name decl scopes warnings genblockp)
                 (vl-lexscopes-declare-name-fn
                      name
                      decl scopes-equiv warnings genblockp)))
 :rule-classes :congruence)

Theorem: vl-lexscopes-declare-name-fn-of-vl-warninglist-fix-warnings

(defthm vl-lexscopes-declare-name-fn-of-vl-warninglist-fix-warnings
 (equal
  (vl-lexscopes-declare-name-fn name decl
                                scopes (vl-warninglist-fix warnings)
                                genblockp)
  (vl-lexscopes-declare-name-fn
       name decl scopes warnings genblockp)))

Theorem: vl-lexscopes-declare-name-fn-vl-warninglist-equiv-congruence-on-warnings

(defthm
 vl-lexscopes-declare-name-fn-vl-warninglist-equiv-congruence-on-warnings
 (implies (vl-warninglist-equiv warnings warnings-equiv)
          (equal (vl-lexscopes-declare-name-fn
                      name decl scopes warnings genblockp)
                 (vl-lexscopes-declare-name-fn
                      name
                      decl scopes warnings-equiv genblockp)))
 :rule-classes :congruence)

Theorem: vl-lexscopes-declare-name-fn-of-bool-fix-genblockp

(defthm vl-lexscopes-declare-name-fn-of-bool-fix-genblockp
 (equal
  (vl-lexscopes-declare-name-fn name decl scopes
                                warnings (acl2::bool-fix genblockp))
  (vl-lexscopes-declare-name-fn
       name decl scopes warnings genblockp)))

Theorem: vl-lexscopes-declare-name-fn-iff-congruence-on-genblockp

(defthm vl-lexscopes-declare-name-fn-iff-congruence-on-genblockp
  (implies (iff genblockp genblockp-equiv)
           (equal (vl-lexscopes-declare-name-fn
                       name decl scopes warnings genblockp)
                  (vl-lexscopes-declare-name-fn
                       name
                       decl scopes warnings genblockp-equiv)))
  :rule-classes :congruence)