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