New doc & doc fixes. Remove s_char on the way.

(C_MOD): Turn into enumeration constant.

diff --git a/include/com.h b/include/com.h
index 9e26e71f9f4118f7a998df65c2614f5c4deabb9e..479ee9164fbaca95464d5b1af77c51d13d0277af 100644 (file)
--- a/include/com.h
+++ b/include/com.h
@@ -38,11 +38,20 @@ struct cmndstr {
     char *c_form;              /* prototype of command */
     int c_cost;                        /* btu cost of command */
     int (*c_addr)(void);       /* core addr of appropriate routine */
     char *c_form;              /* prototype of command */
     int c_cost;                        /* btu cost of command */
     int (*c_addr)(void);       /* core addr of appropriate routine */

-    int c_flags;
+    int c_flags;               /* command flags */

     int c_permit;              /* who is allowed to "do" this command */
 };
 
     int c_permit;              /* who is allowed to "do" this command */
 };
 

-#define C_MOD          0x1     /* modifies database */
+/* Command flag bits */
+enum {
+    /*
+     * Command modifies database.
+     * This also makes printing functions not to block.  In fact,
+     * that's the effective meaning of this flag.  Nothing stops a
+     * command without C_MOD modifying whatever it wants.
+     */
+    C_MOD = 1
+};

 
 /* variables associated with this stuff */
 
 
 /* variables associated with this stuff */
 

diff --git a/include/prototypes.h b/include/prototypes.h
index 224f0a757d561455b3cc38a9967f3b01de266889..66cfd9f8b9c9efcb946825f4b2b16b0814a27f5d 100644 (file)
--- a/include/prototypes.h
+++ b/include/prototypes.h
@@ -441,7 +441,7 @@ extern int status(void);
 extern int command(void);
 /* more in commands.h */
 /* recvclient.c */
 extern int command(void);
 /* more in commands.h */
 /* recvclient.c */

-extern int recvclient(s_char *, int);
+extern int recvclient(char *, int);

 
 /* service.c */
 extern void stop_service(void);
 
 /* service.c */
 extern void stop_service(void);

diff --git a/src/lib/player/empdis.c b/src/lib/player/empdis.c
index 9a516f91c585392308de20a3385629915ecb0fc3..d85b9bdb3cf74c2f393ee913558c748f2c709db9 100644 (file)
--- a/src/lib/player/empdis.c
+++ b/src/lib/player/empdis.c
@@ -63,6 +63,8 @@ static int player_commands_index = 0;
 
 /*
  * Get a command from the current player into COMBUFP[1024], in UTF-8.
 
 /*
  * Get a command from the current player into COMBUFP[1024], in UTF-8.

+ * This may block for input, yielding the processor.  Flush buffered
+ * output when blocking, to make sure player sees the prompt.

  * Return command's byte length on success, -1 on error.
  */
 int
  * Return command's byte length on success, -1 on error.
  */
 int

diff --git a/src/lib/player/recvclient.c b/src/lib/player/recvclient.c
index 01813476dfbf6b5569856b3ab017ff9384caf209..546145cc2aca23ee7d02d5cf1a9f5f880c4cc257 100644 (file)
--- a/src/lib/player/recvclient.c
+++ b/src/lib/player/recvclient.c
@@ -25,7 +25,7 @@
  *
  *  ---
  *
  *
  *  ---
  *

- *  recvclient.c: Send and receive commands from the client
+ *  recvclient.c: Receive input from the client

  * 
  *  Known contributors to this file:
  *     Dave Pare, 1986
  * 
  *  Known contributors to this file:
  *     Dave Pare, 1986


@@ -38,8 +38,22 @@
 #include "player.h"
 #include "empthread.h"
 
 #include "player.h"
 #include "empthread.h"
 

+/*
+ * Receive a line of input from the current player.
+ * If the player's aborted flag is set, return -2 without receiving
+ * input.
+ * Else receive one line and store it in CMD[SIZE].
+ * This may block for input, yielding the processor.  Flush buffered
+ * output when blocking, to make sure player sees the prompt.
+ * If the player's connection has the I/O error indicator set, or the
+ * line is "aborted", set the player's aborted flag and return -2.
+ * If the player's connection has the EOF indicator set, or the line
+ * is "ctld", return -1.
+ * Else return the length of the line.
+ * Design bug: there is no way to indicate truncation of a long line.
+ */

 int
 int

