OpenSubdiv: opensubdiv/far/error.h Source File

| OpenSubdiv

Loading...
Searching...
No Matches
error.h
Go to the documentation of this file.
1//
2// Copyright 2013 Pixar
3//
4// Licensed under the terms set forth in the LICENSE.txt file available at
5// https://opensubdiv.org/license.
6//
7
8#ifndef OPENSUBDIV3_FAR_ERROR_H
9#define OPENSUBDIV3_FAR_ERROR_H
10
11#include "../version.h"
12
13namespace OpenSubdiv {
14namespace OPENSUBDIV_VERSION {
15
16namespace Far {
17
18 typedef enum {
19 FAR_NO_ERROR,
20 FAR_FATAL_ERROR,
21 FAR_INTERNAL_CODING_ERROR,
22 FAR_CODING_ERROR,
23 FAR_RUNTIME_ERROR
24} ErrorType;
25
26
28 typedef void (*ErrorCallbackFunc)(ErrorType err, const char *message);
29
36 void SetErrorCallback(ErrorCallbackFunc func);
37
38
40 typedef void (*WarningCallbackFunc)(const char *message);
41
48 void SetWarningCallback(WarningCallbackFunc func);
49
50
51//
52// The following are intended for internal use only (and will eventually
53// be moved within namespace internal)
54//
55
62 void Error(ErrorType err, const char *format, ...);
63
68 void Warning(const char *format, ...);
69
70
71} // end namespace
72
73} // end namespace OPENSUBDIV_VERSION
74using namespace OPENSUBDIV_VERSION;
75
76} // end namespace OpenSubdiv
77
78#endif // OPENSUBDIV3_FAR_ERROR_H
OpenSubdiv
Definition limits.h:15
OpenSubdiv::OPENSUBDIV_VERSION
Definition limits.h:16
OpenSubdiv::OPENSUBDIV_VERSION::Far
Definition refinerSurfaceFactory.h:19
OpenSubdiv::OPENSUBDIV_VERSION::Far::Error
void Error(ErrorType err, const char *format,...)
Sends an OSD error with a message (internal use only).
OpenSubdiv::OPENSUBDIV_VERSION::Far::WarningCallbackFunc
void(* WarningCallbackFunc)(const char *message)
The warning callback function type (default is "printf").
Definition error.h:40
OpenSubdiv::OPENSUBDIV_VERSION::Far::SetErrorCallback
void SetErrorCallback(ErrorCallbackFunc func)
Sets the error callback function (default is "printf").
OpenSubdiv::OPENSUBDIV_VERSION::Far::SetWarningCallback
void SetWarningCallback(WarningCallbackFunc func)
Sets the warning callback function (default is "printf").
OpenSubdiv::OPENSUBDIV_VERSION::Far::Warning
void Warning(const char *format,...)
Sends an OSD warning message (internal use only).
OpenSubdiv::OPENSUBDIV_VERSION::Far::ErrorCallbackFunc
void(* ErrorCallbackFunc)(ErrorType err, const char *message)
The error callback function type (default is "printf").
Definition error.h:28
OpenSubdiv::OPENSUBDIV_VERSION::Far::ErrorType
ErrorType
Definition error.h:18
OpenSubdiv::OPENSUBDIV_VERSION::Far::FAR_FATAL_ERROR
@ FAR_FATAL_ERROR
Issue a fatal error and end the program.
Definition error.h:20
OpenSubdiv::OPENSUBDIV_VERSION::Far::FAR_INTERNAL_CODING_ERROR
@ FAR_INTERNAL_CODING_ERROR
Issue an internal programming error, but continue execution.
Definition error.h:21
OpenSubdiv::OPENSUBDIV_VERSION::Far::FAR_CODING_ERROR
@ FAR_CODING_ERROR
Issue a generic programming error, but continue execution.
Definition error.h:22
OpenSubdiv::OPENSUBDIV_VERSION::Far::FAR_NO_ERROR
@ FAR_NO_ERROR
No error. Move along.
Definition error.h:19
OpenSubdiv::OPENSUBDIV_VERSION::Far::FAR_RUNTIME_ERROR
@ FAR_RUNTIME_ERROR
Issue a generic runtime error, but continue execution.
Definition error.h:23