gecko-dev/htmlparser/src/CRtfDTD.h
1999-01-26 01:24:31 +00:00

362 lines
8.9 KiB
C++

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/*
* The contents of this file are subject to the Netscape Public License
* Version 1.0 (the "NPL"); you may not use this file except in
* compliance with the NPL. You may obtain a copy of the NPL at
* http://www.mozilla.org/NPL/
*
* Software distributed under the NPL is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
* for the specific language governing rights and limitations under the
* NPL.
*
* The Initial Developer of this code under the NPL is Netscape
* Communications Corporation. Portions created by Netscape are
* Copyright (C) 1998 Netscape Communications Corporation. All Rights
* Reserved.
*/
/**
* MODULE NOTES:
* @update gess 4/8/98
*
*
*/
#ifndef NS_RTFDTD__
#define NS_RTFDTD__
#include "nsIDTD.h"
#include "nsISupports.h"
#include "nsHTMLTokens.h"
#include "nshtmlpars.h"
#include "nsVoidArray.h"
#include "nsDeque.h"
#define NS_RTF_DTD_IID \
{0xa39c6bfc, 0x15f0, 0x11d2, \
{0x80, 0x41, 0x00, 0x10, 0x4b, 0x98, 0x3f, 0xd4}}
class nsIParserNode;
class nsParser;
class nsITokenizer;
enum eRTFTokenTypes {
eRTFToken_unknown=0,
eRTFToken_group, // '{'
eRTFToken_controlword, // '\'
eRTFToken_content, // contains all document content
//everything else is just text or attributes of controls...
eRTFToken_last //make sure this stays the last token...
};
enum eRTFTags {
eRTFCtrl_unknown=0,
eRTFCtrl_quote,
eRTFCtrl_star,
eRTFCtrl_linefeed,
eRTFCtrl_return,
eRTFCtrl_begincontrol,
eRTFCtrl_bold,
eRTFCtrl_bin,
eRTFCtrl_blue,
eRTFCtrl_cols,
eRTFCtrl_comment,
eRTFCtrl_italic,
eRTFCtrl_font,
eRTFCtrl_fonttable,
eRTFCtrl_green,
eRTFCtrl_bottommargin,
eRTFCtrl_leftmargin,
eRTFCtrl_rightmargin,
eRTFCtrl_topmargin,
eRTFCtrl_par,
eRTFCtrl_pard,
eRTFCtrl_plain,
eRTFCtrl_justified,
eRTFCtrl_fulljustified,
eRTFCtrl_leftjustified,
eRTFCtrl_rightjustified,
eRTFCtrl_rdoublequote,
eRTFCtrl_red,
eRTFCtrl_rtf,
eRTFCtrl_tab,
eRTFCtrl_title,
eRTFCtrl_underline,
eRTFCtrl_startgroup,
eRTFCtrl_endgroup,
eRTFCtrl_last //make sure this stays the last token...
};
/**
*
* @update gess7/8/98
* @param
* @return
*/
class CRTFControlWord : public CToken {
public:
CRTFControlWord(char* aKey);
virtual PRInt32 GetTokenType();
virtual PRInt32 Consume(nsScanner& aScanner);
protected:
nsString mArgument;
};
/**
*
* @update gess7/8/98
* @param
* @return
*/
class CRTFGroup: public CToken {
public:
CRTFGroup(char* aKey,PRBool aStartGroup);
virtual PRInt32 GetTokenType();
virtual void SetGroupStart(PRBool aFlag);
virtual PRBool IsGroupStart();
virtual PRInt32 Consume(nsScanner& aScanner);
protected:
PRBool mStart;
};
/**
*
* @update gess7/8/98
* @param
* @return
*/
class CRTFContent: public CToken {
public:
CRTFContent(PRUnichar* aValue);
virtual PRInt32 GetTokenType();
virtual PRInt32 Consume(nsScanner& aScanner);
};
class CRtfDTD : public nsIDTD {
public:
NS_DECL_ISUPPORTS
/**
*
*
* @update gess 4/9/98
* @param
* @return
*/
CRtfDTD();
/**
*
*
* @update gess 4/9/98
* @param
* @return
*/
virtual ~CRtfDTD();
virtual const nsIID& GetMostDerivedIID(void) const;
/**
* Call this method if you want the DTD to construct a clone of itself.
* @update gess7/23/98
* @param
* @return
*/
virtual nsresult CreateNewInstance(nsIDTD** aInstancePtrResult);
/**
* This method is called to determine if the given DTD can parse
* a document in a given source-type.
* NOTE: Parsing always assumes that the end result will involve
* storing the result in the main content model.
* @update gess6/24/98
* @param
* @return TRUE if this DTD can satisfy the request; FALSE otherwise.
*/
virtual PRBool CanParse(nsString& aContentType, nsString& aCommand, PRInt32 aVersion);
/**
*
* @update gess7/7/98
* @param
* @return
*/
virtual eAutoDetectResult AutoDetectContentType(nsString& aBuffer,nsString& aType);
/**
* The parser uses a code sandwich to wrap the parsing process. Before
* the process begins, WillBuildModel() is called. Afterwards the parser
* calls DidBuildModel().
* @update gess5/18/98
* @param aFilename is the name of the file being parsed.
* @return error code (almost always 0)
*/
NS_IMETHOD WillBuildModel(nsString& aFilename,PRInt32 aLevel,nsIParser* aParser,nsIContentSink* aSink=0);
/**
* The parser uses a code sandwich to wrap the parsing process. Before
* the process begins, WillBuildModel() is called. Afterwards the parser
* calls DidBuildModel().
* @update gess5/18/98
* @param aFilename is the name of the file being parsed.
* @return error code (almost always 0)
*/
NS_IMETHOD BuildModel(nsIParser* aParser,nsITokenizer* aTokenizer,nsITokenObserver* anObserver=0,nsIContentSink* aSink=0);
/**
* The parser uses a code sandwich to wrap the parsing process. Before
* the process begins, WillBuildModel() is called. Afterwards the parser
* calls DidBuildModel().
* @update gess5/18/98
* @param anErrorCode contans the last error that occured
* @return error code
*/
NS_IMETHOD DidBuildModel(nsresult anErrorCode,PRInt32 aLevel,nsIParser* aParser,nsIContentSink* aSink=0);
/**
*
* @update gess 3/25/98
* @param aToken -- token object to be put into content model
* @return 0 if all is well; non-zero is an error
*/
NS_IMETHOD HandleGroup(CToken* aToken);
/**
*
* @update gess 3/25/98
* @param aToken -- token object to be put into content model
* @return 0 if all is well; non-zero is an error
*/
NS_IMETHOD HandleControlWord(CToken* aToken);
/**
*
* @update gess 3/25/98
* @param aToken -- token object to be put into content model
* @return 0 if all is well; non-zero is an error
*/
NS_IMETHOD HandleContent(CToken* aToken);
/**
*
* @update gess 3/25/98
* @param aToken -- token object to be put into content model
* @return 0 if all is well; non-zero is an error
*/
NS_IMETHOD HandleToken(CToken* aToken,nsIParser* aParser);
/**
* This method causes all tokens to be dispatched to the given tag handler.
*
* @update gess 3/25/98
* @param aHandler -- object to receive subsequent tokens...
* @return error code (usually 0)
*/
NS_IMETHOD CaptureTokenPump(nsITagHandler* aHandler);
/**
* This method releases the token-pump capture obtained in CaptureTokenPump()
*
* @update gess 3/25/98
* @param aHandler -- object that received tokens...
* @return error code (usually 0)
*/
NS_IMETHOD ReleaseTokenPump(nsITagHandler* aHandler);
/**
*
* @update gess12/28/98
* @param
* @return
*/
nsITokenizer* GetTokenizer(void);
/**
*
* @update gess5/18/98
* @param
* @return
*/
NS_IMETHOD WillResumeParse(void);
/**
*
* @update gess5/18/98
* @param
* @return
*/
NS_IMETHOD WillInterruptParse(void);
/**
* Called by the parser to initiate dtd verification of the
* internal context stack.
* @update gess 7/23/98
* @param
* @return
*/
virtual PRBool Verify(nsString& aURLRef,nsIParser* aParser);
/**
* Set this to TRUE if you want the DTD to verify its
* context stack.
* @update gess 7/23/98
* @param
* @return
*/
virtual void SetVerification(PRBool aEnable);
/**
* This method is called to determine whether or not a tag
* of one type can contain a tag of another type.
*
* @update gess 3/25/98
* @param aParent -- int tag of parent container
* @param aChild -- int tag of child container
* @return PR_TRUE if parent can contain child
*/
virtual PRBool CanContain(PRInt32 aParent,PRInt32 aChild) const;
/**
* This method gets called to determine whether a given
* tag is itself a container
*
* @update gess 3/25/98
* @param aTag -- tag to test for containership
* @return PR_TRUE if given tag can contain other tags
*/
virtual PRBool IsContainer(PRInt32 aTag) const;
/**
* Retrieve a ptr to the global token recycler...
* @update gess8/4/98
* @return ptr to recycler (or null)
*/
virtual nsITokenRecycler* GetTokenRecycler(void);
protected:
nsParser* mParser;
char* mFilename;
nsITokenizer* mTokenizer;
};
extern NS_HTMLPARS nsresult NS_NewRTF_DTD(nsIDTD** aInstancePtrResult);
#endif