• Top
  • Documentation
  • Books
  • Boolean-reasoning
  • Projects
  • Debugging
  • Std
  • Proof-automation
  • Macro-libraries
  • ACL2
  • Interfacing-tools
  • Hardware-verification
    • Gl
    • Esim
    • Vl2014
      • Warnings
      • Primitives
      • Use-set
      • Syntax
      • Getting-started
      • Utilities
      • Loader
      • Transforms
      • Lint
      • Mlib
      • Server
        • 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
        • Vl-descriptionlist-summaries
        • Vls-transdb
        • File-layout
        • Vls-data-p
        • Ts-queue
        • Vls-showloc
        • Vls-get-plainsrc
        • Vl-description->warnings
        • Vl-describe
        • Vls-port-table
        • Vls-describe
        • Vls-data-from-translation
        • Vl-find-description-insensitive
        • Vls-get-warnings
        • Vls-get-summary
        • Vls-get-origsrc
        • Vls-data-origname-reportcard
        • Vls-get-parents
        • Vls-get-children
        • Vls-get-summaries
        • Vl-ppc-description
        • Vls-get-desctypes
        • Vl-description-summary
        • Start
        • Vl-descalist->descriptions/types
        • Stop
      • Kit
      • Printer
      • Esim-vl
      • Well-formedness
    • Sv
    • Vwsim
    • Fgl
    • Vl
    • X86isa
    • Svl
    • Rtl
  • Software-verification
  • Math
  • Testing-utilities

• Vls-commands

Vls-success

Create a "standard", JSON-encoded successful return value for a VL server command.

Signature

(vls-success &key json) → extended-value

Arguments

json — Should be a json-encoded string for the actual value you want to return. This is a keyword argument to remind the caller that they need to provide a json-encoded value.
    Guard (stringp json).

Returns

extended-value — Type (stringp extended-value).

Definitions and Theorems

Function: vls-success-fn

(defun vls-success-fn (json)
  (declare (xargs :guard (stringp json)))
  (let ((__function__ 'vls-success))
    (declare (ignorable __function__))
    (cat "{\":ERROR\": false, \":VALUE\": "
         json "}")))

Theorem: stringp-of-vls-success

(defthm stringp-of-vls-success
  (b* ((extended-value (vls-success-fn json)))
    (stringp extended-value))
  :rule-classes :type-prescription)