command.cpp

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
 */
 
#include "stdafx.h"
#include "landscape.h"
#include "error.h"
#include "gui.h"
#include "command_func.h"
#include "network/network_type.h"
#include "network/network.h"
#include "genworld.h"
#include "strings_func.h"
#include "texteff.hpp"
#include "town.h"
#include "timer/timer_game_economy.h"
#include "company_func.h"
#include "company_base.h"
#include "signal_func.h"
#include "core/backup_type.hpp"
#include "object_base.h"
#include "autoreplace_cmd.h"
#include "company_cmd.h"
#include "depot_cmd.h"
#include "economy_cmd.h"
#include "engine_cmd.h"
#include "goal_cmd.h"
#include "group_cmd.h"
#include "industry_cmd.h"
#include "league_cmd.h"
#include "landscape_cmd.h"
#include "misc_cmd.h"
#include "news_cmd.h"
#include "object_cmd.h"
#include "order_cmd.h"
#include "rail_cmd.h"
#include "road_cmd.h"
#include "roadveh_cmd.h"
#include "settings_cmd.h"
#include "signs_cmd.h"
#include "station_cmd.h"
#include "story_cmd.h"
#include "subsidy_cmd.h"
#include "terraform_cmd.h"
#include "timetable_cmd.h"
#include "town_cmd.h"
#include "train_cmd.h"
#include "tree_cmd.h"
#include "tunnelbridge_cmd.h"
#include "vehicle_cmd.h"
#include "viewport_cmd.h"
#include "water_cmd.h"
#include "waypoint_cmd.h"
#include "misc/endian_buffer.hpp"
#include "string_func.h"
 
#include "table/strings.h"
 
#include "safeguards.h"
 
 
int RecursiveCommandCounter::_counter = 0;
 
 
struct CommandInfo {
  const char *name;   
  CommandFlags flags; 
  CommandType type;   
};
/* Helpers to generate the master command table from the command traits. */
template <typename T>
inline constexpr CommandInfo CommandFromTrait() noexcept { return { T::name, T::flags, T::type }; };
 
template <typename T, T... i>
inline constexpr auto MakeCommandsFromTraits(std::integer_sequence<T, i...>) noexcept {
  return std::array<CommandInfo, sizeof...(i)>{{ CommandFromTrait<CommandTraits<static_cast<Commands>(i)>>()... }};
}
 
static constexpr auto _command_proc_table = MakeCommandsFromTraits(std::make_integer_sequence<std::underlying_type_t<Commands>, CMD_END>{});
 
 
bool IsValidCommand(Commands cmd)
{
  return cmd < _command_proc_table.size();
}
 
CommandFlags GetCommandFlags(Commands cmd)
{
  assert(IsValidCommand(cmd));
 
  return _command_proc_table[cmd].flags;
}
 
const char *GetCommandName(Commands cmd)
{
  assert(IsValidCommand(cmd));
 
  return _command_proc_table[cmd].name;
}
 
bool IsCommandAllowedWhilePaused(Commands cmd)
{
  /* Lookup table for the command types that are allowed for a given pause level setting. */
  static const int command_type_lookup[] = {
    CMDPL_ALL_ACTIONS,     
    CMDPL_NO_LANDSCAPING,  
    CMDPL_NO_LANDSCAPING,  
    CMDPL_NO_CONSTRUCTION, 
    CMDPL_NO_CONSTRUCTION, 
    CMDPL_NO_CONSTRUCTION, 
    CMDPL_NO_ACTIONS,      
    CMDPL_NO_ACTIONS,      
    CMDPL_NO_ACTIONS,      
  };
  static_assert(lengthof(command_type_lookup) == CMDT_END);
 
  assert(IsValidCommand(cmd));
  return _game_mode == GM_EDITOR || command_type_lookup[_command_proc_table[cmd].type] <= _settings_game.construction.command_pause_level;
}
 
void CommandHelperBase::InternalDoBefore(bool top_level, bool test)
{
  if (top_level) _cleared_object_areas.clear();
  if (test) SetTownRatingTestMode(true);
}
 
