Blame docshell/base/nsDocShellEditorData.cpp

Packit f0b94e
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
Packit f0b94e
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
Packit f0b94e
/* This Source Code Form is subject to the terms of the Mozilla Public
Packit f0b94e
 * License, v. 2.0. If a copy of the MPL was not distributed with this
Packit f0b94e
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
Packit f0b94e
Packit f0b94e
#include "nsDocShellEditorData.h"
Packit f0b94e
#include "nsIInterfaceRequestorUtils.h"
Packit f0b94e
#include "nsComponentManagerUtils.h"
Packit f0b94e
#include "nsPIDOMWindow.h"
Packit f0b94e
#include "nsIDOMDocument.h"
Packit f0b94e
#include "nsIEditor.h"
Packit f0b94e
#include "nsIEditingSession.h"
Packit f0b94e
#include "nsIDocShell.h"
Packit f0b94e
Packit f0b94e
using namespace mozilla;
Packit f0b94e
Packit f0b94e
nsDocShellEditorData::nsDocShellEditorData(nsIDocShell* aOwningDocShell)
Packit f0b94e
    : mDocShell(aOwningDocShell),
Packit f0b94e
      mDetachedEditingState(nsIHTMLDocument::eOff),
Packit f0b94e
      mMakeEditable(false),
Packit f0b94e
      mIsDetached(false),
Packit f0b94e
      mDetachedMakeEditable(false) {
Packit f0b94e
  NS_ASSERTION(mDocShell, "Where is my docShell?");
Packit f0b94e
}
Packit f0b94e
Packit f0b94e
nsDocShellEditorData::~nsDocShellEditorData() { TearDownEditor(); }
Packit f0b94e
Packit f0b94e
void nsDocShellEditorData::TearDownEditor() {
Packit f0b94e
  if (mHTMLEditor) {
Packit f0b94e
    RefPtr<HTMLEditor> htmlEditor = mHTMLEditor.forget();
Packit f0b94e
    htmlEditor->PreDestroy(false);
Packit f0b94e
  }
Packit f0b94e
  mEditingSession = nullptr;
Packit f0b94e
  mIsDetached = false;
Packit f0b94e
}
Packit f0b94e
Packit f0b94e
nsresult nsDocShellEditorData::MakeEditable(bool aInWaitForUriLoad) {
Packit f0b94e
  if (mMakeEditable) {
Packit f0b94e
    return NS_OK;
Packit f0b94e
  }
Packit f0b94e
Packit f0b94e
  // if we are already editable, and are getting turned off,
Packit f0b94e
  // nuke the editor.
Packit f0b94e
  if (mHTMLEditor) {
Packit f0b94e
    NS_WARNING("Destroying existing editor on frame");
Packit f0b94e
Packit f0b94e
    RefPtr<HTMLEditor> htmlEditor = mHTMLEditor.forget();
Packit f0b94e
    htmlEditor->PreDestroy(false);
Packit f0b94e
  }
Packit f0b94e
Packit f0b94e
  if (aInWaitForUriLoad) {
Packit f0b94e
    mMakeEditable = true;
Packit f0b94e
  }
Packit f0b94e
  return NS_OK;
Packit f0b94e
}
Packit f0b94e
Packit f0b94e
bool nsDocShellEditorData::GetEditable() {
Packit f0b94e
  return mMakeEditable || (mHTMLEditor != nullptr);
Packit f0b94e
}
Packit f0b94e
Packit f0b94e
nsresult nsDocShellEditorData::CreateEditor() {
Packit f0b94e
  nsCOMPtr<nsIEditingSession> editingSession;
Packit f0b94e
  nsresult rv = GetEditingSession(getter_AddRefs(editingSession));
Packit f0b94e
  if (NS_FAILED(rv)) {
Packit f0b94e
    return rv;
Packit f0b94e
  }
Packit f0b94e
Packit f0b94e
  nsCOMPtr<nsPIDOMWindowOuter> domWindow =
Packit f0b94e
      mDocShell ? mDocShell->GetWindow() : nullptr;
Packit f0b94e
  rv = editingSession->SetupEditorOnWindow(domWindow);
Packit f0b94e
  if (NS_FAILED(rv)) {
Packit f0b94e
    return rv;
Packit f0b94e
  }
Packit f0b94e
Packit f0b94e
  return NS_OK;
Packit f0b94e
}
Packit f0b94e
Packit f0b94e
nsresult nsDocShellEditorData::GetEditingSession(nsIEditingSession** aResult) {
Packit f0b94e
  nsresult rv = EnsureEditingSession();
Packit f0b94e
  NS_ENSURE_SUCCESS(rv, rv);
Packit f0b94e
Packit f0b94e
  NS_ADDREF(*aResult = mEditingSession);
Packit f0b94e
Packit f0b94e
  return NS_OK;
Packit f0b94e
}
Packit f0b94e
Packit f0b94e
nsresult nsDocShellEditorData::SetHTMLEditor(HTMLEditor* aHTMLEditor) {
Packit f0b94e
  // destroy any editor that we have. Checks for equality are
Packit f0b94e
  // necessary to ensure that assigment into the nsCOMPtr does
Packit f0b94e
  // not temporarily reduce the refCount of the editor to zero
Packit f0b94e
  if (mHTMLEditor == aHTMLEditor) {
Packit f0b94e
    return NS_OK;
Packit f0b94e
  }
Packit f0b94e
Packit f0b94e
  if (mHTMLEditor) {
Packit f0b94e
    RefPtr<HTMLEditor> htmlEditor = mHTMLEditor.forget();
Packit f0b94e
    htmlEditor->PreDestroy(false);
Packit f0b94e
    MOZ_ASSERT(!mHTMLEditor,
Packit f0b94e
               "Nested call of nsDocShellEditorData::SetHTMLEditor() detected");
Packit f0b94e
  }
Packit f0b94e
Packit f0b94e
  mHTMLEditor = aHTMLEditor;  // owning addref
Packit f0b94e
  if (!mHTMLEditor) {
Packit f0b94e
    mMakeEditable = false;
Packit f0b94e
  }
Packit f0b94e
Packit f0b94e
  return NS_OK;
Packit f0b94e
}
Packit f0b94e
Packit f0b94e
// This creates the editing session on the content docShell that owns 'this'.
Packit f0b94e
nsresult nsDocShellEditorData::EnsureEditingSession() {
Packit f0b94e
  NS_ASSERTION(mDocShell, "Should have docShell here");
Packit f0b94e
  NS_ASSERTION(!mIsDetached, "This will stomp editing session!");
Packit f0b94e
Packit f0b94e
  nsresult rv = NS_OK;
Packit f0b94e
Packit f0b94e
  if (!mEditingSession) {
Packit f0b94e
    mEditingSession =
Packit f0b94e
        do_CreateInstance("@mozilla.org/editor/editingsession;1", &rv;;
Packit f0b94e
  }
Packit f0b94e
Packit f0b94e
  return rv;
Packit f0b94e
}
Packit f0b94e
Packit f0b94e
nsresult nsDocShellEditorData::DetachFromWindow() {
Packit f0b94e
  NS_ASSERTION(mEditingSession,
Packit f0b94e
               "Can't detach when we don't have a session to detach!");
Packit f0b94e
Packit f0b94e
  nsCOMPtr<nsPIDOMWindowOuter> domWindow =
Packit f0b94e
      mDocShell ? mDocShell->GetWindow() : nullptr;
Packit f0b94e
  nsresult rv = mEditingSession->DetachFromWindow(domWindow);
Packit f0b94e
  NS_ENSURE_SUCCESS(rv, rv);
Packit f0b94e
Packit f0b94e
  mIsDetached = true;
Packit f0b94e
  mDetachedMakeEditable = mMakeEditable;
Packit f0b94e
  mMakeEditable = false;
Packit f0b94e
Packit f0b94e
  nsCOMPtr<nsIDocument> doc = domWindow->GetDoc();
Packit f0b94e
  nsCOMPtr<nsIHTMLDocument> htmlDoc = do_QueryInterface(doc);
Packit f0b94e
  if (htmlDoc) {
Packit f0b94e
    mDetachedEditingState = htmlDoc->GetEditingState();
Packit f0b94e
  }
Packit f0b94e
Packit f0b94e
  mDocShell = nullptr;
Packit f0b94e
Packit f0b94e
  return NS_OK;
Packit f0b94e
}
Packit f0b94e
Packit f0b94e
nsresult nsDocShellEditorData::ReattachToWindow(nsIDocShell* aDocShell) {
Packit f0b94e
  mDocShell = aDocShell;
Packit f0b94e
Packit f0b94e
  nsCOMPtr<nsPIDOMWindowOuter> domWindow =
Packit f0b94e
      mDocShell ? mDocShell->GetWindow() : nullptr;
Packit f0b94e
  nsresult rv = mEditingSession->ReattachToWindow(domWindow);
Packit f0b94e
  NS_ENSURE_SUCCESS(rv, rv);
Packit f0b94e
Packit f0b94e
  mIsDetached = false;
Packit f0b94e
  mMakeEditable = mDetachedMakeEditable;
Packit f0b94e
Packit f0b94e
  nsCOMPtr<nsIDocument> doc = domWindow->GetDoc();
Packit f0b94e
  nsCOMPtr<nsIHTMLDocument> htmlDoc = do_QueryInterface(doc);
Packit f0b94e
  if (htmlDoc) {
Packit f0b94e
    htmlDoc->SetEditingState(mDetachedEditingState);
Packit f0b94e
  }
Packit f0b94e
Packit f0b94e
  return NS_OK;
Packit f0b94e
}