path: root/ui/taglist.h

#pragma once

#include <memory>
#include <QtCore/QAbstractItemModel>
#include <QtCore/QItemSelectionModel>
#include <QtWidgets/QTreeView>
#include <QtWidgets/QTabWidget>
#include <QtWidgets/QStyledItemDelegate>
#include <QtWidgets/QDialog>
#include "binaryninjaapi.h"
#include "notificationsdispatcher.h"
#include "sidebar.h"
#include "viewframe.h"
#include "filter.h"
#include "tagtypelist.h"

/*!

	\defgroup taglist TagList
 	\ingroup uiapi
*/

/*!

    \ingroup taglist
*/
class BINARYNINJAUIAPI TagListModel : public QAbstractItemModel
{
	Q_OBJECT

	using TagStorage = std::vector<std::tuple<TagTypeRef, QString, std::vector<BinaryNinja::TagReference>>>;
	using TagTypeStorage = std::vector<std::pair<TagTypeRef, QString>>;
	using TagTypeIndices = std::map<TagTypeRef, size_t>;

protected:
	QWidget* m_owner;
	BinaryViewRef m_data;
	NotificationsDispatcher* m_dispatcher = nullptr;
	TagTypeStorage m_tagTypes;
	std::unordered_map<std::string, uint64_t> m_tagTypeCounts;
	TagStorage m_tagStorage;
	TagTypeIndices m_tagTypeIndices;
	std::map<int, QSize> m_sectionSizeHints;
	DisassemblySettingsRef m_settings;

private:
	void AddDisassemblyTokens(QList<QVariant>& line, std::vector<BinaryNinja::InstructionTextToken> tokens) const;

	void TrimLeadingWhitespace(QList<QVariant>& line) const;

	QVariant GetIconColumn(const BinaryNinja::TagReference& ref) const;
	QVariant GetLocationColumn(const BinaryNinja::TagReference& ref) const;
	QVariant GetDataColumn(const BinaryNinja::TagReference& ref) const;
	QVariant GetPreviewColumn(const BinaryNinja::TagReference& ref) const;

	QVariant GetIconColumn(const TagTypeRef& ref) const;
	QVariant GetLocationColumn(const TagTypeRef& ref) const;
	QVariant GetDataColumn(const TagTypeRef& ref) const;
	QVariant GetPreviewColumn(const TagTypeRef& ref) const;

public:
	TagListModel(QWidget* parent, BinaryViewRef data);
	virtual ~TagListModel();

	void connectDataStore();
	void disconnectDataStore();

	BinaryNinja::TagReference& GetRef(const QModelIndex& index);
	const BinaryNinja::TagReference& GetRef(const QModelIndex& index) const;

	void SetSectionSizeHints(const std::map<int, QSize>& sizes) { m_sectionSizeHints = sizes; }

	TagTypeRef GetTypeRef(const QModelIndex& index);
	const TagTypeRef GetTypeRef(const QModelIndex& index) const;

	virtual QModelIndex index(int row, int col, const QModelIndex& parent) const override;
	virtual QModelIndex parent(const QModelIndex& i) const override;
	virtual bool hasChildren(const QModelIndex& parent) const override;
	virtual int rowCount(const QModelIndex& parent) const override;
	virtual int columnCount(const QModelIndex& parent) const override;
	virtual QVariant headerData(int section, Qt::Orientation orientation, int role) const override;
	virtual QVariant data(const QModelIndex& i, int role) const override;
	virtual bool setData(const QModelIndex& i, const QVariant& value, int role = Qt::EditRole) override;
	virtual Qt::ItemFlags flags(const QModelIndex& i) const override;
	virtual void sort(int column, Qt::SortOrder order) override;

	void backgroundSort(int column, Qt::SortOrder order, TagStorage& tagStorage, TagTypeStorage& tagTypeStorage, TagTypeIndices& tagTypeIndices);
	void refresh();

Q_SIGNALS:
	void notifyUpdateComplete(bool complete);
};

/*!

    \ingroup taglist
*/
class BINARYNINJAUIAPI TagItemDelegate : public QStyledItemDelegate
{
	Q_OBJECT

  protected:
	QFont m_font, m_monospaceFont, m_emojiFont;
	int m_baseline, m_charWidth, m_charHeight, m_charOffset;

	void initFont();

  public:
	TagItemDelegate(QWidget* parent);

	void updateFonts();

	virtual QSize sizeHint(const QStyleOptionViewItem& option, const QModelIndex& idx) const override;
	virtual void paint(QPainter* painter, const QStyleOptionViewItem& option, const QModelIndex& idx) const override;
	virtual void setEditorData(QWidget* editor, const QModelIndex& index) const override;
};

/*!

    \ingroup taglist
*/
class BINARYNINJAUIAPI TagList : public QTreeView, public FilterTarget
{
	Q_OBJECT

