Files
itgmania212121/stepmania/src/ThemeManager.cpp
T

656 lines
20 KiB
C++

#include "global.h"
/*
-----------------------------------------------------------------------------
Class: ThemeManager
Desc: See header.
Copyright (c) 2001-2002 by the person(s) listed below. All rights reserved.
Chris Danford
-----------------------------------------------------------------------------
*/
#include "ThemeManager.h"
#include "RageLog.h"
#include "PrefsManager.h"
#include "RageException.h"
#include "RageTimer.h"
#include "RageUtil.h"
#include "GameState.h"
#include "GameDef.h"
#include "IniFile.h"
#include "RageTimer.h"
#include "Font.h"
#include "FontCharAliases.h"
#include "RageDisplay.h"
#include "arch/ArchHooks/ArchHooks.h"
#include "arch/arch.h"
#include "RageFile.h"
#include "ScreenManager.h"
#include "StepMania.h"
ThemeManager* THEME = NULL; // global object accessable from anywhere in the program
const CString BASE_THEME_NAME = "default";
const CString FALLBACK_THEME_NAME = "fallback";
const CString LANGUAGES_SUBDIR = "Languages/";
const CString BASE_LANGUAGE = "english";
const CString THEMES_DIR = "Themes/";
const CString METRICS_FILE = "metrics.ini";
const CString ELEMENT_CATEGORY_STRING[NUM_ELEMENT_CATEGORIES] =
{
"BGAnimations",
"Fonts",
"Graphics",
"Numbers",
"Sounds",
"Other"
};
/* We spend a lot of time doing redundant theme path lookups. Cache results. */
static map<CString, CString> g_ThemePathCache[NUM_ELEMENT_CATEGORIES];
void FileNameToClassAndElement( const CString &sFileName, CString &sClassNameOut, CString &sElementOut )
{
// split into class name and file name
int iIndexOfFirstSpace = sFileName.Find(" ");
if( iIndexOfFirstSpace == -1 ) // no space
{
sClassNameOut = "";
sElementOut = sFileName;
}
else
{
sClassNameOut = sFileName.Left( iIndexOfFirstSpace );
sElementOut = sFileName.Right( sFileName.length() - iIndexOfFirstSpace - 1 );
}
}
CString ClassAndElementToFileName( const CString &sClassName, const CString &sElement )
{
if( sClassName.empty() )
return sElement;
else
return sClassName + " " + sElement;
}
ThemeManager::ThemeManager()
{
m_pIniCurMetrics = new IniFile;
m_pIniBaseMetrics = new IniFile;
m_sCurThemeName = BASE_THEME_NAME; // Use the base theme for now. It's up to PrefsManager to change this.
m_uHashForCurThemeMetrics = 0;
m_uHashForBaseThemeMetrics = 0;
m_uHashForCurThemeCurLanguage = 0;
m_uHashForBaseThemeCurLanguage = 0;
m_uHashForCurThemeBaseLanguage = 0;
m_uHashForBaseThemeBaseLanguage = 0;
CStringArray arrayThemeNames;
GetThemeNames( arrayThemeNames );
}
ThemeManager::~ThemeManager()
{
delete m_pIniCurMetrics;
delete m_pIniBaseMetrics;
}
void ThemeManager::GetThemeNames( CStringArray& AddTo )
{
GetDirListing( THEMES_DIR + "*", AddTo, true );
// strip out the folder called "CVS"
for( CStringArray::iterator i=AddTo.begin(); i != AddTo.end(); ++i )
{
if( *i == "CVS" ) {
AddTo.erase(i, i+1);
break;
}
}
}
bool ThemeManager::DoesThemeExist( CString sThemeName )
{
CStringArray asThemeNames;
GetThemeNames( asThemeNames );
for( unsigned i=0; i<asThemeNames.size(); i++ )
{
if( !sThemeName.CompareNoCase(asThemeNames[i]) )
return true;
}
return false;
}
void ThemeManager::GetLanguages( CStringArray& AddTo )
{
AddTo.clear();
CStringArray asTemp;
GetLanguagesForTheme( m_sCurThemeName, AddTo );
GetLanguagesForTheme( BASE_THEME_NAME, asTemp );
AddTo.insert( AddTo.begin(), asTemp.begin(), asTemp.end() );
// remove dupes
sort( AddTo.begin(), AddTo.end() );
CStringArray::iterator it = unique( AddTo.begin(), AddTo.end() );
AddTo.erase(it, AddTo.end());
}
bool ThemeManager::DoesLanguageExist( CString sLanguage )
{
CStringArray asLanguages;
GetLanguages( asLanguages );
for( unsigned i=0; i<asLanguages.size(); i++ )
if( sLanguage.CompareNoCase(asLanguages[i])==0 )
return true;
return false;
}
void ThemeManager::SwitchThemeAndLanguage( CString sThemeName, CString sLanguage )
{
if( !DoesThemeExist(sThemeName) )
m_sCurThemeName = BASE_THEME_NAME;
else
m_sCurThemeName = sThemeName;
if( !DoesLanguageExist(sLanguage) )
m_sCurLanguage = BASE_LANGUAGE;
else
m_sCurLanguage = sLanguage;
// clear theme path cache
int i;
for( i = 0; i < NUM_ELEMENT_CATEGORIES; ++i )
g_ThemePathCache[i].clear();
// update hashes for metrics files
m_uHashForCurThemeMetrics = GetHashForFile( GetMetricsIniPath(m_sCurThemeName) );
m_uHashForBaseThemeMetrics = GetHashForFile( GetMetricsIniPath(BASE_THEME_NAME) );
m_uHashForBaseThemeBaseLanguage = GetHashForFile( GetLanguageIniPath(BASE_THEME_NAME,BASE_LANGUAGE) );
m_uHashForCurThemeBaseLanguage = GetHashForFile( GetLanguageIniPath(m_sCurThemeName,BASE_LANGUAGE) );
m_uHashForBaseThemeCurLanguage = GetHashForFile( GetLanguageIniPath(BASE_THEME_NAME,m_sCurLanguage) );
m_uHashForCurThemeCurLanguage = GetHashForFile( GetLanguageIniPath(m_sCurThemeName,m_sCurLanguage) );
// read new metrics. First read base metrics, then read cur theme's metrics, overriding base theme
m_pIniCurMetrics->Reset();
m_pIniBaseMetrics->Reset();
m_pIniBaseMetrics->ReadFile( GetMetricsIniPath(FALLBACK_THEME_NAME) );
m_pIniBaseMetrics->ReadFile( GetMetricsIniPath(BASE_THEME_NAME) );
m_pIniCurMetrics->ReadFile( GetMetricsIniPath(m_sCurThemeName) );
m_pIniBaseMetrics->ReadFile( GetLanguageIniPath(FALLBACK_THEME_NAME,BASE_LANGUAGE) );
m_pIniBaseMetrics->ReadFile( GetLanguageIniPath(BASE_THEME_NAME,BASE_LANGUAGE) );
m_pIniCurMetrics->ReadFile( GetLanguageIniPath(m_sCurThemeName,BASE_LANGUAGE) );
m_pIniBaseMetrics->ReadFile( GetLanguageIniPath(FALLBACK_THEME_NAME,m_sCurLanguage) );
m_pIniBaseMetrics->ReadFile( GetLanguageIniPath(BASE_THEME_NAME,m_sCurLanguage) );
m_pIniCurMetrics->ReadFile( GetLanguageIniPath(m_sCurThemeName,m_sCurLanguage) );
CString sMetric;
for( i = 0; GetCommandlineArgument( "metric", &sMetric, i ); ++i )
{
/* sMetric must be "foo::bar=baz". "foo" and "bar" never contain "=", so in
* "foo::bar=1+1=2", "baz" is always "1+1=2". Neither foo nor bar may be
* empty, but baz may be. */
Regex re( "^([^=]+)::([^=]+)=(.*)$" );
vector<CString> sBits;
if( !re.Compare( sMetric, sBits ) )
RageException::Throw( "Invalid argument \"--metric=%s\"", sMetric.c_str() );
m_pIniCurMetrics->SetValue( sBits[0], sBits[1], sBits[2] );
}
LOG->MapLog("theme", "Theme: %s", sThemeName.c_str());
LOG->MapLog("language", "Language: %s", sLanguage.c_str());
}
CString ThemeManager::GetThemeDirFromName( const CString &sThemeName )
{
return THEMES_DIR + sThemeName + "/";
}
CString ThemeManager::GetPathToAndFallback( CString sThemeName, ElementCategory category, CString sClassName, CString sElement )
{
int n = 100;
while( n-- )
{
// search with requested name
CString sRet = GetPathToRaw( sThemeName, category, sClassName, sElement );
if( !sRet.empty() )
return sRet;
// search fallback name (if any)
CString sFallback;
GetMetricRaw( sClassName, "Fallback", sFallback );
if( sFallback.empty() )
return "";
sClassName = sFallback;
}
RageException::Throw("Infinite recursion looking up theme element from theme \"%s\", class \"%s\"",
sThemeName.c_str(), sClassName.c_str() );
}
CString ThemeManager::GetPathToRaw( CString sThemeName, ElementCategory category, CString sClassName, CString sElement )
{
try_element_again:
const CString sThemeDir = GetThemeDirFromName( sThemeName );
const CString sCategory = ELEMENT_CATEGORY_STRING[category];
CStringArray asElementPaths;
// If sFileName already has an extension, we're looking for a specific file
bool bLookingForSpecificFile = sElement.find_last_of('.') != sElement.npos;
bool bDirsOnly = category==BGAnimations;
if( bLookingForSpecificFile )
{
GetDirListing( sThemeDir + sCategory+"/"+ClassAndElementToFileName(sClassName,sElement), asElementPaths, bDirsOnly, true );
}
else // look for all files starting with sFileName that have types we can use
{
const CString wildcard = (category == BGAnimations? "":"*");
/* First, look for redirs. */
GetDirListing( sThemeDir + sCategory + "/" + ClassAndElementToFileName(sClassName,sElement) + wildcard + ".redir",
asElementPaths, false, true );
CStringArray asPaths;
GetDirListing( sThemeDir + sCategory + "/" + ClassAndElementToFileName(sClassName,sElement) + wildcard,
asPaths, bDirsOnly, true );
for( unsigned p = 0; p < asPaths.size(); ++p )
{
static const char *masks[NUM_ELEMENT_CATEGORIES][12] = {
{ "", NULL },
{ "ini", NULL },
{ "actor", "sprite", "png", "jpg", "bmp", "gif","avi", "mpg", "mpeg", "txt", "", NULL},
{ "png", NULL },
{ "mp3", "ogg", "wav", NULL },
{ "sm", NULL },
};
const char **asset_masks = masks[category];
const CString ext = GetExtension( asPaths[p] );
if( ext == "redir" )
continue; // got it already
for( int i = 0; asset_masks[i]; ++i )
{
/* No extension means directories. */
if( asset_masks[i][0] == 0 && !IsADirectory(asPaths[p]) )
continue;
if( ext == asset_masks[i] )
{
asElementPaths.push_back( asPaths[p] );
break;
}
}
}
if( category == Fonts )
Font::WeedFontNames(asElementPaths, ClassAndElementToFileName(sClassName,sElement));
}
if( asElementPaths.size() == 0 )
{
// HACK: have Numbers fall back to fonts. Eventually Numbers will be removed.
if( category == Numbers )
return GetPathToRaw( sThemeName, Fonts, sClassName, sElement ) ;
return ""; // This isn't fatal.
}
if( asElementPaths.size() > 1 )
{
FlushDirCache();
g_ThemePathCache[category].clear();
CString message = ssprintf(
"ThemeManager: There is more than one theme element element that matches "
"'%s/%s/%s %s'. Please remove all but one of these matches.",
sThemeName.c_str(), sCategory.c_str(), sClassName.c_str(), sElement.c_str() );
switch( HOOKS->MessageBoxAbortRetryIgnore(message) )
{
case ArchHooks::abort:
RageException::Throw( message );
break;
case ArchHooks::retry:
FlushDirCache();
ReloadMetrics();
goto try_element_again;
case ArchHooks::ignore:
break;
}
}
CString sPath = asElementPaths[0];
bool bIsARedirect = GetExtension(sPath).CompareNoCase("redir")==0;
if( !bIsARedirect )
{
return sPath;
}
else // bIsARedirect
{
CString sNewFileName = GetRedirContents(sPath);
CString sNewClassName, sNewFile;
FileNameToClassAndElement(sNewFileName, sNewClassName, sNewFile);
/* backwards-compatibility hack */
if( category == Fonts )
sNewFileName.Replace(" 16x16.png", "");
/* Search again. For example, themes/default/Fonts/foo might redir
* to "Hello"; but "Hello" might be overridden in themes/hot pink/Fonts/Hello. */
/* Important: We need to do a full search. For example, BG redirs in
* the default theme point to "_shared background", and themes override
* just "_shared background"; the redirs in the default theme should end
* up resolving to the overridden background. */
/* Use GetPathToOptional because we don't want report that there's an element
* missing. Instead we want to report that the redirect is invalid. */
CString sNewPath = GetPath(category, sNewClassName, sNewFile, true);
if( !sNewPath.empty() )
return sNewPath;
else
{
CString message = ssprintf(
"ThemeManager: The redirect '%s' points to the file '%s', which does not exist. "
"Verify that this redirect is correct.",
sPath.c_str(), sNewFileName.c_str());
if( ArchHooks::retry == HOOKS->MessageBoxAbortRetryIgnore(message) )
{
FlushDirCache();
ReloadMetrics();
goto try_element_again;
}
RageException::Throw( "%s", message.c_str() );
}
}
}
CString ThemeManager::GetPath( ElementCategory category, CString sClassName, CString sElement, bool bOptional )
{
CString sFileName = ClassAndElementToFileName( sClassName, sElement );
map<CString, CString> &Cache = g_ThemePathCache[category];
{
map<CString, CString>::const_iterator i;
i = Cache.find( sFileName );
if( i != Cache.end() )
return i->second;
}
try_element_again:
// search the current theme
CString ret = GetPathToAndFallback( m_sCurThemeName, category, sClassName, sElement);
if( !ret.empty() ) // we found something
{
Cache[sFileName] = ret;
return ret;
}
// search the base theme
ret = GetPathToAndFallback( BASE_THEME_NAME, category, sClassName, sElement);
if( !ret.empty() ) // we found something
{
Cache[sFileName] = ret;
return ret;
}
if( bOptional )
{
Cache[sFileName] = "";
return "";
}
CString sCategory = ELEMENT_CATEGORY_STRING[category];
/* We can't fall back on _missing in Other: the file types are unknown. */
CString sMessage = "The theme element \"" + sCategory + "/" + sFileName +"\" is missing.";
ArchHooks::MessageBoxResult res;
if( category != Other )
res = HOOKS->MessageBoxAbortRetryIgnore(sMessage, "MissingThemeElement");
else
res = HOOKS->MessageBoxRetryCancel(sMessage, "MissingThemeElement");
switch( res )
{
case ArchHooks::retry:
FlushDirCache();
ReloadMetrics();
goto try_element_again;
case ArchHooks::ignore:
LOG->Warn(
"Theme element '%s/%s' could not be found in '%s' or '%s'.",
sCategory.c_str(),
sFileName.c_str(),
GetThemeDirFromName(m_sCurThemeName).c_str(),
GetThemeDirFromName(BASE_THEME_NAME).c_str() );
/* Err? */
if(sFileName == "_missing")
RageException::Throw("'_missing' isn't present in '%s%s'", GetThemeDirFromName(BASE_THEME_NAME).c_str(), sCategory.c_str() );
Cache[sFileName] = GetPath( category, "", "_missing" );
return Cache[sFileName];
/* XXX: "abort" and "cancel" are synonyms; merge */
case ArchHooks::abort:
case ArchHooks::cancel:
RageException::Throw( "Theme element '%s/%s' could not be found in '%s' or '%s'.",
sCategory.c_str(),
sFileName.c_str(),
GetThemeDirFromName(m_sCurThemeName).c_str(),
GetThemeDirFromName(BASE_THEME_NAME).c_str() );
default:
ASSERT(0);
return "";
}
}
CString ThemeManager::GetMetricsIniPath( CString sThemeName )
{
return GetThemeDirFromName( sThemeName ) + METRICS_FILE;
}
bool ThemeManager::HasMetric( CString sClassName, CString sValueName )
{
CString sThrowAway;
return GetMetricRaw( sClassName, sValueName, sThrowAway );
}
void ThemeManager::ReloadMetricsIfNecessary()
{
//
// reload metrics if file has changed
//
CString sCurMetricPath = GetMetricsIniPath(m_sCurThemeName);
CString sDefaultMetricPath = GetMetricsIniPath(BASE_THEME_NAME);
if( m_uHashForCurThemeMetrics != GetHashForFile(sCurMetricPath) ||
m_uHashForBaseThemeMetrics != GetHashForFile(sDefaultMetricPath) )
{
ReloadMetrics();
}
}
void ThemeManager::ReloadMetrics()
{
SwitchThemeAndLanguage(m_sCurThemeName, m_sCurLanguage); // force a reload of the metrics cache
if( SCREENMAN )
SCREENMAN->SystemMessage( "Reloaded metrics" );
//
// clear theme path cache
//
for( int i = 0; i < NUM_ELEMENT_CATEGORIES; ++i )
g_ThemePathCache[i].clear();
}
bool ThemeManager::GetMetricRaw( CString sClassName, CString sValueName, CString &ret, int level )
{
if( level > 100 )
RageException::Throw("Infinite recursion looking up theme metric \"%s::%s\"", sClassName.c_str(), sValueName.c_str() );
CString sFallback;
if( m_pIniCurMetrics->GetValue(sClassName,sValueName,ret) )
return true;
if( m_pIniCurMetrics->GetValue(sClassName,"Fallback",sFallback) )
{
if( GetMetricRaw(sFallback,sValueName,ret,level+1) )
return true;
}
if( m_pIniBaseMetrics->GetValue(sClassName,sValueName,ret) )
return true;
if( m_pIniBaseMetrics->GetValue(sClassName,"Fallback",sFallback) )
{
if( GetMetricRaw(sFallback,sValueName,ret,level+1) )
return true;
}
return false;
}
CString ThemeManager::GetMetricRaw( CString sClassName, CString sValueName )
{
try_metric_again:
CString ret;
if( ThemeManager::GetMetricRaw( sClassName, sValueName, ret ) )
return ret;
CString sMessage = ssprintf( "The theme metric '%s-%s' is missing. Correct this and click Retry, or Cancel to break.",sClassName.c_str(),sValueName.c_str() );
switch( HOOKS->MessageBoxAbortRetryIgnore(sMessage) )
{
case ArchHooks::abort:
break; // fall through
case ArchHooks::retry:
FlushDirCache();
ReloadMetrics();
goto try_metric_again;
case ArchHooks::ignore:
return "";
default:
ASSERT(0);
}
CString sCurMetricPath = GetMetricsIniPath(m_sCurThemeName);
CString sDefaultMetricPath = GetMetricsIniPath(BASE_THEME_NAME);
RageException::Throw( "Theme metric '%s : %s' could not be found in '%s' or '%s'.",
sClassName.c_str(),
sValueName.c_str(),
sCurMetricPath.c_str(),
sDefaultMetricPath.c_str()
);
}
/* Get a string metric. */
CString ThemeManager::GetMetric( CString sClassName, CString sValueName )
{
CString sValue = GetMetricRaw(sClassName,sValueName);
// "::" means newline since you can't use line breaks in an ini file.
sValue.Replace("::","\n");
/* XXX: add a parameter to turn this off if there are some metrics where
* we don't want markers */
FontCharAliases::ReplaceMarkers(sValue);
return sValue;
}
int ThemeManager::GetMetricI( CString sClassName, CString sValueName )
{
return atoi( GetMetricRaw(sClassName,sValueName) );
}
float ThemeManager::GetMetricF( CString sClassName, CString sValueName )
{
return (float)atof( GetMetricRaw(sClassName,sValueName) );
}
// #include "LuaHelpers.h"
bool ThemeManager::GetMetricB( CString sClassName, CString sValueName )
{
// const CString str = GetMetricRaw( sClassName,sValueName );
// if( str == "0" )
// return false; /* optimization */
// if( str == "1" )
// return true; /* optimization */
// return Lua::RunExpression( str );
return atoi( GetMetricRaw(sClassName,sValueName) ) != 0;
}
RageColor ThemeManager::GetMetricC( CString sClassName, CString sValueName )
{
RageColor ret(1,1,1,1);
if( !ret.FromString( GetMetricRaw(sClassName,sValueName) ) )
LOG->Warn( "The color value '%s' for NoteSkin metric '%s : %s' is invalid.", GetMetricRaw(sClassName,sValueName).c_str(), sClassName.c_str(), sValueName.c_str() );
return ret;
}
void ThemeManager::NextTheme()
{
CStringArray as;
GetThemeNames( as );
unsigned i;
for( i=0; i<as.size(); i++ )
if( as[i].CompareNoCase(m_sCurThemeName)==0 )
break;
int iNewIndex = (i+1)%as.size();
SwitchThemeAndLanguage( as[iNewIndex], m_sCurLanguage );
}
void ThemeManager::GetLanguagesForTheme( CString sThemeName, CStringArray& asLanguagesOut )
{
CString sLanguageDir = GetThemeDirFromName(sThemeName) + LANGUAGES_SUBDIR;
CStringArray as;
GetDirListing( sLanguageDir + "*.ini", as );
// stip out metrics.ini
for( int i=as.size()-1; i>=0; i-- )
{
if( as[i].CompareNoCase(METRICS_FILE)==0 )
as.erase( as.begin()+i );
// strip ".ini"
as[i] = as[i].Left( as[i].size()-4 );
}
asLanguagesOut = as;
}
CString ThemeManager::GetLanguageIniPath( CString sThemeName, CString sLanguage )
{
return GetThemeDirFromName(sThemeName) + LANGUAGES_SUBDIR + sLanguage + ".ini";
}
// TODO: remove these and update the places that use them
CString ThemeManager::GetPathToB( CString sFileName, bool bOptional ) { CString sClassName, sElement; FileNameToClassAndElement(sFileName,sClassName,sElement); return GetPathB(sClassName,sElement,bOptional); }
CString ThemeManager::GetPathToF( CString sFileName, bool bOptional ) { CString sClassName, sElement; FileNameToClassAndElement(sFileName,sClassName,sElement); return GetPathF(sClassName,sElement,bOptional); }
CString ThemeManager::GetPathToG( CString sFileName, bool bOptional ) { CString sClassName, sElement; FileNameToClassAndElement(sFileName,sClassName,sElement); return GetPathG(sClassName,sElement,bOptional); }
CString ThemeManager::GetPathToN( CString sFileName, bool bOptional ) { CString sClassName, sElement; FileNameToClassAndElement(sFileName,sClassName,sElement); return GetPathN(sClassName,sElement,bOptional); }
CString ThemeManager::GetPathToS( CString sFileName, bool bOptional ) { CString sClassName, sElement; FileNameToClassAndElement(sFileName,sClassName,sElement); return GetPathS(sClassName,sElement,bOptional); }
CString ThemeManager::GetPathToO( CString sFileName, bool bOptional ) { CString sClassName, sElement; FileNameToClassAndElement(sFileName,sClassName,sElement); return GetPathO(sClassName,sElement,bOptional); }