UnrealEngineUWP/Engine/Source/Programs/DotNETCommon/DotNETUtilities/HelpUtils.cs

// Copyright Epic Games, Inc. All Rights Reserved.

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Linq;
using System.Text;
using System.Threading.Tasks;

namespace Tools.DotNETCommon
{
	/// <summary>
	/// Utility functions for showing help for objects
	/// </summary>
	[Obsolete("Functionality in the Tools.DotNETCommon namespace is deprecated. Please reference the EpicGames.Core namespace and assembly instead.")]
	public static class HelpUtils
	{
		/// <summary>
		/// Gets the width of the window for formatting purposes
		/// </summary>
		public static int WindowWidth
		{
			get
			{
				// Get the window width, using a default value if there's no console attached to this process.
				int NewWindowWidth;
				try
				{
					NewWindowWidth = Console.WindowWidth;
				}
				catch
				{
					NewWindowWidth = 240;
				}

				if (NewWindowWidth <= 0)
				{
					NewWindowWidth = 240;
				}

				return NewWindowWidth;
			}
		}

		/// <summary>
		/// Prints help for the given object type
		/// </summary>
		/// <param name="Type">Type to print help for</param>
		public static void PrintHelp(string Title, Type Type)
		{
			PrintHelp(Title, GetDescription(Type), CommandLineArguments.GetParameters(Type));
		}

		/// <summary>
		/// Prints help for a command
		/// </summary>
		/// <param name="Title">Title for the help text</param>
		/// <param name="Description">Description for the command</param>
		/// <param name="Parameters">List of parameters</param>
		public static void PrintHelp(string Title, string Description, List<KeyValuePair<string, string>> Parameters)
		{
			int MaxWidth = WindowWidth;

			bool bFirstLine = true;
			if (!String.IsNullOrEmpty(Title))
			{
				PrintParagraph(Title, MaxWidth);
				bFirstLine = false;
			}

			if (!String.IsNullOrEmpty(Description))
			{
				if (!bFirstLine)
				{
					Log.TraceInformation("");
				}
				PrintParagraph(Description, MaxWidth);
				bFirstLine = false;
			}

			if (Parameters.Count > 0)
			{
				if (!bFirstLine)
				{
					Log.TraceInformation("");
				}

				Log.TraceInformation("Parameters:");
				PrintTable(Parameters, 4, 24, MaxWidth);
			}
		}

		/// <summary>
		/// Gets the description from a type
		/// </summary>
		/// <param name="Type">The type to get a description for</param>
		/// <returns>The description text</returns>
		public static string GetDescription(Type Type)
		{
			StringBuilder DescriptionText = new StringBuilder();
			foreach (DescriptionAttribute Attribute in Type.GetCustomAttributes(typeof(DescriptionAttribute), false))
			{
				if (DescriptionText.Length > 0)
				{
					DescriptionText.AppendLine();
				}
				DescriptionText.AppendLine(Attribute.Description);
			}
			return DescriptionText.ToString();
		}

		/// <summary>
		/// Prints a paragraph of text using word wrapping
		/// </summary>
		/// <param name="Text">Text to print</param>
		/// <param name="MaxWidth">Maximum width for each line</param>
		public static void PrintParagraph(string Text)
		{
			PrintParagraph(Text, WindowWidth - 1);
		}

		/// <summary>
		/// Prints a paragraph of text using word wrapping
		/// </summary>
		/// <param name="Text">Text to print</param>
		/// <param name="MaxWidth">Maximum width for each line</param>
		public static void PrintParagraph(string Text, int MaxWidth)
		{
			List<string> Lines = StringUtils.WordWrap(Text, MaxWidth);
			foreach (string Line in Lines)
			{
				Log.TraceInformation("{0}", Line);
			}
		}

		/// <summary>
		/// Formats the given parameters as so:
		///     -Param1     Param1 Description
		///
		///     -Param2      Param2 Description, this description is
		///                  longer and splits onto a separate line. 
		///
		///     -Param3      Param3 Description continues as before. 
		/// </summary>
		/// <param name="Items">List of parameters arranged as "-ParamName Param Description"</param>
		/// <param name="Indent">Indent from the left hand side</param>
		/// <param name="DefaultRightPadding">The minimum padding from the start of the param name to the start of the description (resizes with larger param names)</param>
		/// <returns></returns>
		public static void PrintTable(List<KeyValuePair<string, string>> Items, int Indent, int MinFirstColumnWidth)
		{
			PrintTable(Items, Indent, MinFirstColumnWidth, WindowWidth - 1);
		}

		/// <summary>
		/// Formats the given parameters as so:
		///     -Param1     Param1 Description
		///
		///     -Param2      Param2 Description, this description is
		///                  longer and splits onto a separate line. 
		///
		///     -Param3      Param3 Description continues as before. 
		/// </summary>
		/// <param name="Items">List of parameters arranged as "-ParamName Param Description"</param>
		/// <param name="Indent">Indent from the left hand side</param>
		/// <param name="DefaultRightPadding">The minimum padding from the start of the param name to the start of the description (resizes with larger param names)</param>
		/// <returns></returns>
		public static void PrintTable(List<KeyValuePair<string, string>> Items, int Indent, int MinFirstColumnWidth, int MaxWidth)
		{
			if(Items.Count > 0)
			{
				// string used to intent the param
				string IndentString = new string(' ', Indent);

				// default the padding value
				int RightPadding = Math.Max(MinFirstColumnWidth, Items.Max(x => x.Key.Length + 1));

				// Build the formatted params
				foreach(KeyValuePair<string, string> Item in Items)
				{
					// build the param first, including intend and padding on the rights size
					string ParamString = IndentString + Item.Key.PadRight(RightPadding);

					// Build the description line by line, adding the same amount of intending each time. 
					List<string> DescriptionLines = StringUtils.WordWrap(Item.Value, MaxWidth - ParamString.Length);

					foreach(string DescriptionLine in DescriptionLines)
					{
						// Formatting as following:
						// <Indent>-param<Right Padding>Description<New line>
						Log.TraceInformation("{0}{1}", ParamString, DescriptionLine);

						// we replace the param string on subsequent lines with white space of the same length
						ParamString = string.Empty.PadRight(IndentString.Length + RightPadding);
					}
				}
			}
		}
	}
}