|
// Licensed to the .NET Foundation under one or more agreements.
// The .NET Foundation licenses this file to you under the MIT license.
using System;
using System.IO;
using Microsoft.Build.Shared;
#nullable disable
namespace Microsoft.Build.Framework
{
/// <summary>
/// Arguments for error events
/// </summary>
// WARNING: marking a type [Serializable] without implementing
// ISerializable imposes a serialization contract -- it is a
// promise to never change the type's fields i.e. the type is
// immutable; adding new fields in the next version of the type
// without following certain special FX guidelines, can break both
// forward and backward compatibility
[Serializable]
public class BuildErrorEventArgs : LazyFormattedBuildEventArgs
{
/// <summary>
/// Subcategory of the error
/// </summary>
private string subcategory;
/// <summary>
/// Error code
/// </summary>
private string code;
/// <summary>
/// File name
/// </summary>
private string file;
/// <summary>
/// The project which issued the event
/// </summary>
private string projectFile;
/// <summary>
/// Line number
/// </summary>
private int lineNumber;
/// <summary>
/// Column number
/// </summary>
private int columnNumber;
/// <summary>
/// End line number
/// </summary>
private int endLineNumber;
/// <summary>
/// End column number
/// </summary>
private int endColumnNumber;
/// <summary>
/// A link pointing to more information about the error
/// </summary>
private string helpLink;
/// <summary>
/// This constructor allows all event data to be initialized
/// </summary>
/// <param name="subcategory">event sub-category</param>
/// <param name="code">event code</param>
/// <param name="file">file associated with the event</param>
/// <param name="lineNumber">line number (0 if not applicable)</param>
/// <param name="columnNumber">column number (0 if not applicable)</param>
/// <param name="endLineNumber">end line number (0 if not applicable)</param>
/// <param name="endColumnNumber">end column number (0 if not applicable)</param>
/// <param name="message">text message</param>
/// <param name="helpKeyword">help keyword </param>
/// <param name="senderName">name of event sender</param>
public BuildErrorEventArgs(
string subcategory,
string code,
string file,
int lineNumber,
int columnNumber,
int endLineNumber,
int endColumnNumber,
string message,
string helpKeyword,
string senderName)
: this(subcategory, code, file, lineNumber, columnNumber, endLineNumber, endColumnNumber, message, helpKeyword, senderName, DateTime.UtcNow)
{
}
/// <summary>
/// This constructor which allows a timestamp to be set
/// </summary>
/// <param name="subcategory">event sub-category</param>
/// <param name="code">event code</param>
/// <param name="file">file associated with the event</param>
/// <param name="lineNumber">line number (0 if not applicable)</param>
/// <param name="columnNumber">column number (0 if not applicable)</param>
/// <param name="endLineNumber">end line number (0 if not applicable)</param>
/// <param name="endColumnNumber">end column number (0 if not applicable)</param>
/// <param name="message">text message</param>
/// <param name="helpKeyword">help keyword </param>
/// <param name="senderName">name of event sender</param>
/// <param name="eventTimestamp">Timestamp when event was created</param>
public BuildErrorEventArgs(
string subcategory,
string code,
string file,
int lineNumber,
int columnNumber,
int endLineNumber,
int endColumnNumber,
string message,
string helpKeyword,
string senderName,
DateTime eventTimestamp)
: this(subcategory, code, file, lineNumber, columnNumber, endLineNumber, endColumnNumber, message, helpKeyword, senderName, null, eventTimestamp, null)
{
// do nothing
}
/// <summary>
/// This constructor which allows a timestamp to be set
/// </summary>
/// <param name="subcategory">event sub-category</param>
/// <param name="code">event code</param>
/// <param name="file">file associated with the event</param>
/// <param name="lineNumber">line number (0 if not applicable)</param>
/// <param name="columnNumber">column number (0 if not applicable)</param>
/// <param name="endLineNumber">end line number (0 if not applicable)</param>
/// <param name="endColumnNumber">end column number (0 if not applicable)</param>
/// <param name="message">text message</param>
/// <param name="helpKeyword">help keyword </param>
/// <param name="senderName">name of event sender</param>
/// <param name="eventTimestamp">Timestamp when event was created</param>
/// <param name="messageArgs">message arguments</param>
public BuildErrorEventArgs(
string subcategory,
string code,
string file,
int lineNumber,
int columnNumber,
int endLineNumber,
int endColumnNumber,
string message,
string helpKeyword,
string senderName,
DateTime eventTimestamp,
params object[] messageArgs)
: this(subcategory, code, file, lineNumber, columnNumber, endLineNumber, endColumnNumber, message, helpKeyword, senderName, null, eventTimestamp, messageArgs)
{
// do nothing
}
/// <summary>
/// This constructor which allows a timestamp to be set
/// </summary>
/// <param name="subcategory">event sub-category</param>
/// <param name="code">event code</param>
/// <param name="file">file associated with the event</param>
/// <param name="lineNumber">line number (0 if not applicable)</param>
/// <param name="columnNumber">column number (0 if not applicable)</param>
/// <param name="endLineNumber">end line number (0 if not applicable)</param>
/// <param name="endColumnNumber">end column number (0 if not applicable)</param>
/// <param name="message">text message</param>
/// <param name="helpKeyword">help keyword </param>
/// <param name="helpLink">A link pointing to more information about the error </param>
/// <param name="senderName">name of event sender</param>
/// <param name="eventTimestamp">Timestamp when event was created</param>
/// <param name="messageArgs">message arguments</param>
public BuildErrorEventArgs(
string subcategory,
string code,
string file,
int lineNumber,
int columnNumber,
int endLineNumber,
int endColumnNumber,
string message,
string helpKeyword,
string senderName,
string helpLink,
DateTime eventTimestamp,
params object[] messageArgs)
: base(message, helpKeyword, senderName, eventTimestamp, messageArgs)
{
this.subcategory = subcategory;
this.code = code;
this.file = file;
this.lineNumber = lineNumber;
this.columnNumber = columnNumber;
this.endLineNumber = endLineNumber;
this.endColumnNumber = endColumnNumber;
this.helpLink = helpLink;
}
/// <summary>
/// Default constructor
/// </summary>
protected BuildErrorEventArgs()
: base()
{
// do nothing
}
/// <summary>
/// The custom sub-type of the event.
/// </summary>
public string Subcategory => subcategory;
/// <summary>
/// Code associated with event.
/// </summary>
public string Code => code;
/// <summary>
/// File associated with event.
/// </summary>
public string File => file;
/// <summary>
/// The project file which issued this event.
/// </summary>
public string ProjectFile
{
get => projectFile;
set => projectFile = value;
}
/// <summary>
/// Line number of interest in associated file.
/// </summary>
public int LineNumber => lineNumber;
/// <summary>
/// Column number of interest in associated file.
/// </summary>
public int ColumnNumber => columnNumber;
/// <summary>
/// Ending line number of interest in associated file.
/// </summary>
public int EndLineNumber => endLineNumber;
/// <summary>
/// Ending column number of interest in associated file.
/// </summary>
public int EndColumnNumber => endColumnNumber;
/// <summary>
/// A link pointing to more information about the error.
/// </summary>
public string HelpLink => helpLink;
#region CustomSerializationToStream
/// <summary>
/// Serializes to a stream through a binary writer
/// </summary>
/// <param name="writer">Binary writer which is attached to the stream the event will be serialized into</param>
internal override void WriteToStream(BinaryWriter writer)
{
base.WriteToStream(writer);
writer.WriteOptionalString(subcategory);
writer.WriteOptionalString(code);
writer.WriteOptionalString(file);
writer.WriteOptionalString(projectFile);
writer.Write((Int32)lineNumber);
writer.Write((Int32)columnNumber);
writer.Write((Int32)endLineNumber);
writer.Write((Int32)endColumnNumber);
writer.WriteOptionalString(helpLink);
}
/// <summary>
/// Deserializes to a stream through a binary writer
/// </summary>
/// <param name="reader">Binary reader which the object will be deserialized from</param>
/// <param name="version">The version of the runtime the message packet was created from</param>
internal override void CreateFromStream(BinaryReader reader, int version)
{
base.CreateFromStream(reader, version);
subcategory = reader.ReadByte() == 0 ? null : reader.ReadString();
code = reader.ReadByte() == 0 ? null : reader.ReadString();
file = reader.ReadByte() == 0 ? null : reader.ReadString();
if (version > 20)
{
projectFile = reader.ReadByte() == 0 ? null : reader.ReadString();
}
else
{
projectFile = null;
}
lineNumber = reader.ReadInt32();
columnNumber = reader.ReadInt32();
endLineNumber = reader.ReadInt32();
endColumnNumber = reader.ReadInt32();
if (version >= 40)
{
helpLink = reader.ReadByte() == 0 ? null : reader.ReadString();
}
else
{
helpLink = null;
}
}
#endregion
}
}
|