Markus Armbruster
9f25de3dce
... when referring to a function's parameter or a struct/union's
member.
The idea of using FOO comes from the GNU coding standards:
The comment on a function is much clearer if you use the argument
names to speak about the argument values. The variable name
itself should be lower case, but write it in upper case when you
are speaking about the value rather than the variable itself.
Thus, "the inode number NODE_NUM" rather than "an inode".
Upcasing names is problematic for a case-sensitive language like C,
because it can create ambiguity. Moreover, it's too much shouting for
my taste.
GTK-Doc's convention to prefix the identifier with @ makes references
to variables stand out nicely. The rest of the GTK-Doc conventions
make no sense for us, however.
Signed-off-by: Markus Armbruster <armbru@pond.sub.org>
69 lines
2.5 KiB
C
69 lines
2.5 KiB
C
/*
|
|
* Empire - A multi-player, client/server Internet based war game.
|
|
* Copyright (C) 1986-2015, Dave Pare, Jeff Bailey, Thomas Ruschak,
|
|
* Ken Stevens, Steve McClure, Markus Armbruster
|
|
*
|
|
* Empire 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 3 of the License, 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.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*
|
|
* ---
|
|
*
|
|
* See files README, COPYING and CREDITS in the root of the source
|
|
* tree for related information and legal notices. It is expected
|
|
* that future projects/authors will amend these files as needed.
|
|
*
|
|
* ---
|
|
*
|
|
* map.h: Definitions for making maps
|
|
*
|
|
* Known contributors to this file:
|
|
*
|
|
*/
|
|
|
|
#ifndef MAP_H
|
|
#define MAP_H
|
|
|
|
#include "types.h"
|
|
|
|
/*
|
|
* Width of the body of a map using @persec characters per sector.
|
|
*
|
|
* One row shows WORLD_X/2 sectors, separated by one space. Requires
|
|
* WORLD_X/2 * (@persec+1) - 1 characters.
|
|
*
|
|
* Every other row is indented so that the center of the first sector
|
|
* is aligned with the space separating the first two sectors in the
|
|
* adjacent rows. For odd @persec, that's (@persec+1)/2 additional
|
|
* characters. For even @persec, it's either @persec/2 or @persec/2 + 1,
|
|
* depending on whether we align the character left or right of the
|
|
* center with the space (the map will look rather odd either way).
|
|
*
|
|
* We need one more character for the terminating zero.
|
|
*/
|
|
#define MAPWIDTH(persec) (WORLD_X/2 * ((persec) + 1) + ((persec) + 2) / 2)
|
|
|
|
/* src/lib/subs/bigmap.c */
|
|
extern int map_set(natid, coord, coord, char, int);
|
|
extern void writebmap(natid);
|
|
extern void writemap(natid);
|
|
/* src/lib/subs/border.c */
|
|
extern void blankfill(char *, struct range *, int);
|
|
extern void border(struct range *, char *, char *);
|
|
/* src/lib/subs/maps.c */
|
|
extern int do_map(int bmap, int unit_type, char *arg1, char *arg2);
|
|
extern int display_region_map(int, int, coord, coord, char *, char *);
|
|
extern int nav_map(int, int, int);
|
|
extern int bmaps_intersect(natid, natid);
|
|
extern int share_bmap(natid, natid, struct nstr_sect *, char, char *);
|
|
|
|
#endif
|