src/company_base.h

   1 /* $Id: company_base.h 26081 2013-11-24 09:52:35Z rubidium $ */
   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         char *Dump(char *buffer, const char *last) const;
  48 };
  49
  50 typedef Pool<Company, CompanyID, 1, MAX_COMPANIES> CompanyPool;
  51 extern CompanyPool _company_pool;
  52
  53
  54 /** Statically loadable part of Company pool item */
  55 struct CompanyProperties {
  56         uint32 name_2;                   ///< Parameter of #name_1.
  57         StringID name_1;                 ///< Name of the company if the user did not change it.
  58         char *name;                      ///< Name of the company if the user changed it.
  59
  60         StringID president_name_1;       ///< Name of the president if the user did not change it.
  61         uint32 president_name_2;         ///< Parameter of #president_name_1
  62         char *president_name;            ///< Name of the president if the user changed it.
  63
  64         CompanyManagerFace face;         ///< Face description of the president.
  65
  66         Money money;                     ///< Money owned by the company.
  67         byte money_fraction;             ///< Fraction of money of the company, too small to represent in #money.
  68         Money current_loan;              ///< Amount of money borrowed from the bank.
  69
  70         byte colour;                     ///< Company colour.
  71
  72         RailTypes avail_railtypes;       ///< Rail types available to the company.
  73
  74         byte block_preview;              ///< Number of quarters that the company is not allowed to get new exclusive engine previews (see CompaniesGenStatistics).
  75
  76         TileIndex location_of_HQ;        ///< Northern tile of HQ; #INVALID_TILE when there is none.
  77         TileIndex last_build_coordinate; ///< Coordinate of the last build thing by this company.
  78
  79         OwnerByte share_owners[4];       ///< Owners of the 4 shares of the company. #INVALID_OWNER if nobody has bought them yet.
  80
  81         Year inaugurated_year;           ///< Year of starting the company.
  82
  83         byte months_of_bankruptcy;       ///< Number of months that the company is unable to pay its debts
  84         CompanyMask bankrupt_asked;      ///< which companies were asked about buying it?
  85         int16 bankrupt_timeout;          ///< If bigger than \c 0, amount of time to wait for an answer on an offer to buy this company.
  86         Money bankrupt_value;
  87
  88         uint32 terraform_limit;          ///< Amount of tileheights we can (still) terraform (times 65536).
  89         uint32 clear_limit;              ///< Amount of tiles we can (still) clear (times 65536).
  90         uint32 tree_limit;               ///< Amount of trees we can (still) plant (times 65536).
  91
  92         /**
  93          * If \c true, the company is (also) controlled by the computer (a NoAI program).
  94          * @note It is possible that the user is also participating in such a company.
  95          */
  96         bool is_ai;
  97
  98         Money yearly_expenses[3][EXPENSES_END];                ///< Expenses of the company for the last three years, in every #Expenses category.
  99         CompanyEconomyEntry cur_economy;                       ///< Economic data of the company of this quarter.
 100         CompanyEconomyEntry old_economy[MAX_HISTORY_QUARTERS]; ///< Economic data of the company of the last #MAX_HISTORY_QUARTERS quarters.
 101         byte num_valid_stat_ent;                               ///< Number of valid statistical entries in #old_economy.
 102
 103         CompanyProperties() : name(NULL), president_name(NULL) {}
 104
 105         ~CompanyProperties()
 106         {
 107                 free(this->name);
 108                 free(this->president_name);
 109         }
 110 };
 111
 112 struct Company : CompanyPool::PoolItem<&_company_pool>, CompanyProperties {
 113         Company(uint16 name_1 = 0, bool is_ai = false);
 114         ~Company();
 115
 116         Livery livery[LS_END];
 117         RoadTypes avail_roadtypes;         ///< Road types available to this company.
 118
 119         class AIInstance *ai_instance;
 120         class AIInfo *ai_info;
 121
 122         EngineRenewList engine_renew_list; ///< Engine renewals of this company.
 123         CompanySettings settings;          ///< settings specific for each company
 124         GroupStatistics group_all[VEH_COMPANY_END];      ///< NOSAVE: Statistics for the ALL_GROUP group.
 125         GroupStatistics group_default[VEH_COMPANY_END];  ///< NOSAVE: Statistics for the DEFAULT_GROUP group.
 126
 127         CompanyInfrastructure infrastructure; ///< NOSAVE: Counts of company owned infrastructure.
 128
 129         /**
 130          * Is this company a valid company, controlled by the computer (a NoAI program)?
 131          * @param index Index in the pool.
 132          * @return \c true if it is a valid, computer controlled company, else \c false.
 133          */
 134         static inline bool IsValidAiID(size_t index)
 135         {
 136                 const Company *c = Company::GetIfValid(index);
 137                 return c != NULL && c->is_ai;
 138         }
 139
 140         /**
 141          * Is this company a valid company, not controlled by a NoAI program?
 142          * @param index Index in the pool.
 143          * @return \c true if it is a valid, human controlled company, else \c false.
 144          * @note If you know that \a index refers to a valid company, you can use #IsHumanID() instead.
 145          */
 146         static inline bool IsValidHumanID(size_t index)
 147         {
 148                 const Company *c = Company::GetIfValid(index);
 149                 return c != NULL && !c->is_ai;
 150         }
 151
 152         /**
 153          * Is this company a company not controlled by a NoAI program?
 154          * @param index Index in the pool.
 155          * @return \c true if it is a human controlled company, else \c false.
 156          * @pre \a index must be a valid CompanyID.
 157          * @note If you don't know whether \a index refers to a valid company, you should use #IsValidHumanID() instead.
 158          */
 159         static inline bool IsHumanID(size_t index)
 160         {
 161                 return !Company::Get(index)->is_ai;
 162         }
 163
 164         static void PostDestructor(size_t index);
 165 };
 166
 167 #define FOR_ALL_COMPANIES_FROM(var, start) FOR_ALL_ITEMS_FROM(Company, company_index, var, start)
 168 #define FOR_ALL_COMPANIES(var) FOR_ALL_COMPANIES_FROM(var, 0)
 169
 170 Money CalculateCompanyValue(const Company *c, bool including_loan = true);
 171
 172 extern uint _next_competitor_start;
 173 extern uint _cur_company_tick_index;
 174
 175 #endif /* COMPANY_BASE_H */