Aegisub/aegisub/src/command/edit.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 edit.cpp
/// @brief edit/ commands.
/// @ingroup command
///

#include "../config.h"

#ifndef AGI_PRE
#endif

#include "command.h"

#include "../ass_file.h"
#include "../dialog_search_replace.h"
#include "../include/aegisub/context.h"
#include "../subs_edit_box.h"
#include "../subs_edit_ctrl.h"
#include "../subs_grid.h"
#include "../video_context.h"

namespace cmd {
/// @defgroup cmd-edit Editing commands.
/// @{


/// Copy subtitles.
class edit_line_copy: public Command {
public:
	CMD_NAME("edit/line/copy")
	STR_MENU("Copy Lines")
	STR_DISP("Copy Lines")
	STR_HELP("Copy subtitles.")

	void operator()(agi::Context *c) {
		if (c->parent->FindFocus() == c->EditBox->TextEdit) {
			c->EditBox->TextEdit->Copy();
			return;
		}
		c->SubsGrid->CopyLines(c->SubsGrid->GetSelection());
	}
};


/// Cut subtitles.
class edit_line_cut: public Command {
public:
	CMD_NAME("edit/line/cut")
	STR_MENU("Cut Lines")
	STR_DISP("Cut Lines")
	STR_HELP("Cut subtitles.")

	void operator()(agi::Context *c) {
		if (c->parent->FindFocus() == c->EditBox->TextEdit) {
			c->EditBox->TextEdit->Cut();
			return;
		}
		c->SubsGrid->CutLines(c->SubsGrid->GetSelection());
	}
};


/// Delete currently selected lines.
class edit_line_delete: public Command {
public:
	CMD_NAME("edit/line/delete")
	STR_MENU("Delete Lines")
	STR_DISP("Delete Lines")
	STR_HELP("Delete currently selected lines.")

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


/// Duplicate the selected lines.
class edit_line_duplicate: public Command {
public:
	CMD_NAME("edit/line/duplicate")
	STR_MENU("&Duplicate Lines")
	STR_DISP("Duplicate Lines")
	STR_HELP("Duplicate the selected lines.")

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


/// Duplicate lines and shift by one frame.
class edit_line_duplicate_shift: public Command {
public:
	CMD_NAME("edit/line/duplicate/shift")
	STR_MENU("&Duplicate and Shift by 1 Frame")
	STR_DISP("Duplicate and Shift by 1 Frame")
	STR_HELP("Duplicate lines and shift by one frame.")

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


/// Joins selected lines in a single one, as karaoke.
class edit_line_join_as_karaoke: public Command {
public:
	CMD_NAME("edit/line/join/as_karaoke")
	STR_MENU("As &Karaoke")
	STR_DISP("As Karaoke")
	STR_HELP("Joins selected lines in a single one, as karaoke.")

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


/// Joins selected lines in a single one, concatenating text together.
class edit_line_join_concatenate: public Command {
public:
	CMD_NAME("edit/line/join/concatenate")
	STR_MENU("&Concatenate")
	STR_DISP("Concatenate")
	STR_HELP("Joins selected lines in a single one, concatenating text together.")

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


/// Joins selected lines in a single one, keeping text of first and discarding remaining.
class edit_line_join_keep_first: public Command {
public:
	CMD_NAME("edit/line/join/keep_first")
	STR_MENU("Keep &First")
	STR_DISP("Keep First")
	STR_HELP("Joins selected lines in a single one, keeping text of first and discarding remaining.")

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


/// Paste subtitles.
class edit_line_paste: public Command {
public:
	CMD_NAME("edit/line/paste")
	STR_MENU("Paste Lines")
	STR_DISP("Paste Lines")
	STR_HELP("Paste subtitles.")

	void operator()(agi::Context *c) {
		if (c->parent->FindFocus() == c->EditBox->TextEdit) {
			c->EditBox->TextEdit->Paste();
			return;
		}
		c->SubsGrid->PasteLines(c->SubsGrid->GetFirstSelRow());
	}
};


/// Paste subtitles over others.
class edit_line_paste_over: public Command {
public:
	CMD_NAME("edit/line/paste/over")
	STR_MENU("Paste Lines Over..")
	STR_DISP("Paste Lines Over")
	STR_HELP("Paste subtitles over others.")

	void operator()(agi::Context *c) {
		c->SubsGrid->PasteLines(c->SubsGrid->GetFirstSelRow(),true);
	}
};


/// Recombine subtitles when they have been split and merged.
class edit_line_recombine: public Command {
public:
	CMD_NAME("edit/line/recombine")
	STR_MENU("Recombine Lines")
	STR_DISP("Recombine Lines")
	STR_HELP("Recombine subtitles when they have been split and merged.")

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


/// Uses karaoke timing to split line into multiple smaller lines.
class edit_line_split_by_karaoke: public Command {
public:
	CMD_NAME("edit/line/split/by_karaoke")
	STR_MENU("Split Lines (by karaoke)")
	STR_DISP("Split Lines (by karaoke)")
	STR_HELP("Uses karaoke timing to split line into multiple smaller lines.")

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


/// Swaps the two selected lines.
class edit_line_swap: public Command {
public:
	CMD_NAME("edit/line/swap")
	STR_MENU("Swap Lines")
	STR_DISP("Swap Lines")
	STR_HELP("Swaps the two selected lines.")

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


/// Redoes last action.
class edit_redo: public Command {
public:
	CMD_NAME("edit/redo")
	STR_MENU("&Redo")
	STR_DISP("Redo")
	STR_HELP("Redoes last action.")

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


/// Find and replace words in subtitles.
class edit_search_replace: public Command {
public:
	CMD_NAME("edit/search_replace")
	STR_MENU("Search and &Replace..")
	STR_DISP("Search and Replace")
	STR_HELP("Find and replace words in subtitles.")

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


/// Undoes last action.
class edit_undo: public Command {
public:
	CMD_NAME("edit/undo")
	STR_MENU("&Undo")
	STR_DISP("Undo")
	STR_HELP("Undoes last action.")

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

/// @}

/// Init edit/ commands
void init_edit(CommandManager *cm) {
	cm->reg(new edit_line_copy());
	cm->reg(new edit_line_cut());
	cm->reg(new edit_line_delete());
	cm->reg(new edit_line_duplicate());
	cm->reg(new edit_line_duplicate_shift());
	cm->reg(new edit_line_join_as_karaoke());
	cm->reg(new edit_line_join_concatenate());
	cm->reg(new edit_line_join_keep_first());
	cm->reg(new edit_line_paste());
	cm->reg(new edit_line_paste_over());
	cm->reg(new edit_line_recombine());
	cm->reg(new edit_line_split_by_karaoke());
	cm->reg(new edit_line_swap());
	cm->reg(new edit_redo());
	cm->reg(new edit_search_replace());
	cm->reg(new edit_undo());
}

} // namespace cmd