Reviewed by Darin
[WebKit-https.git] / WebCore / khtml / editing / htmlediting.h
1 /*
2  * Copyright (C) 2004 Apple Computer, Inc.  All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef __htmlediting_h__
27 #define __htmlediting_h__
28
29 #include "dom_nodeimpl.h"
30 #include "editing/edit_actions.h"
31 #include "qptrlist.h"
32 #include "qvaluelist.h"
33 #include "selection.h"
34 #include "shared.h"
35
36 namespace DOM {
37     class CSSMutableStyleDeclarationImpl;
38     class CSSProperty;
39     class CSSStyleDeclarationImpl;
40     class DocumentFragmentImpl;
41     class HTMLElementImpl;
42     class TextImpl;
43 }
44
45 namespace khtml {
46
47 class EditCommand;
48 class Selection;
49 class VisiblePosition;
50
51 //------------------------------------------------------------------------------------------
52 // EditCommandPtr
53
54 class EditCommandPtr : public SharedPtr<EditCommand>
55 {
56 public:
57     EditCommandPtr();
58     EditCommandPtr(EditCommand *);
59     EditCommandPtr(const EditCommandPtr &);
60     ~EditCommandPtr();
61
62     EditCommandPtr &operator=(const EditCommandPtr &);
63
64     bool isCompositeStep() const;
65
66     void apply() const;
67     void unapply() const;
68     void reapply() const;
69
70     EditAction editingAction() const;
71
72     DOM::DocumentImpl * const document() const;
73
74     Selection startingSelection() const;
75     Selection endingSelection() const;
76
77     void setStartingSelection(const Selection &s) const;
78     void setEndingSelection(const Selection &s) const;
79
80     DOM::CSSMutableStyleDeclarationImpl *typingStyle() const;
81     void setTypingStyle(DOM::CSSMutableStyleDeclarationImpl *) const;
82
83     EditCommandPtr parent() const;
84     void setParent(const EditCommandPtr &) const;
85
86     bool isInsertTextCommand() const;
87     bool isInsertLineBreakCommand() const;
88     bool isTypingCommand() const;
89
90     static EditCommandPtr &emptyCommand();
91 };
92
93 //------------------------------------------------------------------------------------------
94 // StyleChange
95
96 class StyleChange {
97 public:
98     enum ELegacyHTMLStyles { DoNotUseLegacyHTMLStyles, UseLegacyHTMLStyles };
99
100     explicit StyleChange(DOM::CSSStyleDeclarationImpl *, ELegacyHTMLStyles usesLegacyStyles=UseLegacyHTMLStyles);
101     StyleChange(DOM::CSSStyleDeclarationImpl *, const DOM::Position &, ELegacyHTMLStyles usesLegacyStyles=UseLegacyHTMLStyles);
102
103     DOM::DOMString cssStyle() const { return m_cssStyle; }
104     bool applyBold() const { return m_applyBold; }
105     bool applyItalic() const { return m_applyItalic; }
106     bool usesLegacyStyles() const { return m_usesLegacyStyles; }
107
108 private:
109     void init(DOM::CSSStyleDeclarationImpl *, const DOM::Position &);
110     bool checkForLegacyHTMLStyleChange(const DOM::CSSProperty *);
111     static bool currentlyHasStyle(const DOM::Position &, const DOM::CSSProperty *);
112     
113     DOM::DOMString m_cssStyle;
114     bool m_applyBold;
115     bool m_applyItalic;
116     bool m_usesLegacyStyles;
117 };
118
119 //------------------------------------------------------------------------------------------
120 // EditCommand
121
122 class EditCommand : public Shared<EditCommand>
123 {
124 public:
125     EditCommand(DOM::DocumentImpl *);
126     virtual ~EditCommand();
127
128     bool isCompositeStep() const { return m_parent != 0; }
129     EditCommand *parent() const { return m_parent; }
130     void setParent(EditCommand *parent) { m_parent = parent; }
131
132     enum ECommandState { NotApplied, Applied };
133     
134     void apply();       
135     void unapply();
136     void reapply();
137
138     virtual void doApply() = 0;
139     virtual void doUnapply() = 0;
140     virtual void doReapply();  // calls doApply()
141
142     virtual EditAction editingAction() const;
143
144     virtual DOM::DocumentImpl * const document() const { return m_document; }
145
146     Selection startingSelection() const { return m_startingSelection; }
147     Selection endingSelection() const { return m_endingSelection; }
148
149     void setEndingSelectionNeedsLayout(bool flag=true) { m_endingSelection.setNeedsLayout(flag); }
150         
151     ECommandState state() const { return m_state; }
152     void setState(ECommandState state) { m_state = state; }
153
154     void setStartingSelection(const Selection &s);
155     void setEndingSelection(const Selection &s);
156
157     DOM::CSSMutableStyleDeclarationImpl *typingStyle() const { return m_typingStyle; };
158     void setTypingStyle(DOM::CSSMutableStyleDeclarationImpl *);
159     
160     virtual bool isInsertTextCommand() const;
161     virtual bool isTypingCommand() const;
162     
163 private:
164     void assignTypingStyle(DOM::CSSMutableStyleDeclarationImpl *);
165
166     virtual bool preservesTypingStyle() const;
167
168     DOM::DocumentImpl *m_document;
169     ECommandState m_state;
170     Selection m_startingSelection;
171     Selection m_endingSelection;
172     DOM::CSSMutableStyleDeclarationImpl *m_typingStyle;
173     EditCommand *m_parent;
174 };
175
176 //------------------------------------------------------------------------------------------
177 // CompositeEditCommand
178
179 class CompositeEditCommand : public EditCommand
180 {
181 public:
182     CompositeEditCommand(DOM::DocumentImpl *);
183         
184     virtual void doUnapply();
185     virtual void doReapply();
186
187 protected:
188     //
189     // sugary-sweet convenience functions to help create and apply edit commands in composite commands
190     //
191     void appendNode(DOM::NodeImpl *appendChild, DOM::NodeImpl *parentNode);
192     void applyCommandToComposite(EditCommandPtr &);
193     void deleteKeyPressed();
194     void deleteSelection(bool smartDelete=false, bool mergeBlocksAfterDelete=true);
195     void deleteSelection(const Selection &selection, bool smartDelete=false, bool mergeBlocksAfterDelete=true);
196     void deleteTextFromNode(DOM::TextImpl *node, long offset, long count);
197     void inputText(const DOM::DOMString &text, bool selectInsertedText = false);
198     void insertNodeAfter(DOM::NodeImpl *insertChild, DOM::NodeImpl *refChild);
199     void insertNodeAt(DOM::NodeImpl *insertChild, DOM::NodeImpl *refChild, long offset);
200     void insertNodeBefore(DOM::NodeImpl *insertChild, DOM::NodeImpl *refChild);
201     void insertParagraphSeparator();
202     void insertTextIntoNode(DOM::TextImpl *node, long offset, const DOM::DOMString &text);
203     void joinTextNodes(DOM::TextImpl *text1, DOM::TextImpl *text2);
204     void rebalanceWhitespace();
205     void removeCSSProperty(DOM::CSSStyleDeclarationImpl *, int property);
206     void removeFullySelectedNode(DOM::NodeImpl *);
207     void removeNodeAttribute(DOM::ElementImpl *, int attribute);
208     void removeNode(DOM::NodeImpl *removeChild);
209     void removeNodePreservingChildren(DOM::NodeImpl *node);
210     void replaceTextInNode(DOM::TextImpl *node, long offset, long count, const DOM::DOMString &replacementText);
211     void setNodeAttribute(DOM::ElementImpl *, int attribute, const DOM::DOMString &);
212     void splitTextNode(DOM::TextImpl *text, long offset);
213
214     DOM::NodeImpl *applyTypingStyle(DOM::NodeImpl *) const;
215
216     void deleteInsignificantText(DOM::TextImpl *, int start, int end);
217     void deleteInsignificantText(const DOM::Position &start, const DOM::Position &end);
218     void deleteInsignificantTextDownstream(const DOM::Position &);
219
220     void insertBlockPlaceholderIfNeeded(DOM::NodeImpl *);
221     bool removeBlockPlaceholderIfNeeded(DOM::NodeImpl *);
222
223     void moveParagraphContentsToNewBlockIfNecessary(const DOM::Position &);
224
225     bool isMailBlockquote(const DOM::NodeImpl *) const;
226
227     QValueList<EditCommandPtr> m_cmds;
228 };
229
230 //==========================================================================================
231 // Concrete commands
232 //------------------------------------------------------------------------------------------
233 // AppendNodeCommand
234
235 class AppendNodeCommand : public EditCommand
236 {
237 public:
238     AppendNodeCommand(DOM::DocumentImpl *, DOM::NodeImpl *appendChild, DOM::NodeImpl *parentNode);
239     virtual ~AppendNodeCommand();
240
241     virtual void doApply();
242     virtual void doUnapply();
243
244     DOM::NodeImpl *appendChild() const { return m_appendChild; }
245     DOM::NodeImpl *parentNode() const { return m_parentNode; }
246
247 private:
248     DOM::NodeImpl *m_appendChild;
249     DOM::NodeImpl *m_parentNode;    
250 };
251
252 //------------------------------------------------------------------------------------------
253 // ApplyStyleCommand
254
255 class ApplyStyleCommand : public CompositeEditCommand
256 {
257 public:
258     ApplyStyleCommand(DOM::DocumentImpl *, DOM::CSSStyleDeclarationImpl *style, EditAction editingAction=EditActionChangeAttributes);
259     virtual ~ApplyStyleCommand();
260         
261     virtual void doApply();
262     virtual EditAction editingAction() const;
263
264     DOM::CSSMutableStyleDeclarationImpl *style() const { return m_style; }
265
266 private:
267     // style-removal helpers
268     bool isHTMLStyleNode(DOM::CSSMutableStyleDeclarationImpl *, DOM::HTMLElementImpl *);
269     void removeHTMLStyleNode(DOM::HTMLElementImpl *);
270     void removeCSSStyle(DOM::CSSMutableStyleDeclarationImpl *, DOM::HTMLElementImpl *);
271     void removeBlockStyle(DOM::CSSMutableStyleDeclarationImpl *, const DOM::Position &start, const DOM::Position &end);
272     void removeInlineStyle(DOM::CSSMutableStyleDeclarationImpl *, const DOM::Position &start, const DOM::Position &end);
273     bool nodeFullySelected(DOM::NodeImpl *, const DOM::Position &start, const DOM::Position &end) const;
274
275     // style-application helpers
276     void applyBlockStyle(DOM::CSSMutableStyleDeclarationImpl *);
277     void applyInlineStyle(DOM::CSSMutableStyleDeclarationImpl *);
278     void addBlockStyleIfNeeded(DOM::CSSMutableStyleDeclarationImpl *, DOM::NodeImpl *);
279     void addInlineStyleIfNeeded(DOM::CSSMutableStyleDeclarationImpl *, DOM::NodeImpl *start, DOM::NodeImpl *end);
280     bool splitTextAtStartIfNeeded(const DOM::Position &start, const DOM::Position &end);
281     DOM::NodeImpl *splitTextAtEndIfNeeded(const DOM::Position &start, const DOM::Position &end);
282     void surroundNodeRangeWithElement(DOM::NodeImpl *start, DOM::NodeImpl *end, DOM::ElementImpl *element);
283     DOM::Position positionInsertionPoint(DOM::Position);
284     
285     DOM::CSSMutableStyleDeclarationImpl *m_style;
286     EditAction m_editingAction;
287 };
288
289 //------------------------------------------------------------------------------------------
290 // DeleteFromTextNodeCommand
291
292 class DeleteFromTextNodeCommand : public EditCommand
293 {
294 public:
295     DeleteFromTextNodeCommand(DOM::DocumentImpl *document, DOM::TextImpl *node, long offset, long count);
296     virtual ~DeleteFromTextNodeCommand();
297         
298     virtual void doApply();
299     virtual void doUnapply();
300
301     DOM::TextImpl *node() const { return m_node; }
302     long offset() const { return m_offset; }
303     long count() const { return m_count; }
304
305 private:
306     DOM::TextImpl *m_node;
307     long m_offset;
308     long m_count;
309     DOM::DOMString m_text;
310 };
311
312 //------------------------------------------------------------------------------------------
313 // DeleteSelectionCommand
314
315 class DeleteSelectionCommand : public CompositeEditCommand
316
317 public:
318     DeleteSelectionCommand(DOM::DocumentImpl *document, bool smartDelete=false, bool mergeBlocksAfterDelete=true);
319     DeleteSelectionCommand(DOM::DocumentImpl *document, const Selection &selection, bool smartDelete=false, bool mergeBlocksAfterDelete=true);
320         
321     virtual void doApply();
322     virtual EditAction editingAction() const;
323     
324 private:
325     virtual bool preservesTypingStyle() const;
326
327     void initializePositionData();
328     void saveTypingStyleState();
329     void insertPlaceholderForAncestorBlockContent();
330     bool handleSpecialCaseAllContentDelete();
331     bool handleSpecialCaseBRDelete();
332     void handleGeneralDelete();
333     void fixupWhitespace();
334     void moveNodesAfterNode();
335     void calculateEndingPosition();
336     void calculateTypingStyleAfterDelete();
337     void clearTransientState();
338
339     bool m_hasSelectionToDelete;
340     bool m_smartDelete;
341     bool m_mergeBlocksAfterDelete;
342     bool m_trailingWhitespaceValid;
343
344     // This data is transient and should be cleared at the end of the doApply function.
345     Selection m_selectionToDelete;
346     DOM::Position m_upstreamStart;
347     DOM::Position m_downstreamStart;
348     DOM::Position m_upstreamEnd;
349     DOM::Position m_downstreamEnd;
350     DOM::Position m_endingPosition;
351     DOM::Position m_leadingWhitespace;
352     DOM::Position m_trailingWhitespace;
353     DOM::NodeImpl *m_startBlock;
354     DOM::NodeImpl *m_endBlock;
355     DOM::NodeImpl *m_startNode;
356     DOM::CSSMutableStyleDeclarationImpl *m_typingStyle;
357 };
358
359 //------------------------------------------------------------------------------------------
360 // InsertIntoTextNode
361
362 class InsertIntoTextNode : public EditCommand
363 {
364 public:
365     InsertIntoTextNode(DOM::DocumentImpl *document, DOM::TextImpl *, long, const DOM::DOMString &);
366     virtual ~InsertIntoTextNode();
367         
368     virtual void doApply();
369     virtual void doUnapply();
370
371     DOM::TextImpl *node() const { return m_node; }
372     long offset() const { return m_offset; }
373     DOM::DOMString text() const { return m_text; }
374
375 private:
376     DOM::TextImpl *m_node;
377     long m_offset;
378     DOM::DOMString m_text;
379 };
380
381 //------------------------------------------------------------------------------------------
382 // InsertNodeBeforeCommand
383
384 class InsertNodeBeforeCommand : public EditCommand
385 {
386 public:
387     InsertNodeBeforeCommand(DOM::DocumentImpl *, DOM::NodeImpl *insertChild, DOM::NodeImpl *refChild);
388     virtual ~InsertNodeBeforeCommand();
389
390     virtual void doApply();
391     virtual void doUnapply();
392
393     DOM::NodeImpl *insertChild() const { return m_insertChild; }
394     DOM::NodeImpl *refChild() const { return m_refChild; }
395
396 private:
397     DOM::NodeImpl *m_insertChild;
398     DOM::NodeImpl *m_refChild; 
399 };
400
401 //------------------------------------------------------------------------------------------
402 // InsertLineBreakCommand
403
404 class InsertLineBreakCommand : public CompositeEditCommand
405 {
406 public:
407     InsertLineBreakCommand(DOM::DocumentImpl *document);
408
409     virtual void doApply();
410
411 private:
412     virtual bool preservesTypingStyle() const;
413     void insertNodeAfterPosition(DOM::NodeImpl *node, const DOM::Position &pos);
414     void insertNodeBeforePosition(DOM::NodeImpl *node, const DOM::Position &pos);
415 };
416
417 //------------------------------------------------------------------------------------------
418 // InsertParagraphSeparatorCommand
419
420 class InsertParagraphSeparatorCommand : public CompositeEditCommand
421 {
422 public:
423     InsertParagraphSeparatorCommand(DOM::DocumentImpl *document);
424     virtual ~InsertParagraphSeparatorCommand();
425
426     virtual void doApply();
427
428 private:
429     DOM::ElementImpl *createParagraphElement();
430     void setFullTypingStyleBeforeInsertion(const DOM::Position &);
431     void calculateAndSetTypingStyleAfterInsertion();
432
433     virtual bool preservesTypingStyle() const;
434
435     QPtrList<DOM::NodeImpl> ancestors;
436     QPtrList<DOM::NodeImpl> clonedNodes;
437     DOM::CSSMutableStyleDeclarationImpl *m_fullTypingStyle;
438 };
439
440 //------------------------------------------------------------------------------------------
441 // InsertParagraphSeparatorInQuotedContentCommand
442
443 class InsertParagraphSeparatorInQuotedContentCommand : public CompositeEditCommand
444 {
445 public:
446     InsertParagraphSeparatorInQuotedContentCommand(DOM::DocumentImpl *);
447     virtual ~InsertParagraphSeparatorInQuotedContentCommand();
448         
449     virtual void doApply();
450     
451 private:
452     QPtrList<DOM::NodeImpl> ancestors;
453     QPtrList<DOM::NodeImpl> clonedNodes;
454     DOM::ElementImpl *m_breakNode;
455 };
456
457 //------------------------------------------------------------------------------------------
458 // InsertTextCommand
459
460 class InsertTextCommand : public CompositeEditCommand
461 {
462 public:
463     InsertTextCommand(DOM::DocumentImpl *document);
464
465     virtual void doApply();
466
467     void deleteCharacter();
468     void input(const DOM::DOMString &text, bool selectInsertedText = false);
469     
470     unsigned long charactersAdded() const { return m_charactersAdded; }
471     
472 private:
473     virtual bool isInsertTextCommand() const;
474
475     DOM::Position prepareForTextInsertion(bool adjustDownstream);
476     void insertSpace(DOM::TextImpl *textNode, unsigned long offset);
477
478     unsigned long m_charactersAdded;
479 };
480
481 //------------------------------------------------------------------------------------------
482 // JoinTextNodesCommand
483
484 class JoinTextNodesCommand : public EditCommand
485 {
486 public:
487     JoinTextNodesCommand(DOM::DocumentImpl *, DOM::TextImpl *, DOM::TextImpl *);
488     virtual ~JoinTextNodesCommand();
489         
490     virtual void doApply();
491     virtual void doUnapply();
492
493     DOM::TextImpl *firstNode() const { return m_text1; }
494     DOM::TextImpl *secondNode() const { return m_text2; }
495
496 private:
497     DOM::TextImpl *m_text1;
498     DOM::TextImpl *m_text2;
499     unsigned long m_offset;
500 };
501
502 //------------------------------------------------------------------------------------------
503 // MoveSelectionCommand
504
505 class MoveSelectionCommand : public CompositeEditCommand
506 {
507 public:
508     MoveSelectionCommand(DOM::DocumentImpl *document, DOM::DocumentFragmentImpl *fragment, DOM::Position &position, bool smartMove=false);
509     virtual ~MoveSelectionCommand();
510     
511     virtual void doApply();
512     virtual EditAction editingAction() const;
513     
514 private:
515     DOM::DocumentFragmentImpl *m_fragment;
516     DOM::Position m_position;
517     bool m_smartMove;
518 };
519
520 //------------------------------------------------------------------------------------------
521 // RebalanceWhitespaceCommand
522
523 class RebalanceWhitespaceCommand : public EditCommand
524 {
525 public:
526     RebalanceWhitespaceCommand(DOM::DocumentImpl *, const DOM::Position &);
527     virtual ~RebalanceWhitespaceCommand();
528
529     virtual void doApply();
530     virtual void doUnapply();
531
532 private:
533     enum { InvalidOffset = -1 };
534
535     virtual bool preservesTypingStyle() const;
536
537     DOM::DOMString m_beforeString;
538     DOM::DOMString m_afterString;
539     DOM::Position m_position;
540     long m_upstreamOffset;
541     long m_downstreamOffset;
542 };
543
544 //------------------------------------------------------------------------------------------
545 // RemoveCSSPropertyCommand
546
547 class RemoveCSSPropertyCommand : public EditCommand
548 {
549 public:
550     RemoveCSSPropertyCommand(DOM::DocumentImpl *, DOM::CSSStyleDeclarationImpl *, int property);
551     virtual ~RemoveCSSPropertyCommand();
552
553     virtual void doApply();
554     virtual void doUnapply();
555
556     DOM::CSSMutableStyleDeclarationImpl *styleDeclaration() const { return m_decl; }
557     int property() const { return m_property; }
558     
559 private:
560     DOM::CSSMutableStyleDeclarationImpl *m_decl;
561     int m_property;
562     DOM::DOMString m_oldValue;
563     bool m_important;
564 };
565
566 //------------------------------------------------------------------------------------------
567 // RemoveNodeAttributeCommand
568
569 class RemoveNodeAttributeCommand : public EditCommand
570 {
571 public:
572     RemoveNodeAttributeCommand(DOM::DocumentImpl *, DOM::ElementImpl *, DOM::NodeImpl::Id attribute);
573     virtual ~RemoveNodeAttributeCommand();
574
575     virtual void doApply();
576     virtual void doUnapply();
577
578     DOM::ElementImpl *element() const { return m_element; }
579     DOM::NodeImpl::Id attribute() const { return m_attribute; }
580     
581 private:
582     DOM::ElementImpl *m_element;
583     DOM::NodeImpl::Id m_attribute;
584     DOM::DOMString m_oldValue;
585 };
586
587 //------------------------------------------------------------------------------------------
588 // RemoveNodeCommand
589
590 class RemoveNodeCommand : public EditCommand
591 {
592 public:
593     RemoveNodeCommand(DOM::DocumentImpl *, DOM::NodeImpl *);
594     virtual ~RemoveNodeCommand();
595         
596     virtual void doApply();
597     virtual void doUnapply();
598
599     DOM::NodeImpl *node() const { return m_removeChild; }
600
601 private:
602     DOM::NodeImpl *m_parent;    
603     DOM::NodeImpl *m_removeChild;
604     DOM::NodeImpl *m_refChild;    
605 };
606
607 //------------------------------------------------------------------------------------------
608 // RemoveNodePreservingChildrenCommand
609
610 class RemoveNodePreservingChildrenCommand : public CompositeEditCommand
611 {
612 public:
613     RemoveNodePreservingChildrenCommand(DOM::DocumentImpl *, DOM::NodeImpl *);
614     virtual ~RemoveNodePreservingChildrenCommand();
615         
616     virtual void doApply();
617
618     DOM::NodeImpl *node() const { return m_node; }
619
620 private:
621     DOM::NodeImpl *m_node;
622 };
623
624 //------------------------------------------------------------------------------------------
625 // ReplaceSelectionCommand
626
627 // --- ReplacementFragment helper class
628
629 class ReplacementFragment
630 {
631 public:
632     ReplacementFragment(DOM::DocumentFragmentImpl *fragment);
633     ~ReplacementFragment();
634
635     enum EFragmentType { EmptyFragment, SingleTextNodeFragment, TreeFragment };
636
637     DOM::DocumentFragmentImpl *root() const { return m_fragment; }
638     DOM::NodeImpl *firstChild() const;
639     DOM::NodeImpl *lastChild() const;
640
641     DOM::NodeImpl *mergeStartNode() const;
642     DOM::NodeImpl *mergeEndNode() const;
643     
644     void pruneEmptyNodes();
645
646     EFragmentType type() const { return m_type; }
647     bool isEmpty() const { return m_type == EmptyFragment; }
648     bool isSingleTextNode() const { return m_type == SingleTextNodeFragment; }
649     bool isTreeFragment() const { return m_type == TreeFragment; }
650
651     bool hasMoreThanOneBlock() const { return m_hasMoreThanOneBlock; }
652     bool hasInterchangeNewline() const { return m_hasInterchangeNewline; }
653
654 private:
655     // no copy construction or assignment
656     ReplacementFragment(const ReplacementFragment &);
657     ReplacementFragment &operator=(const ReplacementFragment &);
658
659     static bool isInterchangeNewlineNode(const DOM::NodeImpl *);
660     static bool isInterchangeConvertedSpaceSpan(const DOM::NodeImpl *);
661
662     // A couple simple DOM helpers
663     DOM::NodeImpl *enclosingBlock(DOM::NodeImpl *) const;
664     void removeNode(DOM::NodeImpl *);
665     void insertNodeBefore(DOM::NodeImpl *node, DOM::NodeImpl *refNode);
666
667     EFragmentType m_type;
668     DOM::DocumentFragmentImpl *m_fragment;
669     bool m_hasInterchangeNewline;
670     bool m_hasMoreThanOneBlock;
671 };
672
673 // free-floating helper functions
674 bool isProbablyBlock(const DOM::NodeImpl *);
675
676 class ReplaceSelectionCommand : public CompositeEditCommand
677 {
678 public:
679     ReplaceSelectionCommand(DOM::DocumentImpl *document, DOM::DocumentFragmentImpl *fragment, bool selectReplacement=true, bool smartReplace=false);
680     virtual ~ReplaceSelectionCommand();
681     
682     virtual void doApply();
683     virtual EditAction editingAction() const;
684
685 private:
686     void completeHTMLReplacement(const DOM::Position &, const DOM::Position &);
687     void completeHTMLReplacement(DOM::NodeImpl *, DOM::NodeImpl *);
688     
689     ReplacementFragment m_fragment;
690     bool m_selectReplacement;
691     bool m_smartReplace;
692 };
693
694 //------------------------------------------------------------------------------------------
695 // SetNodeAttributeCommand
696
697 class SetNodeAttributeCommand : public EditCommand
698 {
699 public:
700     SetNodeAttributeCommand(DOM::DocumentImpl *, DOM::ElementImpl *, DOM::NodeImpl::Id attribute, const DOM::DOMString &value);
701     virtual ~SetNodeAttributeCommand();
702
703     virtual void doApply();
704     virtual void doUnapply();
705
706     DOM::ElementImpl *element() const { return m_element; }
707     DOM::NodeImpl::Id attribute() const { return m_attribute; }
708     DOM::DOMString value() const { return m_value; }
709     
710 private:
711     DOM::ElementImpl *m_element;
712     DOM::NodeImpl::Id m_attribute;
713     DOM::DOMString m_value;
714     DOM::DOMString m_oldValue;
715 };
716
717 //------------------------------------------------------------------------------------------
718 // SplitTextNodeCommand
719
720 class SplitTextNodeCommand : public EditCommand
721 {
722 public:
723     SplitTextNodeCommand(DOM::DocumentImpl *, DOM::TextImpl *, long);
724     virtual ~SplitTextNodeCommand();
725         
726     virtual void doApply();
727     virtual void doUnapply();
728
729     DOM::TextImpl *node() const { return m_text2; }
730     long offset() const { return m_offset; }
731
732 private:
733     DOM::TextImpl *m_text1;
734     DOM::TextImpl *m_text2;
735     unsigned long m_offset;
736 };
737
738 //------------------------------------------------------------------------------------------
739 // TypingCommand
740
741 class TypingCommand : public CompositeEditCommand
742 {
743 public:
744     enum ETypingCommand { 
745         DeleteKey, 
746         InsertText, 
747         InsertLineBreak, 
748         InsertParagraphSeparator,
749         InsertParagraphSeparatorInQuotedContent,
750     };
751
752     TypingCommand(DOM::DocumentImpl *document, ETypingCommand, const DOM::DOMString &text = "", bool selectInsertedText = false);
753
754     static void deleteKeyPressed(DOM::DocumentImpl *);
755     static void insertText(DOM::DocumentImpl *, const DOM::DOMString &, bool selectInsertedText = false);
756     static void insertLineBreak(DOM::DocumentImpl *);
757     static void insertParagraphSeparator(DOM::DocumentImpl *);
758     static void insertParagraphSeparatorInQuotedContent(DOM::DocumentImpl *);
759     static bool isOpenForMoreTypingCommand(const EditCommandPtr &);
760     static void closeTyping(const EditCommandPtr &);
761     
762     virtual void doApply();
763     virtual EditAction editingAction() const;
764
765     bool openForMoreTyping() const { return m_openForMoreTyping; }
766     void closeTyping() { m_openForMoreTyping = false; }
767
768     void insertText(const DOM::DOMString &text, bool selectInsertedText);
769     void insertLineBreak();
770     void insertParagraphSeparatorInQuotedContent();
771     void insertParagraphSeparator();
772     void deleteKeyPressed();
773
774 private:
775     virtual bool isTypingCommand() const;
776     virtual bool preservesTypingStyle() const;
777
778     void issueCommandForDeleteKey();
779     void removeCommand(const EditCommandPtr &);
780     void markMisspellingsAfterTyping();
781     void typingAddedToOpenCommand();
782     
783     ETypingCommand m_commandType;
784     DOM::DOMString m_textToInsert;
785     bool m_openForMoreTyping;
786     bool m_applyEditing;
787     bool m_selectInsertedText;
788 };
789
790 //------------------------------------------------------------------------------------------
791
792 DOM::ElementImpl *createDefaultParagraphElement(DOM::DocumentImpl *document);
793 DOM::ElementImpl *createBlockPlaceholderElement(DOM::DocumentImpl *document);
794 DOM::ElementImpl *createBreakElement(DOM::DocumentImpl *document);
795
796 //------------------------------------------------------------------------------------------
797
798 } // end namespace khtml
799
800 #endif