/*
 * Copyright (C) 2009 Google 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:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * 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.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "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 THE COPYRIGHT
 * OWNER 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_PUBLIC_WEB_WEB_NODE_H_
#define THIRD_PARTY_BLINK_PUBLIC_WEB_WEB_NODE_H_

#include <iosfwd>
#include <vector>

#include "base/functional/callback_forward.h"
#include "cc/paint/element_id.h"
#include "third_party/blink/public/platform/web_common.h"
#include "third_party/blink/public/platform/web_private_ptr.h"
#include "third_party/blink/public/platform/web_string.h"
#include "third_party/blink/public/web/web_dom_event.h"
#include "v8/include/cppgc/source-location.h"
#include "v8/include/v8-forward.h"

#if INSIDE_BLINK
#include "third_party/blink/renderer/platform/wtf/casting.h"
#endif  // INSIDE_BLINK

namespace base {
class ScopedClosureRunner;
}  // namespace base

namespace blink {

class Node;
class WebDocument;
class WebElement;
class WebElementCollection;
class WebPluginContainer;

// BLINK_WEB_NODE_LOCATION_FROM_HERE is used to optimize away much of
// the code size cost of cppgc::SourceLocation::Current for builds that
// do not need them.  This macro should be used in the constructor of
// WebNode and of any classes that derive from it or use it that want to
// provide source locations for debugging in developer tools heap
// snapshots.
#if BUILDFLAG(VERBOSE_PERSISTENT)
#define BLINK_WEB_NODE_LOCATION_FROM_HERE cppgc::SourceLocation::Current()
#else  // !BUILDFLAG(VERBOSE_PERSISTENT)
#define BLINK_WEB_NODE_LOCATION_FROM_HERE cppgc::SourceLocation()
#endif  // !BUILDFLAG(VERBOSE_PERSISTENT)

// Provides access to some properties of a DOM node.
// Note that the class design requires that neither this class nor any of its
// subclasses have any virtual methods (other than the destructor), so that it
// is possible to safely static_cast an instance of one class to the appropriate
// subclass based on the actual type of the wrapped blink::Node. For the same
// reason, subclasses must not add any additional data members.
class BLINK_EXPORT WebNode {
 public:
  enum class EventType {
    kAutofill,
    kSelectionchange,
    kBeforeinput,
    kInput,
    kCompositionstart,
    kCompositionupdate,
    kCompositionend,
    kDrop,
    kPaste,
    kKeydown,
    kKeyup,
    kKeypress,
  };

  static WebNode FromDomNodeId(int dom_node_id);

  virtual ~WebNode();

  explicit WebNode(
      cppgc::SourceLocation loc = BLINK_WEB_NODE_LOCATION_FROM_HERE);
  WebNode(const WebNode&);
  WebNode& operator=(const WebNode&);

  void Reset();
  void Assign(const WebNode&);

  bool Equals(const WebNode&) const;
  // Required for using WebNodes in std maps.  Note the order used is
  // arbitrary and should not be expected to have any specific meaning.
  bool LessThan(const WebNode&) const;

  bool IsNull() const;
  explicit operator bool() const { return !IsNull(); }

  bool IsConnected() const;

  bool Contains(const WebNode*) const;
  bool ContainsViaFlatTree(const WebNode*) const;

  WebNode ParentNode() const;
  // Returns the DOM parent, or the shadow host when this node is a shadow root.
  WebNode ParentOrShadowHostNode() const;
  // Returns the parent node of this node in the flat (composed) tree.
  WebNode ParentInFlatTree() const;
  // Returns the next node in flat-tree preorder, or a null node if advancing
  // would leave the subtree rooted at `stay_within`.
  WebNode NextInFlatTree(const WebNode& stay_within) const;
  // As above, but skips this node's descendants.
  WebNode NextSkippingChildrenInFlatTree(const WebNode& stay_within) const;
  bool IsInUserAgentShadowRoot() const;
  WebString NodeValue() const;
  WebDocument GetDocument() const;
  WebNode FirstChild() const;
  WebNode LastChild() const;
  WebNode PreviousSibling() const;
  WebNode NextSibling() const;

  bool IsLink() const;
  bool IsDocumentNode() const;
  bool IsDocumentTypeNode() const;
  bool IsCommentNode() const;
  bool IsTextNode() const;
  bool IsFocusable() const;
  bool IsContentEditable() const;
  bool IsElementNode() const;
  void SimulateClick();

  // Returns the top-most ancestor such this WebNode and that ancestor and all
  // nodes in between are contenteditable.
  WebElement RootEditableElement() const;

  // See cc/paint/element_id.h for the definition of these ids.
  cc::ElementId ScrollingElementIdForTesting() const;

  // The argument should be lower-cased.
  WebElementCollection GetElementsByHTMLTagName(const WebString&) const;

  // https://developer.mozilla.org/en-US/docs/Web/API/Document/querySelector
  // If the JS API would have thrown this returns null instead.
  WebElement QuerySelector(const WebString& selector) const;

  std::vector<WebElement> QuerySelectorAll(const WebString& selector) const;

  // Returns all Text nodes where `regex` would match for the text inside of
  // the node, case-insensitive. This function does not normalize adjacent Text
  // nodes and search them together. It only matches within individual Text
  // nodes. It is therefore possible that some text is displayed to the user as
  // a single run of text, but will not match the regex, because the nodes
  // aren't normalized. This function searches within both the DOM and Shadow
  // DOM.
  std::vector<WebNode> FindAllTextNodesMatchingRegex(
      const WebString& regex) const;

  bool Focused() const;

  void RevealAutoExpandableAncestors() const;

  WebPluginContainer* PluginContainer() const;

  bool IsInsideFocusableElementOrARIAWidget() const;

  v8::Local<v8::Value> ToV8Value(v8::Isolate*);

  int GetDomNodeId() const;

  // Adds a listener to this node.
  // Returns a RAII object that removes the listener.
  base::ScopedClosureRunner AddEventListener(
      EventType event_type,
      base::RepeatingCallback<void(WebDOMEvent)> handler,
      bool use_capture = false);

  // Returns true there is at least one listener for `event_type` on this node.
  bool HasEventListeners(EventType event_type) const;

  // Helper to downcast to `T`. Will fail with a CHECK() if converting to `T` is
  // not legal. The returned `T` will always be non-null if `this` is non-null.
  template <typename T>
  T To() const;

  // Helper to downcast to `T`, returning a null `T` if the conversion could not
  // be performed.
  template <typename T>
  T DynamicTo() const;

  BLINK_EXPORT friend std::ostream& operator<<(std::ostream&, const WebNode&);

#if INSIDE_BLINK
  WebNode(Node*);
  WebNode& operator=(Node*);
  operator Node*() const;

  template <typename T>
  T* Unwrap() {
    return ::blink::To<T>(private_.Get());
  }

  template <typename T>
  const T* ConstUnwrap() const {
    return ::blink::To<T>(private_.Get());
  }
#endif

 protected:
  WebPrivatePtrForGC<Node> private_;
};

#define DECLARE_WEB_NODE_TYPE_CASTS(type)      \
  template <>                                  \
  BLINK_EXPORT type WebNode::To<type>() const; \
  template <>                                  \
  BLINK_EXPORT type WebNode::DynamicTo<type>() const

#if INSIDE_BLINK
#define DEFINE_WEB_NODE_TYPE_CASTS(type, predicate)    \
  template <>                                          \
  BLINK_EXPORT type WebNode::To<type>() const {        \
    SECURITY_CHECK(IsNull() || (predicate));           \
    type result;                                       \
    result.WebNode::Assign(*this);                     \
    return result;                                     \
  }                                                    \
  template <>                                          \
  BLINK_EXPORT type WebNode::DynamicTo<type>() const { \
    type result;                                       \
    if (!IsNull() && (predicate)) {                    \
      result.WebNode::Assign(*this);                   \
    }                                                  \
    return result;                                     \
  }
#endif

inline bool operator==(const WebNode& a, const WebNode& b) {
  return a.Equals(b);
}

inline bool operator<(const WebNode& a, const WebNode& b) {
  return a.LessThan(b);
}

}  // namespace blink

#endif  // THIRD_PARTY_BLINK_PUBLIC_WEB_WEB_NODE_H_