Explain the stadium, transfer, contract and application code in comments

Function and section comments for ui/stadium, ui/preparation_flow, the
transfer market, contract, outgoing and incoming transfer screens, and for
app/main, app/window_actions and app/desktop_actions. Comment lines only;
full build and runnable tests unchanged.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
This commit is contained in:
ClaudeandClaude Sonnet 5.5 committed 2026-11-06 11:21:31 +01:00
1 parent e088704dff
commit 73af2a657d
9 files changed
+1281

No files matched your search

+77
View File
@@ -13,6 +13,8 @@
namespace bmh::app {
// Builds the desk request that opens menu `kind` for the observed manager; the item id is
// taken from the desk item of that kind.
ui::DeskRequest DesktopActions::menu(const ui::DeskState& observed, int kind) {
ui::DeskRequest request;
request.kind = ui::DeskRequestKind::open_menu;
@@ -24,6 +26,8 @@ ui::DeskRequest DesktopActions::menu(const ui::DeskState& observed, int kind) {
return request;
}
// Runs `action` as a transaction on the desk settings owner; the checkpoint is restored
// if the action fails.
bool DeskSettingsActions::apply(uint64_t& revision, const std::function<bool()>& action) {
return detail::apply_window(session_, revision, session_.desk_settings_checkpoint(revision),
[&](CareerSession::DeskSettingsCheckpoint before) {
@@ -31,6 +35,7 @@ bool DeskSettingsActions::apply(uint64_t& revision, const std::function<bool()>&
}, action);
}
// Opens the desk settings screen; `acknowledge` receives the projection on success.
std::optional<CareerSession::DeskSettingsProjection> DeskSettingsActions::open(
const ui::DeskRequest& request, uint64_t& revision, std::string& error, const OpenAccept& acknowledge) {
std::optional<CareerSession::DeskSettingsProjection> result;
@@ -43,6 +48,7 @@ std::optional<CareerSession::DeskSettingsProjection> DeskSettingsActions::open(
return result;
}
// Sends any settings action (write, file, close) to the session in one transaction.
std::optional<CareerSession::DeskSettingsDispatch> DeskSettingsActions::dispatch(
const CareerSession::DeskSettingsAction& request, uint64_t& revision, std::string& error,
const Accept& acknowledge) {
@@ -56,16 +62,19 @@ std::optional<CareerSession::DeskSettingsDispatch> DeskSettingsActions::dispatch
return result;
}
// Dispatches a settings write for the owner identified by `sequence`.
std::optional<CareerSession::DeskSettingsDispatch> DeskSettingsActions::write(uint64_t sequence,
const ui::SettingsWriteRequest& request, uint64_t& revision, std::string& error, const Accept& acknowledge) {
return dispatch(CareerSession::DeskSettingsWrite{sequence, request}, revision, error, acknowledge);
}
// Dispatches a settings file (save/load) request for the owner `sequence`.
std::optional<CareerSession::DeskSettingsDispatch> DeskSettingsActions::file(uint64_t sequence,
const ui::SaveLoadRequest& request, uint64_t& revision, std::string& error, const Accept& acknowledge) {
return dispatch(CareerSession::DeskSettingsFile{sequence, request}, revision, error, acknowledge);
}
// Dispatches the close of the settings owner, built from the observed desk request.
std::optional<CareerSession::DeskSettingsDispatch> DeskSettingsActions::close(uint64_t sequence,
uint64_t owner_revision, const ui::DeskRequest& observed, uint64_t& revision, std::string& error,
const Accept& acknowledge) {
@@ -73,6 +82,8 @@ std::optional<CareerSession::DeskSettingsDispatch> DeskSettingsActions::close(ui
return dispatch(CareerSession::DeskSettingsClose{owner}, revision, error, acknowledge);
}
// Applies one edit (row, column, operation) to the settings cells; the request carries
// the observed cells so that a stale view is detected.
bool DeskSettingsActions::edit(const ui::SettingsState& observed, int row, int column, ui::SettingsEdit operation,
uint64_t& revision, std::string& error) {
ui::SettingsWriteRequest request;
@@ -85,11 +96,13 @@ bool DeskSettingsActions::edit(const ui::SettingsState& observed, int row, int c
return apply(revision, [&] { return session_.dispatch_settings(request, revision, error); });
}
// Runs `action` as a transaction restoring the balance checkpoint on failure.
bool BalanceActions::apply(uint64_t& revision, const std::function<bool()>& action) {
return detail::apply_window(session_, revision, session_.balance_checkpoint(),
[&](CareerSession::BalanceCheckpoint before) { session_.restore_balance_checkpoint(std::move(before)); }, action);
}
// Opens the balance (finance plan) screen over `underlay`.
std::optional<ui::BalanceState> BalanceActions::open(const ui::DeskRequest& request,
uint64_t& revision, const Image& underlay, std::string& error, const OpenAccept& acknowledge) {
std::optional<ui::BalanceState> result;
@@ -102,6 +115,7 @@ std::optional<ui::BalanceState> BalanceActions::open(const ui::DeskRequest& requ
return result;
}
// Sends a balance screen request to the session in one transaction.
std::optional<CareerSession::BalanceDispatch> BalanceActions::dispatch(const ui::BalanceRequest& request,
uint64_t& revision, std::string& error, const Accept& acknowledge) {
std::optional<CareerSession::BalanceDispatch> result;
@@ -114,13 +128,20 @@ std::optional<CareerSession::BalanceDispatch> BalanceActions::dispatch(const ui:
return result;
}
// Draft helpers for the console balance plan (thin wrappers around the game functions):
// open a draft for a manager,
BalancePlanDraft BalanceActions::open_draft(int manager) const { return bmh::open_balance_plan(session_.state(), manager); }
// switch its view,
void BalanceActions::cycle_draft(BalancePlanDraft& draft) const { cycle_balance_view(session_.state(), draft); }
// reset it,
void BalanceActions::reset_draft(BalancePlanDraft& draft) const { reset_balance_plan(session_.state(), draft); }
// and edit one row.
BalanceEditStatus BalanceActions::edit_draft(BalancePlanDraft& draft, int row, int32_t value) const {
return edit_balance_plan(session_.state(), draft, row, value);
}
// Closes the draft inside a transaction and always increases the revision. Returns the
// warning flag reported by the close.
bool BalanceActions::close_draft(const BalancePlanDraft& draft, uint64_t& revision) {
bool warning = false;
apply(revision, [&] {
@@ -131,11 +152,13 @@ bool BalanceActions::close_draft(const BalancePlanDraft& draft, uint64_t& revisi
return warning;
}
// Runs `action` as a transaction restoring the other-games checkpoint on failure.
bool OtherGamesActions::apply(uint64_t& revision, const std::function<bool()>& action) {
return detail::apply_window(session_, revision, session_.other_games_checkpoint(),
[&](CareerSession::OtherGamesCheckpoint before) { session_.restore_other_games_checkpoint(std::move(before)); }, action);
}
// Opens the other-games screen over `underlay`.
std::optional<ui::OtherGamesState> OtherGamesActions::open(const ui::DeskRequest& request,
uint64_t& revision, const Image& underlay, std::string& error, const OpenAccept& acknowledge) {
std::optional<ui::OtherGamesState> result;
@@ -148,6 +171,8 @@ std::optional<ui::OtherGamesState> OtherGamesActions::open(const ui::DeskRequest
return result;
}
// Sends an other-games request to the session; `team_info` presents club information
// when the screen asks for it.
std::optional<CareerSession::OtherGamesDispatch> OtherGamesActions::dispatch(const ui::OtherGamesRequest& request,
uint64_t& revision, std::string& error, const TransferOfferTeamInfoPresenter& team_info, const Accept& acknowledge) {
std::optional<CareerSession::OtherGamesDispatch> result;
@@ -160,11 +185,13 @@ std::optional<CareerSession::OtherGamesDispatch> OtherGamesActions::dispatch(con
return result;
}
// Runs `action` as a transaction restoring the top scorers checkpoint on failure.
bool TopScorersActions::apply(uint64_t& revision, const std::function<bool()>& action) {
return detail::apply_window(session_, revision, session_.top_scorers_checkpoint(),
[&](CareerSession::TopScorersCheckpoint before) { session_.restore_top_scorers_checkpoint(std::move(before)); }, action);
}
// Opens the top scorers screen over `underlay`; the revision is increased on opening.
std::optional<ui::TopScorersState> TopScorersActions::open(const ui::DeskRequest& request,
uint64_t& revision, const Image& underlay, std::string& error, const OpenAccept& acknowledge) {
std::optional<ui::TopScorersState> result;
@@ -178,6 +205,7 @@ std::optional<ui::TopScorersState> TopScorersActions::open(const ui::DeskRequest
return result;
}
// Sends a top scorers request to the session in one transaction.
std::optional<CareerSession::TopScorersDispatch> TopScorersActions::dispatch(const ui::TopScorersRequest& request,
uint64_t& revision, std::string& error, const Accept& acknowledge) {
std::optional<CareerSession::TopScorersDispatch> result;
@@ -190,11 +218,13 @@ std::optional<CareerSession::TopScorersDispatch> TopScorersActions::dispatch(con
return result;
}
// Runs `action` as a transaction restoring the opportunities checkpoint on failure.
bool OpportunitiesActions::apply(uint64_t& revision, const std::function<bool()>& action) {
return detail::apply_window(session_, revision, session_.opportunities_checkpoint(),
[&](CareerSession::OpportunitiesCheckpoint before) { session_.restore_opportunities_checkpoint(std::move(before)); }, action);
}
// Opens the opportunities screen over `underlay`; the revision is increased on opening.
std::optional<ui::OpportunitiesState> OpportunitiesActions::open(const ui::DeskRequest& request,
uint64_t& revision, const Image& underlay, std::string& error, bool national_source_case,
int stable_identity, const OpenAccept& acknowledge) {
@@ -209,6 +239,7 @@ std::optional<ui::OpportunitiesState> OpportunitiesActions::open(const ui::DeskR
return result;
}
// Sends an opportunities request to the session in one transaction.
std::optional<CareerSession::OpportunitiesDispatch> OpportunitiesActions::dispatch(const ui::OpportunitiesRequest& request,
uint64_t& revision, std::string& error, const Accept& acknowledge) {
std::optional<CareerSession::OpportunitiesDispatch> result;
@@ -221,6 +252,8 @@ std::optional<CareerSession::OpportunitiesDispatch> OpportunitiesActions::dispat
return result;
}
// Stores a changed statistics display preference (expected flags to target flags) and
// increases the revision; throws if the revision counter is exhausted.
bool OpportunitiesActions::preference(const ui::AnalyticsRequest& request, uint64_t& revision,
std::string& error, const std::function<void()>& acknowledge) {
return apply(revision, [&] {
@@ -233,15 +266,18 @@ bool OpportunitiesActions::preference(const ui::AnalyticsRequest& request, uint6
});
}
// Builds the request that closes the observed opportunities screen.
ui::OpportunitiesRequest OpportunitiesActions::close_request(const ui::OpportunitiesState& observed) {
return {observed.identity, ui::OpportunitiesAction::close, observed.mode};
}
// Runs `action` as a transaction restoring the manager join checkpoint on failure.
bool ManagerJoinActions::apply(uint64_t& revision, const std::function<bool()>& action) {
return detail::apply_window(session_, revision, session_.manager_join_checkpoint(),
[&](CareerSession::ManagerJoinCheckpoint before) { session_.restore_manager_join_checkpoint(std::move(before)); }, action);
}
// Commits a new manager joining the career; `acknowledge` receives the initialization result.
bool ManagerJoinActions::commit(uint64_t& revision, std::string& error,
const std::function<void(ui::CareerInitializationResult&)>& acknowledge) {
return apply(revision, [&] {
@@ -252,6 +288,7 @@ bool ManagerJoinActions::commit(uint64_t& revision, std::string& error,
});
}
// Sends a mailbox action (via the native transaction wrapper) and acknowledges it.
bool MailboxActions::dispatch(const ui::MailboxActionRequest& request, uint64_t& revision,
std::string& error, const std::function<void()>& acknowledge) {
return detail::apply_native(session_, revision, [&] {
@@ -261,6 +298,7 @@ bool MailboxActions::dispatch(const ui::MailboxActionRequest& request, uint64_t&
});
}
// Acknowledges the closing of the mailbox.
bool MailboxActions::close(const ui::MailboxCloseRequest& request, uint64_t& revision,
std::string& error, const std::function<void()>& acknowledge) {
return detail::apply_native(session_, revision, [&] {
@@ -270,6 +308,7 @@ bool MailboxActions::close(const ui::MailboxCloseRequest& request, uint64_t& rev
});
}
// Builds a mailbox action request for the observed message (entry index and raw entry).
ui::MailboxActionRequest MailboxActions::request(int manager, uint64_t revision,
ui::MailboxActionKind kind, const ui::MailboxMessage& observed) {
ui::MailboxActionRequest request;
@@ -281,6 +320,7 @@ ui::MailboxActionRequest MailboxActions::request(int manager, uint64_t revision,
return request;
}
// Sends a menu layout save/load request and acknowledges it.
bool MenuLayoutActions::dispatch(const ui::SaveLoadRequest& request, uint64_t& revision,
std::string& error, const std::function<void()>& acknowledge) {
return detail::apply_native(session_, revision, [&] {
@@ -290,16 +330,22 @@ bool MenuLayoutActions::dispatch(const ui::SaveLoadRequest& request, uint64_t& r
});
}
// Sets one environment item through set_impl (normal UI path).
std::optional<EnvironmentResult> EnvironmentActions::set(const ui::EnvironmentRequest& request,
uint64_t& revision, std::string& error, const Notice& notice, const std::function<void(bool)>& acknowledge) {
return set_impl(request, revision, error, notice, acknowledge, false);
}
// Console variant of set(): the staged state is published even if nothing changed.
std::optional<EnvironmentResult> EnvironmentActions::set_console(const ui::EnvironmentView& observed,
int item, int level, uint64_t& revision, std::string& error, const Notice& notice) {
return set_impl(request(observed, item, level), revision, error, notice, {}, true);
}
// Shared implementation. The request must match the current revision, manager slot
// (0..3), active manager and club, otherwise error is "stale_environment_owner". The change
// is made on a staged copy; a notice callback may abort it. The revision increases only
// when something changed. Returns nothing if the transaction was not accepted.
std::optional<EnvironmentResult> EnvironmentActions::set_impl(const ui::EnvironmentRequest& request,
uint64_t& revision, std::string& error, const Notice& notice, const std::function<void(bool)>& acknowledge,
bool publish_console_result) {
@@ -339,6 +385,7 @@ std::optional<EnvironmentResult> EnvironmentActions::set_impl(const ui::Environm
return result;
}
// Builds a set_item request for `item` and `level` bound to the observed view.
ui::EnvironmentRequest EnvironmentActions::request(const ui::EnvironmentView& observed, int item, int level) {
ui::EnvironmentRequest request;
request.kind = ui::EnvironmentRequestKind::set_item;
@@ -351,10 +398,12 @@ ui::EnvironmentRequest EnvironmentActions::request(const ui::EnvironmentView& ob
return request;
}
// Runs `action` through the native transaction wrapper.
bool RescheduleActions::apply(uint64_t& revision, const std::function<bool()>& action) {
return detail::apply_native(session_, revision, action);
}
// Moves a league match to `day` or undoes a move; any other combination is invalid.
RescheduleStatus RescheduleActions::change(GameState& state, int manager, const LeagueMatchRef& match,
int day, ui::RescheduleActionKind kind) {
if (kind == ui::RescheduleActionKind::move) return reschedule_league_match(state, manager, match, day);
@@ -362,6 +411,9 @@ RescheduleStatus RescheduleActions::change(GameState& state, int manager, const
return RescheduleStatus::invalid_match;
}
// Handles a UI reschedule action: the owner must be the open menu 7 for the current
// revision and active manager, and the match must be among the eligible (or already moved)
// matches. The state changes only when the move succeeds.
RescheduleStatus RescheduleActions::dispatch(const ui::RescheduleAction& request, uint64_t& revision,
const std::function<void()>& acknowledge) {
auto status = RescheduleStatus::invalid_match;
@@ -385,6 +437,7 @@ RescheduleStatus RescheduleActions::dispatch(const ui::RescheduleAction& request
return status;
}
// Moves a match directly (console path); the revision increases on success.
RescheduleStatus RescheduleActions::move(int manager, const LeagueMatchRef& match, int day, uint64_t& revision) {
auto status = RescheduleStatus::invalid_match;
apply(revision, [&] {
@@ -396,6 +449,7 @@ RescheduleStatus RescheduleActions::move(int manager, const LeagueMatchRef& matc
return status;
}
// Console undo; the revision always increases, whatever the result of the undo.
void RescheduleActions::undo_console(int manager, int day, uint64_t& revision) {
apply(revision, [&] {
// Keep the Console's existing accepted-command revision after its own
@@ -406,6 +460,8 @@ void RescheduleActions::undo_console(int manager, int day, uint64_t& revision) {
});
}
// Sends a contract request to the session. If an exception follows an accepted request,
// the pending contract quote is cleared before rethrowing.
bool ContractActions::dispatch(const ui::ContractRequest& request, uint64_t& revision,
ui::ContractActionResult& result, std::string& error, const std::function<void()>& acknowledge) {
bool accepted = false;
@@ -423,6 +479,7 @@ bool ContractActions::dispatch(const ui::ContractRequest& request, uint64_t& rev
}
}
// Creates a contract request of `kind` bound to the observed manager, club and revision.
ui::ContractRequest ContractActions::bind(const ui::ContractsState& observed,
ui::ContractActionKind kind, uint64_t request_id) {
ui::ContractRequest request;
@@ -434,6 +491,7 @@ ui::ContractRequest ContractActions::bind(const ui::ContractsState& observed,
return request;
}
// Request for a player's contract demands (row and player id).
ui::ContractRequest ContractActions::demands(const ui::ContractsState& observed,
const ui::ContractPlayer& player, uint64_t request_id) {
auto request = bind(observed, ui::ContractActionKind::request_demands, request_id);
@@ -442,6 +500,7 @@ ui::ContractRequest ContractActions::demands(const ui::ContractsState& observed,
return request;
}
// Request that sets team bonus `index` to `percent`, keeping the other proposed premiums.
ui::ContractRequest ContractActions::team_bonus(const ui::ContractsState& observed,
int index, uint8_t percent, uint64_t request_id) {
auto request = bind(observed, ui::ContractActionKind::submit_bonuses, request_id);
@@ -450,6 +509,7 @@ ui::ContractRequest ContractActions::team_bonus(const ui::ContractsState& observ
return request;
}
// Request to insure a player (quote, insurance form in the term column, months).
ui::ContractRequest ContractActions::insurance(const ui::ContractsState& observed, int row,
int player, uint64_t quote, uint8_t form, uint8_t months, uint64_t request_id) {
auto request = bind(observed, ui::ContractActionKind::insure_player, request_id);
@@ -458,6 +518,8 @@ ui::ContractRequest ContractActions::insurance(const ui::ContractsState& observe
return request;
}
// Request for a contract offer. With years > 0 it is an offer for that term (salary and
// the matching demand); with 0 years only the bonuses are submitted.
ui::ContractRequest ContractActions::offer(const ui::ContractsState& observed, int row,
int player, uint64_t quote, const std::array<uint8_t,7>& bonuses, int years, uint32_t salary,
const std::array<uint32_t,4>& demands, uint64_t request_id) {
@@ -472,10 +534,12 @@ ui::ContractRequest ContractActions::offer(const ui::ContractsState& observed, i
return request;
}
// Runs `action` through the native transaction wrapper.
bool FriendlyActions::apply(uint64_t& revision, const std::function<bool()>& action) {
return detail::apply_native(session_, revision, action);
}
// Converts the UI's friendly match request into the engine's booking request.
FriendlyBookingRequest FriendlyActions::booking_request(const ui::FriendlyMatchRequest& observed) {
FriendlyBookingQuote quote;
quote.status = FriendlyQuoteStatus::quoted;
@@ -493,6 +557,7 @@ FriendlyBookingRequest FriendlyActions::booking_request(const ui::FriendlyMatchR
observed.accept_cost, observed.approving_manager};
}
// Builds the acknowledgement for the UI from the booking outcome and the new revision.
ui::FriendlyBookingAck FriendlyActions::acknowledgement(const ui::FriendlyMatchRequest& request,
const FriendlyBookingResult& outcome, uint64_t revision) const {
ui::FriendlyBookingAck ack;
@@ -505,6 +570,9 @@ ui::FriendlyBookingAck FriendlyActions::acknowledgement(const ui::FriendlyMatchR
return ack;
}
// Books a friendly match (club or national). The request must be a book request for the
// current revision, otherwise the quote is stale. After booking, the planner count must
// have grown by 2, else the booking is rolled back and planner_mismatch is set.
FriendlyActions::Booking FriendlyActions::book(const ui::FriendlyMatchRequest& request,
uint64_t& revision, bool national, const Accept& acknowledge) {
Booking result;
@@ -532,11 +600,14 @@ FriendlyActions::Booking FriendlyActions::book(const ui::FriendlyMatchRequest& r
return result;
}
// Books a club friendly.
FriendlyActions::Booking FriendlyActions::book_club(const ui::FriendlyMatchRequest& request,
uint64_t& revision, const Accept& acknowledge) { return book(request, revision, false, acknowledge); }
// Books a national team friendly.
FriendlyActions::Booking FriendlyActions::book_national(const ui::FriendlyMatchRequest& request,
uint64_t& revision, const Accept& acknowledge) { return book(request, revision, true, acknowledge); }
// Console booking from an existing quote; the revision increases when it was booked.
FriendlyBookingResult FriendlyActions::book_console(const FriendlyBookingQuote& quote, uint16_t day,
bool accept_opponent, int consenting_manager, bool accept_cost, int approving_manager, uint64_t& revision) {
FriendlyBookingResult result;
@@ -550,19 +621,25 @@ FriendlyBookingResult FriendlyActions::book_console(const FriendlyBookingQuote&
return result;
}
// Quote functions (thin wrappers over the game functions): club friendly quote,
FriendlyBookingQuote FriendlyActions::quote(int manager, int opponent, bool home) const {
return quote_friendly_match(session_.state(), manager, opponent, home);
}
// national friendly quote (uses the random generator),
NationalFriendlyQuote FriendlyActions::national_quote(const NationalFriendlyOwner& owner, int opponent, bool home) {
return quote_national_friendly_match(session_.state(), owner, opponent, home, session_.rand());
}
// whether a club friendly can be played on a day,
FriendlyDateStatus FriendlyActions::date_status(const FriendlyBookingQuote& quote, uint16_t day) const {
return friendly_match_date_status(session_.state(), quote, day);
}
// the same for a national friendly,
FriendlyDateStatus FriendlyActions::national_date_status(const NationalFriendlyQuote& quote,
const NationalFriendlyOwner& owner, uint16_t day) const {
return national_friendly_match_date_status(session_.state(), quote, owner, session_.rand(), day);
}
// and the owner identity of a national friendly built from the request (the last two
// fields are fixed constants).
NationalFriendlyOwner FriendlyActions::national_owner(const ui::FriendlyMatchRequest& request) {
return {request.quote_id, request.revision, request.manager_slot, 0x165, 6};
}