|
// 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.Globalization;
using Microsoft.Build.Framework;
#nullable disable
namespace Microsoft.Build.Shared
{
/// <summary>
/// Offers a default string format for Error and Warning events
/// </summary>
internal static class EventArgsFormatting
{
/// <summary>
/// Format the error event message and all the other event data into
/// a single string.
/// </summary>
/// <param name="e">Error to format</param>
/// <param name="showProjectFile"><code>true</code> to show the project file which issued the event, otherwise <code>false</code>.</param>
/// <param name="projectConfigurationDescription">Properties to Print along with message</param>
/// <returns>The formatted message string.</returns>
internal static string FormatEventMessage(BuildErrorEventArgs e, bool showProjectFile, string projectConfigurationDescription)
{
return FormatEventMessage("error", e.Subcategory, e.Message,
e.Code, e.File, showProjectFile ? e.ProjectFile : null, e.LineNumber, e.EndLineNumber,
e.ColumnNumber, e.EndColumnNumber, e.ThreadId, projectConfigurationDescription);
}
/// <summary>
/// Format the warning message and all the other event data into a
/// single string.
/// </summary>
/// <param name="e">Warning to format</param>
/// <param name="showProjectFile"><code>true</code> to show the project file which issued the event, otherwise <code>false</code>.</param>
/// <param name="projectConfigurationDescription">Properties to Print along with message</param>
/// <returns>The formatted message string.</returns>
internal static string FormatEventMessage(BuildWarningEventArgs e, bool showProjectFile, string projectConfigurationDescription)
{
return FormatEventMessage("warning", e.Subcategory, e.Message,
e.Code, e.File, showProjectFile ? e.ProjectFile : null, e.LineNumber, e.EndLineNumber,
e.ColumnNumber, e.EndColumnNumber, e.ThreadId, projectConfigurationDescription);
}
/// <summary>
/// Format the message and all the other event data into a
/// single string.
/// </summary>
/// <param name="e">Message to format</param>
/// <param name="showProjectFile"><code>true</code> to show the project file which issued the event, otherwise <code>false</code>.</param>
/// <param name="projectConfigurationDescription">Properties to Print along with message</param>
/// <param name="nonNullMessage">The complete message (including property name) for an environment-derived property</param>
/// <returns>The formatted message string.</returns>
internal static string FormatEventMessage(BuildMessageEventArgs e, bool showProjectFile, string projectConfigurationDescription, string nonNullMessage = null)
{
return FormatEventMessage("message", e.Subcategory, nonNullMessage ?? e.Message,
e.Code, e.File, showProjectFile ? e.ProjectFile : null, e.LineNumber, e.EndLineNumber,
e.ColumnNumber, e.EndColumnNumber, e.ThreadId, projectConfigurationDescription);
}
/// <summary>
/// Format the error event message and all the other event data into
/// a single string.
/// </summary>
/// <param name="e">Error to format</param>
/// <returns>The formatted message string.</returns>
internal static string FormatEventMessage(BuildErrorEventArgs e)
{
ErrorUtilities.VerifyThrowArgumentNull(e, nameof(e));
// "error" should not be localized
return FormatEventMessage("error", e.Subcategory, e.Message,
e.Code, e.File, null, e.LineNumber, e.EndLineNumber,
e.ColumnNumber, e.EndColumnNumber, e.ThreadId, null);
}
/// <summary>
/// Format the error event message and all the other event data into
/// a single string.
/// </summary>
/// <param name="e">Error to format</param>
/// <param name="showProjectFile"><code>true</code> to show the project file which issued the event, otherwise <code>false</code>.</param>
/// <returns>The formatted message string.</returns>
internal static string FormatEventMessage(BuildErrorEventArgs e, bool showProjectFile)
{
ErrorUtilities.VerifyThrowArgumentNull(e, nameof(e));
// "error" should not be localized
return FormatEventMessage("error", e.Subcategory, e.Message,
e.Code, e.File, showProjectFile ? e.ProjectFile : null, e.LineNumber, e.EndLineNumber,
e.ColumnNumber, e.EndColumnNumber, e.ThreadId, null);
}
/// <summary>
/// Format the warning message and all the other event data into a
/// single string.
/// </summary>
/// <param name="e">Warning to format</param>
/// <returns>The formatted message string.</returns>
internal static string FormatEventMessage(BuildWarningEventArgs e)
{
ErrorUtilities.VerifyThrowArgumentNull(e, nameof(e));
// "warning" should not be localized
return FormatEventMessage("warning", e.Subcategory, e.Message,
e.Code, e.File, null, e.LineNumber, e.EndLineNumber,
e.ColumnNumber, e.EndColumnNumber, e.ThreadId, null);
}
/// <summary>
/// Format the warning message and all the other event data into a
/// single string.
/// </summary>
/// <param name="e">Warning to format</param>
/// <param name="showProjectFile"><code>true</code> to show the project file which issued the event, otherwise <code>false</code>.</param>
/// <returns>The formatted message string.</returns>
internal static string FormatEventMessage(BuildWarningEventArgs e, bool showProjectFile)
{
ErrorUtilities.VerifyThrowArgumentNull(e, nameof(e));
// "warning" should not be localized
return FormatEventMessage("warning", e.Subcategory, e.Message,
e.Code, e.File, showProjectFile ? e.ProjectFile : null, e.LineNumber, e.EndLineNumber,
e.ColumnNumber, e.EndColumnNumber, e.ThreadId, null);
}
/// <summary>
/// Format the message and all the other event data into a
/// single string.
/// </summary>
/// <param name="e">Message to format</param>
/// <returns>The formatted message string.</returns>
internal static string FormatEventMessage(BuildMessageEventArgs e)
{
return FormatEventMessage(e, false);
}
/// <summary>
/// Format the message and all the other event data into a
/// single string.
/// </summary>
/// <param name="e">Message to format</param>
/// <param name="showProjectFile">Show project file or not</param>
/// <param name="nonNullMessage">For an EnvironmentVariableReadEventArgs, adds an explanatory note and the name of the variable.</param>
/// <returns>The formatted message string.</returns>
internal static string FormatEventMessage(BuildMessageEventArgs e, bool showProjectFile, string nonNullMessage = null)
{
ErrorUtilities.VerifyThrowArgumentNull(e, nameof(e));
// "message" should not be localized
return FormatEventMessage("message", e.Subcategory, nonNullMessage ?? e.Message,
e.Code, e.File, showProjectFile ? e.ProjectFile : null, e.LineNumber, e.EndLineNumber, e.ColumnNumber, e.EndColumnNumber, e.ThreadId, null);
}
/// <summary>
/// Format the event message and all the other event data into a
/// single string.
/// </summary>
/// <param name="category">category ("error" or "warning")</param>
/// <param name="subcategory">subcategory</param>
/// <param name="message">event message</param>
/// <param name="code">error or warning code number</param>
/// <param name="file">file name</param>
/// <param name="lineNumber">line number (0 if n/a)</param>
/// <param name="endLineNumber">end line number (0 if n/a)</param>
/// <param name="columnNumber">column number (0 if n/a)</param>
/// <param name="endColumnNumber">end column number (0 if n/a)</param>
/// <param name="threadId">thread id</param>
/// <returns>The formatted message string.</returns>
internal static string FormatEventMessage(
string category,
string subcategory,
string message,
string code,
string file,
int lineNumber,
int endLineNumber,
int columnNumber,
int endColumnNumber,
int threadId)
{
return FormatEventMessage(category, subcategory, message, code, file, null, lineNumber, endLineNumber, columnNumber, endColumnNumber, threadId, null);
}
/// <summary>
/// Format the event message and all the other event data into a
/// single string.
/// </summary>
/// <param name="category">category ("error" or "warning")</param>
/// <param name="subcategory">subcategory</param>
/// <param name="message">event message</param>
/// <param name="code">error or warning code number</param>
/// <param name="file">file name</param>
/// <param name="projectFile">the project file name</param>
/// <param name="lineNumber">line number (0 if n/a)</param>
/// <param name="endLineNumber">end line number (0 if n/a)</param>
/// <param name="columnNumber">column number (0 if n/a)</param>
/// <param name="endColumnNumber">end column number (0 if n/a)</param>
/// <param name="threadId">thread id</param>
/// <param name="logOutputProperties">log output properties</param>
/// <returns>The formatted message string.</returns>
internal static string FormatEventMessage(
string category,
string subcategory,
string message,
string code,
string file,
string projectFile,
int lineNumber,
int endLineNumber,
int columnNumber,
int endColumnNumber,
int threadId,
string logOutputProperties)
{
// capacity is the longest possible path through the below
// to avoid reallocating while constructing the string
using ReuseableStringBuilder format = new(51);
// Uncomment these lines to show show the processor, if present.
/*
if (threadId != 0)
{
format.Append("{0}>");
}
*/
if (string.IsNullOrEmpty(file))
{
format.Append("MSBUILD : "); // Should not be localized.
}
else
{
format.Append("{1}");
if (lineNumber == 0)
{
format.Append(" : ");
}
else
{
if (columnNumber == 0)
{
if (endLineNumber == 0)
{
format.Append("({2}): ");
}
else
{
format.Append("({2}-{7}): ");
}
}
else
{
if (endLineNumber == 0)
{
if (endColumnNumber == 0)
{
format.Append("({2},{3}): ");
}
else
{
format.Append("({2},{3}-{8}): ");
}
}
else
{
if (endColumnNumber == 0)
{
format.Append("({2}-{7},{3}): ");
}
else
{
format.Append("({2},{3},{7},{8}): ");
}
}
}
}
}
if (!string.IsNullOrEmpty(subcategory))
{
format.Append("{9} ");
}
// The category as a string (should not be localized)
format.Append("{4} ");
// Put a code in, if available and necessary.
if (code == null)
{
format.Append(": ");
}
else
{
format.Append("{5}: ");
}
// Put the message in, if available.
if (message != null)
{
format.Append("{6}");
}
// If the project file was specified, tack that onto the very end.
// Check for additional properties that should be output with project file
if (projectFile != null)
{
// If the project file was specified, tack that onto the very end.
if (!string.Equals(projectFile, file))
{
// Check for additional properties that should be output with project file
if (logOutputProperties?.Length > 0)
{
format.Append(" [{10}::{11}]");
}
else
{
format.Append(" [{10}]");
}
}
else
{
// If the file location of the error _was_ the project file, append only the
// additional output properties
if (logOutputProperties?.Length > 0)
{
format.Append(" [{11}]");
}
}
}
// A null message is allowed and is to be treated as a blank line.
if (message == null)
{
message = String.Empty;
}
string finalFormat = format.ToString();
// Reuse the string builder to create the final message
ReuseableStringBuilder formattedMessage = format.Clear();
// If there are multiple lines, show each line as a separate message.
string[] lines = SplitStringOnNewLines(message);
for (int i = 0; i < lines.Length; i++)
{
formattedMessage.AppendFormat(
CultureInfo.CurrentCulture, finalFormat,
threadId, file,
lineNumber, columnNumber, category, code,
lines[i], endLineNumber, endColumnNumber,
subcategory, projectFile, logOutputProperties);
if (i < (lines.Length - 1))
{
formattedMessage.AppendLine();
}
}
return formattedMessage.ToString();
}
/// <summary>
/// Splits strings on 'newLines' with tolerance for Everett and Dogfood builds.
/// </summary>
/// <param name="s">String to split.</param>
private static string[] SplitStringOnNewLines(string s)
{
string[] subStrings = s.Split(s_newLines, StringSplitOptions.None);
return subStrings;
}
/// <summary>
/// The kinds of newline breaks we expect.
/// </summary>
/// <remarks>Currently we're not supporting "\r".</remarks>
private static readonly string[] s_newLines = { "\r\n", "\n" };
}
}
|