Changeset 1765

Timestamp:

2/8/2010 6:44:59 AM (2 years ago)

Author:

lowjoel

Message:

Removed the TaskProcessing? and TaskProcessed? events in Executor which duplicate the TaskStarted? and TaskFinished? events in Task. The TaskEventArgs? class can't disappear just yet as the TaskAdded? and TaskDeleted? events still need them (the sender is not the task, it's the executor) Addresses #275: Code Review

Location:

branches/eraser6/CodeReview

Files:

• Eraser.Manager/DirectExecutor.cs (modified) (6 diffs)
• Eraser.Manager/Executor.cs (modified) (1 diff)
• Eraser.Manager/Task.cs (modified) (5 diffs)
• Eraser/MainForm.cs (modified) (3 diffs)
• Eraser/ProgressForm.cs (modified) (3 diffs)
• Eraser/SchedulerPanel.cs (modified) (6 diffs)

branches/eraser6/CodeReview/Eraser.Manager/DirectExecutor.cs

@@ -27 +27 @@
 using System.Threading;
 using System.IO;
+using System.Runtime.Serialization;
+using System.Runtime.Serialization.Formatters.Binary;
 
 using Eraser.Util;
 using Eraser.Util.ExtensionMethods;
-using System.Security.Principal;
-using System.Runtime.Serialization;
-using System.Runtime.Serialization.Formatters.Binary;
-using System.Security.Permissions;
 
 namespace Eraser.Manager
@@ -152 +150 @@
         }
 
-        private void OnTaskEdited(object sender, TaskEventArgs e)
+        private void OnTaskEdited(object sender, EventArgs e)
         {
             //Find all schedule entries containing the task - since the user cannot make
             //edits to the task when it is queued (only if it is scheduled) remove
             //all task references and add them back
+            Task task = (Task)sender;
             lock (tasksLock)
                 for (int i = 0; i != scheduledTasks.Count; ++i)
@@ -162 +161 @@
                     {
                         Task currentTask = scheduledTasks.Values[i][j];
-                        if (currentTask == e.Task)
+                        if (currentTask == task)
                             scheduledTasks.Values[i].RemoveAt(j);
                         else
@@ -169 +168 @@
 
             //Then reschedule the task
-            if (e.Task.Schedule is RecurringSchedule)
-                ScheduleTask(e.Task);
+            if (task.Schedule is RecurringSchedule)
+                ScheduleTask(task);
         }
 
@@ -248 +247 @@
                         //Broadcast the task started event.
                         task.Canceled = false;
-                        task.OnTaskStarted(new TaskEventArgs(task));
-                        OnTaskProcessing(new TaskEventArgs(task));
+                        task.OnTaskStarted();
 
                         //Run the task
@@ -318 +316 @@
 
                         //And the task finished event.
-                        task.OnTaskFinished(new TaskEventArgs(task));
-                        OnTaskProcessed(new TaskEventArgs(task));
+                        task.OnTaskFinished();
 
                         //Remove the actively executing task from our instance variable

branches/eraser6/CodeReview/Eraser.Manager/Executor.cs

@@ -126 +126 @@
                 TaskDeleted(this, e);
         }
-
-        /// <summary>
-        /// The task processing event object.
-        /// </summary>
-        public EventHandler<TaskEventArgs> TaskProcessing { get; set; }
-
-        /// <summary>
-        /// Helper function for the Task processing event.
-        /// </summary>
-        protected void OnTaskProcessing(TaskEventArgs e)
-        {
-            if (TaskProcessing != null)
-                TaskProcessing(this, e);
-        }
-
-        /// <summary>
-        /// The task processed event object.
-        /// </summary>
-        public EventHandler<TaskEventArgs> TaskProcessed { get; set; }
-
-        /// <summary>
-        /// Helper function for the Task processed event.
-        /// </summary>
-        protected void OnTaskProcessed(TaskEventArgs e)
-        {
-            if (TaskProcessed != null)
-                TaskProcessed(this, e);
-        }
     }
 

branches/eraser6/CodeReview/Eraser.Manager/Task.cs

@@ -226 +226 @@
         /// The task has been edited.
         /// </summary>
-        public EventHandler<TaskEventArgs> TaskEdited { get; set; }
+        public EventHandler TaskEdited { get; set; }
 
         /// <summary>
         /// The start of the execution of a task.
         /// </summary>
