CGroup.cpp

#include "CGroup.h"

#include <sstream>
#include <iostream>
#include <string>

#include "CAI.h"
#include "CUnit.h"
#include "CUnitTable.h"
#include "CTaskHandler.h"
#include "CPathfinder.h"
#include "CDefenseMatrix.h"

int CGroup::counter = 0;

void CGroup::addUnit(CUnit &unit) {
	if (unit.group) {
		if (unit.group == this) {
			LOG_WW("CGroup::addUnit " << unit << " already registered in " << (*this))
			return; // already registered
		} else {
			// NOTE: unit can exist in one and only group
			//LOG_II("CGroup::addUnit " << unit << " still in " << (*(unit.group)))
			unit.group->remove(unit);
		}
	}

	assert(unit.group == NULL);

	units[unit.key] = &unit;
	unit.reg(*this);
	unit.group = this;

	recalcProperties(&unit);

	LOG_II("CGroup::addUnit " << unit << " to " << (*this))
	// TODO: if group is busy invoke new unit to community process?
}

void CGroup::remove() {
	LOG_II("CGroup::remove " << (*this))

	// NOTE: removal order below is important

	std::list<ARegistrar*>::iterator j = records.begin();
	while(j != records.end()) {
		ARegistrar *regobj = *j; ++j;
		// remove from CEconomy, CPathfinder, ATask, CTaskHandler
		regobj->remove(*this);
	}

	std::map<int, CUnit*>::iterator i;
	for (i = units.begin(); i != units.end(); i++) {
		i->second->unreg(*this);
		i->second->group = NULL;
	}
	units.clear();
	badTargets.clear();

	assert(records.empty());
}

void CGroup::remove(ARegistrar &object) {
	CUnit *unit = dynamic_cast<CUnit*>(&object);

	LOG_II("CGroup::remove " << (*unit) << " from " << (*this))

	assert(units.find(unit->key) != units.end());

	unit->group = NULL;
	unit->unreg(*this);
	units.erase(unit->key);

	if (unit == latecomerUnit)
		removeLatecomer();

	badTargets.clear();

	/* If no more units remain in this group, remove the group */
	if (units.empty()) {
		remove();
	} else {
		/* Recalculate properties of the current group */
		recalcProperties(NULL, true);

		std::map<int, CUnit*>::iterator i;
		for (i = units.begin(); i != units.end(); ++i) {
			recalcProperties(i->second);
		}
	}
}

void CGroup::reclaim(int entity, bool feature) {
	float3 pos;

	if (feature) {
		pos = ai->cb->GetFeaturePos(entity);
		if (pos == ZeroVector)
			return;
	}

	std::map<int, CUnit*>::iterator i;
	for (i = units.begin(); i != units.end(); ++i) {
		if (i->second->def->canReclaim) {
			if (feature)
				i->second->reclaim(pos, 16.0f);
			else
				i->second->reclaim(entity);
		}
	}
}

void CGroup::repair(int target) {
	std::map<int, CUnit*>::iterator i;
	for (i = units.begin(); i != units.end(); ++i) {
		if (i->second->def->canRepair)
			i->second->repair(target);
	}
}

void CGroup::abilities(bool on) {
	std::map<int, CUnit*>::iterator i;
	for (i = units.begin(); i != units.end(); ++i) {
		if (i->second->def->canCloak)
			i->second->cloak(on);
	}
}

void CGroup::micro(bool on) {
	std::map<int, CUnit*>::iterator i;
	for (i = units.begin(); i != units.end(); ++i)
		i->second->micro(on);
}

bool CGroup::isMicroing() {
	std::map<int, CUnit*>::iterator i;
	for (i = units.begin(); i != units.end(); ++i) {
		if (i->second->isMicroing())
			return true;
	}
	return false;
}

bool CGroup::isIdle() {
	bool idle = true;
	std::map<int, CUnit*>::iterator i;
	for (i = units.begin(); i != units.end(); ++i) {
		if (!ai->unittable->idle[i->second->key]) {
			idle = false;
			break;
		}
	}
	return idle;
}

void CGroup::reset() {
	LOG_II("CGroup::reset " << (*this))

	assert(units.empty());
	recalcProperties(NULL, true);
	busy = false;
	micro(false);
	abilities(false);
	units.clear();
	records.clear();
	badTargets.clear();
}

