Config Class Reference

#include <Config.h>

List of all members.

Public Member Functions
	Config (const std::string filename)
	~Config ()
bool	CheckExtensions ()
bool	CheckVBO ()
int	GetWinWidth ()
int	GetWinHeight ()
bool	CheckFullscreen ()
bool	CheckSDLParachute ()
bool	CheckCompressTextures ()
unsigned int	GetTicksBetweenBattles ()
unsigned int	GetNumberALSources ()
bool	DebugLogEnabled ()
std::string	GetStartingShipType ()
Static Public Member Functions
static bool	OpenConfig (const std::string filename)
static void	CloseConfig ()
Static Public Attributes
static Config *	s_config = NULL
Private Member Functions
void	LogConfig ()
Private Attributes
int	m_winWidth
int	m_winHeight
bool	m_fullscreen
bool	m_useVBO
bool	m_useSDLParachute
bool	m_compressTextures
unsigned int	m_ticksBetweenBattles
unsigned int	m_numberALSources
bool	m_debugLogMode
std::string	m_startingShipType

---

Detailed Description

Definition at line 10 of file Config.h.

---

Constructor & Destructor Documentation

Config::Config

(

const std::string

filename

)

Definition at line 18 of file Config.cpp.

References LogConfig(), m_compressTextures, m_debugLogMode, m_fullscreen, m_numberALSources, m_startingShipType, m_ticksBetweenBattles, m_useSDLParachute, m_useVBO, m_winHeight, m_winWidth, Log::Message(), Log::s_log, and Log::SetDebugMode().

