Renamed SettingsAndHelperFunctions to HelperFunctions

Advanced Software Engineering/Advanced Software Engineering/HelperFunctions.cs

@@ -0,0 +1,137 @@
+using System.Collections.Generic;
+using System.Windows.Forms;
+
+namespace Advanced_Software_Engineering {
+
+    public class CommandAndParameterParserResult {
+        private string command;
+        private string[] parameters;
+
+        public CommandAndParameterParserResult(string command, string[] parameters) {
+            this.command = command;
+            this.parameters = parameters;
+        }
+
+        public string getCommand() {
+            return command;
+        }
+
+        public string[] getParameters() {
+            return parameters;
+        }
+    }
+
+    /// <summary>
+    /// This class simply provides settings and some functions that are used across many components.
+    /// </summary>
+    public class HelperFunctions {
+
+        /// <summary>
+        /// This function removes spaces from the start and the end of the text. This should be unit tested.
+        /// </summary>
+        /// <param name="text">Simply any string of any size</param>
+        /// <returns>A string without spaces at the begining or the end</returns>
+        /// <example>
+        /// For example
+        /// <code>
+        /// string a = "     a simple sentence surrounded by spaces                ";
+        /// string b = StripSpaces(a);
+        /// Console.WriteLine(b); // => "a simple sentence surrounded by spaces";
+        /// </code>
+        /// </example>
+        /// <example>
+        /// The code won't remove internal double spaces:
+        /// <code>
+        /// string a = "     a    simple    sentence     surrounded    by    spaces                ";
+        /// string b = StripSpaces(a);
+        /// Console.WriteLine(b); // => "a    simple    sentence     surrounded    by    spaces";
+        /// </code>
+        /// </example>
+        public static string Strip(string text) {
+            //Console.WriteLine("Stripping: '" + text + "'");
+            int start;
+
+            for (start = 0; start < text.Length; start++) {
+                char character = text[start];
+                if (character != " "[0]) break;
+            }
+
+            int end;
+
+            for (end = text.Length - 1; end >= 0; end--) {
+                char character = text[end];
+                if (character != " "[0]) break;
+            }
+
+            if (end == -1) return "";
+
+            string result = text.Substring(start, end - start + 1);
+
+            //Console.WriteLine("Started at: " + start);
+            //Console.WriteLine("Ended at:   " + end);
+            //Console.WriteLine("Result:     " + result);
+
+            return result;
+        }
+
+        /// <summary>
+        /// Strips the strings of the full array. See <see cref="Strip(string)"/>
+        /// </summary>
+        /// <example>
+        /// string[] tmp = {"    text  ", "      ", "   with", "spaces     ", ""};
+        /// Console.WriteLine(StripStringArray(tmp)); // => {"text", "with", "spaces"}
+        /// </example>
+        /// <param name="array">Dirty array with spaces</param>
+        /// <returns>A stripped aray</returns>
+        public static List<string> StripStringArray(string[] array) {
+            List<string> newStringList = new List<string>();
+
+            foreach (string arrayElement in array) {
+                string strippedElement = Strip(arrayElement);
+                if (strippedElement.Length == 0) continue;
+                else newStringList.Add(strippedElement);
+            }
+
+            return newStringList;
+        }
+
+        /// <summary>
+        /// Parses the commands into a directry that Commander can use. See <see cref="Commander"/>
+        /// </summary>
+        /// <param name="text">A string command</param>
+        /// <returns>Directory with the command and its parameters cleanly separated</returns>
+        public static CommandAndParameterParserResult CommandAndParameterParser(string text) {
+            //prepare the parameters by stripping them of spaces
+            string prepParameters = Strip(text);
+            if (prepParameters.Length == 0) return null;
+
+            //split the command from the parameters
+            string[] splitCommand = prepParameters.Split(new char[] { " "[0] }, 2);
+            string command = null;
+            string[] parameters = null;
+
+            //There are parameters, make the command
+            if (splitCommand.Length > 0) {
+                //set command var
+                command = Strip(splitCommand[0]);
+            }
+
+            //There is at least one parameter
+            if (splitCommand.Length > 1) {
+                //seperate all of the parameters by a comma
+                splitCommand = splitCommand[1].Split(","[0]);
+
+                //Remove spaces around parameters
+                splitCommand = StripStringArray(splitCommand).ToArray();
+
+                //We don't want parameters if there aren't any
+                if (!(splitCommand.Length == 1 && splitCommand[0] == "")) {
+                    //set parameter list
+                    parameters = splitCommand;
+                }
+            }
+
+            return new CommandAndParameterParserResult(command, parameters);
+        }
+    }
+}