LayoutTests:
[WebKit-https.git] / WebCore / html / HTMLCollection.h
1 /*
2  * This file is part of the DOM implementation for KDE.
3  *
4  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
5  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
6  * Copyright (C) 2003, 2004, 2005, 2006 Apple Computer, Inc.
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public License
19  * along with this library; see the file COPYING.LIB.  If not, write to
20  * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21  * Boston, MA 02111-1307, USA.
22  *
23  */
24
25 #ifndef HTMLCollection_h
26 #define HTMLCollection_h
27
28 #include "Shared.h"
29 #include <wtf/Forward.h>
30 #include <wtf/HashMap.h>
31 #include <wtf/Vector.h>
32
33 namespace WebCore {
34
35 class AtomicString;
36 class AtomicStringImpl;
37 class Node;
38 class NodeList;
39 class String;
40
41 class HTMLCollection : public Shared<HTMLCollection> {
42 public:
43     enum Type {
44         // from JSHTMLDocument
45         DocImages = 0, // all IMG elements in the document
46         DocApplets,   // all OBJECT and APPLET elements
47         DocEmbeds,    // all EMBED elements
48         DocObjects,   // all OBJECT elements
49         DocForms,     // all FORMS
50         DocLinks,     // all A _and_ AREA elements with a value for href
51         DocAnchors,      // all A elements with a value for name
52         DocScripts,   // all SCRIPT element
53         // from HTMLTable, HTMLTableSection, HTMLTableRow
54         TableRows,    // all rows in this table or tablesection
55         TableTBodies, // all TBODY elements in this table
56         TSectionRows, // all rows elements in this table section
57         TRCells,      // all CELLS in this row
58         // from SELECT
59         SelectOptions,
60         // from HTMLMap
61         MapAreas,
62         DocAll,        // "all" elements (IE)
63         NodeChildren,   // first-level children (IE)
64         WindowNamedItems,
65         DocumentNamedItems
66     };
67
68     enum {
69         UnnamedCollectionTypes = NodeChildren + 1,
70         CollectionTypes = DocumentNamedItems + 1
71     };
72
73     HTMLCollection(Node *_base, HTMLCollection::Type _type);
74     virtual ~HTMLCollection();
75     
76     unsigned length() const;
77     
78     virtual Node *item(unsigned index) const;
79     virtual Node *firstItem() const;
80     virtual Node *nextItem() const;
81
82     virtual Node *namedItem(const String &name, bool caseSensitive = true) const;
83     // In case of multiple items named the same way
84     virtual Node *nextNamedItem(const String &name) const;
85
86     // Extension
87     PassRefPtr<NodeList> tags(const String&);
88
89     void namedItems(const AtomicString &name, Vector<RefPtr<Node> >&) const;
90
91     Node *base() { return m_base.get(); }
92
93     struct CollectionInfo {
94         CollectionInfo();
95         ~CollectionInfo();
96         void reset();
97         unsigned int version;
98         Node *current;
99         unsigned int position;
100         unsigned int length;
101         int elementsArrayPosition;
102         HashMap<AtomicStringImpl*, Vector<Node*>*> idCache;
103         HashMap<AtomicStringImpl*, Vector<Node*>*> nameCache;
104         bool haslength;
105         bool hasNameCache;
106     };
107
108     Type collectionType() const { return type; }
109
110 protected:
111     virtual void updateNameCache() const;
112
113     virtual Node *traverseNextItem(Node *start) const;
114     bool checkForNameMatch(Node *node, bool checkName, const String &name, bool caseSensitive) const;
115     virtual unsigned calcLength() const;
116     virtual void resetCollectionInfo() const;
117     // the base node, the collection refers to
118     RefPtr<Node> m_base;
119     // The collection list the following elements
120     Type type;
121     mutable CollectionInfo *info;
122
123     // For nextNamedItem()
124     mutable bool idsDone;
125
126     mutable bool m_ownsInfo;
127 };
128
129 } //namespace
130
131 #endif