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