Click here to Skip to main content
Click here to Skip to main content

Automatic highlighting of matching braces for Visual Studio C++

, 5 Nov 2008 GPL3
Rate this:
Please Sign up or sign in to vote.
This add-in enables highlighting of matching braces next to the cursor for Visual Studio C++.

Introduction

The Visual Studio 2008 C++ text editor only highlights matching braces if written the first time. Almost all text editors have the feature of highlighting matching braces if you put the cursor near to an open or close brace (even the Visual Studio C# editor). This add-in will provide this feature for C++ too. (Tested with Visual Studio 2008; for 2005, you need to change the version information in the "MatchingBraces.AddIn" file from 9.0 to 8.0).

Using the Add-in

  1. Just copy the contents of the "readyplugin" folder to "C:\Users\Username\Documents\Visual Studio 2008\Addins". Restart Visual Studio.
  2. Put the cursor on the right side of a brace (one of: '{[()]}'). If the brace has a matching one, both braces will be highlighted with a bold font.

Source Code Overview

  • Get mouse and keyboard events:

    To get the add-in working, we first need to get notified if the user has moved the cursor somewhere inside the text editor using the mouse or the keyboard. The Visual Studio Add-in API does not provide a functionality for mouse events. It is necessary to use a Window Hook using the SetWindowsHookEx() function. The built-in TextDocumentKeyPressEvents does not work with the arrow keys. For these keys, a keyboard hook is needed:

    private void InitHook()
    {
      //init the mouse and keyboard hook 
      //with the thread id of the Visual Studio IDE
      uint id = GetCurrentThreadId();
      this.MouseProcDelegate = new HookProc(this.MouseProc);
      mhhook = SetWindowsHookEx(WH_MOUSE, 
               this.MouseProcDelegate, IntPtr.Zero, id);
      this.KeyboardProcDelegate = 
           new HookProcKeyboard(this.KeyboardProc);
      khook = SetWindowsHookEx(WH_KEYBOARD, 
              this.KeyboardProcDelegate, IntPtr.Zero, id);
    }

    To make use of SetWindowsHookEx(), it is necessary to use the Platform Invoke stuff. If the user released a key or released a mouse button, the MouseProc (or KeyboardProc) 'function' will be called before the event reaches the Visual Studio window.

  • Do something with the event (here keyboard):

    If KeyboardProc is called, we only know that a key is released somewhere. First, we need to make sure that a document is open and that the document is a C++ source code:

    private int KeyboardProc(int code, IntPtr wParam, IntPtr lParam)
    {
      try
      {
        if (code != HC_ACTION)
        {
          return CallNextHookEx(khook, code, wParam, lParam);
        }
    
        //only with a C++ document open
        if (_applicationObject.ActiveDocument == null ||
            _applicationObject.ActiveDocument.Language != "C/C++")
        {
          return CallNextHookEx(mhhook, code, wParam, lParam);
        }

    Next, we need to check if the event occurred inside the editor window and not somewhere else:

       //check if the editor window has the keyboard focus
       IntPtr h = GetFocus();
       if (!isEditorWindow(h))
       {
         return CallNextHookEx(mhhook, code, wParam, lParam);
       } 
    
    [...]
    
     private static bool isEditorWindow(IntPtr hWnd)
     {
       IntPtr res;
       StringBuilder ClassName = new StringBuilder(256);
       res = GetClassName(hWnd, ClassName, ClassName.Capacity);
       if (res != IntPtr.Zero)
       {
         if (ClassName.ToString() == "VsTextEditPane")
         {
           return true;
         }
       }
       return false;
     }

    This is the case if the keyboard focus belongs to a window with the class "VsTextEditPane".

    Next, we are (almost) ready to highlight the matching braces:

    private void Highlight()
    {
      try
      {
        TextSelection ts = 
          (TextSelection)_applicationObject.ActiveDocument.Selection;
          if (!ts.IsEmpty)
          {
            return;
          }
            
        //create an edit point on the current cursor position
        EditPoint ep = ts.ActivePoint.CreateEditPoint();
            
    
        //get the letter on the left side of the cursor
        String s = ep.GetText(-1);
            
        //check if it is one of the braces: '{[( }])'
        String pattern = "({|}|\\[|\\]|\\(|\\))";
        if (System.Text.RegularExpressions.Regex.IsMatch(s, pattern))
        {
          //select the brace and rewrite it, 
          //this will trigger the matching braces 
          //functionality from Visual Studio
          ts.CharLeft(true, 1);
          ts.Text = s;
        }
      }
      catch
      {
      }
    }

    Of course, it is first necessary to check if the cursor (returned by ts.ActivePoint.CreateEditPoint()) is on the right side of a brace, using GetText(-1) and a Regex which will match for all braces. If 'Yes', the brace will be selected using ts.CharLeft(true, 1) and replaced with a new one. This will trigger the built-in brace matching functionality of Visual Studio.

  • Avoid adding the input of the braces into the undo-list:

    Everything between the call of _applicationObject.UndoContext.Open() and _applicationObject.UndoContext.SetAborted() will not be visible in the undo-list.

  • Avoid visible page scrolling:

    After calling UndoContext.SetAborted(), the cursor will jump to the last position before UndoContext.Open() was called. It is necessary to move the page back to the current position. To hide this movement from the user, it is necessary to forbid the updating of the editor window by using: SendMessage(EditorWindowHwnd, WM_SETREDRAW, (IntPtr)0, (IntPtr)0). If everything is finished, window updating could be re-enabled using SendMessage(EditorWindowHwnd, WM_SETREDRAW, (IntPtr)1, (IntPtr)0).

Limitations

The add-in needs to rewrite the brace. This modifies the text as long as the cursor is near a brace. If you move the cursor away, the text is not modified anymore.

Conclusion

This is an essential feature for every text editor.

History

  • 0.3:
    • new version fixing problem with visible page scrolling
  • 0.2:
    • The add-in no longer modifies the undo-list.
    • The text is only modified as long as the cursor is near a brace.
    • Lot of internal changes.
  • 0.1:
    • Initial release.

License

This article, along with any associated source code and files, is licensed under The GNU General Public License (GPLv3)

Share

About the Author

Jochen Baier

Germany Germany
No Biography provided

Comments and Discussions

 
GeneralNo Wordwrap & Braces are deselected randomly in VS2005 [modified] Pinmemberfuzibuni4-Mar-11 2:27 
GeneralRe: No Wordwrap & Braces are deselected randomly in VS2005 PinmemberJochen Baier5-Mar-11 4:59 
GeneralCannot work with source controlled files PinmemberMember 475432621-Apr-10 8:13 
GeneralRe: Cannot work with source controlled files PinmemberJochen Baier6-May-10 10:14 
GeneralRe: Cannot work with source controlled files PinmemberMember 823582127-Sep-11 20:21 
GeneralVisual Studio 2008 german PinmemberHonkoid11-Feb-10 13:44 
GeneralRe: Visual Studio 2008 german PinmemberJochen Baier11-Feb-10 19:28 
GeneralRe: Visual Studio 2008 german PinmemberHonkoid12-Feb-10 4:55 
GeneralRe: Visual Studio 2008 german PinmemberJochen Baier12-Feb-10 22:46 
GeneralRe: Visual Studio 2008 german PinmemberHonkoid23-Feb-10 14:50 
Questionsource version Pinmemberdoktorekx23-Dec-09 10:06 
AnswerRe: source version PinmemberJochen Baier23-Dec-09 10:45 
GeneralRe: source version Pinmemberdoktorekx23-Dec-09 11:15 
GeneralAwesome! Pinmembervisualstudiowang23-Oct-09 12:00 
GeneralAuto-Generated End-Brace Comment Pinmemberkjward30-Sep-09 2:11 
GeneralRe: Auto-Generated End-Brace Comment PinmemberJochen Baier2-Oct-09 4:36 
GeneralModified for Visual Basic: Works in VS2008 but not VS2005 PinmemberBruce Farmer21-Sep-09 9:27 
GeneralRe: Modified for Visual Basic: Works in VS2008 but not VS2005 Pinmemberkjward29-Sep-09 4:18 
GeneralRe: Modified for Visual Basic: Works in VS2008 but not VS2005 PinmemberBruce Farmer29-Sep-09 4:38 
GeneralRe: Modified for Visual Basic: Works in VS2008 but not VS2005 Pinmemberkjward29-Sep-09 4:58 
GeneralRe: Modified for Visual Basic: Works in VS2008 but not VS2005 PinmemberBruce Farmer29-Sep-09 7:55 
GeneralMy vote of 1 Pinmembersalocin_2-Jul-09 3:50 
GeneralVS2008 SP1 PinmemberVEMS30-Apr-09 2:15 
Questionchances to get this working with visual basic in VS 2k8 as well? Pinmembertomtom19802-Apr-09 21:20 
GeneralColor Highliight [modified] Pinmemberameliaamelia26-Mar-09 15:57 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Mobile
Web02 | 2.8.141022.2 | Last Updated 5 Nov 2008
Article Copyright 2008 by Jochen Baier
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid