• Top
  • Documentation
  • Books
  • Boolean-reasoning
  • Projects
  • Debugging
  • Community
  • Std
  • Proof-automation
  • Macro-libraries
  • ACL2
  • Interfacing-tools
  • Hardware-verification
  • Software-verification
    • Kestrel-books
      • Crypto-hdwallet
      • Apt
      • Error-checking
      • Fty-extensions
      • Isar
      • Kestrel-utilities
      • Set
      • C
        • Syntax-for-tools
          • Formalized-subset
          • Mapping-to-language-definition
          • Input-files
          • Compilation-database
            • Comp-db-entry
            • Comp-db-arg
            • Json-to-comp-db-entry
            • Json-to-comp-db-entry-list
            • To-preprocess-db
            • To-preprocess-map
            • Comp-db-arguments-absolute-dirs
            • Comp-db-keep-only-preprocessor-args
            • Json-to-comp-db
            • Json-to-comp-db-arguments
            • Comp-db-relativize-keys
            • Json-to-comp-db-get-exec-and-arguments
            • Relativize-path
            • Preprocess-map-from-comp-file
            • Json-to-comp-db-exec-and-arguments
            • Comp-db-arguments-keep-only-preprocessor-args
            • Comp-db-arguments-escape-for-shell
            • Parse-comp-db
            • Json-to-comp-db-get-directory
            • Json-to-comp-db-get-output
            • Json-to-comp-db-get-file
            • Comp-db-drop-shared
            • Comp-db-drop-non-c
            • Comp-db-arg-list-to-string-list
            • Comp-db-absolute-dirs
            • Comp-db-escape-for-shell
            • Json-to-comp-db-try-parse-short-option
            • Preprocess-db-to-map
            • Comp-db-arg-to-string
            • Comp-db
            • Json-to-comp-db-try-parse-equal-arg
            • Defpreprocess-map-fn
            • String-escape-for-shell
            • Comp-db-arg-list
            • Irr-comp-db-arg
            • Show-warnings
            • *cc-options-space-sep*
            • *cc-options-equal-sep*
            • *cc-options-dir*
          • Printer
          • Output-files
          • Abstract-syntax-operations
          • Implementation-environments
          • Abstract-syntax
          • Concrete-syntax
          • Disambiguation
          • Validation
          • Gcc-builtins
          • Preprocessing
          • Parsing
        • Atc
        • Transformation-tools
        • Language
        • Representation
        • Insertion-sort
        • Pack
      • Soft
      • Bv
      • Imp-language
      • Ethereum
      • Event-macros
      • Java
      • Riscv
      • Bitcoin
      • Zcash
      • Yul
      • ACL2-programming-language
      • Prime-fields
      • Json
      • Syntheto
      • File-io-light
      • Cryptography
      • Number-theory
      • Axe
      • Lists-light
      • Builtins
      • Solidity
      • Helpers
      • Htclient
      • Typed-lists-light
      • Arithmetic-light
    • X86isa
    • Axe
    • Execloader
  • Math
  • Testing-utilities

• Compilation-database

String-escape-for-shell

Escape characters interpreted specially by the shell.

Signature

(string-escape-for-shell str) → str$

Arguments

str — Guard (stringp str).

Returns

str$ — Type (stringp str$).

Definitions and Theorems

Function: string-escape-for-shell

(defun string-escape-for-shell (str)
  (declare (xargs :guard (stringp str)))
  (b* ((str (str::strsubst "\\" "\\\\" str))
       (str (str::strsubst "\"" "\\\"" str))
       (str (str::strsubst "$" "\\$" str))
       (str (str::strsubst "`" "\\`" str))
       (str (str::strsubst "!" "``!" str))
       (str (str::strsubst " " "\\ " str))
       (str (str::strsubst ";" "\\;" str))
       (str (str::strsubst "|" "\\|" str))
       (str (str::strsubst "&" "\\&" str))
       (str (str::strsubst "<" "\\<" str))
       (str (str::strsubst ">" "\\>" str))
       (str (str::strsubst "{" "\\{" str))
       (str (str::strsubst "}" "\\}" str))
       (str (str::strsubst "[" "\\[" str))
       (str (str::strsubst "]" "\\]" str))
       (str (str::strsubst "*" "\\*" str))
       (str (str::strsubst "?" "\\?" str))
       (str (str::strsubst "~" "\\~" str)))
    str))

Theorem: stringp-of-string-escape-for-shell

(defthm stringp-of-string-escape-for-shell
  (b* ((str$ (string-escape-for-shell str)))
    (stringp str$))
  :rule-classes :rewrite)