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#include "platform/heap/Handle.h"
32
33namespace blink {
34
35class CompositeEditCommand;
36class Document;
37
38class EditCommand : public RefCountedWillBeGarbageCollectedFinalized<EditCommand> {
39public:
40    virtual ~EditCommand();
41
42    void setParent(CompositeEditCommand*);
43
44    virtual EditAction editingAction() const;
45
46    const VisibleSelection& startingSelection() const { return m_startingSelection; }
47    const VisibleSelection& endingSelection() const { return m_endingSelection; }
48
49    virtual bool isSimpleEditCommand() const { return false; }
50    virtual bool isCompositeEditCommand() const { return false; }
51    bool isTopLevelCommand() const { return !m_parent; }
52
53    virtual void doApply() = 0;
54
55    virtual void trace(Visitor*);
56
57protected:
58    explicit EditCommand(Document&);
59    EditCommand(Document*, const VisibleSelection&, const VisibleSelection&);
60
61    Document& document() const { return *m_document.get(); }
62    CompositeEditCommand* parent() const { return m_parent; }
63    void setStartingSelection(const VisibleSelection&);
64    void setStartingSelection(const VisiblePosition&);
65    void setEndingSelection(const VisibleSelection&);
66    void setEndingSelection(const VisiblePosition&);
67
68private:
69    RefPtrWillBeMember<Document> m_document;
70    VisibleSelection m_startingSelection;
71    VisibleSelection m_endingSelection;
72    RawPtrWillBeMember<CompositeEditCommand> m_parent;
73};
74
75enum ShouldAssumeContentIsAlwaysEditable {
76    AssumeContentIsAlwaysEditable,
77    DoNotAssumeContentIsAlwaysEditable,
78};
79
80class SimpleEditCommand : public EditCommand {
81public:
82    virtual void doUnapply() = 0;
83    virtual void doReapply(); // calls doApply()
84
85protected:
86    explicit SimpleEditCommand(Document& document) : EditCommand(document) { }
87
88private:
89    virtual bool isSimpleEditCommand() const OVERRIDE FINAL { return true; }
90};
91
92DEFINE_TYPE_CASTS(SimpleEditCommand, EditCommand, command, command->isSimpleEditCommand(), command.isSimpleEditCommand());
93
94} // namespace blink
95
96#endif // EditCommand_h
97