kernel/src/bbtkPimpl.h

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