Files
itgmania212121/src/EditMenu.cpp
T
Devin J. Pohly 6ac4fcdbd3 remove accidentally shadowing declaration
With this in place, the orgSel was always Invalid.
2014-02-08 21:39:26 -05:00

633 lines
18 KiB
C++

#include "global.h"
#include "EditMenu.h"
#include "RageLog.h"
#include "SongManager.h"
#include "GameState.h"
#include "ThemeManager.h"
#include "GameManager.h"
#include "Steps.h"
#include "Song.h"
#include "StepsUtil.h"
#include "Foreach.h"
#include "CommonMetrics.h"
#include "BannerCache.h"
#include "UnlockManager.h"
#include "SongUtil.h"
static const char *EditMenuRowNames[] = {
"Group",
"Song",
"StepsType",
"Steps",
"SourceStepsType",
"SourceSteps",
"Action"
};
XToString( EditMenuRow );
XToLocalizedString( EditMenuRow );
static const char *EditMenuActionNames[] = {
"Edit",
"Delete",
"Create",
"Practice",
};
XToString( EditMenuAction );
XToLocalizedString( EditMenuAction );
StringToX( EditMenuAction );
static RString ARROWS_X_NAME( size_t i ) { return ssprintf("Arrows%dX",int(i+1)); }
static RString ROW_Y_NAME( size_t i ) { return ssprintf("Row%dY",int(i+1)); }
void EditMenu::StripLockedStepsAndDifficulty( vector<StepsAndDifficulty> &v )
{
const Song *pSong = GetSelectedSong();
for( int i=(int)v.size()-1; i>=0; i-- )
{
if( v[i].pSteps && UNLOCKMAN->StepsIsLocked(pSong, v[i].pSteps) )
v.erase( v.begin()+i );
}
}
void EditMenu::GetSongsToShowForGroup( const RString &sGroup, vector<Song*> &vpSongsOut )
{
vpSongsOut = SONGMAN->GetSongs( SHOW_GROUPS.GetValue()? sGroup:GROUP_ALL );
EditMode mode = EDIT_MODE.GetValue();
switch( mode )
{
case EditMode_Practice:
case EditMode_CourseMods:
case EditMode_Home:
for( int i=vpSongsOut.size()-1; i>=0; i-- )
{
const Song* pSong = vpSongsOut[i];
if( !pSong->NormallyDisplayed() || pSong->IsTutorial() )
vpSongsOut.erase( vpSongsOut.begin()+i );
}
break;
case EditMode_Full:
break;
default:
FAIL_M(ssprintf("Invalid edit mode: %i", mode));
}
SongUtil::SortSongPointerArrayByTitle( vpSongsOut );
}
void EditMenu::GetGroupsToShow( vector<RString> &vsGroupsOut )
{
vsGroupsOut.clear();
if( !SHOW_GROUPS.GetValue() )
return;
SONGMAN->GetSongGroupNames( vsGroupsOut );
for( int i = vsGroupsOut.size()-1; i>=0; i-- )
{
const RString &sGroup = vsGroupsOut[i];
vector<Song*> vpSongs;
GetSongsToShowForGroup( sGroup, vpSongs );
// strip groups that have no unlocked songs
if( vpSongs.empty() )
vsGroupsOut.erase( vsGroupsOut.begin()+i );
}
}
EditMenu::EditMenu()
{
}
EditMenu::~EditMenu()
{
BANNERCACHE->Undemand();
}
void EditMenu::Load( const RString &sType )
{
LOG->Trace( "EditMenu::Load" );
SHOW_GROUPS.Load(sType,"ShowGroups");
ARROWS_X.Load(sType,ARROWS_X_NAME,NUM_ARROWS);
ARROWS_ENABLED_COMMAND.Load(sType,"ArrowsEnabledCommand");
ARROWS_DISABLED_COMMAND.Load(sType,"ArrowsDisabledCommand");
ROW_Y.Load(sType,ROW_Y_NAME,NUM_EditMenuRow);
EDIT_MODE.Load(sType,"EditMode");
TEXT_BANNER_TYPE.Load( m_sName, "TextBannerType" );
for( int i=0; i<2; i++ )
{
m_sprArrows[i].Load( THEME->GetPathG(sType,i==0?"left":"right") );
m_sprArrows[i]->SetX( ARROWS_X.GetValue(i) );
this->AddChild( m_sprArrows[i] );
}
m_SelectedRow = GetFirstRow();
ZERO( m_iSelection );
FOREACH_EditMenuRow( r )
{
m_textLabel[r].SetName(ssprintf("Label%i",r+1));
m_textLabel[r].LoadFromFont( THEME->GetPathF(sType,"title") );
m_textLabel[r].SetText( EditMenuRowToLocalizedString(r) );
ActorUtil::LoadAllCommandsAndSetXY( m_textLabel[r], sType );
//m_textLabel[r].SetHorizAlign( align_left );
this->AddChild( &m_textLabel[r] );
m_textValue[r].SetName(ssprintf("Value%i",r+1));
m_textValue[r].LoadFromFont( THEME->GetPathF(sType,"value") );
m_textValue[r].SetText( "blah" );
ActorUtil::LoadAllCommandsAndSetXY( m_textValue[r], sType );
this->AddChild( &m_textValue[r] );
}
m_textLabel[ROW_GROUP].SetVisible( SHOW_GROUPS.GetValue() );
m_textValue[ROW_GROUP].SetVisible( SHOW_GROUPS.GetValue() );
// Load low-res banners, if needed.
BANNERCACHE->Demand();
if( SHOW_GROUPS.GetValue() )
{
m_GroupBanner.SetName( "GroupBanner" );
ActorUtil::SetXY( m_GroupBanner, sType );
ActorUtil::LoadAllCommands( m_GroupBanner, sType );
this->AddChild( &m_GroupBanner );
}
m_SongBanner.SetName( "SongBanner" );
ActorUtil::SetXY( m_SongBanner, sType );
ActorUtil::LoadAllCommands( m_SongBanner, sType );
this->AddChild( &m_SongBanner );
m_SongTextBanner.SetName( "SongTextBanner" );
m_SongTextBanner.Load( TEXT_BANNER_TYPE );
ActorUtil::SetXY( m_SongTextBanner, sType );
ActorUtil::LoadAllCommands( m_SongTextBanner, sType );
this->AddChild( &m_SongTextBanner );
m_StepsDisplay.SetName( "StepsDisplay" );
m_StepsDisplay.Load( "StepsDisplayEdit", NULL );
ActorUtil::SetXY( m_StepsDisplay, sType );
this->AddChild( &m_StepsDisplay );
m_StepsDisplaySource.SetName( "StepsDisplaySource" );
m_StepsDisplaySource.Load( "StepsDisplayEdit", NULL );
ActorUtil::SetXY( m_StepsDisplaySource, sType );
this->AddChild( &m_StepsDisplaySource );
m_soundChangeRow.Load( THEME->GetPathS(sType,"row"), true );
m_soundChangeValue.Load( THEME->GetPathS(sType,"value"), true );
// fill in data structures
GetGroupsToShow( m_sGroups );
// In EditMode_Practice this will be filled in by OnRowValueChanged()
if( EDIT_MODE.GetValue() != EditMode_Practice )
m_StepsTypes = CommonMetrics::STEPS_TYPES_TO_SHOW.GetValue();
RefreshAll();
}
void EditMenu::RefreshAll()
{
ChangeToRow( GetFirstRow() );
OnRowValueChanged( (EditMenuRow)0 );
// Select the current song if any
if( GAMESTATE->m_pCurSong )
{
for( unsigned i=0; i<m_sGroups.size(); i++ )
if( GAMESTATE->m_pCurSong->m_sGroupName == m_sGroups[i] )
m_iSelection[ROW_GROUP] = i;
OnRowValueChanged( ROW_GROUP );
for( unsigned i=0; i<m_pSongs.size(); i++ )
if( GAMESTATE->m_pCurSong == m_pSongs[i] )
m_iSelection[ROW_SONG] = i;
OnRowValueChanged( ROW_SONG );
// Select the current StepsType and difficulty if any
if( GAMESTATE->m_pCurSteps[PLAYER_1] )
{
for( unsigned i=0; i<m_StepsTypes.size(); i++ )
{
if( m_StepsTypes[i] == GAMESTATE->m_pCurSteps[PLAYER_1]->m_StepsType )
{
m_iSelection[ROW_STEPS_TYPE] = i;
OnRowValueChanged( ROW_STEPS_TYPE );
}
}
for( unsigned i=0; i<m_vpSteps.size(); i++ )
{
const Steps *pSteps = m_vpSteps[i].pSteps;
if( pSteps == GAMESTATE->m_pCurSteps[PLAYER_1] )
{
m_iSelection[ROW_STEPS] = i;
OnRowValueChanged( ROW_STEPS );
}
}
}
}
}
bool EditMenu::CanGoUp()
{
return m_SelectedRow != GetFirstRow();
}
bool EditMenu::CanGoDown()
{
return m_SelectedRow != NUM_EditMenuRow-1;
}
bool EditMenu::CanGoLeft()
{
if( m_SelectedRow == ROW_SONG || m_SelectedRow == ROW_GROUP )
return true; // wraps
return m_iSelection[m_SelectedRow] != 0;
}
int EditMenu::GetRowSize( EditMenuRow er ) const
{
switch( er )
{
case ROW_GROUP: return m_sGroups.size();
case ROW_SONG: return m_pSongs.size();
case ROW_STEPS_TYPE: return m_StepsTypes.size();
case ROW_STEPS: return m_vpSteps.size();
case ROW_SOURCE_STEPS_TYPE: return m_StepsTypes.size();
case ROW_SOURCE_STEPS: return m_vpSourceSteps.size();
case ROW_ACTION: return m_Actions.size();
default: FAIL_M( ssprintf("Non-existant EditMenuRow %i", er) );
}
}
bool EditMenu::CanGoRight()
{
if( m_SelectedRow == ROW_SONG || m_SelectedRow == ROW_GROUP )
return true; // wraps
return m_iSelection[m_SelectedRow] != GetRowSize(m_SelectedRow)-1;
}
bool EditMenu::RowIsSelectable( EditMenuRow row )
{
if( EDIT_MODE == EditMode_Home && row == ROW_STEPS )
return false;
if( GetSelectedSteps() )
{
switch( row )
{
case ROW_SOURCE_STEPS_TYPE:
case ROW_SOURCE_STEPS:
return false;
default: return true;
}
}
return true;
}
void EditMenu::Up()
{
EditMenuRow dest = m_SelectedRow;
do{
dest = (EditMenuRow)(dest - 1);
} while (!RowIsSelectable(dest));
ASSERT( dest >= 0 );
ChangeToRow( dest );
m_soundChangeRow.Play();
}
void EditMenu::Down()
{
EditMenuRow dest = m_SelectedRow;
do
{
dest = (EditMenuRow)(dest + 1);
} while (!RowIsSelectable(dest));
ASSERT( dest < NUM_EditMenuRow );
ChangeToRow( dest );
m_soundChangeRow.Play();
}
void EditMenu::Left()
{
if( CanGoLeft() )
{
m_iSelection[m_SelectedRow]--;
wrap( m_iSelection[m_SelectedRow], GetRowSize(m_SelectedRow) );
OnRowValueChanged( m_SelectedRow );
m_soundChangeValue.Play();
}
}
void EditMenu::Right()
{
if( CanGoRight() )
{
m_iSelection[m_SelectedRow]++;
wrap( m_iSelection[m_SelectedRow], GetRowSize(m_SelectedRow) );
OnRowValueChanged( m_SelectedRow );
m_soundChangeValue.Play();
}
}
void EditMenu::ChangeToRow( EditMenuRow newRow )
{
m_textLabel[newRow].PlayCommand("GainFocus");
m_textValue[newRow].PlayCommand("GainFocus");
m_textLabel[m_SelectedRow].PlayCommand("LoseFocus");
m_textValue[m_SelectedRow].PlayCommand("LoseFocus");
m_SelectedRow = newRow;
for( int i=0; i<2; i++ )
m_sprArrows[i]->SetY( ROW_Y.GetValue(newRow) );
UpdateArrows();
}
void EditMenu::UpdateArrows()
{
m_sprArrows[0]->RunCommands( CanGoLeft() ? ARROWS_ENABLED_COMMAND : ARROWS_DISABLED_COMMAND );
m_sprArrows[1]->RunCommands( CanGoRight() ? ARROWS_ENABLED_COMMAND : ARROWS_DISABLED_COMMAND );
m_sprArrows[0]->EnableAnimation( CanGoLeft() );
m_sprArrows[1]->EnableAnimation( CanGoRight() );
}
static LocalizedString BLANK ( "EditMenu", "Blank" );
void EditMenu::OnRowValueChanged( EditMenuRow row )
{
UpdateArrows();
EditMode mode = EDIT_MODE.GetValue();
switch( row )
{
case ROW_GROUP:
m_textValue[ROW_GROUP].SetText( SONGMAN->ShortenGroupName(GetSelectedGroup()) );
if( SHOW_GROUPS.GetValue() )
{
m_GroupBanner.LoadFromSongGroup( GetSelectedGroup() );
m_GroupBanner.PlayCommand("Changed");
}
m_pSongs.clear();
if( mode == EditMode_Practice )
{
m_pSongs.clear();
vector<Song*> vtSongs;
GetSongsToShowForGroup( GetSelectedGroup(), vtSongs );
// Filter out songs that aren't playable.
FOREACH( Song*, vtSongs, s )
if( SongUtil::IsSongPlayable(*s) )
m_pSongs.push_back(*s);
}
else
GetSongsToShowForGroup( GetSelectedGroup(), m_pSongs );
m_iSelection[ROW_SONG] = 0;
// fall through
case ROW_SONG:
m_textValue[ROW_SONG].SetText( "" );
m_SongBanner.LoadFromSong( GetSelectedSong() );
m_SongBanner.PlayCommand("Changed");
m_SongTextBanner.SetFromSong( GetSelectedSong() );
if( mode == EditMode_Practice )
{
StepsType orgSel = StepsType_Invalid;
if( !m_StepsTypes.empty() ) // Not first run
{
ASSERT( (int) m_StepsTypes.size() > m_iSelection[ROW_STEPS_TYPE] );
orgSel = m_StepsTypes[m_iSelection[ROW_STEPS_TYPE]];
}
// The StepsType selection may no longer be valid. Zero it for now.
m_iSelection[ROW_STEPS_TYPE] = 0;
m_StepsTypes.clear();
// Only show StepsTypes for which we have valid Steps.
vector<StepsType> vSts = CommonMetrics::STEPS_TYPES_TO_SHOW.GetValue();
FOREACH( StepsType, vSts, st )
{
if( SongUtil::GetStepsByDifficulty( GetSelectedSong(), *st, Difficulty_Invalid, false) != NULL )
m_StepsTypes.push_back( *st );
// Try to preserve the user's StepsType selection.
if( *st == orgSel )
m_iSelection[ROW_STEPS_TYPE] = m_StepsTypes.size() - 1;
}
}
// fall through
case ROW_STEPS_TYPE:
m_textValue[ROW_STEPS_TYPE].SetText( GAMEMAN->GetStepsTypeInfo(GetSelectedStepsType()).GetLocalizedString() );
{
Difficulty dcOld = Difficulty_Invalid;
if( !m_vpSteps.empty() )
dcOld = GetSelectedDifficulty();
m_vpSteps.clear();
FOREACH_ENUM( Difficulty, dc )
{
if( dc == Difficulty_Edit )
{
switch( mode )
{
case EditMode_Full:
case EditMode_CourseMods:
case EditMode_Practice:
{
vector<Steps*> v;
SongUtil::GetSteps( GetSelectedSong(), v, GetSelectedStepsType(), Difficulty_Edit );
StepsUtil::SortStepsByDescription( v );
FOREACH_CONST( Steps*, v, p )
m_vpSteps.push_back( StepsAndDifficulty(*p,dc) );
}
break;
case EditMode_Home:
// have only "New Edit"
break;
default:
FAIL_M(ssprintf("Invalid edit mode: %i", mode));
}
switch( mode )
{
case EditMode_Practice:
case EditMode_CourseMods:
break;
case EditMode_Home:
case EditMode_Full:
m_vpSteps.push_back( StepsAndDifficulty(NULL,dc) ); // "New Edit"
break;
default:
FAIL_M(ssprintf("Invalid edit mode: %i", mode));
}
}
else
{
Steps *pSteps = SongUtil::GetStepsByDifficulty( GetSelectedSong(), GetSelectedStepsType(), dc );
if( pSteps && UNLOCKMAN->StepsIsLocked( GetSelectedSong(), pSteps ) )
pSteps = NULL;
switch( mode )
{
case EditMode_Home:
// don't allow selecting of non-edits in HomeMode
break;
case EditMode_Practice:
case EditMode_CourseMods:
// only show this difficulty if steps exist
if( pSteps )
m_vpSteps.push_back( StepsAndDifficulty(pSteps,dc) );
break;
case EditMode_Full:
// show this difficulty whether or not steps exist.
m_vpSteps.push_back( StepsAndDifficulty(pSteps,dc) );
break;
default:
FAIL_M(ssprintf("Invalid edit mode: %i", mode));
}
}
}
StripLockedStepsAndDifficulty( m_vpSteps );
FOREACH( StepsAndDifficulty, m_vpSteps, s )
{
if( s->dc == dcOld )
{
m_iSelection[ROW_STEPS] = s - m_vpSteps.begin();
break;
}
}
}
CLAMP( m_iSelection[ROW_STEPS], 0, m_vpSteps.size()-1 );
// fall through
case ROW_STEPS:
{
RString s = CustomDifficultyToLocalizedString( GetCustomDifficulty( GetSelectedStepsType(), GetSelectedDifficulty(), CourseType_Invalid ) );
m_textValue[ROW_STEPS].SetText( s );
}
if( GetSelectedSteps() )
m_StepsDisplay.SetFromSteps( GetSelectedSteps() );
else
m_StepsDisplay.SetFromStepsTypeAndMeterAndDifficultyAndCourseType( GetSelectedSourceStepsType(), 0, GetSelectedDifficulty(), CourseType_Invalid );
// fall through
case ROW_SOURCE_STEPS_TYPE:
m_textLabel[ROW_SOURCE_STEPS_TYPE].SetVisible( GetSelectedSteps() ? false : true );
m_textValue[ROW_SOURCE_STEPS_TYPE].SetVisible( GetSelectedSteps() ? false : true );
m_textValue[ROW_SOURCE_STEPS_TYPE].SetText( GAMEMAN->GetStepsTypeInfo(GetSelectedSourceStepsType()).GetLocalizedString() );
m_vpSourceSteps.clear();
m_vpSourceSteps.push_back( StepsAndDifficulty(NULL,Difficulty_Invalid) ); // "blank"
FOREACH_ENUM( Difficulty, dc )
{
// fill in m_vpSourceSteps
if( dc != Difficulty_Edit )
{
Steps *pSteps = SongUtil::GetStepsByDifficulty( GetSelectedSong(), GetSelectedSourceStepsType(), dc );
if( pSteps != NULL )
m_vpSourceSteps.push_back( StepsAndDifficulty(pSteps,dc) );
}
else
{
vector<Steps*> v;
SongUtil::GetSteps( GetSelectedSong(), v, GetSelectedSourceStepsType(), dc );
StepsUtil::SortStepsByDescription( v );
FOREACH_CONST( Steps*, v, pSteps )
m_vpSourceSteps.push_back( StepsAndDifficulty(*pSteps,dc) );
}
}
StripLockedStepsAndDifficulty( m_vpSteps );
CLAMP( m_iSelection[ROW_SOURCE_STEPS], 0, m_vpSourceSteps.size()-1 );
// fall through
case ROW_SOURCE_STEPS:
{
m_textLabel[ROW_SOURCE_STEPS].SetVisible( GetSelectedSteps() ? false : true );
m_textValue[ROW_SOURCE_STEPS].SetVisible( GetSelectedSteps() ? false : true );
{
RString s;
if( GetSelectedSourceDifficulty() == Difficulty_Invalid )
{
s = BLANK;
}
else
{
s = CustomDifficultyToLocalizedString( GetCustomDifficulty( GetSelectedSourceStepsType(), GetSelectedSourceDifficulty(), CourseType_Invalid ) );
}
m_textValue[ROW_SOURCE_STEPS].SetText( s );
}
bool bHideMeter = false;
if( GetSelectedSourceDifficulty() == Difficulty_Invalid )
bHideMeter = true;
else if( GetSelectedSourceSteps() )
m_StepsDisplaySource.SetFromSteps( GetSelectedSourceSteps() );
else
m_StepsDisplaySource.SetFromStepsTypeAndMeterAndDifficultyAndCourseType( GetSelectedSourceStepsType(), 0, GetSelectedSourceDifficulty(), CourseType_Invalid );
m_StepsDisplaySource.SetVisible( !(bHideMeter || GetSelectedSteps()) );
m_Actions.clear();
if( GetSelectedSteps() )
{
switch( mode )
{
case EditMode_Practice:
case EditMode_CourseMods:
m_Actions.push_back( EditMenuAction_Practice );
break;
case EditMode_Home:
case EditMode_Full:
m_Actions.push_back( EditMenuAction_Edit );
m_Actions.push_back( EditMenuAction_Delete );
break;
default:
FAIL_M(ssprintf("Invalid edit mode: %i", mode));
}
}
else
{
m_Actions.push_back( EditMenuAction_Create );
}
m_iSelection[ROW_ACTION] = 0;
}
// fall through
case ROW_ACTION:
m_textValue[ROW_ACTION].SetText( EditMenuActionToLocalizedString(GetSelectedAction()) );
break;
default:
FAIL_M(ssprintf("Invalid EditMenuRow: %i", row));
}
}
/*
* (c) 2001-2004 Chris Danford
* 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.
*/