acrophonetic

README

Acrophonetic

Acrophonetic is a library (and command line program) that transribes characters in a string to a spelling representation.

It currently spells:

• NATO alphabet.
• USMC variant of the NATO alphabet. (9 is "Niner")
• Morse code.

Status

This library is currently unstable and the API may change.

License

Licensed under the terms of the BSD license. See LICENSE file for more infomation.

Documentation

Index

• func Register(t Transcriber)
• func RegisterFunc(f func(r rune) string)
• func Spell(s string) []string
• func SpellSlice(r []rune) []string
• func TransRune(c rune) string
• type Transcriber
  • func TransFunc(f func(r rune) string) Transcriber

Functions

func Register

func Register(t Transcriber)

Register instructes TransRune to use the provided Transcriber.

func RegisterFunc

func RegisterFunc(f func(r rune) string)

RegisterFunc instructs TransRune to use the provided function.

func Spell

func Spell(s string) []string

Spell is a convience method. It converts the provided string to a slice of runes and calls SpellSlice on them.

func SpellSlice

func SpellSlice(r []rune) []string

SpellSlice will return the phonetic representation (if any) for all the provided runes.

func TransRune

func TransRune(c rune) string

TransRune returns acrophonetic representation for the provided rune. It uses the provided Transcriber or the default NATO transcriber. If no representation exists it an empty string will be returned.

Types

type Transcriber

type Transcriber interface {
	TransRune(r rune) string

} //interface

Transcriber translates a rune to a a representation.

func TransFunc

func TransFunc(f func(r rune) string) Transcriber