xpcom/ds/nsStaticAtom.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is Static Atom classes.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corp.
  19  * Portions created by the Initial Developer are Copyright (C) 2003
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *   Alec Flett <alecf@netscape.com>
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #ifndef nsStaticAtom_h__
  40 #define nsStaticAtom_h__
  41
  42 #include "nsIAtom.h"
  43 #include "nsStringBuffer.h"
  44 #include "prlog.h"
  45
  46 #if defined(HAVE_CPP_CHAR16_T)
  47 #define NS_STATIC_ATOM_USE_WIDE_STRINGS
  48 typedef char16_t nsStaticAtomStringType;
  49 #elif defined(HAVE_CPP_2BYTE_WCHAR_T)
  50 #define NS_STATIC_ATOM_USE_WIDE_STRINGS
  51 typedef wchar_t nsStaticAtomStringType;
  52 #else
  53 typedef char nsStaticAtomStringType;
  54 #endif
  55
  56 #define NS_STATIC_ATOM(buffer_name, atom_ptr)  { (nsStringBuffer*) &buffer_name, atom_ptr }
  57 #define NS_STATIC_ATOM_BUFFER(buffer_name, str_data) static nsFakeStringBuffer< sizeof(str_data) > buffer_name = { 1, sizeof(str_data) * sizeof(nsStaticAtomStringType), NS_L(str_data) };
  58
  59 /**
  60  * Holds data used to initialize large number of atoms during startup. Use
  61  * the above macros to initialize these structs. They should never be accessed
  62  * directly other than from AtomTable.cpp
  63  */
  64 struct nsStaticAtom {
  65     nsStringBuffer* mStringBuffer;
  66     nsIAtom ** mAtom;
  67 };
  68
  69 /**
  70  * This is a struct with the same binary layout as a nsStringBuffer.
  71  */
  72 template <PRUint32 size>
  73 struct nsFakeStringBuffer {
  74     PRInt32 mRefCnt;
  75     PRUint32 mSize;
  76     nsStaticAtomStringType mStringData[size];
  77 };
  78
  79 // Register static atoms with the atom table
  80 NS_COM nsresult
  81 NS_RegisterStaticAtoms(const nsStaticAtom*, PRUint32 aAtomCount);
  82
  83 #endif