• 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
        • Vl-lint
        • Vl-server
          • Vls-scannedalist-p
          • Vls-loadedalist-p
          • Vls-commands
            • Vls-command-args-to-eformals
            • Vls-commandinfo-p
            • Vls-success
            • Vls-commandinfolist-p
            • Commands-table
            • Define-vls-command-fn
            • Vls-fail-fn
            • Vls-fail
            • Vls-command-arg-to-eformal
            • Vls-commandtype-p
            • Get-vls-commands
          • Vls-data-p
          • Vl-server-opts-p
          • Vl-descriptionlist-summaries
          • Vls-transdb
          • Vl-describe
          • Ts-queue
          • Vls-get-plainsrc
          • Vl-description->warnings
          • Vls-showloc
          • File-layout
          • Vls-remove-from-scannedalist
          • Vls-describe
          • Vl-server-top
          • Vls-port-table
          • Vl-find-description-insensitive
          • Vls-get-warnings
          • Vls-get-summary
          • Vls-get-origsrc
          • Vl-ppc-description
          • Vls-get-parents
          • Vls-get-children
          • Vls-data-origname-reportcard
          • Vls-data-from-zip
          • Start
          • Vls-make-scannedalist
          • Vls-get-summaries
          • Vls-get-unloaded-json
          • Vls-get-desctypes
          • Vls-scannedalist-to-json
          • Vls-loadedalist-to-json
          • Vl-description-summary
          • *vl-server-help*
          • Vl-descalist->descriptions/types
          • Stop
        • Vl-gather
        • Vl-zip
        • Vl-main
        • Split-plusargs
        • Vl-shell
        • Vl-json
      • Mlib
      • Transforms
    • X86isa
    • Svl
    • Rtl
  • Software-verification
  • Math
  • Testing-utilities

• Vls-commands

Vls-fail

Create a "standard", JSON-encoded error message for a VL server command.

The usage is like with vl-cw.

Definitions and Theorems

Function: vls-fail-fn

(defun vls-fail-fn (msg alist)
  (declare (xargs :guard (and (stringp msg) (alistp alist))))
  (let ((__function__ 'vls-fail-fn))
    (declare (ignorable __function__))
    (b* ((err (with-local-ps (vl-fmt msg alist))))
      (bridge::json-encode (list (cons :error err))))))

Theorem: stringp-of-vls-fail-fn

(defthm stringp-of-vls-fail-fn
  (b* ((json (vls-fail-fn msg alist)))
    (stringp json))
  :rule-classes :type-prescription)