Редактор текстовых программ AgavaSCADA/AgavaPLC

1 Назначение

Текстовый редактор предназначен для подготовки, просмотра и изменения исходных текстов прикладного проекта AgavaSCADA на языках AS (C++) и ST (Structured Text). Редактор применяется при работе с программами, функциями, методами, конструкторами, текстовыми секциями, объявлениями глобальных переменных и другими программными элементами, для которых предусмотрено текстовое представление.

Основные средства редактора обеспечивают ввод и структурирование текста, поиск и замену, просмотр подсказок, переход к определениям программных элементов и отображение диагностических сообщений. При отладке в редакторе обозначаются точки останова, текущая позиция выполнения и значения доступных переменных.

2 Открытие и организация рабочего пространства

Для открытия редактора необходимо выбрать программный узел в структуре проекта и воспользоваться кнопкой открытия редактора в строке свойства, содержащего исходный текст. В зависимости от типа узла это свойство может иметь наименование «Текст» или «Текст программы». Редактор также открывается при переходе к определению программного элемента или к позиции, указанной в диагностическом сообщении.

Текст программного узла отображается на отдельной вкладке рабочей области. Для нескольких узлов допускается одновременное открытие отдельных вкладок. Повторное обращение к уже открытому узлу активирует соответствующую вкладку.

Для текстов отдельных действий предусмотрено редактирование непосредственно в панели свойств. Набор команд в таком представлении определяется типом редактируемого элемента.

Элемент редактора	Назначение
Область исходного текста	Ввод, выделение и изменение текста программы.
Номера строк	Ориентация в тексте и определение положения диагностических сообщений.
Поле отметок рядом с номерами строк	Отображение и переключение точек останова в редакторах, используемых для отладки.
Средства сворачивания	Временное скрытие и раскрытие распознанных участков текста без изменения их содержимого.
Панель команд	Сохранение текста, запуск проверки и, для поддерживаемых узлов, локальной отладки.
Область определения и аргументов	Настройка объявления функции или другого программного элемента, если такая настройка предусмотрена для выбранного узла.

Состав панели команд и дополнительных областей зависит от типа узла. В редакторе функции область определения и таблица аргументов раскрываются кнопкой «Показать/скрыть настройки аргументов».

3 Ввод и редактирование текста

Редактор поддерживает ввод с клавиатуры, выделение фрагментов, копирование, вырезание, вставку, удаление, отмену и повтор изменений. Операции выполняются над текущим выделением либо в позиции текстового курсора.

При вводе кода используются отступы и автоматическое дополнение парных скобок и кавычек. Подсветка выделяет ключевые слова, имена, числовые и строковые значения, комментарии и другие элементы текста. Оформление определяется выбранным языком и настройками редактора.

Для изменения уровня отступа выделенного фрагмента применяются Tab и Shift+Tab. Команды комментирования позволяют временно исключить выделенные строки или фрагмент из выполнения; обозначение комментария определяется языком исходного текста.

Для одновременного изменения нескольких участков предусмотрена работа с несколькими курсорами. Дополнительная позиция ввода устанавливается сочетанием Alt + щелчок мышью. Последующий ввод применяется ко всем установленным позициям; выход из режима выполняется клавишей Esc.

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

3.1 Объявления программных элементов

Для ряда узлов начальная строка объявления согласуется с именем, типом результата, аргументами и другими свойствами узла. При изменении этих параметров соответствующее объявление обновляется в редакторе. Ручное изменение автоматически формируемой строки может быть заменено значением, определённым свойствами узла.

Для изменения имени, типа результата или состава аргументов следует использовать область «Определение», таблицу аргументов либо соответствующие свойства выбранного узла. Доступность этих средств определяется типом программного элемента. Например, для программы состав дополнительных полей отличается от состава полей функции.

3.2 Режим чтения

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

4 Поиск, замена и перемещение по тексту

Поиск в текущем тексте вызывается сочетанием Ctrl+F. В поле поиска вводится искомая строка; найденные совпадения выделяются в редакторе. Переход к следующему и предыдущему совпадениям выполняется кнопками панели поиска либо клавишами F3 и Shift+F3.

