AudacityLogger Class Reference

AudacityLogger is a thread-safe logger class. More...

#include <AudacityLogger.h>

Inheritance diagram for AudacityLogger:

Collaboration diagram for AudacityLogger:

Public Types
using	Listener = std::function< bool() >
	Type of function called by Flush. More...

Public Member Functions
	~AudacityLogger () override
bool	SaveLog (const wxString &fileName) const
bool	ClearLog ()
wxString	GetLog (int count=0)
	Retrieve all or some of the lines since most recent ClearLog or start of program. More...
const wxString &	GetBuffer () const
	Get all the accumulated text since program start or last ClearLog() More...
void	Flush () override
Listener	SetListener (Listener listener)
	Set the unique listener, returning any previous one. More...

Static Public Member Functions
static AudacityLogger *	Get ()

Protected Member Functions
void	DoLogText (const wxString &msg) override

Private Member Functions
	AudacityLogger ()

Private Attributes
Listener	mListener
wxString	mBuffer
bool	mUpdated

Detailed Description

AudacityLogger is a thread-safe logger class.

Provides thread-safe logging based on the wxWidgets log facility.

Definition at line 20 of file AudacityLogger.h.

Member Typedef Documentation

Listener

using AudacityLogger::Listener = std::function< bool() >

Type of function called by Flush.

Returns

true if flush completed

Definition at line 45 of file AudacityLogger.h.

Constructor & Destructor Documentation

~AudacityLogger()

AudacityLogger::~AudacityLogger ( )

overridedefault

AudacityLogger()

AudacityLogger::AudacityLogger ( )

private

Definition at line 51 of file AudacityLogger.cpp.

:  wxEvtHandler(),
   wxLog()
{
   mUpdated = false;
}

References mUpdated.

Member Function Documentation

ClearLog()

bool AudacityLogger::ClearLog

(

)

Definition at line 111 of file AudacityLogger.cpp.

{
   mBuffer = wxEmptyString;
   DoLogText(wxT("Log Cleared."));
 
   return true;
}

References DoLogText(), mBuffer, and wxT().

Here is the call graph for this function:

DoLogText()

void AudacityLogger::DoLogText ( const wxString &  msg )

overrideprotected

Definition at line 73 of file AudacityLogger.cpp.

{
   if (!wxIsMainThread()) {
      wxMutexGuiEnter();
   }
 
   if (mBuffer.empty()) {
      wxString stamp;
 
      TimeStamp(&stamp);
 
      mBuffer << stamp << _TS("Audacity ") << AUDACITY_VERSION_STRING << wxT("\n");
   }
 
   mBuffer << str << wxT("\n");
 
   mUpdated = true;
 
   Flush();
 
   if (!wxIsMainThread()) {
      wxMutexGuiLeave();
   }
}

References _TS, Flush(), mBuffer, mUpdated, str, and wxT().

Referenced by ClearLog().

Here is the call graph for this function:

Here is the caller graph for this function:

Flush()

void AudacityLogger::Flush ( )

override

Definition at line 60 of file AudacityLogger.cpp.

{
   if (mUpdated && mListener && mListener())
      mUpdated = false;
}

References mListener, and mUpdated.

Referenced by DoLogText().

Here is the caller graph for this function:

Get()

AudacityLogger * AudacityLogger::Get ( )

static

Definition at line 35 of file AudacityLogger.cpp.

{
   static std::once_flag flag;
   std::call_once( flag, []{
      // wxWidgets will clean up the logger for the main thread, so we can say
      // safenew.  See:
      // http://docs.wxwidgets.org/3.0/classwx_log.html#a2525bf54fa3f31dc50e6e3cd8651e71d
      std::unique_ptr < wxLog > // DELETE any previous logger
         { wxLog::SetActiveTarget(safenew AudacityLogger) };
   } );
 
   // Use dynamic_cast so that we get a NULL ptr in case our logger
   // is no longer the target.
   return dynamic_cast<AudacityLogger *>(wxLog::GetActiveTarget());
}

References flag, and safenew.

Referenced by SaveLogCommand::Apply(), ClearLogCommand::Apply(), anonymous_namespace{LogWindow.cpp}::OnClear(), AudacityApp::OnInit0(), QuitAudacity(), DBConnection::SetDBError(), DBConnection::SetError(), and LogWindow::Show().

Here is the caller graph for this function:

GetBuffer()

const wxString & AudacityLogger::GetBuffer ( ) const

inline

Get all the accumulated text since program start or last ClearLog()

Definition at line 38 of file AudacityLogger.h.

{ return mBuffer; }

GetLog()

wxString AudacityLogger::GetLog

(

int

count = 0

)

Retrieve all or some of the lines since most recent ClearLog or start of program.

If count == 0 or is more than the number of lines, return all; else return the last count lines

Definition at line 119 of file AudacityLogger.cpp.

{
   if (count == 0)
   {
      return mBuffer;
   }
 
   wxString buffer;
 
   auto lines = wxStringTokenize(mBuffer, wxT("\r\n"), wxTOKEN_RET_DELIMS);
   for (int index = lines.size() - 1; index >= 0 && count > 0; --index, --count)
   {
      buffer.Prepend(lines[index]);
   }
 
   return buffer;
}

References mBuffer, and wxT().

Here is the call graph for this function:

SaveLog()

bool AudacityLogger::SaveLog

(

const wxString &

fileName

)

const

Definition at line 98 of file AudacityLogger.cpp.

{
   wxFFile file(fileName, wxT("w"));
 
   if (file.IsOpened()) {
      file.Write(mBuffer);
      file.Close();
      return true;
   }
 
   return false;
}

References mBuffer, and wxT().

Here is the call graph for this function:

SetListener()

auto AudacityLogger::SetListener

(

Listener

listener

)

Set the unique listener, returning any previous one.

Definition at line 66 of file AudacityLogger.cpp.

{
   auto result = std::move(mListener);
   mListener = std::move(listener);
   return result;
}

Member Data Documentation

mBuffer

wxString AudacityLogger::mBuffer

private

Definition at line 57 of file AudacityLogger.h.

Referenced by ClearLog(), DoLogText(), GetLog(), and SaveLog().

mListener

Listener AudacityLogger::mListener

private

Definition at line 56 of file AudacityLogger.h.

Referenced by Flush().

mUpdated

bool AudacityLogger::mUpdated

private

Definition at line 58 of file AudacityLogger.h.

Referenced by AudacityLogger(), DoLogText(), and Flush().

---

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

• AudacityLogger.h
• AudacityLogger.cpp