1 /* 2 * Copyright (c) 2022-2024 Huawei Device Co., Ltd. 3 * Licensed under the Apache License, Version 2.0 (the "License"); 4 * you may not use this file except in compliance with the License. 5 * You may obtain a copy of the License at 6 * 7 * http://www.apache.org/licenses/LICENSE-2.0 8 * 9 * Unless required by applicable law or agreed to in writing, software 10 * distributed under the License is distributed on an "AS IS" BASIS, 11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 * See the License for the specific language governing permissions and 13 * limitations under the License. 14 */ 15 16 #ifndef FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_INSPECTOR_INSPECTOR_H 17 #define FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_INSPECTOR_INSPECTOR_H 18 19 #include <string> 20 #include <unordered_map> 21 22 #include "base/utils/macros.h" 23 #include "bridge/common/utils/componentInfo.h" 24 #include "core/components_ng/base/frame_node.h" 25 #include "rec_node.h" 26 27 namespace OHOS::Ace::NG { 28 const char KEY_METHOD[] = "method"; 29 const char KEY_PARAMS[] = "params"; 30 31 const uint32_t INVALID_WINDOW_ID = 0; 32 const int32_t INVALID_METHOD_ID = -1; 33 class InspectorFilter; 34 using InspectorTreeMap = std::unordered_map<int32_t, RefPtr<RecNode>>; 35 36 struct InspectorChildrenParameters { 37 int32_t pageId = 0; 38 bool isActive = false; 39 bool isLayoutInspector = false; 40 bool needHandleInternal = false; 41 }; 42 43 class ACE_FORCE_EXPORT Inspector { 44 public: 45 static RefPtr<FrameNode> GetFrameNodeByKey(const std::string& key, bool notDetach = false, 46 bool skipoffscreenNodes = false); 47 static std::string GetInspectorNodeByKey(const std::string& key, 48 const InspectorFilter& filter = InspectorFilter()); 49 static bool SendEventByKey(const std::string& key, int action, const std::string& params); 50 static void GetRectangleById(const std::string& key, Rectangle& rectangle); 51 static std::string GetInspector(bool isLayoutInspector = false); 52 static std::string GetInspector(bool isLayoutInspector, const InspectorFilter& filter, bool& needThrow); 53 static std::string GetInspectorOfNode(RefPtr<NG::UINode> node); 54 static std::string GetSubWindowInspector(bool isLayoutInspector = false); 55 static void HideAllMenus(); 56 static void AddOffscreenNode(RefPtr<FrameNode> node); 57 static void RemoveOffscreenNode(RefPtr<FrameNode> node); 58 static void GetInspectorTree(InspectorTreeMap& treesInfo); 59 static void GetOffScreenTreeNodes(InspectorTreeMap& nodes); 60 static void GetRecordAllPagesNodes(InspectorTreeMap& treesInfo); 61 static std::pair<uint32_t, int32_t> ParseWindowIdFromMsg(const std::string& message); 62 static RefPtr<UINode> GetInspectorByKey( 63 const RefPtr<FrameNode>& root, const std::string& key, bool notDetach = false); 64 private: 65 static RefPtr<RecNode> AddInspectorTreeNode(const RefPtr<NG::UINode>& uiNode, InspectorTreeMap& recNodes); 66 static void GetInspectorTreeInfo( 67 std::vector<RefPtr<NG::UINode>> children, int32_t pageId, InspectorTreeMap& recNodes); 68 static void GetInspectorChildrenInfo( 69 const RefPtr<NG::UINode>& parent, InspectorTreeMap& recNodes, int32_t pageId, uint32_t depth = UINT32_MAX); 70 static void RecordOnePageNodes(const RefPtr<NG::UINode>& pageNode, InspectorTreeMap& treesInfo); 71 72 private: 73 static std::set<RefPtr<FrameNode>> offscreenNodes; 74 }; 75 } // namespace OHOS::Ace::NG 76 77 #endif // FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_INSPECTOR_INSPECTOR_H 78