diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..663f9df --- /dev/null +++ b/.gitignore @@ -0,0 +1,353 @@ +## Ignore Visual Studio temporary files, build results, and +## files generated by popular Visual Studio add-ons. +## +## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore + +# User-specific files +*.rsuser +*.suo +*.user +*.userosscache +*.sln.docstates + +# User-specific files (MonoDevelop/Xamarin Studio) +*.userprefs + +# Mono auto generated files +mono_crash.* + +# Build results +[Dd]ebug/ +[Dd]ebugPublic/ +[Rr]elease/ +[Rr]eleases/ +x64/ +x86/ +[Aa][Rr][Mm]/ +[Aa][Rr][Mm]64/ +bld/ +[Bb]in/ +[Oo]bj/ +[Ll]og/ +[Ll]ogs/ + +# Visual Studio 2015/2017 cache/options directory +.vs/ +# Uncomment if you have tasks that create the project's static files in wwwroot +#wwwroot/ + +# Visual Studio 2017 auto generated files +Generated\ Files/ + +# MSTest test Results +[Tt]est[Rr]esult*/ +[Bb]uild[Ll]og.* + +# NUnit +*.VisualState.xml +TestResult.xml +nunit-*.xml + +# Build Results of an ATL Project +[Dd]ebugPS/ +[Rr]eleasePS/ +dlldata.c + +# Benchmark Results +BenchmarkDotNet.Artifacts/ + +# .NET Core +project.lock.json +project.fragment.lock.json +artifacts/ + +# StyleCop +StyleCopReport.xml + +# Files built by Visual Studio +*_i.c +*_p.c +*_h.h +*.ilk +*.meta +*.obj +*.iobj +*.pch +*.pdb +*.ipdb +*.pgc +*.pgd +*.rsp +*.sbr +*.tlb +*.tli +*.tlh +*.tmp +*.tmp_proj +*_wpftmp.csproj +*.log +*.vspscc +*.vssscc +.builds +*.pidb +*.svclog +*.scc + +# Chutzpah Test files +_Chutzpah* + +# Visual C++ cache files +ipch/ +*.aps +*.ncb +*.opendb +*.opensdf +*.sdf +*.cachefile +*.VC.db +*.VC.VC.opendb + +# Visual Studio profiler +*.psess +*.vsp +*.vspx +*.sap + +# Visual Studio Trace Files +*.e2e + +# TFS 2012 Local Workspace +$tf/ + +# Guidance Automation Toolkit +*.gpState + +# ReSharper is a .NET coding add-in +_ReSharper*/ +*.[Rr]e[Ss]harper +*.DotSettings.user + +# JustCode is a .NET coding add-in +.JustCode + +# TeamCity is a build add-in +_TeamCity* + +# DotCover is a Code Coverage Tool +*.dotCover + +# AxoCover is a Code Coverage Tool +.axoCover/* +!.axoCover/settings.json + +# Visual Studio code coverage results +*.coverage +*.coveragexml + +# NCrunch +_NCrunch_* +.*crunch*.local.xml +nCrunchTemp_* + +# MightyMoose +*.mm.* +AutoTest.Net/ + +# Web workbench (sass) +.sass-cache/ + +# Installshield output folder +[Ee]xpress/ + +# DocProject is a documentation generator add-in +DocProject/buildhelp/ +DocProject/Help/*.HxT +DocProject/Help/*.HxC +DocProject/Help/*.hhc +DocProject/Help/*.hhk +DocProject/Help/*.hhp +DocProject/Help/Html2 +DocProject/Help/html + +# Click-Once directory +publish/ + +# Publish Web Output +*.[Pp]ublish.xml +*.azurePubxml +# Note: Comment the next line if you want to checkin your web deploy settings, +# but database connection strings (with potential passwords) will be unencrypted +*.pubxml +*.publishproj + +# Microsoft Azure Web App publish settings. Comment the next line if you want to +# checkin your Azure Web App publish settings, but sensitive information contained +# in these scripts will be unencrypted +PublishScripts/ + +# NuGet Packages +*.nupkg +# NuGet Symbol Packages +*.snupkg +# The packages folder can be ignored because of Package Restore +**/[Pp]ackages/* +# except build/, which is used as an MSBuild target. +!**/[Pp]ackages/build/ +# Uncomment if necessary however generally it will be regenerated when needed +#!**/[Pp]ackages/repositories.config +# NuGet v3's project.json files produces more ignorable files +*.nuget.props +*.nuget.targets + +# Microsoft Azure Build Output +csx/ +*.build.csdef + +# Microsoft Azure Emulator +ecf/ +rcf/ + +# Windows Store app package directories and files +AppPackages/ +BundleArtifacts/ +Package.StoreAssociation.xml +_pkginfo.txt +*.appx +*.appxbundle +*.appxupload + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!?*.[Cc]ache/ + +# Others +ClientBin/ +~$* +*~ +*.dbmdl +*.dbproj.schemaview +*.jfm +*.pfx +*.publishsettings +orleans.codegen.cs + +# Including strong name files can present a security risk +# (https://github.com/github/gitignore/pull/2483#issue-259490424) +#*.snk + +# Since there are multiple workflows, uncomment next line to ignore bower_components +# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) +#bower_components/ + +# RIA/Silverlight projects +Generated_Code/ + +# Backup & report files from converting an old project file +# to a newer Visual Studio version. Backup files are not needed, +# because we have git ;-) +_UpgradeReport_Files/ +Backup*/ +UpgradeLog*.XML +UpgradeLog*.htm +ServiceFabricBackup/ +*.rptproj.bak + +# SQL Server files +*.mdf +*.ldf +*.ndf + +# Business Intelligence projects +*.rdl.data +*.bim.layout +*.bim_*.settings +*.rptproj.rsuser +*- [Bb]ackup.rdl +*- [Bb]ackup ([0-9]).rdl +*- [Bb]ackup ([0-9][0-9]).rdl + +# Microsoft Fakes +FakesAssemblies/ + +# GhostDoc plugin setting file +*.GhostDoc.xml + +# Node.js Tools for Visual Studio +.ntvs_analysis.dat +node_modules/ + +# Visual Studio 6 build log +*.plg + +# Visual Studio 6 workspace options file +*.opt + +# Visual Studio 6 auto-generated workspace file (contains which files were open etc.) +*.vbw + +# Visual Studio LightSwitch build output +**/*.HTMLClient/GeneratedArtifacts +**/*.DesktopClient/GeneratedArtifacts +**/*.DesktopClient/ModelManifest.xml +**/*.Server/GeneratedArtifacts +**/*.Server/ModelManifest.xml +_Pvt_Extensions + +# Paket dependency manager +.paket/paket.exe +paket-files/ + +# FAKE - F# Make +.fake/ + +# CodeRush personal settings +.cr/personal + +# Python Tools for Visual Studio (PTVS) +__pycache__/ +*.pyc + +# Cake - Uncomment if you are using it +# tools/** +# !tools/packages.config + +# Tabs Studio +*.tss + +# Telerik's JustMock configuration file +*.jmconfig + +# BizTalk build output +*.btp.cs +*.btm.cs +*.odx.cs +*.xsd.cs + +# OpenCover UI analysis results +OpenCover/ + +# Azure Stream Analytics local run output +ASALocalRun/ + +# MSBuild Binary and Structured Log +*.binlog + +# NVidia Nsight GPU debugger configuration file +*.nvuser + +# MFractors (Xamarin productivity tool) working folder +.mfractor/ + +# Local History for Visual Studio +.localhistory/ + +# BeatPulse healthcheck temp database +healthchecksdb + +# Backup folder for Package Reference Convert tool in Visual Studio 2017 +MigrationBackup/ + +# Ionide (cross platform F# VS Code tools) working folder +.ionide/ \ No newline at end of file diff --git a/OnScreenKeyboard.sln b/OnScreenKeyboard.sln new file mode 100644 index 0000000..1071724 --- /dev/null +++ b/OnScreenKeyboard.sln @@ -0,0 +1,31 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio Version 16 +VisualStudioVersion = 16.0.29411.108 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "OnScreenKeyboard", "OnScreenKeyboard\OnScreenKeyboard.csproj", "{D576B8BA-FEDC-4277-A98E-9C781769B83B}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "OnScreenKeyboardTests", "OnScreenKeyboardTests\OnScreenKeyboardTests.csproj", "{B10834E3-188C-49F1-A283-260FEA990763}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {D576B8BA-FEDC-4277-A98E-9C781769B83B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {D576B8BA-FEDC-4277-A98E-9C781769B83B}.Debug|Any CPU.Build.0 = Debug|Any CPU + {D576B8BA-FEDC-4277-A98E-9C781769B83B}.Release|Any CPU.ActiveCfg = Release|Any CPU + {D576B8BA-FEDC-4277-A98E-9C781769B83B}.Release|Any CPU.Build.0 = Release|Any CPU + {B10834E3-188C-49F1-A283-260FEA990763}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {B10834E3-188C-49F1-A283-260FEA990763}.Debug|Any CPU.Build.0 = Debug|Any CPU + {B10834E3-188C-49F1-A283-260FEA990763}.Release|Any CPU.ActiveCfg = Release|Any CPU + {B10834E3-188C-49F1-A283-260FEA990763}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(ExtensibilityGlobals) = postSolution + SolutionGuid = {A743281D-D4B9-4C89-B963-2CA7076F89AA} + EndGlobalSection +EndGlobal diff --git a/OnScreenKeyboard/CursorTracker.cs b/OnScreenKeyboard/CursorTracker.cs new file mode 100644 index 0000000..82a43bd --- /dev/null +++ b/OnScreenKeyboard/CursorTracker.cs @@ -0,0 +1,121 @@ +using System; +using System.Collections.Generic; +using System.Globalization; +using System.Linq; + +namespace OnScreenKeyboard +{ + /* + CursorTracker class + Contains all methods for tracking cursor path and generating the cursor path script + in a specified format. + */ + /// + /// CursorTracker class. + /// Contains all methods for tracking cursor path and generating the cursor path script + /// in a specified format. + /// + public static class CursorTracker + { + // default starting position of cursor on a keyboard ('A') + static (int Row, int Col) cursorDefaultPosition = (0, 0); + + // allowed moves for cursor and their reserved script symbols + const char moveUp = 'U'; + const char moveDown = 'D'; + const char moveLeft = 'L'; + const char moveRight = 'R'; + + // reserved script symbols + const char space = 'S'; + const char select = '#'; + const char separator = ','; + + /// + /// Finds the cursor path on the keyboard for the search term string + /// and generates cursor path script string in a specified format. + /// + /// + /// Cursor path script string. + /// + /// Search term string. + public static string GetCursorPathScript(string inputString) + { + inputString = inputString.ToUpper(CultureInfo.CurrentCulture); + + var cursorCurrentPosition = cursorDefaultPosition; + var cursorPath = new List(); + + foreach (var character in inputString) + { + var cursorTargetPosition = Keyboard.GetKeyLocation(character); + + if (cursorTargetPosition == (-1, -1)) + { + cursorPath.Add(space); + } + else + { + var pathBetweenKeys = GetPathBetweenKeys(cursorCurrentPosition, cursorTargetPosition); + cursorPath.AddRange(pathBetweenKeys); + + cursorCurrentPosition = cursorTargetPosition; + } + + } + + var cursorPathScript = string.Join(separator, cursorPath); + + return cursorPathScript; + } + + /// + /// Finds the cursor path between two keys. + /// + /// + /// A list that contains elements which correspond to the sequence of cursor moves from one key to another. + /// + /// Postion of key at which the cursor is currently located. + /// Postion of key to which the cursor needs to move. + private static List GetPathBetweenKeys((int Row, int Col) currentKeyLocation, (int Row, int Col) targetKeyLocation) + { + var path = new List(); + + var rowOffset = targetKeyLocation.Row - currentKeyLocation.Row; + var colOffset = targetKeyLocation.Col - currentKeyLocation.Col; + + if (rowOffset != 0) + { + var moveDirection = GetMoveDirection(rowOffset, false); + path.AddRange(Enumerable.Repeat(moveDirection, Math.Abs(rowOffset)).ToArray()); + } + + if (colOffset != 0) + { + var moveDirection = GetMoveDirection(colOffset, true); + path.AddRange(Enumerable.Repeat(moveDirection, Math.Abs(colOffset)).ToArray()); + } + + path.Add(select); + + return path; + } + + /// + /// Finds cursor move direction either in row or in column. + /// + /// + /// Move direction either in row or in column. + /// + /// Row or column offset. + /// Defines if cursor moves in row or in column. + private static char GetMoveDirection(int offset, bool isMoveInRow) + { + var moveDirection = offset < 0 ? + (isMoveInRow ? moveLeft : moveUp) : + (isMoveInRow ? moveRight : moveDown); + + return moveDirection; + } + } +} diff --git a/OnScreenKeyboard/Keyboard.cs b/OnScreenKeyboard/Keyboard.cs new file mode 100644 index 0000000..44867d6 --- /dev/null +++ b/OnScreenKeyboard/Keyboard.cs @@ -0,0 +1,56 @@ +using System; + +namespace OnScreenKeyboard +{ + /* + Keyboard class + Contains keyboard layout and method to locate keys. + */ + /// + /// Keyboard class. + /// Contains keyboard layout and method to locate keys. + /// + + public static class Keyboard + { + // keyboard dimensions + const int nRows = 6; + const int nCols = 6; + + // keyboard layout + static char[][] layout = new char[nRows][] + { + new char[nCols] {'A', 'B', 'C', 'D', 'E', 'F' }, + new char[nCols] {'G', 'H', 'I', 'J', 'K', 'L' }, + new char[nCols] {'M', 'N', 'O', 'P', 'Q', 'R' }, + new char[nCols] {'S', 'T', 'U', 'V', 'W', 'X' }, + new char[nCols] {'Y', 'Z', '1', '2', '3', '4' }, + new char[nCols] {'5', '6', '7', '8', '9', '0' } + }; + + /// + /// Gets the key location from its character. + /// + /// + /// A pair of numbers which correspond to the row and column of the key position. + /// + /// Key's character. + public static (int Row, int Col) GetKeyLocation(char character) + { + int Row = -1; + int Col = -1; + + for (int i = 0; i < nRows; i++) + { + if (Array.Exists(layout[i], key => key.Equals(character))) + { + Row = i; + Col = Array.FindIndex(layout[i], key => key.Equals(character)); + break; + } + } + + return (Row, Col); + } + } +} diff --git a/OnScreenKeyboard/OnScreenKeyboard.csproj b/OnScreenKeyboard/OnScreenKeyboard.csproj new file mode 100644 index 0000000..09afcf2 --- /dev/null +++ b/OnScreenKeyboard/OnScreenKeyboard.csproj @@ -0,0 +1,12 @@ + + + + Exe + netcoreapp2.2 + + + + C:\Users\OWNER\source\repos\OnScreenKeyboard\OnScreenKeyboard\OnScreenKeyboard.xml + + + diff --git a/OnScreenKeyboard/OnScreenKeyboard.xml b/OnScreenKeyboard/OnScreenKeyboard.xml new file mode 100644 index 0000000..802a7c2 --- /dev/null +++ b/OnScreenKeyboard/OnScreenKeyboard.xml @@ -0,0 +1,60 @@ + + + + OnScreenKeyboard + + + + + CursorTracker class. + Contains all methods for tracking cursor path and generating the cursor path script + in a specified format. + + + + + Finds the cursor path on the keyboard for the search term string + and generates cursor path script string in a specified format. + + + Cursor path script string. + + Search term string. + + + + Finds the cursor path between two keys. + + + A list that contains elements which correspond to the sequence of cursor moves from one key to another. + + Postion of key at which the cursor is currently located. + Postion of key to which the cursor needs to move. + + + + Finds cursor move direction either in row or in column. + + + Move direction either in row or in column. + + Row or column offset. + Defines if cursor moves in row or in column. + + + + Keyboard class. + Contains keyboard layout and method to locate keys. + + + + + Gets the key location from its character. + + + A pair of numbers which correspond to the row and column of the key position. + + Key's character. + + + diff --git a/OnScreenKeyboard/Program.cs b/OnScreenKeyboard/Program.cs new file mode 100644 index 0000000..2228a50 --- /dev/null +++ b/OnScreenKeyboard/Program.cs @@ -0,0 +1,39 @@ +using System; +using System.IO; + +namespace OnScreenKeyboard +{ + class Program + { + static void Main(string[] args) + { + var inputFilePath = @"input.txt"; + var outputFilePath = @"output.txt"; + + if (!File.Exists(inputFilePath)) + { + string[] createText = + { + "An Orange", + "<--Scube-->", + "Work Hard", + "app v.1.0.0", + "()()AA$$@@" + }; + + File.WriteAllLines(inputFilePath, createText); + } + + var pathScript = ""; + + string[] inputText = File.ReadAllLines(inputFilePath); + + foreach (var inputString in inputText) + { + pathScript = pathScript + (CursorTracker.GetCursorPathScript(inputString) + Environment.NewLine); + } + + File.WriteAllText(outputFilePath, pathScript); + } + } +} diff --git a/OnScreenKeyboardTests/KeyboardCursorTrackerTests.cs b/OnScreenKeyboardTests/KeyboardCursorTrackerTests.cs new file mode 100644 index 0000000..1693e33 --- /dev/null +++ b/OnScreenKeyboardTests/KeyboardCursorTrackerTests.cs @@ -0,0 +1,71 @@ +using Microsoft.VisualStudio.TestTools.UnitTesting; +using OnScreenKeyboard; + +namespace OnScreenKeyboardTests +{ + [TestClass] + public class KeyboardCursorTrackerTests + { + [TestMethod] + public void GetKeyLocation_Returns_0_0_For_A() + { + var character = 'A'; + var expectedPosition = (0, 0); + + var actualPosition = Keyboard.GetKeyLocation(character); + + Assert.AreEqual(actualPosition, expectedPosition); + } + + [TestMethod] + public void GetKeyLocation_Returns_3_4_For_W() + { + var character = 'W'; + var expectedPosition = (3, 4); + + var actualPosition = Keyboard.GetKeyLocation(character); + + Assert.AreEqual(actualPosition, expectedPosition); + } + + [TestMethod] + public void GetKeyLocation_Returns_Minus_1_Minus_1_For_SpaceSymbol() + { + var character = ' '; + var expectedPosition = (-1, -1); + + var actualPosition = Keyboard.GetKeyLocation(character); + + Assert.AreEqual(actualPosition, expectedPosition); + } + + [TestMethod] + public void GetKeyLocation_Returns_Minus_1_Minus_1_For_NonKeyboardSymbol() + { + var character = '<'; + var expectedPosition = (-1, -1); + + var actualPosition = Keyboard.GetKeyLocation(character); + + Assert.AreEqual(actualPosition, expectedPosition); + } + + [DataTestMethod] + [DataRow("", "")] + [DataRow("A", "#")] + [DataRow("Aa", "#,#")] + [DataRow("Aa Bb", "#,#,S,R,#,#")] + [DataRow("D", "R,R,R,#")] + [DataRow("S", "D,D,D,#")] + [DataRow("P", "D,D,R,R,R,#")] + [DataRow("an apple", "#,D,D,R,#,S,U,U,L,#,D,D,R,R,R,#,#,U,R,R,#,U,L,#")] + [DataRow("?miss, 1", "S,D,D,#,U,R,R,#,D,D,L,L,#,#,S,S,D,R,R,#")] + [DataRow("Mr. Smith", "D,D,#,R,R,R,R,R,#,S,S,D,L,L,L,L,L,#,U,#,U,R,R,#,D,D,L,#,U,U,#")] + public void GetCursorPathScriptTest(string inputString, string expectedPathScript) + { + var actualPathScript = CursorTracker.GetCursorPathScript(inputString); + + Assert.AreEqual(actualPathScript, expectedPathScript); + } + } +} diff --git a/OnScreenKeyboardTests/OnScreenKeyboardTests.csproj b/OnScreenKeyboardTests/OnScreenKeyboardTests.csproj new file mode 100644 index 0000000..08f9884 --- /dev/null +++ b/OnScreenKeyboardTests/OnScreenKeyboardTests.csproj @@ -0,0 +1,20 @@ + + + + netcoreapp2.2 + + false + + + + + + + + + + + + + +