1 /* Code for handling XREF output from GNU C++.
2 Copyright (C) 1992, 93-97, 1998 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. */
30 /* The character(s) used to join a directory specification (obtained with
31 getwd or equivalent) with a non-absolute file name. */
33 #ifndef FILE_NAME_JOINER
34 #define FILE_NAME_JOINER "/"
37 /* Nonzero if NAME as a file name is absolute. */
38 #ifndef FILE_NAME_ABSOLUTE_P
39 #define FILE_NAME_ABSOLUTE_P(NAME) (NAME[0] == '/')
42 /* For cross referencing. */
46 /************************************************************************/
48 /* Common definitions */
50 /************************************************************************/
59 #define PALLOC(typ) ((typ *) xcalloc(1,sizeof(typ)))
62 /* Return a malloc'd copy of STR. */
64 ((char *) ((str) == NULL ? NULL \
65 : (char *) strcpy ((char *) xmalloc (strlen ((str)) + 1), (str))))
66 #define SFREE(str) (str != NULL && (free(str),0))
68 #define STREQL(s1,s2) (strcmp((s1),(s2)) == 0)
69 #define STRNEQ(s1,s2) (strcmp((s1),(s2)) != 0)
70 #define STRLSS(s1,s2) (strcmp((s1),(s2)) < 0)
71 #define STRLEQ(s1,s2) (strcmp((s1),(s2)) <= 0)
72 #define STRGTR(s1,s2) (strcmp((s1),(s2)) > 0)
73 #define STRGEQ(s1,s2) (strcmp((s1),(s2)) >= 0)
75 /************************************************************************/
77 /* Type definitions */
79 /************************************************************************/
82 typedef struct _XREF_FILE * XREF_FILE;
83 typedef struct _XREF_SCOPE * XREF_SCOPE;
85 typedef struct _XREF_FILE
92 typedef struct _XREF_SCOPE
101 /************************************************************************/
105 /************************************************************************/
107 static char doing_xref = 0;
108 static FILE * xref_file = NULL;
109 static char xref_name[1024];
110 static XREF_FILE all_files = NULL;
111 static char * wd_name = NULL;
112 static XREF_SCOPE cur_scope = NULL;
113 static int scope_ctr = 0;
114 static XREF_FILE last_file = NULL;
115 static tree last_fndecl = NULL;
117 /************************************************************************/
119 /* Forward definitions */
121 /************************************************************************/
122 static void gen_assign PROTO((XREF_FILE, tree));
123 static XREF_FILE find_file PROTO((const char *));
124 static const char * filename PROTO((XREF_FILE));
125 static const char * fctname PROTO((tree));
126 static const char * declname PROTO((tree));
127 static void simplify_type PROTO((char *));
128 static const char * fixname PROTO((const char *, char *));
129 static void open_xref_file PROTO((const char *));
130 static const char * classname PROTO((tree));
132 /* Start cross referencing. FILE is the name of the file we xref. */
135 GNU_xref_begin (file)
140 if (file != NULL && STRNEQ (file,"-"))
142 open_xref_file(file);
147 /* Finish cross-referencing. ERRCNT is the number of errors
156 if (!doing_xref) return;
158 xf = find_file (input_filename);
159 if (xf == NULL) return;
161 while (cur_scope != NULL)
162 GNU_xref_end_scope(cur_scope->gid,0,0,0);
166 if (xref_file == NULL) return;
173 if (ect > 0) unlink (xref_name);
176 /* Write out xref for file named NAME. */
184 if (!doing_xref || name == NULL) return;
186 if (xref_file == NULL)
188 open_xref_file (name);
189 if (!doing_xref) return;
192 if (all_files == NULL)
193 fprintf(xref_file,"SCP * 0 0 0 0 RESET\n");
195 xf = find_file (name);
196 if (xf != NULL) return;
198 xf = PALLOC (XREF_FILE_INFO);
199 xf->name = SALLOC (name);
200 xf->next = all_files;
206 if (FILE_NAME_ABSOLUTE_P (name) || ! wd_name)
207 xf->outname = xf->name;
211 = (char *) xmalloc (strlen (wd_name) + strlen (FILE_NAME_JOINER)
212 + strlen (name) + 1);
213 sprintf (nmbuf, "%s%s%s", wd_name, FILE_NAME_JOINER, name);
218 fprintf (xref_file, "FIL %s %s 0\n", name, wd_name);
224 /* Start a scope identified at level ID. */
227 GNU_xref_start_scope (id)
233 if (!doing_xref) return;
234 xf = find_file (input_filename);
236 xs = PALLOC (XREF_SCOPE_INFO);
239 if (xs->start <= 0) xs->start = 1;
241 xs->lid = ++scope_ctr;
242 xs->outer = cur_scope;
246 /* Finish a scope at level ID.
249 KEEP is nonzero iff this scope is retained (nonzero if it's
250 a compiler-generated invisible scope).
254 GNU_xref_end_scope (id,inid,prm,keep)
260 XREF_SCOPE xs,lxs,oxs;
263 if (!doing_xref) return;
264 xf = find_file (input_filename);
265 if (xf == NULL) return;
268 for (xs = cur_scope; xs != NULL; xs = xs->outer)
270 if (xs->gid == id) break;
273 if (xs == NULL) return;
276 for (oxs = cur_scope; oxs != NULL; oxs = oxs->outer) {
277 if (oxs->gid == inid) break;
279 if (oxs == NULL) return;
283 if (prm == 2) stype = "SUE";
284 else if (prm != 0) stype = "ARGS";
285 else if (keep == 2 || inid != 0) stype = "INTERN";
286 else stype = "EXTERN";
288 fprintf (xref_file, "SCP %s %d %d %d ",
289 filename (xf), xs->start, lineno,xs->lid);
290 fprintf (xref_file, HOST_WIDE_INT_PRINT_DEC, inid);
291 fprintf (xref_file, " %s\n", stype);
293 if (lxs == NULL) cur_scope = xs->outer;
294 else lxs->outer = xs->outer;
299 /* Output a reference to NAME in FNDECL. */
302 GNU_xref_ref (fndecl,name)
308 if (!doing_xref) return;
309 xf = find_file (input_filename);
310 if (xf == NULL) return;
312 fprintf (xref_file, "REF %s %d %s %s\n",
313 filename (xf), lineno, fctname (fndecl), name);
316 /* Output a reference to DECL in FNDECL. */
319 GNU_xref_decl (fndecl,decl)
329 if (!doing_xref) return;
330 xf = find_file (input_filename);
331 if (xf == NULL) return;
335 if (TREE_CODE (decl) == TYPE_DECL) cls = "TYPEDEF";
336 else if (TREE_CODE (decl) == FIELD_DECL) cls = "FIELD";
337 else if (TREE_CODE (decl) == VAR_DECL)
339 if (fndecl == NULL && TREE_STATIC(decl)
340 && TREE_READONLY(decl) && DECL_INITIAL(decl) != 0
341 && !TREE_PUBLIC(decl) && !DECL_EXTERNAL(decl)
342 && DECL_MODE(decl) != BLKmode) cls = "CONST";
343 else if (DECL_EXTERNAL(decl)) cls = "EXTERN";
344 else if (TREE_PUBLIC(decl)) cls = "EXTDEF";
345 else if (TREE_STATIC(decl)) cls = "STATIC";
346 else if (DECL_REGISTER(decl)) cls = "REGISTER";
349 else if (TREE_CODE (decl) == PARM_DECL) cls = "PARAM";
350 else if (TREE_CODE (decl) == FIELD_DECL) cls = "FIELD";
351 else if (TREE_CODE (decl) == CONST_DECL) cls = "CONST";
352 else if (TREE_CODE (decl) == FUNCTION_DECL)
354 if (DECL_EXTERNAL (decl)) cls = "EXTERN";
355 else if (TREE_PUBLIC (decl)) cls = "EFUNCTION";
356 else cls = "SFUNCTION";
358 else if (TREE_CODE (decl) == LABEL_DECL) cls = "LABEL";
359 else if (TREE_CODE (decl) == UNION_TYPE)
362 decl = TYPE_NAME (decl);
365 else if (TREE_CODE (decl) == RECORD_TYPE)
367 if (CLASSTYPE_DECLARED_CLASS (decl)) cls = "CLASSID";
368 else cls = "STRUCTID";
369 decl = TYPE_NAME (decl);
372 else if (TREE_CODE (decl) == ENUMERAL_TYPE)
375 decl = TYPE_NAME (decl);
378 else if (TREE_CODE (decl) == TEMPLATE_DECL)
380 if (TREE_CODE (DECL_RESULT (decl)) == TYPE_DECL)
382 else if (TREE_CODE (DECL_RESULT (decl)) == FUNCTION_DECL)
384 else if (TREE_CODE (DECL_RESULT (decl)) == VAR_DECL)
387 my_friendly_abort (358);
390 else cls = "UNKNOWN";
392 if (decl == NULL || DECL_NAME (decl) == NULL) return;
394 if (uselin && decl->decl.linenum > 0 && decl->decl.filename != NULL)
396 xf1 = find_file (decl->decl.filename);
399 lineno = decl->decl.linenum;
404 if (DECL_ASSEMBLER_NAME (decl))
405 name = IDENTIFIER_POINTER (DECL_ASSEMBLER_NAME (decl));
407 name = IDENTIFIER_POINTER (DECL_NAME (decl));
409 strcpy (buf, type_as_string (TREE_TYPE (decl), 0));
412 fprintf (xref_file, "DCL %s %d %s %d %s %s %s\n",
413 filename(xf), lineno, name,
414 (cur_scope != NULL ? cur_scope->lid : 0),
415 cls, fctname(fndecl), buf);
417 if (STREQL (cls, "STRUCTID") || STREQL (cls, "UNIONID"))
420 fprintf (xref_file, "DCL %s %d %s %d %s %s %s\n",
421 filename(xf), lineno,name,
422 (cur_scope != NULL ? cur_scope->lid : 0),
423 cls, fctname(fndecl), buf);
427 /* Output a reference to a call to NAME in FNDECL. */
430 GNU_xref_call (fndecl, name)
438 if (!doing_xref) return;
439 xf = find_file (input_filename);
440 if (xf == NULL) return;
441 name = fixname (name, buf);
443 for (s = name; *s != 0; ++s)
444 if (*s == '_' && s[1] == '_') break;
445 if (*s != 0) GNU_xref_ref (fndecl, name);
447 fprintf (xref_file, "CAL %s %d %s %s\n",
448 filename (xf), lineno, name, fctname (fndecl));
451 /* Output cross-reference info about FNDECL. If non-NULL,
452 ARGS are the arguments for the function (i.e., before the FUNCTION_DECL
453 has been fully built). */
456 GNU_xref_function (fndecl, args)
464 if (!doing_xref) return;
465 xf = find_file (input_filename);
466 if (xf == NULL) return;
470 if (args == NULL) args = DECL_ARGUMENTS (fndecl);
472 GNU_xref_decl (NULL, fndecl);
474 for ( ; args != NULL; args = TREE_CHAIN (args))
476 GNU_xref_decl (fndecl,args);
477 if (ct != 0) strcat (buf,",");
478 strcat (buf, declname (args));
482 fprintf (xref_file, "PRC %s %d %s %d %d %s\n",
483 filename(xf), lineno, declname(fndecl),
484 (cur_scope != NULL ? cur_scope->lid : 0),
488 /* Output cross-reference info about an assignment to NAME. */
491 GNU_xref_assign(name)
496 if (!doing_xref) return;
497 xf = find_file(input_filename);
498 if (xf == NULL) return;
500 gen_assign(xf, name);
512 switch (TREE_CODE (name))
514 case IDENTIFIER_NODE :
515 s = IDENTIFIER_POINTER(name);
521 gen_assign(xf, TREE_OPERAND(name, 0));
522 gen_assign(xf, TREE_OPERAND(name, 1));
528 gen_assign(xf, TREE_OPERAND(name, 0));
531 gen_assign(xf, TREE_OPERAND(name, 1));
538 fprintf(xref_file, "ASG %s %d %s\n", filename(xf), lineno, s);
545 if (cls && TREE_CODE_CLASS (TREE_CODE (cls)) == 't')
546 cls = TYPE_NAME (cls);
547 if (cls && TREE_CODE_CLASS (TREE_CODE (cls)) == 'd')
548 cls = DECL_NAME (cls);
549 if (cls && TREE_CODE (cls) == IDENTIFIER_NODE)
550 return IDENTIFIER_POINTER (cls);
554 /* Output cross-reference info about a class hierarchy.
555 CLS is the class type of interest. BASE is a baseclass
556 for CLS. PUB and VIRT give the access info about
557 the class derivation. FRND is nonzero iff BASE is a friend
560 ??? Needs to handle nested classes. */
563 GNU_xref_hier(cls, base, pub, virt, frnd)
572 if (!doing_xref) return;
573 xf = find_file(input_filename);
574 if (xf == NULL) return;
576 fprintf(xref_file, "HIE %s %d %s %s %d %d %d\n",
577 filename(xf), lineno, classname (cls), classname (base),
581 /* Output cross-reference info about class members. CLS
582 is the containing type; FLD is the class member. */
585 GNU_xref_member(cls, fld)
593 #ifdef XREF_SHORT_MEMBER_NAMES
596 char buf[1024], bufa[1024];
598 if (!doing_xref) return;
599 xf = find_file(fld->decl.filename);
600 if (xf == NULL) return;
602 if (TREE_PRIVATE (fld)) prot = "PRIVATE";
603 else if (TREE_PROTECTED(fld)) prot = "PROTECTED";
604 else prot = "PUBLIC";
607 if (TREE_CODE (fld) == FUNCTION_DECL && DECL_CONST_MEMFUNC_P(fld))
609 else if (TREE_CODE (fld) == CONST_DECL)
613 if (TREE_CODE (fld) == FUNCTION_DECL && DECL_ABSTRACT_VIRTUAL_P(fld))
616 d = IDENTIFIER_POINTER(cls);
617 sprintf(buf, "%d%s", (int) strlen(d), d);
618 #ifdef XREF_SHORT_MEMBER_NAMES
621 strcpy(bufa, declname(fld));
623 #ifdef XREF_SHORT_MEMBER_NAMES
624 for (p = &bufa[1]; *p != 0; ++p)
626 if (p[0] == '_' && p[1] == '_' && p[2] >= '0' && p[2] <= '9') {
627 if (strncmp(&p[2], buf, i) == 0) *p = 0;
630 else if (p[0] == '_' && p[1] == '_' && p[2] == 'C' && p[3] >= '0' && p[3] <= '9') {
631 if (strncmp(&p[3], buf, i) == 0) *p = 0;
637 fprintf(xref_file, "MEM %s %d %s %s %s %d %d %d %d %d %d %d\n",
638 filename(xf), fld->decl.linenum, d, bufa, prot,
639 (TREE_CODE (fld) == FUNCTION_DECL ? 0 : 1),
640 (DECL_INLINE (fld) ? 1 : 0),
641 (DECL_LANG_SPECIFIC(fld) && DECL_FRIEND_P(fld) ? 1 : 0),
642 (DECL_VINDEX(fld) ? 1 : 0),
643 (TREE_STATIC(fld) ? 1 : 0),
647 /* Find file entry given name. */
655 for (xf = all_files; xf != NULL; xf = xf->next) {
656 if (STREQL(name, xf->name)) break;
662 /* Return filename for output purposes. */
673 if (last_file == xf) return "*";
680 /* Return function name for output purposes. */
686 static char fctbuf[1024];
689 if (fndecl == NULL && last_fndecl == NULL) return "*";
697 if (fndecl == last_fndecl) return "*";
699 last_fndecl = fndecl;
701 s = declname(fndecl);
702 s = fixname(s, fctbuf);
707 /* Return decl name for output purposes. */
713 if (DECL_NAME (dcl) == NULL) return "?";
715 if (DECL_ASSEMBLER_NAME (dcl))
716 return IDENTIFIER_POINTER (DECL_ASSEMBLER_NAME (dcl));
718 return IDENTIFIER_POINTER (DECL_NAME (dcl));
721 /* Simplify a type string by removing unneeded parenthesis. */
731 while (i > 0 && ISSPACE((unsigned char) typ[i-1])) typ[--i] = 0;
733 if (i > 7 && STREQL(&typ[i-5], "const"))
739 if (typ[i-1] != ')') return;
744 if (*s == ')') ++lvl;
758 if (*s != 0 && s[-1] == ')')
762 if (*s == '(') s[2] = 0;
763 else if (*s == ':') {
764 while (*s != '(') --s;
771 /* Fixup a function name (take care of embedded spaces). */
798 if (fg == 0) return nam;
803 /* Open file for xreffing. */
812 #ifdef XREF_FILE_NAME
813 XREF_FILE_NAME (xref_name, file);
815 s = rindex (file, '/');
817 sprintf (xref_name, ".%s.gxref", file);
821 strcpy (xref_name, file);
822 t = rindex (xref_name, '/');
826 strcat (t, ".gxref");
828 #endif /* no XREF_FILE_NAME */
830 xref_file = fopen(xref_name, "w");
832 if (xref_file == NULL)
834 error("Can't create cross-reference file `%s'", xref_name);