Для замены используется Ctrl+H. Необходимо задать искомый текст и текст замены, проверить область поиска, после чего выполнить замену текущего совпадения или всех найденных совпадений. Перед массовой заменой следует проверить параметры учёта регистра, поиска целого слова и использования регулярных выражений.

Регулярное выражение задаёт правило сопоставления текста. Этот режим применяется при поиске фрагментов, имеющих общую структуру; специальные символы в таком запросе интерпретируются в соответствии с правилами регулярных выражений.

Сочетание Ctrl+G открывает переход к строке. После ввода номера строки и подтверждения курсор перемещается в указанную позицию. Нумерация строк начинается с единицы.

Поиск и замена, вызываемые в редакторе, относятся к открытому тексту. Для просмотра другого программного узла используется соответствующая вкладка или переход к его определению.

5 Подсказки и переход к определению

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

Средство	Порядок использования и результат
Автодополнение	При вводе имени отображается список подходящих элементов. Список также вызывается сочетанием Ctrl+Пробел. Выбор выполняется клавишами перемещения, подтверждение — Enter или Tab, закрытие списка — Esc.
Всплывающая подсказка	При наведении указателя на программный элемент отображаются доступные сведения о его объявлении, типе или назначении.
Подсказка сигнатуры	При вводе вызова отображаются сведения о параметрах функции. Явный вызов подсказки выполняется сочетанием Ctrl+Shift+Пробел.
Встроенные подсказки	Дополнительные сведения отображаются непосредственно рядом с соответствующими участками кода. Эти обозначения не входят в исходный текст.
Переход к определению	После установки курсора на имя и нажатия F2 открывается доступное определение соответствующего элемента. Для перехода также используется Ctrl + щелчок мышью по имени.

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

5.1 Шаблоны языка ST

Для языка ST предусмотрены шаблоны типовых конструкций. В частности, доступны префиксы st if, st case, st for, st while, st repeat, st var и другие варианты объявлений и операторов.

Для вставки шаблона необходимо:

1. Установить курсор в допустимую позицию исходного текста ST.
2. Ввести префикс, например st if, и выбрать соответствующее предложение в списке дополнений. При необходимости вызвать список сочетанием Ctrl+Пробел.
3. Подтвердить вставку и заменить выделенные поля собственными значениями. Для перемещения между полями используются Tab и Shift+Tab.
4. Завершить заполнение шаблона и проверить полученный текст.

Шаблон задаёт заготовку конструкции. Имена переменных, условия, типы и выражения должны соответствовать объявлениям и назначению конкретной программы.

6 Диагностика и проверка текста

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

Команда «Компиляция» на панели редактора сохраняет текущие изменения программного узла и запускает проверку. Диагностические сообщения доступны в окне «Ошибки»; переход по сообщению открывает соответствующее место исходного текста. В отдельных формах редактирования команда проверки имеет наименование «Компилировать».

Для подготовки конфигурации проекта используется команда «Проект → Сохранить конфигурацию», по умолчанию вызываемая сочетанием Ctrl+B. После проверки необходимо проанализировать сообщения и устранить обнаруженные ошибки. Отсутствие отметок в процессе ввода не заменяет проверку проекта перед запуском.

Подсказки типов и параметров, диагностические отметки и отладочные обозначения служат представлению сведений о программе. Они не включаются в сохраняемый исходный текст.

7 Сохранение изменений

В редакторах программных узлов кнопка «Сохранить» передаёт введённый текст и изменённые параметры в соответствующий узел открытого проекта. Для этой команды предусмотрено сочетание Ctrl+S. При отсутствии изменений кнопка сохранения недоступна.

Для записи проекта на диск используется команда «Файл → Сохранить проект» с сочетанием Ctrl+Shift+S. При сохранении проекта учитываются изменения в открытых редакторах программных узлов. Для первой записи проекта требуется указать место сохранения.

При закрытии вкладки с несохранёнными изменениями выводится запрос «Сохранить изменения в скрипте?»:

• «Сохранить» — принять изменения и закрыть редактор;
• «Нет» — закрыть редактор без принятия внесённых в нём изменений;
• «Отмена» — сохранить вкладку открытой и продолжить работу.

