Allow sidebar icons to be hidden

Author: D0ntPanic

ui/globalarea.h

@@ -215,5 +215,6 @@ class BINARYNINJAUIAPI GlobalAreaCompatibilitySidebarWidgetType : public Sidebar
 	SidebarWidgetLocation defaultLocation() const override { return SidebarWidgetLocation::LeftBottom; }
 	SidebarContextSensitivity contextSensitivity() const override { return GlobalSidebarContext; }
 	bool alwaysShowTabs() const override { return true; }
-	bool hideIfNoContent() const override { return true; }
+	SidebarIconVisibility defaultIconVisibility() const override { return InvisibleIfNoContent; }
+	SidebarContentClassifier* contentClassifier(ViewFrame*, BinaryViewRef) override;
 };

ui/sidebar.h

@@ -60,6 +60,7 @@ class BINARYNINJAUIAPI Sidebar : public QObject
 	static std::set<Sidebar*> m_instances;
 	static std::set<SidebarWidgetType*> m_defaultTypes;
 	static std::optional<SidebarMetrics> m_metrics;
+	static std::map<QString, SidebarIconVisibility> m_iconVisibility;
 
 private Q_SLOTS:
 	void containerUpdated();
@@ -122,6 +123,8 @@ private Q_SLOTS:
 	bool isContentActive() const;
 	bool isSideContentActive() const;
 	bool isBottomContentActive() const;
+	bool allIconsVisible() const;
+	std::vector<SidebarWidgetType*> hiddenIcons() const;
 
 	void updateTheme();
 	void updateFonts();
@@ -146,13 +149,20 @@ private Q_SLOTS:
 	static std::vector<SidebarWidgetType*> typesForContainerLocation(SidebarContainerLocation location);
 	static void initSavedTypeOrdering();
 	static void saveTypeOrdering();
+	static void initIconVisibility();
+	static void saveIconVisibility();
 
 	static SidebarMetrics metrics();
 	static void refreshMetrics();
 
 	static std::set<SidebarWidgetType*> defaultTypes() { return m_defaultTypes; }
 	static void setDefaultTypes(const std::set<SidebarWidgetType*>& types) { m_defaultTypes = types; }
 
