Skip to content
  • DRC's avatar
    Improve code formatting consistency · 19c791cd
    DRC authored
    With rare exceptions ...
    - Always separate line continuation characters by one space from
      preceding code.
    - Always use two-space indentation.  Never use tabs.
    - Always use K&R-style conditional blocks.
    - Always surround operators with spaces, except in raw assembly code.
    - Always put a space after, but not before, a comma.
    - Never put a space between type casts and variables/function calls.
    - Never put a space between the function name and the argument list in
      function declarations and prototypes.
    - Always surround braces ('{' and '}') with spaces.
    - Always surround statements (if, for, else, catch, while, do, switch)
      with spaces.
    - Always attach pointer symbols ('*' and '**') to the variable or
      function name.
    - Always precede pointer symbols ('*' and '**') by a space in type
      casts.
    - Use the MIN() macro from jpegint.h within the libjpeg and TurboJPEG
      API libraries (using min() from tjutil.h is still necessary for
      TJBench.)
    - Where it makes sense (particularly in the TurboJPEG code), put a blank
      line after variable declaration blocks.
    - Always separate statements in one-liners by two spaces.
    
    The purpose of this was to ease maintenance on my part and also to make
    it easier for contributors to figure out how to format patch
    submissions.  This was admittedly confusing (even to me sometimes) when
    we had 3 or 4 different style conventions in the same source tree.  The
    new convention is more consistent with the formatting of other OSS code
    bases.
    
    This commit corrects deviations from the chosen formatting style in the
    libjpeg API code and reformats the TurboJPEG API code such that it
    conforms to the same standard.
    
    NOTES:
    - Although it is no longer necessary for the function name in function
      declarations to begin in Column 1 (this was historically necessary
      because of the ansi2knr utility, which allowed libjpeg to be built
      with non-ANSI compilers), we retain that formatting for the libjpeg
      code because it improves readability when using libjpeg's function
      attribute macros (GLOBAL(), etc.)
    - This reformatting project was accomplished with the help of AStyle and
      Uncrustify, although neither was completely up to the task, and thus
      a great deal of manual tweaking was required.  Note to developers of
      code formatting utilities:  the libjpeg-turbo code base is an
      excellent test bed, because AFAICT, it breaks every single one of the
      utilities that are currently available.
    - The legacy (MMX, SSE, 3DNow!) assembly code for i386 has been
      formatted to match the SSE2 code (refer to
      ff5685d5.)  I hadn't intended to
      bother with this, but the Loongson MMI implementation demonstrated
      that there is still academic value to the MMX implementation, as an
      algorithmic model for other 64-bit vector implementations.  Thus, it
      is desirable to improve its readability in the same manner as that of
      the SSE2 implementation.
    19c791cd