Loading...
Searching...
No Matches
Classes
MemoryMap
C++ UI API

Detailed Description

Classes

class  MemoryMapItemDelegate
 
class  SegmentDialog
 
class  SectionDialog
 
class  SegmentWidget
 
class  SectionWidget
 
class  MemoryMapView
 
class  MemoryMapContainer
 
class  MemoryMapViewType
 
class  MemoryMapSidebarWidget
 
class  MemoryMapSidebarWidgetType
 

Class Documentation

◆ MemoryMapItemDelegate

class MemoryMapItemDelegate

Public Member Functions

 MemoryMapItemDelegate (QObject *parent=nullptr)
 
virtual void paint (QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const override
 

Constructor & Destructor Documentation

◆ MemoryMapItemDelegate()

MemoryMapItemDelegate::MemoryMapItemDelegate ( QObject * parent = nullptr)
inline

Member Function Documentation

◆ paint()

virtual void MemoryMapItemDelegate::paint ( QPainter * painter,
const QStyleOptionViewItem & option,
const QModelIndex & index ) const
overridevirtual

◆ SegmentDialog

class SegmentDialog

Public Member Functions

 SegmentDialog (QWidget *parent, BinaryViewRef data, SegmentRef segment=nullptr)
 

Constructor & Destructor Documentation

◆ SegmentDialog()

SegmentDialog::SegmentDialog ( QWidget * parent,
BinaryViewRef data,
SegmentRef segment = nullptr )

◆ SectionDialog

class SectionDialog

Public Member Functions

void SetDefaultValues (const QString &name, uint64_t start, uint64_t length, BNSectionSemantics semantics)
 
 SectionDialog (QWidget *parent, BinaryViewRef data, SectionRef section=nullptr)
 

Constructor & Destructor Documentation

◆ SectionDialog()

SectionDialog::SectionDialog ( QWidget * parent,
BinaryViewRef data,
SectionRef section = nullptr )

Member Function Documentation

◆ SetDefaultValues()

void SectionDialog::SetDefaultValues ( const QString & name,
uint64_t start,
uint64_t length,
BNSectionSemantics semantics )

◆ SegmentWidget

class SegmentWidget

Signals

void currentSegmentChanged (SegmentRef current)
 
void addressDoubleClicked (uint64_t address)
 
void rawAddressDoubleClicked (uint64_t address)
 

Public Member Functions

 SegmentWidget (BinaryViewRef data, QWidget *parent=nullptr)
 
virtual ~SegmentWidget ()
 
SegmentModel * model ()
 
void updateFont ()
 
void highlightRelatedSegments (SectionRef section)
 
void currentRowChanged (const QModelIndex &current, const QModelIndex &previous)
 

Constructor & Destructor Documentation

◆ SegmentWidget()

SegmentWidget::SegmentWidget ( BinaryViewRef data,
QWidget * parent = nullptr )

◆ ~SegmentWidget()

virtual SegmentWidget::~SegmentWidget ( )
virtual

Member Function Documentation

◆ model()

SegmentModel * SegmentWidget::model ( )
inline

◆ updateFont()

void SegmentWidget::updateFont ( )

◆ highlightRelatedSegments()

void SegmentWidget::highlightRelatedSegments ( SectionRef section)

◆ currentRowChanged()

void SegmentWidget::currentRowChanged ( const QModelIndex & current,
const QModelIndex & previous )

◆ currentSegmentChanged

void SegmentWidget::currentSegmentChanged ( SegmentRef current)
signal

◆ addressDoubleClicked

void SegmentWidget::addressDoubleClicked ( uint64_t address)
signal

◆ rawAddressDoubleClicked

void SegmentWidget::rawAddressDoubleClicked ( uint64_t address)
signal

◆ SectionWidget

class SectionWidget

Signals

void currentSectionChanged (SectionRef current)
 
void addressDoubleClicked (uint64_t address)
 

Public Member Functions

 SectionWidget (BinaryViewRef data, QWidget *parent=nullptr)
 
virtual ~SectionWidget ()
 
SectionModel * model ()
 
void updateFont ()
 
void highlightRelatedSections (SegmentRef segment)
 
void currentRowChanged (const QModelIndex &current, const QModelIndex &previous)
 

Constructor & Destructor Documentation

◆ SectionWidget()

SectionWidget::SectionWidget ( BinaryViewRef data,
QWidget * parent = nullptr )

◆ ~SectionWidget()

virtual SectionWidget::~SectionWidget ( )
virtual

Member Function Documentation

◆ model()

SectionModel * SectionWidget::model ( )
inline

◆ updateFont()

void SectionWidget::updateFont ( )

◆ highlightRelatedSections()

void SectionWidget::highlightRelatedSections ( SegmentRef segment)

◆ currentRowChanged()

void SectionWidget::currentRowChanged ( const QModelIndex & current,
const QModelIndex & previous )

◆ currentSectionChanged

void SectionWidget::currentSectionChanged ( SectionRef current)
signal

◆ addressDoubleClicked

void SectionWidget::addressDoubleClicked ( uint64_t address)
signal

◆ MemoryMapView

class MemoryMapView

Public Member Functions

 MemoryMapView (BinaryViewRef data, MemoryMapContainer *container)
 
virtual ~MemoryMapView ()
 
BinaryViewRef getData () override
 
uint64_t getCurrentOffset () override
 
BNAddressRange getSelectionOffsets () override
 
void setSelectionOffsets (BNAddressRange range) override
 
bool navigate (uint64_t offset) override
 
QFont getFont () override
 
void setCurrentOffset (uint64_t offset)
 
void updateFonts () override
 
- Public Member Functions inherited from View
 View ()
 
virtual ~View ()
 
void enableRefreshTimer (QWidget *owner, int interval)
 
void setRefreshQuiesce (bool enable)
 
bool isQuiesced () const
 
virtual void notifyRefresh ()
 
virtual void notifyQuiesce (bool)
 
void setupView (QWidget *widget)
 
virtual bool canAssemble ()
 
virtual bool canCompile ()
 
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 BinaryNinja::FunctionViewType &graph, 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 BinaryNinja::FunctionViewType &graph, const std::function< bool(size_t current, size_t total)> &cb)
 
