Back to index

lightning-sunbird  0.9+nobinonly
nsIMAPGenericParser.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 4; 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) 1999
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 /* 
00039 nsIMAPGenericParser is the base parser class used by the server parser and body shell parser
00040 */ 
00041 
00042 #ifndef nsIMAPGenericParser_H
00043 #define nsIMAPGenericParser_H
00044 
00045 #include "nsImapCore.h"
00046 
00047 #define WHITESPACE " \015\012"     // token delimiter 
00048 
00049 
00050 class nsIMAPGenericParser 
00051 {
00052 
00053 public:
00054        nsIMAPGenericParser();
00055        virtual ~nsIMAPGenericParser();
00056 
00057   // Add any specific stuff in the derived class
00058   virtual PRBool     LastCommandSuccessful();
00059 
00060   PRBool SyntaxError() { return (fParserState & stateSyntaxErrorFlag) != 0; }
00061   PRBool ContinueParse() { return fParserState == stateOK; }
00062   PRBool Connected() { return !(fParserState & stateDisconnectedFlag); }
00063   void SetConnected(PRBool error);
00064     
00065 protected:
00066 
00067        // This is a pure virtual member which must be overridden in the derived class
00068        // for each different implementation of a nsIMAPGenericParser.
00069        // For instance, one implementation (the nsIMAPServerState) might get the next line
00070        // from an open socket, whereas another implementation might just get it from a buffer somewhere.
00071        // This fills in nextLine with the buffer, and returns PR_TRUE if everything is OK.
00072        // Returns PR_FALSE if there was some error encountered.  In that case, we reset the parser.
00073        virtual PRBool       GetNextLineForParser(char **nextLine) = 0;       
00074 
00075   virtual void       HandleMemoryFailure();
00076   void skip_to_CRLF();
00077   void skip_to_close_paren();
00078   char *CreateString();
00079   char *CreateAstring();
00080   char *CreateNilString();
00081   char *CreateLiteral();
00082   char *CreateAtom(PRBool isAstring = PR_FALSE);
00083   char *CreateQuoted(PRBool skipToEnd = PR_TRUE);
00084   char *CreateParenGroup();
00085   virtual void SetSyntaxError(PRBool error, const char *msg);
00086 
00087   void AdvanceToNextToken();
00088   void AdvanceToNextLine();
00089   void AdvanceTokenizerStartingPoint(int32 bytesToAdvance);
00090   void ResetLexAnalyzer();
00091 
00092 protected:
00093        // use with care
00094   char           *fNextToken;
00095   char           *fCurrentLine;
00096        char                                *fLineOfTokens;
00097   char           *fStartOfLineOfTokens;
00098   char           *fCurrentTokenPlaceHolder;
00099   PRBool          fAtEndOfLine;
00100 
00101 private:
00102   enum nsIMAPGenericParserState { stateOK = 0,
00103                                   stateSyntaxErrorFlag = 0x1,
00104                                   stateDisconnectedFlag = 0x2 };
00105   PRUint32 fParserState;
00106 };
00107 
00108 #endif