traderoutes.c

Go to the documentation of this file.

/****************************************************************************
 Freeciv - Copyright (C) 2004 - The Freeciv Team
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
   the Free Software Foundation; either version 2, or (at your option)
   any later version.
 
   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.
****************************************************************************/
 
#ifdef HAVE_CONFIG_H
#include <fc_config.h>
#endif
 
/* utility */
#include "log.h"
#include "rand.h"
 
/* common */
#include "city.h"
#include "effects.h"
#include "game.h"
#include "map.h"
#include "tile.h"
#include "unittype.h"
 
#include "traderoutes.h"
 
const char *trade_route_type_names[] = {
  "National", "NationalIC", "IN", "INIC", "Ally", "AllyIC",
  "Enemy", "EnemyIC", "Team", "TeamIC"
};
 
const char *trade_route_cancelling_type_names[] = {
  "Active", "Inactive", "Cancel"
};
 
struct trade_route_settings trtss[TRT_LAST];
 
static struct goods_type goods[MAX_GOODS_TYPES];
 
/*********************************************************************/
unsigned max_trade_routes(const struct city *pcity)
{
  int eft = get_city_bonus(pcity, EFT_MAX_TRADE_ROUTES);
 
  return CLIP(0, eft, MAX_TRADE_ROUTES);
}
 
/*********************************************************************/
enum trade_route_type cities_trade_route_type(const struct city *pcity1,
                                              const struct city *pcity2)
{
  struct player *plr1 = city_owner(pcity1);
  struct player *plr2 = city_owner(pcity2);
 
  if (plr1 != plr2) {
    struct player_diplstate *ds = player_diplstate_get(plr1, plr2);
 
    if (city_tile(pcity1)->continent != city_tile(pcity2)->continent) {
      switch (ds->type) {
      case DS_ALLIANCE:
        return TRT_ALLY_IC;
      case DS_WAR:
        return TRT_ENEMY_IC;
      case DS_TEAM:
        return TRT_TEAM_IC;
      case DS_ARMISTICE:
      case DS_CEASEFIRE:
      case DS_PEACE:
      case DS_NO_CONTACT:
        return TRT_IN_IC;
      case DS_LAST:
        fc_assert(ds->type != DS_LAST);
        return TRT_IN_IC;
      }
      fc_assert(FALSE);
 
      return TRT_IN_IC;
    } else {
      switch (ds->type) {
      case DS_ALLIANCE:
        return TRT_ALLY;
      case DS_WAR:
        return TRT_ENEMY;
      case DS_TEAM:
        return TRT_TEAM;
      case DS_ARMISTICE:
      case DS_CEASEFIRE:
      case DS_PEACE:
      case DS_NO_CONTACT:
        return TRT_IN;
      case DS_LAST:
        fc_assert(ds->type != DS_LAST);
        return TRT_IN;
      }
      fc_assert(FALSE);
 
      return TRT_IN;
    }
  } else {
    if (city_tile(pcity1)->continent != city_tile(pcity2)->continent) {
      return TRT_NATIONAL_IC;
    } else {
      return TRT_NATIONAL;
    }
  }
 
  return TRT_LAST;
}
 
/*********************************************************************/
int trade_route_type_trade_pct(enum trade_route_type type)
{
  if (type >= TRT_LAST) {
    return 0;
  }
 
  return trtss[type].trade_pct;
}
 
/*********************************************************************/
void trade_route_types_init(void)
{
  enum trade_route_type type;
 
  for (type = TRT_NATIONAL; type < TRT_LAST; type++) {
    struct trade_route_settings *set = trade_route_settings_by_type(type);
 
    set->trade_pct = 100;
  }
}
 
/*********************************************************************/
const char *trade_route_type_name(enum trade_route_type type)
{
  fc_assert_ret_val(type >= TRT_NATIONAL && type < TRT_LAST, NULL);
 
  return trade_route_type_names[type];
}
 
/*********************************************************************/
enum trade_route_type trade_route_type_by_name(const char *name)
{
  enum trade_route_type type;
 
  for (type = TRT_NATIONAL; type < TRT_LAST; type++) {
    if (!fc_strcasecmp(trade_route_type_names[type], name)) {
      return type;
    }
  }
 
  return TRT_LAST;
}
 
/*********************************************************************/
const char *trade_route_cancelling_type_name(enum trade_route_illegal_cancelling type)
{
  fc_assert_ret_val(type >= TRI_ACTIVE && type < TRI_LAST, NULL);
 
  return trade_route_cancelling_type_names[type];
}
 
/*********************************************************************/
enum trade_route_illegal_cancelling trade_route_cancelling_type_by_name(const char *name)
{
  enum trade_route_illegal_cancelling type;
 
