#include "fc_prehdrs.h"
#include <math.h>
#include <signal.h>
#include <stdarg.h>
#include <stdio.h>
#include <stdlib.h>
#include <time.h>
#include "bitvector.h"
#include "capstr.h"
#include "dataio.h"
#include "deprecations.h"
#include "fcbacktrace.h"
#include "fc_cmdline.h"
#include "fciconv.h"
#include "fcintl.h"
#include "log.h"
#include "mem.h"
#include "rand.h"
#include "registry.h"
#include "support.h"
#include "timing.h"
#include "ai.h"
#include "diptreaty.h"
#include "fc_cmdhelp.h"
#include "fc_interface.h"
#include "game.h"
#include "idex.h"
#include "map.h"
#include "mapimg.h"
#include "netintf.h"
#include "packets.h"
#include "player.h"
#include "research.h"
#include "server_settings.h"
#include "version.h"
#include "chatline_g.h"
#include "citydlg_g.h"
#include "connectdlg_g.h"
#include "dialogs_g.h"
#include "diplodlg_g.h"
#include "editgui_g.h"
#include "graphics_g.h"
#include "gui_main_g.h"
#include "mapctrl_g.h"
#include "mapview_g.h"
#include "menu_g.h"
#include "messagewin_g.h"
#include "pages_g.h"
#include "plrdlg_g.h"
#include "repodlgs_g.h"
#include "voteinfo_bar_g.h"
#include "attribute.h"
#include "audio.h"
#include "cityrepdata.h"
#include "climisc.h"
#include "clinet.h"
#include "connectdlg_common.h"
#include "control.h"
#include "editor.h"
#include "global_worklist.h"
#include "helpdata.h"
#include "mapview_common.h"
#include "music.h"
#include "options.h"
#include "overview_common.h"
#include "packhand.h"
#include "svgflag.h"
#include "tilespec.h"
#include "themes_common.h"
#include "update_queue.h"
#include "voteinfo.h"
#include "zoom.h"
#include "agents.h"
#include "cma_core.h"
#include "script_client.h"
#include "client_main.h"

Functions
static enum known_type	mapimg_client_tile_known (const struct tile ptile, const struct player pplayer, bool knowledge)

static struct terrain *	mapimg_client_tile_terrain (const struct tile ptile, const struct player pplayer, bool knowledge)

static struct player *	mapimg_client_tile_owner (const struct tile ptile, const struct player pplayer, bool knowledge)

static struct player *	mapimg_client_tile_city (const struct tile ptile, const struct player pplayer, bool knowledge)

static struct player *	mapimg_client_tile_unit (const struct tile ptile, const struct player pplayer, bool knowledge)

static int	mapimg_client_plrcolor_count (void)

static struct rgbcolor *	mapimg_client_plrcolor_get (int i)

static void	fc_interface_init_client (void)

static char *	put_conv (const char src, size_t length)

static bool	get_conv (char dst, size_t ndst, const char src, size_t nsrc)

static void	charsets_init (void)

static void	emergency_exit (void)

static void	at_exit (void)

static void	client_game_init (void)

static void	client_game_free (void)

static void	client_game_reset (void)

int	default_tileset_select (void)

int	client_main (int argc, char *argv[], bool postpone_tileset)

static void	log_option_save_msg (enum log_level lvl, const char *msg,...)

void fc__noreturn	client_exit (int return_value)

void	client_packet_input (void *packet, int type)

void	user_ended_turn (void)

void	send_turn_done (void)

void	send_report_request (enum report_type type)

void	set_client_state (enum client_states newstate)

enum client_states	client_state (void)

void	client_remove_cli_conn (struct connection *pconn)

void	client_remove_all_cli_conn (void)

void	send_attribute_block_request (void)

void	wait_till_request_got_processed (int request_id)

bool	client_is_observer (void)

void	set_seconds_to_turndone (double seconds)

bool	is_waiting_turn_change (void)

void	start_turn_change_wait (void)

void	stop_turn_change_wait (void)

int	get_seconds_to_turndone (void)

int	get_seconds_to_new_turn (void)

double	real_timer_callback (void)

bool	can_client_control (void)

bool	can_client_issue_orders (void)

