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
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-2011
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.
63 #include "prototypes.h"
68 static void pr_player(struct player *pl, int id, char *buf);
69 static void upr_player(struct player *pl, int id, char *buf);
70 static void outid(struct player *pl, int n);
73 * Print to current player similar to printf().
74 * Use printf-style FORMAT with the optional arguments.
75 * Note: `to print' without further qualifications means sending
85 (void)vsprintf(buf, format, ap);
87 if (player->flags & PF_UTF8)
88 /* normal text needs to be converted to user text */
89 upr_player(player, C_DATA, buf);
91 /* normal text and user text are identical */
92 pr_player(player, C_DATA, buf);
96 * Print UTF-8 text BUF to current player.
103 if (!(player->flags & PF_UTF8)) {
104 p = malloc(strlen(buf) + 1);
105 copy_utf8_to_ascii_no_funny(p, buf);
106 pr_player(player, C_DATA, p);
109 pr_player(player, C_DATA, buf);
113 * Send some text to P with id ID, line-buffered.
114 * Format text to send using printf-style FORMAT and optional
115 * arguments. It is assumed to be already user text. Plain ASCII and
116 * text received from the same player are fine, for anything else the
117 * caller has to deal with output filtering.
118 * If a partial line is buffered, terminate it with a newline first.
121 pr_id(struct player *p, int id, char *format, ...)
127 io_puts(p->iop, "\n");
128 journal_output(p, p->curid, "\n");
131 va_start(ap, format);
132 (void)vsprintf(buf, format, ap);
134 pr_player(p, id, buf);
138 * Send C_FLASH text to PL.
139 * Format text to send using printf-style FORMAT and optional
140 * arguments. It is assumed to be UTF-8.
141 * Initiate an output queue flush, but do not wait for it to complete.
144 pr_flash(struct player *pl, char *format, ...)
146 char buf[4096]; /* UTF-8 */
149 if (pl->state != PS_PLAYING)
151 va_start(ap, format);
152 (void)vsprintf(buf, format, ap);
154 if (!(pl->flags & PF_UTF8))
155 copy_utf8_to_ascii_no_funny(buf, buf);
156 pr_player(pl, C_FLASH, buf);
157 io_output(pl->iop, 0);
161 * Send C_INFORM text to PL.
162 * Format text to send using printf-style FORMAT and optional
163 * arguments. It is assumed to be plain ASCII.
164 * Initiate an output queue flush, but do not wait for it to complete.
167 pr_inform(struct player *pl, char *format, ...)
172 if (pl->state != PS_PLAYING)
174 va_start(ap, format);
175 (void)vsprintf(buf, format, ap);
177 pr_player(pl, C_INFORM, buf);
178 io_output(pl->iop, 0);
182 * Send C_FLASH text to everyone.
183 * Format text to send using printf-style FORMAT and optional
184 * arguments. It is assumed to be plain ASCII.
185 * Prefix text it with a header suitable for broadcast from deity.
186 * Initiate an output queue flush, but do not wait for it to complete.
189 pr_wall(char *format, ...)
193 char buf[4096]; /* UTF-8 */
199 tm = localtime(&now);
200 n = sprintf(buf, "BROADCAST from %s @ %02d:%02d: ",
201 getnatp(0)->nat_cnam, tm->tm_hour, tm->tm_min);
203 va_start(ap, format);
204 (void)vsprintf(buf + n, format, ap);
206 for (p = player_next(NULL); p; p = player_next(p)) {
207 if (p->state != PS_PLAYING)
209 pr_player(p, C_FLASH, buf);
210 io_output(p->iop, 0);
215 * Send ID text BUF to PL, line-buffered.
217 * If a partial line with different id is buffered, terminate it with
221 pr_player(struct player *pl, int id, char *buf)
227 journal_output(pl, id, buf);
230 while (*bp != '\0') {
231 if (pl->curid != -1 && pl->curid != id) {
232 io_puts(pl->iop, "\n");
237 p = strchr(bp, '\n');
240 io_write(pl->iop, bp, len);
244 len = io_puts(pl->iop, bp);
250 while (io_output_if_queue_long(pl->iop,
251 pl->may_sleep == PLAYER_SLEEP_FREELY) > 0)
257 * Send ID text BUF to PL, line-buffered.
258 * This function translates from normal text to user text.
259 * If a partial line with different id is buffered, terminate it with
263 upr_player(struct player *pl, int id, char *buf)
270 journal_output(pl, id, buf);
276 while ((ch = *bp++)) {
277 if (pl->curid != -1 && pl->curid != id) {
278 io_puts(pl->iop, "\n");
287 io_puts(pl->iop, printbuf);
294 io_puts(pl->iop, printbuf);
299 io_write(pl->iop, &ch, 1);
303 io_puts(pl->iop, printbuf);
308 while (io_output_if_queue_long(pl->iop,
309 pl->may_sleep == PLAYER_SLEEP_FREELY) > 0)
316 * This runs always at the beginning of a line.
319 outid(struct player *pl, int n)
323 if (CANT_HAPPEN(n > C_LAST))
327 buf[0] = 'a' - 10 + n;
332 io_puts(pl->iop, buf);
337 * Send redirection request REDIR to the current player.
338 * REDIR is UTF-8, but non-ASCII characters can occur only if the
339 * player sent them. Therefore, it is also user text.
344 pr_id(player, *redir == '>' ? C_REDIR : C_PIPE, "%s\n", redir);
348 * Send script execute request FILE to the current player.
349 * FILE is UTF-8, but non-ASCII characters can occur only if the
350 * player sent them. Therefore, it is also user text.
355 pr_id(player, C_EXECUTE, "%s\n", file);
359 * Send a command prompt to the current player.
362 prprompt(int min, int btu)
364 pr_id(player, C_PROMPT, "%d %d\n", min, btu);
368 * Prompt for a line of non-command input.
369 * Send C_FLUSH prompt PROMPT to the current player.
370 * Read a line of input into BUF[SIZE] and convert it to ASCII.
371 * This may block for input, yielding the processor. Flush buffered
372 * output when blocking, to make sure player sees the prompt.
373 * Return number of bytes in BUF[], not counting the terminating 0,
377 prmptrd(char *prompt, char *buf, int size)
381 if (CANT_HAPPEN(!prompt))
384 pr_id(player, C_FLUSH, "%s\n", prompt);
385 if ((r = recvclient(buf, size)) < 0)
387 time(&player->curup);
390 if (player->flags & PF_UTF8)
391 return copy_utf8_to_ascii_no_funny(buf, buf);
392 return copy_ascii_no_funny(buf, buf);
396 * Prompt for a line of non-command, UTF-8 input.
397 * Send C_FLUSH prompt PROMPT to the current player.
398 * Read a line of input into BUF[SIZE], replacing funny characters by
399 * '?'. The result is UTF-8.
400 * This may block for input, yielding the processor. Flush buffered
401 * output when blocking, to make sure player sees the prompt.
402 * Return number of bytes in BUF[], not counting the terminating 0,
406 uprmptrd(char *prompt, char *buf, int size)
410 if (CANT_HAPPEN(!prompt))
413 pr_id(player, C_FLUSH, "%s\n", prompt);
414 if ((r = recvclient(buf, size)) < 0)
416 time(&player->curup);
419 if (player->flags & PF_UTF8)
420 return copy_utf8_no_funny(buf, buf);
421 return copy_ascii_no_funny(buf, buf);
425 * Print the current time in ctime() format.
437 * Print coordinates X, Y.
438 * FORMAT must be a printf-style format string that converts exactly
442 prxy(char *format, coord x, coord y)
446 np = getnatp(player->cnum);
447 pr(format, xrel(np, x), yrel(np, y));
451 * Sound the current player's bell.
456 struct natstr *np = getnatp(player->cnum);
458 if (np->nat_flags & NF_BEEP)
463 * Print complete lines to country CN similar to printf().
464 * Use printf-style FORMAT with the optional arguments. FORMAT must
466 * If CN is zero, don't print anything.
467 * Else, if CN is the current player and we're not in the update,
468 * print just like pr(). Else print into a bulletin.
469 * Because printing like pr() requires normal text, and bulletins
470 * require user text, only plain ASCII is allowed.
473 mpr(int cn, char *format, ...)
478 CANT_HAPPEN(!format[0] || format[strlen(format) - 1] != '\n');
481 va_start(ap, format);
482 (void)vsprintf(buf, format, ap);
484 if (update_running || cn != player->cnum)
485 wu(0, cn, "%s", buf);
487 pr_player(player, C_DATA, buf);
491 * Copy SRC without funny characters to DST.
492 * Drop control characters, except for '\t'.
493 * Replace non-ASCII characters by '?'.
494 * Return length of DST.
495 * DST must have space. If it overlaps SRC, then DST <= SRC must
499 copy_ascii_no_funny(char *dst, char *src)
505 while ((ch = *src++)) {
506 if ((ch < 0x20 && ch != '\t' && ch != '\n') || ch == 0x7f)
507 ; /* ignore funny control */
509 *p++ = '?'; /* replace non-ASCII */
519 * Copy UTF-8 SRC without funny characters to DST.
520 * Drop control characters, except for '\t'.
521 * FIXME Replace malformed UTF-8 sequences by '?'.
522 * Return byte length of DST.
523 * DST must have space. If it overlaps SRC, then DST <= SRC must
527 copy_utf8_no_funny(char *dst, char *src)
533 while ((ch = *src++)) {
534 /* FIXME do the right thing for malformed and overlong sequences */
535 if ((ch < 0x20 && ch != '\t' && ch != '\n') || ch == 0x7f)
536 ; /* ignore funny control */
546 * Copy UTF-8 SRC without funny characters to ASCII DST.
547 * Drop control characters, except for '\t'.
548 * Replace non-ASCII characters by '?'.
549 * Return length of DST.
550 * DST must have space. If it overlaps SRC, then DST <= SRC must
554 copy_utf8_to_ascii_no_funny(char *dst, char *src)
560 while ((ch = *src++)) {
561 /* FIXME do the right thing for malformed and overlong sequences */
562 if ((ch < 0x20 && ch != '\t' && ch != '\n') || ch == 0x7f)
563 ; /* ignore funny control */
564 else if (ch > 0x7f) {
565 *p++ = '?'; /* replace non-ASCII */
566 while ((*src & 0xc0) == 0x80)
577 * Return byte-index of the N-th UTF-8 character in UTF-8 string S.
578 * If S doesn't have that many characters, return its length instead.
581 ufindpfx(char *s, int n)
586 if ((s[i++] & 0xc0) == 0xc0)
587 while ((s[i] & 0xc0) == 0x80)