QScintilla

QScintilla

QScintilla在Ubuntu上编辑C++代码
原作者	Neil Hodgson等人
开发者	Riverbank Computing公司
首次发布	2006年6月17日
当前版本	2.14.1（2023年6月23日）
原始码库	https://github.com/brCreate/QScintilla
编程语言	C++、Python
操作系统	Microsoft Windows、MacOS、Linux、Android、iOS等
平台	所有Qt支持的平台，如x86及x86-64等
语言	6种语言
语言列表 捷克语、德语、西班牙语、法语、葡萄牙语（巴西）及英语
许可协议	GNU GPL及PyQt商业许可证
网站	https://riverbankcomputing.com/software/qscintilla/intro

QScintilla是对Scintilla的一个Qt端接口，由英国软件公司Riverbank Computing编写，它是一面向Qt公司的Qt图形用户界面框架的源始码编辑器组件之一。由于采用了尼尔·霍奇森（英语：Neil Hodgson）用C++写成的Scintilla组件，QScintilla的内核和基本逻辑均由C++实现。QScintilla封装了几乎所有的Scintilla功能；官方解释称“QScintilla中，除了能找到普通文本编辑器的所有功能外，QScintilla还包含了有助快速编写代码和为程序调试的功能，包括语法高亮、错误指示符、自动完成和调用提示等等。用作选择的页边可有标注，这对于调试器想要标识中断点和当前行很有用。渲染选项比市面上很多原始码编辑器还要多，QScintilla支持比例字形字体、粗体和斜体、多重前景色彩和背景色彩、多重字体等等。”

从理论上来讲，QScintilla是一个以C++编写的自由开源程序库。由于QScintilla也提供了面向Python的组件（用户可以搭配版本5或6的PyQt使用它，也可以在PyPI上下载使用），所以QScintilla也可以被视作一Python程序库。

功能

除了以上官方所述的语法高亮、错误指示符、自动完成和调用提示等以外，QScintilla由于继承了Scintilla的实现与逻辑，它配备了以下的原始码编辑器功能：

• 语法折叠
• 自定义以及可录影的宏（宏）
• 多重文件界面
• 文档打印

由于QScintilla的用户界面部分基于Qt，因此QScintilla可在任何Qt所支持的平台上运作，如Windows、Linux、macOS、iOS和Android等。

目前QScintilla的底层逻辑基于Scintilla 3.10.1版本，因此QScintilla可能缺失部分或全部Scintilla在其3.10.1后的版本所实现的功能（如SCI_GETSTYLEDTEXTFULL等，不在QsciScintillaBase类的匿名枚举中）。

许可证与法律地位

与Scintilla不同，QScintilla使用的是与PyQt（和早期Qt）相同的许可证标准。行双轨许可证：GNU GPL第三版本和PyQt自己的商业许可（目前PyQt和QScintilla均不提供LGPL及其他任何的自由软件许可证，因为官方声称不确定这样做能否维持其售卖商业许可证的收入）。开发自由软件者、开源软件以及任何非牟利的软件可使用免费的许可证，但任何牟利性的、商业性的软件都必须购买PyQt商业许可证才合法。

如果买家买了PyQt商业许可证，那么其许可证就是终身有效的，用户可以自由地下载及商业地使用当前和及后版本的PyQt和QScintilla等。但该许可证并不包含购买时间前所发布的版本。PyQt的商业许可证并不包含Qt的商业许可证；用户需另外购买。

Riverbank Computing公司不单独出售QScintilla的许可证；相反，商业用户必须购买所有的Riverbank Computing产品，包括PyQt、PyQt 3D、PyQt Charts、SIP及QScintilla等。换言之，QScintilla是随着PyQt派生而来的产品。

组件

