Log Class Reference

#include <Log.h>

List of all members.

Public Member Functions
	Log (bool logToFile)
	~Log ()
void	Message (std::string msg)
void	Message (const char *msg,...)
void	DebugMessage (std::string msg)
void	DebugMessage (const char *msg,...)
void	SetDebugMode (bool debugMode)
Static Public Member Functions
static bool	OpenLog (bool logToFile)
static void	CloseLog ()
Static Public Attributes
static Log *	s_log = NULL
Private Attributes
bool	m_debugMode
std::ofstream	m_logFile

---

Detailed Description

Definition at line 11 of file Log.h.

---

Constructor & Destructor Documentation

Log::Log

(

bool

logToFile

)

Definition at line 16 of file Log.cpp.

References m_debugMode, and m_logFile.

Referenced by OpenLog().

                       {
  time_t timestamp;

  m_debugMode = false;

  if (logToFile) {
    m_logFile.open("CrownCutlass.log", ios::out);
    if (!m_logFile) {
      // Can't open log file
      cerr << "Warning: Cannot open error.log for write, continuing without logging\n";
    } else {
      // Log file is open fine, give opening timestamp
      timestamp = time(NULL);
      m_logFile << "Log Started: " << ctime(&timestamp) << endl;
    }
  }
}

Log::~Log

(

)

Definition at line 34 of file Log.cpp.

References m_logFile.

          {
  time_t timestamp;

  // Only need to close logFile if it's open
  if (m_logFile) {
    // Give closing timestamp
    timestamp = time(NULL);
    m_logFile << endl << "Log Closed: " << ctime(&timestamp) << endl;

    // Close log file
    m_logFile.close();
  }
}

---

Member Function Documentation

void Log::CloseLog

(

)

[static]

Definition at line 146 of file Log.cpp.

References s_log.

Referenced by prepExit().

                   {
  if (s_log == NULL) {
    cerr << "Warning: Call to closeLog with NULL s_log pointer" << endl;
    return;
  }

  delete s_log;
  s_log = NULL;
}

void Log::DebugMessage	(	const char *	msg,
			...
	)

Definition at line 90 of file Log.cpp.

References m_debugMode, and m_logFile.

                                           {
  /* WHY DOESN'T THIS WORK???
  va_list vargList; // This is to handle the variable arguments ...

  va_start(vargList, msg);
  if (debugMode) {
    message(msg, vargList);
  }
  va_end(vargList);
  */

  // Remove this once I figure out how to pass the variable args to the regular message
  va_list vargList; // This is to handle the variable arguments ...
  char outBuf[1024];
  unsigned short outLen;

  if (m_debugMode) {
    // This section takes the arguments and puts them into
    // the character array.
    va_start(vargList, msg);
#if defined (WIN32)
    outLen = _vsnprintf(outBuf, sizeof(outBuf), msg, vargList);
#else
    outLen = vsnprintf(outBuf, sizeof(outBuf), msg, vargList);
#endif
    //outLen = vsprintf(outBuf, msg, vargList);
    va_end(vargList);

    if (outLen >= sizeof(outBuf)) {
      // vsnprintf had to truncate the data, set outLen to correct value
      outLen = sizeof(outBuf);
    }

    if (m_logFile) {
      m_logFile << outBuf << endl;
    }

    cerr << outBuf << endl;
  }
}

void Log::DebugMessage

(

std::string

msg

)

Definition at line 84 of file Log.cpp.

References m_debugMode, and Message().

Referenced by CCListModel::AddItem(), Product::AddProductionPoints(), CityEconomy::AllocateProductionPoints(), CCListBox::CCListBox(), CCListModel::CCListModel(), EconomyScreen::EconomyScreen(), Product::GetPrice(), SoundSystem::LogDebugInfo(), CCListModel::RemoveItem(), SoundSystem::SoundSystem(), CCListModel::~CCListModel(), and SoundSystem::~SoundSystem().

                                    {
  if (m_debugMode) {
    Message(msg);
  }
}

void Log::Message	(	const char *	msg,
			...
	)

Definition at line 56 of file Log.cpp.

References m_logFile.

                                      {
  va_list vargList; // This is to handle the variable arguments ...
  char outBuf[1024];
  unsigned short outLen;

  // This section takes the arguments and puts them into
  // the character array.
  va_start(vargList, msg);
#if defined (WIN32)
  outLen = _vsnprintf(outBuf, sizeof(outBuf), msg, vargList);
#else
  outLen = vsnprintf(outBuf, sizeof(outBuf), msg, vargList);
#endif
  //outLen = vsprintf(outBuf, msg, vargList);
  va_end(vargList);

  if (outLen >= sizeof(outBuf)) {
    // vsnprintf had to truncate the data, set outLen to correct value
    outLen = sizeof(outBuf);
  }

  if (m_logFile) {
    m_logFile << outBuf << endl;
  }

  cerr << outBuf << endl;
}

