src/text_input_stream.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_INPUT_STREAM_H
  21 #define MPD_TEXT_INPUT_STREAM_H
  22
  23 struct input_stream;
  24 struct text_input_stream;
  25
  26 /**
  27  * Wraps an existing #input_stream object into a #text_input_stream,
  28  * to read its contents as text lines.
  29  *
  30  * @param is an open #input_stream object
  31  * @return the new #text_input_stream object
  32  */
  33 struct text_input_stream *
  34 text_input_stream_new(struct input_stream *is);
  35
  36 /**
  37  * Frees the #text_input_stream object.  Does not close or free the
  38  * underlying #input_stream.
  39  */
  40 void
  41 text_input_stream_free(struct text_input_stream *tis);
  42
  43 /**
  44  * Reads the next line from the stream.
  45  *
  46  * @return a line (newline character stripped), or NULL on end of file
  47  * or error
  48  */
  49 const char *
  50 text_input_stream_read(struct text_input_stream *tis);
  51
  52 #endif