• QsciAbstractAPIs和QsciAPIs提供了调用提示和自动完成的纯文本API资料。
• QsciCommand和QsciCommandSet提供了一系列QsciScintilla所用到的命令，以及其对应的键盘快捷键。
• QsciDocument表达了一份正在编辑的文件，以便使用QScintilla开发的编辑器调用并进行多文件编辑。
• QsciLexer*定义了词法分析器。QScintilla中的词法分析器虽然不会像一门真正面世的编程语言般产生标识符列表供语法分析器分析，但仍包含面对特定语言的功能，如语法高亮、自动完成、错误提示、调用提示等等。截至2.14.1版本，QScintilla包含面向以下编程语言的功能：ASM、AVS、Bash、Batch、CMake、CoffeeScript、C++、C♯、CSS、D、Diff文档、EDIFACT（支持不足）、Fortran、Fortran 77、Hex、HTML、IDL、IntelHex、Java、JavaScript、JSON、Lua、Makefile、Markdown、MASM、Matlab、NASM、Octave、Pascal、Perl、PO、PostScript、POV、INI文档、Python 2、Ruby、Spice、SQL、S-Record、TCL、Tektronix Hex、TeX、Verilog、VHDL、XML、YAML。用户可以继承以上任何分析器类来更改其默认颜色、背景色、字体、关键字等，以自定显示样式和语言关键字，来让编辑器支持QScintilla默认没有的，但与父类相似的编程语言。例如：继承QsciLexerCPP并重写其受保护方法keywords(int style);来使它实际上变为C语言的分析器（C++的语法与C相似）；重写QsciLexerPython::keywords(int style);使它事实上支持Python 3（在QScintilla的层面下，Python 2和Python 3除关键字外无异）；诸如Java、JavaScript及IDL等也是如此实现的。除此之外，还可以透过继承QsciLexerCustom来进行底层代码扫描和代码折叠来定义一个全新的分析器。
• QsciMacro定义了一系列可快速录制/回放宏/宏的工具。
• QsciPrinter继承了QPrinter，令用户打印一份QScintilla的文档时可操控其特有的页面属性，如缩放度、打印特定行号、自动换行等。
• QsciScintilla是QScintilla面向最终程序员的唯一小部件（继承自QWidget）。是一个功能完备的原始码编辑器，是QScintilla库的核心组件。官方称，“QsciScintilla提供了一个更高阶的、更向Qt的Scintilla API”。QsciScintillaBase则是实现Scintilla的底层逻辑和代码，正常来说一般用户并不会直接用到它（而且QsciScintilla继承QsciScintillaBase）。后者充其量也就是一个枚举提供类（Scintilla称为“资讯”），并且透过SendScintilla(unsigned long msg, ...);方法提供一个底层的资讯交互实现。
• QsciStyle和QsciStyledText是QScintilla自行的样式和受渲染文字的容器。它们可在某些需要设置文字外观的方法中，设置被显示文字的格式，而非系统的默认格式。举例：QsciScintilla::annotate(...);。

示例

右侧的图片为两个示例运行的结果，在GNU/Linux的Ubuntu上编译/运行（用Python和C++编写后运行的结果均为一样）。

An example using the C++ lexer in QScintilla

此处为一个使用Python编写的示例：

#!/usr/bin/python3
# -*- encoding: utf8 -*-

from PyQt5.QtWidgets import QApplication, QMainWindow
# 從PyQt的QtWidgets子模組中導入依賴類，使用版本爲5
from PyQt5.Qsci import QsciLexerCPP, QsciScintilla
# 從QScintilla導入編輯器及C++詞法分析器類，使用PyQt版本爲5
# 需事先透過「pip install QScintilla」下載

import sys
# 導入sys模塊


# 運行主代碼
if __name__ == "__main__":
    app: QApplication = QApplication(sys.argv)
    # 建立一個QApplication實例
    mw: QMainWindow = QMainWindow()
    # 建立一個QMainWindow實例
    ed: QsciScintilla = QsciScintilla(mw)
    # 建立編輯器實例，父類爲mw
    lex: QsciLexerCPP = QsciLexerCPP(ed)
    # 建立詞法分析器實例，父類爲ed
    ed.setLexer(lex)
    # 設定分析器
    ed.setMarginLineNumbers(0, True)
    # 設定行號
    ed.setMarginWidth(0, "000000")
    # 設定顯示行號的頁邊界所佔寬度爲六個字符
    mw.setCentralWidget(ed)
    # 常規操作
    mw.show()
    # 顯示mw
    sys.exit(app.exec())
    # 常規操作，也可調用app.exec_()

以下为C++版本：

#include <QApplication>
#include <QMainWindow>
// 從PyQt的QtWidgets子模組中導入依賴類，使用版本自由
#include <Qsci/qscilexercpp.h>
#include <Qsci/qsciscintilla.h>
// 從QScintilla導入編輯器及C++詞法分析器類，使用Qt版本自由
// 需事先透過「Qt Online Installer」下載、編譯、封裝Qt
// 然後再從GitHub或Riverbank的官網上下載QScintilla，解壓壓縮包、
// 編譯、下載。
// 需要用到CMake/QMake。


// 運行主代碼
int main(int argc, char *argv[]) {
    QApplication app(argc, argv)
    // 建立一個QApplication實例
    QMainWindow mw()
    // 建立一個QMainWindow實例
    QsciScintilla *ed = new QsciScintilla(&mw)
    // 建立編輯器實例，父類爲mw指針地址
    QsciLexerCPP *lex = new QsciLexerCPP(ed)
    // 建立詞法分析器實例，父類爲ed
    ed->setLexer(lex)
    // 設定分析器
    ed->setMarginLineNumbers(0, true)
    // 設定行號
    ed->setMarginWidth(0, "000000")
    // 設定顯示行號的頁邊界所佔寬度爲六個字符
    mw.setCentralWidget(ed)
    // 常規操作
    mw.show()
    // 顯示mw
    return app.exec()
    // 常規操作，也可調用app.exec_()
}