src/company_base.h

   1 /* $Id$ */
   2
   3 /*
   4  * This file is part of OpenTTD.
   5  * 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.
   6  * 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.
   7  * 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/>.
   8  */
   9
  10 /** @file company_base.h Definition of stuff that is very close to a company, like the company struct itself. */
  11
  12 #ifndef COMPANY_BASE_H
  13 #define COMPANY_BASE_H
  14
  15 #include "road_type.h"
  16 #include "livery.h"
  17 #include "autoreplace_type.h"
  18 #include "tile_type.h"
  19 #include "settings_type.h"
  20 #include "group.h"
  21
  22 /** Statistics about the economy. */
  23 struct CompanyEconomyEntry {
  24         Money income;               ///< The amount of income.
  25         Money expenses;             ///< The amount of expenses.
  26         CargoArray delivered_cargo; ///< The amount of delivered cargo.
  27         int32 performance_history;  ///< Company score (scale 0-1000)
  28         Money company_value;        ///< The value of the company.
  29 };
  30
  31 struct CompanyInfrastructure {
  32         uint32 road[ROADTYPE_END]; ///< Count of company owned track bits for each road type.
  33         uint32 signal;             ///< Count of company owned signals.
  34         uint32 rail[RAILTYPE_END]; ///< Count of company owned track bits for each rail type.
  35         uint32 water;              ///< Count of company owned track bits for canals.
  36         uint32 station;            ///< Count of company owned station tiles.
  37         uint32 airport;            ///< Count of company owned airports.
  38
  39         /** Get total sum of all owned track bits. */
  40         uint32 GetRailTotal() const
  41         {
  42                 uint32 total = 0;
  43                 for (RailType rt =  RAILTYPE_BEGIN; rt < RAILTYPE_END; rt++) total += this->rail[rt];
  44                 return total;
  45         }
  46 };
  47
  48 typedef Pool<Company, CompanyID, 1, MAX_COMPANIES> CompanyPool;
  49 extern CompanyPool _company_pool;
  50
  51
  52 /** Statically loadable part of Company pool item */
  53 struct CompanyProperties {
  54         uint32 name_2;                   ///< Parameter of #name_1.
  55         StringID name_1;                 ///< Name of the company if the user did not change it.
  56         char *name;                      ///< Name of the company if the user changed it.
  57
  58         StringID president_name_1;       ///< Name of the president if the user did not change it.
  59         uint32 president_name_2;         ///< Parameter of #president_name_1
  60         char *president_name;            ///< Name of the president if the user changed it.
  61
  62         CompanyManagerFace face;         ///< Face description of the president.
  63
  64         Money money;                     ///< Money owned by the company.
  65         byte money_fraction;             ///< Fraction of money of the company, too small to represent in #money.
  66         Money current_loan;              ///< Amount of money borrowed from the bank.
  67
  68         byte colour;                     ///< Company colour.
  69
  70         byte block_preview;              ///< Number of quarters that the company is not allowed to get new exclusive engine previews (see CompaniesGenStatistics).
  71
  72         TileIndex location_of_HQ;        ///< Northern tile of HQ; #INVALID_TILE when there is none.
  73         TileIndex last_build_coordinate; ///< Coordinate of the last build thing by this company.
  74
  75         OwnerByte share_owners[4];       ///< Owners of the 4 shares of the company. #INVALID_OWNER if nobody has bought them yet.
  76
  77         Year inaugurated_year;           ///< Year of starting the company.
  78
  79         byte months_of_bankruptcy;       ///< Number of months that the company is unable to pay its debts
  80         CompanyMask bankrupt_asked;      ///< which companies were asked about buying it?
  81         int16 bankrupt_timeout;          ///< If bigger than \c 0, amount of time to wait for an answer on an offer to buy this company.
  82         Money bankrupt_value;
  83
  84         uint32 terraform_limit;          ///< Amount of tileheights we can (still) terraform (times 65536).
  85         uint32 clear_limit;              ///< Amount of tiles we can (still) clear (times 65536).
  86         uint32 tree_limit;               ///< Amount of trees we can (still) plant (times 65536).
  87
  88         /**
  89          * If \c true, the company is (also) controlled by the computer (a NoAI program).
  90          * @note It is possible that the user is also participating in such a company.
  91          */
  92         bool is_ai;
  93
  94         Money yearly_expenses[3][EXPENSES_END];                ///< Expenses of the company for the last three years, in every #ExpensesType category.
  95         CompanyEconomyEntry cur_economy;                       ///< Economic data of the company of this quarter.
  96         CompanyEconomyEntry old_economy[MAX_HISTORY_QUARTERS]; ///< Economic data of the company of the last #MAX_HISTORY_QUARTERS quarters.
  97         byte num_valid_stat_ent;                               ///< Number of valid statistical entries in #old_economy.
  98
  99         // TODO: Change some of these member variables to use relevant INVALID_xxx constants
 100         CompanyProperties()
 101                 : name_2(0), name_1(0), name(nullptr), president_name_1(0), president_name_2(0), president_name(nullptr),
 102                   face(0), money(0), money_fraction(0), current_loan(0), colour(0), block_preview(0),
 103                   location_of_HQ(0), last_build_coordinate(0), share_owners(), inaugurated_year(0),
 104                   months_of_bankruptcy(0), bankrupt_asked(0), bankrupt_timeout(0), bankrupt_value(0),
 105                   terraform_limit(0), clear_limit(0), tree_limit(0), is_ai(false) {}
 106
 107         ~CompanyProperties()
 108         {
 109                 free(this->name);
 110                 free(this->president_name);
 111         }
 112 };
 113
 114 struct Company : CompanyPool::PoolItem<&_company_pool>, CompanyProperties {
 115         Company(uint16 name_1 = 0, bool is_ai = false);
 116         ~Company();
 117
 118         Livery livery[LS_END];
 119         RailTypes avail_railtypes;         ///< Rail types available to this company.
 120         RoadTypes avail_roadtypes;         ///< Road types available to this company.
 121
 122         class AIInstance *ai_instance;
 123         class AIInfo *ai_info;
 124
 125         EngineRenewList engine_renew_list; ///< Engine renewals of this company.
 126         CompanySettings settings;          ///< settings specific for each company
 127         GroupStatistics group_all[VEH_COMPANY_END];      ///< NOSAVE: Statistics for the ALL_GROUP group.
 128         GroupStatistics group_default[VEH_COMPANY_END];  ///< NOSAVE: Statistics for the DEFAULT_GROUP group.
 129
 130         CompanyInfrastructure infrastructure; ///< NOSAVE: Counts of company owned infrastructure.
 131
 132         /**
 133          * Is this company a valid company, controlled by the computer (a NoAI program)?
 134          * @param index Index in the pool.
 135          * @return \c true if it is a valid, computer controlled company, else \c false.
 136          */
 137         static inline bool IsValidAiID(size_t index)
 138         {
 139                 const Company *c = Company::GetIfValid(index);
 140                 return c != nullptr && c->is_ai;
 141         }
 142
 143         /**
 144          * Is this company a valid company, not controlled by a NoAI program?
 145          * @param index Index in the pool.
 146          * @return \c true if it is a valid, human controlled company, else \c false.
 147          * @note If you know that \a index refers to a valid company, you can use #IsHumanID() instead.
 148          */
 149         static inline bool IsValidHumanID(size_t index)
 150         {
 151                 const Company *c = Company::GetIfValid(index);
 152                 return c != nullptr && !c->is_ai;
 153         }
 154
 155         /**
 156          * Is this company a company not controlled by a NoAI program?
 157          * @param index Index in the pool.
 158          * @return \c true if it is a human controlled company, else \c false.
 159          * @pre \a index must be a valid CompanyID.
 160          * @note If you don't know whether \a index refers to a valid company, you should use #IsValidHumanID() instead.
 161          */
 162         static inline bool IsHumanID(size_t index)
 163         {
 164                 return !Company::Get(index)->is_ai;
 165         }
 166
 167         static void PostDestructor(size_t index);
 168 };
 169
 170 #define FOR_ALL_COMPANIES_FROM(var, start) FOR_ALL_ITEMS_FROM(Company, company_index, var, start)
 171 #define FOR_ALL_COMPANIES(var) FOR_ALL_COMPANIES_FROM(var, 0)
 172
 173 Money CalculateCompanyValue(const Company *c, bool including_loan = true);
 174
 175 extern uint _next_competitor_start;
 176 extern uint _cur_company_tick_index;
 177
 178 #endif /* COMPANY_BASE_H */