QScintilla: определяем styleText

Вот мы и добрались до самой важной функции лексера void styleText(int start, int end)

Займемся ее реализацией.

void LexerZ::styleText(int start, int end)
{
  //editor() - функция из родительского класса.
  //Возвращает указатель на QsciScintilla
  if (!editor())
   return;

  //получить исходник
  //выделим кусок памяти
  // +1 - под \0
  char * chars = new char[end - start + 1];
  //заполним кусок обратившись сцинтилле
  editor()->SendScintilla(QsciScintilla::SCI_GETTEXTRANGE,
              start, end, chars);
  //преобразуем в строку
  QString source(chars);
  delete [] chars;
 
  //Оптимизация - кэшируем уже ранее отрисованную строку
  if (source == cache)
   return;
  else
   cache = source;
  //Не работаем с пустой строкой
  if (source.isEmpty())
   return;
  //вызываем функцию отрисовки комментария
  //передаем исходную строку, начало и конец
  commentStyling(source, start, end);
}
* This source code was highlighted with Source Code Highlighter.

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

Ее реализация приведена ниже:

QScintilla: раскрашиваем комментарии

Сегодня мы будем раскрашивать комментарии для некого гипотетического языка Z.
Допустим в этом языке комментарии строк принято обозначать символом **, аналогично // в C++. Давайте предположим, что цвет шрифта комментария - синий, цвет фона - светло-зеленый, а сам шрифт - Comic Sans.
Начнем изменения в нашем коде Lexer.cpp и Lexer.h. (Можно переименовать эти файлы в LexerZ.h и LexerZ.cpp).

QScintilla: пишем Lexer

Перед дальнейшим написанием лексера нужно уяснить парадигму паттерна "Виртуальный метод", который использует QScintilla.
Лескер состоит из набора виртуальный функций, которые нужно переопределить. Класс QsciScintilla при необходимости вызывает виртуальные методы базового класса, однако в соответствии с полиморфизмом, будут вызываться методы нашего лексера.
Вот перечень виртуальных функций, необходимых для переопределения:

  //! Возвращает название языка
  virtual const char * language() const;
  //! Цвета для стилей
  virtual QColor defaultColor(int style) const;
  //! Шрифты для стилей
  virtual QFont defaultFont(int style) const;
  //! Бакгроунд для стилей
  virtual QColor defaultPaper(int style) const;
  //! Разбор текста на стили
  virtual void styleText (int start, int end);
  //! Описание
  virtual QString description (int style) const;
* This source code was highlighted with Source Code Highlighter.

Переменная style - это просто идентификатор стиля. Мы сами ее определяем. Для этого в лексере мы определяем некий enum для наших стилей.

  enum
  {
   Default = 0,
   Comment = 1,
   Binary  = 2,
   String  = 3,
   Keyword1 = 4,
   Keyword2 = 5,
   Keyword3 = 6,
   Keyword4 = 7,
   Const  = 8
  };
* This source code was highlighted with Source Code Highlighter.

Имена стилей и их числовые обозначения значения не имеют, далее станет ясно почему.
Самой важной виртуальной функцией является   virtual void styleText (int start, int end);

Именно она отвечает за отрисовку. К этой функции QScintilla обращается всякий раз, когда ей надо перерисовать кусок текста начиная с позиции start до позиции end.

QScintilla: создаем свой лексер

Как уже было сказано ранее, QScintilla поддерживает около 80 языков, раскрашивая каждый в соответствии с их синтаксисом. Т.е. для C++ комментарии задаются символом //, а для языка R символом #. Соответственно, раскрашивать в каждом случае надо по своему.

Трудно представить, что кроме этих 80 языков вам может понадобиться что-то свое, но тем не менее такая ситуация возникнуть может и надо знать как тут поступать.

Вообще, есть два способа добавить свой язык для раскраски.
Первый - это правка собственно исходного кода библиотеки qscintilla2.dll.
Достоинства этого метода - простота добавления. Достаточно взять за пример уже какой-нибудь существующий лексер, скопировать его в новый файл, исправить несколько строк, пересобрать библиотеку и, вуаля, новый лексер готов.
Недостаток этого метода очевиден - необходимость пересобирать библиотеку. Хотелось бы обойтись без этого.
Для этого в QScintilla есть путь истинного воина - наследование от QsciLexerCustom и самостоятельное написание алгоритмов раскраски. Это более сложный путь, на мой взгляд, но зато более правильный с концептуальной точки зрения, т.к. не нужно пересобирать библиотеку.

Итак, первое что мы должны сделать - это отнаследоваться от QsciLexerCustom:

#include <qsci/qscilexercustom.h>

class Lexer : public QsciLexerCustom
{
  Q_OBJECT
public:
  //! Конструктор
  Lexer(QObject * parent = 0);
  //! Деструктор
  virtual ~Lexer();
private:
  Lexer(const Lexer &);
  Lexer &operator=(const Lexer &);
};
* This source code was highlighted with Source Code Highlighter.

В следующих выпусках мы продолжим написание своего лексера.