Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(101)

Side by Side Diff: lib/i18n/message_format.dart

Issue 10453079: Added i18n skeleton API for message_formatting (Closed) Base URL: https://dart.googlecode.com/svn/branches/bleeding_edge/dart
Patch Set: Fixed typing of date_formatting Created 8 years, 6 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch | Annotate | Revision Log
OLDNEW
(Empty)
1 /**
2 * Copyright (c) 2012, the Dart project authors. Please see the AUTHORS file
3 * for details. All rights reserved. Use of this source code is governed by a
4 * BSD-style license that can be found in the LICENSE file.
5 *
6 * Message/plural format library with locale support.
7 *
8 * Message format grammar:
9 *
10 * messageFormatPattern := string ( "{" messageFormatElement "}" string )*
11 * messageFormatElement := argumentIndex [ "," elementFormat ]
12 * elementFormat := "plural" "," pluralStyle
13 * | "select" "," selectStyle
14 * pluralStyle := pluralFormatPattern
15 * selectStyle := selectFormatPattern
16 * pluralFormatPattern := \\[ "offset" ":" offsetIndex ] pluralForms*
17 * selectFormatPattern := pluralForms*
18 * pluralForms := stringKey "{" ( "{" messageFormatElement "}"|string )* "}"
19 *
20 *
21 * Message example:
22 *
23 * I see {NUM_PEOPLE, plural, offset:1
24 * =0 {no one at all}
25 * =1 {{WHO}}
26 * one {{WHO} and one other person}
27 * other {{WHO} and # other people}}
28 * in {PLACE}.
29 *
30 * Calling format({'NUM_PEOPLE': 2, 'WHO': 'Mark', 'PLACE': 'Athens'}) would
31 * produce "I see Mark and one other person in Athens." as output.
32 *
33 * See tests/message_format_test.dart for more examples.
34 */
35
36 #library('MessageFormat');
37
38 class MessageFormat {
39
40 /**
41 * Literal strings, including '', are replaced with \uFDDF_x_ for
42 * parsing purposes, and recovered during format phase.
43 * \uFDDF is a Unicode nonprinting character, not expected to be found in the
44 * typical message.
45 */
46 final String _LITERAL_PLACEHOLDER = '\uFDDF_';
47
48 /** String describing the use case for this message.*/
49 final String _messageDescription;
50
51 /**
52 * String that is used to determin the particular case and gender needed to be
53 * returned. The format of this string follows the same pattern as in Closure,
54 * Java, and C++. This pattern is described at the beginning of this class
55 * definition. See tests/message_format_test.dart for more examples.
56 */
57 final String _messageFunction;
58
59 /**
60 * Constructor. Accepts a String [_messageDescription] describing the use case
61 * for this string in the program, and a the String [_messageFunction] that is
62 * used to determine the particular case and gender for the given instance.
63 */
64 const MessageFormat(this._messageDescription, this._messageFunction);
65
66 /**
67 * Formats a message. By default, we treat '#' with special meaning
68 * representing the number (plural_variable - plural_offset). If [ignorePound]
69 * is true, then we do not treat '#' as a special character, and it is just
70 * treated literally. [namedParameters] is a map of String keys to String or
71 * int values to influence the formatting of the message or data in the
72 * message. For example, example, in the call to
73 * msg_formatter.format({'NUM_PEOPLE': 5, 'NAME': 'Angela'}),
74 * object \{'NUM_PEOPLE': 5, 'NAME': 'Angela'\} holds positional parameters.
75 * 1st parameter could mean 5 people, which could influence plural format,
76 * and 2nd parameter is just relevant data to be printed out in the proper
77 * position in the message.
78 * Returns the correctly formatted message in the desired language.
79 */
80 String format(Map<String, dynamic> messageParameters,
81 [bool ignorePound=false]) {
82 // TODO(efortuna): actually perform the translation here. For now, I'm just
83 // returning a description of the message to be returned.
84 return _messageDescription;
85 }
86 }
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698