| // Copyright 2015 The Cobalt Authors. 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. |
| |
| #ifndef COBALT_BROWSER_DEBUG_CONSOLE_H_ |
| #define COBALT_BROWSER_DEBUG_CONSOLE_H_ |
| |
| #if !defined(ENABLE_DEBUGGER) |
| #error "Debugger is not enabled in this build." |
| #endif // !ENABLE_DEBUGGER |
| |
| #include <memory> |
| #include <string> |
| |
| #include "base/callback.h" |
| #include "base/logging.h" |
| #include "cobalt/base/token.h" |
| #include "cobalt/browser/lifecycle_observer.h" |
| #include "cobalt/browser/web_module.h" |
| #include "cobalt/debug/console/debug_console_mode.h" |
| #include "cobalt/debug/console/debug_hub.h" |
| #include "cobalt/dom/input_event_init.h" |
| #include "cobalt/dom/keyboard_event_init.h" |
| #include "cobalt/dom/pointer_event_init.h" |
| #include "cobalt/dom/wheel_event_init.h" |
| #include "cobalt/dom/window.h" |
| #include "url/gurl.h" |
| |
| namespace cobalt { |
| namespace browser { |
| |
| // DebugConsole wraps the web module and all components used to implement the |
| // debug console. |
| class DebugConsole : public LifecycleObserver { |
| public: |
| DebugConsole( |
| base::ApplicationState initial_application_state, |
| const WebModule::OnRenderTreeProducedCallback& |
| render_tree_produced_callback, |
| network::NetworkModule* network_module, |
| const cssom::ViewportSize& window_dimensions, |
| render_tree::ResourceProvider* resource_provider, |
| float layout_refresh_rate, |
| const debug::CreateDebugClientCallback& create_debug_client_callback); |
| ~DebugConsole(); |
| |
| // Filters a key event. |
| // Returns true if the event should be passed on to other handlers, |
| // false if it was consumed within this function. |
| bool FilterKeyEvent(base::Token type, const dom::KeyboardEventInit& event); |
| |
| // Filters a pointer event. |
| // Returns true if the event should be passed on to other handlers, |
| // false if it was consumed within this function. |
| bool FilterPointerEvent(base::Token type, const dom::PointerEventInit& event); |
| |
| // Filters a wheel event. |
| // Returns true if the event should be passed on to other handlers, |
| // false if it was consumed within this function. |
| bool FilterWheelEvent(base::Token type, const dom::WheelEventInit& event); |
| |
| #if SB_API_VERSION >= 12 || SB_HAS(ON_SCREEN_KEYBOARD) |
| // Filters an on screen keyboard input event. |
| // Returns true if the event should be passed on to other handlers, |
| // false if it was consumed within this function. |
| bool FilterOnScreenKeyboardInputEvent(base::Token type, |
| const dom::InputEventInit& event); |
| #endif // SB_API_VERSION >= 12 || |
| // SB_HAS(ON_SCREEN_KEYBOARD) |
| |
| const WebModule& web_module() const { return *web_module_; } |
| WebModule& web_module() { return *web_module_; } |
| |
| // Cycles through each different possible debug console visibility mode. |
| void CycleMode(); |
| |
| // Returns true iff the console is in a mode that is visible. |
| bool IsVisible() { |
| return (GetMode() != debug::console::kDebugConsoleModeOff); |
| } |
| |
| void SetSize(const cssom::ViewportSize& viewport_size) { |
| web_module_->SetSize(viewport_size); |
| } |
| |
| // LifecycleObserver implementation. |
| void Blur() override { web_module_->Blur(); } |
| void Conceal(render_tree::ResourceProvider* resource_provider) override { |
| web_module_->Conceal(resource_provider); |
| } |
| void Freeze() override { web_module_->Freeze(); } |
| void Unfreeze(render_tree::ResourceProvider* resource_provider) override { |
| web_module_->Unfreeze(resource_provider); |
| } |
| void Reveal(render_tree::ResourceProvider* resource_provider) override { |
| web_module_->Reveal(resource_provider); |
| } |
| void Focus() override { web_module_->Focus(); } |
| |
| void ReduceMemory() { web_module_->ReduceMemory(); } |
| |
| private: |
| void OnError(const GURL& url, const std::string& error) { |
| LOG(ERROR) << error; |
| } |
| |
| // Returns the currently set debug console visibility mode. |
| debug::console::DebugConsoleMode GetMode(); |
| |
| // Returns true iff the debug console is in a state where it should route |
| // input events to its web module. |
| bool ShouldInjectInputEvents(); |
| |
| // The current console visibility mode. The mutex is required since the debug |
| // console's visibility mode may be accessed from both the WebModule thread |
| // and the DebugConsole's host thread. |
| base::Lock mode_mutex_; |
| int mode_; |
| |
| // Sets up everything to do with the management of the web page that |
| // implements the debug console. |
| // This web module will produce a second render tree to combine with the main |
| // one. |
| std::unique_ptr<WebModule> web_module_; |
| }; |
| |
| } // namespace browser |
| } // namespace cobalt |
| |
| #endif // COBALT_BROWSER_DEBUG_CONSOLE_H_ |