Aegisub/aegisub/src/subtitle_format_ass.cpp

// Copyright (c) 2006, 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 subtitle_format_ass.cpp
/// @brief Reading/writing of SSA-lineage subtitles
/// @ingroup subtitle_io
///


///////////
// Headers
#include "config.h"

#include "ass_dialogue.h"
#include "subtitle_format_ass.h"
#include "text_file_reader.h"
#include "text_file_writer.h"


/// @brief Can read? 
/// @param filename 
/// @return 
///
bool ASSSubtitleFormat::CanReadFile(wxString filename) {
	return (filename.Right(4).Lower() == ".ass" || filename.Right(4).Lower() == ".ssa");
}



/// @brief Get name 
/// @return 
///
wxString ASSSubtitleFormat::GetName() {
	return "Advanced Substation Alpha";
}



/// @brief Get read wildcards 
/// @return 
///
wxArrayString ASSSubtitleFormat::GetReadWildcards() {
	wxArrayString formats;
	formats.Add("ass");
	formats.Add("ssa");
	return formats;
}



/// @brief Get write wildcards 
/// @return 
///
wxArrayString ASSSubtitleFormat::GetWriteWildcards() {
	wxArrayString formats;
	formats.Add("ass");
	formats.Add("ssa");
	return formats;
}



/// @brief Read file 
/// @param filename 
/// @param encoding 
///
void ASSSubtitleFormat::ReadFile(wxString filename,wxString encoding) {
	using namespace std;

	// Reader
	TextFileReader file(filename,encoding);
	int version = 1;
	if (filename.Right(4).Lower() == ".ssa") version = 0;

	// Parse file
	wxString curgroup;
	wxString wxbuffer;
	while (file.HasMoreLines()) {
		// Reads line
		wxbuffer = file.ReadLineFromFile();

		// Make sure that the first non-blank non-comment non-group-header line
		// is really [Script Info]
		if (curgroup.IsEmpty() && !wxbuffer.IsEmpty() && wxbuffer[0] != ';' && wxbuffer[0] != '[') {
			curgroup = "[Script Info]";
			AddLine(curgroup,curgroup,version,&curgroup);
		}

		// Convert v4 styles to v4+ styles
		if (!wxbuffer.IsEmpty() && wxbuffer[0] == '[') {
			// Ugly hacks to allow intermixed v4 and v4+ style sections
			wxString low = wxbuffer.Lower();
			if (low == "[v4 styles]") {
				wxbuffer = "[V4+ Styles]";
				curgroup = wxbuffer;
				version = 0;
			}
			else if (low == "[v4+ styles]") {
				wxbuffer = "[V4+ Styles]";
				curgroup = wxbuffer;
				version = 1;
			}
			else if (low == "[v4++ styles]") {
				wxbuffer = "[V4+ Styles]";
				curgroup = wxbuffer;
				version = 2;
			}
			// Not-so-special case for other groups, just set it
			else {
				curgroup = wxbuffer;
			}
		}

		// Add line
		try {
			AddLine(wxbuffer,curgroup,version,&curgroup);
		}
		catch (const char *err) {
			Clear();
			throw wxString("Error processing line: ") + wxbuffer + ": " + wxString(err);
		}
		catch (...) {
			Clear();
			throw wxString("Error processing line: ") + wxbuffer;
		}
	}
}



/// @brief Can write to file? 
/// @param filename 
/// @return 
///
bool ASSSubtitleFormat::CanWriteFile(wxString filename) {
	return (filename.Right(4).Lower() == ".ass" || filename.Right(4).Lower() == ".ssa");
}



/// @brief Write file 
/// @param _filename 
/// @param encoding  
///
void ASSSubtitleFormat::WriteFile(wxString filename,wxString encoding) {
	// Open file
	TextFileWriter file(filename,encoding);
	bool ssa = filename.Right(4).Lower() == ".ssa";

	// Write lines
	std::list<AssEntry*>::iterator last = Line->end(); --last;
	wxString group = Line->front()->group;
	for (std::list<AssEntry*>::iterator cur=Line->begin(); cur!=Line->end(); ++cur) {
		// Add a blank line between each group
		if ((*cur)->group != group) {
			file.WriteLineToFile("");
			group = (*cur)->group;
		}

		// Only add a line break if there is a next line
		bool lineBreak = cur != last;

		// Write line
		if (ssa) file.WriteLineToFile((*cur)->GetSSAText(),lineBreak);
		else file.WriteLineToFile((*cur)->GetEntryData(),lineBreak);
	}
}