command_type.h

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/>.
 */
 
#ifndef COMMAND_TYPE_H
#define COMMAND_TYPE_H
 
#include "economy_type.h"
#include "strings_type.h"
#include "tile_type.h"
 
struct GRFFile;
 
class CommandCost {
  ExpensesType expense_type;                  
  Money cost;                                 
  StringID message;                           
  bool success;                               
  const GRFFile *textref_stack_grffile;       
  uint textref_stack_size;                    
  StringID extra_message = INVALID_STRING_ID; 
 
  static uint32_t textref_stack[16];
 
public:
  CommandCost() : expense_type(INVALID_EXPENSES), cost(0), message(INVALID_STRING_ID), success(true), textref_stack_grffile(nullptr), textref_stack_size(0) {}
 
  explicit CommandCost(StringID msg, StringID extra_msg = INVALID_STRING_ID) : expense_type(INVALID_EXPENSES), cost(0), message(msg), success(false), textref_stack_grffile(nullptr), textref_stack_size(0), extra_message(extra_msg) {}
 
  explicit CommandCost(ExpensesType ex_t) : expense_type(ex_t), cost(0), message(INVALID_STRING_ID), success(true), textref_stack_grffile(nullptr), textref_stack_size(0) {}
 
  CommandCost(ExpensesType ex_t, const Money &cst) : expense_type(ex_t), cost(cst), message(INVALID_STRING_ID), success(true), textref_stack_grffile(nullptr), textref_stack_size(0) {}
 
 
  inline void AddCost(const Money &cost)
  {
    this->cost += cost;
  }
 
  void AddCost(const CommandCost &cmd_cost);
 
  inline void MultiplyCost(int factor)
  {
    this->cost *= factor;
  }
 
  inline Money GetCost() const
  {
    return this->cost;
  }
 
  inline ExpensesType GetExpensesType() const
  {
    return this->expense_type;
  }
 
  void MakeError(StringID message, StringID extra_message = INVALID_STRING_ID)
  {
    assert(message != INVALID_STRING_ID);
    this->success = false;
    this->message = message;
    this->extra_message = extra_message;
  }
 
  void UseTextRefStack(const GRFFile *grffile, uint num_registers);
 
  const GRFFile *GetTextRefStackGRF() const
  {
    return this->textref_stack_grffile;
  }
 
  uint GetTextRefStackSize() const
  {
    return this->textref_stack_size;
  }
 
  const uint32_t *GetTextRefStack() const
  {
    return textref_stack;
  }
 
  StringID GetErrorMessage() const
  {
    if (this->success) return INVALID_STRING_ID;
    return this->message;
  }
 
  StringID GetExtraErrorMessage() const
  {
    if (this->success) return INVALID_STRING_ID;
    return this->extra_message;
  }
 
  inline bool Succeeded() const
  {
    return this->success;
  }
 
  inline bool Failed() const
  {
    return !this->success;
  }
};
 
enum Commands : uint16_t {
  CMD_BUILD_RAILROAD_TRACK,         
  CMD_REMOVE_RAILROAD_TRACK,        
  CMD_BUILD_SINGLE_RAIL,            
  CMD_REMOVE_SINGLE_RAIL,           
  CMD_LANDSCAPE_CLEAR,              
  CMD_BUILD_BRIDGE,                 
  CMD_BUILD_RAIL_STATION,           
  CMD_BUILD_TRAIN_DEPOT,            
  CMD_BUILD_SINGLE_SIGNAL,          
  CMD_REMOVE_SINGLE_SIGNAL,         
  CMD_TERRAFORM_LAND,               
  CMD_BUILD_OBJECT,                 
  CMD_BUILD_OBJECT_AREA,            
  CMD_BUILD_TUNNEL,                 
 
  CMD_REMOVE_FROM_RAIL_STATION,     
  CMD_CONVERT_RAIL,                 
 
