2 * Empire - A multi-player, client/server Internet based war game.
3 * Copyright (C) 1986-2015, Dave Pare, Jeff Bailey, Thomas Ruschak,
4 * Ken Stevens, Steve McClure, Markus Armbruster
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.
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.
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/>.
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.
27 * pr.c: Output to players
29 * Known contributors to this file:
30 * Dave Pare, 1986, 1989
31 * Steve McClure, 1998-2000
32 * Ron Koenderink, 2005
33 * Markus Armbruster, 2005-2012
37 * Player output is fully buffered. It can block only if the
38 * receiving player is the current player and his last command doesn't
39 * have the C_MOD flag. Output to another player must not block
40 * because that player could be gone when the printing thread wakes
41 * up, and the code isn't prepared for that. Output within C_MOD
42 * command never blocks, so that such commands can print freely
43 * without yielding the processor.
45 * Each line of output starts with an identification character
46 * encoding the output id, followed by space. Ids less than 10 are
47 * encoded as decimal digits, and larger ids as lower case letters,
48 * starting with 'a'. Symbolic names for ids are defined in proto.h.
62 #include "prototypes.h"
66 static void pr_player(struct player *pl, int id, char *buf);
67 static void upr_player(struct player *pl, int id, char *buf);
68 static void outid(struct player *pl, int n);
69 static void player_output_some(void);
72 * Print to current player similar to printf().
73 * Use printf-style FORMAT with the optional arguments.
74 * Note: `to print' without further qualifications means sending
84 (void)vsprintf(buf, format, ap);
86 if (player->flags & PF_UTF8)
87 /* normal text needs to be converted to user text */
88 upr_player(player, C_DATA, buf);
90 /* normal text and user text are identical */
91 pr_player(player, C_DATA, buf);
95 * Print UTF-8 text BUF to current player.
102 if (!(player->flags & PF_UTF8)) {
103 p = malloc(strlen(buf) + 1);
104 copy_utf8_to_ascii_no_funny(p, buf);
105 pr_player(player, C_DATA, p);
108 pr_player(player, C_DATA, buf);
112 * Send some text to P with id ID, line-buffered.
113 * Format text to send using printf-style FORMAT and optional
114 * arguments. It is assumed to be already user text. Plain ASCII and
115 * text received from the same player are fine, for anything else the
116 * caller has to deal with output filtering.
117 * If a partial line is buffered, terminate it with a newline first.
120 pr_id(struct player *p, int id, char *format, ...)
126 io_puts(p->iop, "\n");
127 journal_output(p, p->curid, "\n");
130 va_start(ap, format);
131 (void)vsprintf(buf, format, ap);
133 pr_player(p, id, buf);
137 * Send C_FLASH text to PL.
138 * Format text to send using printf-style FORMAT and optional
139 * arguments. It is assumed to be UTF-8.
140 * Initiate an output queue flush, but do not wait for it to complete.
143 pr_flash(struct player *pl, char *format, ...)
145 char buf[4096]; /* UTF-8 */
148 if (pl->state != PS_PLAYING)
150 va_start(ap, format);
151 (void)vsprintf(buf, format, ap);
153 if (!(pl->flags & PF_UTF8))
154 copy_utf8_to_ascii_no_funny(buf, buf);
155 pr_player(pl, C_FLASH, buf);
156 io_output(pl->iop, 0);
160 * Send C_INFORM text to PL.
161 * Format text to send using printf-style FORMAT and optional
162 * arguments. It is assumed to be plain ASCII.
163 * Initiate an output queue flush, but do not wait for it to complete.
166 pr_inform(struct player *pl, char *format, ...)
171 if (pl->state != PS_PLAYING)
173 va_start(ap, format);
174 (void)vsprintf(buf, format, ap);
176 pr_player(pl, C_INFORM, buf);
177 io_output(pl->iop, 0);
181 * Send C_FLASH text to everyone.
182 * Format text to send using printf-style FORMAT and optional
183 * arguments. It is assumed to be plain ASCII.
184 * Prefix text it with a header suitable for broadcast from deity.
185 * Initiate an output queue flush, but do not wait for it to complete.
188 pr_wall(char *format, ...)
192 char buf[4096]; /* UTF-8 */
198 tm = localtime(&now);
199 n = sprintf(buf, "BROADCAST from %s @ %02d:%02d: ",
200 getnatp(0)->nat_cnam, tm->tm_hour, tm->tm_min);
202 va_start(ap, format);
203 (void)vsprintf(buf + n, format, ap);
205 for (p = player_next(NULL); p; p = player_next(p)) {
206 if (p->state != PS_PLAYING)
208 pr_player(p, C_FLASH, buf);
209 io_output(p->iop, 0);
214 * Send ID text BUF to PL, line-buffered.
216 * If a partial line with different id is buffered, terminate it with
220 pr_player(struct player *pl, int id, char *buf)
226 journal_output(pl, id, buf);
229 while (*bp != '\0') {
230 if (pl->curid != -1 && pl->curid != id) {
231 io_puts(pl->iop, "\n");
236 p = strchr(bp, '\n');
239 io_write(pl->iop, bp, len);
243 len = io_puts(pl->iop, bp);
249 player_output_some();
253 * Send ID text BUF to PL, line-buffered.
254 * This function translates from normal text to user text.
255 * If a partial line with different id is buffered, terminate it with
259 upr_player(struct player *pl, int id, char *buf)
266 journal_output(pl, id, buf);
272 while ((ch = *bp++)) {
273 if (pl->curid != -1 && pl->curid != id) {
274 io_puts(pl->iop, "\n");
283 io_puts(pl->iop, printbuf);
290 io_puts(pl->iop, printbuf);
295 io_write(pl->iop, &ch, 1);
299 io_puts(pl->iop, printbuf);
304 player_output_some();
309 * This runs always at the beginning of a line.
312 outid(struct player *pl, int n)
316 if (CANT_HAPPEN(n > C_LAST))
320 buf[0] = 'a' - 10 + n;
325 io_puts(pl->iop, buf);
330 player_output_some(void)
332 time_t deadline = player_io_deadline(player, 1);
334 while (io_output_if_queue_long(player->iop, deadline) > 0)
339 * Send redirection request REDIR to the current player.
340 * REDIR is UTF-8, but non-ASCII characters can occur only if the
341 * player sent them. Therefore, it is also user text.
346 pr_id(player, *redir == '>' ? C_REDIR : C_PIPE, "%s\n", redir);
350 * Send script execute request FILE to the current player.
351 * FILE is UTF-8, but non-ASCII characters can occur only if the
352 * player sent them. Therefore, it is also user text.
357 pr_id(player, C_EXECUTE, "%s\n", file);
361 * Send a command prompt to the current player.
364 prprompt(int min, int btu)
366 pr_id(player, C_PROMPT, "%d %d\n", min, btu);
370 * Prompt for a line of non-command input.
371 * Send C_FLUSH prompt PROMPT to the current player.
372 * Read a line of input into BUF[SIZE] and convert it to ASCII.
373 * This may block for input, yielding the processor. Flush buffered
374 * output when blocking, to make sure player sees the prompt.
375 * Return number of bytes in BUF[], not counting the terminating 0,
379 prmptrd(char *prompt, char *buf, int size)
383 if (CANT_HAPPEN(!prompt))
386 pr_id(player, C_FLUSH, "%s\n", prompt);
387 if ((r = recvclient(buf, size)) < 0)
389 time(&player->curup);
392 if (player->flags & PF_UTF8)
393 return copy_utf8_to_ascii_no_funny(buf, buf);
394 return copy_ascii_no_funny(buf, buf);
398 * Prompt for a line of non-command, UTF-8 input.
399 * Send C_FLUSH prompt PROMPT to the current player.
400 * Read a line of input into BUF[SIZE], replacing funny characters by
401 * '?'. The result is UTF-8.
402 * This may block for input, yielding the processor. Flush buffered
403 * output when blocking, to make sure player sees the prompt.
404 * Return number of bytes in BUF[], not counting the terminating 0,
408 uprmptrd(char *prompt, char *buf, int size)
412 if (CANT_HAPPEN(!prompt))
415 pr_id(player, C_FLUSH, "%s\n", prompt);
416 if ((r = recvclient(buf, size)) < 0)
418 time(&player->curup);
421 if (player->flags & PF_UTF8)
422 return copy_utf8_no_funny(buf, buf);
423 return copy_ascii_no_funny(buf, buf);
427 * Print the current time in ctime() format.
439 * Print coordinates X, Y.
440 * FORMAT must be a printf-style format string that converts exactly
444 prxy(char *format, coord x, coord y)
448 np = getnatp(player->cnum);
449 pr(format, xrel(np, x), yrel(np, y));
453 * Sound the current player's bell.
458 struct natstr *np = getnatp(player->cnum);
460 if (np->nat_flags & NF_BEEP)
465 * Print complete lines to country CN similar to printf().
466 * Use printf-style FORMAT with the optional arguments. FORMAT must
468 * If CN is zero, don't print anything.
469 * Else, if CN is the current player and we're not in the update,
470 * print just like pr(). Else print into a bulletin.
471 * Because printing like pr() requires normal text, and bulletins
472 * require user text, only plain ASCII is allowed.
475 mpr(int cn, char *format, ...)
480 CANT_HAPPEN(!format[0] || format[strlen(format) - 1] != '\n');
483 va_start(ap, format);
484 (void)vsprintf(buf, format, ap);
486 if (update_running || cn != player->cnum)
487 wu(0, cn, "%s", buf);
489 pr_player(player, C_DATA, buf);
493 * Copy SRC without funny characters to DST.
494 * Drop control characters, except for '\t'.
495 * Replace non-ASCII characters by '?'.
496 * Return length of DST.
497 * DST must have space. If it overlaps SRC, then DST <= SRC must
501 copy_ascii_no_funny(char *dst, char *src)
507 while ((ch = *src++)) {
508 if ((ch < 0x20 && ch != '\t' && ch != '\n') || ch == 0x7f)
509 ; /* ignore funny control */
511 *p++ = '?'; /* replace non-ASCII */
521 * Copy UTF-8 SRC without funny characters to DST.
522 * Drop control characters, except for '\t'.
523 * FIXME Replace malformed UTF-8 sequences by '?'.
524 * Return byte length of DST.
525 * DST must have space. If it overlaps SRC, then DST <= SRC must
529 copy_utf8_no_funny(char *dst, char *src)
535 while ((ch = *src++)) {
536 /* FIXME do the right thing for malformed and overlong sequences */
537 if ((ch < 0x20 && ch != '\t' && ch != '\n') || ch == 0x7f)
538 ; /* ignore funny control */
548 * Copy UTF-8 SRC without funny characters to ASCII DST.
549 * Drop control characters, except for '\t'.
550 * Replace non-ASCII characters by '?'.
551 * Return length of DST.
552 * DST must have space. If it overlaps SRC, then DST <= SRC must
556 copy_utf8_to_ascii_no_funny(char *dst, char *src)
562 while ((ch = *src++)) {
563 /* FIXME do the right thing for malformed and overlong sequences */
564 if ((ch < 0x20 && ch != '\t' && ch != '\n') || ch == 0x7f)
565 ; /* ignore funny control */
566 else if (ch > 0x7f) {
567 *p++ = '?'; /* replace non-ASCII */
568 while ((*src & 0xc0) == 0x80)
579 * Return byte-index of the N-th UTF-8 character in UTF-8 string S.
580 * If S doesn't have that many characters, return its length instead.
583 ufindpfx(char *s, int n)
588 if ((s[i++] & 0xc0) == 0xc0)
589 while ((s[i] & 0xc0) == 0x80)