You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/guide/index.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -287,7 +287,7 @@ On the line where the program counter is at, there are two visual indicators:
287
287
288
288
The goal of the Binary Ninja debugger is to provide a unified way of debugging programs on different platforms (e.g., Windows, Linux, macOS, etc). However, this is not an easy task, because each platform has its own way of supporting debugging and it varies considerably.
289
289
290
-
To deal with this, we abstract the core functionalities of a debugger into a class `DebugAdapter`. Each debug adapter is a subclass of the `DebugAdapter` with the platform-dependent implementation of each method.
290
+
To deal with this, we abstract the core functionalities of a debugger into a class [`DebugAdapterType`](https://api.binary.ninja/binaryninja.debugger.debugadaptertype-module.html#binaryninja.debugger.debugadaptertype.DebugAdapterType). Each debug adapter is a subclass of the `DebugAdapterType` with the platform-dependent implementation of each method.
291
291
292
292
The debugger then **drives** the various adapters, creating a unified debugging experience, both in GUI and API.
293
293
@@ -311,7 +311,7 @@ Each debug adapter supports one or more operations to initialize the debugging:
311
311
312
312
Each adapter may provide a list of configuration options. They can be configured via the debug adapter settings dialog.
313
313
314
-
New debug adapters can be created by subclassing `DebugAdapter` to support other targets.
314
+
New debug adapters can be created by subclassing `DebugAdapterType` to support other targets.
315
315
316
316
317
317
### The Debugger Memory Region
@@ -322,7 +322,7 @@ that are not present in the original binary view are represented using the new M
322
322
323
323
These regions get added automatically when the target is launched, and gets removed after debugging. Analysis is no longer lost after debugging.
324
324
325
-
During debugging, the binary view reads and writes its memory from the connected `DebugAdapter` backend.
325
+
During debugging, the binary view reads and writes its memory from the connected `DebugAdapterType` backend.
326
326
Writing to it will also cause the target's memory to change.
327
327
328
328
The binary view can be accessed by the ``data`` property of the controller.
@@ -332,7 +332,7 @@ The binary view can be accessed by the ``data`` property of the controller.
332
332
The debugger exposes its functionality in both the Python and C++ APIs. The Python documentation can be accessed online, for [stable](https://api.binary.ninja/binaryninja.debugger.debuggercontroller-module.html)
333
333
and [dev](https://dev-api.binary.ninja/binaryninja.debugger.debuggercontroller-module.html) version.
334
334
335
-
The API is centered around the [`DebuggerController`](https://dev-api.binary.ninja/binaryninja.debugger.debuggercontroller-module.html#binaryninja.debugger.debuggercontroller.DebuggerController) class, which provides all functionalities of the debugger. There is no need to directly access the `DebugAdapter` classes.
335
+
The API is centered around the [`DebuggerController`](https://dev-api.binary.ninja/binaryninja.debugger.debuggercontroller-module.html#binaryninja.debugger.debuggercontroller.DebuggerController) class, which provides all functionalities of the debugger. There is no need to directly access the `DebugAdapterType` classes.
336
336
337
337
When the debugger is used within the UI, the `dbg` magic variable is injected into the Python interpreter. It always represents the debugger for the currently active Binary View. You can think of it as being created by
0 commit comments