Aegisub/aegisub/src/command/subtitle.cpp

// Copyright (c) 2005-2010, Niels Martin Hansen
// Copyright (c) 2005-2010, Rodrigo Braz Monteiro
// Copyright (c) 2010, Amar Takhar
// 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.cpp
/// @brief subtitle/ commands.
/// @ingroup command
///

#include "../config.h"

#ifndef AGI_PRE
#include <wx/filename.h>
#include <wx/filedlg.h>
#include <wx/choicdlg.h>
#endif

#include <libaegisub/charset_conv.h>

#include "command.h"

#include "../ass_file.h"
#include "../compat.h"
#include "../dialog_attachments.h"
#include "../dialog_properties.h"
#include "../dialog_search_replace.h"
#include "../dialog_spellchecker.h"
#include "../frame_main.h"
#include "../include/aegisub/context.h"
#include "../main.h"
#include "../subs_grid.h"
#include "../video_context.h"


namespace cmd {
/// @defgroup cmd-subtitle Subtitle commands.
/// @{


/// Open the attachment list.
class subtitle_attachment: public Command {
public:
	CMD_NAME("subtitle/attachment")
	STR_MENU("&Attachments..")
	STR_DISP("Attachments")
	STR_HELP("Open the attachment list.")

	void operator()(agi::Context *c) {
		VideoContext::Get()->Stop();
		DialogAttachments attachments(c->parent, c->ass);
		attachments.ShowModal();
	}
};


/// Find words in subtitles.
class subtitle_find: public Command {
public:
	CMD_NAME("subtitle/find")
	STR_MENU("&Find..")
	STR_DISP("Find")
	STR_HELP("Find words in subtitles.")

	void operator()(agi::Context *c) {
		VideoContext::Get()->Stop();
		Search.OpenDialog(false);
	}
};


/// Find next match of last word.
class subtitle_find_next: public Command {
public:
	CMD_NAME("subtitle/find/next")
	STR_MENU("Find Next")
	STR_DISP("Find Next")
	STR_HELP("Find next match of last word.")

	void operator()(agi::Context *c) {
		VideoContext::Get()->Stop();
		Search.FindNext();
	}
};


/// Inserts a line after current.
class subtitle_insert_after: public Command {
public:
	CMD_NAME("subtitle/insert/after")
	STR_MENU("&After Current")
	STR_DISP("After Current")
	STR_HELP("Inserts a line after current.")

	void operator()(agi::Context *c) {
//XXX: subs_grid.cpp
	}
};


/// Inserts a line after current, starting at video time.
class subtitle_insert_after_videotime: public Command {
public:
	CMD_NAME("subtitle/insert/after/videotime")
	STR_MENU("After Current, at Video Time")
	STR_DISP("After Current, at Video Time")
	STR_HELP("Inserts a line after current, starting at video time.")

	void operator()(agi::Context *c) {
//XXX: subs_grid.cpp
	}
};


/// Inserts a line before current.
class subtitle_insert_before: public Command {
public:
	CMD_NAME("subtitle/insert/before")
	STR_MENU("&Before Current")
	STR_DISP("Before Current")
	STR_HELP("Inserts a line before current.")

	void operator()(agi::Context *c) {
//XXX: subs_grid.cpp
	}
};


/// Inserts a line before current, starting at video time.
class subtitle_insert_before_videotime: public Command {
public:
	CMD_NAME("subtitle/insert/before/videotime")
	STR_MENU("Before Current, at Video Time")
	STR_DISP("Before Current, at Video Time")
	STR_HELP("Inserts a line before current, starting at video time.")

	void operator()(agi::Context *c) {
//XXX: subs_grid.cpp
	}
};


/// New subtitles.
class subtitle_new: public Command {
public:
	CMD_NAME("subtitle/new")
	STR_MENU("&New Subtitles")
	STR_DISP("New Subtitles")
	STR_HELP("New subtitles.")

	void operator()(agi::Context *c) {
		wxGetApp().frame->LoadSubtitles(_T(""));
	}
};


/// Opens a subtitles file.
class subtitle_open: public Command {
public:
	CMD_NAME("subtitle/open")
	STR_MENU("&Open Subtitles..")
	STR_DISP("Open Subtitles")
	STR_HELP("Opens a subtitles file.")

	void operator()(agi::Context *c) {
		wxString path = lagi_wxString(OPT_GET("Path/Last/Subtitles")->GetString()); 
		wxString filename = wxFileSelector(_("Open subtitles file"),path,_T(""),_T(""),AssFile::GetWildcardList(0),wxFD_OPEN | wxFD_FILE_MUST_EXIST);
		if (!filename.empty()) {
			wxGetApp().frame->LoadSubtitles(filename);
			wxFileName filepath(filename);
			OPT_SET("Path/Last/Subtitles")->SetString(STD_STR(filepath.GetPath()));
		}
	}
};


/// Opens a subtitles file with a specific charset.
class subtitle_open_charset: public Command {
public:
	CMD_NAME("subtitle/open/charset")
	STR_MENU("&Open Subtitles with Charset..")
	STR_DISP("Open Subtitles with Charset")
	STR_HELP("Opens a subtitles file with a specific charset.")

