ICU 75.1 75.1
|
#include <selfmt.h>
Public Member Functions | |
SelectFormat (const UnicodeString &pattern, UErrorCode &status) | |
Creates a new SelectFormat for a given pattern string. | |
SelectFormat (const SelectFormat &other) | |
copy constructor. | |
virtual | ~SelectFormat () |
Destructor. | |
void | applyPattern (const UnicodeString &pattern, UErrorCode &status) |
Sets the pattern used by this select format. | |
UnicodeString & | format (const UnicodeString &keyword, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const |
Selects the phrase for the given keyword. | |
SelectFormat & | operator= (const SelectFormat &other) |
Assignment operator. | |
virtual bool | operator== (const Format &other) const override |
Return true if another object is semantically equal to this one. | |
virtual bool | operator!= (const Format &other) const |
Return true if another object is semantically unequal to this one. | |
virtual SelectFormat * | clone () const override |
Clones this Format object polymorphically. | |
UnicodeString & | format (const Formattable &obj, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const override |
Format an object to produce a string. | |
UnicodeString & | toPattern (UnicodeString &appendTo) |
Returns the pattern from applyPattern() or constructor. | |
virtual void | parseObject (const UnicodeString &source, Formattable &result, ParsePosition &parse_pos) const override |
This method is not yet supported by SelectFormat . | |
virtual UClassID | getDynamicClassID () const override |
ICU "poor man's RTTI", returns a UClassID for the actual class. | |
UnicodeString & | format (const Formattable &obj, UnicodeString &appendTo, UErrorCode &status) const |
Formats an object to produce a string. | |
virtual UnicodeString & | format (const Formattable &obj, UnicodeString &appendTo, FieldPosition &pos, UErrorCode &status) const=0 |
Format an object to produce a string. | |
virtual UnicodeString & | format (const Formattable &obj, UnicodeString &appendTo, FieldPositionIterator *posIter, UErrorCode &status) const |
Format an object to produce a string. | |
Public Member Functions inherited from icu::Format | |
virtual | ~Format () |
Destructor. | |
bool | operator!= (const Format &other) const |
Return true if the given Format objects are not semantically equal. | |
UnicodeString & | format (const Formattable &obj, UnicodeString &appendTo, UErrorCode &status) const |
Formats an object to produce a string. | |
void | parseObject (const UnicodeString &source, Formattable &result, UErrorCode &status) const |
Parses a string to produce an object. | |
Locale | getLocale (ULocDataLocaleType type, UErrorCode &status) const |
Get the locale for this format object. | |
const char * | getLocaleID (ULocDataLocaleType type, UErrorCode &status) const |
Get the locale for this format object. | |
Public Member Functions inherited from icu::UObject | |
virtual | ~UObject () |
Destructor. | |
Static Public Member Functions | |
static UClassID | getStaticClassID () |
ICU "poor man's RTTI", returns a UClassID for this class. | |
Friends | |
class | MessageFormat |
Additional Inherited Members | |
Protected Member Functions inherited from icu::Format | |
void | setLocaleIDs (const char *valid, const char *actual) |
Format () | |
Default constructor for subclass use only. | |
Format (const Format &) | |
Format & | operator= (const Format &) |
Static Protected Member Functions inherited from icu::Format | |
static void | syntaxError (const UnicodeString &pattern, int32_t pos, UParseError &parseError) |
Simple function for initializing a UParseError from a UnicodeString. | |
SelectFormat
supports the creation of internationalized messages by selecting phrases based on keywords. The pattern specifies how to map keywords to phrases and provides a default phrase. The object provided to the format method is a string that's matched against the keywords. If there is a match, the corresponding phrase is selected; otherwise, the default phrase is used.
SelectFormat
for Gender AgreementNote: Typically, select formatting is done via MessageFormat
with a select
argument type, rather than using a stand-alone SelectFormat
.
The main use case for the select format is gender based inflection. When names or nouns are inserted into sentences, their gender can affect pronouns, verb forms, articles, and adjectives. Special care needs to be taken for the case where the gender cannot be determined. The impact varies between languages:
Some other languages have noun classes that are not related to gender, but similar in grammatical use. Some African languages have around 20 noun classes.
Note:For the gender of a person in a given sentence, we usually need to distinguish only between female, male and other/unknown.
To enable localizers to create sentence patterns that take their language's gender dependencies into consideration, software has to provide information about the gender associated with a noun or name to MessageFormat
. Two main cases can be distinguished:
For people, natural gender information should be maintained for each person. Keywords like "male", "female", "mixed" (for groups of people) and "unknown" could be used.
The resulting keyword is provided to MessageFormat
as a parameter separate from the name or noun it's associated with. For example, to generate a message such as "Jean went to Paris", three separate arguments would be provided: The name of the person as argument 0, the gender of the person as argument 1, and the name of the city as argument 2. The sentence pattern for English, where the gender of the person has no impact on this simple sentence, would not refer to argument 1 at all:
{0} went to {2}.
Note: The entire sentence should be included (and partially repeated) inside each phrase. Otherwise translators would have to be trained on how to move bits of the sentence in and out of the select argument of a message. (The examples below do not follow this recommendation!)
The sentence pattern for French, where the gender of the person affects the form of the participle, uses a select format based on argument 1:
{0} est {1, select, female {allée} other {allé}} à {2}.
Patterns can be nested, so that it's possible to handle interactions of number and gender where necessary. For example, if the above sentence should allow for the names of several people to be inserted, the following sentence pattern can be used (with argument 0 the list of people's names, argument 1 the number of people, argument 2 their combined gender, and argument 3 the city name):
{0} {1, plural, one {est {2, select, female {allée} other {allé}}} other {sont {2, select, female {allées} other {allés}}} }à {3}.
The SelectFormat
pattern string defines the phrase output for each user-defined keyword. The pattern is a sequence of (keyword, message) pairs. A keyword is a "pattern identifier": [^[[:Pattern_Syntax:][:Pattern_White_Space:]]]+
Each message is a MessageFormat pattern string enclosed in {curly braces}.
You always have to define a phrase for the default keyword other
; this phrase is returned when the keyword provided to the format
method matches no other keyword. If a pattern does not provide a phrase for other
, the method it's provided to returns the error U_DEFAULT_KEYWORD_MISSING
.
Pattern_White_Space between keywords and messages is ignored. Pattern_White_Space within a message is preserved and output.
Example: UErrorCode status = U_ZERO_ERROR; MessageFormat *msgFmt = new MessageFormat(UnicodeString("{0} est {1, select, female {allée} other {allé}} à Paris."), Locale("fr"), status); if (U_FAILURE(status)) { return; } FieldPosition ignore(FieldPosition::DONT_CARE); UnicodeString result; char* str1= "Kirti,female"; Formattable args1[] = {"Kirti","female"}; msgFmt->format(args1, 2, result, ignore, status); cout << "Input is " << str1 << " and result is: " << result << endl; delete msgFmt;
Produces the output:
Kirti est allée à Paris.
icu::SelectFormat::SelectFormat | ( | const UnicodeString & | pattern, |
UErrorCode & | status | ||
) |
Creates a new SelectFormat
for a given pattern string.
pattern | the pattern for this SelectFormat . errors are returned to status if the pattern is invalid. |
status | output param set to success/failure code on exit, which must not indicate a failure before the function call. |
icu::SelectFormat::SelectFormat | ( | const SelectFormat & | other | ) |
copy constructor.
void icu::SelectFormat::applyPattern | ( | const UnicodeString & | pattern, |
UErrorCode & | status | ||
) |
Sets the pattern used by this select format.
for the keyword rules. Patterns and their interpretation are specified in the class description.
pattern | the pattern for this select format errors are returned to status if the pattern is invalid. |
status | output param set to success/failure code on exit, which must not indicate a failure before the function call. |
|
overridevirtual |
Clones this Format object polymorphically.
The caller owns the result and should delete it when done.
Implements icu::Format.
|
overridevirtual |
Format an object to produce a string.
This method handles keyword strings. If the Formattable object is not a UnicodeString
, then it returns a failing UErrorCode.
obj | A keyword string that is used to select an alternative. |
appendTo | output parameter to receive result. Result is appended to existing contents. |
pos | On input: an alignment field, if desired. On output: the offsets of the alignment field. |
status | output param filled with success/failure status. |
Implements icu::Format.
|
virtual |
Format an object to produce a string.
This is a pure virtual method which subclasses must implement. This method allows polymorphic formatting of Formattable objects. If a subclass of Format receives a Formattable object type it doesn't handle (e.g., if a numeric Formattable is passed to a DateFormat object) then it returns a failing UErrorCode.
obj | The object to format. |
appendTo | Output parameter to receive result. Result is appended to existing contents. |
pos | On input: an alignment field, if desired. On output: the offsets of the alignment field. |
status | Output param filled with success/failure status. |
Implements icu::Format.
|
virtual |
Format an object to produce a string.
Subclasses should override this method. This method allows polymorphic formatting of Formattable objects. If a subclass of Format receives a Formattable object type it doesn't handle (e.g., if a numeric Formattable is passed to a DateFormat object) then it returns a failing UErrorCode.
obj | The object to format. |
appendTo | Output parameter to receive result. Result is appended to existing contents. |
posIter | On return, can be used to iterate over positions of fields generated by this format call. |
status | Output param filled with success/failure status. |
Reimplemented from icu::Format.
UnicodeString & icu::Format::format | ( | const Formattable & | obj, |
UnicodeString & | appendTo, | ||
UErrorCode & | status | ||
) | const |
Formats an object to produce a string.
obj | The object to format. |
appendTo | Output parameter to receive result. Result is appended to existing contents. |
status | Output parameter filled in with success or failure status. |
UnicodeString & icu::SelectFormat::format | ( | const UnicodeString & | keyword, |
UnicodeString & | appendTo, | ||
FieldPosition & | pos, | ||
UErrorCode & | status | ||
) | const |
Selects the phrase for the given keyword.
keyword | The keyword that is used to select an alternative. |
appendTo | output parameter to receive result. result is appended to existing contents. |
pos | On input: an alignment field, if desired. On output: the offsets of the alignment field. |
status | output param set to success/failure code on exit, which must not indicate a failure before the function call. |
ICU "poor man's RTTI", returns a UClassID for the actual class.
Reimplemented from icu::UObject.
ICU "poor man's RTTI", returns a UClassID for this class.
Return true if another object is semantically unequal to this one.
other | the SelectFormat object to be compared with. |
SelectFormat & icu::SelectFormat::operator= | ( | const SelectFormat & | other | ) |
Return true if another object is semantically equal to this one.
other | the SelectFormat object to be compared with. |
Implements icu::Format.
|
overridevirtual |
This method is not yet supported by SelectFormat
.
Before calling, set parse_pos.index to the offset you want to start parsing at in the source. After calling, parse_pos.index is the end of the text you parsed. If error occurs, index is unchanged.
When parsing, leading whitespace is discarded (with a successful parse), while trailing whitespace is left as is.
See Format::parseObject() for more.
source | The string to be parsed into an object. |
result | Formattable to be set to the parse result. If parse fails, return contents are undefined. |
parse_pos | The position to start parsing at. Upon return this param is set to the position after the last character successfully parsed. If the source is not parsed successfully, this param will remain unchanged. |
Implements icu::Format.
UnicodeString & icu::SelectFormat::toPattern | ( | UnicodeString & | appendTo | ) |
Returns the pattern from applyPattern() or constructor.
appendTo | output parameter to receive result. Result is appended to existing contents. |
|
friend |