File size: 4,017 Bytes
8c763fb | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.Text;
using Dbg = System.Management.Automation.Diagnostics;
namespace System.Management.Automation.Language
{
/// <summary>
/// Contains utility methods for use in applications that generate PowerShell code.
/// </summary>
public static class CodeGeneration
{
/// <summary>
/// Escapes content so that it is safe for inclusion in a single-quoted string.
/// For example: "'" + EscapeSingleQuotedStringContent(userContent) + "'"
/// </summary>
/// <param name="value">The content to be included in a single-quoted string.</param>
/// <returns>Content with all single-quotes escaped.</returns>
public static string EscapeSingleQuotedStringContent(string value)
{
if (string.IsNullOrEmpty(value))
{
return string.Empty;
}
StringBuilder sb = new StringBuilder(value.Length);
foreach (char c in value)
{
sb.Append(c);
if (CharExtensions.IsSingleQuote(c))
{
// double-up quotes to escape them
sb.Append(c);
}
}
return sb.ToString();
}
/// <summary>
/// Escapes content so that it is safe for inclusion in a block comment.
/// For example: "<#" + EscapeBlockCommentContent(userContent) + "#>"
/// </summary>
/// <param name="value">The content to be included in a block comment.</param>
/// <returns>Content with all block comment characters escaped.</returns>
public static string EscapeBlockCommentContent(string value)
{
if (string.IsNullOrEmpty(value))
{
return string.Empty;
}
return value
.Replace("<#", "<`#")
.Replace("#>", "#`>");
}
/// <summary>
/// Escapes content so that it is safe for inclusion in a string that will later be used as a
/// format string. If this is to be embedded inside of a single-quoted string, be sure to also
/// call EscapeSingleQuotedStringContent.
/// For example: "'" + EscapeSingleQuotedStringContent(EscapeFormatStringContent(userContent)) + "'" -f $args.
/// </summary>
/// <param name="value">The content to be included in a format string.</param>
/// <returns>Content with all curly braces escaped.</returns>
public static string EscapeFormatStringContent(string value)
{
if (string.IsNullOrEmpty(value))
{
return string.Empty;
}
StringBuilder sb = new StringBuilder(value.Length);
foreach (char c in value)
{
sb.Append(c);
if (CharExtensions.IsCurlyBracket(c))
{
// double-up curly brackets to escape them
sb.Append(c);
}
}
return sb.ToString();
}
/// <summary>
/// Escapes content so that it is safe for inclusion in a string that will later be used in a variable
/// name reference. This is only valid when used within PowerShell's curly brace naming syntax.
///
/// For example: '${' + EscapeVariableName('value') + '}'
/// </summary>
/// <param name="value">The content to be included as a variable name.</param>
/// <returns>Content with all curly braces and back-ticks escaped.</returns>
public static string EscapeVariableName(string value)
{
if (string.IsNullOrEmpty(value))
{
return string.Empty;
}
return value
.Replace("`", "``")
.Replace("}", "`}")
.Replace("{", "`{");
}
}
}
|