dolphin/Source/Core/DolphinWX/Src/LogWindow.cpp

// Copyright (C) 2003 Dolphin Project.

// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, version 2.0.

// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License 2.0 for more details.

// A copy of the GPL 2.0 should have been included with the program.
// If not, see http://www.gnu.org/licenses/

// Official SVN repository and contact information can be found at
// http://code.google.com/p/dolphin-emu/

#include "LogWindow.h"
#include "ConsoleListener.h"
#include "Console.h"
#include "IniFile.h"
#include "FileUtil.h"
#include "DebuggerUIUtil.h"
#include <wx/fontmap.h>

// Milliseconds between msgQueue flushes to wxTextCtrl
#define UPDATETIME 200

BEGIN_EVENT_TABLE(CLogWindow, wxPanel)
	EVT_CLOSE(CLogWindow::OnClose)
	EVT_TEXT_ENTER(IDM_SUBMITCMD, CLogWindow::OnSubmit)
	EVT_BUTTON(IDM_CLEARLOG, CLogWindow::OnClear)
	EVT_BUTTON(IDM_TOGGLEALL, CLogWindow::OnToggleAll)
	EVT_RADIOBOX(IDM_VERBOSITY, CLogWindow::OnOptionsCheck)
	EVT_CHOICE(IDM_FONT, CLogWindow::OnOptionsCheck)
	EVT_CHECKBOX(IDM_WRAPLINE, CLogWindow::OnOptionsCheck)
	EVT_CHECKBOX(IDM_WRITEFILE, CLogWindow::OnOptionsCheck)
	EVT_CHECKBOX(IDM_WRITECONSOLE, CLogWindow::OnOptionsCheck)
	EVT_CHECKBOX(IDM_WRITEWINDOW, CLogWindow::OnOptionsCheck)
	EVT_CHECKLISTBOX(IDM_LOGCHECKS, CLogWindow::OnLogCheck)
	EVT_TIMER(IDTM_UPDATELOG, CLogWindow::OnLogTimer)
	EVT_SIZE(CLogWindow::OnSize)
END_EVENT_TABLE()

CLogWindow::CLogWindow(CFrame *parent, wxWindowID id, const wxPoint& pos,
	   	const wxSize& size, long style, const wxString& name)
	: wxPanel(parent, id, pos, size, style, name)
	, x(0), y(0), winpos(0)
	, Parent(parent) , m_LogAccess(true)
	, m_Log(NULL), m_cmdline(NULL), m_FontChoice(NULL)
	, m_LogSection(1)
{
#ifdef _WIN32
	m_SJISConv = new wxCSConv(wxFontMapper::GetEncodingName(wxFONTENCODING_SHIFT_JIS));
#else
	m_SJISConv = new wxCSConv(wxFontMapper::GetEncodingName(wxFONTENCODING_EUC_JP));
#endif

	m_LogManager = LogManager::GetInstance();
	for (int i = 0; i < LogTypes::NUMBER_OF_LOGS; ++i)
		m_LogManager->addListener((LogTypes::LOG_TYPE)i, this);
	m_fileLog = m_LogManager->getFileListener();
	m_console = m_LogManager->getConsoleListener();

	CreateGUIControls();

	LoadSettings();

	m_LogTimer = new wxTimer(this, IDTM_UPDATELOG);
	m_LogTimer->Start(UPDATETIME);
}

