Aegisub/aegisub/src/text_file_reader.h

// Copyright (c) 2005, 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


/// DOCME
/// @class TextFileReader
/// @brief DOCME
///
/// DOCME
class TextFileReader {
private:

	/// DOCME
	wxString encoding;

	/// DOCME
	std::ifstream file;

	/// DOCME
	iconv_t conv;

	/// DOCME
	bool trim;

	/// DOCME
	bool readComplete;


	/// DOCME
	wchar_t outbuf[256];

	/// DOCME
	wchar_t *currout;

	/// DOCME
	wchar_t *outptr;

	/// DOCME
	size_t  outbytesleft;


	/// DOCME
	unsigned int currentLine;

	wchar_t GetWChar();

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

public:
	TextFileReader(wxString filename,wxString encoding=_T(""), bool trim=true);
	~TextFileReader();

	wxString ReadLineFromFile();
	bool HasMoreLines();

	static void EnsureValid(const wxString encoding);
	wxString GetCurrentEncoding();
	static wxString GetEncoding(const wxString filename);
};