lang.go

/*
 * This file is a part of hypera.dev/axolotl-lang/v2, licensed under the MIT License.
 *
 * Copyright (c) 2024 Joshua Sing <joshua@joshuasing.dev>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

// Package lang provides the locale files used by Hypera Development's Axolotl
// Discord bot.
//
// Note: This module is not designed for use in other software, and use outside
// of Axolotl is not supported.
package lang // import "hypera.dev/axolotl-lang/v2"

import (
	"embed"
	"fmt"

	"github.com/BurntSushi/toml"
	"github.com/bwmarrin/discordgo"
	"github.com/nicksnyder/go-i18n/v2/i18n"
	"golang.org/x/text/language"
)

//go:embed locales/*.toml
var localeFS embed.FS

type Data map[string]any

var (
	supportedLocales = []discordgo.Locale{
		discordgo.EnglishGB,
		discordgo.EnglishUS,
		discordgo.Japanese,
	}

	bundle  *i18n.Bundle
	locales = make(map[discordgo.Locale]*Localizer)
)

func LoadLocales() error {
	bundle = i18n.NewBundle(language.MustParse(string(supportedLocales[0])))
	bundle.RegisterUnmarshalFunc("toml", toml.Unmarshal)

	for _, locale := range supportedLocales {
		_, err := bundle.LoadMessageFileFS(localeFS, fmt.Sprintf("locales/%s.toml", string(locale)))
		if err != nil {
			return fmt.Errorf("load locale file for %q: %w", locale, err)
		}
		locales[locale] = newLocalizer(locale)
	}

	return nil
}

func SupportedLocales() []discordgo.Locale {
	return supportedLocales
}

func Bundle() *i18n.Bundle {
	return bundle
}

func GetLocalizer(locale discordgo.Locale) *Localizer {
	if l, ok := locales[locale]; ok {
		return l
	}

	// Use default locale.
	return locales[supportedLocales[0]]
}

func Localize(locale discordgo.Locale, id string) string {
	return GetLocalizer(locale).Localize(id)
}

func LocalizeWithData(locale discordgo.Locale, id string, data Data) string {
	return GetLocalizer(locale).LocalizeWithData(id, data)
}

func LocalizePlural(locale discordgo.Locale, id string, count any) string {
	return GetLocalizer(locale).LocalizePlural(id, count)
}

func LocalizePluralWithData(locale discordgo.Locale, id string, count any, data Data) string {
	return GetLocalizer(locale).LocalizePluralWithData(id, count, data)
}

type Localizer struct {
	*i18n.Localizer
	prefix string
}

func newLocalizer(locale discordgo.Locale) *Localizer {
	return &Localizer{Localizer: i18n.NewLocalizer(bundle, string(locale))}
}

func (l *Localizer) Section(name string) *Localizer {
	return &Localizer{Localizer: l.Localizer, prefix: name + "."}
}

func (l *Localizer) Localize(id string) string {
	s, err := l.Localizer.Localize(&i18n.LocalizeConfig{
		MessageID: l.prefix + id,
	})
	if s == "" && err != nil {
		return id
	}
	return s
}

func (l *Localizer) LocalizeWithData(id string, data Data) string {
	s, err := l.Localizer.Localize(&i18n.LocalizeConfig{
		MessageID:    l.prefix + id,
		TemplateData: data,
	})
	if s == "" && err != nil {
		return id
	}
	return s
}

func (l *Localizer) LocalizePlural(id string, count any) string {
	s, err := l.Localizer.Localize(&i18n.LocalizeConfig{
		MessageID:   l.prefix + id,
		PluralCount: count,
	})
	if s == "" && err != nil {
		return id
	}
	return s
}

func (l *Localizer) LocalizePluralWithData(id string, count any, data Data) string {
	s, err := l.Localizer.Localize(&i18n.LocalizeConfig{
		MessageID:    l.prefix + id,
		TemplateData: data,
		PluralCount:  count,
	})
	if s == "" && err != nil {
		return id
	}
	return s
}