/*
 * Copyright (C) 2005, 2006, 2008 Apple Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef EditCommand_h
#define EditCommand_h

#include "core/CoreExport.h"
#include "core/editing/VisibleSelection.h"
#include "core/events/InputEvent.h"
#include "platform/heap/Handle.h"

namespace blink {

class CompositeEditCommand;
class Document;
class EditingState;

class CORE_EXPORT EditCommand : public GarbageCollectedFinalized<EditCommand> {
 public:
  virtual ~EditCommand();

  void setParent(CompositeEditCommand*);

  virtual InputEvent::InputType inputType() const;

  const VisibleSelection& startingSelection() const {
    return m_startingSelection;
  }
  const VisibleSelection& endingSelection() const { return m_endingSelection; }

  virtual bool isSimpleEditCommand() const { return false; }
  virtual bool isCompositeEditCommand() const { return false; }
  bool isTopLevelCommand() const { return !m_parent; }

  // The |EditingState*| argument must not be nullptr.
  virtual void doApply(EditingState*) = 0;

  // |TypingCommand| will return the text of the last |m_commands|.
  virtual String textDataForInputEvent() const;

  DECLARE_VIRTUAL_TRACE();

 protected:
  explicit EditCommand(Document&);

  Document& document() const { return *m_document.get(); }
  CompositeEditCommand* parent() const { return m_parent; }
  void setStartingSelection(const VisibleSelection&);
  void setEndingSelection(const SelectionInDOMTree&);
  // TODO(yosin): |setEndingVisibleSelection()| will take |SelectionInUndoStep|
  // You should not use this function other than copying existing selection.
  void setEndingVisibleSelection(const VisibleSelection&);

  // TODO(yosin) |isRenderedCharacter()| should be removed, and we should use
  // |VisiblePosition::characterAfter()| and
  // |VisiblePosition::characterBefore()|.
  static bool isRenderedCharacter(const Position&);

 private:
  Member<Document> m_document;
  VisibleSelection m_startingSelection;
  VisibleSelection m_endingSelection;
  Member<CompositeEditCommand> m_parent;
};

enum ShouldAssumeContentIsAlwaysEditable {
  AssumeContentIsAlwaysEditable,
  DoNotAssumeContentIsAlwaysEditable,
};

class SimpleEditCommand : public EditCommand {
 public:
  virtual void doUnapply() = 0;
  virtual void doReapply();  // calls doApply()

 protected:
  explicit SimpleEditCommand(Document& document) : EditCommand(document) {}

 private:
  bool isSimpleEditCommand() const final { return true; }
};

DEFINE_TYPE_CASTS(SimpleEditCommand,
                  EditCommand,
                  command,
                  command->isSimpleEditCommand(),
                  command.isSimpleEditCommand());

}  // namespace blink

#endif  // EditCommand_h
