1 /* Code for handling XREF output from GNU C++.
2 Copyright (C) 1992, 1993, 1994, 1995, 1997 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. */
29 extern char *getpwd PROTO((void));
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 *) calloc(1,sizeof(typ)))
63 /* Return a malloc'd copy of STR. */
65 ((char *) ((str) == NULL ? NULL \
66 : (char *) strcpy ((char *) malloc (strlen ((str)) + 1), (str))))
67 #define SFREE(str) (str != NULL && (free(str),0))
69 #define STREQL(s1,s2) (strcmp((s1),(s2)) == 0)
70 #define STRNEQ(s1,s2) (strcmp((s1),(s2)) != 0)
71 #define STRLSS(s1,s2) (strcmp((s1),(s2)) < 0)
72 #define STRLEQ(s1,s2) (strcmp((s1),(s2)) <= 0)
73 #define STRGTR(s1,s2) (strcmp((s1),(s2)) > 0)
74 #define STRGEQ(s1,s2) (strcmp((s1),(s2)) >= 0)
76 /************************************************************************/
78 /* Type definitions */
80 /************************************************************************/
83 typedef struct _XREF_FILE * XREF_FILE;
84 typedef struct _XREF_SCOPE * XREF_SCOPE;
86 typedef struct _XREF_FILE
93 typedef struct _XREF_SCOPE
102 /************************************************************************/
106 /************************************************************************/
108 static char doing_xref = 0;
109 static FILE * xref_file = NULL;
110 static char xref_name[1024];
111 static XREF_FILE all_files = NULL;
112 static char * wd_name = NULL;
113 static XREF_SCOPE cur_scope = NULL;
114 static int scope_ctr = 0;
115 static XREF_FILE last_file = NULL;
116 static tree last_fndecl = NULL;
118 /************************************************************************/
120 /* Forward definitions */
122 /************************************************************************/
123 static void gen_assign PROTO((XREF_FILE, tree));
124 static XREF_FILE find_file PROTO((char *));
125 static char * filename PROTO((XREF_FILE));
126 static char * fctname PROTO((tree));
127 static char * declname PROTO((tree));
128 static void simplify_type PROTO((char *));
129 static char * fixname PROTO((char *, char *));
130 static void open_xref_file PROTO((char *));
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 *) malloc (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 %d %s\n",
289 filename (xf), xs->start, lineno,xs->lid, inid, stype);
291 if (lxs == NULL) cur_scope = xs->outer;
292 else lxs->outer = xs->outer;
297 /* Output a reference to NAME in FNDECL. */
300 GNU_xref_ref (fndecl,name)
306 if (!doing_xref) return;
307 xf = find_file (input_filename);
308 if (xf == NULL) return;
310 fprintf (xref_file, "REF %s %d %s %s\n",
311 filename (xf), lineno, fctname (fndecl), name);
314 /* Output a reference to DECL in FNDECL. */
317 GNU_xref_decl (fndecl,decl)
327 if (!doing_xref) return;
328 xf = find_file (input_filename);
329 if (xf == NULL) return;
333 if (TREE_CODE (decl) == TYPE_DECL) cls = "TYPEDEF";
334 else if (TREE_CODE (decl) == FIELD_DECL) cls = "FIELD";
335 else if (TREE_CODE (decl) == VAR_DECL)
337 if (fndecl == NULL && TREE_STATIC(decl)
338 && TREE_READONLY(decl) && DECL_INITIAL(decl) != 0
339 && !TREE_PUBLIC(decl) && !DECL_EXTERNAL(decl)
340 && DECL_MODE(decl) != BLKmode) cls = "CONST";
341 else if (DECL_EXTERNAL(decl)) cls = "EXTERN";
342 else if (TREE_PUBLIC(decl)) cls = "EXTDEF";
343 else if (TREE_STATIC(decl)) cls = "STATIC";
344 else if (DECL_REGISTER(decl)) cls = "REGISTER";
347 else if (TREE_CODE (decl) == PARM_DECL) cls = "PARAM";
348 else if (TREE_CODE (decl) == FIELD_DECL) cls = "FIELD";
349 else if (TREE_CODE (decl) == CONST_DECL) cls = "CONST";
350 else if (TREE_CODE (decl) == FUNCTION_DECL)
352 if (DECL_EXTERNAL (decl)) cls = "EXTERN";
353 else if (TREE_PUBLIC (decl)) cls = "EFUNCTION";
354 else cls = "SFUNCTION";
356 else if (TREE_CODE (decl) == LABEL_DECL) cls = "LABEL";
357 else if (TREE_CODE (decl) == UNION_TYPE)
360 decl = TYPE_NAME (decl);
363 else if (TREE_CODE (decl) == RECORD_TYPE)
365 if (CLASSTYPE_DECLARED_CLASS (decl)) cls = "CLASSID";
366 else if (IS_SIGNATURE (decl)) cls = "SIGNATUREID";
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")
417 || STREQL (cls, "SIGNATUREID"))
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);
541 /* Output cross-reference info about a class hierarchy.
542 CLS is the class type of interest. BASE is a baseclass
543 for CLS. PUB and VIRT give the access info about
544 the class derivation. FRND is nonzero iff BASE is a friend
547 ??? Needs to handle nested classes. */
550 GNU_xref_hier(cls, base, pub, virt, frnd)
559 if (!doing_xref) return;
560 xf = find_file(input_filename);
561 if (xf == NULL) return;
563 fprintf(xref_file, "HIE %s %d %s %s %d %d %d\n",
564 filename(xf), lineno, cls, base, pub, virt, frnd);
567 /* Output cross-reference info about class members. CLS
568 is the containing type; FLD is the class member. */
571 GNU_xref_member(cls, fld)
579 #ifdef XREF_SHORT_MEMBER_NAMES
582 char buf[1024], bufa[1024];
584 if (!doing_xref) return;
585 xf = find_file(fld->decl.filename);
586 if (xf == NULL) return;
588 if (TREE_PRIVATE (fld)) prot = "PRIVATE";
589 else if (TREE_PROTECTED(fld)) prot = "PROTECTED";
590 else prot = "PUBLIC";
593 if (TREE_CODE (fld) == FUNCTION_DECL && DECL_CONST_MEMFUNC_P(fld))
595 else if (TREE_CODE (fld) == CONST_DECL)
599 if (TREE_CODE (fld) == FUNCTION_DECL && DECL_ABSTRACT_VIRTUAL_P(fld))
602 d = IDENTIFIER_POINTER(cls);
603 sprintf(buf, "%d%s", strlen(d), d);
604 #ifdef XREF_SHORT_MEMBER_NAMES
607 strcpy(bufa, declname(fld));
609 #ifdef XREF_SHORT_MEMBER_NAMES
610 for (p = &bufa[1]; *p != 0; ++p)
612 if (p[0] == '_' && p[1] == '_' && p[2] >= '0' && p[2] <= '9') {
613 if (strncmp(&p[2], buf, i) == 0) *p = 0;
616 else if (p[0] == '_' && p[1] == '_' && p[2] == 'C' && p[3] >= '0' && p[3] <= '9') {
617 if (strncmp(&p[3], buf, i) == 0) *p = 0;
623 fprintf(xref_file, "MEM %s %d %s %s %s %d %d %d %d %d %d %d\n",
624 filename(xf), fld->decl.linenum, d, bufa, prot,
625 (TREE_CODE (fld) == FUNCTION_DECL ? 0 : 1),
626 (DECL_INLINE (fld) ? 1 : 0),
627 (DECL_LANG_SPECIFIC(fld) && DECL_FRIEND_P(fld) ? 1 : 0),
628 (DECL_VINDEX(fld) ? 1 : 0),
629 (TREE_STATIC(fld) ? 1 : 0),
633 /* Find file entry given name. */
641 for (xf = all_files; xf != NULL; xf = xf->next) {
642 if (STREQL(name, xf->name)) break;
648 /* Return filename for output purposes. */
659 if (last_file == xf) return "*";
666 /* Return function name for output purposes. */
672 static char fctbuf[1024];
675 if (fndecl == NULL && last_fndecl == NULL) return "*";
683 if (fndecl == last_fndecl) return "*";
685 last_fndecl = fndecl;
687 s = declname(fndecl);
688 s = fixname(s, fctbuf);
693 /* Return decl name for output purposes. */
699 if (DECL_NAME (dcl) == NULL) return "?";
701 if (DECL_ASSEMBLER_NAME (dcl))
702 return IDENTIFIER_POINTER (DECL_ASSEMBLER_NAME (dcl));
704 return IDENTIFIER_POINTER (DECL_NAME (dcl));
707 /* Simplify a type string by removing unneeded parenthesis. */
717 while (i > 0 && isspace(typ[i-1])) typ[--i] = 0;
719 if (i > 7 && STREQL(&typ[i-5], "const"))
725 if (typ[i-1] != ')') return;
730 if (*s == ')') ++lvl;
744 if (*s != 0 && s[-1] == ')')
748 if (*s == '(') s[2] = 0;
749 else if (*s == ':') {
750 while (*s != '(') --s;
757 /* Fixup a function name (take care of embedded spaces). */
783 if (fg == 0) return nam;
788 /* Open file for xreffing. */
796 #ifdef XREF_FILE_NAME
797 XREF_FILE_NAME (xref_name, file);
799 s = rindex (file, '/');
801 sprintf (xref_name, ".%s.gxref", file);
805 strcpy (xref_name, file);
806 t = rindex (xref_name, '/');
810 strcat (t, ".gxref");
812 #endif /* no XREF_FILE_NAME */
814 xref_file = fopen(xref_name, "w");
816 if (xref_file == NULL)
818 error("Can't create cross-reference file `%s'", xref_name);