Codechange: Extend industry cargo history to 24 years.

Monthly data is stored for the current 24 months.
Quarterly data is stored for a further 2-6 years.
Yearly data is stored for a further 6-24 years.

src/misc/CMakeLists.txt

@@ -8,6 +8,7 @@ add_files(
     getoptdata.cpp
     getoptdata.h
     hashtable.hpp
+    history.cpp
     history_func.hpp
     history_type.hpp
     lrucache.hpp

src/misc/history.cpp

@@ -0,0 +1,65 @@
+/*
+ * 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/>.
+ */
+
+/** @file history.cpp Implementation of functions for storing historical data. */
+
+#include "../stdafx.h"
+
+#include "../core/bitmath_func.hpp"
+#include "history_type.hpp"
+#include "history_func.hpp"
+
+#include "../safeguards.h"
+
+/**
+ * Update mask of valid records for a historical data.
+ * @note Call only for the largest history range sub-division.
+ * @param[in,out] valid_history Valid history records.
+ * @param hr History range to update mask for.
+ * @param cur_month Current economy month.
+ */
+void UpdateValidHistory(ValidHistoryMask &valid_history, const HistoryRange &hr, uint cur_month)
+{
+	/* Update for subdivisions first. */
+	if (hr.hr != nullptr) UpdateValidHistory(valid_history, *hr.hr, cur_month);
+
+	/* No need to update if our last entry is marked valid. */
+	if (HasBit(valid_history, hr.last - 1)) return;
+	/* Is it the right time for this history range? */
+	if (cur_month % hr.total_division != 0) return;
+	/* Is the previous history range valid yet? */
+	if (hr.division != 1 && !HasBit(valid_history, hr.first - hr.division)) return;
+
+	SB(valid_history, hr.first, hr.records, GB(valid_history, hr.first, hr.records) << 1ULL | 1ULL);
+}
+
+/**
+ * Test if history data is valid, without extracting data.
+ * @param valid_history Mask of valid history records.
+ * @param hr History range to test.
+ * @param age Age of data to test.
+ * @return True iff the data for history range and age is valid.
+ */
+bool IsValidHistory(ValidHistoryMask valid_history, const HistoryRange &hr, uint age)
+{
+	if (hr.hr == nullptr) {
+		if (age < hr.periods) {
+			uint slot = hr.first + age;
+			return HasBit(valid_history, slot);
+		}
+	} else {
+		if (age * hr.division < static_cast<uint>(hr.hr->periods - hr.division)) {
+			uint start = age * hr.division + ((TimerGameEconomy::month / hr.hr->division) % hr.division);
+			return IsValidHistory(valid_history, *hr.hr, start);
+		}
+		if (age < hr.periods) {
+			uint slot = hr.first + age - ((hr.hr->periods / hr.division) - 1);
+			return HasBit(valid_history, slot);
+		}
+	}
+	return false;
+}

src/misc/history_func.hpp

@@ -15,25 +15,44 @@
 #include "../timer/timer_game_economy.h"
 #include "history_type.hpp"
 
-/**
- * Update mask of valid history records.
- * @param[in,out] valid_history Valid history records.
- */
-inline void UpdateValidHistory(ValidHistoryMask &valid_history)
-{
-	SB(valid_history, LAST_MONTH, HISTORY_RECORDS - LAST_MONTH, GB(valid_history, LAST_MONTH, HISTORY_RECORDS - LAST_MONTH) << 1ULL | 1ULL);
-}
+void UpdateValidHistory(ValidHistoryMask &valid_history, const HistoryRange &hr, uint cur_month);
+bool IsValidHistory(ValidHistoryMask valid_history, const HistoryRange &hr, uint age);
 
 /**
- * Rotate history.
+ * Sum history data elements.
+ * @note The summation should prevent overflowing, and perform transformations relevant to the type of data.
  * @tparam T type of history data element.
- * @param history Historical data to rotate.
+ * @param history History elements to sum.
+ * @return Sum of history elements.
  */
 template <typename T>
-void RotateHistory(HistoryData<T> &history)
+T SumHistory(typename std::span<const T> history);
+
+/**
+ * Rotate historical data.
+ * @note Call only for the largest history range sub-division.
+ * @tparam T type of history data element.
+ * @param history Historical data to rotate.
+ * @param valid_history Mask of valid history records.
+ * @param hr History range to rotate..
+ * @param cur_month Current economy month.
+ */
+template <typename T>
+void RotateHistory(HistoryData<T> &history, ValidHistoryMask valid_history, const HistoryRange &hr, uint cur_month)
 {
-	std::rotate(std::rbegin(history), std::rbegin(history) + 1, std::rend(history));
-	history[THIS_MONTH] = {};
+	if (hr.hr != nullptr) RotateHistory(history, valid_history, *hr.hr, cur_month);
+	if (cur_month % hr.total_division != 0) return;
+
+	std::move_backward(std::next(std::begin(history), hr.first), std::next(std::begin(history), hr.last - 1), std::next(std::begin(history), hr.last));
+
+	if (hr.total_division == 1) {
+		history[hr.first] = history[hr.first - 1];
+		history.front() = {};
+	} else if (HasBit(valid_history, hr.first - hr.division)) {
+		auto first = std::next(std::begin(history), hr.first - hr.division);
+		auto last = std::next(first, hr.division);
+		history[hr.first] = SumHistory<T>(std::span{first, last});
+	}
 }
 
 /**
@@ -49,19 +68,60 @@ T GetAndResetAccumulatedAverage(Taccrued &total)
 	return result;
 }
 
+/**
+ * Get historical data.
+ * @tparam T type of history data element.
+ * @param history History data to extract from.
+ * @param valid_history Mask of valid history records.
+ * @param hr History range to get.
+ * @param age Age of data to get.
+ * @param cur_month Current economy month.
+ * @param[out] result Extracted historical data.
+ * @return True iff the data for this history range and age is valid.
+ */
+template <typename T>
+bool GetHistory(const HistoryData<T> &history, ValidHistoryMask valid_history, const HistoryRange &hr, uint age, T &result)
+{
+	if (hr.hr == nullptr) {
+		if (age < hr.periods) {
+			uint slot = hr.first + age;
+			result = history[slot];
+			return HasBit(valid_history, slot);
+		}
+	} else {
+		if (age * hr.division < static_cast<uint>(hr.hr->periods - hr.division)) {
+			bool is_valid = false;
+			std::array<T, HISTORY_MAX_DIVISION> tmp_result; // No need to clear as we fill every element we use.
+			uint start = age * hr.division + ((TimerGameEconomy::month / hr.hr->division) % hr.division);
+			for (auto i = start; i != start + hr.division; ++i) {
+				is_valid |= GetHistory(history, valid_history, *hr.hr, i, tmp_result[i - start]);
+			}
+			result = SumHistory<T>(std::span{std::begin(tmp_result), hr.division});
+			return is_valid;
+		}
+		if (age < hr.periods) {
+			uint slot = hr.first + age - ((hr.hr->periods / hr.division) - 1);
+			result = history[slot];
+			return HasBit(valid_history, slot);
+		}
+	}
+	NOT_REACHED();
+}
+
 /**
  * Fill some data with historical data.
  * @param history Historical data to fill from.
  * @param valid_history Mask of valid history records.
+ * @param hr History range to fill with.
  * @param fillers Fillers to fill with history data.
  */
 template <uint N, typename T, typename... Tfillers>
-void FillFromHistory(const HistoryData<T> &history, ValidHistoryMask valid_history, Tfillers... fillers)
+void FillFromHistory(const HistoryData<T> &history, ValidHistoryMask valid_history, const HistoryRange &hr, Tfillers... fillers)
 {
+	T result{};
 	for (uint i = 0; i != N; ++i) {
-		if (HasBit(valid_history, N - i)) {
-			auto &data = history[N - i];
-			(fillers.Fill(i, data), ...);
+		if (GetHistory(history, valid_history, hr, N - i - 1, result)) {
+			(fillers.Fill(i, result), ...);
 		} else {
 			(fillers.MakeInvalid(i), ...);
 		}
@@ -71,13 +131,14 @@ void FillFromHistory(const HistoryData<T> &history, ValidHistoryMask valid_histo
 /**
  * Fill some data with empty records.
  * @param valid_history Mask of valid history records.
+ * @param hr History range to fill with.
  * @param fillers Fillers to fill with history data.
  */
 template <uint N, typename... Tfillers>
-void FillFromEmpty(ValidHistoryMask valid_history, Tfillers... fillers)
+void FillFromEmpty(ValidHistoryMask valid_history, const HistoryRange &hr, Tfillers... fillers)
 {
 	for (uint i = 0; i != N; ++i) {
-		if (HasBit(valid_history, N - i)) {
+		if (IsValidHistory(valid_history, hr, N - i - 1)) {
 			(fillers.MakeZero(i), ...);
 		} else {
 			(fillers.MakeInvalid(i), ...);

src/misc/history_type.hpp

@@ -10,7 +10,37 @@
 #ifndef HISTORY_TYPE_HPP
 #define HISTORY_TYPE_HPP
 
-static constexpr uint8_t HISTORY_RECORDS = 25;
+struct HistoryRange {
+	const HistoryRange *hr;
+	const uint8_t periods; ///< Number of periods for this range.
+	const uint8_t records; ///< Number of records needed for this range.
+	const uint8_t first; ///< Index of first element in history data.
+	const uint8_t last; ///< Index of last element in history data.
+	const uint8_t division; ///< Number of divisions of the previous history range.
+	const uint8_t total_division; ///< Number of divisions of the initial history range.
+
+	explicit constexpr HistoryRange(uint8_t periods) :
+		hr(nullptr), periods(periods), records(this->periods), first(1), last(this->first + this->records), division(1), total_division(1)
+	{
+	}
+
+	constexpr HistoryRange(const HistoryRange &hr, uint8_t division, uint8_t periods) :
+		hr(&hr), periods(periods), records(this->periods - ((hr.periods / division) - 1)), first(hr.last), last(this->first + this->records),
+		division(division), total_division(division * hr.total_division)
+	{
+	}
+};
+
+static constexpr uint8_t HISTORY_PERIODS = 24;
+static constexpr HistoryRange HISTORY_MONTH{HISTORY_PERIODS};
+static constexpr HistoryRange HISTORY_QUARTER{HISTORY_MONTH, 3, HISTORY_PERIODS};
+static constexpr HistoryRange HISTORY_YEAR{HISTORY_QUARTER, 4, HISTORY_PERIODS};
+
+/** Maximum number of divisions from previous history range. */
+static constexpr uint8_t HISTORY_MAX_DIVISION = std::max({HISTORY_MONTH.division, HISTORY_QUARTER.division, HISTORY_YEAR.division});
+
+/** Total number of records require for all history data. */
+static constexpr uint8_t HISTORY_RECORDS = HISTORY_YEAR.last;
 
 static constexpr uint8_t THIS_MONTH = 0;
 static constexpr uint8_t LAST_MONTH = 1;