Locale::XGettext::Util::Keyword - A Keyword Used By xgettext
use Locale::XGettext::Util::Keyword;
$keyword = Locale::XGettext::Keyword->new('npcgettext',
'1c', 2, 3,
'"Plural form"');
$keyword = Locale::XGettext::Keyword->newFromString('npcgettext:1c,2,3,"Plural form"');
Flags are not yet supported.
The module encapsulates a keyword specification for xgettext like
string extractors. It is only interesting for authors of extractors based on
Locale::XGettext.
- new FUNCTION[, ARGSPEC
...]
- Creates a new keyword for FUNCTION FUNCTION. Without ARGSPEC
it is assumed that the singular form is the first argument.
ARGSPEC can be one of the following:
- N
- An integer N greater than 0. The first one encountered specifies
the position of the singular form, the second one the position of the
plural form.
- Nc
- An integer N greater than 0 followed by the character
"c". N specifies the position of the message context
argument.
- "COMMENT"
- Every PO entry for this keyword should get the automatic comment
COMMENT. Note that the surroudning "double quotes" are
required!
- newFromString
COMMAND_LINE_ARG
- COMMAND_LINE_ARG has the same semantcis as the argument to
"--keyword" of xgettext(1).
- function
- Get the function name of the keyword.
- singular
- Get the position of the argument for the singular form.
- plural
- Get the position of the argument for the plural form or 0 if there is no
plural form.
- context
- Get the position of the argument for the plural form or 0 if there is no
plural form.
- The automatic comment for this keyword or the undefined value.
- dump
- Dump the keyword definition into a string suitable for an argument to the
xgettext option '--keyword'.
Copyright (C) 2016-2017 Guido Flohr
<guido.flohr@cantanea.com>, all rights reserved.