Hippy/devtools/devtools-backend/include/module/model/dom_model.h

/*
 * Tencent is pleased to support the open source community by making
 * Hippy available.
 *
 * Copyright (C) 2017-2019 THL A29 Limited, a Tencent company.
 * All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#pragma once

#include <string>
#include <vector>
#include "module/model/base_model.h"
#include "nlohmann/json.hpp"

namespace hippy::devtools {

/**
 * @brief dom node, @see https://dom.spec.whatwg.org/#dom-node-nodetype
 */
enum class DomNodeType {
  kElementNode = 1,
  kAttributeNode = 2,
  kTextNode = 3,
  kCDataSectionNode = 4,
  kProcessingInstructionNode = 5,
  kCommentNode = 6,
  kDocumentNode = 7,
  kDocumentTypeNode = 8,
  kDocumentFragmentNode = 9
};

/**
 * @brief chrome devtools DOM model, @see https://chromedevtools.github.io/devtools-protocol/tot/DOM/
 */
class DomModel : public BaseModel {
 public:
  /**
   * @brief create dom model by json
   * @param json dom json struct
   * @return DOMModel
   */
  static DomModel CreateModel(const nlohmann::json& json);

  /**
   * @brief dom method to getDocument
   * @return json struct
   */
  nlohmann::json BuildDocumentJson();

  /**
   * @brief dom method to getBoxModel
   * @return json struct
   */
  nlohmann::json BuildBoxModelJson();

  /**
   * dom method to setChildNodes
   * @return json struct
   */
  nlohmann::json BuildChildNodesJson();

  static nlohmann::json BuildPushNodeIds(std::vector<int32_t>& node_ids);

  static nlohmann::json BuildPushHitNode(int32_t hit_node_id);

  static nlohmann::json BuildNodeForLocation(int32_t node_id);

  inline void SetNodeId(int32_t node_id) { node_id_ = node_id; }
  inline int32_t GetNodeId() const { return node_id_; }

  inline void SetBackendNodeId(int32_t backend_node_id) { backend_node_id_ = backend_node_id; }
  inline int32_t GetBackendNodeId() { return backend_node_id_; }

  inline void SetParentId(int32_t parent_id) { parent_id_ = parent_id; }
  inline int32_t GetParentId() { return parent_id_; }

  inline void SetRootId(int32_t root_id) { root_id_ = root_id; }
  inline int32_t GetRootId() { return root_id_; }

  inline void SetX(double x) { x_ = x; }
  inline double GetX() const { return x_; }

  inline void SetY(double y) { y_ = y; }
  inline double GetY() const { return y_; }

  inline void SetWidth(double width) { width_ = width; }
  inline double GetWidth() const { return width_; }

  inline void SetHeight(double height) { height_ = height; }
  inline double GetHeight() const { return height_; }

  inline void SetChildNodeCount(uint32_t child_node_count) { child_node_count_ = child_node_count; }
  inline uint32_t GetChildNodeCount() { return child_node_count_; }

  inline void SetLocalName(const std::string& local_name) { local_name_ = local_name; }
  inline std::string GetLocalName() const { return local_name_; }

  inline void SetNodeName(const std::string& node_name) { node_name_ = node_name; }
  inline std::string GetNodeName() const { return node_name_; }

  inline void SetNodeValue(const std::string& node_value) { node_value_ = node_value; }
  inline std::string GetNodeValue() const { return node_value_; }

  inline void SetAttributes(const nlohmann::json& attributes) { attributes_ = attributes; }
  inline nlohmann::json GetAttributes() const { return attributes_; }

  inline void SetStyle(const nlohmann::json& style) { style_ = style; }
  inline nlohmann::json GetStyle() const { return style_; }

  inline void SetRelationTree(const nlohmann::json& relation_tree) { relation_tree_ = relation_tree; }
  inline nlohmann::json GetRelationTree() const { return relation_tree_; }

  inline std::vector<DomModel>& GetChildren() { return children_; }

 private:
  nlohmann::json BuildNodeJson(DomNodeType node_type);
  nlohmann::json BuildTextNodeJson();
  nlohmann::json BuildBoxModelBorder();
  nlohmann::json BuildBoxModelPadding(const nlohmann::json& border);
  nlohmann::json BuildBoxModelContent(const nlohmann::json& padding);
  nlohmann::json BuildBoxModelMargin(const nlohmann::json& border);
  nlohmann::json BuildNodeBasicJson(DomNodeType node_type);
  nlohmann::json BuildAttributesObjectToArray();
  // return [left, top, right, bottom]
  // keys [width, left_width, top_width, right_width, bottom_width]
  std::vector<int32_t> GetLeftTopRightBottomValueFromStyle(std::vector<std::string> keys);
  double AddScreenScaleFactor(const std::shared_ptr<ScreenAdapter>& screen_adapter, double origin_value);

  std::vector<DomModel> children_;
  std::string local_name_;
  std::string node_name_;
  std::string node_value_;
  nlohmann::json attributes_;
  nlohmann::json style_;

  /**
   * @brief find recently cached node when getNodeForLocation
   */
  nlohmann::json relation_tree_;
  double x_ = 0.0;
  double y_ = 0.0;
  double width_ = 0.0;
  double height_ = 0.0;
  int32_t node_id_ = 0;
  int32_t backend_node_id_ = 0;
  int32_t parent_id_ = 0;
  int32_t root_id_ = 0;
  uint32_t child_node_count_ = 0;
};

}  // namespace hippy::devtools