void CGroup::recalcProperties(CUnit* unit, bool reset)
{
	if (reset) {
		strength   = 0.0f;
		speed      = std::numeric_limits<float>::max();
		size       = 0;
		buildSpeed = 0.0f;
		range      = 0.0f;
		buildRange = 0.0f;
		los        = 0.0f;
		maxSlope   = 1.0f;
		pathType   = -1; // emulate NONE
		techlvl    = TECH1;
		cats.reset();
		groupRadius = 0.0f;
		radiusUpdateRequired = false;
		cost       = 0.0f;
		costMetal  = 0.0f;
		worstSpeedUnit = NULL;
		worstSlopeUnit = NULL;
		latecomerUnit = NULL;
		latecomerWeight = 0;
	}

	if (unit == NULL)
		return;

	if (unit->builtBy >= 0) {
		for (int i = MIN_TECHLEVEL - 1; i < MAX_TECHLEVEL; i++) {
			if (unit->techlvl[i]) {
				for (int j = MIN_TECHLEVEL - 1; i < MAX_TECHLEVEL; j++) {
					if (techlvl[j]) {
						if (i > j) {
							techlvl.reset();
							techlvl.set(i);
						}
					}
					break;
				}
				break;
			}
		}
	}

	mergeCats(unit->type->cats);

	// NOTE: aircraft & static units do not have movedata
	MoveData* md = unit->def->movedata;
	if (md) {
		bool validCandidate = true;

		if (units.size() > 1) {
			unitCategory
				envCatsOfGroup = CATS_ENV&cats,
				envCatsOfUnit = CATS_ENV&unit->type->cats;
			validCandidate = (envCatsOfGroup == envCatsOfUnit);
		}

		if (validCandidate) {
			// select base path type with the lowerest slope, so pos(true) will
			// return valid postition for all units in a group...
			if (md->maxSlope <= maxSlope) {
				pathType = md->pathType;
				maxSlope = md->maxSlope;
				worstSlopeUnit = unit;
			}
		}
	}

	strength += unit->type->dps;
	buildSpeed += unit->def->buildSpeed;
	size += FOOTPRINT2REAL * std::max<int>(unit->def->xsize, unit->def->zsize);
	range = std::max<float>(ai->cb->GetUnitMaxRange(unit->key), range);
	buildRange = std::max<float>(unit->def->buildDistance, buildRange);
	los = std::max<float>(unit->def->losRadius, los);
	cost += unit->type->cost;
	costMetal += unit->type->costMetal;

	float temp;
	temp = ai->cb->GetUnitSpeed(unit->key);
	if (temp < speed) {
		speed = temp;
		worstSpeedUnit = unit;
	}

	radiusUpdateRequired = true;
}

void CGroup::merge(CGroup &group) {
	std::map<int, CUnit*>::iterator i = group.units.begin();
	// NOTE: "group" will automatically be removed when last unit
	// is transferred
	while(i != group.units.end()) {
		CUnit *unit = i->second; ++i;
		assert(unit->group == &group);
		addUnit(*unit);
	}
}

float3 CGroup::pos(bool force_valid) {
	std::map<int, CUnit*>::iterator i;
	float3 pos(0.0f, 0.0f, 0.0f);

	for (i = units.begin(); i != units.end(); ++i)
		pos += ai->cb->GetUnitPos(i->first);

	pos /= units.size();

	if (force_valid) {
		if (ai->pathfinder->isBlocked(pos.x, pos.z, pathType)) {
			float3 posValid = ai->pathfinder->getClosestPos(pos, PATH2REAL, this);
			if (posValid == ERRORVECTOR) {
				float bestDistance = std::numeric_limits<float>::max();
				for (i = units.begin(); i != units.end(); ++i) {
					float3 pos2 = ai->cb->GetUnitPos(i->first);
					if (ai->pathfinder->isBlocked(pos2.x, pos2.z, pathType))
						pos2 = ai->pathfinder->getClosestPos(pos2, PATH2REAL, this);
					if (pos2 != ERRORVECTOR) {
						float distance = pos.distance2D(pos2);
						if (distance < bestDistance) {
							posValid = pos2;
							bestDistance = distance;
						}
					}

				}
			}
			return posValid;
		}
	}

	return pos;
}

float CGroup::radius() {
	if (radiusUpdateRequired) {
		int i;
		// get number of units per leg length in a square
		for(i = 1; units.size() > i * i; i++);
		// calculate length of leg of square
		float sqLeg = maxLength() * i / (float)units.size();
		sqLeg *= sqLeg;
		// calculate half of hypotenuse
		groupRadius = sqrt(sqLeg + sqLeg) / 2.0f;

		radiusUpdateRequired = false;
	}
	return groupRadius;
}

int CGroup::maxLength() {
	return size + units.size() * FOOTPRINT2REAL;
}

