OpenCPN Partial API docs
Loading...
Searching...
No Matches
PlugBlacklist Class Reference
Inheritance diagram for PlugBlacklist:
AbstractBlacklist

Public Member Functions

virtual plug_data get_library_data (const std::string &library_file)
 Best effort attempt to get data for a library file. More...
 
plug_status get_status (const std::string &name, int major, int minor)
 Return status for given official plugin name and version. More...
 
plug_status get_status (const plug_data pd)
 Return status for given official plugin name and version. More...
 
virtual bool mark_unloadable (const std::string &name, int major, int minor)
 Given plugin name and version mark it as unloadable. More...
 
bool mark_unloadable (const std::string &path)
 Given a path, mark filename as unloadable. More...
 
bool is_loadable (const std::string path)
 Return true iff plugin (a path) is loadable. More...
 
std::string get_message (plug_status status, const plug_data &data)
 Return plugin-specific message, possibly "". More...
 
virtual plug_status get_status (const std::string &name, int _major, int _minor)=0
 Return status for given official plugin name and version. More...
 
virtual plug_status get_status (const plug_data pd)=0
 Return status for given official plugin name and version. More...
 
virtual plug_data get_library_data (const std::string &library_file)=0
 Best effort attempt to get data for a library file. More...
 
virtual bool mark_unloadable (const std::string &path)=0
 Given a path, mark filename as unloadable. More...
 
virtual bool mark_unloadable (const std::string &name, int major, int minor)=0
 Given plugin name and version mark it as unloadable. More...
 
virtual bool is_loadable (const std::string path)=0
 Return true iff plugin (a path) is loadable. More...
 
virtual std::string get_message (plug_status sts, const plug_data &data)=0
 Return plugin-specific message, possibly "". More...
 

Friends

std::unique_ptr< AbstractBlacklistblacklist_factory ()
 

Detailed Description

Definition at line 152 of file plugin_blacklist.cpp.

Member Function Documentation

◆ get_library_data()

virtual plug_data PlugBlacklist::get_library_data ( const std::string &  library_file)
inlinevirtual

Best effort attempt to get data for a library file.

Implements AbstractBlacklist.

Definition at line 204 of file plugin_blacklist.cpp.

◆ get_message()

std::string PlugBlacklist::get_message ( plug_status  sts,
const plug_data data 
)
inlinevirtual

Return plugin-specific message, possibly "".

Implements AbstractBlacklist.

Definition at line 247 of file plugin_blacklist.cpp.

◆ get_status() [1/2]

plug_status PlugBlacklist::get_status ( const plug_data  pd)
inlinevirtual

Return status for given official plugin name and version.

Implements AbstractBlacklist.

Definition at line 217 of file plugin_blacklist.cpp.

◆ get_status() [2/2]

plug_status PlugBlacklist::get_status ( const std::string &  name,
int  _major,
int  _minor 
)
inlinevirtual

Return status for given official plugin name and version.

Implements AbstractBlacklist.

Definition at line 211 of file plugin_blacklist.cpp.

◆ is_loadable()

bool PlugBlacklist::is_loadable ( const std::string  path)
inlinevirtual

Return true iff plugin (a path) is loadable.

Implements AbstractBlacklist.

Definition at line 235 of file plugin_blacklist.cpp.

◆ mark_unloadable() [1/2]

virtual bool PlugBlacklist::mark_unloadable ( const std::string &  name,
int  major,
int  minor 
)
inlinevirtual

Given plugin name and version mark it as unloadable.

Returns
true if plugin was already marked, else false.

Implements AbstractBlacklist.

Definition at line 221 of file plugin_blacklist.cpp.

◆ mark_unloadable() [2/2]

bool PlugBlacklist::mark_unloadable ( const std::string &  path)
inlinevirtual

Given a path, mark filename as unloadable.

Implements AbstractBlacklist.

Definition at line 227 of file plugin_blacklist.cpp.

Friends And Related Function Documentation

◆ blacklist_factory

std::unique_ptr< AbstractBlacklist > blacklist_factory ( )
friend

Definition at line 268 of file plugin_blacklist.cpp.


The documentation for this class was generated from the following file: