Fix for bug 12751, doctype nodes aren't part of the Document (Acid3).
[WebKit-https.git] / 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 Apple Inc. All rights reserved.
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public License
19  * along with this library; see the file COPYING.LIB.  If not, write to
20  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21  * Boston, MA 02110-1301, USA.
22  *
23  */
24
25 #ifndef Document_h
26 #define Document_h
27
28 #include "Attr.h"
29 #include "Color.h"
30 #include "DeprecatedPtrList.h"
31 #include "DeprecatedValueList.h"
32 #include "DocumentMarker.h"
33 #include "HTMLCollection.h"
34 #include "HTMLFormElement.h"
35 #include "KURL.h"
36 #include "StringHash.h"
37 #include "Timer.h"
38 #include <wtf/HashCountedSet.h>
39 #include <wtf/ListHashSet.h>
40
41 // FIXME: We should move Mac off of the old Frame-based user stylesheet loading
42 // code and onto the new code in Page. We can't do that until the code in Page
43 // supports non-file: URLs, however.
44 #if PLATFORM(MAC)
45 #define FRAME_LOADS_USER_STYLESHEET 1
46 #else
47 #define FRAME_LOADS_USER_STYLESHEET 0
48 #endif
49
50 namespace WebCore {
51
52     class AXObjectCache;
53     class Attr;
54     class Attribute;
55     class CDATASection;
56     class CachedCSSStyleSheet;
57     class CSSStyleDeclaration;
58     class CSSStyleSelector;
59     class CSSStyleSheet;
60     class Comment;
61     class Database;
62     class DOMImplementation;
63     class DOMWindow;
64     class DatabaseThread;
65     class DocLoader;
66     class DocumentFragment;
67     class DocumentType;
68     class EditingText;
69     class Element;
70     class EntityReference;
71     class Event;
72     class EventListener;
73     class Frame;
74     class FrameView;
75     class HTMLDocument;
76     class HTMLElement;
77     class HTMLFormControlElementWithState;
78     class HTMLFormElement;
79     class HTMLHeadElement;
80     class HTMLImageLoader;
81     class HTMLInputElement;
82     class HTMLMapElement;
83     class IntPoint;
84     class MouseEventWithHitTestResults;
85     class NameNodeList;
86     class NodeFilter;
87     class NodeIterator;
88     class NodeList;
89     class Page;
90     class PlatformMouseEvent;
91     class ProcessingInstruction;
92     class Range;
93     class RegisteredEventListener;
94     class RenderArena;
95     class SecurityOrigin;
96     class Settings;
97     class StyleSheet;
98     class StyleSheetList;
99     class Text;
100     class TextResourceDecoder;
101     class Tokenizer;
102     class TreeWalker;
103 #if ENABLE(XBL)
104     class XBLBindingManager;
105 #endif
106 #if ENABLE(XPATH)
107     class XPathEvaluator;
108     class XPathExpression;
109     class XPathNSResolver;
110     class XPathResult;
111 #endif
112     
113     struct DashboardRegionValue;
114     struct HitTestRequest;
115
116 #if ENABLE(SVG)
117     class SVGDocumentExtensions;
118 #endif
119
120     typedef int ExceptionCode;
121
122 class FormElementKey {
123 public:
124     FormElementKey(AtomicStringImpl* = 0, AtomicStringImpl* = 0);
125     ~FormElementKey();
126     FormElementKey(const FormElementKey&);
127     FormElementKey& operator=(const FormElementKey&);
128     AtomicStringImpl* name() const { return m_name; }
129     AtomicStringImpl* type() const { return m_type; }
130 private:
131     void ref() const;
132     void deref() const;
133     AtomicStringImpl* m_name;
134     AtomicStringImpl* m_type;
135 };
136
137 inline bool operator==(const FormElementKey& a, const FormElementKey& b)
138     { return a.name() == b.name() && a.type() == b.type(); }
139
140 struct FormElementKeyHash {
141     static unsigned hash(const FormElementKey&);
142     static bool equal(const FormElementKey& a, const FormElementKey& b) { return a == b; }
143     static const bool safeToCompareToEmptyOrDeleted = true;
144 };
145
146 struct FormElementKeyHashTraits : WTF::GenericHashTraits<FormElementKey> {
147     static FormElementKey deletedValue();
148 };
149
150 class Document : public ContainerNode {
151 public:
152     Document(DOMImplementation*, Frame*, bool isXHTML = false);
153     virtual ~Document();
154
155     virtual void removedLastRef();
156
157     // Nodes belonging to this document hold "self-only" references -
158     // these are enough to keep the document from being destroyed, but
159     // not enough to keep it from removing its children. This allows a
160     // node that outlives its document to still have a valid document
161     // pointer without introducing reference cycles
162
163     void selfOnlyRef()
164     {
165         ASSERT(!m_deletionHasBegun);
166         ++m_selfOnlyRefCount;
167     }
168     void selfOnlyDeref()
169     {
170         ASSERT(!m_deletionHasBegun);
171         --m_selfOnlyRefCount;
172         if (!m_selfOnlyRefCount && !refCount()) {
173 #ifndef NDEBUG
174             m_deletionHasBegun = true;
175 #endif
176             delete this;
177         }
178     }
179
180     // DOM methods & attributes for Document
181
182     DocumentType* doctype() const { return m_docType.get(); }
183
184     DOMImplementation* implementation() const;
185     virtual void childrenChanged(bool changedByParser = false);
186     Element* documentElement() const;
187     virtual PassRefPtr<Element> createElement(const String& tagName, ExceptionCode&);
188     PassRefPtr<DocumentFragment> createDocumentFragment ();
189     PassRefPtr<Text> createTextNode(const String& data);
190     PassRefPtr<Comment> createComment(const String& data);
191     PassRefPtr<CDATASection> createCDATASection(const String& data, ExceptionCode&);
192     PassRefPtr<ProcessingInstruction> createProcessingInstruction(const String& target, const String& data, ExceptionCode&);
193     PassRefPtr<Attr> createAttribute(const String& name, ExceptionCode& ec) { return createAttributeNS(String(), name, ec); }
194     PassRefPtr<Attr> createAttributeNS(const String& namespaceURI, const String& qualifiedName, ExceptionCode&);
195     PassRefPtr<EntityReference> createEntityReference(const String& name, ExceptionCode&);
196     PassRefPtr<Node> importNode(Node* importedNode, bool deep, ExceptionCode&);
197     virtual PassRefPtr<Element> createElementNS(const String& namespaceURI, const String& qualifiedName, ExceptionCode&);
198     PassRefPtr<Element> createElement(const QualifiedName&, bool createdByParser, ExceptionCode& ec);
199     Element* getElementById(const AtomicString&) const;
200
201     Element* elementFromPoint(int x, int y) const;
202     String readyState() const;
203     String inputEncoding() const;
204     String defaultCharset() const;
205
206     String charset() const { return inputEncoding(); }
207     String characterSet() const { return inputEncoding(); }
208
209     void setCharset(const String&);
210
211     String contentLanguage() const { return m_contentLanguage; }
212     void setContentLanguage(const String& lang) { m_contentLanguage = lang; }
213
214     String xmlEncoding() const { return m_xmlEncoding; }
215     String xmlVersion() const { return m_xmlVersion; }
216     bool xmlStandalone() const { return m_xmlStandalone; }
217
218     void setXMLEncoding(const String& encoding) { m_xmlEncoding = encoding; } // read-only property, only to be set from XMLTokenizer
219     void setXMLVersion(const String&, ExceptionCode&);
220     void setXMLStandalone(bool, ExceptionCode&);
221
222     KURL documentURI() const;
223     void setDocumentURI(const String&);
224
225     virtual KURL baseURI() const;
226
227     PassRefPtr<Node> adoptNode(PassRefPtr<Node> source, ExceptionCode&);
228
229     PassRefPtr<HTMLCollection> images();
230     PassRefPtr<HTMLCollection> embeds();
231     PassRefPtr<HTMLCollection> plugins(); // an alias for embeds() required for the JS DOM bindings.
232     PassRefPtr<HTMLCollection> applets();
233     PassRefPtr<HTMLCollection> links();
234     PassRefPtr<HTMLCollection> forms();
235     PassRefPtr<HTMLCollection> anchors();
236     PassRefPtr<HTMLCollection> all();
237     PassRefPtr<HTMLCollection> objects();
238     PassRefPtr<HTMLCollection> scripts();
239     PassRefPtr<HTMLCollection> windowNamedItems(const String& name);
240     PassRefPtr<HTMLCollection> documentNamedItems(const String& name);
241
242     HTMLCollection::CollectionInfo* collectionInfo(HTMLCollection::Type type)
243     {
244         ASSERT(type >= HTMLCollection::FirstUnnamedDocumentCachedType);
245         unsigned index = type - HTMLCollection::FirstUnnamedDocumentCachedType;
246         ASSERT(index < HTMLCollection::NumUnnamedDocumentCachedTypes);
247         return &m_collectionInfo[index]; 
248     }
249
250     HTMLCollection::CollectionInfo* nameCollectionInfo(HTMLCollection::Type, const AtomicString& name);
251
252     // DOM methods overridden from  parent classes
253
254     virtual String nodeName() const;
255     virtual NodeType nodeType() const;
256
257     // Other methods (not part of DOM)
258     virtual bool isDocumentNode() const { return true; }
259     virtual bool isHTMLDocument() const { return false; }
260     virtual bool isImageDocument() const { return false; }
261 #if ENABLE(SVG)
262     virtual bool isSVGDocument() const { return false; }
263 #endif
264     virtual bool isPluginDocument() const { return false; }
265     
266     CSSStyleSelector* styleSelector() const { return m_styleSelector; }
267
268     Element* getElementByAccessKey(const String& key) const;
269     
270     /**
271      * Updates the pending sheet count and then calls updateStyleSelector.
272      */
273     void removePendingSheet();
274
275     /**
276      * This method returns true if all top-level stylesheets have loaded (including
277      * any @imports that they may be loading).
278      */
279     bool haveStylesheetsLoaded() const
280     {
281         return m_pendingStylesheets <= 0 || m_ignorePendingStylesheets
282 #if USE(LOW_BANDWIDTH_DISPLAY)
283             || m_inLowBandwidthDisplay
284 #endif
285             ;
286     }
287
288     /**
289      * Increments the number of pending sheets.  The <link> elements
290      * invoke this to add themselves to the loading list.
291      */
292     void addPendingSheet() { m_pendingStylesheets++; }
293
294     bool gotoAnchorNeededAfterStylesheetsLoad() { return m_gotoAnchorNeededAfterStylesheetsLoad; }
295     void setGotoAnchorNeededAfterStylesheetsLoad(bool b) { m_gotoAnchorNeededAfterStylesheetsLoad = b; }
296
297     /**
298      * Called when one or more stylesheets in the document may have been added, removed or changed.
299      *
300      * Creates a new style selector and assign it to this document. This is done by iterating through all nodes in
301      * document (or those before <BODY> in a HTML document), searching for stylesheets. Stylesheets can be contained in
302      * <LINK>, <STYLE> or <BODY> elements, as well as processing instructions (XML documents only). A list is
303      * constructed from these which is used to create the a new style selector which collates all of the stylesheets
304      * found and is used to calculate the derived styles for all rendering objects.
305      */
306     void updateStyleSelector();
307
308     void recalcStyleSelector();
309
310     bool usesDescendantRules() const { return m_usesDescendantRules; }
311     void setUsesDescendantRules(bool b) { m_usesDescendantRules = b; }
312     bool usesSiblingRules() const { return m_usesSiblingRules; }
313     void setUsesSiblingRules(bool b) { m_usesSiblingRules = b; }
314     bool usesFirstLineRules() const { return m_usesFirstLineRules; }
315     void setUsesFirstLineRules(bool b) { m_usesFirstLineRules = b; }
316     bool usesFirstLetterRules() const { return m_usesFirstLetterRules; }
317     void setUsesFirstLetterRules(bool b) { m_usesFirstLetterRules = b; }
318
319     // Machinery for saving and restoring state when you leave and then go back to a page.
320     void registerFormElementWithState(HTMLFormControlElementWithState* e) { m_formElementsWithState.add(e); }
321     void unregisterFormElementWithState(HTMLFormControlElementWithState* e) { m_formElementsWithState.remove(e); }
322     Vector<String> formElementsState() const;
323     void setStateForNewFormElements(const Vector<String>&);
324     bool hasStateForNewFormElements() const;
325     bool takeStateForFormElement(AtomicStringImpl* name, AtomicStringImpl* type, String& state);
326
327     FrameView* view() const; // can be NULL
328     Frame* frame() const { return m_frame; } // can be NULL
329     Page* page() const; // can be NULL
330     Settings* settings() const; // can be NULL
331
332     PassRefPtr<Range> createRange();
333
334     PassRefPtr<NodeIterator> createNodeIterator(Node* root, unsigned whatToShow,
335         PassRefPtr<NodeFilter>, bool expandEntityReferences, ExceptionCode&);
336
337     PassRefPtr<TreeWalker> createTreeWalker(Node* root, unsigned whatToShow, 
338         PassRefPtr<NodeFilter>, bool expandEntityReferences, ExceptionCode&);
339
340     // Special support for editing
341     PassRefPtr<CSSStyleDeclaration> createCSSStyleDeclaration();
342     PassRefPtr<EditingText> createEditingTextNode(const String&);
343
344     virtual void recalcStyle( StyleChange = NoChange );
345     static DeprecatedPtrList<Document>* changedDocuments;
346     virtual void updateRendering();
347     void updateLayout();
348     void updateLayoutIgnorePendingStylesheets();
349     static void updateDocumentsRendering();
350     DocLoader* docLoader() { return m_docLoader; }
351
352     virtual void attach();
353     virtual void detach();
354
355     RenderArena* renderArena() { return m_renderArena; }
356
357     AXObjectCache* axObjectCache() const;
358     
359     // to get visually ordered hebrew and arabic pages right
360     void setVisuallyOrdered();
361
362     void open();
363     void implicitOpen();
364     void close();
365     void implicitClose();
366     void cancelParsing();
367
368     void write(const String& text);
369     void writeln(const String& text);
370     void finishParsing();
371     void clear();
372
373     bool wellFormed() const { return m_wellFormed; }
374
375     const KURL& url() const { return m_url.isEmpty() ? blankURL() : m_url; }
376     void setURL(const KURL&);
377
378     const KURL& baseURL() const { return m_baseURL.isEmpty() ? url() : m_baseURL; }
379     void setBaseURL(const KURL&);
380
381     const String& baseTarget() const { return m_baseTarget; }
382     void setBaseTarget(const String& baseTarget) { m_baseTarget = baseTarget; }
383
384     KURL completeURL(const String&);
385
386     // from cachedObjectClient
387     virtual void setCSSStyleSheet(const String& url, const String& charset, const CachedCSSStyleSheet*);
388
389 #if FRAME_LOADS_USER_STYLESHEET
390     void setUserStyleSheet(const String& sheet);
391 #endif
392
393     String userStyleSheet() const;
394
395     CSSStyleSheet* elementSheet();
396     CSSStyleSheet* mappedElementSheet();
397     virtual Tokenizer* createTokenizer();
398     Tokenizer* tokenizer() { return m_tokenizer; }
399     
400     bool printing() const { return m_printing; }
401     void setPrinting(bool p) { m_printing = p; }
402
403     enum ParseMode { Compat, AlmostStrict, Strict };
404
405 private:
406     virtual void determineParseMode() {}
407     
408 public:
409     void setParseMode(ParseMode m) { m_parseMode = m; }
410     ParseMode parseMode() const { return m_parseMode; }
411
412     bool inCompatMode() const { return m_parseMode == Compat; }
413     bool inAlmostStrictMode() const { return m_parseMode == AlmostStrict; }
414     bool inStrictMode() const { return m_parseMode == Strict; }
415     
416     void setParsing(bool);
417     bool parsing() const { return m_bParsing; }
418     int minimumLayoutDelay();
419     bool shouldScheduleLayout();
420     int elapsedTime() const;
421     
422     void setTextColor(const Color& color) { m_textColor = color; }
423     Color textColor() const { return m_textColor; }
424
425     const Color& linkColor() const { return m_linkColor; }
426     const Color& visitedLinkColor() const { return m_visitedLinkColor; }
427     const Color& activeLinkColor() const { return m_activeLinkColor; }
428     void setLinkColor(const Color& c) { m_linkColor = c; }
429     void setVisitedLinkColor(const Color& c) { m_visitedLinkColor = c; }
430     void setActiveLinkColor(const Color& c) { m_activeLinkColor = c; }
431     void resetLinkColor();
432     void resetVisitedLinkColor();
433     void resetActiveLinkColor();
434     
435     MouseEventWithHitTestResults prepareMouseEvent(const HitTestRequest&, const IntPoint&, const PlatformMouseEvent&);
436
437     virtual bool childTypeAllowed(NodeType);
438     virtual PassRefPtr<Node> cloneNode(bool deep);
439
440     virtual bool canReplaceChild(Node* newChild, Node* oldChild);
441     
442     StyleSheetList* styleSheets();
443
444     /* Newly proposed CSS3 mechanism for selecting alternate
445        stylesheets using the DOM. May be subject to change as
446        spec matures. - dwh
447     */
448     String preferredStylesheetSet() const;
449     String selectedStylesheetSet() const;
450     void setSelectedStylesheetSet(const String&);
451
452     bool setFocusedNode(PassRefPtr<Node>);
453     Node* focusedNode() const { return m_focusedNode.get(); }
454
455     void setHoverNode(PassRefPtr<Node>);
456     Node* hoverNode() const { return m_hoverNode.get(); }
457
458     void setActiveNode(PassRefPtr<Node>);
459     Node* activeNode() const { return m_activeNode.get(); }
460
461     void focusedNodeRemoved();
462     void removeFocusedNodeOfSubtree(Node*, bool amongChildrenOnly = false);
463     void hoveredNodeDetached(Node*);
464     void activeChainNodeDetached(Node*);
465
466     // Updates for :target (CSS3 selector).
467     void setCSSTarget(Node*);
468     Node* getCSSTarget() const;
469     
470     void setDocumentChanged(bool);
471
472     void attachNodeIterator(NodeIterator*);
473     void detachNodeIterator(NodeIterator*);
474     void notifyBeforeNodeRemoval(Node*);
475     DOMWindow* defaultView() const;
476     PassRefPtr<Event> createEvent(const String& eventType, ExceptionCode&);
477
478     // keep track of what types of event listeners are registered, so we don't
479     // dispatch events unnecessarily
480     enum ListenerType {
481         DOMSUBTREEMODIFIED_LISTENER          = 0x01,
482         DOMNODEINSERTED_LISTENER             = 0x02,
483         DOMNODEREMOVED_LISTENER              = 0x04,
484         DOMNODEREMOVEDFROMDOCUMENT_LISTENER  = 0x08,
485         DOMNODEINSERTEDINTODOCUMENT_LISTENER = 0x10,
486         DOMATTRMODIFIED_LISTENER             = 0x20,
487         DOMCHARACTERDATAMODIFIED_LISTENER    = 0x40,
488         OVERFLOWCHANGED_LISTENER             = 0x80
489     };
490
491     bool hasListenerType(ListenerType listenerType) const { return (m_listenerTypes & listenerType); }
492     void addListenerType(ListenerType listenerType) { m_listenerTypes = m_listenerTypes | listenerType; }
493
494     CSSStyleDeclaration* getOverrideStyle(Element*, const String& pseudoElt);
495
496     void handleWindowEvent(Event*, bool useCapture);
497     void setHTMLWindowEventListener(const AtomicString &eventType, PassRefPtr<EventListener>);
498     EventListener* getHTMLWindowEventListener(const AtomicString &eventType);
499     void removeHTMLWindowEventListener(const AtomicString &eventType);
500
501     void setHTMLWindowEventListener(const AtomicString& eventType, Attribute*);
502
503     void addWindowEventListener(const AtomicString& eventType, PassRefPtr<EventListener>, bool useCapture);
504     void removeWindowEventListener(const AtomicString& eventType, EventListener*, bool useCapture);
505     bool hasWindowEventListener(const AtomicString& eventType);
506
507     PassRefPtr<EventListener> createHTMLEventListener(const String& functionName, const String& code, Node*);
508     
509     /**
510      * Searches through the document, starting from fromNode, for the next selectable element that comes after fromNode.
511      * The order followed is as specified in section 17.11.1 of the HTML4 spec, which is elements with tab indexes
512      * first (from lowest to highest), and then elements without tab indexes (in document order).
513      *
514      * @param fromNode The node from which to start searching. The node after this will be focused. May be null.
515      *
516      * @return The focus node that comes after fromNode
517      *
518      * See http://www.w3.org/TR/html4/interact/forms.html#h-17.11.1
519      */
520     Node* nextFocusableNode(Node* start, KeyboardEvent*);
521
522     /**
523      * Searches through the document, starting from fromNode, for the previous selectable element (that comes _before_)
524      * fromNode. The order followed is as specified in section 17.11.1 of the HTML4 spec, which is elements with tab
525      * indexes first (from lowest to highest), and then elements without tab indexes (in document order).
526      *
527      * @param fromNode The node from which to start searching. The node before this will be focused. May be null.
528      *
529      * @return The focus node that comes before fromNode
530      *
531      * See http://www.w3.org/TR/html4/interact/forms.html#h-17.11.1
532      */
533     Node* previousFocusableNode(Node* start, KeyboardEvent*);
534
535     int nodeAbsIndex(Node*);
536     Node* nodeWithAbsIndex(int absIndex);
537
538     /**
539      * Handles a HTTP header equivalent set by a meta tag using <meta http-equiv="..." content="...">. This is called
540      * when a meta tag is encountered during document parsing, and also when a script dynamically changes or adds a meta
541      * tag. This enables scripts to use meta tags to perform refreshes and set expiry dates in addition to them being
542      * specified in a HTML file.
543      *
544      * @param equiv The http header name (value of the meta tag's "equiv" attribute)
545      * @param content The header value (value of the meta tag's "content" attribute)
546      */
547     void processHttpEquiv(const String& equiv, const String& content);
548     
549     void dispatchImageLoadEventSoon(HTMLImageLoader*);
550     void dispatchImageLoadEventsNow();
551     void removeImage(HTMLImageLoader*);
552     
553     // Returns the owning element in the parent document.
554     // Returns 0 if this is the top level document.
555     Element* ownerElement() const;
556
557     String title() const { return m_title; }
558     void setTitle(const String&, Element* titleElement = 0);
559     void removeTitle(Element* titleElement);
560
561     String cookie() const;
562     void setCookie(const String&);
563
564     String referrer() const;
565
566     String domain() const;
567     void setDomain(const String& newDomain);
568
569     String lastModified() const;
570
571     const KURL& policyBaseURL() const { return m_policyBaseURL; }
572     void setPolicyBaseURL(const KURL& url) { m_policyBaseURL = url; }
573     
574     // The following implements the rule from HTML 4 for what valid names are.
575     // To get this right for all the XML cases, we probably have to improve this or move it
576     // and make it sensitive to the type of document.
577     static bool isValidName(const String&);
578
579     // The following breaks a qualified name into a prefix and a local name.
580     // It also does a validity check, and returns false if the qualified name is invalid
581     // (empty string or invalid characters).
582     static bool parseQualifiedName(const String& qualifiedName, String& prefix, String& localName);
583     
584     void addElementById(const AtomicString& elementId, Element *element);
585     void removeElementById(const AtomicString& elementId, Element *element);
586
587     void addImageMap(HTMLMapElement*);
588     void removeImageMap(HTMLMapElement*);
589     HTMLMapElement* getImageMap(const String& url) const;
590
591     HTMLElement* body();
592     void setBody(PassRefPtr<HTMLElement>, ExceptionCode&);
593
594     HTMLHeadElement* head();
595
596     String toString() const;
597     
598     bool execCommand(const String& command, bool userInterface = false, const String& value = String());
599     bool queryCommandEnabled(const String& command);
600     bool queryCommandIndeterm(const String& command);
601     bool queryCommandState(const String& command);
602     bool queryCommandSupported(const String& command);
603     String queryCommandValue(const String& command);
604     
605     void addMarker(Range*, DocumentMarker::MarkerType, String description = String());
606     void addMarker(Node*, DocumentMarker);
607     void copyMarkers(Node *srcNode, unsigned startOffset, int length, Node *dstNode, int delta, DocumentMarker::MarkerType = DocumentMarker::AllMarkers);
608     void removeMarkers(Range*, DocumentMarker::MarkerType = DocumentMarker::AllMarkers);
609     void removeMarkers(Node*, unsigned startOffset, int length, DocumentMarker::MarkerType = DocumentMarker::AllMarkers);
610     void removeMarkers(DocumentMarker::MarkerType = DocumentMarker::AllMarkers);
611     void removeMarkers(Node*);
612     void repaintMarkers(DocumentMarker::MarkerType = DocumentMarker::AllMarkers);
613     void setRenderedRectForMarker(Node*, DocumentMarker, const IntRect&);
614     void invalidateRenderedRectsForMarkersInRect(const IntRect&);
615     void shiftMarkers(Node*, unsigned startOffset, int delta, DocumentMarker::MarkerType = DocumentMarker::AllMarkers);
616
617     DocumentMarker* markerContainingPoint(const IntPoint&, DocumentMarker::MarkerType = DocumentMarker::AllMarkers);
618     Vector<DocumentMarker> markersForNode(Node*);
619     Vector<IntRect> renderedRectsForMarkers(DocumentMarker::MarkerType = DocumentMarker::AllMarkers);
620     
621     // designMode support
622     enum InheritedBool { off = false, on = true, inherit };    
623     void setDesignMode(InheritedBool value);
624     InheritedBool getDesignMode() const;
625     bool inDesignMode() const;
626
627     Document* parentDocument() const;
628     Document* topDocument() const;
629
630     int docID() const { return m_docID; }
631
632 #if ENABLE(XSLT)
633     void applyXSLTransform(ProcessingInstruction* pi);
634     void setTransformSource(void* doc);
635     const void* transformSource() { return m_transformSource; }
636     PassRefPtr<Document> transformSourceDocument() { return m_transformSourceDocument; }
637     void setTransformSourceDocument(Document* doc) { m_transformSourceDocument = doc; }
638 #endif
639
640 #if ENABLE(XBL)
641     // XBL methods
642     XBLBindingManager* bindingManager() const { return m_bindingManager; }
643 #endif
644
645     void incDOMTreeVersion() { ++m_domtree_version; }
646     unsigned domTreeVersion() const { return m_domtree_version; }
647
648     void setDocType(PassRefPtr<DocumentType>);
649
650     void finishedParsing();
651
652 #if ENABLE(XPATH)
653     // XPathEvaluator methods
654     PassRefPtr<XPathExpression> createExpression(const String& expression,
655                                                  XPathNSResolver* resolver,
656                                                  ExceptionCode& ec);
657     PassRefPtr<XPathNSResolver> createNSResolver(Node *nodeResolver);
658     PassRefPtr<XPathResult> evaluate(const String& expression,
659                                      Node* contextNode,
660                                      XPathNSResolver* resolver,
661                                      unsigned short type,
662                                      XPathResult* result,
663                                      ExceptionCode& ec);
664 #endif // ENABLE(XPATH)
665     
666     enum PendingSheetLayout { NoLayoutWithPendingSheets, DidLayoutWithPendingSheets, IgnoreLayoutWithPendingSheets };
667
668     bool didLayoutWithPendingStylesheets() const { return m_pendingSheetLayout == DidLayoutWithPendingSheets; }
669     
670     void setHasNodesWithPlaceholderStyle() { m_hasNodesWithPlaceholderStyle = true; }
671
672     String iconURL();
673     void setIconURL(const String& iconURL, const String& type);
674
675     bool isAllowedToLoadLocalResources() const { return m_isAllowedToLoadLocalResources; }
676
677     void setUseSecureKeyboardEntryWhenActive(bool);
678     bool useSecureKeyboardEntryWhenActive() const;
679     
680 #if USE(LOW_BANDWIDTH_DISPLAY)
681     void setDocLoader(DocLoader* loader) { m_docLoader = loader; }
682     bool inLowBandwidthDisplay() const { return m_inLowBandwidthDisplay; }
683     void setLowBandwidthDisplay(bool lowBandWidth) { m_inLowBandwidthDisplay = lowBandWidth; }
684 #endif
685     
686     void addNodeList() { m_numNodeLists++; }
687     void removeNodeList() { m_numNodeLists--; }
688     bool hasNodeLists() const { return m_numNodeLists != 0; }
689
690     void updateFocusAppearanceSoon();
691     void cancelFocusAppearanceUpdate();
692     
693 private:
694     CSSStyleSelector* m_styleSelector;
695     bool m_didCalculateStyleSelector;
696
697     Frame* m_frame;
698     DocLoader* m_docLoader;
699     Tokenizer* m_tokenizer;
700     bool m_wellFormed;
701     KURL m_url;
702     KURL m_baseURL;
703     String m_baseTarget;
704
705     RefPtr<DocumentType> m_docType;
706     RefPtr<DOMImplementation> m_implementation;
707
708     RefPtr<StyleSheet> m_sheet;
709 #if FRAME_LOADS_USER_STYLESHEET
710     String m_usersheet;
711 #endif
712
713     // Track the number of currently loading top-level stylesheets.  Sheets
714     // loaded using the @import directive are not included in this count.
715     // We use this count of pending sheets to detect when we can begin attaching
716     // elements.
717     int m_pendingStylesheets;
718
719     // But sometimes you need to ignore pending stylesheet count to
720     // force an immediate layout when requested by JS.
721     bool m_ignorePendingStylesheets;
722
723     // If we do ignore the pending stylesheet count, then we need to add a boolean
724     // to track that this happened so that we can do a full repaint when the stylesheets
725     // do eventually load.
726     PendingSheetLayout m_pendingSheetLayout;
727     
728     bool m_hasNodesWithPlaceholderStyle;
729
730     RefPtr<CSSStyleSheet> m_elemSheet;
731     RefPtr<CSSStyleSheet> m_mappedElementSheet;
732
733     bool m_printing;
734
735     ParseMode m_parseMode;
736
737     Color m_textColor;
738
739     RefPtr<Node> m_focusedNode;
740     RefPtr<Node> m_hoverNode;
741     RefPtr<Node> m_activeNode;
742     mutable RefPtr<Element> m_documentElement;
743
744     unsigned m_domtree_version;
745     
746     HashSet<NodeIterator*> m_nodeIterators;
747
748     unsigned short m_listenerTypes;
749     RefPtr<StyleSheetList> m_styleSheets;
750     
751     typedef DeprecatedValueList<RefPtr<RegisteredEventListener> > RegisteredEventListenerList;
752     RegisteredEventListenerList m_windowEventListeners;
753
754     typedef HashMap<FormElementKey, Vector<String>, FormElementKeyHash, FormElementKeyHashTraits> FormElementStateMap;
755     ListHashSet<HTMLFormControlElementWithState*> m_formElementsWithState;
756     FormElementStateMap m_stateForNewFormElements;
757     
758     Color m_linkColor;
759     Color m_visitedLinkColor;
760     Color m_activeLinkColor;
761
762     String m_preferredStylesheetSet;
763     String m_selectedStylesheetSet;
764
765     bool m_loadingSheet;
766     bool visuallyOrdered;
767     bool m_bParsing;
768     bool m_docChanged;
769     bool m_inStyleRecalc;
770     bool m_closeAfterStyleRecalc;
771     bool m_usesDescendantRules;
772     bool m_usesSiblingRules;
773     bool m_usesFirstLineRules;
774     bool m_usesFirstLetterRules;
775     bool m_gotoAnchorNeededAfterStylesheetsLoad;
776
777     String m_title;
778     bool m_titleSetExplicitly;
779     RefPtr<Element> m_titleElement;
780     
781     RenderArena* m_renderArena;
782
783     typedef std::pair<Vector<DocumentMarker>, Vector<IntRect> > MarkerMapVectorPair;
784     typedef HashMap<RefPtr<Node>, MarkerMapVectorPair*> MarkerMap;
785     MarkerMap m_markers;
786
787     mutable AXObjectCache* m_axObjectCache;
788     
789     DeprecatedPtrList<HTMLImageLoader> m_imageLoadEventDispatchSoonList;
790     DeprecatedPtrList<HTMLImageLoader> m_imageLoadEventDispatchingList;
791     Timer<Document> m_imageLoadEventTimer;
792
793     Timer<Document> m_updateFocusAppearanceTimer;
794
795     Node* m_cssTarget;
796     
797     bool m_processingLoadEvent;
798     double m_startTime;
799     bool m_overMinimumLayoutThreshold;
800     
801 #if ENABLE(XSLT)
802     void* m_transformSource;
803     RefPtr<Document> m_transformSourceDocument;
804 #endif
805
806 #if ENABLE(XBL)
807     XBLBindingManager* m_bindingManager; // The access point through which documents and elements communicate with XBL.
808 #endif
809     
810     typedef HashMap<AtomicStringImpl*, HTMLMapElement*> ImageMapsByName;
811     ImageMapsByName m_imageMapsByName;
812
813     KURL m_policyBaseURL;
814
815     HashSet<Node*> m_disconnectedNodesWithEventListeners;
816
817     int m_docID; // A unique document identifier used for things like document-specific mapped attributes.
818
819     String m_xmlEncoding;
820     String m_xmlVersion;
821     bool m_xmlStandalone;
822
823     String m_contentLanguage;
824
825 public:
826     bool inPageCache();
827     void setInPageCache(bool flag);
828     
829     // Elements can register themselves for the "willSaveToCache()" and  
830     // "didRestoreFromCache()" callbacks
831     void registerForCacheCallbacks(Element*);
832     void unregisterForCacheCallbacks(Element*);
833     void willSaveToCache();
834     void didRestoreFromCache();
835
836     void setShouldCreateRenderers(bool);
837     bool shouldCreateRenderers();
838     
839     void setDecoder(TextResourceDecoder*);
840     TextResourceDecoder* decoder() const { return m_decoder.get(); }
841
842     UChar backslashAsCurrencySymbol() const;
843
844     void setDashboardRegionsDirty(bool f) { m_dashboardRegionsDirty = f; }
845     bool dashboardRegionsDirty() const { return m_dashboardRegionsDirty; }
846     bool hasDashboardRegions () const { return m_hasDashboardRegions; }
847     void setHasDashboardRegions (bool f) { m_hasDashboardRegions = f; }
848     const Vector<DashboardRegionValue>& dashboardRegions() const;
849     void setDashboardRegions(const Vector<DashboardRegionValue>&);
850
851     void removeAllEventListenersFromAllNodes();
852
853     void registerDisconnectedNodeWithEventListeners(Node*);
854     void unregisterDisconnectedNodeWithEventListeners(Node*);
855     
856     HTMLFormElement::CheckedRadioButtons& checkedRadioButtons() { return m_checkedRadioButtons; }
857     
858 #if ENABLE(SVG)
859     const SVGDocumentExtensions* svgExtensions();
860     SVGDocumentExtensions* accessSVGExtensions();
861 #endif
862
863     void initSecurityOrigin();
864     SecurityOrigin* securityOrigin() const { return m_securityOrigin.get(); }
865
866     // Explicitly override the security origin for this document.
867     // Note: It is dangerous to change the security origin of a document
868     //       that already contains content.
869     void setSecurityOrigin(SecurityOrigin*);
870
871     bool processingLoadEvent() const { return m_processingLoadEvent; }
872
873 #if ENABLE(DATABASE)
874     void addOpenDatabase(Database*);
875     void removeOpenDatabase(Database*);
876     DatabaseThread* databaseThread();   // Creates the thread as needed, but not if it has been already terminated.
877     void setHasOpenDatabases() { m_hasOpenDatabases = true; }
878     bool hasOpenDatabases() { return m_hasOpenDatabases; }
879     void stopDatabases();
880 #endif
881 protected:
882     void clearXMLVersion() { m_xmlVersion = String(); }
883
884 private:
885     bool shouldBeAllowedToLoadLocalResources() const;
886
887     void updateTitle();
888     void removeAllDisconnectedNodeEventListeners();
889     void imageLoadEventTimerFired(Timer<Document>*);
890     void updateFocusAppearanceTimerFired(Timer<Document>*);
891
892     RefPtr<SecurityOrigin> m_securityOrigin;
893
894     RenderObject* m_savedRenderer;
895     int m_secureForms;
896     
897     RefPtr<TextResourceDecoder> m_decoder;
898
899     // We maintain the invariant that m_duplicateIds is the count of all elements with a given ID
900     // excluding the one referenced in m_elementsById, if any. This means it one less than the total count
901     // when the first node with a given ID is cached, otherwise the same as the total count.
902     mutable HashMap<AtomicStringImpl*, Element*> m_elementsById;
903     mutable HashCountedSet<AtomicStringImpl*> m_duplicateIds;
904     
905     mutable HashMap<StringImpl*, Element*, CaseFoldingHash> m_elementsByAccessKey;
906     
907     InheritedBool m_designMode;
908     
909     int m_selfOnlyRefCount;
910
911     HTMLFormElement::CheckedRadioButtons m_checkedRadioButtons;
912
913     typedef HashMap<AtomicStringImpl*, HTMLCollection::CollectionInfo*> NamedCollectionMap;
914     HTMLCollection::CollectionInfo m_collectionInfo[HTMLCollection::NumUnnamedDocumentCachedTypes];
915     NamedCollectionMap m_nameCollectionInfo[HTMLCollection::NumNamedDocumentCachedTypes];
916
917 #if ENABLE(XPATH)
918     RefPtr<XPathEvaluator> m_xpathEvaluator;
919 #endif
920     
921 #if ENABLE(SVG)
922     SVGDocumentExtensions* m_svgExtensions;
923 #endif
924     
925     Vector<DashboardRegionValue> m_dashboardRegions;
926     bool m_hasDashboardRegions;
927     bool m_dashboardRegionsDirty;
928
929     mutable bool m_accessKeyMapValid;
930     bool m_createRenderers;
931     bool m_inPageCache;
932     String m_iconURL;
933     
934     HashSet<Element*> m_pageCacheCallbackElements;
935
936     bool m_isAllowedToLoadLocalResources;
937
938     bool m_useSecureKeyboardEntryWhenActive;
939
940     bool m_isXHTML;
941
942     unsigned m_numNodeLists;
943
944 #if ENABLE(DATABASE)
945     RefPtr<DatabaseThread> m_databaseThread;
946     bool m_hasOpenDatabases;    // This never changes back to false, even as the database thread is closed.
947     typedef HashSet<Database*> DatabaseSet;
948     OwnPtr<DatabaseSet> m_openDatabaseSet;
949 #endif
950 #if USE(LOW_BANDWIDTH_DISPLAY)
951     bool m_inLowBandwidthDisplay;
952 #endif
953 };
954
955 } // namespace WebCore
956
957 #endif // Document_h