analyzer

type AnnotationInfo struct {
	// DocumentIndex 是注解所属文档体在报告中的索引。
	DocumentIndex int `json:"document_index"`
	// PageID 是注解所属页面的 ID。
	PageID uint64 `json:"page_id"`
	// ID 是注解 ID。
	ID string `json:"id"`
	// Type 是注解类型。
	Type string `json:"type"`
	// Subtype 是注解子类型。
	Subtype string `json:"subtype,omitempty"`
	// Creator 是注解创建者。
	Creator string `json:"creator,omitempty"`
	// Visible 表示注解是否可见。
	Visible bool `json:"visible"`
	// Print 表示注解是否打印。
	Print bool `json:"print"`
	// HasAppearance 表示注解是否包含外观。
	HasAppearance bool `json:"has_appearance"`
	// Objects 是注解外观对象计数。
	Objects ObjectCounts `json:"objects"`
}

type AttachmentInfo struct {
	// DocumentIndex 是附件所属文档体在报告中的索引。
	DocumentIndex int `json:"document_index"`
	// ID 是附件 ID。
	ID string `json:"id"`
	// Name 是附件名称。
	Name string `json:"name"`
	// Format 是附件格式。
	Format *string `json:"format,omitempty"`
	// Path 是附件文件路径。
	Path string `json:"path"`
	// DeclaredSize 是附件声明的大小，单位为字节。
	DeclaredSize *float64 `json:"declared_size,omitempty"`
	// ActualSize 是附件实际大小，单位为字节。
	ActualSize uint64 `json:"actual_size,omitempty"`
	// Exists 表示附件文件是否存在。
	Exists bool `json:"exists"`
	// Visible 表示附件是否可见。
	Visible bool `json:"visible"`
	// Usage 是附件用途。
	Usage string `json:"usage,omitempty"`
}

type DocumentInfo struct {
	// Index 是文档体在报告中的索引。
	Index int `json:"index"`
	// DocID 是文档体 ID。
	DocID string `json:"doc_id"`
	// Title 是文档标题。
	Title *string `json:"title,omitempty"`
	// Author 是文档作者。
	Author *string `json:"author,omitempty"`
	// Subject 是文档主题。
	Subject *string `json:"subject,omitempty"`
	// Abstract 是文档摘要。
	Abstract *string `json:"abstract,omitempty"`
	// CreationDate 是文档创建时间。
	CreationDate *time.Time `json:"creation_date,omitempty"`
	// ModDate 是文档修改时间。
	ModDate *time.Time `json:"mod_date,omitempty"`
	// DocUsage 是文档用途。
	DocUsage *string `json:"doc_usage,omitempty"`
	// Creator 是文档创建程序。
	Creator *string `json:"creator,omitempty"`
	// CreatorVersion 是文档创建程序版本。
	CreatorVersion *string `json:"creator_version,omitempty"`
	// Keywords 是文档关键词列表。
	Keywords []string `json:"keywords,omitempty"`
	// DocRoot 是文档根文件路径。
	DocRoot string `json:"doc_root"`
	// DeclaredPages 是文档声明的页面数。
	DeclaredPages int `json:"declared_pages"`
	// ParsedPages 是成功解析的页面数。
	ParsedPages int `json:"parsed_pages"`
	// TemplateCount 是文档模板数量。
	TemplateCount int `json:"template_count"`
	// ResourceFiles 是文档资源文件数。
	ResourceFiles int `json:"resource_files"`
	// HasCover 表示文档是否包含封面。
	HasCover bool `json:"has_cover"`
	// HasAttachments 表示文档是否包含附件。
	HasAttachments bool `json:"has_attachments"`
	// HasAnnotations 表示文档是否包含注解。
	HasAnnotations bool `json:"has_annotations"`
	// HasSignatures 表示文档是否包含签名。
	HasSignatures bool `json:"has_signatures"`
}

type DrawParamResourceSummary struct {
	// ResourceSummary 是通用资源统计字段。
	ResourceSummary
	// InheritanceCycles 是绘制参数继承环数量。
	InheritanceCycles int `json:"inheritance_cycles"`
}

