#include <stdarg.h>
#include <string.h>
#include "fcintl.h"
#include "log.h"
#include "mem.h"
#include "shared.h"
#include "support.h"
#include "city.h"
#include "combat.h"
#include "game.h"
#include "map.h"
#include "tile.h"
#include "unit.h"
#include "featured_text.h"

Data Structures
struct	text_tag

Macros
#define	SEQ_START '['

#define	SEQ_STOP ']'

#define	SEQ_END '/'

#define	MAX_LEN_STR 32

#define	log_featured_text log_verbose

#define	text_tag_list_rev_iterate(tags, ptag) TYPED_LIST_ITERATE_REV(struct text_tag, tags, ptag)

#define	text_tag_list_rev_iterate_end LIST_ITERATE_REV_END

Enumerations
enum	sequence_type { ST_START , ST_STOP , ST_SINGLE }

Functions
static const char *	text_tag_type_name (enum text_tag_type type)

static const char *	text_tag_type_short_name (enum text_tag_type type)

static const char *	text_link_type_name (enum text_link_type type)

static bool	find_option (const char buf_in, const char option, char *buf_out, size_t write_len)

static bool	text_tag_init_from_sequence (struct text_tag ptag, enum text_tag_type type, ft_offset_t start_offset, const char sequence)

static bool	text_tag_initv (struct text_tag *ptag, enum text_tag_type type, ft_offset_t start_offset, ft_offset_t stop_offset, va_list args)

static size_t	text_tag_start_sequence (const struct text_tag ptag, char buf, size_t len)

static size_t	text_tag_stop_sequence (const struct text_tag ptag, char buf, size_t len)

static size_t	text_tag_replace_text (const struct text_tag ptag, char buf, size_t len, bool replace_link_text)

struct text_tag *	text_tag_new (enum text_tag_type tag_type, ft_offset_t start_offset, ft_offset_t stop_offset,...)

struct text_tag *	text_tag_copy (const struct text_tag *ptag)

void	text_tag_destroy (struct text_tag *ptag)

enum text_tag_type	text_tag_type (const struct text_tag *ptag)

ft_offset_t	text_tag_start_offset (const struct text_tag *ptag)

ft_offset_t	text_tag_stop_offset (const struct text_tag *ptag)

const char *	text_tag_color_foreground (const struct text_tag *ptag)

const char *	text_tag_color_background (const struct text_tag *ptag)

enum text_link_type	text_tag_link_type (const struct text_tag *ptag)

int	text_tag_link_id (const struct text_tag *ptag)

static size_t	extract_sequence_text (const char featured_text, char buf, size_t len, enum sequence_type seq_type, enum text_tag_type type)

size_t	featured_text_to_plain_text (const char featured_text, char plain_text, size_t plain_text_len, struct text_tag_list **tags, bool replace_link_text)

size_t	featured_text_apply_tag (const char text_source, char featured_text, size_t featured_text_len, enum text_tag_type tag_type, ft_offset_t start_offset, ft_offset_t stop_offset,...)

const char *	city_link (const struct city *pcity)

const char *	city_tile_link (const struct city *pcity)

const char *	tile_link (const struct tile *ptile)

const char *	unit_link (const struct unit *punit)

const char *	unit_tile_link (const struct unit *punit)

Variables
const struct ft_color	ftc_any = FT_COLOR(nullptr, nullptr)

const struct ft_color	ftc_warning = FT_COLOR("#FF0000", nullptr)

const struct ft_color	ftc_log = FT_COLOR("#7F7F7F", nullptr)

const struct ft_color	ftc_server = FT_COLOR("#8B0000", nullptr)

const struct ft_color	ftc_client = FT_COLOR("#EF7F00", nullptr)

const struct ft_color	ftc_editor = FT_COLOR("#0000FF", nullptr)

const struct ft_color	ftc_command = FT_COLOR("#006400", nullptr)

VAR_ARG_CONST struct ft_color	ftc_changed = FT_COLOR("#FF0000", nullptr)

const struct ft_color	ftc_server_prompt = FT_COLOR("#FF0000", "#BEBEBE")

const struct ft_color	ftc_player_lost = FT_COLOR("#FFFFFF", "#000000")

const struct ft_color	ftc_game_start = FT_COLOR("#00FF00", "#115511")

const struct ft_color	ftc_chat_public = FT_COLOR("#00008B", nullptr)

const struct ft_color	ftc_chat_ally = FT_COLOR("#551166", nullptr)

