ptn

Documentation

Index

• func FormatMove(m tak.Move) string
• func FormatMoveLong(m tak.Move) string
• func FormatTPS(p *tak.Position) string
• func ParseMove(move string) (tak.Move, error)
• func ParseTPS(tpn string) (*tak.Position, error)
• type Comment
  • func (o Comment) Source() string
• type Iterator
  • func (i *Iterator) Err() error
  • func (i *Iterator) Move() tak.Move
  • func (i *Iterator) Next() bool
  • func (i *Iterator) PTNMove() int
  • func (i *Iterator) PeekMove() tak.Move
  • func (i *Iterator) Position() *tak.Position
• type Move
  • func (o Move) Source() string
• type MoveNumber
  • func (o MoveNumber) Source() string
• type Op
• type PTN
  • func ParseFile(path string) (*PTN, error)
  • func ParsePTN(r io.Reader) (*PTN, error)
  • func (p *PTN) AddMoves(moves []tak.Move)
  • func (p *PTN) FindTag(name string) string
  • func (p *PTN) InitialPosition() (*tak.Position, error)
  • func (p *PTN) Iterator() *Iterator
  • func (p *PTN) PositionAtMove(move int, color tak.Color) (*tak.Position, error)
  • func (p *PTN) Render() string
• type Result
  • func ResultFromGame(p *tak.Position) Result
  • func (o Result) Source() string
  • func (r *Result) Winner() tak.Color
• type Tag

Functions

func FormatMove

func FormatMove(m tak.Move) string

func FormatMoveLong

func FormatMoveLong(m tak.Move) string

func FormatTPS

func FormatTPS(p *tak.Position) string

func ParseMove

func ParseMove(move string) (tak.Move, error)

func ParseTPS

func ParseTPS(tpn string) (*tak.Position, error)

Types

type Comment

type Comment struct {
	Comment string
	// contains filtered or unexported fields
}

func (Comment) Source

func (o Comment) Source() string

type Iterator

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

func (*Iterator) Err

func (i *Iterator) Err() error

func (*Iterator) Move

func (i *Iterator) Move() tak.Move

func (*Iterator) Next

func (i *Iterator) Next() bool

func (*Iterator) PTNMove

func (i *Iterator) PTNMove() int

func (*Iterator) PeekMove

func (i *Iterator) PeekMove() tak.Move

func (*Iterator) Position

func (i *Iterator) Position() *tak.Position

type Move

type Move struct {
	Move      tak.Move
	Modifiers string
	// contains filtered or unexported fields
}

func (Move) Source

func (o Move) Source() string

type MoveNumber

type MoveNumber struct {
	Number int
	// contains filtered or unexported fields
}

func (MoveNumber) Source

func (o MoveNumber) Source() string

type Op

type Op interface {
	Source() string
	// contains filtered or unexported methods
}

type PTN

type PTN struct {
	Tags []Tag
	Ops  []Op
}

func ParseFile

func ParseFile(path string) (*PTN, error)

func ParsePTN

func ParsePTN(r io.Reader) (*PTN, error)

func (*PTN) AddMoves

func (p *PTN) AddMoves(moves []tak.Move)

func (*PTN) FindTag

func (p *PTN) FindTag(name string) string

func (*PTN) InitialPosition

func (p *PTN) InitialPosition() (*tak.Position, error)

func (*PTN) Iterator

func (p *PTN) Iterator() *Iterator

func (*PTN) PositionAtMove

func (p *PTN) PositionAtMove(move int, color tak.Color) (*tak.Position, error)

PositionAtMove returns the position of the game after PTN move marker `move`, with `color` to play.

`move=0` will cause the code to return the final position of the game.

func (*PTN) Render

func (p *PTN) Render() string

type Result

type Result struct {
	Result string
	// contains filtered or unexported fields
}

func ResultFromGame

func ResultFromGame(p *tak.Position) Result

func (Result) Source

func (o Result) Source() string

func (*Result) Winner

func (r *Result) Winner() tak.Color

type Tag

type Tag struct {
	Name  string
	Value string
}