Aegisub/aegisub/src/text_file_reader.h

// Copyright (c) 2010, Rodrigo Braz Monteiro
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//
//   * Redistributions of source code must retain the above copyright notice,
//     this list of conditions and the following disclaimer.
//   * Redistributions in binary form must reproduce the above copyright notice,
//     this list of conditions and the following disclaimer in the documentation
//     and/or other materials provided with the distribution.
//   * Neither the name of the Aegisub Group nor the names of its contributors
//     may be used to endorse or promote products derived from this software
//     without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
// AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
// LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
// CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
// SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
// INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
//
// Aegisub Project http://www.aegisub.org/
//
// $Id$

/// @file text_file_reader.h
/// @see text_file_reader.cpp
/// @ingroup utility
///

#pragma once

#ifndef AGI_PRE
#include <fstream>

#include <iconv.h>

#include <wx/dynarray.h>
#include <wx/string.h>
#endif

/// @class TextFileReader
/// @brief A line-based text file reader
class TextFileReader {
private:
	/// Encoding of the file being read
	wxString encoding;
	std::ifstream file;
	iconv_t conv;
	bool trim;
	bool readComplete;

	// Iconv buffers and state
	wchar_t outbuf[256];
	wchar_t *currout;
	wchar_t *outptr;
	size_t  outbytesleft;

	/// Current line number
	unsigned int currentLine;

	/// @brief Read a single wchar_t from the file
	wchar_t GetWChar();

	TextFileReader(const TextFileReader&);
	TextFileReader& operator=(const TextFileReader&);

public:
	/// @brief Constructor
	/// @param filename File to open
	/// @param enc      Encoding to use, or empty to autodetect
	/// @param trim     Whether to trim whitespace from lines read
	TextFileReader(wxString filename,wxString encoding=L"", bool trim=true);
	/// @brief Destructor
	~TextFileReader();

	/// @brief Read a line from the file
	/// @return The line, possibly trimmed
	wxString ReadLineFromFile();
	/// @brief Check if there are any more lines to read
	bool HasMoreLines();

	/// @brief Get the file encoding used by this reader
	/// @return "unknown", "binary", or a character encoding name
	wxString GetCurrentEncoding();

	/// @brief Attempt to detect a file's encoding
	/// @param filename The file to check
	/// @return "unknown", "binary", or a character encoding name
	static wxString GetEncoding(wxString const& filename);
};