• Top
    • Documentation
    • Books
    • Recursion-and-induction
    • Boolean-reasoning
    • Debugging
    • Projects
    • Std
    • Proof-automation
    • Macro-libraries
    • ACL2
    • Interfacing-tools
    • Hardware-verification
      • Gl
      • Esim
      • Vl2014
        • Warnings
        • Primitives
        • Use-set
          • Typo-detection
            • Typo-read-lowercase-part
            • Typo-read-part
            • Typo-read-uppercase-part
            • Typo-read-special
            • Typo-detect-aux
            • Typo-detect
              • Typo-find-plausible-typos1
              • Typo-mismatch-plausibly-typo-p
              • Typo-partitioning-alist
              • Typo-partition
              • Vl-typo-first-mismatch
              • Typo-partitions-plausibly-typo-p
              • Vl-typo-count-mismatches
              • Typo-numbers
              • *typo-special-substrings-chars*
              • *typo-numbers*
            • Vl-wireinfo-alistp
            • Vl-annotate-vardecllist-with-wireinfo
            • Vl-useset-report-entry-p
            • Vl-print-useset-report-entry
            • Vl-mark-wires-for-module
            • Vl-split-useset-report
            • Vl-annotate-vardecl-with-wireinfo
            • Vl-mark-wires-for-modinstlist
            • Vl-mark-wires-for-modinst
            • Vl-mark-wires-for-gateinstlist
            • Vl-mark-wires-for-gateinst
            • Vl-mark-wires-for-plainarg
            • Vl-wireinfo-p
            • Vl-mark-wires-for-modulelist
            • Vl-vardecllist-impexp-names
            • Vl-report-totals
            • Vl-mark-wires-for-plainarglist
            • Vl-collect-unused-or-unset-wires
            • Vl-clean-up-warning-wires
            • Vl-print-useset-report-top
            • Vl-mark-wires-for-arguments
            • Vl-useset-report-p
            • Vl-star-names-of-warning-wires
            • Vl-design-use-set-report
            • Vl-module-impexp-names
            • Vl-make-initial-wireinfo-alist
            • Vl-mark-wire-used
            • Vl-mark-wire-set
            • Vl-mark-wires-used
            • Vl-mark-wires-for-assignment
            • Vl-mark-wires-for-assignlist
            • Vl-mark-wires-set
            • Vl-print-useset-report-full-aux
            • Vl-print-typo-alist
            • Vl-print-typo-possibilities
          • Syntax
          • Getting-started
          • Utilities
          • Loader
          • Transforms
          • Lint
          • Mlib
          • Server
          • Kit
          • Printer
          • Esim-vl
          • Well-formedness
        • Sv
        • Vwsim
        • Fgl
        • Vl
        • Svl
        • X86isa
        • Rtl
      • Software-verification
      • Math
      • Testing-utilities
    • Typo-detection

    Typo-detect

    Build an alist associating any "bad" wires with any "good" wires that they may be typos for.

    Signature
    (typo-detect bad good) → alist
    Arguments
    bad — Names of wires we think are somehow bad. It could be, e.g., all of the implicit wires in a module, or all of the implicit wires that are only partly used, etc.
        Guard (string-listp bad).
    good — Names of all the wires we think are somehow good; e.g., declared, used, etc.
        Guard (string-listp good).
    Returns
    alist — Type (alistp alist).

    Definitions and Theorems

    Function: typo-detect

    (defun typo-detect (bad good)
      (declare (xargs :guard (and (string-listp bad)
                                  (string-listp good))))
      (let ((__function__ 'typo-detect))
        (declare (ignorable __function__))
        (typo-detect-aux bad (typo-partitioning-alist good))))

    Theorem: alistp-of-typo-detect

    (defthm alistp-of-typo-detect
      (b* ((alist (typo-detect bad good)))
        (alistp alist))
      :rule-classes :rewrite)

    Theorem: vl-string-keys-p-of-typo-detect

    (defthm vl-string-keys-p-of-typo-detect
      (implies (force (string-listp bad))
               (vl-string-keys-p (typo-detect bad good))))

    Theorem: vl-string-list-values-p-of-typo-detect

    (defthm vl-string-list-values-p-of-typo-detect
      (implies (force (string-listp good))
               (vl-string-list-values-p (typo-detect bad good))))