# Расширение функциональных возможностей &katepart;

## Введение

Как и любой другой улучшенный компонент редактирования, &katepart; предоставляет разнообразные возможности расширения своей функциональности Возможно создавать простые сценарии, которые реализуют дополнительные возможности, с помощью &javascript;. Расширив возможности &katepart;, присоединяйтесь к нам и делитесь созданными инструментами с пользователями по всему миру!

## Подсветка синтаксиса

### Обзор

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

Функция на языке C++, показанная с подсветкой синтаксиса.

Функция на языке C++, показанная с подсветкой синтаксиса.

Та же самая функция на языке C++, показанная без подсветки синтаксиса.

Та же самая функция на языке C++, показанная без подсветки синтаксиса.

Очевидно, что вариант с подсветкой является более удобочитаемым.

&kappname; содержит гибкую настраиваемую систему, которая позволяет выполнять подсветку синтаксиса. В стандартный дистрибутив входят определения для широкого диапазона языков программирования, написания сценариев и разметки, а также для других форматов текстовых файлов. Кроме того, поддерживается добавление пользовательских определений в простых файлах &XML;.

&kappname; автоматически определяет корректные правила синтаксиса при открытии файла пользователем, основываясь на типе &MIME; этого файла (тип определяется по расширению файла, а если таковое отсутствует — по его содержимому). Если в результате автоматического определения выбраны не те правила синтаксиса, возможно указать их вручную с помощью меню: Сервис Подсветка.

Стили и цвета, которые используются в определениях подсветки синтаксиса, возможно настроить на вкладке Для отдельных форматов диалога настройки, а типы &MIME; и расширения файлов, для которых следует использовать эти определения, — на вкладке Типы файлов.

Подсветка синтаксиса позволяет повысить удобочитаемость корректного текста, но не позволяет обеспечить саму корректность текста. Синтаксическая разметка текста является непростой задачей, сложность которой зависит от формата текста. В некоторых случаях авторы правил синтаксиса считают успешным результатом корректную обработку 98 процентов текста (обычно проблемные 2 процента остаются в случае выбора редкого стиля).

### Система подсветки синтаксиса &kappname;

В этом разделе приводится более подробное описание механизма подсветки синтаксиса, который используется в &kappname;. Рекомендуется ознакомиться с этой информацией перед изменением или созданием определений синтаксиса.

#### Принцип работы подсветки синтаксиса

При открытии файла одним из первых действий, которые выполняет редактор &kappname;, является определение правил подсветки синтаксиса для этого файла. Во время чтения текста из файла или получения введенных пользователем строк система подсветки синтаксиса анализирует текст на основе правил подсветки синтаксиса и обозначает в показанном тексте позиции начала и завершения различных контекстов и стилей.

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

Определения синтаксиса, используемые системой подсветки синтаксиса &kappname;, представляют собой файлы &XML;, которые содержат

- Правила определения роли текста, объединённые в контекстные блоки

- Списки ключевых слов

- Определения элементов стиля

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

#### Правила

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

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

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

#### Контекстные стили и ключевые слова

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

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

Во многих форматах существуют списки слов, которые соответствуют определённому элементу. Например, в языках программирования операторы управления составляют один элемент, названия типов данных — другой, встроенные функции языка — третий. Система подсветки синтаксиса &kappname; поддерживает использование таких списков для выявления и обозначения слов в тексте с целью смыслового подчёркивания назначения элементов в текстовых форматах.

#### Стили по умолчанию

Если открыть в &kappname; файл исходного кода на языке C++, &Java; или документ &HTML;, для синтаксической разметки будут использоваться одни и те же цвета (несмотря на то, что разные форматы файлов обуславливают выбор разных слов для обозначения элементов текста). Это происходит, потому что в &kappname; используется предустановленный список стилей по умолчанию, которые применяются отдельными определениями синтаксиса.

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

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

### Формат &XML; определения подсветки

#### Обзор

В &kappname; используется библиотека подсветки синтаксических конструкций из &kde-frameworks;. По умолчанию в неё включены средства подсветки кода &XML;.

Этот раздел посвящён обзору формата &XML; определения подсветки. С помощью небольшого примера в разделе описаны основные компоненты, их назначение и использование. В следующем разделе подробно рассматриваются правила определения способа подсветки.

Формальное определение (XSD) доступно в репозитории подсветки синтаксиса, в файле `language.xsd`

Пользовательские файлы `.xml` подсветки синтаксиса расположены в каталоге `org.kde.syntax-highlighting/syntax/` в папке пользователя (расположение возможно определить с помощью команды ``qtpaths``--paths GenericDataLocation``, обычно это ``$HOME`/.local/share/` и `/usr/share/`).

В случае пакетов Flatpak и Snap место хранения данных зависит от приложения. В приложении Flatpak это обычно ``$HOME`/.var/app/`package-name`/data/`, а в приложении Snap — ``$HOME`/snap/`package-name`/current/.local/share/`. Например, для пакета Flatpak &kate; пользовательские файлы &XML; расположены в каталоге ``$HOME`/.var/app/org.kde.kate/data/org.kde.syntax-highlighting/syntax/`, а для пакета Snap &kate; — в каталоге ``$HOME`/snap/kate/current/.local/share/org.kde.syntax-highlighting/syntax/`.

В &Windows; эти файлы хранятся в `%USERPROFILE%\AppData\Local\org.kde.syntax-highlighting\syntax`. `%USERPROFILE%` обычно имеет значение `C:\Users\`пользователь``.

Если для одного языка имеется несколько файлов, будет загружен файл с наибольшим значением атрибута `version` в элементе `language`.

#### Основные разделы файлов определения синтаксиса &kappname;

Файл подсветки содержит заголовок, в котором задаётся версия &XML;:

-     <?xml version="1.0" encoding="UTF-8"?>

Корневым элементом файла определения является элемент `language`. Доступные атрибуты:

- Обязательные атрибуты:

  `name` задаёт название языка, которое затем будет отображаться в меню и диалоговых окнах.

  `section` определяет категорию.

  `extensions` определяет суффиксы названий файлов, например "*.cpp;*.h".

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

  `kateversion` задаёт последнюю поддерживаемую версию &kappname;.

  Необязательные атрибуты:

  `mimetype` выполняет привязку файлов на основе типа &MIME;.

  `casesensitive` определяет, чувствительны ли ключевые слова к регистру.

  `priority` требуется, если в другом файле определения подсветки используются те же суффиксы файлов. Для подсветки будут использованы правила с более высоким приоритетом.

  `author` содержит имя автора и его адрес электронной почты.

  `license` содержит название лицензии нового файла подсветки синтаксиса, обычно это MIT.

  `style` содержит данные о языке программирования и используется средствами расстановки отступов для атрибута `required-syntax-style`.

  `indenter` определяет используемое по умолчанию средство расстановки отступов. Доступные варианты: ada, normal, cstyle, cmake, haskell, latex, lilypond, lisp, lua, pascal, python, replicode, ruby и xml.

  `hidden` определяет, следует ли отображать название подсветки в меню &kappname;.

  Поэтому следующая строка может выглядеть так:

      <language name="C++" version="1" kateversion="2.4" section="Sources" extensions="*.cpp;*.h" />

Следующим элементом является `highlighting`. В этом элементе содержится необязательный элемент `list` и обязательные элементы `contexts` и `itemDatas`.

- Элементы `list` содержат список ключевых слов. В этом случае ключевыми словами являются class и const. Возможно добавить неограниченное количество списков.

  Начиная с &kde-frameworks; 5.53, в список возможно включать ключевые слова из другого списка, языка или файла с помощью элемента `include`. Для разделения названия списка и названия определения языка следует использовать символы `##` таким же образом, что и в правиле `IncludeRules`. Это позволяет предотвратить дублирование списков ключевых слов, когда требуется включить ключевые слова из другого языка или файла. Например, список othername содержит ключевое слово str и все ключевые слова из списка types, который относится к языку программирования ISO C++.

  В элементе `contexts` содержатся все контексты. По умолчанию первым контекстом является начало диапазона подсветки. В контексте Normal Text существуют два правила: одно сопоставляет список ключевых слов с названием somename, другое определяет кавычки и переключает контекст на контекст string. Дополнительные сведения о правилах приводятся в следующей главе.

  Третья часть состоит из элемента `itemDatas`. В этом элементе содержатся все цвета и гарнитуры шрифтов, необходимые для контекстов и правил. В примере использовано `itemData` Normal Text, String и Keyword.

      <highlighting>
          <list name="somename">
            <item>class</item>
            <item>const</item>
          </list>
          <list name="othername">
            <item>str</item>
            <include>types##ISO C++</include>
          </list>
          <contexts>
            <context attribute="Normal Text" lineEndContext="#pop" name="Normal Text" >
              <keyword attribute="Keyword" context="#stay" String="somename" />
              <keyword attribute="Keyword" context="#stay" String="othername" />
              <DetectChar attribute="String" context="string" char="&quot;" />
            </context>
            <context attribute="String" lineEndContext="#stay" name="string" >
              <DetectChar attribute="String" context="#pop" char="&quot;" />
            </context>
          </contexts>
          <itemDatas>
            <itemData name="Normal Text" defStyleNum="dsNormal" />
            <itemData name="Keyword" defStyleNum="dsKeyword" />
            <itemData name="String" defStyleNum="dsString" />
          </itemDatas>
        </highlighting>

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

