Home | History | Annotate | Download | only in xml
      1 /*
      2  * Copyright (C) 2005 Frerich Raabe <raabe (at) 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 #include "bindings/v8/ScriptWrappable.h"
     31 #include "core/xml/XPathValue.h"
     32 #include "wtf/Forward.h"
     33 #include "wtf/RefCounted.h"
     34 
     35 namespace WebCore {
     36 
     37 class Document;
     38 class ExceptionState;
     39 class Node;
     40 
     41 class XPathResult : public RefCounted<XPathResult>, public ScriptWrappable {
     42 public:
     43     enum XPathResultType {
     44         ANY_TYPE = 0,
     45         NUMBER_TYPE = 1,
     46         STRING_TYPE = 2,
     47         BOOLEAN_TYPE = 3,
     48         UNORDERED_NODE_ITERATOR_TYPE = 4,
     49         ORDERED_NODE_ITERATOR_TYPE = 5,
     50         UNORDERED_NODE_SNAPSHOT_TYPE = 6,
     51         ORDERED_NODE_SNAPSHOT_TYPE = 7,
     52         ANY_UNORDERED_NODE_TYPE = 8,
     53         FIRST_ORDERED_NODE_TYPE = 9
     54     };
     55 
     56     static PassRefPtr<XPathResult> create(Document* document, const XPath::Value& value) { return adoptRef(new XPathResult(document, value)); }
     57     ~XPathResult();
     58 
     59     void convertTo(unsigned short type, ExceptionState&);
     60 
     61     unsigned short resultType() const;
     62 
     63     double numberValue(ExceptionState&) const;
     64     String stringValue(ExceptionState&) const;
     65     bool booleanValue(ExceptionState&) const;
     66     Node* singleNodeValue(ExceptionState&) const;
     67 
     68     bool invalidIteratorState() const;
     69     unsigned long snapshotLength(ExceptionState&) const;
     70     Node* iterateNext(ExceptionState&);
     71     Node* snapshotItem(unsigned long index, ExceptionState&);
     72 
     73     const XPath::Value& value() const { return m_value; }
     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     uint64_t m_domTreeVersion;
     84 };
     85 
     86 } // namespace WebCore
     87 
     88 #endif // XPathResult_h
     89