docshell/base/nsDocShellEditorData.cpp

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  *
   3  * This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7
   8 #include "nsDocShellEditorData.h"
   9 #include "nsIInterfaceRequestorUtils.h"
  10 #include "nsComponentManagerUtils.h"
  11 #include "nsPIDOMWindow.h"
  12 #include "nsIDOMDocument.h"
  13 #include "nsIEditor.h"
  14 #include "nsIEditingSession.h"
  15 #include "nsIDocShell.h"
  16
  17 /*---------------------------------------------------------------------------
  18
  19   nsDocShellEditorData
  20
  21 ----------------------------------------------------------------------------*/
  22
  23 nsDocShellEditorData::nsDocShellEditorData(nsIDocShell* inOwningDocShell)
  24 : mDocShell(inOwningDocShell)
  25 , mMakeEditable(false)
  26 , mIsDetached(false)
  27 , mDetachedMakeEditable(false)
  28 , mDetachedEditingState(nsIHTMLDocument::eOff)
  29 {
  30   NS_ASSERTION(mDocShell, "Where is my docShell?");
  31 }
  32
  33
  34 /*---------------------------------------------------------------------------
  35
  36   ~nsDocShellEditorData
  37
  38 ----------------------------------------------------------------------------*/
  39 nsDocShellEditorData::~nsDocShellEditorData()
  40 {
  41   TearDownEditor();
  42 }
  43
  44 void
  45 nsDocShellEditorData::TearDownEditor()
  46 {
  47   if (mEditor) {
  48     mEditor->PreDestroy(false);
  49     mEditor = nullptr;
  50   }
  51   mEditingSession = nullptr;
  52   mIsDetached = false;
  53 }
  54
  55
  56 /*---------------------------------------------------------------------------
  57
  58   MakeEditable
  59
  60 ----------------------------------------------------------------------------*/
  61 nsresult
  62 nsDocShellEditorData::MakeEditable(bool inWaitForUriLoad)
  63 {
  64   if (mMakeEditable)
  65     return NS_OK;
  66
  67   // if we are already editable, and are getting turned off,
  68   // nuke the editor.
  69   if (mEditor)
  70   {
  71     NS_WARNING("Destroying existing editor on frame");
  72
  73     mEditor->PreDestroy(false);
  74     mEditor = nullptr;
  75   }
  76
  77   if (inWaitForUriLoad)
  78     mMakeEditable = true;
  79   return NS_OK;
  80 }
  81
  82
  83 /*---------------------------------------------------------------------------
  84
  85   GetEditable
  86
  87 ----------------------------------------------------------------------------*/
  88 bool
  89 nsDocShellEditorData::GetEditable()
  90 {
  91   return mMakeEditable || (mEditor != nullptr);
  92 }
  93
  94 /*---------------------------------------------------------------------------
  95
  96   CreateEditor
  97
  98 ----------------------------------------------------------------------------*/
  99 nsresult
 100 nsDocShellEditorData::CreateEditor()
 101 {
 102   nsCOMPtr<nsIEditingSession>   editingSession;
 103   nsresult rv = GetEditingSession(getter_AddRefs(editingSession));
 104   if (NS_FAILED(rv)) return rv;
 105
 106   nsCOMPtr<nsIDOMWindow>    domWindow =
 107     mDocShell ? mDocShell->GetWindow() : nullptr;
 108   rv = editingSession->SetupEditorOnWindow(domWindow);
 109   if (NS_FAILED(rv)) return rv;
 110
 111   return NS_OK;
 112 }
 113
 114
 115 /*---------------------------------------------------------------------------
 116
 117   GetEditingSession
 118
 119 ----------------------------------------------------------------------------*/
 120 nsresult
 121 nsDocShellEditorData::GetEditingSession(nsIEditingSession **outEditingSession)
 122 {
 123   nsresult rv = EnsureEditingSession();
 124   NS_ENSURE_SUCCESS(rv, rv);
 125
 126   NS_ADDREF(*outEditingSession = mEditingSession);
 127
 128   return NS_OK;
 129 }
 130
 131
 132 /*---------------------------------------------------------------------------
 133
 134   GetEditor
 135
 136 ----------------------------------------------------------------------------*/
 137 nsresult
 138 nsDocShellEditorData::GetEditor(nsIEditor **outEditor)
 139 {
 140   NS_ENSURE_ARG_POINTER(outEditor);
 141   NS_IF_ADDREF(*outEditor = mEditor);
 142   return NS_OK;
 143 }
 144
 145
 146 /*---------------------------------------------------------------------------
 147
 148   SetEditor
 149
 150 ----------------------------------------------------------------------------*/
 151 nsresult
 152 nsDocShellEditorData::SetEditor(nsIEditor *inEditor)
 153 {
 154   // destroy any editor that we have. Checks for equality are
 155   // necessary to ensure that assigment into the nsCOMPtr does
 156   // not temporarily reduce the refCount of the editor to zero
 157   if (mEditor.get() != inEditor)
 158   {
 159     if (mEditor)
 160     {
 161       mEditor->PreDestroy(false);
 162       mEditor = nullptr;
 163     }
 164
 165     mEditor = inEditor;    // owning addref
 166     if (!mEditor)
 167       mMakeEditable = false;
 168   }
 169
 170   return NS_OK;
 171 }
 172
 173
 174 /*---------------------------------------------------------------------------
 175
 176   EnsureEditingSession
 177
 178   This creates the editing session on the content docShell that owns
 179   'this'.
 180
 181 ----------------------------------------------------------------------------*/
 182 nsresult
 183 nsDocShellEditorData::EnsureEditingSession()
 184 {
 185   NS_ASSERTION(mDocShell, "Should have docShell here");
 186   NS_ASSERTION(!mIsDetached, "This will stomp editing session!");
 187
 188   nsresult rv = NS_OK;
 189
 190   if (!mEditingSession)
 191   {
 192     mEditingSession =
 193       do_CreateInstance("@mozilla.org/editor/editingsession;1", &rv);
 194   }
 195
 196   return rv;
 197 }
 198
 199 nsresult
 200 nsDocShellEditorData::DetachFromWindow()
 201 {
 202   NS_ASSERTION(mEditingSession,
 203                "Can't detach when we don't have a session to detach!");
 204
 205   nsCOMPtr<nsIDOMWindow> domWindow =
 206     mDocShell ? mDocShell->GetWindow() : nullptr;
 207   nsresult rv = mEditingSession->DetachFromWindow(domWindow);
 208   NS_ENSURE_SUCCESS(rv, rv);
 209
 210   mIsDetached = true;
 211   mDetachedMakeEditable = mMakeEditable;
 212   mMakeEditable = false;
 213
 214   nsCOMPtr<nsIDOMDocument> domDoc;
 215   domWindow->GetDocument(getter_AddRefs(domDoc));
 216   nsCOMPtr<nsIHTMLDocument> htmlDoc = do_QueryInterface(domDoc);
 217   if (htmlDoc)
 218     mDetachedEditingState = htmlDoc->GetEditingState();
 219
 220   mDocShell = nullptr;
 221
 222   return NS_OK;
 223 }
 224
 225 nsresult
 226 nsDocShellEditorData::ReattachToWindow(nsIDocShell* aDocShell)
 227 {
 228   mDocShell = aDocShell;
 229
 230   nsCOMPtr<nsIDOMWindow> domWindow =
 231     mDocShell ? mDocShell->GetWindow() : nullptr;
 232   nsresult rv = mEditingSession->ReattachToWindow(domWindow);
 233   NS_ENSURE_SUCCESS(rv, rv);
 234
 235   mIsDetached = false;
 236   mMakeEditable = mDetachedMakeEditable;
 237
 238   nsCOMPtr<nsIDOMDocument> domDoc;
 239   domWindow->GetDocument(getter_AddRefs(domDoc));
 240   nsCOMPtr<nsIHTMLDocument> htmlDoc = do_QueryInterface(domDoc);
 241   if (htmlDoc)
 242     htmlDoc->SetEditingState(mDetachedEditingState);
 243
 244   return NS_OK;
 245 }