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