From fbb5f8780123021c80478abd8c675f0fad9df949 Mon Sep 17 00:00:00 2001 From: rubidium Date: Wed, 9 Feb 2011 12:59:39 +0000 Subject: [PATCH] (svn r22035) -Codechange: refactor (display) unit conversion to happen at a single place --- src/strings.cpp | 102 +++++++++++++++++++++++++++++------------------- 1 file changed, 61 insertions(+), 41 deletions(-) diff --git a/src/strings.cpp b/src/strings.cpp index 1edea200b7..b5d44a0155 100644 --- a/src/strings.cpp +++ b/src/strings.cpp @@ -543,54 +543,74 @@ static const char *ParseStringChoice(const char *b, uint form, char **dst, const return b + pos; } +/** Helper for unit conversion. */ +struct UnitConversion { + int multiplier; ///< Amount to multiply upon conversion. + int shift; ///< Amount to shift upon conversion. + + /** + * Convert value from OpenTTD's internal unit into the displayed value. + * @param input The input to convert. + * @return The converted value. + */ + int ToDisplay(int input) const + { + return (input * this->multiplier) >> this->shift; + } + + /** + * Convert the displayed value back into a value of OpenTTD's internal unit. + * @param input The input to convert. + * @return The converted value. + */ + int FromDisplay(int input) const + { + return ((input << this->shift) + this->multiplier / 2) / this->multiplier; + } +}; + struct Units { - int s_m; ///< Multiplier for velocity - int s_s; ///< Shift for velocity + UnitConversion s; ///< Multiplier for velocity StringID velocity; ///< String for velocity - int p_m; ///< Multiplier for power - int p_s; ///< Shift for power + UnitConversion p; ///< Multiplier for power StringID power; ///< String for velocity - int w_m; ///< Multiplier for weight - int w_s; ///< Shift for weight + UnitConversion w; ///< Multiplier for weight StringID s_weight; ///< Short string for weight StringID l_weight; ///< Long string for weight - int v_m; ///< Multiplier for volume - int v_s; ///< Shift for volume + UnitConversion v; ///< Multiplier for volume StringID s_volume; ///< Short string for volume StringID l_volume; ///< Long string for volume - int f_m; ///< Multiplier for force - int f_s; ///< Shift for force + UnitConversion f; ///< Multiplier for force StringID force; ///< String for force - int h_m; ///< Multiplier for height - int h_s; ///< Shift for height + UnitConversion h; ///< Multiplier for height StringID height; ///< String for height }; /* Unit conversions */ static const Units units[] = { { // Imperial (Original, mph, hp, metric ton, litre, kN, ft) - 1, 0, STR_UNITS_VELOCITY_IMPERIAL, - 1, 0, STR_UNITS_POWER_IMPERIAL, - 1, 0, STR_UNITS_WEIGHT_SHORT_METRIC, STR_UNITS_WEIGHT_LONG_METRIC, - 1000, 0, STR_UNITS_VOLUME_SHORT_METRIC, STR_UNITS_VOLUME_LONG_METRIC, - 1, 0, STR_UNITS_FORCE_SI, - 3, 0, STR_UNITS_HEIGHT_IMPERIAL, + { 1, 0}, STR_UNITS_VELOCITY_IMPERIAL, + { 1, 0}, STR_UNITS_POWER_IMPERIAL, + { 1, 0}, STR_UNITS_WEIGHT_SHORT_METRIC, STR_UNITS_WEIGHT_LONG_METRIC, + {1000, 0}, STR_UNITS_VOLUME_SHORT_METRIC, STR_UNITS_VOLUME_LONG_METRIC, + { 1, 0}, STR_UNITS_FORCE_SI, + { 3, 0}, STR_UNITS_HEIGHT_IMPERIAL, }, { // Metric (km/h, hp, metric ton, litre, kN, metre) - 103, 6, STR_UNITS_VELOCITY_METRIC, - 1, 0, STR_UNITS_POWER_METRIC, - 1, 0, STR_UNITS_WEIGHT_SHORT_METRIC, STR_UNITS_WEIGHT_LONG_METRIC, - 1000, 0, STR_UNITS_VOLUME_SHORT_METRIC, STR_UNITS_VOLUME_LONG_METRIC, - 1, 0, STR_UNITS_FORCE_SI, - 1, 0, STR_UNITS_HEIGHT_SI, + { 103, 6}, STR_UNITS_VELOCITY_METRIC, + { 1, 0}, STR_UNITS_POWER_METRIC, + { 1, 0}, STR_UNITS_WEIGHT_SHORT_METRIC, STR_UNITS_WEIGHT_LONG_METRIC, + {1000, 0}, STR_UNITS_VOLUME_SHORT_METRIC, STR_UNITS_VOLUME_LONG_METRIC, + { 1, 0}, STR_UNITS_FORCE_SI, + { 1, 0}, STR_UNITS_HEIGHT_SI, }, { // SI (m/s, kilowatt, kilogram, cubic metre, kilonewton, metre) - 1831, 12, STR_UNITS_VELOCITY_SI, - 764, 10, STR_UNITS_POWER_SI, - 1000, 0, STR_UNITS_WEIGHT_SHORT_SI, STR_UNITS_WEIGHT_LONG_SI, - 1, 0, STR_UNITS_VOLUME_SHORT_SI, STR_UNITS_VOLUME_LONG_SI, - 1, 0, STR_UNITS_FORCE_SI, - 1, 0, STR_UNITS_HEIGHT_SI, + {1831, 12}, STR_UNITS_VELOCITY_SI, + { 764, 10}, STR_UNITS_POWER_SI, + {1000, 0}, STR_UNITS_WEIGHT_SHORT_SI, STR_UNITS_WEIGHT_LONG_SI, + { 1, 0}, STR_UNITS_VOLUME_SHORT_SI, STR_UNITS_VOLUME_LONG_SI, + { 1, 0}, STR_UNITS_FORCE_SI, + { 1, 0}, STR_UNITS_HEIGHT_SI, }, }; @@ -601,7 +621,7 @@ static const Units units[] = { */ uint ConvertSpeedToDisplaySpeed(uint speed) { - return (speed * units[_settings_game.locale.units].s_m) >> units[_settings_game.locale.units].s_s; + return units[_settings_game.locale.units].s.ToDisplay(speed); } /** @@ -611,7 +631,7 @@ uint ConvertSpeedToDisplaySpeed(uint speed) */ uint ConvertDisplaySpeedToSpeed(uint speed) { - return ((speed << units[_settings_game.locale.units].s_s) + units[_settings_game.locale.units].s_m / 2) / units[_settings_game.locale.units].s_m; + return units[_settings_game.locale.units].s.FromDisplay(speed); } /** @@ -721,7 +741,7 @@ static char *FormatString(char *buff, const char *str_arg, int64 *argv, const in } case SCC_HEIGHT: { // {HEIGHT} - int64 args[1] = {GetInt32(&argv, argve, &argt) * units[_settings_game.locale.units].h_m >> units[_settings_game.locale.units].h_s}; + int64 args[1] = {units[_settings_game.locale.units].h.ToDisplay(GetInt32(&argv, argve, &argt))}; buff = FormatString(buff, GetStringPtr(units[_settings_game.locale.units].height), args, endof(args), modifier >> 24, last); modifier = 0; break; @@ -744,7 +764,7 @@ static char *FormatString(char *buff, const char *str_arg, int64 *argv, const in case STR_TONS: { int64 args[1]; assert(_settings_game.locale.units < lengthof(units)); - args[0] = GetInt32(&argv, argve, &argt) * units[_settings_game.locale.units].w_m >> units[_settings_game.locale.units].w_s; + args[0] = units[_settings_game.locale.units].w.ToDisplay(GetInt32(&argv, argve, &argt)); buff = FormatString(buff, GetStringPtr(units[_settings_game.locale.units].l_weight), args, endof(args), modifier >> 24, last); modifier = 0; break; @@ -753,7 +773,7 @@ static char *FormatString(char *buff, const char *str_arg, int64 *argv, const in case STR_LITERS: { int64 args[1]; assert(_settings_game.locale.units < lengthof(units)); - args[0] = GetInt32(&argv, argve, &argt) * units[_settings_game.locale.units].v_m >> units[_settings_game.locale.units].v_s; + args[0] = units[_settings_game.locale.units].v.ToDisplay(GetInt32(&argv, argve, &argt)); buff = FormatString(buff, GetStringPtr(units[_settings_game.locale.units].l_volume), args, endof(args), modifier >> 24, last); modifier = 0; break; @@ -839,7 +859,7 @@ static char *FormatString(char *buff, const char *str_arg, int64 *argv, const in case SCC_VOLUME: { // {VOLUME} int64 args[1]; assert(_settings_game.locale.units < lengthof(units)); - args[0] = GetInt32(&argv, argve, &argt, SCC_VOLUME) * units[_settings_game.locale.units].v_m >> units[_settings_game.locale.units].v_s; + args[0] = units[_settings_game.locale.units].v.ToDisplay(GetInt32(&argv, argve, &argt, SCC_VOLUME)); buff = FormatString(buff, GetStringPtr(units[_settings_game.locale.units].l_volume), args, endof(args), modifier >> 24, last); modifier = 0; break; @@ -897,7 +917,7 @@ static char *FormatString(char *buff, const char *str_arg, int64 *argv, const in case SCC_POWER: { // {POWER} int64 args[1]; assert(_settings_game.locale.units < lengthof(units)); - args[0] = GetInt32(&argv, argve, &argt) * units[_settings_game.locale.units].p_m >> units[_settings_game.locale.units].p_s; + args[0] = units[_settings_game.locale.units].p.ToDisplay(GetInt32(&argv, argve, &argt)); buff = FormatString(buff, GetStringPtr(units[_settings_game.locale.units].power), args, endof(args), modifier >> 24, last); modifier = 0; break; @@ -906,7 +926,7 @@ static char *FormatString(char *buff, const char *str_arg, int64 *argv, const in case SCC_VOLUME_SHORT: { // {VOLUME_S} int64 args[1]; assert(_settings_game.locale.units < lengthof(units)); - args[0] = GetInt32(&argv, argve, &argt) * units[_settings_game.locale.units].v_m >> units[_settings_game.locale.units].v_s; + args[0] = units[_settings_game.locale.units].v.ToDisplay(GetInt32(&argv, argve, &argt)); buff = FormatString(buff, GetStringPtr(units[_settings_game.locale.units].s_volume), args, endof(args), modifier >> 24, last); modifier = 0; break; @@ -915,7 +935,7 @@ static char *FormatString(char *buff, const char *str_arg, int64 *argv, const in case SCC_WEIGHT: { // {WEIGHT} int64 args[1]; assert(_settings_game.locale.units < lengthof(units)); - args[0] = GetInt32(&argv, argve, &argt, SCC_WEIGHT) * units[_settings_game.locale.units].w_m >> units[_settings_game.locale.units].w_s; + args[0] = units[_settings_game.locale.units].w.ToDisplay(GetInt32(&argv, argve, &argt, SCC_WEIGHT)); buff = FormatString(buff, GetStringPtr(units[_settings_game.locale.units].l_weight), args, endof(args), modifier >> 24, last); modifier = 0; break; @@ -924,7 +944,7 @@ static char *FormatString(char *buff, const char *str_arg, int64 *argv, const in case SCC_WEIGHT_SHORT: { // {WEIGHT_S} int64 args[1]; assert(_settings_game.locale.units < lengthof(units)); - args[0] = GetInt32(&argv, argve, &argt) * units[_settings_game.locale.units].w_m >> units[_settings_game.locale.units].w_s; + args[0] = units[_settings_game.locale.units].w.ToDisplay(GetInt32(&argv, argve, &argt)); buff = FormatString(buff, GetStringPtr(units[_settings_game.locale.units].s_weight), args, endof(args), modifier >> 24, last); modifier = 0; break; @@ -933,7 +953,7 @@ static char *FormatString(char *buff, const char *str_arg, int64 *argv, const in case SCC_FORCE: { // {FORCE} int64 args[1]; assert(_settings_game.locale.units < lengthof(units)); - args[0] = GetInt32(&argv, argve, &argt) * units[_settings_game.locale.units].f_m >> units[_settings_game.locale.units].f_s; + args[0] = units[_settings_game.locale.units].f.ToDisplay(GetInt32(&argv, argve, &argt)); buff = FormatString(buff, GetStringPtr(units[_settings_game.locale.units].force), args, endof(args), modifier >> 24, last); modifier = 0; break;