]> git.pond.sub.org Git - empserver/blob - include/path.h
Add performance statistics to path finder
[empserver] / include / path.h
1 /*
2  *  Empire - A multi-player, client/server Internet based war game.
3  *  Copyright (C) 1986-2011, Dave Pare, Jeff Bailey, Thomas Ruschak,
4  *                Ken Stevens, Steve McClure, Markus Armbruster
5  *
6  *  Empire 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 3 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, see <http://www.gnu.org/licenses/>.
18  *
19  *  ---
20  *
21  *  See files README, COPYING and CREDITS in the root of the source
22  *  tree for related information and legal notices.  It is expected
23  *  that future projects/authors will amend these files as needed.
24  *
25  *  ---
26  *
27  *  path.h: Definitions for directions, paths, etc.
28  *
29  *  Known contributors to this file:
30  *     Markus Armbruster, 2005-2011
31  */
32
33 #ifndef PATH_H
34 #define PATH_H
35
36 #include <stddef.h>
37 #include "types.h"
38
39         /* direction indices */
40 #define DIR_STOP        0
41 #define DIR_UR          1
42 #define DIR_R           2
43 #define DIR_DR          3
44 #define DIR_DL          4
45 #define DIR_L           5
46 #define DIR_UL          6
47 #define DIR_VIEW        7
48 #define DIR_MAP         8
49 #define DIR_FIRST       1
50 #define DIR_LAST        6
51
52 #define MOB_MOVE        0
53 #define MOB_MARCH       1
54 #define MOB_RAIL        2
55
56 enum p_mode {                   /* How to find path to destination */
57     P_NONE,                     /* don't */
58     P_FLYING,                   /* use BestAirPath() */
59     P_SAILING                   /* use BestShipPath() */
60 };
61
62 /* src/lib/global/dir.c */
63 extern signed char dirindex['z'-'a'+1];
64 extern int diroff[DIR_MAP+1][2];
65 extern char dirch[DIR_MAP+2];
66 extern char *routech[DIR_LAST+1];
67
68 /* src/lib/common/bestpath.c */
69 extern char *bestownedpath(char *, char *, int, int, int, int, int);
70
71 /* src/lib/common/findpath.c */
72 extern void path_find_from(coord, coord, natid, int);
73 extern double path_find_to(coord, coord);
74 extern double path_find(coord, coord, coord, coord, natid, int);
75 extern size_t path_find_route(char *, size_t, coord, coord, coord, coord);
76 #ifdef PATH_FIND_STATS
77 extern void path_find_print_stats(void);
78 #else
79 #define path_find_print_stats() ((void)0)
80 #endif
81
82 /* src/lib/common/path.c */
83 extern char *BestDistPath(char *, struct sctstr *, struct sctstr *,
84                           double *);
85 extern char *BestLandPath(char *, struct sctstr *, struct sctstr *,
86                           double *, int);
87 extern char *BestShipPath(char *, int, int, int, int, int);
88 extern char *BestAirPath(char *, int, int, int, int);
89
90 /* src/lib/subs/paths.c */
91 extern char *getpath(char *, char *, coord, coord, int, int, enum p_mode);
92 extern double fcost(struct sctstr *, natid);
93 extern double ncost(struct sctstr *, natid);
94 extern double pathtoxy(char *, coord *, coord *,
95                        double (*)(struct sctstr *, natid));
96 extern int chkdir(char, int, int);
97 extern int diridx(char);
98 extern void direrr(char *, char *, char *);
99 extern void pathrange(coord, coord, char *, int, struct range *);
100
101 extern double sector_mcost(struct sctstr *, int);
102 extern double speed_factor(double, int);
103
104 #define MAX_PATH_LEN 1024
105
106 #endif