content/xml/document/src/nsLoadSaveContentSink.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.org 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) 2002
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *      Boris Zbarsky <bzbarsky@mit.edu>  (original author)
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * 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
  39 #ifndef nsLoadSaveContentSink_h__
  40 #define nsLoadSaveContentSink_h__
  41
  42 #include "nsIExpatSink.h"
  43 #include "nsIXMLContentSink.h"
  44 #include "nsILoadSaveContentSink.h"
  45 #include "nsCOMPtr.h"
  46
  47 /**
  48  * This class implements the core of the DOMBuilder for DOM3
  49  * Load/Save.  It holds a reference to an actual content sink that
  50  * constructs the content model.
  51  */
  52 class nsLoadSaveContentSink : public nsILoadSaveContentSink,
  53                               public nsIExpatSink
  54 {
  55 public:
  56   nsLoadSaveContentSink();
  57   virtual ~nsLoadSaveContentSink();
  58
  59   /**
  60    * Initializes the sink.  This will return an error if the arguments
  61    * do not satisfy some basic sanity-checks.
  62    * @param aBaseSink a "real" sink that the LoadSave sink can use to
  63    *                  build the document.  This must be non-null and
  64    *                  must also implement nsIExpatSink.
  65    */
  66   nsresult Init(nsIXMLContentSink* aBaseSink);
  67
  68   NS_DECL_ISUPPORTS
  69   NS_DECL_NSIEXPATSINK
  70
  71   // nsILoadSaveContentSink
  72   NS_IMETHOD WillBuildModel(void);
  73   NS_IMETHOD DidBuildModel(void);
  74   NS_IMETHOD WillInterrupt(void);
  75   NS_IMETHOD WillResume(void);
  76   NS_IMETHOD SetParser(nsIParser* aParser);
  77   virtual void FlushPendingNotifications(mozFlushType aType);
  78   NS_IMETHOD SetDocumentCharset(nsAString& aCharset);
  79
  80 private:
  81   /**
  82    * Pointers to the "real" sink.  We hold on to both just for
  83    * convenience sake.
  84    */
  85   nsCOMPtr<nsIXMLContentSink> mBaseSink;
  86   nsCOMPtr<nsIExpatSink> mExpatSink;
  87 };
  88
  89 #endif // nsLoadSaveContentSink_h__