void Log::Message

(

std::string

msg

)

Definition at line 48 of file Log.cpp.

References m_logFile.

Referenced by ResourceManager::AcquireRandom(), Ship::AcquireResource(), Cargo::AddCargo(), BuildTexture(), StateCity::Buy(), StateDone::Buy(), Economy::BuyProduct(), Terrain::CalcHeight(), ShipResource::CalcMassMomentInertia(), Config::CheckExtensions(), CityManager::CityManager(), Config::CloseConfig(), Config::Config(), Economy::CreateEconomy(), CCGui::CreateGui(), DebugMessage(), CityEconomy::DecreaseSize(), Economy::DestroyEconomy(), CCGui::DestroyGui(), SkyDome::Draw(), Ship::Dump(), Point::Dump(), Player::Dump(), Cargo::Dump(), BuildingList::Dump(), Building::Dump(), Battle::EnemyHit(), TCallback< StateNewGame >::Execute(), Cargo::FillRandom(), FontResource::FontResource(), CCListModel::getElementAt(), CityEconomy::IncreaseSize(), init(), Timer::Initialize(), StateSailing::Initialize(), SoundSystem::Initialize(), ResourceManager::Initialize(), SoundEffect::InitializeSource(), StateCity::InitMenu(), TextureResource::Load(), SoundResource::Load(), ShipResource::Load(), FontResource::Load(), Cargo::Load(), CityManager::LoadCityConfig(), ResourceManager::LoadXMLFile(), Config::LogConfig(), ResourceManager::LogDebugInfo(), IGameState::Loop(), main(), MainMenu::MainMenu(), Model::objFirstPass(), Model::objLoad(), Model::objSecondPass(), Config::OpenConfig(), OpenLog(), CityManager::ParseClusters(), SoundEffect::Play(), Battle::PlayerHit(), IGameState::PrepareStateSwitch(), prepExit(), Product::Product(), Ship::ReleaseResource(), ResourceManager::ResourceManager(), ISound::RevokeSource(), StateDone::SackPlayer(), StateCity::Sell(), StateDone::Sell(), Economy::SellProduct(), IGameState::SetCurrentPtr(), IGameState::SetMainMenu(), StateDone::SetMenuQtys(), StateDone::SetupMenu(), ShipResource::ShipResource(), Timer::Shutdown(), SoundSystem::Shutdown(), ResourceManager::Shutdown(), Ship::SinkShip(), SoundResource::SoundResource(), SoundSystem::SoundSystem(), Model::startList(), StateBattle::StateBattle(), StateCity::StateCity(), StateDone::StateDone(), StateNewGame::StateNewGame(), StateSailing::StateSailing(), IGameState::SwitchStates(), IGameState::TakeScreenshot(), Terrain::Terrain(), TextureResource::TextureResource(), StateSailing::Timer(), Battle::Timer(), TextureResource::Unload(), SoundResource::Unload(), ShipResource::Unload(), FontResource::Unload(), Battle::~Battle(), Cargo::~Cargo(), CCGui::~CCGui(), CityManager::~CityManager(), FontFactory::~FontFactory(), FontResource::~FontResource(), MainMenu::~MainMenu(), Ocean::~Ocean(), ResourceManager::~ResourceManager(), ShipFactory::~ShipFactory(), ShipResource::~ShipResource(), SoundFactory::~SoundFactory(), SoundResource::~SoundResource(), SoundSystem::~SoundSystem(), StateBattle::~StateBattle(), StateDone::~StateDone(), StateNewGame::~StateNewGame(), StateSailing::~StateSailing(), Terrain::~Terrain(), TextureFactory::~TextureFactory(), and TextureResource::~TextureResource().

                               {
  if (m_logFile) {
    m_logFile << msg << endl << endl;
  }

  cerr << msg << endl << endl;
}

bool Log::OpenLog

(

bool

logToFile

)

[static]

Definition at line 135 of file Log.cpp.

References Log(), Message(), and s_log.

Referenced by main().

                                {
  // Make sure s_log hasn't already been initialized
  if (s_log != NULL) {
    s_log->Message("Warning: Multiple calls to OpenLog()");
    return false;
  }

  s_log = new Log(logToFile);
  return true;
}

void Log::SetDebugMode

(

bool

debugMode

)

Definition at line 131 of file Log.cpp.

References m_debugMode.

