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