YSSCore::Editor::DebugServer Class

成员函数文档

[since YSS 0.13.0] DebugServer::DebugServer(const QString &name, const QString &id, YSSCore::Editor::EditorPlugin *plugin)

构造函数 name 模块名称，id 模块ID，plugin 所属插件。

这个function 从 YSS 0.13.0 开始支持。

[virtual noexcept, since YSS 0.13.0] DebugServer::~DebugServer()

析构函数

这个function 从 YSS 0.13.0 开始支持。

[signal, since YSS 0.15.0] void DebugServer::actionFinished(YSSCore::Editor::DebugServer::DebugAction action, bool success)

action 正在执行的调试操作， success 调试操作是否成功完成。

当一个调试操作完成时发出此信号。理应只有on开始的函数才应该发出对应的信号。

如果一个步骤最终未能顺利执行完毕，则应该在适当的时候发出这个信号， 并将 success 设置为false，以通知编辑器这个步骤未能成功完成。

请注意，YSS约定，如果收到了 success 为false的该信号，则将 从actionMessage收到的最后一条信息视作错误信息，并以 一定策略显示出来。

这个function 从 YSS 0.15.0 开始支持。

[signal, since YSS 0.15.0] void DebugServer::actionMessage(YSSCore::Editor::DebugServer::DebugAction action, const QString &message)

action 正在执行的调试操作， message 消息内容。

当一个调试操作有消息更新时发出此信号。理应只有on开始的函数才应该发出对应的信号。

message的具体含义取决于正在执行的调试操作，由实现自行决定，YSS 使用这个数据在输出窗口中输出。

这个function 从 YSS 0.15.0 开始支持。

[signal, since YSS 0.15.0] void DebugServer::actionPercent(YSSCore::Editor::DebugServer::DebugAction action, qint32 finished, qint32 total)

action 正在执行的调试操作， finished 已经完成的部分， total 总的部分。

当一个调试操作有进度更新时发出此信号。理应只有on开始的函数才应该发出对应的信号。

finished和total的具体含义取决于正在执行的调试操作，由实现自行决定，YSS 使用这个数据绘制进度条。

这个function 从 YSS 0.15.0 开始支持。

[signal, since YSS 0.15.0] void DebugServer::actionStarted(YSSCore::Editor::DebugServer::DebugAction action)

action 正在执行的调试操作，例如构建、运行、单步调试等。

当一个调试操作开始时发出此信号。理应只有on开始的函数才应该发出对应的信号。

这个function 从 YSS 0.15.0 开始支持。

[signal, since YSS 0.15.0] void DebugServer::breakpointChanged(const QString &filePath, qint32 lineNumber, bool enabled)

filePath 断点所在的文件路径， lineNumber 断点所在的行号， enabled 断点是否启用。

当一个断点被添加、删除时发出此信号。有关何时应该发出此信号，请参见setBreakpoint和setBreakpoints函数的文档说明。

由于写入此类的文件路径理应都是绝对路径，因此期望这个函数的 filePath 也是绝对路径。

此外，YSS约定，行号从0开始计数。

这个function 从 YSS 0.15.0 开始支持。

[signal, since YSS 0.15.0] void DebugServer::breakpointHited(const QString &filePath, qint32 lineNumber)

filePath 断点所在的文件路径， lineNumber 断点所在的行号。

当程序执行过程中命中了一个断点时发出此信号。

由于写入此类的文件路径理应都是绝对路径，因此期望这个函数的 filePath 也是绝对路径。

此外，YSS约定，行号从0开始计数。

这个function 从 YSS 0.15.0 开始支持。

[static, since YSS 0.15.0] QString DebugServer::getActionString(YSSCore::Editor::DebugServer::DebugAction action)

action 调试操作名称

return 调试操作名称的字符串表示形式。

这个function 从 YSS 0.15.0 开始支持。

[virtual, since YSS 0.15.0] QMap<QString, QList<qint32>> DebugServer::getBreakpoints()

return 断点信息。插件可以重写此函数来实现具体的获取断点信息功能。

