tests/util/piglit-log.h

   1 /*
   2  * Copyright 2014 Intel Corporation
   3  *
   4  * Permission is hereby granted, free of charge, to any person obtaining a
   5  * copy of this software and associated documentation files (the "Software"),
   6  * to deal in the Software without restriction, including without limitation
   7  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
   8  * and/or sell copies of the Software, and to permit persons to whom the
   9  * Software is furnished to do so, subject to the following conditions:
  10  *
  11  * The above copyright notice and this permission notice (including the next
  12  * paragraph) shall be included in all copies or substantial portions of the
  13  * Software.
  14  *
  15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL
  18  * THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
  20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
  21  * IN THE SOFTWARE.
  22  */
  23
  24 #pragma once
  25 #ifndef PIGLIT_LOG_H
  26 #define PIGLIT_LOG_H
  27
  28 #include <stdint.h>
  29
  30 #ifdef __cplusplus
  31 extern "C" {
  32 #endif
  33
  34 /**
  35  * \brief Piglit logging options
  36  *
  37  * Options can be set with the setter function piglit_log_set_opt() as well as
  38  * environment variables.  For each option, the environment variable of the
  39  * same name, if set to a non-empty value,  overrides any value set with the
  40  * setter function.
  41  */
  42 enum piglit_log_opt {
  43         /**
  44          * Print thread id in log messages.
  45          * Option type: bool
  46          */
  47         PIGLIT_LOG_PRINT_TID = 0,
  48
  49         /** Fake option. This is the maximum value of piglit_log_opt. */
  50         PIGLIT_LOG_OPT_MAX = 0,
  51 };
  52
  53 #if (__GNUC__ >= 3)
  54 #define PRINTFLIKE(f, a) __attribute__ ((format(__printf__, f, a)))
  55 #else
  56 #define PRINTFLIKE(f, a)
  57 #endif
  58
  59 intptr_t
  60 piglit_log_get_opt(enum piglit_log_opt);
  61
  62 void
  63 piglit_log_set_opt(enum piglit_log_opt opt, intptr_t value);
  64
  65 /** Log an error.message. */
  66 void
  67 piglit_loge(const char *fmt, ...) PRINTFLIKE(1, 2);
  68
  69 /** Log an info message. */
  70 void
  71 piglit_logi(const char *fmt, ...) PRINTFLIKE(1, 2);
  72
  73 /**
  74  * Log a debug message if environment variable PIGLIT_DEBUG is "1" or "true".
  75  */
  76 void
  77 piglit_logd(const char *fmt, ...) PRINTFLIKE(1, 2);
  78
  79 #ifdef __cplusplus
  80 } /* end extern "C" */
  81 #endif
  82
  83 #endif /* PIGLIT_LOG_H */