From 66fd52aa15083f80e51c66c37a8285600fa94dbe Mon Sep 17 00:00:00 2001
From: David Adam <zanchey@ucc.gu.uwa.edu.au>
Date: Sat, 21 Sep 2019 22:24:11 +0800
Subject: [PATCH] fish_xgettext: update translation generation for new build
 system

Closes #6123.
---
 CONTRIBUTING.md                | 22 ++++++++++++++++++++--
 build_tools/fish_xgettext.fish | 15 ++++++++++++++-
 2 files changed, 34 insertions(+), 3 deletions(-)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index a8e0bd830..b879877bc 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -297,7 +297,13 @@ sudo ln -s /usr/bin/clang-format-3.9 /usr/bin/clang-format
 
 ## Message Translations
 
-Fish uses the GNU gettext library to translate messages from English to other languages. To create or update a translation run `make po/[LANGUAGE CODE].po` where `LANGUAGE CODE` is the two letter ISO 639-1 language code of the language you are translating to (e.g. `de` for German). Make sure that you have the `xgettext`, `msgfmt` and `msgmerge` commands installed in order to do this.
+Fish uses the GNU gettext library to translate messages from English to other languages.
+
+All non-debug messages output for user consumption should be marked for translation. In C++, this requires the use of the `_` (underscore) macro:
+
+```
+streams.out.append_format(_(L"%ls: There are no jobs\n"), argv[0]);
+```
 
 All messages in fish script must be enclosed in single or double quote characters. They must also be translated via a subcommand. This means that the following are **not** valid:
 
@@ -315,6 +321,18 @@ echo (_ "goodbye")
 
 Note that you can use either single or double quotes to enclose the message to be translated. You can also optionally include spaces after the opening parentheses and once again before the closing parentheses.
 
-Be cautious about blindly updating an existing translation file. Trivial changes to an existing message (e.g., changing the punctuation) will cause existing translations to be removed, since the tools do literal string matching. Therefore, in general, you need to carefully review any recommended deletions.
+Creating and updating translations requires the Gettext tools, including `xgettext`, `msgfmt` and `msgmerge`. Translation sources are stored in the `po` directory, named `LANG.po`, where `LANG` is the two letter ISO 639-1 language code of the target language (eg `de` for German).
+
+To create a new translation, for example for German:
+* generate a `messages.pot` file by running `build_tools/fish_xgettext.fish` from the source tree
+* copy `messages.pot` to `po/LANG.po` ()
+
+To update a translation:
+* generate a `messages.pot` file by running `build_tools/fish_xgettext.fish` from the source tree
+* update the existing translation by running `msgmerge --update --no-fuzzy-matching po/LANG.po messages.pot`
+
+Many tools are available for editing translation files, including command-line and graphical user interface programs.
+
+Be cautious about blindly updating an existing translation file. Trivial changes to an existing message (eg changing the punctuation) will cause existing translations to be removed, since the tools do literal string matching. Therefore, in general, you need to carefully review any recommended deletions.
 
 Read the [translations wiki](https://github.com/fish-shell/fish-shell/wiki/Translations) for more information.
diff --git a/build_tools/fish_xgettext.fish b/build_tools/fish_xgettext.fish
index eeeddaf32..9a0e2b295 100755
--- a/build_tools/fish_xgettext.fish
+++ b/build_tools/fish_xgettext.fish
@@ -1,5 +1,8 @@
 #!/usr/bin/env fish
 #
+# Tool to generate messages.pot
+# Extended to replace the old Makefile rule which did not port easily to CMak
+
 # This script was originally motivated to work around a quirk (or bug depending on your viewpoint)
 # of the xgettext command. See https://lists.gnu.org/archive/html/bug-gettext/2014-11/msg00006.html.
 # However, it turns out that even if that quirk did not exist we would still need something like
@@ -8,14 +11,19 @@
 # all the strings we want translated. So we extract and normalize all such strings into a format
 # that `xgettext` can handle.
 
+# Start with the C++ source
+xgettext -k -k_ -kN_ -LC++ --no-wrap -o messages.pot src/*.cpp src/*.h
+
 # This regex handles descriptions for `complete` and `function` statements. These messages are not
 # particularly important to translate. Hence the "implicit" label.
-set implicit_regex '(?:^| +)(?:complete|function) .*? (?:-d|--description) (([\'"]).+?(?<!\\\\)\\2).*'
+set implicit_regex '(?:^| +)(?:complete|function).*? (?:-d|--description) (([\'"]).+?(?<!\\\\)\\2).*'
 
 # This regex handles explicit requests to translate a message. These are more important to translate
 # than messages which should be implicitly translated.
 set explicit_regex '.*\( *_ (([\'"]).+?(?<!\\\\)\\2) *\).*'
 
+rm -r /tmp/fish
+
 mkdir -p /tmp/fish/implicit/share/completions /tmp/fish/implicit/share/functions
 mkdir -p /tmp/fish/explicit/share/completions /tmp/fish/explicit/share/functions
 
@@ -40,3 +48,8 @@ for f in share/config.fish share/completions/*.fish share/functions/*.fish
     end </tmp/fish/implicit/$f.tmp >/tmp/fish/implicit/$f
     rm /tmp/fish/implicit/$f.tmp
 end
+
+xgettext -j -k -kN_ -LShell --from-code=UTF-8 -cDescription --no-wrap -o messages.pot /tmp/fish/explicit/share/*/*.fish
+xgettext -j -k -kN_ -LShell --from-code=UTF-8 -cDescription --no-wrap -o messages.pot /tmp/fish/implicit/share/*/*.fish
+
+rm -r /tmp/fish