bool	can_meet_with_player (const struct player *pplayer)

bool	can_intel_with_player (const struct player *pplayer)

const char *	title_for_player (const struct player pplayer, char buf, size_t buf_len)

bool	can_client_change_view (void)

void	set_server_busy (bool busy)

bool	is_server_busy (void)

bool	client_is_global_observer (void)

int	client_player_number (void)

bool	client_has_player (void)

bool	client_map_is_known_and_seen (const struct tile ptile, const struct player pplayer, enum vision_layer vlayer)

static int	client_plr_tile_city_id_get (const struct tile ptile, const struct player pplayer)

static server_setting_id	client_ss_by_name (const char *name)

static const char *	client_ss_name_get (server_setting_id id)

static enum sset_type	client_ss_type_get (server_setting_id id)

static bool	client_ss_val_bool_get (server_setting_id id)

static int	client_ss_val_int_get (server_setting_id id)

static unsigned int	client_ss_val_bitwise_get (server_setting_id id)

bool	is_client_quitting (void)

void	start_quitting (void)

Variables
char *	logfile = NULL

char *	scriptfile = NULL

char *	savefile = NULL

char	forced_tileset_name [512] = "\0"

char	sound_plugin_name [512] = "\0"

char	sound_set_name [512] = "\0"

char	music_set_name [512] = "\0"

char	server_host [512] = "\0"

char	user_name [512] = "\0"

char	fc_password [MAX_LEN_PASSWORD] = "\0"

char	metaserver [512] = "\0"

int	server_port = -1

bool	auto_connect = FALSE

bool	auto_spawn = FALSE

enum announce_type	announce

struct civclient	client

static enum client_states	civclient_state = C_S_INITIAL

bool	waiting_for_end_turn = FALSE

static bool	server_busy = FALSE

static bool	client_quitting = FALSE

static double	seconds_to_turndone = 0.0

static struct timer *	turndone_timer

static struct timer *	between_turns = NULL

static bool	waiting_turn_change = FALSE

static int	seconds_shown_to_turndone

static int	seconds_shown_to_new_turn

Function Documentation

◆ at_exit()

static void at_exit ( void )

static

This is called at program exit.

Definition at line 236 of file client_main.c.

Referenced by client_main().

◆ can_client_change_view()

bool can_client_change_view ( void )

Return TRUE if the client can change the view; i.e. if the mapview is active. This function should be called each time before allowing the user to do mapview actions.

Definition at line 1313 of file client_main.c.

◆ can_client_control()

bool can_client_control ( void )

Returns TRUE iff the client can control player.

Definition at line 1254 of file client_main.c.

Referenced by can_client_issue_orders(), draw_calculated_trade_routes(), nation_button_callback(), ready_button_callback(), fc_client::slot_pregame_start(), fc_client::update_buttons(), update_start_page_buttons(), usdlg_cmd_cursor_changed(), usdlg_cmd_exec(), usdlg_cmd_focus_real(), and voteinfo_do_vote().

◆ can_client_issue_orders()

bool can_client_issue_orders ( void )

Returns TRUE iff the client can issue orders (such as giving unit commands). This function should be called each time before allowing the user to give an order.

Definition at line 1265 of file client_main.c.

