reference

Documentation

Index

• Variables
• func IsReference(str string) bool
• type Reference
  • func NewFileCtx(file string) Reference
  • func NewScoreColCtx(file, table, col string) Reference
  • func NewScoreCtx(file, table string) Reference
  • func NewShortCutCtx(file, table string) Reference
  • func Parse(ref string) (r *Reference, err error)
  • func ParseContext(ctx string) (r *Reference, err error)
  • func (r Reference) Cols() []string
  • func (r *Reference) Complete(ctx Reference) error
  • func (r Reference) Dup() Reference
  • func (r Reference) IsComplete() bool
  • func (r Reference) String() string
  • func (r Reference) Valid() bool
• type Type
  • func (t Type) String() string

Variables

var ErrInvalidRefString = fmt.Errorf("invalid refence string")

Functions

func IsReference

func IsReference(str string) bool

Types

type Reference

type Reference struct {
	Type
	File  string
	Table string
	Row   string // empty for score tables
	Col   string
	Part  string // empty for shortcut tables
}

func NewFileCtx

func NewFileCtx(file string) Reference

func NewScoreColCtx

func NewScoreColCtx(file, table, col string) Reference

func NewScoreCtx

func NewScoreCtx(file, table string) Reference

func NewShortCutCtx

func NewShortCutCtx(file, table string) Reference

func Parse

func Parse(ref string) (r *Reference, err error)

func ParseContext

func ParseContext(ctx string) (r *Reference, err error)

ParseContext tries to guess the context from the given string. Returns an error, if the context is not complete.

func (Reference) Cols

func (r Reference) Cols() []string

Cols returns the columns

func (*Reference) Complete

func (r *Reference) Complete(ctx Reference) error

Complete tries to complete the reference via the given context reference

func (Reference) Dup

func (r Reference) Dup() Reference

func (Reference) IsComplete

func (r Reference) IsComplete() bool

IsComplete checks, if the reference is complete

func (Reference) String

func (r Reference) String() string

'piano=SCORE.timbre[CHORUS] 'piano=SCORE.timbre 'piano=SCORE 'piano =SCORE.timbre[CHORUS] =SCORE.timbre =SCORE =.timbre[CHORUS] =.timbre 'piano=.timbre[CHORUS] 'piano=.timbre 'piano=SCORE[CHORUS]

oder

'UVI.ks.tremolo.cello 'UVI.ks.tremolo .ks.tremolo.cello .ks.tremolo

func (Reference) Valid

func (r Reference) Valid() bool

Valid checks, if the reference is valid

type Type

type Type int

const (
	Unknown Type = iota
	File
	Score
	ShortCut
	ShortCutCell
	ScoreCol
	ScorePart
	ScoreColPart
	FileCtx
	ScoreCtx
	ScoreColCtx
	ShortCutCtx
)

func (Type) String

func (t Type) String() string