type FontResourceSummary struct {
	// ResourceSummary 是通用资源统计字段。
	ResourceSummary
	// Embedded 是嵌入字体数。
	Embedded int `json:"embedded"`
}

type InputInfo struct {
	// Path 是输入文件路径。
	Path string `json:"path"`
	// Size 是输入内容大小，单位为字节。
	Size int64 `json:"size,omitempty"`
}

type OFDInfo struct {
	// Version 是 OFD 根元素声明的版本。
	Version string `json:"version"`
	// DocType 是 OFD 根元素声明的文档类型。
	DocType string `json:"doc_type"`
}

type ObjectCounts struct {
	// Total 是对象总数。
	Total int `json:"total"`
	// Text 是文字对象数。
	Text int `json:"text"`
	// Path 是路径对象数。
	Path int `json:"path"`
	// Image 是图片对象数。
	Image int `json:"image"`
	// Composite 是复合对象数。
	Composite int `json:"composite"`
	// PageBlock 是页面块对象数。
	PageBlock int `json:"page_block"`
	// PathCommands 是路径命令总数。
	PathCommands int `json:"path_commands"`
}

type ObjectSummary struct {
	// Total 是对象总数。
	Total int `json:"total"`
	// Pages 是包含对象统计的页面数。
	Pages int `json:"pages"`
	// AnnotationAppearances 是已展开分析的注解外观数。
	AnnotationAppearances int `json:"annotation_appearances"`
	// AnnotationObjectCounts 是注解外观对象计数。
	AnnotationObjectCounts ObjectCounts `json:"annotation_object_counts"`
	// Text 是文字对象数。
	Text int `json:"text"`
	// Path 是路径对象数。
	Path int `json:"path"`
	// Image 是图片对象数。
	Image int `json:"image"`
	// Composite 是复合对象数。
	Composite int `json:"composite"`
	// PageBlock 是页面块对象数。
	PageBlock int `json:"page_block"`
	// PathCommands 是路径命令总数。
	PathCommands int `json:"path_commands"`
	// MaxPageBlockDepth 是页面块的最大嵌套深度。
	MaxPageBlockDepth int `json:"max_page_block_depth"`
}

type Option func(*Options)

type Options struct {
	// IncludeTemplates 是否分析模板定义、引用和模板 PageRes 资源。默认开启。
	IncludeTemplates bool
	// IncludeAnnotations 是否分析注解及其外观。默认开启。
	IncludeAnnotations bool
	// IncludeSignatures 是否分析签名清单。默认开启。
	IncludeSignatures bool
	// IncludeTree 是否输出 ZIP 包目录树。默认关闭。
	IncludeTree bool
}

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

type PackageSummary struct {
	// Entries 是 ZIP 包条目总数。
	Entries int `json:"entries"`
	// Files 是 ZIP 包文件条目数。
	Files int `json:"files"`
	// Directories 是 ZIP 包目录条目数。
	Directories int `json:"directories"`
	// XMLFiles 是 ZIP 包 XML 文件数。
	XMLFiles int `json:"xml_files"`
	// CompressedBytes 是 ZIP 包条目的压缩后总字节数。
	CompressedBytes uint64 `json:"compressed_bytes"`
	// UncompressedBytes 是 ZIP 包条目的未压缩总字节数。
	UncompressedBytes uint64 `json:"uncompressed_bytes"`
	// Tree 是 ZIP 包目录树根节点。
	Tree *PackageTree `json:"tree,omitempty"`
}

type PackageTree struct {
	// Name 是当前节点的名称。
	Name string `json:"name"`
	// Path 是当前节点在 ZIP 包中的路径。
	Path string `json:"path,omitempty"`
	// Kind 是当前节点的类型。
	Kind string `json:"kind"`
	// MediaType 是当前节点的媒体类型。
	MediaType string `json:"media_type,omitempty"`
	// Size 是当前节点的未压缩大小，单位为字节。
	Size uint64 `json:"size"`
	// CompressedSize 是当前节点的压缩后大小，单位为字节。
	CompressedSize uint64 `json:"compressed_size"`
	// Duplicate 表示当前节点是否为重复条目。
	Duplicate bool `json:"duplicate,omitempty"`
	// Children 是当前目录节点的子节点列表。
	Children []PackageTree `json:"children,omitempty"`
}

