Setup i18n with gotext(0)

21 files changed, 363 insertions, 38 deletions

diff --git a/.gitignore b/.gitignore
index 094db69..d3c2f8f 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,4 +1,7 @@
-/src/version.go
+/doc/*
+!/doc/*.en.*.adoc
+/po/*/*.mo
+/src/meta.go
 /*.bin
 /src/*.a
 /src/*.bin
diff --git a/Makefile b/Makefile
index dff1f13..ca2fa31 100644
--- a/Makefile
+++ b/Makefile
@@ -3,7 +3,6 @@ DATE         = 1970-01-01
 VERSION      = 0.1.0
 NAME         = scrypt
 NAME_UC      = $(NAME)
-LANGUAGES    = en
 ## Installation prefix.  Defaults to "/usr".
 PREFIX       = /usr
 BINDIR       = $(PREFIX)/bin
@@ -24,7 +23,7 @@ GOLDFLAGS    = -L $(GOLIBDIR)
 
 
 .SUFFIXES:
-.SUFFIXES: .go .a .c .o .bin .bin-check
+.SUFFIXES: .go .a .c .o .bin .bin-check .adoc .po .mo
 
 .c.o:
 	$(CC) $(CFLAGS) -o $@ -c $<
@@ -32,23 +31,32 @@ GOLDFLAGS    = -L $(GOLIBDIR)
 .go.a:
 	go tool compile -I $(@D) $(GOCFLAGS)  -o $@ -p $(*F) \
 		`find $< $$(if [ $(*F) != main ]; then \
-			echo src/$(NAME).go src/version.go; fi) | uniq`
+			echo src/$(NAME).go src/meta.go; fi) | uniq`
 
 .a.bin:
 	go tool link    -L $(@D) $(GOLDFLAGS) -o $@ --extldflags '$(LDLIBS)' $<
 
+.adoc:
+	asciidoctor -b manpage -o $@ $<
+
+.po.mo:
+	msgfmt -cfv -o $@ $<
+
 
 
 all:
 include deps.mk
 
 
-libs.a                 = $(libs.go:.go=.a)
-mains.a                = $(mains.go:.go=.a)
-mains.bin              = $(mains.go:.go=.bin)
-functional-tests/lib.a = $(functional-tests/lib.go:.go=.a)
-fuzz-targets/lib.a     = $(fuzz-targets/lib.go:.go=.a)
-benchmarks/lib.a       = $(benchmarks/lib.go:.go=.a)
+libs.a           = $(libs.go:.go=.a)
+mains.a          = $(mains.go:.go=.a)
+mains.bin        = $(mains.go:.go=.bin)
+functional/lib.a = $(functional/lib.go:.go=.a)
+fuzz/lib.a       = $(fuzz/lib.go:.go=.a)
+benchmarks/lib.a = $(benchmarks/lib.go:.go=.a)
+manpages.N.adoc  = $(manpages.en.N.adoc) $(manpages.XX.N.adoc)
+manpages.N       = $(manpages.N.adoc:.adoc=)
+sources.mo       = $(sources.po:.po=.mo)
 
 cgo.go = \
 	src/_cgo_import.go             \
@@ -69,17 +77,20 @@ objects = \
 
 sources = \
 	src/$(NAME).go                 \
-	src/version.go                 \
+	src/meta.go                    \
 	src/main.go                    \
 
 
 derived-assets = \
-	src/version.go                 \
+	src/meta.go                    \
 	$(objects)                     \
 	$(libs.a)                      \
 	$(mains.a)                     \
 	$(mains.bin)                   \
 	$(NAME).bin                    \
+	$(manpages.XX.N.adoc)          \
+	$(manpages.N)                  \
+	$(sources.mo)                  \
 
 side-assets = \
 	src/_cgo_export.h              \
@@ -96,7 +107,7 @@ all: $(derived-assets)
 
 $(objects): Makefile deps.mk
 $(libs.a): Makefile deps.mk
-$(libs.a): src/$(NAME).go src/version.go
+$(libs.a): src/$(NAME).go src/meta.go
 $(libs.a): $(cgo.go) $(cgo.o)
 
 $(cgo.go) $(cgo.c) $(cgo.o): src/_cgo_.o
@@ -108,27 +119,33 @@ src/_cgo_.o: src/$(NAME).go
 src/_cgo_import.go: src/_cgo_.o
 	go tool cgo --dynpackage $(NAME) --dynimport src/_cgo_.o --dynout $@
 
-src/$(NAME).a tests/$(NAME).a $(functional-tests/lib.a) $(benchmarks/lib.a):
-	go tool compile $(GOCFLAGS) -o $@ -p $(*F) $(cgo.go) src/version.go \
+src/$(NAME).a tests/$(NAME).a $(functional/lib.a) $(benchmarks/lib.a):
+	go tool compile $(GOCFLAGS) -o $@ -p $(*F) $(cgo.go) src/meta.go \
 		`find $*.go | grep -Ev '^src/$(NAME)\.go$$'`
 	go tool pack r $@ $(cgo.o)
 
-$(fuzz-targets/lib.a):
+$(fuzz/lib.a):
 	go tool compile $(GOCFLAGS) -o $@ -p $(NAME) -d=libfuzzer \
-		$*.go $(cgo.go) src/version.go
+		$*.go $(cgo.go) src/meta.go
 	go tool pack r $@ $(cgo.o)
 
-src/version.go: Makefile
-	echo 'package $(NAME); const Version = "$(VERSION)"' > $@
+src/meta.go: Makefile
+	echo 'package $(NAME)'                   > $@
+	echo 'const Version   = "$(VERSION)"'   >> $@
+	echo 'const Name      = "$(NAME)"'      >> $@
+	echo 'const LOCALEDIR = "$(LOCALEDIR)"' >> $@
 
 $(NAME).bin: src/main.bin
 	ln -fs src/main.bin $@
 
+$(manpages.XX.N.adoc): po/doc/po4a.cfg
+	po4a --no-update --translate-only $@ po/doc/po4a.cfg
+
 
 
 tests.bin-check = \
 	tests/main.bin-check \
-	$(functional-tests/main.go:.go=.bin-check) \
+	$(functional/main.go:.go=.bin-check) \
 
 $(tests.bin-check):
 	$(EXEC)$*.bin
@@ -157,12 +174,12 @@ check: check-unit check-integration
 
 
 FUZZSEC=1
-fuzz-targets/main.bin-check = $(fuzz-targets/main.go:.go=.bin-check)
-$(fuzz-targets/main.bin-check):
+fuzz/main.bin-check = $(fuzz/main.go:.go=.bin-check)
+$(fuzz/main.bin-check):
 	$(EXEC)$*.bin --test.fuzztime=$(FUZZSEC)s \
 		--test.fuzz='.*' --test.fuzzcachedir=tests/fuzz/corpus
 
-fuzz: $(fuzz-targets/main.bin-check)
+fuzz: $(fuzz/main.bin-check)
 
 
 
@@ -176,6 +193,17 @@ bench: $(benchmarks/main.bin-check)
 
 
 
+i18n-doc:
+	po4a po/doc/po4a.cfg
+
+i18n-code:
+	gotext src/$(NAME).go > po/$(NAME)/$(NAME).pot
+	po4a po/$(NAME)/po4a.cfg
+
+i18n: i18n-doc i18n-code
+
+
+
 ## Remove *all* derived artifacts produced during the build.
 ## A dedicated test asserts that this is always true.
 clean:
@@ -192,7 +220,9 @@ install: all
 
 	cp $(NAME).bin       '$(DESTDIR)$(BINDIR)'/$(NAME)
 	cp src/$(NAME).a     '$(DESTDIR)$(GOLIBDIR)'
-	cp -P $(sources)     '$(DESTDIR)$(SRCDIR)'
+	cp $(sources)        '$(DESTDIR)$(SRCDIR)'
+	instool              '$(DESTDIR)$(MANDIR)'    install man $(manpages.N)
+	instool              '$(DESTDIR)$(LOCALEDIR)' install mo  $(sources.mo)
 
 ## Uninstalls from $(DESTDIR)$(PREFIX).  This is a perfect mirror
 ## of the "install" target, and removes *all* that was installed.
@@ -203,6 +233,9 @@ uninstall:
 		'$(DESTDIR)$(GOLIBDIR)'/$(NAME).a     \
 		'$(DESTDIR)$(SRCDIR)'                 \
 
+	instool '$(DESTDIR)$(MANDIR)'    uninstall man $(manpages.N)
+	instool '$(DESTDIR)$(LOCALEDIR)' uninstall mo  $(sources.mo)
+
 
 
 ALWAYS:
diff --git a/deps.mk b/deps.mk
index 783970b..2d1e467 100644
--- a/deps.mk
+++ b/deps.mk
@@ -14,18 +14,35 @@ mains.go = \
 	tests/fuzz/api/main.go \
 	tests/main.go \
 
-functional-tests/lib.go = \
+manpages.en.N.adoc = \
+	doc/scrypt.en.0.adoc \
+
+manpages.XX.N.adoc = \
+	doc/scrypt.de.0.adoc \
+	doc/scrypt.eo.0.adoc \
+	doc/scrypt.es.0.adoc \
+	doc/scrypt.fr.0.adoc \
+	doc/scrypt.pt.0.adoc \
+
+sources.po = \
+	po/scrypt/de.po \
+	po/scrypt/eo.po \
+	po/scrypt/es.po \
+	po/scrypt/fr.po \
+	po/scrypt/pt.po \
+
+functional/lib.go = \
 	tests/functional/hash-and-check/scrypt.go \
 	tests/functional/version/scrypt.go \
 
-functional-tests/main.go = \
+functional/main.go = \
 	tests/functional/hash-and-check/main.go \
 	tests/functional/version/main.go \
 
-fuzz-targets/lib.go = \
+fuzz/lib.go = \
 	tests/fuzz/api/scrypt.go \
 
-fuzz-targets/main.go = \
+fuzz/main.go = \
 	tests/fuzz/api/main.go \
 
 benchmarks/lib.go = \
diff --git a/doc/scrypt.en.0.adoc b/doc/scrypt.en.0.adoc
new file mode 100644
index 0000000..96933b6
--- /dev/null
+++ b/doc/scrypt.en.0.adoc
@@ -0,0 +1,5 @@
+= scrypt(0)
+
+== NAME
+
+scrypt - .
diff --git a/mkdeps.sh b/mkdeps.sh
index e8da8a4..ae6fffc 100755
--- a/mkdeps.sh
+++ b/mkdeps.sh
@@ -5,21 +5,41 @@ export LANG=POSIX.UTF-8
 
 
 libs() {
-	find src tests -name '*.go' | grep -v '/main\.go$' |
-		grep -v '/version\.go$'
+	find src tests -name '*.go' |
+		grep -Ev '/(main|meta)\.go$' |
+		grep -Ev '/_cgo_(import|gotypes)\.go$' |
+		grep -Ev '\.cgo1\.go$'
 }
 
 mains() {
 	find src tests -name '*.go' | grep    '/main\.go$'
 }
 
+docs() {
+	find doc/*.en.*.adoc
+}
+
+xdocs() {
+	for l in `find po/doc/*.po | xargs -I% basename % .po`; do
+		docs | sed 's|/\(.*\)\.en\.\(.*\)$|/\1.'"$l"'.\2|'
+	done
+}
+
+pos() {
+	find po/ -name '*.po' | grep -Ev '^po/(doc|tests)/'
+}
+
+
 libs  | varlist 'libs.go'
 mains | varlist 'mains.go'
+docs  | varlist 'manpages.en.N.adoc'
+xdocs | varlist 'manpages.XX.N.adoc'
+pos   | varlist 'sources.po'
 
-find tests/functional/*/*.go -not -name main.go | varlist 'functional-tests/lib.go'
-find tests/functional/*/main.go                 | varlist 'functional-tests/main.go'
-find tests/fuzz/*/*.go       -not -name main.go | varlist 'fuzz-targets/lib.go'
-find tests/fuzz/*/main.go                       | varlist 'fuzz-targets/main.go'
+find tests/functional/*/*.go -not -name main.go | varlist 'functional/lib.go'
+find tests/functional/*/main.go                 | varlist 'functional/main.go'
+find tests/fuzz/*/*.go       -not -name main.go | varlist 'fuzz/lib.go'
+find tests/fuzz/*/main.go                       | varlist 'fuzz/main.go'
 find tests/benchmarks/*/*.go -not -name main.go | varlist 'benchmarks/lib.go'
 find tests/benchmarks/*/main.go                 | varlist 'benchmarks/main.go'
 
diff --git a/po/doc/de.po b/po/doc/de.po
new file mode 100644
index 0000000..b9bd59d
--- /dev/null
+++ b/po/doc/de.po
@@ -0,0 +1,22 @@
+msgid ""
+msgstr ""
+"Language: de\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+#. type: Title =
+#: doc/scrypt.en.0.adoc:1
+#, no-wrap
+msgid "scrypt(0)"
+msgstr ""
+
+#. type: Title ==
+#: doc/scrypt.en.0.adoc:3
+#, no-wrap
+msgid "NAME"
+msgstr ""
+
+#. type: Plain text
+#: doc/scrypt.en.0.adoc:5
+msgid "scrypt - ."
+msgstr ""
diff --git a/po/doc/doc.pot b/po/doc/doc.pot
new file mode 100644
index 0000000..ef2b751
--- /dev/null
+++ b/po/doc/doc.pot
@@ -0,0 +1,21 @@
+msgid ""
+msgstr ""
+"Language: \n"
+"Content-Type: text/plain; charset=UTF-8\n"
+
+#. type: Title =
+#: doc/scrypt.en.0.adoc:1
+#, no-wrap
+msgid "scrypt(0)"
+msgstr ""
+
+#. type: Title ==
+#: doc/scrypt.en.0.adoc:3
+#, no-wrap
+msgid "NAME"
+msgstr ""
+
+#. type: Plain text
+#: doc/scrypt.en.0.adoc:5
+msgid "scrypt - ."
+msgstr ""
diff --git a/po/doc/eo.po b/po/doc/eo.po
new file mode 100644
index 0000000..7066b85
--- /dev/null
+++ b/po/doc/eo.po
@@ -0,0 +1,22 @@
+msgid ""
+msgstr ""
+"Language: eo\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+#. type: Title =
+#: doc/scrypt.en.0.adoc:1
+#, no-wrap
+msgid "scrypt(0)"
+msgstr ""
+
+#. type: Title ==
+#: doc/scrypt.en.0.adoc:3
+#, no-wrap
+msgid "NAME"
+msgstr ""
+
+#. type: Plain text
+#: doc/scrypt.en.0.adoc:5
+msgid "scrypt - ."
+msgstr ""
diff --git a/po/doc/es.po b/po/doc/es.po
new file mode 100644
index 0000000..b3178b2
--- /dev/null
+++ b/po/doc/es.po
@@ -0,0 +1,22 @@
+msgid ""
+msgstr ""
+"Language: es\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+#. type: Title =
+#: doc/scrypt.en.0.adoc:1
+#, no-wrap
+msgid "scrypt(0)"
+msgstr ""
+
+#. type: Title ==
+#: doc/scrypt.en.0.adoc:3
+#, no-wrap
+msgid "NAME"
+msgstr ""
+
+#. type: Plain text
+#: doc/scrypt.en.0.adoc:5
+msgid "scrypt - ."
+msgstr ""
diff --git a/po/doc/fr.po b/po/doc/fr.po
new file mode 100644
index 0000000..6e941e0
--- /dev/null
+++ b/po/doc/fr.po
@@ -0,0 +1,22 @@
+msgid ""
+msgstr ""
+"Language: fr\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Plural-Forms: nplurals=2; plural=(n > 1);\n"
+
+#. type: Title =
+#: doc/scrypt.en.0.adoc:1
+#, no-wrap
+msgid "scrypt(0)"
+msgstr ""
+
+#. type: Title ==
+#: doc/scrypt.en.0.adoc:3
+#, no-wrap
+msgid "NAME"
+msgstr ""
+
+#. type: Plain text
+#: doc/scrypt.en.0.adoc:5
+msgid "scrypt - ."
+msgstr ""
diff --git a/po/doc/note.txt b/po/doc/note.txt
new file mode 100644
index 0000000..45279a4
--- /dev/null
+++ b/po/doc/note.txt
@@ -0,0 +1,5 @@
+PO4A-HEADER: mode=eof
+
+
+
+// Generated from po4a(1).
diff --git a/po/doc/po4a.cfg b/po/doc/po4a.cfg
new file mode 100644
index 0000000..d57d541
--- /dev/null
+++ b/po/doc/po4a.cfg
@@ -0,0 +1,5 @@
+[options] --keep 0 --master-charset UTF-8 --localized-charset UTF-8 --addendum-charset UTF-8
+
+[po_directory] po/doc
+
+[type: asciidoc] doc/scrypt.en.0.adoc          $lang:doc/scrypt.$lang.0.adoc
diff --git a/po/doc/pt.po b/po/doc/pt.po
new file mode 100644
index 0000000..a0e1b94
--- /dev/null
+++ b/po/doc/pt.po
@@ -0,0 +1,22 @@
+msgid ""
+msgstr ""
+"Language: pt\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+#. type: Title =
+#: doc/scrypt.en.0.adoc:1
+#, no-wrap
+msgid "scrypt(0)"
+msgstr ""
+
+#. type: Title ==
+#: doc/scrypt.en.0.adoc:3
+#, no-wrap
+msgid "NAME"
+msgstr ""
+
+#. type: Plain text
+#: doc/scrypt.en.0.adoc:5
+msgid "scrypt - ."
+msgstr ""
diff --git a/po/scrypt/de.po b/po/scrypt/de.po
new file mode 100644
index 0000000..4b3f6ea
--- /dev/null
+++ b/po/scrypt/de.po
@@ -0,0 +1,17 @@
+msgid ""
+msgstr ""
+"Language: de\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+#: src/scrypt.go:158
+msgid "Usage: scrypt PASSWORD SALT\n"
+msgstr ""
+
+#: src/scrypt.go:37
+msgid "scrypt: internal error"
+msgstr ""
+
+#: src/scrypt.go:36
+msgid "scrypt: salt is too small"
+msgstr ""
diff --git a/po/scrypt/eo.po b/po/scrypt/eo.po
new file mode 100644
index 0000000..c049161
--- /dev/null
+++ b/po/scrypt/eo.po
@@ -0,0 +1,17 @@
+msgid ""
+msgstr ""
+"Language: eo\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+#: src/scrypt.go:158
+msgid "Usage: scrypt PASSWORD SALT\n"
+msgstr ""
+
+#: src/scrypt.go:37
+msgid "scrypt: internal error"
+msgstr ""
+
+#: src/scrypt.go:36
+msgid "scrypt: salt is too small"
+msgstr ""
diff --git a/po/scrypt/es.po b/po/scrypt/es.po
new file mode 100644
index 0000000..3acf87c
--- /dev/null
+++ b/po/scrypt/es.po
@@ -0,0 +1,17 @@
+msgid ""
+msgstr ""
+"Language: es\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+#: src/scrypt.go:158
+msgid "Usage: scrypt PASSWORD SALT\n"
+msgstr ""
+
+#: src/scrypt.go:37
+msgid "scrypt: internal error"
+msgstr ""
+
+#: src/scrypt.go:36
+msgid "scrypt: salt is too small"
+msgstr ""
diff --git a/po/scrypt/fr.po b/po/scrypt/fr.po
new file mode 100644
index 0000000..deaad0d
--- /dev/null
+++ b/po/scrypt/fr.po
@@ -0,0 +1,17 @@
+msgid ""
+msgstr ""
+"Language: fr\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Plural-Forms: nplurals=2; plural=(n > 1);\n"
+
+#: src/scrypt.go:158
+msgid "Usage: scrypt PASSWORD SALT\n"
+msgstr ""
+
+#: src/scrypt.go:37
+msgid "scrypt: internal error"
+msgstr ""
+
+#: src/scrypt.go:36
+msgid "scrypt: salt is too small"
+msgstr ""
diff --git a/po/scrypt/po4a.cfg b/po/scrypt/po4a.cfg
new file mode 100644
index 0000000..4e88e0a
--- /dev/null
+++ b/po/scrypt/po4a.cfg
@@ -0,0 +1,3 @@
+[options] --keep 0 --master-charset UTF-8 --localized-charset UTF-8 --addendum-charset UTF-8
+
+[po_directory] po/scrypt
diff --git a/po/scrypt/pt.po b/po/scrypt/pt.po
new file mode 100644
index 0000000..0dd2e58
--- /dev/null
+++ b/po/scrypt/pt.po
@@ -0,0 +1,17 @@
+msgid ""
+msgstr ""
+"Language: pt\n"
+"Content-Type: text/plain; charset=UTF-8\n"
+"Plural-Forms: nplurals=2; plural=(n != 1);\n"
+
+#: src/scrypt.go:158
+msgid "Usage: scrypt PASSWORD SALT\n"
+msgstr ""
+
+#: src/scrypt.go:37
+msgid "scrypt: internal error"
+msgstr ""
+
+#: src/scrypt.go:36
+msgid "scrypt: salt is too small"
+msgstr ""
diff --git a/po/scrypt/scrypt.pot b/po/scrypt/scrypt.pot
new file mode 100644
index 0000000..19845fc
--- /dev/null
+++ b/po/scrypt/scrypt.pot
@@ -0,0 +1,17 @@
+msgid ""
+msgstr ""
+"Language: \n"
+"Content-Type: text/plain; charset=UTF-8\n"
+
+#: src/scrypt.go:158
+msgid "Usage: scrypt PASSWORD SALT\n"
+msgstr ""
+
+#: src/scrypt.go:37
+msgid "scrypt: internal error"
+msgstr ""
+
+#: src/scrypt.go:36
+msgid "scrypt: salt is too small"
+msgstr ""
+
diff --git a/src/scrypt.go b/src/scrypt.go
index 70140ab..511546f 100644
--- a/src/scrypt.go
+++ b/src/scrypt.go
@@ -3,11 +3,12 @@ package scrypt
 import (
 	"crypto/rand"
 	"encoding/hex"
-	"errors"
 	"fmt"
 	"io"
 	"os"
 	"slices"
+
+	gt "gotext"
 )
 
 
@@ -32,8 +33,8 @@ const (
 
 
 var (
-	ErrSaltTooSmall = errors.New("scrypt: salt is too small")
-	ErrInternal     = errors.New("scrypt: internal error")
+	ErrSaltTooSmall = gt.Error(gt.Gettext("scrypt: salt is too small"))
+	ErrInternal     = gt.Error(gt.Gettext("scrypt: internal error"))
 )
 
 
@@ -154,7 +155,7 @@ func Check(input CheckInput) (bool, error) {
 
 func Main() {
 	if len(os.Args) != 3 {
-		fmt.Fprintf(os.Stderr, "Usage: scrypt PASSWORD SALT\n")
+		fmt.Fprintf(os.Stderr, gt.Gettext("Usage: scrypt PASSWORD SALT\n"))
 		os.Exit(2)
 	}