1 /* Copyright (C) 1989, 1997, 1998, 1999 Aladdin Enterprises. All rights reserved. */
3 /*$Id: ansi2knr.c,v 1.3 2000/04/12 09:43:21 kevind Exp $*/
4 /* Convert ANSI C function definitions to K&R ("traditional C") syntax */
7 ansi2knr is distributed in the hope that it will be useful, but WITHOUT ANY
8 WARRANTY. No author or distributor accepts responsibility to anyone for the
9 consequences of using it or for whether it serves any particular purpose or
10 works at all, unless he says so in writing. Refer to the GNU General Public
11 License (the "GPL") for full details.
13 Everyone is granted permission to copy, modify and redistribute ansi2knr,
14 but only under the conditions described in the GPL. A copy of this license
15 is supposed to have been given to you along with ansi2knr so you can know
16 your rights and responsibilities. It should be in a file named COPYLEFT,
17 or, if there is no file named COPYLEFT, a file named COPYING. Among other
18 things, the copyright notice and this notice must be preserved on all
21 We explicitly state here what we believe is already implied by the GPL: if
22 the ansi2knr program is distributed as a separate set of sources and a
23 separate executable file which are aggregated on a storage medium together
24 with another program, this in itself does not bring the other program under
25 the GPL, nor does the mere fact that such a program or the procedures for
26 constructing it invoke the ansi2knr executable bring any other part of the
27 program under the GPL.
32 ansi2knr [--filename FILENAME] [INPUT_FILE [OUTPUT_FILE]]
33 * --filename provides the file name for the #line directive in the output,
34 * overriding input_file (if present).
35 * If no input_file is supplied, input is read from stdin.
36 * If no output_file is supplied, output goes to stdout.
37 * There are no error messages.
39 * ansi2knr recognizes function definitions by seeing a non-keyword
40 * identifier at the left margin, followed by a left parenthesis, with a
41 * right parenthesis as the last character on the line, and with a left
42 * brace as the first token on the following line (ignoring possible
43 * intervening comments and/or preprocessor directives), except that a line
45 * identifier1(identifier2)
46 * will not be considered a function definition unless identifier2 is
47 * the word "void", and a line consisting of
48 * identifier1(identifier2, <<arbitrary>>)
49 * will not be considered a function definition.
50 * ansi2knr will recognize a multi-line header provided that no intervening
51 * line ends with a left or right brace or a semicolon. These algorithms
52 * ignore whitespace, comments, and preprocessor directives, except that
53 * the function name must be the first thing on the line. The following
54 * constructs will confuse it:
55 * - Any other construct that starts at the left margin and
56 * follows the above syntax (such as a macro or function call).
57 * - Some macros that tinker with the syntax of function headers.
61 * The original and principal author of ansi2knr is L. Peter Deutsch
62 * <ghost@aladdin.com>. Other authors are noted in the change history
63 * that follows (in reverse chronological order):
64 lpd 1999-08-17 added code to allow preprocessor directives
65 wherever comments are allowed
66 lpd 1999-04-12 added minor fixes from Pavel Roskin
67 <pavel_roskin@geocities.com> for clean compilation with
69 lpd 1999-03-22 added hack to recognize lines consisting of
70 identifier1(identifier2, xxx) as *not* being procedures
71 lpd 1999-02-03 made indentation of preprocessor commands consistent
72 lpd 1999-01-28 fixed two bugs: a '/' in an argument list caused an
73 endless loop; quoted strings within an argument list
75 lpd 1999-01-24 added a check for write errors on the output,
76 suggested by Jim Meyering <meyering@ascend.com>
77 lpd 1998-11-09 added further hack to recognize identifier(void)
79 lpd 1998-10-23 added hack to recognize lines consisting of
80 identifier1(identifier2) as *not* being procedures
81 lpd 1997-12-08 made input_file optional; only closes input and/or
82 output file if not stdin or stdout respectively; prints
83 usage message on stderr rather than stdout; adds
84 --filename switch (changes suggested by
85 <ceder@lysator.liu.se>)
86 lpd 1996-01-21 added code to cope with not HAVE_CONFIG_H and with
87 compilers that don't understand void, as suggested by
89 lpd 1996-01-15 changed to require that the first non-comment token
90 on the line following a function header be a left brace,
91 to reduce sensitivity to macros, as suggested by Tom Lane
93 lpd 1995-06-22 removed #ifndefs whose sole purpose was to define
94 undefined preprocessor symbols as 0; changed all #ifdefs
95 for configuration symbols to #ifs
96 lpd 1995-04-05 changed copyright notice to make it clear that
97 including ansi2knr in a program does not bring the entire
99 lpd 1994-12-18 added conditionals for systems where ctype macros
100 don't handle 8-bit characters properly, suggested by
101 Francois Pinard <pinard@iro.umontreal.ca>;
102 removed --varargs switch (this is now the default)
103 lpd 1994-10-10 removed CONFIG_BROKETS conditional
104 lpd 1994-07-16 added some conditionals to help GNU `configure',
105 suggested by Francois Pinard <pinard@iro.umontreal.ca>;
106 properly erase prototype args in function parameters,
107 contributed by Jim Avera <jima@netcom.com>;
108 correct error in writeblanks (it shouldn't erase EOLs)
109 lpd 1989-xx-xx original version
112 /* Most of the conditionals here are to make ansi2knr work with */
113 /* or without the GNU configure machinery. */
125 For properly autoconfiguring ansi2knr, use AC_CONFIG_HEADER(config.h).
126 This will define HAVE_CONFIG_H and so, activate the following lines.
129 # if STDC_HEADERS || HAVE_STRING_H
132 # include <strings.h>
135 #else /* not HAVE_CONFIG_H */
137 /* Otherwise do it the hard way */
140 # include <strings.h>
143 extern int strlen(), strncmp();
149 #endif /* not HAVE_CONFIG_H */
155 malloc and free should be declared in stdlib.h,
156 but if you've got a K&R compiler, they probably aren't.
162 extern char *malloc();
165 extern char *malloc();
172 /* Define NULL (for *very* old compilers). */
178 * The ctype macros don't always handle 8-bit characters correctly.
179 * Compensate for this here.
182 # undef HAVE_ISASCII /* just in case */
183 # define HAVE_ISASCII 1
186 #if STDC_HEADERS || !HAVE_ISASCII
187 # define is_ascii(c) 1
189 # define is_ascii(c) isascii(c)
192 #define is_space(c) (is_ascii(c) && isspace(c))
193 #define is_alpha(c) (is_ascii(c) && isalpha(c))
194 #define is_alnum(c) (is_ascii(c) && isalnum(c))
196 /* Scanning macros */
197 #define isidchar(ch) (is_alnum(ch) || (ch) == '_')
198 #define isidfirstchar(ch) (is_alpha(ch) || (ch) == '_')
200 /* Forward references */
201 char *ppdirforward();
202 char *ppdirbackward();
210 /* The main program */
218 char *program_name
= argv
[0];
219 char *output_name
= 0;
220 #define bufsize 5000 /* arbitrary size */
225 "Usage: ansi2knr [--filename FILENAME] [INPUT_FILE [OUTPUT_FILE]]\n";
227 * In previous versions, ansi2knr recognized a --varargs switch.
228 * If this switch was supplied, ansi2knr would attempt to convert
229 * a ... argument to va_alist and va_dcl; if this switch was not
230 * supplied, ansi2knr would simply drop any such arguments.
231 * Now, ansi2knr always does this conversion, and we only
232 * check for this switch for backward compatibility.
234 int convert_varargs
= 1;
237 while ( argc
> 1 && argv
[1][0] == '-' ) {
238 if ( !strcmp(argv
[1], "--varargs") ) {
244 if ( !strcmp(argv
[1], "--filename") && argc
> 2 ) {
250 fprintf(stderr
, "%s: Unrecognized switch: %s\n", program_name
,
252 fprintf(stderr
, usage
);
258 fprintf(stderr
, usage
);
261 output_name
= argv
[2];
262 out
= fopen(output_name
, "w");
264 fprintf(stderr
, "%s: Cannot open output file %s\n",
265 program_name
, output_name
);
270 in
= fopen(argv
[1], "r");
272 fprintf(stderr
, "%s: Cannot open input file %s\n",
273 program_name
, argv
[1]);
283 fprintf(out
, "#line 1 \"%s\"\n", filename
);
284 buf
= malloc(bufsize
);
287 fprintf(stderr
, "Unable to allocate read buffer!\n");
291 while ( fgets(line
, (unsigned)(buf
+ bufsize
- line
), in
) != NULL
)
293 test
: line
+= strlen(line
);
294 switch ( test1(buf
) )
296 case 2: /* a function header */
297 convert1(buf
, out
, 1, convert_varargs
);
299 case 1: /* a function */
300 /* Check for a { at the start of the next line. */
302 f
: if ( line
>= buf
+ (bufsize
- 1) ) /* overflow check */
304 if ( fgets(line
, (unsigned)(buf
+ bufsize
- line
), in
) == NULL
)
306 switch ( *skipspace(ppdirforward(more
), 1) )
309 /* Definitely a function header. */
310 convert1(buf
, out
, 0, convert_varargs
);
314 /* The next line was blank or a comment: */
315 /* keep scanning for a non-comment. */
316 line
+= strlen(line
);
319 /* buf isn't a function header, but */
327 case -1: /* maybe the start of a function */
328 if ( line
!= buf
+ (bufsize
- 1) ) /* overflow check */
331 default: /* not a function */
332 concatlits(buf
, line
, buf
+ bufsize
, in
);
342 output_error
= ferror(out
);
343 output_error
|= fclose(out
);
344 } else { /* out == stdout */
346 output_error
= ferror(out
);
348 if ( output_error
) {
349 fprintf(stderr
, "%s: error writing to %s\n", program_name
,
350 (output_name
? output_name
: "stdout"));
359 * Skip forward or backward over one or more preprocessor directives.
365 for (; *p
== '#'; ++p
) {
366 for (; *p
!= '\r' && *p
!= '\n'; ++p
)
369 if (*p
== '\r' && p
[1] == '\n')
375 ppdirbackward(p
, limit
)
382 if (*np
== '\n' && np
[-1] == '\r')
384 for (; np
> limit
&& np
[-1] != '\r' && np
[-1] != '\n'; --np
)
392 /* Skip over whitespace and comments, in either direction. */
396 int dir
; /* 1 for forward, -1 for backward */
399 while ( is_space(*p
) )
401 if ( !(*p
== '/' && p
[dir
] == '*') )
404 while ( !(*p
== '*' && p
[dir
] == '/') ) {
406 return p
; /* multi-line comment?? */
414 /* Scan over a quoted string, in either direction. */
421 for (p
+= dir
; *p
; p
+= dir
) {
425 for (backslashed
= 0; ; backslashed
^= 1) {
426 for (q
--; *q
== '\n' && q
[-1] == '\\'; q
-= 2)
435 return p
; /* unterminated string */
439 * Write blanks over part of a string.
440 * Don't overwrite end-of-line characters.
443 writeblanks(start
, end
)
447 for ( p
= start
; p
< end
; p
++ )
448 if ( *p
!= '\r' && *p
!= '\n' )
454 * Test whether the string in buf is a function definition.
455 * The string may contain and/or end with a newline.
457 * 0 - definitely not a function definition;
458 * 1 - definitely a function definition;
459 * 2 - definitely a function prototype (NOT USED);
460 * -1 - may be the beginning of a function definition,
461 * append another line and look again.
462 * The reason we don't attempt to convert function prototypes is that
463 * Ghostscript's declaration-generating macros look too much like
464 * prototypes, and confuse the algorithms.
474 if ( !isidfirstchar(*p
) )
475 return 0; /* no name at left margin */
476 bend
= skipspace(ppdirbackward(buf
+ strlen(buf
) - 1, buf
), -1);
479 case ';': contin
= 0 /*2*/; break;
480 case ')': contin
= 1; break;
481 case '{': return 0; /* not a function */
482 case '}': return 0; /* not a function */
483 default: contin
= -1;
485 while ( isidchar(*p
) )
490 return 0; /* not a function */
493 return 0; /* no parameters */
494 /* Check that the apparent function name isn't a keyword. */
495 /* We only need to check for keywords that could be followed */
496 /* by a left parenthesis (which, unfortunately, is most of them). */
497 { static char *words
[] =
498 { "asm", "auto", "case", "char", "const", "double",
499 "extern", "float", "for", "if", "int", "long",
500 "register", "return", "short", "signed", "sizeof",
501 "static", "switch", "typedef", "unsigned",
502 "void", "volatile", "while", 0
506 unsigned len
= endfn
- buf
;
508 while ( (kp
= *key
) != 0 )
509 { if ( strlen(kp
) == len
&& !strncmp(kp
, buf
, len
) )
510 return 0; /* name is a keyword */
518 * Check for identifier1(identifier2) and not
519 * identifier1(void), or identifier1(identifier2, xxxx).
522 while ( isidchar(*p
) )
527 (*p
== ')' && (len
!= 4 || strncmp(id
, "void", 4)))
529 return 0; /* not a function */
532 * If the last significant character was a ), we need to count
533 * parentheses, because it might be part of a formal parameter
534 * that is a procedure.
539 for (p
= skipspace(buf
, 1); *p
; p
= skipspace(p
+ 1, 1))
540 level
+= (*p
== '(' ? 1 : *p
== ')' ? -1 : 0);
547 /* Convert a recognized function definition or header to K&R syntax. */
549 convert1(buf
, out
, header
, convert_varargs
)
552 int header
; /* Boolean */
553 int convert_varargs
; /* Boolean */
557 * The breaks table contains pointers to the beginning and end
561 unsigned num_breaks
= 2; /* for testing */
567 /* Pre-ANSI implementations don't agree on whether strchr */
568 /* is called strchr or index, so we open-code it here. */
569 for ( endfn
= buf
; *(endfn
++) != '('; )
572 breaks
= (char **)malloc(sizeof(char *) * num_breaks
* 2);
573 if ( breaks
== NULL
)
574 { /* Couldn't allocate break table, give up */
575 fprintf(stderr
, "Unable to allocate break table!\n");
579 btop
= breaks
+ num_breaks
* 2 - 2;
581 /* Parse the argument list */
589 { /* Filled up break table. */
590 /* Allocate a bigger one and start over. */
591 free((char *)breaks
);
596 /* Find the end of the argument */
597 for ( ; end
== NULL
; p
++ )
601 if ( !level
) end
= p
;
604 if ( !level
) lp
= p
;
608 if ( --level
< 0 ) end
= p
;
613 p
= skipspace(p
, 1) - 1;
616 p
= scanstring(p
, 1) - 1;
622 /* Erase any embedded prototype parameters. */
624 writeblanks(lp
+ 1, rp
);
625 p
--; /* back up over terminator */
626 /* Find the name being declared. */
627 /* This is complicated because of procedure and */
628 /* array modifiers. */
630 { p
= skipspace(p
- 1, -1);
633 case ']': /* skip array dimension(s) */
634 case ')': /* skip procedure args OR name */
646 if (p
> buf
&& p
[-1] == '*')
647 p
= skipspace(p
, -1) + 1;
650 p
= scanstring(p
, -1) + 1;
655 if ( *p
== '(' && *skipspace(p
+ 1, 1) == '*' )
656 { /* We found the name being declared */
657 while ( !isidfirstchar(*p
) )
658 p
= skipspace(p
, 1) + 1;
666 found
: if ( *p
== '.' && p
[-1] == '.' && p
[-2] == '.' )
667 { if ( convert_varargs
)
668 { *bp
++ = "va_alist";
673 if ( bp
== breaks
+ 1 ) /* sole argument */
674 writeblanks(breaks
[0], p
);
676 writeblanks(bp
[-1] - 1, p
);
681 { while ( isidchar(*p
) ) p
--;
686 while ( *p
++ == ',' );
688 /* Make a special check for 'void' arglist */
689 if ( bp
== breaks
+2 )
690 { p
= skipspace(breaks
[0], 1);
691 if ( !strncmp(p
, "void", 4) )
692 { p
= skipspace(p
+4, 1);
693 if ( p
== breaks
[2] - 1 )
694 { bp
= breaks
; /* yup, pretend arglist is empty */
695 writeblanks(breaks
[0], p
+ 1);
699 /* Put out the function name and left parenthesis. */
701 while ( p
!= endfn
) putc(*p
, out
), p
++;
702 /* Put out the declaration. */
705 for ( p
= breaks
[0]; *p
; p
++ )
706 if ( *p
== '\r' || *p
== '\n' )
710 { for ( ap
= breaks
+1; ap
< bp
; ap
+= 2 )
712 while ( isidchar(*p
) )
718 /* Put out the argument declarations */
719 for ( ap
= breaks
+2; ap
<= bp
; ap
+= 2 )
723 fputs(breaks
[0], out
); /* any prior args */
724 fputs("va_dcl", out
); /* the final arg */
728 fputs(breaks
[0], out
);
730 free((char *)breaks
);
734 /* Append a line to a buffer. Return the end of the appended line. */
736 appendline(lineend
, bufend
, in
)
741 if (bufend
== lineend
)
743 if (fgets(lineend
, (unsigned)(bufend
- lineend
), in
) == NULL
)
745 return lineend
+ strlen(lineend
);
749 * Concatenate string literals in a non-function line, appending
750 * new lines if a string literal crosses a line boundary or ends a line.
753 concatlits(line
, lineend
, bufend
, in
)
761 int pending_newlines
= 0;
762 if (lineend
[-1] != '\n')
764 if (*skipspace(s
, 1) == '#')
767 switch ((*d
++ = *s
++))
771 while ((s1
= scanstring(s
- 1, 1)) == lineend
)
772 if (!(lineend
= appendline(lineend
, bufend
, in
)))
778 while ((s1
= skipspace(s
, 1)) == lineend
)
779 if (!(lineend
= appendline(lineend
, bufend
, in
)))
784 do pending_newlines
+= *s
++ == '\n';
789 while (pending_newlines
--)