[WTF] Clean up StringStatics.cpp by using LazyNeverDestroyed<> for Atoms
[WebKit-https.git] / Source / WebCore / dom / Attribute.h
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  *           (C) 2001 Peter Kelly (pmk@post.com)
5  *           (C) 2001 Dirk Mueller (mueller@kde.org)
6  * Copyright (C) 2003, 2004, 2005, 2006, 2008, 2012, 2014 Apple Inc. All rights reserved.
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public License
19  * along with this library; see the file COPYING.LIB.  If not, write to
20  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21  * Boston, MA 02110-1301, USA.
22  *
23  */
24
25 #pragma once
26
27 #include "QualifiedName.h"
28
29 namespace WebCore {
30
31 // This has no counterpart in DOM.
32 // It is an internal representation of the node value of an Attr.
33 // The actual Attr with its value as a Text child is allocated only if needed.
34 class Attribute {
35 public:
36     Attribute(const QualifiedName& name, const AtomicString& value)
37         : m_name(name)
38         , m_value(value)
39     {
40     }
41
42     // NOTE: The references returned by these functions are only valid for as long
43     // as the Attribute stays in place. For example, calling a function that mutates
44     // an Element's internal attribute storage may invalidate them.
45     const AtomicString& value() const { return m_value; }
46     static ptrdiff_t valueMemoryOffset() { return OBJECT_OFFSETOF(Attribute, m_value); }
47     const AtomicString& prefix() const { return m_name.prefix(); }
48     const AtomicString& localName() const { return m_name.localName(); }
49     const AtomicString& namespaceURI() const { return m_name.namespaceURI(); }
50
51     const QualifiedName& name() const { return m_name; }
52     static ptrdiff_t nameMemoryOffset() { return OBJECT_OFFSETOF(Attribute, m_name); }
53
54     bool isEmpty() const { return m_value.isEmpty(); }
55     static bool nameMatchesFilter(const QualifiedName&, const AtomicString& filterPrefix, const AtomicString& filterLocalName, const AtomicString& filterNamespaceURI);
56     bool matches(const AtomicString& prefix, const AtomicString& localName, const AtomicString& namespaceURI) const;
57
58     void setValue(const AtomicString& value) { m_value = value; }
59     void setPrefix(const AtomicString& prefix) { m_name.setPrefix(prefix); }
60
61     // Note: This API is only for HTMLTreeBuilder.  It is not safe to change the
62     // name of an attribute once parseAttribute has been called as DOM
63     // elements may have placed the Attribute in a hash by name.
64     void parserSetName(const QualifiedName& name) { m_name = name; }
65
66 #if COMPILER(MSVC)
67     // NOTE: This constructor is not actually implemented, it's just defined so MSVC
68     // will let us use a zero-length array of Attributes.
69     Attribute();
70 #endif
71
72 private:
73     QualifiedName m_name;
74     AtomicString m_value;
75 };
76
77 inline bool Attribute::nameMatchesFilter(const QualifiedName& name, const AtomicString& filterPrefix, const AtomicString& filterLocalName, const AtomicString& filterNamespaceURI)
78 {
79     if (filterLocalName != name.localName())
80         return false;
81     return filterPrefix == starAtom() || filterNamespaceURI == name.namespaceURI();
82 }
83
84 inline bool Attribute::matches(const AtomicString& prefix, const AtomicString& localName, const AtomicString& namespaceURI) const
85 {
86     return nameMatchesFilter(m_name, prefix, localName, namespaceURI);
87 }
88
89 } // namespace WebCore