third_party/WebKit/Source/core/svg/SVGStringList.h

/*
 * Copyright (C) 2014 Google 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:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * 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.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "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 THE COPYRIGHT
 * OWNER 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.
 */

#ifndef SVGStringList_h
#define SVGStringList_h

#include "core/svg/SVGParsingError.h"
#include "core/svg/SVGString.h"
#include "core/svg/properties/SVGPropertyHelper.h"

namespace blink {

class ExceptionState;
class SVGStringListTearOff;

// Implementation of SVGStringList spec:
// http://www.w3.org/TR/SVG/single-page.html#types-InterfaceSVGStringList
// See SVGStringListTearOff for actual Javascript interface.
// Unlike other SVG*List implementations, SVGStringList is NOT tied to
// SVGString.
// SVGStringList operates directly on DOMString.
//
// In short:
//   SVGStringList has_a Vector<String>.
//   SVGStringList items are exposed to Javascript as DOMString (not SVGString)
//   as in the spec.
//   SVGString is used only for boxing values for non-list string property
//   SVGAnimatedString,
//   and not used for SVGStringList.
class SVGStringList final : public SVGPropertyHelper<SVGStringList> {
 public:
  typedef SVGStringListTearOff TearOffType;

  static SVGStringList* Create() { return new SVGStringList(); }

  ~SVGStringList() override;

  const Vector<String>& Values() const { return values_; }

  // SVGStringList DOM Spec implementation. These are only to be called from
  // SVGStringListTearOff:
  unsigned long length() { return values_.size(); }
  void clear() { values_.clear(); }
  void Initialize(const String&);
  String GetItem(size_t, ExceptionState&);
  void InsertItemBefore(const String&, size_t);
  String RemoveItem(size_t, ExceptionState&);
  void AppendItem(const String&);
  void ReplaceItem(const String&, size_t, ExceptionState&);

  // SVGPropertyBase:
  SVGParsingError SetValueAsString(const String&);
  String ValueAsString() const override;

  void Add(SVGPropertyBase*, SVGElement*) override;
  void CalculateAnimatedValue(SVGAnimationElement*,
                              float percentage,
                              unsigned repeat_count,
                              SVGPropertyBase* from_value,
                              SVGPropertyBase* to_value,
                              SVGPropertyBase* to_at_end_of_duration_value,
                              SVGElement*) override;
  float CalculateDistance(SVGPropertyBase* to, SVGElement*) override;

  static AnimatedPropertyType ClassType() { return kAnimatedStringList; }

 private:
  SVGStringList();

  template <typename CharType>
  void ParseInternal(const CharType*& ptr, const CharType* end);
  bool CheckIndexBound(size_t, ExceptionState&);

  Vector<String> values_;
};

}  // namespace blink

#endif  // SVGStringList_h