File comment.c

RCS Header: /home/amb/CVS/cxref/src/comment.c,v 1.22 2003-01-17 19:07:56 amb Exp

C Cross Referencing & Documentation tool. Version 1.5e.
Collects the comments from the parser.

Included Files

Preprocessor definitions

Turn on the debugging in this file.

#define DEBUG 0

External Variables

option_verbatim_comments

The option to insert the comments verbatim into the output.

extern int option_verbatim_comments

Defined in: cxref.c

CurFile

The file that is currently being processed.

extern File CurFile

Defined in: cxref.c

parse_file

The name of the current file.

extern char* parse_file

Defined in: parse-lex.c

Local Variables

current_comment

The current (latest) comment.

static char* current_comment

Used in: DeleteComment()  
  GetCurrentComment()  
  SeenComment()  
  SetCurrentComment()  

malloc_comment

The malloced string for the current comment.

static char* malloc_comment

Used in: DeleteComment()  
  SeenComment()  
  SetCurrentComment()  

comment_ended

The status of the current comment.

static int comment_ended

Used in: DeleteComment()  
  SeenComment()  

Global Function DeleteComment()

Delete the malloced string for the comment

void DeleteComment ( void )

Prototyped in: cxref.h
Calls: SafeFree() memory.c
Called by: main() cxref.c
References Variables: comment_ended comment.c
  current_comment comment.c
  malloc_comment comment.c

Global Function GetCurrentComment()

Provide the current (latest) comment.

char* GetCurrentComment ( void )

char* GetCurrentComment
Returns the current (latest) comment.

Prototyped in: cxref.h
Called by: SeenDefine() preproc.c
  SeenDefineComment() preproc.c
  SeenDefineFuncArgComment() preproc.c
  SeenFunctionArg() func.c
  SeenFunctionDeclaration() func.c
  SeenFunctionDefinition() func.c
  SeenInclude() preproc.c
  SeenIncludeComment() preproc.c
  SeenStructUnionComp() type.c
  SeenStructUnionStart() type.c
  SeenTypedef() type.c
  SeenVariableDefinition() var.c
  yylex() parse-lex.c
  yyparse() parse-yacc.c
References Variables: current_comment comment.c

Global Function SeenComment()

Function that is called when a comment or part of one is seen. The comment is built up until an end of comment is signaled.

void SeenComment ( char* c, int flag )

char* c
The comment text.
int flag
A flag to indicate the type of comment that it is. if flag==0 then it is a comment of some sort. If flag==1 then it is the end of a file (/ * * comment * * /) comment if flag==2 then it is the end of the other special comment (/ * + comment + * /). if flag==3 then it is the end of a normal comment (/ * comment * /).

Prototyped in: cxref.h
Calls: SafeMalloc() memory.c
  SafeRealloc() memory.c
  SeenFileComment() file.c
  SeenFuncIntComment() func.c
  TidyCommentString() comment.c
  strcat(), strcmp(), strcpy(), strlen()
Called by: yylex() parse-lex.c
References Variables: CurFile cxref.c
  comment_ended comment.c
  current_comment comment.c
  malloc_comment comment.c
  option_verbatim_comments cxref.c
  parse_file parse-lex.c

Global Function SetCurrentComment()

Set the current (latest) comment.

void SetCurrentComment ( char* comment )

char* comment
The comment.

Prototyped in: cxref.h
Calls: SafeRealloc() memory.c
  strcpy(), strlen()
Called by: SeenFileChange() preproc.c
  yyparse() parse-yacc.c
References Variables: current_comment comment.c
  malloc_comment comment.c

Global Function SplitComment()

A function to split out the arguments etc from a comment, for example the function argument comments are separated using this.

char* SplitComment ( char** original, char* name )

char* SplitComment
Returns the required comment.
char** original
A pointer to the original comment, this is altered in the process.
char* name
The name that is to be cut out from the comment.

A most clever function that ignores spaces so that 'char* b' and 'char *b' match.

Prototyped in: cxref.h
Calls: ConcatStrings() memory.c
  CopyString() memory.c
  SafeFree() memory.c
  SafeMallocString() memory.c
  TidyCommentString() comment.c
  strlen(), strstr()
Called by: SeenDefineFunctionArg() preproc.c
  SeenFunctionArg() func.c
  SeenFunctionDefinition() func.c

Local Function TidyCommentString()

Tidy up the current comment string by snipping off trailing and leading junk.

static void TidyCommentString ( char** string, int spaces )

char** string
The string that is to be tidied.
int spaces
Indicates that leading and trailing whitespace are to be removed as well.

Prototyped in: comment.c
Calls: strlen()
Called by: SeenComment() comment.c
  SplitComment() comment.c