-recvclient(s_char *cmd, int size)
+recvclient(char *cmd, int size)

 {
     int count;
 
 {
     int count;
 

diff --git a/src/lib/subs/pr.c b/src/lib/subs/pr.c
index b1bceeb37c5da8af042ace028cfef7deaf3b7535..3cb8d08de854750d18fd2e78aa0ffffffe30fee8 100644 (file)
--- a/src/lib/subs/pr.c
+++ b/src/lib/subs/pr.c
@@ -25,19 +25,23 @@
  *
  *  ---
  *
  *
  *  ---
  *

- *  pr.c: Use to do output to a player
+ *  pr.c: Output to players

  * 
  *  Known contributors to this file:
  *     Dave Pare, 1986, 1989 
  *     Steve McClure, 1998-2000
  */
  * 
  *  Known contributors to this file:
  *     Dave Pare, 1986, 1989 
  *     Steve McClure, 1998-2000
  */

+

 /*
 /*

- * The pr routine historically arranged for nonbuffered i/o
- * because stdio didn't used to automatically flush stdout before
- * it read something from stdin.  Now pr() prepends an "output id"
- * in front of each line of text, informing the user interface
- * what sort of item it is seeing; prompt, noecho prompt,
- * more input data, etc.
+ * Player output is fully buffered.  Unless the receiving player's
+ * last command has the C_MOD flag set, it can block.  Such commands
+ * can print to the current player without yielding the processor.
+ * Printing to another player must be assumed to block.
+ *
+ * Each line of output starts with an identification character
+ * encoding the output id, followed by space.  Ids less than 10 are
+ * encoded as decimal digits, and larger ids as lower case letters,
+ * starting with 'a'.  Symbolic names for ids are defined in proto.h.

  */
 
 #include <string.h>
  */
 
 #include <string.h>


@@ -128,6 +132,7 @@ pr_id(struct player *p, int id, char *format, ...)
  * Send C_FLASH text to PL.
  * Format text to send using printf-style FORMAT and optional
  * arguments.  It is assumed to be UTF-8.
  * Send C_FLASH text to PL.
  * Format text to send using printf-style FORMAT and optional
  * arguments.  It is assumed to be UTF-8.

+ * Initiate an output queue flush, but do not wait for it to complete.

  */
 void
 pr_flash(struct player *pl, char *format, ...)
  */
 void
 pr_flash(struct player *pl, char *format, ...)


@@ -150,6 +155,7 @@ pr_flash(struct player *pl, char *format, ...)
  * Send C_INFORM text to PL.
  * Format text to send using printf-style FORMAT and optional
  * arguments.  It is assumed to be plain ASCII.
  * Send C_INFORM text to PL.
  * Format text to send using printf-style FORMAT and optional
  * arguments.  It is assumed to be plain ASCII.

+ * Initiate an output queue flush, but do not wait for it to complete.

  */
 void
 pr_inform(struct player *pl, char *format, ...)
  */
 void
 pr_inform(struct player *pl, char *format, ...)


@@ -170,6 +176,7 @@ pr_inform(struct player *pl, char *format, ...)
  * Send C_FLASH text to everyone.
  * Format text to send using printf-style FORMAT and optional
  * arguments.  It is assumed to be plain ASCII.
  * Send C_FLASH text to everyone.
  * Format text to send using printf-style FORMAT and optional
  * arguments.  It is assumed to be plain ASCII.

+ * Initiate an output queue flush, but do not wait for it to complete.

  */
 void
 pr_wall(char *format, ...)
  */
 void
 pr_wall(char *format, ...)


@@ -336,6 +343,8 @@ prprompt(int min, int btu)
  * Prompt for a line of non-command input.
  * Send C_FLUSH prompt PROMPT to the current player.
  * Read a line of input into BUF[SIZE] and convert it to ASCII.
  * Prompt for a line of non-command input.
  * Send C_FLUSH prompt PROMPT to the current player.
  * Read a line of input into BUF[SIZE] and convert it to ASCII.

+ * This may block for input, yielding the processor.  Flush buffered
+ * output when blocking, to make sure player sees the prompt.

  * Return number of bytes in BUF[], not counting the terminating 0,
  * or -1 on error.
  */
  * Return number of bytes in BUF[], not counting the terminating 0,
  * or -1 on error.
  */


@@ -361,6 +370,8 @@ prmptrd(char *prompt, char *buf, int size)
  * Send C_FLUSH prompt PROMPT to the current player.
  * Read a line of input into BUF[SIZE], replacing funny characters by
  * '?'.  The result is UTF-8.
  * Send C_FLUSH prompt PROMPT to the current player.
  * Read a line of input into BUF[SIZE], replacing funny characters by
  * '?'.  The result is UTF-8.

+ * This may block for input, yielding the processor.  Flush buffered
+ * output when blocking, to make sure player sees the prompt.

  * Return number of bytes in BUF[], not counting the terminating 0,
  * or -1 on error.
  */
  * Return number of bytes in BUF[], not counting the terminating 0,
  * or -1 on error.
  */


@@ -413,8 +424,8 @@ prxy(char *format, coord x, coord y, natid country)
  * Print to country CN similar to printf().
  * Use printf-style FORMAT with the optional arguments.
  * Output is buffered until a newline arrives.
  * Print to country CN similar to printf().
  * Use printf-style FORMAT with the optional arguments.
  * Output is buffered until a newline arrives.

- * If CN is the current player, print just like pr().
- * Else print into a bulletin.
+ * If CN is the current player and we're not in the update, print just
+ * like pr().  Else print into a bulletin.

  * Because printing like pr() requires normal text, and bulletins
  * require user text, only plain ASCII is allowed.
  */
  * Because printing like pr() requires normal text, and bulletins
  * require user text, only plain ASCII is allowed.
  */


@@ -443,8 +454,8 @@ PR(int cn, char *format, ...)
 
 /*
  * Print the current time in ctime() format to country CN.
 
 /*
  * Print the current time in ctime() format to country CN.

- * If CN is the current player, print like prdate().
- * Else print into a bulletin.
+ * If CN is the current player and we're not in the update, print just
+ * like prdate().  Else print into a bulletin.

  */
 void
 PRdate(natid cn)
  */
 void
 PRdate(natid cn)


@@ -470,8 +481,8 @@ pr_beep(void)
 /*
  * Print to country CN similar to printf().
  * Use printf-style FORMAT with the optional arguments.
 /*
  * Print to country CN similar to printf().
  * Use printf-style FORMAT with the optional arguments.

- * If CN is the current player, print just like pr().
- * Else print into a bulletin.
+ * If CN is the current player and we're not in the update, print just
+ * like pr().  Else print into a bulletin.

  * Because printing like pr() requires normal text, and bulletins
  * require user text, only plain ASCII is allowed.
  */
  * Because printing like pr() requires normal text, and bulletins
  * require user text, only plain ASCII is allowed.
  */