void CGroup::assist(ATask &t) {
	// t->addAssister(
	switch(t.t) {
		case TASK_BUILD: {
			BuildTask *task = dynamic_cast<BuildTask*>(&t);
			CUnit *unit = task->firstGroup()->firstUnit();
			guard(unit->key);
			break;
		}

		case TASK_ATTACK: {
			// TODO: Calculate the flanking pos and attack from there
			AttackTask *task = dynamic_cast<AttackTask*>(&t);
			attack(task->target);
			break;
		}

		case TASK_FACTORY: {
			FactoryTask *task = dynamic_cast<FactoryTask*>(&t);
			CUnit *unit = task->firstGroup()->firstUnit();
			guard(unit->key);
			break;
		}

		default: return;
	}
}

void CGroup::move(float3 &pos, bool enqueue) {
	std::map<int, CUnit*>::iterator i;
	for (i = units.begin(); i != units.end(); ++i)
		i->second->move(pos, enqueue);
}

void CGroup::wait() {
	std::map<int, CUnit*>::iterator i;
	for (i = units.begin(); i != units.end(); ++i)
		i->second->wait();
}

void CGroup::unwait() {
	std::map<int, CUnit*>::iterator i;
	for (i = units.begin(); i != units.end(); ++i)
		i->second->unwait();
}

void CGroup::attack(int target, bool enqueue) {
	std::map<int, CUnit*>::iterator i;
	for (i = units.begin(); i != units.end(); ++i)
		i->second->attack(target, enqueue);
}

bool CGroup::build(float3& pos, UnitType* ut) {
	std::map<int, CUnit*>::iterator alpha, i;
	alpha = units.begin();
	if (alpha->second->build(ut, pos)) {
		for (i = ++alpha; i != units.end(); ++i)
			i->second->guard(alpha->first);
		return true;
	}
	return false;
}

void CGroup::stop() {
	std::map<int, CUnit*>::iterator i;
	for (i = units.begin(); i != units.end(); ++i)
		i->second->stop();
}

void CGroup::guard(int target, bool enqueue) {
	std::map<int, CUnit*>::iterator i;
	for (i = units.begin(); i != units.end(); ++i)
		i->second->guard(target, enqueue);
}

bool CGroup::canTouch(const float3 &goal) {
	return !ai->pathfinder->isBlocked(goal.x, goal.z, pathType);
}

bool CGroup::canReach(const float3 &goal) {
	if (!canTouch(goal))
		return false;
	if (pathType < 0)
		return true;

	float3 gpos = pos(true);

	return ai->pathfinder->pathExists(*this, gpos, goal);
}

bool CGroup::canAttack(int uid) {
	if ((cats&ATTACKER).none() && !firstUnit()->def->canReclaim)
		return false;

	const UnitDef *ud = ai->cbc->GetUnitDef(uid);

	if (ud == NULL || ai->cbc->IsUnitCloaked(uid))
		return false;

	const unitCategory ecats = UC(ud->id);
	float3 epos = ai->cbc->GetUnitPos(uid);

	if ((ecats&AIR).any() && (cats&ANTIAIR).none())
		return false;

	const float enemyRadiusDiv2 = ai->cb->GetUnitDefRadius(ud->id) / 2.0f;
	bool underwater = (epos.y + enemyRadiusDiv2) < 0.0f;
	bool outofwater = (epos.y - enemyRadiusDiv2) >= 0.0f;

	if (underwater && (cats&TORPEDO).none())
		return false;
	if (outofwater && (CATS_ENV&cats) == SUB)
		return false;

	// TODO: add more tweaks based on physical weapon possibilities

	return true;
}

bool CGroup::canAdd(CUnit* unit) {
	return canBeMerged(cats, unit->type->cats);
}

bool CGroup::canAssist(UnitType* type) {
	if (type) {
		if (!type->def->canBeAssisted)
			return false;
		if ((type->cats&(SEA|SUB)).any() && (cats&(SEA|SUB|AIR)).none())
			return false;
		if ((type->cats&(LAND)).any() && (cats&(LAND|AIR)).none())
			return false;
	}

	std::map<int, CUnit*>::const_iterator i;
	for (i = units.begin(); i != units.end(); ++i)
		if (i->second->type->def->canAssist)
			return true;

	return false;
}

bool CGroup::canMerge(CGroup* group) {
	return canBeMerged(cats, group->cats);
}

CUnit* CGroup::firstUnit() {
	if (units.empty())
		return NULL;
	return units.begin()->second;
}