	ViewFrame* m_view;
	class TagListWidget* m_listWidget;
	TagListModel* m_list;
	TagItemDelegate* m_itemDelegate;
	BinaryViewRef m_data;
	UIActionHandler* m_handler;
	UIActionHandler m_actionHandler;
	ContextMenuManager* m_contextMenuManager;
	FilteredView* m_filterView;
	std::unique_ptr<Menu> m_ownedMenu;
	Menu* m_menu;
	std::mutex m_filterMutex;

	// view state
	std::set<QString> m_expandedItems;
	bool m_editing = false;
	std::vector<std::pair<TagTypeRef, std::vector<BinaryNinja::TagReference>>> m_savedSelections;

  public:
	typedef std::function<bool(const BinaryNinja::TagReference&)> FilterFn;

  private:
	std::optional<FilterFn> m_filterFn;

	FilterOptions m_searchFilterOptions;
	std::string m_searchFilter;

	QTimer* m_hoverTimer;
	QPoint m_hoverPos;

	bool m_navToNextOrPrevStarted = false;

  protected:
	virtual void contextMenuEvent(QContextMenuEvent* event) override;
	virtual void keyPressEvent(QKeyEvent* e) override;
	virtual void mouseMoveEvent(QMouseEvent* e) override;
	virtual void mousePressEvent(QMouseEvent* e) override;
	virtual void wheelEvent(QWheelEvent* e) override;
	virtual void resizeEvent(QResizeEvent* event) override;
	void goToReference(const QModelIndex& idx);

	void setFilter(const std::string& filter, FilterOptions options) override;

  private Q_SLOTS:
	void hoverTimerEvent();
	void referenceActivated(const QModelIndex& idx);

	void saveViewState();
	void restoreViewState();

  public Q_SLOTS:
	void showContextMenu();

  public:
	TagList(QWidget* parent, ViewFrame* view, BinaryViewRef data, TagListModel* model = nullptr, Menu* menu = nullptr);
	virtual ~TagList();

	static void registerActions();
	virtual void setModel(QAbstractItemModel* model) override;

	void notifyFontChanged();
	void removeSelection();
	void copySelection();

	void filterTagReferences(std::vector<BinaryNinja::TagReference>& refs);
	void clearFilter();
	void setFilterFunction(FilterFn filter);
	void setFilterView(FilteredView* filterView) { m_filterView = filterView; }

	bool hasSelection();
	void navigateToNext();
	void navigateToPrev();

	virtual void scrollToFirstItem() override;
	virtual void scrollToCurrentItem() override;
	virtual void ensureSelection() override;
	virtual void activateSelection() override;
};

/*!

    \ingroup taglist
*/
class BINARYNINJAUIAPI TagListWidget : public SidebarWidget
{
	Q_OBJECT

	ViewFrame* m_view;
	QTabWidget* m_tabs;

	TagList* m_notificationList;
	FilteredView* m_notificationFilter;
	QWidget* m_header;

	FilterEdit* m_filterEdit;

	TagTypeList* m_typeList;

	BinaryViewRef m_data;
	UIActionHandler* m_handler;

  protected:
	virtual void notifyFontChanged() override;

  private Q_SLOTS:
	void showContextMenu();
	void onTabChanged(int which);

  public:
	TagList* GetList();
	void editTag(TagRef tag);
	TagList* getNotificationList() { return m_notificationList; }
	FilteredView* getNotificationFilter() { return m_notificationFilter; }

	TagListWidget(ViewFrame* view, BinaryViewRef data);
	virtual ~TagListWidget();

	virtual void focus() override;
	virtual QWidget* headerWidget() override { return m_header; }
};

/*!

    \ingroup taglist
*/
class BINARYNINJAUIAPI TagListDialog : public QDialog
{
	Q_OBJECT

  public:
	typedef std::function<void(const TagRef&)> AddFn;

  private:
	BinaryViewRef m_data;
	TagList* m_list;
	FilterEdit* m_filterEdit;
	FilteredView* m_filter;

	AddFn m_addFn;

	QPushButton* m_removeButton;

  public:
	TagListDialog(QWidget* parent, ViewFrame* frame, BinaryViewRef data, AddFn addFn);
	void setFilterFunction(TagList::FilterFn filter);

  private Q_SLOTS:
	void updateActive(const QItemSelection&, const QItemSelection&);
	void createTag();
	void createTagAccept(TagTypeRef tt);
	void removeTag();
};

/*!

    \ingroup taglist
*/
class BINARYNINJAUIAPI TagListSidebarWidgetType : public SidebarWidgetType
{
  public:
	TagListSidebarWidgetType();
	virtual SidebarWidget* createWidget(ViewFrame* frame, BinaryViewRef data) override;
	SidebarWidgetLocation defaultLocation() const override { return SidebarWidgetLocation::LeftContent; }
	SidebarContextSensitivity contextSensitivity() const override { return PerViewTypeSidebarContext; }
};