Martin Natano
d8b6d36a78
- Deprecated: The option is read from the settings, but not written back when saving. This can be used for migrating options to a new name or format. (Not used yet.) - Immutable: The option can not be changed from Lua. Used for security-relevant options that should not be changable by the theme or mod charts. Currently that's networking and some file system access options.
137 lines
3.7 KiB
C++
137 lines
3.7 KiB
C++
#include "global.h"
|
|
#include "Preference.h"
|
|
#include "XmlFile.h"
|
|
#include "RageLog.h"
|
|
#include "LuaManager.h"
|
|
#include "MessageManager.h"
|
|
#include "SubscriptionManager.h"
|
|
|
|
|
|
static SubscriptionManager<IPreference> m_Subscribers;
|
|
|
|
IPreference::IPreference( const RString& sName, PreferenceType type ):
|
|
m_sName( sName ),
|
|
m_bDoNotWrite( type == PreferenceType::Deprecated ),
|
|
m_bImmutable( type == PreferenceType::Immutable )
|
|
{
|
|
m_Subscribers.Subscribe( this );
|
|
}
|
|
|
|
IPreference::~IPreference()
|
|
{
|
|
m_Subscribers.Unsubscribe( this );
|
|
}
|
|
|
|
IPreference *IPreference::GetPreferenceByName( const RString &sName )
|
|
{
|
|
for (IPreference *p : *m_Subscribers.m_pSubscribers)
|
|
{
|
|
if( !p->GetName().CompareNoCase( sName ) )
|
|
return p;
|
|
}
|
|
|
|
return nullptr;
|
|
}
|
|
|
|
void IPreference::LoadAllDefaults()
|
|
{
|
|
for (IPreference *p : *m_Subscribers.m_pSubscribers)
|
|
p->LoadDefault();
|
|
}
|
|
|
|
void IPreference::ReadAllPrefsFromNode( const XNode* pNode, bool bIsStatic )
|
|
{
|
|
ASSERT( pNode != nullptr );
|
|
for (IPreference *p : *m_Subscribers.m_pSubscribers)
|
|
p->ReadFrom( pNode, bIsStatic );
|
|
}
|
|
|
|
void IPreference::SavePrefsToNode( XNode* pNode )
|
|
{
|
|
for (IPreference *p : *m_Subscribers.m_pSubscribers)
|
|
p->WriteTo( pNode );
|
|
}
|
|
|
|
void IPreference::ReadAllDefaultsFromNode( const XNode* pNode )
|
|
{
|
|
if( pNode == nullptr )
|
|
return;
|
|
for (IPreference *p : *m_Subscribers.m_pSubscribers)
|
|
p->ReadDefaultFrom( pNode );
|
|
}
|
|
|
|
void IPreference::PushValue( lua_State *L ) const
|
|
{
|
|
if( LOG )
|
|
LOG->Trace( "The preference value \"%s\" is of a type not supported by Lua", m_sName.c_str() );
|
|
|
|
lua_pushnil( L );
|
|
}
|
|
|
|
void IPreference::SetFromStack( lua_State *L )
|
|
{
|
|
if( LOG )
|
|
LOG->Trace( "The preference value \"%s\" is of a type not supported by Lua", m_sName.c_str() );
|
|
|
|
lua_pop( L, 1 );
|
|
}
|
|
|
|
void IPreference::ReadFrom( const XNode* pNode, bool bIsStatic )
|
|
{
|
|
RString sVal;
|
|
if( pNode->GetAttrValue(m_sName, sVal) )
|
|
{
|
|
FromString( sVal );
|
|
if (bIsStatic)
|
|
m_bDoNotWrite = true;
|
|
}
|
|
}
|
|
|
|
void IPreference::WriteTo( XNode* pNode ) const
|
|
{
|
|
if (m_bDoNotWrite)
|
|
return;
|
|
|
|
pNode->AppendAttr( m_sName, ToString() );
|
|
}
|
|
|
|
/* Load our value from the node, and make it the new default. */
|
|
void IPreference::ReadDefaultFrom( const XNode* pNode )
|
|
{
|
|
RString sVal;
|
|
if( !pNode->GetAttrValue(m_sName, sVal) )
|
|
return;
|
|
SetDefaultFromString( sVal );
|
|
}
|
|
|
|
void BroadcastPreferenceChanged( const RString& sPreferenceName )
|
|
{
|
|
if( MESSAGEMAN )
|
|
MESSAGEMAN->Broadcast( sPreferenceName+"Changed" );
|
|
}
|
|
|
|
/*
|
|
* (c) 2001-2004 Chris Danford, Chris Gomez
|
|
* All rights reserved.
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a
|
|
* copy of this software and associated documentation files (the
|
|
* "Software"), to deal in the Software without restriction, including
|
|
* without limitation the rights to use, copy, modify, merge, publish,
|
|
* distribute, and/or sell copies of the Software, and to permit persons to
|
|
* whom the Software is furnished to do so, provided that the above
|
|
* copyright notice(s) and this permission notice appear in all copies of
|
|
* the Software and that both the above copyright notice(s) and this
|
|
* permission notice appear in supporting documentation.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
|
|
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF
|
|
* THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS
|
|
* INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT
|
|
* OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
|
|
* OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
|
|
* OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
|
* PERFORMANCE OF THIS SOFTWARE.
|
|
*/
|