File size: 10,386 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 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 | // Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.
using System.Diagnostics.CodeAnalysis;
using System.Linq;
using System.Management.Automation.Language;
using System.Runtime.Serialization;
namespace System.Management.Automation
{
/// <summary>
/// Defines the exception thrown when a syntax error occurs while parsing PowerShell script text.
/// </summary>
public class ParseException : RuntimeException
{
private const string errorIdString = "Parse";
private readonly ParseError[] _errors;
/// <summary>
/// The list of parser errors.
/// </summary>
public ParseError[] Errors
{
get { return _errors; }
}
#region Serialization
/// <summary>
/// Initializes a new instance of the ParseException class and defines the serialization information,
/// and streaming context.
/// </summary>
/// <param name="info">The serialization information to use when initializing this object.</param>
/// <param name="context">The streaming context to use when initializing this object.</param>
/// <returns>Constructed object.</returns>
[Obsolete("Legacy serialization support is deprecated since .NET 8", DiagnosticId = "SYSLIB0051")]
protected ParseException(SerializationInfo info,
StreamingContext context)
{
throw new NotSupportedException();
}
#endregion Serialization
#region ctor
/// <summary>
/// Initializes a new instance of the class ParseException.
/// </summary>
/// <returns>Constructed object.</returns>
public ParseException() : base()
{
base.SetErrorId(errorIdString);
base.SetErrorCategory(ErrorCategory.ParserError);
}
/// <summary>
/// Initializes a new instance of the ParseException class and defines the error message.
/// </summary>
/// <param name="message">The error message to use when initializing this object.</param>
/// <returns>Constructed object.</returns>
public ParseException(string message) : base(message)
{
base.SetErrorId(errorIdString);
base.SetErrorCategory(ErrorCategory.ParserError);
}
/// <summary>
/// Initializes a new instance of the ParseException class and defines the error message and
/// errorID.
/// </summary>
/// <param name="message">The error message to use when initializing this object.</param>
/// <param name="errorId">The errorId to use when initializing this object.</param>
/// <returns>Constructed object.</returns>
internal ParseException(string message, string errorId) : base(message)
{
base.SetErrorId(errorId);
base.SetErrorCategory(ErrorCategory.ParserError);
}
/// <summary>
/// Initializes a new instance of the ParseException class and defines the error message,
/// error ID and inner exception.
/// </summary>
/// <param name="message">The error message to use when initializing this object.</param>
/// <param name="errorId">The errorId to use when initializing this object.</param>
/// <param name="innerException">The inner exception to use when initializing this object.</param>
/// <returns>Constructed object.</returns>
internal ParseException(string message, string errorId, Exception innerException)
: base(message, innerException)
{
base.SetErrorId(errorId);
base.SetErrorCategory(ErrorCategory.ParserError);
}
/// <summary>
/// Initializes a new instance of the ParseException class and defines the error message and
/// inner exception.
/// </summary>
/// <param name="message">The error message to use when initializing this object.</param>
/// <param name="innerException">The inner exception to use when initializing this object.</param>
/// <returns>Constructed object.</returns>
public ParseException(string message,
Exception innerException)
: base(message, innerException)
{
base.SetErrorId(errorIdString);
base.SetErrorCategory(ErrorCategory.ParserError);
}
/// <summary>
/// Initializes a new instance of the ParseException class with a collection of error messages.
/// </summary>
/// <param name="errors">The collection of error messages.</param>
public ParseException(ParseError[] errors)
{
if (errors is null || errors.Length == 0)
{
throw new ArgumentNullException(nameof(errors));
}
_errors = errors;
// Arbitrarily choose the first error message for the ErrorId.
base.SetErrorId(_errors[0].ErrorId);
base.SetErrorCategory(ErrorCategory.ParserError);
if (errors[0].Extent != null)
this.ErrorRecord.SetInvocationInfo(new InvocationInfo(null, errors[0].Extent));
}
#endregion ctor
/// <summary>
/// The error message to display.
/// </summary>
public override string Message
{
get
{
if (_errors == null)
{
return base.Message;
}
// Report at most the first 10 errors
var errorsToReport = (_errors.Length > 10)
? _errors.Take(10).Select(static e => e.ToString()).Append(ParserStrings.TooManyErrors)
: _errors.Select(static e => e.ToString());
return string.Join(Environment.NewLine + Environment.NewLine, errorsToReport);
}
}
}
/// <summary>
/// Defines the exception thrown when a incomplete parse error occurs while parsing PowerShell script text.
/// </summary>
/// <remarks>
/// This is a variation on a parsing error that indicates that the parse was incomplete
/// rather than irrecoverably wrong. A host can catch this exception and then prompt for additional
/// input to complete the parse.
/// </remarks>
public class IncompleteParseException
: ParseException
{
#region private
private const string errorIdString = "IncompleteParse";
#endregion
#region ctor
#region Serialization
/// <summary>
/// Initializes a new instance of the IncompleteParseException class and defines the serialization information,
/// and streaming context.
/// </summary>
/// <param name="info">The serialization information to use when initializing this object.</param>
/// <param name="context">The streaming context to use when initializing this object.</param>
/// <returns>Constructed object.</returns>
[Obsolete("Legacy serialization support is deprecated since .NET 8", DiagnosticId = "SYSLIB0051")]
protected IncompleteParseException(SerializationInfo info,
StreamingContext context)
{
throw new NotSupportedException();
}
#endregion Serialization
/// <summary>
/// Initializes a new instance of the class IncompleteParseException.
/// </summary>
/// <returns>Constructed object.</returns>
public IncompleteParseException() : base()
{
// Error category is set in base constructor
base.SetErrorId(errorIdString);
}
/// <summary>
/// Initializes a new instance of the IncompleteParseException class and defines the error message.
/// </summary>
/// <param name="message">The error message to use when initializing this object.</param>
/// <returns>Constructed object.</returns>
public IncompleteParseException(string message) : base(message)
{
// Error category is set in base constructor
base.SetErrorId(errorIdString);
}
/// <summary>
/// Initializes a new instance of the IncompleteParseException class and defines the error message and
/// errorID.
/// </summary>
/// <param name="message">The error message to use when initializing this object.</param>
/// <param name="errorId">The errorId to use when initializing this object.</param>
/// <returns>Constructed object.</returns>
internal IncompleteParseException(string message, string errorId) : base(message, errorId)
{
// Error category is set in base constructor
}
/// <summary>
/// Initializes a new instance of the IncompleteParseException class and defines the error message,
/// error ID and inner exception.
/// </summary>
/// <param name="message">The error message to use when initializing this object.</param>
/// <param name="errorId">The errorId to use when initializing this object.</param>
/// <param name="innerException">The inner exception to use when initializing this object.</param>
/// <returns>Constructed object.</returns>
internal IncompleteParseException(string message, string errorId, Exception innerException)
: base(message, errorId, innerException)
{
// Error category is set in base constructor
}
/// <summary>
/// Initializes a new instance of the IncompleteParseException class and defines the error message and
/// inner exception.
/// </summary>
/// <param name="message">The error message to use when initializing this object.</param>
/// <param name="innerException">The inner exception to use when initializing this object.</param>
/// <returns>Constructed object.</returns>
public IncompleteParseException(string message,
Exception innerException)
: base(message, innerException)
{
// Error category is set in base constructor
base.SetErrorId(errorIdString);
}
#endregion ctor
}
}
|