type PageInfo struct {
	// DocumentIndex 是所属文档体在报告中的索引。
	DocumentIndex int `json:"document_index"`
	// DocumentPage 是页面在所属文档体中的序号。
	DocumentPage int `json:"document_page"`
	// PageNumber 是页面在全局分析结果中的页码。
	PageNumber int `json:"page_number"`
	// ID 是页面 ID。
	ID uint64 `json:"id"`
	// BaseLoc 是页面资源引用的基准位置。
	BaseLoc string `json:"base_loc,omitempty"`
	// Layers 是页面图层数。
	Layers int `json:"layers"`
	// Size 是页面物理尺寸信息。
	Size PageSize `json:"size"`
	// Objects 是页面对象计数。
	Objects ObjectCounts `json:"objects"`
	// Text 是页面文字统计。
	Text TextSummary `json:"text"`
	// Resources 是页面直接引用的资源 ID。
	Resources PageResources `json:"resources"`
}

type PageResources struct {
	// Images 是页面直接引用的图片资源 ID。
	Images []uint64 `json:"images,omitempty"`
	// Fonts 是页面直接引用的字体资源 ID。
	Fonts []uint64 `json:"fonts,omitempty"`
	// Templates 是页面直接引用的模板资源 ID。
	Templates []uint64 `json:"templates,omitempty"`
	// DrawParams 是页面直接引用的绘制参数资源 ID。
	DrawParams []uint64 `json:"draw_params,omitempty"`
	// Composites 是页面直接引用的复合对象资源 ID。
	Composites []uint64 `json:"composites,omitempty"`
	// ColorSpaces 是页面直接引用的颜色空间资源 ID。
	ColorSpaces []uint64 `json:"color_spaces,omitempty"`
}

type PageSize struct {
	// X 是页面物理框的 X 坐标。
	X float64 `json:"x"`
	// Y 是页面物理框的 Y 坐标。
	Y float64 `json:"y"`
	// Width 是页面物理宽度。
	Width float64 `json:"width"`
	// Height 是页面物理高度。
	Height float64 `json:"height"`
	// Unit 是尺寸单位。
	Unit string `json:"unit"`
	// Orientation 是页面方向。
	Orientation string `json:"orientation"`
	// Source 是页面尺寸的来源。
	Source string `json:"source"`
}

type ReferenceEdge struct {
	// From 是引用关系的起点。
	From string `json:"from"`
	// To 是引用关系的目标。
	To string `json:"to"`
	// Type 是引用关系的类型。
	Type string `json:"type"`
	// Source 是引用关系的来源位置。
	Source string `json:"source,omitempty"`
	// Exists 表示引用目标是否存在。
	Exists bool `json:"exists"`
	// Count 是相同引用关系出现的次数。
	Count int `json:"count"`
}

