Vector35 / Vector35/binaryninja-api

Sidebar pointer lifetime (UI-Documentation)

Aperta
#4,949 1 commento 1 reazione 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Effort: Medium Impact: Medium
Lingua principale
C++
Stelle
1.3k
Fork
298
Merge medio
5g 5h
PR unite (30g)
19

Descrizione

Is this a general concept that needs to be documented or a specific API?
UI -> Sidebar

What concept or API needs more documentation?
I am mostly interested in Sidebar, SidebarWidget and SidebarWidgetType.

Is this documentation related to a specific API?
No, since UI code is not documented at all.

Are there any known examples of people using this API/concept?
The example hellosidebar.py and the headers for all internal sidebars (e.g. StringsViewSidebarWidget)

How i got here
I want to implement a custom sidebar in Rust. I started with writing the python example in C++, which leaves me with a few basic questions:

  • Who is responsible for deleting the SidebarWidget* returned in the overload for SidebarWidgetType::createWidget and when is it deleted?
  • Who is responsible for deleting the SidebarWidgetType* registered with Sidebar::addSidebarWidgetType() and when is it deleted?
  • In General: Who is responsible for the pointers created using the UI-API?

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Start with python/examples/hellosidebar.py and the Sidebar, SidebarWidget, and SidebarWidgetType declarations, including the internal sidebar example in ui/stringsview.h. Trace the documented API ownership and destruction behavior for created and registered pointers, then update the relevant UI API documentation so each lifetime question has an explicit answer.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
cpp, python, rust
Ambito
desktop-dev, documentation
Tipo di issue
Documentazione
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
42/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.