src/itemdef.cpp

   1 /*
   2 Minetest
   3 Copyright (C) 2010-2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4 Copyright (C) 2013 Kahrl <kahrl@gmx.net>
   5
   6 This program is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU Lesser General Public License as published by
   8 the Free Software Foundation; either version 2.1 of the License, or
   9 (at your option) any later version.
  10
  11 This program is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU Lesser General Public License for more details.
  15
  16 You should have received a copy of the GNU Lesser General Public License along
  17 with this program; if not, write to the Free Software Foundation, Inc.,
  18 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  19 */
  20
  21 #include "itemdef.h"
  22
  23 #include "nodedef.h"
  24 #include "tool.h"
  25 #include "inventory.h"
  26 #ifndef SERVER
  27 #include "client/mapblock_mesh.h"
  28 #include "client/mesh.h"
  29 #include "client/wieldmesh.h"
  30 #include "client/tile.h"
  31 #include "client/client.h"
  32 #endif
  33 #include "log.h"
  34 #include "settings.h"
  35 #include "util/serialize.h"
  36 #include "util/container.h"
  37 #include "util/thread.h"
  38 #include <map>
  39 #include <set>
  40
  41 /*
  42         ItemDefinition
  43 */
  44 ItemDefinition::ItemDefinition()
  45 {
  46         resetInitial();
  47 }
  48
  49 ItemDefinition::ItemDefinition(const ItemDefinition &def)
  50 {
  51         resetInitial();
  52         *this = def;
  53 }
  54
  55 ItemDefinition& ItemDefinition::operator=(const ItemDefinition &def)
  56 {
  57         if(this == &def)
  58                 return *this;
  59
  60         reset();
  61
  62         type = def.type;
  63         name = def.name;
  64         description = def.description;
  65         inventory_image = def.inventory_image;
  66         inventory_overlay = def.inventory_overlay;
  67         wield_image = def.wield_image;
  68         wield_overlay = def.wield_overlay;
  69         wield_scale = def.wield_scale;
  70         stack_max = def.stack_max;
  71         usable = def.usable;
  72         liquids_pointable = def.liquids_pointable;
  73         if(def.tool_capabilities)
  74         {
  75                 tool_capabilities = new ToolCapabilities(
  76                                 *def.tool_capabilities);
  77         }
  78         groups = def.groups;
  79         node_placement_prediction = def.node_placement_prediction;
  80         sound_place = def.sound_place;
  81         sound_place_failed = def.sound_place_failed;
  82         range = def.range;
  83         palette_image = def.palette_image;
  84         color = def.color;
  85         return *this;
  86 }
  87
  88 ItemDefinition::~ItemDefinition()
  89 {
  90         reset();
  91 }
  92
  93 void ItemDefinition::resetInitial()
  94 {
  95         // Initialize pointers to NULL so reset() does not delete undefined pointers
  96         tool_capabilities = NULL;
  97         reset();
  98 }
  99
 100 void ItemDefinition::reset()
 101 {
 102         type = ITEM_NONE;
 103         name = "";
 104         description = "";
 105         inventory_image = "";
 106         inventory_overlay = "";
 107         wield_image = "";
 108         wield_overlay = "";
 109         palette_image = "";
 110         color = video::SColor(0xFFFFFFFF);
 111         wield_scale = v3f(1.0, 1.0, 1.0);
 112         stack_max = 99;
 113         usable = false;
 114         liquids_pointable = false;
 115         delete tool_capabilities;
 116         tool_capabilities = NULL;
 117         groups.clear();
 118         sound_place = SimpleSoundSpec();
 119         sound_place_failed = SimpleSoundSpec();
 120         range = -1;
 121
 122         node_placement_prediction = "";
 123 }
 124
 125 void ItemDefinition::serialize(std::ostream &os, u16 protocol_version) const
 126 {
 127         // protocol_version >= 37
 128         u8 version = 6;
 129         writeU8(os, version);
 130         writeU8(os, type);
 131         os << serializeString(name);
 132         os << serializeString(description);
 133         os << serializeString(inventory_image);
 134         os << serializeString(wield_image);
 135         writeV3F32(os, wield_scale);
 136         writeS16(os, stack_max);
 137         writeU8(os, usable);
 138         writeU8(os, liquids_pointable);
 139
 140         std::string tool_capabilities_s;
 141         if (tool_capabilities) {
 142                 std::ostringstream tmp_os(std::ios::binary);
 143                 tool_capabilities->serialize(tmp_os, protocol_version);
 144                 tool_capabilities_s = tmp_os.str();
 145         }
 146         os << serializeString(tool_capabilities_s);
 147
 148         writeU16(os, groups.size());
 149         for (const auto &group : groups) {
 150                 os << serializeString(group.first);
 151                 writeS16(os, group.second);
 152         }
 153
 154         os << serializeString(node_placement_prediction);
 155
 156         // Version from ContentFeatures::serialize to keep in sync
 157         sound_place.serialize(os, CONTENTFEATURES_VERSION);
 158         sound_place_failed.serialize(os, CONTENTFEATURES_VERSION);
 159
 160         writeF32(os, range);
 161         os << serializeString(palette_image);
 162         writeARGB8(os, color);
 163         os << serializeString(inventory_overlay);
 164         os << serializeString(wield_overlay);
 165 }
 166
 167 void ItemDefinition::deSerialize(std::istream &is)
 168 {
 169         // Reset everything
 170         reset();
 171
 172         // Deserialize
 173         int version = readU8(is);
 174         if (version < 6)
 175                 throw SerializationError("unsupported ItemDefinition version");
 176
 177         type = (enum ItemType)readU8(is);
 178         name = deSerializeString(is);
 179         description = deSerializeString(is);
 180         inventory_image = deSerializeString(is);
 181         wield_image = deSerializeString(is);
 182         wield_scale = readV3F32(is);
 183         stack_max = readS16(is);
 184         usable = readU8(is);
 185         liquids_pointable = readU8(is);
 186
 187         std::string tool_capabilities_s = deSerializeString(is);
 188         if (!tool_capabilities_s.empty()) {
 189                 std::istringstream tmp_is(tool_capabilities_s, std::ios::binary);
 190                 tool_capabilities = new ToolCapabilities;
 191                 tool_capabilities->deSerialize(tmp_is);
 192         }
 193
 194         groups.clear();
 195         u32 groups_size = readU16(is);
 196         for(u32 i=0; i<groups_size; i++){
 197                 std::string name = deSerializeString(is);
 198                 int value = readS16(is);
 199                 groups[name] = value;
 200         }
 201
 202         node_placement_prediction = deSerializeString(is);
 203
 204         // Version from ContentFeatures::serialize to keep in sync
 205         sound_place.deSerialize(is, CONTENTFEATURES_VERSION);
 206         sound_place_failed.deSerialize(is, CONTENTFEATURES_VERSION);
 207
 208         range = readF32(is);
 209         palette_image = deSerializeString(is);
 210         color = readARGB8(is);
 211         inventory_overlay = deSerializeString(is);
 212         wield_overlay = deSerializeString(is);
 213
 214         // If you add anything here, insert it primarily inside the try-catch
 215         // block to not need to increase the version.
 216         //try {
 217         //} catch(SerializationError &e) {};
 218 }
 219
 220
 221 /*
 222         CItemDefManager
 223 */
 224
 225 // SUGG: Support chains of aliases?
 226
 227 class CItemDefManager: public IWritableItemDefManager
 228 {
 229 #ifndef SERVER
 230         struct ClientCached
 231         {
 232                 video::ITexture *inventory_texture;
 233                 ItemMesh wield_mesh;
 234                 Palette *palette;
 235
 236                 ClientCached():
 237                         inventory_texture(NULL),
 238                         palette(NULL)
 239                 {}
 240         };
 241 #endif
 242
 243 public:
 244         CItemDefManager()
 245         {
 246
 247 #ifndef SERVER
 248                 m_main_thread = std::this_thread::get_id();
 249 #endif
 250                 clear();
 251         }
 252         virtual ~CItemDefManager()
 253         {
 254 #ifndef SERVER
 255                 const std::vector<ClientCached*> &values = m_clientcached.getValues();
 256                 for (ClientCached *cc : values) {
 257                         if (cc->wield_mesh.mesh)
 258                                 cc->wield_mesh.mesh->drop();
 259                         delete cc;
 260                 }
 261
 262 #endif
 263                 for (auto &item_definition : m_item_definitions) {
 264                         delete item_definition.second;
 265                 }
 266                 m_item_definitions.clear();
 267         }
 268         virtual const ItemDefinition& get(const std::string &name_) const
 269         {
 270                 // Convert name according to possible alias
 271                 std::string name = getAlias(name_);
 272                 // Get the definition
 273                 std::map<std::string, ItemDefinition*>::const_iterator i;
 274                 i = m_item_definitions.find(name);
 275                 if(i == m_item_definitions.end())
 276                         i = m_item_definitions.find("unknown");
 277                 assert(i != m_item_definitions.end());
 278                 return *(i->second);
 279         }
 280         virtual const std::string &getAlias(const std::string &name) const
 281         {
 282                 StringMap::const_iterator it = m_aliases.find(name);
 283                 if (it != m_aliases.end())
 284                         return it->second;
 285                 return name;
 286         }
 287         virtual void getAll(std::set<std::string> &result) const
 288         {
 289                 result.clear();
 290                 for (const auto &item_definition : m_item_definitions) {
 291                         result.insert(item_definition.first);
 292                 }
 293
 294                 for (const auto &alias : m_aliases) {
 295                         result.insert(alias.first);
 296                 }
 297         }
 298         virtual bool isKnown(const std::string &name_) const
 299         {
 300                 // Convert name according to possible alias
 301                 std::string name = getAlias(name_);
 302                 // Get the definition
 303                 std::map<std::string, ItemDefinition*>::const_iterator i;
 304                 return m_item_definitions.find(name) != m_item_definitions.end();
 305         }
 306 #ifndef SERVER
 307 public:
 308         ClientCached* createClientCachedDirect(const std::string &name,
 309                         Client *client) const
 310         {
 311                 infostream<<"Lazily creating item texture and mesh for \""
 312                                 <<name<<"\""<<std::endl;
 313
 314                 // This is not thread-safe
 315                 sanity_check(std::this_thread::get_id() == m_main_thread);
 316
 317                 // Skip if already in cache
 318                 ClientCached *cc = NULL;
 319                 m_clientcached.get(name, &cc);
 320                 if(cc)
 321                         return cc;
 322
 323                 ITextureSource *tsrc = client->getTextureSource();
 324                 const ItemDefinition &def = get(name);
 325
 326                 // Create new ClientCached
 327                 cc = new ClientCached();
 328
 329                 // Create an inventory texture
 330                 cc->inventory_texture = NULL;
 331                 if (!def.inventory_image.empty())
 332                         cc->inventory_texture = tsrc->getTexture(def.inventory_image);
 333
 334                 ItemStack item = ItemStack();
 335                 item.name = def.name;
 336
 337                 getItemMesh(client, item, &(cc->wield_mesh));
 338
 339                 cc->palette = tsrc->getPalette(def.palette_image);
 340
 341                 // Put in cache
 342                 m_clientcached.set(name, cc);
 343
 344                 return cc;
 345         }
 346         ClientCached* getClientCached(const std::string &name,
 347                         Client *client) const
 348         {
 349                 ClientCached *cc = NULL;
 350                 m_clientcached.get(name, &cc);
 351                 if (cc)
 352                         return cc;
 353
 354                 if (std::this_thread::get_id() == m_main_thread) {
 355                         return createClientCachedDirect(name, client);
 356                 }
 357
 358                 // We're gonna ask the result to be put into here
 359                 static ResultQueue<std::string, ClientCached*, u8, u8> result_queue;
 360
 361                 // Throw a request in
 362                 m_get_clientcached_queue.add(name, 0, 0, &result_queue);
 363                 try {
 364                         while(true) {
 365                                 // Wait result for a second
 366                                 GetResult<std::string, ClientCached*, u8, u8>
 367                                         result = result_queue.pop_front(1000);
 368
 369                                 if (result.key == name) {
 370                                         return result.item;
 371                                 }
 372                         }
 373                 } catch(ItemNotFoundException &e) {
 374                         errorstream << "Waiting for clientcached " << name
 375                                 << " timed out." << std::endl;
 376                         return &m_dummy_clientcached;
 377                 }
 378         }
 379         // Get item inventory texture
 380         virtual video::ITexture* getInventoryTexture(const std::string &name,
 381                         Client *client) const
 382         {
 383                 ClientCached *cc = getClientCached(name, client);
 384                 if(!cc)
 385                         return NULL;
 386                 return cc->inventory_texture;
 387         }
 388         // Get item wield mesh
 389         virtual ItemMesh* getWieldMesh(const std::string &name,
 390                         Client *client) const
 391         {
 392                 ClientCached *cc = getClientCached(name, client);
 393                 if(!cc)
 394                         return NULL;
 395                 return &(cc->wield_mesh);
 396         }
 397
 398         // Get item palette
 399         virtual Palette* getPalette(const std::string &name,
 400                         Client *client) const
 401         {
 402                 ClientCached *cc = getClientCached(name, client);
 403                 if(!cc)
 404                         return NULL;
 405                 return cc->palette;
 406         }
 407
 408         virtual video::SColor getItemstackColor(const ItemStack &stack,
 409                 Client *client) const
 410         {
 411                 // Look for direct color definition
 412                 const std::string &colorstring = stack.metadata.getString("color", 0);
 413                 video::SColor directcolor;
 414                 if (!colorstring.empty() && parseColorString(colorstring, directcolor, true))
 415                         return directcolor;
 416                 // See if there is a palette
 417                 Palette *palette = getPalette(stack.name, client);
 418                 const std::string &index = stack.metadata.getString("palette_index", 0);
 419                 if (palette && !index.empty())
 420                         return (*palette)[mystoi(index, 0, 255)];
 421                 // Fallback color
 422                 return get(stack.name).color;
 423         }
 424 #endif
 425         void clear()
 426         {
 427                 for(std::map<std::string, ItemDefinition*>::const_iterator
 428                                 i = m_item_definitions.begin();
 429                                 i != m_item_definitions.end(); ++i)
 430                 {
 431                         delete i->second;
 432                 }
 433                 m_item_definitions.clear();
 434                 m_aliases.clear();
 435
 436                 // Add the four builtin items:
 437                 //   "" is the hand
 438                 //   "unknown" is returned whenever an undefined item
 439                 //     is accessed (is also the unknown node)
 440                 //   "air" is the air node
 441                 //   "ignore" is the ignore node
 442
 443                 ItemDefinition* hand_def = new ItemDefinition;
 444                 hand_def->name = "";
 445                 hand_def->wield_image = "wieldhand.png";
 446                 hand_def->tool_capabilities = new ToolCapabilities;
 447                 m_item_definitions.insert(std::make_pair("", hand_def));
 448
 449                 ItemDefinition* unknown_def = new ItemDefinition;
 450                 unknown_def->type = ITEM_NODE;
 451                 unknown_def->name = "unknown";
 452                 m_item_definitions.insert(std::make_pair("unknown", unknown_def));
 453
 454                 ItemDefinition* air_def = new ItemDefinition;
 455                 air_def->type = ITEM_NODE;
 456                 air_def->name = "air";
 457                 m_item_definitions.insert(std::make_pair("air", air_def));
 458
 459                 ItemDefinition* ignore_def = new ItemDefinition;
 460                 ignore_def->type = ITEM_NODE;
 461                 ignore_def->name = "ignore";
 462                 m_item_definitions.insert(std::make_pair("ignore", ignore_def));
 463         }
 464         virtual void registerItem(const ItemDefinition &def)
 465         {
 466                 verbosestream<<"ItemDefManager: registering \""<<def.name<<"\""<<std::endl;
 467                 // Ensure that the "" item (the hand) always has ToolCapabilities
 468                 if (def.name.empty())
 469                         FATAL_ERROR_IF(!def.tool_capabilities, "Hand does not have ToolCapabilities");
 470
 471                 if(m_item_definitions.count(def.name) == 0)
 472                         m_item_definitions[def.name] = new ItemDefinition(def);
 473                 else
 474                         *(m_item_definitions[def.name]) = def;
 475
 476                 // Remove conflicting alias if it exists
 477                 bool alias_removed = (m_aliases.erase(def.name) != 0);
 478                 if(alias_removed)
 479                         infostream<<"ItemDefManager: erased alias "<<def.name
 480                                         <<" because item was defined"<<std::endl;
 481         }
 482         virtual void unregisterItem(const std::string &name)
 483         {
 484                 verbosestream<<"ItemDefManager: unregistering \""<<name<<"\""<<std::endl;
 485
 486                 delete m_item_definitions[name];
 487                 m_item_definitions.erase(name);
 488         }
 489         virtual void registerAlias(const std::string &name,
 490                         const std::string &convert_to)
 491         {
 492                 if (m_item_definitions.find(name) == m_item_definitions.end()) {
 493                         verbosestream<<"ItemDefManager: setting alias "<<name
 494                                 <<" -> "<<convert_to<<std::endl;
 495                         m_aliases[name] = convert_to;
 496                 }
 497         }
 498         void serialize(std::ostream &os, u16 protocol_version)
 499         {
 500                 writeU8(os, 0); // version
 501                 u16 count = m_item_definitions.size();
 502                 writeU16(os, count);
 503
 504                 for (std::map<std::string, ItemDefinition *>::const_iterator
 505                                 it = m_item_definitions.begin();
 506                                 it != m_item_definitions.end(); ++it) {
 507                         ItemDefinition *def = it->second;
 508                         // Serialize ItemDefinition and write wrapped in a string
 509                         std::ostringstream tmp_os(std::ios::binary);
 510                         def->serialize(tmp_os, protocol_version);
 511                         os << serializeString(tmp_os.str());
 512                 }
 513
 514                 writeU16(os, m_aliases.size());
 515
 516                 for (StringMap::const_iterator
 517                                 it = m_aliases.begin();
 518                                 it != m_aliases.end(); ++it) {
 519                         os << serializeString(it->first);
 520                         os << serializeString(it->second);
 521                 }
 522         }
 523         void deSerialize(std::istream &is)
 524         {
 525                 // Clear everything
 526                 clear();
 527                 // Deserialize
 528                 int version = readU8(is);
 529                 if(version != 0)
 530                         throw SerializationError("unsupported ItemDefManager version");
 531                 u16 count = readU16(is);
 532                 for(u16 i=0; i<count; i++)
 533                 {
 534                         // Deserialize a string and grab an ItemDefinition from it
 535                         std::istringstream tmp_is(deSerializeString(is), std::ios::binary);
 536                         ItemDefinition def;
 537                         def.deSerialize(tmp_is);
 538                         // Register
 539                         registerItem(def);
 540                 }
 541                 u16 num_aliases = readU16(is);
 542                 for(u16 i=0; i<num_aliases; i++)
 543                 {
 544                         std::string name = deSerializeString(is);
 545                         std::string convert_to = deSerializeString(is);
 546                         registerAlias(name, convert_to);
 547                 }
 548         }
 549         void processQueue(IGameDef *gamedef)
 550         {
 551 #ifndef SERVER
 552                 //NOTE this is only thread safe for ONE consumer thread!
 553                 while(!m_get_clientcached_queue.empty())
 554                 {
 555                         GetRequest<std::string, ClientCached*, u8, u8>
 556                                         request = m_get_clientcached_queue.pop();
 557
 558                         m_get_clientcached_queue.pushResult(request,
 559                                         createClientCachedDirect(request.key, (Client *)gamedef));
 560                 }
 561 #endif
 562         }
 563 private:
 564         // Key is name
 565         std::map<std::string, ItemDefinition*> m_item_definitions;
 566         // Aliases
 567         StringMap m_aliases;
 568 #ifndef SERVER
 569         // The id of the thread that is allowed to use irrlicht directly
 570         std::thread::id m_main_thread;
 571         // A reference to this can be returned when nothing is found, to avoid NULLs
 572         mutable ClientCached m_dummy_clientcached;
 573         // Cached textures and meshes
 574         mutable MutexedMap<std::string, ClientCached*> m_clientcached;
 575         // Queued clientcached fetches (to be processed by the main thread)
 576         mutable RequestQueue<std::string, ClientCached*, u8, u8> m_get_clientcached_queue;
 577 #endif
 578 };
 579
 580 IWritableItemDefManager* createItemDefManager()
 581 {
 582         return new CItemDefManager();
 583 }