TSVFileStream.h

#ifndef TSVFILESTREAM_H
#define TSVFILESTREAM_H

#include "cppCORE_global.h"
#include <QVector>
#include "VersatileFile.h"

/**
  @brief TSV file parser as stream.

  Assumes that single-quoted header is before the first content line.
*/
class CPPCORESHARED_EXPORT TSVFileStream
{
public:
	///Constructor. Reads from stdin if @p filename is empty.
	TSVFileStream(QString filename, char separator = '\t', char comment = '#');
    ///Destructor.
    ~TSVFileStream();

	///Returns if the stream is at the end.
	bool atEnd() const
	{
		return file_->atEnd() && next_line_.isNull();
	}

	///Returns the current line, split to columns. Note: Empty lines are returned as an empty array.
	QByteArrayList readLine();

	///Returns the split header line. If no header is present, a list with empty string is returned.
	const QByteArrayList& header() const
	{
		return header_;
	}
	///Returns the header column index of the column 'name', or -1 when the column is missing.
	int colIndex(QByteArray name, bool error_when_missing);

	///Returns the comment lines.
	const QByteArrayList& comments() const
	{
		return comments_;
	}
	///Returns the number of columns in the file.
	int columns() const
	{
		return header_.count();
	}

	///Returns the 0-based index of the last read line.
	int lineIndex() const
	{
		return line_;
	}

	//Resets to the state after the coinstructor (internal pointer on first line)
	void reset();

	///Checks and converts a comma-separated list of columns (names or 1-based indices) to 0-based numeric indices.
	QVector<int> checkColumns(const QByteArrayList& col_names, bool numeric);

protected:
	QString filename_;
	char separator_;
	char comment_;
	QByteArray double_comment_;
	QSharedPointer<VersatileFile> file_;
	QByteArray next_line_;
	QByteArrayList comments_;
	QByteArrayList header_;
	int line_;

    //declared away methods
	TSVFileStream(const TSVFileStream& ) = delete;
	TSVFileStream& operator=(const TSVFileStream&) = delete;
	TSVFileStream() = delete;
};


#endif