knuth

README

Package knuth

import path "modernc.org/knuth"

Package knuth collects utilities common to all other packages in this repository.

Documentation: godoc.org/modernc.org/knuth

Installation

To install all the included go... commands found in cmd/

$ go install modernc.org/knuth/cmd...@latest

Hacking

Make sure you have these utilities from the Tex-live package(s) installed in your $PATH:

dvitype
gftopk
gftype
mf
mft
pooltype
tangle
tex
tftopl
vftovp
vptovf
weave

These programs are used only to generate test data. Users of packages/commands in this repository do not need them installed.

You will also need to perform

$ go install modernc.org/unconvert2@latest

After modification of any sources, run '$ make' in the repository root. That will regenerate all applicable Go code and testdata, run the tests of all packages in this repository and install all the commands found in ./cmd

Documentation

Overview

Package knuth collects utilities common to all other packages in this repository.

To install all the included go* commands found in cmd/

$ go install modernc.org/knuth/cmd...@latest

Documentation

http://godoc.org/modernc.org/knuth

Hacking

Make sure you have these utilities from the Tex-live package(s) installed in your $PATH:

dvitype
gftopk
gftype
mf
mft
pooltype
tangle
tex
tftopl
vftovp
vptovf
weave

These programs are used only to generate test data. Users of packages/commands in this repository do not need them installed.

You will also need to perform

$ go install modernc.org/unconvert2@latest

After modification of any sources, run '$ make' in the repository root. That will regenerate all applicable Go code and testdata, run tests of all packages in this repository and install all the commands found in ./cmd.

If your local clone of the repository is private, you need to setup the GOPRIVATE environment variable properly for the tests to pass.

Index

• Variables
• func Open(name string, search []string) (f fs.File, err error)
• type Changer
  • func NewChanger(src, changes RuneSource) (*Changer, error)
  • func (c *Changer) AddLineColumnInfo(offset int, filename string, line, column int)
  • func (c *Changer) C() (rune, error)
  • func (c *Changer) Consume()
  • func (c *Changer) Position() (r token.Position)
  • func (c *Changer) PositionFor(off int) token.Position
• type Error
  • func (e Error) Error() string
• type File
  • func NewBinaryFile(r io.Reader, w io.Writer, sizeofT int, open func(string) (io.Reader, error)) File
  • func NewPoolFile(pool string) File
  • func NewTextFile(r io.Reader, w io.Writer, open func(string) (io.Reader, error)) File
• type Line
  • func ReadLine(s RuneSource) (line *Line, err error)
  • func ReadLine2(s RuneSource) (line *Line, err error)
• type RuneSource
  • func NewRuneSource(name string, src []byte, validator RuneValidator) RuneSource
• type RuneValidator
• type WriteWidth

Variables

var (
	// ASCII is a RuneValidator accepting runes '\x00' ... '\xff`.
	ASCII asciiValidator
	// Unicode is a RuneValidator accepting all valid unicode code points
	// except those in category Co and Cs.
	Unicode unicodeValidator

	// Assets provides some essential resources:
	//
	//  fonts/cm/mf/* from https://ctan.org/tex-archive/systems/knuth/dist/cm
	//  lib/* from https://ctan.org/tex-archive/systems/knuth/dist/lib
	Assets fs.FS = newCFS(assets)
)

Functions

func Open

func Open(name string, search []string) (f fs.File, err error)

Open attempts to open 'name'. If not successful then it tries to open 'name' using 'search' paths. If still not found then Open may try to find the resource in Assets.

If all letters of the base name of 'name' are upper case then the preceding steps may be extended by additionally looking for the lower case alternative of 'name'.

The caller is responsible to properly .Close any returned non-nil fs.Files to avoid resource exhaustion.

Types

type Changer

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

Changer is a RuneSource implementing patching source using a change file.

func NewChanger

func NewChanger(src, changes RuneSource) (*Changer, error)

NewChanger returns a newly created Changer or an error, if any.

func (*Changer) AddLineColumnInfo

func (c *Changer) AddLineColumnInfo(offset int, filename string, line, column int)

AddLineColumnInfo implements RuneSource, but is a no-op.

func (*Changer) C

func (c *Changer) C() (rune, error)

C implements RuneSource.

func (*Changer) Consume

func (c *Changer) Consume()

Consume implements RuneSource.

func (*Changer) Position

func (c *Changer) Position() (r token.Position)

Position implements RuneSource.

func (*Changer) PositionFor

func (c *Changer) PositionFor(off int) token.Position

PositionFor implements RuneSource.

type Error

type Error string

Error is a specific error implementation.

func (Error) Error

func (e Error) Error() string

type File

type File interface {
	ByteP() *byte
	Close()
	CurPos() int32
	Data4P() *[4]byte
	EOF() bool
	EOLN() bool
	ErStat() int32
	Get()
	Put()
	Read(args ...interface{})
	Readln(args ...interface{})
	Reset(args ...interface{})
	Rewrite(args ...interface{})
	SetPos(int32)
	Write(args ...interface{})
	Writeln(args ...interface{})
}

File represents a Pascal file.

func NewBinaryFile

func NewBinaryFile(r io.Reader, w io.Writer, sizeofT int, open func(string) (io.Reader, error)) File

NewBinaryFile returns a File suitable for Pascal file type 'file of T'.

func NewPoolFile

func NewPoolFile(pool string) File

NewPoolFile returns a read only File with a string pool.

func NewTextFile

func NewTextFile(r io.Reader, w io.Writer, open func(string) (io.Reader, error)) File

NewTextFile returns File suitable for Pascal file type 'text'.

type Line

type Line struct {
	Position token.Position
	Src      string
}

Line represents a source line and its position.

func ReadLine

func ReadLine(s RuneSource) (line *Line, err error)

ReadLine reads from s up to and including the next newline, if any. If s is at EOF, (nil, io.EOF) is returned.

func ReadLine2

func ReadLine2(s RuneSource) (line *Line, err error)

ReadLine2 is like ReadLine but additionally trims trailing space. The final '\n' is preserved, if any.

type RuneSource

type RuneSource interface {
	// AddLineColumnInfo adds alternative file, line, and column number information
	// for a given file offset. The offset must be larger than the offset for the
	// previously added alternative line info and smaller than the file size;
	// otherwise the information is ignored.
	//
	// AddLineColumnInfo is typically used to register alternative position
	// information for line directives such as //line filename:line:column.
	AddLineColumnInfo(offset int, filename string, line, column int)
	// C returns the current rune or and error, if any.
	C() (rune, error)
	// Consume moves to the next rune, if any.
	Consume()
	// Position returns the current position.
	Position() token.Position
	// PositionFor returns the position for zero based offset.
	PositionFor(off int) token.Position
}

RuneSource provides a finite stream of runes.

func NewRuneSource

func NewRuneSource(name string, src []byte, validator RuneValidator) RuneSource

NewRuneSource returns a newly created Source. Positions will be reported as coming from 'name'. 'src' is UTF-8 encoded. Decoded runes will be validated by 'validator'.

type RuneValidator

type RuneValidator interface {
	// Validate returns true if its argument is in the accepted rune set.
	Validate(rune) bool
}

RuneValidator validates runes.

type WriteWidth

type WriteWidth int

WriteWidth is the type of width in `writeln(foo: width);`.