+	static SidebarIconVisibility iconVisibility(SidebarWidgetType* type);
+	static SidebarIconVisibility iconVisibility(const QString& name);
+	static void setIconVisibility(SidebarWidgetType* type, SidebarIconVisibility visibility);
+	static void setIconVisibility(const QString& name, SidebarIconVisibility visibility);
+
 	static Sidebar* current()
 	{
 		UIContext* context = UIContext::activeContext();

ui/sidebarcontainer.h

@@ -4,10 +4,9 @@
 #include <QtWidgets/QStackedWidget>
 #include <QtWidgets/QWidget>
 #include "splitter.h"
+#include "sidebarwidget.h"
 
 class Sidebar;
-class SidebarWidgetType;
-class SidebarWidgetAndHeader;
 class SplitPaneWidget;
 
 /*!
@@ -88,17 +87,22 @@ class BINARYNINJAUIAPI SidebarWidgetContainer : public QWidget
 	std::map<SplitPaneWidget*,
 		std::map<ViewFrame*, std::map<QString, std::map<SidebarWidgetType*, SidebarWidgetAndHeader*>>>>
 		m_widgets;
+	std::map<SplitPaneWidget*,
+		std::map<ViewFrame*, std::map<QString, std::map<SidebarWidgetType*, SidebarContentClassifier*>>>>
+		m_contentClassifiers;
 	std::map<SplitPaneWidget*, std::map<QString, std::set<SidebarWidgetType*>>> m_priorWidgets;
 
 	std::map<SidebarWidgetType*, SidebarFloatingWidgetState> m_savedFloatingWidgetState;
 
 	SidebarStackedWidget& stackedWidgetForType(SidebarWidgetType* type);
 	std::vector<SidebarWidgetAndHeader*> widgetsForContext() const;
+	std::vector<SidebarContentClassifier*> contentClassifiersForContext() const;
 	void insertWidgetIntoContainer(SidebarWidgetType* type, QStackedWidget* widget);
 	void updateContentsVisibility();
 
 private Q_SLOTS:
 	void floatingWidgetClosed(SidebarWidgetType* type);
+	void childContentClassificationChanged();
 
 public:
 	SidebarWidgetContainer(Sidebar* sidebar, SidebarContainerLocation location);
@@ -134,8 +138,11 @@ private Q_SLOTS:
 	SidebarWidget* widgetWithTitle(SidebarWidgetType* type, const QString& title) const;
 	bool hasWidgetWithTitle(SidebarWidgetType* type, const QString& title) const;
 	bool activateWidgetWithTitle(SidebarWidgetType* type, const QString& title) const;
-	bool hasContent(SidebarWidgetType* type) const;
-	bool shouldHide(SidebarWidgetType* type) const;
+	SidebarContentClassification contentClassification(SidebarWidgetType* type);
+	bool hasContent(SidebarWidgetType* type);
+	bool shouldHide(SidebarWidgetType* type);
+
+	SidebarContentClassifier* contentClassifier(SidebarWidgetType* type);
 
 	virtual QSize sizeHint() const override;
 
@@ -162,4 +169,5 @@ private Q_SLOTS:
 Q_SIGNALS:
 	void showContents();
 	void hideContents();
+	void contentClassificationChanged();
 };

ui/sidebaricons.h

@@ -78,9 +78,11 @@ class BINARYNINJAUIAPI SidebarIconsWidget : public QWidget
 	std::pair<SidebarWidgetLocation, size_t> findDropLocation(int y) const;
 	QRect placeholderRect() const;
 	bool shouldBeVisible() const;
+	bool shouldContainMoreIcon() const;
 
 private Q_SLOTS:
 	void containerUpdated();
+	void contentClassificationChanged();
 
 protected:
 	virtual void paintEvent(QPaintEvent* event) override;

ui/sidebarwidget.h

@@ -185,6 +185,51 @@ enum SidebarContextSensitivity
 	PerPaneSidebarContext
 };
 
+/*!
+    \ingroup sidebar
+*/
+enum SidebarIconVisibility
+{
+	AlwaysShowSidebarIcon,
+	HideSidebarIconIfNoContent,
+	AlwaysHideSidebarIcon,
+	InvisibleIfNoContent
+};
+
+/*!
+    \ingroup sidebar
+*/
+enum SidebarContentClassification
+{
+	SidebarHasRelevantContent,
+	SidebarHasGeneralMessage,
+	SidebarHasNoContent,
+	SidebarIsWidgetContainer
+};
+
+class BINARYNINJAUIAPI SidebarContentClassifier : public QObject
+{
+	Q_OBJECT
+
+public:
+	virtual SidebarContentClassification contentClassification() = 0;
+	virtual void notifyViewChanged(ViewFrame*) {}
+
+Q_SIGNALS:
+	void contentClassificationChanged();
+};
+
+class BINARYNINJAUIAPI StaticSidebarContentClassifier : public SidebarContentClassifier
+{
+	Q_OBJECT
+
+	SidebarContentClassification m_classification;
+
+public:
+	StaticSidebarContentClassifier(SidebarContentClassification classification) : m_classification(classification) {}
+	SidebarContentClassification contentClassification() override { return m_classification; }
+};
+
 /*!
     \ingroup sidebar
 */
@@ -213,8 +258,14 @@ class BINARYNINJAUIAPI SidebarWidgetType
 	virtual SidebarWidgetLocation defaultLocation() const;
 	virtual SidebarContextSensitivity contextSensitivity() const;
 	virtual bool alwaysShowTabs() const { return false; }
+
+	/*!
+	    \deprecated Use `defaultIconVisibility()`
+	*/
 	virtual bool hideIfNoContent() const { return false; }
 
+	virtual SidebarIconVisibility defaultIconVisibility() const;
+
 	virtual SidebarWidget* createWidget(ViewFrame* /*frame*/, BinaryViewRef /*data*/) { return nullptr; }
 	virtual SidebarWidget* createInvalidContextWidget();
 	virtual QWidget* headerWidget(SplitPaneWidget* /*panes*/, ViewFrame* /*frame*/, BinaryViewRef /*data*/)
@@ -228,5 +279,18 @@ class BINARYNINJAUIAPI SidebarWidgetType
 	virtual bool canUseAsPane(SplitPaneWidget* /*panes*/, BinaryViewRef /*data*/) const { return false; }
 	virtual Pane* createPane(SplitPaneWidget* /*panes*/, BinaryViewRef /*data*/) { return nullptr; }
 
+	virtual SidebarContentClassifier* contentClassifier(ViewFrame* /*frame*/, BinaryViewRef /*data*/)
+	{
+		return nullptr;
+	}
+
 	void updateTheme();
 };
+
+class BINARYNINJAUIAPI MoreSidebarWidgetType : public SidebarWidgetType
+{
+public:
+	MoreSidebarWidgetType();
+
+	static MoreSidebarWidgetType* instance();
+};

ui/workflowmonitor.h

@@ -102,6 +102,7 @@ class BINARYNINJAUIAPI WorkflowMonitorSidebarWidgetType : public SidebarWidgetTy
 
 	SidebarWidgetLocation defaultLocation() const override { return SidebarWidgetLocation::LeftReference; }
 	SidebarContextSensitivity contextSensitivity() const override { return PerViewTypeSidebarContext; }
+	SidebarIconVisibility defaultIconVisibility() const override { return AlwaysHideSidebarIcon; }
 
 	SidebarWidget* createWidget(ViewFrame* frame, BinaryViewRef data) override;