1// Copyright 2010 Google Inc. 2// All rights reserved. 3// 4// Redistribution and use in source and binary forms, with or without 5// modification, are permitted provided that the following conditions are 6// met: 7// 8// * Redistributions of source code must retain the above copyright 9// notice, this list of conditions and the following disclaimer. 10// * Redistributions in binary form must reproduce the above copyright 11// notice, this list of conditions and the following disclaimer in the 12// documentation and/or other materials provided with the distribution. 13// * Neither the name of Google Inc. nor the names of its contributors 14// may be used to endorse or promote products derived from this software 15// without specific prior written permission. 16// 17// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 18// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 19// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 20// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 21// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 22// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 23// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 24// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 25// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 26// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 27// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 28 29/// \file defs.h 30/// 31/// Definitions for compiler and system features autodetected at configuration 32/// time. 33 34#if !defined(KYUA_DEFS_H) 35#define KYUA_DEFS_H 36 37 38/// Attribute to mark a function as printf-like. 39/// 40/// \param a Number of the format parameter. 41/// \param b Number of the first positional parameter. 42#define KYUA_DEFS_FORMAT_PRINTF(a, b) __attribute__((__format__(__printf__, a, b))) 43 44 45/// Attribute to mark a function as non-returning. 46#define KYUA_DEFS_NORETURN __attribute__((noreturn)) 47 48 49/// Attribute to mark a function as pure. 50#define KYUA_DEFS_PURE __attribute__((__pure__)) 51 52 53/// Attribute to mark an entity as unused. 54#define KYUA_DEFS_UNUSED __attribute__((__unused__)) 55 56 57/// Macro to mark a parameter as unused. 58/// 59/// This macro has to be called on the name of a parameter during the 60/// definition (not declaration) of a function. When doing so, it declares 61/// the parameter as unused to silence compiler warnings and also renames 62/// the parameter by prefixing "unused_" to it. This is to ensure that the 63/// developer remembers to remove the call to this macro from the parameter 64/// when he actually starts using it. 65/// 66/// \param name The name of the function parameter to mark as unused. 67#define KYUA_DEFS_UNUSED_PARAM(name) unused_ ## name KYUA_DEFS_UNUSED 68 69 70/// Unconstifies a pointer. 71#define KYUA_DEFS_UNCONST(ptr) ((void*)(unsigned long)(const void*)(ptr)) 72 73 74#endif // !defined(KYUA_DEFS_H) 75