Еще один способ расширения функциональности студии Caché

Приходилось встречаться с мнением, что студия Caché не вполне совершенна, в частности тем, что ее невозможно расширить. Тем не менее, это не совсем так. Существует штатный механизм шаблонов и расширений, позволяющий достраивать студию интерактивными дополнениями.
В этой статье мы коснемся еще одного способа расширения, который может помочь более эффективно управлять создаваемым кодом. В этом поможет класс интеграции студии с системой контроля версий.
Что можно сделать с помощью класса контроля версий? Во-первых, отслеживать некоторые события, происходящие в студии, такие как подключение, создание, удаление, открытие документов, а во-вторых, возможность добавлять пункты в меню, в том числе в контекстное. Через эти пункты меню можно не только выполнять код на сервере, но и создавать некоторые простые диалоги.

Попробуем сделать расширение меню студии для того, чтобы уменьшить/увеличить отступ, комментировать/раскомментировать блок кода (эти возможности в последних версиях Caché есть, доступны по сочетаниям клавиш), а также добавим возможность переформатирования отступов и скобок, которого часто не хватает при редактировании больших программ.

Создание класса контроля версий

Создадим класс Util.StudioExtension как наследника %Studio.Extension.Base и пропишем его в конфигурации сервера для области, в которой собираемся использовать это расширение:

Администрирование системы > Конфигурация > Дополнительные настройки -> Система контроля версий

Class Util.StudioExtension Extends %Studio.Extension.Base
{
XData Menu
{
<MenuBase>
    <Menu Name="Format" Type="1">
        <MenuItem Name="PlusTab"/>
        <MenuItem Name="MinusTab"/>
        <MenuItem Separator="1" />
        <MenuItem Name="ReformatSelection"/>
        <MenuItem Name="ReformatDocument" Save="100"/>
        <MenuItem Separator="1" />
        <MenuItem Name="CommentBlock"/>
        <MenuItem Name="UnCommentBlock"/>
    </Menu>
</MenuBase>
}
}
В этом блоке теги MenuBase, Menu, MenuItem являются отображением классов %Studio.Extension.Base, %Studio.Extension.Menu, %Studio.Extension.MenuItem, смысл атрибутов можно понять по их документации. В нашем случае Name — внутреннее имя пункта, Type=1 означает, что меню контекстное, Separator=1, что пункт является разделителем, Save=100, что при нажатии пункта меню документ должен сохраниться.

Создадим метод, обрабатывающий отображение самого меню. Добавим читаемые русские названия пунктам меню, в случаях, когда считаем нужным, делаем их неактивными (Enabled=0). Например, нет смысла делать активным пункт “переформатировать выделенный текст”, если ничего не выделено.

После переподключения студией должен появиться новый пункт контекстного меню, но он пока еще ничего не делает:

Класс с для работы с отступами

Создадим метод UserAction, который будет реагировать на различные действия, в том числе и на выбор пунктов меню:

Сам класс, который мы используем для форматирования табуляций:

Теперь, если переподключиться студией (это всегда нужно делать после изменения класса контроля версий), пункты меню “добавить отступ” и “убрать отступ” должны заработать.

Класс для комментирования/раскомментирования кода

Модифицируем метод UserAction класса Util.StudioExtension, добавив обработку новых пунктов:

Используем класс Util.FormatComment для обработки строк:

Форматирование текста

Подключим класс для переформатирования кода. Может быть полезно, если ваш проект писался разными командами или программистами, которые не придерживались единого стиля. Код типа
 for i = TheNum:1:TheNum+2 {
         set StartTime = 12 * 3600 + (300 * $R(6))
         while StartTime < (3600 * 22) {
                 set show=##class(Cinema.Show).%New()
                 set show.Film=TheFilm
                 set show.Theater=the(i)
                 set show.StartTime=StartTime
                 do show.%Save()
                 set StartTime = StartTime+(TheFilm.Length * 60) + 1200 \ 300 * 300
         }
 }
можно превратить в
    for i = TheNum:1:TheNum+2
    {
        set StartTime = 12 * 3600 + (300 * $R(6))
        while StartTime < (3600 * 22)
        {
            set show=##class(Cinema.Show).%New()
            set show.Film=TheFilm
            set show.Theater=the(i)
            set show.StartTime=StartTime
            do show.%Save()
            set StartTime = StartTime+(TheFilm.Length * 60) + 1200 \ 300 * 300
        }
    }
или наоборот, как кому нравится. Класс для стиля “скобка над скобкой” — Util.CodeFormat, класс для стиля “скобка в конце строки” — Util.CodeFormat3

Модифицируем метод UserAction, добавив обработку новых пунктов меню:

Класс обработчик кода в стиль «скобка над скобкой»

Класс-обработчик кода в стиль «скобка в конце строки». В случае, если такой стиль предпочтительней, нужно заменить обращения к классу UtilCodeFormat из метода UserAction на UtilCodeFormat3.

Класс-расширение студии Caché целиком:

Готово!