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         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         wield_image = "";
 107         wield_scale = v3f(1.0, 1.0, 1.0);
 108         stack_max = 99;
 109         usable = false;
 110         liquids_pointable = false;
 111         if(tool_capabilities)
 112         {
 113                 delete tool_capabilities;
 114                 tool_capabilities = NULL;
 115         }
 116         groups.clear();
 117         sound_place = SimpleSoundSpec();
 118         sound_place_failed = SimpleSoundSpec();
 119         range = -1;
 120
 121         node_placement_prediction = "";
 122 }
 123
 124 void ItemDefinition::serialize(std::ostream &os, u16 protocol_version) const
 125 {
 126         if(protocol_version <= 17)
 127                 writeU8(os, 1); // version
 128         else if(protocol_version <= 20)
 129                 writeU8(os, 2); // version
 130         else
 131                 writeU8(os, 3); // version
 132         writeU8(os, type);
 133         os<<serializeString(name);
 134         os<<serializeString(description);
 135         os<<serializeString(inventory_image);
 136         os<<serializeString(wield_image);
 137         writeV3F1000(os, wield_scale);
 138         writeS16(os, stack_max);
 139         writeU8(os, usable);
 140         writeU8(os, liquids_pointable);
 141         std::string tool_capabilities_s = "";
 142         if(tool_capabilities){
 143                 std::ostringstream tmp_os(std::ios::binary);
 144                 tool_capabilities->serialize(tmp_os, protocol_version);
 145                 tool_capabilities_s = tmp_os.str();
 146         }
 147         os<<serializeString(tool_capabilities_s);
 148         writeU16(os, groups.size());
 149         for (ItemGroupList::const_iterator
 150                         i = groups.begin(); i != groups.end(); ++i){
 151                 os << serializeString(i->first);
 152                 writeS16(os, i->second);
 153         }
 154         os<<serializeString(node_placement_prediction);
 155         if(protocol_version > 17){
 156                 //serializeSimpleSoundSpec(sound_place, os);
 157                 os<<serializeString(sound_place.name);
 158                 writeF1000(os, sound_place.gain);
 159         }
 160         if (protocol_version > 20) {
 161                 writeF1000(os, range);
 162                 os << serializeString(sound_place_failed.name);
 163                 writeF1000(os, sound_place_failed.gain);
 164         }
 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 < 1 || version > 3)
 175                 throw SerializationError("unsupported ItemDefinition version");
 176         type = (enum ItemType)readU8(is);
 177         name = deSerializeString(is);
 178         description = deSerializeString(is);
 179         inventory_image = deSerializeString(is);
 180         wield_image = deSerializeString(is);
 181         wield_scale = readV3F1000(is);
 182         stack_max = readS16(is);
 183         usable = readU8(is);
 184         liquids_pointable = readU8(is);
 185         std::string tool_capabilities_s = deSerializeString(is);
 186         if(!tool_capabilities_s.empty())
 187         {
 188                 std::istringstream tmp_is(tool_capabilities_s, std::ios::binary);
 189                 tool_capabilities = new ToolCapabilities;
 190                 tool_capabilities->deSerialize(tmp_is);
 191         }
 192         groups.clear();
 193         u32 groups_size = readU16(is);
 194         for(u32 i=0; i<groups_size; i++){
 195                 std::string name = deSerializeString(is);
 196                 int value = readS16(is);
 197                 groups[name] = value;
 198         }
 199         if(version == 1){
 200                 // We cant be sure that node_placement_prediction is send in version 1
 201                 try{
 202                         node_placement_prediction = deSerializeString(is);
 203                 }catch(SerializationError &e) {};
 204                 // Set the old default sound
 205                 sound_place.name = "default_place_node";
 206                 sound_place.gain = 0.5;
 207         } else if(version >= 2) {
 208                 node_placement_prediction = deSerializeString(is);
 209                 //deserializeSimpleSoundSpec(sound_place, is);
 210                 sound_place.name = deSerializeString(is);
 211                 sound_place.gain = readF1000(is);
 212         }
 213         if(version == 3) {
 214                 range = readF1000(is);
 215         }
 216         // If you add anything here, insert it primarily inside the try-catch
 217         // block to not need to increase the version.
 218         try {
 219                 sound_place_failed.name = deSerializeString(is);
 220                 sound_place_failed.gain = readF1000(is);
 221         } catch(SerializationError &e) {};
 222 }
 223
 224 /*
 225         CItemDefManager
 226 */
 227
 228 // SUGG: Support chains of aliases?
 229
 230 class CItemDefManager: public IWritableItemDefManager
 231 {
 232 #ifndef SERVER
 233         struct ClientCached
 234         {
 235                 video::ITexture *inventory_texture;
 236                 scene::IMesh *wield_mesh;
 237
 238                 ClientCached():
 239                         inventory_texture(NULL),
 240                         wield_mesh(NULL)
 241                 {}
 242         };
 243 #endif
 244
 245 public:
 246         CItemDefManager()
 247         {
 248
 249 #ifndef SERVER
 250                 m_main_thread = thr_get_current_thread_id();
 251 #endif
 252                 clear();
 253         }
 254         virtual ~CItemDefManager()
 255         {
 256 #ifndef SERVER
 257                 const std::vector<ClientCached*> &values = m_clientcached.getValues();
 258                 for(std::vector<ClientCached*>::const_iterator
 259                                 i = values.begin(); i != values.end(); ++i)
 260                 {
 261                         ClientCached *cc = *i;
 262                         if (cc->wield_mesh)
 263                                 cc->wield_mesh->drop();
 264                         delete cc;
 265                 }
 266
 267 #endif
 268                 for (std::map<std::string, ItemDefinition*>::iterator iter =
 269                                 m_item_definitions.begin(); iter != m_item_definitions.end();
 270                                 ++iter) {
 271                         delete iter->second;
 272                 }
 273                 m_item_definitions.clear();
 274         }
 275         virtual const ItemDefinition& get(const std::string &name_) const
 276         {
 277                 // Convert name according to possible alias
 278                 std::string name = getAlias(name_);
 279                 // Get the definition
 280                 std::map<std::string, ItemDefinition*>::const_iterator i;
 281                 i = m_item_definitions.find(name);
 282                 if(i == m_item_definitions.end())
 283                         i = m_item_definitions.find("unknown");
 284                 assert(i != m_item_definitions.end());
 285                 return *(i->second);
 286         }
 287         virtual std::string getAlias(const std::string &name) const
 288         {
 289                 StringMap::const_iterator it = m_aliases.find(name);
 290                 if (it != m_aliases.end())
 291                         return it->second;
 292                 return name;
 293         }
 294         virtual std::set<std::string> getAll() const
 295         {
 296                 std::set<std::string> result;
 297                 for(std::map<std::string, ItemDefinition *>::const_iterator
 298                                 it = m_item_definitions.begin();
 299                                 it != m_item_definitions.end(); ++it) {
 300                         result.insert(it->first);
 301                 }
 302                 for (StringMap::const_iterator
 303                                 it = m_aliases.begin();
 304                                 it != m_aliases.end(); ++it) {
 305                         result.insert(it->first);
 306                 }
 307                 return result;
 308         }
 309         virtual bool isKnown(const std::string &name_) const
 310         {
 311                 // Convert name according to possible alias
 312                 std::string name = getAlias(name_);
 313                 // Get the definition
 314                 std::map<std::string, ItemDefinition*>::const_iterator i;
 315                 return m_item_definitions.find(name) != m_item_definitions.end();
 316         }
 317 #ifndef SERVER
 318 public:
 319         ClientCached* createClientCachedDirect(const std::string &name,
 320                         Client *client) const
 321         {
 322                 infostream<<"Lazily creating item texture and mesh for \""
 323                                 <<name<<"\""<<std::endl;
 324
 325                 // This is not thread-safe
 326                 sanity_check(thr_is_current_thread(m_main_thread));
 327
 328                 // Skip if already in cache
 329                 ClientCached *cc = NULL;
 330                 m_clientcached.get(name, &cc);
 331                 if(cc)
 332                         return cc;
 333
 334                 ITextureSource *tsrc = client->getTextureSource();
 335                 const ItemDefinition &def = get(name);
 336
 337                 // Create new ClientCached
 338                 cc = new ClientCached();
 339
 340                 // Create an inventory texture
 341                 cc->inventory_texture = NULL;
 342                 if(def.inventory_image != "")
 343                         cc->inventory_texture = tsrc->getTexture(def.inventory_image);
 344
 345                 ItemStack item = ItemStack();
 346                 item.name = def.name;
 347
 348                 scene::IMesh *mesh = getItemMesh(client, item);
 349                 cc->wield_mesh = mesh;
 350
 351                 // Put in cache
 352                 m_clientcached.set(name, cc);
 353
 354                 return cc;
 355         }
 356         ClientCached* getClientCached(const std::string &name,
 357                         Client *client) const
 358         {
 359                 ClientCached *cc = NULL;
 360                 m_clientcached.get(name, &cc);
 361                 if(cc)
 362                         return cc;
 363
 364                 if(thr_is_current_thread(m_main_thread))
 365                 {
 366                         return createClientCachedDirect(name, client);
 367                 }
 368                 else
 369                 {
 370                         // We're gonna ask the result to be put into here
 371                         static ResultQueue<std::string, ClientCached*, u8, u8> result_queue;
 372
 373                         // Throw a request in
 374                         m_get_clientcached_queue.add(name, 0, 0, &result_queue);
 375                         try{
 376                                 while(true) {
 377                                         // Wait result for a second
 378                                         GetResult<std::string, ClientCached*, u8, u8>
 379                                                 result = result_queue.pop_front(1000);
 380
 381                                         if (result.key == name) {
 382                                                 return result.item;
 383                                         }
 384                                 }
 385                         }
 386                         catch(ItemNotFoundException &e)
 387                         {
 388                                 errorstream<<"Waiting for clientcached " << name << " timed out."<<std::endl;
 389                                 return &m_dummy_clientcached;
 390                         }
 391                 }
 392         }
 393         // Get item inventory texture
 394         virtual video::ITexture* getInventoryTexture(const std::string &name,
 395                         Client *client) const
 396         {
 397                 ClientCached *cc = getClientCached(name, client);
 398                 if(!cc)
 399                         return NULL;
 400                 return cc->inventory_texture;
 401         }
 402         // Get item wield mesh
 403         virtual scene::IMesh* getWieldMesh(const std::string &name,
 404                         Client *client) const
 405         {
 406                 ClientCached *cc = getClientCached(name, client);
 407                 if(!cc)
 408                         return NULL;
 409                 return cc->wield_mesh;
 410         }
 411 #endif
 412         void clear()
 413         {
 414                 for(std::map<std::string, ItemDefinition*>::const_iterator
 415                                 i = m_item_definitions.begin();
 416                                 i != m_item_definitions.end(); ++i)
 417                 {
 418                         delete i->second;
 419                 }
 420                 m_item_definitions.clear();
 421                 m_aliases.clear();
 422
 423                 // Add the four builtin items:
 424                 //   "" is the hand
 425                 //   "unknown" is returned whenever an undefined item
 426                 //     is accessed (is also the unknown node)
 427                 //   "air" is the air node
 428                 //   "ignore" is the ignore node
 429
 430                 ItemDefinition* hand_def = new ItemDefinition;
 431                 hand_def->name = "";
 432                 hand_def->wield_image = "wieldhand.png";
 433                 hand_def->tool_capabilities = new ToolCapabilities;
 434                 m_item_definitions.insert(std::make_pair("", hand_def));
 435
 436                 ItemDefinition* unknown_def = new ItemDefinition;
 437                 unknown_def->type = ITEM_NODE;
 438                 unknown_def->name = "unknown";
 439                 m_item_definitions.insert(std::make_pair("unknown", unknown_def));
 440
 441                 ItemDefinition* air_def = new ItemDefinition;
 442                 air_def->type = ITEM_NODE;
 443                 air_def->name = "air";
 444                 m_item_definitions.insert(std::make_pair("air", air_def));
 445
 446                 ItemDefinition* ignore_def = new ItemDefinition;
 447                 ignore_def->type = ITEM_NODE;
 448                 ignore_def->name = "ignore";
 449                 m_item_definitions.insert(std::make_pair("ignore", ignore_def));
 450         }
 451         virtual void registerItem(const ItemDefinition &def)
 452         {
 453                 verbosestream<<"ItemDefManager: registering \""<<def.name<<"\""<<std::endl;
 454                 // Ensure that the "" item (the hand) always has ToolCapabilities
 455                 if(def.name == "")
 456                         FATAL_ERROR_IF(!def.tool_capabilities, "Hand does not have ToolCapabilities");
 457
 458                 if(m_item_definitions.count(def.name) == 0)
 459                         m_item_definitions[def.name] = new ItemDefinition(def);
 460                 else
 461                         *(m_item_definitions[def.name]) = def;
 462
 463                 // Remove conflicting alias if it exists
 464                 bool alias_removed = (m_aliases.erase(def.name) != 0);
 465                 if(alias_removed)
 466                         infostream<<"ItemDefManager: erased alias "<<def.name
 467                                         <<" because item was defined"<<std::endl;
 468         }
 469         virtual void unregisterItem(const std::string &name)
 470         {
 471                 verbosestream<<"ItemDefManager: unregistering \""<<name<<"\""<<std::endl;
 472
 473                 delete m_item_definitions[name];
 474                 m_item_definitions.erase(name);
 475         }
 476         virtual void registerAlias(const std::string &name,
 477                         const std::string &convert_to)
 478         {
 479                 if (m_item_definitions.find(name) == m_item_definitions.end()) {
 480                         verbosestream<<"ItemDefManager: setting alias "<<name
 481                                 <<" -> "<<convert_to<<std::endl;
 482                         m_aliases[name] = convert_to;
 483                 }
 484         }
 485         void serialize(std::ostream &os, u16 protocol_version)
 486         {
 487                 writeU8(os, 0); // version
 488                 u16 count = m_item_definitions.size();
 489                 writeU16(os, count);
 490
 491                 for (std::map<std::string, ItemDefinition *>::const_iterator
 492                                 it = m_item_definitions.begin();
 493                                 it != m_item_definitions.end(); ++it) {
 494                         ItemDefinition *def = it->second;
 495                         // Serialize ItemDefinition and write wrapped in a string
 496                         std::ostringstream tmp_os(std::ios::binary);
 497                         def->serialize(tmp_os, protocol_version);
 498                         os << serializeString(tmp_os.str());
 499                 }
 500
 501                 writeU16(os, m_aliases.size());
 502
 503                 for (StringMap::const_iterator
 504                                 it = m_aliases.begin();
 505                                 it != m_aliases.end(); ++it) {
 506                         os << serializeString(it->first);
 507                         os << serializeString(it->second);
 508                 }
 509         }
 510         void deSerialize(std::istream &is)
 511         {
 512                 // Clear everything
 513                 clear();
 514                 // Deserialize
 515                 int version = readU8(is);
 516                 if(version != 0)
 517                         throw SerializationError("unsupported ItemDefManager version");
 518                 u16 count = readU16(is);
 519                 for(u16 i=0; i<count; i++)
 520                 {
 521                         // Deserialize a string and grab an ItemDefinition from it
 522                         std::istringstream tmp_is(deSerializeString(is), std::ios::binary);
 523                         ItemDefinition def;
 524                         def.deSerialize(tmp_is);
 525                         // Register
 526                         registerItem(def);
 527                 }
 528                 u16 num_aliases = readU16(is);
 529                 for(u16 i=0; i<num_aliases; i++)
 530                 {
 531                         std::string name = deSerializeString(is);
 532                         std::string convert_to = deSerializeString(is);
 533                         registerAlias(name, convert_to);
 534                 }
 535         }
 536         void processQueue(IGameDef *gamedef)
 537         {
 538 #ifndef SERVER
 539                 //NOTE this is only thread safe for ONE consumer thread!
 540                 while(!m_get_clientcached_queue.empty())
 541                 {
 542                         GetRequest<std::string, ClientCached*, u8, u8>
 543                                         request = m_get_clientcached_queue.pop();
 544
 545                         m_get_clientcached_queue.pushResult(request,
 546                                         createClientCachedDirect(request.key, (Client *)gamedef));
 547                 }
 548 #endif
 549         }
 550 private:
 551         // Key is name
 552         std::map<std::string, ItemDefinition*> m_item_definitions;
 553         // Aliases
 554         StringMap m_aliases;
 555 #ifndef SERVER
 556         // The id of the thread that is allowed to use irrlicht directly
 557         threadid_t m_main_thread;
 558         // A reference to this can be returned when nothing is found, to avoid NULLs
 559         mutable ClientCached m_dummy_clientcached;
 560         // Cached textures and meshes
 561         mutable MutexedMap<std::string, ClientCached*> m_clientcached;
 562         // Queued clientcached fetches (to be processed by the main thread)
 563         mutable RequestQueue<std::string, ClientCached*, u8, u8> m_get_clientcached_queue;
 564 #endif
 565 };
 566
 567 IWritableItemDefManager* createItemDefManager()
 568 {
 569         return new CItemDefManager();
 570 }