bc02a156714261289f4198a3144c0c68110b4ca4
[WebKit-https.git] / Source / WebCore / xml / XPathResult.h
1 /*
2  * Copyright (C) 2005 Frerich Raabe <raabe@kde.org>
3  * Copyright (C) 2006, 2009 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  * 
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  * 
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #pragma once
28
29 #include "XPathValue.h"
30 #include <wtf/Forward.h>
31 #include <wtf/RefCounted.h>
32
33 namespace WebCore {
34
35     typedef int ExceptionCode;
36
37     class Document;
38     class Node;
39
40     class XPathResult : public RefCounted<XPathResult> {
41     public:
42         enum XPathResultType {
43             ANY_TYPE = 0,
44             NUMBER_TYPE = 1,
45             STRING_TYPE = 2,
46             BOOLEAN_TYPE = 3,
47             UNORDERED_NODE_ITERATOR_TYPE = 4,
48             ORDERED_NODE_ITERATOR_TYPE = 5,
49             UNORDERED_NODE_SNAPSHOT_TYPE = 6,
50             ORDERED_NODE_SNAPSHOT_TYPE = 7,
51             ANY_UNORDERED_NODE_TYPE = 8,
52             FIRST_ORDERED_NODE_TYPE = 9
53         };
54         
55         static Ref<XPathResult> create(Document* document, const XPath::Value& value) { return adoptRef(*new XPathResult(document, value)); }
56         WEBCORE_EXPORT ~XPathResult();
57         
58         void convertTo(unsigned short type, ExceptionCode&);
59
60         WEBCORE_EXPORT unsigned short resultType() const;
61
62         WEBCORE_EXPORT double numberValue(ExceptionCode&) const;
63         WEBCORE_EXPORT String stringValue(ExceptionCode&) const;
64         WEBCORE_EXPORT bool booleanValue(ExceptionCode&) const;
65         WEBCORE_EXPORT Node* singleNodeValue(ExceptionCode&) const;
66
67         WEBCORE_EXPORT bool invalidIteratorState() const;
68         WEBCORE_EXPORT unsigned snapshotLength(ExceptionCode&) const;
69         WEBCORE_EXPORT Node* iterateNext(ExceptionCode&);
70         WEBCORE_EXPORT Node* snapshotItem(unsigned index, ExceptionCode&);
71
72         const XPath::Value& value() const { return m_value; }
73
74     private:
75         XPathResult(Document*, const XPath::Value&);
76         
77         XPath::Value m_value;
78         unsigned m_nodeSetPosition;
79         XPath::NodeSet m_nodeSet; // FIXME: why duplicate the node set stored in m_value?
80         unsigned short m_resultType;
81         RefPtr<Document> m_document;
82         uint64_t m_domTreeVersion;
83     };
84
85 } // namespace WebCore