virtual bool findAllData (uint64_t start, uint64_t end, const BinaryNinja::DataBuffer &data, BNFindFlag flags, const std::function< bool(size_t current, size_t total)> &cb, const std::function< bool(uint64_t addr, const BinaryNinja::DataBuffer &match)> &matchCallback)
 
virtual bool findAllText (uint64_t start, uint64_t end, const std::string &data, DisassemblySettingsRef settings, BNFindFlag flags, const BinaryNinja::FunctionViewType &graph, const std::function< bool(size_t current, size_t total)> &cb, const std::function< bool(uint64_t addr, const std::string &match, const BinaryNinja::LinearDisassemblyLine &line)> &matchCallback)
 
virtual bool findAllConstant (uint64_t start, uint64_t end, uint64_t constant, DisassemblySettingsRef settings, const BinaryNinja::FunctionViewType &graph, const std::function< bool(size_t current, size_t total)> &cb, const std::function< bool(uint64_t addr, const BinaryNinja::LinearDisassemblyLine &line)> &matchCallback)
 
virtual SelectionInfoForXref getSelectionForXref ()
 
virtual bool navigateToFunction (FunctionRef func, uint64_t offset)
 
virtual bool goToReference (FunctionRef func, uint64_t source, uint64_t target)
 
virtual bool navigateToViewLocation (const ViewLocation &viewLocation, bool center=false)
 
bool navigateOnOtherPane (uint64_t offset)
 
bool navigateToFunctionOnOtherPane (FunctionRef func, uint64_t offset)
 
bool isBinaryDataNavigable ()
 
void setBinaryDataNavigable (bool navigable)
 
virtual bool closeRequest ()
 
