AXAligner - скрипт редактора для выравнивания X++ кода

[alex55]

Приветствую!

Набросал скрипт для выравнивания X++ кода, желающие могут попробовать beta-версию. Проверял работоспособность в AX 2009 и AX 2012, по идее должен работать и в предыдущих версиях.

Возможности:
- Обработка блока выделенных строк;
- Выравнивание первой границы слева по верхней строке;
- Выравнивание второй границы слева по максимальному значению в блоке;

Установка:
- Добавить в качестве нового метода в класс EditorScripts и скомпилировать.

P.S. Конструктивная критика, мысли по доработке и вариации на тему приветствуются.

//AXAligner ver. 1.0 beta (for AX 2009, AX 2012)
//Developed by alex55 (AXforum.info), 22.01.2013
//Aligns first and second borders from the left for selected block of code
public void aAXAligner(Editor _editor)
{
    #define.EmptyString('')
    #define.Space(' ')
    #define.AllLeftSpaces('<: *')
    #define.AllCharsBeforeSecondLeftBorder('<[^: ]*')

    int i;
    int leftBorderWidth;
    int firstRowLength;
    int maxSecondLeftBorderWidth;
    int startLine = _editor.selectionStartLine();
    int endLine   = _editor.selectionEndLine();

    Map         map         = new Map(Types::Integer, Types::Container);
    TextBuffer  textBuffer  = new TextBuffer();

    str removeAllLeftSpaces(str _row)
    {
        ;

        textBuffer.setText(_row);
        textBuffer.replace(#AllLeftSpaces, #EmptyString);

        return textBuffer.getText();
    }

    void getMaxSecondLeftBorderWidth(str _row, int _rowNum)
    {
        int newRowLength;
        int secondLeftBorderWidth;
        int rowLength;
        ;

        _row = removeAllLeftSpaces(_row);

        rowLength = strlen(_row);

        textBuffer.setText(_row);
        textBuffer.replace(#AllCharsBeforeSecondLeftBorder, #EmptyString);
        textBuffer.replace(#AllLeftSpaces, #EmptyString);

        newRowLength = strlen(textBuffer.getText());

        secondLeftBorderWidth = rowLength - newRowLength;

        map.insert(_rowNum, [secondLeftBorderWidth, rowLength, _row]);

        if (secondLeftBorderWidth > maxSecondLeftBorderWidth)
        {
            maxSecondLeftBorderWidth = secondLeftBorderWidth;
        }
    }

    str alignSecondLeftBorder(int _rowNum)
    {
        int newRowLength;
        int secondLeftBorderWidth;
        int rowLength;
        str secondLeftBorderString;
        str row;
        ;

        [secondLeftBorderWidth, rowLength, row] = map.lookup(_rowNum);

        secondLeftBorderString  = substr(row, 1, secondLeftBorderWidth);
        secondLeftBorderString += strrep(#Space, maxSecondLeftBorderWidth - secondLeftBorderWidth);

        return strrep(#Space, leftBorderWidth) + secondLeftBorderString + substr(row, secondLeftBorderWidth + 1, rowLength - secondLeftBorderWidth);
    }

    str getEditorRow(int _rowNum)
    {
        _editor.gotoLine(_rowNum);
        
        return _editor.currentLine();
    }

    void replaceEditorRow(int _rowNum, str _rowValue)
    {
        _editor.gotoLine(i);
        _editor.gotoCol(1);
        _editor.deleteLines(1);
        _editor.insertLines('\n');
        _editor.gotoLine(_rowNum);
        _editor.gotoCol(1);
        _editor.insertLines(_rowValue);
    }
    ;

    firstRowLength  = strlen(getEditorRow(startLine));
    leftBorderWidth = firstRowLength - strlen(removeAllLeftSpaces(getEditorRow(startLine)));

    for (i = startLine; i <= endLine; i++)
    {
        getMaxSecondLeftBorderWidth(getEditorRow(i), i);
    }

    for (i = startLine; i <= endLine; i++)
    {
        replaceEditorRow(i, alignSecondLeftBorder(i));
    }
}

[dech]

Вместо removeAllLeftSpaces() можно использовать strltrim().
Сразу 10 строк кода долой.
Кстати, в AX 3.0 зависает напрочь.

[alex55]

Цитата:

Сообщение от dech

Вместо removeAllLeftSpaces() можно использовать strltrim().
Сразу 10 строк кода долой.

Спасибо! Да, думаю strltrim() будет вполне достаточно, заменил в новой версии.

Цитата:

Сообщение от dech

Кстати, в AX 3.0 зависает напрочь.

Видимо 3-ка была немного шокирована используемыми регулярками.

Попробуйте менее универсальный вариант, например:
#define.AllNonSpaceCharsBeforeSecondLeftBorder('<[\.\_a-Z0-9\[\]]*')

Возможно его придется дополнить некоторыми символами при необходимости, спец-символа для всех непробельных символов в match-style regexp я не нашел. 3-ку вообще сейчас не использую, так что проверяю только в "поддерживаемых" версиях.

[alex55]

Доработано:
- Устранено возможное срабатывание индикации синтаксических ошибок в окне кода после обработки блока объявления переменных;

//AXAligner ver. 1.1 beta (for AX 2009, AX 2012)
//Developed by alex55 (AXforum.info), 23.01.2013
//Home page: axforum.info/forums/showthread.php?t=45984
//Aligns first and second borders from the left for selected block of a code
public void aAXAligner(Editor _editor)
{
    #define.EmptyString('')
    #define.Space(' ')
    #define.LineDelimiter('\n')
    #define.FirstColumnNum(1)
    #define.OneLine(1)
    #define.AllFirstNonSpaceChars('<[^: ]*')

    int i;
    int leftBorderWidth;
    int firstRowLength;
    int maxSecondLeftBorderWidth = 0;
    int startLine = _editor.selectionStartLine();
    int endLine   = _editor.selectionEndLine();
    int columnNum = _editor.selectionEndCol();

    List         list       = new List(Types::Container);
    TextBuffer   textBuffer = new TextBuffer();
    ListIterator iterator;

    void getMaxSecondLeftBorderWidth(str _row)
    {
        int newRowLength;
        int secondLeftBorderWidth;
        int rowLength;
        ;

        _row = strltrim(_row);

        rowLength = strlen(_row);

        textBuffer.setText(_row);
        textBuffer.replace(#AllFirstNonSpaceChars, #EmptyString);

        newRowLength = strlen(strltrim(textBuffer.getText()));

        secondLeftBorderWidth = rowLength - newRowLength;

        list.addEnd([secondLeftBorderWidth, rowLength, _row]);

        if (secondLeftBorderWidth > maxSecondLeftBorderWidth)
        {
            maxSecondLeftBorderWidth = secondLeftBorderWidth;
        }
    }

    str alignSecondLeftBorder()
    {
        int secondLeftBorderWidth;
        int rowLength;
        str secondLeftBorderString;
        str row;
        ;

        [secondLeftBorderWidth, rowLength, row] = iterator.value();

        secondLeftBorderString  = substr(row, 1, secondLeftBorderWidth);
        secondLeftBorderString += strrep(#Space, maxSecondLeftBorderWidth - secondLeftBorderWidth);

        return strrep(#Space, leftBorderWidth) + secondLeftBorderString + substr(row, secondLeftBorderWidth + 1, rowLength - secondLeftBorderWidth);
    }

    str getEditorRow(int _rowNum)
    {
        _editor.gotoLine(_rowNum);

        return _editor.currentLine();
    }

    void replaceEditorRow(int _rowNum, str _row)
    {
        _editor.gotoLine(_rowNum);
        _editor.gotoCol(#FirstColumnNum);
        _editor.deleteLines(#OneLine);
        _editor.insertLines(#LineDelimiter);
        _editor.gotoLine(_rowNum);
        _editor.gotoCol(#FirstColumnNum);
        _editor.insertLines(_row);
    }

    //Fixes editor's errors indication
    void refreshEditor()
    {
        _editor.gotoLine(endLine + 1);
        _editor.gotoCol(#FirstColumnNum);
        _editor.insertLines(#LineDelimiter);
        _editor.gotoLine(endLine + 1);
        _editor.deleteLines(#OneLine);
        _editor.gotoLine(endLine);
        _editor.gotoCol(columnNum);
    }
    ;

    if (startLine >= endLine)
    {
        return;
    }

    firstRowLength  = strlen(getEditorRow(startLine));
    leftBorderWidth = firstRowLength - strlen(strltrim(getEditorRow(startLine)));

    for (i = startLine; i <= endLine; i++)
    {
        getMaxSecondLeftBorderWidth(getEditorRow(i));
    }

    iterator = new ListIterator(list);

    i = startLine;

    while (iterator.more())
    {
        replaceEditorRow(i, alignSecondLeftBorder());
        iterator.next();
        i++;
    }

    refreshEditor();
}

[macklakov]

Забавная штучка. Есть надежда, что она эволюционирует во что-то вроде Ctrl+K+D из VS?

[S.Kuskov]

Цитата:

Сообщение от alex55

- Выравнивание второй границы слева по максимальному значению в блоке;

А что такое вторая граница?

Предлагаю следующие направления для развития:
Что будет если выделить строки не целиком, а частично? С использованием ALT-O?
Что будет если в коде есть закоментированные строки?

Цитата:

Сообщение от dech

Кстати, в AX 3.0 зависает напрочь.

Axapta виснет на TextBuffer::replace

[kashperuk]

Скрипт не пробовал, поэтому про него писать не буду, хотя думаю, что в общем случае вещь полезная однозначно.

А для меня просто выравнивание индентации кода - это как шаманский ритуал после завершения кодирования, чтоб меньше ломалось поэтому делаю всегда вручную

[alex55]

Цитата:

Сообщение от macklakov

Забавная штучка. Есть надежда, что она эволюционирует во что-то вроде Ctrl+K+D из VS?

Пока в планах только доработка "полу-автоматического" выравнивания для основных типов блоков. Смысл дальнейшей доработки еще не очевиден.

[alex55]

Цитата:

Сообщение от alex55

Видимо 3-ка была немного шокирована используемыми регулярками.

Попробуйте менее универсальный вариант, например:
#define.AllNonSpaceCharsBeforeSecondLeftBorder('<[\.\_a-Z0-9\[\]]*')

Упс.. Бэкслэши все же двойные должны быть в этом случае:

#define.AllFirstNonSpaceChars('<[\\.\\_a-Z0-9\\[\\]]*')

[alex55]

Цитата:

Сообщение от S.Kuskov

А что такое вторая граница?

Позиция первого символа в имени переменной для декларативного блока или символа присваивания для блока присваивания.

Цитата:

Сообщение от S.Kuskov

Предлагаю следующие направления для развития:
Что будет если выделить строки не целиком, а частично? С использованием ALT-O?

Спасибо за идеи! В обработке участвуют вертикальные границы выделенного блока, так что с частичным выделением работает нормально (обрабатываются строки, попавшие в выделение).

Цитата:

Сообщение от S.Kuskov

Что будет если в коде есть закоментированные строки?

Кстати да, строки комментариев в рамках блока надо вообще исключать из обработки и оставлять без изменений. Это точно надо допилить.

[alex55]

Цитата:

Сообщение от kashperuk

А для меня просто выравнивание индентации кода - это как шаманский ритуал после завершения кодирования, чтоб меньше ломалось поэтому делаю всегда вручную

Вообще говоря в данной реализации оставлена разумная доля шаманства: нужный блок там выделить или даже блок одного типа на несколько блоков разбить для достижения более лучшего фэн-шуя и все такое. И, кроме того, думаю нужным шаманским действием обладает результат выравнивания а не его процесс, так что может все же не стоит отказываться от достижений цивилизации?

[Alex_KD]

Пару идей можно почерпнуть тут:AxAssist - ReFormatter

До:



После:



Выложите пару скриншотов чтобы не было вопросов типа "А что такое вторая граница?".
Еще я бы все изменения делал в одной "транзакции", чтобы ctrl-Z нажимать один раз если вдруг чтото не так.

[alex55]

Цитата:

Сообщение от Alex_KD

Пару идей можно почерпнуть тут:AxAssist - ReFormatter

Спасибо, уже глянул! Не было, кстати, желания сделать опциональную обработку по выделению? По старому коду не всегда целессобразно полный реформатинг делать имхо..

Цитата:

Сообщение от Alex_KD

Выложите пару скриншотов чтобы не было вопросов типа "А что такое вторая граница?".

Да, надо будет сделать. Думаю допилить сначала, а потом уже скриншотить более-менее завершенную версию.

Цитата:

Сообщение от Alex_KD

Еще я бы все изменения делал в одной "транзакции", чтобы ctrl-Z нажимать один раз если вдруг чтото не так.

Хорошая идея, спасибо!