const struct ft_color	ftc_chat_private = FT_COLOR("#A020F0", nullptr)

const struct ft_color	ftc_chat_luaconsole = FT_COLOR("#006400", nullptr)

const struct ft_color	ftc_vote_public = FT_COLOR("#FFFFFF", "#AA0000")

const struct ft_color	ftc_vote_team = FT_COLOR("#FFFFFF", "#5555CC")

const struct ft_color	ftc_vote_passed = FT_COLOR("#006400", "#AAFFAA")

const struct ft_color	ftc_vote_failed = FT_COLOR("#8B0000", "#FFAAAA")

const struct ft_color	ftc_vote_yes = FT_COLOR("#000000", "#C8FFD5")

const struct ft_color	ftc_vote_no = FT_COLOR("#000000", "#FFD2D2")

const struct ft_color	ftc_vote_abstain = FT_COLOR("#000000", "#E8E8E8")

const struct ft_color	ftc_luaconsole_input = FT_COLOR("#2B008B", nullptr)

const struct ft_color	ftc_luaconsole_error = FT_COLOR("#FF0000", nullptr)

const struct ft_color	ftc_luaconsole_warn = FT_COLOR("#CF2020", nullptr)

const struct ft_color	ftc_luaconsole_normal = FT_COLOR("#006400", nullptr)

const struct ft_color	ftc_luaconsole_verbose = FT_COLOR("#B8B8B8", nullptr)

const struct ft_color	ftc_luaconsole_debug = FT_COLOR("#B87676", nullptr)

Macro Definition Documentation

◆ log_featured_text

#define log_featured_text log_verbose

Definition at line 42 of file featured_text.c.

◆ MAX_LEN_STR

#define MAX_LEN_STR 32

Definition at line 41 of file featured_text.c.

◆ SEQ_END

#define SEQ_END '/'

Definition at line 39 of file featured_text.c.

◆ SEQ_START

#define SEQ_START '['

Definition at line 37 of file featured_text.c.

◆ SEQ_STOP

#define SEQ_STOP ']'

Definition at line 38 of file featured_text.c.

◆ text_tag_list_rev_iterate

#define text_tag_list_rev_iterate	(	tags,
		ptag
	)	TYPED_LIST_ITERATE_REV(struct text_tag, tags, ptag)

Definition at line 44 of file featured_text.c.

◆ text_tag_list_rev_iterate_end

#define text_tag_list_rev_iterate_end LIST_ITERATE_REV_END

Definition at line 46 of file featured_text.c.

Enumeration Type Documentation

◆ sequence_type

enum sequence_type

Enumerator
ST_START
ST_STOP
ST_SINGLE

Definition at line 66 of file featured_text.c.

Function Documentation

◆ city_link()

const char * city_link ( const struct city * pcity )

Get a text link to a city. N.B.: The returned string is static, so every call to this function overwrites the previous.

Definition at line 1076 of file featured_text.c.

Referenced by announce_trade_route_removal(), api_methods_city_link(), apply_disaster(), auto_arrange_workers(), build_free_small_wonders(), trade_generator::calculate(), change_build_target(), check_city_migrations_player(), check_pollution(), city_add_unit(), city_build_building(), city_build_unit(), city_distribute_surplus_shields(), city_empty_food_stock(), city_global_turn_notify(), city_illness_strike(), city_increase_size(), city_landlocked_sell_coastal_improvements(), city_populate(), city_refresh_after_city_size_increase(), city_turn_notify(), cityrep_buy(), civil_war(), create_city(), dai_city_sell_noncritical(), diplomat_embassy(), diplomat_escape(), diplomat_escape_full(), diplomat_get_tech(), diplomat_incite(), diplomat_infiltrate_tile(), diplomat_investigate(), diplomat_sabotage(), disband_city(), do_city_migration(), do_nuke_tile(), do_paradrop(), do_unit_change_homecity(), do_unit_conquer_city(), do_unit_establish_trade(), do_unit_strike_city_building(), do_unit_strike_city_production(), found_new_tech(), handle_city(), handle_diplomacy_accept_treaty_req(), handle_edit_city(), inputline_make_chat_link(), chatwdg::make_link(), player_loot_player(), really_handle_city_sell(), remove_city(), remove_obsolete_buildings_city(), research_tech_lost(), sell_random_building(), map_view::shortcut_pressed(), spy_escape(), spy_nuke_city(), spy_poison(), spy_spread_plague(), spy_steal_gold(), spy_steal_some_maps(), teleport_unit_to_city(), transfer_city(), transfer_unit(), try_summon_barbarians(), try_to_save_unit(), unit_attack_civilian_casualties(), unit_conquer_city(), unit_do_destroy_city(), unit_do_help_build(), unit_nuke(), update_city_activity(), upgrade_building_prod(), upgrade_unit_prod(), worklist_change_build_target(), and worklist_item_postpone_req_vec().

