Aegisub/aegisub/src/command/grid.cpp

462 lines
13 KiB
C++
Raw Normal View History

// 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/
/// @file grid.cpp
/// @brief grid/ commands.
/// @ingroup command
///
#include "../config.h"
#include "command.h"
#include "../ass_dialogue.h"
#include "../ass_file.h"
#include "../audio_controller.h"
#include "../audio_timing.h"
#include "../include/aegisub/context.h"
#include "../main.h"
#include "../frame_main.h"
#include "../selection_controller.h"
#include "../utils.h"
namespace {
using cmd::Command;
/// @defgroup cmd-grid Subtitle grid commands.
/// @{
/// Move to the next subtitle line.
struct grid_line_next : public Command {
CMD_NAME("grid/line/next")
STR_MENU("Next Line")
STR_DISP("Next Line")
STR_HELP("Move to the next subtitle line")
void operator()(agi::Context *c) {
c->selectionController->NextLine();
}
};
/// Move to the next subtitle line, creating it if needed
struct grid_line_next_create : public Command {
CMD_NAME("grid/line/next/create")
STR_MENU("Next Line")
STR_DISP("Next Line")
STR_HELP("Move to the next subtitle line, creating a new one if needed")
void operator()(agi::Context *c) {
AudioTimingController *tc = c->audioController->GetTimingController();
if (tc)
tc->Commit();
AssDialogue *cur = c->selectionController->GetActiveLine();
c->selectionController->NextLine();
if (cur == c->selectionController->GetActiveLine()) {
AssDialogue *newline = new AssDialogue;
newline->Start = cur->End;
newline->End = cur->End + OPT_GET("Timing/Default Duration")->GetInt();
newline->Style = cur->Style;
entryIter pos = find(c->ass->Line.begin(), c->ass->Line.end(), cur);
c->ass->Line.insert(++pos, newline);
c->ass->Commit(_("line insertion"), AssFile::COMMIT_DIAG_ADDREM);
c->selectionController->NextLine();
}
}
};
/// Move to the previous line.
struct grid_line_prev : public Command {
CMD_NAME("grid/line/prev")
STR_MENU("Previous Line")
STR_DISP("Previous Line")
STR_HELP("Move to the previous line")
void operator()(agi::Context *c) {
c->selectionController->PrevLine();
}
};
/// Sort all subtitles by their actor names
struct grid_sort_actor : public Command {
CMD_NAME("grid/sort/actor")
STR_MENU("&Actor Name")
STR_DISP("Actor Name")
STR_HELP("Sort all subtitles by their actor names")
void operator()(agi::Context *c) {
c->ass->Sort(AssFile::CompActor);
c->ass->Commit(_("sort"), AssFile::COMMIT_ORDER);
}
};
struct validate_sel_multiple : public Command {
CMD_TYPE(COMMAND_VALIDATE)
bool Validate(const agi::Context *c) {
return c->selectionController->GetSelectedSet().size() > 1;
}
};
/// Sort all selected subtitles by their actor names
struct grid_sort_actor_selected : public validate_sel_multiple {
CMD_NAME("grid/sort/actor/selected")
STR_MENU("&Actor Name")
STR_DISP("Actor Name")
STR_HELP("Sort selected subtitles by their actor names")
void operator()(agi::Context *c) {
c->ass->Sort(AssFile::CompActor, c->selectionController->GetSelectedSet());
c->ass->Commit(_("sort"), AssFile::COMMIT_ORDER);
}
};
/// Sort all subtitles by their effects
struct grid_sort_effect : public Command {
CMD_NAME("grid/sort/effect")
STR_MENU("&Effect")
STR_DISP("Effect")
STR_HELP("Sort all subtitles by their effects")
void operator()(agi::Context *c) {
c->ass->Sort(AssFile::CompEffect);
c->ass->Commit(_("sort"), AssFile::COMMIT_ORDER);
}
};
/// Sort all selected subtitles by their effects
struct grid_sort_effect_selected : public validate_sel_multiple {
CMD_NAME("grid/sort/effect/selected")
STR_MENU("&Effect")
STR_DISP("Effect")
STR_HELP("Sort selected subtitles by their effects")
void operator()(agi::Context *c) {
c->ass->Sort(AssFile::CompEffect, c->selectionController->GetSelectedSet());
c->ass->Commit(_("sort"), AssFile::COMMIT_ORDER);
}
};
/// Sort all subtitles by their end times.
struct grid_sort_end : public Command {
CMD_NAME("grid/sort/end")
STR_MENU("&End Time")
STR_DISP("End Time")
STR_HELP("Sort all subtitles by their end times")
void operator()(agi::Context *c) {
c->ass->Sort(AssFile::CompEnd);
c->ass->Commit(_("sort"), AssFile::COMMIT_ORDER);
}
};
/// Sort all selected subtitles by their end times.
struct grid_sort_end_selected : public validate_sel_multiple {
CMD_NAME("grid/sort/end/selected")
STR_MENU("&End Time")
STR_DISP("End Time")
STR_HELP("Sort selected subtitles by their end times")
void operator()(agi::Context *c) {
c->ass->Sort(AssFile::CompEnd, c->selectionController->GetSelectedSet());
c->ass->Commit(_("sort"), AssFile::COMMIT_ORDER);
}
};
/// Sort all subtitles by their layer number.
struct grid_sort_layer : public Command {
CMD_NAME("grid/sort/layer")
STR_MENU("&Layer")
STR_DISP("Layer")
STR_HELP("Sort all subtitles by their layer number")
void operator()(agi::Context *c) {
c->ass->Sort(AssFile::CompLayer);
c->ass->Commit(_("sort"), AssFile::COMMIT_ORDER);
}
};
/// Sort all selected subtitles by their layer number.
struct grid_sort_layer_selected : public validate_sel_multiple {
CMD_NAME("grid/sort/layer/selected")
STR_MENU("&Layer")
STR_DISP("Layer")
STR_HELP("Sort selected subtitles by their layer number")
void operator()(agi::Context *c) {
c->ass->Sort(AssFile::CompLayer, c->selectionController->GetSelectedSet());
c->ass->Commit(_("sort"), AssFile::COMMIT_ORDER);
}
};
/// Sort all subtitles by their start times.
struct grid_sort_start : public Command {
CMD_NAME("grid/sort/start")
STR_MENU("&Start Time")
STR_DISP("Start Time")
STR_HELP("Sort all subtitles by their start times")
void operator()(agi::Context *c) {
c->ass->Sort();
c->ass->Commit(_("sort"), AssFile::COMMIT_ORDER);
}
};
/// Sort all selected subtitles by their start times.
struct grid_sort_start_selected : public validate_sel_multiple {
CMD_NAME("grid/sort/start/selected")
STR_MENU("&Start Time")
STR_DISP("Start Time")
STR_HELP("Sort selected subtitles by their start times")
void operator()(agi::Context *c) {
c->ass->Sort(AssFile::CompStart, c->selectionController->GetSelectedSet());
c->ass->Commit(_("sort"), AssFile::COMMIT_ORDER);
}
};
/// Sort all subtitles by their style names
struct grid_sort_style : public Command {
CMD_NAME("grid/sort/style")
STR_MENU("St&yle Name")
STR_DISP("Style Name")
STR_HELP("Sort all subtitles by their style names")
void operator()(agi::Context *c) {
c->ass->Sort(AssFile::CompStyle);
c->ass->Commit(_("sort"), AssFile::COMMIT_ORDER);
}
};
/// Sort all selected subtitles by their style names
struct grid_sort_style_selected : public validate_sel_multiple {
CMD_NAME("grid/sort/style/selected")
STR_MENU("St&yle Name")
STR_DISP("Style Name")
STR_HELP("Sort selected subtitles by their style names")
void operator()(agi::Context *c) {
c->ass->Sort(AssFile::CompStyle, c->selectionController->GetSelectedSet());
c->ass->Commit(_("sort"), AssFile::COMMIT_ORDER);
}
};
/// Cycle through tag hiding modes.
struct grid_tag_cycle_hiding : public Command {
CMD_NAME("grid/tag/cycle_hiding")
STR_MENU("Cycle Tag Hiding Mode")
STR_DISP("Cycle Tag Hiding Mode")
STR_HELP("Cycle through tag hiding modes")
void operator()(agi::Context *) {
int tagMode = OPT_GET("Subtitle/Grid/Hide Overrides")->GetInt();
// Cycle to next
tagMode = (tagMode+1)%3;
// Show on status bar
wxString message;
if (tagMode == 0) message = _("ASS Override Tag mode set to show full tags.");
if (tagMode == 1) message = _("ASS Override Tag mode set to simplify tags.");
if (tagMode == 2) message = _("ASS Override Tag mode set to hide tags.");
wxGetApp().frame->StatusTimeout(message,10000);
// Set option
OPT_SET("Subtitle/Grid/Hide Overrides")->SetInt(tagMode);
}
};
/// Hide override tags in the subtitle grid.
struct grid_tags_hide : public Command {
CMD_NAME("grid/tags/hide")
STR_MENU("&Hide Tags")
STR_DISP("Hide Tags")
STR_HELP("Hide override tags in the subtitle grid")
CMD_TYPE(COMMAND_RADIO)
bool IsActive(const agi::Context *) {
return OPT_GET("Subtitle/Grid/Hide Overrides")->GetInt() == 2;
}
void operator()(agi::Context *) {
OPT_SET("Subtitle/Grid/Hide Overrides")->SetInt(2);
}
};
/// Show full override tags in the subtitle grid.
struct grid_tags_show : public Command {
CMD_NAME("grid/tags/show")
STR_MENU("Sh&ow Tags")
STR_DISP("Show Tags")
STR_HELP("Show full override tags in the subtitle grid")
CMD_TYPE(COMMAND_RADIO)
bool IsActive(const agi::Context *) {
return OPT_GET("Subtitle/Grid/Hide Overrides")->GetInt() == 0;
}
void operator()(agi::Context *) {
OPT_SET("Subtitle/Grid/Hide Overrides")->SetInt(0);
}
};
/// Replace override tags in the subtitle grid with a simplified placeholder.
struct grid_tags_simplify : public Command {
CMD_NAME("grid/tags/simplify")
STR_MENU("S&implify Tags")
STR_DISP("Simplify Tags")
STR_HELP("Replace override tags in the subtitle grid with a simplified placeholder")
CMD_TYPE(COMMAND_RADIO)
bool IsActive(const agi::Context *) {
return OPT_GET("Subtitle/Grid/Hide Overrides")->GetInt() == 1;
}
void operator()(agi::Context *) {
OPT_SET("Subtitle/Grid/Hide Overrides")->SetInt(1);
}
};
template<class T, class U>
static bool move_one(T begin, T end, U const& value) {
size_t move_count = 0;
T prev = end;
for (; begin != end; ++begin) {
typename U::key_type cur = dynamic_cast<typename U::key_type>(*begin);
bool in_set = !!value.count(cur);
if (!in_set && cur)
prev = begin;
else if (in_set && prev != end) {
using std::swap;
swap(*begin, *prev);
prev = begin;
if (++move_count == value.size())
break;
}
}
return move_count > 0;
}
/// Move the selected lines up one row
struct grid_move_up : public Command {
CMD_NAME("grid/move/up")
STR_MENU("Move line up")
STR_DISP("Move line up")
STR_HELP("Move the selected lines up one row")
CMD_TYPE(COMMAND_VALIDATE)
bool Validate(const agi::Context *c) {
return c->selectionController->GetSelectedSet().size() != 0;
}
void operator()(agi::Context *c) {
if (move_one(c->ass->Line.begin(), c->ass->Line.end(), c->selectionController->GetSelectedSet()))
c->ass->Commit(_("move lines"), AssFile::COMMIT_ORDER);
}
};
/// Move the selected lines down one row
struct grid_move_down : public Command {
CMD_NAME("grid/move/down")
STR_MENU("Move line down")
STR_DISP("Move line down")
STR_HELP("Move the selected lines down one row")
CMD_TYPE(COMMAND_VALIDATE)
bool Validate(const agi::Context *c) {
return c->selectionController->GetSelectedSet().size() != 0;
}
void operator()(agi::Context *c) {
if (move_one(c->ass->Line.rbegin(), c->ass->Line.rend(), c->selectionController->GetSelectedSet()))
c->ass->Commit(_("move lines"), AssFile::COMMIT_ORDER);
}
};
/// Swaps the two selected lines.
struct grid_swap : public Command {
CMD_NAME("grid/swap")
STR_MENU("Swap Lines")
STR_DISP("Swap Lines")
STR_HELP("Swaps the two selected lines")
CMD_TYPE(COMMAND_VALIDATE)
bool Validate(const agi::Context *c) {
return c->selectionController->GetSelectedSet().size() == 2;
}
void operator()(agi::Context *c) {
SubtitleSelection sel = c->selectionController->GetSelectedSet();
if (sel.size() == 2) {
entryIter a = find(c->ass->Line.begin(), c->ass->Line.end(), *sel.begin());
entryIter b = find(c->ass->Line.begin(), c->ass->Line.end(), *sel.rbegin());
using std::swap;
swap(*a, *b);
c->ass->Commit(_("swap lines"), AssFile::COMMIT_ORDER);
}
}
};
}
/// @}
namespace cmd {
void init_grid() {
reg(new grid_line_next);
reg(new grid_line_next_create);
reg(new grid_line_prev);
reg(new grid_sort_actor);
reg(new grid_sort_effect);
reg(new grid_sort_end);
reg(new grid_sort_layer);
reg(new grid_sort_start);
reg(new grid_sort_style);
reg(new grid_sort_actor_selected);
reg(new grid_sort_effect_selected);
reg(new grid_sort_end_selected);
reg(new grid_sort_layer_selected);
reg(new grid_sort_start_selected);
reg(new grid_sort_style_selected);
reg(new grid_move_down);
reg(new grid_move_up);
reg(new grid_swap);
reg(new grid_tag_cycle_hiding);
reg(new grid_tags_hide);
reg(new grid_tags_show);
reg(new grid_tags_simplify);
}
}