Back to index

lightning-sunbird  0.9+nobinonly
nsStaticNameTable.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
00002  *
00003  * ***** BEGIN LICENSE BLOCK *****
00004  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00005  *
00006  * The contents of this file are subject to the Mozilla Public License Version
00007  * 1.1 (the "License"); you may not use this file except in compliance with
00008  * the License. You may obtain a copy of the License at
00009  * http://www.mozilla.org/MPL/
00010  *
00011  * Software distributed under the License is distributed on an "AS IS" basis,
00012  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00013  * for the specific language governing rights and limitations under the
00014  * License.
00015  *
00016  * The Original Code is Mozilla Communicator client code, released
00017  * March 31, 1998.
00018  *
00019  * The Initial Developer of the Original Code is
00020  * Netscape Communications Corporation.
00021  * Portions created by the Initial Developer are Copyright (C) 1998
00022  * the Initial Developer. All Rights Reserved.
00023  *
00024  * Contributor(s):
00025  *
00026  * Alternatively, the contents of this file may be used under the terms of
00027  * either of the GNU General Public License Version 2 or later (the "GPL"),
00028  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00029  * in which case the provisions of the GPL or the LGPL are applicable instead
00030  * of those above. If you wish to allow use of your version of this file only
00031  * under the terms of either the GPL or the LGPL, and not to allow others to
00032  * use your version of this file under the terms of the MPL, indicate your
00033  * decision by deleting the provisions above and replace them with the notice
00034  * and other provisions required by the GPL or the LGPL. If you do not delete
00035  * the provisions above, a recipient may use your version of this file under
00036  * the terms of any one of the MPL, the GPL or the LGPL.
00037  *
00038  * ***** END LICENSE BLOCK ***** */
00039 
00040 /* Classes to manage lookup of static names in a table. */
00041 
00042 #ifndef nsStaticNameTable_h___
00043 #define nsStaticNameTable_h___
00044 
00045 #include "pldhash.h"
00046 /* This class supports case insensitive lookup.
00047  *
00048  * It differs from atom tables:
00049  * - It supports case insensitive lookup.
00050  * - It has minimal footprint by not copying the string table.
00051  * - It does no locking.
00052  * - It returns zero based indexes and const nsCString& as required by its
00053  *   callers in the parser.
00054  * - It is not an xpcom interface - meant for fast lookup in static tables.
00055  *
00056  * ***REQUIREMENTS***
00057  * - It *requires* that all entries in the table be lowercase only.
00058  * - It *requires* that the table of strings be in memory that lives at least
00059  *    as long as this table object - typically a static string array.
00060  */
00061 
00062 class NS_COM nsStaticCaseInsensitiveNameTable
00063 {
00064 public:
00065   enum { NOT_FOUND = -1 };
00066 
00067   PRBool           Init(const char* const aNames[], PRInt32 Count);
00068   PRInt32          Lookup(const nsACString& aName);
00069   PRInt32          Lookup(const nsAString& aName);
00070   const nsAFlatCString& GetStringValue(PRInt32 index);
00071 
00072   nsStaticCaseInsensitiveNameTable();
00073   ~nsStaticCaseInsensitiveNameTable();
00074 
00075 private:
00076   nsDependentCString*   mNameArray;
00077   PLDHashTable mNameTable;
00078   nsDependentCString    mNullStr;
00079 };
00080 
00081 #endif /* nsStaticNameTable_h___ */