| OLD | NEW |
| 1 // Copyright (c) 2012, the Dart project authors. Please see the AUTHORS file | 1 // Copyright (c) 2012, the Dart project authors. Please see the AUTHORS file |
| 2 // for details. All rights reserved. Use of this source code is governed by a | 2 // for details. All rights reserved. Use of this source code is governed by a |
| 3 // BSD-style license that can be found in the LICENSE file. | 3 // BSD-style license that can be found in the LICENSE file. |
| 4 | 4 |
| 5 /** | 5 /** |
| 6 * Bidi stands for Bi-directional text. | 6 * Bidi stands for Bi-directional text. |
| 7 * According to http://en.wikipedia.org/wiki/Bi-directional_text: | 7 * According to http://en.wikipedia.org/wiki/Bi-directional_text: |
| 8 * Bi-directional text is text containing text in both text directionalities, | 8 * Bi-directional text is text containing text in both text directionalities, |
| 9 * both right-to-left (RTL) and left-to-right (LTR). It generally involves text | 9 * both right-to-left (RTL) and left-to-right (LTR). It generally involves text |
| 10 * containing different types of alphabets, but may also refer to boustrophedon, | 10 * containing different types of alphabets, but may also refer to boustrophedon, |
| (...skipping 30 matching lines...) Expand all Loading... |
| 41 | 41 |
| 42 /** | 42 /** |
| 43 * Returns true if [otherDirection] is known to be different from this | 43 * Returns true if [otherDirection] is known to be different from this |
| 44 * direction. | 44 * direction. |
| 45 */ | 45 */ |
| 46 bool isDirectionChange(TextDirection otherDirection) { | 46 bool isDirectionChange(TextDirection otherDirection) { |
| 47 return otherDirection != TextDirection.UNKNOWN && this != otherDirection; | 47 return otherDirection != TextDirection.UNKNOWN && this != otherDirection; |
| 48 } | 48 } |
| 49 } | 49 } |
| 50 | 50 |
| 51 class BidiUtils { | 51 /** Unicode "Left-To-Right Embedding" (LRE) character. */ |
| 52 /** Unicode "Left-To-Right Embedding" (LRE) character. */ | 52 final LRE = '\u202A'; |
| 53 static final LRE = '\u202A'; | 53 |
| 54 | 54 /** Unicode "Right-To-Left Embedding" (RLE) character. */ |
| 55 /** Unicode "Right-To-Left Embedding" (RLE) character. */ | 55 final RLE = '\u202B'; |
| 56 static final RLE = '\u202B'; | 56 |
| 57 | 57 /** Unicode "Pop Directional Formatting" (PDF) character. */ |
| 58 /** Unicode "Pop Directional Formatting" (PDF) character. */ | 58 final PDF = '\u202C'; |
| 59 static final PDF = '\u202C'; | 59 |
| 60 | 60 /** Unicode "Left-To-Right Mark" (LRM) character. */ |
| 61 /** Unicode "Left-To-Right Mark" (LRM) character. */ | 61 final LRM = '\u200E'; |
| 62 static final LRM = '\u200E'; | 62 |
| 63 | 63 /** Unicode "Right-To-Left Mark" (RLM) character. */ |
| 64 /** Unicode "Right-To-Left Mark" (RLM) character. */ | 64 final RLM = '\u200F'; |
| 65 static final RLM = '\u200F'; | 65 |
| 66 | 66 /** Constant to define the threshold of RTL directionality. */ |
| 67 /** Constant to define the threshold of RTL directionality. */ | 67 num _RTL_DETECTION_THRESHOLD = 0.40; |
| 68 static num _RTL_DETECTION_THRESHOLD = 0.40; | 68 |
| 69 | 69 /** |
| 70 /** | 70 * Practical patterns to identify strong LTR and RTL characters, respectively. |
| 71 * Practical patterns to identify strong LTR and RTL characters, respectively. | 71 * These patterns are not completely correct according to the Unicode |
| 72 * These patterns are not completely correct according to the Unicode | 72 * standard. They are simplified for performance and small code size. |
| 73 * standard. They are simplified for performance and small code size. | 73 */ |
| 74 */ | 74 final String _LTR_CHARS = |
| 75 static final String _LTR_CHARS = | 75 @'A-Za-z\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u02B8\u0300-\u0590' |
| 76 @'A-Za-z\u00C0-\u00D6\u00D8-\u00F6\u00F8-\u02B8\u0300-\u0590' | 76 @'\u0800-\u1FFF\u2C00-\uFB1C\uFDFE-\uFE6F\uFEFD-\uFFFF'; |
| 77 @'\u0800-\u1FFF\u2C00-\uFB1C\uFDFE-\uFE6F\uFEFD-\uFFFF'; | 77 final String _RTL_CHARS = @'\u0591-\u07FF\uFB1D-\uFDFD\uFE70-\uFEFC'; |
| 78 static final String _RTL_CHARS = @'\u0591-\u07FF\uFB1D-\uFDFD\uFE70-\uFEFC'; | 78 |
| 79 | 79 /** |
| 80 /** | 80 * Returns the input [text] with spaces instead of HTML tags or HTML escapes, |
| 81 * Returns the input [text] with spaces instead of HTML tags or HTML escapes, | 81 * which is helpful for text directionality estimation. |
| 82 * which is helpful for text directionality estimation. | 82 * Note: This function should not be used in other contexts. |
| 83 * Note: This function should not be used in other contexts. | 83 * It does not deal well with many things: comments, script, |
| 84 * It does not deal well with many things: comments, script, | 84 * elements, style elements, dir attribute,`>` in quoted attribute values, |
| 85 * elements, style elements, dir attribute,`>` in quoted attribute values, | 85 * etc. But it does handle well enough the most common use cases. |
| 86 * etc. But it does handle well enough the most common use cases. | 86 * Since the worst that can happen as a result of these shortcomings is that |
| 87 * Since the worst that can happen as a result of these shortcomings is that | 87 * the wrong directionality will be estimated, we have not invested in |
| 88 * the wrong directionality will be estimated, we have not invested in | 88 * improving this. |
| 89 * improving this. | 89 */ |
| 90 */ | 90 String stripHtmlIfNeeded(String text) { |
| 91 static String stripHtmlIfNeeded(String text) { | 91 // The regular expression is simplified for an HTML tag (opening or |
| 92 // The regular expression is simplified for an HTML tag (opening or | 92 // closing) or an HTML escape. We might want to skip over such expressions |
| 93 // closing) or an HTML escape. We might want to skip over such expressions | 93 // when estimating the text directionality. |
| 94 // when estimating the text directionality. | 94 return text.replaceAll(const RegExp(@'<[^>]*>|&[^;]+;'), ' '); |
| 95 return text.replaceAll(const RegExp(@'<[^>]*>|&[^;]+;'), ' '); | 95 } |
| 96 } | 96 |
| 97 | 97 /** |
| 98 /** | 98 * Determines if the first character in [text] with strong directionality is |
| 99 * Determines if the first character in [text] with strong directionality is | 99 * LTR. If [isHtml] is true, the text is HTML or HTML-escaped. |
| 100 * LTR. If [isHtml] is true, the text is HTML or HTML-escaped. | 100 */ |
| 101 */ | 101 bool startsWithLtr(String text, [isHtml=false]) { |
| 102 static bool startsWithLtr(String text, [isHtml=false]) { | 102 return const RegExp('^[^$_RTL_CHARS]*[$_LTR_CHARS]').hasMatch( |
| 103 return const RegExp('^[^$_RTL_CHARS]*[$_LTR_CHARS]').hasMatch( | 103 isHtml? stripHtmlIfNeeded(text) : text); |
| 104 isHtml? stripHtmlIfNeeded(text) : text); | 104 } |
| 105 } | 105 |
| 106 | 106 /** |
| 107 /** | 107 * Determines if the first character in [text] with strong directionality is |
| 108 * Determines if the first character in [text] with strong directionality is | 108 * RTL. If [isHtml] is true, the text is HTML or HTML-escaped. |
| 109 * RTL. If [isHtml] is true, the text is HTML or HTML-escaped. | 109 */ |
| 110 */ | 110 bool startsWithRtl(String text, [isHtml=false]) { |
| 111 static bool startsWithRtl(String text, [isHtml=false]) { | 111 return const RegExp('^[^$_LTR_CHARS]*[$_RTL_CHARS]').hasMatch( |
| 112 return const RegExp('^[^$_LTR_CHARS]*[$_RTL_CHARS]').hasMatch( | 112 isHtml? stripHtmlIfNeeded(text) : text); |
| 113 isHtml? stripHtmlIfNeeded(text) : text); | 113 } |
| 114 } | 114 |
| 115 | 115 /** |
| 116 /** | 116 * Determines if the exit directionality (ie, the last strongly-directional |
| 117 * Determines if the exit directionality (ie, the last strongly-directional | 117 * character in [text] is LTR. If [isHtml] is true, the text is HTML or |
| 118 * character in [text] is LTR. If [isHtml] is true, the text is HTML or | 118 * HTML-escaped. |
| 119 * HTML-escaped. | 119 */ |
| 120 */ | 120 bool endsWithLtr(String text, [isHtml=false]) { |
| 121 static bool endsWithLtr(String text, [isHtml=false]) { | 121 return const RegExp('[$_LTR_CHARS][^$_RTL_CHARS]*\$').hasMatch( |
| 122 return const RegExp('[$_LTR_CHARS][^$_RTL_CHARS]*\$').hasMatch( | 122 isHtml? stripHtmlIfNeeded(text) : text); |
| 123 isHtml? stripHtmlIfNeeded(text) : text); | 123 } |
| 124 } | 124 |
| 125 | 125 /** |
| 126 /** | 126 * Determines if the exit directionality (ie, the last strongly-directional |
| 127 * Determines if the exit directionality (ie, the last strongly-directional | 127 * character in [text] is RTL. If [isHtml] is true, the text is HTML or |
| 128 * character in [text] is RTL. If [isHtml] is true, the text is HTML or | 128 * HTML-escaped. |
| 129 * HTML-escaped. | 129 */ |
| 130 */ | 130 bool endsWithRtl(String text, [isHtml=false]) { |
| 131 static bool endsWithRtl(String text, [isHtml=false]) { | 131 return const RegExp('[$_RTL_CHARS][^$_LTR_CHARS]*\$').hasMatch( |
| 132 return const RegExp('[$_RTL_CHARS][^$_LTR_CHARS]*\$').hasMatch( | 132 isHtml? stripHtmlIfNeeded(text) : text); |
| 133 isHtml? stripHtmlIfNeeded(text) : text); | 133 } |
| 134 } | 134 |
| 135 | 135 /** |
| 136 /** | 136 * Determines if the given [text] has any LTR characters in it. |
| 137 * Determines if the given [text] has any LTR characters in it. | 137 * If [isHtml] is true, the text is HTML or HTML-escaped. |
| 138 * If [isHtml] is true, the text is HTML or HTML-escaped. | 138 */ |
| 139 */ | 139 bool hasAnyLtr(String text, [isHtml=false]) { |
| 140 static bool hasAnyLtr(String text, [isHtml=false]) { | 140 return const RegExp(@'[' '$_LTR_CHARS' @']').hasMatch( |
| 141 return const RegExp(@'[' '$_LTR_CHARS' @']').hasMatch( | 141 isHtml? stripHtmlIfNeeded(text) : text); |
| 142 isHtml? stripHtmlIfNeeded(text) : text); | 142 } |
| 143 } | 143 |
| 144 | 144 /** |
| 145 /** | 145 * Determines if the given [text] has any RTL characters in it. |
| 146 * Determines if the given [text] has any RTL characters in it. | 146 * If [isHtml] is true, the text is HTML or HTML-escaped. |
| 147 * If [isHtml] is true, the text is HTML or HTML-escaped. | 147 */ |
| 148 */ | 148 bool hasAnyRtl(String text, [isHtml=false]) { |
| 149 static bool hasAnyRtl(String text, [isHtml=false]) { | 149 return const RegExp(@'[' '$_RTL_CHARS' @']').hasMatch( |
| 150 return const RegExp(@'[' '$_RTL_CHARS' @']').hasMatch( | 150 isHtml? stripHtmlIfNeeded(text) : text); |
| 151 isHtml? stripHtmlIfNeeded(text) : text); | 151 } |
| 152 } | 152 |
| 153 | 153 /** |
| 154 /** | 154 * Check if a BCP 47 / III [languageString] indicates an RTL language. |
| 155 * Check if a BCP 47 / III [languageString] indicates an RTL language. | 155 * |
| 156 * | 156 * i.e. either: |
| 157 * i.e. either: | 157 * - a language code explicitly specifying one of the right-to-left scripts, |
| 158 * - a language code explicitly specifying one of the right-to-left scripts, | 158 * e.g. "az-Arab", or |
| 159 * e.g. "az-Arab", or | 159 * - a language code specifying one of the languages normally written in a |
| 160 * - a language code specifying one of the languages normally written in a | 160 * right-to-left script, e.g. "fa" (Farsi), except ones explicitly |
| 161 * right-to-left script, e.g. "fa" (Farsi), except ones explicitly | 161 * specifying Latin or Cyrillic script (which are the usual LTR |
| 162 * specifying Latin or Cyrillic script (which are the usual LTR | 162 * alternatives). |
| 163 * alternatives). | 163 * |
| 164 * | 164 * The list of right-to-left scripts appears in the 100-199 range in |
| 165 * The list of right-to-left scripts appears in the 100-199 range in | 165 * http://www.unicode.org/iso15924/iso15924-num.html, of which Arabic and |
| 166 * http://www.unicode.org/iso15924/iso15924-num.html, of which Arabic and | 166 * Hebrew are by far the most widely used. We also recognize Thaana, N'Ko, and |
| 167 * Hebrew are by far the most widely used. We also recognize Thaana, N'Ko, and | 167 * Tifinagh, which also have significant modern usage. The rest (Syriac, |
| 168 * Tifinagh, which also have significant modern usage. The rest (Syriac, | 168 * Samaritan, Mandaic, etc.) seem to have extremely limited or no modern usage |
| 169 * Samaritan, Mandaic, etc.) seem to have extremely limited or no modern usage | 169 * and are not recognized. |
| 170 * and are not recognized. | 170 * The languages usually written in a right-to-left script are taken as those |
| 171 * The languages usually written in a right-to-left script are taken as those | 171 * with Suppress-Script: Hebr|Arab|Thaa|Nkoo|Tfng in |
| 172 * with Suppress-Script: Hebr|Arab|Thaa|Nkoo|Tfng in | 172 * http://www.iana.org/assignments/language-subtag-registry, |
| 173 * http://www.iana.org/assignments/language-subtag-registry, | 173 * as well as Sindhi (sd) and Uyghur (ug). |
| 174 * as well as Sindhi (sd) and Uyghur (ug). | 174 * The presence of other subtags of the language code, e.g. regions like EG |
| 175 * The presence of other subtags of the language code, e.g. regions like EG | 175 * (Egypt), is ignored. |
| 176 * (Egypt), is ignored. | 176 */ |
| 177 */ | 177 bool isRtlLanguage(String languageString) { |
| 178 static bool isRtlLanguage(String languageString) { | 178 return const RegExp(@'^(ar|dv|he|iw|fa|nqo|ps|sd|ug|ur|yi|.*[-_]' |
| 179 return const RegExp(@'^(ar|dv|he|iw|fa|nqo|ps|sd|ug|ur|yi|.*[-_]' | 179 @'(Arab|Hebr|Thaa|Nkoo|Tfng))(?!.*[-_](Latn|Cyrl)($|-|_))' |
| 180 @'(Arab|Hebr|Thaa|Nkoo|Tfng))(?!.*[-_](Latn|Cyrl)($|-|_))' | 180 @'($|-|_)', ignoreCase : true).hasMatch(languageString); |
| 181 @'($|-|_)', ignoreCase : true).hasMatch(languageString); | 181 } |
| 182 } | 182 |
| 183 | 183 /** |
| 184 /** | 184 * Enforce the [html] snippet in RTL directionality regardless of overall |
| 185 * Enforce the [html] snippet in RTL directionality regardless of overall | 185 * context. If the html piece was enclosed by a tag, the direction will be |
| 186 * context. If the html piece was enclosed by a tag, the direction will be | 186 * applied to existing tag, otherwise a span tag will be added as wrapper. |
| 187 * applied to existing tag, otherwise a span tag will be added as wrapper. | 187 * For this reason, if html snippet start with with tag, this tag must enclose |
| 188 * For this reason, if html snippet start with with tag, this tag must enclose | 188 * the whole piece. If the tag already has a direction specified, this new one |
| 189 * the whole piece. If the tag already has a direction specified, this new one | 189 * will override existing one in behavior (should work on Chrome, FF, and IE |
| 190 * will override existing one in behavior (should work on Chrome, FF, and IE | 190 * since this was ported directly from the Closure version). |
| 191 * since this was ported directly from the Closure version). | 191 */ |
| 192 */ | 192 String enforceRtlInHtml(String html) { |
| 193 static String enforceRtlInHtml(String html) { | 193 return _enforceInHtmlHelper(html, 'rtl'); |
| 194 return _enforceInHtmlHelper(html, 'rtl'); | 194 } |
| 195 } | 195 |
| 196 | 196 /** |
| 197 /** | 197 * Enforce RTL on both end of the given [text] using unicode BiDi formatting |
| 198 * Enforce RTL on both end of the given [text] using unicode BiDi formatting | 198 * characters RLE and PDF. |
| 199 * characters RLE and PDF. | 199 */ |
| 200 */ | 200 String enforceRtlInText(String text) { |
| 201 static String enforceRtlInText(String text) { | 201 return '$RLE$text$PDF'; |
| 202 return '$RLE$text$PDF'; | 202 } |
| 203 } | 203 |
| 204 | 204 /** |
| 205 /** | 205 * Enforce the [html] snippet in LTR directionality regardless of overall |
| 206 * Enforce the [html] snippet in LTR directionality regardless of overall | 206 * context. If the html piece was enclosed by a tag, the direction will be |
| 207 * context. If the html piece was enclosed by a tag, the direction will be | 207 * applied to existing tag, otherwise a span tag will be added as wrapper. |
| 208 * applied to existing tag, otherwise a span tag will be added as wrapper. | 208 * For this reason, if html snippet start with with tag, this tag must enclose |
| 209 * For this reason, if html snippet start with with tag, this tag must enclose | 209 * the whole piece. If the tag already has a direction specified, this new one |
| 210 * the whole piece. If the tag already has a direction specified, this new one | 210 * will override existing one in behavior (tested on FF and IE). |
| 211 * will override existing one in behavior (tested on FF and IE). | 211 */ |
| 212 */ | 212 String enforceLtrInHtml(String html) { |
| 213 static String enforceLtrInHtml(String html) { | 213 return _enforceInHtmlHelper(html, 'ltr'); |
| 214 return _enforceInHtmlHelper(html, 'ltr'); | 214 } |
| 215 } | 215 |
| 216 | 216 /** |
| 217 /** | 217 * Enforce LTR on both end of the given [text] using unicode BiDi formatting |
| 218 * Enforce LTR on both end of the given [text] using unicode BiDi formatting | 218 * characters LRE and PDF. |
| 219 * characters LRE and PDF. | 219 */ |
| 220 */ | 220 String enforceLtrInText(String text) { |
| 221 static String enforceLtrInText(String text) { | 221 return '$LRE$text$PDF'; |
| 222 return '$LRE$text$PDF'; | 222 } |
| 223 } | 223 |
| 224 | 224 /** |
| 225 /** | 225 * Enforce the [html] snippet in the desired [direction] regardless of overall |
| 226 * Enforce the [html] snippet in the desired [direction] regardless of overall | 226 * context. If the html piece was enclosed by a tag, the direction will be |
| 227 * context. If the html piece was enclosed by a tag, the direction will be | 227 * applied to existing tag, otherwise a span tag will be added as wrapper. |
| 228 * applied to existing tag, otherwise a span tag will be added as wrapper. | 228 * For this reason, if html snippet start with with tag, this tag must enclose |
| 229 * For this reason, if html snippet start with with tag, this tag must enclose | 229 * the whole piece. If the tag already has a direction specified, this new one |
| 230 * the whole piece. If the tag already has a direction specified, this new one | 230 * will override existing one in behavior (tested on FF and IE). |
| 231 * will override existing one in behavior (tested on FF and IE). | 231 */ |
| 232 */ | 232 String _enforceInHtmlHelper(String html, String direction) { |
| 233 static String _enforceInHtmlHelper(String html, String direction) { | 233 if (html.startsWith('<')) { |
| 234 if (html.startsWith('<')) { | |
| 235 StringBuffer buffer = new StringBuffer(); | |
| 236 var startIndex = 0; | |
| 237 Match match = const RegExp('<\\w+').firstMatch(html); | |
| 238 if (match != null) { | |
| 239 buffer.add(html.substring( | |
| 240 startIndex, match.end())).add(' dir=$direction'); | |
| 241 startIndex = match.end(); | |
| 242 } | |
| 243 return buffer.add(html.substring(startIndex)).toString(); | |
| 244 } | |
| 245 // '\n' is important for FF so that it won't incorrectly merge span groups. | |
| 246 return '\n<span dir=$direction>$html</span>'; | |
| 247 } | |
| 248 | |
| 249 /** | |
| 250 * Apply bracket guard to [str] using html span tag. This is to address the | |
| 251 * problem of messy bracket display that frequently happens in RTL layout. | |
| 252 * If [isRtlContext] is true, then we explicitly want to wrap in a span of RTL | |
| 253 * directionality, regardless of the estimated directionality. | |
| 254 */ | |
| 255 static String guardBracketInHtml(String str, [bool isRtlContext]) { | |
| 256 var useRtl = isRtlContext == null ? hasAnyRtl(str) : isRtlContext; | |
| 257 RegExp matchingBrackets = | |
| 258 const RegExp(@'(\(.*?\)+)|(\[.*?\]+)|(\{.*?\}+)|(<.*?(>)+)'); | |
| 259 return _guardBracketHelper(str, matchingBrackets, | |
| 260 '<span dir=${useRtl? "rtl" : "ltr"}>', '</span>'); | |
| 261 } | |
| 262 | |
| 263 /** | |
| 264 * Apply bracket guard to [str] using LRM and RLM. This is to address the | |
| 265 * problem of messy bracket display that frequently happens in RTL layout. | |
| 266 * This version works for both plain text and html, but in some cases is not | |
| 267 * as good as guardBracketInHtml. | |
| 268 * If [isRtlContext] is true, then we explicitly want to wrap in a span of RTL | |
| 269 * directionality, regardless of the estimated directionality. | |
| 270 */ | |
| 271 static String guardBracketInText(String str, [bool isRtlContext]) { | |
| 272 var useRtl = isRtlContext == null ? hasAnyRtl(str) : isRtlContext; | |
| 273 var mark = useRtl ? RLM : LRM; | |
| 274 return _guardBracketHelper(str, | |
| 275 const RegExp(@'(\(.*?\)+)|(\[.*?\]+)|(\{.*?\}+)|(<.*?>+)'), mark, mark); | |
| 276 } | |
| 277 | |
| 278 /** | |
| 279 * (Mostly) reimplements the $& functionality of "replace" in JavaScript. | |
| 280 * Given a [str] and the [regexp] to match with, optionally supply a string to | |
| 281 * be inserted [before] the match and/or [after]. For example, | |
| 282 * `_guardBracketHelper('firetruck', const RegExp('truck'), 'hydrant', '!')` | |
| 283 * would return 'firehydrant!'. | |
| 284 */ | |
| 285 // TODO(efortuna): Get rid of this once this is implemented in Dart. | |
| 286 // See Issue 2979. | |
| 287 static String _guardBracketHelper(String str, RegExp regexp, [String before, | |
| 288 String after]) { | |
| 289 StringBuffer buffer = new StringBuffer(); | 234 StringBuffer buffer = new StringBuffer(); |
| 290 var startIndex = 0; | 235 var startIndex = 0; |
| 291 Iterable matches = regexp.allMatches(str); | 236 Match match = const RegExp('<\\w+').firstMatch(html); |
| 292 for (Match match in matches) { | 237 if (match != null) { |
| 293 buffer.add(str.substring(startIndex, match.start())).add(before); | 238 buffer.add(html.substring( |
| 294 buffer.add(str.substring(match.start(), match.end())).add(after); | 239 startIndex, match.end())).add(' dir=$direction'); |
| 295 startIndex = match.end(); | 240 startIndex = match.end(); |
| 296 } | 241 } |
| 297 return buffer.add(str.substring(startIndex)).toString(); | 242 return buffer.add(html.substring(startIndex)).toString(); |
| 298 } | 243 } |
| 299 | 244 // '\n' is important for FF so that it won't incorrectly merge span groups. |
| 300 /** | 245 return '\n<span dir=$direction>$html</span>'; |
| 301 * Estimates the directionality of [text] using the best known | 246 } |
| 302 * general-purpose method (using relative word counts). A | 247 |
| 303 * TextDirection.UNKNOWN return value indicates completely neutral input. | 248 /** |
| 304 * [isHtml] is true if [text] HTML or HTML-escaped. | 249 * Apply bracket guard to [str] using html span tag. This is to address the |
| 305 * | 250 * problem of messy bracket display that frequently happens in RTL layout. |
| 306 * If the number of RTL words is above a certain percentage of the total | 251 * If [isRtlContext] is true, then we explicitly want to wrap in a span of RTL |
| 307 * number of strongly directional words, returns RTL. | 252 * directionality, regardless of the estimated directionality. |
| 308 * Otherwise, if any words are strongly or weakly LTR, returns LTR. | 253 */ |
| 309 * Otherwise, returns UNKNOWN, which is used to mean `neutral`. | 254 String guardBracketInHtml(String str, [bool isRtlContext]) { |
| 310 * Numbers and URLs are counted as weakly LTR. | 255 var useRtl = isRtlContext == null ? hasAnyRtl(str) : isRtlContext; |
| 311 */ | 256 RegExp matchingBrackets = |
| 312 static TextDirection estimateDirection(String text, [bool isHtml=false]) { | 257 const RegExp(@'(\(.*?\)+)|(\[.*?\]+)|(\{.*?\}+)|(<.*?(>)+)'); |
| 313 text = isHtml? stripHtmlIfNeeded(text) : text; | 258 return _guardBracketHelper(str, matchingBrackets, |
| 314 var rtlCount = 0; | 259 '<span dir=${useRtl? "rtl" : "ltr"}>', '</span>'); |
| 315 var total = 0; | 260 } |
| 316 var hasWeaklyLtr = false; | 261 |
| 317 // Split a string into 'words' for directionality estimation based on | 262 /** |
| 318 // relative word counts. | 263 * Apply bracket guard to [str] using LRM and RLM. This is to address the |
| 319 for (String token in text.split(const RegExp(@'\s+'))) { | 264 * problem of messy bracket display that frequently happens in RTL layout. |
| 320 if (BidiUtils.startsWithRtl(token)) { | 265 * This version works for both plain text and html, but in some cases is not |
| 321 rtlCount++; | 266 * as good as guardBracketInHtml. |
| 322 total++; | 267 * If [isRtlContext] is true, then we explicitly want to wrap in a span of RTL |
| 323 } else if (const RegExp(@'^http://').hasMatch(token)) { | 268 * directionality, regardless of the estimated directionality. |
| 324 // Checked if token looks like something that must always be LTR even in | 269 */ |
| 325 // RTL text, such as a URL. | 270 String guardBracketInText(String str, [bool isRtlContext]) { |
| 326 hasWeaklyLtr = true; | 271 var useRtl = isRtlContext == null ? hasAnyRtl(str) : isRtlContext; |
| 327 } else if (BidiUtils.hasAnyLtr(token)) { | 272 var mark = useRtl ? RLM : LRM; |
| 328 total++; | 273 return _guardBracketHelper(str, |
| 329 } else if (const RegExp(@'\d').hasMatch(token)) { | 274 const RegExp(@'(\(.*?\)+)|(\[.*?\]+)|(\{.*?\}+)|(<.*?>+)'), mark, mark); |
| 330 // Checked if token contains any numerals. | 275 } |
| 331 hasWeaklyLtr = true; | 276 |
| 332 } | 277 /** |
| 278 * (Mostly) reimplements the $& functionality of "replace" in JavaScript. |
| 279 * Given a [str] and the [regexp] to match with, optionally supply a string to |
| 280 * be inserted [before] the match and/or [after]. For example, |
| 281 * `_guardBracketHelper('firetruck', const RegExp('truck'), 'hydrant', '!')` |
| 282 * would return 'firehydrant!'. |
| 283 */ |
| 284 // TODO(efortuna): Get rid of this once this is implemented in Dart. |
| 285 // See Issue 2979. |
| 286 String _guardBracketHelper(String str, RegExp regexp, [String before, |
| 287 String after]) { |
| 288 StringBuffer buffer = new StringBuffer(); |
| 289 var startIndex = 0; |
| 290 Iterable matches = regexp.allMatches(str); |
| 291 for (Match match in matches) { |
| 292 buffer.add(str.substring(startIndex, match.start())).add(before); |
| 293 buffer.add(str.substring(match.start(), match.end())).add(after); |
| 294 startIndex = match.end(); |
| 295 } |
| 296 return buffer.add(str.substring(startIndex)).toString(); |
| 297 } |
| 298 |
| 299 /** |
| 300 * Estimates the directionality of [text] using the best known |
| 301 * general-purpose method (using relative word counts). A |
| 302 * TextDirection.UNKNOWN return value indicates completely neutral input. |
| 303 * [isHtml] is true if [text] HTML or HTML-escaped. |
| 304 * |
| 305 * If the number of RTL words is above a certain percentage of the total |
| 306 * number of strongly directional words, returns RTL. |
| 307 * Otherwise, if any words are strongly or weakly LTR, returns LTR. |
| 308 * Otherwise, returns UNKNOWN, which is used to mean `neutral`. |
| 309 * Numbers and URLs are counted as weakly LTR. |
| 310 */ |
| 311 TextDirection estimateDirectionOfText(String text, [bool isHtml=false]) { |
| 312 text = isHtml? stripHtmlIfNeeded(text) : text; |
| 313 var rtlCount = 0; |
| 314 var total = 0; |
| 315 var hasWeaklyLtr = false; |
| 316 // Split a string into 'words' for directionality estimation based on |
| 317 // relative word counts. |
| 318 for (String token in text.split(const RegExp(@'\s+'))) { |
| 319 if (startsWithRtl(token)) { |
| 320 rtlCount++; |
| 321 total++; |
| 322 } else if (const RegExp(@'^http://').hasMatch(token)) { |
| 323 // Checked if token looks like something that must always be LTR even in |
| 324 // RTL text, such as a URL. |
| 325 hasWeaklyLtr = true; |
| 326 } else if (hasAnyLtr(token)) { |
| 327 total++; |
| 328 } else if (const RegExp(@'\d').hasMatch(token)) { |
| 329 // Checked if token contains any numerals. |
| 330 hasWeaklyLtr = true; |
| 333 } | 331 } |
| 334 | 332 } |
| 335 if (total == 0) { | 333 |
| 336 return hasWeaklyLtr ? TextDirection.LTR : TextDirection.UNKNOWN; | 334 if (total == 0) { |
| 337 } else if (rtlCount > BidiUtils._RTL_DETECTION_THRESHOLD * total) { | 335 return hasWeaklyLtr ? TextDirection.LTR : TextDirection.UNKNOWN; |
| 338 return TextDirection.RTL; | 336 } else if (rtlCount > _RTL_DETECTION_THRESHOLD * total) { |
| 337 return TextDirection.RTL; |
| 338 } else { |
| 339 return TextDirection.LTR; |
| 340 } |
| 341 } |
| 342 |
| 343 /** |
| 344 * Find the first index in [str] of the first closing parenthesis that does |
| 345 * not match an opening parenthesis. |
| 346 */ |
| 347 int _unmatchedParenIndex(String str) { |
| 348 int sum = 0; |
| 349 int index = 0; |
| 350 while (sum >= 0 || index > str.length) { |
| 351 int char = str.charCodeAt(index); |
| 352 if (char == '('.charCodeAt(0)) sum++; |
| 353 else if (char == ')'.charCodeAt(0)) sum--; |
| 354 index++; |
| 355 } |
| 356 return index; |
| 357 } |
| 358 |
| 359 /** |
| 360 * Replace the double and single quote directly after a Hebrew character in |
| 361 * [str] with GERESH and GERSHAYIM. This is most likely the user's intention. |
| 362 */ |
| 363 String normalizeHebrewQuote(String str) { |
| 364 StringBuffer buf = new StringBuffer(); |
| 365 if (str.length > 0) { |
| 366 buf.add(str.substring(0, 1)); |
| 367 } |
| 368 // Start at 1 because we're looking for the patterns [\u0591-\u05f2])" or |
| 369 // [\u0591-\u05f2]'. |
| 370 for (int i = 1; i < str.length; i++) { |
| 371 if (str.substring(i, i+1) == '"' |
| 372 && const RegExp('[\u0591-\u05f2]').hasMatch(str.substring(i-1, i))) { |
| 373 buf.add('\u05f4'); |
| 374 } else if (str.substring(i, i+1) == "'" |
| 375 && const RegExp('[\u0591-\u05f2]').hasMatch(str.substring(i-1, i))) { |
| 376 buf.add('\u05f3'); |
| 339 } else { | 377 } else { |
| 340 return TextDirection.LTR; | 378 buf.add(str.substring(i, i+1)); |
| 341 } | 379 } |
| 342 } | 380 } |
| 343 | 381 return buf.toString(); |
| 344 /** | 382 } |
| 345 * Find the first index in [str] of the first closing parenthesis that does | 383 |
| 346 * not match an opening parenthesis. | 384 /** |
| 347 */ | 385 * Check the estimated directionality of [str], return true if the piece of |
| 348 static int _unmatchedParenIndex(String str) { | 386 * text should be laid out in RTL direction. If [isHtml] is true, the string |
| 349 int sum = 0; | 387 * is HTML or HTML-escaped. |
| 350 int index = 0; | 388 */ |
| 351 while (sum >= 0 || index > str.length) { | 389 bool detectRtlDirectionality(String str, [bool isHtml]) { |
| 352 int char = str.charCodeAt(index); | 390 return estimateDirectionOfText(str, isHtml) == TextDirection.RTL; |
| 353 if (char == '('.charCodeAt(0)) sum++; | 391 } |
| 354 else if (char == ')'.charCodeAt(0)) sum--; | |
| 355 index++; | |
| 356 } | |
| 357 return index; | |
| 358 } | |
| 359 | |
| 360 /** | |
| 361 * Replace the double and single quote directly after a Hebrew character in | |
| 362 * [str] with GERESH and GERSHAYIM. This is most likely the user's intention. | |
| 363 */ | |
| 364 static String normalizeHebrewQuote(String str) { | |
| 365 StringBuffer buf = new StringBuffer(); | |
| 366 if (str.length > 0) { | |
| 367 buf.add(str.substring(0, 1)); | |
| 368 } | |
| 369 // Start at 1 because we're looking for the patterns [\u0591-\u05f2])" or | |
| 370 // [\u0591-\u05f2]'. | |
| 371 for (int i = 1; i < str.length; i++) { | |
| 372 if (str.substring(i, i+1) == '"' | |
| 373 && const RegExp('[\u0591-\u05f2]').hasMatch(str.substring(i-1, i))) { | |
| 374 buf.add('\u05f4'); | |
| 375 } else if (str.substring(i, i+1) == "'" | |
| 376 && const RegExp('[\u0591-\u05f2]').hasMatch(str.substring(i-1, i))) { | |
| 377 buf.add('\u05f3'); | |
| 378 } else { | |
| 379 buf.add(str.substring(i, i+1)); | |
| 380 } | |
| 381 } | |
| 382 return buf.toString(); | |
| 383 } | |
| 384 | |
| 385 /** | |
| 386 * Check the directionality of [str], return true if the piece of | |
| 387 * text should be laid out in RTL direction. If [isHtml] is true, the string | |
| 388 * is HTML or HTML-escaped. | |
| 389 */ | |
| 390 static bool detectRtlDirectionality(String str, [bool isHtml]) { | |
| 391 return estimateDirection(str, isHtml) == TextDirection.RTL; | |
| 392 } | |
| 393 } | |
| OLD | NEW |