virtual void closing ()
 
virtual void updateTheme ()
 
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 copyLocationAsURL ()
 
virtual void paste (TransformRef xform=nullptr)
 
virtual bool canCut ()
 
virtual bool canCopy ()
 
virtual bool canCopyWithTransform ()
 
virtual bool canCopyAddress ()
 
virtual bool canCopyLocationAsURL ()
 
virtual bool canPaste ()
 
virtual bool canPasteWithTransform ()
 
virtual void transform (TransformRef xform, bool encode)
 
virtual bool canTransform ()
 
virtual void writeData (const BinaryNinja::DataBuffer &data, uint64_t addr)
 
virtual bool canDisplayAs (const UIActionContext &context, const BNIntegerDisplayType)
 
virtual void displayAs (const UIActionContext &context, BNIntegerDisplayType type)
 
virtual BinaryNinja::Ref< HistoryEntry > getHistoryEntry ()
 
virtual void navigateToHistoryEntry (BinaryNinja::Ref< HistoryEntry > entry)
 
virtual StatusBarWidget * getStatusBarWidget ()
 
virtual ViewPaneHeaderSubtypeWidget * getHeaderSubtypeWidget ()
 
virtual QWidget * getHeaderOptionsWidget ()
 
virtual FunctionRef getCurrentFunction ()
 
virtual BasicBlockRef getCurrentBasicBlock ()
 
virtual ArchitectureRef getCurrentArchitecture ()
 
virtual LowLevelILFunctionRef getCurrentLowLevelILFunction ()
 
virtual MediumLevelILFunctionRef getCurrentMediumLevelILFunction ()
 
virtual HighLevelILFunctionRef getCurrentHighLevelILFunction ()
 
virtual BinaryNinja::FunctionViewType getILViewType ()
 
virtual void setILViewType (const BinaryNinja::FunctionViewType &ilViewType)
 
virtual size_t getCurrentILInstructionIndex ()
 
virtual size_t getSelectionStartILInstructionIndex ()
 
virtual BNILIndexRange getILIndexRange ()
 
virtual DisassemblySettingsRef getDisassemblySettings ()
 
virtual void setDisassemblySettings (DisassemblySettingsRef settings)
 
virtual HighlightTokenState getHighlightTokenState ()
 
virtual UIActionContext actionContext ()
 
Menu & contextMenu ()
 
UIActionHandler * actionHandler ()
 
QWidget * widget ()
 
QString viewType ()
 
void updateCrossReferenceSelection (ViewFrame *frame=nullptr)
 
void forceSyncFromView (ViewFrame *frame=nullptr)
 
virtual void refreshContents ()
 
virtual void clearRelatedHighlights ()
 
virtual void setRelatedIndexHighlights (FunctionRef func, const std::set< size_t > &related)
 
virtual void setRelatedInstructionHighlights (FunctionRef func, const std::set< uint64_t > &related)
 
void notifyContextMenuCreated ()
 

Additional Inherited Members

- Static Public Member Functions inherited from View
static View * getViewFromWidget (QWidget *widget)
 
static void registerActions ()
 
static void registerLateActions ()
 
- Protected Member Functions inherited from View
bool writeDataToClipboard (const BinaryNinja::DataBuffer &data, bool binary, TransformRef xform)
 
BinaryNinja::DataBuffer readDataFromClipboard (TransformRef xform)
 
- Protected Attributes inherited from View
Menu m_contextMenu
 
UIActionHandler m_actionHandler
 
bool m_binaryDataNavigable = false
 
QPointer< TransformParameterDialog > m_transformParamDialog
 
bool m_quiesceState = true
 
QTimer * m_updateTimer = nullptr
 

Constructor & Destructor Documentation

◆ MemoryMapView()

MemoryMapView::MemoryMapView ( BinaryViewRef data,
MemoryMapContainer * container )

◆ ~MemoryMapView()

virtual MemoryMapView::~MemoryMapView ( )
virtual

Member Function Documentation

◆ getData()