Referenced by Config::Config().

                                     {
  m_debugMode = debugMode;
}

---

Member Data Documentation

bool Log::m_debugMode [private]

Definition at line 33 of file Log.h.

Referenced by DebugMessage(), Log(), and SetDebugMode().

std::ofstream Log::m_logFile [private]

Definition at line 35 of file Log.h.

Referenced by DebugMessage(), Log(), Message(), and ~Log().

Log * Log::s_log = NULL [static]

Definition at line 30 of file Log.h.

Referenced by ResourceManager::AcquireRandom(), Ship::AcquireResource(), Cargo::AddCargo(), CCListModel::AddItem(), Product::AddProductionPoints(), CityEconomy::AllocateProductionPoints(), BuildTexture(), StateCity::Buy(), StateDone::Buy(), Economy::BuyProduct(), Terrain::CalcHeight(), ShipResource::CalcMassMomentInertia(), CCListBox::CCListBox(), CCListModel::CCListModel(), Config::CheckExtensions(), CityManager::CityManager(), Config::CloseConfig(), CloseLog(), Config::Config(), Economy::CreateEconomy(), CCGui::CreateGui(), CityEconomy::DecreaseSize(), Economy::DestroyEconomy(), CCGui::DestroyGui(), SkyDome::Draw(), Ship::Dump(), Point::Dump(), Player::Dump(), Cargo::Dump(), BuildingList::Dump(), Building::Dump(), Economy::Economy(), EconomyScreen::EconomyScreen(), Battle::EnemyHit(), TCallback< StateNewGame >::Execute(), Cargo::FillRandom(), FontResource::FontResource(), CCListModel::getElementAt(), Product::GetPrice(), CityEconomy::IncreaseSize(), init(), Timer::Initialize(), StateSailing::Initialize(), SoundSystem::Initialize(), ResourceManager::Initialize(), SoundEffect::InitializeSource(), StateCity::InitMenu(), Ship::Load(), TextureResource::Load(), SoundResource::Load(), ShipResource::Load(), FontResource::Load(), Player::Load(), Cargo::Load(), CityManager::LoadCityConfig(), MainMenu::LoadGame(), ResourceManager::LoadXMLFile(), Config::LogConfig(), SoundSystem::LogDebugInfo(), ResourceManager::LogDebugInfo(), IGameState::Loop(), main(), MainMenu::MainMenu(), Model::objFirstPass(), Model::objLoad(), Model::objSecondPass(), Config::OpenConfig(), OpenLog(), Economy::ParseCityProducts(), CityManager::ParseClusters(), SoundEffect::Play(), Battle::PlayerHit(), IGameState::PrepareStateSwitch(), prepExit(), Product::Product(), Ship::ReleaseResource(), CCListModel::RemoveItem(), ResourceManager::ResourceManager(), ISound::RevokeSource(), StateDone::SackPlayer(), StateCity::Sell(), StateDone::Sell(), Economy::SellProduct(), IGameState::SetCurrentPtr(), IGameState::SetMainMenu(), StateDone::SetMenuQtys(), StateDone::SetupMenu(), ShipResource::ShipResource(), Timer::Shutdown(), SoundSystem::Shutdown(), ResourceManager::Shutdown(), Ship::SinkShip(), SoundResource::SoundResource(), SoundSystem::SoundSystem(), Model::startList(), StateBattle::StateBattle(), StateCity::StateCity(), StateDone::StateDone(), StateNewGame::StateNewGame(), StateSailing::StateSailing(), IGameState::SwitchStates(), IGameState::TakeScreenshot(), Terrain::Terrain(), TextureResource::TextureResource(), StateSailing::Timer(), Battle::Timer(), TextureResource::Unload(), SoundResource::Unload(), ShipResource::Unload(), FontResource::Unload(), MainMenu::Update(), Battle::~Battle(), Cargo::~Cargo(), CCGui::~CCGui(), CCListModel::~CCListModel(), CityManager::~CityManager(), FontFactory::~FontFactory(), FontResource::~FontResource(), MainMenu::~MainMenu(), Ocean::~Ocean(), ResourceManager::~ResourceManager(), ShipFactory::~ShipFactory(), ShipResource::~ShipResource(), SoundFactory::~SoundFactory(), SoundResource::~SoundResource(), SoundSystem::~SoundSystem(), StateBattle::~StateBattle(), StateDone::~StateDone(), StateNewGame::~StateNewGame(), StateSailing::~StateSailing(), Terrain::~Terrain(), TextureFactory::~TextureFactory(), and TextureResource::~TextureResource().

---

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

• src/Log.h
• src/Log.cpp

---