type Report struct {
	// SchemaVersion 是报告 JSON 模式的版本。
	SchemaVersion string `json:"schema_version"`
	// Tool 是生成报告的工具信息。
	Tool ToolInfo `json:"tool"`
	// Input 是被分析输入的信息。
	Input InputInfo `json:"input"`
	// Status 是分析结果的完整性状态。
	Status Status `json:"status"`
	// Warnings 是分析过程中产生的警告信息。
	Warnings []string `json:"warnings,omitempty"`
	// Errors 是分析过程中产生的错误信息。
	Errors []string `json:"errors,omitempty"`
	// OFD 是 OFD 根元素的信息。
	OFD OFDInfo `json:"ofd"`
	// Package 是 ZIP 包的统计信息。
	Package PackageSummary `json:"package"`
	// Summary 是文档级汇总统计。
	Summary Summary `json:"summary"`
	// Documents 是文档体信息列表。
	Documents []DocumentInfo `json:"documents"`
	// Pages 是页面信息列表。
	Pages []PageInfo `json:"pages"`
	// Objects 是对象汇总统计。
	Objects ObjectSummary `json:"objects"`
	// Text 是页面正文文字统计。
	Text TextSummary `json:"text"`
	// TemplateText 是模板文字统计。
	TemplateText TextSummary `json:"template_text"`
	// AnnotationText 是注解外观文字统计。
	AnnotationText TextSummary `json:"annotation_text"`
	// Images 是图片资源统计。
	Images ResourceSummary `json:"images"`
	// Fonts 是字体资源统计。
	Fonts FontResourceSummary `json:"fonts"`
	// DrawParams 是绘制参数资源统计。
	DrawParams DrawParamResourceSummary `json:"draw_params"`
	// ColorSpaces 是颜色空间资源统计。
	ColorSpaces ResourceSummary `json:"color_spaces"`
	// Templates 是模板资源统计。
	Templates ResourceSummary `json:"templates"`
	// Composites 是复合对象资源统计。
	Composites ResourceSummary `json:"composites"`
	// Patterns 是图案资源统计。
	Patterns ResourceSummary `json:"patterns"`
	// Resources 是所有资源的汇总统计。
	Resources ResourceSummary `json:"resources"`
	// ResourceDetails 是资源定义及使用情况列表。
	ResourceDetails []ResourceInfo `json:"resource_details"`
	// Attachments 是附件清单。
	Attachments []AttachmentInfo `json:"attachments"`
	// Annotations 是注解清单。
	Annotations []AnnotationInfo `json:"annotations"`
	// Signatures 是签名清单。
	Signatures []SignatureInfo `json:"signatures"`
	// FileReferences 是文件引用关系列表。
	FileReferences []ReferenceEdge `json:"file_references"`
	// IDReferences 是逻辑 ID 引用关系列表。
	IDReferences []ReferenceEdge `json:"id_references"`
}

type ResourceInfo struct {
	// DocumentIndex 是资源所属文档体在报告中的索引。
	DocumentIndex int `json:"document_index"`
	// ID 是资源 ID。
	ID uint64 `json:"id"`
	// Kind 是资源类型。
	Kind string `json:"kind"`
	// Scope 是资源定义的作用域。
	Scope string `json:"scope,omitempty"`
	// SourceFile 是资源定义所在的文件路径。
	SourceFile string `json:"source_file"`
	// Path 是资源关联的文件路径。
	Path string `json:"path,omitempty"`
	// Exists 表示关联文件是否存在。
	Exists bool `json:"exists"`
	// Used 是资源被使用的次数。
	Used int `json:"used"`
	// Embedded 表示资源是否嵌入文档。
	Embedded bool `json:"embedded"`
	// FontName 是字体名称。
	FontName string `json:"font_name,omitempty"`
	// FamilyName 是字体族名称。
	FamilyName string `json:"family_name,omitempty"`
	// Charset 是字体字符集。
	Charset string `json:"charset,omitempty"`
	// Italic 表示字体是否为斜体。
	Italic bool `json:"italic,omitempty"`
	// Bold 表示字体是否为粗体。
	Bold bool `json:"bold,omitempty"`
	// Serif 表示字体是否为衬线字体。
	Serif bool `json:"serif,omitempty"`
	// FixedWidth 表示字体是否为等宽字体。
	FixedWidth bool `json:"fixed_width,omitempty"`
}

type ResourceSummary struct {
	// Files 是资源文件数。
	Files int `json:"files"`
	// Declared 是声明的资源数。
	Declared int `json:"declared"`
	// Used 是被使用的资源数。
	Used int `json:"used"`
	// References 是资源引用次数。
	References int `json:"references"`
	// UniqueUsed 是被使用的不同资源数。
	UniqueUsed int `json:"unique_used"`
	// Unresolved 是无法解析的资源引用数。
	Unresolved int `json:"unresolved"`
	// MissingFiles 是缺失资源文件数。
	MissingFiles int `json:"missing_files"`
	// Unused 是未被使用的资源数。
	Unused int `json:"unused"`
	// ByType 是按资源类型统计的数量。
	ByType map[string]int `json:"by_type,omitempty"`
}

