validator

type CheckResult struct {
	// Name 是校验阶段的英文名称。
	Name string `json:"name"`
	// NameZh 是校验阶段的中文名称。
	NameZh string `json:"name_zh,omitempty"`
	// Status 是校验阶段的英文状态。
	Status string `json:"status"`
	// StatusZh 是校验阶段的中文状态。
	StatusZh string `json:"status_zh,omitempty"`
}

type InputInfo struct {
	// Path 是被校验的输入文件路径或名称。
	Path string `json:"path"`
	// Size 是输入数据的字节数。
	Size int64 `json:"size"`
}

type Issue struct {
	// Severity 是问题的英文严重程度。
	Severity Severity `json:"severity"`
	// SeverityZh 是问题严重程度的中文名称。
	SeverityZh string `json:"severity_zh,omitempty"`
	// Stage 是问题所属校验阶段的英文名称。
	Stage Stage `json:"stage"`
	// StageZh 是问题所属校验阶段的中文名称。
	StageZh string `json:"stage_zh,omitempty"`
	// Code 是问题的机器可读代码。
	Code string `json:"code"`
	// EngineCode 是底层校验引擎提供的问题代码。
	EngineCode string `json:"engine_code,omitempty"`
	// Clause 是本问题依据的标准条款，供档案系统按条款筛选与统计。
	//
	// 此前条款号只混在 Message 的自然语言里，JSON 输出无法按条款检索；同一判据
	// 在不同宿主下依据不同条款时列出全部条款。
	Clause []string `json:"clause,omitempty"`
	// Message 是问题的详细描述。
	Message string `json:"message"`
	// Hint 是针对问题的处理提示。
	Hint string `json:"hint,omitempty"`
	// File 是问题所在的包内文件路径。
	File string `json:"file,omitempty"`
	// Path 是问题所在的 XML 路径。
	Path string `json:"path,omitempty"`
	// Line 是问题所在的行号。
	Line int `json:"line,omitempty"`
	// Column 是问题所在的列号。
	Column int `json:"column,omitempty"`
}

type MissingReference struct {
	// From 是引用所在条目。
	From string
	// Value 是引用处的原始文本或属性值。
	Value string
	// Path 是解析后的目标路径。
	Path string
}

type Mode string

type Option func(*Options)

type Options struct {
	// Mode 指定校验严格程度。
	Mode Mode
	// MaxErrors 指定最多记录的错误数量，0 表示不限制。
	MaxErrors int
	// MaxInputSize 指定 ZIP 原始输入数据的大小上限，0 表示不限制。
	MaxInputSize int64
	// MaxFileSize 指定单个 ZIP 条目解压后的大小上限。
	MaxFileSize int64
	// MaxTotalSize 指定整个 OFD 包解压后的大小上限。
	MaxTotalSize int64
	// MaxEntries 指定 ZIP 条目数量上限。
	MaxEntries int
	// MaxXMLBytes 指定单个 XML 文件的大小上限。
	MaxXMLBytes int64
	// MaxXMLNodes 指定单个 XML 文档的节点数量上限。
	MaxXMLNodes int
	// MaxXMLDepth 指定单个 XML 文档的嵌套深度上限。
	MaxXMLDepth int
	// CheckXSD 指定是否执行 XSD 校验。
	CheckXSD bool
	// ScanXML 指定是否扫描未被主引用链到达的 XML 文件。
	ScanXML bool
	// CheckDigest 指定是否校验签名摘要。
	CheckDigest bool
	// FailOnWarning 指定是否将警告视为失败。
	FailOnWarning bool
	// Schemas 指定使用的 XSD 模式集合。
	Schemas *schema.Set
	// DocType 指定要额外校验的 OFD profile，取值同 OFD.xml 根节点的 DocType
	// 属性。留空表示按文档声明的值自动判定：声明 OFD-A 时应用 GB/T 42133 的
	// 规则，声明 OFD-H 时在其基础上叠加电子病历要求，基础 OFD 不做 profile
	// 校验。
	DocType string
	// CheckProfile 控制是否执行 profile 校验。Profile 非空时会自动启用，
	// 显式设为 false 可只做基础模式校验。
	CheckProfile bool
}

type PDFOptions struct {
	// Font 指定报告使用的字体文件；未指定时自动查找支持中文的系统字体。
	Font string
}

type ReferenceIndex struct {
	// Reachable 是从 OFD.xml 出发、经嵌套引用可达的条目集合，含 OFD.xml 本身。
	// 目录条目不在其中。
	Reachable map[string]bool
	// Missing 是引用了但包内不存在的条目。它们不改变可达集合，但意味着
	// 输入本身有悬空引用，判断「某条目是否无人引用」时要留意这一前提。
	Missing []MissingReference
	// Escaped 是越过包根目录的非法路径引用。
	Escaped []string
	// Unparsed 是被引用到但无法解析的 XML。命名空间或根元素不符时引用识别
	// 不可信，该文件里的引用全部收集不到。
	//
	// 这一项直接决定能否删除条目：test/testdata/intro.ofd 的命名空间缺
	// "/2016" 后缀，解析失败后它引用的 74 个字体会全部落进「无人引用」，
	// 照单删除就是在真实文件上毁数据。
	Unparsed []string
}

type Report struct {
	// SchemaVersion 是报告模型的版本号。
	SchemaVersion string `json:"schema_version"`
	// Tool 是生成报告的工具信息。
	Tool ToolInfo `json:"tool"`
	// Input 是被校验的输入文件信息。
	Input InputInfo `json:"input"`
	// Status 是整个 OFD 包的校验结论。
	Status Status `json:"status"`
	// StatusZh 是校验结论的中文名称。
	StatusZh string `json:"status_zh,omitempty"`
	// Summary 是报告中的问题和文件数量汇总。
	Summary Summary `json:"summary"`
	// Checks 是各校验阶段的结果列表。
	Checks []CheckResult `json:"checks"`
	// Profile 是本次实际应用的 OFD profile（DocType 取值），为空表示未做
	// profile 校验。校验行为随文件声明变化，报告需显式给出依据。
	//
	// 它记录的是“按哪套规则校验的”，未必等于文件声明的值：用 --doc-type OFD-A
	// 预检一份基础 OFD 时此处为 OFD-A，而文件本身仍声明 OFD。因此这里用
	// Profile 而非 DocType，避免被误读成文件自身的 DocType。
	Profile string `json:"profile,omitempty"`
	// Issues 是校验发现的问题列表。
	Issues []Issue `json:"issues"`
	// StartedAt 是校验开始时间。
	StartedAt time.Time `json:"started_at"`
	// DurationMS 是校验耗时，单位为毫秒。
	DurationMS int64 `json:"duration_ms"`
}

type Severity string

type Stage string

type Status string

type Summary struct {
	// Errors 是错误数量。
	Errors int `json:"errors"`
	// Warnings 是警告数量。
	Warnings int `json:"warnings"`
	// Infos 是提示数量。
	Infos int `json:"infos"`
	// Files 是包内文件数量。
	Files int `json:"files"`
}

type ToolInfo struct {
	// Name 是生成报告的工具名称。
	Name string `json:"name"`
	// Version 是生成报告的工具版本。
	Version string `json:"version"`
}

type Validator struct {
	// contains filtered or unexported fields
}