2008-09-04 Tor Arne Vestbø <tavestbo@trolltech.com>
[WebKit-https.git] / WebCore / dom / Document.h
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  *           (C) 2001 Dirk Mueller (mueller@kde.org)
5  *           (C) 2006 Alexey Proskuryakov (ap@webkit.org)
6  * Copyright (C) 2004, 2005, 2006, 2007, 2008 Apple Inc. All rights reserved.
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., 51 Franklin Street, Fifth Floor,
21  * Boston, MA 02110-1301, USA.
22  *
23  */
24
25 #ifndef Document_h
26 #define Document_h
27
28 #include "Attr.h"
29 #include "Color.h"
30 #include "DeprecatedPtrList.h"
31 #include "DocumentMarker.h"
32 #include "HTMLCollection.h"
33 #include "HTMLFormElement.h"
34 #include "KURL.h"
35 #include "StringHash.h"
36 #include "Timer.h"
37 #include <wtf/HashCountedSet.h>
38 #include <wtf/ListHashSet.h>
39
40 // FIXME: We should move Mac off of the old Frame-based user stylesheet loading
41 // code and onto the new code in Page. We can't do that until the code in Page
42 // supports non-file: URLs, however.
43 #if PLATFORM(MAC) || PLATFORM(QT)
44 #define FRAME_LOADS_USER_STYLESHEET 1
45 #else
46 #define FRAME_LOADS_USER_STYLESHEET 0
47 #endif
48
49 namespace WebCore {
50
51     class AXObjectCache;
52     class Attr;
53     class Attribute;
54     class CDATASection;
55     class CachedCSSStyleSheet;
56     class CanvasRenderingContext2D;
57     class CharacterData;
58     class CSSStyleDeclaration;
59     class CSSStyleSelector;
60     class CSSStyleSheet;
61     class Comment;
62     class Database;
63     class DOMImplementation;
64     class DOMSelection;
65     class DOMWindow;
66     class DatabaseThread;
67     class DocLoader;
68     class DocumentFragment;
69     class DocumentType;
70     class EditingText;
71     class Element;
72     class EntityReference;
73     class Event;
74     class EventListener;
75     class Frame;
76     class FrameView;
77     class HTMLCanvasElement;
78     class HTMLDocument;
79     class HTMLElement;
80     class HTMLFormControlElementWithState;
81     class HTMLFormElement;
82     class HTMLHeadElement;
83     class HTMLImageLoader;
84     class HTMLInputElement;
85     class HTMLMapElement;
86     class IntPoint;
87     class JSNode;
88     class MouseEventWithHitTestResults;
89     class NodeFilter;
90     class NodeIterator;
91     class Page;
92     class PlatformMouseEvent;
93     class ProcessingInstruction;
94     class Range;
95     class RegisteredEventListener;
96     class RenderArena;
97     class SecurityOrigin;
98     class Settings;
99     class StyleSheet;
100     class StyleSheetList;
101     class Text;
102     class TextResourceDecoder;
103     class Tokenizer;
104     class TreeWalker;
105
106 #if ENABLE(SVG)
107     class SVGDocumentExtensions;
108 #endif
109     
110 #if ENABLE(XBL)
111     class XBLBindingManager;
112 #endif
113
114 #if ENABLE(XPATH)
115     class XPathEvaluator;
116     class XPathExpression;
117     class XPathNSResolver;
118     class XPathResult;
119 #endif
120
121 #if ENABLE(DASHBOARD_SUPPORT)
122     struct DashboardRegionValue;
123 #endif
124     struct HitTestRequest;
125
126     typedef int ExceptionCode;
127
128 class FormElementKey {
129 public:
130     FormElementKey(AtomicStringImpl* = 0, AtomicStringImpl* = 0);
131     ~FormElementKey();
132     FormElementKey(const FormElementKey&);
133     FormElementKey& operator=(const FormElementKey&);
134
135     AtomicStringImpl* name() const { return m_name; }
136     AtomicStringImpl* type() const { return m_type; }
137
138     // Hash table deleted values, which are only constructed and never copied or destroyed.
139     FormElementKey(WTF::HashTableDeletedValueType) : m_name(hashTableDeletedValue()) { }
140     bool isHashTableDeletedValue() const { return m_name == hashTableDeletedValue(); }
141
142 private:
143     void ref() const;
144     void deref() const;
145
146     static AtomicStringImpl* hashTableDeletedValue() { return reinterpret_cast<AtomicStringImpl*>(-1); }
147
148     AtomicStringImpl* m_name;
149     AtomicStringImpl* m_type;
150 };
151
152 inline bool operator==(const FormElementKey& a, const FormElementKey& b)
153 {
154     return a.name() == b.name() && a.type() == b.type();
155 }
156
157 struct FormElementKeyHash {
158     static unsigned hash(const FormElementKey&);
159     static bool equal(const FormElementKey& a, const FormElementKey& b) { return a == b; }
160     static const bool safeToCompareToEmptyOrDeleted = true;
161 };
162
163 struct FormElementKeyHashTraits : WTF::GenericHashTraits<FormElementKey> {
164     static void constructDeletedValue(FormElementKey& slot) { new (&slot) FormElementKey(WTF::HashTableDeletedValue); }
165     static bool isDeletedValue(const FormElementKey& value) { return value.isHashTableDeletedValue(); }
166 };
167
168 class Document : public ContainerNode {
169 public:
170     static PassRefPtr<Document> create(Frame* frame)
171     {
172         return new Document(frame, false);
173     }
174     static PassRefPtr<Document> createXHTML(Frame* frame)
175     {
176         return new Document(frame, true);
177     }
178     virtual ~Document();
179
180     virtual void removedLastRef();
181
182     // Nodes belonging to this document hold "self-only" references -
183     // these are enough to keep the document from being destroyed, but
184     // not enough to keep it from removing its children. This allows a
185     // node that outlives its document to still have a valid document
186     // pointer without introducing reference cycles
187
188     void selfOnlyRef()
189     {
190         ASSERT(!m_deletionHasBegun);
191         ++m_selfOnlyRefCount;
192     }
193     void selfOnlyDeref()
194     {
195         ASSERT(!m_deletionHasBegun);
196         --m_selfOnlyRefCount;
197         if (!m_selfOnlyRefCount && !refCount()) {
198 #ifndef NDEBUG
199             m_deletionHasBegun = true;
200 #endif
201             delete this;
202         }
203     }
204
205     // DOM methods & attributes for Document
206
207     DocumentType* doctype() const { return m_docType.get(); }
208
209     DOMImplementation* implementation() const;
210     virtual void childrenChanged(bool changedByParser = false, Node* beforeChange = 0, Node* afterChange = 0, int childCountDelta = 0);
211     Element* documentElement() const;
212     virtual PassRefPtr<Element> createElement(const AtomicString& tagName, ExceptionCode&);
213     PassRefPtr<DocumentFragment> createDocumentFragment ();
214     PassRefPtr<Text> createTextNode(const String& data);
215     PassRefPtr<Comment> createComment(const String& data);
216     PassRefPtr<CDATASection> createCDATASection(const String& data, ExceptionCode&);
217     PassRefPtr<ProcessingInstruction> createProcessingInstruction(const String& target, const String& data, ExceptionCode&);
218     PassRefPtr<Attr> createAttribute(const String& name, ExceptionCode& ec) { return createAttributeNS(String(), name, ec, true); }
219     PassRefPtr<Attr> createAttributeNS(const String& namespaceURI, const String& qualifiedName, ExceptionCode&, bool shouldIgnoreNamespaceChecks = false);
220     PassRefPtr<EntityReference> createEntityReference(const String& name, ExceptionCode&);
221     PassRefPtr<Node> importNode(Node* importedNode, bool deep, ExceptionCode&);
222     virtual PassRefPtr<Element> createElementNS(const String& namespaceURI, const String& qualifiedName, ExceptionCode&);
223     PassRefPtr<Element> createElement(const QualifiedName&, bool createdByParser, ExceptionCode& ec);
224     Element* getElementById(const AtomicString&) const;
225     bool hasElementWithId(AtomicStringImpl* id) const;
226     bool containsMultipleElementsWithId(const AtomicString& elementId) { return m_duplicateIds.contains(elementId.impl()); }
227
228     Element* elementFromPoint(int x, int y) const;
229     String readyState() const;
230     String inputEncoding() const;
231     String defaultCharset() const;
232
233     String charset() const { return inputEncoding(); }
234     String characterSet() const { return inputEncoding(); }
235
236     void setCharset(const String&);
237
238     String contentLanguage() const { return m_contentLanguage; }
239     void setContentLanguage(const String& lang) { m_contentLanguage = lang; }
240
241     String xmlEncoding() const { return m_xmlEncoding; }
242     String xmlVersion() const { return m_xmlVersion; }
243     bool xmlStandalone() const { return m_xmlStandalone; }
244
245     void setXMLEncoding(const String& encoding) { m_xmlEncoding = encoding; } // read-only property, only to be set from XMLTokenizer
246     void setXMLVersion(const String&, ExceptionCode&);
247     void setXMLStandalone(bool, ExceptionCode&);
248
249     String documentURI() const { return m_documentURI; }
250     void setDocumentURI(const String&);
251
252     virtual KURL baseURI() const;
253
254     PassRefPtr<Node> adoptNode(PassRefPtr<Node> source, ExceptionCode&);
255
256     PassRefPtr<HTMLCollection> images();
257     PassRefPtr<HTMLCollection> embeds();
258     PassRefPtr<HTMLCollection> plugins(); // an alias for embeds() required for the JS DOM bindings.
259     PassRefPtr<HTMLCollection> applets();
260     PassRefPtr<HTMLCollection> links();
261     PassRefPtr<HTMLCollection> forms();
262     PassRefPtr<HTMLCollection> anchors();
263     PassRefPtr<HTMLCollection> all();
264     PassRefPtr<HTMLCollection> objects();
265     PassRefPtr<HTMLCollection> scripts();
266     PassRefPtr<HTMLCollection> windowNamedItems(const String& name);
267     PassRefPtr<HTMLCollection> documentNamedItems(const String& name);
268
269     HTMLCollection::CollectionInfo* collectionInfo(HTMLCollection::Type type)
270     {
271         ASSERT(type >= HTMLCollection::FirstUnnamedDocumentCachedType);
272         unsigned index = type - HTMLCollection::FirstUnnamedDocumentCachedType;
273         ASSERT(index < HTMLCollection::NumUnnamedDocumentCachedTypes);
274         return &m_collectionInfo[index]; 
275     }
276
277     HTMLCollection::CollectionInfo* nameCollectionInfo(HTMLCollection::Type, const AtomicString& name);
278
279     // DOM methods overridden from  parent classes
280
281     virtual String nodeName() const;
282     virtual NodeType nodeType() const;
283
284     // Other methods (not part of DOM)
285     virtual bool isDocumentNode() const { return true; }
286     virtual bool isHTMLDocument() const { return false; }
287     virtual bool isImageDocument() const { return false; }
288 #if ENABLE(SVG)
289     virtual bool isSVGDocument() const { return false; }
290 #endif
291     virtual bool isPluginDocument() const { return false; }
292     virtual bool isMediaDocument() const { return false; }
293     
294     CSSStyleSelector* styleSelector() const { return m_styleSelector; }
295
296     Element* getElementByAccessKey(const String& key) const;
297     
298     /**
299      * Updates the pending sheet count and then calls updateStyleSelector.
300      */
301     void removePendingSheet();
302
303     /**
304      * This method returns true if all top-level stylesheets have loaded (including
305      * any @imports that they may be loading).
306      */
307     bool haveStylesheetsLoaded() const
308     {
309         return m_pendingStylesheets <= 0 || m_ignorePendingStylesheets
310 #if USE(LOW_BANDWIDTH_DISPLAY)
311             || m_inLowBandwidthDisplay
312 #endif
313             ;
314     }
315
316     /**
317      * Increments the number of pending sheets.  The <link> elements
318      * invoke this to add themselves to the loading list.
319      */
320     void addPendingSheet() { m_pendingStylesheets++; }
321
322     void addStyleSheetCandidateNode(Node*, bool createdByParser);
323     void removeStyleSheetCandidateNode(Node*);
324
325     bool gotoAnchorNeededAfterStylesheetsLoad() { return m_gotoAnchorNeededAfterStylesheetsLoad; }
326     void setGotoAnchorNeededAfterStylesheetsLoad(bool b) { m_gotoAnchorNeededAfterStylesheetsLoad = b; }
327
328     /**
329      * Called when one or more stylesheets in the document may have been added, removed or changed.
330      *
331      * Creates a new style selector and assign it to this document. This is done by iterating through all nodes in
332      * document (or those before <BODY> in a HTML document), searching for stylesheets. Stylesheets can be contained in
333      * <LINK>, <STYLE> or <BODY> elements, as well as processing instructions (XML documents only). A list is
334      * constructed from these which is used to create the a new style selector which collates all of the stylesheets
335      * found and is used to calculate the derived styles for all rendering objects.
336      */
337     void updateStyleSelector();
338
339     void recalcStyleSelector();
340
341     bool usesDescendantRules() const { return m_usesDescendantRules; }
342     void setUsesDescendantRules(bool b) { m_usesDescendantRules = b; }
343     bool usesSiblingRules() const { return m_usesSiblingRules; }
344     void setUsesSiblingRules(bool b) { m_usesSiblingRules = b; }
345     bool usesFirstLineRules() const { return m_usesFirstLineRules; }
346     void setUsesFirstLineRules(bool b) { m_usesFirstLineRules = b; }
347     bool usesFirstLetterRules() const { return m_usesFirstLetterRules; }
348     void setUsesFirstLetterRules(bool b) { m_usesFirstLetterRules = b; }
349
350     // Machinery for saving and restoring state when you leave and then go back to a page.
351     void registerFormElementWithState(HTMLFormControlElementWithState* e) { m_formElementsWithState.add(e); }
352     void unregisterFormElementWithState(HTMLFormControlElementWithState* e) { m_formElementsWithState.remove(e); }
353     Vector<String> formElementsState() const;
354     void setStateForNewFormElements(const Vector<String>&);
355     bool hasStateForNewFormElements() const;
356     bool takeStateForFormElement(AtomicStringImpl* name, AtomicStringImpl* type, String& state);
357
358     FrameView* view() const; // can be NULL
359     Frame* frame() const { return m_frame; } // can be NULL
360     Page* page() const; // can be NULL
361     Settings* settings() const; // can be NULL
362
363     PassRefPtr<Range> createRange();
364
365     PassRefPtr<NodeIterator> createNodeIterator(Node* root, unsigned whatToShow,
366         PassRefPtr<NodeFilter>, bool expandEntityReferences, ExceptionCode&);
367
368     PassRefPtr<TreeWalker> createTreeWalker(Node* root, unsigned whatToShow, 
369         PassRefPtr<NodeFilter>, bool expandEntityReferences, ExceptionCode&);
370
371     // Special support for editing
372     PassRefPtr<CSSStyleDeclaration> createCSSStyleDeclaration();
373     PassRefPtr<EditingText> createEditingTextNode(const String&);
374
375     virtual void recalcStyle( StyleChange = NoChange );
376     virtual void updateRendering();
377     void updateLayout();
378     void updateLayoutIgnorePendingStylesheets();
379     static void updateDocumentsRendering();
380     DocLoader* docLoader() { return m_docLoader; }
381
382     virtual void attach();
383     virtual void detach();
384
385     void clearFramePointer();
386
387     RenderArena* renderArena() { return m_renderArena; }
388
389     void clearAXObjectCache();
390     AXObjectCache* axObjectCache() const;
391     
392     // to get visually ordered hebrew and arabic pages right
393     void setVisuallyOrdered();
394
395     void open(Document* ownerDocument = 0);
396     void implicitOpen();
397     void close();
398     void implicitClose();
399     void cancelParsing();
400
401     void write(const String& text, Document* ownerDocument = 0);
402     void writeln(const String& text, Document* ownerDocument = 0);
403     void finishParsing();
404     void clear();
405
406     bool wellFormed() const { return m_wellFormed; }
407
408     const KURL& url() const { return m_url; }
409     void setURL(const KURL&);
410
411     const KURL& baseURL() const { return m_baseURL; }
412     // Setting the BaseElementURL will change the baseURL.
413     void setBaseElementURL(const KURL&);
414
415     const String& baseTarget() const { return m_baseTarget; }
416     // Setting the BaseElementTarget will change the baseTarget.
417     void setBaseElementTarget(const String& baseTarget) { m_baseTarget = baseTarget; }
418
419     KURL completeURL(const String&) const;
420
421     unsigned visitedLinkHash(const AtomicString& attributeURL) const;
422
423     // from cachedObjectClient
424     virtual void setCSSStyleSheet(const String& url, const String& charset, const CachedCSSStyleSheet*);
425
426 #if FRAME_LOADS_USER_STYLESHEET
427     void setUserStyleSheet(const String& sheet);
428 #endif
429
430     String userStyleSheet() const;
431
432     CSSStyleSheet* elementSheet();
433     CSSStyleSheet* mappedElementSheet();
434     virtual Tokenizer* createTokenizer();
435     Tokenizer* tokenizer() { return m_tokenizer; }
436     
437     bool printing() const { return m_printing; }
438     void setPrinting(bool p) { m_printing = p; }
439
440     enum ParseMode { Compat, AlmostStrict, Strict };
441
442 private:
443     virtual void determineParseMode() {}
444     
445 public:
446     void setParseMode(ParseMode m) { m_parseMode = m; }
447     ParseMode parseMode() const { return m_parseMode; }
448
449     bool inCompatMode() const { return m_parseMode == Compat; }
450     bool inAlmostStrictMode() const { return m_parseMode == AlmostStrict; }
451     bool inStrictMode() const { return m_parseMode == Strict; }
452     
453     void setParsing(bool);
454     bool parsing() const { return m_bParsing; }
455     int minimumLayoutDelay();
456     bool shouldScheduleLayout();
457     int elapsedTime() const;
458     
459     void setTextColor(const Color& color) { m_textColor = color; }
460     Color textColor() const { return m_textColor; }
461
462     const Color& linkColor() const { return m_linkColor; }
463     const Color& visitedLinkColor() const { return m_visitedLinkColor; }
464     const Color& activeLinkColor() const { return m_activeLinkColor; }
465     void setLinkColor(const Color& c) { m_linkColor = c; }
466     void setVisitedLinkColor(const Color& c) { m_visitedLinkColor = c; }
467     void setActiveLinkColor(const Color& c) { m_activeLinkColor = c; }
468     void resetLinkColor();
469     void resetVisitedLinkColor();
470     void resetActiveLinkColor();
471     
472     MouseEventWithHitTestResults prepareMouseEvent(const HitTestRequest&, const IntPoint&, const PlatformMouseEvent&);
473
474     virtual bool childTypeAllowed(NodeType);
475     virtual PassRefPtr<Node> cloneNode(bool deep);
476
477     virtual bool canReplaceChild(Node* newChild, Node* oldChild);
478     
479     StyleSheetList* styleSheets();
480
481     /* Newly proposed CSS3 mechanism for selecting alternate
482        stylesheets using the DOM. May be subject to change as
483        spec matures. - dwh
484     */
485     String preferredStylesheetSet() const;
486     String selectedStylesheetSet() const;
487     void setSelectedStylesheetSet(const String&);
488
489     bool setFocusedNode(PassRefPtr<Node>);
490     Node* focusedNode() const { return m_focusedNode.get(); }
491
492     // The m_ignoreAutofocus flag specifies whether or not the document has been changed by the user enough 
493     // for WebCore to ignore the autofocus attribute on any form controls
494     bool ignoreAutofocus() const { return m_ignoreAutofocus; };
495     void setIgnoreAutofocus(bool shouldIgnore = true) { m_ignoreAutofocus = shouldIgnore; };
496
497     void setHoverNode(PassRefPtr<Node>);
498     Node* hoverNode() const { return m_hoverNode.get(); }
499
500     void setActiveNode(PassRefPtr<Node>);
501     Node* activeNode() const { return m_activeNode.get(); }
502
503     void focusedNodeRemoved();
504     void removeFocusedNodeOfSubtree(Node*, bool amongChildrenOnly = false);
505     void hoveredNodeDetached(Node*);
506     void activeChainNodeDetached(Node*);
507
508     // Updates for :target (CSS3 selector).
509     void setCSSTarget(Node*);
510     Node* getCSSTarget() const;
511     
512     void setDocumentChanged(bool);
513
514     void attachNodeIterator(NodeIterator*);
515     void detachNodeIterator(NodeIterator*);
516
517     void attachRange(Range*);
518     void detachRange(Range*);
519
520     void nodeChildrenChanged(ContainerNode*);
521     void nodeWillBeRemoved(Node*);
522
523     void textInserted(Node*, unsigned offset, unsigned length);
524     void textRemoved(Node*, unsigned offset, unsigned length);
525     void textNodesMerged(Text* oldNode, unsigned offset);
526     void textNodeSplit(Text* oldNode);
527
528     DOMWindow* defaultView() const { return domWindow(); } 
529     DOMWindow* domWindow() const;
530
531     PassRefPtr<Event> createEvent(const String& eventType, ExceptionCode&);
532
533     // keep track of what types of event listeners are registered, so we don't
534     // dispatch events unnecessarily
535     enum ListenerType {
536         DOMSUBTREEMODIFIED_LISTENER          = 0x01,
537         DOMNODEINSERTED_LISTENER             = 0x02,
538         DOMNODEREMOVED_LISTENER              = 0x04,
539         DOMNODEREMOVEDFROMDOCUMENT_LISTENER  = 0x08,
540         DOMNODEINSERTEDINTODOCUMENT_LISTENER = 0x10,
541         DOMATTRMODIFIED_LISTENER             = 0x20,
542         DOMCHARACTERDATAMODIFIED_LISTENER    = 0x40,
543         OVERFLOWCHANGED_LISTENER             = 0x80,
544         ANIMATIONEND_LISTENER                = 0x100,
545         ANIMATIONSTART_LISTENER              = 0x200,
546         ANIMATIONITERATION_LISTENER          = 0x400,
547         TRANSITIONEND_LISTENER               = 0x800
548     };
549
550     bool hasListenerType(ListenerType listenerType) const { return (m_listenerTypes & listenerType); }
551     void addListenerType(ListenerType listenerType) { m_listenerTypes = m_listenerTypes | listenerType; }
552
553     CSSStyleDeclaration* getOverrideStyle(Element*, const String& pseudoElt);
554
555     void handleWindowEvent(Event*, bool useCapture);
556     void setHTMLWindowEventListener(const AtomicString &eventType, PassRefPtr<EventListener>);
557     EventListener* getHTMLWindowEventListener(const AtomicString &eventType);
558     void removeHTMLWindowEventListener(const AtomicString &eventType);
559
560     void setHTMLWindowEventListener(const AtomicString& eventType, Attribute*);
561
562     void addWindowEventListener(const AtomicString& eventType, PassRefPtr<EventListener>, bool useCapture);
563     void removeWindowEventListener(const AtomicString& eventType, EventListener*, bool useCapture);
564     bool hasWindowEventListener(const AtomicString& eventType);
565     
566     void addPendingFrameUnloadEventCount();
567     void removePendingFrameUnloadEventCount();
568     void addPendingFrameBeforeUnloadEventCount();
569     void removePendingFrameBeforeUnloadEventCount();
570
571     PassRefPtr<EventListener> createHTMLEventListener(const String& functionName, const String& code, Node*);
572     
573     /**
574      * Searches through the document, starting from fromNode, for the next selectable element that comes after fromNode.
575      * The order followed is as specified in section 17.11.1 of the HTML4 spec, which is elements with tab indexes
576      * first (from lowest to highest), and then elements without tab indexes (in document order).
577      *
578      * @param fromNode The node from which to start searching. The node after this will be focused. May be null.
579      *
580      * @return The focus node that comes after fromNode
581      *
582      * See http://www.w3.org/TR/html4/interact/forms.html#h-17.11.1
583      */
584     Node* nextFocusableNode(Node* start, KeyboardEvent*);
585
586     /**
587      * Searches through the document, starting from fromNode, for the previous selectable element (that comes _before_)
588      * fromNode. The order followed is as specified in section 17.11.1 of the HTML4 spec, which is elements with tab
589      * indexes first (from lowest to highest), and then elements without tab indexes (in document order).
590      *
591      * @param fromNode The node from which to start searching. The node before this will be focused. May be null.
592      *
593      * @return The focus node that comes before fromNode
594      *
595      * See http://www.w3.org/TR/html4/interact/forms.html#h-17.11.1
596      */
597     Node* previousFocusableNode(Node* start, KeyboardEvent*);
598
599     int nodeAbsIndex(Node*);
600     Node* nodeWithAbsIndex(int absIndex);
601
602     /**
603      * Handles a HTTP header equivalent set by a meta tag using <meta http-equiv="..." content="...">. This is called
604      * when a meta tag is encountered during document parsing, and also when a script dynamically changes or adds a meta
605      * tag. This enables scripts to use meta tags to perform refreshes and set expiry dates in addition to them being
606      * specified in a HTML file.
607      *
608      * @param equiv The http header name (value of the meta tag's "equiv" attribute)
609      * @param content The header value (value of the meta tag's "content" attribute)
610      */
611     void processHttpEquiv(const String& equiv, const String& content);
612     
613     void dispatchImageLoadEventSoon(HTMLImageLoader*);
614     void dispatchImageLoadEventsNow();
615     void removeImage(HTMLImageLoader*);
616     
617     // Returns the owning element in the parent document.
618     // Returns 0 if this is the top level document.
619     Element* ownerElement() const;
620
621     String title() const { return m_title; }
622     void setTitle(const String&, Element* titleElement = 0);
623     void removeTitle(Element* titleElement);
624
625     String cookie() const;
626     void setCookie(const String&);
627
628     String referrer() const;
629
630     String domain() const;
631     void setDomain(const String& newDomain);
632
633     String lastModified() const;
634
635     const KURL& cookieURL() const { return m_cookieURL; }
636
637     const KURL& policyBaseURL() const { return m_policyBaseURL; }
638     void setPolicyBaseURL(const KURL& url) { m_policyBaseURL = url; }
639     
640     // The following implements the rule from HTML 4 for what valid names are.
641     // To get this right for all the XML cases, we probably have to improve this or move it
642     // and make it sensitive to the type of document.
643     static bool isValidName(const String&);
644
645     // The following breaks a qualified name into a prefix and a local name.
646     // It also does a validity check, and returns false if the qualified name
647     // is invalid.  It also sets ExceptionCode when name is invalid.
648     static bool parseQualifiedName(const String& qualifiedName, String& prefix, String& localName, ExceptionCode&);
649     
650     // Checks to make sure prefix and namespace do not conflict (per DOM Core 3)
651     static bool hasPrefixNamespaceMismatch(const QualifiedName&);
652     
653     void addElementById(const AtomicString& elementId, Element *element);
654     void removeElementById(const AtomicString& elementId, Element *element);
655
656     void addImageMap(HTMLMapElement*);
657     void removeImageMap(HTMLMapElement*);
658     HTMLMapElement* getImageMap(const String& url) const;
659
660     HTMLElement* body();
661     void setBody(PassRefPtr<HTMLElement>, ExceptionCode&);
662
663     HTMLHeadElement* head();
664
665     bool execCommand(const String& command, bool userInterface = false, const String& value = String());
666     bool queryCommandEnabled(const String& command);
667     bool queryCommandIndeterm(const String& command);
668     bool queryCommandState(const String& command);
669     bool queryCommandSupported(const String& command);
670     String queryCommandValue(const String& command);
671     
672     void addMarker(Range*, DocumentMarker::MarkerType, String description = String());
673     void addMarker(Node*, DocumentMarker);
674     void copyMarkers(Node *srcNode, unsigned startOffset, int length, Node *dstNode, int delta, DocumentMarker::MarkerType = DocumentMarker::AllMarkers);
675     void removeMarkers(Range*, DocumentMarker::MarkerType = DocumentMarker::AllMarkers);
676     void removeMarkers(Node*, unsigned startOffset, int length, DocumentMarker::MarkerType = DocumentMarker::AllMarkers);
677     void removeMarkers(DocumentMarker::MarkerType = DocumentMarker::AllMarkers);
678     void removeMarkers(Node*);
679     void repaintMarkers(DocumentMarker::MarkerType = DocumentMarker::AllMarkers);
680     void setRenderedRectForMarker(Node*, DocumentMarker, const IntRect&);
681     void invalidateRenderedRectsForMarkersInRect(const IntRect&);
682     void shiftMarkers(Node*, unsigned startOffset, int delta, DocumentMarker::MarkerType = DocumentMarker::AllMarkers);
683
684     DocumentMarker* markerContainingPoint(const IntPoint&, DocumentMarker::MarkerType = DocumentMarker::AllMarkers);
685     Vector<DocumentMarker> markersForNode(Node*);
686     Vector<IntRect> renderedRectsForMarkers(DocumentMarker::MarkerType = DocumentMarker::AllMarkers);
687     
688     // designMode support
689     enum InheritedBool { off = false, on = true, inherit };    
690     void setDesignMode(InheritedBool value);
691     InheritedBool getDesignMode() const;
692     bool inDesignMode() const;
693
694     Document* parentDocument() const;
695     Document* topDocument() const;
696
697     int docID() const { return m_docID; }
698
699 #if ENABLE(XSLT)
700     void applyXSLTransform(ProcessingInstruction* pi);
701     void setTransformSource(void* doc);
702     const void* transformSource() { return m_transformSource; }
703     PassRefPtr<Document> transformSourceDocument() { return m_transformSourceDocument; }
704     void setTransformSourceDocument(Document* doc) { m_transformSourceDocument = doc; }
705 #endif
706
707 #if ENABLE(XBL)
708     // XBL methods
709     XBLBindingManager* bindingManager() const { return m_bindingManager; }
710 #endif
711
712     void incDOMTreeVersion() { ++m_domtree_version; }
713     unsigned domTreeVersion() const { return m_domtree_version; }
714
715     void setDocType(PassRefPtr<DocumentType>);
716
717     void finishedParsing();
718
719 #if ENABLE(XPATH)
720     // XPathEvaluator methods
721     PassRefPtr<XPathExpression> createExpression(const String& expression,
722                                                  XPathNSResolver* resolver,
723                                                  ExceptionCode& ec);
724     PassRefPtr<XPathNSResolver> createNSResolver(Node *nodeResolver);
725     PassRefPtr<XPathResult> evaluate(const String& expression,
726                                      Node* contextNode,
727                                      XPathNSResolver* resolver,
728                                      unsigned short type,
729                                      XPathResult* result,
730                                      ExceptionCode& ec);
731 #endif // ENABLE(XPATH)
732     
733     enum PendingSheetLayout { NoLayoutWithPendingSheets, DidLayoutWithPendingSheets, IgnoreLayoutWithPendingSheets };
734
735     bool didLayoutWithPendingStylesheets() const { return m_pendingSheetLayout == DidLayoutWithPendingSheets; }
736     
737     void setHasNodesWithPlaceholderStyle() { m_hasNodesWithPlaceholderStyle = true; }
738
739     const String& iconURL() const { return m_iconURL; }
740     void setIconURL(const String& iconURL, const String& type);
741
742     void setUseSecureKeyboardEntryWhenActive(bool);
743     bool useSecureKeyboardEntryWhenActive() const;
744     
745 #if USE(LOW_BANDWIDTH_DISPLAY)
746     void setDocLoader(DocLoader* loader) { m_docLoader = loader; }
747     bool inLowBandwidthDisplay() const { return m_inLowBandwidthDisplay; }
748     void setLowBandwidthDisplay(bool lowBandWidth) { m_inLowBandwidthDisplay = lowBandWidth; }
749 #endif
750     
751     void addNodeListCache() { ++m_numNodeListCaches; }
752     void removeNodeListCache() { ASSERT(m_numNodeListCaches > 0); --m_numNodeListCaches; }
753     bool hasNodeListCaches() const { return m_numNodeListCaches; }
754
755     void updateFocusAppearanceSoon();
756     void cancelFocusAppearanceUpdate();
757         
758     // FF method for accessing the selection added for compatability.
759     DOMSelection* getSelection() const;
760     
761     // Extension for manipulating canvas drawing contexts for use in CSS
762     CanvasRenderingContext2D* getCSSCanvasContext(const String& type, const String& name, int width, int height);
763     HTMLCanvasElement* getCSSCanvasElement(const String& name);
764     
765 protected:
766     Document(Frame*, bool isXHTML);
767
768 private:
769     CSSStyleSelector* m_styleSelector;
770     bool m_didCalculateStyleSelector;
771
772     Frame* m_frame;
773     DocLoader* m_docLoader;
774     Tokenizer* m_tokenizer;
775     bool m_wellFormed;
776
777     // Document URLs.
778     KURL m_url;  // Document.URL: The URL from which this document was retrieved.
779     KURL m_baseURL;  // Node.baseURI: The URL to use when resolving relative URLs.
780     KURL m_baseElementURL;  // The URL set by the <base> element.
781     KURL m_cookieURL;  // The URL to use for cookie access.
782     KURL m_policyBaseURL;  // The policy URL for third-party cookie blocking.
783
784     // Document.documentURI:
785     // Although URL-like, Document.documentURI can actually be set to any
786     // string by content.  Document.documentURI affects m_baseURL unless the
787     // document contains a <base> element, in which case the <base> element
788     // takes precedence.
789     String m_documentURI;
790
791     String m_baseTarget;
792
793     RefPtr<DocumentType> m_docType;
794     mutable RefPtr<DOMImplementation> m_implementation;
795
796     RefPtr<StyleSheet> m_sheet;
797 #if FRAME_LOADS_USER_STYLESHEET
798     String m_usersheet;
799 #endif
800
801     // Track the number of currently loading top-level stylesheets.  Sheets
802     // loaded using the @import directive are not included in this count.
803     // We use this count of pending sheets to detect when we can begin attaching
804     // elements.
805     int m_pendingStylesheets;
806
807     // But sometimes you need to ignore pending stylesheet count to
808     // force an immediate layout when requested by JS.
809     bool m_ignorePendingStylesheets;
810
811     // If we do ignore the pending stylesheet count, then we need to add a boolean
812     // to track that this happened so that we can do a full repaint when the stylesheets
813     // do eventually load.
814     PendingSheetLayout m_pendingSheetLayout;
815     
816     bool m_hasNodesWithPlaceholderStyle;
817
818     RefPtr<CSSStyleSheet> m_elemSheet;
819     RefPtr<CSSStyleSheet> m_mappedElementSheet;
820
821     bool m_printing;
822     
823     bool m_ignoreAutofocus;
824
825     ParseMode m_parseMode;
826
827     Color m_textColor;
828
829     RefPtr<Node> m_focusedNode;
830     RefPtr<Node> m_hoverNode;
831     RefPtr<Node> m_activeNode;
832     mutable RefPtr<Element> m_documentElement;
833
834     unsigned m_domtree_version;
835     
836     HashSet<NodeIterator*> m_nodeIterators;
837     HashSet<Range*> m_ranges;
838
839     unsigned short m_listenerTypes;
840
841     RefPtr<StyleSheetList> m_styleSheets; // All of the stylesheets that are currently in effect for our media type and stylesheet set.
842     ListHashSet<Node*> m_styleSheetCandidateNodes; // All of the nodes that could potentially provide stylesheets to the document (<link>, <style>, <?xml-stylesheet>)
843
844     RegisteredEventListenerList m_windowEventListeners;
845
846     typedef HashMap<FormElementKey, Vector<String>, FormElementKeyHash, FormElementKeyHashTraits> FormElementStateMap;
847     ListHashSet<HTMLFormControlElementWithState*> m_formElementsWithState;
848     FormElementStateMap m_stateForNewFormElements;
849     
850     Color m_linkColor;
851     Color m_visitedLinkColor;
852     Color m_activeLinkColor;
853
854     String m_preferredStylesheetSet;
855     String m_selectedStylesheetSet;
856
857     bool m_loadingSheet;
858     bool visuallyOrdered;
859     bool m_bParsing;
860     bool m_docChanged;
861     bool m_inStyleRecalc;
862     bool m_closeAfterStyleRecalc;
863     bool m_usesDescendantRules;
864     bool m_usesSiblingRules;
865     bool m_usesFirstLineRules;
866     bool m_usesFirstLetterRules;
867     bool m_gotoAnchorNeededAfterStylesheetsLoad;
868
869     String m_title;
870     bool m_titleSetExplicitly;
871     RefPtr<Element> m_titleElement;
872     
873     RenderArena* m_renderArena;
874
875     typedef std::pair<Vector<DocumentMarker>, Vector<IntRect> > MarkerMapVectorPair;
876     typedef HashMap<RefPtr<Node>, MarkerMapVectorPair*> MarkerMap;
877     MarkerMap m_markers;
878
879     mutable AXObjectCache* m_axObjectCache;
880     
881     DeprecatedPtrList<HTMLImageLoader> m_imageLoadEventDispatchSoonList;
882     DeprecatedPtrList<HTMLImageLoader> m_imageLoadEventDispatchingList;
883     Timer<Document> m_imageLoadEventTimer;
884
885     Timer<Document> m_updateFocusAppearanceTimer;
886
887     Node* m_cssTarget;
888     
889     bool m_processingLoadEvent;
890     double m_startTime;
891     bool m_overMinimumLayoutThreshold;
892     
893 #if ENABLE(XSLT)
894     void* m_transformSource;
895     RefPtr<Document> m_transformSourceDocument;
896 #endif
897
898 #if ENABLE(XBL)
899     XBLBindingManager* m_bindingManager; // The access point through which documents and elements communicate with XBL.
900 #endif
901     
902     typedef HashMap<AtomicStringImpl*, HTMLMapElement*> ImageMapsByName;
903     ImageMapsByName m_imageMapsByName;
904
905     HashSet<Node*> m_disconnectedNodesWithEventListeners;
906
907     int m_docID; // A unique document identifier used for things like document-specific mapped attributes.
908
909     String m_xmlEncoding;
910     String m_xmlVersion;
911     bool m_xmlStandalone;
912
913     String m_contentLanguage;
914
915 public:
916     bool inPageCache();
917     void setInPageCache(bool flag);
918     
919     // Elements can register themselves for the "willSaveToCache()" and  
920     // "didRestoreFromCache()" callbacks
921     void registerForCacheCallbacks(Element*);
922     void unregisterForCacheCallbacks(Element*);
923     void willSaveToCache();
924     void didRestoreFromCache();
925
926     void setShouldCreateRenderers(bool);
927     bool shouldCreateRenderers();
928     
929     void setDecoder(PassRefPtr<TextResourceDecoder>);
930     TextResourceDecoder* decoder() const { return m_decoder.get(); }
931
932     UChar backslashAsCurrencySymbol() const;
933
934 #if ENABLE(DASHBOARD_SUPPORT)
935     void setDashboardRegionsDirty(bool f) { m_dashboardRegionsDirty = f; }
936     bool dashboardRegionsDirty() const { return m_dashboardRegionsDirty; }
937     bool hasDashboardRegions () const { return m_hasDashboardRegions; }
938     void setHasDashboardRegions (bool f) { m_hasDashboardRegions = f; }
939     const Vector<DashboardRegionValue>& dashboardRegions() const;
940     void setDashboardRegions(const Vector<DashboardRegionValue>&);
941 #endif
942
943     void removeAllEventListenersFromAllNodes();
944
945     void registerDisconnectedNodeWithEventListeners(Node*);
946     void unregisterDisconnectedNodeWithEventListeners(Node*);
947     
948     HTMLFormElement::CheckedRadioButtons& checkedRadioButtons() { return m_checkedRadioButtons; }
949     
950 #if ENABLE(SVG)
951     const SVGDocumentExtensions* svgExtensions();
952     SVGDocumentExtensions* accessSVGExtensions();
953 #endif
954
955     void initSecurityContext();
956     SecurityOrigin* securityOrigin() const { return m_securityOrigin.get(); }
957
958     // Explicitly override the security origin for this document.
959     // Note: It is dangerous to change the security origin of a document
960     //       that already contains content.
961     void setSecurityOrigin(SecurityOrigin*);
962
963     bool processingLoadEvent() const { return m_processingLoadEvent; }
964
965 #if ENABLE(DATABASE)
966     void addOpenDatabase(Database*);
967     void removeOpenDatabase(Database*);
968     DatabaseThread* databaseThread();   // Creates the thread as needed, but not if it has been already terminated.
969     void setHasOpenDatabases() { m_hasOpenDatabases = true; }
970     bool hasOpenDatabases() { return m_hasOpenDatabases; }
971     void stopDatabases();
972 #endif
973 protected:
974     void clearXMLVersion() { m_xmlVersion = String(); }
975
976 private:
977     void updateTitle();
978     void removeAllDisconnectedNodeEventListeners();
979     void imageLoadEventTimerFired(Timer<Document>*);
980     void updateFocusAppearanceTimerFired(Timer<Document>*);
981     void updateBaseURL();
982
983     RefPtr<SecurityOrigin> m_securityOrigin;
984
985     RenderObject* m_savedRenderer;
986     int m_secureForms;
987     
988     RefPtr<TextResourceDecoder> m_decoder;
989
990     // We maintain the invariant that m_duplicateIds is the count of all elements with a given ID
991     // excluding the one referenced in m_elementsById, if any. This means it one less than the total count
992     // when the first node with a given ID is cached, otherwise the same as the total count.
993     mutable HashMap<AtomicStringImpl*, Element*> m_elementsById;
994     mutable HashCountedSet<AtomicStringImpl*> m_duplicateIds;
995     
996     mutable HashMap<StringImpl*, Element*, CaseFoldingHash> m_elementsByAccessKey;
997     
998     InheritedBool m_designMode;
999     
1000     int m_selfOnlyRefCount;
1001
1002     HTMLFormElement::CheckedRadioButtons m_checkedRadioButtons;
1003
1004     typedef HashMap<AtomicStringImpl*, HTMLCollection::CollectionInfo*> NamedCollectionMap;
1005     HTMLCollection::CollectionInfo m_collectionInfo[HTMLCollection::NumUnnamedDocumentCachedTypes];
1006     NamedCollectionMap m_nameCollectionInfo[HTMLCollection::NumNamedDocumentCachedTypes];
1007
1008 #if ENABLE(XPATH)
1009     RefPtr<XPathEvaluator> m_xpathEvaluator;
1010 #endif
1011     
1012 #if ENABLE(SVG)
1013     SVGDocumentExtensions* m_svgExtensions;
1014 #endif
1015     
1016 #if ENABLE(DASHBOARD_SUPPORT)
1017     Vector<DashboardRegionValue> m_dashboardRegions;
1018     bool m_hasDashboardRegions;
1019     bool m_dashboardRegionsDirty;
1020 #endif
1021
1022     HashMap<String, RefPtr<HTMLCanvasElement> > m_cssCanvasElements;
1023
1024     mutable bool m_accessKeyMapValid;
1025     bool m_createRenderers;
1026     bool m_inPageCache;
1027     String m_iconURL;
1028     
1029     HashSet<Element*> m_pageCacheCallbackElements;
1030
1031     bool m_useSecureKeyboardEntryWhenActive;
1032
1033     bool m_isXHTML;
1034
1035     unsigned m_numNodeListCaches;
1036
1037 public:
1038     typedef HashMap<WebCore::Node*, JSNode*> JSWrapperCache;
1039     JSWrapperCache& wrapperCache() { return m_wrapperCache; }
1040 private:
1041     JSWrapperCache m_wrapperCache;
1042
1043 #if ENABLE(DATABASE)
1044     RefPtr<DatabaseThread> m_databaseThread;
1045     bool m_hasOpenDatabases;    // This never changes back to false, even as the database thread is closed.
1046     typedef HashSet<Database*> DatabaseSet;
1047     OwnPtr<DatabaseSet> m_openDatabaseSet;
1048 #endif
1049
1050 #if USE(LOW_BANDWIDTH_DISPLAY)
1051     bool m_inLowBandwidthDisplay;
1052 #endif
1053
1054 };
1055
1056 inline bool Document::hasElementWithId(AtomicStringImpl* id) const
1057 {
1058     ASSERT(id);
1059     return m_elementsById.contains(id) || m_duplicateIds.contains(id);
1060 }
1061
1062 } // namespace WebCore
1063
1064 #endif // Document_h