CommonMetrics.h

#ifndef COMMON_METRICS_H
#define COMMON_METRICS_H

#include "ThemeMetric.h"
#include "PlayerNumber.h"
#include "Difficulty.h"
#include "GameConstantsAndTypes.h"
#include "LocalizedString.h"

// Types
class ThemeMetricDifficultiesToShow : public ThemeMetric<std::string>
{
public:
	ThemeMetricDifficultiesToShow(): m_v() { }
	ThemeMetricDifficultiesToShow( const std::string& sGroup, const std::string& sName );
	void Read();
	const std::vector<Difficulty> &GetValue() const;
private:
	std::vector<Difficulty> m_v;
};
class ThemeMetricCourseDifficultiesToShow : public ThemeMetric<std::string>
{
public:
	ThemeMetricCourseDifficultiesToShow(): m_v() { }
	ThemeMetricCourseDifficultiesToShow( const std::string& sGroup, const std::string& sName );
	void Read();
	const std::vector<CourseDifficulty> &GetValue() const;
private:
	std::vector<CourseDifficulty> m_v;
};
class ThemeMetricStepsTypesToShow : public ThemeMetric<std::string>
{
public:
	ThemeMetricStepsTypesToShow(): m_v() { }
	ThemeMetricStepsTypesToShow( const std::string& sGroup, const std::string& sName );
	void Read();
	const std::vector<StepsType> &GetValue() const;
private:
	std::vector<StepsType> m_v;
};


/**
 * @brief Definitions of metrics that are in the "Common" group.
 *
 * These metrics are used throughout the metrics file. */
namespace CommonMetrics
{
	/** @brief The first screen in the attract loop. */
	extern ThemeMetric<std::string>		FIRST_ATTRACT_SCREEN;
	/** @brief The screen that appears when pressing the operator button. */
	extern ThemeMetric<std::string>		OPERATOR_MENU_SCREEN;
	/** @brief The default modifiers to apply. */
	extern ThemeMetric<std::string>		DEFAULT_MODIFIERS;
	/** @brief The caption on the title bar. */
	extern LocalizedString				WINDOW_TITLE;
	/** @brief How many entries should be shown before showing "Various" instead. */
	extern ThemeMetric<int>			MAX_COURSE_ENTRIES_BEFORE_VARIOUS;
	/** @brief Adjusts the assist tick sound's playback time. */
	extern ThemeMetric<float>			TICK_EARLY_SECONDS;
	/** @brief Which difficulties are to be shown? */
	extern ThemeMetricDifficultiesToShow	DIFFICULTIES_TO_SHOW;
	/** @brief Which course difficulties are to be shown? */
	extern ThemeMetricCourseDifficultiesToShow	COURSE_DIFFICULTIES_TO_SHOW;
	/**
	 * @brief Which step types are to be shown?
	 *
	 * This metric (StepsTypesToHide) takes a list of StepsTypes to hide and
	 * returns a list of StepsTypes to show. */
	extern ThemeMetricStepsTypesToShow	STEPS_TYPES_TO_SHOW;
	/** @brief Does the player need to explicitly set a style? */
	extern ThemeMetric<bool>			AUTO_SET_STYLE;
	/** @brief How many decimal places are used? */
	extern ThemeMetric<int>			PERCENT_SCORE_DECIMAL_PLACES;

	std::string LocalizeOptionItem( const std::string &s, bool bOptional );
};

#endif

/**
 * @file
 * @author Chris Danford (c) 2003-2004
 * @section LICENSE
 * 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.
 */