Back to index

lightning-sunbird  0.9+nobinonly
nsITokenizer.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 __NSITOKENIZER__
00046 #define __NSITOKENIZER__
00047 
00048 #include "nsISupports.h"
00049 #include "prtypes.h"
00050 
00051 class CToken;
00052 class nsScanner;
00053 class nsDeque;
00054 class nsTokenAllocator;
00055 
00056 #define NS_ITOKENIZER_IID      \
00057   {0xe4238ddc, 0x9eb6,  0x11d2, {0xba, 0xa5, 0x0,     0x10, 0x4b, 0x98, 0x3f, 0xd4 }}
00058 
00063 class nsITokenObserver {
00064 public:
00065   virtual PRBool  operator()(CToken* aToken)=0;
00066 };
00067 
00068 /***************************************************************
00069   Notes: 
00070  ***************************************************************/
00071 
00072 
00073 class nsITokenizer : public nsISupports {
00074 public:
00075   NS_DEFINE_STATIC_IID_ACCESSOR(NS_ITOKENIZER_IID)
00076 
00077   NS_IMETHOD                     WillTokenize(PRBool aIsFinalChunk,nsTokenAllocator* aTokenAllocator)=0;
00078   NS_IMETHOD                     ConsumeToken(nsScanner& aScanner,PRBool& aFlushTokens)=0;
00079   NS_IMETHOD                     DidTokenize(PRBool aIsFinalChunk)=0;
00080   
00081   NS_IMETHOD_(CToken*)           PushTokenFront(CToken* aToken)=0;
00082   NS_IMETHOD_(CToken*)           PushToken(CToken* aToken)=0;
00083   NS_IMETHOD_(CToken*)           PopToken(void)=0;
00084   NS_IMETHOD_(CToken*)           PeekToken(void)=0;
00085   NS_IMETHOD_(CToken*)           GetTokenAt(PRInt32 anIndex)=0;
00086   NS_IMETHOD_(PRInt32)           GetCount(void)=0;
00087   NS_IMETHOD_(nsTokenAllocator*) GetTokenAllocator(void)=0;
00088   NS_IMETHOD_(void)              PrependTokens(nsDeque& aDeque)=0;
00089   NS_IMETHOD                     CopyState(nsITokenizer* aTokenizer)=0;
00090   
00091 };
00092 
00093 #define NS_DECL_NSITOKENIZER \
00094   NS_IMETHOD                     WillTokenize(PRBool aIsFinalChunk,nsTokenAllocator* aTokenAllocator);\
00095   NS_IMETHOD                     ConsumeToken(nsScanner& aScanner,PRBool& aFlushTokens);\
00096   NS_IMETHOD                     DidTokenize(PRBool aIsFinalChunk);\
00097   NS_IMETHOD_(CToken*)           PushTokenFront(CToken* aToken);\
00098   NS_IMETHOD_(CToken*)           PushToken(CToken* aToken);\
00099   NS_IMETHOD_(CToken*)           PopToken(void);\
00100   NS_IMETHOD_(CToken*)           PeekToken(void);\
00101   NS_IMETHOD_(CToken*)           GetTokenAt(PRInt32 anIndex);\
00102   NS_IMETHOD_(PRInt32)           GetCount(void);\
00103   NS_IMETHOD_(nsTokenAllocator*) GetTokenAllocator(void);\
00104   NS_IMETHOD_(void)              PrependTokens(nsDeque& aDeque);\
00105   NS_IMETHOD                     CopyState(nsITokenizer* aTokenizer);
00106 
00107 
00108 #endif