Documentation ¶
Overview ¶
Package pdfcpu is a PDF processing library written in Go supporting encryption. It provides an API and a command line interface. Supported are all versions up to PDF 1.7 (ISO-32000).
The commands are:
attachments list, add, remove, extract embedded file attachments changeopw change owner password changeupw change user password collect create custom sequence of selected pages decrypt remove password protection encrypt set password protection extract extract images, fonts, content, pages or metadata fonts install, list supported fonts grid rearrange pages or images for enhanced browsing experience import import/convert images to PDF info print file info keywords list, add, remove keywords merge concatenate PDFs nup rearrange pages or images for reduced number of pages optimize optimize PDF by getting rid of redundant page resources pages insert, remove selected pages paper print list of supported paper sizes permissions list, set user access permissions portfolio list, add, remove, extract portfolio entries with optional description properties list, add, remove document properties rotate rotate pages split split up s PDF by span or bookmark stamp add, remove, update text, image or PDF stamps for selected pages trim create trimmed version of selected pages validate validate PDF against PDF 32000-1:2008 (PDF 1.7) version print version watermark add, remove, update text, image or PDF watermarks for selected pages
Index ¶
- Constants
- Variables
- func AddPages(ctx, ctxDest *Context, pages []int, usePgCache bool) error
- func AddWatermarks(ctx *Context, selectedPages IntSet, wm *Watermark) error
- func AppendPageTree(d1 *IndirectRef, countd1 int, d2 Dict) error
- func AppendStatsFile(ctx *Context) error
- func CreateTestPageContent(p Page)
- func DateString(t time.Time) string
- func DateTime(s string) (time.Time, bool)
- func DecodeUTF16String(s string) (string, error)
- func DetectWatermarks(ctx *Context) error
- func DrawAndFillRect(b *bytes.Buffer, r *Rectangle)
- func DrawGrid(bb *bytes.Buffer, x, y int, r *Rectangle, strokeCol SimpleColor, ...)
- func DrawHairCross(buf *bytes.Buffer, x, y float64, r *Rectangle)
- func DrawLine(b *bytes.Buffer, xp, yp, xq, yq float64)
- func DrawRect(b *bytes.Buffer, r *Rectangle)
- func EnsureDefaultConfigAt(path string) error
- func Escape(s string) (*string, error)
- func FillRect(bb *bytes.Buffer, rect *Rectangle, c SimpleColor)
- func HexLiteralToString(hexString string) (string, error)
- func IntMemberOf(i int, list []int) bool
- func IsStringUTF16BE(s string) bool
- func IsUTF16BE(b []byte) bool
- func KeywordsAdd(xRefTable *XRefTable, keywords []string) error
- func KeywordsList(xRefTable *XRefTable) ([]string, error)
- func KeywordsRemove(xRefTable *XRefTable, keywords []string) (bool, error)
- func MemberOf(s string, list []string) bool
- func MergeXRefTables(ctxSource, ctxDest *Context) (err error)
- func NUpFromPDF(ctx *Context, selectedPages IntSet, nup *NUp) error
- func OptimizeXRefTable(ctx *Context) error
- func ParseNUpDetails(s string, nup *NUp) error
- func ParseNUpGridDefinition(cols, rows int, nUp *NUp) error
- func ParseNUpValue(n int, nUp *NUp) error
- func Permissions(ctx *Context) (list []string)
- func PropertiesAdd(xRefTable *XRefTable, properties map[string]string) error
- func PropertiesList(xRefTable *XRefTable) ([]string, error)
- func PropertiesRemove(xRefTable *XRefTable, properties []string) (bool, error)
- func RemoveWatermarks(ctx *Context, selectedPages IntSet) error
- func RotatePages(ctx *Context, selectedPages IntSet, rotation int) error
- func SetFillColor(bb *bytes.Buffer, c SimpleColor)
- func SetLineJoinStyle(b *bytes.Buffer, s LineJoinStyle)
- func SetLineWidth(b *bytes.Buffer, w float64)
- func SetStrokeColor(bb *bytes.Buffer, c SimpleColor)
- func StringLiteralToString(s string) (string, error)
- func Text(o Object) (string, error)
- func TimingStats(op string, durRead, durVal, durOpt, durWrite, durTotal float64)
- func Unescape(s string) ([]byte, error)
- func ValidationTimingStats(dur1, dur2, dur float64)
- func Write(ctx *Context) (err error)
- func WriteImage(xRefTable *XRefTable, filename string, sd *StreamDict, objNr int) (string, error)
- type Array
- type Attachment
- type Bookmark
- type Boolean
- type ByteSize
- type CommandMode
- type Configuration
- type Context
- func CollectPages(ctx *Context, collectedPages []int) (*Context, error)
- func CreateContext(xRefTable *XRefTable, conf *Configuration) *Context
- func CreateContextWithXRefTable(conf *Configuration, pageDim *Dim) (*Context, error)
- func NUpFromImage(conf *Configuration, imageFileNames []string, nup *NUp) (*Context, error)
- func NewContext(rs io.ReadSeeker, conf *Configuration) (*Context, error)
- func Read(rs io.ReadSeeker, conf *Configuration) (*Context, error)
- func ReadFile(inFile string, conf *Configuration) (*Context, error)
- func (ctx *Context) AddAttachment(a Attachment, useCollection bool) error
- func (ctx *Context) BookmarksForOutlineLevel1() ([]Bookmark, error)
- func (ctx *Context) ExtractAttachments(ids []string) ([]Attachment, error)
- func (ctx *Context) ExtractFont(objNr int) (*Font, error)
- func (ctx *Context) ExtractImage(objNr int) (*Image, error)
- func (ctx *Context) ExtractMetadata() ([]Metadata, error)
- func (ctx *Context) ExtractPage(pageNr int) (*Context, error)
- func (ctx *Context) ExtractPageContent(pageNr int) (io.Reader, error)
- func (ctx *Context) ExtractPageFonts(pageNr int) ([]Font, error)
- func (ctx *Context) ExtractPageImages(pageNr int) ([]Image, error)
- func (ctx *Context) ExtractPages(pageNrs []int, usePgCache bool) (*Context, error)
- func (ctx *Context) FontObjNrs(pageNr int) []int
- func (ctx *Context) ImageObjNrs(pageNr int) []int
- func (ctx *Context) InfoDigest() ([]string, error)
- func (ctx *Context) ListAttachments() ([]Attachment, error)
- func (ctx *Context) RemoveAttachments(ids []string) (bool, error)
- func (ctx *Context) ResetWriteContext()
- func (ctx *Context) String() string
- type Dict
- func (d Dict) ArrayEntry(key string) Array
- func (d Dict) BooleanEntry(key string) *bool
- func (d Dict) Clone() Object
- func (d Dict) Delete(key string) (value Object)
- func (d Dict) DictEntry(key string) Dict
- func (d Dict) Entry(dictName, key string, required bool) (Object, error)
- func (d Dict) Find(key string) (value Object, found bool)
- func (d Dict) First() *int
- func (d Dict) HexLiteralEntry(key string) *HexLiteral
- func (d *Dict) Increment(key string) error
- func (d *Dict) IncrementBy(key string, i int) error
- func (d Dict) Index() Array
- func (d Dict) IndirectRefEntry(key string) *IndirectRef
- func (d Dict) Insert(key string, value Object) (ok bool)
- func (d Dict) InsertFloat(key string, value float32)
- func (d Dict) InsertInt(key string, value int)
- func (d Dict) InsertName(key, value string)
- func (d Dict) InsertString(key, value string)
- func (d Dict) Int64Entry(key string) *int64
- func (d Dict) IntEntry(key string) *int
- func (d Dict) IsLinearizationParmDict() bool
- func (d Dict) IsObjStm() bool
- func (d Dict) Len() int
- func (d Dict) Length() (*int64, *int)
- func (d Dict) N() *int
- func (d Dict) NameEntry(key string) *string
- func (d Dict) PDFString() string
- func (d Dict) Prev() *int64
- func (d Dict) Size() *int
- func (d Dict) StreamDictEntry(key string) *StreamDict
- func (d Dict) String() string
- func (d Dict) StringEntry(key string) *string
- func (d Dict) StringEntryBytes(key string) ([]byte, error)
- func (d Dict) StringLiteralEntry(key string) *StringLiteral
- func (d Dict) Subtype() *string
- func (d Dict) Type() *string
- func (d Dict) Update(key string, value Object)
- func (d Dict) W() Array
- type Dim
- type DisplayUnit
- type Enc
- type Float
- type Font
- type FontMap
- type FontObject
- type HAlignment
- type HexLiteral
- type Image
- type ImageObject
- type Import
- type IndirectRef
- func CIDFontDescriptor(xRefTable *XRefTable, ttf font.TTFLight, fontName string) (*IndirectRef, error)
- func CIDFontDict(xRefTable *XRefTable, ttf font.TTFLight, fontName string) (*IndirectRef, error)
- func NewIndirectRef(objectNumber, generationNumber int) *IndirectRef
- func NewNUpPageForImage(xRefTable *XRefTable, fileName string, parentIndRef *IndirectRef, nup *NUp) (*IndirectRef, error)
- func NewPageForImage(xRefTable *XRefTable, r io.Reader, parentIndRef *IndirectRef, imp *Import) (*IndirectRef, error)
- type InheritedPageAttrs
- type IntSet
- type Integer
- type LineJoinStyle
- type Metadata
- type NUp
- type Name
- type Node
- func (n *Node) Add(xRefTable *XRefTable, k string, v Object) error
- func (n *Node) AddToLeaf(k string, v Object)
- func (n *Node) HandleLeaf(xRefTable *XRefTable, k string, v Object) error
- func (n Node) KeyList() ([]string, error)
- func (n Node) Process(xRefTable *XRefTable, handler func(*XRefTable, string, Object) error) error
- func (n *Node) Remove(xRefTable *XRefTable, k string) (empty, ok bool, err error)
- func (n Node) String() string
- func (n Node) Value(k string) (Object, bool)
- type Object
- type ObjectStreamDict
- type OptimizationContext
- func (oc *OptimizationContext) DuplicateFontObjectsString() (int, string)
- func (oc *OptimizationContext) DuplicateImageObjectsString() (int, string)
- func (oc *OptimizationContext) DuplicateInfoObjectsString() (int, string)
- func (oc *OptimizationContext) IsDuplicateFontObject(i int) bool
- func (oc *OptimizationContext) IsDuplicateImageObject(i int) bool
- func (oc *OptimizationContext) IsDuplicateInfoObject(i int) bool
- func (oc *OptimizationContext) NonReferencedObjsString() (int, string)
- type PDFFilter
- type PDFImage
- type PDFStats
- type Page
- type PageResourceNames
- type Point
- type ReadContext
- func (rc *ReadContext) IsObjectStreamObject(i int) bool
- func (rc *ReadContext) IsXRefStreamObject(i int) bool
- func (rc *ReadContext) LogStats(optimized bool)
- func (rc *ReadContext) ObjectStreamsString() (int, string)
- func (rc *ReadContext) ReadFileSize() int
- func (rc *ReadContext) XRefStreamsString() (int, string)
- type Rectangle
- func Rect(llx, lly, urx, ury float64) *Rectangle
- func RectForArray(a Array) *Rectangle
- func RectForDim(width, height float64) *Rectangle
- func RectForFormat(f string) *Rectangle
- func RectForWidthAndHeight(llx, lly, width, height float64) *Rectangle
- func WriteColumn(buf *bytes.Buffer, mediaBox, region *Rectangle, td TextDescriptor, ...) *Rectangle
- func WriteColumnAnchored(buf *bytes.Buffer, mediaBox, region *Rectangle, td TextDescriptor, a anchor, ...) *Rectangle
- func WriteMultiLine(buf *bytes.Buffer, mediaBox, region *Rectangle, td TextDescriptor) *Rectangle
- func WriteMultiLineAnchored(buf *bytes.Buffer, mediaBox, region *Rectangle, td TextDescriptor, a anchor) *Rectangle
- type RenderMode
- type SimpleColor
- type StreamDict
- type StringLiteral
- type StringSet
- type TextDescriptor
- type VAlignment
- type Version
- type Watermark
- type WriteContext
- type XRefStreamDict
- type XRefTable
- func (xRefTable *XRefTable) BindNameTrees() error
- func (xRefTable *XRefTable) Catalog() (Dict, error)
- func (xRefTable *XRefTable) CatalogHasPieceInfo() (bool, error)
- func (xRefTable *XRefTable) DeleteObject(objNr int) error
- func (xRefTable *XRefTable) DeleteObjectGraph(o Object) error
- func (xRefTable *XRefTable) Dereference(o Object) (Object, error)
- func (xRefTable *XRefTable) DereferenceArray(o Object) (Array, error)
- func (xRefTable *XRefTable) DereferenceBoolean(o Object, sinceVersion Version) (*Boolean, error)
- func (xRefTable *XRefTable) DereferenceCSVSafeText(o Object) (string, error)
- func (xRefTable *XRefTable) DereferenceDict(o Object) (Dict, error)
- func (xRefTable *XRefTable) DereferenceDictEntry(d Dict, entryName string) (Object, error)
- func (xRefTable *XRefTable) DereferenceInteger(o Object) (*Integer, error)
- func (xRefTable *XRefTable) DereferenceName(o Object, sinceVersion Version, validate func(string) bool) (n Name, err error)
- func (xRefTable *XRefTable) DereferenceNumber(o Object) (float64, error)
- func (xRefTable *XRefTable) DereferenceStreamDict(o Object) (*StreamDict, error)
- func (xRefTable *XRefTable) DereferenceStreamDictForValidation(o Object, onFirstVisitOnly bool) (*StreamDict, error)
- func (xRefTable *XRefTable) DereferenceStringLiteral(o Object, sinceVersion Version, validate func(string) bool) (s StringLiteral, err error)
- func (xRefTable *XRefTable) DereferenceStringOrHexLiteral(obj Object, sinceVersion Version, validate func(string) bool) (s string, err error)
- func (xRefTable *XRefTable) DereferenceText(o Object) (string, error)
- func (xRefTable *XRefTable) DetectPageTreeWatermarks() error
- func (xRefTable *XRefTable) EncryptDict() (Dict, error)
- func (xRefTable *XRefTable) EnsureCollection() error
- func (xRefTable *XRefTable) EnsurePageCount() error
- func (xRefTable *XRefTable) EnsureValidFreeList() error
- func (xRefTable *XRefTable) EnsureVersionForWriting()
- func (xRefTable *XRefTable) Exists(objNr int) bool
- func (xRefTable *XRefTable) Find(objNr int) (*XRefTableEntry, bool)
- func (xRefTable *XRefTable) FindObject(objNr int) (Object, error)
- func (xRefTable *XRefTable) FindTableEntry(objNr int, genNr int) (*XRefTableEntry, bool)
- func (xRefTable *XRefTable) FindTableEntryForIndRef(ir *IndirectRef) (*XRefTableEntry, bool)
- func (xRefTable *XRefTable) FindTableEntryLight(objNr int) (*XRefTableEntry, bool)
- func (xRefTable *XRefTable) Free(objNr int) (*XRefTableEntry, error)
- func (xRefTable *XRefTable) IDFirstElement() (id []byte, err error)
- func (xRefTable *XRefTable) IndRefForNewObject(obj Object) (*IndirectRef, error)
- func (xRefTable *XRefTable) InsertAndUseRecycled(xRefTableEntry XRefTableEntry) (objNr int, err error)
- func (xRefTable *XRefTable) InsertBlankPages(pages IntSet, before bool) error
- func (xRefTable *XRefTable) InsertNew(xRefTableEntry XRefTableEntry) (objNr int)
- func (xRefTable *XRefTable) InsertObject(obj Object) (objNr int, err error)
- func (xRefTable *XRefTable) IsLinearizationObject(i int) bool
- func (xRefTable *XRefTable) LinearizationObjsString() (int, string)
- func (xRefTable *XRefTable) LocateNameTree(nameTreeName string, ensure bool) error
- func (xRefTable *XRefTable) MissingObjects() (int, *string)
- func (xRefTable *XRefTable) NamesDict() (Dict, error)
- func (xRefTable *XRefTable) NewEmbeddedFileStreamDict(filename string) (*IndirectRef, error)
- func (xRefTable *XRefTable) NewEmbeddedStreamDict(r io.Reader, modDate time.Time) (*IndirectRef, error)
- func (xRefTable *XRefTable) NewFileSpecDict(filename, desc string, indRefStreamDict IndirectRef) (Dict, error)
- func (xRefTable *XRefTable) NewFileSpectDictForAttachment(a Attachment) (*IndirectRef, error)
- func (xRefTable *XRefTable) NewSoundStreamDict(filename string, samplingRate int, fileSpecDict Dict) (*IndirectRef, error)
- func (xRefTable *XRefTable) NewStreamDictForBuf(buf []byte) (*StreamDict, error)
- func (xRefTable *XRefTable) NewStreamDictForFile(filename string) (*StreamDict, error)
- func (xRefTable *XRefTable) NextForFree(objNr int) (int, error)
- func (xRefTable *XRefTable) Outlines() (*IndirectRef, error)
- func (xRefTable *XRefTable) PageContent(d Dict) ([]byte, error)
- func (xRefTable *XRefTable) PageDict(page int, consolidateRes bool) (Dict, *InheritedPageAttrs, error)
- func (xRefTable *XRefTable) PageDims() ([]Dim, error)
- func (xRefTable *XRefTable) PageNumber(pageObjNr int) (int, error)
- func (xRefTable *XRefTable) Pages() (*IndirectRef, error)
- func (xRefTable *XRefTable) ParseRootVersion() (v *string, err error)
- func (xRefTable *XRefTable) RemoveCollection() error
- func (xRefTable *XRefTable) RemoveEmbeddedFilesNameTree() error
- func (xRefTable *XRefTable) RemoveNameTree(nameTreeName string) error
- func (xRefTable *XRefTable) UndeleteObject(objectNumber int) error
- func (xRefTable *XRefTable) ValidateVersion(element string, sinceVersion Version) error
- func (xRefTable *XRefTable) Version() Version
- func (xRefTable *XRefTable) VersionString() string
- type XRefTableEntry
Constants ¶
const ( DeviceGrayCS = "DeviceGray" DeviceRGBCS = "DeviceRGB" DeviceCMYKCS = "DeviceCMYK" CalGrayCS = "CalGray" CalRGBCS = "CalRGB" LabCS = "Lab" ICCBasedCS = "ICCBased" IndexedCS = "Indexed" PatternCS = "Pattern" SeparationCS = "Separation" DeviceNCS = "DeviceN" )
PDF defines the following Color Spaces:
const ( // ValidationStrict ensures 100% compliance with the spec (PDF 32000-1:2008). ValidationStrict int = iota // ValidationRelaxed ensures PDF compliance based on frequently encountered validation errors. ValidationRelaxed // ValidationNone bypasses validation. ValidationNone )
const ( // StatsFileNameDefault is the standard stats filename. StatsFileNameDefault = "stats.csv" // PermissionsAll enables all user access permission bits. PermissionsAll int16 = -1 // 0xFFFF // PermissionsNone disables all user access permissions bits. PermissionsNone int16 = -3901 // 0xF0C3 )
const ( TopLeft anchor = iota TopCenter TopRight Left Center // default Right BottomLeft BottomCenter BottomRight Full // special case, no anchor needed, imageSize = pageSize )
These are the defined anchors for relative positioning.
const ( RightDown orientation = iota DownRight LeftDown DownLeft )
These are the defined anchors for relative positioning.
const ( WMText = iota WMImage WMPDF )
Watermark mode
const ( NoDiagonal = iota DiagonalLLToUR DiagonalULToLR )
Rotation along one of 2 diagonals
const ( RootVersion = iota RootExtensions RootPageLabels RootNames RootDests RootViewerPrefs RootPageLayout RootPageMode RootOutlines RootThreads RootOpenAction RootAA RootURI RootAcroForm RootMetadata RootStructTreeRoot RootMarkInfo RootLang RootSpiderInfo RootOutputIntents RootPieceInfo RootOCProperties RootPerms RootLegal RootRequirements RootCollection RootNeedsRendering )
The PDF root object fields.
const ( PageLastModified = iota PageResources PageMediaBox PageCropBox PageBleedBox PageTrimBox PageArtBox PageBoxColorInfo PageContents PageRotate PageGroup PageThumb PageB PageDur PageTrans PageAnnots PageAA PageMetadata PagePieceInfo PageStructParents PageID PagePZ PageSeparationInfo PageTabs PageTemplateInstantiated PagePresSteps PageUserUnit PageVP )
The PDF page object fields.
const ( EolLF = "\x0A" EolCR = "\x0D" EolCRLF = "\x0D\x0A" )
Supported line delimiters
const FreeHeadGeneration = 65535
FreeHeadGeneration is the predefined generation number for the head of the free list.
const (
// ObjectStreamMaxObjects limits the number of objects within an object stream written.
ObjectStreamMaxObjects = 100
)
Variables ¶
var ( Black = SimpleColor{} White = SimpleColor{R: 1, G: 1, B: 1} Gray = SimpleColor{.5, .5, .5} LightGray = SimpleColor{.9, .9, .9} )
Some popular colors.
var ConfigPath string = "default"
ConfigPath defines the location of pdfcpu's configuration directory. If set to a file path, pdfcpu will ensure the config dir at this location. Other possible values:
default: Ensure config dir at default location disable: Disable config dir usage
var (
ErrUnsupported16BPC = errors.New("unsupported 16 bits per component")
)
Errors to be identified.
var PaperSize = map[string]*Dim{}/* 150 elements not displayed */
PaperSize is a map of known paper sizes in user units (=72 dpi pixels).
var VersionStr = "v0.3.6 dev"
VersionStr is the current pdfcpu version.
Functions ¶
func AddWatermarks ¶
AddWatermarks adds watermarks to all pages selected.
func AppendPageTree ¶
func AppendPageTree(d1 *IndirectRef, countd1 int, d2 Dict) error
AppendPageTree appends a pagetree d1 to page tree d2.
func AppendStatsFile ¶
AppendStatsFile appends a stats line for this xRefTable to the configured csv file name.
func CreateTestPageContent ¶
func CreateTestPageContent(p Page)
CreateTestPageContent draws a test grid.
func DateString ¶
DateString returns a string representation of t.
func DecodeUTF16String ¶
DecodeUTF16String decodes a UTF16BE string from a hex string.
func DetectWatermarks ¶
DetectWatermarks checks ctx for watermarks and records the result to xRefTable.Watermarked.
func DrawAndFillRect ¶
DrawAndFillRect strokes and fills a rectangular path for r.
func DrawGrid ¶
func DrawGrid(bb *bytes.Buffer, x, y int, r *Rectangle, strokeCol SimpleColor, fillCol *SimpleColor)
DrawGrid draws an x * y grid on r using strokeCol and fillCol.
func DrawHairCross ¶
DrawHairCross draw a haircross with origin x/y.
func EnsureDefaultConfigAt ¶
EnsureDefaultConfigAt tries to load the default configuration from path. If path/pdfcpu/config.yaml is not found, it will be created.
func FillRect ¶
func FillRect(bb *bytes.Buffer, rect *Rectangle, c SimpleColor)
FillRect draws and fills a rectangle using r, g, b.
func HexLiteralToString ¶
HexLiteralToString returns a possibly UTF16 encoded string for a hex string.
func IntMemberOf ¶
IntMemberOf returns true if list contains i.
func IsStringUTF16BE ¶
IsStringUTF16BE checks a string for Big Endian byte order BOM.
func KeywordsAdd ¶
KeywordsAdd adds keywords to the document info dict. Returns true if at least one keyword was added.
func KeywordsList ¶
KeywordsList returns a list of keywords as recorded in the document info dict.
func KeywordsRemove ¶
KeywordsRemove deletes keywords from the document info dict. Returns true if at least one keyword was removed.
func MergeXRefTables ¶
MergeXRefTables merges Context ctxSource into ctxDest by appending its page tree.
func NUpFromPDF ¶
NUpFromPDF creates an n-up version of the PDF represented by xRefTable.
func OptimizeXRefTable ¶
OptimizeXRefTable optimizes an xRefTable by locating and getting rid of redundant embedded fonts and images.
func ParseNUpDetails ¶
ParseNUpDetails parses a NUp command string into an internal structure.
func ParseNUpGridDefinition ¶
ParseNUpGridDefinition parses NUp grid dimensions into an internal structure.
func ParseNUpValue ¶
ParseNUpValue parses the NUp value into an internal structure.
func Permissions ¶
Permissions returns a list of set permissions.
func PropertiesAdd ¶
PropertiesAdd adds properties into the document info dict. Returns true if at least one property was added.
func PropertiesList ¶
PropertiesList returns a list of document properties as recorded in the document info dict.
func PropertiesRemove ¶
PropertiesRemove deletes specified properties. Returns true if at least one property was removed.
func RemoveWatermarks ¶
RemoveWatermarks removes watermarks for all pages selected.
func RotatePages ¶
RotatePages rotates all selected pages by a multiple of 90 degrees.
func SetFillColor ¶
func SetFillColor(bb *bytes.Buffer, c SimpleColor)
SetFillColor sets the fill color.
func SetLineJoinStyle ¶
func SetLineJoinStyle(b *bytes.Buffer, s LineJoinStyle)
SetLineJoinStyle sets the line join style for stroking operations.
func SetLineWidth ¶
SetLineWidth sets line width for stroking operations.
func SetStrokeColor ¶
func SetStrokeColor(bb *bytes.Buffer, c SimpleColor)
SetStrokeColor sets the stroke color.
func StringLiteralToString ¶
StringLiteralToString returns the best possible string rep for a string literal.
func TimingStats ¶
TimingStats prints processing time stats for an operation.
func ValidationTimingStats ¶
func ValidationTimingStats(dur1, dur2, dur float64)
ValidationTimingStats prints processing time stats for validation.
func WriteImage ¶
WriteImage writes a PDF image object to disk.
Types ¶
type Array ¶
type Array []Object
Array represents a PDF array object.
func NewIntegerArray ¶
NewIntegerArray returns a PDFArray with Integer entries.
func NewNameArray ¶
NewNameArray returns a PDFArray with Name entries.
func NewNumberArray ¶
NewNumberArray returns a PDFArray with Float entries.
func NewStringArray ¶
NewStringArray returns a PDFArray with StringLiteral entries.
type Attachment ¶
type Attachment struct { io.Reader // attachment data ID string // id Desc string // description ModTime *time.Time // time of last modification (optional) }
Attachment is a Reader representing a PDF attachment.
func (Attachment) String ¶
func (a Attachment) String() string
type Bookmark ¶
type Bookmark struct { Title string PageFrom int PageThru int // >= pageFrom and reaches until before pageFrom of the next bookmark. }
Bookmark represents an outline item at some level including page span info.
type Boolean ¶
type Boolean bool
Boolean represents a PDF boolean object.
type CommandMode ¶
type CommandMode int
CommandMode specifies the operation being executed.
const ( VALIDATE CommandMode = iota OPTIMIZE SPLIT MERGECREATE MERGEAPPEND EXTRACTIMAGES EXTRACTFONTS EXTRACTPAGES EXTRACTCONTENT EXTRACTMETADATA TRIM ADDATTACHMENTS ADDATTACHMENTSPORTFOLIO REMOVEATTACHMENTS EXTRACTATTACHMENTS LISTATTACHMENTS SETPERMISSIONS LISTPERMISSIONS ENCRYPT DECRYPT CHANGEUPW CHANGEOPW ADDWATERMARKS REMOVEWATERMARKS IMPORTIMAGES INSERTPAGESBEFORE INSERTPAGESAFTER REMOVEPAGES ROTATE NUP INFO INSTALLFONTS LISTFONTS LISTKEYWORDS ADDKEYWORDS REMOVEKEYWORDS LISTPROPERTIES ADDPROPERTIES REMOVEPROPERTIES COLLECT )
The available commands.
type Configuration ¶
type Configuration struct { Path string // Enables PDF V1.5 compatible processing of object streams, xref streams, hybrid PDF files. Reader15 bool // Enables decoding of all streams (fontfiles, images..) for logging purposes. DecodeAllStreams bool // Validate against ISO-32000: strict or relaxed ValidationMode int // End of line char sequence for writing. Eol string // Turns on object stream generation. // A signal for compressing any new non-stream-object into an object stream. // true enforces WriteXRefStream to true. // false does not prevent xRefStream generation. WriteObjectStream bool // Switches between xRefSection (<=V1.4) and objectStream/xRefStream (>=V1.5) writing. WriteXRefStream bool // Turns on stats collection. // TODO Decision - unused. CollectStats bool // A CSV-filename holding the statistics. StatsFileName string // Supplied user password UserPW string UserPWNew *string // Supplied owner password OwnerPW string OwnerPWNew *string // EncryptUsingAES ensures AES encryption. // true: AES encryption // false: RC4 encryption. EncryptUsingAES bool // AES:40,128,256 RC4:40,128 EncryptKeyLength int // Supplied user access permissions, see Table 22 Permissions int16 // Command being executed. Cmd CommandMode // Chosen units for outputting paper sizes. Units DisplayUnit }
Configuration of a Context.
func NewAESConfiguration ¶
func NewAESConfiguration(userPW, ownerPW string, keyLength int) *Configuration
NewAESConfiguration returns a default configuration for AES encryption.
func NewDefaultConfiguration ¶
func NewDefaultConfiguration() *Configuration
NewDefaultConfiguration returns the default pdfcpu configuration.
func NewRC4Configuration ¶
func NewRC4Configuration(userPW, ownerPW string, keyLength int) *Configuration
NewRC4Configuration returns a default configuration for RC4 encryption.
func (*Configuration) ApplyReducedFeatureSet ¶
func (c *Configuration) ApplyReducedFeatureSet() bool
ApplyReducedFeatureSet returns true if complex entries like annotations shall not be written.
func (*Configuration) EolString ¶
func (c *Configuration) EolString() string
EolString returns a string rep for the eol in effect.
func (Configuration) String ¶
func (c Configuration) String() string
func (*Configuration) UnitsString ¶
func (c *Configuration) UnitsString() string
UnitsString returns a string rep for the display unit in effect.
func (*Configuration) ValidationModeString ¶
func (c *Configuration) ValidationModeString() string
ValidationModeString returns a string rep for the validation mode in effect.
type Context ¶
type Context struct { *Configuration *XRefTable Read *ReadContext Optimize *OptimizationContext Write *WriteContext // contains filtered or unexported fields }
Context represents an environment for processing PDF files.
func CollectPages ¶
CollectPages creates a new PDF Context for a custom PDF page sequence of the PDF represented by ctx.
func CreateContext ¶
func CreateContext(xRefTable *XRefTable, conf *Configuration) *Context
CreateContext creates a Context for given cross reference table and configuration.
func CreateContextWithXRefTable ¶
func CreateContextWithXRefTable(conf *Configuration, pageDim *Dim) (*Context, error)
CreateContextWithXRefTable creates a Context with an xRefTable without pages for given configuration.
func NUpFromImage ¶
func NUpFromImage(conf *Configuration, imageFileNames []string, nup *NUp) (*Context, error)
NUpFromImage creates a single page n-up PDF for one image or a sequence of n-up pages for more than one image.
func NewContext ¶
func NewContext(rs io.ReadSeeker, conf *Configuration) (*Context, error)
NewContext initializes a new Context.
func Read ¶
func Read(rs io.ReadSeeker, conf *Configuration) (*Context, error)
Read takes a readSeeker and generates a Context, an in-memory representation containing a cross reference table.
func ReadFile ¶
func ReadFile(inFile string, conf *Configuration) (*Context, error)
ReadFile reads in a PDF file and builds an internal structure holding its cross reference table aka the Context.
func (*Context) AddAttachment ¶
func (ctx *Context) AddAttachment(a Attachment, useCollection bool) error
AddAttachment adds a.
func (*Context) BookmarksForOutlineLevel1 ¶
BookmarksForOutlineLevel1 returns bookmarks incliuding page span info.
func (*Context) ExtractAttachments ¶
func (ctx *Context) ExtractAttachments(ids []string) ([]Attachment, error)
ExtractAttachments extracts attachments with id.
func (*Context) ExtractFont ¶
ExtractFont extracts a font from font dict by objNr.
func (*Context) ExtractImage ¶
ExtractImage extracts an image from image dict referenced by objNr. Supported imgTypes: FlateDecode, DCTDecode, JPXDecode
func (*Context) ExtractMetadata ¶
ExtractMetadata returns all metadata of ctx.
func (*Context) ExtractPage ¶
ExtractPage extracts pageNr into a new single page context.
func (*Context) ExtractPageContent ¶
ExtractPageContent extracts the consolidated page content stream for pageNr.
func (*Context) ExtractPageFonts ¶
ExtractPageFonts extracts all fonts used by pageNr.
func (*Context) ExtractPageImages ¶
ExtractPageImages extracts all images used by pageNr.
func (*Context) ExtractPages ¶
ExtractPages extracts pageNrs into a new single page context.
func (*Context) FontObjNrs ¶
FontObjNrs returns all font dict objNrs for pageNr. Requires an optimized context.
func (*Context) ImageObjNrs ¶
ImageObjNrs returns all image dict objNrs for pageNr. Requires an optimized context.
func (*Context) InfoDigest ¶
InfoDigest returns info about ctx.
func (*Context) ListAttachments ¶
func (ctx *Context) ListAttachments() ([]Attachment, error)
ListAttachments returns a slice of attachment stubs (attachment w/o data).
func (*Context) RemoveAttachments ¶
RemoveAttachments removes attachments with given id and returns true if anything removed.
func (*Context) ResetWriteContext ¶
func (ctx *Context) ResetWriteContext()
ResetWriteContext prepares an existing WriteContext for a new file to be written.
type Dict ¶
Dict represents a PDF dict object.
func (Dict) ArrayEntry ¶
ArrayEntry expects and returns a Array entry for given key.
func (Dict) BooleanEntry ¶
BooleanEntry expects and returns a BooleanEntry for given key.
func (Dict) HexLiteralEntry ¶
func (d Dict) HexLiteralEntry(key string) *HexLiteral
HexLiteralEntry returns a HexLiteral object for given key.
func (*Dict) IncrementBy ¶
IncrementBy increments the integer value for given key by i.
func (Dict) IndirectRefEntry ¶
func (d Dict) IndirectRefEntry(key string) *IndirectRef
IndirectRefEntry returns an indirectRefEntry for given key for this dictionary.
func (Dict) InsertFloat ¶
InsertFloat adds a new float entry to this PDFDict.
func (Dict) InsertName ¶
InsertName adds a new name entry to this PDFDict.
func (Dict) InsertString ¶
InsertString adds a new string entry to this PDFDict.
func (Dict) Int64Entry ¶
Int64Entry expects and returns a Integer entry representing an int64 value for given key.
func (Dict) IsLinearizationParmDict ¶
IsLinearizationParmDict returns true if this dict has an int entry for key "Linearized".
func (Dict) Length ¶
Length returns a *int64 for entry with key "Length". Stream length may be referring to an indirect object.
func (Dict) PDFString ¶
PDFString returns a string representation as found in and written to a PDF file.
func (Dict) StreamDictEntry ¶
func (d Dict) StreamDictEntry(key string) *StreamDict
StreamDictEntry expects and returns a StreamDict entry for given key. unused.
func (Dict) StringEntry ¶
StringEntry expects and returns a StringLiteral entry for given key.
func (Dict) StringEntryBytes ¶
StringEntryBytes returns the byte slice representing the string value for key.
func (Dict) StringLiteralEntry ¶
func (d Dict) StringLiteralEntry(key string) *StringLiteral
StringLiteralEntry returns a StringLiteral object for given key.
type Dim ¶
type Dim struct {
Width, Height float64
}
Dim represents the dimensions of a rectangular view medium like a PDF page, a sheet of paper or an image grid in user space, inches, centimetres or millimetres.
func (Dim) AspectRatio ¶
AspectRatio returns the relation between width and height.
func (Dim) ToCentimetres ¶
ToCentimetres converts d to centimetres.
func (Dim) ToMillimetres ¶
ToMillimetres converts d to centimetres.
type DisplayUnit ¶
type DisplayUnit int
DisplayUnit is the metric unit used to output paper sizes.
const ( POINTS DisplayUnit = iota INCHES CENTIMETRES MILLIMETRES )
The available display units.
type Enc ¶
type Enc struct {
O, U []byte
OE, UE []byte
Perms []byte
L, P, R, V int
Emd bool // encrypt meta data
ID []byte
}
Enc wraps around all defined encryption attributes.
type Float ¶
type Float float64
Float represents a PDF float object.
type FontObject ¶
type FontObject struct { ResourceNames []string Prefix string FontName string FontDict Dict Data []byte Extension string }
FontObject represents a font used in a PDF file.
func (*FontObject) AddResourceName ¶
func (fo *FontObject) AddResourceName(resourceName string)
AddResourceName adds a resourceName referring to this font.
func (FontObject) Embedded ¶
func (fo FontObject) Embedded() (embedded bool)
Embedded returns true if the font is embedded into this PDF file.
func (FontObject) Encoding ¶
func (fo FontObject) Encoding() string
Encoding returns the Encoding of this font.
func (FontObject) ResourceNamesString ¶
func (fo FontObject) ResourceNamesString() string
ResourceNamesString returns a string representation of all the resource names of this font.
func (FontObject) String ¶
func (fo FontObject) String() string
func (FontObject) SubType ¶
func (fo FontObject) SubType() string
SubType returns the SubType of this font.
type HAlignment ¶
type HAlignment int
HAlignment represents the horizontal alignment of text.
const ( AlignLeft HAlignment = iota AlignCenter AlignRight AlignJustify )
These are the options for horizontal aligned text.
type HexLiteral ¶
type HexLiteral string
HexLiteral represents a PDF hex literal object.
func NewHexLiteral ¶
func NewHexLiteral(b []byte) HexLiteral
NewHexLiteral creates a new HexLiteral for b..
func (HexLiteral) Bytes ¶
func (hexliteral HexLiteral) Bytes() ([]byte, error)
Bytes returns the byte representation.
func (HexLiteral) Clone ¶
func (hexliteral HexLiteral) Clone() Object
Clone returns a clone of hexliteral.
func (HexLiteral) PDFString ¶
func (hexliteral HexLiteral) PDFString() string
PDFString returns the string representation as found in and written to a PDF file.
func (HexLiteral) String ¶
func (hexliteral HexLiteral) String() string
func (HexLiteral) Value ¶
func (hexliteral HexLiteral) Value() string
Value returns a string value for this PDF object.
type Image ¶
Image is a Reader representing an image resource.
func RenderImage ¶
func RenderImage(xRefTable *XRefTable, io *ImageObject, objNr int) (*Image, error)
RenderImage returns a reader for the encoded image bytes.
type ImageObject ¶
type ImageObject struct { ResourceNames []string ImageDict *StreamDict }
ImageObject represents an image used in a PDF file.
func (*ImageObject) AddResourceName ¶
func (io *ImageObject) AddResourceName(resourceName string)
AddResourceName adds a resourceName to this imageObject's ResourceNames dict.
func (ImageObject) ResourceNamesString ¶
func (io ImageObject) ResourceNamesString() string
ResourceNamesString returns a string representation of the ResourceNames for this image.
type Import ¶
type Import struct { PageDim *Dim // page dimensions in user units. PageSize string // one of A0,A1,A2,A3,A4(=default),A5,A6,A7,A8,Letter,Legal,Ledger,Tabloid,Executive,ANSIC,ANSID,ANSIE. UserDim bool // true if one of dimensions or paperSize provided overriding the default. DPI int // destination resolution to apply in dots per inch. Pos anchor // position anchor, one of tl,tc,tr,l,c,r,bl,bc,br,full. Dx, Dy int // anchor offset. Scale float64 // relative scale factor. 0 <= x <= 1 ScaleAbs bool // true for absolute scaling. }
Import represents the command details for the command "ImportImage".
func DefaultImportConfig ¶
func DefaultImportConfig() *Import
DefaultImportConfig returns the default configuration.
func ParseImportDetails ¶
ParseImportDetails parses an Import command string into an internal structure.
type IndirectRef ¶
IndirectRef represents a PDF indirect object.
func CIDFontDescriptor ¶
func CIDFontDescriptor(xRefTable *XRefTable, ttf font.TTFLight, fontName string) (*IndirectRef, error)
CIDFontDescriptor represents a font descriptor describing the CIDFont’s default metrics other than its glyph widths.
func CIDFontDict ¶
CIDFontDict returns the descendent font dict for Type0 fonts.
func NewIndirectRef ¶
func NewIndirectRef(objectNumber, generationNumber int) *IndirectRef
NewIndirectRef returns a new PDFIndirectRef object.
func NewNUpPageForImage ¶
func NewNUpPageForImage(xRefTable *XRefTable, fileName string, parentIndRef *IndirectRef, nup *NUp) (*IndirectRef, error)
NewNUpPageForImage creates a new page dict in xRefTable for given image filename and n-up conf.
func NewPageForImage ¶
func NewPageForImage(xRefTable *XRefTable, r io.Reader, parentIndRef *IndirectRef, imp *Import) (*IndirectRef, error)
NewPageForImage creates a new page dict in xRefTable for given image reader r.
func (IndirectRef) Equals ¶
func (ir IndirectRef) Equals(indRef IndirectRef) bool
Equals returns true if two indirect References refer to the same object.
func (IndirectRef) PDFString ¶
func (ir IndirectRef) PDFString() string
PDFString returns a string representation as found in and written to a PDF file.
func (IndirectRef) String ¶
func (ir IndirectRef) String() string
type InheritedPageAttrs ¶
type InheritedPageAttrs struct {
// contains filtered or unexported fields
}
InheritedPageAttrs represents all inherited page attributes.
type Integer ¶
type Integer int
Integer represents a PDF integer object.
type LineJoinStyle ¶
type LineJoinStyle int
LineJoinStyle represents the shape to be used at the corners of paths that are stroked (see 8.4.3.4)
const ( LJMiter LineJoinStyle = iota LJRound LJBevel )
Render mode
type Metadata ¶
type Metadata struct { io.Reader // metadata ObjNr int // metadata dict objNr ParentObjNr int // container object number ParentType string // container dict type }
Metadata is a Reader representing a metadata dict.
type NUp ¶
type NUp struct { PageDim *Dim // Page dimensions in user units. PageSize string // Paper size eg. A4L, A4P, A4(=default=A4P), see paperSize.go UserDim bool // true if one of dimensions or paperSize provided overriding the default. Orient orientation // One of rd(=default),dr,ld,dl Grid *Dim // Intra page grid dimensions eg (2,2) PageGrid bool // Create a mxn grid of pages for PDF inputfiles only (think "extra page n-Up"). ImgInputFile bool // Process image or PDF input files. Margin int // Cropbox for n-Up content. Border bool // Draw bounding box. }
NUp represents the command details for the command "NUp".
func DefaultNUpConfig ¶
func DefaultNUpConfig() *NUp
DefaultNUpConfig returns the default NUp configuration.
func ImageGridConfig ¶
ImageGridConfig returns a grid configuration for Nup-ing image files.
func ImageNUpConfig ¶
ImageNUpConfig returns an NUp configuration for Nup-ing image files.
func PDFGridConfig ¶
PDFGridConfig returns a grid configuration for Nup-ing PDF files.
func PDFNUpConfig ¶
PDFNUpConfig returns an NUp configuration for Nup-ing PDF files.
type Name ¶
type Name string
Name represents a PDF name object.
type Node ¶
type Node struct { Kids []*Node // Mirror of the name tree's Kids array, an array of indirect references. Names []entry // Mirror of the name tree's Names array. Kmin, Kmax string // Mirror of the name tree's Limit array[Kmin,Kmax]. D Dict // The PDF dict representing this name tree node. }
Node is an opinionated implementation of the PDF name tree. pdfcpu caches all name trees found in the PDF catalog with this data structure. The PDF spec does not impose any rules regarding a strategy for the creation of nodes. A binary tree was chosen where each leaf node has a limited number of entries (maxEntries). Once maxEntries has been reached a leaf node turns into an intermediary node with two kids, which are leaf nodes each of them holding half of the sorted entries of the original leaf node.
func (*Node) HandleLeaf ¶
HandleLeaf processes a leaf node.
func (Node) Process ¶
Process traverses the nametree applying a handler to each entry (key-value pair).
type ObjectStreamDict ¶
type ObjectStreamDict struct { StreamDict Prolog []byte ObjCount int FirstObjOffset int ObjArray Array }
ObjectStreamDict represents a object stream dictionary.
func NewObjectStreamDict ¶
func NewObjectStreamDict() *ObjectStreamDict
NewObjectStreamDict creates a new ObjectStreamDict object.
func (*ObjectStreamDict) AddObject ¶
func (osd *ObjectStreamDict) AddObject(objNumber int, entry *XRefTableEntry) error
AddObject adds another object to this object stream. Relies on decoded content!
func (*ObjectStreamDict) Finalize ¶
func (osd *ObjectStreamDict) Finalize()
Finalize prepares the final content of the objectstream.
func (*ObjectStreamDict) IndexedObject ¶
func (osd *ObjectStreamDict) IndexedObject(index int) (Object, error)
IndexedObject returns the object at given index from a ObjectStreamDict.
type OptimizationContext ¶
type OptimizationContext struct { // Font section PageFonts []IntSet // For each page a registry of font object numbers. FontObjects map[int]*FontObject // FontObject lookup table by font object number. Fonts map[string][]int // All font object numbers registered for a font name. DuplicateFonts map[int]Dict // Registry of duplicate font dicts. DuplicateFontObjs IntSet // The set of objects that represents the union of the object graphs of all duplicate font dicts. // Image section PageImages []IntSet // For each page a registry of image object numbers. ImageObjects map[int]*ImageObject // ImageObject lookup table by image object number. DuplicateImages map[int]*StreamDict // Registry of duplicate image dicts. DuplicateImageObjs IntSet // The set of objects that represents the union of the object graphs of all duplicate image dicts. DuplicateInfoObjects IntSet // Possible result of manual info dict modification. NonReferencedObjs []int // Objects that are not referenced. FixTable map[int]bool // map for visited objects during xreftable traversal for fixing references to free objects. NullObjNr *int // objNr of a regular null object, to be used for fixing references to free objects. }
OptimizationContext represents the context for the optimiziation of a PDF file.
func (*OptimizationContext) DuplicateFontObjectsString ¶
func (oc *OptimizationContext) DuplicateFontObjectsString() (int, string)
DuplicateFontObjectsString returns a formatted string and the number of objs.
func (*OptimizationContext) DuplicateImageObjectsString ¶
func (oc *OptimizationContext) DuplicateImageObjectsString() (int, string)
DuplicateImageObjectsString returns a formatted string and the number of objs.
func (*OptimizationContext) DuplicateInfoObjectsString ¶
func (oc *OptimizationContext) DuplicateInfoObjectsString() (int, string)
DuplicateInfoObjectsString returns a formatted string and the number of objs.
func (*OptimizationContext) IsDuplicateFontObject ¶
func (oc *OptimizationContext) IsDuplicateFontObject(i int) bool
IsDuplicateFontObject returns true if object #i is a duplicate font object.
func (*OptimizationContext) IsDuplicateImageObject ¶
func (oc *OptimizationContext) IsDuplicateImageObject(i int) bool
IsDuplicateImageObject returns true if object #i is a duplicate image object.
func (*OptimizationContext) IsDuplicateInfoObject ¶
func (oc *OptimizationContext) IsDuplicateInfoObject(i int) bool
IsDuplicateInfoObject returns true if object #i is a duplicate info object.
func (*OptimizationContext) NonReferencedObjsString ¶
func (oc *OptimizationContext) NonReferencedObjsString() (int, string)
NonReferencedObjsString returns a formatted string and the number of objs.
type PDFImage ¶
type PDFImage struct {
// contains filtered or unexported fields
}
PDFImage represents a XObject of subtype image.
type PDFStats ¶
type PDFStats struct {
// contains filtered or unexported fields
}
PDFStats is a container for stats.
func (PDFStats) AddPageAttr ¶
AddPageAttr adds the occurrence of a field with given name to the pageAttrs set.
func (PDFStats) AddRootAttr ¶
AddRootAttr adds the occurrence of a field with given name to the rootAttrs set.
func (PDFStats) UsesPageAttr ¶
UsesPageAttr returns true if a field with given name is contained in the pageAttrs set.
func (PDFStats) UsesRootAttr ¶
UsesRootAttr returns true if a field with given name is contained in the rootAttrs set.
type Page ¶
Page represents rendered page content.
func NewPageWithBg ¶
func NewPageWithBg(mediaBox *Rectangle, c SimpleColor) Page
NewPageWithBg creates a page for a mediaBox.
type PageResourceNames ¶
PageResourceNames represents the required resource names for a specific page as extracted from its content streams.
func NewPageResourceNames ¶
func NewPageResourceNames() PageResourceNames
NewPageResourceNames returns initialized pageResourceNames.
func (PageResourceNames) HasContent ¶
func (prn PageResourceNames) HasContent() bool
HasContent returns true in any resource names present.
func (PageResourceNames) HasResources ¶
func (prn PageResourceNames) HasResources(s string) bool
HasResources returns true for any resource names present in resource subDict s.
func (PageResourceNames) Resources ¶
func (prn PageResourceNames) Resources(s string) StringSet
Resources returns a set of all required resource names for subdict s.
func (PageResourceNames) String ¶
func (prn PageResourceNames) String() string
type ReadContext ¶
type ReadContext struct { FileName string // Input PDF-File. FileSize int64 // Input file size. EolCount int // 1 or 2 characters used for eol. BinaryTotalSize int64 // total stream data BinaryImageSize int64 // total image stream data BinaryFontSize int64 // total font stream data (fontfiles) BinaryImageDuplSize int64 // total obsolet image stream data after optimization BinaryFontDuplSize int64 // total obsolet font stream data after optimization Linearized bool // File is linearized. Hybrid bool // File is a hybrid PDF file. UsingObjectStreams bool // File is using object streams. ObjectStreams IntSet // All object numbers of any object streams found which need to be decoded. UsingXRefStreams bool // File is using xref streams. XRefStreams IntSet // All object numbers of any xref streams found. // contains filtered or unexported fields }
ReadContext represents the context for reading a PDF file.
func (*ReadContext) IsObjectStreamObject ¶
func (rc *ReadContext) IsObjectStreamObject(i int) bool
IsObjectStreamObject returns true if object i is a an object stream. All compressed objects are object streams.
func (*ReadContext) IsXRefStreamObject ¶
func (rc *ReadContext) IsXRefStreamObject(i int) bool
IsXRefStreamObject returns true if object #i is a an xref stream.
func (*ReadContext) LogStats ¶
func (rc *ReadContext) LogStats(optimized bool)
LogStats logs stats for read file.
func (*ReadContext) ObjectStreamsString ¶
func (rc *ReadContext) ObjectStreamsString() (int, string)
ObjectStreamsString returns a formatted string and the number of object stream objects.
func (*ReadContext) ReadFileSize ¶
func (rc *ReadContext) ReadFileSize() int
ReadFileSize returns the size of the input file, if there is one.
func (*ReadContext) XRefStreamsString ¶
func (rc *ReadContext) XRefStreamsString() (int, string)
XRefStreamsString returns a formatted string and the number of xref stream objects.
type Rectangle ¶
Rectangle represents a rectangular region in userspace.
func RectForArray ¶
RectForArray returns a new rectangle for given Array.
func RectForDim ¶
RectForDim returns a new rectangle for given dimensions.
func RectForFormat ¶
RectForFormat returns a new rectangle for given format.
func RectForWidthAndHeight ¶
RectForWidthAndHeight returns a new rectangle for given dimensions.
func WriteColumn ¶
func WriteColumn(buf *bytes.Buffer, mediaBox, region *Rectangle, td TextDescriptor, width float64) *Rectangle
WriteColumn writes a text column using s at position x/y using a certain font, fontsize and a desired horizontal and vertical alignment. Enforce a desired column width by supplying a width > 0 (especially useful for justified text). It returns the bounding box of this column.
func WriteColumnAnchored ¶
func WriteColumnAnchored(buf *bytes.Buffer, mediaBox, region *Rectangle, td TextDescriptor, a anchor, width float64) *Rectangle
WriteColumnAnchored writes a justified text column with anchored position and returns its bounding box.
func WriteMultiLine ¶
func WriteMultiLine(buf *bytes.Buffer, mediaBox, region *Rectangle, td TextDescriptor) *Rectangle
WriteMultiLine writes s at position x/y using a certain font, fontsize and a desired horizontal and vertical alignment. It returns the bounding box of this text column.
func WriteMultiLineAnchored ¶
func WriteMultiLineAnchored(buf *bytes.Buffer, mediaBox, region *Rectangle, td TextDescriptor, a anchor) *Rectangle
WriteMultiLineAnchored writes multiple lines with anchored position and returns its bounding box.
func (Rectangle) CroppedCopy ¶
CroppedCopy returns a copy of r with applied margin..
func (Rectangle) FitsWithin ¶
FitsWithin returns true if rectangle r fits within rectangle r2.
func (Rectangle) ScaledHeight ¶
ScaledHeight returns the height for given width according to r's aspect ratio.
func (Rectangle) ScaledWidth ¶
ScaledWidth returns the width for given height according to r's aspect ratio.
type RenderMode ¶
type RenderMode int
RenderMode represents the text rendering mode (see 9.3.6)
const ( RMFill RenderMode = iota RMStroke RMFillAndStroke )
Render mode
type SimpleColor ¶
type SimpleColor struct {
R, G, B float32 // intensities between 0 and 1.
}
SimpleColor is a simple rgb wrapper.
func NewSimpleColor ¶
func NewSimpleColor(rgb uint32) SimpleColor
NewSimpleColor returns a SimpleColor for rgb in the form 0x00RRGGBB
func (SimpleColor) String ¶
func (sc SimpleColor) String() string
type StreamDict ¶
type StreamDict struct { Dict StreamOffset int64 StreamLength *int64 StreamLengthObjNr *int FilterPipeline []PDFFilter Raw []byte // Encoded Content []byte // Decoded IsPageContent bool }
StreamDict represents a PDF stream dict object.
func NewStreamDict ¶
func NewStreamDict(d Dict, streamOffset int64, streamLength *int64, streamLengthObjNr *int, filterPipeline []PDFFilter) StreamDict
NewStreamDict creates a new PDFStreamDict for given PDFDict, stream offset and length.
func ReadJPEG ¶
ReadJPEG generates a PDF image object for a JPEG stream and appends this object to the cross reference table.
func (*StreamDict) Decode ¶
func (sd *StreamDict) Decode() error
Decode applies sd's filter pipeline to sd.Raw in order to produce sd.Content.
func (*StreamDict) Encode ¶
func (sd *StreamDict) Encode() error
Encode applies sd's filter pipeline to sd.Content in order to produce sd.Raw.
func (StreamDict) HasSoleFilterNamed ¶
func (sd StreamDict) HasSoleFilterNamed(filterName string) bool
HasSoleFilterNamed returns true if sd has a filterPipeline with 1 filter named filterName.
type StringLiteral ¶
type StringLiteral string
StringLiteral represents a PDF string literal object.
func (StringLiteral) Clone ¶
func (stringliteral StringLiteral) Clone() Object
Clone returns a clone of stringLiteral.
func (StringLiteral) PDFString ¶
func (stringliteral StringLiteral) PDFString() string
PDFString returns a string representation as found in and written to a PDF file.
func (StringLiteral) String ¶
func (stringliteral StringLiteral) String() string
func (StringLiteral) Value ¶
func (stringliteral StringLiteral) Value() string
Value returns a string value for this PDF object.
type StringSet ¶
StringSet is a set of strings.
func NewStringSet ¶
NewStringSet returns a new StringSet for slice.
type TextDescriptor ¶
type TextDescriptor struct { Text string // A multi line string using \n for line breaks. FontName string // Corefont name to be used. FontKey string // Resource id registered for FontName. FontSize int // Fontsize in points. X, Y float64 // Position of first char's baseline. Dx, Dy float64 // Horizontal and vertical offsets for X,Y. MTop, MBot float64 // Top and bottom margins applied to text bounding box. MLeft, MRight float64 // Left and right margins applied to text bounding box. MinHeight float64 // The minimum height of this text's bounding box. Rotation float64 // 0..360 degree rotation angle. ScaleAbs bool // Scaling type, true=absolute, false=relative to container dimensions. Scale float64 // font scaling factor > 0 (<= 1 for relative scaling). HAlign HAlignment // Horizontal text alignment. VAlign VAlignment // Vertical text alignment. RMode RenderMode // Text render mode StrokeCol SimpleColor // Stroke color to be used for rendering text corresponding to RMode. FillCol SimpleColor // Fill color to be used for rendering text corresponding to RMode. ShowTextBB bool // Render bounding box including BackgroundCol, border and margins. ShowBackground bool // Render background of bounding box using BackgroundCol. BackgroundCol SimpleColor // Bounding box fill color. ShowBorder bool // Render border using BorderCol, BorderWidth and BorderStyle. BorderWidth float64 // Border width, visibility depends on ShowBorder. BorderStyle LineJoinStyle // Border style, also visible if ShowBorder is false as long as ShowBackground is true. BorderCol SimpleColor // Border color. ParIndent bool // Indent first line of paragraphs or space between paragraphs. // Testing ShowLineBB bool // Render line bounding boxes in black. ShowMargins bool // Render all margins in light gray. HairCross bool // Draw haircross at X,Y. }
TextDescriptor contains all attributes needed for rendering a text column in PDF user space.
type VAlignment ¶
type VAlignment int
VAlignment represents the vertical alignment of text.
const ( AlignBaseline VAlignment = iota AlignTop AlignMiddle AlignBottom )
These are the options for vertical aligned text.
type Version ¶
type Version int
Version is a type for the internal representation of PDF versions.
func PDFVersion ¶
PDFVersion returns the PDFVersion for a version string.
type Watermark ¶
type Watermark struct { // configuration Mode int // WMText, WMImage or WMPDF TextString string // raw display text. TextLines []string // display multiple lines of text. FileName string // display pdf page or png image. Page int // the page number of a PDF file. 0 means multistamp/multiwatermark. OnTop bool // if true this is a STAMP else this is a WATERMARK. Pos anchor // position anchor, one of tl,tc,tr,l,c,r,bl,bc,br. Dx, Dy int // anchor offset. HAlign *HAlignment // horizonal alignment for text watermarks. FontName string // supported are Adobe base fonts only. (as of now: Helvetica, Times-Roman, Courier) FontSize int // font scaling factor. ScaledFontSize int // font scaling factor for a specific page Color SimpleColor // text fill color(=non stroking color) for backwards compatibility. FillColor SimpleColor // text fill color(=non stroking color). StrokeColor SimpleColor // text stroking color BgColor *SimpleColor // text bounding box background color MLeft, MRight int // left and right bounding box margin MTop, MBot int // top and bottom bounding box margin BorderWidth int // Border width, visible if BgColor is set. BorderStyle LineJoinStyle // Border style (bounding box corner style), visible if BgColor is set. BorderColor *SimpleColor // border color Rotation float64 // rotation to apply in degrees. -180 <= x <= 180 Diagonal int // paint along the diagonal. UserRotOrDiagonal bool // true if one of rotation or diagonal provided overriding the default. Opacity float64 // opacity the watermark. 0 <= x <= 1 RenderMode RenderMode // fill=0, stroke=1 fill&stroke=2 Scale float64 // relative scale factor: 0 <= x <= 1, absolute scale factor: 0 <= x ScaleAbs bool // true for absolute scaling. Update bool // true for updating instead of adding a page watermark. // contains filtered or unexported fields }
Watermark represents the basic structure and command details for the commands "Stamp" and "Watermark".
func DefaultWatermarkConfig ¶
func DefaultWatermarkConfig() *Watermark
DefaultWatermarkConfig returns the default configuration.
func ParseImageWatermarkDetails ¶
ParseImageWatermarkDetails parses a text Watermark/Stamp command string into an internal structure.
func ParsePDFWatermarkDetails ¶
ParsePDFWatermarkDetails parses a text Watermark/Stamp command string into an internal structure.
func ParseTextWatermarkDetails ¶
ParseTextWatermarkDetails parses a text Watermark/Stamp command string into an internal structure.
func (Watermark) OnTopString ¶
OnTopString returns "watermark" or "stamp" whichever applies.
type WriteContext ¶
type WriteContext struct { // The PDF-File which gets generated. *bufio.Writer // A writer associated with Fp. Fp *os.File // A file pointer needed for detecting FileSize. FileSize int64 // The size of the written file. DirName string // The output directory. FileName string // The output file name. SelectedPages IntSet // For split, trim and extract. BinaryTotalSize int64 // total stream data, counts 100% all stream data written. BinaryImageSize int64 // total image stream data written = Read.BinaryImageSize. BinaryFontSize int64 // total font stream data (fontfiles) = copy of Read.BinaryFontSize. Table map[int]int64 // object write offsets Offset int64 // current write offset WriteToObjectStream bool // if true start to embed objects into object streams and obey ObjectStreamMaxObjects. CurrentObjStream *int // if not nil, any new non-stream-object gets added to the object stream with this object number. Eol string // end of line char sequence }
WriteContext represents the context for writing a PDF file.
func NewWriteContext ¶
func NewWriteContext(eol string) *WriteContext
NewWriteContext returns a new WriteContext.
func (*WriteContext) HasWriteOffset ¶
func (wc *WriteContext) HasWriteOffset(objNumber int) bool
HasWriteOffset returns true if an object has already been written to PDFDestination.
func (*WriteContext) LogStats ¶
func (wc *WriteContext) LogStats()
LogStats logs stats for written file.
func (*WriteContext) SetWriteOffset ¶
func (wc *WriteContext) SetWriteOffset(objNumber int)
SetWriteOffset saves the current write offset to the PDFDestination.
func (*WriteContext) WriteEol ¶
func (wc *WriteContext) WriteEol() error
WriteEol writes an end of line sequence.
type XRefStreamDict ¶
type XRefStreamDict struct { StreamDict Size int Objects []int W [3]int PreviousOffset *int64 }
XRefStreamDict represents a cross reference stream dictionary.
func NewXRefStreamDict ¶
func NewXRefStreamDict(ctx *Context) *XRefStreamDict
NewXRefStreamDict creates a new PDFXRefStreamDict object.
type XRefTable ¶
type XRefTable struct { Table map[int]*XRefTableEntry Size *int // Object count from PDF trailer dict. PageCount int // Number of pages. Root *IndirectRef // Pointer to catalog (reference to root object). RootDict Dict // Catalog Names map[string]*Node // Cache for name trees as found in catalog. Encrypt *IndirectRef // Encrypt dict. E *Enc EncKey []byte // Encrypt key. AES4Strings bool AES4Streams bool AES4EmbeddedStreams bool // PDF Version HeaderVersion *Version // The PDF version the source is claiming to us as per its header. RootVersion *Version // Optional PDF version taking precedence over the header version. // Document information section ID Array // from trailer Info *IndirectRef // Infodict (reference to info dict object) Title string Subject string Keywords string Author string Creator string Producer string CreationDate string ModDate string Properties map[string]string // Linearization section (not yet supported) OffsetPrimaryHintTable *int64 OffsetOverflowHintTable *int64 LinearizationObjs IntSet // Offspec section AdditionalStreams *Array // array of IndirectRef - trailer :e.g., Oasis "Open Doc" // Statistics Stats PDFStats Tagged bool // File is using tags. This is important for ??? // Validation Valid bool // true means successful validated against ISO 32000. ValidationMode int // see Configuration Optimized bool Watermarked bool }
XRefTable represents a PDF cross reference table plus stats for a PDF file.
func CreateAcroFormDemoXRef ¶
CreateAcroFormDemoXRef creates an xRefTable with an AcroForm example.
func CreateAnnotationDemoXRef ¶
CreateAnnotationDemoXRef creates a PDF file with examples of annotations and actions.
func CreateDemoXRef ¶
CreateDemoXRef creates a minimal single page PDF file for demo purposes.
func CreateResourceDictInheritanceDemoXRef ¶
CreateResourceDictInheritanceDemoXRef creates a page tree for testing resource dict inheritance.
func (*XRefTable) BindNameTrees ¶
BindNameTrees syncs up the internal name tree cache with the xreftable.
func (*XRefTable) CatalogHasPieceInfo ¶
CatalogHasPieceInfo returns true if the root has an entry for \"PieceInfo\".
func (*XRefTable) DeleteObject ¶
DeleteObject marks an object as free and inserts it into the free list right after the head.
func (*XRefTable) DeleteObjectGraph ¶
DeleteObjectGraph deletes all objects reachable by indRef.
func (*XRefTable) Dereference ¶
Dereference resolves an indirect object and returns the resulting PDF object.
func (*XRefTable) DereferenceArray ¶
DereferenceArray resolves and validates an array object, which may be an indirect reference.
func (*XRefTable) DereferenceBoolean ¶
DereferenceBoolean resolves and validates a boolean object, which may be an indirect reference.
func (*XRefTable) DereferenceCSVSafeText ¶
DereferenceCSVSafeText resolves and validates a string or hex literal object to a string.
func (*XRefTable) DereferenceDict ¶
DereferenceDict resolves and validates a dictionary object, which may be an indirect reference.
func (*XRefTable) DereferenceDictEntry ¶
DereferenceDictEntry returns a dereferenced dict entry.
func (*XRefTable) DereferenceInteger ¶
DereferenceInteger resolves and validates an integer object, which may be an indirect reference.
func (*XRefTable) DereferenceName ¶
func (xRefTable *XRefTable) DereferenceName(o Object, sinceVersion Version, validate func(string) bool) (n Name, err error)
DereferenceName resolves and validates a name object, which may be an indirect reference.
func (*XRefTable) DereferenceNumber ¶
DereferenceNumber resolves a number object, which may be an indirect reference and returns a float64.
func (*XRefTable) DereferenceStreamDict ¶
func (xRefTable *XRefTable) DereferenceStreamDict(o Object) (*StreamDict, error)
DereferenceStreamDict resolves and validates a stream dictionary object, which may be an indirect reference.
func (*XRefTable) DereferenceStreamDictForValidation ¶
func (xRefTable *XRefTable) DereferenceStreamDictForValidation(o Object, onFirstVisitOnly bool) (*StreamDict, error)
DereferenceStreamDictForValidation resolves stream dictionary objects and ensures they are visited once only during validation.
func (*XRefTable) DereferenceStringLiteral ¶
func (xRefTable *XRefTable) DereferenceStringLiteral(o Object, sinceVersion Version, validate func(string) bool) (s StringLiteral, err error)
DereferenceStringLiteral resolves and validates a string literal object, which may be an indirect reference.
func (*XRefTable) DereferenceStringOrHexLiteral ¶
func (xRefTable *XRefTable) DereferenceStringOrHexLiteral(obj Object, sinceVersion Version, validate func(string) bool) (s string, err error)
DereferenceStringOrHexLiteral resolves and validates a string or hex literal object, which may be an indirect reference.
func (*XRefTable) DereferenceText ¶
DereferenceText resolves and validates a string or hex literal object to a string.
func (*XRefTable) DetectPageTreeWatermarks ¶
DetectPageTreeWatermarks checks xRefTable's page tree for watermarks and records the result to xRefTable.Watermarked.
func (*XRefTable) EncryptDict ¶
EncryptDict returns a pointer to the root object / catalog.
func (*XRefTable) EnsureCollection ¶
EnsureCollection makes sure there is a Collection entry in the catalog. Needed for portfolio / portable collections eg. for file attachments.
func (*XRefTable) EnsurePageCount ¶
EnsurePageCount evaluates the page count for xRefTable if necessary. Important when validation is turned off.
func (*XRefTable) EnsureValidFreeList ¶
EnsureValidFreeList ensures the integrity of the free list associated with the recorded free objects. See 7.5.4 Cross-Reference Table
func (*XRefTable) EnsureVersionForWriting ¶
func (xRefTable *XRefTable) EnsureVersionForWriting()
EnsureVersionForWriting sets the version to the highest supported PDF Version 1.7. This is necessary to allow validation after adding features not supported by the original version of a document as during watermarking.
func (*XRefTable) Find ¶
func (xRefTable *XRefTable) Find(objNr int) (*XRefTableEntry, bool)
Find returns the XRefTable entry for given object number.
func (*XRefTable) FindObject ¶
FindObject returns the object of the XRefTableEntry for a specific object number.
func (*XRefTable) FindTableEntry ¶
func (xRefTable *XRefTable) FindTableEntry(objNr int, genNr int) (*XRefTableEntry, bool)
FindTableEntry returns the XRefTable entry for given object and generation numbers.
func (*XRefTable) FindTableEntryForIndRef ¶
func (xRefTable *XRefTable) FindTableEntryForIndRef(ir *IndirectRef) (*XRefTableEntry, bool)
FindTableEntryForIndRef returns the XRefTable entry for given indirect reference.
func (*XRefTable) FindTableEntryLight ¶
func (xRefTable *XRefTable) FindTableEntryLight(objNr int) (*XRefTableEntry, bool)
FindTableEntryLight returns the XRefTable entry for given object number.
func (*XRefTable) Free ¶
func (xRefTable *XRefTable) Free(objNr int) (*XRefTableEntry, error)
Free returns the cross ref table entry for given number of a free object.
func (*XRefTable) IDFirstElement ¶
IDFirstElement returns the first element of ID.
func (*XRefTable) IndRefForNewObject ¶
func (xRefTable *XRefTable) IndRefForNewObject(obj Object) (*IndirectRef, error)
IndRefForNewObject inserts an object into the xRefTable and returns an indirect reference to it.
func (*XRefTable) InsertAndUseRecycled ¶
func (xRefTable *XRefTable) InsertAndUseRecycled(xRefTableEntry XRefTableEntry) (objNr int, err error)
InsertAndUseRecycled adds given xRefTableEntry into the cross reference table utilizing the freelist.
func (*XRefTable) InsertBlankPages ¶
InsertBlankPages inserts a blank page before or after each selected page.
func (*XRefTable) InsertNew ¶
func (xRefTable *XRefTable) InsertNew(xRefTableEntry XRefTableEntry) (objNr int)
InsertNew adds given xRefTableEntry at next new objNumber into the cross reference table. Only to be called once an xRefTable has been generated completely and all trailer dicts have been processed. xRefTable.Size is the size entry of the first trailer dict processed. Called on creation of new object streams. Called by InsertAndUseRecycled.
func (*XRefTable) InsertObject ¶
InsertObject inserts an object into the xRefTable.
func (*XRefTable) IsLinearizationObject ¶
IsLinearizationObject returns true if object #i is a a linearization object.
func (*XRefTable) LinearizationObjsString ¶
LinearizationObjsString returns a formatted string and the number of objs.
func (*XRefTable) LocateNameTree ¶
LocateNameTree locates/ensures a specific name tree.
func (*XRefTable) MissingObjects ¶
MissingObjects returns the number of objects that were not written plus the corresponding comma separated string representation.
func (*XRefTable) NewEmbeddedFileStreamDict ¶
func (xRefTable *XRefTable) NewEmbeddedFileStreamDict(filename string) (*IndirectRef, error)
NewEmbeddedFileStreamDict returns an embeddedFileStreamDict containing the file "filename".
func (*XRefTable) NewEmbeddedStreamDict ¶
func (xRefTable *XRefTable) NewEmbeddedStreamDict(r io.Reader, modDate time.Time) (*IndirectRef, error)
NewEmbeddedStreamDict creates and returns an embeddedStreamDict containing the bytes represented by r.
func (*XRefTable) NewFileSpecDict ¶
func (xRefTable *XRefTable) NewFileSpecDict(filename, desc string, indRefStreamDict IndirectRef) (Dict, error)
NewFileSpecDict creates and returns a new fileSpec dictionary.
func (*XRefTable) NewFileSpectDictForAttachment ¶
func (xRefTable *XRefTable) NewFileSpectDictForAttachment(a Attachment) (*IndirectRef, error)
NewFileSpectDictForAttachment returns a fileSpecDict for a.
func (*XRefTable) NewSoundStreamDict ¶
func (xRefTable *XRefTable) NewSoundStreamDict(filename string, samplingRate int, fileSpecDict Dict) (*IndirectRef, error)
NewSoundStreamDict returns a new sound stream dict.
func (*XRefTable) NewStreamDictForBuf ¶
func (xRefTable *XRefTable) NewStreamDictForBuf(buf []byte) (*StreamDict, error)
NewStreamDictForBuf creates a streamDict for buf.
func (*XRefTable) NewStreamDictForFile ¶
func (xRefTable *XRefTable) NewStreamDictForFile(filename string) (*StreamDict, error)
NewStreamDictForFile creates a streamDict for filename.
func (*XRefTable) NextForFree ¶
NextForFree returns the number of the object the free object with objNumber links to. This is the successor of this free object in the free list.
func (*XRefTable) Outlines ¶
func (xRefTable *XRefTable) Outlines() (*IndirectRef, error)
Outlines returns the Outlines reference contained in the catalog.
func (*XRefTable) PageContent ¶
PageContent returns the content in PDF syntax for page dict d.
func (*XRefTable) PageDict ¶
func (xRefTable *XRefTable) PageDict(page int, consolidateRes bool) (Dict, *InheritedPageAttrs, error)
PageDict returns a specific page dict along with the resources, mediaBox and CropBox in effect.
func (*XRefTable) PageDims ¶
PageDims returns a sorted slice with media box dimensions for all pages sorted ascending by page number.
func (*XRefTable) PageNumber ¶
PageNumber returns the logical page number for a page dict object number.
func (*XRefTable) Pages ¶
func (xRefTable *XRefTable) Pages() (*IndirectRef, error)
Pages returns the Pages reference contained in the catalog.
func (*XRefTable) ParseRootVersion ¶
ParseRootVersion returns a string representation for an optional Version entry in the root object.
func (*XRefTable) RemoveCollection ¶
RemoveCollection removes an existing Collection entry from the catalog.
func (*XRefTable) RemoveEmbeddedFilesNameTree ¶
RemoveEmbeddedFilesNameTree removes both the embedded files name tree and the Collection dict.
func (*XRefTable) RemoveNameTree ¶
RemoveNameTree removes a specific name tree. Also removes a resulting empty names dict.
func (*XRefTable) UndeleteObject ¶
UndeleteObject ensures an object is not recorded in the free list. e.g. sometimes caused by indirect references to free objects in the original PDF file.
func (*XRefTable) ValidateVersion ¶
ValidateVersion validates against the xRefTable's version.
func (*XRefTable) Version ¶
Version returns the PDF version of the PDF writer that created this file. Before V1.4 this is the header version. Since V1.4 the catalog may contain a Version entry which takes precedence over the header version.
func (*XRefTable) VersionString ¶
VersionString return a string representation for this PDF files PDF version.
type XRefTableEntry ¶
type XRefTableEntry struct { Free bool Offset *int64 Generation *int RefCount int Object Object Compressed bool ObjectStream *int ObjectStreamInd *int Valid bool }
XRefTableEntry represents an entry in the PDF cross reference table.
This may wrap a free object, a compressed object or any in use PDF object:
Dict, StreamDict, ObjectStreamDict, PDFXRefStreamDict, Array, Integer, Float, Name, StringLiteral, HexLiteral, Boolean
func NewFreeHeadXRefTableEntry ¶
func NewFreeHeadXRefTableEntry() *XRefTableEntry
NewFreeHeadXRefTableEntry returns the xref table entry for object 0 which is per definition the head of the free list (list of free objects).
func NewXRefTableEntryGen0 ¶
func NewXRefTableEntryGen0(obj Object) *XRefTableEntry
NewXRefTableEntryGen0 returns a cross reference table entry for an object with generation 0.
Source Files ¶
- array.go
- attach.go
- bookmarks.go
- collect.go
- colorSpace.go
- configuration.go
- context.go
- create.go
- createAnnotations.go
- createRenditions.go
- createTestPDF.go
- crypto.go
- date.go
- dict.go
- doc.go
- equal.go
- extract.go
- iccProfile.go
- importImage.go
- info.go
- keywords.go
- merge.go
- nameTree.go
- nup.go
- optimize.go
- pages.go
- paperSize.go
- parse.go
- parseConfig.go
- parseContent.go
- properties.go
- read.go
- readImage.go
- renderImage.go
- resources.go
- rotate.go
- slice.go
- stamp.go
- stats.go
- streamdict.go
- string.go
- types.go
- utf16.go
- version.go
- write.go
- writeObjects.go
- writePages.go
- writeStats.go
- xreftable.go