Converts a C++ source file into tokens with associated types.

Author:

Joe Linoff

Version:

$Id: ccdoclexer.h,v 1.4 1999/06/12 18:10:33 jdl Exp $

Source:

../../ccdoc/src/ccdoclexer.h:28

public CCcDocLexer ( ) ;

Default constructor.

public enum LEXICON_TYPE { COMMENT ,
                           DOUBLE_QUOTE ,
                           FLOAT ,
                           ID ,
                           INTEGER ,
                           KEYWORD ,
                           OPERATOR ,
                           PRAGMA ,
                           PUNCTUATOR ,
                           RESERVED ,
                           SINGLE_QUOTE ,
                           UNKNOWN ,
                           END_OF_FILE } ;

TOKEN TYPEs.

public LEXICON_TYPE ScanNextToken ( CJdlBufferedFileReader & file ,
                                    const char * & token ) ;

Scan the next token.

The example below shows how to dump all of the lexicons in a file.

 CJdlBufferedFileReader file;
 file.Open("main.cpp");
 CCcDocLexer scanner;
 const char* token;
 CCcDocLexer::LEXICON_TYPE type = CCcDocLexer::END_OF_FILE;
 while( (type = scanner.ScanNextToken(file,token)) != CCcDocLexer::END_OF_FILE ) {
   printf("L:%s:%d:%s\n",scanner.GetName(type),::strlen(token),token);
 }

public static bool IsKeyword ( const char * token ) ;

Is this token a keyword?

Return:

True if this token is keyword or false otherwise.

public static bool IsReserved ( const char * token ) ;

Is this token a reserved word?

Return:

True if this token is keyword or false otherwise.

public static bool IsPunctuator ( const char * token ) ;

Is this token a punctuator?

Return:

True if this token is keyword or false otherwise.

public static const char * GetName ( LEXICON_TYPE type ) ;

Get the name of a token type.

Return:

A string that describes the token type.

public bool IsDebug ( ) const ;

Is the CCDOC_LEXER_DEBUG environment variable set?

Return:

True if it is set or false otherwise.

public static void LoadStringDataFromRcFile ( CJdlStringList & list ,
                                              const char * rcfile ,
                                              const char * section ) ;

Resource file load routine.