void CLogWindow::CreateGUIControls()
{
	// Verbosity
	wxArrayString wxLevels, wxLevelsUse;
	wxLevels.Add(_("Notice"));
	wxLevels.Add(_("Error"));
	wxLevels.Add(_("Warning"));
	wxLevels.Add(_("Info"));
	wxLevels.Add(_("Debug"));
	for (int i = 0; i < MAX_LOGLEVEL; ++i)
	   	wxLevelsUse.Add(wxString::Format(wxT("%s"), wxLevels.Item(i).c_str()));
	m_verbosity = new wxRadioBox(this, IDM_VERBOSITY, _("Verbosity"),
		   	wxDefaultPosition, wxDefaultSize, wxLevelsUse, 0,
		   	wxRA_SPECIFY_ROWS, wxDefaultValidator);
	// Don't take up so much space
	m_verbosity->SetFont(wxFont(7, wxFONTFAMILY_DEFAULT, wxFONTSTYLE_NORMAL, wxFONTWEIGHT_NORMAL));

	// Font
	m_FontChoice = new wxChoice(this, IDM_FONT,
		   	wxDefaultPosition, wxDefaultSize, 0, NULL, 0, wxDefaultValidator);

	m_FontChoice->Append(_("Default font"));
	m_FontChoice->Append(_("Monospaced font"));
	m_FontChoice->Append(_("Selected font"));
	m_FontChoice->SetSelection(0);
	DefaultFont = GetFont();
	MonoSpaceFont.SetNativeFontInfoUserDesc(_T("lucida console windows-1252"));
	LogFont.push_back(DefaultFont);
	LogFont.push_back(MonoSpaceFont);
	LogFont.push_back(DebuggerFont);

	// Options
	wxCheckBox * m_WrapLine = new wxCheckBox(this, IDM_WRAPLINE, _("Word Wrap"));
	m_writeFileCB = new wxCheckBox(this, IDM_WRITEFILE,
		   	_("Write to File"), wxDefaultPosition, wxDefaultSize, 0);
	m_writeConsoleCB = new wxCheckBox(this, IDM_WRITECONSOLE,
		   	_("Write to Console"), wxDefaultPosition, wxDefaultSize, 0);
	m_writeWindowCB = new wxCheckBox(this, IDM_WRITEWINDOW,
		   	_("Write to Window ->"), wxDefaultPosition, wxDefaultSize, 0);

	m_checks = new wxCheckListBox(this, IDM_LOGCHECKS, wxDefaultPosition, wxDefaultSize);

	// Log viewer and submit row
	m_Log = CreateTextCtrl(this, IDM_LOG, wxTE_RICH | wxTE_MULTILINE | wxTE_READONLY | wxTE_DONTWRAP);
	m_cmdline = new wxTextCtrl(this, IDM_SUBMITCMD, wxEmptyString, wxDefaultPosition, wxDefaultSize,
		wxTE_PROCESS_ENTER | wxTE_PROCESS_TAB);

	// Sizers
	sUber = new wxBoxSizer(wxHORIZONTAL);			// whole plane
	sLeft = new wxBoxSizer(wxVERTICAL);				// left sizer
	sRight = new wxBoxSizer(wxVERTICAL);			// right sizer
	sRightBottom = new wxBoxSizer(wxHORIZONTAL);	// submit row
	// Left side: buttons (-submit), options, and log type selection
	wxStaticBoxSizer* sbLeftOptions = new wxStaticBoxSizer(wxVERTICAL, this, _("Options"));

	wxBoxSizer* sLogCtrl = new wxBoxSizer(wxHORIZONTAL);
	sLogCtrl->Add(new wxButton(this, IDM_TOGGLEALL, _("Toggle all"),
			   	wxDefaultPosition, wxDefaultSize, wxBU_EXACTFIT), 1);
	sLogCtrl->Add(new wxButton(this, IDM_CLEARLOG, _("Clear"),
			   	wxDefaultPosition, wxDefaultSize, wxBU_EXACTFIT), 1);

	sbLeftOptions->Add(m_FontChoice, 0, (wxDOWN), 1);
	sbLeftOptions->Add(m_WrapLine, 0, (wxDOWN), 1);
	sbLeftOptions->Add(m_writeFileCB, 0, (wxDOWN), 1);
	sbLeftOptions->Add(m_writeConsoleCB, 0, (wxDOWN), 1);
	sbLeftOptions->Add(m_writeWindowCB, 0);

	sLeft->Add(m_verbosity, 0, wxEXPAND | (wxLEFT | wxRIGHT), 5);
	sLeft->Add(sbLeftOptions, 0, wxEXPAND | (wxLEFT | wxRIGHT), 5);
	sLeft->Add(sLogCtrl, 0, wxEXPAND);
	sLeft->Add(m_checks, 1, wxEXPAND);

	PopulateRight();

	sUber->Add(sLeft, 0, wxEXPAND);
	sUber->Add(sRight, 1, wxEXPAND);
	this->SetSizer(sUber);

	m_cmdline->SetFocus();
}

CLogWindow::~CLogWindow()
{
	for (int i = 0; i < LogTypes::NUMBER_OF_LOGS; ++i)
	{
		m_LogManager->removeListener((LogTypes::LOG_TYPE)i, this);
	}
	m_LogTimer->Stop();
	delete m_LogTimer;
	delete m_SJISConv;
}

void CLogWindow::OnClose(wxCloseEvent& event)
{
	SaveSettings();
	event.Skip();
}

void CLogWindow::OnSize(wxSizeEvent& event)
{
	if (!Parent->g_pCodeWindow &&
		   	Parent->m_Mgr->GetPane(wxT("Pane 1")).IsShown())
	{
		x = Parent->m_Mgr->GetPane(wxT("Pane 1")).rect.GetWidth();
		y = Parent->m_Mgr->GetPane(wxT("Pane 1")).rect.GetHeight();
		winpos = Parent->m_Mgr->GetPane(wxT("Pane 1")).dock_direction;
	}
	event.Skip();
}