-        public EventHandler<TaskEventArgs> TaskStarted { get; set; }
+        public EventHandler TaskStarted { get; set; }
 
         /// <summary>
@@ -241 +241 @@
         /// The completion of the execution of a task.
         /// </summary>
-        public EventHandler<TaskEventArgs> TaskFinished { get; set; }
+        public EventHandler TaskFinished { get; set; }
 
         /// <summary>
@@ -249 +249 @@
         {
             if (TaskEdited != null)
-                TaskEdited(this, new TaskEventArgs(this));
+                TaskEdited(this, EventArgs.Empty);
         }
 
@@ -255 +255 @@
         /// Broadcasts the task execution start event.
         /// </summary>
-        /// <param name="e"></param>
-        internal void OnTaskStarted(TaskEventArgs e)
+        internal void OnTaskStarted()
         {
             if (TaskStarted != null)
-                TaskStarted(this, e);
+                TaskStarted(this, EventArgs.Empty);
             Executing = true;
             Progress = new SteppedProgressManager();
@@ -294 +293 @@
         /// Broadcasts the task execution completion event.
         /// </summary>
-        /// <param name="e"></param>
-        internal void OnTaskFinished(TaskEventArgs e)
+        internal void OnTaskFinished()
         {
             if (TaskFinished != null)
-                TaskFinished(this, e);
+                TaskFinished(this, EventArgs.Empty);
             Executing = false;
             Progress = null;

branches/eraser6/CodeReview/Eraser/MainForm.cs

@@ -54 +54 @@
             Theming.ApplyTheme(notificationMenu);
 
-            //Connect to the executor task processing and processed events.
-            Program.eraserClient.TaskProcessing += OnTaskProcessing;
-            Program.eraserClient.TaskProcessed += OnTaskProcessed;
+            //For every task we need to register the Task Started and Task Finished
+            //event handlers for progress notifications
+            foreach (Task task in Program.eraserClient.Tasks)
+                OnTaskAdded(this, new TaskEventArgs(task));
+            Program.eraserClient.TaskAdded += OnTaskAdded;
+            Program.eraserClient.TaskDeleted += OnTaskDeleted;
 
             //Check the notification area context menu's minimise to tray item.
@@ -305 +308 @@
 
         #region Task processing code (for notification area animation)
-        void OnTaskProcessing(object sender, TaskEventArgs e)
+        void OnTaskAdded(object sender, TaskEventArgs e)
+        {
+            e.Task.TaskStarted += OnTaskProcessing;
+            e.Task.TaskFinished += OnTaskProcessed;
+        }
+
+        void OnTaskDeleted(object sender, TaskEventArgs e)
+        {
+            e.Task.TaskStarted -= OnTaskProcessing;
+            e.Task.TaskFinished -= OnTaskProcessed;
+        }
+
+        void OnTaskProcessing(object sender, EventArgs e)
         {
             if (InvokeRequired)
             {
-                Invoke((EventHandler<TaskEventArgs>)OnTaskProcessing, sender, e);
+                Invoke((EventHandler)OnTaskProcessing, sender, e);
                 return;
             }
 
-            string iconText = S._("Eraser") + " - " + S._("Processing:") + ' ' + e.Task.UIText;
+            Task task = (Task)sender;
+            string iconText = S._("Eraser") + " - " + S._("Processing:") + ' ' + task.UIText;
             if (iconText.Length >= 64)
                 iconText = iconText.Remove(60) + "...";
@@ -322 +338 @@
         }
 
-        void OnTaskProcessed(object sender, TaskEventArgs e)
+        void OnTaskProcessed(object sender, EventArgs e)
         {
             if (InvokeRequired)
             {
-                Invoke((EventHandler<TaskEventArgs>)OnTaskProcessed, sender, e);
+                Invoke((EventHandler)OnTaskProcessed, sender, e);
                 return;
             }

branches/eraser6/CodeReview/Eraser/ProgressForm.cs

@@ -89 +89 @@
         }
 
-        private void task_TaskFinished(object sender, TaskEventArgs e)
+        private void task_TaskFinished(object sender, EventArgs e)
         {
             if (IsDisposed || !IsHandleCreated)
@@ -95 +95 @@
             if (InvokeRequired)
             {
-                Invoke((EventHandler<TaskEventArgs>)task_TaskFinished, sender, e);
+                Invoke((EventHandler)task_TaskFinished, sender, e);
                 return;
             }
 
             //Update the UI. Set everything to 100%
+            Task task = (Task)sender;
             timeLeft.Text = item.Text = pass.Text = string.Empty;
             overallProgressLbl.Text = S._("Total: {0,2:#0.00%}", 1.0);
@@ -109 +110 @@
             //Inform the user on the status of the task.
             LogLevel highestLevel = LogLevel.Information;
-            LogEntryCollection entries = e.Task.Log.LastSessionEntries;
+            LogEntryCollection entries = task.Log.LastSessionEntries;
             foreach (LogEntry log in entries)
                 if (log.Level > highestLevel)

branches/eraser6/CodeReview/Eraser/SchedulerPanel.cs

@@ -186 +186 @@
         /// </summary>
         /// <param name="e">The task event object.</param>
-        void task_TaskStarted(object sender, TaskEventArgs e)
+        void task_TaskStarted(object sender, EventArgs e)
         {
             if (InvokeRequired)
             {
-                Invoke((EventHandler<TaskEventArgs>)task_TaskStarted, sender, e);
+                Invoke((EventHandler)task_TaskStarted, sender, e);
                 return;
             }
 
             //Get the list view item
-            ListViewItem item = GetTaskItem(e.Task);
+            Task task = (Task)sender;
+            ListViewItem item = GetTaskItem(task);
 
             //Update the status.
@@ -228 +229 @@
         /// Handles the task completion event.
         /// </summary>
-        void task_TaskFinished(object sender, TaskEventArgs e)
+        void task_TaskFinished(object sender, EventArgs e)
         {
             if (InvokeRequired)
             {
-                Invoke((EventHandler<TaskEventArgs>)task_TaskFinished, sender, e);
+                Invoke((EventHandler)task_TaskFinished, sender, e);
                 return;
             }
 
             //Get the list view item
-            ListViewItem item = GetTaskItem(e.Task);
+            Task task = (Task)sender;
+            ListViewItem item = GetTaskItem(task);
             if (item == null)
                 return;
@@ -250 +252 @@
             //Get the exit status of the task.
             LogLevel highestLevel = LogLevel.Information;
-            LogEntryCollection logs = e.Task.Log.LastSessionEntries;
+            LogEntryCollection logs = task.Log.LastSessionEntries;
             foreach (LogEntry log in logs)
                 if (log.Level > highestLevel)
@@ -269 +271 @@
                 {
                     case LogLevel.Warning:
-                        message = S._("The task {0} has completed with warnings.", e.Task.UIText);
+                        message = S._("The task {0} has completed with warnings.", task.UIText);
                         icon = ToolTipIcon.Warning;
                         break;
                     case LogLevel.Error:
-                        message = S._("The task {0} has completed with errors.", e.Task.UIText);
+                        message = S._("The task {0} has completed with errors.", task.UIText);
                         icon = ToolTipIcon.Error;
                         break;
                     case LogLevel.Fatal:
-                        message = S._("The task {0} did not complete.", e.Task.UIText);
+                        message = S._("The task {0} did not complete.", task.UIText);
                         icon = ToolTipIcon.Error;
                         break;
                     default:
-                        message = S._("The task {0} has completed.", e.Task.UIText);
+                        message = S._("The task {0} has completed.", task.UIText);
                         icon = ToolTipIcon.Info;
                         break;
@@ -292 +294 @@
             //If the user requested us to remove completed one-time tasks, do so.
             if (EraserSettings.Get().ClearCompletedTasks &&
-                (e.Task.Schedule == Schedule.RunNow) && highestLevel < LogLevel.Warning)
-            {
-                Program.eraserClient.Tasks.Remove(e.Task);
+                (task.Schedule == Schedule.RunNow) && highestLevel < LogLevel.Warning)
+            {
+                Program.eraserClient.Tasks.Remove(task);
             }
 
@@ -319 +321 @@
                 //category since run-on-restart tasks will be changed to immediately
                 //run tasks.
-                CategorizeTask(e.Task, item);
+                CategorizeTask(task, item);
 
                 //Update the status of the task.