Referenced by OpenConfig().

                                       {
  TiXmlDocument doc( filename );
  TiXmlElement* config;
  TiXmlElement* resolution;
  TiXmlElement* temp;
  TiXmlText* data;
  int n;

  m_winWidth = 640;
  m_winHeight = 480;
  m_fullscreen = false;
  m_useVBO = false;
  m_useSDLParachute = true;
  m_compressTextures = true;
  m_ticksBetweenBattles = 20000;
  m_numberALSources = 16;
  m_debugLogMode = false;
  m_startingShipType = "Sloop";

  doc.LoadFile();
  if (doc.Error()) {
    Log::s_log->Message("Warning: %s (line %d)  Using defaults", doc.ErrorDesc(), doc.ErrorRow());
    LogConfig();
    return;
  }

  config = doc.FirstChildElement("GameConfiguration"); // This gets the <GameConfiguration> tag
  if (config == NULL) {
    Log::s_log->Message("Warning: <GameConfiguration> did not parse correctly.");
    LogConfig();
    return;
  }

  try {
    resolution = config->FirstChildElement("Resolution"); // This gets <Resolution>
    if (resolution == NULL) throw 0;

    // Deal with Resolution
    temp = resolution->FirstChildElement("Width");
    if (temp == NULL) throw 0;
    data = temp->FirstChild()->ToText();
    if (data == NULL) throw 1;
    n = sscanf(data->Value(), "%d", &m_winWidth);
    if (n != 1) throw 1;

    temp = resolution->FirstChildElement("Height");
    if (temp == NULL) throw 0;
    data = temp->FirstChild()->ToText();
    if (data == NULL) throw 2;
    n = sscanf(data->Value(), "%d", &m_winHeight);
    if (n != 1) throw 2;
  } catch (int i) {
    switch (i) {
    case 0:
      Log::s_log->Message("Warning: <Resolution> did not parse correctly");
      break;
    case 1:
      Log::s_log->Message("Warning: Invalid <Width> data, using defaults");
      break;
    case 2:
      Log::s_log->Message("Warning: Invalid <Height> data, using defaults");
      break;
    default:
      // Shouldn't get here
      Log::s_log->Message("Warning: Unknown <Resolution> error");
      break;
    }

    // Set it back to the defaults
    m_winWidth = 640;
    m_winHeight = 480;
  }

  try {
    // Deal with Fullscreen
    temp = config->FirstChildElement("Fullscreen");
    if (temp == NULL) throw 0;

    data = temp->FirstChild()->ToText();
    if (data == NULL) throw 1;
    if (strcmp(data->Value(), "true") == 0) {
      m_fullscreen = true;
    } else if (strcmp(data->Value(), "false") == 0) {
      m_fullscreen = false;
    } else {
      throw 1;
    }
  } catch (int i) {
    switch (i) {
    case 0:
      Log::s_log->Message("Warning: <Fullscreen> did not parse correctly");
      break;
    case 1:
      Log::s_log->Message("Warning: Invalid Fullscreen data, using default");
      break;
    default:
      // Shouldn't get here
      Log::s_log->Message("Warning: Unknown <Fullscreen> error");
      break;
    }
  }

  try {
    // Deal with VBOs
    temp = config->FirstChildElement("VBO");
    if (temp == NULL) throw 0;

    data = temp->FirstChild()->ToText();
    if (data == NULL) throw 1;
    if (strcmp(data->Value(), "true") == 0) {
      m_useVBO = true;
    } else if (strcmp(data->Value(), "false") == 0) {
      m_useVBO = false;
    } else {
      throw 1;
    }
  } catch (int i) {
    switch (i) {
    case 0:
      Log::s_log->Message("Warning: <VBO> did not parse correctly");
      break;
    case 1:
      Log::s_log->Message("Warning: Invalid VBO data, using default");
      break;
    default:
      // Shouldn't get here
      Log::s_log->Message("Warning: Unknown <VBO> error");
      break;
    }
  }

  try {
    // Deal with SDLParachute
    temp = config->FirstChildElement("SDLParachute");
    if (temp == NULL) throw 0;

    data = temp->FirstChild()->ToText();
    if (data == NULL) throw 1;
    if (strcmp(data->Value(), "true") == 0) {
      m_useSDLParachute = true;
    } else if (strcmp(data->Value(), "false") == 0) {
      m_useSDLParachute = false;
    } else {
      throw 1;
    }
  } catch (int i) {
    switch (i) {
    case 0:
      Log::s_log->Message("Warning: <SDLParachute> did not parse correctly");
      break;
    case 1:
      Log::s_log->Message("Warning: Invalid SDLParachute data, using default");
      break;
    default:
      // Shouldn't get here
      Log::s_log->Message("Warning: Unknown <SDLParachute> error");
      break;
    }
  }

  try {
    // Deal with CompressTextures
    temp = config->FirstChildElement("CompressTextures");
    if (temp == NULL) throw 0;

    data = temp->FirstChild()->ToText();
    if (data == NULL) throw 1;
    if (strcmp(data->Value(), "true") == 0) {
      m_compressTextures = true;
    } else if (strcmp(data->Value(), "false") == 0) {
      m_compressTextures = false;
    } else {
      throw 1;
    }
  } catch (int i) {
    switch (i) {
    case 0:
      Log::s_log->Message("Warning: <CompressTextures> did not parse correctly");
      break;
    case 1:
      Log::s_log->Message("Warning: Invalid CompressTexture data, using default");
      break;
    default:
      // Shouldn't get here
      Log::s_log->Message("Warning: Unknown <CompressTexture> error");
      break;
    }
  }

  try {
    // Deal with TicksBetweenBattles
    temp = config->FirstChildElement("TicksBetweenBattles");
    if (temp == NULL) throw 0;

    data = temp->FirstChild()->ToText();
    if (data == NULL) throw 1;
    n = sscanf(data->Value(), "%u", &m_ticksBetweenBattles);
    if (n != 1) throw 1;
  } catch (int i) {
    switch (i) {
    case 0:
      Log::s_log->Message("Warning: <TicksBetweenBattles> did not parse correctly");
      break;
    case 1:
      Log::s_log->Message("Warning: Invalid TicksBetweenBattles data, using default");
      break;
    default:
      // Shouldn't get here
      Log::s_log->Message("Warning: Unknown <TicksBetweenBattles> error");
      break;
    }
  }

  try {
    // Deal with NumberALSources
    temp = config->FirstChildElement("NumberALSources");
    if (temp == NULL) throw 0;

    data = temp->FirstChild()->ToText();
    if (data == NULL) throw 1;
    n = sscanf(data->Value(), "%u", &m_numberALSources);
    if (n != 1) throw 1;
  } catch (int i) {
    switch (i) {
    case 0:
      Log::s_log->Message("Warning: <NumberALSources> did not parse correctly");
      break;
    case 1:
      Log::s_log->Message("Warning: Invalid NumberALSources data, using default");
      break;
    default:
      // Shouldn't get here
      Log::s_log->Message("Warning: Unknown <NumberALSources> error");
      break;
    }
  }

  try {
    // Deal with debug log mode
    temp = config->FirstChildElement("DebugLogMode");
    if (temp == NULL) throw 0;

    data = temp->FirstChild()->ToText();
    if (data == NULL) throw 1;
    if (strcmp(data->Value(), "true") == 0) {
      m_debugLogMode = true;
    } else if (strcmp(data->Value(), "false") == 0) {
      m_debugLogMode = false;
    } else {
      throw 1;
    }
  } catch (int i) {
    switch (i) {
    case 0:
      Log::s_log->Message("Warning: <DebugLogMode> did not parse correctly");
      break;
    case 1:
      Log::s_log->Message("Warning: Invalid DebugLogMode data, using default");
      break;
    default:
      // Shouldn't get here
      Log::s_log->Message("Warning: Unknown <DebugLogMode> error");
      break;
    }
  }
  Log::s_log->SetDebugMode(m_debugLogMode);

  try {
    // Deal with StartingShipType
    temp = config->FirstChildElement("StartingShipType");
    if (temp == NULL) throw 0;

    data = temp->FirstChild()->ToText();
    if (data == NULL) throw 1;
    m_startingShipType = data->Value();
  } catch (int i) {
    switch (i) {
      case 0:
        Log::s_log->Message("Warning: <StartingShipType> did not parse correctly");
        break;
      case 1:
        Log::s_log->Message("Warning: Invalid StartingShipType data, using default");
        break;
      default:
      // Shouldn't get here
        Log::s_log->Message("Warning: Unknown <StartingShipType> error");
        break;
    }
  }

  LogConfig();
}

