parser/htmlparser/public/nsIParserService.h

   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 // {78081E70-AD53-11d5-8498-0010A4E0C706}
  56 #define NS_IOBSERVERENTRY_IID \
  57 { 0x78081e70, 0xad53, 0x11d5, { 0x84, 0x98, 0x00, 0x10, 0xa4, 0xe0, 0xc7, 0x06 } }
  58
  59
  60 class nsIObserverEntry : public nsISupports {
  61  public:
  62   NS_DECLARE_STATIC_IID_ACCESSOR(NS_IOBSERVERENTRY_IID)
  63
  64   NS_IMETHOD Notify(nsIParserNode* aNode,
  65                     nsIParser* aParser,
  66                     nsISupports* aWebShell,
  67                     const PRUint32 aFlags) = 0;
  68
  69 };
  70
  71
  72 NS_DEFINE_STATIC_IID_ACCESSOR(nsIObserverEntry, NS_IOBSERVERENTRY_IID)
  73
  74 class nsIParserService : public nsISupports {
  75  public:
  76   NS_DECLARE_STATIC_IID_ACCESSOR(NS_IPARSERSERVICE_IID)
  77
  78   /**
  79    * Looks up the nsHTMLTag enum value corresponding to the tag in aAtom. The
  80    * lookup happens case insensitively.
  81    *
  82    * @param aAtom The tag to look up.
  83    *
  84    * @return PRInt32 The nsHTMLTag enum value corresponding to the tag in aAtom
  85    *                 or eHTMLTag_userdefined if the tag does not correspond to
  86    *                 any of the tag nsHTMLTag enum values.
  87    */
  88   virtual PRInt32 HTMLAtomTagToId(nsIAtom* aAtom) const = 0;
  89
  90   /**
  91    * Looks up the nsHTMLTag enum value corresponding to the tag in aAtom.
  92    *
  93    * @param aAtom The tag to look up.
  94    *
  95    * @return PRInt32 The nsHTMLTag enum value corresponding to the tag in aAtom
  96    *                 or eHTMLTag_userdefined if the tag does not correspond to
  97    *                 any of the tag nsHTMLTag enum values.
  98    */
  99   virtual PRInt32 HTMLCaseSensitiveAtomTagToId(nsIAtom* aAtom) const = 0;
 100
 101   /**
 102    * Looks up the nsHTMLTag enum value corresponding to the tag in aTag. The
 103    * lookup happens case insensitively.
 104    *
 105    * @param aTag The tag to look up.
 106    *
 107    * @return PRInt32 The nsHTMLTag enum value corresponding to the tag in aTag
 108    *                 or eHTMLTag_userdefined if the tag does not correspond to
 109    *                 any of the tag nsHTMLTag enum values.
 110    */
 111   virtual PRInt32 HTMLStringTagToId(const nsAString& aTag) const = 0;
 112
 113   /**
 114    * Gets the tag corresponding to the nsHTMLTag enum value in aId. The
 115    * returned tag will be in lowercase.
 116    *
 117    * @param aId The nsHTMLTag enum value to get the tag for.
 118    *
 119    * @return const PRUnichar* The tag corresponding to the nsHTMLTag enum
 120    *                          value, or nsnull if the enum value doesn't
 121    *                          correspond to a tag (eHTMLTag_unknown,
 122    *                          eHTMLTag_userdefined, eHTMLTag_text, ...).
 123    */
 124   virtual const PRUnichar *HTMLIdToStringTag(PRInt32 aId) const = 0;
 125
 126   /**
 127    * Gets the tag corresponding to the nsHTMLTag enum value in aId. The
 128    * returned tag will be in lowercase.
 129    *
 130    * @param aId The nsHTMLTag enum value to get the tag for.
 131    *
 132    * @return nsIAtom* The tag corresponding to the nsHTMLTag enum value, or
 133    *                  nsnull if the enum value doesn't correspond to a tag
 134    *                  (eHTMLTag_unknown, eHTMLTag_userdefined, eHTMLTag_text,
 135    *                  ...).
 136    */
 137   virtual nsIAtom *HTMLIdToAtomTag(PRInt32 aId) const = 0;
 138
 139   NS_IMETHOD HTMLConvertEntityToUnicode(const nsAString& aEntity,
 140                                         PRInt32* aUnicode) const = 0;
 141
 142   NS_IMETHOD HTMLConvertUnicodeToEntity(PRInt32 aUnicode,
 143                                         nsCString& aEntity) const = 0;
 144
 145   NS_IMETHOD IsContainer(PRInt32 aId, PRBool& aIsContainer) const = 0;
 146   NS_IMETHOD IsBlock(PRInt32 aId, PRBool& aIsBlock) const = 0;
 147
 148   // Observer mechanism
 149   NS_IMETHOD RegisterObserver(nsIElementObserver* aObserver,
 150                               const nsAString& aTopic,
 151                               const eHTMLTags* aTags = nsnull) = 0;
 152
 153   NS_IMETHOD UnregisterObserver(nsIElementObserver* aObserver,
 154                                 const nsAString& aTopic) = 0;
 155   NS_IMETHOD GetTopicObservers(const nsAString& aTopic,
 156                                nsIObserverEntry** aEntry) = 0;
 157
 158   virtual nsresult CheckQName(const nsAString& aQName,
 159                               PRBool aNamespaceAware,
 160                               const PRUnichar** aColon) = 0;
 161   virtual PRBool IsXMLLetter(PRUnichar aChar) = 0;
 162   virtual PRBool IsXMLNCNameChar(PRUnichar aChar) = 0;
 163
 164   /**
 165    * Decodes an entity into a UTF-16 character. If a ; is found between aStart
 166    * and aEnd it will try to decode the entity and set aNext to point to the
 167    * character after the ;. The resulting UTF-16 character will be written in
 168    * aResult, so if the entity is a valid numeric entity there needs to be
 169    * space for at least two PRUnichars.
 170    *
 171    * @param aStart pointer to the character after the ampersand.
 172    * @param aEnd pointer to the position after the last character of the
 173    *             string.
 174    * @param aNext [out] will be set to the character after the ; or null if
 175    *                    the decoding was unsuccessful.
 176    * @param aResult the buffer to write the resulting UTF-16 character in.
 177    * @return the number of PRUnichars written to aResult.
 178    */
 179   virtual PRUint32 DecodeEntity(const PRUnichar* aStart, const PRUnichar* aEnd,
 180                                 const PRUnichar** aNext,
 181                                 PRUnichar* aResult) = 0;
 182 };
 183
 184 NS_DEFINE_STATIC_IID_ACCESSOR(nsIParserService, NS_IPARSERSERVICE_IID)
 185
 186 #endif // nsIParserService_h__