Keep ElementAttributeData sharing cache open for a while after document parsing finishes.
[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, 2012 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 "CollectionType.h"
32 #include "Color.h"
33 #include "ContainerNode.h"
34 #include "DOMTimeStamp.h"
35 #include "DocumentEventQueue.h"
36 #include "DocumentTiming.h"
37 #include "IconURL.h"
38 #include "InspectorCounters.h"
39 #include "IntRect.h"
40 #include "MutationObserver.h"
41 #include "PageVisibilityState.h"
42 #include "PlatformScreen.h"
43 #include "QualifiedName.h"
44 #include "ReferrerPolicy.h"
45 #include "ScriptExecutionContext.h"
46 #include "StringWithDirection.h"
47 #include "Timer.h"
48 #include "TreeScope.h"
49 #include "ViewportArguments.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 CSSStyleSheet;
63 class CachedCSSStyleSheet;
64 class CachedResourceLoader;
65 class CachedScript;
66 class CanvasRenderingContext;
67 class CharacterData;
68 class Comment;
69 class ContextFeatures;
70 class DOMImplementation;
71 class DOMNamedFlowCollection;
72 class DOMSelection;
73 class DOMWindow;
74 class Database;
75 class DatabaseThread;
76 class DocumentFragment;
77 class DocumentLoader;
78 class DocumentMarkerController;
79 class DocumentParser;
80 class DocumentSharedObjectPool;
81 class DocumentStyleSheetCollection;
82 class DocumentType;
83 class DocumentWeakReference;
84 class Element;
85 class EntityReference;
86 class Event;
87 class EventListener;
88 class FloatRect;
89 class FloatQuad;
90 class FormController;
91 class Frame;
92 class FrameView;
93 class HTMLCanvasElement;
94 class HTMLCollection;
95 class HTMLAllCollection;
96 class HTMLDocument;
97 class HTMLElement;
98 class HTMLFrameOwnerElement;
99 class HTMLHeadElement;
100 class HTMLIFrameElement;
101 class HTMLMapElement;
102 class HTMLNameCollection;
103 class HitTestRequest;
104 class HitTestResult;
105 class IntPoint;
106 class LayoutPoint;
107 class LayoutRect;
108 class LiveNodeListBase;
109 class DOMWrapperWorld;
110 class JSNode;
111 class Locale;
112 class MediaCanStartListener;
113 class MediaQueryList;
114 class MediaQueryMatcher;
115 class MouseEventWithHitTestResults;
116 class NamedFlowCollection;
117 class NodeFilter;
118 class NodeIterator;
119 class Page;
120 class PlatformMouseEvent;
121 class ProcessingInstruction;
122 class Range;
123 class RegisteredEventListener;
124 class RenderArena;
125 class RenderView;
126 class RenderFullScreen;
127 class ScriptableDocumentParser;
128 class ScriptElementData;
129 class ScriptRunner;
130 class SecurityOrigin;
131 class SelectorQueryCache;
132 class SerializedScriptValue;
133 class SegmentedString;
134 class Settings;
135 class StyleResolver;
136 class StyleSheet;
137 class StyleSheetContents;
138 class StyleSheetList;
139 class Text;
140 class TextResourceDecoder;
141 class TreeWalker;
142 class WebKitNamedFlow;
143 class XMLHttpRequest;
144 class XPathEvaluator;
145 class XPathExpression;
146 class XPathNSResolver;
147 class XPathResult;
148
149 #if ENABLE(SVG)
150 class SVGDocumentExtensions;
151 #endif
152
153 #if ENABLE(XSLT)
154 class TransformSource;
155 #endif
156
157 #if ENABLE(DASHBOARD_SUPPORT) || ENABLE(DRAGGABLE_REGION)
158 struct AnnotatedRegionValue;
159 #endif
160
161 #if ENABLE(TOUCH_EVENTS)
162 class Touch;
163 class TouchList;
164 #endif
165
166 #if ENABLE(REQUEST_ANIMATION_FRAME)
167 class RequestAnimationFrameCallback;
168 class ScriptedAnimationController;
169 #endif
170
171 #if ENABLE(MICRODATA)
172 class MicroDataItemList;
173 #endif
174
175 #if ENABLE(LINK_PRERENDER)
176 class Prerenderer;
177 #endif
178
179 #if ENABLE(TEXT_AUTOSIZING)
180 class TextAutosizer;
181 #endif
182
183 #if ENABLE(CSP_NEXT)
184 class DOMSecurityPolicy;
185 #endif
186
187 typedef int ExceptionCode;
188
189 enum PageshowEventPersistence {
190     PageshowEventNotPersisted = 0,
191     PageshowEventPersisted = 1
192 };
193
194 enum StyleResolverUpdateFlag { RecalcStyleImmediately, DeferRecalcStyle, RecalcStyleIfNeeded };
195
196 enum NodeListInvalidationType {
197     DoNotInvalidateOnAttributeChanges = 0,
198     InvalidateOnClassAttrChange,
199     InvalidateOnIdNameAttrChange,
200     InvalidateOnNameAttrChange,
201     InvalidateOnForAttrChange,
202     InvalidateForFormControls,
203     InvalidateOnHRefAttrChange,
204     InvalidateOnItemAttrChange,
205     InvalidateOnAnyAttrChange,
206 };
207 const int numNodeListInvalidationTypes = InvalidateOnAnyAttrChange + 1;
208
209 class Document : public ContainerNode, public TreeScope, public ScriptExecutionContext {
210 public:
211     static PassRefPtr<Document> create(Frame* frame, const KURL& url)
212     {
213         return adoptRef(new Document(frame, url, false, false));
214     }
215     static PassRefPtr<Document> createXHTML(Frame* frame, const KURL& url)
216     {
217         return adoptRef(new Document(frame, url, true, false));
218     }
219     virtual ~Document();
220
221     MediaQueryMatcher* mediaQueryMatcher();
222
223     using ContainerNode::ref;
224     using ContainerNode::deref;
225
226     // Nodes belonging to this document hold guard references -
227     // these are enough to keep the document from being destroyed, but
228     // not enough to keep it from removing its children. This allows a
229     // node that outlives its document to still have a valid document
230     // pointer without introducing reference cycles.
231     void guardRef()
232     {
233         ASSERT(!m_deletionHasBegun);
234         ++m_guardRefCount;
235     }
236
237     void guardDeref()
238     {
239         ASSERT(!m_deletionHasBegun);
240         --m_guardRefCount;
241         if (!m_guardRefCount && !refCount()) {
242 #ifndef NDEBUG
243             m_deletionHasBegun = true;
244 #endif
245             delete this;
246         }
247     }
248
249     Element* getElementById(const AtomicString& id) const;
250
251     virtual bool canContainRangeEndPoint() const { return true; }
252
253     Element* getElementByAccessKey(const String& key);
254     void invalidateAccessKeyMap();
255
256     SelectorQueryCache* selectorQueryCache();
257
258     // DOM methods & attributes for Document
259
260     DEFINE_ATTRIBUTE_EVENT_LISTENER(abort);
261     DEFINE_ATTRIBUTE_EVENT_LISTENER(change);
262     DEFINE_ATTRIBUTE_EVENT_LISTENER(click);
263     DEFINE_ATTRIBUTE_EVENT_LISTENER(contextmenu);
264     DEFINE_ATTRIBUTE_EVENT_LISTENER(dblclick);
265     DEFINE_ATTRIBUTE_EVENT_LISTENER(dragenter);
266     DEFINE_ATTRIBUTE_EVENT_LISTENER(dragover);
267     DEFINE_ATTRIBUTE_EVENT_LISTENER(dragleave);
268     DEFINE_ATTRIBUTE_EVENT_LISTENER(drop);
269     DEFINE_ATTRIBUTE_EVENT_LISTENER(dragstart);
270     DEFINE_ATTRIBUTE_EVENT_LISTENER(drag);
271     DEFINE_ATTRIBUTE_EVENT_LISTENER(dragend);
272     DEFINE_ATTRIBUTE_EVENT_LISTENER(input);
273     DEFINE_ATTRIBUTE_EVENT_LISTENER(invalid);
274     DEFINE_ATTRIBUTE_EVENT_LISTENER(keydown);
275     DEFINE_ATTRIBUTE_EVENT_LISTENER(keypress);
276     DEFINE_ATTRIBUTE_EVENT_LISTENER(keyup);
277     DEFINE_ATTRIBUTE_EVENT_LISTENER(mousedown);
278     DEFINE_ATTRIBUTE_EVENT_LISTENER(mousemove);
279     DEFINE_ATTRIBUTE_EVENT_LISTENER(mouseout);
280     DEFINE_ATTRIBUTE_EVENT_LISTENER(mouseover);
281     DEFINE_ATTRIBUTE_EVENT_LISTENER(mouseup);
282     DEFINE_ATTRIBUTE_EVENT_LISTENER(mousewheel);
283     DEFINE_ATTRIBUTE_EVENT_LISTENER(scroll);
284     DEFINE_ATTRIBUTE_EVENT_LISTENER(select);
285     DEFINE_ATTRIBUTE_EVENT_LISTENER(submit);
286
287     DEFINE_ATTRIBUTE_EVENT_LISTENER(blur);
288     DEFINE_ATTRIBUTE_EVENT_LISTENER(error);
289     DEFINE_ATTRIBUTE_EVENT_LISTENER(focus);
290     DEFINE_ATTRIBUTE_EVENT_LISTENER(load);
291     DEFINE_ATTRIBUTE_EVENT_LISTENER(readystatechange);
292
293     // WebKit extensions
294     DEFINE_ATTRIBUTE_EVENT_LISTENER(beforecut);
295     DEFINE_ATTRIBUTE_EVENT_LISTENER(cut);
296     DEFINE_ATTRIBUTE_EVENT_LISTENER(beforecopy);
297     DEFINE_ATTRIBUTE_EVENT_LISTENER(copy);
298     DEFINE_ATTRIBUTE_EVENT_LISTENER(beforepaste);
299     DEFINE_ATTRIBUTE_EVENT_LISTENER(paste);
300     DEFINE_ATTRIBUTE_EVENT_LISTENER(reset);
301     DEFINE_ATTRIBUTE_EVENT_LISTENER(search);
302     DEFINE_ATTRIBUTE_EVENT_LISTENER(selectstart);
303     DEFINE_ATTRIBUTE_EVENT_LISTENER(selectionchange);
304 #if ENABLE(TOUCH_EVENTS)
305     DEFINE_ATTRIBUTE_EVENT_LISTENER(touchstart);
306     DEFINE_ATTRIBUTE_EVENT_LISTENER(touchmove);
307     DEFINE_ATTRIBUTE_EVENT_LISTENER(touchend);
308     DEFINE_ATTRIBUTE_EVENT_LISTENER(touchcancel);
309 #endif
310 #if ENABLE(FULLSCREEN_API)
311     DEFINE_ATTRIBUTE_EVENT_LISTENER(webkitfullscreenchange);
312     DEFINE_ATTRIBUTE_EVENT_LISTENER(webkitfullscreenerror);
313 #endif
314 #if ENABLE(POINTER_LOCK)
315     DEFINE_ATTRIBUTE_EVENT_LISTENER(webkitpointerlockchange);
316     DEFINE_ATTRIBUTE_EVENT_LISTENER(webkitpointerlockerror);
317 #endif
318 #if ENABLE(PAGE_VISIBILITY_API)
319     DEFINE_ATTRIBUTE_EVENT_LISTENER(webkitvisibilitychange);
320 #endif
321
322     void setViewportArguments(const ViewportArguments& viewportArguments) { m_viewportArguments = viewportArguments; }
323     ViewportArguments viewportArguments() const { return m_viewportArguments; }
324 #ifndef NDEBUG
325     bool didDispatchViewportPropertiesChanged() const { return m_didDispatchViewportPropertiesChanged; }
326 #endif
327
328     void setReferrerPolicy(ReferrerPolicy referrerPolicy) { m_referrerPolicy = referrerPolicy; }
329     ReferrerPolicy referrerPolicy() const { return m_referrerPolicy; }
330
331     DocumentType* doctype() const { return m_docType.get(); }
332
333     DOMImplementation* implementation();
334     
335     Element* documentElement() const
336     {
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     bool cssStickyPositionEnabled() const;
355     bool cssRegionsEnabled() const;
356 #if ENABLE(CSS_REGIONS)
357     PassRefPtr<DOMNamedFlowCollection> webkitGetNamedFlows();
358 #endif
359
360     NamedFlowCollection* namedFlows();
361
362     bool regionBasedColumnsEnabled() const;
363
364     bool cssGridLayoutEnabled() const;
365
366     /**
367      * Retrieve all nodes that intersect a rect in the window's document, until it is fully enclosed by
368      * the boundaries of a node.
369      *
370      * @param centerX x reference for the rectangle in CSS pixels
371      * @param centerY y reference for the rectangle in CSS pixels
372      * @param topPadding How much to expand the top of the rectangle
373      * @param rightPadding How much to expand the right of the rectangle
374      * @param bottomPadding How much to expand the bottom of the rectangle
375      * @param leftPadding How much to expand the left of the rectangle
376      * @param ignoreClipping whether or not to ignore the root scroll frame when retrieving the element.
377      *        If false, this method returns null for coordinates outside of the viewport.
378      */
379     PassRefPtr<NodeList> nodesFromRect(int centerX, int centerY, unsigned topPadding, unsigned rightPadding,
380                                        unsigned bottomPadding, unsigned leftPadding, bool ignoreClipping, bool allowShadowContent) const;
381     Element* elementFromPoint(int x, int y) const;
382     PassRefPtr<Range> caretRangeFromPoint(int x, int y);
383
384     String readyState() const;
385
386     String defaultCharset() const;
387
388     String inputEncoding() const { return Document::encoding(); }
389     String charset() const { return Document::encoding(); }
390     String characterSet() const { return Document::encoding(); }
391
392     String encoding() const;
393
394     void setCharset(const String&);
395
396     void setContent(const String&);
397
398     String suggestedMIMEType() const;
399
400     String contentLanguage() const { return m_contentLanguage; }
401     void setContentLanguage(const String&);
402
403     String xmlEncoding() const { return m_xmlEncoding; }
404     String xmlVersion() const { return m_xmlVersion; }
405     enum StandaloneStatus { StandaloneUnspecified, Standalone, NotStandalone };
406     bool xmlStandalone() const { return m_xmlStandalone == Standalone; }
407     StandaloneStatus xmlStandaloneStatus() const { return static_cast<StandaloneStatus>(m_xmlStandalone); }
408     bool hasXMLDeclaration() const { return m_hasXMLDeclaration; }
409
410     void setXMLEncoding(const String& encoding) { m_xmlEncoding = encoding; } // read-only property, only to be set from XMLDocumentParser
411     void setXMLVersion(const String&, ExceptionCode&);
412     void setXMLStandalone(bool, ExceptionCode&);
413     void setHasXMLDeclaration(bool hasXMLDeclaration) { m_hasXMLDeclaration = hasXMLDeclaration ? 1 : 0; }
414
415     String documentURI() const { return m_documentURI; }
416     void setDocumentURI(const String&);
417
418     virtual KURL baseURI() const;
419
420 #if ENABLE(PAGE_VISIBILITY_API)
421     String webkitVisibilityState() const;
422     bool webkitHidden() const;
423     void dispatchVisibilityStateChangeEvent();
424 #endif
425
426 #if ENABLE(CSP_NEXT)
427     DOMSecurityPolicy* securityPolicy();
428 #endif
429
430     PassRefPtr<Node> adoptNode(PassRefPtr<Node> source, ExceptionCode&);
431
432     PassRefPtr<HTMLCollection> images();
433     PassRefPtr<HTMLCollection> embeds();
434     PassRefPtr<HTMLCollection> plugins(); // an alias for embeds() required for the JS DOM bindings.
435     PassRefPtr<HTMLCollection> applets();
436     PassRefPtr<HTMLCollection> links();
437     PassRefPtr<HTMLCollection> forms();
438     PassRefPtr<HTMLCollection> anchors();
439     PassRefPtr<HTMLCollection> scripts();
440     PassRefPtr<HTMLCollection> all();
441
442     PassRefPtr<HTMLCollection> windowNamedItems(const AtomicString& name);
443     PassRefPtr<HTMLCollection> documentNamedItems(const AtomicString& name);
444
445     // Other methods (not part of DOM)
446     bool isHTMLDocument() const { return m_isHTML; }
447     bool isXHTMLDocument() const { return m_isXHTML; }
448     virtual bool isImageDocument() const { return false; }
449 #if ENABLE(SVG)
450     virtual bool isSVGDocument() const { return false; }
451     bool hasSVGRootNode() const;
452 #else
453     static bool isSVGDocument() { return false; }
454     static bool hasSVGRootNode() { return false; }
455 #endif
456     virtual bool isPluginDocument() const { return false; }
457     virtual bool isMediaDocument() const { return false; }
458     virtual bool isFrameSet() const { return false; }
459
460     bool isSrcdocDocument() const { return m_isSrcdocDocument; }
461
462     StyleResolver* styleResolverIfExists() const { return m_styleResolver.get(); }
463
464     bool isViewSource() const { return m_isViewSource; }
465     void setIsViewSource(bool);
466
467     bool sawElementsInKnownNamespaces() const { return m_sawElementsInKnownNamespaces; }
468
469     StyleResolver* styleResolver()
470     { 
471         if (!m_styleResolver)
472             createStyleResolver();
473         return m_styleResolver.get();
474     }
475
476     void notifyRemovePendingSheetIfNeeded();
477
478     bool haveStylesheetsLoaded() const;
479
480     // This is a DOM function.
481     StyleSheetList* styleSheets();
482
483     DocumentStyleSheetCollection* styleSheetCollection() { return m_styleSheetCollection.get(); }
484
485     bool gotoAnchorNeededAfterStylesheetsLoad() { return m_gotoAnchorNeededAfterStylesheetsLoad; }
486     void setGotoAnchorNeededAfterStylesheetsLoad(bool b) { m_gotoAnchorNeededAfterStylesheetsLoad = b; }
487
488     /**
489      * Called when one or more stylesheets in the document may have been added, removed or changed.
490      *
491      * Creates a new style resolver and assign it to this document. This is done by iterating through all nodes in
492      * document (or those before <BODY> in a HTML document), searching for stylesheets. Stylesheets can be contained in
493      * <LINK>, <STYLE> or <BODY> elements, as well as processing instructions (XML documents only). A list is
494      * constructed from these which is used to create the a new style selector which collates all of the stylesheets
495      * found and is used to calculate the derived styles for all rendering objects.
496      */
497     void styleResolverChanged(StyleResolverUpdateFlag);
498
499     void evaluateMediaQueryList();
500
501     // Never returns 0.
502     FormController* formController();
503     Vector<String> formElementsState() const;
504     void setStateForNewFormElements(const Vector<String>&);
505
506     FrameView* view() const; // can be NULL
507     Frame* frame() const { return m_frame; } // can be NULL
508     Page* page() const; // can be NULL
509     Settings* settings() const; // can be NULL
510
511     PassRefPtr<Range> createRange();
512
513     PassRefPtr<NodeIterator> createNodeIterator(Node* root, unsigned whatToShow,
514         PassRefPtr<NodeFilter>, bool expandEntityReferences, ExceptionCode&);
515
516     PassRefPtr<TreeWalker> createTreeWalker(Node* root, unsigned whatToShow,
517         PassRefPtr<NodeFilter>, bool expandEntityReferences, ExceptionCode&);
518
519     // Special support for editing
520     PassRefPtr<CSSStyleDeclaration> createCSSStyleDeclaration();
521     PassRefPtr<Text> createEditingTextNode(const String&);
522
523     void recalcStyle(StyleChange = NoChange);
524     bool childNeedsAndNotInStyleRecalc();
525     void updateStyleIfNeeded();
526     void updateLayout();
527     void updateLayoutIgnorePendingStylesheets();
528     PassRefPtr<RenderStyle> styleForElementIgnoringPendingStylesheets(Element*);
529     PassRefPtr<RenderStyle> styleForPage(int pageIndex);
530
531     // Returns true if page box (margin boxes and page borders) is visible.
532     bool isPageBoxVisible(int pageIndex);
533
534     // Returns the preferred page size and margins in pixels, assuming 96
535     // pixels per inch. pageSize, marginTop, marginRight, marginBottom,
536     // marginLeft must be initialized to the default values that are used if
537     // auto is specified.
538     void pageSizeAndMarginsInPixels(int pageIndex, IntSize& pageSize, int& marginTop, int& marginRight, int& marginBottom, int& marginLeft);
539
540     static void updateStyleForAllDocuments(); // FIXME: Try to reduce the # of calls to this function.
541     CachedResourceLoader* cachedResourceLoader() { return m_cachedResourceLoader.get(); }
542
543     virtual void attach();
544     virtual void detach();
545     void prepareForDestruction();
546
547     // Override ScriptExecutionContext methods to do additional work
548     virtual void suspendActiveDOMObjects(ActiveDOMObject::ReasonForSuspension) OVERRIDE;
549     virtual void resumeActiveDOMObjects() OVERRIDE;
550
551     RenderArena* renderArena() { return m_renderArena.get(); }
552
553     // Implemented in RenderView.h to avoid a cyclic header dependency this just
554     // returns renderer so callers can avoid verbose casts.
555     RenderView* renderView() const;
556
557     // Shadow the implementations on Node to provide faster access for documents.
558     RenderObject* renderer() const { return m_renderer; }
559     void setRenderer(RenderObject* renderer)
560     {
561         m_renderer = renderer;
562         Node::setRenderer(renderer);
563     }
564
565     void clearAXObjectCache();
566     AXObjectCache* axObjectCache() const;
567     bool axObjectCacheExists() const;
568     
569     // to get visually ordered hebrew and arabic pages right
570     void setVisuallyOrdered();
571     bool visuallyOrdered() const { return m_visuallyOrdered; }
572     
573     DocumentLoader* loader() const;
574
575     void open(Document* ownerDocument = 0);
576     void implicitOpen();
577
578     // close() is the DOM API document.close()
579     void close();
580     // In some situations (see the code), we ignore document.close().
581     // explicitClose() bypass these checks and actually tries to close the
582     // input stream.
583     void explicitClose();
584     // implicitClose() actually does the work of closing the input stream.
585     void implicitClose();
586
587     void cancelParsing();
588
589     void write(const SegmentedString& text, Document* ownerDocument = 0);
590     void write(const String& text, Document* ownerDocument = 0);
591     void writeln(const String& text, Document* ownerDocument = 0);
592
593     bool wellFormed() const { return m_wellFormed; }
594
595     const KURL& url() const { return m_url; }
596     void setURL(const KURL&);
597
598     // To understand how these concepts relate to one another, please see the
599     // comments surrounding their declaration.
600     const KURL& baseURL() const { return m_baseURL; }
601     void setBaseURLOverride(const KURL&);
602     const KURL& baseURLOverride() const { return m_baseURLOverride; }
603     const KURL& baseElementURL() const { return m_baseElementURL; }
604     const String& baseTarget() const { return m_baseTarget; }
605     void processBaseElement();
606
607     KURL completeURL(const String&) const;
608     KURL completeURL(const String&, const KURL& baseURLOverride) const;
609
610     virtual String userAgent(const KURL&) const;
611
612     virtual void disableEval(const String& errorMessage);
613
614     bool canNavigate(Frame* targetFrame);
615     Frame* findUnsafeParentScrollPropagationBoundary();
616
617     CSSStyleSheet* elementSheet();
618     
619     virtual PassRefPtr<DocumentParser> createParser();
620     DocumentParser* parser() const { return m_parser.get(); }
621     ScriptableDocumentParser* scriptableDocumentParser() const;
622     
623     bool printing() const { return m_printing; }
624     void setPrinting(bool p) { m_printing = p; }
625
626     bool paginatedForScreen() const { return m_paginatedForScreen; }
627     void setPaginatedForScreen(bool p) { m_paginatedForScreen = p; }
628     
629     bool paginated() const { return printing() || paginatedForScreen(); }
630
631     enum CompatibilityMode { QuirksMode, LimitedQuirksMode, NoQuirksMode };
632
633     virtual void setCompatibilityModeFromDoctype() { }
634     void setCompatibilityMode(CompatibilityMode m);
635     void lockCompatibilityMode() { m_compatibilityModeLocked = true; }
636     CompatibilityMode compatibilityMode() const { return m_compatibilityMode; }
637
638     String compatMode() const;
639
640     bool inQuirksMode() const { return m_compatibilityMode == QuirksMode; }
641     bool inLimitedQuirksMode() const { return m_compatibilityMode == LimitedQuirksMode; }
642     bool inNoQuirksMode() const { return m_compatibilityMode == NoQuirksMode; }
643
644     enum ReadyState {
645         Loading,
646         Interactive,
647         Complete
648     };
649     void setReadyState(ReadyState);
650     void setParsing(bool);
651     bool parsing() const { return m_bParsing; }
652     int minimumLayoutDelay();
653
654     bool shouldScheduleLayout();
655     bool isLayoutTimerActive();
656     int elapsedTime() const;
657     
658     void setTextColor(const Color& color) { m_textColor = color; }
659     Color textColor() const { return m_textColor; }
660
661     const Color& linkColor() const { return m_linkColor; }
662     const Color& visitedLinkColor() const { return m_visitedLinkColor; }
663     const Color& activeLinkColor() const { return m_activeLinkColor; }
664     void setLinkColor(const Color& c) { m_linkColor = c; }
665     void setVisitedLinkColor(const Color& c) { m_visitedLinkColor = c; }
666     void setActiveLinkColor(const Color& c) { m_activeLinkColor = c; }
667     void resetLinkColor();
668     void resetVisitedLinkColor();
669     void resetActiveLinkColor();
670     
671     MouseEventWithHitTestResults prepareMouseEvent(const HitTestRequest&, const LayoutPoint&, const PlatformMouseEvent&);
672
673     /* Newly proposed CSS3 mechanism for selecting alternate
674        stylesheets using the DOM. May be subject to change as
675        spec matures. - dwh
676     */
677     String preferredStylesheetSet() const;
678     String selectedStylesheetSet() const;
679     void setSelectedStylesheetSet(const String&);
680
681     bool setFocusedNode(PassRefPtr<Node>);
682     Node* focusedNode() const { return m_focusedNode.get(); }
683
684     void getFocusableNodes(Vector<RefPtr<Node> >&);
685     
686     // The m_ignoreAutofocus flag specifies whether or not the document has been changed by the user enough 
687     // for WebCore to ignore the autofocus attribute on any form controls
688     bool ignoreAutofocus() const { return m_ignoreAutofocus; };
689     void setIgnoreAutofocus(bool shouldIgnore = true) { m_ignoreAutofocus = shouldIgnore; };
690
691     void setHoverNode(PassRefPtr<Node>);
692     Node* hoverNode() const { return m_hoverNode.get(); }
693
694     void setActiveNode(PassRefPtr<Node>);
695     Node* activeNode() const { return m_activeNode.get(); }
696
697     void focusedNodeRemoved();
698     void removeFocusedNodeOfSubtree(Node*, bool amongChildrenOnly = false);
699     void hoveredNodeDetached(Node*);
700     void activeChainNodeDetached(Node*);
701
702     void updateHoverActiveState(const HitTestRequest&, HitTestResult&);
703
704     // Updates for :target (CSS3 selector).
705     void setCSSTarget(Element*);
706     Element* cssTarget() const { return m_cssTarget; }
707     
708     void scheduleForcedStyleRecalc();
709     void scheduleStyleRecalc();
710     void unscheduleStyleRecalc();
711     bool hasPendingStyleRecalc() const;
712     bool hasPendingForcedStyleRecalc() const;
713     void styleRecalcTimerFired(Timer<Document>*);
714
715     void registerNodeList(LiveNodeListBase*);
716     void unregisterNodeList(LiveNodeListBase*);
717     bool shouldInvalidateNodeListCaches(const QualifiedName* attrName = 0) const;
718     void invalidateNodeListCaches(const QualifiedName* attrName);
719
720     void attachNodeIterator(NodeIterator*);
721     void detachNodeIterator(NodeIterator*);
722     void moveNodeIteratorsToNewDocument(Node*, Document*);
723
724     void attachRange(Range*);
725     void detachRange(Range*);
726
727     void updateRangesAfterChildrenChanged(ContainerNode*);
728     // nodeChildrenWillBeRemoved is used when removing all node children at once.
729     void nodeChildrenWillBeRemoved(ContainerNode*);
730     // nodeWillBeRemoved is only safe when removing one node at a time.
731     void nodeWillBeRemoved(Node*);
732     bool canReplaceChild(Node* newChild, Node* oldChild);
733
734     void textInserted(Node*, unsigned offset, unsigned length);
735     void textRemoved(Node*, unsigned offset, unsigned length);
736     void textNodesMerged(Text* oldNode, unsigned offset);
737     void textNodeSplit(Text* oldNode);
738
739     void createDOMWindow();
740     void takeDOMWindowFrom(Document*);
741
742     DOMWindow* domWindow() const { return m_domWindow.get(); }
743     // In DOM Level 2, the Document's DOMWindow is called the defaultView.
744     DOMWindow* defaultView() const { return domWindow(); } 
745
746     // Helper functions for forwarding DOMWindow event related tasks to the DOMWindow if it exists.
747     void setWindowAttributeEventListener(const AtomicString& eventType, PassRefPtr<EventListener>);
748     EventListener* getWindowAttributeEventListener(const AtomicString& eventType);
749     void dispatchWindowEvent(PassRefPtr<Event>, PassRefPtr<EventTarget> = 0);
750     void dispatchWindowLoadEvent();
751
752     PassRefPtr<Event> createEvent(const String& eventType, ExceptionCode&);
753
754     // keep track of what types of event listeners are registered, so we don't
755     // dispatch events unnecessarily
756     enum ListenerType {
757         DOMSUBTREEMODIFIED_LISTENER          = 1,
758         DOMNODEINSERTED_LISTENER             = 1 << 1,
759         DOMNODEREMOVED_LISTENER              = 1 << 2,
760         DOMNODEREMOVEDFROMDOCUMENT_LISTENER  = 1 << 3,
761         DOMNODEINSERTEDINTODOCUMENT_LISTENER = 1 << 4,
762         DOMCHARACTERDATAMODIFIED_LISTENER    = 1 << 5,
763         OVERFLOWCHANGED_LISTENER             = 1 << 6,
764         ANIMATIONEND_LISTENER                = 1 << 7,
765         ANIMATIONSTART_LISTENER              = 1 << 8,
766         ANIMATIONITERATION_LISTENER          = 1 << 9,
767         TRANSITIONEND_LISTENER               = 1 << 10,
768         BEFORELOAD_LISTENER                  = 1 << 11,
769         SCROLL_LISTENER                      = 1 << 12
770         // 3 bits remaining
771     };
772
773     bool hasListenerType(ListenerType listenerType) const { return (m_listenerTypes & listenerType); }
774     void addListenerTypeIfNeeded(const AtomicString& eventType);
775
776 #if ENABLE(MUTATION_OBSERVERS)
777     bool hasMutationObserversOfType(MutationObserver::MutationType type) const
778     {
779         return m_mutationObserverTypes & type;
780     }
781     bool hasMutationObservers() const { return m_mutationObserverTypes; }
782     void addMutationObserverTypes(MutationObserverOptions types) { m_mutationObserverTypes |= types; }
783 #endif
784
785     CSSStyleDeclaration* getOverrideStyle(Element*, const String& pseudoElt);
786
787     int nodeAbsIndex(Node*);
788     Node* nodeWithAbsIndex(int absIndex);
789
790     /**
791      * Handles a HTTP header equivalent set by a meta tag using <meta http-equiv="..." content="...">. This is called
792      * when a meta tag is encountered during document parsing, and also when a script dynamically changes or adds a meta
793      * tag. This enables scripts to use meta tags to perform refreshes and set expiry dates in addition to them being
794      * specified in a HTML file.
795      *
796      * @param equiv The http header name (value of the meta tag's "equiv" attribute)
797      * @param content The header value (value of the meta tag's "content" attribute)
798      */
799     void processHttpEquiv(const String& equiv, const String& content);
800     void processViewport(const String& features, ViewportArguments::Type origin);
801     void updateViewportArguments();
802     void processReferrerPolicy(const String& policy);
803
804     // Returns the owning element in the parent document.
805     // Returns 0 if this is the top level document.
806     HTMLFrameOwnerElement* ownerElement() const;
807
808     HTMLIFrameElement* seamlessParentIFrame() const;
809     bool shouldDisplaySeamlesslyWithParent() const;
810
811     // Used by DOM bindings; no direction known.
812     String title() const { return m_title.string(); }
813     void setTitle(const String&);
814
815     void setTitleElement(const StringWithDirection&, Element* titleElement);
816     void removeTitle(Element* titleElement);
817
818     String cookie(ExceptionCode&) const;
819     void setCookie(const String&, ExceptionCode&);
820
821     String referrer() const;
822
823     String domain() const;
824     void setDomain(const String& newDomain, ExceptionCode&);
825
826     String lastModified() const;
827
828     // The cookieURL is used to query the cookie database for this document's
829     // cookies. For example, if the cookie URL is http://example.com, we'll
830     // use the non-Secure cookies for example.com when computing
831     // document.cookie.
832     //
833     // Q: How is the cookieURL different from the document's URL?
834     // A: The two URLs are the same almost all the time.  However, if one
835     //    document inherits the security context of another document, it
836     //    inherits its cookieURL but not its URL.
837     //
838     const KURL& cookieURL() const { return m_cookieURL; }
839     void setCookieURL(const KURL& url) { m_cookieURL = url; }
840
841     // The firstPartyForCookies is used to compute whether this document
842     // appears in a "third-party" context for the purpose of third-party
843     // cookie blocking.  The document is in a third-party context if the
844     // cookieURL and the firstPartyForCookies are from different hosts.
845     //
846     // Note: Some ports (including possibly Apple's) only consider the
847     //       document in a third-party context if the cookieURL and the
848     //       firstPartyForCookies have a different registry-controlled
849     //       domain.
850     //
851     const KURL& firstPartyForCookies() const { return m_firstPartyForCookies; }
852     void setFirstPartyForCookies(const KURL& url) { m_firstPartyForCookies = url; }
853     
854     // The following implements the rule from HTML 4 for what valid names are.
855     // To get this right for all the XML cases, we probably have to improve this or move it
856     // and make it sensitive to the type of document.
857     static bool isValidName(const String&);
858
859     // The following breaks a qualified name into a prefix and a local name.
860     // It also does a validity check, and returns false if the qualified name
861     // is invalid.  It also sets ExceptionCode when name is invalid.
862     static bool parseQualifiedName(const String& qualifiedName, String& prefix, String& localName, ExceptionCode&);
863
864     // Checks to make sure prefix and namespace do not conflict (per DOM Core 3)
865     static bool hasValidNamespaceForElements(const QualifiedName&);
866     static bool hasValidNamespaceForAttributes(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     bool hasNodesWithPlaceholderStyle() const { return m_hasNodesWithPlaceholderStyle; }
933     void setHasNodesWithPlaceholderStyle() { m_hasNodesWithPlaceholderStyle = true; }
934
935     const Vector<IconURL>& iconURLs();
936     void addIconURL(const String& url, const String& mimeType, const String& size, IconType);
937
938     void setUseSecureKeyboardEntryWhenActive(bool);
939     bool useSecureKeyboardEntryWhenActive() const;
940
941     void updateFocusAppearanceSoon(bool restorePreviousSelection);
942     void cancelFocusAppearanceUpdate();
943         
944     // Extension for manipulating canvas drawing contexts for use in CSS
945     CanvasRenderingContext* getCSSCanvasContext(const String& type, const String& name, int width, int height);
946     HTMLCanvasElement* getCSSCanvasElement(const String& name);
947
948     bool isDNSPrefetchEnabled() const { return m_isDNSPrefetchEnabled; }
949     void parseDNSPrefetchControlHeader(const String&);
950
951     virtual void postTask(PassOwnPtr<Task>); // Executes the task on context's thread asynchronously.
952
953     virtual void suspendScriptedAnimationControllerCallbacks();
954     virtual void resumeScriptedAnimationControllerCallbacks();
955     
956     void windowScreenDidChange(PlatformDisplayID);
957
958     virtual void finishedParsing();
959
960     bool inPageCache() const { return m_inPageCache; }
961     void setInPageCache(bool flag);
962
963     // Elements can register themselves for the "documentWillSuspendForPageCache()" and  
964     // "documentDidResumeFromPageCache()" callbacks
965     void registerForPageCacheSuspensionCallbacks(Element*);
966     void unregisterForPageCacheSuspensionCallbacks(Element*);
967
968     void documentWillBecomeInactive();
969     void documentWillSuspendForPageCache();
970     void documentDidResumeFromPageCache();
971
972     void registerForMediaVolumeCallbacks(Element*);
973     void unregisterForMediaVolumeCallbacks(Element*);
974     void mediaVolumeDidChange();
975
976     void registerForPrivateBrowsingStateChangedCallbacks(Element*);
977     void unregisterForPrivateBrowsingStateChangedCallbacks(Element*);
978     void storageBlockingStateDidChange();
979     void privateBrowsingStateDidChange();
980
981     void setShouldCreateRenderers(bool);
982     bool shouldCreateRenderers();
983
984     void setDecoder(PassRefPtr<TextResourceDecoder>);
985     TextResourceDecoder* decoder() const { return m_decoder.get(); }
986
987     String displayStringModifiedByEncoding(const String&) const;
988     PassRefPtr<StringImpl> displayStringModifiedByEncoding(PassRefPtr<StringImpl>) const;
989     void displayBufferModifiedByEncoding(LChar* buffer, unsigned len) const
990     {
991         displayBufferModifiedByEncodingInternal(buffer, len);
992     }
993     void displayBufferModifiedByEncoding(UChar* buffer, unsigned len) const
994     {
995         displayBufferModifiedByEncodingInternal(buffer, len);
996     }
997
998     // Quirk for the benefit of Apple's Dictionary application.
999     void setFrameElementsShouldIgnoreScrolling(bool ignore) { m_frameElementsShouldIgnoreScrolling = ignore; }
1000     bool frameElementsShouldIgnoreScrolling() const { return m_frameElementsShouldIgnoreScrolling; }
1001
1002 #if ENABLE(DASHBOARD_SUPPORT) || ENABLE(DRAGGABLE_REGION)
1003     void setAnnotatedRegionsDirty(bool f) { m_annotatedRegionsDirty = f; }
1004     bool annotatedRegionsDirty() const { return m_annotatedRegionsDirty; }
1005     bool hasAnnotatedRegions () const { return m_hasAnnotatedRegions; }
1006     void setHasAnnotatedRegions(bool f) { m_hasAnnotatedRegions = f; }
1007     const Vector<AnnotatedRegionValue>& annotatedRegions() const;
1008     void setAnnotatedRegions(const Vector<AnnotatedRegionValue>&);
1009 #endif
1010
1011     virtual void removeAllEventListeners();
1012
1013 #if ENABLE(SVG)
1014     const SVGDocumentExtensions* svgExtensions();
1015     SVGDocumentExtensions* accessSVGExtensions();
1016 #endif
1017
1018     void initSecurityContext();
1019     void initContentSecurityPolicy();
1020
1021     void updateURLForPushOrReplaceState(const KURL&);
1022     void statePopped(PassRefPtr<SerializedScriptValue>);
1023
1024     bool processingLoadEvent() const { return m_processingLoadEvent; }
1025     bool loadEventFinished() const { return m_loadEventFinished; }
1026
1027     virtual bool isContextThread() const;
1028     virtual bool isJSExecutionForbidden() const { return false; }
1029
1030     bool containsValidityStyleRules() const { return m_containsValidityStyleRules; }
1031     void setContainsValidityStyleRules() { m_containsValidityStyleRules = true; }
1032
1033     void enqueueWindowEvent(PassRefPtr<Event>);
1034     void enqueueDocumentEvent(PassRefPtr<Event>);
1035     void enqueuePageshowEvent(PageshowEventPersistence);
1036     void enqueueHashchangeEvent(const String& oldURL, const String& newURL);
1037     void enqueuePopstateEvent(PassRefPtr<SerializedScriptValue> stateObject);
1038     virtual DocumentEventQueue* eventQueue() const { return m_eventQueue.get(); }
1039
1040     void addMediaCanStartListener(MediaCanStartListener*);
1041     void removeMediaCanStartListener(MediaCanStartListener*);
1042     MediaCanStartListener* takeAnyMediaCanStartListener();
1043
1044     const QualifiedName& idAttributeName() const { return m_idAttributeName; }
1045     
1046 #if ENABLE(FULLSCREEN_API)
1047     bool webkitIsFullScreen() const { return m_fullScreenElement.get(); }
1048     bool webkitFullScreenKeyboardInputAllowed() const { return m_fullScreenElement.get() && m_areKeysEnabledInFullScreen; }
1049     Element* webkitCurrentFullScreenElement() const { return m_fullScreenElement.get(); }
1050     
1051     enum FullScreenCheckType {
1052         EnforceIFrameAllowFullScreenRequirement,
1053         ExemptIFrameAllowFullScreenRequirement,
1054     };
1055
1056     void requestFullScreenForElement(Element*, unsigned short flags, FullScreenCheckType);
1057     void webkitCancelFullScreen();
1058     
1059     void webkitWillEnterFullScreenForElement(Element*);
1060     void webkitDidEnterFullScreenForElement(Element*);
1061     void webkitWillExitFullScreenForElement(Element*);
1062     void webkitDidExitFullScreenForElement(Element*);
1063     
1064     void setFullScreenRenderer(RenderFullScreen*);
1065     RenderFullScreen* fullScreenRenderer() const { return m_fullScreenRenderer; }
1066     void fullScreenRendererDestroyed();
1067     
1068     void setFullScreenRendererSize(const IntSize&);
1069     void setFullScreenRendererBackgroundColor(Color);
1070     
1071     void fullScreenChangeDelayTimerFired(Timer<Document>*);
1072     bool fullScreenIsAllowedForElement(Element*) const;
1073     void fullScreenElementRemoved();
1074     void removeFullScreenElementOfSubtree(Node*, bool amongChildrenOnly = false);
1075     bool isAnimatingFullScreen() const;
1076     void setAnimatingFullScreen(bool);
1077
1078     // W3C API
1079     bool webkitFullscreenEnabled() const;
1080     Element* webkitFullscreenElement() const { return !m_fullScreenElementStack.isEmpty() ? m_fullScreenElementStack.last().get() : 0; }
1081     void webkitExitFullscreen();
1082 #endif
1083
1084 #if ENABLE(POINTER_LOCK)
1085     void webkitExitPointerLock();
1086     Element* webkitPointerLockElement() const;
1087 #endif
1088
1089     // Used to allow element that loads data without going through a FrameLoader to delay the 'load' event.
1090     void incrementLoadEventDelayCount() { ++m_loadEventDelayCount; }
1091     void decrementLoadEventDelayCount();
1092     bool isDelayingLoadEvent() const { return m_loadEventDelayCount; }
1093
1094 #if ENABLE(TOUCH_EVENTS)
1095     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;
1096 #endif
1097
1098     const DocumentTiming* timing() const { return &m_documentTiming; }
1099
1100 #if ENABLE(REQUEST_ANIMATION_FRAME)
1101     int requestAnimationFrame(PassRefPtr<RequestAnimationFrameCallback>);
1102     void cancelAnimationFrame(int id);
1103     void serviceScriptedAnimations(double monotonicAnimationStartTime);
1104 #endif
1105
1106     virtual EventTarget* errorEventTarget();
1107     virtual void logExceptionToConsole(const String& errorMessage, const String& sourceURL, int lineNumber, PassRefPtr<ScriptCallStack>);
1108
1109     void initDNSPrefetch();
1110
1111     unsigned wheelEventHandlerCount() const { return m_wheelEventHandlerCount; }
1112     void didAddWheelEventHandler();
1113     void didRemoveWheelEventHandler();
1114
1115 #if ENABLE(TOUCH_EVENTS)
1116     unsigned touchEventHandlerCount() const { return m_touchEventHandlerCount; }
1117 #else
1118     unsigned touchEventHandlerCount() const { return 0; }
1119 #endif
1120
1121     void didAddTouchEventHandler();
1122     void didRemoveTouchEventHandler();
1123
1124     bool visualUpdatesAllowed() const { return m_visualUpdatesAllowed; }
1125
1126 #if ENABLE(MICRODATA)
1127     PassRefPtr<NodeList> getItems(const String& typeNames);
1128 #endif
1129
1130     bool isInDocumentWrite() { return m_writeRecursionDepth > 0; }
1131
1132     void suspendScheduledTasks(ActiveDOMObject::ReasonForSuspension);
1133     void resumeScheduledTasks();
1134
1135     IntSize viewportSize() const;
1136
1137 #if ENABLE(LINK_PRERENDER)
1138     Prerenderer* prerenderer() { return m_prerenderer.get(); }
1139 #endif
1140
1141 #if ENABLE(TEXT_AUTOSIZING)
1142     TextAutosizer* textAutosizer() { return m_textAutosizer.get(); }
1143 #endif
1144
1145     void adjustFloatQuadsForScrollAndAbsoluteZoomAndFrameScale(Vector<FloatQuad>&, RenderObject*);
1146     void adjustFloatRectForScrollAndAbsoluteZoomAndFrameScale(FloatRect&, RenderObject*);
1147
1148     void setContextFeatures(PassRefPtr<ContextFeatures>);
1149     ContextFeatures* contextFeatures() { return m_contextFeatures.get(); }
1150
1151     virtual void reportMemoryUsage(MemoryObjectInfo*) const OVERRIDE;
1152
1153     DocumentSharedObjectPool* sharedObjectPool() { return m_sharedObjectPool.get(); }
1154
1155     void didRemoveAllPendingStylesheet();
1156     void setNeedsNotifyRemoveAllPendingStylesheet() { m_needsNotifyRemoveAllPendingStylesheet = true; }
1157     void clearStyleResolver();
1158     void notifySeamlessChildDocumentsOfStylesheetUpdate() const;
1159
1160     bool inStyleRecalc() { return m_inStyleRecalc; }
1161
1162     // Return a Locale for the default locale if the argument is null or empty.
1163     Locale& getCachedLocale(const AtomicString& locale = nullAtom);
1164
1165 #if ENABLE(DIALOG_ELEMENT)
1166     void addToTopLayer(Element*);
1167     void removeFromTopLayer(Element*);
1168     const Vector<RefPtr<Element> >& topLayerElements() const { return m_topLayerElements; }
1169 #endif
1170
1171 protected:
1172     Document(Frame*, const KURL&, bool isXHTML, bool isHTML);
1173
1174     virtual void didUpdateSecurityOrigin() OVERRIDE;
1175
1176     void clearXMLVersion() { m_xmlVersion = String(); }
1177
1178 private:
1179     friend class Node;
1180     friend class IgnoreDestructiveWriteCountIncrementer;
1181
1182     void removedLastRef();
1183     
1184     void detachParser();
1185
1186     typedef void (*ArgumentsCallback)(const String& keyString, const String& valueString, Document*, void* data);
1187     void processArguments(const String& features, void* data, ArgumentsCallback);
1188
1189     virtual bool isDocument() const { return true; }
1190
1191     virtual void childrenChanged(bool changedByParser = false, Node* beforeChange = 0, Node* afterChange = 0, int childCountDelta = 0);
1192
1193     virtual String nodeName() const;
1194     virtual NodeType nodeType() const;
1195     virtual bool childTypeAllowed(NodeType) const;
1196     virtual PassRefPtr<Node> cloneNode(bool deep);
1197
1198     virtual void refScriptExecutionContext() { ref(); }
1199     virtual void derefScriptExecutionContext() { deref(); }
1200
1201     virtual const KURL& virtualURL() const; // Same as url(), but needed for ScriptExecutionContext to implement it without a performance loss for direct calls.
1202     virtual KURL virtualCompleteURL(const String&) const; // Same as completeURL() for the same reason as above.
1203
1204     virtual void addMessage(MessageSource, MessageType, MessageLevel, const String& message, const String& sourceURL, unsigned lineNumber, PassRefPtr<ScriptCallStack>, unsigned long requestIdentifier = 0);
1205
1206     virtual double minimumTimerInterval() const;
1207
1208     virtual double timerAlignmentInterval() const;
1209
1210     void updateTitle(const StringWithDirection&);
1211     void updateFocusAppearanceTimerFired(Timer<Document>*);
1212     void updateBaseURL();
1213
1214     void buildAccessKeyMap(TreeScope* root);
1215
1216     void createStyleResolver();
1217
1218     void seamlessParentUpdatedStylesheets();
1219
1220     PassRefPtr<NodeList> handleZeroPadding(const HitTestRequest&, HitTestResult&) const;
1221
1222     void loadEventDelayTimerFired(Timer<Document>*);
1223
1224     void pendingTasksTimerFired(Timer<Document>*);
1225
1226     static void didReceiveTask(void*);
1227     
1228     template <typename CharacterType>
1229     void displayBufferModifiedByEncodingInternal(CharacterType*, unsigned) const;
1230
1231 #if ENABLE(PAGE_VISIBILITY_API)
1232     PageVisibilityState visibilityState() const;
1233 #endif
1234
1235     PassRefPtr<HTMLCollection> ensureCachedCollection(CollectionType);
1236
1237 #if ENABLE(FULLSCREEN_API)
1238     void clearFullscreenElementStack();
1239     void popFullscreenElementStack();
1240     void pushFullscreenElementStack(Element*);
1241     void addDocumentToFullScreenChangeEventQueue(Document*);
1242 #endif
1243
1244     void setVisualUpdatesAllowed(ReadyState);
1245     void setVisualUpdatesAllowed(bool);
1246     void visualUpdatesSuppressionTimerFired(Timer<Document>*);
1247
1248     void addListenerType(ListenerType listenerType) { m_listenerTypes |= listenerType; }
1249     void addMutationEventListenerTypeIfEnabled(ListenerType);
1250
1251     int m_guardRefCount;
1252
1253     OwnPtr<StyleResolver> m_styleResolver;
1254     bool m_didCalculateStyleResolver;
1255     bool m_hasDirtyStyleResolver;
1256     bool m_hasNodesWithPlaceholderStyle;
1257     bool m_needsNotifyRemoveAllPendingStylesheet;
1258     // But sometimes you need to ignore pending stylesheet count to
1259     // force an immediate layout when requested by JS.
1260     bool m_ignorePendingStylesheets;
1261
1262     // If we do ignore the pending stylesheet count, then we need to add a boolean
1263     // to track that this happened so that we can do a full repaint when the stylesheets
1264     // do eventually load.
1265     PendingSheetLayout m_pendingSheetLayout;
1266
1267     Frame* m_frame;
1268     RefPtr<DOMWindow> m_domWindow;
1269
1270     RefPtr<CachedResourceLoader> m_cachedResourceLoader;
1271     RefPtr<DocumentParser> m_parser;
1272     RefPtr<ContextFeatures> m_contextFeatures;
1273
1274     bool m_wellFormed;
1275
1276     // Document URLs.
1277     KURL m_url; // Document.URL: The URL from which this document was retrieved.
1278     KURL m_baseURL; // Node.baseURI: The URL to use when resolving relative URLs.
1279     KURL m_baseURLOverride; // An alternative base URL that takes precedence over m_baseURL (but not m_baseElementURL).
1280     KURL m_baseElementURL; // The URL set by the <base> element.
1281     KURL m_cookieURL; // The URL to use for cookie access.
1282     KURL m_firstPartyForCookies; // The policy URL for third-party cookie blocking.
1283
1284     // Document.documentURI:
1285     // Although URL-like, Document.documentURI can actually be set to any
1286     // string by content.  Document.documentURI affects m_baseURL unless the
1287     // document contains a <base> element, in which case the <base> element
1288     // takes precedence.
1289     //
1290     // This property is read-only from JavaScript, but writable from Objective C.
1291     String m_documentURI;
1292
1293     String m_baseTarget;
1294
1295     RefPtr<DocumentType> m_docType;
1296     OwnPtr<DOMImplementation> m_implementation;
1297
1298     RefPtr<CSSStyleSheet> m_elemSheet;
1299
1300     bool m_printing;
1301     bool m_paginatedForScreen;
1302
1303     bool m_ignoreAutofocus;
1304
1305     CompatibilityMode m_compatibilityMode;
1306     bool m_compatibilityModeLocked; // This is cheaper than making setCompatibilityMode virtual.
1307
1308     Color m_textColor;
1309
1310     RefPtr<Node> m_focusedNode;
1311     RefPtr<Node> m_hoverNode;
1312     RefPtr<Node> m_activeNode;
1313     RefPtr<Element> m_documentElement;
1314
1315     uint64_t m_domTreeVersion;
1316     static uint64_t s_globalTreeVersion;
1317     
1318     HashSet<NodeIterator*> m_nodeIterators;
1319     HashSet<Range*> m_ranges;
1320
1321     unsigned short m_listenerTypes;
1322
1323 #if ENABLE(MUTATION_OBSERVERS)
1324     MutationObserverOptions m_mutationObserverTypes;
1325 #endif
1326
1327
1328     OwnPtr<DocumentStyleSheetCollection> m_styleSheetCollection;
1329     RefPtr<StyleSheetList> m_styleSheetList;
1330
1331     OwnPtr<FormController> m_formController;
1332
1333     Color m_linkColor;
1334     Color m_visitedLinkColor;
1335     Color m_activeLinkColor;
1336
1337     bool m_loadingSheet;
1338     bool m_visuallyOrdered;
1339     ReadyState m_readyState;
1340     bool m_bParsing;
1341     
1342     Timer<Document> m_styleRecalcTimer;
1343     bool m_pendingStyleRecalcShouldForce;
1344     bool m_inStyleRecalc;
1345     bool m_closeAfterStyleRecalc;
1346
1347     bool m_gotoAnchorNeededAfterStylesheetsLoad;
1348     bool m_isDNSPrefetchEnabled;
1349     bool m_haveExplicitlyDisabledDNSPrefetch;
1350     bool m_frameElementsShouldIgnoreScrolling;
1351     bool m_containsValidityStyleRules;
1352     bool m_updateFocusAppearanceRestoresSelection;
1353
1354     // http://www.whatwg.org/specs/web-apps/current-work/#ignore-destructive-writes-counter
1355     unsigned m_ignoreDestructiveWriteCount;
1356
1357     StringWithDirection m_title;
1358     StringWithDirection m_rawTitle;
1359     bool m_titleSetExplicitly;
1360     RefPtr<Element> m_titleElement;
1361
1362     OwnPtr<RenderArena> m_renderArena;
1363
1364     OwnPtr<AXObjectCache> m_axObjectCache;
1365     OwnPtr<DocumentMarkerController> m_markers;
1366     
1367     Timer<Document> m_updateFocusAppearanceTimer;
1368
1369     Element* m_cssTarget;
1370
1371     // FIXME: Merge these 2 variables into an enum. Also, FrameLoader::m_didCallImplicitClose
1372     // is almost a duplication of this data, so that should probably get merged in too.
1373     // FIXME: Document::m_processingLoadEvent and DocumentLoader::m_wasOnloadHandled are roughly the same
1374     // and should be merged.
1375     bool m_processingLoadEvent;
1376     bool m_loadEventFinished;
1377
1378     RefPtr<SerializedScriptValue> m_pendingStateObject;
1379     double m_startTime;
1380     bool m_overMinimumLayoutThreshold;
1381     
1382     OwnPtr<ScriptRunner> m_scriptRunner;
1383
1384 #if ENABLE(XSLT)
1385     OwnPtr<TransformSource> m_transformSource;
1386     RefPtr<Document> m_transformSourceDocument;
1387 #endif
1388
1389     int m_docID; // A unique document identifier used for things like document-specific mapped attributes.
1390
1391     String m_xmlEncoding;
1392     String m_xmlVersion;
1393     unsigned m_xmlStandalone : 2;
1394     unsigned m_hasXMLDeclaration : 1;
1395
1396     String m_contentLanguage;
1397
1398     RenderObject* m_savedRenderer;
1399     
1400     RefPtr<TextResourceDecoder> m_decoder;
1401
1402     InheritedBool m_designMode;
1403
1404     HashSet<LiveNodeListBase*> m_listsInvalidatedAtDocument;
1405     unsigned m_nodeListCounts[numNodeListInvalidationTypes];
1406
1407     RefPtr<XPathEvaluator> m_xpathEvaluator;
1408
1409 #if ENABLE(SVG)
1410     OwnPtr<SVGDocumentExtensions> m_svgExtensions;
1411 #endif
1412
1413 #if ENABLE(DASHBOARD_SUPPORT) || ENABLE(DRAGGABLE_REGION)
1414     Vector<AnnotatedRegionValue> m_annotatedRegions;
1415     bool m_hasAnnotatedRegions;
1416     bool m_annotatedRegionsDirty;
1417 #endif
1418
1419     HashMap<String, RefPtr<HTMLCanvasElement> > m_cssCanvasElements;
1420
1421     bool m_createRenderers;
1422     bool m_inPageCache;
1423     Vector<IconURL> m_iconURLs;
1424
1425     HashSet<Element*> m_documentSuspensionCallbackElements;
1426     HashSet<Element*> m_mediaVolumeCallbackElements;
1427     HashSet<Element*> m_privateBrowsingStateChangedElements;
1428
1429     HashMap<StringImpl*, Element*, CaseFoldingHash> m_elementsByAccessKey;    
1430     bool m_accessKeyMapValid;
1431
1432     OwnPtr<SelectorQueryCache> m_selectorQueryCache;
1433
1434     bool m_useSecureKeyboardEntryWhenActive;
1435
1436     bool m_isXHTML;
1437     bool m_isHTML;
1438
1439     bool m_isViewSource;
1440     bool m_sawElementsInKnownNamespaces;
1441     bool m_isSrcdocDocument;
1442
1443     RenderObject* m_renderer;
1444     RefPtr<DocumentEventQueue> m_eventQueue;
1445
1446     RefPtr<DocumentWeakReference> m_weakReference;
1447
1448     HashSet<MediaCanStartListener*> m_mediaCanStartListeners;
1449
1450     QualifiedName m_idAttributeName;
1451
1452 #if ENABLE(FULLSCREEN_API)
1453     bool m_areKeysEnabledInFullScreen;
1454     RefPtr<Element> m_fullScreenElement;
1455     Vector<RefPtr<Element> > m_fullScreenElementStack;
1456     RenderFullScreen* m_fullScreenRenderer;
1457     Timer<Document> m_fullScreenChangeDelayTimer;
1458     Deque<RefPtr<Node> > m_fullScreenChangeEventTargetQueue;
1459     Deque<RefPtr<Node> > m_fullScreenErrorEventTargetQueue;
1460     bool m_isAnimatingFullScreen;
1461     LayoutRect m_savedPlaceholderFrameRect;
1462     RefPtr<RenderStyle> m_savedPlaceholderRenderStyle;
1463 #endif
1464
1465 #if ENABLE(DIALOG_ELEMENT)
1466     Vector<RefPtr<Element> > m_topLayerElements;
1467 #endif
1468
1469     int m_loadEventDelayCount;
1470     Timer<Document> m_loadEventDelayTimer;
1471
1472     ViewportArguments m_viewportArguments;
1473
1474     ReferrerPolicy m_referrerPolicy;
1475
1476     bool m_directionSetOnDocumentElement;
1477     bool m_writingModeSetOnDocumentElement;
1478
1479     DocumentTiming m_documentTiming;
1480     RefPtr<MediaQueryMatcher> m_mediaQueryMatcher;
1481     bool m_writeRecursionIsTooDeep;
1482     unsigned m_writeRecursionDepth;
1483     
1484     unsigned m_wheelEventHandlerCount;
1485 #if ENABLE(TOUCH_EVENTS)
1486     unsigned m_touchEventHandlerCount;
1487 #endif
1488
1489 #if ENABLE(REQUEST_ANIMATION_FRAME)
1490     RefPtr<ScriptedAnimationController> m_scriptedAnimationController;
1491 #endif
1492
1493     Timer<Document> m_pendingTasksTimer;
1494     Vector<OwnPtr<Task> > m_pendingTasks;
1495
1496 #if ENABLE(LINK_PRERENDER)
1497     OwnPtr<Prerenderer> m_prerenderer;
1498 #endif
1499
1500 #if ENABLE(TEXT_AUTOSIZING)
1501     OwnPtr<TextAutosizer> m_textAutosizer;
1502 #endif
1503
1504     bool m_scheduledTasksAreSuspended;
1505     
1506     bool m_visualUpdatesAllowed;
1507     Timer<Document> m_visualUpdatesSuppressionTimer;
1508
1509     RefPtr<NamedFlowCollection> m_namedFlows;
1510
1511 #if ENABLE(CSP_NEXT)
1512     RefPtr<DOMSecurityPolicy> m_domSecurityPolicy;
1513 #endif
1514
1515     void sharedObjectPoolClearTimerFired(Timer<Document>*);
1516     Timer<Document> m_sharedObjectPoolClearTimer;
1517
1518     OwnPtr<DocumentSharedObjectPool> m_sharedObjectPool;
1519
1520 #ifndef NDEBUG
1521     bool m_didDispatchViewportPropertiesChanged;
1522 #endif
1523
1524     typedef HashMap<AtomicString, OwnPtr<Locale> > LocaleIdentifierToLocaleMap;
1525     LocaleIdentifierToLocaleMap m_localeCache;
1526 };
1527
1528 inline void Document::notifyRemovePendingSheetIfNeeded()
1529 {
1530     if (m_needsNotifyRemoveAllPendingStylesheet)
1531         didRemoveAllPendingStylesheet();
1532 }
1533
1534 // Put these methods here, because they require the Document definition, but we really want to inline them.
1535
1536 inline bool Node::isDocumentNode() const
1537 {
1538     return this == m_document;
1539 }
1540
1541 inline TreeScope* Node::treeScope() const
1542 {
1543     return hasRareData() ? m_data.m_rareData->treeScope() : documentInternal();
1544 }
1545
1546 inline Node::Node(Document* document, ConstructionType type)
1547     : m_nodeFlags(type)
1548     , m_document(document)
1549     , m_previous(0)
1550     , m_next(0)
1551 {
1552     if (document)
1553         document->guardRef();
1554 #if !defined(NDEBUG) || (defined(DUMP_NODE_STATISTICS) && DUMP_NODE_STATISTICS)
1555     trackForDebugging();
1556 #endif
1557     InspectorCounters::incrementCounter(InspectorCounters::NodeCounter);
1558 }
1559
1560 Node* eventTargetNodeForDocument(Document*);
1561
1562 } // namespace WebCore
1563
1564 #endif // Document_h