Back to index

lightning-sunbird  0.9+nobinonly
nsHTMLTokenizer.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.org 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  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 
00045 #ifndef __NSHTMLTOKENIZER
00046 #define __NSHTMLTOKENIZER
00047 
00048 #include "nsISupports.h"
00049 #include "nsITokenizer.h"
00050 #include "nsIDTD.h"
00051 #include "prtypes.h"
00052 #include "nsDeque.h"
00053 #include "nsScanner.h"
00054 #include "nsHTMLTokens.h"
00055 #include "nsDTDUtils.h"
00056 
00057 #define NS_HTMLTOKENIZER_IID      \
00058   {0xe4238ddd, 0x9eb6, 0x11d2, \
00059   {0xba, 0xa5, 0x0,     0x10, 0x4b, 0x98, 0x3f, 0xd4 }}
00060 
00061 /***************************************************************
00062   Notes: 
00063  ***************************************************************/
00064 
00065 #ifdef _MSC_VER
00066 #pragma warning( disable : 4275 )
00067 #endif
00068 
00069 class nsHTMLTokenizer : public nsITokenizer {
00070 public:
00071   
00072   NS_DECL_ISUPPORTS
00073   NS_DECL_NSITOKENIZER
00074   nsHTMLTokenizer(PRInt32 aParseMode = eDTDMode_quirks,
00075                   eParserDocType aDocType = eHTML3_Quirks,
00076                   eParserCommands aCommand = eViewNormal,
00077                   PRUint16 aFlags = 0);
00078   virtual ~nsHTMLTokenizer();
00079 
00080 protected:
00081 
00082   virtual nsresult ConsumeTag(PRUnichar aChar,CToken*& aToken,nsScanner& aScanner,PRBool& aFlushTokens);
00083   virtual nsresult ConsumeStartTag(PRUnichar aChar,CToken*& aToken,nsScanner& aScanner,PRBool& aFlushTokens);
00084   virtual nsresult ConsumeEndTag(PRUnichar aChar,CToken*& aToken,nsScanner& aScanner);
00085   virtual nsresult ConsumeAttributes(PRUnichar aChar, CToken* aToken, nsScanner& aScanner);
00086   virtual nsresult ConsumeEntity(PRUnichar aChar,CToken*& aToken,nsScanner& aScanner);
00087   virtual nsresult ConsumeWhitespace(PRUnichar aChar,CToken*& aToken,nsScanner& aScanner);
00088   virtual nsresult ConsumeComment(PRUnichar aChar,CToken*& aToken,nsScanner& aScanner);
00089   virtual nsresult ConsumeNewline(PRUnichar aChar,CToken*& aToken,nsScanner& aScanner);
00090   virtual nsresult ConsumeText(CToken*& aToken,nsScanner& aScanner);
00091   virtual nsresult ConsumeSpecialMarkup(PRUnichar aChar,CToken*& aToken,nsScanner& aScanner);
00092   virtual nsresult ConsumeProcessingInstruction(PRUnichar aChar,CToken*& aToken,nsScanner& aScanner);
00093 
00094   nsresult ScanDocStructure(PRBool aIsFinalChunk);
00095 
00096   static void AddToken(CToken*& aToken,nsresult aResult,nsDeque* aDeque,nsTokenAllocator* aTokenAllocator);
00097 
00098   nsDeque            mTokenDeque;
00099   PRPackedBool       mIsFinalChunk;
00100   nsTokenAllocator*  mTokenAllocator;
00101   // This variable saves the position of the last tag we inspected in
00102   // ScanDocStructure. We start scanning the general well-formedness of the
00103   // document starting at this position each time.
00104   PRInt32            mTokenScanPos;
00105   PRUint32           mFlags;
00106 };
00107 
00108 extern nsresult NS_NewHTMLTokenizer(nsITokenizer** aInstancePtrResult,
00109                                     PRInt32 aMode,eParserDocType aDocType,
00110                                     eParserCommands aCommand, PRInt32 aFlags);
00111 
00112 #endif
00113 
00114