update readme

elbiazo · Mar 7, 2023 · e4e415d · e4e415d
1 parent a0ecd78
commit e4e415d
Show file tree

Hide file tree

Showing 9 changed files with 43 additions and 23 deletions.
diff --git a/README.md b/README.md
@@ -6,10 +6,11 @@ Calltree generator for function
 
 ## Description:
 
-Generates call tree
+Generates call tree. Alternative view for callgraph.
 
 ## Releases
 
+* 2.0 -- Multiview Support
 * 1.2 -- Bug Fixes
 * 1.1 -- Refactoring
 * 1.0 -- Public Release
@@ -30,23 +31,27 @@ This plugin is released under an [MIT license](./LICENSE).
 When working with really big binaries with alot of xrefs, you would want to change recursive depth to smaller number or else Binary Ninja might hang.
 ## Description
 
-![](images/2022-02-09-16-42-57.png)
+Calltree is a plugin that generates call tree for a function. It is an alternative view for callgraph. It is a multiview plugin, so you can have multiple calltree views open at the same time.
+
+### Default View
+
+![](images/2023-03-06-23-31-27.png)
 
 ### Expand and Collapse tree
 
 **Expand**
 
-![](images/2022-02-09-16-50-03.png)
+![](images/2023-03-06-23-44-02.png)
 
 **Collapse**
 
-![](images/2022-02-09-16-51-28.png)
+![](images/2023-03-06-23-44-24.png)
 
 **Search**
 
 ![](images/2022-02-09-16-53-33.png)
 
-**Recursion Depth**
+### Recursion Depth
 
 **Show Only Root Level**
 
@@ -56,9 +61,21 @@ When working with really big binaries with alot of xrefs, you would want to chan
 
 ![](images/2022-02-09-16-59-03.png)
 
+### Pinning and Removing Calltree View
+
+**Pinning Calltree View**
+
+![](images/2023-03-06-23-40-42.png)
+
+**Pinned Calltree Name Max Length**
+
+![](images/2023-03-06-23-46-04.png)
+
+
 ## Contributors
 
 Thanks everyone that have contributed to calltree!
 
 * galenbwill
 * droogie
+* bambu
diff --git a/images/2023-03-06-23-30-37.png b/images/2023-03-06-23-30-37.png
diff --git a/images/2023-03-06-23-31-27.png b/images/2023-03-06-23-31-27.png
diff --git a/images/2023-03-06-23-40-42.png b/images/2023-03-06-23-40-42.png
diff --git a/images/2023-03-06-23-44-02.png b/images/2023-03-06-23-44-02.png
diff --git a/images/2023-03-06-23-44-24.png b/images/2023-03-06-23-44-24.png
diff --git a/images/2023-03-06-23-46-04.png b/images/2023-03-06-23-46-04.png
diff --git a/init.py b/init.py
@@ -16,8 +16,9 @@
     QPushButton,
     QSpinBox,
     QHBoxLayout,
+    QStyle,
 )
-from PySide6.QtGui import QImage
+from PySide6.QtGui import QImage, QIcon, QPixmap
 
 from .calltree import CallTreeLayout, CurrentFunctionNameLayout, CalltreeWidget
 from binaryninja.settings import Settings
@@ -55,7 +56,7 @@
     {
         "title" : "Pinned Name Length",
         "type" : "number",
-        "default" : 5,
+        "default" : 10,
         "description" : "Max length of string to display in pinned tabs",
         "ignore" : ["SettingsProjectScope", "SettingsResourceScope"]
     }
@@ -122,11 +123,10 @@ def __init__(self, name: str, frame, data):
         calltree_options = QHBoxLayout()
 
         self.pin_tab_button = QPushButton("P")
-        btn_size = QSize(25, 25)
+        btn_size = QSize(50, 25)
         self.pin_tab_button.setFixedSize(btn_size)
         self.pin_tab_button.clicked.connect(self.pin_current_tab)
         self.remove_current_tab_button = QPushButton("R")
-        btn_size = QSize(25, 25)
         self.remove_current_tab_button.setFixedSize(btn_size)
         self.remove_current_tab_button.clicked.connect(self.remove_current_tab)
 
@@ -150,19 +150,22 @@ def remove_current_tab(self):
             self.calltree_tab.removeTab(cur_tab_index)
 
     def pin_current_tab(self):
-        pinned_calltree = CalltreeWidget()
-        cur_func_name = self.current_calltree.cur_func_text.toPlainText()
-        pinned_calltree.cur_func_text.setText(cur_func_name)
-
-        # TODO: find a way to do deepcopy instead of updating widget everytime
-        pinned_calltree.in_calltree.binary_view = self.binary_view
-        pinned_calltree.out_calltree.binary_view = self.binary_view
-        pinned_calltree.in_calltree.update_widget(self.cur_func)
-        pinned_calltree.out_calltree.update_widget(self.cur_func)
-        pinned_calltree.cur_func_layout.binary_view = self.binary_view
-
-        max_pinned_name_len = Settings().get_integer("calltree.pin_name_len")
-        self.calltree_tab.addTab(pinned_calltree, cur_func_name[:max_pinned_name_len])
+        if self.cur_func is not None:
+            pinned_calltree = CalltreeWidget()
+            cur_func_name = self.current_calltree.cur_func_text.toPlainText()
+            pinned_calltree.cur_func_text.setText(cur_func_name)
+
+            # TODO: find a way to do deepcopy instead of updating widget everytime
+            pinned_calltree.in_calltree.binary_view = self.binary_view
+            pinned_calltree.out_calltree.binary_view = self.binary_view
+            pinned_calltree.in_calltree.update_widget(self.cur_func)
+            pinned_calltree.out_calltree.update_widget(self.cur_func)
+            pinned_calltree.cur_func_layout.binary_view = self.binary_view
+
+            max_pinned_name_len = Settings().get_integer("calltree.pin_name_len")
+            self.calltree_tab.addTab(
+                pinned_calltree, cur_func_name[:max_pinned_name_len]
+            )
 
     def notifyViewLocationChanged(self, view, location):
         def extract_location_info(location):

diff --git a/plugin.json b/plugin.json
@@ -10,7 +10,7 @@
    "api": [
       "python3"
    ],
-   "description": "Generates calltree",
+   "description": "Generates calltree. Alternative view for callgraph",
    "longdescription": "Generates calltree for current function. Alternative view for callgraph",
    "license": {
       "name": "MIT",