company_base.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 COMPANY_BASE_H
#define COMPANY_BASE_H
 
#include "road_type.h"
#include "livery.h"
#include "autoreplace_type.h"
#include "tile_type.h"
#include "timer/timer_game_economy.h"
#include "settings_type.h"
#include "group.h"
 
static const Money COMPANY_MAX_LOAN_DEFAULT = INT64_MIN;
 
struct CompanyEconomyEntry {
  Money income;               
  Money expenses;             
  CargoArray delivered_cargo{}; 
  int32_t performance_history;  
  Money company_value;        
};
 
struct CompanyInfrastructure {
  std::array<uint32_t, RAILTYPE_END> rail{}; 
  std::array<uint32_t, ROADTYPE_END> road{}; 
  uint32_t signal;             
  uint32_t water;              
  uint32_t station;            
  uint32_t airport;            
 
  auto operator<=>(const CompanyInfrastructure &) const = default;
 
  uint32_t GetRailTotal() const
  {
    return std::accumulate(std::begin(this->rail), std::end(this->rail), 0U);
  }
 
  uint32_t GetRoadTotal() const;
  uint32_t GetTramTotal() const;
};
 
class FreeUnitIDGenerator {
public:
  UnitID NextID() const;
  UnitID UseID(UnitID index);
  void ReleaseID(UnitID index);
 
private:
  using BitmapStorage = size_t;
  static constexpr size_t BITMAP_SIZE = std::numeric_limits<BitmapStorage>::digits;
 
  std::vector<BitmapStorage> used_bitmap;
};
 
typedef Pool<Company, CompanyID, 1, MAX_COMPANIES> CompanyPool;
extern CompanyPool _company_pool;
 
struct CompanyProperties {
  uint32_t name_2;                   
  StringID name_1;                 
  std::string name;                
 
  StringID president_name_1;       
  uint32_t president_name_2;         
  std::string president_name;      
 
  NetworkAuthorizedKeys allow_list; 
 
  CompanyManagerFace face;         
 
  Money money;                     
  uint8_t money_fraction;             
  Money current_loan;              
  Money max_loan;                  
 
  Colours colour;                  
 
  uint8_t block_preview;              
 
  TileIndex location_of_HQ;        
  TileIndex last_build_coordinate; 
 
  TimerGameEconomy::Year inaugurated_year; 
  TimerGameCalendar::Year inaugurated_year_calendar; 
 
  uint8_t months_empty = 0; 
  uint8_t months_of_bankruptcy;       
  CompanyMask bankrupt_asked;      
  int16_t bankrupt_timeout;          
  Money bankrupt_value;
 
  uint32_t terraform_limit;          
  uint32_t clear_limit;              
  uint32_t tree_limit;               
  uint32_t build_object_limit;       
 
  bool is_ai;
 
  std::array<Expenses, 3> yearly_expenses{}; 
  CompanyEconomyEntry cur_economy;                       
  CompanyEconomyEntry old_economy[MAX_HISTORY_QUARTERS]; 
  uint8_t num_valid_stat_ent;                               
 
  Livery livery[LS_END];
 
  EngineRenewList engine_renew_list; 
  CompanySettings settings;          
 
  // TODO: Change some of these member variables to use relevant INVALID_xxx constants
  CompanyProperties()
    : name_2(0), name_1(0), president_name_1(0), president_name_2(0),
      face(0), money(0), money_fraction(0), current_loan(0), max_loan(COMPANY_MAX_LOAN_DEFAULT),
      colour(COLOUR_BEGIN), block_preview(0), location_of_HQ(0), last_build_coordinate(0), inaugurated_year(0),
      months_of_bankruptcy(0), bankrupt_asked(0), bankrupt_timeout(0), bankrupt_value(0),
      terraform_limit(0), clear_limit(0), tree_limit(0), build_object_limit(0), is_ai(false), engine_renew_list(nullptr) {}
};
 
struct Company : CompanyProperties, CompanyPool::PoolItem<&_company_pool> {
  Company(uint16_t name_1 = 0, bool is_ai = false);
  ~Company();
 
  RailTypes avail_railtypes;         
  RoadTypes avail_roadtypes;         
 
  std::unique_ptr<class AIInstance> ai_instance;
  class AIInfo *ai_info;
  std::unique_ptr<class AIConfig> ai_config;
 
  GroupStatistics group_all[VEH_COMPANY_END];      
  GroupStatistics group_default[VEH_COMPANY_END];  
 
  CompanyInfrastructure infrastructure; 
 
  FreeUnitIDGenerator freeunits[VEH_COMPANY_END];
  FreeUnitIDGenerator freegroups;
 
  Money GetMaxLoan() const;
 
  static inline bool IsValidAiID(size_t index)
  {
    const Company *c = Company::GetIfValid(index);
    return c != nullptr && c->is_ai;
  }
 
  static inline bool IsValidHumanID(size_t index)
  {
    const Company *c = Company::GetIfValid(index);
    return c != nullptr && !c->is_ai;
  }
 
  static inline bool IsHumanID(size_t index)
  {
    return !Company::Get(index)->is_ai;
  }
 
  static void PostDestructor(size_t index);
};
 
Money CalculateCompanyValue(const Company *c, bool including_loan = true);
Money CalculateHostileTakeoverValue(const Company *c);
 
extern uint _cur_company_tick_index;
 
#endif /* COMPANY_BASE_H */