/*
 * 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 THIRD_PARTY_BLINK_RENDERER_CORE_EDITING_COMMANDS_EDIT_COMMAND_H_
#define THIRD_PARTY_BLINK_RENDERER_CORE_EDITING_COMMANDS_EDIT_COMMAND_H_

#include "base/types/strong_alias.h"
#include "third_party/blink/renderer/core/core_export.h"
#include "third_party/blink/renderer/core/events/input_event.h"
#include "third_party/blink/renderer/platform/heap/garbage_collected.h"
#include "third_party/blink/renderer/platform/wtf/casting.h"

namespace blink {

class CompositeEditCommand;
class Document;
class EditingState;

class CORE_EXPORT EditCommand : public GarbageCollected<EditCommand> {
 public:
  // Specifies which password echo setting to be used when executing text
  // insertion or replacement operations within a password field.
  enum class PasswordEchoBehavior {
    kEchoIfPasswordEchoPhysicalEnabled,
    kEchoIfPasswordEchoTouchEnabled,
    // Password characters should only be echoed interactively during typing.
    // Editing operations like pasting from clipboard should not trigger the
    // password echo animation.
    kDoNotEcho
  };

  virtual ~EditCommand();

  virtual void SetParent(CompositeEditCommand*);

  virtual InputEvent::InputType GetInputType() const;

  virtual bool IsSimpleEditCommand() const { return false; }
  virtual bool IsCompositeEditCommand() const { return false; }
  bool IsTopLevelCommand() const { return !parent_; }

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

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

  virtual void Trace(Visitor*) const;
  bool SelectionIsDirectional() const { return selection_is_directional_; }
  void SetSelectionIsDirectional(bool is_directional) {
    selection_is_directional_ = is_directional;
  }

 protected:
  explicit EditCommand(Document&);

  Document& GetDocument() const { return *document_.Get(); }
  CompositeEditCommand* Parent() const { return parent_.Get(); }

  static bool IsRenderedCharacter(const Position&);

 private:
  Member<Document> document_;
  Member<CompositeEditCommand> parent_;
  bool selection_is_directional_ = false;
};

using ShouldAssumeContentIsAlwaysEditable =
    base::StrongAlias<class ShouldAssumeContentIsAlwaysEditableTag, bool>;

class CORE_EXPORT SimpleEditCommand : public EditCommand {
 public:
  virtual void DoUnapply() = 0;
  virtual void DoReapply();  // calls doApply()

  virtual String ToString() const = 0;

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

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

template <>
struct DowncastTraits<SimpleEditCommand> {
  static bool AllowFrom(const EditCommand& command) {
    return command.IsSimpleEditCommand();
  }
};

}  // namespace blink

#endif  // THIRD_PARTY_BLINK_RENDERER_CORE_EDITING_COMMANDS_EDIT_COMMAND_H_