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