1 /* Code for handling XREF output from GNU C++.
2 Copyright (C) 1992, 1993, 1994, 1995, 1996, 1997, 1998,
3 2000 Free Software Foundation, Inc.
4 Contributed by Michael Tiemann (tiemann@cygnus.com)
6 This file is part of GNU CC.
8 GNU CC is free software; you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation; either version 2, or (at your option)
13 GNU CC is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU CC; see the file COPYING. If not, write to
20 the Free Software Foundation, 59 Temple Place - Suite 330,
21 Boston, MA 02111-1307, USA. */
31 /* The character(s) used to join a directory specification (obtained with
32 getwd or equivalent) with a non-absolute file name. */
34 #ifndef FILE_NAME_JOINER
35 #define FILE_NAME_JOINER "/"
38 /* Nonzero if NAME as a file name is absolute. */
39 #ifndef FILE_NAME_ABSOLUTE_P
40 #define FILE_NAME_ABSOLUTE_P(NAME) (NAME[0] == '/')
43 /* For cross referencing. */
47 /************************************************************************/
49 /* Common definitions */
51 /************************************************************************/
60 #define PALLOC(typ) ((typ *) xcalloc(1,sizeof(typ)))
63 /* Return a malloc'd copy of STR. */
64 #define SALLOC(str) ((char *) ((str) == NULL ? NULL : xstrdup (str)))
65 #define SFREE(str) (str != NULL && (free(str),0))
67 #define STREQL(s1,s2) (strcmp((s1),(s2)) == 0)
68 #define STRNEQ(s1,s2) (strcmp((s1),(s2)) != 0)
69 #define STRLSS(s1,s2) (strcmp((s1),(s2)) < 0)
70 #define STRLEQ(s1,s2) (strcmp((s1),(s2)) <= 0)
71 #define STRGTR(s1,s2) (strcmp((s1),(s2)) > 0)
72 #define STRGEQ(s1,s2) (strcmp((s1),(s2)) >= 0)
74 /************************************************************************/
76 /* Type definitions */
78 /************************************************************************/
81 typedef struct _XREF_FILE
* XREF_FILE
;
82 typedef struct _XREF_SCOPE
* XREF_SCOPE
;
84 typedef struct _XREF_FILE
91 typedef struct _XREF_SCOPE
100 /************************************************************************/
104 /************************************************************************/
106 static char doing_xref
= 0;
107 static FILE * xref_file
= NULL
;
108 static char xref_name
[1024];
109 static XREF_FILE all_files
= NULL
;
110 static char * wd_name
= NULL
;
111 static XREF_SCOPE cur_scope
= NULL
;
112 static int scope_ctr
= 0;
113 static XREF_FILE last_file
= NULL
;
114 static tree last_fndecl
= NULL
;
116 /************************************************************************/
118 /* Forward definitions */
120 /************************************************************************/
121 static void gen_assign
PARAMS ((XREF_FILE
, tree
));
122 static XREF_FILE find_file
PARAMS ((const char *));
123 static const char * filename
PARAMS ((XREF_FILE
));
124 static const char * fctname
PARAMS ((tree
));
125 static const char * declname
PARAMS ((tree
));
126 static void simplify_type
PARAMS ((char *));
127 static const char * fixname
PARAMS ((const char *, char *));
128 static void open_xref_file
PARAMS ((const char *));
129 static const char * classname
PARAMS ((tree
));
131 /* Start cross referencing. FILE is the name of the file we xref. */
134 GNU_xref_begin (file
)
139 if (file
!= NULL
&& STRNEQ (file
,"-"))
141 open_xref_file(file
);
146 /* Finish cross-referencing. ERRCNT is the number of errors
155 if (!doing_xref
) return;
157 xf
= find_file (input_filename
);
158 if (xf
== NULL
) return;
160 while (cur_scope
!= NULL
)
161 GNU_xref_end_scope(cur_scope
->gid
,0,0,0);
165 if (xref_file
== NULL
) return;
172 if (ect
> 0) unlink (xref_name
);
175 /* Write out xref for file named NAME. */
183 if (!doing_xref
|| name
== NULL
) return;
185 if (xref_file
== NULL
)
187 open_xref_file (name
);
188 if (!doing_xref
) return;
191 if (all_files
== NULL
)
192 fprintf(xref_file
,"SCP * 0 0 0 0 RESET\n");
194 xf
= find_file (name
);
195 if (xf
!= NULL
) return;
197 xf
= PALLOC (XREF_FILE_INFO
);
198 xf
->name
= SALLOC (name
);
199 xf
->next
= all_files
;
205 if (FILE_NAME_ABSOLUTE_P (name
) || ! wd_name
)
206 xf
->outname
= xf
->name
;
210 = (char *) xmalloc (strlen (wd_name
) + strlen (FILE_NAME_JOINER
)
211 + strlen (name
) + 1);
212 sprintf (nmbuf
, "%s%s%s", wd_name
, FILE_NAME_JOINER
, name
);
217 fprintf (xref_file
, "FIL %s %s 0\n", name
, wd_name
);
223 /* Start a scope identified at level ID. */
226 GNU_xref_start_scope (id
)
232 if (!doing_xref
) return;
233 xf
= find_file (input_filename
);
235 xs
= PALLOC (XREF_SCOPE_INFO
);
238 if (xs
->start
<= 0) xs
->start
= 1;
240 xs
->lid
= ++scope_ctr
;
241 xs
->outer
= cur_scope
;
245 /* Finish a scope at level ID.
248 KEEP is nonzero iff this scope is retained (nonzero if it's
249 a compiler-generated invisible scope).
253 GNU_xref_end_scope (id
,inid
,prm
,keep
)
259 XREF_SCOPE xs
,lxs
,oxs
;
262 if (!doing_xref
) return;
263 xf
= find_file (input_filename
);
264 if (xf
== NULL
) return;
267 for (xs
= cur_scope
; xs
!= NULL
; xs
= xs
->outer
)
269 if (xs
->gid
== id
) break;
272 if (xs
== NULL
) return;
275 for (oxs
= cur_scope
; oxs
!= NULL
; oxs
= oxs
->outer
) {
276 if (oxs
->gid
== inid
) break;
278 if (oxs
== NULL
) return;
282 if (prm
== 2) stype
= "SUE";
283 else if (prm
!= 0) stype
= "ARGS";
284 else if (keep
== 2 || inid
!= 0) stype
= "INTERN";
285 else stype
= "EXTERN";
287 fprintf (xref_file
, "SCP %s %d %d %d ",
288 filename (xf
), xs
->start
, lineno
,xs
->lid
);
289 fprintf (xref_file
, HOST_WIDE_INT_PRINT_DEC
, inid
);
290 fprintf (xref_file
, " %s\n", stype
);
292 if (lxs
== NULL
) cur_scope
= xs
->outer
;
293 else lxs
->outer
= xs
->outer
;
298 /* Output a reference to NAME in FNDECL. */
301 GNU_xref_ref (fndecl
,name
)
307 if (!doing_xref
) return;
308 xf
= find_file (input_filename
);
309 if (xf
== NULL
) return;
311 fprintf (xref_file
, "REF %s %d %s %s\n",
312 filename (xf
), lineno
, fctname (fndecl
), name
);
315 /* Output a reference to DECL in FNDECL. */
318 GNU_xref_decl (fndecl
,decl
)
328 if (!doing_xref
) return;
329 xf
= find_file (input_filename
);
330 if (xf
== NULL
) return;
334 if (TREE_CODE (decl
) == TYPE_DECL
) cls
= "TYPEDEF";
335 else if (TREE_CODE (decl
) == FIELD_DECL
) cls
= "FIELD";
336 else if (TREE_CODE (decl
) == VAR_DECL
)
338 if (fndecl
== NULL
&& TREE_STATIC(decl
)
339 && TREE_READONLY(decl
) && DECL_INITIAL(decl
) != 0
340 && !TREE_PUBLIC(decl
) && !DECL_EXTERNAL(decl
)
341 && DECL_MODE(decl
) != BLKmode
) cls
= "CONST";
342 else if (DECL_EXTERNAL(decl
)) cls
= "EXTERN";
343 else if (TREE_PUBLIC(decl
)) cls
= "EXTDEF";
344 else if (TREE_STATIC(decl
)) cls
= "STATIC";
345 else if (DECL_REGISTER(decl
)) cls
= "REGISTER";
348 else if (TREE_CODE (decl
) == PARM_DECL
) cls
= "PARAM";
349 else if (TREE_CODE (decl
) == FIELD_DECL
) cls
= "FIELD";
350 else if (TREE_CODE (decl
) == CONST_DECL
) cls
= "CONST";
351 else if (TREE_CODE (decl
) == FUNCTION_DECL
)
353 if (DECL_EXTERNAL (decl
)) cls
= "EXTERN";
354 else if (TREE_PUBLIC (decl
)) cls
= "EFUNCTION";
355 else cls
= "SFUNCTION";
357 else if (TREE_CODE (decl
) == LABEL_DECL
) cls
= "LABEL";
358 else if (TREE_CODE (decl
) == UNION_TYPE
)
361 decl
= TYPE_NAME (decl
);
364 else if (TREE_CODE (decl
) == RECORD_TYPE
)
366 if (CLASSTYPE_DECLARED_CLASS (decl
)) cls
= "CLASSID";
367 else cls
= "STRUCTID";
368 decl
= TYPE_NAME (decl
);
371 else if (TREE_CODE (decl
) == ENUMERAL_TYPE
)
374 decl
= TYPE_NAME (decl
);
377 else if (TREE_CODE (decl
) == TEMPLATE_DECL
)
379 if (TREE_CODE (DECL_RESULT (decl
)) == TYPE_DECL
)
381 else if (TREE_CODE (DECL_RESULT (decl
)) == FUNCTION_DECL
)
383 else if (TREE_CODE (DECL_RESULT (decl
)) == VAR_DECL
)
386 my_friendly_abort (358);
389 else cls
= "UNKNOWN";
391 if (decl
== NULL
|| DECL_NAME (decl
) == NULL
) return;
393 if (uselin
&& decl
->decl
.linenum
> 0 && decl
->decl
.filename
!= NULL
)
395 xf1
= find_file (decl
->decl
.filename
);
398 lineno
= decl
->decl
.linenum
;
403 if (DECL_ASSEMBLER_NAME (decl
))
404 name
= IDENTIFIER_POINTER (DECL_ASSEMBLER_NAME (decl
));
406 name
= IDENTIFIER_POINTER (DECL_NAME (decl
));
408 strcpy (buf
, type_as_string (TREE_TYPE (decl
), 0));
411 fprintf (xref_file
, "DCL %s %d %s %d %s %s %s\n",
412 filename(xf
), lineno
, name
,
413 (cur_scope
!= NULL
? cur_scope
->lid
: 0),
414 cls
, fctname(fndecl
), buf
);
416 if (STREQL (cls
, "STRUCTID") || STREQL (cls
, "UNIONID"))
419 fprintf (xref_file
, "DCL %s %d %s %d %s %s %s\n",
420 filename(xf
), lineno
,name
,
421 (cur_scope
!= NULL
? cur_scope
->lid
: 0),
422 cls
, fctname(fndecl
), buf
);
426 /* Output a reference to a call to NAME in FNDECL. */
429 GNU_xref_call (fndecl
, name
)
437 if (!doing_xref
) return;
438 xf
= find_file (input_filename
);
439 if (xf
== NULL
) return;
440 name
= fixname (name
, buf
);
442 for (s
= name
; *s
!= 0; ++s
)
443 if (*s
== '_' && s
[1] == '_') break;
444 if (*s
!= 0) GNU_xref_ref (fndecl
, name
);
446 fprintf (xref_file
, "CAL %s %d %s %s\n",
447 filename (xf
), lineno
, name
, fctname (fndecl
));
450 /* Output cross-reference info about FNDECL. If non-NULL,
451 ARGS are the arguments for the function (i.e., before the FUNCTION_DECL
452 has been fully built). */
455 GNU_xref_function (fndecl
, args
)
463 if (!doing_xref
) return;
464 xf
= find_file (input_filename
);
465 if (xf
== NULL
) return;
469 if (args
== NULL
) args
= DECL_ARGUMENTS (fndecl
);
471 GNU_xref_decl (NULL
, fndecl
);
473 for ( ; args
!= NULL
; args
= TREE_CHAIN (args
))
475 GNU_xref_decl (fndecl
,args
);
476 if (ct
!= 0) strcat (buf
,",");
477 strcat (buf
, declname (args
));
481 fprintf (xref_file
, "PRC %s %d %s %d %d %s\n",
482 filename(xf
), lineno
, declname(fndecl
),
483 (cur_scope
!= NULL
? cur_scope
->lid
: 0),
487 /* Output cross-reference info about an assignment to NAME. */
490 GNU_xref_assign(name
)
495 if (!doing_xref
) return;
496 xf
= find_file(input_filename
);
497 if (xf
== NULL
) return;
499 gen_assign(xf
, name
);
511 switch (TREE_CODE (name
))
513 case IDENTIFIER_NODE
:
514 s
= IDENTIFIER_POINTER(name
);
520 gen_assign(xf
, TREE_OPERAND(name
, 0));
521 gen_assign(xf
, TREE_OPERAND(name
, 1));
527 gen_assign(xf
, TREE_OPERAND(name
, 0));
530 gen_assign(xf
, TREE_OPERAND(name
, 1));
537 fprintf(xref_file
, "ASG %s %d %s\n", filename(xf
), lineno
, s
);
544 if (cls
&& TYPE_P (cls
))
545 cls
= TYPE_NAME (cls
);
546 if (cls
&& DECL_P (cls
))
547 cls
= DECL_NAME (cls
);
548 if (cls
&& TREE_CODE (cls
) == IDENTIFIER_NODE
)
549 return IDENTIFIER_POINTER (cls
);
553 /* Output cross-reference info about a class hierarchy.
554 CLS is the class type of interest. BASE is a baseclass
555 for CLS. PUB and VIRT give the access info about
556 the class derivation. FRND is nonzero iff BASE is a friend
559 ??? Needs to handle nested classes. */
562 GNU_xref_hier(cls
, base
, pub
, virt
, frnd
)
571 if (!doing_xref
) return;
572 xf
= find_file(input_filename
);
573 if (xf
== NULL
) return;
575 fprintf(xref_file
, "HIE %s %d %s %s %d %d %d\n",
576 filename(xf
), lineno
, classname (cls
), classname (base
),
580 /* Output cross-reference info about class members. CLS
581 is the containing type; FLD is the class member. */
584 GNU_xref_member(cls
, fld
)
592 #ifdef XREF_SHORT_MEMBER_NAMES
595 char buf
[1024], bufa
[1024];
597 if (!doing_xref
) return;
598 xf
= find_file(fld
->decl
.filename
);
599 if (xf
== NULL
) return;
601 if (TREE_PRIVATE (fld
)) prot
= "PRIVATE";
602 else if (TREE_PROTECTED(fld
)) prot
= "PROTECTED";
603 else prot
= "PUBLIC";
606 if (TREE_CODE (fld
) == FUNCTION_DECL
&& DECL_CONST_MEMFUNC_P(fld
))
608 else if (TREE_CODE (fld
) == CONST_DECL
)
612 if (TREE_CODE (fld
) == FUNCTION_DECL
&& DECL_PURE_VIRTUAL_P(fld
))
615 d
= IDENTIFIER_POINTER(cls
);
616 sprintf(buf
, "%d%s", (int) strlen(d
), d
);
617 #ifdef XREF_SHORT_MEMBER_NAMES
620 strcpy(bufa
, declname(fld
));
622 #ifdef XREF_SHORT_MEMBER_NAMES
623 for (p
= &bufa
[1]; *p
!= 0; ++p
)
625 if (p
[0] == '_' && p
[1] == '_' && p
[2] >= '0' && p
[2] <= '9') {
626 if (strncmp(&p
[2], buf
, i
) == 0) *p
= 0;
629 else if (p
[0] == '_' && p
[1] == '_' && p
[2] == 'C' && p
[3] >= '0' && p
[3] <= '9') {
630 if (strncmp(&p
[3], buf
, i
) == 0) *p
= 0;
636 fprintf(xref_file
, "MEM %s %d %s %s %s %d %d %d %d %d %d %d\n",
637 filename(xf
), fld
->decl
.linenum
, d
, bufa
, prot
,
638 (TREE_CODE (fld
) == FUNCTION_DECL
? 0 : 1),
639 (DECL_INLINE (fld
) ? 1 : 0),
640 (DECL_LANG_SPECIFIC(fld
) && DECL_FRIEND_P(fld
) ? 1 : 0),
641 (DECL_VINDEX(fld
) ? 1 : 0),
642 (TREE_STATIC(fld
) ? 1 : 0),
646 /* Find file entry given name. */
654 for (xf
= all_files
; xf
!= NULL
; xf
= xf
->next
) {
655 if (STREQL(name
, xf
->name
)) break;
661 /* Return filename for output purposes. */
672 if (last_file
== xf
) return "*";
679 /* Return function name for output purposes. */
685 static char fctbuf
[1024];
688 if (fndecl
== NULL
&& last_fndecl
== NULL
) return "*";
696 if (fndecl
== last_fndecl
) return "*";
698 last_fndecl
= fndecl
;
700 s
= declname(fndecl
);
701 s
= fixname(s
, fctbuf
);
706 /* Return decl name for output purposes. */
712 if (DECL_NAME (dcl
) == NULL
) return "?";
714 if (DECL_ASSEMBLER_NAME (dcl
))
715 return IDENTIFIER_POINTER (DECL_ASSEMBLER_NAME (dcl
));
717 return IDENTIFIER_POINTER (DECL_NAME (dcl
));
720 /* Simplify a type string by removing unneeded parenthesis. */
730 while (i
> 0 && ISSPACE((unsigned char) typ
[i
-1])) typ
[--i
] = 0;
732 if (i
> 7 && STREQL(&typ
[i
-5], "const"))
738 if (typ
[i
-1] != ')') return;
743 if (*s
== ')') ++lvl
;
757 if (*s
!= 0 && s
[-1] == ')')
761 if (*s
== '(') s
[2] = 0;
762 else if (*s
== ':') {
763 while (*s
!= '(') --s
;
770 /* Fixup a function name (take care of embedded spaces). */
797 if (fg
== 0) return nam
;
802 /* Open file for xreffing. */
811 #ifdef XREF_FILE_NAME
812 XREF_FILE_NAME (xref_name
, file
);
814 s
= rindex (file
, '/');
816 sprintf (xref_name
, ".%s.gxref", file
);
820 strcpy (xref_name
, file
);
821 t
= rindex (xref_name
, '/');
825 strcat (t
, ".gxref");
827 #endif /* no XREF_FILE_NAME */
829 xref_file
= fopen(xref_name
, "w");
831 if (xref_file
== NULL
)
833 error("Can't create cross-reference file `%s'", xref_name
);