Основы написания макросов SynEdit: от записи до программирования с использованием PascalScript для Delphi и Pascal

Delphi , Технологии , Макросы

SynEdit - мощный компонент текстового редактора, широко используемый в средах разработки Delphi и Pascal. Одним из его ключевых преимуществ является возможность автоматизации задач с помощью макросов. В этой статье мы рассмотрим основы написания макросов для SynEdit, начиная с простых записанных макросов и переходя к более сложным, программируемым с использованием PascalScript.

Что такое макрос SynEdit?

Макрос SynEdit - это последовательность действий, которые можно записать и воспроизвести для автоматизации повторяющихся задач. Существует два основных типа макросов:

1. Записанные макросы: Простейший тип, представляющий собой последовательность нажатий клавиш и команд редактора, записанных в режиме реального времени. Не требует знания программирования.
2. Программируемые макросы: Более гибкий и мощный тип, использующий подмножество языка PascalScript для управления командами SynEdit. Позволяет создавать сложные логические конструкции и автоматизировать действительно сложные задачи.

Записанные макросы: Простота и удобство

Записанные макросы идеально подходят для автоматизации простых, повторяющихся действий. Чтобы создать записанный макрос:

1. Включите режим записи макроса в IDE (обычно через меню "Макросы" или аналогичное).
2. Выполните действия, которые вы хотите автоматизировать. SynEdit будет записывать все ваши нажатия клавиш и команды редактора.
3. Остановите запись макроса.
4. Сохраните макрос под удобным именем.
5. Воспроизведите макрос в любое время, чтобы повторить записанную последовательность действий.

Хотя записанные макросы просты в использовании, они ограничены в своей функциональности. Для более сложных задач потребуется программируемый макрос.

Программируемые макросы: Мощь PascalScript

Программируемые макросы используют подмножество языка PascalScript для управления редактором SynEdit. Это открывает возможности для создания макросов, способных выполнять сложные логические операции, условные переходы и манипуляции с текстом.

Особенности PascalScript в макросах SynEdit

Важно понимать ограничения PascalScript при написании макросов SynEdit:

• Ограничения языка: PascalScript - это подмножество Pascal, поэтому некоторые возможности стандартного Pascal недоступны. Например, запрещены локальные объявления типов и констант, диапазоны в объявлениях множеств (..), типизированные константы.
• Отсутствие writeln: Функция writeln для вывода информации недоступна. Для отладки используйте функцию ShowMessage (см. ниже).
• Ошибки присваивания: Если пропустить двоеточие в операторе присваивания (= вместо :=), PascalScript выдаст неинформативное сообщение об "Internal error (20)".
• Проблемы с break и continue: Вложенные циклы могут некорректно обрабатывать операторы break и continue.
• Нет отладчика, модулей, include-файлов, препроцессора: Это значительно усложняет организацию и отладку кода.
• Строки на основе 1: В отличие от стандартного Pascal, строки в макросах PascalScript индексируются с 1.

Рекомендации по программированию макросов SynEdit

• Простота кода: Из-за ограничений языка и отсутствия отладчика, стремитесь к максимально простому и понятному коду.
• Отладка: Используйте функцию ShowMessage для вывода отладочной информации. Создайте собственные функции для вывода информации и приостановки выполнения (см. пример ниже).
• Соглашения об именах: Придерживайтесь четких соглашений об именах для переменных и функций, чтобы облегчить понимание кода.
• Разбиение на функции: Разбивайте сложные задачи на небольшие, легко тестируемые функции.

Пример отладочных функций

const
  DEBUG_OUTPUT_MESSAGES = TRUE;
  DEBUG_PAUSE           = TRUE;

procedure OutputDebugString(const InDebugString: string; const InOutput: boolean);
begin
  if not DEBUG_OUTPUT_MESSAGES then Exit;
  if not InOutput then Exit;
  ShowMessage(InDebugString);
end;

procedure Pause(const InPauseMessage: string);
var
  InString: string;
begin
  if not DEBUG_PAUSE then Exit;
  if Trim(InPauseMessage) = '' then InPauseMessage := 'execution PAUSED';
  InputQuery(InPauseMessage, 'press ENTER/RETURN to continue', InString);
end;

Работа с редактором SynEdit: Ключевые моменты

• Нумерация строк: Внутренний массив строк SynEdit (Lines) индексируется с 0, в то время как координаты курсора (CaretXY) начинаются с 1. Будьте внимательны при преобразовании между этими системами.
• Автоматическое заполнение пробелами: При вводе текста в редакторе SynEdit, он автоматически заполняет пробелами пустые области между последним существующим символом и введенным текстом. Это может упростить написание макросов.

Функции PascalScript, доступные в макросах SynEdit

PascalScript предоставляет набор стандартных функций, которые можно использовать в макросах. К ним относятся функции для работы со строками, числами и массивами. Полный список функций можно найти в документации PascalScript. Некоторые из наиболее часто используемых функций:

