nhyatt/putty-source
1
0
Fork 0
mirror of https://git.tartarus.org/simon/putty.git synced 2025-07-15 10:07:39 -05:00
Code Issues Projects Releases Wiki Activity

Convert a lot of 'int' variables to 'bool'.

Browse Source 
My normal habit these days, in new code, is to treat int and bool as
_almost_ completely separate types. I'm still willing to use C's
implicit test for zero on an integer (e.g. 'if (!blob.len)' is fine,
no need to spell it out as blob.len != 0), but generally, if a
variable is going to be conceptually a boolean, I like to declare it
bool and assign to it using 'true' or 'false' rather than 0 or 1.

PuTTY is an exception, because it predates the C99 bool, and I've
stuck to its existing coding style even when adding new code to it.
But it's been annoying me more and more, so now that I've decided C99
bool is an acceptable thing to require from our toolchain in the first
place, here's a quite thorough trawl through the source doing
'boolification'. Many variables and function parameters are now typed
as bool rather than int; many assignments of 0 or 1 to those variables
are now spelled 'true' or 'false'.

I managed this thorough conversion with the help of a custom clang
plugin that I wrote to trawl the AST and apply heuristics to point out
where things might want changing. So I've even managed to do a decent
job on parts of the code I haven't looked at in years!

To make the plugin's work easier, I pushed platform front ends
generally in the direction of using standard 'bool' in preference to
platform-specific boolean types like Windows BOOL or GTK's gboolean;
I've left the platform booleans in places they _have_ to be for the
platform APIs to work right, but variables only used by my own code
have been converted wherever I found them.

