Source/WebCore/xml/XPathResult.h

/*
 * Copyright (C) 2005 Frerich Raabe <raabe@kde.org>
 * Copyright (C) 2006, 2009 Apple Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#pragma once

#include "ExceptionOr.h"
#include "XPathValue.h"

namespace WebCore {

class XPathResult : public RefCounted<XPathResult> {
public:
    enum XPathResultType {
        ANY_TYPE = 0,
        NUMBER_TYPE = 1,
        STRING_TYPE = 2,
        BOOLEAN_TYPE = 3,
        UNORDERED_NODE_ITERATOR_TYPE = 4,
        ORDERED_NODE_ITERATOR_TYPE = 5,
        UNORDERED_NODE_SNAPSHOT_TYPE = 6,
        ORDERED_NODE_SNAPSHOT_TYPE = 7,
        ANY_UNORDERED_NODE_TYPE = 8,
        FIRST_ORDERED_NODE_TYPE = 9
    };

    static Ref<XPathResult> create(Document& document, const XPath::Value& value) { return adoptRef(*new XPathResult(document, value)); }
    WEBCORE_EXPORT ~XPathResult();

    ExceptionOr<void> convertTo(unsigned short type);

    WEBCORE_EXPORT unsigned short resultType() const;

    WEBCORE_EXPORT ExceptionOr<double> numberValue() const;
    WEBCORE_EXPORT ExceptionOr<String> stringValue() const;
    WEBCORE_EXPORT ExceptionOr<bool> booleanValue() const;
    WEBCORE_EXPORT ExceptionOr<Node*> singleNodeValue() const;

    WEBCORE_EXPORT bool invalidIteratorState() const;
    WEBCORE_EXPORT ExceptionOr<unsigned> snapshotLength() const;
    WEBCORE_EXPORT ExceptionOr<Node*> iterateNext();
    WEBCORE_EXPORT ExceptionOr<Node*> snapshotItem(unsigned index);

    const XPath::Value& value() const { return m_value; }

private:
    XPathResult(Document&, const XPath::Value&);

    XPath::Value m_value;
    unsigned m_nodeSetPosition { 0 };
    XPath::NodeSet m_nodeSet; // FIXME: why duplicate the node set stored in m_value?
    unsigned short m_resultType;
    RefPtr<Document> m_document;
    uint64_t m_domTreeVersion { 0 };
};

} // namespace WebCore