- В разделе `comment` определяется последовательность символов, с помощью которой возможно добавить однострочный комментарий. Также возможно определить многострочный комментарий с помощью элемента multiLine с дополнительным атрибутом end. Эти определения будут использованы при выполнении пользователем действий закомментировать/раскомментировать.

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

  В других разделах, `folding`, `emptyLines` и `spellchecking`, как правило, необходимости нет. Сведения об этих разделах приводятся далее.

      <general>
          <comments>
            <comment name="singleLine" start="#"/>
            <comment name="multiLine" start="###" end="###" region="CommentFolding"/>
          </comments>
          <keywords casesensitive="1"/>
          <folding indentationsensitive="0"/>
          <emptyLines>
            <emptyLine regexpr="\s+"/>
            <emptyLine regexpr="\s*#.*"/>
          </emptyLines>
          <spellchecking>
            <encoding char="á" string="\'a"/>
            <encoding char="à" string="\`a"/>
          </spellchecking>
        </general>
      </language>

#### Подробные сведения о разделах

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

Элемент `context` относится к группе `contexts`. Этот элемент определяет связанные с контекстом правила (например, что должно произойти, если система подсветки достигнет конца строки). Доступные атрибуты:

- `name` — название контекста. С помощью этого названия правила будут определять контекст, на который следует переключиться в случае выявления соответствия правила.

  `lineEndContext` определяет контекст, на который переключается система подсветки при достижении конца строки. Значением этого атрибута может быть либо название другого контекста, либо `#stay` для запрета смены контекста (ничего не делать), либо `#pop` для выхода из контекста. Возможно, например, указать `#pop#pop#pop`, чтобы система поднялась на три контекста выше, или даже `#pop#pop!OtherContext`, чтобы система поднялась на два контекста выше и переключилась на контекст с названием `OtherContext`.

  `lineEmptyContext` определяет контекст, который используется при обнаружении пустой строки. Значение по умолчанию: #stay.

  `fallthrough` определяет, следует ли системе подсветки переключаться на контекст, указанный в fallthroughContext, если текст не соответствует ни одному из правил. Значение по умолчанию: false.

  `fallthroughContext` определяет следующий контекст, если текст не соответствует ни одному из правил.

  `noIndentationBasedFolding` отключает сворачивание на основе отступов в контексте. Если сворачивание на основе отступов неактивно, этот атрибут не имеет смысла. Этот атрибут указывается в элементе folding группы general. Значение по умолчанию: false.

Элемент `itemData` находится в группе `itemDatas`. Она определяет гарнитуры шрифтов и цвета. Возможно указывать пользовательские гарнитуры и цвета. Рекомендуется использовать стили по умолчанию, чтобы пользователь всегда видел одинаковые цвета в файлах различных форматов. Но всё же иногда другого способа нет, и придётся изменить атрибуты цветов и шрифтов. Обязательные атрибуты — name и defStyleNum, прочие являются необязательными. Доступные атрибуты:

- `name` задаёт название itemData. Оно будет использоваться в контекстах и правилах для ссылки на itemData в атрибуте attribute.

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

  `color` определяет цвет. Возможные форматы: '#rrggbb' или '#rgb'.

  `selColor` определяет цвет выделенного текста.

  `italic`, если значение true, текст будет выделен курсивом.

  `bold`, если значение true, текст будет выделен полужирным.

  `underline`, если значение true, текст будет подчёркнут.

  `strikeout`, если значение true, текст будет перечёркнут.

  `spellChecking`, если значение true, будет проверено правописание текста.

Элемент `keywords` в группе `general` определяет свойства ключевых слов. Доступные атрибуты:

- `casesensitive` может иметь значение true или false. Если значение true, все ключевые слова сопоставляются с учётом регистра.

  `weakDeliminator` — список символов, которые не являются символами разделения слов. Например, точка `'.'` является символом разделения слов. Допустим, что ключевое слово в `list` содержит точку: это слово будет задействовано, только если точка будет указана среди значений этого аргумента.

  `additionalDeliminator` определяет дополнительные символы разметки.

  `wordWrapDeliminator` определяет символы, после которых возможен перенос строки.

  Стандартные символы разметки и разделения слов: `.():!+,-<=>%&*/;?[]^{|}~\`, пробел (`' '`) и символ табуляции (`'\t'`).

Элемент `comment` в группе `comments` определяет свойства комментариев, которые будут использованы для действий в пунктах меню Сервис Закомментировать, Сервис Раскомментировать и Сервис Закомментировать или раскомментировать. Доступные атрибуты:

- `name` может иметь иметь значение singleLine или multiLine. Если выбрано значение multiLine, необходимо также указать атрибуты end и region. Если выбрано значение singleLine, возможно добавить необязательный атрибут position.

  `start` определяет строку, которая используется для обозначения начала комментария. В C++ этой строкой для многострочных комментариев является "/*". Этот атрибут является обязательным для типов multiLine и singleLine.

  `end` определяет строку, которой завершается комментарий. В C++ этой строкой будет "*/". Этот атрибут доступен только для комментариев типа multiLine и является обязательным для них.

  Атрибут `region` должен иметь значение названия пригодного для сворачивания многострочного комментария. Например, если в правилах указано beginRegion="Comment" ... endRegion="Comment", следует использовать значение region="Comment". Это позволяет применять действие раскомментирования, даже если был выделен не весь текст многострочного комментария. Нужно только, чтобы курсор находился внутри этого многострочного комментария. Этот атрибут доступен только для типа multiLine.

  `position` определяет место вставки однострочного комментария. По умолчанию однострочный комментарий будет вставлен в начале строки в нулевой позиции. Но если использовать запись position="afterwhitespace", комментарий будет вставлен справа после первого пробельного блока, перед первым непробельным символом. Эта возможность полезна для языков, где важны отступы в строках, таких как Python и YAML. Этот атрибут является необязательным, его единственное возможное значение — это afterwhitespace. Он доступен только для типа singleLine.

Элемент `folding` в группе `general` определяет свойства сворачивания кода. Доступны атрибуты:

- `indentationsensitive`, если значение true, отметки сворачивания кода будут добавлены на основе отступов, как в языке сценариев Python. Обычно не требуется указывать этот атрибут, так как его значением по умолчанию является false.

Элемент `emptyLine` в группе `emptyLines` определяет, какие из строк следует считать пустыми. Это позволяет изменить поведение атрибута lineEmptyContext в элементах `context`. Доступные атрибуты:

- `regexpr` определяет регулярное выражение, соответствие которому будет считаться пустой строкой. По умолчанию пустые строки не содержат никаких символов, поэтому это регулярное выражение добавляет «пустые» строки, например, если следует считать строки из пробелов пустыми. Впрочем, для большинства определений синтаксиса в этом атрибуте нет необходимости.

Элемент `encoding` в группе `spellchecking` определяет кодировку символов, которая используется для проверки орфографии. Доступные атрибуты:

- `char` — кодированный символ.

  `string` — последовательность символов, которая будет закодирована как символ char при проверке правописания. Например, если выполняется обработка кода на языке LaTeX, строка `\"{A}` соответствует символу `Ä`.

#### Доступные стили по умолчанию

Как следует из ранее приведённого краткого описания: стили по умолчанию — это предустановленные стили шрифтов и цветов.

Общие стили по умолчанию:

- `dsNormal`, если не требуется особая подсветка.

  `dsKeyword`, встроенные ключевые слова языка.

  `dsFunction`, вызовы и определения функций.

  `dsVariable`, если применимо: названия переменных (например, $someVar в PHP/Perl).

  `dsControlFlow`, ключевые слова управления обработкой, включая if, else, switch, break, return, yield, ...

  `dsOperator`, операторы, например + - * / :: < >

  `dsBuiltIn`, встроенные функции, классы и объекты.

  `dsExtension`, общие расширения, например классы &Qt; и функции и макросы в C++ и Python.

  `dsPreprocessor`, инструкции препроцессора или определения макросов.

  `dsAttribute`, аннотации, например @override и __declspec(...).

Стили по умолчанию, связанные со строками:

- `dsChar`, отдельные символы, например 'x'.

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

  `dsString`, строки, например "hello world".

  `dsVerbatimString`, буквальные или необработанные строки, например 'raw \backlash' в Perl, CoffeeScript и командных оболочках, а также r'\raw' в Python.

  `dsSpecialString`, SQL, регулярные выражения, документация HERE, математический режим &latex;, ...

  `dsImport`, импорт, включение или потребность в модулях.

Стили по умолчанию, связанные с числами:

- `dsDataType`, встроенные типы данных, например int, void, u64.

  `dsDecVal`, десятичные значения.

  `dsBaseN`, значения с основой, отличной от 10.

  `dsFloat`, значения с плавающей точкой.

  `dsConstant`, встроенные и заданные пользователем константы, например PI.

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

