Laboratoire de l'Informatique et du Parallélisme » Pobyso

/** @file read-lines-from-file.h

 * Read lines from a text file, filtering out empty, #-comment lines,

 * leading spaces and tab, trailing comments.

 * @author S.T.

 * @date 2016/10/18

 */

/******************************************************************************/

/*

 * Prerequisites for use:

 *   The user must include

 *   #include <stdio.h>

 *   #include <libgen.h>

 */

#ifndef RLFF_INCLUDE_h

#define RLFF_INCLUDE_h

  /* Types, constants and macros definitions. */

  typedef struct rlff_readLines rlff_readLines_t;

  struct rlff_readLines

  {

    unsigned int linesNum;

    unsigned int linesLength;

    char* lines;

  };

  /* Exported functions. */

  /** Free a readLines_t object. */

  void

  rlff_free_lines(rlff_readLines_t* linesRead);

  char*

  rlff_get_line_at(rlff_readLines_t* linesRead, unsigned int lineIndex);

  /** Print the lines. */

  void

  rlff_print_lines(rlff_readLines_t* linesRead);

  /** Read the lines from a file give by name. */

  rlff_readLines_t*

  rlff_read_lines_from_file_name(char* fileName);

  /** Read the lines from a file give by a handle on the file file. */

  rlff_readLines_t*

  rlff_read_lines_from_file_handle(FILE* fileHandle);

#endif