Classes
Plugin Manager
C++ Core API

Detailed Description

Classes

class  BinaryNinja::RepoPlugin
 
class  BinaryNinja::Repository
 
class  BinaryNinja::RepositoryManager
 

Class Documentation

◆ BinaryNinja::RepoPlugin

class BinaryNinja::RepoPlugin

Public Member Functions

 RepoPlugin (BNRepoPlugin *plugin)
 
PluginStatus GetPluginStatus () const
 
std::vector< std::string > GetApis () const
 
std::vector< std::string > GetInstallPlatforms () const
 
std::string GetPath () const
 
std::string GetSubdir () const
 
std::string GetDependencies () const
 
std::string GetPluginDirectory () const
 
std::string GetAuthor () const
 
std::string GetDescription () const
 
std::string GetLicense () const
 
std::string GetLicenseText () const
 
std::string GetLongdescription () const
 
std::string GetName () const
 
std::vector< PluginType > GetPluginTypes () const
 
std::string GetPackageUrl () const
 
std::string GetProjectUrl () const
 
std::string GetAuthorUrl () const
 
std::string GetVersion () const
 
std::string GetCommit () const
 
std::string GetRepository () const
 
std::string GetProjectData ()
 
std::string GetInstallInstructions (const std::string &platform) const
 
uint64_t GetMinimumVersion () const
 
uint64_t GetLastUpdate ()
 
bool IsBeingDeleted () const
 
bool IsBeingUpdated () const
 
bool IsInstalled () const
 
bool IsEnabled () const
 
bool IsRunning () const
 
bool IsUpdatePending () const
 
bool IsDisablePending () const
 
bool IsDeletePending () const
 
bool IsUpdateAvailable () const
 
bool AreDependenciesBeingInstalled () const
 
bool Uninstall ()
 
bool Install ()
 
bool InstallDependencies ()
 
bool Enable (bool force)
 
bool Disable ()
 
bool Update ()
 
- Public Member Functions inherited from BinaryNinja::CoreRefCountObject< BNRepoPlugin, BNNewPluginReference, BNFreePlugin >
 CoreRefCountObject ()
 
virtual ~CoreRefCountObject ()
 
BNRepoPlugin * GetObject () const
 
void AddRef ()
 
void Release ()
 
void AddRefForRegistration ()
 
void ReleaseForRegistration ()
 
void AddRefForCallback ()
 
void ReleaseForCallback ()
 

Additional Inherited Members

- Static Public Member Functions inherited from BinaryNinja::CoreRefCountObject< BNRepoPlugin, BNNewPluginReference, BNFreePlugin >
static BNRepoPlugin * GetObject (CoreRefCountObject *obj)
 
static BNRepoPlugin * GetObject (const CoreRefCountObject *obj)
 
- Public Attributes inherited from BinaryNinja::CoreRefCountObject< BNRepoPlugin, BNNewPluginReference, BNFreePlugin >
std::atomic< int > m_refs
 
bool m_registeredRef
 
BNRepoPlugin * m_object
 

Constructor & Destructor Documentation

◆ RepoPlugin()

RepoPlugin::RepoPlugin ( BNRepoPlugin *  plugin)

Member Function Documentation

◆ GetPluginStatus()

PluginStatus RepoPlugin::GetPluginStatus ( ) const

◆ GetApis()

vector< string > RepoPlugin::GetApis ( ) const

◆ GetInstallPlatforms()

vector< string > RepoPlugin::GetInstallPlatforms ( ) const

◆ GetPath()

string RepoPlugin::GetPath ( ) const

◆ GetSubdir()

string RepoPlugin::GetSubdir ( ) const

◆ GetDependencies()

string RepoPlugin::GetDependencies ( ) const

◆ GetPluginDirectory()

std::string BinaryNinja::RepoPlugin::GetPluginDirectory ( ) const

◆ GetAuthor()

string RepoPlugin::GetAuthor ( ) const

◆ GetDescription()

