kernel/src/bbtkPimpl.h

   1 /*=========================================================================
   2   Program:   bbtk
   3   Module:    $RCSfile: bbtkPimpl.h,v $
   4   Language:  C++
   5   Date:      $Date: 2010/01/14 13:17:27 $
   6   Version:   $Revision: 1.2 $
   7 =========================================================================*/
   8
   9 /* ---------------------------------------------------------------------
  10
  11 * Copyright (c) CREATIS-LRMN (Centre de Recherche en Imagerie Medicale)
  12 * Authors : Eduardo Davila, Laurent Guigues, Jean-Pierre Roux
  13 *
  14 *  This software is governed by the CeCILL-B license under French law and
  15 *  abiding by the rules of distribution of free software. You can  use,
  16 *  modify and/ or redistribute the software under the terms of the CeCILL-B
  17 *  license as circulated by CEA, CNRS and INRIA at the following URL
  18 *  http://www.cecill.info/licences/Licence_CeCILL-B_V1-en.html
  19 *  or in the file LICENSE.txt.
  20 *
  21 *  As a counterpart to the access to the source code and  rights to copy,
  22 *  modify and redistribute granted by the license, users are provided only
  23 *  with a limited warranty  and the software's author,  the holder of the
  24 *  economic rights,  and the successive licensors  have only  limited
  25 *  liability.
  26 *
  27 *  The fact that you are presently reading this means that you have had
  28 *  knowledge of the CeCILL-B license and that you accept its terms.
  29 * ------------------------------------------------------------------------ */
  30
  31 #ifndef __bbtkPimpl_h_INCLUDED__
  32 #define __bbtkPimpl_h_INCLUDED__
  33
  34
  35 /** \brief Macro defining the members used to hide a class implementation details using the pimpl idom
  36  *    /// See http://c2.com/cgi/wiki?PimplIdiom
  37  * NOTE :
  38  *  - Defines the struct Pimpl to be implemented in cpp file
  39  *  - Declares a private member called p
  40  *  - Declares the methods PimplConstruct/PimplCopyConstruct/PimplDestruct
  41  */
  42 #define BBTK_DECLARE_PIMPL(CLASS)                                     \
  43   private:                                                            \
  44   /* The Pimpl struct forward definition */                           \
  45   class Pimpl;                                                        \
  46   /* The Pimpl pointer */                                             \
  47   Pimpl* p;                                                           \
  48   /* Constructs the Pimpl (to be called in all Ctors) */              \
  49   void PimplConstruct();                                              \
  50   /* Copy constructs the Pimpl (to be called in copy Ctor) */         \
  51   void PimplCopyConstruct(const CLASS&);                              \
  52   /* Destructs the Pimpl (to be called in Dtor) */                    \
  53   void PimplDestruct();
  54
  55 #endif
  56
  57 /** \brief Macro implementing the PimplConstruct/PimplCopyConstruct/PimplDestruct method declared by BBTK_DECLARE_PIMPL: to be put in cpp **/
  58 #define BBTK_IMPL_PIMPL(CLASS)                                          \
  59   void CLASS::PimplConstruct()                                          \
  60   {                                                                     \
  61     p = new Pimpl;                                                      \
  62   }                                                                     \
  63   void CLASS::PimplCopyConstruct(const CLASS& o)                        \
  64   {                                                                     \
  65     p = new Pimpl(*(o.p));                                              \
  66   }                                                                     \
  67   void CLASS::PimplDestruct()                                           \
  68   {                                                                     \
  69     delete p;                                                           \
  70   }
  71
  72