WebCore/html/HTMLCollection.h

/*
 * This file is part of the DOM implementation for KDE.
 *
 * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
 *           (C) 1999 Antti Koivisto (koivisto@kde.org)
 * Copyright (C) 2003, 2004, 2005, 2006 Apple Computer, Inc.
 *
 * 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; see the file COPYING.LIB.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 *
 */

#ifndef HTMLCollection_h
#define HTMLCollection_h

#include "Shared.h"
#include <wtf/Forward.h>
#include <wtf/HashMap.h>
#include <wtf/Vector.h>

namespace WebCore {

class AtomicString;
class AtomicStringImpl;
class Node;
class NodeList;
class String;

class HTMLCollection : public Shared<HTMLCollection> {
public:
    enum Type {
        // from JSHTMLDocument
        DocImages = 0, // all IMG elements in the document
        DocApplets,   // all OBJECT and APPLET elements
        DocEmbeds,    // all EMBED elements
        DocObjects,   // all OBJECT elements
        DocForms,     // all FORMS
        DocLinks,     // all A _and_ AREA elements with a value for href
        DocAnchors,      // all A elements with a value for name
        DocScripts,   // all SCRIPT element
        // from HTMLTable, HTMLTableSection, HTMLTableRow
        TableRows,    // all rows in this table or tablesection
        TableTBodies, // all TBODY elements in this table
        TSectionRows, // all rows elements in this table section
        TRCells,      // all CELLS in this row
        // from SELECT
        SelectOptions,
        // from HTMLMap
        MapAreas,
        DocAll,        // "all" elements (IE)
        NodeChildren,   // first-level children (IE)
        WindowNamedItems,
        DocumentNamedItems
    };

    enum {
        UnnamedCollectionTypes = NodeChildren + 1,
        CollectionTypes = DocumentNamedItems + 1
    };

    HTMLCollection(Node *_base, HTMLCollection::Type _type);
    virtual ~HTMLCollection();
    
    unsigned length() const;
    
    virtual Node *item(unsigned index) const;
    virtual Node *firstItem() const;
    virtual Node *nextItem() const;

    virtual Node *namedItem(const String &name, bool caseSensitive = true) const;
    // In case of multiple items named the same way
    virtual Node *nextNamedItem(const String &name) const;

    // Extension
    PassRefPtr<NodeList> tags(const String&);

    void namedItems(const AtomicString &name, Vector<RefPtr<Node> >&) const;

    Node *base() { return m_base.get(); }

    struct CollectionInfo {
        CollectionInfo();
        CollectionInfo(const CollectionInfo&);
        CollectionInfo& operator=(const CollectionInfo& other)
        {
            CollectionInfo tmp(other);    
            swap(tmp);
            return *this;
        }
        
        ~CollectionInfo();
        void reset();
        void swap(CollectionInfo&);

        unsigned int version;
        Node *current;
        unsigned int position;
        unsigned int length;
        int elementsArrayPosition;
        typedef HashMap<AtomicStringImpl*, Vector<Node*>*> NodeCacheMap;
        NodeCacheMap idCache;
        NodeCacheMap nameCache;
        bool haslength;
        bool hasNameCache;
    private:
        static void copyCacheMap(NodeCacheMap& dest, const NodeCacheMap& src)
        {
            ASSERT(dest.isEmpty());
            NodeCacheMap::const_iterator end = src.end();
            for (NodeCacheMap::const_iterator it = src.begin(); it != end; ++it)
                dest.add(it->first, new Vector<Node*>(*it->second));
        }
    };

    Type collectionType() const { return type; }

protected:
    virtual void updateNameCache() const;

    virtual Node *traverseNextItem(Node *start) const;
    bool checkForNameMatch(Node *node, bool checkName, const String &name, bool caseSensitive) const;
    virtual unsigned calcLength() const;
    virtual void resetCollectionInfo() const;
    // the base node, the collection refers to
    RefPtr<Node> m_base;
    // The collection list the following elements
    Type type;
    mutable CollectionInfo *info;

    // For nextNamedItem()
    mutable bool idsDone;

    mutable bool m_ownsInfo;
};

} //namespace

#endif