parse

Documentation

Index

• Constants
• Variables
• type ActionNode
• type ActorNode
  • func (an *ActorNode) ActorName() string
• type ActorRef
• type ArrowHeadType
• type ArrowStemType
• type ArrowType
• type Attribute
• type AttributeList
• type BlockNode
• type BlockSegment
• type BlockSegmentList
• type GapNode
• type GapType
• type Node
• type NodeList
  • func Parse(reader io.Reader, filename string) (*NodeList, error)
• type NormalActorRef
• type NoteAlignment
• type NoteNode
• type ProcessInstructionNode
• type PseudoActorRef
• type SegmentType
• type StyleNode
• type TitleNode

Constants

const (
	SOLID_ARROW_STEM  ArrowStemType = iota
	DASHED_ARROW_STEM               = iota
	THICK_ARROW_STEM                = iota
)

const (
	SOLID_ARROW_HEAD        ArrowHeadType = iota
	OPEN_ARROW_HEAD                       = iota
	BARBED_ARROW_HEAD                     = iota
	LOWER_BARBED_ARROW_HEAD               = iota
)

const (
	ALT_SEGMENT               SegmentType = iota
	ALT_ELSE_SEGMENT                      = iota
	PAR_SEGMENT                           = iota
	PAR_ELSE_SEGMENT                      = iota
	OPT_SEGMENT                           = iota
	LOOP_SEGMENT                          = iota
	CONCURRENT_SEGMENT                    = iota
	CONCURRENT_WHILST_SEGMENT             = iota
	NONE_SEGMENT
)

const (
	LEFT_NOTE_ALIGNMENT  NoteAlignment = iota
	RIGHT_NOTE_ALIGNMENT               = iota
	OVER_NOTE_ALIGNMENT                = iota
)

const (
	SPACER_GAP GapType = iota
	EMPTY_GAP          = iota
	LINE_GAP           = iota
	FRAME_GAP          = iota
)

const ANGR = 57375

const BACKSLASHANGR = 57377

const COMMA = 57374

const DASH = 57370

const DOT = 57372

const DOUBLEANGR = 57376

const DOUBLEDASH = 57371

const EQUAL = 57373

const IDENT = 57383

const K_ALT = 57360

const K_BLOCK = 57359

const K_CONCURRENT = 57368

const K_ELSE = 57362

const K_ELSEALT = 57361

const K_ELSEPAR = 57367

const K_END = 57363

const K_FRAME = 57358

const K_GAP = 57356

const K_HORIZONTAL = 57354

const K_LEFT = 57350

const K_LINE = 57357

const K_LOOP = 57364

const K_NOTE = 57348

const K_OF = 57353

const K_OPT = 57365

const K_OVER = 57352

const K_PAR = 57366

const K_PARTICIPANT = 57347

const K_RIGHT = 57351

const K_SPACER = 57355

const K_STYLE = 57349

const K_TITLE = 57346

const K_WHILST = 57369

const MESSAGE = 57382

const PARL = 57379

const PARR = 57380

const SLASHANGR = 57378

const STRING = 57381

Variables

var DualRunes = map[string]int{
	".": DOT,
	",": COMMA,

	"--": DOUBLEDASH,
	"-":  DASH,
	"=":  EQUAL,

	">>":  DOUBLEANGR,
	">":   ANGR,
	"/>":  SLASHANGR,
	"\\>": BACKSLASHANGR,
}

Types

type ActionNode

type ActionNode struct {
	From  ActorRef
	To    ActorRef
	Arrow ArrowType
	Descr string
}

An action node

type ActorNode

type ActorNode struct {
	// Identifier
	Ident string

	// Returns true if the actor has a separate description
	HasDescr bool

	// Description
	Descr string

	// Attributes
	Attributes *AttributeList
}

An actor declaration node

func (*ActorNode) ActorName

func (an *ActorNode) ActorName() string

Returns a suitable actor name. This can either be the description if HasDescr is true or the ident value if HasDescr is false.

type ActorRef

type ActorRef interface {
}

A reference to an actor

type ArrowHeadType

type ArrowHeadType int

type ArrowStemType

type ArrowStemType int

type ArrowType

type ArrowType struct {
	Stem ArrowStemType
	Head ArrowHeadType
}

type Attribute

type Attribute struct {
	Name  string
	Value string
}

Attributes

type AttributeList

type AttributeList struct {
	Head *Attribute
	Tail *AttributeList
}

type BlockNode

type BlockNode struct {
	Segments *BlockSegmentList
}

A block node. Each block can have one or more segments

type BlockSegment

type BlockSegment struct {
	Type          SegmentType
	Prefix        string
	Message       string
	AttributeList *AttributeList
	SubNodes      *NodeList
}

type BlockSegmentList

type BlockSegmentList struct {
	Head *BlockSegment
	Tail *BlockSegmentList
}

type GapNode

type GapNode struct {
	Type  GapType
	Descr string
}

type GapType

type GapType int

Gap node

type Node

type Node interface {
}

A type of declaration node

type NodeList

type NodeList struct {
	Head Node
	Tail *NodeList
}

A list of declaration node

func Parse

func Parse(reader io.Reader, filename string) (*NodeList, error)

type NormalActorRef

type NormalActorRef string

A reference to a normal actor

type NoteAlignment

type NoteAlignment int

Note node

type NoteNode

type NoteNode struct {
	Actor1 ActorRef
	Actor2 ActorRef // Can be nil

	Position NoteAlignment
	Descr    string
}

type ProcessInstructionNode

type ProcessInstructionNode struct {
	Prefix string
	Value  string
}

A processing instruction node

type PseudoActorRef

type PseudoActorRef string

A reference to a pseudo actor

type SegmentType

type SegmentType int

type StyleNode

type StyleNode struct {
	Name       string
	Attributes *AttributeList
}

A style declaration node

type TitleNode

type TitleNode struct {
	Title string
}

A title declaration node