cargomonitor.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 CARGOMONITOR_H
#define CARGOMONITOR_H
 
#include "cargo_type.h"
#include "company_func.h"
#include "industry.h"
#include "town.h"
#include "core/overflowsafe_type.hpp"
 
struct Station;
 
typedef uint32_t CargoMonitorID; 
 
typedef std::map<CargoMonitorID, OverflowSafeInt32> CargoMonitorMap;
 
extern CargoMonitorMap _cargo_pickups;
extern CargoMonitorMap _cargo_deliveries;
 
 
/* Constants for encoding and extracting cargo monitors. */
constexpr uint8_t CCB_TOWN_IND_NUMBER_START = 0; 
constexpr uint8_t CCB_TOWN_IND_NUMBER_LENGTH = 16; 
constexpr uint8_t CCB_IS_INDUSTRY_BIT = 16; 
constexpr uint8_t CCB_CARGO_TYPE_START = 19; 
constexpr uint8_t CCB_CARGO_TYPE_LENGTH = 6; 
constexpr uint8_t CCB_COMPANY_START = 25; 
constexpr uint8_t CCB_COMPANY_LENGTH = 4; 
 
static_assert(NUM_CARGO     <= (1 << CCB_CARGO_TYPE_LENGTH));
static_assert(MAX_COMPANIES <= (1 << CCB_COMPANY_LENGTH));
 
 
inline CargoMonitorID EncodeCargoIndustryMonitor(CompanyID company, CargoID ctype, IndustryID ind)
{
  assert(ctype < (1 << CCB_CARGO_TYPE_LENGTH));
  assert(company < (1 << CCB_COMPANY_LENGTH));
 
  uint32_t ret = 0;
  SB(ret, CCB_TOWN_IND_NUMBER_START, CCB_TOWN_IND_NUMBER_LENGTH, ind);
  SetBit(ret, CCB_IS_INDUSTRY_BIT);
  SB(ret, CCB_CARGO_TYPE_START, CCB_CARGO_TYPE_LENGTH, ctype);
  SB(ret, CCB_COMPANY_START, CCB_COMPANY_LENGTH, company);
  return ret;
}
 
inline CargoMonitorID EncodeCargoTownMonitor(CompanyID company, CargoID ctype, TownID town)
{
  assert(ctype < (1 << CCB_CARGO_TYPE_LENGTH));
  assert(company < (1 << CCB_COMPANY_LENGTH));
 
  uint32_t ret = 0;
  SB(ret, CCB_TOWN_IND_NUMBER_START, CCB_TOWN_IND_NUMBER_LENGTH, town);
  SB(ret, CCB_CARGO_TYPE_START, CCB_CARGO_TYPE_LENGTH, ctype);
  SB(ret, CCB_COMPANY_START, CCB_COMPANY_LENGTH, company);
  return ret;
}
 
inline CompanyID DecodeMonitorCompany(CargoMonitorID num)
{
  return static_cast<CompanyID>(GB(num, CCB_COMPANY_START, CCB_COMPANY_LENGTH));
}
 
inline CargoID DecodeMonitorCargoType(CargoMonitorID num)
{
  return GB(num, CCB_CARGO_TYPE_START, CCB_CARGO_TYPE_LENGTH);
}
 
inline bool MonitorMonitorsIndustry(CargoMonitorID num)
{
  return HasBit(num, CCB_IS_INDUSTRY_BIT);
}
 
inline IndustryID DecodeMonitorIndustry(CargoMonitorID num)
{
  if (!MonitorMonitorsIndustry(num)) return INVALID_INDUSTRY;
  return GB(num, CCB_TOWN_IND_NUMBER_START, CCB_TOWN_IND_NUMBER_LENGTH);
}
 
inline TownID DecodeMonitorTown(CargoMonitorID num)
{
  if (MonitorMonitorsIndustry(num)) return INVALID_TOWN;
  return GB(num, CCB_TOWN_IND_NUMBER_START, CCB_TOWN_IND_NUMBER_LENGTH);
}
 
void ClearCargoPickupMonitoring(CompanyID company = INVALID_OWNER);
void ClearCargoDeliveryMonitoring(CompanyID company = INVALID_OWNER);
int32_t GetDeliveryAmount(CargoMonitorID monitor, bool keep_monitoring);
int32_t GetPickupAmount(CargoMonitorID monitor, bool keep_monitoring);
void AddCargoDelivery(CargoID cargo_type, CompanyID company, uint32_t amount, SourceType src_type, SourceID src, const Station *st, IndustryID dest = INVALID_INDUSTRY);
 
#endif /* CARGOMONITOR_H */