Followup changes in JerryScript debugger after #1910.

* Remove 'jerry_debugger_cleaup'. Do it automatically in 'jerry_cleanup'.
* Updated the documentations.
* Updated the NuttX and Artik053 targets.

JerryScript-DCO-1.0-Signed-off-by: László Langó llango.u-szeged@partner.samsung.com
This commit is contained in:
László Langó
2017-09-05 10:00:30 +02:00
committed by yichoi
parent a51def40e7
commit a54427e255
12 changed files with 110 additions and 50 deletions
+57 -7
View File
@@ -65,8 +65,8 @@ All available commands of the client can be queried by the
## Integrating debugger support into applications using JerryScript
The debugger can be enabled by passing the `JERRY_INIT_DEBUGGER` flag
to the `jerry_init ()` function which then initializes the debugger
The debugger can be enabled by calling the `jerry_debugger_init (uint16_t port)`
function after the `jerry_init ()` function. It initializes the debugger
and blocks until a client connects.
When the debugger is enabled it is recommended to use
@@ -83,6 +83,36 @@ debugger is disabled.
The following section describes the debugger functions
available for the host application.
### jerry_debugger_init
**Summary**
Debugger server initialization. Must be called after `jerry_init`.
**Prototype**
```c
void
jerry_debugger_init (uint16_t port);
```
- `port` - Server port number
**Example**
```c
{
jerry_init (JERRY_INIT_EMPTY);
jerry_debugger_init (5001);
// ...
jerry_cleanup ();
}
```
### jerry_debugger_is_connected
**Summary**
@@ -100,12 +130,15 @@ jerry_debugger_is_connected (void);
```c
{
jerry_init (JERRY_INIT_DEBUGGER);
jerry_init (JERRY_INIT_EMPTY);
jerry_debugger_init (5001);
if (jerry_debugger_is_connected ())
{
printf ("A remote debugger client is connected.");
}
jerry_cleanup ();
}
```
@@ -129,9 +162,12 @@ jerry_debugger_stop (void)
```c
{
jerry_init (JERRY_INIT_DEBUGGER);
jerry_init (JERRY_INIT_EMPTY);
jerry_debugger_init (5001);
jerry_debugger_stop ();
jerry_cleanup ();
}
```
@@ -160,9 +196,12 @@ jerry_debugger_continue (void)
```c
{
jerry_init (JERRY_INIT_DEBUGGER);
jerry_init (JERRY_INIT_EMPTY);
jerry_debugger_init (5001);
jerry_debugger_continue ();
jerry_cleanup ();
}
```
@@ -191,7 +230,8 @@ jerry_debugger_stop_at_breakpoint (bool enable_stop_at_breakpoint)
```c
{
jerry_init (JERRY_INIT_DEBUGGER);
jerry_init (JERRY_INIT_EMPTY);
jerry_debugger_init (5001);
jerry_debugger_stop_at_breakpoint (true);
@@ -199,6 +239,8 @@ jerry_debugger_stop_at_breakpoint (bool enable_stop_at_breakpoint)
jerry_eval (...);
jerry_debugger_stop_at_breakpoint (false);
jerry_cleanup ();
}
```
@@ -221,7 +263,8 @@ jerry_debugger_wait_and_run_client_source (jerry_value_t *return_value)
**Example**
```c
jerry_init (JERRY_INIT_DEBUGGER);
jerry_init (JERRY_INIT_EMPTY);
jerry_debugger_init (5001);
jerry_value_t run_result;
jerry_debugger_wait_and_run_type_t receive_status;
@@ -239,6 +282,8 @@ jerry_debugger_wait_and_run_client_source (jerry_value_t *return_value)
jerry_release_value (run_result);
}
while (receive_status == JERRY_DEBUGGER_SOURCE_RECEIVED);
jerry_cleanup ();
```
### jerry_debugger_send_output
@@ -258,8 +303,13 @@ At the moment only the JS print size is implemented.
**Example**
```c
jerry_init (JERRY_INIT_EMPTY);
jerry_debugger_init (5001);
jerry_char_t my_output = "Hey, this should be sent too!";
jerry_size_t my_output_size = sizeof (my_output);
jerry_debugger_send_output (my_output, my_output_size, JERRY_DEBUGGER_OUTPUT_OK);
jerry_cleanup ();
```