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 "ExceptionOr.h"
30#include "XPathValue.h"
31
32namespace WebCore {
33
34class XPathResult : public RefCounted<XPathResult> {
35public:
36 enum XPathResultType {
37 ANY_TYPE = 0,
38 NUMBER_TYPE = 1,
39 STRING_TYPE = 2,
40 BOOLEAN_TYPE = 3,
41 UNORDERED_NODE_ITERATOR_TYPE = 4,
42 ORDERED_NODE_ITERATOR_TYPE = 5,
43 UNORDERED_NODE_SNAPSHOT_TYPE = 6,
44 ORDERED_NODE_SNAPSHOT_TYPE = 7,
45 ANY_UNORDERED_NODE_TYPE = 8,
46 FIRST_ORDERED_NODE_TYPE = 9
47 };
48
49 static Ref<XPathResult> create(Document& document, const XPath::Value& value) { return adoptRef(*new XPathResult(document, value)); }
50 WEBCORE_EXPORT ~XPathResult();
51
52 ExceptionOr<void> convertTo(unsigned short type);
53
54 WEBCORE_EXPORT unsigned short resultType() const;
55
56 WEBCORE_EXPORT ExceptionOr<double> numberValue() const;
57 WEBCORE_EXPORT ExceptionOr<String> stringValue() const;
58 WEBCORE_EXPORT ExceptionOr<bool> booleanValue() const;
59 WEBCORE_EXPORT ExceptionOr<Node*> singleNodeValue() const;
60
61 WEBCORE_EXPORT bool invalidIteratorState() const;
62 WEBCORE_EXPORT ExceptionOr<unsigned> snapshotLength() const;
63 WEBCORE_EXPORT ExceptionOr<Node*> iterateNext();
64 WEBCORE_EXPORT ExceptionOr<Node*> snapshotItem(unsigned index);
65
66 const XPath::Value& value() const { return m_value; }
67
68private:
69 XPathResult(Document&, const XPath::Value&);
70
71 XPath::Value m_value;
72 unsigned m_nodeSetPosition { 0 };
73 XPath::NodeSet m_nodeSet; // FIXME: why duplicate the node set stored in m_value?
74 unsigned short m_resultType;
75 RefPtr<Document> m_document;
76 uint64_t m_domTreeVersion { 0 };
77};
78
79} // namespace WebCore
80