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 class InspectorFilter;
29 using InspectorTreeMap = std::unordered_map<int32_t, RefPtr<RecNode>>;
30 
31 class ACE_FORCE_EXPORT Inspector {
32 public:
33     static RefPtr<FrameNode> GetFrameNodeByKey(const std::string& key, bool notDetach = false);
34     static std::string GetInspectorNodeByKey(const std::string& key,
35         const InspectorFilter& filter = InspectorFilter());
36     static bool SendEventByKey(const std::string& key, int action, const std::string& params);
37     static void GetRectangleById(const std::string& key, Rectangle& rectangle);
38     static std::string GetInspector(bool isLayoutInspector = false);
39     static std::string GetInspector(bool isLayoutInspector, const InspectorFilter& filter, bool& needThrow);
40     static std::string GetInspectorOfNode(RefPtr<NG::UINode> node);
41     static std::string GetSubWindowInspector(bool isLayoutInspector = false);
42     static std::string GetSimplifiedInspector(int32_t containerId);
43     static void HideAllMenus();
44     static void AddOffscreenNode(RefPtr<FrameNode> node);
45     static void RemoveOffscreenNode(RefPtr<FrameNode> node);
46     static void GetInspectorTree(InspectorTreeMap& treesInfo);
47     static void GetOffScreenTreeNodes(InspectorTreeMap& nodes);
48     static void GetRecordAllPagesNodes(InspectorTreeMap& treesInfo);
49 
50 private:
51     static RefPtr<RecNode> AddInspectorTreeNode(const RefPtr<NG::UINode>& uiNode, InspectorTreeMap& recNodes);
52     static void GetInspectorTreeInfo(
53         std::vector<RefPtr<NG::UINode>> children, int32_t pageId, InspectorTreeMap& recNodes);
54     static void GetInspectorChildrenInfo(
55         const RefPtr<NG::UINode>& parent, InspectorTreeMap& recNodes, int32_t pageId, uint32_t depth = UINT32_MAX);
56     static void RecordOnePageNodes(const RefPtr<NG::UINode>& pageNode, InspectorTreeMap& treesInfo);
57 
58 private:
59     static std::set<RefPtr<FrameNode>> offscreenNodes;
60 };
61 } // namespace OHOS::Ace::NG
62 
63 #endif // FOUNDATION_ACE_FRAMEWORKS_CORE_COMPONENTS_NG_INSPECTOR_INSPECTOR_H
64