third_party/WebKit/Source/core/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 #ifndef XPathResult_h
  28 #define XPathResult_h
  29
  30 #include "bindings/core/v8/ScriptWrappable.h"
  31 #include "core/xml/XPathValue.h"
  32 #include "platform/heap/Handle.h"
  33 #include "wtf/Forward.h"
  34
  35 namespace blink {
  36
  37 class Document;
  38 class ExceptionState;
  39 class Node;
  40
  41 namespace XPath {
  42 struct EvaluationContext;
  43 }
  44
  45 // TODO(Oilpan): remove Finalized when transition type for m_document is.
  46 class XPathResult final : public GarbageCollectedFinalized<XPathResult>, public ScriptWrappable {
  47     DECLARE_EMPTY_DESTRUCTOR_WILL_BE_REMOVED(XPathResult);
  48     DEFINE_WRAPPERTYPEINFO();
  49 public:
  50     enum XPathResultType {
  51         ANY_TYPE = 0,
  52         NUMBER_TYPE = 1,
  53         STRING_TYPE = 2,
  54         BOOLEAN_TYPE = 3,
  55         UNORDERED_NODE_ITERATOR_TYPE = 4,
  56         ORDERED_NODE_ITERATOR_TYPE = 5,
  57         UNORDERED_NODE_SNAPSHOT_TYPE = 6,
  58         ORDERED_NODE_SNAPSHOT_TYPE = 7,
  59         ANY_UNORDERED_NODE_TYPE = 8,
  60         FIRST_ORDERED_NODE_TYPE = 9
  61     };
  62
  63     static XPathResult* create(XPath::EvaluationContext& context, const XPath::Value& value)
  64     {
  65         return new XPathResult(context, value);
  66     }
  67
  68     void convertTo(unsigned short type, ExceptionState&);
  69
  70     unsigned short resultType() const;
  71
  72     double numberValue(ExceptionState&) const;
  73     String stringValue(ExceptionState&) const;
  74     bool booleanValue(ExceptionState&) const;
  75     Node* singleNodeValue(ExceptionState&) const;
  76
  77     bool invalidIteratorState() const;
  78     unsigned snapshotLength(ExceptionState&) const;
  79     Node* iterateNext(ExceptionState&);
  80     Node* snapshotItem(unsigned index, ExceptionState&);
  81
  82     const XPath::Value& value() const { return m_value; }
  83
  84     DECLARE_TRACE();
  85
  86 private:
  87     XPathResult(XPath::EvaluationContext&, const XPath::Value&);
  88     XPath::NodeSet& nodeSet() { return *m_nodeSet; }
  89
  90     XPath::Value m_value;
  91     unsigned m_nodeSetPosition;
  92     Member<XPath::NodeSet> m_nodeSet; // FIXME: why duplicate the node set stored in m_value?
  93     unsigned short m_resultType;
  94     RefPtrWillBeMember<Document> m_document;
  95     uint64_t m_domTreeVersion;
  96 };
  97
  98 } // namespace blink
  99
 100 #endif // XPathResult_h