src/OpenFOAM/db/error/StaticAssert.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software; you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM; if not, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::StaticAssertFailed
  27
  28 Description
  29     Macros and classes to provide static (compile-time) assertions.
  30
  31     Ideas from various sources
  32     (http://www.ddj.com/cpp/184401547, http://www.boost.org)
  33
  34 \*---------------------------------------------------------------------------*/
  35
  36 #ifndef StaticAssert_H
  37 #define StaticAssert_H
  38
  39 namespace Foam
  40 {
  41
  42 //- Forward declaration of StaticAssertionFailed.
  43 //  Leave as an incomplete class so that sizeof(..) fails
  44 template<bool Truth> class StaticAssertionFailed;
  45
  46 /*---------------------------------------------------------------------------*\
  47                     Class StaticAssertionFailed Declaration
  48 \*---------------------------------------------------------------------------*/
  49
  50 //- Specialization for successful assertions
  51 template<>
  52 class StaticAssertionFailed<true>
  53 {};
  54
  55
  56 //- Helper class for handling static assertions
  57 template<unsigned Test>
  58 class StaticAssertionTest {};
  59
  60 }
  61
  62 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  63
  64 // internal use:
  65 // ~~~~~~~~~~~~~
  66 // paste together strings, even if an argument is itself a macro
  67 #define StaticAssertMacro(X,Y)  StaticAssertMacro1(X,Y)
  68 #define StaticAssertMacro1(X,Y) StaticAssertMacro2(X,Y)
  69 #define StaticAssertMacro2(X,Y) X##Y
  70
  71 // external use:
  72 // ~~~~~~~~~~~~~
  73 /**
  74  * @def StaticAssert(Test)
  75  * Assert that some test is true at compile-time
  76 */
  77 #define StaticAssert(Test)                                                   \
  78     typedef ::Foam::StaticAssertionTest                                      \
  79     <                                                                        \
  80         sizeof( ::Foam::StaticAssertionFailed< ((Test) ? true : false) > )   \
  81     > StaticAssertMacro(StaticAssertionTest, __LINE__)
  82
  83 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  84
  85 #endif
  86
  87 // ************************************************************************* //