Referenced by action_decision_request(), adjust_workers_button_pressed(), append_cma_to_menu_item(), butt_down_overviewcanvas(), button_down_citymap(), city_dialog::buy(), buy_callback(), can_end_turn(), can_meet_with_player(), change_production_callback(), citizens_callback(), citizens_callback(), city_can_buy(), city_packet_common(), city_dialog::city_rename(), city_selection_changed_callback(), cityopt_callback(), city_dialog::clear_worklist(), client_change_all(), client_init_meeting(), clipboard_copy_production(), clipboard_paste_production(), city_dialog::cma_double_clicked(), common_taxrates_callback(), city_map::context_menu(), unit_item::contextMenuEvent(), unit_item::create_actions(), create_and_append_settings_page(), create_governor_menu(), create_multiplier_dialog(), create_rates_dialog(), create_unit_menu(), create_wl_menu(), science_report::current_tech_changed(), disband_all_units(), city_widget::display_list_menu(), city_dialog::display_worklist_menu(), do_disband_alternative(), economy_report_command_callback(), economy_report_selection_callback(), enable_minimap_widgets(), enable_order_buttons(), enable_unitinfo_widgets(), science_report::goal_tech_changed(), gui_init_meeting(), handle_city_name_suggestion_info(), handle_city_sabotage_list(), diplo_dlg::init(), key_unit_assign_battlegroup(), left_butt_down_overviewcanvas(), left_button_down_citymap(), maybe_activate_keyboardless_goto(), mr_menu::menus_sensitive(), middle_present_unit_release(), middle_supported_unit_release(), impr_item::mouseDoubleClickEvent(), city_map::mousePressEvent(), city_label::mousePressEvent(), plr_widget::mousePressEvent(), research_diagram::mousePressEvent(), multipliers_command_callback(), popup_airlift_dialog(), popup_diplomacy_dialog(), popup_goto_dialog(), popup_multiplier_dialog(), popup_rates_dialog(), present_unit_callback(), present_unit_middle_callback(), city_dialog::production_changed(), production_menu_shown(), real_city_dialog_refresh(), real_menus_init(), real_menus_update(), real_multipliers_dialog_update(), refresh_cma_dialog(), refresh_worklist(), request_new_unit_activity_targeted(), request_orders_cleared(), request_unit_load(), request_unit_unload(), right_button_down_citymap(), right_unit_release(), science_diagram_button_release_callback(), science_diagram_left_button_up(), science_report_current_callback(), science_report_goal_callback(), science_report_init(), sell_all_improvements(), sell_callback(), set_government_choice(), spaceship_autoplace(), src_selection_callback(), supported_unit_callback(), supported_unit_middle_callback(), units_orders_city_dlg_callback(), units_report_command_callback(), units_report_selection_callback(), update_city_cma_dialog(), city_dialog::update_disabled(), update_players_menu(), plr_report::update_report(), upgrade_canvas_clipboard(), wakeup_button_pressed(), and wakeup_sentried_units().

◆ can_intel_with_player()

bool can_intel_with_player ( const struct player * pplayer )

Returns TRUE iff the client can get intelligence from another given player.

Definition at line 1286 of file client_main.c.

Referenced by button_press_callback(), left_button_press_callback(), player_nation_callback(), players_intel_callback(), players_intel_callback(), popup_players_nations_dialog(), title_for_player(), and update_players_menu().

◆ can_meet_with_player()

bool can_meet_with_player ( const struct player * pplayer )

Returns TRUE iff the client can do diplomatic meetings with another given player.

Definition at line 1275 of file client_main.c.

Referenced by button_press_callback(), call_meeting_dlg_callback(), player_nation_callback(), popup_diplomacy_dialog(), popup_players_nations_dialog(), right_button_press_callback(), update_players_menu(), and plr_report::update_report().

◆ charsets_init()

static void charsets_init ( void )

static

Set up charsets for the client.

Definition at line 218 of file client_main.c.

Referenced by client_main().

◆ client_exit()

void fc__noreturn client_exit ( int return_value )

Main client execution stop function. This calls ui_exit() and not the other way around.

Definition at line 724 of file client_main.c.

Referenced by client_main(), and default_tileset_select().

◆ client_game_free()

static void client_game_free ( void )

static

Called by set_client_state() and client_exit() below.

Definition at line 271 of file client_main.c.

Referenced by client_exit(), and set_client_state().

◆ client_game_init()

static void client_game_init ( void )

static

Called only by set_client_state() below.

Definition at line 248 of file client_main.c.

Referenced by set_client_state().

◆ client_game_reset()

static void client_game_reset ( void )

static

Called only by set_client_state() below. Just free what is needed to change view (player target).

Definition at line 301 of file client_main.c.

Referenced by set_client_state().

◆ client_has_player()

bool client_has_player ( void )

Either controlling or observing.

Definition at line 1365 of file client_main.c.

