2 * Empire - A multi-player, client/server Internet based war game.
3 * Copyright (C) 1986-2006, 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
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.
67 #include "prototypes.h"
69 static void pr_player(struct player *pl, int id, char *buf);
70 static void upr_player(struct player *pl, int id, char *buf);
71 static void outid(struct player *pl, int n);
74 * Print to current player similar to printf().
75 * Use printf-style FORMAT with the optional arguments.
76 * Note: `to print' without further qualifications means sending
86 (void)vsprintf(buf, format, ap);
88 if (player->flags & PF_UTF8)
89 /* normal text needs to be converted to user text */
90 upr_player(player, C_DATA, buf);
92 /* normal text and user text are identical */
93 pr_player(player, C_DATA, buf);
97 * Print UTF-8 text BUF to current player.
104 if (!(player->flags & PF_UTF8)) {
105 p = malloc(strlen(buf) + 1);
106 copy_utf8_to_ascii_no_funny(p, buf);
107 pr_player(player, C_DATA, p);
110 pr_player(player, C_DATA, buf);
114 * Send some text to P with id ID, line-buffered.
115 * Format text to send using printf-style FORMAT and optional
116 * arguments. It is assumed to be already user text. Plain ASCII and
117 * text received from the same player are fine, for anything else the
118 * caller has to deal with output filtering.
119 * If a partial line is buffered, terminate it with a newline first.
122 pr_id(struct player *p, int id, char *format, ...)
128 io_puts(p->iop, "\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, IO_NOWAIT);
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, IO_NOWAIT);
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 * Initiate an output queue flush, but do not wait for it to complete.
188 pr_wall(char *format, ...)
190 char buf[4096]; /* UTF-8 */
194 va_start(ap, format);
195 (void)vsprintf(buf, format, ap);
197 for (p = player_next(0); p; p = player_next(p)) {
198 if (p->state != PS_PLAYING)
200 pr_player(p, C_FLASH, buf);
201 io_output(p->iop, IO_NOWAIT);
206 * Send ID text BUF to PL, line-buffered.
208 * If a partial line with different id is buffered, terminate it with
212 pr_player(struct player *pl, int id, char *buf)
219 while (*bp != '\0') {
220 if (pl->curid != -1 && pl->curid != id) {
221 io_puts(pl->iop, "\n");
226 p = strchr(bp, '\n');
229 if ((pl->command && (pl->command->c_flags & C_MOD)) ||
231 io_write(pl->iop, bp, len, IO_NOWAIT);
233 io_write(pl->iop, bp, len, IO_WAIT);
237 len = io_puts(pl->iop, bp);
244 * Send ID text BUF to PL, line-buffered.
245 * This function translates from normal text to user text.
246 * If a partial line with different id is buffered, terminate it with
250 upr_player(struct player *pl, int id, char *buf)
261 while ((ch = *bp++)) {
262 if (pl->curid != -1 && pl->curid != id) {
263 io_puts(pl->iop, "\n");
272 io_puts(pl->iop, printbuf);
279 io_puts(pl->iop, printbuf);
284 if ((pl->command && (pl->command->c_flags & C_MOD)) ||
286 io_write(pl->iop, &ch, 1, IO_NOWAIT);
288 io_write(pl->iop, &ch, 1, IO_WAIT);
292 io_puts(pl->iop, printbuf);
299 * This runs always at the beginning of a line.
302 outid(struct player *pl, int n)
306 if (CANT_HAPPEN(n > C_LAST))
310 buf[0] = 'a' - 10 + n;
315 io_puts(pl->iop, buf);
320 * Send redirection request REDIR to the current player.
321 * REDIR is UTF-8, but non-ASCII characters can occur only if the
322 * player sent them. Therefore, it is also user text.
327 pr_id(player, *redir == '>' ? C_REDIR : C_PIPE, "%s\n", redir);
331 * Send script execute request FILE to the current player.
332 * REDIR is UTF-8, but non-ASCII characters can occur only if the
333 * player sent them. Therefore, it is also user text.
338 pr_id(player, C_EXECUTE, "%s\n", file);
342 * Send a command prompt to the current player.
345 prprompt(int min, int btu)
347 pr_id(player, C_PROMPT, "%d %d\n", min, btu);
351 * Prompt for a line of non-command input.
352 * Send C_FLUSH prompt PROMPT to the current player.
353 * Read a line of input into BUF[SIZE] and convert it to ASCII.
354 * This may block for input, yielding the processor. Flush buffered
355 * output when blocking, to make sure player sees the prompt.
356 * Return number of bytes in BUF[], not counting the terminating 0,
360 prmptrd(char *prompt, char *buf, int size)
365 * Each prompt must consume one line of input. recvclient()
366 * doesn't do that while player->aborted.
368 CANT_HAPPEN(player->aborted);
370 if (CANT_HAPPEN(!prompt))
373 pr_id(player, C_FLUSH, "%s\n", prompt);
374 if ((r = recvclient(buf, size)) < 0)
376 time(&player->curup);
379 if (player->flags & PF_UTF8)
380 return copy_utf8_to_ascii_no_funny(buf, buf);
381 return copy_ascii_no_funny(buf, buf);
385 * Prompt for a line of non-command, UTF-8 input.
386 * Send C_FLUSH prompt PROMPT to the current player.
387 * Read a line of input into BUF[SIZE], replacing funny characters by
388 * '?'. The result is UTF-8.
389 * This may block for input, yielding the processor. Flush buffered
390 * output when blocking, to make sure player sees the prompt.
391 * Return number of bytes in BUF[], not counting the terminating 0,
395 uprmptrd(char *prompt, char *buf, int size)
400 CANT_HAPPEN(player->aborted);
402 if (CANT_HAPPEN(!prompt))
405 pr_id(player, C_FLUSH, "%s\n", prompt);
406 if ((r = recvclient(buf, size)) < 0)
408 time(&player->curup);
411 if (player->flags & PF_UTF8)
412 return copy_utf8_no_funny(buf, buf);
413 return copy_ascii_no_funny(buf, buf);
417 * Print the current time in ctime() format.
429 * Print coordinates X, Y for COUNTRY.
430 * FORMAT must be a printf-style format string that converts exactly
434 prxy(char *format, coord x, coord y, natid country)
438 np = getnatp(country);
439 pr(format, xrel(np, x), yrel(np, y));
443 * Print to country CN similar to printf().
444 * Use printf-style FORMAT with the optional arguments.
445 * Output is buffered until a newline arrives.
446 * If CN is the current player and we're not in the update, print just
447 * like pr(). Else print into a bulletin.
448 * Because printing like pr() requires normal text, and bulletins
449 * require user text, only plain ASCII is allowed.
452 PR(int cn, char *format, ...)
454 /* XXX should really do this on a per-nation basis */
455 static char longline[MAXNOC][512];
460 va_start(ap, format);
461 (void)vsprintf(buf, format, ap);
463 newline = strrchr(buf, '\n') ? 1 : 0;
464 strcat(longline[cn], buf);
466 if (update_pending || (cn && cn != player->cnum))
467 typed_wu(0, cn, longline[cn], TEL_BULLETIN);
469 pr_player(player, C_DATA, longline[cn]);
470 longline[cn][0] = '\0';
475 * Print the current time in ctime() format to country CN.
476 * If CN is the current player and we're not in the update, print just
477 * like prdate(). Else print into a bulletin.
489 * Sound the current player's bell.
494 struct natstr *np = getnatp(player->cnum);
496 if (np->nat_flags & NF_BEEP)
501 * Print to country CN similar to printf().
502 * Use printf-style FORMAT with the optional arguments.
503 * If CN is the current player and we're not in the update, print just
504 * like pr(). Else print into a bulletin.
505 * Because printing like pr() requires normal text, and bulletins
506 * require user text, only plain ASCII is allowed.
509 mpr(int cn, char *format, ...)
514 va_start(ap, format);
515 (void)vsprintf(buf, format, ap);
518 if (update_pending || cn != player->cnum)
519 typed_wu(0, cn, buf, TEL_BULLETIN);
521 pr_player(player, C_DATA, buf);
526 * Copy SRC without funny characters to DST.
527 * Drop control characters, except for '\t'.
528 * Replace non-ASCII characters by '?'.
529 * Return length of DST.
530 * DST must have space. If it overlaps SRC, then DST <= SRC must
534 copy_ascii_no_funny(char *dst, char *src)
540 while ((ch = *src++)) {
541 if ((ch < 0x20 && ch != '\t' && ch != '\n') || ch == 0x7f)
542 ; /* ignore funny control */
544 *p++ = '?'; /* replace non-ASCII */
554 * Copy UTF-8 SRC without funny characters to DST.
555 * Drop control characters, except for '\t'.
556 * FIXME Replace malformed UTF-8 sequences by '?'.
557 * Return byte length of DST.
558 * DST must have space. If it overlaps SRC, then DST <= SRC must
562 copy_utf8_no_funny(char *dst, char *src)
568 while ((ch = *src++)) {
569 /* FIXME do the right thing for malformed and overlong sequences */
570 if ((ch < 0x20 && ch != '\t' && ch != '\n') || ch == 0x7f)
571 ; /* ignore funny control */
581 * Copy UTF-8 SRC without funny characters to ASCII DST.
582 * Drop control characters, except for '\t'.
583 * Replace non-ASCII characters by '?'.
584 * Return length of DST.
585 * DST must have space. If it overlaps SRC, then DST <= SRC must
589 copy_utf8_to_ascii_no_funny(char *dst, char *src)
595 while ((ch = *src++)) {
596 /* FIXME do the right thing for malformed and overlong sequences */
597 if ((ch < 0x20 && ch != '\t' && ch != '\n') || ch == 0x7f)
598 ; /* ignore funny control */
599 else if (ch > 0x7f) {
600 *p++ = '?'; /* replace non-ASCII */
601 while ((*src++ & 0xc0) == 0x80) ;
611 * Return byte-index of the N-th UTF-8 character in UTF-8 string S.
612 * If S doesn't have that many characters, return its length instead.
615 ufindpfx(char *s, int n)
621 if ((s[i++] & 0xc0) == 0xc0)
622 while ((s[i] & 0xc0) == 0x80)