void CGroup::mergeCats(unitCategory newcats) {
	if (cats == 0)
		cats = newcats;
	else {
		// NOTE: here is a list of cats which can't be left after merging
		// if they are absent initially, i.e. LAND + LAND|SEA = LAND
		static unitCategory nonXorCats[] = {SEA, SUB, LAND, AIR, STATIC, MOBILE, SCOUTER};
		unitCategory oldcats = cats;
		cats |= newcats;
		for (int i = 0; i < sizeof(nonXorCats) / sizeof(unitCategory); i++) {
			unitCategory tag = nonXorCats[i];
			if ((oldcats&tag).none() && (cats&tag).any())
				cats &= ~tag;
		}
	}
}

float CGroup::getThreat(float3& target, float radius) {
	return ai->threatmap->getThreat(target, radius, this);
}

bool CGroup::addBadTarget(int id) {
	const UnitDef* ud = ai->cbc->GetUnitDef(id);
	if (ud == NULL)
		return false;

	LOG_WW("CGroup::addBadTarget " << ud->humanName << "(" << id << ") to " << (*this))

	const unitCategory ecats = UC(ud->id);
	if ((ecats&STATIC).any())
		badTargets[id] = -1;
	else
		badTargets[id] = ai->cb->GetCurrentFrame();

	return true;
}

int CGroup::selectTarget(const std::map<int, UnitType*>& targets, TargetsFilter &tf) {
	std::vector<int> targetsVec;
	targetsVec.reserve(targets.size());
	std::map<int, UnitType*>::const_iterator ti = targets.begin();
	for (ti = targets.begin(); ti != targets.end(); ++ti) {
		targetsVec.push_back(ti->first);
	}

	return selectTarget(targetsVec, tf);
}

int CGroup::selectTarget(const std::vector<int>& targets, TargetsFilter &tf) {
	bool scout = (cats&SCOUTER).any();
	bool bomber = !scout && (cats&AIR).any() && (cats&ARTILLERY).any();
	int frame = ai->cb->GetCurrentFrame();
	float unitDamageK;
	float3 gpos = pos();

	if (targets.empty() || tf.candidatesLimit == 0)
		return tf.bestTarget;

	std::vector<int>::const_iterator ti = targets.begin();
	for (int i = 0; ti != targets.end() && i < tf.candidatesLimit; ++ti, i++) {
		const int t = *ti;

		if (!canAttack(t) || (tf.excludeId && (*(tf.excludeId))[t]))
			continue;

		if (!badTargets.empty()) {
			std::map<int, int>::iterator it = badTargets.find(t);
			if (it != badTargets.end()) {
				if (it->second < 0)
					continue; // permanent bad target
				if ((frame - it->second) < BAD_TARGET_TIMEOUT)
					continue; // temporary bad target
				else {
					badTargets.erase(it->first);
					LOG_II("CGroup::selectTarget bad target Unit(" << t << ") timed out for " << (*this))
				}
			}
		}

		const UnitDef* ud = ai->cbc->GetUnitDef(t);
		if (ud == NULL)
			continue;

		const unitCategory ecats = UC(ud->id);
		if ((tf.include&ecats).none() || (tf.exclude&ecats).any())
			continue;

		float3 epos = ai->cbc->GetUnitPos(t);
		float threat = getThreat(epos, tf.threatRadius);
		if (threat > tf.threatCeiling)
			continue;

		float unitMaxHealth = ai->cbc->GetUnitMaxHealth(t);
		if (unitMaxHealth > EPS)
			unitDamageK = (unitMaxHealth - ai->cbc->GetUnitHealth(t)) / unitMaxHealth;
		else
			unitDamageK = 0.0f;

		float score = gpos.distance2D(epos);
		score += tf.threatFactor * threat;
		score += tf.damageFactor * unitDamageK;
		score += tf.powerFactor * ud->power;

		// TODO: refactor so params below are moved into TargetFilter?
		if (ai->defensematrix->isPosInBounds(epos))
			// boost in priority enemy at our base, even scout units
			score -= 1000.0f; // TODO: better change value to the length a group can pass for 1 min (40 sec?)?
		else if(!scout && (ecats&SCOUTER).any()) {
			// remote scouts are not interesting for non-scout groups
			score += 10000.0f;
		}

		if (bomber && (ecats&STATIC).any() && (ecats&ANTIAIR).any())
			score -= 500.0f;

		// do not allow land units chase after air units...
		if ((cats&AIR).none() && (ecats&AIR).any())
			score += 3000.0f;

		// air fighters prefer aircraft...
		if ((cats&AIR).any() && (cats&ANTIAIR).any() && (ecats&AIR).none())
			score += 5000.0f;

		if (score < tf.scoreCeiling) {
			tf.bestTarget = t;
			tf.scoreCeiling = score;
			tf.threatValue = threat;
		}
	}

	return tf.bestTarget;
}

