2011-01-19 James Robinson <jamesr@chromium.org>
[WebKit-https.git] / Source / 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, 2009, 2010 Apple Inc. All rights reserved.
7  * Copyright (C) 2008, 2009 Torch Mobile Inc. All rights reserved. (http://www.torchmobile.com/)
8  * Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies)
9  *
10  * This library is free software; you can redistribute it and/or
11  * modify it under the terms of the GNU Library General Public
12  * License as published by the Free Software Foundation; either
13  * version 2 of the License, or (at your option) any later version.
14  *
15  * This library is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
18  * Library General Public License for more details.
19  *
20  * You should have received a copy of the GNU Library General Public License
21  * along with this library; see the file COPYING.LIB.  If not, write to
22  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
23  * Boston, MA 02110-1301, USA.
24  *
25  */
26
27 #ifndef Document_h
28 #define Document_h
29
30 #include "CheckedRadioButtons.h"
31 #include "CollectionCache.h"
32 #include "CollectionType.h"
33 #include "Color.h"
34 #include "ContainerNode.h"
35 #include "DocumentTiming.h"
36 #include "QualifiedName.h"
37 #include "ScriptExecutionContext.h"
38 #include "Timer.h"
39 #include "ViewportArguments.h"
40 #include <wtf/FixedArray.h>
41 #include <wtf/HashCountedSet.h>
42 #include <wtf/OwnPtr.h>
43 #include <wtf/PassOwnPtr.h>
44
45 #if USE(JSC)
46 #include <runtime/WeakGCMap.h>
47 #endif
48
49 namespace WebCore {
50
51 class AsyncScriptRunner;
52 class Attr;
53 class AXObjectCache;
54 class CDATASection;
55 class CachedCSSStyleSheet;
56 class CachedResourceLoader;
57 class CachedScript;
58 class CanvasRenderingContext;
59 class CharacterData;
60 class CSSStyleDeclaration;
61 class CSSStyleSelector;
62 class CSSStyleSheet;
63 class Comment;
64 class DOMImplementation;
65 class DOMSelection;
66 class DOMWindow;
67 class Database;
68 class DatabaseThread;
69 class DocumentFragment;
70 class DocumentMarkerController;
71 class DocumentType;
72 class DocumentWeakReference;
73 class EditingText;
74 class Element;
75 class EntityReference;
76 class Event;
77 class EventListener;
78 class EventQueue;
79 class FormAssociatedElement;
80 class Frame;
81 class FrameView;
82 class HTMLCanvasElement;
83 class HTMLCollection;
84 class HTMLAllCollection;
85 class HTMLDocument;
86 class HTMLElement;
87 class HTMLFormElement;
88 class HTMLFrameOwnerElement;
89 class HTMLHeadElement;
90 class HTMLInputElement;
91 class HTMLMapElement;
92 class HitTestRequest;
93 class HitTestResult;
94 class IntPoint;
95 class DOMWrapperWorld;
96 class JSNode;
97 class MediaCanStartListener;
98 class MediaQueryList;
99 class MediaQueryMatcher;
100 class MouseEventWithHitTestResults;
101 class NodeFilter;
102 class NodeIterator;
103 class Page;
104 class PlatformMouseEvent;
105 class ProcessingInstruction;
106 class Range;
107 class RegisteredEventListener;
108 class RenderArena;
109 class RenderView;
110 class RenderFullScreen;
111 class ScriptableDocumentParser;
112 class ScriptElementData;
113 class SecurityOrigin;
114 class SerializedScriptValue;
115 class SegmentedString;
116 class Settings;
117 class StyleSheet;
118 class StyleSheetList;
119 class Text;
120 class TextResourceDecoder;
121 class DocumentParser;
122 class TreeWalker;
123 class XMLHttpRequest;
124
125 #if ENABLE(SVG)
126 class SVGDocumentExtensions;
127 #endif
128
129 #if ENABLE(XSLT)
130 class TransformSource;
131 #endif
132
133 #if ENABLE(XPATH)
134 class XPathEvaluator;
135 class XPathExpression;
136 class XPathNSResolver;
137 class XPathResult;
138 #endif
139
140 #if ENABLE(DASHBOARD_SUPPORT)
141 struct DashboardRegionValue;
142 #endif
143
144 #if ENABLE(TOUCH_EVENTS)
145 class Touch;
146 class TouchList;
147 #endif
148
149 typedef int ExceptionCode;
150
151 class FormElementKey {
152 public:
153     FormElementKey(AtomicStringImpl* = 0, AtomicStringImpl* = 0);
154     ~FormElementKey();
155     FormElementKey(const FormElementKey&);
156     FormElementKey& operator=(const FormElementKey&);
157
158     AtomicStringImpl* name() const { return m_name; }
159     AtomicStringImpl* type() const { return m_type; }
160
161     // Hash table deleted values, which are only constructed and never copied or destroyed.
162     FormElementKey(WTF::HashTableDeletedValueType) : m_name(hashTableDeletedValue()) { }
163     bool isHashTableDeletedValue() const { return m_name == hashTableDeletedValue(); }
164
165 private:
166     void ref() const;
167     void deref() const;
168
169     static AtomicStringImpl* hashTableDeletedValue() { return reinterpret_cast<AtomicStringImpl*>(-1); }
170
171     AtomicStringImpl* m_name;
172     AtomicStringImpl* m_type;
173 };
174
175 inline bool operator==(const FormElementKey& a, const FormElementKey& b)
176 {
177     return a.name() == b.name() && a.type() == b.type();
178 }
179
180 struct FormElementKeyHash {
181     static unsigned hash(const FormElementKey&);
182     static bool equal(const FormElementKey& a, const FormElementKey& b) { return a == b; }
183     static const bool safeToCompareToEmptyOrDeleted = true;
184 };
185
186 struct FormElementKeyHashTraits : WTF::GenericHashTraits<FormElementKey> {
187     static void constructDeletedValue(FormElementKey& slot) { new (&slot) FormElementKey(WTF::HashTableDeletedValue); }
188     static bool isDeletedValue(const FormElementKey& value) { return value.isHashTableDeletedValue(); }
189 };
190
191 enum PageshowEventPersistence {
192     PageshowEventNotPersisted = 0,
193     PageshowEventPersisted = 1
194 };
195
196 enum StyleSelectorUpdateFlag { RecalcStyleImmediately, DeferRecalcStyle };
197
198 class Document : public ContainerNode, public ScriptExecutionContext {
199 public:
200     static PassRefPtr<Document> create(Frame* frame, const KURL& url)
201     {
202         return adoptRef(new Document(frame, url, false, false));
203     }
204     static PassRefPtr<Document> createXHTML(Frame* frame, const KURL& url)
205     {
206         return adoptRef(new Document(frame, url, true, false));
207     }
208     virtual ~Document();
209
210     MediaQueryMatcher* mediaQueryMatcher();
211
212     using ContainerNode::ref;
213     using ContainerNode::deref;
214
215     // Nodes belonging to this document hold "self-only" references -
216     // these are enough to keep the document from being destroyed, but
217     // not enough to keep it from removing its children. This allows a
218     // node that outlives its document to still have a valid document
219     // pointer without introducing reference cycles
220
221     void selfOnlyRef()
222     {
223         ASSERT(!m_deletionHasBegun);
224         ++m_selfOnlyRefCount;
225     }
226     void selfOnlyDeref()
227     {
228         ASSERT(!m_deletionHasBegun);
229         --m_selfOnlyRefCount;
230         if (!m_selfOnlyRefCount && !refCount()) {
231 #ifndef NDEBUG
232             m_deletionHasBegun = true;
233 #endif
234             delete this;
235         }
236     }
237
238     // DOM methods & attributes for Document
239
240     DEFINE_ATTRIBUTE_EVENT_LISTENER(abort);
241     DEFINE_ATTRIBUTE_EVENT_LISTENER(change);
242     DEFINE_ATTRIBUTE_EVENT_LISTENER(click);
243     DEFINE_ATTRIBUTE_EVENT_LISTENER(contextmenu);
244     DEFINE_ATTRIBUTE_EVENT_LISTENER(dblclick);
245     DEFINE_ATTRIBUTE_EVENT_LISTENER(dragenter);
246     DEFINE_ATTRIBUTE_EVENT_LISTENER(dragover);
247     DEFINE_ATTRIBUTE_EVENT_LISTENER(dragleave);
248     DEFINE_ATTRIBUTE_EVENT_LISTENER(drop);
249     DEFINE_ATTRIBUTE_EVENT_LISTENER(dragstart);
250     DEFINE_ATTRIBUTE_EVENT_LISTENER(drag);
251     DEFINE_ATTRIBUTE_EVENT_LISTENER(dragend);
252     DEFINE_ATTRIBUTE_EVENT_LISTENER(formchange);
253     DEFINE_ATTRIBUTE_EVENT_LISTENER(forminput);
254     DEFINE_ATTRIBUTE_EVENT_LISTENER(input);
255     DEFINE_ATTRIBUTE_EVENT_LISTENER(invalid);
256     DEFINE_ATTRIBUTE_EVENT_LISTENER(keydown);
257     DEFINE_ATTRIBUTE_EVENT_LISTENER(keypress);
258     DEFINE_ATTRIBUTE_EVENT_LISTENER(keyup);
259     DEFINE_ATTRIBUTE_EVENT_LISTENER(mousedown);
260     DEFINE_ATTRIBUTE_EVENT_LISTENER(mousemove);
261     DEFINE_ATTRIBUTE_EVENT_LISTENER(mouseout);
262     DEFINE_ATTRIBUTE_EVENT_LISTENER(mouseover);
263     DEFINE_ATTRIBUTE_EVENT_LISTENER(mouseup);
264     DEFINE_ATTRIBUTE_EVENT_LISTENER(mousewheel);
265     DEFINE_ATTRIBUTE_EVENT_LISTENER(scroll);
266     DEFINE_ATTRIBUTE_EVENT_LISTENER(select);
267     DEFINE_ATTRIBUTE_EVENT_LISTENER(submit);
268
269     DEFINE_ATTRIBUTE_EVENT_LISTENER(blur);
270     DEFINE_ATTRIBUTE_EVENT_LISTENER(error);
271     DEFINE_ATTRIBUTE_EVENT_LISTENER(focus);
272     DEFINE_ATTRIBUTE_EVENT_LISTENER(load);
273     DEFINE_ATTRIBUTE_EVENT_LISTENER(readystatechange);
274
275     // WebKit extensions
276     DEFINE_ATTRIBUTE_EVENT_LISTENER(beforecut);
277     DEFINE_ATTRIBUTE_EVENT_LISTENER(cut);
278     DEFINE_ATTRIBUTE_EVENT_LISTENER(beforecopy);
279     DEFINE_ATTRIBUTE_EVENT_LISTENER(copy);
280     DEFINE_ATTRIBUTE_EVENT_LISTENER(beforepaste);
281     DEFINE_ATTRIBUTE_EVENT_LISTENER(paste);
282     DEFINE_ATTRIBUTE_EVENT_LISTENER(reset);
283     DEFINE_ATTRIBUTE_EVENT_LISTENER(search);
284     DEFINE_ATTRIBUTE_EVENT_LISTENER(selectstart);
285 #if ENABLE(TOUCH_EVENTS)
286     DEFINE_ATTRIBUTE_EVENT_LISTENER(touchstart);
287     DEFINE_ATTRIBUTE_EVENT_LISTENER(touchmove);
288     DEFINE_ATTRIBUTE_EVENT_LISTENER(touchend);
289     DEFINE_ATTRIBUTE_EVENT_LISTENER(touchcancel);
290 #endif
291 #if ENABLE(FULLSCREEN_API)
292     DEFINE_ATTRIBUTE_EVENT_LISTENER(webkitfullscreenchange);
293 #endif
294
295     ViewportArguments viewportArguments() const { return m_viewportArguments; }
296
297     DocumentType* doctype() const { return m_docType.get(); }
298
299     DOMImplementation* implementation() const;
300     
301     Element* documentElement() const
302     {
303         if (!m_documentElement)
304             cacheDocumentElement();
305         return m_documentElement.get();
306     }
307     
308     virtual PassRefPtr<Element> createElement(const AtomicString& tagName, ExceptionCode&);
309     PassRefPtr<DocumentFragment> createDocumentFragment();
310     PassRefPtr<Text> createTextNode(const String& data);
311     PassRefPtr<Comment> createComment(const String& data);
312     PassRefPtr<CDATASection> createCDATASection(const String& data, ExceptionCode&);
313     PassRefPtr<ProcessingInstruction> createProcessingInstruction(const String& target, const String& data, ExceptionCode&);
314     PassRefPtr<Attr> createAttribute(const String& name, ExceptionCode&);
315     PassRefPtr<Attr> createAttributeNS(const String& namespaceURI, const String& qualifiedName, ExceptionCode&, bool shouldIgnoreNamespaceChecks = false);
316     PassRefPtr<EntityReference> createEntityReference(const String& name, ExceptionCode&);
317     PassRefPtr<Node> importNode(Node* importedNode, bool deep, ExceptionCode&);
318     virtual PassRefPtr<Element> createElementNS(const String& namespaceURI, const String& qualifiedName, ExceptionCode&);
319     PassRefPtr<Element> createElement(const QualifiedName&, bool createdByParser);
320     Element* getElementById(const AtomicString&) const;
321     bool hasElementWithId(AtomicStringImpl* id) const;
322     bool containsMultipleElementsWithId(const AtomicString& id) const;
323
324     /**
325      * Retrieve all nodes that intersect a rect in the window's document, until it is fully enclosed by
326      * the boundaries of a node.
327      *
328      * @param centerX x reference for the rectangle in CSS pixels
329      * @param centerY y reference for the rectangle in CSS pixels
330      * @param topPadding How much to expand the top of the rectangle
331      * @param rightPadding How much to expand the right of the rectangle
332      * @param bottomPadding How much to expand the bottom of the rectangle
333      * @param leftPadding How much to expand the left of the rectangle
334      * @param ignoreClipping whether or not to ignore the root scroll frame when retrieving the element.
335      *        If false, this method returns null for coordinates outside of the viewport.
336      */
337     PassRefPtr<NodeList> nodesFromRect(int centerX, int centerY, unsigned topPadding, unsigned rightPadding,
338                                        unsigned bottomPadding, unsigned leftPadding, bool ignoreClipping) const;
339     Element* elementFromPoint(int x, int y) const;
340     PassRefPtr<Range> caretRangeFromPoint(int x, int y);
341
342     String readyState() const;
343
344     String defaultCharset() const;
345     
346     // Synonyms backing similar DOM attributes. Use Document::encoding() to avoid virtual dispatch.
347     String inputEncoding() const { return Document::encoding(); }
348     String charset() const { return Document::encoding(); }
349     String characterSet() const { return Document::encoding(); }
350
351     void setCharset(const String&);
352
353     void setContent(const String&);
354
355     String contentLanguage() const { return m_contentLanguage; }
356     void setContentLanguage(const String& lang) { m_contentLanguage = lang; }
357
358     String xmlEncoding() const { return m_xmlEncoding; }
359     String xmlVersion() const { return m_xmlVersion; }
360     bool xmlStandalone() const { return m_xmlStandalone; }
361
362     void setXMLEncoding(const String& encoding) { m_xmlEncoding = encoding; } // read-only property, only to be set from XMLDocumentParser
363     void setXMLVersion(const String&, ExceptionCode&);
364     void setXMLStandalone(bool, ExceptionCode&);
365
366     String documentURI() const { return m_documentURI; }
367     void setDocumentURI(const String&);
368
369     virtual KURL baseURI() const;
370
371     PassRefPtr<Node> adoptNode(PassRefPtr<Node> source, ExceptionCode&);
372
373     PassRefPtr<HTMLCollection> images();
374     PassRefPtr<HTMLCollection> embeds();
375     PassRefPtr<HTMLCollection> plugins(); // an alias for embeds() required for the JS DOM bindings.
376     PassRefPtr<HTMLCollection> applets();
377     PassRefPtr<HTMLCollection> links();
378     PassRefPtr<HTMLCollection> forms();
379     PassRefPtr<HTMLCollection> anchors();
380     PassRefPtr<HTMLCollection> objects();
381     PassRefPtr<HTMLCollection> scripts();
382     PassRefPtr<HTMLCollection> windowNamedItems(const String& name);
383     PassRefPtr<HTMLCollection> documentNamedItems(const String& name);
384
385     PassRefPtr<HTMLAllCollection> all();
386
387     // Find first anchor with the given name.
388     // First searches for an element with the given ID, but if that fails, then looks
389     // for an anchor with the given name. ID matching is always case sensitive, but
390     // Anchor name matching is case sensitive in strict mode and not case sensitive in
391     // quirks mode for historical compatibility reasons.
392     Element* findAnchor(const String& name);
393
394     CollectionCache* collectionInfo(CollectionType type)
395     {
396         ASSERT(type >= FirstUnnamedDocumentCachedType);
397         unsigned index = type - FirstUnnamedDocumentCachedType;
398         ASSERT(index < NumUnnamedDocumentCachedTypes);
399         m_collectionInfo[index].checkConsistency();
400         return &m_collectionInfo[index]; 
401     }
402
403     CollectionCache* nameCollectionInfo(CollectionType, const AtomicString& name);
404
405     // Other methods (not part of DOM)
406     bool isHTMLDocument() const { return m_isHTML; }
407     bool isXHTMLDocument() const { return m_isXHTML; }
408     virtual bool isImageDocument() const { return false; }
409 #if ENABLE(SVG)
410     virtual bool isSVGDocument() const { return false; }
411     bool hasSVGRootNode() const;
412 #else
413     static bool isSVGDocument() { return false; }
414     static bool hasSVGRootNode() { return false; }
415 #endif
416     virtual bool isPluginDocument() const { return false; }
417     virtual bool isMediaDocument() const { return false; }
418 #if ENABLE(WML)
419     virtual bool isWMLDocument() const { return false; }
420 #endif
421 #if ENABLE(XHTMLMP)
422     bool isXHTMLMPDocument() const; 
423     bool shouldProcessNoscriptElement() const { return m_shouldProcessNoScriptElement; }
424     void setShouldProcessNoscriptElement(bool shouldDo) { m_shouldProcessNoScriptElement = shouldDo; }
425 #endif
426     virtual bool isFrameSet() const { return false; }
427     
428     CSSStyleSelector* styleSelector()
429     { 
430         if (!m_styleSelector)
431             createStyleSelector();
432         return m_styleSelector.get();
433     }
434
435     Element* getElementByAccessKey(const String& key) const;
436     
437     /**
438      * Updates the pending sheet count and then calls updateStyleSelector.
439      */
440     void removePendingSheet();
441
442     /**
443      * This method returns true if all top-level stylesheets have loaded (including
444      * any @imports that they may be loading).
445      */
446     bool haveStylesheetsLoaded() const
447     {
448         return m_pendingStylesheets <= 0 || m_ignorePendingStylesheets;
449     }
450
451     /**
452      * Increments the number of pending sheets.  The <link> elements
453      * invoke this to add themselves to the loading list.
454      */
455     void addPendingSheet() { m_pendingStylesheets++; }
456
457     void addStyleSheetCandidateNode(Node*, bool createdByParser);
458     void removeStyleSheetCandidateNode(Node*);
459
460     bool gotoAnchorNeededAfterStylesheetsLoad() { return m_gotoAnchorNeededAfterStylesheetsLoad; }
461     void setGotoAnchorNeededAfterStylesheetsLoad(bool b) { m_gotoAnchorNeededAfterStylesheetsLoad = b; }
462
463     /**
464      * Called when one or more stylesheets in the document may have been added, removed or changed.
465      *
466      * Creates a new style selector and assign it to this document. This is done by iterating through all nodes in
467      * document (or those before <BODY> in a HTML document), searching for stylesheets. Stylesheets can be contained in
468      * <LINK>, <STYLE> or <BODY> elements, as well as processing instructions (XML documents only). A list is
469      * constructed from these which is used to create the a new style selector which collates all of the stylesheets
470      * found and is used to calculate the derived styles for all rendering objects.
471      */
472     void styleSelectorChanged(StyleSelectorUpdateFlag);
473     void recalcStyleSelector();
474
475     bool usesDescendantRules() const { return m_usesDescendantRules; }
476     void setUsesDescendantRules(bool b) { m_usesDescendantRules = b; }
477     bool usesSiblingRules() const { return m_usesSiblingRules; }
478     void setUsesSiblingRules(bool b) { m_usesSiblingRules = b; }
479     bool usesFirstLineRules() const { return m_usesFirstLineRules; }
480     void setUsesFirstLineRules(bool b) { m_usesFirstLineRules = b; }
481     bool usesFirstLetterRules() const { return m_usesFirstLetterRules; }
482     void setUsesFirstLetterRules(bool b) { m_usesFirstLetterRules = b; }
483     bool usesBeforeAfterRules() const { return m_usesBeforeAfterRules; }
484     void setUsesBeforeAfterRules(bool b) { m_usesBeforeAfterRules = b; }
485     bool usesRemUnits() const { return m_usesRemUnits; }
486     void setUsesRemUnits(bool b) { m_usesRemUnits = b; }
487     bool usesLinkRules() const { return linkColor() != visitedLinkColor() || m_usesLinkRules; }
488     void setUsesLinkRules(bool b) { m_usesLinkRules = b; }
489
490     // Machinery for saving and restoring state when you leave and then go back to a page.
491     void registerFormElementWithState(Element* e) { m_formElementsWithState.add(e); }
492     void unregisterFormElementWithState(Element* e) { m_formElementsWithState.remove(e); }
493     Vector<String> formElementsState() const;
494     void setStateForNewFormElements(const Vector<String>&);
495     bool hasStateForNewFormElements() const;
496     bool takeStateForFormElement(AtomicStringImpl* name, AtomicStringImpl* type, String& state);
497
498     void registerFormElementWithFormAttribute(FormAssociatedElement*);
499     void unregisterFormElementWithFormAttribute(FormAssociatedElement*);
500     void resetFormElementsOwner(HTMLFormElement*);
501
502     FrameView* view() const; // can be NULL
503     Frame* frame() const { return m_frame; } // can be NULL
504     Page* page() const; // can be NULL
505     Settings* settings() const; // can be NULL
506
507     PassRefPtr<Range> createRange();
508
509     PassRefPtr<NodeIterator> createNodeIterator(Node* root, unsigned whatToShow,
510         PassRefPtr<NodeFilter>, bool expandEntityReferences, ExceptionCode&);
511
512     PassRefPtr<TreeWalker> createTreeWalker(Node* root, unsigned whatToShow, 
513         PassRefPtr<NodeFilter>, bool expandEntityReferences, ExceptionCode&);
514
515     // Special support for editing
516     PassRefPtr<CSSStyleDeclaration> createCSSStyleDeclaration();
517     PassRefPtr<EditingText> createEditingTextNode(const String&);
518
519     virtual void recalcStyle(StyleChange = NoChange);
520     bool childNeedsAndNotInStyleRecalc();
521     virtual void updateStyleIfNeeded();
522     void updateLayout();
523     void updateLayoutIgnorePendingStylesheets();
524     PassRefPtr<RenderStyle> styleForElementIgnoringPendingStylesheets(Element*);
525     PassRefPtr<RenderStyle> styleForPage(int pageIndex);
526
527     // Returns true if page box (margin boxes and page borders) is visible.
528     bool isPageBoxVisible(int pageIndex);
529
530     // Returns the preferred page size and margins in pixels, assuming 96
531     // pixels per inch. pageSize, marginTop, marginRight, marginBottom,
532     // marginLeft must be initialized to the default values that are used if
533     // auto is specified.
534     void pageSizeAndMarginsInPixels(int pageIndex, IntSize& pageSize, int& marginTop, int& marginRight, int& marginBottom, int& marginLeft);
535
536     static void updateStyleForAllDocuments(); // FIXME: Try to reduce the # of calls to this function.
537     CachedResourceLoader* cachedResourceLoader() { return m_cachedResourceLoader.get(); }
538
539     virtual void attach();
540     virtual void detach();
541
542     RenderArena* renderArena() { return m_renderArena.get(); }
543
544     RenderView* renderView() const;
545
546     void clearAXObjectCache();
547     AXObjectCache* axObjectCache() const;
548     bool axObjectCacheExists() const;
549     
550     // to get visually ordered hebrew and arabic pages right
551     void setVisuallyOrdered();
552     bool visuallyOrdered() const { return m_visuallyOrdered; }
553
554     void open(Document* ownerDocument = 0);
555     void implicitOpen();
556     void close();
557     void implicitClose();
558     void cancelParsing();
559
560     void write(const SegmentedString& text, Document* ownerDocument = 0);
561     void write(const String& text, Document* ownerDocument = 0);
562     void writeln(const String& text, Document* ownerDocument = 0);
563     void finishParsing();
564
565     bool wellFormed() const { return m_wellFormed; }
566
567     const KURL& url() const { return m_url; }
568     void setURL(const KURL&);
569
570     const KURL& baseURL() const { return m_baseURL; }
571     const String& baseTarget() const { return m_baseTarget; }
572     void processBaseElement();
573
574     KURL completeURL(const String&) const;
575
576     virtual String userAgent(const KURL&) const;
577
578     CSSStyleSheet* pageUserSheet();
579     void clearPageUserSheet();
580     void updatePageUserSheet();
581
582     const Vector<RefPtr<CSSStyleSheet> >* pageGroupUserSheets() const;
583     void clearPageGroupUserSheets();
584     void updatePageGroupUserSheets();
585
586     CSSStyleSheet* elementSheet();
587     CSSStyleSheet* mappedElementSheet();
588     
589     virtual PassRefPtr<DocumentParser> createParser();
590     DocumentParser* parser() const { return m_parser.get(); }
591     ScriptableDocumentParser* scriptableDocumentParser() const;
592     
593     bool printing() const { return m_printing; }
594     void setPrinting(bool p) { m_printing = p; }
595
596     bool paginatedForScreen() const { return m_paginatedForScreen; }
597     void setPaginatedForScreen(bool p) { m_paginatedForScreen = p; }
598     
599     bool paginated() const { return printing() || paginatedForScreen(); }
600
601     enum CompatibilityMode { QuirksMode, LimitedQuirksMode, NoQuirksMode };
602
603     virtual void setCompatibilityModeFromDoctype() { }
604     void setCompatibilityMode(CompatibilityMode m);
605     void lockCompatibilityMode() { m_compatibilityModeLocked = true; }
606     CompatibilityMode compatibilityMode() const { return m_compatibilityMode; }
607
608     String compatMode() const;
609
610     bool inQuirksMode() const { return m_compatibilityMode == QuirksMode; }
611     bool inLimitedQuirksMode() const { return m_compatibilityMode == LimitedQuirksMode; }
612     bool inNoQuirksMode() const { return m_compatibilityMode == NoQuirksMode; }
613
614     enum ReadyState {
615         Loading,
616         Interactive,
617         Complete
618     };
619     void setReadyState(ReadyState);
620     void setParsing(bool);
621     bool parsing() const { return m_bParsing; }
622     int minimumLayoutDelay();
623
624     // This method is used by Android.
625     void setExtraLayoutDelay(int delay) { m_extraLayoutDelay = delay; }
626
627     bool shouldScheduleLayout();
628     int elapsedTime() const;
629     
630     void setTextColor(const Color& color) { m_textColor = color; }
631     Color textColor() const { return m_textColor; }
632
633     const Color& linkColor() const { return m_linkColor; }
634     const Color& visitedLinkColor() const { return m_visitedLinkColor; }
635     const Color& activeLinkColor() const { return m_activeLinkColor; }
636     void setLinkColor(const Color& c) { m_linkColor = c; }
637     void setVisitedLinkColor(const Color& c) { m_visitedLinkColor = c; }
638     void setActiveLinkColor(const Color& c) { m_activeLinkColor = c; }
639     void resetLinkColor();
640     void resetVisitedLinkColor();
641     void resetActiveLinkColor();
642     
643     MouseEventWithHitTestResults prepareMouseEvent(const HitTestRequest&, const IntPoint&, const PlatformMouseEvent&);
644
645     StyleSheetList* styleSheets();
646
647     /* Newly proposed CSS3 mechanism for selecting alternate
648        stylesheets using the DOM. May be subject to change as
649        spec matures. - dwh
650     */
651     String preferredStylesheetSet() const;
652     String selectedStylesheetSet() const;
653     void setSelectedStylesheetSet(const String&);
654
655     bool setFocusedNode(PassRefPtr<Node>);
656     Node* focusedNode() const { return m_focusedNode.get(); }
657
658     void getFocusableNodes(Vector<RefPtr<Node> >&);
659     
660     // The m_ignoreAutofocus flag specifies whether or not the document has been changed by the user enough 
661     // for WebCore to ignore the autofocus attribute on any form controls
662     bool ignoreAutofocus() const { return m_ignoreAutofocus; };
663     void setIgnoreAutofocus(bool shouldIgnore = true) { m_ignoreAutofocus = shouldIgnore; };
664
665     void setHoverNode(PassRefPtr<Node>);
666     Node* hoverNode() const { return m_hoverNode.get(); }
667
668     void setActiveNode(PassRefPtr<Node>);
669     Node* activeNode() const { return m_activeNode.get(); }
670
671     void focusedNodeRemoved();
672     void removeFocusedNodeOfSubtree(Node*, bool amongChildrenOnly = false);
673     void hoveredNodeDetached(Node*);
674     void activeChainNodeDetached(Node*);
675
676     // Updates for :target (CSS3 selector).
677     void setCSSTarget(Element*);
678     Element* cssTarget() const { return m_cssTarget; }
679     
680     void scheduleForcedStyleRecalc();
681     void scheduleStyleRecalc();
682     void unscheduleStyleRecalc();
683     bool isPendingStyleRecalc() const;
684     void styleRecalcTimerFired(Timer<Document>*);
685
686     void attachNodeIterator(NodeIterator*);
687     void detachNodeIterator(NodeIterator*);
688     void moveNodeIteratorsToNewDocument(Node*, Document*);
689
690     void attachRange(Range*);
691     void detachRange(Range*);
692
693     void nodeChildrenChanged(ContainerNode*);
694     // nodeChildrenWillBeRemoved is used when removing all node children at once.
695     void nodeChildrenWillBeRemoved(ContainerNode*);
696     // nodeWillBeRemoved is only safe when removing one node at a time.
697     void nodeWillBeRemoved(Node*);
698
699     void textInserted(Node*, unsigned offset, unsigned length);
700     void textRemoved(Node*, unsigned offset, unsigned length);
701     void textNodesMerged(Text* oldNode, unsigned offset);
702     void textNodeSplit(Text* oldNode);
703
704     DOMWindow* defaultView() const { return domWindow(); } 
705     DOMWindow* domWindow() const;
706
707     // Helper functions for forwarding DOMWindow event related tasks to the DOMWindow if it exists.
708     void setWindowAttributeEventListener(const AtomicString& eventType, PassRefPtr<EventListener>);
709     EventListener* getWindowAttributeEventListener(const AtomicString& eventType);
710     void dispatchWindowEvent(PassRefPtr<Event>, PassRefPtr<EventTarget> = 0);
711     void dispatchWindowLoadEvent();
712
713     PassRefPtr<Event> createEvent(const String& eventType, ExceptionCode&);
714
715     // keep track of what types of event listeners are registered, so we don't
716     // dispatch events unnecessarily
717     enum ListenerType {
718         DOMSUBTREEMODIFIED_LISTENER          = 0x01,
719         DOMNODEINSERTED_LISTENER             = 0x02,
720         DOMNODEREMOVED_LISTENER              = 0x04,
721         DOMNODEREMOVEDFROMDOCUMENT_LISTENER  = 0x08,
722         DOMNODEINSERTEDINTODOCUMENT_LISTENER = 0x10,
723         DOMATTRMODIFIED_LISTENER             = 0x20,
724         DOMCHARACTERDATAMODIFIED_LISTENER    = 0x40,
725         OVERFLOWCHANGED_LISTENER             = 0x80,
726         ANIMATIONEND_LISTENER                = 0x100,
727         ANIMATIONSTART_LISTENER              = 0x200,
728         ANIMATIONITERATION_LISTENER          = 0x400,
729         TRANSITIONEND_LISTENER               = 0x800,
730         BEFORELOAD_LISTENER                  = 0x1000,
731         TOUCH_LISTENER                       = 0x2000,
732         BEFOREPROCESS_LISTENER               = 0x4000
733     };
734
735     bool hasListenerType(ListenerType listenerType) const { return (m_listenerTypes & listenerType); }
736     void addListenerType(ListenerType listenerType) { m_listenerTypes = m_listenerTypes | listenerType; }
737     void addListenerTypeIfNeeded(const AtomicString& eventType);
738
739     CSSStyleDeclaration* getOverrideStyle(Element*, const String& pseudoElt);
740
741     /**
742      * Searches through the document, starting from fromNode, for the next selectable element that comes after fromNode.
743      * The order followed is as specified in section 17.11.1 of the HTML4 spec, which is elements with tab indexes
744      * first (from lowest to highest), and then elements without tab indexes (in document order).
745      *
746      * @param fromNode The node from which to start searching. The node after this will be focused. May be null.
747      *
748      * @return The focus node that comes after fromNode
749      *
750      * See http://www.w3.org/TR/html4/interact/forms.html#h-17.11.1
751      */
752     Node* nextFocusableNode(Node* start, KeyboardEvent*);
753
754     /**
755      * Searches through the document, starting from fromNode, for the previous selectable element (that comes _before_)
756      * fromNode. The order followed is as specified in section 17.11.1 of the HTML4 spec, which is elements with tab
757      * indexes first (from lowest to highest), and then elements without tab indexes (in document order).
758      *
759      * @param fromNode The node from which to start searching. The node before this will be focused. May be null.
760      *
761      * @return The focus node that comes before fromNode
762      *
763      * See http://www.w3.org/TR/html4/interact/forms.html#h-17.11.1
764      */
765     Node* previousFocusableNode(Node* start, KeyboardEvent*);
766
767     int nodeAbsIndex(Node*);
768     Node* nodeWithAbsIndex(int absIndex);
769
770     /**
771      * Handles a HTTP header equivalent set by a meta tag using <meta http-equiv="..." content="...">. This is called
772      * when a meta tag is encountered during document parsing, and also when a script dynamically changes or adds a meta
773      * tag. This enables scripts to use meta tags to perform refreshes and set expiry dates in addition to them being
774      * specified in a HTML file.
775      *
776      * @param equiv The http header name (value of the meta tag's "equiv" attribute)
777      * @param content The header value (value of the meta tag's "content" attribute)
778      */
779     void processHttpEquiv(const String& equiv, const String& content);
780     void processViewport(const String& features);
781
782     // Returns the owning element in the parent document.
783     // Returns 0 if this is the top level document.
784     HTMLFrameOwnerElement* ownerElement() const;
785
786     String title() const { return m_title; }
787     void setTitle(const String&, Element* titleElement = 0);
788     void removeTitle(Element* titleElement);
789
790     String cookie(ExceptionCode&) const;
791     void setCookie(const String&, ExceptionCode&);
792
793     String referrer() const;
794
795     String domain() const;
796     void setDomain(const String& newDomain, ExceptionCode&);
797
798     String lastModified() const;
799
800     // The cookieURL is used to query the cookie database for this document's
801     // cookies. For example, if the cookie URL is http://example.com, we'll
802     // use the non-Secure cookies for example.com when computing
803     // document.cookie.
804     //
805     // Q: How is the cookieURL different from the document's URL?
806     // A: The two URLs are the same almost all the time.  However, if one
807     //    document inherits the security context of another document, it
808     //    inherits its cookieURL but not its URL.
809     //
810     const KURL& cookieURL() const { return m_cookieURL; }
811
812     // The firstPartyForCookies is used to compute whether this document
813     // appears in a "third-party" context for the purpose of third-party
814     // cookie blocking.  The document is in a third-party context if the
815     // cookieURL and the firstPartyForCookies are from different hosts.
816     //
817     // Note: Some ports (including possibly Apple's) only consider the
818     //       document in a third-party context if the cookieURL and the
819     //       firstPartyForCookies have a different registry-controlled
820     //       domain.
821     //
822     const KURL& firstPartyForCookies() const { return m_firstPartyForCookies; }
823     void setFirstPartyForCookies(const KURL& url) { m_firstPartyForCookies = url; }
824     
825     // The following implements the rule from HTML 4 for what valid names are.
826     // To get this right for all the XML cases, we probably have to improve this or move it
827     // and make it sensitive to the type of document.
828     static bool isValidName(const String&);
829
830     // The following breaks a qualified name into a prefix and a local name.
831     // It also does a validity check, and returns false if the qualified name
832     // is invalid.  It also sets ExceptionCode when name is invalid.
833     static bool parseQualifiedName(const String& qualifiedName, String& prefix, String& localName, ExceptionCode&);
834     
835     // Checks to make sure prefix and namespace do not conflict (per DOM Core 3)
836     static bool hasPrefixNamespaceMismatch(const QualifiedName&);
837     
838     void addElementById(const AtomicString& elementId, Element *element);
839     void removeElementById(const AtomicString& elementId, Element *element);
840
841     void addImageMap(HTMLMapElement*);
842     void removeImageMap(HTMLMapElement*);
843     HTMLMapElement* getImageMap(const String& url) const;
844
845     HTMLElement* body() const;
846     void setBody(PassRefPtr<HTMLElement>, ExceptionCode&);
847
848     HTMLHeadElement* head();
849
850     DocumentMarkerController* markers() const { return m_markers.get(); }
851
852     bool directionSetOnDocumentElement() const { return m_directionSetOnDocumentElement; }
853     bool writingModeSetOnDocumentElement() const { return m_writingModeSetOnDocumentElement; }
854     void setDirectionSetOnDocumentElement(bool b) { m_directionSetOnDocumentElement = b; }
855     void setWritingModeSetOnDocumentElement(bool b) { m_writingModeSetOnDocumentElement = b; }
856
857     bool execCommand(const String& command, bool userInterface = false, const String& value = String());
858     bool queryCommandEnabled(const String& command);
859     bool queryCommandIndeterm(const String& command);
860     bool queryCommandState(const String& command);
861     bool queryCommandSupported(const String& command);
862     String queryCommandValue(const String& command);
863     
864     // designMode support
865     enum InheritedBool { off = false, on = true, inherit };    
866     void setDesignMode(InheritedBool value);
867     InheritedBool getDesignMode() const;
868     bool inDesignMode() const;
869
870     Document* parentDocument() const;
871     Document* topDocument() const;
872
873     int docID() const { return m_docID; }
874     
875     AsyncScriptRunner* asyncScriptRunner() { return m_asyncScriptRunner.get(); }
876
877 #if ENABLE(XSLT)
878     void applyXSLTransform(ProcessingInstruction* pi);
879     PassRefPtr<Document> transformSourceDocument() { return m_transformSourceDocument; }
880     void setTransformSourceDocument(Document* doc) { m_transformSourceDocument = doc; }
881
882     void setTransformSource(PassOwnPtr<TransformSource>);
883     TransformSource* transformSource() const { return m_transformSource.get(); }
884 #endif
885
886     void incDOMTreeVersion() { ++m_domTreeVersion; }
887     unsigned domTreeVersion() const { return m_domTreeVersion; }
888
889     void setDocType(PassRefPtr<DocumentType>);
890
891 #if ENABLE(XPATH)
892     // XPathEvaluator methods
893     PassRefPtr<XPathExpression> createExpression(const String& expression,
894                                                  XPathNSResolver* resolver,
895                                                  ExceptionCode& ec);
896     PassRefPtr<XPathNSResolver> createNSResolver(Node *nodeResolver);
897     PassRefPtr<XPathResult> evaluate(const String& expression,
898                                      Node* contextNode,
899                                      XPathNSResolver* resolver,
900                                      unsigned short type,
901                                      XPathResult* result,
902                                      ExceptionCode& ec);
903 #endif // ENABLE(XPATH)
904     
905     enum PendingSheetLayout { NoLayoutWithPendingSheets, DidLayoutWithPendingSheets, IgnoreLayoutWithPendingSheets };
906
907     bool didLayoutWithPendingStylesheets() const { return m_pendingSheetLayout == DidLayoutWithPendingSheets; }
908     
909     void setHasNodesWithPlaceholderStyle() { m_hasNodesWithPlaceholderStyle = true; }
910
911     const String& iconURL() const { return m_iconURL; }
912     void setIconURL(const String& iconURL, const String& type);
913
914     void setUseSecureKeyboardEntryWhenActive(bool);
915     bool useSecureKeyboardEntryWhenActive() const;
916
917     void addNodeListCache() { ++m_numNodeListCaches; }
918     void removeNodeListCache() { ASSERT(m_numNodeListCaches > 0); --m_numNodeListCaches; }
919     bool hasNodeListCaches() const { return m_numNodeListCaches; }
920
921     void updateFocusAppearanceSoon(bool restorePreviousSelection);
922     void cancelFocusAppearanceUpdate();
923         
924     // FF method for accessing the selection added for compatibility.
925     DOMSelection* getSelection() const;
926     
927     // Extension for manipulating canvas drawing contexts for use in CSS
928     CanvasRenderingContext* getCSSCanvasContext(const String& type, const String& name, int width, int height);
929     HTMLCanvasElement* getCSSCanvasElement(const String& name);
930
931     bool isDNSPrefetchEnabled() const { return m_isDNSPrefetchEnabled; }
932     void parseDNSPrefetchControlHeader(const String&);
933
934     virtual void reportException(const String& errorMessage, int lineNumber, const String& sourceURL);
935     virtual void addMessage(MessageSource, MessageType, MessageLevel, const String& message, unsigned lineNumber, const String& sourceURL);
936     virtual void postTask(PassOwnPtr<Task>); // Executes the task on context's thread asynchronously.
937
938 #if USE(JSC)
939     typedef JSC::WeakGCMap<WebCore::Node*, JSNode*> JSWrapperCache;
940     typedef HashMap<DOMWrapperWorld*, JSWrapperCache*> JSWrapperCacheMap;
941     JSWrapperCacheMap& wrapperCacheMap() { return m_wrapperCacheMap; }
942     JSWrapperCache* getWrapperCache(DOMWrapperWorld* world);
943     JSWrapperCache* createWrapperCache(DOMWrapperWorld*);
944     void destroyWrapperCache(DOMWrapperWorld*);
945     void destroyAllWrapperCaches();
946 #endif
947
948     virtual void finishedParsing();
949
950     bool inPageCache() const { return m_inPageCache; }
951     void setInPageCache(bool flag);
952     
953     // Elements can register themselves for the "documentWillBecomeInactive()" and  
954     // "documentDidBecomeActive()" callbacks
955     void registerForDocumentActivationCallbacks(Element*);
956     void unregisterForDocumentActivationCallbacks(Element*);
957     void documentWillBecomeInactive();
958     void documentDidBecomeActive();
959
960     void registerForMediaVolumeCallbacks(Element*);
961     void unregisterForMediaVolumeCallbacks(Element*);
962     void mediaVolumeDidChange();
963
964     void setShouldCreateRenderers(bool);
965     bool shouldCreateRenderers();
966
967     void setDecoder(PassRefPtr<TextResourceDecoder>);
968     TextResourceDecoder* decoder() const { return m_decoder.get(); }
969
970     String displayStringModifiedByEncoding(const String&) const;
971     PassRefPtr<StringImpl> displayStringModifiedByEncoding(PassRefPtr<StringImpl>) const;
972     void displayBufferModifiedByEncoding(UChar* buffer, unsigned len) const;
973
974     // Quirk for the benefit of Apple's Dictionary application.
975     void setFrameElementsShouldIgnoreScrolling(bool ignore) { m_frameElementsShouldIgnoreScrolling = ignore; }
976     bool frameElementsShouldIgnoreScrolling() const { return m_frameElementsShouldIgnoreScrolling; }
977
978 #if ENABLE(DASHBOARD_SUPPORT)
979     void setDashboardRegionsDirty(bool f) { m_dashboardRegionsDirty = f; }
980     bool dashboardRegionsDirty() const { return m_dashboardRegionsDirty; }
981     bool hasDashboardRegions () const { return m_hasDashboardRegions; }
982     void setHasDashboardRegions(bool f) { m_hasDashboardRegions = f; }
983     const Vector<DashboardRegionValue>& dashboardRegions() const;
984     void setDashboardRegions(const Vector<DashboardRegionValue>&);
985 #endif
986
987     virtual void removeAllEventListeners();
988
989     CheckedRadioButtons& checkedRadioButtons() { return m_checkedRadioButtons; }
990     
991 #if ENABLE(SVG)
992     const SVGDocumentExtensions* svgExtensions();
993     SVGDocumentExtensions* accessSVGExtensions();
994 #endif
995
996     void initSecurityContext();
997
998     // Explicitly override the security origin for this document.
999     // Note: It is dangerous to change the security origin of a document
1000     //       that already contains content.
1001     void setSecurityOrigin(SecurityOrigin*);
1002
1003     void updateURLForPushOrReplaceState(const KURL&);
1004     void statePopped(SerializedScriptValue*);
1005
1006     bool processingLoadEvent() const { return m_processingLoadEvent; }
1007
1008 #if ENABLE(DATABASE)
1009     virtual bool allowDatabaseAccess() const;
1010     virtual void databaseExceededQuota(const String& name);
1011 #endif
1012
1013     virtual bool isContextThread() const;
1014     virtual bool isJSExecutionTerminated() const { return false; }
1015
1016     void setUsingGeolocation(bool f) { m_usingGeolocation = f; }
1017     bool usingGeolocation() const { return m_usingGeolocation; };
1018
1019 #if ENABLE(WML)
1020     void setContainsWMLContent(bool value) { m_containsWMLContent = value; }
1021     bool containsWMLContent() const { return m_containsWMLContent; }
1022
1023     void resetWMLPageState();
1024     void initializeWMLPageState();
1025 #endif
1026     
1027     bool containsValidityStyleRules() const { return m_containsValidityStyleRules; }
1028     void setContainsValidityStyleRules() { m_containsValidityStyleRules = true; }
1029
1030     void enqueueWindowEvent(PassRefPtr<Event>);
1031     void enqueuePageshowEvent(PageshowEventPersistence);
1032     void enqueueHashchangeEvent(const String& oldURL, const String& newURL);
1033     void enqueuePopstateEvent(PassRefPtr<SerializedScriptValue> stateObject);
1034     EventQueue* eventQueue() const { return m_eventQueue.get(); }
1035
1036     void addMediaCanStartListener(MediaCanStartListener*);
1037     void removeMediaCanStartListener(MediaCanStartListener*);
1038     MediaCanStartListener* takeAnyMediaCanStartListener();
1039
1040     const QualifiedName& idAttributeName() const { return m_idAttributeName; }
1041     
1042 #if ENABLE(FULLSCREEN_API)
1043     bool webkitIsFullScreen() const { return m_isFullScreen; }
1044     bool webkitFullScreenKeyboardInputAllowed() const { return m_isFullScreen && m_areKeysEnabledInFullScreen; }
1045     Element* webkitCurrentFullScreenElement() const { return m_fullScreenElement.get(); }
1046     void webkitRequestFullScreenForElement(Element*, unsigned short flags);
1047     void webkitCancelFullScreen();
1048     
1049     void webkitWillEnterFullScreenForElement(Element*);
1050     void webkitDidEnterFullScreenForElement(Element*);
1051     void webkitWillExitFullScreenForElement(Element*);
1052     void webkitDidExitFullScreenForElement(Element*);
1053     
1054     void setFullScreenRenderer(RenderFullScreen*);
1055     RenderFullScreen* fullScreenRenderer() const { return m_fullScreenRenderer; }
1056     
1057     void setFullScreenRendererSize(const IntSize&);
1058     void setFullScreenRendererBackgroundColor(Color);
1059     
1060     void fullScreenChangeDelayTimerFired(Timer<Document>*);
1061 #endif
1062
1063     // Used to allow element that loads data without going through a FrameLoader to delay the 'load' event.
1064     void incrementLoadEventDelayCount() { ++m_loadEventDelayCount; }
1065     void decrementLoadEventDelayCount();
1066     bool isDelayingLoadEvent() const { return m_loadEventDelayCount; }
1067
1068 #if ENABLE(TOUCH_EVENTS)
1069     PassRefPtr<Touch> createTouch(DOMWindow*, EventTarget*, int identifier, int pageX, int pageY, int screenX, int screenY, ExceptionCode&) const;
1070     PassRefPtr<TouchList> createTouchList(ExceptionCode&) const;
1071 #endif
1072
1073     const DocumentTiming* timing() const { return &m_documentTiming; }
1074
1075     bool mayCauseFlashOfUnstyledContent() const;
1076
1077     void initDNSPrefetch();
1078
1079 protected:
1080     Document(Frame*, const KURL& url, bool isXHTML, bool isHTML, const KURL& baseURL = KURL());
1081
1082     void clearXMLVersion() { m_xmlVersion = String(); }
1083
1084 private:
1085     class DocumentOrderedMap {
1086     public:
1087         void add(AtomicStringImpl*, Element*);
1088         void remove(AtomicStringImpl*, Element*);
1089         void clear();
1090
1091         bool contains(AtomicStringImpl*) const;
1092         bool containsMultiple(AtomicStringImpl*) const;
1093         template<bool keyMatches(AtomicStringImpl*, Element*)> Element* get(AtomicStringImpl*, const Document*) const;
1094
1095         void checkConsistency() const;
1096
1097     private:
1098         typedef HashMap<AtomicStringImpl*, Element*> Map;
1099
1100         // We maintain the invariant that m_duplicateCounts is the count of all elements with a given key
1101         // excluding the one referenced in m_map, if any. This means it one less than the total count
1102         // when the first node with a given key is cached, otherwise the same as the total count.
1103         mutable Map m_map;
1104         mutable HashCountedSet<AtomicStringImpl*> m_duplicateCounts;
1105     };
1106
1107     friend class IgnoreDestructiveWriteCountIncrementer;
1108
1109     void detachParser();
1110
1111     typedef void (*ArgumentsCallback)(const String& keyString, const String& valueString, Document*, void* data);
1112     void processArguments(const String& features, void* data, ArgumentsCallback);
1113
1114     virtual bool isDocument() const { return true; }
1115     virtual void removedLastRef();
1116
1117     virtual void childrenChanged(bool changedByParser = false, Node* beforeChange = 0, Node* afterChange = 0, int childCountDelta = 0);
1118
1119     virtual String nodeName() const;
1120     virtual NodeType nodeType() const;
1121     virtual bool childTypeAllowed(NodeType);
1122     virtual PassRefPtr<Node> cloneNode(bool deep);
1123     virtual bool canReplaceChild(Node* newChild, Node* oldChild);
1124
1125     virtual void refScriptExecutionContext() { ref(); }
1126     virtual void derefScriptExecutionContext() { deref(); }
1127
1128     virtual const KURL& virtualURL() const; // Same as url(), but needed for ScriptExecutionContext to implement it without a performance loss for direct calls.
1129     virtual KURL virtualCompleteURL(const String&) const; // Same as completeURL() for the same reason as above.
1130
1131     String encoding() const;
1132
1133     void updateTitle();
1134     void updateFocusAppearanceTimerFired(Timer<Document>*);
1135     void updateBaseURL();
1136
1137     void cacheDocumentElement() const;
1138
1139     void createStyleSelector();
1140
1141     PassRefPtr<NodeList> handleZeroPadding(const HitTestRequest&, HitTestResult&) const;
1142
1143     void loadEventDelayTimerFired(Timer<Document>*);
1144
1145     OwnPtr<CSSStyleSelector> m_styleSelector;
1146     bool m_didCalculateStyleSelector;
1147
1148     Frame* m_frame;
1149     OwnPtr<CachedResourceLoader> m_cachedResourceLoader;
1150     RefPtr<DocumentParser> m_parser;
1151     bool m_wellFormed;
1152
1153     // Document URLs.
1154     KURL m_url; // Document.URL: The URL from which this document was retrieved.
1155     KURL m_baseURL; // Node.baseURI: The URL to use when resolving relative URLs.
1156     KURL m_baseElementURL; // The URL set by the <base> element.
1157     KURL m_cookieURL; // The URL to use for cookie access.
1158     KURL m_firstPartyForCookies; // The policy URL for third-party cookie blocking.
1159
1160     // Document.documentURI:
1161     // Although URL-like, Document.documentURI can actually be set to any
1162     // string by content.  Document.documentURI affects m_baseURL unless the
1163     // document contains a <base> element, in which case the <base> element
1164     // takes precedence.
1165     String m_documentURI;
1166
1167     String m_baseTarget;
1168
1169     RefPtr<DocumentType> m_docType;
1170     mutable RefPtr<DOMImplementation> m_implementation;
1171
1172     // Track the number of currently loading top-level stylesheets needed for rendering.
1173     // Sheets loaded using the @import directive are not included in this count.
1174     // We use this count of pending sheets to detect when we can begin attaching
1175     // elements and when it is safe to execute scripts.
1176     int m_pendingStylesheets;
1177
1178     // But sometimes you need to ignore pending stylesheet count to
1179     // force an immediate layout when requested by JS.
1180     bool m_ignorePendingStylesheets;
1181
1182     // If we do ignore the pending stylesheet count, then we need to add a boolean
1183     // to track that this happened so that we can do a full repaint when the stylesheets
1184     // do eventually load.
1185     PendingSheetLayout m_pendingSheetLayout;
1186     
1187     bool m_hasNodesWithPlaceholderStyle;
1188
1189     RefPtr<CSSStyleSheet> m_elemSheet;
1190     RefPtr<CSSStyleSheet> m_mappedElementSheet;
1191     RefPtr<CSSStyleSheet> m_pageUserSheet;
1192     mutable OwnPtr<Vector<RefPtr<CSSStyleSheet> > > m_pageGroupUserSheets;
1193     mutable bool m_pageGroupUserSheetCacheValid;
1194
1195     bool m_printing;
1196     bool m_paginatedForScreen;
1197
1198     bool m_ignoreAutofocus;
1199
1200     CompatibilityMode m_compatibilityMode;
1201     bool m_compatibilityModeLocked; // This is cheaper than making setCompatibilityMode virtual.
1202
1203     Color m_textColor;
1204
1205     RefPtr<Node> m_focusedNode;
1206     RefPtr<Node> m_hoverNode;
1207     RefPtr<Node> m_activeNode;
1208     mutable RefPtr<Element> m_documentElement;
1209
1210     unsigned m_domTreeVersion;
1211     
1212     HashSet<NodeIterator*> m_nodeIterators;
1213     HashSet<Range*> m_ranges;
1214
1215     unsigned short m_listenerTypes;
1216
1217     RefPtr<StyleSheetList> m_styleSheets; // All of the stylesheets that are currently in effect for our media type and stylesheet set.
1218     
1219     typedef ListHashSet<Node*, 32> StyleSheetCandidateListHashSet;
1220     StyleSheetCandidateListHashSet m_styleSheetCandidateNodes; // All of the nodes that could potentially provide stylesheets to the document (<link>, <style>, <?xml-stylesheet>)
1221
1222     typedef ListHashSet<Element*, 64> FormElementListHashSet;
1223     FormElementListHashSet m_formElementsWithState;
1224     typedef ListHashSet<FormAssociatedElement*, 32> FormAssociatedElementListHashSet;
1225     FormAssociatedElementListHashSet m_formElementsWithFormAttribute;
1226
1227     typedef HashMap<FormElementKey, Vector<String>, FormElementKeyHash, FormElementKeyHashTraits> FormElementStateMap;
1228     FormElementStateMap m_stateForNewFormElements;
1229     
1230     Color m_linkColor;
1231     Color m_visitedLinkColor;
1232     Color m_activeLinkColor;
1233
1234     String m_preferredStylesheetSet;
1235     String m_selectedStylesheetSet;
1236
1237     bool m_loadingSheet;
1238     bool m_visuallyOrdered;
1239     ReadyState m_readyState;
1240     bool m_bParsing;
1241     
1242     Timer<Document> m_styleRecalcTimer;
1243     bool m_pendingStyleRecalcShouldForce;
1244     bool m_inStyleRecalc;
1245     bool m_closeAfterStyleRecalc;
1246
1247     bool m_usesDescendantRules;
1248     bool m_usesSiblingRules;
1249     bool m_usesFirstLineRules;
1250     bool m_usesFirstLetterRules;
1251     bool m_usesBeforeAfterRules;
1252     bool m_usesRemUnits;
1253     bool m_usesLinkRules;
1254     bool m_gotoAnchorNeededAfterStylesheetsLoad;
1255     bool m_isDNSPrefetchEnabled;
1256     bool m_haveExplicitlyDisabledDNSPrefetch;
1257     bool m_frameElementsShouldIgnoreScrolling;
1258     bool m_containsValidityStyleRules;
1259     bool m_updateFocusAppearanceRestoresSelection;
1260
1261     // http://www.whatwg.org/specs/web-apps/current-work/#ignore-destructive-writes-counter
1262     unsigned m_ignoreDestructiveWriteCount;
1263
1264     String m_title;
1265     String m_rawTitle;
1266     bool m_titleSetExplicitly;
1267     RefPtr<Element> m_titleElement;
1268
1269     OwnPtr<RenderArena> m_renderArena;
1270
1271     mutable AXObjectCache* m_axObjectCache;
1272     OwnPtr<DocumentMarkerController> m_markers;
1273     
1274     Timer<Document> m_updateFocusAppearanceTimer;
1275
1276     Element* m_cssTarget;
1277     
1278     bool m_processingLoadEvent;
1279     RefPtr<SerializedScriptValue> m_pendingStateObject;
1280     double m_startTime;
1281     bool m_overMinimumLayoutThreshold;
1282     // This is used to increase the minimum delay between re-layouts. It is set
1283     // using setExtraLayoutDelay to modify the minimum delay used at different
1284     // points during the lifetime of the Document.
1285     int m_extraLayoutDelay;
1286     
1287     OwnPtr<AsyncScriptRunner> m_asyncScriptRunner;
1288
1289 #if ENABLE(XSLT)
1290     OwnPtr<TransformSource> m_transformSource;
1291     RefPtr<Document> m_transformSourceDocument;
1292 #endif
1293
1294     DocumentOrderedMap m_imageMapsByName;
1295
1296     int m_docID; // A unique document identifier used for things like document-specific mapped attributes.
1297
1298     String m_xmlEncoding;
1299     String m_xmlVersion;
1300     bool m_xmlStandalone;
1301
1302     String m_contentLanguage;
1303
1304 #if ENABLE(XHTMLMP)
1305     bool m_shouldProcessNoScriptElement;
1306 #endif
1307
1308     RenderObject* m_savedRenderer;
1309     
1310     RefPtr<TextResourceDecoder> m_decoder;
1311
1312     DocumentOrderedMap m_elementsById;
1313     
1314     mutable HashMap<StringImpl*, Element*, CaseFoldingHash> m_elementsByAccessKey;
1315     
1316     InheritedBool m_designMode;
1317     
1318     int m_selfOnlyRefCount;
1319
1320     CheckedRadioButtons m_checkedRadioButtons;
1321
1322     typedef HashMap<AtomicStringImpl*, CollectionCache*> NamedCollectionMap;
1323     FixedArray<CollectionCache, NumUnnamedDocumentCachedTypes> m_collectionInfo;
1324     FixedArray<NamedCollectionMap, NumNamedDocumentCachedTypes> m_nameCollectionInfo;
1325
1326 #if ENABLE(XPATH)
1327     RefPtr<XPathEvaluator> m_xpathEvaluator;
1328 #endif
1329     
1330 #if ENABLE(SVG)
1331     OwnPtr<SVGDocumentExtensions> m_svgExtensions;
1332 #endif
1333     
1334 #if ENABLE(DASHBOARD_SUPPORT)
1335     Vector<DashboardRegionValue> m_dashboardRegions;
1336     bool m_hasDashboardRegions;
1337     bool m_dashboardRegionsDirty;
1338 #endif
1339
1340     HashMap<String, RefPtr<HTMLCanvasElement> > m_cssCanvasElements;
1341
1342     mutable bool m_accessKeyMapValid;
1343     bool m_createRenderers;
1344     bool m_inPageCache;
1345     String m_iconURL;
1346     
1347     HashSet<Element*> m_documentActivationCallbackElements;
1348     HashSet<Element*> m_mediaVolumeCallbackElements;
1349
1350     bool m_useSecureKeyboardEntryWhenActive;
1351
1352     bool m_isXHTML;
1353     bool m_isHTML;
1354
1355     unsigned m_numNodeListCaches;
1356
1357 #if USE(JSC)
1358     JSWrapperCacheMap m_wrapperCacheMap;
1359     JSWrapperCache* m_normalWorldWrapperCache;
1360 #endif
1361
1362     bool m_usingGeolocation;
1363     
1364     OwnPtr<EventQueue> m_eventQueue;
1365
1366 #if ENABLE(WML)
1367     bool m_containsWMLContent;
1368 #endif
1369
1370     RefPtr<DocumentWeakReference> m_weakReference;
1371
1372     HashSet<MediaCanStartListener*> m_mediaCanStartListeners;
1373
1374     QualifiedName m_idAttributeName;
1375     
1376 #if ENABLE(FULLSCREEN_API)
1377     bool m_isFullScreen;
1378     bool m_areKeysEnabledInFullScreen;
1379     RefPtr<Element> m_fullScreenElement;
1380     RenderFullScreen* m_fullScreenRenderer;
1381     Timer<Document> m_fullScreenChangeDelayTimer;
1382 #endif
1383
1384     int m_loadEventDelayCount;
1385     Timer<Document> m_loadEventDelayTimer;
1386
1387     ViewportArguments m_viewportArguments;
1388
1389     bool m_directionSetOnDocumentElement;
1390     bool m_writingModeSetOnDocumentElement;
1391
1392     DocumentTiming m_documentTiming;
1393     RefPtr<MediaQueryMatcher> m_mediaQueryMatcher;
1394 };
1395
1396 inline bool Document::DocumentOrderedMap::contains(AtomicStringImpl* id) const
1397 {
1398     return m_map.contains(id) || m_duplicateCounts.contains(id);
1399 }
1400
1401 inline bool Document::DocumentOrderedMap::containsMultiple(AtomicStringImpl* id) const
1402 {
1403     return m_duplicateCounts.contains(id);
1404 }
1405
1406 inline bool Document::hasElementWithId(AtomicStringImpl* id) const
1407 {
1408     ASSERT(id);
1409     return m_elementsById.contains(id);
1410 }
1411
1412 inline bool Document::containsMultipleElementsWithId(const AtomicString& id) const
1413 {
1414     return m_elementsById.containsMultiple(id.impl());
1415 }
1416     
1417 inline bool Node::isDocumentNode() const
1418 {
1419     return this == m_document;
1420 }
1421
1422 // here because it uses a Document method but we really want to inline it
1423 inline Node::Node(Document* document, ConstructionType type)
1424     : m_document(document)
1425     , m_previous(0)
1426     , m_next(0)
1427     , m_renderer(0)
1428     , m_nodeFlags(type)
1429 {
1430     if (m_document)
1431         m_document->selfOnlyRef();
1432 #if !defined(NDEBUG) || (defined(DUMP_NODE_STATISTICS) && DUMP_NODE_STATISTICS)
1433     trackForDebugging();
1434 #endif
1435 }
1436
1437 } // namespace WebCore
1438
1439 #endif // Document_h