Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kmaehashi/xojoinstruments
:negative_squared_cross_mark: Memory Leak Detector for Xojo
https://github.com/kmaehashi/xojoinstruments
xojo
Last synced: about 1 month ago
JSON representation
:negative_squared_cross_mark: Memory Leak Detector for Xojo
- Host: GitHub
- URL: https://github.com/kmaehashi/xojoinstruments
- Owner: kmaehashi
- License: mit
- Created: 2018-01-08T12:30:12.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2022-09-24T15:32:09.000Z (about 2 years ago)
- Last Synced: 2024-10-05T00:47:25.232Z (about 2 months ago)
- Topics: xojo
- Language: Xojo
- Homepage: https://forum.xojo.com/t/41487
- Size: 628 KB
- Stars: 22
- Watchers: 6
- Forks: 2
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://github.com/kmaehashi/XojoInstruments/actions/workflows/test.yml)
# Xojo Instruments
Xojo Instruments is a runtime tool to diagnose memory leaks and circular references in Xojo Desktop applications.
https://user-images.githubusercontent.com/939877/144716398-03936a9c-7906-4c75-ab9d-3a7dd54c9866.mov
## Quick Start
1. Download the latest release from [Releases](https://github.com/kmaehashi/XojoInstruments/releases).
1. Open Xojo Instruments project in Xojo IDE in `DesktopApp` folder.
1. Copy `XojoInstruments` folder to your project using the IDE.
1. Insert the following line to the top of `App.Open` (or `App.Opening`) event handler of your project.
```
XojoInstruments.Start()
```
**Hint:** If you are using Xojo 2021 Release 3 or later, you may need to change the Super of ``XojoInstrumentsDesktopGUI`` to ``DesktopWindow``.
## Basic Usage
### Snapshot Capturing
1. Run your application.
1. Click `Capture` in `Xojo Instruments` window to capture the current runtime status.
1. Do something in your application.
1. Click `Capture & Compare`.
1. Go to `Comparison` tab to see what objects has been added/removed.
While running your application under the IDE, you can also view the selected object in IDE by clicking `Inspect in IDE`.
### Reference Graph
Reference Graph represents a dependency (reference hierarchy) between objects.
You can possibly find circular reference by using the graph.
1. Turn on `Build Reference Graph` and click `Capture`.
1. Go to `Visualization` tab.
1. (Optional) Turn on `Detect circular` to automatically highlight circular references in the graph.
1. Click `Render`.
While running your application under the IDE, you can view the object in IDE by double-clicking a object node in the graph.
You can choose either `vis.js` (bundled with Xojo Instruments, not supported on Windows) or `dot` command ([GraphViz](http://www.graphviz.org/download/) - needs to be installed separately) to render the graph.
You can also use `Backreference` tab to see back reference (list of objects referring the target object).
## Notes
* As Xojo framework itself creates/caches some instances, you may notice unexpected "leaks" of instances.
Common ones are `EndOfLine`, `DockItem` and `Xojo.Introspection.*`.
* Reference graphs are built by traversing properties of each object.
Please be aware that due to the limitation of introspection mechanism, Xojo Instruments cannot capture all references.
Here is an example of references that cannot be captured:
* Delegates (e.g., reference created by `AddHandler` / `AddressOf`)
* Module properties
* Shared class properties
* Static variables
* Reference between window and non-control instances / container controls
* Some objects used by Xojo framework itself
* When comparing any two snapshots, you will at least see 1 added & 1 removed `Delegate` instance.
This is a known limitation.
## License
MIT License