Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ggerganov/incppect
Inspect C++ memory in the browser
https://github.com/ggerganov/incppect
Last synced: 7 days ago
JSON representation
Inspect C++ memory in the browser
- Host: GitHub
- URL: https://github.com/ggerganov/incppect
- Owner: ggerganov
- License: mit
- Created: 2019-04-25T17:30:46.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-05-08T15:08:09.000Z (over 2 years ago)
- Last Synced: 2024-10-03T13:51:12.655Z (2 months ago)
- Language: C++
- Size: 87.9 KB
- Stars: 89
- Watchers: 6
- Forks: 16
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- AwesomeCppGameDev - incppect
README
[](https://github.com/ggerganov/incppect/actions)
# incppect
Inspect C++ memory in the browser
## Description
This is a small library that allows a C++ native application to stream memory bits to one or more websocket clients. This functionality can be used to conveniently inspect the internal state of the native application from a browser.
Incppect starts a simple HTTP(S)/WebSocket server in your application that accepts external connections. When a client connects, incppect serves the static content (HTML/JS) from a user-specified location, as well as the built-in incppect JS client [incppect.js](https://github.com/ggerganov/incppect/blob/master/src/incppect.js). The client opens a websocket connection back to the application and starts requesting custom data. The data is streamed back to the client over the websocket. The usage/visualization of the received data is entirely up to the client.
The HTTP(S)/WebSocket server is implemented via the [uWebSocket](https://github.com/uNetworking/uWebSockets) library (included in the project as a submodule).
## Examples:
Checkout the [examples](https://github.com/ggerganov/incppect/tree/master/examples) folder for more samples.
Other projects:
- [imgui-ws](https://github.com/ggerganov/imgui-ws) - Dear ImGui over WebSockets
- [typing-battles](https://github.com/ggerganov/typing-battles) - A multiplayer typing game
## Sample usage (HTTP):
Example: [hello-browser](https://github.com/ggerganov/incppect/tree/master/examples/hello-browser)
In your C++ program add something along these lines:
```cpp
#include "incppect/incppect.h"
// start the web server in a dedicated thread
auto & incppect = Incppect::getInstance();
incppect.runAsync(...);
int32_t some_var;
float some_arr[10];
// define variables that can be requested from the web clients
incppect.var("path0", [&](auto ) { return Incppect::view(some_var); });
incppect.var("path1[%d]", [&](auto idxs) { return Incppect::view(some_arr[idxs[0]]); });
```
In your web client:
```js
incppect.render = function() {
// request C++ data
var some_var = this.get_int32('path0');
var some_arr_element = this.get_int32_arr('path1[%d]', 5);
// do something with it
...
}
incppect.init();
```
## Sample usage (HTTPS):
Example: [hello-browser-ssl](https://github.com/ggerganov/incppect/tree/master/examples/hello-browser-ssl)
In your C++ program add something along these lines:
```cpp
#include "incppect/incppect.h"
// start the web server in a dedicated thread
auto & incppect = Incppect::getInstance();
// provide valid SSL certificate
incppect::Parameters parameters;
parameters.sslKey = "key.pem";
parameters.sslCert = "cert.pem";
incppect.runAsync(parameters);
int32_t some_var;
float some_arr[10];
// define variables that can be requested from the web clients
incppect.var("path0", [&](auto ) { return Incppect::view(some_var); });
incppect.var("path1[%d]", [&](auto idxs) { return Incppect::view(some_arr[idxs[0]]); });
```
In your web client:
```js
incppect.render = function() {
// request C++ data
var some_var = this.get_int32('path0');
var some_arr_element = this.get_int32_arr('path1[%d]', 5);
// do something with it
...
}
// notice we use secure web-socket
incppect.ws_uri = 'wss://' + window.location.hostname + ':' + window.location.port + '/incppect';
incppect.init();
```
## Build instructions
**Linux and Mac OS**
```bash
git clone https://github.com/ggerganov/incppect
cd incppect
git submodule update --init
mkdir build && cd build
cmake ..
make
```
](https://i.imgur.com/8hJSbzQ.gif){kind=link}