mattercontrol/BrailleBuilder/BrailleGrade2.cs

/*
Copyright (c) 2014, Lars Brubaker
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

The views and conclusions contained in the software and documentation are those
of the authors and should not be interpreted as representing official policies,
either expressed or implied, of the FreeBSD Project.
*/

using MatterHackers.Agg.UI;
using MatterHackers.MatterControl.CreatorPlugins;
using MatterHackers.MatterControl.PluginSystem;
using MatterHackers.Agg;
#if !__ANDROID__
using NUnit.Framework;
#endif
using System;
using System.Collections.Generic;
using System.Text;
using System.Text.RegularExpressions;

// finish a, b, t

namespace MatterHackers.MatterControl.Plugins.BrailleBuilder
{
	public static class BrailleGrade2
	{
#if !__ANDROID__
		static bool ranTests = false;
		[Test]
		public static void BrailGrade2Tests()
		{
			if (!ranTests)
			{
				Assert.IsTrue(ConvertWord("taylor") == "taylor");
				//Assert.IsTrue(ConvertWord("Taylor") == ",taylor");
				//Assert.IsTrue(ConvertWord("TayLor") == ",tay,lor");
				Assert.IsTrue(ConvertWord("energy") == "5}gy");
				Assert.IsTrue(ConvertWord("men") == "m5");
				Assert.IsTrue(ConvertWord("runabout") == "runab");
				Assert.IsTrue(ConvertWord("afternoon") == "afn");
				Assert.IsTrue(ConvertWord("really") == "re,y");
				Assert.IsTrue(ConvertWord("glance") == "gl.e");
				Assert.IsTrue(ConvertWord("station") == "/,n");
				Assert.IsTrue(ConvertWord("as") == "z");
				Assert.IsTrue(ConvertWord("abby") == "a2y");
				//Matt Implemented
				Assert.IsTrue(ConvertWord("commitment") == "-mit;t");
				Assert.IsTrue(ConvertWord("mother") == "\"m");
				Assert.IsTrue(ConvertWord("myself") == "myf");
				Assert.IsTrue(ConvertWord("lochness") == "lo*;s");
				Assert.IsTrue(ConvertWord("Seven o'clock") == ",sev5 o'c");

				Assert.IsTrue(ConvertWord("test") == "te/");
				Assert.IsTrue(ConvertWord("that") == "t");
				Assert.IsTrue(ConvertWord("will") == "w");
				Assert.IsTrue(ConvertWord("show") == "%{");
				Assert.IsTrue(ConvertWord("our") == "|r");
				Assert.IsTrue(ConvertWord("with") == ")");
				Assert.IsTrue(ConvertWord("braille") == "brl");
				Assert.IsTrue(ConvertWord("conformance") == "3=m.e");

				Assert.IsTrue(ConvertString("here it is") == "\"h x is");
				Assert.IsTrue(ConvertString("test that will show our conformance with braille") == "te/ t w %{ |r 3=m.e ) brl");
				//Assert.IsTrue(ConvertString("so we can create some strings and then this gives us the output that is expected") == "s we c cr1te \"s /r+s & !n ? gives u ! |tput t is expect$");				

				ranTests = true;
			}
		}
#endif

		internal class TextMapping
		{
			internal string Key;
			internal string Value;

			internal TextMapping(string key, string value)
			{
				this.Key = key;
				this.Value = value;
			}

			public override string ToString()
			{
				return "{0} -> {1}".FormatWith(Key, Value);
			}
		}

		static List<TextMapping> exactTextMappings = new List<TextMapping>();
		static List<TextMapping> anyPositionMappings = new List<TextMapping>();
		static List<TextMapping> afterTextMappings = new List<TextMapping>();
		static List<TextMapping> beforeTextMappings = new List<TextMapping>();
		static List<TextMapping> betweenTextMappings = new List<TextMapping>();

