|
Freeciv-3.2
|
Go to the source code of this file.
Data Structures | |
| struct | requirement |
| struct | req_context |
| struct | req_vec_change |
| struct | req_vec_problem |
Typedefs | |
| typedef enum req_unchanging_status(* | req_unchanging_cond_cb) (const struct civ_map *nmap, enum req_unchanging_status def, const struct req_context *context, const struct requirement *req) |
| typedef enum fc_tristate(* | req_tester_cb) (const struct req_context *context, const struct player *other_player, const struct requirement *req, void *data, int n_data) |
| typedef signed char | req_vec_num_in_item |
| req_vec_num_in_item a requirement vectors number in an item. | |
| typedef req_vec_num_in_item(* | requirement_vector_number) (const void *parent_item, const struct requirement_vector *vec) |
| typedef struct requirement_vector *(* | requirement_vector_by_number) (const void *parent_item, req_vec_num_in_item number) |
| typedef const char *(* | requirement_vector_namer) (req_vec_num_in_item number) |
Enumerations | |
| enum | req_unchanging_status { REQUCH_NO = 0 , REQUCH_CTRL , REQUCH_ACT , REQUCH_SCRIPTS , REQUCH_HACK , REQUCH_YES } |
| enum | req_item_found { ITF_NO , ITF_YES , ITF_NOT_APPLICABLE } |
Definition at line 65 of file requirements.h.
| #define req_range_iterate_end |
Definition at line 71 of file requirements.h.
| #define REQ_RANGE_MAX (REQ_RANGE_COUNT - 1) /* REQ_RANGE_WORLD */ |
Definition at line 62 of file requirements.h.
| #define requirement_diplrel_ereq | ( | _id_, | |
| _range_, | |||
| _present_ | |||
| ) | requirement_kind_ereq(_id_, _range_, _present_, DRO_LAST) |
Definition at line 449 of file requirements.h.
Definition at line 435 of file requirements.h.
Definition at line 429 of file requirements.h.
Definition at line 409 of file requirements.h.
Definition at line 415 of file requirements.h.
Definition at line 412 of file requirements.h.
Definition at line 432 of file requirements.h.
Definition at line 419 of file requirements.h.
Definition at line 423 of file requirements.h.
Definition at line 426 of file requirements.h.
Definition at line 439 of file requirements.h.
| #define requirement_vector_iterate | ( | req_vec, | |
| preq | |||
| ) | TYPED_VECTOR_ITERATE(struct requirement, req_vec, preq) |
Definition at line 92 of file requirements.h.
| #define requirement_vector_iterate_end VECTOR_ITERATE_END |
Definition at line 94 of file requirements.h.
| #define SPECENUM_COUNT REQ_RANGE_COUNT /* Keep this last */ |
Definition at line 61 of file requirements.h.
Definition at line 61 of file requirements.h.
Definition at line 37 of file requirements.h.
Definition at line 37 of file requirements.h.
| #define SPECENUM_VALUE0 REQ_RANGE_LOCAL |
Definition at line 38 of file requirements.h.
| #define SPECENUM_VALUE0 RVCO_REMOVE |
Definition at line 38 of file requirements.h.
| #define SPECENUM_VALUE0NAME "Local" |
Definition at line 39 of file requirements.h.
Definition at line 39 of file requirements.h.
| #define SPECENUM_VALUE1 REQ_RANGE_TILE |
Definition at line 40 of file requirements.h.
| #define SPECENUM_VALUE1 RVCO_APPEND |
Definition at line 40 of file requirements.h.
| #define SPECENUM_VALUE10 REQ_RANGE_WORLD |
Definition at line 59 of file requirements.h.
| #define SPECENUM_VALUE10NAME "World" |
Definition at line 60 of file requirements.h.
| #define SPECENUM_VALUE1NAME "Tile" |
Definition at line 41 of file requirements.h.
Definition at line 41 of file requirements.h.
| #define SPECENUM_VALUE2 REQ_RANGE_CADJACENT |
Definition at line 42 of file requirements.h.
| #define SPECENUM_VALUE2NAME "CAdjacent" |
Definition at line 43 of file requirements.h.
| #define SPECENUM_VALUE3 REQ_RANGE_ADJACENT |
Definition at line 44 of file requirements.h.
| #define SPECENUM_VALUE3NAME "Adjacent" |
Definition at line 45 of file requirements.h.
| #define SPECENUM_VALUE4 REQ_RANGE_CITY |
Definition at line 46 of file requirements.h.
| #define SPECENUM_VALUE4NAME "City" |
Definition at line 47 of file requirements.h.
| #define SPECENUM_VALUE5 REQ_RANGE_TRADE_ROUTE |
Definition at line 48 of file requirements.h.
| #define SPECENUM_VALUE5NAME "Traderoute" |
Definition at line 50 of file requirements.h.
| #define SPECENUM_VALUE6 REQ_RANGE_CONTINENT |
Definition at line 51 of file requirements.h.
| #define SPECENUM_VALUE6NAME "Continent" |
Definition at line 52 of file requirements.h.
| #define SPECENUM_VALUE7 REQ_RANGE_PLAYER |
Definition at line 53 of file requirements.h.
| #define SPECENUM_VALUE7NAME "Player" |
Definition at line 54 of file requirements.h.
| #define SPECENUM_VALUE8 REQ_RANGE_TEAM |
Definition at line 55 of file requirements.h.
| #define SPECENUM_VALUE8NAME "Team" |
Definition at line 56 of file requirements.h.
| #define SPECENUM_VALUE9 REQ_RANGE_ALLIANCE |
Definition at line 57 of file requirements.h.
| #define SPECENUM_VALUE9NAME "Alliance" |
Definition at line 58 of file requirements.h.
| #define SPECVEC_TAG requirement |
Definition at line 89 of file requirements.h.
| #define SPECVEC_TYPE struct requirement |
Definition at line 90 of file requirements.h.
| #define universal_is_mentioned_by_requirement | ( | preq, | |
| psource | |||
| ) | are_universals_equal(&preq->source, psource) |
Definition at line 371 of file requirements.h.
Definition at line 396 of file requirements.h.
| #define universals_iterate_end |
Definition at line 401 of file requirements.h.
| typedef enum fc_tristate(* req_tester_cb) (const struct req_context *context, const struct player *other_player, const struct requirement *req, void *data, int n_data) |
Definition at line 185 of file requirements.h.
| typedef enum req_unchanging_status(* req_unchanging_cond_cb) (const struct civ_map *nmap, enum req_unchanging_status def, const struct req_context *context, const struct requirement *req) |
Definition at line 1 of file requirements.h.
req_vec_num_in_item a requirement vectors number in an item.
A ruleset item can have more than one requirement vector. This numbers them. Allows applying a change suggested based on one ruleset item to another ruleset item of the same kind - say to a copy.
Definition at line 237 of file requirements.h.
| typedef struct requirement_vector *(* requirement_vector_by_number) (const void *parent_item, req_vec_num_in_item number) |
Returns a writable pointer to the specified requirement vector in the specified parent item or NULL if the parent item doesn't have a requirement vector with that requirement vector number.
| parent_item | the item that should have the requirement vector. |
| number | the item's requirement vector number. |
Definition at line 247 of file requirements.h.
| typedef const char *(* requirement_vector_namer) (req_vec_num_in_item number) |
Returns the name of the specified requirement vector number in the parent item or NULL if parent items of the kind this function is for don't have a requirement vector with that number.
| number | the requirement vector to name |
Definition at line 270 of file requirements.h.
| typedef req_vec_num_in_item(* requirement_vector_number) (const void *parent_item, const struct requirement_vector *vec) |
Returns the requirement vector number of the specified requirement vector in the specified parent item or -1 if the vector doesn't belong to the parent item.
| parent_item | the item that may own the vector. |
| vec | the requirement vector to number. |
Definition at line 247 of file requirements.h.
| Enumerator | |
|---|---|
| ITF_NO | |
| ITF_YES | |
| ITF_NOT_APPLICABLE | |
Definition at line 378 of file requirements.h.
| Enumerator | |
|---|---|
| REQUCH_NO | |
| REQUCH_CTRL | |
| REQUCH_ACT | |
| REQUCH_SCRIPTS | |
| REQUCH_HACK | |
| REQUCH_YES | |
Definition at line 116 of file requirements.h.
| bool are_reqs_active | ( | const struct req_context * | context, |
| const struct player * | other_player, | ||
| const struct requirement_vector * | reqs, | ||
| const enum req_problem_type | prob_type | ||
| ) |
Checks the requirement(s) to see if they are active on the given target.
context gives the target (or targets) to evaluate against
reqs gives the requirement vector. The function returns TRUE only if all requirements are active.
context may be NULL. This is equivalent to passing an empty context.
Make sure you give all aspects of the target when calling this function: for instance if you have TARGET_CITY pass the city's owner as the target player as well as the city itself as the target city.
Definition at line 5523 of file requirements.c.
Referenced by action_auto_perf_unit_sel(), add_clause(), are_road_reqs_fulfilled(), can_build_base(), can_build_extra(), can_change_to_government(), can_city_build_improvement_direct(), can_disaster_happen(), can_extra_appear(), can_extra_disappear(), can_remove_extra(), can_unit_do_connect(), city_can_use_specialist(), city_style(), get_target_bonus_effects(), get_tile_infrastructure_set(), get_tile_value(), goods_can_be_provided(), handle_diplomacy_accept_treaty_req(), is_enabler_active(), is_native_tile_to_extra(), is_native_tile_to_road(), is_target_possible(), multiplier_can_be_changed(), player_can_build_base(), player_can_build_extra(), player_can_remove_extra(), player_music_style(), sg_special_set_bv(), sg_special_set_dbv(), unit_can_displace_hut(), unit_can_enter_hut(), and unit_enter_hut().
| bool are_reqs_active_ranges | ( | const enum req_range | min_range, |
| const enum req_range | max_range, | ||
| const struct req_context * | context, | ||
| const struct player * | other_player, | ||
| const struct requirement_vector * | reqs, | ||
| const enum req_problem_type | prob_type | ||
| ) |
Like are_reqs_active() but checks only requirements that have one of the ranges between min_range and max_range.
Definition at line 5541 of file requirements.c.
Referenced by can_city_build_unit_direct().
| bool are_requirements_contradictions | ( | const struct requirement * | req1, |
| const struct requirement * | req2 | ||
| ) |
Returns TRUE if req1 and req2 contradicts each other.
TODO: If information about what entity each requirement type will be evaluated against is passed it will become possible to detect stuff like that an unclaimed tile contradicts all DiplRel requirements against it.
Definition at line 1676 of file requirements.c.
Referenced by default_tester_cb(), does_req_contradicts_reqs(), req_implies_req(), req_vec_first_contradiction_in_vec(), and req_vec_get_first_contradiction().
| bool are_requirements_equal | ( | const struct requirement * | req1, |
| const struct requirement * | req2 | ||
| ) |
Returns TRUE if req1 and req2 are equal. Does not care if one is quiet and the other not.
Definition at line 1458 of file requirements.c.
Referenced by req_edit::incoming_req_vec_change(), is_req_in_vec(), purge_duplicate_req_vec(), req_vec_change_apply(), req_vec_get_first_redundant_req(), send_packet_ruleset_action_auto_100(), send_packet_ruleset_action_enabler_100(), send_packet_ruleset_building_100(), send_packet_ruleset_city_100(), send_packet_ruleset_clause_100(), send_packet_ruleset_disaster_100(), send_packet_ruleset_effect_100(), send_packet_ruleset_extra_100(), send_packet_ruleset_goods_100(), send_packet_ruleset_government_100(), send_packet_ruleset_multiplier_100(), send_packet_ruleset_music_100(), send_packet_ruleset_road_100(), send_packet_ruleset_specialist_100(), send_packet_ruleset_tech_100(), and send_packet_ruleset_unit_100().
Return TRUE iff the two sources are equivalent. Note this isn't the same as an == or memcmp check.
Definition at line 6485 of file requirements.c.
Referenced by add_target_to_production(), add_target_to_worklist(), are_requirements_equal(), are_requirements_opposites(), are_worklists_equal(), change_build_target(), city_building_impr_or_unit(), city_dialog_update_building(), city_set_queue(), city_worklist_commit(), client_change_all(), clipboard_send_production_packet(), handle_city_change(), handle_city_info(), insert_allows_single(), ok_worklist_editor_callback(), and ruledit_gui::open_effect_edit().
| enum fc_tristate default_tester_cb | ( | const struct req_context * | context, |
| const struct player * | other_player, | ||
| const struct requirement * | req, | ||
| void * | data, | ||
| int | n_data | ||
| ) |
A tester callback for tri_reqs_cb_active() that uses the default requirement calculation except for requirements in data[n_data] array and ones implied by them or contradicting them
Definition at line 5690 of file requirements.c.
| bool does_req_contradicts_reqs | ( | const struct requirement * | req, |
| const struct requirement_vector * | vec | ||
| ) |
Returns TRUE if the given requirement contradicts the given requirement vector.
Definition at line 1859 of file requirements.c.
Referenced by ae_suggest_repair_if_no_oblig(), city_production_caravan_shields_init(), local_dipl_rel_action_cache_set(), local_dipl_rel_tile_other_tgt_action_cache_set(), and utype_may_act_tgt_city_tile().
| bool is_req_active | ( | const struct req_context * | context, |
| const struct player * | other_player, | ||
| const struct requirement * | req, | ||
| const enum req_problem_type | prob_type | ||
| ) |
Checks the requirement to see if it is active on the given target.
context gives the target (or targets) to evaluate against req gives the requirement itself
context may be NULL. This is equivalent to passing an empty context.
Make sure you give all aspects of the target when calling this function: for instance if you have TARGET_CITY pass the city's owner as the target player as well as the city itself as the target city.
Definition at line 5434 of file requirements.c.
Referenced by adjust_improvement_wants_by_effects(), adjust_wants_for_reqs(), adv_units_ruleset_init(), are_reqs_active(), are_reqs_active_ranges(), can_player_build_improvement_direct(), can_player_build_unit_direct(), city_landlocked_sell_coastal_improvements(), dai_cant_help_req(), dai_find_source_building(), dai_gov_value(), dai_tech_effect_values(), dai_wants_defender_against(), get_potential_improvement_bonus(), improvement_obsolete(), is_effect_prevented(), is_req_preventing(), mke_eval_req(), utype_needs_improvement(), and worklist_item_postpone_req_vec().
| bool is_req_in_vec | ( | const struct requirement * | req, |
| const struct requirement_vector * | vec | ||
| ) |
Returns TRUE iff the requirement vector vec contains the requirement req.
Definition at line 5843 of file requirements.c.
Referenced by tgt_citytile_act_cache_set(), and unit_state_action_cache_set().
| enum req_unchanging_status is_req_preventing | ( | const struct req_context * | context, |
| const struct player * | other_player, | ||
| const struct requirement * | req, | ||
| enum req_problem_type | prob_type | ||
| ) |
Returns whether this requirement is unfulfilled and probably won't be ever
Definition at line 5814 of file requirements.c.
Referenced by can_city_build_improvement_later(), can_player_build_improvement_later(), dai_cant_help_req(), reqs_may_activate(), and tactical_req_cb().
| enum req_unchanging_status is_req_unchanging | ( | const struct req_context * | context, |
| const struct requirement * | req | ||
| ) |
Gives a suggestion may req ever evaluate to another value with given context. (The other player is not supplied since it has no value for changeability of any requirement for now.)
Note this isn't absolute. Result other than REQUCH_NO here just means that the requirement probably can't change its value afterwards.
Definition at line 5766 of file requirements.c.
Referenced by is_req_preventing(), and sanity_check_ruleset_data().
| const struct req_context * req_context_empty | ( | void | ) |
Returns a pointer to a statically-allocated, empty requirement context.
Definition at line 1005 of file requirements.c.
Referenced by action_enabled_local(), action_hard_reqs_actor(), action_prob(), get_effect_expected_value(), get_target_bonus_effects(), is_action_possible(), is_req_knowable(), and tri_req_present().
| void req_copy | ( | struct requirement * | dst, |
| const struct requirement * | src | ||
| ) |
Fill in copy of the requirement.
Definition at line 1445 of file requirements.c.
Referenced by can_player_build_unit_direct(), req_implies_req(), and unchanging_noally().
| struct requirement req_from_str | ( | const char * | type, |
| const char * | range, | ||
| bool | survives, | ||
| bool | present, | ||
| bool | quiet, | ||
| const char * | value | ||
| ) |
Parse a requirement type and value string into a requirement structure. Returns the invalid element for enum universal_n on error. Passing in a NULL type is considered VUT_NONE (not an error).
Pass this some values like "Building", "Factory".
Definition at line 1042 of file requirements.c.
Referenced by effect_edit::add_now(), effect_list_compat_cb(), load_ruleset_cities(), lookup_req_list(), rscompat_action_enabler_adjust_3_2(), rscompat_extra_adjust_3_2(), rscompat_postprocess(), and rscompat_terrain_extra_rmtime_3_2().
| struct requirement req_from_values | ( | int | type, |
| int | range, | ||
| bool | survives, | ||
| bool | present, | ||
| bool | quiet, | ||
| int | value | ||
| ) |
Set the values of a req from serializable integers. This is the opposite of req_get_values.
Definition at line 1411 of file requirements.c.
Referenced by req_edit::add_now(), dio_get_requirement_raw(), hard_code_oblig_hard_reqs(), hard_code_oblig_hard_reqs_ruleset(), load_action_auto_uflag_block(), load_action_post_success_force(), load_ruleset_units(), and send_ruleset_techs().
| void req_get_values | ( | const struct requirement * | req, |
| int * | type, | ||
| int * | range, | ||
| bool * | survives, | ||
| bool * | present, | ||
| bool * | quiet, | ||
| int * | value | ||
| ) |
Return the value of a req as a serializable integer. This is the opposite of req_set_value.
Definition at line 1430 of file requirements.c.
Referenced by dio_put_requirement_raw().
| bool req_implies_req | ( | const struct requirement * | req1, |
| const struct requirement * | req2 | ||
| ) |
Returns TRUE if req2 is always fulfilled when req1 is (i.e. req1 => req2)
Definition at line 1659 of file requirements.c.
Referenced by default_tester_cb().
| bool req_is_impossible_to_fulfill | ( | const struct requirement * | req | ) |
Returns TRUE iff the specified requirement is known to be impossible to fulfill. Note that this function may return FALSE even when it is impossible to fulfill a requirement if it can't detect it.
| req | the requirement to check the possibility of. |
Definition at line 5963 of file requirements.c.
Referenced by req_vec_is_impossible_to_fulfill().
Returns the given requirement as a formatted string ready for printing. Does not care about the 'quiet' property.
astring does not need to be initialized before the call, but caller needs to call astr_free() for it once the returned string is no longer needed.
Definition at line 1020 of file requirements.c.
Referenced by effect_list_sanity_cb(), enabler_first_self_contradiction(), enabler_tile_tgt_local_diplrel_implies_claimed(), req_vec_change_translation(), req_vec_get_first_contradiction(), req_vec_get_first_missing_univ(), req_vec_get_first_redundant_req(), sanity_check_ruleset_data(), and save_action_auto_uflag_block().
| struct requirement_vector * req_vec_by_number | ( | const void * | parent_item, |
| req_vec_num_in_item | number | ||
| ) |
Returns a writable pointer to the specified requirement vector in the specified requirement vector or NULL if the parent item doesn't have a requirement vector with that requirement vector number.
| parent_item | the item that should have the requirement vector. |
| number | the item's requirement vector number. |
Definition at line 6015 of file requirements.c.
Referenced by purge_duplicate_req_vec(), and purge_unused_req_vec().
| bool req_vec_change_apply | ( | const struct req_vec_change * | modification, |
| requirement_vector_by_number | getter, | ||
| const void * | parent_item | ||
| ) |
Returns TRUE iff the specified requirement vector modification was successfully applied to the specified target requirement vector.
| modification | the requirement vector change |
| getter | a function that returns a pointer to the requirement vector the change should be applied to given a ruleset item and the vectors number in the item. |
| parent_item | the item to apply the change to. |
Definition at line 6104 of file requirements.c.
Referenced by req_vec_fix::apply_solution(), purge_duplicate_req_vec(), purge_unused_req_vec(), and rscompat_enabler_add_obligatory_hard_reqs().
| const char * req_vec_change_translation | ( | const struct req_vec_change * | change, |
| const requirement_vector_namer | namer | ||
| ) |
Returns the specified requirement vector change as a translated string ready for use in the user interface. N.B.: The returned string is static, so every call to this function overwrites the previous.
| change | the requirement vector change |
| namer | a function that returns a description of the vector to change for the item the vector belongs to. |
Definition at line 6031 of file requirements.c.
Referenced by req_vec_fix::apply_solution(), req_vec_fix_problem::req_vec_fix_problem(), and rscompat_enabler_add_obligatory_hard_reqs().
| struct req_vec_problem * req_vec_get_first_contradiction | ( | const struct requirement_vector * | vec, |
| requirement_vector_number | get_num, | ||
| const void * | parent_item | ||
| ) |
Returns the first self contradiction found in the specified requirement vector with suggested solutions or NULL if no contradiction was found. It is the responsibility of the caller to free the suggestion when it is done with it.
| vec | the requirement vector to look in. |
| get_num | function that returns the requirement vector's number in the parent item. |
| parent_item | the item that owns the vector. |
Definition at line 6221 of file requirements.c.
Referenced by req_vec_suggest_repair().
| struct req_vec_problem * req_vec_get_first_missing_univ | ( | const struct requirement_vector * | vec, |
| requirement_vector_number | get_num, | ||
| const void * | parent_item | ||
| ) |
Returns the first universal known to always be absent in the specified requirement vector with suggested solutions or NULL if no missing universals were found. It is the responsibility of the caller to free the suggestion when it is done with it.
| vec | the requirement vector to look in. |
| get_num | function that returns the requirement vector's number in the parent item. |
| parent_item | the item that owns the vector. |
Definition at line 6307 of file requirements.c.
Referenced by purge_unused_req_vec(), and req_vec_suggest_improvement().
| struct req_vec_problem * req_vec_get_first_redundant_req | ( | const struct requirement_vector * | vec, |
| requirement_vector_number | get_num, | ||
| const void * | parent_item | ||
| ) |
Returns the first redundant requirement in the specified requirement vector with suggested solutions or NULL if no redundant requirements were found. It is the responsibility of the caller to free the suggestion when it is done with it.
| vec | the requirement vector to look in. |
| get_num | function that returns the requirement vector's number in the parent item. |
| parent_item | the item that owns the vector. |
Definition at line 6392 of file requirements.c.
Referenced by purge_duplicate_req_vec(), and req_vec_suggest_improvement().
| bool req_vec_is_impossible_to_fulfill | ( | const struct requirement_vector * | reqs | ) |
Returns TRUE iff the specified requirement vector is known to be impossible to fulfill. Note that this function may return FALSE even when it is impossible to fulfill a requirement if it can't detect it.
| reqs | the requirement vector to check the possibility of. |
Definition at line 5976 of file requirements.c.
Referenced by action_enabler_utype_possible_actor(), ruleset_purge_unused_effects(), and ruleset_purge_unused_enablers().
| void req_vec_problem_free | ( | struct req_vec_problem * | issue | ) |
De-allocates resources associated with the given requirement vector problem.
| issue | the no longer needed problem. |
Definition at line 6201 of file requirements.c.
Referenced by enabler_problem_level(), purge_duplicate_req_vec(), purge_unused_req_vec(), req_vec_fix::refresh(), req_vec_get_first_missing_univ(), rscompat_enabler_add_obligatory_hard_reqs(), sanity_check_req_vec(), sanity_check_ruleset_data(), and req_vec_fix::~req_vec_fix().
| struct req_vec_problem * req_vec_problem_new | ( | int | num_suggested_solutions, |
| const char * | descr, | ||
| ... | |||
| ) |
Returns a new requirement vector problem with the specified number of suggested solutions and the specified description. The suggestions are added by the caller.
| num_suggested_solutions | the number of suggested solutions. |
| descr | the description of the problem as a format string |
Definition at line 6176 of file requirements.c.
Referenced by action_enabler_suggest_improvement(), ae_suggest_repair_if_no_oblig(), enabler_first_self_contradiction(), enabler_tile_tgt_local_diplrel_implies_claimed(), req_vec_get_first_contradiction(), req_vec_get_first_missing_univ(), and req_vec_get_first_redundant_req().
| struct req_vec_problem * req_vec_problem_new_transl | ( | int | num_suggested_solutions, |
| const char * | description, | ||
| const char * | description_translated | ||
| ) |
Returns a new requirement vector problem with the specified number of suggested solutions and the specified description. The suggestions are added by the caller.
| num_suggested_solutions | the number of suggested solutions. |
| description | the description of the problem. |
| description_translated | the translated description of the problem. |
Definition at line 6142 of file requirements.c.
Referenced by req_vec_problem_new().
| struct req_vec_problem * req_vec_suggest_improvement | ( | const struct requirement_vector * | vec, |
| requirement_vector_number | get_num, | ||
| const void * | parent_item | ||
| ) |
Returns a suggestion to improve the specified requirement vector or NULL if nothing to improve is found. It is the responsibility of the caller to free the suggestion when it is done with it. A possible improvement isn't always an error.
| vec | the requirement vector to look in. |
| get_num | function that returns the requirement vector's number in the parent item. |
| parent_item | the item that owns the vector. |
Definition at line 6458 of file requirements.c.
Referenced by action_enabler_suggest_improvement().
| struct req_vec_problem * req_vec_suggest_repair | ( | const struct requirement_vector * | vec, |
| requirement_vector_number | get_num, | ||
| const void * | parent_item | ||
| ) |
Returns a suggestion to fix the specified requirement vector or NULL if no fix is found to be needed. It is the responsibility of the caller to free the suggestion when it is done with it.
| vec | the requirement vector to look in. |
| get_num | function that returns the requirement vector's number in the parent item. |
| parent_item | the item that owns the vector. |
Definition at line 6286 of file requirements.c.
Referenced by action_enabler_suggest_repair(), req_vec_suggest_improvement(), and sanity_check_req_vec().
| req_vec_num_in_item req_vec_vector_number | ( | const void * | parent_item, |
| const struct requirement_vector * | vec | ||
| ) |
Returns the requirement vector number of the specified requirement vector in the specified requirement vector.
| parent_item | the item that may own the vector. |
| vec | the requirement vector to number. |
Definition at line 5996 of file requirements.c.
Referenced by purge_duplicate_req_vec(), purge_unused_req_vec(), and sanity_check_req_vec().
| bool req_vec_wants_type | ( | const struct requirement_vector * | reqs, |
| enum universals_n | kind | ||
| ) |
Returns TRUE iff the specified requirement vector has a positive requirement of the specified requirement type.
| reqs | the requirement vector to look in |
| kind | the requirement type to look for |
Definition at line 5861 of file requirements.c.
Referenced by city_production_caravan_shields_init().
| int requirement_kind_ereq | ( | const int | value, |
| const enum req_range | range, | ||
| const bool | present, | ||
| const int | max_value | ||
| ) |
Returns (the position of) the given requirement's enumerator in the enumeration of all possible requirements of its requirement kind.
Note: Since this isn't used for any requirement type that supports surviving requirements those aren't supported. Add support if a user appears.
Definition at line 7718 of file requirements.c.
| enum fc_tristate tri_req_active | ( | const struct req_context * | context, |
| const struct player * | other_player, | ||
| const struct requirement * | req | ||
| ) |
Evaluates req in context with other_player to fc_tristate.
context may be NULL. This is equivalent to passing an empty context.
Fields of context that are NULL are considered unspecified and will produce TRI_MAYBE if req needs them to evaluate.
Definition at line 5490 of file requirements.c.
Referenced by default_tester_cb(), tactical_req_cb(), and tri_req_active_turns().
| enum fc_tristate tri_req_active_turns | ( | int | pass, |
| int | period, | ||
| const struct req_context * | context, | ||
| const struct player * | other_player, | ||
| const struct requirement * | req | ||
| ) |
For requirements changing with time, will they be active for the target after pass in period turns if nothing else changes? Since year and calfrag changing is effect dependent, the result may appear not precise. (Does not consider research progress etc.)
Definition at line 5566 of file requirements.c.
Referenced by tactical_req_cb().
| enum fc_tristate tri_reqs_cb_active | ( | const struct req_context * | context, |
| const struct player * | other_player, | ||
| const struct requirement_vector * | reqs, | ||
| struct requirement_vector * | maybe_reqs, | ||
| req_tester_cb | tester, | ||
| void * | data, | ||
| int | n_data | ||
| ) |
Test requirements in reqs with tester according to (data, n_data) and give the resulting tristate. If maybe_reqs is not NULL, copies requirements that are evaluated to TRI_MAYBE into it (stops as soon as one evaluates to TRI_NO).
Definition at line 5719 of file requirements.c.
Referenced by action_may_happen_unit_on_city().
Return the number of shields it takes to build this universal.
Definition at line 7141 of file requirements.c.
Referenced by city_production_build_shield_cost(), city_turns_to_build(), get_city_dialog_production_full(), and get_production_name().
Combine values into a universal structure. This is for serialization and is the opposite of universal_extraction(). FIXME: ensure that every caller checks error return!
Definition at line 624 of file requirements.c.
Referenced by dio_get_worklist_raw(), handle_city_change(), handle_city_info(), and req_from_values().
Parse requirement type (kind) and value strings into a universal structure. Passing in a NULL type is considered VUT_NONE (not an error).
Pass this some values like "Building", "Factory". FIXME: ensure that every caller checks error return!
Definition at line 238 of file requirements.c.
Referenced by global_worklists_build(), req_from_str(), sg_load_player_city(), sg_load_player_city(), worklist_load(), and worklist_load().
Extract universal structure into its components for serialization; the opposite of universal_by_number().
Definition at line 866 of file requirements.c.
Referenced by get_req_source_effects(), req_get_values(), help_widget::set_topic_building(), and universal_value_cb().
Initialise universal_found_function array.
Definition at line 7688 of file requirements.c.
Referenced by game_init().
| enum req_item_found universal_fulfills_requirement | ( | const struct requirement * | preq, |
| const struct universal * | source | ||
| ) |
Will the universal 'source' fulfill this requirement?
Definition at line 7273 of file requirements.c.
Referenced by adjust_improvement_wants_by_effects(), effect_value_from_universals(), present_implies_not_present(), universal_is_relevant_to_requirement(), and universals_say_everything().
| bool universal_fulfills_requirements | ( | bool | check_necessary, |
| const struct requirement_vector * | reqs, | ||
| const struct universal * | source | ||
| ) |
Will the universal 'source' fulfill the requirements in the list? If 'check_necessary' is FALSE: are there no requirements that 'source' would actively prevent the fulfilment of? If 'check_necessary' is TRUE: does 'source' help the requirements to be fulfilled? (NB 'source' might not be the only source of its type that would be sufficient; for instance, if 'source' is a specific terrain type, we can return TRUE even if the requirement is only for something vague like a TerrainClass.)
Definition at line 7294 of file requirements.c.
Referenced by action_enabler_utype_possible_actor(), action_univs_not_blocking(), help_widget::add_extras_of_act_for_terrain(), effect_cumulative_min(), helptext_building(), and universals_mean_unfulfilled().
Returns TRUE iff the specified universal legally can appear in a requirement.
Definition at line 269 of file requirements.c.
Referenced by universal_kind_values().
| bool universal_is_mentioned_by_requirements | ( | const struct requirement_vector * | reqs, |
| const struct universal * | psource | ||
| ) |
Returns TRUE iff the universal 'psource' is directly mentioned by any of the requirements in 'reqs'.
Definition at line 7181 of file requirements.c.
Referenced by effect_list_fill_cb(), effect_list_universal_needed_cb(), and is_universal_needed().
| bool universal_is_relevant_to_requirement | ( | const struct requirement * | req, |
| const struct universal * | source | ||
| ) |
Returns TRUE iff the specified universal is relevant to fulfilling the specified requirement.
Definition at line 7331 of file requirements.c.
Referenced by helptext_building().
| const char * universal_name_translation | ( | const struct universal * | psource, |
| char * | buf, | ||
| size_t | bufsz | ||
| ) |
Make user-friendly text for the source. The text is put into a user buffer which is also returned. This should be short, as it's used in lists like "Aqueduct+Size 8" when explaining a calculated value. It just needs to be enough to remind the player of rules they already know, not a complete explanation (use insert_requirement() for that).
Definition at line 6776 of file requirements.c.
Referenced by apply_disaster(), city_production_name_translation(), clipboard_copy_production(), diplomat_sabotage(), do_unit_strike_city_production(), get_city_dialog_production_full(), get_city_dialog_production_row(), get_city_mapview_production(), get_effect_req_text(), help_update_improvement(), help_update_wonder(), insert_allows_single(), manual_improvements(), popup_impr_info(), req_edit::refresh_item(), req_text_insert(), and help_widget::set_topic_building().
Returns TRUE iff the specified universal is known to never be there. Note that this function may return FALSE even when it is impossible for the universal to appear in the game if that can't be detected.
| source | the universal to check the absence of. |
Definition at line 5880 of file requirements.c.
Referenced by ae_suggest_repair_if_no_oblig(), req_is_impossible_to_fulfill(), and req_vec_get_first_missing_univ().
Return the universal number of the constituent.
Definition at line 876 of file requirements.c.
Referenced by city_change_production(), clipboard_send_production_packet(), dio_put_worklist_raw(), package_city(), and universal_extraction().
| bool universal_replace_in_req_vec | ( | struct requirement_vector * | reqs, |
| const struct universal * | to_replace, | ||
| const struct universal * | replacement | ||
| ) |
Replaces all instances of the universal to_replace with replacement in the requirement vector reqs and returns TRUE iff any requirements were replaced.
Definition at line 7161 of file requirements.c.
Return the (untranslated) rule name of the universal. You don't have to free the return pointer.
Definition at line 6617 of file requirements.c.
Referenced by effect_edit::add_now(), define_orig_production_values(), effect_list_sanity_cb(), global_worklist_save(), global_worklists_unbuild(), req_to_fstring(), req_vec_get_first_missing_univ(), save_reqs_vector(), sg_save_player_cities(), and worklist_save().
Return untranslated name of the universal source name.
Definition at line 7133 of file requirements.c.
Referenced by effect_edit::add_now(), global_worklist_save(), global_worklists_unbuild(), req_to_fstring(), sanity_check_req_set(), sg_save_player_cities(), universal_fulfills_requirement(), universal_fulfills_requirements(), and worklist_save().
Parse requirement value strings into a universal structure.
Definition at line 282 of file requirements.c.
Referenced by req_edit::univ_value_edit(), req_edit::univ_value_enum_menu(), and universal_by_rule_name().
| bool universals_mean_unfulfilled | ( | struct requirement_vector * | reqs, |
| struct universal * | unis, | ||
| size_t | n_unis | ||
| ) |
Returns TRUE iff the presence of any of the specified universals is enough to guarantee that the specified requirement vector never will be fulfilled.
| reqs | the requirement vector that never should be fulfilled |
| unis | the universals that are present |
| n_unis | the number of universals in unis |
Definition at line 7203 of file requirements.c.
Referenced by effect_cumulative_max(), and effect_universals_value_never_below().
| bool universals_say_everything | ( | struct requirement_vector * | reqs, |
| struct universal * | unis, | ||
| size_t | n_unis | ||
| ) |
Returns TRUE iff the presence of the specified universals is enough to know if the specified requirement vector is fulfilled. This means that the requirement vector can't check anything it can't find in the listed universals. Note that TRUE is returned both when the requirement vector is known to be fulfilled and when it is known to be unfulfilled.
| reqs | the requirement vector certainty is wanted about |
| unis | the universals that are present |
| n_unis | the number of universals in unis |
Definition at line 7236 of file requirements.c.
Referenced by effect_universals_value_never_below().
1.9.8