src/util/basic_macros.h

   1 /*
   2 Minetest
   3 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU Lesser General Public License as published by
   7 the Free Software Foundation; either version 2.1 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU Lesser General Public License for more details.
  14
  15 You should have received a copy of the GNU Lesser General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 #ifndef BASICMACROS_HEADER
  21 #define BASICMACROS_HEADER
  22
  23 #define ARRLEN(x) (sizeof(x) / sizeof((x)[0]))
  24
  25 #define MYMIN(a, b) ((a) < (b) ? (a) : (b))
  26
  27 #define MYMAX(a, b) ((a) > (b) ? (a) : (b))
  28
  29 // Requires <algorithm>
  30 #define CONTAINS(c, v) (std::find((c).begin(), (c).end(), (v)) != (c).end())
  31
  32 // To disable copy constructors and assignment operations for some class
  33 // 'Foobar', add the macro DISABLE_CLASS_COPY(Foobar) as a private member.
  34 // Note this also disables copying for any classes derived from 'Foobar' as well
  35 // as classes having a 'Foobar' member.
  36 #define DISABLE_CLASS_COPY(C) \
  37         C(const C &);             \
  38         C &operator=(const C &)
  39
  40 #ifndef _MSC_VER
  41         #define UNUSED_ATTRIBUTE __attribute__ ((unused))
  42 #else
  43         #define UNUSED_ATTRIBUTE
  44 #endif
  45
  46 // Fail compilation if condition expr is not met.
  47 // Note that 'msg' must follow the format of a valid identifier, e.g.
  48 // STATIC_ASSERT(sizeof(foobar_t) == 40), foobar_t_is_wrong_size);
  49 #define STATIC_ASSERT(expr, msg) \
  50         UNUSED_ATTRIBUTE typedef char msg[!!(expr) * 2 - 1]
  51
  52 // Macros to facilitate writing position vectors to a stream
  53 // Usage:
  54 //      v3s16 pos(1,2,3);
  55 //      mystream << "message " << PP(pos) << std::endl;
  56
  57 #define PP(x) "("<<(x).X<<","<<(x).Y<<","<<(x).Z<<")"
  58
  59 #define PP2(x) "("<<(x).X<<","<<(x).Y<<")"
  60
  61 #endif