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