• Abs(e: extended): extended - Возвращает абсолютное значение числа.
• Copy(s: string; ifrom, icount: longint): string - Возвращает подстроку из строки.
• Delete(var s: string; ifrom, icount: longint) - Удаляет подстроку из строки.
• FloatToStr(e: extended): string - Преобразует число с плавающей точкой в строку.
• IntToStr(i: longint): string - Преобразует целое число в строку.
• Length(s: string): longint - Возвращает длину строки.
• Lowercase(s: string): string - Преобразует строку в нижний регистр.
• Uppercase(s: string): string - Преобразует строку в верхний регистр.
• Pos(substr, s: string): longint - Возвращает позицию подстроки в строке.
• Trim(s: string): string - Удаляет пробелы в начале и конце строки.
• StrToInt(s: string): longint - Преобразует строку в целое число.
• StrToFloat(s: string): extended - Преобразует строку в число с плавающей точкой.

Функции SynEdit, доступные в макросах SynEdit

SynEdit предоставляет набор функций и команд, специфичных для редактора, которые можно использовать в макросах. Список этих функций можно найти в файле syneditkeycmds.pp (или аналогичном файле в вашей установке Lazarus/Delphi). Некоторые из наиболее полезных функций:

• ecFind - Найти.
• ecReplace - Заменить.
• ecGotoLineNumber - Перейти к номеру строки.
• ecSelectionUpperCase - Преобразовать выделенный текст в верхний регистр.
• ecSelectionLowerCase - Преобразовать выделенный текст в нижний регистр.
• ecSelectionComment - Закомментировать выделенный текст.
• ecSelectionUncomment - Раскомментировать выделенный текст.
• ecInsertTextAtCaret(Text: String; Adjust: TSynEditCaretAdjust) - Вставить текст в позицию курсора.
• CaretXY: TPoint - Возвращает координаты курсора.
• Lines: TStrings - Возвращает список строк в редакторе.
• SelAvail: Boolean - Возвращает True, если выделен текст.
• BlockBegin: TPoint - Возвращает начальную координату выделенного блока.
• BlockEnd: TPoint - Возвращает конечную координату выделенного блока.
• LineAtCaret: String - Возвращает строку, в которой находится курсор.
• MoveCaretIgnoreEOL(Point: TPoint) - Перемещает курсор в указанную позицию, игнорируя конец строки.
• LogicalCaretXY: TPoint - Устанавливает логическую позицию курсора.

Пример макроса: Выравнивание столбцов по двоеточию

Этот пример демонстрирует, как выровнять столбцы в выделенном блоке кода по символу двоеточия (:).

var
  p1, p2: TPoint;
  s1, s2: string;
  i, j, k: Integer;

begin
  if not Caller.SelAvail then Exit;

  p1 := Caller.BlockBegin;
  p2 := Caller.BlockEnd;

  s2 := ':'; // Символ для выравнивания

  j := 0;
  for i := p1.y to p2.y do
  begin
    s1 := Caller.Lines[i - 1];
    k := Pos(s2, s1);
    if (k > j) then j := k;
  end;

  if j < 1 then Exit;

  for i := p1.y to p2.y do
  begin
    s1 := Caller.Lines[i - 1];
    k := Pos(s2, s1);
    if (k > 0) and (k < j) then
    begin
      Caller.LogicalCaretXY := Point(k, i);
      while k < j do
      begin
        ecChar(' ');
        inc(k);
      end;
    end;
  end;
end.

Альтернативное решение (с использованием регулярных выражений)

Хотя PascalScript не поддерживает регулярные выражения "из коробки", можно использовать сторонние библиотеки для работы с ними. Использование регулярных выражений позволило бы значительно упростить поиск и выравнивание столбцов. Например, можно использовать библиотеку TRegExpr (доступна в Lazarus/Delphi) для поиска всех строк, содержащих двоеточие, и определения максимальной позиции двоеточия. Затем можно использовать эту информацию для выравнивания столбцов, как и в предыдущем примере. Этот подход может быть более гибким и устойчивым к изменениям в формате кода.

Заключение

Макросы SynEdit - мощный инструмент для автоматизации задач в Delphi и Pascal. Начиная с простых записанных макросов и переходя к более сложным, программируемым с использованием PascalScript, вы можете значительно повысить свою производительность и избежать рутинных операций. Помните об ограничениях PascalScript, стремитесь к простоте кода и используйте отладочные функции для облегчения разработки. Экспериментируйте, изучайте доступные функции SynEdit и создавайте макросы, которые помогут вам в вашей работе!

Создано по материалам из источника по ссылке.

Этот текст описывает основы создания макросов для компонента SynEdit, начиная с простых записанных макросов и заканчивая программируемыми макросами с использованием PascalScript.

Комментарии и вопросы

Получайте свежие новости и обновления по Object Pascal, Delphi и Lazarus прямо в свой смартфон. Подпишитесь на наш Telegram-канал delphi_kansoftware и будьте в курсе последних тенденций в разработке под Linux, Windows, Android и iOS

:: Главная :: Макросы ::