- `dsComment`, комментарии.

  `dsDocumentation`, /** Комментарии в документах */ или """docstrings""".

  `dsAnnotation`, команды документации, например @param, @brief.

  `dsCommentVar`, названия переменных, используемых в приведённых выше командах, например "foobar" в @param foobar.

  `dsRegionMarker`, отметки области, например //BEGIN, //END в комментариях.

Прочие стили по умолчанию:

- `dsInformation`, примечания и подсказки, например @note в doxygen.

  `dsWarning`, предупреждения, например @warning в doxygen.

  `dsAlert`, специальные слова, например TODO, FIXME, XXXX.

  `dsError`, подсветка ошибок и синтаксических неточностей.

  `dsOthers`, если не подходит иное.

### Правила определения способа подсветки

В этом разделе приводится описание правил определения синтаксиса.

Каждое из правил может соответствовать нулевому или большему количеству символов в начале строки, которая проверяется на соответствие. Если такое соответствие будет найдено, найденным символам будет назначен стиль или attribute, указанный с помощью правила, также правило позволяет направить системе запрос на изменение текущего контекста.

Правило выглядит следующим образом:

    <RuleName attribute="(идентификатор)" context="(идентификатор)" [специфичные для правила атрибуты] />

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

context возможно определить с помощью:

- идентификатора, который является названием другого контекста.

- Значения порядка, которое сообщает движку, что следует остаться в текущем контексте (`#stay`) или вернуться к предыдущему контексту, использованному в строке (`#pop`).

  Чтобы вернуться на несколько уровней контекста назад, ключевое слово #pop возможно повторить несколько раз: `#pop#pop#pop`

- Значения порядка, за которым следуют восклицательный знак (!) и значение идентификатора, что заставит движок сначала использовать порядок, а затем переключиться на другой контекст, например `#pop#pop!OtherContext`.

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

### Общие атрибуты

Следующие атрибуты являются общими для всех правил, их возможно указывать везде, где в списке имеется надпись `(общие атрибуты)`. Атрибуты attribute и context являются обязательными, все остальные атрибуты являются необязательными.

- attribute: атрибут, указывающий на заданный itemData.

- context: определяет контекст, на который следует переключить систему подсветки в случае выявления соответствия правила.

- beginRegion: начать блок сворачивания кода. Значение по умолчанию: unset.

- endRegion: закрыть блок сворачивания кода. Значение по умолчанию: unset.

- lookAhead: если значение true, система подсветки не обрабатывает длину соответствия. Значение по умолчанию: false.

- firstNonSpace: соответствие устанавливается, только если строка является первой отличной от пробелов последовательностью символов в строке текста. Значение по умолчанию: false.

- column: соответствие устанавливается, если будет совпадать строка. Значение по умолчанию: unset.

### Динамические правила

Некоторые из правил позволяют устанавливать необязательный атрибут `dynamic`. Это атрибут логического типа, его значение по умолчанию: false. Если атрибут dynamic имеет значение true, в правиле возможно использовать заполнители, которые обозначают текст, найденный с помощью правила регулярного выражения. Текст будет переключён в текущий контекст в его атрибутах `string` или `char`. В атрибуте `string` заполнитель `%N` (где N — это число) будет заменён соответствующим захваченным элементом `N` из вызывающего регулярного выражения, начиная с 1. В атрибуте `char` заполнитель должен быть числом `N`, он будет заменён на первый символ соответствующего захваченного элемента `N` из вызывающего регулярного выражения. Все правила, разрешающие использование этого атрибута, обозначены надписью (dynamic).

- dynamic: может иметь значение (true|false).

Как это работает:

В регулярных выражениях правил `RegExpr` средство обработки захватывает и запоминает весь текст в простых круглых скобках `(ШАБЛОН)`. Захваченные фрагменты текста можно использовать в контексте, на который переключается средство, в правилах с атрибутом `dynamic` true для замены `%N` (в String) или `N` (в char).

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

- Если захваченные фрагменты текста не будет использоваться ни динамическими правилами, ни в том же регулярном выражении, следует использовать `группы без захвата`: `(?:ШАБЛОН)`

  Захват групп с поиском вперёд или поиском назад, например `(?=ШАБЛОН)`, `(?!ШАБЛОН)` или `(?<=ШАБЛОН)`, не выполняется. Дополнительные сведения доступны в разделе Регулярные выражения.

- Группы с захватом возможно использовать внутри того же регулярного выражения, если указать `\N` вместо `%N`. Дополнительные сведения: Захват совпавшего текста (обратные ссылки) в разделе Регулярные выражения.

Пример 1:

В этом простом примере обработчик захватывает текст, соответствующий регулярному выражению `=*`, и вставляет его вместо `%1` в динамическом правиле. Это позволяет определить комментарий, который завершается тем же количеством символов `=`, что и начинается. Соответствующим текстом будет: `[[ комментарий ]]`, `[=[ комментарий ]=]` или `[=====[ комментарий ]=====]`.

Кроме того, захваченные данные доступны только в переключённом контексте Multi-line Comment.

    <context name="Normal" attribute="Normal Text" lineEndContext="#stay">
      <RegExpr context="Multi-line Comment" attribute="Comment" String="\[(=*)\[" beginRegion="RegionComment"/>
    </context>
    <context name="Multi-line Comment" attribute="Comment" lineEndContext="#stay">
      <StringDetect context="#pop" attribute="Comment" String="]%1]" dynamic="true" endRegion="RegionComment"/>
    </context>

Пример 2:

В динамическом правиле `%1` соответствует захваченному фрагменту текста, который соответствует шаблону `#+`, а `%2` — шаблону `&quot;+`. Следовательно, соответствующий фрагмент текста будет таким: `#метка""""в контексте""""#`.

Захваченными данным нельзя будет воспользоваться в других контекстах, таких как OtherContext, FindEscapes или SomeContext.

    <context name="SomeContext" attribute="Normal Text" lineEndContext="#stay">
      <RegExpr context="#pop!NamedString" attribute="String" String="(#+)(?:[\w-]|[^[:ascii:]])(&quot;+)"/>
    </context>
    <context name="NamedString" attribute="String" lineEndContext="#stay">
      <RegExpr context="#pop!OtherContext" attribute="String" String="%2(?:%1)?" dynamic="true"/>
      <DetectChar context="FindEscapes" attribute="Escape" char="\"/>
    </context>

Пример 3:

Эта запись соответствует такому тексту: `Class::function<T>( ... )`.

    <context name="Normal" attribute="Normal Text" lineEndContext="#stay">
      <RegExpr context="FunctionName" lookAhead="true"
                  String="\b([a-zA-Z_][\w-]*)(::)([a-zA-Z_][\w-]*)(?:&lt;[\w\-\s]*&gt;)?(\()"/>
    </context>
    <context name="FunctionName" attribute="Normal Text" lineEndContext="#pop">
      <StringDetect context="#stay" attribute="Class" String="%1" dynamic="true"/>
      <StringDetect context="#stay" attribute="Operator" String="%2" dynamic="true"/>
      <StringDetect context="#stay" attribute="Function" String="%3" dynamic="true"/>
      <DetectChar context="#pop" attribute="Normal Text" char="4" dynamic="true"/>
    </context>

#### Подробные сведения о правилах

DetectChar

- Проверка на соответствие одному определённому символу. Обычно используется для поиска конца строк, взятых в кавычки.

      <DetectChar char="(символ)" (общие атрибуты) (dynamic) />

  Атрибут `char` определяет символ, с которым будет происходить сравнение.

Detect2Chars

- Проверка на соответствие двум определённым символам в заданном порядке.

      <Detect2Chars char="(символ)" char1="(символ)" (общие атрибуты) />

  Атрибут `char` определяет первый символ, с которым будет происходить сравнение, `char1` — второй.

AnyChar

- Проверка на соответствие одному символу из набора указанных символов.

      <AnyChar String="(строка)" (общие атрибуты) />

  Атрибут `String` определяет набор символов.

StringDetect

- Проверка на соответствие указанной строке.

      <StringDetect String="(строка)" [insensitive="true|false"] (общие атрибуты) (dynamic) />

  Атрибут `String` определяет строку, с которой будет происходить сравнение. Атрибут `insensitive` по умолчанию имеет значение false, этот атрибут передаётся функции сравнения строк. Если он имеет значение true, сравнение выполняется без учёта регистра.

WordDetect

- Проверка на соответствие указанной строке, но с дополнительным требованием относительно границ слов, в частности, точки `'.'` или пробела в начале и конце слова. Обработка `\b<string>\b` выполняется подобно обработке регулярного выражения, но быстрее, чем обработка правила `RegExpr`.

      <WordDetect String="(строка)" [insensitive="true|false"] (общие атрибуты) />

  Атрибут `String` определяет строку, с которой будет происходить сравнение. Атрибут `insensitive` по умолчанию имеет значение false, этот атрибут передаётся функции сравнения строк. Если он имеет значение true, сравнение выполняется без учёта регистра.

  Начиная с &kate; 3.5 (&kde; 4.5)

RegExpr