◆ city_tile_link()

const char * city_tile_link ( const struct city * pcity )

Get a text link to a city tile (make a clickable link to a tile with the city name as text). N.B.: The returned string is static, so every call to this function overwrites the previous.

Definition at line 1093 of file featured_text.c.

Referenced by api_methods_city_tile_link(), disband_city(), do_city_migration(), remove_city(), unit_conquer_city(), and unit_do_destroy_city().

◆ extract_sequence_text()

static size_t extract_sequence_text	(	const char *	featured_text,
		char *	buf,
		size_t	len,
		enum sequence_type *	seq_type,
		enum text_tag_type *	type
	)

static

Extract a sequence from a string. Also, determine the type and the text tag type of the sequence. Return 0 on error.

Definition at line 774 of file featured_text.c.

Referenced by featured_text_to_plain_text().

◆ featured_text_apply_tag()

size_t featured_text_apply_tag	(	const char *	text_source,
		char *	featured_text,
		size_t	featured_text_len,
		enum text_tag_type	tag_type,
		ft_offset_t	start_offset,
		ft_offset_t	stop_offset,
			...
	)

Apply a tag to a text. This text can already containing escape sequences. Returns 0 on error.

Prototype:

If tag_type is TTT_BOLD, TTT_ITALIC, TTT_STRIKE or TTT_UNDERLINE, there shouldn't be any extra argument.
If tag_type is TTT_COLOR: size_t featured_text_apply_tag(..., const struct ft_color color);
If tag_type is TTT_LINK and you want a city link: size_t featured_text_apply_tag(..., TLT_CITY, struct city *pcity);
If tag_type is TTT_LINK and you want a tile link: size_t featured_text_apply_tag(..., TLT_TILE, struct tile *ptile);
If tag_type is TTT_LINK and you want an unit link: size_t featured_text_apply_tag(..., TLT_UNIT, struct unit *punit);

◆ featured_text_to_plain_text()

size_t featured_text_to_plain_text	(	const char *	featured_text,
		char *	plain_text,
		size_t	plain_text_len,
		struct text_tag_list **	tags,
		bool	replace_link_text
	)

Separate the text from the text features. 'tags' can be nullptr.

When 'replace_link_text' is set, the text used for the signal sequence links will be overwritten. It is used on client side to have updated links in chatline, to communicate when users don't know share the city names, and avoid users making voluntary confusing names when editing links in chatline.

Definition at line 868 of file featured_text.c.

Referenced by con_write(), handle_event(), luaconsole_append(), and output_window_append().

◆ find_option()

static bool find_option	(	const char *	buf_in,
		const char *	option,
		char *	buf_out,
		size_t	write_len
	)

static

Find inside a sequence the string associated to a particular option name. Returns TRUE on success.

Definition at line 178 of file featured_text.c.

Referenced by text_tag_init_from_sequence().

◆ text_link_type_name()

static const char * text_link_type_name ( enum text_link_type type )

static

Return the name of the text tag link target type.

Definition at line 159 of file featured_text.c.

Referenced by city_link(), city_tile_link(), text_tag_init_from_sequence(), text_tag_start_sequence(), tile_link(), unit_link(), and unit_tile_link().

◆ text_tag_color_background()

const char * text_tag_color_background ( const struct text_tag * ptag )

Return the background color suggested by this text tag. This requires the tag type to be TTT_COLOR. Returns nullptr on error, "" if unset.

Definition at line 731 of file featured_text.c.

Referenced by apply_tags(), and apply_text_tag().

◆ text_tag_color_foreground()

const char * text_tag_color_foreground ( const struct text_tag * ptag )

Return the foreground color suggested by this text tag. This requires the tag type to be TTT_COLOR. Returns nullptr on error, "" if unset.

Definition at line 717 of file featured_text.c.

Referenced by apply_tags(), and apply_text_tag().

◆ text_tag_copy()

struct text_tag * text_tag_copy ( const struct text_tag * ptag )

This function returns a new pointer to a text_tag which is similar to the 'ptag' argument.

Definition at line 667 of file featured_text.c.

