editor/composer/nsEditingSession.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #ifndef nsEditingSession_h__
   7 #define nsEditingSession_h__
   8
   9 #include "nsCOMPtr.h"               // for nsCOMPtr
  10 #include "nsISupportsImpl.h"        // for NS_DECL_ISUPPORTS
  11 #include "nsIWeakReferenceUtils.h"  // for nsWeakPtr
  12 #include "nsWeakReference.h"        // for nsSupportsWeakReference, etc
  13 #include "nscore.h"                 // for nsresult
  14
  15 #ifndef __gen_nsIWebProgressListener_h__
  16 #  include "nsIWebProgressListener.h"
  17 #endif
  18
  19 #ifndef __gen_nsIEditingSession_h__
  20 #  include "nsIEditingSession.h"  // for NS_DECL_NSIEDITINGSESSION, etc
  21 #endif
  22
  23 #include "nsString.h"  // for nsCString
  24
  25 class mozIDOMWindowProxy;
  26 class nsBaseCommandController;
  27 class nsIDOMWindow;
  28 class nsISupports;
  29 class nsITimer;
  30 class nsIChannel;
  31 class nsIControllers;
  32 class nsIDocShell;
  33 class nsIWebProgress;
  34
  35 namespace mozilla {
  36 class ComposerCommandsUpdater;
  37 class HTMLEditor;
  38 }  // namespace mozilla
  39
  40 class nsEditingSession final : public nsIEditingSession,
  41                                public nsIWebProgressListener,
  42                                public nsSupportsWeakReference {
  43  public:
  44   nsEditingSession();
  45
  46   // nsISupports
  47   NS_DECL_ISUPPORTS
  48
  49   // nsIWebProgressListener
  50   NS_DECL_NSIWEBPROGRESSLISTENER
  51
  52   // nsIEditingSession
  53   NS_DECL_NSIEDITINGSESSION
  54
  55   /**
  56    * Removes all the editor's controllers/listeners etc and makes the window
  57    * uneditable.
  58    */
  59   nsresult DetachFromWindow(nsPIDOMWindowOuter* aWindow);
  60
  61   /**
  62    * Undos DetachFromWindow(), reattaches this editing session/editor
  63    * to the window.
  64    */
  65   nsresult ReattachToWindow(nsPIDOMWindowOuter* aWindow);
  66
  67  protected:
  68   virtual ~nsEditingSession();
  69
  70   typedef already_AddRefed<nsBaseCommandController> (*ControllerCreatorFn)();
  71
  72   nsresult SetupEditorCommandController(
  73       ControllerCreatorFn aControllerCreatorFn, mozIDOMWindowProxy* aWindow,
  74       nsISupports* aContext, uint32_t* aControllerId);
  75
  76   nsresult SetContextOnControllerById(nsIControllers* aControllers,
  77                                       nsISupports* aContext, uint32_t aID);
  78
  79   /**
  80    *  Set the editor on the controller(s) for this window
  81    */
  82   nsresult SetEditorOnControllers(nsPIDOMWindowOuter& aWindow,
  83                                   mozilla::HTMLEditor* aEditor);
  84
  85   /**
  86    *  Setup editor and related support objects
  87    */
  88   MOZ_CAN_RUN_SCRIPT nsresult SetupEditorOnWindow(nsPIDOMWindowOuter& aWindow);
  89
  90   nsresult PrepareForEditing(nsPIDOMWindowOuter* aWindow);
  91
  92   static void TimerCallback(nsITimer* aTimer, void* aClosure);
  93   nsCOMPtr<nsITimer> mLoadBlankDocTimer;
  94
  95   // progress load stuff
  96   nsresult StartDocumentLoad(nsIWebProgress* aWebProgress,
  97                              bool isToBeMadeEditable);
  98   MOZ_CAN_RUN_SCRIPT_BOUNDARY
  99   nsresult EndDocumentLoad(nsIWebProgress* aWebProgress, nsIChannel* aChannel,
 100                            nsresult aStatus, bool isToBeMadeEditable);
 101   nsresult StartPageLoad(nsIChannel* aChannel);
 102   nsresult EndPageLoad(nsIWebProgress* aWebProgress, nsIChannel* aChannel,
 103                        nsresult aStatus);
 104
 105   bool IsProgressForTargetDocument(nsIWebProgress* aWebProgress);
 106
 107   void RemoveEditorControllers(nsPIDOMWindowOuter* aWindow);
 108   void RemoveWebProgressListener(nsPIDOMWindowOuter* aWindow);
 109   void RestoreAnimationMode(nsPIDOMWindowOuter* aWindow);
 110   void RemoveListenersAndControllers(nsPIDOMWindowOuter* aWindow,
 111                                      mozilla::HTMLEditor* aHTMLEditor);
 112
 113   /**
 114    * Disable scripts and plugins in aDocShell.
 115    */
 116   nsresult DisableJSAndPlugins(nsIDocShell& aDocShell);
 117
 118   /**
 119    * Restore JS and plugins (enable/disable them) according to the state they
 120    * were before the last call to disableJSAndPlugins.
 121    */
 122   nsresult RestoreJSAndPlugins(nsPIDOMWindowOuter* aWindow);
 123
 124  protected:
 125   bool mDoneSetup;  // have we prepared for editing yet?
 126
 127   // Used to prevent double creation of editor because nsIWebProgressListener
 128   //  receives a STATE_STOP notification before the STATE_START
 129   //  for our document, so we wait for the STATE_START, then STATE_STOP
 130   //  before creating an editor
 131   bool mCanCreateEditor;
 132
 133   bool mInteractive;
 134   bool mMakeWholeDocumentEditable;
 135
 136   bool mDisabledJSAndPlugins;
 137
 138   // True if scripts were enabled before the editor turned scripts
 139   // off, otherwise false.
 140   bool mScriptsEnabled;
 141
 142   // True if plugins were enabled before the editor turned plugins
 143   // off, otherwise false.
 144   bool mPluginsEnabled;
 145
 146   bool mProgressListenerRegistered;
 147
 148   // The image animation mode before it was turned off.
 149   uint16_t mImageAnimationMode;
 150
 151   // THE REMAINING MEMBER VARIABLES WILL BECOME A SET WHEN WE EDIT
 152   // MORE THAN ONE EDITOR PER EDITING SESSION
 153   RefPtr<mozilla::ComposerCommandsUpdater> mComposerCommandsUpdater;
 154
 155   // Save the editor type so we can create the editor after loading uri
 156   nsCString mEditorType;
 157   uint32_t mEditorFlags;
 158   uint32_t mEditorStatus;
 159   uint32_t mBaseCommandControllerId;
 160   uint32_t mDocStateControllerId;
 161   uint32_t mHTMLCommandControllerId;
 162
 163   // Make sure the docshell we use is safe
 164   nsWeakPtr mDocShell;
 165
 166   // See if we can reuse an existing editor
 167   nsWeakPtr mExistingEditor;
 168 };
 169
 170 #endif  // nsEditingSession_h__