Another way to extend the functionality of the studio Caché

It was necessary to meet with the opinion that the studio Caché is not completely perfect, in particular the fact that it cannot be expanded. However, this is not the case. There is a regular mechanism of templates and extensions , which allows the studio to be completed with interactive additions.
In this article we will touch on another extension method that can help more effectively manage the generated code. This will help the studio integration class with the version control system.
What can be done with the version control class? First, to track some events occurring in the studio, such as connecting, creating, deleting, opening documents, and secondly, the ability to add items to the menu, including the shortcut. Through these menu items you can not only execute code on the server, but also create some simple dialogs.

Let's try to expand the studio menu in order to reduce / increase the indent, comment / uncomment the code block (these features in recent versions of Caché are available by keyboard shortcuts), and also add the ability to reformat indents and brackets, which is often not enough when editing large programs.

Creating a version control class

Create a class Util.StudioExtension as a descendant of% Studio.Extension.Base and assign it in the server configuration for the area in which we are going to use this extension:

System Administration> Configuration> Advanced Settings -> Version Control System
')
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 >
}
}
In this block, the tags MenuBase, Menu, MenuItem are the display of the classes% Studio.Extension.Base,% Studio.Extension.Menu,% Studio.Extension.MenuItem, the meaning of the attributes can be understood from their documentation. In our case, Name is the internal name of the item, Type = 1 means that the context menu, Separator = 1, that the item is a separator, Save = 100, that when you click the menu item, the document should be saved.

Create a method that handles the display of the menu itself. Add readable Russian names to menu items; in cases when we consider it necessary, we make them inactive (Enabled = 0). For example, it makes no sense to make active the item “reformat the selected text” if nothing is selected.

After reconnection by the studio, a new context menu item should appear, but it still does nothing:

Indenting Class

Create a UserAction method that will respond to various actions, including the selection of menu items:

The class itself that we use to format tabs:

Now, if you reconnect with the studio (this should always be done after changing the version control class), the menu items “add indent” and “remove indent” should work.

Class for commenting / uncommenting code

We modify the UserAction method of the Util.StudioExtension class by adding the processing of new items:

We use the Util.FormatComment class to process strings:

Text formatting

Let's connect a class to reformat code. It can be useful if your project was written by different teams or programmers who did not adhere to the same style. Type Code
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
}
}
can be turned into
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
}
}
or vice versa, as someone like. The class for the style “bracket above the bracket” - Util.CodeFormat, the class for the style “bracket at the end of the line” - Util.CodeFormat3

Modify the UserAction method by adding processing new menu items:

Class handler code in the style of "bracket above the bracket"

Class handler code in the style of "bracket at the end of the line." If this style is preferable, you need to replace the calls to the UtilCodeFormat class from the UserAction method with UtilCodeFormat3.

Class expansion studio Caché entirely:

Done!