53ac5e2f4cbe2bc3e956459a67ef655da6b5fdce
[WebKit-https.git] / Source / WebCore / html / DOMTokenList.h
1 /*
2  * Copyright (C) 2010 Google Inc. All rights reserved.
3  * Copyright (C) 2015, 2016 Apple Inc. All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
16  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
17  * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
18  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
19  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
20  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
21  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
23  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "Element.h"
29
30 namespace WebCore {
31
32 class DOMTokenList {
33     WTF_MAKE_FAST_ALLOCATED;
34 public:
35     DOMTokenList(Element&, const QualifiedName& attributeName, WTF::Function<bool(StringView)>&& isSupportedToken = { });
36
37     void associatedAttributeValueChanged(const AtomicString&);
38
39     void ref() { m_element.ref(); }
40     void deref() { m_element.deref(); }
41
42     unsigned length() const;
43     const AtomicString& item(unsigned index) const;
44
45     WEBCORE_EXPORT bool contains(const AtomicString&) const;
46     ExceptionOr<void> add(const Vector<String>&);
47     ExceptionOr<void> add(const AtomicString&);
48     ExceptionOr<void> remove(const Vector<String>&);
49     ExceptionOr<void> remove(const AtomicString&);
50     WEBCORE_EXPORT ExceptionOr<bool> toggle(const AtomicString&, std::optional<bool> force);
51     ExceptionOr<void> replace(const AtomicString& token, const AtomicString& newToken);
52     ExceptionOr<bool> supports(StringView token);
53
54     Element& element() const { return m_element; }
55
56     WEBCORE_EXPORT void setValue(const String&);
57     WEBCORE_EXPORT const AtomicString& value() const;
58
59 private:
60     void updateTokensFromAttributeValue(const String&);
61     void updateAssociatedAttributeFromTokens();
62
63     WEBCORE_EXPORT Vector<AtomicString>& tokens();
64     const Vector<AtomicString>& tokens() const { return const_cast<DOMTokenList&>(*this).tokens(); }
65
66     static ExceptionOr<void> validateToken(const String&);
67     static ExceptionOr<void> validateTokens(const String* tokens, size_t length);
68     ExceptionOr<void> addInternal(const String* tokens, size_t length);
69     ExceptionOr<void> removeInternal(const String* tokens, size_t length);
70
71     Element& m_element;
72     const WebCore::QualifiedName& m_attributeName;
73     bool m_inUpdateAssociatedAttributeFromTokens { false };
74     bool m_tokensNeedUpdating { true };
75     Vector<AtomicString> m_tokens;
76     WTF::Function<bool(StringView)> m_isSupportedToken;
77 };
78
79 inline unsigned DOMTokenList::length() const
80 {
81     return tokens().size();
82 }
83
84 inline const AtomicString& DOMTokenList::item(unsigned index) const
85 {
86     auto& tokens = this->tokens();
87     return index < tokens.size() ? tokens[index] : nullAtom;
88 }
89
90 } // namespace WebCore