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