Создаем расширение (extension) Visual Studio для генерирования C++ директивы #define в header-файле

    Добрый день.
    Будем делать расширение Visual Studio, которое встраивает в контекстное меню редактора поле «Create C++ Header #define», при клике на которое генерируется уникальная директива #define (директива позволяет включать header только один раз).
    В конечном счете выглядеть это будет следующим образом:



    На самом деле обычно это автоматизируется с помощью макросов самой студии ( и вариантов макросов в сети много), но мне приятнее использовать контекстное меню, тем более что создание самого расширения — это дело простое, всю работу сделает VSPackage Builder, нам останется лишь вписать несколько строчек кода в обработчик нажатия элемента меню.


    Итак, начнем. Нам потребуется Visual Studio 2010 Pro или старше. Необходимо дополнительно установить Visual Studio 2010 SDK и специальное дополнение VSPackage Builder, максимально облегчающее создание новых расширений.

    Создание расширения


    Создадим новый проект в Visual Studio:
    Visual C# -> Extensibility -> VSPackage Builder
    Даем проекту имя — я назвала его HeaderDefineCreater.



    В открывшемся проекте разместим на дизайнере расширения (файл HeaderDefineCreater.vspackage) все необходимые нам элементы. Начнем с первого элемента — добавим контекстное меню. В его свойствах напротив поля Location выберем размещение — «Context Menu | Editor»



    Затем создадим группу Group, одну кнопку (назовем ее CreateHeaderDefineButton) и два коннекта между всеми элементами. На скрине с левой стороны показаны свойства для кнопки. Там все стандартное, разве что следует обратить внимание что кнопка (то есть строка в контекстном меню) будет видима только в редакторе (Visibility Constraints: TextEditor). Что касается шортката, то эти поля можно оставить пустыми, поскольку их можно настроить отдельно при использовании расширения.



    Ну вот, все готово. Осталось только заполнить обработчик нажатия на элемент контекстного меню.
    Автоматически сгенерированный обработчик нажатия выглядит следующим образом:
    using System;
    using System.Collections.Generic;
    using System.Linq;
    using System.Text;
    using System.Runtime.InteropServices;
    using Microsoft.VisualStudio;
    using Microsoft.VisualStudio.Shell.Interop;
    using Microsoft.VisualStudio.OLE.Interop;
    using Microsoft.VisualStudio.Shell;
    
    
    namespace HeaderDefineCreater
    {
        [Guid(GuidList.guidHeaderDefineCreaterPkgString)]
        public class HeaderDefineCreaterPackage : HeaderDefineCreaterPackageBase
        {
            protected override void CreateHeaderDefineButtonExecuteHandler(object sender, EventArgs e)
            {
    
            }
        }
    }
    
    


    Заполним обработчик. Существует множество схожих по функциональности макросов для студии, написанные в VB, так что ничего не пришлось выдумывать самой, просто слегка переписала на С#.

    using System;
    using System.Collections.Generic;
    using System.Linq;
    using System.Text;
    using System.Runtime.InteropServices;
    using Microsoft.VisualStudio;
    using Microsoft.VisualStudio.Shell.Interop;
    using Microsoft.VisualStudio.OLE.Interop;
    using Microsoft.VisualStudio.Shell;
    
    // Импортируем еще 3 пространства имен:
    using System.Windows.Forms;
    using EnvDTE;
    using System.IO;
    
    namespace HeaderDefineCreater
    {
        [Guid(GuidList.guidHeaderDefineCreaterPkgString)]
        public class HeaderDefineCreaterPackage : HeaderDefineCreaterPackageBase
        {
            protected override void CreateHeaderDefineButtonExecuteHandler(object sender, EventArgs e)
            {
                try
                {
                    // Получим объект верхнего уровня в объектной модели автоматизации Visual Studio
                    EnvDTE.DTE dte = (EnvDTE.DTE)GetService(typeof(EnvDTE.DTE));
    
                    // Получим название без расширения у активного документа в Visual Studio
                    String fileName = Path.GetFileNameWithoutExtension(dte.ActiveDocument.Name);
    
                    // Приведем название к прописным буквам
                    fileName = fileName.ToUpper();
    
                    // Сгенерируем уникальный идентификатор GUID
                    String strGuid = System.Guid.NewGuid().ToString().ToUpper();
                    strGuid = strGuid.Replace("-", "_");
    
                    // Объединим название файла и идентификатор GUID 
                    String strDefine = fileName + "_" + strGuid;
    
                    // Создадим саму надпись, которая будет выведена в документе
                    string txt = "";
                    txt += "\n#ifndef " + strDefine;
                    txt += "\n#define " + strDefine;
                    txt += "\n\n\n\n\n#endif // " + strDefine;
                    txt += "\n";
        
                    // Выведем надпись в активный документ
                    TextSelection textSelection = (TextSelection)dte.ActiveDocument.Selection;
                    textSelection.Text = txt;
    
                }
                catch (Exception ex)
                {
                    // Если что-то пошло не так, то просто покажем сообщение об ошибке и не уроним студию...
                    MessageBox.Show(ex.Message);
                }
            }
        }
    }
    


    Нам осталось лишь заполнить поля в манифесте (добавить иконку, описание и тд. ) и все скомпилировать.



    После компиляции мы получим готовое расширение HeaderDefineCreater.vsix.

    Установка расширения и смена шорткатов


    Устанавливается расширение простым двойным кликом.
    Удалить его можно зайдя в Tools->Extension Manager.



    Для того, чтобы установить шорткат для расширения, нужно зайти в Tools -> Options -> Keyboard, найти там по поиску имя кнопки (мы кнопку назвали CreateHeaderDefineButton, но, впрочем, для простоты можно было бы ее назвать и именем расширения). Для найденной кнопки ставим любое свободное сочетание:



    Спасибо за внимание. Замечания приветствуются. Замечу, что я не пишу на C#, а изучаю С++ и расширение создавалось прежде всего для облегчения рутинных операций на плюсах и для внутреннего использования. Думаю, что название для поля контекстного меню можно было бы придумать и лучше… да и иконка не соответствует содержимому :) Но здесь мне просто хотелось показать как быстро создать свое расширение, надеюсь, еще кому-нибудь будет полезно.

    Я не стала выкладывать сюда весь проект, поскольку расширение очень простое, все шаги описаны, да и весь код в обработчике клика тоже здесь выложен. Поэтому приложу для примера только само расширение, получившееся в итоге — HeaderDefineCreater.vsix

    Средняя зарплата в IT

    110 475 ₽/мес.
    Средняя зарплата по всем IT-специализациям на основании 6 942 анкет, за 2-ое пол. 2020 года Узнать свою зарплату
    AdBlock похитил этот баннер, но баннеры не зубы — отрастут

    Подробнее
    Реклама

    Комментарии 10

      0
      >>«Create C++ Header #define», при клике на которое генерируется уникальная директива #define (директива позволяет включать header только один раз).

      Решая похожу задачу написал скрипт на python 3.2 и поместил в Tools Visual Studio. На мой взгляд быстрее написать скрипт и повесть в Tools Visual Studio или поместить вызов скрипта в одной из опций Far или Total Commander

      Также рекомендую еще включить "#pragma once"
        0
        Еще быстрее макрос в самой студии написать на VB и вызывать по комбинации клавиш. И поначалу я именно таким способом и пользовалась, но потом сделала себе это расширение и как то привыкла уже им пользоваться. Про "#pragma once" перед дефайнами — это есть в моем исходном расширении, но сюда я не стала его добавлять, нужно будет дописать.
          +1
          #pragma once не нужен перед дефайнами — он нужен вместо них.
          И ЕМНИП с кроссплатформенностью у него уже все хорошо.
          Так что совсем не ясно для чего огород городить.
        +2
        Имхо, уникальный идентификатор со случайными цифрами выглядит ужасно. Google C++ Style guide рекомендует генерировать его по полному пути к файлу в проекте (заменяя слэши на подчеркивания)--и я с ним согласен, так define guards выглядят намного читабельнее и удобнее.
          0
          Это оно конечно да, но тогда при переименовании или перемещении файлов придется изменять все дефайны внутри файлов. Поэтому мне больше близка идея GUID
            0
            Вы правы. Поэтому лучшее решение, на мой взгляд, это
            а. пользоваться гугловским соглашением о полных путях
            б. написать еще один макрос/плагин/консольное приложение :-), типа «UpdateDefineGuardsInProject», который сможет обновить все define guards в проекте в соответствие с текущими путями
            в. в новых файлах вызывать ваше представленное расширение, генерировать начальный guard
            г. при перемещении/переименовании файлов вызывать второй плагин

            Притом в вашем расширении можно просто будет вызвать часть кода из UpdateDefineGuardsInProject, при определенной архитектуре.
          0
          Давно уже ничего не писал в VS, но по-моему там хватает "#pragma once"… Думаю, что при изучении C++ проблемы переносимости кода и скорости компиляции вас не слишком заинтересуют.
          А вообще CodeBlocks или SublimeText2 в сочетании с clang или gcc, и будет вам счастье с C++11 и без меню с большими буквами (привет, VS12!).
            0
            SublimeText я использую, но в качестве просто текстового редактора. Visual Studio как IDE как-то ближе, а под линуксом Qt Creator
            +2
            Название команды не очень удачное, непонятно о чём.
            Для таких дефайнов есть термин «include guard»:
            ru.wikipedia.org/wiki/Include_guard
              +1
              Да! Спасибо. Я знала что этому должно быть красивое название, спасибо что подсказали

            Только полноправные пользователи могут оставлять комментарии. Войдите, пожалуйста.

            Самое читаемое