parser/htmlparser/src/nsLoggingSink.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is Mozilla Communicator client code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #ifndef NS_LOGGING_SINK_H__
  39 #define NS_LOGGING_SINK_H__
  40
  41 #include "nsILoggingSink.h"
  42 #include "nsIParser.h"
  43
  44 class nsLoggingSink : public nsILoggingSink {
  45 public:
  46   nsLoggingSink();
  47   virtual ~nsLoggingSink();
  48
  49   void SetProxySink(nsIHTMLContentSink *aSink) {
  50     mSink=aSink;
  51   }
  52
  53   void ReleaseProxySink() {
  54     NS_IF_RELEASE(mSink);
  55     mSink=0;
  56   }
  57
  58
  59   // nsISupports
  60   NS_DECL_ISUPPORTS
  61
  62   // nsIContentSink
  63   NS_IMETHOD WillParse();
  64   NS_IMETHOD WillBuildModel();
  65   NS_IMETHOD DidBuildModel();
  66   NS_IMETHOD WillInterrupt();
  67   NS_IMETHOD WillResume();
  68   NS_IMETHOD SetParser(nsIParser* aParser);
  69   NS_IMETHOD OpenContainer(const nsIParserNode& aNode);
  70   NS_IMETHOD CloseContainer(const nsHTMLTag aTag);
  71   NS_IMETHOD AddLeaf(const nsIParserNode& aNode);
  72   NS_IMETHOD AddComment(const nsIParserNode& aNode);
  73   NS_IMETHOD AddProcessingInstruction(const nsIParserNode& aNode);
  74   NS_IMETHOD AddDocTypeDecl(const nsIParserNode& aNode);
  75   virtual void FlushPendingNotifications(mozFlushType aType) { }
  76   NS_IMETHOD SetDocumentCharset(nsACString& aCharset) { return NS_OK; }
  77   virtual nsISupports *GetTarget() { return nsnull; }
  78
  79   // nsIHTMLContentSink
  80   NS_IMETHOD OpenHead();
  81   NS_IMETHOD IsEnabled(PRInt32 aTag, PRBool* aReturn)
  82   /* Take the largest possible feature set. */
  83   { NS_ENSURE_ARG_POINTER(aReturn); *aReturn = PR_TRUE; return NS_OK; }
  84   NS_IMETHOD NotifyTagObservers(nsIParserNode* aNode) { return NS_OK; }
  85   NS_IMETHOD_(PRBool) IsFormOnStack() { return PR_FALSE; }
  86
  87   NS_IMETHOD BeginContext(PRInt32 aPosition);
  88   NS_IMETHOD EndContext(PRInt32 aPosition);
  89   NS_IMETHOD DidProcessTokens(void) { return NS_OK; }
  90   NS_IMETHOD WillProcessAToken(void) { return NS_OK; }
  91   NS_IMETHOD DidProcessAToken(void) { return NS_OK; }
  92
  93   // nsILoggingSink
  94   NS_IMETHOD SetOutputStream(PRFileDesc *aStream,PRBool autoDelete=PR_FALSE);
  95
  96   nsresult OpenNode(const char* aKind, const nsIParserNode& aNode);
  97   nsresult CloseNode(const char* aKind);
  98   nsresult LeafNode(const nsIParserNode& aNode);
  99   nsresult WriteAttributes(const nsIParserNode& aNode);
 100   nsresult QuoteText(const nsAString& aValue, nsString& aResult);
 101   nsresult GetNewCString(const nsAString& aValue, char** aResult);
 102   PRBool WillWriteAttributes(const nsIParserNode& aNode);
 103
 104 protected:
 105   PRFileDesc          *mOutput;
 106   int                  mLevel;
 107   nsIHTMLContentSink  *mSink;
 108   PRBool               mAutoDeleteOutput;
 109   nsIParser*           mParser;
 110 };
 111
 112 #endif
 113