/*
 *  This file is part of the KDE libraries
 *  Copyright (C) 2001 Peter Kelly (pmk@post.com)
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Library General Public
 *  License as published by the Free Software Foundation; either
 *  version 2 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Library General Public License for more details.
 *
 *  You should have received a copy of the GNU Library General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
 */

#ifndef _KJS_TRAVERSAL_H_
#define _KJS_TRAVERSAL_H_

#include "ecma/kjs_binding.h"
#include "ecma/kjs_dom.h"
#include "dom/dom2_traversal.h"

namespace KJS
{

class DOMNodeIterator : public DOMObject
{
public:
    DOMNodeIterator(ExecState *exec, DOM::NodeIteratorImpl *ni);
    ~DOMNodeIterator();
    using KJS::JSObject::getOwnPropertySlot;
    virtual bool getOwnPropertySlot(ExecState *exec, const Identifier &propertyName, PropertySlot &slot);
    JSValue *getValueProperty(ExecState *exec, int token) const;
    // no put - all read-only
    virtual const ClassInfo *classInfo() const
    {
        return &info;
    }
    static const ClassInfo info;
    enum { Filter, Root, WhatToShow, ExpandEntityReferences,
           NextNode, PreviousNode, Detach
         };
    DOM::NodeIteratorImpl *impl() const
    {
        return m_impl.get();
    }
protected:
    SharedPtr<DOM::NodeIteratorImpl> m_impl;
};

// Constructor object NodeFilter
class NodeFilterConstructor : public DOMObject
{
public:
    NodeFilterConstructor(ExecState *);
    using KJS::JSObject::getOwnPropertySlot;
    virtual bool getOwnPropertySlot(ExecState *exec, const Identifier &propertyName, PropertySlot &slot);
    JSValue *getValueProperty(ExecState *exec, int token) const;
    // no put - all read-only
    virtual const ClassInfo *classInfo() const
    {
        return &info;
    }
    static const ClassInfo info;
};

class DOMTreeWalker : public DOMObject
{
public:
    DOMTreeWalker(ExecState *exec, DOM::TreeWalkerImpl *tw);
    ~DOMTreeWalker();
    using KJS::JSObject::getOwnPropertySlot;
    virtual bool getOwnPropertySlot(ExecState *exec, const Identifier &propertyName, PropertySlot &slot);
    JSValue *getValueProperty(ExecState *exec, int token) const;
    virtual void mark();
    using KJS::JSObject::put;
    virtual void put(ExecState *exec, const Identifier &propertyName,
                     JSValue *value, int attr = None);
    virtual const ClassInfo *classInfo() const
    {
        return &info;
    }
    static const ClassInfo info;
    enum { Root, WhatToShow, Filter, ExpandEntityReferences, CurrentNode,
           ParentNode, FirstChild, LastChild, PreviousSibling, NextSibling,
           PreviousNode, NextNode
         };
    DOM::TreeWalkerImpl *impl() const
    {
        return m_impl.get();
    }
protected:
    SharedPtr<DOM::TreeWalkerImpl> m_impl;
};

JSValue *getDOMNodeIterator(ExecState *exec, DOM::NodeIteratorImpl *ni);
JSValue *getNodeFilterConstructor(ExecState *exec);
JSValue *getDOMNodeFilter(ExecState *exec, DOM::NodeFilterImpl *nf);
JSValue *getDOMTreeWalker(ExecState *exec, DOM::TreeWalkerImpl *tw);

/**
 * Convert an object to a NodeFilter. Returns a null Node if not possible.
 */
DOM::NodeFilterImpl *toNodeFilter(JSValue *);

class JSNodeFilter : public DOM::NodeFilterImpl
{
public:
    JSNodeFilter(JSObject *_filter);
    virtual ~JSNodeFilter();

    virtual bool  isJSFilter() const;
    virtual short acceptNode(const DOM::Node &n, void *&bindingsException);

    void mark();

    JSObject *filter() const
    {
        return m_filter;
    }

    // Extracts a JSNodeFilter contained insode a DOM::NodeFilterImpl,
    // if any (or returns 0);
    static JSNodeFilter *fromDOMFilter(DOM::NodeFilterImpl *nf);
protected:
    // The filter here can be either a function or
    // an object with the acceptNode property. We will use either one.

    // Memory management note: we expect the wrapper object to mark us.
    JSObject *m_filter;
};

} // namespace

#endif
