C-Programm Anzahl Kommentarzeilen (// und /* */)

Schreiben Sie eine state machine, die behandeln soll, die meisten Fällen.

Beim Scannen der Datei, werden Sie in einem der folgenden Staaten:

1. TEXT - regelmäßige (nicht kommentiert) text; dies ist der Zustand, beginnen Sie im. Alle neue-Zeile gesehen in diesem Zustand dazu, dass die gesamte-Zeilen-Zähler erhöht werden.
2. SAW_SLASH - haben Sie gesehen, eine einzige /, die möglicherweise den start eines single - oder multi-line-Kommentar. Wenn das nächste Zeichen ein / sind, gehen Sie in die SINGLE_COMMENT Zustand. Wenn das nächste Zeichen ein * sind, gehen Sie in die MULTI_COMMENT Zustand. Für jeden anderen Charakter, gehen Sie zurück in den TEXT Stand.
3. SINGLE_COMMENT - haben Sie gesehen, die // token; Sie bleiben in diesem Zustand, bis ein newline-Zeichen; sobald Sie sehen, das neue-Zeile-Zeichen, das Ihnen erhöhen Sie die Anzahl von single-line-Kommentare sowie insgesamt Linien, und gehen Sie zurück zu dem TEXT Stand.
4. MULTI_COMMENT - haben Sie gesehen, die /* token; Sie bleiben in diesem Zustand, bis Sie das nächste */ token. Alle neue-Zeile-sehen Sie in diesem Zustand verursachen die multi-comment-Zeile-Zähler werden erhöht, zusammen mit der gesamten Zeilen.
5. SAW_STAR - Während in der MULTI_COMMENT Zustand, haben Sie gesehen, eine einzige *. Wenn das nächste Zeichen / sind, gehen Sie zurück zu dem TEXT Stand. Wenn das nächste Zeichen *, wohnen Sie in der SAW_STAR Zustand. Ansonsten gehen Sie zurück zu der MULTI_COMMENT Zustand.

Gibt es Grenzfälle, dass ich mich nicht um (wie die Begegnung mit einer EOF-während in einem Kommentar Stand), aber das folgende sollte ein vernünftiger Beispiel, wie Sie tun Sachen wie diese.

Beachten Sie, dass verschachtelte Kommentare nicht gezählt werden; d.h., wenn ein //getrennte Kommentar erscheint in einer /* */getrennten Kommentar, nur der multi-Kommentar-counter aktualisiert werden.

Werden Sie wahrscheinlich wollen, um den Faktor der zähl-Logik in eine eigene Funktion; nur versuchen, um das Beispiel so einfach, wie ich kann.

#include <stdio.h>
#include <stdlib.h>

/**
 * Count up the number of total lines, single-comment lines,
 * and multi-comment lines in a file.
 */
int main(int argc, char **argv)
{
  FILE *fp;
  int c;
  unsigned int chars  = 0;
  unsigned int total  = 0;
  unsigned int multi  = 0;
  unsigned int single = 0;

  enum states { TEXT, 
                SAW_SLASH, 
                SAW_STAR, 
                SINGLE_COMMENT, 
                MULTI_COMMENT } state = TEXT;

  if ( argc < 2 )
  {
    fprintf(stderr, "USAGE: %s <filename>\n", argv[0]);
    exit(0);
  }

  fp = fopen( argv[1], "r" );
  if ( !fp )
  {
    fprintf(stderr, "Cannot open file %s\n", argv[1] );
    exit(0);
  }

  while ( (c = fgetc( fp )) != EOF )
  {
    chars++;
    switch( state )
    {
      case TEXT :
        switch( c )
        {
          case '/'  : state = SAW_SLASH; break;
          case '\n' : total++; //fall-through
          default   : break;
        }
        break;

      case SAW_SLASH :
        switch( c )
        {
          case '/'  : state = SINGLE_COMMENT; break;
          case '*'  : state = MULTI_COMMENT; break;
          case '\n' : total++; //fall through
          default   : state = TEXT; break;
        }
        break;

      case SAW_STAR :
        switch( c )
        {
          case '/'  : state = TEXT; multi++; break;
          case '*'  : break;
          case '\n' : total++; multi++; //fall through
          default   : state = MULTI_COMMENT; break;
        }
        break;

      case SINGLE_COMMENT :
        switch( c )
        {
          case '\n' : state = TEXT; total++; single++; //fall through
          default   : break;
        }
        break;

      case MULTI_COMMENT :
        switch( c )
        {
          case '*'  : state = SAW_STAR; break;
          case '\n' : total++; multi++; //fall through
          default   : break;
        }
        break;

      default: //NOT REACHABLE
        break;
    }
  }

  fclose(fp);

  printf( "File                 : %s\n", argv[1] );
  printf( "Total lines          : %8u\n", total );
  printf( "Single-comment lines : %8u\n", single );
  printf( "Multi-comment lines  : %8u\n", multi );
  return 0;
}

BEARBEITEN

Hier ist ein Tisch-driven-äquivalent zu dem oben genannten Programm. Ich erstelle ein state Tabelle zu Steuern, Staatliche übergänge und einen action Tabelle zu kontrollieren, was passiert, wenn ich den Status ändern.

#include <stdio.h>
#include <stdlib.h>
#include <ctype.h>

/**
 * Using preprocessor macros instead of enums, per request; normally
 * I would use enums, since they obey scoping rules and
 * show up in debuggers.
 */
#define TEXT           0
#define SAW_SLASH      1
#define SAW_STAR       2
#define SINGLE_COMMENT 3
#define MULTI_COMMENT  4

#define TOTAL_STATES   5

#define NO_ACTION      0
#define INC_TOTAL      1
#define INC_SINGLE     2
#define INC_MULTI      4

/**
 * This example assumes 7-bit ASCII, for a total of
 * 128 character encodings.  You'll want to change this
 * to handle other encodings.
 */
#define ENCODINGS    128

/**
 * Need a state table to control state transitions and an action
 * table to specify what happens on a transition.  Each table
 * is indexed by the state and the next input character.
 */
static int  state[TOTAL_STATES][ENCODINGS]; //Since these tables are declared at file scope, they will be initialized to
static int action[TOTAL_STATES][ENCODINGS]; //all elements 0, which correspond to the "default" states defined above.

/**
 * Initialize our state table.
 */
void initState( int (*state)[ENCODINGS] )
{
  /**
   * If we're in the TEXT state and see a '/' character, move to the SAW_SLASH
   * state, otherwise stay in the TEXT state
   */
  state[TEXT]['/'] = SAW_SLASH;

  /**
   * If we're in the SAW_SLASH state, we can go one of three ways depending
   * on the next character.
   */
  state[SAW_SLASH]['/'] = SINGLE_COMMENT;
  state[SAW_SLASH]['*'] = MULTI_COMMENT;
  state[SAW_SLASH]['\n'] = TEXT;

  /**
   * For all but a few specific characters, if we're in any one of
   * the SAW_STAR, SINGLE_COMMENT, or MULTI_COMMENT states,
   * we stay in that state.
   */
  for ( size_t i = 0; i < ENCODINGS; i++ )
  {
    state[SAW_STAR][i] = MULTI_COMMENT;
    state[SINGLE_COMMENT][i] = SINGLE_COMMENT;
    state[MULTI_COMMENT][i] = MULTI_COMMENT;
  }

  /**
   * Exceptions to the loop above.
   */
  state[SAW_STAR]['/'] = TEXT;
  state[SAW_STAR]['*'] = SAW_STAR;

  state[SINGLE_COMMENT]['\n'] = TEXT;
  state[MULTI_COMMENT]['*'] = SAW_STAR;
}

/**
 * Initialize our action table
 */
void initAction( int (*action)[ENCODINGS] )
{
  action[TEXT]['\n'] = INC_TOTAL;
  action[SAW_STAR]['/'] = INC_MULTI;
  action[MULTI_COMMENT]['\n'] = INC_MULTI | INC_TOTAL;   //Multiple actions are bitwise-OR'd
  action[SINGLE_COMMENT]['\n'] = INC_SINGLE | INC_TOTAL; //together
  action[SAW_SLASH]['\n'] = INC_TOTAL;
}

/**
 * Scan the input file for comments
 */
void countComments( FILE *stream, size_t *totalLines, size_t *single, size_t *multi )
{
  *totalLines = *single = *multi = 0;

  int c;
  int curState = TEXT, curAction = NO_ACTION;

  while ( ( c = fgetc( stream ) ) != EOF )
  {
    curAction = action[curState][c]; //Read the action before we overwrite the state
    curState = state[curState][c];   //Get the new state (which may be the same as the old state)

    if ( curAction & INC_TOTAL )     //Execute the action.
      (*totalLines)++;

    if ( curAction & INC_SINGLE )
      (*single)++;

    if ( curAction & INC_MULTI )
      (*multi)++;
  }
}

/**
 * Main function.
 */
int main( int argc, char **argv )
{
  /**
   * Input sanity check
   */
  if ( argc < 2 )
  {
    fprintf( stderr, "USAGE: %s <filename>\n", argv[0] );
    exit( EXIT_FAILURE );
  }

  /**
   * Open the input file
   */
  FILE *fp = fopen( argv[1], "r" );
  if ( !fp )
  {
    fprintf( stderr, "Cannot open file %s\n", argv[1] );
    exit( EXIT_FAILURE );
  }

  /**
   * If input file was successfully opened, initialize our
   * state and action tables.
   */
  initState( state );
  initAction( action );

  size_t totalLines, single, multi;

  /**
   * Do the thing.
   */
  countComments( fp, &totalLines, &single, &multi );
  fclose( fp );

  printf( "File                 : %s\n", argv[1] );
  printf( "Total lines          : %zu\n", totalLines );
  printf( "Single-comment lines : %zu\n", single );
  printf( "Multi-comment lines  : %zu\n", multi );

  return EXIT_SUCCESS;
}

Ausführen der Datei auf sich selbst gibt uns

$ ./comment_counter comment_counter.c
File                 : comment_counter.c
Total lines          : 150
Single-comment lines : 7
Multi-comment lines  : 42

die ich für richtig halte. Dieser hat alle die gleichen Schwächen wie die erste version, nur in einer anderen form.