escape

The escape statement is used to escape quotes in a variable value or the contents of a named buffer.

Syntax

escape quotes in_varName|{bufferName}

Details

If a variable value or named buffer contains quotes then it may be desirable to escape them, either for display purposes (to prevent USE from removing them before rendering the data as output) or in order to satisfy the requirements of an external API.

The escape statement will precede all occurrances of the character " with a backslash as shown in the example below. This operation is not just temporary - it will update the actual contents of the variable or named buffer.

The escape statement does not consider the context of any existing quotes in the data. Running it multiple times against the same data will add an additional escape character each time to each occurrence of a quote.

Example

Given an input file called ‘escapeme.txt’ containing the following data:

"this "is some text" with
          some "quotes" in it"

The following script:

buffer test = FILE system/extracted/escapeme.txt
          escape quotes in {test}
          print {test}
          
          var testvar = "\"This is \"a test\" string\""
          escape quotes in testvar
          print ${testvar}

will produce the following output:

\"this \"is some text\" with
          some \"quotes\" in it\"
          
          \"This is \"a test\" string\"

How did we do?