ast

Documentation

Overview

Package ast declares the types used to represent syntax trees for kpr files.

Index

• type Amount
  • func (a *Amount) End() token.Pos
  • func (a *Amount) Pos() token.Pos
• type AmountLine
• type BadEntry
  • func (b *BadEntry) End() token.Pos
  • func (b *BadEntry) Pos() token.Pos
• type BadLine
  • func (b *BadLine) End() token.Pos
  • func (b *BadLine) Pos() token.Pos
• type BalanceHeader
  • func (b *BalanceHeader) End() token.Pos
  • func (b *BalanceHeader) Pos() token.Pos
• type BasicValue
  • func (v *BasicValue) End() token.Pos
  • func (v *BasicValue) Pos() token.Pos
• type Comment
  • func (c *Comment) End() token.Pos
  • func (c *Comment) Pos() token.Pos
• type CommentGroup
  • func (c *CommentGroup) End() token.Pos
  • func (c *CommentGroup) Pos() token.Pos
• type DeclareAccount
  • func (c *DeclareAccount) End() token.Pos
  • func (c *DeclareAccount) Pos() token.Pos
• type DisableAccount
  • func (c *DisableAccount) End() token.Pos
  • func (c *DisableAccount) Pos() token.Pos
• type End
  • func (d *End) End() token.Pos
  • func (d *End) Pos() token.Pos
• type Entry
• type File
• type LineNode
• type MetadataLine
  • func (v *MetadataLine) End() token.Pos
  • func (v *MetadataLine) Pos() token.Pos
• type MultiBalance
  • func (b *MultiBalance) End() token.Pos
• type Node
• type SingleBalance
  • func (b *SingleBalance) End() token.Pos
• type SplitLine
  • func (s *SplitLine) End() token.Pos
  • func (s *SplitLine) Pos() token.Pos
• type Transaction
  • func (t *Transaction) End() token.Pos
  • func (t *Transaction) Pos() token.Pos
• type UnitDecl
  • func (u *UnitDecl) End() token.Pos
  • func (u *UnitDecl) Pos() token.Pos

Types

type Amount

type Amount struct {
	Decimal *BasicValue // DECIMAL
	Unit    *BasicValue // USYMBOL
}

An Amount node represents an amount.

func (*Amount) End

func (a *Amount) End() token.Pos

func (*Amount) Pos

func (a *Amount) Pos() token.Pos

type AmountLine

type AmountLine struct {
	*Amount
}

An AmountLine node represents an amount line node.

type BadEntry

type BadEntry struct {
	From, To token.Pos
}

A BadEntry node is a placeholder for an entry containing syntax errors for which a correct entry node cannot be created.

func (*BadEntry) End

func (b *BadEntry) End() token.Pos

func (*BadEntry) Pos

func (b *BadEntry) Pos() token.Pos

type BadLine

type BadLine struct {
	From, To token.Pos
}

A BadLine node is a placeholder for a line containing syntax errors for which a correct line node cannot be created.

func (*BadLine) End

func (b *BadLine) End() token.Pos

func (*BadLine) Pos

func (b *BadLine) Pos() token.Pos

type BalanceHeader

type BalanceHeader struct {
	TokPos  token.Pos
	Token   token.Token
	Date    *BasicValue // DATE
	Account *BasicValue // ACCTNAME
}

A BalanceHeader contains the fields shared by balance entry nodes.

func (*BalanceHeader) End

func (b *BalanceHeader) End() token.Pos

func (*BalanceHeader) Pos

func (b *BalanceHeader) Pos() token.Pos

type BasicValue

type BasicValue struct {
	ValuePos token.Pos
	Kind     token.Token // STRING, USYMBOL, ACCTNAME, DECIMAL, DATE
	Value    string
}

A BasicValue node represents a basic single token value.

func (*BasicValue) End

func (v *BasicValue) End() token.Pos

func (*BasicValue) Pos

func (v *BasicValue) Pos() token.Pos

type Comment

type Comment struct {
	// Position of starting #
	TokPos token.Pos
	// Comment text, including # and excluding trailing newline.
	Text string
}