Config::~Config

(

)

Definition at line 312 of file Config.cpp.

                {
}

---

Member Function Documentation

bool Config::CheckCompressTextures

(

)

Definition at line 362 of file Config.cpp.

References m_compressTextures.

Referenced by BuildTexture().

                                   {
  return m_compressTextures;
}

bool Config::CheckExtensions

(

)

Definition at line 317 of file Config.cpp.

References CheckVBO(), m_useVBO, Log::Message(), s_config, and Log::s_log.

                             {
  // Check multi-texturing functions
  if (!GLEE_ARB_multitexture) {
    // Probably should just throw an exception
    Log::s_log->Message("Error: Your video card and/or drivers do not support multitexturing");
    return false;
  }

  // Check vertex array drawing function
  if (!GLEE_EXT_draw_range_elements) {
    // Probably should just throw an exception
    Log::s_log->Message("Error: Your video card and/or drivers do not support glDrawRangeElements");
    return false;
  }

  // Check VBOs if enabled
  if (Config::s_config->CheckVBO() && !GLEE_ARB_vertex_buffer_object) {
    m_useVBO = false;
    Log::s_log->Message("Warning: Your video card and/or drivers do not support VBOs, falling back on VAs");
  }

  // We have multitexturing, so we can continue
  return true;
}

bool Config::CheckFullscreen

(

)

Definition at line 354 of file Config.cpp.

References m_fullscreen.

                             {
  return m_fullscreen;
}

bool Config::CheckSDLParachute

(

)

Definition at line 358 of file Config.cpp.

References m_useSDLParachute.

                               {
  return m_useSDLParachute;
}

bool Config::CheckVBO

(

)

Definition at line 342 of file Config.cpp.

References m_useVBO.

Referenced by CheckExtensions().

                      {
  return m_useVBO;
}

void Config::CloseConfig

(

)

[static]

Definition at line 376 of file Config.cpp.

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

Referenced by prepExit().

                         {
  if (s_config == NULL) {
    Log::s_log->Message("Warning: Close config on NULL configuration");
    return;
  }

  delete s_config;
  s_config = NULL;
}

bool Config::DebugLogEnabled

(

)

Definition at line 438 of file Config.cpp.

References m_debugLogMode.

                             {
  return m_debugLogMode;
}

unsigned int Config::GetNumberALSources

(

)

Definition at line 434 of file Config.cpp.

References m_numberALSources.

                                        {
  return m_numberALSources;
}

string Config::GetStartingShipType

(

)

Definition at line 442 of file Config.cpp.

References m_startingShipType.

                                   {
  return m_startingShipType;
}

unsigned int Config::GetTicksBetweenBattles

(

)

Definition at line 430 of file Config.cpp.

References m_ticksBetweenBattles.

                                            {
  return m_ticksBetweenBattles;
}

int Config::GetWinHeight

(

)

Definition at line 350 of file Config.cpp.

References m_winHeight.

Referenced by Battle::Battle(), IGameState::DisplayBackground(), IGameState::DisplaySplashScreen(), init(), StateSailing::Initialize(), main(), Map::Map(), and IGameState::TakeScreenshot().

                         {
  return m_winHeight;
}

int Config::GetWinWidth

(

)

Definition at line 346 of file Config.cpp.

References m_winWidth.

Referenced by Battle::Battle(), IGameState::DisplayBackground(), IGameState::DisplaySplashScreen(), init(), StateSailing::Initialize(), main(), Map::Map(), and IGameState::TakeScreenshot().

                        {
  return m_winWidth;
}