string RepoPlugin::GetDescription ( ) const

◆ GetLicense()

string RepoPlugin::GetLicense ( ) const

◆ GetLicenseText()

string RepoPlugin::GetLicenseText ( ) const

◆ GetLongdescription()

string RepoPlugin::GetLongdescription ( ) const

◆ GetName()

string RepoPlugin::GetName ( ) const

◆ GetPluginTypes()

vector< PluginType > RepoPlugin::GetPluginTypes ( ) const

◆ GetPackageUrl()

string RepoPlugin::GetPackageUrl ( ) const

◆ GetProjectUrl()

string RepoPlugin::GetProjectUrl ( ) const

◆ GetAuthorUrl()

string RepoPlugin::GetAuthorUrl ( ) const

◆ GetVersion()

string RepoPlugin::GetVersion ( ) const

◆ GetCommit()

string RepoPlugin::GetCommit ( ) const

◆ GetRepository()

string RepoPlugin::GetRepository ( ) const

◆ GetProjectData()

string RepoPlugin::GetProjectData ( )

◆ GetInstallInstructions()

std::string RepoPlugin::GetInstallInstructions ( const std::string &  platform) const

◆ GetMinimumVersion()

uint64_t RepoPlugin::GetMinimumVersion ( ) const

◆ GetLastUpdate()

uint64_t RepoPlugin::GetLastUpdate ( )

◆ IsBeingDeleted()

bool RepoPlugin::IsBeingDeleted ( ) const

◆ IsBeingUpdated()

bool RepoPlugin::IsBeingUpdated ( ) const

◆ IsInstalled()

bool RepoPlugin::IsInstalled ( ) const

◆ IsEnabled()

bool RepoPlugin::IsEnabled ( ) const

◆ IsRunning()

bool RepoPlugin::IsRunning ( ) const

◆ IsUpdatePending()

bool RepoPlugin::IsUpdatePending ( ) const

◆ IsDisablePending()

bool RepoPlugin::IsDisablePending ( ) const

◆ IsDeletePending()

bool RepoPlugin::IsDeletePending ( ) const

◆ IsUpdateAvailable()

bool RepoPlugin::IsUpdateAvailable ( ) const

◆ AreDependenciesBeingInstalled()

bool RepoPlugin::AreDependenciesBeingInstalled ( ) const

◆ Uninstall()

bool RepoPlugin::Uninstall ( )

◆ Install()

bool RepoPlugin::Install ( )

◆ InstallDependencies()

bool RepoPlugin::InstallDependencies ( )

◆ Enable()

bool RepoPlugin::Enable ( bool  force)

◆ Disable()

bool RepoPlugin::Disable ( )

◆ Update()

bool RepoPlugin::Update ( )

◆ BinaryNinja::Repository

class BinaryNinja::Repository

Public Member Functions

 Repository (BNRepository *repository)
 
std::string GetUrl () const
 
std::string GetRepoPath () const
 
std::string GetLocalReference () const
 
std::string GetRemoteReference () const
 
std::vector< Ref< RepoPlugin > > GetPlugins () const
 
std::string GetPluginDirectory () const
 
Ref< RepoPlugin > GetPluginByPath (const std::string &pluginPath)
 
std::string GetFullPath () const
 
- Public Member Functions inherited from BinaryNinja::CoreRefCountObject< BNRepository, BNNewRepositoryReference, BNFreeRepository >
 CoreRefCountObject ()
 
virtual ~CoreRefCountObject ()
 
BNRepository * GetObject () const
 
void AddRef ()
 
void Release ()
 
void AddRefForRegistration ()
 
void ReleaseForRegistration ()
 
void AddRefForCallback ()
 
void ReleaseForCallback ()
 

Additional Inherited Members

- Static Public Member Functions inherited from BinaryNinja::CoreRefCountObject< BNRepository, BNNewRepositoryReference, BNFreeRepository >
static BNRepository * GetObject (CoreRefCountObject *obj)
 
