gecko-dev/content/base/src/nsDocument.h

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 *
 * The contents of this file are subject to the Netscape Public License
 * Version 1.0 (the "NPL"); you may not use this file except in
 * compliance with the NPL.  You may obtain a copy of the NPL at
 * http://www.mozilla.org/NPL/
 *
 * Software distributed under the NPL is distributed on an "AS IS" basis,
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the NPL
 * for the specific language governing rights and limitations under the
 * NPL.
 *
 * The Initial Developer of this code under the NPL is Netscape
 * Communications Corporation.  Portions created by Netscape are
 * Copyright (C) 1998 Netscape Communications Corporation.  All Rights
 * Reserved.
 */
#ifndef nsDocument_h___
#define nsDocument_h___

#include "nsIDocument.h"
#include "nsVoidArray.h"
#include "nsIDOMDocument.h"
#include "nsIScriptObjectOwner.h"
#include "nsIScriptContext.h"
#include "nsIDOMEventCapturer.h"

class nsISelection;
class nsIEventListenerManager;

class nsPostData : public nsIPostData {
public:
  nsPostData(PRBool aIsFile, char* aData) : mIsFile(aIsFile), mData(aData) {}
  nsPostData(nsIPostData* aPostData);
  PRBool       IsFile() { return mIsFile; }   
  const char*  GetData() { return mData; }    
protected:
  PRBool mIsFile;
  char*  mData;
};

// Base class for our document implementations
class nsDocument : public nsIDocument, public nsIDOMDocument, public nsIScriptObjectOwner, public nsIDOMEventCapturer {
public:
  NS_DECL_ISUPPORTS

  virtual nsIArena* GetArena();

  /**
   * Return the title of the document. May return null.
   */
  virtual const nsString* GetDocumentTitle() const;

  /**
   * Return the URL for the document. May return null.
   */
  virtual nsIURL* GetDocumentURL() const;

  /**
   * Return a standard name for the document's character set. This will
   * trigger a startDocumentLoad if necessary to answer the question.
   */
  virtual nsCharSetID GetDocumentCharacterSet() const;
  virtual void SetDocumentCharacterSet(nsCharSetID aCharSetID);

  /**
   * Create a new presentation shell that will use aContext for
   * it's presentation context (presentation context's <b>must not</b> be
   * shared among multiple presentation shell's).
   */
  virtual nsresult CreateShell(nsIPresContext* aContext,
                               nsIViewManager* aViewManager,
                               nsIStyleSet* aStyleSet,
                               nsIPresShell** aInstancePtrResult);
  virtual PRBool DeleteShell(nsIPresShell* aShell);
  virtual PRInt32 GetNumberOfShells();
  virtual nsIPresShell* GetShellAt(PRInt32 aIndex);

  /**
   * Return the parent document of this document. Will return null
   * unless this document is within a compound document and has a parent.
   */
  virtual nsIDocument* GetParentDocument();
  virtual void SetParentDocument(nsIDocument* aParent);
  virtual void AddSubDocument(nsIDocument* aSubDoc);
  virtual PRInt32 GetNumberOfSubDocuments();
  virtual nsIDocument* GetSubDocumentAt(PRInt32 aIndex);

  /**
   * Return the root content object for this document.
   */
  virtual nsIContent* GetRootContent();
  virtual void SetRootContent(nsIContent* aRoot);

  /**
   * Get the style sheets owned by this document.
   */
  virtual PRInt32 GetNumberOfStyleSheets();
  virtual nsIStyleSheet* GetStyleSheetAt(PRInt32 aIndex);
  virtual void AddStyleSheet(nsIStyleSheet* aSheet);

  /**
   * Add a new observer of document change notifications. Whenever
   * content is changed, appended, inserted or removed the observers are
   * informed.
   */
  virtual void AddObserver(nsIDocumentObserver* aObserver);

  /**
   * Remove an observer of document change notifications. This will
   * return false if the observer cannot be found.
   */
  virtual PRBool RemoveObserver(nsIDocumentObserver* aObserver);

  // Observation hooks used by content nodes to propagate
  // notifications to document observers.
  NS_IMETHOD BeginLoad();
  NS_IMETHOD EndLoad();
  virtual void ContentChanged(nsIContent* aContent,
                              nsISupports* aSubContent);

  virtual void ContentAppended(nsIContent* aContainer);

  virtual void ContentInserted(nsIContent* aContainer,
                               nsIContent* aChild,
                               PRInt32 aIndexInContainer);

  virtual void ContentReplaced(nsIContent* aContainer,
                               nsIContent* aOldChild,
                               nsIContent* aNewChild,
                               PRInt32 aIndexInContainer);

  virtual void ContentWillBeRemoved(nsIContent* aContainer,
                                    nsIContent* aChild,
                                    PRInt32 aIndexInContainer);

  virtual void ContentHasBeenRemoved(nsIContent* aContainer,
                                     nsIContent* aChild,
                                     PRInt32 aIndexInContainer);