BinaryViewRef MemoryMapView::getData ( )
inlineoverridevirtual

Implements View.

◆ getCurrentOffset()

uint64_t MemoryMapView::getCurrentOffset ( )
overridevirtual

Implements View.

◆ getSelectionOffsets()

BNAddressRange MemoryMapView::getSelectionOffsets ( )
overridevirtual

Reimplemented from View.

◆ setSelectionOffsets()

void MemoryMapView::setSelectionOffsets ( BNAddressRange range)
overridevirtual

Implements View.

◆ navigate()

bool MemoryMapView::navigate ( uint64_t offset)
overridevirtual

Implements View.

◆ getFont()

QFont MemoryMapView::getFont ( )
inlineoverridevirtual

Implements View.

◆ setCurrentOffset()

void MemoryMapView::setCurrentOffset ( uint64_t offset)

◆ updateFonts()

void MemoryMapView::updateFonts ( )
overridevirtual

Reimplemented from View.

◆ MemoryMapContainer

class MemoryMapContainer

Public Member Functions

 MemoryMapContainer (BinaryViewRef data, MemoryMapSidebarWidget *parent)
 
virtual View * getView () override
 
MemoryMapView * getMemoryMapView ()
 
- Public Member Functions inherited from ViewContainer
virtual ~ViewContainer ()
 

Protected Member Functions

virtual void focusInEvent (QFocusEvent *event) override
 

Friends

class StringsView
 

Constructor & Destructor Documentation

◆ MemoryMapContainer()

MemoryMapContainer::MemoryMapContainer ( BinaryViewRef data,
MemoryMapSidebarWidget * parent )

Member Function Documentation

◆ getView()

virtual View * MemoryMapContainer::getView ( )
inlineoverridevirtual

Implements ViewContainer.

◆ getMemoryMapView()

MemoryMapView * MemoryMapContainer::getMemoryMapView ( )
inline

◆ focusInEvent()

virtual void MemoryMapContainer::focusInEvent ( QFocusEvent * event)
overrideprotectedvirtual

Friends And Related Symbol Documentation

◆ StringsView

friend class StringsView
friend

◆ MemoryMapViewType

class MemoryMapViewType

Public Member Functions

 MemoryMapViewType ()
 
virtual int getPriority (BinaryViewRef data, const QString &filename)
 
virtual QWidget * create (BinaryViewRef data, ViewFrame *viewFrame)
 
- Public Member Functions inherited from ViewType
 ViewType (const QString &name, const QString &longName)
 
virtual ~ViewType ()
 
const QString & getName ()
 
const QString & getLongName ()
 
virtual QString getDisplayName (BinaryViewTypeRef type)
 
virtual QString getDisplayLongName (BinaryViewTypeRef type)
 

Static Public Member Functions

static void init ()
 
- Static Public Member Functions inherited from ViewType
static ViewType * getTypeByName (const QString &name)
 
static const std::vector< ViewType * > & getTypes ()
 
static void registerViewType (ViewType *type)
 

Constructor & Destructor Documentation

◆ MemoryMapViewType()

MemoryMapViewType::MemoryMapViewType ( )

Member Function Documentation

◆ getPriority()

virtual int MemoryMapViewType::getPriority ( BinaryViewRef data,
const QString & filename )
virtual

Implements ViewType.

◆ create()

virtual QWidget * MemoryMapViewType::create ( BinaryViewRef data,
ViewFrame * viewFrame )
virtual

Implements ViewType.

◆ init()

static void MemoryMapViewType::init ( )
static

◆ MemoryMapSidebarWidget

class MemoryMapSidebarWidget

Public Member Functions

 MemoryMapSidebarWidget (BinaryViewRef data)
 
void focus () override
 
- Public Member Functions inherited from SidebarWidget
 SidebarWidget (const QString &title)
 
 ~SidebarWidget ()
 
const QString & title () const
 
void enableRefreshTimer (int interval)
 
void setRefreshQuiesce (bool enable)
 