Referenced by center_on_something(), city_model_fill(), city_model_get(), client_remove_unit(), collect_production_targets(), editor_apply_tool(), editor_grab_applied_player(), editor_grab_tool(), fill_row(), find_nearest_unit(), get_bulbs_per_turn(), handle_endgame_player(), handle_page_msg(), handle_player_attribute_chunk(), handle_player_diplstate(), handle_start_phase(), handle_unit_packet_common(), handle_unit_remove(), key_editor_toggle_fogofwar(), meswin_add(), meswin_dialog_update(), city_model::populate(), popup_goto_dialog(), real_city_dialog_refresh(), real_menus_init(), mr_menu::save_image(), science_report_redraw(), set_client_state(), show_new_turn_info(), units_report_update(), update_goto_dialog(), units_reports::update_units(), and voteinfo_bar_can_be_shown().

◆ client_is_global_observer()

bool client_is_global_observer ( void )

Returns whether client is global observer

Definition at line 1346 of file client_main.c.

Referenced by city_packet_common(), col_government(), create_city_dialog(), units_select::create_pixmap(), draw_trade_routes(), editbar_player_pov_combobox_changed(), editor_apply_tool(), get_culture_info(), get_gold_info(), get_luxury_info(), get_researching_info(), get_science_info(), get_tax_info(), handle_worker_task(), mapimg_client_define(), mapimg_client_tile_known(), plr_widget::nation_selected(), observe_button_callback(), popup_info_text(), popup_spaceship_dialog(), refresh_player_pov_indicator(), science_report_dialog_popup(), science_report_init(), show_full_citybar(), show_small_citybar(), side_left_click_science(), side_right_click_diplomacy(), fc_client::slot_pregame_observe(), switch_city_callback(), fc_client::update_buttons(), fc_sidewidget::update_final_pixmap(), update_intel_dialog(), fc_client::update_sidebar_tooltips(), update_start_page_buttons(), usdlg_data_new(), and usdlg_get_unit_descr().

◆ client_is_observer()

bool client_is_observer ( void )

Returns whether client is observer.

Definition at line 1084 of file client_main.c.

Referenced by attribute_flush(), can_client_change_view(), can_client_control(), can_intel_with_player(), client_tile_get_known(), create_city_dialog(), city_dialog::disband_state_changed(), enqueue_call(), handle_event(), handle_start_phase(), key_press_map_canvas(), key_press_map_canvas(), mr_menu::menus_sensitive(), production_widget::prod_selected(), qtg_init_meeting(), real_city_dialog_refresh(), redraw_unit_info_label(), set_client_state(), show_new_turn_info(), side_rates_wdg(), side_right_click_diplomacy(), side_right_click_science(), fc_client::slot_pregame_observe(), switch_city_callback(), gov_menu::update(), mr_menu::update_airlift_menu(), mr_menu::update_bases_menu(), fc_client::update_buttons(), city_dialog::update_buy_button(), city_dialog::update_disabled(), update_info_label(), science_report::update_report(), mr_menu::update_roads_menu(), update_start_page_buttons(), and voteinfo_bar_can_be_shown().

◆ client_main()

int client_main	(	int	argc,
		char *	argv[],
		bool	postpone_tileset
	)

Entry point for common client code.

Definition at line 351 of file client_main.c.

Referenced by main().

◆ client_map_is_known_and_seen()

bool client_map_is_known_and_seen	(	const struct tile *	ptile,
		const struct player *	pplayer,
		enum vision_layer	vlayer
	)

Return the vision of the player on a tile. Client version of ./server/maphand/map_is_known_and_seen().

Definition at line 1374 of file client_main.c.

Referenced by fc_interface_init_client(), and infra_placement_set_tile().

◆ client_packet_input()

void client_packet_input	(	void *	packet,
		int	type
	)

Handle packet received from server.

Definition at line 774 of file client_main.c.

Referenced by input_from_server(), and input_from_server_till_request_got_processed().

◆ client_player_number()

int client_player_number ( void )

Returns number of player attached to client.

Definition at line 1354 of file client_main.c.

Referenced by editbar_player_pov_combobox_changed(), editor_apply_tool(), and key_editor_toggle_fogofwar().

◆ client_plr_tile_city_id_get()

static int client_plr_tile_city_id_get	(	const struct tile *	ptile,
		const struct player *	pplayer
	)

static

Returns the id of the city the player believes exists at 'ptile'.

Definition at line 1384 of file client_main.c.

Referenced by fc_interface_init_client().

