6ee2f98349
Document all functions, class, struct, union, enum, macro, variable, typedefs. This isn't the actual document in itself but empty documentation using any old documentation if it was there. This was done using exuberant ctags to get tag info, then a TCL script to parse/remove old comments and convert them into Doxygen-style. Some notes: * Anything labeled 'DOCME' needs to be documented, @param and @return have been left blank as it would be annoying to delete the 'DOCME' from every one of those. * Some multiline comments may have been munged into single line comments * Leave the /// comments above global variables with a space, if they're harder to read then we'll be less likey to use them. * Enum comments can go after the enumeration itself '[value] /// comment' * include/aegisub/*.h haven't been converted yet, this will be done in a later commit * Some documentation blocks are in the wrong place, in the .h when it should be in the .cpp, or vice versa. See http://devel.aegisub.org/wiki/Doxygen for some details on Doxygen and a 'style guide'. Originally committed to SVN as r3312.
480 lines
14 KiB
C++
480 lines
14 KiB
C++
// 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 dialog_translation.cpp
|
|
/// @brief Translation Assistant dialogue box and logic
|
|
/// @ingroup tools_ui
|
|
///
|
|
|
|
|
|
///////////
|
|
// Headers
|
|
#include "config.h"
|
|
|
|
#include <wx/wxprec.h>
|
|
#include <wx/settings.h>
|
|
#include "dialog_translation.h"
|
|
#include "ass_dialogue.h"
|
|
#include "ass_file.h"
|
|
#include "subs_grid.h"
|
|
#include "video_display.h"
|
|
#include "video_context.h"
|
|
#include "subs_edit_box.h"
|
|
#include "options.h"
|
|
#include "audio_display.h"
|
|
#include "frame_main.h"
|
|
#include "hotkeys.h"
|
|
#include "utils.h"
|
|
#include "help_button.h"
|
|
#include "libresrc/libresrc.h"
|
|
|
|
|
|
|
|
|
|
/// @brief Constructor
|
|
/// @param parent
|
|
/// @param _subs
|
|
/// @param _grid
|
|
/// @param startrow
|
|
/// @param preview
|
|
///
|
|
DialogTranslation::DialogTranslation (wxWindow *parent,AssFile *_subs,SubtitlesGrid *_grid,int startrow,bool preview)
|
|
: wxDialog(parent, -1, _("Translation Assistant"), wxDefaultPosition, wxDefaultSize, wxDEFAULT_DIALOG_STYLE | wxRESIZE_BORDER | wxMINIMIZE_BOX, _T("TranslationAssistant"))
|
|
{
|
|
// Set icon
|
|
SetIcon(BitmapToIcon(GETIMAGE(translation_toolbutton_24)));
|
|
|
|
// Set variables
|
|
enablePreview = preview;
|
|
main = parent;
|
|
subs = _subs;
|
|
grid = _grid;
|
|
audio = VideoContext::Get()->audio;
|
|
video = video->Get();
|
|
|
|
// Translation controls
|
|
OrigText = new ScintillaTextCtrl(this,TEXT_ORIGINAL,_T(""),wxDefaultPosition,wxSize(320,80));
|
|
OrigText->SetWrapMode(wxSTC_WRAP_WORD);
|
|
OrigText->SetMarginWidth(1,0);
|
|
OrigText->StyleSetForeground(1,wxColour(10,60,200));
|
|
OrigText->SetReadOnly(true);
|
|
//OrigText->PushEventHandler(new DialogTranslationEvent(this));
|
|
TransText = new ScintillaTextCtrl(this,TEXT_TRANS,_T(""),wxDefaultPosition,wxSize(320,80));
|
|
TransText->SetWrapMode(wxSTC_WRAP_WORD);
|
|
TransText->SetMarginWidth(1,0);
|
|
TransText->PushEventHandler(new DialogTranslationEvent(this));
|
|
TransText->SetFocus();
|
|
|
|
// Translation box
|
|
wxSizer *TranslationSizer = new wxBoxSizer(wxVERTICAL);
|
|
wxSizer *OriginalTransSizer = new wxStaticBoxSizer(wxVERTICAL,this,_("Original"));
|
|
wxSizer *TranslatedSizer = new wxStaticBoxSizer(wxVERTICAL,this,_("Translation"));
|
|
LineCount = new wxStaticText(this,-1,_("Current line: ?"));
|
|
OriginalTransSizer->Add(LineCount,0,wxBOTTOM,5);
|
|
OriginalTransSizer->Add(OrigText,1,wxEXPAND,0);
|
|
TranslatedSizer->Add(TransText,1,wxEXPAND,0);
|
|
TranslationSizer->Add(OriginalTransSizer,1,wxEXPAND,0);
|
|
TranslationSizer->Add(TranslatedSizer,1,wxTOP|wxEXPAND,5);
|
|
|
|
// Hotkeys
|
|
wxSizer *KeysSizer = new wxStaticBoxSizer(wxVERTICAL,this,_("Keys"));
|
|
wxSizer *KeysInnerSizer = new wxGridSizer(2,0,5);
|
|
KeysInnerSizer->Add(new wxStaticText(this,-1,Hotkeys.GetText(_T("Translation Assistant Accept")) + _T(": ")));
|
|
KeysInnerSizer->Add(new wxStaticText(this,-1,_("Accept changes")));
|
|
KeysInnerSizer->Add(new wxStaticText(this,-1,Hotkeys.GetText(_T("Translation Assistant Preview")) + _T(": ")));
|
|
KeysInnerSizer->Add(new wxStaticText(this,-1,_("Preview changes")));
|
|
KeysInnerSizer->Add(new wxStaticText(this,-1,Hotkeys.GetText(_T("Translation Assistant Prev")) + _T(": ")));
|
|
KeysInnerSizer->Add(new wxStaticText(this,-1,_("Previous line")));
|
|
KeysInnerSizer->Add(new wxStaticText(this,-1,Hotkeys.GetText(_T("Translation Assistant Next")) + _T(": ")));
|
|
KeysInnerSizer->Add(new wxStaticText(this,-1,_("Next line")));
|
|
KeysInnerSizer->Add(new wxStaticText(this,-1,Hotkeys.GetText(_T("Translation Assistant Insert Original")) + _T(": ")));
|
|
KeysInnerSizer->Add(new wxStaticText(this,-1,_("Insert original")));
|
|
KeysInnerSizer->Add(new wxStaticText(this,-1,Hotkeys.GetText(_T("Translation Assistant Play Video")) + _T(": ")));
|
|
KeysInnerSizer->Add(new wxStaticText(this,-1,_("Play Video")));
|
|
KeysInnerSizer->Add(new wxStaticText(this,-1,Hotkeys.GetText(_T("Translation Assistant Play Audio")) + _T(": ")));
|
|
KeysInnerSizer->Add(new wxStaticText(this,-1,_("Play Audio")));
|
|
PreviewCheck = new wxCheckBox(this,PREVIEW_CHECK,_("Enable preview"));
|
|
PreviewCheck->SetValue(preview);
|
|
PreviewCheck->PushEventHandler(new DialogTranslationEvent(this));
|
|
KeysSizer->Add(KeysInnerSizer,0,wxEXPAND,0);
|
|
KeysSizer->Add(PreviewCheck,0,wxTOP,5);
|
|
|
|
// Tool sizer
|
|
wxStaticBoxSizer *ToolSizer = new wxStaticBoxSizer(wxVERTICAL,this, _("Actions"));
|
|
wxButton *PlayVideoButton = new wxButton(this,BUTTON_TRANS_PLAY_VIDEO,_("Play Video"));
|
|
wxButton *PlayAudioButton = new wxButton(this,BUTTON_TRANS_PLAY_AUDIO,_("Play Audio"));
|
|
PlayVideoButton->Enable(video->IsLoaded());
|
|
PlayAudioButton->Enable(audio->loaded);
|
|
ToolSizer->Add(PlayAudioButton,0,wxALL,5);
|
|
ToolSizer->Add(PlayVideoButton,0,wxLEFT | wxRIGHT | wxBOTTOM,5);
|
|
|
|
// Hotkeys + Tool sizer
|
|
wxBoxSizer *HTSizer = new wxBoxSizer(wxHORIZONTAL);
|
|
HTSizer->Add(KeysSizer,1,wxRIGHT | wxEXPAND,5);
|
|
HTSizer->Add(ToolSizer,0);
|
|
|
|
// Button sizer
|
|
wxStdDialogButtonSizer *ButtonSizer = new wxStdDialogButtonSizer();
|
|
ButtonSizer->AddButton(new wxButton(this,wxID_CANCEL));
|
|
ButtonSizer->AddButton(new HelpButton(this,_T("Translation Assistant")));
|
|
ButtonSizer->Realize();
|
|
|
|
// General layout
|
|
wxSizer *MainSizer = new wxBoxSizer(wxVERTICAL);
|
|
MainSizer->Add(TranslationSizer,1,wxALL | wxEXPAND,5);
|
|
MainSizer->Add(HTSizer,0,wxLEFT | wxRIGHT | wxBOTTOM | wxEXPAND,5);
|
|
MainSizer->Add(ButtonSizer,0,wxALIGN_RIGHT | wxLEFT | wxBOTTOM | wxRIGHT,5);
|
|
|
|
// Set sizer
|
|
SetSizer(MainSizer);
|
|
MainSizer->SetSizeHints(this);
|
|
|
|
// Position window
|
|
if (lastx == -1 && lasty == -1) {
|
|
CenterOnParent();
|
|
} else {
|
|
Move(lastx, lasty);
|
|
}
|
|
|
|
// Set subs/grid
|
|
JumpToLine(startrow,0);
|
|
UpdatePreview();
|
|
}
|
|
|
|
|
|
|
|
/// @brief Jumps to line at block
|
|
/// @param n
|
|
/// @param block
|
|
/// @return
|
|
///
|
|
bool DialogTranslation::JumpToLine(int n,int block) {
|
|
using std::vector;
|
|
AssDialogue *nextLine;
|
|
try {
|
|
nextLine = grid->GetDialogue(n);
|
|
} catch (...) {
|
|
return false;
|
|
}
|
|
if (!nextLine) return false;
|
|
current = nextLine;
|
|
|
|
// Count blocks
|
|
int nblocks = 0;
|
|
current->ParseASSTags();
|
|
size_t size_blocks = current->Blocks.size();
|
|
for (size_t i=0;i<size_blocks;i++) {
|
|
if (current->Blocks.at(i)->GetType() == BLOCK_PLAIN) nblocks++;
|
|
}
|
|
|
|
// Wrap around
|
|
if (block == 0xFFFF) block = nblocks-1;
|
|
if (block < 0) {
|
|
block = 0xFFFF;
|
|
n--;
|
|
return JumpToLine(n,block);
|
|
}
|
|
if (block >= nblocks) {
|
|
block = 0;
|
|
n++;
|
|
return JumpToLine(n,block);
|
|
}
|
|
|
|
// Set current
|
|
curline = n;
|
|
current = grid->GetDialogue(n);
|
|
curblock = block;
|
|
LineCount->SetLabel(wxString::Format(_("Current line: %i/%i"),curline+1,grid->GetRows()));
|
|
|
|
// Update grid
|
|
grid->BeginBatch();
|
|
grid->SelectRow(curline);
|
|
grid->MakeCellVisible(curline,0);
|
|
grid->editBox->SetToLine(curline);
|
|
grid->EndBatch();
|
|
|
|
// Adds blocks
|
|
OrigText->SetReadOnly(false);
|
|
OrigText->ClearAll();
|
|
AssDialogueBlock *curBlock;
|
|
bool found = false;
|
|
int pos=-1;
|
|
for (vector<AssDialogueBlock*>::iterator cur=current->Blocks.begin();cur!=current->Blocks.end();cur++) {
|
|
curBlock = *cur;
|
|
if (curBlock->GetType() == BLOCK_PLAIN) {
|
|
pos++;
|
|
int curLen = OrigText->GetReverseUnicodePosition(OrigText->GetLength());
|
|
OrigText->AppendText(curBlock->text);
|
|
if (pos == block) {
|
|
OrigText->StartUnicodeStyling(curLen);
|
|
OrigText->SetUnicodeStyling(curLen,curBlock->text.Length(),1);
|
|
found = true;
|
|
}
|
|
}
|
|
else if (curBlock->GetType() == BLOCK_OVERRIDE) OrigText->AppendText(_T("{") + curBlock->text + _T("}"));
|
|
}
|
|
current->ClearBlocks();
|
|
OrigText->SetReadOnly(true);
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
|
|
/// @brief Updates video preview
|
|
/// @return
|
|
///
|
|
void DialogTranslation::UpdatePreview () {
|
|
if (enablePreview) {
|
|
try {
|
|
if (VideoContext::Get()->IsLoaded()) {
|
|
AssDialogue *cur = grid->GetDialogue(curline);
|
|
VideoContext::Get()->JumpToTime(cur->Start.GetMS());
|
|
}
|
|
}
|
|
catch (...) {
|
|
return;
|
|
}
|
|
}
|
|
}
|
|
|
|
///////////////
|
|
// Event table
|
|
BEGIN_EVENT_TABLE(DialogTranslation, wxDialog)
|
|
EVT_BUTTON(wxID_CANCEL,DialogTranslation::OnClose)
|
|
EVT_BUTTON(BUTTON_TRANS_PLAY_VIDEO,DialogTranslation::OnPlayVideoButton)
|
|
EVT_BUTTON(BUTTON_TRANS_PLAY_AUDIO,DialogTranslation::OnPlayAudioButton)
|
|
END_EVENT_TABLE()
|
|
|
|
|
|
/////////////////
|
|
// Event handler
|
|
|
|
|
|
/// @brief Constructor
|
|
/// @param ctrl
|
|
///
|
|
DialogTranslationEvent::DialogTranslationEvent(DialogTranslation *ctrl) {
|
|
control = ctrl;
|
|
}
|
|
|
|
// Event table
|
|
BEGIN_EVENT_TABLE(DialogTranslationEvent, wxEvtHandler)
|
|
EVT_KEY_DOWN(DialogTranslationEvent::OnTransBoxKey)
|
|
EVT_CHECKBOX(PREVIEW_CHECK, DialogTranslationEvent::OnPreviewCheck)
|
|
END_EVENT_TABLE()
|
|
|
|
|
|
/// @brief Redirects
|
|
/// @param event
|
|
///
|
|
void DialogTranslationEvent::OnPreviewCheck(wxCommandEvent &event) { control->enablePreview = event.IsChecked(); }
|
|
|
|
/// @brief DOCME
|
|
/// @param event
|
|
///
|
|
void DialogTranslationEvent::OnTransBoxKey(wxKeyEvent &event) { control->OnTransBoxKey(event); }
|
|
|
|
|
|
|
|
/// @brief Key pressed event
|
|
/// @param event
|
|
/// @return
|
|
///
|
|
void DialogTranslation::OnTransBoxKey(wxKeyEvent &event) {
|
|
#ifdef __APPLE__
|
|
Hotkeys.SetPressed(event.GetKeyCode(),event.m_metaDown,event.m_altDown,event.m_shiftDown);
|
|
#else
|
|
Hotkeys.SetPressed(event.GetKeyCode(),event.m_controlDown,event.m_altDown,event.m_shiftDown);
|
|
#endif
|
|
|
|
// Previous
|
|
if (Hotkeys.IsPressed(_T("Translation Assistant Prev"))) {
|
|
bool ok = JumpToLine(curline,curblock-1);
|
|
if (ok) {
|
|
TransText->ClearAll();
|
|
TransText->SetFocus();
|
|
}
|
|
|
|
UpdatePreview();
|
|
return;
|
|
}
|
|
|
|
// Next
|
|
if (Hotkeys.IsPressed(_T("Translation Assistant Next")) || (Hotkeys.IsPressed(_T("Translation Assistant Accept")) && TransText->GetValue().IsEmpty())) {
|
|
bool ok = JumpToLine(curline,curblock+1);
|
|
if (ok) {
|
|
TransText->ClearAll();
|
|
TransText->SetFocus();
|
|
}
|
|
|
|
UpdatePreview();
|
|
return;
|
|
}
|
|
|
|
// Accept (enter)
|
|
if (Hotkeys.IsPressed(_T("Translation Assistant Accept")) || Hotkeys.IsPressed(_T("Translation Assistant Preview"))) {
|
|
// Store
|
|
AssDialogue *cur = grid->GetDialogue(curline);
|
|
cur->ParseASSTags();
|
|
int nblock = -1;
|
|
for (unsigned int i=0;i<cur->Blocks.size();i++) {
|
|
if (cur->Blocks.at(i)->GetType() == BLOCK_PLAIN) nblock++;
|
|
if (nblock == curblock) {
|
|
cur->Blocks.at(i)->text = TransText->GetValue();
|
|
break;
|
|
}
|
|
}
|
|
|
|
// Update line
|
|
cur->UpdateText();
|
|
cur->UpdateData();
|
|
cur->ClearBlocks();
|
|
subs->FlagAsModified(_("translation assistant"));
|
|
grid->CommitChanges();
|
|
((FrameMain*)main)->UpdateTitle();
|
|
UpdatePreview();
|
|
|
|
// Next
|
|
if (Hotkeys.IsPressed(_T("Translation Assistant Accept"))) {
|
|
// JumpToLine() returns false if the requested line doesn't exist.
|
|
// Assume that means we were on the last line.
|
|
if (!JumpToLine(curline,curblock+1)) {
|
|
wxMessageBox(_("No more lines to translate."));
|
|
EndModal(1);
|
|
return;
|
|
}
|
|
TransText->ClearAll();
|
|
TransText->SetFocus();
|
|
}
|
|
else JumpToLine(curline,curblock);
|
|
return;
|
|
}
|
|
|
|
// Insert original text (insert)
|
|
if (Hotkeys.IsPressed(_T("Translation Assistant Insert Original"))) {
|
|
using std::vector;
|
|
AssDialogueBlock *curBlock;
|
|
int pos = -1;
|
|
current->ParseASSTags();
|
|
for (vector<AssDialogueBlock*>::iterator cur=current->Blocks.begin();cur!=current->Blocks.end();cur++) {
|
|
curBlock = *cur;
|
|
if (curBlock->GetType() == BLOCK_PLAIN) {
|
|
pos++;
|
|
if (pos == curblock) {
|
|
TransText->AddText(curBlock->text);
|
|
}
|
|
}
|
|
}
|
|
current->ClearBlocks();
|
|
return;
|
|
}
|
|
|
|
// Play video
|
|
if (Hotkeys.IsPressed(_T("Translation Assistant Play Video"))) {
|
|
if (video->IsLoaded()) {
|
|
video->PlayLine();
|
|
TransText->SetFocus();
|
|
}
|
|
return;
|
|
}
|
|
|
|
// Play audio
|
|
if (Hotkeys.IsPressed(_T("Translation Assistant Play Audio"))) {
|
|
if (audio->loaded) {
|
|
audio->Play(current->Start.GetMS(),current->End.GetMS());
|
|
TransText->SetFocus();
|
|
}
|
|
return;
|
|
}
|
|
|
|
// Close
|
|
if (event.GetKeyCode() == WXK_ESCAPE) EndModal(1);
|
|
|
|
// Ignore enter
|
|
if (event.GetKeyCode() == WXK_RETURN || event.GetKeyCode() == WXK_NUMPAD_ENTER) return;
|
|
|
|
// Skip anything else
|
|
event.Skip();
|
|
}
|
|
|
|
|
|
|
|
/// @brief Play video button
|
|
/// @param event
|
|
///
|
|
void DialogTranslation::OnPlayVideoButton(wxCommandEvent &event) {
|
|
video->PlayLine();
|
|
TransText->SetFocus();
|
|
}
|
|
|
|
|
|
|
|
/// @brief Play audio button
|
|
/// @param event
|
|
///
|
|
void DialogTranslation::OnPlayAudioButton(wxCommandEvent &event) {
|
|
audio->Play(current->Start.GetMS(),current->End.GetMS());
|
|
TransText->SetFocus();
|
|
}
|
|
|
|
|
|
|
|
/// @brief Close
|
|
/// @param event
|
|
///
|
|
void DialogTranslation::OnClose (wxCommandEvent &event) {
|
|
GetPosition(&lastx, &lasty);
|
|
TransText->PopEventHandler(true);
|
|
PreviewCheck->PopEventHandler(true);
|
|
EndModal(0);
|
|
}
|
|
|
|
|
|
|
|
/// @brief Minimize
|
|
/// @param event
|
|
///
|
|
void DialogTranslation::OnMinimize (wxIconizeEvent &event) {
|
|
//Iconize(true);
|
|
if (main) ((wxFrame*)main)->Iconize(true);
|
|
event.Skip();
|
|
}
|
|
|
|
|
|
|
|
/// DOCME
|
|
int DialogTranslation::lastx = -1;
|
|
|
|
/// DOCME
|
|
int DialogTranslation::lasty = -1;
|
|
|
|
|