parser/htmlparser/public/nsIContentSink.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  *   Henri Sivonen <hsivonen@iki.fi>
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either of the GNU General Public License Version 2 or later (the "GPL"),
  27  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38 #ifndef nsIContentSink_h___
  39 #define nsIContentSink_h___
  40
  41 /**
  42  * MODULE NOTES:
  43  * @update  gess 4/1/98
  44  *
  45  * This pure virtual interface is used as the "glue" that connects the parsing
  46  * process to the content model construction process.
  47  *
  48  * The icontentsink interface is a very lightweight wrapper that represents the
  49  * content-sink model building process. There is another one that you may care
  50  * about more, which is the IHTMLContentSink interface. (See that file for details).
  51  */
  52 #include "nsISupports.h"
  53 #include "nsStringGlue.h"
  54 #include "mozFlushType.h"
  55
  56 class nsIParser;
  57
  58 #define NS_ICONTENT_SINK_IID \
  59 { 0x94ec4df1, 0x6885, 0x4b1f, \
  60  { 0x85, 0x10, 0xe3, 0x5f, 0x4f, 0x36, 0xea, 0xaa } }
  61
  62 class nsIContentSink : public nsISupports {
  63 public:
  64
  65   NS_DECLARE_STATIC_IID_ACCESSOR(NS_ICONTENT_SINK_IID)
  66
  67   /**
  68    * This method gets called before the nsParser calls tokenize.
  69    * This is needed because the XML side actually builds
  70    * the content model as part of the tokenization and
  71    * not on BuildModel(). The XML side can use this call
  72    * to do stuff that the HTML side does in WillProcessTokens().
  73    *
  74    * @update 2006-10-17 hsivonen
  75    */
  76   NS_IMETHOD WillTokenize(void)=0;
  77
  78   /**
  79    * This method gets called when the parser begins the process
  80    * of building the content model via the content sink.
  81    *
  82    * @update 5/7/98 gess
  83    */
  84   NS_IMETHOD WillBuildModel(void)=0;
  85
  86   /**
  87    * This method gets called when the parser concludes the process
  88    * of building the content model via the content sink.
  89    *
  90    * @update 5/7/98 gess
  91    */
  92   NS_IMETHOD DidBuildModel()=0;
  93
  94   /**
  95    * This method gets called when the parser gets i/o blocked,
  96    * and wants to notify the sink that it may be a while before
  97    * more data is available.
  98    *
  99    * @update 5/7/98 gess
 100    */
 101   NS_IMETHOD WillInterrupt(void)=0;
 102
 103   /**
 104    * This method gets called when the parser i/o gets unblocked,
 105    * and we're about to start dumping content again to the sink.
 106    *
 107    * @update 5/7/98 gess
 108    */
 109   NS_IMETHOD WillResume(void)=0;
 110
 111   /**
 112    * This method gets called by the parser so that the content
 113    * sink can retain a reference to the parser. The expectation
 114    * is that the content sink will drop the reference when it
 115    * gets the DidBuildModel notification i.e. when parsing is done.
 116    */
 117   NS_IMETHOD SetParser(nsIParser* aParser)=0;
 118
 119   /**
 120    * Flush content so that the content model is in sync with the state
 121    * of the sink.
 122    *
 123    * @param aType the type of flush to perform
 124    */
 125   virtual void FlushPendingNotifications(mozFlushType aType)=0;
 126
 127   /**
 128    * Set the document character set. This should be passed on to the
 129    * document itself.
 130    */
 131   NS_IMETHOD SetDocumentCharset(nsACString& aCharset)=0;
 132
 133   /**
 134    * Returns the target object (often a document object) into which
 135    * the content built by this content sink is being added, if any
 136    * (IOW, may return null).
 137    */
 138   virtual nsISupports *GetTarget()=0;
 139 };
 140
 141 NS_DEFINE_STATIC_IID_ACCESSOR(nsIContentSink, NS_ICONTENT_SINK_IID)
 142
 143 #endif /* nsIContentSink_h___ */