  CMD_BUILD_RAIL_WAYPOINT,          
  CMD_RENAME_WAYPOINT,              
  CMD_REMOVE_FROM_RAIL_WAYPOINT,    
 
  CMD_BUILD_ROAD_WAYPOINT,          
  CMD_REMOVE_FROM_ROAD_WAYPOINT,    
 
  CMD_BUILD_ROAD_STOP,              
  CMD_REMOVE_ROAD_STOP,             
  CMD_BUILD_LONG_ROAD,              
  CMD_REMOVE_LONG_ROAD,             
  CMD_BUILD_ROAD,                   
  CMD_BUILD_ROAD_DEPOT,             
  CMD_CONVERT_ROAD,                 
 
  CMD_BUILD_AIRPORT,                
 
  CMD_BUILD_DOCK,                   
 
  CMD_BUILD_SHIP_DEPOT,             
  CMD_BUILD_BUOY,                   
 
  CMD_PLANT_TREE,                   
 
  CMD_BUILD_VEHICLE,                
  CMD_SELL_VEHICLE,                 
  CMD_REFIT_VEHICLE,                
  CMD_SEND_VEHICLE_TO_DEPOT,        
  CMD_SET_VEHICLE_VISIBILITY,       
 
  CMD_MOVE_RAIL_VEHICLE,            
  CMD_FORCE_TRAIN_PROCEED,          
  CMD_REVERSE_TRAIN_DIRECTION,      
 
  CMD_CLEAR_ORDER_BACKUP,           
  CMD_MODIFY_ORDER,                 
  CMD_SKIP_TO_ORDER,                
  CMD_DELETE_ORDER,                 
  CMD_INSERT_ORDER,                 
 
  CMD_CHANGE_SERVICE_INT,           
 
  CMD_BUILD_INDUSTRY,               
  CMD_INDUSTRY_SET_FLAGS,           
  CMD_INDUSTRY_SET_EXCLUSIVITY,     
  CMD_INDUSTRY_SET_TEXT,            
  CMD_INDUSTRY_SET_PRODUCTION,      
 
  CMD_SET_COMPANY_MANAGER_FACE,     
  CMD_SET_COMPANY_COLOUR,           
 
  CMD_INCREASE_LOAN,                
  CMD_DECREASE_LOAN,                
  CMD_SET_COMPANY_MAX_LOAN,         
 
  CMD_WANT_ENGINE_PREVIEW,          
  CMD_ENGINE_CTRL,                  
 
  CMD_RENAME_VEHICLE,               
  CMD_RENAME_ENGINE,                
  CMD_RENAME_COMPANY,               
  CMD_RENAME_PRESIDENT,             
  CMD_RENAME_STATION,               
  CMD_RENAME_DEPOT,                 
 
  CMD_PLACE_SIGN,                   
  CMD_RENAME_SIGN,                  
 
  CMD_TURN_ROADVEH,                 
 
  CMD_PAUSE,                        
 
  CMD_BUY_COMPANY,                  
 
  CMD_FOUND_TOWN,                   
  CMD_RENAME_TOWN,                  
  CMD_DO_TOWN_ACTION,               
  CMD_TOWN_CARGO_GOAL,              
  CMD_TOWN_GROWTH_RATE,             
  CMD_TOWN_RATING,                  
  CMD_TOWN_SET_TEXT,                
  CMD_EXPAND_TOWN,                  
  CMD_DELETE_TOWN,                  
  CMD_PLACE_HOUSE,                  
 
  CMD_ORDER_REFIT,                  
  CMD_CLONE_ORDER,                  
  CMD_CLEAR_AREA,                   
 
  CMD_MONEY_CHEAT,                  
  CMD_CHANGE_BANK_BALANCE,          
  CMD_BUILD_CANAL,                  
 
