content/xml/document/src/nsXMLPrettyPrinter.h

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   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  *   Jonas Sicking <jonas@sicking.cc> (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 nsXMLPrettyPrinter_h__
  40 #define nsXMLPrettyPrinter_h__
  41
  42 #include "nsStubDocumentObserver.h"
  43 #include "nsIDocument.h"
  44 #include "nsCOMPtr.h"
  45
  46 class nsXMLPrettyPrinter : public nsStubDocumentObserver
  47 {
  48 public:
  49     nsXMLPrettyPrinter();
  50     virtual ~nsXMLPrettyPrinter();
  51
  52     NS_DECL_ISUPPORTS
  53
  54     // nsIDocumentObserver
  55     virtual void BeginUpdate(nsIDocument* aDocument, nsUpdateType aUpdateType);
  56     virtual void EndUpdate(nsIDocument* aDocument, nsUpdateType aUpdateType);
  57
  58     // nsIMutationObserver
  59     NS_DECL_NSIMUTATIONOBSERVER_ATTRIBUTECHANGED
  60     NS_DECL_NSIMUTATIONOBSERVER_CONTENTAPPENDED
  61     NS_DECL_NSIMUTATIONOBSERVER_CONTENTINSERTED
  62     NS_DECL_NSIMUTATIONOBSERVER_CONTENTREMOVED
  63     NS_DECL_NSIMUTATIONOBSERVER_NODEWILLBEDESTROYED
  64
  65     /**
  66      * This will prettyprint the document if the document is loaded in a
  67      * displayed window.
  68      *
  69      * @param aDocument  document to prettyprint
  70      * @param [out] aDidPrettyPrint if true, and error not returned, actually
  71      *              went ahead with prettyprinting the document.
  72      */
  73     nsresult PrettyPrint(nsIDocument* aDocument, PRBool* aDidPrettyPrint);
  74
  75 private:
  76     /**
  77      * Signals for unhooking by setting mUnhookPending if the node changed is
  78      * non-anonymous content.
  79      *
  80      * @param aContent  content that has changed
  81      */
  82     void MaybeUnhook(nsIContent* aContent);
  83
  84     nsIDocument* mDocument; //weak. Set as long as we're observing the document
  85     PRUint32 mUpdateDepth;
  86     PRPackedBool mUnhookPending;
  87 };
  88
  89 nsresult NS_NewXMLPrettyPrinter(nsXMLPrettyPrinter** aPrinter);
  90
  91 #endif //nsXMLPrettyPrinter_h__