type3

Documentation

Overview

Package type3 provides support for embedding type 3 fonts into PDF documents.

Index

• type EmbedInfo
  • func Extract(r pdf.Getter, dicts *font.Dicts) (*EmbedInfo, error)
  • func (info *EmbedInfo) Embed(w pdf.Putter, fontDictRef pdf.Reference) error
• type Font
  • func New(unitsPerEm uint16) *Font
  • func (f *Font) AddGlyph(name string, widthX funit.Int16, bbox funit.Rect16, shapeOnly bool) (*GlyphBuilder, error)
  • func (f *Font) Embed(w pdf.Putter, resName pdf.Name) (font.Embedded, error)
  • func (f *Font) GetGeometry() *font.Geometry
  • func (f *Font) Layout(s string, ptSize float64) glyph.Seq
• type Glyph
• type GlyphBuilder
  • func (g *GlyphBuilder) Close() error

Types

type EmbedInfo

type EmbedInfo struct {
	Glyphs map[string]*Glyph

	FontMatrix [6]float64

	// Encoding (a slice of length 256) is the encoding vector used by the client.
	// This is used to construct the `Encoding` entry of the PDF font dictionary.
	Encoding []string

	// ResName is the resource name for the font.
	// This is only used for PDF version 1.0.
	ResName pdf.Name

	// Resources is the resource dictionary for the font.
	Resources *pdf.Resources // TODO(voss): include the individual fields instead

	ItalicAngle float64

	IsFixedPitch bool
	IsSerif      bool
	IsScript     bool
	ForceBold    bool

	IsAllCap   bool
	IsSmallCap bool

	// ToUnicode (optional) is a map from character codes to unicode strings.
	ToUnicode *tounicode.Info
}

EmbedInfo contains the information needed to embed a type 3 font into a PDF document.

func Extract

func Extract(r pdf.Getter, dicts *font.Dicts) (*EmbedInfo, error)

Extract extracts information about a type 3 font from a PDF file.

func (*EmbedInfo) Embed

func (info *EmbedInfo) Embed(w pdf.Putter, fontDictRef pdf.Reference) error

Embed implements the font.Font interface.

type Font

type Font struct {
	Glyphs map[string]*Glyph

	Ascent             funit.Int16
	Descent            funit.Int16
	BaseLineSkip       funit.Int16
	UnderlinePosition  funit.Float64
	UnderlineThickness funit.Float64

	ItalicAngle  float64
	IsFixedPitch bool
	IsSerif      bool
	IsScript     bool
	IsItalic     bool
	IsAllCap     bool
	IsSmallCap   bool
	ForceBold    bool

	FontMatrix [6]float64
	Resources  *pdf.Resources

	CMap map[rune]glyph.ID
	// contains filtered or unexported fields
}

Font is a PDF type 3 font.

func New

func New(unitsPerEm uint16) *Font

New creates a new type 3 font. Initally the font does not contain any glyphs. Use Font.AddGlyph to add glyphs to the font.

func (*Font) AddGlyph

func (f *Font) AddGlyph(name string, widthX funit.Int16, bbox funit.Rect16, shapeOnly bool) (*GlyphBuilder, error)

AddGlyph adds a new glyph to the type 3 font.

If shapeOnly is true, a call to the "d1" operator is added at the start of the glyph description. In this case, the glyph description may only specify the shape of the glyph, but not its color. Otherwise, a call to the "d0" operator is added at the start of the glyph description. In this case, the glyph description may specify both the shape and the color of the glyph.

func (*Font) Embed

func (f *Font) Embed(w pdf.Putter, resName pdf.Name) (font.Embedded, error)

Embed implements the font.Font interface.

func (*Font) GetGeometry

func (f *Font) GetGeometry() *font.Geometry

GetGeometry implements the font.Font interface.

func (*Font) Layout

func (f *Font) Layout(s string, ptSize float64) glyph.Seq

Layout implements the font.Font interface.

type Glyph

type Glyph struct {
	WidthX funit.Int16
	BBox   funit.Rect16
	Data   []byte
}

Glyph is a glyph in a type 3 font.

type GlyphBuilder

type GlyphBuilder struct {
	*graphics.Page
	// contains filtered or unexported fields
}

GlyphBuilder is used to write a glyph description as described in section 9.6.5 of PDF 32000-1:2008. The .Close() method must be called after the description has been written.

func (*GlyphBuilder) Close

func (g *GlyphBuilder) Close() error

Close most be called after the glyph description has been written.