pos

Documentation

Overview

Package pos implements the position of a lexical dotted item

Index

• type Pos
  • func From(stack []int) *Pos
  • func New() *Pos
  • func (pos *Pos) Clone() *Pos
  • func (pos *Pos) Equal(other *Pos) bool
  • func (pos *Pos) Inc() *Pos
  • func (pos *Pos) Len() int
  • func (pos *Pos) Peek(height int) int
  • func (pos *Pos) Pop(n int) *Pos
  • func (pos *Pos) Push(p int) *Pos
  • func (pos *Pos) String() string
  • func (pos *Pos) Tail() *Pos
  • func (pos *Pos) Top() int

Types

type Pos

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

Pos contains the position of a lexical Item

func From

func From(stack []int) *Pos

From returns a Pos derived from the position stack, `stack`

func New

func New() *Pos

New returns a new position before the first symbol

func (*Pos) Clone

func (pos *Pos) Clone() *Pos

Clone returns a deep copy of pos

func (*Pos) Equal

func (pos *Pos) Equal(other *Pos) bool

Equal is true if the two stacks are the same

func (*Pos) Inc

func (pos *Pos) Inc() *Pos

Inc increments the value of pos.Top(). It returns pos for command chaining

func (*Pos) Len

func (pos *Pos) Len() int

Len returns the number of items on the stack

func (*Pos) Peek

func (pos *Pos) Peek(height int) int

Peek returns the value of the item at height above the bottom of the stack. Pos remains unmodified

func (*Pos) Pop

func (pos *Pos) Pop(n int) *Pos

Pop removes the top n elements from the stack. Pop returns a self pointer for command chaining.

func (*Pos) Push

func (pos *Pos) Push(p int) *Pos

Push pushes p onto the stack and returns a pointer to itself for command chainging.

func (*Pos) String

func (pos *Pos) String() string

func (*Pos) Tail

func (pos *Pos) Tail() *Pos

func (*Pos) Top

func (pos *Pos) Top() int

Top returns the value at the top of the stack without changing the stack