  for (type = TRI_ACTIVE; type < TRI_LAST; type++) {
    if (!fc_strcasecmp(trade_route_cancelling_type_names[type], name)) {
      return type;
    }
  }
 
  return TRI_LAST;
}
 
/*********************************************************************/
struct trade_route_settings *
trade_route_settings_by_type(enum trade_route_type type)
{
  fc_assert_ret_val(type >= TRT_NATIONAL && type < TRT_LAST, NULL);
 
  return &trtss[type];
}
 
/*********************************************************************/
bool can_cities_trade(const struct city *pc1, const struct city *pc2)
{
  /* If you change the logic here, make sure to update the help in
   * helptext_unit(). */
  return (pc1 && pc2 && pc1 != pc2
          && (city_owner(pc1) != city_owner(pc2)
              || map_distance(pc1->tile, pc2->tile)
                 >= game.info.trademindist)
          && (trade_route_type_trade_pct(cities_trade_route_type(pc1, pc2))
              > 0));
}
 
/*********************************************************************/
int city_trade_removable(const struct city *pcity,
                         struct trade_route_list *would_remove)
{
  struct trade_route *sorted[MAX_TRADE_ROUTES];
  int num, i, j;
 
  /* Sort trade route values. */
  num = 0;
  trade_routes_iterate(pcity, proute) {
    for (j = num; j > 0 && (proute->value < sorted[j - 1]->value) ; j--) {
      sorted[j] = sorted[j - 1];
    }
    sorted[j] = proute;
    num++;
  } trade_routes_iterate_end;
 
  /* No trade routes at all. */
  if (0 == num) {
    return 0;
  }
 
  /* Adjust number of concerned trade routes. */
  num += 1 - max_trade_routes(pcity);
  if (0 >= num) {
    num = 1;
  }
 
  /* Return values. */
  for (i = j = 0; i < num; i++) {
    j += sorted[i]->value;
    if (NULL != would_remove) {
      trade_route_list_append(would_remove, sorted[i]);
    }
  }
 
  return j;
}
 
/*********************************************************************/
bool can_establish_trade_route(const struct city *pc1, const struct city *pc2)
{
  int trade = -1;
  int maxpc1;
  int maxpc2;
 
  if (!pc1 || !pc2 || pc1 == pc2
      || !can_cities_trade(pc1, pc2)
      || have_cities_trade_route(pc1, pc2)) {
    return FALSE;
  }
 
  /* First check if cities can have trade routes at all. */
  maxpc1 = max_trade_routes(pc1);
  if (maxpc1 <= 0) {
    return FALSE;
  }
  maxpc2 = max_trade_routes(pc2);
  if (maxpc2 <= 0) {
    return FALSE;
  }
    
  if (city_num_trade_routes(pc1) >= maxpc1) {
    trade = trade_base_between_cities(pc1, pc2);
    /* can we replace trade route? */
    if (city_trade_removable(pc1, NULL) >= trade) {
      return FALSE;
    }
  }
  
  if (city_num_trade_routes(pc2) >= maxpc2) {
    if (trade == -1) {
      trade = trade_base_between_cities(pc1, pc2);
    }
    /* can we replace trade route? */
    if (city_trade_removable(pc2, NULL) >= trade) {
      return FALSE;
    }
  }  
 
  return TRUE;
}
 
/*********************************************************************/
int trade_base_between_cities(const struct city *pc1, const struct city *pc2)
{
  int bonus = 0;
 
  if (NULL == pc1 || NULL == pc1->tile || NULL == pc2 || NULL == pc2->tile) {
    return 0;
  }
 
  if (game.info.trade_revenue_style == TRS_CLASSIC) {
    /* Classic Freeciv */
    int real_dist = real_map_distance(pc1->tile, pc2->tile);
    int weighted_distance
      = ((100 - game.info.trade_world_rel_pct) * real_dist
         + game.info.trade_world_rel_pct
         * (real_dist * 40 / MAX(wld.map.xsize, wld.map.ysize))) / 100;
 
    bonus = weighted_distance
            + city_size_get(pc1) + city_size_get(pc2);
  } else if (game.info.trade_revenue_style == TRS_SIMPLE) {
    /* Simple revenue style */
    bonus = (pc1->citizen_base[O_TRADE] + pc2->citizen_base[O_TRADE] + 4)
            * 3;
  }
 
  bonus = bonus
          * trade_route_type_trade_pct(cities_trade_route_type(pc1, pc2))
          / 100;
 
  bonus /= 12;
 
  return bonus;
}
 
