Merge pull request #5 from Microsoft/dev/venkatesh/VSOperations

VSoperations inheriting from IEnvironmentOperations

Author: venkateshpotluri

src/VisualStudio/CodeTalk/CodeTalk.csproj

@@ -68,6 +68,7 @@
     <WarningLevel>4</WarningLevel>
   </PropertyGroup>
   <ItemGroup>
+    <Compile Include="IEnvironmentOperations.cs" />
     <Compile Include="Properties\Resources.Designer.cs">
       <AutoGen>True</AutoGen>
       <DesignTime>True</DesignTime>

src/VisualStudio/CodeTalk/Commands/Commands.cs

@@ -119,7 +119,7 @@ public override void Execute()
             {
                 int currentLineNumber = 0;
 
-                currentLineNumber = TalkCodePackage.vsOperations.GetCursorLineNumber();
+                currentLineNumber = TalkCodePackage.vsOperations.GetCurrentCursorPosition().lineNumber;
                 contextHierarchy = codeFile.GetContextAtLine(currentLineNumber) as IList<ISyntaxEntity>;
 
                 if (0 == contextHierarchy.Count)
@@ -276,7 +276,7 @@ public override void Execute()
         {
             rm = new ResourceManager(typeof(Resources));
 
-            if (TalkCodePackage.vsOperations.RemoveBreakpointIfExists()) { return; }
+            if (TalkCodePackage.vsOperations.RemoveBreakpointInCurrentPosition()) { return; }
 
             ToolWindowPane talkpointWindow = TalkCodePackage.currentPackage.FindToolWindow(typeof(TalkpointToolWindow), 0, true);
 

src/VisualStudio/CodeTalk/Commands/MoveToContextCommand.cs

@@ -57,7 +57,7 @@ public override void Execute()
                 int currentLineNumber = 0;
                 int destinationLineNumber = 0;
 
-                currentLineNumber = TalkCodePackage.vsOperations.GetCursorLineNumber();
+                currentLineNumber = TalkCodePackage.vsOperations.GetCurrentCursorPosition().lineNumber;
                 contextHierarchy = codeFile.GetContextAtLine(currentLineNumber) as IList<ISyntaxEntity>;
 
                 if (0 == contextHierarchy.Count)

src/VisualStudio/CodeTalk/Commands/SkipCommentCommand.cs

@@ -54,7 +54,7 @@ public override void Execute()
 				MessageBox.Show(rm.GetString("CompilationErrorString", CultureInfo.CurrentCulture), rm.GetString("CodeTalkText", CultureInfo.CurrentCulture), MessageBoxButtons.OK, MessageBoxIcon.Error);
 				return;
             }
-            lineNumber = TalkCodePackage.vsOperations.GetCursorLineNumber();
+            lineNumber = TalkCodePackage.vsOperations.GetCurrentCursorPosition().lineNumber;
             commentAtLine = codeFile.GetCommentAtLine(lineNumber);
             if (commentAtLine != null)
             {

src/VisualStudio/CodeTalk/IEnvironmentOperations.cs

@@ -0,0 +1,90 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using static Microsoft.CodeTalk.Constants;
+
+namespace Microsoft.CodeTalk
+{
+    public interface IEnvironmentOperations
+    {
+        /// <summary>
+        /// Method to Evaluate Expression in Debugging context
+        /// </summary>
+        /// <param name="expression"></param>
+        /// <returns></returns>
+        string RunExpressionInDebugger(string expression);
+
+        /// <summary>
+        /// Method to add a tone Talkpoint with existing tones
+        /// </summary>
+        /// <param name="tone"></param>
+        /// <param name="doesContinue"></param>
+        void AddTonalTalkPointToCurrentLine(Tones tone, bool doesContinue);
+
+        /// <summary>
+        /// Method to add tone Talkpoint with Custom tones
+        /// </summary>
+        /// <param name="customTone"></param>
+        /// <param name="doesContinue"></param>
+        void AddTonalTalkPointToCurrentLine(CustomTone customTone, bool doesContinue);
+
+        /// <summary>
+        /// Method to add text Talkpoint
+        /// </summary>
+        /// <param name="statement"></param>
+        /// <param name="doesContinue"></param>
+        void AddTextualTalkpointToCurrentLine(string statement, bool doesContinue);
+
+        /// <summary>
+        /// Method to add expression Talkpoint
+        /// </summary>
+        /// <param name="expression"></param>
+        /// <param name="doesContinue"></param>
+        void AddExpressionTalkpointToCurrentLine(string expression, bool doesContinue);
+
+        /// <summary>
+        /// Method to remove exixting breakpoints in current line
+        /// </summary>
+        /// <returns></returns>
+        bool RemoveBreakpointInCurrentPosition();
+
+        /// <summary>
+        /// Method to get the file path of the active document
+        /// </summary>
+        /// <returns></returns>
+        string GetActiveDocumentPath();
+
+        /// <summary>
+        /// Method to get the code text of the actuve document
+        /// </summary>
+        /// <returns></returns>
+        string GetActiveDocumentCode();
+
+        /// <summary>
+        /// Method to go to the given location in the active document
+        /// </summary>
+        /// <param name="lineNumber"></param>
+        /// <param name="columnNumber"></param>
+        void GoToLocationInActiveDocument(int lineNumber, int columnNumber);
+
+        /// <summary>
+        /// Method to get the current cursor position
+        /// </summary>
+        /// <returns></returns>
+        CursorPos GetCurrentCursorPosition();
+
+        /// <summary>
+        /// Method to check if active document is in focus
+        /// </summary>
+        /// <returns></returns>
+        bool IsActiveDocumentFocussed();
+
+        /// <summary>
+        /// Method to play error tone if there is an error.
+        /// </summary>
+        void PlaySoundIfError();
+
+    }
+}

src/VisualStudio/CodeTalk/TalkCodePackage.cs

@@ -174,12 +174,6 @@ protected override void Initialize()
             currentPackage = this;
             vsOperations = new VSOperations();
 
-            //Setting Handlers
-            vsOperations.SetBreakModeHandler();
-            vsOperations.SetExceptionHandler();
-            //VS Document focussed changed event
-            vsOperations.OnDocumentFocusChanged();
-
             TextToSpeech.IsTextToSpeechEnabled = true;
             AboutCommand.Initialize(this);
             CodeTalkOptionsCommand.Initialize(this);

src/VisualStudio/CodeTalk/VSOperations.cs

@@ -26,7 +26,7 @@
 
 namespace Microsoft.CodeTalk
 {
-    public class VSOperations : IDisposable
+    public class VSOperations : IEnvironmentOperations, IDisposable
     {
         DTE dte;
         IVsTextManager textManager;
@@ -50,7 +50,13 @@ public VSOperations()
             textManager = (IVsTextManager)Package.GetGlobalService(typeof(SVsTextManager));
             debugEvents = dte.Events.DebuggerEvents;
             mTalkPoints = new List<Talkpoint>();
-        }
+
+			//Setting Handlers
+			SetBreakModeHandler();
+			SetExceptionHandler();
+			//VS Document focussed changed event
+			OnDocumentFocusChanged();
+		}
 
         public void SetBreakModeHandler()
         {
@@ -226,7 +232,7 @@ public void AddExpressionTalkpointToCurrentLine(string expression, bool doesCont
             }
         }
 
-        public bool RemoveBreakpointIfExists()
+        public bool RemoveBreakpointInCurrentPosition()
         {
             var cursorPos = GetCurrentCursorPosition();
             var filePath = GetActiveDocumentPath();
@@ -311,19 +317,21 @@ public string GetDocumentCode(Document document)
             return codeText;
         }
 
-        public void GoToLocationInActiveDocument(int lineNumber)
+        public void GoToLocationInActiveDocument(int lineNumber, int columnNumber = 0)
         {
             if (null == dte.ActiveDocument) { return; }
             TextDocument activeDocument = dte.ActiveDocument.Object() as TextDocument;
             dte.ActiveDocument.Activate();
             activeDocument.Selection.GotoLine(lineNumber);
         }
+
         public bool IsActiveDocumentPresent()
         {
             if (null == dte) { return false; }
             if (null == dte.ActiveDocument) { return false; }
             return true;
         }
+
         public int GetCursorLineNumber()
         {
             return GetCurrentCursorPosition().lineNumber;