symbols

Documentation

Index

• type Class
  • func (f *Class) HasColors() bool
  • func (f *Class) HumanReadableName() string
  • func (f *Class) String() string
• type ClassType
• type Classes
  • func NewClasses() *Classes
  • func (f *Classes) Add(class *Class)
  • func (f *Classes) Get(name string) (*Class, bool)
  • func (f *Classes) Len() int
  • func (f *Classes) Raw() map[string]*Class
• type Function
  • func (f *Function) HasColors() bool
  • func (f *Function) HumanReadableName() string
  • func (f *Function) String() string
• type FunctionType
• type Functions
  • func NewFunctions() *Functions
  • func (f *Functions) Add(fun *Function)
  • func (f *Functions) Get(name string) (*Function, bool)
  • func (f *Functions) Len() int
  • func (f *Functions) Raw() map[string]*Function

Types

type Class

type Class struct {
	Name   string
	Type   ClassType
	Pos    meta.ElementPosition
	Colors *palette.ColorContainer

	WithExplicitConstructor bool
}

Class is a structure for storing information about a class.

func (*Class) HasColors

func (f *Class) HasColors() bool

func (*Class) HumanReadableName

func (f *Class) HumanReadableName() string

HumanReadableName returns a string with a name that is understandable.

func (*Class) String

func (f *Class) String() string

type ClassType

type ClassType uint8

const (
	PlainClass ClassType = iota
	Interface
	Trait
)

type Classes

type Classes struct {
	Classes map[string]*Class
	// contains filtered or unexported fields
}

func NewClasses

func NewClasses() *Classes

func (*Classes) Add

func (f *Classes) Add(class *Class)

func (*Classes) Get

func (f *Classes) Get(name string) (*Class, bool)

func (*Classes) Len

func (f *Classes) Len() int

func (*Classes) Raw

func (f *Classes) Raw() map[string]*Class

type Function

type Function struct {
	Name   string
	Type   FunctionType
	Pos    meta.ElementPosition
	Colors *palette.ColorContainer

	Called   *Functions
	CalledBy *Functions
}

Function is a structure for storing information about a function.

func (*Function) HasColors

func (f *Function) HasColors() bool

func (*Function) HumanReadableName

func (f *Function) HumanReadableName() string

HumanReadableName returns a string with a name that is understandable.

func (*Function) String

func (f *Function) String() string

type FunctionType

type FunctionType int64

const (
	MainFunc FunctionType = iota
	LocalFunc
	ExternFunc
)

type Functions

type Functions struct {
	Functions map[string]*Function
	// contains filtered or unexported fields
}

func NewFunctions

func NewFunctions() *Functions

func (*Functions) Add

func (f *Functions) Add(fun *Function)

func (*Functions) Get

func (f *Functions) Get(name string) (*Function, bool)

func (*Functions) Len

func (f *Functions) Len() int

func (*Functions) Raw

func (f *Functions) Raw() map[string]*Function