Back to index

lightning-sunbird  0.9+nobinonly
nsXMLDocument.h
Go to the documentation of this file.
00001 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
00002 /* ***** BEGIN LICENSE BLOCK *****
00003  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00004  *
00005  * The contents of this file are subject to the Mozilla Public License Version
00006  * 1.1 (the "License"); you may not use this file except in compliance with
00007  * the License. You may obtain a copy of the License at
00008  * http://www.mozilla.org/MPL/
00009  *
00010  * Software distributed under the License is distributed on an "AS IS" basis,
00011  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
00012  * for the specific language governing rights and limitations under the
00013  * License.
00014  *
00015  * The Original Code is Mozilla Communicator client code.
00016  *
00017  * The Initial Developer of the Original Code is
00018  * Netscape Communications Corporation.
00019  * Portions created by the Initial Developer are Copyright (C) 1998
00020  * the Initial Developer. All Rights Reserved.
00021  *
00022  * Contributor(s):
00023  *
00024  * Alternatively, the contents of this file may be used under the terms of
00025  * either of the GNU General Public License Version 2 or later (the "GPL"),
00026  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
00027  * in which case the provisions of the GPL or the LGPL are applicable instead
00028  * of those above. If you wish to allow use of your version of this file only
00029  * under the terms of either the GPL or the LGPL, and not to allow others to
00030  * use your version of this file under the terms of the MPL, indicate your
00031  * decision by deleting the provisions above and replace them with the notice
00032  * and other provisions required by the GPL or the LGPL. If you do not delete
00033  * the provisions above, a recipient may use your version of this file under
00034  * the terms of any one of the MPL, the GPL or the LGPL.
00035  *
00036  * ***** END LICENSE BLOCK ***** */
00037 
00038 #ifndef nsXMLDocument_h___
00039 #define nsXMLDocument_h___
00040 
00041 #include "nsDocument.h"
00042 #include "nsIInterfaceRequestor.h"
00043 #include "nsIInterfaceRequestorUtils.h"
00044 #include "nsIChannelEventSink.h"
00045 #include "nsIDOMXMLDocument.h"
00046 #include "nsIScriptContext.h"
00047 #include "nsHTMLStyleSheet.h"
00048 #include "nsIHTMLCSSStyleSheet.h"
00049 #include "nsIEventQueueService.h"
00050 
00051 class nsIParser;
00052 class nsIDOMNode;
00053 class nsIURI;
00054 class nsIChannel;
00055 
00056 class nsXMLDocument : public nsDocument,
00057                       public nsIInterfaceRequestor,
00058                       public nsIChannelEventSink
00059 {
00060 public:
00061   nsXMLDocument();
00062   virtual ~nsXMLDocument();
00063 
00064   NS_DECL_ISUPPORTS_INHERITED
00065 
00066   virtual void Reset(nsIChannel* aChannel, nsILoadGroup* aLoadGroup);
00067   virtual void ResetToURI(nsIURI *aURI, nsILoadGroup *aLoadGroup);
00068 
00069   virtual nsresult StartDocumentLoad(const char* aCommand, nsIChannel* channel,
00070                                      nsILoadGroup* aLoadGroup,
00071                                      nsISupports* aContainer,
00072                                      nsIStreamListener **aDocListener,
00073                                      PRBool aReset = PR_TRUE,
00074                                      nsIContentSink* aSink = nsnull);
00075 
00076   virtual void EndLoad();
00077 
00078   virtual PRBool IsLoadedAsData();
00079 
00080   // nsIDOMNode interface
00081   NS_IMETHOD CloneNode(PRBool aDeep, nsIDOMNode** aReturn);
00082 
00083   // nsIDOMDocument interface
00084   NS_IMETHOD GetElementById(const nsAString& aElementId,
00085                             nsIDOMElement** aReturn);
00086 
00087   // nsIInterfaceRequestor
00088   NS_DECL_NSIINTERFACEREQUESTOR
00089 
00090   // nsIHTTPEventSink
00091   NS_DECL_NSICHANNELEVENTSINK
00092 
00093   // nsIDOMXMLDocument
00094   NS_DECL_NSIDOMXMLDOCUMENT
00095 
00096   virtual nsresult Init();
00097 
00098   void SetLoadedAsData(PRBool aLoadedAsData) { mLoadedAsData = aLoadedAsData; }
00099 
00100 protected:
00101   virtual nsresult GetLoadGroup(nsILoadGroup **aLoadGroup);
00102 
00103   nsCOMPtr<nsIEventQueueService> mEventQService;
00104 
00105   nsCOMPtr<nsIScriptContext> mScriptContext;
00106 
00107   // mChannelIsPending indicates whether we're currently asynchronously loading
00108   // data from mChannel (via document.load() or normal load).  It's set to true
00109   // when we first find out about the channel (StartDocumentLoad) and set to
00110   // false in EndLoad or if ResetToURI() is called.  In the latter case our
00111   // mChannel is also cancelled.  Note that if this member is true, mChannel
00112   // cannot be null.
00113   PRPackedBool mChannelIsPending;
00114   PRPackedBool mLoadedAsData;
00115   PRPackedBool mLoadedAsInteractiveData;
00116   PRPackedBool mAsync;
00117   PRPackedBool mLoopingForSyncLoad;
00118 };
00119 
00120 
00121 #endif // nsXMLDocument_h___