peter1138@8544: /* $Id$ */
peter1138@8544: 
rubidium@9111: /** @file newgrf_generic.cpp Handling of generic feature callbacks. */
rubidium@9111: 
peter1138@8544: #include "stdafx.h"
peter1138@8544: #include "openttd.h"
peter1138@8544: #include "variables.h"
peter1138@8544: #include "landscape.h"
peter1138@8544: #include "debug.h"
peter1138@8544: #include "newgrf.h"
peter1138@8544: #include "newgrf_callbacks.h"
peter1138@8544: #include "newgrf_commons.h"
peter1138@8544: #include "newgrf_spritegroup.h"
peter1138@8544: #include "newgrf_generic.h"
peter1138@8544: #include "tile_map.h"
peter1138@8544: #include <list>
peter1138@8544: 
peter1138@8544: 
peter1138@8544: struct GenericCallback {
peter1138@8544: 	const GRFFile *file;
peter1138@8544: 	const SpriteGroup *group;
peter1138@8544: 
peter1138@8544: 	GenericCallback(const GRFFile *file, const SpriteGroup *group) :
peter1138@8544: 		file(file),
peter1138@8544: 		group(group)
peter1138@8544: 	{ }
peter1138@8544: };
peter1138@8544: 
peter1138@8544: typedef std::list<GenericCallback> GenericCallbackList;
peter1138@8544: 
peter1138@8544: static GenericCallbackList _gcl[GSF_END];
peter1138@8544: 
peter1138@8544: 
peter1138@8544: /**
peter1138@8544:  * Reset all generic feature callback sprite groups.
peter1138@8544:  */
peter1138@8544: void ResetGenericCallbacks()
peter1138@8544: {
peter1138@8544: 	for (uint8 feature = 0; feature < lengthof(_gcl); feature++) {
peter1138@8544: 		_gcl[feature].clear();
peter1138@8544: 	}
peter1138@8544: }
peter1138@8544: 
peter1138@8544: 
peter1138@8544: /**
peter1138@8544:  * Add a generic feature callback sprite group to the appropriate feature list.
peter1138@8544:  * @param feature
peter1138@8544:  * @param file
peter1138@8544:  * @param group
peter1138@8544:  */
peter1138@8544: void AddGenericCallback(uint8 feature, const GRFFile *file, const SpriteGroup *group)
peter1138@8544: {
peter1138@8544: 	if (feature >= lengthof(_gcl)) {
peter1138@8544: 		grfmsg(5, "AddGenericCallback: Unsupported feature 0x%02X", feature);
peter1138@8544: 		return;
peter1138@8544: 	}
peter1138@8544: 
peter1138@8544: 	/* Generic feature callbacks are evaluated in reverse (i.e. the last group
peter1138@8544: 	 * to be added is evaluated first, etc) thus we push the group to the
peter1138@8544: 	 * beginning of the list so a standard iterator will do the right thing. */
peter1138@8544: 	_gcl[feature].push_front(GenericCallback(file, group));
peter1138@8544: }
peter1138@8544: 
peter1138@8544: 
peter1138@8544: static uint32 GenericCallbackGetRandomBits(const ResolverObject *object)
peter1138@8544: {
peter1138@8544: 	return 0;
peter1138@8544: }
peter1138@8544: 
peter1138@8544: 
peter1138@8544: static uint32 GenericCallbackGetTriggers(const ResolverObject *object)
peter1138@8544: {
peter1138@8544: 	return 0;
peter1138@8544: }
peter1138@8544: 
peter1138@8544: 
peter1138@8544: static void GenericCallbackSetTriggers(const ResolverObject *object, int triggers)
peter1138@8544: {
peter1138@8544: 	return;
peter1138@8544: }
peter1138@8544: 
peter1138@8544: 
peter1138@8544: static uint32 GenericCallbackGetVariable(const ResolverObject *object, byte variable, byte parameter, bool *available)
peter1138@8544: {
peter1138@8544: 	switch (variable) {
peter1138@8544: 		case 0x40: return object->u.generic.cargo_type;
peter1138@8544: 
peter1138@8544: 		case 0x80: return object->u.generic.cargo_type;
peter1138@8544: 		case 0x81: return object->u.generic.cargo_type;
peter1138@8544: 		case 0x82: return object->u.generic.default_selection;
peter1138@8544: 		case 0x83: return object->u.generic.src_industry;
peter1138@8544: 		case 0x84: return object->u.generic.dst_industry;
peter1138@8544: 		case 0x85: return object->u.generic.distance;
peter1138@8544: 		case 0x86: return object->u.generic.event;
peter1138@8544: 		case 0x87: return object->u.generic.count;
peter1138@8544: 		case 0x88: return object->u.generic.station_size;
peter1138@8544: 
peter1138@8544: 		default: break;
peter1138@8544: 	}
peter1138@8544: 
peter1138@8544: 	DEBUG(grf, 1, "Unhandled generic feature property 0x%02X", variable);
peter1138@8544: 
peter1138@8544: 	*available = false;
peter1138@8544: 	return 0;
peter1138@8544: }
peter1138@8544: 
peter1138@8544: 
peter1138@8544: static const SpriteGroup *GenericCallbackResolveReal(const ResolverObject *object, const SpriteGroup *group)
peter1138@8544: {
peter1138@8544: 	if (group->g.real.num_loaded == 0) return NULL;
peter1138@8544: 
peter1138@8544: 	return group->g.real.loaded[0];
peter1138@8544: }
peter1138@8544: 
peter1138@8544: 
frosch@9750: static inline void NewGenericResolver(ResolverObject *res, const GRFFile *grffile)
peter1138@8544: {
peter1138@8544: 	res->GetRandomBits = &GenericCallbackGetRandomBits;
peter1138@8544: 	res->GetTriggers   = &GenericCallbackGetTriggers;
peter1138@8544: 	res->SetTriggers   = &GenericCallbackSetTriggers;
peter1138@8544: 	res->GetVariable   = &GenericCallbackGetVariable;
peter1138@8544: 	res->ResolveReal   = &GenericCallbackResolveReal;
peter1138@8544: 
peter1138@8544: 	res->callback        = CBID_NO_CALLBACK;
peter1138@8544: 	res->callback_param1 = 0;
peter1138@8544: 	res->callback_param2 = 0;
peter1138@8544: 	res->last_value      = 0;
peter1138@8544: 	res->trigger         = 0;
peter1138@8544: 	res->reseed          = 0;
glx@8756: 	res->count           = 0;
frosch@9750: 	res->grffile         = grffile;
peter1138@8544: }
peter1138@8544: 
peter1138@8544: 
peter1138@8544: /** Follow a generic feature callback list and return the first successful
peter1138@8544:  * answer
peter1138@8544:  * @param feature GRF Feature of callback
peter1138@8544:  * @param object  pre-populated resolver object
peter1138@8544:  * @param file    address of GRFFile object if file reference is needed, NULL is valid
peter1138@8544:  * @return callback value if successful or CALLBACK_FAILED
peter1138@8544:  */
peter1138@8544: static uint16 GetGenericCallbackResult(uint8 feature, ResolverObject *object, const GRFFile **file)
peter1138@8544: {
peter1138@8544: 	assert(feature < lengthof(_gcl));
peter1138@8544: 
peter1138@8544: 	/* Test each feature callback sprite group. */
peter1138@8544: 	for (GenericCallbackList::const_iterator it = _gcl[feature].begin(); it != _gcl[feature].end(); ++it) {
peter1138@8544: 		const SpriteGroup *group = it->group;
peter1138@8544: 		group = Resolve(group, object);
peter1138@8544: 		if (group == NULL || group->type != SGT_CALLBACK) continue;
peter1138@8544: 
peter1138@8544: 		/* Return NewGRF file if necessary */
peter1138@8544: 		if (file != NULL) *file = it->file;
peter1138@8544: 
peter1138@8544: 		return group->g.callback.result;
peter1138@8544: 	}
peter1138@8544: 
peter1138@8544: 	/* No callback returned a valid result, so we've failed. */
peter1138@8544: 	return CALLBACK_FAILED;
peter1138@8544: }
peter1138@8544: 
peter1138@8544: 
peter1138@8544: /**
peter1138@8544:  * 'Execute' an AI purchase selection callback
peter1138@8544:  */
peter1138@8544: uint16 GetAiPurchaseCallbackResult(uint8 feature, CargoID cargo_type, uint8 default_selection, IndustryType src_industry, IndustryType dst_industry, uint8 distance, AIConstructionEvent event, uint8 count, uint8 station_size, const GRFFile **file)
peter1138@8544: {
peter1138@8544: 	ResolverObject object;
peter1138@8544: 
frosch@9750: 	NewGenericResolver(&object, *file);
peter1138@8544: 
peter1138@8544: 	object.callback = CBID_GENERIC_AI_PURCHASE_SELECTION;
peter1138@8544: 	object.u.generic.cargo_type        = cargo_type;
peter1138@8544: 	object.u.generic.default_selection = default_selection;
peter1138@8544: 	object.u.generic.src_industry      = src_industry;
peter1138@8544: 	object.u.generic.dst_industry      = dst_industry;
peter1138@8544: 	object.u.generic.distance          = distance;
peter1138@8544: 	object.u.generic.event             = event;
peter1138@8544: 	object.u.generic.count             = count;
peter1138@8544: 	object.u.generic.station_size      = station_size;
peter1138@8544: 
rubidium@9020: 	uint16 callback = GetGenericCallbackResult(feature, &object, file);
rubidium@9020: 	if (callback != CALLBACK_FAILED) callback = GB(callback, 0, 8);
rubidium@9020: 	return callback;
peter1138@8544: }