Source/WebCore/animation/AnimationEffectTimingReadOnly.h

/*
 * Copyright (C) 2018 Apple Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#pragma once

#include "AnimationEffectReadOnly.h"
#include "ExceptionOr.h"
#include "FillMode.h"
#include "KeyframeEffectOptions.h"
#include "PlaybackDirection.h"
#include "TimingFunction.h"
#include "WebAnimationUtilities.h"
#include <wtf/Forward.h>
#include <wtf/Ref.h>
#include <wtf/RefCounted.h>
#include <wtf/RefPtr.h>
#include <wtf/Seconds.h>
#include <wtf/Variant.h>

namespace WebCore {

class AnimationEffectTimingReadOnly : public RefCounted<AnimationEffectTimingReadOnly> {
public:
    static Ref<AnimationEffectTimingReadOnly> create();
    ~AnimationEffectTimingReadOnly();

    bool isAnimationEffectTiming() const { return m_classType == AnimationEffectTimingClass; }

    void setEffect(AnimationEffectReadOnly* effect) { m_effect = effect; }

    ExceptionOr<void> setProperties(std::optional<Variant<double, KeyframeEffectOptions>>&&);
    void copyPropertiesFromSource(AnimationEffectTimingReadOnly*);

    double bindingsDelay() const { return secondsToWebAnimationsAPITime(m_delay); }
    void setBindingsDelay(double delay) { setDelay(Seconds::fromMilliseconds(delay)); }

    double bindingsEndDelay() const { return secondsToWebAnimationsAPITime(m_endDelay); }
    void setBindingsEndDelay(double endDelay) { setEndDelay(Seconds::fromMilliseconds(endDelay)); }

    Variant<double, String> bindingsDuration() const;
    ExceptionOr<void> setBindingsDuration(Variant<double, String>&&);

    Seconds delay() const { return m_delay; }
    void setDelay(const Seconds&);

    Seconds endDelay() const { return m_endDelay; }
    void setEndDelay(const Seconds&);

    FillMode fill() const { return m_fill; }
    void setFill(FillMode);

    double iterationStart() const { return m_iterationStart; }
    ExceptionOr<void> setIterationStart(double);

    double iterations() const { return m_iterations; }
    ExceptionOr<void> setIterations(double);

    Seconds iterationDuration() const { return m_iterationDuration; }
    void setIterationDuration(const Seconds&);

    PlaybackDirection direction() const { return m_direction; }
    void setDirection(PlaybackDirection);

    String easing() const { return m_timingFunction->cssText(); }
    ExceptionOr<void> setEasing(const String&);

    TimingFunction* timingFunction() const { return m_timingFunction.get(); }
    void setTimingFunction(const RefPtr<TimingFunction>&);

    Seconds endTime() const;
    Seconds activeDuration() const;

protected:
    enum ClassType {
        AnimationEffectTimingClass,
        AnimationEffectTimingReadOnlyClass
    };

    ClassType classType() const { return m_classType; }

    explicit AnimationEffectTimingReadOnly(ClassType);

private:
    void propertyDidChange();

    ClassType m_classType;
    AnimationEffectReadOnly* m_effect;
    Seconds m_delay { 0_s };
    Seconds m_endDelay { 0_s };
    FillMode m_fill { FillMode::Auto };
    double m_iterationStart { 0 };
    double m_iterations { 1 };
    Seconds m_iterationDuration { 0_s };
    PlaybackDirection m_direction { PlaybackDirection::Normal };
    RefPtr<TimingFunction> m_timingFunction;

};

} // namespace WebCore

#define SPECIALIZE_TYPE_TRAITS_ANIMATION_EFFECT_TIMING(ToValueTypeName, predicate) \
SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::ToValueTypeName) \
static bool isType(const WebCore::AnimationEffectTimingReadOnly& value) { return value.predicate; } \
SPECIALIZE_TYPE_TRAITS_END()