opensubdiv/far/error.h Source File

- Main Page
- Namespaces
- Classes
- Files

- File List

error.h
Go to the documentation of this file.
1 //
2 // Copyright 2013 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24
25 #ifndef OPENSUBDIV3_FAR_ERROR_H
26 #define OPENSUBDIV3_FAR_ERROR_H
27
28 #include "../version.h"
29
30 namespace OpenSubdiv {
31 namespace OPENSUBDIV_VERSION {
32
33 namespace Far {
34
35 typedef enum {
36 FAR_NO_ERROR,
37 FAR_FATAL_ERROR,
38 FAR_INTERNAL_CODING_ERROR,
39 FAR_CODING_ERROR,
40 FAR_RUNTIME_ERROR
41 } ErrorType;
42
43
45 typedef void (*ErrorCallbackFunc)(ErrorType err, const char *message);
46
53 void SetErrorCallback(ErrorCallbackFunc func);
54
55
57 typedef void (*WarningCallbackFunc)(const char *message);
58
65 void SetWarningCallback(WarningCallbackFunc func);
66
67
68 //
69 // The following are intended for internal use only (and will eventually
70 // be moved within namespace internal)
71 //
72
79 void Error(ErrorType err, const char *format, ...);
80
85 void Warning(const char *format, ...);
86
87
88 } // end namespace
89
90 } // end namespace OPENSUBDIV_VERSION
91 using namespace OPENSUBDIV_VERSION;
92
93 } // end namespace OpenSubdiv
94
95 #endif // OPENSUBDIV3_FAR_ERROR_H
OpenSubdiv::OPENSUBDIV_VERSION::Far::Warning
void Warning(const char *format,...)
Sends an OSD warning message (internal use only)
OpenSubdiv
Definition: error.h:30
OpenSubdiv::OPENSUBDIV_VERSION::Far::FAR_CODING_ERROR
Issue a generic programming error, but continue execution.
Definition: error.h:39
OpenSubdiv::OPENSUBDIV_VERSION::Far::FAR_NO_ERROR
No error. Move along.
Definition: error.h:36
OpenSubdiv::OPENSUBDIV_VERSION::Far::FAR_RUNTIME_ERROR
Issue a generic runtime error, but continue execution.
Definition: error.h:40
OpenSubdiv::OPENSUBDIV_VERSION::Far::SetWarningCallback
void SetWarningCallback(WarningCallbackFunc func)
Sets the warning callback function (default is "printf")
OpenSubdiv::OPENSUBDIV_VERSION::Far::WarningCallbackFunc
void(* WarningCallbackFunc)(const char *message)
The warning callback function type (default is "printf")
Definition: error.h:57
OpenSubdiv::OPENSUBDIV_VERSION::Far::FAR_INTERNAL_CODING_ERROR
Issue an internal programming error, but continue execution.
Definition: error.h:38
OpenSubdiv::OPENSUBDIV_VERSION::Far::ErrorType
ErrorType
Definition: error.h:35
OpenSubdiv::OPENSUBDIV_VERSION::Far::SetErrorCallback
void SetErrorCallback(ErrorCallbackFunc func)
Sets the error callback function (default is "printf")
OpenSubdiv::OPENSUBDIV_VERSION::Far::ErrorCallbackFunc
void(* ErrorCallbackFunc)(ErrorType err, const char *message)
The error callback function type (default is "printf")
Definition: error.h:45
OpenSubdiv::OPENSUBDIV_VERSION::Far::FAR_FATAL_ERROR
Issue a fatal error and end the program.
Definition: error.h:37
OpenSubdiv::OPENSUBDIV_VERSION::Far::Error
void Error(ErrorType err, const char *format,...)
Sends an OSD error with a message (internal use only)