Reviewed by John.
[WebKit-https.git] / WebCore / khtml / html / html_miscimpl.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  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public License
18  * along with this library; see the file COPYING.LIB.  If not, write to
19  * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20  * Boston, MA 02111-1307, USA.
21  *
22  */
23 #ifndef HTML_MISCIMPL_H
24 #define HTML_MISCIMPL_H
25
26 #include "html_elementimpl.h"
27 #include "misc/shared.h"
28 #include <qdict.h>
29 #include <qptrvector.h>
30
31 namespace DOM {
32
33 class Node;
34 class DOMString;
35 class HTMLCollection;
36
37 class HTMLBaseFontElementImpl : public HTMLElementImpl
38 {
39 public:
40     HTMLBaseFontElementImpl(DocumentPtr *doc);
41
42     ~HTMLBaseFontElementImpl();
43
44     virtual Id id() const;
45 };
46
47 // -------------------------------------------------------------------------
48
49 class HTMLCollectionImpl : public khtml::Shared<HTMLCollectionImpl>
50 {
51     friend class DOM::HTMLCollection;
52 public:
53     enum Type {
54         // from HTMLDocument
55         DOC_IMAGES = 0, // all IMG elements in the document
56         DOC_APPLETS,   // all OBJECT and APPLET elements
57         DOC_EMBEDS,    // all EMBED elements
58         DOC_OBJECTS,   // all OBJECT elements
59         DOC_FORMS,     // all FORMS
60         DOC_LINKS,     // all A _and_ AREA elements with a value for href
61         DOC_ANCHORS,      // all A elements with a value for name
62         // from HTMLTable, HTMLTableSection, HTMLTableRow
63         TABLE_ROWS,    // all rows in this table or tablesection
64         TABLE_TBODIES, // all TBODY elements in this table
65         TSECTION_ROWS, // all rows elements in this table section
66         TR_CELLS,      // all CELLS in this row
67         // from SELECT
68         SELECT_OPTIONS,
69         // from HTMLMap
70         MAP_AREAS,
71         DOC_ALL,        // "all" elements (IE)
72         NODE_CHILDREN,   // first-level children (IE)
73         DOC_NAMEABLE_ITEMS, // all IMG, FORM, APPLET, EMBED and OBJECT elements, used to look
74                             // up element name as document property
75         LAST_TYPE
76     };
77
78     HTMLCollectionImpl(NodeImpl *_base, int _tagId);
79     virtual ~HTMLCollectionImpl();
80     
81     unsigned long length() const;
82     
83     virtual NodeImpl *item ( unsigned long index ) const;
84     virtual NodeImpl *firstItem() const;
85     virtual NodeImpl *nextItem() const;
86
87     virtual NodeImpl *namedItem ( const DOMString &name, bool caseSensitive = true ) const;
88     // In case of multiple items named the same way
89     virtual NodeImpl *nextNamedItem( const DOMString &name ) const;
90
91     QValueList<Node> namedItems( const DOMString &name ) const;
92
93     struct CollectionInfo {
94         CollectionInfo();
95         void reset();
96         unsigned int version;
97         NodeImpl *current;
98         unsigned int position;
99         unsigned int length;
100         bool haslength;
101         int elementsArrayPosition;
102         QDict<QPtrVector<NodeImpl> > idCache;
103         QDict<QPtrVector<NodeImpl> > nameCache;
104         bool hasNameCache;
105      };
106
107 protected:
108     virtual void updateNameCache() const;
109
110     virtual NodeImpl *traverseNextItem(NodeImpl *start) const;
111     bool checkForNameMatch(NodeImpl *node, bool checkName, const DOMString &name, bool caseSensitive) const;
112     virtual unsigned long calcLength() const;
113     virtual void resetCollectionInfo() const;
114     // the base node, the collection refers to
115     NodeImpl *base;
116     // The collection list the following elements
117     int type;
118     mutable CollectionInfo *info;
119
120     // For nextNamedItem()
121     mutable bool idsDone;
122 };
123
124 // this whole class is just a big hack to find form elements even in
125 // malformed HTML elements
126 // the famous <table><tr><form><td> problem
127 class HTMLFormCollectionImpl : public HTMLCollectionImpl
128 {
129 public:
130     // base must inherit HTMLGenericFormElementImpl or this won't work
131     HTMLFormCollectionImpl(NodeImpl* _base);
132     ~HTMLFormCollectionImpl();
133
134     virtual NodeImpl *item ( unsigned long index ) const;
135     virtual NodeImpl *firstItem() const;
136     virtual NodeImpl *nextItem() const;
137
138     virtual NodeImpl *namedItem ( const DOMString &name, bool caseSensitive = true ) const;
139     virtual NodeImpl *nextNamedItem( const DOMString &name ) const;
140
141 protected:
142     virtual void updateNameCache() const;
143     virtual unsigned long calcLength() const;
144     virtual NodeImpl *getNamedItem(NodeImpl* current, int attr_id, const DOMString& name, bool caseSensitive) const;
145     virtual NodeImpl *nextNamedItemInternal( const DOMString &name ) const;
146 private:
147     NodeImpl* getNamedFormItem(int attr_id, const DOMString& name, int duplicateNumber, bool caseSensitive) const;
148     mutable int currentPos;
149 };
150
151
152 }; //namespace
153
154 #endif