1 /* Copyright 2017 The TensorFlow Authors. All Rights Reserved.
2 
3 Licensed under the Apache License, Version 2.0 (the "License");
4 you may not use this file except in compliance with the License.
5 You may obtain a copy of the License at
6 
7     http://www.apache.org/licenses/LICENSE-2.0
8 
9 Unless required by applicable law or agreed to in writing, software
10 distributed under the License is distributed on an "AS IS" BASIS,
11 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 See the License for the specific language governing permissions and
13 limitations under the License.
14 ==============================================================================*/
15 #ifndef TENSORFLOW_LITE_CORE_API_ERROR_REPORTER_H_
16 #define TENSORFLOW_LITE_CORE_API_ERROR_REPORTER_H_
17 
18 #include <cstdarg>
19 
20 namespace tflite {
21 
22 /// A functor that reports error to supporting system. Invoked similar to
23 /// printf.
24 ///
25 /// Usage:
26 ///  ErrorReporter foo;
27 ///  foo.Report("test %d", 5);
28 /// or
29 ///  va_list args;
30 ///  foo.Report("test %d", args); // where args is va_list
31 ///
32 /// Subclass ErrorReporter to provide another reporting destination.
33 /// For example, if you have a GUI program, you might redirect to a buffer
34 /// that drives a GUI error log box.
35 class ErrorReporter {
36  public:
~ErrorReporter()37   virtual ~ErrorReporter() {}
38   virtual int Report(const char* format, va_list args) = 0;
39   int Report(const char* format, ...);
40   int ReportError(void*, const char* format, ...);
41 };
42 
43 }  // namespace tflite
44 
45 // You should not make bare calls to the error reporter, instead use the
46 // TF_LITE_REPORT_ERROR macro, since this allows message strings to be
47 // stripped when the binary size has to be optimized. If you are looking to
48 // reduce binary size, define TF_LITE_STRIP_ERROR_STRINGS when compiling and
49 // every call will be stubbed out, taking no memory.
50 #ifndef TF_LITE_STRIP_ERROR_STRINGS
51 #define TF_LITE_REPORT_ERROR(reporter, ...)                             \
52   do {                                                                  \
53     static_cast<tflite::ErrorReporter*>(reporter)->Report(__VA_ARGS__); \
54   } while (false)
55 #else  // TF_LITE_STRIP_ERROR_STRINGS
56 #define TF_LITE_REPORT_ERROR(reporter, ...)
57 #endif  // TF_LITE_STRIP_ERROR_STRINGS
58 
59 #endif  // TENSORFLOW_LITE_CORE_API_ERROR_REPORTER_H_
60