/*********************************************************************/
int trade_from_route(const struct city *pc1, const struct trade_route *route,
                     int base)
{
  int val;
 
  if (route->dir == RDIR_TO) {
    val = base * route->goods->to_pct / 100;
 
    if (route->goods->to_pct > 0) {
      val = MAX(val, game.info.min_trade_route_val);
    }
  } else {
    val = base * route->goods->from_pct / 100;
 
    if (route->goods->from_pct > 0) {
      val = MAX(val, game.info.min_trade_route_val);
    }
  }
 
  return val;
}
 
/*********************************************************************/
int city_num_trade_routes(const struct city *pcity)
{
  return trade_route_list_size(pcity->routes);
}
 
/*********************************************************************/
static int best_value(const void *a, const void *b)
{
  return *(int *)a < *(int *)b;
}
 
/*********************************************************************/
static int max_tile_trade(const struct city *pcity)
{
  int i, total = 0;
  int radius_sq = city_map_radius_sq_get(pcity);
  int tile_trade[city_map_tiles(radius_sq)];
  size_t size = 0;
  bool is_celebrating = base_city_celebrating(pcity);
  const struct civ_map *nmap = &(wld.map);
 
  if (pcity->tile == NULL) {
    return 0;
  }
 
  city_map_iterate(radius_sq, cindex, cx, cy) {
    struct tile *ptile = city_map_to_tile(nmap, pcity->tile, radius_sq, cx, cy);
 
    if (ptile == NULL) {
      continue;
    }
 
    if (is_free_worked_index(cindex)) {
      total += city_tile_output(pcity, ptile, is_celebrating, O_TRADE);
      continue;
    }
 
    if (!city_can_work_tile(pcity, ptile)) {
      continue;
    }
 
    tile_trade[size++] = city_tile_output(pcity, ptile, is_celebrating,
                                          O_TRADE);
  } city_map_iterate_end;
 
  qsort(tile_trade, size, sizeof(*tile_trade), best_value);
 
  for (i = 0; i < pcity->size && i < size; i++) {
    total += tile_trade[i];
  }
 
  return total;
}
 
/*********************************************************************/
int max_trade_prod(const struct city *pcity)
{
  /* Trade tile base */
  int trade_prod = max_tile_trade(pcity);
 
  /* Add trade routes values */
  trade_partners_iterate(pcity, partner) {
    trade_prod += trade_base_between_cities(pcity, partner);
  } trade_partners_iterate_end;
 
  return trade_prod;
}
 
/*********************************************************************/
int get_caravan_enter_city_trade_bonus(const struct city *pc1, 
                                       const struct city *pc2,
                                       struct goods_type *pgood,
                                       const bool establish_trade)
{
  int tb = 0, bonus = 0;
  enum trade_route_type trtype = cities_trade_route_type(pc1, pc2);
 
  if (trtss[trtype].bonus_type == TBONUS_NONE) {
    return 0;
  }
 
  if (game.info.caravan_bonus_style == CBS_CLASSIC) {
    /* Should this be real_map_distance? */
    int distance = map_distance(pc1->tile, pc2->tile);
    int weighted_distance = ((100 - game.info.trade_world_rel_pct) * distance
                             + game.info.trade_world_rel_pct
                             * (distance * 40 / MAX(wld.map.xsize, wld.map.ysize))) / 100;
 
    tb = weighted_distance + 10;
    tb = (tb * (pc1->surplus[O_TRADE] + pc2->surplus[O_TRADE])) / 24;
  } else if (game.info.caravan_bonus_style == CBS_LOGARITHMIC) {
    /* Logarithmic bonus */
    int distance = real_map_distance(pc1->tile, pc2->tile);
    int weighted_distance = ((100 - game.info.trade_world_rel_pct) * distance
                             + game.info.trade_world_rel_pct
                             * (distance * 40 / MAX(wld.map.xsize, wld.map.ysize))) / 100;
 
    tb = pow(log(weighted_distance + 20
                 + max_trade_prod(pc1) + max_trade_prod(pc2)) * 2, 2);
  }
 
  if (pgood != NULL) {
    tb = tb * pgood->onetime_pct / 100;
  }
 
  /* Trade_revenue_bonus increases revenue by power of 2 in milimes */
  bonus = get_target_bonus_effects(NULL,
                                   /* TODO: Should unit requirements be
                                    * allowed so stuff like moves left and
                                    * unit type can modify the bonus? */
                                   &(const struct req_context) {
                                     .player = city_owner(pc1),
                                     .city = pc1,
                                     .tile = city_tile(pc1),
                                   /* Could be used to reduce the one time
                                    * bonus if no trade route is
                                    * established. */
                                     .action = action_by_number(
                                                 establish_trade
                                                 ? ACTION_TRADE_ROUTE
                                                 : ACTION_MARKETPLACE
                                               ),
                                   }, city_owner(pc2),
                                   EFT_TRADE_REVENUE_BONUS);
 
  /* Be mercy full to players with small amounts. Round up. */
  tb = ceil((float)tb * pow(2.0, (double)bonus / 1000.0));
 
  return tb;
}
 