◆ text_tag_destroy()

void text_tag_destroy ( struct text_tag * ptag )

Free a text_tag structure.

Definition at line 684 of file featured_text.c.

Referenced by featured_text_to_plain_text().

◆ text_tag_init_from_sequence()

static bool text_tag_init_from_sequence	(	struct text_tag *	ptag,
		enum text_tag_type	type,
		ft_offset_t	start_offset,
		const char *	sequence
	)

static

Initialize a text_tag structure from a string sequence. Returns TRUE on success.

Definition at line 227 of file featured_text.c.

Referenced by featured_text_to_plain_text().

◆ text_tag_initv()

static bool text_tag_initv	(	struct text_tag *	ptag,
		enum text_tag_type	type,
		ft_offset_t	start_offset,
		ft_offset_t	stop_offset,
		va_list	args
	)

static

Initialize a text_tag structure from a va_list.

What's should be in the va_list:

If the text tag type is TTT_BOLD, TTT_ITALIC, TTT_STRIKE or TTT_UNDERLINE, there shouldn't be any extra argument.
If the text tag type is TTT_COLOR, then there should be 1 argument of type 'struct ft_color'.
If the text tag type is TTT_LINK, then there should be 2 extra arguments. The first is type 'enum text_link_type' and will determine the type of the following argument:
- If the link type is TLT_CITY, last argument is typed 'struct city *'.
- If the link type is TLT_TILE, last argument is typed 'struct tile *'.
- If the link type is TLT_UNIT, last argument is typed 'struct unit *'.

Returns TRUE on success.

Definition at line 391 of file featured_text.c.

Referenced by featured_text_apply_tag(), and text_tag_new().

◆ text_tag_link_id()

int text_tag_link_id ( const struct text_tag * ptag )

Return the link target id suggested by this text tag (city id, tile index or unit id). This requires the tag type to be TTT_LINK. Returns -1 on error.

Definition at line 760 of file featured_text.c.

Referenced by apply_tags(), apply_text_tag(), and handle_event().

◆ text_tag_link_type()

enum text_link_type text_tag_link_type ( const struct text_tag * ptag )

Return the link target type suggested by this text tag. This requires the tag type to be TTT_LINK. Returns -1 on error.

Definition at line 745 of file featured_text.c.

Referenced by apply_tags(), apply_text_tag(), and handle_event().

◆ text_tag_new()

struct text_tag * text_tag_new	(	enum text_tag_type	tag_type,
		ft_offset_t	start_offset,
		ft_offset_t	stop_offset,
			...
	)

Returns a new text_tag or nullptr on error.

Prototype:

If tag_type is TTT_BOLD, TTT_ITALIC, TTT_STRIKE or TTT_UNDERLINE, there shouldn't be any extra argument.
If tag_type is TTT_COLOR: struct text_tag *text_tag_new(..., const struct ft_color color);
If tag_type is TTT_LINK and you want a city link: struct text_tag *text_tag_new(..., TLT_CITY, struct city *pcity);
If tag_type is TTT_LINK and you want a tile link: struct text_tag *text_tag_new(..., TLT_TILE, struct tile *ptile);
If tag_type is TTT_LINK and you want an unit link: struct text_tag *text_tag_new(..., TLT_UNIT, struct unit *punit);

◆ text_tag_replace_text()

static size_t text_tag_replace_text	(	const struct text_tag *	ptag,
		char *	buf,
		size_t	len,
		bool	replace_link_text
	)

static

When the sequence looks like [sequence/] then we insert a string instead.

Definition at line 578 of file featured_text.c.

Referenced by featured_text_to_plain_text().

◆ text_tag_start_offset()

ft_offset_t text_tag_start_offset ( const struct text_tag * ptag )

Return the start offset (in bytes) of this text tag.

Definition at line 700 of file featured_text.c.

Referenced by apply_tags(), and apply_text_tag().

◆ text_tag_start_sequence()

static size_t text_tag_start_sequence	(	const struct text_tag *	ptag,
		char *	buf,
		size_t	len
	)

static

Print in a string the start sequence of the tag.

Definition at line 474 of file featured_text.c.

Referenced by featured_text_apply_tag().

◆ text_tag_stop_offset()

ft_offset_t text_tag_stop_offset ( const struct text_tag * ptag )

Return the stop offset (in bytes) of this text tag.

Definition at line 708 of file featured_text.c.

Referenced by apply_tags(), and apply_text_tag().

◆ text_tag_stop_sequence()