void CLogWindow::SaveSettings()
{
	IniFile ini;
	ini.Load(File::GetUserPath(F_LOGGERCONFIG_IDX));

	if (!Parent->g_pCodeWindow)
	{
		ini.Set("LogWindow", "x", x);
		ini.Set("LogWindow", "y", y);
		ini.Set("LogWindow", "pos", winpos);
	}
	ini.Set("Options", "Verbosity", m_verbosity->GetSelection() + 1);
	ini.Set("Options", "Font", m_FontChoice->GetSelection());
	ini.Set("Options", "WriteToFile", m_writeFile);
	ini.Set("Options", "WriteToConsole", m_writeConsole);
	ini.Set("Options", "WriteToWindow", m_writeWindow);
	for (int i = 0; i < LogTypes::NUMBER_OF_LOGS; ++i)
		ini.Set("Logs", m_LogManager->getShortName((LogTypes::LOG_TYPE)i), m_checks->IsChecked(i));
	ini.Save(File::GetUserPath(F_LOGGERCONFIG_IDX));
}

void CLogWindow::LoadSettings()
{
	IniFile ini;
	ini.Load(File::GetUserPath(F_LOGGERCONFIG_IDX));

	ini.Get("LogWindow", "x", &x, Parent->GetSize().GetX() / 2);
	ini.Get("LogWindow", "y", &y, Parent->GetSize().GetY());
	ini.Get("LogWindow", "pos", &winpos, wxAUI_DOCK_RIGHT);

	int verbosity,font;
	ini.Get("Options", "Verbosity", &verbosity, 0);
	if (verbosity < 1) verbosity = 1;
	if (verbosity > MAX_LOGLEVEL) verbosity = MAX_LOGLEVEL;
	m_verbosity->SetSelection(verbosity - 1);
	ini.Get("Options", "Font", &font, 0);
	m_FontChoice->SetSelection(font);
	if (m_FontChoice->GetSelection() < (int)LogFont.size())
		m_Log->SetDefaultStyle(wxTextAttr(wxNullColour, wxNullColour, LogFont[m_FontChoice->GetSelection()]));
	ini.Get("Options", "WriteToFile", &m_writeFile, false);
	m_writeFileCB->SetValue(m_writeFile);
	ini.Get("Options", "WriteToConsole", &m_writeConsole, true);
	m_writeConsoleCB->SetValue(m_writeConsole);
	ini.Get("Options", "WriteToWindow", &m_writeWindow, true);
	m_writeWindowCB->SetValue(m_writeWindow);
	for (int i = 0; i < LogTypes::NUMBER_OF_LOGS; ++i)
	{
		bool enable;
		ini.Get("Logs", m_LogManager->getShortName((LogTypes::LOG_TYPE)i), &enable, true);

		if (m_writeWindow && enable)
			m_LogManager->addListener((LogTypes::LOG_TYPE)i, this);
		else
			m_LogManager->removeListener((LogTypes::LOG_TYPE)i, this);

		if (m_writeFile && enable)
			m_LogManager->addListener((LogTypes::LOG_TYPE)i, m_fileLog);
		else
			m_LogManager->removeListener((LogTypes::LOG_TYPE)i, m_fileLog);

		if (m_writeConsole && enable)
			m_LogManager->addListener((LogTypes::LOG_TYPE)i, m_console);
		else
			m_LogManager->removeListener((LogTypes::LOG_TYPE)i, m_console);
		m_LogManager->setLogLevel((LogTypes::LOG_TYPE)i, (LogTypes::LOG_LEVELS)(verbosity));
	}
	UpdateChecks();
}

void CLogWindow::OnSubmit(wxCommandEvent& WXUNUSED (event))
{
	if (!m_cmdline) return;
	Console_Submit(m_cmdline->GetValue().To8BitData());
	m_cmdline->SetValue(wxEmptyString);
}

void CLogWindow::OnClear(wxCommandEvent& WXUNUSED (event))
{
	m_Log->Clear();

	m_LogSection.Enter();
	int msgQueueSize = (int)msgQueue.size();
	for (int i = 0; i < msgQueueSize; i++)
		msgQueue.pop();
	m_LogSection.Leave();

	m_console->ClearScreen();
}

// Enable or disable all boxes for the current verbosity level and save the changes.
void CLogWindow::OnToggleAll(wxCommandEvent& WXUNUSED (event))
{
	static bool enableAll = false;
	for (int i = 0; i < LogTypes::NUMBER_OF_LOGS; ++i)
	{
		ToggleLog(i, enableAll);
	}

	SaveSettings();
	enableAll = !enableAll;
}

