Skip to content
Snippets Groups Projects
  1. Sep 08, 2019
    • Simon Tatham's avatar
      Whitespace rationalisation of entire code base. · 5d718ef6
      Simon Tatham authored
      The number of people has been steadily increasing who read our source
      code with an editor that thinks tab stops are 4 spaces apart, as
      opposed to the traditional tty-derived 8 that the PuTTY code expects.
      
      So I've been wondering for ages about just fixing it, and switching to
      a spaces-only policy throughout the code. And I recently found out
      about 'git blame -w', which should make this change not too disruptive
      for the purposes of source-control archaeology; so perhaps now is the
      time.
      
      While I'm at it, I've also taken the opportunity to remove all the
      trailing spaces from source lines (on the basis that git dislikes
      them, and is the only thing that seems to have a strong opinion one
      way or the other).
          
      Apologies to anyone downstream of this code who has complicated patch
      sets to rebase past this change. I don't intend it to be needed again.
      5d718ef6
  2. Jul 28, 2019
  3. Feb 06, 2019
  4. Nov 03, 2018
    • Simon Tatham's avatar
      Convert a lot of 'int' variables to 'bool'. · 3214563d
      Simon Tatham authored
      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'!
      3214563d
  5. Oct 06, 2018
  6. Oct 04, 2018
    • Simon Tatham's avatar
      Get rid of lots of implicit pointer types. · 96ec2c25
      Simon Tatham authored
      All the main backend structures - Ssh, Telnet, Pty, Serial etc - now
      describe structure types themselves rather than pointers to them. The
      same goes for the codebase-wide trait types Socket and Plug, and the
      supporting types SockAddr and Pinger.
      
      All those things that were typedefed as pointers are older types; the
      newer ones have the explicit * at the point of use, because that's
      what I now seem to be preferring. But whichever one of those is
      better, inconsistently using a mixture of the two styles is worse, so
      let's make everything consistent.
      
      A few types are still implicitly pointers, such as Bignum and some of
      the GSSAPI types; generally this is either because they have to be
      void *, or because they're typedefed differently on different
      platforms and aren't always pointers at all. Can't be helped. But I've
      got rid of the main ones, at least.
      96ec2c25
  7. May 27, 2018
    • Simon Tatham's avatar
      Modernise the Socket/Plug vtable system. · 5129c40b
      Simon Tatham authored
      Now I've got FROMFIELD, I can rework it so that structures providing
      an implementation of the Socket or Plug trait no longer have to have
      the vtable pointer as the very first thing in the structure. In
      particular, this means that the ProxySocket structure can now directly
      implement _both_ the Socket and Plug traits, which is always
      _logically_ how it's worked, but previously it had to be implemented
      via two separate structs linked to each other.
      5129c40b
  8. May 25, 2018
  9. May 15, 2015
    • Simon Tatham's avatar
      Giant const-correctness patch of doom! · 89da2ddf
      Simon Tatham authored
      Having found a lot of unfixed constness issues in recent development,
      I thought perhaps it was time to get proactive, so I compiled the
      whole codebase with -Wwrite-strings. That turned up a huge load of
      const problems, which I've fixed in this commit: the Unix build now
      goes cleanly through with -Wwrite-strings, and the Windows build is as
      close as I could get it (there are some lingering issues due to
      occasional Windows API functions like AcquireCredentialsHandle not
      having the right constness).
      
      Notable fallout beyond the purely mechanical changing of types:
       - the stuff saved by cmdline_save_param() is now explicitly
         dupstr()ed, and freed in cmdline_run_saved.
       - I couldn't make both string arguments to cmdline_process_param()
         const, because it intentionally writes to one of them in the case
         where it's the argument to -pw (in the vain hope of being at least
         slightly friendly to 'ps'), so elsewhere I had to temporarily
         dupstr() something for the sake of passing it to that function
       - I had to invent a silly parallel version of const_cmp() so I could
         pass const string literals in to lookup functions.
       - stripslashes() in pscp.c and psftp.c has the annoying strchr nature
      89da2ddf
  10. Nov 17, 2013
    • Simon Tatham's avatar
      Replace the hacky 'OSSocket' type with a closure. · 19fba3fe
      Simon Tatham authored
      The mechanism for constructing a new connection-type Socket when a
      listening one receives an incoming connection previously worked by
      passing a platform-specific 'OSSocket' type to the plug_accepting
      function, which would then call sk_register to wrap it with a proper
      Socket instance. This is less flexible than ideal, because it presumes
      that only one kind of OS object might ever need to be turned into a
      Socket. So I've replaced OSSocket throughout the code base with a pair
      of parameters consisting of a function pointer and a context such that
      passing the latter to the former returns the appropriate Socket; this
      will permit different classes of listening Socket to pass different
      function pointers.
      
      In deference to the reality that OSSockets tend to be small integers
      or pointer-sized OS handles, I've made the context parameter an
      int/pointer union that can hold either of those directly, rather than
      the usual approach of making it a plain 'void *' and requiring a
      context structure to be dynamically allocated every time.
      
      [originally from svn r10068]
      19fba3fe
  11. Sep 13, 2011
    • Simon Tatham's avatar
      Revamp of EOF handling in all network connections, pipes and other · 947962e0
      Simon Tatham authored
      data channels. Should comprehensively fix 'half-closed', in principle,
      though it's a big and complicated change and so there's a good chance
      I've made at least one mistake somewhere.
      
      All connections should now be rigorous about propagating end-of-file
      (or end-of-data-stream, or socket shutdown, or whatever) independently
      in both directions, except in frontends with no mechanism for sending
      explicit EOF (e.g. interactive terminal windows) or backends which are
      basically always used for interactive sessions so it's unlikely that
      an application would be depending on independent EOF (telnet, rlogin).
      
      EOF should now never accidentally be sent while there's still buffered
      data to go out before it. (May help fix 'portfwd-corrupt', and also I
      noticed recently that the ssh main session channel can accidentally
      have MSG_EOF sent before the output bufchain is clear, leading to
      embarrassment when it subsequently does send the output).
      
      [originally from svn r9279]
      947962e0
  12. Jul 14, 2011
    • Simon Tatham's avatar
      Post-release destabilisation! Completely remove the struct type · a1f3b7a3
      Simon Tatham authored
      'Config' in putty.h, which stores all PuTTY's settings and includes an
      arbitrary length limit on every single one of those settings which is
      stored in string form. In place of it is 'Conf', an opaque data type
      everywhere outside the new file conf.c, which stores a list of (key,
      value) pairs in which every key contains an integer identifying a
      configuration setting, and for some of those integers the key also
      contains extra parts (so that, for instance, CONF_environmt is a
      string-to-string mapping). Everywhere that a Config was previously
      used, a Conf is now; everywhere there was a Config structure copy,
      conf_copy() is called; every lookup, adjustment, load and save
      operation on a Config has been rewritten; and there's a mechanism for
      serialising a Conf into a binary blob and back for use with Duplicate
      Session.
      
      User-visible effects of this change _should_ be minimal, though I
      don't doubt I've introduced one or two bugs here and there which will
      eventually be found. The _intended_ visible effects of this change are
      that all arbitrary limits on configuration strings and lists (e.g.
      limit on number of port forwardings) should now disappear; that list
      boxes in the configuration will now be displayed in a sorted order
      rather than the arbitrary order in which they were added to the list
      (since the underlying data structure is now a sorted tree234 rather
      than an ad-hoc comma-separated string); and one more specific change,
      which is that local and dynamic port forwardings on the same port
      number are now mutually exclusive in the configuration (putting 'D' in
      the key rather than the value was a mistake in the first place).
      
      One other reorganisation as a result of this is that I've moved all
      the dialog.c standard handlers (dlg_stdeditbox_handler and friends)
      out into config.c, because I can't really justify calling them generic
      any more. When they took a pointer to an arbitrary structure type and
      the offset of a field within that structure, they were independent of
      whether that structure was a Config or something completely different,
      but now they really do expect to talk to a Conf, which can _only_ be
      used for PuTTY configuration, so I've renamed them all things like
      conf_editbox_handler and moved them out of the nominally independent
      dialog-box management module into the PuTTY-specific config.c.
      
      [originally from svn r9214]
      a1f3b7a3
  13. Aug 30, 2004
  14. May 10, 2003
    • Simon Tatham's avatar
      Fixes for Debian bug #192701 (64-bit gccs warn about casts between · 9a242f06
      Simon Tatham authored
      ptrs and ints of different size and -Werror makes this serious).
      The GTK bits are done by Colin's patch to use GINT_TO_POINTER
      (thanks); the uxnet bits are done by cleaning up the rest of the
      code. In particular, network.h now typedefs `OSSocket' to be a type
      capable of holding whatever the OS's socket data type is that
      underlies our socket abstraction. Individual platforms can make this
      typedef themselves if they define OSSOCKET_DEFINED to prevent
      network.h redoing it; so the Unix OSSocket is now int. Default is
      still void *, so other platforms should be unaffected.
      
      [originally from svn r3171]
      9a242f06
  15. May 06, 2003
  16. May 04, 2003
  17. Jan 12, 2003
    • Simon Tatham's avatar
      proxy.c now no longer refers to `cfg'. Instead, each of the three · 952857fc
      Simon Tatham authored
      proxy-indirection network functions (name_lookup, new_connection,
      new_listener) takes a `const Config *' as an argument, and extracts
      enough information from it before returning to handle that
      particular network operation in accordance with the proxy settings
      it specifies. This involved {win,ux}net.c due to a `const'
      repercussion.
      
      [originally from svn r2567]
      952857fc
  18. Oct 26, 2002
  19. Oct 22, 2002
  20. Apr 27, 2002
  21. Mar 27, 2002
  22. Mar 23, 2002
    • Simon Tatham's avatar
      Justin Bradford's proxy support patch. Currently supports only HTTP · eabd704d
      Simon Tatham authored
      CONNECT, but contains an extensible framework to allow other
      proxies. Apparently SOCKS and ad-hoc-telnet-proxy are already
      planned (the GUI mentions them already even though they don't work
      yet). GUI includes full configurability and allows definition of
      exclusion zones. Rock and roll.
      
      [originally from svn r1598]
      eabd704d
Loading