Back to index

lightning-sunbird  0.9+nobinonly
nsStaticAtom.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
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 Static Atom classes.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corp.
00019  * Portions created by the Initial Developer are Copyright (C) 2003
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *   Alec Flett <alecf@netscape.com>
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either the GNU General Public License Version 2 or later (the "GPL"), or
00027  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00028  * in which case the provisions of the GPL or the LGPL are applicable instead
00029  * of those above. If you wish to allow use of your version of this file only
00030  * under the terms of either the GPL or the LGPL, and not to allow others to
00031  * use your version of this file under the terms of the MPL, indicate your
00032  * decision by deleting the provisions above and replace them with the notice
00033  * and other provisions required by the GPL or the LGPL. If you do not delete
00034  * the provisions above, a recipient may use your version of this file under
00035  * the terms of any one of the MPL, the GPL or the LGPL.
00036  *
00037  * ***** END LICENSE BLOCK ***** */
00038 
00039 #ifndef nsStaticAtom_h__
00040 #define nsStaticAtom_h__
00041 
00042 #include "nsIAtom.h"
00043 
00044 // see http://www.mozilla.org/projects/xpcom/atoms.html to use this stuff
00045 
00046 // class for declaring a static list of atoms, for use with gperf
00047 // Keep this VERY simple
00048 // mString: the value of the atom - the policy is that this is only
00049 //          ASCII, in order to avoid unnecessary conversions if
00050 //          someone asks for this in unicode
00051 // mAtom:   a convienience pointer - if you want to store the value of
00052 //          the atom created by this structure somewhere, put its
00053 //          address here
00054 struct nsStaticAtom {
00055     const char* mString;
00056     nsIAtom ** mAtom;
00057 };
00058 
00059 
00060 // register your lookup function with the atom table. Your function
00061 // will be called when at atom is not found in the main atom table.
00062 NS_COM nsresult
00063 NS_RegisterStaticAtoms(const nsStaticAtom*, PRUint32 aAtomCount);
00064 
00065 #endif