| // Copyright 2013 The Flutter Authors. All rights reserved. |
| // Use of this source code is governed by a BSD-style license that can be |
| // found in the LICENSE file. |
| |
| #ifndef FLUTTER_IMPELLER_BASE_VALIDATION_H_ |
| #define FLUTTER_IMPELLER_BASE_VALIDATION_H_ |
| |
| #include <sstream> |
| |
| namespace impeller { |
| |
| class ValidationLog { |
| public: |
| ValidationLog(); |
| |
| ~ValidationLog(); |
| |
| std::ostream& GetStream(); |
| |
| private: |
| std::ostringstream stream_; |
| |
| ValidationLog(const ValidationLog&) = delete; |
| |
| ValidationLog(ValidationLog&&) = delete; |
| |
| ValidationLog& operator=(const ValidationLog&) = delete; |
| |
| ValidationLog& operator=(ValidationLog&&) = delete; |
| }; |
| |
| void ImpellerValidationBreak(const char* message); |
| |
| void ImpellerValidationErrorsSetFatal(bool fatal); |
| |
| bool ImpellerValidationErrorsAreFatal(); |
| |
| struct ScopedValidationDisable { |
| ScopedValidationDisable(); |
| |
| ~ScopedValidationDisable(); |
| |
| ScopedValidationDisable(const ScopedValidationDisable&) = delete; |
| |
| ScopedValidationDisable& operator=(const ScopedValidationDisable&) = delete; |
| }; |
| |
| struct ScopedValidationFatal { |
| ScopedValidationFatal(); |
| |
| ~ScopedValidationFatal(); |
| |
| ScopedValidationFatal(const ScopedValidationFatal&) = delete; |
| |
| ScopedValidationFatal& operator=(const ScopedValidationFatal&) = delete; |
| }; |
| |
| } // namespace impeller |
| |
| //------------------------------------------------------------------------------ |
| /// Get a stream to the log Impeller uses for all validation errors. The |
| /// behavior of these logs is as follows: |
| /// |
| /// * Validation error are completely ignored in the Flutter release |
| /// runtime-mode. |
| /// * In non-release runtime-modes, validation logs are redirected to the |
| /// Flutter `INFO` log. These logs typically show up when verbose logging is |
| /// enabled. |
| /// * If `ImpellerValidationErrorsSetFatal` is set to `true`, validation logs |
| /// are fatal. The runtime-mode restriction still applies. This usually |
| /// happens in test environments. |
| /// |
| #define VALIDATION_LOG ::impeller::ValidationLog{}.GetStream() |
| |
| #endif // FLUTTER_IMPELLER_BASE_VALIDATION_H_ |