gecko-dev/dom/svg/SVGAnimatedViewBox.h
longsonr 5221ba1823 Bug 1524314 - Use RAII notifier classes to simplify code r=dholbert
Also converts some of the RAII notifier classes to templates where they are doing the same notifications so we get more code reuse.

Differential Revision: https://phabricator.services.mozilla.com/D84229
2020-08-03 09:32:36 +00:00

122 lines
3.8 KiB
C++

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef DOM_SVG_SVGANIMATEDVIEWBOX_H_
#define DOM_SVG_SVGANIMATEDVIEWBOX_H_
#include "nsCycleCollectionParticipant.h"
#include "nsError.h"
#include "SVGAttrTearoffTable.h"
#include "mozilla/Attributes.h"
#include "mozilla/SMILAttr.h"
#include "mozilla/UniquePtr.h"
#include "mozilla/dom/SVGAnimatedRect.h"
namespace mozilla {
class SMILValue;
namespace dom {
class SVGRect;
class SVGAnimationElement;
class SVGElement;
} // namespace dom
struct SVGViewBox {
float x, y;
float width, height;
bool none;
SVGViewBox() : x(0.0), y(0.0), width(0.0), height(0.0), none(true) {}
SVGViewBox(float aX, float aY, float aWidth, float aHeight)
: x(aX), y(aY), width(aWidth), height(aHeight), none(false) {}
bool operator==(const SVGViewBox& aOther) const;
static nsresult FromString(const nsAString& aStr, SVGViewBox* aViewBox);
};
class SVGAnimatedViewBox {
public:
friend class AutoChangeViewBoxNotifier;
using SVGElement = dom::SVGElement;
void Init();
/**
* Returns true if the corresponding "viewBox" attribute defined a rectangle
* with finite values and nonnegative width/height.
* Returns false if the viewBox was set to an invalid
* string, or if any of the four rect values were too big to store in a
* float, or the width/height are negative.
*/
bool HasRect() const;
/**
* Returns true if the corresponding "viewBox" attribute either defined a
* rectangle with finite values or the special "none" value.
*/
bool IsExplicitlySet() const {
if (mAnimVal || mHasBaseVal) {
const SVGViewBox& rect = GetAnimValue();
return rect.none || (rect.width >= 0 && rect.height >= 0);
}
return false;
}
const SVGViewBox& GetBaseValue() const { return mBaseVal; }
void SetBaseValue(const SVGViewBox& aRect, SVGElement* aSVGElement);
const SVGViewBox& GetAnimValue() const {
return mAnimVal ? *mAnimVal : mBaseVal;
}
void SetAnimValue(const SVGViewBox& aRect, SVGElement* aSVGElement);
nsresult SetBaseValueString(const nsAString& aValue, SVGElement* aSVGElement,
bool aDoSetAttr);
void GetBaseValueString(nsAString& aValue) const;
already_AddRefed<dom::SVGAnimatedRect> ToSVGAnimatedRect(
SVGElement* aSVGElement);
already_AddRefed<dom::SVGRect> ToDOMBaseVal(SVGElement* aSVGElement);
already_AddRefed<dom::SVGRect> ToDOMAnimVal(SVGElement* aSVGElement);
UniquePtr<SMILAttr> ToSMILAttr(SVGElement* aSVGElement);
private:
SVGViewBox mBaseVal;
UniquePtr<SVGViewBox> mAnimVal;
bool mHasBaseVal;
public:
struct SMILViewBox : public SMILAttr {
public:
SMILViewBox(SVGAnimatedViewBox* aVal, SVGElement* aSVGElement)
: mVal(aVal), mSVGElement(aSVGElement) {}
// These will stay alive because a SMILAttr only lives as long
// as the Compositing step, and DOM elements don't get a chance to
// die during that.
SVGAnimatedViewBox* mVal;
SVGElement* mSVGElement;
// SMILAttr methods
virtual nsresult ValueFromString(
const nsAString& aStr, const dom::SVGAnimationElement* aSrcElement,
SMILValue& aValue, bool& aPreventCachingOfSandwich) const override;
virtual SMILValue GetBaseValue() const override;
virtual void ClearAnimValue() override;
virtual nsresult SetAnimValue(const SMILValue& aValue) override;
};
static SVGAttrTearoffTable<SVGAnimatedViewBox, dom::SVGAnimatedRect>
sSVGAnimatedRectTearoffTable;
};
} // namespace mozilla
#endif // DOM_SVG_SVGANIMATEDVIEWBOX_H_