static size_t text_tag_stop_sequence	(	const struct text_tag *	ptag,
		char *	buf,
		size_t	len
	)

static

Print in a string the stop sequence of the tag.

Definition at line 563 of file featured_text.c.

Referenced by featured_text_apply_tag().

◆ text_tag_type()

enum text_tag_type text_tag_type ( const struct text_tag * ptag )

Return the type of this text tag.

Definition at line 692 of file featured_text.c.

◆ text_tag_type_name()

static const char * text_tag_type_name ( enum text_tag_type type )

static

Return the long name of the text tag type. See also text_tag_type_short_name().

Definition at line 110 of file featured_text.c.

Referenced by extract_sequence_text(), and featured_text_to_plain_text().

◆ text_tag_type_short_name()

static const char * text_tag_type_short_name ( enum text_tag_type type )

static

Return the name abbreviation of the text tag type. See also text_tag_type_name().

Definition at line 135 of file featured_text.c.

Referenced by city_link(), city_tile_link(), extract_sequence_text(), text_tag_start_sequence(), text_tag_stop_sequence(), tile_link(), unit_link(), and unit_tile_link().

◆ tile_link()

const char * tile_link ( const struct tile * ptile )

Get a text link to a tile. N.B.: The returned string is static, so every call to this function overwrites the previous.

Definition at line 1110 of file featured_text.c.

Referenced by api_methods_tile_link(), city_build(), diplomat_infiltrate_tile(), do_conquer_extras(), do_paradrop(), end_turn(), execute_orders(), handle_edit_city_create(), handle_edit_player_vision(), handle_edit_tile_extra(), handle_edit_tile_terrain(), handle_edit_unit_create(), handle_edit_unit_remove(), inputline_make_chat_link(), chatwdg::make_link(), map_view::shortcut_pressed(), spy_attack(), spy_escape(), unit_activity_targeted_internal(), unit_do_regular_move(), unit_nuke(), and update_unit_activity().

◆ unit_link()

const char * unit_link ( const struct unit * punit )

Get a text link to an unit. N.B.: The returned string is static, so every call to this function overwrites the previous.

Definition at line 1126 of file featured_text.c.

Referenced by api_methods_unit_link(), bounce_unit(), can_unit_move_to_tile_with_notify(), city_distribute_surplus_shields(), collect_ransom(), diplomat_bribe_stack(), diplomat_bribe_unit(), diplomat_escape_full(), diplomat_infiltrate_tile(), diplomat_sabotage(), do_airline(), do_attack(), do_capture_units(), do_expel_unit(), do_heal_unit(), do_unit_establish_trade(), do_unit_strike_city_building(), do_unit_strike_city_production(), do_unit_upgrade(), do_upgrade_effects(), do_wipe_units(), execute_orders(), explain_why_no_action_enabled(), handle_edit_unit(), illegal_action_msg(), inputline_make_chat_link(), kill_unit(), chatwdg::make_link(), notify_unit_experience(), player_restore_units(), remove_city(), server_remove_unit_full(), spy_nuke_city(), spy_poison(), spy_sabotage_unit(), spy_spread_plague(), spy_steal_gold(), spy_steal_some_maps(), teleport_unit_to_city(), terrain_change_bounce_single_unit(), transfer_unit(), try_to_save_unit(), unit_activities_cancel(), unit_attack_civilian_casualties(), unit_bombard(), unit_do_help_build(), and wakeup_neighbor_sentries().

◆ unit_tile_link()

const char * unit_tile_link ( const struct unit * punit )

Get a text link to a unit tile (make a clickable link to a tile with the unit type name as text). N.B.: The returned string is static, so every call to this function overwrites the previous.

Definition at line 1143 of file featured_text.c.

Referenced by api_methods_unit_tile_link(), begin_turn(), bounce_unit(), check_units_single_tile(), city_add_unit(), city_populate(), collect_ransom(), diplomat_escape_full(), diplomat_get_tech(), diplomat_incite(), diplomat_infiltrate_tile(), diplomat_sabotage(), do_attack(), do_nuke_tile(), do_paradrop(), do_unit_change_homecity(), do_unit_establish_trade(), hut_get_limited(), kill_unit(), player_restore_units(), remove_city(), remove_illegal_armistice_units(), sell_random_unit(), spy_nuke_city(), spy_poison(), spy_spread_plague(), spy_steal_gold(), spy_steal_some_maps(), transfer_city_units(), transfer_unit(), unit_lost_with_transport(), and unit_nuke().