int CGroup::selectTarget(float search_radius, TargetsFilter &tf) {
	int limit = std::min<int>(MAX_ENEMIES, tf.candidatesLimit);
	int numEnemies = ai->cbc->GetEnemyUnits(&ai->unitIDs[0], pos(), search_radius, limit);
	if (numEnemies > 0) {
		tf.candidatesLimit = numEnemies;
		tf.bestTarget = selectTarget(ai->unitIDs, tf);
	}
	return tf.bestTarget;
}

float CGroup::getScanRange() {
	float result = radius();

	if ((cats&STATIC).any())
		result = getRange();
	else if ((cats&BUILDER).any())
		result += buildRange * 1.5f;
	else if ((cats&SNIPER).any())
		result += range * 1.05f;
	else if ((cats&SCOUTER).any())
		result += range * 3.0f;
	else if ((cats&ATTACKER).any())
		result += range * 1.4f;

	return result;
}

float CGroup::getRange() const {
	if ((cats&BUILDER).any())
		return buildRange;
	return range;
}

bool CGroup::canBeMerged(unitCategory bcats, unitCategory mcats) {
	static unitCategory nonMergableCats[] = { AIR, LAND, ATTACKER, STATIC, MOBILE, BUILDER, SCOUTER };

	if (bcats.none())
		return true;

	unitCategory c = (bcats&mcats); // common cats between two groups of cats

	if (c.none() || (c&CATS_ENV).none())
		return false;

	// NOTE: if one tag of "nonMergableCats" has been disappeared after logical
	// addition then unit or group with "mcats" can't be merged
	for (int i = 0; i < sizeof(nonMergableCats) / sizeof(unitCategory); i++) {
		unitCategory tag = nonMergableCats[i];
		if ((bcats&tag).any() && (c&tag).none())
			return false;
	}

	if ((bcats&SCOUTER).none() && (mcats&SCOUTER).any()) {
		// merging scout group with non-scout group...
		static unitCategory attackCats = ANTIAIR|ARTILLERY|SNIPER|ASSAULT;
		if ((c&attackCats).none())
			return false;
	}

	// NOTE: aircraft units have more restricted merge rules
	// TODO: refactor with introducing Group behaviour property?
	if ((bcats&AIR).any()) {
		if ((bcats&ASSAULT).any() && (c&ASSAULT).none())
			return false;
		if ((bcats&ARTILLERY).any() && (c&ARTILLERY).none())
			return false;
	}

	return true;
}

bool CGroup::canPerformTasks() {
	std::map<int, CUnit*>::iterator i;
	for (i = units.begin(); i != units.end(); ++i)
		if (!i->second->canPerformTasks())
			return false;
	return true;
}

void CGroup::updateLatecomer(CUnit* unit) {
	if (units.size() <= 1)
		return; // to less units to register latecomer

	if (latecomerUnit && latecomerUnit != unit) {
		removeLatecomer();
	}

	if (latecomerUnit == NULL) {
		latecomerUnit = unit;
		latecomerPos = unit->pos();
		return;
	}

	float3 newPos = unit->pos();
	if (latecomerPos.distance2D(newPos) < 32.0f) {
		latecomerWeight++;
		if (latecomerWeight > 10) {
			LOG_WW("CGroup::updateLatecomer " << unit << " is stuck")
			unit->stop();
			remove(*unit);
			// on idle code will take unit back in action
			ai->unittable->unitsUnderPlayerControl[unit->key] = unit;
		}
	}
	else {
		latecomerPos = newPos;
		latecomerWeight = 0;
	}
}

void CGroup::removeLatecomer() {
	if (latecomerUnit) {
		latecomerUnit = NULL;
		latecomerWeight = 0;
	}
}

std::ostream& operator<<(std::ostream &out, const CGroup &group) {
	std::stringstream ss;

	ss << "Group(" << group.key
		<< "): range(" << group.getRange()
		<< "), speed(" << group.speed
		<< "), strength(" << group.strength
		<< "), amount(" << group.units.size() << ") [";

	std::map<int, CUnit*>::const_iterator i = group.units.begin();
	for (i = group.units.begin(); i != group.units.end(); ++i) {
		ss << (*i->second) << ", ";
	}
	std::string s = ss.str();
	s = s.substr(0, s.size() - 2);
	s += "]";
	out << s;

	return out;
}