/*********************************************************************/
bool have_cities_trade_route(const struct city *pc1, const struct city *pc2)
{
  trade_partners_iterate(pc1, route_to) {
    if (route_to->id == pc2->id) {
      return TRUE;
    }
  } trade_partners_iterate_end;
 
  return FALSE;
}
 
/*********************************************************************/
void goods_init(void)
{
  int i;
 
  for (i = 0; i < MAX_GOODS_TYPES; i++) {
    goods[i].id = i;
 
    requirement_vector_init(&(goods[i].reqs));
    goods[i].ruledit_disabled = FALSE;
    goods[i].helptext = NULL;
  }
}
 
/*********************************************************************/
void goods_free(void)
{
  int i;
 
  for (i = 0; i < MAX_GOODS_TYPES; i++) {
    requirement_vector_free(&(goods[i].reqs));
 
    if (NULL != goods[i].helptext) {
      strvec_destroy(goods[i].helptext);
      goods[i].helptext = NULL;
    }
  }
}
 
/*********************************************************************/
Goods_type_id goods_number(const struct goods_type *pgood)
{
  fc_assert_ret_val(NULL != pgood, -1);
 
  return pgood->id;
}
 
/*********************************************************************/
Goods_type_id goods_index(const struct goods_type *pgood)
{
  fc_assert_ret_val(NULL != pgood, -1);
 
  return pgood - goods;
}
 
/*********************************************************************/
struct goods_type *goods_by_number(Goods_type_id id)
{
  fc_assert_ret_val(id >= 0 && id < game.control.num_goods_types, NULL);
 
  return &goods[id];
}
 
/*********************************************************************/
const char *goods_name_translation(struct goods_type *pgood)
{
  return name_translation_get(&pgood->name);
}
 
/*********************************************************************/
const char *goods_rule_name(struct goods_type *pgood)
{
  return rule_name_get(&pgood->name);
}
 
/*********************************************************************/
struct goods_type *goods_by_rule_name(const char *name)
{
  const char *qs;
 
  if (name == NULL) {
    return NULL;
  }
 
  qs = Qn_(name);
 
  goods_type_iterate(pgood) {
    if (!fc_strcasecmp(goods_rule_name(pgood), qs)) {
      return pgood;
    }
  } goods_type_iterate_end;
 
  return NULL;
}
 
/*********************************************************************/
struct goods_type *goods_by_translated_name(const char *name)
{
  goods_type_iterate(pgood) {
    if (0 == strcmp(goods_name_translation(pgood), name)) {
      return pgood;
    }
  } goods_type_iterate_end;
 
  return NULL;
}
 
/*********************************************************************/
bool goods_has_flag(const struct goods_type *pgood, enum goods_flag_id flag)
{
  return BV_ISSET(pgood->flags, flag);
}
 
/*********************************************************************/
bool goods_can_be_provided(struct city *pcity, struct goods_type *pgood,
                           struct unit *punit)
{
  return are_reqs_active(&(const struct req_context) {
                           .player = city_owner(pcity),
                           .city = pcity,
                           .tile = city_tile(pcity),
                           .unit = punit,
                           .unittype = punit ? unit_type_get(punit) : NULL,
                         },
                         NULL,
                         &pgood->reqs, RPT_CERTAIN);
}
 
/*********************************************************************/
bool city_receives_goods(const struct city *pcity,
                         const struct goods_type *pgood)
{
  trade_routes_iterate(pcity, proute) {
    if (proute->goods == pgood
        && (proute->dir == RDIR_TO || proute->dir == RDIR_BIDIRECTIONAL)) {
      struct city *tcity = game_city_by_number(proute->partner);
      enum trade_route_type type;
      struct trade_route_settings *settings;
 
      if (can_cities_trade(pcity, tcity)) {
        return TRUE;
      }
 
      type = cities_trade_route_type(pcity, tcity);
      settings = trade_route_settings_by_type(type);
 
      if (settings->cancelling == TRI_ACTIVE) {
        return TRUE;
      }
    }
  } trade_routes_iterate_end;
 
  return FALSE;
}
 
/*********************************************************************/
struct goods_type *goods_from_city_to_unit(struct city *src, struct unit *punit)
{
  int i = 0;
  struct goods_type *potential[MAX_GOODS_TYPES];
 
  goods_type_iterate(pgood) {
    if (goods_can_be_provided(src, pgood, punit)) {
      potential[i++] = pgood;
    }
  } goods_type_iterate_end;
 
  if (i == 0) {
    return NULL;
  }
 
  return potential[fc_rand(i)];
}