type SignatureInfo struct {
	// DocumentIndex 是签名所属文档体在报告中的索引。
	DocumentIndex int `json:"document_index"`
	// ID 是签名 ID。
	ID string `json:"id"`
	// Type 是签名类型。
	Type string `json:"type,omitempty"`
	// Path 是签名文件路径。
	Path string `json:"path,omitempty"`
	// Provider 是签名提供方名称。
	Provider string `json:"provider,omitempty"`
	// Company 是签名提供方公司名称。
	Company string `json:"company,omitempty"`
	// Version 是签名版本。
	Version string `json:"version,omitempty"`
	// Method 是签名方法。
	Method string `json:"method,omitempty"`
	// Date 是签名时间。
	Date string `json:"date,omitempty"`
	// CheckMethod 是签名引用校验方法。
	CheckMethod string `json:"check_method,omitempty"`
	// ReferenceCount 是签名引用数量。
	ReferenceCount int `json:"reference_count"`
	// StampCount 是签名印章注解数量。
	StampCount int `json:"stamp_count"`
	// Pages 是签名覆盖的页面 ID 列表。
	Pages []uint64 `json:"pages,omitempty"`
	// SignedValue 是签名值文件路径。
	SignedValue string `json:"signed_value,omitempty"`
	// SignedValueExists 表示签名值文件是否存在。
	SignedValueExists bool `json:"signed_value_exists"`
	// Seal 是印章文件路径。
	Seal string `json:"seal,omitempty"`
	// SealExists 表示印章文件是否存在。
	SealExists bool `json:"seal_exists"`
}

type Status string

type Summary struct {
	// DocumentBodies 是文档体数量。
	DocumentBodies int `json:"document_bodies"`
	// Pages 是页面总数。
	Pages int `json:"pages"`
	// ParsedPages 是成功解析的页面数。
	ParsedPages int `json:"parsed_pages"`
	// Objects 是对象总数。
	Objects int `json:"objects"`
	// PageObjects 是页面对象总数。
	PageObjects int `json:"page_objects"`
	// AnnotationObjects 是注解外观对象总数。
	AnnotationObjects int `json:"annotation_objects"`
	// TextCharacters 是文字字符总数。
	TextCharacters int `json:"text_characters"`
	// PageTextCharacters 是页面文字字符总数。
	PageTextCharacters int `json:"page_text_characters"`
	// AnnotationTextChars 是注解外观文字字符总数。
	AnnotationTextChars int `json:"annotation_text_characters"`
	// Images 是图片资源数量。
	Images int `json:"images"`
	// Fonts 是字体资源数量。
	Fonts int `json:"fonts"`
	// DrawParams 是绘制参数资源数量。
	DrawParams int `json:"draw_params"`
	// ColorSpaces 是颜色空间资源数量。
	ColorSpaces int `json:"color_spaces"`
	// Templates 是模板资源数量。
	Templates int `json:"templates"`
	// Composites 是复合对象资源数量。
	Composites int `json:"composites"`
	// Patterns 是图案资源数量。
	Patterns int `json:"patterns"`
	// Attachments 是附件数量。
	Attachments int `json:"attachments"`
	// Annotations 是注解数量。
	Annotations int `json:"annotations"`
	// Signatures 是签名数量。
	Signatures int `json:"signatures"`
}

type TextSummary struct {
	// Objects 是文字对象数。
	Objects int `json:"objects"`
	// TextCodes 是文字编码数量。
	TextCodes int `json:"text_codes"`
	// UTF8Bytes 是文字 UTF-8 编码的字节数。
	UTF8Bytes int `json:"utf8_bytes"`
	// UnicodeCodePoints 是 Unicode 码点数。
	UnicodeCodePoints int `json:"unicode_code_points"`
	// WhitespaceCodePoints 是空白 Unicode 码点数。
	WhitespaceCodePoints int `json:"whitespace_code_points"`
	// NonWhitespaceCodePoints 是非空白 Unicode 码点数。
	NonWhitespaceCodePoints int `json:"non_whitespace_code_points"`
	// Glyphs 是字形数量。
	Glyphs int `json:"glyphs"`
}

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