tron@2186: /* $Id$ */
tron@2186: 
rubidium@10455: /** @file driver.cpp Base for all driver handling. */
belugas@6451: 
tron@2171: #include "stdafx.h"
tron@2171: #include "openttd.h"
tron@2210: #include "debug.h"
tron@2171: #include "driver.h"
tron@2171: 
rubidium@9631: #include "sound/sound_driver.hpp"
rubidium@9631: #include "music/music_driver.hpp"
rubidium@9631: #include "video/video_driver.hpp"
tron@2222: 
rubidium@9724: VideoDriver *_video_driver;
rubidium@9724: char _ini_videodriver[32];
rubidium@9724: int _num_resolutions;
rubidium@11044: Dimension _resolutions[32];
rubidium@11044: Dimension _cur_resolution;
rubidium@9724: 
rubidium@9631: SoundDriver *_sound_driver;
rubidium@9724: char _ini_sounddriver[32];
rubidium@9724: 
rubidium@9631: MusicDriver *_music_driver;
rubidium@9724: char _ini_musicdriver[32];
rubidium@9724: 
rubidium@9724: char _ini_blitter[32];
tron@2171: 
tron@2171: static const char* GetDriverParam(const char* const* parm, const char* name)
tron@2171: {
tron@2458: 	size_t len;
tron@2171: 
tron@2224: 	if (parm == NULL) return NULL;
tron@2224: 
tron@2224: 	len = strlen(name);
tron@2171: 	for (; *parm != NULL; parm++) {
tron@2171: 		const char* p = *parm;
tron@2171: 
tron@2171: 		if (strncmp(p, name, len) == 0) {
tron@2171: 			if (p[len] == '=')  return p + len + 1;
tron@2171: 			if (p[len] == '\0') return p + len;
tron@2171: 		}
tron@2171: 	}
tron@2171: 	return NULL;
tron@2171: }
tron@2171: 
tron@2171: bool GetDriverParamBool(const char* const* parm, const char* name)
tron@2171: {
tron@2171: 	return GetDriverParam(parm, name) != NULL;
tron@2171: }
tron@2171: 
tron@2171: int GetDriverParamInt(const char* const* parm, const char* name, int def)
tron@2171: {
tron@2171: 	const char* p = GetDriverParam(parm, name);
tron@2171: 	return p != NULL ? atoi(p) : def;
tron@2171: }
rubidium@9869: 
rubidium@9869: /**
rubidium@9869:  * Find the requested driver and return its class.
rubidium@9869:  * @param name the driver to select.
rubidium@9869:  * @post Sets the driver so GetCurrentDriver() returns it too.
rubidium@9869:  */
rubidium@9869: const Driver *DriverFactoryBase::SelectDriver(const char *name, Driver::Type type)
rubidium@9869: {
rubidium@9869: 	if (GetDrivers().size() == 0) return NULL;
rubidium@9869: 
rubidium@9869: 	if (*name == '\0') {
rubidium@9869: 		/* Probe for this driver */
rubidium@9869: 		for (int priority = 10; priority >= 0; priority--) {
rubidium@9869: 			Drivers::iterator it = GetDrivers().begin();
rubidium@9869: 			for (; it != GetDrivers().end(); ++it) {
rubidium@9869: 				DriverFactoryBase *d = (*it).second;
rubidium@9869: 
rubidium@9869: 				/* Check driver type */
rubidium@9869: 				if (d->type != type) continue;
rubidium@9869: 				if (d->priority != priority) continue;
rubidium@9869: 
rubidium@9869: 				Driver *newd = d->CreateInstance();
rubidium@9869: 				const char *err = newd->Start(NULL);
rubidium@9869: 				if (err == NULL) {
rubidium@9869: 					DEBUG(driver, 1, "Successfully probed %s driver '%s'", GetDriverTypeName(type), d->name);
rubidium@9869: 					delete *GetActiveDriver(type);
rubidium@9869: 					*GetActiveDriver(type) = newd;
rubidium@9869: 					return newd;
rubidium@9869: 				}
rubidium@9869: 
rubidium@9869: 				DEBUG(driver, 1, "Probing %s driver '%s' failed with error: %s", GetDriverTypeName(type), d->name, err);
rubidium@9869: 				delete newd;
rubidium@9869: 			}
rubidium@9869: 		}
rubidium@10867: 		usererror("Couldn't find any suitable %s driver", GetDriverTypeName(type));
rubidium@9869: 	} else {
rubidium@9869: 		char *parm;
rubidium@9869: 		char buffer[256];
rubidium@9869: 		const char *parms[32];
rubidium@9869: 
rubidium@9869: 		/* Extract the driver name and put parameter list in parm */
rubidium@9869: 		strecpy(buffer, name, lastof(buffer));
rubidium@9869: 		parm = strchr(buffer, ':');
rubidium@9869: 		parms[0] = NULL;
rubidium@9869: 		if (parm != NULL) {
rubidium@9869: 			uint np = 0;
rubidium@9869: 			/* Tokenize the parm. */
rubidium@9869: 			do {
rubidium@9869: 				*parm++ = '\0';
rubidium@9869: 				if (np < lengthof(parms) - 1) parms[np++] = parm;
rubidium@9869: 				while (*parm != '\0' && *parm != ',') parm++;
rubidium@9869: 			} while (*parm == ',');
rubidium@9869: 			parms[np] = NULL;
rubidium@9869: 		}
rubidium@9869: 
rubidium@9869: 		/* Find this driver */
rubidium@9869: 		Drivers::iterator it = GetDrivers().begin();
rubidium@9869: 		for (; it != GetDrivers().end(); ++it) {
rubidium@9869: 			DriverFactoryBase *d = (*it).second;
rubidium@9869: 
rubidium@9869: 			/* Check driver type */
rubidium@9869: 			if (d->type != type) continue;
rubidium@9869: 
rubidium@9869: 			/* Check driver name */
rubidium@9869: 			if (strcasecmp(buffer, d->name) != 0) continue;
rubidium@9869: 
rubidium@9869: 			/* Found our driver, let's try it */
rubidium@9869: 			Driver *newd = d->CreateInstance();
rubidium@9869: 
rubidium@9869: 			const char *err = newd->Start(parms);
rubidium@9869: 			if (err != NULL) {
rubidium@9869: 				delete newd;
rubidium@10867: 				usererror("Unable to load driver '%s'. The error was: %s", d->name, err);
rubidium@9869: 			}
rubidium@9869: 
rubidium@9869: 			DEBUG(driver, 1, "Successfully loaded %s driver '%s'", GetDriverTypeName(type), d->name);
rubidium@9869: 			delete *GetActiveDriver(type);
rubidium@9869: 			*GetActiveDriver(type) = newd;
rubidium@9869: 			return newd;
rubidium@9869: 		}
rubidium@10867: 		usererror("No such %s driver: %s\n", GetDriverTypeName(type), buffer);
rubidium@9869: 	}
rubidium@9869: }
rubidium@9869: 
rubidium@9869: /**
rubidium@9869:  * Register a driver internally, based on its name.
rubidium@9869:  * @param name the name of the driver.
rubidium@9869:  * @note an assert() will be trigger if 2 driver with the same name try to register.
rubidium@9869:  */
rubidium@9869: void DriverFactoryBase::RegisterDriver(const char *name, Driver::Type type, int priority)
rubidium@9869: {
rubidium@9869: 	/* Don't register nameless Drivers */
rubidium@9869: 	if (name == NULL) return;
rubidium@9869: 
rubidium@9869: 	this->name = strdup(name);
rubidium@9869: 	this->type = type;
rubidium@9869: 	this->priority = priority;
rubidium@9869: 
rubidium@9869: 	/* Prefix the name with driver type to make it unique */
rubidium@9869: 	char buf[32];
rubidium@9869: 	strecpy(buf, GetDriverTypeName(type), lastof(buf));
rubidium@9869: 	strecpy(buf + 5, name, lastof(buf));
rubidium@9869: 
rubidium@11126: 	const char *longname = strdup(buf);
rubidium@11126: 
rubidium@11126: 	std::pair<Drivers::iterator, bool> P = GetDrivers().insert(Drivers::value_type(longname, this));
rubidium@9869: 	assert(P.second);
rubidium@9869: }
rubidium@9869: 
rubidium@9869: /**
rubidium@9869:  * Build a human readable list of available drivers, grouped by type.
rubidium@9869:  */
rubidium@9869: char *DriverFactoryBase::GetDriversInfo(char *p, const char *last)
rubidium@9869: {
rubidium@9869: 	for (Driver::Type type = Driver::DT_BEGIN; type != Driver::DT_END; type++) {
rubidium@9869: 		p += snprintf(p, last - p, "List of %s drivers:\n", GetDriverTypeName(type));
rubidium@9869: 
rubidium@9869: 		for (int priority = 10; priority >= 0; priority--) {
rubidium@9869: 			Drivers::iterator it = GetDrivers().begin();
rubidium@9869: 			for (; it != GetDrivers().end(); it++) {
rubidium@9869: 				DriverFactoryBase *d = (*it).second;
rubidium@9869: 				if (d->type != type) continue;
rubidium@9869: 				if (d->priority != priority) continue;
rubidium@9869: 				p += snprintf(p, last - p, "%18s: %s\n", d->name, d->GetDescription());
rubidium@9869: 			}
rubidium@9869: 		}
rubidium@9869: 
rubidium@9869: 		p += snprintf(p, last - p, "\n");
rubidium@9869: 	}
rubidium@9869: 
rubidium@9869: 	return p;
rubidium@9869: }
glx@10920: 
glx@10920: /** Frees memory used for this->name
glx@10920:  */
glx@10920: DriverFactoryBase::~DriverFactoryBase() {
glx@10920: 	if (this->name == NULL) return;
glx@10920: 
glx@10920: 	/* Prefix the name with driver type to make it unique */
glx@10920: 	char buf[32];
glx@10920: 	strecpy(buf, GetDriverTypeName(type), lastof(buf));
glx@10920: 	strecpy(buf + 5, this->name, lastof(buf));
glx@10920: 
rubidium@11126: 	Drivers::iterator it = GetDrivers().find(buf);
rubidium@11126: 	assert(it != GetDrivers().end());
rubidium@11126: 
rubidium@11126: 	const char *longname = (*it).first;
rubidium@11126: 
rubidium@11126: 	GetDrivers().erase(it);
rubidium@11126: 	free((void *)longname);
rubidium@11126: 
glx@10920: 	if (GetDrivers().empty()) delete &GetDrivers();
rubidium@11126: 	free((void *)this->name);
glx@10920: }