Here is a framework that detects cases where a PO file assigns
the same accelerator key to multiple buttons in a dialog box or
to multiple items in a menu. ELinks already has some support for
this but it requires the translator to run ELinks and manually
scan through all menus and dialogs. The attached changes make it
possible to quickly detect and list any conflicts, including ones
that can only occur on operating systems or configurations that
the translator is not currently using.
The changes have no immediate effect on the elinks executable or
the MO files. PO files become larger, however.
The scheme works like this:
- Like before, accelerator keys in translatable strings are
tagged with the tilde (~) character.
- Whenever a C source file defines an accelerator key, it must
assign one or more named "contexts" to it. The translations in
the PO files inherit these contexts. If multiple strings use
the same accelerator (case insensitive) in the same context,
that's a conflict and can be detected automatically.
- The contexts are defined with "gettext_accelerator_context"
comments in source files. These comments delimit regions where
all translatable strings containing tildes are given the same
contexts. There must be one special comment at the top of the
region; it lists the contexts assigned to that region. The
region automatically ends at the end of the function (found
with regexp /^\}/), but it can also be closed explicitly with
another special comment. The comments are formatted like this:
/* [gettext_accelerator_context(foo, bar, baz)]
begins a region that uses the contexts "foo", "bar", and "baz".
The comma is the delimiter; whitespace is optional.
[gettext_accelerator_context()]
ends the region. */
The scripts don't currently check whether this syntax occurs
inside or outside comments.
- The names of contexts consist of C identifiers delimited with
periods. I typically used the name of a function that sets
up a dialog, or the name of an array where the items of a
menu are listed. There is a special feature for static
functions: if the name begins with a period, then the period
will be replaced with the name of the source file and a colon.
- If a menu is programmatically generated from multiple parts,
of which some are never used together, so that it is safe to
use the same accelerators in them, then it is necessary to
define multiple contexts for the same menu. link_menu() in
src/viewer/text/link.c is the most complex example of this.
- During make update-po:
- A Perl script (po/gather-accelerator-contexts.pl) reads
po/elinks.pot, scans the source files listed in it for
"gettext_accelerator_context" comments, and rewrites
po/elinks.pot with "accelerator_context" comments that
indicate the contexts of each msgid: the union of all
contexts of all of its uses in the source files. It also
removes any "gettext_accelerator_context" comments that
xgettext --add-comments has copied to elinks.pot.
- If po/gather-accelerator-contexts.pl does not find any
contexts for some use of an msgid that seems to contain an
accelerator (because it contains a tilde), it warns. If the
tilde refers to e.g. "~/.elinks" and does not actually mark
an accelerator, the warning can be silenced by specifying the
special context "IGNORE", which the script otherwise ignores.
- msgmerge copies the "accelerator_context" comments from
po/elinks.pot to po/*.po. Translators do not edit those
comments.
- During make check-po:
- Another Perl script (po/check-accelerator-contexts.pl) reads
po/*.po and keeps track of which accelerators have been bound
in each context. It warns about any conflicts it finds.
This script does not access the C source files; thus it does
not matter if the line numbers in "#:" lines are out of date.
This implementation is not perfect and I am not proposing to
add it to the main source tree at this time. Specifically:
- It introduces compile-time dependencies on Perl and Locale::PO.
There should be a configure-time or compile-time check so that
the new features are skipped if the prerequisites are missing.
- When the scripts include msgstr strings in warnings, they
should transcode them from the charset of the PO file to the
one specified by the user's locale.
- It is not adequately documented (well, except perhaps here).
- po/check-accelerator-contexts.pl reports the same conflict
multiple times if it occurs in multiple contexts.
- The warning messages should include line numbers, so that users
of Emacs could conveniently edit the conflicting part of the PO
file. This is not feasible with the current version of
Locale::PO.
- Locale::PO does not understand #~ lines and spews warnings
about them. There is an ugly hack to hide these warnings.
- Jonas Fonseca suggested the script could propose accelerators
that are still available. This has not been implemented.
There are three files attached:
- po/gather-accelerator-contexts.pl: Augments elinks.pot with
context information.
- po/check-accelerator-contexts.pl: Checks conflicts.
- accelerator-contexts.diff: Makes po/Makefile run the scripts,
and adds special comments to source files.
2005-12-04 18:38:29 -05:00
|
|
|
#! /usr/bin/perl
|
2006-01-13 16:33:52 -05:00
|
|
|
# The copyright notice and license are in the POD at the bottom.
|
|
|
|
|
Here is a framework that detects cases where a PO file assigns
the same accelerator key to multiple buttons in a dialog box or
to multiple items in a menu. ELinks already has some support for
this but it requires the translator to run ELinks and manually
scan through all menus and dialogs. The attached changes make it
possible to quickly detect and list any conflicts, including ones
that can only occur on operating systems or configurations that
the translator is not currently using.
The changes have no immediate effect on the elinks executable or
the MO files. PO files become larger, however.
The scheme works like this:
- Like before, accelerator keys in translatable strings are
tagged with the tilde (~) character.
- Whenever a C source file defines an accelerator key, it must
assign one or more named "contexts" to it. The translations in
the PO files inherit these contexts. If multiple strings use
the same accelerator (case insensitive) in the same context,
that's a conflict and can be detected automatically.
- The contexts are defined with "gettext_accelerator_context"
comments in source files. These comments delimit regions where
all translatable strings containing tildes are given the same
contexts. There must be one special comment at the top of the
region; it lists the contexts assigned to that region. The
region automatically ends at the end of the function (found
with regexp /^\}/), but it can also be closed explicitly with
another special comment. The comments are formatted like this:
/* [gettext_accelerator_context(foo, bar, baz)]
begins a region that uses the contexts "foo", "bar", and "baz".
The comma is the delimiter; whitespace is optional.
[gettext_accelerator_context()]
ends the region. */
The scripts don't currently check whether this syntax occurs
inside or outside comments.
- The names of contexts consist of C identifiers delimited with
periods. I typically used the name of a function that sets
up a dialog, or the name of an array where the items of a
menu are listed. There is a special feature for static
functions: if the name begins with a period, then the period
will be replaced with the name of the source file and a colon.
- If a menu is programmatically generated from multiple parts,
of which some are never used together, so that it is safe to
use the same accelerators in them, then it is necessary to
define multiple contexts for the same menu. link_menu() in
src/viewer/text/link.c is the most complex example of this.
- During make update-po:
- A Perl script (po/gather-accelerator-contexts.pl) reads
po/elinks.pot, scans the source files listed in it for
"gettext_accelerator_context" comments, and rewrites
po/elinks.pot with "accelerator_context" comments that
indicate the contexts of each msgid: the union of all
contexts of all of its uses in the source files. It also
removes any "gettext_accelerator_context" comments that
xgettext --add-comments has copied to elinks.pot.
- If po/gather-accelerator-contexts.pl does not find any
contexts for some use of an msgid that seems to contain an
accelerator (because it contains a tilde), it warns. If the
tilde refers to e.g. "~/.elinks" and does not actually mark
an accelerator, the warning can be silenced by specifying the
special context "IGNORE", which the script otherwise ignores.
- msgmerge copies the "accelerator_context" comments from
po/elinks.pot to po/*.po. Translators do not edit those
comments.
- During make check-po:
- Another Perl script (po/check-accelerator-contexts.pl) reads
po/*.po and keeps track of which accelerators have been bound
in each context. It warns about any conflicts it finds.
This script does not access the C source files; thus it does
not matter if the line numbers in "#:" lines are out of date.
This implementation is not perfect and I am not proposing to
add it to the main source tree at this time. Specifically:
- It introduces compile-time dependencies on Perl and Locale::PO.
There should be a configure-time or compile-time check so that
the new features are skipped if the prerequisites are missing.
- When the scripts include msgstr strings in warnings, they
should transcode them from the charset of the PO file to the
one specified by the user's locale.
- It is not adequately documented (well, except perhaps here).
- po/check-accelerator-contexts.pl reports the same conflict
multiple times if it occurs in multiple contexts.
- The warning messages should include line numbers, so that users
of Emacs could conveniently edit the conflicting part of the PO
file. This is not feasible with the current version of
Locale::PO.
- Locale::PO does not understand #~ lines and spews warnings
about them. There is an ugly hack to hide these warnings.
- Jonas Fonseca suggested the script could propose accelerators
that are still available. This has not been implemented.
There are three files attached:
- po/gather-accelerator-contexts.pl: Augments elinks.pot with
context information.
- po/check-accelerator-contexts.pl: Checks conflicts.
- accelerator-contexts.diff: Makes po/Makefile run the scripts,
and adds special comments to source files.
2005-12-04 18:38:29 -05:00
|
|
|
use strict;
|
|
|
|
use warnings;
|
|
|
|
use Locale::PO qw();
|
2006-01-14 05:24:32 -05:00
|
|
|
use Getopt::Long qw(GetOptions :config bundling gnu_compat);
|
2006-01-13 16:33:52 -05:00
|
|
|
use autouse 'Pod::Usage' => qw(pod2usage);
|
|
|
|
|
2006-03-11 12:58:42 -05:00
|
|
|
my $VERSION = "1.5";
|
2006-01-13 16:33:52 -05:00
|
|
|
|
2006-01-14 05:24:32 -05:00
|
|
|
sub show_version
|
|
|
|
{
|
2006-01-14 09:50:45 -05:00
|
|
|
print "check-accelerator-conflicts.pl $VERSION\n";
|
2006-01-14 05:24:32 -05:00
|
|
|
pod2usage({-verbose => 99, -sections => "COPYRIGHT AND LICENSE",
|
|
|
|
-exitval => 0});
|
|
|
|
}
|
|
|
|
|
2006-02-18 19:11:52 -05:00
|
|
|
# The character that precedes accelerators in strings.
|
|
|
|
# Set with the --accelerator-tag=CHARACTER option.
|
|
|
|
my $Opt_accelerator_tag;
|
|
|
|
|
|
|
|
# True if, for missing or fuzzy translations, the msgid string should
|
2006-03-11 12:58:42 -05:00
|
|
|
# be checked instead of msgstr. Set with the --msgid-fallback and
|
|
|
|
# --no-msgid-fallback options.
|
|
|
|
my $Opt_msgid_fallback = 1;
|
2006-01-14 12:36:58 -05:00
|
|
|
|
2006-02-18 05:21:18 -05:00
|
|
|
sub acceleration_arrays_eq ($$)
|
2006-02-12 13:28:07 -05:00
|
|
|
{
|
|
|
|
my($left, $right) = @_;
|
|
|
|
ref($left) eq "ARRAY" or return 0;
|
|
|
|
ref($right) eq "ARRAY" or return 0;
|
|
|
|
@$left == @$right or return 0;
|
|
|
|
$left->[$_] eq $right->[$_] or return 0
|
|
|
|
foreach (0 .. $#$right);
|
|
|
|
return 1;
|
|
|
|
}
|
|
|
|
|
2006-01-14 12:36:58 -05:00
|
|
|
sub check_po_file ($)
|
2006-01-13 16:33:52 -05:00
|
|
|
{
|
2006-03-11 12:58:42 -05:00
|
|
|
# The name of the PO file to be checked.
|
2006-01-13 16:33:52 -05:00
|
|
|
my($po_file_name) = @_;
|
2006-03-11 12:58:42 -05:00
|
|
|
|
|
|
|
# A nested hash that lists the accelerators and their uses.
|
|
|
|
# $accelerators{$accelerator}{$ctxname}{ACCELERATIONS}[$i]{LINENO}
|
|
|
|
# 1. In %accelerators, the keys are one-character strings,
|
|
|
|
# and the values are hash references.
|
|
|
|
# 2. In %{$accelerators{$accelerator}}, the keys are names
|
|
|
|
# of contexts in which the accelerator is used, and the
|
|
|
|
# values are references to "crossing" hashes.
|
|
|
|
# 3. %{$accelerators{$accelerator}{$ctxname}} is a "crossing" hash,
|
|
|
|
# so named because it describes how an accelerator and a context
|
|
|
|
# cross each other. It has the following elements:
|
|
|
|
# (ACCELERATIONS => [see point 4 below],
|
|
|
|
# REPORTED => (1 if this is a conflict and has been reported),
|
|
|
|
# AVOID => (1 if this accelerator should not be suggested in this
|
|
|
|
# context))
|
|
|
|
# 4. @{$accelerators{$accelerator}{$ctxname}{ACCELERATIONS}} is a list of
|
|
|
|
# references to "acceleration" hashes. If the same acceleration occurs
|
|
|
|
# in multiple contexts, then the references are to the same hash.
|
|
|
|
# 5. %{$accelerators{$accelerator}{ctxname}{ACCELERATIONS}[$i]} is an
|
|
|
|
# "acceleration" hash. It has the following structure:
|
|
|
|
# (PO => (the Locale::PO object),
|
|
|
|
# CTXNAMES => [read-only list of names of contexts in which the
|
|
|
|
# accelerator is used],
|
|
|
|
# ACCELERATOR => (a one-character string),
|
|
|
|
# LINENO => (line number in the PO file),
|
|
|
|
# STRING => (the msgid or msgstr string that defines the accelerator;
|
|
|
|
# unquoted as much as possible),
|
|
|
|
# EXPLAIN => (a string to be displayed if a conflict is found))
|
2006-02-12 13:28:07 -05:00
|
|
|
my %accelerators;
|
2006-03-11 12:58:42 -05:00
|
|
|
|
|
|
|
# How many entries had checkable accelerators.
|
|
|
|
my $checkable_count = 0;
|
|
|
|
|
|
|
|
# How many conflicts have been found so far.
|
|
|
|
my $conflict_count = 0;
|
2006-02-12 13:28:07 -05:00
|
|
|
|
|
|
|
{
|
|
|
|
my $pos = Locale::PO->load_file_asarray($po_file_name)
|
|
|
|
or warn "$po_file_name: $!\n", return 2;
|
|
|
|
foreach my $po (@$pos) {
|
|
|
|
my $automatic = $po->automatic()
|
|
|
|
or next;
|
2006-02-18 05:21:18 -05:00
|
|
|
my($ctxnames) = ($automatic =~ /^accelerator_context\(([^\)]*)\)/)
|
2006-02-12 13:28:07 -05:00
|
|
|
or next;
|
2006-02-18 05:21:18 -05:00
|
|
|
my @ctxnames = split(/\s*,\s*/, $ctxnames);
|
|
|
|
my @accelerations;
|
2006-02-18 19:11:52 -05:00
|
|
|
my $msgid = $po->msgid();
|
|
|
|
my $msgstr = $po->msgstr();
|
|
|
|
if ($po->dequote($msgstr) ne "" && !$po->fuzzy()) {
|
|
|
|
if (my($accelerator) = ($msgstr =~ /\Q$Opt_accelerator_tag\E(.)/s)) {
|
2006-02-18 05:21:18 -05:00
|
|
|
push @accelerations, { PO => $po,
|
2006-02-18 19:11:52 -05:00
|
|
|
CTXNAMES => \@ctxnames,
|
2006-02-18 05:21:18 -05:00
|
|
|
ACCELERATOR => $accelerator,
|
|
|
|
LINENO => $po->msgstr_begin_lineno(),
|
|
|
|
STRING => $msgstr,
|
|
|
|
EXPLAIN => "msgstr $msgstr" };
|
|
|
|
}
|
|
|
|
|
|
|
|
# TODO: look for accelerators in plural forms?
|
|
|
|
}
|
2006-02-18 19:11:52 -05:00
|
|
|
elsif ($Opt_msgid_fallback && $po->dequote($msgid) ne "") {
|
|
|
|
if (my($accelerator) = ($msgid =~ /\Q$Opt_accelerator_tag\E(.)/s)) {
|
2006-02-18 05:21:18 -05:00
|
|
|
push @accelerations, { PO => $po,
|
2006-02-18 19:11:52 -05:00
|
|
|
CTXNAMES => \@ctxnames,
|
2006-02-18 05:21:18 -05:00
|
|
|
ACCELERATOR => $accelerator,
|
|
|
|
LINENO => $po->msgid_begin_lineno(),
|
2006-02-18 19:11:52 -05:00
|
|
|
STRING => $msgid,
|
2006-02-18 05:21:18 -05:00
|
|
|
EXPLAIN => "msgid $msgid" };
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2006-03-11 12:58:42 -05:00
|
|
|
$checkable_count++ if @accelerations;
|
2006-02-18 05:21:18 -05:00
|
|
|
foreach my $acceleration (@accelerations) {
|
2006-03-11 12:58:42 -05:00
|
|
|
my $accelerator = uc($acceleration->{ACCELERATOR});
|
|
|
|
foreach my $crossing (@{$accelerators{$accelerator}}{@ctxnames}) {
|
|
|
|
push @{$crossing->{ACCELERATIONS}}, $acceleration;
|
|
|
|
$crossing->{AVOID} = 1 if $acceleration->{EXPLAIN} =~ /^msgstr/;
|
2006-02-18 05:21:18 -05:00
|
|
|
}
|
2006-02-12 13:28:07 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
foreach my $accelerator (sort keys %accelerators) {
|
|
|
|
my $ctxhash = $accelerators{$accelerator};
|
2006-03-11 12:58:42 -05:00
|
|
|
foreach my $crossing (@{$ctxhash}{sort keys %$ctxhash}) {
|
|
|
|
my $accelerations = $crossing->{ACCELERATIONS};
|
|
|
|
if ($accelerations && @$accelerations > 1 && !$crossing->{REPORTED}) {
|
2006-02-12 14:08:23 -05:00
|
|
|
my @ctxnames_in_conflict;
|
2006-03-11 12:58:42 -05:00
|
|
|
foreach my $inner_ctxname (keys %$ctxhash) {
|
|
|
|
my $inner_crossing = $ctxhash->{$inner_ctxname};
|
|
|
|
if (acceleration_arrays_eq($inner_crossing->{ACCELERATIONS},
|
|
|
|
$accelerations)) {
|
|
|
|
push @ctxnames_in_conflict, $inner_ctxname;
|
|
|
|
$inner_crossing->{REPORTED} = 1;
|
2006-02-12 13:28:07 -05:00
|
|
|
}
|
|
|
|
}
|
2006-02-12 14:08:23 -05:00
|
|
|
my $ctxnames_in_conflict = join(", ", map(qq("$_"), @ctxnames_in_conflict));
|
|
|
|
warn "$po_file_name: Accelerator conflict for \"$accelerator\" in $ctxnames_in_conflict:\n";
|
2006-02-18 05:21:18 -05:00
|
|
|
foreach my $acceleration (@$accelerations) {
|
|
|
|
my $lineno = $acceleration->{LINENO};
|
|
|
|
my $explain = $acceleration->{EXPLAIN};
|
2006-02-12 14:08:23 -05:00
|
|
|
|
2006-02-18 05:21:18 -05:00
|
|
|
# Get a string of unique characters in the string,
|
2006-02-12 14:08:23 -05:00
|
|
|
# preferring characters that start a word.
|
2006-02-18 05:21:18 -05:00
|
|
|
# FIXME: should remove quotes and resolve \n etc.
|
|
|
|
my $displaystr = $acceleration->{STRING};
|
2006-02-18 19:11:52 -05:00
|
|
|
$displaystr =~ s/\Q$Opt_accelerator_tag\E//g;
|
2006-02-12 14:08:23 -05:00
|
|
|
my $suggestions = "";
|
|
|
|
foreach my $char ($displaystr =~ /\b(\w)/g,
|
|
|
|
$displaystr =~ /(\w)/g) {
|
|
|
|
$suggestions .= $char unless $suggestions =~ /\Q$char\E/i;
|
|
|
|
}
|
|
|
|
|
|
|
|
# But don't suggest unavailable characters.
|
|
|
|
SUGGESTION: foreach my $char (split(//, $suggestions)) {
|
2006-02-18 19:11:52 -05:00
|
|
|
foreach my $ctxname (@{$acceleration->{CTXNAMES}}) {
|
2006-02-12 14:08:23 -05:00
|
|
|
$suggestions =~ s/\Q$char\E//, next SUGGESTION
|
2006-03-11 12:58:42 -05:00
|
|
|
if $accelerators{uc($char)}{$ctxname}{AVOID};
|
2006-02-12 14:08:23 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2006-02-18 05:21:18 -05:00
|
|
|
warn "$po_file_name:$lineno: $explain\n";
|
2006-02-12 14:08:23 -05:00
|
|
|
if ($suggestions eq "") {
|
|
|
|
warn "$po_file_name:$lineno: no suggestions :-(\n";
|
|
|
|
}
|
|
|
|
else {
|
|
|
|
warn "$po_file_name:$lineno: suggestions: $suggestions\n";
|
|
|
|
}
|
2006-03-11 12:58:42 -05:00
|
|
|
} # foreach $acceleration in conflict
|
|
|
|
$conflict_count++;
|
2006-02-12 14:08:23 -05:00
|
|
|
} # if found a conflict
|
|
|
|
} # foreach context known for $accelerator
|
|
|
|
} # foreach $accelerator
|
2006-03-11 12:58:42 -05:00
|
|
|
|
|
|
|
print "$po_file_name: "
|
|
|
|
. ($checkable_count == 1 ? "Checked 1 entry" : "Checked $checkable_count entries")
|
|
|
|
. ", "
|
|
|
|
. ($conflict_count == 1 ? "found 1 accelerator conflict" : "found $conflict_count accelerator conflicts")
|
|
|
|
. ".\n";
|
|
|
|
return $conflict_count ? 1 : 0;
|
2006-01-13 16:33:52 -05:00
|
|
|
}
|
|
|
|
|
2006-01-14 12:36:58 -05:00
|
|
|
GetOptions("accelerator-tag=s" => sub {
|
|
|
|
my($option, $value) = @_;
|
|
|
|
die "Cannot use multiple --accelerator-tag options\n"
|
2006-02-18 19:11:52 -05:00
|
|
|
if defined($Opt_accelerator_tag);
|
2006-01-14 12:36:58 -05:00
|
|
|
die "--accelerator-tag requires a single-character argument\n"
|
|
|
|
if length($value) != 1;
|
2006-02-18 19:11:52 -05:00
|
|
|
$Opt_accelerator_tag = $value;
|
2006-01-14 12:36:58 -05:00
|
|
|
},
|
2006-03-11 12:58:42 -05:00
|
|
|
"msgid-fallback!" => \$Opt_msgid_fallback,
|
2006-01-14 12:36:58 -05:00
|
|
|
"help" => sub { pod2usage({-verbose => 1, -exitval => 0}) },
|
2006-01-13 16:33:52 -05:00
|
|
|
"version" => \&show_version)
|
|
|
|
or exit 2;
|
2006-02-18 19:11:52 -05:00
|
|
|
$Opt_accelerator_tag = "~" unless defined $Opt_accelerator_tag;
|
2006-01-13 16:33:52 -05:00
|
|
|
print(STDERR "$0: missing file operand\n"), exit 2 unless @ARGV;
|
2006-01-14 12:36:58 -05:00
|
|
|
|
2006-01-13 16:33:52 -05:00
|
|
|
my $max_error = 0;
|
|
|
|
foreach my $po_file_name (@ARGV) {
|
|
|
|
my $error = check_po_file($po_file_name);
|
|
|
|
$max_error = $error if $error > $max_error;
|
Here is a framework that detects cases where a PO file assigns
the same accelerator key to multiple buttons in a dialog box or
to multiple items in a menu. ELinks already has some support for
this but it requires the translator to run ELinks and manually
scan through all menus and dialogs. The attached changes make it
possible to quickly detect and list any conflicts, including ones
that can only occur on operating systems or configurations that
the translator is not currently using.
The changes have no immediate effect on the elinks executable or
the MO files. PO files become larger, however.
The scheme works like this:
- Like before, accelerator keys in translatable strings are
tagged with the tilde (~) character.
- Whenever a C source file defines an accelerator key, it must
assign one or more named "contexts" to it. The translations in
the PO files inherit these contexts. If multiple strings use
the same accelerator (case insensitive) in the same context,
that's a conflict and can be detected automatically.
- The contexts are defined with "gettext_accelerator_context"
comments in source files. These comments delimit regions where
all translatable strings containing tildes are given the same
contexts. There must be one special comment at the top of the
region; it lists the contexts assigned to that region. The
region automatically ends at the end of the function (found
with regexp /^\}/), but it can also be closed explicitly with
another special comment. The comments are formatted like this:
/* [gettext_accelerator_context(foo, bar, baz)]
begins a region that uses the contexts "foo", "bar", and "baz".
The comma is the delimiter; whitespace is optional.
[gettext_accelerator_context()]
ends the region. */
The scripts don't currently check whether this syntax occurs
inside or outside comments.
- The names of contexts consist of C identifiers delimited with
periods. I typically used the name of a function that sets
up a dialog, or the name of an array where the items of a
menu are listed. There is a special feature for static
functions: if the name begins with a period, then the period
will be replaced with the name of the source file and a colon.
- If a menu is programmatically generated from multiple parts,
of which some are never used together, so that it is safe to
use the same accelerators in them, then it is necessary to
define multiple contexts for the same menu. link_menu() in
src/viewer/text/link.c is the most complex example of this.
- During make update-po:
- A Perl script (po/gather-accelerator-contexts.pl) reads
po/elinks.pot, scans the source files listed in it for
"gettext_accelerator_context" comments, and rewrites
po/elinks.pot with "accelerator_context" comments that
indicate the contexts of each msgid: the union of all
contexts of all of its uses in the source files. It also
removes any "gettext_accelerator_context" comments that
xgettext --add-comments has copied to elinks.pot.
- If po/gather-accelerator-contexts.pl does not find any
contexts for some use of an msgid that seems to contain an
accelerator (because it contains a tilde), it warns. If the
tilde refers to e.g. "~/.elinks" and does not actually mark
an accelerator, the warning can be silenced by specifying the
special context "IGNORE", which the script otherwise ignores.
- msgmerge copies the "accelerator_context" comments from
po/elinks.pot to po/*.po. Translators do not edit those
comments.
- During make check-po:
- Another Perl script (po/check-accelerator-contexts.pl) reads
po/*.po and keeps track of which accelerators have been bound
in each context. It warns about any conflicts it finds.
This script does not access the C source files; thus it does
not matter if the line numbers in "#:" lines are out of date.
This implementation is not perfect and I am not proposing to
add it to the main source tree at this time. Specifically:
- It introduces compile-time dependencies on Perl and Locale::PO.
There should be a configure-time or compile-time check so that
the new features are skipped if the prerequisites are missing.
- When the scripts include msgstr strings in warnings, they
should transcode them from the charset of the PO file to the
one specified by the user's locale.
- It is not adequately documented (well, except perhaps here).
- po/check-accelerator-contexts.pl reports the same conflict
multiple times if it occurs in multiple contexts.
- The warning messages should include line numbers, so that users
of Emacs could conveniently edit the conflicting part of the PO
file. This is not feasible with the current version of
Locale::PO.
- Locale::PO does not understand #~ lines and spews warnings
about them. There is an ugly hack to hide these warnings.
- Jonas Fonseca suggested the script could propose accelerators
that are still available. This has not been implemented.
There are three files attached:
- po/gather-accelerator-contexts.pl: Augments elinks.pot with
context information.
- po/check-accelerator-contexts.pl: Checks conflicts.
- accelerator-contexts.diff: Makes po/Makefile run the scripts,
and adds special comments to source files.
2005-12-04 18:38:29 -05:00
|
|
|
}
|
2006-01-13 16:33:52 -05:00
|
|
|
exit $max_error;
|
2006-01-08 19:17:16 -05:00
|
|
|
|
|
|
|
__END__
|
|
|
|
|
|
|
|
=head1 NAME
|
|
|
|
|
2006-01-14 09:50:45 -05:00
|
|
|
check-accelerator-conflicts.pl - Scan a PO file for conflicting
|
2006-01-08 19:17:16 -05:00
|
|
|
accelerator keys.
|
|
|
|
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
|
2006-01-14 12:36:58 -05:00
|
|
|
B<check-accelerator-conflicts.pl> [I<option> ...] F<I<language>.po> [...]
|
2006-01-08 19:17:16 -05:00
|
|
|
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
|
2006-01-14 09:50:45 -05:00
|
|
|
B<check-accelerator-conflicts.pl> is part of a framework that detects
|
2006-01-08 19:17:16 -05:00
|
|
|
conflicting accelerator keys in Gettext PO files. A conflict is when
|
|
|
|
two items in the same menu or two buttons in the same dialog box use
|
|
|
|
the same accelerator key.
|
|
|
|
|
|
|
|
The PO file format does not normally include any information on which
|
|
|
|
strings will be used in the same menu or dialog box.
|
2006-01-14 09:50:45 -05:00
|
|
|
B<check-accelerator-conflicts.pl> can only be used on PO files to which
|
2006-01-08 19:17:16 -05:00
|
|
|
this information has been added with B<gather-accelerator-contexts.pl>
|
|
|
|
or merged with B<msgmerge>.
|
|
|
|
|
2006-01-14 09:50:45 -05:00
|
|
|
B<check-accelerator-conflicts.pl> reads the F<I<language>.po> file
|
2006-01-08 19:17:16 -05:00
|
|
|
named on the command line and reports any conflicts to standard error.
|
2006-02-18 19:11:52 -05:00
|
|
|
It also tries to suggest replacements for the conflicting accelerators.
|
2006-01-08 19:17:16 -05:00
|
|
|
|
2006-01-14 09:50:45 -05:00
|
|
|
B<check-accelerator-conflicts.pl> does not access the source files to
|
2006-01-08 19:17:16 -05:00
|
|
|
which F<I<language>.po> refers. Thus, it does not matter if the line
|
|
|
|
numbers in "#:" lines are out of date.
|
|
|
|
|
2006-01-14 12:36:58 -05:00
|
|
|
=head1 OPTIONS
|
|
|
|
|
|
|
|
=over
|
|
|
|
|
|
|
|
=item B<--accelerator-tag=>I<character>
|
|
|
|
|
|
|
|
Specify the character that marks accelerators in C<msgstr> strings.
|
|
|
|
Whenever this character occurs in a C<msgstr>,
|
|
|
|
B<check-accelerator-conflicts.pl> treats the next character as an
|
|
|
|
accelerator and checks that it is unique in each of the contexts in
|
|
|
|
which the C<msgstr> is used.
|
|
|
|
|
|
|
|
Omitting the B<--accelerator-tag> option implies
|
|
|
|
B<--accelerator-tag="~">. The option must be given to each program
|
|
|
|
separately because there is no standard way to save this information
|
|
|
|
in the PO file.
|
|
|
|
|
2006-02-18 19:11:52 -05:00
|
|
|
=item B<--msgid-fallback>
|
|
|
|
|
2006-03-11 12:58:42 -05:00
|
|
|
=item B<--no-msgid-fallback>
|
|
|
|
|
|
|
|
Select how to check entries where the C<msgstr> is missing or fuzzy.
|
|
|
|
The default is B<--msgid-fallback>, which makes
|
|
|
|
B<check-accelerator-conflicts.pl> use the C<msgid> instead, and report
|
|
|
|
any conflicts between C<msgid> and C<msgstr> strings. The alternative
|
|
|
|
is B<--no-msgid-fallback>, which makes B<check-accelerator-conflicts.pl>
|
|
|
|
completely ignore such entries.
|
2006-02-18 19:11:52 -05:00
|
|
|
|
2006-03-11 12:58:42 -05:00
|
|
|
Regardless of these options, B<check-accelerator-conflicts.pl> will
|
|
|
|
suggest accelerators that would conflict with ones defined in C<msgid>
|
|
|
|
strings. Those strings will be eventually shadowed by C<msgstr>
|
|
|
|
strings, so their accelerators should not affect which accelerators
|
|
|
|
the translator chooses for C<msgstr> strings.
|
2006-02-18 19:11:52 -05:00
|
|
|
|
2006-01-14 12:36:58 -05:00
|
|
|
=back
|
|
|
|
|
|
|
|
=head1 ARGUMENTS
|
|
|
|
|
|
|
|
=over
|
|
|
|
|
|
|
|
=item F<I<language>.po> [...]
|
|
|
|
|
|
|
|
The PO files to be scanned for conflicts. These files must include the
|
|
|
|
"accelerator_context" comments added by B<gather-accelerator-contexts.pl>.
|
|
|
|
If the special comments are missing, no conflicts will be found.
|
|
|
|
|
|
|
|
=back
|
|
|
|
|
2006-01-13 16:33:52 -05:00
|
|
|
=head1 EXIT CODE
|
2006-01-08 19:17:16 -05:00
|
|
|
|
2006-01-13 16:33:52 -05:00
|
|
|
0 if no conflicts were found.
|
2006-01-08 19:17:16 -05:00
|
|
|
|
2006-01-13 16:33:52 -05:00
|
|
|
1 if some conflicts were found.
|
2006-01-08 19:17:16 -05:00
|
|
|
|
2006-01-13 16:33:52 -05:00
|
|
|
2 if the command line is invalid or a file cannot be read.
|
2006-01-08 19:17:16 -05:00
|
|
|
|
|
|
|
=head1 BUGS
|
|
|
|
|
|
|
|
=head2 Waiting for Locale::PO fixes
|
|
|
|
|
2006-01-14 09:50:45 -05:00
|
|
|
When B<check-accelerator-conflicts.pl> includes C<msgstr> strings in
|
2006-01-08 19:17:16 -05:00
|
|
|
warnings, it should transcode them from the charset of the PO file to
|
|
|
|
the one specified by the user's locale.
|
|
|
|
|
|
|
|
=head1 AUTHOR
|
|
|
|
|
|
|
|
Kalle Olavi Niemitalo <kon@iki.fi>
|
|
|
|
|
|
|
|
=head1 COPYRIGHT AND LICENSE
|
|
|
|
|
|
|
|
Copyright (c) 2005-2006 Kalle Olavi Niemitalo.
|
|
|
|
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
|
|
it under the same terms as Perl itself. In addition:
|
|
|
|
|
|
|
|
=over
|
|
|
|
|
|
|
|
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 COPYRIGHT HOLDER(S) 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.
|
|
|
|
|
|
|
|
=back
|
|
|
|
|
|
|
|
=head1 SEE ALSO
|
|
|
|
|
|
|
|
L<gather-accelerator-contexts.pl>, C<xgettext(1)>, C<msgmerge(1)>
|