Document AssFile's public methods

Originally committed to SVN as r4524.
This commit is contained in:
Thomas Goyne 2010-06-16 06:20:14 +00:00
parent 166c95975b
commit 8086fae633
2 changed files with 108 additions and 171 deletions

View file

@ -71,10 +71,6 @@ AssFile::~AssFile() {
Clear();
}
/// @brief Load generic subs
/// @param file
/// @param charset
/// @param addToRecent
void AssFile::Load (const wxString &_filename,wxString charset,bool addToRecent) {
bool ok = true;
@ -145,11 +141,6 @@ void AssFile::Load (const wxString &_filename,wxString charset,bool addToRecent)
if (addToRecent) AddToRecent(_filename);
}
/// @brief Save a file to Hard Disk
/// @param _filename
/// @param setfilename
/// @param addToRecent
/// @param encoding
void AssFile::Save(wxString _filename,bool setfilename,bool addToRecent,const wxString encoding) {
// Finds last dot
int i = 0;
@ -181,9 +172,6 @@ void AssFile::Save(wxString _filename,bool setfilename,bool addToRecent,const wx
}
}
/// @brief Saves a file to a ram vector
/// @param dst
/// @param encoding
void AssFile::SaveMemory(std::vector<char> &dst,const wxString encoding) {
// Set encoding
wxString enc = encoding;
@ -226,16 +214,12 @@ void AssFile::SaveMemory(std::vector<char> &dst,const wxString encoding) {
}
}
/// @brief Exports file with proper transformations
/// @param _filename
void AssFile::Export(wxString _filename) {
AssExporter exporter(this);
exporter.AddAutoFilters();
exporter.Export(_filename,_T("UTF-8"));
}
/// @brief Can save file?
/// @return
bool AssFile::CanSave() {
// ASS format?
wxString ext = filename.Lower().Right(4);
@ -287,12 +271,8 @@ bool AssFile::CanSave() {
return true;
}
/// @brief even moving things out of order might break ASS parsing - AMZ. I strongly advice you against touching this function unless you know what you're doing; ------------------- Appends line to Ass
/// @param data
/// @param group
/// @param version
/// @param outGroup
/// @return
// I strongly advice you against touching this function unless you know what you're doing;
// even moving things out of order might break ASS parsing - AMZ.
void AssFile::AddLine (wxString data,wxString group,int &version,wxString *outGroup) {
// Group
AssEntry *entry = NULL;
@ -427,7 +407,6 @@ void AssFile::AddLine (wxString data,wxString group,int &version,wxString *outGr
return;
}
/// @brief Clears contents of assfile
void AssFile::Clear () {
for (entryIter cur=Line.begin();cur != Line.end();cur++) {
delete *cur;
@ -439,10 +418,7 @@ void AssFile::Clear () {
Modified = false;
}
/// @brief Loads default subs
/// @param defline
void AssFile::LoadDefault (bool defline) {
// Clear first
Clear();
// Write headers
@ -471,8 +447,6 @@ void AssFile::LoadDefault (bool defline) {
loaded = true;
}
/// @brief Copy constructor
/// @param from
AssFile::AssFile (AssFile &from) {
using std::list;
@ -487,10 +461,7 @@ AssFile::AssFile (AssFile &from) {
}
}
/// @brief Insert a new style
/// @param style
void AssFile::InsertStyle (AssStyle *style) {
// Variables
using std::list;
AssEntry *curEntry;
list<AssEntry*>::iterator lastStyle = Line.end();
@ -536,8 +507,6 @@ void AssFile::InsertStyle (AssStyle *style) {
}
}
/// @brief Insert attachment
/// @param attach
void AssFile::InsertAttachment (AssAttachment *attach) {
// Search for insertion point
std::list<AssEntry*>::iterator insPoint=Line.end(),cur;
@ -571,16 +540,10 @@ void AssFile::InsertAttachment (AssAttachment *attach) {
}
}
/// @brief Insert attachment from file
/// @param filename
void AssFile::InsertAttachment (wxString filename) {
// Get name
wxFileName fname(filename);
// Create
AssAttachment *newAttach = new AssAttachment(fname.GetFullName());
// Load
try {
newAttach->Import(filename);
}
@ -596,25 +559,19 @@ void AssFile::InsertAttachment (wxString filename) {
InsertAttachment(newAttach);
}
/// @brief Gets script info
/// @param _key
/// @return
wxString AssFile::GetScriptInfo(const wxString _key) {
// Prepare
wxString key = _key;;
key.Lower();
key += _T(":");
std::list<AssEntry*>::iterator cur;
bool GotIn = false;
// Look for it
for (cur=Line.begin();cur!=Line.end();cur++) {
if ((*cur)->group == _T("[Script Info]")) {
GotIn = true;
wxString curText = (*cur)->GetEntryData();
curText.Lower();
// Found
if (curText.StartsWith(key)) {
wxString result = curText.Mid(key.length());
result.Trim(false);
@ -625,13 +582,9 @@ wxString AssFile::GetScriptInfo(const wxString _key) {
else if (GotIn) break;
}
// Couldn't find
return _T("");
return "";
}
/// @brief Get script info as int
/// @param key
/// @return
int AssFile::GetScriptInfoAsInt(const wxString key) {
long temp = 0;
try {
@ -643,12 +596,7 @@ int AssFile::GetScriptInfoAsInt(const wxString key) {
return temp;
}
/// @brief Set a script info line
/// @param _key
/// @param value
/// @return
void AssFile::SetScriptInfo(const wxString _key,const wxString value) {
// Prepare
wxString key = _key;;
key.Lower();
key += _T(":");
@ -699,11 +647,7 @@ void AssFile::SetScriptInfo(const wxString _key,const wxString value) {
}
}
/// @brief Get resolution
/// @param sw
/// @param sh
void AssFile::GetResolution(int &sw,int &sh) {
// Height
wxString temp = GetScriptInfo(_T("PlayResY"));
if (temp.IsEmpty() || !temp.IsNumber()) {
sh = 0;
@ -714,7 +658,6 @@ void AssFile::GetResolution(int &sw,int &sh) {
sh = templ;
}
// Width
temp = GetScriptInfo(_T("PlayResX"));
if (temp.IsEmpty() || !temp.IsNumber()) {
sw = 0;
@ -735,6 +678,7 @@ void AssFile::GetResolution(int &sw,int &sh) {
else
sw = sh * 4 / 3;
} else if (sh == 0) {
// you are not crazy; this doesn't make any sense
if (sw == 1280)
sh = 1024;
else
@ -742,15 +686,12 @@ void AssFile::GetResolution(int &sw,int &sh) {
}
}
/// @brief Adds a comment to [Script Info]
/// @param _comment
void AssFile::AddComment(const wxString _comment) {
wxString comment = _T("; ");
comment += _comment;
std::list<AssEntry*>::iterator cur;
int step = 0;
// Find insert position
for (cur=Line.begin();cur!=Line.end();cur++) {
// Start of group
if (step == 0 && (*cur)->group == _T("[Script Info]")) step = 1;
@ -766,8 +707,6 @@ void AssFile::AddComment(const wxString _comment) {
}
}
/// @brief Get list of styles
/// @return
wxArrayString AssFile::GetStyles() {
wxArrayString styles;
AssStyle *curstyle;
@ -780,29 +719,19 @@ wxArrayString AssFile::GetStyles() {
return styles;
}
/// @brief Gets style of specific name
/// @param name
/// @return
AssStyle *AssFile::GetStyle(wxString name) {
AssStyle *curstyle;
for (entryIter cur=Line.begin();cur!=Line.end();cur++) {
curstyle = dynamic_cast<AssStyle*>(*cur);
if (curstyle) {
if (curstyle->name == name) return curstyle;
}
AssStyle *curstyle = dynamic_cast<AssStyle*>(*cur);
if (curstyle && curstyle->name == name)
return curstyle;
}
return NULL;
}
/// @brief Adds file name to list of recent
/// @param file
void AssFile::AddToRecent(wxString file) {
AegisubApp::Get()->mru->Add("Subtitle", STD_STR(file));
}
/// @brief List of supported wildcards
/// @param mode
/// @return
wxString AssFile::GetWildcardList(int mode) {
if (mode == 0) return SubtitleFormat::GetWildcards(0);
else if (mode == 1) return _T("Advanced Substation Alpha (*.ass)|*.ass");
@ -810,32 +739,22 @@ wxString AssFile::GetWildcardList(int mode) {
else return _T("");
}
/// @brief Compress/decompress for storage on stack
/// @param compress
void AssFile::CompressForStack(bool compress) {
void AssFile::CompressForStack() {
AssDialogue *diag;
for (entryIter cur=Line.begin();cur!=Line.end();cur++) {
diag = dynamic_cast<AssDialogue*>(*cur);
if (diag) {
if (compress) {
diag->SetEntryData(_T(""));
diag->ClearBlocks();
}
else diag->UpdateData();
diag->SetEntryData("");
diag->ClearBlocks();
}
}
}
/// @brief Checks if file is modified
/// @return
bool AssFile::IsModified() {
return Modified;
}
/// @brief Flag file as modified
/// @param desc
void AssFile::FlagAsModified(wxString desc) {
// Clear redo
if (!RedoStack.empty()) {
//StackPush();
//UndoStack.push_back(new AssFile(*UndoStack.back()));
@ -849,12 +768,10 @@ void AssFile::FlagAsModified(wxString desc) {
StackPush(desc);
}
/// @brief Stack push
/// @param desc
void AssFile::StackPush(wxString desc) {
// Places copy on stack
AssFile *curcopy = new AssFile(*top);
curcopy->CompressForStack(true);
curcopy->CompressForStack();
curcopy->undodescription = desc;
UndoStack.push_back(curcopy);
StackModified = true;
@ -872,10 +789,9 @@ void AssFile::StackPush(wxString desc) {
}
}
/// @brief Stack pop
void AssFile::StackPop() {
bool addcopy = false;
wxString undodesc=_T("");
wxString undodesc="";
if (StackModified) {
@ -889,11 +805,10 @@ void AssFile::StackPop() {
if (!UndoStack.empty()) {
//delete top;
AssFile *undo = UndoStack.back();
top->CompressForStack(true);
top->CompressForStack();
top->undodescription = undodesc;
RedoStack.push_back(top);
top = undo;
top->CompressForStack(false);
UndoStack.pop_back();
Popping = true;
}
@ -903,9 +818,7 @@ void AssFile::StackPop() {
}
}
/// @brief Stack redo
void AssFile::StackRedo() {
bool addcopy = false;
if (StackModified) {
delete UndoStack.back();
@ -915,13 +828,11 @@ void AssFile::StackRedo() {
}
if (!RedoStack.empty()) {
top->CompressForStack(true);
top->CompressForStack();
UndoStack.push_back(top);
top = RedoStack.back();
top->CompressForStack(false);
RedoStack.pop_back();
Popping = true;
//StackModified = false;
}
if (addcopy) {
@ -929,15 +840,12 @@ void AssFile::StackRedo() {
}
}
/// @brief Stack clear
void AssFile::StackClear() {
// Clear undo
for (std::list<AssFile*>::iterator cur=UndoStack.begin();cur!=UndoStack.end();cur++) {
delete *cur;
}
UndoStack.clear();
// Clear redo
for (std::list<AssFile*>::iterator cur=RedoStack.begin();cur!=RedoStack.end();cur++) {
delete *cur;
}
@ -946,8 +854,6 @@ void AssFile::StackClear() {
Popping = false;
}
/// @brief Stack reset
/// @return
void AssFile::StackReset() {
StackClear();
delete top;
@ -955,27 +861,19 @@ void AssFile::StackReset() {
StackModified = false;
}
/// @brief Returns if undo stack is empty
/// @return
bool AssFile::IsUndoStackEmpty() {
if (StackModified) return (UndoStack.size() <= 1);
else return UndoStack.empty();
}
/// @brief Returns if redo stack is empty
/// @return
bool AssFile::IsRedoStackEmpty() {
return RedoStack.empty();
}
/// @brief DOCME
/// @return
wxString AssFile::GetUndoDescription() {
return (IsUndoStackEmpty())?_T(""):(UndoStack.back())->undodescription;
}
/// @brief DOCME
/// @return
wxString AssFile::GetRedoDescription() {
return (IsRedoStackEmpty())?_T(""):(RedoStack.back())->undodescription;
}
@ -1025,17 +923,8 @@ void AssFile::Sort(std::list<AssDialogue*> &lst, CompFunc comp) {
lst.sort(comp);
}
/// DOCME
AssFile *AssFile::top;
/// DOCME
std::list<AssFile*> AssFile::UndoStack;
/// DOCME
std::list<AssFile*> AssFile::RedoStack;
/// DOCME
bool AssFile::Popping;
/// DOCME
bool AssFile::StackModified;

View file

@ -78,66 +78,114 @@ private:
static bool StackModified;
static void StackClear();
public:
/// DOCME
std::list<AssEntry*> Line;
/// DOCME
wxString filename;
/// DOCME
wxString undodescription;
/// DOCME
public:
/// The lines in the file
std::list<AssEntry*> Line;
/// The filename of this file, if any
wxString filename;
/// Is the file loaded?
bool loaded;
AssFile();
AssFile(AssFile &from);
~AssFile();
bool IsModified(); // Returns if file has unmodified changes
void FlagAsModified(wxString desc); // Flag file as being modified, will automatically put a copy on stack
void Clear(); // Wipes file
void CompressForStack(bool compress); // Compress/decompress for storage on stack
void LoadDefault(bool defline=true); // Loads default file. Pass false to prevent it from adding a default line too
void InsertStyle(AssStyle *style); // Inserts a style to file
void InsertAttachment(AssAttachment *attach); // Inserts an attachment
void InsertAttachment(wxString filename); // Inserts a file as an attachment
wxArrayString GetStyles(); // Gets a list of all styles available
AssStyle *GetStyle(wxString name); // Gets style by its name
/// Does the file have unsaved changes?
bool IsModified();
/// @brief Flag the file as modified and push a copy onto the undo stack
/// @param desc Undo description
void FlagAsModified(wxString desc);
/// Clear the file
void Clear();
/// Discard some parsed data to reduce the size of the undo stack
void CompressForStack();
/// @brief Load default file
/// @param defline Add a blank line to the file
void LoadDefault(bool defline=true);
/// Add a style to the file
void InsertStyle(AssStyle *style);
/// Add an attachment to the file
void InsertAttachment(AssAttachment *attach);
/// Attach a file to the ass file
void InsertAttachment(wxString filename);
/// Get the names of all of the styles available
wxArrayString GetStyles();
/// @brief Get a style by name
/// @param name Style name
/// @return Pointer to style or NULL
AssStyle *GetStyle(wxString name);
//wxString GetString(); // Returns the whole file as a single string
void Load(const wxString &file,wxString charset=_T(""),bool addToRecent=true); // Load from a file
void Save(wxString file,bool setfilename=false,bool addToRecent=true,const wxString encoding=_T("")); // Save to a file. Pass true to second argument if this isn't a copy
void SaveMemory(std::vector<char> &dst,const wxString encoding=_T("")); // Save to a memory string
void Export(wxString file); // Saves exported copy, with effects applied
void AddToRecent(wxString file); // Adds file name to list of recently opened files
bool CanSave(); // Returns true if the file can be saved in its current format
static wxString GetWildcardList(int mode); // Returns the list of wildcards supported (0 = open, 1 = save, 2 = export)
void GetResolution(int &w,int &h); // Get resolution
int GetScriptInfoAsInt(const wxString key); // Returns the value in a [Script Info] key as int.
wxString GetScriptInfo(const wxString key); // Returns the value in a [Script Info] key as string.
void SetScriptInfo(const wxString key,const wxString value); // Sets the value of a [Script Info] key. Adds it if it doesn't exist.
void AddComment(const wxString comment); // Adds a ";" comment under [Script Info].
/// @brief Load from a file
/// @param file File name
/// @param charset Character set of file or empty to autodetect
/// @param addToRecent Should the file be added to the MRU list?
void Load(const wxString &file,wxString charset="",bool addToRecent=true);
/// @brief Save to a file
/// @param file Path to save to
/// @param setfilename Should the filename be changed to the passed path?
/// @param addToRecent Should the file be added to the MRU list?
/// @param encoding Encoding to use, or empty to let the writer decide (which usually means "App/Save Charset")
void Save(wxString file,bool setfilename=false,bool addToRecent=true,const wxString encoding=_T(""));
/// @brief Save to a memory buffer. Used for subtitle providers which support it
/// @param[out] dst Destination vector
void SaveMemory(std::vector<char> &dst,const wxString encoding=_T(""));
/// @brief Saves exported copy, with effects applied
/// @param file Path to save to; file name is never set to this
void Export(wxString file);
/// Add file name to the MRU list
void AddToRecent(wxString file);
/// Can the file be saved in its current format?
bool CanSave();
/// @brief Get the list of wildcards supported
/// @param mode 0 = open, 1 = save, 2 = export
static wxString GetWildcardList(int mode);
/// @brief Get the script resolution
/// @param[out] w Width
/// @param[in] h Height
void GetResolution(int &w,int &h);
/// Get the value in a [Script Info] key as int.
int GetScriptInfoAsInt(const wxString key);
/// Get the value in a [Script Info] key as string.
wxString GetScriptInfo(const wxString key);
/// Set the value of a [Script Info] key. Adds it if it doesn't exist.
void SetScriptInfo(const wxString key,const wxString value);
// Add a ";" comment in the [Script Info] section
void AddComment(const wxString comment);
/// @brief Add a line to the file
/// @param data Full text of ASS line
/// @param group Section of the file to add the line to
/// @param[out] version ASS version the line was parsed as
/// @param[out] outGroup Group it was actually added to; attachments do something strange here
void AddLine(wxString data,wxString group,int &version,wxString *outGroup=NULL);
static void StackPop(); // Pop subs from stack and sets 'top' to it
static void StackRedo(); // Redoes action on stack
static void StackPush(wxString desc); // Puts a copy of 'top' on the stack
static void StackReset(); // Resets stack. Do this before loading new subtitles.
static bool IsUndoStackEmpty(); // Checks if undo stack is empty
static bool IsRedoStackEmpty(); // Checks if undo stack is empty
static wxString GetUndoDescription(); // Gets field undodescription from back of UndoStack
static wxString GetRedoDescription(); // Gets field undodescription from back of RedoStack
/// Pop subs from stack and set 'top' to it
static void StackPop();
/// Redo action on stack
static void StackRedo();
/// @brief Put a copy of 'top' on the stack
/// @param desc Undo message
static void StackPush(wxString desc);
/// Clear the stack. Do before loading new subtitles.
static void StackReset();
/// Check if undo stack is empty
static bool IsUndoStackEmpty();
/// Check if redo stack is empty
static bool IsRedoStackEmpty();
/// Get the description of the first undoable change
static wxString GetUndoDescription();
/// Get the description of the first redoable change
static wxString GetRedoDescription();
/// DOCME
static bool Popping; // Flags the stack as popping. You must unset this after popping
/// Flags the stack as popping. You must unset this after popping
static bool Popping;
/// DOCME
static AssFile *top; // Current script file. It is "above" the stack.
/// Current script file. It is "above" the stack.
static AssFile *top;
/// Comparison function for use when sorting
typedef bool (*CompFunc)(const AssDialogue* lft, const AssDialogue* rgt);