In a few places there are int values that look very like booleans in
_most_ of the places they're used, but have a rarely-used third value,
or a distinction between different nonzero values that most users
don't care about. In these cases, I've _removed_ uses of 'true' and
'false' for the return values, to emphasise that there's something
more subtle going on than a simple boolean answer:
 - the 'multisel' field in dialog.h's list box structure, for which
   the GTK front end in particular recognises a difference between 1
   and 2 but nearly everything else treats as boolean
 - the 'urgent' parameter to plug_receive, where 1 vs 2 tells you
   something about the specific location of the urgent pointer, but
   most clients only care about 0 vs 'something nonzero'
 - the return value of wc_match, where -1 indicates a syntax error in
   the wildcard.
 - the return values from SSH-1 RSA-key loading functions, which use
   -1 for 'wrong passphrase' and 0 for all other failures (so any
   caller which already knows it's not loading an _encrypted private_
   key can treat them as boolean)
 - term->esc_query, and the 'query' parameter in toggle_mode in
   terminal.c, which _usually_ hold 0 for ESC[123h or 1 for ESC[?123h,
   but can also hold -1 for some other intervening character that we
   don't support.

In a few places there's an integer that I haven't turned into a bool
even though it really _can_ only take values 0 or 1 (and, as above,
tried to make the call sites consistent in not calling those values
true and false), on the grounds that I thought it would make it more
confusing to imply that the 0 value was in some sense 'negative' or
bad and the 1 positive or good:
 - the return value of plug_accepting uses the POSIXish convention of
   0=success and nonzero=error; I think if I made it bool then I'd
   also want to reverse its sense, and that's a job for a separate
   piece of work.
 - the 'screen' parameter to lineptr() in terminal.c, where 0 and 1
   represent the default and alternate screens. There's no obvious
   reason why one of those should be considered 'true' or 'positive'
   or 'success' - they're just indices - so I've left it as int.

ssh_scp_recv had particularly confusing semantics for its previous int
return value: its call sites used '<= 0' to check for error, but it
never actually returned a negative number, just 0 or 1. Now the
function and its call sites agree that it's a bool.

In a couple of places I've renamed variables called 'ret', because I
don't like that name any more - it's unclear whether it means the
return value (in preparation) for the _containing_ function or the
return value received from a subroutine call, and occasionally I've
accidentally used the same variable for both and introduced a bug. So
where one of those got in my way, I've renamed it to 'toret' or 'retd'
(the latter short for 'returned') in line with my usual modern
practice, but I haven't done a thorough job of finding all of them.

Finally, one amusing side effect of doing this is that I've had to
separate quite a few chained assignments. It used to be perfectly fine
to write 'a = b = c = TRUE' when a,b,c were int and TRUE was just a
the 'true' defined by stdbool.h, that idiom provokes a warning from
gcc: 'suggest parentheses around assignment used as truth value'!
This commit is contained in:
Simon Tatham
2018-11-02 19:23:19 +00:00
parent 1378bb049a
commit 3214563d8e
164 changed files with 2914 additions and 2805 deletions
Download Patch File Download Diff File Expand all files Collapse all files

36
unix/uxpty.c
View File

@ -87,10 +87,10 @@ struct Pty {
char name[FILENAME_MAX];
pid_t child_pid;
int term_width, term_height;
int child_dead, finished;
bool child_dead, finished;
int exit_code;
bufchain output_data;
int pending_eof;
bool pending_eof;
Backend backend;
};
@ -178,7 +178,7 @@ static Pty *single_pty = NULL;
#ifndef OMIT_UTMP
static pid_t pty_utmp_helper_pid = -1;
static int pty_utmp_helper_pipe = -1;
static int pty_stamped_utmp;
static bool pty_stamped_utmp;
static struct utmpx utmp_entry;
#endif
@ -246,7 +246,7 @@ static void setup_utmp(char *ttyname, char *location)
}
#endif
pty_stamped_utmp = 1;
pty_stamped_utmp = true;
}
@ -273,7 +273,7 @@ static void cleanup_utmp(void)
pututxline(&utmp_entry);
endutxent();
pty_stamped_utmp = 0; /* ensure we never double-cleanup */
pty_stamped_utmp = false; /* ensure we never double-cleanup */
}
#endif
@ -285,7 +285,7 @@ static void sigchld_handler(int signum)
static void pty_setup_sigchld_handler(void)
{
static int setup = false;
static bool setup = false;
if (!setup) {
putty_signal(SIGCHLD, sigchld_handler);
setup = true;
@ -597,7 +597,7 @@ static void pty_real_select_result(Pty *pty, int fd, int event, int status)
{
char buf[4096];
int ret;
int finished = false;
bool finished = false;
if (event < 0) {
/*
@ -629,7 +629,7 @@ static void pty_real_select_result(Pty *pty, int fd, int event, int status)
}
} else {
if (event == 1) {
int is_stdout = (fd == pty->master_o);
bool is_stdout = (fd == pty->master_o);
ret = read(fd, buf, sizeof(buf));
@ -844,12 +844,12 @@ static void copy_ttymodes_into_termios(
*/
Backend *pty_backend_create(
Seat *seat, LogContext *logctx, Conf *conf, char **argv, const char *cmd,
struct ssh_ttymodes ttymodes, int pipes_instead)
struct ssh_ttymodes ttymodes, bool pipes_instead)
{
int slavefd;
pid_t pid, pgrp;
#ifndef NOT_X_WINDOWS /* for Mac OS X native compilation */
int got_windowid;
bool got_windowid;
long windowid;
#endif
Pty *pty;
@ -987,7 +987,7 @@ Backend *pty_backend_create(
char *e = *ep;
if (!strncmp(e, pty_osx_envrestore_prefix, plen)) {
int unset = (e[plen] == 'u');
bool unset = (e[plen] == 'u');
char *pname = dupprintf("%.*s", (int)strcspn(e, "="), e);
char *name = pname + plen + 1;
char *value = e + strcspn(e, "=");
@ -1129,7 +1129,7 @@ Backend *pty_backend_create(
putty_signal(SIGINT, SIG_DFL);
putty_signal(SIGQUIT, SIG_DFL);
putty_signal(SIGPIPE, SIG_DFL);
block_signal(SIGPIPE, 0);
block_signal(SIGPIPE, false);
if (argv || cmd) {
/*
* If we were given a separated argument list, try to exec
@ -1237,7 +1237,7 @@ Backend *pty_backend_create(
static const char *pty_init(Seat *seat, Backend **backend_handle,
LogContext *logctx, Conf *conf,
const char *host, int port,
char **realhost, int nodelay, int keepalive)
char **realhost, bool nodelay, bool keepalive)
{
const char *cmd = NULL;
struct ssh_ttymodes modes;
@ -1470,16 +1470,16 @@ static const SessionSpecial *pty_get_specials(Backend *be)
return NULL;
}
static int pty_connected(Backend *be)
static bool pty_connected(Backend *be)
{
/* Pty *pty = container_of(be, Pty, backend); */
return true;
}
static int pty_sendok(Backend *be)
static bool pty_sendok(Backend *be)
{
/* Pty *pty = container_of(be, Pty, backend); */
return 1;
return true;
}
static void pty_unthrottle(Backend *be, int backlog)
@ -1488,10 +1488,10 @@ static void pty_unthrottle(Backend *be, int backlog)
/* do nothing */
}
static int pty_ldisc(Backend *be, int option)
static bool pty_ldisc(Backend *be, int option)
{
/* Pty *pty = container_of(be, Pty, backend); */
return 0; /* neither editing nor echoing */
return false; /* neither editing nor echoing */
}
static void pty_provide_ldisc(Backend *be, Ldisc *ldisc)