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