gecko/content/smil/nsSMILMappedAttribute.cpp

177 lines
6.5 KiB
C++

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is the Mozilla SMIL module.
*
* The Initial Developer of the Original Code is the Mozilla Corporation.
* Portions created by the Initial Developer are Copyright (C) 2010
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Daniel Holbert <dholbert@mozilla.com>
*
* Alternatively, the contents of this file may be used under the terms of
* either of the GNU General Public License Version 2 or later (the "GPL"),
* or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
* in which case the provisions of the GPL or the LGPL are applicable instead
* of those above. If you wish to allow use of your version of this file only
* under the terms of either the GPL or the LGPL, and not to allow others to
* use your version of this file under the terms of the MPL, indicate your
* decision by deleting the provisions above and replace them with the notice
* and other provisions required by the GPL or the LGPL. If you do not delete
* the provisions above, a recipient may use your version of this file under
* the terms of any one of the MPL, the GPL or the LGPL.
*
* ***** END LICENSE BLOCK ***** */
/* representation of a SMIL-animatable mapped attribute on an element */
#include "nsSMILMappedAttribute.h"
#include "nsPropertyTable.h"
#include "nsContentErrors.h" // For NS_PROPTABLE_PROP_OVERWRITTEN
#include "nsSMILValue.h"
#include "nsSMILCSSValueType.h"
#include "nsIContent.h"
#include "nsIDocument.h"
#include "nsIPresShell.h"
#include "nsCSSProps.h"
// Callback function, for freeing string buffers stored in property table
static void
ReleaseStringBufferPropertyValue(void* aObject, /* unused */
nsIAtom* aPropertyName, /* unused */
void* aPropertyValue,
void* aData /* unused */)
{
nsStringBuffer* buf = static_cast<nsStringBuffer*>(aPropertyValue);
buf->Release();
}
nsresult
nsSMILMappedAttribute::ValueFromString(const nsAString& aStr,
const nsISMILAnimationElement* aSrcElement,
nsSMILValue& aValue,
PRBool& aCanCache) const
{
NS_ENSURE_TRUE(IsPropertyAnimatable(mPropID), NS_ERROR_FAILURE);
nsSMILCSSValueType::ValueFromString(mPropID, mElement, aStr,
PR_TRUE, aValue);
if (aValue.IsNull()) {
return NS_ERROR_FAILURE;
}
// XXXdholbert: For simplicity, just assume that all CSS values have to
// reparsed every sample. See note in nsSMILCSSProperty::ValueFromString.
aCanCache = PR_FALSE;
return NS_OK;
}
nsSMILValue
nsSMILMappedAttribute::GetBaseValue() const
{
nsAutoString baseStringValue;
nsRefPtr<nsIAtom> attrName = GetAttrNameAtom();
PRBool success = mElement->GetAttr(kNameSpaceID_None, attrName,
baseStringValue);
nsSMILValue baseValue;
if (success) {
nsSMILCSSValueType::ValueFromString(mPropID, mElement, baseStringValue,
PR_TRUE, baseValue);
} else {
// Attribute is unset -- use computed value.
// FIRST: Temporarily clear animated value, to make sure it doesn't pollute
// the computed value. (We want base value, _without_ animations applied.)
void* buf = mElement->UnsetProperty(SMIL_MAPPED_ATTR_ANIMVAL,
attrName, nsnull);
FlushChangesToTargetAttr();
// SECOND: we use nsSMILCSSProperty::GetBaseValue to look up the property's
// computed value. NOTE: This call will temporarily clear the SMIL
// override-style for the corresponding CSS property on our target element.
// This prevents any animations that target the CSS property from affecting
// animations that target the mapped attribute.
baseValue = nsSMILCSSProperty::GetBaseValue();
// FINALLY: If we originally had an animated value set, then set it again.
if (buf) {
mElement->SetProperty(SMIL_MAPPED_ATTR_ANIMVAL, attrName, buf,
ReleaseStringBufferPropertyValue);
FlushChangesToTargetAttr();
}
}
return baseValue;
}
nsresult
nsSMILMappedAttribute::SetAnimValue(const nsSMILValue& aValue)
{
NS_ENSURE_TRUE(IsPropertyAnimatable(mPropID), NS_ERROR_FAILURE);
// Convert nsSMILValue to string
nsAutoString valStr;
if (!nsSMILCSSValueType::ValueToString(aValue, valStr)) {
NS_WARNING("Failed to convert nsSMILValue for mapped attr into a string");
return NS_ERROR_FAILURE;
}
// Set the string as this mapped attribute's animated value.
nsStringBuffer* valStrBuf = nsCSSValue::BufferFromString(nsString(valStr));
nsRefPtr<nsIAtom> attrName = GetAttrNameAtom();
nsresult rv = mElement->SetProperty(SMIL_MAPPED_ATTR_ANIMVAL,
attrName, valStrBuf,
ReleaseStringBufferPropertyValue);
if (rv == NS_PROPTABLE_PROP_OVERWRITTEN) {
rv = NS_OK;
}
FlushChangesToTargetAttr();
return rv;
}
void
nsSMILMappedAttribute::ClearAnimValue()
{
nsRefPtr<nsIAtom> attrName = GetAttrNameAtom();
nsresult rv = mElement->DeleteProperty(SMIL_MAPPED_ATTR_ANIMVAL, attrName);
if (NS_SUCCEEDED(rv)) {
FlushChangesToTargetAttr();
}
// Else, there's no animated value to be cleared -- no need to flush
// changes, because we didn't change anything.
}
void
nsSMILMappedAttribute::FlushChangesToTargetAttr() const
{
// Clear animated content-style-rule
mElement->DeleteProperty(SMIL_MAPPED_ATTR_ANIMVAL,
SMIL_MAPPED_ATTR_STYLERULE_ATOM);
nsIDocument* doc = mElement->GetCurrentDoc();
// Request animation restyle
if (doc) {
nsIPresShell* shell = doc->GetPrimaryShell();
if (shell) {
shell->RestyleForAnimation(mElement);
}
}
}
already_AddRefed<nsIAtom>
nsSMILMappedAttribute::GetAttrNameAtom() const
{
return do_GetAtom(nsCSSProps::GetStringValue(mPropID));
}