Use #pragma once in WebCore
[WebKit-https.git] / Source / WebCore / dom / TextNodeTraversal.h
1 /*
2  * Copyright (C) 2013 Apple 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
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "NodeTraversal.h"
29 #include "Text.h"
30
31 namespace WTF {
32 class StringBuilder;
33 }
34
35 namespace WebCore {
36 namespace TextNodeTraversal {
37
38 // First text child of the node.
39 Text* firstChild(const Node&);
40 Text* firstChild(const ContainerNode&);
41
42 // First text descendant of the node.
43 Text* firstWithin(const Node&);
44 Text* firstWithin(const ContainerNode&);
45
46 // Pre-order traversal skipping non-text nodes.
47 Text* next(const Node&);
48 Text* next(const Node&, const Node* stayWithin);
49 Text* next(const Text&);
50 Text* next(const Text&, const Node* stayWithin);
51
52 // Next text sibling.
53 Text* nextSibling(const Node&);
54
55 // Concatenated text contents of a subtree.
56 String contentsAsString(const Node&);
57 String contentsAsString(const ContainerNode&);
58 void appendContents(const ContainerNode&, StringBuilder& result);
59
60 }
61
62 namespace TextNodeTraversal {
63
64 template <class NodeType>
65 inline Text* firstTextChildTemplate(NodeType& current)
66 {
67     Node* node = current.firstChild();
68     while (node && !is<Text>(*node))
69         node = node->nextSibling();
70     return downcast<Text>(node);
71 }
72 inline Text* firstChild(const Node& current) { return firstTextChildTemplate(current); }
73 inline Text* firstChild(const ContainerNode& current) { return firstTextChildTemplate(current); }
74
75 template <class NodeType>
76 inline Text* firstTextWithinTemplate(NodeType& current)
77 {
78     Node* node = current.firstChild();
79     while (node && !is<Text>(*node))
80         node = NodeTraversal::next(*node, &current);
81     return downcast<Text>(node);
82 }
83 inline Text* firstWithin(const Node& current) { return firstTextWithinTemplate(current); }
84 inline Text* firstWithin(const ContainerNode& current) { return firstTextWithinTemplate(current); }
85
86 template <class NodeType>
87 inline Text* traverseNextTextTemplate(NodeType& current)
88 {
89     Node* node = NodeTraversal::next(current);
90     while (node && !is<Text>(*node))
91         node = NodeTraversal::next(*node);
92     return downcast<Text>(node);
93 }
94 inline Text* next(const Node& current) { return traverseNextTextTemplate(current); }
95 inline Text* next(const Text& current) { return traverseNextTextTemplate(current); }
96
97 template <class NodeType>
98 inline Text* traverseNextTextTemplate(NodeType& current, const Node* stayWithin)
99 {
100     Node* node = NodeTraversal::next(current, stayWithin);
101     while (node && !is<Text>(*node))
102         node = NodeTraversal::next(*node, stayWithin);
103     return downcast<Text>(node);
104 }
105 inline Text* next(const Node& current, const Node* stayWithin) { return traverseNextTextTemplate(current, stayWithin); }
106 inline Text* next(const Text& current, const Node* stayWithin) { return traverseNextTextTemplate(current, stayWithin); }
107
108 inline Text* nextSibling(const Node& current)
109 {
110     Node* node = current.nextSibling();
111     while (node && !is<Text>(*node))
112         node = node->nextSibling();
113     return downcast<Text>(node);
114 }
115
116 } // namespace TextNodeTraversal
117 } // namespace WebCore