Add in progress UI API headers

1 files changed, 262 insertions, 0 deletions

diff --git a/ui/viewframe.h b/ui/viewframe.h
new file mode 100644
index 00000000..402c95c9
--- /dev/null
+++ b/ui/viewframe.h
@@ -0,0 +1,262 @@
+#pragma once
+
+#include <QtWidgets/QAction>
+#include <QtWidgets/QGestureEvent>
+#include <QtWidgets/QLabel>
+#include <QtCore/QPointer>
+#include <QtWidgets/QVBoxLayout>
+#include <QtWidgets/QWidget>
+#include <map>
+#include <stack>
+#include <utility>
+#include <vector>
+#include "filecontext.h"
+#include "viewtype.h"
+#include "action.h"
+
+class BINARYNINJAUIAPI HistoryEntry: public BinaryNinja::RefCountObject
+{
+	QString m_viewType;
+
+public:
+	virtual ~HistoryEntry() {}
+
+	QString getViewType() const { return m_viewType; }
+	void setViewType(const QString& type) { m_viewType = type; }
+};
+
+class AssembleDialog;
+class CompileDialog;
+class FeatureMap;
+class StatusBarWidget;
+class ViewNavigationMode;
+
+class BINARYNINJAUIAPI View
+{
+protected:
+	Menu m_contextMenu;
+	UIActionHandler m_actionHandler;
+
+	bool writeDataToClipboard(const BinaryNinja::DataBuffer& data, bool binary, TransformRef xform);
+	BinaryNinja::DataBuffer readDataFromClipboard(TransformRef xform);
+
+	// FIXME: Support for typeview, where the default navigation mode is not compatible with the navigation interface
+	// The view concept and navigation interface needs to be revisited at some point
+	// New interface/design should be pushed to NavigationHandler and through API
+	// The empty string is global navigation (inside view) by default, allows offset to be interpreted by mode
+	friend class ViewNavigationMode;
+	virtual std::string getNavigationMode() { return ""; }
+	virtual void setNavigationMode(std::string mode) { (void)mode; }
+	virtual std::vector<std::string> getNavigationModes() { return {}; }
+
+public:
+	View();
+	virtual ~View() {}
+
+	void setupView(QWidget* widget);
+
+	virtual bool canAssemble() { return false; }
+	virtual bool canCompile() { return false; }
+
+	virtual bool findNextData(uint64_t start, uint64_t end, const BinaryNinja::DataBuffer& data, uint64_t& addr, BNFindFlag flags,
+		const std::function<bool (size_t current, size_t total)>& cb);
+	virtual bool findNextText(uint64_t start, uint64_t end, const std::string& text, uint64_t& addr,
+		DisassemblySettingsRef settings, BNFindFlag flags,
+		const std::function<bool (size_t current, size_t total)>& cb);
+	virtual bool findNextConstant(uint64_t start, uint64_t end, uint64_t constant, uint64_t& addr, DisassemblySettingsRef settings,
+		const std::function<bool (size_t current, size_t total)>& cb);
+
+	virtual BinaryViewRef getData() = 0;
+	virtual uint64_t getCurrentOffset() = 0;
+	virtual void getSelectionOffsets(uint64_t& begin, uint64_t& end);
+	virtual void getSelectionForInfo(uint64_t& begin, uint64_t& end);
+	virtual bool navigate(uint64_t offset) = 0;
+	virtual bool navigateToFunction(FunctionRef func, uint64_t offset);
+	virtual bool goToReference(FunctionRef func, uint64_t source, uint64_t target);
+
+	virtual bool closeRequest() { return true; }
+	virtual void closing() {}
+	virtual void updateFonts() {}
+
+	virtual void undo();
+	virtual void redo();
+	virtual bool canUndo();
+	virtual bool canRedo();
+
+	virtual void cut();
+	virtual void copy(TransformRef xform = nullptr);
+	virtual void copyAddress();
+	virtual void paste(TransformRef xform = nullptr);
+	virtual bool canCut();
+	virtual bool canCopy();
+	virtual bool canCopyWithTransform();
+	virtual bool canCopyAddress();
+	virtual bool canPaste();
+	virtual bool canPasteWithTransform();
+
+	virtual void transform(TransformRef xform, bool encode);
+	virtual bool canTransform();
+
+	virtual void writeData(const BinaryNinja::DataBuffer& data);
+
+	virtual bool canDisplayAs(const UIActionContext& context);
+	virtual void displayAs(const UIActionContext& context, BNIntegerDisplayType type);
+
+	virtual HistoryEntry* getHistoryEntry();
+	virtual void navigateToHistoryEntry(HistoryEntry* entry);
+
+	virtual StatusBarWidget* getStatusBarWidget() { return nullptr; }
+
+	static View* getViewFromWidget(QWidget* widget);
+
+	virtual FunctionRef getCurrentFunction() { return nullptr; }
+	virtual BasicBlockRef getCurrentBasicBlock() { return nullptr; }
+	virtual ArchitectureRef getCurrentArchitecture() { return nullptr; }
+
+	virtual LowLevelILFunctionRef getCurrentLowLevelILFunction() { return nullptr; }
+	virtual MediumLevelILFunctionRef getCurrentMediumLevelILFunction() { return nullptr; }
+	virtual size_t getCurrentILInstructionIndex() { return BN_INVALID_EXPR; }
+
+	virtual QFont getFont() = 0;
+	DisassemblySettingsRef getDisassemblySettings();
+
+	virtual HighlightTokenState getHighlightTokenState();
+
+	virtual UIActionContext actionContext();
+	Menu& contextMenu() { return m_contextMenu; }
+	UIActionHandler* actionHandler() { return &m_actionHandler; }
+	QWidget* widget() { return m_actionHandler.widget(); }
+
+	static void registerActions();
+};
+
+
+class BINARYNINJAUIAPI ViewNavigationMode
+{
+	View* m_view;
+	std::string m_mode;
+
+	ViewNavigationMode();
+
+public:
+	ViewNavigationMode(View* view, std::string mode) : m_view(view) { m_mode = m_view->getNavigationMode(); m_view->setNavigationMode(mode); }
+	~ViewNavigationMode() { m_view->setNavigationMode(m_mode); }
+};
+
+class BINARYNINJAUIAPI ViewContainer
+{
+public:
+	virtual ~ViewContainer() {}
+	virtual View* getView() = 0;
+};
+
+class FunctionsView;
+
+class BINARYNINJAUIAPI ViewFrame : public QWidget
+{
+	Q_OBJECT
+
+private:
+	QWidget* createView(const QString& typeName, ViewType* type, BinaryViewRef data);
+	HistoryEntry* getHistoryEntry();
+
+	FileContext* m_context;
+	BinaryViewRef m_data;
+	QWidget* m_view;
+	QWidget* m_viewContainer;
+	QVBoxLayout* m_viewLayout;
+	std::map<QString, QPointer<QWidget>> m_extendedViewCache;
+	std::map<QString, QWidget*> m_viewCache;
+	std::stack<BinaryNinja::Ref<HistoryEntry>> m_back, m_forward;
+	bool m_graphViewPreferred = false;
+	std::vector<QString> m_viewTypePriority;
+
+	FunctionsView* m_funcs = nullptr;
+	FeatureMap* m_featureMap = nullptr;
+
+	UIActionHandler m_actionHandler;
+
+protected:
+	QPointer<CompileDialog> compileDialog;
+
+	bool event(QEvent* event) override;
+	virtual void mousePressEvent(QMouseEvent* event) override;
+	bool gestureEvent(QGestureEvent* event);
+
+	void setView(QWidget* view);
+
+public:
+	explicit ViewFrame(QWidget* parent, FileContext* file, const QString& type, bool createExtendedViews = false);
+	virtual ~ViewFrame();
+
+	FileContext* getFileContext() const { return m_context; }
+	FunctionsView* getFunctionsView() const { return m_funcs; }
+
+	QString getTabName();
+	QString getShortFileName();
+	std::vector<QString> getAvailableTypes() const;
+
+	QString getCurrentView();
+	QString getCurrentDataType();
+	uint64_t getCurrentOffset();
+	void getSelectionOffsets(uint64_t& begin, uint64_t& end);
+
+	View* getCurrentViewInterface() const { return View::getViewFromWidget(m_view); }
+	QWidget* getCurrentWidget() const { return m_view; }
+
+	bool setViewType(const QString& type);
+	bool isGraphViewPreferred() { return m_graphViewPreferred; }
+	void setGraphViewPreferred(bool graphViewPreferred) { m_graphViewPreferred = graphViewPreferred; }
+	void focus();
+	void closeFeatureMap();
+	QWidget* createFeatureMap();
+	void refreshFeatureMap();
+
+	QWidget* getExtendedView(const QString& name, bool create = false);
+
+	bool navigate(const QString& type, uint64_t offset, bool updateInfo = true);
+	bool navigate(const QString& type, const std::function<bool(View*)>& handler, bool updateInfo = true);
+	bool navigate(BinaryViewRef data, uint64_t offset, bool updateInfo = true);
+	bool navigateToFunction(FunctionRef func, uint64_t offset, bool updateInfo = true);
+	bool goToReference(BinaryViewRef data, FunctionRef func, uint64_t source, uint64_t target);
+	QString getTypeForView(QWidget* view);
+	QString getDataTypeForView(QWidget* view);
+
+	bool closeRequest();
+	void closing();
+
+	void updateFonts();
+	void updateTheme();
+	void addHistoryEntry();
+	void back();
+	void forward();
+
+	static bool getAddressFromString(QWidget* parent, BinaryViewRef data, uint64_t& offset,
+		uint64_t currentAddress, const QString& addrStr, std::string& errorString);
+	static bool getAddressFromInput(QWidget* parent, BinaryViewRef data, uint64_t& offset,
+		uint64_t currentAddress, const QString& title = "Go to Address", const QString& msg = "Address:");
+
+	void setCurrentFunction(FunctionRef func);
+	void updateFeatureMapLocation(View* view);
+	void updateCrossReferences();
+	void showCrossReferences();
+
+	virtual UIActionContext actionContext();
+	void bindActions();
+	static void registerActions();
+
+	static ViewFrame* viewFrameForWidget(QWidget* widget);
+
+public Q_SLOTS:
+	virtual void assemble();
+	virtual void compile();
+
+private Q_SLOTS:
+	void deleteFeatureMap();
+
+Q_SIGNALS:
+	void notifyCloseFeatureMap();
+	void nofifyViewChanged(ViewFrame* frame);
+};
+
+Q_DECLARE_METATYPE(View*)