• 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-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-location
            • Vl-location-p
            • Vl-string-between-locs
            • Vl-location-between-p
            • Vl-string-findloc
            • Vl-linecol
            • Vl-location-string
            • Vl-location-fix
            • Vl-location->line
            • Vl-location->filename
            • Vl-location->col
            • Vl-locationlist
            • *vl-fakeloc*
          • Vl-echar-p
          • Vl-echarlist->chars
          • Vl-echarlist-from-chars
          • Vl-echarlist-from-str
          • Vl-echarlist-unsigned-value
          • Vl-change-echarlist-locations
          • Vl-echar-digit-value
          • Vl-echarlist->string
        • 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-location

Vl-location-string

Convert an vl-location-p into a string.

Signature

(vl-location-string loc) → str

Arguments

loc — Guard (vl-location-p loc).

Returns

str — Type (stringp str).

(vl-location-string loc) is often useful in generating warning or error messages. It converts a vl-location-p object into a string of the form filename:line:col.

Definitions and Theorems

Function: vl-location-string

(defun vl-location-string (loc)
  (declare (xargs :guard (vl-location-p loc)))
  (let ((__function__ 'vl-location-string))
    (declare (ignorable __function__))
    (cat (vl-location->filename loc)
         ":" (natstr (vl-location->line loc))
         ":" (natstr (vl-location->col loc)))))

Theorem: stringp-of-vl-location-string

(defthm stringp-of-vl-location-string
  (b* ((str (vl-location-string loc)))
    (stringp str))
  :rule-classes :type-prescription)

Theorem: vl-location-string-of-vl-location-fix-loc

(defthm vl-location-string-of-vl-location-fix-loc
  (equal (vl-location-string (vl-location-fix loc))
         (vl-location-string loc)))

Theorem: vl-location-string-vl-location-equiv-congruence-on-loc

(defthm vl-location-string-vl-location-equiv-congruence-on-loc
  (implies (vl-location-equiv loc loc-equiv)
           (equal (vl-location-string loc)
                  (vl-location-string loc-equiv)))
  :rule-classes :congruence)