x64dbg 插件开发指南：用 GuiScriptEnableHighlighting 控制脚本视图语法高亮-港品优选

x64dbg 插件开发指南：用 GuiScriptEnableHighlighting 控制脚本视图语法高亮

【免费下载链接】x64dbgAn open-source user mode debugger for Windows. Optimized for reverse engineering and malware analysis.项目地址: https://gitcode.com/gh_mirrors/x6/x64dbg

导读

GuiScriptEnableHighlighting是 x64dbg 提供给插件与调试引擎使用的 GUI 桥接（bridge）函数之一，用于动态开关「脚本」视图中脚本源码的语法高亮显示。本指南围绕该函数展开：先给出官方 API 语义（签名、参数、返回值），再深入仓库源码追完整条调用链——从调试引擎simplescript.cpp的默认启用逻辑，到 bridge 层的消息投递，再到 GUI 侧ScriptView的富文本渲染实现，帮助读者在开发插件或扩展脚本功能时准确控制脚本视图的展示效果。

函数原型与官方语义

该函数在官方开发者文档 GuiScriptEnableHighlighting.md 中的定义如下：

void GuiScriptEnableHighlighting(bool enable);

参数说明

参数	类型	说明
`enable`	`bool`	传入`true`启用脚本视图中的语法高亮，传入`false`关闭

返回值

该函数没有返回值（void）。

官方示例

GuiScriptEnableHighlighting(true);

桥接（Bridge）层：从调试引擎到 GUI 的消息投递

x64dbg 的架构将调试引擎（src/dbg）与图形界面（src/gui）分离，二者通过src/bridge提供的桥接机制通信。GuiScriptEnableHighlighting正是这一机制的典型实现：

导出声明：函数在 bridgemain.h 中以BRIDGE_IMPEXP宏导出，供插件与调试引擎调用；
消息编码：对应消息在 bridgemain.h 的消息表中被声明为msg(GUI_SCRIPT_ENABLEHIGHLIGHTING, bool enable, unused)；
发送实现：核心实现位于 bridgemain.cpp：

BRIDGE_IMPEXP void GuiScriptEnableHighlighting(bool enable) { _gui_sendmessage(GUI_SCRIPT_ENABLEHIGHLIGHTING, (void*)(duint)enable, 0); }

可以看到，enable参数被直接转换为duint型指针作为消息参数发送，第二个参数固定为0（本消息不使用）。

GUI 侧的消息分发

GUI 进程在 Bridge.cpp 中接收并分发该消息：

case GUI_SCRIPT_ENABLEHIGHLIGHTING: emit scriptEnableHighlighting((bool)param1); break;

param1被还原为bool并发出 Qt 信号scriptEnableHighlighting。

ScriptView：高亮开关的实际消费方

脚本视图类ScriptView位于 src/gui/Src/Gui/ScriptView.h，它继承了StdTable，负责渲染脚本的行号、文本与信息三列。

信号连接与状态存储

在 ScriptView.cpp 构造函数中完成信号连接：

connect(Bridge::getBridge(), SIGNAL(scriptEnableHighlighting(bool)), this, SLOT(enableHighlighting(bool)));

对应的槽函数 ScriptView.cpp 只做一件事——把开关值存入成员变量：

void ScriptView::enableHighlighting(bool enable) { mEnableSyntaxHighlighting = enable; }

该成员变量在 ScriptView.h 中声明，构造函数中默认初始化为false（见 ScriptView.cpp），即脚本视图默认不启用语法高亮。

高亮的实际渲染逻辑

开关真正发挥作用的位置是重写的paintContent函数（ScriptView.h 声明）。在绘制「命令」列（case 1）时，代码首先检查开关状态（ScriptView.cpp）：

case 1: //command { if(mEnableSyntaxHighlighting) { //initialize int charwidth = getCharWidth(); int xadd = charwidth; //for testing RichTextPainter::List richText; RichTextPainter::CustomRichText_t newRichText; newRichText.underline = false; QString command = getCellContent(row, col); //handle comments int comment_idx = command.indexOf("\1"); //find the index of the comment ... } ... }

当开关为true时，代码借助RichTextPainter构建富文本片段：先解析出行内注释分隔符，再根据行类型（linecommand、linebranch等）分别以InstructionRetColor、InstructionRetBackgroundColor等配置色渲染助记符与操作数。也就是说，高亮颜色本身并非硬编码，而是取自 x64dbg 的颜色配置系统（ConfigColor），用户可以在 GUI 设置中统一调整配色。

调试引擎中的默认调用点

GuiScriptEnableHighlighting不仅面向插件 API，调试引擎内部也主动调用它。在 simplescript.cpp 的scriptLoad函数中，加载脚本文件时引擎会先清空脚本视图，然后显式开启高亮：

static bool scriptLoad(const char* filename, bool gui) { ExclusiveSectionLocker<LockScriptLineMap> lockLineMap; ExclusiveSectionLocker<LockScriptBreakpoints> lockBreakpoints; GuiScriptClear(); GuiScriptEnableHighlighting(true); //enable default script syntax highlighting scriptIp = 0; ... GuiScriptAdd(lines, script); scriptIp = scriptNextIp(0); GuiScriptSetIp(scriptIp); return true; }

注释明确写着 "enable default script syntax highlighting"。也就是说，虽然ScriptView构造时默认关闭高亮，但只要通过scriptLoad（或其异步封装ScriptLoadAwait，见 simplescript.cpp）加载脚本，调试引擎就会调用本函数强制开启高亮。这解释了用户在 GUI 中打开脚本文件时默认能看到语法着色效果的原因。

使用建议与注意事项

综合上述源码链路，开发者在使用GuiScriptEnableHighlighting时应注意以下几点：

调用线程与异步性：该函数通过_gui_sendmessage将消息投递给 GUI 线程处理，属于典型的跨线程桥接调用。从调试引擎或插件线程调用是安全的，但高亮状态的生效发生在 GUI 侧消息处理完成之后；
全局开关语义：它控制的是脚本视图这一全局组件的显示开关，而非某个具体脚本或文件的高亮属性；高亮的详细颜色则由全局颜色配置（如InstructionRetColor）决定；
与默认行为的关系：若你的插件希望脚本视图高亮保持开启，可以主动调用GuiScriptEnableHighlighting(true)；若希望在调试引擎加载脚本后关闭高亮，则需要在该调用之后（例如监听相关 GUI 事件时）再次调用GuiScriptEnableHighlighting(false)覆盖默认状态；
配套 API：脚本视图还提供GuiScriptAdd、GuiScriptClear、GuiScriptSetIp、GuiScriptSetTitle、GuiScriptSetInfoLine、GuiScriptError、GuiScriptMessage、GuiScriptMsgyn等一系列相关桥接函数（完整清单见 docs/developers/functions/gui/index.rst），它们共同构成了插件与脚本视图交互的完整工具集。

企业官网建设流程全解析