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");
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)
227 while (*bp != '\0') {
228 if (pl->curid != -1 && pl->curid != id) {
229 io_puts(pl->iop, "\n");
234 p = strchr(bp, '\n');
237 io_write(pl->iop, bp, len);
241 len = io_puts(pl->iop, bp);
246 journal_output(pl, id, buf);
249 while (io_output_if_queue_long(pl->iop,
250 pl->may_sleep == PLAYER_SLEEP_FREELY) > 0)
256 * Send ID text BUF to PL, line-buffered.
257 * This function translates from normal text to user text.
258 * If a partial line with different id is buffered, terminate it with
262 upr_player(struct player *pl, int id, char *buf)
273 while ((ch = *bp++)) {
274 if (pl->curid != -1 && pl->curid != id) {
275 io_puts(pl->iop, "\n");
284 io_puts(pl->iop, printbuf);
291 io_puts(pl->iop, printbuf);
296 io_write(pl->iop, &ch, 1);
300 io_puts(pl->iop, printbuf);
304 journal_output(pl, id, buf);
307 while (io_output_if_queue_long(pl->iop,
308 pl->may_sleep == PLAYER_SLEEP_FREELY) > 0)
315 * This runs always at the beginning of a line.
318 outid(struct player *pl, int n)
322 if (CANT_HAPPEN(n > C_LAST))
326 buf[0] = 'a' - 10 + n;
331 io_puts(pl->iop, buf);
336 * Send redirection request REDIR to the current player.
337 * REDIR is UTF-8, but non-ASCII characters can occur only if the
338 * player sent them. Therefore, it is also user text.
343 pr_id(player, *redir == '>' ? C_REDIR : C_PIPE, "%s\n", redir);
347 * Send script execute request FILE to the current player.
348 * REDIR is UTF-8, but non-ASCII characters can occur only if the
349 * player sent them. Therefore, it is also user text.
354 pr_id(player, C_EXECUTE, "%s\n", file);
358 * Send a command prompt to the current player.
361 prprompt(int min, int btu)
363 pr_id(player, C_PROMPT, "%d %d\n", min, btu);
367 * Prompt for a line of non-command input.
368 * Send C_FLUSH prompt PROMPT to the current player.
369 * Read a line of input into BUF[SIZE] and convert it to ASCII.
370 * This may block for input, yielding the processor. Flush buffered
371 * output when blocking, to make sure player sees the prompt.
372 * Return number of bytes in BUF[], not counting the terminating 0,
376 prmptrd(char *prompt, char *buf, int size)
380 if (CANT_HAPPEN(!prompt))
383 pr_id(player, C_FLUSH, "%s\n", prompt);
384 if ((r = recvclient(buf, size)) < 0)
386 time(&player->curup);
389 if (player->flags & PF_UTF8)
390 return copy_utf8_to_ascii_no_funny(buf, buf);
391 return copy_ascii_no_funny(buf, buf);
395 * Prompt for a line of non-command, UTF-8 input.
396 * Send C_FLUSH prompt PROMPT to the current player.
397 * Read a line of input into BUF[SIZE], replacing funny characters by
398 * '?'. The result is UTF-8.
399 * This may block for input, yielding the processor. Flush buffered
400 * output when blocking, to make sure player sees the prompt.
401 * Return number of bytes in BUF[], not counting the terminating 0,
405 uprmptrd(char *prompt, char *buf, int size)
409 if (CANT_HAPPEN(!prompt))
412 pr_id(player, C_FLUSH, "%s\n", prompt);
413 if ((r = recvclient(buf, size)) < 0)
415 time(&player->curup);
418 if (player->flags & PF_UTF8)
419 return copy_utf8_no_funny(buf, buf);
420 return copy_ascii_no_funny(buf, buf);
424 * Print the current time in ctime() format.
436 * Print coordinates X, Y for COUNTRY.
437 * FORMAT must be a printf-style format string that converts exactly
441 prxy(char *format, coord x, coord y, natid country)
445 np = getnatp(country);
446 pr(format, xrel(np, x), yrel(np, y));
450 * Print to country CN similar to printf().
451 * Use printf-style FORMAT with the optional arguments.
452 * Output is buffered until a newline arrives.
453 * If CN is the current player and we're not in the update, print just
454 * like pr(). Else print into a bulletin.
455 * Because printing like pr() requires normal text, and bulletins
456 * require user text, only plain ASCII is allowed.
459 PR(int cn, char *format, ...)
461 /* XXX should really do this on a per-nation basis */
462 static char longline[MAXNOC][512];
467 va_start(ap, format);
468 (void)vsprintf(buf, format, ap);
470 newline = strrchr(buf, '\n') ? 1 : 0;
471 strcat(longline[cn], buf);
473 if (update_running || (cn && cn != player->cnum))
474 typed_wu(0, cn, longline[cn], TEL_BULLETIN);
476 pr_player(player, C_DATA, longline[cn]);
477 longline[cn][0] = '\0';
482 * Print the current time in ctime() format to country CN.
483 * If CN is the current player and we're not in the update, print just
484 * like prdate(). Else print into a bulletin.
496 * Sound the current player's bell.
501 struct natstr *np = getnatp(player->cnum);
503 if (np->nat_flags & NF_BEEP)
508 * Print to country CN similar to printf().
509 * Use printf-style FORMAT with the optional arguments.
510 * If CN is zero, don't print anything.
511 * Else, if CN is the current player and we're not in the update,
512 * print just like pr(). Else print into a bulletin.
513 * Because printing like pr() requires normal text, and bulletins
514 * require user text, only plain ASCII is allowed.
517 mpr(int cn, char *format, ...)
524 va_start(ap, format);
525 (void)vsprintf(buf, format, ap);
527 if (update_running || cn != player->cnum)
528 typed_wu(0, cn, buf, TEL_BULLETIN);
530 pr_player(player, C_DATA, buf);
534 * Copy SRC without funny characters to DST.
535 * Drop control characters, except for '\t'.
536 * Replace non-ASCII characters by '?'.
537 * Return length of DST.
538 * DST must have space. If it overlaps SRC, then DST <= SRC must
542 copy_ascii_no_funny(char *dst, char *src)
548 while ((ch = *src++)) {
549 if ((ch < 0x20 && ch != '\t' && ch != '\n') || ch == 0x7f)
550 ; /* ignore funny control */
552 *p++ = '?'; /* replace non-ASCII */
562 * Copy UTF-8 SRC without funny characters to DST.
563 * Drop control characters, except for '\t'.
564 * FIXME Replace malformed UTF-8 sequences by '?'.
565 * Return byte length of DST.
566 * DST must have space. If it overlaps SRC, then DST <= SRC must
570 copy_utf8_no_funny(char *dst, char *src)
576 while ((ch = *src++)) {
577 /* FIXME do the right thing for malformed and overlong sequences */
578 if ((ch < 0x20 && ch != '\t' && ch != '\n') || ch == 0x7f)
579 ; /* ignore funny control */
589 * Copy UTF-8 SRC without funny characters to ASCII DST.
590 * Drop control characters, except for '\t'.
591 * Replace non-ASCII characters by '?'.
592 * Return length of DST.
593 * DST must have space. If it overlaps SRC, then DST <= SRC must
597 copy_utf8_to_ascii_no_funny(char *dst, char *src)
603 while ((ch = *src++)) {
604 /* FIXME do the right thing for malformed and overlong sequences */
605 if ((ch < 0x20 && ch != '\t' && ch != '\n') || ch == 0x7f)
606 ; /* ignore funny control */
607 else if (ch > 0x7f) {
608 *p++ = '?'; /* replace non-ASCII */
609 while ((*src++ & 0xc0) == 0x80) ;
619 * Return byte-index of the N-th UTF-8 character in UTF-8 string S.
620 * If S doesn't have that many characters, return its length instead.
623 ufindpfx(char *s, int n)
629 if ((s[i++] & 0xc0) == 0xc0)
630 while ((s[i] & 0xc0) == 0x80)