- Проверка на совпадение с регулярным выражением.

      <RegExpr String="(строка)" [insensitive="true|false"] [minimal="true|false"] (общие атрибуты) (dynamic) />

  Атрибут `String` определяет регулярное выражение.

  `insensitive` по умолчанию имеет значение false, этот атрибут передаётся движку поиска по регулярным выражениям.

  `minimal` по умолчанию имеет значение false, этот атрибут передаётся движку поиска по регулярным выражениям.

  Поскольку поиск соответствий для применения правила всегда происходит в начале текущей строки, регулярное выражение, начинающееся с символа каретки (`^`), указывает на то, что поиск соответствия правилу следует выполнять только в начале строки.

  Подробные сведения доступны в разделе Регулярные выражения.

keyword

- Проверка на соответствие ключевому слову из указанного списка.

      <keyword String="(название списка)" (общие атрибуты) />

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

  Система подсветки обрабатывает правила ключевых слов оптимизированным способом. Поэтому совершенно необходимо, чтобы все ключевые слова, которые следует найти, были ограничены заданными разделителями, заранее предусмотренными (разделителями по умолчанию) или явно указанными в свойстве additionalDeliminator тега keywords.

  Если ключевое слово, которое следует найти, должно содержать символ разделителя, соответствующий символ следует добавить в свойство weakDeliminator тега keywords. После этого символ утратит своё свойство разделителя во всех правилах keyword.

Int

- Проверка на соответствие целому числу (регулярное выражение: `\b[0-9]+`).

      <Int (общие атрибуты) />

  У этого правила нет специфичных атрибутов.

Float

- Проверка на соответствие числу с плавающей точкой (регулярное выражение: `(\b[0-9]+\.[0-9]*|\.[0-9]+)([eE][-+]?[0-9]+)?`).

      <Float (общие атрибуты) />

  У этого правила нет специфичных атрибутов.

HlCOct

- Проверка на соответствие восьмеричному преставлению числа (регулярное выражение: `\b0[0-7]+`).

      <HlCOct (общие атрибуты) />

  У этого правила нет специфичных атрибутов.

HlCHex

- Проверка на соответствие шестнадцатеричному представлению числа (регулярное выражение: `\b0[xX][0-9a-fA-F]+`).

      <HlCHex (общие атрибуты) />

  У этого правила нет специфичных атрибутов.

HlCStringChar

