fc2d1078ac2f021e87f631811aaa10575a8467b9
1 /* Code for handling XREF output from GNU C++.
2 Copyright (C) 1992, 1993, 1994, 1995 Free Software Foundation, Inc.
3 Contributed by Michael Tiemann (tiemann@cygnus.com)
5 This file is part of GNU CC.
7 GNU CC is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
12 GNU CC is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU CC; see the file COPYING. If not, write to
19 the Free Software Foundation, 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
39 extern char *getpwd
PROTO((void));
44 extern char *index ();
45 extern char *rindex ();
48 /* The character(s) used to join a directory specification (obtained with
49 getwd or equivalent) with a non-absolute file name. */
51 #ifndef FILE_NAME_JOINER
52 #define FILE_NAME_JOINER "/"
55 /* Nonzero if NAME as a file name is absolute. */
56 #ifndef FILE_NAME_ABSOLUTE_P
57 #define FILE_NAME_ABSOLUTE_P(NAME) (NAME[0] == '/')
60 /* For cross referencing. */
64 /************************************************************************/
66 /* Common definitions */
68 /************************************************************************/
77 #define PALLOC(typ) ((typ *) calloc(1,sizeof(typ)))
80 /* Return a malloc'd copy of STR. */
82 ((char *) ((str) == NULL ? NULL \
83 : (char *) strcpy ((char *) malloc (strlen ((str)) + 1), (str))))
84 #define SFREE(str) (str != NULL && (free(str),0))
86 #define STREQL(s1,s2) (strcmp((s1),(s2)) == 0)
87 #define STRNEQ(s1,s2) (strcmp((s1),(s2)) != 0)
88 #define STRLSS(s1,s2) (strcmp((s1),(s2)) < 0)
89 #define STRLEQ(s1,s2) (strcmp((s1),(s2)) <= 0)
90 #define STRGTR(s1,s2) (strcmp((s1),(s2)) > 0)
91 #define STRGEQ(s1,s2) (strcmp((s1),(s2)) >= 0)
93 /************************************************************************/
95 /* Type definitions */
97 /************************************************************************/
100 typedef struct _XREF_FILE
* XREF_FILE
;
101 typedef struct _XREF_SCOPE
* XREF_SCOPE
;
103 typedef struct _XREF_FILE
110 typedef struct _XREF_SCOPE
119 /************************************************************************/
123 /************************************************************************/
125 static char doing_xref
= 0;
126 static FILE * xref_file
= NULL
;
127 static char xref_name
[1024];
128 static XREF_FILE all_files
= NULL
;
129 static char * wd_name
= NULL
;
130 static XREF_SCOPE cur_scope
= NULL
;
131 static int scope_ctr
= 0;
132 static XREF_FILE last_file
= NULL
;
133 static tree last_fndecl
= NULL
;
135 /************************************************************************/
137 /* Forward definitions */
139 /************************************************************************/
140 static void gen_assign
PROTO((XREF_FILE
, tree
));
141 static XREF_FILE find_file
PROTO((char *));
142 static char * filename
PROTO((XREF_FILE
));
143 static char * fctname
PROTO((tree
));
144 static char * declname
PROTO((tree
));
145 static void simplify_type
PROTO((char *));
146 static char * fixname
PROTO((char *, char *));
147 static void open_xref_file
PROTO((char *));
149 /* Start cross referencing. FILE is the name of the file we xref. */
152 GNU_xref_begin (file
)
157 if (file
!= NULL
&& STRNEQ (file
,"-"))
159 open_xref_file(file
);
164 /* Finish cross-referencing. ERRCNT is the number of errors
173 if (!doing_xref
) return;
175 xf
= find_file (input_filename
);
176 if (xf
== NULL
) return;
178 while (cur_scope
!= NULL
)
179 GNU_xref_end_scope(cur_scope
->gid
,0,0,0);
183 if (xref_file
== NULL
) return;
190 if (ect
> 0) unlink (xref_name
);
193 /* Write out xref for file named NAME. */
201 if (!doing_xref
|| name
== NULL
) return;
203 if (xref_file
== NULL
)
205 open_xref_file (name
);
206 if (!doing_xref
) return;
209 if (all_files
== NULL
)
210 fprintf(xref_file
,"SCP * 0 0 0 0 RESET\n");
212 xf
= find_file (name
);
213 if (xf
!= NULL
) return;
215 xf
= PALLOC (XREF_FILE_INFO
);
216 xf
->name
= SALLOC (name
);
217 xf
->next
= all_files
;
223 if (FILE_NAME_ABSOLUTE_P (name
) || ! wd_name
)
224 xf
->outname
= xf
->name
;
228 = (char *) malloc (strlen (wd_name
) + strlen (FILE_NAME_JOINER
)
229 + strlen (name
) + 1);
230 sprintf (nmbuf
, "%s%s%s", wd_name
, FILE_NAME_JOINER
, name
);
235 fprintf (xref_file
, "FIL %s %s 0\n", name
, wd_name
);
241 /* Start a scope identified at level ID. */
244 GNU_xref_start_scope (id
)
250 if (!doing_xref
) return;
251 xf
= find_file (input_filename
);
253 xs
= PALLOC (XREF_SCOPE_INFO
);
256 if (xs
->start
<= 0) xs
->start
= 1;
258 xs
->lid
= ++scope_ctr
;
259 xs
->outer
= cur_scope
;
263 /* Finish a scope at level ID.
266 KEEP is nonzero iff this scope is retained (nonzero if it's
267 a compiler-generated invisible scope).
271 GNU_xref_end_scope (id
,inid
,prm
,keep
)
277 XREF_SCOPE xs
,lxs
,oxs
;
280 if (!doing_xref
) return;
281 xf
= find_file (input_filename
);
282 if (xf
== NULL
) return;
285 for (xs
= cur_scope
; xs
!= NULL
; xs
= xs
->outer
)
287 if (xs
->gid
== id
) break;
290 if (xs
== NULL
) return;
293 for (oxs
= cur_scope
; oxs
!= NULL
; oxs
= oxs
->outer
) {
294 if (oxs
->gid
== inid
) break;
296 if (oxs
== NULL
) return;
300 if (prm
== 2) stype
= "SUE";
301 else if (prm
!= 0) stype
= "ARGS";
302 else if (keep
== 2 || inid
!= 0) stype
= "INTERN";
303 else stype
= "EXTERN";
305 fprintf (xref_file
,"SCP %s %d %d %d %d %s\n",
306 filename (xf
), xs
->start
, lineno
,xs
->lid
, inid
, stype
);
308 if (lxs
== NULL
) cur_scope
= xs
->outer
;
309 else lxs
->outer
= xs
->outer
;
314 /* Output a reference to NAME in FNDECL. */
317 GNU_xref_ref (fndecl
,name
)
323 if (!doing_xref
) return;
324 xf
= find_file (input_filename
);
325 if (xf
== NULL
) return;
327 fprintf (xref_file
, "REF %s %d %s %s\n",
328 filename (xf
), lineno
, fctname (fndecl
), name
);
331 /* Output a reference to DECL in FNDECL. */
334 GNU_xref_decl (fndecl
,decl
)
344 if (!doing_xref
) return;
345 xf
= find_file (input_filename
);
346 if (xf
== NULL
) return;
350 if (TREE_CODE (decl
) == TYPE_DECL
) cls
= "TYPEDEF";
351 else if (TREE_CODE (decl
) == FIELD_DECL
) cls
= "FIELD";
352 else if (TREE_CODE (decl
) == VAR_DECL
)
354 if (fndecl
== NULL
&& TREE_STATIC(decl
)
355 && TREE_READONLY(decl
) && DECL_INITIAL(decl
) != 0
356 && !TREE_PUBLIC(decl
) && !DECL_EXTERNAL(decl
)
357 && DECL_MODE(decl
) != BLKmode
) cls
= "CONST";
358 else if (DECL_EXTERNAL(decl
)) cls
= "EXTERN";
359 else if (TREE_PUBLIC(decl
)) cls
= "EXTDEF";
360 else if (TREE_STATIC(decl
)) cls
= "STATIC";
361 else if (DECL_REGISTER(decl
)) cls
= "REGISTER";
364 else if (TREE_CODE (decl
) == PARM_DECL
) cls
= "PARAM";
365 else if (TREE_CODE (decl
) == FIELD_DECL
) cls
= "FIELD";
366 else if (TREE_CODE (decl
) == CONST_DECL
) cls
= "CONST";
367 else if (TREE_CODE (decl
) == FUNCTION_DECL
)
369 if (DECL_EXTERNAL (decl
)) cls
= "EXTERN";
370 else if (TREE_PUBLIC (decl
)) cls
= "EFUNCTION";
371 else cls
= "SFUNCTION";
373 else if (TREE_CODE (decl
) == LABEL_DECL
) cls
= "LABEL";
374 else if (TREE_CODE (decl
) == UNION_TYPE
)
377 decl
= TYPE_NAME (decl
);
380 else if (TREE_CODE (decl
) == RECORD_TYPE
)
382 if (CLASSTYPE_DECLARED_CLASS (decl
)) cls
= "CLASSID";
383 else if (IS_SIGNATURE (decl
)) cls
= "SIGNATUREID";
384 else cls
= "STRUCTID";
385 decl
= TYPE_NAME (decl
);
388 else if (TREE_CODE (decl
) == ENUMERAL_TYPE
)
391 decl
= TYPE_NAME (decl
);
394 else if (TREE_CODE (decl
) == TEMPLATE_DECL
)
396 if (TREE_CODE (DECL_RESULT (decl
)) == TYPE_DECL
)
398 else if (TREE_CODE (DECL_RESULT (decl
)) == FUNCTION_DECL
)
400 else if (TREE_CODE (DECL_RESULT (decl
)) == VAR_DECL
)
403 my_friendly_abort (358);
406 else cls
= "UNKNOWN";
408 if (decl
== NULL
|| DECL_NAME (decl
) == NULL
) return;
410 if (uselin
&& decl
->decl
.linenum
> 0 && decl
->decl
.filename
!= NULL
)
412 xf1
= find_file (decl
->decl
.filename
);
415 lineno
= decl
->decl
.linenum
;
420 if (DECL_ASSEMBLER_NAME (decl
))
421 name
= IDENTIFIER_POINTER (DECL_ASSEMBLER_NAME (decl
));
423 name
= IDENTIFIER_POINTER (DECL_NAME (decl
));
425 strcpy (buf
, type_as_string (TREE_TYPE (decl
), 0));
428 fprintf (xref_file
, "DCL %s %d %s %d %s %s %s\n",
429 filename(xf
), lineno
, name
,
430 (cur_scope
!= NULL
? cur_scope
->lid
: 0),
431 cls
, fctname(fndecl
), buf
);
433 if (STREQL (cls
, "STRUCTID") || STREQL (cls
, "UNIONID")
434 || STREQL (cls
, "SIGNATUREID"))
437 fprintf (xref_file
, "DCL %s %d %s %d %s %s %s\n",
438 filename(xf
), lineno
,name
,
439 (cur_scope
!= NULL
? cur_scope
->lid
: 0),
440 cls
, fctname(fndecl
), buf
);
444 /* Output a reference to a call to NAME in FNDECL. */
447 GNU_xref_call (fndecl
, name
)
455 if (!doing_xref
) return;
456 xf
= find_file (input_filename
);
457 if (xf
== NULL
) return;
458 name
= fixname (name
, buf
);
460 for (s
= name
; *s
!= 0; ++s
)
461 if (*s
== '_' && s
[1] == '_') break;
462 if (*s
!= 0) GNU_xref_ref (fndecl
, name
);
464 fprintf (xref_file
, "CAL %s %d %s %s\n",
465 filename (xf
), lineno
, name
, fctname (fndecl
));
468 /* Output cross-reference info about FNDECL. If non-NULL,
469 ARGS are the arguments for the function (i.e., before the FUNCTION_DECL
470 has been fully built). */
473 GNU_xref_function (fndecl
, args
)
481 if (!doing_xref
) return;
482 xf
= find_file (input_filename
);
483 if (xf
== NULL
) return;
487 if (args
== NULL
) args
= DECL_ARGUMENTS (fndecl
);
489 GNU_xref_decl (NULL
, fndecl
);
491 for ( ; args
!= NULL
; args
= TREE_CHAIN (args
))
493 GNU_xref_decl (fndecl
,args
);
494 if (ct
!= 0) strcat (buf
,",");
495 strcat (buf
, declname (args
));
499 fprintf (xref_file
, "PRC %s %d %s %d %d %s\n",
500 filename(xf
), lineno
, declname(fndecl
),
501 (cur_scope
!= NULL
? cur_scope
->lid
: 0),
505 /* Output cross-reference info about an assignment to NAME. */
508 GNU_xref_assign(name
)
513 if (!doing_xref
) return;
514 xf
= find_file(input_filename
);
515 if (xf
== NULL
) return;
517 gen_assign(xf
, name
);
529 switch (TREE_CODE (name
))
531 case IDENTIFIER_NODE
:
532 s
= IDENTIFIER_POINTER(name
);
538 gen_assign(xf
, TREE_OPERAND(name
, 0));
539 gen_assign(xf
, TREE_OPERAND(name
, 1));
545 gen_assign(xf
, TREE_OPERAND(name
, 0));
548 gen_assign(xf
, TREE_OPERAND(name
, 1));
555 fprintf(xref_file
, "ASG %s %d %s\n", filename(xf
), lineno
, s
);
558 /* Output cross-reference info about a class hierarchy.
559 CLS is the class type of interest. BASE is a baseclass
560 for CLS. PUB and VIRT give the access info about
561 the class derivation. FRND is nonzero iff BASE is a friend
564 ??? Needs to handle nested classes. */
567 GNU_xref_hier(cls
, base
, pub
, virt
, frnd
)
576 if (!doing_xref
) return;
577 xf
= find_file(input_filename
);
578 if (xf
== NULL
) return;
580 fprintf(xref_file
, "HIE %s %d %s %s %d %d %d\n",
581 filename(xf
), lineno
, cls
, base
, pub
, virt
, frnd
);
584 /* Output cross-reference info about class members. CLS
585 is the containing type; FLD is the class member. */
588 GNU_xref_member(cls
, fld
)
596 #ifdef XREF_SHORT_MEMBER_NAMES
599 char buf
[1024], bufa
[1024];
601 if (!doing_xref
) return;
602 xf
= find_file(fld
->decl
.filename
);
603 if (xf
== NULL
) return;
605 if (TREE_PRIVATE (fld
)) prot
= "PRIVATE";
606 else if (TREE_PROTECTED(fld
)) prot
= "PROTECTED";
607 else prot
= "PUBLIC";
610 if (TREE_CODE (fld
) == FUNCTION_DECL
&& DECL_CONST_MEMFUNC_P(fld
))
612 else if (TREE_CODE (fld
) == CONST_DECL
)
616 if (TREE_CODE (fld
) == FUNCTION_DECL
&& DECL_ABSTRACT_VIRTUAL_P(fld
))
619 d
= IDENTIFIER_POINTER(cls
);
620 sprintf(buf
, "%d%s", strlen(d
), d
);
621 #ifdef XREF_SHORT_MEMBER_NAMES
624 strcpy(bufa
, declname(fld
));
626 #ifdef XREF_SHORT_MEMBER_NAMES
627 for (p
= &bufa
[1]; *p
!= 0; ++p
)
629 if (p
[0] == '_' && p
[1] == '_' && p
[2] >= '0' && p
[2] <= '9') {
630 if (strncmp(&p
[2], buf
, i
) == 0) *p
= 0;
633 else if (p
[0] == '_' && p
[1] == '_' && p
[2] == 'C' && p
[3] >= '0' && p
[3] <= '9') {
634 if (strncmp(&p
[3], buf
, i
) == 0) *p
= 0;
640 fprintf(xref_file
, "MEM %s %d %s %s %s %d %d %d %d %d %d %d\n",
641 filename(xf
), fld
->decl
.linenum
, d
, bufa
, prot
,
642 (TREE_CODE (fld
) == FUNCTION_DECL
? 0 : 1),
643 (DECL_INLINE (fld
) ? 1 : 0),
644 (DECL_LANG_SPECIFIC(fld
) && DECL_FRIEND_P(fld
) ? 1 : 0),
645 (DECL_VINDEX(fld
) ? 1 : 0),
646 (TREE_STATIC(fld
) ? 1 : 0),
650 /* Find file entry given name. */
658 for (xf
= all_files
; xf
!= NULL
; xf
= xf
->next
) {
659 if (STREQL(name
, xf
->name
)) break;
665 /* Return filename for output purposes. */
676 if (last_file
== xf
) return "*";
683 /* Return function name for output purposes. */
689 static char fctbuf
[1024];
692 if (fndecl
== NULL
&& last_fndecl
== NULL
) return "*";
700 if (fndecl
== last_fndecl
) return "*";
702 last_fndecl
= fndecl
;
704 s
= declname(fndecl
);
705 s
= fixname(s
, fctbuf
);
710 /* Return decl name for output purposes. */
716 if (DECL_NAME (dcl
) == NULL
) return "?";
718 if (DECL_ASSEMBLER_NAME (dcl
))
719 return IDENTIFIER_POINTER (DECL_ASSEMBLER_NAME (dcl
));
721 return IDENTIFIER_POINTER (DECL_NAME (dcl
));
724 /* Simplify a type string by removing unneeded parenthesis. */
734 while (i
> 0 && isspace(typ
[i
-1])) typ
[--i
] = 0;
736 if (i
> 7 && STREQL(&typ
[i
-5], "const"))
742 if (typ
[i
-1] != ')') return;
747 if (*s
== ')') ++lvl
;
761 if (*s
!= 0 && s
[-1] == ')')
765 if (*s
== '(') s
[2] = 0;
766 else if (*s
== ':') {
767 while (*s
!= '(') --s
;
774 /* Fixup a function name (take care of embedded spaces). */
800 if (fg
== 0) return nam
;
805 /* Open file for xreffing. */
813 #ifdef XREF_FILE_NAME
814 XREF_FILE_NAME (xref_name
, file
);
816 s
= rindex (file
, '/');
818 sprintf (xref_name
, ".%s.gxref", file
);
822 strcpy (xref_name
, file
);
823 t
= rindex (xref_name
, '/');
827 strcat (t
, ".gxref");
829 #endif /* no XREF_FILE_NAME */
831 xref_file
= fopen(xref_name
, "w");
833 if (xref_file
== NULL
)
835 error("Can't create cross-reference file `%s'", xref_name
);