diff options
Diffstat (limited to 'src/fs/io/TextFile.hxx')
-rw-r--r-- | src/fs/io/TextFile.hxx | 73 |
1 files changed, 73 insertions, 0 deletions
diff --git a/src/fs/io/TextFile.hxx b/src/fs/io/TextFile.hxx new file mode 100644 index 000000000..5577363e7 --- /dev/null +++ b/src/fs/io/TextFile.hxx @@ -0,0 +1,73 @@ +/* + * Copyright (C) 2003-2014 The Music Player Daemon Project + * http://www.musicpd.org + * + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + */ + +#ifndef MPD_TEXT_FILE_HXX +#define MPD_TEXT_FILE_HXX + +#include "check.h" +#include "Compiler.h" + +#include <stddef.h> + +class Path; +class Error; +class FileReader; +class AutoGunzipReader; +class BufferedReader; + +class TextFile { + FileReader *const file_reader; + +#ifdef HAVE_ZLIB + AutoGunzipReader *const gunzip_reader; +#endif + + BufferedReader *const buffered_reader; + +public: + TextFile(Path path_fs, Error &error); + + TextFile(const TextFile &other) = delete; + + ~TextFile(); + + bool HasFailed() const { + return gcc_unlikely(buffered_reader == nullptr); + } + + /** + * Reads a line from the input file, and strips trailing + * space. There is a reasonable maximum line length, only to + * prevent denial of service. + * + * Use Check() after nullptr has been returned to check + * whether an error occurred or end-of-file has been reached. + * + * @param file the source file, opened in text mode + * @return a pointer to the line, or nullptr on end-of-file or error + */ + char *ReadLine(); + + /** + * Check whether a ReadLine() call has thrown an error. + */ + bool Check(Error &error) const; +}; + +#endif |