Back to index

lightning-sunbird  0.9+nobinonly
nsAtomTable.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is mozilla.org code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #ifndef nsAtomTable_h__
00039 #define nsAtomTable_h__
00040 
00041 #include "nsIAtom.h"
00042 
00049 class AtomImpl : public nsIAtom {
00050 public:
00051   AtomImpl();
00052 
00053 protected:
00054   // We don't need a virtual destructor here because PermanentAtomImpl
00055   // deletions aren't handled through Release().
00056   ~AtomImpl();
00057 
00058 public:
00059   NS_DECL_ISUPPORTS
00060   NS_DECL_NSIATOM
00061 
00062   enum { REFCNT_PERMANENT_SENTINEL = PR_UINT32_MAX };
00063 
00064   virtual PRBool IsPermanent();
00065 
00066   // We can't use the virtual function in the base class destructor.
00067   PRBool IsPermanentInDestructor() {
00068     return mRefCnt == REFCNT_PERMANENT_SENTINEL;
00069   }
00070 
00071   void* operator new(size_t size, const nsACString& aString) CPP_THROW_NEW;
00072 
00073   void operator delete(void* ptr) {
00074     ::operator delete(ptr);
00075   }
00076 
00077   // for |#ifdef NS_BUILD_REFCNT_LOGGING| access to reference count
00078   nsrefcnt GetRefCount() { return mRefCnt; }
00079 
00080   // Actually more; 0 terminated. This slot is reserved for the
00081   // terminating zero.
00082   char mString[1];
00083 };
00084 
00089 class PermanentAtomImpl : public AtomImpl {
00090 public:
00091   PermanentAtomImpl();
00092   ~PermanentAtomImpl();
00093   NS_IMETHOD_(nsrefcnt) AddRef();
00094   NS_IMETHOD_(nsrefcnt) Release();
00095 
00096   virtual PRBool IsPermanent();
00097 
00098   void* operator new(size_t size, const nsACString& aString) CPP_THROW_NEW {
00099     return AtomImpl::operator new(size, aString);
00100   }
00101   void* operator new(size_t size, AtomImpl* aAtom) CPP_THROW_NEW;
00102 
00103 };
00104 
00105 void NS_PurgeAtomTable();
00106 
00107 #endif // nsAtomTable_h__