		public static string ConvertWord(string text)
		{
			EnsureInitialized();

			// put in commas before capitals
			string converted = Regex.Replace(text, "([A-Z])", ",$1");
			converted = converted.ToLower();

			// do the replacements that must be the complete word by itself
			foreach (TextMapping keyValue in exactTextMappings)
			{
				if (converted == keyValue.Key)
				{
					converted = keyValue.Value;
					return converted;
				}
			}

			// do the replacements that must come after other characters
			string tempAfterFirstCharacter = converted.Substring(1);
			foreach (TextMapping keyValue in afterTextMappings)
			{
				if (tempAfterFirstCharacter.Contains(keyValue.Key))
				{
					converted = converted.Substring(0, 1) + tempAfterFirstCharacter.Replace(keyValue.Key, keyValue.Value);
					tempAfterFirstCharacter = converted.Substring(1);
				}
			}

			// do the replacements that must come after other characters
			string tempBeforeLastCharacter = converted.Substring(0,converted.Length-1);
			foreach (TextMapping keyValue in beforeTextMappings)
			{
				if (tempBeforeLastCharacter.Contains(keyValue.Key))
				{
					converted = tempBeforeLastCharacter.Replace(keyValue.Key, keyValue.Value) + converted[converted.Length-1];
					tempBeforeLastCharacter = converted.Substring(0, converted.Length - 1);
				}
			}

			// do the replacements that can go anywhere
			foreach (TextMapping keyValue in anyPositionMappings)
			{
				if (converted.Contains(keyValue.Key))
				{
					converted = converted.Replace(keyValue.Key, keyValue.Value);
				}
			}

			if (converted.Length > 2)
			{
				// do the replacements that must come after and before other characters
				string tempMiddleCharacters = converted.Substring(1, converted.Length - 2);
				foreach (TextMapping keyValue in betweenTextMappings)
				{
					if (tempMiddleCharacters.Contains(keyValue.Key))
					{
						int findPosition = tempMiddleCharacters.IndexOf(keyValue.Key);
						int afterReplacemntStart = 1 + findPosition + keyValue.Key.Length;
						int afterReplacementLength = converted.Length - afterReplacemntStart;
						converted = converted.Substring(0, 1) + tempMiddleCharacters.Replace(keyValue.Key, keyValue.Value) + converted.Substring(afterReplacemntStart, afterReplacementLength);
						tempMiddleCharacters = converted.Substring(1, converted.Length - 2);
					}
				}
			}

			return converted;
		}

		private static bool isInitialized = false;
		private static void EnsureInitialized()
		{
			if (!isInitialized)
			{
				ConvertMappingStringToList();
				anyPositionMappings.Sort(SortOnKeySize);
				isInitialized = true;
			}
		}

		private static int SortOnKeySize(TextMapping x, TextMapping y)
		{
			return y.Key.Length.CompareTo(x.Key.Length);
		}

		public static string ConvertString(string text)
		{
			string[] words = text.Split(' ');

			StringBuilder finalString = new StringBuilder();
			bool first = true;

			foreach (string word in words)
			{
				if (word != null && word.Length > 0)
				{
					if (!first)
					{
						finalString.Append(" ");
					}
					finalString.Append(ConvertWord(word));

					first = false;
				}
			}

			return finalString.ToString();
		}

		private static void ConvertMappingStringToList()
		{
			string[] conversions = BrailleGrade2Mapping.mappingTable.Split('\n'); 

			foreach(string inLine in conversions)
			{
				string line = inLine.Replace("\r", "");
				if(line != null && line.Length>0)
				{
					string[] keyConversionPair = line.Split(' ');
					if(keyConversionPair.Length == 2 && keyConversionPair[0] != null && keyConversionPair[0].Length > 0 && keyConversionPair[1] != null && keyConversionPair[1].Length >0)
					{
						if(keyConversionPair[0] != "//")
						{
							TextMapping mapping = new TextMapping(keyConversionPair[0].ToLower(), keyConversionPair[1]);
							if (keyConversionPair[0] == keyConversionPair[0].ToUpper())//if in all caps it is an exact match
							{
								exactTextMappings.Add(mapping);
							}
							else if(mapping.Key[0] == '+' && mapping.Key[mapping.Key.Length-1] == '+')//check between
							{
								mapping.Key = mapping.Key.Trim('+');
								betweenTextMappings.Add(mapping);
							}
							else if (mapping.Key[0] == '+') 
							{
								mapping.Key = mapping.Key.Trim('+');
								afterTextMappings.Add(mapping);
							}
							else if(mapping.Key[mapping.Key.Length-1] == '+')
							{
								mapping.Key = mapping.Key.Trim('+');
								beforeTextMappings.Add(mapping);
							}
							else if(mapping.Key.Contains("*"))
							{
								//TODO - implement words before/after key
							}
							else//if not a special type then it is an anyPositionMapping
							{
								anyPositionMappings.Add(mapping);
							}
						}
					}
				}
			}

		}
	}
}