Blame editor/libeditor/ChangeStyleTransaction.cpp

Packit f0b94e
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
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 "mozilla/ChangeStyleTransaction.h"
Packit f0b94e
Packit f0b94e
#include "mozilla/dom/Element.h"  // for Element
Packit f0b94e
#include "nsAString.h"            // for nsAString::Append, etc.
Packit f0b94e
#include "nsCRT.h"                // for nsCRT::IsAsciiSpace
Packit f0b94e
#include "nsDebug.h"              // for NS_ENSURE_SUCCESS, etc.
Packit f0b94e
#include "nsError.h"              // for NS_ERROR_NULL_POINTER, etc.
Packit f0b94e
#include "nsGkAtoms.h"            // for nsGkAtoms, etc.
Packit f0b94e
#include "nsICSSDeclaration.h"    // for nsICSSDeclaration.
Packit f0b94e
#include "nsLiteralString.h"      // for NS_LITERAL_STRING, etc.
Packit f0b94e
#include "nsReadableUtils.h"      // for ToNewUnicode
Packit f0b94e
#include "nsString.h"             // for nsAutoString, nsString, etc.
Packit f0b94e
#include "nsStyledElement.h"      // for nsStyledElement.
Packit f0b94e
#include "nsUnicharUtils.h"       // for nsCaseInsensitiveStringComparator
Packit f0b94e
Packit f0b94e
namespace mozilla {
Packit f0b94e
Packit f0b94e
using namespace dom;
Packit f0b94e
Packit f0b94e
// static
Packit f0b94e
already_AddRefed<ChangeStyleTransaction> ChangeStyleTransaction::Create(
Packit f0b94e
    Element& aElement, nsAtom& aProperty, const nsAString& aValue) {
Packit f0b94e
  RefPtr<ChangeStyleTransaction> transaction =
Packit f0b94e
      new ChangeStyleTransaction(aElement, aProperty, aValue, false);
Packit f0b94e
  return transaction.forget();
Packit f0b94e
}
Packit f0b94e
Packit f0b94e
// static
Packit f0b94e
already_AddRefed<ChangeStyleTransaction> ChangeStyleTransaction::CreateToRemove(
Packit f0b94e
    Element& aElement, nsAtom& aProperty, const nsAString& aValue) {
Packit f0b94e
  RefPtr<ChangeStyleTransaction> transaction =
Packit f0b94e
      new ChangeStyleTransaction(aElement, aProperty, aValue, true);
Packit f0b94e
  return transaction.forget();
Packit f0b94e
}
Packit f0b94e
Packit f0b94e
ChangeStyleTransaction::ChangeStyleTransaction(Element& aElement,
Packit f0b94e
                                               nsAtom& aProperty,
Packit f0b94e
                                               const nsAString& aValue,
Packit f0b94e
                                               bool aRemove)
Packit f0b94e
    : EditTransactionBase(),
Packit f0b94e
      mElement(&aElement),
Packit f0b94e
      mProperty(&aProperty),
Packit f0b94e
      mValue(aValue),
Packit f0b94e
      mRemoveProperty(aRemove),
Packit f0b94e
      mUndoValue(),
Packit f0b94e
      mRedoValue(),
Packit f0b94e
      mUndoAttributeWasSet(false),
Packit f0b94e
      mRedoAttributeWasSet(false) {}
Packit f0b94e
Packit f0b94e
#define kNullCh (char16_t('\0'))
Packit f0b94e
Packit f0b94e
NS_IMPL_CYCLE_COLLECTION_INHERITED(ChangeStyleTransaction, EditTransactionBase,
Packit f0b94e
                                   mElement)
Packit f0b94e
Packit f0b94e
NS_INTERFACE_MAP_BEGIN_CYCLE_COLLECTION(ChangeStyleTransaction)
Packit f0b94e
NS_INTERFACE_MAP_END_INHERITING(EditTransactionBase)
Packit f0b94e
Packit f0b94e
NS_IMPL_ADDREF_INHERITED(ChangeStyleTransaction, EditTransactionBase)
Packit f0b94e
NS_IMPL_RELEASE_INHERITED(ChangeStyleTransaction, EditTransactionBase)
Packit f0b94e
Packit f0b94e
ChangeStyleTransaction::~ChangeStyleTransaction() {}
Packit f0b94e
Packit f0b94e
// Answers true if aValue is in the string list of white-space separated values
Packit f0b94e
// aValueList.
Packit f0b94e
bool ChangeStyleTransaction::ValueIncludes(const nsAString& aValueList,
Packit f0b94e
                                           const nsAString& aValue) {
Packit f0b94e
  nsAutoString valueList(aValueList);
Packit f0b94e
  bool result = false;
Packit f0b94e
Packit f0b94e
  // put an extra null at the end
Packit f0b94e
  valueList.Append(kNullCh);
Packit f0b94e
Packit f0b94e
  char16_t* value = ToNewUnicode(aValue);
Packit f0b94e
  char16_t* start = valueList.BeginWriting();
Packit f0b94e
  char16_t* end = start;
Packit f0b94e
Packit f0b94e
  while (kNullCh != *start) {
Packit f0b94e
    while (kNullCh != *start && nsCRT::IsAsciiSpace(*start)) {
Packit f0b94e
      // skip leading space
Packit f0b94e
      start++;
Packit f0b94e
    }
Packit f0b94e
    end = start;
Packit f0b94e
Packit f0b94e
    while (kNullCh != *end && !nsCRT::IsAsciiSpace(*end)) {
Packit f0b94e
      // look for space or end
Packit f0b94e
      end++;
Packit f0b94e
    }
Packit f0b94e
    // end string here
Packit f0b94e
    *end = kNullCh;
Packit f0b94e
Packit f0b94e
    if (start < end) {
Packit f0b94e
      if (nsDependentString(value).Equals(
Packit f0b94e
              nsDependentString(start), nsCaseInsensitiveStringComparator())) {
Packit f0b94e
        result = true;
Packit f0b94e
        break;
Packit f0b94e
      }
Packit f0b94e
    }
Packit f0b94e
    start = ++end;
Packit f0b94e
  }
Packit f0b94e
  free(value);
Packit f0b94e
  return result;
Packit f0b94e
}
Packit f0b94e
Packit f0b94e
// Removes the value aRemoveValue from the string list of white-space separated
Packit f0b94e
// values aValueList
Packit f0b94e
void ChangeStyleTransaction::RemoveValueFromListOfValues(
Packit f0b94e
    nsAString& aValues, const nsAString& aRemoveValue) {
Packit f0b94e
  nsAutoString classStr(aValues);
Packit f0b94e
  nsAutoString outString;
Packit f0b94e
  // put an extra null at the end
Packit f0b94e
  classStr.Append(kNullCh);
Packit f0b94e
Packit f0b94e
  char16_t* start = classStr.BeginWriting();
Packit f0b94e
  char16_t* end = start;
Packit f0b94e
Packit f0b94e
  while (kNullCh != *start) {
Packit f0b94e
    while (kNullCh != *start && nsCRT::IsAsciiSpace(*start)) {
Packit f0b94e
      // skip leading space
Packit f0b94e
      start++;
Packit f0b94e
    }
Packit f0b94e
    end = start;
Packit f0b94e
Packit f0b94e
    while (kNullCh != *end && !nsCRT::IsAsciiSpace(*end)) {
Packit f0b94e
      // look for space or end
Packit f0b94e
      end++;
Packit f0b94e
    }
Packit f0b94e
    // end string here
Packit f0b94e
    *end = kNullCh;
Packit f0b94e
Packit f0b94e
    if (start < end && !aRemoveValue.Equals(start)) {
Packit f0b94e
      outString.Append(start);
Packit f0b94e
      outString.Append(char16_t(' '));
Packit f0b94e
    }
Packit f0b94e
Packit f0b94e
    start = ++end;
Packit f0b94e
  }
Packit f0b94e
  aValues.Assign(outString);
Packit f0b94e
}
Packit f0b94e
Packit f0b94e
NS_IMETHODIMP
Packit f0b94e
ChangeStyleTransaction::DoTransaction() {
Packit f0b94e
  nsCOMPtr<nsStyledElement> inlineStyles = do_QueryInterface(mElement);
Packit f0b94e
  NS_ENSURE_TRUE(inlineStyles, NS_ERROR_NULL_POINTER);
Packit f0b94e
Packit f0b94e
  nsCOMPtr<nsICSSDeclaration> cssDecl = inlineStyles->Style();
Packit f0b94e
Packit f0b94e
  nsAutoString propertyNameString;
Packit f0b94e
  mProperty->ToString(propertyNameString);
Packit f0b94e
Packit f0b94e
  mUndoAttributeWasSet = mElement->HasAttr(kNameSpaceID_None, nsGkAtoms::style);
Packit f0b94e
Packit f0b94e
  nsAutoString values;
Packit f0b94e
  nsresult rv = cssDecl->GetPropertyValue(propertyNameString, values);
Packit f0b94e
  NS_ENSURE_SUCCESS(rv, rv);
Packit f0b94e
  mUndoValue.Assign(values);
Packit f0b94e
Packit f0b94e
  // Does this property accept more than one value? (bug 62682)
Packit f0b94e
  bool multiple = AcceptsMoreThanOneValue(*mProperty);
Packit f0b94e
Packit f0b94e
  if (mRemoveProperty) {
Packit f0b94e
    nsAutoString returnString;
Packit f0b94e
    if (multiple) {
Packit f0b94e
      // Let's remove only the value we have to remove and not the others
Packit f0b94e
Packit f0b94e
      // The two lines below are a workaround because
Packit f0b94e
      // nsDOMCSSDeclaration::GetPropertyCSSValue is not yet implemented (bug
Packit f0b94e
      // 62682)
Packit f0b94e
      RemoveValueFromListOfValues(values, NS_LITERAL_STRING("none"));
Packit f0b94e
      RemoveValueFromListOfValues(values, mValue);
Packit f0b94e
      if (values.IsEmpty()) {
Packit f0b94e
        rv = cssDecl->RemoveProperty(propertyNameString, returnString);
Packit f0b94e
        NS_ENSURE_SUCCESS(rv, rv);
Packit f0b94e
      } else {
Packit f0b94e
        nsAutoString priority;
Packit f0b94e
        cssDecl->GetPropertyPriority(propertyNameString, priority);
Packit f0b94e
        rv = cssDecl->SetProperty(propertyNameString, values, priority);
Packit f0b94e
        NS_ENSURE_SUCCESS(rv, rv);
Packit f0b94e
      }
Packit f0b94e
    } else {
Packit f0b94e
      rv = cssDecl->RemoveProperty(propertyNameString, returnString);
Packit f0b94e
      NS_ENSURE_SUCCESS(rv, rv);
Packit f0b94e
    }
Packit f0b94e
  } else {
Packit f0b94e
    nsAutoString priority;
Packit f0b94e
    cssDecl->GetPropertyPriority(propertyNameString, priority);
Packit f0b94e
    if (multiple) {
Packit f0b94e
      // Let's add the value we have to add to the others
Packit f0b94e
Packit f0b94e
      // The line below is a workaround because
Packit f0b94e
      // nsDOMCSSDeclaration::GetPropertyCSSValue is not yet implemented (bug
Packit f0b94e
      // 62682)
Packit f0b94e
      AddValueToMultivalueProperty(values, mValue);
Packit f0b94e
    } else {
Packit f0b94e
      values.Assign(mValue);
Packit f0b94e
    }
Packit f0b94e
    rv = cssDecl->SetProperty(propertyNameString, values, priority);
Packit f0b94e
    NS_ENSURE_SUCCESS(rv, rv);
Packit f0b94e
  }
Packit f0b94e
Packit f0b94e
  // Let's be sure we don't keep an empty style attribute
Packit f0b94e
  uint32_t length = cssDecl->Length();
Packit f0b94e
  if (!length) {
Packit f0b94e
    rv = mElement->UnsetAttr(kNameSpaceID_None, nsGkAtoms::style, true);
Packit f0b94e
    NS_ENSURE_SUCCESS(rv, rv);
Packit f0b94e
  } else {
Packit f0b94e
    mRedoAttributeWasSet = true;
Packit f0b94e
  }
Packit f0b94e
Packit f0b94e
  return cssDecl->GetPropertyValue(propertyNameString, mRedoValue);
Packit f0b94e
}
Packit f0b94e
Packit f0b94e
nsresult ChangeStyleTransaction::SetStyle(bool aAttributeWasSet,
Packit f0b94e
                                          nsAString& aValue) {
Packit f0b94e
  if (aAttributeWasSet) {
Packit f0b94e
    // The style attribute was not empty, let's recreate the declaration
Packit f0b94e
    nsAutoString propertyNameString;
Packit f0b94e
    mProperty->ToString(propertyNameString);
Packit f0b94e
Packit f0b94e
    nsCOMPtr<nsStyledElement> inlineStyles = do_QueryInterface(mElement);
Packit f0b94e
    NS_ENSURE_TRUE(inlineStyles, NS_ERROR_NULL_POINTER);
Packit f0b94e
    nsCOMPtr<nsICSSDeclaration> cssDecl = inlineStyles->Style();
Packit f0b94e
Packit f0b94e
    if (aValue.IsEmpty()) {
Packit f0b94e
      // An empty value means we have to remove the property
Packit f0b94e
      nsAutoString returnString;
Packit f0b94e
      return cssDecl->RemoveProperty(propertyNameString, returnString);
Packit f0b94e
    }
Packit f0b94e
    // Let's recreate the declaration as it was
Packit f0b94e
    nsAutoString priority;
Packit f0b94e
    cssDecl->GetPropertyPriority(propertyNameString, priority);
Packit f0b94e
    return cssDecl->SetProperty(propertyNameString, aValue, priority);
Packit f0b94e
  }
Packit f0b94e
  return mElement->UnsetAttr(kNameSpaceID_None, nsGkAtoms::style, true);
Packit f0b94e
}
Packit f0b94e
Packit f0b94e
NS_IMETHODIMP
Packit f0b94e
ChangeStyleTransaction::UndoTransaction() {
Packit f0b94e
  return SetStyle(mUndoAttributeWasSet, mUndoValue);
Packit f0b94e
}
Packit f0b94e
Packit f0b94e
NS_IMETHODIMP
Packit f0b94e
ChangeStyleTransaction::RedoTransaction() {
Packit f0b94e
  return SetStyle(mRedoAttributeWasSet, mRedoValue);
Packit f0b94e
}
Packit f0b94e
Packit f0b94e
// True if the CSS property accepts more than one value
Packit f0b94e
bool ChangeStyleTransaction::AcceptsMoreThanOneValue(nsAtom& aCSSProperty) {
Packit f0b94e
  return &aCSSProperty == nsGkAtoms::text_decoration;
Packit f0b94e
}
Packit f0b94e
Packit f0b94e
// Adds the value aNewValue to the list of white-space separated values aValues
Packit f0b94e
void ChangeStyleTransaction::AddValueToMultivalueProperty(
Packit f0b94e
    nsAString& aValues, const nsAString& aNewValue) {
Packit f0b94e
  if (aValues.IsEmpty() || aValues.LowerCaseEqualsLiteral("none")) {
Packit f0b94e
    aValues.Assign(aNewValue);
Packit f0b94e
  } else if (!ValueIncludes(aValues, aNewValue)) {
Packit f0b94e
    // We already have another value but not this one; add it
Packit f0b94e
    aValues.Append(char16_t(' '));
Packit f0b94e
    aValues.Append(aNewValue);
Packit f0b94e
  }
Packit f0b94e
}
Packit f0b94e
Packit f0b94e
}  // namespace mozilla