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
  44 // see http://www.mozilla.org/projects/xpcom/atoms.html to use this stuff
  45
  46 // class for declaring a static list of atoms, for use with gperf
  47 // Keep this VERY simple
  48 // mString: the value of the atom - the policy is that this is only
  49 //          ASCII, in order to avoid unnecessary conversions if
  50 //          someone asks for this in unicode
  51 // mAtom:   a convienience pointer - if you want to store the value of
  52 //          the atom created by this structure somewhere, put its
  53 //          address here
  54 struct nsStaticAtom {
  55     const char* mString;
  56     nsIAtom ** mAtom;
  57 };
  58
  59
  60 // register your lookup function with the atom table. Your function
  61 // will be called when at atom is not found in the main atom table.
  62 NS_COM nsresult
  63 NS_RegisterStaticAtoms(const nsStaticAtom*, PRUint32 aAtomCount);
  64
  65 #endif