// Append checkboxes and update checked groups.
void CLogWindow::UpdateChecks()
{
	// This is only run once to append checkboxes to the wxCheckListBox.
	if (m_checks->GetCount() == 0)
	{
		// [F|RES] hide the window while we fill it... wxwidgets gets trouble
		// if you don't do it (at least the win version)
		m_checks->Freeze();

		for (int i = 0; i < LogTypes::NUMBER_OF_LOGS; i++)
		{
			m_checks->Append(wxString::FromAscii(m_LogManager->getFullName( (LogTypes::LOG_TYPE)i )));
		}
		m_checks->Thaw();
	}

	m_checks->Freeze();
	for (int i = 0; i < LogTypes::NUMBER_OF_LOGS; i++)
	{
		m_checks->Check(i,
			m_LogManager->isListener((LogTypes::LOG_TYPE)i, this) ||
			m_LogManager->isListener((LogTypes::LOG_TYPE)i, m_console) ||
			m_LogManager->isListener((LogTypes::LOG_TYPE)i, m_fileLog));
	}
	m_checks->Thaw();
}

void CLogWindow::UnPopulateRight()
{
	sRight->Detach(m_Log);
	sRight->Detach(sRightBottom);
	sRightBottom = new wxBoxSizer(wxHORIZONTAL);
}
void CLogWindow::PopulateRight()
{
	sRightBottom->Add(m_cmdline, 1, wxEXPAND);
	sRight->Add(m_Log, 1, wxEXPAND | wxSHRINK);
	sRight->Add(sRightBottom, 0, wxEXPAND);
	this->Layout();
}

wxTextCtrl* CLogWindow::CreateTextCtrl(wxPanel* parent, wxWindowID id, long Style)
{
	wxTextCtrl* TC = new wxTextCtrl(parent, id, wxEmptyString, wxDefaultPosition, wxDefaultSize, Style);
#ifdef __APPLE__
	TC->SetBackgroundColour(*wxLIGHT_GREY);
#else
	TC->SetBackgroundColour(*wxBLACK);
#endif
	if (m_FontChoice)
	{
		if (m_FontChoice->GetSelection() < (int)LogFont.size())
			TC->SetDefaultStyle(wxTextAttr(wxNullColour, wxNullColour, LogFont[m_FontChoice->GetSelection()]));
	}
	return TC;
}

// When an option is changed, save the change
void CLogWindow::OnOptionsCheck(wxCommandEvent& event)
{
	wxString Text;

	switch (event.GetId())
	{
	case IDM_VERBOSITY:
		{
			// get selection
			int v = m_verbosity->GetSelection() + 1;
			for (int i = 0; i < LogTypes::NUMBER_OF_LOGS; i++)
			{
				m_LogManager->setLogLevel((LogTypes::LOG_TYPE)i, (LogTypes::LOG_LEVELS)v);
			}
		}
		break;

	case IDM_WRAPLINE:
#ifdef __WXGTK__
		m_Log->SetWindowStyleFlag(m_Log->GetWindowStyleFlag() ^ (wxTE_WORDWRAP | wxTE_DONTWRAP));
#else
		// Unfortunately wrapping styles can only be changed dynamically with wxGTK
		// Notice:	To retain the colors when changing word wrapping we need to
		//			loop through every letter with GetStyle and then reapply them letter by letter
		// Prevent m_Log access while it's being destroyed
		m_LogAccess = false;
		UnPopulateRight();
		Text = m_Log->GetValue();
		m_Log->Destroy();
		if (event.IsChecked())
			m_Log = CreateTextCtrl(this, IDM_LOG,
					wxTE_RICH | wxTE_MULTILINE | wxTE_READONLY | wxTE_WORDWRAP);
		else
			m_Log = CreateTextCtrl(this, IDM_LOG,
					wxTE_RICH | wxTE_MULTILINE | wxTE_READONLY | wxTE_DONTWRAP);
		m_Log->SetDefaultStyle(wxTextAttr(*wxWHITE));
		m_Log->AppendText(Text);
		PopulateRight();
		m_LogAccess = true;
#endif
		break;

	case IDM_FONT:
		// Update selected font
		LogFont[LogFont.size()-1] = DebuggerFont;
		m_Log->SetStyle(0, m_Log->GetLastPosition(),
			   	wxTextAttr(wxNullColour, wxNullColour, LogFont[event.GetSelection()]));
		m_Log->SetDefaultStyle(wxTextAttr(wxNullColour, wxNullColour, LogFont[event.GetSelection()]));
		break;

	case IDM_WRITEFILE:
		for (int i = 0; i < LogTypes::NUMBER_OF_LOGS; ++i)
		{
			m_writeFile = event.IsChecked();
			if (m_checks->IsChecked(i))
			{
				if (m_writeFile)
					m_LogManager->addListener((LogTypes::LOG_TYPE)i, m_fileLog);
				else
					m_LogManager->removeListener((LogTypes::LOG_TYPE)i, m_fileLog);
			}
		}
		break;

	case IDM_WRITEWINDOW:
		for (int i = 0; i < LogTypes::NUMBER_OF_LOGS; ++i)
		{
			m_writeWindow = event.IsChecked();
			if (m_checks->IsChecked(i))
			{
				if (m_writeWindow)
					m_LogManager->addListener((LogTypes::LOG_TYPE)i, this);
				else
					m_LogManager->removeListener((LogTypes::LOG_TYPE)i, this);
			}
		}
		break;

	case IDM_WRITECONSOLE:
		for (int i = 0; i < LogTypes::NUMBER_OF_LOGS; ++i)
		{
			m_writeConsole = event.IsChecked();
			if (m_checks->IsChecked(i))
			{
				if (m_writeConsole)
					m_LogManager->addListener((LogTypes::LOG_TYPE)i, m_console);
				else
					m_LogManager->removeListener((LogTypes::LOG_TYPE)i, m_console);
			}
		}
		break;
	}
	SaveSettings();
}

