blob: 19fd67b53613e16a07b59c94aff240ae11d661cd (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
/* -*- 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_SMIL_SMILTIMEVALUE_H_
#define DOM_SMIL_SMILTIMEVALUE_H_
#include "mozilla/SMILTypes.h"
#include "nsDebug.h"
namespace mozilla {
/*----------------------------------------------------------------------
* SMILTimeValue class
*
* A tri-state time value.
*
* First a quick overview of the SMIL time data types:
*
* SMILTime -- a timestamp in milliseconds.
* SMILTimeValue -- (this class) a timestamp that can take the additional
* states 'indefinite' and 'unresolved'
* SMILInstanceTime -- an SMILTimeValue used for constructing intervals. It
* contains additional fields to govern reset behavior
* and track timing dependencies (e.g. syncbase timing).
* SMILInterval -- a pair of SMILInstanceTimes that defines a begin and
* an end time for animation.
* SMILTimeValueSpec -- a component of a begin or end attribute, such as the
* '5s' or 'a.end+2m' in begin="5s; a.end+2m". Acts as
* a broker between an SMILTimedElement and its
* SMILInstanceTimes by generating new instance times
* and handling changes to existing times.
*
* Objects of this class may be in one of three states:
*
* 1) The time is resolved and has a definite millisecond value
* 2) The time is resolved and indefinite
* 3) The time is unresolved
*
* In summary:
*
* State | GetMillis | IsDefinite | IsIndefinite | IsResolved
* -----------+---------------+------------+--------------+------------
* Definite | SMILTimeValue | true | false | true
* -----------+---------------+------------+--------------+------------
* Indefinite | -- | false | true | true
* -----------+---------------+------------+--------------+------------
* Unresolved | -- | false | false | false
*
*/
class SMILTimeValue {
public:
// Creates an unresolved time value
SMILTimeValue()
: mMilliseconds(kUnresolvedMillis), mState(STATE_UNRESOLVED) {}
// Creates a resolved time value
explicit SMILTimeValue(SMILTime aMillis)
: mMilliseconds(aMillis), mState(STATE_DEFINITE) {}
// Named constructor to create an indefinite time value
static SMILTimeValue Indefinite() {
SMILTimeValue value;
value.SetIndefinite();
return value;
}
static SMILTimeValue Zero() { return SMILTimeValue(SMILTime(0L)); }
bool IsIndefinite() const { return mState == STATE_INDEFINITE; }
void SetIndefinite() {
mState = STATE_INDEFINITE;
mMilliseconds = kUnresolvedMillis;
}
bool IsResolved() const { return mState != STATE_UNRESOLVED; }
void SetUnresolved() {
mState = STATE_UNRESOLVED;
mMilliseconds = kUnresolvedMillis;
}
bool IsDefinite() const { return mState == STATE_DEFINITE; }
SMILTime GetMillis() const {
MOZ_ASSERT(mState == STATE_DEFINITE,
"GetMillis() called for unresolved or indefinite time");
return mState == STATE_DEFINITE ? mMilliseconds : kUnresolvedMillis;
}
bool IsZero() const {
return mState == STATE_DEFINITE ? mMilliseconds == 0 : false;
}
void SetMillis(SMILTime aMillis) {
mState = STATE_DEFINITE;
mMilliseconds = aMillis;
}
/*
* EnsureNonZero ensures values such as 0.0001s are not represented as 0
* for values where 0 is invalid.
*/
enum class Rounding : uint8_t { EnsureNonZero, Nearest };
void SetMillis(double aMillis, Rounding aRounding);
int8_t CompareTo(const SMILTimeValue& aOther) const;
bool operator==(const SMILTimeValue& aOther) const {
return CompareTo(aOther) == 0;
}
bool operator!=(const SMILTimeValue& aOther) const {
return CompareTo(aOther) != 0;
}
bool operator<(const SMILTimeValue& aOther) const {
return CompareTo(aOther) < 0;
}
bool operator>(const SMILTimeValue& aOther) const {
return CompareTo(aOther) > 0;
}
bool operator<=(const SMILTimeValue& aOther) const {
return CompareTo(aOther) <= 0;
}
bool operator>=(const SMILTimeValue& aOther) const {
return CompareTo(aOther) >= 0;
}
private:
static const SMILTime kUnresolvedMillis;
SMILTime mMilliseconds;
enum { STATE_DEFINITE, STATE_INDEFINITE, STATE_UNRESOLVED } mState;
};
} // namespace mozilla
#endif // DOM_SMIL_SMILTIMEVALUE_H_
|
