ManaPlus
petdb.cpp
Go to the documentation of this file.
1 /*
2  * The ManaPlus Client
3  * Copyright (C) 2008-2009 The Mana World Development Team
4  * Copyright (C) 2009-2010 The Mana Developers
5  * Copyright (C) 2011-2019 The ManaPlus Developers
6  * Copyright (C) 2019-2021 Andrei Karas
7  *
8  * This file is part of The ManaPlus Client.
9  *
10  * This program is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * any later version.
14  *
15  * This program is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with this program. If not, see <http://www.gnu.org/licenses/>.
22  */
23 
24 #include "resources/db/petdb.h"
25 
26 #include "configuration.h"
27 
28 #include "resources/beingcommon.h"
29 #include "resources/beinginfo.h"
30 
32 
33 #include "utils/checkutils.h"
34 #include "utils/dtor.h"
35 #include "utils/gettext.h"
36 
37 #include "debug.h"
38 
39 namespace
40 {
42  bool mLoaded = false;
43 } // namespace
44 
46 {
47  if (mLoaded)
48  unload();
49 
50  logger->log1("Initializing PET database...");
53  loadXmlDir("petsPatchDir", loadXmlFile)
54  mLoaded = true;
55 }
56 
57 void PETDB::loadXmlFile(const std::string &fileName,
58  const SkipError skipError)
59 {
62  skipError);
63  XmlNodeConstPtrConst rootNode = doc.rootNode();
64 
65  if ((rootNode == nullptr) || !xmlNameEqual(rootNode, "pets"))
66  {
67  logger->log("PET Database: Error while loading %s!",
68  fileName.c_str());
69  return;
70  }
71 
72  // iterate <pet>s
73  for_each_xml_child_node(petNode, rootNode)
74  {
75  if (xmlNameEqual(petNode, "include"))
76  {
77  const std::string name = XML::getProperty(petNode, "name", "");
78  if (!name.empty())
79  loadXmlFile(name, skipError);
80  continue;
81  }
82  else if (!xmlNameEqual(petNode, "pet"))
83  {
84  continue;
85  }
86 
88  petNode, "id", -1), BeingTypeId);
89  if (id == BeingTypeId_negOne)
90  {
91  reportAlways("PET Database: PET with missing ID in %s!",
92  paths.getStringValue("petsFile").c_str())
93  continue;
94  }
95 
96  BeingInfo *currentInfo = nullptr;
97  if (mPETInfos.find(id) != mPETInfos.end())
98  currentInfo = mPETInfos[id];
99  if (currentInfo == nullptr)
100  currentInfo = new BeingInfo;
101 
102  currentInfo->setName(XML::langProperty(petNode,
103  // TRANSLATORS: unknown info name
104  "name", _("pet")));
105 
106  currentInfo->setTargetSelection(XML::getBoolProperty(petNode,
107  "targetSelection", true));
108 
109  BeingCommon::readBasicAttributes(currentInfo, petNode, "talk");
110  BeingCommon::readWalkingAttributes(currentInfo, petNode, 0);
111 
112  currentInfo->setDeadSortOffsetY(XML::getProperty(petNode,
113  "deadSortOffsetY", 31));
114 
115  const std::string returnMessage = XML::langProperty(petNode,
116  // TRANSLATORS: popup menu item
117  // TRANSLATORS: pet return to egg
118  "removeMessage", _("Return to egg"));
119  currentInfo->setString(0, returnMessage);
120 
121  SpriteDisplay display;
122  for_each_xml_child_node(spriteNode, petNode)
123  {
124  if (!XmlHaveChildContent(spriteNode))
125  continue;
126 
127  if (xmlNameEqual(spriteNode, "sprite"))
128  {
129  SpriteReference *const currentSprite = new SpriteReference;
130  currentSprite->sprite = XmlChildContent(spriteNode);
131  currentSprite->variant =
132  XML::getProperty(spriteNode, "variant", 0);
133  display.sprites.push_back(currentSprite);
134  }
135  else if (xmlNameEqual(spriteNode, "particlefx"))
136  {
137  std::string particlefx = XmlChildContent(spriteNode);
138  display.particles.push_back(particlefx);
139  }
140  }
141 
142  currentInfo->setDisplay(display);
143 
144  mPETInfos[id] = currentInfo;
145  }
146 }
147 
149 {
150  logger->log1("Unloading PET database...");
152  mPETInfos.clear();
153 
154  mLoaded = false;
155 }
156 
158 {
159  const BeingInfoIterator i = mPETInfos.find(id);
160 
161  if (i == mPETInfos.end())
162  {
163  reportAlways("PETDB: Warning, unknown PET ID %d requested",
164  toInt(id, int))
165  return BeingInfo::unknown;
166  }
167  return i->second;
168 }
static void loadXmlFile(const std::string &file, const std::string &name, BadgesInfos &arr, const SkipError skipError)
Definition: badgesdb.cpp:43
#define loadXmlDir(name, function)
Definition: beingcommon.h:39
BeingInfos::iterator BeingInfoIterator
Definition: beinginfo.h:410
std::map< BeingTypeId, BeingInfo * > BeingInfos
Definition: beinginfo.h:409
int BeingTypeId
Definition: beingtypeid.h:30
const BeingTypeId BeingTypeId_negOne
Definition: beingtypeid.h:31
#define reportAlways(...)
Definition: checkutils.h:253
void setString(const int idx, const std::string &value)
Definition: beinginfo.h:344
void setTargetSelection(const bool n)
Definition: beinginfo.h:180
void setName(const std::string &name)
Definition: beinginfo.h:65
void setDisplay(const SpriteDisplay &display)
Definition: beinginfo.cpp:127
void setDeadSortOffsetY(const int n)
Definition: beinginfo.h:195
static BeingInfo * unknown
Definition: beinginfo.h:56
std::string getStringValue(const std::string &key) const
void log(const char *const log_text,...)
Definition: logger.cpp:269
void log1(const char *const log_text)
Definition: logger.cpp:238
xmlNodePtr rootNode()
Definition: libxml.cpp:169
Configuration paths
void delete_all(Container &c)
Definition: dtor.h:56
#define _(s)
Definition: gettext.h:35
#define toInt(val, name)
Definition: intdefines.h:47
#define fromInt(val, name)
Definition: intdefines.h:46
#define for_each_xml_child_node(var, parent)
Definition: libxml.h:161
Logger * logger
Definition: logger.cpp:89
void readBasicAttributes(BeingInfo *const info, xmlNode *const node, const std::string &hoverCursor)
Definition: beingcommon.cpp:37
void readWalkingAttributes(BeingInfo *const info, xmlNode *const node, const int moreBlockFlags)
Definition: beingcommon.cpp:60
void unload()
Definition: net.cpp:180
BeingInfo * get(const BeingTypeId id)
Definition: petdb.cpp:157
void load()
Definition: petdb.cpp:45
void unload()
Definition: petdb.cpp:148
void loadXmlFile(const std::string &fileName, const SkipError skipError)
Definition: petdb.cpp:57
std::string langProperty(const xmlNodePtr node, const char *const name, const std::string &def)
Definition: libxml.cpp:258
bool getBoolProperty(const xmlNodePtr node, const char *const name, const bool def)
Definition: libxml.cpp:269
int getProperty(const xmlNodePtr node, const char *const name, int def)
Definition: libxml.cpp:174
const bool SkipError_false
Definition: skiperror.h:30
const bool SkipError_true
Definition: skiperror.h:30
bool SkipError
Definition: skiperror.h:30
StringVect particles
Definition: spritedisplay.h:48
std::vector< SpriteReference * > sprites
Definition: spritedisplay.h:47
std::string sprite
std::string fileName
Definition: testmain.cpp:39
const bool UseVirtFs_true
Definition: usevirtfs.h:30