返回值是一个QMap，键是文件路径，值是该文件中所有断点所在的行号列表。 YSS约定，行号从0开始计数。

由于setBreakpoint时使用的理应是绝对路径，因此期望这里返回的也是绝对路径。

YSS会在保存项目时，通过调用此函数保存断点信息。不过在保存时，会 自动根据文件是项目内文件还是项目外文件，来将路径转换为相对路径或绝对路径 存储，避免项目移动后丢失断点信息。

这个function 从 YSS 0.15.0 开始支持。

[since YSS 0.13.0] YSSCore::Editor::DebugServer::SupportedDebugFeature DebugServer::getSupportedFeatures()

return 这个DebugServer支持的调试功能。

这个function 从 YSS 0.13.0 开始支持。

[virtual, since YSS 0.13.0] void DebugServer::onBuild(bool rebuild)

当构建操作开始时调用此函数。插件可以重写此函数来实现具体的构建功能。 rebuild 是否是全部重新构建。

对YSS而言，构建指的是，通过一定步骤将项目已有内容进行转换， 以进行后续操作的过程。从“已有内容”到“后续操作”间的这个“构建” 步骤理应是无法被跳过的。

为了性能考虑，构建操作并不总是一定要通过处理整个项目进行构建， 这个时候 rebuild 即是false，指示实现可以根据需要有选择的进行构建。 相反，如果 rebuild 是true，则指示实现需要进行全部重新构建。

实现应首先保证全部重新构建的功能完整实现，然后再考虑在 rebuild 为false时的优化实现。

构建开始时，发出actionStarted信号，构建过程中根据需要发出actionPercent和actionMessage 信号，构建完成时发出actionFinished信号。

这个function 从 YSS 0.13.0 开始支持。

[virtual, since YSS 0.13.0] void DebugServer::onClean(bool includeTarget)

当清理构建产物操作开始时调用此函数。插件可以重写此函数来实现具体的清理构建产物功能。 includeTarget 是否包括输出文件。

这个函数被调用时，如果 includeTarget 为false，则只应该清理 构建过程中产生的中间文件，而不应该清理输出文件。相反，如果 includeTarget 为true， 则应该清理包括输出文件在内的所有构建产物。

实现应首先保证包括输出文件在内的全部清理功能完整实现，然后再考虑在 includeTarget 为false时的优化实现。

清理开始时，发出actionStarted信号，清理过程中根据需要发出actionPercent和actionMessage 信号，清理完成时发出actionFinished信号。

这个function 从 YSS 0.13.0 开始支持。

[virtual, since YSS 0.13.0] void DebugServer::onContinue()

当继续操作开始时调用此函数。插件可以重写此函数来实现具体的继续功能。

继续操作开始时，发出actionStarted信号，继续操作完成时发出actionFinished信号。

如果继续操作有错，可以通过actionMessage信号来输出错误信息，并在适当的时候发出actionFinished信号，且将success设置为false。

YSS不处理DebugAction为Continue时的actionPercent信号。

这个function 从 YSS 0.13.0 开始支持。

[virtual, since YSS 0.13.0] void DebugServer::onRun(bool debug)

当运行程序操作开始时调用此函数。插件可以重写此函数来实现具体的运行程序功能。 debug 是否以调试模式运行。

YSS不要求优先实现带有调试的运行。对于调试功能的具体实现视实际情况而定。

值得指出的常见误区是，对于程序编译而言，调试模式运行不等于Debug方案编译， Release编译的程序同样可以以调试模式运行，反之亦然。因此这个函数的实现不应该 将其连带视作对编译方案的要求，而应该仅仅关注于运行时的调试功能。

运行开始时，发出actionStarted信号，运行完成时发出actionFinished信号。

运行过程中，可以通过targetStdOutput和targetStdError信号来输出目标的标准输出和标准错误。

如果运行有错，可以通过actionMessage信号来输出错误信息，并在适当的时候发出actionFinished信号，且将success设置为false。

YSS不处理DebugAction为Run或DebugRun时的actionPercent信号。

