123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124 |
- // Copyright 2018 The Chromium Authors. All rights reserved.
- // Use of this source code is governed by a BSD-style license that can be
- // found in the LICENSE file.
- #ifndef COMPONENTS_UI_DEVTOOLS_DOM_AGENT_H_
- #define COMPONENTS_UI_DEVTOOLS_DOM_AGENT_H_
- #include <memory>
- #include <string>
- #include <unordered_map>
- #include <vector>
- #include "base/observer_list.h"
- #include "components/ui_devtools/devtools_base_agent.h"
- #include "components/ui_devtools/devtools_export.h"
- #include "components/ui_devtools/dom.h"
- #include "components/ui_devtools/ui_element_delegate.h"
- namespace ui_devtools {
- class UIElement;
- class DOMAgentObserver {
- public:
- virtual void OnElementBoundsChanged(UIElement* ui_element) {}
- virtual void OnElementAdded(UIElement* ui_element) {}
- };
- class UI_DEVTOOLS_EXPORT DOMAgent
- : public UiDevToolsBaseAgent<protocol::DOM::Metainfo>,
- public UIElementDelegate {
- public:
- DOMAgent();
- DOMAgent(const DOMAgent&) = delete;
- DOMAgent& operator=(const DOMAgent&) = delete;
- ~DOMAgent() override;
- // DOM::Backend:
- protocol::Response disable() override;
- protocol::Response getDocument(
- std::unique_ptr<protocol::DOM::Node>* out_root) override;
- protocol::Response pushNodesByBackendIdsToFrontend(
- std::unique_ptr<protocol::Array<int>> backend_node_ids,
- std::unique_ptr<protocol::Array<int>>* result) override;
- protocol::Response performSearch(
- const protocol::String& query,
- protocol::Maybe<bool> include_user_agent_shadow_dom,
- protocol::String* search_id,
- int* result_count) override;
- protocol::Response getSearchResults(
- const protocol::String& search_id,
- int from_index,
- int to_index,
- std::unique_ptr<protocol::Array<int>>* node_ids) override;
- protocol::Response discardSearchResults(
- const protocol::String& search_id) override;
- protocol::Response dispatchMouseEvent(
- int node_id,
- std::unique_ptr<protocol::DOM::MouseEvent> event) override;
- protocol::Response dispatchKeyEvent(
- int node_id,
- std::unique_ptr<protocol::DOM::KeyEvent> event) override;
- // UIElementDelegate:
- void OnUIElementAdded(UIElement* parent, UIElement* child) override;
- void OnUIElementReordered(UIElement* parent, UIElement* child) override;
- void OnUIElementRemoved(UIElement* ui_element) override;
- void OnUIElementBoundsChanged(UIElement* ui_element) override;
- void AddObserver(DOMAgentObserver* observer);
- void RemoveObserver(DOMAgentObserver* observer);
- UIElement* GetElementFromNodeId(int node_id) const;
- UIElement* element_root() const { return element_root_.get(); }
- // Returns parent id of the element with id |node_id|. Returns 0 if parent
- // does not exist.
- int GetParentIdOfNodeId(int node_id) const;
- protected:
- std::unique_ptr<protocol::DOM::Node> BuildNode(
- const std::string& name,
- std::unique_ptr<std::vector<std::string>> attributes,
- std::unique_ptr<protocol::Array<protocol::DOM::Node>> children,
- int node_ids);
- std::unique_ptr<protocol::DOM::Node> BuildDomNodeFromUIElement(
- UIElement* root);
- private:
- struct Query;
- // These are called on creating a DOM document.
- std::unique_ptr<protocol::DOM::Node> BuildInitialTree();
- // The caller takes ownership of the returned pointers.
- virtual std::vector<UIElement*> CreateChildrenForRoot() = 0;
- virtual std::unique_ptr<protocol::DOM::Node> BuildTreeForUIElement(
- UIElement* ui_element) = 0;
- void OnElementBoundsChanged(UIElement* ui_element);
- // Recursively removes |ui_element| and its children from the frontend
- // elements tree. If |update_node_id_map|=true, also remove |ui_element|'s
- // |node_id| from |node_id_to_ui_element_|.
- void RemoveDomNode(UIElement* ui_element, bool update_node_id_map);
- void Reset();
- Query PreprocessQuery(protocol::String query);
- void SearchDomTree(const Query& query, std::vector<int>* result_collector);
- std::unique_ptr<UIElement> element_root_;
- std::unordered_map<int, UIElement*> node_id_to_ui_element_;
- base::ObserverList<DOMAgentObserver>::Unchecked observers_;
- using SearchResults = std::unordered_map<std::string, std::vector<int>>;
- SearchResults search_results_;
- bool is_document_created_ = false;
- };
- } // namespace ui_devtools
- #endif // COMPONENTS_UI_DEVTOOLS_DOM_AGENT_H_
|