Back to index

lightning-sunbird  0.9+nobinonly
nsXMLNameSpaceMap.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
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  * IBM Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 2005
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *  Brian Ryner <bryner@brianryner.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 nsXMLNameSpaceMap_h_
00040 #define nsXMLNameSpaceMap_h_
00041 
00042 #include "nsVoidArray.h"
00043 
00044 class nsIAtom;
00045 
00050 class nsXMLNameSpaceMap
00051 {
00052 public:
00057   static NS_HIDDEN_(nsXMLNameSpaceMap*) Create();
00058 
00064   NS_HIDDEN_(nsresult) AddPrefix(nsIAtom *aPrefix, PRInt32 aNameSpaceID);
00065 
00070   NS_HIDDEN_(nsresult) AddPrefix(nsIAtom *aPrefix, nsString &aURI);
00071 
00072   /* Remove a prefix from the map. */
00073   NS_HIDDEN_(void) RemovePrefix(nsIAtom *aPrefix);
00074 
00075   /*
00076    * Returns the namespace ID for the given prefix, if it is in the map.
00077    * If |aPrefix| is null and is not in the map, then a null namespace
00078    * (kNameSpaceID_None) is returned.  If |aPrefix| is non-null and is not in
00079    * the map, then kNameSpaceID_Unknown is returned.
00080    */
00081   NS_HIDDEN_(PRInt32) FindNameSpaceID(nsIAtom *aPrefix) const;
00082 
00087   NS_HIDDEN_(nsIAtom*) FindPrefix(PRInt32 aNameSpaceID) const;
00088 
00089   /* Removes all prefix mappings. */
00090   NS_HIDDEN_(void) Clear();
00091 
00092   ~nsXMLNameSpaceMap() { Clear(); }
00093 
00094 private:
00095   nsXMLNameSpaceMap() NS_HIDDEN;  // use Create() to create new instances
00096 
00097   nsVoidArray mNameSpaces;
00098 };
00099 
00100 #endif