/// <summary>
/// Does the specified action while logging contextual information.
/// </summary>
/// <param name="tag">The tag.</param>
/// <param name="toDoPriority">The priority.</param>
/// <param name="author">The author.</param>
/// <param name="description">The description.</param>
/// <param name="action">The action.</param>
private static void Do(string tag, ToDoPriority toDoPriority, string author, string description, Action action = null)
{
if (ToDo.IsToDoEnabled || toDoPriority == ToDoPriority.Critical || toDoPriority == ToDoPriority.High)
{
var stackTrace = new StackTrace();
string methodName = stackTrace.GetFrame(2).GetMethod().Name;
Type declaringType = stackTrace.GetFrame(2).GetMethod().DeclaringType;
if (declaringType != null)
{
string className = declaringType.FullName;
int lineNumber = stackTrace.GetFrame(2).GetFileLineNumber();
string fileName = stackTrace.GetFrame(2).GetFileName();
const string format = "{1} - Priority: {2}, Author: {3}, Description: {4}{0}At {5}.{6}, File: {7}, Line: {8}{0}";
string message = string.Format(format, Environment.NewLine, tag, toDoPriority, author, description, className, methodName, fileName, lineNumber);
Logger.Warn(message);
}
}
// Now Run the action.
if (action != null)
{
action();
}
}
public ToDoCreatePage(ToDoPriority priority)
{
_priority = priority;
InitializeComponent();
TimePicker.Time = DateTime.Now.TimeOfDay;
}
/// <summary>
/// Does the specified action while logging contextual information.
/// </summary>
/// <param name="tag">The tag.</param>
/// <param name="toDoPriority">The priority.</param>
/// <param name="author">The author.</param>
/// <param name="description">The description.</param>
/// <param name="action">The action.</param>
private static void Do(string tag, ToDoPriority toDoPriority, string author, string description, Action action = null)
{
if (ToDo.IsToDoEnabled || toDoPriority == ToDoPriority.Critical || toDoPriority == ToDoPriority.High)
{
var stackTrace = new StackTrace();
string methodName = stackTrace.GetFrame(2).GetMethod().Name;
Type declaringType = stackTrace.GetFrame(2).GetMethod().DeclaringType;
if (declaringType != null)
{
string className = declaringType.FullName;
int lineNumber = stackTrace.GetFrame(2).GetFileLineNumber();
string fileName = stackTrace.GetFrame(2).GetFileName();
const string format = "{1} - Priority: {2}, Author: {3}, Description: {4}{0}At {5}.{6}, File: {7}, Line: {8}{0}";
string message = string.Format(format, Environment.NewLine, tag, toDoPriority, author, description, className, methodName, fileName, lineNumber);
Logger.Warn(message);
}
}
// Now Run the action.
if (action != null)
{
action();
}
}
/// <summary>
/// Implementation the specified action.
/// </summary>
/// <param name="toDoPriority">The priority.</param>
/// <param name="author">The author.</param>
/// <param name="description">The description.</param>
/// <param name="action">The action.</param>
public static void Implement(ToDoPriority toDoPriority, string author, string description, Action action = null)
{
Do("Implementation Needed", toDoPriority, author, description, action);
}
/// <summary>
/// Logs the specified action as an area for refactoring.
/// </summary>
/// <param name="toDoPriority">The priority.</param>
/// <param name="author">The author.</param>
/// <param name="description">The description.</param>
/// <param name="action">The action.</param>
public static void Refactor(ToDoPriority toDoPriority, string author, string description, Action action = null)
{
Do("Refactor Needed", toDoPriority, author, description, action);
}
/// <summary>
/// Logs the specified action as a workaround
/// </summary>
/// <param name="toDoPriority">The priority.</param>
/// <param name="author">The author.</param>
/// <param name="description">The description.</param>
/// <param name="action">The action.</param>
public static void WorkAround(ToDoPriority toDoPriority, string author, string description, Action action = null)
{
Do("Workaround performed", toDoPriority, author, description, action);
}
/// <summary>
/// Logs the specified action as an area for a bugfix
/// </summary>
/// <param name="toDoPriority">The priority.</param>
/// <param name="author">The author.</param>
/// <param name="description">The description.</param>
/// <param name="action">The action.</param>
public static void BugFix(ToDoPriority toDoPriority, string author, string description, Action action = null)
{
Do("BugFix Needed", toDoPriority, author, description, action);
}
/// <summary>
/// Logs the specified action as a code review
/// </summary>
/// <param name="toDoPriority">The priority.</param>
/// <param name="author">The author.</param>
/// <param name="description">The description.</param>
/// <param name="action">The action.</param>
public static void CodeReview(ToDoPriority toDoPriority, string author, string description, Action action = null)
{
Do("CodeReview Needed", toDoPriority, author, description, action);
}
/// <summary>
/// Logs the specified action for optimization.
/// </summary>
/// <param name="toDoPriority">The priority.</param>
/// <param name="author">The author.</param>
/// <param name="description">The description.</param>
/// <param name="action">The action.</param>
public static void Optimize(ToDoPriority toDoPriority, string author, string description, Action action = null)
{
Do("Optimization Needed", toDoPriority, author, description, action);
}
/// <summary>
/// Implementation the specified action.
/// </summary>
/// <param name="toDoPriority">The priority.</param>
/// <param name="author">The author.</param>
/// <param name="description">The description.</param>
/// <param name="action">The action.</param>
public static void Implement(ToDoPriority toDoPriority, string author, string description, Action action = null)
{
Do("Implementation Needed", toDoPriority, author, description, action);
}
/// <summary>
/// Logs the specified action as an area for refactoring.
/// </summary>
/// <param name="toDoPriority">The priority.</param>
/// <param name="author">The author.</param>
/// <param name="description">The description.</param>
/// <param name="action">The action.</param>
public static void Refactor(ToDoPriority toDoPriority, string author, string description, Action action = null)
{
Do("Refactor Needed", toDoPriority, author, description, action);
}
/// <summary>
/// Logs the specified action as a workaround
/// </summary>
/// <param name="toDoPriority">The priority.</param>
/// <param name="author">The author.</param>
/// <param name="description">The description.</param>
/// <param name="action">The action.</param>
public static void WorkAround(ToDoPriority toDoPriority, string author, string description, Action action = null)
{
Do("Workaround performed", toDoPriority, author, description, action);
}
/// <summary>
/// Logs the specified action as an area for a bugfix
/// </summary>
/// <param name="toDoPriority">The priority.</param>
/// <param name="author">The author.</param>
/// <param name="description">The description.</param>
/// <param name="action">The action.</param>
public static void BugFix(ToDoPriority toDoPriority, string author, string description, Action action = null)
{
Do("BugFix Needed", toDoPriority, author, description, action);
}
/// <summary>
/// Logs the specified action as a code review
/// </summary>
/// <param name="toDoPriority">The priority.</param>
/// <param name="author">The author.</param>
/// <param name="description">The description.</param>
/// <param name="action">The action.</param>
public static void CodeReview(ToDoPriority toDoPriority, string author, string description, Action action = null)
{
Do("CodeReview Needed", toDoPriority, author, description, action);
}
/// <summary>
/// Logs the specified action for optimization.
/// </summary>
/// <param name="toDoPriority">The priority.</param>
/// <param name="author">The author.</param>
/// <param name="description">The description.</param>
/// <param name="action">The action.</param>
public static void Optimize(ToDoPriority toDoPriority, string author, string description, Action action = null)
{
Do("Optimization Needed", toDoPriority, author, description, action);
}
