mirror of
https://github.com/vcmi/vcmi.git
synced 2024-12-26 22:57:00 +02:00
449 lines
10 KiB
C++
449 lines
10 KiB
C++
/*
|
|
* MapReaderH3M.cpp, part of VCMI engine
|
|
*
|
|
* Authors: listed in file AUTHORS in main folder
|
|
*
|
|
* License: GNU General Public License v2.0 or later
|
|
* Full text of license available in license.txt file, in main folder
|
|
*
|
|
*/
|
|
|
|
#include "StdInc.h"
|
|
#include "MapReaderH3M.h"
|
|
|
|
#include "../filesystem/CBinaryReader.h"
|
|
#include "../int3.h"
|
|
#include "../mapObjects/ObjectTemplate.h"
|
|
|
|
VCMI_LIB_NAMESPACE_BEGIN
|
|
|
|
template<>
|
|
BuildingID MapReaderH3M::remapIdentifier(const BuildingID & identifier)
|
|
{
|
|
return identifier;
|
|
}
|
|
|
|
template<>
|
|
GameResID MapReaderH3M::remapIdentifier(const GameResID & identifier)
|
|
{
|
|
return identifier;
|
|
}
|
|
|
|
template<>
|
|
SpellID MapReaderH3M::remapIdentifier(const SpellID & identifier)
|
|
{
|
|
return identifier;
|
|
}
|
|
|
|
template<>
|
|
PlayerColor MapReaderH3M::remapIdentifier(const PlayerColor & identifier)
|
|
{
|
|
return identifier;
|
|
}
|
|
|
|
template<class Identifier>
|
|
Identifier MapReaderH3M::remapIdentifier(const Identifier & identifier)
|
|
{
|
|
return remapper.remap(identifier);
|
|
}
|
|
|
|
MapReaderH3M::MapReaderH3M(CInputStream * stream)
|
|
: reader(std::make_unique<CBinaryReader>(stream))
|
|
{
|
|
}
|
|
|
|
void MapReaderH3M::setFormatLevel(const MapFormatFeaturesH3M & newFeatures)
|
|
{
|
|
features = newFeatures;
|
|
}
|
|
|
|
void MapReaderH3M::setIdentifierRemapper(const MapIdentifiersH3M & newRemapper)
|
|
{
|
|
remapper = newRemapper;
|
|
}
|
|
|
|
ArtifactID MapReaderH3M::readArtifact()
|
|
{
|
|
ArtifactID result;
|
|
|
|
if(features.levelAB)
|
|
result = ArtifactID(reader->readUInt16());
|
|
else
|
|
result = ArtifactID(reader->readUInt8());
|
|
|
|
if(result.getNum() == features.artifactIdentifierInvalid)
|
|
return ArtifactID::NONE;
|
|
|
|
if (result.getNum() < features.artifactsCount)
|
|
return remapIdentifier(result);
|
|
|
|
logGlobal->warn("Map contains invalid artifact %d. Will be removed!", result.getNum());
|
|
return ArtifactID::NONE;
|
|
}
|
|
|
|
ArtifactID MapReaderH3M::readArtifact8()
|
|
{
|
|
ArtifactID result(reader->readUInt8());
|
|
|
|
if(result.getNum() == 0xff)
|
|
return ArtifactID::NONE;
|
|
|
|
if (result.getNum() < features.artifactsCount)
|
|
return remapIdentifier(result);
|
|
|
|
logGlobal->warn("Map contains invalid artifact %d. Will be removed!", result.getNum());
|
|
return ArtifactID::NONE;
|
|
}
|
|
|
|
ArtifactID MapReaderH3M::readArtifact32()
|
|
{
|
|
ArtifactID result(reader->readInt32());
|
|
|
|
if(result == ArtifactID::NONE)
|
|
return ArtifactID::NONE;
|
|
|
|
if (result.getNum() < features.artifactsCount)
|
|
return remapIdentifier(result);
|
|
|
|
logGlobal->warn("Map contains invalid artifact %d. Will be removed!", result.getNum());
|
|
return ArtifactID::NONE;
|
|
}
|
|
|
|
HeroTypeID MapReaderH3M::readHero()
|
|
{
|
|
HeroTypeID result(reader->readUInt8());
|
|
|
|
if(result.getNum() == features.heroIdentifierInvalid)
|
|
return HeroTypeID(-1);
|
|
|
|
assert(result.getNum() < features.heroesCount);
|
|
return remapIdentifier(result);
|
|
}
|
|
|
|
HeroTypeID MapReaderH3M::readHeroPortrait()
|
|
{
|
|
HeroTypeID result(reader->readUInt8());
|
|
|
|
if(result.getNum() == features.heroIdentifierInvalid)
|
|
return HeroTypeID::NONE;
|
|
|
|
if (result.getNum() >= features.heroesPortraitsCount)
|
|
{
|
|
logGlobal->warn("Map contains invalid hero portrait ID %d. Will be reset!", result.getNum() );
|
|
return HeroTypeID::NONE;
|
|
}
|
|
|
|
return remapper.remapPortrait(result);
|
|
}
|
|
|
|
CreatureID MapReaderH3M::readCreature()
|
|
{
|
|
CreatureID result;
|
|
|
|
if(features.levelAB)
|
|
result = CreatureID(reader->readUInt16());
|
|
else
|
|
result = CreatureID(reader->readUInt8());
|
|
|
|
if(result.getNum() == features.creatureIdentifierInvalid)
|
|
return CreatureID::NONE;
|
|
|
|
if(result.getNum() < features.creaturesCount)
|
|
return remapIdentifier(result);
|
|
|
|
// this may be random creature in army/town, to be randomized later
|
|
CreatureID randomIndex(result.getNum() - features.creatureIdentifierInvalid - 1);
|
|
assert(randomIndex < CreatureID::NONE);
|
|
|
|
if (randomIndex.getNum() > -16)
|
|
return randomIndex;
|
|
|
|
logGlobal->warn("Map contains invalid creature %d. Will be removed!", result.getNum());
|
|
return CreatureID::NONE;
|
|
}
|
|
|
|
TerrainId MapReaderH3M::readTerrain()
|
|
{
|
|
TerrainId result(readUInt8());
|
|
assert(result.getNum() < features.terrainsCount);
|
|
return remapIdentifier(result);
|
|
}
|
|
|
|
RoadId MapReaderH3M::readRoad()
|
|
{
|
|
RoadId result(readInt8());
|
|
assert(result.getNum() <= features.roadsCount);
|
|
return result;
|
|
}
|
|
|
|
RiverId MapReaderH3M::readRiver()
|
|
{
|
|
RiverId result(readInt8());
|
|
assert(result.getNum() <= features.riversCount);
|
|
return result;
|
|
}
|
|
|
|
PrimarySkill MapReaderH3M::readPrimary()
|
|
{
|
|
PrimarySkill result(readUInt8());
|
|
assert(result <= PrimarySkill::KNOWLEDGE );
|
|
return result;
|
|
}
|
|
|
|
SecondarySkill MapReaderH3M::readSkill()
|
|
{
|
|
SecondarySkill result(readUInt8());
|
|
assert(result.getNum() < features.skillsCount);
|
|
return remapIdentifier(result);
|
|
}
|
|
|
|
SpellID MapReaderH3M::readSpell()
|
|
{
|
|
SpellID result(readUInt8());
|
|
if(result.getNum() == features.spellIdentifierInvalid)
|
|
return SpellID::NONE;
|
|
if(result.getNum() == features.spellIdentifierInvalid - 1)
|
|
return SpellID::PRESET;
|
|
|
|
assert(result.getNum() < features.spellsCount);
|
|
return remapIdentifier(result);
|
|
}
|
|
|
|
SpellID MapReaderH3M::readSpell32()
|
|
{
|
|
SpellID result(readInt32());
|
|
if(result.getNum() == features.spellIdentifierInvalid)
|
|
return SpellID::NONE;
|
|
assert(result.getNum() < features.spellsCount);
|
|
return result;
|
|
}
|
|
|
|
GameResID MapReaderH3M::readGameResID()
|
|
{
|
|
GameResID result(readInt8());
|
|
assert(result.getNum() < features.resourcesCount);
|
|
return result;
|
|
}
|
|
|
|
PlayerColor MapReaderH3M::readPlayer()
|
|
{
|
|
uint8_t value = readUInt8();
|
|
|
|
if (value == 255)
|
|
return PlayerColor::NEUTRAL;
|
|
|
|
if (value >= PlayerColor::PLAYER_LIMIT_I)
|
|
{
|
|
logGlobal->warn("Map contains invalid player ID %d. Will be reset!", value );
|
|
return PlayerColor::NEUTRAL;
|
|
}
|
|
|
|
return PlayerColor(value);
|
|
}
|
|
|
|
PlayerColor MapReaderH3M::readPlayer32()
|
|
{
|
|
uint32_t value = readUInt32();
|
|
|
|
if (value == 255)
|
|
return PlayerColor::NEUTRAL;
|
|
|
|
if (value >= PlayerColor::PLAYER_LIMIT_I)
|
|
{
|
|
logGlobal->warn("Map contains invalid player ID %d. Will be reset!", value );
|
|
return PlayerColor::NEUTRAL;
|
|
}
|
|
|
|
return PlayerColor(value);
|
|
}
|
|
|
|
void MapReaderH3M::readBitmaskBuildings(std::set<BuildingID> & dest, std::optional<FactionID> faction)
|
|
{
|
|
std::set<BuildingID> h3m;
|
|
readBitmask(h3m, features.buildingsBytes, features.buildingsCount, false);
|
|
|
|
for (auto const & h3mEntry : h3m)
|
|
{
|
|
BuildingID mapped = remapper.remapBuilding(faction, h3mEntry);
|
|
|
|
if (mapped != BuildingID::NONE) // artifact merchant may be set in random town, but not present in actual town
|
|
dest.insert(mapped);
|
|
}
|
|
}
|
|
|
|
void MapReaderH3M::readBitmaskFactions(std::set<FactionID> & dest, bool invert)
|
|
{
|
|
readBitmask(dest, features.factionsBytes, features.factionsCount, invert);
|
|
}
|
|
|
|
void MapReaderH3M::readBitmaskPlayers(std::set<PlayerColor> & dest, bool invert)
|
|
{
|
|
readBitmask(dest, 1, 8, invert);
|
|
}
|
|
|
|
void MapReaderH3M::readBitmaskResources(std::set<GameResID> & dest, bool invert)
|
|
{
|
|
readBitmask(dest, features.resourcesBytes, features.resourcesCount, invert);
|
|
}
|
|
|
|
void MapReaderH3M::readBitmaskHeroClassesSized(std::set<HeroClassID> & dest, bool invert)
|
|
{
|
|
uint32_t classesCount = reader->readUInt32();
|
|
uint32_t classesBytes = (classesCount + 7) / 8;
|
|
|
|
readBitmask(dest, classesBytes, classesCount, invert);
|
|
}
|
|
|
|
void MapReaderH3M::readBitmaskHeroes(std::set<HeroTypeID> & dest, bool invert)
|
|
{
|
|
readBitmask<HeroTypeID>(dest, features.heroesBytes, features.heroesCount, invert);
|
|
}
|
|
|
|
void MapReaderH3M::readBitmaskHeroesSized(std::set<HeroTypeID> & dest, bool invert)
|
|
{
|
|
uint32_t heroesCount = readUInt32();
|
|
uint32_t heroesBytes = (heroesCount + 7) / 8;
|
|
assert(heroesCount <= features.heroesCount);
|
|
|
|
readBitmask<HeroTypeID>(dest, heroesBytes, heroesCount, invert);
|
|
}
|
|
|
|
void MapReaderH3M::readBitmaskArtifacts(std::set<ArtifactID> &dest, bool invert)
|
|
{
|
|
readBitmask<ArtifactID>(dest, features.artifactsBytes, features.artifactsCount, invert);
|
|
}
|
|
|
|
void MapReaderH3M::readBitmaskArtifactsSized(std::set<ArtifactID> &dest, bool invert)
|
|
{
|
|
uint32_t artifactsCount = reader->readUInt32();
|
|
uint32_t artifactsBytes = (artifactsCount + 7) / 8;
|
|
assert(artifactsCount <= features.artifactsCount);
|
|
|
|
readBitmask<ArtifactID>(dest, artifactsBytes, artifactsCount, invert);
|
|
}
|
|
|
|
void MapReaderH3M::readBitmaskSpells(std::set<SpellID> & dest, bool invert)
|
|
{
|
|
readBitmask(dest, features.spellsBytes, features.spellsCount, invert);
|
|
}
|
|
|
|
void MapReaderH3M::readBitmaskSkills(std::set<SecondarySkill> & dest, bool invert)
|
|
{
|
|
readBitmask(dest, features.skillsBytes, features.skillsCount, invert);
|
|
}
|
|
|
|
template<class Identifier>
|
|
void MapReaderH3M::readBitmask(std::set<Identifier> & dest, int bytesToRead, int objectsToRead, bool invert)
|
|
{
|
|
for(int byte = 0; byte < bytesToRead; ++byte)
|
|
{
|
|
const ui8 mask = reader->readUInt8();
|
|
for(int bit = 0; bit < 8; ++bit)
|
|
{
|
|
if(byte * 8 + bit < objectsToRead)
|
|
{
|
|
const size_t index = byte * 8 + bit;
|
|
const bool flag = mask & (1 << bit);
|
|
const bool result = (flag != invert);
|
|
|
|
Identifier h3mID(index);
|
|
Identifier vcmiID = remapIdentifier(h3mID);
|
|
|
|
if (result)
|
|
dest.insert(vcmiID);
|
|
else
|
|
dest.erase(vcmiID);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
int3 MapReaderH3M::readInt3()
|
|
{
|
|
int3 p;
|
|
p.x = reader->readUInt8();
|
|
p.y = reader->readUInt8();
|
|
p.z = reader->readUInt8();
|
|
return p;
|
|
}
|
|
|
|
std::shared_ptr<ObjectTemplate> MapReaderH3M::readObjectTemplate()
|
|
{
|
|
auto tmpl = std::make_shared<ObjectTemplate>();
|
|
tmpl->readMap(*reader);
|
|
remapper.remapTemplate(*tmpl);
|
|
return tmpl;
|
|
}
|
|
|
|
void MapReaderH3M::skipUnused(size_t amount)
|
|
{
|
|
reader->skip(amount);
|
|
}
|
|
|
|
void MapReaderH3M::skipZero(size_t amount)
|
|
{
|
|
#ifdef NDEBUG
|
|
skipUnused(amount);
|
|
#else
|
|
for(size_t i = 0; i < amount; ++i)
|
|
{
|
|
uint8_t value = reader->readUInt8();
|
|
assert(value == 0);
|
|
}
|
|
#endif
|
|
}
|
|
|
|
void MapReaderH3M::readResources(TResources & resources)
|
|
{
|
|
for(int x = 0; x < features.resourcesCount; ++x)
|
|
resources[x] = reader->readInt32();
|
|
}
|
|
|
|
bool MapReaderH3M::readBool()
|
|
{
|
|
uint8_t result = readUInt8();
|
|
assert(result == 0 || result == 1);
|
|
|
|
return result != 0;
|
|
}
|
|
|
|
int8_t MapReaderH3M::readInt8Checked(int8_t lowerLimit, int8_t upperLimit)
|
|
{
|
|
int8_t result = readInt8();
|
|
assert(result >= lowerLimit);
|
|
assert(result <= upperLimit);
|
|
return std::clamp(result, lowerLimit, upperLimit);
|
|
}
|
|
|
|
uint8_t MapReaderH3M::readUInt8()
|
|
{
|
|
return reader->readUInt8();
|
|
}
|
|
|
|
int8_t MapReaderH3M::readInt8()
|
|
{
|
|
return reader->readInt8();
|
|
}
|
|
|
|
uint16_t MapReaderH3M::readUInt16()
|
|
{
|
|
return reader->readUInt16();
|
|
}
|
|
|
|
uint32_t MapReaderH3M::readUInt32()
|
|
{
|
|
return reader->readUInt32();
|
|
}
|
|
|
|
int32_t MapReaderH3M::readInt32()
|
|
{
|
|
return reader->readInt32();
|
|
}
|
|
|
|
std::string MapReaderH3M::readBaseString()
|
|
{
|
|
return reader->readBaseString();
|
|
}
|
|
|
|
VCMI_LIB_NAMESPACE_END
|