added textual type/field descriptions and wiki mode

[l2e.git] / src / loader / Interpreter.cpp

diff --git a/src/loader/Interpreter.cpp b/src/loader/Interpreter.cpp
index 550be2678f7e75f175b9a187a50080079d911a70..a3d382ceba7618f9f1782bf718c1cf49293753be 100644 (file)
--- a/src/loader/Interpreter.cpp
+++ b/src/loader/Interpreter.cpp
@@ -15,6 +15,7 @@
 #include "../common/Ikari.h"
 #include "../common/Item.h"
 #include "../common/Spell.h"
+#include "../common/Stats.h"
 #include "../common/TargetingMode.h"
 #include "../graphics/ComplexAnimation.h"
 #include "../graphics/Font.h"
@@ -31,10 +32,10 @@
 using battle::Hero;
 using battle::Monster;
 using battle::PartyLayout;
-using battle::Stats;
 using common::Ikari;
 using common::Item;
 using common::Spell;
+using common::Stats;
 using common::TargetingMode;
 using graphics::Animation;
 using graphics::Color;
@@ -46,7 +47,6 @@ using graphics::SimpleAnimation;
 using graphics::Sprite;
 using geometry::Vector;
 using std::make_pair;
-using std::map;
 using std::set;
 using std::string;
 using std::vector;
@@ -57,11 +57,11 @@ Interpreter::~Interpreter() {
        for (vector<PostponedDefinition>::const_iterator i(postponedDefinitions.begin()), end(postponedDefinitions.end()); i != end; ++i) {
                delete i->identifier;
        }
-       for (map<string, SDL_Surface *>::const_iterator i(imageCache.begin()), end(imageCache.end()); i != end; ++i) {
+       for (std::map<string, SDL_Surface *>::const_iterator i(imageCache.begin()), end(imageCache.end()); i != end; ++i) {
                SDL_FreeSurface(i->second);
        }
        // TODO: maybe need to reverse the array deletion check if most objects turn out to be arrays (of char)
-       for (map<int, vector<void *> >::const_iterator i(values.begin()), end(values.end()); i != end; ++i) {
+       for (std::map<int, vector<void *> >::const_iterator i(values.begin()), end(values.end()); i != end; ++i) {
                for (vector<void *>::const_iterator j(i->second.begin()), end(i->second.end()); j != end; ++j) {
                        delete[] reinterpret_cast<char *>(*j);
                }
@@ -69,8 +69,13 @@ Interpreter::~Interpreter() {
 }
 
 
+const Interpreter::ParsedDefinition &Interpreter::GetDefinition(const string &identifier) const {
+       return parsedDefinitions.at(identifier);
+}
+
+
 void *Interpreter::GetObject(int typeId, const std::string &name) {
-       map<string, ParsedDefinition>::const_iterator i(parsedDefinitions.find(name));
+       std::map<string, ParsedDefinition>::const_iterator i(parsedDefinitions.find(name));
        if (i != parsedDefinitions.end()) {
                const TypeDescription &requested(TypeDescription::Get(typeId));
                const TypeDescription &actual(TypeDescription::Get(i->second.type));
@@ -301,6 +306,9 @@ void Interpreter::ReadObject(int typeId, int id, char *object, const PropertyLis
                                }
                        } else {
                                char *src(reinterpret_cast<char *>(GetObject(fd.TypeId(), *i->second)));
+                               if (fd.TypeId() == TypeDescription::GetTypeId("Image")) {
+                                       src = reinterpret_cast<char *>(GetImage(src));
+                               }
                                if (fd.IsReferenced()) {
                                        std::memcpy(dest, &src, sizeof(char *));
                                } else {
@@ -308,9 +316,22 @@ void Interpreter::ReadObject(int typeId, int id, char *object, const PropertyLis
                                }
                        }
                } else {
-                       Postpone(typeId, id, fd.Offset(), i->second->GetIdentifier(), fd.TypeId());
+                       Postpone(typeId, id, fd.Offset(), i->second->GetIdentifier(), fd.TypeId(), !fd.IsReferenced());
                }
        }
+       td.Load(object);
+}
+
+
+SDL_Surface *Interpreter::GetImage(const string &path) {
+       std::map<string, SDL_Surface *>::const_iterator result(imageCache.find(path));
+       if (result != imageCache.end()) {
+               return result->second;
+       } else {
+               SDL_Surface *image(IMG_Load(path.c_str()));
+               imageCache.insert(make_pair(path, image));
+               return image;
+       }
 }
 
 
@@ -318,43 +339,53 @@ bool Interpreter::CanLink(const Value &v) const {
        return v.IsLiteral() || source.IsDefined(v.GetIdentifier());
 }
 
-void Interpreter::Postpone(int type, int id, std::ptrdiff_t offset, const std::string &identifier, int linkedType) {
+void Interpreter::Postpone(int type, int id, std::ptrdiff_t offset, const std::string &identifier, int linkedType, bool inlined) {
        char *str(new char[identifier.size() + 1]);
        std::memcpy(str, identifier.c_str(), identifier.size());
        str[identifier.size()] = '\0';
-       postponedDefinitions.push_back(PostponedDefinition(type, id, offset, str, linkedType));
+       postponedDefinitions.push_back(PostponedDefinition(type, id, offset, str, linkedType, inlined));
 }
 
 
 void Interpreter::CreateTypeDescriptions() {
        {
                TypeDescription &td(TypeDescription::CreateOrGet("Boolean"));
+               td.SetDescription("Logical value which can be either true or false.");
                td.SetSize(sizeof(bool));
        }
        {
                TypeDescription &td(TypeDescription::CreateOrGet("Color"));
+               td.SetDescription(
+                               "A color in RGB format with an optional alpha channel.\n"
+                               "Components range from 0 to 255.\n"
+                               "Alpha defaults to 255 if omitted.");
                td.SetSize(sizeof(Color));
        }
        {
                TypeDescription &td(TypeDescription::CreateOrGet("Image"));
+               td.SetDescription("Path to a PNG file with image data.");
                td.SetSize(sizeof(SDL_Surface));
        }
        {
                TypeDescription &td(TypeDescription::CreateOrGet("Number"));
+               td.SetDescription("A signed integer.");
                td.SetSize(sizeof(int));
        }
        {
                int stringId(TypeDescription::GetTypeId("String"));
                TypeDescription &td(TypeDescription::CreateOrGet("Path"));
+               td.SetDescription("A path in the filesystem which is interpreted relative to the source file's location.");
                td.SetSize(1);
                td.AddSupertype(stringId, 0);
        }
        {
                TypeDescription &td(TypeDescription::CreateOrGet("String"));
+               td.SetDescription("Some characters.");
                td.SetSize(1);
        }
        {
                TypeDescription &td(TypeDescription::CreateOrGet("Vector"));
+               td.SetDescription("A pair of numbers usually describing a 2D translation or offset.");
                td.SetSize(sizeof(Vector<int>));
        }
 }