tools/cxref/query/output.c

   1 /***************************************
   2   $Header$
   3
   4   C Cross Referencing & Documentation tool. Version 1.4.
   5   ******************/ /******************
   6   Written by Andrew M. Bishop
   7
   8   This file Copyright 1995,96,97 Andrew M. Bishop
   9   It may be distributed under the GNU Public License, version 2, or
  10   any higher version.  See section COPYING of the GNU Public license
  11   for conditions under which this file may be redistributed.
  12   ***************************************/
  13
  14 #include <stdio.h>
  15 #include <stdlib.h>
  16 #include <string.h>
  17
  18 #include "../memory.h"
  19 #include "../datatype.h"
  20 #include "../cxref.h"
  21 #include "query.h"
  22
  23
  24 /*+ The command line switch that sets the amount of cross referencing to do. +*/
  25 extern int option_xref;
  26
  27 extern File *files;             /*+ The files that are queried. +*/
  28 extern int n_files;             /*+ The number of files referenced. +*/
  29
  30 extern Function *functions;     /*+ The functions that are queried. +*/
  31 extern int n_functions;         /*+ The number of functions referenced. +*/
  32
  33 extern Variable *variables;     /*+ The variables that are queried. +*/
  34 extern int n_variables;         /*+ The number of variables referenced. +*/
  35
  36 extern Typedef *typedefs;       /*+ The type definitions that are queried. +*/
  37 extern int n_typedefs;          /*+ The number of typedefs referenced. +*/
  38
  39 /* Local fuctions */
  40
  41 static void OutputFile(File file);
  42 static void OutputInclude(Include incl,int depth);
  43 static void OutputFunction(Function func);
  44 static void OutputVariable(Variable var);
  45 static void OutputTypedef(Typedef type);
  46
  47
  48 /*++++++++++++++++++++++++++++++++++++++
  49   Ouput the cross references for the named thing.
  50
  51   char* name The name of the object to ouput the cross references for.
  52   ++++++++++++++++++++++++++++++++++++++*/
  53
  54 void OutputCrossRef(char* name)
  55 {
  56  int i,any=0;
  57
  58  for(i=0;i<n_files;i++)
  59     if(!strcmp(name,files[i]->name))
  60        {OutputFile(files[i]);any++;}
  61
  62  for(i=0;i<n_typedefs;i++)
  63     if(!strcmp(name,typedefs[i]->name))
  64       {OutputTypedef(typedefs[i]);any++;}
  65
  66  for(i=0;i<n_variables;i++)
  67     if(!strcmp(name,variables[i]->name))
  68       {OutputVariable(variables[i]);any++;}
  69
  70  for(i=0;i<n_functions;i++)
  71     if(!strcmp(name,functions[i]->name))
  72       {OutputFunction(functions[i]);any++;}
  73
  74  if(!any)
  75     printf("cxref-query: No match for '%s'.\n",name);
  76 }
  77
  78 /*++++++++++++++++++++++++++++++++++++++
  79   Print out the information for a file.
  80
  81   File file The file to output the information for.
  82   ++++++++++++++++++++++++++++++++++++++*/
  83
  84 static void OutputFile(File file)
  85 {
  86  int i;
  87  Include inc;
  88  Function func;
  89  Variable var;
  90  Typedef type;
  91
  92  printf("File: %s\n\n",file->name);
  93
  94  for(inc=file->includes,i=0;inc;inc=inc->next,i++)
  95    {
  96     printf("    %s %c%s%c\n",i?"          ":"Includes: ",inc->scope==GLOBAL?'<':'"',inc->name,inc->scope==GLOBAL?'>':'"');
  97     OutputInclude(inc,1);
  98    }
  99  if(file->includes)
 100     printf("\n");
 101
 102  for(func=file->functions,i=0;func;func=func->next,i++)
 103     printf("    %s %s\n",i?"          ":"Functions:",func->name);
 104  if(file->functions)
 105     printf("\n");
 106
 107  for(var=file->variables,i=0;var;var=var->next,i++)
 108     printf("    %s %s\n",i?"          ":"Variables:",var->name);
 109  if(file->variables)
 110     printf("\n");
 111
 112  for(type=file->typedefs,i=0;type;type=type->next,i++)
 113     printf("    %s %s\n",i?"          ":"Types:    ",type->name);
 114  if(file->typedefs)
 115     printf("\n");
 116
 117  if(option_xref&XREF_FILE)
 118    {
 119     for(i=0;i<file->inc_in->n;i++)
 120        printf("   %s %s\n",i?"            ":"Included in:",file->inc_in->s[i]);
 121     if(file->inc_in->n)
 122        printf("\n");
 123    }
 124
 125  if(option_xref&XREF_FUNC)
 126    {
 127     for(i=0;i<file->f_refs->n;i++)
 128        printf("   %s %s : %s\n",i?"            ":"Refs func:  ",file->f_refs->s1[i],file->f_refs->s2[i]);
 129     if(file->f_refs->n)
 130        printf("\n");
 131    }
 132
 133  if(option_xref&XREF_VAR)
 134    {
 135     for(i=0;i<file->v_refs->n;i++)
 136        printf("   %s %s : %s\n",i?"            ":"Refs var:   ",file->v_refs->s1[i],file->v_refs->s2[i]);
 137     if(file->v_refs->n)
 138        printf("\n");
 139    }
 140 }
 141
 142
 143 /*++++++++++++++++++++++++++++++++++++++
 144   Print out the information for an include file.
 145
 146   Include incl The include file to output the information for.
 147
 148   int depth The depth of the includes.
 149   ++++++++++++++++++++++++++++++++++++++*/
 150
 151 static void OutputInclude(Include incl,int depth)
 152 {
 153  int c,i;
 154  Include inc;
 155
 156  for(inc=incl->includes,c=0;inc;inc=inc->next,c++)
 157    {
 158     for(i=0;i<depth;i++) fputs("   ",stdout);
 159     printf("               %c%s%c\n",inc->scope==GLOBAL?'<':'"',inc->name,inc->scope==GLOBAL?'>':'"');
 160     OutputInclude(inc,depth+1);
 161    }
 162 }
 163
 164
 165 /*++++++++++++++++++++++++++++++++++++++
 166   Print out the information for a typedef.
 167
 168   Typedef type The typedef to output the information for.
 169   ++++++++++++++++++++++++++++++++++++++*/
 170
 171 static void OutputTypedef(Typedef type)
 172 {
 173  printf("In file: %s\n",type->comment);
 174
 175  if(type->type)
 176     printf("Typedef: %s = %s\n",type->name,type->type);
 177  else
 178     printf("Type:    %s\n",type->name);
 179
 180  printf("\n");
 181 }
 182
 183
 184 /*++++++++++++++++++++++++++++++++++++++
 185   Print out the information for a variable.
 186
 187   Variable var The variable to output the information for.
 188   ++++++++++++++++++++++++++++++++++++++*/
 189
 190 static void OutputVariable(Variable var)
 191 {
 192  int i,done=0;
 193
 194  printf("In file: %s\n",var->comment);
 195
 196  printf("Variable: %s [",var->name);
 197  if(var->scope&LOCAL)    done=printf("Local");
 198  if(var->scope&GLOBAL)   done=printf("%sGlobal definition",done?" and ":"");
 199  if(var->scope&EXTERNAL) done=printf("%sExternal",done?" and ":"");
 200  if(var->scope&EXTERN_H) done=printf("%sExternal from header file",done?" and ":"");
 201  if(var->scope&EXTERN_F) done=printf("%sExternal within function",done?" and ":"");
 202  printf("]\n");
 203
 204  if(option_xref&XREF_VAR)
 205    {
 206     if(var->scope&(GLOBAL|LOCAL))
 207        for(i=0;i<var->visible->n;i++)
 208           printf("   %s %s : %s\n",i?"            ":"Visible in: ",var->visible->s1[i],var->visible->s2[i]);
 209
 210     for(i=0;i<var->used->n;i++)
 211        if(var->used->s1[i][0]=='$')
 212           printf("   %s %s\n",i?"            ":"Used in:    ",var->used->s2[i]);
 213        else
 214           printf("   %s %s : %s\n",i?"            ":"Used in:    ",var->used->s1[i],var->used->s2[i]);
 215    }
 216
 217  printf("\n");
 218 }
 219
 220
 221 /*++++++++++++++++++++++++++++++++++++++
 222   Print out the information for a function.
 223
 224   Function func The function to output the information for.
 225   ++++++++++++++++++++++++++++++++++++++*/
 226
 227 static void OutputFunction(Function func)
 228 {
 229  int i;
 230
 231  printf("In file: %s\n",func->comment);
 232
 233  printf("Function: %s ",func->name);
 234
 235  switch(func->scope)
 236    {
 237    case LOCAL:           printf("[Local]\n"); break;
 238    case GLOBAL:          printf("[Global]\n"); break;
 239    case LOCAL+INLINED:   printf("[Local inline]\n"); break;
 240    case INLINED:         printf("[inline]\n"); break;
 241    default:              ;
 242    }
 243
 244  if(option_xref&XREF_FUNC)
 245    {
 246     for(i=0;i<func->calls->n;i++)
 247        printf("   %s %s : %s\n",i?"            ":"Calls:      ",func->calls->s1[i],func->calls->s2[i]?func->calls->s2[i]:"?unknown?");
 248
 249     for(i=0;i<func->called->n;i++)
 250        printf("   %s %s : %s\n",i?"            ":"Called from:",func->called->s1[i],func->called->s2[i]);
 251
 252     for(i=0;i<func->used->n;i++)
 253       {
 254        if(func->used->s1[i][0]=='$')
 255           printf("   %s %s\n",i?"            ":"Used in:    ",func->used->s2[i]);
 256        else
 257           printf("   %s %s : %s\n",i?"            ":"Used in:    ",func->used->s1[i],func->used->s2[i]);
 258       }
 259
 260     for(i=0;i<func->f_refs->n;i++)
 261        printf("   %s %s : %s\n",i?"            ":"Refs func:  ",func->f_refs->s1[i],func->f_refs->s2[i]?func->f_refs->s2[i]:"?unknown?");
 262    }
 263
 264  if(option_xref&XREF_VAR)
 265     for(i=0;i<func->v_refs->n;i++)
 266        printf("   %s %s : %s\n",i?"            ":"Refs var:   ",func->v_refs->s1[i],func->v_refs->s2[i]?func->v_refs->s2[i]:"?unknown?");
 267
 268  printf("\n");
 269 }