src/mesa/main/errors.h

   1 /*
   2  * Mesa 3-D graphics library
   3  *
   4  * Copyright (C) 1999-2008  Brian Paul   All Rights Reserved.
   5  *
   6  * Permission is hereby granted, free of charge, to any person obtaining a
   7  * copy of this software and associated documentation files (the "Software"),
   8  * to deal in the Software without restriction, including without limitation
   9  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
  10  * and/or sell copies of the Software, and to permit persons to whom the
  11  * Software is furnished to do so, subject to the following conditions:
  12  *
  13  * The above copyright notice and this permission notice shall be included
  14  * in all copies or substantial portions of the Software.
  15  *
  16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
  17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  18  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  19  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR
  20  * OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
  21  * ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
  22  * OTHER DEALINGS IN THE SOFTWARE.
  23  */
  24
  25
  26 /**
  27  * \file errors.h
  28  * Mesa debugging and error handling functions.
  29  *
  30  * This file provides functions to record errors, warnings, and miscellaneous
  31  * debug information.
  32  */
  33
  34
  35 #ifndef ERRORS_H
  36 #define ERRORS_H
  37
  38
  39 #include <stdio.h>
  40 #include <stdarg.h>
  41 #include "glheader.h"
  42 #include "menums.h"
  43
  44
  45 #ifdef __cplusplus
  46 extern "C" {
  47 #endif
  48
  49 struct gl_context;
  50
  51 extern void
  52 _mesa_warning( struct gl_context *gc, const char *fmtString, ... ) PRINTFLIKE(2, 3);
  53
  54 extern void
  55 _mesa_problem( const struct gl_context *ctx, const char *fmtString, ... ) PRINTFLIKE(2, 3);
  56
  57 extern void
  58 _mesa_error( struct gl_context *ctx, GLenum error, const char *fmtString, ... ) PRINTFLIKE(3, 4);
  59
  60 extern void
  61 _mesa_error_no_memory(const char *caller);
  62
  63 extern void
  64 _mesa_debug( const struct gl_context *ctx, const char *fmtString, ... ) PRINTFLIKE(2, 3);
  65
  66 extern void
  67 _mesa_log(const char *fmtString, ...) PRINTFLIKE(1, 2);
  68
  69 extern FILE *
  70 _mesa_get_log_file(void);
  71
  72 void
  73 _mesa_shader_debug(struct gl_context *ctx, GLenum type, GLuint *id,
  74                    const char *msg);
  75
  76 extern void
  77 _mesa_gl_vdebugf(struct gl_context *ctx,
  78                  GLuint *id,
  79                  enum mesa_debug_source source,
  80                  enum mesa_debug_type type,
  81                  enum mesa_debug_severity severity,
  82                  const char *fmtString,
  83                  va_list args);
  84
  85 extern void
  86 _mesa_gl_debugf(struct gl_context *ctx,
  87                 GLuint *id,
  88                 enum mesa_debug_source source,
  89                 enum mesa_debug_type type,
  90                 enum mesa_debug_severity severity,
  91                 const char *fmtString, ...) PRINTFLIKE(6, 7);
  92
  93 extern size_t
  94 _mesa_gl_debug(struct gl_context *ctx,
  95                GLuint *id,
  96                enum mesa_debug_source source,
  97                enum mesa_debug_type type,
  98                enum mesa_debug_severity severity,
  99                const char *msg);
 100
 101 #define _mesa_perf_debug(ctx, sev, ...) do {                              \
 102    static GLuint msg_id = 0;                                              \
 103    if (unlikely(ctx->Const.ContextFlags & GL_CONTEXT_FLAG_DEBUG_BIT)) {   \
 104       _mesa_gl_debugf(ctx, &msg_id,                                       \
 105                       MESA_DEBUG_SOURCE_API,                              \
 106                       MESA_DEBUG_TYPE_PERFORMANCE,                        \
 107                       sev,                                                \
 108                       __VA_ARGS__);                                       \
 109    }                                                                      \
 110 } while (0)
 111
 112
 113 #ifdef __cplusplus
 114 }
 115 #endif
 116
 117
 118 #endif /* ERRORS_H */