Mozilla/mozilla/parser/htmlparser/src/nsHTMLContentSinkStream.h

/* -*- 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  gpk 7/12/98
 * 
 * This file declares the concrete HTMLContentSink class.
 * This class is used during the parsing process as the
 * primary interface between the parser and the content
 * model.
 * This content sink writes to a stream. If no stream
   is declared in the constructor then all output goes
   to cout.
   The file is pretty printed according to the pretty
   printing interface. subclasses may choose to override
   this behavior or set runtime flags for desired
   resutls.
 */

#ifndef  NS_HTMLCONTENTSINK_STREAM
#define  NS_HTMLCONTENTSINK_STREAM

#include "nsIParserNode.h"
#include "nsIHTMLContentSink.h"
#include "nshtmlpars.h"
#include "nsHTMLTokens.h"


#define NS_HTMLCONTENTSINK_STREAM_IID  \
  {0xa39c6bff, 0x15f0, 0x11d2, \
  {0x80, 0x41, 0x0, 0x10, 0x4b, 0x98, 0x3f, 0xd4}}



class ostream;

class nsHTMLContentSinkStream : public nsIHTMLContentSink {
  public:

  /**
   * 
   * @update	gess7/7/98
   * @param 
   * @return
   */
  nsHTMLContentSinkStream(); 

  /**
   * 
   * @update	gess7/7/98
   * @param 
   * @return
   */
  nsHTMLContentSinkStream(ostream& aStream); 

  /**
   * 
   * @update	gess7/7/98
   * @param 
   * @return
   */
  virtual ~nsHTMLContentSinkStream();

  // nsISupports
  NS_DECL_ISUPPORTS
 
  // nsIContentSink
  NS_IMETHOD WillBuildModel(void);
  NS_IMETHOD DidBuildModel(PRInt32 aQualityLevel);
  NS_IMETHOD WillInterrupt(void);
  NS_IMETHOD WillResume(void);
  NS_IMETHOD OpenContainer(const nsIParserNode& aNode);
  NS_IMETHOD CloseContainer(const nsIParserNode& aNode);
  NS_IMETHOD AddLeaf(const nsIParserNode& aNode);

  // nsIHTMLContentSink
  NS_IMETHOD PushMark();
  NS_IMETHOD SetTitle(const nsString& aValue);
  NS_IMETHOD OpenHTML(const nsIParserNode& aNode);
  NS_IMETHOD CloseHTML(const nsIParserNode& aNode);
  NS_IMETHOD OpenHead(const nsIParserNode& aNode);
  NS_IMETHOD CloseHead(const nsIParserNode& aNode);
  NS_IMETHOD OpenBody(const nsIParserNode& aNode);
  NS_IMETHOD CloseBody(const nsIParserNode& aNode);
  NS_IMETHOD OpenForm(const nsIParserNode& aNode);
  NS_IMETHOD CloseForm(const nsIParserNode& aNode);
  NS_IMETHOD OpenMap(const nsIParserNode& aNode);
  NS_IMETHOD CloseMap(const nsIParserNode& aNode);
  NS_IMETHOD OpenFrameset(const nsIParserNode& aNode);
  NS_IMETHOD CloseFrameset(const nsIParserNode& aNode);

  /**
   * 
   * @update	gess7/7/98
   * @param 
   * @return
   */
  void SetOutputStream(ostream& aStream);

public:
  void SetLowerCaseTags(PRBool aDoLowerCase) { mLowerCaseTags = aDoLowerCase; }
    

protected:

    nsresult AddLeaf(const nsIParserNode& aNode, ostream& aStream);
    void WriteAttributes(const nsIParserNode& aNode,ostream& aStream);
    void AddStartTag(const nsIParserNode& aNode, ostream& aStream);
    void AddEndTag(const nsIParserNode& aNode, ostream& aStream);

    PRBool IsInline(eHTMLTags aTag) const;
    PRBool IsBlockLevel(eHTMLTags aTag) const;

    void AddIndent(ostream& aStream);


    /**
      * Desired line break state before the open tag.
      */
    PRInt32 BreakBeforeOpen(eHTMLTags aTag) const;

    /**
      * Desired line break state after the open tag.
      */
    PRInt32 BreakAfterOpen(eHTMLTags aTag) const;

    /**
      * Desired line break state before the close tag.
      */
    PRInt32 BreakBeforeClose(eHTMLTags aTag) const;

    /**
      * Desired line break state after the close tag.
      */
    PRInt32 BreakAfterClose(eHTMLTags aTag) const;

    /**
      * Indent/outdent when the open/close tags are encountered.
      * This implies that breakAfterOpen() and breakBeforeClose()
      * are PR_TRUE no matter what those methods return.
      */
    PRBool IndentChildren(eHTMLTags aTag) const;

    /**
      * All tags after this tag and before the closing tag will be output with no
      * formatting.
      */
    PRBool PreformattedChildren(eHTMLTags aTag) const;

    /**
      * Eat the close tag.  Pretty much just for <P*>.
      */
    PRBool EatOpen(eHTMLTags aTag) const;

    /**
      * Eat the close tag.  Pretty much just for </P>.
      */
    PRBool EatClose(eHTMLTags aTag) const;

    /**
      * Are we allowed to insert new white space before the open tag.
      *
      * Returning PR_FALSE does not prevent inserting WS
      * before the tag if WS insertion is allowed for another reason,
      * e.g. there is already WS there or we are after a tag that
      * has PermitWSAfter*().
      */
    PRBool PermitWSBeforeOpen(eHTMLTags aTag) const;

    /** @see PermitWSBeforeOpen */
    PRBool PermitWSAfterOpen(eHTMLTags aTag) const;

    /** @see PermitWSBeforeOpen */
    PRBool PermitWSBeforeClose(eHTMLTags aTag) const;

    /** @see PermitWSBeforeOpen */
    PRBool PermitWSAfterClose(eHTMLTags aTag) const;

    /** Certain structures allow us to ignore the whitespace from the source 
      * document */
    PRBool IgnoreWS(eHTMLTags aTag) const;


protected:
    ostream*  mOutput;
    int       mTabLevel;

    PRInt32   mIndent;
    PRBool    mLowerCaseTags;
    PRInt32   mHTMLStackPos;
    eHTMLTags mHTMLTagStack[1024];  // warning: hard-coded nesting level
    PRInt32   mColPos;


};

extern NS_HTMLPARS nsresult
NS_New_HTML_ContentSinkStream(nsIHTMLContentSink** aInstancePtrResult);


#endif