bool isQuiesced () const
 
virtual void notifyRefresh ()
 
virtual void notifyQuiesce (bool)
 
virtual void notifyFontChanged ()
 
virtual void notifyOffsetChanged (uint64_t)
 
virtual void notifyThemeChanged ()
 
virtual void notifyViewChanged (ViewFrame *)
 
virtual void notifyViewLocationChanged (View *, const ViewLocation &)
 
virtual void closing ()
 
virtual void setPrimaryOrientation (Qt::Orientation)
 
virtual QWidget * headerWidget ()
 

Friends

class MemoryMapView
 

Additional Inherited Members

- Protected Attributes inherited from SidebarWidget
QString m_title
 
UIActionHandler m_actionHandler
 
ContextMenuManager * m_contextMenuManager = nullptr
 
Menu * m_menu = nullptr
 
bool m_quiesceState = true
 
QTimer * m_updateTimer = nullptr
 

Constructor & Destructor Documentation

◆ MemoryMapSidebarWidget()

MemoryMapSidebarWidget::MemoryMapSidebarWidget ( BinaryViewRef data)

Member Function Documentation

◆ focus()

void MemoryMapSidebarWidget::focus ( )
overridevirtual

Reimplemented from SidebarWidget.

Friends And Related Symbol Documentation

◆ MemoryMapView

friend class MemoryMapView
friend

◆ MemoryMapSidebarWidgetType

class MemoryMapSidebarWidgetType

Public Member Functions

 MemoryMapSidebarWidgetType ()
 
SidebarWidgetLocation defaultLocation () const override
 
SidebarContextSensitivity contextSensitivity () const override
 
SidebarWidget * createWidget (ViewFrame *frame, BinaryViewRef data) override
 
virtual bool canUseAsPane (SplitPaneWidget *, BinaryViewRef) const override
 
virtual Pane * createPane (SplitPaneWidget *panes, BinaryViewRef data) override
 
- Public Member Functions inherited from SidebarWidgetType
 SidebarWidgetType (const QImage &icon, const QString &name)
 
virtual ~SidebarWidgetType ()
 
const SidebarIcon & icon () const
 
const QString & name () const
 
virtual bool isInReferenceArea () const
 
virtual bool viewSensitive () const
 
virtual bool alwaysShowTabs () const
 
virtual bool hideIfNoContent () const
 
virtual SidebarWidget * createInvalidContextWidget ()
 
virtual QWidget * headerWidget (SplitPaneWidget *, ViewFrame *, BinaryViewRef)
 
virtual bool focusHeaderWidget () const
 
virtual QString noWidgetMessage () const
 
virtual DockableTabStyle * tabStyle () const
 
void updateTheme ()
 

Constructor & Destructor Documentation

◆ MemoryMapSidebarWidgetType()

MemoryMapSidebarWidgetType::MemoryMapSidebarWidgetType ( )

Member Function Documentation

◆ defaultLocation()

SidebarWidgetLocation MemoryMapSidebarWidgetType::defaultLocation ( ) const
inlineoverridevirtual

Reimplemented from SidebarWidgetType.

◆ contextSensitivity()

SidebarContextSensitivity MemoryMapSidebarWidgetType::contextSensitivity ( ) const
inlineoverridevirtual

Reimplemented from SidebarWidgetType.

◆ createWidget()

SidebarWidget * MemoryMapSidebarWidgetType::createWidget ( ViewFrame * frame,
BinaryViewRef data )
overridevirtual

Reimplemented from SidebarWidgetType.

◆ canUseAsPane()

virtual bool MemoryMapSidebarWidgetType::canUseAsPane ( SplitPaneWidget * ,
BinaryViewRef  ) const
inlineoverridevirtual

Reimplemented from SidebarWidgetType.

◆ createPane()

virtual Pane * MemoryMapSidebarWidgetType::createPane ( SplitPaneWidget * panes,
BinaryViewRef data )
overridevirtual

Reimplemented from SidebarWidgetType.