git.pond.sub.org Git - empserver/blob - src/lib/common/path.c

   1 /*
   2  *  Empire - A multi-player, client/server Internet based war game.
   3  *  Copyright (C) 1986-2009, Dave Pare, Jeff Bailey, Thomas Ruschak,
   4  *                           Ken Stevens, Steve McClure
   5  *
   6  *  This program is free software; you can redistribute it and/or modify
   7  *  it under the terms of the GNU General Public License as published by
   8  *  the Free Software Foundation; either version 2 of the License, or
   9  *  (at your option) any later version.
  10  *
  11  *  This program is distributed in the hope that it will be useful,
  12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *  GNU General Public License for more details.
  15  *
  16  *  You should have received a copy of the GNU General Public License
  17  *  along with this program; if not, write to the Free Software
  18  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19  *
  20  *  ---
  21  *
  22  *  See files README, COPYING and CREDITS in the root of the source
  23  *  tree for related information and legal notices.  It is expected
  24  *  that future projects/authors will amend these files as needed.
  25  *
  26  *  ---
  27  *
  28  *  path.c: Empire/A* Interface code.
  29  *          Define AS_STATS for A* statistics.
  30  *
  31  *  Known contributors to this file:
  32  *     Phil Lapsley, 1991
  33  *     Dave Pare, 1991
  34  *     Thomas Ruschak, 1993
  35  *     Steve McClure, 1997
  36  */
  37
  38 #include <config.h>
  39
  40 #include <stdio.h>
  41 #include "../as/as.h"
  42 #include "file.h"
  43 #include "misc.h"
  44 #include "optlist.h"
  45 #include "path.h"
  46 #include "prototypes.h"
  47 #include "sect.h"
  48 #include "xy.h"
  49
  50 #define BP_ASHASHSIZE   128     /* A* queue hash table size */
  51 #define BP_NEIGHBORS    6       /* max number of neighbors */
  52
  53 struct bestp {
  54     int sctcache_hits;
  55     int sctcache_misses;
  56     int bp_mobtype;
  57     struct as_data *adp;
  58 };
  59
  60 static int bp_path(struct as_path *pp, char *buf);
  61 static int bp_neighbors(struct as_coord c, struct as_coord *cp, void *);
  62 static double bp_lbcost(struct as_coord from, struct as_coord to, void *);
  63 static double bp_realcost(struct as_coord from, struct as_coord to, void *);
  64 static double bp_seccost(struct as_coord from, struct as_coord to, void *);
  65 static int bp_coord_hash(struct as_coord c);
  66
  67 /* We use this for caching neighbors.  It never changes except
  68  * at reboot time (maybe) so we never need to free it */
  69 static struct sctstr **neighsects;
  70
  71 static struct bestp *
  72 bp_init(void)
  73 {
  74     struct bestp *bp;
  75
  76     bp = malloc(sizeof(*bp));
  77     memset(bp, 0, sizeof(*bp));
  78     bp->adp = as_init(BP_NEIGHBORS, BP_ASHASHSIZE, bp_coord_hash,
  79                       bp_neighbors, bp_lbcost, bp_realcost,
  80                       bp_seccost, bp);
  81
  82     if (bp->adp == NULL)
  83         return NULL;
  84
  85     if (neighsects == NULL)
  86         neighsects = calloc(WORLD_SZ() * 6, sizeof(struct sctstr *));
  87
  88     return bp;
  89 }
  90
  91 /*
  92  * Find the best path from sector to to sector, and put the Empire movement
  93  * string in path.  Return 0 on success, -1 on error.
  94  */
  95 static int
  96 best_path(struct sctstr *from, struct sctstr *to, char *path,
  97           int mob_type)
  98 {
  99     static struct bestp *mybestpath;
 100     struct as_data *adp;
 101     struct as_path *ap;
 102
 103     if (mybestpath == 0)
 104         mybestpath = bp_init();
 105     adp = mybestpath->adp;
 106     ap = as_find_cachepath(from->sct_x, from->sct_y, to->sct_x, to->sct_y);
 107     if (ap == NULL) {
 108         adp->from.x = from->sct_x;
 109         adp->from.y = from->sct_y;
 110         adp->to.x = to->sct_x;
 111         adp->to.y = to->sct_y;
 112         mybestpath->bp_mobtype = mob_type;
 113
 114         if (as_search(adp) < 0)
 115             return -1;
 116         ap = adp->path;
 117     }
 118
 119     if (bp_path(ap, path) < 0)
 120         return -1;
 121
 122 #ifdef AS_STATS
 123     as_stats(adp, stderr);
 124 #endif /* AS_STATS */
 125 #ifdef BP_STATS
 126     fprintf(stderr, "best path %s\n", path);
 127     fprintf(stderr, "cache hits/misses: %d/%d\n",
 128             bp->sctcache_hits, bp->sctcache_misses);
 129 #endif /* BP_STATS */
 130     return 0;
 131 }
 132
 133 /*
 134  * Translate an A* path into an empire movement string.  Return 0 on
 135  * success, -1 on failure.
 136  */
 137 static int
 138 bp_path(struct as_path *pp, char *buf)
 139 {
 140     struct as_path *np;
 141     char *cp = buf;
 142     int dx, dy;
 143     int n;
 144
 145     np = pp->next;
 146     while (np) {
 147         dx = np->c.x - pp->c.x;
 148         /* deal with wraparound from non-neg coords */
 149         if (dx < -2)
 150             dx += WORLD_X;
 151         else if (dx > 2)
 152             dx -= WORLD_X;
 153         dy = np->c.y - pp->c.y;
 154         if (dy < -1)
 155             dy += WORLD_Y;
 156         else if (dy > 1)
 157             dy -= WORLD_Y;
 158         for (n = 1; n <= 6; n++)
 159             if (dx == diroff[n][0] && dy == diroff[n][1])
 160                 break;
 161         if (n > 6)
 162             return -1;
 163
 164         *cp++ = dirch[n];
 165         pp = np;
 166         np = np->next;
 167     }
 168     *cp = '\0';
 169     return 0;
 170 }
 171
 172 /*
 173  * Find coords neighboring this sector; return number of such
 174  * coords, and coordinartes themselves in an array pointed
 175  * to by *cpp.
 176  * XXX need to check ownership, sector types, etc.
 177  */
 178 static int
 179 bp_neighbors(struct as_coord c, struct as_coord *cp, void *pp)
 180 {
 181     struct sctstr *sectp = (void *)empfile[EF_SECTOR].cache;
 182     struct bestp *bp = pp;
 183     coord x, y;
 184     coord nx, ny;
 185     int n = 0, q;
 186     struct sctstr *sp, *from, **ssp;
 187     /* Six pointers, just in case our cache isn't there */
 188     struct sctstr *tsp[] = { 0, 0, 0, 0, 0, 0 };
 189     int sx, sy, offset;
 190
 191     x = c.x;
 192     y = c.y;
 193     sx = XNORM(x);
 194     sy = YNORM(y);
 195     offset = XYOFFSET(sx, sy);
 196     from = &sectp[offset];
 197
 198     if (neighsects == NULL)
 199         ssp = (struct sctstr **)&tsp[0];
 200     else
 201         ssp = (struct sctstr **)&neighsects[offset * 6];
 202     for (q = 1; q <= 6; q++, ssp++) {
 203         if (*ssp == NULL) {
 204             /* We haven't cached this neighbor yet */
 205             nx = x + diroff[q][0];
 206             ny = y + diroff[q][1];
 207             sx = XNORM(nx);
 208             sy = YNORM(ny);
 209             offset = XYOFFSET(sx, sy);
 210             sp = &sectp[offset];
 211             *ssp = sp;
 212         } else {
 213             sp = *ssp;
 214             sx = XNORM(sp->sct_x);
 215             sy = YNORM(sp->sct_y);
 216         }
 217         /* No need to calculate cost each time, just make sure we can
 218            move through it.  We calculate it later. */
 219         if (dchr[sp->sct_type].d_mob0 < 0)
 220             continue;
 221         if (bp->bp_mobtype == MOB_RAIL && !SCT_HAS_RAIL(sp))
 222             continue;
 223         if (sp->sct_own != from->sct_own)
 224             continue;
 225         cp[n].x = sx;
 226         cp[n].y = sy;
 227         n++;
 228     }
 229     return n;
 230 }
 231
 232 /*
 233  * Compute a lower-bound on the cost from "from" to "to".
 234  */
 235 /*ARGSUSED*/
 236 static double
 237 bp_lbcost(struct as_coord from, struct as_coord to, void *pp)
 238 {
 239     struct sctstr *sectp = (void *)empfile[EF_SECTOR].cache;
 240     struct bestp *bp = pp;
 241     int x, y, sx, sy, offset;
 242
 243     x = to.x;
 244     y = to.y;
 245     sx = XNORM(x);
 246     sy = YNORM(y);
 247     offset = XYOFFSET(sx, sy);
 248     return sector_mcost(&sectp[offset], bp->bp_mobtype);
 249 }
 250
 251 /*
 252  * Compute the real cost to move from "from" to "to".
 253  */
 254 static double
 255 bp_realcost(struct as_coord from, struct as_coord to, void *pp)
 256 {
 257     return bp_lbcost(from, to, pp);
 258 }
 259
 260 /*
 261  * Tie breaker secondary metric (only used when lower bound costs
 262  * are equal).
 263  */
 264 /*ARGSUSED*/
 265 static double
 266 bp_seccost(struct as_coord from, struct as_coord to, void *pp)
 267 {
 268     return mapdist((coord)from.x, (coord)from.y,
 269                    (coord)to.x, (coord)to.y);
 270 }
 271
 272 /*
 273  * Hash a coordinate into an integer.
 274  */
 275 static int
 276 bp_coord_hash(struct as_coord c)
 277 {
 278     return ((abs(c.x) + 1) << 3) ^ abs(c.y);
 279 }
 280
 281 void
 282 bp_enable_cachepath(void)
 283 {
 284     as_enable_cachepath();
 285 }
 286
 287 void
 288 bp_disable_cachepath(void)
 289 {
 290     as_disable_cachepath();
 291 }
 292
 293 void
 294 bp_clear_cachepath(void)
 295 {
 296     as_clear_cachepath();
 297 }
 298
 299 double
 300 pathcost(struct sctstr *start, char *path, int mob_type)
 301 {
 302     struct sctstr *sectp = (void *)empfile[EF_SECTOR].cache;
 303     unsigned i;
 304     int o;
 305     int cx, cy;
 306     double cost = 0.0;
 307     struct sctstr *sp;
 308     int sx, sy, offset;
 309
 310     cx = start->sct_x;
 311     cy = start->sct_y;
 312
 313     while (*path) {
 314         if (*path == 'h') {
 315             path++;
 316             continue;
 317         }
 318         i = *path - 'a';
 319         if (CANT_HAPPEN(i >= sizeof(dirindex) / sizeof(*dirindex)))
 320             break;
 321         o = dirindex[i];
 322         if (CANT_HAPPEN(o < 0))
 323             break;
 324         cx += diroff[o][0];
 325         cy += diroff[o][1];
 326         sx = XNORM(cx);
 327         sy = YNORM(cy);
 328         offset = XYOFFSET(sx, sy);
 329         sp = &sectp[offset];
 330         cost += sector_mcost(sp, mob_type);
 331         path++;
 332     }
 333
 334     return cost;
 335 }
 336
 337 char *
 338 BestDistPath(char *path,
 339              struct sctstr *from,
 340              struct sctstr *to, double *cost)
 341 {
 342     return BestLandPath(path, from, to, cost, MOB_MOVE);
 343 }
 344
 345 char *
 346 BestLandPath(char *path,
 347              struct sctstr *from,
 348              struct sctstr *to, double *cost, int mob_type)
 349 {
 350     int length;
 351
 352     *path = 0;
 353     *cost = 0.0;
 354     if (best_path(from, to, path, mob_type) < 0)
 355         return NULL;
 356     *cost = pathcost(from, path, mob_type);
 357     length = strlen(path);
 358     path[length] = 'h';
 359     path[length + 1] = '\0';
 360     return path;
 361 }
 362
 363 char *
 364 BestShipPath(char *path, int fx, int fy, int tx, int ty, int owner)
 365 {
 366     char *map;
 367
 368     map = ef_ptr(EF_BMAP, owner);
 369     if (!map)
 370         return NULL;
 371     return bestownedpath(path, map, fx, fy, tx, ty, owner);
 372 }
 373
 374 char *
 375 BestAirPath(char *path, int fx, int fy, int tx, int ty)
 376 {
 377     return bestownedpath(path, NULL, fx, fy, tx, ty, -1);
 378 }