  /**
    * Returns the Selection Object
   */
  virtual nsISelection * GetSelection();

  /**
    * Selects all the Content
   */
  virtual void SelectAll();

  /**
    * Copies all text from the selection
   */
  virtual void GetSelectionText(nsString & aText);

  void TraverseTree(nsString   & aText,  
                    nsIContent * aContent, 
                    nsIContent * aStart, 
                    nsIContent * aEnd, 
                    PRBool     & aInRange);


public:
  
  NS_IMETHOD GetScriptObject(nsIScriptContext *aContext, void** aScriptObject);
  NS_IMETHOD ResetScriptObject();

  // nsIDOMDocument interface
  NS_IMETHOD GetNodeType(PRInt32 *aType);
  NS_IMETHOD GetParentNode(nsIDOMNode **aNode);
  NS_IMETHOD GetChildNodes(nsIDOMNodeIterator **aIterator);
  NS_IMETHOD HasChildNodes(PRBool *aReturn);
  NS_IMETHOD GetFirstChild(nsIDOMNode **aNode);
  NS_IMETHOD GetPreviousSibling(nsIDOMNode **aNode);
  NS_IMETHOD GetNextSibling(nsIDOMNode **aNode);
  NS_IMETHOD InsertBefore(nsIDOMNode *newChild, nsIDOMNode *refChild);
  NS_IMETHOD ReplaceChild(nsIDOMNode *newChild, nsIDOMNode *oldChild);
  NS_IMETHOD RemoveChild(nsIDOMNode *oldChild);
  NS_IMETHOD GetMasterDoc(nsIDOMDocument **aDocument);
  NS_IMETHOD SetMasterDoc(nsIDOMDocument *aDocument);
  NS_IMETHOD GetDocumentType(nsIDOMNode **aDocType); 
  NS_IMETHOD SetDocumentType(nsIDOMNode *aNode); 
  NS_IMETHOD GetDocumentElement(nsIDOMElement **aElement);
  NS_IMETHOD SetDocumentElement(nsIDOMElement *aElement); 
  NS_IMETHOD GetDocumentContext(nsIDOMDocumentContext **aDocContext);
  NS_IMETHOD SetDocumentContext(nsIDOMDocumentContext *aContext);
  NS_IMETHOD CreateDocumentContext(nsIDOMDocumentContext **aDocContext);
  NS_IMETHOD CreateElement(nsString &aTagName, 
                                            nsIDOMAttributeList *aAttributes, 
                                            nsIDOMElement **aElement);
  NS_IMETHOD CreateTextNode(nsString &aData, nsIDOMText** aTextNode);
  NS_IMETHOD CreateComment(nsString &aData, nsIDOMComment **aComment);
  NS_IMETHOD CreatePI(nsString &aName, nsString &aData, nsIDOMPI **aPI);
  NS_IMETHOD CreateAttribute(nsString &aName, 
                                              nsIDOMNode *value, 
                                              nsIDOMAttribute **aAttribute);
  NS_IMETHOD CreateAttributeList(nsIDOMAttributeList **aAttributesList);
  NS_IMETHOD CreateTreeIterator(nsIDOMNode *aNode, nsIDOMTreeIterator **aTreeIterator);
  NS_IMETHOD GetElementsByTagName(nsString &aTagname, nsIDOMNodeIterator **aIterator);

  // nsIDOMEventCapturer interface
  NS_IMETHOD CaptureEvent(nsIDOMEventListener *aListener);
  NS_IMETHOD ReleaseEvent(nsIDOMEventListener *aListener);
  NS_IMETHOD AddEventListener(nsIDOMEventListener *aListener, const nsIID& aIID);
  NS_IMETHOD RemoveEventListener(nsIDOMEventListener *aListener, const nsIID& aIID);

  NS_IMETHOD GetListenerManager(nsIEventListenerManager** aInstancePtrResult);

  NS_IMETHOD HandleDOMEvent(nsIPresContext& aPresContext, 
                            nsGUIEvent* aEvent, 
                            nsIDOMEvent* aDOMEvent,
                            nsEventStatus& aEventStatus);

protected:
  virtual void AddStyleSheetToSet(nsIStyleSheet* aSheet, nsIStyleSet* aSet);  // subclass hook

  nsDocument();
  virtual ~nsDocument(); 
  nsresult Init();

  nsISelection * mSelection;

  nsIArena* mArena;
  nsString* mDocumentTitle;
  nsIURL* mDocumentURL;
  nsCharSetID mCharacterSet;
  nsIDocument* mParentDocument;
  nsVoidArray mSubDocuments;
  nsVoidArray mPresShells;
  nsIContent* mRootContent;
  nsVoidArray mStyleSheets;
  nsVoidArray mObservers;
  void* mScriptObject;
  nsIEventListenerManager* mListenerManager;
};

#endif /* nsDocument_h___ */