364 lines
12 KiB
C++
364 lines
12 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.1 (the "License"); you may not use this file
|
|
* except in compliance with the License. You may obtain a copy of
|
|
* the License at http://www.mozilla.org/NPL/
|
|
*
|
|
* Software distributed under the License is distributed on an "AS
|
|
* IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
|
|
* implied. See the License for the specific language governing
|
|
* rights and limitations under the License.
|
|
*
|
|
* The Original Code is mozilla.org code.
|
|
*
|
|
* The Initial Developer of the Original Code is Netscape
|
|
* Communications Corporation. Portions created by Netscape are
|
|
* Copyright (C) 1998 Netscape Communications Corporation. All
|
|
* Rights Reserved.
|
|
*
|
|
* Contributor(s):
|
|
*/
|
|
|
|
/**
|
|
* MODULE NOTES:
|
|
* @update gess 7/15/98
|
|
*
|
|
* NavDTD is an implementation of the nsIDTD interface.
|
|
* In particular, this class captures the behaviors of the original
|
|
* Navigator parser productions.
|
|
*
|
|
* This DTD, like any other in NGLayout, provides a few basic services:
|
|
* - First, the DTD collaborates with the Parser class to convert plain
|
|
* text into a sequence of HTMLTokens.
|
|
* - Second, the DTD describes containment rules for known elements.
|
|
* - Third the DTD controls and coordinates the interaction between the
|
|
* parsing system and content sink. (The content sink is the interface
|
|
* that serves as a proxy for content model).
|
|
* - Fourth the DTD maintains an internal style-stack to handle residual (leaky)
|
|
* style tags.
|
|
*
|
|
* You're most likely working in this class file because
|
|
* you want to add or change a behavior inherent in this DTD. The remainder
|
|
* of this section will describe what you need to do to affect the kind of
|
|
* change you want in this DTD.
|
|
*
|
|
* RESIDUAL-STYLE HANDLNG:
|
|
* There are a number of ways to represent style in an HTML document.
|
|
* 1) explicit style tags (<B>, <I> etc)
|
|
* 2) implicit styles (like those implicit in <Hn>)
|
|
* 3) CSS based styles
|
|
*
|
|
* Residual style handling results from explicit style tags that are
|
|
* not closed. Consider this example: <p>text <b>bold </p>
|
|
* When the <p> tag closes, the <b> tag is NOT automatically closed.
|
|
* Unclosed style tags are handled by the process we call residual-style
|
|
* tag handling.
|
|
*
|
|
* There are two aspects to residual style tag handling. The first is the
|
|
* construction and managing of a stack of residual style tags. The
|
|
* second is the automatic emission of residual style tags onto leaf content
|
|
* in subsequent portions of the document.This step is necessary to propagate
|
|
* the expected style behavior to subsequent portions of the document.
|
|
*
|
|
* Construction and managing the residual style stack is an inline process that
|
|
* occurs during the model building phase of the parse process. During the model-
|
|
* building phase of the parse process, a content stack is maintained which tracks
|
|
* the open container hierarchy. If a style tag(s) fails to be closed when a normal
|
|
* container is closed, that style tag is placed onto the residual style stack. If
|
|
* that style tag is subsequently closed (in most contexts), it is popped off the
|
|
* residual style stack -- and are of no further concern.
|
|
*
|
|
* Residual style tag emission occurs when the style stack is not empty, and leaf
|
|
* content occurs. In our earlier example, the <b> tag "leaked" out of the <p>
|
|
* container. Just before the next leaf is emitted (in this or another container) the
|
|
* style tags that are on the stack are emitted in succession. These same residual
|
|
* style tags get closed automatically when the leaf's container closes, or if a
|
|
* child container is opened.
|
|
*
|
|
*
|
|
*/
|
|
#ifndef NS_OTHERDTD__
|
|
#define NS_OTHERDTD__
|
|
|
|
#include "nsIDTD.h"
|
|
#include "nsISupports.h"
|
|
#include "nsIParser.h"
|
|
#include "nsHTMLTokens.h"
|
|
#include "nshtmlpars.h"
|
|
#include "nsVoidArray.h"
|
|
#include "nsDeque.h"
|
|
#include "nsParserCIID.h"
|
|
|
|
|
|
#define NS_IOTHERHTML_DTD_IID \
|
|
{0x8a5e89c0, 0xd16d, 0x11d1, \
|
|
{0x80, 0x22, 0x00, 0x60, 0x8, 0x14, 0x98, 0x89}}
|
|
|
|
class nsIHTMLContentSink;
|
|
class nsIDTDDebug;
|
|
class nsIParserNode;
|
|
class nsParser;
|
|
class nsDTDContext;
|
|
class nsEntryStack;
|
|
class nsITokenizer;
|
|
class nsCParserNode;
|
|
class CTokenRecycler;
|
|
|
|
/***************************************************************
|
|
Now the main event: COtherDTD.
|
|
|
|
This not so simple class performs all the duties of token
|
|
construction and model building. It works in conjunction with
|
|
an nsParser.
|
|
***************************************************************/
|
|
|
|
#if defined(XP_PC)
|
|
#pragma warning( disable : 4275 )
|
|
#endif
|
|
|
|
CLASS_EXPORT_HTMLPARS COtherDTD : public nsIDTD {
|
|
|
|
#if defined(XP_PC)
|
|
#pragma warning( default : 4275 )
|
|
#endif
|
|
|
|
public:
|
|
/**
|
|
* Common constructor for navdtd. You probably want to call
|
|
* NS_NewNavHTMLDTD().
|
|
*
|
|
* @update gess 7/9/98
|
|
*/
|
|
COtherDTD();
|
|
|
|
/**
|
|
* Virtual destructor -- you know what to do
|
|
* @update gess 7/9/98
|
|
*/
|
|
virtual ~COtherDTD();
|
|
|
|
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);
|
|
|
|
|
|
NS_DECL_ISUPPORTS
|
|
|
|
/**
|
|
* This method is called to determine if the given DTD can parse
|
|
* a document of a given source-type.
|
|
* Note that parsing assumes that the end result will always be stored
|
|
* in the main content model. Of course, it's up to you which content-
|
|
* model you pass in to the parser, so you can always control the process.
|
|
*
|
|
* @update gess 7/15/98
|
|
* @param aContentType contains the name of a filetype that you are
|
|
* being asked to parse).
|
|
* @return TRUE if this DTD parse the given type; FALSE otherwise.
|
|
*/
|
|
virtual eAutoDetectResult CanParse(CParserContext& aParserContext,nsString& aBuffer, PRInt32 aVersion);
|
|
|
|
/**
|
|
* 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);
|
|
|
|
|
|
/**
|
|
* The parser uses a code sandwich to wrap the parsing process. Before
|
|
* the process begins, WillBuildModel() is called. Afterwards the parser
|
|
* calls DidBuildModel().
|
|
* @update rickg 03.20.2000
|
|
* @param aParserContext
|
|
* @param aSink
|
|
* @return error code (almost always 0)
|
|
*/
|
|
NS_IMETHOD WillBuildModel( const CParserContext& aParserContext,nsIContentSink* aSink);
|
|
|
|
/**
|
|
* 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,PRBool aNotifySink,nsIParser* aParser,nsIContentSink* aSink=0);
|
|
|
|
/**
|
|
* This method is called by the parser, once for each token
|
|
* that has been constructed during the tokenization phase.
|
|
* @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);
|
|
|
|
/**
|
|
*
|
|
* @update gess12/28/98
|
|
* @param
|
|
* @return
|
|
*/
|
|
NS_IMETHOD GetTokenizer(nsITokenizer*& aTokenizer);
|
|
|
|
/**
|
|
* Note that the otherDTD get's it's recycler from
|
|
* the body context.
|
|
*
|
|
* @update rickg 16June2000
|
|
* @return always 0
|
|
*/
|
|
virtual nsITokenRecycler* GetTokenRecycler(void) {return 0;}
|
|
|
|
/**
|
|
* If the parse process gets interrupted, this method gets called
|
|
* prior to the process resuming.
|
|
* @update gess5/18/98
|
|
* @return error code -- usually NS_OK (0)
|
|
*/
|
|
NS_IMETHOD WillResumeParse(void);
|
|
|
|
/**
|
|
* If the parse process is about to be interrupted, this method
|
|
* will be called just prior.
|
|
* @update gess5/18/98
|
|
* @return error code -- usually NS_OK (0)
|
|
*/
|
|
NS_IMETHOD WillInterruptParse(void);
|
|
|
|
/**
|
|
* 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;
|
|
|
|
/**
|
|
* Use this id you want to stop the building content model
|
|
* --------------[ Sets DTD to STOP mode ]----------------
|
|
* It's recommended to use this method in accordance with
|
|
* the parser's terminate() method.
|
|
*
|
|
* @update harishd 07/22/99
|
|
* @param
|
|
* @return
|
|
*/
|
|
virtual nsresult Terminate(nsIParser* aParser=nsnull) { return mDTDState=NS_ERROR_HTMLPARSER_STOPPARSING; }
|
|
|
|
/**
|
|
* Give rest of world access to our tag enums, so that CanContain(), etc,
|
|
* become useful.
|
|
*/
|
|
NS_IMETHOD StringTagToIntTag(nsString &aTag, PRInt32* aIntTag) const;
|
|
|
|
NS_IMETHOD IntTagToStringTag(PRInt32 aIntTag, nsString& aTag) const;
|
|
|
|
NS_IMETHOD ConvertEntityToUnicode(const nsString& aEntity, PRInt32* aUnicode) const;
|
|
|
|
virtual PRBool IsBlockElement(PRInt32 aTagID,PRInt32 aParentID) const;
|
|
virtual PRBool IsInlineElement(PRInt32 aTagID,PRInt32 aParentID) const;
|
|
|
|
/**
|
|
* The following set of methods are used to partially construct
|
|
* the content model (via the sink) according to the type of token.
|
|
* @update gess5/11/98
|
|
* @param aToken is the token (of a given type) to be handled
|
|
* @return error code representing construction state; usually 0.
|
|
*/
|
|
nsresult HandleStartToken(CToken* aToken);
|
|
nsresult HandleEndToken(CToken* aToken);
|
|
nsresult HandleEntityToken(CToken* aToken);
|
|
|
|
//*************************************************
|
|
//these cover methods mimic the sink, and are used
|
|
//by the parser to manage its context-stack.
|
|
//*************************************************
|
|
|
|
static void ReleaseTable(void);
|
|
|
|
protected:
|
|
|
|
nsresult CollectAttributes(nsCParserNode& aNode,eHTMLTags aTag,PRInt32 aCount);
|
|
nsresult WillHandleStartTag(CToken* aToken,eHTMLTags aChildTag,nsCParserNode& aNode);
|
|
nsresult DidHandleStartTag(nsCParserNode& aNode,eHTMLTags aChildTag);
|
|
nsCParserNode* CreateNode(void);
|
|
|
|
nsIHTMLContentSink* mSink;
|
|
|
|
nsDTDContext* mBodyContext;
|
|
PRBool mHasOpenForm;
|
|
PRBool mHasOpenMap;
|
|
PRInt32 mHasOpenHead;
|
|
PRBool mHasOpenBody;
|
|
PRBool mHadFrameset;
|
|
PRBool mHadBody;
|
|
nsString mFilename;
|
|
nsIDTDDebug* mDTDDebug;
|
|
PRInt32 mLineNumber;
|
|
nsParser* mParser;
|
|
nsITokenizer* mTokenizer;
|
|
PRBool mHasOpenScript;
|
|
eHTMLTags mSkipTarget;
|
|
nsDeque mSharedNodes;
|
|
nsresult mDTDState;
|
|
nsDTDMode mDTDMode;
|
|
eParserCommands mParserCommand; //tells us to viewcontent/viewsource/viewerrors...
|
|
|
|
PRUint32 mComputedCRC32;
|
|
PRUint32 mExpectedCRC32;
|
|
nsAutoString mScratch; //used for various purposes; non-persistent
|
|
eParserDocType mDocType;
|
|
PRBool mEnableStrict;
|
|
|
|
#ifdef NS_DEBUG
|
|
PRInt32 gNodeCount;
|
|
#endif
|
|
|
|
};
|
|
|
|
extern NS_HTMLPARS nsresult NS_NewOtherHTMLDTD(nsIDTD** aInstancePtrResult);
|
|
|
|
|
|
|
|
#endif //NS_OTHERDTD__
|
|
|
|
|
|
|