• Top
    • Documentation
    • Books
    • Boolean-reasoning
    • Projects
    • Debugging
    • Std
    • Proof-automation
    • Macro-libraries
    • ACL2
    • Interfacing-tools
    • Hardware-verification
      • Gl
      • Esim
      • Vl2014
      • Sv
      • Fgl
      • Vwsim
      • 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-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)