security/manager/ssl/src/nsNSSCleaner.h

   1 /* ***** BEGIN LICENSE BLOCK *****
   2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   3  *
   4  * The contents of this file are subject to the Mozilla Public License Version
   5  * 1.1 (the "License"); you may not use this file except in compliance with
   6  * the License. You may obtain a copy of the License at
   7  * http://www.mozilla.org/MPL/
   8  *
   9  * Software distributed under the License is distributed on an "AS IS" basis,
  10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11  * for the specific language governing rights and limitations under the
  12  * License.
  13  *
  14  * The Original Code is Mozilla Communicator.
  15  *
  16  * The Initial Developer of the Original Code is
  17  * Netscape Communications Corporation.
  18  * Portions created by the Initial Developer are Copyright (C) 2002
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *   Kai Engert <kaie@netscape.com>
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either the GNU General Public License Version 2 or later (the "GPL"), or
  26  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #ifndef _INC_NSSCleaner_H
  39 #define _INC_NSSCleaner_H
  40
  41 /*
  42   NSSCleanupAutoPtrClass(CERTCertificate, CERT_DestroyCertificate)
  43
  44   will produce:
  45
  46   class CERTCertificateCleaner
  47   {
  48   private:
  49     CERTCertificateCleaner(const CERTCertificateCleaner&);
  50     CERTCertificateCleaner();
  51     void operator=(const CERTCertificateCleaner&);
  52     CERTCertificate *&object;
  53   public:
  54     CERTCertificateCleaner(CERTCertificate *&a_object)
  55       :object(a_object) {}
  56     ~CERTCertificateCleaner() {
  57       if (object) {
  58         CERT_DestroyCertificate(object);
  59         object = nsnull;
  60       }
  61     }
  62   };
  63
  64   By making default and copy constructor, and assignment operator
  65   private, we will make sure nobody will be able to use it.
  66   Not defining bodies for them is an additional safeguard.
  67
  68   This class is not designed to allow being passed around.
  69   It's just for automatic cleanup of a local variable.
  70
  71
  72   By storing a reference to the underlying pointer,
  73   we will zero out the given pointer variable,
  74   making sure it will not be used after it has been freed.
  75
  76   Even better, in case the underlying pointer variable gets
  77   assigned another value, this will be recognized, and
  78   the latest value stored in the pointer will be freed.
  79
  80
  81   In order to not require everybody to have all the NSS
  82   includes in their implementation files,
  83   we don't declare the classes here.
  84
  85 */
  86
  87 #define NSSCleanupAutoPtrClass(nsstype, cleanfunc) \
  88 class nsstype##Cleaner                             \
  89 {                                                  \
  90 private:                                           \
  91   nsstype##Cleaner(const nsstype##Cleaner&);       \
  92   nsstype##Cleaner();                              \
  93   void operator=(const nsstype##Cleaner&);         \
  94   nsstype *&object;                                \
  95 public:                                            \
  96   nsstype##Cleaner(nsstype *&a_object)             \
  97     :object(a_object) {}                           \
  98   ~nsstype##Cleaner() {                            \
  99     if (object) {                                  \
 100       cleanfunc(object);                           \
 101       object = nsnull;                             \
 102     }                                              \
 103   }                                                \
 104   void detach() {object=nsnull;}                   \
 105 };
 106
 107 #define NSSCleanupAutoPtrClass_WithParam(nsstype, cleanfunc, namesuffix, paramvalue) \
 108 class nsstype##Cleaner##namesuffix                 \
 109 {                                                  \
 110 private:                                           \
 111   nsstype##Cleaner##namesuffix(const nsstype##Cleaner##namesuffix &); \
 112   nsstype##Cleaner##namesuffix();                                     \
 113   void operator=(const nsstype##Cleaner##namesuffix &);               \
 114   nsstype *&object;                                \
 115 public:                                            \
 116   nsstype##Cleaner##namesuffix(nsstype *&a_object) \
 117     :object(a_object) {}                           \
 118   ~nsstype##Cleaner##namesuffix() {                \
 119     if (object) {                                  \
 120       cleanfunc(object, paramvalue);               \
 121       object = nsnull;                             \
 122     }                                              \
 123   }                                                \
 124   void detach() {object=nsnull;}                   \
 125 };
 126
 127 #include "certt.h"
 128
 129 class CERTVerifyLogContentsCleaner
 130 {
 131 public:
 132   CERTVerifyLogContentsCleaner(CERTVerifyLog *&cvl);
 133   ~CERTVerifyLogContentsCleaner();
 134 private:
 135   CERTVerifyLog *&m_cvl;
 136 };
 137
 138 #endif