analyzer

package
v0.0.7 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 6, 2026 License: Unlicense Imports: 19 Imported by: 0

Documentation

Overview

Package analyzer 包提供 OFD 文档结构、对象、资源和引用关系分析能力。

Index

Constants

View Source 
const (
	// SchemaVersion 是分析工具 JSON 报告的模式版本。
	SchemaVersion = "1"
	// ToolVersion 是 analyzer 的工具版本。
	ToolVersion = "0.0.1"
)

Variables

This section is empty.

Functions

func AnalyzeTextCharacters 

func AnalyzeTextCharacters(value string) (bytes, codePoints int)

AnalyzeTextCharacters 返回字符串的 UTF-8 字节数和 Unicode 码点数。

func IsValidUTF8 

func IsValidUTF8(value string) bool

IsValidUTF8 判断字符串是否包含有效 UTF-8。

func RenderJSON 

func RenderJSON(writer io.Writer, report Report, pretty bool) error

RenderJSON 将分析报告写为 JSON。

func RenderMarkdown 

func RenderMarkdown(writer io.Writer, report Report) error

RenderMarkdown 将分析报告输出为中文 Markdown。

func RenderPDF 

func RenderPDF(writer io.Writer, report Report, options PDFOptions) error

RenderPDF 将分析报告渲染为可搜索文本的 PDF 文档。

func RenderText 

func RenderText(writer io.Writer, report Report) error

RenderText 将分析报告输出为中文纯文本。

func ValidateInputPath 

func ValidateInputPath(filename string) error

ValidateInputPath 检查输入路径是否为可读的普通文件，供 CLI 使用。

Types

type AnnotationInfo 

type AnnotationInfo struct {
	DocumentIndex int          `json:"document_index"`
	PageID        uint64       `json:"page_id"`
	ID            string       `json:"id"`
	Type          string       `json:"type"`
	Subtype       string       `json:"subtype,omitempty"`
	Creator       string       `json:"creator,omitempty"`
	Visible       bool         `json:"visible"`
	Print         bool         `json:"print"`
	HasAppearance bool         `json:"has_appearance"`
	Objects       ObjectCounts `json:"objects"`
}

AnnotationInfo 描述注解清单项。

type AttachmentInfo 

type AttachmentInfo struct {
	DocumentIndex int      `json:"document_index"`
	ID            string   `json:"id"`
	Name          string   `json:"name"`
	Format        *string  `json:"format,omitempty"`
	Path          string   `json:"path"`
	DeclaredSize  *float64 `json:"declared_size,omitempty"`
	ActualSize    uint64   `json:"actual_size,omitempty"`
	Exists        bool     `json:"exists"`
	Visible       bool     `json:"visible"`
	Usage         string   `json:"usage,omitempty"`
}

AttachmentInfo 描述附件清单项。

type DocumentInfo 

type DocumentInfo struct {
	Index          int        `json:"index"`
	DocID          string     `json:"doc_id"`
	Title          *string    `json:"title,omitempty"`
	Author         *string    `json:"author,omitempty"`
	Subject        *string    `json:"subject,omitempty"`
	Abstract       *string    `json:"abstract,omitempty"`
	CreationDate   *time.Time `json:"creation_date,omitempty"`
	ModDate        *time.Time `json:"mod_date,omitempty"`
	DocUsage       *string    `json:"doc_usage,omitempty"`
	Creator        *string    `json:"creator,omitempty"`
	CreatorVersion *string    `json:"creator_version,omitempty"`
	Keywords       []string   `json:"keywords,omitempty"`
	DocRoot        string     `json:"doc_root"`
	DeclaredPages  int        `json:"declared_pages"`
	ParsedPages    int        `json:"parsed_pages"`
	TemplateCount  int        `json:"template_count"`
	ResourceFiles  int        `json:"resource_files"`
	HasCover       bool       `json:"has_cover"`
	HasAttachments bool       `json:"has_attachments"`
	HasAnnotations bool       `json:"has_annotations"`
	HasSignatures  bool       `json:"has_signatures"`
}

DocumentInfo 描述一个文档体及其元数据。

type DrawParamResourceSummary 

type DrawParamResourceSummary struct {
	ResourceSummary
	InheritanceCycles int `json:"inheritance_cycles"`
}

DrawParamResourceSummary 是绘制参数资源统计。

type FontResourceSummary 

type FontResourceSummary struct {
	ResourceSummary
	Embedded int `json:"embedded"`
}

FontResourceSummary 是字体资源统计。

type InputInfo 

type InputInfo struct {
	Path string `json:"path"`
	Size int64  `json:"size,omitempty"`
}

InputInfo 描述被分析的输入。

type OFDInfo 

type OFDInfo struct {
	Version string `json:"version"`
	DocType string `json:"doc_type"`
}

OFDInfo 描述 OFD 根元素的属性。

type ObjectCounts 

type ObjectCounts struct {
	Total        int `json:"total"`
	Text         int `json:"text"`
	Path         int `json:"path"`
	Image        int `json:"image"`
	Composite    int `json:"composite"`
	PageBlock    int `json:"page_block"`
	PathCommands int `json:"path_commands"`
}