	void operator()(agi::Context *c) {
		// Initialize charsets
		wxString path = lagi_wxString(OPT_GET("Path/Last/Subtitles")->GetString());

		// Get options and load
		wxString filename = wxFileSelector(_("Open subtitles file"),path,_T(""),_T(""),AssFile::GetWildcardList(0),wxFD_OPEN | wxFD_FILE_MUST_EXIST);
		if (!filename.empty()) {
			wxString charset = wxGetSingleChoice(_("Choose charset code:"), _("Charset"), agi::charset::GetEncodingsList<wxArrayString>(), c->parent, -1, -1, true, 250, 200);
			if (!charset.empty()) {
				wxGetApp().frame->LoadSubtitles(filename,charset);
			}
			OPT_SET("Path/Last/Subtitles")->SetString(STD_STR(filename));
		}
	}
};


/// Opens the subtitles from the current video file.
class subtitle_open_video: public Command {
public:
	CMD_NAME("subtitle/open/video")
	STR_MENU("Open Subtitles from &Video")
	STR_DISP("Open Subtitles from Video")
	STR_HELP("Opens the subtitles from the current video file.")

	void operator()(agi::Context *c) {
		wxGetApp().frame->LoadSubtitles(VideoContext::Get()->videoName, "binary");
	}
};


/// Open script properties window.
class subtitle_properties: public Command {
public:
	CMD_NAME("subtitle/properties")
	STR_MENU("&Properties..")
	STR_DISP("Properties")
	STR_HELP("Open script properties window.")

	void operator()(agi::Context *c) {
		VideoContext::Get()->Stop();
		DialogProperties Properties(c->parent, c->ass);
		Properties.ShowModal();
	}
};



/// Saves subtitles.
class subtitle_save: public Command {
public:
	CMD_NAME("subtitle/save")
	STR_MENU("&Save Subtitles")
	STR_DISP("Save Subtitles")
	STR_HELP("Saves subtitles.")

	void operator()(agi::Context *c) {
		wxGetApp().frame->SaveSubtitles(false);
	}
};


/// Saves subtitles with another name.
class subtitle_save_as: public Command {
public:
	CMD_NAME("subtitle/save/as")
	STR_MENU("Save Subtitles as..")
	STR_DISP("Save Subtitles as")
	STR_HELP("Saves subtitles with another name.")

	void operator()(agi::Context *c) {
		wxGetApp().frame->SaveSubtitles(true);
	}
};


/// Selects all lines that are currently visible on video frame.
class subtitle_select_visiblek: public Command {
public:
	CMD_NAME("subtitle/select/visible")
	STR_MENU("Select Visible")
	STR_DISP("Select Visible")
	STR_HELP("Selects all lines that are currently visible on video frame.")

	void operator()(agi::Context *c) {
		VideoContext::Get()->Stop();
		c->SubsGrid->SelectVisible();
	}
};


/// Open spell checker.
class subtitle_spellcheck: public Command {
public:
	CMD_NAME("subtitle/spellcheck")
	STR_MENU("Spe&ll Checker..")
	STR_DISP("Spell Checker")
	STR_HELP("Open spell checker.")

	void operator()(agi::Context *c) {
//XXX: This is obscene, requires refactoring the spellchecker.
//	VideoContext::Get()->Stop();
//	new DialogSpellChecker;
	}
};


/// 
class subtitle_tags_show: public Command {
public:
	CMD_NAME("subtitle/tags/show")
	STR_MENU("XXX: No idea")
	STR_DISP("XXX: No idea")
	STR_HELP("XXX: No idea")

	void operator()(agi::Context *c) {
//XXX: see grid.cpp:grid_tags_hide()
	}
};

/// @}

/// Init subtitle/ commands.
void init_subtitle(CommandManager *cm) {
	cm->reg(new subtitle_attachment());
	cm->reg(new subtitle_find());
	cm->reg(new subtitle_find_next());
	cm->reg(new subtitle_insert_after());
	cm->reg(new subtitle_insert_after_videotime());
	cm->reg(new subtitle_insert_before());
	cm->reg(new subtitle_insert_before_videotime());
	cm->reg(new subtitle_new());
	cm->reg(new subtitle_open());
	cm->reg(new subtitle_open_charset());
	cm->reg(new subtitle_open_video());
	cm->reg(new subtitle_properties());
	cm->reg(new subtitle_save());
	cm->reg(new subtitle_save_as());
	cm->reg(new subtitle_select_visiblek());
	cm->reg(new subtitle_spellcheck());
	cm->reg(new subtitle_tags_show());
}


} // namespace cmd