void CommandHelperBase::InternalDoAfter(CommandCost &res, DoCommandFlags flags, bool top_level, bool test)
{
  if (test) {
    SetTownRatingTestMode(false);
 
    if (res.Succeeded() && top_level && !flags.Test(DoCommandFlag::QueryCost) && !flags.Test(DoCommandFlag::Bankrupt)) {
      CheckCompanyHasMoney(res); // CheckCompanyHasMoney() modifies 'res' to an error if it fails.
    }
  } else {
    /* If top-level, subtract the money. */
    if (res.Succeeded() && top_level && !flags.Test(DoCommandFlag::Bankrupt)) {
      SubtractMoneyFromCompany(res);
    }
  }
}
 
std::tuple<bool, bool, bool> CommandHelperBase::InternalPostBefore(Commands cmd, CommandFlags flags, TileIndex tile, StringID err_message, bool network_command)
{
  /* Cost estimation is generally only done when the
   * local user presses shift while doing something.
   * However, in case of incoming network commands,
   * map generation or the pause button we do want
   * to execute. */
  bool estimate_only = _shift_pressed && IsLocalCompany() && !_generating_world && !network_command && !flags.Test(CommandFlag::NoEst);
 
  /* We're only sending the command, so don't do
   * fancy things for 'success'. */
  bool only_sending = _networking && !network_command;
 
  if (_pause_mode.Any() && !IsCommandAllowedWhilePaused(cmd) && !estimate_only) {
    ShowErrorMessage(GetEncodedString(err_message), GetEncodedString(STR_ERROR_NOT_ALLOWED_WHILE_PAUSED),
      WL_INFO, TileX(tile) * TILE_SIZE, TileY(tile) * TILE_SIZE);
    return { true, estimate_only, only_sending };
  } else {
    return { false, estimate_only, only_sending };
  }
}
 
void CommandHelperBase::InternalPostResult(const CommandCost &res, TileIndex tile, bool estimate_only, bool only_sending, StringID err_message, bool my_cmd)
{
  int x = TileX(tile) * TILE_SIZE;
  int y = TileY(tile) * TILE_SIZE;
 
  if (res.Failed()) {
    /* Only show the error when it's for us. */
    if (estimate_only || (IsLocalCompany() && err_message != 0 && my_cmd)) {
      ShowErrorMessage(GetEncodedString(err_message), x, y, res);
    }
  } else if (estimate_only) {
    ShowEstimatedCostOrIncome(res.GetCost(), x, y);
  } else if (!only_sending && tile != 0 && IsLocalCompany() && _game_mode != GM_EDITOR) {
    /* Only show the cost animation when we did actually
     * execute the command, i.e. we're not sending it to
     * the server, when it has cost the local company
     * something. Furthermore in the editor there is no
     * concept of cost, so don't show it there either. */
    ShowCostOrIncomeAnimation(x, y, GetSlopePixelZ(x, y), res.GetCost());
  }
}
 
void CommandHelperBase::LogCommandExecution(Commands cmd, StringID err_message, const CommandDataBuffer &args, bool failed)
{
  Debug(desync, 1, "{}: {:08x}; {:02x}; {:02x}; {:08x}; {:08x}; {} ({})", failed ? "cmdf" : "cmd", (uint32_t)TimerGameEconomy::date.base(), TimerGameEconomy::date_fract, _current_company, cmd, err_message, FormatArrayAsHex(args), GetCommandName(cmd));
}
 
bool CommandHelperBase::InternalExecutePrepTest(CommandFlags cmd_flags, TileIndex, Backup<CompanyID> &cur_company)
{
  /* Always execute server and spectator commands as spectator */
  bool exec_as_spectator = cmd_flags.Any({CommandFlag::Spectator, CommandFlag::Server});
 
  /* If the company isn't valid it may only do server command or start a new company!
   * The server will ditch any server commands a client sends to it, so effectively
   * this guards the server from executing functions for an invalid company. */
  if (_game_mode == GM_NORMAL && !exec_as_spectator && !Company::IsValidID(_current_company) && !(_current_company == OWNER_DEITY && cmd_flags.Test(CommandFlag::Deity))) {
    return false;
  }
 
  if (exec_as_spectator) cur_company.Change(COMPANY_SPECTATOR);
 
  /* Enter test mode. */
  _cleared_object_areas.clear();
  SetTownRatingTestMode(true);
  BasePersistentStorageArray::SwitchMode(PSM_ENTER_TESTMODE);
  return true;
}
 
