translate

Documentation

Overview

Package translate converts charachorder.File's from one keyboard layout to another.

Index

• func AddTranslation(t Translation)
• func AddTranslationFromFile(filename string)
• func Names() []string
• type TranslateKey
• type Translation
  • func GetTranslation(name string) (Translation, bool)
  • func NewTranslationFromYaml(value []byte) Translation
  • func (t *Translation) Translate(chord charachorder.Chord, reverse bool) charachorder.Chord
  • func (t *Translation) TranslateFile(f *charachorder.File, reverse bool) charachorder.File

Functions

func AddTranslation

func AddTranslation(t Translation)

AddTranslation adds a translation to the known list.

func AddTranslationFromFile

func AddTranslationFromFile(filename string)

AddTranslationFromFile reads a YAML file and adds it to then known list of translations.

func Names

func Names() []string

Names returns all known translation names.

Types

type TranslateKey

type TranslateKey struct {
	Qwerty string
	To     string
}

type Translation

type Translation struct {
	Name         string
	Translations map[string]string
}

Translation represents a translation to or from Qwerty into `Name`.

func GetTranslation

func GetTranslation(name string) (Translation, bool)

GetTranslation will find a known location or return false if unknown.

func NewTranslationFromYaml

func NewTranslationFromYaml(value []byte) Translation

NewTranslationFromYaml parses YAML content into a `Translation`.

func (*Translation) Translate

func (t *Translation) Translate(chord charachorder.Chord, reverse bool) charachorder.Chord

Translate converts a single `chord` to the layout from Qwerty.

func (*Translation) TranslateFile

func (t *Translation) TranslateFile(f *charachorder.File, reverse bool) charachorder.File

TranslateFile converts an entire file to the layout from Qwerty.