]> git.localhorst.tv Git - l2e.git/blobdiff - src/loader/Interpreter.cpp
added textual type/field descriptions and wiki mode
[l2e.git] / src / loader / Interpreter.cpp
index 42fb1216d18e207d4e20c843fd2856a0dde15bc4..a3d382ceba7618f9f1782bf718c1cf49293753be 100644 (file)
@@ -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"
 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));
@@ -107,7 +112,26 @@ void Interpreter::ReadDefinition(const Definition &dfn) {
 }
 
 void Interpreter::ReadLiteral(const Definition &dfn) {
-       switch (dfn.GetLiteral()->GetType()) {
+       const string &typeName(dfn.GetLiteral()->IsArray() ? "Array" : dfn.GetLiteral()->GetTypeName());
+       int typeId(TypeDescription::GetTypeId(typeName));
+       int id(values[typeId].size());
+       const TypeDescription &td(TypeDescription::Get(typeId));
+       int size(
+                       (dfn.GetLiteral()->GetType() == Literal::PATH
+                                       || dfn.GetLiteral()->GetType() == Literal::STRING)
+                       ? dfn.GetLiteral()->GetString().size() : td.Size());
+       char *object(new char[size]);
+       if (dfn.GetLiteral()->GetType() == Literal::OBJECT) {
+               ReadObject(typeId, id, object, *dfn.GetLiteral()->GetProperties());
+       } else {
+               ReadLiteral(typeId, id, object, *dfn.GetLiteral());
+       }
+       values[typeId].push_back(object);
+       parsedDefinitions.insert(make_pair(dfn.Identifier(), ParsedDefinition(&dfn, typeId, id)));
+}
+
+void Interpreter::ReadLiteral(int typeId, int id, char *object, const Literal &literal) {
+       switch (literal.GetType()) {
                case Literal::ARRAY_VALUES:
                        throw Error("named value arrays are not supported, sorry");
                        break;
@@ -115,55 +139,27 @@ void Interpreter::ReadLiteral(const Definition &dfn) {
                        throw Error("named property list arrays are not supported, sorry");
                        break;
                case Literal::BOOLEAN:
-                       {
-                               int typeId(TypeDescription::GetTypeId("Boolean"));
-                               values[typeId].push_back(new bool(dfn.GetLiteral()->GetBoolean()));
-                               parsedDefinitions.insert(make_pair(dfn.Identifier(), ParsedDefinition(&dfn, typeId, values[typeId].size() - 1)));
-                       }
+                       new (object) bool(literal.GetBoolean());
                        break;
                case Literal::COLOR:
-                       {
-                               int typeId(TypeDescription::GetTypeId("Color"));
-                               values[typeId].push_back(new Color(dfn.GetLiteral()->GetRed(), dfn.GetLiteral()->GetGreen(), dfn.GetLiteral()->GetBlue(), dfn.GetLiteral()->GetAlpha()));
-                               parsedDefinitions.insert(make_pair(dfn.Identifier(), ParsedDefinition(&dfn, typeId, values[typeId].size() - 1)));
-                       }
+                       new (object) Color(literal.GetRed(), literal.GetGreen(), literal.GetBlue(), literal.GetAlpha());
                        break;
                case Literal::NUMBER:
-                       {
-                               int typeId(TypeDescription::GetTypeId("Number"));
-                               values[typeId].push_back(new int(dfn.GetLiteral()->GetNumber()));
-                               parsedDefinitions.insert(make_pair(dfn.Identifier(), ParsedDefinition(&dfn, typeId, values[typeId].size() - 1)));
-                       }
+                       new (object) int(literal.GetNumber());
                        break;
                case Literal::PATH:
-                       {
-                               int typeId(TypeDescription::GetTypeId("Path"));
-                               char *str(new char[dfn.GetLiteral()->GetString().size() + 1]);
-                               std::memcpy(str, dfn.GetLiteral()->GetString().c_str(), dfn.GetLiteral()->GetString().size());
-                               str[dfn.GetLiteral()->GetString().size()] = '\0';
-                               values[typeId].push_back(str);
-                               parsedDefinitions.insert(make_pair(dfn.Identifier(), ParsedDefinition(&dfn, typeId, values[typeId].size() - 1)));
-                       }
+                       std::memcpy(object, literal.GetString().c_str(), literal.GetString().size());
+                       object[literal.GetString().size()] = '\0';
                        break;
                case Literal::STRING:
-                       {
-                               int typeId(TypeDescription::GetTypeId("String"));
-                               char *str(new char[dfn.GetLiteral()->GetString().size() + 1]);
-                               std::memcpy(str, dfn.GetLiteral()->GetString().c_str(), dfn.GetLiteral()->GetString().size());
-                               str[dfn.GetLiteral()->GetString().size()] = '\0';
-                               values[typeId].push_back(str);
-                               parsedDefinitions.insert(make_pair(dfn.Identifier(), ParsedDefinition(&dfn, typeId, values[typeId].size() - 1)));
-                       }
+                       std::memcpy(object, literal.GetString().c_str(), literal.GetString().size());
+                       object[literal.GetString().size()] = '\0';
                        break;
                case Literal::VECTOR:
-                       {
-                               int typeId(TypeDescription::GetTypeId("Vector"));
-                               values[typeId].push_back(new Vector<int>(dfn.GetLiteral()->GetX(), dfn.GetLiteral()->GetY()));
-                               parsedDefinitions.insert(make_pair(dfn.Identifier(), ParsedDefinition(&dfn, typeId, values[typeId].size() - 1)));
-                       }
+                       new (object) Vector<int>(literal.GetX(), literal.GetY());
                        break;
                case Literal::OBJECT:
-                       ReadObject(dfn);
+                       throw Error("illogical branch: read literal object as non-object literal");
                        break;
        }
 }
@@ -175,6 +171,7 @@ void *Interpreter::GetObject(int typeId, const Value &v) {
                        int typeId(TypeDescription::GetTypeId(v.GetLiteral().GetTypeName()));
                        const TypeDescription &td(TypeDescription::Get(typeId));
                        char *object(new char[td.Size()]);
+                       td.Construct(object);
                        int id(values[typeId].size());
                        values[typeId].push_back(object);
                        ReadObject(typeId, id, object, *v.GetLiteral().GetProperties());
@@ -250,6 +247,7 @@ void *Interpreter::GetObject(int typeId, const Value &v) {
                                                const TypeDescription &td(TypeDescription::Get(typeId));
                                                id = values[typeId].size();
                                                char *object(new char[td.Size()]);
+                                               td.Construct(object);
                                                ReadObject(typeId, id, object, *v.GetLiteral().GetProperties());
                                        }
                                        break;
@@ -268,6 +266,7 @@ void Interpreter::ReadObject(const Definition &dfn) {
        const TypeDescription &td(TypeDescription::Get(typeId));
        int id(values[typeId].size());
        char *object(new char[td.Size()]);
+       td.Construct(object);
        values[typeId].push_back(object);
        ReadObject(typeId, id, object, *dfn.GetProperties());
        parsedDefinitions.insert(make_pair(dfn.Identifier(), ParsedDefinition(&dfn, typeId, id)));
@@ -282,15 +281,21 @@ void Interpreter::ReadObject(int typeId, int id, char *object, const PropertyLis
                if (CanLink(*i->second)) {
                        char *dest(object + fd.Offset());
                        if (fd.IsAggregate()) {
-                               if (i->second->GetLiteral().GetType() != Literal::ARRAY_PROPS) {
-                                       throw Error("unsupported aggregate type");
-                               }
                                int arraySize(i->second->GetLiteral().ArraySize());
                                char *aggregate(new char[fieldType.Size() * arraySize]);
                                char *iter(aggregate);
-                               vector<PropertyList *> list(i->second->GetLiteral().GetPropertyLists());
-                               for (vector<PropertyList *>::const_iterator j(list.begin()), end(list.end()); j != end; ++j, iter += fieldType.Size()) {
-                                       ReadObject(fieldType.TypeId(), -1, iter, **j);
+                               if (i->second->GetLiteral().GetType() == Literal::ARRAY_PROPS) {
+                                       const vector<PropertyList *> &list(i->second->GetLiteral().GetPropertyLists());
+                                       for (vector<PropertyList *>::const_iterator j(list.begin()), end(list.end()); j != end; ++j, iter += fieldType.Size()) {
+                                               fieldType.Construct(iter);
+                                               ReadObject(fieldType.TypeId(), -1, iter, **j);
+                                       }
+                               } else {
+                                       const vector<Value *> &list(i->second->GetLiteral().GetValues());
+                                       for (vector<Value *>::const_iterator j(list.begin()), end(list.end()); j != end; ++j, iter += fieldType.Size()) {
+                                               fieldType.Construct(iter);
+                                               ReadLiteral(fieldType.TypeId(), -1, iter, (*j)->GetLiteral());
+                                       }
                                }
                                if (fd.IsReferenced()) {
                                        std::memcpy(dest, &aggregate, sizeof(char *));
@@ -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>));
        }
 }