跳到正文
Yayin Story Studio Yayin Story Studio 项目文档

Contents

YSSFileExt Namespace

Yayin Story Studio 文件扩展插件（YSS File Extensions）的根命名空间. 详情...

头文件： #include <YSSFileExt>
自以下版本： Yayin Story Studio 0.16.0

类

(自 YSS 0.16.0 引入) class IniLangHighlighter
(自 YSS 0.16.0 引入) class IniLangServer
(自 YSS 0.16.0 引入) class JsonLangDiagnosticData
(自 YSS 0.16.0 引入) class JsonLangDocument
(自 YSS 0.16.0 引入) class JsonLangHighlighter
(自 YSS 0.16.0 引入) class JsonLangServer
(自 YSS 0.16.0 引入) struct JsonToken
(自 YSS 0.16.0 引入) class SimpleFileTemplateInitWidget
(自 YSS 0.16.0 引入) class SimpleFileTemplateProvider
(自 YSS 0.16.0 引入) class TomlLangHighlighter
(自 YSS 0.16.0 引入) class TomlLangServer
(自 YSS 0.16.0 引入) class XmlLangHighlighter
(自 YSS 0.16.0 引入) class XmlLangServer
(自 YSS 0.16.0 引入) class YSSLangDiagnosticData
(自 YSS 0.16.0 引入) class YSSLangDocument
(自 YSS 0.16.0 引入) class YSSLangHighlighter
(自 YSS 0.16.0 引入) class YamlLangHighlighter
(自 YSS 0.16.0 引入) class YamlLangServer

类型别名

(自 YSS 0.16.0 引入) enum class JsonTokenType { Invalid, EndOfFile, LBrace, RBrace, LBracket, …, Unexpected }
(自 YSS 0.16.0 引入) YSSLangAnalyzeFn

Functions

(自 YSS 0.16.0 引入) QList<YSSFileExt::JsonToken> lexJsonLine(const QString &line, qint32 baseLine, QList<YSSFileExt::JsonLangDiagnosticData> *diagnostics = nullptr)

详细说明

所有 YSS File Extensions 插件的组件均在此命名空间下。

类

class IniLangHighlighter

INI 语法高亮器：按主题样式着色 INI 单元（节、键、值、注释）. 详情...

class IniLangServer

INI 语言服务器：提供 Visindigo 2024（Light/Dark）主题着色与 INI 语法诊断. 详情...

class JsonLangDiagnosticData

一条 JSON 语法诊断信息（行、列、长度、类型、消息与修复建议）. 详情...

class JsonLangDocument

对整个 JSON 文档的封装：维护行内容、进行全文档语法分析并存储逐行诊断. 详情...

class JsonLangHighlighter

JSON 语法高亮器：按主题样式着色 JSON 单元，并渲染 JsonLangDocument 产出的诊断消息. 详情...

class JsonLangServer

JSON 语言服务器：提供 Visindigo 2024（Light/Dark）主题着色与 JSON 语法错误诊断. 详情...

class JsonToken

一个 JSON 词法单元，含类型、文本及（行、列、长度）位置. 详情...

class SimpleFileTemplateInitWidget

极简新建文件初始化控件：输入文件名，在目标文件夹创建指定扩展名的空文件. 详情...

class SimpleFileTemplateProvider

基于 SimpleFileTemplateInitWidget 的通用空文件模板提供者. 详情...

class TomlLangHighlighter

TOML 语法高亮器：按主题样式着色 TOML 单元（表头、键、字符串、数字等）. 详情...

class TomlLangServer

TOML 语言服务器：提供 Visindigo 2024（Light/Dark）主题着色与 TOML 语法诊断. 详情...

class XmlLangHighlighter

XML 语法高亮器：按主题样式着色 XML 单元（标签、属性、注释、CDATA 等）. 详情...

class XmlLangServer

XML 语言服务器：提供 Visindigo 2024（Light/Dark）主题着色与 XML 语法诊断. 详情...

class YSSLangDiagnosticData

一条通用语法诊断信息（行、列、长度、严重级别、代码与修复建议）. 详情...

class YSSLangDocument

通用语言文档：维护行内容、防抖全文档分析并存储逐行诊断. 详情...

class YSSLangHighlighter

通用语法高亮器基类：缓存当前主题、按样式键着色并渲染文档诊断. 详情...

class YamlLangHighlighter

YAML 语法高亮器：按主题样式着色 YAML 单元（键、字符串、注释、锚点等）. 详情...

class YamlLangServer

YAML 语言服务器：提供 Visindigo 2024（Light/Dark）主题着色与 YAML 语法诊断. 详情...

Type Documentation

[since YSS 0.16.0] enum class YSSFileExt::JsonTokenType

JSON 词法单元类型。

ConstantValueDescription
YSSFileExt::JsonTokenType::Invalid0无效单元，用于默认初始化，分析过程中不应出现。
YSSFileExt::JsonTokenType::EndOfFile1文件结束标记，不会出现在 lexJsonLine() 的返回列表中。
YSSFileExt::JsonTokenType::LBrace2左花括号。
YSSFileExt::JsonTokenType::RBrace3右花括号。
YSSFileExt::JsonTokenType::LBracket4左方括号。
YSSFileExt::JsonTokenType::RBracket5右方括号。
YSSFileExt::JsonTokenType::Colon6冒号。
YSSFileExt::JsonTokenType::Comma7逗号。
YSSFileExt::JsonTokenType::String8字符串字面量，含首尾引号。
YSSFileExt::JsonTokenType::Number9数字字面量，含整数、小数与指数形式。
YSSFileExt::JsonTokenType::True10布尔值 true。
YSSFileExt::JsonTokenType::False11布尔值 false。
YSSFileExt::JsonTokenType::Null12空值 null。
YSSFileExt::JsonTokenType::Unexpected13其它意外字符或单元，属于词法错误，会附带诊断信息。

这个enum 从 YSS 0.16.0 开始支持。

[alias, since YSS 0.16.0] YSSFileExt::YSSLangAnalyzeFn

全文档分析函数：输入文档全部行，产出诊断列表，由各语言提供。

这个typedef 从 YSS 0.16.0 开始支持。

Function Documentation

[since YSS 0.16.0] QList<YSSFileExt::JsonToken> YSSFileExt::lexJsonLine(const QString &line, qint32 baseLine, QList<YSSFileExt::JsonLangDiagnosticData> *diagnostics = nullptr)

对一行 JSON 文本进行词法分析。

line 待分析的单行文本；baseLine 该行在文档中的 0-based 行号。 diagnostics 非空时，将词法级错误（未闭合字符串、无效数字等）追加到其中。 return 该行的词法单元列表（不含 EndOfFile）。

这个function 从 YSS 0.16.0 开始支持。