void Config::LogConfig

(

)

[private]

Definition at line 386 of file Config.cpp.

References m_compressTextures, m_debugLogMode, m_fullscreen, m_numberALSources, m_startingShipType, m_ticksBetweenBattles, m_useSDLParachute, m_useVBO, m_winHeight, m_winWidth, Log::Message(), and Log::s_log.

Referenced by Config().

                       {
  ostringstream outputString;

  outputString << "Configuration:" << endl;
  outputString << "Resolution: " << m_winWidth << " x " << m_winHeight << endl;

  outputString << "Fullscreen: ";
  if (m_fullscreen) outputString << "true";
  else outputString << "false";
  outputString << endl;

  outputString << "Use VBOs: ";
  if (m_useVBO) outputString << "true";
  else outputString << "false";
  outputString << endl;

  outputString << "Enable SDL Parachute: ";
  if (m_useSDLParachute) outputString << "true";
  else outputString << "false";
  outputString << endl;

  outputString << "Compress Textures: ";
  if (m_compressTextures) outputString << "true";
  else outputString << "false";
  outputString << endl;

  outputString << "TicksBetweenBattles: ";
  outputString << m_ticksBetweenBattles;
  outputString << endl;

  outputString << "NumberALSources: ";
  outputString << m_numberALSources;
  outputString << endl;

  outputString << "DebugLogMode: ";
  if (m_debugLogMode) outputString << "true";
  else outputString << "false";
  outputString << endl;

  outputString << "Starting Ship Type: \"" << m_startingShipType << "\"";

  Log::s_log->Message(outputString.str());
}

bool Config::OpenConfig

(

const std::string

filename

)

[static]

Definition at line 366 of file Config.cpp.

References Config(), Log::Message(), s_config, and Log::s_log.

Referenced by main().

                                                {
  if (s_config != NULL) {
    Log::s_log->Message("Warning: Open config on non-NULL configuration");
    return false;
  }

  s_config = new Config(filename);
  return true;
}

---

Member Data Documentation

bool Config::m_compressTextures [private]

Definition at line 72 of file Config.h.

Referenced by CheckCompressTextures(), Config(), and LogConfig().

bool Config::m_debugLogMode [private]

Definition at line 83 of file Config.h.

Referenced by Config(), DebugLogEnabled(), and LogConfig().

bool Config::m_fullscreen [private]

Definition at line 60 of file Config.h.

Referenced by CheckFullscreen(), Config(), and LogConfig().

unsigned int Config::m_numberALSources [private]

Definition at line 80 of file Config.h.

Referenced by Config(), GetNumberALSources(), and LogConfig().

std::string Config::m_startingShipType [private]

Definition at line 86 of file Config.h.

Referenced by Config(), GetStartingShipType(), and LogConfig().

unsigned int Config::m_ticksBetweenBattles [private]

Definition at line 76 of file Config.h.

Referenced by Config(), GetTicksBetweenBattles(), and LogConfig().

bool Config::m_useSDLParachute [private]

Definition at line 67 of file Config.h.

Referenced by CheckSDLParachute(), Config(), and LogConfig().

bool Config::m_useVBO [private]

Definition at line 63 of file Config.h.

Referenced by CheckExtensions(), CheckVBO(), Config(), and LogConfig().

int Config::m_winHeight [private]

Definition at line 57 of file Config.h.

Referenced by Config(), GetWinHeight(), and LogConfig().

int Config::m_winWidth [private]

Definition at line 56 of file Config.h.

Referenced by Config(), GetWinWidth(), and LogConfig().

Config * Config::s_config = NULL [static]

Definition at line 52 of file Config.h.

Referenced by Battle::Battle(), BuildTexture(), CheckExtensions(), CloseConfig(), IGameState::DisplayBackground(), IGameState::DisplaySplashScreen(), IGameState::IGameState(), init(), Battle::InitHUD(), StateSailing::Initialize(), IGameState::Loop(), main(), MainMenu::MainMenu(), Map::Map(), OpenConfig(), Player::Player(), Terrain::SetGlArrayPointers(), StateSailing::SetTicksToNextBattle(), StateBattle::StateBattle(), StateNewGame::SwitchTo(), StateCity::SwitchTo(), StateDone::SwitchTo(), StateBattle::SwitchTo(), Map::SwitchTo(), MainMenu::SwitchTo(), IGameState::TakeScreenshot(), Terrain::Terrain(), and Terrain::~Terrain().

---

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

• src/Config.h
• src/Config.cpp

---