2 * Empire - A multi-player, client/server Internet based war game.
3 * Copyright (C) 1986-2010, Dave Pare, Jeff Bailey, Thomas Ruschak,
4 * Ken Stevens, Steve McClure
6 * This program 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 2 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, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 * See files README, COPYING and CREDITS in the root of the source
23 * tree for related information and legal notices. It is expected
24 * that future projects/authors will amend these files as needed.
28 * pr.c: Output to players
30 * Known contributors to this file:
31 * Dave Pare, 1986, 1989
32 * Steve McClure, 1998-2000
33 * Ron Koenderink, 2005
34 * Markus Armbruster, 2005-2009
38 * Player output is fully buffered. It can block only if the
39 * receiving player is the current player and his last command doesn't
40 * have the C_MOD flag. Output to another player must not block
41 * because that player could be gone when the printing thread wakes
42 * up, and the code isn't prepared for that. Output within C_MOD
43 * command never blocks, so that such commands can print freely
44 * without yielding the processor.
46 * Each line of output starts with an identification character
47 * encoding the output id, followed by space. Ids less than 10 are
48 * encoded as decimal digits, and larger ids as lower case letters,
49 * starting with 'a'. Symbolic names for ids are defined in proto.h.
64 #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, "\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)
228 while (*bp != '\0') {
229 if (pl->curid != -1 && pl->curid != id) {
230 io_puts(pl->iop, "\n");
235 p = strchr(bp, '\n');
238 io_write(pl->iop, bp, len);
242 len = io_puts(pl->iop, bp);
247 journal_output(pl, buf);
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)
274 while ((ch = *bp++)) {
275 if (pl->curid != -1 && pl->curid != id) {
276 io_puts(pl->iop, "\n");
285 io_puts(pl->iop, printbuf);
292 io_puts(pl->iop, printbuf);
297 io_write(pl->iop, &ch, 1);
301 io_puts(pl->iop, printbuf);
305 journal_output(pl, buf);
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);
333 journal_output(pl, buf);
338 * Send redirection request REDIR to the current player.
339 * REDIR is UTF-8, but non-ASCII characters can occur only if the
340 * player sent them. Therefore, it is also user text.
345 pr_id(player, *redir == '>' ? C_REDIR : C_PIPE, "%s\n", redir);
349 * Send script execute request FILE to the current player.
350 * REDIR is UTF-8, but non-ASCII characters can occur only if the
351 * player sent them. Therefore, it is also user text.
356 pr_id(player, C_EXECUTE, "%s\n", file);
360 * Send a command prompt to the current player.
363 prprompt(int min, int btu)
365 pr_id(player, C_PROMPT, "%d %d\n", min, btu);
369 * Prompt for a line of non-command input.
370 * Send C_FLUSH prompt PROMPT to the current player.
371 * Read a line of input into BUF[SIZE] and convert it to ASCII.
372 * This may block for input, yielding the processor. Flush buffered
373 * output when blocking, to make sure player sees the prompt.
374 * Return number of bytes in BUF[], not counting the terminating 0,
378 prmptrd(char *prompt, char *buf, int size)
382 if (CANT_HAPPEN(!prompt))
385 pr_id(player, C_FLUSH, "%s\n", prompt);
386 if ((r = recvclient(buf, size)) < 0)
388 time(&player->curup);
391 if (player->flags & PF_UTF8)
392 return copy_utf8_to_ascii_no_funny(buf, buf);
393 return copy_ascii_no_funny(buf, buf);
397 * Prompt for a line of non-command, UTF-8 input.
398 * Send C_FLUSH prompt PROMPT to the current player.
399 * Read a line of input into BUF[SIZE], replacing funny characters by
400 * '?'. The result is UTF-8.
401 * This may block for input, yielding the processor. Flush buffered
402 * output when blocking, to make sure player sees the prompt.
403 * Return number of bytes in BUF[], not counting the terminating 0,
407 uprmptrd(char *prompt, char *buf, int size)
411 if (CANT_HAPPEN(!prompt))
414 pr_id(player, C_FLUSH, "%s\n", prompt);
415 if ((r = recvclient(buf, size)) < 0)
417 time(&player->curup);
420 if (player->flags & PF_UTF8)
421 return copy_utf8_no_funny(buf, buf);
422 return copy_ascii_no_funny(buf, buf);
426 * Print the current time in ctime() format.
438 * Print coordinates X, Y for COUNTRY.
439 * FORMAT must be a printf-style format string that converts exactly
443 prxy(char *format, coord x, coord y, natid country)
447 np = getnatp(country);
448 pr(format, xrel(np, x), yrel(np, y));
452 * Print to country CN similar to printf().
453 * Use printf-style FORMAT with the optional arguments.
454 * Output is buffered until a newline arrives.
455 * If CN is the current player and we're not in the update, print just
456 * like pr(). Else print into a bulletin.
457 * Because printing like pr() requires normal text, and bulletins
458 * require user text, only plain ASCII is allowed.
461 PR(int cn, char *format, ...)
463 /* XXX should really do this on a per-nation basis */
464 static char longline[MAXNOC][512];
469 va_start(ap, format);
470 (void)vsprintf(buf, format, ap);
472 newline = strrchr(buf, '\n') ? 1 : 0;
473 strcat(longline[cn], buf);
475 if (update_running || (cn && cn != player->cnum))
476 typed_wu(0, cn, longline[cn], TEL_BULLETIN);
478 pr_player(player, C_DATA, longline[cn]);
479 longline[cn][0] = '\0';
484 * Print the current time in ctime() format to country CN.
485 * If CN is the current player and we're not in the update, print just
486 * like prdate(). Else print into a bulletin.
498 * Sound the current player's bell.
503 struct natstr *np = getnatp(player->cnum);
505 if (np->nat_flags & NF_BEEP)
510 * Print to country CN similar to printf().
511 * Use printf-style FORMAT with the optional arguments.
512 * If CN is zero, don't print anything.
513 * Else, if CN is the current player and we're not in the update,
514 * print just like pr(). Else print into a bulletin.
515 * Because printing like pr() requires normal text, and bulletins
516 * require user text, only plain ASCII is allowed.
519 mpr(int cn, char *format, ...)
526 va_start(ap, format);
527 (void)vsprintf(buf, format, ap);
529 if (update_running || cn != player->cnum)
530 typed_wu(0, cn, buf, TEL_BULLETIN);
532 pr_player(player, C_DATA, buf);
536 * Copy SRC without funny characters to DST.
537 * Drop control characters, except for '\t'.
538 * Replace non-ASCII characters by '?'.
539 * Return length of DST.
540 * DST must have space. If it overlaps SRC, then DST <= SRC must
544 copy_ascii_no_funny(char *dst, char *src)
550 while ((ch = *src++)) {
551 if ((ch < 0x20 && ch != '\t' && ch != '\n') || ch == 0x7f)
552 ; /* ignore funny control */
554 *p++ = '?'; /* replace non-ASCII */
564 * Copy UTF-8 SRC without funny characters to DST.
565 * Drop control characters, except for '\t'.
566 * FIXME Replace malformed UTF-8 sequences by '?'.
567 * Return byte length of DST.
568 * DST must have space. If it overlaps SRC, then DST <= SRC must
572 copy_utf8_no_funny(char *dst, char *src)
578 while ((ch = *src++)) {
579 /* FIXME do the right thing for malformed and overlong sequences */
580 if ((ch < 0x20 && ch != '\t' && ch != '\n') || ch == 0x7f)
581 ; /* ignore funny control */
591 * Copy UTF-8 SRC without funny characters to ASCII DST.
592 * Drop control characters, except for '\t'.
593 * Replace non-ASCII characters by '?'.
594 * Return length of DST.
595 * DST must have space. If it overlaps SRC, then DST <= SRC must
599 copy_utf8_to_ascii_no_funny(char *dst, char *src)
605 while ((ch = *src++)) {
606 /* FIXME do the right thing for malformed and overlong sequences */
607 if ((ch < 0x20 && ch != '\t' && ch != '\n') || ch == 0x7f)
608 ; /* ignore funny control */
609 else if (ch > 0x7f) {
610 *p++ = '?'; /* replace non-ASCII */
611 while ((*src++ & 0xc0) == 0x80) ;
621 * Return byte-index of the N-th UTF-8 character in UTF-8 string S.
622 * If S doesn't have that many characters, return its length instead.
625 ufindpfx(char *s, int n)
631 if ((s[i++] & 0xc0) == 0xc0)
632 while ((s[i] & 0xc0) == 0x80)