From mboxrd@z Thu Jan  1 00:00:00 1970
Return-Path: <m.sandoval@proxmox.com>
Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68])
 (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)
 key-exchange X25519 server-signature RSA-PSS (2048 bits))
 (No client certificate requested)
 by lists.proxmox.com (Postfix) with ESMTPS id 7089F88A1
 for <pve-devel@lists.proxmox.com>; Thu, 31 Aug 2023 13:17:03 +0200 (CEST)
Received: from firstgate.proxmox.com (localhost [127.0.0.1])
 by firstgate.proxmox.com (Proxmox) with ESMTP id 538349894
 for <pve-devel@lists.proxmox.com>; Thu, 31 Aug 2023 13:17:03 +0200 (CEST)
Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com
 [94.136.29.106])
 (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)
 key-exchange X25519 server-signature RSA-PSS (2048 bits))
 (No client certificate requested)
 by firstgate.proxmox.com (Proxmox) with ESMTPS
 for <pve-devel@lists.proxmox.com>; Thu, 31 Aug 2023 13:17:01 +0200 (CEST)
Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1])
 by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 8BBBC478EB
 for <pve-devel@lists.proxmox.com>; Thu, 31 Aug 2023 13:17:01 +0200 (CEST)
From: Maximiliano Sandoval <m.sandoval@proxmox.com>
To: pve-devel@lists.proxmox.com
Date: Thu, 31 Aug 2023 13:16:58 +0200
Message-Id: <20230831111658.98006-1-m.sandoval@proxmox.com>
X-Mailer: git-send-email 2.39.2
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
X-SPAM-LEVEL: Spam detection results:  0
 AWL -0.004 Adjusted score from AWL reputation of From: address
 BAYES_00                 -1.9 Bayes spam probability is 0 to 1%
 DMARC_MISSING             0.1 Missing DMARC policy
 KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment
 SPF_HELO_NONE           0.001 SPF: HELO does not publish an SPF Record
 SPF_PASS               -0.001 SPF: sender matches SPF record
 URIBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to URIBL was blocked. See
 http://wiki.apache.org/spamassassin/DnsBlocklists#dnsbl-block for more
 information. [jsgettext.pl, gnu.org]
Subject: [pve-devel] [PATCH proxmox-i18n v2] js generator: extract comments
 from source
X-BeenThere: pve-devel@lists.proxmox.com
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Proxmox VE development discussion <pve-devel.lists.proxmox.com>
List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pve-devel>, 
 <mailto:pve-devel-request@lists.proxmox.com?subject=unsubscribe>
List-Archive: <http://lists.proxmox.com/pipermail/pve-devel/>
List-Post: <mailto:pve-devel@lists.proxmox.com>
List-Help: <mailto:pve-devel-request@lists.proxmox.com?subject=help>
List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel>, 
 <mailto:pve-devel-request@lists.proxmox.com?subject=subscribe>
X-List-Received-Date: Thu, 31 Aug 2023 11:17:03 -0000

Adds a way to extract comments to the resulting .po files loosely
matching xgettext's behavior. Useful for instances like

```js
   // Translators: This is the verb, not the noun
   gettext("Profile");

   // Translators: This would read 'foo bar'
   Ext.String.format(gettext('foo {0}'), 'bar');
```

where the string is not enough to guarantee is a satisfactory
translation.

Do note that two identical messages with different comments will count
as the same message (same msgid) from the point of view of gettext. To
truly differentiate them one would need to support Context via the
pgettext function, see [1].

Unlike xgettext we require comments to start with either `TRANSLATORS`
or `i18n` (the parsing is case-insensitive) simply to avoid filling po
files with potentially confusing comments unrelated to translations.

Caveats:
  - Cannot extract multi-line comments
  - Does not understand comments in the /* foo */ form

[1] https://www.gnu.org/software/gettext/manual/html_node/Contexts.html

Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
---
 jsgettext.pl | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)

diff --git a/jsgettext.pl b/jsgettext.pl
index 7f758fd..1c6c050 100755
--- a/jsgettext.pl
+++ b/jsgettext.pl
@@ -93,7 +93,7 @@ my $href = {
 };
 
 sub extract_msg {
-    my ($filename, $linenr, $line) = @_;
+    my ($filename, $linenr, $line, $comment) = @_;
 
     my $count = 0;
 
@@ -110,8 +110,13 @@ sub extract_msg {
 
 	if (my $po = $href->{$text}) {
 	    $po->reference($po->reference() . " $ref");
+	    if ($po->automatic && $comment) {
+		$po->automatic($po->automatic . "\n" . $comment);
+	    } elsif ($comment) {
+		$po->automatic($comment);
+	    }
 	} else {
-	    $href->{$text} = Locale::PO->new(-msgid=> $text, -reference=> $ref, -msgstr=> '');
+	    $href->{$text} = Locale::PO->new(-msgid=> $text, -reference=> $ref, -msgstr=> '', -automatic=> $comment);
 	}
     }
     die "can't extract gettext message in '$filename' line $linenr\n" if !$count;
@@ -122,10 +127,13 @@ my $sources = find_js_sources($dirs);
 
 foreach my $s (@$sources) {
     open(my $SRC_FH, '<', $s) || die "unable to open file '$s' - $!\n";
+    my $prev_line;
     while(defined(my $line = <$SRC_FH>)) {
 	if ($line =~ m/gettext\s*\(/ && $line !~ m/^\s*function gettext/) {
-	    extract_msg($s, $., $line);
+	    my ($comment) = $prev_line =~ /\/\/\s+((?:translators|i18n).*)/i;
+	    extract_msg($s, $., $line, $comment);
 	}
+	$prev_line = $line;
     }
     close($SRC_FH);
 }
-- 
2.39.2