src/text_file.h

   1 /*
   2  * Copyright (C) 2003-2010 The Music Player Daemon Project
   3  * http://www.musicpd.org
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  18  */
  19
  20 #ifndef MPD_TEXT_FILE_H
  21 #define MPD_TEXT_FILE_H
  22
  23 #include <glib.h>
  24
  25 #include <stdio.h>
  26
  27 /**
  28  * Reads a line from the input file, and strips trailing space.  There
  29  * is a reasonable maximum line length, only to prevent denial of
  30  * service.
  31  *
  32  * @param file the source file, opened in text mode
  33  * @param buffer an allocator for the buffer
  34  * @return a pointer to the line, or NULL on end-of-file or error
  35  */
  36 char *
  37 read_text_line(FILE *file, GString *buffer);
  38
  39 #endif