gecko-dev/dom/svg/nsSVGEnum.h
Birunthan Mohanathas a8939590de Bug 1182996 - Fix and add missing namespace comments. rs=ehsan
The bulk of this commit was generated by running:

  run-clang-tidy.py \
    -checks='-*,llvm-namespace-comment' \
    -header-filter=^/.../mozilla-central/.* \
    -fix
2015-07-13 08:25:42 -07:00

127 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 __NS_SVGENUM_H__
#define __NS_SVGENUM_H__
#include "nsAutoPtr.h"
#include "nsCycleCollectionParticipant.h"
#include "nsError.h"
#include "nsISMILAttr.h"
#include "nsSVGElement.h"
#include "mozilla/Attributes.h"
#include "mozilla/dom/SVGAnimatedEnumeration.h"
class nsIAtom;
class nsSMILValue;
namespace mozilla {
namespace dom {
class SVGAnimationElement;
} // namespace dom
} // namespace mozilla
typedef uint8_t nsSVGEnumValue;
struct nsSVGEnumMapping {
nsIAtom **mKey;
nsSVGEnumValue mVal;
};
class nsSVGEnum
{
public:
void Init(uint8_t aAttrEnum, uint16_t aValue) {
mAnimVal = mBaseVal = uint8_t(aValue);
mAttrEnum = aAttrEnum;
mIsAnimated = false;
mIsBaseSet = false;
}
nsresult SetBaseValueAtom(const nsIAtom* aValue, nsSVGElement *aSVGElement);
nsIAtom* GetBaseValueAtom(nsSVGElement *aSVGElement);
nsresult SetBaseValue(uint16_t aValue,
nsSVGElement *aSVGElement);
uint16_t GetBaseValue() const
{ return mBaseVal; }
void SetAnimValue(uint16_t aValue, nsSVGElement *aSVGElement);
uint16_t GetAnimValue() const
{ return mAnimVal; }
bool IsExplicitlySet() const
{ return mIsAnimated || mIsBaseSet; }
already_AddRefed<mozilla::dom::SVGAnimatedEnumeration>
ToDOMAnimatedEnum(nsSVGElement* aSVGElement);
// Returns a new nsISMILAttr object that the caller must delete
nsISMILAttr* ToSMILAttr(nsSVGElement* aSVGElement);
private:
nsSVGEnumValue mAnimVal;
nsSVGEnumValue mBaseVal;
uint8_t mAttrEnum; // element specified tracking for attribute
bool mIsAnimated;
bool mIsBaseSet;
nsSVGEnumMapping *GetMapping(nsSVGElement *aSVGElement);
public:
struct DOMAnimatedEnum final : public mozilla::dom::SVGAnimatedEnumeration
{
DOMAnimatedEnum(nsSVGEnum* aVal, nsSVGElement *aSVGElement)
: mozilla::dom::SVGAnimatedEnumeration(aSVGElement)
, mVal(aVal)
{}
virtual ~DOMAnimatedEnum();
nsSVGEnum *mVal; // kept alive because it belongs to content
using mozilla::dom::SVGAnimatedEnumeration::SetBaseVal;
virtual uint16_t BaseVal() override
{
return mVal->GetBaseValue();
}
virtual void SetBaseVal(uint16_t aBaseVal,
mozilla::ErrorResult& aRv) override
{
aRv = mVal->SetBaseValue(aBaseVal, mSVGElement);
}
virtual uint16_t AnimVal() override
{
// Script may have modified animation parameters or timeline -- DOM
// getters need to flush any resample requests to reflect these
// modifications.
mSVGElement->FlushAnimations();
return mVal->GetAnimValue();
}
};
struct SMILEnum : public nsISMILAttr
{
public:
SMILEnum(nsSVGEnum* aVal, nsSVGElement* aSVGElement)
: mVal(aVal), mSVGElement(aSVGElement) {}
// These will stay alive because a nsISMILAttr only lives as long
// as the Compositing step, and DOM elements don't get a chance to
// die during that.
nsSVGEnum* mVal;
nsSVGElement* mSVGElement;
// nsISMILAttr methods
virtual nsresult ValueFromString(const nsAString& aStr,
const mozilla::dom::SVGAnimationElement* aSrcElement,
nsSMILValue& aValue,
bool& aPreventCachingOfSandwich) const override;
virtual nsSMILValue GetBaseValue() const override;
virtual void ClearAnimValue() override;
virtual nsresult SetAnimValue(const nsSMILValue& aValue) override;
};
};
#endif //__NS_SVGENUM_H__