// When a checkbox is changed
void CLogWindow::OnLogCheck(wxCommandEvent& event)
{
	int i = event.GetInt();
	ToggleLog(i, m_checks->IsChecked(i));

	SaveSettings();
}

void CLogWindow::ToggleLog(int _logType, bool enable)
{
	LogTypes::LOG_TYPE logType = (LogTypes::LOG_TYPE)_logType;

	m_checks->Check(_logType, enable);

	m_LogManager->setEnable(logType, enable);

	if (enable)
	{
		if (m_writeWindow)
			m_LogManager->addListener(logType, this);
		if (m_writeFile)
			m_LogManager->addListener(logType, m_fileLog);
		if (m_writeConsole)
			m_LogManager->addListener(logType, m_console);
	}
	else
	{
		m_LogManager->removeListener(logType, this);
		m_LogManager->removeListener(logType, m_fileLog);
		m_LogManager->removeListener(logType, m_console);
	}
}

void CLogWindow::OnLogTimer(wxTimerEvent& WXUNUSED(event))
{
	if (!m_LogAccess) return;

	UpdateLog();
	// Scroll to the last line
	if (msgQueue.size() > 0)
	{
		m_Log->ScrollLines(1);
		m_Log->ShowPosition( m_Log->GetLastPosition() );
	}
}

void CLogWindow::UpdateLog()
{
	if (!m_LogAccess) return;
	if (!m_Log) return;

	m_LogTimer->Stop();

	m_LogSection.Enter();
	int msgQueueSize = (int)msgQueue.size();
	for (int i = 0; i < msgQueueSize; i++)
	{
		switch (msgQueue.front().first)
		{
			
			case ERROR_LEVEL:
				m_Log->SetDefaultStyle(wxTextAttr(*wxRED));
				break;
				
			case WARNING_LEVEL:
				m_Log->SetDefaultStyle(wxTextAttr(wxColour(255, 255, 0))); // YELLOW
				break;
				
			case NOTICE_LEVEL:
				m_Log->SetDefaultStyle(wxTextAttr(*wxGREEN));
				break;
				
			case INFO_LEVEL:
				m_Log->SetDefaultStyle(wxTextAttr(*wxCYAN));
				break;
				
			case DEBUG_LEVEL:
				m_Log->SetDefaultStyle(wxTextAttr(*wxLIGHT_GREY));
				break;
				
			default:
				m_Log->SetDefaultStyle(wxTextAttr(*wxWHITE));
				break;
		}
		if (msgQueue.front().second.size())
		{
			int j = m_Log->GetLastPosition();
			m_Log->AppendText(msgQueue.front().second);
			// White timestamp
			m_Log->SetStyle(j, j + 9, wxTextAttr(*wxWHITE));
		}
		msgQueue.pop();
	}
	m_LogSection.Leave();

	m_LogTimer->Start(UPDATETIME);
}

void CLogWindow::Log(LogTypes::LOG_LEVELS level, const char *text)
{
	m_LogSection.Enter();
	if (msgQueue.size() >= 100)
		msgQueue.pop();
	msgQueue.push(std::pair<u8, wxString>((u8)level, wxString(text, *m_SJISConv)));
	m_LogSection.Leave();
}