◆ client_remove_all_cli_conn()

void client_remove_all_cli_conn ( void )

Remove (and free) all connections from all connection lists in client. Assumes game.all_connections is properly maintained with all connections.

Definition at line 1053 of file client_main.c.

Referenced by client_exit(), and set_client_state().

◆ client_remove_cli_conn()

void client_remove_cli_conn ( struct connection * pconn )

Remove pconn from all connection lists in client, then free it.

Definition at line 1035 of file client_main.c.

Referenced by client_remove_all_cli_conn(), and handle_conn_info().

◆ client_ss_by_name()

static server_setting_id client_ss_by_name ( const char * name )

static

Returns the id of the server setting with the specified name.

Definition at line 1398 of file client_main.c.

Referenced by fc_interface_init_client().

◆ client_ss_name_get()

static const char * client_ss_name_get ( server_setting_id id )

static

Returns the name of the server setting with the specified id.

Definition at line 1413 of file client_main.c.

Referenced by fc_interface_init_client().

◆ client_ss_type_get()

static enum sset_type client_ss_type_get ( server_setting_id id )

static

Returns the type of the server setting with the specified id.

Definition at line 1428 of file client_main.c.

Referenced by fc_interface_init_client().

◆ client_ss_val_bitwise_get()

static unsigned int client_ss_val_bitwise_get ( server_setting_id id )

static

Returns the value of the bitwise server setting with the specified id.

Definition at line 1501 of file client_main.c.

Referenced by fc_interface_init_client().

◆ client_ss_val_bool_get()

static bool client_ss_val_bool_get ( server_setting_id id )

static

Returns the value of the boolean server setting with the specified id.

Definition at line 1471 of file client_main.c.

Referenced by fc_interface_init_client().

◆ client_ss_val_int_get()

static int client_ss_val_int_get ( server_setting_id id )

static

Returns the value of the integer server setting with the specified id.

Definition at line 1486 of file client_main.c.

Referenced by fc_interface_init_client().

◆ client_state()

enum client_states client_state ( void )

Return current client state.

Definition at line 1027 of file client_main.c.

Referenced by apply_taxrates_callback(), boot_help_texts(), button_down_on_map(), button_up_on_map(), can_client_change_view(), can_client_issue_orders(), client_exit(), diplo_wdg::closeEvent(), control_mouse_cursor(), create_races_dialog(), disable_main_widgets(), enable_main_widgets(), finger_down_on_map(), finger_up_on_map(), flush_dirty(), flush_rect(), global_worklists_load(), gui_flush(), handle_event(), handle_research_info(), inputline_return(), map_view::keyPressEvent(), main_key_down_handler(), main_key_down_handler(), map_event_handler(), map_event_handler(), mr_menu::menus_sensitive(), musicspec_reread_callback(), option_dialog_new(), play_single_track(), popdown_all_game_dialogs(), popup_goto_dialog(), qtg_real_output_window_append(), races_dialog::races_dialog(), real_conn_list_dialog_update(), real_menus_init(), real_menus_update(), real_resize_window_callback(), real_timer_callback(), resize_minimap(), fc_game_tab_widget::resizeEvent(), minimap_view::resizeEvent(), chat_listener::send_chat_message(), start_style_music(), thaw(), themespec_reread(), tilespec_reread(), tilespec_reread_callback(), update_unit_info_label(), and update_unit_pix_label().

◆ default_tileset_select()

int default_tileset_select ( void )

Do the initial default tileset selection.

Definition at line 323 of file client_main.c.

Referenced by client_main(), and qtg_ui_main().

◆ emergency_exit()

static void emergency_exit ( void )

static

This is called at program exit in any emergency. This is registered as at_quick_exit() callback, so no destructor kind of actions here

Definition at line 228 of file client_main.c.

Referenced by at_exit(), and client_main().

◆ fc_interface_init_client()

static void fc_interface_init_client ( void )

static

Initialize client specific functions.

Definition at line 1516 of file client_main.c.

Referenced by client_main().

◆ get_conv()

static bool get_conv	(	char *	dst,
		size_t	ndst,
		const char *	src,
		size_t	nsrc
	)

static

