From 31aea2831f980875038a7999c2e5f993e16898ad Mon Sep 17 00:00:00 2001 From: Lukasz Baldyga Date: Sun, 15 Nov 2020 05:14:36 +0000 Subject: [PATCH] CodeMaid Cleanup for main project --- .../Advanced Software Engineering/App.config | 2 +- .../Commander.cs | 21 +++++----- .../Advanced Software Engineering/Drawer.cs | 19 ++++++--- .../Advanced Software Engineering/Program.cs | 15 +++---- .../Properties/AssemblyInfo.cs | 3 +- .../SettingsAndHelperFunctions.cs | 12 +++--- .../Verbs/DrawingVerbs/Circle.cs | 13 ++----- .../Verbs/DrawingVerbs/Clear.cs | 12 ++---- .../Verbs/DrawingVerbs/Dot.cs | 11 ++---- .../Verbs/DrawingVerbs/DrawLines.cs | 18 ++++----- .../Verbs/DrawingVerbs/DrawTo.cs | 15 +++---- .../Verbs/DrawingVerbs/Fill.cs | 13 ++----- .../Verbs/DrawingVerbs/FillColor.cs | 17 +++----- .../Verbs/DrawingVerbs/MoveTo.cs | 16 +++----- .../Verbs/DrawingVerbs/PenColor.cs | 15 +++---- .../Verbs/DrawingVerbs/Quadrilateral.cs | 12 ++---- .../Verbs/DrawingVerbs/Rectangle.cs | 19 ++++----- .../Verbs/DrawingVerbs/RegularPolygon.cs | 16 ++++---- .../Verbs/DrawingVerbs/ResetPen.cs | 12 ++---- .../Verbs/DrawingVerbs/Square.cs | 11 ++---- .../Verbs/DrawingVerbs/Triangle.cs | 12 ++---- .../Verbs/ValueHelper.cs | 9 ++--- .../Verbs/Verb.cs | 11 ++---- .../Verbs/VerbFactory.cs | 18 +++------ .../Windows/AboutWindow.cs | 26 ++++--------- .../Windows/CommandHelp.cs | 4 +- .../Windows/DetailsWindow.cs | 4 +- .../Windows/DrawPreview.cs | 32 +++++---------- .../Windows/ErrorWindow.cs | 17 ++++---- .../Windows/Menu.cs | 37 ++++++------------ .../Windows/TextEditor.cs | 39 +++++++------------ 31 files changed, 173 insertions(+), 308 deletions(-) diff --git a/Advanced Software Engineering/Advanced Software Engineering/App.config b/Advanced Software Engineering/Advanced Software Engineering/App.config index 56efbc7..ffaf540 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/App.config +++ b/Advanced Software Engineering/Advanced Software Engineering/App.config @@ -1,6 +1,6 @@  - + \ No newline at end of file diff --git a/Advanced Software Engineering/Advanced Software Engineering/Commander.cs b/Advanced Software Engineering/Advanced Software Engineering/Commander.cs index 08ce86c..0be44c2 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Commander.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Commander.cs @@ -1,19 +1,17 @@ using System; using System.Collections.Generic; using System.Drawing; -using System.Drawing.Drawing2D; -using System.Linq; namespace Advanced_Software_Engineering { + /// /// The commander class takes care of commands. It also takes control of the drawer. /// public class Commander { - - Graphics graphics; - List commands = new List(); - Drawer drawer; - bool commands_ok = true; + private Graphics graphics; + private List commands = new List(); + private Drawer drawer; + private bool commands_ok = true; /// /// This command updates the graphics element (usually) when the page repaints. @@ -58,6 +56,7 @@ namespace Advanced_Software_Engineering { this.ProcessCommands(rawCommands); drawer.ResetDrawer(); } + /// /// Adds a verb to the command list to be executed. /// @@ -71,7 +70,7 @@ namespace Advanced_Software_Engineering { /// /// Processes commands seperated by \n or \r\n /// If the command is wrong, don't remove all of the commands - public void ProcessCommands(string rawCommands, bool pardonCommands=false) { + public void ProcessCommands(string rawCommands, bool pardonCommands = false) { //ignore case rawCommands = rawCommands.ToLower(); Console.WriteLine("Processing:\n" + rawCommands); @@ -101,7 +100,7 @@ namespace Advanced_Software_Engineering { } if (failed) { - if(!pardonCommands) RemoveAllCommands(); + if (!pardonCommands) RemoveAllCommands(); commands_ok = false; } else { commands_ok = true; @@ -112,7 +111,6 @@ namespace Advanced_Software_Engineering { foreach (Verb verb in this.commands) { Console.WriteLine(verb.GetDescription()); } - } /// @@ -157,5 +155,4 @@ namespace Advanced_Software_Engineering { return commands_ok; } } - -} +} \ No newline at end of file diff --git a/Advanced Software Engineering/Advanced Software Engineering/Drawer.cs b/Advanced Software Engineering/Advanced Software Engineering/Drawer.cs index fe6370b..5212e14 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Drawer.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Drawer.cs @@ -1,24 +1,25 @@ using System; -using System.Collections.Generic; using System.Drawing; using System.Drawing.Drawing2D; using System.Linq; -using System.Text; -using System.Threading.Tasks; namespace Advanced_Software_Engineering { + /// /// The drawer is responsible for drawing on the graphics object. /// public class Drawer { + /// /// The starting color of the pen / brush /// protected static Color defaultColor = Color.Black; + /// /// The deafult width of the pen /// protected static float defaultWidth = 1f; + /// /// Weather enclosed spaces will have fill. /// @@ -28,6 +29,7 @@ namespace Advanced_Software_Engineering { /// The Brush object /// protected SolidBrush brush; + /// /// The Pen object /// @@ -37,6 +39,7 @@ namespace Advanced_Software_Engineering { /// The current position of the pen. /// protected Point penPosition; + /// /// The graphics object /// @@ -73,6 +76,7 @@ namespace Advanced_Software_Engineering { /// /// Position to move the pen to public void MovePen(Point point) => penPosition = point; + /// /// Returns the current pen position /// @@ -84,14 +88,17 @@ namespace Advanced_Software_Engineering { /// /// current fill satus public bool GetFill() => fill; + /// /// Allows the filling of objects. /// public void EnableFill() => fill = true; + /// /// Disables the filling of objects. /// public void DisableFill() => fill = false; + /// /// Set the filling of objects /// @@ -103,6 +110,7 @@ namespace Advanced_Software_Engineering { /// /// Pen color public void SetPenColor(Color color) => pen.Color = color; + /// /// Set the width of the pen /// @@ -129,7 +137,6 @@ namespace Advanced_Software_Engineering { /// /// Points to draw to public void DrawLines(Point[] points) { - if (points.Length < 2) { throw new Exception("Cannot have less than two points in a line"); } @@ -139,7 +146,7 @@ namespace Advanced_Software_Engineering { path.AddLines(points); path.AddLine(points[0], points.Last()); //Add final line - + DrawLines(path); } @@ -176,4 +183,4 @@ namespace Advanced_Software_Engineering { graphics.FillRectangle(new SolidBrush(pen.Color), penPosition.X, penPosition.Y, 1, 1); } } -} +} \ No newline at end of file diff --git a/Advanced Software Engineering/Advanced Software Engineering/Program.cs b/Advanced Software Engineering/Advanced Software Engineering/Program.cs index bcac0b0..42a3982 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Program.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Program.cs @@ -1,21 +1,16 @@ using System; -using System.Collections.Generic; -using System.Linq; -using System.Threading.Tasks; using System.Windows.Forms; -namespace Advanced_Software_Engineering -{ - static class Program - { +namespace Advanced_Software_Engineering { + + internal static class Program { public static Form MainMenu; /// /// The main entry point for the application. /// [STAThread] - static void Main() - { + private static void Main() { Application.EnableVisualStyles(); Application.SetCompatibleTextRenderingDefault(false); @@ -23,4 +18,4 @@ namespace Advanced_Software_Engineering Application.Run(MainMenu); } } -} +} \ No newline at end of file diff --git a/Advanced Software Engineering/Advanced Software Engineering/Properties/AssemblyInfo.cs b/Advanced Software Engineering/Advanced Software Engineering/Properties/AssemblyInfo.cs index 5547599..a0cd2ca 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Properties/AssemblyInfo.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Properties/AssemblyInfo.cs @@ -1,5 +1,4 @@ using System.Reflection; -using System.Runtime.CompilerServices; using System.Runtime.InteropServices; // General Information about an assembly is controlled through the following @@ -33,4 +32,4 @@ using System.Runtime.InteropServices; // by using the '*' as shown below: // [assembly: AssemblyVersion("1.0.*")] [assembly: AssemblyVersion("1.0.0.0")] -[assembly: AssemblyFileVersion("1.0.0.0")] +[assembly: AssemblyFileVersion("1.0.0.0")] \ No newline at end of file diff --git a/Advanced Software Engineering/Advanced Software Engineering/SettingsAndHelperFunctions.cs b/Advanced Software Engineering/Advanced Software Engineering/SettingsAndHelperFunctions.cs index 3560ef7..44dc947 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/SettingsAndHelperFunctions.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/SettingsAndHelperFunctions.cs @@ -1,14 +1,13 @@ -using System; -using System.Collections.Generic; -using System.Drawing; -using System.Security.Policy; +using System.Collections.Generic; using System.Windows.Forms; namespace Advanced_Software_Engineering { + /// /// This class simply provides settings and some functions that are used across many components. /// public class SettingsAndHelperFunctions { + /// /// The variable simply keep track of the windows that are currently shown (excluding ). /// @@ -23,8 +22,8 @@ namespace Advanced_Software_Engineering { System.Console.WriteLine("Showing MainMenu"); Program.MainMenu.Show(); } - } + /// /// This function removes spaces from the start and the end of the text. This should be unit tested. /// @@ -71,7 +70,6 @@ namespace Advanced_Software_Engineering { //Console.WriteLine("Result: " + result); return result; - } /// @@ -135,4 +133,4 @@ namespace Advanced_Software_Engineering { return commandAndParameters; } } -} +} \ No newline at end of file diff --git a/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/Circle.cs b/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/Circle.cs index fbcd6b0..a0f1942 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/Circle.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/Circle.cs @@ -1,16 +1,11 @@ -using System; -using System.Collections.Generic; -using System.Linq; -using System.Text; -using System.Threading.Tasks; +namespace Advanced_Software_Engineering.Verbs.DrawingVerbs { -namespace Advanced_Software_Engineering.Verbs.DrawingVerbs { /// /// Circle Verb class. /// public class Circle : Verb { - Drawer drawer; - double scale; + private Drawer drawer; + private double scale; /// /// Circle constructor creates the Circle verb. @@ -37,4 +32,4 @@ namespace Advanced_Software_Engineering.Verbs.DrawingVerbs { return "Draws a circle radius " + scale.ToString() + ", with origin of the pen"; } } -} +} \ No newline at end of file diff --git a/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/Clear.cs b/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/Clear.cs index 84205f6..be90b9f 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/Clear.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/Clear.cs @@ -1,15 +1,10 @@ -using System; -using System.Collections.Generic; -using System.Linq; -using System.Text; -using System.Threading.Tasks; +namespace Advanced_Software_Engineering.Verbs.DrawingVerbs { -namespace Advanced_Software_Engineering.Verbs.DrawingVerbs { /// /// The Clear Verb class. /// public class Clear : Verb { - Drawer drawer; + private Drawer drawer; /// /// Create the clear Verb @@ -31,6 +26,5 @@ namespace Advanced_Software_Engineering.Verbs.DrawingVerbs { public string GetDescription() { return "Clears the canvas"; } - } -} +} \ No newline at end of file diff --git a/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/Dot.cs b/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/Dot.cs index d6d52b7..87e923e 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/Dot.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/Dot.cs @@ -1,15 +1,10 @@ -using System; -using System.Collections.Generic; -using System.Linq; -using System.Text; -using System.Threading.Tasks; +namespace Advanced_Software_Engineering.Verbs.DrawingVerbs { -namespace Advanced_Software_Engineering.Verbs.DrawingVerbs { /// /// The Dot Verb class /// public class Dot : Verb { - Drawer drawer; + private Drawer drawer; /// /// Creates the Dot Verb @@ -34,4 +29,4 @@ namespace Advanced_Software_Engineering.Verbs.DrawingVerbs { return "Places a dot where the pen currently is"; } } -} +} \ No newline at end of file diff --git a/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/DrawLines.cs b/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/DrawLines.cs index e24656d..7e0d543 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/DrawLines.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/DrawLines.cs @@ -1,20 +1,16 @@ -using System; -using System.Collections.Generic; -using System.Drawing; -using System.Linq; -using System.Text; -using System.Threading.Tasks; +using System.Drawing; namespace Advanced_Software_Engineering.Verbs.DrawingVerbs { + /// /// DrawLines Verb class /// public class DrawLines : Verb { - Drawer drawer; - Point[] points; + private Drawer drawer; + private Point[] points; - bool descCreated = false; - string desc; + private bool descCreated = false; + private string desc; /// /// DrawLines constructor @@ -48,4 +44,4 @@ namespace Advanced_Software_Engineering.Verbs.DrawingVerbs { return desc; } } -} +} \ No newline at end of file diff --git a/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/DrawTo.cs b/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/DrawTo.cs index 484c62f..2331f69 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/DrawTo.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/DrawTo.cs @@ -1,18 +1,13 @@ -using System; -using System.Collections.Generic; -using System.Drawing; -using System.Linq; -using System.Text; -using System.Threading.Tasks; +using System.Drawing; namespace Advanced_Software_Engineering.Verbs.DrawingVerbs { + /// /// DrawTo Verb class /// public class DrawTo : Verb { - - Drawer drawer; - Point moveToPoint; + private Drawer drawer; + private Point moveToPoint; /// /// Creates the DrawTo intstance @@ -40,4 +35,4 @@ namespace Advanced_Software_Engineering.Verbs.DrawingVerbs { return "Draw line " + moveToPoint.X + ", " + moveToPoint.Y; } } -} +} \ No newline at end of file diff --git a/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/Fill.cs b/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/Fill.cs index 65cdf25..e625fc4 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/Fill.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/Fill.cs @@ -1,16 +1,11 @@ -using System; -using System.Collections.Generic; -using System.Linq; -using System.Text; -using System.Threading.Tasks; +namespace Advanced_Software_Engineering.Verbs.DrawingVerbs { -namespace Advanced_Software_Engineering.Verbs.DrawingVerbs { /// /// Fill Verb class /// public class Fill : Verb { - Drawer drawer; - bool enable; + private Drawer drawer; + private bool enable; /// /// Fill enables or disables the fill insider drawer @@ -39,4 +34,4 @@ namespace Advanced_Software_Engineering.Verbs.DrawingVerbs { else return "Disable fill"; } } -} +} \ No newline at end of file diff --git a/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/FillColor.cs b/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/FillColor.cs index 5f5df1a..4bf7797 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/FillColor.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/FillColor.cs @@ -1,19 +1,13 @@ -using System; -using System.Collections.Generic; -using System.Drawing; -using System.Drawing.Drawing2D; -using System.Linq; -using System.Text; -using System.Threading.Tasks; +using System.Drawing; namespace Advanced_Software_Engineering.Verbs.DrawingVerbs { + /// /// The FillColor Verb class /// public class FillColor : Verb { - - Drawer drawer; - Color color; + private Drawer drawer; + private Color color; /// /// Create the FillColor instance @@ -39,6 +33,5 @@ namespace Advanced_Software_Engineering.Verbs.DrawingVerbs { public string GetDescription() { return "Set fill color to: " + color.ToString(); } - } -} +} \ No newline at end of file diff --git a/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/MoveTo.cs b/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/MoveTo.cs index 6709545..3c688a3 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/MoveTo.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/MoveTo.cs @@ -1,18 +1,13 @@ -using System; -using System.Collections.Generic; -using System.Drawing; -using System.Linq; -using System.Text; -using System.Threading.Tasks; +using System.Drawing; namespace Advanced_Software_Engineering.Verbs.DrawingVerbs { + /// /// MoveTo Verb class /// public class MoveTo : Verb { - - Drawer drawer; - Point moveToPoint; + private Drawer drawer; + private Point moveToPoint; /// /// Creates a MoveTo instance @@ -49,6 +44,5 @@ namespace Advanced_Software_Engineering.Verbs.DrawingVerbs { public string GetDescription() { return "Move origin to " + moveToPoint.X + ", " + moveToPoint.Y; } - } -} +} \ No newline at end of file diff --git a/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/PenColor.cs b/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/PenColor.cs index 8b159e6..af172d1 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/PenColor.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/PenColor.cs @@ -1,18 +1,13 @@ -using System; -using System.Collections.Generic; -using System.Drawing; -using System.Linq; -using System.Text; -using System.Threading.Tasks; +using System.Drawing; namespace Advanced_Software_Engineering.Verbs.DrawingVerbs { + /// /// The PenColor Verb class /// public class PenColor : Verb { - - Drawer drawer; - Color color; + private Drawer drawer; + private Color color; /// /// Creates a PenColor instance @@ -39,4 +34,4 @@ namespace Advanced_Software_Engineering.Verbs.DrawingVerbs { return "Set pen color to: " + color.ToString(); } } -} +} \ No newline at end of file diff --git a/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/Quadrilateral.cs b/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/Quadrilateral.cs index 1a9ca06..8b5b378 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/Quadrilateral.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/Quadrilateral.cs @@ -1,16 +1,12 @@ -using System; -using System.Collections.Generic; -using System.Drawing; -using System.Linq; -using System.Text; -using System.Threading.Tasks; +using System.Drawing; namespace Advanced_Software_Engineering.Verbs.DrawingVerbs { + /// /// The Quadrilateral Verb class /// public class Quadrilateral : Verb { - Verb verb; + private Verb verb; /// /// Creates a Quadrilateral instances @@ -35,4 +31,4 @@ namespace Advanced_Software_Engineering.Verbs.DrawingVerbs { /// Description of the quadrilateral points public string GetDescription() => verb.GetDescription(); } -} +} \ No newline at end of file diff --git a/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/Rectangle.cs b/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/Rectangle.cs index 83946b4..e3c8340 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/Rectangle.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/Rectangle.cs @@ -1,12 +1,9 @@ using System; using System.Collections.Generic; using System.Drawing; -using System.Linq; -using System.Text; -using System.Threading.Tasks; -using System.Windows.Forms.VisualStyles; namespace Advanced_Software_Engineering.Verbs.DrawingVerbs { + /// /// Rectangle Verb class /// @@ -14,11 +11,11 @@ namespace Advanced_Software_Engineering.Verbs.DrawingVerbs { /// Correct /// public class Rectangle : Verb { - Drawer drawer; - PointF[] points; + private Drawer drawer; + private PointF[] points; - double width; - double height; + private double width; + private double height; /// /// Create a rectangle instance. Makes sure that @@ -29,7 +26,7 @@ namespace Advanced_Software_Engineering.Verbs.DrawingVerbs { public Rectangle(Drawer drawer, double width, double height) { this.drawer = drawer; - float root2 = (float) Math.Sqrt(2) / 2; + float root2 = (float)Math.Sqrt(2) / 2; points = new PointF[] { @@ -43,7 +40,6 @@ namespace Advanced_Software_Engineering.Verbs.DrawingVerbs { this.height = height; } - /// /// Gets the description from the rectangle /// @@ -67,6 +63,5 @@ namespace Advanced_Software_Engineering.Verbs.DrawingVerbs { drawer.DrawLines(morePoints.ToArray()); } - } -} +} \ No newline at end of file diff --git a/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/RegularPolygon.cs b/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/RegularPolygon.cs index fb23e3d..98aca88 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/RegularPolygon.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/RegularPolygon.cs @@ -1,20 +1,18 @@ using System; using System.Collections.Generic; using System.Drawing; -using System.Linq; -using System.Text; -using System.Threading.Tasks; namespace Advanced_Software_Engineering.Verbs.DrawingVerbs { + /// /// A class that generates a RegularPolygon verb. /// public class RegularPolygon : Verb { - Drawer drawer; - int sides; - double scale; - double offset; - List points; + private Drawer drawer; + private int sides; + private double scale; + private double offset; + private List points; /// /// Draws a regular polygon. @@ -66,4 +64,4 @@ namespace Advanced_Software_Engineering.Verbs.DrawingVerbs { return "Draws a " + sides + " sided regular polygon, with rotation of " + offset + " radians, with inner radius of " + scale; } } -} +} \ No newline at end of file diff --git a/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/ResetPen.cs b/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/ResetPen.cs index 146f2b7..aa58355 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/ResetPen.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/ResetPen.cs @@ -1,15 +1,10 @@ -using System; -using System.Collections.Generic; -using System.Linq; -using System.Text; -using System.Threading.Tasks; +namespace Advanced_Software_Engineering.Verbs.DrawingVerbs { -namespace Advanced_Software_Engineering.Verbs.DrawingVerbs { /// /// Setsets the pen to the initial position. /// public class ResetPen : Verb { - Drawer drawer; + private Drawer drawer; /// /// Creates the ResetPen verb @@ -31,6 +26,5 @@ namespace Advanced_Software_Engineering.Verbs.DrawingVerbs { public string GetDescription() { return "Moves pen to the start (0, 0)"; } - } -} +} \ No newline at end of file diff --git a/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/Square.cs b/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/Square.cs index bc03f15..bb0b6e5 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/Square.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/Square.cs @@ -1,16 +1,11 @@ -using System; -using System.Collections.Generic; -using System.Linq; -using System.Text; -using System.Threading.Tasks; +namespace Advanced_Software_Engineering.Verbs.DrawingVerbs { -namespace Advanced_Software_Engineering.Verbs.DrawingVerbs { /// /// The Square Verb class /// public class Square : Verb { + private Verb verb; - Verb verb; /// /// A new Squre instance. Draws squares using /// @@ -41,4 +36,4 @@ namespace Advanced_Software_Engineering.Verbs.DrawingVerbs { /// public string GetDescription() => verb.GetDescription(); } -} +} \ No newline at end of file diff --git a/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/Triangle.cs b/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/Triangle.cs index ffd6628..36f2c7b 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/Triangle.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Verbs/DrawingVerbs/Triangle.cs @@ -1,16 +1,12 @@ -using System; -using System.Collections.Generic; -using System.Drawing; -using System.Linq; -using System.Text; -using System.Threading.Tasks; +using System.Drawing; namespace Advanced_Software_Engineering.Verbs.DrawingVerbs { + /// /// The Triangle Verb class /// public class Triangle : Verb { - Verb verb; + private Verb verb; /// /// Creates a new Triangle instance using . @@ -53,4 +49,4 @@ namespace Advanced_Software_Engineering.Verbs.DrawingVerbs { /// Description of how the triangle will be drawn public string GetDescription() => verb.GetDescription(); } -} +} \ No newline at end of file diff --git a/Advanced Software Engineering/Advanced Software Engineering/Verbs/ValueHelper.cs b/Advanced Software Engineering/Advanced Software Engineering/Verbs/ValueHelper.cs index f8b4580..dabedaf 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Verbs/ValueHelper.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Verbs/ValueHelper.cs @@ -1,15 +1,13 @@ using System; -using System.Collections.Generic; using System.Drawing; -using System.Linq; -using System.Text; -using System.Threading.Tasks; namespace Advanced_Software_Engineering.Verbs { + /// /// This class contains a large amount of useful conversions /// public class ValueHelper { + /// /// Converts string to int (if possible) /// @@ -74,7 +72,6 @@ namespace Advanced_Software_Engineering.Verbs { if (text.StartsWith("#")) text = text.Substring(1); - switch (text.Length) { case 6: return Color.FromArgb( @@ -106,4 +103,4 @@ namespace Advanced_Software_Engineering.Verbs { return Color.FromArgb(a, r, g, b); } } -} +} \ No newline at end of file diff --git a/Advanced Software Engineering/Advanced Software Engineering/Verbs/Verb.cs b/Advanced Software Engineering/Advanced Software Engineering/Verbs/Verb.cs index 9f19498..238fed8 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Verbs/Verb.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Verbs/Verb.cs @@ -1,22 +1,19 @@ -using System; -using System.Collections.Generic; -using System.Linq; -using System.Text; -using System.Threading.Tasks; +namespace Advanced_Software_Engineering { -namespace Advanced_Software_Engineering { /// /// Verb is an interface for executing and getting the descriptions of Verbs. Some Verbs draw lines, some verbs will assign /// public interface Verb { + /// /// This executes the verb to the drawer inside it. /// void ExecuteVerb(); + /// /// The description of what the Verb will do. /// /// A string description of what the Verb will do string GetDescription(); } -} +} \ No newline at end of file diff --git a/Advanced Software Engineering/Advanced Software Engineering/Verbs/VerbFactory.cs b/Advanced Software Engineering/Advanced Software Engineering/Verbs/VerbFactory.cs index 36290ba..7aeef60 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Verbs/VerbFactory.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Verbs/VerbFactory.cs @@ -1,18 +1,16 @@ -using System; -using System.CodeDom; -using System.Collections.Generic; -using System.Linq; -using System.Security.Cryptography; -using System.Windows.Forms; -using System.Windows.Forms.VisualStyles; using Advanced_Software_Engineering.Verbs; using Advanced_Software_Engineering.Verbs.DrawingVerbs; +using System; +using System.Collections.Generic; +using System.Linq; namespace Advanced_Software_Engineering { + /// /// This class is responsible for creating Verbs. /// public class VerbFactory { + /// /// This function returns a Verb from a command and drawer. /// @@ -23,7 +21,6 @@ namespace Advanced_Software_Engineering { /// The command as a string /// A verb that maches the command public static Verb MakeVerb(Drawer drawer, string fullCommand) { - Dictionary commandAndParameters = SettingsAndHelperFunctions.CommandAndParameterParser(fullCommand); if (!commandAndParameters.Keys.Contains("command")) throw new Exception("There is no command to process"); @@ -41,7 +38,6 @@ namespace Advanced_Software_Engineering { return new MoveTo(drawer, ValueHelper.ConvertToInt(parameters[0]), ValueHelper.ConvertToInt(parameters[1])); - } else throw new Exception(command + " has an incorrect number of parameters"); case "drawto": @@ -142,7 +138,6 @@ namespace Advanced_Software_Engineering { return new Dot(drawer); } else throw new Exception(command + " doesn't take parameters"); - case "clear": if (parameterLength == 0) { return new Clear(drawer); @@ -210,7 +205,6 @@ namespace Advanced_Software_Engineering { default: throw new Exception("Unknown command"); } - } } -} +} \ No newline at end of file diff --git a/Advanced Software Engineering/Advanced Software Engineering/Windows/AboutWindow.cs b/Advanced Software Engineering/Advanced Software Engineering/Windows/AboutWindow.cs index 5f7148a..d9f3a63 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Windows/AboutWindow.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Windows/AboutWindow.cs @@ -1,22 +1,13 @@ -using System; -using System.Collections.Generic; -using System.ComponentModel; -using System.Data; -using System.Drawing; -using System.Linq; -using System.Text; -using System.Threading.Tasks; -using System.Windows.Forms; +using System.Windows.Forms; + +namespace Advanced_Software_Engineering { + + public partial class About_Window : Form { -namespace Advanced_Software_Engineering -{ - public partial class About_Window : Form - { /// ///Creates an About Window which shows details about the program. /// - public About_Window() - { + public About_Window() { InitializeComponent(); SettingsAndHelperFunctions.NumberOfWindows++; } @@ -26,9 +17,8 @@ namespace Advanced_Software_Engineering /// /// /// - private void About_Window_FormClosed(object sender, FormClosedEventArgs e) - { + private void About_Window_FormClosed(object sender, FormClosedEventArgs e) { SettingsAndHelperFunctions.WindowClosed(); } } -} +} \ No newline at end of file diff --git a/Advanced Software Engineering/Advanced Software Engineering/Windows/CommandHelp.cs b/Advanced Software Engineering/Advanced Software Engineering/Windows/CommandHelp.cs index 491cf97..7c6941d 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Windows/CommandHelp.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Windows/CommandHelp.cs @@ -1,10 +1,12 @@ using System.Windows.Forms; namespace Advanced_Software_Engineering { + /// /// This class is resposible for the command help window. The command help window shows help for the commands. /// public partial class CommandHelp : Form { + /// /// Initilize CommandHelp. /// @@ -12,4 +14,4 @@ namespace Advanced_Software_Engineering { InitializeComponent(); } } -} +} \ No newline at end of file diff --git a/Advanced Software Engineering/Advanced Software Engineering/Windows/DetailsWindow.cs b/Advanced Software Engineering/Advanced Software Engineering/Windows/DetailsWindow.cs index 7f360f3..b6ab735 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Windows/DetailsWindow.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Windows/DetailsWindow.cs @@ -1,10 +1,12 @@ using System.Windows.Forms; namespace Advanced_Software_Engineering { + /// /// This form is reponsible for showing details. It is essentially a textbox in a form. /// public partial class DetailsWindow : Form { + /// /// A details window dedicated to showing details. /// @@ -25,4 +27,4 @@ namespace Advanced_Software_Engineering { Text = title; } } -} +} \ No newline at end of file diff --git a/Advanced Software Engineering/Advanced Software Engineering/Windows/DrawPreview.cs b/Advanced Software Engineering/Advanced Software Engineering/Windows/DrawPreview.cs index 146a903..b0deb50 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Windows/DrawPreview.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Windows/DrawPreview.cs @@ -1,21 +1,13 @@ using System; -using System.Collections.Generic; -using System.ComponentModel; -using System.Data; using System.Drawing; -using System.Linq; -using System.Text; -using System.Threading.Tasks; using System.Windows.Forms; -namespace Advanced_Software_Engineering -{ - public partial class Draw_Preview : Form - { +namespace Advanced_Software_Engineering { - Graphics graphics; - Commander commander; - bool pardonCommands; + public partial class Draw_Preview : Form { + private Graphics graphics; + private Commander commander; + private bool pardonCommands; /// /// The draw preview window. Spawns the basic DrawPreview. @@ -23,8 +15,7 @@ namespace Advanced_Software_Engineering /// /// This window is responsible for showing what has been drawn. /// - public Draw_Preview() - { + public Draw_Preview() { InitializeComponent(); SettingsAndHelperFunctions.NumberOfWindows++; graphics = panel1.CreateGraphics(); @@ -51,8 +42,7 @@ namespace Advanced_Software_Engineering button1.Enabled = false; } - private void DrawPreview_FormClosed(object sender, FormClosedEventArgs e) - { + private void DrawPreview_FormClosed(object sender, FormClosedEventArgs e) { SettingsAndHelperFunctions.WindowClosed(); Dispose(); } @@ -61,14 +51,12 @@ namespace Advanced_Software_Engineering DrawPreviewPane_Paint(sender, null); } - private void DrawPreviewPane_Paint(object sender, PaintEventArgs e) - { + private void DrawPreviewPane_Paint(object sender, PaintEventArgs e) { graphics = panel1.CreateGraphics(); commander.DrawAllCommands(graphics); } - private void SubmitCommand(object sender, EventArgs e) - { + private void SubmitCommand(object sender, EventArgs e) { commander.ProcessCommandsAndExecute(textBox1.Text, pardonCommands); textBox1.Text = ""; } @@ -124,4 +112,4 @@ namespace Advanced_Software_Engineering } } } -} +} \ No newline at end of file diff --git a/Advanced Software Engineering/Advanced Software Engineering/Windows/ErrorWindow.cs b/Advanced Software Engineering/Advanced Software Engineering/Windows/ErrorWindow.cs index d4a3806..1251076 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Windows/ErrorWindow.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Windows/ErrorWindow.cs @@ -1,27 +1,26 @@ using System; using System.Collections.Generic; -using System.ComponentModel; -using System.Data; using System.Drawing; -using System.Linq; -using System.Text; -using System.Threading.Tasks; using System.Windows.Forms; namespace Advanced_Software_Engineering { + /// /// The error window that can show errors, warnings and messages. /// public partial class ErrorWindow : Form { - string desc; + private string desc; + /// /// The error message type. /// public const int ERROR_MESSAGE = 0; + /// /// The warning message type /// public const int WARNING_MESSAGE = 1; + /// /// The info message type /// @@ -67,7 +66,6 @@ namespace Advanced_Software_Engineering { SetPicture(type); Focus(); - } /// @@ -78,7 +76,7 @@ namespace Advanced_Software_Engineering { pictureBox1.Image = IMAGEDIR[type]; pictureBox1.Refresh(); - switch(type) { + switch (type) { case ERROR_MESSAGE: groupBox1.Text = "Error"; break; @@ -112,7 +110,6 @@ namespace Advanced_Software_Engineering { } private void ErrorWindow_Load(object sender, EventArgs e) { - } } -} +} \ No newline at end of file diff --git a/Advanced Software Engineering/Advanced Software Engineering/Windows/Menu.cs b/Advanced Software Engineering/Advanced Software Engineering/Windows/Menu.cs index 3ccc399..2789536 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Windows/Menu.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Windows/Menu.cs @@ -1,53 +1,40 @@ using System; -using System.Collections.Generic; -using System.ComponentModel; -using System.Data; -using System.Drawing; -using System.Linq; -using System.Text; -using System.Threading.Tasks; using System.Windows.Forms; -namespace Advanced_Software_Engineering -{ - public partial class Menu : Form - { +namespace Advanced_Software_Engineering { + + public partial class Menu : Form { + /// - /// This creates the main menu window you see when launching the program. + /// This creates the main menu window you see when launching the program. /// /// /// This program window is only meant to show at launch and when all of the other windows are closed. It launches all windows independently of each other, so a theoretically unlimited number of windows can exist. /// - public Menu() - { + public Menu() { InitializeComponent(); } - private void button1_Click(object sender, EventArgs e) - { + private void button1_Click(object sender, EventArgs e) { new Draw_Preview().Show(); this.Hide(); } - private void button2_Click(object sender, EventArgs e) - { + private void button2_Click(object sender, EventArgs e) { new Text_Editor().Show(); this.Hide(); } - private void button3_Click(object sender, EventArgs e) - { + private void button3_Click(object sender, EventArgs e) { new About_Window().Show(); this.Hide(); } - private void button4_Click(object sender, EventArgs e) - { + private void button4_Click(object sender, EventArgs e) { this.Close(); } - private void Menu_Load(object sender, EventArgs e) - { + private void Menu_Load(object sender, EventArgs e) { //Do things on load } @@ -55,4 +42,4 @@ namespace Advanced_Software_Engineering new ErrorWindow().Show(); } } -} +} \ No newline at end of file diff --git a/Advanced Software Engineering/Advanced Software Engineering/Windows/TextEditor.cs b/Advanced Software Engineering/Advanced Software Engineering/Windows/TextEditor.cs index 23190a5..e2ceb89 100644 --- a/Advanced Software Engineering/Advanced Software Engineering/Windows/TextEditor.cs +++ b/Advanced Software Engineering/Advanced Software Engineering/Windows/TextEditor.cs @@ -1,24 +1,17 @@ using System; -using System.Collections.Generic; -using System.ComponentModel; -using System.Data; -using System.Diagnostics.Eventing.Reader; -using System.Drawing; using System.IO; -using System.Linq; -using System.Text; -using System.Threading.Tasks; using System.Windows.Forms; namespace Advanced_Software_Engineering { - public partial class Text_Editor : Form { - const string DefaultTitleString = "ASE - Text Editor"; - Draw_Preview DisplayForm = null; - bool unsavedChanges = false; - bool newWindow = true; - bool okToOverwrite = false; - string fileName = ""; + public partial class Text_Editor : Form { + private const string DefaultTitleString = "ASE - Text Editor"; + + private Draw_Preview DisplayForm = null; + private bool unsavedChanges = false; + private bool newWindow = true; + private bool okToOverwrite = false; + private string fileName = ""; /// /// The text editor is the main window that the user will be using for writing code. @@ -46,12 +39,12 @@ namespace Advanced_Software_Engineering { fileStream.Close(); } - void UpdateTitle(string fileName) { + private void UpdateTitle(string fileName) { this.fileName = fileName; UpdateTitle(); } - void UpdateTitle() { + private void UpdateTitle() { if (fileName != "") this.Text = DefaultTitleString + " - " + fileName; else this.Text = DefaultTitleString; if (unsavedChanges) this.Text = "* " + this.Text + " *"; @@ -126,11 +119,9 @@ namespace Advanced_Software_Engineering { } private void openFile() { - OpenFileDialog openFileDialog = new OpenFileDialog(); if (openFileDialog.ShowDialog() == DialogResult.OK) { - if (newWindow) { StreamReader fileStream = new StreamReader(openFileDialog.OpenFile()); textBox1.Text = fileStream.ReadToEnd(); @@ -141,7 +132,6 @@ namespace Advanced_Software_Engineering { fileStream.Close(); } else new Text_Editor(openFileDialog).Show(); } - } private void RunCode() { @@ -202,7 +192,6 @@ namespace Advanced_Software_Engineering { private void runToolStripMenuItem_Click(object sender, EventArgs e) => RunCode(); - private void createNewInstance() => new Text_Editor().Show(); private void handleKeypress(object sender, EventArgs e) => handleKeypress(); @@ -210,12 +199,15 @@ namespace Advanced_Software_Engineering { private void textBox1_Click(object sender, EventArgs e) => updateRowCol(); private void saveAsToolStripMenuItem_Click(object sender, EventArgs e) => saveFileAs(); + private void saveToolStripMenuItem_Click(object sender, EventArgs e) => saveFile(); private void newFileToolStripMenuItem_Click(object sender, EventArgs e) => createNewInstance(); + private void aboutToolStripMenuItem_Click(object sender, EventArgs e) => new About_Window().Show(); private void Text_Editor_FormClosing(object sender, FormClosingEventArgs e) => handleExit(e); + private void exitToolStripMenuItem_Click(object sender, EventArgs e) => Close(); private void openToolStripMenuItem_Click(object sender, EventArgs e) => openFile(); @@ -260,8 +252,5 @@ namespace Advanced_Software_Engineering { private void textBox1_KeyUp(object sender, KeyEventArgs e) => updateRowCol(); private void helpToolStripMenuItem1_Click(object sender, EventArgs e) => new CommandHelp().Show(); - - - } -} +} \ No newline at end of file