fs2open.github.com/code/particle/ParticleManager.cpp

#include <algorithm>
#include <memory>

#include "particle/ParticleEffect.h"

#include "particle/ParticleManager.h"

#include "bmpman/bmpman.h"
#include "globalincs/systemvars.h"
#include "tracing/tracing.h"

/**
 * @defgroup particleSystems Particle System
 */

namespace particle {
std::unique_ptr<ParticleManager> ParticleManager::m_manager = nullptr;

ParticleManager::ParticleManager() = default;

void ParticleManager::init() {
	Assertion(m_manager == nullptr, "ParticleManager was not properly shut down!");

	m_manager.reset(new ParticleManager());

	//Need to init the base graphics once here
	::particle::init();

	parseConfigFiles();
}

void ParticleManager::shutdown() {
	Assertion(m_manager != nullptr, "ParticleManager was not properly inited!");

	m_manager = nullptr;
}

ParticleSource* ParticleManager::createSource() {
	ParticleSource* source;

	m_sourceValidityCounter++;

	// If we are currently in the onFrame function, adding stuff to the vector would invalidate the iterator currently in use
	if (m_processingSources) {
		m_deferredSourceAdding.emplace_back();

		source = &m_deferredSourceAdding.back();
	}
	else {
		m_sources.emplace_back();

		source = &m_sources.back();
	}

	return source;
}

ParticleEffectHandle ParticleManager::getEffectByName(const SCP_string& name)
{
	if (name.empty()) {
		// Don't allow empty names, it's a special case for effects that should not be referenced.
		return ParticleEffectHandle::invalid();
	}

	auto foundIterator = find_if(m_effects.begin(), m_effects.end(),
								 [&name](const SCP_vector<ParticleEffect>& vec) {
									 return !vec.empty() && lcase_equal(vec.front().getName(), name);
								 });

	if (foundIterator == m_effects.end()) {
		return ParticleEffectHandle::invalid();
	}

	return ParticleEffectHandle(distance(m_effects.begin(), foundIterator));
}

void ParticleManager::doFrame(float) {
	if (Is_standalone) {
		return;
	}

	TRACE_SCOPE(tracing::ProcessParticleEffects);

	m_processingSources = true;
	bool changehappened = false;

	for (auto source = std::begin(m_sources); source != std::end(m_sources);) {
		if (!source->isValid() || !source->process()) {
			changehappened = true;

			// if we're sitting on the very last source, popping-back will invalidate the iterator!
			if (std::next(source) == m_sources.end()) {
				m_sources.pop_back();
				break;
			}

			*source = std::move(m_sources.back());
			m_sources.pop_back();
			continue;
		}

		// source is only incremented here as elements would be skipped in
		// the case that a source needs to be removed
		++source;
	}

	m_processingSources = false;

	for (auto& source : m_deferredSourceAdding) {
		changehappened = true;
		m_sources.push_back(std::move(source));
	}
	m_deferredSourceAdding.clear();

	if (changehappened)
		m_sourceValidityCounter++;
}

ParticleEffectHandle ParticleManager::addEffect(ParticleEffect&& effect)
{
	SCP_vector<ParticleEffect> effectList;
	effectList.emplace_back(std::move(effect));
	return addEffect(std::move(effectList));
}

ParticleEffectHandle ParticleManager::addEffect(SCP_vector<ParticleEffect>&& effect)
{
	// we don't need this on standalone so remove the effect and return something invalid
	if (Is_standalone) {
		return ParticleEffectHandle::invalid();
	}

	Assert(!effect.empty());

	for (const auto& subeffect : effect) {
		for (const auto& bitmap : subeffect.m_bitmap_list) {
			if (bitmap < 0) {
				if (effect.front().getName().empty()) {
					mprintf(("Internal legacy particle effect did not have a valid bitmap. Check particleexp01, particlesmoke01, and particlesmoke02!\n"));
				}
				else {
					// I suspect we cannot get here. Parsing systems should prevent creation of named particles with invalid bitmaps, but just to be safe...
					Warning(LOCATION, "Particle effect with name '%s' contains invalid bitmaps!", effect.front().getName().c_str());
				}
				return ParticleEffectHandle::invalid();
			}
		}
	}

#ifndef NDEBUG
	if (!effect.front().getName().empty()) {
		// This check is a bit expensive and will only be used in debug
		auto index = getEffectByName(effect.front().getName());

		if (index.isValid()) {
			Warning(LOCATION, "Effect with name '%s' already exists!", effect.front().getName().c_str());
			return index;
		}
	}
#endif

	auto& effect_after_emplace = m_effects.emplace_back(std::move(effect));

	auto handle = ParticleEffectHandle(static_cast<ParticleEffectHandle::impl_type>(m_effects.size() - 1));
	for (size_t i = 0; i < effect_after_emplace.size(); i++)
		effect_after_emplace[i].m_self = ParticleSubeffectHandle{handle, i};

	return handle;
}

void ParticleManager::pageIn() {
	for (auto& effectList : m_effects) {
		for (auto& effect : effectList)
			effect.pageIn();
	}
}

ParticleSource* ParticleManager::createSource(ParticleEffectHandle index)
{
	ParticleSource* source = createSource();
	source->setEffect(index);

	return source;
}

void ParticleManager::clearSources() {
	m_sources.clear();
	m_deferredSourceAdding.clear();
}

uint32_t ParticleManager::getSourceValidityCounter() const {
	return m_sourceValidityCounter;
}

namespace util {
ParticleEffectHandle parseEffect(const SCP_string& objectName)
{
	SCP_string name;
	stuff_string(name, F_NAME);

	auto idx = ParticleManager::get()->getEffectByName(name);

	if (!idx.isValid()) {
		if (objectName.empty()) {
			error_display(0, "Unknown particle effect name '%s' encountered!", name.c_str());
		} else {
			error_display(0, "Unknown particle effect name '%s' encountered while parsing '%s'!", name.c_str(),
						  objectName.c_str());
		}
	}

	return idx;
}
}

namespace internal {
	bool required_string_if_new(const char* token, bool no_create) {
		if (no_create) {
			return optional_string(token) == 1;
		}

		required_string(token);
		return true;
	}

	SCP_vector<int> parseAnimationList(bool critical) {

		SCP_vector<SCP_string> bitmap_strings;

		// check to see if we are parsing a single value or list
		ignore_white_space();
		if (*Mp == '(') {
			// list of names case
			stuff_string_list(bitmap_strings);
		}
		else {
			// single name case
			SCP_string name;
			stuff_string(name, F_FILESPEC);
			bitmap_strings.push_back(std::move(name));
		}

		SCP_vector<int> handles;

		for (auto const &name: bitmap_strings) {
			// FRED never renders or pages in particle effects, 
			// so skip the (potentially expensive) animation loading here.  
			// Still record placeholder handle so the effect stays "defined" and 
			// can be resolved by name from the weapons/ships tables without spurious errors.
			if (Fred_running) {
				handles.push_back(0);
				continue;
			}

			auto handle = bm_load_animation(name.c_str());
			if (handle >= 0) {
				handles.push_back(handle);
			}
			else {
				int level = critical ? 1 : 0;
				error_display(level, "Failed to load effect %s!", name.c_str());
			}
		}

		return handles;
	}
}
}