translit.go

// Package translit provides transliteration transformer.
// See subpackages for language-specific transformers.
package translit

import (
	"golang.org/x/text/transform"

	"github.com/mxmCherry/translit/internal/transformer"
	"github.com/mxmCherry/translit/internal/tree"
	"github.com/mxmCherry/translit/internal/tree/maptree"
)

// Factory represents pre-compiled tree builder/factory.
type Factory interface {
	// Transformer returns/builds a "fresh" transliteration transformer.
	Transformer() transform.Transformer
}

type factory struct {
	rules tree.Node
}

// Map pre-compiles string-to-string transliteration rule map into transformer factory.
func Map(rules map[string]string) Factory {
	r := new(maptree.Node)
	tree.Populate(r, rules)
	return &factory{
		rules: r,
	}
}

func (f *factory) Transformer() transform.Transformer {
	return transformer.New(f.rules)
}