tests/util/piglit-util-waffle.h

   1 /*
   2  * Copyright © 2012 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 /**
  25  * \file
  26  * \brief Waffle utilities
  27  *
  28  * Each function wfl_checked_*, if the backing Waffle function fails, prints
  29  * the error message emitted by Waffle and ends the test.
  30  */
  31
  32 #pragma once
  33
  34 #include <waffle.h>
  35
  36 /**
  37  * \brief Print the current Waffle error.
  38  *
  39  * The \a func_name is the name of most recently called Waffle function.
  40  */
  41 void
  42 wfl_log_error(const char *func_name);
  43
  44 /**
  45  * \brief Print the current Waffle error to stdout.
  46  *
  47  * The \a func_name is the name of most recently called Waffle function.
  48  */
  49 void
  50 wfl_log_error_stdout(const char *func_name);
  51
  52 /**
  53  * \brief Print the current Waffle error if PIGLIT_DEBUG=1.
  54  *
  55  * The \a func_name is the name of most recently called Waffle function.
  56  */
  57 void
  58 wfl_log_debug(const char *func_name);
  59
  60 /**
  61  * \brief Print the current Waffle error and end the test.
  62  *
  63  * The \a func_name is the name of most recently called Waffle function.
  64  *
  65  * If the error is WAFFLE_ERROR_UNSUPPORTED_ON_PLATFORM, skip the test.
  66  * Otherwise, fail the test.
  67  */
  68 void
  69 wfl_fatal_error(const char *func_name);
  70
  71 static inline void
  72 wfl_checked_init(const int32_t *attrib_list)
  73 {
  74         bool ok = waffle_init(attrib_list);
  75         if (!ok)
  76                 wfl_fatal_error("waffle_init");
  77 }
  78
  79 static inline struct waffle_display*
  80 wfl_checked_display_connect(const char *name)
  81 {
  82         struct waffle_display *dpy = waffle_display_connect(name);
  83         if (!dpy)
  84                 wfl_fatal_error("waffle_display_connect");
  85         return dpy;
  86 }
  87
  88 static inline struct waffle_config*
  89 wfl_checked_config_choose(struct waffle_display *dpy,
  90                            const int32_t *attrib_list)
  91 {
  92         struct waffle_config *config = waffle_config_choose(dpy, attrib_list);
  93         if (!config)
  94                 wfl_fatal_error("waffle_attrib_list");
  95         return config;
  96 }
  97
  98 static inline struct waffle_context*
  99 wfl_checked_context_create(struct waffle_config *config,
 100                            struct waffle_context *shared_ctx)
 101 {
 102         struct waffle_context *ctx = waffle_context_create(config, NULL);
 103         if (!ctx)
 104                 wfl_fatal_error("waffle_context_create");
 105         return ctx;
 106 }
 107
 108 static inline struct waffle_window*
 109 wfl_checked_window_create(struct waffle_config *config,
 110                              int32_t width, int32_t height)
 111 {
 112         struct waffle_window *window = waffle_window_create(config, width, height);
 113         if (!window)
 114                 wfl_fatal_error("waffle_window_create");
 115         return window;
 116 }
 117
 118 static inline bool
 119 wfl_checked_make_current(struct waffle_display *dpy,
 120                          struct waffle_window *window,
 121                          struct waffle_context *ctx)
 122 {
 123         bool ok = waffle_make_current(dpy, window, ctx);
 124         if (!ok)
 125                 wfl_fatal_error("waffle_make_current");
 126         return ok;
 127 }