При редактировании текста действия непосредственно в панели свойств изменения относятся к свойству выбранного элемента. Для сохранения результата на диске необходимо сохранить проект.

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

8 Средства отладки в редакторе

Для установки или снятия точки останова используется F9, щелчок по полю отметок или номерам строк, а также команда контекстного меню «Добавить/убрать точку останова». Точка относится к строке исходного текста; её фактическое положение уточняется при подготовке отладочного запуска.

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

Если включён показ значений переменных, они отображаются рядом с именами либо в конце строки. Для поддерживаемых составных значений щелчок по обозначению открывает подробный просмотр. Отображаемые данные относятся к текущей остановке; после продолжения выполнения они очищаются или обновляются при следующей остановке.

В редакторах поддерживаемых функций предусмотрена команда «Начать локальную отладку». Перед запуском сохраняются текущие изменения; при наличии входных аргументов задаются их значения. Порядок локальной и удалённой отладки приведён в разделе «Отладка проекта».

9 Настройка редактора

Настройки открываются командой «Параметры → Настройки». В разделе «Текстовый редактор» задаются следующие параметры:

Группа параметров	Назначение
«Шрифт»	Выбор гарнитуры и размера символов.
«Размер табуляции»	Настройка ширины отступа при отображении и вводе текста.
«Тема текстового редактора»	Выбор цветового оформления. Переключение светлого и тёмного оформления также доступно в контекстном меню редактора.
«Показывать значения переменных в тексте при отладке»	Включение или отключение отладочных значений непосредственно в исходном тексте.
«Расположение значений переменных»	Выбор представления: «Рамками после имён» или «В конце строки».
«Языковой сервер»	Общее включение интеллектуальных средств редактирования и выбор отдельных функций: диагностики, автодополнений, всплывающих и встроенных подсказок, подсказок сигнатур и подсветки синтаксиса.

В разделе «Горячие клавиши» изменяются сочетания для предусмотренных настраиваемых команд редактора, в том числе перехода к определению и переключения точки останова. Для назначения сочетания необходимо выбрать ячейку в столбце «Клавиша» и ввести требуемое сочетание с клавиатуры. Команды редактора следует вызывать при установленном в нём фокусе ввода.

10 Основные сочетания клавиш

В таблице приведены сочетания по умолчанию. Для настраиваемых команд следует учитывать назначения, установленные пользователем.

Действие	Сочетание
Выделить весь текст	Ctrl+A
Копировать выделение	Ctrl+C
Вырезать выделение	Ctrl+X
Вставить содержимое буфера обмена	Ctrl+V
Отменить последнее изменение	Ctrl+Z
Повторить отменённое изменение	Ctrl+Y
Поиск в текущем тексте	Ctrl+F
Замена в текущем тексте	Ctrl+H
Следующее / предыдущее совпадение	F3 / Shift+F3
Перейти к строке	Ctrl+G
Вызвать список дополнений	Ctrl+Пробел
Вызвать подсказку параметров	Ctrl+Shift+Пробел
Перейти к определению	F2
Установить / снять точку останова	F9
Увеличить / уменьшить отступ	Tab / Shift+Tab
Сохранить изменения программного узла	Ctrl+S
Сохранить проект на диске	Ctrl+Shift+S
Подготовить конфигурацию проекта	Ctrl+B

11 Рекомендуемая последовательность работы

1. Открыть текст требуемого программного узла и проверить выбранный язык.
2. При необходимости задать имя, тип результата, аргументы и другие параметры объявления доступными для узла средствами.
3. Ввести или изменить исходный текст, используя подсказки и шаблоны соответствующего языка.
4. Проверить внесённые изменения; при массовых правках воспользоваться поиском и заменой.
5. Сохранить текст и выполнить проверку командой редактора. Проанализировать сообщения в окне «Ошибки» и устранить обнаруженные нарушения.
6. Сохранить проект на диске и подготовить конфигурацию проекта для требуемого способа запуска.
7. При необходимости выполнить отладочный запуск и проверить значения переменных и последовательность выполнения программы.