1/*
2 * Copyright (C) 2014 Google Inc. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
6 * met:
7 *
8 *     * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 *     * Redistributions in binary form must reproduce the above
11 * copyright notice, this list of conditions and the following disclaimer
12 * in the documentation and/or other materials provided with the
13 * distribution.
14 *     * Neither the name of Google Inc. nor the names of its
15 * contributors may be used to endorse or promote products derived from
16 * this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30
31#ifndef SVGStringList_h
32#define SVGStringList_h
33
34#include "bindings/core/v8/ScriptWrappable.h"
35#include "core/svg/SVGString.h"
36#include "core/svg/properties/SVGPropertyHelper.h"
37
38namespace blink {
39
40class SVGStringListTearOff;
41
42// Implementation of SVGStringList spec:
43// http://www.w3.org/TR/SVG/single-page.html#types-InterfaceSVGStringList
44// See SVGStringListTearOff for actual Javascript interface.
45// Unlike other SVG*List implementations, SVGStringList is NOT tied to SVGString.
46// SVGStringList operates directly on DOMString.
47//
48// In short:
49//   SVGStringList has_a Vector<String>.
50//   SVGStringList items are exposed to Javascript as DOMString (not SVGString) as in the spec.
51//   SVGString is used only for boxing values for non-list string property SVGAnimatedString,
52//   and not used for SVGStringList.
53class SVGStringList FINAL : public SVGPropertyHelper<SVGStringList> {
54public:
55    typedef SVGStringListTearOff TearOffType;
56
57    static PassRefPtr<SVGStringList> create()
58    {
59        return adoptRef(new SVGStringList());
60    }
61
62    virtual ~SVGStringList();
63
64    const Vector<String>& values() const { return m_values; }
65
66    // SVGStringList DOM Spec implementation. These are only to be called from SVGStringListTearOff:
67    unsigned long length() { return m_values.size(); }
68    void clear() { m_values.clear(); }
69    void initialize(const String&);
70    String getItem(size_t, ExceptionState&);
71    void insertItemBefore(const String&, size_t);
72    String removeItem(size_t, ExceptionState&);
73    void appendItem(const String&);
74    void replaceItem(const String&, size_t, ExceptionState&);
75
76    // SVGPropertyBase:
77    void setValueAsString(const String&, ExceptionState&);
78    virtual String valueAsString() const OVERRIDE;
79
80    virtual void add(PassRefPtrWillBeRawPtr<SVGPropertyBase>, SVGElement*) OVERRIDE;
81    virtual void calculateAnimatedValue(SVGAnimationElement*, float percentage, unsigned repeatCount, PassRefPtr<SVGPropertyBase> fromValue, PassRefPtr<SVGPropertyBase> toValue, PassRefPtr<SVGPropertyBase> toAtEndOfDurationValue, SVGElement*) OVERRIDE;
82    virtual float calculateDistance(PassRefPtr<SVGPropertyBase> to, SVGElement*) OVERRIDE;
83
84    static AnimatedPropertyType classType() { return AnimatedStringList; }
85
86private:
87    SVGStringList();
88
89    template <typename CharType>
90    void parseInternal(const CharType*& ptr, const CharType* end);
91    bool checkIndexBound(size_t, ExceptionState&);
92
93    Vector<String> m_values;
94};
95
96} // namespace blink
97
98#endif // SVGStringList_h
99