Classes | |
class | BinaryNinja::LogListener |
class | BinaryNinja::Logger |
Logger is a class allowing scoped logging to the console. More... | |
class | BinaryNinja::LogRegistry |
A class allowing registering and retrieving Loggers. More... | |
Functions | |
void | BinaryNinja::Log (BNLogLevel level, const char *fmt,...) |
Logs to the error console with the given BNLogLevel. More... | |
void | BinaryNinja::LogTrace (const char *fmt,...) |
LogTrace only writes text to the error console if the console is set to log level: DebugLog Log level and the build is not a DEBUG build (i.e. More... | |
void | BinaryNinja::LogDebug (const char *fmt,...) |
LogDebug only writes text to the error console if the console is set to log level: DebugLog Log level DebugLog is the most verbose logging level in release builds. More... | |
void | BinaryNinja::LogInfo (const char *fmt,...) |
LogInfo always writes text to the error console, and corresponds to the log level: InfoLog. More... | |
void | BinaryNinja::LogWarn (const char *fmt,...) |
LogWarn writes text to the error console including a warning icon, and also shows a warning icon in the bottom pane. More... | |
void | BinaryNinja::LogError (const char *fmt,...) |
LogError writes text to the error console and pops up the error console. More... | |
void | BinaryNinja::LogAlert (const char *fmt,...) |
LogAlert pops up a message box displaying the alert message and logs to the error console. More... | |
void | BinaryNinja::LogToStdout (BNLogLevel minimumLevel) |
Redirects the minimum level passed to standard out. More... | |
void | BinaryNinja::LogToStderr (BNLogLevel minimumLevel) |
Redirects the minimum level passed to standard error. More... | |
bool | BinaryNinja::LogToFile (BNLogLevel minimumLevel, const std::string &path, bool append=false) |
Redirects minimum log level to the file at `path`, optionally appending rather than overwriting. More... | |
void | BinaryNinja::CloseLogs () |
Close all log files. More... | |
class BinaryNinja::LogListener |
Public Member Functions | |
virtual | ~LogListener () |
virtual void | LogMessage (size_t session, BNLogLevel level, const std::string &msg, const std::string &logger_name="", size_t tid=0)=0 |
virtual void | CloseLog () |
virtual BNLogLevel | GetLogLevel () |
Static Public Member Functions | |
static void | RegisterLogListener (LogListener *listener) |
static void | UnregisterLogListener (LogListener *listener) |
static void | UpdateLogListeners () |
|
inlinevirtual |
|
static |
|
static |
|
static |
|
pure virtual |
Implemented in LogListModel.
|
inlinevirtual |
|
inlinevirtual |
Reimplemented in LogListModel.
class BinaryNinja::Logger |
Logger is a class allowing scoped logging to the console.
Public Member Functions | |
Logger (BNLogger *logger) | |
Logger (const std::string &loggerName, size_t sessionId=0) | |
Create a logger with the specified name and session ID. More... | |
void | Log (BNLogLevel level, const char *fmt,...) |
Logs to the error console with the given BNLogLevel. More... | |
void | LogTrace (const char *fmt,...) |
LogTrace only writes text to the error console if the console is set to log level: DebugLog Log level and the build is not a DEBUG build (i.e. More... | |
void | LogDebug (const char *fmt,...) |
LogDebug only writes text to the error console if the console is set to log level: DebugLog Log level DebugLog is the most verbose logging level in release builds. More... | |
void | LogInfo (const char *fmt,...) |
LogInfo always writes text to the error console, and corresponds to the log level: InfoLog. More... | |
void | LogWarn (const char *fmt,...) |
LogWarn writes text to the error console including a warning icon, and also shows a warning icon in the bottom pane. More... | |
void | LogError (const char *fmt,...) |
LogError writes text to the error console and pops up the error console. More... | |
void | LogAlert (const char *fmt,...) |
LogAlert pops up a message box displaying the alert message and logs to the error console. More... | |
std::string | GetName () |
Get the name registered for this Logger. More... | |
size_t | GetSessionId () |
Get the session ID registered for this logger. More... | |
![]() | |
CoreRefCountObject () | |
virtual | ~CoreRefCountObject () |
BNLogger * | GetObject () const |
void | AddRef () |
void | Release () |
void | AddRefForRegistration () |
void | ReleaseForRegistration () |
void | AddRefForCallback () |
void | ReleaseForCallback () |
Additional Inherited Members | |
![]() | |
static BNLogger * | GetObject (CoreRefCountObject *obj) |
static BNLogger * | GetObject (const CoreRefCountObject *obj) |
![]() | |
std::atomic< int > | m_refs |
bool | m_registeredRef |
BNLogger * | m_object |
Logger::Logger | ( | BNLogger * | logger | ) |
BinaryNinja::Logger::Logger | ( | const std::string & | loggerName, |
size_t | sessionId = 0 |
||
) |
Create a logger with the specified name and session ID.
Session ID corresponds to the tab for the specified BinaryView, and the default of 0 will log to *all tabs*.
loggerName | Name of the logger to create |
sessionId | Session ID for the logger. |
void Logger::Log | ( | BNLogLevel | level, |
const char * | fmt, | ||
... | |||
) |
Logs to the error console with the given BNLogLevel.
level | BNLogLevel debug log level |
fmt | C-style format string. |
... | Variable arguments corresponding to the format string. |
void Logger::LogTrace | ( | const char * | fmt, |
... | |||
) |
LogTrace only writes text to the error console if the console is set to log level: DebugLog Log level and the build is not a DEBUG build (i.e.
the preprocessor directive _DEBUG is defined)
fmt | C-style format string. |
... | Variable arguments corresponding to the format string. |
void Logger::LogDebug | ( | const char * | fmt, |
... | |||
) |
LogDebug only writes text to the error console if the console is set to log level: DebugLog Log level DebugLog is the most verbose logging level in release builds.
fmt | C-style format string. |
... | Variable arguments corresponding to the format string. |
void Logger::LogInfo | ( | const char * | fmt, |
... | |||
) |
LogInfo always writes text to the error console, and corresponds to the log level: InfoLog.
Log level InfoLog is the second most verbose logging level.
fmt | C-style format string. |
... | Variable arguments corresponding to the format string. |
void Logger::LogWarn | ( | const char * | fmt, |
... | |||
) |
LogWarn writes text to the error console including a warning icon, and also shows a warning icon in the bottom pane.
LogWarn corresponds to the log level: WarningLog.
fmt | C-style format string. |
... | Variable arguments corresponding to the format string. |
void Logger::LogError | ( | const char * | fmt, |
... | |||
) |
LogError writes text to the error console and pops up the error console.
Additionally, Errors in the console log include a error icon. LogError corresponds to the log level: ErrorLog.
fmt | C-style format string. |
... | Variable arguments corresponding to the format string. |
void Logger::LogAlert | ( | const char * | fmt, |
... | |||
) |
LogAlert pops up a message box displaying the alert message and logs to the error console.
LogAlert corresponds to the log level: AlertLog.
fmt | C-style format string. |
... | Variable arguments corresponding to the format string. |
string Logger::GetName | ( | ) |
size_t Logger::GetSessionId | ( | ) |
Get the session ID registered for this logger.
class BinaryNinja::LogRegistry |
A class allowing registering and retrieving Loggers.
Static Public Member Functions | |
static Ref< Logger > | CreateLogger (const std::string &loggerName, size_t sessionId=0) |
Create a logger with the specified name and session ID. More... | |
static Ref< Logger > | GetLogger (const std::string &loggerName, size_t sessionId=0) |
Get a logger with the specified name and session ID. More... | |
static std::vector< std::string > | GetLoggerNames () |
Get the list of registered Logger names. More... | |
|
static |
Create a logger with the specified name and session ID.
BinaryView::CreateLogger
instead of this.Session ID corresponds to the tab for the specified BinaryView, and the default of 0 will log to *all tabs*.
loggerName | Name of the logger to create |
sessionId | Session ID for the logger |
|
static |
Get a logger with the specified name and session ID.
Session ID corresponds to the tab for the specified BinaryView, and the default of 0 will log to *all tabs*.
loggerName | Name of the logger to create |
sessionId | Session ID for the logger |
|
static |
void BinaryNinja::Log | ( | BNLogLevel | level, |
const char * | fmt, | ||
... | |||
) |
Logs to the error console with the given BNLogLevel.
level | BNLogLevel debug log level |
fmt | C-style format string. |
... | Variable arguments corresponding to the format string. |
void BinaryNinja::LogTrace | ( | const char * | fmt, |
... | |||
) |
LogTrace only writes text to the error console if the console is set to log level: DebugLog Log level and the build is not a DEBUG build (i.e.
the preprocessor directive _DEBUG is defined)
fmt | C-style format string. |
... | Variable arguments corresponding to the format string. |
void BinaryNinja::LogDebug | ( | const char * | fmt, |
... | |||
) |
LogDebug only writes text to the error console if the console is set to log level: DebugLog Log level DebugLog is the most verbose logging level in release builds.
fmt | C-style format string. |
... | Variable arguments corresponding to the format string. |
void BinaryNinja::LogInfo | ( | const char * | fmt, |
... | |||
) |
LogInfo always writes text to the error console, and corresponds to the log level: InfoLog.
Log level InfoLog is the second most verbose logging level.
fmt | C-style format string. |
... | Variable arguments corresponding to the format string. |
void BinaryNinja::LogWarn | ( | const char * | fmt, |
... | |||
) |
LogWarn writes text to the error console including a warning icon, and also shows a warning icon in the bottom pane.
LogWarn corresponds to the log level: WarningLog.
fmt | C-style format string. |
... | Variable arguments corresponding to the format string. |
void BinaryNinja::LogError | ( | const char * | fmt, |
... | |||
) |
LogError writes text to the error console and pops up the error console.
Additionall, Errors in the console log include a error icon. LogError corresponds to the log level: ErrorLog.
fmt | C-style format string. |
... | Variable arguments corresponding to the format string. |
void BinaryNinja::LogAlert | ( | const char * | fmt, |
... | |||
) |
LogAlert pops up a message box displaying the alert message and logs to the error console.
LogAlert corresponds to the log level: AlertLog.
fmt | C-style format string. |
... | Variable arguments corresponding to the format string. |
void BinaryNinja::LogToStdout | ( | BNLogLevel | minimumLevel | ) |
Redirects the minimum level passed to standard out.
minimumLevel | minimum level to log to stdout |
void BinaryNinja::LogToStderr | ( | BNLogLevel | minimumLevel | ) |
Redirects the minimum level passed to standard error.
minimumLevel | minimum level to log to stderr |
bool BinaryNinja::LogToFile | ( | BNLogLevel | minimumLevel, |
const std::string & | path, | ||
bool | append = false |
||
) |
Redirects minimum log level to the file at `path`, optionally appending rather than overwriting.
minimumLevel | minimum level to log to stderr |
path | Path to log to |
append | Optional flag for specifying appending. True = append, False = overwrite. |
void BinaryNinja::CloseLogs | ( | ) |
Close all log files.