- Проверка на соответствие символу управляющей последовательности.

      <HlCStringChar (общие атрибуты) />

  У этого правила нет специфичных атрибутов.

  Проверка на соответствие символам, которые часто используются в коде программ, например `\n` (переход на новую строку) или `\t` (табуляция).

  Поиск будет выполняться по перечисленным далее символам, если эти символы расположены сразу после обратной косой черты (`\`): `abefnrtv"'?\`. Кроме того, соответствующими считаются экранированные шестнадцатеричные числа, например `\xff`, и экранированные восьмеричные числа, например `\033`.

HlCChar

- Проверка на соответствие символу C.

      <HlCChar (общие атрибуты) />

  У этого правила нет специфичных атрибутов.

  Проверка на соответствие символам C, заключённым в одинарные кавычки (пример: `'c'`). Кавычки могут содержать обычный или экранированный символ. Сведения о поиске экранированных последовательностей символов доступны в пункте, посвящённом HlCStringChar.

RangeDetect

- Проверка на соответствие строке с заданными символами начала и конца.

      <RangeDetect char="(символ)"  char1="(символ)" (общие атрибуты) />

  `char` определяет символ начала диапазона, `char1` — символ конца диапазона.

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

LineContinue

- Проверка на соответствие указанному символу в конце строки.

      <LineContinue (общие атрибуты) [char="\"] />

  Необязательный для установления соответствия атрибут `char`, значением по умолчанию является символ обратной косой черты (`'\'`). Введён с &kde; 4.13.

  Это правило позволяет переключить контекст в конце строки. Такая возможность требуется, например, в коде на языке C/C++ для продолжения макросов или строк.

IncludeRules

- Включение правил из другого контекста, языка или файла.

      <IncludeRules context="ссылка на контекст" [includeAttrib="true|false"] />

  Атрибут `context` определяет контекст, который следует включить.

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

      <IncludeRules context="anotherContext" />

  Если строка содержит последовательность символов `##`, система подсветки выполнит поиск контекста в другом определении языка с указанным названием. Например,

      <IncludeRules context="String##C++" />

  позволяет включить контекст String из определения правил подсветки C++.

  Если атрибут `includeAttrib` имеет значение true, атрибут назначения будет изменён на атрибут источника. Это необходимо, например, для выполнения комментирования в том случае, если подсветка соответствующего включённому контексту текста отличается от подсветки из основного контекста.

DetectSpaces

- Поиск пробелов.

      <DetectSpaces (общие атрибуты) />

  У этого правила нет специфичных атрибутов.

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

DetectIdentifier

- Поиск строк идентификаторов (регулярное выражение: `[a-zA-Z_][a-zA-Z0-9_]*`).

      <DetectIdentifier (общие атрибуты) />

  У этого правила нет специфичных атрибутов.

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

#### Советы и рекомендации

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

- Если необходимо определить соответствие только двух символов, используйте `Detect2Chars` вместо `StringDetect`. То же относится и к `DetectChar`.

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

      <RegExpr attribute="Macro" context="macro" String="^\s*#" />

  Тот же результат возможно получить гораздо быстрее:

      <DetectChar attribute="Macro" context="macro" char="#" firstNonSpace="true" />

  Если требуется найти регулярное выражение `'^#'`, возможно опять же использовать `DetectChar` с атрибутом `column="0"`. Отсчёт значения атрибута `column` основан на количестве символов, следовательно, табуляция считается одним символом.

- В правилах `RegExpr` используйте атрибут `column="0"`, если будет использован шаблон `^ШАБЛОН` для установления соответствия текста в начале строки. Это ускорит обработку, так как средству обработки не потребуется выполнять поиск в остальных позициях строки.

- Используйте в регулярных выражениях группы без захвата `(?:ШАБЛОН)` вместо групп с захватом `(ШАБЛОН)`, если захваченные данные не будут использоваться в том же регулярном выражении или в динамических правилах. Это позволяет избежать ненужного хранения этих данных.

- Возможно переключать контексты без обработки символов. Предположим, что требуется переключить контекст при обнаружении строки `*/`, но при этом обработать эту строку в следующем контексте. Приведённое далее правило позволяет найти соответствие, а благодаря атрибуту `lookAhead` средство определения подсветки сохранит найденную строку для обработки в следующем контексте.

      <Detect2Chars attribute="Comment" context="#pop" char="*" char1="/" lookAhead="true" />

- Используйте `DetectSpaces`, если известно, что имеется несколько пробелов.

- Используйте `DetectIdentifier` вместо регулярного выражения `'[a-zA-Z_]\w*'`.

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

- Просмотрите другие файлы &XML;, чтобы узнать, как другие пользователи реализуют сложные правила.

- Корректность каждого файла &XML; возможно проверить с помощью команды `validatehl.sh language.xsd mySyntax.xml`. Файлы `validatehl.sh` и `language.xsd` доступны в репозитории подсветки синтаксиса.

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

      <?xml version="1.0" encoding="UTF-8"?>
      <!DOCTYPE language SYSTEM "language.dtd"
      [
              <!ENTITY myref    "[A-Za-z_:][\w.:_-]*">
      ]>

  После такого определения возможно использовать &myref; вместо регулярного выражения.

## Написание сценариев &javascript;

Функциональность компонента редактирования &kappname; возможно расширить с помощью написания сценариев. Для этого используется язык ECMAScript (широко известен как &javascript;). &kappname; поддерживает два вида сценариев: сценарии расстановки отступов и сценарии командной строки.

### Сценарии расстановки отступов

Сценарии расстановки отступов — также их называют средствами расстановки отступов — выполняют автоматическую расстановку отступов в исходном коде по мере набора текста. Например, после нажатия клавиши Enter программа обычно увеличивает отступ в следующей строке.

В следующих разделах приведены пошаговые инструкции по созданию основы простого средства расстановки отступов. На первом этапе следует создать файл `*.js` с названием, например, `javascript.js` в локальной домашней папке `$`XDG_DATA_HOME`/katepart5/script/indentation`. Здесь переменная среды `XDG_DATA_HOME` обычно имеет значение `~/.local` или `~/.local/share`.

В &Windows; эти файлы расположены в каталоге `%USERPROFILE%\AppData\Local\katepart5\indentation`. `%USERPROFILE%` обычно имеет значение `C:\\Users\\`пользователь``.

#### Заголовок сценария расстановки отступов

Заголовок файла `javascript.js` внедряется как &JSON; в начало документа и имеет следующую форму:

    var katescript = {
        "name": "JavaScript",
        "author": "Example Name <example.name@some.address.org>",
        "license": "BSD License",
        "revision": 1,
        "kate-version": "5.1",
        "required-syntax-style": "javascript",
        "indent-languages": ["javascript"],
        "priority": 0,
    }; // kate-script-header, must be at the start of the file without comments

Далее приводится подробное описание каждой из записей заголовка:

- `name` [обязательная запись]: название средства расстановки отступов, которое будет показано в меню Сервис Расстановка отступов и диалоге настройки.

- `author` [необязательная запись]: имя и контактные данные автора.

- `license` [необязательная запись]: краткая форма условий лицензирования, например BSD или LGPLv3.

- `revision` [обязательная запись]: версия сценария. Не забывайте увеличивать номер версии при каждом внесении изменений в файл.

- `kate-version` [обязательная запись]: минимальное значение версии &kappname;, необходимой для работы сценария.

- `required-syntax-style` [необязательная запись]: нужный стиль синтаксиса, который соответствует указанному значению `style` в файлах определения подсветки синтаксических конструкций. Эта запись важна для средств расстановки отступов, которые работают на основе определённых данных о подсветке в документе. Если указан стиль синтаксиса, средством расстановки отступов будет возможно воспользоваться только в том случае, если будет задействовано соответствующее средство подсветки текста. Это позволяет предотвратить неопределённое поведение, вызванное использованием средства расстановки отступов без необходимой для его работы схемы подсветки. Например, таким образом настроено средство расстановки отступов в файлах `ruby.js` и `ruby.xml`.

- `indent-languages` [необязательная запись]: массив &JSON; стилей синтаксических конструкций, которые может обрабатывать средство расстановки отступов, например: `["c++", "java"]`.

- `priority` [необязательная запись]: если какому-либо файлу с определённой подсветкой соответствуют несколько средств расстановки отступов, значение приоритета определяет, какое средство расстановки отступов будет использоваться по умолчанию.

#### Исходный код средства расстановки отступов

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

    // необходимые библиотеки JS katepart, например range.js, если используется Range
    require ("range.js");

    triggerCharacters = "{}/:;";
    function indent(line, indentWidth, ch)
    {
        // сценарий будет вызываться при обработке каждого символа новой строки (ch == '\n') и всех символов, указанных в
        // глобальной переменной triggerCharacters. При выборе пункта меню СервисВыровнять
        // переменная ch будет иметь пустое значение, то есть ch == ''.
        //
        // смотрите также раздел: «Программный интерфейс (API) работы со сценариями»
        return -2;
    }

В функции `indent()` предусмотрено три параметра:

- `line`: строка, в которой следует установить отступ

- `indentWidth`: ширина отступа (в пробелах)

- `ch`: символ новой строки (`ch == '\n'`), символ переключения, указанный в `triggerCharacters`, или пустая строка, если пользователем был выбран пункт меню Сервис Выравнивание.

Значение, возвращённое функцией `indent()`, определяет способ установки отступа в строке. Если возвращённое функцией значение является простым целым числом, оно обрабатывается следующим образом:

- возвращено значение `-2`: ничего не делать

- возвращено значение `-1`: сохранить отступ (он будет определён на основе предыдущей непустой строки)

- возвращено значение `0`: числа >= 0 определяют глубину отступа в пробелах

Либо может быть возвращён массив из двух элементов:

- `возвращено [ отступ, выравнивание ];`

Первым элементом такого массива является глубина отступа, похожая на значение, о котором говорилось ранее. Другой же элемент является абсолютным значением, которое соответствует столбцу выравнивания. Если это значение превышает значение отступа, то после создания отступа согласно первому параметру к этому отступу будет добавлена разница между ними (в пробелах). В ином случае второе число игнорируется. Одновременное использование символов табуляции и пробелов для расстановки отступов часто называют смешанным режимом.

Рассмотрим следующий пример: предположим, что для создания отступов используются символы табуляции и значение ширины табуляции равняется 4. Здесь <tab> — символ табуляции, а '.' — пробел:

    1: <tab><tab>foobar("привет",
    2: <tab><tab>......."мир");

При создании отступа для строки 2 функция `indent()` возвращает [8, 15]. В результате два символа табуляции будут вставлены для создания отступа в столбце 8, а затем будет добавлено 7 пробелов для выравнивания по второму параметру, следовательно, строка останется выровненной во время просмотра файла при любой ширине табуляции.

По умолчанию в пакете &kappname; &kde; поставляются несколько средств расстановки отступов. Код этих средств на языке &javascript; расположен в каталоге `$`XDG_DATA_DIRS`/katepart5/script/indentation`.

В &Windows; эти файлы расположены в каталоге `%USERPROFILE%\AppData\Local\katepart5\indentation`. `%USERPROFILE%` обычно имеет значение `C:\\Users\\`пользователь``.

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

Чтобы сообщить о созданном полезном сценарии разработчикам &kappname;, отправьте письмо в список рассылки.

### Сценарии командной строки

Поскольку у всех пользователей разные потребности, в &kappname; предусмотрена поддержка небольших вспомогательных инструментов для ускорения работы с фрагментами текста с помощью встроенной командной строки. Например, команда `sort` (упорядочить) реализована именно с помощью такого инструмента. В этом разделе содержится описание способа создания файлов `*.js`, которые позволят расширить возможности &kappname; путём добавления вспомогательных сценариев.

Сценарии командной строки расположены в той же папке, что и сценарии расстановки отступов. Поэтому на первом этапе следует создать файл `*.js` с именем `myutils.js` в локальной домашней папке `$`XDG_DATA_HOME`/katepart5/script/commands`. Здесь переменная среды `XDG_DATA_HOME` обычно имеет значение `~/.local` или `~/.local/share`.

В &Windows; эти файлы расположены в каталоге `%USERPROFILE%\AppData\Local\katepart5\commands`. `%USERPROFILE%` обычно имеет значение `C:\\Users\\`пользователь``.

#### Заголовок сценария командной строки

Заголовок каждого сценария командной строки встраивается в &JSON; в начале сценария следующим образом:

    var katescript = {
        "author": "Example Name <example.name@some.address.org>",
        "license": "LGPLv2+",
        "revision": 1,
        "kate-version": "5.1",
        "functions": ["sort", "moveLinesDown"],
        "actions": [
            {   "function": "sort",
                "name": "Sort Selected Text",
                "category": "Editing",
                "interactive": "false"
            },
            {   "function": "moveLinesDown",
                "name": "Move Lines Down",
                "category": "Editing",
                "shortcut": "Ctrl+Shift+Down",
                "interactive": "false"
            }
        ]
    }; // kate-script-header, must be at the start of the file without comments

Далее приводится подробное описание каждой из записей заголовка:

- `author` [необязательная запись]: имя и контактные данные автора.

- `license` [необязательная запись]: краткая форма условий лицензирования, например BSD или LGPLv2.

- `revision` [обязательная запись]: версия сценария. Не забывайте увеличивать номер версии при каждом внесении изменений в файл.

- `kate-version` [обязательная запись]: минимальное значение версии &kappname;, необходимой для работы сценария.

- `functions` [обязательная запись]: массив &JSON; команд сценария.

- `actions` [необязательная запись]: массив &JSON; объектов &JSON;, определяющий действия, которые будут доступны в меню приложения. Подробные сведения доступны в разделе Привязки клавиш.

Так как значением `functions` является массив &JSON;, отдельный сценарий может содержать произвольное количество команд командной строки. Доступ к каждой из функций возможно получить с помощью встроенной командной строки &kappname;.

#### Исходный код сценария

Все функции, указанные в заголовке, должны быть реализованы в сценарии. Таким образом, файл сценария из вышеприведённого примера должен реализовывать две функции: `sort` и `moveLinesDown`. Все функции должны быть записаны в следующем виде:

    // необходимые библиотеки JS katepart, например range.js, если используется Range
    require ("range.js");

    function <name>(параметр1, параметр2, ...)
    {
        // ... реализация, смотрите также раздел: «Программный интерфейс (API) работы со сценариями»
    }

Параметры в командной строке передаются функции как `параметр1`, `параметр2` и так далее. Чтобы документировать каждую команду, просто реализуйте функцию '`help`' следующим образом:

    function help(cmd)
    {
        if (cmd == "sort") {
            return i18n("Sort the selected text.");
        } else if (cmd == "...") {
            // ...
        }
    }

После этого выполнение команды `help sort` приведёт к вызову соответствующей функции справки (help) с параметром `cmd` в значении названия указанной команды, то есть `cmd == "sort"`. В ответ на команду в &kappname; будет показан заданный текст справки. Обязательно выполните перевод строк.

При разработке сценария командной строки этот сценарий требуется перезагружать для проверки корректности поведения. Вместо перезапуска приложения достаточно просто перейти в командную строку и выполнить команду `reload-scripts`.

##### Привязки клавиш

Чтобы доступ к сценарию было возможно осуществлять с помощью меню приложения и с помощью комбинаций клавиш, он должен содержать соответствующий заголовок. В приведённом выше примере обе функции — `sort` и `moveLinesDown` — отображаются как соответствующие пункты меню благодаря этой части заголовка сценария:

    var katescript = {
        ...
        "actions": [
            {   "function": "sort",
                "name": "Sort Selected Text",
                "icon": "",
                "category": "Editing",
                "interactive": "false"
            },
            {   "function": "moveLinesDown",
                "name": "Move Lines Down",
                "icon": "",
                "category": "Editing",
                "shortcut": "Ctrl+Shift+Down",
                "interactive": "false"
            }
        ]
    };

Поля для одного действия таковы:

- `function` [обязательная запись]: функция, пункт которой должен отображаться в меню Сервис Сценарии.

- `name` [обязательная запись]: текст пункта, который показан в меню сценариев.

- `icon` [необязательная запись]: значок, который отображается рядом с текстом в меню. Возможно указать название одного из значков &kde;.

- `category` [необязательная запись]: если указана категория, сценарий будет отображаться в соответствующем вложенном меню.

- `shortcut` [необязательная запись]: здесь указывается комбинация клавиш, которая будет использоваться по умолчанию. Например: `Ctrl+Alt+t`. Дополнительные сведения доступны в документации &Qt;.

- `interactive` [необязательная запись]: если для работы сценария требуются введённые пользователем данные, установите этот параметр в значение `true`.

Чтобы сообщить о созданном полезном сценарии разработчикам &kappname;, отправьте письмо в список рассылки.

### Программный интерфейс (API) работы со сценариями

Программный интерфейс работы со сценариями, основы которого представлены здесь, возможно использовать для любых сценариев, в том числе сценариев расстановки отступов и сценариев командной строки. Классы `Cursor` и `Range` определяются библиотечными файлами в `$`XDG_DATA_DIRS`/katepart5/libraries`. Если требуется воспользоваться ими в определённом сценарии, чтобы задействовать какие-либо функции `Document` или `View`, включите в сценарий необходимую библиотеку с помощью следующей команды:

    // необходимые библиотеки JS katepart, например range.js, если используется Range
    require ("range.js");

Чтобы расширить стандартный программный интерфейс (API) работы со сценариями собственными функциями и прототипами, просто создайте файл в локальной папке файлов настройки &kde; `$`XDG_DATA_HOME`/katepart5/libraries` и включите его в файл сценария с помощью следующего кода:

    require ("myscriptnamehere.js");

В &Windows; эти файлы расположены в каталоге `%USERPROFILE%\AppData\Local\katepart5\libraries`. `%USERPROFILE%` обычно имеет значение `C:\\Users\\`пользователь``.

Рекомендованным способом расширения возможностей существующих прототипов, например `Cursor` или `Range`, не является внесение изменений в глобальные файлы `*.js`. Вместо этого следует изменить прототип `Cursor` в &javascript; после включения `cursor.js` в сценарий с помощью команды `require`.

#### Курсоры и диапазоны

Поскольку &kappname; является текстовым редактором, весь программный интерфейс по возможности основан на курсорах и диапазонах текста. Объект «Cursor» (курсор) является простым кортежем `(line, column)` (строка, столбец), который определяет позицию в тексте документа. Объект «Range» (диапазон) — это фрагмент текста от начальной до конечной позиции курсора. Подробное описание программного интерфейса приводится в следующих разделах.

##### Прототип Cursor (курсор)

    Cursor();

- Конструктор. Возвращает объект «Cursor» (курсор) в позиции `(0, 0)`.

  Пример: `var cursor = new Cursor();`

    Cursor(int строка, int столбец);

- Конструктор. Возвращает объект «Cursor» (курсор) в позиции (строка, столбец).

  Пример: `var cursor = new Cursor(3, 42);`

    Cursor(Cursor другой);

- Конструктор копирования. Возвращает копию курсора `другой`.

  Пример: `var copy = new Cursor(другой);`

    Cursor Cursor.clone();

- Возвращает клон курсора.

  Пример: `var clone = cursor.clone();`

    Cursor.setPosition(int строка, int столбец);

- Устанавливает курсор в место, указанное параметрами `строка` и `столбец`.

  Начиная с &kde; 4.11

    bool Cursor.isValid();

- Проверка корректности курсора. Курсор является некорректным, если строка и/или столбец установлены в значение `-1`.

  Пример: `var valid = cursor.isValid();`

    Cursor Cursor.invalid();

- Возвращает новый некорректный курсор, размещённый в позиции `(-1, -1)`.

  Пример: `var invalidCursor = cursor.invalid();`

    int Cursor.compareTo(Cursor другой);

- Сравнивает текущий курсор с курсором `другой`. Возвращает

  - `-1`, если текущий курсор расположен перед курсором `другой`

  - `0`, если курсоры находятся в одинаковых позициях

  - `+1`, если текущий курсор расположен после курсора `другой`

    bool Cursor.equals(Cursor другой);

- Возвращает `true`, если текущий курсор и курсор `другой` находятся в одинаковых позициях, в ином случае — `false`.

    String Cursor.toString();

- Возвращает курсор как строку вида `Cursor(строка, столбец)`.

##### Прототип Range (диапазон)

    Range();

- Конструктор. Вызов `new Range()` возвращает диапазон в позиции (0, 0) - (0, 0).

    Range(Cursor начало, Cursor конец);

- Конструктор. Вызов `new Range(`начало`, `конец`)` возвращает диапазон (`начало`, `конец`).

    Range(int начальнаяСтрока, int начальныйСтолбец, int конечнаяСтрока, int конечныйСтолбец);

- Конструктор. Вызов `new Range(`начальнаяСтрока`, `начальныйСтолбец`, `конечнаяСтрока`, `конечныйСтолбец`)` возвращает диапазон с позиции (`начальнаяСтрока`, `начальныйСтолбец`) до позиции (`конечнаяСтрока`, `конечныйСтолбец`).

    Range(Range другой);

- Конструктор копирования. Возвращает копию диапазона `другой`.

    Range Range.clone();

- Возвращает клон диапазона.

  Пример: `var clone = range.clone();`

    bool Range.isEmpty();

- Возвращает `true`, если начальная и конечная позиции курсора совпадают.

  Пример: `var empty = range.isEmpty();`

  Начиная с &kde; 4.11

    bool Range.isValid();

- Возвращает `true`, если начальная и конечная позиции курсора являются корректными, в ином случае — `false`.

  Пример: `var valid = range.isValid();`

    Range Range.invalid();

- Возвращает диапазон от (-1, -1) до (-1, -1).

    bool Range.contains(Cursor курсор);

- Возвращает `true`, если позиция курсора находится в этом диапазоне, в ином случае — `false`.

    bool Range.contains(Range другой);

- Возвращает `true`, если текущий диапазон содержит диапазон `другой`, в ином случае — `false`.

    bool Range.containsColumn(int столбец);

- Возвращает `true`, если `столбец` принадлежит полуоткрытому интервалу `[начальный.столбец, конечный.столбец)`, в ином случае — `false`.

    bool Range.containsLine(int строка);

- Возвращает `true`, если `строка` принадлежит полуоткрытому интервалу `[начальная.строка, конечная.строка)`, в ином случае — `false`.

    bool Range.overlaps(Range другой);

- Возвращает `true`, если текущий диапазон и диапазон `другой` имеют ненулевое пересечение, в ином случае — `false`.

    bool Range.overlapsLine(int строка);

- Возвращает `true`, если `строка` принадлежит интервалу `[начальная.строка, конечная.строка]`, в ином случае — `false`.

    bool Range.overlapsColumn(int столбец);

- Возвращает `true`, если `столбец` принадлежит интервалу `[начальный.столбец, конечный.столбец]`, в ином случае — `false`.

    bool Range.onSingleLine();

- Возвращает `true`, если диапазон начинается и заканчивается в одной и той же строке, то есть если `Range.начальная.строка == Range.конечная.строка`.

  Начиная с &kde; 4.9

    bool Range.equals(Range другой);

- Возвращает `true`, если текущий диапазон и диапазон `другой` совпадают, в ином случае — `false`.

    String Range.toString();

- Возвращает диапазон как строку вида `Range(Cursor(строка, столбец), Cursor(строка, столбец))`.

#### Глобальные функции

В этом разделе перечислены все глобальные функции.

##### Чтение и включение файлов

    String read(String название файла);

- Найти файл с именем `название файла` в каталоге `katepart/script/files` и вернуть его содержимое в виде строки.

    void require(String название файла);

- Найти файл с именем `название файла` в каталоге `katepart/script/libraries` и обработать его код. В`require` предусмотрена встроенная защита от повторного включения одного и того же `файла`.

  Начиная с &kde; 4.10

##### Отладка

    void debug(String текст);

- Вывести `текст` в `stdout` в консоль, с помощью которой запущено приложение.

##### Перевод

Полноценная локализация станет возможной только при использовании нескольких функций, предназначенных для перевода строк, а именно: `i18n`, `i18nc`, `i18np` и `i18ncp`. Поведение этих функций в точности соответствует поведению функций перевода строк &kde;.

С помощью функций перевода и системы перевода &kde; встроенные в сценарий строки сообщений возможно перевести на язык интерфейса приложения. Строки в сценариях, которые являются частью официальной сборки &kappname;, автоматически извлекаются и представляются для перевода командам переводчиков &kde;. Другими словами, разработчикам основной ветви &kappname; не приходится заниматься извлечением сообщений и их переводом. Впрочем, следует отметить, что перевод будет работать только в пределах инфраструктуры &kde;, то есть перевод новых строк сценариев, разработанных за пределами &kde;, невозможен. Поэтому созданные сценарии следует отправлять в основную ветвь разработки &kate;, чтобы сделать возможным надлежащий перевод.

    void i18n(String текст, параметр1, ...);

- Перевести `текст` на язык интерфейса приложения. Параметры `параметр1`, ... являются необязательными. Они позволяют заменить строки `%1`, `%2` и так далее.

    void i18nc(String контекст, String текст, параметр1, ...);

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

    void i18np(String единственное, String множественное, int количество, параметр1, ...);

- Перевести `единственное` или `множественное` число сообщения на язык интерфейса приложения, в зависимости от указанного значения параметра `количество`. Параметры `параметр1`, ... являются необязательными. Они позволяют заменить строки `%1`, `%2` и так далее.

    void i18ncp(String контекст, String единственное, String множественное, int количество, параметр1, ...);

- Перевести `единственное` или `множественное` число сообщения на язык интерфейса приложения, в зависимости от указанного значения параметра `количество`. При этом переводчикам будет показана строка `контекст`, что облегчает перевод. Параметры `параметр1`, ... являются необязательными. Они позволяют заменить строки `%1`, `%2` и так далее.

#### Программный интерфейс (API) View

Каким бы образом ни был запущен сценарий, он всегда будет использовать глобальную переменную `view`, которая соответствует текущей активной области просмотра. Далее приводится список всех доступных функций объекта «View».

    Cursor view.cursorPosition()

- Возвращает текущую позицию курсора в области просмотра.

    void view.setCursorPosition(int строка, int столбец);
    void view.setCursorPosition(Cursor курсор);

- Устанавливает для текущего курсора позицию (строка, столбец) или позицию указанного курсора.

    Cursor view.virtualCursorPosition();

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

    void view.setVirtualCursorPosition(int строка, int столбец);
    void view.setVirtualCursorPosition(Cursor курсор);

- Устанавливает для текущего виртуального курсора позицию (строка, столбец) или позицию указанного курсора.

    String view.selectedText();

- Возвращает выделенный фрагмент текст. Если выделенного фрагмента текста нет, возвращается пустая строка.

    bool view.hasSelection();

- Возвращает `true`, если выделенный фрагмент текст находится в области просмотра, в ином случае — `false`.

    Range view.selection();

- Возвращает диапазон выделенного фрагмента текста. Если выделенного фрагмента текста нет, возвращается некорректный диапазон.

    void view.setSelection(Range диапазон);

- Устанавливает выделение текста по указанному диапазону.

    void view.removeSelectedText();

- Удаляет выделенный текст. Если в области просмотра отстутствует выделенный текст, никаких действий не выполняется.

    void view.selectAll();

- Выделяет весь текст в документе.

    void view.clearSelection();

- Снимает выделение с текста, не удаляя сам текст.

    object view.executeCommand(String команда,
                               String параметры,
                               Range диапазон);

- Выполняет команду командной строки `команда` с дополнительными параметрами `параметры` и необязательным диапазоном `диапазон`. Возвращённый объект `object` имеет логическое свойство `object.ok`, которое указывает на то, было ли успешным выполнение команды `команда`. В случае ошибки строка `object.status` будет содержать сообщение об ошибке.

  Начиная с &kde-frameworks; 5.50

#### Программный интерфейс (API) Document

Каким бы образом ни был запущен сценарий, он всегда будет использовать глобальную переменную `document`, которая соответствует текущему активному документу. Далее приводится список всех доступных функций объекта «Document».

    String document.fileName();

- Возвращает название файла документа или пустую строку для несохранённых буферов с текстом.

    String document.url();

- Возвращает полный &URL;-адрес документа или пустую строку для несохранённых буферов с текстом.

    String document.mimeType();

- Возвращает тип &MIME; документа или тип &MIME; `application/octet-stream`, если не удалось найти соответствующий тип &MIME;.

    String document.encoding();

- Возвращает текущую кодировку, которая будет использована для сохранения файла .

    String document.highlightingMode();

- Возвращает глобальный режим подсветки, используемый во всём документе.

    String document.highlightingModeAt(Cursor позиция);

- Возвращает режим подсветки, используемый в указанной позиции в документе.

    Array document.embeddedHighlightingModes();

- Возвращает массив режимов подсветки, встроенных в текущий документ.

    bool document.isModified();

- Возвращает `true`, если в документе имеются несохранённые изменения, в ином случае — `false`.

    String document.text();

- Возвращает всё содержимое документа в виде единой текстовой строки. Разрывы строк обозначаются символом перехода на новую строку `\n`.

    String document.text(int соСтроки, int соСтолбца, int доСтроки, int доСтолбца);
    String document.text(Cursor с, Cursor до);
    String document.text(Range диапазон);

- Возвращает текст в указанном диапазоне. Чтобы код было легче читать, рекомендуется использовать основанную на объектах Cursor и Range версию функции.

    String document.line(int строка);

- Возвращает строку по её номеру в тексте. Если указанный номер находится вне диапазона номеров строк документа, возвращается пустая строка.

    String document.wordAt(int строка, int столбец);
    String document.wordAt(Cursor курсор);

- Возвращает слово в указанной позиции курсора.

    Range document.wordRangeAt(int строка, int столбец);
    Range document.wordRangeAt(Cursor курсор);

- Возвращает диапазон слова в указанной позиции курсора. Возвращённое значение диапазона будет некорректным (смотрите Range.isValid()), если текст находится за концом строки. Если в указанной позиции курсора отсутствует слово, возвращается пустой диапазон.

  Начиная с &kde; 4.9

    String document.charAt(int строка, int столбец);
    String document.charAt(Cursor курсор);

- Возвращает символ в указанной позиции курсора.

    String document.firstChar(int строка);

- Возвращает первый отличный от пробела символ в указанной `строке`. Первым символом строки считается символ в столбце 0. Если строка является пустой или состоит только из пробелов, функция возвращает пустую строку.

    String document.lastChar(int строка);

- Возвращает последний отличный от пробела символ в указанной `строке`. Если строка является пустой или состоит только из пробелов, функция возвращает пустую строку.

    bool document.isSpace(int строка, int столбец);
    bool document.isSpace(Cursor курсор);

- Возвращает `true`, если символ в указанной позиции курсора является пробелом, в ином случае — `false`.

    bool document.matchesAt(int строка, int столбец, String текст);
    bool document.matchesAt(Cursor курсор, String текст);

- Возвращает `true`, если указанный `текст` расположен в соответствующей позиции курсора, в ином случае — `false`.

    bool document.startsWith(int строка, String текст, bool skipWhiteSpaces);

- Возвращает `true`, если строка с указанным номером начинается с фрагмента текста `текст`, в ином случае — `false`. Параметр `skipWhiteSpaces` позволяет указать программе, следует ли игнорировать пробелы в начале строки.

    bool document.endsWith(int строка, String текст, bool skipWhiteSpaces);

- Возвращает `true`, если строка с указанным номером заканчивается фрагментом текста `текст`, в ином случае — `false`. Параметр `skipWhiteSpaces` позволяет указать программе, следует ли игнорировать пробелы в конце строки.

    bool document.setText(String текст);

- Заменяет всё содержимое документа на указанный текст.

    bool document.clear();

- Удаляет весь текст в документе.

    bool document.truncate(int строка, int столбец);
    bool document.truncate(Cursor курсор);

- Обрезает строку с указанным номером на указанном столбце или в указанной позиции курсора. Возвращает `true` в случае успеха или `false`, если строка с указанным номером находится вне диапазона номеров строк документа.

    bool document.insertText(int строка, int столбец, String текст);
    bool document.insertText(Cursor курсор, String текст);

- Вставляет указанный `текст` в указанной позиции курсора. Возвращает `true` в случае успеха или `false`, если документ доступен только для чтения.

    bool document.removeText(int соСтроки, int соСтолбца, int доСтроки, int доСтолбца);
    bool document.removeText(Cursor с, Cursor до);
    bool document.removeText(Range диапазон);

- Удаляет текст в указанном диапазоне. Возвращает `true` в случае успеха или `false`, если документ доступен только для чтения.

    bool document.insertLine(int строка, String текст);

- Вставляет текст в указанной строке. Возвращает `true` в случае успеха или `false`, если документ доступен только для чтения или указанная строка находится вне диапазона номеров строк документа.

    bool document.removeLine(int строка);

- Удаляет строку с указанным номером. Возвращает `true` в случае успеха или `false`, если документ доступен только для чтения или указанная строка находится вне диапазона номеров строк документа.

    bool document.wrapLine(int строка, int столбец);
    bool document.wrapLine(Cursor курсор);

- Переносит строку по указанной позиции курсора. Возвращает `true` в случае успеха или `false` (например, если номер строки < 0).

  Начиная с &kde; 4.9

    void document.joinLines(int начальнаяСтрока, int конечнаяСтрока);

- Соединяет строки в диапазоне от `начальнаяСтрока` до `конечнаяСтрока`. Две последовательные текстовые строки всегда разделяются одиночным пробелом.

    int document.lines();

- Возвращает число строк в документе.

    bool document.isLineModified(int строка);

- Возвращает `true`, если `строка` в настоящее время содержит несохранённые данные.

  Начиная с &kde; 5.0

    bool document.isLineSaved(int строка);

- Возвращает `true`, если `строка` была изменена и затем документ был сохранён. Следовательно, в настоящее время строка не содержит какие-либо несохранённые данные.

  Начиная с &kde; 5.0

    bool document.isLineTouched(int строка);

- Возвращает `true`, если `строка` в настоящее время содержит несохранённые данные или была изменена ранее.

  Начиная с &kde; 5.0

    bool document.findTouchedLine(int начальнаяСтрока, bool down);

- Поиск следующей изменённой строки, начиная со строки `начальнаяСтрока`. Поиск выполняется в направлении «вверх» (к началу документа) или «вниз» (к концу документа), в зависимости от значения параметра `down`.

  Начиная с &kde; 5.0

    int document.length();

- Возвращает число символов в документе.

    int document.lineLength(int строка);

- Возвращает длину строки с номером `строка`.

    void document.editBegin();

- Начинает группу редактирования для упорядочения операций отмены или повтора действий. Не забывайте, что вызывать `editEnd()` следует именно столько раз, сколько вызывается `editBegin()`. Вызовы `editBegin()` используют встроенный счётчик, следовательно, их возможно вкладывать один в другой.

    void document.editEnd();

- Завершает группу редактирования. Последний вызов `editEnd()` (то есть соответствие первого вызова `editBegin()`) завершает шаг по редактированию.

    int document.firstColumn(int строка);

- Возвращает первый отличный от пробела столбец в указанной с помощью параметра `строка` строке. Если в строке будут только пробелы, функция вернёт значение `-1`.

    int document.lastColumn(int строка);

- Возвращает последний отличный от пробела столбец в указанной с помощью параметра `строка` строке. Если в строке будут только пробелы, функция вернёт значение `-1`.

    int document.prevNonSpaceColumn(int строка, int столбец);
    int document.prevNonSpaceColumn(Cursor курсор);

- Возвращает номер столбца с символом, отличным от пробела. Поиск будет выполнен в направлении начала документа, начиная с указанной позиции курсора.

    int document.nextNonSpaceColumn(int строка, int столбец);
    int document.nextNonSpaceColumn(Cursor курсор);

- Возвращает номер столбца с символом, отличным от пробела. Поиск будет выполнен в направлении конца документа, начиная с указанной позиции курсора.

    int document.prevNonEmptyLine(int строка);

- Возвращает следующую непустую строку, содержащую отличные от пробелов символы. Поиск будет выполнен в направлении начала документа.

    int document.nextNonEmptyLine(int строка);

- Возвращает следующую непустую строку, содержащую отличные от пробелов символы. Поиск будет выполнен в направлении конца документа.

    bool document.isInWord(String символ, int атрибут);

- Возвращает `true`, если указанный `символ` с указанным параметром `атрибут` может быть частью слова, в ином случае — `false`.

    bool document.canBreakAt(String символ, int атрибут);

- Возвращает `true`, если указанный `символ` с указанным параметром `атрибут` может быть использован как место переноса строки, в ином случае — `false`.

    bool document.canComment(int начальныйАтрибут, int конечныйАтрибут);

- Возвращает `true`, если диапазон, начало и конец которого определяются на основе указанных атрибутов, может быть закомментирован, в ином случае — `false`.

    String document.commentMarker(int атрибут);

- Возвращает метку комментария для однострочных комментариев для указанного параметра `атрибут`.

    String document.commentStart(int атрибут);

- Возвращает метку комментария для начала многострочных комментариев для указанного параметра `атрибут`.

    String document.commentEnd(int атрибут);

- Возвращает метку комментария для завершения многострочных комментариев для указанного параметра `атрибут`.

    Range document.documentRange();

- Возвращает диапазон, который включает весь документ.

    Cursor documentEnd();

- Возвращает курсор, расположенный в последнем столбце последней строки в документе.

    bool isValidTextPosition(int строка, int столбец);
    bool isValidTextPosition(Cursor курсор);

- Возвращает `true`, если курсор находится в корректной позиции в тексте. Позиция в тексте является корректной, только если курсор находится в начале, в середине или в конце корректной строки текста. Кроме того, позиция в тексте является некорректной, если курсор находится в заменителе символа Юникода.

  Начиная с &kde; 5.0

    int document.attribute(int строка, int столбец);
    int document.attribute(Cursor курсор);

- Возвращает атрибут в указанной позиции курсора.

    bool document.isAttribute(int строка, int столбец, int атрибут);
    bool document.isAttribute(Cursor курсор, int атрибут);

- Возвращает `true`, если атрибут в указанной позиции курсора совпадает со значением параметра `атрибут`, в ином случае — `false`.

    String document.attributeName(int строка, int столбец);
    String document.attributeName(Cursor курсор);

- Возвращает название атрибута как удобочитаемый текст. Соответствует названию `itemData` в файлах подсветки синтаксиса.

    bool document.isAttributeName(int строка, int столбец, String название);
    bool document.isAttributeName(Cursor курсор, String название);

- Возвращает `true`, если название атрибута в определённой позиции курсора соответствует указанному значению параметра `название`, в ином случае — `false`.

    String document.variable(String ключ);

- Возвращает значение запрашиваемой переменной документа `ключ`. Если переменной документа с указанным названием не существует, возвращается пустая строка.

    void document.setVariable(String ключ, String значение);

- Устанавливает значение соответствующей переменной документа `ключ`.

  Смотрите также переменные документа Kate

  Начиная с &kde; 4.8

    int document.firstVirtualColumn(int строка);

- Возвращает виртуальный столбец первого отличного от пробела символа в указанной строке или `-1`, если строка является пустой или содержит только пробелы.

    int document.lastVirtualColumn(int строка);

- Возвращает виртуальный столбец последнего отличного от пробела символа в указанной строке или `-1`, если строка является пустой или содержит только пробелы.

    int document.toVirtualColumn(int строка, int столбец);
    int document.toVirtualColumn(Cursor курсор);
    Cursor document.toVirtualCursor(Cursor курсор);

- Преобразует указанную реальную позицию курсора в виртуальную позицию курсора, возвращая либо целое значение (int), либо объект «Cursor».

    int document.fromVirtualColumn(int строка, int виртуальныйСтолбец);
    int document.fromVirtualColumn(Cursor виртуальныйКурсор);
    Cursor document.fromVirtualCursor(Cursor виртуальныйКурсор);

- Преобразует указанную виртуальную позицию курсора в реальную позицию курсора, возвращая либо целое значение (int), либо объект «Cursor».

    Cursor document.anchor(int строка, int столбец, Char символ);
    Cursor document.anchor(Cursor курсор, Char символ);

- Выполняет поиск указанного символа в направлении начала документа, начиная в указанной позиции курсора. Например, если функции будет передан символ «(», она вернёт позицию открывающей скобки «(». Выполняется подсчёт ссылок, то есть другие «(...)» будут проигнорированы.

    Cursor document.rfind(int строка, int столбец, String текст, int атрибут = -1);
    Cursor document.rfind(Cursor курсор, String текст, int атрибут = -1);

- Выполняет поиск указанного текста с соответствующим значением параметра `атрибут` в направлении начала текста. Параметр `атрибут` игнорируется, если он установлен в значение `-1`. Возвращает некорректный курсор, если текст не удалось найти.

    int document.defStyleNum(int строка, int столбец);
    int document.defStyleNum(Cursor курсор);

- Возвращает стиль по умолчанию, используемый в указанной позиции курсора.

    bool document.isCode(int строка, int столбец);
    bool document.isCode(Cursor курсор);

- Возвращает `true`, если атрибут в указанной позиции курсора не совпадает ни с одним из следующих значений стилей: `dsComment`, `dsString`, `dsRegionMarker`, `dsChar`, `dsOthers`.

    bool document.isComment(int строка, int столбец);
    bool document.isComment(Cursor курсор);

- Возвращает `true`, если значением атрибута символа в позиции курсора является `dsComment`, в ином случае — `false`.

    bool document.isString(int строка, int столбец);
    bool document.isString(Cursor курсор);

- Возвращает `true`, если значением атрибута символа в позиции курсора является `dsString`, в ином случае — `false`.

    bool document.isRegionMarker(int строка, int столбец);
    bool document.isRegionMarker(Cursor курсор);

- Возвращает `true`, если значением атрибута символа в позиции курсора является `dsRegionMarker`, в ином случае — `false`.

    bool document.isChar(int строка, int столбец);
    bool document.isChar(Cursor курсор);

- Возвращает `true`, если значением атрибута символа в позиции курсора является `dsChar`, в ином случае — `false`.

    bool document.isOthers(int строка, int столбец);
    bool document.isOthers(Cursor курсор);

- Возвращает `true`, если значением атрибута символа в позиции курсора является `dsOthers`, в ином случае — `false`.

#### Программный интерфейс (API) редактора

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

    String editor.clipboardText();

- Возвращает текст, который в настоящее время находится в глобальном буфере обмена.

  Начиная с &kde-frameworks; 5.50

    String editor.clipboardHistory();

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

  Начиная с &kde-frameworks; 5.50

    void editor.setClipboardText(String текст);

- Устанавливает для содержимого буфера обмена значение `текст`. Запись `текст` будет добавлена в журнал буфера обмена.

  Начиная с &kde-frameworks; 5.50