ObjectCounts 是单页面或单个对象容器的对象计数。

type ObjectSummary 

type ObjectSummary struct {
	Total                  int          `json:"total"`
	Pages                  int          `json:"pages"`
	AnnotationAppearances  int          `json:"annotation_appearances"`
	AnnotationObjectCounts ObjectCounts `json:"annotation_object_counts"`
	Text                   int          `json:"text"`
	Path                   int          `json:"path"`
	Image                  int          `json:"image"`
	Composite              int          `json:"composite"`
	PageBlock              int          `json:"page_block"`
	PathCommands           int          `json:"path_commands"`
	MaxPageBlockDepth      int          `json:"max_page_block_depth"`
}

ObjectSummary 是实际展开分析的页面对象和注解外观对象的汇总。

type Option 

type Option func(*Options)

Option 配置分析工具。

func WithAnnotations 

func WithAnnotations(enabled bool) Option

WithAnnotations 设置是否分析注解。

func WithPackage 

func WithPackage(enabled bool) Option

WithPackage 设置是否输出 ZIP 条目统计。

func WithSignatures 

func WithSignatures(enabled bool) Option

WithSignatures 设置是否分析签名。

func WithTemplates 

func WithTemplates(enabled bool) Option

WithTemplates 设置是否分析模板定义、引用和模板 PageRes 资源。 关闭后仍保留文档元数据中的模板数量和文档到模板文件的结构引用。

type Options 

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

Options 控制分析工具的统计范围。

type PDFOptions 

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

PDFOptions 配置 PDF 报告生成选项。

type PackageSummary 

type PackageSummary struct {
	Entries           int    `json:"entries"`
	Files             int    `json:"files"`
	Directories       int    `json:"directories"`
	XMLFiles          int    `json:"xml_files"`
	CompressedBytes   uint64 `json:"compressed_bytes"`
	UncompressedBytes uint64 `json:"uncompressed_bytes"`
}

PackageSummary 描述 ZIP 包的基本统计。

type PageInfo 

type PageInfo struct {
	DocumentIndex int           `json:"document_index"`
	DocumentPage  int           `json:"document_page"`
	PageNumber    int           `json:"page_number"`
	ID            uint64        `json:"id"`
	BaseLoc       string        `json:"base_loc,omitempty"`
	Layers        int           `json:"layers"`
	Size          PageSize      `json:"size"`
	Objects       ObjectCounts  `json:"objects"`
	Text          TextSummary   `json:"text"`
	Resources     PageResources `json:"resources"`
}

PageInfo 描述一个页面及其对象、文本和直接资源引用。

type PageResources 

type PageResources struct {
	Images      []uint64 `json:"images,omitempty"`
	Fonts       []uint64 `json:"fonts,omitempty"`
	Templates   []uint64 `json:"templates,omitempty"`
	DrawParams  []uint64 `json:"draw_params,omitempty"`
	Composites  []uint64 `json:"composites,omitempty"`
	ColorSpaces []uint64 `json:"color_spaces,omitempty"`
}

PageResources 描述页面内容直接引用的资源 ID。

type PageSize 

type PageSize struct {
	X           float64 `json:"x"`
	Y           float64 `json:"y"`
	Width       float64 `json:"width"`
	Height      float64 `json:"height"`
	Unit        string  `json:"unit"`
	Orientation string  `json:"orientation"`
	Source      string  `json:"source"`
}

PageSize 描述页面物理尺寸和方向。

type ReferenceEdge 

type ReferenceEdge struct {
	From   string `json:"from"`
	To     string `json:"to"`
	Type   string `json:"type"`
	Source string `json:"source,omitempty"`
	Exists bool   `json:"exists"`
	Count  int    `json:"count"`
}

ReferenceEdge 描述一条文件或逻辑 ID 引用关系。

type Report 

type Report struct {
	SchemaVersion   string                   `json:"schema_version"`
	Tool            ToolInfo                 `json:"tool"`
	Input           InputInfo                `json:"input"`
	Status          Status                   `json:"status"`
	Warnings        []string                 `json:"warnings,omitempty"`
	Errors          []string                 `json:"errors,omitempty"`
	OFD             OFDInfo                  `json:"ofd"`
	Package         PackageSummary           `json:"package"`
	Summary         Summary                  `json:"summary"`
	Documents       []DocumentInfo           `json:"documents"`
	Pages           []PageInfo               `json:"pages"`
	Objects         ObjectSummary            `json:"objects"`
	Text            TextSummary              `json:"text"`
	TemplateText    TextSummary              `json:"template_text"`
	AnnotationText  TextSummary              `json:"annotation_text"`
	Images          ResourceSummary          `json:"images"`
	Fonts           FontResourceSummary      `json:"fonts"`
	DrawParams      DrawParamResourceSummary `json:"draw_params"`
	ColorSpaces     ResourceSummary          `json:"color_spaces"`
	Templates       ResourceSummary          `json:"templates"`
	Composites      ResourceSummary          `json:"composites"`
	Patterns        ResourceSummary          `json:"patterns"`
	Resources       ResourceSummary          `json:"resources"`
	ResourceDetails []ResourceInfo           `json:"resource_details"`
	Attachments     []AttachmentInfo         `json:"attachments"`
	Annotations     []AnnotationInfo         `json:"annotations"`
	Signatures      []SignatureInfo          `json:"signatures"`
	FileReferences  []ReferenceEdge          `json:"file_references"`
	IDReferences    []ReferenceEdge          `json:"id_references"`
}

