LCOV - code coverage report
Current view: directory - objdir/dist/include - nsXMLNameSpaceMap.h (source / functions) Found Hit Coverage
Test: app.info Lines: 4 0 0.0 %
Date: 2012-06-02 Functions: 3 0 0.0 %

       1                 : /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
       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 Mozilla Communicator client code.
      16                 :  *
      17                 :  * The Initial Developer of the Original Code is
      18                 :  * IBM Corporation.
      19                 :  * Portions created by the Initial Developer are Copyright (C) 2005
      20                 :  * the Initial Developer. All Rights Reserved.
      21                 :  *
      22                 :  * Contributor(s):
      23                 :  *  Brian Ryner <bryner@brianryner.com>
      24                 :  *
      25                 :  * Alternatively, the contents of this file may be used under the terms of
      26                 :  * either of the GNU General Public License Version 2 or later (the "GPL"),
      27                 :  * or 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 nsXMLNameSpaceMap_h_
      40                 : #define nsXMLNameSpaceMap_h_
      41                 : 
      42                 : #include "nsString.h"
      43                 : #include "nsTArray.h"
      44                 : #include "nsCOMPtr.h"
      45                 : #include "nsIAtom.h"
      46                 : 
      47                 : struct nsNameSpaceEntry
      48               0 : {
      49               0 :   nsNameSpaceEntry(nsIAtom *aPrefix)
      50               0 :     : prefix(aPrefix) {}
      51                 : 
      52                 :   nsCOMPtr<nsIAtom> prefix;
      53                 :   PRInt32 nameSpaceID;
      54                 : };
      55                 : 
      56                 : /**
      57                 :  * nsXMLNameSpaceMap contains a set of prefixes which are mapped onto
      58                 :  * namespaces.  It allows the set to be searched by prefix or by namespace ID.
      59                 :  */
      60                 : class nsXMLNameSpaceMap
      61                 : {
      62                 : public:
      63                 :   /**
      64                 :    * Allocates a new nsXMLNameSpaceMap (with new()) and if aForXML is
      65                 :    * true initializes it with the xmlns and xml namespaces.
      66                 :    */
      67                 :   static NS_HIDDEN_(nsXMLNameSpaceMap*) Create(bool aForXML);
      68                 : 
      69                 :   /**
      70                 :    * Add a prefix and its corresponding namespace ID to the map.
      71                 :    * Passing a null |aPrefix| corresponds to the default namespace, which may
      72                 :    * be set to something other than kNameSpaceID_None.
      73                 :    */
      74                 :   NS_HIDDEN_(nsresult) AddPrefix(nsIAtom *aPrefix, PRInt32 aNameSpaceID);
      75                 : 
      76                 :   /**
      77                 :    * Add a prefix and a namespace URI to the map.  The URI will be converted
      78                 :    * to its corresponding namespace ID.
      79                 :    */
      80                 :   NS_HIDDEN_(nsresult) AddPrefix(nsIAtom *aPrefix, nsString &aURI);
      81                 : 
      82                 :   /*
      83                 :    * Returns the namespace ID for the given prefix, if it is in the map.
      84                 :    * If |aPrefix| is null and is not in the map, then a null namespace
      85                 :    * (kNameSpaceID_None) is returned.  If |aPrefix| is non-null and is not in
      86                 :    * the map, then kNameSpaceID_Unknown is returned.
      87                 :    */
      88                 :   NS_HIDDEN_(PRInt32) FindNameSpaceID(nsIAtom *aPrefix) const;
      89                 : 
      90                 :   /**
      91                 :    * If the given namespace ID is in the map, then the first prefix which
      92                 :    * maps to that namespace is returned.  Otherwise, null is returned.
      93                 :    */
      94                 :   NS_HIDDEN_(nsIAtom*) FindPrefix(PRInt32 aNameSpaceID) const;
      95                 : 
      96                 :   /* Removes all prefix mappings. */
      97                 :   NS_HIDDEN_(void) Clear();
      98                 : 
      99               0 :   ~nsXMLNameSpaceMap() { Clear(); }
     100                 : 
     101                 : private:
     102                 :   nsXMLNameSpaceMap() NS_HIDDEN;  // use Create() to create new instances
     103                 : 
     104                 :   nsTArray<nsNameSpaceEntry> mNameSpaces;
     105                 : };
     106                 : 
     107                 : #endif

Generated by: LCOV version 1.7