| 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 part of matcher; | 5 part of matcher; |
| 6 | 6 |
| 7 // To decouple the reporting of errors, and allow for extensibility of | 7 // To decouple the reporting of errors, and allow for extensibility of |
| 8 // matchers, we make use of some interfaces. | 8 // matchers, we make use of some interfaces. |
| 9 | 9 |
| 10 /** | 10 /** |
| 11 * The ErrorFormatter type is used for functions that | 11 * The ErrorFormatter type is used for functions that |
| 12 * can be used to build up error reports upon [expect] failures. | 12 * can be used to build up error reports upon [expect] failures. |
| 13 * There is one built-in implementation ([defaultErrorFormatter]) | 13 * There is one built-in implementation ([defaultErrorFormatter]) |
| 14 * which is used by the default failure handler. If the failure handler | 14 * which is used by the default failure handler. If the failure handler |
| 15 * is replaced it may be desirable to replace the [stringDescription] | 15 * is replaced it may be desirable to replace the [stringDescription] |
| 16 * error formatter with another. | 16 * error formatter with another. |
| 17 */ | 17 */ |
| 18 typedef String ErrorFormatter(actual, Matcher matcher, String reason, | 18 typedef String ErrorFormatter(actual, Matcher matcher, String reason, |
| 19 Map matchState, bool verbose); | 19 Map matchState, bool verbose); |
| 20 | 20 |
| 21 /** | 21 /** |
| 22 * Matchers build up their error messages by appending to | 22 * Matchers build up their error messages by appending to |
| 23 * Description objects. This interface is implemented by | 23 * Description objects. This interface is implemented by |
| 24 * StringDescription. This interface is unlikely to need | 24 * StringDescription. This interface is unlikely to need |
| 25 * other implementations, but could be useful to replace in | 25 * other implementations, but could be useful to replace in |
| 26 * some cases - e.g. language conversion. | 26 * some cases - e.g. language conversion. |
| 27 */ | 27 */ |
| 28 abstract class Description { | 28 abstract class Description { |
| 29 int get length; |
| 30 |
| 29 /** Change the value of the description. */ | 31 /** Change the value of the description. */ |
| 30 Description replace(String text); | 32 Description replace(String text); |
| 31 | 33 |
| 32 /** This is used to add arbitrary text to the description. */ | 34 /** This is used to add arbitrary text to the description. */ |
| 33 Description add(String text); | 35 Description add(String text); |
| 34 | 36 |
| 35 /** This is used to add a meaningful description of a value. */ | 37 /** This is used to add a meaningful description of a value. */ |
| 36 Description addDescriptionOf(value); | 38 Description addDescriptionOf(value); |
| 37 | 39 |
| 38 /** | 40 /** |
| (...skipping 53 matching lines...) Expand 10 before | Expand all | Expand 10 after Loading... |
| 92 * the [reason] (argument from [expect]), some additonal [matchState] | 94 * the [reason] (argument from [expect]), some additonal [matchState] |
| 93 * generated by the [matcher], and a verbose flag which controls in | 95 * generated by the [matcher], and a verbose flag which controls in |
| 94 * some cases how much [matchState] information is used. It will use | 96 * some cases how much [matchState] information is used. It will use |
| 95 * these to create a detailed error message (typically by calling | 97 * these to create a detailed error message (typically by calling |
| 96 * an [ErrorFormatter]) and then call [fail] with this message. | 98 * an [ErrorFormatter]) and then call [fail] with this message. |
| 97 */ | 99 */ |
| 98 void failMatch(actual, Matcher matcher, String reason, | 100 void failMatch(actual, Matcher matcher, String reason, |
| 99 Map matchState, bool verbose); | 101 Map matchState, bool verbose); |
| 100 } | 102 } |
| 101 | 103 |
| OLD | NEW |