unitlist.c

Go to the documentation of this file.

/****************************************************************************
 Freeciv - Copyright (C) 2005 - The Freeciv Project
   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"
 
/* common */
#include "game.h"
#include "movement.h"
#include "unitlist.h"
 
/************************************************************************/
struct unit *unit_list_find(const struct unit_list *punitlist, int unit_id)
{
  unit_list_iterate(punitlist, punit) {
    if (punit->id == unit_id) {
      return punit;
    }
  } unit_list_iterate_end;
 
  return NULL;
}
 
/************************************************************************/
static int compar_unit_ord_map(const struct unit *const *ua,
                               const struct unit *const *ub)
{
  return (*ua)->server.ord_map - (*ub)->server.ord_map;
}
 
/************************************************************************/
static int compar_unit_ord_city(const struct unit *const *ua,
                                const struct unit *const *ub)
{
  return (*ua)->server.ord_city - (*ub)->server.ord_city;
}
 
/************************************************************************/
void unit_list_sort_ord_map(struct unit_list *punitlist)
{
  fc_assert_ret(is_server());
 
  unit_list_sort(punitlist, compar_unit_ord_map);
}
 
/************************************************************************/
void unit_list_sort_ord_city(struct unit_list *punitlist)
{
  fc_assert_ret(is_server());
 
  unit_list_sort(punitlist, compar_unit_ord_city);
}
 
/************************************************************************/
bool can_units_do(const struct unit_list *punits,
                  bool (can_fn)(const struct unit *punit))
{
  unit_list_iterate(punits, punit) {
    if (can_fn(punit)) {
      return TRUE;
    }
  } unit_list_iterate_end;
 
  return FALSE;
}
 
/************************************************************************/
bool can_units_do_on_map(const struct civ_map *nmap,
                         const struct unit_list *punits,
                         bool (can_fn)(const struct civ_map *nmap,
                                       const struct unit *punit))
{
  unit_list_iterate(punits, punit) {
    if (can_fn(nmap, punit)) {
      return TRUE;
    }
  } unit_list_iterate_end;
 
  return FALSE;
}
 
/************************************************************************/
bool can_units_do_activity(const struct civ_map *nmap,
                           const struct unit_list *punits,
                           enum unit_activity activity,
                           enum gen_action action)
{
  unit_list_iterate(punits, punit) {
    if (can_unit_do_activity(nmap, punit, activity, action)) {
      return TRUE;
    }
  } unit_list_iterate_end;
 
  return FALSE;
}
 
/************************************************************************/
bool can_units_do_activity_targeted(const struct civ_map *nmap,
                                    const struct unit_list *punits,
                                    enum unit_activity activity,
                                    enum gen_action action,
                                    struct extra_type *pextra)
{
  unit_list_iterate(punits, punit) {
    if (can_unit_do_activity_targeted(nmap, punit, activity, action, pextra)) {
      return TRUE;
    }
  } unit_list_iterate_end;
 
  return FALSE;
}
 
/************************************************************************/
bool can_units_do_any_road(const struct civ_map *nmap,
                           const struct unit_list *punits)
{
  unit_list_iterate(punits, punit) {
    extra_type_by_cause_iterate(EC_ROAD, pextra) {
      struct road_type *proad = extra_road_get(pextra);
 
      if (can_build_road(nmap, proad, punit, unit_tile(punit))) {
        return TRUE;
      }
    } extra_type_by_cause_iterate_end;
  } unit_list_iterate_end;
 
  return FALSE;
}
 
/************************************************************************/
bool can_units_do_base_gui(const struct unit_list *punits,
                           enum base_gui_type base_gui)
{
  unit_list_iterate(punits, punit) {
    struct base_type *pbase = get_base_by_gui_type(base_gui, punit,
                                                   unit_tile(punit));
 
    if (pbase) {
      /* Some unit can build base of given gui_type */
      return TRUE;
    }
  } unit_list_iterate_end;
 
  return FALSE;
}
 
/************************************************************************/
bool units_have_type_flag(const struct unit_list *punits,
                          enum unit_type_flag_id flag, bool has_flag)
{
  unit_list_iterate(punits, punit) {
    if (EQ(has_flag, unit_has_type_flag(punit, flag))) {
      return TRUE;
    }
  } unit_list_iterate_end;
 
  return FALSE;
}
 
/************************************************************************/
bool units_contain_cityfounder(const struct unit_list *punits)
{
  if (game.scenario.prevent_new_cities) {
    return FALSE;
  }
 
  unit_list_iterate(punits, punit) {
    if (EQ(TRUE, unit_can_do_action(punit, ACTION_FOUND_CITY))) {
      return TRUE;
    }
  } unit_list_iterate_end;
 
  return FALSE;
}
 
/************************************************************************/
bool units_can_do_action(const struct unit_list *punits,
                         action_id act_id, bool can_do)
{
  unit_list_iterate(punits, punit) {
    if (EQ(can_do, unit_can_do_action(punit, act_id))) {
      return TRUE;
    }
  } unit_list_iterate_end;
 
  return FALSE;
}
 
/************************************************************************/
bool units_can_do_action_with_result(const struct unit_list *punits,
                                     enum action_result result, bool can_do)
{
  unit_list_iterate(punits, punit) {
    if (EQ(can_do, unit_can_do_action_result(punit, result))) {
      return TRUE;
    }
  } unit_list_iterate_end;
 
  return FALSE;
}
 
/************************************************************************/
bool units_are_occupied(const struct unit_list *punits)
{
  unit_list_iterate(punits, punit) {
    if (get_transporter_occupancy(punit) > 0) {
      return TRUE;
    }
  } unit_list_iterate_end;
 
  return FALSE;
}
 
/************************************************************************/
bool units_can_load(const struct unit_list *punits)
{
  unit_list_iterate(punits, punit) {
    if (unit_can_load(punit)) {
      return TRUE;
    }
  } unit_list_iterate_end;
 
  return FALSE;
}
 
/************************************************************************/
bool units_can_unload(const struct civ_map *nmap,
                      const struct unit_list *punits)
{
  unit_list_iterate(punits, punit) {
    if (unit_transported(punit)
        && can_unit_unload(punit, unit_transport_get(punit))
        && can_unit_exist_at_tile(nmap, punit, unit_tile(punit))) {
      return TRUE;
    }
  } unit_list_iterate_end;
 
  return FALSE;
}
 
/************************************************************************/
bool units_have_activity_on_tile(const struct unit_list *punits,
                                 enum unit_activity activity)
{
  unit_list_iterate(punits, punit) {
    if (is_unit_activity_on_tile(activity, unit_tile(punit))) {
      return TRUE;
    }
  } unit_list_iterate_end;
 
  return FALSE;
}
 
/************************************************************************/
bool units_can_upgrade(const struct civ_map *nmap,
                       const struct unit_list *punits)
{
  unit_list_iterate(punits, punit) {
    if (UU_OK == unit_upgrade_test(nmap, punit, FALSE)) {
      return TRUE;
    }
  } unit_list_iterate_end;
 
  return FALSE;
}
 
/************************************************************************/
bool units_can_convert(const struct civ_map *nmap,
                       const struct unit_list *punits)
{
  unit_list_iterate(punits, punit) {
    if (utype_can_do_action(unit_type_get(punit), ACTION_CONVERT)
        && unit_can_convert(nmap, punit)) {
      return TRUE;
    }
  } unit_list_iterate_end;
 
  return FALSE;
}