]> git.pond.sub.org Git - empserver/blob - src/lib/subs/supply.c
Replace common pattern by new LIMIT_TO()
[empserver] / src / lib / subs / supply.c
1 /*
2  *  Empire - A multi-player, client/server Internet based war game.
3  *  Copyright (C) 1986-2013, 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  *  supply.c: Supply subroutines
28  *
29  *  Known contributors to this file:
30  *     Markus Armbruster, 2004-2013
31  */
32
33 #include <config.h>
34
35 #include <math.h>
36 #include "chance.h"
37 #include "empobj.h"
38 #include "file.h"
39 #include "land.h"
40 #include "nat.h"
41 #include "optlist.h"
42 #include "path.h"
43 #include "prototypes.h"
44 #include "sect.h"
45 #include "ship.h"
46
47 static int s_commod(struct empobj *, short *, i_type, int, int, int);
48 static int get_minimum(struct lndstr *, i_type);
49
50 int
51 sct_supply(struct sctstr *sp, i_type type, int wanted)
52 {
53     return s_commod((struct empobj *)sp, sp->sct_item,
54                     type, wanted, ITEM_MAX, 1);
55 }
56
57 int
58 shp_supply(struct shpstr *sp, i_type type, int wanted)
59 {
60     return s_commod((struct empobj *)sp, sp->shp_item,
61                     type, wanted, mchr[sp->shp_type].m_item[type], 1);
62 }
63
64 int
65 lnd_supply(struct lndstr *lp, i_type type, int wanted)
66 {
67     return s_commod((struct empobj *)lp, lp->lnd_item,
68                     type, wanted, lchr[lp->lnd_type].l_item[type], 1);
69 }
70
71 int
72 lnd_in_supply(struct lndstr *lp)
73 {
74     if (!opt_NOFOOD) {
75         if (lp->lnd_item[I_FOOD] < get_minimum(lp, I_FOOD))
76             return 0;
77     }
78     return lp->lnd_item[I_SHELL] >= get_minimum(lp, I_SHELL);
79 }
80
81 int
82 lnd_supply_all(struct lndstr *lp)
83 {
84     int fail = 0;
85
86     if (!opt_NOFOOD)
87         fail |= !lnd_supply(lp, I_FOOD, get_minimum(lp, I_FOOD));
88     fail |= !lnd_supply(lp, I_SHELL, get_minimum(lp, I_SHELL));
89     return !fail;
90 }
91
92 /*
93  * Actually get the commod
94  *
95  * First, try to forage in the sector
96  * Second look for a warehouse or headquarters to leech
97  * Third, look for a ship we own in a harbor
98  * Fourth, look for supplies in a supply unit we own
99  *              (one good reason to do this last is that the supply
100  *               unit will then call resupply, taking more time)
101  *
102  * May want to put code to resupply with SAMs here, later --ts
103  */
104 static int
105 s_commod(struct empobj *sink, short *vec,
106          i_type type, int wanted, int limit, int actually_doit)
107 {
108     natid own = sink->own;
109     coord x = sink->x;
110     coord y = sink->y;
111     int lookrange;
112     struct sctstr sect;
113     struct nstr_sect ns;
114     struct nstr_item ni;
115     struct lchrstr *lcp;
116     struct shpstr ship;
117     struct lndstr land;
118     /* leave at least 1 military in sectors/ships */
119     int minimum = 0;
120     int can_move;
121     double move_cost, weight, mobcost;
122     int packing;
123     struct dchrstr *dp;
124     struct ichrstr *ip;
125
126     if (wanted > limit)
127         wanted = limit;
128     if (wanted <= vec[type])
129         return 1;
130     wanted -= vec[type];
131
132     /* try to get it from sector we're in */
133     if (sink->ef_type != EF_SECTOR) {
134         getsect(x, y, &sect);
135         if (sect.sct_own == own) {
136             if (!opt_NOFOOD && type == I_FOOD)
137                 minimum = 1 + (int)ceil(food_needed(sect.sct_item,
138                                                     etu_per_update));
139             if (sect.sct_item[type] - wanted >= minimum) {
140                 sect.sct_item[type] -= wanted;
141                 if (actually_doit) {
142                     vec[type] += wanted;
143                     putsect(&sect);
144                     put_empobj(sink->ef_type, sink->uid, sink);
145                 }
146                 return 1;
147             } else if (sect.sct_item[type] - minimum > 0) {
148                 wanted -= sect.sct_item[type] - minimum;
149                 sect.sct_item[type] = minimum;
150                 if (actually_doit) {
151                     vec[type] += sect.sct_item[type] - minimum;
152                     putsect(&sect);
153                 }
154             }
155         }
156     }
157
158     /* look for a headquarters or warehouse */
159     lookrange = tfact(own, 10.0);
160     snxtsct_dist(&ns, x, y, lookrange);
161     while (nxtsct(&ns, &sect) && wanted) {
162         if (ns.curdist == 0)
163             continue;
164         if (sect.sct_own != own)
165             continue;
166         if ((sect.sct_type != SCT_WAREH) &&
167             (sect.sct_type != SCT_HEADQ) && (sect.sct_type != SCT_HARBR))
168             continue;
169         if ((sect.sct_type == SCT_HEADQ) &&
170             (sect.sct_dist_x == sect.sct_x) &&
171             (sect.sct_dist_y == sect.sct_y))
172             continue;
173         if (sect.sct_effic < 60)
174             continue;
175         move_cost = path_find(sect.sct_x, sect.sct_y, x, y, own, MOB_MOVE);
176         if (move_cost < 0)
177             continue;
178         if (!opt_NOFOOD && type == I_FOOD)
179             minimum = 1 + (int)ceil(food_needed(sect.sct_item,
180                                                 etu_per_update));
181         if (sect.sct_item[type] <= minimum)
182             continue;
183         ip = &ichr[type];
184         dp = &dchr[sect.sct_type];
185         packing = ip->i_pkg[dp->d_pkg];
186         if (packing > 1 && sect.sct_effic < 60)
187             packing = 1;
188         weight = (double)ip->i_lbs / packing;
189         mobcost = move_cost * weight;
190         if (mobcost > 0)
191             can_move = (double)sect.sct_mobil / mobcost;
192         else
193             can_move = sect.sct_item[type] - minimum;
194         if (can_move > sect.sct_item[type] - minimum)
195             can_move = sect.sct_item[type] - minimum;
196
197         if (can_move >= wanted) {
198             int n;
199
200             sect.sct_item[type] -= wanted;
201
202             /* take off mobility for delivering sect */
203             n = roundavg(wanted * weight * move_cost);
204             sect.sct_mobil -= LIMIT_TO(n, 0, sect.sct_mobil);
205             if (actually_doit) {
206                 vec[type] += wanted;
207                 putsect(&sect);
208                 put_empobj(sink->ef_type, sink->uid, sink);
209             }
210             return 1;
211         } else if (can_move > 0) {
212             int n;
213             wanted -= can_move;
214             sect.sct_item[type] -= can_move;
215
216             /* take off mobility for delivering sect */
217             n = roundavg(can_move * weight * move_cost);
218             sect.sct_mobil -= LIMIT_TO(n, 0, sect.sct_mobil);
219             if (actually_doit) {
220                 vec[type] += can_move;
221                 putsect(&sect);
222             }
223         }
224     }
225
226     /* look for an owned ship in a harbor */
227     snxtitem_dist(&ni, EF_SHIP, x, y, lookrange);
228     while (nxtitem(&ni, &ship) && wanted) {
229         if (sink->ef_type == EF_SHIP && sink->uid == ship.shp_uid)
230             continue;
231         if (ship.shp_own != own)
232             continue;
233         if (!(mchr[(int)ship.shp_type].m_flags & M_SUPPLY))
234             continue;
235         getsect(ship.shp_x, ship.shp_y, &sect);
236         if (sect.sct_type != SCT_HARBR)
237             continue;
238         if (sect.sct_effic < 2)
239             continue;
240         move_cost = path_find(sect.sct_x, sect.sct_y, x, y, own, MOB_MOVE);
241         if (move_cost < 0)
242             continue;
243         if (!opt_NOFOOD && type == I_FOOD)
244             minimum = 1 + (int)ceil(food_needed(ship.shp_item,
245                                                 etu_per_update));
246         if (ship.shp_item[type] <= minimum)
247             continue;
248         ip = &ichr[type];
249         dp = &dchr[sect.sct_type];
250         packing = ip->i_pkg[dp->d_pkg];
251         if (packing > 1 && sect.sct_effic < 60)
252             packing = 1;
253         weight = (double)ip->i_lbs / packing;
254         mobcost = move_cost * weight;
255         if (mobcost > 0)
256             can_move = (double)sect.sct_mobil / mobcost;
257         else
258             can_move = ship.shp_item[type] - minimum;
259         if (can_move > ship.shp_item[type] - minimum)
260             can_move = ship.shp_item[type] - minimum;
261         if (can_move >= wanted) {
262             int n;
263             ship.shp_item[type] -= wanted;
264
265             n = roundavg(wanted * weight * move_cost);
266             sect.sct_mobil -= LIMIT_TO(n, 0, sect.sct_mobil);
267             if (actually_doit) {
268                 vec[type] += can_move;
269                 putship(ship.shp_uid, &ship);
270                 putsect(&sect);
271                 put_empobj(sink->ef_type, sink->uid, sink);
272             }
273             return 1;
274         } else if (can_move > 0) {
275             int n;
276             wanted -= can_move;
277             ship.shp_item[type] -= can_move;
278
279             n = roundavg(can_move * weight * move_cost);
280             sect.sct_mobil -= LIMIT_TO(n, 0, sect.sct_mobil);
281             if (actually_doit) {
282                 vec[type] += can_move;
283                 putship(ship.shp_uid, &ship);
284                 putsect(&sect);
285             }
286         }
287     }
288
289     /* look for an owned supply unit */
290     snxtitem_dist(&ni, EF_LAND, x, y, lookrange);
291     while (nxtitem(&ni, &land) && wanted) {
292         int min;
293
294         if (sink->ef_type == EF_LAND && sink->uid == land.lnd_uid)
295             continue;
296         if (land.lnd_own != own)
297             continue;
298
299         lcp = &lchr[(int)land.lnd_type];
300         if (!(lcp->l_flags & L_SUPPLY))
301             continue;
302
303         if (land.lnd_item[type] <= get_minimum(&land, type))
304             continue;
305
306         if (land.lnd_ship >= 0) {
307             getsect(land.lnd_x, land.lnd_y, &sect);
308             if (sect.sct_type != SCT_HARBR || sect.sct_effic < 2)
309                 continue;
310         }
311
312         move_cost = path_find(land.lnd_x, land.lnd_y, x, y, own, MOB_MOVE);
313         if (move_cost < 0)
314             continue;
315
316 #if 0
317         /*
318          * Recursive supply is disabled for now.  It can introduce
319          * cycles into the "resupplies from" relation.  The code below
320          * attempts to break these cycles by temporarily zapping the
321          * commodity being supplied.  That puts the land file in a
322          * funny state temporarily, risking loss of supplies when
323          * something goes wrong on the way.  Worse, it increases
324          * lnd_seqno even when !actually_doit, which can lead to
325          * spurious seqno mismatch oopses in users of
326          * lnd_could_be_supplied().  I can't be bothered to clean up
327          * this mess right now, because recursive resupply is too dumb
328          * to be really useful anyway: each step uses the first source
329          * it finds, without consideration of mobility cost.  If you
330          * re-enable it, don't forget to uncomment its documentation
331          * in supply.t as well.
332          */
333         if (land.lnd_item[type] - wanted < get_minimum(&land, type)) {
334             struct lndstr save;
335
336             /*
337              * Temporarily zap this unit's store, so the recursion
338              * avoids it.
339              */
340             save = land;
341             land.lnd_item[type] = 0;
342             putland(land.lnd_uid, &land);
343             save.lnd_seqno = land.lnd_seqno;
344
345             s_commod((struct empobj *)&land, land.lnd_item, type, wanted,
346                      lchr[land.lnd_type].l_item[type] - wanted,
347                      actually_doit);
348             land.lnd_item[type] += save.lnd_item[type];
349
350             if (actually_doit)
351                 putland(land.lnd_uid, &land);
352             else
353                 putland(save.lnd_uid, &save);
354         }
355 #endif
356
357         min = get_minimum(&land, type);
358         ip = &ichr[type];
359         weight = ip->i_lbs;
360         mobcost = move_cost * weight;
361         if (mobcost > 0)
362             can_move = (double)land.lnd_mobil / mobcost;
363         else
364             can_move = land.lnd_item[type] - min;
365         if (can_move > land.lnd_item[type] - min)
366             can_move = land.lnd_item[type] - min;
367
368         if (can_move >= wanted) {
369             land.lnd_item[type] -= wanted;
370             land.lnd_mobil -= roundavg(wanted * weight * move_cost);
371             if (actually_doit) {
372                 vec[type] += wanted;
373                 putland(land.lnd_uid, &land);
374                 put_empobj(sink->ef_type, sink->uid, sink);
375             }
376             return 1;
377         } else if (can_move > 0) {
378             wanted -= can_move;
379             land.lnd_item[type] -= can_move;
380             land.lnd_mobil -= roundavg(can_move * weight * move_cost);
381             if (actually_doit) {
382                 vec[type] += can_move;
383                 putland(land.lnd_uid, &land);
384             }
385         }
386     }
387
388     if (actually_doit)
389         put_empobj(sink->ef_type, sink->uid, sink);
390     return 0;
391 }
392
393 /*
394  * We want to get enough shells to fire once,
395  * one update's worth of food.
396  */
397 static int
398 get_minimum(struct lndstr *lp, i_type type)
399 {
400     struct lchrstr *lcp;
401     int max, want = 0;
402
403     lcp = &lchr[(int)lp->lnd_type];
404     max = lcp->l_item[type];
405
406     switch (type) {
407     case I_FOOD:
408         if (opt_NOFOOD)
409             return 0;           /* no food reqd, get out */
410         want = (int)ceil(food_needed(lp->lnd_item, etu_per_update));
411         break;
412     case I_SHELL:
413         want = lcp->l_ammo;
414         break;
415     default:
416         return 0;
417     }
418
419     if (want > max)
420         want = max;
421
422     return want;
423 }
424
425 int
426 lnd_could_be_supplied(struct lndstr *lp)
427 {
428     int res, food, food_needed, shells_needed, shells;
429
430     if (!opt_NOFOOD) {
431         food_needed = get_minimum(lp, I_FOOD);
432         food = lp->lnd_item[I_FOOD];
433         if (food < food_needed) {
434             res = s_commod((struct empobj *)lp, lp->lnd_item,
435                            I_FOOD, food_needed,
436                            lchr[lp->lnd_type].l_item[I_FOOD], 0);
437             lp->lnd_item[I_FOOD] = food;
438             if (!res)
439                 return 0;
440         }
441     }
442
443     shells_needed = lchr[lp->lnd_type].l_ammo;
444     shells = lp->lnd_item[I_SHELL];
445     if (shells < shells_needed) {
446         res = s_commod((struct empobj *)lp, lp->lnd_item,
447                        I_SHELL, shells_needed,
448                        lchr[lp->lnd_type].l_item[I_SHELL], 0);
449         lp->lnd_item[I_SHELL] = shells;
450         if (!res)
451             return 0;
452     }
453
454     return 1;
455 }