Convert a text string from the data to the internal encoding when it is first read from the network. Returns FALSE if the destination isn't large enough or the source was bad.

Definition at line 190 of file client_main.c.

Referenced by charsets_init().

◆ get_seconds_to_new_turn()

int get_seconds_to_new_turn ( void )

Return the number of seconds until turn-done. Don't call this unless current_turn_timeout() != 0.

Definition at line 1173 of file client_main.c.

Referenced by get_timeout_label_text().

◆ get_seconds_to_turndone()

int get_seconds_to_turndone ( void )

Return the number of seconds until turn-done. Don't call this unless current_turn_timeout() != 0.

Definition at line 1159 of file client_main.c.

Referenced by get_timeout_label_text().

◆ is_client_quitting()

bool is_client_quitting ( void )

Is the client marked as one going down?

Definition at line 1637 of file client_main.c.

Referenced by fc_client::closeEvent(), and set_client_state().

◆ is_server_busy()

bool is_server_busy ( void )

Returns if server is considered busy at the moment

Definition at line 1338 of file client_main.c.

Referenced by can_end_turn(), and control_mouse_cursor().

◆ is_waiting_turn_change()

bool is_waiting_turn_change ( void )

Are we in turn-change wait state?

Definition at line 1128 of file client_main.c.

Referenced by get_timeout_label_text(), and real_menus_update().

◆ log_option_save_msg()

static void log_option_save_msg	(	enum log_level	lvl,
		const char *	msg,
			...
	)

static

Write messages from option saving to the log.

Definition at line 711 of file client_main.c.

Referenced by client_exit().

◆ mapimg_client_plrcolor_count()

static int mapimg_client_plrcolor_count ( void )

static

Helper function for the mapimg module - number of player colors.

Definition at line 1607 of file client_main.c.

Referenced by client_game_init().

◆ mapimg_client_plrcolor_get()

static struct rgbcolor * mapimg_client_plrcolor_get ( int i )

static

Helper function for the mapimg module - one player color. For the client only the colors of the defined players are shown.

Definition at line 1616 of file client_main.c.

Referenced by client_game_init().

◆ mapimg_client_tile_city()

static struct player * mapimg_client_tile_city	(	const struct tile *	ptile,
		const struct player *	pplayer,
		bool	knowledge
	)

static

Helper function for the mapimg module - city owner.

Definition at line 1575 of file client_main.c.

Referenced by client_game_init().

◆ mapimg_client_tile_known()

static enum known_type mapimg_client_tile_known	(	const struct tile *	ptile,
		const struct player *	pplayer,
		bool	knowledge
	)

static

Helper function for the mapimg module - tile knowledge.

Definition at line 1541 of file client_main.c.

Referenced by client_game_init().

◆ mapimg_client_tile_owner()

static struct player * mapimg_client_tile_owner	(	const struct tile *	ptile,
		const struct player *	pplayer,
		bool	knowledge
	)

static

Helper function for the mapimg module - tile owner.

Definition at line 1565 of file client_main.c.

Referenced by client_game_init().

◆ mapimg_client_tile_terrain()

static struct terrain * mapimg_client_tile_terrain	(	const struct tile *	ptile,
		const struct player *	pplayer,
		bool	knowledge
	)

static

Helper function for the mapimg module - tile terrain.

Definition at line 1556 of file client_main.c.

Referenced by client_game_init().

◆ mapimg_client_tile_unit()

static struct player * mapimg_client_tile_unit	(	const struct tile *	ptile,
		const struct player *	pplayer,
		bool	knowledge
	)

static

Helper function for the mapimg module - unit owner.

Definition at line 1591 of file client_main.c.

Referenced by client_game_init().

◆ put_conv()

static char * put_conv	(	const char *	src,
		size_t *	length
	)

static

Convert a text string from the internal to the data encoding, when it is written to the network.

Definition at line 172 of file client_main.c.

Referenced by charsets_init().

◆ real_timer_callback()

double real_timer_callback ( void )

This function should be called at least once per second. It does various updates (idle animations and timeout updates). It returns the number of seconds until it should be called again.

Definition at line 1183 of file client_main.c.

Referenced by gui_event_loop(), gui_event_loop(), timer_callback(), and fc_client::timerEvent().