/*
* This source file is part of RmlUi, the HTML/CSS Interface Middleware
*
* For the latest information, see http://github.com/mikke89/RmlUi
*
* Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd
* Copyright (c) 2019 The RmlUi Team, and contributors
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*
*/
#ifndef RMLUI_DEBUGGER_DEBUGGERSYSTEMINTERFACE_H
#define RMLUI_DEBUGGER_DEBUGGERSYSTEMINTERFACE_H
#include "../../Include/RmlUi/Core/SystemInterface.h"
namespace Rml {
namespace Debugger {
class ElementLog;
/**
The log interface the debugger installs into RmlUi. This is a pass-through interface, so it holds onto the
application's system interface and passes all the calls through.
@author Peter Curry
*/
class DebuggerSystemInterface : public Rml::SystemInterface
{
public:
/// Instances a new debugging log interface.
/// @param[in] log The logging element to send messages to.
DebuggerSystemInterface(Rml::SystemInterface* application_interface, ElementLog* log);
virtual ~DebuggerSystemInterface();
/// Get the number of seconds elapsed since the start of the application.
/// @return Elapsed time, in seconds.
double GetElapsedTime() override;
/// Translate the input string into the translated string.
/// @param[out] translated Translated string ready for display.
/// @param[in] input String as received from XML.
/// @return Number of translations that occured.
int TranslateString(String& translated, const String& input) override;
/// Log the specified message.
/// @param[in] type Type of log message, ERROR, WARNING, etc.
/// @param[in] message Message to log.
/// @return True to continue execution, false to break into the debugger.
bool LogMessage(Log::Type type, const String& message) override;
/// Set mouse cursor.
/// @param[in] cursor_name Cursor name to activate.
void SetMouseCursor(const String& cursor_name) override;
/// Set clipboard text.
/// @param[in] text Text to apply to clipboard.
void SetClipboardText(const String& text) override;
/// Get clipboard text.
/// @param[out] text Retrieved text from clipboard.
void GetClipboardText(String& text) override;
/// Activate keyboard (for touchscreen devices)
void ActivateKeyboard() override;
/// Deactivate keyboard (for touchscreen devices)
void DeactivateKeyboard() override;
private:
Rml::SystemInterface* application_interface;
ElementLog* log;
};
}
} // namespace Rml
#endif