src/inventory.cpp

   1 /*
   2 Minetest-c55
   3 Copyright (C) 2010 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   5 This program is free software; you can redistribute it and/or modify
   6 it under the terms of the GNU General Public License as published by
   7 the Free Software Foundation; either version 2 of the License, or
   8 (at your option) any later version.
   9
  10 This program is distributed in the hope that it will be useful,
  11 but WITHOUT ANY WARRANTY; without even the implied warranty of
  12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 GNU General Public License for more details.
  14
  15 You should have received a copy of the GNU General Public License along
  16 with this program; if not, write to the Free Software Foundation, Inc.,
  17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18 */
  19
  20 /*
  21 (c) 2010 Perttu Ahola <celeron55@gmail.com>
  22 */
  23
  24 #include "inventory.h"
  25 #include "serialization.h"
  26 #include "utility.h"
  27 #include "debug.h"
  28 #include <sstream>
  29 #include "main.h"
  30
  31 /*
  32         InventoryItem
  33 */
  34
  35 InventoryItem::InventoryItem(u16 count)
  36 {
  37         m_count = count;
  38 }
  39
  40 InventoryItem::~InventoryItem()
  41 {
  42 }
  43
  44 InventoryItem* InventoryItem::deSerialize(std::istream &is)
  45 {
  46         DSTACK(__FUNCTION_NAME);
  47
  48         //is.imbue(std::locale("C"));
  49         // Read name
  50         std::string name;
  51         std::getline(is, name, ' ');
  52
  53         if(name == "MaterialItem")
  54         {
  55                 // u16 reads directly as a number (u8 doesn't)
  56                 u16 material;
  57                 is>>material;
  58                 u16 count;
  59                 is>>count;
  60                 if(material > 255)
  61                         throw SerializationError("Too large material number");
  62                 return new MaterialItem(material, count);
  63         }
  64         else if(name == "MBOItem")
  65         {
  66                 std::string inventorystring;
  67                 std::getline(is, inventorystring, '|');
  68                 return new MapBlockObjectItem(inventorystring);
  69         }
  70         else if(name == "CraftItem")
  71         {
  72                 std::string subname;
  73                 std::getline(is, subname, ' ');
  74                 u16 count;
  75                 is>>count;
  76                 return new CraftItem(subname, count);
  77         }
  78         else if(name == "ToolItem")
  79         {
  80                 std::string toolname;
  81                 std::getline(is, toolname, ' ');
  82                 u16 wear;
  83                 is>>wear;
  84                 return new ToolItem(toolname, wear);
  85         }
  86         else
  87         {
  88                 dstream<<"Unknown InventoryItem name=\""<<name<<"\""<<std::endl;
  89                 throw SerializationError("Unknown InventoryItem name");
  90         }
  91 }
  92
  93 /*
  94         MapBlockObjectItem
  95 */
  96 #ifndef SERVER
  97 video::ITexture * MapBlockObjectItem::getImage()
  98 {
  99         if(m_inventorystring.substr(0,3) == "Rat")
 100                 //return g_device->getVideoDriver()->getTexture(porting::getDataPath("rat.png").c_str());
 101                 return g_irrlicht->getTexture("rat.png");
 102
 103         if(m_inventorystring.substr(0,4) == "Sign")
 104                 //return g_device->getVideoDriver()->getTexture(porting::getDataPath("sign.png").c_str());
 105                 return g_irrlicht->getTexture("sign.png");
 106
 107         return NULL;
 108 }
 109 #endif
 110 std::string MapBlockObjectItem::getText()
 111 {
 112         if(m_inventorystring.substr(0,3) == "Rat")
 113                 return "";
 114
 115         if(m_inventorystring.substr(0,4) == "Sign")
 116                 return "";
 117
 118         return "obj";
 119 }
 120
 121 MapBlockObject * MapBlockObjectItem::createObject
 122                 (v3f pos, f32 player_yaw, f32 player_pitch)
 123 {
 124         std::istringstream is(m_inventorystring);
 125         std::string name;
 126         std::getline(is, name, ' ');
 127
 128         if(name == "None")
 129         {
 130                 return NULL;
 131         }
 132         else if(name == "Sign")
 133         {
 134                 std::string text;
 135                 std::getline(is, text, '|');
 136                 SignObject *obj = new SignObject(NULL, -1, pos);
 137                 obj->setText(text);
 138                 obj->setYaw(-player_yaw);
 139                 return obj;
 140         }
 141         else if(name == "Rat")
 142         {
 143                 RatObject *obj = new RatObject(NULL, -1, pos);
 144                 return obj;
 145         }
 146         else if(name == "ItemObj")
 147         {
 148                 /*
 149                         Now we are an inventory item containing the serialization
 150                         string of an object that contains the serialization
 151                         string of an inventory item. Fuck this.
 152                 */
 153                 //assert(0);
 154                 dstream<<__FUNCTION_NAME<<": WARNING: Ignoring ItemObj "
 155                                 <<"because an item-object should never be inside "
 156                                 <<"an object-item."<<std::endl;
 157                 return NULL;
 158         }
 159         else
 160         {
 161                 return NULL;
 162         }
 163 }
 164
 165 /*
 166         Inventory
 167 */
 168
 169 InventoryList::InventoryList(std::string name, u32 size)
 170 {
 171         m_name = name;
 172         m_size = size;
 173         clearItems();
 174 }
 175
 176 InventoryList::~InventoryList()
 177 {
 178         for(u32 i=0; i<m_items.size(); i++)
 179         {
 180                 if(m_items[i])
 181                         delete m_items[i];
 182         }
 183 }
 184
 185 void InventoryList::clearItems()
 186 {
 187         for(u32 i=0; i<m_items.size(); i++)
 188         {
 189                 if(m_items[i])
 190                         delete m_items[i];
 191         }
 192
 193         m_items.clear();
 194
 195         for(u32 i=0; i<m_size; i++)
 196         {
 197                 m_items.push_back(NULL);
 198         }
 199 }
 200
 201 void InventoryList::serialize(std::ostream &os)
 202 {
 203         //os.imbue(std::locale("C"));
 204
 205         for(u32 i=0; i<m_items.size(); i++)
 206         {
 207                 InventoryItem *item = m_items[i];
 208                 if(item != NULL)
 209                 {
 210                         os<<"Item ";
 211                         item->serialize(os);
 212                 }
 213                 else
 214                 {
 215                         os<<"Empty";
 216                 }
 217                 os<<"\n";
 218         }
 219
 220         os<<"EndInventoryList\n";
 221 }
 222
 223 void InventoryList::deSerialize(std::istream &is)
 224 {
 225         //is.imbue(std::locale("C"));
 226
 227         clearItems();
 228         u32 item_i = 0;
 229
 230         for(;;)
 231         {
 232                 std::string line;
 233                 std::getline(is, line, '\n');
 234
 235                 std::istringstream iss(line);
 236                 //iss.imbue(std::locale("C"));
 237
 238                 std::string name;
 239                 std::getline(iss, name, ' ');
 240
 241                 if(name == "EndInventoryList")
 242                 {
 243                         break;
 244                 }
 245                 // This is a temporary backwards compatibility fix
 246                 else if(name == "end")
 247                 {
 248                         break;
 249                 }
 250                 else if(name == "Item")
 251                 {
 252                         if(item_i > getSize() - 1)
 253                                 throw SerializationError("too many items");
 254                         InventoryItem *item = InventoryItem::deSerialize(iss);
 255                         m_items[item_i++] = item;
 256                 }
 257                 else if(name == "Empty")
 258                 {
 259                         if(item_i > getSize() - 1)
 260                                 throw SerializationError("too many items");
 261                         m_items[item_i++] = NULL;
 262                 }
 263                 else
 264                 {
 265                         throw SerializationError("Unknown inventory identifier");
 266                 }
 267         }
 268 }
 269
 270 InventoryList::InventoryList(const InventoryList &other)
 271 {
 272         /*
 273                 Do this so that the items get cloned. Otherwise the pointers
 274                 in the array will just get copied.
 275         */
 276         *this = other;
 277 }
 278
 279 InventoryList & InventoryList::operator = (const InventoryList &other)
 280 {
 281         m_name = other.m_name;
 282         m_size = other.m_size;
 283         clearItems();
 284         for(u32 i=0; i<other.m_items.size(); i++)
 285         {
 286                 InventoryItem *item = other.m_items[i];
 287                 if(item != NULL)
 288                 {
 289                         m_items[i] = item->clone();
 290                 }
 291         }
 292
 293         return *this;
 294 }
 295
 296 std::string InventoryList::getName()
 297 {
 298         return m_name;
 299 }
 300
 301 u32 InventoryList::getSize()
 302 {
 303         return m_items.size();
 304 }
 305
 306 u32 InventoryList::getUsedSlots()
 307 {
 308         u32 num = 0;
 309         for(u32 i=0; i<m_items.size(); i++)
 310         {
 311                 InventoryItem *item = m_items[i];
 312                 if(item != NULL)
 313                         num++;
 314         }
 315         return num;
 316 }
 317
 318 InventoryItem * InventoryList::getItem(u32 i)
 319 {
 320         if(i > m_items.size() - 1)
 321                 return NULL;
 322         return m_items[i];
 323 }
 324
 325 InventoryItem * InventoryList::changeItem(u32 i, InventoryItem *newitem)
 326 {
 327         assert(i < m_items.size());
 328
 329         InventoryItem *olditem = m_items[i];
 330         m_items[i] = newitem;
 331         return olditem;
 332 }
 333
 334 void InventoryList::deleteItem(u32 i)
 335 {
 336         assert(i < m_items.size());
 337         InventoryItem *item = changeItem(i, NULL);
 338         if(item)
 339                 delete item;
 340 }
 341
 342 InventoryItem * InventoryList::addItem(InventoryItem *newitem)
 343 {
 344         /*
 345                 First try to find if it could be added to some existing items
 346         */
 347         for(u32 i=0; i<m_items.size(); i++)
 348         {
 349                 // Ignore empty slots
 350                 if(m_items[i] == NULL)
 351                         continue;
 352                 // Try adding
 353                 newitem = addItem(i, newitem);
 354                 if(newitem == NULL)
 355                         return NULL; // All was eaten
 356         }
 357
 358         /*
 359                 Then try to add it to empty slots
 360         */
 361         for(u32 i=0; i<m_items.size(); i++)
 362         {
 363                 // Ignore unempty slots
 364                 if(m_items[i] != NULL)
 365                         continue;
 366                 // Try adding
 367                 newitem = addItem(i, newitem);
 368                 if(newitem == NULL)
 369                         return NULL; // All was eaten
 370         }
 371
 372         // Return leftover
 373         return newitem;
 374 }
 375
 376 InventoryItem * InventoryList::addItem(u32 i, InventoryItem *newitem)
 377 {
 378         // If it is an empty position, it's an easy job.
 379         InventoryItem *to_item = m_items[i];
 380         if(to_item == NULL)
 381         {
 382                 m_items[i] = newitem;
 383                 return NULL;
 384         }
 385
 386         // If not addable, return the item
 387         if(newitem->addableTo(to_item) == false)
 388                 return newitem;
 389
 390         // If the item fits fully in the slot, add counter and delete it
 391         if(newitem->getCount() <= to_item->freeSpace())
 392         {
 393                 to_item->add(newitem->getCount());
 394                 delete newitem;
 395                 return NULL;
 396         }
 397         // Else the item does not fit fully. Add all that fits and return
 398         // the rest.
 399         else
 400         {
 401                 u16 freespace = to_item->freeSpace();
 402                 to_item->add(freespace);
 403                 newitem->remove(freespace);
 404                 return newitem;
 405         }
 406 }
 407
 408 InventoryItem * InventoryList::takeItem(u32 i, u32 count)
 409 {
 410         if(count == 0)
 411                 return NULL;
 412
 413         InventoryItem *item = m_items[i];
 414         // If it is an empty position, return NULL
 415         if(item == NULL)
 416                 return NULL;
 417
 418         if(count >= item->getCount())
 419         {
 420                 // Get the item by swapping NULL to its place
 421                 return changeItem(i, NULL);
 422         }
 423         else
 424         {
 425                 InventoryItem *item2 = item->clone();
 426                 item->remove(count);
 427                 item2->setCount(count);
 428                 return item2;
 429         }
 430
 431         return false;
 432 }
 433
 434 void InventoryList::decrementMaterials(u16 count)
 435 {
 436         for(u32 i=0; i<m_items.size(); i++)
 437         {
 438                 InventoryItem *item = takeItem(i, count);
 439                 if(item)
 440                         delete item;
 441         }
 442 }
 443
 444 void InventoryList::print(std::ostream &o)
 445 {
 446         o<<"InventoryList:"<<std::endl;
 447         for(u32 i=0; i<m_items.size(); i++)
 448         {
 449                 InventoryItem *item = m_items[i];
 450                 if(item != NULL)
 451                 {
 452                         o<<i<<": ";
 453                         item->serialize(o);
 454                         o<<"\n";
 455                 }
 456         }
 457 }
 458
 459 /*
 460         Inventory
 461 */
 462
 463 Inventory::~Inventory()
 464 {
 465         clear();
 466 }
 467
 468 void Inventory::clear()
 469 {
 470         for(u32 i=0; i<m_lists.size(); i++)
 471         {
 472                 delete m_lists[i];
 473         }
 474         m_lists.clear();
 475 }
 476
 477 Inventory::Inventory()
 478 {
 479 }
 480
 481 Inventory::Inventory(const Inventory &other)
 482 {
 483         *this = other;
 484 }
 485
 486 Inventory & Inventory::operator = (const Inventory &other)
 487 {
 488         clear();
 489         for(u32 i=0; i<other.m_lists.size(); i++)
 490         {
 491                 m_lists.push_back(new InventoryList(*other.m_lists[i]));
 492         }
 493         return *this;
 494 }
 495
 496 void Inventory::serialize(std::ostream &os)
 497 {
 498         for(u32 i=0; i<m_lists.size(); i++)
 499         {
 500                 InventoryList *list = m_lists[i];
 501                 os<<"List "<<list->getName()<<" "<<list->getSize()<<"\n";
 502                 list->serialize(os);
 503         }
 504
 505         os<<"EndInventory\n";
 506 }
 507
 508 void Inventory::deSerialize(std::istream &is)
 509 {
 510         clear();
 511
 512         for(;;)
 513         {
 514                 std::string line;
 515                 std::getline(is, line, '\n');
 516
 517                 std::istringstream iss(line);
 518
 519                 std::string name;
 520                 std::getline(iss, name, ' ');
 521
 522                 if(name == "EndInventory")
 523                 {
 524                         break;
 525                 }
 526                 // This is a temporary backwards compatibility fix
 527                 else if(name == "end")
 528                 {
 529                         break;
 530                 }
 531                 else if(name == "List")
 532                 {
 533                         std::string listname;
 534                         u32 listsize;
 535
 536                         std::getline(iss, listname, ' ');
 537                         iss>>listsize;
 538
 539                         InventoryList *list = new InventoryList(listname, listsize);
 540                         list->deSerialize(is);
 541
 542                         m_lists.push_back(list);
 543                 }
 544                 else
 545                 {
 546                         throw SerializationError("Unknown inventory identifier");
 547                 }
 548         }
 549 }
 550
 551 InventoryList * Inventory::addList(const std::string &name, u32 size)
 552 {
 553         s32 i = getListIndex(name);
 554         if(i != -1)
 555         {
 556                 if(m_lists[i]->getSize() != size)
 557                 {
 558                         delete m_lists[i];
 559                         m_lists[i] = new InventoryList(name, size);
 560                 }
 561                 return m_lists[i];
 562         }
 563         else
 564         {
 565                 m_lists.push_back(new InventoryList(name, size));
 566                 return m_lists.getLast();
 567         }
 568 }
 569
 570 InventoryList * Inventory::getList(const std::string &name)
 571 {
 572         s32 i = getListIndex(name);
 573         if(i == -1)
 574                 return NULL;
 575         return m_lists[i];
 576 }
 577
 578 s32 Inventory::getListIndex(const std::string &name)
 579 {
 580         for(u32 i=0; i<m_lists.size(); i++)
 581         {
 582                 if(m_lists[i]->getName() == name)
 583                         return i;
 584         }
 585         return -1;
 586 }
 587
 588 /*
 589         InventoryAction
 590 */
 591
 592 InventoryAction * InventoryAction::deSerialize(std::istream &is)
 593 {
 594         std::string type;
 595         std::getline(is, type, ' ');
 596
 597         InventoryAction *a = NULL;
 598
 599         if(type == "Move")
 600         {
 601                 a = new IMoveAction(is);
 602         }
 603
 604         return a;
 605 }
 606
 607 void IMoveAction::apply(Inventory *inventory)
 608 {
 609         /*dstream<<"from_name="<<from_name<<" to_name="<<to_name<<std::endl;
 610         dstream<<"from_i="<<from_i<<" to_i="<<to_i<<std::endl;*/
 611         InventoryList *list_from = inventory->getList(from_name);
 612         InventoryList *list_to = inventory->getList(to_name);
 613         /*dstream<<"list_from="<<list_from<<" list_to="<<list_to
 614                         <<std::endl;*/
 615         /*if(list_from)
 616                 dstream<<" list_from->getItem(from_i)="<<list_from->getItem(from_i)
 617                                 <<std::endl;
 618         if(list_to)
 619                 dstream<<" list_to->getItem(to_i)="<<list_to->getItem(to_i)
 620                                 <<std::endl;*/
 621
 622         /*
 623                 If a list doesn't exist or the source item doesn't exist
 624                 or the source and the destination slots are the same
 625         */
 626         if(!list_from || !list_to || list_from->getItem(from_i) == NULL
 627                         || (list_from == list_to && from_i == to_i))
 628         {
 629                 dstream<<__FUNCTION_NAME<<": Operation not allowed"<<std::endl;
 630                 return;
 631         }
 632
 633         // Take item from source list
 634         InventoryItem *item1 = NULL;
 635         if(count == 0)
 636                 item1 = list_from->changeItem(from_i, NULL);
 637         else
 638                 item1 = list_from->takeItem(from_i, count);
 639
 640         // Try to add the item to destination list
 641         InventoryItem *olditem = item1;
 642         item1 = list_to->addItem(to_i, item1);
 643
 644         // If nothing is returned, the item was fully added
 645         if(item1 == NULL)
 646                 return;
 647
 648         // If olditem is returned, nothing was added.
 649         bool nothing_added = (item1 == olditem);
 650
 651         // If something else is returned, part of the item was left unadded.
 652         // Add the other part back to the source item
 653         list_from->addItem(from_i, item1);
 654
 655         // If olditem is returned, nothing was added.
 656         // Swap the items
 657         if(nothing_added)
 658         {
 659                 // Take item from source list
 660                 item1 = list_from->changeItem(from_i, NULL);
 661                 // Adding was not possible, swap the items.
 662                 InventoryItem *item2 = list_to->changeItem(to_i, item1);
 663                 // Put item from destination list to the source list
 664                 list_from->changeItem(from_i, item2);
 665                 return;
 666         }
 667 }
 668
 669 //END