| 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 library dart2js.diagnostics.invariant; | 5 library dart2js.diagnostics.invariant; |
| 6 | 6 |
| 7 import 'spannable.dart'; | 7 import 'spannable.dart'; |
| 8 | 8 |
| 9 /** | 9 /** |
| 10 * If true, print a warning for each method that was resolved, but not | 10 * If true, print a warning for each method that was resolved, but not |
| 11 * compiled. | 11 * compiled. |
| 12 */ | 12 */ |
| 13 const bool REPORT_EXCESS_RESOLUTION = false; | 13 const bool REPORT_EXCESS_RESOLUTION = false; |
| 14 | 14 |
| 15 /// Flag that can be used in assertions to assert that a code path is only | 15 /// Flag that can be used in assertions to assert that a code path is only |
| 16 /// executed as part of development. | 16 /// executed as part of development. |
| 17 /// | 17 /// |
| 18 /// This flag is automatically set to true if helper methods like, [debugPrint], | 18 /// This flag is automatically set to true if helper methods like, [debugPrint], |
| 19 /// [debugWrapPrint], [trace], and [reportHere] are called. | 19 /// [debugWrapPrint], [trace], and [reportHere] are called. |
| 20 bool DEBUG_MODE = false; | 20 bool DEBUG_MODE = false; |
| 21 | 21 |
| 22 /// Assert that [DEBUG_MODE] is `true` and provide [message] as part of the | 22 /// Assert that [DEBUG_MODE] is `true` and provide [message] as part of the |
| 23 /// error message. | 23 /// error message. |
| 24 assertDebugMode(String message) { | 24 assertDebugMode(String message) { |
| 25 assert(DEBUG_MODE, | 25 assert(DEBUG_MODE, |
| 26 failedAt(NO_LOCATION_SPANNABLE, 'Debug mode is not enabled: $message')); | 26 failedAt(NO_LOCATION_SPANNABLE, 'Debug mode is not enabled: $message')); |
| 27 } | 27 } |
| 28 | 28 |
| 29 /** | |
| 30 * Throws a [SpannableAssertionFailure] if [condition] is | |
| 31 * [:false:]. [condition] must be either a [:bool:] or a no-arg | |
| 32 * function returning a [:bool:]. | |
| 33 * | |
| 34 * Use this method to provide better information for assertion by calling | |
| 35 * [invariant] as the argument to an [:assert:] statement: | |
| 36 * | |
| 37 * assert(invariant(position, isValid)); | |
| 38 * | |
| 39 * [spannable] must be non-null and will be used to provide positional | |
| 40 * information in the generated error message. | |
| 41 */ | |
| 42 bool invariant(Spannable spannable, var condition, {var message: null}) { | |
| 43 // TODO(johnniwinther): Use [spannable] and [message] to provide better | |
| 44 // information on assertion errors. | |
| 45 if (spannable == null) { | |
| 46 throw new SpannableAssertionFailure(CURRENT_ELEMENT_SPANNABLE, | |
| 47 'Spannable was null for invariant. Use CURRENT_ELEMENT_SPANNABLE.'); | |
| 48 } | |
| 49 if (condition is Function) { | |
| 50 condition = condition(); | |
| 51 if (condition is String) { | |
| 52 message = condition; | |
| 53 condition = false; | |
| 54 } | |
| 55 } | |
| 56 if (!condition) { | |
| 57 if (message is Function) { | |
| 58 message = message(); | |
| 59 } | |
| 60 throw new SpannableAssertionFailure(spannable, message); | |
| 61 } | |
| 62 return true; | |
| 63 } | |
| 64 | |
| 65 /// Throws a [SpannableAssertionFailure]. | 29 /// Throws a [SpannableAssertionFailure]. |
| 66 /// | 30 /// |
| 67 /// Use this method to provide better information for assertion by calling | 31 /// Use this method to provide better information for assertion by calling |
| 68 /// [failedAt] as the second argument to an `assert` statement: | 32 /// [failedAt] as the second argument to an `assert` statement: |
| 69 /// | 33 /// |
| 70 /// assert(condition, failedAt(position, message)); | 34 /// assert(condition, failedAt(position, message)); |
| 71 /// | 35 /// |
| 72 /// [spannable] must be non-null and will be used to provide positional | 36 /// [spannable] must be non-null and will be used to provide positional |
| 73 /// information in the generated error message. | 37 /// information in the generated error message. |
| 74 bool failedAt(Spannable spannable, [var message]) { | 38 bool failedAt(Spannable spannable, [var message]) { |
| 75 // TODO(johnniwinther): Use [spannable] and [message] to provide better | 39 // TODO(johnniwinther): Use [spannable] and [message] to provide better |
| 76 // information on assertion errors. | 40 // information on assertion errors. |
| 77 if (spannable == null) { | 41 if (spannable == null) { |
| 78 throw new SpannableAssertionFailure( | 42 throw new SpannableAssertionFailure( |
| 79 CURRENT_ELEMENT_SPANNABLE, | 43 CURRENT_ELEMENT_SPANNABLE, |
| 80 'Spannable was null for failedInvariant. ' | 44 'Spannable was null for failedInvariant. ' |
| 81 'Use CURRENT_ELEMENT_SPANNABLE.'); | 45 'Use CURRENT_ELEMENT_SPANNABLE.'); |
| 82 } | 46 } |
| 83 if (message is Function) { | 47 if (message is Function) { |
| 84 message = message(); | 48 message = message(); |
| 85 } | 49 } |
| 86 throw new SpannableAssertionFailure(spannable, message); | 50 throw new SpannableAssertionFailure(spannable, message); |
| 87 } | 51 } |
| 88 | |
| 89 typedef void InternalErrorFunction(Spannable location, String message); | |
| OLD | NEW |