static BNRepository * GetObject (const CoreRefCountObject *obj)
 
- Public Attributes inherited from BinaryNinja::CoreRefCountObject< BNRepository, BNNewRepositoryReference, BNFreeRepository >
std::atomic< int > m_refs
 
bool m_registeredRef
 
BNRepository * m_object
 

Constructor & Destructor Documentation

◆ Repository()

Repository::Repository ( BNRepository *  repository)

Member Function Documentation

◆ GetUrl()

string Repository::GetUrl ( ) const

◆ GetRepoPath()

string Repository::GetRepoPath ( ) const

◆ GetLocalReference()

std::string BinaryNinja::Repository::GetLocalReference ( ) const

◆ GetRemoteReference()

std::string BinaryNinja::Repository::GetRemoteReference ( ) const

◆ GetPlugins()

vector< Ref< RepoPlugin > > Repository::GetPlugins ( ) const

◆ GetPluginDirectory()

std::string BinaryNinja::Repository::GetPluginDirectory ( ) const

◆ GetPluginByPath()

Ref< RepoPlugin > Repository::GetPluginByPath ( const std::string &  pluginPath)

◆ GetFullPath()

string Repository::GetFullPath ( ) const

◆ BinaryNinja::RepositoryManager

class BinaryNinja::RepositoryManager

Public Member Functions

 RepositoryManager (const std::string &enabledPluginsPath)
 
 RepositoryManager (BNRepositoryManager *repoManager)
 
 RepositoryManager ()
 
bool CheckForUpdates ()
 
std::vector< Ref< Repository > > GetRepositories ()
 
Ref< Repository > GetRepositoryByPath (const std::string &repoName)
 
bool AddRepository (const std::string &url, const std::string &repoPath)
 
Ref< Repository > GetDefaultRepository ()
 
- Public Member Functions inherited from BinaryNinja::CoreRefCountObject< BNRepositoryManager, BNNewRepositoryManagerReference, BNFreeRepositoryManager >
 CoreRefCountObject ()
 
virtual ~CoreRefCountObject ()
 
BNRepositoryManager * GetObject () const
 
void AddRef ()
 
void Release ()
 
void AddRefForRegistration ()
 
void ReleaseForRegistration ()
 
void AddRefForCallback ()
 
void ReleaseForCallback ()
 

Additional Inherited Members

- Static Public Member Functions inherited from BinaryNinja::CoreRefCountObject< BNRepositoryManager, BNNewRepositoryManagerReference, BNFreeRepositoryManager >
static BNRepositoryManager * GetObject (CoreRefCountObject *obj)
 
static BNRepositoryManager * GetObject (const CoreRefCountObject *obj)
 
- Public Attributes inherited from BinaryNinja::CoreRefCountObject< BNRepositoryManager, BNNewRepositoryManagerReference, BNFreeRepositoryManager >
std::atomic< int > m_refs
 
bool m_registeredRef
 
BNRepositoryManager * m_object
 

Constructor & Destructor Documentation

◆ RepositoryManager() [1/3]

BinaryNinja::RepositoryManager::RepositoryManager ( const std::string &  enabledPluginsPath)

◆ RepositoryManager() [2/3]

RepositoryManager::RepositoryManager ( BNRepositoryManager *  repoManager)

◆ RepositoryManager() [3/3]

RepositoryManager::RepositoryManager ( )

Member Function Documentation

◆ CheckForUpdates()

bool RepositoryManager::CheckForUpdates ( )

◆ GetRepositories()

vector< Ref< Repository > > RepositoryManager::GetRepositories ( )

◆ GetRepositoryByPath()

Ref< Repository > RepositoryManager::GetRepositoryByPath ( const std::string &  repoName)

◆ AddRepository()

bool RepositoryManager::AddRepository ( const std::string &  url,
const std::string &  repoPath 
)

◆ GetDefaultRepository()

Ref< Repository > RepositoryManager::GetDefaultRepository ( )