Line data Source code
1 : package i18n
2 :
3 : import (
4 : "embed"
5 : "fmt"
6 : "slices"
7 :
8 : "github.com/leonelquinteros/gotext"
9 : )
10 :
11 : //go:embed locale/*.po
12 : var localeFS embed.FS
13 :
14 : // defaultLang は源泉言語。原文が英語なので en にする。未知の言語はここへフォールバックする。
15 : const defaultLang = "en"
16 :
17 : // Msgid は訳す前の英語の原文。query.T に通して現在の言語の訳を引く。
18 : // 訳した後の文字列は string のまま持つので、取り違えるとコンパイルで止まる
19 : type Msgid string
20 :
21 : // Lang は対応する言語1つのメタデータを表す。
22 : type Lang struct {
23 : Code string // 言語コード。"ja" / "en"
24 : Label Msgid // 表示名
25 : }
26 :
27 : // supportedLangs は対応する言語の一覧。表示順もこの並び。
28 : // 言語検証・UI の選択肢・翻訳カタログの全てがこの1箇所から導出される唯一の定義。
29 : // 言語を足すときはここへ1行足し、源泉言語 en 以外は locale/<code>.po を置く。
30 : var supportedLangs = []Lang{
31 : {Code: "ja", Label: "Japanese"},
32 : {Code: "en", Label: "English"},
33 : }
34 :
35 : // SupportedLangs は対応する言語の一覧を表示順で返す。呼び出し側の変更が定義へ波及しないよう複製を返す。
36 : func SupportedLangs() []Lang {
37 1 : return slices.Clone(supportedLangs)
38 1 : }
39 :
40 : // IsSupportedLang は code が対応する言語コードかを返す。設定値の検証に使う。
41 : func IsSupportedLang(code string) bool {
42 2 : return slices.ContainsFunc(supportedLangs, func(l Lang) bool { return l.Code == code })
43 : }
44 :
45 : // Catalog は全言語の翻訳を持つ不変マスタ。embed から構築し、以後変わらない。
46 : // Resources が値で保持し、query.T が現在言語とともに引く。RawMaster と同じ、起動時に構築する読み取り専用データ。
47 : // 内部は map なので値コピーしても実体を共有する。読み取り専用なので共有して問題ない。
48 : type Catalog struct {
49 : langs map[string]*gotext.Po
50 : }
51 :
52 : // NewCatalog は対応言語ごとに埋め込み PO を読んでカタログを構築する。言語集合は supportedLangs に従う。
53 : func NewCatalog() Catalog {
54 1 : langs := make(map[string]*gotext.Po, len(supportedLangs))
55 1 : for _, l := range supportedLangs {
56 1 : langs[l.Code] = loadPo(l.Code)
57 1 : }
58 1 : return Catalog{langs: langs}
59 : }
60 :
61 : // loadPo は言語コードの翻訳 PO を返す。源泉言語 en は原文そのものなので空 PO にし、未訳フォールバックで原文を返す。
62 : // それ以外は埋め込みの locale/<code>.po を解析する。
63 : func loadPo(code string) *gotext.Po {
64 1 : if code == defaultLang {
65 1 : return gotext.NewPo()
66 1 : }
67 1 : return mustParse("locale/" + code + ".po")
68 : }
69 :
70 : // mustParse は埋め込み PO を読んで解析する。埋め込みなので読み込み失敗はビルドの誤りとして panic する。
71 : // gotext の Parse はエラーを返さず内部で握り潰すので、解析失敗はここで検知できない。妥当性はテストで担保する。
72 : func mustParse(path string) *gotext.Po {
73 1 : data, err := localeFS.ReadFile(path)
74 1 : if err != nil {
75 0 : panic(fmt.Sprintf("i18n: failed to read embedded PO: %s: %v", path, err))
76 : }
77 1 : po := gotext.NewPo()
78 1 : po.Parse(data)
79 1 : return po
80 : }
81 :
82 : // Translate は lang における msgid の訳を返す。未知の言語や未訳は原文の英語へフォールバックする。
83 : // args を渡すと訳を書式として printf 整形する。args が無ければ整形せずそのまま返す。
84 : //
85 : // gotext の Get は書式引数で printf 整形するため、直接呼ぶと go vet が非定数の書式文字列と誤検知する。
86 : // メソッド値を介して呼び回避する。
87 : func (c Catalog) Translate(lang string, msgid Msgid, args ...any) string {
88 1 : if lang == PseudoLang {
89 1 : return pseudoTranslate(string(msgid), args...)
90 1 : }
91 1 : po, ok := c.langs[lang]
92 1 : if !ok {
93 1 : po = c.langs[defaultLang]
94 1 : }
95 1 : get := po.Get
96 1 : return get(string(msgid), args...)
97 : }
|