Config Class Reference

#include <config.h>

Collaboration diagram for Config:

[legend]List of all members.

Public Member Functions
bool	GetExterieurMondeVide () const
void	SetExterieurMondeVide (bool emv)
bool	GetDisplayEnergyCharacter () const
void	SetDisplayEnergyCharacter (bool dec)
bool	GetDisplayNameCharacter () const
void	SetDisplayNameCharacter (bool dnc)
bool	GetDisplayWindParticles () const
void	SetDisplayWindParticles (bool dwp)
bool	GetDefaultMouseCursor () const
void	SetDefaultMouseCursor (bool dmc)
bool	GetScrollOnBorder () const
void	SetScrollOnBorder (bool sob)
bool	IsNetworkActivated () const
int	GetTransparency () const
Keyboard *	GetKeyboard ()
WeaponsList *	GetWeaponsList ()
std::string	GetTtfFilename () const
std::string	GetDataDir () const
std::string	GetLocaleDir () const
std::string	GetPersonalDir () const
void	Apply ()
bool	Save ()
Static Public Member Functions
static Config *	GetInstance ()
Public Attributes
Config::tmp_xml_config	tmp
Static Public Attributes
static const int	ALPHA = 0
static const int	COLORKEY = 1
Protected Member Functions
bool	LoadXml (xmlpp::Element *xml)
void	SetKeyboardConfig ()
bool	SaveXml ()
std::string	GetEnv (const std::string &name, const std::string &default_value)
Protected Attributes
std::string	m_game_mode
bool	m_xml_loaded
std::string	m_filename
std::string	data_dir
std::string	locale_dir
std::string	personal_dir
bool	exterieur_monde_vide
bool	display_energy_character
bool	display_name_character
bool	display_wind_particles
bool	default_mouse_cursor
bool	scroll_on_border
std::string	ttf_filename
int	transparency
Private Member Functions
	Config ()
bool	DoLoading (void)
Private Attributes
Keyboard *	my_keyboard
WeaponsList *	my_weapons_list
Static Private Attributes
static Config *	singleton = NULL
Classes
struct	tmp_xml_config

---

Detailed Description

Definition at line 45 of file config.h.

---

Constructor & Destructor Documentation

Config::Config

(

)

[private]

Definition at line 65 of file config.cpp.

{

#ifdef USE_AUTOPACKAGE
  BrInitError error;
  std::string filename;

  if (br_init (&error) == 0 && error != BR_INIT_ERROR_DISABLED) {
    std::cout << "Warning: BinReloc failed to initialize (error code "
              << error << ")" << std::endl;
    std::cout << "Will fallback to hardcoded default path." << std::endl;
  }
#endif

  // Default values
  exterieur_monde_vide = true;
  m_game_mode = "classic";
  display_energy_character = true;
  display_name_character = true;
  display_wind_particles = true;
  default_mouse_cursor = false;
  scroll_on_border = true;
  transparency = ALPHA;

  // video
  tmp.video.width = 800;
  tmp.video.height = 600;
  tmp.video.fullscreen = false;

  // sound
  tmp.sound.music = true;
  tmp.sound.effects = true;
  tmp.sound.frequency = 44100;

  // network
  tmp.network.enable_network = false;

  Constants::GetInstance();

  // directories
#ifdef USE_AUTOPACKAGE
  data_dir     = GetEnv(Constants::ENV_DATADIR, br_find_data_dir(INSTALL_DATADIR));
  locale_dir   = GetEnv(Constants::ENV_LOCALEDIR, br_find_locale_dir(INSTALL_LOCALEDIR));
  filename     = data_dir + PATH_SEPARATOR + "font" + PATH_SEPARATOR + "DejaVuSans.ttf";
  ttf_filename = GetEnv(Constants::ENV_FONT_PATH, br_find_locale_dir(filename.c_str()));
#else
  data_dir     = GetEnv(Constants::ENV_DATADIR, INSTALL_DATADIR);
  locale_dir   = GetEnv(Constants::ENV_LOCALEDIR, INSTALL_LOCALEDIR);
  ttf_filename = GetEnv(Constants::ENV_FONT_PATH, FONT_FILE);
#endif

#ifndef WIN32
  personal_dir = GetHome() + "/.wormux/";
#else
  personal_dir = GetHome() + "\\Wormux\\";
#endif
  InitI18N(locale_dir.c_str());

  DoLoading();
  std::string dir = TranslateDirectory(locale_dir);
  I18N_SetDir (dir + PATH_SEPARATOR);

  dir = TranslateDirectory(data_dir);
  resource_manager.AddDataPath(dir + PATH_SEPARATOR);
}

