developer/VSSDK/VisualStudioIntegration/Tools/Wizards/Templates/CS/VsMacroRecorder.cs

   1 using System;
   2 using System.Runtime.CompilerServices;
   3 using System.Runtime.InteropServices;
   4 using Microsoft.VisualStudio;
   5 using Microsoft.VisualStudio.Shell.Interop;
   6
   7 namespace %ProjectNamespace%.%ProjectClass%
   8 {
   9     // Last command type sent to the macro recorder. Note that there are more commands
  10     // recorded than is implied by this list. Commands in this list (other than
  11     // LastMacroNone) are coalesced when multiples of the same command are received
  12     // consecutively.
  13
  14     // This enum should be extended or replaced with your own command identifiers to enable
  15     // Coalescing of commands.
  16     public enum LastMacro
  17     {
  18         None,
  19         Text,
  20         DownArrowLine,
  21         DownArrowLineSelection,
  22         DownArrowPara,
  23         DownArrowParaSelection,
  24         UpArrowLine,
  25         UpArrowLineSelection,
  26         UpArrowPara,
  27         UpArrowParaSelection,
  28         LeftArrowChar,
  29         LeftArrowCharSelection,
  30         LeftArrowWord,
  31         LeftArrowWordSelection,
  32         RightArrowChar,
  33         RightArrowCharSelection,
  34         RightArrowWord,
  35         RightArrowWordSelection,
  36         DeleteChar,
  37         DeleteWord,
  38         BackspaceChar,
  39         BackspaceWord
  40     }
  41
  42     [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1027:MarkEnumsWithFlags")]
  43     [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1008:EnumsShouldHaveZeroValue")]
  44     public enum MoveScope
  45         {
  46         Character = tom.tomConstants.tomCharacter,
  47         Word = tom.tomConstants.tomWord,
  48         Line = tom.tomConstants.tomLine,
  49         Paragraph = tom.tomConstants.tomParagraph
  50         }
  51
  52         /// <summary>
  53     /// The VSMacroRecorder class implementation and the IVsMacroRecorder Interface definition
  54     /// were included here in this seperate class because they were not included in the
  55     /// interop assemblies shipped with Visual Studio 2005.
  56     ///
  57     /// When implementing a macro recorder this class should be copied into your own name space
  58     /// and not shared between different 3rd party packages.
  59         /// </summary>
  60     public class VSMacroRecorder
  61     {
  62         private IVsMacroRecorder m_VsMacroRecorder;
  63             private LastMacro m_LastMacroRecorded;
  64         private uint m_TimesPreviouslyRecorded;
  65         Guid m_GuidEmitter;
  66
  67         public VSMacroRecorder(Guid emitter)
  68             {
  69                     this.m_LastMacroRecorded = LastMacro.None;
  70
  71             this.m_GuidEmitter = emitter;
  72             }
  73
  74             // Compiler generated destructor is fine
  75
  76         public void Reset()
  77         {
  78             m_LastMacroRecorded = LastMacro.None;
  79             m_TimesPreviouslyRecorded = 0;
  80         }
  81
  82             public void Stop()
  83             {
  84                     Reset();
  85             m_VsMacroRecorder = null;
  86         }
  87
  88             public bool IsLastRecordedMacro(LastMacro macro)
  89             {
  90                     return (macro == m_LastMacroRecorded && ObjectIsLastMacroEmitter()) ? true : false;
  91             }
  92
  93             public bool IsRecording()
  94             {
  95                     // If the property can not be retreived it is assumeed no macro is being recorded.
  96                     VSRECORDSTATE recordState = VSRECORDSTATE.VSRECORDSTATE_OFF;
  97
  98             // Retrieve the macro recording state.
  99             IVsShell vsShell = (IVsShell)Microsoft.VisualStudio.Shell.Package.GetGlobalService(typeof(SVsShell));
 100             if (vsShell != null)
 101             {
 102                 object var;
 103                 if (ErrorHandler.Succeeded(vsShell.GetProperty((int)__VSSPROPID.VSSPROPID_RecordState, out var)) && null != var)
 104                 {
 105                     recordState = (VSRECORDSTATE)var;
 106                 }
 107             }
 108
 109             // If there is a change in the record state to OFF or ON we must either obtain
 110             // or release the macro recorder.
 111             if (recordState == VSRECORDSTATE.VSRECORDSTATE_ON && m_VsMacroRecorder == null)
 112             {
 113                 // If this QueryService fails we no macro recording
 114                 m_VsMacroRecorder = (IVsMacroRecorder)Microsoft.VisualStudio.Shell.Package.GetGlobalService(typeof(IVsMacroRecorder));
 115             }
 116             else if (recordState == VSRECORDSTATE.VSRECORDSTATE_OFF && m_VsMacroRecorder != null)
 117             {
 118                 // If the macro recording state has been switched off then we can release
 119                 // the service. Note that if the state has become paused we take no action.
 120                 Stop();
 121             }
 122
 123             return (m_VsMacroRecorder != null);
 124             }
 125
 126             public void RecordLine(string line)
 127             {
 128                     m_VsMacroRecorder.RecordLine(line, ref m_GuidEmitter);
 129                     Reset();
 130             }
 131
 132         public bool RecordBatchedLine(LastMacro macroRecorded, string line)
 133         {
 134             if (null == line)
 135                 line = "";
 136
 137             return RecordBatchedLine(macroRecorded, line, 0);
 138         }
 139
 140             public bool RecordBatchedLine(LastMacro macroRecorded, string line, int maxLineLength)
 141             {
 142             if (null == line)
 143                 line = "";
 144
 145             if (maxLineLength > 0 && line.Length >= maxLineLength)
 146                     {
 147                             // Reset the state after recording the line, so it will not be appended to further
 148                             RecordLine(line);
 149                             // Notify the caller that the this line will not be appended to further
 150                             return true;
 151                     }
 152
 153                     if(IsLastRecordedMacro(macroRecorded))
 154                     {
 155                             m_VsMacroRecorder.ReplaceLine(line, ref m_GuidEmitter);
 156                             // m_LastMacroRecorded can stay the same
 157                             ++m_TimesPreviouslyRecorded;
 158                     }
 159                     else
 160                     {
 161                             m_VsMacroRecorder.RecordLine(line, ref m_GuidEmitter);
 162                             m_LastMacroRecorded = macroRecorded;
 163                             m_TimesPreviouslyRecorded = 1;
 164                     }
 165
 166                     return false;
 167             }
 168
 169             public uint GetTimesPreviouslyRecorded(LastMacro macro)
 170             {
 171                     return IsLastRecordedMacro(macro) ? m_TimesPreviouslyRecorded : 0;
 172             }
 173
 174         // This function determines if the last line sent to the macro recorder was
 175         // sent from this emitter. Note it is not valid to call this function if
 176         // macro recording is switched off.
 177         private bool ObjectIsLastMacroEmitter()
 178         {
 179             Guid guid;
 180             m_VsMacroRecorder.GetLastEmitterId(out guid);
 181                     return guid.Equals(m_GuidEmitter);
 182         }
 183     }
 184
 185 #region "IVsMacro Interfaces"
 186     [StructLayout(LayoutKind.Sequential, Pack = 4), ComConversionLoss]
 187     internal struct _VSPROPSHEETPAGE
 188     {
 189         public uint dwSize;
 190         public uint dwFlags;
 191         [ComAliasName("vbapkg.ULONG_PTR")]
 192         public uint hInstance;
 193         public ushort wTemplateId;
 194         public uint dwTemplateSize;
 195         [ComConversionLoss]
 196         public IntPtr pTemplate;
 197         [ComAliasName("vbapkg.ULONG_PTR")]
 198         public uint pfnDlgProc;
 199         [ComAliasName("vbapkg.LONG_PTR")]
 200         public int lParam;
 201         [ComAliasName("vbapkg.ULONG_PTR")]
 202         public uint pfnCallback;
 203         [ComConversionLoss]
 204         public IntPtr pcRefParent;
 205         public uint dwReserved;
 206         [ComConversionLoss, ComAliasName("vbapkg.wireHWND")]
 207         public IntPtr hwndDlg;
 208     }
 209
 210     internal enum _VSRECORDMODE
 211     {
 212         // Fields
 213         VSRECORDMODE_ABSOLUTE = 1,
 214         VSRECORDMODE_RELATIVE = 2
 215     }
 216
 217     [ComImport, ComConversionLoss, InterfaceType(1), Guid("55ED27C1-4CE7-11D2-890F-0060083196C6")]
 218     internal interface IVsMacros
 219     {
 220         [MethodImpl(MethodImplOptions.InternalCall, MethodCodeType = MethodCodeType.Runtime)]
 221         void GetMacroCommands([Out] IntPtr ppsaMacroCanonicalNames);
 222     }
 223
 224     [ComImport, InterfaceType(1), Guid("04BBF6A5-4697-11D2-890E-0060083196C6")]
 225     internal interface IVsMacroRecorder
 226     {
 227         [MethodImpl(MethodImplOptions.InternalCall, MethodCodeType = MethodCodeType.Runtime)]
 228         void RecordStart([In, MarshalAs(UnmanagedType.LPWStr)] string pszReserved);
 229         [MethodImpl(MethodImplOptions.InternalCall, MethodCodeType = MethodCodeType.Runtime)]
 230         void RecordEnd();
 231         [MethodImpl(MethodImplOptions.InternalCall, MethodCodeType = MethodCodeType.Runtime)]
 232         void RecordLine([In, MarshalAs(UnmanagedType.LPWStr)] string pszLine, [In] ref Guid rguidEmitter);
 233         [MethodImpl(MethodImplOptions.InternalCall, MethodCodeType = MethodCodeType.Runtime)]
 234         void GetLastEmitterId([Out] out Guid pguidEmitter);
 235         [MethodImpl(MethodImplOptions.InternalCall, MethodCodeType = MethodCodeType.Runtime)]
 236         void ReplaceLine([In, MarshalAs(UnmanagedType.LPWStr)] string pszLine, [In] ref Guid rguidEmitter);
 237         [MethodImpl(MethodImplOptions.InternalCall, MethodCodeType = MethodCodeType.Runtime)]
 238         void RecordCancel();
 239         [MethodImpl(MethodImplOptions.InternalCall, MethodCodeType = MethodCodeType.Runtime)]
 240         void RecordPause();
 241         [MethodImpl(MethodImplOptions.InternalCall, MethodCodeType = MethodCodeType.Runtime)]
 242         void RecordResume();
 243         [MethodImpl(MethodImplOptions.InternalCall, MethodCodeType = MethodCodeType.Runtime)]
 244         void SetCodeEmittedFlag([In] int fFlag);
 245         [MethodImpl(MethodImplOptions.InternalCall, MethodCodeType = MethodCodeType.Runtime)]
 246         void GetCodeEmittedFlag([Out] out int pfFlag);
 247         [MethodImpl(MethodImplOptions.InternalCall, MethodCodeType = MethodCodeType.Runtime)]
 248         void GetKeyWord([In] uint uiKeyWordId, [Out, MarshalAs(UnmanagedType.BStr)] out string pbstrKeyWord);
 249         [MethodImpl(MethodImplOptions.InternalCall, MethodCodeType = MethodCodeType.Runtime)]
 250         void IsValidIdentifier([In, MarshalAs(UnmanagedType.LPWStr)] string pszIdentifier);
 251         [MethodImpl(MethodImplOptions.InternalCall, MethodCodeType = MethodCodeType.Runtime)]
 252         void GetRecordMode([Out] out _VSRECORDMODE peRecordMode);
 253         [MethodImpl(MethodImplOptions.InternalCall, MethodCodeType = MethodCodeType.Runtime)]
 254         void SetRecordMode([In] _VSRECORDMODE eRecordMode);
 255         [MethodImpl(MethodImplOptions.InternalCall, MethodCodeType = MethodCodeType.Runtime)]
 256         void GetStringLiteralExpression([In, MarshalAs(UnmanagedType.LPWStr)] string pszStringValue, [Out, MarshalAs(UnmanagedType.BStr)] out string pbstrLiteralExpression);
 257         [MethodImpl(MethodImplOptions.InternalCall, MethodCodeType = MethodCodeType.Runtime)]
 258         void ExecuteLine([In, MarshalAs(UnmanagedType.LPWStr)] string pszLine);
 259         [MethodImpl(MethodImplOptions.InternalCall, MethodCodeType = MethodCodeType.Runtime)]
 260         void AddTypeLibRef([In] ref Guid guidTypeLib, [In] uint uVerMaj, [In] uint uVerMin);
 261     }
 262 #endregion
 263 }