Created attachment 2481[details]
Fix for client con_tty.c issues
OK I've already sent this out on the ioquake3 mailing list. So I'm just going to copy and paste most parts of the email here.
================================================
First let me give you a little bit of background to justify why I spent so much
time fixing these bugs. Let's say I'm hanging out with my clan and we find a
scrim. Someone writes a text message over Mumble with an IP address, port,
and password to the scrim server. So currently, I have to try to memorize
this information or minimize my game window so I can type as I read. It's
really annoying. Back in the old days I could just copy and paste the info
into my X terminal. Yes, I'm running Linux.
So, my mission for the past couple of days has been to fix con_tty.c. I know
there were many issues with the old [client] version, and as far as I know
I've addressed all the issues. Now my patch (attached) does
not enable the tty console on clients. My patch also doesn't modify the
behavior of the console on servers (well, almost doesn't; it does fix two
small bugs, see #5 and #9 below). So, if you're using my patch on either the
server or on the client you'll hardly even notice that the patch is applied!
If you would like to start _using_ my patch and trying it out, you'll have to
edit the Makefile to change "client/con_passive" to "client/con_tty" in the one
spot where you see it. If this change to the Makefile is made, I'm not really
sure how many other systems it affects other than Linux. I have not gotten
that far into fixing the other consoles yet. For example, by changing the
Makefile in the way suggested, it may cause Windows client builds to use
con_win32.c. I really don't know at this point. However, just fixing
con_tty.c is a step in the right direction. If needed, I will fix any other
version of the console as well (such as Windows).
Here is a rundown of the changes in my patch:
1. The tty prompt can be changed to any string consisting of one or more
characters (well probably zero or more characters but alas, I didn't actually
test the zero case; the code should handle it from what I recall). The tty
prompt is defined via TTY_CONSOLE_PROMPT. Right now it's set to the original
"]" for servers and to "ioq3-tty]" for clients. You can change it to a better
value before committing my change.
2. Commands typed in the tty console can optionally be sent to appear in the
in-game console. Right now that feature is turned on. It's controlled via
TTY_COMMANDS_VISIBLE_IN_GAME (tests presence of this being #defined).
3. [removed]
4. Using the symbolic STDOUT_FILENO more consistently instead of 1 in
write() calls.
5. If a user types Enter at the tty prompt, the empty string will no longer
be added to the history. Only commands consisting of one or more
characters (even if it's a space) will be added to the console history.
This change affects the server console too.
6. On tty console initialization [especially for clients], make sure that the
prompt appears immediately and not only after a call to Com_Printf(). When
the game starts and a user doesn't see the prompt, it may lead to poor
user experience.
7. Only commands are allowed in the tty console. No chats. (This is the old
behavior.) To make that more clear in the client console, all commands will
have a '\' prepended to them. This '\' will appear before the command when
it's entered (visually) and the '\' will be present in the history. The '\'
is not prepended if a '/' starts the command. A '\' is also not prepended when
the command length is at capacity (length 255). This only applies to a client
tty console; the server console is completely unchanged in this respect.
8. CON_Input() returns the stuff after a '/' or a '\' if such a character
precedes the command string. In other words, autocompletion is no longer
broken. Like I said in #7, a '\' is prepended to every command, so seeing
that '\' whether you used autocompletion or not makes things very consistent
and causes a delightful user experience. This change does not apply to the
server console. (In server console, the command string is treated literally
including any preceding slashes.)
9. CON_Print(), which is called as a result of any Com_Printf(), only
does the CON_Show() of the prompt when the string being printed ends with
a '\n'. I have a very good explanation of how this works in the comments
to the code. The problem with outputting a prompt on a line that doesn't end
with a '\n' is that the output can get garbled, especially if the prompt
consists of more than one character. This is the only other change that
affects the server console. It's not a dangerous change; it only improves
things. It does not cause any problems even if every string passed to
CON_Print() never ends with a '\n' (it will only look a little bit unpleasant,
but won't be any more unpleasant then before).
Let's test out and proofread my changes! Hopefully this patch can make it
into the ioquake3 SVN source tree!
If you see any problems please let me know. I can work on making this as
good as you need it.
I have already tested this change on a server and on a client with
TTY_COMMANDS_VISIBLE_IN_GAME on and off.
Also we need to figure out what other console code needs to be fixed
before enabling tty console in the Makefile.
I just found another slight glitch in the console. It has to do with when
the console first starts up [on the server].
Here is what happens when I run ioq3ded with r1803 from ioquake3 trunk:
...
IP: 127.0.0.1
Opening IP socket: 0.0.0.0:20000
^H ^Hexecing server1.cfg
]^H ^Hsv_maxclients will be changed upon restarting.
...
I basically ran ioq3ded and piped all output (stdout and stderr) to a file.
That is what you're seeing above. The "^H" is a backspace (I verified this
by using the xxd command on my saved output). So the order of bytes being
sent to the console starting with the last '0' in "0.0.0.0:20000" is:
1. char '0'
2. '\n'
3. '\b'
4. ' '
5. '\b'
6. 'e'
7. 'x'
and so on.
The bug is that it's sending backspaces before the console gets printed
(on initialization). It should only send those backspaces after the console
gets printed for the first time. This is a very minor issue I know. However
it leads to ugly formatting in a screen session.
After my initial patch to this bug report (above) is applied, the console
behavior changes slightly:
...
IP: 127.0.0.1
Opening IP socket: 0.0.0.0:20000
^H ^H]^H ^Hexecing server1.cfg
]^H ^Hsv_maxclients will be changed upon restarting.
...
Either way it's not right.
I'll work on improving my patch above to take care of this problem as well.
I have updated my patch with 2 additional fixes:
1. On tty console init (CON_Init()), don't print backspace characters to
terminal before console prompt is displayed. When backspace characters
are printed before the prompt is displayed, output of ioq3ded in a screen
session looks ugly on the line where the console activity starts. Also
it's just incorrect to do this.
2. On tty console shutdown (CON_Shutdown()), the old behavior:
- Type backspaces to delete the width of the console prompt regardless
of whether console is currently being shown (CON_Show()).
New behavior:
- Type backspaces to delete the width of console prompt in addition
to width of text in the command buffer, and only do this if console is
currently shown. In other words, use CON_Hide().
3. (Not important) Adding comments to CON_Init() and CON_Shutdown() at the
top of these functions to describe that these functions are meant to be called
just once during the lifetime of the application, at application start and
at application end.
Yeah, I really loved that you used to be able to type stuff into the console on the client either. Don't worry, I'll look at these patches over the next time and commit them if they're reasonably clean.
Sorry, I'd like to apply this but the patch didn't work, I did not get any console on stdin/stdout. Maybe it's related to some of my recent changes that the patch does not work anymore. Would you be willing to take another look at this?
At this point it's a build issue, not a code issue. "Edit the Makefile to change "client/con_passive" to "client/con_tty" in the one spot where you see it."
Created attachment 2969[details]
Have unix client use con_tty.c
- Made changes to Makefile so unix clients use con_tty.c.
- Changed client tty to act like client in-game console e.g. if in-game and no slash do say command.
- Changed client tty prompt to "tty]" (from "ioq3-tty]"), better for derivative games.
Comment 8Zachary J. Slater
2011-12-25 04:46:20 EST
Created attachment 2481 [details] Fix for client con_tty.c issues OK I've already sent this out on the ioquake3 mailing list. So I'm just going to copy and paste most parts of the email here. ================================================ First let me give you a little bit of background to justify why I spent so much time fixing these bugs. Let's say I'm hanging out with my clan and we find a scrim. Someone writes a text message over Mumble with an IP address, port, and password to the scrim server. So currently, I have to try to memorize this information or minimize my game window so I can type as I read. It's really annoying. Back in the old days I could just copy and paste the info into my X terminal. Yes, I'm running Linux. So, my mission for the past couple of days has been to fix con_tty.c. I know there were many issues with the old [client] version, and as far as I know I've addressed all the issues. Now my patch (attached) does not enable the tty console on clients. My patch also doesn't modify the behavior of the console on servers (well, almost doesn't; it does fix two small bugs, see #5 and #9 below). So, if you're using my patch on either the server or on the client you'll hardly even notice that the patch is applied! If you would like to start _using_ my patch and trying it out, you'll have to edit the Makefile to change "client/con_passive" to "client/con_tty" in the one spot where you see it. If this change to the Makefile is made, I'm not really sure how many other systems it affects other than Linux. I have not gotten that far into fixing the other consoles yet. For example, by changing the Makefile in the way suggested, it may cause Windows client builds to use con_win32.c. I really don't know at this point. However, just fixing con_tty.c is a step in the right direction. If needed, I will fix any other version of the console as well (such as Windows). Here is a rundown of the changes in my patch: 1. The tty prompt can be changed to any string consisting of one or more characters (well probably zero or more characters but alas, I didn't actually test the zero case; the code should handle it from what I recall). The tty prompt is defined via TTY_CONSOLE_PROMPT. Right now it's set to the original "]" for servers and to "ioq3-tty]" for clients. You can change it to a better value before committing my change. 2. Commands typed in the tty console can optionally be sent to appear in the in-game console. Right now that feature is turned on. It's controlled via TTY_COMMANDS_VISIBLE_IN_GAME (tests presence of this being #defined). 3. [removed] 4. Using the symbolic STDOUT_FILENO more consistently instead of 1 in write() calls. 5. If a user types Enter at the tty prompt, the empty string will no longer be added to the history. Only commands consisting of one or more characters (even if it's a space) will be added to the console history. This change affects the server console too. 6. On tty console initialization [especially for clients], make sure that the prompt appears immediately and not only after a call to Com_Printf(). When the game starts and a user doesn't see the prompt, it may lead to poor user experience. 7. Only commands are allowed in the tty console. No chats. (This is the old behavior.) To make that more clear in the client console, all commands will have a '\' prepended to them. This '\' will appear before the command when it's entered (visually) and the '\' will be present in the history. The '\' is not prepended if a '/' starts the command. A '\' is also not prepended when the command length is at capacity (length 255). This only applies to a client tty console; the server console is completely unchanged in this respect. 8. CON_Input() returns the stuff after a '/' or a '\' if such a character precedes the command string. In other words, autocompletion is no longer broken. Like I said in #7, a '\' is prepended to every command, so seeing that '\' whether you used autocompletion or not makes things very consistent and causes a delightful user experience. This change does not apply to the server console. (In server console, the command string is treated literally including any preceding slashes.) 9. CON_Print(), which is called as a result of any Com_Printf(), only does the CON_Show() of the prompt when the string being printed ends with a '\n'. I have a very good explanation of how this works in the comments to the code. The problem with outputting a prompt on a line that doesn't end with a '\n' is that the output can get garbled, especially if the prompt consists of more than one character. This is the only other change that affects the server console. It's not a dangerous change; it only improves things. It does not cause any problems even if every string passed to CON_Print() never ends with a '\n' (it will only look a little bit unpleasant, but won't be any more unpleasant then before). Let's test out and proofread my changes! Hopefully this patch can make it into the ioquake3 SVN source tree! If you see any problems please let me know. I can work on making this as good as you need it. I have already tested this change on a server and on a client with TTY_COMMANDS_VISIBLE_IN_GAME on and off. Also we need to figure out what other console code needs to be fixed before enabling tty console in the Makefile.Created attachment 2495 [details] Fix for client con_tty.c issues, updatedI have updated my patch with 2 additional fixes: 1. On tty console init (CON_Init()), don't print backspace characters to terminal before console prompt is displayed. When backspace characters are printed before the prompt is displayed, output of ioq3ded in a screen session looks ugly on the line where the console activity starts. Also it's just incorrect to do this. 2. On tty console shutdown (CON_Shutdown()), the old behavior: - Type backspaces to delete the width of the console prompt regardless of whether console is currently being shown (CON_Show()). New behavior: - Type backspaces to delete the width of console prompt in addition to width of text in the command buffer, and only do this if console is currently shown. In other words, use CON_Hide(). 3. (Not important) Adding comments to CON_Init() and CON_Shutdown() at the top of these functions to describe that these functions are meant to be called just once during the lifetime of the application, at application start and at application end.Created attachment 2969 [details] Have unix client use con_tty.c - Made changes to Makefile so unix clients use con_tty.c. - Changed client tty to act like client in-game console e.g. if in-game and no slash do say command. - Changed client tty prompt to "tty]" (from "ioq3-tty]"), better for derivative games.