  CMD_CREATE_SUBSIDY,               
  CMD_COMPANY_CTRL,                 
  CMD_COMPANY_ALLOW_LIST_CTRL, 
  CMD_CUSTOM_NEWS_ITEM,             
  CMD_CREATE_GOAL,                  
  CMD_REMOVE_GOAL,                  
  CMD_SET_GOAL_DESTINATION,         
  CMD_SET_GOAL_TEXT,                
  CMD_SET_GOAL_PROGRESS,            
  CMD_SET_GOAL_COMPLETED,           
  CMD_GOAL_QUESTION,                
  CMD_GOAL_QUESTION_ANSWER,         
  CMD_CREATE_STORY_PAGE,            
  CMD_CREATE_STORY_PAGE_ELEMENT,    
  CMD_UPDATE_STORY_PAGE_ELEMENT,    
  CMD_SET_STORY_PAGE_TITLE,         
  CMD_SET_STORY_PAGE_DATE,          
  CMD_SHOW_STORY_PAGE,              
  CMD_REMOVE_STORY_PAGE,            
  CMD_REMOVE_STORY_PAGE_ELEMENT,    
  CMD_SCROLL_VIEWPORT,              
  CMD_STORY_PAGE_BUTTON,            
 
  CMD_LEVEL_LAND,                   
 
  CMD_BUILD_LOCK,                   
 
  CMD_BUILD_SIGNAL_TRACK,           
  CMD_REMOVE_SIGNAL_TRACK,          
 
  CMD_GIVE_MONEY,                   
  CMD_CHANGE_SETTING,               
  CMD_CHANGE_COMPANY_SETTING,       
 
  CMD_SET_AUTOREPLACE,              
 
  CMD_CLONE_VEHICLE,                
  CMD_START_STOP_VEHICLE,           
  CMD_MASS_START_STOP,              
  CMD_AUTOREPLACE_VEHICLE,          
  CMD_DEPOT_SELL_ALL_VEHICLES,      
  CMD_DEPOT_MASS_AUTOREPLACE,       
 
  CMD_CREATE_GROUP,                 
  CMD_DELETE_GROUP,                 
  CMD_ALTER_GROUP,                  
  CMD_ADD_VEHICLE_GROUP,            
  CMD_ADD_SHARED_VEHICLE_GROUP,     
  CMD_REMOVE_ALL_VEHICLES_GROUP,    
  CMD_SET_GROUP_FLAG,               
  CMD_SET_GROUP_LIVERY,             
 
  CMD_MOVE_ORDER,                   
  CMD_CHANGE_TIMETABLE,             
  CMD_BULK_CHANGE_TIMETABLE,        
  CMD_SET_VEHICLE_ON_TIME,          
  CMD_AUTOFILL_TIMETABLE,           
  CMD_SET_TIMETABLE_START,          
 
  CMD_OPEN_CLOSE_AIRPORT,           
 
  CMD_CREATE_LEAGUE_TABLE,               
  CMD_CREATE_LEAGUE_TABLE_ELEMENT,       
  CMD_UPDATE_LEAGUE_TABLE_ELEMENT_DATA,  
  CMD_UPDATE_LEAGUE_TABLE_ELEMENT_SCORE, 
  CMD_REMOVE_LEAGUE_TABLE_ELEMENT,       
 
  CMD_END,                          
};
 
