Moved parsing of specials.xml from gui/specialswindow.cpp to separate source files.

Restored functional recharge bars in specials window.

Individual specials are only shown after the server informed the client about their status.

Made level label, use button and progress bars optional. Their use is controlled through specials.xml.

The special window button is again shown even when the player has no specials. This problem needs to be solved differently now for architecture reasons.

Reviewed-by: Jaxad0127

2 files changed, 204 insertions, 0 deletions

diff --git a/src/resources/specialdb.cpp b/src/resources/specialdb.cpp
new file mode 100644
index 00000000..ac591c4f
--- /dev/null
+++ b/src/resources/specialdb.cpp
@@ -0,0 +1,132 @@
+/*
+ *  The Mana Client
+ *  Copyright (C) 2010  The Mana Developers
+ *
+ *  This file is part of The Mana Client.
+ *
+ *  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; either version 2 of the License, or
+ *  any later version.
+ *
+ *  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 for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "resources/specialdb.h"
+
+#include "log.h"
+
+#include "utils/dtor.h"
+#include "utils/xml.h"
+
+
+namespace
+{
+    SpecialInfos mSpecialInfos;
+    bool mLoaded = false;
+}
+
+SpecialInfo::TargetMode SpecialDB::targetModeFromString(const std::string& str)
+{
+    if      (str=="self")   return SpecialInfo::TARGET_SELF;
+    else if (str=="friend") return SpecialInfo::TARGET_FRIEND;
+    else if (str=="enemy")  return SpecialInfo::TARGET_ENEMY;
+    else if (str=="being")  return SpecialInfo::TARGET_BEING;
+    else if (str=="point")  return SpecialInfo::TARGET_POINT;
+
+    logger->log("SpecialDB: Warning, unknown target mode \"%s\"", str.c_str() );
+    return SpecialInfo::TARGET_SELF;
+}
+
+void SpecialDB::load()
+{
+    if (mLoaded)
+        unload();
+
+    logger->log("Initializing special database...");
+
+    XML::Document doc("specials.xml");
+    xmlNodePtr root = doc.rootNode();
+
+    if (!root || !xmlStrEqual(root->name, BAD_CAST "specials"))
+    {
+        logger->log("Error loading specials file specials.xml");
+        return;
+    }
+
+    std::string setName;
+
+    for_each_xml_child_node(set, root)
+    {
+        if (xmlStrEqual(set->name, BAD_CAST "set"))
+        {
+            setName = XML::getProperty(set, "name", "Actions");
+
+
+            for_each_xml_child_node(special, set)
+            {
+                if (xmlStrEqual(special->name, BAD_CAST "special"))
+                {
+                    SpecialInfo *info = new SpecialInfo();
+                    int id = XML::getProperty(special, "id", 0);
+                    info->id = id;
+                    info->set = setName;
+                    info->name = XML::getProperty(special, "name", "");
+                    info->icon = XML::getProperty(special, "icon", "");
+
+                    info->isActive = XML::getBoolProperty(special, "active", false);
+                    info->targetMode = targetModeFromString(XML::getProperty(special, "target", "self"));
+
+                    info->level = XML::getProperty(special, "level", -1);
+                    info->hasLevel = info->level > -1;
+
+                    info->hasRechargeBar = XML::getBoolProperty(special, "recharge", false);
+                    info->rechargeNeeded = 0;
+                    info->rechargeCurrent = 0;
+
+                    if (mSpecialInfos.find(id) != mSpecialInfos.end())
+                    {
+                        logger->log("SpecialDB: Duplicate special ID %d (ignoring)", id);
+                    } else {
+                        mSpecialInfos[id] = info;
+                    }
+                }
+            }
+        }
+    }
+
+    mLoaded = true;
+}
+
+void SpecialDB::unload()
+{
+
+    delete_all(mSpecialInfos);
+    mSpecialInfos.clear();
+
+    mLoaded = false;
+}
+
+
+SpecialInfo *SpecialDB::get(int id)
+{
+
+    SpecialInfos::iterator i = mSpecialInfos.find(id);
+
+    if (i == mSpecialInfos.end())
+    {
+        return NULL;
+    }
+    else
+    {
+        return i->second;
+    }
+    return NULL;
+}
+
diff --git a/src/resources/specialdb.h b/src/resources/specialdb.h
new file mode 100644
index 00000000..38612c2a
--- /dev/null
+++ b/src/resources/specialdb.h
@@ -0,0 +1,72 @@
+/*
+ *  The Mana Client
+ *  Copyright (C) 2010  The Mana Developers
+ *
+ *  This file is part of The Mana Client.
+ *
+ *  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; either version 2 of the License, or
+ *  any later version.
+ *
+ *  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 for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef SPECIAL_DB_H
+#define SPECIAL_DB_H
+
+#include <string>
+#include <map>
+
+struct SpecialInfo
+{
+    enum TargetMode
+    {
+        TARGET_SELF,    // no target selection
+        TARGET_FRIEND,  // target friendly being
+        TARGET_ENEMY,   // target hostile being
+        TARGET_BEING,   // target any being
+        TARGET_POINT    // target map location
+    };
+    int id;
+    std::string set; // tab on which the special is shown
+    std::string name; // displayed name of special
+    std::string icon; // filename of graphical icon
+
+    bool isActive; // true when the special can be used
+    TargetMode targetMode; // target mode
+
+    bool hasLevel; // true when the special has levels
+    int level; // level of special when applicable
+
+    bool hasRechargeBar; // true when the special has a recharge bar
+    int rechargeNeeded; // maximum recharge when applicable
+    int rechargeCurrent; // current recharge when applicable
+};
+
+/**
+ * Special information database.
+ */
+namespace SpecialDB
+{
+    void load();
+
+    void unload();
+
+    /** gets the special info for ID. Will return 0 when it is
+     *  a server-specific special.
+     */
+    SpecialInfo *get(int id);
+
+    SpecialInfo::TargetMode targetModeFromString(const std::string& str);
+}
+
+typedef std::map<int, SpecialInfo *> SpecialInfos;
+
+#endif