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