std::tuple<bool, bool, bool> CommandHelperBase::InternalExecuteValidateTestAndPrepExec(CommandCost &res, CommandFlags cmd_flags, bool estimate_only, bool network_command, [[maybe_unused]] Backup<CompanyID> &cur_company)
{
  BasePersistentStorageArray::SwitchMode(PSM_LEAVE_TESTMODE);
  SetTownRatingTestMode(false);
 
  /* Make sure we're not messing things up here. */
  assert(cmd_flags.Any({CommandFlag::Spectator, CommandFlag::Server}) ? _current_company == COMPANY_SPECTATOR : cur_company.Verify());
 
  /* If the command fails, we're doing an estimate
   * or the player does not have enough money
   * (unless it's a command where the test and
   * execution phase might return different costs)
   * we bail out here. */
  bool test_and_exec_can_differ = cmd_flags.Test(CommandFlag::NoTest);
  if (res.Failed() || estimate_only || (!test_and_exec_can_differ && !CheckCompanyHasMoney(res))) {
    return { true, !_networking || _generating_world || network_command, false };
  }
 
  bool send_net = _networking && !_generating_world && !network_command;
 
  if (!send_net) {
    /* Prepare for command execution. */
    _cleared_object_areas.clear();
    BasePersistentStorageArray::SwitchMode(PSM_ENTER_COMMAND);
  }
 
  return { false, _debug_desync_level >= 1, send_net };
}
 
CommandCost CommandHelperBase::InternalExecuteProcessResult(Commands cmd, CommandFlags cmd_flags, [[maybe_unused]] const CommandCost &res_test, const CommandCost &res_exec, Money extra_cash, TileIndex tile, Backup<CompanyID> &cur_company)
{
  BasePersistentStorageArray::SwitchMode(PSM_LEAVE_COMMAND);
 
  if (cmd == CMD_COMPANY_CTRL) {
    cur_company.Trash();
    /* We are a new company                  -> Switch to new local company.
     * We were closed down                   -> Switch to spectator
     * Some other company opened/closed down -> The outside function will switch back */
    _current_company = _local_company;
  } else {
    /* Make sure nothing bad happened, like changing the current company. */
    assert(cmd_flags.Any({CommandFlag::Spectator, CommandFlag::Server}) ? _current_company == COMPANY_SPECTATOR : cur_company.Verify());
    cur_company.Restore();
  }
 
  /* If the test and execution can differ we have to check the
   * return of the command. Otherwise we can check whether the
   * test and execution have yielded the same result,
   * i.e. cost and error state are the same. */
  bool test_and_exec_can_differ = cmd_flags.Test(CommandFlag::NoTest);
  if (!test_and_exec_can_differ) {
    assert(res_test.GetCost() == res_exec.GetCost() && res_test.Failed() == res_exec.Failed()); // sanity check
  } else if (res_exec.Failed()) {
    return res_exec;
  }
 
  /* If we're needing more money and we haven't done
   * anything yet, ask for the money! */
  if (extra_cash != 0 && res_exec.GetCost() == 0) {
    /* It could happen we removed rail, thus gained money, and deleted something else.
     * So make sure the signal buffer is empty even in this case */
    UpdateSignalsInBuffer();
    return CommandCostWithParam(STR_ERROR_NOT_ENOUGH_CASH_REQUIRES_CURRENCY, extra_cash);
  }
 
  /* update last build coordinate of company. */
  if (tile != 0) {
    Company *c = Company::GetIfValid(_current_company);
    if (c != nullptr) c->last_build_coordinate = tile;
  }
 
  SubtractMoneyFromCompany(res_exec);
 
  /* Record if there was a command issues during pause; ignore pause/other setting related changes. */
  if (_pause_mode.Any() && _command_proc_table[cmd].type != CMDT_SERVER_SETTING) _pause_mode.Set(PauseMode::CommandDuringPause);
 
  /* update signals if needed */
  UpdateSignalsInBuffer();
 
  return res_exec;
}
 
 
void CommandCost::AddCost(const CommandCost &ret)
{
  this->AddCost(ret.cost);
  if (this->success && !ret.success) {
    this->message = ret.message;
    this->success = false;
  }
}
 
/* static */ EncodedString CommandCost::encoded_message;
 
CommandCost CommandCostWithParam(StringID str, uint64_t value)
{
  CommandCost error = CommandCost(str);
  if (IsLocalCompany()) {
    error.SetEncodedMessage(GetEncodedString(str, value));
  }
  return error;
}