这个function 从 YSS 0.13.0 开始支持。

[virtual, since YSS 0.13.0] void DebugServer::onStepInto()

当单步进入操作开始时调用此函数。插件可以重写此函数来实现具体的单步进入功能。

单步操作开始时，发出actionStarted信号，单步操作完成时发出actionFinished信号。

如果单步操作有错，可以通过actionMessage信号来输出错误信息，并在适当的时候发出actionFinished信号，且将success设置为false。

YSS不处理DebugAction为StepInto时的actionPercent信号。

这个function 从 YSS 0.13.0 开始支持。

[virtual, since YSS 0.13.0] void DebugServer::onStepOver()

当单步跳过操作开始时调用此函数。插件可以重写此函数来实现具体的单步跳过功能。

单步操作开始时，发出actionStarted信号，单步操作完成时发出actionFinished信号。

如果单步操作有错，可以通过actionMessage信号来输出错误信息，并在适当的时候发出actionFinished信号，且将success设置为false。

YSS不处理DebugAction为StepOver时的actionPercent信号。

这个function 从 YSS 0.13.0 开始支持。

[virtual, since YSS 0.13.0] void DebugServer::onStop()

当停止操作开始时调用此函数。插件可以重写此函数来实现具体的停止功能。

停止操作开始时，发出actionStarted信号，停止操作完成时发出actionFinished信号。

如果停止操作有错，可以通过actionMessage信号来输出错误信息，并在适当的时候发出actionFinished信号，且将success设置为false。

YSS不处理DebugAction为Stop时的actionPercent信号。

这个function 从 YSS 0.13.0 开始支持。

[virtual, since YSS 0.13.0] void DebugServer::onSuspend()

当暂停操作开始时调用此函数。插件可以重写此函数来实现具体的暂停功能。

暂停操作开始时，发出actionStarted信号，暂停操作完成时发出actionFinished信号。

如果暂停操作有错，可以通过actionMessage信号来输出错误信息，并在适当的时候发出actionFinished信号，且将success设置为false。

YSS不处理DebugAction为Suspend时的actionPercent信号。

这个function 从 YSS 0.13.0 开始支持。

[virtual, since YSS 0.13.0] void DebugServer::setBreakpoint(const QString &filePath, qint32 lineNumber, bool enabled = true)

设置断点。插件可以重写此函数来实现具体的设置断点功能。 filePath 断点所在的文件路径， lineNumber 断点所在的行号， enabled 断点是否启用。 YSS约定，行号从0开始计数。 当一个断点被添加、删除时，应该发出breakpointChanged信号，以通知编辑器断点信息的变化。

传入这个函数的文件路径理应是绝对路径。

这个function 从 YSS 0.13.0 开始支持。

[virtual, since YSS 0.15.0] void DebugServer::setBreakpoints(const QMap<QString, QList<qint32>> &breakpoints)

设置断点信息。插件可以重写此函数来实现具体的设置断点信息功能。 breakpoints 断点信息，键是文件路径，值是该文件中所有断点所在的行号列表。

这个函数传入的路径理应是绝对路径。

对于传入的断点信息，插件应该将其保存起来，并对其中的每一条断点信息， 发出breakpointChanged信号，以通知编辑器断点信息的变化。

YSS会在加载项目时，通过调用此函数加载断点信息。在加载时，会自动将 所有路径转换为绝对路径。

此外，YSS约定，行号从0开始计数。

这个function 从 YSS 0.15.0 开始支持。

[since YSS 0.13.0] void DebugServer::setSupportedFeatures(YSSCore::Editor::DebugServer::SupportedDebugFeature features)

features 这个DebugServer支持的调试功能。

设置这个DebugServer支持的调试功能。

这个function 从 YSS 0.13.0 开始支持。

[virtual, since YSS 0.15.0] void DebugServer::writeTargetStdInput(const QString &input)

YSS通过此函数将一些输入发送给正在调试的程序。插件可以重写此函数来实现具体的向目标程序发送输入的功能。 input 发送的输入内容。

这个function 从 YSS 0.15.0 开始支持。