Improve code formatting consistency
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
ff5685d5344273df321eb63a005eaae19d2496e3.) 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.
diff --git a/rdjpgcom.c b/rdjpgcom.c
index b3076dd..c435b90 100644
--- a/rdjpgcom.c
+++ b/rdjpgcom.c
@@ -69,7 +69,7 @@
/* Read one byte, testing for EOF */
static int
-read_1_byte (void)
+read_1_byte(void)
{
int c;
@@ -82,7 +82,7 @@
/* Read 2 bytes, convert to unsigned int */
/* All 2-byte quantities in JPEG markers are MSB first */
static unsigned int
-read_2_bytes (void)
+read_2_bytes(void)
{
int c1, c2;
@@ -92,7 +92,7 @@
c2 = NEXTBYTE();
if (c2 == EOF)
ERREXIT("Premature EOF in JPEG file");
- return (((unsigned int) c1) << 8) + ((unsigned int) c2);
+ return (((unsigned int)c1) << 8) + ((unsigned int)c2);
}
@@ -134,7 +134,7 @@
*/
static int
-next_marker (void)
+next_marker(void)
{
int c;
int discarded_bytes = 0;
@@ -169,7 +169,7 @@
*/
static int
-first_marker (void)
+first_marker(void)
{
int c1, c2;
@@ -191,7 +191,7 @@
*/
static void
-skip_variable (void)
+skip_variable(void)
/* Skip over an unknown or uninteresting variable-length marker */
{
unsigned int length;
@@ -204,7 +204,7 @@
length -= 2;
/* Skip over the remaining bytes */
while (length > 0) {
- (void) read_1_byte();
+ (void)read_1_byte();
length--;
}
}
@@ -217,7 +217,7 @@
*/
static void
-process_COM (int raw)
+process_COM(int raw)
{
unsigned int length;
int ch;
@@ -274,7 +274,7 @@
*/
static void
-process_SOFn (int marker)
+process_SOFn(int marker)
{
unsigned int length;
unsigned int image_height, image_width;
@@ -310,13 +310,13 @@
image_width, image_height, num_components, data_precision);
printf("JPEG process: %s\n", process);
- if (length != (unsigned int) (8 + num_components * 3))
+ if (length != (unsigned int)(8 + num_components * 3))
ERREXIT("Bogus SOF marker length");
for (ci = 0; ci < num_components; ci++) {
- (void) read_1_byte(); /* Component ID code */
- (void) read_1_byte(); /* H, V sampling factors */
- (void) read_1_byte(); /* Quantization table number */
+ (void)read_1_byte(); /* Component ID code */
+ (void)read_1_byte(); /* H, V sampling factors */
+ (void)read_1_byte(); /* Quantization table number */
}
}
@@ -332,7 +332,7 @@
*/
static int
-scan_JPEG_header (int verbose, int raw)
+scan_JPEG_header(int verbose, int raw)
{
int marker;
@@ -401,7 +401,7 @@
static void
-usage (void)
+usage(void)
/* complain about bad command line */
{
fprintf(stderr, "rdjpgcom displays any textual comments in a JPEG file.\n");
@@ -417,7 +417,7 @@
static int
-keymatch (char *arg, const char *keyword, int minchars)
+keymatch(char *arg, const char *keyword, int minchars)
/* Case-insensitive matching of (possibly abbreviated) keyword switches. */
/* keyword is the constant keyword (must be lower case already), */
/* minchars is length of minimum legal abbreviation. */
@@ -446,7 +446,7 @@
*/
int
-main (int argc, char **argv)
+main(int argc, char **argv)
{
int argn;
char *arg;
@@ -477,7 +477,7 @@
/* Open the input file. */
/* Unix style: expect zero or one file name */
- if (argn < argc-1) {
+ if (argn < argc - 1) {
fprintf(stderr, "%s: only one input file\n", progname);
usage();
}
@@ -502,7 +502,7 @@
}
/* Scan the JPEG headers. */
- (void) scan_JPEG_header(verbose, raw);
+ (void)scan_JPEG_header(verbose, raw);
/* All done. */
exit(EXIT_SUCCESS);