LCOV - app.info - objdir/dist/include/nsIParserService.h

LCOV - code coverage report
| Current view: | directory - objdir/dist/include - nsIParserService.h (source / functions) |  | Found | Hit | Coverage |
| Test: | app.info | Lines: | 1 | 1 | 100.0 %
| Date: | 2012-04-21 | Functions: | 1 | 1 | 100.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                 :  * Netscape Communications Corporation.
          19                 :  * Portions created by the Initial Developer are Copyright (C) 1998
          20                 :  * the Initial Developer. All Rights Reserved.
          21                 :  *
          22                 :  * Contributor(s):
          23                 :  *
          24                 :  * Alternatively, the contents of this file may be used under the terms of
          25                 :  * either of the GNU General Public License Version 2 or later (the "GPL"),
          26                 :  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
          27                 :  * in which case the provisions of the GPL or the LGPL are applicable instead
          28                 :  * of those above. If you wish to allow use of your version of this file only
          29                 :  * under the terms of either the GPL or the LGPL, and not to allow others to
          30                 :  * use your version of this file under the terms of the MPL, indicate your
          31                 :  * decision by deleting the provisions above and replace them with the notice
          32                 :  * and other provisions required by the GPL or the LGPL. If you do not delete
          33                 :  * the provisions above, a recipient may use your version of this file under
          34                 :  * the terms of any one of the MPL, the GPL or the LGPL.
          35                 :  *
          36                 :  * ***** END LICENSE BLOCK ***** */
          37                 :
          38                 : #ifndef nsIParserService_h__
          39                 : #define nsIParserService_h__
          40                 :
          41                 : #include "nsISupports.h"
          42                 : #include "nsStringGlue.h"
          43                 : #include "nsHTMLTags.h"
          44                 : #include "nsIElementObserver.h"
          45                 :
          46                 : class nsIParser;
          47                 : class nsIParserNode;
          48                 :
          49                 : #define NS_PARSERSERVICE_CONTRACTID "@mozilla.org/parser/parser-service;1"
          50                 :
          51                 : // {90a92e37-abd6-441b-9b39-4064d98e1ede}
          52                 : #define NS_IPARSERSERVICE_IID \
          53                 : { 0x90a92e37, 0xabd6, 0x441b, { 0x9b, 0x39, 0x40, 0x64, 0xd9, 0x8e, 0x1e, 0xde } }
          54                 :
          55              34 : class nsIParserService : public nsISupports {
          56                 :  public:
          57                 :   NS_DECLARE_STATIC_IID_ACCESSOR(NS_IPARSERSERVICE_IID)
          58                 :
          59                 :   /**
          60                 :    * Looks up the nsHTMLTag enum value corresponding to the tag in aAtom. The
          61                 :    * lookup happens case insensitively.
          62                 :    *
          63                 :    * @param aAtom The tag to look up.
          64                 :    *
          65                 :    * @return PRInt32 The nsHTMLTag enum value corresponding to the tag in aAtom
          66                 :    *                 or eHTMLTag_userdefined if the tag does not correspond to
          67                 :    *                 any of the tag nsHTMLTag enum values.
          68                 :    */
          69                 :   virtual PRInt32 HTMLAtomTagToId(nsIAtom* aAtom) const = 0;
          70                 :
          71                 :   /**
          72                 :    * Looks up the nsHTMLTag enum value corresponding to the tag in aAtom.
          73                 :    *
          74                 :    * @param aAtom The tag to look up.
          75                 :    *
          76                 :    * @return PRInt32 The nsHTMLTag enum value corresponding to the tag in aAtom
          77                 :    *                 or eHTMLTag_userdefined if the tag does not correspond to
          78                 :    *                 any of the tag nsHTMLTag enum values.
          79                 :    */
          80                 :   virtual PRInt32 HTMLCaseSensitiveAtomTagToId(nsIAtom* aAtom) const = 0;
          81                 :
          82                 :   /**
          83                 :    * Looks up the nsHTMLTag enum value corresponding to the tag in aTag. The
          84                 :    * lookup happens case insensitively.
          85                 :    *
          86                 :    * @param aTag The tag to look up.
          87                 :    *
          88                 :    * @return PRInt32 The nsHTMLTag enum value corresponding to the tag in aTag
          89                 :    *                 or eHTMLTag_userdefined if the tag does not correspond to
          90                 :    *                 any of the tag nsHTMLTag enum values.
          91                 :    */
          92                 :   virtual PRInt32 HTMLStringTagToId(const nsAString& aTag) const = 0;
          93                 :
          94                 :   /**
          95                 :    * Gets the tag corresponding to the nsHTMLTag enum value in aId. The
          96                 :    * returned tag will be in lowercase.
          97                 :    *
          98                 :    * @param aId The nsHTMLTag enum value to get the tag for.
          99                 :    *
         100                 :    * @return const PRUnichar* The tag corresponding to the nsHTMLTag enum
         101                 :    *                          value, or nsnull if the enum value doesn't
         102                 :    *                          correspond to a tag (eHTMLTag_unknown,
         103                 :    *                          eHTMLTag_userdefined, eHTMLTag_text, ...).
         104                 :    */
         105                 :   virtual const PRUnichar *HTMLIdToStringTag(PRInt32 aId) const = 0;
         106                 :
         107                 :   /**
         108                 :    * Gets the tag corresponding to the nsHTMLTag enum value in aId. The
         109                 :    * returned tag will be in lowercase.
         110                 :    *
         111                 :    * @param aId The nsHTMLTag enum value to get the tag for.
         112                 :    *
         113                 :    * @return nsIAtom* The tag corresponding to the nsHTMLTag enum value, or
         114                 :    *                  nsnull if the enum value doesn't correspond to a tag
         115                 :    *                  (eHTMLTag_unknown, eHTMLTag_userdefined, eHTMLTag_text,
         116                 :    *                  ...).
         117                 :    */
         118                 :   virtual nsIAtom *HTMLIdToAtomTag(PRInt32 aId) const = 0;
         119                 :
         120                 :   NS_IMETHOD HTMLConvertEntityToUnicode(const nsAString& aEntity,
         121                 :                                         PRInt32* aUnicode) const = 0;
         122                 :
         123                 :   NS_IMETHOD HTMLConvertUnicodeToEntity(PRInt32 aUnicode,
         124                 :                                         nsCString& aEntity) const = 0;
         125                 :
         126                 :   NS_IMETHOD IsContainer(PRInt32 aId, bool& aIsContainer) const = 0;
         127                 :   NS_IMETHOD IsBlock(PRInt32 aId, bool& aIsBlock) const = 0;
         128                 :
         129                 :   virtual nsresult CheckQName(const nsAString& aQName,
         130                 :                               bool aNamespaceAware,
         131                 :                               const PRUnichar** aColon) = 0;
         132                 :   virtual bool IsXMLLetter(PRUnichar aChar) = 0;
         133                 :   virtual bool IsXMLNCNameChar(PRUnichar aChar) = 0;
         134                 :
         135                 :   /**
         136                 :    * Decodes an entity into a UTF-16 character. If a ; is found between aStart
         137                 :    * and aEnd it will try to decode the entity and set aNext to point to the
         138                 :    * character after the ;. The resulting UTF-16 character will be written in
         139                 :    * aResult, so if the entity is a valid numeric entity there needs to be
         140                 :    * space for at least two PRUnichars.
         141                 :    *
         142                 :    * @param aStart pointer to the character after the ampersand.
         143                 :    * @param aEnd pointer to the position after the last character of the
         144                 :    *             string.
         145                 :    * @param aNext [out] will be set to the character after the ; or null if
         146                 :    *                    the decoding was unsuccessful.
         147                 :    * @param aResult the buffer to write the resulting UTF-16 character in.
         148                 :    * @return the number of PRUnichars written to aResult.
         149                 :    */
         150                 :   virtual PRUint32 DecodeEntity(const PRUnichar* aStart, const PRUnichar* aEnd,
         151                 :                                 const PRUnichar** aNext,
         152                 :                                 PRUnichar* aResult) = 0;
         153                 : };
         154                 :
         155                 : NS_DEFINE_STATIC_IID_ACCESSOR(nsIParserService, NS_IPARSERSERVICE_IID)
         156                 :
         157                 : #endif // nsIParserService_h__

Generated by: LCOV version 1.7