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

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

Issue 10538033: MessageFormat fixup (Closed) Base URL: http://dart.googlecode.com/svn/branches/bleeding_edge/dart/
Patch Set: 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 * String that is used to determin the particular case and gender needed to be
42 * returned. The format of this string follows the same pattern as in Closure,
43 * Java, and C++. This pattern is described at the beginning of this class
44 * definition. See tests/message_format_test.dart for more examples.
45 */
46 final String _messageFunction;
47
48 /**
49 * String indicating a language code with which the message is to be
50 * formatted (such as en-US).
51 */
52 final String _locale;
53
54 /**
55 * Constructor. The constructor expects you do provide annotations in comments
56 * above your declaration of this constructor with an @desc describing the
57 * context for the useage of the function. You may also specify @ex to specify
58 * examples of inputs for each particular argument that the [_messageFunction]
59 * accepts. The String [_messageFunction] is used to determine the particular
60 * case and gender for the given instance. An optional [_locale] can be
61 * provided for specifics of the language locale to be used, otherwise, we
62 * will attempt to infer it (acceptable if Dart is running on the client, we
63 * can infer from the browser).
64 */
65 //TODO(efortuna): _locale is not currently inferred.
66 const MessageFormat(this._messageFunction, [this._locale = 'en-US']);
67
68 /**
69 * Formats a message. By default, we treat '#' with special meaning
70 * representing the number (plural_variable - plural_offset). If [ignorePound]
71 * is true, then we do not treat '#' as a special character, and it is just
72 * treated literally. [namedParameters] is a map of String keys to String or
73 * int values to influence the formatting of the message or data in the
74 * message. For example, example, in the call to
75 * msg_formatter.format({'NUM_PEOPLE': 5, 'NAME': 'Angela'}),
76 * object \{'NUM_PEOPLE': 5, 'NAME': 'Angela'\} holds positional parameters.
77 * 1st parameter could mean 5 people, which could influence plural format,
78 * and 2nd parameter is just relevant data to be printed out in the proper
79 * position in the message.
80 * Returns the correctly formatted message in the desired language.
81 */
82 String format(Map<String, dynamic> messageParameters,
83 [bool ignorePound=false]) {
84 // TODO(efortuna): actually perform the translation here. For now, I'm just
85 // returning a description of the message to be returned.
86 return _messageDescription;
87 }
88 }
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698