1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
|
=encoding utf8
=head1 NAME
Log::Report::Extract::PerlPPI - Collect translatable strings from Perl using PPI
=head1 INHERITANCE
Log::Report::Extract::PerlPPI
is a Log::Report::Extract
=head1 SYNOPSIS
my $ppi = Log::Report::Extract::PerlPPI->new(
lexicon => '/usr/share/locale',
);
$ppi->process('lib/My/Pkg.pm'); # call for each .pm file
$ppi->showStats; # optional
$ppi->write;
# See script xgettext-perl
bin/xgettext-perl -p $lexdir @source_dirs
=head1 DESCRIPTION
This module helps maintaining the POT files, updating the list of
message-ids which are kept in them. After initiation, the L<process()|Log::Report::Extract::PerlPPI/"Processors">
method needs to be called with all files which changed since last processing
and the existing PO files will get updated accordingly.
If no translations exist yet, one C<$lexicon/$domain.po> file will be
created. If you want to start a translation, copy C<$lexicon/$domain.po>
to C<$lexicon/$domain/$lang.po> and edit that file. You may use
C<poedit> to edit po-files. There are many smart translation management
applications which can hand po-files, for instance Pootle and Weblate.
Do not forget to add the new po-file to your distribution (MANIFEST)
Extends L<"DESCRIPTION" in Log::Report::Extract|Log::Report::Extract/"DESCRIPTION">.
=head2 The extraction process
All pm-files need to be processed in one go: no incremental processing!
The Perl source is parsed using PPI, which does understand Perl syntax
quite well, but does not support all features.
Automatically, the textdomain of the translations is discovered, as
first parameter of C<use Log::Report>. You may switch textdomain inside
one pm-file.
When all files have been processed, during the L<write()|Log::Report::Extract/"Processors">, all existing
po-files for all discovered textdomains will get updated. Not only the
C<$lexicon/$domain.po> template, but also all C<$lexicon/$domain/$lang.po>
will be replaced. When a msgid has disappeared, existing translations
will get disabled, not removed. New msgids will be added and flagged
"fuzzy".
=head3 What is extracted?
This script will extract the msgids used in C<__()>, C<__x()>, C<__xn()>,
and C<__n()> (implemented by L<Log::Report|Log::Report>) For instance
__x"msgid", @more
__x'msgid', @more <--- no! syntax error!
__x("msgid", @more)
__x('msgid', @more)
__x(msgid => @more)
Besides, there are some helpers which are no-ops in the code, only to fill
the po-tables: C<N__()>, C<N__n()>, C<N__()>
=head3 What is not extracted?
B<Not> extracted are the usage of anything above, where the first
parameter is not a simple string. Not extracted are
__x($format, @more)
__x$format, @more
__x(+$format, _domain => 'other domain', @more)
__x($first.$second, @more)
In these cases, you have to use C<N__()> functions to declare the possible
values of C<$format>.
=head1 METHODS
Extends L<"METHODS" in Log::Report::Extract|Log::Report::Extract/"METHODS">.
=head2 Constructors
Extends L<"Constructors" in Log::Report::Extract|Log::Report::Extract/"Constructors">.
=over 4
=item $class-E<gt>B<new>(%options)
Inherited, see L<Log::Report::Extract/"Constructors">
=back
=head2 Accessors
Extends L<"Accessors" in Log::Report::Extract|Log::Report::Extract/"Accessors">.
=over 4
=item $obj-E<gt>B<addPot>($domain, $pot, %options)
Inherited, see L<Log::Report::Extract/"Accessors">
=item $obj-E<gt>B<charset>()
Inherited, see L<Log::Report::Extract/"Accessors">
=item $obj-E<gt>B<domains>()
Inherited, see L<Log::Report::Extract/"Accessors">
=item $obj-E<gt>B<index>()
Inherited, see L<Log::Report::Extract/"Accessors">
=item $obj-E<gt>B<pots>($domain)
Inherited, see L<Log::Report::Extract/"Accessors">
=back
=head2 Processors
Extends L<"Processors" in Log::Report::Extract|Log::Report::Extract/"Processors">.
=over 4
=item $obj-E<gt>B<cleanup>(%options)
Inherited, see L<Log::Report::Extract/"Processors">
=item $obj-E<gt>B<process>($filename, %options)
Update the domains mentioned in the C<$filename>. All textdomains defined
in the file will get updated automatically, but not written before
all files where processed.
Improves base, see L<Log::Report::Extract/"Processors">
-Option --Default
charset 'iso-8859-1'
=over 2
=item charset => $charset
PPI v1.284 still does not support unicode by itself, so you need to help
it by specifying the character-set which is used in the file.
=back
=item $obj-E<gt>B<showStats>( [$domains] )
Inherited, see L<Log::Report::Extract/"Processors">
=item $obj-E<gt>B<store>( $domain, $filename, $linenr, $context, $msg, [$msg_plural] )
Inherited, see L<Log::Report::Extract/"Processors">
=item $obj-E<gt>B<write>( [$domain], %options )
Inherited, see L<Log::Report::Extract/"Processors">
=back
=head1 DIAGNOSTICS
=over 4
=item Fault: cannot create lexicon directory $dir: $!
Cast by C<new()>
=item Fault: cannot read perl from file $filename: $!
Cast by C<process()>
=item Error: count missing in $function in line $line
Cast by C<process()>
=item Error: extractions require an explicit lexicon directory
Cast by C<new()>
=item Info: no Perl in file $filename
Cast by C<process()>
=item Error: no context tags allowed in plural `$msgid'
Cast by C<store()>
=item Info: processing file $fn in $charset
Cast by C<process()>
=item Info: starting new textdomain $domain, template in $filename
Cast by C<write()>
=item Error: string is incorrect at line $line: $error
Cast by C<process()>
=item Warning: use double quotes not single, in $string on $file line $line
Cast by C<process()>
=back
=head1 SEE ALSO
This module is part of Log-Report-Lexicon version 1.15,
built on November 06, 2025. Website: F<http://perl.overmeer.net/CPAN/>
=head1 LICENSE
For contributors see file ChangeLog.
This software is copyright (c) 2007-2025 by Mark Overmeer.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
|
