Index: /cvsroot/mozilla/content/smil/Makefile.in =================================================================== RCS file: /cvsroot/mozilla/content/smil/Makefile.in diff -N content/smil/Makefile.in --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ /cvsroot/mozilla/content/smil/Makefile.in 14 Sep 2005 10:44:00 -0000 @@ -0,0 +1,48 @@ +# +# ***** 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 mozilla.org code. +# +# The Initial Developer of the Original Code is +# Netscape Communications Corporation. +# Portions created by the Initial Developer are Copyright (C) 1999 +# the Initial Developer. All Rights Reserved. +# +# Contributor(s): +# +# 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 ***** + +DEPTH = ../.. +topsrcdir = @top_srcdir@ +srcdir = @srcdir@ +VPATH = @srcdir@ + +include $(DEPTH)/config/autoconf.mk + +DIRS = public src + +include $(topsrcdir)/config/rules.mk + Index: /cvsroot/mozilla/content/smil/public/Makefile.in =================================================================== RCS file: /cvsroot/mozilla/content/smil/public/Makefile.in diff -N content/smil/public/Makefile.in --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ /cvsroot/mozilla/content/smil/public/Makefile.in 14 Sep 2005 10:44:01 -0000 @@ -0,0 +1,61 @@ +# +# ***** 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 mozilla.org code. +# +# The Initial Developer of the Original Code is +# Netscape Communications Corporation. +# Portions created by the Initial Developer are Copyright (C) 1998 +# the Initial Developer. All Rights Reserved. +# +# Contributor(s): +# +# 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 ***** + +DEPTH = ../../.. +topsrcdir = @top_srcdir@ +srcdir = @srcdir@ +VPATH = @srcdir@ + +include $(DEPTH)/config/autoconf.mk + +MODULE = content + +EXPORTS = \ + nsISMILAnimAttr.h \ + nsISMILAnimElement.h \ + nsISMILAnimVal.h \ + nsISMILAnimationController.h \ + nsISMILAnimationFunction.h \ + nsISMILAnimationRegistry.h \ + nsISMILComposable.h \ + nsISMILTimeClient.h \ + nsISMILTimeContainer.h \ + nsISMILTimedElement.h \ + $(NULL) + +include $(topsrcdir)/config/rules.mk + Index: /cvsroot/mozilla/content/smil/public/nsISMILAnimAttr.h =================================================================== RCS file: /cvsroot/mozilla/content/smil/public/nsISMILAnimAttr.h diff -N content/smil/public/nsISMILAnimAttr.h --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ /cvsroot/mozilla/content/smil/public/nsISMILAnimAttr.h 14 Sep 2005 10:44:01 -0000 @@ -0,0 +1,70 @@ +/* -*- 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 SVG project. + * + * Contributor(s): + * Brian Birtles + * + * 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 ***** */ + +#ifndef __NS_ISMILANIMATTR_H__ +#define __NS_ISMILANIMATTR_H__ + +#include "nsISupports.h" + +class nsISMILAnimVal; + +//////////////////////////////////////////////////////////////////////// +// nsISMILAnimAttr + +// {c487920a-7d12-40ff-bf3b-c39dd4797cff} +#define NS_ISMILANIMATTR_IID \ +{ 0xc487920a, 0x7d12, 0x40ff, { 0xbf, 0x3b, 0xc3, 0x9d, 0xd4, 0x79, 0x7c, 0xff } } + +class nsISMILAnimAttr : public nsISupports +{ +public: + NS_DEFINE_STATIC_IID_ACCESSOR(NS_ISMILANIMATTR_IID) + + virtual nsISMILAnimVal* GetBaseValue()=0; + virtual nsresult SetAnimValue(nsISMILAnimVal& aValue)=0; + + /* + * Factory methods + * + * NOTE: By moving these to nsISMILAnimVal, we'd be able to remove the + * dependency on this interface by nsSMILAnimationFunction and be one step + * closer to removing this interface altogether. + */ + virtual nsresult Create(nsISMILAnimVal** aResult) const = 0; + + virtual nsresult CreateFromSpec(const nsAString& aSpec, + nsISMILAnimVal** aResult) const = 0; +}; + +#endif // __NS_ISMILANIMATTR_H__ + Index: /cvsroot/mozilla/content/smil/public/nsISMILAnimElement.h =================================================================== RCS file: /cvsroot/mozilla/content/smil/public/nsISMILAnimElement.h diff -N content/smil/public/nsISMILAnimElement.h --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ /cvsroot/mozilla/content/smil/public/nsISMILAnimElement.h 14 Sep 2005 10:44:01 -0000 @@ -0,0 +1,58 @@ +/* -*- 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 SVG project. + * + * Contributor(s): + * Brian Birtles + * + * 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 ***** */ + +#ifndef __NS_ISMILANIMELEMENT__ +#define __NS_ISMILANIMELEMENT__ + +#include "nsISupports.h" +#include "nsISMILAnimAttr.h" + +//////////////////////////////////////////////////////////////////////// +// nsISMILAnimElement: interface of elements that have attributes +// that can be animated. + +// {5DD94E10-FD8D-42FB-B054-8D29F771033A} +#define NS_ISMILANIMELEMENT_IID \ +{ 0x5dd94e10, 0xfd8d, 0x42fb, { 0xb0, 0x54, 0x8d, 0x29, 0xf7, 0x71, 0x03, 0x3a } } + +class nsISMILAnimElement : public nsISupports +{ +public: + NS_DEFINE_STATIC_IID_ACCESSOR(NS_ISMILANIMELEMENT_IID) + + virtual nsISMILAnimAttr* + GetAnimAttribute(PRInt32 aNamespaceID, nsIAtom* aName)=0; +}; + +#endif // __NS_ISMILANIMELEMENT__ + Index: /cvsroot/mozilla/content/smil/public/nsISMILAnimVal.h =================================================================== RCS file: /cvsroot/mozilla/content/smil/public/nsISMILAnimVal.h diff -N content/smil/public/nsISMILAnimVal.h --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ /cvsroot/mozilla/content/smil/public/nsISMILAnimVal.h 14 Sep 2005 10:44:01 -0000 @@ -0,0 +1,127 @@ +/* -*- 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 SVG project. + * + * Contributor(s): + * Brian Birtles + * + * 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 ***** */ + +#ifndef __NS_ISMILANIMVAL_H__ +#define __NS_ISMILANIMVAL_H__ + +#include "nsISupports.h" + +//////////////////////////////////////////////////////////////////////// +// nsISMILAnimVal + +// {01d2aae5-9de4-4e8f-a1e9-ae660ad27925} +#define NS_ISMILANIMVAL_IID \ +{ 0x01d2aae5, 0x9de4, 0x4e8f, { 0xa1, 0xe9, 0xae, 0x66, 0x0a, 0xd2, 0x79, 0x25 } } + +class nsISMILAnimVal : public nsISupports +{ +public: + NS_DEFINE_STATIC_IID_ACCESSOR(NS_ISMILANIMVAL_IID) + + /** + * Calculates the 'distance' between this value and another. This is the + * distance used in paced interpolation. + * + * @param aTo The end of the interval for which the distance should be + * calculated. + * @param aDistance The result of the calculation. + * @return True on success, or false if there is no notion of distance for + * the underlying data type. + */ + virtual bool ComputeDistance(const nsISMILAnimVal& aTo, + PRFloat64& aDistance) const = 0; + + /** + * Calculates an interpolates value between this value and the specified end + * value using the specified proportion. + * + * @param aEndVal The value defining the end of the interval of + * interpolation. + * @param aUnitDistance A number between 0.0 and 1.0 (inclusive) defining + * the distance of the interpolated value in the + * interval. + * @param aResult The interpolated value. + * + * @result NS_OK on success, NS_ERROR_FAILURE if this data type cannot be + * interpolated or NS_ERROR_OUT_OF_MEMORY if insufficient memory was + * available for storing the result. + */ + virtual nsresult Interpolate(const nsISMILAnimVal& aEndVal, + float aUnitDistance, + nsISMILAnimVal& aResult) = 0; + + /** + * Add the given value to this value. This method facilitates additive and + * cumulative animation. + * + * This method will fail (return false) if the underlying datatype is not + * additive or was not specified using an additive syntax. + * + * See SVG 1.1, section 19.2.5. In particular, + * + * "If a given attribute or property can take values of keywords (which are + * not additive) or numeric values (which are additive), then additive + * animations are possible if the subsequent animation uses a numeric value + * even if the base animation uses a keyword value; however, if the subsequent + * animation uses a keyword value, additive animation is not possible." + * + * @param aAddedVal The value to add to this value. + * @return True on success, false on failure. + */ + virtual bool Add(const nsISMILAnimVal& aAddedVal) = 0; + + /** + * Assign this object the value of another. Think of this as the assignment + * operator. + * + * @param aNewVal The value to set. + * @return True on success, false on failure such as when the underlying + * type of the specified object differs. + */ + virtual bool Set(const nsISMILAnimVal& aNewVal) = 0; + + /** + * Repeats this value or the specified value a number of times. This method + * will fail (return false) if the underlying data type is not additive. + * + * @param aCount The number of times to repeat the value. + * @param aRepeatValue The value to repeat. If this parameter is null the + * current value will be repeated. + * @return True on success, false on failure. + */ + virtual bool Repeat(PRUint32 aCount, + const nsISMILAnimVal* aRepeatValue = nsnull) = 0; +}; + +#endif // __NS_ISMILANIMVAL_H__ + Index: /cvsroot/mozilla/content/smil/public/nsISMILAnimationController.h =================================================================== RCS file: /cvsroot/mozilla/content/smil/public/nsISMILAnimationController.h diff -N content/smil/public/nsISMILAnimationController.h --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ /cvsroot/mozilla/content/smil/public/nsISMILAnimationController.h 14 Sep 2005 10:44:02 -0000 @@ -0,0 +1,67 @@ +/* -*- 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 SVG project. + * + * Contributor(s): + * Brian Birtles + * + * 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 ***** */ + +#ifndef __NS_ISMILANIMATIONCONTROLLER_H__ +#define __NS_ISMILANIMATIONCONTROLLER_H__ + +#include "nsIAnimationController.h" + +#define NS_ISMILANIMATIONCONTROLLER_IID \ +{ 0xd2c81398, 0x1f30, 0x4303, { 0xbe, 0xbe, 0xc5, 0x0c, 0x01, 0xfd, 0xd8, 0x85 } } + +class nsISMILTimeContainer; + +//////////////////////////////////////////////////////////////////////// +// nsISMILAnimationController: Animation controller + +class nsISMILAnimationController : public nsIAnimationController +{ +public: + NS_DEFINE_STATIC_IID_ACCESSOR(NS_ISMILANIMATIONCONTROLLER_IID) + + // nsIAnimationController methods + virtual nsresult Pause()=0; + virtual nsresult Resume()=0; + + // Eventually, this will probably be all nsISMILTimedElements so that it is + // possible to have hierarchies of containers (which will implement + // nsISMILTimedElement), and then these methods will be replaced with + // SetRootElement. + virtual nsresult AddTimeContainer(nsISMILTimeContainer* aContainer)=0; + virtual nsresult RemoveTimeContainer(nsISMILTimeContainer* aContainer)=0; +}; + +nsISMILAnimationController* NS_NewSMILAnimationController(); + +#endif // __NS_ISMILANIMATIONCONTROLLER_H__ + Index: /cvsroot/mozilla/content/smil/public/nsISMILAnimationFunction.h =================================================================== RCS file: /cvsroot/mozilla/content/smil/public/nsISMILAnimationFunction.h diff -N content/smil/public/nsISMILAnimationFunction.h --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ /cvsroot/mozilla/content/smil/public/nsISMILAnimationFunction.h 14 Sep 2005 10:44:02 -0000 @@ -0,0 +1,104 @@ + +/* -*- 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 SVG project. + * + * Contributor(s): + * Brian Birtles + * + * 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 ***** */ + +#ifndef __NS_ISMILANIMFUNCTION_H__ +#define __NS_ISMILANIMFUNCTION_H__ + +#include "nsISupports.h" + +class nsISMILAnimAttr; + +// {14eb1aab-e4ba-4c77-be89-195ef975c90d} +#define NS_ISMILANIMFUNCTION_IID \ +{ 0x14eb1aab, 0xe4ba, 0x4c77, { 0xbe, 0x89, 0x19, 0x5e, 0xf9, 0x75, 0xc9, 0x0d } } + +/** + * Provides the animation function for an interpolating animation element. This + * includes the animation-related attributes. It is intended to be used by + * elements such as , and so on. + * + * It will likely be split into nsISMILInterpolatingAnimFunc and + * nsISMILSimpleAnimFunc when is introduced. Extra parameters or perhaps + * a subclass will probably be needed to support , + * and the like. + */ +class nsISMILAnimationFunction : public nsISupports +{ +public: + NS_DEFINE_STATIC_IID_ACCESSOR(NS_ISMILANIMFUNCTION_IID) + + virtual nsresult Init(nsISMILAnimAttr& aAttribute)=0; + virtual PRBool IsInitialised()=0; + + /* + * Property setters + */ + virtual nsresult SetAccumulate(const nsAString& aAccumulate)=0; + virtual nsresult SetAdditive(const nsAString& aAdditive)=0; + virtual nsresult SetBy(const nsAString& aBy)=0; + virtual nsresult SetCalcMode(const nsAString& aCalcMode)=0; + virtual nsresult SetFrom(const nsAString& aFrom)=0; + virtual nsresult SetKeyTimes(const nsAString& aKeyTimes)=0; + virtual nsresult SetKeySplines(const nsAString& aKeySplines)=0; + virtual nsresult SetTo(const nsAString& aTo)=0; + virtual nsresult SetValues(const nsAString& aValues)=0; + + /* + * Property unsetters + * + * Unsetters are used instead of simply passing an empty string to the setters + * as in some cases an empty string is an error whereas not specifying an + * attribute is not. + * + * Unsetters are used in preference to setting a default value so that this + * object is responsible for supplying default values and not all the + * different animation elements that use it. + */ + virtual void UnsetAdditive()=0; + virtual void UnsetBy()=0; + virtual void UnsetCalcMode()=0; + virtual void UnsetAccumulate()=0; + virtual void UnsetFrom()=0; + virtual void UnsetKeyTimes()=0; + virtual void UnsetKeySplines()=0; + virtual void UnsetTo()=0; + virtual void UnsetValues()=0; + + virtual void SetDocumentPosition(PRUint16 aDocPosition)=0; +}; + +nsISMILAnimationFunction* NS_NewSMILAnimationFunction(); + +#endif //__NS_ISMILANIMFUNCTION_H__ + Index: /cvsroot/mozilla/content/smil/public/nsISMILAnimationRegistry.h =================================================================== RCS file: /cvsroot/mozilla/content/smil/public/nsISMILAnimationRegistry.h diff -N content/smil/public/nsISMILAnimationRegistry.h --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ /cvsroot/mozilla/content/smil/public/nsISMILAnimationRegistry.h 14 Sep 2005 10:44:02 -0000 @@ -0,0 +1,71 @@ +/* -*- 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 SVG project. + * + * Contributor(s): + * Brian Birtles + * + * 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 ***** */ + +#ifndef __NS_ISMILANIMATIONREGISTRY_H__ +#define __NS_ISMILANIMATIONREGISTRY_H__ + +#include "nsISupports.h" + +class nsISMILAnimationController; +class nsISMILComposable; +class nsISMILAnimAttr; +class nsISMILTimedElement; + +#define NS_ISMILANIMATIONREGISTRY_IID \ +{ 0xdd3c7124, 0xcc1f, 0x447b, { 0xa1, 0x35, 0x4a, 0xd8, 0xfc, 0xd4, 0x9f, 0x31 } } + +//////////////////////////////////////////////////////////////////////// +// nsISMILAnimationRegistry: Entry point for SMIL animated documents + +class nsISMILAnimationRegistry : public nsISupports +{ +public: + NS_DEFINE_STATIC_IID_ACCESSOR(NS_ISMILANIMATIONREGISTRY_IID) + + virtual nsresult SetController(nsISMILAnimationController* aController)=0; + virtual void Pause()=0; + virtual void Unpause()=0; + virtual PRBool IsPaused()=0; + virtual float GetCurrentTime()=0; + virtual nsresult SetCurrentTime(float aSeconds)=0; + virtual nsresult RegisterComposable(nsISMILAnimAttr* aTargetAttr, + nsISMILComposable* aComposable)=0; + virtual nsresult UnregisterComposable(nsISMILComposable* aComposable)=0; + virtual nsresult RegisterTimedElement(nsISMILTimedElement* aElement)=0; + virtual nsresult UnregisterTimedElement(nsISMILTimedElement* aElement)=0; +}; + +nsISMILAnimationRegistry* NS_NewSMILAnimationRegistry(); + +#endif // __NS_ISMILANIMATIONREGISTRY_H__ + Index: /cvsroot/mozilla/content/smil/public/nsISMILComposable.h =================================================================== RCS file: /cvsroot/mozilla/content/smil/public/nsISMILComposable.h diff -N content/smil/public/nsISMILComposable.h --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ /cvsroot/mozilla/content/smil/public/nsISMILComposable.h 14 Sep 2005 10:44:02 -0000 @@ -0,0 +1,131 @@ +/* -*- 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 SVG project. + * + * Contributor(s): + * Brian Birtles + * + * 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 ***** */ + +#ifndef __NS_ISMILCOMPOSABLE_H__ +#define __NS_ISMILCOMPOSABLE_H__ + +#include "nsISupports.h" +#include "nsWeakReference.h" + +class nsISMILAnimVal; + +//////////////////////////////////////////////////////////////////////// +// nsISMILComposable + +// {4b05aa22-712e-4a9e-8452-f7c4b2e507e7} +#define NS_ISMILCOMPOSABLE_IID \ +{ 0x4b05aa22, 0x712e, 0x4a9e, { 0x84, 0x52, 0xf7, 0xc4, 0xb2, 0xe5, 0x07, 0xe7 } } + +class nsISMILComposable : public nsSupportsWeakReference +{ +public: + NS_DEFINE_STATIC_IID_ACCESSOR(NS_ISMILCOMPOSABLE_IID) + + /** + * Combines the result of this animation function for the last sample with the + * specified value. + * + * @param aResult The value to compose with. + */ + virtual void ComposeResult(nsISMILAnimVal &aResult)=0; + + /** + * Returns the relative priority of this animation to another. The priority is + * used for determining the position of the animation in the animation + * sandwich. + * + * @return -1 if this animation has lower priority or 1 if this animation has + * higher priority + * + * This method should never return 0. + */ + virtual PRInt8 CompareTo(const nsISMILComposable& composable) const=0; + + /* + * The following three methods are used in sorting. + */ + + /** + * Indicates if this animation is a 'to animation'. Such animations appear + * 'higher' in the animation sandwich than all other animations. + * + * @return True if this animation is a to animation, false otherwise. + */ + virtual PRBool IsToAnimation() const=0; + + /** + * Returns the begin time of this animation for the interval it is currently + * animating. For inactive animations this will be LL_MinInt but such + * animations should be filtered from compositing anyway. + * + * @return A 64-bit integer representing the begin time of this animation. + */ + virtual const PRInt64& GetBeginTime() const=0; + + /** + * Returns a unique (0-based) index indicating the position of this animation + * in the document. The first animation will have index 0 as so on. Positions + * are recalculated when the document structure is changed. + * + * @return An unsigned integer representing this animation's position in the + * document. + */ + virtual PRUint16 GetDocumentPosition() const=0; + + /* + * The following methods are provided so that the compositor can optimise its + * operations in the future by only composing those animation that will affect + * the final result. + */ + + /** + * Indicates if the animation is currently active. Inactive animations will + * not contribute to the composed result. + * + * @return True if the animation active, false otherwise. + */ + virtual PRBool IsActive() const=0; + + /** + * Indicates if this animation will replace the passed in result rather than + * adding to it. Animations that replace the underlying value may be called + * without first calling lower priority animations. + * + * @return True if the animation will replace, false if it will add or + * otherwise build on the passed in value. + */ + virtual PRBool WillReplace() const=0; +}; + +#endif // __NS_ISMILCOMPOSABLE_H__ + Index: /cvsroot/mozilla/content/smil/public/nsISMILTimeClient.h =================================================================== RCS file: /cvsroot/mozilla/content/smil/public/nsISMILTimeClient.h diff -N content/smil/public/nsISMILTimeClient.h --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ /cvsroot/mozilla/content/smil/public/nsISMILTimeClient.h 14 Sep 2005 10:44:02 -0000 @@ -0,0 +1,64 @@ +/* -*- 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 SVG project. + * + * Contributor(s): + * Brian Birtles + * + * 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 ***** */ + +#ifndef __NS_ISMILTIMECLIENT_H__ +#define __NS_ISMILTIMECLIENT_H__ + +#include "nsISupports.h" + +class nsSMILTimeValue; + +//////////////////////////////////////////////////////////////////////// +// nsISMILTimeClient + +// {196f66f4-e6f6-420b-a337-da42a2efccde} +#define NS_ISMILTIMECLIENT_IID \ +{ 0x196f66f4, 0xe6f6, 0x420b, { 0xa3, 0x37, 0xda, 0x42, 0xa2, 0xef, 0xcc, 0xde } } + +class nsISMILTimeClient : public nsISupports +{ +public: + NS_DEFINE_STATIC_IID_ACCESSOR(NS_ISMILTIMECLIENT_IID) + + virtual void SampleAt(const PRInt64& aSimpleTime, + const nsSMILTimeValue& aSimpleDuration, + const PRUint32& aRepeatIteration)=0; + + virtual void SampleLastValue(const PRUint32& aRepeatIteration)=0; + + virtual void ToActive(const PRInt64& aBeginTime)=0; + + virtual void ToInactive()=0; +}; + +#endif // __NS_ISMILTIMECLIENT_H__ Index: /cvsroot/mozilla/content/smil/public/nsISMILTimeContainer.h =================================================================== RCS file: /cvsroot/mozilla/content/smil/public/nsISMILTimeContainer.h diff -N content/smil/public/nsISMILTimeContainer.h --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ /cvsroot/mozilla/content/smil/public/nsISMILTimeContainer.h 14 Sep 2005 10:44:03 -0000 @@ -0,0 +1,67 @@ +/* -*- 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 SVG project. + * + * Contributor(s): + * Brian Birtles + * + * 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 ***** */ + +#ifndef __NS_ISMILTIMECONTAINER_H__ +#define __NS_ISMILTIMECONTAINER_H__ + +#include "nsISupports.h" +#include "nsISMILTimedElement.h" + +//////////////////////////////////////////////////////////////////////// +// nsISMILTimeContainer: Time container + +// {46b51a7b-d857-45f1-9c7d-4d0d12719238} +#define NS_ISMILTIMECONTAINER_IID \ +{ 0x46b51a7b, 0xd857, 0x45f1, { 0x9c, 0x7d, 0x4d, 0x0d, 0x12, 0x71, 0x92, 0x38 } } + +// When implementing SMIL 2.0 time containers, this would inherit from +// nsISMILTimedElement, amongst other changes +class nsISMILTimeContainer : public nsISupports +{ +public: + NS_DEFINE_STATIC_IID_ACCESSOR(NS_ISMILTIMECONTAINER_IID) + + virtual nsresult Pause()=0; + virtual nsresult Resume()=0; + + // We may later change this to SampleAt and maintain separate host document + // and document fragment times. This would allow more advanced time + // manipulations for documents with several animated SVG document fragments. + virtual void Sample()=0; + + virtual nsresult AddTimedElement(nsISMILTimedElement* aElement)=0; + virtual nsresult RemoveTimedElement(nsISMILTimedElement* aElement)=0; +}; + +#endif // __NS_ISMILTIMECONTAINER_H__ + Index: /cvsroot/mozilla/content/smil/public/nsISMILTimedElement.h =================================================================== RCS file: /cvsroot/mozilla/content/smil/public/nsISMILTimedElement.h diff -N content/smil/public/nsISMILTimedElement.h --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ /cvsroot/mozilla/content/smil/public/nsISMILTimedElement.h 14 Sep 2005 10:44:03 -0000 @@ -0,0 +1,131 @@ +/* -*- 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 SVG project. + * + * Contributor(s): + * Brian Birtles + * + * 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 ***** */ + +#ifndef __NS_ISMILTIMEDELEMENT_H__ +#define __NS_ISMILTIMEDELEMENT_H__ + +#include "nsWeakReference.h" + +class nsISMILTimeClient; +class nsSMILTimeValue; +class nsSMILInstanceTime; + +//////////////////////////////////////////////////////////////////////// +// nsISMILTimedElement + +// {c5f60446-5c1a-4f3b-8ce3-646199ac97f2} +#define NS_ISMILTIMEDELEMENT_IID \ +{ 0xc5f60446, 0x5c1a, 0x4f3b, { 0x8c, 0xe3, 0x64, 0x61, 0x99, 0xac, 0x97, 0xf2 } } + +class nsISMILTimedElement : public nsSupportsWeakReference +{ +public: + NS_DEFINE_STATIC_IID_ACCESSOR(NS_ISMILTIMEDELEMENT_IID) + + /** + * Adds an instance time object this this element's list of instance times. + * These instance times are used when creating intervals. + * + * This method is typically called by a nsSMILTimeValueSpec to register an + * instance time corresponding its specification. + * + * @param aInstanceTime The time to add. + * + * @param aIsBegin True if the time to be added represents a begin time + * or False if it represents an end time. + */ + virtual void AddInstanceTime(nsSMILInstanceTime* aInstanceTime, + PRBool aIsBegin)=0; + + /** + * Sets the object that will be called by this timed element each time it is + * sampled. + * + * In Schmitz's model it is possible to associate several time clients with + * a timed element but for now we only allow one. + * + * @param aClient The time client to associate. Any previous time client + * will be disassociated and no longer sampled. Setting this + * to NULL will simply disassociate the previous client, if + * any. + */ + virtual void SetTimeClient(nsISMILTimeClient* aClient)=0; + + /** + * Samples the object at the given document time. Timing intervals are updated + * and if this element is active at the given time the associated time client + * to be sampled with the appropriate simple time. + * + * @param aDocumentTime The document time at which to sample. + */ + virtual void SampleAt(const PRInt64& aDocumentTime)=0; + + /* + * Property setters + */ + virtual nsresult SetBeginSpec(const nsAString& aBeginSpec)=0; + virtual nsresult SetEndSpec(const nsAString& aEndSpec)=0; + virtual nsresult SetSimpleDuration(const nsAString& aDurSpec)=0; + virtual nsresult SetMin(const nsAString& aMinSpec)=0; + virtual nsresult SetMax(const nsAString& aMaxSpec)=0; + virtual nsresult SetRestart(const nsAString& aRestartSpec)=0; + virtual nsresult SetRepeatCount(const nsAString& aRepeatCountSpec)=0; + virtual nsresult SetRepeatDur(const nsAString& aRepeatDurSpec)=0; + virtual nsresult SetFillMode(const nsAString& aFillModeSpec)=0; + + /* + * Property unsetters + * + * Unsetters are used instead of simply passing an empty string to the setters + * as in some cases an empty string is an error whereas not specifying an + * attribute is not. + * + * Unsetters are used in preference to setting a default value so that this + * object is responsible for supplying default values and not all the + * different animation elements that use it. + */ + virtual void UnsetBeginSpec()=0; + virtual void UnsetEndSpec()=0; + virtual void UnsetSimpleDuration()=0; + virtual void UnsetMin()=0; + virtual void UnsetMax()=0; + virtual void UnsetRestart()=0; + virtual void UnsetRepeatCount()=0; + virtual void UnsetRepeatDur()=0; + virtual void UnsetFillMode()=0; +}; + +nsISMILTimedElement* NS_NewSMILTimedElement(); + +#endif // __NS_ISMILTIMEDELEMENT_H__ + Index: /cvsroot/mozilla/content/smil/src/Makefile.in =================================================================== RCS file: /cvsroot/mozilla/content/smil/src/Makefile.in diff -N content/smil/src/Makefile.in --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ /cvsroot/mozilla/content/smil/src/Makefile.in 14 Sep 2005 10:44:03 -0000 @@ -0,0 +1,83 @@ +# +# ***** 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 mozilla.org code. +# +# The Initial Developer of the Original Code is +# Netscape Communications Corporation. +# Portions created by the Initial Developer are Copyright (C) 1998 +# the Initial Developer. All Rights Reserved. +# +# Contributor(s): +# +# 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 ***** + +DEPTH = ../../.. +topsrcdir = @top_srcdir@ +srcdir = @srcdir@ +VPATH = @srcdir@ + +include $(DEPTH)/config/autoconf.mk + +MODULE = content +LIBRARY_NAME = gkconsmil_s +LIBXUL_LIBRARY = 1 + +REQUIRES = xpcom \ + string \ + js \ + layout \ + content \ + necko \ + xpconnect \ + docshell \ + webshell \ + imglib2 \ + unicharutil \ + locale \ + $(NULL) + +CPPSRCS = \ + nsSMILAnimationController.cpp \ + nsSMILAnimationFunction.cpp \ + nsSMILAnimationRegistry.cpp \ + nsSMILCompositor.cpp \ + nsSMILInstanceTime.cpp \ + nsSMILInterval.cpp \ + nsSMILTimedDocumentRoot.cpp \ + nsSMILTimedElement.cpp \ + nsSMILTimeValue.cpp \ + nsSMILTimeValueSpec.cpp \ + $(NULL) + +include $(topsrcdir)/config/config.mk + +# we don't want the shared lib, but we want to force the creation of a static lib. +FORCE_STATIC_LIB = 1 + +include $(topsrcdir)/config/rules.mk + +DEFINES += -D_IMPL_NS_LAYOUT Index: /cvsroot/mozilla/content/smil/src/nsSMILAnimationController.cpp =================================================================== RCS file: /cvsroot/mozilla/content/smil/src/nsSMILAnimationController.cpp diff -N content/smil/src/nsSMILAnimationController.cpp --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ /cvsroot/mozilla/content/smil/src/nsSMILAnimationController.cpp 14 Sep 2005 10:44:04 -0000 @@ -0,0 +1,253 @@ +/* -*- 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 SVG project. + * + * Contributor(s): + * Brian Birtles + * + * 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 ***** */ + +#include "nsISMILAnimationController.h" +#include "nsComponentManagerUtils.h" +#include "nsWeakReference.h" +#include "nsITimer.h" +#include "nsISMILTimeContainer.h" +#include "nsCOMArray.h" +#include "nsISimpleEnumerator.h" +#include "nsArrayEnumerator.h" + +class nsSMILAnimationController : public nsISMILAnimationController, + public nsSupportsWeakReference, + public nsITimerCallback +{ +public: + virtual ~nsSMILAnimationController(); + + NS_DECL_ISUPPORTS + NS_DECL_NSITIMERCALLBACK + + // nsISMILAnimationController + virtual nsresult Pause(); + virtual nsresult Resume(); + virtual nsresult AddTimeContainer(nsISMILTimeContainer* aContainer); + virtual nsresult RemoveTimeContainer(nsISMILTimeContainer* aContainer); + +protected: + friend nsISMILAnimationController* NS_NewSMILAnimationController(); + + nsresult Init(); + nsresult StartTimer(); + nsresult StopTimer(); + void SampleChildren(); + + nsCOMPtr mTimer; + nsCOMArray mTimeContainers; +}; + +//////////////////////////////////////////////////////////////////////// +// nsSMILAnimationController implementation + +//---------------------------------------------------------------------- +// ctors, dtors, factory methods + +nsSMILAnimationController::~nsSMILAnimationController() +{ + if (mTimer) + mTimer->Cancel(); +} + +nsISMILAnimationController* NS_NewSMILAnimationController() +{ + nsSMILAnimationController* animationController = + new nsSMILAnimationController(); + + if (animationController) + { + nsresult rv = animationController->Init(); + if (NS_FAILED(rv)) + { + delete animationController; + animationController = nsnull; + } + } + + return animationController; +} + + +//---------------------------------------------------------------------- +// nsISupports methods: + +NS_IMPL_ISUPPORTS3(nsSMILAnimationController, + nsISMILAnimationController, + nsIAnimationController, + nsISupportsWeakReference); + +//---------------------------------------------------------------------- +// nsITimerCallback methods + +NS_IMETHODIMP +nsSMILAnimationController::Notify(nsITimer *timer) +{ + NS_ASSERTION(mTimer == timer, + "nsSMILAnimationController::Notify called with incorrect timer"); + + SampleChildren(); + + return NS_OK; +} + + +//---------------------------------------------------------------------- +// nsISMILAnimationController methods: + +nsresult +nsSMILAnimationController::Pause() +{ + // TODO[2]: (for now this just involves calling pause on all the children) + NS_NOTYETIMPLEMENTED("nsSMILAnimationController::Pause"); + return NS_ERROR_NOT_IMPLEMENTED; +} + +nsresult +nsSMILAnimationController::Resume() +{ + // TODO[2]: (for now this just involves calling resume on all the children) + NS_NOTYETIMPLEMENTED("nsSMILAnimationController::Resume"); + return NS_ERROR_NOT_IMPLEMENTED; +} + +nsresult +nsSMILAnimationController::AddTimeContainer(nsISMILTimeContainer* aContainer) +{ + if (!aContainer) + return NS_ERROR_NULL_POINTER; + + nsresult rv; + nsCOMPtr weakRef( + getter_AddRefs(do_GetWeakReference(aContainer, &rv)) ); + + if (NS_SUCCEEDED(rv)) + rv = (mTimeContainers.AppendObject(weakRef)) ? NS_OK : NS_ERROR_FAILURE; + + if (NS_SUCCEEDED(rv) && mTimeContainers.Count() == 1) + rv = StartTimer(); + + return rv; +} + +nsresult +nsSMILAnimationController::RemoveTimeContainer(nsISMILTimeContainer* aContainer) +{ + if (!aContainer) + return NS_ERROR_NULL_POINTER; + + nsresult rv; + nsCOMPtr weakRef( + getter_AddRefs(do_GetWeakReference(aContainer, &rv)) ); + + if (NS_SUCCEEDED(rv)) + rv = (mTimeContainers.RemoveObject(weakRef)) ? NS_OK : NS_ERROR_FAILURE; + + if (NS_SUCCEEDED(rv) && mTimeContainers.Count() == 0) + rv = StopTimer(); + + return rv; +} + +//---------------------------------------------------------------------- +// Implementation helpers: + +nsresult +nsSMILAnimationController::Init() +{ + mTimer = do_CreateInstance("@mozilla.org/timer;1"); + return (mTimer) ? NS_OK : NS_ERROR_OUT_OF_MEMORY; +} + +nsresult +nsSMILAnimationController::StartTimer() +{ + NS_ASSERTION(mTimer, "NULL timer!"); + + // TODO[2]: Remove magic number and make timer self-tuning + return mTimer->InitWithCallback(NS_STATIC_CAST(nsITimerCallback*, this), + 25, nsITimer::TYPE_REPEATING_SLACK); +} + +nsresult +nsSMILAnimationController::StopTimer() +{ + NS_ASSERTION(mTimer, "NULL timer!"); + + return mTimer->Cancel(); +} + +void +nsSMILAnimationController::SampleChildren() +{ + // Creating a new enumerator each sample provides thread-safety but I'm not + // sure what the cost is + + nsCOMPtr enumerator; + nsresult rv = + NS_NewArrayEnumerator(getter_AddRefs(enumerator), mTimeContainers); + NS_ENSURE_SUCCESS(rv,); + + PRBool more = PR_FALSE; + nsCOMPtr container; + nsCOMPtr weakRef; + + while (NS_SUCCEEDED(enumerator->HasMoreElements(&more)) && more) + { + if (NS_FAILED(enumerator->GetNext(getter_AddRefs(weakRef))) || !weakRef) + break; + + container = do_QueryReferent(weakRef); + + if (container) + container->Sample(); + } + + /* Non-thread safe version + PRUint32 i = mTimeContainers.Count(); + while (i > 0) + { + --i; + nsCOMPtr + container( do_QueryReferent(mTimeContainers[i]) ); + // The above could be replaced with mTimeContainers.SafeObjectAt(i) to + // provide a little more safety + + if (container) + container->Sample(); + else + mTimeContainers.RemoveObjectAt(i); + } + */ +} + Index: /cvsroot/mozilla/content/smil/src/nsSMILAnimationFunction.cpp =================================================================== RCS file: /cvsroot/mozilla/content/smil/src/nsSMILAnimationFunction.cpp diff -N content/smil/src/nsSMILAnimationFunction.cpp --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ /cvsroot/mozilla/content/smil/src/nsSMILAnimationFunction.cpp 14 Sep 2005 10:44:05 -0000 @@ -0,0 +1,731 @@ +/* -*- 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 SVG project. + * + * Contributor(s): + * Brian Birtles + * + * 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 ***** */ + +#include "nsISMILAnimationFunction.h" +#include "nsISMILComposable.h" +#include "nsISMILTimeClient.h" +#include "nsSMILTimeValue.h" +#include "nsISMILAnimVal.h" +#include "nsISMILAnimAttr.h" +#include "nsCOMPtr.h" +#include "nsCOMArray.h" +#include "nsReadableUtils.h" +#include "nsString.h" +#include "nsCRT.h" +#include + +//---------------------------------------------------------------------- +// nsSMILAnimationFunction + +class nsSMILAnimationFunction : public nsISMILAnimationFunction, + public nsISMILComposable, + public nsISMILTimeClient +{ +public: + nsSMILAnimationFunction(); + + NS_DECL_ISUPPORTS + + // nsISMILAnimationFunction + virtual nsresult Init(nsISMILAnimAttr& aAttribute); + virtual PRBool IsInitialised(); + + virtual nsresult SetAccumulate(const nsAString& aAccumulate); + virtual nsresult SetAdditive(const nsAString& aAdditive); + virtual nsresult SetBy(const nsAString& aBy); + virtual nsresult SetCalcMode(const nsAString& aCalcMode); + virtual nsresult SetFrom(const nsAString& aFrom); + virtual nsresult SetKeyTimes(const nsAString& aKeyTimes); + virtual nsresult SetKeySplines(const nsAString& aKeySplines); + virtual nsresult SetTo(const nsAString& aTo); + virtual nsresult SetValues(const nsAString& aValues); + + virtual void UnsetAdditive(); + virtual void UnsetBy(); + virtual void UnsetCalcMode(); + virtual void UnsetAccumulate(); + virtual void UnsetFrom(); + virtual void UnsetKeyTimes(); + virtual void UnsetKeySplines(); + virtual void UnsetTo(); + virtual void UnsetValues(); + + virtual void SetDocumentPosition(PRUint16 aDocPosition); + + // nsISMILTimeClient methods + virtual void SampleAt(const PRInt64& aSimpleTime, + const nsSMILTimeValue& aSimpleDuration, + const PRUint32& aRepeatIteration); + virtual void SampleLastValue(const PRUint32& aRepeatIteration); + virtual void ToActive(const PRInt64& aBeginTime); + virtual void ToInactive(); + + // nsISMILComposable methods + virtual void ComposeResult(nsISMILAnimVal &aResult); + virtual PRInt8 CompareTo(const nsISMILComposable& composable) const; + virtual PRBool IsToAnimation() const; + virtual const PRInt64& GetBeginTime() const; + virtual PRUint16 GetDocumentPosition() const; + virtual PRBool IsActive() const; + virtual PRBool WillReplace() const; + +protected: + // Implementation helpers + nsISMILAnimationFunction* NS_NewSMILAnimationFunction(); + virtual void FillValuesArray(); + virtual PRBool IsAdditive() const; + + // Members + + /* + * The attribute being targeted. This is needed for parsing animation function + * values and creating temporary objects. + */ + nsCOMPtr mAttribute; + + /* + * There are a lot of member variables here. Most of these are keeping track + * of the state of various attributes so that as they are set and unset we + * know which ones to apply. This could be done more effectively in the + * element that owns this object (for example, by calling GetAttr) but we take + * care of it here as we expect many elements will reuse this logic. + */ + PRBool mIsActive; + + /* + * Animation function values. + */ + nsCOMPtr mFrom; + nsCOMPtr mTo; + nsCOMPtr mBy; + nsCOMArray mValues; + + /* + * When the values attribute isn't set explicitly, the mValues array is filled + * with an equivalent set of values based on the from, to and by attributes. + * This flag indicates if the values array is filled with values from an + * actual values attribute (in which case it is true) or if it has been filled + * with the values of from, to and by (in which case it is false). + */ + PRBool mValuesIsSet; + + enum nsSMILCalcMode + { + NS_SMIL_CALCMODE_LINEAR, + NS_SMIL_CALCMODE_DISCRETE, + NS_SMIL_CALCMODE_PACED, + NS_SMIL_CALCMODE_SPLINE + }; + nsSMILCalcMode mCalcMode; + + PRBool mAdditive; + + /* + * These are the parameters provided by the previous sample. Currently we + * perform lazy calculation. That is, we only calculate the result if and when + * instructed by the compositor. This allows us to apply the result directly + * to the animation value and allows the compositor to filter out functions + * that it determines will not contribute to the final result. + */ + PRInt64 mSimpleTime; + nsSMILTimeValue mSimpleDuration; + PRUint32 mRepeatIteration; + PRBool mLastValue; + + PRInt64 mBeginTime; + PRUint16 mDocumentPosition; +}; + +//---------------------------------------------------------------------- +// Constructors etc. + +nsSMILAnimationFunction::nsSMILAnimationFunction() + : mValuesIsSet(PR_FALSE), + mCalcMode(NS_SMIL_CALCMODE_LINEAR), + mAdditive(PR_FALSE), + mIsActive(PR_FALSE), + mSimpleTime(-1), + mRepeatIteration(0), + mLastValue(PR_FALSE), + mBeginTime(LL_MinInt()), + mDocumentPosition(PR_UINT16_MAX) +{ +} + +nsISMILAnimationFunction* +NS_NewSMILAnimationFunction() +{ + return new nsSMILAnimationFunction(); +} + +//---------------------------------------------------------------------- +// nsISupports methods: + +NS_IMPL_ISUPPORTS4(nsSMILAnimationFunction, + nsISMILAnimationFunction, + nsISMILComposable, + nsISMILTimeClient, + nsISupportsWeakReference) + +//---------------------------------------------------------------------- +// nsISMILAnimationFunction methods: + +nsresult +nsSMILAnimationFunction::Init(nsISMILAnimAttr& aAttribute) +{ + mAttribute = &aAttribute; + return NS_OK; +} + +PRBool +nsSMILAnimationFunction::IsInitialised() +{ + return (mAttribute != nsnull); +} + +nsresult +nsSMILAnimationFunction::SetAdditive(const nsAString& aAdditive) +{ + /* + * We could use nsSVGEnum here but I'd prefer to keep this module independent + * of SVG if possible. Besides, the enums are very simple. + */ + nsresult rv = NS_ERROR_FAILURE; + mAdditive = PR_FALSE; + char* str = ToNewCString(aAdditive); + char* val = str; + + while (*val && NS_IS_SPACE(*val)) + ++val; + + if (*val != 0) { + if (PL_strncmp(val, "sum", 3) == 0) { + mAdditive = PR_TRUE; + val += 3; + rv = NS_OK; + } else if (PL_strncmp(val, "replace", 7) == 0) { + val += 7; + rv = NS_OK; + } + } + + if (NS_SUCCEEDED(rv)) { + while (*val && NS_IS_SPACE(*val)) + ++val; + if (*val != 0) { + mAdditive = PR_FALSE; + rv = NS_ERROR_FAILURE; + } + } + + nsMemory::Free(str); + + return rv; +} + +void +nsSMILAnimationFunction::UnsetAdditive() +{ + mAdditive = PR_FALSE; +} + +nsresult +nsSMILAnimationFunction::SetBy(const nsAString& aBy) +{ + NS_ASSERTION(mAttribute, "Animation element not initialised."); + + if (!mAttribute) + return NS_ERROR_FAILURE; + + nsresult rv; + rv = mAttribute->CreateFromSpec(aBy, getter_AddRefs(mBy)); + + FillValuesArray(); + + return rv; +} + +void +nsSMILAnimationFunction::UnsetBy() +{ + mBy = nsnull; + FillValuesArray(); +} + +nsresult +nsSMILAnimationFunction::SetCalcMode(const nsAString& aCalcMode) +{ + // TODO[2] + return NS_ERROR_NOT_IMPLEMENTED; +} + +void +nsSMILAnimationFunction::UnsetCalcMode() +{ + // TODO[2] +} + +nsresult +nsSMILAnimationFunction::SetAccumulate(const nsAString& aAccumulate) +{ + // TODO[2] + return NS_ERROR_NOT_IMPLEMENTED; +} + +void +nsSMILAnimationFunction::UnsetAccumulate() +{ + // TODO[2] +} + + +nsresult +nsSMILAnimationFunction::SetFrom(const nsAString& aFrom) +{ + NS_ASSERTION(mAttribute, "Animation element not initialised."); + + if (!mAttribute) + return NS_ERROR_FAILURE; + + nsresult rv; + rv = mAttribute->CreateFromSpec(aFrom, getter_AddRefs(mFrom)); + + FillValuesArray(); + + return rv; +} + +void +nsSMILAnimationFunction::UnsetFrom() +{ + mFrom = nsnull; + FillValuesArray(); +} + +nsresult +nsSMILAnimationFunction::SetKeySplines(const nsAString& aKeySplines) +{ + // TODO[2] + return NS_ERROR_NOT_IMPLEMENTED; +} + +void +nsSMILAnimationFunction::UnsetKeySplines() +{ + // TODO[2] +} + +nsresult +nsSMILAnimationFunction::SetKeyTimes(const nsAString& aKeyTimes) +{ + // TODO[2] + return NS_ERROR_NOT_IMPLEMENTED; +} + +void +nsSMILAnimationFunction::UnsetKeyTimes() +{ + // TODO[2] +} + +nsresult +nsSMILAnimationFunction::SetTo(const nsAString& aTo) +{ + NS_ASSERTION(mAttribute, "Animation element not initialised."); + + if (!mAttribute) + return NS_ERROR_FAILURE; + + nsresult rv; + rv = mAttribute->CreateFromSpec(aTo, getter_AddRefs(mTo)); + + FillValuesArray(); + + return rv; +} + +void +nsSMILAnimationFunction::UnsetTo() +{ + mTo = nsnull; + FillValuesArray(); +} + +nsresult +nsSMILAnimationFunction::SetValues(const nsAString& aValues) +{ + NS_ASSERTION(mAttribute, "Animation element not initialised."); + + if (!mAttribute) + return NS_ERROR_FAILURE; + + nsresult rv; + nsAString::const_iterator start; + nsAString::const_iterator end; + nsAString::const_iterator substr_end; + nsAString::const_iterator next; + + aValues.BeginReading(start); + aValues.EndReading(end); + + mValues.Clear(); + mValuesIsSet = PR_FALSE; + + while (start != end) { + rv = NS_ERROR_FAILURE; + + while (*start && NS_IS_SPACE(*start)) + ++start; + + if (*start == '\0' || *start == ';') + break; + + substr_end = start; + + while (substr_end != end && *substr_end != ';') + ++substr_end; + + next = substr_end; + if (*substr_end == ';') { + ++next; + if (next == end) + break; + } + + do --substr_end; while (start != substr_end && NS_IS_SPACE(*substr_end)); + ++substr_end; + + nsCOMPtr newValue; + rv = mAttribute->CreateFromSpec(Substring(start, substr_end), + getter_AddRefs(newValue)); + + if (NS_FAILED(rv)) + break; + + mValues.AppendObject(newValue); + + start = next; + } + + if (NS_SUCCEEDED(rv)) + mValuesIsSet = PR_TRUE; + else + mValues.Clear(); + + return rv; +} + +void +nsSMILAnimationFunction::UnsetValues() +{ + mValuesIsSet = PR_FALSE; + FillValuesArray(); +} + +void +nsSMILAnimationFunction::SetDocumentPosition(PRUint16 aDocPosition) +{ + mDocumentPosition = aDocPosition; +} + +//---------------------------------------------------------------------- +// nsISMILTimeClient methods + +void +nsSMILAnimationFunction::SampleAt(const PRInt64& aSimpleTime, + const nsSMILTimeValue& aSimpleDuration, + const PRUint32& aRepeatIteration) +{ + mSimpleTime = aSimpleTime; + mSimpleDuration = aSimpleDuration; + mRepeatIteration = aRepeatIteration; + mLastValue = PR_FALSE; +} + +void +nsSMILAnimationFunction::SampleLastValue(const PRUint32& aRepeatIteration) +{ + mRepeatIteration = aRepeatIteration; + mLastValue = PR_TRUE; +} + +void +nsSMILAnimationFunction::ToActive(const PRInt64& aBeginTime) +{ + mBeginTime = aBeginTime; + mIsActive = PR_TRUE; +} + +void +nsSMILAnimationFunction::ToInactive() +{ + mIsActive = PR_FALSE; +} + +//---------------------------------------------------------------------- +// nsISMILComposable methods + +void +nsSMILAnimationFunction::ComposeResult(nsISMILAnimVal &aResult) +{ + /* + * This checks if mValues is empty so we don't need to check it again + */ + if (!IsActive()) + return; + + NS_ENSURE_TRUE(mSimpleTime >= 0,); + NS_ENSURE_TRUE(mSimpleDuration.IsResolved() || + mSimpleDuration.IsIndefinite(), ); + NS_ENSURE_TRUE(mAttribute,); + + nsCOMPtr result; + NS_ENSURE_SUCCESS(mAttribute->Create(getter_AddRefs(result)),); + + if (mSimpleDuration.IsIndefinite() || + (mValuesIsSet && mValues.Count() == 1)) { + nsISMILAnimVal* firstValue = mValues.SafeObjectAt(0); + NS_ENSURE_TRUE(firstValue,); + result->Set(*firstValue); + } else if (mLastValue) { + nsISMILAnimVal* lastValue = mValues.SafeObjectAt(mValues.Count() - 1); + NS_ENSURE_TRUE(lastValue,); + result->Repeat(mRepeatIteration, lastValue); + } else { + const PRInt64& dur = mSimpleDuration.GetMillis(); + + if (LL_CMP(mSimpleTime, >=, dur) || !LL_GE_ZERO(mSimpleTime)) { + NS_ERROR("Animation sampled outside interval."); + return; + } + + double fTime; + double fDur; + double simpleDistance; + double intervalDistance; + PRInt32 index; + nsISMILAnimVal* from = nsnull; + nsISMILAnimVal* to = nsnull; + + LL_L2D(fTime, mSimpleTime); + LL_L2D(fDur, dur); + + NS_ASSERTION(mValues.Count() >= 2 || IsToAnimation(), + "Unexpected number of values."); + + simpleDistance = (fDur > 0.0) ? fTime / fDur : 0.0; + + if (IsToAnimation()) { + from = &aResult; + to = mValues.SafeObjectAt(0); + intervalDistance = simpleDistance; + } else { + index = (PRInt32) floor(simpleDistance * (mValues.Count() - 1)); + + from = mValues.SafeObjectAt(index); + NS_ENSURE_TRUE(from,); + + to = mValues.SafeObjectAt(index + 1); + NS_ENSURE_TRUE(to,); + + intervalDistance = simpleDistance * (mValues.Count() - 1) - index; + } + + nsresult rv = from->Interpolate(*to, + NS_STATIC_CAST(float, intervalDistance), + *result); + NS_ENSURE_SUCCESS(rv,); + } + + /* + * If additive animation isn't required or fails, just set the value. + */ + if (!IsAdditive() || !aResult.Add(*result)) + aResult.Set(*result); +} + +PRInt8 +nsSMILAnimationFunction::CompareTo(const nsISMILComposable& composable) const +{ + /* + * Inactive animations sort first + */ + if (!IsActive()) + return -1; + + if (!composable.IsActive()) + return 1; + + /* + * To animations sort last + */ + if (!IsToAnimation() && composable.IsToAnimation()) + return -1; + + if (IsToAnimation() && !composable.IsToAnimation()) + return 1; + + /* + * We sort using the same rules if both animations are 'to animations' or both + * animations are not 'to animations'. + */ + if (LL_NE(mBeginTime, composable.GetBeginTime())) + return LL_CMP(mBeginTime, >, composable.GetBeginTime()) ? 1 : -1; + + // XXX When syncbase timing is implemented, we next need to sort based on + // dependencies + + /* + * Animations that appear later in the document sort after those earlier in + * the document + */ + /* + * Disabled for now until we implement the document traversal + NS_ASSERTION(mDocumentPosition != composable.GetDocumentPosition(), + "Two animations cannot have the same document position!"); + */ + + return (mDocumentPosition <= composable.GetDocumentPosition()) ? -1 : 1; +} + +PRBool +nsSMILAnimationFunction::IsToAnimation() const +{ + return (!mValuesIsSet && mTo && !mFrom); +} + +const PRInt64& +nsSMILAnimationFunction::GetBeginTime() const +{ + return mBeginTime; +} + +PRUint16 +nsSMILAnimationFunction::GetDocumentPosition() const +{ + return mDocumentPosition; +} + +PRBool +nsSMILAnimationFunction::IsActive() const +{ + /* + * Even if an animation should be active, if its attributes are set + * incorrectly, it will have no effect and should be considered by the + * compositor to be inactive. + */ + return (mIsActive && mValues.Count() > 0); +} + + +PRBool +nsSMILAnimationFunction::WillReplace() const +{ + return !IsAdditive(); +} + +//---------------------------------------------------------------------- +// Implementation helpers + +/* + * SMILANIM specifies the following rules for animation function values: + * + * (1) if values is set, it overrides everything + * (2) for from/to/by animation at least to or by must be specified, from on its + * own (or nothing) is an error--which we will ignore + * (3) if both by and to are specified only to will be used, by will be ignored + * (4) if by is specified without from (by animation), forces additive behaviour + * (5) if to is specified without from (to animation), special care needs to be + * taken when compositing animation as such animations are composited last. + * + * This helper method applies these rules to fill in the values list and to set + * some internal state. + */ +void +nsSMILAnimationFunction::FillValuesArray() +{ + if (!mValuesIsSet) { + mValues.Clear(); + + if (mTo) { + if (mFrom) { + mValues.AppendObject(mFrom); + mValues.AppendObject(mTo); + } else { + mValues.AppendObject(mTo); + } + } else if (mBy) { + if (mFrom) { + /* + * Set values to 'from; from + to' + */ + mValues.AppendObject(mFrom); + nsCOMPtr to; + if (NS_SUCCEEDED(mAttribute->Create(getter_AddRefs(to)))) { + to->Set(*mFrom); + to->Add(*mBy); + mValues.AppendObject(to); + } else { + mValues.Clear(); + } + } else { + /* + * Set values to '0; by' + */ + nsCOMPtr from; + if (NS_SUCCEEDED(mAttribute->Create(getter_AddRefs(from)))) { + mValues.AppendObject(from); + mValues.AppendObject(mBy); + } else { + mValues.Clear(); + } + } + } + /* else, do nothing, mValues has been cleared already. */ + } +} + +inline PRBool +nsSMILAnimationFunction::IsAdditive() const +{ + /* + * Animation is additive if: + * + * (1) additive = "sum" (mAdditive == true), or + * (2) it is 'by animation' (by is set, from and values are not) + * + * Although animation is not additive if it is 'to animation' + */ + return (!IsToAnimation() && (mAdditive || (!mValuesIsSet && mBy && !mFrom))); +} + Index: /cvsroot/mozilla/content/smil/src/nsSMILAnimationRegistry.cpp =================================================================== RCS file: /cvsroot/mozilla/content/smil/src/nsSMILAnimationRegistry.cpp diff -N content/smil/src/nsSMILAnimationRegistry.cpp --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ /cvsroot/mozilla/content/smil/src/nsSMILAnimationRegistry.cpp 14 Sep 2005 10:44:06 -0000 @@ -0,0 +1,273 @@ +/* -*- 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 SVG project. + * + * Contributor(s): + * Brian Birtles + * + * 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 ***** */ + +#include "nsSMILAnimationRegistry.h" +#include "nsISMILAnimationController.h" +#include "nsISMILAnimAttr.h" +#include "nsSMILTimedDocumentRoot.h" +#include "nsISMILComposable.h" + +//////////////////////////////////////////////////////////////////////// +// nsSMILAnimationRegistry implementation + +struct CompositorEntry +{ + nsISMILAnimAttr* key; + nsSMILCompositor compositor; +}; + +//---------------------------------------------------------------------- +// ctors, dtors, factory methods + +nsSMILAnimationRegistry::nsSMILAnimationRegistry() +{ +} + +nsSMILAnimationRegistry::~nsSMILAnimationRegistry() +{ + if (mController && mTimedDocumentRoot) + mController->RemoveTimeContainer(mTimedDocumentRoot); + + CompositorEntry* entry; + PRInt32 count = mCompositors.Count(); + + for (PRInt32 i = 0; i < count; ++i) + { + entry = NS_STATIC_CAST(CompositorEntry*, mCompositors[i]); + mCompositors.ReplaceElementAt(nsnull, i); + delete entry; + } + + mCompositors.Clear(); +} + +nsISMILAnimationRegistry* +NS_NewSMILAnimationRegistry() +{ + nsSMILAnimationRegistry* animationRegistry = new nsSMILAnimationRegistry(); + + if (animationRegistry) + { + nsresult rv = animationRegistry->Init(); + if (NS_FAILED(rv)) + { + delete animationRegistry; + animationRegistry = nsnull; + } + } + + return animationRegistry; +} + +nsresult +nsSMILAnimationRegistry::Init() +{ + mTimedDocumentRoot = new nsSMILTimedDocumentRoot(this); + NS_ENSURE_TRUE(mTimedDocumentRoot, NS_ERROR_OUT_OF_MEMORY); + + return NS_OK; +} + +//---------------------------------------------------------------------- +// nsISupports methods: + +NS_IMPL_ISUPPORTS1(nsSMILAnimationRegistry, + nsISMILAnimationRegistry); + +//---------------------------------------------------------------------- +// nsISMILAnimationRegistry methods: + +nsresult +nsSMILAnimationRegistry::SetController(nsISMILAnimationController* aController) +{ + nsresult rv = NS_OK; + + if (mController) + { + rv = mController->RemoveTimeContainer(mTimedDocumentRoot); + NS_ENSURE_SUCCESS(rv,rv); + } + + mController = aController; + + if (mController && mTimedDocumentRoot) + rv = mController->AddTimeContainer(mTimedDocumentRoot); + + return rv; +} + +void +nsSMILAnimationRegistry::Pause() +{ + // TODO[3] +} + +void +nsSMILAnimationRegistry::Unpause() +{ + // TODO[3] +} + +PRBool +nsSMILAnimationRegistry::IsPaused() +{ + // TODO[3] + return false; +} + +float +nsSMILAnimationRegistry::GetCurrentTime() +{ + return 0.0f; +} + +nsresult +nsSMILAnimationRegistry::SetCurrentTime(float aSeconds) +{ + return NS_ERROR_NOT_IMPLEMENTED; +} + +nsresult +nsSMILAnimationRegistry::RegisterComposable(nsISMILAnimAttr* aTargetAttr, + nsISMILComposable* aComposable) +{ + NS_ENSURE_ARG_POINTER(aTargetAttr); + NS_ENSURE_ARG_POINTER(aComposable); + + nsSMILCompositor* compositor = nsnull; + CompositorEntry* entry; + + /* + * Iterate in reverse as if a compositor already exists for this attribute it + * is most likely to be the most recently added entry. + */ + for (PRInt32 i = mCompositors.Count() - 1; i >= 0 && !compositor; --i) + { + entry = (CompositorEntry*)mCompositors[i]; + if (entry && entry->key == aTargetAttr) + compositor = &entry->compositor; + } + + if (!compositor) + { + entry = new CompositorEntry(); + NS_ENSURE_TRUE(entry,NS_ERROR_OUT_OF_MEMORY); + + nsresult rv = entry->compositor.Init(aTargetAttr); + NS_ENSURE_SUCCESS(rv,rv); + + entry->key = aTargetAttr; + if (!mCompositors.AppendElement(entry)) + { + delete entry; + return NS_ERROR_FAILURE; + } + + compositor = &entry->compositor; + } + + return compositor->AddComposable(aComposable); +} + +nsresult +nsSMILAnimationRegistry::UnregisterComposable(nsISMILComposable* aComposable) +{ + NS_ENSURE_ARG_POINTER(aComposable); + + PRBool found = PR_FALSE; + nsresult result = NS_OK; + nsresult rv = NS_ERROR_FAILURE; + nsSMILCompositor* compositor = nsnull; + CompositorEntry* entry; + PRInt32 count = mCompositors.Count(); + + for (PRInt32 i = 0; i < count; ++i) + { + entry = (CompositorEntry*)mCompositors[i]; + if (entry) + { + rv = entry->compositor.RemoveComposable(aComposable); + + /* + * This rather complicated error handling just ensures that we report the + * first error that occurs, or a generic error if the item wasn't found. + */ + if (NS_SUCCEEDED(result)) + result = rv; + found = PR_TRUE; + } + + /* + * Even if the entry now no longer has any compositors we don't bother + * deleting it. After all, it may be re-used again later. + */ + } + + return (found) ? rv : NS_ERROR_FAILURE; +} + +nsresult +nsSMILAnimationRegistry::RegisterTimedElement(nsISMILTimedElement *aElement) +{ + return (mTimedDocumentRoot) ? mTimedDocumentRoot->AddTimedElement(aElement) + : NS_ERROR_FAILURE; +} + +nsresult +nsSMILAnimationRegistry::UnregisterTimedElement(nsISMILTimedElement *aElement) +{ + return (mTimedDocumentRoot) ? mTimedDocumentRoot->RemoveTimedElement(aElement) + : NS_ERROR_FAILURE; +} + +void +nsSMILAnimationRegistry::StartSample() +{ + // TODO[2]: Suspend redraw +} + +void +nsSMILAnimationRegistry::EndSample() +{ + CompositorEntry* entry; + PRInt32 count = mCompositors.Count(); + + for (PRInt32 i = 0; i < count; ++i) + { + entry = NS_STATIC_CAST(CompositorEntry*, mCompositors[i]); + entry->compositor.ComposeSample(); + } + + // TODO[2]: Unsuspend redraw +} + Index: /cvsroot/mozilla/content/smil/src/nsSMILAnimationRegistry.h =================================================================== RCS file: /cvsroot/mozilla/content/smil/src/nsSMILAnimationRegistry.h diff -N content/smil/src/nsSMILAnimationRegistry.h --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ /cvsroot/mozilla/content/smil/src/nsSMILAnimationRegistry.h 14 Sep 2005 10:44:06 -0000 @@ -0,0 +1,82 @@ +/* -*- 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 SVG project. + * + * Contributor(s): + * Brian Birtles + * + * 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 ***** */ + +#ifndef __NS_SMILANIMATIONREGISTRY_H__ +#define __NS_SMILANIMATIONREGISTRY_H__ + +#include "nsISMILAnimationRegistry.h" +#include "nsSMILCompositor.h" +#include "nsVoidArray.h" +#include "nsAutoPtr.h" + +class nsSMILTimedDocumentRoot; +class nsISMILAnimAttr; +class nsISMILAnimationController; +class nsISMILComposable; + +class nsSMILAnimationRegistry : public nsISMILAnimationRegistry +{ +public: + nsSMILAnimationRegistry(); + ~nsSMILAnimationRegistry(); + + NS_DECL_ISUPPORTS + + virtual void StartSample(); + virtual void EndSample(); + + // nsISMILAnimationRegistry + virtual nsresult SetController(nsISMILAnimationController* aController); + virtual void Pause(); + virtual void Unpause(); + virtual PRBool IsPaused(); + virtual float GetCurrentTime(); + virtual nsresult SetCurrentTime(float aSeconds); + virtual nsresult RegisterComposable(nsISMILAnimAttr *aTargetAttr, + nsISMILComposable *aComposable); + virtual nsresult UnregisterComposable(nsISMILComposable *aComposable); + virtual nsresult RegisterTimedElement(nsISMILTimedElement *aElement); + virtual nsresult UnregisterTimedElement(nsISMILTimedElement *aElement); + +protected: + friend nsISMILAnimationRegistry* NS_NewSMILAnimationRegistry(); + + nsresult Init(); + + nsVoidArray mCompositors; + nsRefPtr mTimedDocumentRoot; + nsCOMPtr mController; +}; + +#endif // __NS_SMILANIMATIONREGISTRY_H__ + Index: /cvsroot/mozilla/content/smil/src/nsSMILCompositor.cpp =================================================================== RCS file: /cvsroot/mozilla/content/smil/src/nsSMILCompositor.cpp diff -N content/smil/src/nsSMILCompositor.cpp --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ /cvsroot/mozilla/content/smil/src/nsSMILCompositor.cpp 14 Sep 2005 10:44:08 -0000 @@ -0,0 +1,168 @@ +/* -*- 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 SVG project. + * + * Contributor(s): + * Brian Birtles + * + * 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 ***** */ + +#include "nsSMILCompositor.h" +#include "nsISMILComposable.h" +#include "nsISimpleEnumerator.h" +#include "nsArrayEnumerator.h" +#include "nsISMILAnimAttr.h" +#include "nsISMILAnimVal.h" + +//////////////////////////////////////////////////////////////////////// +// nsSMILCompositor implementation + +nsresult +nsSMILCompositor::Init(nsISMILAnimAttr* aTargetAttribute) +{ + NS_ENSURE_ARG_POINTER(aTargetAttribute); + + nsresult rv; + mTargetAttribute = do_GetWeakReference(aTargetAttribute, &rv); + if (NS_FAILED(rv)) + { + mTargetAttribute = nsnull; + return rv; + } + + return NS_OK; +} + +nsresult +nsSMILCompositor::AddComposable(nsISMILComposable* aComposable) +{ + NS_ENSURE_ARG_POINTER(aComposable); + + nsresult rv; + nsCOMPtr weakRef( + getter_AddRefs(do_GetWeakReference(aComposable, &rv)) ); + + if (NS_SUCCEEDED(rv)) + rv = (mChildren.AppendObject(weakRef)) ? NS_OK : NS_ERROR_FAILURE; + + return rv; +} + +nsresult +nsSMILCompositor::RemoveComposable(nsISMILComposable* aComposable) +{ + NS_ENSURE_ARG_POINTER(aComposable); + + nsresult rv; + nsCOMPtr weakRef( + getter_AddRefs(do_GetWeakReference(aComposable, &rv)) ); + + if (NS_SUCCEEDED(rv)) + rv = (mChildren.RemoveObject(weakRef)) ? NS_OK : NS_ERROR_FAILURE; + + return rv; +} + +void +nsSMILCompositor::ComposeSample() +{ + NS_ASSERTION(mTargetAttribute, "Target attribute not set on compositor."); + + if (!mTargetAttribute) + return; + + nsCOMPtr targetAttribute( + do_QueryReferent(mTargetAttribute) ); + + if (!targetAttribute) + return; + + nsCOMPtr result( CopyBaseValue(targetAttribute) ); + if (!result) + return; + + mChildren.Sort(SortCompositors, nsnull); + + nsCOMPtr enumerator; + nsresult rv = + NS_NewArrayEnumerator(getter_AddRefs(enumerator), mChildren); + NS_ENSURE_SUCCESS(rv,); + + PRBool more = PR_FALSE; + nsCOMPtr composable; + nsCOMPtr weakRef; + + while (NS_SUCCEEDED(enumerator->HasMoreElements(&more)) && more) + { + if (NS_FAILED(enumerator->GetNext(getter_AddRefs(weakRef))) || !weakRef) + break; + + composable = do_QueryReferent(weakRef); + + if (composable) + { + composable->ComposeResult(*result); + } + } + + // We can't just call Set on the animated value itself, because the observers + // of the animated object as a whole need to be updated too. + targetAttribute->SetAnimValue(*result); +} + +//---------------------------------------------------------------------- +// Implementation helpers + +PR_CALLBACK int +nsSMILCompositor::SortCompositors(nsIWeakReference *aRef1, + nsIWeakReference *aRef2, + void* aData) +{ + nsCOMPtr a = do_QueryReferent(aRef1); + nsCOMPtr b = do_QueryReferent(aRef2); + + return (a && b) ? a->CompareTo(*b) : -1; +} + +nsISMILAnimVal* +nsSMILCompositor::CopyBaseValue(nsISMILAnimAttr* aTargetAttribute) +{ + nsISMILAnimVal* baseValueCopy; + + nsCOMPtr baseVal( aTargetAttribute->GetBaseValue() ); + if (!baseVal) + return nsnull; + + aTargetAttribute->Create(&baseValueCopy); + if (!baseValueCopy) + return nsnull; + + baseValueCopy->Set(*baseVal); + + return baseValueCopy; +} + Index: /cvsroot/mozilla/content/smil/src/nsSMILCompositor.h =================================================================== RCS file: /cvsroot/mozilla/content/smil/src/nsSMILCompositor.h diff -N content/smil/src/nsSMILCompositor.h --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ /cvsroot/mozilla/content/smil/src/nsSMILCompositor.h 14 Sep 2005 10:44:08 -0000 @@ -0,0 +1,68 @@ +/* -*- 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 SVG project. + * + * Contributor(s): + * Brian Birtles + * + * 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 ***** */ + +#ifndef __NS_SMILCOMPOSITOR_H__ +#define __NS_SMILCOMPOSITOR_H__ + +#include "nsCOMArray.h" +#include "nsWeakReference.h" + +//////////////////////////////////////////////////////////////////////// +// nsSMILCompositor: Collection of animation compositors + +class nsISMILComposable; +class nsISMILAnimAttr; +class nsISMILAnimVal; + +class nsSMILCompositor +{ +public: + nsresult Init(nsISMILAnimAttr* aTargetAttribute); + + nsresult AddComposable(nsISMILComposable* aComposable); + nsresult RemoveComposable(nsISMILComposable* aComposable); + void ComposeSample(); + +protected: + PR_STATIC_CALLBACK(int) SortCompositors(nsIWeakReference* aRef1, + nsIWeakReference* aRef2, + void* aData); + + nsISMILAnimVal* CopyBaseValue(nsISMILAnimAttr* aTargetAttribute); + + nsCOMArray mChildren; + nsWeakPtr mTargetAttribute; +}; + +#endif // __NS_SMILCOMPOSITOR_H__ + Index: /cvsroot/mozilla/content/smil/src/nsSMILInstanceTime.cpp =================================================================== RCS file: /cvsroot/mozilla/content/smil/src/nsSMILInstanceTime.cpp diff -N content/smil/src/nsSMILInstanceTime.cpp --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ /cvsroot/mozilla/content/smil/src/nsSMILInstanceTime.cpp 14 Sep 2005 10:44:08 -0000 @@ -0,0 +1,53 @@ +/* -*- 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 SVG project. + * + * Contributor(s): + * Brian Birtles + * + * 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 ***** */ + +#include "nsSMILInstanceTime.h" +#include "nsSMILTimeValueSpec.h" +#include "nsSMILTimeValue.h" + +//---------------------------------------------------------------------- +// Implementation + +nsSMILInstanceTime::nsSMILInstanceTime (const nsSMILTimeValue &aTime, + nsSMILTimeValueSpec *aCreator, + PRBool aClearOnReset /*=false*/) + : mTime(aTime), // Copy the time + mClearOnReset(aClearOnReset) +{ + if (aCreator) + mCreator = do_GetWeakReference(aCreator); +} + +//---------------------------------------------------------------------- +// nsSMILInstanceTime + Index: /cvsroot/mozilla/content/smil/src/nsSMILInstanceTime.h =================================================================== RCS file: /cvsroot/mozilla/content/smil/src/nsSMILInstanceTime.h diff -N content/smil/src/nsSMILInstanceTime.h --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ /cvsroot/mozilla/content/smil/src/nsSMILInstanceTime.h 14 Sep 2005 10:44:08 -0000 @@ -0,0 +1,96 @@ +/* -*- 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 SVG project. + * + * Contributor(s): + * Brian Birtles + * + * 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 ***** */ + +#ifndef __NS_SMILINSTANCETIME_H__ +#define __NS_SMILINSTANCETIME_H__ + +#include "nsSMILTimeValue.h" +#include "nsWeakReference.h" + +class nsSMILTimeValueSpec; + +//////////////////////////////////////////////////////////////////////// +// nsSMILInstanceTime + +class nsSMILInstanceTime +{ +public: + nsSMILInstanceTime (const nsSMILTimeValue &aTime, + nsSMILTimeValueSpec *aCreator, + PRBool aClearOnReset = false); + + const nsSMILTimeValue& Time() const { return mTime; } + + PRBool ClearOnReset() const { return mClearOnReset; } + + // dependent update + + nsrefcnt AddRef() { return ++mRefCnt; } + nsrefcnt Release(); + +protected: + nsSMILTimeValue mTime; + nsWeakPtr mCreator; + + /** + * Should this instance time be removed when the owning timed element is rest. + * True for events and DOM calls. + */ + PRBool mClearOnReset; + + /* + * This will only be used for for identifying the instance times associated + * with a deleting interval. We will never de-reference this pointer, but only + * use it for pointer comparisons. Therefore it's not necessary for instances + * of nsSMILInterval to be reference-counted. + * + * nsSMILInterval *mTimebase + */ + + nsAutoRefCnt mRefCnt; +}; + +inline nsrefcnt +nsSMILInstanceTime::Release() +{ + if (--mRefCnt == 0) + { + delete this; + return 0; + } + + return mRefCnt; +} + +#endif // __NS_SMILINSTANCETIME_H__ + Index: /cvsroot/mozilla/content/smil/src/nsSMILInterval.cpp =================================================================== RCS file: /cvsroot/mozilla/content/smil/src/nsSMILInterval.cpp diff -N content/smil/src/nsSMILInterval.cpp --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ /cvsroot/mozilla/content/smil/src/nsSMILInterval.cpp 14 Sep 2005 10:44:09 -0000 @@ -0,0 +1,56 @@ +/* -*- 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 SVG project. + * + * Contributor(s): + * Brian Birtles + * + * 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 ***** */ + +#include "nsSMILInterval.h" + +nsSMILInterval::nsSMILInterval(const nsSMILTimeValue& aBegin, + const nsSMILTimeValue& aEnd) +: mBegin(aBegin), + mEnd(aEnd) +{ +} + +//---------------------------------------------------------------------- +// Implementation + +PRBool +nsSMILInterval::Recalc(const nsVoidArray& aBeginTimes, + const nsVoidArray& aEndTimes, + PRBool aHasEnds, + const nsSMILTimeValue& min, + const nsSMILTimeValue& max) +{ + // TODO[2] + return PR_TRUE; +} + Index: /cvsroot/mozilla/content/smil/src/nsSMILInterval.h =================================================================== RCS file: /cvsroot/mozilla/content/smil/src/nsSMILInterval.h diff -N content/smil/src/nsSMILInterval.h --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ /cvsroot/mozilla/content/smil/src/nsSMILInterval.h 14 Sep 2005 10:44:09 -0000 @@ -0,0 +1,66 @@ +/* -*- 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 SVG project. + * + * Contributor(s): + * Brian Birtles + * + * 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 ***** */ + +#ifndef __NS_SMILINTERVAL_H__ +#define __NS_SMILINTERVAL_H__ + +#include "nsSMILTimeValue.h" + +//////////////////////////////////////////////////////////////////////// +// nsSMILInterval class + +class nsVoidArray; + +class nsSMILInterval +{ +public: + nsSMILInterval() {} + + nsSMILInterval(const nsSMILTimeValue& aBegin, + const nsSMILTimeValue& aEnd); + + const nsSMILTimeValue& Begin() { return mBegin; } + const nsSMILTimeValue& End() { return mEnd; } + + PRBool Recalc(const nsVoidArray& aBeginTimes, + const nsVoidArray& aEndTimes, + PRBool aHasEnds, + const nsSMILTimeValue& min, + const nsSMILTimeValue& max); + +protected: + nsSMILTimeValue mBegin; + nsSMILTimeValue mEnd; +}; + +#endif // __NS_SMILINTERVAL_H__ Index: /cvsroot/mozilla/content/smil/src/nsSMILTimeValue.cpp =================================================================== RCS file: /cvsroot/mozilla/content/smil/src/nsSMILTimeValue.cpp diff -N content/smil/src/nsSMILTimeValue.cpp --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ /cvsroot/mozilla/content/smil/src/nsSMILTimeValue.cpp 14 Sep 2005 10:44:09 -0000 @@ -0,0 +1,137 @@ +/* -*- 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 SVG project. + * + * Contributor(s): + * Brian Birtles + * + * 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 ***** */ + +#include "nsSMILTimeValue.h" +#include "nsDebug.h" + +PRInt64 nsSMILTimeValue::mUnresolvedSeconds = LL_MaxInt(); + +//---------------------------------------------------------------------- +// Implementation + +// Default constructor creates an unresolved time +nsSMILTimeValue::nsSMILTimeValue() + : mMilliseconds(LL_MaxInt()), + mIndefinite(PR_FALSE), + mResolved(PR_FALSE) +{} + +//---------------------------------------------------------------------- +// nsSMILTimeValue methods: + +// TODO[3]: Profile and move the most accessed methods inline + +PRBool +nsSMILTimeValue::IsIndefinite() const +{ + return mIndefinite; +} + +void +nsSMILTimeValue::SetIndefinite() +{ + mResolved = PR_FALSE; + mIndefinite = PR_TRUE; + mMilliseconds = LL_MaxInt(); +} + +PRBool +nsSMILTimeValue::IsResolved() const +{ + return mResolved; +} + +void +nsSMILTimeValue::SetUnresolved() +{ + mResolved = PR_FALSE; + mIndefinite = PR_FALSE; + mMilliseconds = LL_MaxInt(); +} + +const PRInt64& +nsSMILTimeValue::GetMillis() const +{ + NS_ASSERTION(mResolved, "GetMillis() called for unresolved time."); + + if (!mResolved) + return mUnresolvedSeconds; + + return mMilliseconds; +} + +void +nsSMILTimeValue::SetMillis(const PRInt64& aMillis) +{ + mResolved = PR_TRUE; + mIndefinite = PR_FALSE; + mMilliseconds = aMillis; +} + +PRInt8 +nsSMILTimeValue::CompareTo(const nsSMILTimeValue& aCompare) const +{ + PRInt8 result; + + if (mResolved) + { + result = (aCompare.mResolved) + ? CmpLL(mMilliseconds, aCompare.mMilliseconds) + : -1; + } + else if (mIndefinite) + { + if (aCompare.mResolved) + result = 1; + else if (aCompare.mIndefinite) + result = 0; + else + result = -1; + } + else + { + result = (aCompare.mResolved || aCompare.mIndefinite) ? 1 : 0; + } + + return result; +} + +PR_CALLBACK int +nsSMILTimeValue::ComparisonCallback(const void *aElement1, + const void *aElement2, + void* aData) +{ + return NS_STATIC_CAST(const nsSMILTimeValue*, aElement1)->CompareTo + (*NS_STATIC_CAST(const nsSMILTimeValue*, aElement2)); +} + Index: /cvsroot/mozilla/content/smil/src/nsSMILTimeValue.h =================================================================== RCS file: /cvsroot/mozilla/content/smil/src/nsSMILTimeValue.h diff -N content/smil/src/nsSMILTimeValue.h --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ /cvsroot/mozilla/content/smil/src/nsSMILTimeValue.h 14 Sep 2005 10:44:09 -0000 @@ -0,0 +1,115 @@ +/* -*- 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 SVG project. + * + * Contributor(s): + * Brian Birtles + * + * 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 ***** */ + +#ifndef __NS_SMILTIMEVALUE_H__ +#define __NS_SMILTIMEVALUE_H__ + +#include "prtypes.h" +#include "prlong.h" + +/* + * nsSMILTimeValue class + * + * This class considers three orthogonal cases: + * + * 1) The time is resolved and has a millisecond value + * 2) The time is indefinite + * 3) The time in unresolved + * + * There is considerable chance for confusion with regards to the indefinite + * state. Is it resolved? We adopt the convention that it is NOT resolved (but + * nor is it unresolved). This simplifies implementation as you can then write: + * + * if (time.IsResolved()) + * x = time.GetMillis() + * + * instead of: + * + * if (time.IsResolved() && !time.IsIndefinite()) + * x = time.GetMillis() + * + * Testing if a time is unresolved becomes more complicated but this is tested + * much less often. + * + * In summary: + * + * State | GetMillis | IsResolved | IsIndefinite + * --------------+--------------------+--------------------+------------------- + * Resolved | The millisecond | PR_TRUE | PR_FALSE + * | time | | + * --------------+--------------------+--------------------+------------------- + * Indefinite | LL_MaxInt | PR_FALSE | PR_TRUE + * --------------+--------------------+--------------------+------------------- + * Unresolved | LL_MaxInt | PR_FALSE | PR_FALSE + * + */ + +class nsSMILTimeValue +{ +public: + // Creates an unresolved time value + nsSMILTimeValue(); + + PRBool IsIndefinite() const; + void SetIndefinite(); + + PRBool IsResolved() const; + void SetUnresolved(); + + const PRInt64& GetMillis() const; + void SetMillis(const PRInt64& aMillis); + + PRInt8 CompareTo(const nsSMILTimeValue& aCompare) const; + + PR_STATIC_CALLBACK(int) ComparisonCallback(const void *aElement1, + const void *aElement2, + void* aData); + +private: + PRInt8 CmpLL(const PRInt64& a, const PRInt64& b) const; + + static PRInt64 mUnresolvedSeconds; + + PRInt64 mMilliseconds; + PRBool mIndefinite; + PRBool mResolved; +}; + +// A signed comparison of two signed 64-bit integers +inline PRInt8 +nsSMILTimeValue::CmpLL(const PRInt64& a, const PRInt64& b) const +{ + return (LL_EQ(a, b)) ? 0 : (LL_CMP(a, >, b)) ? 1 : -1; +} + +#endif // __NS_SMILTIMEVALUE_H__ Index: /cvsroot/mozilla/content/smil/src/nsSMILTimeValueSpec.cpp =================================================================== RCS file: /cvsroot/mozilla/content/smil/src/nsSMILTimeValueSpec.cpp diff -N content/smil/src/nsSMILTimeValueSpec.cpp --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ /cvsroot/mozilla/content/smil/src/nsSMILTimeValueSpec.cpp 14 Sep 2005 10:44:10 -0000 @@ -0,0 +1,443 @@ +/* -*- 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 SVG project. + * + * Contributor(s): + * Brian Birtles + * + * 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 ***** */ + +#include "nsSMILTimeValueSpec.h" +#include "nsSMILTimeValue.h" +#include "nsSMILInstanceTime.h" +#include "nsAutoPtr.h" +#include "nsCRT.h" +#include "prdtoa.h" + +const PRUint32 nsSMILTimeValueSpec::MSEC_PER_SEC = 1000; +const PRUint32 nsSMILTimeValueSpec::MSEC_PER_MIN = 1000 * 60; +const PRUint32 nsSMILTimeValueSpec::MSEC_PER_HOUR = 1000 * 60 * 60; + +//---------------------------------------------------------------------- +// Implementation + +// We can't return a raw pointer here because we call SetSpec, which calls +// getWeakReference on the newly created value spec which will cause it to be +// destroyed unless it is addref'ed first. + +nsresult NS_NewSMILTimeValueSpec(nsISMILTimedElement* aOwner, + PRBool aIsBegin, + const nsAString& aStringSpec, + nsSMILTimeValueSpec** aResult) +{ + if (nsnull == aResult) return NS_ERROR_NULL_POINTER; + + *aResult = nsnull; + + nsSMILTimeValueSpec* valueSpec = new nsSMILTimeValueSpec(aOwner, aIsBegin); + + if (!valueSpec) return NS_ERROR_OUT_OF_MEMORY; + NS_ADDREF(valueSpec); + + nsresult rv = valueSpec->SetSpec(aStringSpec); + + if (NS_FAILED(rv)) + { + NS_RELEASE(valueSpec); + return rv; + } + + *aResult = valueSpec; + + return NS_OK; +} + +nsSMILTimeValueSpec::nsSMILTimeValueSpec(nsISMILTimedElement* aOwner, + PRBool aIsBegin) + : mIsBegin(aIsBegin), + mOffset() // initalises to zero +{ + if (aOwner) + mOwner = do_GetWeakReference(aOwner); +} + +//---------------------------------------------------------------------- +// nsISupports + +NS_IMPL_ISUPPORTS2(nsSMILTimeValueSpec, + nsSMILTimeValueSpec, + nsISupportsWeakReference) + +//---------------------------------------------------------------------- +// nsSMILTimeValueSpec + +nsresult +nsSMILTimeValueSpec::SetSpec(const nsAString& aStringSpec) +{ + // TODO[2]: Parse other specifiers + nsSMILTimeValue clockTime; + nsresult rv = ParseClockValue(aStringSpec, + &clockTime, + true, // allow + or - + true); // allow 'indefinite' + + if (NS_FAILED(rv) || (!clockTime.IsResolved() && !clockTime.IsIndefinite())) + return NS_ERROR_FAILURE; + + if (clockTime.IsResolved()) + mOffset = clockTime.GetMillis(); + + if (mOwner) + { + nsRefPtr instance = + new nsSMILInstanceTime(clockTime, this); + + nsCOMPtr owner = do_QueryReferent(mOwner); + if (owner) + owner->AddInstanceTime(instance, mIsBegin); + else + rv = NS_ERROR_FAILURE; + } + + return rv; +} + +// This method can actually parse more than a clock value as defined in the +// SMIL Animation specification. It can also parse: +// - the + or - before an offset +// - the special value "indefinite" +// - the special value "media" +// +// Because the value "media" cannot be represented as part of an nsSMILTimeValue +// and has different meanings depending on where it is used, it is passed out as +// a separate parameter (which can be set to null if the media attribute is not +// allowed). +// +// aResult may be NULL, e.g. to check if the string is a valid clock value +nsresult +nsSMILTimeValueSpec::ParseClockValue(const nsAString& aStringSpec, + nsSMILTimeValue* aResult, + PRBool aAllowSign, // = false + PRBool aAllowIndefinite, // = false + PRBool aAllowMedia, // = false + PRBool* aIsMedia) // = nsnull +{ + PRInt64 offset = LL_Zero(); + PRFloat64 component = 0.0l; + + PRInt8 sign = 0; + PRUint8 colonCount = 0; + + PRBool started = PR_FALSE; + PRBool isValid = PR_TRUE; + + PRInt32 metricMultiplicand = MSEC_PER_SEC; + + PRBool numIsReal = PR_FALSE; + PRBool prevNumCouldBeMin = PR_FALSE; + PRBool numCouldBeMin = PR_FALSE; + PRBool numCouldBeSec = PR_FALSE; + PRBool isIndefinite = PR_FALSE; + + char* spec; + char* str = spec = ToNewCString(aStringSpec); + + if (aIsMedia) + *aIsMedia = PR_FALSE; + + while (*str) + { + if (IsSpace(*str)) + { + if (started) + { + ++str; + break; + } + // else, we haven't started yet, ignore initial whitespace + } + else if (aAllowSign && (*str == '+' || *str == '-')) + { + if (sign != 0) + { + // sign has already been set + isValid = PR_FALSE; + break; + } + + if (started) + { + // sign appears in the middle of the string + isValid = PR_FALSE; + break; + } + + sign = (*str == '+') ? 1 : -1; + } + // The NS_IS_DIGIT etc. macros are not locale-specific + else if (NS_IS_DIGIT(*str)) + { + char *end; + + prevNumCouldBeMin = numCouldBeMin; + + if (!GetClockComponent(str, &end, component, numIsReal, numCouldBeMin, + numCouldBeSec)) + { + isValid = PR_FALSE; + break; + } + + started = PR_TRUE; + str = end - 1; + } + else if (*str == ':') + { + ++colonCount; + + // Neither minutes nor hours can be reals + if (numIsReal) + { + isValid = PR_FALSE; + break; + } + + // Clock value can't start with a ':' + if (!started) + { + isValid = PR_FALSE; + break; + } + + // Can't have more than two colons + if (colonCount > 2) + { + isValid = PR_FALSE; + break; + } + + // Multiply the offset by 60 and add the last accumulated component + PRInt64 component64; + LL_D2L(component64, component); + LL_MUL(offset, offset, LL_INIT(0,60)); + LL_ADD(offset, offset, component64); + + component = 0.0l; + } + else if (NS_IS_ALPHA(*str)) + { + if (colonCount > 0) + { + isValid = PR_FALSE; + break; + } + + char* end; + if (PL_strstr(str, "indefinite") == str && aAllowIndefinite) + { + // We set a separate flag because we don't know what the state of the + // passed in time value is and we shouldn't change it in the case of a + // bad input string (so we can't initialise it to 0ms for example). + isIndefinite = PR_TRUE; + if (aResult) + aResult->SetIndefinite(); + end = str + PL_strlen("indefinite"); + } + else if (PL_strstr(str, "media") == str && aAllowMedia) + { + if (aIsMedia) + *aIsMedia = PR_TRUE; + end = str + PL_strlen("media"); + } + else if (!GetMetricMultiplicand(str, &end, metricMultiplicand)) + { + isValid = PR_FALSE; + break; + } + + str = end; + + // Nothing must come after the string except whitespace + break; + } + else + { + isValid = PR_FALSE; + break; + } + + ++str; + } + + if (!started) isValid = PR_FALSE; + + // Process remainder of string (if any) to ensure it is only trailing + // whitespace (embedded whitespace is not allowed) + while (*str && isValid) + { + if (!IsSpace(*str)) isValid = PR_FALSE; + ++str; + } + + nsMemory::Free(spec); + + // No more processing required if the value was "indefinite" or "media". + if (isIndefinite || (aIsMedia && *aIsMedia)) + return NS_OK; + + // If there is more than one colon then the previous component must be a + // correctly formatted minute (i.e. two digits between 00 and 59) and the + // latest component must be a correctly formatted second (i.e. two digits + // before the .) + if (colonCount > 0 && (!prevNumCouldBeMin || !numCouldBeSec)) + isValid = PR_FALSE; + + if (isValid) + { + // Tack on the last component + if (colonCount > 0) + { + LL_MUL(offset, offset, LL_INIT(0,60)); + LL_MUL(offset, offset, LL_INIT(0,1000)); + component *= 1000; + // rounding + component = (component >= 0) ? component + 0.5l : component - 0.5l; + PRInt64 component64; + LL_D2L(component64, component); + LL_ADD(offset, offset, component64); + } + else + { + component *= metricMultiplicand; + // rounding + component = (component >= 0) ? component + 0.5l : component - 0.5l; + LL_D2L(offset, component); + } + + if (aResult) + { + PRInt64 millis = offset; + + if (sign == -1) + LL_NEG(millis, offset); + + aResult->SetMillis(millis); + } + } + + return (isValid) ? NS_OK : NS_ERROR_FAILURE; +} + +// NS_IS_SPACE relies on isspace which may return true for \xB and \xC but +// SMILANIM does not consider these characters to be whitespace. +inline PRBool +nsSMILTimeValueSpec::IsSpace(const char c) +{ + return (c == 0x9 || c == 0xA || c == 0xD || c == 0x20); +} + +inline PRBool +nsSMILTimeValueSpec::GetClockComponent(const char* aSrc, + char** aEnd, + PRFloat64& aResult, + PRBool& aIsReal, + PRBool& aCouldBeMin, + PRBool& aCouldBeSec) +{ + char *rest; + PRFloat64 value = PR_strtod(aSrc, &rest); + + // Check a number was found + if (rest == aSrc) + return PR_FALSE; + + // Check it's not expressed in exponential form + PRBool isExp = (PL_strnpbrk(aSrc, "eE", rest - aSrc) != nsnull); + if (isExp) + return PR_FALSE; + + // Don't allow real numbers of the form "23." + if (*(rest - 1) == '.') + return PR_FALSE; + + // Number looks good + aResult = value; + *aEnd = rest; + + // Set some flags so we can check this number is valid once we know + // whether it's an hour, minute string etc. + aIsReal = (PL_strnchr(aSrc, '.', rest - aSrc) != nsnull); + aCouldBeMin = (value < 60.0l && ((rest - aSrc) == 2)); + aCouldBeSec = (value < 60.0l || + (value == 60.0l && aSrc[0] == '5')); // Take care of rounding error + aCouldBeSec &= (PL_strlen(aSrc) >= 2 && + (aSrc[2] == '\0' || aSrc[2] == '.' || IsSpace(aSrc[2]))); + + return PR_TRUE; +} + +inline PRBool +nsSMILTimeValueSpec::GetMetricMultiplicand(char* aSrc, + char** aEnd, + PRInt32& multiplicand) +{ + nsresult result = PR_TRUE; + + switch (*aSrc) + { + case 'h': + *aEnd = aSrc + 1; + multiplicand = MSEC_PER_HOUR; + break; + case 'm': + if (aSrc[1] == 'i' && aSrc[2] == 'n') + { + *aEnd = aSrc + 3; + multiplicand = MSEC_PER_MIN; + } + else if (aSrc[1] == 's') + { + *aEnd = aSrc + 2; + multiplicand = 1; + } + else + { + result = PR_FALSE; + } + break; + case 's': + *aEnd = aSrc + 1; + multiplicand = MSEC_PER_SEC; + break; + default: + result = PR_FALSE; + break; + } + + return result; +} + Index: /cvsroot/mozilla/content/smil/src/nsSMILTimeValueSpec.h =================================================================== RCS file: /cvsroot/mozilla/content/smil/src/nsSMILTimeValueSpec.h diff -N content/smil/src/nsSMILTimeValueSpec.h --- /dev/null 1 Jan 1970 00:00:00 -0000 +++ /cvsroot/mozilla/content/smil/src/nsSMILTimeValueSpec.h 14 Sep 2005 10:44:10 -0000 @@ -0,0 +1,104 @@ +/* -*- 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