enum DoCommandFlag {
  DC_NONE                  = 0x000, 
  DC_EXEC                  = 0x001, 
  DC_AUTO                  = 0x002, 
  DC_QUERY_COST            = 0x004, 
  DC_NO_WATER              = 0x008, 
  // 0x010 is unused
  DC_NO_TEST_TOWN_RATING   = 0x020, 
  DC_BANKRUPT              = 0x040, 
  DC_AUTOREPLACE           = 0x080, 
  DC_NO_CARGO_CAP_CHECK    = 0x100, 
  DC_ALL_TILES             = 0x200, 
  DC_NO_MODIFY_TOWN_RATING = 0x400, 
  DC_FORCE_CLEAR_TILE      = 0x800, 
};
DECLARE_ENUM_AS_BIT_SET(DoCommandFlag)
 
 
enum CommandFlags {
  CMD_SERVER    = 0x001, 
  CMD_SPECTATOR = 0x002, 
  CMD_OFFLINE   = 0x004, 
  CMD_AUTO      = 0x008, 
  CMD_ALL_TILES = 0x010, 
  CMD_NO_TEST   = 0x020, 
  CMD_NO_WATER  = 0x040, 
  CMD_CLIENT_ID = 0x080, 
  CMD_DEITY     = 0x100, 
  CMD_STR_CTRL  = 0x200, 
  CMD_NO_EST    = 0x400, 
  CMD_LOCATION  = 0x800, 
};
DECLARE_ENUM_AS_BIT_SET(CommandFlags)
 
 
enum CommandType {
  CMDT_LANDSCAPE_CONSTRUCTION, 
  CMDT_VEHICLE_CONSTRUCTION,   
  CMDT_MONEY_MANAGEMENT,       
  CMDT_VEHICLE_MANAGEMENT,     
  CMDT_ROUTE_MANAGEMENT,       
  CMDT_OTHER_MANAGEMENT,       
  CMDT_COMPANY_SETTING,        
  CMDT_SERVER_SETTING,         
  CMDT_CHEAT,                  
 
  CMDT_END,                    
};
 
enum CommandPauseLevel {
  CMDPL_NO_ACTIONS,      
  CMDPL_NO_CONSTRUCTION, 
  CMDPL_NO_LANDSCAPING,  
  CMDPL_ALL_ACTIONS,     
};
 
 
template <typename T> struct CommandFunctionTraitHelper;
template <typename... Targs>
struct CommandFunctionTraitHelper<CommandCost(*)(DoCommandFlag, Targs...)> {
  using Args = std::tuple<std::decay_t<Targs>...>;
  using RetTypes = void;
  using CbArgs = Args;
  using CbProcType = void(*)(Commands, const CommandCost &);
};
template <template <typename...> typename Tret, typename... Tretargs, typename... Targs>
struct CommandFunctionTraitHelper<Tret<CommandCost, Tretargs...>(*)(DoCommandFlag, Targs...)> {
  using Args = std::tuple<std::decay_t<Targs>...>;
  using RetTypes = std::tuple<std::decay_t<Tretargs>...>;
  using CbArgs = std::tuple<std::decay_t<Tretargs>..., std::decay_t<Targs>...>;
  using CbProcType = void(*)(Commands, const CommandCost &, Tretargs...);
};
 
template <Commands Tcmd> struct CommandTraits;
 
#define DEF_CMD_TRAIT(cmd_, proc_, flags_, type_) \
  template<> struct CommandTraits<cmd_> { \
    using ProcType = decltype(&proc_); \
    using Args = typename CommandFunctionTraitHelper<ProcType>::Args; \
    using RetTypes = typename CommandFunctionTraitHelper<ProcType>::RetTypes; \
    using CbArgs = typename CommandFunctionTraitHelper<ProcType>::CbArgs; \
    using RetCallbackProc = typename CommandFunctionTraitHelper<ProcType>::CbProcType; \
    static constexpr Commands cmd = cmd_; \
    static constexpr auto &proc = proc_; \
    static constexpr CommandFlags flags = (CommandFlags)(flags_); \
    static constexpr CommandType type = type_; \
    static inline constexpr const char *name = #proc_; \
  };
 
typedef std::vector<uint8_t> CommandDataBuffer;
 
typedef void CommandCallback(Commands cmd, const CommandCost &result, TileIndex tile);
 
typedef void CommandCallbackData(Commands cmd, const CommandCost &result, const CommandDataBuffer &data, CommandDataBuffer result_data);
 
#endif /* COMMAND_TYPE_H */