Report 是分析工具的稳定 JSON 报告模型。

func Analyze 

func Analyze(input any, options ...Option) (Report, error)

Analyze 分析一个 OFD 文件。输入支持文件路径、[]byte 和 io.Reader。

type ResourceInfo 

type ResourceInfo struct {
	DocumentIndex int    `json:"document_index"`
	ID            uint64 `json:"id"`
	Kind          string `json:"kind"`
	Scope         string `json:"scope,omitempty"`
	SourceFile    string `json:"source_file"`
	Path          string `json:"path,omitempty"`
	Exists        bool   `json:"exists"`
	Used          int    `json:"used"`
	Embedded      bool   `json:"embedded"`
	FontName      string `json:"font_name,omitempty"`
	FamilyName    string `json:"family_name,omitempty"`
	Charset       string `json:"charset,omitempty"`
	Italic        bool   `json:"italic,omitempty"`
	Bold          bool   `json:"bold,omitempty"`
	Serif         bool   `json:"serif,omitempty"`
	FixedWidth    bool   `json:"fixed_width,omitempty"`
}

ResourceInfo 描述一个资源定义及其使用情况。

type ResourceSummary 

type ResourceSummary struct {
	Files        int            `json:"files"`
	Declared     int            `json:"declared"`
	Used         int            `json:"used"`
	References   int            `json:"references"`
	UniqueUsed   int            `json:"unique_used"`
	Unresolved   int            `json:"unresolved"`
	MissingFiles int            `json:"missing_files"`
	Unused       int            `json:"unused"`
	ByType       map[string]int `json:"by_type,omitempty"`
}

ResourceSummary 是通用资源定义和引用统计。

type SignatureInfo 

type SignatureInfo struct {
	DocumentIndex     int      `json:"document_index"`
	ID                string   `json:"id"`
	Type              string   `json:"type,omitempty"`
	Path              string   `json:"path,omitempty"`
	Provider          string   `json:"provider,omitempty"`
	Company           string   `json:"company,omitempty"`
	Version           string   `json:"version,omitempty"`
	Method            string   `json:"method,omitempty"`
	Date              string   `json:"date,omitempty"`
	CheckMethod       string   `json:"check_method,omitempty"`
	ReferenceCount    int      `json:"reference_count"`
	StampCount        int      `json:"stamp_count"`
	Pages             []uint64 `json:"pages,omitempty"`
	SignedValue       string   `json:"signed_value,omitempty"`
	SignedValueExists bool     `json:"signed_value_exists"`
	Seal              string   `json:"seal,omitempty"`
	SealExists        bool     `json:"seal_exists"`
}

SignatureInfo 描述签名清单项。

type Status 

type Status string

Status 表示分析结果是否完整。 

const (
	StatusComplete Status = "complete"
	StatusPartial  Status = "partial"
	StatusFailed   Status = "failed"
)

type Summary 

type Summary struct {
	DocumentBodies      int `json:"document_bodies"`
	Pages               int `json:"pages"`
	ParsedPages         int `json:"parsed_pages"`
	Objects             int `json:"objects"`
	PageObjects         int `json:"page_objects"`
	AnnotationObjects   int `json:"annotation_objects"`
	TextCharacters      int `json:"text_characters"`
	PageTextCharacters  int `json:"page_text_characters"`
	AnnotationTextChars int `json:"annotation_text_characters"`
	Images              int `json:"images"`
	Fonts               int `json:"fonts"`
	DrawParams          int `json:"draw_params"`
	ColorSpaces         int `json:"color_spaces"`
	Templates           int `json:"templates"`
	Composites          int `json:"composites"`
	Patterns            int `json:"patterns"`
	Attachments         int `json:"attachments"`
	Annotations         int `json:"annotations"`
	Signatures          int `json:"signatures"`
}

Summary 是文档级汇总统计。

type TextSummary 

type TextSummary struct {
	Objects                 int `json:"objects"`
	TextCodes               int `json:"text_codes"`
	UTF8Bytes               int `json:"utf8_bytes"`
	UnicodeCodePoints       int `json:"unicode_code_points"`
	WhitespaceCodePoints    int `json:"whitespace_code_points"`
	NonWhitespaceCodePoints int `json:"non_whitespace_code_points"`
	Glyphs                  int `json:"glyphs"`
}

TextSummary 是文字统计。字符数按 Unicode 码点统计。

type ToolInfo 

type ToolInfo struct {
	Name    string `json:"name"`
	Version string `json:"version"`
}

ToolInfo 描述报告生成工具。

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.