search

rizinorg / cutter

Free and Open Source Reverse Engineering Platform powered by rizin
https://cutter.re
GNU General Public License v3.0
15.87k stars 1.15k forks source link

Configuration option to show the rizin commands / Python API hovering buttons #1662

Open XVilka opened 5 years ago

XVilka commented 5 years ago

To simplify the writing Cutter scripts without diving every time in the documentation it might be possible to adopt Blender approach - once you toggle configuration option "Python Tooltips", it shows the Python API required to do the same action, on hovering every button or other UI elements.

See the screenshot how it is done: image

See also https://blender.stackexchange.com/questions/18750/how-to-find-the-python-equivalent-operation-for-tools-settings-menu

xarkes commented 5 years ago

We could also add C++ API I think.

ITAYC0HEN commented 5 years ago

I think that this can be part of a whole solution in which we organize the actions in Cutter in some kind of a big structure. So if we already write the API for each action, we can also write the description of it and how to trigger it -- this can be used for a command palette https://github.com/radareorg/cutter/issues/1264