A Comment node represents a comment.

func (*Comment) End

func (c *Comment) End() token.Pos

func (*Comment) Pos

func (c *Comment) Pos() token.Pos

type CommentGroup

type CommentGroup struct {
	// Must be non-empty
	List []*Comment
}

A CommentGroup represents consecutive comments.

func (*CommentGroup) End

func (c *CommentGroup) End() token.Pos

func (*CommentGroup) Pos

func (c *CommentGroup) Pos() token.Pos

type DeclareAccount

type DeclareAccount struct {
	TokPos   token.Pos
	Account  *BasicValue // ACCTNAME
	Metadata []LineNode  // MetadataLine, BadLine
	EndTok   *End
}

A DeclareAccount node represents a declare account entry node.

func (*DeclareAccount) End

func (c *DeclareAccount) End() token.Pos

func (*DeclareAccount) Pos

func (c *DeclareAccount) Pos() token.Pos

type DisableAccount

type DisableAccount struct {
	TokPos  token.Pos
	Date    *BasicValue // DATE
	Account *BasicValue // ACCTNAME
}

A DisableAccount node represents a disable account entry node.

func (*DisableAccount) End

func (c *DisableAccount) End() token.Pos

func (*DisableAccount) Pos

func (c *DisableAccount) Pos() token.Pos

type End

type End struct {
	TokPos token.Pos
}

An End node represents an end keyword ending a multiple line entry.

func (*End) End

func (d *End) End() token.Pos

func (*End) Pos

func (d *End) Pos() token.Pos

type Entry

type Entry interface {
	Node
	// contains filtered or unexported methods
}

All entry nodes implement Entry.

type File

type File struct {
	Entries  []Entry
	Comments []*CommentGroup
}

A File represents a source file.

type LineNode

type LineNode interface {
	Node
	// contains filtered or unexported methods
}

All line nodes implement LineNode.

type MetadataLine

type MetadataLine struct {
	TokPos token.Pos
	Key    *BasicValue // STRING
	Val    *BasicValue // STRING
}

A MetadataLine node represents a metadata line.

func (*MetadataLine) End

func (v *MetadataLine) End() token.Pos

func (*MetadataLine) Pos

func (v *MetadataLine) Pos() token.Pos

type MultiBalance

type MultiBalance struct {
	BalanceHeader
	Amounts []LineNode // AmountLine, BadLine
	EndTok  *End
}

A MultiBalance node represents a balance entry node spanning multiple lines.

func (*MultiBalance) End

func (b *MultiBalance) End() token.Pos

type Node

type Node interface {
	Pos() token.Pos // position of first character belonging to the node
	End() token.Pos // position of first character immediately after the node
}

All node types implement the Node interface.

type SingleBalance

type SingleBalance struct {
	BalanceHeader
	Amount *Amount
}

A SingleBalance node represents a balance entry node on a single line.

func (*SingleBalance) End

func (b *SingleBalance) End() token.Pos

type SplitLine

type SplitLine struct {
	Account *BasicValue // STRING
	Amount  *Amount
}

A SplitLine node represents a split line node in a transaction.

func (*SplitLine) End

func (s *SplitLine) End() token.Pos

func (*SplitLine) Pos

func (s *SplitLine) Pos() token.Pos

type Transaction

type Transaction struct {
	TokPos      token.Pos
	Date        *BasicValue // DATE
	Description *BasicValue // STRING
	Splits      []LineNode  // SplitLine, BadLine
	EndTok      *End
}

A Transaction node represents a transaction entry node.

func (*Transaction) End

func (t *Transaction) End() token.Pos

func (*Transaction) Pos

func (t *Transaction) Pos() token.Pos

type UnitDecl

type UnitDecl struct {
	TokPos token.Pos
	Unit   *BasicValue // USYMBOL
	Scale  *BasicValue // DECIMAL
}

A UnitDecl node represents a unit declaration entry node.

func (*UnitDecl) End

func (u *UnitDecl) End() token.Pos

func (*UnitDecl) Pos

func (u *UnitDecl) Pos() token.Pos