text

Documentation

Index

• func Blocked(input string) []string
• type Cache
  • func NewLineCache(cp Codepage, localizer resource.Localizer) *Cache
  • func NewPageCache(cp Codepage, localizer resource.Localizer) *Cache
  • func (cache *Cache) InvalidateResources(ids []resource.ID)
  • func (cache *Cache) Text(key resource.Key) (string, error)
• type Codepage
  • func DefaultCodepage() Codepage
• type ElectronicMessage
  • func DecodeElectronicMessage(cp Codepage, provider resource.BlockProvider) (message ElectronicMessage, err error)
  • func EmptyElectronicMessage() ElectronicMessage
  • func (message ElectronicMessage) Encode(cp Codepage) [][]byte
• type ElectronicMessageCache
  • func NewElectronicMessageCache(cp Codepage, localizer resource.Localizer) *ElectronicMessageCache
  • func (cache *ElectronicMessageCache) InvalidateResources(ids []resource.ID)
  • func (cache *ElectronicMessageCache) Message(key resource.Key) (ElectronicMessage, error)

Functions

func Blocked

func Blocked(input string) []string

Blocked splits the given input string into a series of lines, usable for blocked serialization. It returns an array of strings that each are below a maximum line length. The list is terminated with one empty line (necessary for compound strings).

Types

type Cache

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

Cache retrieves texts from a localizer and keeps them decoded until they are invalidated.

func NewLineCache

func NewLineCache(cp Codepage, localizer resource.Localizer) *Cache

NewLineCache returns a cache for single-block texts.

func NewPageCache

func NewPageCache(cp Codepage, localizer resource.Localizer) *Cache

NewPageCache returns a cache for resource-based texts.

func (*Cache) InvalidateResources

func (cache *Cache) InvalidateResources(ids []resource.ID)

InvalidateResources lets the cache remove any texts from resources that are specified in the given slice.

func (*Cache) Text

func (cache *Cache) Text(key resource.Key) (string, error)

Text retrieves and caches the text of given key.

type Codepage

type Codepage interface {
	// Encode converts the provided string to a byte array. It appends one 0x00 byte at the end.
	Encode(value string) []byte
	// Decode converts the provided byte slice to a string. It ignores trailing 0x00 bytes.
	Decode(data []byte) string
}

Codepage wraps the methods for serializing strings. The encoded byte array is expected to be terminated by one 0x00 byte.

func DefaultCodepage

func DefaultCodepage() Codepage

DefaultCodepage returns a Codepage instance that represents the one used for the resources. It is based on the Code Page 437 ( https://en.wikipedia.org/wiki/Code_page_437 ).

type ElectronicMessage

type ElectronicMessage struct {
	// NextMessage identifies the message that should follow this one. -1 for none.
	NextMessage int
	// IsInterrupt marks messages that are the ones following another.
	IsInterrupt bool
	// ColorIndex is into the palette for the sender text. -1 for default.
	ColorIndex int
	// LeftDisplay indicates the image to show in the left MFD. -1 for none.
	LeftDisplay int
	// RightDisplay indicates the image to show in the right MFD. -1 for none.
	RightDisplay int

	// Title of the message.
	Title string
	// Sender of the message.
	Sender string
	// Subject of the message.
	Subject string
	// VerboseText the long form.
	VerboseText string
	// TerseText the short form.
	TerseText string
}

ElectronicMessage describes one message.

func DecodeElectronicMessage

func DecodeElectronicMessage(cp Codepage, provider resource.BlockProvider) (message ElectronicMessage, err error)

DecodeElectronicMessage tries to decode a message from given block holder.

func EmptyElectronicMessage

func EmptyElectronicMessage() ElectronicMessage

EmptyElectronicMessage returns an instance of an empty electronic message.

func (ElectronicMessage) Encode

func (message ElectronicMessage) Encode(cp Codepage) [][]byte

Encode serializes the message into a block holder.

type ElectronicMessageCache

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

ElectronicMessageCache retrieves messages from a localizer and keeps them decoded until they are invalidated.

func NewElectronicMessageCache

func NewElectronicMessageCache(cp Codepage, localizer resource.Localizer) *ElectronicMessageCache

NewElectronicMessageCache returns a new instance.

func (*ElectronicMessageCache) InvalidateResources

func (cache *ElectronicMessageCache) InvalidateResources(ids []resource.ID)

InvalidateResources lets the cache remove any texts from resources that are specified in the given slice.

func (*ElectronicMessageCache) Message

func (cache *ElectronicMessageCache) Message(key resource.Key) (ElectronicMessage, error)

Message retrieves and caches the message of given key.