Here is the call graph for this function:

Here is the caller graph for this function:

---

Member Function Documentation

void Config::Apply

(

)

Definition at line 268 of file config.cpp.

{
  SetKeyboardConfig();

  // Charge le mode jeu
  my_weapons_list = new WeaponsList();

  GameMode::GetInstance()->Load(m_game_mode);

  // Son
  jukebox.ActiveMusic (tmp.sound.music);
  jukebox.ActiveEffects (tmp.sound.effects);
  jukebox.SetFrequency (tmp.sound.frequency);

  // load the teams
  teams_list.LoadList();
  if (m_xml_loaded)
    teams_list.InitList (tmp.teams);

  // Load maps
  if (m_xml_loaded && !tmp.map_name.empty())
    MapsList::GetInstance()->SelectMapByName (tmp.map_name);
  else
    MapsList::GetInstance()->SelectMapByIndex (0);
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool Config::DoLoading

(

void

)

[private]

Definition at line 131 of file config.cpp.

{
  m_xml_loaded = false;
  try
  {
    // Load XML conf
    XmlReader doc;
    m_filename = personal_dir + FILENAME;
    if (!doc.Load(m_filename))
      return false;
    if (!LoadXml(doc.GetRoot()))
      return false;
    m_xml_loaded = true;
  }
  catch (const xmlpp::exception &e)
  {
    std::cout << "o "
        << _("Error while loading configuration file: %s") << std::endl
        << e.what() << std::endl;
    return false;
  }
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

std::string Config::GetDataDir

(

)

const

Definition at line 390 of file config.cpp.

{
  return data_dir;
}

Here is the caller graph for this function:

bool Config::GetDefaultMouseCursor

(

)

const

Definition at line 425 of file config.cpp.

{
  return default_mouse_cursor;
}

bool Config::GetDisplayEnergyCharacter

(

)

const

Definition at line 410 of file config.cpp.

{
  return display_energy_character;
}

Here is the caller graph for this function:

bool Config::GetDisplayNameCharacter

(

)

const

Definition at line 415 of file config.cpp.

{
  return display_name_character;
}

Here is the caller graph for this function:

bool Config::GetDisplayWindParticles

(

)

const

Definition at line 420 of file config.cpp.

{
  return display_wind_particles;
}

Here is the caller graph for this function:

std::string Config::GetEnv	(	const std::string &	name,
		const std::string &	default_value
	)			[protected]

Definition at line 380 of file config.cpp.

{
  const char *env = std::getenv(name.c_str());
  if (env != NULL) {
    return env;
  } else {
    return default_value;
  }
}

Here is the caller graph for this function:

bool Config::GetExterieurMondeVide

(

)

const

Definition at line 405 of file config.cpp.

{
  return exterieur_monde_vide;
}

Here is the caller graph for this function:

Config * Config::GetInstance

(

)

[static]

Definition at line 58 of file config.cpp.

                             {
  if (singleton == NULL) {
    singleton = new Config();
  }
  return singleton;
}

Here is the call graph for this function:

Here is the caller graph for this function:

Keyboard* Config::GetKeyboard

(

)

[inline]

Definition at line 74 of file config.h.

{ return my_keyboard; }

Here is the caller graph for this function:

std::string Config::GetLocaleDir

(

)

const

Definition at line 395 of file config.cpp.

{
  return locale_dir;
}

std::string Config::GetPersonalDir

(

)

const

Definition at line 400 of file config.cpp.

{
  return personal_dir;
}

Here is the caller graph for this function:

bool Config::GetScrollOnBorder

(

)

const

Definition at line 430 of file config.cpp.

{
  return scroll_on_border;
}

Here is the caller graph for this function:

int Config::GetTransparency

(

)

const

Definition at line 475 of file config.cpp.

{
  return transparency;
}

std::string Config::GetTtfFilename

(

)

const

Definition at line 435 of file config.cpp.

{
  return ttf_filename;
}

WeaponsList* Config::GetWeaponsList

(

)

[inline]

Definition at line 75 of file config.h.

{ return my_weapons_list; }

Here is the caller graph for this function:

bool Config::IsNetworkActivated

(

)

const

Definition at line 440 of file config.cpp.

{
  return tmp.network.enable_network;
}

Here is the caller graph for this function:

bool Config::LoadXml

(

xmlpp::Element *

xml

)

[protected]

Definition at line 156 of file config.cpp.

{
  std::cout << "o " << _("Reading personal config file") << std::endl;

  xmlpp::Element *elem;

  //=== Map ===
  XmlReader::ReadString(xml, "map", tmp.map_name);

  //=== Teams ===
  elem = XmlReader::GetMarker(xml, "teams");
  int i = 0;

  xmlpp::Element *team = XmlReader::GetMarker(elem, "team_" + ulong2str(i));

  while (team != NULL)
  {
    ConfigTeam one_team;
    XmlReader::ReadString(team, "id", one_team.id);
    XmlReader::ReadString(team, "player_name", one_team.player_name);

    int tmp_nb_characters;
    XmlReader::ReadInt(team, "nb_characters", tmp_nb_characters);
    one_team.nb_characters = (uint)tmp_nb_characters;

    tmp.teams.push_back(one_team);

    // get next team
    i++;
    team = XmlReader::GetMarker(elem, "team_"+ulong2str(i));
  }

  //=== Video ===
  elem = XmlReader::GetMarker(xml, "video");
  if (elem != NULL)
  {
    uint max_fps;
    if (XmlReader::ReadUint(elem, "max_fps", max_fps))
      AppWormux::GetInstance()->video.SetMaxFps(max_fps);

    XmlReader::ReadBool(elem, "display_wind_particles", display_wind_particles);
    XmlReader::ReadBool(elem, "display_energy_character", display_energy_character);
    XmlReader::ReadBool(elem, "display_name_character", display_name_character);
    XmlReader::ReadBool(elem, "default_mouse_cursor", default_mouse_cursor);
    XmlReader::ReadBool(elem, "scroll_on_border", scroll_on_border);
    XmlReader::ReadInt(elem, "width", tmp.video.width);
    XmlReader::ReadInt(elem, "height", tmp.video.height);
    XmlReader::ReadBool(elem, "full_screen", tmp.video.fullscreen);
  }

  //=== Sound ===
  elem = XmlReader::GetMarker(xml, "sound");
  if (elem != NULL)
  {
    XmlReader::ReadBool(elem, "music", tmp.sound.music);
    XmlReader::ReadBool(elem, "effects", tmp.sound.effects);
    XmlReader::ReadUint(elem, "frequency", tmp.sound.frequency);
  }

  //=== network ===
  elem = XmlReader::GetMarker(xml, "network");
  if (elem != NULL)
  {
    XmlReader::ReadBool(elem, "enable_network", tmp.network.enable_network);
  }

  //=== game mode ===
  XmlReader::ReadString(xml, "game_mode", m_game_mode);
  return true;
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool Config::Save

(

)

Definition at line 294 of file config.cpp.

{
  std::string rep = personal_dir;

  // Create the directory if it doesn't exist
#ifndef WIN32
   if (mkdir (personal_dir.c_str(), 0750) != 0 && errno != EEXIST)
#else
  if (_mkdir (personal_dir.c_str()) != 0 && errno != EEXIST)
#endif
  {
    std::cerr << "o "
      << Format(_("Error while creating directory \"%s\": unable to store configuration file."),
          rep.c_str())
      << std::endl;
    return false;
  }

  return SaveXml();
}

Here is the call graph for this function:

Here is the caller graph for this function:

bool Config::SaveXml

(

)

[protected]

Definition at line 315 of file config.cpp.

{
  XmlWriter doc;

  doc.Create(m_filename, "config", "1.0", "utf-8");
  xmlpp::Element *root = doc.GetRoot();
  doc.WriteElement(root, "version", Constants::VERSION);

  //=== Map ===
  doc.WriteElement(root, "map", MapsList::GetInstance()->ActiveMap().ReadName());

  //=== Teams ===
  xmlpp::Element *team_elements = root->add_child("teams");

  TeamsList::iterator
    it=teams_list.playing_list.begin(),
    fin=teams_list.playing_list.end();
  for (int i=0; it != fin; ++it, i++)
  {
    xmlpp::Element *a_team = team_elements->add_child("team_"+ulong2str(i));
    doc.WriteElement(a_team, "id", (**it).GetId());
    doc.WriteElement(a_team, "player_name", (**it).GetPlayerName());
    doc.WriteElement(a_team, "nb_characters", ulong2str((**it).GetNbCharacters()));
  }

  //=== Video ===
  AppWormux * app = AppWormux::GetInstance();

  xmlpp::Element *video_node = root->add_child("video");
  doc.WriteElement(video_node, "display_wind_particles", ulong2str(display_wind_particles));
  doc.WriteElement(video_node, "display_energy_character", ulong2str(display_energy_character));
  doc.WriteElement(video_node, "display_name_character", ulong2str(display_name_character));
  doc.WriteElement(video_node, "default_mouse_cursor", ulong2str(default_mouse_cursor));
  doc.WriteElement(video_node, "scroll_on_border", ulong2str(scroll_on_border));
  doc.WriteElement(video_node, "width", ulong2str(app->video.window.GetWidth()));
  doc.WriteElement(video_node, "height", ulong2str(app->video.window.GetHeight()));
  doc.WriteElement(video_node, "full_screen",
                   ulong2str(static_cast<uint>(app->video.IsFullScreen())) );
  doc.WriteElement(video_node, "max_fps",
                   long2str(static_cast<int>(app->video.GetMaxFps())));

  if (transparency == ALPHA)
    doc.WriteElement(video_node, "transparency", "alpha");
  else if (transparency == COLORKEY)
    doc.WriteElement(video_node, "transparency", "colorkey");

  //=== Sound ===
  xmlpp::Element *sound_node = root->add_child("sound");
  doc.WriteElement(sound_node, "music",  ulong2str(jukebox.UseMusic()));
  doc.WriteElement(sound_node, "effects", ulong2str(jukebox.UseEffects()));
  doc.WriteElement(sound_node, "frequency", ulong2str(jukebox.GetFrequency()));

  //=== Network ===
  xmlpp::Element *net_node = root->add_child("network");
  doc.WriteElement(net_node, "enable_network",  ulong2str(IsNetworkActivated()));

  //=== game mode ===
  doc.WriteElement(root, "game_mode", m_game_mode);
  return doc.Save();
}

Here is the call graph for this function:

Here is the caller graph for this function:

void Config::SetDefaultMouseCursor

(

bool

dmc

)

Definition at line 460 of file config.cpp.

{
  default_mouse_cursor = dmc;
}

void Config::SetDisplayEnergyCharacter

(

bool

dec

)

Definition at line 445 of file config.cpp.

{
  display_energy_character = dec;
}

Here is the caller graph for this function:

void Config::SetDisplayNameCharacter

(

bool

dnc

)

Definition at line 450 of file config.cpp.

{
  display_name_character = dnc;
}

Here is the caller graph for this function:

void Config::SetDisplayWindParticles

(

bool

dwp

)

Definition at line 455 of file config.cpp.

{
  display_wind_particles = dwp;
}

Here is the caller graph for this function:

void Config::SetExterieurMondeVide

(

bool

emv

)

Definition at line 470 of file config.cpp.

{
  exterieur_monde_vide = emv;
}

Here is the caller graph for this function:

void Config::SetKeyboardConfig

(

)

[protected]

Definition at line 227 of file config.cpp.

{
  my_keyboard = new Keyboard();

  my_keyboard->SetKeyAction(SDLK_LEFT,      Action::ACTION_MOVE_LEFT);
  my_keyboard->SetKeyAction(SDLK_RIGHT,     Action::ACTION_MOVE_RIGHT);
  my_keyboard->SetKeyAction(SDLK_UP,        Action::ACTION_UP);
  my_keyboard->SetKeyAction(SDLK_DOWN,      Action::ACTION_DOWN);
  my_keyboard->SetKeyAction(SDLK_RETURN,    Action::ACTION_JUMP);
  my_keyboard->SetKeyAction(SDLK_BACKSPACE, Action::ACTION_HIGH_JUMP);
  my_keyboard->SetKeyAction(SDLK_b,         Action::ACTION_BACK_JUMP);
  my_keyboard->SetKeyAction(SDLK_SPACE,     Action::ACTION_SHOOT);
  my_keyboard->SetKeyAction(SDLK_TAB,       Action::ACTION_NEXT_CHARACTER);
  my_keyboard->SetKeyAction(SDLK_ESCAPE,    Action::ACTION_QUIT);
  my_keyboard->SetKeyAction(SDLK_p,         Action::ACTION_PAUSE);
  my_keyboard->SetKeyAction(SDLK_F10,       Action::ACTION_FULLSCREEN);
  my_keyboard->SetKeyAction(SDLK_F9,        Action::ACTION_TOGGLE_INTERFACE);
  my_keyboard->SetKeyAction(SDLK_F1,        Action::ACTION_WEAPONS1);
  my_keyboard->SetKeyAction(SDLK_F2,        Action::ACTION_WEAPONS2);
  my_keyboard->SetKeyAction(SDLK_F3,        Action::ACTION_WEAPONS3);
  my_keyboard->SetKeyAction(SDLK_F4,        Action::ACTION_WEAPONS4);
  my_keyboard->SetKeyAction(SDLK_F5,        Action::ACTION_WEAPONS5);
  my_keyboard->SetKeyAction(SDLK_F6,        Action::ACTION_WEAPONS6);
  my_keyboard->SetKeyAction(SDLK_F7,        Action::ACTION_WEAPONS7);
  my_keyboard->SetKeyAction(SDLK_F8,        Action::ACTION_WEAPONS8);
  my_keyboard->SetKeyAction(SDLK_c,         Action::ACTION_CENTER);
  my_keyboard->SetKeyAction(SDLK_1,         Action::ACTION_WEAPON_1);
  my_keyboard->SetKeyAction(SDLK_2,         Action::ACTION_WEAPON_2);
  my_keyboard->SetKeyAction(SDLK_3,         Action::ACTION_WEAPON_3);
  my_keyboard->SetKeyAction(SDLK_4,         Action::ACTION_WEAPON_4);
  my_keyboard->SetKeyAction(SDLK_5,         Action::ACTION_WEAPON_5);
  my_keyboard->SetKeyAction(SDLK_6,         Action::ACTION_WEAPON_6);
  my_keyboard->SetKeyAction(SDLK_7,         Action::ACTION_WEAPON_7);
  my_keyboard->SetKeyAction(SDLK_8,         Action::ACTION_WEAPON_8);
  my_keyboard->SetKeyAction(SDLK_9,         Action::ACTION_WEAPON_9);
  my_keyboard->SetKeyAction(SDLK_PAGEUP,    Action::ACTION_WEAPON_MORE);
  my_keyboard->SetKeyAction(SDLK_PAGEDOWN,  Action::ACTION_WEAPON_LESS);
  my_keyboard->SetKeyAction(SDLK_s,         Action::ACTION_CHAT);

}

Here is the call graph for this function:

Here is the caller graph for this function:

void Config::SetScrollOnBorder

(

bool

sob

)

Definition at line 465 of file config.cpp.

{
  scroll_on_border = sob;
}

Here is the caller graph for this function:

---

Member Data Documentation

const int Config::ALPHA = 0 [static]

Definition at line 48 of file config.h.

const int Config::COLORKEY = 1 [static]

Definition at line 49 of file config.h.

std::string Config::data_dir [protected]

Definition at line 116 of file config.h.

bool Config::default_mouse_cursor [protected]

Definition at line 122 of file config.h.

bool Config::display_energy_character [protected]

Definition at line 119 of file config.h.

bool Config::display_name_character [protected]

Definition at line 120 of file config.h.

bool Config::display_wind_particles [protected]

Definition at line 121 of file config.h.

bool Config::exterieur_monde_vide [protected]

Definition at line 118 of file config.h.

std::string Config::locale_dir [protected]

Definition at line 116 of file config.h.

std::string Config::m_filename [protected]

Definition at line 114 of file config.h.

std::string Config::m_game_mode [protected]

Definition at line 112 of file config.h.

bool Config::m_xml_loaded [protected]

Definition at line 113 of file config.h.

Keyboard* Config::my_keyboard [private]

Definition at line 131 of file config.h.

WeaponsList* Config::my_weapons_list [private]

Definition at line 132 of file config.h.

std::string Config::personal_dir [protected]

Definition at line 116 of file config.h.

bool Config::scroll_on_border [protected]

Definition at line 123 of file config.h.

Config * Config::singleton = NULL [static, private]

Definition at line 133 of file config.h.

struct Config::tmp_xml_config Config::tmp

int Config::transparency [protected]

Definition at line 126 of file config.h.

std::string Config::ttf_filename [protected]

Definition at line 124 of file config.h.

---

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

• src/game/config.h
• src/game/config.cpp

---