Back to index

lightning-sunbird  0.9+nobinonly
nsTemplateMap.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 Mozilla Communicator client 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  *   Chris Waterson <waterson@netscape.com>
00024  *
00025  * Alternatively, the contents of this file may be used under the terms of
00026  * either of the GNU General Public License Version 2 or later (the "GPL"),
00027  * or 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 nsTemplateMap_h__
00040 #define nsTemplateMap_h__
00041 
00042 #include "pldhash.h"
00043 #include "nsXULElement.h"
00044 
00045 class nsTemplateMap {
00046 protected:
00047     struct Entry {
00048         PLDHashEntryHdr mHdr;
00049         nsIContent*     mContent;
00050         nsIContent*     mTemplate;
00051     };
00052 
00053     PLDHashTable mTable;
00054 
00055     void
00056     Init() { PL_DHashTableInit(&mTable, PL_DHashGetStubOps(), nsnull, sizeof(Entry), PL_DHASH_MIN_SIZE); }
00057 
00058     void
00059     Finish() { PL_DHashTableFinish(&mTable); }
00060 
00061 public:
00062     nsTemplateMap() { Init(); }
00063 
00064     ~nsTemplateMap() { Finish(); }
00065 
00066     void
00067     Put(nsIContent* aContent, nsIContent* aTemplate) {
00068         NS_ASSERTION(PL_DHASH_ENTRY_IS_FREE(PL_DHashTableOperate(&mTable, aContent, PL_DHASH_LOOKUP)),
00069                      "aContent already in map");
00070 
00071         Entry* entry =
00072             NS_REINTERPRET_CAST(Entry*, PL_DHashTableOperate(&mTable, aContent, PL_DHASH_ADD));
00073 
00074         if (entry) {
00075             entry->mContent = aContent;
00076             entry->mTemplate = aTemplate;
00077         }
00078     }
00079 
00080     void
00081     Remove(nsIContent* aContent) {
00082         NS_ASSERTION(PL_DHASH_ENTRY_IS_BUSY(PL_DHashTableOperate(&mTable, aContent, PL_DHASH_LOOKUP)),
00083                      "aContent not in map");
00084 
00085         PL_DHashTableOperate(&mTable, aContent, PL_DHASH_REMOVE);
00086 
00087         PRUint32 count;
00088 
00089         // If possible, use the special nsXULElement interface to
00090         // "peek" at the child count without accidentally creating
00091         // children as a side effect, since we're about to rip 'em
00092         // outta the map anyway.
00093         nsXULElement *xulcontent = nsXULElement::FromContent(aContent);
00094         if (xulcontent) {
00095             count = xulcontent->PeekChildCount();
00096         }
00097         else {
00098             count = aContent->GetChildCount();
00099         }
00100 
00101         for (PRUint32 i = 0; i < count; ++i) {
00102             Remove(aContent->GetChildAt(i));
00103         }
00104     }
00105 
00106 
00107     void
00108     GetTemplateFor(nsIContent* aContent, nsIContent** aResult) {
00109         Entry* entry =
00110             NS_REINTERPRET_CAST(Entry*, PL_DHashTableOperate(&mTable, aContent, PL_DHASH_LOOKUP));
00111 
00112         if (PL_DHASH_ENTRY_IS_BUSY(&entry->mHdr))
00113             NS_IF_ADDREF(*aResult = entry->mTemplate);
00114         else
00115             *aResult = nsnull;
00116     }
00117 
00118     void
00119     Clear() { Finish(); Init(); }
00120 };
00121 
00122 #endif // nsTemplateMap_h__
00123