mirror of
https://github.com/jerryscript-project/jerryscript.git
synced 2025-12-15 16:29:21 +00:00
9860d66a56
Related to #4186. Some notable changes: - The term 'Error' now strictly refers to native Error objects defined in the ECMA standard, which are ordinary objects. All other uses of 'error' or 'error reference' where the term refers to a thrown value is now called 'exception'. - Simplified the naming scheme of many String API functions. These functions will now also take an 'encoding' argument to specify the desired encoding in which to operate. - Removed the substring-copy-to-buffer functions. These functions behaved awkwardly, as they use character index to specify the start/end positions, and were mostly used incorrectly with byte offsets instead. The functionality can still be replicated with other functions if necessary. - String-to-buffer functions will no longer fail if the buffer is not sufficiently large, the string will instead be cropped. - Fixed the usage of the '_sz' prefix in many API functions. The term 'sz' means zero-terminated string in hungarian notation, this was used incorrectly in many cases. - Renamed most of the public API functions to have shorter, more on-point names, rather than the often too long descriptive names. Functions are now also grouped by the type of value they operate on, where this makes sense. JerryScript-DCO-1.0-Signed-off-by: Dániel Bátyai dbatyai@inf.u-szeged.hu
77 lines
2.7 KiB
C
77 lines
2.7 KiB
C
/* Copyright JS Foundation and other contributors, http://js.foundation
|
|
*
|
|
* 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 JERRYSCRIPT_DEBUGGER_H
|
|
#define JERRYSCRIPT_DEBUGGER_H
|
|
|
|
#include "jerryscript-port.h"
|
|
|
|
JERRY_C_API_BEGIN
|
|
|
|
/** \addtogroup jerry-debugger Jerry engine interface - Debugger feature
|
|
* @{
|
|
*/
|
|
|
|
/**
|
|
* JerryScript debugger protocol version.
|
|
*/
|
|
#define JERRY_DEBUGGER_VERSION (9)
|
|
|
|
/**
|
|
* Types for the client source wait and run method.
|
|
*/
|
|
typedef enum
|
|
{
|
|
JERRY_DEBUGGER_SOURCE_RECEIVE_FAILED = 0, /**< source is not received */
|
|
JERRY_DEBUGGER_SOURCE_RECEIVED = 1, /**< a source has been received */
|
|
JERRY_DEBUGGER_SOURCE_END = 2, /**< the end of the sources signal received */
|
|
JERRY_DEBUGGER_CONTEXT_RESET_RECEIVED, /**< the context reset request has been received */
|
|
} jerry_debugger_wait_for_source_status_t;
|
|
|
|
/**
|
|
* Callback for jerry_debugger_wait_and_run_client_source
|
|
*
|
|
* The callback receives the resource name, source code and a user pointer.
|
|
*
|
|
* @return this value is passed back by jerry_debugger_wait_and_run_client_source
|
|
*/
|
|
typedef jerry_value_t (*jerry_debugger_wait_for_source_callback_t) (const jerry_char_t *source_name_p,
|
|
size_t source_name_size,
|
|
const jerry_char_t *source_p,
|
|
size_t source_size,
|
|
void *user_p);
|
|
|
|
/**
|
|
* Engine debugger functions.
|
|
*/
|
|
bool jerry_debugger_is_connected (void);
|
|
void jerry_debugger_stop (void);
|
|
void jerry_debugger_continue (void);
|
|
void jerry_debugger_stop_at_breakpoint (bool enable_stop_at_breakpoint);
|
|
jerry_debugger_wait_for_source_status_t
|
|
jerry_debugger_wait_for_client_source (jerry_debugger_wait_for_source_callback_t callback_p,
|
|
void *user_p,
|
|
jerry_value_t *return_value);
|
|
void jerry_debugger_send_output (const jerry_char_t *buffer, jerry_size_t str_size);
|
|
void jerry_debugger_send_log (jerry_log_level_t level, const jerry_char_t *buffer, jerry_size_t str_size);
|
|
|
|
/**
|
|
* @}
|
|
*/
|
|
|
|
JERRY_C_API_END
|
|
|
|
#endif /* !JERRYSCRIPT_DEBUGGER_H */
|