Home | History | Annotate | Download | only in editing 
      1 /*
      2  * Copyright (C) 2005, 2006, 2008 Apple 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 EditCommand_h
     27 #define EditCommand_h
     28 
     29 #include "core/editing/EditAction.h"
     30 #include "core/editing/VisibleSelection.h"
     31 
     32 #ifndef NDEBUG
     33 #include "wtf/HashSet.h"
     34 #endif
     35 
     36 namespace WebCore {
     37 
     38 class CompositeEditCommand;
     39 class Document;
     40 class Element;
     41 
     42 class EditCommand : public RefCounted<EditCommand> {
     43 public:
     44     virtual ~EditCommand();
     45 
     46     void setParent(CompositeEditCommand*);
     47 
     48     virtual EditAction editingAction() const;
     49 
     50     const VisibleSelection& startingSelection() const { return m_startingSelection; }
     51     const VisibleSelection& endingSelection() const { return m_endingSelection; }
     52 
     53     virtual bool isSimpleEditCommand() const { return false; }
     54     virtual bool isCompositeEditCommand() const { return false; }
     55     virtual bool isEditCommandComposition() const { return false; }
     56     bool isTopLevelCommand() const { return !m_parent; }
     57 
     58     virtual void doApply() = 0;
     59 
     60 protected:
     61     explicit EditCommand(Document*);
     62     EditCommand(Document*, const VisibleSelection&, const VisibleSelection&);
     63 
     64     Document* document() const { return m_document.get(); }
     65     CompositeEditCommand* parent() const { return m_parent; }
     66     void setStartingSelection(const VisibleSelection&);
     67     void setEndingSelection(const VisibleSelection&);
     68 
     69 private:
     70     RefPtr<Document> m_document;
     71     VisibleSelection m_startingSelection;
     72     VisibleSelection m_endingSelection;
     73     CompositeEditCommand* m_parent;
     74 };
     75 
     76 enum ShouldAssumeContentIsAlwaysEditable {
     77     AssumeContentIsAlwaysEditable,
     78     DoNotAssumeContentIsAlwaysEditable,
     79 };
     80 
     81 class SimpleEditCommand : public EditCommand {
     82 public:
     83     virtual void doUnapply() = 0;
     84     virtual void doReapply(); // calls doApply()
     85 
     86 #ifndef NDEBUG
     87     virtual void getNodesInCommand(HashSet<Node*>&) = 0;
     88 #endif
     89 
     90 protected:
     91     explicit SimpleEditCommand(Document* document) : EditCommand(document) { }
     92 
     93 #ifndef NDEBUG
     94     void addNodeAndDescendants(Node*, HashSet<Node*>&);
     95 #endif
     96 
     97 private:
     98     virtual bool isSimpleEditCommand() const OVERRIDE { return true; }
     99 };
    100 
    101 inline SimpleEditCommand* toSimpleEditCommand(EditCommand* command)
    102 {
    103     ASSERT(command);
    104     ASSERT_WITH_SECURITY_IMPLICATION(command->isSimpleEditCommand());
    105     return static_cast<SimpleEditCommand*>(command);
    106 }
    107 
    108 } // namespace WebCore
    109 
    110 #endif // EditCommand_h
    111