55818d10b30bfd0dcd53a68157db31cec5eda692
[WebKit-https.git] / Source / WebCore / html / HTMLAnchorElement.h
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  *           (C) 2000 Simon Hausmann <hausmann@kde.org>
5  * Copyright (C) 2007-2016 Apple Inc. All rights reserved.
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public License
18  * along with this library; see the file COPYING.LIB.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20  * Boston, MA 02110-1301, USA.
21  *
22  */
23
24 #pragma once
25
26 #include "HTMLElement.h"
27 #include "HTMLNames.h"
28 #include "SharedStringHash.h"
29 #include "URLUtils.h"
30 #include <wtf/OptionSet.h>
31
32 namespace WebCore {
33
34 class DOMTokenList;
35
36 // Link relation bitmask values.
37 enum class Relation {
38     NoReferrer = 1 << 0,
39     NoOpener = 1 << 1,
40 };
41
42 class HTMLAnchorElement : public HTMLElement, public URLUtils<HTMLAnchorElement> {
43     WTF_MAKE_ISO_ALLOCATED(HTMLAnchorElement);
44 public:
45     static Ref<HTMLAnchorElement> create(Document&);
46     static Ref<HTMLAnchorElement> create(const QualifiedName&, Document&);
47
48     virtual ~HTMLAnchorElement();
49
50     WEBCORE_EXPORT URL href() const;
51     void setHref(const AtomicString&);
52
53     const AtomicString& name() const;
54
55     WEBCORE_EXPORT String origin() const;
56
57     WEBCORE_EXPORT String text();
58     void setText(const String&);
59
60     bool isLiveLink() const;
61
62     bool willRespondToMouseClickEvents() final;
63
64     bool hasRel(Relation) const;
65     
66     SharedStringHash visitedLinkHash() const;
67     void invalidateCachedVisitedLinkHash() { m_cachedVisitedLinkHash = 0; }
68
69     WEBCORE_EXPORT DOMTokenList& relList();
70
71 protected:
72     HTMLAnchorElement(const QualifiedName&, Document&);
73
74     void parseAttribute(const QualifiedName&, const AtomicString&) override;
75
76 private:
77     bool supportsFocus() const override;
78     bool isMouseFocusable() const override;
79     bool isKeyboardFocusable(KeyboardEvent*) const override;
80     void defaultEventHandler(Event&) final;
81     void setActive(bool active = true, bool pause = false) final;
82     void accessKeyAction(bool sendMouseEvents) final;
83     bool isURLAttribute(const Attribute&) const final;
84     bool canStartSelection() const final;
85     String target() const override;
86     int tabIndex() const final;
87     bool draggable() const final;
88
89     void sendPings(const URL& destinationURL);
90
91     void handleClick(Event&);
92
93     enum EventType {
94         MouseEventWithoutShiftKey,
95         MouseEventWithShiftKey,
96         NonMouseEvent,
97     };
98     static EventType eventType(Event&);
99     bool treatLinkAsLiveForEventType(EventType) const;
100
101     Element* rootEditableElementForSelectionOnMouseDown() const;
102     void setRootEditableElementForSelectionOnMouseDown(Element*);
103     void clearRootEditableElementForSelectionOnMouseDown();
104
105     bool m_hasRootEditableElementForSelectionOnMouseDown;
106     bool m_wasShiftKeyDownOnMouseDown;
107     OptionSet<Relation> m_linkRelations;
108     mutable SharedStringHash m_cachedVisitedLinkHash;
109
110     std::unique_ptr<DOMTokenList> m_relList;
111 };
112
113 inline SharedStringHash HTMLAnchorElement::visitedLinkHash() const
114 {
115     if (!m_cachedVisitedLinkHash)
116         m_cachedVisitedLinkHash = computeVisitedLinkHash(document().baseURL(), attributeWithoutSynchronization(HTMLNames::hrefAttr));
117     return m_cachedVisitedLinkHash; 
118 }
119
120 // Functions shared with the other anchor elements (i.e., SVG).
121
122 bool isEnterKeyKeydownEvent(Event&);
123 bool shouldProhibitLinks(Element*);
124
125 } // namespace WebCore