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

+64
View File
@@ -16,6 +16,9 @@
namespace bmh::app {
using detail::apply_window;
// Runs `action` as a transaction on the league family state. Returns true if the action
// succeeded; if it returns false or throws, the checkpoint and the revision are restored
// (an exception is rethrown).
bool LeagueFamilyActions::apply(uint64_t& revision, const std::function<bool()>& action) {
auto before = session_.league_family_checkpoint();
const auto old_revision = revision;
@@ -31,6 +34,8 @@ bool LeagueFamilyActions::apply(uint64_t& revision, const std::function<bool()>&
return false;
}
// Opens the league pairings screen from the desk (menu kind 1, using the desk item of
// kind 1). Returns its state, or nothing with `error` set if the session refused.
std::optional<ui::LeaguePairingsState> LeagueFamilyActions::open_pairings(
const ui::DeskState& observed, uint64_t& revision, std::string& error) {
ui::DeskRequest request;
@@ -48,6 +53,7 @@ std::optional<ui::LeaguePairingsState> LeagueFamilyActions::open_pairings(
return result;
}
// Sends one pairings screen event (kind and value) to the session inside a transaction.
std::optional<CareerSession::LeaguePairingsDispatch> LeagueFamilyActions::pairings(
const ui::LeaguePairingsIdentity& observed, LeaguePairingsAction kind, int value,
uint64_t& revision, std::string& error) {
@@ -63,16 +69,19 @@ std::optional<CareerSession::LeaguePairingsDispatch> LeagueFamilyActions::pairin
return result;
}
// Builds the desk request that opens menu 1 (pairings) for the manager of `identity`.
ui::DeskRequest LeagueFamilyActions::pairings_entry(const ui::StrengthsIdentity& identity,
uint64_t revision) {
return {ui::DeskRequestKind::open_menu, identity.manager, 0, 1, -1, revision};
}
// Builds the pairings request that selects `league`.
ui::LeaguePairingsRequest LeagueFamilyActions::pairings_selection(
const ui::LeaguePairingsIdentity& identity, int league) {
return {identity, {LeaguePairingsAction::select_league, league, -1}};
}
// Turns a fresh strengths request into an `open` request bound to `identity`.
ui::StrengthsRequest LeagueFamilyActions::strengths_entry(const ui::StrengthsRequest& fresh,
const ui::StrengthsIdentity& identity) {
auto request = fresh;
@@ -81,6 +90,9 @@ ui::StrengthsRequest LeagueFamilyActions::strengths_entry(const ui::StrengthsReq
return request;
}
// Runs `action` as a transaction on the transfer state. Before it, the game state, random
// generators, offer editor, poach state, club modal runtime and revision are copied; they
// are all restored if the action returns false or throws (then rethrown).
bool TransferActions::apply(uint64_t& revision, const std::function<bool()>& action) {
auto state = session_.g_;
const auto game = session_.game_;
@@ -90,6 +102,7 @@ bool TransferActions::apply(uint64_t& revision, const std::function<bool()>& act
const auto owner_revision = session_.transfer_offer_revision_;
auto runtime = session_.club_modal_runtime_;
const auto old_revision = revision;
// Puts every saved piece back into the session.
const auto restore = [&] {
session_.g_ = std::move(state);
session_.game_ = game;
@@ -110,12 +123,17 @@ bool TransferActions::apply(uint64_t& revision, const std::function<bool()>& act
return false;
}
// Handles a transfer market request. In the normal interactive policy the session does
// the work (with the sale hooks and the review callback). The other policy is an older
// path that only allows listing a player and submitting a bid; it bumps the revision
// only if the state or random stream really changed. `acknowledge` is called on success.
std::optional<TransferActions::MarketDispatch> TransferActions::market(
const ui::TransferMarketRequest& request, const HumanBuyerSaleHooks& hooks,
uint64_t& revision, std::string& error, HumanBuyerMarketEntryPolicy policy,
const MarketAccept& acknowledge,
const std::function<int(const GameState&, const TransferOfferListView&)>& review) {
std::optional<MarketDispatch> result;
// Body of the transaction; returning false rolls everything back.
apply(revision, [&] {
const auto old_revision = revision;
if (policy == HumanBuyerMarketEntryPolicy::normal_interactive) {
@@ -156,6 +174,9 @@ std::optional<TransferActions::MarketDispatch> TransferActions::market(
return result;
}
// Checks a market request against the current state. Returns a German error text if the
// request is stale or invalid, or an empty string if it may proceed. Bonus values may be
// at most 255 (interactive policy) or 100 (legacy policy).
std::string TransferActions::rejection(const ui::TransferMarketRequest& request,
uint64_t revision, HumanBuyerMarketEntryPolicy policy) const {
const auto& state = session_.state();
@@ -186,6 +207,7 @@ std::string TransferActions::rejection(const ui::TransferMarketRequest& request,
return {};
}
// Opens the transfer offer editor for a market request (one transaction).
std::optional<CareerSession::TransferOfferEditorDispatch> TransferActions::open_offer(
const ui::TransferMarketRequest& request, uint64_t& revision, std::string& error,
const OfferAccept& acknowledge) {
@@ -199,6 +221,7 @@ std::optional<CareerSession::TransferOfferEditorDispatch> TransferActions::open_
return result;
}
// Asks the session for a preview (quote) of a market request without committing it.
std::optional<CareerSession::TransferMarketPreviewDispatch> TransferActions::preview(
const ui::TransferMarketRequest& request, uint64_t& revision, std::string& error,
const PreviewAccept& acknowledge) {
@@ -212,6 +235,8 @@ std::optional<CareerSession::TransferMarketPreviewDispatch> TransferActions::pre
return result;
}
// Sends an action of the outgoing offer editor to the session; the team and player
// information presenters are used when it opens those screens.
std::optional<CareerSession::TransferOfferEditorDispatch> TransferActions::offer(
const ui::OutgoingTransferRequest& request, const HumanBuyerSaleHooks& hooks,
uint64_t& revision, std::string& error, const TransferOfferTeamInfoPresenter& team_info,
@@ -226,6 +251,7 @@ std::optional<CareerSession::TransferOfferEditorDispatch> TransferActions::offer
return result;
}
// Starts a poaching attempt for the given manager and squad slot.
std::optional<CareerSession::PoachDispatch> TransferActions::poach(int manager, int slot,
uint64_t& revision, std::string& error) {
std::optional<CareerSession::PoachDispatch> result;
@@ -236,6 +262,8 @@ std::optional<CareerSession::PoachDispatch> TransferActions::poach(int manager,
return result;
}
// Builds the request to list the squad player `item` on the market (as a loan if `loan`),
// bound to the observed state's manager, club and revision.
ui::TransferMarketRequest TransferActions::listing(const ui::TransferMarketState& observed,
const ui::TransferMarketSquadItem& item, bool loan) {
ui::TransferMarketRequest request;
@@ -251,6 +279,8 @@ ui::TransferMarketRequest TransferActions::listing(const ui::TransferMarketState
return request;
}
// Builds the request to open an offer for the market entry `item`; an existing own bid
// is used as the starting point.
ui::TransferMarketRequest TransferActions::opening(const ui::TransferMarketState& observed,
const ui::TransferMarketItem& item, bool loan) {
ui::TransferMarketRequest request;
@@ -268,6 +298,7 @@ ui::TransferMarketRequest TransferActions::opening(const ui::TransferMarketState
return request;
}
// Builds a request from the offer editor's current state plus the changed field and value.
ui::OutgoingTransferRequest TransferActions::editor(const ui::OutgoingTransferEditorState& observed,
ui::OutgoingTransferRequestKind kind, ui::OutgoingTransferField field, uint32_t value) {
ui::OutgoingTransferRequest request;
@@ -287,11 +318,13 @@ ui::OutgoingTransferRequest TransferActions::editor(const ui::OutgoingTransferEd
return request;
}
// Runs `action` as a transaction restoring the bank checkpoint on failure.
bool BankActions::apply(uint64_t& revision, const std::function<bool()>& action) {
return apply_window(session_, revision, session_.bank_checkpoint(),
[&](CareerSession::BankCheckpoint before) { session_.restore_bank_checkpoint(std::move(before)); }, action);
}
// Sends a bank request to the session; `acknowledge` is called when it was accepted.
bool BankActions::dispatch(const ui::BankRequest& request, uint64_t& revision, std::string& error,
const std::function<void()>& acknowledge) {
return apply(revision, [&] {
@@ -301,6 +334,7 @@ bool BankActions::dispatch(const ui::BankRequest& request, uint64_t& revision, s
});
}
// Creates a bank request of `kind` bound to the observed manager, club and revision.
ui::BankRequest BankActions::bind(const ui::BankState& observed, ui::BankRequestKind kind) {
ui::BankRequest request;
request.kind = kind;
@@ -310,12 +344,14 @@ ui::BankRequest BankActions::bind(const ui::BankState& observed, ui::BankRequest
return request;
}
// Request to move `amount` to the deposit account.
ui::BankRequest BankActions::savings(const ui::BankState& observed, int32_t amount) {
auto request = bind(observed, ui::BankRequestKind::move_to_deposit);
request.amount = amount;
return request;
}
// Request for an investment action on asset index `asset` with `count` units.
ui::BankRequest BankActions::investment(const ui::BankState& observed, ui::BankRequestKind kind,
int asset, int count) {
auto request = bind(observed, kind);
@@ -324,6 +360,8 @@ ui::BankRequest BankActions::investment(const ui::BankState& observed, ui::BankR
return request;
}
// Request for a bank credit: carries the saved credit, the player's edits, whether the
// fees are accepted and the counterparty.
ui::BankRequest BankActions::credit(const ui::BankState& observed, const BankCreditContext& context,
const BankCreditDraft& draft, bool accept_fees, int counterparty) {
auto request = bind(observed, ui::BankRequestKind::bank_credit);
@@ -334,11 +372,14 @@ ui::BankRequest BankActions::credit(const ui::BankState& observed, const BankCre
return request;
}
// Runs `action` as a transaction restoring the stadium checkpoint on failure.
bool StadiumActions::apply(uint64_t& revision, const std::function<bool()>& action) {
return apply_window(session_, revision, session_.stadium_checkpoint(),
[&](CareerSession::StadiumCheckpoint before) { session_.restore_stadium_checkpoint(std::move(before)); }, action);
}
// Sends a stadium request to the session with the notice hooks; `acknowledge` is called
// when it was accepted.
bool StadiumActions::dispatch(const ui::StadiumRequest& request, uint64_t& revision, std::string& error,
const ConstructionNoticeHook& construction, const SeasonTicketCompensationNoticeHook& compensation,
const std::function<void()>& acknowledge) {
@@ -349,6 +390,7 @@ bool StadiumActions::dispatch(const ui::StadiumRequest& request, uint64_t& revis
});
}
// Creates a stadium request bound to the observed club, revision, scope and sequence.
ui::StadiumRequest StadiumActions::request(const ui::StadiumState& observed, ui::StadiumRequestKind kind,
int object, int option, int32_t price, bool accept_tip) {
ui::StadiumRequest request;
@@ -366,6 +408,8 @@ ui::StadiumRequest StadiumActions::request(const ui::StadiumState& observed, ui:
return request;
}
// Sets the ticket price for the observed desk's club; the stable club identity is filled
// in when the club index is valid.
bool DeskActions::ticket_price(const ui::DeskState& observed, int price,
uint64_t& revision, std::string& error) {
TicketPriceRequest request;
@@ -378,11 +422,13 @@ bool DeskActions::ticket_price(const ui::DeskState& observed, int price,
return session_.dispatch_ticket_price(request, revision, error);
}
// Runs `action` as a transaction restoring the lineup checkpoint on failure.
bool LineupActions::apply(uint64_t& revision, const std::function<bool()>& action) {
return apply_window(session_, revision, session_.lineup_checkpoint(),
[&](CareerSession::LineupCheckpoint before) { session_.restore_lineup_checkpoint(std::move(before)); }, action);
}
// Sends a lineup request to the session; `acknowledge` is called when accepted.
bool LineupActions::lineup(const ui::LineupRequest& request, uint64_t& revision, std::string& error,
const std::function<void()>& acknowledge) {
return apply(revision, [&] {
@@ -392,6 +438,7 @@ bool LineupActions::lineup(const ui::LineupRequest& request, uint64_t& revision,
});
}
// Sends a pitch request to the session; `acknowledge` is called when accepted.
bool LineupActions::pitch(const ui::PitchRequest& request, uint64_t& revision, std::string& error,
const std::function<void()>& acknowledge) {
return apply(revision, [&] {
@@ -401,10 +448,13 @@ bool LineupActions::pitch(const ui::PitchRequest& request, uint64_t& revision, s
});
}
// Sends a pitch swap request to the session as one transaction.
bool LineupActions::pitch_swap(const ui::PitchRequest& request, uint64_t& revision, std::string& error) {
return apply(revision, [&] { return session_.dispatch_pitch_swap(request, revision, error); });
}
// Changes one order value (`aspect`) of a player. Only valid for the observed revision;
// on success the revision is increased.
bool LineupActions::order(const ui::LineupState& observed, const ui::LineupPlayer& player,
int aspect, int value, uint64_t& revision) {
return apply(revision, [&] {
@@ -415,6 +465,9 @@ bool LineupActions::order(const ui::LineupState& observed, const ui::LineupPlaye
});
}
// Tries the requested pitch move on a copy of the state and tells whether the player ends
// up paired with `second_row` (requested), with another player (other_pair) or whether the
// move is invalid.
LineupActions::PairTarget LineupActions::pair_target(const ui::PitchRequest& request, int second_row) const {
auto preview = session_.state();
if (!move_pitch_player_source(preview, request.manager_slot, request.runtime_club,
@@ -426,6 +479,7 @@ LineupActions::PairTarget LineupActions::pair_target(const ui::PitchRequest& req
? PairTarget::requested : PairTarget::other_pair;
}
// Creates a lineup request that prepares the lineup of the observed state.
ui::LineupRequest LineupActions::prepare(const ui::LineupState& observed) {
ui::LineupRequest request;
request.kind = ui::LineupRequestKind::prepare_lineup;
@@ -435,6 +489,7 @@ ui::LineupRequest LineupActions::prepare(const ui::LineupState& observed) {
return request;
}
// Creates a request to swap two players of the lineup.
ui::LineupRequest LineupActions::swap(const ui::LineupState& observed,
const ui::LineupPlayer& first, const ui::LineupPlayer& second) {
auto request = prepare(observed);
@@ -445,6 +500,8 @@ ui::LineupRequest LineupActions::swap(const ui::LineupState& observed,
return request;
}
// Creates a pitch request of `kind` bound to the observed lineup. The observed live mode
// must be known, otherwise a FormatError is thrown.
ui::PitchRequest LineupActions::bind_pitch(const ui::PreparationState& observed, ui::PitchRequestKind kind) {
if (!observed.pitch || !observed.pitch->indoor.has_value())
throw FormatError("pitch: missing observed live mode");
@@ -457,6 +514,7 @@ ui::PitchRequest LineupActions::bind_pitch(const ui::PreparationState& observed,
return request;
}
// Creates a request to swap two players on the pitch (including their current positions).
ui::PitchRequest LineupActions::swap_pitch(const ui::PreparationState& observed,
const ui::LineupPlayer& first, const ui::LineupPlayer& second) {
auto request = bind_pitch(observed, ui::PitchRequestKind::swap_players);
@@ -466,6 +524,7 @@ ui::PitchRequest LineupActions::swap_pitch(const ui::PreparationState& observed,
return request;
}
// Creates a request to switch the pitch page (toggles the 0x000c bits of the display word).
ui::PitchRequest LineupActions::page(const ui::PreparationState& observed) {
auto request = bind_pitch(observed, ui::PitchRequestKind::select_pitch_page);
request.expected_mode = uint8_t(observed.pitch->mode);
@@ -477,6 +536,8 @@ ui::PitchRequest LineupActions::page(const ui::PreparationState& observed) {
return request;
}
// Creates a request to load or save a formation in `slot`; saving copies the position
// bytes of the 11 players on the pitch.
ui::PitchRequest LineupActions::formation(const ui::PreparationState& observed,
ui::PitchRequestKind kind, int slot) {
auto request = bind_pitch(observed, kind);
@@ -492,6 +553,7 @@ ui::PitchRequest LineupActions::formation(const ui::PreparationState& observed,
return request;
}
// Creates a request to move a player to the given depth and lane.
ui::PitchRequest LineupActions::move(const ui::PreparationState& observed, const ui::LineupPlayer& player,
int depth, int lane) {
auto request = bind_pitch(observed, ui::PitchRequestKind::move_player);
@@ -502,6 +564,8 @@ ui::PitchRequest LineupActions::move(const ui::PreparationState& observed, const
return request;
}
// Creates a request that advances one of the three automatic weights (index 0..2) by one
// step; each weight is a 2-bit value that wraps around after 3.
ui::PitchRequest LineupActions::weight(const ui::PreparationState& observed, int index) {
if (index < 0 || index > 2) throw FormatError("pitch: invalid automatic weight index");
auto request = bind_pitch(observed, ui::PitchRequestKind::set_automatic_weight);