tools/cxref/preproc.c

   1 /***************************************
   2   $Header$
   3
   4   C Cross Referencing & Documentation tool. Version 1.5f.
   5
   6   Collects the pre-processing instruction stuff.
   7   ******************/ /******************
   8   Written by Andrew M. Bishop
   9
  10   This file Copyright 1995,96,97,99,2000,01,02,03,04 Andrew M. Bishop
  11   It may be distributed under the GNU Public License, version 2, or
  12   any higher version.  See section COPYING of the GNU Public license
  13   for conditions under which this file may be redistributed.
  14   ***************************************/
  15
  16 /*+ Control the output of debugging information for this file. +*/
  17 #define DEBUG 0
  18
  19 #include <stdlib.h>
  20 #include <stdio.h>
  21 #include <string.h>
  22 #include <unistd.h>
  23
  24 #include <limits.h>
  25 #include <sys/stat.h>
  26
  27 #include "memory.h"
  28 #include "datatype.h"
  29 #include "parse-yy.h"
  30 #include "cxref.h"
  31
  32 /*+ The file that is currently being processed. +*/
  33 extern File CurFile;
  34
  35 /*+ The name of the include directories specified on the command line. +*/
  36 extern char **option_incdirs;
  37
  38 /*+ The number of include directories on the command line. +*/
  39 extern int option_nincdirs;
  40
  41 /*+ When in a header file, this is set to 1, to allow most of the stuff to be skipped. +*/
  42 int in_header=0;
  43
  44 /*+ The current #include we are looking at. +*/
  45 static Include cur_inc=NULL;
  46
  47 /*+ The current #define we are looking at. +*/
  48 static Define cur_def=NULL;
  49
  50 /*+ The depth of includes. +*/
  51 static int inc_depth=0;
  52
  53 /*+ The type of include at this depth. +*/
  54 static char *inc_type=NULL;
  55
  56 /*+ The name of the include file at this depth. +*/
  57 static char **inc_name=NULL;
  58
  59 /*+ The working directory. +*/
  60 static char *cwd=NULL;
  61
  62
  63 static Include NewIncludeType(char *name);
  64 static Define NewDefineType(char *name);
  65
  66
  67 /*++++++++++++++++++++++++++++++++++++++
  68   Function that is called when an included file is seen in the current file.
  69
  70   char *name The name of the file from the source code.
  71   ++++++++++++++++++++++++++++++++++++++*/
  72
  73 void SeenInclude(char *name)
  74 {
  75 #if DEBUG
  76  printf("#Preproc.c# #include %s\n",name);
  77 #endif
  78
  79  if(!inc_type || inc_depth==0 || (inc_depth > 0 && inc_type[inc_depth-1]==LOCAL))
  80    {
  81     Include inc,*t=&CurFile->includes;
  82     int inc_scope=(*name=='"')?LOCAL:GLOBAL;
  83     int i;
  84
  85     name++;
  86     name[strlen(name)-1]=0;
  87
  88     if(inc_scope==LOCAL && option_nincdirs)
  89        for(i=0;i<option_nincdirs;i++)
  90          {
  91           char *newname=CanonicaliseName(ConcatStrings(3,option_incdirs[i],"/",name));
  92           struct stat buf;
  93
  94           if(!lstat(newname,&buf))
  95             {name=newname;break;}
  96          }
  97
  98     for(i=0;i<inc_depth;i++)
  99       {
 100        while(*t && (*t)->next)
 101           t=&(*t)->next;
 102        t=&(*t)->includes;
 103       }
 104
 105     inc=NewIncludeType(name);
 106
 107     inc->comment=MallocString(GetCurrentComment());
 108     inc->scope=inc_scope;
 109
 110     AddToLinkedList(*t,Include,inc);
 111
 112     cur_inc=inc;
 113    }
 114  else
 115     cur_inc=NULL;
 116 }
 117
 118
 119 /*++++++++++++++++++++++++++++++++++++++
 120   Function that is called when a comment is seen following a #include.
 121   ++++++++++++++++++++++++++++++++++++++*/
 122
 123 void SeenIncludeComment(void)
 124 {
 125  char* comment=GetCurrentComment();
 126
 127 #if DEBUG
 128  printf("#Preproc.c# #include trailing comment '%s' for %s\n",comment,cur_inc->name);
 129 #endif
 130
 131  if(!cur_inc->comment)
 132     cur_inc->comment=MallocString(comment);
 133 }
 134
 135
 136 /*++++++++++++++++++++++++++++++++++++++
 137   Function that is called when a change in current file is seen.
 138
 139   char *SeenFileChange Returns the filename that we are now in.
 140
 141   char *name The pathname of the included file as determined by gcc.
 142
 143   int flag The flags that GCC leaves in the file
 144   ++++++++++++++++++++++++++++++++++++++*/
 145
 146 char *SeenFileChange(char *name,int flag)
 147 {
 148  if(!cwd)
 149    {
 150     cwd=(char*)Malloc(PATH_MAX+1);
 151     if(!getcwd(cwd,PATH_MAX))
 152        cwd[0]=0;
 153    }
 154
 155  /* Special gcc-3.x fake names for built-in #defines. */
 156
 157 /* jmj: the fake names differ from locale to locale, but are always bracketed like this */
 158 /* old: if(!strcmp(name,"<built-in>") || !strcmp(name,"<command line>"))*/
 159  if (*name == '<' && name[strlen(name) - 1] == '>')
 160    {
 161     in_header=1;
 162     return(NULL);
 163    }
 164  else if(flag==-1)
 165    {
 166     in_header=0;
 167     return(CurFile->name);
 168    }
 169
 170  name=CanonicaliseName(name);
 171
 172  if(!strncmp(name,cwd,strlen(cwd)))
 173     name=name+strlen(cwd);
 174
 175  if(flag&4)
 176    {
 177     if(inc_depth>=2)
 178        name=inc_name[inc_depth-2];
 179     else
 180        name=CurFile->name;
 181    }
 182
 183 #if DEBUG
 184  printf("#Preproc.c# FileChange - %s %s (flag=%d)\n",flag&2?"Included ":"Return to",name,flag);
 185 #endif
 186
 187  /* Store the information. */
 188
 189  if(flag&2 && (!inc_type || inc_depth==0 || (inc_depth > 0 && inc_type[inc_depth-1]==LOCAL)))
 190    {
 191     if(!cur_inc)
 192       {
 193        if(flag&8)
 194           SeenInclude(ConcatStrings(3,"<",name,">"));
 195        else
 196           SeenInclude(ConcatStrings(3,"\"",name,"\""));
 197       }
 198     else if(!(flag&8))
 199       {
 200        Free(cur_inc->name);
 201        cur_inc->name=MallocString(name);
 202       }
 203    }
 204
 205  if(flag&2)
 206    {
 207     inc_depth++;
 208
 209     if(!inc_type)
 210       {
 211        inc_type=(char*)Malloc(16);
 212        inc_name=(char**)Malloc(16*sizeof(char*));
 213       }
 214     else
 215        if(!(inc_depth%16))
 216          {
 217           inc_type=(char*)Realloc(inc_type,(unsigned)(inc_depth+16));
 218           inc_name=(char**)Realloc(inc_name,(unsigned)(sizeof(char*)*(inc_depth+16)));
 219          }
 220
 221     if(inc_depth>1 && inc_type[inc_depth-2]==GLOBAL)
 222        inc_type[inc_depth-1]=GLOBAL;
 223     else if (inc_depth > 0)
 224        inc_type[inc_depth-1]=cur_inc?cur_inc->scope:(flag&8)?GLOBAL:LOCAL;
 225
 226     inc_name[inc_depth-1]=CopyString(name);
 227    }
 228  else
 229     inc_depth--;
 230
 231  if(inc_type && inc_depth>0)
 232     in_header=inc_type[inc_depth-1];
 233  else
 234     in_header=0;
 235
 236  SetCurrentComment(NULL);
 237
 238  cur_inc=NULL;
 239
 240  return(name);
 241 }
 242
 243
 244 /*++++++++++++++++++++++++++++++++++++++
 245   Function that is called when a #define is seen in the current file.
 246
 247   char* name The name of the #defined symbol.
 248   ++++++++++++++++++++++++++++++++++++++*/
 249
 250 void SeenDefine(char* name)
 251 {
 252  Define def;
 253
 254 #if DEBUG
 255  printf("#Preproc.c# Defined name '%s'\n",name);
 256 #endif
 257
 258  def=NewDefineType(name);
 259
 260  def->comment=MallocString(GetCurrentComment());
 261
 262  def->lineno=parse_line;
 263
 264  AddToLinkedList(CurFile->defines,Define,def);
 265
 266  cur_def=def;
 267 }
 268
 269
 270 /*++++++++++++++++++++++++++++++++++++++
 271   Function that is called when a comment is seen in a #define definition.
 272   ++++++++++++++++++++++++++++++++++++++*/
 273
 274 void SeenDefineComment(void)
 275 {
 276  char* comment=GetCurrentComment();
 277
 278 #if DEBUG
 279  printf("#Preproc.c# #define inline comment '%s' in %s\n",comment,cur_def->name);
 280 #endif
 281
 282  if(!cur_def->comment)
 283     cur_def->comment=MallocString(comment);
 284 }
 285
 286
 287 /*++++++++++++++++++++++++++++++++++++++
 288   Function that is called when a #define value is seen in the current file.
 289
 290   char* value The value of the #defined symbol.
 291   ++++++++++++++++++++++++++++++++++++++*/
 292
 293 void SeenDefineValue(char* value)
 294 {
 295 #if DEBUG
 296  printf("#Preproc.c# #define value '%s' for %s\n",value,cur_def->name);
 297 #endif
 298
 299  cur_def->value=MallocString(value);
 300 }
 301
 302
 303 /*++++++++++++++++++++++++++++++++++++++
 304   Function that is called when a #define function argument is seen in the current definition.
 305
 306   char* name The argument.
 307   ++++++++++++++++++++++++++++++++++++++*/
 308
 309 void SeenDefineFunctionArg(char* name)
 310 {
 311 #if DEBUG
 312  printf("#Preproc.c# #define Function arg '%s' in %s()\n",name,cur_def->name);
 313 #endif
 314
 315  AddToStringList2(cur_def->args,name,SplitComment(&cur_def->comment,name),0,0);
 316 }
 317
 318
 319 /*++++++++++++++++++++++++++++++++++++++
 320   Function that is called when a comment is seen in a #define function definition.
 321   ++++++++++++++++++++++++++++++++++++++*/
 322
 323 void SeenDefineFuncArgComment(void)
 324 {
 325  char* comment=GetCurrentComment();
 326
 327 #if DEBUG
 328  printf("#Preproc.c# #define Function arg comment '%s' in %s()\n",comment,cur_def->name);
 329 #endif
 330
 331  if(!cur_def->args->s2[cur_def->args->n-1])
 332     cur_def->args->s2[cur_def->args->n-1]=MallocString(comment);
 333 }
 334
 335
 336 /*++++++++++++++++++++++++++++++++++++++
 337   Tidy up all of the local variables in case of a problem and abnormal parser termination.
 338   ++++++++++++++++++++++++++++++++++++++*/
 339
 340 void ResetPreProcAnalyser(void)
 341 {
 342  in_header=0;
 343
 344  cur_inc=NULL;
 345  cur_def=NULL;
 346
 347  inc_depth=0;
 348
 349  if(inc_type) Free(inc_type);
 350  inc_type=NULL;
 351  if(inc_name) Free(inc_name);
 352  inc_name=NULL;
 353
 354  if(cwd) Free(cwd);
 355  cwd=NULL;
 356 }
 357
 358
 359 /*++++++++++++++++++++++++++++++++++++++
 360   Create a new Include datatype.
 361
 362   Include NewIncludeType Return the new Include type.
 363
 364   char *name The name of the new include.
 365   ++++++++++++++++++++++++++++++++++++++*/
 366
 367 static Include NewIncludeType(char *name)
 368 {
 369  Include inc=(Include)Calloc(1,sizeof(struct _Include));
 370
 371  inc->name=MallocString(name);
 372
 373  return(inc);
 374 }
 375
 376
 377 /*++++++++++++++++++++++++++++++++++++++
 378   Delete the specified Include type.
 379
 380   Include inc The Include type to be deleted.
 381   ++++++++++++++++++++++++++++++++++++++*/
 382
 383 void DeleteIncludeType(Include inc)
 384 {
 385  if(inc->comment) Free(inc->comment);
 386  if(inc->name)    Free(inc->name);
 387  if(inc->includes)
 388    {
 389     Include p=inc->includes;
 390     do{
 391        Include n=p->next;
 392        DeleteIncludeType(p);
 393        p=n;
 394       }
 395     while(p);
 396    }
 397  Free(inc);
 398 }
 399
 400
 401 /*++++++++++++++++++++++++++++++++++++++
 402   Create a new Define datatype.
 403
 404   Define NewDefineType Return the new Define type.
 405
 406   char *name The name of the new define.
 407   ++++++++++++++++++++++++++++++++++++++*/
 408
 409 static Define NewDefineType(char *name)
 410 {
 411  Define def=(Define)Calloc(1,sizeof(struct _Define)); /* clear unused pointers */
 412
 413  def->name=MallocString(name);
 414  def->args=NewStringList2();
 415
 416  return(def);
 417 }
 418
 419
 420 /*++++++++++++++++++++++++++++++++++++++
 421   Delete the specified Define type.
 422
 423   Define def The Define type to be deleted.
 424   ++++++++++++++++++++++++++++++++++++++*/
 425
 426 void DeleteDefineType(Define def)
 427 {
 428  if(def->comment) Free(def->comment);
 429  if(def->name)    Free(def->name);
 430  if(def->value)   Free(def->value);
 431  if(def->args)    DeleteStringList2(def->args);
 432  Free(def);
 433 }